@trpc/server 11.0.0-alpha-tmp-app-router-example.388 → 11.0.0-alpha-tmp-issues-5851-take-two.448

package/src/unstable-core-do-not-import/stream/sse.ts

@@ -0,0 +1,288 @@
+import { getTRPCErrorFromUnknown } from '../error/TRPCError';
+import type { ValidateShape } from '../types';
+import { run } from '../utils';
+import type { ConsumerOnError } from './jsonl';
+import { createTimeoutPromise } from './utils/createDeferred';
+import { createReadableStream } from './utils/createReadableStream';
+
+type Serialize = (value: any) => any;
+type Deserialize = (value: any) => any;
+
+/**
+ * Server-sent Event Message
+ * @see https://html.spec.whatwg.org/multipage/server-sent-events.html
+ * @public
+ */
+export interface SSEMessage {
+  /**
+   * The data field of the message - this can be anything
+   */
+  data: unknown;
+  /**
+   * The id for this message
+   * Passing this id will allow the client to resume the connection from this point if the connection is lost
+   * @see https://html.spec.whatwg.org/multipage/server-sent-events.html#the-last-event-id-header
+   */
+  id: string;
+}
+
+const sseSymbol = Symbol('SSEMessageEnvelope');
+export type SSEMessageEnvelope<TData> = [typeof sseSymbol, TData];
+
+/**
+ * Produce a typed server-sent event message
+ */
+export function sse<TData extends SSEMessage>(
+  event: ValidateShape<TData, SSEMessage>,
+): SSEMessageEnvelope<TData> {
+  if (event.id === '') {
+    // This could be removed by using different event names for `yield sse(x)`-emitted events and `yield y`-emitted events
+    throw new Error(
+      '`id` must not be an empty string as empty string is the same as not setting the id at all',
+    );
+  }
+  return [sseSymbol, event as TData];
+}
+
+export function isSSEMessageEnvelope<TData extends SSEMessage>(
+  value: unknown,
+): value is SSEMessageEnvelope<TData> {
+  return Array.isArray(value) && value[0] === sseSymbol;
+}
+
+export type SerializedSSEvent = Omit<SSEMessage, 'data'> & {
+  data?: string;
+};
+
+/**
+ * @internal
+ */
+export interface PingOptions {
+  /**
+   * Enable ping comments sent from the server
+   * @default false
+   */
+  enabled: boolean;
+  /**
+   * Interval in milliseconds
+   * @default 1000
+   */
+  intervalMs?: number;
+}
+
+export interface SSEStreamProducerOptions {
+  serialize?: Serialize;
+  data: AsyncIterable<unknown>;
+  maxDepth?: number;
+  ping?: PingOptions;
+  /**
+   * Maximum duration in milliseconds for the request before ending the stream
+   * Only useful for serverless runtimes
+   * @default undefined
+   */
+  maxDurationMs?: number;
+  /**
+   * End the request immediately after data is sent
+   * Only useful for serverless runtimes that do not support streaming responses
+   * @default false
+   */
+  emitAndEndImmediately?: boolean;
+}
+
+type SSEvent = Partial<
+  SSEMessage & {
+    comment: string;
+    event: string;
+  }
+>;
+/**
+ *
+ * @see https://html.spec.whatwg.org/multipage/server-sent-events.html
+ */
+export function sseStreamProducer(opts: SSEStreamProducerOptions) {
+  const stream = createReadableStream<SSEvent>();
+  stream.controller.enqueue({
+    comment: 'connected',
+  });
+
+  const { serialize = (v) => v } = opts;
+
+  const ping: Required<PingOptions> = {
+    enabled: opts.ping?.enabled ?? false,
+    intervalMs: opts.ping?.intervalMs ?? 1000,
+  };
+
+  run(async () => {
+    const iterator = opts.data[Symbol.asyncIterator]();
+
+    const closedPromise = stream.cancelledPromise.then(() => 'closed' as const);
+    const maxDurationPromise = createTimeoutPromise(
+      opts.maxDurationMs ?? Infinity,
+      'maxDuration' as const,
+    );
+
+    let nextPromise = iterator.next();
+
+    while (true) {
+      const pingPromise = createTimeoutPromise(
+        ping.enabled ? ping.intervalMs : Infinity,
+        'ping' as const,
+      );
+      const next = await Promise.race([
+        nextPromise.catch(getTRPCErrorFromUnknown),
+        pingPromise.promise,
+        closedPromise,
+        maxDurationPromise.promise,
+      ]);
+
+      pingPromise.clear();
+      if (next === 'closed') {
+        break;
+      }
+      if (next === 'maxDuration') {
+        break;
+      }
+
+      if (next === 'ping') {
+        stream.controller.enqueue({
+          comment: 'ping',
+        });
+        continue;
+      }
+
+      if (next instanceof Error) {
+        stream.controller.error(next);
+        break;
+      }
+      if (next.done) {
+        break;
+      }
+
+      const value = next.value;
+
+      const chunk: SSEvent = isSSEMessageEnvelope(value)
+        ? { ...value[1] }
+        : {
+            data: value,
+          };
+      if ('data' in chunk) {
+        chunk.data = JSON.stringify(serialize(chunk.data));
+      }
+
+      stream.controller.enqueue(chunk);
+
+      if (opts.emitAndEndImmediately) {
+        // end the stream in the next tick so that we can send a few more events from the queue
+        setTimeout(maxDurationPromise.resolve, 1);
+      }
+
+      nextPromise = iterator.next();
+    }
+    maxDurationPromise.clear();
+    await iterator.return?.();
+    try {
+      stream.controller.close();
+    } catch {}
+  }).catch((error) => {
+    return stream.controller.error(error);
+  });
+
+  return stream.readable.pipeThrough(
+    new TransformStream<SSEvent, string>({
+      transform(chunk, controller) {
+        if ('event' in chunk) {
+          controller.enqueue(`event: ${chunk.event}\n`);
+        }
+        if ('data' in chunk) {
+          controller.enqueue(`data: ${chunk.data}\n`);
+        }
+        if ('id' in chunk) {
+          controller.enqueue(`id: ${chunk.id}\n`);
+        }
+        if ('comment' in chunk) {
+          controller.enqueue(`: ${chunk.comment}\n`);
+        }
+        controller.enqueue('\n\n');
+      },
+    }),
+  );
+}
+export type inferSSEOutput<TData> = TData extends SSEMessageEnvelope<
+  infer $Data
+>
+  ? $Data
+  : TData;
+/**
+ * @see https://html.spec.whatwg.org/multipage/server-sent-events.html
+ */
+
+export function sseStreamConsumer<TData>(opts: {
+  from: EventSource;
+  onError?: ConsumerOnError;
+  deserialize?: Deserialize;
+}): AsyncIterable<inferSSEOutput<TData>> {
+  const { deserialize = (v) => v } = opts;
+  const eventSource = opts.from;
+
+  const stream = createReadableStream<MessageEvent>();
+
+  const transform = new TransformStream<MessageEvent, inferSSEOutput<TData>>({
+    async transform(chunk, controller) {
+      const def: Partial<SSEMessage> = {
+        data: deserialize(JSON.parse(chunk.data)),
+      };
+
+      if (chunk.lastEventId) {
+        def.id = chunk.lastEventId;
+      }
+      controller.enqueue(def as inferSSEOutput<TData>);
+    },
+  });
+
+  eventSource.addEventListener('message', (msg) => {
+    stream.controller.enqueue(msg);
+  });
+  eventSource.addEventListener('error', (cause) => {
+    if (eventSource.readyState === EventSource.CLOSED) {
+      stream.controller.error(cause);
+    }
+  });
+
+  const readable = stream.readable.pipeThrough(transform);
+  return {
+    [Symbol.asyncIterator]() {
+      const reader = readable.getReader();
+
+      const iterator: AsyncIterator<inferSSEOutput<TData>> = {
+        async next() {
+          const value = await reader.read();
+          if (value.done) {
+            return {
+              value: undefined,
+              done: true,
+            };
+          }
+          return {
+            value: value.value,
+            done: false,
+          };
+        },
+        async return() {
+          reader.releaseLock();
+          return {
+            value: undefined,
+            done: true,
+          };
+        },
+      };
+      return iterator;
+    },
+  };
+}
+
+export const sseHeaders = {
+  'Content-Type': 'text/event-stream',
+  'Cache-Control': 'no-cache, no-transform',
+  'X-Accel-Buffering': 'no',
+  Connection: 'keep-alive',
+} as const;

