Release 0.7.7

It was emitting uknown room, so the messages where never send

History.md

@@ -1,4 +1,26 @@
 
+0.7.7 / 2011-07-12
+==================
+
+  * Fixed double dispatch handling with emit to closed clients.
+  * Added test for emitting to closed clients to prevent regression.
+  * Fixed race condition in redis test.
+  * Changed Transport#end instrumentation.
+  * Leveraged $emit instead of emit internally.
+  * Made tests faster.
+  * Fixed double disconnect events.
+  * Fixed disconnect logic
+  * Simplified remote events handling in Socket.
+  * Increased testcase timeout.
+  * Fixed unknown room emitting (GH-291). [3rd-Eden]
+  * Fixed `address` in handshakeData. [3rd-Eden]
+  * Removed transports definition in chat example.
+  * Fixed room cleanup
+  * Fixed; make sure the client is cleaned up after booting.
+  * Make sure to mark the client as non-open if the connection is closed.
+  * Removed unneeded `buffer` declarations.
+  * Fixed; make sure to clear socket handlers and subscriptions upon transport close.
+
 0.7.6 / 2011-06-30
 ==================
 

Makefile

@@ -4,6 +4,7 @@ ALL_TESTS = $(shell find test/ -name '*.test.js')
 run-tests:
 	@npm link > /dev/null --local
 	@./node_modules/.bin/expresso \
+		-t 3000 \
 		-I support \
 		-I lib \
 		--serial \

examples/chat/app.js

