fix: rpc timeout error messages to include caller (#5103)

vitest-dev · Feb 5, 2024 · a6e04bd · a6e04bd
1 parent 2494fbf
commit a6e04bd
Show file tree

Hide file tree

Showing 11 changed files with 37 additions and 11 deletions.
diff --git a/packages/ui/package.json b/packages/ui/package.json
@@ -72,7 +72,7 @@
     "@vitest/ws-client": "workspace:*",
     "@vueuse/core": "^10.6.1",
     "ansi-to-html": "^0.7.2",
-    "birpc": "0.2.14",
+    "birpc": "0.2.15",
     "codemirror": "^5.65.16",
     "codemirror-theme-vars": "^0.1.2",
     "cypress": "^13.6.2",

diff --git a/packages/vitest/package.json b/packages/vitest/package.json
@@ -176,7 +176,7 @@
     "@types/node": "^20.11.5",
     "@types/prompts": "^2.4.9",
     "@types/sinonjs__fake-timers": "^8.1.5",
-    "birpc": "0.2.14",
+    "birpc": "0.2.15",
     "chai-subset": "^1.6.0",
     "cli-truncate": "^4.0.0",
     "expect-type": "^0.17.3",

diff --git a/packages/vitest/src/api/setup.ts b/packages/vitest/src/api/setup.ts
@@ -157,6 +157,9 @@ export function setup(vitestOrWorkspace: Vitest | WorkspaceProject, _server?: Vi
         eventNames: ['onUserConsoleLog', 'onFinished', 'onCollected', 'onCancel'],
         serialize: (data: any) => stringify(data, stringifyReplace),
         deserialize: parse,
+        onTimeoutError(functionName) {
+          throw new Error(`[vitest-api]: Timeout calling "${functionName}"`)
+        },
       },
     )
 

diff --git a/packages/vitest/src/node/pools/forks.ts b/packages/vitest/src/node/pools/forks.ts
@@ -33,6 +33,9 @@ function createChildProcessChannel(project: WorkspaceProject) {
       on(fn) {
         emitter.on(events.response, fn)
       },
+      onTimeoutError(functionName) {
+        throw new Error(`[vitest-pool]: Timeout calling "${functionName}"`)
+      },
     },
   )
 

diff --git a/packages/vitest/src/node/pools/threads.ts b/packages/vitest/src/node/pools/threads.ts
@@ -26,6 +26,9 @@ function createWorkerChannel(project: WorkspaceProject) {
       on(fn) {
         port.on('message', fn)
       },
+      onTimeoutError(functionName) {
+        throw new Error(`[vitest-pool]: Timeout calling "${functionName}"`)
+      },
     },
   )
 

diff --git a/packages/vitest/src/node/pools/vmForks.ts b/packages/vitest/src/node/pools/vmForks.ts
@@ -38,6 +38,9 @@ function createChildProcessChannel(project: WorkspaceProject) {
       on(fn) {
         emitter.on(events.response, fn)
       },
+      onTimeoutError(functionName) {
+        throw new Error(`[vitest-pool]: Timeout calling "${functionName}"`)
+      },
     },
   )
 

diff --git a/packages/vitest/src/node/pools/vmThreads.ts b/packages/vitest/src/node/pools/vmThreads.ts
@@ -30,6 +30,9 @@ function createWorkerChannel(project: WorkspaceProject) {
       on(fn) {
         port.on('message', fn)
       },
+      onTimeoutError(functionName) {
+        throw new Error(`[vitest-pool]: Timeout calling "${functionName}"`)
+      },
     },
   )
 

diff --git a/packages/vitest/src/runtime/rpc.ts b/packages/vitest/src/runtime/rpc.ts
@@ -67,6 +67,14 @@ export function createRuntimeRpc(options: Pick<BirpcOptions<RuntimeRPC>, 'on' |
     },
     {
       eventNames: ['onUserConsoleLog', 'onFinished', 'onCollected', 'onCancel'],
+      onTimeoutError(functionName, args) {
+        let message = `[vitest-worker]: Timeout calling "${functionName}"`
+
+        if (functionName === 'fetch' || functionName === 'transform' || functionName === 'resolveId')
+          message += ` with "${JSON.stringify(args)}"`
+
+        throw new Error(message)
+      },
       ...options,
     },
   ))

diff --git a/packages/ws-client/package.json b/packages/ws-client/package.json
@@ -39,7 +39,7 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "birpc": "0.2.14",
+    "birpc": "0.2.15",
     "flatted": "^3.2.9",
     "ws": "^8.14.2"
   },

diff --git a/packages/ws-client/src/index.ts b/packages/ws-client/src/index.ts
@@ -78,6 +78,9 @@ export function createClient(url: string, options: VitestClientOptions = {}) {
     on: fn => (onMessage = fn),
     serialize: stringify,
     deserialize: parse,
+    onTimeoutError(functionName) {
+      throw new Error(`[vitest-ws-client]: Timeout calling "${functionName}"`)
+    },
   }
 
   ctx.rpc = createBirpc<WebSocketHandlers, WebSocketEvents>(

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml