@jcbuisson/express-x-plugins 4.0.11 → 4.0.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jcbuisson/express-x-plugins",
-  "version": "4.0.11",
+  "version": "4.0.13",
   "description": "Plugins for express-x",
   "type": "module",
   "main": "./src/electric-server-plugin.mjs",

package/src/reload-server-plugin.mjs

@@ -19,11 +19,13 @@ export async function reloadPlugin(app, options = {}) {
    const data = Object.create(null)
    const transferTokens = Object.create(null)
    const transferExpiryTimers = Object.create(null)
+   const consumedSocketIds = new Set()
    roomCache.set(app, rooms)
    dataCache.set(app, data)
 
    app.addDisconnectingListener((socket, reason) => {
       console.log('onSocketDisconnecting', socket.id, reason)
+      if (consumedSocketIds.delete(socket.id)) return
       // save socket data & rooms in caches
       const alreadySavedData = data[socket.id]
       const alreadySavedRooms = rooms[socket.id]
@@ -48,13 +50,14 @@ export async function reloadPlugin(app, options = {}) {
       console.log('onSocketConnect', socket.id)
       const transferToken = randomUUID()
       socket.data.__cnxTransferToken = transferToken
+      transferTokens[socket.id] = transferToken
       socket.emit('cnx-transfer-token', transferToken)
    
       // when client ask for transfer from fromSocketId to toSocketId
       socket.on('cnx-transfer', async (fromSocketId, toSocketId, claimedToken) => {
          app.log('verbose', `cnx-transfer from ${fromSocketId} to ${toSocketId}`)
          // A socket may only claim its own ID as the destination — prevent session hijacking
-         if (toSocketId !== socket.id || typeof claimedToken !== 'string'
+         if (toSocketId !== socket.id || fromSocketId === socket.id || typeof claimedToken !== 'string'
             || transferTokens[fromSocketId] !== claimedToken) {
             app.log('verbose', `cnx-transfer rejected: toSocketId ${toSocketId} !== socket.id ${socket.id}`)
             socket.emit('cnx-transfer-error', fromSocketId, toSocketId)
@@ -62,17 +65,20 @@ export async function reloadPlugin(app, options = {}) {
          }
          // copy connection room & data from 'fromSocketId' to 'toSocketId'
          const toSocket = io.sockets.sockets.get(toSocketId)
-         // data & rooms of fromSocketId are taken from dataCache and roomCache, since socket no longer exists
-         const fromSocketRooms = rooms[fromSocketId]
+         const fromSocket = io.sockets.sockets.get(fromSocketId)
+         // Usually the old socket has disconnected and its state is cached. During a
+         // fast reload it may still be live, so snapshot it directly instead.
+         const fromSocketRooms = rooms[fromSocketId] ?? fromSocket?.rooms
+         const fromSocketData = data[fromSocketId] ?? fromSocket?.data
          if (toSocket && fromSocketRooms) {
             // copy rooms
             for (const room of fromSocketRooms) {
                if (room === fromSocketId) continue // do not include room associated to socket#id
-               toSocket.join(room)
+               await toSocket.join(room)
             }
             // copy data
             toSocket.data = {
-               ...data[fromSocketId],
+               ...fromSocketData,
                ...toSocket.data,
                __cnxTransferToken: transferToken,
             }
@@ -84,6 +90,10 @@ export async function reloadPlugin(app, options = {}) {
             delete transferTokens[fromSocketId]
             clearTimeout(transferExpiryTimers[fromSocketId])
             delete transferExpiryTimers[fromSocketId]
+            if (fromSocket) {
+               consumedSocketIds.add(fromSocketId)
+               fromSocket.disconnect(true)
+            }
             // send acknowlegment to toSocket
             toSocket.emit('cnx-transfer-ack', fromSocketId, toSocketId)
          } else {

package/test/reload-server-plugin.test.mjs

@@ -0,0 +1,71 @@
+import assert from 'node:assert/strict'
+import test from 'node:test'
+
+import { reloadPlugin } from '../src/reload-server-plugin.mjs'
+
+class FakeSocket {
+   constructor(id, sockets, disconnectingListener) {
+      this.id = id
+      this.data = {}
+      this.rooms = new Set([id])
+      this.handlers = new Map()
+      this.emitted = []
+      this.sockets = sockets
+      this.disconnectingListener = disconnectingListener
+      this.joinDelay = Promise.resolve()
+   }
+
+   on(event, handler) { this.handlers.set(event, handler) }
+   emit(event, ...args) { this.emitted.push([event, ...args]) }
+   async join(room) {
+      await this.joinDelay
+      this.rooms.add(room)
+   }
+   disconnect() {
+      this.disconnectingListener(this, 'server namespace disconnect')
+      this.sockets.delete(this.id)
+   }
+}
+
+test('transfers state when the replacement connects before the old socket disconnects', async () => {
+   const sockets = new Map()
+   let connectListener
+   let disconnectingListener
+   const app = {
+      get(key) {
+         if (key === 'io') return { sockets: { sockets } }
+         if (key === 'config') return {}
+      },
+      addConnectListener(listener) { connectListener = listener },
+      addDisconnectingListener(listener) { disconnectingListener = listener },
+      log() {},
+   }
+   await reloadPlugin(app, { authorizeRoomRestore: async () => true })
+
+   const oldSocket = new FakeSocket('old', sockets, (...args) => disconnectingListener(...args))
+   oldSocket.data.user = 'Ada'
+   oldSocket.rooms.add('project:1')
+   sockets.set(oldSocket.id, oldSocket)
+   connectListener(oldSocket)
+   const transferToken = oldSocket.emitted.find(([event]) => event === 'cnx-transfer-token')[1]
+
+   const newSocket = new FakeSocket('new', sockets, (...args) => disconnectingListener(...args))
+   let finishJoin
+   newSocket.joinDelay = new Promise(resolve => { finishJoin = resolve })
+   sockets.set(newSocket.id, newSocket)
+   connectListener(newSocket)
+   const transfer = newSocket.handlers.get('cnx-transfer')('old', 'new', transferToken)
+
+   await Promise.resolve()
+   assert.equal(newSocket.emitted.some(([event]) => event === 'cnx-transfer-ack'), false)
+   finishJoin()
+   await transfer
+
+   assert.equal(newSocket.data.user, 'Ada')
+   assert.equal(newSocket.rooms.has('project:1'), true)
+   assert.equal(sockets.has('old'), false)
+   assert.deepEqual(
+      newSocket.emitted.find(([event]) => event === 'cnx-transfer-ack').slice(1),
+      ['old', 'new'],
+   )
+})