feat: resync state

Author: SebastienGllmt

README.md

@@ -100,6 +100,8 @@ const App = () => {
       - pauses persistence
     - `.persist()`
       - resumes persistence
+    - `.resync()`
+      - overrides redux state with the value in storage
 
 ## State Reconciler
 State reconcilers define how incoming state is merged in with initial state. It is critical to choose the right state reconciler for your state. There are three options that ship out of the box, let's look at how each operates:

src/constants.js

@@ -3,6 +3,7 @@
 export const KEY_PREFIX = 'persist:'
 export const FLUSH = 'persist/FLUSH'
 export const REHYDRATE = 'persist/REHYDRATE'
+export const RESYNC = 'persist/RESYNC'
 export const PAUSE = 'persist/PAUSE'
 export const PERSIST = 'persist/PERSIST'
 export const PURGE = 'persist/PURGE'

src/persistReducer.js

@@ -6,6 +6,7 @@ import {
   PURGE,
   REHYDRATE,
   DEFAULT_VERSION,
+  RESYNC,
 } from './constants'
 
 import type {
@@ -73,9 +74,7 @@ export default function persistReducer<State: Object, Action: Object>(
         // dev warning if we are already sealed
         if (process.env.NODE_ENV !== 'production' && _sealed)
           console.error(
-            `redux-persist: rehydrate for "${
-              config.key
-            }" called after timeout.`,
+            `redux-persist: rehydrate for "${config.key}" called after timeout.`,
             payload,
             err
           )
@@ -92,9 +91,7 @@ export default function persistReducer<State: Object, Action: Object>(
             _rehydrate(
               undefined,
               new Error(
-                `redux-persist: persist timed out for persist key "${
-                  config.key
-                }"`
+                `redux-persist: persist timed out for persist key "${config.key}"`
               )
             )
         }, timeout)
@@ -112,7 +109,7 @@ export default function persistReducer<State: Object, Action: Object>(
         return {
           ...baseReducer(restState, action),
           _persist,
-        };
+        }
       }
 
       if (
@@ -155,6 +152,16 @@ export default function persistReducer<State: Object, Action: Object>(
         ...baseReducer(restState, action),
         _persist,
       }
+    } else if (action.type === RESYNC) {
+      getStoredState(config).then(
+        restoredState => action.rehydrate(config.key, restoredState, undefined),
+        err => action.rehydrate(config.key, undefined, err)
+      )
+
+      return {
+        ...baseReducer(restState, action),
+        _persist: { version, rehydrated: false },
+      }
     } else if (action.type === FLUSH) {
       action.result(_persistoid && _persistoid.flush())
       return {

src/persistStore.js

@@ -11,7 +11,15 @@ import type {
 } from './types'
 
 import { createStore } from 'redux'
-import { FLUSH, PAUSE, PERSIST, PURGE, REGISTER, REHYDRATE } from './constants'
+import {
+  FLUSH,
+  PAUSE,
+  PERSIST,
+  RESYNC,
+  PURGE,
+  REGISTER,
+  REHYDRATE,
+} from './constants'
 
 type PendingRehydrate = [Object, RehydrateErrorType, PersistConfig]
 type Persist = <R>(PersistConfig, MigrationManifest) => R => R
@@ -120,9 +128,12 @@ export default function persistStore(
     persist: () => {
       store.dispatch({ type: PERSIST, register, rehydrate })
     },
+    resync: () => {
+      store.dispatch({ type: RESYNC, rehydrate })
+    },
   }
 
-  if (!(options && options.manualPersist)){
+  if (!(options && options.manualPersist)) {
     persistor.persist()
   }
 

types/constants.d.ts

@@ -2,6 +2,7 @@ declare module "redux-persist/es/constants" {
   const KEY_PREFIX: 'persist:';
   const FLUSH: 'persist/FLUSH';
   const REHYDRATE: 'persist/REHYDRATE';
+  const RESYNC: 'persist/RESYNC';
   const PAUSE: 'persist/PAUSE';
   const PERSIST: 'persist/PERSIST';
   const PURGE: 'persist/PURGE';

types/types.d.ts

@@ -137,6 +137,7 @@ declare module "redux-persist/es/types" {
   interface Persistor {
     pause(): void;
     persist(): void;
+    resync(): void;
     purge(): Promise<any>;
     flush(): Promise<any>;
     dispatch(action: PersistorAction): PersistorAction;