react-native-onyx 3.0.66 → 3.0.68

package/dist/OnyxUtils.d.ts

@@ -135,7 +135,7 @@ declare function getCollectionDataAndSendAsObject<TKey extends OnyxKey>(matching
  * Remove a key from Onyx and update the subscribers
  */
 declare function remove<TKey extends OnyxKey>(key: TKey, isProcessingCollectionUpdate?: boolean): Promise<void>;
-declare function reportStorageQuota(): Promise<void>;
+declare function reportStorageQuota(error?: Error): Promise<void>;
 /**
  * Handles storage operation failures based on the error type:
  * - Storage capacity errors: evicts data and retries the operation
@@ -257,6 +257,10 @@ declare function mergeCollectionWithPatches<TKey extends CollectionKeyBase>({ co
 declare function partialSetCollection<TKey extends CollectionKeyBase>({ collectionKey, collection }: SetCollectionParams<TKey>, retryAttempt?: number): Promise<void>;
 declare function logKeyChanged(onyxMethod: Extract<OnyxMethod, 'set' | 'merge'>, key: OnyxKey, value: unknown, hasChanged: boolean): void;
 declare function logKeyRemoved(onyxMethod: Extract<OnyxMethod, 'set' | 'merge'>, key: OnyxKey): void;
+/**
+ * Getter - returns the callback to state mapping, useful in test environments.
+ */
+declare function getCallbackToStateMapping(): Record<number, CallbackToStateMapping<OnyxKey>>;
 /**
  * Clear internal variables used in this file, useful in test environments.
  */
@@ -316,6 +320,7 @@ declare const OnyxUtils: {
     setWithRetry: typeof setWithRetry;
     multiSetWithRetry: typeof multiSetWithRetry;
     setCollectionWithRetry: typeof setCollectionWithRetry;
+    getCallbackToStateMapping: typeof getCallbackToStateMapping;
 };
 export type { OnyxMethod };
 export default OnyxUtils;

package/dist/OnyxUtils.js

@@ -633,13 +633,13 @@ function remove(key, isProcessingCollectionUpdate) {
     }
     return storage_1.default.removeItem(key).then(() => undefined);
 }
-function reportStorageQuota() {
+function reportStorageQuota(error) {
     return storage_1.default.getDatabaseSize()
         .then(({ bytesUsed, bytesRemaining }) => {
-        Logger.logInfo(`Storage Quota Check -- bytesUsed: ${bytesUsed} bytesRemaining: ${bytesRemaining}`);
+        Logger.logInfo(`Storage Quota Check -- bytesUsed: ${bytesUsed} bytesRemaining: ${bytesRemaining}. Original error: ${error}`);
     })
         .catch((dbSizeError) => {
-        Logger.logAlert(`Unable to get database size. Error: ${dbSizeError}`);
+        Logger.logAlert(`Unable to get database size. getDatabaseSize error: ${dbSizeError}. Original error: ${error}`);
     });
 }
 /**
@@ -654,7 +654,7 @@ function retryOperation(error, onyxMethod, defaultParams, retryAttempt) {
     const nextRetryAttempt = currentRetryAttempt + 1;
     Logger.logInfo(`Failed to save to storage. Error: ${error}. onyxMethod: ${onyxMethod.name}. retryAttempt: ${currentRetryAttempt}/${MAX_STORAGE_OPERATION_RETRY_ATTEMPTS}`);
     if (error && Str.startsWith(error.message, "Failed to execute 'put' on 'IDBObjectStore'")) {
-        Logger.logAlert('Attempted to set invalid data set in Onyx. Please ensure all data is serializable.');
+        Logger.logAlert(`Attempted to set invalid data set in Onyx. Please ensure all data is serializable. Error: ${error}`);
         throw error;
     }
     const errorMessage = (_b = (_a = error === null || error === void 0 ? void 0 : error.message) === null || _a === void 0 ? void 0 : _a.toLowerCase) === null || _b === void 0 ? void 0 : _b.call(_a);
@@ -674,12 +674,12 @@ function retryOperation(error, onyxMethod, defaultParams, retryAttempt) {
         // If we have no acceptable keys to remove then we are possibly trying to save mission critical data. If this is the case,
         // then we should stop retrying as there is not much the user can do to fix this. Instead of getting them stuck in an infinite loop we
         // will allow this write to be skipped.
-        Logger.logAlert('Out of storage. But found no acceptable keys to remove.');
-        return reportStorageQuota();
+        Logger.logAlert(`Out of storage. But found no acceptable keys to remove. Error: ${error}`);
+        return reportStorageQuota(error);
     }
     // Remove the least recently accessed key and retry.
-    Logger.logInfo(`Out of storage. Evicting least recently accessed key (${keyForRemoval}) and retrying.`);
-    reportStorageQuota();
+    Logger.logInfo(`Out of storage. Evicting least recently accessed key (${keyForRemoval}) and retrying. Error: ${error}`);
+    reportStorageQuota(error);
     // @ts-expect-error No overload matches this call.
     return remove(keyForRemoval).then(() => onyxMethod(defaultParams, nextRetryAttempt));
 }
@@ -866,6 +866,24 @@ function subscribeToKey(connectOptions) {
     const subscriptionID = lastSubscriptionID++;
     callbackToStateMapping[subscriptionID] = mapping;
     callbackToStateMapping[subscriptionID].subscriptionID = subscriptionID;
+    // If the subscriber is attempting to connect to a collection member whose ID is skippable (e.g. "undefined", "null", etc.)
+    // we suppress wiring the subscription fully to avoid unnecessary callback emissions such as for "report_undefined".
+    // We still return a valid subscriptionID so callers can disconnect safely.
+    try {
+        const skippableIDs = getSkippableCollectionMemberIDs();
+        if (skippableIDs.size) {
+            const [, collectionMemberID] = OnyxKeys_1.default.splitCollectionMemberKey(mapping.key);
+            if (skippableIDs.has(collectionMemberID)) {
+                // Clean up the provisional mapping to avoid retaining unused subscribers.
+                OnyxCache_1.default.addNullishStorageKey(mapping.key);
+                delete callbackToStateMapping[subscriptionID];
+                return subscriptionID;
+            }
+        }
+    }
+    catch (e) {
+        // Not a collection member key, proceed as usual.
+    }
     // When keyChanged is called, a key is passed and the method looks through all the Subscribers in callbackToStateMapping for the matching key to get the subscriptionID
     // to avoid having to loop through all the Subscribers all the time (even when just one connection belongs to one key),
     // We create a mapping from key to lists of subscriptionIDs to access the specific list of subscriptionIDs.
@@ -1374,6 +1392,12 @@ function logKeyChanged(onyxMethod, key, value, hasChanged) {
 function logKeyRemoved(onyxMethod, key) {
     Logger.logInfo(`${onyxMethod} called for key: ${key} => null passed, so key was removed`);
 }
+/**
+ * Getter - returns the callback to state mapping, useful in test environments.
+ */
+function getCallbackToStateMapping() {
+    return callbackToStateMapping;
+}
 /**
  * Clear internal variables used in this file, useful in test environments.
  */
@@ -1432,5 +1456,6 @@ const OnyxUtils = {
     setWithRetry,
     multiSetWithRetry,
     setCollectionWithRetry,
+    getCallbackToStateMapping,
 };
 exports.default = OnyxUtils;

package/package.json

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