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 copy and paste text inconsistent on mWeb #13396

Merged
merged 4 commits into from
Dec 9, 2022

Conversation

b1tjoy
Copy link
Contributor

@b1tjoy b1tjoy commented Dec 7, 2022

Details

When we copy a multiple line message which contains whitespace in the beginning of line by our App's Copy to clipboard context menu, then long press composer textbox and paste what we copied to it on iOS Safari, whitespace in the beginning of line is missing (problem 1). If we use quick paste suggestion on GBoard to paste what we copied on Android Chrome, new line is missing (problem 2), < and > is encoded (problem 3). This PR fix problem 1.

@aldo-expensify fix problem 2 in PR Expensify/expensify-common#474 and #12968. I fix problem 3 in PR #13108. Both PRs have been merged into main branch.

Since we use Clipboard API to write data to system pasteboard, and Clipboard API is available only in secure context (https), if you test with your local ip address, you need to enable https first.

"web-server": "webpack-dev-server --open --config config/webpack/webpack.dev.js",

-     "web-server": "webpack-dev-server --open --config config/webpack/webpack.dev.js",
+     "web-server": "webpack-dev-server --open --config config/webpack/webpack.dev.js --server-type https",

Fixed Issues

$ #10262
PROPOSAL: #10262 (comment)

Tests

  1. Launch and login to Expensify App
  2. Open any chat
  3. Copy multiple line of code from GitHub repo source code page, the text you copied must contain at least one line which has whitespace in the beginning of the line, and must contain < or > too
  4. Paste the text you copied to textbox and send it as plain text rather than code block
  5. Long press the message you just sent, open context menu
  6. Press Copy to clipboard on context menu
  7. Long press textbox and paste to textbox using system paste menu
  8. Verify the text you paste, new line is not missing, whitespace in the beginning of line is not missing, < is not encoded as &lt;, > is not encoded as &gt;
  9. Focus textbox and press quick paste suggestion on GBoard to paste to textbox (this step and the next one are for Android Chrome)
  10. Verify the text you paste, new line is not missing, whitespace in the beginning of line is not missing, < is not encoded as &lt;, > is not encoded as &gt;
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Launch and login to Expensify App
  2. Open any chat
  3. Copy multiple line of code from GitHub repo source code page, the text you copied must contain at least one line which has whitespace in the beginning of the line, and must contain < or > too
  4. Paste the text you copied to textbox and send it as plain text rather than code block
  5. Long press the message you just sent, open context menu
  6. Press Copy to clipboard on context menu
  7. Long press textbox and paste to textbox using system paste menu
  8. Verify the text you paste, new line is not missing, whitespace in the beginning of line is not missing, < is not encoded as &lt;, > is not encoded as &gt;
  9. Focus textbox and press quick paste suggestion on GBoard to paste to textbox (this step and the next one are for Android Chrome)
  10. Verify the text you paste, new line is not missing, whitespace in the beginning of line is not missing, < is not encoded as &lt;, > is not encoded as &gt;
  • 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.

Screenshots/Videos

Web
macOS-Chrome-2022-12-07-220100.mp4
Mobile Web - Chrome
Android-Chrome-2022-12-07-221943.mp4
Mobile Web - Safari
iOS-Safari-2022-12-07-220527.mp4
Desktop
macOS-Desktop-2022-12-07-224349.mp4
iOS
iOS-native-2022-12-07-221319.mp4
Android
Android-native-2022-12-07-223825.mp4

@b1tjoy b1tjoy requested a review from a team as a code owner December 7, 2022 15:48
@melvin-bot melvin-bot bot requested review from parasharrajat and pecanoro and removed request for a team December 7, 2022 15:48
@melvin-bot
Copy link

melvin-bot bot commented Dec 7, 2022

@pecanoro @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

Testing now.

@parasharrajat
Copy link
Member

parasharrajat commented Dec 8, 2022

Screenshots

🔲 iOS / native

screen-2022-12-09_02.04.56.mp4

🔲 iOS / Safari

screen-2022-12-09_01.53.27.mp4

🔲 MacOS / Desktop

screen-2022-12-09_02.04.33.mp4

🔲 MacOS / Chrome

screen-2022-12-09_00.46.31.mp4

🔲 Android / Chrome

screen-2022-12-09_00.45.50.mp4

🔲 Android / native

screen-2022-12-09_01.02.17.mp4

parasharrajat
parasharrajat previously approved these changes Dec 8, 2022
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.

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:
    • 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
  • 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.

cc: @pecanoro

🎀 👀 🎀 C+ reviewed

try {
document.execCommand('copy');
// eslint-disable-next-line no-empty
} catch (e) {}
Copy link
Contributor

Choose a reason for hiding this comment

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

Any specific reason why we need an empty catch here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I took code snippets from here, the 'copy' command can throw an error according to W3C Doc.

paste(text) {
try {
document.execCommand('insertText', false, text);
this.updateNumberOfLines();
// Pointer will go out of sight when a large paragraph is pasted on the web. Refocusing the input keeps the cursor in view.
this.textInput.blur();
this.textInput.focus();
// eslint-disable-next-line no-empty
} catch (e) {}
}

Copy link
Contributor

Choose a reason for hiding this comment

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

Got it! Can you add a comment explaining why then?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done. Please review.

Copy link
Contributor

Choose a reason for hiding this comment

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

Can you move the comment inside the catch as discussed here? https://expensify.slack.com/archives/C01GTK53T8Q/p1670607994265879

@parasharrajat
Copy link
Member

@pecanoro Let's get this merged today.

@pecanoro pecanoro merged commit 354db82 into Expensify:main Dec 9, 2022
@OSBotify
Copy link
Contributor

OSBotify commented Dec 9, 2022

✋ 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 production by @chiragsalian in version: 1.2.38-6 🚀

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

@mollfpr
Copy link
Contributor

mollfpr commented Feb 2, 2023

Hi! Coming from this issue #14300 where this PR introduces the regression. selection.removeAllRanges(); is removed the highlight from the selection.

Thank you!

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