App icon indicating copy to clipboard operation
App copied to clipboard
verified publisher icon Expensify

Fix image moves permanently when swipe down

Open bernhardoj opened this issue 1 year ago • 3 comments

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

$ https://github.com/Expensify/App/issues/51465 PROPOSAL: https://github.com/Expensify/App/issues/51465#issuecomment-2446960948

Tests

Same as QA Steps

  • [x] Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

  1. Send an attachment to any chat
  2. Open the attachment
  3. Swipe the image down a little
  4. Verify it goes back to its initial position
  • [x] Verify that no errors appear in the JS console

PR Author Checklist

  • [x] I linked the correct issue in the ### Fixed Issues section above
  • [x] I wrote clear testing steps that cover the changes made in this PR
    • [x] I added steps for local testing in the Tests section
    • [x] I added steps for the expected offline behavior in the Offline steps section
    • [x] I added steps for Staging and/or Production testing in the QA steps section
    • [x] I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • [x] 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)
    • [x] 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).
  • [x] I included screenshots or videos for tests on all platforms
  • [x] I ran the tests on all platforms & verified they passed on:
    • [x] Android: Native
    • [x] Android: mWeb Chrome
    • [x] iOS: Native
    • [x] iOS: mWeb Safari
    • [x] MacOS: Chrome / Safari
    • [x] MacOS: Desktop
  • [x] 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)
  • [x] I followed proper code patterns (see Reviewing the code)
    • [x] 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)
    • [x] I verified that comments were added to code that is not self explanatory
    • [x] 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.
    • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • [x] 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:
    • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • [x] 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)
    • [x] 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.
    • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
  • [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • [x] I followed the guidelines as stated in the Review Guidelines
  • [x] 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)
  • [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • [x] 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
  • [x] I verified that if a function's arguments changed that all usages have also been updated correctly
  • [x] If any new file was added I verified that:
    • [x] 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
  • [x] If a new CSS style is added I verified that:
    • [x] A similar style doesn't already exist
    • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • [x] 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.
  • [x] 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)
  • [x] 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.
  • [x] 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.
  • [x] 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:
    • [x] I verified that all the inputs inside a form are aligned with each other.
    • [x] I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • [x] 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.
  • [x] 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

https://github.com/user-attachments/assets/76aa79ee-95b9-4607-bc2f-48ba9673d25a

Android: mWeb Chrome
iOS: Native

https://github.com/user-attachments/assets/bcf8204a-190e-42b1-9382-bc5ef8f2f83c

iOS: mWeb Safari

https://github.com/user-attachments/assets/b05fcb86-ad91-4865-ac4f-d184f78e176d

MacOS: Chrome / Safari

https://github.com/user-attachments/assets/425ed9e1-e683-4380-94b5-16f824d80981

MacOS: Desktop

https://github.com/user-attachments/assets/86f5c3e8-ea5a-4972-aa98-a42dda8f0815

bernhardoj avatar Nov 02 '24 03:11 bernhardoj

@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[bot] avatar Nov 02 '24 03:11 melvin-bot[bot]

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

Screenshot 2024-11-02 at 11 41 23

bernhardoj avatar Nov 02 '24 03:11 bernhardoj

Additional videos:

Double tap zoom:

https://github.com/user-attachments/assets/e3746fb8-a831-4b7f-9c35-561dedae0d7e

Pinch:

https://github.com/user-attachments/assets/16d804c6-335e-4034-8488-9b04ddda419e

Avatar crop modal:

https://github.com/user-attachments/assets/5616523d-c628-4d5a-941f-e9236aa33eb6

bernhardoj avatar Nov 02 '24 03:11 bernhardoj

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

https://github.com/user-attachments/assets/ace12fff-79a5-4417-b89e-ba069a400cc5

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.

brunovjk avatar Nov 04 '24 12:11 brunovjk

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

https://github.com/user-attachments/assets/598f1458-1251-4779-a27e-5c746c1e18e9

https://github.com/user-attachments/assets/65963204-84be-40ba-9e69-a601f016837b

bernhardoj avatar Nov 04 '24 13:11 bernhardoj

Reviewer Checklist

  • [x] I have verified the author checklist is complete (all boxes are checked off).
  • [x] I verified the correct issue is linked in the ### Fixed Issues section above
  • [x] I verified testing steps are clear and they cover the changes made in this PR
    • [x] I verified the steps for local testing are in the Tests section
    • [x] I verified the steps for Staging and/or Production testing are in the QA steps section
    • [x] 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)
    • [x] 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)
  • [x] I checked that screenshots or videos are included for tests on all platforms
  • [x] I included screenshots or videos for tests on all platforms
  • [x] I verified tests pass on all platforms & I tested again on:
    • [x] Android: Native
    • [x] Android: mWeb Chrome
    • [x] iOS: Native
    • [x] iOS: mWeb Safari
    • [x] MacOS: Chrome / Safari
    • [x] MacOS: Desktop
  • [x] 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
  • [x] I verified proper code patterns were followed (see Reviewing the code)
    • [x] 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).
    • [x] I verified that comments were added to code that is not self explanatory
    • [x] 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.
    • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • [x] 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)
    • [x] 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.
    • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
  • [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • [x] I verified that this PR follows the guidelines as stated in the Review Guidelines
  • [x] 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)
  • [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • [x] 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
  • [x] If a new component is created I verified that:
    • [x] A similar component doesn't exist in the codebase
    • [x] All props are defined accurately and each prop has a /** comment above it */
    • [x] The file is named correctly
    • [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • [x] The only data being stored in the state is data necessary for rendering and nothing else
    • [x] 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)
    • [x] 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)
    • [x] All JSX used for rendering exists in the render method
    • [x] 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
  • [x] If any new file was added I verified that:
    • [x] 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
  • [x] If a new CSS style is added I verified that:
    • [x] A similar style doesn't already exist
    • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
  • [x] 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.
  • [x] 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)
  • [x] 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.
  • [x] 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.
  • [x] 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:
    • [x] I verified that all the inputs inside a form are aligned with each other.
    • [x] I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • [x] 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.
  • [x] 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.
  • [x] I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

