Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix image moves permanently when swipe down #51921

Conversation

bernhardoj
Copy link
Contributor

@bernhardoj bernhardoj commented Nov 2, 2024

Explanation of Change

When swiping down an image attachment, it doesn't go back to its place. The root of the issue is the function that captured an old canvas value. This PR fixes it by making sure the canvas size is added to the useCallback deps.

Fixed Issues

$ #51465
PROPOSAL: #51465 (comment)

Tests

Same as QA Steps

  • Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

  1. Send at least 2 attachments to any chat
  2. Open one of the attachments
  3. Swipe the image down a little
  4. Verify it goes back to its initial position
  5. Verify you can't swipe left/right while swiping down
  6. Verify you can't swipe down while swiping left/right

Web/Desktop: There is no swipe

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (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
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • 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 followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • 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
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • 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.

Screenshots/Videos

Android: Native
android.mp4
Android: mWeb Chrome
iOS: Native
ios.mp4
iOS: mWeb Safari
ios.mweb.mp4
MacOS: Chrome / Safari
web.mp4
MacOS: Desktop
desktop.mp4

@bernhardoj bernhardoj requested a review from a team as a code owner November 2, 2024 03:45
@melvin-bot melvin-bot bot requested a review from brunovjk November 2, 2024 03:45
Copy link

melvin-bot bot commented Nov 2, 2024

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

@melvin-bot melvin-bot bot removed the request for review from a team November 2, 2024 03:45
@bernhardoj
Copy link
Contributor Author

Swiping the image on mWeb chrome throws an error (on main too).

Screenshot 2024-11-02 at 11 41 23

@bernhardoj
Copy link
Contributor Author

Additional videos:

Double tap zoom:

double.tap.zoom.mp4

Pinch:

pinch.mp4

Avatar crop modal:

avatar.mp4

@brunovjk
Copy link
Contributor

brunovjk commented Nov 4, 2024

@bernhardoj If we have just one image, everything looks fine to me, but if we upload two images, especially with different heights, then swipe a bit to the side, so that you can see both images, and then swipe down, something strange is happening:

51921_ios_native_bug.mov

Can you reproduce it? I haven't tested it in main yet. I'll take a look and see if I can find the root. Thanks.

@bernhardoj
Copy link
Contributor Author

Not exactly the same, but it always behave strangely after uploading a new image, on main too.

asd.mp4
ios.mp4

@brunovjk
Copy link
Contributor

brunovjk commented Nov 4, 2024

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.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
51921_android_native.mov
Android: mWeb Chrome
51921_android_web.mov
iOS: Native
51921_ios_native.mov
iOS: mWeb Safari
51921_ios_web.mov
MacOS: Chrome / Safari
51921_web_chorme.mov
MacOS: Desktop
51921_web_desktop.mov

@brunovjk
Copy link
Contributor

brunovjk commented Nov 4, 2024

Not exactly the same, but it always behave strangely after uploading a new image, on main too.

True, however, apart from this strange behavior, I believe that the problem we are trying to solve still persists, If we only have one image, everything works fine, with two:

Screen.Recording.2024-11-04.at.15.29.19.mov

What do you think @bernhardoj?

@bernhardoj
Copy link
Contributor Author

I'll take a look.

@brunovjk
Copy link
Contributor

brunovjk commented Nov 5, 2024

Gerat! Let me know if I can help in any way.

@bernhardoj
Copy link
Contributor Author

I'm having problem with my iOS. It doesn't respond to press.

@bernhardoj
Copy link
Contributor Author

It works normally back and I can repro this. The root cause is that the finishPanGesture isn't called because shouldDisableTransformationGestures is true.

// If we are swiping (in the pager), we don't want to return to boundaries
if (shouldDisableTransformationGestures.value) {
return;
}
finishPanGesture();

From the comment, looks like it's expected?

@brunovjk
Copy link
Contributor

brunovjk commented Nov 7, 2024

From the comment, looks like it's expected?

I see, thanks for clarifying, that makes sense. @bernhardoj what do you think about preventing swiping in more than one direction? Example: preventing "swiping sideways" if we are performing another gesture, in this case "swiping down". Not allowing two movements to be made at the same time. I tested it on Whatsapp and this is how they do it there, I couldn't record a video to illustrate it better, but if it wasn't clear, let me know. Do you think it would be feasible here? Thank you.

@bernhardoj
Copy link
Contributor Author

Yeah, I prefer to prevent that too, but I think we need the team's input first about changing this behavior.

@Julesssss
Copy link
Contributor

Yeah I totally agree with the suggestion of only allowing swiping in one direction at a time 👍

@brunovjk
Copy link
Contributor

brunovjk commented Nov 9, 2024

Nice. @bernhardoj do you think we can make these changes here? Thanks.

@bernhardoj
Copy link
Contributor Author

Updated. Please check

@brunovjk
Copy link
Contributor

Nice! Looking good, except for one detail: when adding a new photo, we could skip the upload by swiping the image down:

iOS: Native - main
Screen.Recording.2024-11-11.at.10.49.36.mov

Now, after the changes, I can't:

iOS: Native - testing PR
Screen.Recording.2024-11-11.at.10.50.37.mov

@bernhardoj, was that intentional? Other than that, everything else looks great.

}
// eslint-disable-next-line react-compiler/react-compiler, no-param-reassign
isPagerScrollEnabled.value = !current;
},
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed. In non-carousel, changing isScrollEnabled, changes the nope shared value here

