@office-iss/react-native-win32 0.0.0-canary.29 → 0.0.0-canary.290

package/src/private/debugging/setUpFuseboxReactDevToolsDispatcher.js

@@ -0,0 +1,114 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and 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
+ * @oncall react_native
+ */
+
+type JSONValue =
+  | string
+  | number
+  | boolean
+  | null
+  | {[key: string]: JSONValue}
+  | Array<JSONValue>;
+type DomainName = 'react-devtools';
+
+class EventScope<T> {
+  #listeners: Set<(T) => void> = new Set();
+
+  addEventListener(listener: T => void): void {
+    this.#listeners.add(listener);
+  }
+
+  removeEventListener(listener: T => void): void {
+    this.#listeners.delete(listener);
+  }
+
+  emit(value: T): void {
+    // Assuming that listeners won't throw.
+    for (const listener of this.#listeners) {
+      listener(value);
+    }
+  }
+}
+
+export class Domain {
+  name: DomainName;
+  onMessage: EventScope<JSONValue>;
+
+  constructor(name: DomainName) {
+    if (global[FuseboxReactDevToolsDispatcher.BINDING_NAME] == null) {
+      throw new Error(
+        `Could not create domain ${name}: receiving end doesn't exist`,
+      );
+    }
+
+    this.name = name;
+    this.onMessage = new EventScope<JSONValue>();
+  }
+
+  sendMessage(message: JSONValue) {
+    const messageWithDomain = {domain: this.name, message};
+    const serializedMessageWithDomain = JSON.stringify(messageWithDomain);
+
+    global[FuseboxReactDevToolsDispatcher.BINDING_NAME](
+      serializedMessageWithDomain,
+    );
+  }
+}
+
+/**
+ * Globally bound object providing a hook for React DevTools runtime API calls
+ * over CDP.
+ *
+ * @see {@link ./__docs__/FuseboxReactDevToolsDispatcher.excalidraw-embedded.png}
+ */
+class FuseboxReactDevToolsDispatcher {
+  static #domainNameToDomainMap: Map<DomainName, Domain> = new Map();
+
+  // Referenced and initialized from Chrome DevTools frontend.
+  static BINDING_NAME: string = '__CHROME_DEVTOOLS_FRONTEND_BINDING__';
+  static onDomainInitialization: EventScope<Domain> = new EventScope<Domain>();
+
+  // Should be private, referenced from Chrome DevTools frontend only.
+  static initializeDomain(domainName: DomainName): Domain {
+    const domain = new Domain(domainName);
+
+    this.#domainNameToDomainMap.set(domainName, domain);
+    this.onDomainInitialization.emit(domain);
+
+    return domain;
+  }
+
+  // Should be private, referenced from Chrome DevTools frontend only.
+  static sendMessage(domainName: DomainName, message: string): void {
+    const domain = this.#domainNameToDomainMap.get(domainName);
+    if (domain == null) {
+      throw new Error(
+        `Could not send message to ${domainName}: domain doesn't exist`,
+      );
+    }
+
+    try {
+      const parsedMessage = JSON.parse(message);
+      domain.onMessage.emit(parsedMessage);
+    } catch (err) {
+      console.error(
+        `Error while trying to send a message to domain ${domainName}:`,
+        err,
+      );
+    }
+  }
+}
+
+Object.defineProperty(global, '__FUSEBOX_REACT_DEVTOOLS_DISPATCHER__', {
+  value: FuseboxReactDevToolsDispatcher,
+  configurable: false,
+  enumerable: false,
+  writable: false,
+});

package/src/private/devmenu/DevMenu.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @format
+ */
+
+/**
+ * The DevMenu module exposes methods for interacting with the Dev Menu in development.
+ */
+export interface DevMenuStatic {
+  /**
+   * Show the Dev Menu.
+   */
+  show(): void;
+}
+
+export const DevMenu: DevMenuStatic;

package/src/private/devmenu/DevMenu.js

