[chore] Release 2.3.0

Diff: https://github.com/socketio/socket.io/compare/2.2.0...2.3.0

.github/ISSUE_TEMPLATE.md

@@ -1,5 +1,9 @@
 
-*Note*: for support questions, please use one of these channels: [stackoverflow](http://stackoverflow.com/questions/tagged/socket.io) or [slack](https://socketio.slack.com)
+**Note**: for support questions, please use one of these channels: [stackoverflow](http://stackoverflow.com/questions/tagged/socket.io) or [slack](https://socketio.slack.com)
+
+For bug reports and feature requests for the **Swift client**, please open an issue [there](https://github.com/socketio/socket.io-client-swift).
+
+For bug reports and feature requests for the **Java client**, please open an issue [there](https://github.com/socketio/socket.io-client-java).
 
 ### You want to:
 
@@ -8,13 +12,15 @@
 
 ### Current behaviour
 
+*What is actually happening?*
 
 ### Steps to reproduce (if the current behaviour is a bug)
 
-**Note**: the best way to get a quick answer is to provide a failing test case, by forking the following [fiddle](https://github.com/darrachequesne/socket.io-fiddle) for example.
+**Note**: the best way (and by that we mean **the only way**) to get a quick answer is to provide a failing test case by forking the following [fiddle](https://github.com/socketio/socket.io-fiddle).
 
 ### Expected behaviour
 
+*What is expected?*
 
 ### Setup
 - OS:

.travis.yml

@@ -1,10 +1,8 @@
 language: node_js
 sudo: false
 node_js:
-  - '4'
-  - '6'
   - '8'
-  - node
+  - '10'
 notifications:
   irc: "irc.freenode.org#socket.io"
 git:

Readme.md

@@ -11,7 +11,7 @@
 
 ## Features
 
-Socket.IO enables real-time bidirectional event-based communication. It consists in:
+Socket.IO enables real-time bidirectional event-based communication. It consists of:
 
 - a Node.js server (this repository)
 - a [Javascript client library](https://github.com/socketio/socket.io-client) for the browser (or a Node.js client)
@@ -55,10 +55,10 @@ Any serializable data structures can be emitted, including:
 Sample code:
 
 ```js
-io.on('connection', function(socket){
-  socket.emit('request', /* */); // emit an event to the socket
-  io.emit('broadcast', /* */); // emit an event to all connected sockets
-  socket.on('reply', function(){ /* */ }); // listen to the event
+io.on('connection', socket => {
+  socket.emit('request', /* … */); // emit an event to the socket
+  io.emit('broadcast', /* … */); // emit an event to all connected sockets
+  socket.on('reply', () => { /* … */ }); // listen to the event
 });
 ```
 
@@ -84,7 +84,7 @@ This is a useful feature to send notifications to a group of users, or to a give
 ## Installation
 
 ```bash
-npm install socket.io --save
+npm install socket.io
 ```
 
 ## How to use
@@ -93,11 +93,11 @@ The following example attaches socket.io to a plain Node.JS
 HTTP server listening on port `3000`.
 
 ```js
-var server = require('http').createServer();
-var io = require('socket.io')(server);
-io.on('connection', function(client){
-  client.on('event', function(data){});
-  client.on('disconnect', function(){});
+const server = require('http').createServer();
+const io = require('socket.io')(server);
+io.on('connection', client => {
+  client.on('event', data => { /* … */ });
+  client.on('disconnect', () => { /* … */ });
 });
 server.listen(3000);
 ```
@@ -105,8 +105,8 @@ server.listen(3000);
 ### Standalone
 
 ```js
-var io = require('socket.io')();
-io.on('connection', function(client){});
+const io = require('socket.io')();
+io.on('connection', client => { ... });
 io.listen(3000);
 ```
 
@@ -118,10 +118,10 @@ to pass the `Server` to `socket.io`, and not the express application
 function. Also make sure to call `.listen` on the `server`, not the `app`.
 
 ```js
-var app = require('express')();
-var server = require('http').createServer(app);
-var io = require('socket.io')(server);
-io.on('connection', function(){ /* … */ });
+const app = require('express')();
+const server = require('http').createServer(app);
+const io = require('socket.io')(server);
+io.on('connection', () => { /* … */ });
 server.listen(3000);
 ```
 
@@ -131,10 +131,10 @@ Like Express.JS, Koa works by exposing an application as a request
 handler function, but only by calling the `callback` method.
 
 ```js
-var app = require('koa')();
-var server = require('http').createServer(app.callback());
-var io = require('socket.io')(server);
-io.on('connection', function(){ /* … */ });
+const app = require('koa')();
+const server = require('http').createServer(app.callback());
+const io = require('socket.io')(server);
+io.on('connection', () => { /* … */ });
 server.listen(3000);
 ```
 

docs/API.md

@@ -78,7 +78,7 @@ Exposed by `require('socket.io')`.
     - `path` _(String)_: name of the path to capture (`/socket.io`)
     - `serveClient` _(Boolean)_: whether to serve the client files (`true`)
     - `adapter` _(Adapter)_: the adapter to use. Defaults to an instance of the `Adapter` that ships with socket.io which is memory based. See [socket.io-adapter](https://github.com/socketio/socket.io-adapter)
-    - `origins` _(String)_: the allowed origins (`*`)
+    - `origins` _(String)_: the allowed origins (`*:*`)
     - `parser` _(Parser)_: the parser to use. Defaults to an instance of the `Parser` that ships with socket.io. See [socket.io-parser](https://github.com/socketio/socket.io-parser).
 
 Works with and without `new`:
@@ -635,7 +635,7 @@ Emits an event to the socket identified by the string name. Any other parameters
 
 ```js
 socket.emit('hello', 'world');
-socket.emit('with-binary', 1, '2', { 3: '4', 5: new Buffer(6) });
+socket.emit('with-binary', 1, '2', { 3: '4', 5: Buffer.alloc(6) });
 ```
 
 The `ack` argument is optional and will be called with the client's answer.

docs/emit.md

@@ -29,7 +29,7 @@ function onConnect(socket){
   io.of('myNamespace').to('room').emit('event', 'message');
 
   // sending to individual socketid (private message)
-  socket.to(<socketid>).emit('hey', 'I just met you');
+  io.to(<socketid>).emit('hey', 'I just met you');
 
   // sending with acknowledgement
   socket.emit('question', 'do you think so?', function (answer) {});

examples/chat/index.js

@@ -6,7 +6,7 @@ var server = require('http').createServer(app);
 var io = require('../..')(server);
 var port = process.env.PORT || 3000;
 
-server.listen(port, function () {
+server.listen(port, () => {
   console.log('Server listening at port %d', port);
 });
 
@@ -17,11 +17,11 @@ app.use(express.static(path.join(__dirname, 'public')));
 
 var numUsers = 0;
 
-io.on('connection', function (socket) {
+io.on('connection', (socket) => {
   var addedUser = false;
 
   // when the client emits 'new message', this listens and executes
-  socket.on('new message', function (data) {
+  socket.on('new message', (data) => {
     // we tell the client to execute 'new message'
     socket.broadcast.emit('new message', {
       username: socket.username,
@@ -30,7 +30,7 @@ io.on('connection', function (socket) {
   });
 
   // when the client emits 'add user', this listens and executes
-  socket.on('add user', function (username) {
+  socket.on('add user', (username) => {
     if (addedUser) return;
 
     // we store the username in the socket session for this client
@@ -48,21 +48,21 @@ io.on('connection', function (socket) {
   });
 
   // when the client emits 'typing', we broadcast it to others
-  socket.on('typing', function () {
+  socket.on('typing', () => {
     socket.broadcast.emit('typing', {
       username: socket.username
     });
   });
 
   // when the client emits 'stop typing', we broadcast it to others
-  socket.on('stop typing', function () {
+  socket.on('stop typing', () => {
     socket.broadcast.emit('stop typing', {
       username: socket.username
     });
   });
 
   // when the user disconnects.. perform this
-  socket.on('disconnect', function () {
+  socket.on('disconnect', () => {
     if (addedUser) {
       --numUsers;
 

examples/chat/public/main.js

@@ -25,7 +25,7 @@ $(function() {
 
   var socket = io();
 
-  function addParticipantsMessage (data) {
+  const addParticipantsMessage = (data) => {
     var message = '';
     if (data.numUsers === 1) {
       message += "there's 1 participant";
@@ -36,7 +36,7 @@ $(function() {
   }
 
   // Sets the client's username
-  function setUsername () {
+  const setUsername = () => {
     username = cleanInput($usernameInput.val().trim());
 
     // If the username is valid
@@ -52,7 +52,7 @@ $(function() {
   }
 
   // Sends a chat message
-  function sendMessage () {
+  const sendMessage = () => {
     var message = $inputMessage.val();
     // Prevent markup from being injected into the message
     message = cleanInput(message);
@@ -69,13 +69,13 @@ $(function() {
   }
 
   // Log a message
-  function log (message, options) {
+    const log = (message, options) => {
     var $el = $('<li>').addClass('log').text(message);
     addMessageElement($el, options);
   }
 
   // Adds the visual chat message to the message list
-  function addChatMessage (data, options) {
+  const addChatMessage = (data, options) => {
     // Don't fade the message in if there is an 'X was typing'
     var $typingMessages = getTypingMessages(data);
     options = options || {};
@@ -100,14 +100,14 @@ $(function() {
   }
 
   // Adds the visual chat typing message
-  function addChatTyping (data) {
+  const addChatTyping = (data) => {
     data.typing = true;
     data.message = 'is typing';
     addChatMessage(data);
   }
 
   // Removes the visual chat typing message
-  function removeChatTyping (data) {
+  const removeChatTyping = (data) => {
     getTypingMessages(data).fadeOut(function () {
       $(this).remove();
     });
@@ -118,7 +118,7 @@ $(function() {
   // options.fade - If the element should fade-in (default = true)
   // options.prepend - If the element should prepend
   //   all other messages (default = false)
-  function addMessageElement (el, options) {
+  const addMessageElement = (el, options) => {
     var $el = $(el);
 
     // Setup default options
@@ -145,12 +145,12 @@ $(function() {
   }
 
   // Prevents input from having injected markup
-  function cleanInput (input) {
+  const cleanInput = (input) => {
     return $('<div/>').text(input).html();
   }
 
   // Updates the typing event
-  function updateTyping () {
+  const updateTyping = () => {
     if (connected) {
       if (!typing) {
         typing = true;
@@ -158,7 +158,7 @@ $(function() {
       }
       lastTypingTime = (new Date()).getTime();
 
-      setTimeout(function () {
+      setTimeout(() => {
         var typingTimer = (new Date()).getTime();
         var timeDiff = typingTimer - lastTypingTime;
         if (timeDiff >= TYPING_TIMER_LENGTH && typing) {
@@ -170,14 +170,14 @@ $(function() {
   }
 
   // Gets the 'X is typing' messages of a user
-  function getTypingMessages (data) {
+  const getTypingMessages = (data) => {
     return $('.typing.message').filter(function (i) {
       return $(this).data('username') === data.username;
     });
   }
 
   // Gets the color of a username through our hash function
-  function getUsernameColor (username) {
+  const getUsernameColor = (username) => {
     // Compute hash code
     var hash = 7;
     for (var i = 0; i < username.length; i++) {
@@ -190,7 +190,7 @@ $(function() {
 
   // Keyboard events
 
-  $window.keydown(function (event) {
+  $window.keydown(event => {
     // Auto-focus the current input when a key is typed
     if (!(event.ctrlKey || event.metaKey || event.altKey)) {
       $currentInput.focus();
@@ -207,26 +207,26 @@ $(function() {
     }
   });
 
-  $inputMessage.on('input', function() {
+  $inputMessage.on('input', () => {
     updateTyping();
   });
 
   // Click events
 
   // Focus input when clicking anywhere on login page
-  $loginPage.click(function () {
+  $loginPage.click(() => {
     $currentInput.focus();
   });
 
   // Focus input when clicking on the message input's border
-  $inputMessage.click(function () {
+  $inputMessage.click(() => {
     $inputMessage.focus();
   });
 
   // Socket events
 
   // Whenever the server emits 'login', log the login message
-  socket.on('login', function (data) {
+  socket.on('login', (data) => {
     connected = true;
     // Display the welcome message
     var message = "Welcome to Socket.IO Chat – ";
@@ -237,45 +237,45 @@ $(function() {
   });
 
   // Whenever the server emits 'new message', update the chat body
-  socket.on('new message', function (data) {
+  socket.on('new message', (data) => {
     addChatMessage(data);
   });
 
   // Whenever the server emits 'user joined', log it in the chat body
-  socket.on('user joined', function (data) {
+  socket.on('user joined', (data) => {
     log(data.username + ' joined');
     addParticipantsMessage(data);
   });
 
   // Whenever the server emits 'user left', log it in the chat body
-  socket.on('user left', function (data) {
+  socket.on('user left', (data) => {
     log(data.username + ' left');
     addParticipantsMessage(data);
     removeChatTyping(data);
   });
 
   // Whenever the server emits 'typing', show the typing message
-  socket.on('typing', function (data) {
+  socket.on('typing', (data) => {
     addChatTyping(data);
   });
 
   // Whenever the server emits 'stop typing', kill the typing message
-  socket.on('stop typing', function (data) {
+  socket.on('stop typing', (data) => {
     removeChatTyping(data);
   });
 
-  socket.on('disconnect', function () {
+  socket.on('disconnect', () => {
     log('you have been disconnected');
   });
 
-  socket.on('reconnect', function () {
+  socket.on('reconnect', () => {
     log('you have been reconnected');
     if (username) {
       socket.emit('add user', username);
     }
   });
 
-  socket.on('reconnect_error', function () {
+  socket.on('reconnect_error', () => {
     log('attempt to reconnect has failed');
   });
 

examples/cluster-nginx/server/package.json

@@ -5,7 +5,7 @@
   "main": "index.js",
   "author": "Grant Timmerman",
   "private": true,
-  "license": "BSD",
+  "license": "MIT",
   "dependencies": {
     "express": "4.13.4",
     "socket.io": "^1.7.2",

examples/custom-parsers/README.md

@@ -14,7 +14,7 @@ They are tested with various payloads:
 
 - string: `['1', '2', ... '1000']`
 - numeric: `[1, 2, ... 1000]`
-- binary: `new Buffer(1000), where buf[i] = i`
+- binary: `Buffer.allocUnsafe(1000), where buf[i] = i`
 
 ## How to use
 

examples/custom-parsers/src/server.js

@@ -27,7 +27,7 @@ let server4 = io(3004, {
 
 let string = [];
 let numeric = [];
-let binary = new Buffer(1e3);
+let binary = Buffer.allocUnsafe(1e3);
 for (var i = 0; i < 1e3; i++) {
   string.push('' + i);
   numeric.push(i);

examples/whiteboard/public/main.js

@@ -16,6 +16,12 @@
   canvas.addEventListener('mouseup', onMouseUp, false);
   canvas.addEventListener('mouseout', onMouseUp, false);
   canvas.addEventListener('mousemove', throttle(onMouseMove, 10), false);
+  
+  //Touch support for mobile devices
+  canvas.addEventListener('touchstart', onMouseDown, false);
+  canvas.addEventListener('touchend', onMouseUp, false);
+  canvas.addEventListener('touchcancel', onMouseUp, false);
+  canvas.addEventListener('touchmove', throttle(onMouseMove, 10), false);
 
   for (var i = 0; i < colors.length; i++){
     colors[i].addEventListener('click', onColorUpdate, false);
@@ -51,21 +57,21 @@
 
   function onMouseDown(e){
     drawing = true;
-    current.x = e.clientX;
-    current.y = e.clientY;
+    current.x = e.clientX||e.touches[0].clientX;
+    current.y = e.clientY||e.touches[0].clientY;
   }
 
   function onMouseUp(e){
     if (!drawing) { return; }
     drawing = false;
-    drawLine(current.x, current.y, e.clientX, e.clientY, current.color, true);
+    drawLine(current.x, current.y, e.clientX||e.touches[0].clientX, e.clientY||e.touches[0].clientY, current.color, true);
   }
 
   function onMouseMove(e){
     if (!drawing) { return; }
-    drawLine(current.x, current.y, e.clientX, e.clientY, current.color, true);
-    current.x = e.clientX;
-    current.y = e.clientY;
+    drawLine(current.x, current.y, e.clientX||e.touches[0].clientX, e.clientY||e.touches[0].clientY, current.color, true);
+    current.x = e.clientX||e.touches[0].clientX;
+    current.y = e.clientY||e.touches[0].clientY;
   }
 
   function onColorUpdate(e){

lib/index.js

@@ -370,6 +370,7 @@ Server.prototype.serve = function(req, res){
   }
 
   debug('serve client source');
+  res.setHeader("Cache-Control", "public, max-age=0");
   res.setHeader('Content-Type', 'application/javascript');
   res.setHeader('ETag', expectedEtag);
   res.writeHead(200);

lib/namespace.js

@@ -262,6 +262,9 @@ Namespace.prototype.write = function(){
  */
 
 Namespace.prototype.clients = function(fn){
+  if(!this.adapter){
+    throw new Error('No adapter for this namespace, are you trying to get the list of clients of a dynamic namespace?')
+  }
   this.adapter.clients(this.rooms, fn);
   // reset rooms for scenario:
   // .in('room').clients() (GH-1978)

lib/socket.js

@@ -39,7 +39,8 @@ exports.events = [
 var flags = [
   'json',
   'volatile',
-  'broadcast'
+  'broadcast',
+  'local'
 ];
 
 /**

package.json

@@ -1,6 +1,6 @@
 {
   "name": "socket.io",
-  "version": "2.1.0",
+  "version": "2.3.0",
   "description": "node.js realtime framework server",
   "keywords": [
     "realtime",
@@ -24,12 +24,12 @@
     "test": "nyc mocha --reporter spec --slow 200 --bail --timeout 10000 test/socket.io.js"
   },
   "dependencies": {
-    "debug": "~3.1.0",
-    "engine.io": "~3.2.0",
+    "debug": "~4.1.0",
+    "engine.io": "~3.4.0",
     "has-binary2": "~1.0.2",
     "socket.io-adapter": "~1.1.0",
-    "socket.io-client": "2.1.0",
-    "socket.io-parser": "~3.2.0"
+    "socket.io-client": "2.3.0",
+    "socket.io-parser": "~3.4.0"
   },
   "devDependencies": {
     "expect.js": "0.3.1",

test/socket.io.js

@@ -23,7 +23,7 @@ function client(srv, nsp, opts){
 
 describe('socket.io', function(){
 
-  it('should be the same version as client', function(){
+  it.skip('should be the same version as client', function(){
     var version = require('../package').version;
     expect(version).to.be(require('socket.io-client/package').version);
   });
@@ -1126,7 +1126,7 @@ describe('socket.io', function(){
         sio.on('connection', function(s){
           fs.readFile(join(__dirname, 'support', 'doge.jpg'), function(err, data){
             if (err) return done(err);
-            var buf = new Buffer('asdfasdf', 'utf8');
+            var buf = Buffer.from('asdfasdf', 'utf8');
             s.emit('multiple', 1, data, '3', [4], buf, [data, 'swag', buf]);
           });
         });
@@ -1143,7 +1143,7 @@ describe('socket.io', function(){
             expect(Buffer.isBuffer(a)).to.be(true);
             done();
           });
-          var buf = new Buffer('abcdefg', 'utf8');
+          var buf = Buffer.from('abcdefg', 'utf8');
           socket.emit('buff', buf);
         });
       });
@@ -1168,7 +1168,7 @@ describe('socket.io', function(){
           });
           fs.readFile(join(__dirname, 'support', 'doge.jpg'), function(err, data){
             if (err) return done(err);
-            var buf = new Buffer('asdfasdf', 'utf8');
+            var buf = Buffer.from('asdfasdf', 'utf8');
             socket.emit('multiple', 1, data, '3', [4], buf, [data, 'swag', buf]);
           });
         });
@@ -1496,7 +1496,7 @@ describe('socket.io', function(){
             expect(Buffer.isBuffer(buf)).to.be(true);
             fn(1, 2);
           });
-          socket.emit('woot', new Buffer(3), function(a, b){
+          socket.emit('woot', Buffer.alloc(3), function(a, b){
             expect(a).to.be(1);
             expect(b).to.be(2);
             done();
@@ -1515,7 +1515,7 @@ describe('socket.io', function(){
             expect(Buffer.isBuffer(a)).to.be(true);
             fn();
           });
-          s.emit('hi', new Buffer(4), function(){
+          s.emit('hi', Buffer.alloc(4), function(){
             done();
           });
         });
@@ -1529,7 +1529,7 @@ describe('socket.io', function(){
         var socket = client(srv);
         sio.on('connection', function(s){
           socket.on('hi', function(fn){
-            fn(new Buffer(1));
+            fn(Buffer.alloc(1));
           });
           s.emit('hi', function(a){
             expect(Buffer.isBuffer(a)).to.be(true);
@@ -1546,7 +1546,7 @@ describe('socket.io', function(){
         var socket = client(srv);
         sio.on('connection', function(s){
           s.on('woot', function(fn){
-            fn(new Buffer(2));
+            fn(Buffer.alloc(2));
           });
           socket.emit('woot', function(a){
             expect(Buffer.isBuffer(a)).to.be(true);
@@ -1899,7 +1899,7 @@ describe('socket.io', function(){
         });
 
         function emit(){
-          sio.emit('bin', new Buffer(10));
+          sio.emit('bin', Buffer.alloc(10));
         }
       });
     });
@@ -2083,8 +2083,8 @@ describe('socket.io', function(){
             socket.join(room, fn);
           });
           socket.on('broadcast', function(){
-            socket.broadcast.to('test').emit('bin', new Buffer(5));
-            socket.emit('bin2', new Buffer(5));
+            socket.broadcast.to('test').emit('bin', Buffer.alloc(5));
+            socket.emit('bin2', Buffer.alloc(5));
           });
         });
       });