relay-compiler 9.0.0 → 9.1.0

package/language/javascript/RelayFlowTypeTransformers.js.flow

@@ -0,0 +1,184 @@
+/**
+ * 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 t = require('@babel/types');
+
+const {
+  exactObjectTypeAnnotation,
+  readOnlyArrayOfType,
+} = require('./RelayFlowBabelFactories');
+
+import type {Schema, TypeID, EnumTypeID} from '../../core/Schema';
+
+export type BabelTypes = typeof t;
+export type ScalarTypeMapping = {
+  [type: string]: string | (BabelTypes => mixed),
+  ...,
+};
+
+import type {State} from './RelayFlowGenerator';
+
+function getInputObjectTypeIdentifier(schema: Schema, typeID: TypeID): string {
+  return schema.getTypeString(typeID);
+}
+
+function transformScalarType(
+  schema: Schema,
+  type: TypeID,
+  state: State,
+  objectProps?: mixed,
+): mixed {
+  if (schema.isNonNull(type)) {
+    return transformNonNullableScalarType(
+      schema,
+      schema.getNullableType(type),
+      state,
+      objectProps,
+    );
+  } else {
+    return t.nullableTypeAnnotation(
+      transformNonNullableScalarType(schema, type, state, objectProps),
+    );
+  }
+}
+
+function transformNonNullableScalarType(
+  schema: Schema,
+  type: TypeID,
+  state: State,
+  objectProps,
+) {
+  if (schema.isList(type)) {
+    return readOnlyArrayOfType(
+      transformScalarType(
+        schema,
+        schema.getListItemType(type),
+        state,
+        objectProps,
+      ),
+    );
+  } else if (
+    schema.isObject(type) ||
+    schema.isUnion(type) ||
+    schema.isInterface(type)
+  ) {
+    return objectProps;
+  } else if (schema.isScalar(type)) {
+    return transformGraphQLScalarType(schema.getTypeString(type), state);
+  } else if (schema.isEnum(type)) {
+    return transformGraphQLEnumType(schema, schema.assertEnumType(type), state);
+  } else {
+    throw new Error(`Could not convert from GraphQL type ${String(type)}`);
+  }
+}
+
+function transformGraphQLScalarType(typeName: string, state: State) {
+  const customType = state.customScalars[typeName];
+  if (typeof customType === 'function') {
+    return customType(t);
+  }
+  switch (customType ?? typeName) {
+    case 'ID':
+    case 'String':
+      return t.stringTypeAnnotation();
+    case 'Float':
+    case 'Int':
+      return t.numberTypeAnnotation();
+    case 'Boolean':
+      return t.booleanTypeAnnotation();
+    default:
+      return customType == null
+        ? t.anyTypeAnnotation()
+        : t.genericTypeAnnotation(t.identifier(customType));
+  }
+}
+
+function transformGraphQLEnumType(
+  schema: Schema,
+  type: EnumTypeID,
+  state: State,
+) {
+  state.usedEnums[schema.getTypeString(type)] = type;
+  return t.genericTypeAnnotation(t.identifier(schema.getTypeString(type)));
+}
+
+function transformInputType(
+  schema: Schema,
+  type: TypeID,
+  state: State,
+): $FlowFixMe {
+  if (schema.isNonNull(type)) {
+    return transformNonNullableInputType(
+      schema,
+      schema.getNullableType(type),
+      state,
+    );
+  } else {
+    return t.nullableTypeAnnotation(
+      transformNonNullableInputType(schema, type, state),
+    );
+  }
+}
+
+function transformNonNullableInputType(
+  schema: Schema,
+  type: TypeID,
+  state: State,
+) {
+  if (schema.isList(type)) {
+    return readOnlyArrayOfType(
+      transformInputType(schema, schema.getListItemType(type), state),
+    );
+  } else if (schema.isScalar(type)) {
+    return transformGraphQLScalarType(schema.getTypeString(type), state);
+  } else if (schema.isEnum(type)) {
+    return transformGraphQLEnumType(schema, schema.assertEnumType(type), state);
+  } else if (schema.isInputObject(type)) {
+    const typeIdentifier = getInputObjectTypeIdentifier(schema, type);
+    if (state.generatedInputObjectTypes[typeIdentifier]) {
+      return t.genericTypeAnnotation(t.identifier(typeIdentifier));
+    }
+    state.generatedInputObjectTypes[typeIdentifier] = 'pending';
+    const fields = schema.getFields(schema.assertInputObjectType(type));
+    const props = fields.map(fieldID => {
+      const fieldType = schema.getFieldType(fieldID);
+      const fieldName = schema.getFieldName(fieldID);
+      const property = t.objectTypeProperty(
+        t.identifier(fieldName),
+        transformInputType(schema, fieldType, state),
+      );
+      if (
+        state.optionalInputFields.indexOf(fieldName) >= 0 ||
+        !schema.isNonNull(fieldType)
+      ) {
+        property.optional = true;
+      }
+      return property;
+    });
+
+    state.generatedInputObjectTypes[typeIdentifier] = exactObjectTypeAnnotation(
+      props,
+    );
+    return t.genericTypeAnnotation(t.identifier(typeIdentifier));
+  } else {
+    throw new Error(
+      `Could not convert from GraphQL type ${schema.getTypeString(type)}`,
+    );
+  }
+}
+
+module.exports = {
+  transformInputType,
+  transformScalarType,
+};

package/language/javascript/RelayLanguagePluginJavaScript.js.flow

@@ -0,0 +1,34 @@
+/**
+ * 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 RelayFlowGenerator = require('./RelayFlowGenerator');
+
+const {find} = require('./FindGraphQLTags');
+const {
+  formatGeneratedCommonjsModule,
+  formatGeneratedESModule,
+} = require('./formatGeneratedModule');
+
+import type {PluginInterface} from '../RelayLanguagePluginInterface';
+
+module.exports = (options?: {|eagerESModules: boolean|}): PluginInterface => ({
+  inputExtensions: ['js', 'jsx'],
+  outputExtension: 'js',
+  typeGenerator: RelayFlowGenerator,
+  formatModule:
+    options && options.eagerESModules
+      ? formatGeneratedESModule
+      : formatGeneratedCommonjsModule,
+  findGraphQLTags: find,
+});

package/language/javascript/formatGeneratedModule.js.flow

@@ -0,0 +1,65 @@
+/**
+ * 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';
+
+import type {FormatModule} from '../RelayLanguagePluginInterface';
+
+const formatGeneratedModule: FormatModule = ({
+  moduleName,
+  documentType,
+  docText,
+  concreteText,
+  typeText,
+  hash,
+  sourceHash,
+}) => {
+  const documentTypeImport = documentType
+    ? `import type { ${documentType} } from 'relay-runtime';`
+    : '';
+  const docTextComment =
+    docText != null ? '\n/*\n' + docText.trim() + '\n*/\n' : '';
+  const hashText = hash != null ? `\n * ${hash}` : '';
+  return `/**
+ * ${'@'}flow${hashText}
+ */
+
+/* eslint-disable */
+
+'use strict';
+
+/*::
+${documentTypeImport}
+${typeText || ''}
+*/
+
+${docTextComment}
+const node/*: ${documentType || 'empty'}*/ = ${concreteText};
+// prettier-ignore
+(node/*: any*/).hash = '${sourceHash}';
+`;
+};
+
+const formatGeneratedCommonjsModule: FormatModule = options => {
+  return `${formatGeneratedModule(options)}
+module.exports = node;
+`;
+};
+
+const formatGeneratedESModule: FormatModule = options => {
+  return `${formatGeneratedModule(options)}
+export default node;
+`;
+};
+
+exports.formatGeneratedCommonjsModule = formatGeneratedCommonjsModule;
+exports.formatGeneratedESModule = formatGeneratedESModule;

