Fix: Only the delete confirmation modal should close when pressing ESC button #31256

dukenv0307 · 2023-11-13T05:06:09Z

Details

Only the delete confirmation modal should close when pressing ESC button

Fixed Issues

$ #30045
PROPOSAL: #30045 (comment)

Tests

Open the app
Open any distance request report or raise one and open
Click on image
Click on 3 dots and click on delete request
When the delete confirmation popup is open, press ESC
Verify that only the delete delete confirmation popup is closed
Pressing ESC once more time, verify that the image modal is closed

Verify that no errors appear in the JS console

Offline tests

QA Steps

Open the app
Open any distance request report or raise one and open
Click on image
Click on 3 dots and click on delete request
When the delete confirmation popup is open, press ESC
Verify that only the delete delete confirmation popup is closed
Pressing ESC once more time, verify that the image modal is closed

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android.mov

Android: mWeb Chrome

chrome.mov

iOS: Native

ios-resize.mov

iOS: mWeb Safari

safari-resize.mov

MacOS: Chrome / Safari

web-resize.mov

MacOS: Desktop

desktop.mov

melvin-bot · 2023-11-13T06:10:26Z

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

hoangzinh · 2023-11-13T08:11:49Z

src/components/AttachmentModal.js

@@ -398,7 +400,7 @@ function AttachmentModal(props) {
            <Modal
                type={modalType}
                onSubmit={submitAndClose}
-                onClose={closeModal}
+                onClose={isOverlayModalVisible ? null : closeModal}


Is it better if we do

function handleCloseModal() { if (isOverlayModalVisible) return; closeModal(); } ... onClose={handleCloseModal}

cc @dukenv0307 just in case you missed this message

@hoangzinh Sorry for the delay, I don't know how I miss the notification.
Your suggestion seems valid but when I tried to apply it, the weird part is that the Confirm modal didn't close 😵‍💫
Taking a closer look now.

@hoangzinh
Actually, if we assign a function to onClose, the onClose function in Modal in the outside

App/src/components/AttachmentModal.js

Line 412 in 47c7819

onClose={closeModal}

will be triggered then do nothing to close the Confirm modal
On the other hand, if onClose in the outter Modal is assigned to null, onClose function in Confirm modal will be triggered, this will trigger

App/src/components/AttachmentModal.js

Line 493 in 47c7819

onCancel={closeConfirmModal}

onCancel, then onCalcel set isAttachmentInvalid to false then close Confirm modal

So, I think it is better to keep the current code change.
Let me know if any concerns.

if onClose in the outter Modal is assigned to null, onClose function in Confirm modal will be triggered

Could you elaborate more on this one? I still do not understand what is different between them.

Interesting! It looks like if we pass a null value to onBackButtonPress of AttachmentModal, then the onBackButtonPress will be triggered for Confirm modal. Am I correct? If yes, because this one is not trivial, do you think we can pass an additional prop to Modal, then we wrap this magic inside Modal implementation. In other places, we can just pass a prop like isOverlayed, then everything will be handled inside Modal

I want to double-confirm here:
You want to update the code here

App/src/components/Modal/BaseModal.tsx

Line 174 in 72e73ae

onBackButtonPress={onClose}

to something like:

onBackButtonPress={isOverlayModalVisible ? null : closeModal}

This will fail since onBackButtonPress of ReactNativeModal expects (() => void) | undefined and the code works for null only, not undefined.

I believe the current code is pretty straightforward to fix the problem without introducing any potential bug like adding additional logic to the Modal component

Interesting! Hmm, you're right, but with current implementation of this PR, if we want to migrate this AttachmentModal component to typescript, what would we do with onClose={isOverlayModalVisible ? null : closeModal}.

I found a related upstream issue. It looks like we have to handle it in application level react-native-modal/react-native-modal#623 (comment).

Hmm. How about if isOverlayModalVisible is true, we will call closeConfirmModal, otherwise we will call closeModal.

That's worked. Please re-check the PR and let me know if any concerns

hoangzinh · 2023-11-22T16:21:10Z

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.21.26.38.-.android.mov

Android: mWeb Chrome

Screen.Recording.2023-11-23.at.20.14.14.-.android.chrome.mov

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2023-11-23.at.19.57.32.-.web.mov

MacOS: Desktop

Screen.Recording.2023-11-23.at.19.59.20.-.desktop.mov

hoangzinh

LGTM

OSBotify · 2023-11-27T10:06:35Z

✋ 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:22:55Z

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

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

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

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

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

dukenv0307 added 3 commits October 23, 2023 09:55

fix: 30045

9439e70

Merge branch 'main' into fix/30045

647b3b0

update condition

4dcb1ba

dukenv0307 changed the title ~~fix: 30045~~ Fix: Only the delete confirmation modal should close when pressing ESC button Nov 13, 2023

dukenv0307 marked this pull request as ready for review November 13, 2023 06:10

dukenv0307 requested a review from a team as a code owner November 13, 2023 06:10

melvin-bot bot requested review from hoangzinh and removed request for a team November 13, 2023 06:10

hoangzinh reviewed Nov 13, 2023

View reviewed changes

Merge branch 'main' into fix/30045

1384dfd

hoangzinh mentioned this pull request Nov 15, 2023

[HOLD for payment 2023-12-06] [$500] Delete request popup closes after map image popup on ESC #30045

Closed

6 tasks

dukenv0307 added 4 commits November 16, 2023 14:43

Merge branch 'main' into fix/30045

4a7df75

Merge branch 'main' into fix/30045

c24c55d

Merge branch 'main' into fix/30045

670a85a

update condition for onClose function of the modal

c63d370

hoangzinh approved these changes Nov 23, 2023

View reviewed changes

melvin-bot bot requested a review from MariaHCD November 23, 2023 14:29

MariaHCD approved these changes Nov 27, 2023

View reviewed changes

MariaHCD merged commit c687387 into Expensify:main Nov 27, 2023
16 of 17 checks passed

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

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

Closed

53 tasks

ishpaul777 mentioned this pull request Dec 4, 2023

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

Closed

6 tasks

hoangzinh mentioned this pull request Dec 5, 2023

Allow detaching receipts from transactions #26219

Merged

59 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: Only the delete confirmation modal should close when pressing ESC button #31256

Fix: Only the delete confirmation modal should close when pressing ESC button #31256

dukenv0307 commented Nov 13, 2023 •

edited

Loading

melvin-bot bot commented Nov 13, 2023

hoangzinh Nov 13, 2023

hoangzinh Nov 15, 2023

dukenv0307 Nov 15, 2023

dukenv0307 Nov 16, 2023

hoangzinh Nov 16, 2023

hoangzinh Nov 17, 2023 •

edited

Loading

dukenv0307 Nov 21, 2023

hoangzinh Nov 21, 2023

hoangzinh Nov 21, 2023

dukenv0307 Nov 22, 2023 •

edited

Loading

hoangzinh commented Nov 22, 2023 •

edited

Loading

hoangzinh left a comment

OSBotify commented Nov 27, 2023

OSBotify commented Nov 27, 2023

OSBotify commented Nov 29, 2023

Fix: Only the delete confirmation modal should close when pressing ESC button #31256

Fix: Only the delete confirmation modal should close when pressing ESC button #31256

Conversation

dukenv0307 commented Nov 13, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 13, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hoangzinh Nov 17, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dukenv0307 Nov 22, 2023 • edited Loading

Choose a reason for hiding this comment

hoangzinh commented Nov 22, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

hoangzinh left a comment

Choose a reason for hiding this comment

OSBotify commented Nov 27, 2023

OSBotify commented Nov 27, 2023

OSBotify commented Nov 29, 2023

dukenv0307 commented Nov 13, 2023 •

edited

Loading

hoangzinh Nov 17, 2023 •

edited

Loading

dukenv0307 Nov 22, 2023 •

edited

Loading

hoangzinh commented Nov 22, 2023 •

edited

Loading