Skip to content

fix(core): include input name in error message #60404

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
crisbeto wants to merge 1 commit into from
Closed

fix(core): include input name in error message #60404

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
10 changes: 6 additions & 4 deletions packages/core/src/authoring/input/input_signal.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,10 +127,12 @@ export function createInputSignal<T, TransformT>(
producerAccessed(node);

if (node.value === REQUIRED_UNSET_VALUE) {
throw new RuntimeError(
RuntimeErrorCode.REQUIRED_INPUT_NO_VALUE,
ngDevMode && 'Input is required but no value is available yet.',
);
let message: string | null = null;
if (ngDevMode) {
const name = options?.debugName ?? options?.alias;
message = `Input${name ? ` "${name}"` : ''} is required but no value is available yet.`;
}
throw new RuntimeError(RuntimeErrorCode.REQUIRED_INPUT_NO_VALUE, message);
}

return node.value;
Expand Down
28 changes: 28 additions & 0 deletions packages/core/test/authoring/input_signal_spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,34 @@ describe('input signal', () => {
});
});

it('should include debugName in required inputs error message, if available', () => {
TestBed.runInInjectionContext(() => {
const signal = input.required({debugName: 'mySignal'});
const node = signal[SIGNAL];

expect(() => signal()).toThrowError(
/Input "mySignal" is required but no value is available yet\./,
);

node.applyValueToInputSignal(node, 1);
expect(signal()).toBe(1);
});
});

it('should include alias in required inputs error message, if available', () => {
TestBed.runInInjectionContext(() => {
const signal = input.required({alias: 'alias'});
const node = signal[SIGNAL];

expect(() => signal()).toThrowError(
/Input "alias" is required but no value is available yet\./,
);

node.applyValueToInputSignal(node, 1);
expect(signal()).toBe(1);
});
});

it('should throw if a `computed` depends on an uninitialized required input', () => {
TestBed.runInInjectionContext(() => {
const signal = input.required<number>();
Expand Down