Merge remote-tracking branch 'origin/main' into feature/reassure-phase-2

Author: fabioh8010

.nvmrc

@@ -1 +1 @@
-20.18.1
+20.19.1

lib/Onyx.ts

@@ -238,6 +238,11 @@ function multiSet(data: OnyxMultiSetInput): Promise<void> {
 
     const updatePromises = keyValuePairsToSet.map(([key, value]) => {
         const prevValue = cache.get(key, false);
+        // When we use multiSet to set a key we want to clear the current delta changes from Onyx.merge that were queued
+        // before the value was set. If Onyx.merge is currently reading the old value from storage, it will then not apply the changes.
+        if (OnyxUtils.hasPendingMergeForKey(key)) {
+            delete OnyxUtils.getMergeQueue()[key];
+        }
 
         // Update cache and optimistically inform subscribers on the next tick
         cache.set(key, value);

lib/OnyxUtils.ts

@@ -2,7 +2,6 @@
 import {deepEqual} from 'fast-equals';
 import lodashClone from 'lodash/clone';
 import type {ValueOf} from 'type-fest';
-import lodashPick from 'lodash/pick';
 import DevTools from './DevTools';
 import * as Logger from './Logger';
 import type Onyx from './Onyx';
@@ -1417,9 +1416,8 @@ function updateSnapshots(data: OnyxUpdate[], mergeFn: typeof Onyx.merge): Array<
             }
 
             const oldValue = updatedData[key] || {};
-            const newValue = lodashPick(value, Object.keys(snapshotData[key]));
 
-            updatedData = {...updatedData, [key]: Object.assign(oldValue, newValue)};
+            updatedData = {...updatedData, [key]: Object.assign(oldValue, value)};
         });
 
         // Skip the update if there's no data to be merged

lib/useOnyx.ts

@@ -300,7 +300,7 @@ function useOnyx<TKey extends OnyxKey, TReturnValue = OnyxValue<TKey>>(
             // we log an alert so it can be acknowledged by the consumer. Additionally, we won't log alerts
             // if there's a `Onyx.clear()` task in progress.
             if (options?.canBeMissing === false && newStatus === 'loaded' && !isOnyxValueDefined && !OnyxCache.hasPendingTask(TASK.CLEAR)) {
-                Logger.logAlert(`useOnyx returned no data for key with canBeMissing set to false.`, {key, showAlert: true});
+                Logger.logAlert(`useOnyx returned no data for key with canBeMissing set to false for key ${key}`, {showAlert: true});
             }
         }
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-onyx",
-  "version": "2.0.105",
+  "version": "2.0.109",
   "author": "Expensify, Inc.",
   "homepage": "https://expensify.com",
   "description": "State management for React Native",
@@ -126,7 +126,7 @@
     }
   },
   "engines": {
-    "node": ">=20.18.1",
+    "node": ">=20.19.1",
     "npm": ">=10.8.2"
   },
   "sideEffects": false

package.json

@@ -1448,7 +1448,7 @@ describe('Onyx', () => {
         const snapshot1 = `${ONYX_KEYS.COLLECTION.SNAPSHOT}1`;
 
         const initialValue = {name: 'Fluffy'};
-        const finalValue = {name: 'Kitty'};
+        const finalValue = {name: 'Kitty', nickName: 'Fitse'};
 
         await Onyx.set(cat, initialValue);
         await Onyx.set(snapshot1, {data: {[cat]: initialValue}});
@@ -2029,5 +2029,25 @@ describe('Onyx', () => {
                 [`${ONYX_KEYS.COLLECTION.TEST_KEY}entry2`]: {id: 'entry2_id', name: 'entry2_name'},
             });
         });
+        it('should clear pending merge for a key during multiSet()', async () => {
+            const testKey = `${ONYX_KEYS.COLLECTION.TEST_KEY}entry1`;
+
+            // Mock the merge queue with the correct type
+            const mockMergeQueue: Record<string, unknown[]> = {
+                [testKey]: [{some: 'mergeData'}],
+            };
+
+            // Mock the utility functions
+            jest.spyOn(OnyxUtils, 'hasPendingMergeForKey').mockImplementation((key) => key === testKey);
+            jest.spyOn(OnyxUtils, 'getMergeQueue').mockImplementation(() => mockMergeQueue);
+
+            await Onyx.multiSet({
+                [testKey]: {id: 'entry1_id', name: 'entry1_name'},
+            });
+
+            expect(mockMergeQueue[testKey]).toBeUndefined();
+
+            jest.restoreAllMocks();
+        });
     });
 });

tests/unit/onyxTest.ts

@@ -752,7 +752,7 @@ describe('useOnyx', () => {
 
     describe('canBeMissing', () => {
         let logAlertFn = jest.fn();
-        const alertMessage = 'useOnyx returned no data for key with canBeMissing set to false.';
+        const alertMessage = 'useOnyx returned no data for key with canBeMissing set to false for key test';
 
         beforeEach(() => {
             logAlertFn = jest.fn();
@@ -806,7 +806,7 @@ describe('useOnyx', () => {
             expect(result1.current[0]).toBeUndefined();
             expect(result1.current[1].status).toEqual('loaded');
             expect(logAlertFn).toHaveBeenCalledTimes(1);
-            expect(logAlertFn).toHaveBeenNthCalledWith(1, alertMessage, {key: ONYXKEYS.TEST_KEY, showAlert: true});
+            expect(logAlertFn).toHaveBeenNthCalledWith(1, alertMessage, {showAlert: true});
 
             await act(async () => Onyx.set(ONYXKEYS.TEST_KEY, 'test'));
 
@@ -816,7 +816,7 @@ describe('useOnyx', () => {
 
             expect(result1.current[0]).toBeUndefined();
             expect(logAlertFn).toHaveBeenCalledTimes(2);
-            expect(logAlertFn).toHaveBeenNthCalledWith(2, alertMessage, {key: ONYXKEYS.TEST_KEY, showAlert: true});
+            expect(logAlertFn).toHaveBeenNthCalledWith(2, alertMessage, {showAlert: true});
         });
 
         it('should log an alert if Onyx doesn\'t return selected data in loaded state and "canBeMissing" property is false', async () => {
@@ -837,7 +837,7 @@ describe('useOnyx', () => {
             expect(result1.current[0]).toBeUndefined();
             expect(result1.current[1].status).toEqual('loaded');
             expect(logAlertFn).toHaveBeenCalledTimes(1);
-            expect(logAlertFn).toHaveBeenNthCalledWith(1, alertMessage, {key: ONYXKEYS.TEST_KEY, showAlert: true});
+            expect(logAlertFn).toHaveBeenNthCalledWith(1, alertMessage, {showAlert: true});
 
             await act(async () => Onyx.set(ONYXKEYS.TEST_KEY, 'test'));
 
@@ -847,7 +847,7 @@ describe('useOnyx', () => {
 
             expect(result1.current[0]).toBeUndefined();
             expect(logAlertFn).toHaveBeenCalledTimes(2);
-            expect(logAlertFn).toHaveBeenNthCalledWith(2, alertMessage, {key: ONYXKEYS.TEST_KEY, showAlert: true});
+            expect(logAlertFn).toHaveBeenNthCalledWith(2, alertMessage, {showAlert: true});
         });
 
         it('should log an alert if Onyx doesn\'t return data but there is a selector that always return something and "canBeMissing" property is false', async () => {
@@ -865,7 +865,7 @@ describe('useOnyx', () => {
             expect(result1.current[0]).toBe('undefined_changed');
             expect(result1.current[1].status).toEqual('loaded');
             expect(logAlertFn).toHaveBeenCalledTimes(1);
-            expect(logAlertFn).toHaveBeenNthCalledWith(1, alertMessage, {key: ONYXKEYS.TEST_KEY, showAlert: true});
+            expect(logAlertFn).toHaveBeenNthCalledWith(1, alertMessage, {showAlert: true});
 
             await act(async () => Onyx.set(ONYXKEYS.TEST_KEY, 'test'));
 
@@ -875,7 +875,7 @@ describe('useOnyx', () => {
 
             expect(result1.current[0]).toBe('undefined_changed');
             expect(logAlertFn).toHaveBeenCalledTimes(2);
-            expect(logAlertFn).toHaveBeenNthCalledWith(2, alertMessage, {key: ONYXKEYS.TEST_KEY, showAlert: true});
+            expect(logAlertFn).toHaveBeenNthCalledWith(2, alertMessage, {showAlert: true});
         });
 
         it('should not log an alert if "canBeMissing" property is false but there is a Onyx.clear() task in progress', async () => {
@@ -890,7 +890,7 @@ describe('useOnyx', () => {
             expect(result1.current[0]).toBeUndefined();
             expect(result1.current[1].status).toEqual('loaded');
             expect(logAlertFn).toHaveBeenCalledTimes(1);
-            expect(logAlertFn).toHaveBeenNthCalledWith(1, alertMessage, {key: ONYXKEYS.TEST_KEY, showAlert: true});
+            expect(logAlertFn).toHaveBeenNthCalledWith(1, alertMessage, {showAlert: true});
 
             await act(async () => Onyx.set(ONYXKEYS.TEST_KEY, 'test'));