next-ws 0.0.0-beta-20250823112013 → 0.0.0-beta-20250824084203

package/dist/cli.cjs

@@ -27,7 +27,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var import_minimist = __toESM(require("minimist"));
 
 // package.json
-var version = "0.0.0-beta-20250823112013";
+var version = "0.0.0-beta-20250824084203";
 
 // src/commands/helpers/define.ts
 function defineCommandGroup(definition) {
@@ -757,14 +757,78 @@ var patchRouterServer = definePatchStep({
     }).toSource();
   }
 });
+var patchHeaders = definePatchStep({
+  title: "Add WebSocket contextual headers resolution to request headers",
+  path: "next:dist/client/components/headers.js",
+  async transform(code) {
+    const marker = "@patch headers";
+    const snippet = (0, import_jscodeshift.default)(`
+      // ${marker}
+      const kRequestStorage = Symbol.for('next-ws.request-store');
+      const requestStorage = Reflect.get(globalThis, kRequestStorage);
+      const contextualHeaders = requestStorage?.getStore()?.headers;
+      if (contextualHeaders) return contextualHeaders;
+    `);
+    const block = import_jscodeshift.default.blockStatement(snippet.nodes()[0].program.body);
+    return (0, import_jscodeshift.default)(code).find(import_jscodeshift.default.FunctionDeclaration, { id: { name: "headers" } }).forEach(({ node }) => {
+      const body = node.body.body;
+      const existing = (0, import_jscodeshift.default)(body).find(CommentLine, { value: ` ${marker}` }).paths()[0];
+      const idx = body.indexOf(existing?.parent.node);
+      if (existing && idx > -1) body[idx] = block;
+      else body.unshift(block);
+    }).toSource();
+  }
+});
+var patchCookies = definePatchStep({
+  title: "Add WebSocket contextual cookies resolution to request cookies",
+  path: "next:dist/client/components/headers.js",
+  async transform(code) {
+    const marker = "@patch cookies";
+    const snippet = (0, import_jscodeshift.default)(`
+      // ${marker}
+      const kRequestStorage = Symbol.for('next-ws.request-store');
+      const requestStorage = Reflect.get(globalThis, kRequestStorage);
+      const contextualCookies = requestStorage?.getStore()?.cookies;
+      if (contextualCookies) return contextualCookies;
+    `);
+    const block = import_jscodeshift.default.blockStatement(snippet.nodes()[0].program.body);
+    return (0, import_jscodeshift.default)(code).find(import_jscodeshift.default.FunctionDeclaration, { id: { name: "cookies" } }).forEach(({ node }) => {
+      const body = node.body.body;
+      const existing = (0, import_jscodeshift.default)(body).find(CommentLine, { value: ` ${marker}` }).paths()[0];
+      const idx = body.indexOf(existing?.parent.node);
+      if (existing && idx > -1) body[idx] = block;
+      else body.unshift(block);
+    }).toSource();
+  }
+});
 var patch_1_default = definePatch({
   name: "patch-1",
-  versions: ">=13.5.1 <=15.5.0",
-  steps: [patchNextNodeServer, patchRouterServer]
+  versions: ">=13.5.1 <=14.2.32",
+  steps: [patchNextNodeServer, patchRouterServer, patchHeaders, patchCookies]
+});
+
+// src/patches/patch-2.ts
+var patchHeaders2 = definePatchStep({
+  ...patchHeaders,
+  path: "next:dist/server/request/headers.js"
+});
+var patchCookies2 = definePatchStep({
+  ...patchCookies,
+  path: "next:dist/server/request/cookies.js"
+});
+var patch_2_default = definePatch({
+  name: "patch-2",
+  versions: ">=15.0.0 <=15.5.0",
+  steps: [
+    patchNextNodeServer,
+    patchRouterServer,
+    patchHeaders2,
+    patchCookies2
+  ]
 });
 
 // src/patches/index.ts
-var patches_default = [patch_1_default];
+var patches_default = [patch_1_default, patch_2_default];
 
 // src/commands/helpers/semver.ts
 var import_range = __toESM(require("semver/classes/range.js"));

package/dist/server/index.cjs

