Bump version to 0.9.4.

README: Add missing constructor arguments

.travis.yml

@@ -3,4 +3,5 @@ language: node_js
 node_js:
   - "0.8"
   - "0.10"
-  - "0.11"
+  - "0.12"
+  - "iojs"

CHANGELOG.md

@@ -1,96 +1,95 @@
+### 0.9.4 / 2015-03-08
+
+* Don't send input to the driver before `start()` is called
+
+### 0.9.3 / 2015-02-19
+
+* Make sure the TCP socket is not left open when closing the connection
+
+### 0.9.2 / 2014-12-21
+
+* Only emit `error` once, and don't emit it after `close`
+
+### 0.9.1 / 2014-12-18
+
+* Check that all options to the WebSocket constructor are recognized
+
 ### 0.9.0 / 2014-12-13
 
 * Allow protocol extensions to be passed into websocket-extensions
 
-
 ### 0.8.1 / 2014-11-12
 
 * Send the correct hostname when upgrading a connection to TLS
 
-
 ### 0.8.0 / 2014-11-08
 
 * Support connections via HTTP proxies
 * Close the connection cleanly if we're still waiting for a handshake response
 
-
 ### 0.7.3 / 2014-10-04
 
 * Allow sockets to be closed when they are in any state other than `CLOSED`
 
-
 ### 0.7.2 / 2013-12-29
 
 * Make sure the `close` event is emitted by clients on Node v0.10
 
-
 ### 0.7.1 / 2013-12-03
 
 * Support the `maxLength` websocket-driver option
 * Make the client emit `error` events on network errors
 
-
 ### 0.7.0 / 2013-09-09
 
 * Allow the server to send custom headers with EventSource responses
 
-
 ### 0.6.1 / 2013-07-05
 
 * Add `ca` option to the client for specifying certificate authorities
 * Start the server driver asynchronously so that `onopen` handlers can be added
 
-
 ### 0.6.0 / 2013-05-12
 
 * Add support for custom headers
 
-
 ### 0.5.0 / 2013-05-05
 
 * Extract the protocol handlers into the `websocket-driver` library
 * Support the Node streaming API
 
-
 ### 0.4.4 / 2013-02-14
 
 * Emit the `close` event if TCP is closed before CLOSE frame is acked
 
-
 ### 0.4.3 / 2012-07-09
 
 * Add `Connection: close` to EventSource response
 * Handle situations where `request.socket` is undefined
 
-
 ### 0.4.2 / 2012-04-06
 
 * Add WebSocket error code `1011`.
 * Handle URLs with no path correctly by sending `GET /`
 
-
 ### 0.4.1 / 2012-02-26
 
 * Treat anything other than a `Buffer` as a string when calling `send()`
 
-
 ### 0.4.0 / 2012-02-13
 
 * Add `ping()` method to server-side `WebSocket` and `EventSource`
 * Buffer `send()` calls until the draft-76 handshake is complete
 * Fix HTTPS problems on Node 0.7
 
-
 ### 0.3.1 / 2012-01-16
 
 * Call `setNoDelay(true)` on `net.Socket` objects to reduce latency
 
-
 ### 0.3.0 / 2012-01-13
 
 * Add support for `EventSource` connections
 
-
 ### 0.2.0 / 2011-12-21
 
 * Add support for `Sec-WebSocket-Protocol` negotiation
@@ -98,18 +97,15 @@
 * Improve performance of HyBi parsing/framing functions
 * Decouple parsers from TCP and reduce write volume
 
-
 ### 0.1.2 / 2011-12-05
 
 * Detect closed sockets on the server side when TCP connection breaks
 * Make `hixie-76` sockets work through HAProxy
 
-
 ### 0.1.1 / 2011-11-30
 
 * Fix `addEventListener()` interface methods
 
-
 ### 0.1.0 / 2011-11-27
 
 * Initial release, based on WebSocket components from Faye

README.md

@@ -6,12 +6,11 @@
   [client](http://faye.jcoglan.com/autobahn/clients/)
 
 This is a general-purpose WebSocket implementation extracted from the
-[Faye](http://faye.jcoglan.com) project. It provides classes for easily
-building WebSocket servers and clients in Node. It does not provide a server
-itself, but rather makes it easy to handle WebSocket connections within an
-existing [Node](http://nodejs.org/) application. It does not provide any
-abstraction other than the standard [WebSocket
-API](http://dev.w3.org/html5/websockets/).
+[Faye](http://faye.jcoglan.com) project. It provides classes for easily building
+WebSocket servers and clients in Node. It does not provide a server itself, but
+rather makes it easy to handle WebSocket connections within an existing
+[Node](http://nodejs.org/) application. It does not provide any abstraction
+other than the standard [WebSocket API](http://dev.w3.org/html5/websockets/).
 
 It also provides an abstraction for handling
 [EventSource](http://dev.w3.org/html5/eventsource/) connections, which are
@@ -77,10 +76,9 @@ If you need to detect when the WebSocket handshake is complete, you can use the
 
 If the connection's protocol version supports it, you can call `ws.ping()` to
 send a ping message and wait for the client's response. This method takes a
-message string, and an optional callback that fires when a matching pong
-message is received. It returns `true` iff a ping message was sent. If the
-client does not support ping/pong, this method sends no data and returns
-`false`.
+message string, and an optional callback that fires when a matching pong message
+is received. It returns `true` iff a ping message was sent. If the client does
+not support ping/pong, this method sends no data and returns `false`.
 
 ```js
 ws.ping('Mic check, one, two', function() {
@@ -122,7 +120,7 @@ including any authorization information, custom headers and TLS config you
 require. Only the `origin` setting is required.
 
 ```js
-var ws = new WebSocket.Client('ws://www.example.com/', null, {
+var ws = new WebSocket.Client('ws://www.example.com/', [], {
   proxy: {
     origin:  'http://username:password@proxy.example.com',
     headers: {'User-Agent': 'node'},
@@ -169,14 +167,14 @@ array of extensions to the `:extensions` option. For example, to add
 ```js
 var deflate = require('permessage-deflate');
 
-var ws = new WebSocket(request, null, {extensions: [deflate]});
+var ws = new WebSocket(request, socket, body, [], {extensions: [deflate]});
 ```
 
 
 ## Initialization options
 
-Both the server- and client-side classes allow an options object to be passed
-in at initialization time, for example:
+Both the server- and client-side classes allow an options object to be passed in
+at initialization time, for example:
 
 ```js
 var ws = new WebSocket(request, socket, body, protocols, options);
@@ -193,8 +191,8 @@ var ws = new WebSocket.Client(url, protocols, options);
   be sent during the handshake process
 * `maxLength` - the maximum allowed size of incoming message frames, in bytes.
   The default value is `2^26 - 1`, or 1 byte short of 64 MiB.
-* `ping` - an integer that sets how often the WebSocket should send ping
-  frames, measured in seconds
+* `ping` - an integer that sets how often the WebSocket should send ping frames,
+  measured in seconds
 
 The client accepts some additional options:
 
@@ -218,19 +216,19 @@ Both server- and client-side `WebSocket` objects support the following API.
   due to bad data sent by the other peer. This event is purely informational,
   you do not need to implement error recover.
 * <b>`on('close', function(event) {})`</b> fires when either the client or the
-  server closes the connection. Event has two optional attributes,
-  <b>`code`</b> and <b>`reason`</b>, that expose the status code and message
-  sent by the peer that closed the connection.
+  server closes the connection. Event has two optional attributes, <b>`code`</b>
+  and <b>`reason`</b>, that expose the status code and message sent by the peer
+  that closed the connection.
 * <b>`send(message)`</b> accepts either a `String` or a `Buffer` and sends a
   text or binary message over the connection to the other peer.
-* <b>`ping(message = '', function() {})`</b> sends a ping frame with an
-  optional message and fires the callback when a matching pong is received.
+* <b>`ping(message = '', function() {})`</b> sends a ping frame with an optional
+  message and fires the callback when a matching pong is received.
 * <b>`close(code, reason)`</b> closes the connection, sending the given status
   code and reason text, both of which are optional.
 * <b>`version`</b> is a string containing the version of the `WebSocket`
   protocol the connection is using.
-* <b>`protocol`</b> is a string (which may be empty) identifying the
-  subprotocol the socket is using.
+* <b>`protocol`</b> is a string (which may be empty) identifying the subprotocol
+  the socket is using.
 
 
 ## Handling EventSource connections in Node
@@ -283,8 +281,8 @@ The `EventSource` object exposes the following properties:
 * <b>`url`</b> is a string containing the URL the client used to create the
   EventSource.
 * <b>`lastEventId`</b> is a string containing the last event ID received by the
-  client. You can use this when the client reconnects after a dropped
-  connection to determine which messages need resending.
+  client. You can use this when the client reconnects after a dropped connection
+  to determine which messages need resending.
 
 When you initialize an EventSource with ` new EventSource()`, you can pass
 configuration options after the `response` parameter. Available options are:
@@ -293,9 +291,9 @@ configuration options after the `response` parameter. Available options are:
   EventSource response.
 * <b>`retry`</b> is a number that tells the client how long (in seconds) it
   should wait after a dropped connection before attempting to reconnect.
-* <b>`ping`</b> is a number that tells the server how often (in seconds) to
-  send 'ping' packets to the client to keep the connection open, to defeat
-  timeouts set by proxies. The client will ignore these messages.
+* <b>`ping`</b> is a number that tells the server how often (in seconds) to send
+  'ping' packets to the client to keep the connection open, to defeat timeouts
+  set by proxies. The client will ignore these messages.
 
 For example, this creates a connection that allows access from any origin, pings
 every 15 seconds and is retryable every 10 seconds if the connection is broken:
@@ -317,22 +315,21 @@ some data over the wire to keep the connection alive.
 
 (The MIT License)
 
-Copyright (c) 2010-2014 James Coglan
+Copyright (c) 2010-2015 James Coglan
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the 'Software'), to deal in
 the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
-of the Software, and to permit persons to whom the Software is furnished to do
-so, subject to the following conditions:
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

examples/autobahn_client.js

@@ -25,7 +25,7 @@ var runCase = function(n) {
   }
 
   url = host + '/runCase?case=' + n + '&agent=' + agent;
-  socket = new WebSocket.Client(url, null, options);
+  socket = new WebSocket.Client(url, [], options);
   socket.pipe(socket);
 
   socket.on('close', function() {

examples/client.js

@@ -5,7 +5,7 @@ var url     = process.argv[2],
     headers = {Origin: 'http://faye.jcoglan.com'},
     ca      = fs.readFileSync(__dirname + '/../spec/server.crt'),
     proxy   = {origin: process.argv[3], headers: {'User-Agent': 'Echo'}, tls: {ca: ca}},
-    ws      = new WebSocket.Client(url, null, {headers: headers, proxy: proxy, tls: {ca: ca}});
+    ws      = new WebSocket.Client(url, [], {headers: headers, proxy: proxy, tls: {ca: ca}});
 
 ws.onopen = function() {
   console.log('[open]', ws.headers);

lib/faye/websocket.js

@@ -21,11 +21,11 @@ var WebSocket = function(request, socket, body, protocols, options) {
   var catchup = function() { self._stream.removeListener('data', catchup) };
   this._stream.on('data', catchup);
 
-  this._driver.io.write(body);
   API.call(this, options);
 
   process.nextTick(function() {
     self._driver.start();
+    self._driver.io.write(body);
   });
 };
 util.inherits(WebSocket, API);
@@ -34,6 +34,10 @@ WebSocket.isWebSocket = function(request) {
   return driver.isWebSocket(request);
 };
 
+WebSocket.validateOptions = function(options, validKeys) {
+  driver.validateOptions(options, validKeys);
+};
+
 WebSocket.WebSocket   = WebSocket;
 WebSocket.Client      = require('./websocket/client');
 WebSocket.EventSource = require('./eventsource');

lib/faye/websocket/api.js

@@ -1,10 +1,12 @@
 var Stream      = require('stream').Stream,
     util        = require('util'),
+    driver      = require('websocket-driver'),
     EventTarget = require('./api/event_target'),
     Event       = require('./api/event');
 
 var API = function(options) {
   options = options || {};
+  driver.validateOptions(options, ['headers', 'extensions', 'maxLength', 'ping', 'proxy', 'tls', 'ca']);
 
   this.readable = this.writable = true;
 
@@ -30,13 +32,10 @@ var API = function(options) {
 
   this._driver.on('open',    function(e) { self._open() });
   this._driver.on('message', function(e) { self._receiveMessage(e.data) });
-  this._driver.on('close',   function(e) { self._finalize(e.reason, e.code) });
+  this._driver.on('close',   function(e) { self._beginClose(e.reason, e.code) });
 
   this._driver.on('error', function(error) {
-    var event = new Event('error', {message: error.message});
-    event.initEvent('error', false, false);
-    self.dispatchEvent(event);
-    self._finalize('', 1006);
+    self._emitError(error.message);
   });
   this.on('error', function() {});
 
@@ -105,11 +104,12 @@ var instance = {
     this._stream.setNoDelay(true);
 
     ['close', 'end'].forEach(function(event) {
-      this._stream.on(event, function() { self._finalize('', 1006) });
+      this._stream.on(event, function() { self._finalizeClose() });
     }, this);
 
     this._stream.on('error', function(error) {
-      self._driver.emit('error', new Error('Network error: ' + self.url + ': ' + error.message));
+      self._emitError('Network error: ' + self.url + ': ' + error.message);
+      self._finalizeClose();
     });
   },
 
@@ -134,7 +134,26 @@ var instance = {
     this.dispatchEvent(event);
   },
 
-  _finalize: function(reason, code) {
+  _emitError: function(message) {
+    if (this.readyState >= API.CLOSING) return;
+
+    var event = new Event('error', {message: message});
+    event.initEvent('error', false, false);
+    this.dispatchEvent(event);
+  },
+
+  _beginClose: function(reason, code) {
+    if (this.readyState === API.CLOSED) return;
+    this.readyState = API.CLOSING;
+
+    if (this._stream) {
+      this._stream.end();
+      if (!this._stream.readable) this._finalizeClose();
+    }
+    this._closeParams = [reason, code];
+  },
+
+  _finalizeClose: function() {
     if (this.readyState === API.CLOSED) return;
     this.readyState = API.CLOSED;
 
@@ -144,7 +163,10 @@ var instance = {
     if (this.readable) this.emit('end');
     this.readable = this.writable = false;
 
-    var event = new Event('close', {code: code || 1000, reason: reason || ''});
+    var reason = this._closeParams ? this._closeParams[0] : '',
+        code   = this._closeParams ? this._closeParams[1] : 1006;
+
+    var event = new Event('close', {code: code, reason: reason});
     event.initEvent('close', false, false);
     this.dispatchEvent(event);
   }

package.json

@@ -5,10 +5,10 @@
 , "keywords"        : ["websocket", "eventsource"]
 , "license"         : "MIT"
 
-, "version"         : "0.9.0"
+, "version"         : "0.9.4"
 , "engines"         : {"node": ">=0.4.0"}
 , "main"            : "./lib/faye/websocket"
-, "dependencies"    : {"websocket-driver": ">=0.5.0"}
+, "dependencies"    : {"websocket-driver": ">=0.5.1"}
 , "devDependencies" : {"jstest": "", "pace": "", "permessage-deflate": ""}
 
 , "scripts"         : {"test": "jstest spec/runner.js"}

spec/faye/websocket/client_spec.js

@@ -211,7 +211,7 @@ test.describe("Client", function() { with(this) {
 
     it("can be closed before connecting", function() { with(this) {
       open_socket_and_close_it_fast(socket_url, protocols)
-      wait(10)
+      wait(100)
       check_closed()
       check_never_opened()
       check_not_readable()