Function waitForBatchedUpdates

tests/utils/waitForBatchedUpdates.ts:14–38

()

 *      waitForBatchedUpdates().then(...)
 */
const waitForBatchedUpdates = (): Promise<void> =>
    new Promise((outerResolve) => {
        // We first need to exhaust the microtask queue, before we schedule the next task in the macro-task queue (setTimeout).
        // This is because we need to wait for all async onyx operations to finish, as they might schedule other macro-tasks,
        // and we want those tasks to run before our scheduled task.
        // E.g. this makes the following code work for tests:
        //
        //   Onyx.merge(...)
        //   return waitForBatchedUpdates().then(...);
        //
        // Note: Ideally, you'd just await the Onyx.merge promise.

        new Promise((innerResolve) => {
            setImmediate(() => {
                innerResolve("Flush all micro tasks that pushed by using '.then' method");
            });
        }).then(() => {
            if (getIsUsingFakeTimers()) {
                jest.runOnlyPendingTimers();
                outerResolve();
                return;
            }
            setTimeout(outerResolve, 0);
        });
    });

export default waitForBatchedUpdates;