fix(core): return a readonly signal on asReadonly. (#54706)

JeanMeche · pkozlowski-opensource · commit 7243c704cf8a · 2024-03-06T14:41:12.000+01:00
Previous `asReadonly()` returned the signal value and not the signal itself. Fixes #54704 PR Close #54706
diff --git a/packages/core/src/authoring/model/model_signal.ts b/packages/core/src/authoring/model/model_signal.ts
@@ -10,7 +10,7 @@ import {producerAccessed, SIGNAL, signalSetFn} from '@angular/core/primitives/si
 
 import {RuntimeError, RuntimeErrorCode} from '../../errors';
 import {Signal} from '../../render3/reactivity/api';
-import {WritableSignal, ɵWRITABLE_SIGNAL} from '../../render3/reactivity/signal';
+import {signalAsReadonlyFn, WritableSignal, ɵWRITABLE_SIGNAL} from '../../render3/reactivity/signal';
 import {ɵINPUT_SIGNAL_BRAND_READ_TYPE, ɵINPUT_SIGNAL_BRAND_WRITE_TYPE} from '../input/input_signal';
 import {INPUT_SIGNAL_NODE, InputSignalNode, REQUIRED_UNSET_VALUE} from '../input/input_signal_node';
 import {OutputEmitterRef} from '../output/output_emitter_ref';
@@ -63,7 +63,7 @@ export function createModelSignal<T>(initialValue: T): ModelSignal<T> {
   }
 
   getter[SIGNAL] = node;
-  getter.asReadonly = (() => getter()) as () => Signal<T>;
+  getter.asReadonly = signalAsReadonlyFn.bind(getter as any) as () => Signal<T>;
 
   // TODO: Should we throw an error when updating a destroyed model?
   getter.set = (newValue: T) => {
diff --git a/packages/core/src/render3/reactivity/signal.ts b/packages/core/src/render3/reactivity/signal.ts
@@ -80,7 +80,7 @@ export function signal<T>(initialValue: T, options?: CreateSignalOptions<T>): Wr
   return signalFn as WritableSignal<T>;
 }
 
-function signalAsReadonlyFn<T>(this: SignalGetter<T>): Signal<T> {
+export function signalAsReadonlyFn<T>(this: SignalGetter<T>): Signal<T> {
   const node = this[SIGNAL] as SignalNode<T>& {readonlyFn?: Signal<T>};
   if (node.readonlyFn === undefined) {
     const readonlyFn = () => this();
diff --git a/packages/core/test/authoring/model_input_spec.ts b/packages/core/test/authoring/model_input_spec.ts
@@ -6,7 +6,7 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import {computed, model} from '@angular/core';
+import {computed, isSignal, model, WritableSignal} from '@angular/core';
 import {TestBed} from '@angular/core/testing';
 
 describe('model signal', () => {
@@ -35,6 +35,16 @@ describe('model signal', () => {
     expect(signal()).toBe(18);
   });
 
+  it('should return readonly signal', () => {
+    const signal = TestBed.runInInjectionContext(() => model(2));
+    const readOnly = signal.asReadonly();
+
+    expect(isSignal(readOnly)).toBeTrue();
+    expect(readOnly()).toBe(2);
+    expect((readOnly as WritableSignal<unknown>).set).toBeUndefined();
+    expect((readOnly as WritableSignal<unknown>).update).toBeUndefined();
+  });
+
   it('should emit when the value changes', () => {
     const signal = TestBed.runInInjectionContext(() => model(1));
     const values: number[] = [];

Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ export function signal<T>(initialValue: T, options?: CreateSignalOptions<T>): Wr`
`80`	`80`	`return signalFn as WritableSignal<T>;`
`81`	`81`	`}`
`82`	`82`
`83`		`-function signalAsReadonlyFn<T>(this: SignalGetter<T>): Signal<T> {`
	`83`	`+export function signalAsReadonlyFn<T>(this: SignalGetter<T>): Signal<T> {`
`84`	`84`	`const node = this[SIGNAL] as SignalNode<T>& {readonlyFn?: Signal<T>};`
`85`	`85`	`if (node.readonlyFn === undefined) {`
`86`	`86`	`const readonlyFn = () => this();`