Fix attachment modal doesn't close when pressing search shortcut by bernhardoj · Pull Request #27639 · Expensify/App

bernhardoj · 2023-09-18T06:22:10Z

Details

Pressing search shortcut while having attachment modal showing won't close the attachment modal.

Fixed Issues

$ #27359
PROPOSAL: #27359 (comment)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Web/Desktop

Send an image attachment to a chat
Open the image attachment
Press CTRL+K
Verify the image attachment modal is closed and the search page is opened

Android/iOS/mWeb
Verify that we can still open any modal on the app

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover 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 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).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
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)
I followed proper code patterns (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
  - 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:
- 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 followed the guidelines as stated in the Review Guidelines
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)
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
I verified that if a function's arguments changed that all usages have also been updated correctly
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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Screen.Recording.2023-09-18.at.14.16.37.mov

Mobile Web - Chrome

Screen.Recording.2023-09-18.at.13.54.37.mov

Mobile Web - Safari

Screen.Recording.2023-09-18.at.13.54.14.mov

Desktop

Screen.Recording.2023-09-18.at.14.18.56.mov

iOS

Screen.Recording.2023-09-18.at.13.53.42.mov

Android

Screen.Recording.2023-09-18.at.14.09.45.mov

melvin-bot · 2023-09-18T06:22:15Z

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

bernhardoj · 2023-09-18T06:35:58Z

src/components/Modal/BaseModal.js

+                return;
            }
-
+            hideModal(true);


I think we should create a ref for hideModal function too, but as it doesn't have any problem yet, I leave it as it is. Let me know if we should make it a ref too.

I think ref is only needed for variables that are passed by value (not confirmed).

Maybe, haven't tested it too

s77rt · 2023-09-18T11:42:30Z

src/components/Modal/BaseModal.js

+            if (!isVisible) {
+                return;
+            }
+            Modal.willAlertModalBecomeVisible(false);
+            Modal.setCloseModal(null);


I don't think this logic fits best as the cleanup logic. Can we done this using usePrevious instead?

useEffect(() => { if (isVisible) { Modal.willAlertModalBecomeVisible(true); Modal.setCloseModal(onClose); } else if (wasVisible && !isVisible) { Modal.willAlertModalBecomeVisible(false); Modal.setCloseModal(null); } }, [isVisible, wasVisible, onClose]);

The cleanup func runs when isVisible changes, so if isVisible is updated to false the cleanup func runs with isVisible value is still true. I must admit it's harder to understand, so I updated it using your suggestion.

s77rt · 2023-09-18T14:40:29Z

src/components/Modal/BaseModal.js

-        // To handle closing any modal already visible when this modal is mounted, i.e. PopoverReportActionContextMenu
-        Modal.setCloseModal(isVisible ? onClose : null);
-    }, [isVisible, onClose]);
+        isVisibleRef.current = isVisible;


NAB. Is there a significant gain merging the two useEffects together? I think it's more readable to have the isVisibleRef useEffect separated

Nope, just to reduce loc :). I think it's fine to put it here, we can even put it outside of useEffect, but it will feels like out of place.

s77rt · 2023-09-18T15:05:43Z

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

Web

web.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

desktop.mov

iOS

Android

OSBotify · 2023-09-19T03:32:22Z

✋ 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-09-20T08:45:51Z

🚀 Deployed to staging by https://github.com/AndrewGable in version: 1.3.72-0 🚀

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

OSBotify · 2023-09-22T13:27:46Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.72-11 🚀

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

0xmiroslav · 2023-10-12T16:52:24Z

This caused regression:

Repro step:

Open FAB menu and close it
Press Ctrk+K
Expects to open Search page but nothing happens (BUG)
Open FAB menu again
Close FAB menu by clicking anywhere outside
Search page opens this time (BUG)

Screen.Recording.2023-10-12.at.6.35.41.PM.mov

bernhardoj · 2023-10-12T17:07:34Z

@0xmiroslav I think you marked the wrong PR. It is coming from this one instead.

0xmiroslav · 2023-10-12T17:10:39Z

@bernhardoj I confirmed that reverting this PR fixes that bug

bernhardoj · 2023-10-12T17:20:25Z

@0xmiroslav I also confirmed reverting #28486 fix it.

This PR was merged 3 weeks ago.

Both useEffect logic of PopoverWithoutOverlay and BaseModal is incorrect and this PR corrected BaseModal. This PR Fix navigation breaks on opening search page after reloading the attachment #28486 trying to fix it on PopoverWithoutOverlay with a wrong fix making it never clear the setCloseModal.

App/src/components/PopoverWithoutOverlay/index.js

