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

Add support for the paste and match style command #9880

Merged
merged 11 commits into from
Aug 1, 2022
Merged

Add support for the paste and match style command #9880

merged 11 commits into from
Aug 1, 2022

Conversation

marktoman
Copy link
Contributor

@marktoman marktoman commented Jul 13, 2022

Details

Fixed Issues

$ #9240

Test Steps

Desktop (new functionality)

Steps

  1. Select a submitted comment that has formatting in a chat
  2. Press Cmd/Ctrl + C
  3. Move to Composer and press Cmd/Ctrl + V
  4. Delete it and press Cmd/Ctrl + Shift + V
  5. Delete it and press Cmd/Ctrl + Shift + Option/Alt + V

Result
Input has formatting in 3. and loses it in 4 and 5.

Web, except Firefox (new functionality)

Steps

  1. Right-click a submitted comment that has formatting in a chat
  2. Click Copy to clipboard
  3. Move to Composer, right-click, and select Paste
  4. In Chrome, right-click or go to the Edit system menu, click Paste and Match Style. In Safari, this item is only in the Edit menu.
  5. In Chrome, Delete it and press Cmd/Ctrl + Shift + V
  6. In Chrome (mac) and Safari, Delete it and press Cmd + Shift + Option + V

Result
Input has formatting in 3. and loses it in 4-6.

Mobile web and Firefox (retaining existing functionality)

Steps

  1. Long-tap (or right-click) on a submitted comment that has formatting in a chat
  2. Tap Copy to clipboard
  3. Move to Composer, long-tap (or right-click), pick Paste

Result
Input has formatting.

  • Verify that no errors appear in the JS console

PR Review Checklist

