Cherry pick: Use relative paths for module verboseNames

Summary:
This diff changes the verboseName assigned to modules to be the full relative path of the module, instead of just the file name.

This fixes #204

Reviewed By: mjesun

Differential Revision: D9013798

fbshipit-source-id: 306be4890628dfa6bfa5cc22d1bf0d8119314636

Author: rafeca

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

@@ -44,6 +44,7 @@ const options = {
   createModuleId: createModuleIdFactory(),
   dev: true,
   getRunModuleStatement: moduleId => `require(${JSON.stringify(moduleId)});`,
+  projectRoot: '/root',
   runBeforeMainModule: [],
   runModule: true,
   sourceMapUrl: 'http://localhost/bundle.map',

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

@@ -57,6 +57,7 @@ it('should return the RAM bundle info', async () => {
         ramGroups: [],
       }),
       dev: true,
+      projectRoot: '/root',
       runBeforeMainModule: [],
       runModule: true,
       sourceMapUrl: 'http://localhost/bundle.map',
@@ -76,6 +77,7 @@ it('should use the preloadedModules and ramGroup configs to build a RAM bundle',
     getRunModuleStatement,
     getTransformOptions,
     dev: true,
+    projectRoot: '/root',
     runBeforeMainModule: [],
     runModule: true,
     sourceMapUrl: 'http://localhost/bundle.map',

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

@@ -11,6 +11,7 @@
 'use strict';
 
 const createModuleIdFactory = require('../../../lib/createModuleIdFactory');
+const path = require('path');
 const plainJSBundle = require('../plainJSBundle');
 
 const polyfill = {
@@ -23,15 +24,15 @@ const polyfill = {
 };
 
 const fooModule = {
-  path: 'foo',
-  dependencies: new Map([['./bar', {absolutePath: 'bar', data: {}}]]),
+  path: '/root/foo',
+  dependencies: new Map([['./bar', {absolutePath: '/root/bar', data: {}}]]),
   output: [
     {type: 'js/module', data: {code: '__d(function() {/* code for foo */});'}},
   ],
 };
 
 const barModule = {
-  path: 'bar',
+  path: '/root/bar',
   dependencies: new Map(),
   output: [
     {type: 'js/module', data: {code: '__d(function() {/* code for bar */});'}},
@@ -44,16 +45,20 @@ const getRunModuleStatement = moduleId =>
 it('should serialize a very simple bundle', () => {
   expect(
     plainJSBundle(
-      'foo',
+      '/root/foo',
       [polyfill],
       {
-        dependencies: new Map([['foo', fooModule], ['bar', barModule]]),
+        dependencies: new Map([
+          ['/root/foo', fooModule],
+          ['/root/bar', barModule],
+        ]),
         entryPoints: ['foo'],
       },
       {
-        createModuleId: path => path,
+        createModuleId: filePath => path.basename(filePath),
         dev: true,
         getRunModuleStatement,
+        projectRoot: '/root',
         runBeforeMainModule: [],
         runModule: true,
         sourceMapUrl: 'http://localhost/bundle.map',
@@ -73,17 +78,21 @@ it('should serialize a very simple bundle', () => {
 it('should add runBeforeMainModule statements if found in the graph', () => {
   expect(
     plainJSBundle(
-      'foo',
+      '/root/foo',
       [polyfill],
       {
-        dependencies: new Map([['foo', fooModule], ['bar', barModule]]),
-        entryPoints: ['foo'],
+        dependencies: new Map([
+          ['/root/foo', fooModule],
+          ['/root/bar', barModule],
+        ]),
+        entryPoints: ['/root/foo'],
       },
       {
-        createModuleId: path => path,
+        createModuleId: filePath => path.basename(filePath),
         dev: true,
         getRunModuleStatement,
-        runBeforeMainModule: ['bar', 'non-existant'],
+        projectRoot: '/root',
+        runBeforeMainModule: ['/root/bar', 'non-existant'],
         runModule: true,
         sourceMapUrl: 'http://localhost/bundle.map',
       },
@@ -103,17 +112,21 @@ it('should add runBeforeMainModule statements if found in the graph', () => {
 it('should handle numeric module ids', () => {
   expect(
     plainJSBundle(
-      'foo',
+      '/root/foo',
       [polyfill],
       {
-        dependencies: new Map([['foo', fooModule], ['bar', barModule]]),
-        entryPoints: ['foo'],
+        dependencies: new Map([
+          ['/root/foo', fooModule],
+          ['/root/bar', barModule],
+        ]),
+        entryPoints: ['/root/foo'],
       },
       {
         createModuleId: createModuleIdFactory(),
         dev: true,
         getRunModuleStatement,
-        runBeforeMainModule: ['bar', 'non-existant'],
+        projectRoot: '/root',
+        runBeforeMainModule: ['/root/bar', 'non-existant'],
         runModule: true,
         sourceMapUrl: 'http://localhost/bundle.map',
       },
@@ -133,18 +146,22 @@ it('should handle numeric module ids', () => {
 it('outputs custom runModule statements', () => {
   expect(
     plainJSBundle(
-      'foo',
+      '/root/foo',
       [polyfill],
       {
-        dependencies: new Map([['foo', fooModule], ['bar', barModule]]),
-        entryPoints: ['foo'],
+        dependencies: new Map([
+          ['/root/foo', fooModule],
+          ['/root/bar', barModule],
+        ]),
+        entryPoints: ['/root/foo'],
       },
       {
-        createModuleId: path => path,
+        createModuleId: filePath => path.basename(filePath),
         dev: true,
         getRunModuleStatement: moduleId =>
           `export default require(${JSON.stringify(moduleId)}).default;`,
-        runBeforeMainModule: ['bar'],
+        projectRoot: '/root',
+        runBeforeMainModule: ['/root/bar'],
         runModule: true,
       },
     ),

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

@@ -21,6 +21,7 @@ type Options = {|
   +createModuleId: string => number | string,
   +dev: boolean,
   +getRunModuleStatement: (number | string) => string,
+  +projectRoot: string,
   +runBeforeMainModule: $ReadOnlyArray<string>,
   +runModule: boolean,
   +sourceMapUrl: ?string,

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

@@ -30,6 +30,7 @@ type Options = {|
   +getRunModuleStatement: number => string,
   +getTransformOptions: ?GetTransformOptions,
   +platform: ?string,
+  +projectRoot: string,
   +runBeforeMainModule: $ReadOnlyArray<string>,
   +runModule: boolean,
   +sourceMapUrl: ?string,

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

@@ -45,6 +45,7 @@ describe('wrapModule()', () => {
       wrapModule(myModule, {
         createModuleId: createModuleIdFactory(),
         dev: false,
+        projectRoot: '/root',
       }),
     ).toEqual('__d(function() { console.log("foo") },0,[1,2]);');
   });
@@ -54,6 +55,7 @@ describe('wrapModule()', () => {
       wrapModule(myModule, {
         createModuleId: createModuleIdFactory(),
         dev: true,
+        projectRoot: '/root',
       }),
     ).toEqual('__d(function() { console.log("foo") },0,[1,2],"foo.js");');
   });
@@ -65,6 +67,7 @@ describe('wrapModule()', () => {
       wrapModule(myModule, {
         createModuleId: createModuleIdFactory(),
         dev: true,
+        projectRoot: '/root',
       }),
     ).toEqual(myModule.output[0].data.code);
   });
@@ -75,6 +78,7 @@ describe('wrapModule()', () => {
       wrapModule(myModule, {
         createModuleId: path => path,
         dev: false,
+        projectRoot: '/root',
       }),
     ).toEqual(
       '__d(function() { console.log("foo") },"/root/foo.js",["/bar","/baz"]);',

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

@@ -20,6 +20,7 @@ import type {MixedOutput, Module} from '../../types.flow';
 export type Options = {
   +createModuleId: string => number | string,
   +dev: boolean,
+  +projectRoot: string,
 };
 
 // Used to include paths in production bundles for traces of performance tuned runs,
@@ -42,12 +43,10 @@ function wrapModule(module: Module<>, options: Options) {
     }),
   ];
 
-  // Add the module name as the last parameter (to make it easier to do
+  // Add the module relative path as the last parameter (to make it easier to do
   // requires by name when debugging).
-  // TODO (t26853986): Switch this to use the relative file path (once we have
-  // as single project root).
   if (PASS_MODULE_PATHS_TO_DEFINE || options.dev) {
-    params.push(path.basename(module.path));
+    params.push(path.relative(options.projectRoot, module.path));
     if (PASS_MODULE_PATHS_TO_DEFINE) {
       params.push(module.path);
     }

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

@@ -17,7 +17,8 @@ const {isJsModule, wrapModule} = require('./helpers/js');
 import type {DeltaResult, Graph, Module} from '../types.flow';
 
 type Options = {
-  createModuleId: string => number,
+  +createModuleId: string => number,
+  +projectRoot: string,
 };
 
 export type Result = {
@@ -58,7 +59,7 @@ function _prepareModule(
   options: Options,
 ): {|+id: number, +code: string|} {
   const code = wrapModule(module, {
-    createModuleId: options.createModuleId,
+    ...options,
     dev: true,
   });
 

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

@@ -20,6 +20,7 @@ type Options = {|
   +createModuleId: string => number | string,
   +dev: boolean,
   +getRunModuleStatement: (number | string) => string,
+  +projectRoot: string,
   +runBeforeMainModule: $ReadOnlyArray<string>,
   +runModule: boolean,
   +sourceMapUrl: ?string,

packages/metro/src/HmrServer.js

@@ -127,6 +127,7 @@ class HmrServer<TClient: Client> {
 
       return hmrJSBundle(delta, client.graph, {
         createModuleId: this._packagerServer._opts.createModuleId,
+        projectRoot: this._packagerServer.getProjectRoots()[0],
       });
     } catch (error) {
       const formattedError = formatBundlingError(error);