mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Xuan HuangandFacebook GitHub Bot
dc8d218077
Summary: Changelog: [Internal] Historically, Immediate API is implemented upon the React Native's internal microtask-y queue (known as "immediate queue"), which is the same queue Promise polyfill is operating on. To make React Native suitable of using the built-in Promises from JSVMs, which usually enqueues to the JSVM internal microtask queue and has no access to React Native microtask-y queue, we need to migrate the Immediate API to use the JSVM microtask queue as well to preserve the semantics of code relies on the interleaving of promises and immediates. To do that, this diff implement a shim layer for immediate APIs via the new `global.queueMicrotask` API (which enqueues to JSVM) in JS, by wrapping the immediate callback into a "microtask callback", which validate the `immediate ID` against `clearedImmediate` Set before invoking it. Reviewed By: RSNara Differential Revision: D29845305 fbshipit-source-id: c2ed3fed426a5316b1e0dfbfaad51706d1765d4d
100 lines
3.1 KiB
JavaScript
100 lines
3.1 KiB
JavaScript
/**
|
|
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*
|
|
* @flow strict-local
|
|
* @format
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
const {polyfillGlobal} = require('../Utilities/PolyfillFunctions');
|
|
|
|
if (__DEV__) {
|
|
if (typeof global.Promise !== 'function') {
|
|
console.error('Promise should exist before setting up timers.');
|
|
}
|
|
}
|
|
|
|
// Currently, Hermes `Promise` is implemented via Internal Bytecode.
|
|
const hasHermesPromiseQueuedToJSVM =
|
|
global?.HermesInternal?.hasPromise?.() &&
|
|
global?.HermesInternal?.useEngineQueue?.();
|
|
|
|
// An util function to tell whether a function is provided natively by calling
|
|
// the `toString` and check if the result includes `[native code]` in it.
|
|
// N.B. a polyfill can fake this behavior but they usually won't. Hence this
|
|
// is usually good enough for our purpose.
|
|
const isNativeFunction = f =>
|
|
typeof f === 'function' && f.toString().indexOf('[native code]') > -1;
|
|
const hasNativePromise = isNativeFunction(Promise);
|
|
|
|
const hasPromiseQueuedToJSVM = hasNativePromise || hasHermesPromiseQueuedToJSVM;
|
|
|
|
// In bridgeless mode, timers are host functions installed from cpp.
|
|
if (!global.RN$Bridgeless) {
|
|
/**
|
|
* Set up timers.
|
|
* You can use this module directly, or just require InitializeCore.
|
|
*/
|
|
const defineLazyTimer = name => {
|
|
polyfillGlobal(name, () => require('./Timers/JSTimers')[name]);
|
|
};
|
|
defineLazyTimer('setTimeout');
|
|
defineLazyTimer('clearTimeout');
|
|
defineLazyTimer('setInterval');
|
|
defineLazyTimer('clearInterval');
|
|
defineLazyTimer('requestAnimationFrame');
|
|
defineLazyTimer('cancelAnimationFrame');
|
|
defineLazyTimer('requestIdleCallback');
|
|
defineLazyTimer('cancelIdleCallback');
|
|
}
|
|
|
|
/**
|
|
* Set up immediate APIs, which is required to use the same microtask queue
|
|
* as the Promise.
|
|
*/
|
|
if (hasPromiseQueuedToJSVM) {
|
|
// When promise queues to the JSVM microtasks queue, we shim the immedaite
|
|
// APIs via `queueMicrotask` to maintain the backward compatibility.
|
|
polyfillGlobal(
|
|
'setImmediate',
|
|
() => require('./Timers/immediateShim').setImmediate,
|
|
);
|
|
polyfillGlobal(
|
|
'clearImmediate',
|
|
() => require('./Timers/immediateShim').clearImmediate,
|
|
);
|
|
} else {
|
|
// When promise was polyfilled hence is queued to the RN microtask queue,
|
|
// we polyfill the immediate APIs as aliases to the ReactNativeMicrotask APIs.
|
|
// Note that in bridgeless mode, immediate APIs are installed from cpp.
|
|
if (!global.RN$Bridgeless) {
|
|
polyfillGlobal(
|
|
'setImmediate',
|
|
() => require('./Timers/JSTimers').queueReactNativeMicrotask,
|
|
);
|
|
polyfillGlobal(
|
|
'clearImmediate',
|
|
() => require('./Timers/JSTimers').clearReactNativeMicrotask,
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Set up the microtask queueing API, which is required to use the same
|
|
* microtask queue as the Promise.
|
|
*/
|
|
if (hasHermesPromiseQueuedToJSVM) {
|
|
// Fast path for Hermes.
|
|
polyfillGlobal('queueMicrotask', () => global.HermesInternal.enqueueJob);
|
|
} else {
|
|
// Polyfill it with promise (regardless it's polyfiled or native) otherwise.
|
|
polyfillGlobal(
|
|
'queueMicrotask',
|
|
() => require('./Timers/queueMicrotask.js').default,
|
|
);
|
|
}
|