WebSocket protocol handler with pluggable I/O. 

WebSocket protocol handler with pluggable I/O

jcoglan

websocket-driver

* When the peer sends a close frame with no error code, emit 1000

* Use the `buffer.{read,write}UInt{16,32}BE` methods for reading/writing numbers

  to buffers rather than including duplicate logic for this

* Allow the parser to recover cleanly if event listeners raise an error

* Add a `pong` method for sending unsolicited pong frames

* Don't emit extra close frames if we receive a close frame after we already

* Fail the connection when the driver receives an invalid

* Don't treat incoming data as WebSocket frames if a client driver is closed

* Fix compatibility with the HTTP parser on io.js

* Use `websocket-extensions` to make sure messages and close frames are kept in

* Don't allow drivers to be created with unrecognized options

* Support protocol extensions via the websocket-extensions module

* Support connection via HTTP proxies using `CONNECT`

* It is now possible to call `close()` before `start()` and close the driver

* Don't hold references to frame buffers after a message has been emitted

* Make sure that `protocol` and `version` are exposed properly by the TCP driver

* Don't hold memory-leaking references to I/O buffers after they have been

* Correct the draft-76 status line reason phrase

* Expand `maxLength` to cover sequences of continuation frames and

* Decrease default maximum frame buffer size to 64MB

* Stop parsing when the protocol enters a failure mode, to save CPU cycles

* Add a `maxLength` option to limit allowed frame size

* Don't pre-allocate a message buffer until the whole frame has arrived

* Fix compatibility with Node v0.11 `HTTPParser`

* Support client URLs with Basic Auth credentials

* No functional changes, just updates to package.json

* Export the isSecureRequest() method since faye-websocket relies on it

* Queue sent messages in the client's initial state

* Add API for setting and reading headers

* Add Driver.server() method for getting a driver for TCP servers

    Extensions = require('websocket-extensions'),

    Frame      = require('./hybi/frame'),

    Message    = require('./hybi/message');

