[chore] release 1.5.0 (#2711)

Documentation update to help new programmers

.gitignore

@@ -9,4 +9,5 @@ lib-cov
 benchmarks/*.png
 node_modules
 coverage
-.idea
+.idea
+dist

.npmignore

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

.travis.yml

@@ -3,14 +3,22 @@ before_install:
   - npm install -g npm@'>=1.4.3'
 language: node_js
 node_js:
-  - "0.8"
   - "0.10"
   - "0.12"
   - "4"
+  - "node"
 
 git:
   depth: 1
 
+matrix:
+  include:
+  - node_js: '0.10'
+    env: TEST_VERSION=compat
+  - node_js: '0.12'
+    env: TEST_VERSION=compat
+  - node_js: '4'
+    env: TEST_VERSION=compat
 #matrix:
   #fast_finish: true
   #allow_failures:

History.md

@@ -1,4 +1,20 @@
 
+1.5.0 / 2016-10-06
+==================
+
+  * [feature] stop append /# before id when no namespace (#2508)
+  * [feature] Add a 'disconnecting' event to access to socket.rooms upon disconnection (#2332)
+  * [fix] Fix query string management (#2422)
+  * [fix] add quote to exec paths, prevent error when spaces in path (#2508)
+  * [docs] Prevent mixup for new programmers (#2599)
+  * [example] Fix chat display in Firefox (#2477)
+  * [chore] Add gulp & babel in the build process (#2471)
+  * [chore] Bump engine.io to 1.7.0 (#2707)
+  * [chore] Remove unused zuul-ngrok dependency (#2708)
+  * [chore] Point towards current master of socket.io-client (#2710)
+  * [chore] Restrict files included in npm package (#2709)
+  * [chore] Link build badge to master branch (#2549)
+
 1.4.8 / 2016-06-23
 ==================
 

Makefile

@@ -1,15 +1,8 @@
 
-REPORTER = dot
-
 test:
-	@./node_modules/.bin/mocha \
-		--reporter $(REPORTER) \
-		--slow 200ms \
-		--bail
+	@./node_modules/.bin/gulp test
 
 test-cov:
-	@./node_modules/.bin/istanbul cover ./node_modules/.bin/_mocha -- \
-		--reporter $(REPORTER) \
-		test/
+	@./node_modules/.bin/gulp test-cov
 
 .PHONY: test

Readme.md

@@ -1,7 +1,7 @@
 
 # socket.io
 
-[![Build Status](https://secure.travis-ci.org/socketio/socket.io.svg)](https://travis-ci.org/socketio/socket.io)
+[![Build Status](https://secure.travis-ci.org/socketio/socket.io.svg?branch=master)](https://travis-ci.org/socketio/socket.io)
 [![Dependency Status](https://david-dm.org/socketio/socket.io.svg)](https://david-dm.org/socketio/socket.io)
 [![devDependency Status](https://david-dm.org/socketio/socket.io/dev-status.svg)](https://david-dm.org/socketio/socket.io#info=devDependencies)
 ![NPM version](https://badge.fury.io/js/socket.io.svg)
@@ -16,9 +16,9 @@ HTTP server listening on port `3000`.
 ```js
 var server = require('http').createServer();
 var io = require('socket.io')(server);
-io.on('connection', function(socket){
-  socket.on('event', function(data){});
-  socket.on('disconnect', function(){});
+io.on('connection', function(client){
+  client.on('event', function(data){});
+  client.on('disconnect', function(){});
 });
 server.listen(3000);
 ```
@@ -27,7 +27,7 @@ server.listen(3000);
 
 ```js
 var io = require('socket.io')();
-io.on('connection', function(socket){});
+io.on('connection', function(client){});
 io.listen(3000);
 ```
 
@@ -200,7 +200,7 @@ server.listen(3000);
 
 ### Server#close
 
-  Closes socket server
+  Closes socket.io server
 
   ```js
   var Server = require('socket.io');
@@ -300,10 +300,13 @@ server.listen(3000);
   A `Socket` is the fundamental class for interacting with browser
   clients. A `Socket` belongs to a certain `Namespace` (by default `/`)
   and uses an underlying `Client` to communicate.
+  
+  It should be noted the `Socket` doesn't relate directly to the actual
+  underlying TCP/IP `socket` and it is only the name of the class.
 
 ### Socket#rooms:Object
 
-  A hash of strings identifying the rooms this socket is in, indexed by
+  A hash of strings identifying the rooms this client is in, indexed by
   room name.
 
 ### Socket#client:Client
@@ -313,7 +316,8 @@ server.listen(3000);
 ### Socket#conn:Socket
 
   A reference to the underlying `Client` transport connection (engine.io
-  `Socket` object).
+  `Socket` object). This allows access to the IO transport layer, which
+  still (mostly) asbtracts the actual TCP/IP socket.
 
 ### Socket#request:Request
 
@@ -323,30 +327,30 @@ server.listen(3000);
 
 ### Socket#id:String
 
-  A unique identifier for the socket session, that comes from the
+  A unique identifier for the session, that comes from the
   underlying `Client`.
 
 ### Socket#emit(name:String[, …]):Socket
 
-  Emits an event to the socket identified by the string `name`. Any
-  other parameters can be included.
+  Emits an event identified by the string `name` to the client.
+  Any other parameters can be included.
 
   All datastructures are supported, including `Buffer`. JavaScript
   functions can't be serialized/deserialized.
 
   ```js
   var io = require('socket.io')();
-  io.on('connection', function(socket){
-    socket.emit('an event', { some: 'data' });
+  io.on('connection', function(client){
+    client.emit('an event', { some: 'data' });
   });
   ```
 
 ### Socket#join(name:String[, fn:Function]):Socket
 
-  Adds the socket to the `room`, and fires optionally a callback `fn`
+  Adds the client to the `room`, and fires optionally a callback `fn`
   with `err` signature (if any).
 
-  The socket is automatically a member of a room identified with its
+  The client is automatically a member of a room identified with its
   session id (see `Socket#id`).
 
   The mechanics of joining  rooms are handled by the `Adapter`
@@ -355,7 +359,7 @@ server.listen(3000);
 
 ### Socket#leave(name:String[, fn:Function]):Socket
 
-  Removes the socket from `room`, and fires optionally a callback `fn`
+  Removes the client from `room`, and fires optionally a callback `fn`
   with `err` signature (if any).
 
   **Rooms are left automatically upon disconnection**.
@@ -367,14 +371,14 @@ server.listen(3000);
 ### Socket#to(room:String):Socket
 
   Sets a modifier for a subsequent event emission that the event will
-  only be _broadcasted_ to sockets that have joined the given `room`.
+  only be _broadcasted_ to clients that have joined the given `room`.
 
   To emit to multiple rooms, you can call `to` several times.
 
   ```js
   var io = require('socket.io')();
-  io.on('connection', function(socket){
-    socket.to('others').emit('an event', { some: 'data' });
+  io.on('connection', function(client){
+    client.to('others').emit('an event', { some: 'data' });
   });
   ```
 
@@ -389,10 +393,33 @@ server.listen(3000);
 
   ```js
   var io = require('socket.io')();
-  io.on('connection', function(socket){
-    socket.compress(false).emit('an event', { some: 'data' });
+  io.on('connection', function(client){
+    client.compress(false).emit('an event', { some: 'data' });
   });
   ```
+  
+### Socket#disconnect(close:Boolean):Socket
+    
+  Disconnects this client. If value of close is `true`, closes the underlying connection. 
+  Otherwise, it just disconnects the namespace.
+
+#### Events
+
+- `disconnect`
+    - Fired upon disconnection.
+    - **Arguments**
+      - `String`: the reason of the disconnection (either client or server-side)
+- `error`
+    - Fired when an error occurs.
+    - **Arguments**
+      - `Object`: error data
+- `disconnecting`
+    - Fired when the client is going to be disconnected (but hasn't left its `rooms` yet).
+    - **Arguments**
+      - `String`: the reason of the disconnection (either client or server-side)
+
+These are reserved events (along with `connect`, `newListener` and `removeListener`) which cannot be used as event names.
+
 
 ### Client
 
@@ -422,6 +449,17 @@ To see the output from all of Socket.IO's debugging scopes you can use:
 DEBUG=socket.io* node myapp
 ```
 
+## Testing
+
+```
+npm test
+```
+This runs the `gulp` task `test`. By default the test will be run with the source code in `lib` directory.
+
+Set the environmental variable `TEST_VERSION` to `compat` to test the transpiled es5-compat version of the code.
+
+The `gulp` task `test` will always transpile the source code into es5 and export to `dist` first before running the test.
+
 ## License
 
 MIT

examples/chat/package.json

@@ -7,6 +7,6 @@
   "private": true,
   "license": "BSD",
   "dependencies": {
-    "express": "3.4.8"
+    "express": "4.13.4"
   }
-}
+}

examples/chat/public/style.css

@@ -128,7 +128,6 @@ ul {
 }
 
 .username {
-  float: left;
   font-weight: 700;
   overflow: hidden;
   padding-right: 15px;

gulpfile.js

@@ -0,0 +1,69 @@
+const gulp = require('gulp');
+const mocha = require('gulp-mocha');
+const babel = require("gulp-babel");
+const istanbul = require('gulp-istanbul');
+const help = require('gulp-task-listing');
+const del = require('del');
+
+gulp.task('help', help);
+
+gulp.task('default', ['transpile']);
+
+const TRANSPILE_DEST_DIR = './dist';
+
+// By default, individual js files are transformed by babel and exported to /dist
+gulp.task('transpile', function () {
+  return gulp.src("lib/*.js")
+    .pipe(babel({ "presets": ["es2015"] }))
+    .pipe(gulp.dest(TRANSPILE_DEST_DIR));
+});
+
+gulp.task('clean', function () {
+  return del([TRANSPILE_DEST_DIR]);
+})
+
+gulp.task('test', ['transpile'], function(){
+  return gulp.src('test/socket.io.js', {read: false})
+    .pipe(mocha({
+      slow: 200,
+      reporter: 'spec',
+      bail: true,
+      timeout: 10000
+    }))
+    .once('error', function (err) {
+      console.error(err.stack);
+      process.exit(1);
+    })
+    .once('end', function () {
+      process.exit();
+    });
+});
+
+gulp.task('set-compat-node-env', function() {
+  process.env.TEST_VERSION = 'compat';
+});
+
+gulp.task('test-compat', ['set-compat-node-env', 'test']);
+
+gulp.task('istanbul-pre-test', function () {
+  return gulp.src(['lib/**/*.js'])
+    // Covering files
+    .pipe(istanbul())
+    // Force `require` to return covered files
+    .pipe(istanbul.hookRequire());
+});
+
+gulp.task('test-cov', ['istanbul-pre-test'], function(){
+  return gulp.src('test/socket.io.js', {read: false})
+    .pipe(mocha({
+      reporter: 'dot'
+    }))
+    .pipe(istanbul.writeReports())
+    .once('error', function (err){
+      console.error(err.stack);
+      process.exit(1);
+    })
+    .once('end', function (){
+      process.exit();
+    });
+});

