Disable attachment carousel scroll when zoomed in #18634

terrysahaidak · 2023-05-09T10:47:22Z

Details

There are many problems with the current image zoom component. First of all, it's deprecated by the authors. There are workarounds for double ckick for zoom, it doesn't zoom when you pinch until you double press etc, but also it uses PanResponder and runs all the logic on the JS thread, so when JS thread is blocked by something it doesn't respond to gestures.

And there was another bug - if you zoom in, the pager's scroll view would scroll alongside the pan responder.
Since the whole component is deprecated and we already have quite a few workarounds I decided to just block the scroll completely when you zoom in, since on iOS it doesn't work properly, on Android it sometimes might work, but there is no clear UX pattern when it works.

There is no easy way to fix this properly so it works on both platforms well.

I already tried:

Using react-native-pager-view and changing scrollEnabled using react-native-reanimated's useAnimatedProps, but it still doesn't allow for the proper swipe to the left/right to change the page
Using react-native-gesture-handler and scroll view where we would block the gesture until we enable it on the UI thread, but it requires the zoom component to be written with reanimated and gesture handler as well, but also this same behavior doesn't properly work on Android, i might require some fixes in the gesture handler code

So in order to properly fix this component for good, we need to rewrite it with gesture-handler and reanimated, so all the logic is running on UI thread, then we can combine gesture-handlers for single tap, double tap, pan and pinch gestures in order to enable rich UX for the image zoom.

But in the meantime this change allows users to actually use the app with a slight inconvenience - they have to zoom out to navigate to the next page.

Fixed Issues

$ #17720
PROPOSAL: GH_LINK_ISSUE(COMMENT)

Tests

Open chat with multiple image attachments
Open image
Zoom in by double tap
Swipe left/right
It should not switch the page until you zoom out by double tap/pinch out
Verify that no errors appear in the JS console

Offline tests

QA Steps

Open chat with multiple image attachments
Open image
Zoom in by double tap
Swipe left/right
It should not switch the page until you zoom out by double tap/pinch out
Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

No changes

Mobile Web - Chrome

No changes

Mobile Web - Safari

No changes

Desktop

No changes

iOS

RPReplay_Final1683628727.mov

Android

telegram-cloud-document-2-5391220435167750468.mp4

melvin-bot · 2023-05-09T10:47:54Z

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

terrysahaidak · 2023-05-09T10:49:13Z

src/components/ImageView/index.native.js

@@ -198,12 +201,15 @@ class ImageView extends PureComponent {
                                    scale: 2,
                                    duration: 100,
                                });
+
+                                this.props.onScaleChanged(2);


onMove will be called after the zoom animation, so it's possible to zoom and swipe and stuck in between the images. Sending scale just when we actually trigger the animation makes this nearly impossible, you should be really fast to catch in between state updates. And this lucky case will be fixed by migration to UI thread only code with gesture handler and reanimated.

Like your explanation, please add comment in code why this manual call is needed

aimane-chnaif · 2023-05-10T08:02:31Z

@terrysahaidak please fix conflict came from prettier

…zoom-ios

terrysahaidak · 2023-05-10T16:56:46Z

@aimane-chnaif thanks a lot. this implementation was discussed basically here in this thread on Slack: https://expensify.slack.com/archives/C035J5C9FAP/p1682027016020719

The current plan we agreed on is to merge the fix to unblock the zoom feature for the users and work on a better implementation altogether.

puneetlath

Seems to make sense to me.

puneetlath · 2023-05-17T21:32:58Z

@aimane-chnaif bump.

aimane-chnaif · 2023-05-19T20:29:58Z

I will review this tomorrow

puneetlath · 2023-05-22T14:46:51Z

@aimane-chnaif bump!

aimane-chnaif · 2023-05-22T14:55:51Z

Now that onScaleChanged is responsive to image as well as pdf, let's update this comment:

App/src/components/AttachmentView.js

Lines 40 to 41 in cb4f7c9

    
           /** Handles scale changed event in PDF component */ 
        
           onScaleChanged: PropTypes.func,

aimane-chnaif · 2023-05-22T15:33:10Z

When double tap, sometimes zoom doesn't work because of Pressable onPress event.
As seen in video, arrow buttons briefly show and disappear when double tap to zoom.
This doesn't happen on pdf. Can we fix this to prevent both events at the same time?

ios-bug.mov

terrysahaidak · 2023-05-23T20:23:01Z

@aimane-chnaif the bug you described is not related to the changes in this PR and is related to the image-zoom library. PDF uses a different zoom implementation this is why it doesn't happen there.

aimane-chnaif · 2023-05-23T20:28:47Z

the bug you described is not related to the changes in this PR and is related to the image-zoom library

@puneetlath mind considering this out of scope here?

puneetlath · 2023-05-25T21:31:05Z

If it exists on main then I think it's fine to consider that out of scope here.

aimane-chnaif · 2023-05-28T14:15:58Z

@terrysahaidak please complete checklist

aimane-chnaif · 2023-06-01T16:28:09Z

@terrysahaidak please complete checklist

Any update?

aimane-chnaif · 2023-06-01T16:29:30Z

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.

Screenshots/Videos

Web

web.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

ios.mov

Android

android.mov

aimane-chnaif

All good!
Just waiting for author checklist to be completed

terrysahaidak · 2023-06-01T17:12:53Z

hey, sorry for the delay, I saw in another merged PR where it also was changing something for iOS/android only and they did not check other platforms since there were no changes and provided screen recordings.