https://github.com/user-attachments/assets/25a90e44-25b3-490d-a81f-e77254ffe537

Android: mWeb Chrome

https://github.com/user-attachments/assets/37a1832a-5c55-4968-b056-38f8a459b7eb

iOS: Native

https://github.com/user-attachments/assets/866035e9-3384-4465-a7f3-10c9758c3a1f

iOS: mWeb Safari

https://github.com/user-attachments/assets/70d205c1-8ec5-4807-8bb9-524d67893c6c

MacOS: Chrome / Safari

https://github.com/user-attachments/assets/db7497ec-4277-4f24-8f35-e0d171722176

MacOS: Desktop

https://github.com/user-attachments/assets/960e5b22-a9c3-498a-9407-4f07d66fcead

brunovjk avatar Nov 04 '24 14:11 brunovjk

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:

https://github.com/user-attachments/assets/beeeb4aa-d328-4a48-aff1-8807fb15d315

What do you think @bernhardoj?

brunovjk avatar Nov 04 '24 18:11 brunovjk

I'll take a look.

bernhardoj avatar Nov 05 '24 11:11 bernhardoj

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

brunovjk avatar Nov 05 '24 12:11 brunovjk

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

bernhardoj avatar Nov 06 '24 08:11 bernhardoj

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

https://github.com/Expensify/App/blob/afa7b33107747d0242acfd01d032d5339be390d9/src/components/MultiGestureCanvas/usePanGesture.ts#L233-L238

From the comment, looks like it's expected?

bernhardoj avatar Nov 07 '24 05:11 bernhardoj

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.

brunovjk avatar Nov 07 '24 18:11 brunovjk

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

bernhardoj avatar Nov 08 '24 03:11 bernhardoj

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

Julesssss avatar Nov 08 '24 13:11 Julesssss

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

brunovjk avatar Nov 09 '24 11:11 brunovjk

Updated. Please check

bernhardoj avatar Nov 10 '24 07:11 bernhardoj

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

https://github.com/user-attachments/assets/6dda9ab8-4b31-42a4-b7e0-002a46416176

Now, after the changes, I can't:

iOS: Native - testing PR

https://github.com/user-attachments/assets/2feca7f5-640e-4f8f-8c19-2c2b6c152972

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

brunovjk avatar Nov 11 '24 14:11 brunovjk

:test_tube::test_tube: Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! :test_tube::test_tube:

Android :robot: iOS :apple:
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/51921/index.html https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/51921/index.html
Android iOS
Desktop :computer: Web :spider_web:
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/51921/NewExpensify.dmg https://51921.pr-testing.expensify.com
Desktop Web

:eyes: View the workflow run that generated this build :eyes:

github-actions[bot] avatar Nov 12 '24 10:11 github-actions[bot]

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

Android: Native

https://github.com/user-attachments/assets/9bf23224-4a74-4aed-b3a2-b78e5741e221

iOS: Native

https://github.com/user-attachments/assets/104aca35-20c3-4bcd-983d-0e2a0795e3a1

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

Android: mWeb Chrome

https://github.com/user-attachments/assets/8f1b6e51-e477-4893-af38-7d0be1a0d0e2

iOS: mWeb Safari

https://github.com/user-attachments/assets/903ec359-6dce-4824-b7f0-552515eeb5e0

Otherwise everything looks fine:

MacOS: Chrome / Safari

https://github.com/user-attachments/assets/b916720a-61bf-47a9-a51a-d9566eda161c

MacOS: Desktop

https://github.com/user-attachments/assets/218a7d67-c1f3-45f4-be09-1dc5d0d87abd

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

brunovjk avatar Nov 12 '24 12:11 brunovjk

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

mobile_mWeb

https://github.com/user-attachments/assets/dbdb1401-60fc-4678-9d1d-05e03ff123a9

In native still fine:

native

https://github.com/user-attachments/assets/87f017b0-937d-4ae8-9df8-82457fba4f5e

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

brunovjk avatar Nov 12 '24 18:11 brunovjk

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

Julesssss avatar Nov 13 '24 12:11 Julesssss

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.

brunovjk avatar Nov 13 '24 13:11 brunovjk

Added the test.

bernhardoj avatar Nov 13 '24 13:11 bernhardoj

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

brunovjk avatar Nov 13 '24 13:11 brunovjk

Thanks, looks good.

Julesssss avatar Nov 13 '24 13:11 Julesssss

:hand: 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 avatar Nov 13 '24 13:11 OSBotify

🚀 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 ❌

github-actions[bot] avatar Nov 14 '24 00:11 github-actions[bot]

🚀 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 🚫

github-actions[bot] avatar Nov 15 '24 14:11 github-actions[bot]