Merge pull request #9916 from IgniteUI/vslavov/transaction-refactor-migrations

feat(grids): add migrations for deprecated IgxGridTransaction token

Author: zdrawku

projects/igniteui-angular/migrations/update-12_1_0/index.spec.ts

@@ -700,6 +700,73 @@ public onBannerOpened(event: BannerEventArgs) {
         }`);
     });
 
+    // Transaction providers
+    it('Should add a comment for the deprecated IgxGridTransactionToken', async () => {
+        appTree.create(
+            '/testSrc/appPrefix/component/transaction.component.ts', `
+        import { IgxGridComponent, IgxGridTransaction, IgxTransactionService } from 'igniteui-angular';
+        @Component({
+            template: '',
+            providers: [{ provide: IgxGridTransaction, useClass: IgxTransactionService }]
+        })
+        export class TransactionComponent {
+            @ViewChild(IgxGridComponent, { read: IgxGridComponent })
+            public IgxGridTransaction!: IgxGridComponent;
+        }`);
+    const tree = await schematicRunner.runSchematicAsync(migrationName, {}, appTree)
+            .toPromise();
+
+        expect(tree.readContent('/testSrc/appPrefix/component/transaction.component.ts'))
+            .toEqual(`
+        import { IgxGridComponent, IgxGridTransaction, IgxTransactionService } from 'igniteui-angular';
+        @Component({
+            template: '',
+            providers: [/* Injection token 'IgxGridTransaction' has been deprecated. Please refer to the update guide for more details. */
+{ provide: IgxGridTransaction, useClass: IgxTransactionService }]
+        })
+        export class TransactionComponent {
+            @ViewChild(IgxGridComponent, { read: IgxGridComponent })
+            public IgxGridTransaction!: IgxGridComponent;
+        }`);
+    });
+
+    it('Should add a comment for the deprecated IgxGridTransactionToken, multiple providers', async () => {
+        appTree.create(
+            '/testSrc/appPrefix/component/transaction.component.ts', `
+        import { IgxGridComponent, IgxGridTransaction, IgxTransactionService } from 'igniteui-angular';
+        @Component({
+            template: '',
+            providers: [
+                { provider: A, useClass: AService },
+                { provide: IgxGridTransaction, useClass: IgxTransactionService },
+                { provider: B, useClass: BService}
+            ]
+        })
+        export class TransactionComponent {
+            @ViewChild(IgxGridComponent, { read: IgxGridComponent })
+            public IgxGridTransaction!: IgxGridComponent;
+        }`);
+    const tree = await schematicRunner.runSchematicAsync(migrationName, {}, appTree)
+            .toPromise();
+
+        expect(tree.readContent('/testSrc/appPrefix/component/transaction.component.ts'))
+            .toEqual(`
+        import { IgxGridComponent, IgxGridTransaction, IgxTransactionService } from 'igniteui-angular';
+        @Component({
+            template: '',
+            providers: [
+                { provider: A, useClass: AService },
+                /* Injection token 'IgxGridTransaction' has been deprecated. Please refer to the update guide for more details. */
+{ provide: IgxGridTransaction, useClass: IgxTransactionService },
+                { provider: B, useClass: BService}
+            ]
+        })
+        export class TransactionComponent {
+            @ViewChild(IgxGridComponent, { read: IgxGridComponent })
+            public IgxGridTransaction!: IgxGridComponent;
+        }`);
+    });
+
     it('Should properly rename IComboSelectionChangeEventArgs to IComboSelectionChangingEventArgs',  async () => {
         appTree.create('/testSrc/appPrefix/component/test.component.ts',
         `
@@ -751,4 +818,3 @@ public onBannerOpened(event: BannerEventArgs) {
     });
 });
 
-

projects/igniteui-angular/migrations/update-12_1_0/index.ts

@@ -14,6 +14,9 @@ export default (): Rule => (host: Tree, context: SchematicContext) => {
   const prop = ['[paging]', 'paging'];
   const changes = new Map<string, FileChange[]>();
   const warnMsg = `\n<!-- Auto migrated template content. Please, check your bindings! -->\n`;
+  const deprecatedToken = 'IgxGridTransaction';
+  const providerWarnMsg = `/* Injection token 'IgxGridTransaction' has been deprecated. ` +
+  `Please refer to the update guide for more details. */`;
   const templateNames = [];
 
   const applyChanges = () => {
@@ -111,5 +114,17 @@ export default (): Rule => (host: Tree, context: SchematicContext) => {
   applyChanges();
   changes.clear();
 
+  const matchStr = String.raw`({\s*provide:\s*${deprecatedToken}[^}]*},?)`;
+  const matchExpr = new RegExp(matchStr, 'g');
+
+  for (const path of update.tsFiles) {
+    let content = host.read(path)?.toString();
+    if (content.indexOf(deprecatedToken) < 0) {
+      continue;
+    }
+    content = content.replace(matchExpr, `${providerWarnMsg}\n$1`);
+    host.overwrite(path, content);
+  }
+
   update.applyChanges();
 };