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

Ignore unselectable text from selection #27421

Merged
merged 2 commits into from
Sep 18, 2023

Conversation

bernhardoj
Copy link
Contributor

@bernhardoj bernhardoj commented Sep 14, 2023

Details

On the web, there is some text that is not selectable but we can still copy it when using copy shortcut CTRL+C.

Fixed Issues

$ #26694
PROPOSAL: #26694 (comment)

Tests

Same as QA Steps

  • Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Web
NOTE: if you encounter a case where the pasted text contains some random style text, it's a known issue that won't be fixed based on this comment
Emoji reaction:

  1. Send any message to a chat
  2. Add an emoji reaction to the message
  3. Triple click the message to select it
  4. Press CTRL+C and paste it to composer or any text editor
  5. Verify the pasted text does not contain any emoji

Menu item:

  1. Open Settings > Profile > Timezone
  2. Turn on the automatic timezone
  3. Select the Timezone title text and drag it to the bottom of the timezone name
  4. Press CTRL+C and paste it to composer or any text editor
  5. Verify the pasted text does not contain the timezone name

Multiple Avatars 1:

  1. Open workspace invite page
  2. Select more than 8 users to invite and press Next
  3. Drag a text selection from the header to the bottom of +N text of the avatar overlay
  4. Press CTRL+C and paste it to composer or any text editor
  5. Verify the pasted text does not contain the +N text

Multiple Avatars 2:

  1. Create a new group chat with >= 3 members and open it
  2. Drag a text selection from the first user name on the chat header to the left of +N text of the avatar
  3. Press CTRL+C and paste it to composer or any text editor
  4. Verify the pasted text does not contain the +N text

Calendar:

  1. Open Settings > Profile > Personal Details > Date of birth
  2. Drag a text selection from "Date of birth" title to the bottom of the Save button text
  3. Press CTRL+C and paste it to composer or any text editor
  4. Verify the pasted text does not contain any text from the calendar and the Save button

Edited message:

  1. Send any message to a chat
  2. Edit the message
  3. Select the message along with the (edited) text
  4. Press CTRL+C and paste it to composer or any text editor
  5. Verify the pasted message does not contain any space

Reply:

  1. Send any message to a chat
  2. Add a new reply to the message you sent
  3. Drag a text selection from the message to the bottom of "N Reply" text
  4. Press CTRL+C and paste it to composer or any text editor
  5. Verify the pasted text does not contain "N Reply" text and its timestamp

List item 1:

  1. Open Settings > Profile > Personal Details > Pronouns
  2. Search for any pronouns
  3. Drag a text selection from the Pronouns title to the pronouns list
  4. Press CTRL+C and paste it to composer or any text editor
  5. Verify the pasted text does not contain the pronouns list

List item 2:

  1. Open workspace members page
  2. Drag a text selection from Members title to the members list
  3. Press CTRL+C and paste it to composer or any text editor
  4. Verify the pasted text does not contain the members list and the Select all text

New message:

  1. Open any chat with a few messages
  2. Mark the last message as unread
  3. Scroll up to show the "New message" floating view
  4. Drag a text selection from the user name on the header to the end of "New message" text
  5. Press CTRL+C and paste it to composer or any text editor
  6. Verify the pasted text does not contain "New message"

Text input prefix

  1. Press FAB and choose New room
  2. Drag a text selection from the new room title to the bottom of the "#" prefix text
  3. Press CTRL+C and paste it to composer or any text editor
  4. Verify the pasted text does not contain the prefix ("#") text
  • 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

Emoji reaction

emoji.mov

List 1 (RadioListItem)

radio.list.item.mov

List 2 (BaseSelectionList + UserListItem)

selection.list.mov

MenuItem (timezone)

timezone.menuitem.mov

MultipleAvatars

multiple.avatar_2.mov
multiple_avatar_1.mov

CalendarPicker + Button

button.+.calendar.mov

Edited text

edited.mov

Thread reply

reply.mov

Floating New message

new.message.mov

Prefix

prefix.mov
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android

@bernhardoj bernhardoj requested a review from a team as a code owner September 14, 2023 09:10
@melvin-bot melvin-bot bot removed the request for review from a team September 14, 2023 09:10
@melvin-bot
Copy link

