Fix/28342: Task description does not remove empty quotes by DylanDylann · Pull Request #29144 · Expensify/App

DylanDylann · 2023-10-10T03:53:51Z

Details

Inconsistency bug - Assign Task - Task description does not remove empty quotes (works fine in private notes)

Fixed Issues

Tests

Open the app
Open task report or assign any user task and open the report
Open description
Enter text with multiple empty quotes eg:

> Hello
>
>

Save the description and observe that description displays only one quote with text on task page (which is correct)
Again open description and observe that extra greater then signs are removed

Verify that no errors appear in the JS console

Offline tests

QA Steps

Open the app
Open task report or assign any user task and open the report
Open description
Enter text with multiple empty quotes eg:

> Hello
>
>

Save the description and observe that description displays only one quote with text on task page (which is correct)
Again open description and observe that extra greater then signs are removed

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screencast.from.10-10-2023.13.23.11.webm

Android: mWeb Chrome

android-chrome-quote.mp4

iOS: Native

native.mov

iOS: mWeb Safari

ios.mp4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

DylanDylann · 2023-10-10T05:31:16Z

In this proposal [HOLD for payment 2023-11-29] [$500] Inconsistency bug - Assign Task - Task description does not remove empty quotes (works fine in private notes) #28342 (comment), I let BE store the HTML, not mark down like the private notes logic.
But when implementing this PR, I found out that if we let BE store the HTML, for example,
<blockscope>Hello <br/> 123</blockscope>
, it just stores as "Hello123". So when submitting the description to BE, I keep using the original logic (let BE save the mark down string) rather than convert mark down to HTML.
Additionally, besides the screen that encounters the bug in the [HOLD for payment 2023-11-29] [$500] Inconsistency bug - Assign Task - Task description does not remove empty quotes (works fine in private notes) #28342, we also need to fix other screens that relate to the task `s description like
NewTaskDescriptionPage ,
NewTaskDetailsPage,
NewTaskPage

melvin-bot · 2023-10-10T09:50:20Z

@robertKozik 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]

robertKozik · 2023-10-10T15:32:51Z

@DylanDylann why don't we preview the html on android native? It sticks to the

> Hello
>
>

rather then format properly or even remove the excessive quotes?

DylanDylann · 2023-10-10T18:17:52Z

@DylanDylann why don't we preview the html on android native? It sticks to the
> Hello
>
>
rather then format properly or even remove the excessive quotes?

Updated and this is the result:

Screencast.from.11-10-2023.01.01.24.webm

robertKozik · 2023-10-10T19:35:59Z

@DylanDylann We are getting now strange margin on top of rendered HTML, it's diffrent on other platforms - can we do sth with it?

DylanDylann · 2023-10-10T23:36:36Z

@DylanDylann We are getting now strange margin on top of rendered HTML, it's diffrent on other platforms - can we do sth with it?

Currently, in staging, we are having the bug "Description does not display properly in Android native platform". You can verify it.
When implementing this PR, I encountered this issue and tried to fix this but it led to the strange margin as you mentioned. So I think, I will revert all the logic used to fix the bug "Description does not display properly in Android native platform" and create a separate issue because the scope of this is only about "Task description does not remove empty quotes". What do you think @robertKozik ?

robertKozik · 2023-10-11T07:55:22Z

@DylanDylann We are getting now strange margin on top of rendered HTML, it's diffrent on other platforms - can we do sth with it?

Currently, in staging, we are having the bug "Description does not display properly in Android native platform". You can verify it.

When implementing this PR, I encountered this issue and tried to fix this but it led to the strange margin as you mentioned. So I think, I will revert all the logic used to fix the bug "Description does not display properly in Android native platform" and create a separate issue because the scope of this is only about "Task description does not remove empty quotes". What do you think @robertKozik ?

Has this issue already been reported? I'm fine with creating a separate bug report for it, but we should still address the problem of displaying the description with excessive quotes on android native, which should undoubtedly be part of this.

DylanDylann · 2023-10-11T08:08:10Z

@robertKozik

Has this issue already been reported?

I am not sure about it. Will check when I have a chance

I'm fine with creating a separate bug report for it,

Yeah. Let's wait internal team to confirm this #28342 (comment)

DylanDylann · 2023-10-12T00:12:56Z

@robertKozik Please help review the current change and we will create another issue to fix the markdown in android

robertKozik · 2023-10-12T08:27:06Z

As I see we didn't get the confirmation from internal team about the creation of another issue about the markdown on android native - I had review the current state of the PR before, so if we agree on proceeding with it I'll post the reviewer PR quickly

DylanDylann · 2023-10-12T09:32:50Z

Thanks @robertKozik

DylanDylann · 2023-10-18T23:47:26Z

@robertKozik internal team has confirmed here #28342 (comment). Let's continue reviewing this PR

robertKozik · 2023-10-19T08:50:04Z

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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

web.mov

Mobile Web - Chrome

android.-.web.mov

Mobile Web - Safari

ios.web.mov

Desktop

desktop.mov

iOS

android.native.mov

Android

ios.native.mov

robertKozik

LGTM

iwiznia · 2023-10-19T10:50:49Z

                    <View style={styles.mb5}>
                        <TextInput
-                            defaultValue={props.task.description}
+                            defaultValue={parser.htmlToMarkdown(parser.replace(props.task.description))}


