[navigation-refactor] Fix animation glitch when navigating in the browser history with swiping iOS Safari #22678

adamgrzybowski · 2023-07-11T19:26:29Z

Details

Description of the problem

This is a patch for react-navigation to remove animation glitches on iOS Safari. These glitches occur when the user wants to navigate in the browser history with the swipe gesture. Quick and partial animation of the transition from the previous page is visible after swiping.

To fix that we need to prevent transition animation for navigation done with gestures.

Solution

Gestures that would trigger navigation in the browser history generate broken touch events so this solution is based on this broken behavior. This will need a rework if the bugs with events in the iOS safari will be fixed.

This solution uses two different broken behaviors to detect if we should animate the transition.

Gestures that would trigger going back in the browser history have a negative pageX value for the touchend event.
Gestures that would trigger going forward in the browser history are ended immediately after starting without proper touchend event emitted.

Edge case

There is one small use case where the animation will be prevented and it shouldn't be:

The user starts the gesture that would trigger going forward in the history but drops it before the threshold to actually trigger the navigation
The user presses one of the browser arrows to navigate in the history.

After one prevented transition animation this solution will work normally until the next case like that.

Video with the example below:

Screen.Recording.2023-07-11.at.21.24.33.mov

Follow up

We may want to contact react-navigation maintainers to see if they are interested in including this solution in their repository. It's hacky but it works. Also, there is a related issue on their GitHub

Note

Those changes are relevant only for the iOS Safari version. They won't affect any other platform. But it's worth checking the Android web version.

Fixed Issues

$ #20886

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

Do these tests on iOS mobile

Test going back with swiping

Open any report
Swipe from left to right to go to the previous page. Do it quickly.
Observe if there is any animation glitch. It would look like the animation of going back is run twice.

Test going back with the back button

Open any report
Press the browser back button
There should be normal animation of going back (previous page animating from left to right)

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Mobile Web - Chrome

Screen.Recording.2023-07-11.at.21.21.04.mov

Mobile Web - Safari

Screen.Recording.2023-07-11.at.20.57.55.mov

Desktop

iOS

Android

melvin-bot · 2023-07-11T19:26:34Z

@fedirjh 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 · 2023-07-14T19:23:35Z

@fedirjh Are you bale to work on this one or should we reassign

fedirjh · 2023-07-14T19:44:04Z

@mountiny Reviewing shortly. The linked issue is on hold for an upstream fix, so shouldn’t we open a similar upstream PR ?

mountiny · 2023-07-14T20:17:10Z

@fedirjh I think we can go ahead with this fix now and @adamgrzybowski will follow up with some upstream pr fix, the main priority is on the resize and performance issue now but after that we should get fix upstream, we dotn want to be maintaining patches

fedirjh · 2023-07-14T21:11:30Z

@adamgrzybowski I run into this error when applying the patch :

…h-for-swipe-ios-safari

adamgrzybowski · 2023-07-18T15:18:37Z

Hey @fedirjh I fixed the patch

fedirjh · 2023-07-18T15:38:07Z

Thank you @adamgrzybowski , reviewing shortly.

fedirjh · 2023-07-21T20:29:48Z

Screenshots/Videos

Web

Web.mp4

Mobile Web - Chrome

Chrome.mp4

Mobile Web - Safari

Safari.mp4

Desktop

Desktop.mp4

iOS

IOS.mp4

Android

Android.mp4

fedirjh · 2023-07-21T20:43:05Z

@adamgrzybowski @mountiny Are we aware of this bug ? The header is updated after navigation , this is not related to this PR:

Bug.mp4

adamgrzybowski · 2023-07-24T12:50:22Z

I haven't seen any issue for that @fedirjh

mountiny · 2023-07-24T12:58:46Z

@fedirjh Is thi happening on main as well? then we can probably proceed.

Do you think we can get through the checklist today? thanks!

fedirjh · 2023-07-24T13:09:36Z

Is this happening on main as well?

Yes it's on main as well. Will report it on slack.

Do you think we can get through the checklist today?

Will do it shortly.

fedirjh · 2023-07-25T00:23:39Z

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 / Chrome
- iOS / native
- iOS / 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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(themeColors.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 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.

fedirjh · 2023-07-25T00:24:25Z

@adamgrzybowski Looks like we are missing testing steps.

fedirjh · 2023-07-25T00:49:23Z

@adamgrzybowski Found this bug when trying to swipe and the keyboard is open , the chat header jumps to the middle of the screen , on main the keyboard is hidden after the swipe gesture is done.

CleanShot.2023-07-25.at.01.34.36.mp4

…h-for-swipe-ios-safari

adamgrzybowski · 2023-07-25T10:21:22Z

@fedirjh I merged the newest main and it works fine now. Thanks!

fedirjh

Looks good to me.

fedirjh · 2023-07-25T11:31:45Z

@adamgrzybowski Could you please add QA testing steps ?

adamgrzybowski · 2023-07-25T11:42:41Z

@fedirjh Done!

mountiny

thanks everyone ❤️ 🚀

OSBotify · 2023-07-25T11:54:13Z

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

OSBotify · 2023-07-26T16:10:46Z

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

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

OSBotify · 2023-07-27T22:08:55Z

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

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

OSBotify · 2023-07-27T22:39:32Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.46-2 🚀

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

OSBotify · 2023-07-31T18:37:24Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.47-6 🚀

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

create patch

fa2cde8

adamgrzybowski requested a review from a team as a code owner July 11, 2023 19:26

melvin-bot bot requested review from fedirjh and removed request for a team July 11, 2023 19:26

mountiny assigned adamgrzybowski Jul 14, 2023

adamgrzybowski added 2 commits July 18, 2023 14:04

Merge branch 'main' into @swm/navigation-refactor-fix-animation-glitc…

ce3f5a3

…h-for-swipe-ios-safari

fix patch

25b8cbb

Merge branch 'main' into @swm/navigation-refactor-fix-animation-glitc…

036e8c3

…h-for-swipe-ios-safari

fedirjh approved these changes Jul 25, 2023

View reviewed changes

melvin-bot bot requested a review from mountiny July 25, 2023 11:28

fedirjh approved these changes Jul 25, 2023

View reviewed changes

mountiny approved these changes Jul 25, 2023

View reviewed changes

mountiny merged commit 104e65a into Expensify:main Jul 25, 2023

OSBotify mentioned this pull request Jul 26, 2023

Deploy Checklist: New Expensify 2023-07-26 #23657

Closed

43 tasks

OSBotify mentioned this pull request Jul 27, 2023

Deploy Checklist: New Expensify 2023-07-27 #23765

Closed

79 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[navigation-refactor] Fix animation glitch when navigating in the browser history with swiping iOS Safari #22678

[navigation-refactor] Fix animation glitch when navigating in the browser history with swiping iOS Safari #22678

adamgrzybowski commented Jul 11, 2023 •

edited

Loading

melvin-bot bot commented Jul 11, 2023

mountiny commented Jul 14, 2023

fedirjh commented Jul 14, 2023

mountiny commented Jul 14, 2023

fedirjh commented Jul 14, 2023

adamgrzybowski commented Jul 18, 2023

fedirjh commented Jul 18, 2023

fedirjh commented Jul 21, 2023

fedirjh commented Jul 21, 2023

adamgrzybowski commented Jul 24, 2023

mountiny commented Jul 24, 2023

fedirjh commented Jul 24, 2023

fedirjh commented Jul 25, 2023 •

edited

Loading

fedirjh commented Jul 25, 2023

fedirjh commented Jul 25, 2023

adamgrzybowski commented Jul 25, 2023

fedirjh left a comment

fedirjh commented Jul 25, 2023

adamgrzybowski commented Jul 25, 2023

mountiny left a comment

OSBotify commented Jul 25, 2023

OSBotify commented Jul 26, 2023

OSBotify commented Jul 27, 2023

OSBotify commented Jul 27, 2023

OSBotify commented Jul 31, 2023

[navigation-refactor] Fix animation glitch when navigating in the browser history with swiping iOS Safari #22678

[navigation-refactor] Fix animation glitch when navigating in the browser history with swiping iOS Safari #22678

Conversation

adamgrzybowski commented Jul 11, 2023 • edited Loading

Details

Description of the problem

Solution

Edge case

Follow up

Note

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 11, 2023

mountiny commented Jul 14, 2023

fedirjh commented Jul 14, 2023

mountiny commented Jul 14, 2023

fedirjh commented Jul 14, 2023

adamgrzybowski commented Jul 18, 2023

fedirjh commented Jul 18, 2023

fedirjh commented Jul 21, 2023

Screenshots/Videos

fedirjh commented Jul 21, 2023

adamgrzybowski commented Jul 24, 2023

mountiny commented Jul 24, 2023

fedirjh commented Jul 24, 2023

fedirjh commented Jul 25, 2023 • edited Loading

Reviewer Checklist

fedirjh commented Jul 25, 2023

fedirjh commented Jul 25, 2023

adamgrzybowski commented Jul 25, 2023

fedirjh left a comment

Choose a reason for hiding this comment

fedirjh commented Jul 25, 2023

adamgrzybowski commented Jul 25, 2023

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Jul 25, 2023

OSBotify commented Jul 26, 2023

OSBotify commented Jul 27, 2023

OSBotify commented Jul 27, 2023

OSBotify commented Jul 31, 2023

adamgrzybowski commented Jul 11, 2023 •

edited

Loading

fedirjh commented Jul 25, 2023 •

edited

Loading