fix(store-devtools): correctly import state when feature is set to tr…

…ue (#3855) Closes #3636
ngrx · Apr 24, 2023 · 0df3419 · 0df3419
1 parent 3a5e5d8
commit 0df3419
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 2 deletions.
diff --git a/modules/store-devtools/spec/config.spec.ts b/modules/store-devtools/spec/config.spec.ts
@@ -109,4 +109,30 @@ describe('StoreDevtoolsOptions', () => {
       },
     });
   });
+
+  it('import "true" is updated to "custom"', () => {
+    // setting import to true results in an error while importing a persisted state into the devtools
+    // the imported state only contains the new state without the actions (and config)
+    // while testing this, the imported state also wasn't correct and contained the initial state values
+    const config = createConfig({
+      features: {
+        import: true,
+      },
+    });
+    expect(config).toEqual({
+      maxAge: false,
+      monitor: noMonitor,
+      actionSanitizer: undefined,
+      stateSanitizer: undefined,
+      name: DEFAULT_NAME,
+      serialize: false,
+      logOnly: false,
+      autoPause: false,
+      features: {
+        import: 'custom',
+      },
+      trace: false,
+      traceLimit: 75,
+    });
+  });
 });
diff --git a/modules/store-devtools/src/config.ts b/modules/store-devtools/src/config.ts
@@ -172,7 +172,15 @@ export function createConfig(
   const logOnly = options.logOnly
     ? { pause: true, export: true, test: true }
     : false;
-  const features = options.features || logOnly || DEFAULT_OPTIONS.features;
+  const features: NonNullable<Partial<StoreDevtoolsConfig['features']>> =
+    options.features ||
+    logOnly ||
+    (DEFAULT_OPTIONS.features as NonNullable<
+      Partial<StoreDevtoolsConfig['features']>
+    >);
+  if (features.import === true) {
+    features.import = 'custom';
+  }
   const config = Object.assign({}, DEFAULT_OPTIONS, { features }, options);
 
   if (config.maxAge && config.maxAge < 2) {

diff --git a/projects/example-app/src/app/app.module.ts b/projects/example-app/src/app/app.module.ts
@@ -62,7 +62,6 @@ import { AppComponent } from '@example-app/core/containers';
      */
     StoreDevtoolsModule.instrument({
       name: 'NgRx Book Store App',
-
       // In a production build you would want to disable the Store Devtools
       // logOnly: !isDevMode(),
     }),