refactor(migrations): improve generic assignability in tsurge and pass more info (#57451)

devversion · dylhunn · commit cb7d817edd48 · 2024-08-19T22:44:43.000-07:00
* Improves some of the generic assignability for tsurge. Anything is allowed to be returned from an overridden `prepareProgram` method. This is useful for the signal input migration. * Passes the absolute root paths to migrations. This is helpful for the signal input migration and there is no other way to access it. It's better to pass specifically, compared to passing the whole unsafe `ParsedConfiguration` object. PR Close #57451
diff --git a/packages/core/schematics/utils/tsurge/BUILD.bazel b/packages/core/schematics/utils/tsurge/BUILD.bazel
@@ -4,7 +4,7 @@ ts_library(
     name = "tsurge",
     srcs = glob(["**/*.ts"]),
     visibility = [
-        "//packages/core/schematics/utils/tsurge/test:__pkg__",
+        "//packages/core/schematics:__subpackages__",
     ],
     deps = [
         "//packages/compiler-cli",
diff --git a/packages/core/schematics/utils/tsurge/executors/analyze_exec.ts b/packages/core/schematics/utils/tsurge/executors/analyze_exec.ts
@@ -8,15 +8,21 @@
 
 import {TsurgeMigration} from '../migration';
 import {Serializable} from '../helpers/serializable';
+import ts from 'typescript';
+import {NgtscProgram} from '../../../../../compiler-cli/src/ngtsc/program';
 
 /**
  * Executes the analyze phase of the given migration against
  * the specified TypeScript project.
  *
  * @returns the serializable migration unit data.
  */
-export async function executeAnalyzePhase<UnitData, GlobalData>(
-  migration: TsurgeMigration<UnitData, GlobalData>,
+export async function executeAnalyzePhase<
+  UnitData,
+  GlobalData,
+  TsProgramType extends ts.Program | NgtscProgram,
+>(
+  migration: TsurgeMigration<UnitData, GlobalData, TsProgramType, unknown>,
   tsconfigAbsolutePath: string,
 ): Promise<Serializable<UnitData>> {
   const baseInfo = migration.createProgram(tsconfigAbsolutePath);
diff --git a/packages/core/schematics/utils/tsurge/executors/merge_exec.ts b/packages/core/schematics/utils/tsurge/executors/merge_exec.ts
@@ -6,17 +6,23 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
+import ts from 'typescript';
 import {Serializable} from '../helpers/serializable';
 import {TsurgeMigration} from '../migration';
+import {NgtscProgram} from '../../../../../compiler-cli/src/ngtsc/program';
 
 /**
  * Executes the merge phase for the given migration against
  * the given set of analysis unit data.
  *
  * @returns the serializable migration global data.
  */
-export async function executeMergePhase<UnitData, GlobalData>(
-  migration: TsurgeMigration<UnitData, GlobalData>,
+export async function executeMergePhase<
+  UnitData,
+  GlobalData,
+  TsProgramType extends ts.Program | NgtscProgram,
+>(
+  migration: TsurgeMigration<UnitData, GlobalData, TsProgramType, unknown>,
   units: UnitData[],
 ): Promise<Serializable<GlobalData>> {
   return await migration.merge(units);
diff --git a/packages/core/schematics/utils/tsurge/executors/migrate_exec.ts b/packages/core/schematics/utils/tsurge/executors/migrate_exec.ts
@@ -8,6 +8,8 @@
 
 import {TsurgeMigration} from '../migration';
 import {Replacement} from '../replacement';
+import {NgtscProgram} from '../../../../../compiler-cli/src/ngtsc/program';
+import ts from 'typescript';
 
 /**
  * Executes the migrate phase of the given migration against
@@ -18,8 +20,12 @@ import {Replacement} from '../replacement';
  *
  * @returns a list of text replacements to apply to disk.
  */
-export async function executeMigratePhase<UnitData, GlobalData>(
-  migration: TsurgeMigration<UnitData, GlobalData>,
+export async function executeMigratePhase<
+  UnitData,
+  GlobalData,
+  TsProgramType extends ts.Program | NgtscProgram,
+>(
+  migration: TsurgeMigration<UnitData, GlobalData, TsProgramType, unknown>,
   globalMetadata: GlobalData,
   tsconfigAbsolutePath: string,
 ): Promise<Replacement[]> {
diff --git a/packages/core/schematics/utils/tsurge/helpers/ngtsc_program.ts b/packages/core/schematics/utils/tsurge/helpers/ngtsc_program.ts
@@ -59,6 +59,7 @@ export function createNgtscProgram(
   return {
     program: ngtscProgram,
     userOptions: tsconfig.options,
+    programAbsoluteRootPaths: tsconfig.rootNames,
     tsconfigAbsolutePath: absoluteTsconfigPath,
   };
 }
diff --git a/packages/core/schematics/utils/tsurge/migration.ts b/packages/core/schematics/utils/tsurge/migration.ts
@@ -48,7 +48,7 @@ export abstract class TsurgeMigration<
   UnitAnalysisMetadata,
   CombinedGlobalMetadata,
   TsProgramType extends ts.Program | NgtscProgram = NgtscProgram,
-  FullProgramInfo extends ProgramInfo<TsProgramType> = ProgramInfo<TsProgramType>,
+  PreparationInfo = ProgramInfo<TsProgramType>,
 > {
   // By default, ngtsc programs are being created.
   createProgram(tsconfigAbsPath: string, fs?: FileSystem): BaseProgramInfo<TsProgramType> {
@@ -57,7 +57,7 @@ export abstract class TsurgeMigration<
 
   // Optional function to prepare the base `ProgramInfo` even further,
   // for the analyze and migrate phases. E.g. determining source files.
-  prepareProgram(info: BaseProgramInfo<TsProgramType>): FullProgramInfo {
+  prepareProgram(info: BaseProgramInfo<TsProgramType>): PreparationInfo {
     assert(info.program instanceof NgtscProgram);
 
     const userProgram = info.program.getTsProgram();
@@ -78,11 +78,11 @@ export abstract class TsurgeMigration<
       sourceFiles,
       fullProgramSourceFiles,
       projectDirAbsPath,
-    } as FullProgramInfo;
+    } as PreparationInfo;
   }
 
   /** Analyzes the given TypeScript project and returns serializable compilation unit data. */
-  abstract analyze(program: FullProgramInfo): Promise<Serializable<UnitAnalysisMetadata>>;
+  abstract analyze(program: PreparationInfo): Promise<Serializable<UnitAnalysisMetadata>>;
 
   /** Merges all compilation unit data from previous analysis phases into a global metadata. */
   abstract merge(units: UnitAnalysisMetadata[]): Promise<Serializable<CombinedGlobalMetadata>>;
@@ -93,6 +93,6 @@ export abstract class TsurgeMigration<
    */
   abstract migrate(
     globalMetadata: CombinedGlobalMetadata,
-    program: FullProgramInfo,
+    program: PreparationInfo,
   ): Promise<Replacement[]>;
 }
diff --git a/packages/core/schematics/utils/tsurge/program_info.ts b/packages/core/schematics/utils/tsurge/program_info.ts
@@ -19,6 +19,7 @@ import ts from 'typescript';
 export interface BaseProgramInfo<T extends NgtscProgram | ts.Program> {
   program: T;
   userOptions: NgCompilerOptions;
+  programAbsoluteRootPaths: string[];
   tsconfigAbsolutePath: string;
 }
 

Original file line number	Diff line number	Diff line change
`@@ -59,6 +59,7 @@ export function createNgtscProgram(`
`59`	`59`	`return {`
`60`	`60`	`program: ngtscProgram,`
`61`	`61`	`userOptions: tsconfig.options,`
	`62`	`+ programAbsoluteRootPaths: tsconfig.rootNames,`
`62`	`63`	`tsconfigAbsolutePath: absoluteTsconfigPath,`
`63`	`64`	`};`
`64`	`65`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@ import ts from 'typescript';`
`19`	`19`	`export interface BaseProgramInfo<T extends NgtscProgram \| ts.Program> {`
`20`	`20`	`program: T;`
`21`	`21`	`userOptions: NgCompilerOptions;`
	`22`	`+ programAbsoluteRootPaths: string[];`
`22`	`23`	`tsconfigAbsolutePath: string;`
`23`	`24`	`}`
`24`	`25`