I checked everything.

I'll add the comment in the code as requested in ~2h.

terrysahaidak · 2023-06-02T16:29:12Z

@aimane-chnaif should be good to go!

puneetlath · 2023-06-02T21:16:08Z

@terrysahaidak you have a lint issue.

terrysahaidak · 2023-06-02T21:47:38Z

Edited code using github.dev and as always there are some random eslint/prettier errors :(
Such fixes are so easy to do using it, i wish we would have prettier and stuff also working in there.

puneetlath · 2023-06-02T21:53:03Z

Oh, I've never used it. How could we get prettier working in there?

OSBotify · 2023-06-02T21:58:41Z

✋ 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-06-05T19:25:35Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.3.24-0 🚀

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

OSBotify · 2023-06-07T03:29:25Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.24-5 🚀

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

OSBotify · 2023-06-07T13:21:04Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.24-5 🚀

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

Disable attachment carousel scroll when zoomed in

102509a

terrysahaidak requested a review from a team as a code owner May 9, 2023 10:47

melvin-bot bot requested review from tylerkaraszewski and removed request for a team May 9, 2023 10:47

terrysahaidak commented May 9, 2023

View reviewed changes

aimane-chnaif mentioned this pull request May 9, 2023

[HOLD for payment 2023-06-13] Weird behavior while dragging zoomed image in preview #17720

Closed

6 tasks

Merge remote-tracking branch 'upstream/main' into @terrysahaidak/fix-…

42fc1dd

…zoom-ios

puneetlath requested review from puneetlath and aimane-chnaif May 11, 2023 23:24

puneetlath previously approved these changes May 11, 2023

View reviewed changes

onScaleChanged is used for ImageZoom too now

532582c

terrysahaidak dismissed puneetlath’s stale review via 532582c May 23, 2023 20:25

aimane-chnaif previously approved these changes Jun 1, 2023

View reviewed changes

Add comment about onScaleChange usage

8cb92b1

terrysahaidak dismissed aimane-chnaif’s stale review via 8cb92b1 June 2, 2023 16:28

aimane-chnaif previously approved these changes Jun 2, 2023

View reviewed changes

Linter fixes

cb3d307

terrysahaidak dismissed aimane-chnaif’s stale review via cb3d307 June 2, 2023 21:44

puneetlath approved these changes Jun 2, 2023

View reviewed changes

aimane-chnaif approved these changes Jun 2, 2023

View reviewed changes

puneetlath merged commit aabe713 into Expensify:main Jun 2, 2023

OSBotify mentioned this pull request Jun 5, 2023

Deploy Checklist: New Expensify 2023-06-05 #20195

Closed

51 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Disable attachment carousel scroll when zoomed in #18634

Disable attachment carousel scroll when zoomed in #18634

terrysahaidak commented May 9, 2023 •

edited

Loading

melvin-bot bot commented May 9, 2023

terrysahaidak May 9, 2023

aimane-chnaif May 28, 2023

aimane-chnaif commented May 10, 2023

terrysahaidak commented May 10, 2023

puneetlath left a comment

puneetlath commented May 17, 2023

aimane-chnaif commented May 19, 2023

puneetlath commented May 22, 2023

aimane-chnaif commented May 22, 2023

aimane-chnaif commented May 22, 2023

terrysahaidak commented May 23, 2023

aimane-chnaif commented May 23, 2023

puneetlath commented May 25, 2023

aimane-chnaif commented May 28, 2023

aimane-chnaif commented Jun 1, 2023

aimane-chnaif commented Jun 1, 2023

aimane-chnaif left a comment

terrysahaidak commented Jun 1, 2023

terrysahaidak commented Jun 2, 2023

puneetlath commented Jun 2, 2023

terrysahaidak commented Jun 2, 2023

puneetlath commented Jun 2, 2023

OSBotify commented Jun 2, 2023

OSBotify commented Jun 5, 2023

OSBotify commented Jun 7, 2023

OSBotify commented Jun 7, 2023

Disable attachment carousel scroll when zoomed in #18634

Disable attachment carousel scroll when zoomed in #18634

Conversation

terrysahaidak commented May 9, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 9, 2023

terrysahaidak May 9, 2023

Choose a reason for hiding this comment

aimane-chnaif May 28, 2023

Choose a reason for hiding this comment

aimane-chnaif commented May 10, 2023

terrysahaidak commented May 10, 2023

puneetlath left a comment

Choose a reason for hiding this comment

puneetlath commented May 17, 2023

aimane-chnaif commented May 19, 2023

puneetlath commented May 22, 2023

aimane-chnaif commented May 22, 2023

aimane-chnaif commented May 22, 2023

terrysahaidak commented May 23, 2023

aimane-chnaif commented May 23, 2023

puneetlath commented May 25, 2023

aimane-chnaif commented May 28, 2023

aimane-chnaif commented Jun 1, 2023

aimane-chnaif commented Jun 1, 2023

Reviewer Checklist

Screenshots/Videos

aimane-chnaif left a comment

Choose a reason for hiding this comment

terrysahaidak commented Jun 1, 2023

terrysahaidak commented Jun 2, 2023

puneetlath commented Jun 2, 2023

terrysahaidak commented Jun 2, 2023

puneetlath commented Jun 2, 2023

OSBotify commented Jun 2, 2023

OSBotify commented Jun 5, 2023

OSBotify commented Jun 7, 2023

OSBotify commented Jun 7, 2023

terrysahaidak commented May 9, 2023 •

edited

Loading