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

use PopoverMenu for account switcher modal #49051

Open
wants to merge 40 commits into
base: main
Choose a base branch
from

Conversation

nkdengineer
Copy link
Contributor

Details

use PopoverMenu for account switcher modal

Fixed Issues

$ #48292
PROPOSAL: #48292 (comment)

Tests

  1. Login into an account that has access to many accounts and enable the copilot beta
  2. Open the setting page
  3. Click on account switcher
  4. Verify that the account switcher modal is scrollable and takes 50% of the height of the screen
  5. For Web/Desktop, verify that the position of the account switcher modal is correct and we can use the arrow key to select an account
  • Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

  1. Login into an account that has access to many accounts and enable the copilot beta
  2. Open the setting page
  3. Click on account switcher
  4. Verify that the account switcher modal is scrollable and takes 50% of the height of the screen
  5. For Web/Desktop, verify that the position of the account switcher modal is correct and we can use the arrow key to select an account
  • 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • 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.

Screenshots/Videos

Android: Native
Screen.Recording.2024-09-12.at.16.37.31.mov
Android: mWeb Chrome
Screen.Recording.2024-09-12.at.16.41.41.mov
iOS: Native
Screen.Recording.2024-09-12.at.16.42.31.mov
iOS: mWeb Safari
Screen.Recording.2024-09-12.at.16.38.51.mov
MacOS: Chrome / Safari
Screen.Recording.2024-09-12.at.16.36.32.mov
MacOS: Desktop
Screen.Recording.2024-09-12.at.16.46.39.mov

@nkdengineer nkdengineer marked this pull request as ready for review September 12, 2024 10:49
@nkdengineer nkdengineer requested a review from a team as a code owner September 12, 2024 10:49
@melvin-bot melvin-bot bot requested a review from s77rt September 12, 2024 10:49
Copy link

melvin-bot bot commented Sep 12, 2024

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

src/components/AccountSwitcher.tsx Outdated Show resolved Hide resolved
src/components/AccountSwitcher.tsx Outdated Show resolved Hide resolved
src/components/PopoverMenu.tsx Outdated Show resolved Hide resolved
@s77rt
Copy link
Contributor

s77rt commented Sep 13, 2024

The design does not match with the current one

Screenshot 2024-09-13 at 10 11 25 AM Screenshot 2024-09-13 at 10 14 27 AM

@s77rt
Copy link
Contributor

s77rt commented Sep 13, 2024

Bug: After switching account, both accounts are focused

Screenshot 2024-09-13 at 10 17 18 AM

@nkdengineer
Copy link
Contributor Author

nkdengineer commented Sep 13, 2024

The design does not match with the current one

Bug: After switching accounts, both accounts are focused

@s77rt Fixed two bugs above. About the first bug, the reason is the wrap view of PopoverMenu has a fixed width in createMenuContainer style that is less than the child width.

src/components/PopoverMenu.tsx Outdated Show resolved Hide resolved
src/components/PopoverMenu.tsx Outdated Show resolved Hide resolved
@s77rt
Copy link
Contributor

s77rt commented Sep 16, 2024

The design still does not match with the current one

  1. The selected user is not highlighted
  2. There is an extra space surrounding the title
Screenshot 2024-09-13 at 10 11 25 AM Screenshot 2024-09-16 at 11 52 44 AM

@nkdengineer
Copy link
Contributor Author

nkdengineer commented Sep 16, 2024

The selected user is not highlighted

@s77rt Can't reproduce the first bug.

Screen.Recording.2024-09-16.at.18.04.40.mov

@s77rt
Copy link
Contributor

s77rt commented Sep 16, 2024

@nkdengineer Close the modal and open it again

src/components/AccountSwitcher.tsx Outdated Show resolved Hide resolved
@nkdengineer
Copy link
Contributor Author

@s77rt I updated. Please help to check again.

@s77rt
Copy link
Contributor

s77rt commented Sep 25, 2024

@nkdengineer Please fix lint issues

@nkdengineer
Copy link
Contributor Author

@nkdengineer Please fix lint issues

Fixed

@s77rt
Copy link
Contributor

s77rt commented Sep 25, 2024

@nkdengineer Can you look into the performance failing test

@nkdengineer
Copy link
Contributor Author

Bug: the account is in selected state and does not show error.

@s77rt The reason is we change this line prevProps.menuItems.length === nextProps.menuItems.length that causes the component to be rendered more time. But it's required to fix this bug then I think we can accept this test fail.

@s77rt
Copy link
Contributor

s77rt commented Sep 25, 2024

@nkdengineer I don't think this is acceptable as I doubt the list changed during the test. It's most likely due to shallow comparison where prevProps.menuItems === nextProps.menuItems will be false even if the menu items array are the same. Try use lodashIsEqual, it will perform a deep comparison and should fix the performance test

@nkdengineer
Copy link
Contributor Author

Let me try.

@nkdengineer
Copy link
Contributor Author

@s77rt Still fails with lodashIsEqual

@s77rt
Copy link
Contributor

s77rt commented Sep 25, 2024

@nkdengineer Please investigate why it fails i.e. what were the previous and the next menuItems that cause the component to re-render

@nkdengineer
Copy link
Contributor Author

@s77rt It comes from ReportActionCompose. Fixed it now.

@@ -336,7 +336,7 @@ PopoverMenu.displayName = 'PopoverMenu';
export default React.memo(
PopoverMenu,
(prevProps, nextProps) =>
lodashIsEqual(prevProps.menuItems, nextProps.menuItems) &&
lodashIsEqual(prevProps.menuItems.length, nextProps.menuItems.length) &&
Copy link
Contributor

Choose a reason for hiding this comment

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

Don't we need to compare the menu items and not just their lengths in order to show the error

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@s77rt Sorry, that was my mistake. I forgot to revert the change in PopoverMenu when running perf-test locally and mistakenly thought it was fixed. But the current fail test come from AttachmentPickerWithMenuItems

@dangrous
Copy link
Contributor

dangrous commented Oct 2, 2024

how are we looking on this one?

@nkdengineer
Copy link
Contributor Author

@dangrous We're looking at the perf-test fails. The reason here. What do you think?

@nkdengineer
Copy link
Contributor Author

@s77rt Since the render count difference is only 1, can we accept this and merge this PR? I can't find a way to reduce this render count in ReportScreen.

@s77rt
Copy link
Contributor

s77rt commented Oct 3, 2024

@nkdengineer I think we should at least find the root cause i.e. what's causing the extra render

@s77rt
Copy link
Contributor

s77rt commented Oct 7, 2024

@nkdengineer Any progress on this?

@nkdengineer
Copy link
Contributor Author

Still investigating the RCA.

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.

7 participants