var Hybi = function(request, url, options) {

  this._extensions     = new Extensions();

  this._masking        = this._options.masking;

  this._protocols      = this._options.protocols || [];

  this._requireMasking = this._options.requireMasking;

  if (typeof this._protocols === 'string')

    this._protocols = this._protocols.split(/ *, */);

  var secKey    = this._request.headers['sec-websocket-key'],

      protos    = this._request.headers['sec-websocket-protocol'],

      version   = this._request.headers['sec-websocket-version'],

  this._headers.set('Upgrade', 'websocket');

  this._headers.set('Connection', 'Upgrade');

  this._headers.set('Sec-WebSocket-Accept', Hybi.generateAccept(secKey));

    if (typeof protos === 'string') protos = protos.split(/ *, */);

    this.protocol = protos.filter(function(p) { return supported.indexOf(p) >= 0 })[0];

    if (this.protocol) this._headers.set('Sec-WebSocket-Protocol', this.protocol);

Hybi.mask = function(payload, mask, offset) {

  if (!mask || mask.length === 0) return payload;

  for (var i = 0, n = payload.length - offset; i < n; i++) {

    payload[offset + i] = payload[offset + i] ^ mask[i % 4];

Hybi.GUID = '258EAFA5-E914-47DA-95CA-C5AB0DC85B11';

  ERROR_CODES:        [1000, 1001, 1002, 1003, 1007, 1008, 1009, 1010, 1011],

  // http://www.w3.org/International/questions/qa-forms-utf-8.en.php

  UTF8_MATCH: /^([\x00-\x7F]|[\xC2-\xDF][\x80-\xBF]|\xE0[\xA0-\xBF][\x80-\xBF]|[\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}|\xED[\x80-\x9F][\x80-\xBF]|\xF0[\x90-\xBF][\x80-\xBF]{2}|[\xF1-\xF3][\x80-\xBF]{3}|\xF4[\x80-\x8F][\x80-\xBF]{2})*$/,

          if (buffer) this._parseOpcode(buffer[0]);

          if (buffer) this._parseLength(buffer[0]);

          buffer = this._reader.read(this._frame.lengthBytes);

          if (buffer) this._parseExtendedLength(buffer);

            this._frame.maskingKey = buffer;

          buffer = this._reader.read(this._frame.length);

    if (this.readyState > 1) return false;

    return this.frame(message, 'binary');

    if (callback) this._pingCallbacks[message] = callback;

      if (this.readyState > 1) return false;

      return this.frame(message, 'pong');

    code   = code   || this.ERRORS.normal_closure;

      this.emit('close', new Base.CloseEvent(code, reason));

      this._extensions.close(function() { this.frame(reason, 'close', code) }, this);

    if (this.readyState <= 0) return this._queue([buffer, type, code]);

    if (this.readyState > 2) return false;

    if (buffer instanceof Array) buffer = new Buffer(buffer);

        isText  = (typeof buffer === 'string'),

      code   = (payload.length >= 2) ? 256 * payload[0] + payload[1] : null;

      code   = (payload.length >= 2) ? payload.readUInt16BE(0) : null;

      reason = (payload.length > 2) ? this._encode(payload.slice(2)) : null;

          !(code !== null && code >= this.MIN_RESERVED_ERROR && code <= this.MAX_RESERVED_ERROR) &&

          this.ERROR_CODES.indexOf(code) < 0)

        code = this.ERRORS.protocol_error;

      if (payload.length > 125 || (payload.length > 2 && !reason))

      this._shutdown(code, reason || '');

      this._shutdown(code || this.DEFAULT_ERROR_CODE, reason || '');

    this._extensions.processIncomingMessage(message, function(error, message) {

      if (error) return this._fail('extension_error', error.message);

      if (message.opcode === this.OPCODES.text) payload = this._encode(payload);

        return this._fail('encoding_error', 'Could not decode a text frame as UTF-8');

        this.emit('message', new Base.MessageEvent(payload));

      var string = buffer.toString('binary', 0, buffer.length);

      if (!this.UTF8_MATCH.test(string)) return null;

    return buffer.toString('utf8', 0, buffer.length);

    if (buffer.length === 2) return buffer.readUInt16BE(0);

    return buffer.readUInt32BE(0) * 0x100000000 +

, "description"     : "WebSocket protocol handler with pluggable I/O"

, "homepage"        : "http://github.com/faye/websocket-driver-node"

, "author"          : "James Coglan <jcoglan@gmail.com> (http://jcoglan.com/)"

, "engines"         : {"node": ">=0.6.0"}

, "main"            : "./lib/websocket/driver"

, "dependencies"    : {"websocket-extensions": ">=0.1.1"}

, "devDependencies" : {"jstest": "", "permessage-deflate": ""}

, "scripts"         : {"test": "jstest spec/runner.js"}

                      , "url"   : "git://github.com/faye/websocket-driver-node.git"

, "bugs"            : "http://github.com/faye/websocket-driver-node/issues"

		@@ -0,1 +1,5 @@
		### 0.6.2 / 2015-07-18

		* When the peer sends a close frame with no error code, emit 1000

		### 0.6.1 / 2015-07-13
		@@ -2,0 +6,0 @@

		@@ -97,2 +97,3 @@ 'use strict';
		ERROR_CODES: [1000, 1001, 1002, 1003, 1007, 1008, 1009, 1010, 1011],
		DEFAULT_ERROR_CODE: 1000,
		MIN_RESERVED_ERROR: 3000,
		@@ -407,3 +408,3 @@ MAX_RESERVED_ERROR: 4999,
		if (opcode === this.OPCODES.close) {
		code = (payload.length >= 2) ? 256 * payload[0] + payload[1] : null;
		code = (payload.length >= 2) ? payload.readUInt16BE(0) : null;
		reason = (payload.length > 2) ? this._encode(payload.slice(2)) : null;
		@@ -419,3 +420,3 @@

		this._shutdown(code, reason \|\| '');
		this._shutdown(code \|\| this.DEFAULT_ERROR_CODE, reason \|\| '');
		}
		@@ -422,0 +423,0 @@

		@@ -8,3 +8,3 @@ { "name" : "websocket-driver"

		, "version" : "0.6.1"
		, "version" : "0.6.2"
		, "engines" : {"node": ">=0.6.0"}
		@@ -11,0 +11,0 @@ , "main" : "./lib/websocket/driver"

Improved metrics