Contributor (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 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 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 tagging the marketing team 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
  • 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 */
    • Any functional components have the displayName property
    • 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 Contributor+ 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 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 verified tests pass on all platforms & I tested again 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 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 tagging the marketing team 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 */
    • Any functional components have the displayName property
    • 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.

QA Steps

@Expensify/applauseleads please add this new functionality to the regression test suite

Desktop (new functionality)

Steps

  1. Select a submitted comment that has formatting in a chat
  2. Press Cmd/Ctrl + C
  3. Move to Composer and press Cmd/Ctrl + V
  4. Delete it and press Cmd/Ctrl + Shift + V
  5. Delete it and press Cmd/Ctrl + Shift + Option/Alt + V

Result
Input has formatting in 3. and loses it in 4 and 5.

Web, except Firefox (new functionality)

Steps

  1. Right-click a submitted comment that has formatting in a chat
  2. Click Copy to clipboard
  3. Move to Composer, right-click, and select Paste
  4. In Chrome, right-click or go to the Edit system menu, click Paste and Match Style. In Safari, this item is only in the Edit menu.
  5. In Chrome, Delete it and press Cmd/Ctrl + Shift + V
  6. In Chrome (mac) and Safari, Delete it and press Cmd + Shift + Option + V

Result
Input has formatting in 3. and loses it in 4-6.

Mobile web and Firefox (retaining existing functionality)

Steps

  1. Long-tap (or right-click) on a submitted comment that has formatting in a chat
  2. Tap Copy to clipboard
  3. Move to Composer, long-tap (or right-click), pick Paste

Result
Input has formatting.

  • Verify that no errors appear in the JS console

Screenshots

Web

mac-chrome.mp4
mac-safari.mp4
win-chrome.mp4
win-firefox.mp4

Mobile Web

android-chrome.mp4
android-firefox.mp4
ios-safari.mp4

Desktop

mac-desktop.mp4
mac-desktop.mp4

iOS

ios-native.mp4

Android

android-native.mp4

@marktoman marktoman requested a review from a team as a code owner July 13, 2022 17:38
@melvin-bot melvin-bot bot requested review from parasharrajat and roryabraham and removed request for a team July 13, 2022 17:38
desktop/main.js Outdated Show resolved Hide resolved
src/libs/Clipboard/index.js Outdated Show resolved Hide resolved
src/libs/Clipboard/index.native.js Outdated Show resolved Hide resolved
src/pages/home/report/ContextMenu/ContextMenuActions.js Outdated Show resolved Hide resolved
src/pages/home/report/ContextMenu/ContextMenuActions.js Outdated Show resolved Hide resolved
src/libs/SelectionScraper/base.js Outdated Show resolved Hide resolved
src/libs/SelectionScraper/base.js Outdated Show resolved Hide resolved
src/libs/SelectionScraper/base.js Outdated Show resolved Hide resolved
src/pages/home/report/ContextMenu/ContextMenuActions.js Outdated Show resolved Hide resolved
@marktoman
Copy link
Contributor Author

marktoman commented Jul 16, 2022

There is one thing with the edit menu on desktop.

Currently, we have two Paste and Match style menu items under Edit in the system menu. One is provided by electron, which has a slightly different shortcut. Second we add ourselves. We have to have an item in the system menu for a keyboard shortcut to register. A context menu item with the shortcut is not enough.

What I have tried:

  • Pick the default item and change the shortcut. This does not work because the electron items are supplied after we submit ours (i.e. the arrays are empty).
  • Keep both items, but set ours with visible: false. This does not work for roles like paste and pasteAndMatchStyle. I assume the reason is security.

Options:

  • Keep both items
  • Remove ours and use the provided shortcut in the right-click context menu as well
  • Build the system menu from a template. The template would replace Menu.getApplicationMenu() with Menu.buildFromTemplate(template). The modifications below it that access the systemMenu variable remain the same. Inside the template, we simply add our shortcut: { role: 'pasteAndMatchStyle', accelerator: 'CmdOrCtrl+Shift+V' }. You can see the diff and test it as well.

@parasharrajat
Copy link
Member

parasharrajat commented Jul 16, 2022

I have no clue about it so far. I will dig in and let you know. It would also be good to hear the pros of each option.

One is provided by electron, which has a slightly different shortcut.

What is different with native one?

@marktoman
Copy link
Contributor Author

Electron provides us with the standard shortcut for paste and match style on mac (used in Text Edit, Safari, etc.), which includes alt.

We can decide to honor it because the input context menu makes the shortcut evident to the user.

The only change would be this in index.js:

contextMenu({
    append: (defaultActions, parameters) => [
        new MenuItem({
            visible: parameters.isEditable,
            role: 'pasteAndMatchStyle',
            accelerator: 'CmdOrCtrl+Alt+Shift+V',
        }),
    ],
});

Result:

image

image

@marktoman
Copy link
Contributor Author

Keeping both items has the disadvantage of adding Paste and Match Style twice in the Edit menu, once for each shortcut. (This is not the case for the context menu.) It has the advantage of supporting both shortcuts.

Making cmd+shift+v default has the disadvantage of explicitly adding the menu template instead of leaving the default items to Electron.

Honoring the standard shortcut has the advantage of making the least amount of changes in index.js and adding no duplicit items to the Edit menu, and users expect this shortcut to work.

I think that because the context menu item makes the shortcut hard to miss, the shortcut itself is slightly less important.

@parasharrajat
Copy link
Member

I will test this tomorrow. Thanks for the details.

@marktoman
Copy link
Contributor Author

I've found that while chrome shows cmd+shift+v in the Edit menu (probably for parity with windows), it supports the standard mac shortcut as well. I think that from the mac user's point of view, cmd+shift+alt+v is essential while the other one is not.

@parasharrajat
Copy link
Member

I am also in favor of using the system default. I wonder what is used for safari.

@marktoman
Copy link
Contributor Author

Safari and other native mac apps use the standard. cmd+shift+v does not do anything in Safari.

@parasharrajat
Copy link
Member

I will test it shortly and open a discussion about this on the issue to get a consensus for different shortcuts on MAC.

@marktoman
Copy link
Contributor Author

Here it is in action:

mac-desktop.mp4

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.

I have suggested a few things that I feel are more reasonable. Feel free to discuss in case, you don't like any change. I am happy to get better ideas.

desktop/main.js Show resolved Hide resolved
desktop/main.js Outdated Show resolved Hide resolved
src/pages/settings/AppDownloadLinks.js Outdated Show resolved Hide resolved
src/libs/SelectionScraper/BaseSelectionScraper.js Outdated Show resolved Hide resolved
src/libs/SelectionScraper/BaseSelectionScraper.js Outdated Show resolved Hide resolved
src/libs/SelectionScraper/index.js Outdated Show resolved Hide resolved
src/libs/SelectionScraper/index.js Outdated Show resolved Hide resolved
src/libs/SelectionScraper/index.native.js Outdated Show resolved Hide resolved
src/libs/Clipboard/index.js Outdated Show resolved Hide resolved
src/pages/home/report/ContextMenu/ContextMenuActions.js Outdated Show resolved Hide resolved
src/libs/Clipboard/index.js Outdated Show resolved Hide resolved
src/libs/Clipboard/index.js Outdated Show resolved Hide resolved
src/libs/Clipboard/index.native.js Outdated Show resolved Hide resolved
src/libs/SelectionScraper/BaseSelectionScraper.js Outdated Show resolved Hide resolved
src/libs/SelectionScraper/BaseSelectionScraper.js Outdated Show resolved Hide resolved
src/libs/SelectionScraper/index.js Outdated Show resolved Hide resolved
src/pages/home/report/ContextMenu/ContextMenuActions.js Outdated Show resolved Hide resolved
desktop/main.js Outdated Show resolved Hide resolved
src/pages/home/report/ContextMenu/ContextMenuActions.js Outdated Show resolved Hide resolved
@marktoman
Copy link
Contributor Author

I have updated the description with a testing step for desktop and with the video showing all new desktop functionality.

@marktoman
Copy link
Contributor Author

I've updated the description with a video for Safari and fixed related steps.

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.

What do you think of the suggestions?

src/pages/home/report/ContextMenu/ContextMenuActions.js Outdated Show resolved Hide resolved
src/libs/SelectionScraper/index.js Outdated Show resolved Hide resolved
src/libs/SelectionScraper/index.native.js Outdated Show resolved Hide resolved
src/pages/home/report/ContextMenu/ContextMenuActions.js Outdated Show resolved Hide resolved
src/pages/home/report/ContextMenu/ContextMenuActions.js Outdated Show resolved Hide resolved
src/pages/home/report/ContextMenu/ContextMenuActions.js Outdated Show resolved Hide resolved
src/pages/home/report/ContextMenu/ContextMenuActions.js Outdated Show resolved Hide resolved
@marktoman
Copy link
Contributor Author

@parasharrajat I've added your latest suggestions to this version. What do you think?

@parasharrajat
Copy link
Member

Looking much better. let's try to revert the unnecessary changes.

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.

It's not working on Safari and firefox. I understand the reason for firefox but what about safari.

@marktoman
Copy link
Contributor Author

It is working in Safari. Have you followed the steps?

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.

OK, looking good to me.

A few points about the PR.

  1. We have implemented the native support for paste and match formatting instead of using Ctrl+Shift+V on all platforms. It may be technically impossible for some of the platforms to use a custom shortcut for such a feature. But most of the platform supports Ctrl+Shift+V for the same.

cc: @roryabraham

PR 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 verified tests pass on all platforms & I tested again 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 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 tagging the marketing team 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 */
    • Any functional components have the displayName property
    • 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.

🎀 👀 🎀 C+ reviewed

@parasharrajat
Copy link
Member

@marktoman Please mention in the tests and QA steps that this does not work on Firefox Web. Also, Please add QA steps. If tests and QA steps are same copy paste them.

@roryabraham roryabraham merged commit f654cc1 into Expensify:main Aug 1, 2022
@OSBotify
Copy link
Contributor

OSBotify commented Aug 1, 2022

🚀 Deployed to staging by @roryabraham in version: 1.1.87-1 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Aug 4, 2022

🚀 Deployed to production by @yuwenmemon in version: 1.1.87-9 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants