feat(persistence): additional options

Brigad · Mar 21, 2018 · d7243c9 · d7243c9
1 parent 57c243f
commit d7243c9
Show file tree

Hide file tree

Showing 5 changed files with 169 additions and 47 deletions.
diff --git a/__tests__/internals/persistence/getPrunedForPersistenceState.test.js b/__tests__/internals/persistence/getPrunedForPersistenceState.test.js
@@ -3,10 +3,10 @@ import moment from 'moment';
 
 import getPrunedForPersistenceState from '../../../src/internals/persistence/getPrunedForPersistenceState';
 
-const URL_1 = 'https://api.co/fruits?page1';
-const URL_2 = 'https://api.co/fruits?page2';
-const URL_3 = 'https://api.co/fruits?page3';
-const URL_4 = 'https://api.co/fruits?page4';
+const URL_PENDING = 'https://api.co/fruits?page1';
+const URL_INVALIDATED = 'https://api.co/fruits?page2';
+const URL_SOON_TO_EXPIRE = 'https://api.co/fruits?page3';
+const URL_NEVER_EXPIRE = 'https://api.co/fruits?page4';
 const RESOURCE_NAME = 'fruits';
 const RESOURCE_NAME_2 = 'vegetables';
 const RESOURCE_NAME_3 = 'sauces';
@@ -19,7 +19,7 @@ const EXPIRE_AT_NEVER = 'never';
 
 const STATE_REQUESTS = {
   requests: {
-    [URL_1]: {
+    [URL_PENDING]: {
       resourceName: RESOURCE_NAME,
       resourceId: null,
       startedAt: MOMENT_NOW,
@@ -30,7 +30,7 @@ const STATE_REQUESTS = {
       didInvalidate: false,
       fromCache: false,
     },
-    [URL_2]: {
+    [URL_INVALIDATED]: {
       resourceName: RESOURCE_NAME,
       resourceId: null,
       startedAt: MOMENT_NOW,
@@ -41,7 +41,7 @@ const STATE_REQUESTS = {
       didInvalidate: true,
       fromCache: false,
     },
-    [URL_3]: {
+    [URL_SOON_TO_EXPIRE]: {
       resourceName: RESOURCE_NAME,
       resourceId: null,
       startedAt: MOMENT_NOW,
@@ -52,7 +52,7 @@ const STATE_REQUESTS = {
       didInvalidate: false,
       fromCache: false,
     },
-    [URL_4]: {
+    [URL_NEVER_EXPIRE]: {
       resourceName: RESOURCE_NAME,
       resourceId: null,
       startedAt: MOMENT_NOW,
@@ -68,7 +68,7 @@ const STATE_REQUESTS = {
 
 const STATE_RESOURCES = {
   requests: {
-    [URL_1]: {
+    [URL_PENDING]: {
       resourceName: RESOURCE_NAME,
       resourceId: null,
       startedAt: MOMENT_NOW,
@@ -82,7 +82,21 @@ const STATE_RESOURCES = {
         [RESOURCE_NAME]: [1, 2, 3],
       },
     },
-    [URL_4]: {
+    [URL_INVALIDATED]: {
+      resourceName: RESOURCE_NAME,
+      resourceId: null,
+      startedAt: MOMENT_NOW,
+      endedAt: MOMENT_NOW,
+      expireAt: EXPIRE_AT_NEVER,
+      hasSucceeded: true,
+      hasFailed: false,
+      didInvalidate: true,
+      fromCache: false,
+      payloadIds: {
+        [RESOURCE_NAME]: [1, 2, 3],
+      },
+    },
+    [URL_NEVER_EXPIRE]: {
       resourceName: RESOURCE_NAME,
       resourceId: null,
       startedAt: MOMENT_NOW,
@@ -114,7 +128,7 @@ const STATE_RESOURCES = {
 
 const STATE_RESOURCES_OTHER_ORDER = {
   requests: {
-    [URL_4]: {
+    [URL_NEVER_EXPIRE]: {
       resourceName: RESOURCE_NAME,
       resourceId: null,
       startedAt: MOMENT_NOW,
@@ -128,7 +142,7 @@ const STATE_RESOURCES_OTHER_ORDER = {
         [RESOURCE_NAME]: [3, 4, 5],
       },
     },
-    [URL_1]: {
+    [URL_PENDING]: {
       resourceName: RESOURCE_NAME,
       resourceId: null,
       startedAt: MOMENT_NOW,
@@ -142,6 +156,20 @@ const STATE_RESOURCES_OTHER_ORDER = {
         [RESOURCE_NAME]: [1, 2, 3],
       },
     },
+    [URL_INVALIDATED]: {
+      resourceName: RESOURCE_NAME,
+      resourceId: null,
+      startedAt: MOMENT_NOW,
+      endedAt: MOMENT_NOW,
+      expireAt: EXPIRE_AT_NEVER,
+      hasSucceeded: true,
+      hasFailed: false,
+      didInvalidate: true,
+      fromCache: false,
+      payloadIds: {
+        [RESOURCE_NAME]: [1, 2, 3],
+      },
+    },
   },
   resources: {
     [RESOURCE_NAME_2]: {
@@ -160,7 +188,7 @@ const STATE_RESOURCES_OTHER_ORDER = {
 
 const STATE_RESOLVERS_HASHES = {
   requests: {
-    [URL_1]: {
+    [URL_PENDING]: {
       resourceName: RESOURCE_NAME,
       resourceId: null,
       startedAt: MOMENT_NOW,
@@ -174,7 +202,7 @@ const STATE_RESOLVERS_HASHES = {
         [RESOURCE_NAME]: [1, 2, 3],
       },
     },
-    [URL_4]: {
+    [URL_NEVER_EXPIRE]: {
       resourceName: RESOURCE_NAME,
       resourceId: null,
       startedAt: MOMENT_NOW,
@@ -209,11 +237,11 @@ const STATE_RESOLVERS_HASHES = {
   },
   resolversHashes: {
     requests: {
-      [URL_1]: {
-        [RESOURCE_NAME]: 'URL_1_HASH',
+      [URL_PENDING]: {
+        [RESOURCE_NAME]: 'URL_PENDING_HASH',
       },
-      [URL_4]: {
-        [RESOURCE_NAME]: 'URL_4_HASH',
+      [URL_NEVER_EXPIRE]: {
+        [RESOURCE_NAME]: 'URL_NEVER_EXPIRE_HASH',
       },
     },
     resources: {
@@ -240,46 +268,96 @@ describe('getPrunedForPersistenceState', () => {
 
   test('requests: no endedAt', () => {
     expect(
-      getPrunedForPersistenceState(STATE_REQUESTS).requests[URL_1],
+      getPrunedForPersistenceState(STATE_REQUESTS).requests[URL_PENDING],
     ).toBeUndefined();
   });
 
   test('requests: didInvalidate', () => {
     expect(
-      getPrunedForPersistenceState(STATE_REQUESTS).requests[URL_2],
+      getPrunedForPersistenceState(STATE_REQUESTS).requests[URL_INVALIDATED],
     ).toBeUndefined();
   });
 
   test('requests: cache expired', () => {
     mockdate.set(MOMENT_NOW);
     expect(
-      getPrunedForPersistenceState(STATE_REQUESTS).requests[URL_3],
+      getPrunedForPersistenceState(STATE_REQUESTS).requests[URL_SOON_TO_EXPIRE],
     ).not.toBeUndefined();
 
     mockdate.set(moment(MOMENT_NOW).add(999, 'milliseconds'));
     expect(
-      getPrunedForPersistenceState(STATE_REQUESTS).requests[URL_3],
+      getPrunedForPersistenceState(STATE_REQUESTS).requests[URL_SOON_TO_EXPIRE],
     ).not.toBeUndefined();
 
     mockdate.set(moment(MOMENT_NOW).add(1000, 'milliseconds'));
     expect(
-      getPrunedForPersistenceState(STATE_REQUESTS).requests[URL_3],
+      getPrunedForPersistenceState(STATE_REQUESTS).requests[URL_SOON_TO_EXPIRE],
     ).not.toBeUndefined();
 
     mockdate.set(moment(MOMENT_NOW).add(1001, 'milliseconds'));
     expect(
-      getPrunedForPersistenceState(STATE_REQUESTS).requests[URL_3],
+      getPrunedForPersistenceState(STATE_REQUESTS).requests[URL_SOON_TO_EXPIRE],
     ).toBeUndefined();
   });
 
   test('requests: expiredAt never', () => {
     mockdate.set(MOMENT_NOW);
     expect(
-      getPrunedForPersistenceState(STATE_REQUESTS).requests[URL_4]
+      getPrunedForPersistenceState(STATE_REQUESTS).requests[URL_NEVER_EXPIRE]
         .didInvalidate,
     ).toBe(true);
   });
 
+  test('requests: always persist string', () => {
+    expect(
+      getPrunedForPersistenceState(STATE_RESOURCES, {
+        alwaysPersist: RESOURCE_NAME,
+      }).requests[URL_INVALIDATED],
+    ).not.toBeUndefined();
+  });
+
+  test('requests: always persist array', () => {
+    expect(
+      getPrunedForPersistenceState(STATE_RESOURCES, {
+        alwaysPersist: [RESOURCE_NAME],
+      }).requests[URL_INVALIDATED],
+    ).not.toBeUndefined();
+  });
+
+  test('requests: always persist no endedAt string', () => {
+    expect(
+      getPrunedForPersistenceState(STATE_RESOURCES, {
+        alwaysPersist: RESOURCE_NAME,
+      }).requests[URL_PENDING],
+    ).toBeUndefined();
+  });
+
+  test('requests: always persist no endedAt array', () => {
+    expect(
+      getPrunedForPersistenceState(STATE_RESOURCES, {
+        alwaysPersist: [RESOURCE_NAME],
+      }).requests[URL_PENDING],
+    ).toBeUndefined();
+  });
+
+  test('requests: never persist string', () => {
+    mockdate.set(MOMENT_NOW);
+    expect(
+      getPrunedForPersistenceState(STATE_RESOURCES, {
+        neverPersist: RESOURCE_NAME,
+      }).requests[URL_NEVER_EXPIRE],
+    ).toBeUndefined();
+  });
+
+  test('requests: never persist array', () => {
+    mockdate.set(MOMENT_NOW);
+    expect(
+      getPrunedForPersistenceState(STATE_RESOURCES, {
+        neverPersist: [RESOURCE_NAME],
+      }).requests[URL_NEVER_EXPIRE],
+    ).toBeUndefined();
+  });
+
   test('resources first order', () => {
     const prunedState = getPrunedForPersistenceState(STATE_RESOURCES);
     const prunedStateResourcesIds = Object.keys(
@@ -323,9 +401,9 @@ describe('getPrunedForPersistenceState', () => {
       STATE_RESOLVERS_HASHES,
     ).resolversHashes;
 
-    expect(prunedStateResolversHashes.requests[URL_1]).toBeUndefined();
+    expect(prunedStateResolversHashes.requests[URL_PENDING]).toBeUndefined();
     expect(
-      prunedStateResolversHashes.requests[URL_4][RESOURCE_NAME],
+      prunedStateResolversHashes.requests[URL_NEVER_EXPIRE][RESOURCE_NAME],
     ).not.toBeUndefined();
     expect(prunedStateResolversHashes.resources[RESOURCE_NAME]).toBeUndefined();
     expect(

diff --git a/docs/api/getPersistableState.md b/docs/api/getPersistableState.md
@@ -1,10 +1,14 @@
-# `getPersistableState(state)`
+# `getPersistableState(state, options)`
 
 Returns a state pruned from outdated data. [Read more](../principles/persistence.md) about what is removed from the state exactly.
 
 #### Arguments
 
-1.  (_state_): The current Redux state
+1.  (_state_): (`object`) The current Redux state
+2.  (_persistOptions_): (`object`) An object containing additional, optional options for the pruning:
+
+A. (_alwaysPersist_): (`string || array<string>`) String or array of strings containing resource name(s). Request performing on the resource(s) will **always** be persisted, expired or not
+B. (_neverPersist_): (`string || array<string>`) String or array of strings containing resource name(s). Request performing on the resource(s) will **never** be persisted, expired or not
 
 #### Returns
 
@@ -23,9 +27,16 @@ import thunkMiddleware from 'redux-thunk';
 // No need to manually install redux-persist if you already have installed redux-offline
 import { createTransform } from 'redux-persist';
 
-const restEasyTransform = createTransform(getPersistableState, null, {
-  whitelist: ['restEasy'],
-});
+const restEasyTransform = createTransform(
+  state =>
+    getPersistableState(state, {
+      persist: { alwaysPersist: ['tokens'], neverPersist: ['configuration'] },
+    }),
+  null,
+  {
+    whitelist: ['restEasy'],
+  },
+);
 
 const createPersistedStore = (persistCallback, initialStore = {}) => {
   const offlineCustomConfig = {
@@ -46,3 +57,8 @@ const createPersistedStore = (persistCallback, initialStore = {}) => {
 
 export default createPersistedStore;
 ```
+
+#### Tips
+
+* `persistOptions.alwaysPersist` is a great way to persist resources you would never want to expire
+* `persistOptions.neverPersist` is a great way to clear some resources each time your app starts
diff --git a/docs/principles/persistence.md b/docs/principles/persistence.md
@@ -4,7 +4,10 @@ Redux-rest-easy works out-of-the-box with libraries such as [redux-offline](http
 
 Here is a list of actions performed when you call [getPersistableState](../api/getPersistableState.md):
 
-* in-progress, expired and invalidated requests are deleted
-* requests with `expireAt` set to `never` (`cacheLifetime` set to `Infinity`) are invalidated
-* resources which are no longer referenced by any request are deleted
-* resolversHashes which refer to no longer existing requests or modified resources are deleted
+* In-progress requests are deleted. _This is to avoid pending requests never resolving._
+* Expired and invalidated requests are deleted. _This is to avoid keeping outdated requests possibly forever._
+* Requests with `expireAt` set to `never` (`cacheLifetime` set to `Infinity`) are invalidated. _This is to avoid trusting remote data forever. Can still be done via persistOptions.alwaysPersist_
+* Resources which are no longer referenced by any request are deleted. _This is to avoidkeeping outdated resources in the state._
+* resolversHashes which refer to no longer existing requests or modified resources are deleted. _This is to avoidkeeping outdated hashes in the state._
+
+The first action is mandatory to avoid inconsistent state, but the others won't be applied to requests performing on resources defined in `persistOptions.alwaysPersist` and `persistOptions.neverPersist`. Instead, such requests will always/never be persisted.
diff --git a/src/getPersistableState.js b/src/getPersistableState.js
@@ -1,5 +1,6 @@
 import getPrunedForPersistenceState from './internals/persistence/getPrunedForPersistenceState';
 
-const getPersistableState = state => getPrunedForPersistenceState(state);
+const getPersistableState = (state, persistOptions) =>
+  getPrunedForPersistenceState(state, persistOptions);
 
 export default getPersistableState;
diff --git a/src/internals/persistence/getPrunedForPersistenceState.js b/src/internals/persistence/getPrunedForPersistenceState.js
@@ -1,23 +1,47 @@
+/* eslint-disable no-nested-ternary */
+
 import hasCacheExpired from '../utils/hasCacheExpired';
 
-const getPrunedForPersistenceState = (state) => {
+const getPrunedForPersistenceState = (
+  state,
+  { alwaysPersist, neverPersist } = {},
+) => {
   if (!state || !Object.keys(state).length) {
     return {};
   }
 
+  const alwaysPersistResources
+    = typeof alwaysPersist === 'string' ? [alwaysPersist] : alwaysPersist;
+  const neverPersistResources
+    = typeof neverPersist === 'string' ? [neverPersist] : neverPersist;
+
   const newRequests = Object.entries(state.requests || {}).reduce(
     (allRequests, [key, request]) => ({
       ...allRequests,
       ...(request.endedAt
-      && !request.didInvalidate
-      && !hasCacheExpired(request.expireAt)
-        ? {
-            [key]:
-              request.expireAt === 'never'
-                ? { ...request, didInvalidate: true }
-                : request,
-          }
-        : {}),
+      && alwaysPersistResources
+      && request.payloadIds
+      && Object.keys(request.payloadIds).some(resourceName =>
+        alwaysPersistResources.includes(resourceName),
+      )
+        ? { [key]: request }
+        : !(
+            neverPersistResources
+            && request.payloadIds
+            && Object.keys(request.payloadIds).some(resourceName =>
+              neverPersistResources.includes(resourceName),
+            )
+          )
+          && request.endedAt
+          && !request.didInvalidate
+          && !hasCacheExpired(request.expireAt)
+          ? {
+              [key]:
+                request.expireAt === 'never'
+                  ? { ...request, didInvalidate: true }
+                  : request,
+            }
+          : {}),
     }),
     {},
   );