Lines 42 to 48 in 0c30f64

    
           // We prevent setting closeModal function to null when the component is invisible the first time it is rendered 
        
           if (!firstRenderRef.current || !props.isVisible) { 
        
               firstRenderRef.current = false; 
        
               return; 
        
           } 
        
           firstRenderRef.current = false; 
        
           Modal.setCloseModal(props.isVisible ? () => props.onClose(props.anchorRef) : null);

Notice that it early returns when it is not visible, so Modal.setCloseModal(null) is never called.

That PR also caused this issue #29341. They should correct the useEffect logic the same we did in this PR.

paultsimura · 2023-11-21T09:28:55Z

src/components/Modal/BaseModal.js

+            // To handle closing any modal already visible when this modal is mounted, i.e. PopoverReportActionContextMenu
+            Modal.setCloseModal(onClose);
+        } else if (wasVisible && !isVisible) {
+            Modal.willAlertModalBecomeVisible(false);


Hi @bernhardoj, we are thinking of moving this line, and the same line from the next useEffect into the hideModal function. Was there any specific reason not to do it in this PR? Just asking so that we won't break any edge case that I'm not aware of...

I don't think there is any reason but just replicating the previous code.

fix modal doesn't close when pressing search shortcut

8314b4b

bernhardoj requested a review from a team as a code owner September 18, 2023 06:22

melvin-bot bot requested review from s77rt and removed request for a team September 18, 2023 06:22

bernhardoj commented Sep 18, 2023

View reviewed changes

s77rt suggested changes Sep 18, 2023

View reviewed changes

simplify code

fd015a0

s77rt reviewed Sep 18, 2023

View reviewed changes

s77rt approved these changes Sep 18, 2023

View reviewed changes

melvin-bot bot requested a review from AndrewGable September 18, 2023 15:07

AndrewGable approved these changes Sep 19, 2023

View reviewed changes

AndrewGable merged commit c414887 into Expensify:main Sep 19, 2023

tienifr mentioned this pull request Sep 20, 2023

[$500] Web - Navigating to Search by keyboard shortcut when the "Update Workspace currency to USD" Modal is open Does not close the modal #27277

Closed

6 tasks

OSBotify mentioned this pull request Sep 20, 2023

Deploy Checklist: New Expensify 2023-09-20 #27837

Closed

0xmiroslav mentioned this pull request Sep 22, 2023

[$500] Request Money - [Scan receipt] Compose box is not focused when visiting requested money details chat after deleting another one #27249

Closed

6 tasks

melvin-bot bot mentioned this pull request Sep 22, 2023

[HOLD for payment 2023-09-29] [$500] Search page - Opening search by keyboard shortcut when attachment is open breaks the navigation #27359

Closed

6 tasks

ishpaul777 mentioned this pull request Sep 28, 2023

Dev: Web - Incorrect Screen when Clicking CMD+K while Year Selection Modal is opened. #27160

Closed

6 tasks

0xmiroslav mentioned this pull request Oct 12, 2023

redirect Anon user to sign in page on shortcut use #29323

Merged

59 tasks

This was referenced Oct 12, 2023

[HOLD for payment 2023-10-25] [$500] Fab - App disables CTRL+K / CTRL+SHIFT+K shortcuts on FAB menu option pages #29341

Closed

[$125] Web - Keyboard shortcuts don't work on Web #29444

Closed

trjExpensify mentioned this pull request Oct 16, 2023

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

Closed

6 tasks

paultsimura reviewed Nov 21, 2023

View reviewed changes

paultsimura mentioned this pull request Nov 21, 2023

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

Merged

48 tasks

rayane-d mentioned this pull request Mar 3, 2024

HOLD for payment 2024-04-03 [$500] Workspace - 3 dot menu in WS listing/WS chat stops working after viewing WS avatar #37609

Closed

6 tasks

bernhardoj mentioned this pull request Apr 2, 2024

[HOLD for payment 2024-06-06] [$500] Web - CTRL + K does not open Search while user avatar preview opened #37634

Closed

6 tasks

Conversation

bernhardoj commented Sep 18, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Sep 18, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

s77rt commented Sep 18, 2023

Reviewer Checklist

Screenshots/Videos

Uh oh!

OSBotify commented Sep 19, 2023

Uh oh!

OSBotify commented Sep 20, 2023

Uh oh!

OSBotify commented Sep 22, 2023

Uh oh!

0xmiroslav commented Oct 12, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bernhardoj commented Oct 12, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

0xmiroslav commented Oct 12, 2023

Uh oh!

bernhardoj commented Oct 12, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

0xmiroslav commented Oct 12, 2023 •

edited

Loading

bernhardoj commented Oct 12, 2023 •

edited

Loading