Adjust tests to the batching updates feature

jest.config.js

@@ -23,6 +23,6 @@ module.exports = {
     },
     testEnvironment: 'jsdom',
     setupFiles: ['<rootDir>/jest/setup.js', './node_modules/@react-native-google-signin/google-signin/jest/build/setup.js'],
-    setupFilesAfterEnv: ['@testing-library/jest-native/extend-expect'],
+    setupFilesAfterEnv: ['@testing-library/jest-native/extend-expect', '<rootDir>/jest/setupAfterEnv.js'],
     cacheDirectory: '<rootDir>/.jest-cache',
 };

jest/setupAfterEnv.js

@@ -0,0 +1 @@
+jest.useRealTimers();

package.json

@@ -132,7 +132,7 @@
     "react-native-linear-gradient": "^2.8.1",
     "react-native-localize": "^2.2.6",
     "react-native-modal": "^13.0.0",
-    "react-native-onyx": "1.0.77",
+    "react-native-onyx": "1.0.78",
     "react-native-pager-view": "^6.2.0",
     "react-native-pdf": "^6.7.1",
     "react-native-performance": "^5.1.0",

src/libs/RequestThrottle.ts

@@ -16,8 +16,12 @@ function getRequestWaitTime() {
     return requestWaitTime;
 }
 
+function getLastRequestWaitTime() {
+    return requestWaitTime;
+}
+
 function sleep(): Promise<void> {
     return new Promise((resolve) => setTimeout(resolve, getRequestWaitTime()));
 }
 
-export {clear, getRequestWaitTime, sleep};
+export {clear, getRequestWaitTime, sleep, getLastRequestWaitTime};

src/libs/actions/PersistedRequests.ts

@@ -10,8 +10,11 @@ Onyx.connect({
     callback: (val) => (persistedRequests = val ?? []),
 });
 
