[chore] Release 1.5.1 (#2735)

Making proper optional Docs for socketIO

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,25 @@
+
+*Note*: for support questions, please use one of these channels: [stackoverflow](http://stackoverflow.com/questions/tagged/socket.io) or [slack](https://socketio.slack.com)
+
+### You want to:
+
+* [x] report a *bug*
+* [ ] request a *feature*
+
+### Current behaviour
+
+
+### Steps to reproduce (if the current behaviour is a bug)
+
+
+### Expected behaviour
+
+
+### Setup
+- OS:
+- browser:
+- socket.io version:
+
+### Other information (e.g. stacktraces, related issues, suggestions how to fix)
+
+

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,18 @@
+
+### The kind of change this PR does introduce
+
+* [x] a bug fix
+* [ ] a new feature
+* [ ] an update to the documentation
+* [ ] a code change that improves performance
+* [ ] other
+
+### Current behaviour
+
+
+### New behaviour
+
+
+### Other information (e.g. related issues)
+
+

.gitignore

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

.npmignore

@@ -1,3 +0,0 @@
-support
-test
-examples

.travis.yml

@@ -1,13 +1,28 @@
+sudo: false
+before_install:
+  - npm install -g npm@'>=1.4.3'
 language: node_js
 node_js:
-  - "0.8"
   - "0.10"
-  - "0.11"
+  - "0.12"
+  - "4"
+  - "node"
+
+git:
+  depth: 1
 
 matrix:
-  fast_finish: true
-  allow_failures:
-    - node_js: "0.11"
+  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:
+    #- node_js: "0.11"
 
 notifications:
   irc: "irc.freenode.org#socket.io"

History.md

@@ -1,4 +1,239 @@
 
+1.5.1 / 2016-10-24
+==================
+
+  * [fix] Avoid swallowing exceptions thrown by user event handlers (#2682)
+  * [test] Use client function to unify `client` in test script (#2731)
+  * [docs] Add link to LICENSE (#2221)
+  * [docs] Fix JSDoc of optional parameters (#2465)
+  * [docs] Fix typo (#2724)
+  * [docs] Link readme npm package badge to npm registry page (#2612)
+  * [docs] Minor fixes (#2526)
+  * [chore] Bump socket.io-parser to 2.3.0 (#2730)
+  * [chore] Add Github issue and PR templates (#2733)
+  * [chore] Bump engine.io to 1.7.2 (#2729)
+  * [chore] Bump socket.io-parser to 2.3.1 (#2734)
+
+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
+==================
+
+  * package: bump `engine.io`
+
+1.4.7 / 2016-06-23
+==================
+
+  * package: bump `engine.io`
+
+1.4.6 / 2016-05-02
+==================
+
+  * package: bump engine.io
+
+1.4.5 / 2016-01-26
+==================
+
+  * fix closing the underlying `http.Server`
+
+1.4.4 / 2016-01-10
+==================
+
+  * package: bump `engine.io`
+
+1.4.3 / 2016-01-08
+==================
+
+  * bump `socket.io-client`
+
+1.4.2 / 2016-01-07
+==================
+
+  * bump `engine.io`
+
+1.4.1 / 2016-01-07
+==================
+
+  * version bump
+
+1.4.0 / 2015-11-28
+==================
+
+  * socket.io: increase large binary data test timeout
+  * package: bump `engine.io` for release
+  * trigger callback even when joining an already joined room
+  * package: bump parser
+  * namespace: clear rooms flag after a clients call (fixes #1978)
+  * package: bump `socket.io-parser`
+  * fixed tests with large data
+  * fixed a typo in the example code
+  * package: bump mocha
+  * package: bump `has-binary` and `zuul-ngrok`
+  * package: bump `engine.io` and `socket.io-client`
+  * README: clarified documentation of Socket.in
+  * README: fixed up legacy repo links
+  * test: better timeout for stress test
+  * socket: don't set request property which has a getter
+  * removed proxy index file
+  * support flags on namespace
+  * improve Socket#packet and Client#packet
+  * socket: warn node_redis-style about missing `error`
+  * test: added failing test
+  * test: increase timeout for large binary data test
+  * package: bump `has-binary` to work with all objects (fixes #1955)
+  * fix origin verification default https port [evanlucas]
+  * support compression [nkzawa]
+  * changed type of `Client#sockets`, `Namespace#sockets` and `Socket#rooms` to maps (instead of arrays)
+
+1.3.7 / 2015-09-21
+==================
+
+  * package: bump `socket.io-client` for node4 compatibility
+  * package: bump `engine.io` for node4 compatibility
+
+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
+==================
+
+ * package: bump `socket.io-parser` for windows fix
+
 1.0.1 / 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

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,11 +1,12 @@
-### 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/LearnBoost/socket.io.png)](http://travis-ci.org/LearnBoost/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/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)](https://www.npmjs.com/package/socket.io)
+![Downloads](https://img.shields.io/npm/dm/socket.io.svg?style=flat)
+[![](http://slack.socket.io/badge.svg?)](http://slack.socket.io)
 
 ## How to use
 
@@ -13,11 +14,11 @@ 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){});
-  socket.on('disconnect', function(){});
+io.on('connection', function(client){
+  client.on('event', function(data){});
+  client.on('disconnect', function(){});
 });
 server.listen(3000);
 ```
@@ -26,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);
 ```
 
@@ -39,7 +40,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 +53,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);
@@ -87,7 +88,7 @@ server.listen(3000);
 
   The same options passed to socket.io are always passed to
   the `engine.io` `Server` that gets created. See engine.io
-  [options](https://github.com/learnboost/engine.io#methods-1)
+  [options](https://github.com/socketio/engine.io#methods-1)
   as reference.
 
 ### Server(srv:http#Server, opts:Object)
@@ -129,7 +130,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/socketio/socket.io-adapter).
 
   If no arguments are supplied this method returns the current value.
 
@@ -139,6 +140,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/expressjs/cors)
+
 
 ### Server#sockets:Namespace
 
@@ -160,7 +170,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 +180,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 +198,24 @@ server.listen(3000);
 
   For other available methods, see `Namespace` below.
 
+### Server#close
+
+  Closes socket.io 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.
@@ -215,6 +243,40 @@ server.listen(3000);
   Hash of `Socket` objects that are connected to this namespace indexed
   by `id`.
 
+### Namespace#clients(fn:Function)
+
+  Gets a list of client IDs connected to this namespace (across all nodes if applicable).
+
+  An example to get all clients in a namespace:
+
+  ```js
+  var io = require('socket.io')();
+  io.of('/chat').clients(function(error, clients){
+    if (error) throw error;
+    console.log(clients); // => [PZDoMHjiu8PYfRiKAAAF, Anw2LatarvGVVXEIAAAD]
+  });
+  ```
+
+  An example to get all clients in namespace's room:
+
+  ```js
+  var io = require('socket.io')();
+  io.of('/chat').in('general').clients(function(error, clients){
+    if (error) throw error;
+    console.log(clients); // => [Anw2LatarvGVVXEIAAAD]
+  });
+  ```
+
+  As with broadcasting, the default is all clients from the default namespace ('/'):
+
+  ```js
+  var io = require('socket.io')();
+  io.clients(function(error, clients){
+    if (error) throw error;
+    console.log(clients); // => [6em3d4TJP8Et9EMNAAAA, G5p55dHhGgUnLUctAAAB]
+  });
+  ```
+
 ### Namespace#use(fn:Function):Namespace
 
   Registers a middleware, which is a function that gets executed for
@@ -238,10 +300,14 @@ 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:Array
+### Socket#rooms:Object
 
-  A list of strings identifying the rooms this socket is in.
+  A hash of strings identifying the rooms this client is in, indexed by
+  room name.
 
 ### Socket#client:Client
 
@@ -249,8 +315,9 @@ server.listen(3000);
 
 ### Socket#conn:Socket
 
-  A reference to the underyling `Client` transport connection (engine.io
-  `Socket` object).
+  A reference to the underlying `Client` transport connection (engine.io
+  `Socket` object). This allows access to the IO transport layer, which
+  still (mostly) abstracts the actual TCP/IP socket.
 
 ### Socket#request:Request
 
@@ -260,62 +327,100 @@ 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`
   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/socketio/socket.io-adapter).
 
 ### 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**.
 
   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/socketio/socket.io-adapter).
 
 ### Socket#to(room:String):Socket
-### Socket#in(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' });
   });
   ```
 
+### Socket#in(room:String):Socket
+
+  Same as `Socket#to`
+
+### Socket#compress(v:Boolean):Socket
+
+  Sets a modifier for a subsequent event emission that the event data will
+  only be _compressed_ if the value is `true`. Defaults to `true` when you don't call the method.
+
+  ```js
+  var io = require('socket.io')();
+  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
 
   The `Client` class represents an incoming transport (engine.io)
@@ -334,7 +439,7 @@ server.listen(3000);
 
 ## Debug / logging
 
-Socket.IO is powered by [debug](http://github.com/visionmedia/debug).
+Socket.IO is powered by [debug](https://github.com/visionmedia/debug).
 In order to see all the debug output, run your app with the environment variable
 `DEBUG` including the desired scope.
 
@@ -344,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
+[MIT](LICENSE)

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/index.js

@@ -14,8 +14,6 @@ app.use(express.static(__dirname + '/public'));
 
 // Chatroom
 
-// usernames which are currently connected to the chat
-var usernames = {};
 var numUsers = 0;
 
 io.on('connection', function (socket) {
@@ -32,10 +30,10 @@ io.on('connection', function (socket) {
 
   // when the client emits 'add user', this listens and executes
   socket.on('add user', function (username) {
+    if (addedUser) return;
+
     // we store the username in the socket session for this client
     socket.username = username;
-    // add the client's username to the global list
-    usernames[username] = username;
     ++numUsers;
     addedUser = true;
     socket.emit('login', {
@@ -64,9 +62,7 @@ io.on('connection', function (socket) {
 
   // when the user disconnects.. perform this
   socket.on('disconnect', function () {
-    // remove the username from global usernames list
     if (addedUser) {
-      delete usernames[socket.username];
       --numUsers;
 
       // echo globally that this client has left

examples/chat/package.json

@@ -2,11 +2,11 @@
   "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",
   "dependencies": {
-    "express": "3.4.8"
+    "express": "4.13.4"
   }
-}
+}

examples/chat/public/main.js

@@ -7,7 +7,7 @@ $(function() {
     '#3b88eb', '#3824aa', '#a700ff', '#d300e7'
   ];
 
-  // Initialize varibles
+  // Initialize variables
   var $window = $(window);
   var $usernameInput = $('.usernameInput'); // Input for username
   var $messages = $('.messages'); // Messages area
@@ -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 */
@@ -124,7 +128,6 @@ ul {
 }
 
 .username {
-  float: left;
   font-weight: 700;
   overflow: hidden;
   padding-right: 15px;
@@ -143,4 +146,4 @@ ul {
   position: absolute;
   right: 0;
   width: 100%;
-}
+}

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();
+    });
+});

index.js

@@ -1,2 +0,0 @@
-
-module.exports = require('./lib');

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.
@@ -16,7 +17,7 @@ module.exports = Client;
  * Client constructor.
  *
  * @param {Server} server instance
- * @param {Socket} connection
+ * @param {Socket} conn
  * @api private
  */
 
@@ -28,7 +29,7 @@ function Client(server, conn){
   this.id = conn.id;
   this.request = conn.request;
   this.setup();
-  this.sockets = [];
+  this.sockets = {};
   this.nsps = {};
   this.connectBuffer = [];
 }
@@ -42,35 +43,43 @@ 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);
 };
 
 /**
  * Connects a client to a namespace.
  *
- * @param {String} namespace name
+ * @param {String} name namespace
  * @api private
  */
 
-Client.prototype.connect = function(name){
+Client.prototype.connect = function(name, query){
   debug('connecting to namespace %s', name);
-  var nsp = this.server.of(name);
+  var nsp = this.server.nsps[name];
+  if (!nsp) {
+    this.packet({ type: parser.ERROR, nsp: name, data : 'Invalid namespace'});
+    return;
+  }
+
   if ('/' != name && !this.nsps['/']) {
     this.connectBuffer.push(name);
     return;
   }
 
   var self = this;
-  var socket = nsp.add(this, function(){
-    self.sockets.push(socket);
+  var socket = nsp.add(this, query, function(){
+    self.sockets[socket.id] = 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 = [];
     }
   });
 };
@@ -82,12 +91,12 @@ Client.prototype.connect = function(name){
  */
 
 Client.prototype.disconnect = function(){
-  var socket;
-  // we don't use a for loop because the length of
-  // `sockets` changes upon each iteration
-  while (socket = this.sockets.shift()) {
-    socket.disconnect();
+  for (var id in this.sockets) {
+    if (this.sockets.hasOwnProperty(id)) {
+      this.sockets[id].disconnect();
+    }
   }
+  this.sockets = {};
   this.close();
 };
 
@@ -98,10 +107,9 @@ Client.prototype.disconnect = function(){
  */
 
 Client.prototype.remove = function(socket){
-  var i = this.sockets.indexOf(socket);
-  if (~i) {
-    var nsp = this.sockets[i].nsp.name;
-    this.sockets.splice(i, 1);
+  if (this.sockets.hasOwnProperty(socket.id)) {
+    var nsp = this.sockets[socket.id].nsp.name;
+    delete this.sockets[socket.id];
     delete this.nsps[nsp];
   } else {
     debug('ignoring remove for %s', socket.id);
@@ -126,25 +134,25 @@ Client.prototype.close = function(){
  * Writes a packet to the transport.
  *
  * @param {Object} packet object
- * @param {Boolean} whether packet is already encoded
- * @param {Boolean} whether packet is volatile
+ * @param {Object} opts
  * @api private
  */
 
-Client.prototype.packet = function(packet, preEncoded, volatile){
+Client.prototype.packet = function(packet, opts){
+  opts = opts || {};
   var self = this;
 
   // this writes to the actual connection
   function writeToEngine(encodedPackets) {
-    if (volatile && !self.conn.transport.writable) return;
+    if (opts.volatile && !self.conn.transport.writable) return;
     for (var i = 0; i < encodedPackets.length; i++) {
-      self.conn.write(encodedPackets[i]);
+      self.conn.write(encodedPackets[i], { compress: opts.compress });
     }
   }
 
   if ('open' == this.conn.readyState) {
     debug('writing packet %j', packet);
-    if(!preEncoded) { // not broadcasting, need to encode
+    if (!opts.preEncoded) { // not broadcasting, need to encode
       this.encoder.encode(packet, function (encodedPackets) { // encode, then write results to engine
         writeToEngine(encodedPackets);
       });
@@ -163,7 +171,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);
+  }
 };
 
 /**
@@ -174,17 +187,35 @@ 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) {
-      socket.onpacket(packet);
+      process.nextTick(function() {
+        socket.onpacket(packet);
+      });
     } else {
       debug('no socket for namespace %s', packet.nsp);
     }
   }
 };
 
+/**
+ * Handles an error.
+ *
+ * @param {Object} err object
+ * @api private
+ */
+
+Client.prototype.onerror = function(err){
+  for (var id in this.sockets) {
+    if (this.sockets.hasOwnProperty(id)) {
+      this.sockets[id].onerror(err);
+    }
+  }
+  this.onclose('client error');
+};
+
 /**
  * Called upon transport close.
  *
@@ -199,9 +230,12 @@ Client.prototype.onclose = function(reason){
   this.destroy();
 
   // `nsps` and `sockets` are cleaned up seamlessly
-  this.sockets.forEach(function(socket){
-    socket.onclose(reason);
-  });
+  for (var id in this.sockets) {
+    if (this.sockets.hasOwnProperty(id)) {
+      this.sockets[id].onclose(reason);
+    }
+  }
+  this.sockets = {};
 
   this.decoder.destroy(); // clean up decoder
 };
@@ -214,6 +248,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

@@ -5,7 +5,6 @@
 
 var http = require('http');
 var read = require('fs').readFileSync;
-var parse = require('url').parse;
 var engine = require('engine.io');
 var client = require('socket.io-client');
 var clientVersion = require('socket.io-client/package').version;
@@ -30,8 +29,8 @@ var clientSource = read(require.resolve('socket.io-client/socket.io.js'), 'utf-8
 /**
  * Server constructor.
  *
- * @param {http.Server|Number|Object} http server, port or options
- * @param {Object} options
+ * @param {http.Server|Number|Object} srv http server, port or options
+ * @param {Object} [opts]
  * @api public
  */
 
@@ -54,21 +53,25 @@ function Server(srv, opts){
 /**
  * Server request verification function, that checks for allowed origins
  *
- * @param {http.IncomingMessage} request
- * @param {Function} callback to be called with the result: `fn(err, success)`
+ * @param {http.IncomingMessage} req request
+ * @param {Function} fn callback to be called with the result: `fn(err, success)`
  */
 
 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 {
       var parts = url.parse(origin);
-      parts.port = parts.port || 80;
+      var defaultPort = 'https:' == parts.protocol ? 443 : 80;
+      parts.port = parts.port != null
+        ? parts.port
+        : defaultPort;
       var ok =
         ~this._origins.indexOf(parts.hostname + ':' + parts.port) ||
         ~this._origins.indexOf(parts.hostname + ':*') ||
@@ -83,7 +86,7 @@ Server.prototype.checkRequest = function(req, fn) {
 /**
  * Sets/gets whether client code is being served.
  *
- * @param {Boolean} whether to serve client code
+ * @param {Boolean} v whether to serve client code
  * @return {Server|Boolean} self when setting or value when getting
  * @api public
  */
@@ -106,7 +109,7 @@ var oldSettings = {
 };
 
 /**
- * Backwards compatiblity.
+ * Backwards compatibility.
  *
  * @api public
  */
@@ -136,7 +139,7 @@ Server.prototype.set = function(key, val){
 /**
  * Sets the client serving path.
  *
- * @param {String} pathname
+ * @param {String} v pathname
  * @return {Server|String} self when setting or value when getting
  * @api public
  */
@@ -150,7 +153,7 @@ Server.prototype.path = function(v){
 /**
  * Sets the adapter for rooms.
  *
- * @param {Adapter} pathname
+ * @param {Adapter} v pathname
  * @return {Server|Adapter} self when setting or value when getting
  * @api public
  */
@@ -159,7 +162,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;
 };
@@ -167,7 +172,7 @@ Server.prototype.adapter = function(v){
 /**
  * Sets the allowed origins for requests.
  *
- * @param {String} origins
+ * @param {String} v origins
  * @return {Server|Adapter} self when setting or value when getting
  * @api public
  */
@@ -191,7 +196,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,13 +214,14 @@ 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);
+  opts.allowRequest = opts.allowRequest || this.checkRequest.bind(this);
 
   // initialize engine
   debug('creating engine.io instance with opts %j', opts);
@@ -224,6 +230,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);
 
@@ -233,7 +242,7 @@ Server.prototype.attach = function(srv, opts){
 /**
  * Attaches the static file serving.
  *
- * @param {Function|http.Server} http server
+ * @param {Function|http.Server} srv http server
  * @api private
  */
 
@@ -244,7 +253,7 @@ Server.prototype.attachServe = function(srv){
   var self = this;
   srv.removeAllListeners('request');
   srv.on('request', function(req, res) {
-    if (0 == req.url.indexOf(url)) {
+    if (0 === req.url.indexOf(url)) {
       self.serve(req, res);
     } else {
       for (var i = 0; i < evs.length; i++) {
@@ -263,8 +272,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();
@@ -282,7 +292,7 @@ Server.prototype.serve = function(req, res){
 /**
  * Binds socket.io to an engine.io instance.
  *
- * @param {engine.Server} engine.io (or compatible) server
+ * @param {engine.Server} engine engine.io (or compatible) server
  * @return {Server} self
  * @api public
  */
@@ -296,7 +306,7 @@ Server.prototype.bind = function(engine){
 /**
  * Called with each incoming transport connection.
  *
- * @param {engine.Socket} socket
+ * @param {engine.Socket} conn
  * @return {Server} self
  * @api public
  */
@@ -311,26 +321,49 @@ Server.prototype.onconnection = function(conn){
 /**
  * Looks up a namespace.
  *
- * @param {String} nsp name
- * @param {Function} optional, nsp `connection` ev handler
+ * @param {String} name nsp name
+ * @param {Function} [fn] optional, nsp `connection` ev handler
  * @api public
  */
 
 Server.prototype.of = function(name, fn){
-  if (!this.nsps[name]) {
+  if (String(name)[0] !== '/') name = '/' + name;
+  
+  var nsp = this.nsps[name];
+  if (!nsp) {
     debug('initializing namespace %s', name);
-    var nsp = new Namespace(this, name);
+    nsp = new Namespace(this, name);
     this.nsps[name] = nsp;
   }
-  if (fn) this.nsps[name].on('connect', fn);
-  return this.nsps[name];
+  if (fn) nsp.on('connect', fn);
+  return nsp;
+};
+
+/**
+ * Closes server connection
+ *
+ * @api public
+ */
+
+Server.prototype.close = function(){
+  for (var id in this.nsps['/'].sockets) {
+    if (this.nsps['/'].sockets.hasOwnProperty(id)) {
+      this.nsps['/'].sockets[id].onclose();
+    }
+  }
+
+  this.engine.close();
+
+  if(this.httpServer){
+    this.httpServer.close();
+  }
 };
 
 /**
  * Expose main namespace (/).
  */
 
-['on', 'to', 'in', 'use', 'emit', 'send', 'write'].forEach(function(fn){
+['on', 'to', 'in', 'use', 'emit', 'send', 'write', 'clients', 'compress'].forEach(function(fn){
   Server.prototype[fn] = function(){
     var nsp = this.sockets[fn];
     return nsp.apply(this.sockets, arguments);
@@ -338,8 +371,9 @@ Server.prototype.of = function(name, fn){
 });
 
 Namespace.flags.forEach(function(flag){
-  Server.prototype.__defineGetter__(flag, function(name){
-    this.flags.push(name);
+  Server.prototype.__defineGetter__(flag, function(){
+    this.sockets.flags = this.sockets.flags || {};
+    this.sockets.flags[flag] = true;
     return this;
   });
 });

lib/namespace.js

@@ -7,7 +7,7 @@ var Socket = require('./socket');
 var Emitter = require('events').EventEmitter;
 var parser = require('socket.io-parser');
 var debug = require('debug')('socket.io:namespace');
-var hasBin = require('has-binary-data');
+var hasBin = require('has-binary');
 
 /**
  * Module exports.
@@ -29,7 +29,10 @@ exports.events = [
  * Flags.
  */
 
-exports.flags = ['json'];
+exports.flags = [
+  'json',
+  'volatile'
+];
 
 /**
  * `EventEmitter#emit` reference.
@@ -48,11 +51,10 @@ var emit = Emitter.prototype.emit;
 function Namespace(server, name){
   this.name = name;
   this.server = server;
-  this.sockets = [];
+  this.sockets = {};
   this.connected = {};
   this.fns = [];
   this.ids = 0;
-  this.acks = {};
   this.initAdapter();
 }
 
@@ -102,7 +104,7 @@ Namespace.prototype.use = function(fn){
  * Executes the middleware for an incoming client.
  *
  * @param {Socket} socket that will get added
- * @param {Function} last fn call in the middleware
+ * @param {Function} fn last fn call in the middleware
  * @api private
  */
 
@@ -148,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(){
@@ -158,7 +160,7 @@ Namespace.prototype.add = function(client, fn){
         if (err) return socket.error(err.data || err.message);
 
         // track socket
-        self.sockets.push(socket);
+        self.sockets[socket.id] = socket;
 
         // it's paramount that the internal `onconnect` logic
         // fires before user-set events to prevent state order
@@ -185,9 +187,8 @@ Namespace.prototype.add = function(client, fn){
  */
 
 Namespace.prototype.remove = function(socket){
-  var i = this.sockets.indexOf(socket);
-  if (~i) {
-    this.sockets.splice(i, 1);
+  if (this.sockets.hasOwnProperty(socket.id)) {
+    delete this.sockets[socket.id];
   } else {
     debug('ignoring remove for %s', socket.id);
   }
@@ -240,3 +241,32 @@ Namespace.prototype.write = function(){
   this.emit.apply(this, args);
   return this;
 };
+
+/**
+ * Gets a list of clients.
+ *
+ * @return {Namespace} self
+ * @api public
+ */
+
+Namespace.prototype.clients = function(fn){
+  this.adapter.clients(this.rooms, fn);
+  // delete rooms flag for scenario:
+  // .in('room').clients() (GH-1978)
+  delete this.rooms;
+  return this;
+};
+
+/**
+ * Sets the compress flag.
+ *
+ * @param {Boolean} compress if `true`, compresses the sending data
+ * @return {Socket} self
+ * @api public
+ */
+
+Namespace.prototype.compress = function(compress){
+  this.flags = this.flags || {};
+  this.flags.compress = compress;
+  return this;
+};

lib/socket.js

@@ -7,7 +7,7 @@ var Emitter = require('events').EventEmitter;
 var parser = require('socket.io-parser');
 var url = require('url');
 var debug = require('debug')('socket.io:socket');
-var hasBin = require('has-binary-data');
+var hasBin = require('has-binary');
 
 /**
  * Module exports.
@@ -25,7 +25,9 @@ exports.events = [
   'error',
   'connect',
   'disconnect',
-  'newListener'
+  'disconnecting',
+  'newListener',
+  'removeListener'
 ];
 
 /**
@@ -54,19 +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 = client.id;
-  this.request = client.request;
+  this.id = nsp.name !== '/' ? nsp.name + '#' + client.id : client.id;
   this.client = client;
   this.conn = client.conn;
-  this.rooms = [];
+  this.rooms = {};
   this.acks = {};
   this.connected = true;
   this.disconnected = false;
-  this.handshake = this.buildHandshake();
+  this.handshake = this.buildHandshake(query);
 }
 
 /**
@@ -88,7 +89,7 @@ flags.forEach(function(flag){
 });
 
 /**
- * `request` engine.io shorcut.
+ * `request` engine.io shortcut.
  *
  * @api public
  */
@@ -103,16 +104,28 @@ 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) + '',
-    address: this.request.connection.address(),
+    address: this.conn.remoteAddress,
     xdomain: !!this.request.headers.origin,
     secure: !!this.request.connection.encrypted,
     issued: +(new Date),
     url: this.request.url,
-    query: url.parse(this.request.url, true).query || {}
+    query: buildQuery()
   };
 };
 
@@ -131,10 +144,11 @@ Socket.prototype.emit = function(ev){
     var packet = {};
     packet.type = hasBin(args) ? parser.BINARY_EVENT : parser.EVENT;
     packet.data = args;
+    var flags = this.flags || {};
 
     // access last argument to see if it's an ACK callback
     if ('function' == typeof args[args.length - 1]) {
-      if (this._rooms || (this.flags && this.flags.broadcast)) {
+      if (this._rooms || flags.broadcast) {
         throw new Error('Callbacks are not supported when broadcasting');
       }
 
@@ -143,15 +157,18 @@ Socket.prototype.emit = function(ev){
       packet.id = this.nsp.ids++;
     }
 
-    if (this._rooms || (this.flags && this.flags.broadcast)) {
+    if (this._rooms || flags.broadcast) {
       this.adapter.broadcast(packet, {
         except: [this.id],
         rooms: this._rooms,
-        flags: this.flags
+        flags: flags
       });
     } else {
       // dispatch packet
-      this.packet(packet);
+      this.packet(packet, {
+        volatile: flags.volatile,
+        compress: flags.compress
+      });
     }
 
     // reset flags
@@ -195,20 +212,22 @@ Socket.prototype.write = function(){
  * Writes a packet.
  *
  * @param {Object} packet object
+ * @param {Object} opts options
  * @api private
  */
 
-Socket.prototype.packet = function(packet, preEncoded){
+Socket.prototype.packet = function(packet, opts){
   packet.nsp = this.nsp.name;
-  var volatile = this.flags && this.flags.volatile;
-  this.client.packet(packet, preEncoded, volatile);
+  opts = opts || {};
+  opts.compress = false !== opts.compress;
+  this.client.packet(packet, opts);
 };
 
 /**
  * Joins a room.
  *
  * @param {String} room
- * @param {Function} optional, callback
+ * @param {Function} fn optional, callback
  * @return {Socket} self
  * @api private
  */
@@ -216,11 +235,14 @@ Socket.prototype.packet = function(packet, preEncoded){
 Socket.prototype.join = function(room, fn){
   debug('joining room %s', room);
   var self = this;
-  if (~this.rooms.indexOf(room)) return this;
+  if (this.rooms.hasOwnProperty(room)) {
+    fn && fn(null);
+    return this;
+  }
   this.adapter.add(this.id, room, function(err){
     if (err) return fn && fn(err);
     debug('joined room %s', room);
-    self.rooms.push(room);
+    self.rooms[room] = room;
     fn && fn(null);
   });
   return this;
@@ -230,7 +252,7 @@ Socket.prototype.join = function(room, fn){
  * Leaves a room.
  *
  * @param {String} room
- * @param {Function} optional, callback
+ * @param {Function} fn optional, callback
  * @return {Socket} self
  * @api private
  */
@@ -241,7 +263,7 @@ 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));
+    delete self.rooms[room];
     fn && fn(null);
   });
   return this;
@@ -255,10 +277,11 @@ Socket.prototype.leave = function(room, fn){
 
 Socket.prototype.leaveAll = function(){
   this.adapter.delAll(this.id);
+  this.rooms = {};
 };
 
 /**
- * Called by `Namespace` upon succesful
+ * Called by `Namespace` upon successful
  * middleware execution (ie: authorization).
  *
  * @api private
@@ -266,9 +289,9 @@ Socket.prototype.leaveAll = function(){
 
 Socket.prototype.onconnect = function(){
   debug('socket connected - writing packet');
+  this.nsp.connected[this.id] = this;
   this.join(this.id);
   this.packet({ type: parser.CONNECT });
-  this.nsp.connected[this.id] = this;
 };
 
 /**
@@ -293,6 +316,10 @@ Socket.prototype.onpacket = function(packet){
       this.onack(packet);
       break;
 
+    case parser.BINARY_ACK:
+      this.onack(packet);
+      break;
+
     case parser.DISCONNECT:
       this.ondisconnect();
       break;
@@ -324,7 +351,7 @@ Socket.prototype.onevent = function(packet){
 /**
  * Produces an ack callback to emit with an event.
  *
- * @param {Number} packet id
+ * @param {Number} id packet id
  * @api private
  */
 
@@ -336,11 +363,15 @@ 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
     });
+
+    sent = true;
   };
 };
 
@@ -372,16 +403,33 @@ 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
+ * @throw {Error} optional error object
  * @api private
  */
 
 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);
@@ -394,7 +442,7 @@ Socket.prototype.onclose = function(reason){
 /**
  * Produces an `error` packet.
  *
- * @param {Object} error object
+ * @param {Object} err error object
  * @api private
  */
 
@@ -405,7 +453,7 @@ Socket.prototype.error = function(err){
 /**
  * Disconnects this client.
  *
- * @param {Boolean} if `true`, closes the underlying connection
+ * @param {Boolean} close if `true`, closes the underlying connection
  * @return {Socket} self
  * @api public
  */
@@ -420,3 +468,17 @@ Socket.prototype.disconnect = function(close){
   }
   return this;
 };
+
+/**
+ * Sets the compress flag.
+ *
+ * @param {Boolean} compress if `true`, compresses the sending data
+ * @return {Socket} self
+ * @api public
+ */
+
+Socket.prototype.compress = function(compress){
+  this.flags = this.flags || {};
+  this.flags.compress = compress;
+  return this;
+};

package.json

@@ -1,6 +1,6 @@
 {
   "name": "socket.io",
-  "version": "1.0.1",
+  "version": "1.5.1",
   "description": "node.js realtime framework server",
   "keywords": [
     "realtime",
@@ -11,27 +11,39 @@
     "socket",
     "io"
   ],
+  "main": "./lib/index",
+  "files": [
+    "lib/"
+  ],
+  "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git://github.com/LearnBoost/socket.io"
+    "url": "git://github.com/socketio/socket.io"
   },
   "scripts": {
-    "test": "make test"
+    "test": "gulp test"
   },
   "dependencies": {
-    "engine.io": "1.2.1",
-    "socket.io-parser": "2.1.4",
-    "socket.io-client": "1.0.1",
-    "socket.io-adapter": "0.2.0",
-    "has-binary-data": "0.1.1",
-    "debug": "0.7.4"
+    "engine.io": "1.7.2",
+    "socket.io-parser": "2.3.1",
+    "socket.io-client": "1.5.1",
+    "socket.io-adapter": "0.4.0",
+    "has-binary": "0.1.7",
+    "debug": "2.2.0"
   },
   "devDependencies": {
-    "mocha": "1.16.2",
+    "babel-preset-es2015": "6.3.13",
+    "del": "2.2.0",
     "expect.js": "0.3.1",
-    "supertest": "0.8.2",
-    "superagent": "0.17.0",
-    "istanbul": "0.2.3"
+    "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"
   },
   "contributors": [
     {

test/fixtures/server-close.js

@@ -0,0 +1,11 @@
+var server = require('http').createServer();
+var ioc = require('socket.io-client');
+var io = require('../..')(server);
+
+var srv = server.listen(function() {
+  var socket = ioc('ws://localhost:' + server.address().port);
+  socket.on('connect', function() {
+    io.close();
+    socket.close();
+  });
+});