package/src/unstable-core-do-not-import/stream/utils/createDeferred.ts

@@ -0,0 +1,48 @@
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
+export function createDeferred<TValue>() {
+  let resolve: (value: TValue) => void;
+  let reject: (error: unknown) => void;
+  const promise = new Promise<TValue>((res, rej) => {
+    resolve = res;
+    reject = rej;
+  });
+
+  return { promise, resolve: resolve!, reject: reject! };
+}
+export type Deferred<TValue> = ReturnType<typeof createDeferred<TValue>>;
+
+export const createTimeoutPromise = <TValue>(
+  timeoutMs: number,
+  value: TValue,
+) => {
+  let deferred = createDeferred<TValue>();
+  deferred = deferred as typeof deferred & { clear: () => void };
+
+  let timeout: ReturnType<typeof setTimeout> | null = null;
+  const clear = () => {
+    if (timeout) {
+      clearTimeout(timeout);
+      timeout = null;
+    }
+  };
+  const resolve = () => {
+    deferred.resolve(value);
+    clear();
+  };
+  if (timeoutMs !== Infinity) {
+    timeout = setTimeout(resolve, timeoutMs);
+    timeout.unref?.();
+  }
+
+  return {
+    promise: deferred.promise,
+    /**
+     * Clear the timeout without resolving the promise
+     */
+    clear,
+    /**
+     * Resolve the promise with the value
+     */
+    resolve,
+  };
+};

package/src/unstable-core-do-not-import/stream/utils/createReadableStream.ts

@@ -0,0 +1,31 @@
+import { createDeferred } from './createDeferred';
+
+// ---------- utils
+/**
+ * One-off readable stream
+ */
+export function createReadableStream<TValue = unknown>() {
+  let controller: ReadableStreamDefaultController<TValue> =
+    null as unknown as ReadableStreamDefaultController<TValue>;
+
+  const deferred = createDeferred<'cancelled'>();
+  let cancelled = false;
+  const readable = new ReadableStream<TValue>({
+    start(c) {
+      controller = c;
+    },
+    cancel() {
+      deferred.resolve('cancelled');
+      cancelled = true;
+    },
+  });
+
+  return {
+    readable,
+    controller,
+    cancelledPromise: deferred.promise,
+    cancelled() {
+      return cancelled;
+    },
+  } as const;
+}

package/src/unstable-core-do-not-import/stream/utils/createServer.ts

@@ -0,0 +1,44 @@
+import http from 'http';
+import type { Socket } from 'net';
+
+export function createServer(
+  handler: (req: http.IncomingMessage, res: http.ServerResponse) => void,
+) {
+  const server = http.createServer(async (req, res) => {
+    handler(req, res);
+  });
+  server.listen(0);
+
+  const connections = new Set<Socket>();
+  server.on('connection', (conn) => {
+    connections.add(conn);
+    conn.once('close', () => {
+      connections.delete(conn);
+    });
+  });
+
+  const port = (server.address() as any).port;
+
+  const url = `http://localhost:${port}`;
+
+  async function forceClose() {
+    for (const conn of connections) {
+      conn.destroy();
+    }
+    await new Promise((resolve) => {
+      server.close(resolve);
+    });
+  }
+
+  return {
+    url,
+    close: async () => {
+      await forceClose();
+    },
+    restart: async () => {
+      await forceClose();
+
+      server.listen(port);
+    },
+  };
+}

package/src/unstable-core-do-not-import/utils.ts

@@ -56,3 +56,8 @@ export function isAsyncIterable<TValue>(
     asyncIteratorsSupported && isObject(value) && Symbol.asyncIterator in value
   );
 }
+
+/**
+ * Run an IIFE
+ */
+export const run = <TValue>(fn: () => TValue): TValue => fn();

package/src/unstable-core-do-not-import.ts

@@ -12,13 +12,15 @@ export * from './unstable-core-do-not-import/clientish/inference';
 export * from './unstable-core-do-not-import/clientish/inferrable';
 export * from './unstable-core-do-not-import/clientish/serialize';
 export * from './unstable-core-do-not-import/createProxy';
-export * from './unstable-core-do-not-import/error/TRPCError';
 export * from './unstable-core-do-not-import/error/formatter';
 export * from './unstable-core-do-not-import/error/getErrorShape';
