relay-compiler 12.0.0 → 13.0.0-rc.0

package/codegen/RelayFileWriter.js.flow

@@ -1,367 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- *
- * @flow
- * @format
- */
-
-// flowlint ambiguous-object-type:error
-
-'use strict';
-
-const ASTConvert = require('../core/ASTConvert');
-const CodegenDirectory = require('./CodegenDirectory');
-const CompilerContext = require('../core/CompilerContext');
-const Profiler = require('../core/GraphQLCompilerProfiler');
-const RelayParser = require('../core/RelayParser');
-
-const compileRelayArtifacts = require('./compileRelayArtifacts');
-const graphql = require('graphql');
-const invariant = require('invariant');
-const md5 = require('../util/md5');
-const nullthrows = require('nullthrows');
-const path = require('path');
-const writeRelayGeneratedFile = require('./writeRelayGeneratedFile');
-
-const {
-  getReaderSourceDefinitionName,
-} = require('../core/GraphQLDerivedFromMetadata');
-const {isExecutableDefinitionAST} = require('../core/SchemaUtils');
-const {Map: ImmutableMap} = require('immutable');
-
-import type {Schema} from '../core/Schema';
-import type {
-  FormatModule,
-  PluginInterface,
-  TypeGenerator,
-} from '../language/RelayLanguagePluginInterface';
-import type {ScalarTypeMapping} from '../language/javascript/RelayFlowTypeTransformers';
-import type {Reporter} from '../reporters/Reporter';
-import type {Filesystem} from './CodegenDirectory';
-import type {SourceControl} from './SourceControl';
-import type {RelayCompilerTransforms} from './compileRelayArtifacts';
-import type {DocumentNode, ValidationContext} from 'graphql';
-import type {RequestParameters} from 'relay-runtime';
-
-export type GenerateExtraFiles = (
-  getOutputDirectory: (path?: string) => CodegenDirectory,
-  compilerContext: CompilerContext,
-  getGeneratedDirectory: (definitionName: string) => CodegenDirectory,
-) => void;
-
-export type ValidationRule = (context: ValidationContext) => any;
-
-export type WriterConfig = {
-  baseDir: string,
-  compilerTransforms: RelayCompilerTransforms,
-  customScalars: ScalarTypeMapping,
-  formatModule: FormatModule,
-  generateExtraFiles?: GenerateExtraFiles,
-  optionalInputFieldsForFlow: $ReadOnlyArray<string>,
-  outputDir?: ?string,
-  generatedDirectories?: $ReadOnlyArray<string>,
-  persistQuery?: ?(text: string) => Promise<string>,
-  schemaExtensions: $ReadOnlyArray<string>,
-  noFutureProofEnums: boolean,
-  useHaste: boolean,
-  extension: string,
-  typeGenerator: TypeGenerator,
-  // Haste style module that exports flow types for GraphQL enums.
-  // TODO(T22422153) support non-haste environments
-  enumsHasteModule?: string,
-  printModuleDependency?: string => string,
-  filesystem?: Filesystem,
-  repersist?: boolean,
-  writeQueryParameters?: (
-    outputDirectory: CodegenDirectory,
-    filename: string,
-    moduleName: string,
-    requestParams: RequestParameters,
-  ) => void,
-  ...
-};
-
-function compileAll({
-  baseDir,
-  baseDocuments,
-  schema,
-  compilerTransforms,
-  documents,
-  reporter,
-  typeGenerator,
-}: {|
-  baseDir: string,
-  baseDocuments: $ReadOnlyArray<DocumentNode>,
-  schema: Schema,
-  compilerTransforms: RelayCompilerTransforms,
-  documents: $ReadOnlyArray<DocumentNode>,
-  reporter: Reporter,
-  typeGenerator: TypeGenerator,
-|}) {
-  const definitions = ASTConvert.convertASTDocumentsWithBase(
-    schema,
-    baseDocuments,
-    documents,
-    RelayParser.transform,
-  );
-  const compilerContext = new CompilerContext(schema).addAll(definitions);
-
-  const transformedTypeContext = compilerContext.applyTransforms(
-    typeGenerator.transforms,
-    reporter,
-  );
-  const transformedQueryContext = compilerContext.applyTransforms(
-    [
-      ...compilerTransforms.commonTransforms,
-      ...compilerTransforms.queryTransforms,
-    ],
-    reporter,
-  );
-  const artifacts = compileRelayArtifacts(
-    compilerContext,
-    compilerTransforms,
-    reporter,
-  );
-
-  return {
-    artifacts,
-    definitions,
-    transformedQueryContext,
-    transformedTypeContext,
-  };
-}
-
-function writeAll({
-  config: writerConfig,
-  onlyValidate,
-  baseDocuments,
-  documents,
-  schema,
-  reporter,
-  sourceControl,
-  languagePlugin,
-}: {|
-  config: WriterConfig,
-  onlyValidate: boolean,
-  // $FlowFixMe[value-as-type]
-  baseDocuments: ImmutableMap<string, DocumentNode>,
-  // $FlowFixMe[value-as-type]
-  documents: ImmutableMap<string, DocumentNode>,
-  schema: Schema,
-  reporter: Reporter,
-  sourceControl: ?SourceControl,
-  languagePlugin?: ?PluginInterface,
-|}): Promise<Map<string, CodegenDirectory>> {
-  return Profiler.asyncContext('RelayFileWriter.writeAll', async () => {
-    const {
-      artifacts: artifactsWithBase,
-      transformedTypeContext,
-      transformedQueryContext,
-    } = compileAll({
-      schema,
-      baseDir: writerConfig.baseDir,
-      baseDocuments: baseDocuments.valueSeq().toArray(),
-      compilerTransforms: writerConfig.compilerTransforms,
-      documents: documents.valueSeq().toArray(),
-      reporter,
-      typeGenerator: writerConfig.typeGenerator,
-    });
-    // Build a context from all the documents
-    const baseDefinitionNames = new Set();
-    baseDocuments.forEach(doc => {
-      doc.definitions.forEach(def => {
-        if (isExecutableDefinitionAST(def) && def.name) {
-          baseDefinitionNames.add(def.name.value);
-        }
-      });
-    });
-
-    // remove nodes that are present in the base or that derive from nodes
-    // in the base
-    const artifacts = artifactsWithBase.filter(([_definition, node]) => {
-      const sourceName = getReaderSourceDefinitionName(node);
-      return !baseDefinitionNames.has(sourceName);
-    });
-
-    const artifactMap = new Map(
-      artifacts.map(([_definition, node]) => [
-        node.kind === 'Request' ? node.params.name : node.name,
-        node,
-      ]),
-    );
-
-    const definitionsMeta = new Map();
-    const getDefinitionMeta = (definitionName: string) => {
-      const artifact = nullthrows(artifactMap.get(definitionName));
-      const sourceName = getReaderSourceDefinitionName(artifact);
-      const definitionMeta = definitionsMeta.get(sourceName);
-      invariant(
-        definitionMeta,
-        'RelayFileWriter: Could not determine source for definition: `%s`.',
-        definitionName,
-      );
-      return definitionMeta;
-    };
-    documents.forEach((doc, filePath) => {
-      doc.definitions.forEach(def => {
-        if (def.name) {
-          definitionsMeta.set(def.name.value, {
-            dir: path.join(writerConfig.baseDir, path.dirname(filePath)),
-            ast: def,
-          });
-        }
-      });
-    });
-
-    const allOutputDirectories: Map<string, CodegenDirectory> = new Map();
-    const addCodegenDir = dirPath => {
-      const codegenDir = new CodegenDirectory(dirPath, {
-        onlyValidate: onlyValidate,
-        filesystem: writerConfig.filesystem,
-      });
-      allOutputDirectories.set(dirPath, codegenDir);
-      return codegenDir;
-    };
-
-    for (const existingDirectory of writerConfig.generatedDirectories || []) {
-      addCodegenDir(existingDirectory);
-    }
-
-    let configOutputDirectory;
-    if (writerConfig.outputDir) {
-      configOutputDirectory = addCodegenDir(writerConfig.outputDir);
-    }
-
-    const getGeneratedDirectory = definitionName => {
-      if (configOutputDirectory) {
-        return configOutputDirectory;
-      }
-      const generatedPath = path.join(
-        getDefinitionMeta(definitionName).dir,
-        '__generated__',
-      );
-      let cachedDir = allOutputDirectories.get(generatedPath);
-      if (!cachedDir) {
-        cachedDir = addCodegenDir(generatedPath);
-      }
-      return cachedDir;
-    };
-
-    const formatModule = Profiler.instrument(
-      writerConfig.formatModule,
-      'RelayFileWriter:formatModule',
-    );
-
-    const persistQuery = writerConfig.persistQuery
-      ? Profiler.instrumentWait(
-          writerConfig.persistQuery,
-          'RelayFileWriter:persistQuery',
-        )
-      : null;
-
-    try {
-      await Promise.all(
-        artifacts.map(async ([definition, node]) => {
-          const nodeName =
-            node.kind === 'Request' ? node.params.name : node.name;
-          if (baseDefinitionNames.has(nodeName)) {
-            // don't add definitions that were part of base context
-            return;
-          }
-
-          const typeNode = transformedTypeContext.get(nodeName);
-          const typeText = typeNode
-            ? writerConfig.typeGenerator.generate(
-                schema,
-                (typeNode: $FlowFixMe),
-                {
-                  customScalars: writerConfig.customScalars,
-                  enumsHasteModule: writerConfig.enumsHasteModule,
-                  optionalInputFields: writerConfig.optionalInputFieldsForFlow,
-                  useHaste: writerConfig.useHaste,
-                  useSingleArtifactDirectory: !!writerConfig.outputDir,
-                  noFutureProofEnums: writerConfig.noFutureProofEnums,
-                  normalizationIR:
-                    definition.kind === 'Request' ? definition.root : undefined,
-                },
-              )
-            : '';
-
-          const sourceHash = Profiler.run('hashGraphQL', () =>
-            md5(graphql.print(getDefinitionMeta(nodeName).ast)),
-          );
-
-          await writeRelayGeneratedFile(
-            schema,
-            getGeneratedDirectory(nodeName),
-            definition,
-            node,
-            formatModule,
-            typeText,
-            persistQuery,
-            sourceHash,
-            writerConfig.extension,
-            writerConfig.printModuleDependency,
-            writerConfig.repersist ?? false,
-            writerConfig.writeQueryParameters ?? function noop() {},
-            languagePlugin,
-          );
-        }),
-      );
-
-      const generateExtraFiles = writerConfig.generateExtraFiles;
-      if (generateExtraFiles) {
-        Profiler.run('RelayFileWriter:generateExtraFiles', () => {
-          const configDirectory = writerConfig.outputDir;
-          generateExtraFiles(
-            dir => {
-              const outputDirectory = dir || configDirectory;
-              invariant(
-                outputDirectory,
-                'RelayFileWriter: cannot generate extra files without specifying ' +
-                  'an outputDir in the config or passing it in.',
-              );
-              let outputDir = allOutputDirectories.get(outputDirectory);
-              if (!outputDir) {
-                outputDir = addCodegenDir(outputDirectory);
-              }
-              return outputDir;
-            },
-            transformedQueryContext,
-            getGeneratedDirectory,
-          );
-        });
-      }
-
-      allOutputDirectories.forEach(dir => {
-        dir.deleteExtraFiles(languagePlugin?.keepExtraFile);
-      });
-      if (sourceControl && !onlyValidate) {
-        await CodegenDirectory.sourceControlAddRemove(
-          sourceControl,
-          Array.from(allOutputDirectories.values()),
-        );
-      }
-    } catch (error) {
-      let details;
-      try {
-        details = JSON.parse(error.message);
-      } catch (_) {} // eslint-disable-line lint/no-unused-catch-bindings
-      if (details && details.name === 'GraphQL2Exception' && details.message) {
-        throw new Error('GraphQL error writing modules:\n' + details.message);
-      }
-      throw new Error(
-        'Error writing modules:\n' + String(error.stack || error),
-      );
-    }
-
-    return allOutputDirectories;
-  });
-}
-
-module.exports = {
-  writeAll,
-};

package/codegen/SourceControl.js.flow

@@ -1,58 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- *
- * @flow strict
- * @format
- */
-
-// flowlint ambiguous-object-type:error
-
-'use strict';
-
-const childProcess = require('child_process');
-
-function execFile(cmd: string, args: Array<string>): Promise<void> {
-  return new Promise((resolve, reject) => {
-    childProcess.execFile(cmd, args, err => {
-      if (err) {
-        reject(err);
-      } else {
-        resolve();
-      }
-    });
-  });
-}
-
-/**
- * An abstraction over the source control system to make it injectable.
- */
-export type SourceControl = {
-  addRemove(
-    added: $ReadOnlyArray<string>,
-    removed: $ReadOnlyArray<string>,
-  ): Promise<void>,
-  ...
-};
-
-const SourceControlMercurial: SourceControl = {
-  async addRemove(
-    added: $ReadOnlyArray<string>,
-    removed: $ReadOnlyArray<string>,
-  ): Promise<void> {
-    // NOTE: Not using `hg addremove` as that has a bug when deleting a file
-    // that was just added, but not yet committed: T10711513
-    if (added.length > 0) {
-      await execFile('hg', ['add', ...added]);
-    }
-    if (removed.length > 0) {
-      await execFile('hg', ['forget', ...removed]);
-    }
-  },
-};
-
-module.exports = {
-  SourceControlMercurial,
-};

