metro 0.70.3 → 0.71.2

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

@@ -22,19 +22,19 @@ export type BuildResult = GraphResult;
 export type Callback<A = void, B = void> = (Error => void) &
   ((null | void, A, B) => void);
 
-export type Dependency = {|
+export type Dependency = {
   // The module name or path used to require the dependency
   id: string,
   +isAsync: boolean,
   +isPrefetchOnly: boolean,
-  +splitCondition: ?{|
+  +splitCondition: ?{
     +mobileConfigName: string,
-  |},
+  },
   path: string,
   +locs: $ReadOnlyArray<BabelSourceLocation>,
-|};
+};
 
-export type File = {|
+export type File = {
   code: string,
   map: ?BasicSourceMap,
   functionMap: ?FBSourceFunctionMap,
@@ -42,7 +42,7 @@ export type File = {|
   type: CodeFileTypes,
   libraryIdx: ?number,
   soundResources?: ?Array<string>,
-|};
+};
 
 type CodeFileTypes = 'module' | 'script';
 
@@ -51,11 +51,11 @@ export type GraphFn = (
   // platform: string,
 ) => GraphResult;
 
-export type GraphResult = {|
+export type GraphResult = {
   modules: Array<Module>,
-|};
+};
 
-export type ModuleIds = {|
+export type ModuleIds = {
   /**
    * The module ID is global across all segments and identifies the module
    * uniquely. This is useful to cache modules that has been loaded already at
@@ -71,7 +71,7 @@ export type ModuleIds = {|
    * case this property does not apply and will be omitted.
    */
   +localId?: number,
-|};
+};
 
 /**
  * Indempotent function that gets us the IDs corresponding to a particular
@@ -87,17 +87,17 @@ export type LoadResult = {
 
 export type LoadFn = (file: string) => LoadResult;
 
-export type Module = {|
+export type Module = {
   dependencies: Array<Dependency>,
   file: File,
-|};
+};
 
 export type PostProcessModules = (
   modules: $ReadOnlyArray<Module>,
   entryPoints: Array<string>,
 ) => $ReadOnlyArray<Module>;
 
-export type OutputFnArg = {|
+export type OutputFnArg = {
   dependencyMapReservedName?: ?string,
   filename: string,
   globalPrefix: string,
@@ -107,22 +107,22 @@ export type OutputFnArg = {|
   sourceMapPath?: ?string,
   enableIDInlining: boolean,
   segmentID: number,
-|};
+};
 export type OutputFn<M: MixedSourceMap = MixedSourceMap> =
   OutputFnArg => OutputResult<M>;
 
-export type OutputResult<M: MixedSourceMap> = {|
+export type OutputResult<M: MixedSourceMap> = {
   code: string | Buffer,
   extraFiles?: Iterable<[string, string | Buffer]>,
   map: M,
-|};
+};
 
-export type PackageData = {|
+export type PackageData = {
   browser?: Object | string,
   main?: string,
   name?: string,
   'react-native'?: Object | string,
-|};
+};
 
 export type ResolveFn = (id: string, source: ?string) => string;
 
@@ -159,16 +159,16 @@ export type TransformResults = {
 
 export type TransformVariants = {+[name: string]: {...}};
 
-export type TransformedCodeFile = {|
+export type TransformedCodeFile = {
   +file: string,
   +functionMap: ?FBSourceFunctionMap,
   +hasteID: ?string,
   +package?: PackageData,
   +transformed: TransformResults,
   +type: CodeFileTypes,
-|};
+};
 
-export type ImageSize = {|+width: number, +height: number|};
+export type ImageSize = {+width: number, +height: number};
 
 export type AssetFileVariant = $ReadOnly<{
   /**
@@ -228,24 +228,24 @@ export type AssetFile = $ReadOnly<{
 }>;
 
 export type TransformedSourceFile =
-  | {|
+  | {
       +type: 'code',
       +details: TransformedCodeFile,
-    |}
-  | {|
+    }
+  | {
       +type: 'asset',
       +details: AssetFile,
-    |}
-  | {|
+    }
+  | {
       +type: 'unknown',
-    |};
+    };
 
-export type LibraryOptions = {|
+export type LibraryOptions = {
   dependencies?: Array<string>,
   optimize: boolean,
   platform?: string,
   rebasePath: string => string,
-|};
+};
 
 export type Base64Content = string;
 export type AssetContents = {
@@ -258,7 +258,7 @@ export type AssetContentsByPath = {
   ...
 };
 
-export type ResolvedCodeFile = {|
+export type ResolvedCodeFile = {
   +codeFile: TransformedCodeFile,
   /**
    * Imagine we have a source file that contains a `require('foo')`. The library
@@ -267,35 +267,35 @@ export type ResolvedCodeFile = {|
    * `{'foo': 'bar/foo.js', 'bar': 'node_modules/bar/index.js'}`.
    */
   +filePathsByDependencyName: {[dependencyName: string]: string, ...},
-|};
+};
 
