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: long press app download links on mweb Safari to open the Copy to Clipboard menu #17310

Merged
merged 15 commits into from
Apr 14, 2023

Conversation

akinwale
Copy link
Contributor

@akinwale akinwale commented Apr 11, 2023

Details

Allow the app download links and other external links to display the Copy to Clipboard menu when a user long-presses the item. Refactor MenuItem to get rid of nested Pressables.

Fixed Issues

$ #16946
PROPOSAL: #16946 (comment)

Tests

  1. Log in to any account
  2. Open the Settings page.
  3. Long-press the Help link. This should present the Copy to Clipboard overlay with the action and link displayed at the bottom.
  4. Use the Copy to Clipboard action and verify the copied URL.
  5. Open the About page.
  6. Long-press the View the code link. This should present the Copy to Clipboard overlay.
  7. Repeat step 4.
  8. Long-press the View open jobs link. This should present the Copy to Clipboard overlay.
  9. Repeat step 4.
  10. Click on App download links.
  11. Long-press on each of the links. The Copy to Clipboard overlay should be displayed after long-pressing each link.
  12. Verify that copied URL matches for each of the links.
  • Verify that no errors appear in the JS console

Offline tests

Same as tests.

QA Steps

Same as tests.

  • 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 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 correct English and 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
    • 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 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

Web

Mobile Web - Chrome
16946-android-chrome.webm
Mobile Web - Safari
16946-ios-safari.mov
Desktop

Desktop

iOS
16946-ios-native.mov
Android
16946-android-native.webm

@akinwale akinwale requested a review from a team as a code owner April 11, 2023 22:22
@melvin-bot melvin-bot bot requested review from eVoloshchak and mountiny and removed request for a team April 11, 2023 22:22
@MelvinBot
Copy link

@mountiny @eVoloshchak One of you needs to 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]

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

Great job, and great comments from @eVoloshchak! I would really make sure we cover testing of all the platforms for where the MenuItem components is used since its quite often used component

@akinwale
Copy link
Contributor Author

Great job, and great comments from @eVoloshchak! I would really make sure we cover testing of all the platforms for where the MenuItem components is used since its quite often used component

Thanks for the feedback. I manually tested the component on both (Android / iOS) native mobile and mobile web platforms, as well as desktop and regular web browsers.

@akinwale akinwale requested a review from eVoloshchak April 12, 2023 11:44
@eVoloshchak
Copy link
Contributor

@akinwale, besides one small change, the code looks good to me.
There are a couple of pages left this logic needs to be added to, namely GetAssistancePage and WorkspaceTravelVBAView (I think that's all the pages, but I'd appreciate it if you double-check once more if I missed something)

@akinwale
Copy link
Contributor Author

akinwale commented Apr 12, 2023

@akinwale, besides one small change, the code looks good to me. There are a couple of pages left this logic needs to be added to, namely GetAssistancePage and WorkspaceTravelVBAView (I think that's all the pages, but I'd appreciate it if you double-check once more if I missed something)

@eVoloshchak I am unable to determine one of the links for WorkspaceTravelVBAView as it makes use of the Link.openOldDotLink method instead of an actual string constant. However, it looks like they defer to a component called Section which in turn renders a MenuItemList where the MenuItems are rendered. I will add the logic to MenuItemList and then the missing links that I cannot determine for the MenuItems can be updated in a separate PR. Is this ok?

@akinwale akinwale requested a review from eVoloshchak April 12, 2023 16:37
@eVoloshchak
Copy link
Contributor

@eVoloshchak I am unable to determine one of the links for WorkspaceTravelVBAView as it makes use of the Link.openOldDotLink method instead of an actual constant. However, it looks like they defer to a component called Section which in turn renders a MenuItemList where the MenuItems are rendered. I will add the logic to MenuItemList and then the missing links that I cannot determine for the MenuItems can be updated in a separate PR. Is this ok?

I think it's possible to determine the link. If we move buildOldDotURL into the upper scope (so it can be called using Link.buildOldDotURL), we can then add the following here:

link: Link.buildOldDotURL('domain_companycards')

@akinwale
Copy link
Contributor Author

akinwale commented Apr 12, 2023

@eVoloshchak I am unable to determine one of the links for WorkspaceTravelVBAView as it makes use of the Link.openOldDotLink method instead of an actual constant. However, it looks like they defer to a component called Section which in turn renders a MenuItemList where the MenuItems are rendered. I will add the logic to MenuItemList and then the missing links that I cannot determine for the MenuItems can be updated in a separate PR. Is this ok?

I think it's possible to determine the link. If we move buildOldDotURL into the upper scope (so it can be called using Link.buildOldDotURL), we can then add the following here:

link: Link.buildOldDotURL('domain_companycards')

I don't think this will work. The buildldDotURL takes a shortLivedAuthToken as a parameter, which is different from the url parameter that is passed to openOldDotLink. This seems like it would be a more complex implementation. Also, I feel that it's beyond the scope of this PR.

@eVoloshchak
Copy link
Contributor

eVoloshchak commented Apr 12, 2023

The buildldDotURL takes a shortLivedAuthToken

It's optional: If shortLivedAuthToken is not accessible, fallback to opening the link without the token, so all we need to do is move it to the upper scope

Also, I feel that it's beyond the scope of this PR.

I'm not too sure about that, the original requirement was: any menu item which is a link should have this behaviour

