feat: apply Object.freeze in patchState on state in dev mode

Author: rainerhahnekamp

modules/signals/spec/signal-state.spec.ts

@@ -194,4 +194,14 @@ describe('signalState', () => {
       expect(stateCounter).toBe(3);
       expect(userCounter).toBe(1);
     }));
+
+  it('throws on a mutable change', () => {
+    const userState = signalState(initialState);
+    expect(() =>
+      patchState(userState, (state) => {
+        state.ngrx = 'mutable change';
+        return state;
+      })
+    ).toThrowError("Cannot assign to read only property 'ngrx' of object");
+  });
 });

modules/signals/src/state-source.ts

@@ -10,6 +10,8 @@ import {
 import { SIGNAL } from '@angular/core/primitives/signals';
 import { Prettify } from './ts-helpers';
 
+declare const ngDevMode: boolean;
+
 const STATE_WATCHERS = new WeakMap<object, Array<StateWatcher<any>>>();
 
 export const STATE_SOURCE = Symbol('STATE_SOURCE');
@@ -40,7 +42,9 @@ export function patchState<State extends object>(
     updaters.reduce(
       (nextState: State, updater) => ({
         ...nextState,
-        ...(typeof updater === 'function' ? updater(nextState) : updater),
+        ...(typeof updater === 'function'
+          ? updater(freezeInDevMode(nextState))
+          : updater),
       }),
       currentState
     )
@@ -49,6 +53,14 @@ export function patchState<State extends object>(
   notifyWatchers(stateSource);
 }
 
+function freezeInDevMode<State extends object>(value: State): State {
+  if (ngDevMode) {
+    Object.freeze(value);
+  }
+
+  return value;
+}
+
 export function getState<State extends object>(
   stateSource: StateSource<State>
 ): State {