react-native-onyx 2.0.20 → 2.0.22

package/API.md

@@ -94,9 +94,6 @@ value will be saved to storage after the default value.</p>
 <dt><a href="#update">update(data)</a> ⇒ <code>Promise</code></dt>
 <dd><p>Insert API responses and lifecycle data into Onyx</p>
 </dd>
-<dt><a href="#setMemoryOnlyKeys">setMemoryOnlyKeys(keyList)</a></dt>
-<dd><p>When set these keys will not be persisted to storage</p>
-</dd>
 <dt><a href="#init">init([options])</a></dt>
 <dd><p>Initialize the store with actions and listening for storage events</p>
 </dd>
@@ -424,17 +421,6 @@ Insert API responses and lifecycle data into Onyx
 | --- | --- | --- |
 | data | <code>Array</code> | An array of objects with shape {onyxMethod: oneOf('set', 'merge', 'mergeCollection', 'multiSet', 'clear'), key: string, value: *} |
 
-<a name="setMemoryOnlyKeys"></a>
-
-## setMemoryOnlyKeys(keyList)
-When set these keys will not be persisted to storage
-
-**Kind**: global function  
-
-| Param | Type |
-| --- | --- |
-| keyList | <code>Array.&lt;string&gt;</code> | 
-
 <a name="init"></a>
 
 ## init([options])

package/dist/Onyx.d.ts

@@ -304,11 +304,6 @@ declare function init(config?: InitOptions): void;
  */
 declare function hasPendingMergeForKey(key: OnyxKey): boolean;
 