@@ -0,0 +1,31 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and 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
+ */
+
+import NativeDevMenu from '../specs_DEPRECATED/modules/NativeDevMenu';
+
+/**
+ * The DevMenu module exposes methods for interacting with the Dev Menu in development.
+ */
+type DevMenuStatic = {
+  /**
+   * Show the Dev Menu.
+   */
+  show(): void,
+};
+
+const DevMenu: DevMenuStatic = {
+  show(): void {
+    if (__DEV__) {
+      NativeDevMenu.show?.();
+    }
+  },
+};
+
+export default DevMenu;

package/src/private/featureflags/ReactNativeFeatureFlags.js

@@ -0,0 +1,336 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @generated SignedSource<<b4da778c80a82ff5c93c7d799ff0c580>>
+ * @flow strict
+ */
+
+/**
+ * IMPORTANT: Do NOT modify this file directly.
+ *
+ * To change the definition of the flags, edit
+ *   packages/react-native/scripts/featureflags/ReactNativeFeatureFlags.config.js.
+ *
+ * To regenerate this code, run the following script from the repo root:
+ *   yarn featureflags --update
+ */
+
+import {
+  type Getter,
+  type OverridesFor,
+  createJavaScriptFlagGetter,
+  createNativeFlagGetter,
+  setOverrides,
+} from './ReactNativeFeatureFlagsBase';
+
+export type ReactNativeFeatureFlagsJsOnly = $ReadOnly<{
+  jsOnlyTestFlag: Getter<boolean>,
+  animatedShouldDebounceQueueFlush: Getter<boolean>,
+  animatedShouldUseSingleOp: Getter<boolean>,
+  avoidAnimatedRefInvalidation: Getter<boolean>,
+  avoidStateUpdateInAnimatedPropsMemo: Getter<boolean>,
+  disableInteractionManager: Getter<boolean>,
+  enableAccessToHostTreeInFabric: Getter<boolean>,
+  fixVirtualizeListCollapseWindowSize: Getter<boolean>,
+  isLayoutAnimationEnabled: Getter<boolean>,
+  scheduleAnimatedCleanupInMicrotask: Getter<boolean>,
+  shouldUseAnimatedObjectForTransform: Getter<boolean>,
+  shouldUseRemoveClippedSubviewsAsDefaultOnIOS: Getter<boolean>,
+  shouldUseSetNativePropsInFabric: Getter<boolean>,
+}>;
+
+export type ReactNativeFeatureFlagsJsOnlyOverrides = OverridesFor<ReactNativeFeatureFlagsJsOnly>;
+
+export type ReactNativeFeatureFlags = $ReadOnly<{
+  ...ReactNativeFeatureFlagsJsOnly,
+  commonTestFlag: Getter<boolean>,
+  commonTestFlagWithoutNativeImplementation: Getter<boolean>,
+  animatedShouldSignalBatch: Getter<boolean>,
+  cxxNativeAnimatedEnabled: Getter<boolean>,
+  disableMountItemReorderingAndroid: Getter<boolean>,
+  enableAccumulatedUpdatesInRawPropsAndroid: Getter<boolean>,
+  enableBridgelessArchitecture: Getter<boolean>,
+  enableCppPropsIteratorSetter: Getter<boolean>,
+  enableEagerRootViewAttachment: Getter<boolean>,
+  enableFabricLogs: Getter<boolean>,
+  enableFabricRenderer: Getter<boolean>,
+  enableIOSViewClipToPaddingBox: Getter<boolean>,
+  enableImagePrefetchingAndroid: Getter<boolean>,
+  enableJSRuntimeGCOnMemoryPressureOnIOS: Getter<boolean>,
+  enableLayoutAnimationsOnAndroid: Getter<boolean>,
+  enableLayoutAnimationsOnIOS: Getter<boolean>,
+  enableLongTaskAPI: Getter<boolean>,
+  enableMainQueueModulesOnIOS: Getter<boolean>,
+  enableNativeCSSParsing: Getter<boolean>,
+  enableNewBackgroundAndBorderDrawables: Getter<boolean>,
+  enablePropsUpdateReconciliationAndroid: Getter<boolean>,
+  enableReportEventPaintTime: Getter<boolean>,
+  enableSynchronousStateUpdates: Getter<boolean>,
+  enableUIConsistency: Getter<boolean>,
+  enableViewCulling: Getter<boolean>,
+  enableViewRecycling: Getter<boolean>,
+  enableViewRecyclingForText: Getter<boolean>,
+  enableViewRecyclingForView: Getter<boolean>,
+  fixMappingOfEventPrioritiesBetweenFabricAndReact: Getter<boolean>,
+  fixMountingCoordinatorReportedPendingTransactionsOnAndroid: Getter<boolean>,
+  fuseboxEnabledRelease: Getter<boolean>,
+  fuseboxNetworkInspectionEnabled: Getter<boolean>,
+  removeTurboModuleManagerDelegateMutex: Getter<boolean>,
+  throwExceptionInsteadOfDeadlockOnTurboModuleSetupDuringSyncRenderIOS: Getter<boolean>,
+  traceTurboModulePromiseRejectionsOnAndroid: Getter<boolean>,
+  useAlwaysAvailableJSErrorHandling: Getter<boolean>,
+  useEditTextStockAndroidFocusBehavior: Getter<boolean>,
+  useFabricInterop: Getter<boolean>,
+  useNativeViewConfigsInBridgelessMode: Getter<boolean>,
+  useOptimizedEventBatchingOnAndroid: Getter<boolean>,
+  useRawPropsJsiValue: Getter<boolean>,
+  useTurboModuleInterop: Getter<boolean>,
+  useTurboModules: Getter<boolean>,
+}>;
+
+/**
+ * JS-only flag for testing. Do NOT modify.
+ */
+export const jsOnlyTestFlag: Getter<boolean> = createJavaScriptFlagGetter('jsOnlyTestFlag', false);
+
+/**
+ * Enables an experimental flush-queue debouncing in Animated.js.
+ */
+export const animatedShouldDebounceQueueFlush: Getter<boolean> = createJavaScriptFlagGetter('animatedShouldDebounceQueueFlush', false);
+
+/**
+ * Enables an experimental mega-operation for Animated.js that replaces many calls to native with a single call into native, to reduce JSI/JNI traffic.
+ */
+export const animatedShouldUseSingleOp: Getter<boolean> = createJavaScriptFlagGetter('animatedShouldUseSingleOp', false);
+
+/**
+ * Changes `useAnimatedProps` to avoid invalidating the callback ref whenever `props` changes.
+ */
+export const avoidAnimatedRefInvalidation: Getter<boolean> = createJavaScriptFlagGetter('avoidAnimatedRefInvalidation', false);
+
+/**
+ * Changes `useAnimatedPropsMemo` to avoid state updates to invalidate the cached `AnimatedProps`.
+ */
+export const avoidStateUpdateInAnimatedPropsMemo: Getter<boolean> = createJavaScriptFlagGetter('avoidStateUpdateInAnimatedPropsMemo', false);
+
+/**
+ * Disables InteractionManager and replaces its scheduler with `setImmediate`.
+ */
+export const disableInteractionManager: Getter<boolean> = createJavaScriptFlagGetter('disableInteractionManager', true);
+
+/**
+ * Enables access to the host tree in Fabric using DOM-compatible APIs.
+ */
+export const enableAccessToHostTreeInFabric: Getter<boolean> = createJavaScriptFlagGetter('enableAccessToHostTreeInFabric', false);
+
+/**
+ * Fixing an edge case where the current window size is not properly calculated with fast scrolling. Window size collapsed to 1 element even if windowSize more than the current amount of elements
+ */
+export const fixVirtualizeListCollapseWindowSize: Getter<boolean> = createJavaScriptFlagGetter('fixVirtualizeListCollapseWindowSize', false);
+
+/**
+ * Function used to enable / disabled Layout Animations in React Native.
+ */
+export const isLayoutAnimationEnabled: Getter<boolean> = createJavaScriptFlagGetter('isLayoutAnimationEnabled', true);
+
+/**
+ * Changes the cleanup of `AnimatedProps` to occur in a microtask instead of synchronously during effect cleanup (for unmount) or subsequent mounts (for updates).
+ */
+export const scheduleAnimatedCleanupInMicrotask: Getter<boolean> = createJavaScriptFlagGetter('scheduleAnimatedCleanupInMicrotask', true);
+
+/**
+ * Enables use of AnimatedObject for animating transform values.
+ */
+export const shouldUseAnimatedObjectForTransform: Getter<boolean> = createJavaScriptFlagGetter('shouldUseAnimatedObjectForTransform', false);
+
+/**
+ * removeClippedSubviews prop will be used as the default in FlatList on iOS to match Android
+ */
+export const shouldUseRemoveClippedSubviewsAsDefaultOnIOS: Getter<boolean> = createJavaScriptFlagGetter('shouldUseRemoveClippedSubviewsAsDefaultOnIOS', false);
+
+/**
+ * Enables use of setNativeProps in JS driven animations.
+ */
+export const shouldUseSetNativePropsInFabric: Getter<boolean> = createJavaScriptFlagGetter('shouldUseSetNativePropsInFabric', true);
+
+/**
+ * Common flag for testing. Do NOT modify.
+ */
+export const commonTestFlag: Getter<boolean> = createNativeFlagGetter('commonTestFlag', false);
+/**
+ * Common flag for testing (without native implementation). Do NOT modify.
+ */
+export const commonTestFlagWithoutNativeImplementation: Getter<boolean> = createNativeFlagGetter('commonTestFlagWithoutNativeImplementation', false);
+/**
+ * Enables start- and finishOperationBatch on any platform.
+ */
+export const animatedShouldSignalBatch: Getter<boolean> = createNativeFlagGetter('animatedShouldSignalBatch', false);
+/**
+ * Use a C++ implementation of Native Animated instead of the platform implementation.
+ */
+export const cxxNativeAnimatedEnabled: Getter<boolean> = createNativeFlagGetter('cxxNativeAnimatedEnabled', false);
+/**
+ * Prevent FabricMountingManager from reordering mountItems, which may lead to invalid state on the UI thread
+ */
+export const disableMountItemReorderingAndroid: Getter<boolean> = createNativeFlagGetter('disableMountItemReorderingAndroid', false);
+/**
+ * When enabled, Android will accumulate updates in rawProps to reduce the number of mounting instructions for cascading re-renders.
+ */
+export const enableAccumulatedUpdatesInRawPropsAndroid: Getter<boolean> = createNativeFlagGetter('enableAccumulatedUpdatesInRawPropsAndroid', false);
+/**
+ * Feature flag to enable the new bridgeless architecture. Note: Enabling this will force enable the following flags: `useTurboModules` & `enableFabricRenderer`.
+ */
+export const enableBridgelessArchitecture: Getter<boolean> = createNativeFlagGetter('enableBridgelessArchitecture', false);
+/**
+ * Enable prop iterator setter-style construction of Props in C++ (this flag is not used in Java).
+ */
+export const enableCppPropsIteratorSetter: Getter<boolean> = createNativeFlagGetter('enableCppPropsIteratorSetter', false);
+/**
+ * Feature flag to configure eager attachment of the root view/initialisation of the JS code.
+ */
+export const enableEagerRootViewAttachment: Getter<boolean> = createNativeFlagGetter('enableEagerRootViewAttachment', false);
+/**
+ * This feature flag enables logs for Fabric.
+ */
+export const enableFabricLogs: Getter<boolean> = createNativeFlagGetter('enableFabricLogs', false);
+/**
+ * Enables the use of the Fabric renderer in the whole app.
+ */
+export const enableFabricRenderer: Getter<boolean> = createNativeFlagGetter('enableFabricRenderer', false);
+/**
+ * iOS Views will clip to their padding box vs border box
+ */
+export const enableIOSViewClipToPaddingBox: Getter<boolean> = createNativeFlagGetter('enableIOSViewClipToPaddingBox', false);
+/**
+ * When enabled, Android will build and initiate image prefetch requests on ImageShadowNode::layout
+ */
+export const enableImagePrefetchingAndroid: Getter<boolean> = createNativeFlagGetter('enableImagePrefetchingAndroid', false);
+/**
+ * Trigger JS runtime GC on memory pressure event on iOS
+ */
+export const enableJSRuntimeGCOnMemoryPressureOnIOS: Getter<boolean> = createNativeFlagGetter('enableJSRuntimeGCOnMemoryPressureOnIOS', false);
+/**
+ * When enabled, LayoutAnimations API will animate state changes on Android.
+ */
+export const enableLayoutAnimationsOnAndroid: Getter<boolean> = createNativeFlagGetter('enableLayoutAnimationsOnAndroid', false);
+/**
+ * When enabled, LayoutAnimations API will animate state changes on iOS.
+ */
+export const enableLayoutAnimationsOnIOS: Getter<boolean> = createNativeFlagGetter('enableLayoutAnimationsOnIOS', true);
+/**
+ * Enables the reporting of long tasks through `PerformanceObserver`. Only works if the event loop is enabled.
+ */
+export const enableLongTaskAPI: Getter<boolean> = createNativeFlagGetter('enableLongTaskAPI', false);
+/**
+ * Makes modules requiring main queue setup initialize on the main thread, during React Native init.
+ */
+export const enableMainQueueModulesOnIOS: Getter<boolean> = createNativeFlagGetter('enableMainQueueModulesOnIOS', false);
+/**
+ * Parse CSS strings using the Fabric CSS parser instead of ViewConfig processing
+ */
+export const enableNativeCSSParsing: Getter<boolean> = createNativeFlagGetter('enableNativeCSSParsing', false);
+/**
+ * Use BackgroundDrawable and BorderDrawable instead of CSSBackgroundDrawable
+ */
+export const enableNewBackgroundAndBorderDrawables: Getter<boolean> = createNativeFlagGetter('enableNewBackgroundAndBorderDrawables', false);
+/**
+ * When enabled, Android will receive prop updates based on the differences between the last rendered shadow node and the last committed shadow node.
+ */
+export const enablePropsUpdateReconciliationAndroid: Getter<boolean> = createNativeFlagGetter('enablePropsUpdateReconciliationAndroid', false);
+/**
+ * Report paint time inside the Event Timing API implementation (PerformanceObserver).
+ */
+export const enableReportEventPaintTime: Getter<boolean> = createNativeFlagGetter('enableReportEventPaintTime', false);
+/**
+ * Dispatches state updates synchronously in Fabric (e.g.: updates the scroll position in the shadow tree synchronously from the main thread).
+ */
+export const enableSynchronousStateUpdates: Getter<boolean> = createNativeFlagGetter('enableSynchronousStateUpdates', false);
+/**
+ * Ensures that JavaScript always has a consistent view of the state of the UI (e.g.: commits done in other threads are not immediately propagated to JS during its execution).
+ */
+export const enableUIConsistency: Getter<boolean> = createNativeFlagGetter('enableUIConsistency', false);
+/**
+ * Enables View Culling: as soon as a view goes off screen, it can be reused anywhere in the UI and pieced together with other items to create new UI elements.
+ */
+export const enableViewCulling: Getter<boolean> = createNativeFlagGetter('enableViewCulling', false);
+/**
+ * Enables View Recycling. When enabled, individual ViewManagers must still opt-in.
+ */
+export const enableViewRecycling: Getter<boolean> = createNativeFlagGetter('enableViewRecycling', false);
+/**
+ * Enables View Recycling for <Text> via ReactTextView/ReactTextViewManager.
+ */
+export const enableViewRecyclingForText: Getter<boolean> = createNativeFlagGetter('enableViewRecyclingForText', true);
+/**
+ * Enables View Recycling for <View> via ReactViewGroup/ReactViewManager.
+ */
+export const enableViewRecyclingForView: Getter<boolean> = createNativeFlagGetter('enableViewRecyclingForView', true);
+/**
+ * Uses the default event priority instead of the discreet event priority by default when dispatching events from Fabric to React.
+ */
+export const fixMappingOfEventPrioritiesBetweenFabricAndReact: Getter<boolean> = createNativeFlagGetter('fixMappingOfEventPrioritiesBetweenFabricAndReact', false);
+/**
+ * Fixes a limitation on Android where the mounting coordinator would report there are no pending transactions but some of them were actually not processed due to the use of the push model.
+ */
+export const fixMountingCoordinatorReportedPendingTransactionsOnAndroid: Getter<boolean> = createNativeFlagGetter('fixMountingCoordinatorReportedPendingTransactionsOnAndroid', false);
+/**
+ * Flag determining if the React Native DevTools (Fusebox) CDP backend should be enabled in release builds. This flag is global and should not be changed across React Host lifetimes.
+ */
+export const fuseboxEnabledRelease: Getter<boolean> = createNativeFlagGetter('fuseboxEnabledRelease', false);
+/**
+ * Enable network inspection support in the React Native DevTools CDP backend. Requires `enableBridgelessArchitecture`. This flag is global and should not be changed across React Host lifetimes.
+ */
+export const fuseboxNetworkInspectionEnabled: Getter<boolean> = createNativeFlagGetter('fuseboxNetworkInspectionEnabled', false);
+/**
+ * When enabled, mutex _turboModuleManagerDelegateMutex in RCTTurboModuleManager will not be used
+ */
+export const removeTurboModuleManagerDelegateMutex: Getter<boolean> = createNativeFlagGetter('removeTurboModuleManagerDelegateMutex', false);
+/**
+ * Throw an exception instead of deadlocking when a TurboModule that requires main queue setup is initialized during a synchronous render on iOS.
+ */
+export const throwExceptionInsteadOfDeadlockOnTurboModuleSetupDuringSyncRenderIOS: Getter<boolean> = createNativeFlagGetter('throwExceptionInsteadOfDeadlockOnTurboModuleSetupDuringSyncRenderIOS', false);
+/**
+ * Enables storing js caller stack when creating promise in native module. This is useful in case of Promise rejection and tracing the cause.
+ */
+export const traceTurboModulePromiseRejectionsOnAndroid: Getter<boolean> = createNativeFlagGetter('traceTurboModulePromiseRejectionsOnAndroid', false);
+/**
+ * In Bridgeless mode, use the always available javascript error reporting pipeline.
+ */
+export const useAlwaysAvailableJSErrorHandling: Getter<boolean> = createNativeFlagGetter('useAlwaysAvailableJSErrorHandling', false);
+/**
+ * If true, focusing in ReactEditText will mainly use stock Android requestFocus() behavior. If false it will use legacy custom focus behavior.
+ */
+export const useEditTextStockAndroidFocusBehavior: Getter<boolean> = createNativeFlagGetter('useEditTextStockAndroidFocusBehavior', true);
+/**
+ * Should this application enable the Fabric Interop Layer for Android? If yes, the application will behave so that it can accept non-Fabric components and render them on Fabric. This toggle is controlling extra logic such as custom event dispatching that are needed for the Fabric Interop Layer to work correctly.
+ */
+export const useFabricInterop: Getter<boolean> = createNativeFlagGetter('useFabricInterop', true);
+/**
+ * When enabled, the native view configs are used in bridgeless mode.
+ */
+export const useNativeViewConfigsInBridgelessMode: Getter<boolean> = createNativeFlagGetter('useNativeViewConfigsInBridgelessMode', false);
+/**
+ * Uses an optimized mechanism for event batching on Android that does not need to wait for a Choreographer frame callback.
+ */
+export const useOptimizedEventBatchingOnAndroid: Getter<boolean> = createNativeFlagGetter('useOptimizedEventBatchingOnAndroid', false);
+/**
+ * Instead of using folly::dynamic as internal representation in RawProps and RawValue, use jsi::Value
+ */
+export const useRawPropsJsiValue: Getter<boolean> = createNativeFlagGetter('useRawPropsJsiValue', false);
+/**
+ * In Bridgeless mode, should legacy NativeModules use the TurboModule system?
+ */
+export const useTurboModuleInterop: Getter<boolean> = createNativeFlagGetter('useTurboModuleInterop', false);
+/**
+ * When enabled, NativeModules will be executed by using the TurboModule system
+ */
+export const useTurboModules: Getter<boolean> = createNativeFlagGetter('useTurboModules', false);
+
+/**
+ * Overrides the feature flags with the provided methods.
+ * NOTE: Only JS-only flags can be overridden from JavaScript using this API.
+ */
+export const override = setOverrides;

