@trpc/client 10.27.3 → 10.28.0

package/dist/links/wsLink.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"wsLink.d.ts","sourceRoot":"","sources":["../../src/links/wsLink.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAiB,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAC1E,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAc,MAAM,yBAAyB,CAAC;AAC9E,OAAO,EAKL,mBAAmB,EACpB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAErD,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAE9C,aAAK,gBAAgB,CAAC,OAAO,SAAS,SAAS,EAAE,OAAO,IAAI,mBAAmB,CAC7E,OAAO,EACP,gBAAgB,CAAC,OAAO,CAAC,CAC1B,CAAC;AAEF,aAAK,kBAAkB,CAAC,OAAO,SAAS,SAAS,EAAE,OAAO,IAAI,QAAQ,CACpE,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,EAClC,eAAe,CAAC,OAAO,CAAC,CACzB,CAAC;AAEF,MAAM,WAAW,sBAAsB;IACrC,GAAG,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,CAAC;IAC7B,SAAS,CAAC,EAAE,OAAO,SAAS,CAAC;IAC7B,YAAY,CAAC,EAAE,OAAO,UAAU,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,IAAI,CAAC;IACpB,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;CAC/C;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,sBAAsB;;kBAgNpC,SAAS,wDAA0B,aAAa;;EAoDtE;AACD,oBAAY,mBAAmB,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC;AAEpE,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,mBAAmB,CAAC;CAC7B;AAiBD,wBAAgB,MAAM,CAAC,OAAO,SAAS,SAAS,EAC9C,IAAI,EAAE,oBAAoB,GACzB,QAAQ,CAAC,OAAO,CAAC,CA4DnB"}
+{"version":3,"file":"wsLink.d.ts","sourceRoot":"","sources":["../../src/links/wsLink.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAiB,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAC1E,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAc,MAAM,yBAAyB,CAAC;AAC9E,OAAO,EAKL,mBAAmB,EACpB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAErD,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAE9C,aAAK,gBAAgB,CAAC,OAAO,SAAS,SAAS,EAAE,OAAO,IAAI,mBAAmB,CAC7E,OAAO,EACP,gBAAgB,CAAC,OAAO,CAAC,CAC1B,CAAC;AAEF,aAAK,kBAAkB,CAAC,OAAO,SAAS,SAAS,EAAE,OAAO,IAAI,QAAQ,CACpE,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,EAClC,eAAe,CAAC,OAAO,CAAC,CACzB,CAAC;AAEF,MAAM,WAAW,sBAAsB;IACrC,GAAG,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,CAAC;IAC7B,SAAS,CAAC,EAAE,OAAO,SAAS,CAAC;IAC7B,YAAY,CAAC,EAAE,OAAO,UAAU,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,IAAI,CAAC;IACpB,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;CAC/C;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,sBAAsB;;kBAwNpC,SAAS,wDAA0B,aAAa;;EAqDtE;AACD,oBAAY,mBAAmB,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC;AAEpE,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,mBAAmB,CAAC;CAC7B;AASD,wBAAgB,MAAM,CAAC,OAAO,SAAS,SAAS,EAC9C,IAAI,EAAE,oBAAoB,GACzB,QAAQ,CAAC,OAAO,CAAC,CA6CnB"}

package/dist/links/wsLink.js

@@ -67,6 +67,13 @@ function createWSClient(opts) {
             conn.close();
         }
     }
