Merge pull request #552 from jnowakow/snapshots

Add snapshot functionality
Expensify · Jun 13, 2024 · 56c3994 · 56c3994
2 parents 3cabc12 + 4ba3b9a
commit 56c3994
Show file tree

Hide file tree

Showing 3 changed files with 81 additions and 1 deletion.
diff --git a/lib/Onyx.ts b/lib/Onyx.ts
@@ -1,5 +1,6 @@
 /* eslint-disable no-continue */
 import _ from 'underscore';
+import lodashPick from 'lodash/pick';
 import * as Logger from './Logger';
 import cache from './OnyxCache';
 import createDeferredTask from './createDeferredTask';
@@ -631,6 +632,46 @@ function clear(keysToPreserve: OnyxKey[] = []): Promise<void> {
         .then(() => undefined);
 }
 
+function updateSnapshots(data: OnyxUpdate[]) {
+    const snapshotCollectionKey = OnyxUtils.getSnapshotKey();
+    if (!snapshotCollectionKey) return;
+
+    const promises: Array<() => Promise<void>> = [];
+
+    const snapshotCollection = OnyxUtils.getCachedCollection(snapshotCollectionKey);
+
+    Object.entries(snapshotCollection).forEach(([snapshotKey, snapshotValue]) => {
+        // Snapshots may not be present in cache. We don't know how to update them so we skip.
+        if (!snapshotValue) {
+            return;
+        }
+
+        let updatedData = {};
+
+        data.forEach(({key, value}) => {
+            // snapshots are normal keys so we want to skip update if they are written to Onyx
+            if (OnyxUtils.isCollectionMemberKey(snapshotCollectionKey, key)) {
+                return;
+            }
+
+            if (typeof snapshotValue !== 'object' || !('data' in snapshotValue)) {
+                return;
+            }
+
+            const snapshotData = snapshotValue.data;
+            if (!snapshotData || !snapshotData[key]) {
+                return;
+            }
+
+            updatedData = {...updatedData, [key]: lodashPick(value, Object.keys(snapshotData[key]))};
+        });
+
+        promises.push(() => merge(snapshotKey, {data: updatedData}));
+    });
+
+    return Promise.all(promises.map((p) => p()));
+}
+
 /**
  * Insert API responses and lifecycle data into Onyx
  *
@@ -679,7 +720,10 @@ function update(data: OnyxUpdate[]): Promise<void> {
         }
     });
 
-    return clearPromise.then(() => Promise.all(promises.map((p) => p()))).then(() => undefined);
+    return clearPromise
+        .then(() => Promise.all(promises.map((p) => p())))
+        .then(() => updateSnapshots(data))
+        .then(() => undefined);
 }
 
 const Onyx = {

diff --git a/lib/OnyxUtils.ts b/lib/OnyxUtils.ts
@@ -68,6 +68,12 @@ let defaultKeyStates: Record<OnyxKey, OnyxValue<OnyxKey>> = {};
 let batchUpdatesPromise: Promise<void> | null = null;
 let batchUpdatesQueue: Array<() => void> = [];
 
+let snapshotKey: OnyxKey | null = null;
+
+function getSnapshotKey(): OnyxKey | null {
+    return snapshotKey;
+}
+
 /**
  * Getter - returns the merge queue.
  */
@@ -119,6 +125,10 @@ function initStoreValues(keys: DeepRecord<string, OnyxKey>, initialKeyStates: Pa
 
     // Let Onyx know about which keys are safe to evict
     evictionAllowList = safeEvictionKeys;
+
+    if (typeof keys.COLLECTION === 'object' && typeof keys.COLLECTION.SNAPSHOT === 'string') {
+        snapshotKey = keys.COLLECTION.SNAPSHOT;
+    }
 }
 
 /**
@@ -1142,6 +1152,7 @@ const OnyxUtils = {
     prepareKeyValuePairsForStorage,
     applyMerge,
     initializeWithDefaultKeyStates,
+    getSnapshotKey,
 };
 
 export default OnyxUtils;
diff --git a/tests/unit/onyxTest.ts b/tests/unit/onyxTest.ts
@@ -15,6 +15,7 @@ const ONYX_KEYS = {
         TEST_POLICY: 'testPolicy_',
         TEST_UPDATE: 'testUpdate_',
         ANIMALS: 'animals_',
+        SNAPSHOT: 'snapshot_',
     },
 };
 
@@ -1368,4 +1369,28 @@ describe('Onyx', () => {
                 connectionIDs.map((id) => Onyx.disconnect(id));
             });
     });
+
+    it('should update Snapshot when its data changed', async () => {
+        const cat = `${ONYX_KEYS.COLLECTION.ANIMALS}cat`;
+        const snapshot1 = `${ONYX_KEYS.COLLECTION.SNAPSHOT}1`;
+
+        const initialValue = {name: 'Fluffy'};
+        const finalValue = {name: 'Kitty'};
+
+        await Onyx.set(cat, initialValue);
+        await Onyx.set(snapshot1, {data: {[cat]: initialValue}});
+
+        const callback = jest.fn();
+
+        Onyx.connect({
+            key: ONYX_KEYS.COLLECTION.SNAPSHOT,
+            callback,
+        });
+
+        await Onyx.update([{key: cat, value: finalValue, onyxMethod: Onyx.METHOD.MERGE}]);
+
+        expect(callback).toBeCalledTimes(2);
+        expect(callback).toHaveBeenNthCalledWith(1, {data: {[cat]: initialValue}}, snapshot1);
+        expect(callback).toHaveBeenNthCalledWith(2, {data: {[cat]: finalValue}}, snapshot1);
+    });
 });