metro 0.63.0 → 0.64.0

package/src/ModuleGraph/output/util.js.flow

@@ -55,17 +55,24 @@ function addModuleIdsToModuleWrapper(
 
 exports.addModuleIdsToModuleWrapper = addModuleIdsToModuleWrapper;
 
+type InlineModuleIdsOptions = {
+  dependencyMapReservedName: ?string,
+  globalPrefix: string,
+  ignoreMissingDependencyMapReference?: boolean,
+};
+
 function inlineModuleIds(
   module: Module,
   idForPath: ({path: string, ...}) => number,
   {
     dependencyMapReservedName = undefined,
     globalPrefix,
-  }: {dependencyMapReservedName: ?string, globalPrefix: string} = {},
+    ignoreMissingDependencyMapReference = false,
+  }: InlineModuleIdsOptions,
 ): {
   moduleCode: string,
   moduleMap: ?BasicSourceMap,
-  ...
+  fileId: number,
 } {
   const {dependencies, file} = module;
   const {code, map, path} = file;
@@ -78,7 +85,7 @@ function inlineModuleIds(
 
   if (!dependencyIds.length) {
     // Nothing to inline in this module.
-    return {moduleCode: addParamsToDefineCall(code, fileId), moduleMap: map};
+    return {fileId, moduleCode: code, moduleMap: map};
   }
 
   if (dependencyMapReservedName != null) {
@@ -108,6 +115,10 @@ function inlineModuleIds(
      *    integer printed as a simple sequence of digits.
      */
     if (!code.includes(dependencyMapReservedName)) {
+      if (ignoreMissingDependencyMapReference) {
+        return {fileId, moduleCode: code, moduleMap: map};
+      }
+
       // If we're here, the module was probably generated by some code that
       // doesn't make the dependency map name externally configurable, or a
       // mock that needs to be updated.
@@ -136,35 +147,57 @@ function inlineModuleIds(
       },
     );
     return {
-      moduleCode: addParamsToDefineCall(inlinedCode, fileId),
+      fileId,
+      moduleCode: inlinedCode,
       moduleMap: map,
     };
   }
-  const {ast} = transformSync(code, {
-    ast: true,
-    babelrc: false,
-    code: false,
-    configFile: false,
-    plugins: [
-      ...passthroughSyntaxPlugins,
-      [reverseDependencyMapReferences, {dependencyIds, globalPrefix}],
-    ],
-  });
+  const ast = nullthrows(
+    transformSync(code, {
+      ast: true,
+      babelrc: false,
+      code: false,
+      configFile: false,
+      plugins: [
+        ...passthroughSyntaxPlugins,
+        [reverseDependencyMapReferences, {dependencyIds, globalPrefix}],
+      ],
+    }).ast,
+  );
 
   const {code: generatedCode, map: generatedMap} = generate(ast, path, '');
 
   return {
-    moduleCode: addParamsToDefineCall(generatedCode, fileId),
+    fileId,
+    moduleCode: generatedCode,
     moduleMap: map && generatedMap && mergeSourceMaps(path, map, generatedMap),
   };
 }
 
-function escapeRegex(str: string): string {
-  // From http://stackoverflow.com/questions/14076210/
-  return str.replace(/([.?*+\^$\[\]\\(){}|\-])/g, '\\$1');
+function inlineModuleIdsAndAddParamsToDefineCall(
+  module: Module,
+  idForPath: ({path: string, ...}) => number,
+  options: InlineModuleIdsOptions,
+): {
+  moduleCode: string,
+  moduleMap: ?BasicSourceMap,
+} {
+  const {fileId, moduleCode, moduleMap} = inlineModuleIds(
+    module,
+    idForPath,
+    options,
+  );
+
+  return {moduleCode: addParamsToDefineCall(moduleCode, fileId), moduleMap};
 }
 
 exports.inlineModuleIds = inlineModuleIds;
+exports.inlineModuleIdsAndAddParamsToDefineCall = inlineModuleIdsAndAddParamsToDefineCall;
+
+function escapeRegex(str: string): string {
+  // From http://stackoverflow.com/questions/14076210/
+  return str.replace(/([.?*+^$[\]\\(){}|-])/g, '\\$1');
+}
 
 type IdForPathFn = ({path: string, ...}) => number;
 
@@ -180,7 +213,6 @@ function getModuleCodeAndMap(
     enableIDInlining: boolean,
     dependencyMapReservedName: ?string,
     globalPrefix: string,
-    ...
   }>,
 ): {|
   moduleCode: string,
@@ -196,10 +228,14 @@ function getModuleCodeAndMap(
     moduleCode = addModuleIdsToModuleWrapper(module, idForPath);
     moduleMap = file.map;
   } else {
-    ({moduleCode, moduleMap} = inlineModuleIds(module, idForPath, {
-      dependencyMapReservedName: options.dependencyMapReservedName,
-      globalPrefix: options.globalPrefix,
-    }));
+    ({moduleCode, moduleMap} = inlineModuleIdsAndAddParamsToDefineCall(
+      module,
+      idForPath,
+      {
+        dependencyMapReservedName: options.dependencyMapReservedName,
+        globalPrefix: options.globalPrefix,
+      },
+    ));
   }
   if (moduleMap && moduleMap.sources) {
     const x_facebook_sources = [];

package/src/ModuleGraph/test-helpers.js

@@ -10,11 +10,83 @@
 
 const generate = require("@babel/generator").default;
 
+const _require = require("jest-snapshot"),
+  toMatchSnapshot = _require.toMatchSnapshot;
+
 const generateOptions = {
   concise: true,
   sourceType: "module"
 };
 
-exports.codeFromAst = ast => generate(ast, generateOptions).code;
+const codeFromAst = ast => generate(ast, generateOptions).code;
+
+const comparableCode = code => code.trim().replace(/\s+/g, " ");
+
+function toEqualComparableCode(received, expected) {
+  const comparableExpected = comparableCode(expected);
+  const pass = received === comparableExpected;
+  const options = {
+    isNot: this.isNot,
+    promise: this.promise
+  };
+  const message = pass
+    ? () =>
+        this.utils.matcherHint(
+          "toEqualComparableCode",
+          undefined,
+          undefined,
+          options
+        ) +
+        "\n\n" +
+        `Expected: not ${this.utils.printExpected(comparableExpected)}\n` +
+        `Received: ${this.utils.printReceived(received)}`
+    : () => {
+        const diffString = this.utils.printDiffOrStringify(
+          comparableExpected,
+          received,
+          "expected",
+          "received",
+          this.expand
+        );
+        return (
+          this.utils.matcherHint(
+            "toEqualComparableCode",
+            undefined,
+            undefined,
+            options
+          ) +
+          "\n\n" +
+          diffString
+        );
+      };
+  return {
+    actual: received,
+    message,
+    pass
+  };
+} // See https://superuser.com/questions/380772/removing-ansi-color-codes-from-text-stream
 
-exports.comparableCode = code => code.trim().replace(/\s+/g, " ");
+const ANSI_PATTERN = /\x1b\[[0-9;]*m/g;
+
+function trimANSICodes(input) {
+  return input.replace(ANSI_PATTERN, "");
+}
+/**
+ * Matches a text that contains ANSI control codes (e.g. [39m^) against a snapshot.
+ * Usage: Call expect.extend({toMatchCodeFrameSnapshot}) to add the matcher in your test
+ */
+
+function toMatchCodeFrameSnapshot(received) {
+  return toMatchSnapshot.call(
+    this,
+    trimANSICodes(received),
+    "toMatchCodeFrameSnapshot"
+  );
+}
+
+module.exports = {
+  codeFromAst,
+  comparableCode,
+  toEqualComparableCode,
+  toMatchCodeFrameSnapshot
+};

package/src/ModuleGraph/types.flow.js.flow

@@ -23,6 +23,7 @@ export type Callback<A = void, B = void> = (Error => void) &
   ((null | void, A, B) => void);
 
 export type Dependency = {|
+  // The module name or path used to require the dependency
   id: string,
   +isAsync: boolean,
   +isPrefetchOnly: boolean,
@@ -128,29 +129,33 @@ export type ResolveFn = (id: string, source: ?string) => string;
 
 export type TransformResult = ConcreteTransformResult | LinkedTransformResult;
 
+export type ImportNames = {
+  all: string,
+  default: string,
+};
+
 export type ConcreteTransformResult = {
+  type: 'concrete',
   code: string,
   dependencies: $ReadOnlyArray<TransformResultDependency>,
   dependencyMapName?: string,
   map: ?BasicSourceMap,
   requireName: string,
   soundResources?: ?Array<string>,
-  importNames?: {
-    all: string,
-    default: string,
-    ...
-  },
+  importNames?: ImportNames,
   isESModule?: true,
 };
 
-export type LinkedTransformResult = $ReadOnly<{sourceVariantName: string}>;
+export type LinkedTransformResult = $ReadOnly<{
+  type: 'linked',
+  sourceVariantName: string,
+}>;
 
 export type TransformResults = {
   +[string]: TransformResult,
-  ...,
 };
 
-export type TransformVariants = {+[name: string]: {...}, ...};
+export type TransformVariants = {+[name: string]: {...}};
 
 export type TransformedCodeFile = {|
   +file: string,

package/src/ModuleGraph/worker/JsFileWrapping.js

@@ -9,18 +9,83 @@
  */
 "use strict";
 
-const t = require("@babel/types");
+var _template = _interopRequireDefault(require("@babel/template"));
 
-const template = require("@babel/template").default;
+var _traverse = _interopRequireDefault(require("@babel/traverse"));
 
-const traverse = require("@babel/traverse").default;
+var t = _interopRequireWildcard(require("@babel/types"));
+
+var _invariant = _interopRequireDefault(require("invariant"));
+
+function _getRequireWildcardCache() {
+  if (typeof WeakMap !== "function") return null;
+  var cache = new WeakMap();
+
+  _getRequireWildcardCache = function() {
+    return cache;
+  };
+
+  return cache;
+}
+
+function _interopRequireWildcard(obj) {
+  if (obj && obj.__esModule) {
+    return obj;
+  }
+
+  if (obj === null || (typeof obj !== "object" && typeof obj !== "function")) {
+    return {
+      default: obj
+    };
+  }
+
+  var cache = _getRequireWildcardCache();
+
+  if (cache && cache.has(obj)) {
+    return cache.get(obj);
+  }
+
+  var newObj = {};
+  var hasPropertyDescriptor =
+    Object.defineProperty && Object.getOwnPropertyDescriptor;
+
+  for (var key in obj) {
+    if (Object.prototype.hasOwnProperty.call(obj, key)) {
+      var desc = hasPropertyDescriptor
+        ? Object.getOwnPropertyDescriptor(obj, key)
+        : null;
+
+      if (desc && (desc.get || desc.set)) {
+        Object.defineProperty(newObj, key, desc);
+      } else {
+        newObj[key] = obj[key];
+      }
+    }
+  }
+
+  newObj.default = obj;
+
+  if (cache) {
+    cache.set(obj, newObj);
+  }
+
+  return newObj;
+}
+
+function _interopRequireDefault(obj) {
+  return obj && obj.__esModule
+    ? obj
+    : {
+        default: obj
+      };
+}
 
 const WRAP_NAME = "$$_REQUIRE"; // note: babel will prefix this with _
 // Check first the `global` variable as the global object. This way serializers
 // can create a local variable called global to fake it as a global object
 // without having to pollute the window object on web.
 
-const IIFE_PARAM = template(
+const IIFE_PARAM = _template.default.expression(
   "typeof globalThis !== 'undefined' ? globalThis : typeof global !== 'undefined' ? global : typeof window !== 'undefined' ? window : this"
 );
 
@@ -48,27 +113,31 @@ function wrapModule(
 
 function wrapPolyfill(fileAst) {
   const factory = functionFromProgram(fileAst.program, ["global"]);
-  const iife = t.callExpression(factory, [IIFE_PARAM().expression]);
+  const iife = t.callExpression(factory, [IIFE_PARAM()]);
   return t.file(t.program([t.expressionStatement(iife)]));
 }
 
+function jsonToCommonJS(source) {
+  return `module.exports = ${source};`;
+}
+
 function wrapJson(source, globalPrefix) {
   // Unused parameters; remember that's wrapping JSON.
   const moduleFactoryParameters = buildParameters(
-    "_aUnused",
-    "_bUnused",
-    "_cUnused"
+    "_importDefaultUnused",
+    "_importAllUnused",
+    "_dependencyMapUnused"
   );
   return [
     `${globalPrefix}__d(function(${moduleFactoryParameters.join(", ")}) {`,
-    `  module.exports = ${source};`,
+    `  ${jsonToCommonJS(source)}`,
     "});"
   ].join("\n");
 }
 
 function functionFromProgram(program, parameters) {
   return t.functionExpression(
-    t.identifier(""),
+    undefined,
     parameters.map(makeIdentifier),
     t.blockStatement(program.body, program.directives)
   );
@@ -88,13 +157,21 @@ function buildParameters(importDefaultName, importAllName, dependencyMapName) {
     "exports",
     dependencyMapName
   ];
-}
+} // Renaming requires should ideally only be done when generating for the target
+// that expects the custom require name in the optimize step.
+// This visitor currently renames all `require` references even if the module
+// contains a custom `require` declaration. This should be fixed by only renaming
+// if the `require` symbol hasn't been redeclared.
 
 function renameRequires(ast) {
   let newRequireName = WRAP_NAME;
-  traverse(ast, {
+  (0, _traverse.default)(ast, {
     Program(path) {
       const body = path.get("body.0.expression.arguments.0.body");
+      (0, _invariant.default)(
+        !Array.isArray(body),
+        "metro: Expected `body` to be a single path."
+      );
       newRequireName = body.scope.generateUid(WRAP_NAME);
       body.scope.rename("require", newRequireName);
     }
@@ -105,6 +182,7 @@ function renameRequires(ast) {
 module.exports = {
   WRAP_NAME,
   wrapJson,
+  jsonToCommonJS,
   wrapModule,
   wrapPolyfill
 };

package/src/ModuleGraph/worker/JsFileWrapping.js.flow

@@ -10,31 +10,30 @@
 
 'use strict';
 
-const t = require('@babel/types');
-const template = require('@babel/template').default;
-const traverse = require('@babel/traverse').default;
-
-import type {Ast} from '@babel/core';
+import template from '@babel/template';
+import traverse from '@babel/traverse';
+import * as t from '@babel/types';
+import type {Program, FunctionExpression, Identifier} from '@babel/types';
+import invariant from 'invariant';
 
 const WRAP_NAME = '$$_REQUIRE'; // note: babel will prefix this with _
 
 // Check first the `global` variable as the global object. This way serializers
 // can create a local variable called global to fake it as a global object
 // without having to pollute the window object on web.
-const IIFE_PARAM = template(
+const IIFE_PARAM = template.expression(
   "typeof globalThis !== 'undefined' ? globalThis : typeof global !== 'undefined' ? global : typeof window !== 'undefined' ? window : this",
 );
 
 function wrapModule(
-  fileAst: Ast,
+  fileAst: BabelNodeFile,
   importDefaultName: string,
   importAllName: string,
   dependencyMapName: string,
   globalPrefix: string,
 ): {
-  ast: Ast,
+  ast: BabelNodeFile,
   requireName: string,
-  ...
 } {
   const params = buildParameters(
     importDefaultName,
@@ -50,40 +49,44 @@ function wrapModule(
   return {ast, requireName};
 }
 
-function wrapPolyfill(fileAst: Ast): Ast {
+function wrapPolyfill(fileAst: BabelNodeFile): BabelNodeFile {
   const factory = functionFromProgram(fileAst.program, ['global']);
 
-  const iife = t.callExpression(factory, [IIFE_PARAM().expression]);
+  const iife = t.callExpression(factory, [IIFE_PARAM()]);
   return t.file(t.program([t.expressionStatement(iife)]));
 }
 
+function jsonToCommonJS(source: string): string {
+  return `module.exports = ${source};`;
+}
+
 function wrapJson(source: string, globalPrefix: string): string {
   // Unused parameters; remember that's wrapping JSON.
   const moduleFactoryParameters = buildParameters(
-    '_aUnused',
-    '_bUnused',
-    '_cUnused',
+    '_importDefaultUnused',
+    '_importAllUnused',
+    '_dependencyMapUnused',
   );
 
   return [
     `${globalPrefix}__d(function(${moduleFactoryParameters.join(', ')}) {`,
-    `  module.exports = ${source};`,
+    `  ${jsonToCommonJS(source)}`,
     '});',
   ].join('\n');
 }
 
 function functionFromProgram(
-  program: Ast,
+  program: Program,
   parameters: $ReadOnlyArray<string>,
-): Ast {
+): FunctionExpression {
   return t.functionExpression(
-    t.identifier(''),
+    undefined,
     parameters.map(makeIdentifier),
     t.blockStatement(program.body, program.directives),
   );
 }
 
-function makeIdentifier(name: string): Ast {
+function makeIdentifier(name: string): Identifier {
   return t.identifier(name);
 }
 
@@ -103,13 +106,23 @@ function buildParameters(
   ];
 }
 
-function renameRequires(ast: Ast): string {
+// Renaming requires should ideally only be done when generating for the target
+// that expects the custom require name in the optimize step.
+// This visitor currently renames all `require` references even if the module
+// contains a custom `require` declaration. This should be fixed by only renaming
+// if the `require` symbol hasn't been redeclared.
+function renameRequires(ast: BabelNodeFile): string {
   let newRequireName = WRAP_NAME;
 
   traverse(ast, {
     Program(path) {
       const body = path.get('body.0.expression.arguments.0.body');
 
+      invariant(
+        !Array.isArray(body),
+        'metro: Expected `body` to be a single path.',
+      );
+
       newRequireName = body.scope.generateUid(WRAP_NAME);
       body.scope.rename('require', newRequireName);
     },
@@ -122,6 +135,7 @@ module.exports = {
   WRAP_NAME,
 
   wrapJson,
+  jsonToCommonJS,
   wrapModule,
   wrapPolyfill,
 };