-/**
- * When set these keys will not be persisted to storage
- */
-declare function setMemoryOnlyKeys(keyList: OnyxKey[]): void;
-
 /**
  * Tries to get a value from the cache. If the value is not present in cache it will return the default value or undefined.
  * If the requested key is a collection, it will return an object with all the collection members.
@@ -335,7 +330,6 @@ declare const Onyx: {
     removeFromEvictionBlockList: typeof removeFromEvictionBlockList;
     isSafeEvictionKey: typeof isSafeEvictionKey;
     METHOD: typeof METHOD;
-    setMemoryOnlyKeys: typeof setMemoryOnlyKeys;
     tryGetCachedValue: typeof tryGetCachedValue;
     isCollectionKey: typeof isCollectionKey;
     isCollectionMemberKey: typeof isCollectionMemberKey;

package/dist/Onyx.js

@@ -165,12 +165,12 @@ function get(key) {
 /**
  * Returns current key names stored in persisted storage
  * @private
- * @returns {Promise<string[]>}
+ * @returns {Promise<Set<Key>>}
  */
 function getAllKeys() {
     // When we've already read stored keys, resolve right away
     const storedKeys = OnyxCache_1.default.getAllKeys();
-    if (storedKeys.length > 0) {
+    if (storedKeys.size > 0) {
         return Promise.resolve(storedKeys);
     }
     const taskName = 'getAllKeys';
@@ -181,7 +181,8 @@ function getAllKeys() {
     // Otherwise retrieve the keys from storage and capture a promise to aid concurrent usages
     const promise = storage_1.default.getAllKeys().then((keys) => {
         OnyxCache_1.default.setAllKeys(keys);
-        return keys;
+        // return the updated set of keys
+        return OnyxCache_1.default.getAllKeys();
     });
     return OnyxCache_1.default.captureTask(taskName, promise);
 }
@@ -252,10 +253,16 @@ function tryGetCachedValue(key, mapping = {}) {
         const allCacheKeys = OnyxCache_1.default.getAllKeys();
         // It is possible we haven't loaded all keys yet so we do not know if the
         // collection actually exists.
-        if (allCacheKeys.length === 0) {
+        if (allCacheKeys.size === 0) {
             return;
         }
-        const matchingKeys = underscore_1.default.filter(allCacheKeys, (k) => k.startsWith(key));
+        const matchingKeys = [];
+        allCacheKeys.forEach((k) => {
+            if (!k.startsWith(key)) {
+                return;
+            }
+            matchingKeys.push(k);
+        });
         const values = underscore_1.default.reduce(matchingKeys, (finalObject, matchedKey) => {
             const cachedValue = OnyxCache_1.default.getValue(matchedKey);
             if (cachedValue) {
@@ -342,7 +349,7 @@ function addToEvictionBlockList(key, connectionID) {
 function addAllSafeEvictionKeysToRecentlyAccessedList() {
     return getAllKeys().then((keys) => {
         underscore_1.default.each(evictionAllowList, (safeEvictionKey) => {
-            underscore_1.default.each(keys, (key) => {
+            keys.forEach((key) => {
                 if (!isKeyMatch(safeEvictionKey, key)) {
                     return;
                 }
@@ -357,7 +364,13 @@ function addAllSafeEvictionKeysToRecentlyAccessedList() {
  * @returns {Object}
  */
 function getCachedCollection(collectionKey) {
-    const collectionMemberKeys = underscore_1.default.filter(OnyxCache_1.default.getAllKeys(), (storedKey) => isCollectionMemberKey(collectionKey, storedKey));
+    const collectionMemberKeys = [];
+    OnyxCache_1.default.getAllKeys().forEach((storedKey) => {
+        if (!isCollectionMemberKey(collectionKey, storedKey)) {
+            return;
+        }
+        collectionMemberKeys.push(storedKey);
+    });
     return underscore_1.default.reduce(collectionMemberKeys, (prev, curr) => {
         const cachedValue = OnyxCache_1.default.getValue(curr);
         if (!cachedValue) {
@@ -821,7 +834,13 @@ function connect(mapping) {
         // We search all the keys in storage to see if any are a "match" for the subscriber we are connecting so that we
         // can send data back to the subscriber. Note that multiple keys can match as a subscriber could either be
         // subscribed to a "collection key" or a single key.
-        const matchingKeys = underscore_1.default.filter(keys, (key) => isKeyMatch(mapping.key, key));
+        const matchingKeys = [];
+        keys.forEach((key) => {
+            if (!isKeyMatch(mapping.key, key)) {
+                return;
+            }
+            matchingKeys.push(key);
+        });
         // If the key being connected to does not exist we initialize the value with null. For subscribers that connected
         // directly via connect() they will simply get a null value sent to them without any information about which key matched
         // since there are none matched. In withOnyx() we wait for all connected keys to return a value before rendering the child
@@ -1241,7 +1260,7 @@ function clear(keysToPreserve = []) {
         //      status, or activeClients need to remain in Onyx even when signed out)
         // 2. Any keys with a default state (because they need to remain in Onyx as their default, and setting them
         //      to null would cause unknown behavior)
-        underscore_1.default.each(keys, (key) => {
+        keys.forEach((key) => {
             const isKeyToPreserve = underscore_1.default.contains(keysToPreserve, key);
             const isDefaultKey = underscore_1.default.has(defaultKeyStates, key);
             // If the key is being removed or reset to default:
@@ -1336,7 +1355,7 @@ function mergeCollection(collectionKey, collection) {
             return true;
         })
             .keys()
-            .partition((key) => persistedKeys.includes(key))
+            .partition((key) => persistedKeys.has(key))
             .value();
         const existingKeyCollection = underscore_1.default.pick(collection, existingKeys);
         const newCollection = underscore_1.default.pick(collection, newKeys);
@@ -1412,15 +1431,6 @@ function update(data) {
     });
     return clearPromise.then(() => Promise.all(underscore_1.default.map(promises, (p) => p())));
 }
-/**
- * When set these keys will not be persisted to storage
- * @param {string[]} keyList
- */
-function setMemoryOnlyKeys(keyList) {
-    storage_1.default.setMemoryOnlyKeys(keyList);
-    // When in memory only mode for certain keys we do not want to ever drop items from the cache as the user will have no way to recover them again via storage.
-    OnyxCache_1.default.setRecentKeysLimit(Infinity);
-}
 /**
  * Initialize the store with actions and listening for storage events
  *
@@ -1491,7 +1501,6 @@ const Onyx = {
     removeFromEvictionBlockList,
     isSafeEvictionKey,
     METHOD,
-    setMemoryOnlyKeys,
     tryGetCachedValue,
     hasPendingMergeForKey,
     isCollectionKey,

package/dist/OnyxCache.d.ts

@@ -20,7 +20,7 @@ declare class OnyxCache {
     private maxRecentKeysSize;
     constructor();
     /** Get all the storage keys */
-    getAllKeys(): Key[];
+    getAllKeys(): Set<Key>;
     /**
      * Get a cached value from storage
      * @param [shouldReindexCache] – This is an LRU cache, and by default accessing a value will make it become last in line to be evicted. This flag can be used to skip that and just access the value directly without side-effects.

package/dist/OnyxCache.js

@@ -23,7 +23,7 @@ class OnyxCache {
     }
     /** Get all the storage keys */
     getAllKeys() {
-        return Array.from(this.storageKeys);
+        return this.storageKeys;
     }
     /**
      * Get a cached value from storage

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

@@ -18,6 +18,5 @@ declare const idbKeyvalMockSpy: {
         bytesUsed: number;
         bytesRemaining: number;
     }>, []>;
-    setMemoryOnlyKeys: jest.Mock<void, []>;
 };
 export default idbKeyvalMockSpy;

package/dist/storage/__mocks__/index.js

@@ -60,8 +60,6 @@ const idbKeyvalMock = {
     getDatabaseSize() {
         return Promise.resolve({ bytesRemaining: 0, bytesUsed: 99999 });
     },
-    // eslint-disable-next-line @typescript-eslint/no-empty-function
-    setMemoryOnlyKeys() { },
 };
 const idbKeyvalMockSpy = {
     idbKeyvalSet: set,
@@ -80,6 +78,5 @@ const idbKeyvalMockSpy = {
         storageMapInternal = data;
     }),
     getDatabaseSize: jest.fn(idbKeyvalMock.getDatabaseSize),
-    setMemoryOnlyKeys: jest.fn(idbKeyvalMock.setMemoryOnlyKeys),
 };
 exports.default = idbKeyvalMockSpy;

package/dist/storage/providers/IDBKeyVal.js

@@ -37,8 +37,6 @@ const provider = {
     },
     multiSet: (pairs) => (0, idb_keyval_1.setMany)(pairs, getCustomStore()),
     clear: () => (0, idb_keyval_1.clear)(getCustomStore()),
-    // eslint-disable-next-line @typescript-eslint/no-empty-function
-    setMemoryOnlyKeys: () => { },
     getAllKeys: () => (0, idb_keyval_1.keys)(getCustomStore()),
     getItem: (key) => (0, idb_keyval_1.get)(key, getCustomStore())
         // idb-keyval returns undefined for missing items, but this needs to return null so that idb-keyval does the same thing as SQLiteStorage.

package/dist/storage/providers/SQLiteStorage.js

@@ -85,8 +85,6 @@ const provider = {
         });
     },
     // eslint-disable-next-line @typescript-eslint/no-empty-function
-    setMemoryOnlyKeys: () => { },
-    // eslint-disable-next-line @typescript-eslint/no-empty-function
     keepInstancesSync: () => { },
 };
 exports.default = provider;

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

@@ -48,10 +48,6 @@ type StorageProvider = {
      * Clears absolutely everything from storage
      */
     clear: () => Promise<QueryResult | void>;
-    /**
-     * Sets memory only keys
-     */
-    setMemoryOnlyKeys: () => void;
     /**
      * Gets the total bytes of the database file
      */

package/package.json

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