Skip to content

feat(compiler): allow template to access private props #70188

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
JeanMeche wants to merge 1 commit into
base: main
Choose a base branch
from
+38 −14
Open

feat(compiler): allow template to access private props #70188

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
17 changes: 17 additions & 0 deletions packages/compiler-cli/src/ngtsc/typecheck/src/diagnostics.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,15 @@ import {makeTemplateDiagnostic} from '../diagnostics';

import {getSourceMapping, TypeCheckSourceResolver} from './tcb_util';

/**
* This function will the check the source text of the TCB instead of doing a more expensive AST traversal (via getTokenAtPosition)
*/
function isAccessOnThis(text: string, start: number): boolean {
return (
text.substring(start - 5, start) === 'this.' || text.substring(start - 7, start) === '(this).'
);
}

/**
* Determines if the diagnostic should be reported. Some diagnostics are produced because of the
* way TCBs are generated; those diagnostics should not be reported as type check errors of the
Expand All @@ -27,7 +36,15 @@ export function shouldReportDiagnostic(diagnostic: ts.Diagnostic): boolean {
return false;
} else if (code === 7006 /* Parameter '$event' implicitly has an 'any' type. */) {
return false;
} else if (code === 2341 /* Property 'X' is private and only accessible within class */) {
if (diagnostic.file !== undefined && diagnostic.start !== undefined) {
// Here we're discarding private property reads error to allow them to be used in template expressions
if (isAccessOnThis(diagnostic.file.text, diagnostic.start)) {
return false;
}
}
}

return true;
}

Expand Down
21 changes: 18 additions & 3 deletions packages/compiler-cli/src/ngtsc/typecheck/test/diagnostics_spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -748,7 +748,7 @@ class TestComponent {
expect(messages).toEqual([]);
});

it('disallows access to private members', () => {
it('allow access to private members', () => {
const messages = diagnose(
`<button (click)="doFoo()">{{ message }}</button>`,
`
Expand All @@ -758,9 +758,24 @@ class TestComponent {
}`,
);

expect(messages).toEqual([]);
});

it('disallows access of a nested private member', () => {
const messages = diagnose(
`<div>{{ prop.a }}</div>`,
`
export class Model {
private a = 1;
}

export class TestComponent {
private prop = new Model();
}
`,
);
expect(messages).toEqual([
`TestComponent.html(1, 18): Property 'doFoo' is private and only accessible within class 'TestComponent'.`,
`TestComponent.html(1, 30): Property 'message' is private and only accessible within class 'TestComponent'.`,
`TestComponent.html(1, 14): Property 'a' is private and only accessible within class 'Model'.`,
]);
});
});
Expand Down
14 changes: 3 additions & 11 deletions packages/compiler-cli/test/ngtsc/host_bindings_type_check_spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
* found in the LICENSE file at https://angular.dev/license
*/

import ts from 'typescript';
import {runInEachFileSystem} from '../../src/ngtsc/file_system/testing';
import {loadStandardTestFiles} from '../../src/ngtsc/testing';
import {NgtscTestEnvironment} from './env';
import ts from 'typescript';

const testFiles = loadStandardTestFiles();

Expand Down Expand Up @@ -603,7 +603,7 @@ runInEachFileSystem(() => {
expect(getDiagnosticSourceCode(diags[0])).toBe('two');
});

it('should report host decorators on private members', () => {
it('should not report host decorators on private members', () => {
env.write(
'test.ts',
`
Expand All @@ -618,15 +618,7 @@ runInEachFileSystem(() => {
);

const diags = env.driveDiagnostics();
expect(diags.length).toBe(2);
expect(diags[0].messageText).toBe(
`Property 'id' is private and only accessible within class 'Comp'.`,
);
expect(diags[1].messageText).toBe(
`Property 'handleClick' is private and only accessible within class 'Comp'.`,
);
expect(getDiagnosticSourceCode(diags[0])).toBe('id');
expect(getDiagnosticSourceCode(diags[1])).toBe('handleClick');
expect(diags.length).toBe(0);
});

it('should report diagnostic on the entire expression of property binding if node contains escaped string', () => {
Expand Down