feat(ngcc): execute schematic-like migrations in ngcc

packages/compiler-cli/ngcc/src/analysis/decoration_analyzer.ts

@@ -7,6 +7,7 @@
  */
 import {ConstantPool} from '@angular/compiler';
 import * as ts from 'typescript';
+
 import {BaseDefDecoratorHandler, ComponentDecoratorHandler, DirectiveDecoratorHandler, InjectableDecoratorHandler, NgModuleDecoratorHandler, PipeDecoratorHandler, ReferencesRegistry, ResourceLoader} from '../../../src/ngtsc/annotations';
 import {CycleAnalyzer, ImportGraph} from '../../../src/ngtsc/cycles';
 import {isFatalDiagnosticError} from '../../../src/ngtsc/diagnostics';
@@ -18,9 +19,12 @@ import {ClassDeclaration} from '../../../src/ngtsc/reflection';
 import {LocalModuleScopeRegistry, MetadataDtsModuleScopeResolver} from '../../../src/ngtsc/scope';
 import {CompileResult, DecoratorHandler, DetectResult, HandlerPrecedence} from '../../../src/ngtsc/transform';
 import {NgccClassSymbol, NgccReflectionHost} from '../host/ngcc_host';
-import {Migration, MigrationHost} from '../migrations/migration';
+import {Migration} from '../migrations/migration';
+import {MissingInjectableMigration} from '../migrations/missing_injectable_migration';
+import {UndecoratedParentMigration} from '../migrations/undecorated_parent_migration';
 import {EntryPointBundle} from '../packages/entry_point_bundle';
 import {isDefined} from '../utils';
+
 import {DefaultMigrationHost} from './migration_host';
 import {AnalyzedClass, AnalyzedFile, CompiledClass, CompiledFile, DecorationAnalyses} from './types';
 import {analyzeDecorators, isWithinPackage} from './util';
@@ -100,7 +104,7 @@ export class DecorationAnalyzer {
         this.reflectionHost, this.evaluator, this.metaRegistry, NOOP_DEFAULT_IMPORT_RECORDER,
         this.isCore),
   ];
