No need for 'register' event

Removed the 'register' event as the user details are now being passed as part of the initial socket setup.

Author: paul-graham

app/socket/index.js

@@ -24,8 +24,9 @@ module.exports = (server, redis) => {
     allowEIO3: true,
     cors: {
       origin: '*',
-      methods: ['GET', 'POST']
-    }
+      methods: ['GET', 'POST'],
+      credentials: true
+    },
   });
   const handlers = Handlers(activityService, socketServer);
   const watcher = redis.duplicate();

app/socket/router/index.js

@@ -25,13 +25,7 @@ const router = {
     return [...connections];
   },
   init: (io, iorouter, handlers) => {
-    const start = Date.now();
     // Set up routes for each type of message.
-    iorouter.on('register', (socket, ctx, next) => {
-      utils.log(socket, ctx.request.user, 'register');
-      router.addUser(socket.id, ctx.request.user);
-      next();
-    });
     iorouter.on('view', (socket, ctx, next) => {
       const user = router.getUser(socket.id);
       utils.log(socket, `${ctx.request.caseId} (${user.name})`, 'view');
@@ -54,15 +48,16 @@ const router = {
     // On client connection, attach the router and track the socket.
     io.on('connection', (socket) => {
       router.addConnection(socket);
-      const ts = (Date.now() - start).toString(10).padStart(10, '0');
-      utils.log(socket, '', `connected (${router.getConnections().length} total)`, console.log, ts);
+      router.addUser(socket.id, socket.handshake.query.user);
+      utils.log(socket, '', `connected (${router.getConnections().length} total)`);
+      utils.log(socket, '', `connected (${router.getConnections().length} total)`, console.log, Date.now());
       socket.use((packet, next) => {
         iorouter.attach(socket, packet, next);
       });
       // When the socket disconnects, do an appropriate teardown.
       socket.on('disconnect', () => {
-        const ts = (Date.now() - start).toString(10).padStart(10, '0');
-        utils.log(socket, '', `disconnected (${router.getConnections().length - 1} total)`, console.log, ts);
+        utils.log(socket, '', `disconnected (${router.getConnections().length - 1} total)`);
+        utils.log(socket, '', `disconnected (${router.getConnections().length - 1} total)`, console.log, Date.now());
         handlers.removeSocketActivity(socket.id);
         router.removeUser(socket.id);
         router.removeConnection(socket);

test/spec/app/socket/router/index.spec.js

@@ -47,6 +47,11 @@ describe('socket.router', () => {
   };
   const MOCK_SOCKET = {
     id: 'socket-id',
+    handshake: {
+      query: {
+        user: { id: 'a', name: 'Bob Smith' }
+      }
+    },
     rooms: ['socket-id'],
     events: {},
     messages: [],
@@ -101,31 +106,26 @@ describe('socket.router', () => {
       });
     });
     it('should have set up the appropriate events on the io router', () => {
-      const EXPECTED_EVENTS = ['register', 'view', 'edit', 'watch'];
+      const EXPECTED_EVENTS = ['view', 'edit', 'watch'];
       EXPECTED_EVENTS.forEach((event) => {
         expect(MOCK_IO_ROUTER.events[event]).to.be.a('function');
       });
     });
   });
 
   describe('iorouter', () => {
-    const MOCK_CONTEXT_REGISTER = {
-      request: {
-        user: { id: 'a', name: 'Bob Smith' }
-      }
-    };
     const MOCK_CONTEXT = {
       request: {
         caseId: '1234567890',
         caseIds: ['2345678901', '3456789012', '4567890123']
       }
     };
     beforeEach(() => {
-      // We need to register before each call as it sets up the user.
-      MOCK_IO_ROUTER.dispatch('register', MOCK_SOCKET, MOCK_CONTEXT_REGISTER, () => {});
+      // Dispatch the connection each time.
+      MOCK_SOCKET_SERVER.dispatch('connection', MOCK_SOCKET);
     });
     it('should appropriately handle registering a user', () => {
-      expect(router.getUser(MOCK_SOCKET.id)).to.deep.equal(MOCK_CONTEXT_REGISTER.request.user);
+      expect(router.getUser(MOCK_SOCKET.id)).to.deep.equal(MOCK_SOCKET.handshake.query.user);
     });
     it('should appropriately handle viewing a case', () => {
       const ACTIVITY = 'view';
@@ -138,7 +138,7 @@ describe('socket.router', () => {
         expect(MOCK_HANDLERS.calls[0].params.socket).to.equal(MOCK_SOCKET);
         expect(MOCK_HANDLERS.calls[0].params.caseId).to.equal(MOCK_CONTEXT.request.caseId);
         // Note that the MOCK_CONTEXT doesn't include the user, which means we had to get it from elsewhere.
-        expect(MOCK_HANDLERS.calls[0].params.user).to.deep.equal(MOCK_CONTEXT_REGISTER.request.user);
+        expect(MOCK_HANDLERS.calls[0].params.user).to.deep.equal(MOCK_SOCKET.handshake.query.user);
         expect(MOCK_HANDLERS.calls[0].params.activity).to.equal(ACTIVITY);
       });
       expect(nextCalled).to.be.true;
@@ -154,7 +154,7 @@ describe('socket.router', () => {
         expect(MOCK_HANDLERS.calls[0].params.socket).to.equal(MOCK_SOCKET);
         expect(MOCK_HANDLERS.calls[0].params.caseId).to.equal(MOCK_CONTEXT.request.caseId);
         // Note that the MOCK_CONTEXT doesn't include the user, which means we had to get it from elsewhere.
-        expect(MOCK_HANDLERS.calls[0].params.user).to.deep.equal(MOCK_CONTEXT_REGISTER.request.user);
+        expect(MOCK_HANDLERS.calls[0].params.user).to.deep.equal(MOCK_SOCKET.handshake.query.user);
         expect(MOCK_HANDLERS.calls[0].params.activity).to.equal(ACTIVITY);
       });
       expect(nextCalled).to.be.true;
@@ -175,15 +175,7 @@ describe('socket.router', () => {
   });
 
   describe('io', () => {
-    const MOCK_CONTEXT_REGISTER = {
-      request: {
-        user: { id: 'a', name: 'Bob Smith' }
-      }
-    };
     beforeEach(() => {
-      // We need to register before each call as it sets up the user.
-      MOCK_IO_ROUTER.dispatch('register', MOCK_SOCKET, MOCK_CONTEXT_REGISTER, () => {});
-
       // Dispatch the connection each time.
       MOCK_SOCKET_SERVER.dispatch('connection', MOCK_SOCKET);
     });