lib/client.js

@@ -5,6 +5,7 @@
 
 var parser = require('socket.io-parser');
 var debug = require('debug')('socket.io:client');
+var url = require('url');
 
 /**
  * Module exports.
@@ -58,7 +59,7 @@ Client.prototype.setup = function(){
  * @api private
  */
 
-Client.prototype.connect = function(name){
+Client.prototype.connect = function(name, query){
   debug('connecting to namespace %s', name);
   var nsp = this.server.nsps[name];
   if (!nsp) {
@@ -72,7 +73,7 @@ Client.prototype.connect = function(name){
   }
 
   var self = this;
-  var socket = nsp.add(this, function(){
+  var socket = nsp.add(this, query, function(){
     self.sockets[socket.id] = socket;
     self.nsps[nsp.name] = socket;
 
@@ -186,7 +187,7 @@ Client.prototype.ondata = function(data){
 
 Client.prototype.ondecoded = function(packet) {
   if (parser.CONNECT == packet.type) {
-    this.connect(packet.nsp);
+    this.connect(url.parse(packet.nsp).pathname, url.parse(packet.nsp, true).query);
   } else {
     var socket = this.nsps[packet.nsp];
     if (socket) {

lib/namespace.js

@@ -150,9 +150,9 @@ Namespace.prototype['in'] = function(name){
  * @api private
  */
 
-Namespace.prototype.add = function(client, fn){
+Namespace.prototype.add = function(client, query, fn){
   debug('adding socket to nsp %s', this.name);
-  var socket = new Socket(this, client);
+  var socket = new Socket(this, client, query);
   var self = this;
   this.run(socket, function(err){
     process.nextTick(function(){

lib/socket.js

@@ -25,6 +25,7 @@ exports.events = [
   'error',
   'connect',
   'disconnect',
+  'disconnecting',
   'newListener',
   'removeListener'
 ];
@@ -55,18 +56,18 @@ var emit = Emitter.prototype.emit;
  * @api public
  */
 
-function Socket(nsp, client){
+function Socket(nsp, client, query){
   this.nsp = nsp;
   this.server = nsp.server;
   this.adapter = this.nsp.adapter;
-  this.id = nsp.name + '#' + client.id;
+  this.id = nsp.name !== '/' ? nsp.name + '#' + client.id : client.id;
   this.client = client;
   this.conn = client.conn;
   this.rooms = {};
   this.acks = {};
   this.connected = true;
   this.disconnected = false;
-  this.handshake = this.buildHandshake();
+  this.handshake = this.buildHandshake(query);
 }
 
 /**
@@ -103,7 +104,19 @@ Socket.prototype.__defineGetter__('request', function(){
  * @api private
  */
 
-Socket.prototype.buildHandshake = function(){
+Socket.prototype.buildHandshake = function(query){
+  var self = this;
+  function buildQuery(){
+    var requestQuery = url.parse(self.request.url, true).query;
+    //if socket-specific query exist, replace query strings in requestQuery
+    if(query){
+      query.t = requestQuery.t;
+      query.EIO = requestQuery.EIO;
+      query.transport = requestQuery.transport;
+      return query;
+    }
+    return requestQuery || {};
+  }
   return {
     headers: this.request.headers,
     time: (new Date) + '',
@@ -112,7 +125,7 @@ Socket.prototype.buildHandshake = function(){
     secure: !!this.request.connection.encrypted,
     issued: +(new Date),
     url: this.request.url,
-    query: url.parse(this.request.url, true).query || {}
+    query: buildQuery()
   };
 };
 
@@ -416,6 +429,7 @@ Socket.prototype.onerror = function(err){
 Socket.prototype.onclose = function(reason){
   if (!this.connected) return this;
   debug('closing socket - reason %s', reason);
+  this.emit('disconnecting', reason);
   this.leaveAll();
   this.nsp.remove(this);
   this.client.remove(this);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "socket.io",
-  "version": "1.4.8",
+  "version": "1.5.0",
   "description": "node.js realtime framework server",
   "keywords": [
     "realtime",
@@ -12,29 +12,38 @@
     "io"
   ],
   "main": "./lib/index",
+  "files": [
+    "lib/"
+  ],
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git://github.com/Automattic/socket.io"
+    "url": "git://github.com/socketio/socket.io"
   },
   "scripts": {
-    "test": "mocha --reporter dot --slow 200ms --bail"
+    "test": "gulp test"
   },
   "dependencies": {
-    "engine.io": "1.6.11",
+    "engine.io": "1.7.0",
     "socket.io-parser": "2.2.6",
-    "socket.io-client": "1.4.8",
+    "socket.io-client": "1.5.0",
     "socket.io-adapter": "0.4.0",
     "has-binary": "0.1.7",
     "debug": "2.2.0"
   },
   "devDependencies": {
+    "babel-preset-es2015": "6.3.13",
+    "del": "2.2.0",
     "expect.js": "0.3.1",
+    "gulp": "3.9.0",
+    "gulp-babel": "6.1.1",
+    "gulp-istanbul": "0.10.3",
+    "gulp-mocha": "2.2.0",
+    "gulp-task-listing": "1.0.1",
     "istanbul": "0.4.1",
     "mocha": "2.3.4",
     "superagent": "1.6.1",
-    "supertest": "1.1.0",
-    "zuul-ngrok": "3.2.0"
+    "supertest": "1.1.0"
   },
   "contributors": [
     {

test/socket.io.js

@@ -1,6 +1,12 @@
-
+var testVersion = process.env.TEST_VERSION;
 var http = require('http').Server;
-var io = require('..');
+var io;
+if (testVersion === 'compat') {
+  console.log('testing compat version');
+  io = require('../dist');
+} else {
+  io = require('../lib');
+}
 var fs = require('fs');
 var join = require('path').join;
 var exec = require('child_process').exec;
@@ -415,8 +421,8 @@ describe('socket.io', function(){
 
     describe('graceful close', function(){
       function fixture(filename) {
-        return process.execPath + ' ' +
-          join(__dirname, 'fixtures', filename);
+        return '"' + process.execPath + '" "' +
+          join(__dirname, 'fixtures', filename) + '"';
       }
 
       it('should stop socket and timers', function(done){
@@ -426,9 +432,18 @@ describe('socket.io', function(){
   });
 
   describe('namespaces', function(){
-    var Socket = require('../lib/socket');
-    var Namespace = require('../lib/namespace');
-
+    var Socket;
+    if (testVersion === 'compat') {
+      Socket = require('../dist/socket');
+    } else {
+      Socket = require('../lib/socket');
+    }
+    var Namespace;
+    if (testVersion === 'compat') {
+      Namespace = require('../dist/namespace');
+    } else {
+      Namespace = require('../lib/namespace');
+    }
     it('should be accessible through .sockets', function(){
       var sio = io();
       expect(sio.sockets).to.be.a(Namespace);
@@ -629,6 +644,31 @@ describe('socket.io', function(){
       });
     });
 
+    it('should fire a `disconnecting` event just before leaving all rooms', function(done){
+      var srv = http();
+      var sio = io(srv);
+      srv.listen(function(){
+        var socket = client(srv);
+
+        sio.on('connection', function(s){
+          s.join('a', function(){
+            s.disconnect();
+          });
+
+          var total = 2;
+          s.on('disconnecting', function(reason){
+            expect(Object.keys(s.rooms)).to.eql([s.id, 'a']);
+            total--;
+          });
+
+          s.on('disconnect', function(reason){
+            expect(Object.keys(s.rooms)).to.eql([]);
+            --total || done();
+          });
+        });
+      });
+    });
+
     it('should return error connecting to non-existent namespace', function(done){
       var srv = http();
       var sio = io(srv);
@@ -651,7 +691,7 @@ describe('socket.io', function(){
         var clientSocket2 = client(srv);
         sio.on('connection', function() {
           connections++;
-          if(connections === 2) {
+          if (connections === 2) {
             done();
           }
         });
@@ -785,7 +825,7 @@ describe('socket.io', function(){
           setTimeout(function() {
             sio.of('/chat').emit('ev', 'data');
             sio.of('/chat').volatile.emit('ev', 'data');
-          }, 20);
+          }, 50);
         });
 
         var socket = client(srv, '/chat');
@@ -797,7 +837,7 @@ describe('socket.io', function(){
       setTimeout(function() {
         expect(counter).to.be(1);
         done();
-      }, 200);
+      }, 500);
     });
 
     it('should emit volatile event', function(done) {
@@ -810,7 +850,7 @@ describe('socket.io', function(){
           // Wait to make sure there are no packets being sent for opening the connection
           setTimeout(function() {
             sio.of('/chat').volatile.emit('ev', 'data');
-          }, 20);
+          }, 100);
         });
 
         var socket = client(srv, '/chat');
@@ -822,7 +862,7 @@ describe('socket.io', function(){
       setTimeout(function() {
         expect(counter).to.be(1);
         done();
-      }, 200);
+      }, 500);
     });
 
     it('should enable compression by default', function(done){
@@ -1139,7 +1179,7 @@ describe('socket.io', function(){
           // Wait to make sure there are no packets being sent for opening the connection
           setTimeout(function() {
             s.volatile.emit('ev', 'data');
-          }, 20);
+          }, 100);
         });
 
         var socket = client(srv, { transports: ['polling'] });
@@ -1151,7 +1191,7 @@ describe('socket.io', function(){
       setTimeout(function() {
         expect(counter).to.be(1);
         done();
-      }, 200);
+      }, 500);
     });
 
     it('should emit volatile event (ws)', function(done) {
@@ -1190,7 +1230,7 @@ describe('socket.io', function(){
           setTimeout(function() {
             s.volatile.emit('ev', 'data');
             s.volatile.emit('ev', 'data');
-          }, 20);
+          }, 100);
         });
 
         var socket = client(srv, { transports: ['polling'] });
@@ -1202,7 +1242,7 @@ describe('socket.io', function(){
       setTimeout(function() {
         expect(counter).to.be(1);
         done();
-      }, 200);
+      }, 500);
     });
 
     it('should emit only one consecutive volatile event (ws)', function(done) {
@@ -1518,6 +1558,24 @@ describe('socket.io', function(){
         });
       });
     });
+    
+    it('should see query parameters sent from secondary namespace connections in handshake object', function(done){
+      var srv = http();
+      var sio = io(srv);
+      var addr = srv.listen().address();
+      var url = 'ws://localhost:' + addr.port;
+      var client1 = ioc(url);
+      var client2 = ioc(url + '/connection2', {query: {key1: 'aa', key2: '&=bb'}});
+      sio.on('connection', function(s){
+      });
+      sio.of('/connection2').on('connection', function(s){
+        expect(s.handshake.query.key1).to.be('aa');
+        expect(s.handshake.query.key2).to.be('&=bb');
+        done();
+      });
+
+
+    });
 
     it('should handle very large json', function(done){
       this.timeout(30000);
@@ -2036,7 +2094,12 @@ describe('socket.io', function(){
   });
 
   describe('middleware', function(done){
-    var Socket = require('../lib/socket');
+    var Socket;
+    if (testVersion === 'compat') {
+      Socket = require('../dist/socket');
+    } else {
+      Socket = require('../lib/socket');
+    }
 
     it('should call functions', function(done){
       var srv = http();