react-native-worklets 0.7.4 → 0.8.0-bundle-mode-preview-2

package/src/initializers/initializers.native.ts

@@ -1,8 +1,15 @@
 'use strict';
 
+import {
+  disallowRNImports,
+  mockTurboModuleRegistry,
+  silenceHMRWarnings,
+} from '../bundleMode/metroOverrides';
+import { initializeNetworking } from '../bundleMode/network';
 import { setupCallGuard } from '../callGuard';
 import { registerReportFatalRemoteError } from '../debug/errors';
 import { registerWorkletsError, WorkletsError } from '../debug/WorkletsError';
+import { getStaticFeatureFlag } from '../featureFlags/featureFlags';
 import { bundleValueUnpacker } from '../memory/bundleUnpacker';
 import { __installUnpacker as installCustomSerializableUnpacker } from '../memory/customSerializableUnpacker';
 import { makeShareableCloneOnUIRecursive } from '../memory/serializable';
@@ -108,7 +115,7 @@ export function init() {
 
 /** A function that should be run on any kind of runtime. */
 function initializeRuntime() {
-  if (globalThis._WORKLETS_BUNDLE_MODE) {
+  if (globalThis._WORKLETS_BUNDLE_MODE_ENABLED) {
     globalThis.__valueUnpacker = bundleValueUnpacker as ValueUnpacker;
   }
   installSynchronizableUnpacker();
@@ -133,68 +140,17 @@ function initializeRNRuntime() {
 
 /** A function that should be run only on Worklet runtimes. */
 function initializeWorkletRuntime() {
-  if (globalThis._WORKLETS_BUNDLE_MODE) {
+  if (globalThis._WORKLETS_BUNDLE_MODE_ENABLED) {
     setupCallGuard();
 
     if (__DEV__) {
-      /*
-       * Temporary workaround for Metro bundler. We must implement a dummy
-       * Refresh module to prevent Metro from throwing irrelevant errors.
-       */
-      const Refresh = new Proxy(
-        {},
-        {
-          get() {
-            return () => {};
-          },
-        }
-      );
-
-      globalThis.__r.Refresh = Refresh;
-
-      /* Gracefully handle unwanted imports from React Native. */
-      const modules = require.getModules();
-      const ReactNativeModuleId = require.resolveWeak('react-native');
-
-      const factory = function (
-        _global: unknown,
-        _require: unknown,
-        _importDefault: unknown,
-        _importAll: unknown,
-        module: Record<string, unknown>,
-        _exports: unknown,
-        _dependencyMap: unknown
-      ) {
-        module.exports = new Proxy(
-          {},
-          {
-            get: function get(_target, prop) {
-              globalThis.console.warn(
-                `You tried to import '${String(prop)}' from 'react-native' module on a Worklet Runtime. Using 'react-native' module on a Worklet Runtime is not allowed.`
-              );
-              return {
-                get() {
-                  return undefined;
-                },
-              };
-            },
-          }
-        );
-      };
-
-      const mod = {
-        dependencyMap: [],
-        factory,
-        hasError: false,
-        importedAll: {},
-        importedDefault: {},
-        isInitialized: false,
-        publicModule: {
-          exports: {},
-        },
-      };
+      silenceHMRWarnings();
+      disallowRNImports();
+    }
 
-      modules.set(ReactNativeModuleId, mod);
+    if (getStaticFeatureFlag('FETCH_PREVIEW_ENABLED')) {
+      mockTurboModuleRegistry();
+      initializeNetworking();
     }
   }
 }
@@ -210,10 +166,8 @@ function installRNBindingsOnUIRuntime() {
     );
   }
 
-  const runtimeBoundCapturableConsole = getMemorySafeCapturableConsole();
-
-  if (!globalThis._WORKLETS_BUNDLE_MODE) {
-    /** In bundle mode Runtimes setup their callGuard themselves. */
+  if (!globalThis._WORKLETS_BUNDLE_MODE_ENABLED) {
+    /** In Bundle Mode Runtimes setup their callGuard themselves. */
     runOnUISync(setupCallGuard);
 
     /** In Bundle Mode the error is taken from the bundle. */
@@ -223,6 +177,8 @@ function installRNBindingsOnUIRuntime() {
     runOnUISync(setupSerializer);
   }
 
+  const runtimeBoundCapturableConsole = getMemorySafeCapturableConsole();
+
   runOnUISync(() => {
     'worklet';
 

package/src/initializers/workletRuntimeEntry.native.ts

@@ -14,14 +14,14 @@ import { init } from './initializers';
  * error is caught in C++ code.
  *
  * This function has no effect on the RN Runtime beside setting the
- * `_WORKLETS_BUNDLE_MODE` flag.
+ * `_WORKLETS_BUNDLE_MODE_ENABLED` flag.
  */
 export function bundleModeInit() {
   // Worklets Babel Plugin replaces `false` with `true` here
   // when Bundle Mode is enabled.
-  globalThis._WORKLETS_BUNDLE_MODE = false;
+  globalThis._WORKLETS_BUNDLE_MODE_ENABLED = false;
 
-  if (!globalThis._WORKLETS_BUNDLE_MODE) {
+  if (!globalThis._WORKLETS_BUNDLE_MODE_ENABLED) {
     return;
   }
 

package/src/memory/bundleUnpacker.native.ts

@@ -48,11 +48,9 @@ function getWorklet(
   if (__DEV__) {
     try {
       worklet = getWorkletFromMetroRequire(workletHash, closureVariables);
-    } catch (_e) {
+    } catch (e) {
       logger.error(
-        'Unable to resolve worklet with hash ' +
-          workletHash +
-          '. Try reloading the app.'
+        `Unable to resolve worklet with hash ${workletHash}. Try reloading the app. Original error: ${(e as Error).message}`
       );
     }
   } else {

package/src/memory/serializable.native.ts

@@ -174,7 +174,7 @@ export function createSerializable<TValue>(
     return cloneArray(value, shouldPersistRemote, depth);
   }
   if (
-    globalThis._WORKLETS_BUNDLE_MODE &&
+    globalThis._WORKLETS_BUNDLE_MODE_ENABLED &&
     isFunction &&
     (value as WorkletImport).__bundleData
   ) {
@@ -238,7 +238,7 @@ export function createSerializable<TValue>(
   return inaccessibleObject(value);
 }
 
-if (globalThis._WORKLETS_BUNDLE_MODE) {
+if (globalThis._WORKLETS_BUNDLE_MODE_ENABLED) {
   // TODO: Do it programmatically.
   createSerializable.__bundleData = {
     imported: 'createSerializable',
@@ -870,7 +870,7 @@ function makeShareableCloneOnUIRecursiveLEGACY<TValue>(
 
 /** @deprecated This function is no longer supported. */
 export const makeShareableCloneOnUIRecursive = (
-  globalThis._WORKLETS_BUNDLE_MODE
+  globalThis._WORKLETS_BUNDLE_MODE_ENABLED
     ? createSerializable
     : makeShareableCloneOnUIRecursiveLEGACY
 ) as typeof makeShareableCloneOnUIRecursiveLEGACY;

package/src/memory/synchronizableUnpacker.native.ts

@@ -6,7 +6,7 @@ import { type Synchronizable, type SynchronizableRef } from './types';
 export function __installUnpacker() {
   // TODO: Add cache for synchronizables.
   const serializer =
-    !globalThis._WORKLET || globalThis._WORKLETS_BUNDLE_MODE
+    !globalThis._WORKLET || globalThis._WORKLETS_BUNDLE_MODE_ENABLED
       ? createSerializable
       : (value: unknown) => globalThis.__serializer(value);
 

package/src/platformChecker.ts

@@ -3,6 +3,7 @@
 import { Platform } from 'react-native';
 
 export const IS_JEST: boolean = !!process.env.JEST_WORKER_ID;
-export const IS_WEB: boolean = Platform.OS === 'web';
-export const IS_WINDOWS: boolean = Platform.OS === 'windows';
+export const IS_WEB: boolean = /* @__PURE__ */ (() => Platform.OS === 'web')();
+export const IS_WINDOWS: boolean = /* @__PURE__ */ (() =>
+  Platform.OS === 'windows')();
 export const SHOULD_BE_USE_WEB: boolean = IS_JEST || IS_WEB || IS_WINDOWS;

package/src/privateGlobals.d.ts

@@ -19,7 +19,7 @@ declare global {
 
   var _toString: (value: unknown) => string;
   var __workletsModuleProxy: WorkletsModuleProxy;
-  var _WORKLETS_BUNDLE_MODE: boolean | undefined;
+  var _WORKLETS_BUNDLE_MODE_ENABLED: boolean | undefined;
   var _WORKLETS_VERSION_CPP: string | undefined;
   var _WORKLETS_VERSION_JS: string | undefined;
   var _createSerializable: <T>(
@@ -84,6 +84,8 @@ declare global {
   var __hasNativeState: (value: object) => boolean;
   /** Only in Debug builds. */
   var __isHostObject: (value: object) => boolean;
+  /** Only in Bundle Mode on Worklet Runtimes. */
+  var TurboModules: Map<string, unknown>;
   interface NodeRequire {
     resolveWeak(id: string): number;
     getModules(): Map<number, unknown>;

package/src/runtimeKind.ts

@@ -29,6 +29,53 @@ export function getRuntimeKind(): RuntimeKind {
   return globalThis.__RUNTIME_KIND;
 }
 
+/**
+ * Checks if the current runtime is the [React Native
+ * Runtime](https://docs.swmansion.com/react-native-worklets/docs/fundamentals/runtimeKinds/#rn-runtime).
+ *
+ * @returns `true` if the current runtime is the React Native Runtime, `false`
+ *   otherwise.
+ */
+export function isRNRuntime(): boolean {
+  'worklet';
+  return globalThis.__RUNTIME_KIND === 1;
+}
+
+/**
+ * Checks if the current runtime is a [Worklet
+ * Runtime](https://docs.swmansion.com/react-native-worklets/docs/fundamentals/runtimeKinds/#worklet-runtime).
+ *
+ * @returns `true` if the current runtime is a Worklet Runtime, `false`
+ *   otherwise.
+ */
+export function isWorkletRuntime(): boolean {
+  'worklet';
+  return globalThis.__RUNTIME_KIND !== 1;
+}
+
+/**
+ * Checks if the current runtime is the [UI
+ * Runtime](https://docs.swmansion.com/react-native-worklets/docs/fundamentals/runtimeKinds/#ui-runtime).
+ *
+ * @returns `true` if the current runtime is the UI Runtime, `false` otherwise.
+ */
+export function isUIRuntime(): boolean {
+  'worklet';
+  return globalThis.__RUNTIME_KIND === 2;
+}
+
+/**
+ * Checks if the current runtime is a [Worker
+ * Runtime](https://docs.swmansion.com/react-native-worklets/docs/fundamentals/runtimeKinds/#worker-runtime).
+ *
+ * @returns `true` if the current runtime is a Worker Runtime, `false`
+ *   otherwise.
+ */
+export function isWorkerRuntime(): boolean {
+  'worklet';
+  return globalThis.__RUNTIME_KIND === 3;
+}
+
 if (globalThis.__RUNTIME_KIND === undefined) {
   // In Jest environments eager imports make this file to evaluate before
   // `initializers.ts` file, therefore we have to set the RuntimeKind here,

package/src/runtimes.native.ts

@@ -123,8 +123,8 @@ export function createWorkletRuntime(
  *   or another [Worker
  *   Runtime](https://docs.swmansion.com/react-native-worklets/docs/fundamentals/runtimeKinds#worker-runtime),
  *   unless the [Bundle
- *   Mode](https://docs.swmansion.com/react-native-worklets/docs/experimental/bundleMode)
- *   is enabled.
+ *   Mode](https://docs.swmansion.com/react-native-worklets/docs/bundleMode/) is
+ *   enabled.
  *
  * @param workletRuntime - The runtime to schedule the worklet on.
  * @param worklet - The worklet to schedule.
@@ -198,3 +198,42 @@ export function runOnRuntime<Args extends unknown[], ReturnValue>(
 type WorkletRuntimeConfigInternal = WorkletRuntimeConfig & {
   initializer?: WorkletFunction<[], void>;
 };
+
+/**
+ * Lets you run a function synchronously on a [Worker
+ * Runtime](https://docs.swmansion.com/react-native-worklets/docs/fundamentals/runtimeKinds#worker-runtime).
+ *
+ * - This function cannot be called from the [UI
+ *   Runtime](https://docs.swmansion.com/react-native-worklets/docs/fundamentals/runtimeKinds#ui-runtime).
+ *   or another [Worker
+ *   Runtime](https://docs.swmansion.com/react-native-worklets/docs/fundamentals/runtimeKinds#worker-runtime),
+ *   unless the [Bundle
+ *   Mode](https://docs.swmansion.com/react-native-worklets/docs/bundleMode/) is
+ *   enabled.
+ *
+ * @param workletRuntime - The runtime to run the worklet on.
+ * @param worklet - The worklet to run.
+ * @param args - The arguments to pass to the worklet.
+ * @returns The return value of the worklet.
+ */
+export function runOnRuntimeSync<Args extends unknown[], ReturnValue>(
+  workletRuntime: WorkletRuntime,
+  worklet: (...args: Args) => ReturnValue,
+  ...args: Args
+): ReturnValue {
+  'worklet';
+  if (__DEV__ && !isWorkletFunction(worklet)) {
+    throw new WorkletsError(
+      'The function passed to `runOnRuntimeSync` is not a worklet.'
+    );
+  }
+
+  return WorkletsModule.runOnRuntimeSync(
+    workletRuntime,
+    createSerializable(() => {
+      'worklet';
+      const result = worklet(...args);
+      return makeShareableCloneOnUIRecursive(result);
+    })
+  );
+}

package/src/runtimes.ts

@@ -38,3 +38,13 @@ export function scheduleOnRuntime<Args extends unknown[], ReturnValue>(
 export function scheduleOnRuntime(): never {
   throw new WorkletsError('`scheduleOnRuntime` is not supported on web.');
 }
+
+export function runOnRuntimeSync<Args extends unknown[], ReturnValue>(
+  workletRuntime: WorkletRuntime,
+  worklet: (...args: Args) => ReturnValue,
+  ...args: Args
+): ReturnValue;
+
+export function runOnRuntimeSync(): never {
+  throw new WorkletsError('`runOnRuntimeSync` is not supported on web.');
+}

package/src/threads.native.ts

@@ -66,7 +66,7 @@ export const callMicrotasks = callMicrotasksOnUIThread;
  *   Runtime](https://docs.swmansion.com/react-native-worklets/docs/fundamentals/runtimeKinds#ui-runtime)
  *   or a [Worker
  *   Runtime](https://docs.swmansion.com/react-native-worklets/docs/fundamentals/runtimeKinds#worker-runtime),
- *   unless you have the [Bundle Mode](/docs/experimental/bundleMode) enabled.
+ *   unless you have the [Bundle Mode](/docs/bundleMode/) enabled.
  *
  * @param fun - A reference to a function you want to schedule on the [UI
  *   Runtime](https://docs.swmansion.com/react-native-worklets/docs/fundamentals/runtimeKinds#ui-runtime).
@@ -187,7 +187,7 @@ export function runOnUISync<Args extends unknown[], ReturnValue>(
   worklet: WorkletFunction<Args, ReturnValue>,
   ...args: Args
 ): ReturnValue {
-  return WorkletsModule.executeOnUIRuntimeSync(
+  return WorkletsModule.runOnUISync(
     createSerializable(() => {
       'worklet';
       const result = worklet(...args);