-  migrations: Migration[] = [];
+  migrations: Migration[] = [new UndecoratedParentMigration(), new MissingInjectableMigration()];
 
   constructor(
       private fs: FileSystem, private bundle: EntryPointBundle,
@@ -118,9 +122,9 @@ export class DecorationAnalyzer {
                               .filter(sourceFile => isWithinPackage(this.packagePath, sourceFile))
                               .map(sourceFile => this.analyzeFile(sourceFile))
                               .filter(isDefined);
-    const migrationHost = new DefaultMigrationHost(
-        this.reflectionHost, this.fullMetaReader, this.evaluator, this.handlers, analyzedFiles);
-    analyzedFiles.forEach(analyzedFile => this.migrateFile(migrationHost, analyzedFile));
+
+    this.applyMigrations(analyzedFiles);
+
     analyzedFiles.forEach(analyzedFile => this.resolveFile(analyzedFile));
     const compiledFiles = analyzedFiles.map(analyzedFile => this.compileFile(analyzedFile));
     compiledFiles.forEach(
@@ -146,21 +150,27 @@ export class DecorationAnalyzer {
     return analyzedClass;
   }
 
-  protected migrateFile(migrationHost: MigrationHost, analyzedFile: AnalyzedFile): void {
-    analyzedFile.analyzedClasses.forEach(({declaration}) => {
-      this.migrations.forEach(migration => {
-        try {
-          const result = migration.apply(declaration, migrationHost);
-          if (result !== null) {
-            this.diagnosticHandler(result);
-          }
-        } catch (e) {
-          if (isFatalDiagnosticError(e)) {
-            this.diagnosticHandler(e.toDiagnostic());
-          } else {
-            throw e;
+  protected applyMigrations(analyzedFiles: AnalyzedFile[]): void {
+    const migrationHost = new DefaultMigrationHost(
+        this.reflectionHost, this.fullMetaReader, this.evaluator, this.handlers,
+        this.bundle.entryPoint.path, analyzedFiles);
+
+    this.migrations.forEach(migration => {
+      analyzedFiles.forEach(analyzedFile => {
+        analyzedFile.analyzedClasses.forEach(({declaration}) => {
+          try {
+            const result = migration.apply(declaration, migrationHost);
+            if (result !== null) {
+              this.diagnosticHandler(result);
+            }
+          } catch (e) {
+            if (isFatalDiagnosticError(e)) {
+              this.diagnosticHandler(e.toDiagnostic());
+            } else {
+              throw e;
+            }
           }
-        }
+        });
       });
     });
   }

packages/compiler-cli/ngcc/src/analysis/migration_host.ts

@@ -6,15 +6,18 @@
  * found in the LICENSE file at https://angular.io/license
  */
 import * as ts from 'typescript';
+
 import {ErrorCode, FatalDiagnosticError} from '../../../src/ngtsc/diagnostics';
+import {AbsoluteFsPath} from '../../../src/ngtsc/file_system';
 import {MetadataReader} from '../../../src/ngtsc/metadata';
 import {PartialEvaluator} from '../../../src/ngtsc/partial_evaluator';
 import {ClassDeclaration, Decorator} from '../../../src/ngtsc/reflection';
 import {DecoratorHandler} from '../../../src/ngtsc/transform';
 import {NgccReflectionHost} from '../host/ngcc_host';
 import {MigrationHost} from '../migrations/migration';
+
 import {AnalyzedClass, AnalyzedFile} from './types';
-import {analyzeDecorators} from './util';
+import {analyzeDecorators, isWithinPackage} from './util';
 
 /**
  * The standard implementation of `MigrationHost`, which is created by the
@@ -24,7 +27,7 @@ export class DefaultMigrationHost implements MigrationHost {
   constructor(
       readonly reflectionHost: NgccReflectionHost, readonly metadata: MetadataReader,
       readonly evaluator: PartialEvaluator, private handlers: DecoratorHandler<any, any>[],
-      private analyzedFiles: AnalyzedFile[]) {}
+      private entryPointPath: AbsoluteFsPath, private analyzedFiles: AnalyzedFile[]) {}
 
   injectSyntheticDecorator(clazz: ClassDeclaration, decorator: Decorator): void {
     const classSymbol = this.reflectionHost.getClassSymbol(clazz) !;
@@ -41,6 +44,25 @@ export class DefaultMigrationHost implements MigrationHost {
       mergeAnalyzedClasses(oldAnalyzedClass, newAnalyzedClass);
     }
   }
+
+  getAllDecorators(clazz: ClassDeclaration): Decorator[]|null {
+    const sourceFile = clazz.getSourceFile();
+    const analyzedFile = this.analyzedFiles.find(file => file.sourceFile === sourceFile);
+    if (analyzedFile === undefined) {
+      return null;
+    }
+
+    const analyzedClass = analyzedFile.analyzedClasses.find(c => c.declaration === clazz);
+    if (analyzedClass === undefined) {
+      return null;
+    }
+
+    return analyzedClass.decorators;
+  }
+
+  isInScope(clazz: ClassDeclaration): boolean {
+    return isWithinPackage(this.entryPointPath, clazz.getSourceFile());
+  }
 }
 
 function getOrCreateAnalyzedFile(

packages/compiler-cli/ngcc/src/host/esm2015_host.ts

@@ -344,10 +344,18 @@ export class Esm2015ReflectionHost extends TypeScriptReflectionHost implements N
     return superDeclaration;
   }
 
-  /** Gets all decorators of the given class symbol. */
+  /**
+   * Gets all decorators of the given class symbol. Any decorator that have been synthetically
+   * injected by a migration will not be present in the returned collection.
+   */
   getDecoratorsOfSymbol(symbol: NgccClassSymbol): Decorator[]|null {
     const {classDecorators} = this.acquireDecoratorInfo(symbol);
-    return classDecorators;
+    if (classDecorators === null) {
+      return null;
+    }
+
+    // Return a clone of the array to prevent consumers from mutating the cache.
+    return Array.from(classDecorators);
   }
 
   /**

packages/compiler-cli/ngcc/src/migrations/migration.ts

@@ -42,4 +42,20 @@ export interface MigrationHost {
    * @param decorator the decorator to inject.
    */
   injectSyntheticDecorator(clazz: ClassDeclaration, decorator: Decorator): void;
+
+  /**
+   * Retrieves all decorators that are associated with the class, including synthetic decorators
+   * that have been injected before.
+   * @param clazz the class for which all decorators are retrieved.
+   * @returns the list of the decorators, or null if the class was not decorated.
+   */
+  getAllDecorators(clazz: ClassDeclaration): Decorator[]|null;
+
+  /**
+   * Determines whether the provided class in within scope of the entry-point that is currently
+   * being compiled.
+   * @param clazz the class for which to be determine whether it is within the current entry-point.
+   * @returns true if the file is part of the compiled entry-point, false otherwise.
+   */
+  isInScope(clazz: ClassDeclaration): boolean;
 }

packages/compiler-cli/ngcc/src/migrations/missing_injectable_migration.ts

@@ -0,0 +1,186 @@
+/**
+ * @license
+ * Copyright Google Inc. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+import * as ts from 'typescript';
+
+import {forwardRefResolver} from '../../../src/ngtsc/annotations';
+import {Reference} from '../../../src/ngtsc/imports';
+import {ResolvedValue, ResolvedValueMap} from '../../../src/ngtsc/partial_evaluator';
+import {ClassDeclaration, Decorator} from '../../../src/ngtsc/reflection';
+
+import {Migration, MigrationHost} from './migration';
+import {createInjectableDecorator, isClassDeclaration} from './utils';
+
+/**
+ * Ensures that classes that are provided as an Angular service in either `NgModule.providers` or
+ * `Directive.providers`/`Component.viewProviders` are decorated with one of the `@Injectable`,
+ * `@Directive`, `@Component` or `@Pipe` decorators, adding an `@Injectable()` decorator when none
+ * are present.
+ *
+ * At least one decorator is now mandatory, as otherwise the compiler would not compile an
+ * injectable definition for the service. This is unlike View Engine, where having just an unrelated
+ * decorator may have been sufficient for the service to become injectable.
+ *
+ * In essence, this migration operates on classes that are themselves an NgModule, Directive or
+ * Component. Their metadata is statically evaluated so that their "providers"/"viewProviders"
+ * properties can be analyzed. For any provider that refers to an undecorated class, the class will
+ * be migrated to have an `@Injectable()` decorator.
+ *
+ * This implementation mirrors the "missing-injectable" schematic.
+ */
+export class MissingInjectableMigration implements Migration {
+  apply(clazz: ClassDeclaration, host: MigrationHost): ts.Diagnostic|null {
+    const decorators = host.reflectionHost.getDecoratorsOfDeclaration(clazz);
+    if (decorators === null) {
+      return null;
+    }
+
+    for (const decorator of decorators) {
+      const name = getAngularCoreDecoratorName(decorator);
+      if (name === 'NgModule') {
+        migrateNgModuleProviders(decorator, host);
+      } else if (name === 'Directive') {
+        migrateDirectiveProviders(decorator, host, /* isComponent */ false);
+      } else if (name === 'Component') {
+        migrateDirectiveProviders(decorator, host, /* isComponent */ true);
+      }
+    }
+
+    return null;
+  }
+}
+
+/**
+ * Iterates through all `NgModule.providers` and adds the `@Injectable()` decorator to any provider
+ * that is not otherwise decorated.
+ */
+function migrateNgModuleProviders(decorator: Decorator, host: MigrationHost): void {
+  if (decorator.args === null || decorator.args.length !== 1) {
+    return;
+  }
+
+  const metadata = host.evaluator.evaluate(decorator.args[0], forwardRefResolver);
+  if (!(metadata instanceof Map)) {
+    return;
+  }
+
+  migrateProviders(metadata, 'providers', host);
+}
+
+/**
+ * Iterates through all `Directive.providers` and if `isComponent` is set to true also
+ * `Component.viewProviders` and adds the `@Injectable()` decorator to any provider that is not
+ * otherwise decorated.
+ */
+function migrateDirectiveProviders(
+    decorator: Decorator, host: MigrationHost, isComponent: boolean): void {
+  if (decorator.args === null || decorator.args.length !== 1) {
+    return;
+  }
+
+  const metadata = host.evaluator.evaluate(decorator.args[0], forwardRefResolver);
+  if (!(metadata instanceof Map)) {
+    return;
+  }
+
+  migrateProviders(metadata, 'providers', host);
+  if (isComponent) {
+    migrateProviders(metadata, 'viewProviders', host);
+  }
+}
+
+/**
+ * Given an object with decorator metadata, iterates through the list of providers to add
+ * `@Injectable()` to any provider that is not otherwise decorated.
+ */
+function migrateProviders(metadata: ResolvedValueMap, field: string, host: MigrationHost): void {
+  if (!metadata.has(field)) {
+    return;
+  }
+  const providers = metadata.get(field) !;
+  if (!Array.isArray(providers)) {
+    return;
+  }
+
+  for (const provider of providers) {
+    migrateProvider(provider, host);
+  }
+}
+
+/**
+ * Analyzes a single provider entry and determines the class that is required to have an
+ * `@Injectable()` decorator.
+ */
+function migrateProvider(provider: ResolvedValue, host: MigrationHost): void {
+  if (provider instanceof Map) {
+    if (!provider.has('provide') || provider.has('useValue') || provider.has('useFactory') ||
+        provider.has('useExisting')) {
+      return;
+    }
+    if (provider.has('useClass')) {
+      migrateProviderClass(provider.get('useClass') !, host);
+    } else {
+      migrateProviderClass(provider.get('provide') !, host);
+    }
+  } else if (Array.isArray(provider)) {
+    for (const v of provider) {
+      migrateProvider(v, host);
+    }
+  } else {
+    migrateProviderClass(provider, host);
+  }
+}
+
+/**
+ * Given a provider class, adds the `@Injectable()` decorator if no other relevant Angular decorator
+ * is present on the class.
+ */
+function migrateProviderClass(provider: ResolvedValue, host: MigrationHost): void {
+  // Providers that do not refer to a class cannot be migrated.
+  if (!(provider instanceof Reference)) {
+    return;
+  }
+
+  const clazz = provider.node as ts.Declaration;
+  if (isClassDeclaration(clazz) && host.isInScope(clazz) && needsInjectableDecorator(clazz, host)) {
+    host.injectSyntheticDecorator(clazz, createInjectableDecorator(clazz));
+  }
+}
+
+const NO_MIGRATE_DECORATORS = new Set(['Injectable', 'Directive', 'Component', 'Pipe']);
+
+/**
+ * Determines if the given class needs to be decorated with `@Injectable()` based on whether it
+ * already has an Angular decorator applied.
+ */
+function needsInjectableDecorator(clazz: ClassDeclaration, host: MigrationHost): boolean {
+  const decorators = host.getAllDecorators(clazz);
+  if (decorators === null) {
+    return true;
+  }
+
+  for (const decorator of decorators) {
+    const name = getAngularCoreDecoratorName(decorator);
+    if (name !== null && NO_MIGRATE_DECORATORS.has(name)) {
+      return false;
+    }
+  }
+
+  return true;
+}
+
+/**
+ * Determines the original name of a decorator if it is from '@angular/core'. For other decorators,
+ * null is returned.
+ */
+export function getAngularCoreDecoratorName(decorator: Decorator): string|null {
+  if (decorator.import === null || decorator.import.from !== '@angular/core') {
+    return null;
+  }
+
+  return decorator.import.name;
+}