Huh? Why are we converting to HTML and back to markdown?? This was not part of the proposal, was it?

I have mentioned in this #29144 (comment)

So when submitting the description to BE, I keep using the original logic (let BE save the mark down string) rather than convert mark down to HTML.

Hmmmm but comments are saved in the DB as html, no? So this would mean saving things differently than for comments? That does not sound correct...right?

Yeah. Comments and Privates notes are saved on BE side as HTML. As I mentioned above, with the description, I found out that if we let BE store the HTML, for example,
Hello
123, it just stores as "Hello123"

So if we want to store description as HTML, we need the BE fix

Yeah I don't think we would want to save html in one place and markdown in the other.... can you comment on the OG issue what changes would need to be done in the backend please?

@iwiznia just requested confirm here #28342

…mpty-quotes

DylanDylann · 2023-11-16T04:16:37Z

@iwiznia Please help review this PR again. Please note that we will use the solution that I mentioned before #29144 (comment)

OSBotify · 2023-11-16T17:40:06Z

✋ 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-11-22T00:49:12Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.1-13 🚀

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

DylanDylann added 2 commits October 10, 2023 10:48

fix task description does not remove empty quotes

8c5cf6d

fix bug when save description

6083557

DylanDylann marked this pull request as ready for review October 10, 2023 09:50

DylanDylann requested a review from a team as a code owner October 10, 2023 09:50

melvin-bot Bot requested review from robertKozik and removed request for a team October 10, 2023 09:50

DylanDylann mentioned this pull request Oct 10, 2023

[HOLD for payment 2023-11-29] [$500] Inconsistency bug - Assign Task - Task description does not remove empty quotes (works fine in private notes) #28342

Closed

6 tasks

DylanDylann added 3 commits October 10, 2023 22:14

fix update the logic

47e4904

fix remove redundant code

cd0fd6a

fix lint

9797b1f

fix android issue whenn displaying desc

c8aeb9b

DylanDylann added 2 commits October 11, 2023 14:43

fix revert logic fixing display description

8224acd

fix revert all related to display description

cf07ccb

robertKozik approved these changes Oct 19, 2023

View reviewed changes

melvin-bot Bot requested a review from iwiznia October 19, 2023 08:50

iwiznia reviewed Oct 19, 2023

View reviewed changes

Merge branch 'main' into fix/28342-task-description-does-not-remove-e…

3a59c85

…mpty-quotes

DylanDylann added 6 commits November 3, 2023 23:31

fix sending html to BE

2e68ecb

fix display task view issue

2ab9dbf

fix app crash when clicking on IOU

2dd8668

fix revert fix display task view issue

2bb69aa

fix revert sending html to BE

b4cdfa2

fix merge main

daf413c

DylanDylann force-pushed the fix/28342-task-description-does-not-remove-empty-quotes branch from 5b9f5a8 to daf413c Compare November 16, 2023 03:02

DylanDylann added 2 commits November 16, 2023 10:07

fix lint

fb32496

fix remove unrelated change

31f2dc6

iwiznia approved these changes Nov 16, 2023

View reviewed changes

iwiznia merged commit aacc1d4 into Expensify:main Nov 16, 2023

os-botify Bot mentioned this pull request Nov 20, 2023

Deploy Checklist: New Expensify 2023-11-20 #31556

Closed

90 tasks

aswin-s mentioned this pull request Jan 17, 2024

[HOLD for payment 2024-04-01] [$250] Android - App lags after adding code block in task description #34324

Closed

6 tasks

Uh oh!

Conversation

DylanDylann commented Oct 10, 2023 • edited by github-actions Bot 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!

DylanDylann commented Oct 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

melvin-bot Bot commented Oct 10, 2023

Uh oh!

robertKozik commented Oct 10, 2023

Uh oh!

DylanDylann commented Oct 10, 2023

Uh oh!

robertKozik commented Oct 10, 2023

Uh oh!

DylanDylann commented Oct 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

robertKozik commented Oct 11, 2023

Uh oh!

DylanDylann commented Oct 11, 2023

Uh oh!

DylanDylann commented Oct 12, 2023

Uh oh!

robertKozik commented Oct 12, 2023

Uh oh!

DylanDylann commented Oct 12, 2023

Uh oh!

DylanDylann commented Oct 18, 2023

Uh oh!

robertKozik commented Oct 19, 2023

Reviewer Checklist

Screenshots/Videos

Uh oh!

robertKozik left a comment

Choose a reason for hiding this comment

Uh oh!

iwiznia Oct 19, 2023

Choose a reason for hiding this comment

Uh oh!

DylanDylann Oct 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iwiznia Oct 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DylanDylann Oct 19, 2023

Choose a reason for hiding this comment

Uh oh!

iwiznia Oct 19, 2023

Choose a reason for hiding this comment

Uh oh!

DylanDylann Oct 19, 2023

Choose a reason for hiding this comment

Uh oh!

DylanDylann commented Nov 16, 2023

Uh oh!

OSBotify commented Nov 16, 2023

Uh oh!

OSBotify commented Nov 22, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

DylanDylann commented Oct 10, 2023 •

edited by github-actions Bot

Loading

DylanDylann commented Oct 10, 2023 •

edited

Loading

DylanDylann commented Oct 10, 2023 •

edited

Loading

DylanDylann Oct 19, 2023 •

edited

Loading

iwiznia Oct 19, 2023 •

edited

Loading