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(PopoverMenu): fix opening external links #45762

Conversation

zfurtak
Copy link
Contributor

@zfurtak zfurtak commented Jul 19, 2024

Details

Fixed Issues

$#45417
PROPOSAL:

Tests

This bug is related to feature that is not yet in the app.
To check the external links functionality it's needed to change code in 1 button.
This code has to be added in PolicyAccountingPage (line 188)

onSelected: () => {
                    Link.openLink(getQuickBooksOnlineSetupLink(policyID), CONST.NEW_EXPENSIFY_URL);
                },

Check deatils on this branch.

Additionally it's needed to add file .env in the main directory with one line:

ENVIRONMENT=staging

Testing scenario:

  1. Add code from above
  2. Go to Settings -> Workspaces
  3. Create a workspace, click More features and choose Accounting
  4. Connect to Xero
  5. It's needed to create an account there
  6. After everything is set up click three dots
  7. Choose Sync up
  8. The changed code should be called and an external page should open

Other features connected to PopoverMenu that are worthy to check are:

  1. Uploading and viewing avatar
    1. Go to Settings
    2. Click on the avatar
    3. Click Upload photo
    4. New photo should appear
    5. Click on the avatar
    6. Click View photo
    7. The photo should appear on a modal
  2. Deleting workspace
    1. Go to Settings
    2. Go to Workspace
    3. Click three dots on a chosen workspace
    4. Click Delete workspace
    5. Workspace should disappear
  3. Adding attachment to a message
    1. Go to a chosen chat (report)
    2. Click + next to input
    3. Click Add attachments
    4. Modal with files to attach should appear
  4. Deleting tag/tax from workspace
    1. Go to Settings
    2. Go to Workspaces
    3. Go to a chosen workspace
    4. If neither tab Taxes nor Tags is not visible go to More features
    5. Turn on Tags or Taxes
    6. Go to proper tab
    7. Add a new tag
    8. Select this tag
    9. Click the button above 1 selected
    10. Click Delete tag and confirm in the next modal
    11. Tag should disappear
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

The external links functionality can't be tested yet. We need to wait until it's placed in the app.
Rest of the tests same like above.
It would be great to test all features that are connected to PopoverMenu or ButtonWithDropDownMenu

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

External link

Screen.Recording.2024-07-22.at.12.26.18.mov

Other functionalities connected to PopoverMenu

Screen.Recording.2024-07-22.at.12.29.24.mov
Screen.Recording.2024-07-22.at.12.30.00.mov
Screen.Recording.2024-07-22.at.12.29.41.mov
Android: mWeb Chrome

External link

link.mov

Other functionalities connected to PopoverMenu

Screen.Recording.2024-07-22.at.12.46.20.mov
Screen.Recording.2024-07-22.at.12.46.34.mov
Screen.Recording.2024-07-22.at.12.47.42.mov
iOS: Native

External link

Screen.Recording.2024-07-22.at.11.46.32.mov

Other functionalities connected to PopoverMenu

Screen.Recording.2024-07-22.at.11.46.07.mov
Screen.Recording.2024-07-22.at.11.47.05.mov
Screen.Recording.2024-07-22.at.11.47.16.mov
1111.mov
iOS: mWeb Safari

External link

linki.mov

Other functionalities connected to PopoverMenu

1.mov
2.mov
Screen.Recording.2024-07-22.at.11.21.34.mov
MacOS: Chrome / Safari

External link

web-90.mov

Other functionalities connected to PopoverMenu

web-1-1.mov
web-2-2.mov
web-4-4.mov
web-5-5.mov
MacOS: Desktop

External link

link-desktop.mov

Other functionalities connected to PopoverMenu

Screen.Recording.2024-07-22.at.12.04.50.mov
desktop.mov
desktop-avatar.mov
Screen.Recording.2024-07-22.at.12.05.00.mov

Copy link
Contributor

@BrtqKr BrtqKr left a comment

Choose a reason for hiding this comment

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

LGTM

@zfurtak zfurtak marked this pull request as ready for review July 23, 2024 09:20
@zfurtak zfurtak requested a review from a team as a code owner July 23, 2024 09:20
@melvin-bot melvin-bot bot removed the request for review from a team July 23, 2024 09:20
Copy link

melvin-bot bot commented Jul 23, 2024

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

@melvin-bot melvin-bot bot requested a review from shubham1206agra July 23, 2024 09:20
@shubham1206agra
Copy link
Contributor

@zfurtak I am not sure what this PR is accomplishing since the given test was working fine before this PR too.

@zfurtak
Copy link
Contributor Author

zfurtak commented Jul 25, 2024

@shubham1206agra as I was testing, it wasn't possible to open an external link from PopoverMenu on mWeb iOS. Did you check this exact case? (with added code)

@zfurtak
Copy link
Contributor Author

zfurtak commented Jul 26, 2024

friendly bump @shubham1206agra 😊

@zfurtak
Copy link
Contributor Author

zfurtak commented Jul 29, 2024

Could you take a look @shubham1206agra? :)

@shubham1206agra
Copy link
Contributor

I will do this today.

@zfurtak
Copy link
Contributor Author