@@ -61,10 +61,6 @@ app.listen(3000, function () {
 var io = sio.listen(app)
   , nicknames = {};
 
-io.set('transports', [
-  , 'xhr-polling'
-]);
-
 io.sockets.on('connection', function (socket) {
   socket.on('user message', function (msg) {
     socket.broadcast.emit('user message', socket.nickname, msg);

lib/manager.js

@@ -324,18 +324,6 @@ Manager.prototype.onOpen = function (id) {
  */
 
 Manager.prototype.onDispatch = function (room, packet, volatile, exceptions) {
-  // go through the users who have pending buffers
-  for (var i = 0, l = this.closedA.length; i < l; i++) {
-    if (!this.roomClients[this.closedA[i]]) continue;
-
-    if (this.roomClients[this.closedA[i]][room]) {
-      if (!~exceptions.indexOf(this.closedA[i])) {
-        this.closed[this.closedA[i]].push(packet);
-      }
-    }
-  }
-
-  // go through room clients
   if (this.rooms[room]) {
     for (var i = 0, l = this.rooms[room].length; i < l; i++) {
       var id = this.rooms[room][i];
@@ -390,6 +378,10 @@ Manager.prototype.onLeave = function (id, room) {
  */
 
 Manager.prototype.onClose = function (id) {
+  if (this.open[id]) {
+    delete this.open[id];
+  }
+
   this.closed[id] = [];
   this.closedA.push(id);
 
@@ -433,6 +425,8 @@ Manager.prototype.onClientMessage = function (id, packet) {
  */
 
 Manager.prototype.onClientDisconnect = function (id, reason) {
+  this.onDisconnect(id);
+
   for (var name in this.namespaces) {
     if (this.roomClients[id][name]) {
       this.namespaces[name].handleDisconnect(id, reason);
@@ -469,7 +463,7 @@ Manager.prototype.onDisconnect = function (id, local) {
 
   if (this.roomClients[id]) {
     for (var room in this.roomClients[id]) {
-      this.rooms[room].splice(this.rooms.indexOf(id), 1);
+      this.rooms[room].splice(this.rooms[room].indexOf(id), 1);
     }
   }
 
@@ -811,10 +805,21 @@ Manager.prototype.handleHandshake = function (data, req, res) {
  */
 
 Manager.prototype.handshakeData = function (data) {
-  var connectionAddress = null;
-  if (data.request.connection.address) {
-    connectionAddress = data.request.connection.address();
+  var connection = data.request.connection
+    , connectionAddress;
+
+  if (connection.remoteAddress) {
+    connectionAddress = {
+        address: connection.remoteAddress
+      , port: connection.remotePort
+    }; 
+  } else if (connection.socket && connection.socket.remoteAddress) {
+    connectionAddress = {
+        address: connection.socket.remoteAddress
+      , port: connection.socket.remotePort
+    }; 
   }
+
   return {
       headers: data.headers
     , address: connectionAddress

lib/namespace.js

@@ -49,7 +49,7 @@ SocketNamespace.prototype.$emit = EventEmitter.prototype.emit;
 
 SocketNamespace.prototype.clients = function (room) {
   var room = this.name + (room !== undefined ?
-    (this.name !== '' ? '/' : '') + room : '');
+     '/' + room : '');
 
   if (!this.manager.rooms[room]) {
     return [];
@@ -109,7 +109,7 @@ SocketNamespace.prototype.__defineGetter__('volatile', function () {
  */
 
 SocketNamespace.prototype.in = function (room) {
-  this.flags.endpoint = (this.name === '' ? '' : (this.name + '/')) + room;
+  this.flags.endpoint = this.name + (room ? '/' + room : '');
   return this;
 };
 
@@ -181,7 +181,7 @@ SocketNamespace.prototype.send = function (data) {
  */
 
 SocketNamespace.prototype.emit = function (name) {
-  if (name == 'connection' || name == 'newListener') {
+  if (name == 'newListener') {
     return this.$emit.apply(this, arguments);
   }
 
@@ -287,7 +287,7 @@ SocketNamespace.prototype.handlePacket = function (sessid, packet) {
     socket.packet({ type: 'connect' });
 
     // emit connection event
-    self.emit('connection', socket);
+    self.$emit('connection', socket);
   };
 
   switch (packet.type) {
@@ -333,7 +333,7 @@ SocketNamespace.prototype.handlePacket = function (sessid, packet) {
       this.manager.onLeave(sessid, this.name);
       this.store.publish('leave', sessid, this.name);
 
-      socket.emit('disconnect', packet.reason || 'packet');
+      socket.$emit('disconnect', packet.reason || 'packet');
       break;
 
     case 'json':
@@ -343,6 +343,6 @@ SocketNamespace.prototype.handlePacket = function (sessid, packet) {
       if (dataAck)
         params.push(ack);
 
-      socket.emit.apply(socket, params);
+      socket.$emit.apply(socket, params);
   };
 };

lib/socket.io.js

@@ -15,7 +15,7 @@ var client = require('socket.io-client');
  * Version.
  */
 
-exports.version = '0.7.6';
+exports.version = '0.7.7';
 
 /**
  * Supported protocol version.

lib/socket.js

@@ -19,22 +19,6 @@ var parser = require('./parser')
 
 exports = module.exports = Socket;
 
-/**
- * Reserved event names.
- */
-
-var events = {
-    message: 1
-  , connect: 1
-  , disconnect: 1
-  , open: 1
-  , close: 1
-  , error: 1
-  , retry: 1
-  , reconnect: 1
-  , newListener: 1
-};
-
 /**
  * Socket constructor.
  *
@@ -149,7 +133,7 @@ Socket.prototype.setFlags = function () {
 
 Socket.prototype.onDisconnect = function (reason) {
   if (!this.disconnected) {
-    this.emit('disconnect', reason);
+    this.$emit('disconnect', reason);
     this.disconnected = true;
   }
 };
@@ -162,7 +146,7 @@ Socket.prototype.onDisconnect = function (reason) {
 
 Socket.prototype.join = function (name, fn) {
   var nsp = this.namespace.name
-    , name = (nsp === '' ? '' : (nsp + '/')) + name;
+    , name = (nsp + '/') + name;
 
   this.manager.onJoin(this.id, name);
   this.manager.store.publish('join', this.id, name);
@@ -183,7 +167,7 @@ Socket.prototype.join = function (name, fn) {
 
 Socket.prototype.leave = function (name, fn) {
   var nsp = this.namespace.name
-    , name = (nsp === '' ? '' : (nsp + '/')) + name;
+    , name = (nsp + '/') + name;
 
   this.manager.onLeave(this.id, name);
   this.manager.store.publish('leave', this.id, name);
@@ -293,13 +277,8 @@ Socket.prototype.disconnect = function () {
     if (this.manager.transports[this.id] && this.manager.transports[this.id].open) {
       this.manager.transports[this.id].onForcedDisconnect();
     } else {
-      if (this.manager.open[this.id]) {
-        // if the connection is open in a different node
-        this.manager.store.publish('disconnect-force:' + this.id);
-      } else {
-        this.manager.onClientDisconnect(this.id);
-        this.manager.store.publish('disconnect:' + this.id);
-      }
+      this.manager.onClientDisconnect(this.id);
+      this.manager.store.publish('disconnect:' + this.id);
     }
   }
 
@@ -342,7 +321,7 @@ Socket.prototype.$emit = EventEmitter.prototype.emit;
  */
 
 Socket.prototype.emit = function (ev) {
-  if (events[ev]) {
+  if (ev == 'newListener') {
     return this.$emit.apply(this, arguments);
   }
 

lib/transport.js

@@ -28,7 +28,6 @@ function Transport (mng, data, req) {
   this.id = data.id;
   this.disconnected = false;
   this.drained = true;
-  this.buffer = [];
   this.handleRequest(req);
 };
 
@@ -357,11 +356,13 @@ Transport.prototype.onMessage = function (packet) {
     if ('disconnect' == packet.type && packet.endpoint == '') {
       this.log.debug('got disconnection packet');
 
-      if (current && current.open) {
+      if (current) {
         current.onForcedDisconnect();
       } else {
         this.store.publish('disconnect-force:' + this.id);
       }
+
+      return;
     }
 
     if (packet.id && packet.ack != 'data') {
@@ -439,6 +440,7 @@ Transport.prototype.close = function () {
 Transport.prototype.onClose = function () {
   if (this.open) {
     this.setCloseTimeout();
+    this.clearHandlers();
     this.open = false;
     this.manager.onClose(this.id);
     this.store.publish('close', this.id);
@@ -453,7 +455,7 @@ Transport.prototype.onClose = function () {
 
 Transport.prototype.end = function (reason) {
   if (!this.disconnected) {
-    this.log.info('ending socket');
+    this.log.info('transport end');
 
     var local = this.manager.transports[this.id];
 
@@ -480,7 +482,6 @@ Transport.prototype.discard = function () {
   this.discarded = true;
   this.clearTimeouts();
   this.clearHandlers();
-  this.buffer = [];
 
   return this;
 };

package.json

@@ -1,7 +1,7 @@
 {
     "name": "socket.io"
-  , "version": "0.7.6"
-  , "description": "Realtime apps made cross-browser & easy with a WebSocket-like API"
+  , "version": "0.7.7"
+  , "description": "Real-time apps made cross-browser & easy with a WebSocket-like API"
   , "homepage": "http://socket.io"
   , "keywords": ["websocket", "socket", "realtime", "socket.io", "comet", "ajax"]
   , "author": "Guillermo Rauch <guillermo@learnboost.com>"
@@ -15,7 +15,7 @@
       , "url": "https://github.com/LearnBoost/Socket.IO-node.git"
     }
   , "dependencies": {
-        "socket.io-client": "0.7.3"
+        "socket.io-client": "0.7.4"
       , "policyfile": "0.0.3"
       , "redis": "0.6.0"
     }

test/common.js

@@ -180,7 +180,9 @@ client = function (port) {
 
 create = function (cl) {
   console.log('');
-  return io.listen(cl.port);
+  var manager = io.listen(cl.port);
+  manager.set('client store expiration', 0);
+  return manager;
 };
 
 /**

test/namespace.test.js

@@ -80,8 +80,8 @@ module.exports = {
         fn(null, true);
       })
       .on('connection', function (socket) {
-        socket.handshake.address.address.should.equal('127.0.0.1');
-        socket.handshake.address.port.should.equal(ports);
+        (!!socket.handshake.address.address).should.be.true;
+        (!!socket.handshake.address.port).should.be.true;
         socket.handshake.headers.host.should.equal('localhost');
         socket.handshake.headers.connection.should.equal('keep-alive');
         socket.handshake.time.should.match(/GMT/);
@@ -139,5 +139,109 @@ module.exports = {
         }
       })
     });
+  },
+
+  'broadcasting sends and emits on a namespace': function (done) {
+    var cl = client(++ports)
+      , io = create(cl)
+      , calls = 0
+      , connect = 0
+      , message = 0
+      , events = 0
+      , expected = 5
+      , ws1
+      , ws2;
+
+    io.of('a')
+      .on('connection', function (socket){
+        socket.broadcast.emit('b', 'test');
+        socket.broadcast.json.emit('json', {foo:'bar'});
+        socket.broadcast.send('foo');
+      });
+
+    function finish () {
+      connect.should.equal(2);
+      message.should.equal(1);
+      events.should.equal(2);
+
+      cl.end();
+      ws1.finishClose();
+      ws2.finishClose();
+      io.server.close();
+      done();
+    }
+
+    cl.handshake(function (sid) {
+     ws1 = websocket(cl, sid);
+
+      ws1.on('open', function() {
+        ws1.packet({
+            type: 'connect'
+          , endpoint: 'a'
+        });
+      });
+
+      ws1.on('message', function (data) {
+        if (data.type === 'connect') {
+          ++connect;
+          if (++calls === expected) finish();
+        }
+
+        if (data.type === 'message') {
+          ++message;
+          if (++calls === expected) finish();
+        }
+
+        if (data.type === 'event') {
+          if (data.name === 'b' || data.name === 'json') ++events;
+          if (++calls === expected) finish();
+        }
+      });
+
+      cl.handshake(function (sid) {
+        ws2 = websocket(cl, sid);
+
+        ws2.on('open', function () {
+          ws2.packet({
+              type: 'connect'
+            , endpoint: 'a'
+          });
+        });
+      })
+    })
+  },
+
+  'joining rooms inside a namespace': function (done) {
+    var cl = client(++ports)
+      , io = create(cl)
+      , calls = 0
+      , ws;
+
+    io.of('/foo').on('connection', function (socket) {
+      socket.join('foo.bar');
+      this.in('foo.bar').emit('baz', 'pewpew');
+    });
+
+    cl.handshake(function (sid) {
+      ws = websocket(cl, sid);
+
+      ws.on('open', function (){
+         ws.packet({
+            type: 'connect'
+          , endpoint: '/foo'
+        });
+      });
+
+      ws.on('message', function (data) {
+        if (data.type === 'event') {
+          data.name.should.equal('baz');
+
+          cl.end();
+          ws.finishClose();
+          io.server.close();
+          done();
+        }
+      });
+    })
   }
 };

test/stores.redis.test.js

@@ -233,7 +233,7 @@ module.exports = {
           store.destroy();
           done();
         });
-      }, 1900);
+      }, 2000);
     });
   }
 

test/transports.websocket.test.js

@@ -12,7 +12,7 @@
 var sio = require('socket.io')
   , should = require('./common')
   , parser = sio.parser
-  , ports = 15400;
+  , ports = 15800;
 
 /**
  * Tests.
@@ -1493,8 +1493,8 @@ module.exports = {
       , ws;
 
     io.sockets.on('connection', function (socket) {
-      socket.handshake.address.address.should.equal('127.0.0.1');
-      socket.handshake.address.port.should.equal(ports);
+      (!!socket.handshake.address.address).should.be.true;
+      (!!socket.handshake.address.port).should.be.true;
       socket.handshake.headers.host.should.equal('localhost');
       socket.handshake.headers.connection.should.equal('keep-alive');
       socket.handshake.time.should.match(/GMT/);

test/transports.xhr-polling.test.js

@@ -2635,4 +2635,82 @@ module.exports = {
     });
   },
 
+  'test emitting to closed clients': function (done) {
+    var cl = client(++ports)
+      , cl2 = client(ports)
+      , io = create(cl)
+      , connections = 0;
+
+    io.configure(function () {
+      io.set('close timeout', .1);
+    });
+
+    io.sockets.on('connection', function (socket) {
+      socket.send('a');
+    });
+
+    cl.handshake(function (sid) {
+      cl.get('/socket.io/{protocol}/xhr-polling/' + sid, function (res, packs) {
+        res.statusCode.should.equal(200);
+        packs.should.have.length(1);
+        packs[0].should.eql({ type: 'message', endpoint: '', data: 'a' });
+
+        cl2.handshake(function (sid2) {
+          cl2.get(
+              '/socket.io/{protocol}/xhr-polling/' + sid2
+            , function (res, packs) {
+                res.statusCode.should.equal(200);
+                packs.should.have.length(1);
+                packs[0].should.eql({ type: 'message', endpoint: '', data: 'a' });
+
+                io.sockets.emit('woot', 'b');
+
+                var total = 2;
+
+                cl.get(
+                    '/socket.io/{protocol}/xhr-polling/' + sid
+                  , function (res, packs) {
+                      res.statusCode.should.equal(200);
+                      packs.should.have.length(1);
+                      packs[0].should.eql({
+                          type: 'event'
+                        , endpoint: ''
+                        , name: 'woot'
+                        , args: ['b']
+                      });
+
+                      --total || finish();
+                    }
+                );
+
+                cl2.get(
+                    '/socket.io/{protocol}/xhr-polling/' + sid2
+                  , function (res, packs) {
+                      res.statusCode.should.equal(200);
+                      packs.should.have.length(1);
+                      packs[0].should.eql({
+                          type: 'event'
+                        , endpoint: ''
+                        , name: 'woot'
+                        , args: ['b']
+                      });
+
+                      --total || finish();
+                    }
+                );
+
+                function finish () {
+                  cl.end();
+                  cl2.end();
+                  io.server.close();
+                  done();
+                };
+              }
+          );
+        });
+        
+      });
+    });
+  }
+
 };