Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix report action context menu stuck when open search page with keyboard shortcut #29152

Merged
merged 4 commits into from
Oct 19, 2023

Conversation

tsa321
Copy link
Contributor

@tsa321 tsa321 commented Oct 10, 2023

Details

Fixed Issues

$ #27244
PROPOSAL: #27244 (comment)

Tests

For Macos chrome / Desktop:

  1. Open any report
  2. Click FAB button then right click report action then Open search page with cmd + k
  3. Notice there is no popover/context menu being stuck and search page is opened
  4. Click emoji picker -> right click reportaction -> cmd + k
  5. Notice there is no popover/context menu being stuck and search page is opened
  6. Right click context menu -> choose emoji picker inside context menu -> cmd + k
  7. Notice there is no popover/context menu being stuck and search page is opened
  8. Click Fab button -> right click on LHN -> cmd + k
  9. Notice there is no popover/context menu being stuck and search page is opened
  10. Click any button that trigger popover / context menu with other different combinations -> cmd + k
  11. Notice there is no popover/context menu being stuck and search page is opened

For mobile:

  1. Click emoji picker, fab button, long press report action and other actions to trigger popover or context menu
  2. Verify the components functions properly when opening and closing the context menu.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

For Macos chrome / Desktop:

  1. Open any report
  2. Click FAB button then right click report action then Open search page with cmd + k
  3. Notice there is no popover/context menu being stuck and search page is opened
  4. Click emoji picker -> right click reportaction -> cmd + k
  5. Notice there is no popover/context menu being stuck and search page is opened
  6. Right click context menu -> choose emoji picker inside context menu -> cmd + k
  7. Notice there is no popover/context menu being stuck and search page is opened
  8. Click Fab button -> right click on LHN -> cmd + k
  9. Notice there is no popover/context menu being stuck and search page is opened
  10. Click any button that trigger popover / context menu with other different combinations -> cmd + k
  11. Notice there is no popover/context menu being stuck and search page is opened

For mobile:

  1. Click emoji picker, fab button, long press report action and other actions to trigger popover or context menu
  2. Verify the components functions properly when opening and closing the context menu.
  • 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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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

Android: Native
android-native_d.mp4
Android: mWeb Chrome
android-mweb_d.mp4
iOS: Native
ios-native_d.mp4
iOS: mWeb Safari
ios-msafari_d.mp4
MacOS: Chrome / Safari
macos-web_d.mp4
MacOS: Desktop
macos-dekstop_d.mp4

…ard shortcut

Signed-off-by: Tsaqif <tsaiinkwa@yahoo.com>
@tsa321 tsa321 requested a review from a team as a code owner October 10, 2023 05:47
@melvin-bot melvin-bot bot requested review from mollfpr and removed request for a team October 10, 2023 05:47
@melvin-bot
Copy link

melvin-bot bot commented Oct 10, 2023

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

@tsa321
Copy link
Contributor Author

tsa321 commented Oct 10, 2023

@mollfpr Could you review my pr when you have a chance? thank you...

@tsa321
Copy link
Contributor Author

tsa321 commented Oct 13, 2023

@mollfpr Friendly bump...

Copy link
Contributor

@mollfpr mollfpr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the late review @tsa321, I just got out from the hospital after surgery on my right because of the motorcycle accident on Wednesday 🙏

I left a comment but the test looks good.

activePopoverRef.current.close();
lodashGet(activePopoverRef, 'current.onCloseCallback', () => {})();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand you want to call the function after it returns from the lodashGet, but I found this harder to understand at first glance. Usually, people use lodashGet to assign the return to another variable instead of calling it immediately, so this will make us for a moment. Could we make it more explanatory instead of making it simple?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mollfpr just to make sure for the easy to read code. Should we change the code into something like this?:

const closeCallback = lodashGet(activePopoverRef, 'current.onCloseCallback', () => {})
closeCallback();

Or should we use if clause instead? something like this:

if (activePopoverRef && activePopoverRef.current && activePopoverRef.current.onCloseCallback) {
     activePopoverRef.current.onCloseCallback();
}

Or do you have other options?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The if clause looks good to me!

@@ -106,6 +109,7 @@ function PopoverContextProvider(props) {
closePopover(activePopoverRef.current.anchorRef);
}
activePopoverRef.current = popoverParams;
lodashGet(activePopoverRef, 'current.onOpenCallback', () => {})();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as the above.

@tsa321
Copy link
Contributor Author

tsa321 commented Oct 16, 2023

