From 11ea3a3f3319eb1ac141ffde3f0f3b65d3bf0e4e Mon Sep 17 00:00:00 2001
From: Alex Rickabaugh <alx+alxhub@alxandria.net>
Date: Fri, 6 Apr 2018 08:23:40 -0700
Subject: [PATCH] fix(compiler-cli): don't lower expressions in flat module
 metadata (#23226)

Lowering expressions in flat module metadata is desirable, but it won't
work without some rearchitecting. Currently the flat module index source
is added to the Program and therefore must be determined before the rest
of the transforms run. Since the lowering transform changes the set of
exports needed in the index, this creates a catch-22 in the index
generation.

This commit causes the flat module index metadata to be generated using
only those transforms which are "safe" (don't modify the index).

PR Close #23226
---
 .../compiler-cli/src/transformers/program.ts  | 22 ++++++++++++++-----
 packages/compiler-cli/test/ngc_spec.ts        |  5 ++---
 2 files changed, 19 insertions(+), 8 deletions(-)

diff --git a/packages/compiler-cli/src/transformers/program.ts b/packages/compiler-cli/src/transformers/program.ts
index ad7a3c10c1..ca7f8a587e 100644
--- a/packages/compiler-cli/src/transformers/program.ts
+++ b/packages/compiler-cli/src/transformers/program.ts
@@ -112,6 +112,8 @@ const MAX_TS_VERSION = '2.8.0';
 class AngularCompilerProgram implements Program {
   private rootNames: string[];
   private metadataCache: MetadataCache;
+  // Metadata cache used exclusively for the flat module index
+  private flatModuleMetadataCache: MetadataCache;
   private loweringMetadataTransform: LowerMetadataTransform;
   private oldProgramLibrarySummaries: Map<string, LibrarySummary>|undefined;
   private oldProgramEmittedGeneratedFiles: Map<string, GeneratedFile>|undefined;
@@ -149,7 +151,7 @@ class AngularCompilerProgram implements Program {
 
     if (options.flatModuleOutFile) {
       const {host: bundleHost, indexName, errors} =
-          createBundleIndexHost(options, this.rootNames, host, () => this.metadataCache);
+          createBundleIndexHost(options, this.rootNames, host, () => this.flatModuleMetadataCache);
       if (errors) {
         this._optionsDiagnostics.push(...errors.map(e => ({
                                                       category: e.category,
@@ -574,9 +576,12 @@ class AngularCompilerProgram implements Program {
       customTransformers?: CustomTransformers): ts.CustomTransformers {
     const beforeTs: Array<ts.TransformerFactory<ts.SourceFile>> = [];
     const metadataTransforms: MetadataTransformer[] = [];
+    const flatModuleMetadataTransforms: MetadataTransformer[] = [];
     if (this.options.enableResourceInlining) {
       beforeTs.push(getInlineResourcesTransformFactory(this.tsProgram, this.hostAdapter));
-      metadataTransforms.push(new InlineResourcesMetadataTransformer(this.hostAdapter));
+      const transformer = new InlineResourcesMetadataTransformer(this.hostAdapter);
+      metadataTransforms.push(transformer);
+      flatModuleMetadataTransforms.push(transformer);
     }
 
     if (!this.options.disableExpressionLowering) {
@@ -592,14 +597,18 @@ class AngularCompilerProgram implements Program {
 
       // If we have partial modules, the cached metadata might be incorrect as it doesn't reflect
       // the partial module transforms.
-      metadataTransforms.push(new PartialModuleMetadataTransformer(partialModules));
+      const transformer = new PartialModuleMetadataTransformer(partialModules);
+      metadataTransforms.push(transformer);
+      flatModuleMetadataTransforms.push(transformer);
     }
 
     if (stripDecorators) {
       beforeTs.push(getDecoratorStripTransformerFactory(
           stripDecorators, this.compiler.reflector, this.getTsProgram().getTypeChecker()));
-      metadataTransforms.push(
-          new StripDecoratorsMetadataTransformer(stripDecorators, this.compiler.reflector));
+      const transformer =
+          new StripDecoratorsMetadataTransformer(stripDecorators, this.compiler.reflector);
+      metadataTransforms.push(transformer);
+      flatModuleMetadataTransforms.push(transformer);
     }
 
     if (customTransformers && customTransformers.beforeTs) {
@@ -608,6 +617,9 @@ class AngularCompilerProgram implements Program {
     if (metadataTransforms.length > 0) {
       this.metadataCache = this.createMetadataCache(metadataTransforms);
     }
+    if (flatModuleMetadataTransforms.length > 0) {
+      this.flatModuleMetadataCache = this.createMetadataCache(flatModuleMetadataTransforms);
+    }
     const afterTs = customTransformers ? customTransformers.afterTs : undefined;
     return {before: beforeTs, after: afterTs};
   }
diff --git a/packages/compiler-cli/test/ngc_spec.ts b/packages/compiler-cli/test/ngc_spec.ts
index 40da113145..c9add65258 100644
--- a/packages/compiler-cli/test/ngc_spec.ts
+++ b/packages/compiler-cli/test/ngc_spec.ts
@@ -1040,7 +1040,6 @@ describe('ngc transformer command-line', () => {
           exports: [
             FlatComponent,
           ],
-          providers: [{provide: 'test', useFactory: () => true}],
         })
         export class FlatModule {
         }`);
@@ -1055,7 +1054,7 @@ describe('ngc transformer command-line', () => {
       shouldExist('index.metadata.json');
     });
 
-    it('should downlevel flat module metadata', () => {
+    it('should downlevel templates in flat module metadata', () => {
       writeFlatModule('index.js');
 
       const exitCode = main(['-p', path.join(basePath, 'tsconfig.json')], errorSpy);
@@ -1066,7 +1065,7 @@ describe('ngc transformer command-line', () => {
       const metadataPath = path.resolve(outDir, 'index.metadata.json');
       const metadataSource = fs.readFileSync(metadataPath, 'utf8');
       expect(metadataSource).not.toContain('templateUrl');
-      expect(metadataSource).toContain('"useFactory":{"__symbolic":"reference","name":"ɵ0"}');
+      expect(metadataSource).toContain('<div>flat module component</div>');
     });
 
     describe('with tree example', () => {