@fluojs/websockets 1.0.0-beta.3 → 1.0.0-beta.5

package/dist/deno/deno-service.js

@@ -11,6 +11,7 @@ import { WEBSOCKET_OPTIONS_INTERNAL } from '../options-token.internal.js';
 const DEFAULT_MAX_PENDING_MESSAGES_PER_SOCKET = 256;
 const DEFAULT_MAX_WEBSOCKET_CONNECTIONS = 1_000;
 const DEFAULT_MAX_WEBSOCKET_PAYLOAD_BYTES = 1_048_576;
+const DEFAULT_WEBSOCKET_SHUTDOWN_TIMEOUT_MS = 5_000;
 const LIFECYCLE_LOG_CONTEXT = 'WebSocketGatewayLifecycleService';
 const WEBSOCKET_OPEN_READY_STATE = 1;
 function hasDenoWebSocketBindingHost(adapter) {
@@ -41,6 +42,16 @@ function resolveMessageByteLength(message) {
   }
   return message.size;
 }
+function createCompletionSignal() {
+  let resolve;
+  const promise = new Promise(res => {
+    resolve = res;
+  });
+  return {
+    promise,
+    resolve
+  };
+}
 
 /**
  * Boots Deno-backed websocket gateways and manages their room lifecycle state.
@@ -50,11 +61,14 @@ class DenoWebSocketGatewayLifecycleService {
   static {
     [_DenoWebSocketGateway, _initClass] = _applyDecs(this, [Inject(RUNTIME_CONTAINER, COMPILED_MODULES, APPLICATION_LOGGER, HTTP_APPLICATION_ADAPTER, WEBSOCKET_OPTIONS_INTERNAL)], []).c;
   }
+  isShuttingDown = false;
+  pendingUpgradeOperations = new Set();
   pendingUpgradeReservations = 0;
   roomSockets = new Map();
   shutdownPromise;
   socketRegistry = new Map();
   socketRooms = new Map();
+  socketStates = new Map();
   constructor(runtimeContainer, compiledModules, logger, adapter, moduleOptions) {
     this.runtimeContainer = runtimeContainer;
     this.compiledModules = compiledModules;
@@ -90,53 +104,60 @@ class DenoWebSocketGatewayLifecycleService {
   createBinding(descriptors) {
     const descriptorsByPath = this.groupDescriptorsByPath(descriptors);
     return {
-      fetch: async (request, host) => {
-        if (!isWebSocketUpgradeRequest(request)) {
-          return new Response(null, {
-            status: 426
-          });
-        }
-        let targetPath;
-        try {
-          targetPath = normalizeGatewayPath(new URL(request.url).pathname);
-        } catch {
-          return new Response(null, {
-            status: 400
-          });
-        }
-        const descriptors = descriptorsByPath.get(targetPath);
-        if (!descriptors) {
-          return new Response(null, {
-            status: 404
-          });
-        }
-        const rejection = await this.resolveUpgradeRejection(request, targetPath);
-        if (rejection) {
-          return new Response(rejection.body ?? null, {
-            headers: rejection.headers,
-            status: rejection.status
-          });
-        }
-        let response;
-        let socket;
-        try {
-          ({
-            response,
-            socket
-          } = host.upgrade(request));
-        } catch (error) {
-          this.releaseUpgradeReservation();
-          throw error;
-        }
-        void this.bindConnectionHandlers(socket, request, descriptors).catch(error => {
-          this.unregisterSocket(this.findSocketId(socket));
-          this.logger.error('WebSocket gateway open lifecycle failed.', error, LIFECYCLE_LOG_CONTEXT);
-          socket.close(1011, 'Internal server error');
-        });
-        return response;
-      }
+      fetch: (request, host) => this.trackPendingUpgradeOperation(this.handleUpgradeRequest(request, host, descriptorsByPath))
     };
   }
+  async handleUpgradeRequest(request, host, descriptorsByPath) {
+    if (!isWebSocketUpgradeRequest(request)) {
+      return new Response(null, {
+        status: 426
+      });
+    }
+    let targetPath;
+    try {
+      targetPath = normalizeGatewayPath(new URL(request.url).pathname);
+    } catch {
+      return new Response(null, {
+        status: 400
+      });
+    }
+    const descriptors = descriptorsByPath.get(targetPath);
+    if (!descriptors) {
+      return new Response(null, {
+        status: 404
+      });
+    }
+    const rejection = await this.resolveUpgradeRejection(request, targetPath);
+    if (rejection) {
+      return new Response(rejection.body ?? null, {
+        headers: rejection.headers,
+        status: rejection.status
+      });
+    }
+    if (this.isShuttingDown) {
+      this.releaseUpgradeReservation();
+      return new Response('WebSocket server is shutting down.', {
+        status: 503
+      });
+    }
+    let response;
+    let socket;
+    try {
+      ({
+        response,
+        socket
+      } = host.upgrade(request));
+    } catch (error) {
+      this.releaseUpgradeReservation();
+      throw error;
+    }
+    void this.trackPendingUpgradeOperation(this.bindConnectionHandlers(socket, request, descriptors)).catch(error => {
+      this.unregisterSocket(this.findSocketId(socket));
+      this.logger.error('WebSocket gateway open lifecycle failed.', error, LIFECYCLE_LOG_CONTEXT);
+      socket.close(1011, 'Internal server error');
+    });
+    return response;
+  }
   groupDescriptorsByPath(descriptors) {
     const descriptorsByPath = new Map();
     for (const descriptor of descriptors) {
@@ -153,17 +174,35 @@ class DenoWebSocketGatewayLifecycleService {
     const state = this.createConnectionHandlerState(request, descriptors);
     this.releaseUpgradeReservation();
     this.socketRegistry.set(state.socketId, socket);
+    this.socketStates.set(state.socketId, state);
     this.attachConnectionListeners(state, socket, request);
-    await this.resolveConnectionGateways(state);
-    await this.runConnectHandlers(state, socket);
-    await this.finalizeConnectionBinding(state, socket, request);
+    try {
+      await this.resolveConnectionGateways(state);
+      await this.runConnectHandlers(state, socket);
+      await this.finalizeConnectionBinding(state, socket, request);
+      if (this.isShuttingDown && socket.readyState === WEBSOCKET_OPEN_READY_STATE) {
+        socket.close(1001, 'Server shutting down');
+        await state.disconnectLifecyclePromise;
+      }
+    } finally {
+      if (!state.handlersReady && state.bufferedDisconnect) {
+        this.settleDisconnectLifecycle(state);
+      }
+      this.settleConnectLifecycle(state);
+    }
   }
   createConnectionHandlerState(request, descriptors) {
+    const connectLifecycle = createCompletionSignal();
+    const disconnectLifecycle = createCompletionSignal();
     return {
       bufferedDisconnect: undefined,
       bufferedMessages: [],
       bufferedMessagesStartIndex: 0,
+      connectLifecycleSettled: false,
+      connectLifecyclePromise: connectLifecycle.promise,
       descriptors,
+      disconnectLifecycleSettled: false,
+      disconnectLifecyclePromise: disconnectLifecycle.promise,
       enqueuedMessageCount: 0,
       handlerQueue: Promise.resolve(),
       handlersReady: false,
@@ -171,10 +210,26 @@ class DenoWebSocketGatewayLifecycleService {
       queuedMessages: [],
       queuedMessagesStartIndex: 0,
       request,
+      resolveConnectLifecycle: connectLifecycle.resolve,
+      resolveDisconnectLifecycle: disconnectLifecycle.resolve,
       resolved: [],
       socketId: crypto.randomUUID()
     };
   }
+  settleConnectLifecycle(state) {
+    if (state.connectLifecycleSettled) {
+      return;
+    }
+    state.connectLifecycleSettled = true;
+    state.resolveConnectLifecycle();
+  }
+  settleDisconnectLifecycle(state) {
+    if (state.disconnectLifecycleSettled) {
+      return;
+    }
+    state.disconnectLifecycleSettled = true;
+    state.resolveDisconnectLifecycle();
+  }
   attachConnectionListeners(state, socket, request) {
     socket.addEventListener('message', event => {
       if (this.closeOversizedPayload(state.socketId, socket, event.data)) {
@@ -311,6 +366,8 @@ class DenoWebSocketGatewayLifecycleService {
       await dispatchGatewayDisconnect(state.resolved, socket, disconnectEvent.code, disconnectEvent.reason, state.socketId, this.logger, LIFECYCLE_LOG_CONTEXT);
     }).catch(error => {
       this.logger.error('WebSocket gateway disconnect dispatch failed.', error, LIFECYCLE_LOG_CONTEXT);
+    }).finally(() => {
+      this.settleDisconnectLifecycle(state);
     });
   }
   async resolveConnectionGateways(state) {
@@ -361,6 +418,12 @@ class DenoWebSocketGatewayLifecycleService {
     return '';
   }
   async resolveUpgradeRejection(request, path) {
+    if (this.isShuttingDown) {
+      return {
+        body: 'WebSocket server is shutting down.',
+        status: 503
+      };
+    }
     if (!this.tryReserveUpgradeSlot()) {
       return {
         body: 'WebSocket connection limit exceeded.',
@@ -437,6 +500,13 @@ class DenoWebSocketGatewayLifecycleService {
     }
     return configured;
   }
+  resolveShutdownTimeoutMs() {
+    const configured = this.moduleOptions.shutdown?.timeoutMs;
+    if (typeof configured !== 'number' || !Number.isFinite(configured) || configured <= 0) {
+      return DEFAULT_WEBSOCKET_SHUTDOWN_TIMEOUT_MS;
+    }
+    return Math.floor(configured);
+  }
   async shutdown() {
     if (this.shutdownPromise) {
       await this.shutdownPromise;
@@ -446,14 +516,112 @@ class DenoWebSocketGatewayLifecycleService {
     await this.shutdownPromise;
   }
   async runShutdownLifecycle() {
+    this.isShuttingDown = true;
     if (hasDenoWebSocketBindingHost(this.adapter)) {
       this.adapter.configureWebSocketBinding(undefined);
     }
+    const shutdownTimeoutMs = this.resolveShutdownTimeoutMs();
+    await this.awaitPendingUpgradeOperations(shutdownTimeoutMs);
+    await this.closeActiveSockets(shutdownTimeoutMs);
     this.pendingUpgradeReservations = 0;
     this.socketRegistry.clear();
     this.socketRooms.clear();
+    this.socketStates.clear();
     this.roomSockets.clear();
   }
+  trackPendingUpgradeOperation(operation) {
+    if (typeof operation === 'function') {
+      return (...args) => this.trackPendingUpgradeOperation(operation(...args));
+    }
+    let trackedOperation;
+    trackedOperation = operation.then(() => undefined, () => undefined).finally(() => {
+      if (trackedOperation) {
+        this.pendingUpgradeOperations.delete(trackedOperation);
+      }
+    });
+    this.pendingUpgradeOperations.add(trackedOperation);
+    return operation;
+  }
+  async awaitPendingUpgradeOperations(timeoutMs) {
+    if (this.pendingUpgradeOperations.size === 0) {
+      return;
+    }
+    await new Promise((resolve, reject) => {
+      let settled = false;
+      const timeout = setTimeout(() => {
+        if (settled) {
+          return;
+        }
+        settled = true;
+        reject(new Error(`Timed out while waiting for in-flight Deno websocket upgrades after ${String(timeoutMs)}ms.`));
+      }, timeoutMs);
+      Promise.all([...this.pendingUpgradeOperations]).then(() => {
+        if (settled) {
+          return;
+        }
+        settled = true;
+        clearTimeout(timeout);
+        resolve();
+      }).catch(error => {
+        if (settled) {
+          return;
+        }
+        settled = true;
+        clearTimeout(timeout);
+        reject(error);
+      });
+    }).catch(error => {
+      this.logger.error(`Failed to wait for in-flight Deno websocket upgrades within ${String(timeoutMs)}ms.`, error, LIFECYCLE_LOG_CONTEXT);
+    });
+  }
+  async closeActiveSockets(timeoutMs) {
+    const activeSockets = [...this.socketRegistry.entries()];
+    if (activeSockets.length === 0) {
+      return;
+    }
+    const activeStates = activeSockets.map(([socketId]) => this.socketStates.get(socketId)).filter(state => state !== undefined);
+    for (const [, socket] of activeSockets) {
+      if (socket.readyState === WEBSOCKET_OPEN_READY_STATE) {
+        socket.close(1001, 'Server shutting down');
+      }
+    }
+    await this.awaitHandlerQueueDrain(activeStates, timeoutMs);
+  }
+  async awaitHandlerQueueDrain(states, timeoutMs) {
+    if (states.length === 0) {
+      return;
+    }
+    await new Promise((resolve, reject) => {
+      let settled = false;
+      const timeout = setTimeout(() => {
+        if (settled) {
+          return;
+        }
+        settled = true;
+        reject(new Error(`Timed out while closing Deno websocket connections after ${String(timeoutMs)}ms.`));
+      }, timeoutMs);
+      Promise.all(states.map(async state => {
+        await state.connectLifecyclePromise;
+        await state.disconnectLifecyclePromise;
+      })).then(() => {
+        if (settled) {
+          return;
+        }
+        settled = true;
+        clearTimeout(timeout);
+        resolve();
+      }).catch(error => {
+        if (settled) {
+          return;
+        }
+        settled = true;
+        clearTimeout(timeout);
+        reject(error);
+      });
+    }).catch(error => {
+      this.logger.error(`Failed to close Deno websocket connections within ${String(timeoutMs)}ms.`, error, LIFECYCLE_LOG_CONTEXT);
+    });
+  }
   joinRoom(socketId, room) {
     let rooms = this.socketRooms.get(socketId);
     if (!rooms) {
@@ -514,6 +682,7 @@ class DenoWebSocketGatewayLifecycleService {
       return;
     }
     this.socketRegistry.delete(socketId);
+    this.socketStates.delete(socketId);
     const rooms = this.socketRooms.get(socketId);
     if (rooms) {
       for (const room of rooms) {

package/package.json

@@ -9,7 +9,7 @@
     "realtime",
     "upgrade"
   ],
-  "version": "1.0.0-beta.3",
+  "version": "1.0.0-beta.5",
   "private": false,
   "license": "MIT",
   "repository": {
@@ -69,17 +69,17 @@
   ],
   "dependencies": {
     "ws": "^8.18.3",
-    "@fluojs/di": "^1.0.0-beta.4",
-    "@fluojs/core": "^1.0.0-beta.2",
-    "@fluojs/http": "^1.0.0-beta.3",
-    "@fluojs/runtime": "^1.0.0-beta.4"
+    "@fluojs/core": "^1.0.0-beta.4",
+    "@fluojs/di": "^1.0.0-beta.6",
+    "@fluojs/http": "^1.0.0-beta.10",
+    "@fluojs/runtime": "^1.0.0-beta.11"
   },
   "devDependencies": {
     "@types/ws": "^8.18.1",
     "vitest": "^3.2.4",
-    "@fluojs/platform-bun": "^1.0.0-beta.3",
-    "@fluojs/platform-express": "^1.0.0-beta.3",
-    "@fluojs/platform-fastify": "^1.0.0-beta.4"
+    "@fluojs/platform-bun": "^1.0.0-beta.6",
+    "@fluojs/platform-express": "^1.0.0-beta.6",
+    "@fluojs/platform-fastify": "^1.0.0-beta.8"
   },
   "scripts": {
     "prebuild": "node ../../tooling/scripts/clean-dist.mjs",