fixup! feat(server): Change the nest integration to support Nest features that were competing with Orpc

Author: Mathiasduc

packages/nest/src/filters/orpc-exception.filter.ts

@@ -45,7 +45,7 @@ const codec = new StandardOpenAPICodec(
 @Injectable()
 export class ORPCExceptionFilter implements ExceptionFilter {
   constructor(
-    private config: StandardServerNode.SendStandardResponseOptions | undefined,
+    private config?: StandardServerNode.SendStandardResponseOptions | undefined,
   ) {}
 
   async catch(exception: ORPCError<any, any>, host: ArgumentsHost) {

packages/nest/src/implement.test.ts

@@ -10,14 +10,15 @@ import { oc, ORPCError } from '@orpc/contract'
 import { implement, lazy } from '@orpc/server'
 import * as StandardServerNode from '@orpc/standard-server-node'
 import supertest from 'supertest'
-import { expect, it, vi } from 'vitest'
+import { beforeEach, describe, expect, it, vi } from 'vitest'
 import { z } from 'zod'
 import { ORPCExceptionFilter } from './filters/orpc-exception.filter'
 import { Implement } from './implement'
 import { ORPCModule } from './module'
+import * as Utils from './utils'
 
 const sendStandardResponseSpy = vi.spyOn(StandardServerNode, 'sendStandardResponse')
-const setStandardResponseSpy = vi.spyOn(StandardServerNode, 'setStandardResponse')
+const setStandardResponseSpy = vi.spyOn(Utils, 'setStandardNodeResponse')
 
 beforeEach(() => {
   vi.clearAllMocks()

packages/nest/src/implement.ts

@@ -19,7 +19,7 @@ import * as StandardServerFastify from '@orpc/standard-server-fastify'
 import * as StandardServerNode from '@orpc/standard-server-node'
 import { mergeMap } from 'rxjs'
 import { ORPC_MODULE_CONFIG_SYMBOL } from './module'
-import { toNestPattern } from './utils'
+import { setStandardFastifyResponse, setStandardNodeResponse, toNestPattern } from './utils'
 
 const MethodDecoratorMap = {
   HEAD: Head,
@@ -176,10 +176,10 @@ export class ImplementInterceptor implements NestInterceptor {
         })()
         // Set status and headers
         if ('raw' in res) {
-          return StandardServerFastify.setStandardResponse(res as FastifyReply, standardResponse, this.config)
+          return setStandardFastifyResponse(res as FastifyReply, standardResponse, this.config)
         }
         else {
-          return StandardServerNode.setStandardResponse(res as Response, standardResponse, this.config)
+          return setStandardNodeResponse(res as Response, standardResponse, this.config)
         }
       }),
     )

packages/nest/src/utils.ts

@@ -1,8 +1,14 @@
 import type { AnyContractRouter, HTTPPath } from '@orpc/contract'
+import type { StandardBody, StandardHeaders, StandardResponse } from '@orpc/standard-server'
+import type { NodeHttpResponse } from '@orpc/standard-server-node'
+import type { FastifyReply } from 'fastify/types/reply'
+import type { SendStandardResponseOptions } from '../../standard-server-aws-lambda/src'
+import { Readable } from 'node:stream'
 import { toHttpPath } from '@orpc/client/standard'
 import { ContractProcedure, isContractProcedure } from '@orpc/contract'
 import { standardizeHTTPPath } from '@orpc/openapi-client/standard'
 import { toArray } from '@orpc/shared'
+import { toNodeHttpBody } from '@orpc/standard-server-node'
 
 export function toNestPattern(path: HTTPPath): string {
   return standardizeHTTPPath(path)
@@ -54,3 +60,70 @@ export function populateContractRouterPaths<T extends AnyContractRouter>(router:
 
   return populated as any
 }
+
+export function setStandardFastifyResponse(
+  reply: FastifyReply,
+  standardResponse: StandardResponse,
+  options: SendStandardResponseOptions = { shouldStringifyBody: false },
+) {
+  if (options.shouldStringifyBody === undefined) {
+    options.shouldStringifyBody = false
+  }
+
+  return new Promise((resolve, reject) => {
+    reply.raw.once('error', reject)
+    reply.raw.once('close', resolve)
+
+    const resHeaders: StandardHeaders = { ...standardResponse.headers }
+
+    const resBody = toNodeHttpBody(standardResponse.body, resHeaders, options)
+
+    reply.code(standardResponse.status)
+    reply.headers(resHeaders)
+    return resolve(resBody)
+  })
+}
+
+export function setStandardNodeResponse(
+  res: NodeHttpResponse,
+  standardResponse: StandardResponse,
+  options: SendStandardResponseOptions = { shouldStringifyBody: false },
+): Promise<void | StandardBody | undefined> {
+  if (options.shouldStringifyBody === undefined) {
+    options.shouldStringifyBody = false
+  }
+
+  return new Promise((resolve, reject) => {
+    res.once('error', reject)
+    res.once('close', resolve)
+
+    const resHeaders: StandardHeaders = { ...standardResponse.headers }
+
+    const resBody = toNodeHttpBody(standardResponse.body, resHeaders, options)
+
+    res.statusCode = standardResponse.status
+    for (const [key, value] of Object.entries(resHeaders)) {
+      if (value !== undefined) {
+        res.setHeader(key, value)
+      }
+    }
+
+    if (resBody === undefined) {
+      return resolve(undefined)
+    }
+    else if (resBody instanceof Readable) {
+      res.once('close', () => {
+        if (!resBody.closed) {
+          resBody.destroy(res.errored ?? undefined)
+        }
+      })
+
+      resBody.once('error', error => res.destroy(error))
+
+      resBody.pipe(res)
+    }
+    else {
+      return resolve(resBody)
+    }
+  })
+}

packages/standard-server-fastify/src/response.ts

@@ -1,7 +1,7 @@
 import type { StandardHeaders, StandardResponse } from '@orpc/standard-server'
 import type { ToNodeHttpBodyOptions } from '@orpc/standard-server-node'
 import type { FastifyReply } from 'fastify'
-import { toNodeHttpBody, toResponseBody } from '@orpc/standard-server-node'
+import { toNodeHttpBody } from '@orpc/standard-server-node'
 
 export interface SendStandardResponseOptions extends ToNodeHttpBodyOptions { }
 
@@ -23,22 +23,3 @@ export function sendStandardResponse(
     reply.send(resBody)
   })
 }
-
-export function setStandardResponse(
-  reply: FastifyReply,
-  standardResponse: StandardResponse,
-  options: SendStandardResponseOptions = {},
-) {
-  return new Promise((resolve, reject) => {
-    reply.raw.once('error', reject)
-    reply.raw.once('close', resolve)
-
-    const resHeaders: StandardHeaders = { ...standardResponse.headers }
-
-    const resBody = toResponseBody(standardResponse.body, resHeaders, options)
-
-    reply.code(standardResponse.status)
-    reply.headers(resHeaders)
-    return resolve(resBody)
-  })
-}

packages/standard-server-node/src/body.ts

@@ -50,7 +50,9 @@ export function toStandardBody(req: NodeHttpRequest, options: ToStandardBodyOpti
   })
 }
 
