Fix goog.module naming consistency

Ensure that modules are named after their path relative to `rootDir` or the closest common parent path.

Author: theRobinator

src/cli_support.ts

@@ -9,14 +9,23 @@
 import * as path from 'path';
 
 // Postprocess generated JS.
-export function pathToModuleName(context: string, fileName: string): string {
-  fileName = fileName.replace(/\.js$/, '');
+export function pathToModuleName(
+    rootModulePath: string, context: string, fileName: string): string {
+  fileName = fileName.replace(/\.[tj]s$/, '');
 
   if (fileName[0] === '.') {
     // './foo' or '../foo'.
     // Resolve the path against the dirname of the current module.
     fileName = path.join(path.dirname(context), fileName);
   }
+
+  // Ensure consistency by naming all modules after their absolute paths
+  fileName = path.resolve(fileName);
+
+  if (rootModulePath) {
+    fileName = path.relative(rootModulePath, fileName);
+  }
+
   // Replace characters not supported by goog.module.
   const moduleName =
       fileName.replace(/\/|\\/g, '.').replace(/^[^a-zA-Z_$]/, '_').replace(/[^a-zA-Z0-9._$]/g, '_');

src/main.ts

@@ -17,7 +17,7 @@ import * as ts from './typescript';
 import * as cliSupport from './cli_support';
 import * as tsickle from './tsickle';
 import {ModulesManifest} from './tsickle';
-import {createSourceReplacingCompilerHost} from './util';
+import {getCommonParentDirectory} from './util';
 
 /** Tsickle settings passed on the command line. */
 export interface Settings {
@@ -131,17 +131,20 @@ function loadTscConfig(args: string[]):
 export function toClosureJS(
     options: ts.CompilerOptions, fileNames: string[], settings: Settings,
     writeFile?: ts.WriteFileCallback): tsickle.EmitResult {
-  const compilerHost = ts.createCompilerHost(options);
-  const program = ts.createProgram(fileNames, options, compilerHost);
   // Use absolute paths to determine what files to process since files may be imported using
   // relative or absolute paths
-  const filesToProcess = new Set(fileNames.map(i => path.resolve(i)));
+  const absoluteFileNames = fileNames.map(i => path.resolve(i));
+
+  const compilerHost = ts.createCompilerHost(options);
+  const program = ts.createProgram(fileNames, options, compilerHost);
+  const filesToProcess = new Set(absoluteFileNames);
+  const rootModulePath = options.rootDir || getCommonParentDirectory(absoluteFileNames);
   const transformerHost: tsickle.TsickleHost = {
     shouldSkipTsickleProcessing: (fileName: string) => {
       return !filesToProcess.has(path.resolve(fileName));
     },
     shouldIgnoreWarningsForPath: (fileName: string) => false,
-    pathToModuleName: cliSupport.pathToModuleName,
+    pathToModuleName: cliSupport.pathToModuleName.bind(null, rootModulePath),
     fileNameToModuleId: (fileName) => fileName,
     es5Mode: true,
     googmodule: true,

src/util.ts

@@ -10,6 +10,7 @@
 // ES6 maps and sets when running on node 4, which doesn't
 // support Iterators completely.
 
+import * as path from 'path';
 import * as ts from 'typescript';
 
 /**
@@ -62,3 +63,24 @@ export function hasModifierFlag(node: ts.Node, flag: ts.ModifierFlags): boolean
 export function isDtsFileName(fileName: string): boolean {
   return /\.d\.ts$/.test(fileName);
 }
+
+/**
+ * Determine the lowest-level common parent directory of the given list of files.
+ */
+export function getCommonParentDirectory(fileNames: string[]): string {
+  const pathSplitter = /[\/\\]+/;
+  const commonParent = fileNames[0].split(pathSplitter);
+  for (let i = 1; i < fileNames.length; i++) {
+    const thisPath = fileNames[i].split(pathSplitter);
+    let j = 0;
+    while (thisPath[j] === commonParent[j]) {
+      j++;
+    }
+    commonParent.length = j;  // Truncate without copying the array
+  }
+  if (commonParent.length === 0) {
+    return '/';
+  } else {
+    return commonParent.join(path.sep);
+  }
+}

test/decorator-annotator_test.ts

@@ -45,7 +45,7 @@ describe('decorator-annotator', () => {
 
     const transformerHost: tsickle.TsickleHost = {
       shouldSkipTsickleProcessing: (filePath) => !sources(sourceText).has(filePath),
-      pathToModuleName: cliSupport.pathToModuleName,
+      pathToModuleName: cliSupport.pathToModuleName.bind(null, '/'),
       shouldIgnoreWarningsForPath: (filePath) => false,
       fileNameToModuleId: (filePath) => filePath,
       transformDecorators: true,

test/e2e_node_kind_source_map_test.ts

@@ -29,7 +29,7 @@ describe('source maps each node with transformer', () => {
       quux;`);
 
     // Run tsickle+TSC to convert inputs to Closure JS files.
-    const {files} = compileWithTransfromer(sources, sourceMapCompilerOptions);
+    const {files} = compileWithTransfromer(sources, sourceMapCompilerOptions, process.cwd());
     const compiledJs = files.get('input.js')!;
     const sourceMap = getSourceMapWithName('input.js.map', files);
 

test/es5processor_test.ts

@@ -15,6 +15,7 @@ import * as cliSupport from '../src/cli_support';
 import * as es5processor from '../src/es5processor';
 
 import * as testSupport from './test_support';
+import {getCommonParentDirectory} from '../src/util';
 
 chaiUse(chaiDiff);
 
@@ -24,7 +25,7 @@ describe('convertCommonJsToGoogModule', () => {
     const tsHost = ts.createCompilerHost(options);
     const host: es5processor.Es5ProcessorHost = {
       fileNameToModuleId: (fn) => fn,
-      pathToModuleName: cliSupport.pathToModuleName,
+      pathToModuleName: cliSupport.pathToModuleName.bind(null, process.cwd()),
       es5Mode: isES5,
       prelude,
       options: testSupport.compilerOptions,

test/test_support.ts

@@ -17,6 +17,7 @@ import * as cliSupport from '../src/cli_support';
 import * as es5processor from '../src/es5processor';
 import {BasicSourceMapConsumer, sourceMapTextToConsumer} from '../src/source_map_utils';
 import * as tsickle from '../src/tsickle';
+import {getCommonParentDirectory} from '../src/util';
 
 /** Base compiler options to be customized and exposed. */
 export const baseCompilerOptions: ts.CompilerOptions = {
@@ -285,16 +286,18 @@ export function getSourceMapWithName(
  * downleveling and closurization.
  */
 export function compileWithTransfromer(
-    sources: Map<string, string>, compilerOptions: ts.CompilerOptions) {
+    sources: Map<string, string>, compilerOptions: ts.CompilerOptions, rootPath?: string) {
   const fileNames = Array.from(sources.keys());
   const tsHost = createSourceCachingHost(sources, compilerOptions);
   const program = ts.createProgram(fileNames, compilerOptions, tsHost);
   expect(ts.getPreEmitDiagnostics(program))
       .lengthOf(0, tsickle.formatDiagnostics(ts.getPreEmitDiagnostics(program)));
 
+  const rootModulePath = rootPath ? rootPath : getCommonParentDirectory(fileNames);
+
   const transformerHost: tsickle.TsickleHost = {
     shouldSkipTsickleProcessing: (filePath) => !sources.has(filePath),
-    pathToModuleName: cliSupport.pathToModuleName,
+    pathToModuleName: cliSupport.pathToModuleName.bind(null, rootModulePath),
     shouldIgnoreWarningsForPath: (filePath) => false,
     fileNameToModuleId: (filePath) => filePath,
     transformDecorators: true,