fix: ProfileAvatar (modal) page has no slide in animation by chrispader · Pull Request #53475 · Expensify/App

chrispader · 2024-12-03T15:50:44Z

Explanation of Change

This PR includes a temporary fix for the slide in animations of modal screens like the ProfileAvatar screen. The reason the animation was not visible is because the screens with NativeStack only get mounted once we navigate there and the screen has not finished rendering/mounting when the modal animates in.

Similarly, when we animate the modal out, we'll have to delay the back navigation by the modal animation duration.

Ultimately, we should think about migrating react-native-modal/RN Modal screens to @react-navigation modal screens.

Fixed Issues

$ #53362
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Go to a report -> Profile
Press on the avatar
Make sure the modal slide in animation is visible and smooth
Press on the back button
Make sure the slide out animation is visible and smooth

Offline tests

QA Steps

Same as in Tests.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen_Recording_20241203_211213_New.Expensify.Dev.mp4

Android: mWeb Chrome

iOS: Native

Uploading Simulator Screen Recording - iPhone 16 Pro - 2024-12-03 at 20.54.28.mp4…

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2024-12-03.at.21.14.39.mov

MacOS: Desktop

melvin-bot · 2024-12-03T15:51:17Z

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

jasperhuangg · 2024-12-03T17:44:39Z

Assigning reviewers from the issue

ikevin127 · 2024-12-03T18:28:48Z

@chrispader Would this work the same using InteractionManager.runAfterInteractions instead of setTimeout ? I'd go for that if it works the same, in order to avoid the other timeout variant.

Otherwise, if we keep the setTimeout, then we should use a variable from CONST for the timeout delay, either of the two:

CONST.ANIMATED_TRANSITION (300ms)
CONST.ANIMATION_IN_TIMING (100ms)

and also make sure to clear the timeout on component unmount.

Everything else looks good, will start working on the checklist shortly!

ikevin127 · 2024-12-03T19:57:44Z

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: Nativex
- 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

android.mp4

Android: mWeb Chrome

Uploading android-mweb.mp4…

iOS: Native

ios.mp4

iOS: mWeb Safari

ios-mweb.mp4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

chrispader · 2024-12-03T20:04:10Z

@chrispader Would this work the same using InteractionManager.runAfterInteractions instead of setTimeout ? I'd go for that if it works the same, in order to avoid the other timeout variant.

You're right, for the slide in animation we can use the InteractionManager.

Otherwise, if we keep the setTimeout, then we should use a variable from CONST for the timeout delay, either of the two:

CONST.ANIMATED_TRANSITION (300ms)

For the slide out animation, we'll still need to use the timeout with CONST.ANIMATED_TRANSITION, since we only want to navigate after the modal has finished animating.

chrispader · 2024-12-03T20:25:54Z

@mountiny i created a tracking issue for a more holistic solution to this here: #53493

ikevin127

⚠️ Approved with one issue found during testing on iOS: Native:

ios.mp4

There seems to be a UI artifact when closing the modal, right before getting off the screen it seems to get stuck for a second, it's like a frame drop right before going away which causes the out animation to not qualify as smooth as required in Tests steps.

I checked this on current staging / dev code and the issue is not present there because there's no animation when closing the modal so I'm not sure whether the issue was there before the "no slide animation" issue surfaced.

I'm not sure if we're supposed to deal with the issue in this PR or we're good to move forward the way it is.

cc @mountiny for take on this

mountiny

I agree that the bug that @ikevin127 found should be addressed

mountiny · 2024-12-04T11:54:09Z