-export type LibraryBoundCodeFile = {|
+export type LibraryBoundCodeFile = {
   ...ResolvedCodeFile,
   /**
    * Index of the library that this code file has been exported from.
    */
   +libraryIdx: number,
-|};
+};
 
 /**
  * Describe a set of JavaScript files and the associated assets. It could be
  * depending on modules from other libraries. To be able to resolve these
  * dependencies, these libraries need to be provided by callsites (ex. Buck).
  */
-export type Library = {|
+export type Library = {
   +files: Array<TransformedCodeFile>,
   /* cannot be a Map because it's JSONified later on */
   +assets: AssetContentsByPath,
-|};
+};
 
 /**
  * Just like a `Library`, but it also contains module resolutions. For example
  * if there is a `require('foo')` in some JavaScript file, we keep track of the
  * path it resolves to, ex. `beep/glo/foo.js`.
  */
-export type ResolvedLibrary = {|
+export type ResolvedLibrary = {
   +files: $ReadOnlyArray<ResolvedCodeFile>,
   /* cannot be a Map because it's JSONified later on */
   +assets: AssetContentsByPath,
   +isPartiallyResolved?: boolean,
-|};
+};

package/src/ModuleGraph/worker/collectDependencies.js

@@ -53,6 +53,7 @@ function collectDependencies(ast, options) {
     dynamicRequires: options.dynamicRequires,
     keepRequireNames: options.keepRequireNames,
     allowOptionalDependencies: options.allowOptionalDependencies,
+    unstable_allowRequireContext: options.unstable_allowRequireContext,
   };
   const visitor = {
     CallExpression(path, state) {
@@ -97,6 +98,22 @@ function collectDependencies(ast, options) {
           splitCondition: args[1],
         });
         return;
+      } // Match `require.context`
+
+      if (
+        // Feature gate, defaults to `false`.
+        state.unstable_allowRequireContext &&
+        callee.type === "MemberExpression" && // `require`
+        callee.object.type === "Identifier" &&
+        callee.object.name === "require" && // `context`
+        callee.property.type === "Identifier" &&
+        callee.property.name === "context" &&
+        !callee.computed && // Ensure `require` refers to the global and not something else.
+        !path.scope.getBinding("require")
+      ) {
+        processRequireContextCall(path, state);
+        visited.add(path.node);
+        return;
       }
 
       if (
@@ -148,6 +165,146 @@ function collectDependencies(ast, options) {
     dependencyMapName: nullthrows(state.dependencyMapIdentifier).name,
   };
 }
