refactor(compiler-cli): rework source manager to accommodate directives (#60191)

Currently the `TemplateSourceManager` is set up to specifically cater to component templates. These changes make it more generic so we can reuse it for directives.

PR Close #60191

Author: crisbeto

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

@@ -416,11 +416,11 @@ export interface SourceLocation {
 }
 
 /**
- * A representation of all a node's template mapping information we know. Useful for producing
+ * A representation of all a node's type checking information we know. Useful for producing
  * diagnostics based on a TCB node or generally mapping from a TCB node back to a template location.
  */
-export interface FullTemplateMapping {
+export interface FullSourceMapping {
   sourceLocation: SourceLocation;
-  templateSourceMapping: SourceMapping;
+  sourceMapping: SourceMapping;
   span: ParseSourceSpan;
 }

packages/compiler-cli/src/ngtsc/typecheck/api/checker.ts

@@ -26,7 +26,7 @@ import {Reference} from '../../imports';
 import {NgModuleMeta, PipeMeta} from '../../metadata';
 import {ClassDeclaration} from '../../reflection';
 
-import {FullTemplateMapping, NgTemplateDiagnostic, TypeCheckableDirectiveMeta} from './api';
+import {FullSourceMapping, NgTemplateDiagnostic, TypeCheckableDirectiveMeta} from './api';
 import {GlobalCompletion} from './completion';
 import {PotentialDirective, PotentialImport, PotentialImportMode, PotentialPipe} from './scope';
 import {ElementSymbol, Symbol, TcbLocation, TemplateSymbol} from './symbols';
@@ -67,10 +67,10 @@ export interface TemplateTypeChecker {
   getDiagnosticsForFile(sf: ts.SourceFile, optimizeFor: OptimizeFor): ts.Diagnostic[];
 
   /**
-   * Given a `shim` and position within the file, returns information for mapping back to a template
+   * Given a `shim` and position within the file, returns information for mapping back to a source
    * location.
    */
-  getTemplateMappingAtTcbLocation(tcbLocation: TcbLocation): FullTemplateMapping | null;
+  getSourceMappingAtTcbLocation(tcbLocation: TcbLocation): FullSourceMapping | null;
 
   /**
    * Get all `ts.Diagnostic`s currently available that pertain to the given component.

packages/compiler-cli/src/ngtsc/typecheck/extended/checks/interpolated_signal_not_invoked/index.ts

@@ -96,7 +96,7 @@ function buildDiagnosticForSignal(
   // check for `{{ mySignal }}`
   const symbol = ctx.templateTypeChecker.getSymbolOfNode(node, component);
   if (symbol !== null && symbol.kind === SymbolKind.Expression && isSignalReference(symbol)) {
-    const templateMapping = ctx.templateTypeChecker.getTemplateMappingAtTcbLocation(
+    const templateMapping = ctx.templateTypeChecker.getSourceMappingAtTcbLocation(
       symbol.tcbLocation,
     )!;
     const errorString = `${node.name} is a function and should be invoked: ${node.name}()`;
@@ -116,7 +116,7 @@ function buildDiagnosticForSignal(
     symbolOfReceiver.kind === SymbolKind.Expression &&
     isSignalReference(symbolOfReceiver)
   ) {
-    const templateMapping = ctx.templateTypeChecker.getTemplateMappingAtTcbLocation(
+    const templateMapping = ctx.templateTypeChecker.getSourceMappingAtTcbLocation(
       symbolOfReceiver.tcbLocation,
     )!;
 

packages/compiler-cli/src/ngtsc/typecheck/extended/checks/nullish_coalescing_not_nullable/index.ts

@@ -51,7 +51,7 @@ class NullishCoalescingNotNullableCheck extends TemplateCheckWithVisitor<ErrorCo
     if (symbol.kind !== SymbolKind.Expression) {
       return [];
     }
-    const templateMapping = ctx.templateTypeChecker.getTemplateMappingAtTcbLocation(
+    const templateMapping = ctx.templateTypeChecker.getSourceMappingAtTcbLocation(
       symbol.tcbLocation,
     );
     if (templateMapping === null) {

packages/compiler-cli/src/ngtsc/typecheck/extended/checks/optional_chain_not_nullable/index.ts

@@ -56,7 +56,7 @@ class OptionalChainNotNullableCheck extends TemplateCheckWithVisitor<ErrorCode.O
     if (symbol.kind !== SymbolKind.Expression) {
       return [];
     }
-    const templateMapping = ctx.templateTypeChecker.getTemplateMappingAtTcbLocation(
+    const templateMapping = ctx.templateTypeChecker.getSourceMappingAtTcbLocation(
       symbol.tcbLocation,
     );
     if (templateMapping === null) {

packages/compiler-cli/src/ngtsc/typecheck/src/checker.ts

@@ -50,7 +50,7 @@ import {isShim} from '../../shims';
 import {getSourceFileOrNull, isSymbolWithValueDeclaration} from '../../util/src/typescript';
 import {
   ElementSymbol,
-  FullTemplateMapping,
+  FullSourceMapping,
   GlobalCompletion,
   NgTemplateDiagnostic,
   OptimizeFor,
@@ -80,8 +80,8 @@ import {
 } from './context';
 import {shouldReportDiagnostic, translateDiagnostic} from './diagnostics';
 import {TypeCheckShimGenerator} from './shim';
-import {TemplateSourceManager} from './source';
-import {findTypeCheckBlock, getTemplateMapping, TemplateSourceResolver} from './tcb_util';
+import {DirectiveSourceManager} from './source';
+import {findTypeCheckBlock, getSourceMapping, TypeCheckSourceResolver} from './tcb_util';
 import {SymbolBuilder} from './template_symbol_builder';
 
 const REGISTRY = new DomElementSchemaRegistry();
@@ -262,7 +262,7 @@ export class TemplateTypeCheckerImpl implements TemplateTypeChecker {
     return null;
   }
 
-  getTemplateMappingAtTcbLocation(tcbLocation: TcbLocation): FullTemplateMapping | null {
+  getSourceMappingAtTcbLocation(tcbLocation: TcbLocation): FullSourceMapping | null {
     const fileRecord = this.getFileRecordForTcbLocation(tcbLocation);
     if (fileRecord === null) {
       return null;
@@ -272,7 +272,7 @@ export class TemplateTypeCheckerImpl implements TemplateTypeChecker {
     if (shimSf === undefined) {
       return null;
     }
-    return getTemplateMapping(
+    return getSourceMapping(
       shimSf,
       tcbLocation.positionInFile,
       fileRecord.sourceManager,
@@ -466,7 +466,7 @@ export class TemplateTypeCheckerImpl implements TemplateTypeChecker {
     const sfPath = absoluteFromSourceFile(clazz.getSourceFile());
     const fileRecord = this.state.get(sfPath)!;
     const id = fileRecord.sourceManager.getTypeCheckId(clazz);
-    const mapping = fileRecord.sourceManager.getSourceMapping(id);
+    const mapping = fileRecord.sourceManager.getTemplateSourceMapping(id);
 
     return {
       ...makeTemplateDiagnostic(
@@ -648,7 +648,7 @@ export class TemplateTypeCheckerImpl implements TemplateTypeChecker {
     if (!this.state.has(path)) {
       this.state.set(path, {
         hasInlines: false,
-        sourceManager: new TemplateSourceManager(),
+        sourceManager: new DirectiveSourceManager(),
         isComplete: false,
         shimData: new Map(),
       });
@@ -1010,7 +1010,7 @@ export class TemplateTypeCheckerImpl implements TemplateTypeChecker {
 
 function convertDiagnostic(
   diag: ts.Diagnostic,
-  sourceResolver: TemplateSourceResolver,
+  sourceResolver: TypeCheckSourceResolver,
 ): TemplateDiagnostic | null {
   if (!shouldReportDiagnostic(diag)) {
     return null;
@@ -1030,10 +1030,10 @@ export interface FileTypeCheckingData {
   hasInlines: boolean;
 
   /**
-   * Source mapping information for mapping diagnostics from inlined type check blocks back to the
-   * original template.
+   * Information for mapping diagnostics from inlined type check blocks
+   * back to their original sources.
    */
-  sourceManager: TemplateSourceManager;
+  sourceManager: DirectiveSourceManager;
 
   /**
    * Data for each shim generated from this input file.
@@ -1056,7 +1056,7 @@ export interface FileTypeCheckingData {
 class WholeProgramTypeCheckingHost implements TypeCheckingHost {
   constructor(private impl: TemplateTypeCheckerImpl) {}
 
-  getSourceManager(sfPath: AbsoluteFsPath): TemplateSourceManager {
+  getSourceManager(sfPath: AbsoluteFsPath): DirectiveSourceManager {
     return this.impl.getFileData(sfPath).sourceManager;
   }
 
@@ -1099,7 +1099,7 @@ class SingleFileTypeCheckingHost implements TypeCheckingHost {
     }
   }
 
-  getSourceManager(sfPath: AbsoluteFsPath): TemplateSourceManager {
+  getSourceManager(sfPath: AbsoluteFsPath): DirectiveSourceManager {
     this.assertPath(sfPath);
     return this.fileData.sourceManager;
   }

packages/compiler-cli/src/ngtsc/typecheck/src/context.ts

@@ -41,7 +41,7 @@ import {Environment} from './environment';
 import {OutOfBandDiagnosticRecorder, OutOfBandDiagnosticRecorderImpl} from './oob';
 import {ReferenceEmitEnvironment} from './reference_emit_environment';
 import {TypeCheckShimGenerator} from './shim';
-import {TemplateSourceManager} from './source';
+import {DirectiveSourceManager} from './source';
 import {requiresInlineTypeCheckBlock, TcbInliningRequirement} from './tcb_util';
 import {generateTypeCheckBlock, TcbGenericContextBehavior} from './type_check_block';
 import {TypeCheckFile} from './type_check_file';
@@ -106,7 +106,7 @@ export interface PendingFileTypeCheckingData {
    * Source mapping information for mapping diagnostics from inlined type check blocks back to the
    * original template.
    */
-  sourceManager: TemplateSourceManager;
+  sourceManager: DirectiveSourceManager;
 
   /**
    * Map of in-progress shim data for shims generated from this input file.
@@ -145,9 +145,9 @@ export interface PendingShimData {
  */
 export interface TypeCheckingHost {
   /**
-   * Retrieve the `TemplateSourceManager` responsible for directives in the given input file path.
+   * Retrieve the `DirectiveSourceManager` responsible for directives in the given input file path.
    */
-  getSourceManager(sfPath: AbsoluteFsPath): TemplateSourceManager;
+  getSourceManager(sfPath: AbsoluteFsPath): DirectiveSourceManager;
 
   /**
    * Whether a particular class should be included in the current type-checking pass.
@@ -322,8 +322,8 @@ export class TypeCheckContextImpl implements TypeCheckContext {
     }
 
     if (templateContext !== null) {
-      fileData.sourceManager.captureSource(
-        ref.node,
+      fileData.sourceManager.captureTemplateSource(
+        id,
         templateContext.sourceMapping,
         templateContext.file,
       );

packages/compiler-cli/src/ngtsc/typecheck/src/diagnostics.ts

@@ -11,7 +11,7 @@ import ts from 'typescript';
 import {TemplateDiagnostic, TypeCheckId} from '../api';
 import {makeTemplateDiagnostic} from '../diagnostics';
 
-import {getTemplateMapping, TemplateSourceResolver} from './tcb_util';
+import {getSourceMapping, TypeCheckSourceResolver} from './tcb_util';
 
 /**
  * Wraps the node in parenthesis such that inserted span comments become attached to the proper
@@ -94,12 +94,12 @@ export function shouldReportDiagnostic(diagnostic: ts.Diagnostic): boolean {
  */
 export function translateDiagnostic(
   diagnostic: ts.Diagnostic,
-  resolver: TemplateSourceResolver,
+  resolver: TypeCheckSourceResolver,
 ): TemplateDiagnostic | null {
   if (diagnostic.file === undefined || diagnostic.start === undefined) {
     return null;
   }
-  const fullMapping = getTemplateMapping(
+  const fullMapping = getSourceMapping(
     diagnostic.file,
     diagnostic.start,
     resolver,
@@ -109,7 +109,7 @@ export function translateDiagnostic(
     return null;
   }
 
-  const {sourceLocation, templateSourceMapping, span} = fullMapping;
+  const {sourceLocation, sourceMapping: templateSourceMapping, span} = fullMapping;
   return makeTemplateDiagnostic(
     sourceLocation.id,
     templateSourceMapping,

packages/compiler-cli/src/ngtsc/typecheck/src/dom.ts

@@ -18,7 +18,7 @@ import {ErrorCode, ngErrorCode} from '../../diagnostics';
 import {TemplateDiagnostic, TypeCheckId} from '../api';
 import {makeTemplateDiagnostic} from '../diagnostics';
 
-import {TemplateSourceResolver} from './tcb_util';
+import {TypeCheckSourceResolver} from './tcb_util';
 
 const REGISTRY = new DomElementSchemaRegistry();
 const REMOVE_XHTML_REGEX = /^:xhtml:/;
@@ -88,7 +88,7 @@ export class RegistryDomSchemaChecker implements DomSchemaChecker {
     return this._diagnostics;
   }
 
-  constructor(private resolver: TemplateSourceResolver) {}
+  constructor(private resolver: TypeCheckSourceResolver) {}
 
   checkElement(
     id: TypeCheckId,
@@ -102,7 +102,7 @@ export class RegistryDomSchemaChecker implements DomSchemaChecker {
     const name = element.name.replace(REMOVE_XHTML_REGEX, '');
 
     if (!REGISTRY.hasElement(name, schemas)) {
-      const mapping = this.resolver.getSourceMapping(id);
+      const mapping = this.resolver.getTemplateSourceMapping(id);
 
       const schemas = `'${hostIsStandalone ? '@Component' : '@NgModule'}.schemas'`;
       let errorMsg = `'${name}' is not a known element:\n`;
@@ -138,7 +138,7 @@ export class RegistryDomSchemaChecker implements DomSchemaChecker {
     hostIsStandalone: boolean,
   ): void {
     if (!REGISTRY.hasProperty(element.name, name, schemas)) {
-      const mapping = this.resolver.getSourceMapping(id);
+      const mapping = this.resolver.getTemplateSourceMapping(id);
 
       const decorator = hostIsStandalone ? '@Component' : '@NgModule';
       const schemas = `'${decorator}.schemas'`;