@office-iss/react-native-win32 0.0.0-canary.256 → 0.0.0-canary.257

package/Libraries/Text/TextOptimized.js

@@ -0,0 +1,538 @@
+/**
+ * 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 type {PressEvent} from '../Types/CoreEventTypes';
+import type {NativeTextProps} from './TextNativeComponent';
+import type {PressRetentionOffset, TextProps} from './TextProps';
+
+import * as PressabilityDebug from '../Pressability/PressabilityDebug';
+import usePressability from '../Pressability/usePressability';
+import flattenStyle from '../StyleSheet/flattenStyle';
+import processColor from '../StyleSheet/processColor';
+import Platform from '../Utilities/Platform';
+import TextAncestor from './TextAncestor';
+import {NativeText, NativeVirtualText} from './TextNativeComponent';
+import * as React from 'react';
+import {useContext, useMemo, useState} from 'react';
+
+type TextForwardRef = React.ElementRef<
+  typeof NativeText | typeof NativeVirtualText,
+>;
+
+/**
+ * Text is the fundamental component for displaying text.
+ *
+ * @see https://reactnative.dev/docs/text
+ *
+ * NOTE: This file is a short term fork of `Text` for the purpose of performance
+ *       testing. Any changes to either this component or `Text` should be avoided
+ *       while this file exists.
+ *
+ *       Specific differences from `Text`:
+ *        - Lazy init Pressability via a nested component
+ *        - Skip children context wrapper when safe.
+ *        - Move props destructuring to function param.
+ */
+const TextOptimized: React.AbstractComponent<TextProps, TextForwardRef> =
+  React.forwardRef(
+    (
+      {
+        accessible,
+        accessibilityLabel,
+        accessibilityState,
+        allowFontScaling,
+        'aria-busy': ariaBusy,
+        'aria-checked': ariaChecked,
+        'aria-disabled': ariaDisabled,
+        'aria-expanded': ariaExpanded,
+        'aria-label': ariaLabel,
+        'aria-selected': ariaSelected,
+        children,
+        ellipsizeMode,
+        disabled,
+        id,
+        nativeID,
+        numberOfLines,
+        onLongPress,
+        onPress,
+        onPressIn,
+        onPressOut,
+        onResponderGrant,
+        onResponderMove,
+        onResponderRelease,
+        onResponderTerminate,
+        onResponderTerminationRequest,
+        onStartShouldSetResponder,
+        pressRetentionOffset,
+        selectable,
+        selectionColor,
+        suppressHighlighting,
+        style,
+        ...restProps
+      }: TextProps,
+      forwardedRef,
+    ) => {
+      const _accessibilityLabel = ariaLabel ?? accessibilityLabel;
+
+      let _accessibilityState: ?TextProps['accessibilityState'] =
+        accessibilityState;
+      if (
+        ariaBusy != null ||
+        ariaChecked != null ||
+        ariaDisabled != null ||
+        ariaExpanded != null ||
+        ariaSelected != null
+      ) {
+        if (_accessibilityState != null) {
+          _accessibilityState = {
+            busy: ariaBusy ?? _accessibilityState.busy,
+            checked: ariaChecked ?? _accessibilityState.checked,
+            disabled: ariaDisabled ?? _accessibilityState.disabled,
+            expanded: ariaExpanded ?? _accessibilityState.expanded,
+            selected: ariaSelected ?? _accessibilityState.selected,
+          };
+        } else {
+          _accessibilityState = {
+            busy: ariaBusy,
+            checked: ariaChecked,
+            disabled: ariaDisabled,
+            expanded: ariaExpanded,
+            selected: ariaSelected,
+          };
+        }
+      }
+
+      const _accessibilityStateDisabled = _accessibilityState?.disabled;
+      const _disabled = disabled ?? _accessibilityStateDisabled;
+
+      const isPressable =
+        (onPress != null ||
+          onLongPress != null ||
+          onStartShouldSetResponder != null) &&
+        _disabled !== true;
+
+      // TODO: Move this processing to the view configuration.
+      const _selectionColor =
+        selectionColor == null ? null : processColor(selectionColor);
+
+      let _style = style;
+      if (__DEV__) {
+        if (PressabilityDebug.isEnabled() && onPress != null) {
+          _style = [style, {color: 'magenta'}];
+        }
+      }
+
+      let _numberOfLines = numberOfLines;
+      if (_numberOfLines != null && !(_numberOfLines >= 0)) {
+        if (__DEV__) {
+          console.error(
+            `'numberOfLines' in <Text> must be a non-negative number, received: ${_numberOfLines}. The value will be set to 0.`,
+          );
+        }
+        _numberOfLines = 0;
+      }
+
+      let _selectable = selectable;
+
+      const processedStyle = flattenStyle(_style);
+      if (processedStyle != null) {
+        if (typeof processedStyle.fontWeight === 'number') {
+          // $FlowFixMe[cannot-write]
+          processedStyle.fontWeight = processedStyle.fontWeight.toString();
+        }
+
+        if (processedStyle.userSelect != null) {
+          _selectable = userSelectToSelectableMap[processedStyle.userSelect];
+          // $FlowFixMe[cannot-write]
+          delete processedStyle.userSelect;
+        }
+
+        if (processedStyle.verticalAlign != null) {
+          // $FlowFixMe[cannot-write]
+          processedStyle.textAlignVertical =
+            verticalAlignToTextAlignVerticalMap[processedStyle.verticalAlign];
+          // $FlowFixMe[cannot-write]
+          delete processedStyle.verticalAlign;
+        }
+      }
+
+      const _nativeID = id ?? nativeID;
+
+      const hasTextAncestor = useContext(TextAncestor);
+      if (hasTextAncestor) {
+        if (isPressable) {
+          return (
+            <NativePressableVirtualText
+              ref={forwardedRef}
+              textProps={{
+                ...restProps,
+                accessibilityLabel: _accessibilityLabel,
+                accessibilityState: _accessibilityState,
+                nativeID: _nativeID,
+                numberOfLines: _numberOfLines,
+                selectable: _selectable,
+                selectionColor: _selectionColor,
+                style: processedStyle,
+                disabled: disabled,
+                children,
+              }}
+              textPressabilityProps={{
+                onLongPress,
+                onPress,
+                onPressIn,
+                onPressOut,
+                onResponderGrant,
+                onResponderMove,
+                onResponderRelease,
+                onResponderTerminate,
+                onResponderTerminationRequest,
+                onStartShouldSetResponder,
+                pressRetentionOffset,
+                suppressHighlighting,
+              }}
+            />
+          );
+        }
+
+        return (
+          <NativeVirtualText
+            {...restProps}
+            accessibilityLabel={_accessibilityLabel}
+            accessibilityState={_accessibilityState}
+            isHighlighted={false}
+            isPressable={false}
+            nativeID={_nativeID}
+            numberOfLines={_numberOfLines}
+            ref={forwardedRef}
+            selectable={_selectable}
+            selectionColor={_selectionColor}
+            style={processedStyle}
+            disabled={disabled}>
+            {children}
+          </NativeVirtualText>
+        );
+      }
+
+      // If the disabled prop and accessibilityState.disabled are out of sync but not both in
+      // falsy states we need to update the accessibilityState object to use the disabled prop.
+      if (
+        _disabled !== _accessibilityStateDisabled &&
+        ((_disabled != null && _disabled !== false) ||
+          (_accessibilityStateDisabled != null &&
+            _accessibilityStateDisabled !== false))
+      ) {
+        _accessibilityState = {..._accessibilityState, disabled: _disabled};
+      }
+
+      const _accessible = Platform.select({
+        ios: accessible !== false,
+        android:
+          accessible == null
+            ? onPress != null || onLongPress != null
+            : accessible,
+        default: accessible,
+      });
+
+      let nativeText = null;
+      if (isPressable) {
+        nativeText = (
+          <NativePressableText
+            ref={forwardedRef}
+            textProps={{
+              ...restProps,
+              accessibilityLabel: _accessibilityLabel,
+              accessibilityState: _accessibilityState,
+              accessible: _accessible,
+              allowFontScaling: allowFontScaling !== false,
+              disabled: _disabled,
+              ellipsizeMode: ellipsizeMode ?? 'tail',
+              nativeID: _nativeID,
+              numberOfLines: _numberOfLines,
+              selectable: _selectable,
+              selectionColor: _selectionColor,
+              style: processedStyle,
+              children,
+            }}
+            textPressabilityProps={{
+              onLongPress,
+              onPress,
+              onPressIn,
+              onPressOut,
+              onResponderGrant,
+              onResponderMove,
+              onResponderRelease,
+              onResponderTerminate,
+              onResponderTerminationRequest,
+              onStartShouldSetResponder,
+              pressRetentionOffset,
+              suppressHighlighting,
+            }}
+          />
+        );
+      } else {
+        nativeText = (
+          <NativeText
+            {...restProps}
+            accessibilityLabel={_accessibilityLabel}
+            accessibilityState={_accessibilityState}
+            accessible={_accessible}
+            allowFontScaling={allowFontScaling !== false}
+            disabled={_disabled}
+            ellipsizeMode={ellipsizeMode ?? 'tail'}
+            isHighlighted={false}
+            nativeID={_nativeID}
+            numberOfLines={_numberOfLines}
+            ref={forwardedRef}
+            selectable={_selectable}
+            selectionColor={_selectionColor}
+            style={processedStyle}>
+            {children}
+          </NativeText>
+        );
+      }
+
+      if (children == null) {
+        return nativeText;
+      }
+
+      // If the children do not contain a JSX element it would not be possible to have a
+      // nested `Text` component so we can skip adding the `TextAncestor` context wrapper
+      // which has a performance overhead. Since we do this for performance reasons we need
+      // to keep the check simple to avoid regressing overall perf. For this reason the
+      // `children.length` constant is set to `3`, this should be a reasonable tradeoff
+      // to capture the majority of `Text` uses but also not make this check too expensive.
+      if (Array.isArray(children) && children.length <= 3) {
+        let hasNonTextChild = false;
+        for (let child of children) {
+          if (child != null && typeof child === 'object') {
+            hasNonTextChild = true;
+            break;
+          }
+        }
+        if (!hasNonTextChild) {
+          return nativeText;
+        }
+      } else if (typeof children !== 'object') {
+        return nativeText;
+      }
+
+      return (
+        <TextAncestor.Provider value={true}>{nativeText}</TextAncestor.Provider>
+      );
+    },
+  );
+
+TextOptimized.displayName = 'TextOptimized';
+
+type TextPressabilityProps = $ReadOnly<{
+  onLongPress?: ?(event: PressEvent) => mixed,
+  onPress?: ?(event: PressEvent) => mixed,
+  onPressIn?: ?(event: PressEvent) => mixed,
+  onPressOut?: ?(event: PressEvent) => mixed,
+  onResponderGrant?: ?(event: PressEvent) => void,
+  onResponderMove?: ?(event: PressEvent) => void,
+  onResponderRelease?: ?(event: PressEvent) => void,
+  onResponderTerminate?: ?(event: PressEvent) => void,
+  onResponderTerminationRequest?: ?() => boolean,
+  onStartShouldSetResponder?: ?() => boolean,
+  pressRetentionOffset?: ?PressRetentionOffset,
+  suppressHighlighting?: ?boolean,
+}>;
+
+/**
+ * Hook that handles setting up Pressability of Text components.
+ *
+ * NOTE: This hook is relatively expensive so it should only be used absolutely necessary.
+ */
+function useTextPressability({
+  onLongPress,
+  onPress,
+  onPressIn,
+  onPressOut,
+  onResponderGrant,
+  onResponderMove,
+  onResponderRelease,
+  onResponderTerminate,
+  onResponderTerminationRequest,
+  onStartShouldSetResponder,
+  pressRetentionOffset,
+  suppressHighlighting,
+}: TextPressabilityProps) {
+  const [isHighlighted, setHighlighted] = useState(false);
+
+  // Setup pressability config and wrap callbacks needs to track the highlight state.
+  const config = useMemo(() => {
+    let _onPressIn = onPressIn;
+    let _onPressOut = onPressOut;
+
+    // Updating isHighlighted causes unnecessary re-renders for platforms that don't use it
+    // in the best case, and cause issues with text selection in the worst case. Forcing
+    // the isHighlighted prop to false on all platforms except iOS.
+    if (Platform.OS === 'ios') {
+      _onPressIn = (event: PressEvent) => {
+        setHighlighted(suppressHighlighting == null || !suppressHighlighting);
+        onPressIn?.(event);
+      };
+
+      _onPressOut = (event: PressEvent) => {
+        setHighlighted(false);
+        onPressOut?.(event);
+      };
+    }
+
+    return {
+      disabled: false,
+      pressRectOffset: pressRetentionOffset,
+      onLongPress,
+      onPress,
+      onPressIn: _onPressIn,
+      onPressOut: _onPressOut,
+    };
+  }, [
+    pressRetentionOffset,
+    onLongPress,
+    onPress,
+    onPressIn,
+    onPressOut,
+    suppressHighlighting,
+  ]);
+
+  // Init the pressability class
+  const eventHandlers = usePressability(config);
+
+  // Create NativeText event handlers which proxy events to pressability
+  const eventHandlersForText = useMemo(
+    () =>
+      eventHandlers == null
+        ? null
+        : {
+            onResponderGrant(event: PressEvent) {
+              eventHandlers.onResponderGrant(event);
+              if (onResponderGrant != null) {
+                onResponderGrant(event);
+              }
+            },
+            onResponderMove(event: PressEvent) {
+              eventHandlers.onResponderMove(event);
+              if (onResponderMove != null) {
+                onResponderMove(event);
+              }
+            },
+            onResponderRelease(event: PressEvent) {
+              eventHandlers.onResponderRelease(event);
+              if (onResponderRelease != null) {
+                onResponderRelease(event);
+              }
+            },
+            onResponderTerminate(event: PressEvent) {
+              eventHandlers.onResponderTerminate(event);
+              if (onResponderTerminate != null) {
+                onResponderTerminate(event);
+              }
+            },
+            onClick: eventHandlers.onClick,
+            onResponderTerminationRequest:
+              onResponderTerminationRequest != null
+                ? onResponderTerminationRequest
+                : eventHandlers.onResponderTerminationRequest,
+            onStartShouldSetResponder:
+              onStartShouldSetResponder != null
+                ? onStartShouldSetResponder
+                : eventHandlers.onStartShouldSetResponder,
+          },
+    [
+      eventHandlers,
+      onResponderGrant,
+      onResponderMove,
+      onResponderRelease,
+      onResponderTerminate,
+      onResponderTerminationRequest,
+      onStartShouldSetResponder,
+    ],
+  );
+
+  // Return the highlight state and NativeText event handlers
+  return useMemo(
+    () => [isHighlighted, eventHandlersForText],
+    [isHighlighted, eventHandlersForText],
+  );
+}
+
+type NativePressableTextProps = $ReadOnly<{
+  textProps: NativeTextProps,
+  textPressabilityProps: TextPressabilityProps,
+}>;
+
+/**
+ * Wrap the NativeVirtualText component and initialize pressability.
+ *
+ * This logic is split out from the main Text component to enable the more
+ * expensive pressability logic to be only initialized when needed.
+ */
+const NativePressableVirtualText: React.AbstractComponent<
+  NativePressableTextProps,
+  TextForwardRef,
+> = React.forwardRef(({textProps, textPressabilityProps}, forwardedRef) => {
+  const [isHighlighted, eventHandlersForText] = useTextPressability(
+    textPressabilityProps,
+  );
+
+  return (
+    <NativeVirtualText
+      {...textProps}
+      {...eventHandlersForText}
+      isHighlighted={isHighlighted}
+      isPressable={true}
+      ref={forwardedRef}
+    />
+  );
+});
+
+/**
+ * Wrap the NativeText component and initialize pressability.
+ *
+ * This logic is split out from the main Text component to enable the more
+ * expensive pressability logic to be only initialized when needed.
+ */
+const NativePressableText: React.AbstractComponent<
+  NativePressableTextProps,
+  TextForwardRef,
+> = React.forwardRef(({textProps, textPressabilityProps}, forwardedRef) => {
+  const [isHighlighted, eventHandlersForText] = useTextPressability(
+    textPressabilityProps,
+  );
+
+  return (
+    <NativeText
+      {...textProps}
+      {...eventHandlersForText}
+      isHighlighted={isHighlighted}
+      isPressable={true}
+      ref={forwardedRef}
+    />
+  );
+});
+
+const userSelectToSelectableMap = {
+  auto: true,
+  text: true,
+  none: false,
+  contain: true,
+  all: true,
+};
+
+const verticalAlignToTextAlignVerticalMap = {
+  auto: 'auto',
+  top: 'top',
+  bottom: 'bottom',
+  middle: 'center',
+};
+
+module.exports = TextOptimized;

