react-native-onyx 3.0.9 → 3.0.10

package/dist/Onyx.js

@@ -626,8 +626,9 @@ function setCollection(collectionKey, collection) {
         });
         const keyValuePairs = OnyxUtils_1.default.prepareKeyValuePairsForStorage(mutableCollection, true, undefined, true);
         const previousCollection = OnyxUtils_1.default.getCachedCollection(collectionKey);
-        keyValuePairs.forEach(([key, value]) => OnyxCache_1.default.set(key, value));
-        const updatePromise = OnyxUtils_1.default.scheduleNotifyCollectionSubscribers(collectionKey, mutableCollection, previousCollection);
+        // Preserve references for unchanged items in setCollection
+        const preservedCollection = OnyxUtils_1.default.preserveCollectionReferences(keyValuePairs);
+        const updatePromise = OnyxUtils_1.default.scheduleNotifyCollectionSubscribers(collectionKey, preservedCollection, previousCollection);
         return storage_1.default.multiSet(keyValuePairs)
             .catch((error) => OnyxUtils_1.default.evictStorageAndRetry(error, setCollection, collectionKey, collection))
             .then(() => {

package/dist/OnyxUtils.d.ts

@@ -1,6 +1,6 @@
 import type { ValueOf } from 'type-fest';
 import type Onyx from './Onyx';
-import type { CollectionKey, CollectionKeyBase, ConnectOptions, DeepRecord, KeyValueMapping, CallbackToStateMapping, MultiMergeReplaceNullPatches, OnyxCollection, OnyxEntry, OnyxInput, OnyxKey, OnyxMergeCollectionInput, OnyxUpdate, OnyxValue, Selector } from './types';
+import type { CollectionKey, CollectionKeyBase, ConnectOptions, DeepRecord, KeyValueMapping, CallbackToStateMapping, MultiMergeReplaceNullPatches, OnyxCollection, OnyxEntry, OnyxInput, OnyxInputKeyValueMapping, OnyxKey, OnyxMergeCollectionInput, OnyxUpdate, OnyxValue, Selector } from './types';
 import type { FastMergeResult } from './utils';
 import type { DeferredTask } from './createDeferredTask';
 import type { StorageKeyValuePair } from './storage/providers/types';
@@ -138,6 +138,18 @@ declare function getCollectionKey(key: CollectionKey): string;
  * If the requested key is a collection, it will return an object with all the collection members.
  */
 declare function tryGetCachedValue<TKey extends OnyxKey>(key: TKey): OnyxValue<OnyxKey>;
+/**
+ * Utility function to preserve object references for unchanged items in collection operations.
+ * Compares new values with cached values using deep equality and preserves references when data is identical.
+ * @returns The preserved collection with unchanged references maintained
+ */
+declare function preserveCollectionReferences(keyValuePairs: StorageKeyValuePair[]): OnyxInputKeyValueMapping;
+/**
+ * Utility function for merge operations that preserves references after cache merge has been performed.
+ * Compares merged values with original cached values and preserves references when data is unchanged.
+ * @returns The preserved collection with unchanged references maintained
+ */
+declare function preserveCollectionReferencesAfterMerge(collection: Record<string, OnyxValue<OnyxKey>>, originalCachedValues: Record<string, OnyxValue<OnyxKey>>): Record<string, OnyxValue<OnyxKey>>;
 declare function getCachedCollection<TKey extends CollectionKeyBase>(collectionKey: TKey, collectionMemberKeys?: string[]): NonNullable<OnyxCollection<KeyValueMapping[TKey]>>;
 /**
  * When a collection of keys change, search for any callbacks matching the collection key and trigger those callbacks
@@ -324,6 +336,8 @@ declare const OnyxUtils: {
     updateSnapshots: typeof updateSnapshots;
     mergeCollectionWithPatches: typeof mergeCollectionWithPatches;
     partialSetCollection: typeof partialSetCollection;
+    preserveCollectionReferences: typeof preserveCollectionReferences;
+    preserveCollectionReferencesAfterMerge: typeof preserveCollectionReferencesAfterMerge;
     logKeyChanged: typeof logKeyChanged;
     logKeyRemoved: typeof logKeyRemoved;
 };

package/dist/OnyxUtils.js

@@ -452,6 +452,51 @@ function tryGetCachedValue(key) {
     }
     return val;
 }
+/**
+ * Utility function to preserve object references for unchanged items in collection operations.
+ * Compares new values with cached values using deep equality and preserves references when data is identical.
+ * @returns The preserved collection with unchanged references maintained
+ */
+function preserveCollectionReferences(keyValuePairs) {
+    const preservedCollection = {};
+    keyValuePairs.forEach(([key, value]) => {
+        const cachedValue = OnyxCache_1.default.get(key, false);
+        // If no cached value exists, we need to add the new value (skip expensive deep equality check)
+        // Use deep equality check to preserve references for unchanged items
+        if (cachedValue !== undefined && (0, fast_equals_1.deepEqual)(value, cachedValue)) {
+            // Keep the existing reference
+            preservedCollection[key] = cachedValue;
+        }
+        else {
+            // Update cache only for changed items
+            OnyxCache_1.default.set(key, value);
+            preservedCollection[key] = value;
+        }
+    });
+    return preservedCollection;
+}
+/**
+ * Utility function for merge operations that preserves references after cache merge has been performed.
+ * Compares merged values with original cached values and preserves references when data is unchanged.
+ * @returns The preserved collection with unchanged references maintained
+ */
+function preserveCollectionReferencesAfterMerge(collection, originalCachedValues) {
+    const preservedCollection = {};
+    Object.keys(collection).forEach((key) => {
+        const newMergedValue = OnyxCache_1.default.get(key, false);
+        const originalValue = originalCachedValues[key];
+        // Use deep equality check to preserve references for unchanged items
+        if (originalValue !== undefined && (0, fast_equals_1.deepEqual)(newMergedValue, originalValue)) {
+            // Keep the existing reference and update cache
+            preservedCollection[key] = originalValue;
+            OnyxCache_1.default.set(key, originalValue);
+        }
+        else {
+            preservedCollection[key] = newMergedValue;
+        }
+    });
+    return preservedCollection;
+}
 function getCachedCollection(collectionKey, collectionMemberKeys) {
     // Use optimized collection data retrieval when cache is populated
     const collectionData = OnyxCache_1.default.getCollectionData(collectionKey);
@@ -1094,10 +1139,18 @@ function mergeCollectionWithPatches(collectionKey, collection, mergeReplaceNullP
         // finalMergedCollection contains all the keys that were merged, without the keys of incompatible updates
         const finalMergedCollection = Object.assign(Object.assign({}, existingKeyCollection), newCollection);
         // Prefill cache if necessary by calling get() on any existing keys and then merge original data to cache
-        // and update all subscribers
+        // and update all subscribers with reference preservation for unchanged items
         const promiseUpdate = previousCollectionPromise.then((previousCollection) => {
+            // Capture the original cached values before merging
+            const originalCachedValues = {};
+            Object.keys(finalMergedCollection).forEach((key) => {
+                originalCachedValues[key] = OnyxCache_1.default.get(key, false);
+            });
+            // Then merge all the data into cache as normal
             OnyxCache_1.default.merge(finalMergedCollection);
-            return scheduleNotifyCollectionSubscribers(collectionKey, finalMergedCollection, previousCollection);
+            // Finally, preserve references for items that didn't actually change
+            const preservedCollection = preserveCollectionReferencesAfterMerge(finalMergedCollection, originalCachedValues);
+            return scheduleNotifyCollectionSubscribers(collectionKey, preservedCollection, previousCollection);
         });
         return Promise.all(promises)
             .catch((error) => evictStorageAndRetry(error, mergeCollectionWithPatches, collectionKey, resultCollection))
@@ -1145,8 +1198,9 @@ function partialSetCollection(collectionKey, collection) {
         const existingKeys = resultCollectionKeys.filter((key) => persistedKeys.has(key));
         const previousCollection = getCachedCollection(collectionKey, existingKeys);
         const keyValuePairs = prepareKeyValuePairsForStorage(mutableCollection, true, undefined, true);
-        keyValuePairs.forEach(([key, value]) => OnyxCache_1.default.set(key, value));
-        const updatePromise = scheduleNotifyCollectionSubscribers(collectionKey, mutableCollection, previousCollection);
+        // Preserve references for unchanged items in partialSetCollection
+        const preservedCollection = preserveCollectionReferences(keyValuePairs);
+        const updatePromise = scheduleNotifyCollectionSubscribers(collectionKey, preservedCollection, previousCollection);
         return storage_1.default.multiSet(keyValuePairs)
             .catch((error) => evictStorageAndRetry(error, partialSetCollection, collectionKey, collection))
             .then(() => {
@@ -1223,6 +1277,8 @@ const OnyxUtils = {
     updateSnapshots,
     mergeCollectionWithPatches,
     partialSetCollection,
+    preserveCollectionReferences,
+    preserveCollectionReferencesAfterMerge,
     logKeyChanged,
     logKeyRemoved,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-onyx",
-  "version": "3.0.9",
+  "version": "3.0.10",
   "author": "Expensify, Inc.",
   "homepage": "https://expensify.com",
   "description": "State management for React Native",