+    function closeActiveSubscriptions() {
+        Object.values(pendingRequests).forEach((req)=>{
+            if (req.type === 'subscription') {
+                req.callbacks.complete();
+            }
+        });
+    }
     function resumeSubscriptionOnReconnect(req) {
         if (outgoing.some((r)=>r.id === req.op.id)) {
             return;
@@ -205,6 +212,7 @@ function createWSClient(opts) {
         close: ()=>{
             state = 'closed';
             onClose?.();
+            closeActiveSubscriptions();
             closeIfNoPending(activeConnection);
             clearTimeout(connectTimer);
             connectTimer = null;
@@ -222,13 +230,6 @@ class TRPCWebSocketClosedError extends Error {
         Object.setPrototypeOf(this, TRPCWebSocketClosedError.prototype);
     }
 }
-class TRPCSubscriptionEndedError extends Error {
-    constructor(message){
-        super(message);
-        this.name = 'TRPCSubscriptionEndedError';
-        Object.setPrototypeOf(this, TRPCSubscriptionEndedError.prototype);
-    }
-}
 function wsLink(opts) {
     return (runtime)=>{
         const { client  } = opts;
@@ -236,7 +237,6 @@ function wsLink(opts) {
             return observable.observable((observer)=>{
                 const { type , path , id , context  } = op;
                 const input = runtime.transformer.serialize(op.input);
-                let isDone = false;
                 const unsub = client.request({
                     type,
                     path,
@@ -245,17 +245,11 @@ function wsLink(opts) {
                     context
                 }, {
                     error (err) {
-                        isDone = true;
                         observer.error(err);
                         unsub();
                     },
                     complete () {
-                        if (!isDone) {
-                            isDone = true;
-                            observer.error(transformResult.TRPCClientError.from(new TRPCSubscriptionEndedError('Operation ended prematurely')));
-                        } else {
-                            observer.complete();
-                        }
+                        observer.complete();
                     },
                     next (message) {
                         const transformed = transformResult.transformResult(message, runtime);
@@ -268,14 +262,12 @@ function wsLink(opts) {
                         });
                         if (op.type !== 'subscription') {
                             // if it isn't a subscription we don't care about next response
-                            isDone = true;
                             unsub();
                             observer.complete();
                         }
                     }
                 });
                 return ()=>{
-                    isDone = true;
                     unsub();
                 };
             });

package/dist/links/wsLink.mjs

@@ -63,6 +63,13 @@ function createWSClient(opts) {
             conn.close();
         }
     }
+    function closeActiveSubscriptions() {
+        Object.values(pendingRequests).forEach((req)=>{
+            if (req.type === 'subscription') {
+                req.callbacks.complete();
+            }
+        });
+    }
     function resumeSubscriptionOnReconnect(req) {
         if (outgoing.some((r)=>r.id === req.op.id)) {
             return;
@@ -201,6 +208,7 @@ function createWSClient(opts) {
         close: ()=>{
             state = 'closed';
             onClose?.();
+            closeActiveSubscriptions();
             closeIfNoPending(activeConnection);
             clearTimeout(connectTimer);
             connectTimer = null;
@@ -218,13 +226,6 @@ class TRPCWebSocketClosedError extends Error {
         Object.setPrototypeOf(this, TRPCWebSocketClosedError.prototype);
     }
 }
-class TRPCSubscriptionEndedError extends Error {
-    constructor(message){
-        super(message);
-        this.name = 'TRPCSubscriptionEndedError';
-        Object.setPrototypeOf(this, TRPCSubscriptionEndedError.prototype);
-    }
-}
 function wsLink(opts) {
     return (runtime)=>{
         const { client  } = opts;
@@ -232,7 +233,6 @@ function wsLink(opts) {
             return observable((observer)=>{
                 const { type , path , id , context  } = op;
                 const input = runtime.transformer.serialize(op.input);
-                let isDone = false;
                 const unsub = client.request({
                     type,
                     path,
@@ -241,17 +241,11 @@ function wsLink(opts) {
                     context
                 }, {
                     error (err) {
-                        isDone = true;
                         observer.error(err);
                         unsub();
                     },
                     complete () {
-                        if (!isDone) {
-                            isDone = true;
-                            observer.error(TRPCClientError.from(new TRPCSubscriptionEndedError('Operation ended prematurely')));
-                        } else {
-                            observer.complete();
-                        }
+                        observer.complete();
                     },
                     next (message) {
                         const transformed = transformResult(message, runtime);
@@ -264,14 +258,12 @@ function wsLink(opts) {
                         });
                         if (op.type !== 'subscription') {
                             // if it isn't a subscription we don't care about next response
-                            isDone = true;
                             unsub();
                             observer.complete();
                         }
                     }
                 });
                 return ()=>{
-                    isDone = true;
                     unsub();
                 };
             });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trpc/client",
-  "version": "10.27.3",
+  "version": "10.28.0",
   "description": "The tRPC client library",
   "author": "KATT",
   "license": "MIT",
@@ -72,14 +72,15 @@
     "README.md",
     "package.json",
     "links",
-    "shared"
+    "shared",
+    "!**/*.test.*"
   ],
   "peerDependencies": {
-    "@trpc/server": "10.27.3"
+    "@trpc/server": "10.28.0"
   },
   "devDependencies": {
     "@testing-library/dom": "^9.0.0",
-    "@trpc/server": "10.27.3",
+    "@trpc/server": "10.28.0",
     "@types/isomorphic-fetch": "^0.0.36",
     "@types/node": "^18.7.20",
     "eslint": "^8.40.0",
@@ -94,5 +95,8 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "a7bca8888003f0a2f3e8b966e44442bb576bfff2"
+  "funding": [
+    "https://trpc.io/sponsor"
+  ],
+  "gitHead": "7aadb24ce0bc20ae27f32bd80891ef6da5885e5e"
 }

package/src/links/wsLink.ts

@@ -120,6 +120,14 @@ export function createWSClient(opts: WebSocketClientOptions) {
     }
   }
 
+  function closeActiveSubscriptions() {
+    Object.values(pendingRequests).forEach((req) => {
+      if (req.type === 'subscription') {
+        req.callbacks.complete();
+      }
+    });
+  }
+
   function resumeSubscriptionOnReconnect(req: TRequest) {
     if (outgoing.some((r) => r.id === req.op.id)) {
       return;
@@ -281,6 +289,7 @@ export function createWSClient(opts: WebSocketClientOptions) {
     close: () => {
       state = 'closed';
       onClose?.();
+      closeActiveSubscriptions();
       closeIfNoPending(activeConnection);
       clearTimeout(connectTimer as any);
       connectTimer = null;
@@ -304,14 +313,6 @@ class TRPCWebSocketClosedError extends Error {
   }
 }
 
-class TRPCSubscriptionEndedError extends Error {
-  constructor(message: string) {
-    super(message);
-    this.name = 'TRPCSubscriptionEndedError';
-    Object.setPrototypeOf(this, TRPCSubscriptionEndedError.prototype);
-  }
-}
-
 export function wsLink<TRouter extends AnyRouter>(
   opts: WebSocketLinkOptions,
 ): TRPCLink<TRouter> {
@@ -323,28 +324,15 @@ export function wsLink<TRouter extends AnyRouter>(
 
         const input = runtime.transformer.serialize(op.input);
 
-        let isDone = false;
         const unsub = client.request(
           { type, path, input, id, context },
           {
             error(err) {
-              isDone = true;
               observer.error(err as TRPCClientError<any>);
               unsub();
             },
             complete() {
-              if (!isDone) {
-                isDone = true;
-                observer.error(
-                  TRPCClientError.from(
-                    new TRPCSubscriptionEndedError(
-                      'Operation ended prematurely',
-                    ),
-                  ),
-                );
-              } else {
-                observer.complete();
-              }
+              observer.complete();
             },
             next(message) {
               const transformed = transformResult(message, runtime);
@@ -360,7 +348,6 @@ export function wsLink<TRouter extends AnyRouter>(
               if (op.type !== 'subscription') {
                 // if it isn't a subscription we don't care about next response
 
-                isDone = true;
                 unsub();
                 observer.complete();
               }
@@ -368,7 +355,6 @@ export function wsLink<TRouter extends AnyRouter>(
           },
         );
         return () => {
-          isDone = true;
           unsub();
         };
       });

package/src/internals/types.test.ts

@@ -1,66 +0,0 @@
-import isomorphicFetch from 'isomorphic-fetch';
-import nodeFetch from 'node-fetch';
-import type { fetch as undiciFetch } from 'undici';
-import { createTRPCProxyClient } from '../createTRPCClientProxy';
-import { getFetch } from '../getFetch';
-import { httpBatchLink } from '../links/httpBatchLink';
-import { getAbortController } from './getAbortController';
-import {
-  AbortControllerEsque,
-  AbortControllerInstanceEsque,
-  FetchEsque,
-  ResponseEsque,
-} from './types';
-
-describe('AbortController', () => {
-  test('AbortControllerEsque', () => {
-    expectTypeOf(
-      getAbortController,
-    ).returns.toEqualTypeOf<AbortControllerEsque | null>();
-
-    expectTypeOf(() => {
-      const AbortController = getAbortController(undefined)!;
-      return new AbortController();
-    }).returns.toEqualTypeOf<AbortControllerInstanceEsque>();
-  });
-});
-
-describe('fetch', () => {
-  test('parameters', () => {
-    createTRPCProxyClient({
-      links: [
-        httpBatchLink({
-          url: 'YOUR_SERVER_URL',
-          fetch(url, options) {
-            return fetch(url, options);
-          },
-        }),
-      ],
-    });
-  });
-
-  test('FetchEsque', () => {
-    expectTypeOf(getFetch).returns.toEqualTypeOf<FetchEsque>();
-
-    expectTypeOf(() =>
-      getFetch()('', {
-        body: '',
-        headers: Math.random() > 0.5 ? [['a', 'b']] : { a: 'b' },
-        method: 'GET',
-        signal: new AbortSignal(),
-      }),
-    ).returns.toEqualTypeOf<Promise<ResponseEsque>>();
-
-    getFetch({} as unknown as typeof fetch);
-  });
-
-  test('NativeFetchEsque', () => {
-    getFetch(isomorphicFetch);
-    getFetch(nodeFetch as any);
-
-    // Passing in undiciFetch directly in Node v18.7.0 gives:
-    // ReferenceError: TextEncoder is not defined
-    // 🤷
-    getFetch({} as unknown as typeof undiciFetch);
-  });
-});

package/src/links/dedupeLink.test.ts

@@ -1,128 +0,0 @@
-import { waitFor } from '@testing-library/dom';
-import { OperationLink } from '..';
-import { AnyRouter } from '../../../server/src';
-import { observable } from '../../../server/src/observable';
-import { dedupeLink } from './dedupeLink';
-import { createChain } from './internals/createChain';
-
-test('dedupeLink', async () => {
-  const endingLinkTriggered = vi.fn();
-  const timerTriggered = vi.fn();
-  const links: OperationLink<AnyRouter, any, any>[] = [
-    // "dedupe link"
-    dedupeLink()(null as any),
-    ({ op }) => {
-      return observable((subscribe) => {
-        endingLinkTriggered();
-        const timer = setTimeout(() => {
-          timerTriggered();
-          subscribe.next({
-            result: {
-              type: 'data',
-              data: {
-                input: op.input,
-              },
-            },
-          });
-          subscribe.complete();
-        }, 1);
-        return () => clearTimeout(timer);
-      });
-    },
-  ];
-  {
-    const call1 = createChain<AnyRouter, unknown, unknown>({
-      links,
-      op: {
-        type: 'query',
-        id: 1,
-        input: 'world',
-        path: 'hello',
-        context: {},
-      },
-    });
-
-    const call2 = createChain<AnyRouter, unknown, unknown>({
-      links,
-      op: {
-        type: 'query',
-        id: 1,
-        input: 'world',
-        path: 'hello',
-        context: {},
-      },
-    });
-    const next = vi.fn();
-    call1.subscribe({ next });
-    call2.subscribe({ next });
-
-    expect(endingLinkTriggered).toHaveBeenCalledTimes(1);
-    await waitFor(() => {
-      expect(timerTriggered).toHaveBeenCalledTimes(1);
-    });
-
-    expect(next).toHaveBeenCalledTimes(2);
-  }
-});
-
-test('dedupe - cancel one does not cancel the other', async () => {
-  const endingLinkTriggered = vi.fn();
-  const timerTriggered = vi.fn();
-  const links: OperationLink<AnyRouter, any, any>[] = [
-    // "dedupe link"
-    dedupeLink()(null as any),
-    ({ op }) => {
-      return observable((subscribe) => {
-        endingLinkTriggered();
-        const timer = setTimeout(() => {
-          timerTriggered();
-          subscribe.next({
-            result: {
-              type: 'data',
-              data: {
-                input: op.input,
-              },
-            },
-          });
-          subscribe.complete();
-        }, 1);
-        return () => clearTimeout(timer);
-      });
-    },
-  ];
-
-  {
-    const call1 = createChain<AnyRouter, unknown, unknown>({
-      links,
-      op: {
-        type: 'query',
-        id: 1,
-        input: 'world',
-        path: 'hello',
-        context: {},
-      },
-    });
-
-    const call2 = createChain<AnyRouter, unknown, unknown>({
-      links,
-      op: {
-        type: 'query',
-        id: 1,
-        input: 'world',
-        path: 'hello',
-        context: {},
-      },
-    });
-    const next = vi.fn();
-    const call1$ = call1.subscribe({ next });
-    call2.subscribe({ next });
-    call1$.unsubscribe();
-
-    expect(endingLinkTriggered).toHaveBeenCalledTimes(1);
-    await waitFor(() => {
-      expect(timerTriggered).toHaveBeenCalledTimes(1);
-
-      expect(next).toHaveBeenCalledTimes(1);
-    });
-  }
-});

package/src/links/internals/createChain.test.ts

@@ -1,117 +0,0 @@
-import { observable } from '@trpc/server/observable';
-import { AnyRouter } from '@trpc/server/src';
-import { createChain } from './createChain';
-
-describe('chain', () => {
-  test('trivial', () => {
-    const result$ = createChain<AnyRouter, unknown, unknown>({
-      links: [
-        ({ next, op }) => {
-          return observable((observer) => {
-            const subscription = next(op).subscribe(observer);
-            return () => {
-              subscription.unsubscribe();
-            };
-          });
-        },
-        ({ op }) => {
-          return observable((observer) => {
-            observer.next({
-              context: {},
-              result: {
-                type: 'data',
-                data: {
-                  input: op.input,
-                },
-              },
-            });
-            observer.complete();
-          });
-        },
-      ],
-      op: {
-        type: 'query',
-        id: 1,
-        input: 'world',
-        path: 'hello',
-        context: {},
-      },
-    });
-
-    const next = vi.fn();
-
-    result$.subscribe({ next });
-    // console.log(next.mock.calls);
-    expect(next).toHaveBeenCalledTimes(1);
-  });
-  test('multiple responses', () => {
-    const result$ = createChain<AnyRouter, unknown, unknown>({
-      links: [
-        ({ next, op }) => {
-          return observable((observer) => {
-            observer.next({
-              context: {},
-              result: {
-                type: 'data',
-                data: 'from cache',
-              },
-            });
-            const subscription = next(op).subscribe(observer);
-            return () => {
-              subscription.unsubscribe();
-            };
-          });
-        },
-        ({ op }) => {
-          return observable((observer) => {
-            observer.next({
-              result: {
-                type: 'data',
-                data: {
-                  input: op.input,
-                },
-              },
-            });
-            observer.complete();
-          });
-        },
-      ],
-      op: {
-        type: 'query',
-        id: 1,
-        input: 'world',
-        path: 'hello',
-        context: {},
-      },
-    });
-
-    const next = vi.fn();
-
-    result$.subscribe({ next });
-
-    expect(next).toHaveBeenCalledTimes(2);
-    expect(next.mock.calls[0]).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "context": Object {},
-          "result": Object {
-            "data": "from cache",
-            "type": "data",
-          },
-        },
-      ]
-    `);
-    expect(next.mock.calls[1]).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "result": Object {
-            "data": Object {
-              "input": "world",
-            },
-            "type": "data",
-          },
-        },
-      ]
-    `);
-  });
-});

package/src/links/splitLink.test.ts

@@ -1,55 +0,0 @@
-import { observable } from '@trpc/server/observable';
-import { splitLink } from '../';
-import { OperationLink, TRPCLink } from '../';
-import { AnyRouter } from '../../../server/src';
-import { createChain } from '../links/internals/createChain';
-
-test('splitLink', () => {
-  const wsLinkSpy = vi.fn();
-  const wsLink: TRPCLink<any> = () => () =>
-    observable(() => {
-      wsLinkSpy();
-    });
-  const httpLinkSpy = vi.fn();
-  const httpLink: TRPCLink<any> = () => () =>
-    observable(() => {
-      httpLinkSpy();
-    });
-  const links: OperationLink<AnyRouter, any, any>[] = [
-    // "dedupe link"
-    splitLink({
-      condition(op) {
-        return op.type === 'subscription';
-      },
-      true: wsLink,
-      false: [httpLink],
-    })(null as any),
-  ];
-
-  createChain({
-    links,
-    op: {
-      type: 'query',
-      input: null,
-      path: '.',
-      id: 0,
-      context: {},
-    },
-  }).subscribe({});
-  expect(httpLinkSpy).toHaveBeenCalledTimes(1);
-  expect(wsLinkSpy).toHaveBeenCalledTimes(0);
-  vi.resetAllMocks();
-
-  createChain({
-    links,
-    op: {
-      type: 'subscription',
-      input: null,
-      path: '.',
-      id: 0,
-      context: {},
-    },
-  }).subscribe({});
-  expect(httpLinkSpy).toHaveBeenCalledTimes(0);
-  expect(wsLinkSpy).toHaveBeenCalledTimes(1);
-});