fix(migrations): account for parameters with union types (#57127)

crisbeto · dylhunn · commit cb442a0ce718 · 2024-07-26T10:00:32.000-07:00
This can up in Material where we had a `constructor(@optionA() foo: Foo | null)` which ended up producing incorrect code, because the union type was preserved. These changes resolve the issue by picking out the first non-literal type from the union for the `inject` call. PR Close #57127
diff --git a/packages/core/schematics/ng-generate/inject-migration/migration.ts b/packages/core/schematics/ng-generate/inject-migration/migration.ts
@@ -319,6 +319,8 @@ function createInjectReplacementCall(
     // they'll be specified as type arguments to `inject()`.
     if (ts.isTypeReferenceNode(type) && type.typeArguments && type.typeArguments.length > 0) {
       injectedType = type.typeName.getText();
+    } else if (ts.isUnionTypeNode(type)) {
+      injectedType = (type.types.find((t) => !ts.isLiteralTypeNode(t)) || type.types[0]).getText();
     } else {
       injectedType = type.getText();
     }
diff --git a/packages/core/schematics/test/inject_migration_spec.ts b/packages/core/schematics/test/inject_migration_spec.ts
@@ -1139,4 +1139,31 @@ describe('inject migration', () => {
       `}`,
     ]);
   });
+
+  it('should pick up the first non-literal type if a parameter has a union type', async () => {
+    writeFile(
+      '/dir.ts',
+      [
+        `import { Directive, Optional } from '@angular/core';`,
+        `import { Foo } from 'foo';`,
+        ``,
+        `@Directive()`,
+        `class MyDir {`,
+        `  constructor(@Optional() private foo: null | Foo) {}`,
+        `}`,
+      ].join('\n'),
+    );
+
+    await runMigration();
+
+    expect(tree.readContent('/dir.ts').split('\n')).toEqual([
+      `import { Directive, Optional, inject } from '@angular/core';`,
+      `import { Foo } from 'foo';`,
+      ``,
+      `@Directive()`,
+      `class MyDir {`,
+      `  private foo = inject(Foo, { optional: true });`,
+      `}`,
+    ]);
+  });
 });

Original file line number	Diff line number	Diff line change
`@@ -319,6 +319,8 @@ function createInjectReplacementCall(`
`319`	`319`	// they'll be specified as type arguments to `inject()`.
`320`	`320`	`if (ts.isTypeReferenceNode(type) && type.typeArguments && type.typeArguments.length > 0) {`
`321`	`321`	`injectedType = type.typeName.getText();`
	`322`	`+ } else if (ts.isUnionTypeNode(type)) {`
	`323`	`+ injectedType = (type.types.find((t) => !ts.isLiteralTypeNode(t)) \|\| type.types[0]).getText();`
`322`	`324`	`} else {`
`323`	`325`	`injectedType = type.getText();`
`324`	`326`	`}`