RobinTail / express-zod-api / 13444086320

import * as R from "ramda";

import { responseVariants } from "./api-response";

import { FlatObject, getRoutePathParams } from "./common-helpers";

import { contentTypes } from "./content-type";

import { assertJsonCompatible } from "./deep-checks";

import { extractObjectSchema } from "./io-schema";

export class Diagnostics {

  readonly #trier = R.tryCatch(assertJsonCompatible);

  #verifiedEndpoints = new WeakSet<AbstractEndpoint>();

  #verifiedPaths = new WeakMap<

  >();

  constructor(protected logger: ActualLogger) {}

  public checkJsonCompat(endpoint: AbstractEndpoint, ctx: FlatObject): void {

    if (this.#verifiedEndpoints.has(endpoint)) return;

    if (endpoint.getRequestType() === "json") {

      this.#trier((reason) =>

        this.logger.warn(

          "The final input schema of the endpoint contains an unsupported JSON payload type.",

          Object.assign(ctx, { reason }),

        ),

      )(endpoint.getSchema("input"), "in");

    }

    for (const variant of responseVariants) {

      const catcher = this.#trier((reason) =>

        this.logger.warn(

          `The final ${variant} response schema of the endpoint contains an unsupported JSON payload type.`,

          Object.assign(ctx, { reason }),

        ),

      );

      for (const { mimeTypes, schema } of endpoint.getResponses(variant)) {

        catcher(schema, "out");

      }

    }

    this.#verifiedEndpoints.add(endpoint);

  }

  public checkPathParams(

    path: string,

    endpoint: AbstractEndpoint,

    ctx: FlatObject,

  ): void {

    const ref = this.#verifiedPaths.get(endpoint);

    const params = getRoutePathParams(path);

    if (params.length === 0) return; // next statement can be expensive

    const shape =

      ref?.shape || extractObjectSchema(endpoint.getSchema("input")).shape;

    for (const param of params) {

      this.logger.warn(

        "The input schema of the endpoint is most likely missing the parameter of the path it's assigned to.",

        Object.assign(ctx, { path, param }),

      );

    }

    if (ref) ref.paths.push(path);

    else this.#verifiedPaths.set(endpoint, { shape, paths: [path] });

  }

}