Support markdown for description preview by aldo-expensify · Pull Request #39466 · Expensify/App

aldo-expensify · 2024-04-02T23:39:20Z

Details

~~Add new custom html tag <supporting-text> to handle passing the styles we use for supporting text~~
Use RenderHTML along with <muted-text> instead of <Text> to handle the html derived from the markdown
Replace useState + useRef by useMemo

Update: changed it to use the existing muted-text since it looks the same

Fixed Issues

$ #39451
PROPOSAL:

Tests

Open a new DM chat with someone you haven't chatted before
Create a money request and set as description ~test~
Verify that the money request preview shows ~~test~~ as the description (markdown rendered correctly)
Create another money request in the same chat
Verify that now it shows "2 requests"
Click on the preview and go inside the IOU report
Verify that both transactions show the description correctly:
Click the transaction with description ~~test~~
Verify that the "Description" shows strikethrough in the detailed view
Delete the second request so you only have one again
Edit the only transaction left with Merchant: ~merchant~
Verify that the input shows ~merchant~ and not ~~merchant~~
Go to the DM chat and verify that the preview shows ~merchant~ and not ~~merchant~~

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Open a new DM chat with someone you haven't chatted before
Create a money request and set as description ~test~
Verify that the money request preview shows ~~test~~ as the description (markdown rendered correctly)
Create another money request in the same chat
Verify that now it shows "2 requests"
Click on the preview and go inside the IOU report
Verify that both transactions show the description correctly:
Click the transaction with description ~~test~~
Verify that the "Description" shows strikethrough in the detailed view
Delete the second request so you only have one again
Edit the only transaction left with Merchant: ~merchant~
Verify that the input shows ~merchant~ and not ~~merchant~~
Go to the DM chat and verify that the preview shows ~merchant~ and not ~~merchant~~

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

MacOS: Desktop

melvin-bot · 2024-04-02T23:39:25Z

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

ishpaul777 · 2024-04-02T23:50:44Z

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

Record_2024-04-03-06-44-55.mp4

iOS: Native

Screen.Recording.2024-04-03.at.6.28.26.AM.mov

iOS: mWeb Safari

Screen.Recording.2024-04-03.at.6.22.54.AM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-04-03.at.6.18.03.AM.mov

MacOS: Desktop

Screen.Recording.2024-04-03.at.6.35.42.AM-1.mov

ishpaul777 · 2024-04-02T23:57:15Z

