refactor(compiler): Add a new helper method getPrimaryAngularDecorator. (angular#47180)

This helper accepts a class, and returns the primary Angular Decorator associated with that trait (e.g. the Component, Pipe, Directive, or NgModule decorator). This will be useful for the language service import project, which needs to edit import arrays inside the decorator. PR Close angular#47180

Author: dylhunn

packages/compiler-cli/src/ngtsc/annotations/component/src/handler.ts

@@ -444,6 +444,7 @@ export class ComponentDecoratorHandler implements
  rawImports,
  resolvedImports,
  schemas,
+ decorator: decorator?.node as ts.Decorator | null ?? null,
  },
  diagnostics,
  };
@@ -483,6 +484,7 @@ export class ComponentDecoratorHandler implements
  imports: analysis.resolvedImports,
  animationTriggerNames: analysis.animationTriggerNames,
  schemas: analysis.schemas,
+ decorator: analysis.decorator,
  });
 
  this.resourceRegistry.registerResources(analysis.resources, node);

packages/compiler-cli/src/ngtsc/annotations/component/src/metadata.ts

@@ -70,6 +70,7 @@ export interface ComponentAnalysisData {
  resolvedImports: Reference<ClassDeclaration>[]|null;
 
  schemas: SchemaMetadata[]|null;
+ decorator: ts.Decorator|null;
 }
 
 export type ComponentResolutionData =

packages/compiler-cli/src/ngtsc/annotations/directive/src/handler.ts

@@ -41,6 +41,7 @@ export interface DirectiveHandlerData {
  outputs: ClassPropertyMapping;
  isPoisoned: boolean;
  isStructural: boolean;
+ decorator: ts.Decorator|null;
 }
 
 export class DirectiveDecoratorHandler implements
@@ -115,6 +116,7 @@ export class DirectiveDecoratorHandler implements
  providersRequiringFactory,
  isPoisoned: false,
  isStructural: directiveResult.isStructural,
+ decorator: decorator?.node as ts.Decorator | null ?? null,
  }
  };
  }
@@ -149,6 +151,7 @@ export class DirectiveDecoratorHandler implements
  isStandalone: analysis.meta.isStandalone,
  imports: null,
  schemas: null,
+ decorator: analysis.decorator,
  });
 
  this.injectableRegistry.registerInjectable(node);

packages/compiler-cli/src/ngtsc/annotations/ng_module/src/handler.ts

@@ -43,6 +43,7 @@ export interface NgModuleAnalysis {
  providersRequiringFactory: Set<Reference<ClassDeclaration>>|null;
  providers: ts.Expression|null;
  remoteScopesMayRequireCycleProtection: boolean;
+ decorator: ts.Decorator|null;
 }
 
 export interface NgModuleResolution {
@@ -442,6 +443,7 @@ export class NgModuleDecoratorHandler implements
  node, this.reflector, this.isCore, this.annotateForClosureCompiler),
  factorySymbolName: node.name.text,
  remoteScopesMayRequireCycleProtection,
+ decorator: decorator?.node as ts.Decorator | null ?? null,
  },
  };
  }
@@ -464,6 +466,7 @@ export class NgModuleDecoratorHandler implements
  rawDeclarations: analysis.rawDeclarations,
  rawImports: analysis.rawImports,
  rawExports: analysis.rawExports,
+ decorator: analysis.decorator,
  });
 
  if (this.factoryTracker !== null) {

packages/compiler-cli/src/ngtsc/annotations/src/pipe.ts

@@ -24,6 +24,7 @@ export interface PipeHandlerData {
  meta: R3PipeMetadata;
  classMetadata: R3ClassMetadata|null;
  pipeNameExpr: ts.Expression;
+ decorator: ts.Decorator|null;
 }
 
 /**
@@ -143,6 +144,7 @@ export class PipeDecoratorHandler implements
  },
  classMetadata: extractClassMetadata(clazz, this.reflector, this.isCore),
  pipeNameExpr,
+ decorator: decorator?.node as ts.Decorator | null ?? null,
  },
  };
  }
@@ -159,6 +161,7 @@ export class PipeDecoratorHandler implements
  name: analysis.meta.pipeName,
  nameExpr: analysis.pipeNameExpr,
  isStandalone: analysis.meta.isStandalone,
+ decorator: analysis.decorator,
  });
 
  this.injectableRegistry.registerInjectable(node);

packages/compiler-cli/src/ngtsc/core/api/src/options.ts

@@ -25,6 +25,11 @@ export interface TestOnlyOptions {
  */
  _useHostForImportGeneration?: boolean;
 
+ /**
+ * Enable the Language Service APIs for template type-checking for tests.
+ */
+ _enableTemplateTypeChecker?: boolean;
+
  /**
  * An option to enable ngtsc's internal performance tracing.
  *

packages/compiler-cli/src/ngtsc/core/src/compiler.ts

@@ -256,6 +256,7 @@ export class NgCompiler {
  private cycleAnalyzer: CycleAnalyzer;
  readonly ignoreForDiagnostics: Set<ts.SourceFile>;
  readonly ignoreForEmit: Set<ts.SourceFile>;
+ readonly enableTemplateTypeChecker: boolean;
 
  /**
  * `NgCompiler` can be reused for multiple compilations (for resource-only changes), and each
@@ -314,10 +315,12 @@ export class NgCompiler {
  readonly programDriver: ProgramDriver,
  readonly incrementalStrategy: IncrementalBuildStrategy,
  readonly incrementalCompilation: IncrementalCompilation,
- readonly enableTemplateTypeChecker: boolean,
+ enableTemplateTypeChecker: boolean,
  readonly usePoisonedData: boolean,
  private livePerfRecorder: ActivePerfRecorder,
  ) {
+ this.enableTemplateTypeChecker =
+ enableTemplateTypeChecker || (options._enableTemplateTypeChecker ?? false);
  this.constructionDiagnostics.push(
  ...this.adapter.constructionDiagnostics, ...verifyCompatibleTypeCheckOptions(this.options));
 
@@ -1064,8 +1067,8 @@ export class NgCompiler {
 
  const templateTypeChecker = new TemplateTypeCheckerImpl(
  this.inputProgram, notifyingDriver, traitCompiler, this.getTypeCheckingConfig(), refEmitter,
- reflector, this.adapter, this.incrementalCompilation, scopeReader, typeCheckScopeRegistry,
- this.delegatingPerfRecorder);
+ reflector, this.adapter, this.incrementalCompilation, metaReader, scopeReader,
+ typeCheckScopeRegistry, this.delegatingPerfRecorder);
 
  // Only construct the extended template checker if the configuration is valid and usable.
  const extendedTemplateChecker = this.constructionDiagnostics.length === 0 ?

packages/compiler-cli/src/ngtsc/metadata/src/api.ts

@@ -48,6 +48,13 @@ export interface NgModuleMeta {
  * because the module came from a .d.ts file).
  */
  rawExports: ts.Expression|null;
+
+ /**
+ * The primary decorator associated with this `ngModule`.
+ *
+ * If this is `null`, no decorator exists, meaning it's probably from a .d.ts file.
+ */
+ decorator: ts.Decorator|null;
 }
 
 /**
@@ -161,6 +168,13 @@ export interface DirectiveMeta extends T2DirectiveMeta, DirectiveTypeCheckMeta {
  * For standalone components, the list of schemas declared.
  */
  schemas: SchemaMetadata[]|null;
