prevent re-uploading avatar when press enter key multiple times #17326

situchan · 2023-04-12T07:00:53Z

Details

prevent slider press event on enter key press
prevent save button press event while processing (cropping, saving or uploading) image

Fixed Issues

$ #16644
PROPOSAL: #16644 (comment)

Tests

Navigate to Settings > Workspaces > any workspace > General settings
Click on avatar > Upload photo
Choose any photo
Click anywhere on the zoom slider to zoom the photo
Press enter key (Save button on mobile) twice (or more times) very quickly
Verify that modal is closed, image is uploaded only once and no error message shows

Verify that no errors appear in the JS console

Offline tests

Same as Tests step but also verify that avatar is greyed on General settings page
And when back online, verify that image is uploaded only once

QA Steps

Same as Tests step

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

web.mov

Mobile Web - Chrome

mchrome.mov

Mobile Web - Safari

msafari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

MelvinBot · 2023-04-12T07:01:00Z

@techievivek @0xmiroslav One of you needs to 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]

0xmiroslav · 2023-04-12T16:18:35Z

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

mchrome.mov

Mobile Web - Safari

msafari.mp4

Desktop

desktop.mov

iOS

ios.mp4

Android

android.mov

0xmiroslav

Looks good and tests well 🎉
cc: @techievivek

techievivek

A few comments.

techievivek · 2023-04-13T10:56:01Z

src/components/AvatarCropModal/AvatarCropModal.js

+                isLoading.value = false;
            });
-    }, [originalImageHeight.value, originalImageWidth.value, scale.value, translateX.value, imageContainerSize, translateY.value, props, rotation.value]);
+    }, [originalImageHeight.value, originalImageWidth.value, scale.value, translateX.value, imageContainerSize, translateY.value, props, rotation.value, isLoading]);


Shouldn't this be isLoading.value?

Both are fine but I think isLoading is better for optimization.
If we add isLoading.value as dependency of useCallback, cropAndSaveImage function is re-calculated whenever that value changes.
If we set value to isLoading.value, it's updated instantly (useSharedValue's feature), even if we use useCallback without dependency. So it's safe to add just isLoading as a dependency.

I noticed that isLoading should be added as a dependency because its value is changed inside useCallback.
If we don't add that dependency but just isLoading.value, lint fails:

Ok, thanks for confirming that. 👍

src/components/AvatarCropModal/AvatarCropModal.js

situchan · 2023-04-13T11:24:15Z

@techievivek done feedback

0xmiroslav

@techievivek thanks for suggestions.
LGTM!

techievivek

Looks good 🎉

OSBotify · 2023-04-14T06:36:31Z

✋ 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-04-18T06:09:48Z

🚀 Deployed to staging by https://github.com/techievivek in version: 1.3.1-0 🚀

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

OSBotify · 2023-04-19T17:22:57Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.1-3 🚀

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

prevent re-uploading avatar when press enter key multiple times

252656d

situchan requested a review from a team as a code owner April 12, 2023 07:00

melvin-bot bot requested review from 0xmiroslav and techievivek and removed request for a team April 12, 2023 07:00

0xmiroslav previously approved these changes Apr 12, 2023

View reviewed changes

techievivek reviewed Apr 13, 2023

View reviewed changes

add comment for isLoading flag on AvatarCropModal

16e11d8

situchan dismissed 0xmiroslav’s stale review via 16e11d8 April 13, 2023 11:22

0xmiroslav approved these changes Apr 13, 2023

View reviewed changes

techievivek approved these changes Apr 14, 2023

View reviewed changes

techievivek merged commit 29dc7c2 into Expensify:main Apr 14, 2023

eVoloshchak mentioned this pull request Apr 17, 2023

[$1000] Save button does not throttle requests and keeps user on upload page #17285

Closed

5 tasks

OSBotify mentioned this pull request Apr 17, 2023

Deploy Checklist: New Expensify 2023-04-17 #17546

Closed

53 tasks

kbecciv mentioned this pull request Apr 18, 2023

Web - Workspace - Image is flashing when user hits the Enter key twice. #17589

Closed

6 tasks

MelvinBot mentioned this pull request Apr 19, 2023

[HOLD for payment 2023-04-26] [$1000] Error message is displayed while trying to upload a workspace photo by pressing the enter/return key twice #16644

Closed

6 tasks

situchan deleted the fix/16644-avatar-upload-enter-twice branch November 4, 2025 03:19

prevent re-uploading avatar when press enter key multiple times #17326

prevent re-uploading avatar when press enter key multiple times #17326

Uh oh!

Conversation

situchan commented Apr 12, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

MelvinBot commented Apr 12, 2023

Uh oh!

0xmiroslav commented Apr 12, 2023

Reviewer Checklist

Screenshots/Videos

Uh oh!

0xmiroslav left a comment

Choose a reason for hiding this comment

Uh oh!

techievivek left a comment

Choose a reason for hiding this comment

Uh oh!

techievivek Apr 13, 2023

Choose a reason for hiding this comment

Uh oh!

situchan Apr 13, 2023

Choose a reason for hiding this comment

Uh oh!

situchan Apr 13, 2023

Choose a reason for hiding this comment

Uh oh!

techievivek Apr 14, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

situchan commented Apr 13, 2023

Uh oh!

0xmiroslav left a comment

Choose a reason for hiding this comment

Uh oh!

techievivek left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Apr 14, 2023

Uh oh!

OSBotify commented Apr 18, 2023

Uh oh!

OSBotify commented Apr 19, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants