feat: safeDeserialize, safeSerialize

Author: yqrashawn

packages/trpc-webext/package.json

@@ -38,7 +38,7 @@
     "build": "tsc",
     "lint": "eslint src",
     "format": "prettier --write .",
-    "test": "vitest",
+    "test": "vitest run",
     "test:watch": "vitest --watch"
   },
   "peerDependencies": {

packages/trpc-webext/src/adapter/index.test.ts

@@ -1,16 +1,18 @@
+import { initTRPC, TRPCError } from '@trpc/server'
+import { observable } from '@trpc/server/observable'
 import {
+  afterEach,
+  beforeEach,
   describe,
-  it,
   expect,
-  vi,
-  beforeEach,
-  afterEach,
+  it,
   type Mock,
+  vi,
 } from 'vitest'
-import { initTRPC, TRPCError } from '@trpc/server'
-import { observable } from '@trpc/server/observable'
 import { z } from 'zod'
+
 import { createWebExtHandler } from './'
+
 import type { Runtime } from 'webextension-polyfill'
 
 // Mock runtime

packages/trpc-webext/src/adapter/index.ts

@@ -6,6 +6,8 @@ import {
   TRPCError,
 } from '@trpc/server/unstable-core-do-not-import'
 
+import { safeDeserialize, safeSerialize } from '../utils'
+
 import type { Unsubscribable } from '@trpc/server/observable'
 import type {
   AnyRouter,
@@ -172,7 +174,7 @@ async function handleRegularProcedure<TRouter extends AnyRouter>(
     })
   }
 
-  const input = context.transformer.input.deserialize(trpc.params.input)
+  const input = safeDeserialize(context.transformer.input, trpc.params.input)
   const ctx = await context.createContext?.({
     req: port,
     res: undefined,
@@ -187,7 +189,7 @@ async function handleRegularProcedure<TRouter extends AnyRouter>(
     signal: undefined,
   })
 
-  const serializedData = context.transformer.output.serialize(result)
+  const serializedData = safeSerialize(context.transformer.output, result)
   sendResponse({
     result: {
       type: 'data',
@@ -211,7 +213,7 @@ async function handleSubscription<TRouter extends AnyRouter>(
     })
   }
 
-  const input = context.transformer.input.deserialize(trpc.params.input)
+  const input = safeDeserialize(context.transformer.input, trpc.params.input)
   const ctx = await context.createContext?.({
     req: port,
     res: undefined,

packages/trpc-webext/src/link/index.test.ts

@@ -1,16 +1,18 @@
+import { TRPCClientError } from '@trpc/client'
 import {
+  afterEach,
+  beforeEach,
   describe,
-  it,
   expect,
-  vi,
-  beforeEach,
-  afterEach,
+  it,
   type Mock,
+  vi,
 } from 'vitest'
-import { TRPCClientError } from '@trpc/client'
+
 import { webExtensionLink } from './'
+
+import type { Operation, TRPCClientRuntime } from '@trpc/client'
 import type { Runtime } from 'webextension-polyfill'
-import type { Operation } from '@trpc/client'
 
 // Mock runtime
 const mockRuntime = {
@@ -147,7 +149,7 @@ describe('webExtensionLink', () => {
         runtime: mockRuntime,
         transformer: mockTransformer,
       })
-      operationLink = link()
+      operationLink = link({} as TRPCClientRuntime)
     })
 
     it('should serialize input before sending', () => {
@@ -253,7 +255,7 @@ describe('webExtensionLink', () => {
         runtime: mockRuntime,
         transformer: mockTransformer,
       })
-      operationLink = link()
+      operationLink = link({} as TRPCClientRuntime)
     })
 
     it('should ignore non-tRPC messages', () => {
@@ -525,7 +527,7 @@ describe('webExtensionLink', () => {
         runtime: mockRuntime,
         transformer: mockTransformer,
       })
-      operationLink = link()
+      operationLink = link({} as TRPCClientRuntime)
     })
 
     it('should not complete subscription on data', () => {
@@ -642,7 +644,7 @@ describe('webExtensionLink', () => {
         transformer: mockTransformer,
         timeoutMS: 1000,
       })
-      operationLink = link()
+      operationLink = link({} as TRPCClientRuntime)
     })
 
     afterEach(() => {
@@ -752,10 +754,8 @@ describe('webExtensionLink', () => {
   })
 
   describe('Port Disconnection', () => {
-    let link: ReturnType<typeof webExtensionLink>
-
     beforeEach(() => {
-      link = webExtensionLink({
+      webExtensionLink({
         runtime: mockRuntime,
         transformer: mockTransformer,
       })
@@ -777,7 +777,7 @@ describe('webExtensionLink', () => {
       ;(mockRuntime.connect as Mock).mockReturnValue(newMockPort)
 
       // Create new link - should reconnect
-      const newLink = webExtensionLink({
+      webExtensionLink({
         runtime: mockRuntime,
         transformer: mockTransformer,
       })
@@ -795,7 +795,7 @@ describe('webExtensionLink', () => {
         runtime: mockRuntime,
         transformer: mockTransformer,
       })
-      operationLink = link()
+      operationLink = link({} as TRPCClientRuntime)
     })
 
     it('should handle transformer that returns undefined', () => {

packages/trpc-webext/src/link/index.ts

@@ -1,11 +1,16 @@
 import { TRPCClientError } from '@trpc/client'
 import { observable } from '@trpc/server/observable'
 
+import { safeDeserialize, safeSerialize } from '../utils'
+
 import type { Operation, OperationResultEnvelope, TRPCLink } from '@trpc/client'
 import type { AnyTRPCRouter } from '@trpc/server'
 import type { Observer } from '@trpc/server/observable'
 import type { TRPCResponseMessage } from '@trpc/server/rpc'
-import type { DataTransformer } from '@trpc/server/unstable-core-do-not-import'
+import type {
+  DataTransformer,
+  TRPCResult,
+} from '@trpc/server/unstable-core-do-not-import'
 import type { Runtime } from 'webextension-polyfill'
 
 export interface WebExtensionLinkOptions {
@@ -45,7 +50,7 @@ function isBackgroundMessage(message: unknown): message is BackgroundMessage {
     typeof message === 'object' &&
     message !== null &&
     'trpc' in message &&
-    typeof (message as any).trpc === 'object'
+    typeof (message as BackgroundMessage).trpc === 'object'
   )
 }
 
@@ -77,7 +82,7 @@ function createPortMessageHandler(
     if ('error' in trpc) {
       // Handle error response
       const error = shouldDeserialize(trpc.error)
-        ? transformer.deserialize(trpc.error)
+        ? safeDeserialize(transformer, trpc.error)
         : trpc.error
 
       observer.error(TRPCClientError.from({ ...trpc, error }))
@@ -90,9 +95,9 @@ function createPortMessageHandler(
         ...trpc.result,
         ...((!trpc.result?.type || trpc.result.type === 'data') && {
           type: 'data' as const,
-          data: transformer.deserialize(trpc.result?.data || {}),
+          data: safeDeserialize(transformer, trpc.result?.data || {}),
         }),
-      },
+      } as TRPCResult<unknown>,
     })
 
     // Complete for non-subscription or stopped subscription
@@ -159,7 +164,7 @@ export function webExtensionLink(
     return ({ op }) => {
       const { id, type, path, input } = op
 
-      const serializedInput = transformer.serialize(input) ?? input
+      const serializedInput = safeSerialize(transformer, input) ?? input
 
       const trpcPayload = {
         id,

packages/trpc-webext/src/utils.ts

@@ -0,0 +1,33 @@
+import { TRPCError } from '@trpc/server'
+
+import type { DataTransformer } from '@trpc/server/unstable-core-do-not-import'
+
+export function safeDeserialize<T>(
+  transformer: DataTransformer,
+  data: unknown,
+): T {
+  try {
+    return transformer.deserialize(data)
+  } catch (error) {
+    throw new TRPCError({
+      code: 'BAD_REQUEST',
+      message: 'Failed to deserialize input data',
+      cause: error,
+    })
+  }
+}
+
+export function safeSerialize<T>(
+  transformer: DataTransformer,
+  data: T,
+): unknown {
+  try {
+    return transformer.serialize(data)
+  } catch (error) {
+    throw new TRPCError({
+      code: 'BAD_REQUEST',
+      message: 'Failed to serialize output data',
+      cause: error,
+    })
+  }
+}