+/**
+ * This promise is only used by tests. DO NOT USE THIS PROMISE IN THE APPLICATION CODE
+ */
 function clear() {
-    Onyx.set(ONYXKEYS.PERSISTED_REQUESTS, []);
+    return Onyx.set(ONYXKEYS.PERSISTED_REQUESTS, []);
 }
 
 function save(requestsToPersist: Request[]) {

tests/README.md

@@ -6,7 +6,7 @@
 
 - Much of the logic in the app is asynchronous in nature. [`react-native-onyx`](https://github.com/expensify/react-native-onyx) relies on [`AsyncStorage`](https://github.com/react-native-async-storage/async-storage) and writes data async before updating subscribers.
 - [Actions](https://github.com/Expensify/App#actions) do not typically return a `Promise` and therefore can't always be "awaited" before running an assertion.
-- To test a result after some asynchronous code has run we can use [`Onyx.connect()`](https://github.com/Expensify/react-native-onyx/blob/2c94a94e51fab20330f7bd5381b72ea6c25553d9/lib/Onyx.js#L217-L231) and the helper method [`waitForPromisesToResolve()`](https://github.com/Expensify/ReactNativeChat/blob/ca2fa88a5789b82463d35eddc3d57f70a7286868/tests/utils/waitForPromisesToResolve.js#L1-L9) which returns a `Promise` and will ensure that all other `Promises` have finished running before resolving.
+- To test a result after some asynchronous code has run we can use [`Onyx.connect()`](https://github.com/Expensify/react-native-onyx/blob/2c94a94e51fab20330f7bd5381b72ea6c25553d9/lib/Onyx.js#L217-L231) and the helper method [`waitForBatchedUpdates()`](https://github.com/Expensify/ReactNativeChat/blob/ca2fa88a5789b82463d35eddc3d57f70a7286868/tests/utils/waitForBatchedUpdates.js#L1-L9) which returns a `Promise` and will ensure that all other `Promises` have finished running before resolving.
 - **Important Note:** When writing any asynchronous Jest test it's very important that your test itself **return a `Promise`**.
 
 ## Mocking Network Requests
@@ -65,7 +65,7 @@ describe('actions/Report', () => {
 
         // When we add a new action to that report
         Report.addComment(REPORT_ID, 'Hello!');
-        return waitForPromisesToResolve()
+        return waitForBatchedUpdates()
             .then(() => {
                 const action = reportActions[ACTION_ID];
 

tests/actions/IOUTest.js

@@ -2,14 +2,15 @@ import _ from 'underscore';
 import Onyx from 'react-native-onyx';
 import CONST from '../../src/CONST';
 import ONYXKEYS from '../../src/ONYXKEYS';
-import waitForPromisesToResolve from '../utils/waitForPromisesToResolve';
+import waitForBatchedUpdates from '../utils/waitForBatchedUpdates';
 import * as IOU from '../../src/libs/actions/IOU';
 import * as TestHelper from '../utils/TestHelper';
 import DateUtils from '../../src/libs/DateUtils';
 import * as NumberUtils from '../../src/libs/NumberUtils';
 import * as ReportActions from '../../src/libs/actions/ReportActions';
 import * as Report from '../../src/libs/actions/Report';
 import OnyxUpdateManager from '../../src/libs/actions/OnyxUpdateManager';
+import waitForNetworkPromises from '../utils/waitForNetworkPromises';
 
 const CARLOS_EMAIL = 'cmartins@expensifail.com';
 const CARLOS_ACCOUNT_ID = 1;
@@ -30,7 +31,7 @@ describe('actions/IOU', () => {
 
     beforeEach(() => {
         global.fetch = TestHelper.getGlobalFetchMock();
-        return Onyx.clear().then(waitForPromisesToResolve);
+        return Onyx.clear().then(waitForBatchedUpdates);
     });
 
     describe('requestMoney', () => {
@@ -44,7 +45,7 @@ describe('actions/IOU', () => {
             let transactionID;
             fetch.pause();
             IOU.requestMoney({}, amount, CONST.CURRENCY.USD, '', merchant, RORY_EMAIL, RORY_ACCOUNT_ID, {login: CARLOS_EMAIL, accountID: CARLOS_ACCOUNT_ID}, comment);
-            return waitForPromisesToResolve()
+            return waitForBatchedUpdates()
                 .then(
                     () =>
                         new Promise((resolve) => {
@@ -209,7 +210,7 @@ describe('actions/IOU', () => {
                 )
                 .then(() => {
                     IOU.requestMoney(chatReport, amount, CONST.CURRENCY.USD, '', '', RORY_EMAIL, RORY_ACCOUNT_ID, {login: CARLOS_EMAIL, accountID: CARLOS_ACCOUNT_ID}, comment);
-                    return waitForPromisesToResolve();
+                    return waitForBatchedUpdates();
                 })
                 .then(
                     () =>
@@ -309,6 +310,7 @@ describe('actions/IOU', () => {
                         }),
                 )
                 .then(fetch.resume)
+                .then(waitForBatchedUpdates)
                 .then(
                     () =>
                         new Promise((resolve) => {
@@ -400,7 +402,7 @@ describe('actions/IOU', () => {
                 .then(() => Onyx.set(`${ONYXKEYS.COLLECTION.TRANSACTION}${existingTransaction.transactionID}`, existingTransaction))
                 .then(() => {
                     IOU.requestMoney(chatReport, amount, CONST.CURRENCY.USD, '', '', RORY_EMAIL, RORY_ACCOUNT_ID, {login: CARLOS_EMAIL, accountID: CARLOS_ACCOUNT_ID}, comment);
-                    return waitForPromisesToResolve();
+                    return waitForBatchedUpdates();
                 })
                 .then(
                     () =>
@@ -491,6 +493,7 @@ describe('actions/IOU', () => {
                         }),
                 )
                 .then(fetch.resume)
+                .then(waitForNetworkPromises)
                 .then(
                     () =>
                         new Promise((resolve) => {
@@ -533,7 +536,7 @@ describe('actions/IOU', () => {
             fetch.pause();
             IOU.requestMoney({}, amount, CONST.CURRENCY.USD, '', '', RORY_EMAIL, RORY_ACCOUNT_ID, {login: CARLOS_EMAIL, accountID: CARLOS_ACCOUNT_ID}, comment);
             return (
-                waitForPromisesToResolve()
+                waitForBatchedUpdates()
                     .then(
                         () =>
                             new Promise((resolve) => {
@@ -904,7 +907,7 @@ describe('actions/IOU', () => {
                         comment,
                         CONST.CURRENCY.USD,
                     );
-                    return waitForPromisesToResolve();
+                    return waitForBatchedUpdates();
                 })
                 .then(
                     () =>
@@ -1127,6 +1130,7 @@ describe('actions/IOU', () => {
                         }),
                 )
                 .then(fetch.resume)
+                .then(waitForNetworkPromises)
                 .then(
                     () =>
                         new Promise((resolve) => {
@@ -1187,7 +1191,7 @@ describe('actions/IOU', () => {
             let payIOUAction;
             let transaction;
             IOU.requestMoney({}, amount, CONST.CURRENCY.USD, '', '', RORY_EMAIL, RORY_ACCOUNT_ID, {login: CARLOS_EMAIL, accountID: CARLOS_ACCOUNT_ID}, comment);
-            return waitForPromisesToResolve()
+            return waitForBatchedUpdates()
                 .then(
                     () =>
                         new Promise((resolve) => {
@@ -1267,7 +1271,7 @@ describe('actions/IOU', () => {
                 .then(() => {
                     fetch.pause();
                     IOU.payMoneyRequest(CONST.IOU.PAYMENT_TYPE.ELSEWHERE, chatReport, iouReport);
-                    return waitForPromisesToResolve();
+                    return waitForBatchedUpdates();
                 })
                 .then(
                     () =>