Sorry for the late review @tsa321, I just got out from the hospital after surgery on my right because of the motorcycle accident on Wednesday 🙏

I am sorry to hear that @mollfpr 🙏, I hope you get well soon and wishing you a speedy recovery.

Signed-off-by: Tsaqif <tsaiinkwa@yahoo.com>
@tsa321
Copy link
Contributor Author

tsa321 commented Oct 16, 2023

and @mollfpr I have checked the recent history of popoverWithoutOverly and the related PRs and I think this PR could solve the issue in:

#28241 and #29341

@mollfpr
Copy link
Contributor

mollfpr commented Oct 16, 2023

@tsa321 Have you try revert the mentioned PR here?

@tsa321
Copy link
Contributor Author

tsa321 commented Oct 16, 2023

@mollfpr yes, I have reverted the two PRs.

@mollfpr
Copy link
Contributor

mollfpr commented Oct 16, 2023

Thanks @tsa321! Could you cross-post it in #29341 and get their thoughts about this PR?

@parasharrajat
Copy link
Member

IF this issue is related to same root cause as #29341. Please hold this PR.

@tsa321
Copy link
Contributor Author

tsa321 commented Oct 16, 2023

@parasharrajat This is different root cause with #29341
The issue I am fixing here is dated 12 september, more than 1 month ago.

What I am saying is my PR could also solve #28241 (the attachment refresh navigation issue, I have tested it by reverting the PR that solve the issue and executing my PR) So I found a solution for my issue that I am trying to solve here and the other issue #28241 (the attachment navigation issue)

Can we move forward?
Thank you...

@tsa321 tsa321 requested a review from mollfpr October 16, 2023 11:20
@tsa321
Copy link
Contributor Author

tsa321 commented Oct 16, 2023

@mollfpr Could we move forward? It is different root cause...

@tsa321
Copy link
Contributor Author

tsa321 commented Oct 16, 2023

cc @mollfpr: parasharrajat replies from other issue: #28241 (comment)

@mollfpr
Copy link
Contributor

mollfpr commented Oct 17, 2023

@tsa321 Let's wait for the revert, and we can move forward with this.

@mollfpr
Copy link
Contributor

mollfpr commented Oct 17, 2023

@tsa321 Could you add [HOLD] to the PR title? Thanks!

@tsa321 tsa321 changed the title Fix report action context menu stuck when open search page with keyboard shortcut [HLD] Fix report action context menu stuck when open search page with keyboard shortcut Oct 17, 2023
@tsa321 tsa321 changed the title [HLD] Fix report action context menu stuck when open search page with keyboard shortcut [HOLD] Fix report action context menu stuck when open search page with keyboard shortcut Oct 17, 2023
@tsa321 tsa321 changed the title [HOLD] Fix report action context menu stuck when open search page with keyboard shortcut Fix report action context menu stuck when open search page with keyboard shortcut Oct 18, 2023
@tsa321
Copy link
Contributor Author

tsa321 commented Oct 18, 2023

@mollfpr The revert has been merged, let's continue this PR. Thank you...

Signed-off-by: Tsaqif <tsaiinkwa@yahoo.com>
@mollfpr
Copy link
Contributor

mollfpr commented Oct 19, 2023

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

Web
29152.Web.mp4
Mobile Web - Chrome
29152.mWeb-Chrome.mp4
Mobile Web - Safari
29152.mWeb-Safari.mp4
Desktop
29152.Desktop.mp4
iOS
29152.iOS.mp4
Android
29152.Android.mp4

Copy link
Contributor

@mollfpr mollfpr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM and tests well 👍

All yours @cead22

activePopoverRef.current.close();
if (activePopoverRef && activePopoverRef.current && activePopoverRef.current.onCloseCallback) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we need activePopoverRef && activePopoverRef.current && since above we're calling activePopoverRef.current.close();

Suggested change
if (activePopoverRef && activePopoverRef.current && activePopoverRef.current.onCloseCallback) {
if (activePopoverRef.current.onCloseCallback) {

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cead22 done

Signed-off-by: Tsaqif <tsaiinkwa@yahoo.com>
@tsa321 tsa321 requested a review from cead22 October 19, 2023 16:02
Copy link
Contributor

@cead22 cead22 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for testing several different popup conbinations!

@cead22 cead22 merged commit 20cd522 into Expensify:main Oct 19, 2023
14 checks passed
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

🚀 Deployed to staging by https://github.com/cead22 in version: 1.3.88-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.88-11 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants