js-rpc2 2.4.2 → 2.5.0

package/doc/websocket.md

@@ -149,7 +149,7 @@ example()
 
 #### createRpcServerWebSocket
 
-创建 WebSocket RPC 服务器。
+创建 WebSocket RPC 服务器，自动绑定 connection 事件。
 
 ```js
 /**
@@ -157,7 +157,7 @@ example()
  * path: string; 
  * wss: WebSocketServer; 
  * rpcKey:string;
- * extension: {asyncLocalStorage:AsyncLocalStorage<IncomingMessage>;}; 
+ * extension: {asyncLocalStorage:AsyncLocalStorage<{ws:WebSocket;request:IncomingMessage;}>;}; 
  * logger?:(msg:string)=>void;
  * }} param
  */
@@ -168,9 +168,55 @@ export function createRpcServerWebSocket(param)
 - `path`: RPC 服务的路径，用于区分不同的服务
 - `wss`: WebSocketServer 实例
 - `rpcKey`: 可选的安全密钥，用于验证客户端连接
-- `extension`: 包含可远程调用函数的对象
+- `extension`: 包含可远程调用函数的对象，可提供 `asyncLocalStorage` 用于存储当前连接上下文（包含 `ws` 和 `request`）
 - `logger`: 可选的日志函数
 
+#### createRpcServerWebSocketOnConnection
+
+创建 WebSocket RPC 连接处理函数，返回一个可用于 `wss.on('connection', handler)` 的处理函数。适用于需要自定义连接绑定逻辑的场景。
+
+```js
+/**
+ * @param {{
+ * path: string; 
+ * wss: WebSocketServer; 
+ * rpcKey:string;
+ * extension: {asyncLocalStorage:AsyncLocalStorage<{ws:WebSocket;request:IncomingMessage;}>;}; 
+ * logger?:(msg:string)=>void;
+ * }} param
+ * @returns {(ws: WebSocket, request: IncomingMessage) => void}
+ */
+export function createRpcServerWebSocketOnConnection(param)
+```
+
+使用示例：
+```js
+import { createServer } from 'http'
+import { WebSocketServer } from 'ws'
+import { createRpcServerWebSocketOnConnection } from 'js-rpc2/src/server.js'
+
+const server = createServer()
+const wss = new WebSocketServer({ server })
+
+// 获取连接处理函数
+const onConnection = createRpcServerWebSocketOnConnection({
+    path: '/rpc',
+    rpcKey: 'secret-key',
+    extension: { /* your API methods */ }
+})
+
+// 自定义绑定方式
+wss.on('connection', (ws, request) => {
+    // 可以在这里添加自定义逻辑
+    console.log('New connection from:', request.socket.remoteAddress)
+    
+    // 调用 RPC 连接处理
+    onConnection(ws, request)
+})
+
+server.listen(9000)
+```
+
 ### 客户端 API
 
 #### createRpcClientWebSocket

package/jsconfig.json

@@ -1,29 +1,40 @@
 {
-  "compilerOptions": {
-    "moduleResolution": "nodenext",
-    "target": "ESNext",
-    "module": "NodeNext",
-    "types": ["node"],
-    "isolatedModules": true,
-    "resolveJsonModule": true,
-    /**
+    "compilerOptions": {
+        "moduleResolution": "nodenext",
+        "target": "ESNext",
+        "module": "NodeNext",
+        "types": [
+            "node"
+        ],
+        "isolatedModules": true,
+        "resolveJsonModule": true,
+        /**
      * To have warnings / errors of the Svelte compiler at the
      * correct position, enable source maps by default.
      */
-    "sourceMap": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    "baseUrl": ".",
-    /**
+        "sourceMap": true,
+        "esModuleInterop": true,
+        "skipLibCheck": true,
+        "forceConsistentCasingInFileNames": true,
+        /**
      * Typecheck JS in `.svelte` and `.js` files by default.
      * Disable this if you'd like to use dynamic types.
      */
-    "checkJs": true
-  },
-  /**
+        "checkJs": true,
+        "strict": true,
+        "strictNullChecks": false,
+        "noImplicitAny": false,
+        "useUnknownInCatchVariables": false,
+    },
+    /**
    * Use global.d.ts instead of compilerOptions.types
    * to avoid limiting type declarations.
    */
-  "include": ["src/**/*.d.ts", "src/**/*.js", "bin/**/*.js", "src/**/*.svelte", "*.js"]
-}
+    "include": [
+        "src/**/*.d.ts",
+        "src/**/*.js",
+        "bin/**/*.js",
+        "src/**/*.svelte",
+        "*.js"
+    ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-rpc2",
-  "version": "2.4.2",
+  "version": "2.5.0",
   "description": "js web websocket http rpc",
   "main": "index.js",
   "type": "module",

package/src/lib.js

@@ -660,7 +660,7 @@ export function createRpcClientHelper(param) {
  * url:string;
  * rpcKey:string;
  * signal:AbortSignal;
- * intercept?:(e:Event)=>void;
+ * intercept?:(e:CloseEvent)=>void;
  * }} param
  */
 export function createRpcClientWebSocket(param) {

package/src/server.js

@@ -4,7 +4,7 @@ import { AsyncLocalStorage } from "node:async_hooks"
 
 /**
  * @import { IncomingMessage } from "node:http"
- * @import {WebSocketServer} from 'ws'
+ * @import {WebSocket, WebSocketServer} from 'ws'
  */
 
 export { createRpcServerHelper }
@@ -14,19 +14,38 @@ export { createRpcServerHelper }
  */
 
 /**
- * @template T
  * @param {{
  * path: string; 
  * wss: WebSocketServer; 
  * rpcKey:string;
- * extension: {asyncLocalStorage:AsyncLocalStorage<IncomingMessage>;}; 
+ * extension: {asyncLocalStorage:AsyncLocalStorage<{ws:WebSocket;request:IncomingMessage;}>;}; 
  * logger?:(msg:string)=>void;
  * }} param
  */
 export function createRpcServerWebSocket(param) {
     let asyncLocalStorage = param.extension.asyncLocalStorage
     if (!asyncLocalStorage) { asyncLocalStorage = new AsyncLocalStorage() }
-    param.wss.on('connection', (ws, request) => {
+    const onconnection = createRpcServerWebSocketOnConnection(param)
+    param.wss.on('connection', onconnection)
+}
+
+/**
+ * @param {{
+ * path: string; 
+ * wss: WebSocketServer; 
+ * rpcKey:string;
+ * extension: {asyncLocalStorage:AsyncLocalStorage<{ws:WebSocket;request:IncomingMessage;}>;}; 
+ * logger?:(msg:string)=>void;
+ * }} param
+ */
+export function createRpcServerWebSocketOnConnection(param) {
+    let asyncLocalStorage = param.extension.asyncLocalStorage
+    if (!asyncLocalStorage) { asyncLocalStorage = new AsyncLocalStorage() }
+    /**
+     * @param {WebSocket} ws
+     * @param {IncomingMessage} request
+     */
+    return function (ws, request) {
         let url = request.url
         if (url != param.path) {
             return
@@ -46,7 +65,7 @@ export function createRpcServerWebSocket(param) {
             if (writer.desiredSize <= 0) {
                 ws.pause()
             }
-            asyncLocalStorage.enterWith(request)
+            asyncLocalStorage.enterWith({ ws, request })
             await writer.write(buffer)
             ws.resume()
         })
@@ -56,7 +75,7 @@ export function createRpcServerWebSocket(param) {
         ws.on('error', (error) => {
             console.error('createRpcServerWebSocket connection ws error', error)
         })
-    })
+    }
 }
 
 /**