+/** Extract args passed to the `require.context` method. */
+
+function getRequireContextArgs(path) {
+  const args = path.get("arguments");
+  let directory;
+
+  if (!Array.isArray(args) || args.length < 1) {
+    throw new InvalidRequireCallError(path);
+  } else {
+    const result = args[0].evaluate();
+
+    if (result.confident && typeof result.value === "string") {
+      directory = result.value;
+    } else {
+      var _result$deopt;
+
+      throw new InvalidRequireCallError(
+        (_result$deopt = result.deopt) !== null && _result$deopt !== void 0
+          ? _result$deopt
+          : args[0],
+        "First argument of `require.context` should be a string denoting the directory to require."
+      );
+    }
+  } // Default to requiring through all directories.
+
+  let recursive = true;
+
+  if (args.length > 1) {
+    const result = args[1].evaluate();
+
+    if (result.confident && typeof result.value === "boolean") {
+      recursive = result.value;
+    } else if (!(result.confident && typeof result.value === "undefined")) {
+      var _result$deopt2;
+
+      throw new InvalidRequireCallError(
+        (_result$deopt2 = result.deopt) !== null && _result$deopt2 !== void 0
+          ? _result$deopt2
+          : args[1],
+        "Second argument of `require.context` should be an optional boolean indicating if files should be imported recursively or not."
+      );
+    }
+  } // Default to all files.
+
+  let filter = {
+    pattern: ".*",
+    flags: "",
+  };
+
+  if (args.length > 2) {
+    // evaluate() to check for undefined (because it's technically a scope lookup)
+    // but check the AST for the regex literal, since evaluate() doesn't do regex.
+    const result = args[2].evaluate();
+    const argNode = args[2].node;
+
+    if (argNode.type === "RegExpLiteral") {
+      // TODO: Handle `new RegExp(...)` -- `argNode.type === 'NewExpression'`
+      filter = {
+        pattern: argNode.pattern,
+        flags: argNode.flags || "",
+      };
+    } else if (!(result.confident && typeof result.value === "undefined")) {
+      throw new InvalidRequireCallError(
+        args[2],
+        `Third argument of \`require.context\` should be an optional RegExp pattern matching all of the files to import, instead found node of type: ${argNode.type}.`
+      );
+    }
+  } // Default to `sync`.
+
+  let mode = "sync";
+
+  if (args.length > 3) {
+    const result = args[3].evaluate();
+
+    if (result.confident && typeof result.value === "string") {
+      mode = getContextMode(args[3], result.value);
+    } else if (!(result.confident && typeof result.value === "undefined")) {
+      var _result$deopt3;
+
+      throw new InvalidRequireCallError(
+        (_result$deopt3 = result.deopt) !== null && _result$deopt3 !== void 0
+          ? _result$deopt3
+          : args[3],
+        'Fourth argument of `require.context` should be an optional string "mode" denoting how the modules will be resolved.'
+      );
+    }
+  }
+
+  if (args.length > 4) {
+    throw new InvalidRequireCallError(
+      path,
+      `Too many arguments provided to \`require.context\` call. Expected 4, got: ${args.length}`
+    );
+  }
+
+  return [
+    directory,
+    {
+      recursive,
+      filter,
+      mode,
+    },
+  ];
+}
+
+function getContextMode(path, mode) {
+  if (
+    mode === "sync" ||
+    mode === "eager" ||
+    mode === "lazy" ||
+    mode === "lazy-once"
+  ) {
+    return mode;
+  }
+
+  throw new InvalidRequireCallError(
+    path,
+    `require.context "${mode}" mode is not supported. Expected one of: sync, eager, lazy, lazy-once`
+  );
+}
+
+function processRequireContextCall(path, state) {
+  const [directory, contextParams] = getRequireContextArgs(path);
+  const transformer = state.dependencyTransformer;
+  const dep = registerDependency(
+    state,
+    {
+      // We basically want to "import" every file in a folder and then filter them out with the given `filter` RegExp.
+      name: directory,
+      // Capture the matching context
+      contextParams,
+      asyncType: null,
+      optional: isOptionalDependency(directory, path, state),
+    },
+    path
+  ); // require() the generated module representing this context
+
+  path.get("callee").replaceWith(types.identifier("require"));
+  transformer.transformSyncRequire(path, dep, state);
+}
 
 function collectImports(path, state) {
   if (path.node.source) {
@@ -309,10 +466,15 @@ function getModuleNameFromCallArgs(path) {
 collectDependencies.getModuleNameFromCallArgs = getModuleNameFromCallArgs;
 
 class InvalidRequireCallError extends Error {
-  constructor({ node }) {
+  constructor({ node }, message) {
     const line = node.loc && node.loc.start && node.loc.start.line;
     super(
-      `Invalid call at line ${line || "<unknown>"}: ${generate(node).code}`
+      [
+        `Invalid call at line ${line || "<unknown>"}: ${generate(node).code}`,
+        message,
+      ]
+        .filter(Boolean)
+        .join("\n")
     );
   }
 }
@@ -348,9 +510,11 @@ const makeJSResourceTemplate = template.statement(`
 const DefaultDependencyTransformer = {
   transformSyncRequire(path, dependency, state) {
     const moduleIDExpression = createModuleIDExpression(dependency, state);
-    path.node.arguments = state.keepRequireNames
-      ? [moduleIDExpression, types.stringLiteral(dependency.name)]
-      : [moduleIDExpression];
+    path.node.arguments = [moduleIDExpression]; // Always add the debug name argument last
+
+    if (state.keepRequireNames) {
+      path.node.arguments.push(types.stringLiteral(dependency.name));
+    }
   },
 
   transformImportCall(path, dependency, state) {
@@ -420,12 +584,51 @@ function createModuleIDExpression(dependency, state) {
 function createModuleNameLiteral(dependency) {
   return types.stringLiteral(dependency.name);
 }
+/**
+ * Given an import qualifier, return a key used to register the dependency.
+ * Generally this return the `ImportQualifier.name` property, but in the case
+ * of `require.context` more attributes can be appended to distinguish various combinations that would otherwise conflict.
+ *
+ * For example, the following case would have collision issues if they all utilized the `name` property:
+ * ```
+ * require('./foo');
+ * require.context('./foo');
+ * require.context('./foo', true, /something/);
+ * require.context('./foo', false, /something/);
+ * require.context('./foo', false, /something/, 'lazy');
+ * ```
+ *
+ * This method should be utilized by `registerDependency`.
+ */
+
+function getKeyForDependency(qualifier) {
+  let key = qualifier.name;
+  const { contextParams } = qualifier; // Add extra qualifiers when using `require.context` to prevent collisions.
+
+  if (contextParams) {
+    // NOTE(EvanBacon): Keep this synchronized with `RequireContextParams`, if any other properties are added
+    // then this key algorithm should be updated to account for those properties.
+    // Example: `./directory__true__/foobar/m__lazy`
+    key += [
+      "",
+      "context",
+      String(contextParams.recursive),
+      String(contextParams.filter.pattern),
+      String(contextParams.filter.flags),
+      contextParams.mode, // Join together and append to the name:
+    ].join("__");
+  }
+
+  return key;
+}
 
 class DefaultModuleDependencyRegistry {
   _dependencies = new Map();
 
   registerDependency(qualifier) {
-    let dependency = this._dependencies.get(qualifier.name);
+    const key = getKeyForDependency(qualifier);
+
+    let dependency = this._dependencies.get(key);
 
     if (dependency == null) {
       const newDependency = {
@@ -439,15 +642,19 @@ class DefaultModuleDependencyRegistry {
         newDependency.isOptional = true;
       }
 
+      if (qualifier.contextParams) {
+        newDependency.contextParams = qualifier.contextParams;
+      }
+
       dependency = newDependency;
 
-      this._dependencies.set(qualifier.name, dependency);
+      this._dependencies.set(key, dependency);
     } else {
       const original = dependency;
       dependency = collapseDependencies(original, qualifier);
 
       if (original !== dependency) {
-        this._dependencies.set(qualifier.name, dependency);
+        this._dependencies.set(key, dependency);
       }
     }