src/pages/settings/Profile/ProfileAvatar.tsx

            source={UserUtils.getFullSizeAvatar(avatarURL, accountID)}
            onModalClose={() => {
-                Navigation.goBack();
+                setTimeout(() => {


@chrispader I know this is tough, but we are trying not to use setTimeout in the App as its a fragile workaround usually, could you think of any other way to achieve this?

InteractionManager.runAfterInteractions should work there as well.

i tried but it didn't work. There are no interactions to run this after. Rather we essentially want to run it "before" interactions such as the navigation back (screen unmount)

Since react-native-modal also doesn't have a callback for when the close animation is completed, i don't think we can implement this differently without yet again patching the library.

mountiny

@chrispader Can you please add this to the issue to migrate to react-navigation modal so we do not forget to remove this once we migrate over?

chrispader · 2024-12-06T16:25:00Z

@chrispader Can you please add this to the issue to migrate to react-navigation modal so we do not forget to remove this once we migrate over?

yes, will do!

OSBotify · 2024-12-06T16:29:31Z

✋ 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-09T16:29:14Z

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

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

iwiznia · 2024-12-09T20:39:42Z

This caused regression: #53777
Reverting here #53784

github-actions · 2024-12-10T22:47:28Z

🚀 Deployed to production by https://github.com/luacmartins in version: 9.0.73-8 🚀

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

chrispader · 2024-12-23T14:41:28Z

This issue can potentially be fixed by #53493

fix: no animation on modal screens

67cc4f0

chrispader requested a review from a team as a code owner December 3, 2024 15:50

melvin-bot bot requested review from jasperhuangg and removed request for a team December 3, 2024 15:51

chrispader mentioned this pull request Dec 3, 2024

[HOLD 53493] [$250] iOS - Attachment - No sliding in animation when opening attachment #53362

Closed

8 tasks

jasperhuangg requested review from ikevin127 and mountiny and removed request for jasperhuangg December 3, 2024 17:44

chrispader added 4 commits December 3, 2024 20:39

fix: use InteractinManager in BaseModal implementation

3d8f108

revert: changes from AttachmentModal

c769399

remove unused code

2fee013

fix: withOnyx -> useOnyx migration

0bb54d6

chrispader mentioned this pull request Dec 3, 2024

[Due for payment 2026-03-30] [Due for payment 2026-03-13] Replace modal screens with modals from @react-navigation #53493

Open

ikevin127 approved these changes Dec 3, 2024

View reviewed changes

mountiny assigned chrispader Dec 4, 2024

mountiny requested changes Dec 4, 2024

View reviewed changes

mountiny approved these changes Dec 6, 2024

View reviewed changes

mountiny merged commit b678c54 into Expensify:main Dec 6, 2024

github-actions bot mentioned this pull request Dec 9, 2024

Deploy Checklist: New Expensify 2024-12-09 #53762

Closed

70 tasks

ishpaul777 mentioned this pull request Dec 9, 2024

Revert "fix: ProfileAvatar (modal) page has no slide in animation" #53784

Merged

FitseTLT mentioned this pull request Dec 9, 2024

[$250] Blank RHP opens for a moment when validating a new contact method #53772

Closed

8 tasks

iwiznia mentioned this pull request Dec 9, 2024

QAB missing tooltip #53777

Closed

8 tasks

Conversation

chrispader commented Dec 3, 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!

melvin-bot bot commented Dec 3, 2024

Uh oh!

jasperhuangg commented Dec 3, 2024

Uh oh!

ikevin127 commented Dec 3, 2024

Uh oh!

ikevin127 commented Dec 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

chrispader commented Dec 3, 2024

Uh oh!

chrispader commented Dec 3, 2024

Uh oh!

ikevin127 left a comment

Choose a reason for hiding this comment

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

mountiny Dec 4, 2024

Choose a reason for hiding this comment

Uh oh!

ikevin127 Dec 4, 2024

Choose a reason for hiding this comment

Uh oh!

chrispader Dec 5, 2024

Choose a reason for hiding this comment

Uh oh!

chrispader Dec 5, 2024

Choose a reason for hiding this comment

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

chrispader commented Dec 6, 2024

Uh oh!

OSBotify commented Dec 6, 2024

Uh oh!

github-actions bot commented Dec 9, 2024

Uh oh!

iwiznia commented Dec 9, 2024

Uh oh!

github-actions bot commented Dec 10, 2024

Uh oh!

chrispader commented Dec 23, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

chrispader commented Dec 3, 2024 •

edited

Loading

ikevin127 commented Dec 3, 2024 •

edited

Loading