react-native-onyx 3.0.48 → 3.0.49

package/dist/Onyx.js

@@ -221,7 +221,13 @@ function merge(key, changes) {
             }
             try {
                 const validChanges = mergeQueue[key].filter((change) => {
-                    const { isCompatible, existingValueType, newValueType } = utils_1.default.checkCompatibilityWithExistingValue(change, existingValue);
+                    const { isCompatible, existingValueType, newValueType, isEmptyArrayCoercion } = utils_1.default.checkCompatibilityWithExistingValue(change, existingValue);
+                    if (isEmptyArrayCoercion) {
+                        // Merging an object into an empty array isn't semantically correct, but we allow it
+                        // in case we accidentally encoded an empty object as an empty array in PHP. If you're
+                        // looking at a bugbot from this message, we're probably missing that key in OnyxKeys::KEYS_REQUIRING_EMPTY_OBJECT
+                        Logger.logAlert(`[ENSURE_BUGBOT] Onyx merge called on key "${key}" whose existing value is an empty array. Will coerce to object.`);
+                    }
                     if (!isCompatible) {
                         Logger.logAlert(logMessages_1.default.incompatibleUpdateAlert(key, 'merge', existingValueType, newValueType));
                     }

package/dist/OnyxUtils.js

@@ -1111,7 +1111,13 @@ function setWithRetry({ key, value, options }, retryAttempt) {
         return Promise.resolve();
     }
     // Check if the value is compatible with the existing value in the storage
-    const { isCompatible, existingValueType, newValueType } = utils_1.default.checkCompatibilityWithExistingValue(value, existingValue);
+    const { isCompatible, existingValueType, newValueType, isEmptyArrayCoercion } = utils_1.default.checkCompatibilityWithExistingValue(value, existingValue);
+    if (isEmptyArrayCoercion) {
+        // Setting an object over empty array isn't semantically correct, but we allow it
+        // in case we accidentally encoded an empty object as an empty array in PHP. If you're
+        // looking at a bugbot from this message, we're probably missing that key in OnyxKeys::KEYS_REQUIRING_EMPTY_OBJECT
+        Logger.logAlert(`[ENSURE_BUGBOT] Onyx setWithRetry called on key "${key}" whose existing value is an empty array. Will coerce to object.`);
+    }
     if (!isCompatible) {
         Logger.logAlert(logMessages_1.default.incompatibleUpdateAlert(key, 'set', existingValueType, newValueType));
         return Promise.resolve();
@@ -1309,7 +1315,13 @@ function mergeCollectionWithPatches({ collectionKey, collection, mergeReplaceNul
         const existingKeys = keys.filter((key) => persistedKeys.has(key));
         const cachedCollectionForExistingKeys = getCachedCollection(collectionKey, existingKeys);
         const existingKeyCollection = existingKeys.reduce((obj, key) => {
-            const { isCompatible, existingValueType, newValueType } = utils_1.default.checkCompatibilityWithExistingValue(resultCollection[key], cachedCollectionForExistingKeys[key]);
+            const { isCompatible, existingValueType, newValueType, isEmptyArrayCoercion } = utils_1.default.checkCompatibilityWithExistingValue(resultCollection[key], cachedCollectionForExistingKeys[key]);
+            if (isEmptyArrayCoercion) {
+                // Merging an object into an empty array isn't semantically correct, but we allow it
+                // in case we accidentally encoded an empty object as an empty array in PHP. If you're
+                // looking at a bugbot from this message, we're probably missing that key in OnyxKeys::KEYS_REQUIRING_EMPTY_OBJECT
+                Logger.logAlert(`[ENSURE_BUGBOT] Onyx mergeCollection called on key "${key}" whose existing value is an empty array. Will coerce to object.`);
+            }
             if (!isCompatible) {
                 Logger.logAlert(logMessages_1.default.incompatibleUpdateAlert(key, 'mergeCollection', existingValueType, newValueType));
                 return obj;

package/dist/utils.d.ts

@@ -46,6 +46,7 @@ declare function checkCompatibilityWithExistingValue(value: unknown, existingVal
     isCompatible: boolean;
     existingValueType?: string;
     newValueType?: string;
+    isEmptyArrayCoercion?: boolean;
 };
 /**
  * Picks entries from an object based on a condition.

package/dist/utils.js

@@ -142,6 +142,16 @@ function checkCompatibilityWithExistingValue(value, existingValue) {
             isCompatible: true,
         };
     }
+    // PHP's associative arrays cannot distinguish between an empty list and an
+    // empty object, so it encodes both as []. A key that should hold an
+    // object may arrive from the server as [] and be stored that way. If
+    // we then try to MERGE an object into that key, the array-vs-object type check
+    // would normally block it. Since an empty array carries no data worth
+    // preserving, we treat it as compatible with an object update and coerce it.
+    const isObjectValue = typeof value === 'object' && !Array.isArray(value);
+    if (Array.isArray(existingValue) && existingValue.length === 0 && isObjectValue) {
+        return { isCompatible: true, isEmptyArrayCoercion: true };
+    }
     const existingValueType = Array.isArray(existingValue) ? 'array' : 'non-array';
     const newValueType = Array.isArray(value) ? 'array' : 'non-array';
     if (existingValueType !== newValueType) {

package/package.json

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