package/Libraries/Utilities/ReactNativeTestTools.js

@@ -20,14 +20,8 @@ const View = require('../Components/View/View');
 const Text = require('../Text/Text');
 const {VirtualizedList} = require('@react-native/virtualized-lists');
 const React = require('react');
-const ShallowRenderer = require('react-shallow-renderer');
 const ReactTestRenderer = require('react-test-renderer');
 
-/* $FlowFixMe[not-a-function] (>=0.125.1 site=react_native_fb) This comment
- * suppresses an error found when Flow v0.125.1 was deployed. To see the error,
- * delete this comment and run Flow. */
-// $FlowFixMe[invalid-constructor]
-const shallowRenderer = new ShallowRenderer();
 export type ReactTestInstance = $PropertyType<ReactTestRendererType, 'root'>;
 export type Predicate = (node: ReactTestInstance) => boolean;
 /* $FlowFixMe[value-as-type] (>=0.125.1 site=react_native_fb) This comment
@@ -119,7 +113,7 @@ function expectNoConsoleError() {
   });
 }
 
-function expectRendersMatchingSnapshot(
+async function expectRendersMatchingSnapshot(
   name: string,
   ComponentProvider: () => React.Element<any>,
   unmockComponent: () => mixed,
@@ -128,7 +122,9 @@ function expectRendersMatchingSnapshot(
 
   jest.resetAllMocks();
 
-  instance = ReactTestRenderer.create(<ComponentProvider />);
+  await ReactTestRenderer.act(() => {
+    instance = ReactTestRenderer.create(<ComponentProvider />);
+  });
   expect(instance).toMatchSnapshot(
     'should deep render when mocked (please verify output manually)',
   );
@@ -136,22 +132,9 @@ function expectRendersMatchingSnapshot(
   jest.resetAllMocks();
   unmockComponent();
 
-  instance = shallowRenderer.render(<ComponentProvider />);
-  expect(instance).toMatchSnapshot(
-    `should shallow render as <${name} /> when not mocked`,
-  );
-
-  jest.resetAllMocks();
-
-  instance = shallowRenderer.render(<ComponentProvider />);
-  expect(instance).toMatchSnapshot(
-    `should shallow render as <${name} /> when mocked`,
-  );
-
-  jest.resetAllMocks();
-  unmockComponent();
-
-  instance = ReactTestRenderer.create(<ComponentProvider />);
+  await ReactTestRenderer.act(() => {
+    instance = ReactTestRenderer.create(<ComponentProvider />);
+  });
   expect(instance).toMatchSnapshot(
     'should deep render when not mocked (please verify output manually)',
   );

package/Libraries/__tests__/ButtonWin32-test.js

@@ -2,15 +2,16 @@
 'use strict';
 
 const React = require('react');
-const ReactTestRenderer = require('react-test-renderer');
+const renderer = require('react-native/jest/renderer');
 
 const {ButtonWin32} = require('@office-iss/react-native-win32');
 
 describe('ButtonWin32', () => {
-  it('renders native component', () => {
-    const component = ReactTestRenderer.create(
-      <ButtonWin32/>
-    );
-    expect(component).toMatchSnapshot();
+  it('renders native component', async () => {
+    expect(
+      await renderer.create(
+        <ButtonWin32/>,
+      ),
+    ).toMatchSnapshot();
   });
 });

package/Libraries/promiseRejectionTrackingOptions.js

@@ -52,6 +52,7 @@ let rejectionTrackingOptions: $NonMaybeType<Parameters<enable>[0]> = {
           substitutions: [],
         },
         componentStack: [],
+        componentStackType: null,
         stack,
         category: 'possible_unhandled_promise_rejection',
       });

package/jest/renderer.js

@@ -9,22 +9,33 @@
  * @oncall react_native
  */
 
