feat(router-store) warn about DefaultRouterStateSerializer for runtime checks enabled (ngrx#2940)

Closes ngrx#2686

Author: david-shortman

modules/router-store/src/router_store_module.ts

@@ -4,6 +4,7 @@ import {
   ModuleWithProviders,
   NgModule,
   ErrorHandler,
+  isDevMode,
 } from '@angular/core';
 import {
   NavigationCancel,
@@ -15,7 +16,14 @@ import {
   Event,
   RouterEvent,
 } from '@angular/router';
-import { select, Selector, Store } from '@ngrx/store';
+import {
+  isNgrxMockEnvironment,
+  RuntimeChecks,
+  select,
+  Selector,
+  Store,
+  ACTIVE_RUNTIME_CHECKS,
+} from '@ngrx/store';
 import { withLatestFrom } from 'rxjs/operators';
 
 import {
@@ -188,10 +196,28 @@ export class StoreRouterConnectingModule {
     private router: Router,
     private serializer: RouterStateSerializer<SerializedRouterStateSnapshot>,
     private errorHandler: ErrorHandler,
-    @Inject(ROUTER_CONFIG) private config: StoreRouterConfig
+    @Inject(ROUTER_CONFIG) private config: StoreRouterConfig,
+    @Inject(ACTIVE_RUNTIME_CHECKS) private activeRuntimeChecks: RuntimeChecks
   ) {
     this.stateKey = this.config.stateKey as StateKeyOrSelector;
 
+    if (
+      !isNgrxMockEnvironment() &&
+      isDevMode() &&
+      (activeRuntimeChecks?.strictActionSerializability ||
+        activeRuntimeChecks?.strictStateSerializability) &&
+      this.serializer instanceof DefaultRouterStateSerializer
+    ) {
+      console.warn(
+        '@ngrx/router-store: The serializability runtime checks cannot be enabled ' +
+          'with the DefaultRouterStateSerializer. The default serializer ' +
+          'has an unserializable router state and actions that are not serializable. ' +
+          'To use the serializability runtime checks either use ' +
+          'the MinimalRouterStateSerializer or implement a custom router state serializer. ' +
+          'This also applies to Ivy with immutability runtime checks.'
+      );
+    }
+
     this.setUpStoreStateListener();
     this.setUpRouterEventsListener();
   }

modules/store/src/index.ts

@@ -48,6 +48,7 @@ export {
   FEATURE_REDUCERS,
   USER_PROVIDED_META_REDUCERS,
   USER_RUNTIME_CHECKS,
+  ACTIVE_RUNTIME_CHECKS,
 } from './tokens';
 export {
   StoreModule,

modules/store/src/runtime_checks.ts

@@ -7,7 +7,7 @@ import {
 import { RuntimeChecks, MetaReducer, Action } from './models';
 import {
   _USER_RUNTIME_CHECKS,
-  _ACTIVE_RUNTIME_CHECKS,
+  ACTIVE_RUNTIME_CHECKS,
   META_REDUCERS,
   USER_RUNTIME_CHECKS,
   _ACTION_TYPE_UNIQUENESS_CHECK,
@@ -98,26 +98,26 @@ export function provideRuntimeChecks(
       deps: [_USER_RUNTIME_CHECKS],
     },
     {
-      provide: _ACTIVE_RUNTIME_CHECKS,
+      provide: ACTIVE_RUNTIME_CHECKS,
       deps: [USER_RUNTIME_CHECKS],
       useFactory: createActiveRuntimeChecks,
     },
     {
       provide: META_REDUCERS,
       multi: true,
-      deps: [_ACTIVE_RUNTIME_CHECKS],
+      deps: [ACTIVE_RUNTIME_CHECKS],
       useFactory: createImmutabilityCheckMetaReducer,
     },
     {
       provide: META_REDUCERS,
       multi: true,
-      deps: [_ACTIVE_RUNTIME_CHECKS],
+      deps: [ACTIVE_RUNTIME_CHECKS],
       useFactory: createSerializationCheckMetaReducer,
     },
     {
       provide: META_REDUCERS,
       multi: true,
-      deps: [_ACTIVE_RUNTIME_CHECKS],
+      deps: [ACTIVE_RUNTIME_CHECKS],
       useFactory: createInNgZoneCheckMetaReducer,
     },
   ];
@@ -128,7 +128,7 @@ export function checkForActionTypeUniqueness(): Provider[] {
     {
       provide: _ACTION_TYPE_UNIQUENESS_CHECK,
       multi: true,
-      deps: [_ACTIVE_RUNTIME_CHECKS],
+      deps: [ACTIVE_RUNTIME_CHECKS],
       useFactory: _actionTypeUniquenessCheck,
     },
   ];

modules/store/src/store_module.ts

@@ -37,7 +37,7 @@ import {
   USER_PROVIDED_META_REDUCERS,
   _RESOLVED_META_REDUCERS,
   _ROOT_STORE_GUARD,
-  _ACTIVE_RUNTIME_CHECKS,
+  ACTIVE_RUNTIME_CHECKS,
   _ACTION_TYPE_UNIQUENESS_CHECK,
 } from './tokens';
 import { ACTIONS_SUBJECT_PROVIDERS, ActionsSubject } from './actions_subject';

modules/store/src/tokens.ts

@@ -83,7 +83,7 @@ export const _USER_RUNTIME_CHECKS = new InjectionToken<RuntimeChecks>(
 /**
  * Runtime checks currently in use
  */
-export const _ACTIVE_RUNTIME_CHECKS = new InjectionToken<RuntimeChecks>(
+export const ACTIVE_RUNTIME_CHECKS = new InjectionToken<RuntimeChecks>(
   '@ngrx/store Internal Runtime Checks'
 );