Avoid parsing html in editing composer when reloading page by eh2077 · Pull Request #18195 · Expensify/App

eh2077 · 2023-04-29T23:40:56Z

Details

Fixed Issues

$ #17843
PROPOSAL: #17843 (comment)

Tests

Open the App and go to a chat
Send a message with markdown, e.g., # Heading
Edit the message we send
Refresh the App
4a. For Web/mWeb/Desktop, refresh the page with CMD+R or press the refresh button.
4b. For iOS/Android, close the App, then open the App again and go to the chat we send the message.
Ensure that the edited message still is unchanged.
Save the edit message without changing anything
Ensure that the message is the same and no (edited) text shown
Edit the same message again
Change the markdown message to equal of HTML entities, e.g., <h1>Heading</h1> and wait for seconds for the draft to save
Do step 4 again
Ensure that the edited message is not changed to markdown and remains as before we refresh the App, <h1>Heading</h1>
Save the edited message
Ensure that the message is changed to what we saved, <h1>Heading</h1>

Verify that no errors appear in the JS console

Offline tests

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

web.mov

Mobile Web - Chrome

mobile-chrome.mp4

Mobile Web - Safari

mobile-safari.mp4

Desktop

desktop.mov

iOS

ios.mp4

Android

android.mp4

MelvinBot · 2023-04-29T23:41:01Z

@chiragsalian @mollfpr 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]

mollfpr

Thanks for the quick PR @eh2077! Just need some comments for clarity on the code.

mollfpr · 2023-04-30T02:28:18Z

-        const parser = new ExpensiMark();
-        const draftMessage = parser.htmlToMarkdown(this.props.draftMessage).trim();
+        let draftMessage;
+        if (this.props.draftMessage === this.props.action.message[0].html) {


@eh2077 Could you add a comment explaining why we doing this and what issue we trying to solve?

Added comments

mollfpr · 2023-04-30T02:28:56Z

        // unmount when user deletes content of textarea, we set previous message instead of empty string.
        if (newDraft.trim().length > 0) {
-            this.debouncedSaveDraft(newDraft);
+            this.debouncedSaveDraft(_.escape(newDraft));


I would also like to let you know that comment here will be helpful.

mollfpr · 2023-04-30T02:38:29Z

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

18195.Web.mov

Mobile Web - Chrome

18195.mWeb.Chrome.mp4

Mobile Web - Safari

18195.mWeb.Safari.mp4

Desktop

18195.Desktop.mov

iOS

18195.iOS.mp4

Android

18195.Android.mp4

mollfpr · 2023-04-30T04:23:31Z

So far, the tests have been well, and the changes look good. 👍

Just some improvement for the test case.

I don't think the current test case covers enough of your changes, and your test case only works on the web/desktop, where we should also cover the native test.

Open the App and go to a chat
Send a message with markdown, e.g., # Heading
Edit the message we send
Refresh the App
4a. For Web/mWeb/Desktop, refresh the page with CMD+R or press the refresh button.
4b. For iOS/Android, close the App, then open the App again and go to the chat we send the message.
Ensure that the edited message still is unchanged.
Save the edit message without changing anything
Ensure that the message is the same and no (edited) text shown
Edit the same message again
Change the markdown message to equal of HTML entities, e.g., <h1>Heading</h1> and wait for seconds for the draft to save
Do step 4 again
Ensure that the edited message is not changed to markdown or remains before we refresh the App
Save the edit message
Ensure that the message is changed to what we save

You can just edit this; the point is to cover all the cases where the issue arises.

eh2077 · 2023-04-30T21:54:28Z

@mollfpr Updated test cases!

mollfpr

LGTM 👍

All yours @chiragsalian

chiragsalian

lgtm

OSBotify · 2023-05-03T01:00:19Z

🚀 Deployed to staging by https://github.com/chiragsalian in version: 1.3.9-13 🚀

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

OSBotify · 2023-05-09T04:06:43Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.12-0 🚀

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

avoid parsing html in editing composer when reloading page

330bce5

eh2077 requested a review from a team as a code owner April 29, 2023 23:40

melvin-bot Bot requested review from chiragsalian and mollfpr and removed request for a team April 29, 2023 23:40

eh2077 mentioned this pull request Apr 29, 2023

[HOLD for payment 2023-05-16] [$1000] HTML in edit box is parsed after reloading, but that doesn't happen in normal composer #17843

Closed

6 tasks

mollfpr requested changes Apr 30, 2023

View reviewed changes

add comments for the change

360627b

eh2077 requested a review from mollfpr April 30, 2023 03:02

mollfpr approved these changes May 1, 2023

View reviewed changes

chiragsalian approved these changes May 2, 2023

View reviewed changes

chiragsalian merged commit 4062e43 into Expensify:main May 2, 2023

marcaaron mentioned this pull request May 3, 2023

Deploy Checklist: New Expensify 2023-05-02 #18322

Closed

59 tasks

Uh oh!

Conversation

eh2077 commented Apr 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

MelvinBot commented Apr 29, 2023

Uh oh!

mollfpr left a comment

Choose a reason for hiding this comment

Uh oh!

mollfpr Apr 30, 2023

Choose a reason for hiding this comment

Uh oh!

eh2077 Apr 30, 2023

Choose a reason for hiding this comment

Uh oh!

mollfpr Apr 30, 2023

Choose a reason for hiding this comment

Uh oh!

eh2077 Apr 30, 2023

Choose a reason for hiding this comment

Uh oh!

mollfpr commented Apr 30, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

mollfpr commented Apr 30, 2023

Uh oh!

eh2077 commented Apr 30, 2023

Uh oh!

mollfpr left a comment

Choose a reason for hiding this comment

Uh oh!

chiragsalian left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented May 3, 2023

Uh oh!

OSBotify commented May 9, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

eh2077 commented Apr 29, 2023 •

edited

Loading

mollfpr commented Apr 30, 2023 •

edited

Loading