+import type {ReactTestRenderer} from 'react-test-renderer';
+
+import nullthrows from 'nullthrows';
 import * as React from 'react';
-import ShallowRenderer from 'react-shallow-renderer';
 import TestRenderer from 'react-test-renderer';
 
-const renderer = new ShallowRenderer();
-
-export const shallow = (Component: React.Element<any>): any => {
-  const Wrapper = (): React.Element<any> => Component;
-
-  return renderer.render(<Wrapper />);
-};
+export async function create(
+  Component: React.Element<any>,
+): Promise<ReactTestRenderer> {
+  let component;
+  await TestRenderer.act(async () => {
+    component = TestRenderer.create(Component);
+  });
+  return nullthrows(component);
+}
 
-export const shallowRender = (Component: React.Element<any>): any => {
-  return renderer.render(Component);
-};
+export async function unmount(testRenderer: ReactTestRenderer) {
+  await TestRenderer.act(async () => {
+    testRenderer.unmount();
+  });
+}
 
-export const create = (Component: React.Element<any>): any => {
-  return TestRenderer.create(Component);
-};
+export async function update(
+  testRenderer: ReactTestRenderer,
+  element: React.Element<any>,
+) {
+  await TestRenderer.act(async () => {
+    testRenderer.update(element);
+  });
+}

package/jest/setup.js

@@ -9,6 +9,11 @@
 
 'use strict';
 
+global.IS_REACT_ACT_ENVIRONMENT = true;
+// Suppress the `react-test-renderer` warnings until New Architecture and legacy
+// mode are no longer supported by React Native.
+global.IS_REACT_NATIVE_TEST_ENVIRONMENT = true;
+
 const MockNativeMethods = jest.requireActual('./MockNativeMethods');
 const mockComponent = jest.requireActual('./mockComponent');