openapi-ts / packages / openapi-python / src / createClient.ts

import path from 'node:path';

import { type Logger, Project } from '@hey-api/codegen-core';
import { $RefParser } from '@hey-api/json-schema-ref-parser';
import {
  applyNaming,
  buildGraph,
  compileInputPath,
  Context,
  getSpec,
  type Input,
  logInputPaths,
  type OpenApi,
  parseOpenApiSpec,
  patchOpenApiSpec,
  postprocessOutput,
  type WatchValues,
} from '@hey-api/shared';
import colors from 'ansi-colors';

import { postProcessors } from './config/output/postprocess';
import type { Config } from './config/types';
import { generateOutput } from './generate/output';
import { PythonRenderer } from './py-dsl';

export async function createClient({
  config,
  dependencies,
  jobIndex,
  logger,
  watches: _watches,
}: {
  config: Config;
  dependencies: Record<string, string>;
  jobIndex: number;
  logger: Logger;
  /**
   * Always undefined on the first run, defined on subsequent runs.
   */
  watches?: ReadonlyArray<WatchValues>;
}): Promise<Context | undefined> {
  const watches: ReadonlyArray<WatchValues> =
    _watches ||
    Array.from({ length: config.input.length }, () => ({
      headers: new Headers(),
    }));

  const inputPaths = config.input.map((input) => compileInputPath(input));

  // on first run, print the message as soon as possible
  if (config.logs.level !== 'silent' && !_watches) {
    logInputPaths(inputPaths, jobIndex);
  }

  const getSpecData = async (input: Input, index: number) => {
    const eventSpec = logger.timeEvent('spec');
    const { arrayBuffer, error, resolvedInput, response } = await getSpec({
      fetchOptions: input.fetch,
      inputPath: inputPaths[index]!.path,
      timeout: input.watch.timeout,
      watch: watches[index]!,
    });
    eventSpec.timeEnd();

    // throw on first run if there's an error to preserve user experience
    // if in watch mode, subsequent errors won't throw to gracefully handle
    // cases where server might be reloading
    if (error && !_watches) {
      const text = await response.text().catch(() => '');
      throw new Error(
        `Request failed with status ${response.status}: ${text || response.statusText}`,
      );
    }

    return { arrayBuffer, resolvedInput };
  };
  const specData = (
    await Promise.all(config.input.map((input, index) => getSpecData(input, index)))
  ).filter((data) => data.arrayBuffer || data.resolvedInput);

  let context: Context | undefined;

  if (specData.length) {
    const refParser = new $RefParser();
    const data =
      specData.length > 1
        ? await refParser.bundleMany({
            arrayBuffer: specData.map((data) => data.arrayBuffer!),
            pathOrUrlOrSchemas: [],
            resolvedInputs: specData.map((data) => data.resolvedInput!),
          })
        : await refParser.bundle({
            arrayBuffer: specData[0]!.arrayBuffer,
            pathOrUrlOrSchema: undefined,
            resolvedInput: specData[0]!.resolvedInput!,
          });

    // on subsequent runs in watch mode, print the message only if we know we're
    // generating the output
    if (config.logs.level !== 'silent' && _watches) {
      console.clear();
      logInputPaths(inputPaths, jobIndex);
    }

    const eventInputPatch = logger.timeEvent('input.patch');
    await patchOpenApiSpec({ patchOptions: config.parser.patch, spec: data });
    eventInputPatch.timeEnd();

    const eventParser = logger.timeEvent('parser');
    // TODO: allow overriding via config
    const project = new Project({
      defaultFileName: '__init__',
      fileName: (base) => {
        const name = applyNaming(base, config.output.fileName);
        const { suffix } = config.output.fileName;
        if (!suffix) {
          return name;
        }
        return name === '__init__' || name.endsWith(suffix) ? name : `${name}${suffix}`;
      },
      nameConflictResolvers: config.output.nameConflictResolver
        ? {
            typescript: config.output.nameConflictResolver,
          }
        : undefined,
      renderers: [
        new PythonRenderer({
          header: config.output.header,
          preferExportAll: config.output.preferExportAll,
          preferFileExtension: config.output.importFileExtension || undefined,
          resolveModuleName: config.output.resolveModuleName,
        }),
      ],
      root: config.output.path,
    });
    context = new Context<OpenApi.V2_0_X | OpenApi.V3_0_X | OpenApi.V3_1_X, Config>({
      config,
      dependencies,
      logger,
      project,
      spec: data as OpenApi.V2_0_X | OpenApi.V3_0_X | OpenApi.V3_1_X,
    });
    parseOpenApiSpec(context);
    context.graph = buildGraph(context.ir, logger).graph;
    eventParser.timeEnd();

    const eventGenerator = logger.timeEvent('generator');
    await generateOutput(context);
    eventGenerator.timeEnd();

    const eventPostprocess = logger.timeEvent('postprocess');
    if (!config.dryRun) {
      const jobPrefix = colors.gray(`[Job ${jobIndex + 1}] `);
      postprocessOutput(config.output, postProcessors, jobPrefix);

      if (config.logs.level !== 'silent') {
        const outputPath = process.env.INIT_CWD
          ? `./${path.relative(process.env.INIT_CWD, config.output.path)}`
          : config.output.path;
        console.log(
          `${jobPrefix}${colors.green('✅ Done!')} Your output is in ${colors.cyanBright(outputPath)}`,
        );
      }
    }
    eventPostprocess.timeEnd();
  }

  const watchedInput = config.input.find(
    (input, index) => input.watch.enabled && typeof inputPaths[index]!.path === 'string',
  );

  if (watchedInput) {
    setTimeout(() => {
      createClient({
        config,
        dependencies,
        jobIndex,
        logger,
        watches,
      });
    }, watchedInput.watch.interval);
  }

  return context;
}