isPagerScrolling: nope,
isScrollEnabled: nope,

which sets isPagerScrolling to true too, disabling the pan gesture.

Copy link
Contributor

@brunovjk
Copy link
Contributor

Thanks for the changes @bernhardoj, in native everything looks good now:

Android: Native
51921_android_native.mov
iOS: Native
51921_ios_native.mov

However, in mobile web, when we already have some images uploaded, I can't dismiss the image by swiping down:

Android: mWeb Chrome
51921_android_web.mov
iOS: mWeb Safari
51921_ios_web.mov

Otherwise everything looks fine:

MacOS: Chrome / Safari
51921_web_chorme.mov
MacOS: Desktop
51921_web_desktop.mov

Let me know if I can help in any way. Thank you.

@@ -201,12 +201,12 @@ function AttachmentCarousel({report, source, onNavigate, setDownloadButtonVisibi
activePage: 0,
pagerRef,
isPagerScrolling: nope,
isScrollEnabled: nope,
isScrollEnabled,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed. Same with the previous issue.

@brunovjk
Copy link
Contributor

Sorry @bernhardoj, but it seems to be worse on mWeb:

mobile_mWeb
mobile_mWeb.mov

In native still fine:

native
native.mov

Do you have any idea what it could be? Let me know if you find anything.

scrollTo(scrollRef, page * cellWidth - translationX, 0, false);
})
.onEnd(({translationX, velocityX}) => {
if (scale.current !== 1) {
if (!isScrollEnabled.value) {
return;
}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed. The scroll stuck because we swipe down while scrolling, making isScrollEnabled false. Now I update isPagerScrolling while scrolling.

@@ -253,11 +257,12 @@ function AttachmentCarousel({report, source, onNavigate, setDownloadButtonVisibi
newIndex = Math.min(attachments.length - 1, Math.max(0, page + delta));
}

isPagerScrolling.value = false;
scrollTo(scrollRef, newIndex * cellWidth, 0, true);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no completion callback when the scroll animation is complete.

Copy link
Contributor

@brunovjk brunovjk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job @bernhardoj, everything looks good to me now. I retested on all platforms and updated the videos.

@melvin-bot melvin-bot bot requested a review from Julesssss November 13, 2024 11:50
@Julesssss
Copy link
Contributor

One last thing, is there another test we should add to cover the slightly changed behaviour?

...what do you think about preventing swiping in more than one direction? Example: preventing "swiping sideways" if we are performing another gesture, in this case "swiping down". Not allowing two movements to be made at the same time. I tested it on Whatsapp and this is how they do it there

@brunovjk
Copy link
Contributor

brunovjk commented Nov 13, 2024

One last thing, is there another test we should add to cover the slightly changed behaviour?

...what do you think about preventing swiping in more than one direction? Example: preventing "swiping sideways" if we are performing another gesture, in this case "swiping down". Not allowing two movements to be made at the same time. I tested it on Whatsapp and this is how they do it there

Well noted @Julesssss. @bernhardoj can you update the Test Steps for us? Thank you.

@bernhardoj
Copy link
Contributor Author

Added the test.

@brunovjk
Copy link
Contributor

Thank you @bernhardoj! What do you think @Julesssss? Thanks.

@Julesssss
Copy link
Contributor

Thanks, looks good.

@Julesssss Julesssss merged commit b1c1a4b into Expensify:main Nov 13, 2024
19 checks passed
@OSBotify
Copy link
Contributor

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

Copy link
Contributor

🚀 Deployed to staging by https://github.com/Julesssss in version: 9.0.62-0 🚀

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

Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.62-4 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants