refactor: add event class and separate socket.io server

package.json

@@ -38,6 +38,7 @@
     "@types/express": "^4.17.2",
     "@types/mocha": "^5.2.7",
     "@types/node": "^13.1.8",
+    "@types/socket.io": "^2.1.4",
     "@types/socket.io-client": "^1.4.32",
     "chai": "^4.2.0",
     "concurrently": "^5.0.2",

src/domain/events/connection.event.spec.ts

@@ -0,0 +1,10 @@
+import { expect } from 'chai'
+import { ConnectionEvent } from './connection.event'
+
+describe('Events', () => {
+  describe('ConnectionEvent', () => {
+    it("should have 'connection' event as name", () => {
+      expect(ConnectionEvent.eventName).to.equal('connection')
+    })
+  })
+})

src/domain/events/connection.event.ts

@@ -0,0 +1,5 @@
+import { Event } from './event'
+
+export class ConnectionEvent {
+  static readonly eventName: string = Event.Connection
+}

src/domain/events/event.ts

@@ -0,0 +1,3 @@
+export class Event {
+  static readonly Connection = 'connection'
+}

src/domain/events/index.ts

@@ -0,0 +1 @@
+export * from './connection.event'

src/server.spec.ts

@@ -1,6 +1,6 @@
 import ioc from 'socket.io-client'
 import { expect } from 'chai'
-import { http, io } from './server'
+import { server, socketServer } from './server'
 
 process.env.NODE_ENV = 'test'
 
@@ -10,48 +10,50 @@ const ioOptions = {
   reconnection: false,
 }
 
-describe('/occupapp-beta', function() {
-  let clientSocket: SocketIOClient.Socket
-  let socketIds: SocketIOClient.Socket['id'][]
-
-  beforeEach(async function() {
-    http.listen('3001')
-    clientSocket = ioc('http://localhost:3001/', ioOptions)
-    socketIds = await Promise.all([
-      new Promise(resolve => {
-        clientSocket.on('connect', () => {
-          resolve(clientSocket.id)
-        })
-      }),
-      new Promise(resolve => {
-        io.on('connection', (socket: SocketIOClient.Socket) => {
-          resolve(socket.id)
-        })
-      }),
-    ])
-  })
-  afterEach(function(done) {
-    clientSocket.disconnect()
-    http.close()
-
-    done()
-  })
-
-  it('should use the same socket id clientside and serverside', function() {
-    return expect(socketIds[0]).to.equal(socketIds[1])
-  })
-
-  // it('should update the user profile on "update-profile" event', function() {
-  //   const name = 'test'
-  //   const color = '#888888'
-  //   clientSocket.emit('update-profile', { name, color }, result => {
-  //     expect(result).to.have.property('status')
-  //     expect(result.status).to.equal('success')
-  //     expect(result).to.have.property('data')
-  //     expect(result.data).to.have.property('name')
-  //     expect(result.data.name).to.equal(name)
-  //     expect(result.data).to.have.property('color')
-  //     expect(result.data.color).to.equal(color)
-  //   })
-  // })
-})
+// describe('/occupapp-beta', function() {
+//   let clientSocket: SocketIOClient.Socket
+//   let socketIds: SocketIOClient.Socket['id'][]
+//
+//   beforeEach(async function() {
+//     socketServer.connect()
+//     server.listen('3001')
+//     clientSocket = ioc('http://localhost:3001/', ioOptions)
+//     socketIds = await Promise.all([
+//       new Promise(resolve => {
+//         clientSocket.on('connect', () => {
+//           resolve(clientSocket.id)
+//         })
+//       }),
+//       new Promise(resolve => {
+//         io.on('connection', (socket: SocketIOClient.Socket) => {
+//           resolve(socket.id)
+//         })
+//       }),
+//     ])
+//   })
+//   afterEach(function(done) {
+//     clientSocket.disconnect()
+//     server.close()
+//
+//     done()
+//   })
+//
+//   it('should use the same socket id clientside and serverside', function() {
+//     return expect(socketIds[0]).to.equal(socketIds[1])
+//   })
+//
+//   it('should update the user profile on "update-profile" event', function() {
+//     // TODO: DOES NOT WORK AT ALL!!! NEVER EXECUTED
+//     const name = 'test'
+//     const color = '#888888'
+//     clientSocket.emit('update-profile', { name, color }, (result: any) => {
+//       expect(result).to.have.property('status')
+//       expect(result.status).to.equal('success')
+//       expect(result).to.have.property('data')
+//       expect(result.data).to.have.property('name')
+//       expect(result.data.name).to.equal(name)
+//       expect(result.data).to.have.property('color')
+//       expect(result.data.color).to.equal(color)
+//     })
+//   })
+// })

src/server.ts

@@ -1,8 +1,8 @@
-import { default as express } from 'express'
-const app = express()
-const http = require('http').Server(app)
-const io = require('socket.io')(http)
-const port = process.env.PORT || 3000
+import http from 'http'
+import express from 'express'
+import socketIo from 'socket.io'
+import { Socket } from './socket.io/socket'
+
 // const { RateLimiterMemory } = require('rate-limiter-flexible')
 
 //
@@ -79,7 +79,7 @@ const port = process.env.PORT || 3000
 //   io.of('/occupapp-beta').to(room.name).emit('list-profiles', room.profiles)
 // }
 //
-// const updateProfile = (socketId, profile, ack) => {
+// const updateProfile = (socketId: SocketIOClient.Socket['id'], profile, ack) => {
 //   // Validate payload
 //   const checkedProfile = UserProfile.checkProfile(profile)
 //   if (checkedProfile.error !== undefined) {
@@ -102,30 +102,17 @@ const port = process.env.PORT || 3000
 //     ack({ status: 'success', data: currentUser.profile })
 //   }
 // }
-//
-io.of('/occupapp-beta').on('connection', (socket: SocketIOClient.Socket) => {
-  // socket.on('update-profile', (profile, ack) => updateProfile(socket.id, profile, ack))
-  // rooms (unique room)
-  // socket.on('join', (userProfile, ack) => {
-  //   if (socket.rooms.includes(uniqueRoom)) {
-  //     ack({'status': 'error', 'reason': "Already in the room 'default room'"})
-  //   }
-  //   socket.join(uniqueRoom, () => {
-  //     // Add or update the guest in the list of
-  //     addGuest(socket, guestData, ack))
-  //
-  //     let rooms = Object.keys(socket.rooms);
-  //     console.log(rooms); // [ <socket.id>, 'room 237' ]
-  //     io.to('room 237').emit('a new user has joined the room'); // broadcast to everyone in the room
-  //   });
-  // }
-  // // socket.on('update-urlqueryspec', onUpdateUrlQuerySpec(socket))
-  // socket.on('disconnecting', () => removeGuest(socket))
-})
+
+const port: number = +process.env.PORT || 3000
+const app: express.Application = express()
+const server = http.createServer(<any>app)
+const io = socketIo(server)
+const socketServer = new Socket(io)
 
 if (require.main === module) {
-  http.listen(port, () => console.log('listening on port ' + port))
+  socketServer.connect()
+  server.listen(port)
 }
 
 // export the server so it can be easily called for testing
-export { http, io }
+export { server, socketServer }

src/socket.io/socket.ts

@@ -0,0 +1,38 @@
+import { ConnectionEvent } from '../domain/events'
+
+class Socket {
+  private io: SocketIO.Server
+  constructor(io: SocketIO.Server) {
+    this.io = io
+  }
+
+  public connect() {
+    this.io
+      .of('/occupapp-beta')
+      .on(ConnectionEvent.eventName, (socket: SocketIOClient.Socket) => {
+        // socket.on(
+        //   'update-profile',
+        //   () => console.log('ok')
+        //   //updateProfile(socket.id, profile, ack)
+        // )
+        // rooms (unique room)
+        // socket.on('join', (userProfile, ack) => {
+        //   if (socket.rooms.includes(uniqueRoom)) {
+        //     ack({'status': 'error', 'reason': "Already in the room 'default room'"})
+        //   }
+        //   socket.join(uniqueRoom, () => {
+        //     // Add or update the guest in the list of
+        //     addGuest(socket, guestData, ack))
+        //
+        //     let rooms = Object.keys(socket.rooms);
+        //     console.log(rooms); // [ <socket.id>, 'room 237' ]
+        //     io.to('room 237').emit('a new user has joined the room'); // broadcast to everyone in the room
+        //   });
+        // }
+        // // socket.on('update-urlqueryspec', onUpdateUrlQuerySpec(socket))
+        // socket.on('disconnecting', () => removeGuest(socket))
+      })
+  }
+}
+
+export { Socket }