feat(core): pass signal node to throwInvalidWriteToSignalErrorFn (#59600)

mturco · thePunderWoman · commit 2588985f433b · 2025-02-13T17:56:14.000Z
Updates the signature of the `throwInvalidWriteToSignalError` to take the signal node in question and pass it along to the throwInvalidWriteToSignalErrorFn handler function. This allows the handler to e.g. include the signal name in error messaging. PR Close #59600
diff --git a/goldens/public-api/core/primitives/signals/index.api.md b/goldens/public-api/core/primitives/signals/index.api.md
@@ -144,7 +144,7 @@ export function setAlternateWeakRefImpl(impl: unknown): void;
 export function setPostSignalSetFn(fn: (() => void) | null): (() => void) | null;
 
 // @public (undocumented)
-export function setThrowInvalidWriteToSignalError(fn: () => never): void;
+export function setThrowInvalidWriteToSignalError(fn: <T>(node: SignalNode<T>) => never): void;
 
 // @public
 export const SIGNAL: unique symbol;
diff --git a/packages/core/primitives/signals/src/errors.ts b/packages/core/primitives/signals/src/errors.ts
@@ -6,16 +6,18 @@
  * found in the LICENSE file at https://angular.dev/license
  */
 
+import type {SignalNode} from './signal';
+
 function defaultThrowError(): never {
   throw new Error();
 }
 
-let throwInvalidWriteToSignalErrorFn = defaultThrowError;
+let throwInvalidWriteToSignalErrorFn: <T>(node: SignalNode<T>) => never = defaultThrowError;
 
-export function throwInvalidWriteToSignalError() {
-  throwInvalidWriteToSignalErrorFn();
+export function throwInvalidWriteToSignalError<T>(node: SignalNode<T>) {
+  throwInvalidWriteToSignalErrorFn(node);
 }
 
-export function setThrowInvalidWriteToSignalError(fn: () => never): void {
+export function setThrowInvalidWriteToSignalError(fn: <T>(node: SignalNode<T>) => never): void {
   throwInvalidWriteToSignalErrorFn = fn;
 }
diff --git a/packages/core/primitives/signals/src/signal.ts b/packages/core/primitives/signals/src/signal.ts
@@ -70,7 +70,7 @@ export function signalGetFn<T>(this: SignalNode<T>): T {
 
 export function signalSetFn<T>(node: SignalNode<T>, newValue: T) {
   if (!producerUpdatesAllowed()) {
-    throwInvalidWriteToSignalError();
+    throwInvalidWriteToSignalError(node);
   }
 
   if (!node.equal(node.value, newValue)) {
@@ -81,7 +81,7 @@ export function signalSetFn<T>(node: SignalNode<T>, newValue: T) {
 
 export function signalUpdateFn<T>(node: SignalNode<T>, updater: (value: T) => T): void {
   if (!producerUpdatesAllowed()) {
-    throwInvalidWriteToSignalError();
+    throwInvalidWriteToSignalError(node);
   }
 
   signalSetFn(node, updater(node.value));

Original file line number	Diff line number	Diff line change
`@@ -6,16 +6,18 @@`
`6`	`6`	`* found in the LICENSE file at https://angular.dev/license`
`7`	`7`	`*/`
`8`	`8`
	`9`	`+import type {SignalNode} from './signal';`
	`10`	`+`
`9`	`11`	`function defaultThrowError(): never {`
`10`	`12`	`throw new Error();`
`11`	`13`	`}`
`12`	`14`
`13`		`-let throwInvalidWriteToSignalErrorFn = defaultThrowError;`
	`15`	`+let throwInvalidWriteToSignalErrorFn: <T>(node: SignalNode<T>) => never = defaultThrowError;`
`14`	`16`
`15`		`-export function throwInvalidWriteToSignalError() {`
`16`		`- throwInvalidWriteToSignalErrorFn();`
	`17`	`+export function throwInvalidWriteToSignalError<T>(node: SignalNode<T>) {`
	`18`	`+ throwInvalidWriteToSignalErrorFn(node);`
`17`	`19`	`}`
`18`	`20`
`19`		`-export function setThrowInvalidWriteToSignalError(fn: () => never): void {`
	`21`	`+export function setThrowInvalidWriteToSignalError(fn: <T>(node: SignalNode<T>) => never): void {`
`20`	`22`	`throwInvalidWriteToSignalErrorFn = fn;`
`21`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ export function signalGetFn<T>(this: SignalNode<T>): T {`
`70`	`70`
`71`	`71`	`export function signalSetFn<T>(node: SignalNode<T>, newValue: T) {`
`72`	`72`	`if (!producerUpdatesAllowed()) {`
`73`		`- throwInvalidWriteToSignalError();`
	`73`	`+ throwInvalidWriteToSignalError(node);`
`74`	`74`	`}`
`75`	`75`
`76`	`76`	`if (!node.equal(node.value, newValue)) {`
`@@ -81,7 +81,7 @@ export function signalSetFn<T>(node: SignalNode<T>, newValue: T) {`
`81`	`81`
`82`	`82`	`export function signalUpdateFn<T>(node: SignalNode<T>, updater: (value: T) => T): void {`
`83`	`83`	`if (!producerUpdatesAllowed()) {`
`84`		`- throwInvalidWriteToSignalError();`
	`84`	`+ throwInvalidWriteToSignalError(node);`
`85`	`85`	`}`
`86`	`86`
`87`	`87`	`signalSetFn(node, updater(node.value));`