+
+ /**
+ * The primary decorator associated with this directive.
+ *
+ * If this is `null`, no decorator exists, meaning it's probably from a .d.ts file.
+ */
+ decorator: ts.Decorator|null;
 }
 
 /**
@@ -191,6 +205,7 @@ export interface PipeMeta {
  name: string;
  nameExpr: ts.Expression|null;
  isStandalone: boolean;
+ decorator: ts.Decorator|null;
 }
 
 /**

packages/compiler-cli/src/ngtsc/metadata/src/dts.ts

@@ -58,6 +58,7 @@ export class DtsMetadataReader implements MetadataReader {
  rawDeclarations: null,
  rawImports: null,
  rawExports: null,
+ decorator: null,
  };
  }
 
@@ -119,6 +120,7 @@ export class DtsMetadataReader implements MetadataReader {
  imports: null,
  // The same goes for schemas.
  schemas: null,
+ decorator: null,
  };
  }
 
@@ -153,6 +155,7 @@ export class DtsMetadataReader implements MetadataReader {
  name,
  nameExpr: null,
  isStandalone,
+ decorator: null,
  };
  }
 }

packages/compiler-cli/src/ngtsc/scope/test/local_spec.ts

@@ -57,6 +57,7 @@ describe('LocalModuleScopeRegistry', () => {
  rawDeclarations: null,
  rawImports: null,
  rawExports: null,
+ decorator: null,
  });
 
  const scope = scopeRegistry.getScopeOfModule(Module.node) as LocalModuleScope;
@@ -77,6 +78,7 @@ describe('LocalModuleScopeRegistry', () => {
  rawDeclarations: null,
  rawImports: null,
  rawExports: null,
+ decorator: null,
  });
  metaRegistry.registerNgModuleMetadata({
  kind: MetaKind.NgModule,
@@ -88,6 +90,7 @@ describe('LocalModuleScopeRegistry', () => {
  rawDeclarations: null,
  rawImports: null,
  rawExports: null,
+ decorator: null,
  });
  metaRegistry.registerNgModuleMetadata({
  kind: MetaKind.NgModule,
@@ -99,6 +102,7 @@ describe('LocalModuleScopeRegistry', () => {
  rawDeclarations: null,
  rawImports: null,
  rawExports: null,
+ decorator: null,
  });
 
  const scopeA = scopeRegistry.getScopeOfModule(ModuleA.node) as LocalModuleScope;
@@ -119,6 +123,7 @@ describe('LocalModuleScopeRegistry', () => {
  rawDeclarations: null,
  rawImports: null,
  rawExports: null,
+ decorator: null,
  });
  metaRegistry.registerNgModuleMetadata({
  kind: MetaKind.NgModule,
@@ -130,6 +135,7 @@ describe('LocalModuleScopeRegistry', () => {
  rawDeclarations: null,
  rawImports: null,
  rawExports: null,
+ decorator: null,
  });
 
  const scopeA = scopeRegistry.getScopeOfModule(ModuleA.node) as LocalModuleScope;
@@ -150,6 +156,7 @@ describe('LocalModuleScopeRegistry', () => {
  rawDeclarations: null,
  rawImports: null,
  rawExports: null,
+ decorator: null,
  });
  metaRegistry.registerNgModuleMetadata({
  kind: MetaKind.NgModule,
@@ -161,6 +168,7 @@ describe('LocalModuleScopeRegistry', () => {
  rawDeclarations: null,
  rawImports: null,
  rawExports: null,
+ decorator: null,
  });
  metaRegistry.registerNgModuleMetadata({
  kind: MetaKind.NgModule,
@@ -172,6 +180,7 @@ describe('LocalModuleScopeRegistry', () => {
  rawDeclarations: null,
  rawImports: null,
  rawExports: null,
+ decorator: null,
  });
 
  const scope = scopeRegistry.getScopeOfModule(ModuleA.node) as LocalModuleScope;
@@ -199,6 +208,7 @@ describe('LocalModuleScopeRegistry', () => {
  rawDeclarations: null,
  rawImports: null,
  rawExports: null,
+ decorator: null,
  });
 
  const scope = scopeRegistry.getScopeOfModule(Module.node) as LocalModuleScope;
@@ -218,6 +228,7 @@ describe('LocalModuleScopeRegistry', () => {
  rawDeclarations: null,
  rawImports: null,
  rawExports: null,
+ decorator: null,
  });
  metaRegistry.registerNgModuleMetadata({
  kind: MetaKind.NgModule,
@@ -229,6 +240,7 @@ describe('LocalModuleScopeRegistry', () => {
  rawDeclarations: null,
  rawImports: null,
  rawExports: null,
+ decorator: null,
  });
 
  const scopeA = scopeRegistry.getScopeOfModule(ModuleA.node) as LocalModuleScope;
@@ -248,6 +260,7 @@ describe('LocalModuleScopeRegistry', () => {
  rawDeclarations: null,
  rawImports: null,
  rawExports: null,
+ decorator: null,
  });
  metaRegistry.registerNgModuleMetadata({
  kind: MetaKind.NgModule,
@@ -259,6 +272,7 @@ describe('LocalModuleScopeRegistry', () => {
  rawDeclarations: null,
  rawImports: null,
  rawExports: null,
+ decorator: null,
  });
 
  expect(scopeRegistry.getScopeOfModule(ModuleA.node)!.compilation.isPoisoned).toBeTrue();
@@ -297,6 +311,7 @@ function fakeDirective(ref: Reference<ClassDeclaration>): DirectiveMeta {
  isStandalone: false,
  imports: null,
  schemas: null,
+ decorator: null,
  };
 }
 
@@ -308,6 +323,7 @@ function fakePipe(ref: Reference<ClassDeclaration>): PipeMeta {
  name,
  nameExpr: null,
  isStandalone: false,
+ decorator: null,
  };
 }