Replace projectRoots with projectRoot + watchRoots

Reviewed By: rafeca

Differential Revision: D8450498

fbshipit-source-id: 830c21e847c3236e42d5414a8587508cb73864bd

Author: Alexey Kureev

packages/metro/src/Bundler.js

@@ -83,13 +83,14 @@ export type Options = {|
   +polyfillModuleNames: Array<string>,
   +postMinifyProcess: PostMinifyProcess,
   +postProcessBundleSourcemap: PostProcessBundleSourcemap,
-  +projectRoots: $ReadOnlyArray<string>,
+  +projectRoot: string,
   +providesModuleNodeModules?: Array<string>,
   +reporter: Reporter,
   +resolveRequest: ?CustomResolver,
   +sourceExts: Array<string>,
   +transformModulePath: string,
   +watch: boolean,
+  +watchFolders: $ReadOnlyArray<string>,
   +workerPath: ?string,
 |};
 
@@ -101,17 +102,17 @@ class Bundler {
   _baseHash: string;
   _transformer: Transformer;
   _depGraphPromise: Promise<DependencyGraph>;
-  _projectRoots: $ReadOnlyArray<string>;
+  _projectRoot: string;
   _getTransformOptions: void | GetTransformOptions;
 
   constructor(opts: Options) {
-    opts.projectRoots.forEach(verifyRootExists);
+    opts.watchFolders.forEach(verifyRootExists);
 
     const getTransformCacheKey = getTransformCacheKeyFn({
       asyncRequireModulePath: opts.asyncRequireModulePath,
       cacheVersion: opts.cacheVersion,
       dynamicDepsInPackages: opts.dynamicDepsInPackages,
-      projectRoots: opts.projectRoots,
+      projectRoot: opts.projectRoot,
       transformModulePath: opts.transformModulePath,
     });
 
@@ -140,13 +141,14 @@ class Bundler {
       mainFields: opts.getResolverMainFields(),
       maxWorkers: opts.maxWorkers,
       platforms: new Set(opts.platforms),
-      projectRoots: opts.projectRoots,
+      projectRoot: opts.projectRoot,
       providesModuleNodeModules:
         opts.providesModuleNodeModules || defaults.providesModuleNodeModules,
       reporter: opts.reporter,
       resolveRequest: opts.resolveRequest,
       sourceExts: opts.sourceExts,
       watch: opts.watch,
+      watchFolders: opts.watchFolders,
     });
 
     this._baseHash = stableHash([
@@ -156,7 +158,7 @@ class Bundler {
       opts.minifierPath,
     ]).toString('binary');
 
-    this._projectRoots = opts.projectRoots;
+    this._projectRoot = opts.projectRoot;
     this._getTransformOptions = opts.getTransformOptions;
   }
 
@@ -205,7 +207,7 @@ class Bundler {
   } {
     return {
       enableBabelRCLookup: this._opts.enableBabelRCLookup,
-      projectRoot: this._projectRoots[0],
+      projectRoot: this._projectRoot,
     };
   }
 
@@ -241,7 +243,7 @@ class Bundler {
       }
     }
 
