Release 1.3.6

Added tests for volatile

.npmignore

@@ -1,3 +1,4 @@
 support
 test
 examples
+.gitignore

.travis.yml

@@ -4,6 +4,9 @@ node_js:
   - "0.10"
   - "0.11"
 
+git:
+  depth: 1
+
 matrix:
   fast_finish: true
   allow_failures:

History.md

@@ -1,4 +1,128 @@
 
+1.3.6 / 2015-07-14
+==================
+
+  * package: bump `engine.io` to fix build on windows
+
+1.3.5 / 2015-03-03
+==================
+
+ * package: bump `socket.io-parser`
+
+1.3.4 / 2015-02-14
+==================
+
+ * package: bump `socket.io-client`
+
+1.3.3 / 2015-02-03
+==================
+
+ * socket: warn node_redis-style about missing `error`
+ * package: bump parser to better handle bad binary packets
+
+1.3.2 / 2015-01-19
+==================
+
+ * no change on this release
+
+1.3.1 / 2015-01-19
+==================
+
+ * no change on this release
+ * package: bump `engine.io`
+
+1.3.0 / 2015-01-19
+==================
+
+ * package: bump `engine.io`
+ * add test for reconnection after server restarts [rase-]
+ * update license with up-to-date year range [fay-jai]
+ * fix leaving unknown rooms [defunctzombie]
+ * allow null origins when allowed origins is a function [drewblaisdell]
+ * fix tests on node 0.11
+ * package: fix `npm test` to run on windows
+ * package: bump `debug` v2.1.0 [coderaiser]
+ * added tests for volatile [rase-]
+
+1.2.1 / 2014-11-21
+==================
+
+ * fix protocol violations and improve error handling (GH-1880)
+ * package: bump `engine.io` for websocket leak fix [3rd-Eden]
+ * style tweaks
+
+1.2.0 / 2014-10-27
+==================
+
+ * package: bump `engine.io`
+ * downloads badge
+ * add test to check that empty rooms are autopruned
+ * added Server#origins(v:Function) description for dynamic CORS
+ * added test coverage for Server#origins(function) for dynamic CORS
+ * added optional Server#origins(function) for dynamic CORS
+ * fix usage example for Server#close
+ * package: fix main file for example application 'chat'
+ * package: bump `socket.io-parser`
+ * update README http ctor to createServer()
+ * bump adapter with a lot of fixes for room bookkeeping
+
+1.1.0 / 2014-09-04
+==================
+
+ * examples: minor fix of escaping
+ * testing for equivalence of namespaces starting with / or without
+ * update index.js
+ * added relevant tests
+ * take "" and "/" as equivalent namespaces on server
+ * use svg instead of png to get better image quality in readme
+ * make CI build faster
+ * fix splice arguments and `socket.rooms` value update in `socket.leaveAll`.
+ * client cannot connect to non-existing namespaces
+ * bump engine.io version to get the cached IP address
+ * fixed handshake object address property and made the test case more strict.
+ * package: bump `engine.io`
+ * fixed the failing test where server crashes on disconnect involving connectBuffer
+ * npmignore: ignore `.gitignore` (fixes #1607)
+ * test: added failing case for `socket.disconnect` and nsps
+ * fix repo in package.json
+ * improve Close documentation
+ * use ephemeral ports
+ * fix: We should use the standard http protocol to handler the etag header.
+ * override default browser font-family for inputs
+ * update has-binary-data to 1.0.3
+ * add close specs
+ * add ability to stop the http server even if not created inside socket.io
+ * make sure server gets close
+ * Add test case for checking that reconnect_failed is fired only once upon failure
+ * package: bump `socket.io-parser` for `component-emitter` dep fix
+
+1.0.6 / 2014-06-19
+==================
+
+ * package: bump `socket.io-client`
+
+1.0.5 / 2014-06-16
+==================
+
+ * package: bump `engine.io` to fix jsonp `\n` bug and CORS warnings
+ * index: fix typo [yanatan16]
+ * add `removeListener` to blacklisted events
+ * examples: clearer instructions to install chat example
+ * index: fix namespace `connectBuffer` issue
+
+1.0.4 / 2014-06-02
+==================
+
+ * package: bump socket.io-client
+
+1.0.3 / 2014-05-31
+==================
+
+ * package: bump `socket.io-client`
+ * package: bump `socket.io-parser` for binary ACK fix
+ * package: bump `engine.io` for binary UTF8 fix
+ * example: fix XSS in chat example
+
 1.0.2 / 2014-05-28
 ==================
 

LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2014 Automattic <dev@cloudup.com>
+Copyright (c) 2014-2015 Automattic <dev@cloudup.com>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

Readme.md

@@ -1,11 +1,9 @@
-### This Readme corresponds to the upcoming 1.0 release. Please refer to http://socket.io for the current 0.9.x documentation.
-
-<hr />
 
 # socket.io
 
-[![Build Status](https://secure.travis-ci.org/automattic/socket.io.png)](http://travis-ci.org/automattic/socket.io)
-[![NPM version](https://badge.fury.io/js/socket.io.png)](http://badge.fury.io/js/socket.io)
+[![Build Status](https://secure.travis-ci.org/Automattic/socket.io.svg)](http://travis-ci.org/Automattic/socket.io)
+![NPM version](https://badge.fury.io/js/socket.io.svg)
+![Downloads](http://img.shields.io/npm/dm/socket.io.svg?style=flat)
 
 ## How to use
 
@@ -13,7 +11,7 @@ The following example attaches socket.io to a plain Node.JS
 HTTP server listening on port `3000`.
 
 ```js
-var server = require('http').Server();
+var server = require('http').createServer();
 var io = require('socket.io')(server);
 io.on('connection', function(socket){
   socket.on('event', function(data){});
@@ -39,7 +37,7 @@ function.
 
 ```js
 var app = require('express')();
-var server = require('http').Server(app);
+var server = require('http').createServer(app);
 var io = require('socket.io')(server);
 io.on('connection', function(){ /* … */ });
 server.listen(3000);
@@ -52,7 +50,7 @@ handler function, but only by calling the `callback` method.
 
 ```js
 var app = require('koa')();
-var server = require('http').Server(app.callback());
+var server = require('http').createServer(app.callback());
 var io = require('socket.io')(server);
 io.on('connection', function(){ /* … */ });
 server.listen(3000);
@@ -129,7 +127,7 @@ server.listen(3000);
 
   Sets the adapter `v`. Defaults to an instance of the `Adapter` that
   ships with socket.io which is memory based. See
-  [socket.io-adapter](https://github.com/learnboost/socket.io-adapter).
+  [socket.io-adapter](https://github.com/Automattic/socket.io-adapter).
 
   If no arguments are supplied this method returns the current value.
 
@@ -139,6 +137,15 @@ server.listen(3000);
 
   If no arguments are supplied this method returns the current value.
 
+### Server#origins(v:Function):Server
+
+  Sets the allowed origins as dynamic function. Function takes two arguments `origin:String` and `callback(error, success)`, where `success` is a boolean value indicating whether origin is allowed or not.
+
+  __Potential drawbacks__:
+  * in some situations, when it is not possible to determine `origin` it may have value of `*`
+  * As this function will be executed for every request, it is advised to make this function work as fast as possible
+  * If `socket.io` is used together with `Express`, the CORS headers will be affected only for `socket.io` requests. For Express can use [cors](https://github.com/troygoode/node-cors/)
+
 
 ### Server#sockets:Namespace
 
@@ -160,7 +167,7 @@ server.listen(3000);
 
 ### Server#bind(srv:engine#Server):Server
 
-  Advanced use only. Binds the server to a specific engine.io `Server` 
+  Advanced use only. Binds the server to a specific engine.io `Server`
   (or compatible API) instance.
 
 ### Server#onconnection(socket:engine#Socket):Server
@@ -170,14 +177,14 @@ server.listen(3000);
 
 ### Server#of(nsp:String):Namespace
 
-  Initializes and retrieves the given `Namespace` by its pathname 
+  Initializes and retrieves the given `Namespace` by its pathname
   identifier `nsp`.
 
   If the namespace was already initialized it returns it right away.
 
 ### Server#emit
 
-  Emits an event to all connected clients. The following two are 
+  Emits an event to all connected clients. The following two are
   equivalent:
 
   ```js
@@ -188,6 +195,24 @@ server.listen(3000);
 
   For other available methods, see `Namespace` below.
 
+### Server#close
+
+  Closes socket server
+
+  ```js
+  var Server = require('socket.io');
+  var PORT   = 3030;
+  var server = require('http').Server();
+
+  var io = Server(PORT);
+
+  io.close(); // Close current server
+
+  server.listen(PORT); // PORT is free to use
+
+  io = Server(server);
+  ```
+
 ### Server#use
 
   See `Namespace#use` below.
@@ -249,7 +274,7 @@ server.listen(3000);
 
 ### Socket#conn:Socket
 
-  A reference to the underyling `Client` transport connection (engine.io
+  A reference to the underlying `Client` transport connection (engine.io
   `Socket` object).
 
 ### Socket#request:Request
@@ -288,7 +313,7 @@ server.listen(3000);
 
   The mechanics of joining  rooms are handled by the `Adapter`
   that has been configured (see `Server#adapter` above), defaulting to
-  [socket.io-adapter](https://github.com/socket.io/socket.io-adapter).
+  [socket.io-adapter](https://github.com/Automattic/socket.io-adapter).
 
 ### Socket#leave(name:String[, fn:Function]):Socket
 
@@ -299,7 +324,7 @@ server.listen(3000);
 
   The mechanics of leaving rooms are handled by the `Adapter`
   that has been configured (see `Server#adapter` above), defaulting to
-  [socket.io-adapter](https://github.com/socket.io/socket.io-adapter).
+  [socket.io-adapter](https://github.com/Automattic/socket.io-adapter).
 
 ### Socket#to(room:String):Socket
 ### Socket#in(room:String):Socket

examples/chat/README.md

@@ -6,17 +6,20 @@ A simple chat demo for socket.io
 ## How to use
 
 ```
+$ cd socket.io
+$ npm install
+$ cd examples/chat
 $ npm install
 $ node .
 ```
 
-And point your browser to `http://localhost:3000`. Optionally specify
+And point your browser to `http://localhost:3000`. Optionally, specify
 a port by supplying the `PORT` env variable.
 
 ## Features
 
-- Multiple users can join a chat room by entering a unique username
+- Multiple users can join a chat room by each entering a unique username
 on website load.
-- Users can type chat messages to the chat room
+- Users can type chat messages to the chat room.
 - A notification is sent to all users when a user joins or leaves
-the chatroom
+the chatroom.

examples/chat/package.json

@@ -2,7 +2,7 @@
   "name": "socket.io-chat",
   "version": "0.0.0",
   "description": "A simple chat client using socket.io",
-  "main": "app.js",
+  "main": "index.js",
   "author": "Grant Timmerman",
   "private": true,
   "license": "BSD",

examples/chat/public/main.js

@@ -30,7 +30,7 @@ $(function() {
     if (data.numUsers === 1) {
       message += "there's 1 participant";
     } else {
-      message += "there're " + data.numUsers + " participants";
+      message += "there are " + data.numUsers + " participants";
     }
     log(message);
   }
@@ -70,8 +70,8 @@ $(function() {
 
   // Log a message
   function log (message, options) {
-    var el = '<li class="log">' + message + '</li>';
-    addMessageElement(el, options);
+    var $el = $('<li>').addClass('log').text(message);
+    addMessageElement($el, options);
   }
 
   // Adds the visual chat message to the message list
@@ -84,16 +84,17 @@ $(function() {
       $typingMessages.remove();
     }
 
-    var colorStyle = 'style="color:' + getUsernameColor(data.username) + '"';
-    var usernameDiv = '<span class="username"' + colorStyle + '>' +
-      data.username + '</span>';
-    var messageBodyDiv = '<span class="messageBody">' +
-      data.message + '</span>';
+    var $usernameDiv = $('<span class="username"/>')
+      .text(data.username)
+      .css('color', getUsernameColor(data.username));
+    var $messageBodyDiv = $('<span class="messageBody">')
+      .text(data.message);
 
     var typingClass = data.typing ? 'typing' : '';
-    var messageDiv = '<li class="message ' + typingClass + '">' +
-    usernameDiv + messageBodyDiv + '</li>';
-    var $messageDiv = $(messageDiv).data('username', data.username);
+    var $messageDiv = $('<li class="message"/>')
+      .data('username', data.username)
+      .addClass(typingClass)
+      .append($usernameDiv, $messageBodyDiv);
 
     addMessageElement($messageDiv, options);
   }
@@ -145,7 +146,7 @@ $(function() {
 
   // Prevents input from having injected markup
   function cleanInput (input) {
-    return $('<div/>').text(input).html() || input;
+    return $('<div/>').text(input).text();
   }
 
   // Updates the typing event
@@ -228,7 +229,7 @@ $(function() {
   socket.on('login', function (data) {
     connected = true;
     // Display the welcome message
-    var message = "Welcome to Socket.IO Chat &mdash; ";
+    var message = "Welcome to Socket.IO Chat – ";
     log(message, {
       prepend: true
     });
@@ -262,4 +263,4 @@ $(function() {
   socket.on('stop typing', function (data) {
     removeChatTyping(data);
   });
-});
+});

examples/chat/public/style.css

@@ -5,6 +5,11 @@
 }
 
 html {
+  font-weight: 300;
+  -webkit-font-smoothing: antialiased;
+}
+
+html, input {
   font-family:
     "HelveticaNeue-Light",
     "Helvetica Neue Light",
@@ -13,8 +18,6 @@ html {
     Arial,
     "Lucida Grande",
     sans-serif;
-  font-weight: 300;
-  -webkit-font-smoothing: antialiased;
 }
 
 html, body {
@@ -25,6 +28,7 @@ html, body {
 
 ul {
   list-style: none;
+  word-wrap: break-word;
 }
 
 /* Pages */
@@ -143,4 +147,4 @@ ul {
   position: absolute;
   right: 0;
   width: 100%;
-}
+}

lib/client.js

@@ -42,9 +42,12 @@ function Client(server, conn){
 Client.prototype.setup = function(){
   this.onclose = this.onclose.bind(this);
   this.ondata = this.ondata.bind(this);
+  this.onerror = this.onerror.bind(this);
   this.ondecoded = this.ondecoded.bind(this);
+
   this.decoder.on('decoded', this.ondecoded);
   this.conn.on('data', this.ondata);
+  this.conn.on('error', this.onerror);
   this.conn.on('close', this.onclose);
 };
 
@@ -57,6 +60,10 @@ Client.prototype.setup = function(){
 
 Client.prototype.connect = function(name){
   debug('connecting to namespace %s', name);
+  if (!this.server.nsps[name]) {
+    this.packet({ type: parser.ERROR, nsp: name, data : 'Invalid namespace'});
+    return;
+  }
   var nsp = this.server.of(name);
   if ('/' != name && !this.nsps['/']) {
     this.connectBuffer.push(name);
@@ -68,9 +75,9 @@ Client.prototype.connect = function(name){
     self.sockets.push(socket);
     self.nsps[nsp.name] = socket;
 
-    if ('/' == nsp.name) {
+    if ('/' == nsp.name && self.connectBuffer.length > 0) {
       self.connectBuffer.forEach(self.connect, self);
-      delete self.connectBuffer;
+      self.connectBuffer = [];
     }
   });
 };
@@ -163,7 +170,12 @@ Client.prototype.packet = function(packet, preEncoded, volatile){
  */
 
 Client.prototype.ondata = function(data){
-  this.decoder.add(data);
+  // try/catch is needed for protocol violations (GH-1880)
+  try {
+    this.decoder.add(data);
+  } catch(e) {
+    this.onerror(e);
+  }
 };
 
 /**
@@ -185,6 +197,20 @@ Client.prototype.ondecoded = function(packet) {
   }
 };
 
+/**
+ * Handles an error.
+ *
+ * @param {Objcet} error object
+ * @api private
+ */
+
+Client.prototype.onerror = function(err){
+  this.sockets.forEach(function(socket){
+    socket.onerror(err);
+  });
+  this.onclose('client error');
+};
+
 /**
  * Called upon transport close.
  *
@@ -199,9 +225,10 @@ Client.prototype.onclose = function(reason){
   this.destroy();
 
   // `nsps` and `sockets` are cleaned up seamlessly
-  this.sockets.forEach(function(socket){
+  var socket;
+  while (socket = this.sockets.shift()) {
     socket.onclose(reason);
-  });
+  }
 
   this.decoder.destroy(); // clean up decoder
 };
@@ -214,6 +241,7 @@ Client.prototype.onclose = function(reason){
 
 Client.prototype.destroy = function(){
   this.conn.removeListener('data', this.ondata);
+  this.conn.removeListener('error', this.onerror);
   this.conn.removeListener('close', this.onclose);
   this.decoder.removeListener('decoded', this.ondecoded);
 };

lib/index.js

@@ -62,8 +62,9 @@ Server.prototype.checkRequest = function(req, fn) {
   var origin = req.headers.origin || req.headers.referer;
 
   // file:// URLs produce a null Origin which can't be authorized via echo-back
-  if ('null' == origin) origin = '*';
+  if ('null' == origin || null == origin) origin = '*';
 
+  if (!!origin && typeof(this._origins) == 'function') return this._origins(origin, fn);
   if (this._origins.indexOf('*:*') !== -1) return fn(null, true);
   if (origin) {
     try {
@@ -159,7 +160,9 @@ Server.prototype.adapter = function(v){
   if (!arguments.length) return this._adapter;
   this._adapter = v;
   for (var i in this.nsps) {
-    this.nsps[i].initAdapter();
+    if (this.nsps.hasOwnProperty(i)) {
+      this.nsps[i].initAdapter();
+    }
   }
   return this;
 };
@@ -191,7 +194,7 @@ Server.prototype.origins = function(v){
 Server.prototype.listen =
 Server.prototype.attach = function(srv, opts){
   if ('function' == typeof srv) {
-    var msg = 'You are trying to attach socket.io to an express' +
+    var msg = 'You are trying to attach socket.io to an express ' +
     'request handler function. Please pass a http.Server instance.';
     throw new Error(msg);
   }
@@ -209,11 +212,12 @@ Server.prototype.attach = function(srv, opts){
       res.end();
     });
     srv.listen(port);
+
   }
 
   // set engine.io path to `/socket.io`
   opts = opts || {};
-  opts.path = opts.path || '/socket.io';
+  opts.path = opts.path || this.path();
   // set origins verification
   opts.allowRequest = this.checkRequest.bind(this);
 
@@ -224,6 +228,9 @@ Server.prototype.attach = function(srv, opts){
   // attach static file serving
   if (this._serveClient) this.attachServe(srv);
 
+  // Export http server
+  this.httpServer = srv;
+
   // bind to engine events
   this.bind(this.eio);
 
@@ -263,8 +270,9 @@ Server.prototype.attachServe = function(srv){
  */
 
 Server.prototype.serve = function(req, res){
-  if (req.headers.etag) {
-    if (clientVersion == req.headers.etag) {
+  var etag = req.headers['if-none-match'];
+  if (etag) {
+    if (clientVersion == etag) {
       debug('serve client 304');
       res.writeHead(304);
       res.end();
@@ -317,6 +325,8 @@ Server.prototype.onconnection = function(conn){
  */
 
 Server.prototype.of = function(name, fn){
+  if (String(name)[0] !== '/') name = '/' + name;
+  
   if (!this.nsps[name]) {
     debug('initializing namespace %s', name);
     var nsp = new Namespace(this, name);
@@ -326,6 +336,24 @@ Server.prototype.of = function(name, fn){
   return this.nsps[name];
 };
 
+/**
+ * Closes server connection
+ *
+ * @api public
+ */
+
+Server.prototype.close = function(){
+  this.nsps['/'].sockets.forEach(function(socket){
+    socket.onclose();
+  });
+
+  this.engine.close();
+
+  if(this.httpServer){
+    this.httpServer.close();
+  }
+};
+
 /**
  * Expose main namespace (/).
  */

lib/socket.js

@@ -25,7 +25,8 @@ exports.events = [
   'error',
   'connect',
   'disconnect',
-  'newListener'
+  'newListener',
+  'removeListener'
 ];
 
 /**
@@ -107,7 +108,7 @@ Socket.prototype.buildHandshake = function(){
   return {
     headers: this.request.headers,
     time: (new Date) + '',
-    address: this.request.connection.address(),
+    address: this.conn.remoteAddress,
     xdomain: !!this.request.headers.origin,
     secure: !!this.request.connection.encrypted,
     issued: +(new Date),
@@ -241,7 +242,10 @@ Socket.prototype.leave = function(room, fn){
   this.adapter.del(this.id, room, function(err){
     if (err) return fn && fn(err);
     debug('left room %s', room);
-    self.rooms.splice(self.rooms.indexOf(room, 1));
+    var idx = self.rooms.indexOf(room);
+    if (idx >= 0) {
+      self.rooms.splice(idx, 1);
+    }
     fn && fn(null);
   });
   return this;
@@ -255,6 +259,7 @@ Socket.prototype.leave = function(room, fn){
 
 Socket.prototype.leaveAll = function(){
   this.adapter.delAll(this.id);
+  this.rooms = [];
 };
 
 /**
@@ -293,6 +298,10 @@ Socket.prototype.onpacket = function(packet){
       this.onack(packet);
       break;
 
+    case parser.BINARY_ACK:
+      this.onack(packet);
+      break;
+
     case parser.DISCONNECT:
       this.ondisconnect();
       break;
@@ -336,9 +345,11 @@ Socket.prototype.ack = function(id){
     if (sent) return;
     var args = Array.prototype.slice.call(arguments);
     debug('sending ack %j', args);
+
+    var type = hasBin(args) ? parser.BINARY_ACK : parser.ACK;
     self.packet({
       id: id,
-      type: parser.ACK,
+      type: type,
       data: args
     });
   };
@@ -372,10 +383,26 @@ Socket.prototype.ondisconnect = function(){
   this.onclose('client namespace disconnect');
 };
 
+/**
+ * Handles a client error.
+ *
+ * @api private
+ */
+
+Socket.prototype.onerror = function(err){
+  if (this.listeners('error').length) {
+    this.emit('error', err);
+  } else {
+    console.error('Missing error handler on `socket`.');
+    console.error(err.stack);
+  }
+};
+
 /**
  * Called upon closing. Called by `Client`.
  *
  * @param {String} reason
+ * @param {Error} optional error object
  * @api private
  */
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "socket.io",
-  "version": "1.0.2",
+  "version": "1.3.6",
   "description": "node.js realtime framework server",
   "keywords": [
     "realtime",
@@ -13,18 +13,18 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git://github.com/LearnBoost/socket.io"
+    "url": "git://github.com/Automattic/socket.io"
   },
   "scripts": {
-    "test": "make test"
+    "test": "mocha --reporter dot --slow 200ms --bail"
   },
   "dependencies": {
-    "engine.io": "1.2.1",
-    "socket.io-parser": "2.1.5",
-    "socket.io-client": "1.0.2",
-    "socket.io-adapter": "0.2.0",
-    "has-binary-data": "0.1.1",
-    "debug": "0.7.4"
+    "engine.io": "1.5.2",
+    "socket.io-parser": "2.2.4",
+    "socket.io-client": "1.3.6",
+    "socket.io-adapter": "0.3.1",
+    "has-binary-data": "0.1.3",
+    "debug": "2.1.0"
   },
   "devDependencies": {
     "mocha": "1.16.2",