@@ -39,66 +39,43 @@ __export(server_exports, {
 module.exports = __toCommonJS(server_exports);
 
 // src/server/persistent.ts
-var logger = __toESM(require("next/dist/build/output/log.js"));
-function getEnvironmentMeta() {
-  const isCustomServer = !process.title.startsWith("next-");
-  const isMainProcess = process.env.NEXT_WS_MAIN_PROCESS === "1";
-  const isDevelopment = process.env.NODE_ENV === "development";
-  return { isCustomServer, isMainProcess, isDevelopment };
-}
-function mainProcessOnly(callerName) {
-  if (process.env.NEXT_WS_SKIP_ENVIRONMENT_CHECK === "1") return;
-  const meta = getEnvironmentMeta();
-  if (!meta.isCustomServer && !meta.isMainProcess) {
-    throw new Error(
-      `[next-ws] Attempt to call '${callerName}' outside the main process.
-You may be attempting to interact with the WebSocket server outside of an UPGRADE handler. This will fail in production, as Next.js employs a worker process for routing, which do not have access to the WebSocket server on the main process.
-You can resolve this by using a custom server.`
-    );
-  } else if (!meta.isCustomServer) {
-    logger.warnOnce(
-      `[next-ws] The function '${callerName}' was called without a custom server.
-This could lead to unintended behaviour, especially if you're attempting to interact with the WebSocket server outside of an UPGRADE handler.
-Please note, while such configurations might function during development, they will fail in production. This is because Next.js employs a worker process for routing in production, which do not have access to the WebSocket server on the main process.
-You can resolve this by using a custom server.`
-    );
-  }
-}
-var kHttpServer = Symbol.for("kHttpServer");
-function getHttpServer() {
-  mainProcessOnly("getHttpServer");
-  return Reflect.get(globalThis, kHttpServer);
-}
-function setHttpServer(server) {
-  mainProcessOnly("setHttpServer");
-  Reflect.set(globalThis, kHttpServer, server);
-  return getHttpServer();
-}
-function useHttpServer(server) {
-  mainProcessOnly("useHttpServer");
-  const existing = getHttpServer();
-  if (existing) return existing;
-  return setHttpServer(server());
-}
-var kWebSocketServer = Symbol.for("kWebSocketServer");
-function getWebSocketServer() {
-  mainProcessOnly("getWebSocketServer");
-  return Reflect.get(globalThis, kWebSocketServer);
-}
-function setWebSocketServer(server) {
-  mainProcessOnly("setWebSocketServer");
-  Reflect.set(globalThis, kWebSocketServer, server);
-  return getWebSocketServer();
-}
-function useWebSocketServer(server) {
-  mainProcessOnly("useWebSocketServer");
-  const existing = getWebSocketServer();
-  if (existing) return existing;
-  return setWebSocketServer(server());
+function useGlobal(key) {
+  return [
+    function get() {
+      return Reflect.get(globalThis, key);
+    },
+    function set(value) {
+      return Reflect.set(globalThis, key, value);
+    },
+    function use(getter) {
+      const existing = Reflect.get(globalThis, key);
+      if (existing) return existing;
+      Reflect.set(globalThis, key, getter());
+      return Reflect.get(globalThis, key);
+    }
+  ];
 }
+var [getHttpServer, setHttpServer, useHttpServer] = (
+  //
+  useGlobal(
+    Symbol.for("next-ws.http-server")
+    //
+  )
+);
+var [getWebSocketServer, setWebSocketServer, useWebSocketServer] = useGlobal(
+  Symbol.for("next-ws.websocket-server")
+);
+var [getRequestStorage, setRequestStorage, useRequestStorage] = (
+  //
+  useGlobal(
+    Symbol.for("next-ws.request-store")
+    //
+  )
+);
 
 // src/server/setup.ts
-var logger3 = __toESM(require("next/dist/build/output/log.js"));
+var import_node_async_hooks2 = require("async_hooks");
+var logger2 = __toESM(require("next/dist/build/output/log.js"));
 var import_ws = require("ws");
 
 // src/server/helpers/match.ts
@@ -142,7 +119,7 @@ function findMatchingRoute(nextServer, requestPathname) {
 }
 
 // src/server/helpers/module.ts
-var logger2 = __toESM(require("next/dist/build/output/log.js"));
+var logger = __toESM(require("next/dist/build/output/log.js"));
 async function importRouteModule(nextServer, filePath) {
   try {
     if ("hotReloader" in nextServer) {
@@ -153,7 +130,7 @@ async function importRouteModule(nextServer, filePath) {
     } else if ("ensurePage" in nextServer) {
       await nextServer.ensurePage({ page: filePath, clientOnly: false });
     } else {
-      logger2.warnOnce(
+      logger.warnOnce(
         "[next-ws] unable to ensure page, you may need to open the route in your browser first so Next.js compiles it"
       );
     }
@@ -185,26 +162,55 @@ function toNextRequest(message) {
   });
 }
 
+// src/server/helpers/store.ts
+var import_node_async_hooks = require("async_hooks");
+var import_cookies = require("next/dist/compiled/@edge-runtime/cookies");
+var ReadonlyHeaders = class extends Headers {
+  append() {
+    throw new Error("Headers are read-only");
+  }
+  set() {
+    throw new Error("Headers are read-only");
+  }
+  delete() {
+    throw new Error("Headers are read-only");
+  }
+};
+var ReadonlyRequestsCookies = class extends import_cookies.RequestCookies {
+  set() {
+    throw new Error("Cookies are read-only");
+  }
+  delete() {
+    throw new Error("Cookies are read-only");
+  }
+};
+function createRequestStore(request) {
+  return {
+    headers: new ReadonlyHeaders(request.headers),
+    cookies: new ReadonlyRequestsCookies(request.headers)
+  };
+}
+var requestStorage = new import_node_async_hooks.AsyncLocalStorage();
+
 // src/server/setup.ts
 function setupWebSocketServer(nextServer) {
-  process.env.NEXT_WS_MAIN_PROCESS = String(1);
-  process.env.NEXT_WS_SKIP_ENVIRONMENT_CHECK = String(1);
   const httpServer = (
     //
     // @ts-expect-error - serverOptions is protected
     useHttpServer(() => nextServer.serverOptions?.httpServer)
   );
   if (!httpServer)
-    return logger3.error("[next-ws] was not able to find the HTTP server");
+    return logger2.error("[next-ws] was not able to find the HTTP server");
   const wsServer = (
     //
     useWebSocketServer(() => new import_ws.WebSocketServer({ noServer: true }))
   );
-  if (!wsServer)
-    return logger3.error("[next-ws] was not able to find the WebSocket server");
-  process.env.NEXT_WS_SKIP_ENVIRONMENT_CHECK = String(0);
-  logger3.ready("[next-ws] has started the WebSocket server");
-  const kInstalled = Symbol.for("kInstalled");
+  const requestStorage2 = (
+    //
+    useRequestStorage(() => new import_node_async_hooks2.AsyncLocalStorage())
+  );
+  logger2.ready("[next-ws] has started the WebSocket server");
+  const kInstalled = Symbol.for("next-ws.http-server.attached");
   if (Reflect.has(httpServer, kInstalled)) return;
   Reflect.set(httpServer, kInstalled, true);
   httpServer.on("upgrade", async (message, socket, head) => {
@@ -213,30 +219,34 @@ function setupWebSocketServer(nextServer) {
     if (pathname.includes("/_next")) return;
     const route = findMatchingRoute(nextServer, pathname);
     if (!route) {
-      logger3.error(`[next-ws] could not find route for page ${pathname}`);
+      logger2.error(`[next-ws] could not find route for page ${pathname}`);
       return socket.end();
     }
     const module2 = await importRouteModule(nextServer, route.filename);
     if (!module2) {
-      logger3.error(`[next-ws] could not import module for page ${pathname}`);
+      logger2.error(`[next-ws] could not import module for page ${pathname}`);
       return socket.end();
     }
     const handleUpgrade = module2.userland.UPGRADE;
     const handleSocket = module2.userland.SOCKET;
     if ((!handleUpgrade || typeof handleUpgrade !== "function") && (!handleSocket || typeof handleSocket !== "function")) {
-      logger3.error(`[next-ws] route '${pathname}' does not export a handler`);
+      logger2.error(`[next-ws] route '${pathname}' does not export a handler`);
       return socket.end();
     }
     if (handleSocket)
-      logger3.warnOnce(
-        "DeprecationWarning: [next-ws] SOCKET is deprecated, use UPGRADE instead, see https://github.com/apteryxxyz/next-ws#-usage"
+      logger2.warnOnce(
+        "DeprecationWarning: [next-ws] SOCKET is deprecated, prefer UPGRADE instead, see https://github.com/apteryxxyz/next-ws#-usage"
       );
     wsServer.handleUpgrade(message, socket, head, async (client) => {
       wsServer.emit("connection", client, message);
       try {
         const context = { params: route.params };
         if (handleUpgrade) {
-          await handleUpgrade(client, wsServer, request, context);
+          await requestStorage2.run(
+            createRequestStore(request),
+            //
+            () => handleUpgrade(client, wsServer, request, context)
+          );
         } else if (handleSocket) {
           const handleClose = (
             //
@@ -246,7 +256,7 @@ function setupWebSocketServer(nextServer) {
             client.once("close", () => handleClose());
         }
       } catch (cause) {
-        logger3.error(
+        logger2.error(
           `[next-ws] error in socket handler for '${pathname}'`,
           cause
         );

package/dist/server/index.d.ts

@@ -1,8 +1,6 @@
 import * as next_server from 'next/server';
 import * as http from 'http';
 import * as ws from 'ws';
-import { WebSocketServer } from 'ws';
-import { Server } from 'node:http';
 import NextNodeServer from 'next/dist/server/next-server.js';
 
 /** @deprecated Prefer UPGRADE and {@link UpgradeHandler} */
@@ -22,10 +20,10 @@ type RouteContext<Path extends string> = {
     params: Record<string, string | string[] | undefined> & RouteParams<Path> & RouteParams<Path>;
 };
 
-declare function getHttpServer(): Server | undefined;
-declare function setHttpServer<T extends Server | undefined>(server: T): T;
-declare function getWebSocketServer(): WebSocketServer | undefined;
-declare function setWebSocketServer<T extends WebSocketServer | undefined>(server: T): T;
+declare const getHttpServer: () => http.Server<typeof http.IncomingMessage, typeof http.ServerResponse> | undefined;
+declare const setHttpServer: (value: http.Server<typeof http.IncomingMessage, typeof http.ServerResponse>) => boolean;
+declare const getWebSocketServer: () => ws.WebSocketServer | undefined;
+declare const setWebSocketServer: (value: ws.WebSocketServer) => boolean;
 
 declare function setupWebSocketServer(nextServer: NextNodeServer): void;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-ws",
-  "version": "0.0.0-beta-20250823112013",
+  "version": "0.0.0-beta-20250824084203",
   "description": "Add support for WebSockets in the Next.js app directory",
   "license": "MIT",
   "keywords": [