write-graphql-schema.ts

import { writeFile } from "node:fs/promises";
import { resolve } from "node:path";
import { fileURLToPath } from "node:url";

import { minifyIntrospectionQuery } from "@urql/introspection";
import { introspectionFromSchema, lexicographicSortSchema, printSchema } from "graphql";

import { makeLogger } from "@/lib/logger";

const logger = makeLogger("write-graphql-schema");

const MONOREPO_ROOT = resolve(import.meta.dirname, "../../../../../");
const ENSSDK_ROOT = resolve(MONOREPO_ROOT, "packages/enssdk/");
const GENERATED_DIR = resolve(ENSSDK_ROOT, "src/omnigraph/generated");

async function _writeGraphQLSchema() {
  const { schema: unsortedSchema } = await import("@/omnigraph-api/schema");
  const schema = lexicographicSortSchema(unsortedSchema);
  const sdl = printSchema(schema);
  const introspection = minifyIntrospectionQuery(introspectionFromSchema(schema), {
    /**
     * We include Scalar types in the introspection in order to power automatic bigint deserialization
     * within the Omnigraph's urql GraphCache.
     */
    includeScalars: true,
  });

  await Promise.all([
    writeFile(resolve(GENERATED_DIR, "schema.graphql"), sdl),
    writeFile(
      resolve(GENERATED_DIR, "introspection.ts"),
      `export const introspection = ${JSON.stringify(introspection)} as const;\n`,
    ),
  ]);
}

/**
 * Attempts to write the GraphQL Schema, swallowing any errors.
 */
export async function writeGraphQLSchema() {
  try {
    await _writeGraphQLSchema();
    logger.info(`Wrote SDL to ${GENERATED_DIR}`);
  } catch (error) {
    logger.warn(error, `Unable to write SDL to ${GENERATED_DIR}`);
  }
}

// when executed directly (`pnpm generate:gqlschema`), write generated schema and produce an exit code
if (resolve(process.argv[1]) === fileURLToPath(import.meta.url)) {
  try {
    await _writeGraphQLSchema();
    console.log(`Wrote SDL to ${GENERATED_DIR}`);
    process.exit(0);
  } catch (error) {
    console.error(error);
    process.exit(1);
  }
}