package/lib/bin/RelayCompilerBin.js

@@ -89,6 +89,11 @@ var options = {
     type: 'string',
     array: false
   },
+  repersist: {
+    describe: 'Run the persist function even if the query has not changed.',
+    type: 'boolean',
+    "default": false
+  },
   noFutureProofEnums: {
     describe: 'This option controls whether or not a catch-all entry is added to enum type definitions ' + 'for values that may be added in the future. Enabling this means you will have to update ' + 'your application whenever the GraphQL server schema adds new enum values to prevent it ' + 'from breaking.',
     type: 'boolean',
@@ -110,6 +115,11 @@ var options = {
   customScalars: {
     describe: 'Mappings from custom scalars in your schema to built-in GraphQL ' + 'types, for type emission purposes. (Uses yargs dot-notation, e.g. ' + '--customScalars.URL=String)',
     type: 'object'
+  },
+  eagerESModules: {
+    describe: 'This option enables emitting es modules artifacts.',
+    type: 'boolean',
+    "default": false
   }
 }; // Parse CLI args
 

package/lib/bin/RelayCompilerMain.js

@@ -16,10 +16,18 @@ var _asyncToGenerator = require("@babel/runtime/helpers/asyncToGenerator");
 
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
-var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread"));
-
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 
+function _createForOfIteratorHelper(o) { if (typeof Symbol === "undefined" || o[Symbol.iterator] == null) { if (Array.isArray(o) || (o = _unsupportedIterableToArray(o))) { var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var it, normalCompletion = true, didErr = false, err; return { s: function s() { it = o[Symbol.iterator](); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(n); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
 var CodegenRunner = require('../codegen/CodegenRunner');
 
 var ConsoleReporter = require('../reporters/ConsoleReporter');
@@ -213,7 +221,7 @@ function getPathBasedConfig(config) {
     }
   }
 
-  return (0, _objectSpread2["default"])({}, config, {
+  return _objectSpread({}, config, {
     schema: schema,
     src: src,
     persistOutput: persistOutput
@@ -231,7 +239,7 @@ function _getWatchConfig() {
     if (config.watch) {
       if (!watchman) {
         console.error('Watchman is required to watch for changes. Running with watch mode disabled.');
-        return (0, _objectSpread2["default"])({}, config, {
+        return _objectSpread({}, config, {
           watch: false,
           watchman: false
         });
@@ -245,7 +253,7 @@ function _getWatchConfig() {
       console.log('HINT: pass --watch to keep watching for changes.');
     }
 
-    return (0, _objectSpread2["default"])({}, config, {
+    return _objectSpread({}, config, {
       watchman: watchman
     });
   });
@@ -253,7 +261,7 @@ function _getWatchConfig() {
 }
 
 function getCodegenRunner(config) {
-  var _artifactDirectory, _parserConfigs;
+  var _parserConfigs;
 
   var reporter = new ConsoleReporter({
     verbose: config.verbose,
@@ -271,7 +279,7 @@ function getCodegenRunner(config) {
   var sourceModuleParser = RelaySourceModuleParser(languagePlugin.findGraphQLTags, languagePlugin.getFileFilter);
   var providedArtifactDirectory = config.artifactDirectory;
   var artifactDirectory = providedArtifactDirectory != null ? path.resolve(process.cwd(), providedArtifactDirectory) : null;
-  var generatedDirectoryName = (_artifactDirectory = artifactDirectory) !== null && _artifactDirectory !== void 0 ? _artifactDirectory : '__generated__';
+  var generatedDirectoryName = artifactDirectory !== null && artifactDirectory !== void 0 ? artifactDirectory : '__generated__';
   var sourceSearchOptions = {
     extensions: inputExtensions,
     include: config.include,
@@ -309,7 +317,7 @@ function getCodegenRunner(config) {
     filepaths: config.watchman ? null : getFilepathsFromGlob(config.src, graphqlSearchOptions)
   }), _parserConfigs);
   var writerConfigs = (0, _defineProperty2["default"])({}, sourceWriterName, {
-    writeFiles: getRelayFileWriter(config.src, languagePlugin, config.noFutureProofEnums, artifactDirectory, config.persistOutput, config.customScalars, persistQueryFunction),
+    writeFiles: getRelayFileWriter(config.src, languagePlugin, config.noFutureProofEnums, artifactDirectory, config.persistOutput, config.customScalars, persistQueryFunction, config.repersist),
     isGeneratedFile: languagePlugin.isGeneratedFile ? languagePlugin.isGeneratedFile : defaultIsGeneratedFile,
     parser: sourceParserName,
     baseParsers: ['graphql']
@@ -332,129 +340,115 @@ function defaultPersistFunction(text) {
   return Promise.resolve(id);
 }
 
-function getRelayFileWriter(baseDir, languagePlugin, noFutureProofEnums, outputDir, persistedQueryPath, customScalars, persistFunction) {
-  return (
-    /*#__PURE__*/
-    function () {
-      var _ref2 = _asyncToGenerator(function* (_ref) {
-        var onlyValidate = _ref.onlyValidate,
-            schema = _ref.schema,
-            documents = _ref.documents,
-            baseDocuments = _ref.baseDocuments,
-            sourceControl = _ref.sourceControl,
-            reporter = _ref.reporter;
-        var persistQuery;
-        var queryMap;
-
-        if (persistFunction != null || persistedQueryPath != null) {
-          queryMap = new Map();
-          var persistImplmentation = persistFunction || defaultPersistFunction;
-
-          persistQuery =
-          /*#__PURE__*/
-          function () {
-            var _persistQuery = _asyncToGenerator(function* (text) {
-              var id = yield persistImplmentation(text);
-              !(typeof id === 'string') ? process.env.NODE_ENV !== "production" ? invariant(false, 'Expected persist function to return a string, got `%s`.', id) : invariant(false) : void 0;
-              queryMap.set(id, text);
-              return id;
-            });
-
-            function persistQuery(_x4) {
-              return _persistQuery.apply(this, arguments);
-            }
+function getRelayFileWriter(baseDir, languagePlugin, noFutureProofEnums, outputDir, persistedQueryPath, customScalars, persistFunction, repersist) {
+  return /*#__PURE__*/function () {
+    var _ref2 = _asyncToGenerator(function* (_ref) {
+      var onlyValidate = _ref.onlyValidate,
+          schema = _ref.schema,
+          documents = _ref.documents,
+          baseDocuments = _ref.baseDocuments,
+          sourceControl = _ref.sourceControl,
+          reporter = _ref.reporter;
+      var persistQuery;
+      var queryMap;
+
+      if (persistFunction != null || persistedQueryPath != null) {
+        queryMap = new Map();
+        var persistImplmentation = persistFunction || defaultPersistFunction;
+
+        persistQuery = /*#__PURE__*/function () {
+          var _persistQuery = _asyncToGenerator(function* (text) {
+            var id = yield persistImplmentation(text);
+            !(typeof id === 'string') ? process.env.NODE_ENV !== "production" ? invariant(false, 'Expected persist function to return a string, got `%s`.', id) : invariant(false) : void 0;
+            queryMap.set(id, text);
+            return id;
+          });
+
+          function persistQuery(_x4) {
+            return _persistQuery.apply(this, arguments);
+          }
 
-            return persistQuery;
-          }();
-        }
+          return persistQuery;
+        }();
+      }
 
-        var schemaExtensions = languagePlugin.schemaExtensions ? [].concat((0, _toConsumableArray2["default"])(languagePlugin.schemaExtensions), (0, _toConsumableArray2["default"])(relaySchemaExtensions)) : relaySchemaExtensions;
-        var results = yield RelayFileWriter.writeAll({
-          config: {
-            baseDir: baseDir,
-            compilerTransforms: {
-              commonTransforms: commonTransforms,
-              codegenTransforms: codegenTransforms,
-              fragmentTransforms: fragmentTransforms,
-              printTransforms: printTransforms,
-              queryTransforms: queryTransforms
-            },
-            customScalars: customScalars || {},
-            formatModule: languagePlugin.formatModule,
-            optionalInputFieldsForFlow: [],
-            schemaExtensions: schemaExtensions,
-            useHaste: false,
-            noFutureProofEnums: noFutureProofEnums,
-            extension: languagePlugin.outputExtension,
-            typeGenerator: languagePlugin.typeGenerator,
-            outputDir: outputDir,
-            persistQuery: persistQuery
+      var schemaExtensions = languagePlugin.schemaExtensions ? [].concat((0, _toConsumableArray2["default"])(languagePlugin.schemaExtensions), (0, _toConsumableArray2["default"])(relaySchemaExtensions)) : relaySchemaExtensions;
+      var results = yield RelayFileWriter.writeAll({
+        config: {
+          baseDir: baseDir,
+          compilerTransforms: {
+            commonTransforms: commonTransforms,
+            codegenTransforms: codegenTransforms,
+            fragmentTransforms: fragmentTransforms,
+            printTransforms: printTransforms,
+            queryTransforms: queryTransforms
           },
-          onlyValidate: onlyValidate,
-          schema: schema,
-          baseDocuments: baseDocuments,
-          documents: documents,
-          reporter: reporter,
-          sourceControl: sourceControl,
-          languagePlugin: languagePlugin
-        });
-
-        if (queryMap != null && persistedQueryPath != null) {
-          var object = {};
-
-          if (fs.existsSync(persistedQueryPath)) {
-            try {
-              var prevText = fs.readFileSync(persistedQueryPath, 'utf8');
-              var prevData = JSON.parse(prevText);
-
-              if (prevData != null && typeof prevData === 'object') {
-                object = prevData;
-              } else {
-                console.error("Invalid data in persisted query file '".concat(persistedQueryPath, "', expected an object."));
-              }
-            } catch (error) {
-              console.error(error);
-            }
-          }
+          customScalars: customScalars || {},
+          formatModule: languagePlugin.formatModule,
+          optionalInputFieldsForFlow: [],
+          schemaExtensions: schemaExtensions,
+          useHaste: false,
+          noFutureProofEnums: noFutureProofEnums,
+          extension: languagePlugin.outputExtension,
+          typeGenerator: languagePlugin.typeGenerator,
+          outputDir: outputDir,
+          persistQuery: persistQuery,
+          repersist: repersist
+        },
+        onlyValidate: onlyValidate,
+        schema: schema,
+        baseDocuments: baseDocuments,
+        documents: documents,
+        reporter: reporter,
+        sourceControl: sourceControl,
+        languagePlugin: languagePlugin
+      });
 
-          var _iteratorNormalCompletion = true;
-          var _didIteratorError = false;
-          var _iteratorError = undefined;
+      if (queryMap != null && persistedQueryPath != null) {
+        var object = {};
 
+        if (fs.existsSync(persistedQueryPath)) {
           try {
-            for (var _iterator = queryMap.entries()[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true) {
-              var _step$value = _step.value,
-                  id = _step$value[0],
-                  _text = _step$value[1];
-              object[id] = _text;
-            }
-          } catch (err) {
-            _didIteratorError = true;
-            _iteratorError = err;
-          } finally {
-            try {
-              if (!_iteratorNormalCompletion && _iterator["return"] != null) {
-                _iterator["return"]();
-              }
-            } finally {
-              if (_didIteratorError) {
-                throw _iteratorError;
-              }
+            var prevText = fs.readFileSync(persistedQueryPath, 'utf8');
+            var prevData = JSON.parse(prevText);
+
+            if (prevData != null && typeof prevData === 'object') {
+              object = prevData;
+            } else {
+              console.error("Invalid data in persisted query file '".concat(persistedQueryPath, "', expected an object."));
             }
+          } catch (error) {
+            console.error(error);
           }
+        }
 
-          var data = JSON.stringify(object, null, 2);
-          fs.writeFileSync(persistedQueryPath, data, 'utf8');
+        var _iterator = _createForOfIteratorHelper(queryMap.entries()),
+            _step;
+
+        try {
+          for (_iterator.s(); !(_step = _iterator.n()).done;) {
+            var _step$value = _step.value,
+                id = _step$value[0],
+                _text = _step$value[1];
+            object[id] = _text;
+          }
+        } catch (err) {
+          _iterator.e(err);
+        } finally {
+          _iterator.f();
         }
 
-        return results;
-      });
+        var data = JSON.stringify(object, null, 2);
+        fs.writeFileSync(persistedQueryPath, data, 'utf8');
+      }
+
+      return results;
+    });
 
-      return function (_x3) {
-        return _ref2.apply(this, arguments);
-      };
-    }()
-  );
+    return function (_x3) {
+      return _ref2.apply(this, arguments);
+    };
+  }();
 }
 
 function getSchemaSource(schemaPath) {

package/lib/codegen/CodegenDirectory.js

@@ -25,9 +25,7 @@ var invariant = require("fbjs/lib/invariant");
 var path = require('path'); // flowlint nonstrict-import:warn
 
 
-var CodegenDirectory =
-/*#__PURE__*/
-function () {
+var CodegenDirectory = /*#__PURE__*/function () {
   function CodegenDirectory(dir, options) {
     var _this = this;
 
@@ -153,9 +151,7 @@ function () {
     };
   };
 
-  CodegenDirectory.sourceControlAddRemove =
-  /*#__PURE__*/
-  function () {
+  CodegenDirectory.sourceControlAddRemove = /*#__PURE__*/function () {
     var _sourceControlAddRemove = _asyncToGenerator(function* (sourceControl, dirs) {
       var _CodegenDirectory$get = CodegenDirectory.getAddedRemovedFiles(dirs),
           added = _CodegenDirectory$get.added,