codegen.ts

import {
  DefinitionNode,
  DocumentNode,
  Kind,
  NameNode,
  print,
  specifiedRules,
  visit,
} from 'graphql';
import {
  AddToSchemaResult,
  createNoopProfiler,
  federationSpec,
  getCachedDocumentNodeFromSchema,
  isComplexPluginOutput,
  Types,
} from '@graphql-codegen/plugin-helpers';
import { mergeSchemas } from '@graphql-tools/schema';
import { asArray, Source, validateGraphQlDocuments } from '@graphql-tools/utils';
import { executePlugin } from './execute-plugin.js';
import { transformDocuments } from './transform-document.js';
import {
  extractHashFromSchema,
  getSkipDocumentsValidationOption,
  hasFederationSpec,
  pickFlag,
  prioritize,
  shouldValidateDocumentsAgainstSchema,
  shouldValidateDuplicateDocuments,
} from './utils.js';

export async function codegen(options: Types.GenerateOptions): Promise<string> {
  const documents = options.documents || [];
  const profiler = options.profiler ?? createNoopProfiler();

  const skipDocumentsValidation = getSkipDocumentsValidationOption(options);

  if (documents.length > 0 && shouldValidateDuplicateDocuments(skipDocumentsValidation)) {
    await profiler.run(
      async () => validateDuplicateDocuments(documents),
      'validateDuplicateDocuments',
    );
  }

  const pluginPackages = Object.keys(options.pluginMap).map(key => options.pluginMap[key]);

  // merged schema with parts added by plugins
  const additionalTypeDefs: AddToSchemaResult[] = [];
  for (const plugin of pluginPackages) {
    const addToSchema =
      typeof plugin.addToSchema === 'function'
        ? plugin.addToSchema(options.config)
        : plugin.addToSchema;

    if (addToSchema) {
      additionalTypeDefs.push(addToSchema);
    }
  }

  const federationInConfig: boolean = pickFlag('federation', options.config);
  const isFederation = prioritize(federationInConfig, false);

  if (isFederation && !hasFederationSpec(options.schemaAst || options.schema)) {
    additionalTypeDefs.push(federationSpec);
  }

  // Use mergeSchemas, only if there is no GraphQLSchema provided or the schema should be extended
  const mergeNeeded = !options.schemaAst || additionalTypeDefs.length > 0;

  const schemaInstance = await profiler.run(async () => {
    return mergeNeeded
      ? mergeSchemas({
          // If GraphQLSchema provided, use it
          schemas: options.schemaAst ? [options.schemaAst] : [],
          // If GraphQLSchema isn't provided but DocumentNode is, use it to get the final GraphQLSchema
          typeDefs: options.schemaAst
            ? additionalTypeDefs
            : [options.schema, ...additionalTypeDefs],
          convertExtensions: true,
          assumeValid: true,
          assumeValidSDL: true,
          ...options.config,
        } as any)
      : options.schemaAst;
  }, 'Create schema instance');

  const schemaDocumentNode =
    mergeNeeded || !options.schema
      ? getCachedDocumentNodeFromSchema(schemaInstance!)
      : options.schema;

  const documentTransforms = Array.isArray(options.documentTransforms)
    ? options.documentTransforms
    : [];
  const transformedDocuments = await transformDocuments({
    ...options,
    documentTransforms,
    schema: schemaDocumentNode,
    schemaAst: schemaInstance,
    profiler,
  });

  if (
    schemaInstance &&
    transformedDocuments.length > 0 &&
    shouldValidateDocumentsAgainstSchema(skipDocumentsValidation)
  ) {
    const ignored = ['NoUnusedFragments', 'NoUnusedVariables', 'KnownDirectives'];
    if (typeof skipDocumentsValidation === 'object' && skipDocumentsValidation.ignoreRules) {
      ignored.push(...asArray(skipDocumentsValidation.ignoreRules));
    }
    const extraFragments: { importFrom: string; node: DefinitionNode }[] =
      pickFlag('externalFragments', options.config) || [];

    const errors = await profiler.run(() => {
      const fragments = extraFragments.map(f => ({
        location: f.importFrom,
        document: {
          kind: Kind.DOCUMENT,
          definitions: [f.node],
        } as DocumentNode,
      }));
      const rules = specifiedRules.filter(
        rule => !ignored.some(ignoredRule => rule.name.startsWith(ignoredRule)),
      );
      const schemaHash = extractHashFromSchema(schemaInstance);

      if (
        !schemaHash ||
        !options.cache ||
        transformedDocuments.some(d => typeof d.hash !== 'string')
      ) {
        return Promise.resolve(
          validateGraphQlDocuments(
            schemaInstance,
            [
              ...transformedDocuments.flatMap(d => d.document),
              ...fragments.flatMap(f => f.document),
            ],
            rules,
          ),
        );
      }

      const cacheKey = [schemaHash]
        .concat(transformedDocuments.map(doc => doc.hash))
        .concat(JSON.stringify(fragments))
        .join(',');

      return options.cache('documents-validation', cacheKey, () =>
        Promise.resolve(
          validateGraphQlDocuments(
            schemaInstance,
            [
              ...transformedDocuments.flatMap(d => d.document),
              ...fragments.flatMap(f => f.document),
            ],
            rules,
          ),
        ),
      );
    }, 'Validate documents against schema');

    if (errors.length > 0) {
      throw new Error(
        `GraphQL Document Validation failed with ${errors.length} errors;
  ${errors.map((error, index) => `Error ${index}: ${error.stack}`).join('\n\n')}`,
      );
    }
  }

  const prepend: Set<string> = new Set<string>();
  const append: Set<string> = new Set<string>();

  const output = await Promise.all(
    options.plugins.map(async plugin => {
      const name = Object.keys(plugin)[0];
      const pluginPackage = options.pluginMap[name];
      const pluginConfig = plugin[name] || {};

      const execConfig =
        typeof pluginConfig === 'object' ? { ...options.config, ...pluginConfig } : pluginConfig;

      const result = await profiler.run(
        () =>
          executePlugin(
            {
              name,
              config: execConfig,
              parentConfig: options.config,
              schema: schemaDocumentNode,
              schemaAst: schemaInstance,
              documents: transformedDocuments,
              outputFilename: options.filename,
              allPlugins: options.plugins,
              skipDocumentsValidation: options.skipDocumentsValidation,
              pluginContext: options.pluginContext,
              profiler,
            },
            pluginPackage,
          ),
        `Plugin ${name}`,
      );

      if (typeof result === 'string') {
        return result || '';
      }
      if (isComplexPluginOutput(result)) {
        if (result.append && result.append.length > 0) {
          for (const item of result.append) {
            if (item) {
              append.add(item);
            }
          }
        }

        if (result.prepend && result.prepend.length > 0) {
          for (const item of result.prepend) {
            if (item) {
              prepend.add(item);
            }
          }
        }
        return result.content || '';
      }

      return '';
    }),
  );

  return [
    ...sortPrependValues(Array.from(prepend.values())),
    ...output,
    ...Array.from(append.values()),
  ]
    .filter(Boolean)
    .join('\n');
}

