Skip to content

fix(compiler-cli): apply debugName transform to required signal queries #69462

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

Open
P4 wants to merge 1 commit into
base: main
Choose a base branch
from
+274 −6
Open

fix(compiler-cli): apply debugName transform to required signal queries #69462

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
14 changes: 8 additions & 6 deletions packages/compiler-cli/src/ngtsc/transform/src/implicit_signal_debug_name_transform.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,10 @@ function insertDebugNameIntoCallExpression(
node: ts.CallExpression,
debugName: string,
): ts.CallExpression {
const isRequired = isRequiredSignalFunction(node.expression);
const isRequiredInput = isRequiredInputFunction(node.expression);
const hasNoArgs = node.arguments.length === 0;
const configPosition = hasNoArgs || isSignalWithObjectOnlyDefinition(node) || isRequired ? 0 : 1;
const configPosition =
hasNoArgs || isSignalWithObjectOnlyDefinition(node) || isRequiredInput ? 0 : 1;
const existingArg =
configPosition >= node.arguments.length ? null : node.arguments[configPosition];

Expand Down Expand Up @@ -62,7 +63,7 @@ function insertDebugNameIntoCallExpression(

// If we're adding an argument, but the function requires a first argument (e.g. `input()`),
// we have to add `undefined` before the debug literal.
if (hasNoArgs && !isRequired) {
if (hasNoArgs && !isRequiredInput) {
spreadArgs.push(ts.factory.createIdentifier('undefined'));
}

Expand Down Expand Up @@ -297,15 +298,16 @@ function isSignalFunction(expression: ts.Identifier): boolean {
return signalFunctions.has(text);
}

function isRequiredSignalFunction(expression: ts.Expression): boolean {
// Check for a property access expression that uses the 'required' property
function isRequiredInputFunction(expression: ts.Expression): boolean {
// Check for a property access expression that uses the 'required' property on `input` or `model`
if (
ts.isPropertyAccessExpression(expression) &&
ts.isIdentifier(expression.name) &&
ts.isIdentifier(expression.expression)
) {
const accessName = expression.name.text;
if (accessName === 'required') {
const parentName = expression.expression.text;
if (accessName === 'required' && (parentName === 'input' || parentName === 'model')) {
return true;
}
}
Expand Down
266 changes: 266 additions & 0 deletions packages/compiler-cli/test/ngtsc/debug_transform_spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1319,6 +1319,139 @@ runInEachFileSystem(() => {
`viewChild("foo", { debugName: "testViewChild", read: ElementRef })`,
);
});

describe('.required', () => {
it('should insert debug info into .required', () => {
env.write(
'test.ts',
`
import {viewChild, Component} from '@angular/core';

@Component({
template: '',
})
class MyComponent {
testViewChild = viewChild.required('foo');
}
`,
);
env.driveMain();

const jsContents = env.getContents('test.js');
expect(cleanNewLines(jsContents)).toContain(
`viewChild.required('foo', /* @ts-ignore */ ...(ngDevMode ? [{ debugName: "testViewChild" }] : /* istanbul ignore next */ []))`,
);
});

it('should insert debug info into .required with existing options', () => {
env.write(
'test.ts',
`
import {viewChild, Component, ElementRef} from '@angular/core';

@Component({
template: ''
}) class MyComponent {
testViewChild = viewChild.required('foo', { read: ElementRef });
}
`,
);
env.driveMain();

const jsContents = env.getContents('test.js');
expect(cleanNewLines(jsContents)).toContain(
`viewChild.required('foo', { ...(ngDevMode ? { debugName: "testViewChild" } : /* istanbul ignore next */ {}), read: ElementRef })`,
);
});

it('should tree-shake away debug info if in prod mode', () => async () => {
env.write(
'test.ts',
`
import {viewChild, Component} from '@angular/core';

@Component({
template: ''
})
class MyComponent {
testViewChild = viewChild.required('foo');
}
`,
);
env.driveMain();

const jsContents = env.getContents('test.js');
const builtContent = (await esbuild.transform(jsContents, minifiedProdBuildOptions)).code;
expect(builtContent).not.toContain('debugName');
expect(cleanNewLines(builtContent)).toContain(`viewChild( "foo" )`);
});

it('should not tree-shake away debug info if in dev mode', async () => {
env.write(
'test.ts',
`
import {viewChild, Component} from '@angular/core';

@Component({
template: '',
})
class MyComponent {
testViewChild = viewChild.required('foo');
}
`,
);
env.driveMain();

const jsContents = env.getContents('test.js');
const builtContent = (await esbuild.transform(jsContents, minifiedDevBuildOptions)).code;
expect(cleanNewLines(builtContent)).toContain(
`viewChild.required( "foo", { debugName: "testViewChild" } )`,
);
});

it('should tree-shake away debug info if in prod mode with custom options', async () => {
env.write(
'test.ts',
`
import {viewChild, Component, ElementRef} from '@angular/core';

@Component({
template: ''
}) class MyComponent {
testViewChild = viewChild.required('foo', { read: ElementRef });
}
`,
);
env.driveMain();

const jsContents = env.getContents('test.js');
const builtContent = (await esbuild.transform(jsContents, minifiedProdBuildOptions)).code;
expect(builtContent).not.toContain('debugName');
expect(builtContent).toContain('viewChild.required("foo", { read: ElementRef })');
});

it('should not tree-shake away debug info if in dev mode with custom options', async () => {
env.write(
'test.ts',
`
import {viewChild, Component, ElementRef} from '@angular/core';

@Component({
template: ''
}) class MyComponent {
testViewChild = viewChild.required('foo', { read: ElementRef });
}
`,
);
env.driveMain();

const jsContents = env.getContents('test.js');
const builtContent = (await esbuild.transform(jsContents, minifiedDevBuildOptions)).code;
expect(cleanNewLines(builtContent)).toContain(
`viewChild.required("foo", { debugName: "testViewChild", read: ElementRef })`,
);
});
});
});

describe('viewChildren', () => {
Expand Down Expand Up @@ -1575,6 +1708,139 @@ runInEachFileSystem(() => {
`contentChild("foo", { debugName: "testContentChild", read: ElementRef })`,
);
});

describe('.required', () => {
it('should insert debug info into .required', () => {
env.write(
'test.ts',
`
import {contentChild, Component} from '@angular/core';

@Component({
template: '',
})
class MyComponent {
testContentChild = contentChild.required('foo');
}
`,
);
env.driveMain();

const jsContents = env.getContents('test.js');
expect(cleanNewLines(jsContents)).toContain(
`contentChild.required('foo', /* @ts-ignore */ ...(ngDevMode ? [{ debugName: "testContentChild" }] : /* istanbul ignore next */ []))`,
);
});

it('should insert debug info into .required with existing options', () => {
env.write(
'test.ts',
`
import {contentChild, Component, ElementRef} from '@angular/core';

@Component({
template: ''
}) class MyComponent {
testContentChild = contentChild.required('foo', { read: ElementRef });
}
`,
);
env.driveMain();

const jsContents = env.getContents('test.js');
expect(cleanNewLines(jsContents)).toContain(
`contentChild.required('foo', { ...(ngDevMode ? { debugName: "testContentChild" } : /* istanbul ignore next */ {}), read: ElementRef })`,
);
});

it('should tree-shake away debug info if in prod mode', () => async () => {
env.write(
'test.ts',
`
import {contentChild, Component} from '@angular/core';

@Component({
template: ''
})
class MyComponent {
testContentChild = contentChild.required('foo');
}
`,
);
env.driveMain();

const jsContents = env.getContents('test.js');
const builtContent = (await esbuild.transform(jsContents, minifiedProdBuildOptions)).code;
expect(builtContent).not.toContain('debugName');
expect(cleanNewLines(builtContent)).toContain(`contentChild( "foo" )`);
});

it('should not tree-shake away debug info if in dev mode', async () => {
env.write(
'test.ts',
`
import {contentChild, Component} from '@angular/core';

@Component({
template: '',
})
class MyComponent {
testContentChild = contentChild.required('foo');
}
`,
);
env.driveMain();

const jsContents = env.getContents('test.js');
const builtContent = (await esbuild.transform(jsContents, minifiedDevBuildOptions)).code;
expect(cleanNewLines(builtContent)).toContain(
`contentChild.required( "foo", { debugName: "testContentChild" } )`,
);
});

it('should tree-shake away debug info if in prod mode with custom options', async () => {
env.write(
'test.ts',
`
import {contentChild, Component, ElementRef} from '@angular/core';

@Component({
template: ''
}) class MyComponent {
testContentChild = contentChild.required('foo', { read: ElementRef });
}
`,
);
env.driveMain();

const jsContents = env.getContents('test.js');
const builtContent = (await esbuild.transform(jsContents, minifiedProdBuildOptions)).code;
expect(builtContent).not.toContain('debugName');
expect(builtContent).toContain('contentChild.required("foo", { read: ElementRef })');
});

it('should not tree-shake away debug info if in dev mode with custom options', async () => {
env.write(
'test.ts',
`
import {contentChild, Component, ElementRef} from '@angular/core';

@Component({
template: ''
}) class MyComponent {
testContentChild = contentChild.required('foo', { read: ElementRef });
}
`,
);
env.driveMain();

const jsContents = env.getContents('test.js');
const builtContent = (await esbuild.transform(jsContents, minifiedDevBuildOptions)).code;
expect(cleanNewLines(builtContent)).toContain(
`contentChild.required("foo", { debugName: "testContentChild", read: ElementRef })`,
);
});
});
});

describe('contentChildren', () => {
Expand Down
Loading