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

The "Copy URL to clipboard" tooltip does not appear when hovering over a task description link #28951

Merged

Conversation

ZhenjaHorbach
Copy link
Contributor

@ZhenjaHorbach ZhenjaHorbach commented Oct 5, 2023

Details

  1. Private Notes - The strikethrough line of the link is displaying in white on the Private Notes page
  2. The "Copy URL to clipboard" tooltip does not appear when hovering over a task description link
  3. The strikethrough line of the link is displaying in white on the Private Notes page

Fixed Issues

$ #27812
$ #28862
$ #28859
PROPOSAL: #27812 (comment)

Tests

  1. Open a chat.
  2. Navigate to the "Assign task" section.
  3. Enter a title and insert a link in the description, then create the task.
  4. After task creation, right-click on the description link.
  5. Observe that the tooltip for "Copy URL to clipboard" does not appear

  1. Navigate to staging.
  2. Open any chat
  3. Click on the header and go to Private notes
  4. Go to My note > Notes
  5. Add ~https://xyz.com/~ and save
  6. Notice that the strikethrough line appears in white

  1. Go to staging
  2. Go to any chat
  3. Click on the header and navigate to Private notes
  4. Go to My note > Notes
  5. Add # https://xvz.com/ and save it
  6. Notice that the link following the hashtag is not displayed in bold
  • Verify that no errors appear in the JS console

Offline tests

  1. Open a chat.
  2. Navigate to the "Assign task" section.
  3. Enter a title and insert a link in the description, then create the task.
  4. After task creation, right-click on the description link.
  5. Observe that the tooltip for "Copy URL to clipboard" does not appear

  1. Navigate to staging.
  2. Open any chat
  3. Click on the header and go to Private notes
  4. Go to My note > Notes
  5. Add ~https://xyz.com/~ and save
  6. Notice that the strikethrough line appears in white

  1. Go to staging
  2. Go to any chat
  3. Click on the header and navigate to Private notes
  4. Go to My note > Notes
  5. Add # https://xvz.com/ and save it
  6. Notice that the link following the hashtag is not displayed in bold

QA Steps

  1. Open a chat.
  2. Navigate to the "Assign task" section.
  3. Enter a title and insert a link in the description, then create the task.
  4. After task creation, right-click on the description link.
  5. Observe that the tooltip for "Copy URL to clipboard" does not appear

  1. Navigate to staging.
  2. Open any chat
  3. Click on the header and go to Private notes
  4. Go to My note > Notes
  5. Add ~https://xyz.com/~ and save
  6. Notice that the strikethrough line appears in white

  1. Go to staging
  2. Go to any chat
  3. Click on the header and navigate to Private notes
  4. Go to My note > Notes
  5. Add # https://xvz.com/ and save it
  6. Notice that the link following the hashtag is not displayed in bold
  • 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 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

Web
Screen.Recording.2023-10-05.at.20.37.46.mov
Screenshot 2023-10-05 at 20 38 31 Screenshot 2023-10-05 at 20 39 33
Mobile Web - Chrome Screenshot 2023-10-05 at 20 55 29 Screenshot 2023-10-05 at 20 56 00
Mobile Web - Safari Screenshot 2023-10-05 at 20 41 17 Screenshot 2023-10-05 at 20 40 56
Desktop Screenshot 2023-10-05 at 20 43 34 Screenshot 2023-10-05 at 20 43 03
Screen.Recording.2023-10-05.at.20.43.56.mov
iOS Screenshot 2023-10-05 at 20 51 20 Screenshot 2023-10-05 at 20 51 44
Android Screenshot 2023-10-05 at 21 53 38 Screenshot 2023-10-05 at 21 54 16

@ZhenjaHorbach ZhenjaHorbach requested a review from a team as a code owner October 5, 2023 19:17
@melvin-bot melvin-bot bot requested review from ntdiary and removed request for a team October 5, 2023 19:17
@melvin-bot
Copy link

melvin-bot bot commented Oct 5, 2023

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

@ZhenjaHorbach
Copy link
Contributor Author

@ntdiary
Hello)
You may have been assigned by accident
But here's the approval from @jjcoffee

#27812 (comment)

@jjcoffee
Copy link
Contributor

jjcoffee commented Oct 6, 2023

@ZhenjaHorbach Just waiting for you to be assigned on the main issue.

@ZhenjaHorbach
Copy link
Contributor Author

@jjcoffee
Hello
I've already been assigned )

@jjcoffee
Copy link
Contributor

jjcoffee commented Oct 9, 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

image
image

Mobile Web - Chrome
android-chrome.mp4
Mobile Web - Safari
ios-safari-2023-10-11_13.12.22.mp4
Desktop
mac-desktop-2023-10-11_13.19.43.mp4
iOS
ios-native-2023-10-11_13.15.00.mp4
Android
android-native.mp4

@jjcoffee
Copy link
Contributor

jjcoffee commented Oct 9, 2023

Based on @thienlnam's comment on Slack, it sounds like we're wanting to disable the Copy URL to clipboard tooltip on the preview/Confirm Task screen, and possibly even remove the autolink too (maybe markdown generally). @Expensify/design might have an opinion on this?

Confirm Task - Should we disable markdown processing altogether here?
image

Task detail

Screenshot from 2023-10-09 17-11-35

@ZhenjaHorbach
Copy link
Contributor Author

ZhenjaHorbach commented Oct 9, 2023

@jjcoffee

If there are such thoughts, then we can probably expand the solution and add 3 item menu states )

  1. Only text
  2. Markdown
  3. <Comment> + Markdown

@ZhenjaHorbach
Copy link
Contributor Author

@shawnborton

Hello )
Can you please confirm the suggestions we should make or make new propositions ?)

Based on @thienlnam's comment on Slack, it sounds like we're wanting to disable the Copy URL to clipboard tooltip on the preview/Confirm Task screen, and possibly even remove the autolink too (maybe markdown generally). @Expensify/design might have an opinion on this?

Confirm Task - Should we disable markdown processing altogether here? image

Task detail

Screenshot from 2023-10-09 17-11-35

cc: @jjcoffee

@shawnborton
Copy link
Contributor

Ah sorry, I commented in Slack, but it sounds like we want to keep markdown/links in this particular view.

As for the tooltip, I think we should stay consistent with other link tooltips in chat which just shows the URL in the tooltip, right?

@ZhenjaHorbach
Copy link
Contributor Author

Ah sorry, I commented in Slack, but it sounds like we want to keep markdown/links in this particular view.

As for the tooltip, I think we should stay consistent with other link tooltips in chat which just shows the URL in the tooltip, right?

Yes, links have the same tooltip with URL copy )

@ZhenjaHorbach
Copy link
Contributor Author

@jjcoffee
If I understood correctly, the ticket is ready )

@ZhenjaHorbach
Copy link
Contributor Author

@jjcoffee , Bump )

@jjcoffee
Copy link
Contributor

@ZhenjaHorbach Did you test with task description on Android? I'm still getting the hashtag rendered (works fine on private notes):

android-native-issue

@ZhenjaHorbach
Copy link
Contributor Author

@ZhenjaHorbach Did you test with task description on Android? I'm still getting the hashtag rendered (works fine on private notes):

android-native-issue

Strange, I will check

@ZhenjaHorbach
Copy link
Contributor Author

ZhenjaHorbach commented Oct 11, 2023

@jjcoffee
You were right )
It's a real problem on Android.
This is due to we parse text for Android with a special character that half of the regular expressions do not understand

This changes was made in this PR
https://github.com/Expensify/App/pull/27462/files

I checked and I didn't find a single reason
Why do we need to add an additional symbol for android during parsing

And it works on private notes, because we get title from props with all tags

@jjcoffee
Copy link
Contributor

@ZhenjaHorbach If you look a bit deeper, it's required because of this

It is to force the text to becomes LTR because the style from styles.ltr uses writingDirection which is not supported on native (the comment mentioned Android only but looks like iOS doesn't support that style too).

To be safe maybe we can just do setHtml(convertToLTR(parser.replace(props.title)));?

@ZhenjaHorbach
Copy link
Contributor Author

ZhenjaHorbach commented Oct 11, 2023

@ZhenjaHorbach If you look a bit deeper, it's required because of this

It is to force the text to becomes LTR because the style from styles.ltr uses writingDirection which is not supported on native (the comment mentioned Android only but looks like iOS doesn't support that style too).

To be safe maybe we can just do setHtml(convertToLTR(parser.replace(props.title)));?

I have tried )
But then an invisible line will appear on description on task )

Maybe add a prop that disables adding a special character?)

Without convertToLTR
Screenshot 2023-10-11 at 15 33 17

With convertToLTR
Screenshot 2023-10-11 at 15 32 17

@jjcoffee
Copy link
Contributor

jjcoffee commented Oct 11, 2023

Ahhh never mind, I see that we do convertToLTR any time we use RenderHTML anyway:

onText: (text) => (text.data = convertToLTR(text.data)),

So should be safe to remove!

Copy link
Contributor

@jjcoffee jjcoffee left a comment

Choose a reason for hiding this comment

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

LGTM!

@melvin-bot melvin-bot bot requested a review from thienlnam October 11, 2023 13:53
@jjcoffee
Copy link
Contributor

Ready for your review @youssef-lr (automation went a bit weird since this is linked to 3 different issues)!

Copy link
Contributor

@youssef-lr youssef-lr left a comment

Choose a reason for hiding this comment

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

LGTM

@youssef-lr youssef-lr merged commit 62e12c9 into Expensify:main Oct 17, 2023
12 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/youssef-lr in version: 1.3.86-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.86-5 🚀

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