feat(store): ignore actions from NgRx libraries in runtime checks (#2351

)
ngrx · Feb 6, 2020 · 0dabfc4 · 0dabfc4
1 parent 381f98e
commit 0dabfc4
Show file tree

Hide file tree

Showing 6 changed files with 57 additions and 22 deletions.
diff --git a/modules/store/spec/meta-reducers/immutability_reducer.spec.ts b/modules/store/spec/meta-reducers/immutability_reducer.spec.ts
@@ -44,8 +44,8 @@ describe('immutabilityCheckMetaReducer:', () => {
 
     function invokeActionReducer(reduce: Function, checkIsOn = true) {
       immutabilityCheckMetaReducer((state, action) => reduce(state, action), {
-        action: checkIsOn,
-        state: false,
+        action: () => checkIsOn,
+        state: () => false,
       })({}, { type: 'invoke', numbers: [1, 2, 3], fun: function() {} });
     }
   });
@@ -95,8 +95,8 @@ describe('immutabilityCheckMetaReducer:', () => {
           return reduce(state, action);
         },
         {
-          state: checkIsOn,
-          action: false,
+          state: () => checkIsOn,
+          action: () => false,
         }
       );
 

diff --git a/modules/store/spec/meta-reducers/serialization_reducer.spec.ts b/modules/store/spec/meta-reducers/serialization_reducer.spec.ts
@@ -95,15 +95,15 @@ describe('serializationCheckMetaReducer:', () => {
 
   function invokeActionReducer(action: any, checkIsOn = true) {
     serializationCheckMetaReducer(state => state, {
-      action: checkIsOn,
-      state: false,
+      action: () => checkIsOn,
+      state: () => false,
     })(undefined, action);
   }
 
   function invokeStateReducer(nextState?: any, checkIsOn = true) {
     serializationCheckMetaReducer(() => nextState, {
-      state: checkIsOn,
-      action: false,
+      state: () => checkIsOn,
+      action: () => false,
     })(undefined, {
       type: 'invokeReducer',
     });

diff --git a/modules/store/spec/runtime_checks.spec.ts b/modules/store/spec/runtime_checks.spec.ts
@@ -2,7 +2,7 @@ import * as ngCore from '@angular/core';
 import { TestBed, fakeAsync, flush } from '@angular/core/testing';
 import { Store, StoreModule, META_REDUCERS, USER_RUNTIME_CHECKS } from '..';
 import { createActiveRuntimeChecks } from '../src/runtime_checks';
-import { RuntimeChecks } from '../src/models';
+import { RuntimeChecks, Action } from '../src/models';
 import * as metaReducers from '../src/meta-reducers';
 
 describe('Runtime checks:', () => {
@@ -203,6 +203,18 @@ describe('Runtime checks:', () => {
         }).not.toThrow();
       })
     );
+
+    it(
+      'should not throw for NgRx actions',
+      fakeAsync(() => {
+        const store = setupStore({ strictStateSerializability: true });
+
+        expect(() => {
+          store.dispatch(makeNgrxAction(invalidAction()));
+          flush();
+        }).not.toThrow();
+      })
+    );
   });
 
   describe('Action Serialization:', () => {
@@ -295,6 +307,18 @@ describe('Runtime checks:', () => {
         }).not.toThrow();
       })
     );
+
+    it(
+      'should not throw for NgRx actions',
+      fakeAsync(() => {
+        const store = setupStore({ strictActionImmutability: true });
+
+        expect(() => {
+          store.dispatch(makeNgrxAction(invalidAction()));
+          flush();
+        }).not.toThrow();
+      })
+    );
   });
 });
 
@@ -350,3 +374,8 @@ function reducerWithBugs(state: any = {}, action: any) {
       return state;
   }
 }
+
+export function makeNgrxAction(action: Action) {
+  action.type = '@ngrx ' + action.type;
+  return action;
+}
diff --git a/modules/store/src/meta-reducers/immutability_reducer.ts b/modules/store/src/meta-reducers/immutability_reducer.ts
@@ -1,16 +1,16 @@
-import { ActionReducer } from '../models';
+import { ActionReducer, Action } from '../models';
 import { isFunction, hasOwnProperty, isObjectLike } from './utils';
 
 export function immutabilityCheckMetaReducer(
   reducer: ActionReducer<any, any>,
-  checks: { action: boolean; state: boolean }
+  checks: { action: (action: Action) => boolean; state: () => boolean }
 ): ActionReducer<any, any> {
   return function(state, action) {
-    const act = checks.action ? freeze(action) : action;
+    const act = checks.action(action) ? freeze(action) : action;
 
     const nextState = reducer(state, act);
 
-    return checks.state ? freeze(nextState) : nextState;
+    return checks.state() ? freeze(nextState) : nextState;
   };
 }
 

diff --git a/modules/store/src/meta-reducers/serialization_reducer.ts b/modules/store/src/meta-reducers/serialization_reducer.ts
@@ -1,4 +1,4 @@
-import { ActionReducer } from '../models';
+import { ActionReducer, Action } from '../models';
 import {
   isPlainObject,
   isUndefined,
@@ -11,17 +11,17 @@ import {
 
 export function serializationCheckMetaReducer(
   reducer: ActionReducer<any, any>,
-  checks: { action: boolean; state: boolean }
+  checks: { action: (action: Action) => boolean; state: () => boolean }
 ): ActionReducer<any, any> {
   return function(state, action) {
-    if (checks.action) {
+    if (checks.action(action)) {
       const unserializableAction = getUnserializable(action);
       throwIfUnserializable(unserializableAction, 'action');
     }
 
     const nextState = reducer(state, action);
 
-    if (checks.state) {
+    if (checks.state()) {
       const unserializableState = getUnserializable(nextState);
       throwIfUnserializable(unserializableState, 'state');
     }

diff --git a/modules/store/src/runtime_checks.ts b/modules/store/src/runtime_checks.ts
@@ -3,7 +3,7 @@ import {
   serializationCheckMetaReducer,
   immutabilityCheckMetaReducer,
 } from './meta-reducers';
-import { RuntimeChecks, MetaReducer } from './models';
+import { RuntimeChecks, MetaReducer, Action } from './models';
 import {
   _USER_RUNTIME_CHECKS,
   _ACTIVE_RUNTIME_CHECKS,
@@ -39,8 +39,9 @@ export function createSerializationCheckMetaReducer({
   return reducer =>
     strictActionSerializability || strictStateSerializability
       ? serializationCheckMetaReducer(reducer, {
-          action: strictActionSerializability,
-          state: strictStateSerializability,
+          action: action =>
+            strictActionSerializability && !ignoreNgrxAction(action),
+          state: () => strictStateSerializability,
         })
       : reducer;
 }
@@ -52,12 +53,17 @@ export function createImmutabilityCheckMetaReducer({
   return reducer =>
     strictActionImmutability || strictStateImmutability
       ? immutabilityCheckMetaReducer(reducer, {
-          action: strictActionImmutability,
-          state: strictStateImmutability,
+          action: action =>
+            strictActionImmutability && !ignoreNgrxAction(action),
+          state: () => strictStateImmutability,
         })
       : reducer;
 }
 
+function ignoreNgrxAction(action: Action) {
+  return action.type.startsWith('@ngrx');
+}
+
 export function provideRuntimeChecks(
   runtimeChecks?: Partial<RuntimeChecks>
 ): Provider[] {