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 context menu when long press on url and email link #12987

Merged
merged 12 commits into from
Jan 12, 2023

Conversation

b1tjoy
Copy link
Contributor

@b1tjoy b1tjoy commented Nov 24, 2022

Details

When long press on URL/email link in comment, "Copy URL to clipboard" or "Copy e-mail to clipboard" does not show, this PR fix it by replace LongPressGestureHandler with Pressable in PressableWithSecondaryInteraction.

Because of the limitation of gesture responder system of react-native, only the inner Pressable in a nested Pressable tree can catch long press event, and because of the limitation of react-native-render-html, we can not pass necessary data to the inner Pressable to display context menu. So we use React Context API to let the inner pressable component display context menu in it's long press event handler.

But use Pressable cause some regressions, this PR fix the regressions too. Regressions need to notice:

  1. Long press on image opens attachment modal on iOS and Android native, does not show context menu as we expected
  2. Long press on URL link redirect to browser on iOS and Android native, does not show context menu as we expected
  3. Long press on URL/email link opens 3D-Touch menu on iOS/Safari
  4. Long press on code block shows nothing on iOS and Android native, does not show context menu as we expected
  5. Long press on code block opens 3D-Touch menu on iOS/Safari
  6. Long press on IOU card shows nothing on iOS and Android native, does not show context menu as we expected
  7. Long press on IOU card opens 3D-Touch menu on iOS/Safari

Since we can pass props data to IOUAction in ReportActionItem, I use prop drilling to fix regressions with IOU card rather than Context API.

Fixed Issues

$ #8311
PROPOSAL: #8311 (comment)

