feat(compiler): make .ngsummary.json files portable

This also allows to customize the filePaths in `.ngsummary.json` file
via the new methods `toSummaryFileName` and `fromSummaryFileName`
on the `CompilerHost`.

Author: tbosch

packages/compiler-cli/src/compiler_host.ts

@@ -42,6 +42,10 @@ export abstract class BaseAotCompilerHost<C extends BaseAotCompilerHostContext>
 
   abstract fileNameToModuleName(importedFile: string, containingFile: string): string|null;
 
+  abstract toSummaryFileName(fileName: string, referringSrcFileName: string): string;
+
+  abstract fromSummaryFileName(fileName: string, referringLibFileName: string): string;
+
   protected getSourceFile(filePath: string): ts.SourceFile {
     const sf = this.program.getSourceFile(filePath);
     if (!sf) {
@@ -144,10 +148,6 @@ export abstract class BaseAotCompilerHost<C extends BaseAotCompilerHostContext>
     return null;
   }
 
-  getOutputFileName(sourceFilePath: string): string {
-    return sourceFilePath.replace(EXT, '') + '.d.ts';
-  }
-
   isSourceFile(filePath: string): boolean {
     const excludeRegex =
         this.options.generateCodeForLibraries === false ? GENERATED_OR_DTS_FILES : GENERATED_FILES;
@@ -268,6 +268,12 @@ export class CompilerHost extends BaseAotCompilerHost<CompilerHostContext> {
     };
   }
 
+  toSummaryFileName(fileName: string, referringSrcFileName: string): string {
+    return fileName.replace(EXT, '') + '.d.ts';
+  }
+
+  fromSummaryFileName(fileName: string, referringLibFileName: string): string { return fileName; }
+
   calculateEmitPath(filePath: string): string {
     // Write codegen in a directory structure matching the sources.
     let root = this.options.basePath !;

packages/compiler-cli/src/transformers/api.ts

@@ -130,6 +130,20 @@ export interface CompilerHost extends ts.CompilerHost {
    * See ImportResolver.
    */
   fileNameToModuleName(importedFilePath: string, containingFilePath: string): string|null;
+  /**
+   * Converts a file name into a representation that should be stored in a summary file.
+   * This has to include changing the suffix as well.
+   * E.g.
+   * `some_file.ts` -> `some_file.d.ts`
+   *
+   * @param referringSrcFileName the soure file that refers to fileName
+   */
+  toSummaryFileName(fileName: string, referringSrcFileName: string): string;
+  /**
+   * Converts a fileName that was processed by `toSummaryFileName` back into a real fileName
+   * given the fileName of the library that is referrig to it.
+   */
+  fromSummaryFileName(fileName: string, referringLibFileName: string): string;
   /**
    * Load a referenced resource either statically or asynchronously. If the host returns a
    * `Promise<string>` it is assumed the user of the corresponding `Program` will call

packages/compiler-cli/src/transformers/compiler_host.ts

@@ -24,6 +24,8 @@ export function createCompilerHost(
 
   host.moduleNameToFileName = mixin.moduleNameToFileName.bind(mixin);
   host.fileNameToModuleName = mixin.fileNameToModuleName.bind(mixin);
+  host.toSummaryFileName = mixin.toSummaryFileName.bind(mixin);
+  host.fromSummaryFileName = mixin.fromSummaryFileName.bind(mixin);
 
   // Make sure we do not `host.realpath()` from TS as we do not want to resolve symlinks.
   // https://github.com/Microsoft/TypeScript/issues/9552
@@ -109,9 +111,15 @@ class CompilerHostMixin {
 
     let moduleName: string;
     if (importedFilePackagName === containingFilePackageName) {
-      moduleName = dotRelative(
-          path.dirname(stripRootDir(this.rootDirs, containingFile)),
-          stripRootDir(this.rootDirs, importedFile));
+      const rootedContainingFile = stripRootDir(this.rootDirs, containingFile);
+      const rootedImportedFile = stripRootDir(this.rootDirs, importedFile);
+
+      if (rootedContainingFile !== containingFile && rootedImportedFile !== importedFile) {
+        // if both files are contained in the `rootDirs`, then strip the rootDirs
+        containingFile = rootedContainingFile;
+        importedFile = rootedImportedFile;
+      }
+      moduleName = dotRelative(path.dirname(containingFile), importedFile);
     } else if (importedFilePackagName) {
       moduleName = stripNodeModulesPrefix(importedFile);
     } else {
@@ -120,6 +128,18 @@ class CompilerHostMixin {
     }
     return moduleName;
   }
+
+  toSummaryFileName(fileName: string, referringSrcFileName: string): string {
+    return this.fileNameToModuleName(fileName, referringSrcFileName);
+  }
+
+  fromSummaryFileName(fileName: string, referringLibFileName: string): string {
+    const resolved = this.moduleNameToFileName(fileName, referringLibFileName);
+    if (!resolved) {
+      throw new Error(`Could not resolve ${fileName} from ${referringLibFileName}`);
+    }
+    return resolved;
+  }
 }
 
 interface ModuleFilenameResolutionHost extends ts.ModuleResolutionHost {
@@ -189,6 +209,11 @@ function stripNodeModulesPrefix(filePath: string): string {
   return filePath.replace(/.*node_modules\//, '');
 }
 
+function getNodeModulesPrefix(filePath: string): string|null {
+  const match = /.*node_modules\//.exec(filePath);
+  return match ? match[1] : null;
+}
+
 function normalizePath(p: string): string {
   return path.normalize(path.join(p, '.')).replace(/\\/g, '/');
 }

packages/compiler-cli/src/transformers/program.ts

@@ -314,6 +314,14 @@ class AotCompilerHostImpl extends BaseAotCompilerHost<CompilerHost> {
   fileNameToModuleName(importedFile: string, containingFile: string): string|null {
     return this.context.fileNameToModuleName(importedFile, containingFile);
   }
+
+  toSummaryFileName(fileName: string, referringSrcFileName: string): string {
+    return this.context.toSummaryFileName(fileName, referringSrcFileName);
+  }
+
+  fromSummaryFileName(fileName: string, referringLibFileName: string): string {
+    return this.context.fromSummaryFileName(fileName, referringLibFileName);
+  }
 }
 
 export function createProgram(

packages/compiler-cli/test/diagnostics/mocks.ts

@@ -105,7 +105,8 @@ const summaryResolver = new AotSummaryResolver(
     {
       loadSummary(filePath: string) { return null; },
       isSourceFile(sourceFilePath: string) { return true; },
-      getOutputFileName(sourceFilePath: string) { return sourceFilePath; }
+      toSummaryFileName(sourceFilePath: string) { return sourceFilePath; },
+      fromSummaryFileName(filePath: string): string{return filePath;},
     },
     staticSymbolCache);
 

packages/compiler-cli/test/transformers/compiler_host_spec.ts

@@ -67,8 +67,13 @@ describe('NgCompilerHost', () => {
           ]
         }
       });
+      // both files are in the rootDirs
       expect(ngHostWithMultipleRoots.fileNameToModuleName('/tmp/src/b/b.ts', '/tmp/src/a/a.ts'))
           .toBe('./b');
+
+      // one file is not in the rootDirs
+      expect(ngHostWithMultipleRoots.fileNameToModuleName('/tmp/src/c/c.ts', '/tmp/src/a/a.ts'))
+          .toBe('../c/c');
     });
 
     it('should error if accessing a source file from a package', () => {

packages/compiler/src/aot/compiler.ts

@@ -207,10 +207,10 @@ export class AotCompiler {
   }
 
   private _createSummary(
-      srcFileUrl: string, directives: StaticSymbol[], pipes: StaticSymbol[],
+      srcFileName: string, directives: StaticSymbol[], pipes: StaticSymbol[],
       ngModules: StaticSymbol[], injectables: StaticSymbol[],
       ngFactoryCtx: OutputContext): GeneratedFile[] {
-    const symbolSummaries = this._symbolResolver.getSymbolsOf(srcFileUrl)
+    const symbolSummaries = this._symbolResolver.getSymbolsOf(srcFileName)
                                 .map(symbol => this._symbolResolver.resolveSymbol(symbol));
     const typeData: {
       summary: CompileTypeSummary,
@@ -235,18 +235,19 @@ export class AotCompiler {
                                metadata: this._metadataResolver.getInjectableSummary(ref) !.type
                              }))
         ];
-    const forJitOutputCtx = this._createOutputContext(summaryForJitFileName(srcFileUrl, true));
+    const forJitOutputCtx = this._createOutputContext(summaryForJitFileName(srcFileName, true));
     const {json, exportAs} = serializeSummaries(
-        forJitOutputCtx, this._summaryResolver, this._symbolResolver, symbolSummaries, typeData);
+        srcFileName, forJitOutputCtx, this._summaryResolver, this._symbolResolver, symbolSummaries,
+        typeData);
     exportAs.forEach((entry) => {
       ngFactoryCtx.statements.push(
           o.variable(entry.exportAs).set(ngFactoryCtx.importExpr(entry.symbol)).toDeclStmt(null, [
             o.StmtModifier.Exported
           ]));
     });
-    const summaryJson = new GeneratedFile(srcFileUrl, summaryFileName(srcFileUrl), json);
+    const summaryJson = new GeneratedFile(srcFileName, summaryFileName(srcFileName), json);
     if (this._enableSummariesForJit) {
-      return [summaryJson, this._codegenSourceModule(srcFileUrl, forJitOutputCtx)];
+      return [summaryJson, this._codegenSourceModule(srcFileName, forJitOutputCtx)];
     };
 
     return [summaryJson];

packages/compiler/src/aot/summary_resolver.ts

@@ -23,11 +23,20 @@ export interface AotSummaryResolverHost {
    */
   isSourceFile(sourceFilePath: string): boolean;
   /**
-   * Returns the output file path of a source file.
+   * Converts a file name into a representation that should be stored in a summary file.
+   * This has to include changing the suffix as well.
    * E.g.
    * `some_file.ts` -> `some_file.d.ts`
+   *
+   * @param referringSrcFileName the soure file that refers to fileName
    */
-  getOutputFileName(sourceFilePath: string): string;
+  toSummaryFileName(fileName: string, referringSrcFileName: string): string;
+
+  /**
+   * Converts a fileName that was processed by `toSummaryFileName` back into a real fileName
+   * given the fileName of the library that is referrig to it.
+   */
+  fromSummaryFileName(fileName: string, referringLibFileName: string): string;
 }
 
 export class AotSummaryResolver implements SummaryResolver<StaticSymbol> {
@@ -46,7 +55,13 @@ export class AotSummaryResolver implements SummaryResolver<StaticSymbol> {
     return !this.host.isSourceFile(stripGeneratedFileSuffix(filePath));
   }
 
-  getLibraryFileName(filePath: string) { return this.host.getOutputFileName(filePath); }
+  toSummaryFileName(filePath: string, referringSrcFileName: string) {
+    return this.host.toSummaryFileName(filePath, referringSrcFileName);
+  }
+
+  fromSummaryFileName(fileName: string, referringLibFileName: string) {
+    return this.host.fromSummaryFileName(fileName, referringLibFileName);
+  }
 
   resolveSummary(staticSymbol: StaticSymbol): Summary<StaticSymbol> {
     staticSymbol.assertNoMembers();
@@ -85,7 +100,8 @@ export class AotSummaryResolver implements SummaryResolver<StaticSymbol> {
         throw e;
       }
       if (json) {
-        const {summaries, importAs} = deserializeSummaries(this.staticSymbolCache, json);
+        const {summaries, importAs} =
+            deserializeSummaries(this.staticSymbolCache, this, filePath, json);
         summaries.forEach((summary) => this.summaryCache.set(summary.symbol, summary));
         importAs.forEach((importAs) => {
           this.importAs.set(

packages/compiler/src/aot/summary_serializer.ts

@@ -15,7 +15,7 @@ import {ResolvedStaticSymbol, StaticSymbolResolver} from './static_symbol_resolv
 import {summaryForJitFileName, summaryForJitName} from './util';
 
 export function serializeSummaries(
-    forJitCtx: OutputContext, summaryResolver: SummaryResolver<StaticSymbol>,
+    srcFileName: string, forJitCtx: OutputContext, summaryResolver: SummaryResolver<StaticSymbol>,
     symbolResolver: StaticSymbolResolver, symbols: ResolvedStaticSymbol[], types: {
       summary: CompileTypeSummary,
       metadata: CompileNgModuleMetadata | CompileDirectiveMetadata | CompilePipeMetadata |
@@ -76,15 +76,17 @@ export function serializeSummaries(
       });
     }
   });
-  const {json, exportAs} = toJsonSerializer.serialize();
+  const {json, exportAs} = toJsonSerializer.serialize(srcFileName);
   forJitSerializer.serialize(exportAs);
   return {json, exportAs};
 }
 
-export function deserializeSummaries(symbolCache: StaticSymbolCache, json: string):
+export function deserializeSummaries(
+    symbolCache: StaticSymbolCache, summaryResolver: SummaryResolver<StaticSymbol>,
+    libraryFileName: string, json: string):
     {summaries: Summary<StaticSymbol>[], importAs: {symbol: StaticSymbol, importAs: string}[]} {
-  const deserializer = new FromJsonDeserializer(symbolCache);
-  return deserializer.deserialize(json);
+  const deserializer = new FromJsonDeserializer(symbolCache, summaryResolver);
+  return deserializer.deserialize(libraryFileName, json);
 }
 
 export function createForJitStub(outputCtx: OutputContext, reference: StaticSymbol) {
@@ -151,7 +153,8 @@ class ToJsonSerializer extends ValueTransformer {
     }
   }
 
-  serialize(): {json: string, exportAs: {symbol: StaticSymbol, exportAs: string}[]} {
+  serialize(srcFileName: string):
+      {json: string, exportAs: {symbol: StaticSymbol, exportAs: string}[]} {
     const exportAs: {symbol: StaticSymbol, exportAs: string}[] = [];
     const json = JSON.stringify({
       summaries: this.processedSummaries,
@@ -165,10 +168,7 @@ class ToJsonSerializer extends ValueTransformer {
         return {
           __symbol: index,
           name: symbol.name,
-          // We convert the source filenames tinto output filenames,
-          // as the generated summary file will be used when the current
-          // compilation unit is used as a library
-          filePath: this.summaryResolver.getLibraryFileName(symbol.filePath),
+          filePath: this.summaryResolver.toSummaryFileName(symbol.filePath, srcFileName),
           importAs: importAs
         };
       })
@@ -317,15 +317,21 @@ class ForJitSerializer {
 class FromJsonDeserializer extends ValueTransformer {
   private symbols: StaticSymbol[];
 
-  constructor(private symbolCache: StaticSymbolCache) { super(); }
+  constructor(
+      private symbolCache: StaticSymbolCache,
+      private summaryResolver: SummaryResolver<StaticSymbol>) {
+    super();
+  }
 
-  deserialize(json: string):
+  deserialize(libraryFileName: string, json: string):
       {summaries: Summary<StaticSymbol>[], importAs: {symbol: StaticSymbol, importAs: string}[]} {
     const data: {summaries: any[], symbols: any[]} = JSON.parse(json);
     const importAs: {symbol: StaticSymbol, importAs: string}[] = [];
     this.symbols = [];
     data.symbols.forEach((serializedSymbol) => {
-      const symbol = this.symbolCache.get(serializedSymbol.filePath, serializedSymbol.name);
+      const symbol = this.symbolCache.get(
+          this.summaryResolver.fromSummaryFileName(serializedSymbol.filePath, libraryFileName),
+          serializedSymbol.name);
       this.symbols.push(symbol);
       if (serializedSymbol.importAs) {
         importAs.push({symbol: symbol, importAs: serializedSymbol.importAs});

packages/compiler/src/summary_resolver.ts

@@ -17,7 +17,8 @@ export interface Summary<T> {
 
 export abstract class SummaryResolver<T> {
   abstract isLibraryFile(fileName: string): boolean;
-  abstract getLibraryFileName(fileName: string): string|null;
+  abstract toSummaryFileName(fileName: string, referringSrcFileName: string): string;
+  abstract fromSummaryFileName(fileName: string, referringLibFileName: string): string;
   abstract resolveSummary(reference: T): Summary<T>|null;
   abstract getSymbolsOf(filePath: string): T[];
   abstract getImportAs(reference: T): T;
@@ -28,12 +29,13 @@ export abstract class SummaryResolver<T> {
 export class JitSummaryResolver implements SummaryResolver<Type<any>> {
   private _summaries = new Map<Type<any>, Summary<Type<any>>>();
 
-  isLibraryFile(fileName: string): boolean { return false; };
-  getLibraryFileName(fileName: string): string|null { return null; }
+  isLibraryFile(): boolean { return false; };
+  toSummaryFileName(fileName: string): string { return fileName; }
+  fromSummaryFileName(fileName: string): string { return fileName; }
   resolveSummary(reference: Type<any>): Summary<Type<any>>|null {
     return this._summaries.get(reference) || null;
   };
-  getSymbolsOf(filePath: string): Type<any>[] { return []; }
+  getSymbolsOf(): Type<any>[] { return []; }
   getImportAs(reference: Type<any>): Type<any> { return reference; }
   addSummary(summary: Summary<Type<any>>) { this._summaries.set(summary.symbol, summary); };
 }