zfurtak commented Jul 30, 2024

How is it going @shubham1206agra?

@shubham1206agra
Copy link
Contributor

shubham1206agra commented Jul 30, 2024

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 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 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(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.
  • 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.2024-07-31.at.8.12.42.AM.mov
Android: mWeb Chrome
Screen.Recording.2024-07-30.at.4.28.16.PM.mov
iOS: Native
Screen.Recording.2024-07-30.at.4.40.08.PM.mov
iOS: mWeb Safari
Screen.Recording.2024-07-30.at.4.22.16.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-07-30.at.4.16.09.PM.mov
MacOS: Desktop
Screen.Recording.2024-07-30.at.4.32.13.PM.mov

@melvin-bot melvin-bot bot requested a review from arosiclair July 30, 2024 11:13
@shubham1206agra
Copy link
Contributor

Woops. Just saw Perf is failing. @zfurtak Can you please look into this?

@zfurtak
Copy link
Contributor Author

zfurtak commented Jul 30, 2024

@shubham1206agra
Oh yes, I know about this performance issue and have been looking into it for a while. 🧐

With @BrtqKr we tried different approaches to solve it (get rid of these additional 2 re-renders). We've tried to apply memoization and useCallbacks to the related functions/values, but nothing seemed to help.
We believe this is related to the fact that we're waiting for the modal to close, before proceeding with the following actions. This happens inside of the different scope(Modal.close() to be more precise), preventing batching of the updates, which is causing 2 extra re-renders in result.
The previous behaviour was not stable and because we have react forget enabled, this shouldn't be much of an issue. 😊

@arosiclair
Copy link
Contributor

@shubham1206agra Android native video is missing in your checklist

We believe this is related to the fact that we're waiting for the modal to close, before proceeding with the following actions.

Sounds like we can't avoid this. Should we update the test to expect a slower time?

@zfurtak
Copy link
Contributor Author

zfurtak commented Jul 30, 2024

Sounds like we can't avoid this. Should we update the test to expect a slower time?

@arosiclair yes exactly, it would be perfect!

@shubham1206agra
Copy link
Contributor

Android native video is missing in your checklist

@arosiclair Right now my android native build is not compiling.

@arosiclair
Copy link
Contributor

Sounds like we can't avoid this. Should we update the test to expect a slower time?

@arosiclair yes exactly, it would be perfect!

Not sure how to update it. Asked about that here.

Android native video is missing in your checklist

@arosiclair Right now my android native build is not compiling.

Can you try fixing it? Start a thread in #expensify-open-source if you're having trouble.

@shubham1206agra
Copy link
Contributor

@arosiclair Uploaded the Android Native recording.

Copy link
Contributor

@arosiclair arosiclair left a comment

Choose a reason for hiding this comment

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

LGTM 👍. Per this thread we just have to merge this with the performance test failing to set a new baseline for it.

@arosiclair arosiclair merged commit ec38b05 into Expensify:main Aug 1, 2024
14 of 15 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Aug 1, 2024

✋ 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

OSBotify commented Aug 2, 2024

🚀 Deployed to staging by https://github.com/arosiclair in version: 9.0.16-0 🚀

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

Comment on lines 123 to +124
onItemSelected(selectedItem, index);
selectedItem.onSelected?.();
Copy link
Contributor

@aldo-expensify aldo-expensify Aug 2, 2024

Choose a reason for hiding this comment

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

The changes in this file caused a regression: #46746

I'm trying to understand this component, why do we have two callbacks when we click a menu item? onItemSelected / selectedItem.onSelected?

Copy link
Contributor

Choose a reason for hiding this comment

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

You can ignore that question, I see that they are just two "types" of callback, and in the broken flow onItemSelected(selectedItem, index) takes care of closing the context menu (menu opened with the 3 dots), meanwhile selectedItem.onSelected?.(); is supposed to open the next confirmation modal.

I think the difference in the implementation is that now selectedItem.onSelected?.(); gets called earlier. Before it was called in the onModalHide callback.

@aldo-expensify
Copy link
Contributor

aldo-expensify commented Aug 2, 2024

I see that there may be more places where you missed wrapping in this Model.close(() => {...}, for example:

onSelected: () => setIsDeleteTagsConfirmModalVisible(true),

Update: seems like in this case it is not necessary since it works well 🤷 . When is it necessary to use Model.close(() => {...}?

@zfurtak
Copy link
Contributor Author

zfurtak commented Aug 5, 2024

Update: seems like in this case it is not necessary since it works well 🤷 . When is it necessary to use Model.close(() => {...}?

@aldo-expensify
Since the action is now being called earlier in some cases, the modal (PopoverMenu) doesn't have enough time to close and remains as a parent of a new modal that is opened. Without Modal.close(() => ... wrapping the new modal is opened but with height = 0 and width = 0.
We need to add it in cases when another modal is opening, in the app it's mostly deleting, because of opening delete confirmation modal (ConfirmModal) or adding attachment/photo.

@marcaaron
Copy link
Contributor

I believe this also caused the regression here

@OSBotify
Copy link
Contributor

OSBotify commented Aug 6, 2024

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.16-8 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 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.

8 participants