-export interface ToNodeHttpBodyOptions extends ToEventStreamOptions {}
+export interface ToNodeHttpBodyOptions extends ToEventStreamOptions {
+  shouldStringifyBody?: boolean
+}
 
 /**
  * @param body
@@ -60,59 +62,11 @@ export interface ToNodeHttpBodyOptions extends ToEventStreamOptions {}
 export function toNodeHttpBody(
   body: StandardBody,
   headers: StandardHeaders,
-  options: ToNodeHttpBodyOptions = {},
+  options: ToNodeHttpBodyOptions = { shouldStringifyBody: true },
 ): Readable | undefined | string {
-  const currentContentDisposition = flattenHeader(headers['content-disposition'])
-
-  delete headers['content-type']
-  delete headers['content-disposition']
-
-  if (body === undefined) {
-    return
-  }
-
-  if (body instanceof Blob) {
-    headers['content-type'] = body.type
-    headers['content-length'] = body.size.toString()
-    headers['content-disposition'] = currentContentDisposition ?? generateContentDisposition(body instanceof File ? body.name : 'blob')
-
-    return Readable.fromWeb(body.stream())
+  if (options.shouldStringifyBody === undefined) {
+    options.shouldStringifyBody = true
   }
-
-  if (body instanceof FormData) {
-    const response = new Response(body)
-    headers['content-type'] = response.headers.get('content-type')!
-
-    return Readable.fromWeb(response.body!)
-  }
-
-  if (body instanceof URLSearchParams) {
-    headers['content-type'] = 'application/x-www-form-urlencoded'
-
-    return body.toString()
-  }
-
-  if (isAsyncIteratorObject(body)) {
-    headers['content-type'] = 'text/event-stream'
-
-    return toEventStream(body, options)
-  }
-
-  headers['content-type'] = 'application/json'
-
-  return stringifyJSON(body)
-}
-
-/**
- * @param body
- * @param headers - WARNING: The headers can be mutated by the function and may affect the original headers.
- * @param options
- */
-export function toResponseBody(
-  body: StandardBody,
-  headers: StandardHeaders,
-  options: ToNodeHttpBodyOptions = {},
-): Readable | undefined | StandardBody {
   const currentContentDisposition = flattenHeader(headers['content-disposition'])
 
   delete headers['content-type']
@@ -150,15 +104,11 @@ export function toResponseBody(
   }
 
   headers['content-type'] = 'application/json'
-  // It seems like Nest/Node, in case of a string body, remove or alter the string if
-  // content type json is not set.
-  // We also need to "double" stringify it, else the string will be encoded as an Array
-  // This match the behavior of #toNodeHttpBody
-  if (typeof body === 'string') {
-    return stringifyJSON(body)
-  }
 
-  return body
+  if (options.shouldStringifyBody === false && typeof body !== 'string') {
+    return body as unknown as string
+  }
+  return stringifyJSON(body)
 }
 
 function _streamToFormData(stream: Readable, contentType: string): Promise<FormData> {

packages/standard-server-node/src/response.ts

@@ -1,8 +1,7 @@
-import type { StandardBody, StandardHeaders, StandardResponse } from '@orpc/standard-server'
+import type { StandardHeaders, StandardResponse } from '@orpc/standard-server'
 import type { ToNodeHttpBodyOptions } from './body'
 import type { NodeHttpResponse } from './types'
-import { Readable } from 'node:stream'
-import { toNodeHttpBody, toResponseBody } from './body'
+import { toNodeHttpBody } from './body'
 
 export interface SendStandardResponseOptions extends ToNodeHttpBodyOptions {}
 
@@ -40,42 +39,3 @@ export function sendStandardResponse(
     }
   })
 }
-export function setStandardResponse(
-  res: NodeHttpResponse,
-  standardResponse: StandardResponse,
-  options: SendStandardResponseOptions = {},
-): Promise<void | StandardBody | undefined> {
-  return new Promise((resolve, reject) => {
-    res.once('error', reject)
-    res.once('close', resolve)
-
-    const resHeaders: StandardHeaders = { ...standardResponse.headers }
-
-    const resBody = toResponseBody(standardResponse.body, resHeaders, options)
-
-    res.statusCode = standardResponse.status
-    for (const [key, value] of Object.entries(resHeaders)) {
-      if (value !== undefined) {
-        res.setHeader(key, value)
-      }
-    }
-
-    if (resBody === undefined) {
-      return resolve(undefined)
-    }
-    else if (resBody instanceof Readable) {
-      res.once('close', () => {
-        if (!resBody.closed) {
-          resBody.destroy(res.errored ?? undefined)
-        }
-      })
-
-      resBody.once('error', error => res.destroy(error))
-
-      resBody.pipe(res)
-    }
-    else {
-      return resolve(resBody)
-    }
-  })
-}