Skip to content

fix(core): handle shorthand assignment in the inject migration #57134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
cexbrayat wants to merge 1 commit into from
Closed

fix(core): handle shorthand assignment in the inject migration #57134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions packages/core/schematics/ng-generate/inject-migration/analysis.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,11 @@ export function detectClassesUsingDI(sourceFile: ts.SourceFile, localTypeChecker
export function getConstructorUnusedParameters(
declaration: ts.ConstructorDeclaration,
localTypeChecker: ts.TypeChecker,
): Set<ts.ParameterDeclaration> {
const accessedTopLevelParameters = new Set<ts.ParameterDeclaration>();
const topLevelParameters = new Set<ts.ParameterDeclaration>();
): Set<ts.Declaration> {
const accessedTopLevelParameters = new Set<ts.Declaration>();
const topLevelParameters = new Set<ts.Declaration>();
const topLevelParameterNames = new Set<string>();
const unusedParams = new Set<ts.ParameterDeclaration>();
const unusedParams = new Set<ts.Declaration>();

// Prepare the parameters for quicker checks further down.
for (const param of declaration.parameters) {
Expand Down Expand Up @@ -102,6 +102,12 @@ export function getConstructorUnusedParameters(
if (ts.isParameter(decl) && topLevelParameters.has(decl)) {
accessedTopLevelParameters.add(decl);
}
if (ts.isShorthandPropertyAssignment(decl)) {
const symbol = localTypeChecker.getShorthandAssignmentValueSymbol(decl);
if (symbol && symbol.valueDeclaration && ts.isParameter(symbol.valueDeclaration)) {
accessedTopLevelParameters.add(symbol.valueDeclaration);
}
}
});
});

Expand All @@ -110,7 +116,6 @@ export function getConstructorUnusedParameters(
unusedParams.add(param);
}
}

return unusedParams;
}

Expand Down
35 changes: 33 additions & 2 deletions packages/core/schematics/test/inject_migration_spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -503,6 +503,37 @@ describe('inject migration', () => {
]);
});

it('should declare a variable if an injected parameter with modifiers is referenced in the constructor via shorthand assignment', async () => {
writeFile(
'/dir.ts',
[
`import { Directive, Inject, LOCALE_ID } from '@angular/core';`,
``,
`@Directive()`,
`class MyDir {`,
` constructor(@Inject(LOCALE_ID) locale: string) {`,
` console.log({ locale });`,
` }`,
`}`,
].join('\n'),
);

await runMigration();

expect(tree.readContent('/dir.ts').split('\n')).toEqual([
`import { Directive, Inject, LOCALE_ID, inject } from '@angular/core';`,
``,
`@Directive()`,
`class MyDir {`,
` constructor() {`,
` const locale = inject(LOCALE_ID);`,
``,
` console.log({ locale });`,
` }`,
`}`,
]);
});

it('should not declare a variable in the constructor if the only references to the parameter are shadowed', async () => {
writeFile(
'/dir.ts',
Expand Down Expand Up @@ -824,7 +855,7 @@ describe('inject migration', () => {
]);
});

it('should be able to opt into generating backwads-compatible constructors for a class with existing members', async () => {
it('should be able to opt into generating backwards-compatible constructors for a class with existing members', async () => {
writeFile(
'/dir.ts',
[
Expand Down Expand Up @@ -870,7 +901,7 @@ describe('inject migration', () => {
]);
});

it('should be able to opt into generating backwads-compatible constructors for a class that only has a constructor', async () => {
it('should be able to opt into generating backwards-compatible constructors for a class that only has a constructor', async () => {
writeFile(
'/dir.ts',
[
Expand Down