Migrate last components to reanimated by sumo-slonik · Pull Request #55202 · Expensify/App

sumo-slonik · 2025-01-14T12:26:09Z

Explanation of Change

Migration of the latest components from animated to reanimated, adding a rule to the linter that blocks animated imports, adding examples of how to create animation code with reanimated, and adding exceptions to the linter in places where migration is not possible due to external libraries being used.

Fixed Issues

$ #52920

Tests

There are no visible changes in the GUI, but you can follow this procedure:

Go to Settings.
Go to Profile.
Go to Display Name.
Make sure the overlay outside of the RHP is greyed and blurred

Verify that no errors appear in the JS console

Offline tests

No needed

QA Steps

Same as test.

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2025-01-14.at.15.24.04.mov

MacOS: Desktop

Screen.Recording.2025-01-14.at.15.37.40.mov

…nunarrow_and_daseoverlat_to_reanimated_II # Conflicts: # src/components/TabSelector/TabSelectorItem.tsx # src/pages/Search/SearchTypeMenuNarrow.tsx

…, migrate base overly

blazejkustra

Awesome work, LGTM

melvin-bot · 2025-01-15T11:45:58Z

@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]

shawnborton · 2025-01-15T14:01:19Z

Is there anything here that needs to be reviewed by the design team?

sumo-slonik · 2025-01-15T14:34:40Z

@shawnborton There are no user-visible changes here. It's just the completion of the optimization that removes animated and replaces it with reanimated. The only noticeable change might be performance improvements.

shawnborton · 2025-01-15T15:22:20Z

Sounds good, thanks for confirming!

shubham1206agra · 2025-01-17T16:19:10Z

    const {translate} = useLocalize();

    return (
        <Animated.View


@sumo-slonik Is there a reason why this component is not being migrated to Reanimated?

BaseOverlay also utilizes react-navigation but in this case, it involves the import:
import { useCardAnimation } from '@react-navigation/stack';
Later, we use useCardAnimation to create opacity in the styles for Animated.View to obtain the animation progress like this:

opacity: current.progress.interpolate({ inputRange: [0, 1], outputRange: [0, variables.overlayOpacity], extrapolate: 'clamp', }),

Due to this integration with react-navigation, migrating this component to Reanimated is not possible.

The useReanimatedTransitionProgress() from react-native-screens could potentially address the issue on native platforms. However, on those platforms, this component appears as follows:

function Overlay() { return null; } Overlay.displayName = 'Overlay'; export default Overlay;

, so migration is not necessary.

@mountiny Do you agree with this? Asking for confirmation.

the explanation sounds good to me

shubham1206agra · 2025-01-20T03:47:33Z

@sumo-slonik Can you resolve conflicts here?

…ng-to_reanimated # Conflicts: # src/components/TabSelector/TabSelectorItem.tsx

sumo-slonik · 2025-01-20T17:15:46Z

@sumo-slonik Can you resolve conflicts here?

Conflicts resolved.

mountiny · 2025-01-21T21:58:28Z

@shubham1206agra thanks for the review, can you please complete the testing now? thank you!

shubham1206agra · 2025-01-22T10:53:31Z

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 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.ts 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.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2025-01-22.at.4.13.19.PM.mov

MacOS: Desktop

Screen.Recording.2025-01-22.at.4.16.18.PM.mov

mountiny

Thanks!

OSBotify · 2025-01-22T16:12:58Z

✋ 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 · 2025-01-23T18:27:52Z

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

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

github-actions · 2025-01-28T01:51:17Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.89-8 🚀

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

sumo-slonik added 7 commits December 20, 2024 16:27

remove animated fromm SearchTypeMenuNarrow.tsx

9b2a0f7

Merge branch 'main' into feature/kuba_nowakowski/migrate_searchtypeme…

68e848c

…nunarrow_and_daseoverlat_to_reanimated_II # Conflicts: # src/components/TabSelector/TabSelectorItem.tsx # src/pages/Search/SearchTypeMenuNarrow.tsx

add sample of reanimated code, add rule to not use animated to linter…

13003f0

…, migrate base overly

add exceptions for restricted imports

dcea680

npm run prettier

baf916e

add exception to restricted import

a9d28d7

fix eslint check

6d1ba82

sumo-slonik changed the title ~~[DRAFT[ Migrate last components to reanimated~~ [DRAFT]Migrate last components to reanimated Jan 14, 2025

blazejkustra approved these changes Jan 14, 2025

View reviewed changes

Comment thread contributingGuides/TS_CHEATSHEET.md Outdated

Comment thread contributingGuides/TS_CHEATSHEET.md

changes after review

351777f

sumo-slonik changed the title ~~[DRAFT]Migrate last components to reanimated~~ Migrate last components to reanimated Jan 15, 2025

sumo-slonik marked this pull request as ready for review January 15, 2025 11:45

sumo-slonik requested review from a team as code owners January 15, 2025 11:45

melvin-bot Bot requested a review from shubham1206agra January 15, 2025 11:45

melvin-bot Bot removed the request for review from a team January 15, 2025 11:45

shawnborton removed the request for review from a team January 15, 2025 15:22

shubham1206agra reviewed Jan 17, 2025

View reviewed changes

Merge branch 'main' into feature/kuba_nowakowski/last_part_of_migrati…

87b281a

…ng-to_reanimated # Conflicts: # src/components/TabSelector/TabSelectorItem.tsx

mountiny assigned sumo-slonik Jan 21, 2025

shubham1206agra approved these changes Jan 22, 2025

View reviewed changes

melvin-bot Bot requested a review from mountiny January 22, 2025 10:53

mountiny approved these changes Jan 22, 2025

View reviewed changes

mountiny merged commit da678d1 into Expensify:main Jan 22, 2025

github-actions Bot mentioned this pull request Jan 23, 2025

Deploy Checklist: New Expensify 2025-01-23 #55657

Closed

melvin-bot Bot mentioned this pull request Jan 28, 2025

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

Closed

Uh oh!

Conversation

sumo-slonik commented Jan 14, 2025 • edited by mountiny 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!

Uh oh!

Uh oh!

melvin-bot Bot commented Jan 15, 2025

Uh oh!

shawnborton commented Jan 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sumo-slonik commented Jan 15, 2025

Uh oh!

shawnborton commented Jan 15, 2025

Uh oh!

shubham1206agra Jan 17, 2025

Choose a reason for hiding this comment

Uh oh!

sumo-slonik Jan 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shubham1206agra Jan 21, 2025

Choose a reason for hiding this comment

Uh oh!

mountiny Jan 21, 2025

Choose a reason for hiding this comment

Uh oh!

shubham1206agra commented Jan 20, 2025

Uh oh!

sumo-slonik commented Jan 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mountiny commented Jan 21, 2025

Uh oh!

shubham1206agra commented Jan 22, 2025

Reviewer Checklist

Screenshots/Videos

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Jan 22, 2025

Uh oh!

github-actions Bot commented Jan 23, 2025

Uh oh!

github-actions Bot commented Jan 28, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

sumo-slonik commented Jan 14, 2025 •

edited by mountiny

Loading

shawnborton commented Jan 15, 2025 •

edited

Loading

sumo-slonik Jan 20, 2025 •

edited

Loading

sumo-slonik commented Jan 20, 2025 •

edited

Loading