fix: reset image viewer grabbed state when mouse is released by mdneyazahmad · Pull Request #12226 · Expensify/App

mdneyazahmad · 2022-10-28T05:50:16Z

Details

While dragging the image in a modal, when the cursor is released outside image view, the state of the cursor is not reset, and the image is draggable with just mouse move. This PR fixes this issue by tracking the cursor position and resetting the grabbed state when that is released outside the image view.

Note: This PR does not touch the native files, i.e., no change for native platform (iOS and android).

Fixed Issues

$ #11192
PROPOSAL: #11192 (comment)

Tests

Open app
Send some image file (verify that the resolution is large enough to be draggable in zoomed state)
Click on the image
Open dev tool, and click on console tab, and clear any logs there
Now click to zoom and drag
Release the cursor when that is outside the image view
Try to move the cursor and verify that the image is not draggable
Close the modal
Verify that there is no console error

Verify that no errors appear in the JS console

QA Steps

Open app
Send some image file (verify that the resolution is large enough to be draggable in zoomed state)
Click on the image
Open dev tool, and click on console tab, and clear any logs there
Now click to zoom and drag
Release the cursor when that is outside the image view
Try to move the cursor and verify that the image is not draggable
Close the modal
Verify that there is no console error

Verify that no errors appear in the JS console

PR Review Checklist

PR Author Checklist

PR Reviewer Checklist

The reviewer will copy/paste it into a new comment and complete it after the author checklist is completed

Screenshots

Web

web.mp4

Mobile Web - Chrome

mweb-chrome.mp4

Mobile Web - Safari

mweb-safari.mp4

Desktop

desktop.mp4

iOS

ios.mp4

Android

android.mp4

mananjadhav · 2022-11-02T05:02:11Z

@mdneyazahmad The changes look fine, I'll test them all platforms by tomorrow.

Quick confirmation on the web video, I hope you're not leaving the mouse cursor here? While dragging the pointer outside the container? I can't make out from the video.

mananjadhav · 2022-11-03T21:36:57Z

Quick confirmation on the web video, I hope you're not leaving the mouse cursor here? While dragging the pointer outside the container? I can't make out from the video.

@mdneyazahmad Waiting for the confirmation as the solution doesn't work for me. Here's the attached video on web.

image-drag-outside-container.mp4

mdneyazahmad · 2022-11-04T09:53:56Z

@mananjadhav it is not very clear from the video. Could you list the steps?

mananjadhav · 2022-11-05T18:48:30Z

@mdneyazahmad The same reproduction steps from the issue.

Open the chat
Click on any attachment which is large enough to zoom
Zoom in the image
Grab the image and drag around within the container (attachment view), it should drag
Don't leave the mouse pointer yet, and drag it outside the attachment view, it still drags the image (ie it is in grabbed state)

mdneyazahmad · 2022-11-07T08:08:17Z

@mananjadhav I believe that is expected, and that is reason mousemove is attached to document. Could you confirm that the image is draggable without holding the mouse button?

The original issue is different. When you leave the mouse outside image view. The image is draggable without holding the mouse button.

mananjadhav · 2022-11-07T08:26:10Z

Could you confirm that the image is draggable without holding the mouse button?

With your fix the image is not draggable if I leave the mouse pointer. Got it, you're right. I checked the original GH issue description and we're talking about leaving the mouse pointer outside the container.

mananjadhav · 2022-11-07T12:30:04Z

Changes look fine and test well. Thanks the explanation @mdneyazahmad.

@roryabraham All yours

🎀 👀 🎀
C+ reviewed

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:
- iOS / native
- Android / native
- iOS / Safari
- Android / Chrome
- MacOS / Chrome
- 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 was added in all src/languages/* files
- I verified any copy / text that was added to the app is correct English and 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 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 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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.