@nmtjs/http-transport 0.15.0-beta.2 → 0.15.0-beta.4

package/src/server.ts

@@ -0,0 +1,365 @@
+import { Buffer } from 'node:buffer'
+import { Duplex, Readable } from 'node:stream'
+
+import type {
+  GatewayApiCallOptions,
+  TransportWorker,
+  TransportWorkerParams,
+} from '@nmtjs/gateway'
+import { anyAbortSignal, isAbortError, isAsyncIterable } from '@nmtjs/common'
+import { provide } from '@nmtjs/core'
+import {
+  ConnectionType,
+  ErrorCode,
+  ProtocolBlob,
+  ProtocolVersion,
+} from '@nmtjs/protocol'
+import {
+  ProtocolClientStream,
+  ProtocolError,
+  UnsupportedContentTypeError,
+  UnsupportedFormatError,
+} from '@nmtjs/protocol/server'
+
+import type {
+  HttpAdapterParams,
+  HttpAdapterServer,
+  HttpAdapterServerFactory,
+  HttpTransportCorsCustomParams,
+  HttpTransportCorsOptions,
+  HttpTransportOptions,
+  HttpTransportServerRequest,
+} from './types.ts'
+import {
+  AllowedHttpMethod,
+  HttpCodeMap,
+  HttpStatus,
+  HttpStatusText,
+} from './constants.ts'
+import * as injections from './injectables.ts'
+
+const NEEMATA_BLOB_HEADER = 'X-Neemata-Blob'
+const DEFAULT_ALLOWED_METHODS = Object.freeze(['post']) as ('get' | 'post')[]
+const DEFAULT_CORS_PARAMS = Object.freeze({
+  allowCredentials: 'true',
+  allowMethods: ['GET', 'POST'],
+  allowHeaders: [
+    'Content-Type',
+    'Content-Disposition',
+    'Content-Length',
+    'Accept',
+    'Transfer-Encoding',
+  ],
+  maxAge: undefined,
+  requestMethod: undefined,
+  exposeHeaders: [],
+  requestHeaders: [],
+}) satisfies HttpTransportCorsCustomParams
+const CORS_HEADERS_MAP: Record<
+  keyof HttpTransportCorsCustomParams | 'origin',
+  string
+> = {
+  origin: 'Access-Control-Allow-Origin',
+  allowMethods: 'Access-Control-Allow-Methods',
+  allowHeaders: 'Access-Control-Allow-Headers',
+  allowCredentials: 'Access-Control-Allow-Credentials',
+  maxAge: 'Access-Control-Max-Age',
+  exposeHeaders: 'Access-Control-Expose-Headers',
+  requestHeaders: 'Access-Control-Request-Headers',
+  requestMethod: 'Access-Control-Request-Method',
+}
+
+export function createHTTPTransportWorker(
+  adapterFactory: HttpAdapterServerFactory<any>,
+  options: HttpTransportOptions,
+): TransportWorker<ConnectionType.Unidirectional> {
+  return new HttpTransportServer(adapterFactory, options)
+}
+
+export class HttpTransportServer
+  implements TransportWorker<ConnectionType.Unidirectional>
+{
+  #server: HttpAdapterServer
+  #corsOptions?:
+    | null
+    | true
+    | string[]
+    | HttpTransportCorsOptions
+    | ((origin: string) => boolean | HttpTransportCorsOptions)
+
+  params!: TransportWorkerParams<ConnectionType.Unidirectional>
+
+  constructor(
+    protected readonly adapterFactory: HttpAdapterServerFactory<any>,
+    protected readonly options: HttpTransportOptions,
+  ) {
+    this.#server = this.createServer()
+    this.#corsOptions = this.options.cors
+  }
+
+  async start(hooks: TransportWorkerParams<ConnectionType.Unidirectional>) {
+    this.params = hooks
+    return await this.#server.start()
+  }
+
+  async stop() {
+    await this.#server.stop()
+  }
+
+  async httpHandler(
+    request: HttpTransportServerRequest,
+    body: ReadableStream | null,
+    requestSignal: AbortSignal,
+  ): Promise<Response> {
+    const url = new URL(request.url)
+    const procedure = url.pathname.slice(1) // remove leading '/'
+    const method = request.method.toLowerCase()
+    const origin = request.headers.get('origin')
+    const responseHeaders = new Headers()
+    if (origin) this.applyCors(origin, request, responseHeaders)
+
+    // Handle preflight requests
+    if (method === 'options') {
+      return new Response(null, {
+        status: HttpStatus.OK,
+        headers: responseHeaders,
+      })
+    }
+
+    const controller = new AbortController()
+    const signal = anyAbortSignal(requestSignal, controller.signal)
+    const canHaveBody = method !== 'get'
+    const isBlob = request.headers.get(NEEMATA_BLOB_HEADER) === 'true'
+    const contentType = request.headers.get('content-type')
+    const accept = request.headers.get('accept') || '*/*'
+
+    await using connection = await this.params.onConnect({
+      accept,
+      contentType: isBlob ? '*/*' : contentType,
+      data: request,
+      protocolVersion: ProtocolVersion.v1,
+      type: ConnectionType.Unidirectional,
+    })
+
+    try {
+      // Parse request body if present
+      let payload: any
+      if (canHaveBody && body) {
+        const bodyStream = Readable.fromWeb(body as any)
+        const cannotDecode =
+          !contentType || !this.params.formats.supportsDecoder(contentType)
+        if (isBlob || cannotDecode) {
+          const type = contentType || 'application/octet-stream'
+          const contentLength = request.headers.get('content-length')
+          const size = contentLength
+            ? Number.parseInt(contentLength)
+            : undefined
+          payload = new ProtocolClientStream(-1, { size, type })
+          bodyStream.pipe(payload)
+        } else {
+          const buffer = Buffer.concat(await bodyStream.toArray())
+          if (buffer.byteLength > 0) {
+            payload = connection.decoder.decode(buffer)
+          }
+        }
+      } else {
+        const querystring = url.searchParams.get('payload')
+        if (querystring) {
+          payload = JSON.parse(querystring)
+        }
+      }
+
+      const metadata: GatewayApiCallOptions['metadata'] = (metadata) => {
+        const allowHttpMethod =
+          metadata.get(AllowedHttpMethod) ?? DEFAULT_ALLOWED_METHODS
+        if (!allowHttpMethod.includes(method as any)) {
+          throw new ProtocolError(ErrorCode.NotFound)
+        }
+      }
+
+      const result = await this.params.onRpc(
+        connection,
+        {
+          callId: 0, // since the connection is closed after the call, only one call exists per connection
+          payload,
+          procedure,
+          metadata,
+        },
+        signal,
+        provide(injections.httpResponseHeaders, responseHeaders),
+      )
+
+      // Handle blob responses
+      if (result instanceof ProtocolBlob) {
+        const { source, metadata } = result
+        const { type } = metadata
+
+        responseHeaders.set(NEEMATA_BLOB_HEADER, 'true')
+        responseHeaders.set('Content-Type', type)
+        if (metadata.size) {
+          responseHeaders.set('Content-Length', metadata.size.toString())
+        }
+
+        // Convert source to ReadableStream
+        let stream: ReadableStream
+
+        if (source instanceof ReadableStream) {
+          stream = source
+        } else if (source instanceof Readable || source instanceof Duplex) {
+          stream = Readable.toWeb(source) as unknown as ReadableStream
+        } else {
+          throw new Error('Invalid stream source')
+        }
+
+        return new Response(stream, {
+          status: HttpStatus.OK,
+          statusText: HttpStatusText[HttpStatus.OK],
+          headers: responseHeaders,
+        })
+      } else if (isAsyncIterable(result)) {
+        responseHeaders.set('Content-Type', connection.encoder.contentType)
+        responseHeaders.set('Transfer-Encoding', 'chunked')
+        const stream = new ReadableStream({
+          async start(controller) {
+            try {
+              for await (const chunk of result) {
+                const encoded = connection.encoder.encode(chunk)
+                const base64 = Buffer.from(
+                  encoded.buffer,
+                  encoded.byteOffset,
+                  encoded.byteLength,
+                ).toString('base64')
+                controller.enqueue(`data: ${base64}\n\n`)
+              }
+              controller.close()
+            } catch (error) {
+              if (isAbortError(error)) controller.close()
+              else controller.error(error)
+            }
+          },
+        })
+        return new Response(stream, {
+          status: HttpStatus.OK,
+          statusText: HttpStatusText[HttpStatus.OK],
+          headers: responseHeaders,
+        })
+      } else {
+        // Handle regular responses
+        const buffer = connection.encoder.encode(result)
+        responseHeaders.set('Content-Type', connection.encoder.contentType)
+
+        // @ts-expect-error
+        return new Response(buffer, {
+          status: HttpStatus.OK,
+          statusText: HttpStatusText[HttpStatus.OK],
+          headers: responseHeaders,
+        })
+      }
+    } catch (error) {
+      console.error(error)
+      if (error instanceof UnsupportedFormatError) {
+        const status =
+          error instanceof UnsupportedContentTypeError
+            ? HttpStatus.UnsupportedMediaType
+            : HttpStatus.NotAcceptable
+        const text = HttpStatusText[status]
+
+        return new Response(text, {
+          status,
+          statusText: text,
+          headers: responseHeaders,
+        })
+      }
+
+      if (error instanceof ProtocolError) {
+        const status =
+          error.code in HttpCodeMap
+            ? HttpCodeMap[error.code]
+            : HttpStatus.InternalServerError
+        const text = HttpStatusText[status]
+        const payload = connection.encoder.encode(error)
+        responseHeaders.set('Content-Type', connection.encoder.contentType)
+
+        // @ts-expect-error
+        return new Response(payload, {
+          status,
+          statusText: text,
+          headers: responseHeaders,
+        })
+      }
+
+      // Unknown error
+      // this.logError(error, 'Unknown error while processing HTTP request')
+      console.error(error)
+
+      const payload = connection.encoder.encode(
+        new ProtocolError(
+          ErrorCode.InternalServerError,
+          'Internal Server Error',
+        ),
+      )
+      responseHeaders.set('Content-Type', connection.encoder.contentType)
+
+      // @ts-expect-error
+      return new Response(payload, {
+        status: HttpStatus.InternalServerError,
+        statusText: HttpStatusText[HttpStatus.InternalServerError],
+        headers: responseHeaders,
+      })
+    }
+  }
+
+  private applyCors(
+    origin: string,
+    request: HttpTransportServerRequest,
+    headers: Headers,
+  ) {
+    if (!this.#corsOptions) return
+
+    let params: HttpTransportCorsCustomParams | null = null
+
+    if (this.options.cors === true) {
+      params = { ...DEFAULT_CORS_PARAMS }
+    } else if (
+      Array.isArray(this.options.cors) &&
+      this.options.cors.includes(origin)
+    ) {
+      params = { ...DEFAULT_CORS_PARAMS }
+    } else if (typeof this.options.cors === 'function') {
+      const result = this.options.cors(origin, request)
+      if (typeof result === 'boolean') {
+        if (result) {
+          params = { ...DEFAULT_CORS_PARAMS }
+        }
+      } else if (typeof result === 'object') {
+        params = { ...DEFAULT_CORS_PARAMS }
+        for (const key in DEFAULT_CORS_PARAMS) {
+          params[key] = result[key]
+        }
+      }
+    }
+
+    if (params === null) return
+
+    headers.set(CORS_HEADERS_MAP.origin, origin)
+
+    for (const key in params) {
+      const header = CORS_HEADERS_MAP[key]
+      if (header) {
+        let value = params[key]
+        if (Array.isArray(value)) value = value.filter(Boolean).join(', ')
+        if (value) headers.set(header, value)
+      }
+    }
+  }
+
+  private createServer() {
+    // const hooks = this.createWsHooks()
+    const opts: HttpAdapterParams = {
+      ...this.options,
+      // logger: this.logger.child({ $lable: 'WsServer' }),
+      fetchHandler: this.httpHandler.bind(this),
+    }
+    return this.adapterFactory(opts)
+  }
+}

package/src/types.ts

@@ -0,0 +1,102 @@
+import type { Async, OneOf } from '@nmtjs/common'
+
+export type HttpTransportServerRequest = {
+  url: URL
+  method: string
+  headers: Headers
+}
+
+export type HttpTransportOptions<
+  R extends keyof HttpTransportRuntimes = keyof HttpTransportRuntimes,
+> = {
+  listen: HttpTransportListenOptions
+  cors?: HttpTransportCorsOptions
+  tls?: HttpTransportTlsOptions
+  runtime?: HttpTransportRuntimes[R]
+}
+
+export type HttpTransportCorsCustomParams = {
+  allowMethods?: string[]
+  allowHeaders?: string[]
+  allowCredentials?: string
+  maxAge?: string
+  exposeHeaders?: string[]
+  requestHeaders?: string[]
+  requestMethod?: string
+}
+
+export type HttpTransportCorsOptions =
+  | true
+  | string[]
+  | HttpTransportCorsCustomParams
+  | ((
+      origin: string,
+      request: HttpTransportServerRequest,
+    ) => boolean | HttpTransportCorsCustomParams)
+
+export type HttpTransportListenOptions = OneOf<
+  [{ port: number; hostname?: string; reusePort?: boolean }, { unix: string }]
+>
+
+export type HttpTransportRuntimeBun = Partial<
+  Pick<
+    import('bun').Serve.Options<undefined>,
+    'development' | 'id' | 'maxRequestBodySize' | 'idleTimeout' | 'ipv6Only'
+  > &
+    import('bun').Serve.Routes<any, any>
+>
+
+export type HttpTransportRuntimeNode = {}
+
+export type HttpTransportRuntimeDeno = {}
+
+export type HttpTransportRuntimes = {
+  bun: HttpTransportRuntimeBun
+  node: HttpTransportRuntimeNode
+  deno: HttpTransportRuntimeDeno
+}
+
+export type HttpTransportTlsOptions = {
+  /**
+   * File path or inlined TLS certificate in PEM format (required).
+   */
+  cert?: string
+  /**
+   * File path or inlined TLS private key in PEM format (required).
+   */
+  key?: string
+  /**
+   * Passphrase for the private key (optional).
+   */
+  passphrase?: string
+}
+
+export type HttpAdapterParams<
+  R extends keyof HttpTransportRuntimes = keyof HttpTransportRuntimes,
+> = {
+  listen: HttpTransportListenOptions
+  fetchHandler: (
+    request: HttpTransportServerRequest,
+    body: ReadableStream | null,
+    signal: AbortSignal,
+  ) => Async<Response>
+  cors?: HttpTransportCorsOptions
+  tls?: HttpTransportTlsOptions
+  runtime?: HttpTransportRuntimes[R]
+}
+
+export type DenoServer = ReturnType<typeof globalThis.Deno.serve>
+
+export interface HttpAdapterServer {
+  runtime: {
+    bun?: import('bun').Server<undefined>
+    node?: import('uWebSockets.js').TemplatedApp
+    deno?: DenoServer
+  }
+  stop: () => Async<any>
+  start: () => Async<string>
+}
+
+export type HttpAdapterServerFactory<
+  R extends keyof HttpTransportRuntimes = keyof HttpTransportRuntimes,
+> = (params: HttpAdapterParams<R>) => HttpAdapterServer

package/src/utils.ts

@@ -0,0 +1,28 @@
+import { ErrorCode } from '@nmtjs/protocol'
+import { ProtocolError } from '@nmtjs/protocol/server'
+
+export const InternalError = (message = 'Internal Server Error') =>
+  new ProtocolError(ErrorCode.InternalServerError, message)
+
+export const NotFoundError = (message = 'Not Found') =>
+  new ProtocolError(ErrorCode.NotFound, message)
+
+export const ForbiddenError = (message = 'Forbidden') =>
+  new ProtocolError(ErrorCode.Forbidden, message)
+
+export const RequestTimeoutError = (message = 'Request Timeout') =>
+  new ProtocolError(ErrorCode.RequestTimeout, message)
+
+export const NotFoundHttpResponse = () =>
+  new Response('Not Found', {
+    status: 404,
+    headers: { 'Content-Type': 'text/plain' },
+  })
+
+export const InternalServerErrorHttpResponse = () =>
+  new Response('Internal Server Error', {
+    status: 500,
+    headers: { 'Content-Type': 'text/plain' },
+  })
+
+export const StatusResponse = () => new Response('OK', { status: 200 })