@whook/whook/src/libs/body.ts

Build strong and efficient REST web services.

import { YHTTPError } from 'yhttperror';
import FirstChunkStream from 'first-chunk-stream';
import { YError } from 'yerror';
import { ensureResolvedObject, type OpenAPI } from 'ya-open-api-types';
import { pickFirstHeaderValue } from './headers.js';
import { Readable, type Transform } from 'node:stream';
import {
  type WhookDecoders,
  type WhookEncoders,
  type WhookParsers,
  type WhookStringifiers,
} from '../services/httpRouter.js';
import { type WhookOpenAPIOperation } from '../types/openapi.js';
import { type WhookResponse } from '../types/http.js';
import { type ExpressiveJSONSchema } from 'ya-json-schema-types';
import { type WhookRequestBody } from '../types/http.js';
import { type WhookBodySpec } from '../libs/router.js';

/* Architecture Note #2.11.3: Request body
According to the OpenAPI specification
there are two kinds of requests:
- **validated contents:** it implies to
 buffer their content and parse them to
 finally validate it. In that case, we
 provide it as a plain JS object to the
 routes handlers.
- **streamable contents:** often used
 for large files, those contents must
 be parsed and validated into the
 handler itself.
*/
export async function getBody(
  {
    DECODERS,
    PARSERS,
    API,
    bufferLimit,
  }: {
    DECODERS?: WhookDecoders<Transform>;
    PARSERS?: WhookParsers;
    API: OpenAPI;
    bufferLimit: number;
  },
  operation: WhookOpenAPIOperation,
  inputStream: Readable,
  bodySpec: WhookBodySpec,
): Promise<WhookRequestBody | undefined> {
  const bodyIsEmpty = !(bodySpec.contentType && bodySpec.contentLength);

  const requestBody =
    'requestBody' in operation && operation.requestBody
      ? await ensureResolvedObject(API, operation.requestBody)
      : undefined;
  const schemaObject = (await ensureResolvedObject(
    API,
    requestBody &&
      requestBody.content &&
      requestBody.content[bodySpec.contentType] &&
      requestBody.content[bodySpec.contentType].schema &&
      (requestBody.content[bodySpec.contentType]
        .schema as ExpressiveJSONSchema),
  )) as ExpressiveJSONSchema;
  const bodyIsBinary =
    typeof schemaObject === 'object' &&
    schemaObject !== null &&
    'type' in schemaObject &&
    schemaObject.type === 'string' &&
    'format' in schemaObject &&
    schemaObject.format === 'binary';

  if (bodyIsEmpty) {
    return;
  }

  if (bodyIsBinary) {
    return inputStream;
  }

  if (!PARSERS?.[bodySpec.contentType]) {
    return Promise.reject(
      new YHTTPError(500, 'E_PARSER_LACK', bodySpec.contentType),
    );
  }

  if (bodySpec.contentLength > bufferLimit) {
    throw new YHTTPError(
      400,
      'E_REQUEST_CONTENT_TOO_LARGE',
      bodySpec.contentLength,
      bufferLimit,
    );
  }

  const body: Buffer = await new Promise((resolve, reject) => {
    const Decoder = DECODERS?.[bodySpec.charset];

    if (!Decoder) {
      return Promise.reject(
        new YHTTPError(500, 'E_DECODER_LACK', bodySpec.charset),
      );
    }

    inputStream.on('error', (err: Error) => {
      reject(YHTTPError.wrap(err as Error, 400, 'E_REQUEST_FAILURE'));
    });
    inputStream.pipe(new Decoder()).pipe(
      new FirstChunkStream(
        {
          chunkSize: bufferLimit + 1,
        },
        async (chunk) => {
          if (bufferLimit >= chunk.length) {
            resolve(Buffer.from(chunk));
            return chunk;
          }

          reject(
            new YHTTPError(
              400,
              'E_REQUEST_CONTENT_TOO_LARGE',
              chunk.length,
              bufferLimit,
            ),
          );
          return FirstChunkStream.stop;
        },
      ),
    );
  });

  if (body.length !== bodySpec.contentLength) {
    throw new YHTTPError(
      400,
      'E_BAD_BODY_LENGTH',
      body.length,
      bodySpec.contentLength,
    );
  }

  try {
    return await new Promise<WhookRequestBody>((resolve, reject) => {
      try {
        resolve(PARSERS[bodySpec.contentType](body.toString(), bodySpec));
      } catch (err) {
        reject(err);
      }
    });
  } catch (err) {
    throw YHTTPError.wrap(err as Error, 400, 'E_BAD_BODY', body.toString());
  }
}

export async function sendBody(
  {
    ENCODERS,
    STRINGIFIERS,
  }: {
    ENCODERS?: WhookEncoders<Transform>;
    STRINGIFIERS?: WhookStringifiers;
  },
  response: WhookResponse,
): Promise<WhookResponse> {
  if (!response.body) {
    return response;
  }

  if (response.body instanceof Readable) {
    return response;
  }

  const responseContentType =
    pickFirstHeaderValue('content-type', response.headers || {}) ||
    'text/plain';

  if (!STRINGIFIERS?.[responseContentType]) {
    throw new YError(
      'E_STRINGIFYER_LACK',
      response.headers?.['content-type'],
      response,
    );
  }

  const Encoder = ENCODERS?.['utf-8'];

  if (!Encoder) {
    throw new YError('E_ENCODER_LACK', 'utf-8');
  }

  const stream = new Encoder();
  const content = STRINGIFIERS[responseContentType](response.body as string);

  stream.write(content);

  stream.end();

  return {
    ...response,
    headers: {
      'content-type': `${response.headers?.['content-type']}; charset=utf-8`,
      ...response.headers,
    },
    body: stream,
  };
}