@akinwale
Copy link
Contributor Author

The buildldDotURL takes a shortLivedAuthToken

It's optional: If shortLivedAuthToken is not accessible, fallback to opening the link without the token, so all we need to do is move it to the upper scope

Also, I feel that it's beyond the scope of this PR.

I'm not too sure about that, the original requirement was: any menu item which is a link should have this behaviour

The buildOldDotURL method returns a promise. Therefore assigning it to link property directly as you demonstrated still wouldn't work.

It is out of scope because it's a refactor of business logic for building old URLs. The logic for the handling of links to display the Copy to Clipboard menu has already been implemented in the MenuItemList. The only thing left that's left is to set the link property for this particular link. If I can get the actual URL that this points to, then I can define a new constant and use that instead.

@akinwale
Copy link
Contributor Author

@eVoloshchak
Looking at the method, it looks like the resulting URL will be https://www.expensify.com/domain_companycards. Can you confirm if this is correct? We can just define a string constant in WorkspaceTravelVBAView and set it to this.

@eVoloshchak
Copy link
Contributor

@eVoloshchak Looking at the method, it looks like the resulting URL will be https://www.expensify.com/domain_companycards. Can you confirm if this is correct? We can just define a string constant in WorkspaceTravelVBAView and set it to this.

It also contains current email, so we can't define it as a constant
https://www.expensify.com.dev/domain_companycards?email=someemail%2B01%40gmail.com

I'm investigating how we can get the result of buildOldDotURL, hold on

@eVoloshchak
Copy link
Contributor

@akinwale, we can add the following here:

link: () => Link.buildOldDotURL('domain_companycards')

And then in MenuItemList
onSecondaryInteraction={e => onSecondaryInteraction(menuItemProps.link, e)}, where

    const onSecondaryInteraction = (link, e) => {
        if (typeof link === 'function') {
            link().then(url => ReportActionContextMenu.showContextMenu(CONTEXT_MENU_TYPES.LINK, e, url, popoverAnchor));
        } else if (!_.isEmpty(link)) {
            ReportActionContextMenu.showContextMenu(CONTEXT_MENU_TYPES.LINK, e, link, popoverAnchor);
        }
    };

@akinwale akinwale force-pushed the task-16946 branch 2 times, most recently from a7829b6 to 206bf05 Compare April 12, 2023 18:21
@akinwale akinwale requested a review from eVoloshchak April 13, 2023 19:26
@akinwale akinwale requested a review from eVoloshchak April 13, 2023 19:41
{_.map(props.menuItems, menuItemProps => (
<MenuItem
key={menuItemProps.title}
onSecondaryInteraction={_.isEmpty(menuItemProps.link) ? e => secondaryInteraction(menuItemProps.link, e) : undefined}
Copy link
Contributor

@eVoloshchak eVoloshchak Apr 13, 2023

Choose a reason for hiding this comment

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

This works but I don't understand why.
Why are we calling secondaryInteraction if link is empty? Shouldn't it be the other way around?
UPD: It doesn't work properly, it opens the context menu only if link is a function

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It shoud be !_.isEmpty. Let me double-check.

Copy link
Contributor Author

@akinwale akinwale Apr 13, 2023

Choose a reason for hiding this comment

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

Yeah, I'll have to explicitly check if it's a function first before isEmpty. eslint complains about explicitly converting to Boolean.

Copy link
Contributor

Choose a reason for hiding this comment

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

I haven't tested, but maybe _.isUndefined will be of help

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's a better option, thanks.

@akinwale akinwale requested a review from eVoloshchak April 13, 2023 20:06
@eVoloshchak
Copy link
Contributor

eVoloshchak commented Apr 13, 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 / 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 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 correct English and 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 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
Screen.Recording.2023-04-13.at.23.20.32.mov
Mobile Web - Chrome
Screen_Recording_20230413-231250_Chrome.mp4
Mobile Web - Safari
IMG_0016.MP4
Desktop
Screen.Recording.2023-04-13.at.23.18.59.mov
iOS
IMG_0015.MP4
Android
Screen_Recording_20230413-231203_New.Expensify.mp4

Copy link
Contributor

@eVoloshchak eVoloshchak left a comment

Choose a reason for hiding this comment

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

Looks good and tests well!
cc: @mountiny

Copy link
Contributor

@AndrewGable AndrewGable left a comment

Choose a reason for hiding this comment

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

Not super involved in initial proposal, but code looks good to me. Leaving merge for @mountiny

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

Great job on this one both @akinwale and @eVoloshchak thanks!

@mountiny mountiny merged commit 4607dcb into Expensify:main Apr 14, 2023
@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/mountiny in version: 1.3.1-0 🚀

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

1 similar comment
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 1.3.1-0 🚀

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

mountiny added a commit that referenced this pull request Apr 18, 2023
This reverts commit 4607dcb, reversing
changes made to 6ee5e7a.
AndrewGable added a commit that referenced this pull request Apr 18, 2023
Revert "Merge pull request #17310 from akinwale/task-16946"
OSBotify pushed a commit that referenced this pull request Apr 18, 2023
Revert "Merge pull request #17310 from akinwale/task-16946"

(cherry picked from commit 479b6ed)
@OSBotify
Copy link
Contributor

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

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 1.3.2-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.2-5 🚀

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.

6 participants