Migrate animated to reanimated Tooltip and Switch by sumo-slonik · Pull Request #53298 · Expensify/App

sumo-slonik · 2024-11-29T07:04:30Z

Explanation of Change

Swap use animated from react-native to react-native-reanimated so we have big performance gains in animations

Fixed Issues

$ #52920

PROPOSAL:
here

Tests

On the web, just hover over any field that should have a tooltip and see if it displays.

expected behavior:

on first hover tooltip appears with animation
if it has not been 1s since the previous hover, the animation is not activated and the tooltip simply appears right away
if it has been 1s, the animation appears

On all platforms switch any switch and see if it works

expected behavior:

every time the swithch is clicked, there is a smooth on and off animation
Verify that no errors appear in the JS console

Offline tests

Are not needed

QA Steps

On the web, just hover over any field that should have a tooltip and see if it displays.

expected behavior:

on first hover tooltip appears with animation
if it has not been 1s since the previous hover, the animation is not activated and the tooltip simply appears right away
if it has been 1s, the animation appears

On all platforms switch any switch and see if it works

expected behavior:

every time the swithch is clicked, there is a smooth on and off animation
Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-11-29.at.11.16.07.mov

Android: mWeb Chrome

Screen.Recording.2024-11-29.at.12.12.29.mov

iOS: Native

Screen.Recording.2024-11-29.at.08.27.07.mov

iOS: mWeb Safari

Screen.Recording.2024-11-29.at.12.02.26.mov

MacOS: Chrome / Safari

Screen.Recording.2024-11-29.at.08.13.22.mov

MacOS: Desktop

Screen.Recording.2024-11-29.at.08.17.10.mov

blazejkustra

Smoothness incoming ❤️ LGTM

melvin-bot · 2024-11-29T12:39:53Z

@shubham1206agra Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

mountiny · 2024-11-30T09:43:55Z

@shubham1206agra kicked off the build, when do you think you can get around to this review?

github-actions · 2024-11-30T09:44:02Z

🚧 @mountiny has triggered a test build. You can view the workflow run here.

mountiny · 2024-11-30T09:51:36Z

Very exciting!

github-actions · 2024-11-30T10:10:36Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/53298/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/53298/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/53298/NewExpensify.dmg	https://53298.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

shubham1206agra · 2024-11-30T13:21:30Z

@shubham1206agra kicked off the build, when do you think you can get around to this review?

@mountiny Doing this now. Works well on my Android device.

shubham1206agra · 2024-11-30T15:04:28Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible 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 checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- 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
- 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 verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
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
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Screen.Recording.2024-11-30.at.8.24.23.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-11-30.at.7.35.22.PM.mov

iOS: Native

Screen.Recording.2024-11-30.at.8.09.07.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-11-30.at.7.28.36.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-11-30.at.7.21.31.PM.mov

MacOS: Desktop

Screen.Recording.2024-11-30.at.7.47.15.PM.mov

mountiny

LGTM! Great job!

OSBotify · 2024-11-30T19:08:20Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

github-actions · 2024-12-02T22:03:06Z

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.70-0 🚀

platform	result
🤖 android 🤖	false ❌
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	success ✅
🍎🔄 iOS HybridApp 🍎🔄	success ✅

github-actions · 2024-12-04T01:12:20Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 9.0.70-9 🚀

platform	result
🤖 android 🤖	skipped 🚫
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	failure ❌
🍎🔄 iOS HybridApp 🍎🔄	failure ❌

shubham1206agra · 2024-12-04T12:27:25Z

                disabledAction?.();
                return;
            }
+            offsetX.set(withTiming(isOn ? OFFSET_X.OFF : OFFSET_X.ON, {duration: 300}));


Sorry, missed this implementation bug which caused #53447

eVoloshchak · 2025-03-21T17:29:45Z

+        const tooltipHorizontalPadding = spacing.ph2.paddingHorizontal * 2;
+        const tooltipWidth = props.tooltipContentWidth && props.tooltipContentWidth + tooltipHorizontalPadding + 1;
+        const isTooltipSizeReady = tooltipWidth !== undefined && props.tooltipWrapperHeight !== undefined;
+        let scale = 1;


✋ Hey, coming from #55848 (comment)
This has caused an issue with tooltip flickering before showing fully

scale here defaults to 1 when isTooltipSizeReady is false, which displays the tooltip even before it's size was calculated. This was resolved by changing this line to let scale = 0, so the tooltip is hidden until the size is calculated
More details: #55848 (comment)

blazejkustra and others added 6 commits November 29, 2024 07:42

Migrate Switch to Reanimated

2403fcd

Tooltip migration

b31d8b0

code review fixes for tooltip

0e71771

Tooltip migration

5937650

code review fixes for tooltip

9f8a42b

new reanimated api instead of .value

daf4697

blazejkustra approved these changes Nov 29, 2024

View reviewed changes

sumo-slonik marked this pull request as ready for review November 29, 2024 12:39

sumo-slonik requested review from a team as code owners November 29, 2024 12:39

melvin-bot Bot requested a review from shubham1206agra November 29, 2024 12:39

melvin-bot Bot removed the request for review from a team November 29, 2024 12:39

blazejkustra mentioned this pull request Nov 29, 2024

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

Closed

mountiny assigned sumo-slonik Nov 30, 2024

mountiny added the Ready To Build label Nov 30, 2024

shubham1206agra approved these changes Nov 30, 2024

View reviewed changes

melvin-bot Bot requested a review from mountiny November 30, 2024 15:04

mountiny approved these changes Nov 30, 2024

View reviewed changes

mountiny merged commit 9056c61 into Expensify:main Nov 30, 2024

github-actions Bot mentioned this pull request Dec 2, 2024

Deploy Checklist: New Expensify 2024-12-02 #53406

Closed

48 tasks

shubham1206agra reviewed Dec 4, 2024

View reviewed changes

eVoloshchak reviewed Mar 21, 2025

View reviewed changes

Conversation

sumo-slonik commented Nov 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

blazejkustra left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot Bot commented Nov 29, 2024

Uh oh!

mountiny commented Nov 30, 2024

Uh oh!

github-actions Bot commented Nov 30, 2024

Uh oh!

mountiny commented Nov 30, 2024

Uh oh!

github-actions Bot commented Nov 30, 2024

Uh oh!

shubham1206agra commented Nov 30, 2024

Uh oh!

shubham1206agra commented Nov 30, 2024

Reviewer Checklist

Screenshots/Videos

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Nov 30, 2024

Uh oh!

github-actions Bot commented Dec 2, 2024

Uh oh!

github-actions Bot commented Dec 4, 2024

Uh oh!

shubham1206agra Dec 4, 2024

Choose a reason for hiding this comment

Uh oh!

eVoloshchak Mar 21, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

sumo-slonik commented Nov 29, 2024 •

edited

Loading