Converted Arrays to Maps

Author: darrachequesne

lib/client.js

@@ -28,7 +28,7 @@ function Client(server, conn){
   this.id = conn.id;
   this.request = conn.request;
   this.setup();
-  this.sockets = [];
+  this.sockets = new Map();
   this.nsps = {};
   this.connectBuffer = [];
 }
@@ -72,7 +72,7 @@ Client.prototype.connect = function(name){
 
   var self = this;
   var socket = nsp.add(this, function(){
-    self.sockets.push(socket);
+    self.sockets.set(socket.id, socket);
     self.nsps[nsp.name] = socket;
 
     if ('/' == nsp.name && self.connectBuffer.length > 0) {
@@ -89,12 +89,10 @@ 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()) {
+  for (var socket of this.sockets.values()) {
     socket.disconnect();
   }
+  this.sockets.clear();
   this.close();
 };
 
@@ -105,10 +103,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.has(socket.id)) {
+    var nsp = this.sockets.get(socket.id).nsp.name;
+    this.sockets.delete(socket.id);
     delete this.nsps[nsp];
   } else {
     debug('ignoring remove for %s', socket.id);
@@ -205,9 +202,9 @@ Client.prototype.ondecoded = function(packet) {
  */
 
 Client.prototype.onerror = function(err){
-  this.sockets.forEach(function(socket){
+  for (var socket of this.sockets.values()) {
     socket.onerror(err);
-  });
+  }
   this.onclose('client error');
 };
 
@@ -225,10 +222,10 @@ Client.prototype.onclose = function(reason){
   this.destroy();
 
   // `nsps` and `sockets` are cleaned up seamlessly
-  var socket;
-  while (socket = this.sockets.shift()) {
+  for (var socket of this.sockets.values()) {
     socket.onclose(reason);
   }
+  this.sockets.clear();
 
   this.decoder.destroy(); // clean up decoder
 };

lib/index.js

@@ -346,9 +346,9 @@ Server.prototype.of = function(name, fn){
  */
 
 Server.prototype.close = function(){
-  this.nsps['/'].sockets.forEach(function(socket){
+  for (var socket of this.nsps['/'].sockets.values()) {
     socket.onclose();
-  });
+  }
 
   this.engine.close();
 

lib/namespace.js

@@ -51,7 +51,7 @@ var emit = Emitter.prototype.emit;
 function Namespace(server, name){
   this.name = name;
   this.server = server;
-  this.sockets = [];
+  this.sockets = new Map();
   this.connected = {};
   this.fns = [];
   this.ids = 0;
@@ -161,7 +161,7 @@ Namespace.prototype.add = function(client, fn){
         if (err) return socket.error(err.data || err.message);
 
         // track socket
-        self.sockets.push(socket);
+        self.sockets.set(socket.id, socket);
 
         // it's paramount that the internal `onconnect` logic
         // fires before user-set events to prevent state order
@@ -188,9 +188,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.has(socket.id)) {
+    this.sockets.delete(socket.id);
   } else {
     debug('ignoring remove for %s', socket.id);
   }

lib/socket.js

@@ -59,11 +59,11 @@ function Socket(nsp, client){
   this.nsp = nsp;
   this.server = nsp.server;
   this.adapter = this.nsp.adapter;
-  this.id = client.id;
+  this.id = nsp.name + '#' + client.id;
   this.request = client.request;
   this.client = client;
   this.conn = client.conn;
-  this.rooms = [];
+  this.rooms = new Map();
   this.acks = {};
   this.connected = true;
   this.disconnected = false;
@@ -223,11 +223,11 @@ Socket.prototype.packet = function(packet, opts){
 Socket.prototype.join = function(room, fn){
   debug('joining room %s', room);
   var self = this;
-  if (~this.rooms.indexOf(room)) return this;
+  if (this.rooms.has(room)) 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.set(room, room);
     fn && fn(null);
   });
   return this;
@@ -248,10 +248,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);
-    var idx = self.rooms.indexOf(room);
-    if (idx >= 0) {
-      self.rooms.splice(idx, 1);
-    }
+    self.rooms.delete(room);
     fn && fn(null);
   });
   return this;
@@ -265,7 +262,7 @@ Socket.prototype.leave = function(room, fn){
 
 Socket.prototype.leaveAll = function(){
   this.adapter.delAll(this.id);
-  this.rooms = [];
+  this.rooms.clear();
 };
 
 /**

test/socket.io.js

@@ -19,6 +19,14 @@ function client(srv, nsp, opts){
   return ioc(url, opts);
 }
 
+// Returns an array of keys from a Map
+// Note: spread separator only available in Node.js >= 5.x.x
+function getKeys(map){
+  var a = [];
+  for (var k of map.keys()) { a.push(k); }
+  return a;
+}
+
 describe('socket.io', function(){
 
   it('should be the same version as client', function(){
@@ -342,12 +350,12 @@ describe('socket.io', function(){
       var clientSocket = client(srv, { reconnection: false });
 
       clientSocket.on('disconnect', function init() {
-        expect(sio.nsps['/'].sockets.length).to.equal(0);
+        expect(sio.nsps['/'].sockets.size).to.equal(0);
         server.listen(PORT);
       });
 
       clientSocket.on('connect', function init() {
-        expect(sio.nsps['/'].sockets.length).to.equal(1);
+        expect(sio.nsps['/'].sockets.size).to.equal(1);
         sio.close();
       });
 
@@ -369,12 +377,12 @@ describe('socket.io', function(){
       var clientSocket = ioc('ws://0.0.0.0:' + PORT);
 
       clientSocket.on('disconnect', function init() {
-        expect(sio.nsps['/'].sockets.length).to.equal(0);
+        expect(sio.nsps['/'].sockets.size).to.equal(0);
         server.listen(PORT);
       });
 
       clientSocket.on('connect', function init() {
-        expect(sio.nsps['/'].sockets.length).to.equal(1);
+        expect(sio.nsps['/'].sockets.size).to.equal(1);
         sio.close();
       });
 
@@ -1906,15 +1914,15 @@ describe('socket.io', function(){
         var socket = client(srv);
         sio.on('connection', function(s){
           s.join('a', function(){
-            expect(s.rooms).to.eql([s.id, 'a']);
+            expect(getKeys(s.rooms)).to.eql([s.id, 'a']);
             s.join('b', function(){
-              expect(s.rooms).to.eql([s.id, 'a', 'b']);
+              expect(getKeys(s.rooms)).to.eql([s.id, 'a', 'b']);
               s.join( 'c', function(){
-                expect(s.rooms).to.eql([s.id, 'a', 'b', 'c']);
+                expect(getKeys(s.rooms)).to.eql([s.id, 'a', 'b', 'c']);
                 s.leave('b', function(){
-                  expect(s.rooms).to.eql([s.id, 'a', 'c']);
+                  expect(getKeys(s.rooms)).to.eql([s.id, 'a', 'c']);
                   s.leaveAll();
-                  expect(s.rooms).to.eql([]);
+                  expect(getKeys(s.rooms)).to.eql([]);
                   done();
                 });
               });
@@ -1950,13 +1958,13 @@ describe('socket.io', function(){
         var socket = client(srv);
         sio.on('connection', function(s){
           s.join('a', function(){
-            expect(s.rooms).to.eql([s.id, 'a']);
+            expect(getKeys(s.rooms)).to.eql([s.id, 'a']);
             s.join('b', function(){
-              expect(s.rooms).to.eql([s.id, 'a', 'b']);
+              expect(getKeys(s.rooms)).to.eql([s.id, 'a', 'b']);
               s.leave('unknown', function(){
-                expect(s.rooms).to.eql([s.id, 'a', 'b']);
+                expect(getKeys(s.rooms)).to.eql([s.id, 'a', 'b']);
                 s.leaveAll();
-                expect(s.rooms).to.eql([]);
+                expect(getKeys(s.rooms)).to.eql([]);
                 done();
               });
             });