WIP: Replace `react-native` Animated API with `react-native-reanimated` #52956

blazejkustra · 2024-11-22T11:56:07Z

Explanation of Change

Fixed Issues

$ #52920
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

blazejkustra · 2024-11-26T09:07:37Z

src/components/Tooltip/BaseGenericTooltip/index.native.tsx

        () =>
            StyleUtils.getTooltipStyles({
                // eslint-disable-next-line react-compiler/react-compiler
                tooltip: rootWrapper.current,
-                currentSize: animation,
+                currentSize: animation.value,


This line should be removed, right? And the logic inside getTooltipStyles adjusted so that animationStyles aren't returned.

I will correct it, I didn't want to change utils that are already written, but I can safely remove it is not used anywhere

blazejkustra · 2024-11-26T09:07:47Z

src/components/Tooltip/BaseGenericTooltip/index.tsx

        () =>
            StyleUtils.getTooltipStyles({
                tooltip: rootWrapper.current,
-                currentSize: animation,
+                currentSize: animation.value,


blazejkustra · 2024-11-26T09:08:00Z

src/components/Tooltip/BaseGenericTooltip/types.ts

@@ -1,12 +1,13 @@
 import type {Animated} from 'react-native';


Eslint failing @sumo-slonik

blazejkustra · 2024-11-26T09:08:21Z

src/components/Tooltip/GenericTooltip.tsx

+                        runOnJS(() => {
+                            isAnimationCanceledShared.value = !finished;
+                        })();


I'm wondering why do we need to run it on JS thread?

I will correct it in that case if it is not needed :)

blazejkustra · 2024-11-26T09:09:06Z

src/components/Tooltip/GenericTooltip.tsx

+    const animationSharedValue = useSharedValue<number>(0);
+    const isTooltipSenseInitiatorShared = useSharedValue<boolean>(true);
+    const isAnimationCanceledShared = useSharedValue<boolean>(false);


I think we don't need to add SharedValue and Shared suffixes to these variables, what do you think?

I think we can do without it

blazejkustra · 2024-11-26T09:09:54Z

src/components/Tooltip/GenericTooltip.tsx

+                        })();
+                    },
+                ),
+            );
        }
        TooltipSense.activate();
    }, [shouldForceAnimate]);


More ESLint warining, you need to add these shared values as dependencies (they won't cause reruns as these are stable references)

blazejkustra · 2024-11-26T09:10:34Z

src/styles/utils/generators/TooltipStyleUtils/index.ts

@@ -269,6 +276,21 @@ const createTooltipStyleUtils: StyleUtilGenerator<GetTooltipStylesStyleUtil> = (
            },
        };
    },
+
+    // Utility function to create and manage scale animations with React Native Reanimated
+


Suggested change

blazejkustra · 2024-11-26T09:11:09Z

src/styles/utils/generators/TooltipStyleUtils/index.ts

@@ -269,6 +276,21 @@ const createTooltipStyleUtils: StyleUtilGenerator<GetTooltipStylesStyleUtil> = (
            },
        };
    },
+
+    // Utility function to create and manage scale animations with React Native Reanimated


Let's use JSDoc syntax, this way when you hover over functions you get intellisense 😄

Suggested change

// Utility function to create and manage scale animations with React Native Reanimated

/** Utility function to create and manage scale animations with React Native Reanimated */

Migrate Switch to Reanimated

74361e3

blazejkustra mentioned this pull request Nov 22, 2024

[HOLD for payment 2025-01-02] Replace react-native Animated API with react-native-reanimated #52920

Open

Tooltip migration

a7dfc67

blazejkustra commented Nov 26, 2024

View reviewed changes

code review fixes for tooltip

334a0de

sumo-slonik force-pushed the migrate/animated-reanimated branch from b9b6785 to 334a0de Compare November 26, 2024 10:22

sumo-slonik added 3 commits November 27, 2024 14:04

migrate AttachmentModal.tsx

1bc7257

migrate GrowlNotification

4385dcf

migrate TextInput

e20c704

sumo-slonik force-pushed the migrate/animated-reanimated branch from 3744f48 to e20c704 Compare November 28, 2024 12:38

add worklet signatures to functions

46d8efb

blazejkustra closed this Nov 29, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP: Replace `react-native` Animated API with `react-native-reanimated` #52956

WIP: Replace `react-native` Animated API with `react-native-reanimated` #52956

blazejkustra commented Nov 22, 2024 •

edited

Loading

blazejkustra Nov 26, 2024

sumo-slonik Nov 26, 2024

blazejkustra Nov 26, 2024

blazejkustra Nov 26, 2024

blazejkustra Nov 26, 2024

sumo-slonik Nov 26, 2024

blazejkustra Nov 26, 2024

sumo-slonik Nov 26, 2024

blazejkustra Nov 26, 2024

blazejkustra Nov 26, 2024

blazejkustra Nov 26, 2024

		@@ -1,12 +1,13 @@
		import type {Animated} from 'react-native';

	// Utility function to create and manage scale animations with React Native Reanimated
	/** Utility function to create and manage scale animations with React Native Reanimated */

WIP: Replace react-native Animated API with react-native-reanimated #52956

WIP: Replace react-native Animated API with react-native-reanimated #52956

Conversation

blazejkustra commented Nov 22, 2024 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

WIP: Replace `react-native` Animated API with `react-native-reanimated` #52956

WIP: Replace `react-native` Animated API with `react-native-reanimated` #52956

blazejkustra commented Nov 22, 2024 •

edited

Loading