refactor(material/schematics): create shared migration utilities folder (#25106)

* move update file content updating logic to migration-utilities

Author: wagnermaciel

src/material/schematics/migration-utilities/BUILD.bazel

@@ -0,0 +1,36 @@
+load("//tools:defaults.bzl", "jasmine_node_test", "spec_bundle", "ts_library")
+
+package(default_visibility = ["//visibility:public"])
+
+ts_library(
+    name = "migration-utilities",
+    srcs = glob(
+        ["**/*.ts"],
+        exclude = ["**/*.spec.ts"],
+    ),
+    deps = [],
+)
+
+ts_library(
+    name = "unit_tests_lib",
+    testonly = True,
+    srcs = glob(["**/*.spec.ts"] + ["rules/components/test-setup-helper.ts"]),
+    deps = [
+        ":migration-utilities",
+        "@npm//@types/jasmine",
+    ],
+)
+
+spec_bundle(
+    name = "unit_tests_bundle",
+    # Exclude the `node` devkit entry-point to avoid bundling native modules like
+    # `chokidar` and `fsevents`. These rely on native bindings and break with ESBuild.
+    external = ["@angular-devkit/core/node"],
+    platform = "node",
+    deps = [":unit_tests_lib"],
+)
+
+jasmine_node_test(
+    name = "unit_tests",
+    deps = [":unit_tests_bundle"],
+)

src/material/schematics/migration-utilities/index.spec.ts

@@ -0,0 +1,22 @@
+import {writeUpdates} from './index';
+
+describe('migration-utilities', () => {
+  describe('writeUpdates', () => {
+    it('should call update functions in the correct order', () => {
+      const fn1 = jasmine.createSpy().and.returnValue('1');
+      const fn2 = jasmine.createSpy().and.returnValue('2');
+      const fn3 = jasmine.createSpy().and.returnValue('3');
+
+      const result = writeUpdates('0', [
+        {offset: 1, updateFn: fn3},
+        {offset: 2, updateFn: fn2},
+        {offset: 3, updateFn: fn1},
+      ]);
+
+      expect(fn1).toHaveBeenCalledOnceWith('0');
+      expect(fn2).toHaveBeenCalledOnceWith('1');
+      expect(fn3).toHaveBeenCalledOnceWith('2');
+      expect(result).toBe('3');
+    });
+  });
+});

src/material/schematics/migration-utilities/index.ts

@@ -0,0 +1,23 @@
+/**
+ * @license
+ * Copyright Google LLC 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
+ */
+
+/** Stores the data needed to make a single update to a file. */
+export interface Update {
+  /** The start index of the location of the update. */
+  offset: number;
+
+  /** A function to be used to update the file content. */
+  updateFn: (html: string) => string;
+}
+
+/** Applies the updates to the given file content in reverse offset order. */
+export function writeUpdates(content: string, updates: Update[]): string {
+  updates.sort((a, b) => b.offset - a.offset);
+  updates.forEach(update => (content = update.updateFn(content)));
+  return content;
+}

src/material/schematics/ng-generate/mdc-migration/BUILD.bazel

@@ -15,6 +15,7 @@ ts_library(
     ),
     deps = [
         "//src/cdk/schematics",
+        "//src/material/schematics/migration-utilities",
         "@npm//@angular-devkit/schematics",
         "@npm//@angular/compiler",
         "@npm//@types/node",

src/material/schematics/ng-generate/mdc-migration/rules/components/card/card-template.ts

@@ -7,8 +7,9 @@
  */
 
 import * as compiler from '@angular/compiler';
-import {TemplateMigrator, Update} from '../../template-migrator';
+import {TemplateMigrator} from '../../template-migrator';
 import {addAttribute, visitElements} from '../../tree-traversal';
+import {Update} from '../../../../../migration-utilities';
 
 export class CardTemplateMigrator extends TemplateMigrator {
   getUpdates(ast: compiler.ParsedTemplate): Update[] {
@@ -20,7 +21,7 @@ export class CardTemplateMigrator extends TemplateMigrator {
       }
 
       updates.push({
-        location: node.startSourceSpan.end,
+        offset: node.startSourceSpan.start.offset,
         updateFn: html => addAttribute(html, node, 'appearance', 'outlined'),
       });
     });

src/material/schematics/ng-generate/mdc-migration/rules/components/chips/chips-template.ts

@@ -7,8 +7,9 @@
  */
 
 import * as compiler from '@angular/compiler';
-import {TemplateMigrator, Update} from '../../template-migrator';
+import {TemplateMigrator} from '../../template-migrator';
 import {replaceStartTag, replaceEndTag, visitElements} from '../../tree-traversal';
+import {Update} from '../../../../../migration-utilities';
 
 /** Stores a mat-chip-list with the mat-chip elements nested within it. */
 interface ChipMap {
@@ -91,11 +92,11 @@ export class ChipsTemplateMigrator extends TemplateMigrator {
   private _buildTagUpdates(node: compiler.TmplAstElement, tagName: string): Update[] {
     return [
       {
-        location: node.startSourceSpan.start,
+        offset: node.startSourceSpan.start.offset,
         updateFn: html => replaceStartTag(html, node, tagName),
       },
       {
-        location: node.endSourceSpan!.start,
+        offset: node.endSourceSpan!.start.offset,
         updateFn: html => replaceEndTag(html, node, tagName),
       },
     ];

src/material/schematics/ng-generate/mdc-migration/rules/template-migration.ts

@@ -10,7 +10,7 @@ import {Migration, ResolvedResource} from '@angular/cdk/schematics';
 import {SchematicContext} from '@angular-devkit/schematics';
 import {parseTemplate} from './tree-traversal';
 import {ComponentMigrator} from '.';
-import {Update} from './template-migrator';
+import {Update, writeUpdates} from '../../../migration-utilities';
 
 export class TemplateMigration extends Migration<ComponentMigrator[], SchematicContext> {
   enabled = true;
@@ -22,11 +22,7 @@ export class TemplateMigration extends Migration<ComponentMigrator[], SchematicC
     const updates: Update[] = [];
     migrators.forEach(m => updates.push(...m.getUpdates(ast)));
 
-    updates.sort((a, b) => b.location.offset - a.location.offset);
-    updates.forEach(update => {
-      template.content = update.updateFn(template.content);
-    });
-
-    this.fileSystem.overwrite(template.filePath, template.content);
+    const content = writeUpdates(template.content, updates);
+    this.fileSystem.overwrite(template.filePath, content);
   }
 }

src/material/schematics/ng-generate/mdc-migration/rules/template-migrator.ts

@@ -7,15 +7,7 @@
  */
 
 import * as compiler from '@angular/compiler';
-
-/** Stores the data needed to make a template update. */
-export interface Update {
-  /** The location of the update. */
-  location: compiler.ParseLocation;
-
-  /** A function to be used to update the template. */
-  updateFn: (html: string) => string;
-}
+import {Update} from '../../../migration-utilities';
 
 export abstract class TemplateMigrator {
   /** Returns the data needed to update the given node. */