package/codegen/compileRelayArtifacts.js.flow

@@ -1,182 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- *
- * @flow strict-local
- * @format
- */
-
-// flowlint ambiguous-object-type:error
-
-'use strict';
-
-const Printer = require('../core/IRPrinter');
-const Profiler = require('../core/GraphQLCompilerProfiler');
-const RelayCodeGenerator = require('./RelayCodeGenerator');
-
-const filterContextForNode = require('../core/filterContextForNode');
-
-import type CompilerContext from '../core/CompilerContext';
-import type {IRTransform} from '../core/CompilerContext';
-import type {GeneratedDefinition} from '../core/IR';
-import type {Reporter} from '../reporters/Reporter';
-import type {GeneratedNode} from 'relay-runtime';
-
-export type RelayCompilerTransforms = {
-  commonTransforms: $ReadOnlyArray<IRTransform>,
-  codegenTransforms: $ReadOnlyArray<IRTransform>,
-  fragmentTransforms: $ReadOnlyArray<IRTransform>,
-  printTransforms: $ReadOnlyArray<IRTransform>,
-  queryTransforms: $ReadOnlyArray<IRTransform>,
-  ...
-};
-
-function createFragmentContext(
-  context: CompilerContext,
-  transforms: RelayCompilerTransforms,
-  reporter?: Reporter,
-): CompilerContext {
-  // The fragment is used for reading data from the normalized store.
-  return context.applyTransforms(
-    [...transforms.commonTransforms, ...transforms.fragmentTransforms],
-    reporter,
-  );
-}
-
-function createPrintContext(
-  context: CompilerContext,
-  transforms: RelayCompilerTransforms,
-  reporter?: Reporter,
-): CompilerContext {
-  // The unflattened query is used for printing, since flattening creates an
-  // invalid query.
-  return context.applyTransforms(
-    [
-      ...transforms.commonTransforms,
-      ...transforms.queryTransforms,
-      ...transforms.printTransforms,
-    ],
-    reporter,
-  );
-}
-
-function createCodeGenContext(
-  context: CompilerContext,
-  transforms: RelayCompilerTransforms,
-  reporter?: Reporter,
-): CompilerContext {
-  // The flattened query is used for codegen in order to reduce the number of
-  // duplicate fields that must be processed during response normalization.
-  return context.applyTransforms(
-    [
-      ...transforms.commonTransforms,
-      ...transforms.queryTransforms,
-      ...transforms.codegenTransforms,
-    ],
-    reporter,
-  );
-}
-
-function compile(
-  context: CompilerContext,
-  fragmentContext: CompilerContext,
-  printContext: CompilerContext,
-  codeGenContext: CompilerContext,
-): $ReadOnlyArray<[GeneratedDefinition, GeneratedNode]> {
-  const results = [];
-  const schema = context.getSchema();
-
-  // Add everything from codeGenContext, these are the operations as well as
-  // SplitOperations from @match.
-  for (const node of codeGenContext.documents()) {
-    if (node.kind === 'Root') {
-      const fragment = fragmentContext.getRoot(node.name);
-      const request = {
-        kind: 'Request',
-        fragment: {
-          kind: 'Fragment',
-          argumentDefinitions: fragment.argumentDefinitions,
-          directives: fragment.directives,
-          loc: {kind: 'Derived', source: node.loc},
-          metadata: null,
-          name: fragment.name,
-          selections: fragment.selections,
-          type: fragment.type,
-        },
-        id: null,
-        loc: node.loc,
-        metadata: node.metadata || {},
-        name: fragment.name,
-        root: node,
-        text: printOperation(printContext, fragment.name),
-      };
-      results.push([request, RelayCodeGenerator.generate(schema, request)]);
-    } else {
-      results.push([node, RelayCodeGenerator.generate(schema, node)]);
-    }
-  }
-
-  // Add all the Fragments from the fragmentContext for the reader ASTs.
-  for (const node of fragmentContext.documents()) {
-    if (node.kind === 'Fragment') {
-      results.push([node, RelayCodeGenerator.generate(schema, node)]);
-    }
-  }
-  return results;
-}
-
-const OPERATION_ORDER = {
-  Root: 0,
-  SplitOperation: 1,
-  Fragment: 2,
-};
-function printOperation(printContext: CompilerContext, name: string): string {
-  const printableRoot = printContext.getRoot(name);
-  return filterContextForNode(printableRoot, printContext)
-    .documents()
-    .sort((a, b) => {
-      if (a.kind !== b.kind) {
-        return OPERATION_ORDER[a.kind] - OPERATION_ORDER[b.kind];
-      }
-      return a.name < b.name ? -1 : 1;
-    })
-    .map(doc => Printer.print(printContext.getSchema(), doc))
-    .join('\n');
-}
-
-/**
- * Transforms the provided compiler context
- *
- * compileRelayArtifacts generates artifacts for Relay's runtime as a result of
- * applying a series of transforms. Each kind of artifact is dependent on
- * transforms being applied in the following order:
- *
- *   - Fragment Readers: commonTransforms, fragmentTransforms
- *   - Operation Writers: commonTransforms, queryTransforms, codegenTransforms
- *   - GraphQL Text: commonTransforms, queryTransforms, printTransforms
- *
- * The order of the transforms applied for each artifact below is important.
- * CompilerContext will memoize applying each transform, so while
- * `commonTransforms` appears in each artifacts' application, it will not result
- * in repeated work as long as the order remains consistent across each context.
- */
-function compileRelayArtifacts(
-  context: CompilerContext,
-  transforms: RelayCompilerTransforms,
-  reporter?: Reporter,
-): $ReadOnlyArray<[GeneratedDefinition, GeneratedNode]> {
-  return Profiler.run('GraphQLCompiler.compile', () => {
-    const fragmentContext = createFragmentContext(
-      context,
-      transforms,
-      reporter,
-    );
-    const printContext = createPrintContext(context, transforms, reporter);
-    const codeGenContext = createCodeGenContext(context, transforms, reporter);
-    return compile(context, fragmentContext, printContext, codeGenContext);
-  });
-}
-
-module.exports = compileRelayArtifacts;

package/codegen/createPrintRequireModuleDependency.js.flow

@@ -1,19 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- *
- * @flow strict
- * @format
- */
-
-// flowlint ambiguous-object-type:error
-
-'use strict';
-
-function createPrintRequireModuleDependency(): string => string {
-  return moduleName => `require('./${moduleName}')`;
-}
-
-module.exports = createPrintRequireModuleDependency;

package/codegen/sortObjectByKey.js.flow

@@ -1,25 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- *
- * @flow strict-local
- * @format
- */
-
-'use strict';
-
-function sortObjectByKey<T: ?{[key: string]: mixed}>(obj: T): T {
-  if (obj == null) {
-    return obj;
-  }
-  const result = {};
-  for (const key of Object.keys(obj).sort()) {
-    result[key] = obj[key];
-  }
-  // $FlowFixMe[incompatible-return]
-  return result;
-}
-
-module.exports = sortObjectByKey;