Merge pull request #28549 from software-mansion-labs/Sebryu-performan…

…ce-context-optimization Optimized context usages and set up eslint rule for optimization
Expensify · Oct 19, 2023 · 2b98d2b · 2b98d2b
2 parents 550dbf5 + cc4052c
commit 2b98d2b
Show file tree

Hide file tree

Showing 12 changed files with 114 additions and 132 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -37,10 +37,12 @@ module.exports = {
     overrides: [
         {
             files: ['*.js', '*.jsx', '*.ts', '*.tsx'],
+            plugins: ['react'],
             rules: {
                 'rulesdir/no-multiple-onyx-in-file': 'off',
                 'rulesdir/onyx-props-must-have-default': 'off',
                 'react-native-a11y/has-accessibility-hint': ['off'],
+                'react/jsx-no-constructed-context-values': 'error',
                 'react-native-a11y/has-valid-accessibility-descriptors': [
                     'error',
                     {

diff --git a/src/components/AnimatedStep/AnimatedStepProvider.js b/src/components/AnimatedStep/AnimatedStepProvider.js
@@ -1,4 +1,4 @@
-import React, {useState} from 'react';
+import React, {useMemo, useState} from 'react';
 import PropTypes from 'prop-types';
 import AnimatedStepContext from './AnimatedStepContext';
 import CONST from '../../CONST';
@@ -9,8 +9,9 @@ const propTypes = {
 
 function AnimatedStepProvider({children}) {
     const [animationDirection, setAnimationDirection] = useState(CONST.ANIMATION_DIRECTION.IN);
+    const contextValue = useMemo(() => ({animationDirection, setAnimationDirection}), [animationDirection, setAnimationDirection]);
 
-    return <AnimatedStepContext.Provider value={{animationDirection, setAnimationDirection}}>{children}</AnimatedStepContext.Provider>;
+    return <AnimatedStepContext.Provider value={contextValue}>{children}</AnimatedStepContext.Provider>;
 }
 
 AnimatedStepProvider.propTypes = propTypes;

diff --git a/src/components/Attachments/AttachmentCarousel/Pager/index.js b/src/components/Attachments/AttachmentCarousel/Pager/index.js
@@ -1,5 +1,5 @@
 /* eslint-disable es/no-optional-chaining */
-import React, {useRef, useState, useImperativeHandle} from 'react';
+import React, {useRef, useState, useImperativeHandle, useMemo} from 'react';
 import {View} from 'react-native';
 import PropTypes from 'prop-types';
 import {GestureHandlerRootView, createNativeWrapper} from 'react-native-gesture-handler';
@@ -126,22 +126,25 @@ function AttachmentCarouselPager({
         scrollEnabled: shouldPagerScroll.value,
     }));
 
+    const contextValue = useMemo(
+        () => ({
+            canvasWidth: containerWidth,
+            canvasHeight: containerHeight,
+            isScrolling,
+            pagerRef,
+            shouldPagerScroll,
+            onPinchGestureChange,
+            onTap,
+            onSwipe,
+            onSwipeSuccess,
+            onSwipeDown,
+        }),
+        [containerWidth, containerHeight, isScrolling, pagerRef, shouldPagerScroll, onPinchGestureChange, onTap, onSwipe, onSwipeSuccess, onSwipeDown],
+    );
+
     return (
         <GestureHandlerRootView style={styles.flex1}>
-            <AttachmentCarouselPagerContext.Provider
-                value={{
-                    canvasWidth: containerWidth,
-                    canvasHeight: containerHeight,
-                    isScrolling,
-                    pagerRef,
-                    shouldPagerScroll,
-                    onPinchGestureChange,
-                    onTap,
-                    onSwipe,
-                    onSwipeSuccess,
-                    onSwipeDown,
-                }}
-            >
+            <AttachmentCarouselPagerContext.Provider value={contextValue}>
                 <AnimatedPagerView
                     pageMargin={40}
                     offscreenPageLimit={1}

diff --git a/src/components/DragAndDrop/Provider/index.js b/src/components/DragAndDrop/Provider/index.js
@@ -1,5 +1,5 @@
 import _ from 'underscore';
-import React, {useRef, useCallback, useEffect} from 'react';
+import React, {useRef, useCallback, useEffect, useMemo} from 'react';
 import {View} from 'react-native';
 import {PortalHost} from '@gorhom/portal';
 import Str from 'expensify-common/lib/str';
@@ -37,8 +37,9 @@ function DragAndDropProvider({children, isDisabled = false, setIsDraggingOver =
         setIsDraggingOver(isDraggingOver);
     }, [isDraggingOver, setIsDraggingOver]);
 
+    const contextValue = useMemo(() => ({isDraggingOver, setOnDropHandler, dropZoneID: dropZoneID.current}), [isDraggingOver, setOnDropHandler]);
     return (
-        <DragAndDropContext.Provider value={{isDraggingOver, setOnDropHandler, dropZoneID: dropZoneID.current}}>
+        <DragAndDropContext.Provider value={contextValue}>
             <View
                 ref={(e) => (dropZone.current = e)}
                 style={[styles.flex1, styles.w100, styles.h100]}

diff --git a/src/components/PopoverProvider/index.js b/src/components/PopoverProvider/index.js
@@ -118,18 +118,17 @@ function PopoverContextProvider(props) {
         [closePopover],
     );
 
-    return (
-        <PopoverContext.Provider
-            value={{
-                onOpen,
-                close: closePopover,
-                popover: activePopoverRef.current,
-                isOpen,
-            }}
-        >
-            {props.children}
-        </PopoverContext.Provider>
+    const contextValue = React.useMemo(
+        () => ({
+            onOpen,
+            close: closePopover,
+            popover: activePopoverRef.current,
+            isOpen,
+        }),
+        [onOpen, closePopover, isOpen],
     );
+
+    return <PopoverContext.Provider value={contextValue}>{props.children}</PopoverContext.Provider>;
 }
 
 PopoverContextProvider.defaultProps = defaultProps;

diff --git a/src/components/PopoverProvider/index.native.js b/src/components/PopoverProvider/index.native.js
@@ -15,18 +15,17 @@ const PopoverContext = React.createContext({
 });
 
 function PopoverContextProvider(props) {
-    return (
-        <PopoverContext.Provider
-            value={{
-                onOpen: () => {},
-                close: () => {},
-                popover: {},
-                isOpen: false,
-            }}
-        >
-            {props.children}
-        </PopoverContext.Provider>
+    const contextValue = React.useMemo(
+        () => ({
+            onOpen: () => {},
+            close: () => {},
+            popover: {},
+            isOpen: false,
+        }),
+        [],
     );
+
+    return <PopoverContext.Provider value={contextValue}>{props.children}</PopoverContext.Provider>;
 }
 
 PopoverContextProvider.defaultProps = defaultProps;

diff --git a/src/components/ScrollViewWithContext.js b/src/components/ScrollViewWithContext.js
@@ -1,4 +1,4 @@
-import React, {useState, useRef} from 'react';
+import React, {useState, useRef, useMemo} from 'react';
 import {ScrollView} from 'react-native';
 
 const MIN_SMOOTH_SCROLL_EVENT_THROTTLE = 16;
@@ -27,6 +27,14 @@ function ScrollViewWithContext({onScroll, scrollEventThrottle, children, innerRe
         setContentOffsetY(event.nativeEvent.contentOffset.y);
     };
 
+    const contextValue = useMemo(
+        () => ({
+            scrollViewRef,
+            contentOffsetY,
+        }),
+        [scrollViewRef, contentOffsetY],
+    );
+
     return (
         <ScrollView
             // eslint-disable-next-line react/jsx-props-no-spreading
@@ -35,14 +43,7 @@ function ScrollViewWithContext({onScroll, scrollEventThrottle, children, innerRe
             onScroll={setContextScrollPosition}
             scrollEventThrottle={scrollEventThrottle || MIN_SMOOTH_SCROLL_EVENT_THROTTLE}
         >
-            <ScrollContext.Provider
-                value={{
-                    scrollViewRef,
-                    contentOffsetY,
-                }}
-            >
-                {children}
-            </ScrollContext.Provider>
+            <ScrollContext.Provider value={contextValue}>{children}</ScrollContext.Provider>
         </ScrollView>
     );
 }

diff --git a/src/components/withKeyboardState.js b/src/components/withKeyboardState.js
@@ -1,4 +1,4 @@
-import React, {forwardRef, createContext, useEffect, useState} from 'react';
+import React, {forwardRef, createContext, useEffect, useState, useMemo} from 'react';
 import {Keyboard} from 'react-native';
 import PropTypes from 'prop-types';
 import getComponentDisplayName from '../libs/getComponentDisplayName';
@@ -31,7 +31,13 @@ function KeyboardStateProvider(props) {
         };
     }, []);
 
-    return <KeyboardStateContext.Provider value={{isKeyboardShown}}>{children}</KeyboardStateContext.Provider>;
+    const contextValue = useMemo(
+        () => ({
+            isKeyboardShown,
+        }),
+        [isKeyboardShown],
+    );
+    return <KeyboardStateContext.Provider value={contextValue}>{children}</KeyboardStateContext.Provider>;
 }
 
 KeyboardStateProvider.propTypes = keyboardStateProviderPropTypes;

diff --git a/src/components/withWindowDimensions/index.js b/src/components/withWindowDimensions/index.js
@@ -1,8 +1,8 @@
-import React, {forwardRef, createContext, useState, useEffect} from 'react';
+import React, {forwardRef, createContext, useState, useEffect, useMemo} from 'react';
 import PropTypes from 'prop-types';
 import lodashDebounce from 'lodash/debounce';
 import {Dimensions} from 'react-native';
-import {SafeAreaInsetsContext} from 'react-native-safe-area-context';
+import {useSafeAreaInsets} from 'react-native-safe-area-context';
 import getComponentDisplayName from '../../libs/getComponentDisplayName';
 import variables from '../../styles/variables';
 import getWindowHeightAdjustment from '../../libs/getWindowHeightAdjustment';
@@ -62,31 +62,23 @@ function WindowDimensionsProvider(props) {
             dimensionsEventListener.remove();
         };
     }, []);
-
-    return (
-        <SafeAreaInsetsContext.Consumer>
-            {(insets) => {
-                const isExtraSmallScreenWidth = windowDimension.windowWidth <= variables.extraSmallMobileResponsiveWidthBreakpoint;
-                const isSmallScreenWidth = windowDimension.windowWidth <= variables.mobileResponsiveWidthBreakpoint;
-                const isMediumScreenWidth = !isSmallScreenWidth && windowDimension.windowWidth <= variables.tabletResponsiveWidthBreakpoint;
-                const isLargeScreenWidth = !isSmallScreenWidth && !isMediumScreenWidth;
-                return (
-                    <WindowDimensionsContext.Provider
-                        value={{
-                            windowHeight: windowDimension.windowHeight + getWindowHeightAdjustment(insets),
-                            windowWidth: windowDimension.windowWidth,
-                            isExtraSmallScreenWidth,
-                            isSmallScreenWidth,
-                            isMediumScreenWidth,
-                            isLargeScreenWidth,
-                        }}
-                    >
-                        {props.children}
-                    </WindowDimensionsContext.Provider>
-                );
-            }}
-        </SafeAreaInsetsContext.Consumer>
-    );
+    const insets = useSafeAreaInsets();
+    const adjustment = getWindowHeightAdjustment(insets);
+    const contextValue = useMemo(() => {
+        const isExtraSmallScreenWidth = windowDimension.windowWidth <= variables.extraSmallMobileResponsiveWidthBreakpoint;
+        const isSmallScreenWidth = windowDimension.windowWidth <= variables.mobileResponsiveWidthBreakpoint;
+        const isMediumScreenWidth = !isSmallScreenWidth && windowDimension.windowWidth <= variables.tabletResponsiveWidthBreakpoint;
+        const isLargeScreenWidth = !isSmallScreenWidth && !isMediumScreenWidth;
+        return {
+            windowHeight: windowDimension.windowHeight + adjustment,
+            windowWidth: windowDimension.windowWidth,
+            isExtraSmallScreenWidth,
+            isSmallScreenWidth,
+            isMediumScreenWidth,
+            isLargeScreenWidth,
+        };
+    }, [windowDimension.windowHeight, windowDimension.windowWidth, adjustment]);
+    return <WindowDimensionsContext.Provider value={contextValue}>{props.children}</WindowDimensionsContext.Provider>;
 }
 
 WindowDimensionsProvider.propTypes = windowDimensionsProviderPropTypes;

diff --git a/src/components/withWindowDimensions/index.native.js b/src/components/withWindowDimensions/index.native.js
@@ -1,7 +1,7 @@
-import React, {forwardRef, createContext, useState, useEffect} from 'react';
+import React, {forwardRef, createContext, useState, useEffect, useMemo} from 'react';
 import PropTypes from 'prop-types';
 import {Dimensions} from 'react-native';
-import {SafeAreaInsetsContext} from 'react-native-safe-area-context';
+import {useSafeAreaInsets} from 'react-native-safe-area-context';
 import getComponentDisplayName from '../../libs/getComponentDisplayName';
 import variables from '../../styles/variables';
 import getWindowHeightAdjustment from '../../libs/getWindowHeightAdjustment';
@@ -60,31 +60,20 @@ function WindowDimensionsProvider(props) {
             dimensionsEventListener.remove();
         };
     }, []);
-
-    return (
-        <SafeAreaInsetsContext.Consumer>
-            {(insets) => {
-                const isExtraSmallScreenWidth = windowDimension.windowWidth <= variables.extraSmallMobileResponsiveWidthBreakpoint;
-                const isSmallScreenWidth = true;
-                const isMediumScreenWidth = false;
-                const isLargeScreenWidth = false;
-                return (
-                    <WindowDimensionsContext.Provider
-                        value={{
-                            windowHeight: windowDimension.windowHeight + getWindowHeightAdjustment(insets),
-                            windowWidth: windowDimension.windowWidth,
-                            isExtraSmallScreenWidth,
-                            isSmallScreenWidth,
-                            isMediumScreenWidth,
-                            isLargeScreenWidth,
-                        }}
-                    >
-                        {props.children}
-                    </WindowDimensionsContext.Provider>
-                );
-            }}
-        </SafeAreaInsetsContext.Consumer>
-    );
+    const insets = useSafeAreaInsets();
+    const adjustment = getWindowHeightAdjustment(insets);
+    const contextValue = useMemo(() => {
+        const isExtraSmallScreenWidth = windowDimension.windowWidth <= variables.extraSmallMobileResponsiveWidthBreakpoint;
+        return {
+            windowHeight: windowDimension.windowHeight + adjustment,
+            windowWidth: windowDimension.windowWidth,
+            isExtraSmallScreenWidth,
+            isSmallScreenWidth: true,
+            isMediumScreenWidth: false,
+            isLargeScreenWidth: false,
+        };
+    }, [windowDimension.windowHeight, windowDimension.windowWidth, adjustment]);
+    return <WindowDimensionsContext.Provider value={contextValue}>{props.children}</WindowDimensionsContext.Provider>;
 }
 
 WindowDimensionsProvider.propTypes = windowDimensionsProviderPropTypes;

diff --git a/src/pages/home/report/ReportActionItem.js b/src/pages/home/report/ReportActionItem.js
@@ -282,6 +282,16 @@ function ReportActionItem(props) {
         [props.report, props.action, props.emojiReactions],
     );
 
+    const contextValue = useMemo(
+        () => ({
+            anchor: popoverAnchorRef,
+            report: props.report,
+            action: props.action,
+            checkIfContextMenuActive: toggleContextMenuFromActiveReportAction,
+        }),
+        [props.report, props.action, toggleContextMenuFromActiveReportAction],
+    );
+
     /**
      * Get the content of ReportActionItem
      * @param {Boolean} hovered whether the ReportActionItem is hovered
@@ -404,14 +414,7 @@ function ReportActionItem(props) {
         } else {
             const hasBeenFlagged = !_.contains([CONST.MODERATION.MODERATOR_DECISION_APPROVED, CONST.MODERATION.MODERATOR_DECISION_PENDING], moderationDecision);
             children = (
-                <ShowContextMenuContext.Provider
-                    value={{
-                        anchor: popoverAnchorRef,
-                        report: props.report,
-                        action: props.action,
-                        checkIfContextMenuActive: toggleContextMenuFromActiveReportAction,
-                    }}
-                >
+                <ShowContextMenuContext.Provider value={contextValue}>
                     {!props.draftMessage ? (
                         <View style={props.displayAsGroup && hasBeenFlagged ? styles.blockquote : {}}>
                             <ReportActionItemMessage
@@ -558,14 +561,7 @@ function ReportActionItem(props) {
         const parentReportAction = ReportActionsUtils.getParentReportAction(props.report);
         if (ReportActionsUtils.isTransactionThread(parentReportAction)) {
             content = (
-                <ShowContextMenuContext.Provider
-                    value={{
-                        anchor: popoverAnchorRef,
-                        report: props.report,
-                        action: props.action,
-                        checkIfContextMenuActive: toggleContextMenuFromActiveReportAction,
-                    }}
-                >
+                <ShowContextMenuContext.Provider value={contextValue}>
                     <MoneyRequestView
                         report={props.report}
                         shouldShowHorizontalRule={!props.shouldHideThreadDividerLine}