melvin-bot bot commented Sep 14, 2023

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

@melvin-bot melvin-bot bot requested a review from 0xmiros September 14, 2023 09:10
@melvin-bot
Copy link

melvin-bot bot commented Sep 14, 2023

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

@bernhardoj
Copy link
Contributor Author

The issue only happens when using the copy shortcut, so the fix is only applied to a component with a user-select none style on the web (large screen). However, we still have 1 component that I haven't applied the fix yet, that is OfflineWithFeedback. The reason is, that OfflineWithFeedback is used in some places where the children override the user-select none to user-select text, for example, BaseAnchorForCommentsOnly.

This means, that even though the OfflineWithFeedback is not selectable, the BaseAnchorForCommentsOnly is still selectable. If we ignore the selection from all OfflineWithFeedback, selecting anchor text and copying it will not include the anchor text, as shown below:

Screen.Recording.2023-09-14.at.17.18.00.mov

I don't know the reason why we are setting the user-select text to BaseAnchorForCommentsOnly or to all markdown text actually (in BaseHTMLEngineProvider), but the question is, do we ignore it or add new props to OfflineWithFeedback (called shouldIgnoreSelectionOnDelete, defaults true) and pass it as false in BaseAnchorForCommentsOnly case?

dataSet: {[CONST.SELECTION_SCRAPER_HIDDEN_ELEMENT]: props.shouldIgnoreSelectionOnDelete}

Copy link
Contributor

@0xmiros 0xmiros left a comment

Choose a reason for hiding this comment

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

Seems like you put dataSet code on all views where selectable={false} is passed.
Can we put in base component - Text, BaseGenericPressable so if selectable={false} is passed, add dataSet prop manually?

@bernhardoj
Copy link
Contributor Author

@0xmiroslav that's actually a nice idea, but I see that react-native-web 0.19 deprecated selectable props and we are in the process of updating it to >= 0.19. I'm afraid that if we apply the dataSet in the Text/BaseGenericPressable and set the value based on selectable, it will be removed along with selectable (or may not be removed at all which makes the value always false, or undefined).

@0xmiros
Copy link
Contributor

0xmiros commented Sep 15, 2023

@0xmiroslav that's actually a nice idea, but I see that react-native-web 0.19 deprecated selectable props and we are in the process of updating it to >= 0.19. I'm afraid that if we apply the dataSet in the Text/BaseGenericPressable and set the value based on selectable, it will be removed along with selectable (or may not be removed at all which makes the value always false, or undefined).

Makes sense 👍

@0xmiros
Copy link
Contributor

0xmiros commented Sep 15, 2023

@bernhardoj please fix conflict

@bernhardoj
Copy link
Contributor Author

Conflicts solved

@@ -28,6 +29,7 @@ function EditedRenderer(props) {
<Text
selectable={false}
style={[styles.w1, styles.userSelectNone]}
dataSet={{[CONST.SELECTION_SCRAPER_HIDDEN_ELEMENT]: true}}
Copy link
Contributor

Choose a reason for hiding this comment

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

Personally I think adding space (messsage (edited)) is better than no space (messsage(edited))

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yeah, me too, but I don't know why we added userSelectNone to the space.

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe to fix these:
#15194
#23402

Copy link
Contributor Author

Choose a reason for hiding this comment

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

huh interesting, let's keep it then

@0xmiros
Copy link
Contributor

0xmiros commented Sep 16, 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 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
web1.mov
web2.mov
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android

Copy link
Contributor

@0xmiros 0xmiros 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 Li357 September 16, 2023 19:36
Copy link
Contributor

@Li357 Li357 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, thanks for the thorough testing here!

@Li357 Li357 merged commit 5d4b49b into Expensify:main Sep 18, 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.

@getusha
Copy link
Contributor

getusha commented Sep 18, 2023

@0xmiroslav that's actually a nice idea, but I see that react-native-web 0.19 deprecated selectable props and we are in the process of #24482. I'm afraid that if we apply the dataSet in the Text/BaseGenericPressable and set the value based on selectable, it will be removed along with selectable (or may not be removed at all which makes the value always false, or undefined).

Thank you for taking this into consideration @bernhardoj @0xmiroslav

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/Li357 in version: 1.3.71-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.71-12 🚀

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