Fix paste heading message in chat causes incorrect line breaks #19030

tienifr · 2023-05-16T16:04:24Z

Details

Fixed Issues

$ #16921
PROPOSAL: #16921 (comment)

Tests

Navigate to chat in Chrome and Safari
Open an existing chat and compose a H1 message (e.g., # hello world)
Send the message
Hover over the message and click on the edit pencil
Edit the H1 message (e.g., # hello world1234)
Click Save Changes
Hover over the edited message
Triple-click on the edited H1 message to highlight it
Copy/paste in the composer
Verify the pasted H1 message should not add a new line after #, and it should be the same as the original message

Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Navigate to chat in Chrome and Safari
Open an existing chat and compose a H1 message (e.g., # hello world)
Send the message
Hover over the message and click on the edit pencil
Edit the H1 message (e.g., # hello world1234)
Click Save Changes
Hover over the edited message
Triple-click on the edited H1 message to highlight it
Copy/paste in the composer
Verify the pasted H1 message should not add a new line after #, and it should be the same as the original message

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-05-16.at.22.36.06.mov

Mobile Web - Chrome

RPReplay_Final1684251887.mp4

Mobile Web - Safari

RPReplay_Final1684251711.mp4

Desktop

Screen.Recording.2023-05-16.at.23.01.56.mov

iOS

Screen.Recording.2023-05-16.at.23.15.23.mp4

Android

Screen.Recording.2023-05-16.at.23.33.01.mov

melvin-bot · 2023-05-16T17:14:35Z

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

tienifr · 2023-05-16T17:18:42Z

@0xmiroslav The PR is ready for review.
Even though we can't find any regressions when remove dom.children[0].type !== 'text', but I think it is necessary to add some extra changes to keep our feature safe. Thanks

0xmiros · 2023-05-17T06:45:14Z

@tienifr please update PR title to be more friendly

tienifr · 2023-05-17T07:30:46Z

@0xmiroslav I've updated the PR title

0xmiros · 2023-05-17T07:30:55Z

src/libs/SelectionScraper/index.js

@@ -126,7 +127,7 @@ const replaceNodes = (dom) => {
    }

    if (dom.children) {
-        domChildren = _.map(dom.children, (c) => replaceNodes(c));
+        domChildren = _.map(dom.children, (c) => replaceNodes(c, isChildOfEditorElement || !!dom.attribs[tagAttribute]));


Suggested change

domChildren = _.map(dom.children, (c) => replaceNodes(c, isChildOfEditorElement || !!dom.attribs[tagAttribute]));

domChildren = _.map(dom.children, (c) => replaceNodes(c, isChildOfEditorElement || !_.isEmpty(dom.attribs && dom.attribs[tagAttribute])));

0xmiros · 2023-05-17T07:43:35Z

src/libs/SelectionScraper/index.js

@@ -126,7 +127,7 @@ const replaceNodes = (dom) => {
    }

    if (dom.children) {
-        domChildren = _.map(dom.children, (c) => replaceNodes(c));
+        domChildren = _.map(dom.children, (c) => replaceNodes(c, isChildOfEditorElement || !_.isEmpty(dom.attribs[tagAttribute])));


do you think attribs always exists when dom has children?
For safety, !_.isEmpty(dom.attribs && dom.attribs[tagAttribute]) like above code

@0xmiroslav I agree checking both dom.attribs and dom.attribs[tagAttribute] is safer

0xmiros · 2023-05-17T08:01:29Z

This is already known bug and happens on main so out of scope

0xmiros · 2023-05-17T08:02:33Z

@tienifr lint failing in PressableWithFeedback component. happening on main so out of scope

0xmiros · 2023-05-17T08:04:15Z

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

web.mov

Mobile Web - Chrome

mchrome.mov

Mobile Web - Safari

msafari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

0xmiros · 2023-05-17T10:58:47Z

@tienifr please pull main. lint fixed now

…es-line-break

tienifr · 2023-05-17T14:45:07Z

@tienifr please pull main. lint fixed now

@0xmiroslav done!

tienifr · 2023-05-17T15:06:57Z

@0xmiroslav hi sorry I think I missed 1 place where we need to pass isChildOfEditorElement to replaceNodes, please see this additional commit I just added: 0096fc9

In that block dom.attribs && dom.attribs[tagAttribute] is already empty so we only have to pass the isChildOfEditorElement

0xmiros · 2023-05-17T15:13:02Z

src/libs/SelectionScraper/index.js

        // additional newlines from being added in the HTML to Markdown conversion process.
-        return replaceNodes(dom.children[0]);
+        return replaceNodes(dom.children[0], isChildOfEditorElement);


Good catch!

0xmiros

@NikkiWines LGTM!

tienifr · 2023-05-18T12:36:11Z

@NikkiWines could you take a look at the PR?

Thanks!

NikkiWines

OSBotify · 2023-05-18T17:56:41Z

✋ 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 · 2023-05-22T23:51:45Z

🚀 Deployed to staging by https://github.com/NikkiWines in version: 1.3.17-0 🚀

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

OSBotify · 2023-05-25T00:23:37Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.17-5 🚀

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

tienifr added 2 commits May 16, 2023 22:46

fix: 16921-paste-h1-message-in-chat-causes-incorrect-line-breaks

b50e293

extra safe

f0d0e70

tienifr marked this pull request as ready for review May 16, 2023 17:14

tienifr requested a review from a team as a code owner May 16, 2023 17:14

melvin-bot bot requested review from 0xmiros and NikkiWines and removed request for a team May 16, 2023 17:14

tienifr changed the title ~~fix: 16921-paste-h1-message-in-chat-causes-incorrect-line-breaks~~ fFx paste heading message in chat causes incorrect line breaks May 17, 2023

tienifr changed the title ~~fFx paste heading message in chat causes incorrect line breaks~~ Fix paste heading message in chat causes incorrect line breaks May 17, 2023

0xmiros reviewed May 17, 2023

View reviewed changes

refactor code

f178a31

0xmiros reviewed May 17, 2023

View reviewed changes

add extra check dom.attribs

6e369a4

This comment was marked as outdated.

Sign in to view

Merge branch 'main' into fix/16921-paste-heading-message-in-chat-caus…

d1f1362

…es-line-break

tienifr dismissed 0xmiros’s stale review via 0405171 May 17, 2023 15:04

fix: add missing isChildOfEditorElement in replaceNodes

0096fc9

tienifr force-pushed the fix/16921-paste-heading-message-in-chat-causes-line-break branch from 0405171 to 0096fc9 Compare May 17, 2023 15:04

0xmiros reviewed May 17, 2023

View reviewed changes

0xmiros approved these changes May 17, 2023

View reviewed changes

This comment was marked as duplicate.

Sign in to view

NikkiWines approved these changes May 18, 2023

View reviewed changes

NikkiWines merged commit ad0a873 into Expensify:main May 18, 2023

OSBotify mentioned this pull request May 22, 2023

Deploy Checklist: New Expensify 2023-05-22 #19422

Closed

62 tasks

Christinadobrzyn mentioned this pull request May 24, 2023

[HOLD for payment 2023-06-01] [$4000] Paste H1(# test) message in chat causes incorrect line breaks #16921

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix paste heading message in chat causes incorrect line breaks #19030

Fix paste heading message in chat causes incorrect line breaks #19030

tienifr commented May 16, 2023 •

edited

Loading

melvin-bot bot commented May 16, 2023

tienifr commented May 16, 2023

0xmiros commented May 17, 2023

tienifr commented May 17, 2023

0xmiros May 17, 2023 •

edited

Loading

0xmiros May 17, 2023

tienifr May 17, 2023 •

edited

Loading

0xmiros commented May 17, 2023

0xmiros commented May 17, 2023

0xmiros commented May 17, 2023

This comment was marked as outdated.

0xmiros commented May 17, 2023

tienifr commented May 17, 2023

tienifr commented May 17, 2023

0xmiros May 17, 2023

0xmiros left a comment

tienifr commented May 18, 2023

This comment was marked as duplicate.

NikkiWines left a comment

OSBotify commented May 18, 2023

OSBotify commented May 22, 2023

OSBotify commented May 25, 2023

	domChildren = _.map(dom.children, (c) => replaceNodes(c, isChildOfEditorElement \|\| !!dom.attribs[tagAttribute]));
	domChildren = _.map(dom.children, (c) => replaceNodes(c, isChildOfEditorElement \|\| !_.isEmpty(dom.attribs && dom.attribs[tagAttribute])));

Fix paste heading message in chat causes incorrect line breaks #19030

Fix paste heading message in chat causes incorrect line breaks #19030

Conversation

tienifr commented May 16, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 16, 2023

tienifr commented May 16, 2023

0xmiros commented May 17, 2023

tienifr commented May 17, 2023

0xmiros May 17, 2023 • edited Loading

Choose a reason for hiding this comment

0xmiros May 17, 2023

Choose a reason for hiding this comment

tienifr May 17, 2023 • edited Loading

Choose a reason for hiding this comment

0xmiros commented May 17, 2023

0xmiros commented May 17, 2023

0xmiros commented May 17, 2023

Reviewer Checklist

Screenshots/Videos

This comment was marked as outdated.

0xmiros commented May 17, 2023

tienifr commented May 17, 2023

tienifr commented May 17, 2023

0xmiros May 17, 2023

Choose a reason for hiding this comment

0xmiros left a comment

Choose a reason for hiding this comment

tienifr commented May 18, 2023

This comment was marked as duplicate.

NikkiWines left a comment

Choose a reason for hiding this comment

OSBotify commented May 18, 2023

OSBotify commented May 22, 2023

OSBotify commented May 25, 2023

tienifr commented May 16, 2023 •

edited

Loading

0xmiros May 17, 2023 •

edited

Loading

tienifr May 17, 2023 •

edited

Loading