@trpc/server 11.0.0-rc.348 → 11.0.0-rc.351

package/src/adapters/node-http/content-type/form-data/index.ts

@@ -1,37 +1,163 @@
-import { Readable } from 'stream';
+/**
+ * Copyright 2021 Remix Software Inc.
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+/**
+ * @link https://github.com/remix-run/remix/blob/0bcb4a304dd2f08f6032c3bf0c3aa7eb5b976901/packages/remix-server-runtime/formData.ts
+ */
+import * as fs from 'fs/promises';
+import { Readable } from 'node:stream';
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore the type definitions for this package are borked
+import { streamMultipart } from '@web3-storage/multipart-parser';
 // @trpc/server
-import type { AnyRouter } from '../../../../@trpc/server';
-import type { NodeHTTPRequest, NodeHTTPResponse } from '../../types';
-import type { NodeHTTPContentTypeHandler } from '../types';
-
-export const getFormDataContentTypeHandler: <
-  TRouter extends AnyRouter,
-  TRequest extends NodeHTTPRequest,
-  TResponse extends NodeHTTPResponse,
->() => NodeHTTPContentTypeHandler<TRouter, TRequest, TResponse> = () => ({
-  name: 'node-http-formdata',
-  isMatch: (headers) => {
-    return !!headers.get('content-type')?.startsWith('multipart/form-data');
-  },
-  async getInputs(opts, inputOpts) {
-    if (inputOpts.isBatchCall) {
-      throw new Error('Batch calls not supported for form-data');
-    }
+import { createNodeHTTPContentTypeHandler } from '../../internals/contentType';
+import type { NodeHTTPRequest } from '../../types';
+import { NodeOnDiskFile } from './fileUploadHandler';
+import type { UploadHandler, UploadHandlerPart } from './uploadHandler';
+import { MaxBodySizeExceededError } from './uploadHandler';
+
+const utfTextDecoder = new TextDecoder('utf-8');
+
+/**
+ * Allows you to handle multipart forms (file uploads) for your app.
+ * Request body parts with a 'filename' property will be treated as files.
+ * The rest will be treated as text.
+ * @param request The incoming Node HTTP request
+ * @param uploadHandler A function that handles file uploads and returns a value to be used in the request body. If uploaded to disk, the returned value is a NodeOnDiskFile. If uploaded to memory, the returned value is a File.
+ * @param maxBodySize The maximum size of the request body in bytes. Defaults to Infinity.
+ *
+ * @link https://remix.run/utils/parse-multipart-form-data
+ */
+async function parseMultipartFormData(
+  request: NodeHTTPRequest,
+  uploadHandler: UploadHandler,
+  maxBodySize = Infinity,
+) {
+  const contentType = request.headers['content-type'] ?? '';
+  const [type, boundary] = contentType.split(/\s*;\s*boundary=/);
+
+  if (!boundary || type !== 'multipart/form-data') {
+    throw new TypeError('Could not parse content as FormData.');
+  }
+
+  const formData = new FormData();
+  const parts: AsyncIterable<UploadHandlerPart & { done?: true }> =
+    streamMultipart(Readable.toWeb(request), boundary);
+
+  let currentBodySize = 0;
+
+  const nodeOnDiskFiles: NodeOnDiskFile[] = [];
+
+  try {
+    for await (const part of parts) {
+      if (part.done) break;
 
-    const contentType = opts.req.headers['content-type'];
-    if (!contentType) {
-      // Should be unreachable given the isMatch check
-      throw new Error('No content-type header found');
+      if (typeof part.filename === 'string') {
+        // This is a file, so the uploadHandler function will be called
+
+        // only pass basename as the multipart/form-data spec recommends
+        // https://datatracker.ietf.org/doc/html/rfc7578#section-4.2
+        part.filename = part.filename.split(/[/\\]/).pop();
+        const value = await uploadHandler(part as Required<typeof part>);
+
+        if (typeof value === 'undefined' || value === null) {
+          continue;
+        }
+        // add to cleanup array in case of error
+        if (value instanceof NodeOnDiskFile) {
+          nodeOnDiskFiles.push(value);
+        }
+
+        // if the combined size of the body exceeds the max size, throw an error
+        currentBodySize += value.size;
+        if (currentBodySize > maxBodySize) {
+          throw new MaxBodySizeExceededError(maxBodySize);
+        }
+        // add the file to the form data
+        formData.append(part.name, value as any);
+      } else {
+        // This is text, so we'll decode it and add it to the form data
+        let textualPart = '';
+        for await (const chunk of part.data) {
+          // if the combined size of the body exceeds the max size, throw an error
+          currentBodySize += chunk.length;
+          if (currentBodySize > maxBodySize) {
+            throw new MaxBodySizeExceededError(maxBodySize);
+          }
+          textualPart += utfTextDecoder.decode(chunk);
+        }
+        // add the text to the form data
+        formData.append(part.name, textualPart);
+      }
     }
 
-    const form = await new Request('https://unused.com', {
-      method: 'POST',
-      headers: { 'content-type': contentType },
-      body: Readable.toWeb(opts.req) as ReadableStream,
-      // @ts-expect-error - outdated types? this exists
-      duplex: 'half',
-    }).formData();
-
-    return form;
-  },
-});
+    return formData;
+  } catch (e) {
+    // clean up any files that were uploaded to disk if an error occurs
+    await Promise.all(
+      nodeOnDiskFiles.map((file) => fs.unlink(file.getFilePath())),
+    );
+    throw e;
+  }
+}
+
+function isMultipartFormDataRequest(req: NodeHTTPRequest) {
+  const contentTypeHeader = req.headers['content-type'];
+  return (
+    contentTypeHeader?.startsWith('multipart/form-data') ??
+    contentTypeHeader === 'application/x-www-form-urlencoded'
+  );
+}
+
+export const nodeHTTPFormDataContentTypeHandler =
+  createNodeHTTPContentTypeHandler({
+    isMatch(opts) {
+      return isMultipartFormDataRequest(opts.req);
+    },
+    async getBody(opts) {
+      const fields = Object.fromEntries(opts.query);
+
+      return {
+        ok: true,
+        data: fields,
+        preprocessed: false,
+      };
+    },
+    getInputs(opts) {
+      const req = opts.req;
+      const unparsedInput = req.query.get('input');
+      if (!unparsedInput) {
+        return {
+          0: undefined,
+        };
+      }
+      const transformer = opts.router._def._config.transformer;
+
+      const deserializedInput = transformer.input.deserialize(
+        JSON.parse(unparsedInput),
+      );
+      return {
+        0: deserializedInput,
+      };
+    },
+  });
+
+export {
+  NodeOnDiskFile as experimental_NodeOnDiskFile,
+  createFileUploadHandler as experimental_createFileUploadHandler,
+} from './fileUploadHandler';
+export { createMemoryUploadHandler as experimental_createMemoryUploadHandler } from './memoryUploadHandler';
+export {
+  MaxBodySizeExceededError,
+  MaxPartSizeExceededError,
+  composeUploadHandlers as experimental_composeUploadHandlers,
+  type UploadHandler,
+} from './uploadHandler';
+export {
+  isMultipartFormDataRequest as experimental_isMultipartFormDataRequest,
+  parseMultipartFormData as experimental_parseMultipartFormData,
+};

package/src/adapters/node-http/content-type/form-data/memoryUploadHandler.ts

@@ -0,0 +1,56 @@
+/**
+ * Copyright 2021 Remix Software Inc.
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+/**
+ * @link https://github.com/remix-run/remix/blob/0bcb4a304dd2f08f6032c3bf0c3aa7eb5b976901/packages/remix-server-runtime/upload/memoryUploadHandler.ts
+ */
+import type { UploadHandler } from './uploadHandler';
+import { MaxPartSizeExceededError } from './uploadHandler';
+
+export type MemoryUploadHandlerFilterArgs = {
+  filename?: string;
+  contentType: string;
+  name: string;
+};
+
+export type MemoryUploadHandlerOptions = {
+  /**
+   * The maximum upload size allowed. If the size is exceeded an error will be thrown.
+   * Defaults to 3000000B (3MB).
+   */
+  maxPartSize?: number;
+  /**
+   *
+   * @param filename
+   * @param mimetype
+   * @param encoding
+   */
+  filter?(args: MemoryUploadHandlerFilterArgs): Promise<boolean> | boolean;
+};
+
+export function createMemoryUploadHandler({
+  filter,
+  maxPartSize = 3000000,
+}: MemoryUploadHandlerOptions = {}): UploadHandler {
+  return async ({ filename, contentType, name, data }) => {
+    if (filter && !(await filter({ filename, contentType, name }))) {
+      return undefined;
+    }
+
+    let size = 0;
+    const chunks = [];
+    for await (const chunk of data) {
+      size += chunk.byteLength;
+      if (size > maxPartSize) {
+        throw new MaxPartSizeExceededError(name, maxPartSize);
+      }
+      chunks.push(chunk);
+    }
+
+    return new File(chunks, filename, { type: contentType });
+  };
+}

package/src/adapters/node-http/content-type/form-data/streamSlice.ts

@@ -0,0 +1,56 @@
+import type { TransformCallback } from 'node:stream';
+import { Transform } from 'node:stream';
+
+class SliceStream extends Transform {
+  private indexOffset = 0;
+  private emitUp = false;
+  private emitDown = false;
+
+  constructor(private startIndex = 0, private endIndex = Infinity) {
+    super();
+  }
+
+  override _transform(
+    chunk: any,
+    _: BufferEncoding,
+    done: TransformCallback,
+  ): void {
+    this.indexOffset += chunk.length;
+
+    if (!this.emitUp && this.indexOffset >= this.startIndex) {
+      this.emitUp = true;
+      const start = chunk.length - (this.indexOffset - this.startIndex);
+
+      if (this.indexOffset > this.endIndex) {
+        const end = chunk.length - (this.indexOffset - this.endIndex);
+        this.emitDown = true;
+        this.push(chunk.slice(start, end));
+      } else {
+        this.push(chunk.slice(start, chunk.length));
+      }
+
+      done();
+      return;
+    }
+
+    if (this.emitUp && !this.emitDown) {
+      if (this.indexOffset >= this.endIndex) {
+        this.emitDown = true;
+        this.push(
+          chunk.slice(0, chunk.length - (this.indexOffset - this.endIndex)),
+        );
+      } else {
+        this.push(chunk);
+      }
+
+      done();
+      return;
+    }
+
+    done();
+  }
+}
+
+export function streamSlice(startIndex = 0, endIndex = Infinity): SliceStream {
+  return new SliceStream(startIndex, endIndex);
+}

package/src/adapters/node-http/content-type/form-data/uploadHandler.ts

@@ -0,0 +1,89 @@
+import type { NodeOnDiskFile } from './fileUploadHandler';
+
+/**
+ * @link https://github.com/remix-run/remix/blob/0bcb4a304dd2f08f6032c3bf0c3aa7eb5b976901/packages/remix-server-runtime/formData.ts
+ */
+export type UploadHandlerPart = {
+  name: string;
+  filename?: string;
+  contentType: string;
+  data: AsyncIterable<Uint8Array>;
+};
+
+export type UploadHandler = (
+  part: Required<UploadHandlerPart>,
+) => Promise<File | NodeOnDiskFile | null | undefined>;
+
+export function composeUploadHandlers(
+  ...handlers: UploadHandler[]
+): UploadHandler {
+  return async (part) => {
+    for (const handler of handlers) {
+      const value = await handler(part);
+      if (typeof value !== 'undefined' && value !== null) {
+        return value;
+      }
+    }
+
+    return undefined;
+  };
+}
+
+export class MaxPartSizeExceededError extends Error {
+  constructor(public field: string, public maxBytes: number) {
+    super(`Field "${field}" exceeded upload size of ${maxBytes} bytes.`);
+  }
+}
+
+export class MaxBodySizeExceededError extends Error {
+  constructor(public maxBytes: number) {
+    super(`Body exceeded upload size of ${maxBytes} bytes.`);
+  }
+}
+
+export type MemoryUploadHandlerFilterArgs = {
+  filename?: string;
+  contentType: string;
+  name: string;
+};
+
+export type MemoryUploadHandlerOptions = {
+  /**
+   * The maximum upload size allowed. If the size is exceeded an error will be thrown.
+   * Defaults to 3000000B (3MB).
+   */
+  maxPartSize?: number;
+  /**
+   *
+   * @param filename
+   * @param mimetype
+   * @param encoding
+   */
+  filter?(args: MemoryUploadHandlerFilterArgs): Promise<boolean> | boolean;
+};
+
+/**
+ * @see
+ */
+export function createMemoryUploadHandler({
+  filter,
+  maxPartSize = 3000000,
+}: MemoryUploadHandlerOptions = {}): UploadHandler {
+  return async ({ filename, contentType, name, data }) => {
+    if (filter && !(await filter({ filename, contentType, name }))) {
+      return undefined;
+    }
+
+    let size = 0;
+    const chunks = [];
+    for await (const chunk of data) {
+      size += chunk.byteLength;
+      if (size > maxPartSize) {
+        throw new MaxPartSizeExceededError(name, maxPartSize);
+      }
+      chunks.push(chunk);
+    }
+
+    return new File(chunks, filename, { type: contentType });
+  };
+}

package/src/adapters/node-http/content-type/json/getPostBody.ts

@@ -9,6 +9,22 @@ export async function getPostBody(opts: {
 }): Promise<BodyResult> {
   const { req, maxBodySize = Infinity } = opts;
   return new Promise((resolve) => {
+    if (
+      !req.headers['content-type']?.startsWith('application/json') &&
+      (!req.method ||
+        (req.method !== 'GET' &&
+          req.method !== 'OPTIONS' &&
+          req.method !== 'HEAD'))
+    ) {
+      resolve({
+        ok: false,
+        error: new TRPCError({
+          code: 'UNSUPPORTED_MEDIA_TYPE',
+          message: 'Invalid Content-Type header (expected application/json)',
+        }),
+      });
+      return;
+    }
     if ('body' in req) {
       resolve({
         ok: true,
@@ -19,25 +35,18 @@ export async function getPostBody(opts: {
       });
       return;
     }
-
     let body = '';
     let hasBody = false;
-
-    function onData(data: any) {
+    req.on('data', function (data) {
       body += data;
       hasBody = true;
       if (body.length > maxBodySize) {
-        req.off('data', onData);
-
         resolve({
           ok: false,
           error: new TRPCError({ code: 'PAYLOAD_TOO_LARGE' }),
         });
       }
-    }
-
-    req.on('data', onData);
-
+    });
     req.on('end', () => {
       resolve({
         ok: true,

package/src/adapters/node-http/content-type/json/index.ts

@@ -1,91 +1,11 @@
-// @trpc/server
-import { TRPCError } from '../../../../@trpc/server';
-import type {
-  AnyRouter,
-  CombinedDataTransformer,
-} from '../../../../@trpc/server';
-import type { NodeHTTPRequest, NodeHTTPResponse } from '../../types';
-import type { NodeHTTPContentTypeHandler } from '../types';
+import { getJsonContentTypeInputs } from '../../../../@trpc/server/http';
+import { createNodeHTTPContentTypeHandler } from '../../internals/contentType';
 import { getPostBody } from './getPostBody';
 
-export const getNodeHTTPJSONContentTypeHandler: <
-  TRouter extends AnyRouter,
-  TRequest extends NodeHTTPRequest,
-  TResponse extends NodeHTTPResponse,
->() => NodeHTTPContentTypeHandler<TRouter, TRequest, TResponse> = () => ({
-  name: 'node-http-json',
-  isMatch: (headers) => {
-    return !!headers.get('content-type')?.startsWith('application/json');
-  },
-  getInputs: async (opts, info) => {
-    const bodyResult = await getPostBody(opts);
-    if (!bodyResult.ok) {
-      throw bodyResult.error;
-    }
-
-    const preprocessedBody = bodyResult.preprocessed;
-    const body = bodyResult.data;
-
-    function getRawProcedureInputOrThrow() {
-      try {
-        if (opts.req.method === 'GET') {
-          const input = opts.query.get('input');
-          if (!input) {
-            return undefined;
-          }
-
-          return JSON.parse(input);
-        }
-
-        if (preprocessedBody || typeof body !== 'string') {
-          // Some tools like nextjs may parse json
-          // requests before they reach us. So we just use them as is
-          return body;
-        } else {
-          return JSON.parse(body);
-        }
-      } catch (cause) {
-        throw new TRPCError({
-          code: 'PARSE_ERROR',
-          cause,
-        });
-      }
-    }
-
-    const deserializeInputValue = (
-      rawValue: unknown,
-      transformer: CombinedDataTransformer,
-    ) => {
-      return typeof rawValue !== 'undefined'
-        ? transformer.input.deserialize(rawValue)
-        : rawValue;
-    };
-
-    const rawInput = getRawProcedureInputOrThrow();
-    if (rawInput === undefined) {
-      return undefined;
-    }
-
-    const transformer = opts.router._def._config.transformer;
-
-    if (!info.isBatchCall) {
-      return deserializeInputValue(rawInput, transformer);
-    }
-
-    /* istanbul ignore if  */
-    if (
-      rawInput == null ||
-      typeof rawInput !== 'object' ||
-      Array.isArray(rawInput)
-    ) {
-      throw new TRPCError({
-        code: 'BAD_REQUEST',
-        message: '"input" needs to be an object when doing a batch call',
-      });
-    }
-
-    const rawValue = rawInput[info.batch];
-
-    return deserializeInputValue(rawValue, transformer);
+export const nodeHTTPJSONContentTypeHandler = createNodeHTTPContentTypeHandler({
+  isMatch(opts) {
+    return !!opts.req.headers['content-type']?.startsWith('application/json');
   },
+  getBody: getPostBody,
+  getInputs: getJsonContentTypeInputs,
 });

package/src/adapters/node-http/{content-type/types.ts → internals/contentType.ts}

@@ -9,11 +9,23 @@ import type {
 } from '../types';
 
 export interface NodeHTTPContentTypeHandler<
-  TRouter extends AnyRouter,
   TRequest extends NodeHTTPRequest,
   TResponse extends NodeHTTPResponse,
 > extends BaseContentTypeHandler<
-    NodeHTTPRequestHandlerOptions<TRouter, TRequest, TResponse> & {
+    NodeHTTPRequestHandlerOptions<AnyRouter, TRequest, TResponse> & {
       query: URLSearchParams;
     }
   > {}
+
+export function createNodeHTTPContentTypeHandler(
+  contentTypeHandler: NodeHTTPContentTypeHandler<
+    NodeHTTPRequest,
+    NodeHTTPResponse
+  >,
+) {
+  return <
+    TRequest extends NodeHTTPRequest,
+    TResponse extends NodeHTTPResponse,
+  >(): NodeHTTPContentTypeHandler<TRequest, TResponse> =>
+    contentTypeHandler as any;
+}

package/src/adapters/node-http/nodeHTTPRequestHandler.ts

@@ -8,7 +8,6 @@
  * ```
  */
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
-
 // @trpc/server
 import type { AnyRouter } from '../../@trpc/server';
 import type {
@@ -21,16 +20,16 @@ import {
   getBatchStreamFormatter,
   resolveHTTPResponse,
 } from '../../@trpc/server/http';
-import { selectContentHandlerOrUnsupportedMediaType } from '../content-handlers/selectContentHandlerOrUnsupportedMediaType';
-import { getFormDataContentTypeHandler } from './content-type/form-data';
-import { getNodeHTTPJSONContentTypeHandler } from './content-type/json';
-import { getOctetContentTypeHandler } from './content-type/octet';
+import { nodeHTTPJSONContentTypeHandler } from './content-type/json';
+import type { NodeHTTPContentTypeHandler } from './internals/contentType';
 import type {
   NodeHTTPRequest,
   NodeHTTPRequestHandlerOptions,
   NodeHTTPResponse,
 } from './types';
 
+const defaultJSONContentTypeHandler = nodeHTTPJSONContentTypeHandler();
+
 export async function nodeHTTPRequestHandler<
   TRouter extends AnyRouter,
   TRequest extends NodeHTTPRequest,
@@ -57,10 +56,38 @@ export async function nodeHTTPRequestHandler<
       ? new URLSearchParams(opts.req.query as any)
       : new URLSearchParams(opts.req.url!.split('?')[1]);
 
+    const jsonContentTypeHandler =
+      defaultJSONContentTypeHandler as unknown as NodeHTTPContentTypeHandler<
+        TRequest,
+        TResponse
+      >;
+
+    const contentTypeHandlers = opts.experimental_contentTypeHandlers ?? [
+      jsonContentTypeHandler,
+    ];
+
+    const contentTypeHandler =
+      contentTypeHandlers.find((handler) =>
+        handler.isMatch({
+          // FIXME: no typecasting should be needed here
+          ...(opts as any),
+          query,
+        }),
+      ) ??
+      // fallback to json
+      jsonContentTypeHandler;
+
+    const bodyResult = await contentTypeHandler.getBody({
+      // FIXME: no typecasting should be needed here
+      ...(opts as any),
+      query,
+    });
+
     const req: HTTPRequest = {
       method: opts.req.method!,
       headers: opts.req.headers,
       query,
+      body: bodyResult.ok ? bodyResult.data : undefined,
     };
 
     let isStream = false;
@@ -106,33 +133,19 @@ export async function nodeHTTPRequestHandler<
       }
     };
 
-    const [contentTypeHandler, unsupportedMediaTypeError] =
-      selectContentHandlerOrUnsupportedMediaType(
-        [
-          getNodeHTTPJSONContentTypeHandler<TRouter, TRequest, TResponse>(),
-          getFormDataContentTypeHandler<TRouter, TRequest, TResponse>(),
-          getOctetContentTypeHandler<TRouter, TRequest, TResponse>(),
-        ],
-        { ...opts, query },
-      );
-
     await resolveHTTPResponse<TRouter, HTTPRequest>({
       ...opts,
       req,
       createContext,
-      error: unsupportedMediaTypeError,
+      error: bodyResult.ok ? null : bodyResult.error,
+      preprocessedBody: bodyResult.ok ? bodyResult.preprocessed : false,
       onError(o) {
         opts?.onError?.({
           ...o,
           req: opts.req,
         });
       },
-      async getInput(inputsOpts) {
-        return await contentTypeHandler?.getInputs(
-          { ...opts, query },
-          inputsOpts,
-        );
-      },
+      contentTypeHandler,
       unstable_onHead,
       unstable_onChunk,
     });