+export * from './unstable-core-do-not-import/error/TRPCError';
 export * from './unstable-core-do-not-import/http/batchStreamFormatter';
 export * from './unstable-core-do-not-import/http/contentType';
 export * from './unstable-core-do-not-import/http/contentTypeParsers';
+export * from './unstable-core-do-not-import/http/formDataToObject';
 export * from './unstable-core-do-not-import/http/getHTTPStatusCode';
+export * from './unstable-core-do-not-import/http/parseConnectionParams';
 export * from './unstable-core-do-not-import/http/resolveResponse';
 export * from './unstable-core-do-not-import/http/toURL';
 export * from './unstable-core-do-not-import/http/types';
@@ -30,7 +32,8 @@ export * from './unstable-core-do-not-import/procedureBuilder';
 export * from './unstable-core-do-not-import/rootConfig';
 export * from './unstable-core-do-not-import/router';
 export * from './unstable-core-do-not-import/rpc';
+export * from './unstable-core-do-not-import/stream/jsonl';
+export * from './unstable-core-do-not-import/stream/sse';
 export * from './unstable-core-do-not-import/transformer';
 export * from './unstable-core-do-not-import/types';
 export * from './unstable-core-do-not-import/utils';
-export * from './unstable-core-do-not-import/stream/stream';

package/dist/adapters/next-app-dir/formDataToObject.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"formDataToObject.d.ts","sourceRoot":"","sources":["../../../src/adapters/next-app-dir/formDataToObject.ts"],"names":[],"mappings":"AA2BA,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,2BAQlD"}

package/dist/adapters/next-app-dir/formDataToObject.js

@@ -1,34 +0,0 @@
-'use strict';
-
-/* eslint-disable @typescript-eslint/no-non-null-assertion */ function set(obj, path, value) {
-    if (typeof path === 'string') {
-        path = path.split(/[\.\[\]]/).filter(Boolean);
-    }
-    if (path.length > 1) {
-        const p = path.shift();
-        const isArrayIndex = /^\d+$/.test(path[0]);
-        obj[p] = obj[p] || (isArrayIndex ? [] : {});
-        set(obj[p], path, value);
-        return;
-    }
-    const p1 = path[0];
-    if (obj[p1] === undefined) {
-        obj[p1] = value;
-    } else if (Array.isArray(obj[p1])) {
-        obj[p1].push(value);
-    } else {
-        obj[p1] = [
-            obj[p1],
-            value
-        ];
-    }
-}
-function formDataToObject(formData) {
-    const obj = {};
-    for (const [key, value] of formData.entries()){
-        set(obj, key, value);
-    }
-    return obj;
-}
-
-exports.formDataToObject = formDataToObject;

package/dist/adapters/next-app-dir/formDataToObject.mjs

@@ -1,32 +0,0 @@
-/* eslint-disable @typescript-eslint/no-non-null-assertion */ function set(obj, path, value) {
-    if (typeof path === 'string') {
-        path = path.split(/[\.\[\]]/).filter(Boolean);
-    }
-    if (path.length > 1) {
-        const p = path.shift();
-        const isArrayIndex = /^\d+$/.test(path[0]);
-        obj[p] = obj[p] || (isArrayIndex ? [] : {});
-        set(obj[p], path, value);
-        return;
-    }
-    const p1 = path[0];
-    if (obj[p1] === undefined) {
-        obj[p1] = value;
-    } else if (Array.isArray(obj[p1])) {
-        obj[p1].push(value);
-    } else {
-        obj[p1] = [
-            obj[p1],
-            value
-        ];
-    }
-}
-function formDataToObject(formData) {
-    const obj = {};
-    for (const [key, value] of formData.entries()){
-        set(obj, key, value);
-    }
-    return obj;
-}
-
-export { formDataToObject };

package/dist/unstable-core-do-not-import/stream/stream.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"stream.d.ts","sourceRoot":"","sources":["../../../src/unstable-core-do-not-import/stream/stream.ts"],"names":[],"mappings":"AAiBA;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,SAAS,EAAE,MAAM,2BAA2B,CAAC,UAAU,CAAC,CAAC;CAC1D,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,EAAE,CACA,SAAS,EAAE,MAAM,GAAG,MAAM,EAC1B,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,GACjC,yBAAyB,CAAC;CAC9B,CAAC;AAGF,QAAA,MAAM,wBAAwB,IAAI,CAAC;AACnC,KAAK,wBAAwB,GAAG,OAAO,wBAAwB,CAAC;AAChE,QAAA,MAAM,+BAA+B,IAAI,CAAC;AAC1C,KAAK,+BAA+B,GAAG,OAAO,+BAA+B,CAAC;AAE9E,QAAA,MAAM,wBAAwB,IAAI,CAAC;AACnC,KAAK,wBAAwB,GAAG,OAAO,wBAAwB,CAAC;AAChE,QAAA,MAAM,uBAAuB,IAAI,CAAC;AAClC,KAAK,uBAAuB,GAAG,OAAO,uBAAuB,CAAC;AAE9D,QAAA,MAAM,0BAA0B,IAAI,CAAC;AACrC,KAAK,0BAA0B,GAAG,OAAO,0BAA0B,CAAC;AACpE,QAAA,MAAM,2BAA2B,IAAI,CAAC;AACtC,KAAK,2BAA2B,GAAG,OAAO,2BAA2B,CAAC;AACtE,QAAA,MAAM,2BAA2B,IAAI,CAAC;AACtC,KAAK,2BAA2B,GAAG,OAAO,2BAA2B,CAAC;AAEtE,KAAK,kBAAkB,GAEnB,IAAI,GAEJ,MAAM,GAEN,MAAM,CAAC;AAEX,KAAK,UAAU,GAAG,MAAM,GAAG;IAAE,YAAY,EAAE,IAAI,CAAA;CAAE,CAAC;AAClD,KAAK,cAAc,GACf,wBAAwB,GACxB,+BAA+B,CAAC;AACpC,KAAK,eAAe,GAAG;IACrB,GAAG,EAAE,kBAAkB;IACvB,IAAI,EAAE,cAAc;IACpB,OAAO,EAAE,UAAU;CACpB,CAAC;AACF,KAAK,aAAa,GAAG;IAEnB;QAAC,OAAO;KAAC;IAET,GAAG,eAAe,EAAE;CACrB,CAAC;AAGF,KAAK,YAAY,GACb;IACE,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,wBAAwB;IAChC,KAAK,EAAE,aAAa;CACrB,GACD,CAAC,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,uBAAuB,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;AAC9E,KAAK,aAAa,GACd,CAAC,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,0BAA0B,CAAC,GAC5D;IACE,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,2BAA2B;IACnC,KAAK,EAAE,aAAa;CACrB,GACD;IACE,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,2BAA2B;IACnC,KAAK,EAAE,OAAO;CACf,CAAC;AACN,KAAK,SAAS,GAAG,YAAY,GAAG,aAAa,CAAC;AAE9C,wBAAgB,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,OAAO,CAAC,OAAO,CAAC,CAMnE;AAED,KAAK,SAAS,GAAG,CAAC,KAAK,EAAE,GAAG,KAAK,GAAG,CAAC;AACrC,KAAK,WAAW,GAAG,CAAC,KAAK,EAAE,GAAG,KAAK,GAAG,CAAC;AAEvC,MAAM,MAAM,eAAe,GAAG,CAAC,IAAI,EAAE;IACnC,KAAK,EAAE,OAAO,CAAC;IACf,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;CAC3B,KAAK,IAAI,CAAC;AACX,MAAM,WAAW,eAAe;IAC9B,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE;QACnB,KAAK,EAAE,OAAO,CAAC;QACf,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;KAC3B,KAAK,OAAO,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAkJD;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,eAAe,8BA2BxD;AACD,cAAM,sBAAuB,SAAQ,KAAK;gBAC5B,KAAK,CAAC,EAAE,OAAO;CAK5B;AAMD,MAAM,MAAM,eAAe,GAAG,CAAC,IAAI,EAAE;IAAE,KAAK,EAAE,OAAO,CAAA;CAAE,KAAK,IAAI,CAAC;AA6FjE;;;GAGG;AACH,wBAAsB,mBAAmB,CAAC,KAAK,EAAE,IAAI,EAAE;IACrD,IAAI,EAAE,yBAAyB,GAAG,sBAAsB,CAAC;IACzD,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE;QAAE,KAAK,EAAE,OAAO,CAAA;KAAE,KAAK,KAAK,CAAC;CACnD;;IAkLA"}