Live Markdown Preview for web

[Skalakid]

This PR adds Live Markdown Preview feature for web using @expensify/react-native-live-markdown library. Previously Markdown Input was added only for native devices in #34292.

Details

Fixed Issues

$ #27977
PROPOSAL:

Tests

Testing Replacement Rules

Code Fence:
Type: your text
Expected: Text appears in a separate block formatted as code.

Inline Code Block:
Type: your text
Expected: Text appears inline, formatted as code.

Email Link:
Type: [email protected]
Expected: Email address turns into a clickable mailto link.

URL Link:
Type: https://github.com/Expensify/App/pull/34292
Expected: Displays https://github.com/Expensify/App/pull/34292 styled as web link (it shouldn't be clickable).

Italics
Type: your text
Expected: Text appears in italics.

Bold Text:
Type: your text
Expected: Text appears in bold.

Strikethrough Text:
Type: your text
Expected: Text appears with a strikethrough.

Block Quote:
Type: > your text
Expected: Text appears as a block quote.

Heading:
Type: # Your Heading
Expected: Text appears as a large, bold heading.

• Verify that no errors appear in the JS console

Offline tests

Same as Tests

QA Steps

Same as Tests

• Verify that no errors appear in the JS console

PR Author Checklist

• I linked the correct issue in the ### Fixed Issues section above
• I wrote clear testing steps that cover the changes made in this PR
  • I added steps for local testing in the Tests section
  • I added steps for the expected offline behavior in the Offline steps section
  • I added steps for Staging and/or Production testing in the QA steps section
  • I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
• I included screenshots or videos for tests on all platforms
• I ran the tests on all platforms & verified they passed on:
  • Android: Native
  • Android: mWeb Chrome
  • iOS: Native
  • iOS: mWeb Safari
  • MacOS: Chrome / Safari
  • MacOS: Desktop
• I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
• I followed proper code patterns (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
    • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
  • 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 followed the guidelines as stated in the Review Guidelines
• I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
• 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
• I verified that if a function's arguments changed that all usages have also been updated correctly
• 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 form input styles:
  • I verified that all the inputs inside a form are aligned with each other.
  • I added Design label 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.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

[melvin-bot]

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

[thienlnam]

Adding @c3024 / @shubham1206agra here since they did the original review for live markdown mobile

[thienlnam]

Thanks for the PR @Skalakid, could you also copy the tests from #34292 into the QA steps of the issue description so our quality assurance team can test this as well once it's deployed?

[shubham1206agra]

@Skalakid The Cursor after using mention is wrong (it doesn't update to the correct position).

[Skalakid]

@shubham1206agra I just fixed the bug with cursor positioning, it should have the correct position now

[github-actions]

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/35837/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/35837/index.html
Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/35837/NewExpensify.dmg	https://35837.pr-testing.expensify.com

---

👀 View the workflow run that generated this build 👀

[c3024]

There is a styling warning thrown if the composer is resized with text in it.

Warning: Removing a style property during rerender (overflowY) when a conflicting property is set (overflow) can lead to styling bugs. To avoid this, don't mix shorthand and non-shorthand properties for the same value; instead, replace the shorthand with separate values. at div at eval (webpack-internal:///./node_modules/@expensify/react-native-live-markdown/lib/module/MarkdownTextInput.web.js:80:3) at Composer (webpack-internal:///./src/components/Composer/index.tsx:83:20)

liveMarkDownWarningWeb.mp4

[shubham1206agra]

@shubham1206agra I just fixed the bug with cursor positioning, it should have the correct position now

@Skalakid This is still not fixed for me :(.

[Skalakid]

@shubham1206agra are you testing on adhoc build? If no, try removing node_modules and reinstalling dependencies with npm i

Screen.Recording.2024-02-07.at.09.14.11.mov

[shubham1206agra]

@Skalakid This was on ad-hoc build only. Try using keys for selection.

[Skalakid]

@shubham1206agra can you record a video with bug reproduction, please? It will be easier to fix it

[shubham1206agra]

@shubham1206agra can you record a video with bug reproduction, please? It will be easier to fix it

This is fixed now. An old ad-hoc build was used to test it again at that time accidentally.

[thienlnam]

Looks like we're really close - I'm going to generate one last ad hoc to ensure there's no breaking items but looks like we may even be able to merge today?

[github-actions]

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/35837/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/35837/index.html
Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/35837/NewExpensify.dmg	https://35837.pr-testing.expensify.com

---

👀 View the workflow run that generated this build 👀

[shubham1206agra]

@Skalakid @robertKozik One more thing I noticed. Copy-pasting anything multiline is inserting extra lines in between text.

[c3024]

Copy-pasting anything multiline is inserting extra lines in between text.

I noticed this as well but this issue was on main even before merging this PR.

[shubham1206agra]

Interesting. It was not on staging.

[c3024]

Extra text breaks are added on staging as well. 🤔

Screen.Recording.2024-02-08.at.5.40.19.PM.mov

[shubham1206agra]

This PR is adding more lines :)
Staging:

This PR

[robertKozik]

Sorry for the late response here, but this text inside code blocks seems to break Markdown

lol > lol

More specifically these characters &'"<>.

@Skalakid Can you issue a fix to this in a follow-up PR now?

@shubham1206agra Follow up on this one - Expensify/expensify-common#644

[shubham1206agra]

@thienlnam One enhancement is the support of the tooltip for mention in the preview.

[OSBotify]

🚀 Deployed to staging by https://github.com/thienlnam in version: 1.4.39-0 🚀

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

[situchan]

BUG (Critical): Macbook keyboard glitch on each key input in composer

bug.mp4

[OSBotify]

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.39-8 🚀

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

[thienlnam]

@situchan Could you give us more details about the mac that you're experiencing this bug on? #35837 (comment)

Model / OSX version / Browser

[situchan]

@situchan Could you give us more details about the mac that you're experiencing this bug on? #35837 (comment)

Model / OSX version / Browser

Macbook Pro 2019 / Sonoma 14.0 / Chrome