function resolveCompareValue(a: string) {
  if (
    a.startsWith('/*') ||
    a.startsWith('//') ||
    a.startsWith(' *') ||
    a.startsWith(' */') ||
    a.startsWith('*/')
  ) {
    return 0;
  }
  if (a.startsWith('package')) {
    return 1;
  }
  if (a.startsWith('import')) {
    return 2;
  }
  return 3;
}

export function sortPrependValues(values: string[]): string[] {
  return values.sort((a: string, b: string) => {
    const aV = resolveCompareValue(a);
    const bV = resolveCompareValue(b);

    if (aV < bV) {
      return -1;
    }
    if (aV > bV) {
      return 1;
    }

    return 0;
  });
}

function validateDuplicateDocuments(files: Types.DocumentFile[]) {
  // duplicated names
  const definitionMap: {
    [kind: string]: {
      [name: string]: {
        paths: Set<string>;
        contents: Set<string>;
      };
    };
  } = {};

  function addDefinition(
    file: Source,
    node: DefinitionNode & { name?: NameNode },
    deduplicatedDefinitions: Set<DefinitionNode>,
  ) {
    if (typeof node.name !== 'undefined') {
      definitionMap[node.kind] ||= {};
      definitionMap[node.kind][node.name.value] ||= {
        paths: new Set(),
        contents: new Set(),
      };

      const definitionKindMap = definitionMap[node.kind];

      const length = definitionKindMap[node.name.value].contents.size;
      definitionKindMap[node.name.value].paths.add(file.location!);
      definitionKindMap[node.name.value].contents.add(print(node));
      if (length === definitionKindMap[node.name.value].contents.size) {
        return null;
      }
    }
    return deduplicatedDefinitions.add(node);
  }

  for (const file of files) {
    const deduplicatedDefinitions = new Set<DefinitionNode>();
    visit(file.document!, {
      OperationDefinition(node) {
        addDefinition(file, node, deduplicatedDefinitions);
      },
      FragmentDefinition(node) {
        addDefinition(file, node, deduplicatedDefinitions);
      },
    });
    (file.document as any).definitions = Array.from(deduplicatedDefinitions);
  }

  const kinds = Object.keys(definitionMap);

  for (const kind of kinds) {
    const definitionKindMap = definitionMap[kind];
    const names = Object.keys(definitionKindMap);
    if (names.length) {
      const duplicated = names.filter(name => definitionKindMap[name].contents.size > 1);

      if (!duplicated.length) {
        continue;
      }

      const list = duplicated
        .map(name =>
          `
        * ${name} found in:
          ${[...definitionKindMap[name].paths]
            .map(filepath => {
              return `
              - ${filepath}
            `.trimEnd();
            })
            .join('')}
    `.trimEnd(),
        )
        .join('');

      const definitionKindName = kind.replace('Definition', '').toLowerCase();
      throw new Error(
        `Not all ${definitionKindName}s have an unique name: ${duplicated.join(', ')}: \n
          ${list}
        `,
      );
    }
  }
}