@aldo-expensify Lint is failing :(

ishpaul777 · 2024-04-03T00:22:20Z

Hmm 🤔 is it expected that we want to render the merchant as html in report preview asking because we dont render it as html in transaction preview

Screen.Recording.2024-04-03.at.5.51.26.AM.mov

aldo-expensify · 2024-04-03T00:25:55Z

Hmm 🤔 is it expected that we want to render the merchant as html in report preview asking becuase we dont render it as html in transaction preview

Good question, checking...

aldo-expensify · 2024-04-03T00:41:13Z

@ishpaul777 nice catch about the Merchant. I ended up rendering only as HTML if the text is coming from the description. Merchant is not rendered as html because that is consistent with the input that is not doing it either.

I fixed the linter issues, sorry about that!

aldo-expensify · 2024-04-03T00:44:14Z

Updated tests steps to check for the merchant too

ishpaul777 · 2024-04-03T00:47:03Z

Nice! i'll complete the videos

melvin-bot · 2024-04-03T01:19:42Z

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

marcaaron

LGTM

…scription-preview Support markdown for description preview (cherry picked from commit bce4724)

OSBotify · 2024-04-03T22:09:31Z

🚀 Cherry-picked to staging by https://github.com/jasperhuangg in version: 1.4.59-7 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

jasperhuangg · 2024-04-03T23:33:07Z

Looks like the desktop CP failed, rerunning it

OSBotify · 2024-04-08T10:58:05Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.60-13 🚀

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

aldo-expensify added 3 commits April 2, 2024 16:29

Add supporting-text custom element with supporting text style

508c4ce

Render report preview subtitle as html

d8ffc6d

Use useMemo instead of unnecessary state and ref

4cc379b

aldo-expensify self-assigned this Apr 2, 2024

aldo-expensify requested a review from a team as a code owner April 2, 2024 23:39

melvin-bot Bot removed the request for review from a team April 2, 2024 23:39

melvin-bot Bot requested a review from eVoloshchak April 2, 2024 23:39

Use muted-text and remove supporting-text

5f8d91b

aldo-expensify requested review from ishpaul777 and removed request for eVoloshchak April 2, 2024 23:46

aldo-expensify added 2 commits April 2, 2024 17:26

Lint

861a746

Style / Only apply html render for description and not merchant

e6ebbc2

ishpaul777 approved these changes Apr 3, 2024

View reviewed changes

melvin-bot Bot requested a review from techievivek April 3, 2024 01:19

marcaaron approved these changes Apr 3, 2024

View reviewed changes

marcaaron merged commit bce4724 into main Apr 3, 2024

marcaaron deleted the aldo_support-markdown-for-description-preview branch April 3, 2024 01:28

aldo-expensify mentioned this pull request Apr 3, 2024

[HOLD for payment 2024-04-15] IOU - IOU preview in the main chat does not support mark down, while IOU report supports it #39451

Closed

6 tasks done

OSBotify pushed a commit that referenced this pull request Apr 3, 2024

Merge pull request #39466 from Expensify/aldo_support-markdown-for-de…

fb70f34

…scription-preview Support markdown for description preview (cherry picked from commit bce4724)

github-actions Bot mentioned this pull request Apr 3, 2024

Deploy Checklist: New Expensify 2024-04-02 #39399

Closed

87 tasks done

Navigation Menu

Repository navigation

Support markdown for description preview - #39466

Support markdown for description preview#39466
marcaaron merged 6 commits into
mainfrom
aldo_support-markdown-for-description-preview

aldo-expensify commented Apr 2, 2024 •

edited

Loading

Uh oh!

melvin-bot Bot commented Apr 2, 2024

Uh oh!

ishpaul777 commented Apr 2, 2024 •

edited

Loading

Uh oh!

ishpaul777 commented Apr 2, 2024

Uh oh!

ishpaul777 commented Apr 3, 2024 •

edited

Loading

Uh oh!

aldo-expensify commented Apr 3, 2024

Uh oh!

aldo-expensify commented Apr 3, 2024

Uh oh!

aldo-expensify commented Apr 3, 2024

Uh oh!

ishpaul777 commented Apr 3, 2024

Uh oh!

melvin-bot Bot commented Apr 3, 2024

Uh oh!

marcaaron left a comment

Uh oh!

OSBotify commented Apr 3, 2024

Uh oh!

jasperhuangg commented Apr 3, 2024

Uh oh!

OSBotify commented Apr 8, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

aldo-expensify commented Apr 2, 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 Apr 2, 2024

Uh oh!

ishpaul777 commented Apr 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

ishpaul777 commented Apr 2, 2024

Uh oh!

ishpaul777 commented Apr 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aldo-expensify commented Apr 3, 2024

Uh oh!

aldo-expensify commented Apr 3, 2024

Uh oh!

aldo-expensify commented Apr 3, 2024

Uh oh!

ishpaul777 commented Apr 3, 2024

Uh oh!

melvin-bot Bot commented Apr 3, 2024

Uh oh!

marcaaron left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Apr 3, 2024

Uh oh!

jasperhuangg commented Apr 3, 2024

Uh oh!

OSBotify commented Apr 8, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

aldo-expensify commented Apr 2, 2024 •

edited

Loading

ishpaul777 commented Apr 2, 2024 •

edited

Loading

ishpaul777 commented Apr 3, 2024 •

edited

Loading