package/src/private/featureflags/ReactNativeFeatureFlagsBase.js

@@ -0,0 +1,115 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and 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
+ * @format
+ */
+
+import type {
+  ReactNativeFeatureFlagsJsOnly,
+  ReactNativeFeatureFlagsJsOnlyOverrides,
+} from './ReactNativeFeatureFlags';
+
+import NativeReactNativeFeatureFlags from './specs/NativeReactNativeFeatureFlags';
+
+const accessedFeatureFlags: Set<string> = new Set();
+let overrides: ?ReactNativeFeatureFlagsJsOnlyOverrides;
+
+export type Getter<T> = () => T;
+
+// This defines the types for the overrides object, whose methods also receive
+// the default value as a parameter.
+export type OverridesFor<T> = Partial<{
+  [key in keyof T]: (ReturnType<T[key]>) => ReturnType<T[key]>,
+}>;
+
+function createGetter<T: boolean | number | string>(
+  configName: string,
+  customValueGetter: Getter<?T>,
+  defaultValue: T,
+): Getter<T> {
+  let cachedValue: ?T;
+
+  return () => {
+    if (cachedValue == null) {
+      cachedValue = customValueGetter() ?? defaultValue;
+    }
+    return cachedValue;
+  };
+}
+
+export function createJavaScriptFlagGetter<
+  K: $Keys<ReactNativeFeatureFlagsJsOnly>,
+>(
+  configName: K,
+  defaultValue: ReturnType<ReactNativeFeatureFlagsJsOnly[K]>,
+): Getter<ReturnType<ReactNativeFeatureFlagsJsOnly[K]>> {
+  return createGetter(
+    configName,
+    () => {
+      accessedFeatureFlags.add(configName);
+      return overrides?.[configName]?.(defaultValue);
+    },
+    defaultValue,
+  );
+}
+
+type NativeFeatureFlags = $NonMaybeType<typeof NativeReactNativeFeatureFlags>;
+
+export function createNativeFlagGetter<K: $Keys<NativeFeatureFlags>>(
+  configName: K,
+  defaultValue: ReturnType<$NonMaybeType<NativeFeatureFlags[K]>>,
+  skipUnavailableNativeModuleError: boolean = false,
+): Getter<ReturnType<$NonMaybeType<NativeFeatureFlags[K]>>> {
+  return createGetter(
+    configName,
+    () => {
+      maybeLogUnavailableNativeModuleError(configName);
+      return NativeReactNativeFeatureFlags?.[configName]?.();
+    },
+    defaultValue,
+  );
+}
+
+export function getOverrides(): ?ReactNativeFeatureFlagsJsOnlyOverrides {
+  return overrides;
+}
+
+export function setOverrides(
+  newOverrides: ReactNativeFeatureFlagsJsOnlyOverrides,
+): void {
+  if (overrides != null) {
+    throw new Error('Feature flags cannot be overridden more than once');
+  }
+
+  if (accessedFeatureFlags.size > 0) {
+    const accessedFeatureFlagsStr = Array.from(accessedFeatureFlags).join(', ');
+    throw new Error(
+      `Feature flags were accessed before being overridden: ${accessedFeatureFlagsStr}`,
+    );
+  }
+
+  overrides = newOverrides;
+}
+
+const reportedConfigNames: Set<string> = new Set();
+const hasTurboModules =
+  global.RN$Bridgeless === true || global.__turboModuleProxy != null;
+
+function maybeLogUnavailableNativeModuleError(configName: string): void {
+  if (
+    !NativeReactNativeFeatureFlags &&
+    // Don't log more than once per config
+    !reportedConfigNames.has(configName) &&
+    // Don't log in the legacy architecture.
+    hasTurboModules
+  ) {
+    reportedConfigNames.add(configName);
+    console.error(
+      `Could not access feature flag '${configName}' because native module method was not available`,
+    );
+  }
+}