-    const localPath = toLocalPath(this._projectRoots, filePath);
+    const localPath = toLocalPath(this._opts.watchFolders, filePath);
 
     const partialKey = stableHash([
       // This is the hash related to the global Bundler config.

packages/metro/src/Bundler/__tests__/Bundler-test.js

@@ -43,24 +43,28 @@ var commonOptions = {
   minifierPath: defaults.DEFAULT_METRO_MINIFIER_PATH,
   platforms: defaults.platforms,
   postMinifyProcess: e => e,
+  projectRoot: '/root',
   resetCache: false,
   sourceExts: defaults.sourceExts,
   transformModulePath: '/path/to/transformer.js',
   watch: false,
+  watchFolders: ['/root'],
 };
 
 describe('Bundler', function() {
   let bundler;
   let assetServer;
-  let projectRoots;
+  let watchFolders;
+  let projectRoot;
 
   beforeEach(function() {
     os.cpus.mockReturnValue({length: 1});
     // local directory on purpose, because it should not actually write
     // anything to the disk during a unit test!
     os.tmpDir.mockReturnValue(path.join(__dirname));
 
-    projectRoots = ['/root'];
+    projectRoot = '/root';
+    watchFolders = [projectRoot];
 
     mkdirp.sync('/path/to');
     mkdirp.sync('/root');
@@ -72,7 +76,7 @@ describe('Bundler', function() {
 
     bundler = new Bundler({
       ...commonOptions,
-      projectRoots,
+      watchFolders,
       assetServer,
     });
 
@@ -90,7 +94,7 @@ describe('Bundler', function() {
     ]);
     const b = new Bundler({
       ...commonOptions,
-      projectRoots,
+      watchFolders,
       assetServer,
       platforms: ['android', 'vr'],
     });
@@ -104,7 +108,7 @@ describe('Bundler', function() {
     const bundlerInstance = new Bundler({
       ...commonOptions,
       cacheStores: [{get, set}],
-      projectRoots,
+      watchFolders,
     });
 
     const depGraph = {

packages/metro/src/Config.js

@@ -95,7 +95,22 @@ export type ConfigT = {
    */
   getPlatforms: () => Array<string>,
 
-  getProjectRoots(): Array<string>,
+  /**
+   * Specify a list of project roots
+   * @deprecated Previousely used to set up a list of watchers (one per
+   * directory). Discontinued in a favor of getProjectRoot and getWatchFolders
+   */
+  getProjectRoots: ?() => Array<string>,
+
+  /**
+   * Specify a root folder of the user project
+   */
+  getProjectRoot: () => string,
+
+  /**
+   * Specify any additional (to projectRoot) watch folders
+   */
+  getWatchFolders: () => Array<string>,
 
   /**
    * Specify any additional node modules that should be processed for
@@ -201,9 +216,11 @@ const DEFAULT = ({
   getEnableBabelRCLookup: () => true,
   getPlatforms: () => [],
   getPolyfillModuleNames: () => [],
+  getProjectRoots: undefined,
   // We assume the default project path is two levels up from
   // node_modules/metro/
-  getProjectRoots: () => [path.resolve(__dirname, '../../..')],
+  getProjectRoot: () => path.resolve(__dirname, '../../..'),
+  getWatchFolders: () => [],
   getProvidesModuleNodeModules: () => providesModuleNodeModules.slice(),
   getRunModuleStatement: (moduleId: number | string) =>
     `require(${JSON.stringify(moduleId)});`,
@@ -221,10 +238,37 @@ const DEFAULT = ({
 }: ConfigT);
 
 const normalize = (initialConfig: ConfigT, defaults?: ConfigT): ConfigT => {
-  return {
+  const normalizedConfig: ConfigT = {
     ...(defaults || DEFAULT),
     ...initialConfig,
   };
+
+  const watchFolders = normalizedConfig.getWatchFolders();
+  const projectRoot = normalizedConfig.getProjectRoot();
+
+  // TODO: Remove me once getProjectRoots is finally deprecated
+  if (normalizedConfig.getProjectRoots) {
+    const legacyProjectRoots = normalizedConfig.getProjectRoots();
+    normalizedConfig.getProjectRoot = () => legacyProjectRoots[0];
+    normalizedConfig.getWatchFolders = () => legacyProjectRoots;
+    normalizedConfig.getProjectRoots = undefined;
+
+    console.warn(
+      'Warning! Your metro configuration contains a deprecated function ' +
+        '"projectRoots". Please, consider changing it to "getProjectRoot" ' +
+        'with "watchFolders" (if needed)',
+    );
+  } else if (watchFolders.includes(projectRoot)) {
+    console.warn(
+      'Warning! There is no need to specify your projectRoot (' +
+        projectRoot +
+        ') in "watchFolders". It will be watched automatically',
+    );
+  } else {
+    normalizedConfig.getWatchFolders = () => [projectRoot, ...watchFolders];
+  }
+
+  return normalizedConfig;
 };
 
 const load = (configFile: string, defaults?: ConfigT) =>

packages/metro/src/DeltaBundler/Serializers/__tests__/getAssets-test.js

@@ -34,7 +34,7 @@ it('should return the bundle assets', async () => {
     ]),
   };
 
-  expect(await getAssets(graph, {projectRoots: ['/tmp']})).toEqual([
+  expect(await getAssets(graph, {watchFolders: ['/tmp']})).toEqual([
     {path: '/tmp/3.png', localPath: '3.png'},
     {path: '/tmp/5.mov', localPath: '5.mov'},
   ]);

packages/metro/src/DeltaBundler/Serializers/getAssets.js

@@ -21,7 +21,7 @@ import type {Graph} from '../types.flow';
 type Options = {|
   assetPlugins: $ReadOnlyArray<string>,
   platform: ?string,
-  projectRoots: $ReadOnlyArray<string>,
+  watchFolders: $ReadOnlyArray<string>,
 |};
 
 async function getAssets(
@@ -35,7 +35,7 @@ async function getAssets(
       promises.push(
         getAssetData(
           module.path,
-          toLocalPath(options.projectRoots, module.path),
+          toLocalPath(options.watchFolders, module.path),
           options.assetPlugins,
           options.platform,
         ),