fix: Attachments reopen on multiple 'esc' click and hang on browser's navigation back #31524

paultsimura · 2023-11-19T20:27:56Z

Details

This fixes 2 issues:

The attachments modal reopens on clicking "esc" quickly multiple times.
The attachments modal freezes when navigating back by clicking on the browser's "back" button

Use focus with delay on modal close;
Move setReadyToFocus fully to hideModal

Fixed Issues

$ #27237
PROPOSAL: #27237 (comment)

Tests

Same as QA

Offline tests

Same as QA

QA Steps

Attach multiple images in a chat
Open the first uploaded image
Click on ESC multiple times

Verify that the attachment modal doesn't reopen

Open an attachment again
Click the "Back" button in the browser

Verify that the composer gets focused

Open an attachment again
Click the "X" button on the modal

Verify that the composer gets focused

PR Author Checklist

Screenshots/Videos

Android: Native

android-compressed.mp4

Android: mWeb Chrome

chrome-compressed.mp4

iOS: Native

ios.mp4

iOS: mWeb Safari

safari.mp4

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

Move setReadyToFocus fully to hideModal

melvin-bot · 2023-11-19T20:28:01Z

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

paultsimura · 2023-11-21T08:47:33Z

src/pages/home/report/ReportAttachments.js

+            onModalHide={() => {
+                Navigation.dismissModal();
+                // This enables Composer refocus when the attachments modal is closed by the browser navigation
+                ComposerFocusManager.setReadyToFocus();


@abdulrahuman5196 I decided to go with my alternative solution for the Composer refocus on navigation because removing the !fullscreen check in hideModal would cause a regression on the Composer refocus after closing the Emoji picker.

Do we need this change? What does change bring in? @paultsimura

This focuses the composer when we navigate back by clicking the browser's "Back" button. Otherwise, ComposerFocusManager.setReadyToFocus() is called within BaseModal in 2 places:

App/src/components/Modal/BaseModal.tsx

Lines 115 to 117 in d521dd6

const handleDismissModal = () => {

ComposerFocusManager.setReadyToFocus();

};

App/src/components/Modal/BaseModal.tsx

Lines 66 to 68 in d521dd6

if (!fullscreen) {

ComposerFocusManager.setReadyToFocus();

}

The AttachmentsModal is fullscreen, so the hideModal does not call the ComposerFocusManager.setReadyToFocus().
Also, the Modal's onDismiss is not called when we are navigating – it's the RN limitation. The component just gets destroyed without calling the onDismiss.
Therefore, the ComposerFocusManager.setReadyToFocus() is not called in these two places in the BaseModal, so we need to call it explicitly.

paultsimura · 2023-11-21T14:07:40Z

@abdulrahuman5196 all yours, thanks

abdulrahuman5196

@paultsimura Could you provide information on the requested questions?

abdulrahuman5196 · 2023-11-21T15:13:15Z

src/pages/home/report/ReportAttachments.js

+            onModalHide={() => {
+                Navigation.dismissModal();
+                // This enables Composer refocus when the attachments modal is closed by the browser navigation
+                ComposerFocusManager.setReadyToFocus();


Do we need this change? What does change bring in? @paultsimura

abdulrahuman5196 · 2023-11-21T15:13:43Z

src/components/Modal/BaseModal.tsx

@@ -56,6 +56,7 @@ function BaseModal(
     */
    const hideModal = useCallback(
        (callHideCallback = true) => {
+            Modal.willAlertModalBecomeVisible(false);


Same here. What does this change provide?

Here I just moved Modal.willAlertModalBecomeVisible(false) from 2 useEffect hooks into hideModal.
This removes the race condition when double-clicking the esc button, as the hideModal is eventually called after each of those hooks, therefore Modal.willAlertModalBecomeVisible(false) will be called when the modal gets hidden. Without this change, the composer won't get focused when double-clicking esc.

I asked the original author here - there was no specific reason to put this call inside the hooks instead of the hideModal: #27639 (comment)

paultsimura · 2023-11-21T16:30:39Z

Thanks @abdulrahuman5196, replied.

# Conflicts: # src/components/Modal/BaseModal.tsx

paultsimura · 2023-11-23T11:30:45Z

@abdulrahuman5196 a friendly bump 🙏

abdulrahuman5196 · 2023-11-23T12:57:58Z

Checking again now

abdulrahuman5196 · 2023-11-23T16:11:53Z

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

Screen.Recording.2023-11-23.at.9.21.08.PM.mp4

Android: mWeb Chrome

Screen.Recording.2023-11-23.at.9.22.51.PM.mp4

iOS: Native

Screen.Recording.2023-11-23.at.8.48.18.PM.mp4

iOS: mWeb Safari

Screen.Recording.2023-11-23.at.9.12.42.PM.mp4

MacOS: Chrome / Safari

Screen.Recording.2023-11-23.at.7.26.42.PM.mp4

MacOS: Desktop

Screen.Recording.2023-11-23.at.7.35.32.PM.mp4

abdulrahuman5196

Changes looks good and works well. Reviewers checklist is also complete.

All yours. @hayata-suenaga

🎀 👀 🎀
C+ Reviewed

hayata-suenaga

👍

OSBotify · 2023-11-24T15:45:08Z

✋ 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-11-27T19:23:16Z

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.4.4-0 🚀

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

OSBotify · 2023-11-29T11:45:52Z

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

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

Use focus with delay on modal close;

487a794

Move setReadyToFocus fully to hideModal

paultsimura requested a review from a team as a code owner November 19, 2023 20:27

melvin-bot bot requested review from abdulrahuman5196 and removed request for a team November 19, 2023 20:27

Refocus composer on ReportAttachments modal hide

b9b0f60

paultsimura commented Nov 21, 2023

View reviewed changes

Fix composer losing focus on double 'esc' click

086e606

abdulrahuman5196 reviewed Nov 21, 2023

View reviewed changes

Merge branch 'main' into fix/27237-attachments-hang

0e6d7ed

# Conflicts: # src/components/Modal/BaseModal.tsx

paultsimura requested a review from abdulrahuman5196 November 22, 2023 07:53

abdulrahuman5196 approved these changes Nov 23, 2023

View reviewed changes

melvin-bot bot requested a review from hayata-suenaga November 23, 2023 16:14

hayata-suenaga approved these changes Nov 24, 2023

View reviewed changes

hayata-suenaga merged commit a279886 into Expensify:main Nov 24, 2023
14 checks passed

github-actions bot mentioned this pull request Nov 27, 2023

Deploy Checklist: New Expensify 2023-11-27 #32066

Closed

53 tasks

Christinadobrzyn mentioned this pull request Nov 28, 2023

[HOLD for payment 2023-12-06] [$1000] Web - Pressing ESC on attachment preview glitches the preview #27237

Closed

6 tasks

aimane-chnaif mentioned this pull request Dec 8, 2023

[HOLD for payment 2024-02-07] [$500] Search Page opens in Background when delete Reciept Confirm Modal is visible #29511

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Attachments reopen on multiple 'esc' click and hang on browser's navigation back #31524

fix: Attachments reopen on multiple 'esc' click and hang on browser's navigation back #31524

paultsimura commented Nov 19, 2023

melvin-bot bot commented Nov 19, 2023

paultsimura Nov 21, 2023

abdulrahuman5196 Nov 21, 2023

paultsimura Nov 21, 2023

paultsimura commented Nov 21, 2023

abdulrahuman5196 left a comment

abdulrahuman5196 Nov 21, 2023

abdulrahuman5196 Nov 21, 2023

paultsimura Nov 21, 2023

paultsimura commented Nov 21, 2023

paultsimura commented Nov 23, 2023

abdulrahuman5196 commented Nov 23, 2023

abdulrahuman5196 commented Nov 23, 2023 •

edited

Loading

abdulrahuman5196 left a comment

hayata-suenaga left a comment

OSBotify commented Nov 24, 2023

OSBotify commented Nov 27, 2023

OSBotify commented Nov 29, 2023

	const handleDismissModal = () => {
	ComposerFocusManager.setReadyToFocus();
	};

fix: Attachments reopen on multiple 'esc' click and hang on browser's navigation back #31524

fix: Attachments reopen on multiple 'esc' click and hang on browser's navigation back #31524

Conversation

paultsimura commented Nov 19, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 19, 2023

paultsimura Nov 21, 2023

Choose a reason for hiding this comment

abdulrahuman5196 Nov 21, 2023

Choose a reason for hiding this comment

paultsimura Nov 21, 2023

Choose a reason for hiding this comment

paultsimura commented Nov 21, 2023

abdulrahuman5196 left a comment

Choose a reason for hiding this comment

abdulrahuman5196 Nov 21, 2023

Choose a reason for hiding this comment

abdulrahuman5196 Nov 21, 2023

Choose a reason for hiding this comment

paultsimura Nov 21, 2023

Choose a reason for hiding this comment

paultsimura commented Nov 21, 2023

paultsimura commented Nov 23, 2023

abdulrahuman5196 commented Nov 23, 2023

abdulrahuman5196 commented Nov 23, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

abdulrahuman5196 left a comment

Choose a reason for hiding this comment

hayata-suenaga left a comment

Choose a reason for hiding this comment

OSBotify commented Nov 24, 2023

OSBotify commented Nov 27, 2023

OSBotify commented Nov 29, 2023

abdulrahuman5196 commented Nov 23, 2023 •

edited

Loading