react-native-onyx 3.0.51 → 3.0.53

package/dist/Onyx.js

@@ -78,8 +78,13 @@ function init({ keys = {}, initialKeyStates = {}, evictableKeys = [], maxCachedK
         OnyxCache_1.default.setRecentKeysLimit(maxCachedKeysCount);
     }
     OnyxUtils_1.default.initStoreValues(keys, initialKeyStates, evictableKeys);
-    // Initialize all of our keys with data provided then give green light to any pending connections
-    Promise.all([OnyxCache_1.default.addEvictableKeysToRecentlyAccessedList(OnyxUtils_1.default.isCollectionKey, OnyxUtils_1.default.getAllKeys), OnyxUtils_1.default.initializeWithDefaultKeyStates()]).then(OnyxUtils_1.default.getDeferredInitTask().resolve);
+    // Initialize all of our keys with data provided then give green light to any pending connections.
+    // addEvictableKeysToRecentlyAccessedList must run after initializeWithDefaultKeyStates because
+    // eager cache loading populates the key index (cache.setAllKeys) inside initializeWithDefaultKeyStates,
+    // and the evictable keys list depends on that index being populated.
+    OnyxUtils_1.default.initializeWithDefaultKeyStates()
+        .then(() => OnyxCache_1.default.addEvictableKeysToRecentlyAccessedList(OnyxUtils_1.default.isCollectionKey, OnyxUtils_1.default.getAllKeys))
+        .then(OnyxUtils_1.default.getDeferredInitTask().resolve);
 }
 /**
  * Connects to an Onyx key given the options passed and listens to its changes.

package/dist/OnyxUtils.js

@@ -91,7 +91,9 @@ let snapshotKey = null;
 let lastSubscriptionID = 0;
 // Connections can be made before `Onyx.init`. They would wait for this task before resolving
 const deferredInitTask = (0, createDeferredTask_1.default)();
-// Holds a set of collection member IDs which updates will be ignored when using Onyx methods.
+// Collection member IDs that Onyx should silently ignore across all operations — reads, writes, cache, and subscriber
+// notifications. This is used to filter out keys formed from invalid/default IDs (e.g. "-1", "0",
+// "undefined", "null", "NaN") that can appear when an ID variable is accidentally coerced to string.
 let skippableCollectionMemberIDs = new Set();
 // Holds a set of keys that should always be merged into snapshot entries.
 let snapshotMergeKeys = new Set();
@@ -906,17 +908,65 @@ function mergeInternal(mode, changes, existingValue) {
  * Merge user provided default key value pairs.
  */
 function initializeWithDefaultKeyStates() {
-    // Filter out RAM-only keys from storage reads as they may have stale persisted data
-    // from before the key was migrated to RAM-only.
-    const keysToFetch = Object.keys(defaultKeyStates).filter((key) => !isRamOnlyKey(key));
-    return storage_1.default.multiGet(keysToFetch).then((pairs) => {
-        const existingDataAsObject = Object.fromEntries(pairs);
-        const merged = utils_1.default.fastMerge(existingDataAsObject, defaultKeyStates, {
+    // Eagerly load the entire database into cache in a single batch read.
+    // This is faster than lazy-loading individual keys because:
+    // 1. One DB transaction instead of hundreds
+    // 2. All subsequent reads are synchronous cache hits
+    return storage_1.default.getAll()
+        .then((pairs) => {
+        const allDataFromStorage = {};
+        for (const [key, value] of pairs) {
+            // RAM-only keys should not be cached from storage as they may have stale persisted data
+            // from before the key was migrated to RAM-only.
+            if (isRamOnlyKey(key)) {
+                continue;
+            }
+            // Skip collection members that are marked as skippable
+            if (skippableCollectionMemberIDs.size && getCollectionKey(key)) {
+                const [, collectionMemberID] = splitCollectionMemberKey(key);
+                if (skippableCollectionMemberIDs.has(collectionMemberID)) {
+                    continue;
+                }
+            }
+            allDataFromStorage[key] = value;
+        }
+        // Load all storage data into cache silently (no subscriber notifications)
+        OnyxCache_1.default.setAllKeys(Object.keys(allDataFromStorage));
+        OnyxCache_1.default.merge(allDataFromStorage);
+        // For keys that have a developer-defined default (via `initialKeyStates`), merge the
+        // persisted value with the default so new properties added in code updates are applied
+        // without wiping user data that already exists in storage.
+        const defaultKeysFromStorage = Object.keys(defaultKeyStates).reduce((obj, key) => {
+            if (key in allDataFromStorage) {
+                // eslint-disable-next-line no-param-reassign
+                obj[key] = allDataFromStorage[key];
+            }
+            return obj;
+        }, {});
+        const merged = utils_1.default.fastMerge(defaultKeysFromStorage, defaultKeyStates, {
             shouldRemoveNestedNulls: true,
         }).result;
         OnyxCache_1.default.merge(merged !== null && merged !== void 0 ? merged : {});
-        for (const [key, value] of Object.entries(merged !== null && merged !== void 0 ? merged : {}))
+        // Notify subscribers about default key states so that any subscriber that connected
+        // before init (e.g. during module load) receives the merged default values immediately
+        for (const [key, value] of Object.entries(merged !== null && merged !== void 0 ? merged : {})) {
             keyChanged(key, value);
+        }
+    })
+        .catch((error) => {
+        Logger.logAlert(`Failed to load data from storage during init. The app will boot with default key states only. Error: ${error}`);
+        // Populate the key index so getAllKeys() returns correct results for default keys.
+        // Without this, subscribers that check getAllKeys() would see an empty set even
+        // though we have default values in cache.
+        OnyxCache_1.default.setAllKeys(Object.keys(defaultKeyStates));
+        // Boot with defaults so the app renders instead of deadlocking.
+        // Users will get a fresh-install experience but the app won't be bricked.
+        OnyxCache_1.default.merge(defaultKeyStates);
+        // Notify subscribers about default key states so that any subscriber that connected
+        // before init (e.g. during module load) receives the merged default values immediately
+        for (const [key, value] of Object.entries(defaultKeyStates)) {
+            keyChanged(key, value);
+        }
     });
 }
 /**
@@ -1041,7 +1091,7 @@ function unsubscribeFromKey(subscriptionID) {
     if (!callbackToStateMapping[subscriptionID]) {
         return;
     }
-    deleteKeyBySubscriptions(lastSubscriptionID);
+    deleteKeyBySubscriptions(subscriptionID);
     delete callbackToStateMapping[subscriptionID];
 }
 function updateSnapshots(data, mergeFn) {

package/dist/storage/__mocks__/index.d.ts

@@ -10,6 +10,7 @@ declare const StorageMock: {
     removeItems: jest.Mock<Promise<void>, [keys: import("../providers/types").StorageKeyList], any>;
     clear: jest.Mock<Promise<void>, [], any>;
     getAllKeys: jest.Mock<Promise<import("../providers/types").StorageKeyList>, [], any>;
+    getAll: jest.Mock<Promise<import("../providers/types").StorageKeyValuePair[]>, [], any>;
     getDatabaseSize: jest.Mock<Promise<{
         bytesUsed: number;
         bytesRemaining: number;

package/dist/storage/__mocks__/index.js

@@ -48,6 +48,7 @@ const StorageMock = {
     removeItems: jest.fn(MemoryOnlyProvider_1.default.removeItems),
     clear: jest.fn(MemoryOnlyProvider_1.default.clear),
     getAllKeys: jest.fn(MemoryOnlyProvider_1.default.getAllKeys),
+    getAll: jest.fn(MemoryOnlyProvider_1.default.getAll),
     getDatabaseSize: jest.fn(MemoryOnlyProvider_1.default.getDatabaseSize),
     keepInstancesSync: jest.fn(),
     getMockStore: jest.fn(() => MemoryOnlyProvider_1.mockStore),

package/dist/storage/index.js

@@ -181,6 +181,10 @@ const storage = {
      * Returns all available keys
      */
     getAllKeys: () => tryOrDegradePerformance(() => provider.getAllKeys()),
+    /**
+     * Returns all key-value pairs from storage in a single batch operation
+     */
+    getAll: () => tryOrDegradePerformance(() => provider.getAll()),
     /**
      * Gets the total bytes of the store
      */
@@ -211,5 +215,6 @@ GlobalSettings.addGlobalSettingsChangeListener(({ enablePerformanceMetrics }) =>
     storage.removeItems = (0, metrics_1.default)(storage.removeItems, 'Storage.removeItems');
     storage.clear = (0, metrics_1.default)(storage.clear, 'Storage.clear');
     storage.getAllKeys = (0, metrics_1.default)(storage.getAllKeys, 'Storage.getAllKeys');
+    storage.getAll = (0, metrics_1.default)(storage.getAll, 'Storage.getAll');
 });
 exports.default = storage;

package/dist/storage/providers/IDBKeyValProvider/index.js

@@ -131,6 +131,12 @@ const provider = {
         }
         return IDB.keys(provider.store);
     },
+    getAll() {
+        if (!provider.store) {
+            throw new Error('Store not initialized!');
+        }
+        return IDB.entries(provider.store);
+    },
     getItem(key) {
         if (!provider.store) {
             throw new Error('Store not initialized!');

package/dist/storage/providers/MemoryOnlyProvider.js

@@ -111,6 +111,12 @@ const provider = {
     getAllKeys() {
         return Promise.resolve(underscore_1.default.keys(provider.store));
     },
+    /**
+     * Returns all key-value pairs from memory
+     */
+    getAll() {
+        return Promise.resolve(Object.entries(provider.store));
+    },
     /**
      * Gets the total bytes of the store.
      * `bytesRemaining` will always be `Number.POSITIVE_INFINITY` since we don't have a hard limit on memory.

package/dist/storage/providers/NoopProvider.js

@@ -73,6 +73,12 @@ const provider = {
     getAllKeys() {
         return Promise.resolve([]);
     },
+    /**
+     * Returns all key-value pairs from storage
+     */
+    getAll() {
+        return Promise.resolve([]);
+    },
     /**
      * Gets the total bytes of the store.
      * `bytesRemaining` will always be `Number.POSITIVE_INFINITY` since we don't have a hard limit on memory.

package/dist/storage/providers/SQLiteProvider.js

@@ -147,6 +147,16 @@ const provider = {
             return (result !== null && result !== void 0 ? result : []);
         });
     },
+    getAll() {
+        if (!provider.store) {
+            throw new Error('Store is not initialized!');
+        }
+        return provider.store.executeAsync('SELECT record_key, valueJSON FROM keyvaluepairs;').then(({ rows }) => {
+            // eslint-disable-next-line no-underscore-dangle
+            const result = rows === null || rows === void 0 ? void 0 : rows._array.map((row) => [row.record_key, JSON.parse(row.valueJSON)]);
+            return (result !== null && result !== void 0 ? result : []);
+        });
+    },
     removeItem(key) {
         if (!provider.store) {
             throw new Error('Store is not initialized!');

package/dist/storage/providers/types.d.ts

@@ -46,6 +46,11 @@ type StorageProvider<TStore> = {
      * Returns all keys available in storage
      */
     getAllKeys: () => Promise<StorageKeyList>;
+    /**
+     * Returns all key-value pairs from storage in a single batch operation.
+     * More efficient than getAllKeys + multiGet for loading the entire database.
+     */
+    getAll: () => Promise<StorageKeyValuePair[]>;
     /**
      * Removes given key and its value from storage
      */

package/dist/types.d.ts

@@ -360,8 +360,9 @@ type InitOptions = {
      */
     enableDevTools?: boolean;
     /**
-     * Array of collection member IDs which updates will be ignored when using Onyx methods.
-     * Additionally, any subscribers from these keys to won't receive any data from Onyx.
+     * Array of collection member IDs that Onyx should silently ignore across all operations.
+     * This prevents keys formed from invalid or default IDs (e.g. "-1", "0", "undefined") from
+     * polluting cache or triggering subscriber notifications.
      */
     skippableCollectionMemberIDs?: string[];
     /**

package/package.json

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