fix: save IOU request description in html by dominictb · Pull Request #44523 · Expensify/App

dominictb · 2024-06-27T06:11:30Z

Details

fix: save IOU request description in html

Fixed Issues

Tests

Go to staging.new.expensify.com
Go to workspace chat.
Go offline
Submit an expense to workspace chat containing multiline description with mark down on each line.
Example:

> hello
> hello
*hello*

Go to transaction thread.
Verify the description is correctly formatted
Go online
Wait for the expense to be completely created (sometimes the expense is created but not sent).
Click on the description.
Without changing the description, click Save.

Expected: No system message for description edit will show up because no edit is made to the description.

Repeat all the above steps with create, categorize, share track expenses; create distance requests; split bills; send invoices.

Verify that no errors appear in the JS console

Offline tests

QA Steps

Go to staging.new.expensify.com
Go to workspace chat.
Go offline
Submit an expense to workspace chat containing multiline description with mark down on each line.
Example:

> hello
> hello
*hello*

Go to transaction thread.
Verify the description is correctly formatted
Go online
Wait for the expense to be completely created (sometimes the expense is created but not sent).
Click on the description.
Without changing the description, click Save.

Expected: No system message for description edit will show up because no edit is made to the description.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Expense:

Screen.Recording.2025-01-15.at.18.32.21-compressed.mov

Distance request:

Screen.Recording.2025-03-06.at.02.26.59.mov

Invoice:

Screen.Recording.2025-03-07.at.02.34.48-compressed.mov

MacOS: Desktop

Screen.Recording.2025-01-15.at.18.59.48-compressed.mov

Signed-off-by: dominictb <tb-dominic@outlook.com>

…/43403-html-desc

…tml-desc

melvin-bot · 2025-01-15T03:42:34Z

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

dominictb · 2025-01-15T03:46:52Z

Should be reviewed by @mkhutornyi

akinwale · 2025-01-15T08:38:14Z

@dominictb @mkhutornyi is OOO so I'll be reviewing this.

akinwale

@dominictb Please fix the eslint errors for non-existent IDs. See https://github.com/Expensify/App/blob/main/contributingGuides/STYLE.md#default-value-for-inexistent-IDs for more details.

Additionally, please merge with the latest main branch.

akinwale · 2025-01-15T10:58:53Z

@dominictb Please merge latest main. Thanks.

dominictb · 2025-01-15T11:03:43Z

@akinwale I already merged it. However let's pause a bit because I observed several issues and need to test them carefully. I'll notify you when it's done. My ETA is several hours. Thanks.

dominictb · 2025-01-15T15:49:41Z

Discussing the problem while creating money requests here #43403 (comment).

akinwale · 2025-01-30T13:10:56Z

@dominictb Can you check if the E/Web PR has been merged?

…tml-desc

akinwale · 2025-02-24T08:04:36Z

@dominictb Just following up to see if there are any updates here. The last set of changes have been deployed based on this comment. Thanks.

dominictb · 2025-02-26T03:41:30Z

on my list today

…tml-desc

dominictb · 2025-03-04T21:25:14Z

Updating & testing FE code for the split, track & distance flows.

…tml-desc

dominictb · 2025-03-05T19:37:39Z

The BE seems too slow for me, especially the UpdateMoneyRequestXXX endpoints. Will try to retest tomorrow.

…tml-desc

dominictb · 2025-03-06T19:41:24Z

@akinwale I've done implemented all the flows. Ready for review. These are the actions changed:

Normal expense/request:
- RequestMoney
- UpdateMoneyRequestDescription
Track expense:
- TrackExpense
- ConvertTrackedExpenseToRequest
- AddTrackedExpenseToPolicy
- ShareTrackedExpense
- CategorizeTrackedExpense
CreateDistanceRequest
Split bills:
- SplitBill
- SplitBillAndOpenReport
- StartSplitBill
- CompleteSplitBill
SendInvoice

akinwale · 2025-03-08T15:52:49Z

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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
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 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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.ts 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
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

Android: Native

Android: mWeb Chrome

iOS: Native

44523-ios-native.mp4

iOS: mWeb Safari

44523-ios-safari.mp4

MacOS: Chrome / Safari

44523-web.mp4

MacOS: Desktop

44523-desktop.mp4

akinwale

LGTM.

mountiny

Looks good, @dominictb for the QA team, could you please update the PR body with all the flows affected here, I know its a lot but we should ensure QA will test them so we do not miss anything

mountiny · 2025-03-08T21:24:26Z

src/libs/actions/IOU.ts

        amount: transaction?.amount ?? 0,
        currency: transaction?.currency ?? '',
-        comment: transaction?.comment?.comment?.trim() ?? '',
+        comment: parsedComment,


We should not need the comment parameter as only the description will be used. We should clean this up in a follow up @dominictb @akinwale

OSBotify · 2025-03-08T21:37:31Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

github-actions · 2025-03-10T21:35:01Z

🚀 Deployed to staging by https://github.com/mountiny in version: 9.1.11-1 🚀

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

github-actions · 2025-03-14T01:05:44Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.1.12-7 🚀

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

sobitneupane · 2025-05-14T08:54:03Z

src/pages/iou/request/step/IOURequestStepDescription.tsx

+    const currentDescriptionInMarkdown = Parser.htmlToMarkdown(
+        isEditingSplitBill && !lodashIsEmpty(splitDraftTransaction) ? splitDraftTransaction?.comment?.comment ?? '' : transaction?.comment?.comment ?? '',
+    );
+    const descriptionRef = useRef(currentDescriptionInMarkdown);


The case of transaction draft was not handled in the initial implementation.

Issue: #59986
Title: Expense-In confirmation page, description saved as <> is not shown on reopening

dukenv0307 · 2025-08-05T04:25:22Z

src/libs/actions/IOU.ts

    sessionAccountID: number,
    sessionEmail?: string,
 ) {
+    const parsedComment = getParsedComment(updatedTransaction?.comment?.comment ?? '');


Coming from: #65889, we need to use Parser.htmlToMarkdown before parsing the comment

dominictb added 6 commits June 27, 2024 13:08

fix: save IOU request description in html

f699846

Signed-off-by: dominictb <tb-dominic@outlook.com>

Merge branch 'main' of https://github.com/dominictb/epsf-app into fix…

95b3e54

…/43403-html-desc

use description param

cb71610

Merge branch 'main' of github.com:dominictb/epsf-app into fix/43403-h…

5cf94d8

…tml-desc

show markdown in modified expense action

e00242a

fix lint

824e446

dominictb marked this pull request as ready for review January 15, 2025 03:42

dominictb requested a review from a team as a code owner January 15, 2025 03:42

melvin-bot bot requested review from akinwale and removed request for a team January 15, 2025 03:42

akinwale suggested changes Jan 15, 2025

View reviewed changes

dominictb added 2 commits January 15, 2025 16:49

fix lint

f7f6d8b

fix lint

51073b3

dominictb changed the title ~~fix: save IOU request description in html~~ [HOLD E/Web] fix: save IOU request description in html Jan 20, 2025

dominictb added 4 commits February 7, 2025 01:57

Merge branch 'main' of github.com:dominictb/epsf-app into fix/43403-h…

a49df42

…tml-desc

fix lint

96edb95

implement html description for request money

00c314a

show markdown text in iou preview

3282020

dominictb changed the title ~~[HOLD E/Web] fix: save IOU request description in html~~ fix: save IOU request description in html Mar 4, 2025

Merge branch 'main' of github.com:dominictb/epsf-app into fix/43403-h…

c272962

…tml-desc

dominictb added 4 commits March 5, 2025 04:36

implement html description for track expense

94d5863

implement html description for categorize & share track expense

9b78a33

Merge branch 'main' of github.com:dominictb/epsf-app into fix/43403-h…

f9c3777

…tml-desc

implement html description for distance request

dbd1178

dominictb added 3 commits March 6, 2025 02:43

implement html description for split bills

290a124

Merge branch 'main' of github.com:dominictb/epsf-app into fix/43403-h…

3515e14

…tml-desc

implement html description for invoices

7df8a6d

implement html description for complete split bill

26631ad

akinwale approved these changes Mar 8, 2025

View reviewed changes

melvin-bot bot requested a review from mountiny March 8, 2025 15:53

mountiny assigned dominictb Mar 8, 2025

mountiny approved these changes Mar 8, 2025

View reviewed changes

mountiny merged commit 6cb1f44 into Expensify:main Mar 8, 2025
18 checks passed

github-actions bot mentioned this pull request Mar 10, 2025

Deploy Checklist: New Expensify 2025-03-10 #58124

Closed

dominictb mentioned this pull request Mar 12, 2025

[Due for payment 2025-03-25] Reports - Description with mark down is rendered as HTML tag #58268

Closed

8 tasks

melvin-bot bot mentioned this pull request Mar 14, 2025

[Due for payment 2025-03-25][$250] Expense - Saving multiline description with mark down with no edit triggers system message #43403

Closed

6 tasks

FitseTLT mentioned this pull request Apr 4, 2025

[Due for payment 2025-07-22] [$125] Pay someone - Mark down is not rendered in description field after paying someone #58562

Closed

8 tasks

sobitneupane reviewed May 14, 2025

View reviewed changes

Swor71 mentioned this pull request May 19, 2025

[$250] PDF/CSV report description has anchor tags #60711

Closed

18 tasks

mkzie2 mentioned this pull request Jul 17, 2025

[Due for payment 2025-08-11] [$250] Split scan - Description with mark down is displayed in HTML tags on the expense preview #65889

Closed

8 tasks

dukenv0307 reviewed Aug 5, 2025

View reviewed changes

Conversation

dominictb commented Jun 27, 2024 • 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!

melvin-bot bot commented Jan 15, 2025

Uh oh!

dominictb commented Jan 15, 2025

Uh oh!

akinwale commented Jan 15, 2025

Uh oh!

akinwale left a comment • 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!

akinwale commented Jan 15, 2025

Uh oh!

dominictb commented Jan 15, 2025

Uh oh!

dominictb commented Jan 15, 2025

Uh oh!

akinwale commented Jan 30, 2025

Uh oh!

akinwale commented Feb 24, 2025

Uh oh!

dominictb commented Feb 26, 2025

Uh oh!

dominictb commented Mar 4, 2025

Uh oh!

dominictb commented Mar 5, 2025

Uh oh!

dominictb commented Mar 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

akinwale commented Mar 8, 2025

Reviewer Checklist

Screenshots/Videos

Uh oh!

akinwale left a comment

Choose a reason for hiding this comment

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

mountiny Mar 8, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

OSBotify commented Mar 8, 2025

Uh oh!

github-actions bot commented Mar 10, 2025

Uh oh!

github-actions bot commented Mar 14, 2025

Uh oh!

sobitneupane May 14, 2025

Choose a reason for hiding this comment

Uh oh!

dukenv0307 Aug 5, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

dominictb commented Jun 27, 2024 •

edited

Loading

akinwale left a comment •

edited

Loading

dominictb commented Mar 6, 2025 •

edited

Loading