vert-x / mod-lang-js

Vert.x 2.x is deprecated - use instead

Vert.x 2.x is deprecated - use instead https://github.com/vert-x3/vertx-lang-js

Javascript Language Module for Vert.x

This is the Javascript language module used by mod-lang-dynjs and mod-lang-rhino. This module is not typically used directly, but rather both mod-lang-rhino and mod-lang-dynjs have a dependency on this module which provides the core Javascript API for Vert.x.

Documentation

• User Manual
• 1.1.0 API Documentation
• HEAD API Documentation

Continuous Integration

The module is built on our Cloudbees CI server, as well as on Travis CI with each push to GitHub.

Running the tests

You'll need to have Maven and JDK7 or better installed. If you don't, do that first. Then you can clone and build.

$ git clone https://github.com/vert-x/mod-lang-js.git
$ cd mod-lang-js
$ mvn verify

This will run all of the integration tests against both mod-lang-rhino and mod-lang-dynjs.

If you're hacking on this code and want to install this module locally:

$ mvn install

Now your local vert.x installation will pick up the local version when testing against mod-lang-dynjs or mod-lang-rhino.

By default, vert.x runs Javascript verticles and modules with Rhino. Change this by creating a langs.properties file at the root of your project that looks like this for dynjs.

dynjs=io.vertx~lang-dynjs~1.0.1:org.dynjs.vertx.DynJSVerticleFactory
.js=dynjs

Or if you want to use the experimental nashorn module, do this.

nashorn=io.vertx~lang-nashorn~1.0.0-beta2-SNAPSHOT:org.vertx.java.platform.impl.NashornVerticleFactory
.js=nashorn

Enjoy. And if you have any problems, hit us on on freenode at #dynjs or #vertx.

mod-lang-js's Issues

Add deployVerticle(name, config) and deplyVertic

JSON array deserialization problem on the event bus

Arrays cannot be used as "top level" structure on the event bus. The following code exhibits the problem:

var console = require('vertx/console');
var container = require('vertx/container');
var eb = require('vertx').eventBus;

var sendData  = ['abc'];

eb.registerHandler('ebAdr', function (data, replier) {
    console.log('DATA: ' + JSON.stringify(data));
});

eb.send('ebAdr', sendData, function (reply) {
    container.exit();
});

The following error is thrown:

org.mozilla.javascript.WrappedException: Wrapped org.vertx.java.core.json.DecodeException: Failed to decode:Can not deserialize instance of java.util.LinkedHashMap out of START_ARRAY token

Please make websocket frame size configurable

... on HttpClient and HttpServer by exposing the getter/setter for MaxWebSocketFrameSize

eclipse-vertx/vert.x@8a00f2f

Thanks!

Nashorn can't complete test suite

Nashorn considers JavaThing#op(String arg) and JavaThing#op(CharSequence arg) to be ambiguous. I think this is probably a bug in nashorn, since it should at least not fail. However tests begin failing with error messages like:

SEVERE: Exception in Nashorn JavaScript verticle
java.lang.RuntimeException: java.lang.NoSuchMethodException: Can't unambiguously select between fixed arity signatures [(java.lang.String, java.lang.String), (java.lang.CharSequence, java.lang.CharSequence)] of the method org.vertx.java.core.http.impl.HttpHeadersAdapter.set for argument types [java.lang.String, jdk.nashorn.internal.runtime.ConsString]
at org.vertx.java.core.Handler$$NashornJavaAdapter.handle(Unknown Source)
at org.vertx.java.core.http.impl.DefaultHttpServer$4$1.run(DefaultHttpServer.java:250)

Mistake in file_system.js - chown/chmod confusion

While creating the TypeScript definitions I have noticed a mistake in file_system.js where the newly created method which should be called chownSync is in fact called chmodSync. I've issued a pull request and signed the Eclipse CLA. Not sure if I can link this to the pull request after the fact but I'll try. Thanks.

Support event bus' registration handler

The registration handler as defined https://github.com/eclipse/vert.x/blob/master/vertx-core/src/main/java/org/vertx/java/core/eventbus/EventBus.java#L395 which is used to notify clients when an address has been registered with all nodes, is not supported in the JS API. It should be.

Add support to append and set bytes on a Buffer with an offset and length

See eclipse-vertx/vert.x#779

Please expose remoteAddress() on websocket and sockjssocket

eclipse-vertx/vert.x@9d672ed

Thanks!

Don't assume an event bus message has an address property

This commit breaks backwards compatibility.

#7

The fix requires that the event bus always call jMsg.address(), which hasn't always existed. Therefore, with older versions of vert.x users will see this message.

org.dynjs.exception.ThrowException: TypeError: not callable: [DerefRef: value=undefined; ref=[Reference: name=address; base=org.vertx.java.core.eventbus.impl.JsonObjectMessage@809f86c (org.vertx.java.core.eventbus.impl.JsonObjectMessage)]]

This would cause breakage for users of lang-rhino 2.0.0-final or any recent SNAPSHOT of lang-rhino or lang-dynjs who upgrade their language module to 2.1 for rhino or 1.0 for dynjs, but don't update their vert.x. Admittedly a silly thing to do, but there you go.

SockJS and Event Bus bridges Needs Integration Testing

Add support for chown(..) operations to FileSystem.

https://bugs.eclipse.org/bugs/show_bug.cgi?id=423812

Add sendFile operation that takes a resultHandler.

See:
https://bugs.eclipse.org/bugs/show_bug.cgi?id=423447
eclipse-vertx/vert.x#786

Implement new EventBus send timeouts

The Java eventbus now supports sends with timeout, also the Message class supports replies with timeouts.

We should expose this new functionality in the JS API too

setTimeout or setImmediate shim

I'm sure this is not the first time it's come up, but I would like to see the Vert.x JavaScript module support support some form of the setTimeout or setImmediate functions out of the box. This would make it immediately compatible with tools which require this, such as Q or async.

I created a pull request for Q, but kriskowal suggest adding support for one of these functions in Vert.x itself, and to be honest I agree. I make extensive use for both async and Q throughout my code, and I've had to use custom versions of both in order to make them work. Would it be possible to just add a shim around vertx.runOnContext or similar? If it already exists in the code, can we enable it by default?

Wrong license for coffeescript

Looking at the coffeescript repo license:

https://github.com/jashkenas/coffee-script/blob/master/LICENSE

It appears we're appending the wrong one (ASL to coffee-script.js) (also in rhino and dynjs).

We should include the correct LICENSE.txt file

Implement new SockJSServer.bridge method

As per eclipse-vertx/vert.x@ea8b3d0#diff-584e0ff4c0448578612a911d9202355eR241

Improvement: nashorn as an runtime for mod-lang-js

Please expose message address publicly

eclipse-vertx/vert.x@cbbd951

Thanks!

container.env doesn't behave like a JS object

Should be able to say container.env['prop'] to retrieve properties instead of exposing it as a Java Map and having to do container.env.get('prop').

Why is mod-lang-js using the both the old and the new test framework?

vertx-testframework is the old test framework
testtools - is the new framework

mod-lang-js seems to be depending on both of these. That doesn't make a lot of sense to me.

Make eventBus.send work with null messages

Currently the testEchoNull function in eventbus_test.js doesn't really test to see if a null value is returned.

Please implement equivalent functionality to EventBusBridgeHook

... and also expose uri() method in ServerWebSocket

eclipse-vertx/vert.x@d207b6a

Add coffee-script.js to top level directory

It seems that coffee-script.js is missing in the top level directory. In my case I could not run coffee based sources without it.

Please implement new sendFile methods which takes a result handler

eclipse-vertx/vert.x@f9afbdb

Thanks!

Add support for HTTP Compression

See also:
eclipse-vertx/vert.x@633ccaa

Moved from vert-x/mod-lang-rhino#20

Complete event bus "send reply failures" implementation

Also, can we extend this to include event bus send reply failures?

eclipse-vertx/vert.x@00eceab

Moved from vert-x/mod-lang-rhino#19

Add support to pass config objects to modules and verticles deployed from JavaScript

Need support for the equivalent Java methods of:

deployVerticle(name, config)
deployModule(name, config)
deployVerticle(name, config, ResultHandler)
deployModule(name, config, ResultHandler)

Currently, if I want to deploy the JDBC Persistor module, I have to deploy it from Java because JavaScript doesn't allow the passing of config objects to programmatically deployed modules and verticles. This means that MUST write code in a language which the rest of my team cannot easily support.

Add support for NetSocket to SSL

https://bugs.eclipse.org/bugs/show_bug.cgi?id=417705

Add sendWithTimeout support to event_bus API in JavaScript

The JavaScript AP does not support sendWithTimeout the same as the Java API. This is definitely something which is needed to provide parity across language implementations.