Tests

  1. Send a mixed comment contains both regular text, URL and email
  2. Long press on regular text in the message you just sent, verify it shows regular context menu
  3. Long press on URL link in the message you just sent, verify it shows "Copy URL to clipboard" context menu
  4. Press on URL link in the message you just sent, verify it opens URL with default browser
  5. Long press on email link in the message you just sent, verify it shows "Copy email to clipboard" context menu
  6. Send an image attachment
  7. Long press on the image you just sent, verify it shows regular context menu
  8. Press on the image you just sent, verify it shows attachment preview modal
  9. Send a comment contains code block, line need to be long enough to make code block horizontally scrollable
  10. Long press on the code block you just sent, verify it shows regular context menu
  11. Use trackpad or finger to scroll code block and verify it can be scrolled horizontally
  12. Use another account to request money from your current account, when you receive IOU action do the next step
  13. Long press on Pay button or other area in IOU card, verify it shows regular context menu
  14. Press on Pay button or other area in IOU card, verify it shows IOU details modal
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Send a mixed comment contains both regular text, URL and email
  2. Long press on regular text in the message you just sent, verify it shows regular context menu
  3. Long press on URL link in the message you just sent, verify it shows "Copy URL to clipboard" context menu
  4. Press on URL link in the message you just sent, verify it opens URL with default browser
  5. Long press on email link in the message you just sent, verify it shows "Copy email to clipboard" context menu
  6. Send an image attachment
  7. Long press on the image you just sent, verify it shows regular context menu
  8. Press on the image you just sent, verify it shows attachment preview modal
  9. Send a comment contains code block, line need to be long enough to make code block horizontally scrollable
  10. Long press on the code block you just sent, verify it shows regular context menu
  11. Use trackpad or finger to scroll code block and verify it can be scrolled horizontally
  12. Use another account to request money from your current account, when you receive IOU action do the next step
  13. Long press on Pay button or other area in IOU card, verify it shows regular context menu
  14. Press on Pay button or other area in IOU card, verify it shows IOU details modal
  • 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:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 was added in all src/languages/* files
    • 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 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 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.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

PR Reviewer Checklist

The reviewer will copy/paste it into a new comment and complete it after the author checklist is completed

  • 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 expected offline behavior are in the Offline steps 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 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 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:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 was added in all src/languages/* files
    • 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
  • 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 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 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
macOS-Chrome-2022-11-24-155600.mp4
Mobile Web - Chrome
Android-Chrome-2022-11-24-155904.mp4
Mobile Web - Safari
iOS-Safari-2022-11-24-155428.mp4
Desktop
macOS-Desktop-2022-11-24-161527.mp4
iOS
iOS-native-2022-11-24-154812.mp4
Android
Android-native-2022-11-24-161045.mp4

@b1tjoy b1tjoy requested a review from a team as a code owner November 24, 2022 10:34
@melvin-bot melvin-bot bot requested review from marcochavezf and parasharrajat and removed request for a team November 24, 2022 10:34
@melvin-bot
Copy link

melvin-bot bot commented Nov 24, 2022

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

@parasharrajat
Copy link
Member

I will start the review today

@parasharrajat
Copy link
Member

It is much more involved than I thought.

Comment on lines 172 to 177
<TouchableWithoutFeedback
onPress={props.onPreviewPressed}
onPressIn={() => props.isSmallScreenWidth && canUseTouchScreen() && ControlSelection.block()}
onPressOut={() => ControlSelection.unblock()}
onLongPress={showContextMenu}
>
Copy link
Member

Choose a reason for hiding this comment

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

I didn't expect these to be changed. But let me test these first.

Copy link
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

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

Started review.

@parasharrajat
Copy link
Member

Sorry for the delay on this. I am currently away. I will actively review it when I am back.

@marcochavezf
Copy link
Contributor

Hi @b1tjoy, could you fix the conflicts?

Copy link
Contributor

@marcochavezf marcochavezf 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 the changes @b1tjoy, the code LGTM so far! I'm leaving a few comments:

src/components/ShowContextMenuContext.js Outdated Show resolved Hide resolved
src/components/ShowContextMenuContext.js Outdated Show resolved Hide resolved
src/components/AnchorForCommentsOnly/index.js Outdated Show resolved Hide resolved
src/components/ReportActionItem/IOUPreview.js Outdated Show resolved Hide resolved
src/components/ShowContextMenuContext.js Outdated Show resolved Hide resolved
@parasharrajat
Copy link
Member

Apologies for the delay on this, I was on/off for the last two weeks. My first thought is that solution is very complex and complex than what I thought it be. I will try to simplify it or remove unnecessary changes. Normally, I suggest breaking it into multiple PRs but it is fine.

I will start testing and the review.

@marcochavezf
Copy link
Contributor

Hi @parasharrajat, let me know if you're actively reviewing this PR, happy to help to review/test it in spare cycles if not.

@parasharrajat
Copy link
Member

Happy to have hands on this.

@marcochavezf
Copy link
Contributor

marcochavezf commented Jan 4, 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 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.
  • 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-01-12.at.12.02.40.mov
Mobile Web - Chrome
Screen.Recording.2023-01-12.at.15.56.06.mov
Mobile Web - Safari
Screen.Recording.2023-01-12.at.15.47.32.mov
Desktop
Screen.Recording.2023-01-12.at.16.03.47.mov
iOS
Screen.Recording.2023-01-12.at.17.06.38.mov
Android
Screen.Recording.2023-01-12.at.16.10.05.mov

@marcochavezf
Copy link
Contributor

Hi @b1tjoy, could you fix again the conflicts? I was OOO, apologies for the delay here. I'm going to continue reviewing it asap once the conflicts are resolved 🙇🏽

@b1tjoy
Copy link
Contributor Author

b1tjoy commented Jan 10, 2023

@marcochavezf Sorry for my late response. Conflicts resolved.

Copy link
Contributor

@marcochavezf marcochavezf left a comment

Choose a reason for hiding this comment

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

LGTM, I tested all possible scenarios, and seems everything is working fine 👍🏽 Thanks @b1tjoy for all the effort here!

@marcochavezf marcochavezf merged commit 81855c2 into Expensify:main Jan 12, 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.

@parasharrajat
Copy link
Member

parasharrajat commented Jan 13, 2023

Lolz, I was finally reviewing it. But it is fine I will still check for code patterns.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by @marcochavezf in version: 1.2.54-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by @AndrewGable in version: 1.2.54-2 🚀

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

@mollfpr
Copy link
Contributor

mollfpr commented Feb 7, 2023

Heyy, coming from this #14301 issue. Our contributors find this PR introduces the issue, specifically the usage of Pressable in the BasePreRenderer component when hovered, the cursor has the pointer style instead of text. To fix it, we replace the Pressable with TouchableWithoutFeedback and have discussed it in Slack.

Thank you!

@sobitneupane
Copy link
Contributor

Going through the issue and PR, it looks like the changes made in this PR is intended to solve the issue in native and mWeb or particularly touch screen devices. This issue reported suggest that the feature of long press should not be available for Web and Desktop. So, we prevented the Long Press Context Menu for Web and Desktop with these changes

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