Enable Live Markdown Preview on web by Skalakid · Pull Request #38152 · Expensify/App

Skalakid · 2024-03-12T16:47:23Z

Important

QA team - please test Android & iOS as well since this PR also includes the upgrade of the package itself

Details

This PR adds Live Markdown Preview feature for web using @expensify/react-native-live-markdown library.

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: test@email.com
Expected: Email address turns into not 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

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Uploading live-markdown-for-web.mov…

MacOS: Desktop

melvin-bot · 2024-03-13T10:30:51Z

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

tomekzaw · 2024-03-13T11:12:47Z

src/components/Composer/index.tsx

@@ -1,14 +1,15 @@
+import {MarkdownTextInput} from '@expensify/react-native-live-markdown';


Let's use RNMarkdownTextInput component instead. https://github.com/Expensify/App/blob/main/src/components/RNMarkdownTextInput.tsx

parasharrajat · 2024-03-13T13:22:31Z

I will get this reviewed in a couple of hours. Currently AFK

thienlnam · 2024-03-13T17:13:55Z

Adding the original reviewers of the live markdown web PR that we reverted

c3024 · 2024-03-14T03:21:04Z

Email Link:
Type: test@email.com
Expected: Email address turns into a clickable mailto link.

Should the email be clickable in the composer?

Both email and web links are not clickable in composer.

emailNotClickable.mp4

c3024 · 2024-03-14T03:30:22Z

A warning is thrown after logging in

c3024 · 2024-03-14T05:56:33Z

Maximum 3 level indents in composer for quote against 4 levels in the sent message.

multiIndents.mp4

BartoszGrajdek · 2024-03-26T11:27:50Z

There is unused space in the composer when expanding the composer.

Can you explain what you mean?

c3024 · 2024-03-26T13:27:40Z

The scroll does not extend throughout the composer height when clicked on the expand icon on the top left of the composer. It works fine on main.

scrollNotExtendedThroughoutComposerHeight.mp4

BartoszGrajdek · 2024-03-27T11:20:12Z

The scroll does not extend throughout the composer height when clicked on the expand icon on the top left of the composer. It works fine on main.

Should be fine now

thienlnam · 2024-03-27T15:48:14Z

Okay generating one last adhoc for those new changes - let's merge this if we don't find any blockers.

I've been adding these other edge cases to these issues that aren't blockers #39006

github-actions · 2024-03-27T16:09:31Z

🧪🧪 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/38152/index.html	❌ FAILED ❌
	The QR code can't be generated, because the iOS build failed
Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/38152/NewExpensify.dmg	https://38152.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

shubham1206agra · 2024-03-27T16:52:12Z

Screen.Recording.2024-03-27.at.10.20.52.PM.mov

BUG: Undo operation removes more than one character

shubham1206agra · 2024-03-27T16:56:42Z

Screen.Recording.2024-03-27.at.10.24.49.PM.mov

BUG: Unable to undo pasted quoted text.

Skalakid · 2024-03-27T17:29:46Z

BUG: Undo operation removes more than one character

@shubham1206agra I think it's not a bug. History items are added with the debouce, so if you are writing faster, parts of the text are saved and then undone

BartoszGrajdek · 2024-03-27T18:11:54Z

For mentions, if the mention is followed by a space then scrolls works correctly on pressing Shift + Enter but if we press Shift + Enter right after the mention without a space followed then it does not scroll.

Also fixed 🚀

thienlnam

This has gone through a series of reviews and we've fixed any main blockers - I tested one final time and everything looks good - let's ship this out and fix the follow ups as they come up

thienlnam · 2024-03-27T18:36:22Z

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

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

OSBotify · 2024-03-27T18:45:41Z

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

BartoszGrajdek · 2024-03-28T19:47:11Z

Important

QA team - please test Android & iOS as well since this PR also includes the upgrade of the package itself

OSBotify · 2024-03-29T02:26:56Z

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

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

OSBotify · 2024-04-02T11:03:12Z

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

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

rayane-d · 2024-12-10T11:44:26Z

src/components/Composer/index.tsx

+    useEffect(() => {
+        if (!textInput.current || prevScroll === undefined) {
+            return;
+        }
+        textInput.current.scrollTop = prevScroll;
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, [isComposerFullSize]);


Coming from #49541

When isComposerFullSize is toggled, the scroll position aligns with the top of the compose bar. However, it would be more intuitive if the scroll position followed the bottom of the compose bar instead. This adjustment would ensure that the last line of text remains visible, preventing the user from losing their place when toggling the text box.

Proposal: #49541 (comment)
PR: #50520

Skalakid added 5 commits March 12, 2024 17:34

Enable live markdown input on web

3973b76

Bump expensify-common version

60a8cec

Merge branch 'main' into @Skalakid/live-markdown-input-for-web

4379afe

Bump react-native-live-markdown verion to 0.1.26

c868943

Merge branch 'main' into @Skalakid/live-markdown-input-for-web

3cd3e79

Skalakid marked this pull request as ready for review March 13, 2024 10:30

Skalakid requested a review from a team as a code owner March 13, 2024 10:30

melvin-bot bot requested review from parasharrajat and removed request for a team March 13, 2024 10:30

tomekzaw reviewed Mar 13, 2024

View reviewed changes

Skalakid mentioned this pull request Mar 13, 2024

Fix blockquotes limiting in ExpensiMark Expensify/expensify-common#665

Merged

Skalakid added 2 commits March 13, 2024 14:46

Change Composer markdown component to RNMarkdownTextInput

cf5f86b

Change ref type

124ac6c

Skalakid changed the title ~~Enable live markdown input on web~~ Enable Live Markdown Preview on web Mar 13, 2024

Skalakid added 2 commits March 13, 2024 15:33

Fix prettier

52f68dc

Fix Podfile

8333bb6

thienlnam requested review from c3024 and shubham1206agra and removed request for parasharrajat March 13, 2024 17:13

thienlnam assigned Skalakid Mar 13, 2024

thienlnam added the Ready To Build label Mar 13, 2024

This comment has been minimized.

Sign in to view

Skalakid added 2 commits March 14, 2024 10:34

Merge branch 'main' into @Skalakid/live-markdown-input-for-web

f24cebb

Update react-native-live-markdown and expensify-common versions

ab6d0f6

thienlnam mentioned this pull request Mar 26, 2024

[HOLD for payment 2024-04-15] Live Markdown Composer Issues #39006

Closed

fix: full composer scrollbar

58bb4ea

BartoszGrajdek mentioned this pull request Mar 27, 2024

Caret positioning & scrolling on enter Expensify/react-native-live-markdown#247

Merged

fix: shift+enter after mentions scrolling issue

8fe7c78

thienlnam approved these changes Mar 27, 2024

View reviewed changes

thienlnam merged commit b2ab3a9 into Expensify:main Mar 27, 2024

thienlnam mentioned this pull request Mar 28, 2024

HIGH: [Live Markdown] Tracking Live Markdown Issues #36071

Closed

github-actions bot mentioned this pull request Mar 29, 2024

Deploy Checklist: New Expensify 2024-03-29 #39222

Closed

flodnv mentioned this pull request Mar 29, 2024

[HOLD for payment 2024-04-15] Mark down - App crashes when entering an emoji inside three backticks code block #39236

Closed

6 tasks

arosiclair mentioned this pull request Mar 29, 2024

[HOLD for payment 2024-06-21] [$500] mweb - Chat - App crashes when selecting an emoji #39234

Closed

6 tasks

lanitochka17 mentioned this pull request Mar 29, 2024

Mark down - Different colour of strikethrough on email depending on bold mark down position #39266

Closed

6 tasks

francoisl mentioned this pull request Mar 29, 2024

[HOLD for payment 2024-05-08] Web - Chat - Composer jumps when entering first emoji #39267

Closed

6 tasks

kbecciv mentioned this pull request Mar 29, 2024

Mark down - Position of text with header and line changes after collapsing the composer #39271

Closed

6 tasks

melvin-bot bot mentioned this pull request Apr 2, 2024

[HOLD for payment 2024-04-09] Live Markdown Preview #27977

Closed

20 tasks

c3024 mentioned this pull request Apr 5, 2024

[HOLD for payment 2024-04-15] [$500] One character jumps after cursor when typing fast #39360

Closed

6 tasks

rayane-d reviewed Dec 10, 2024

View reviewed changes

		@@ -1,14 +1,15 @@
		import {MarkdownTextInput} from '@expensify/react-native-live-markdown';

Conversation

Skalakid commented Mar 12, 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 Mar 13, 2024

Uh oh!

tomekzaw Mar 13, 2024

Choose a reason for hiding this comment

Uh oh!

parasharrajat commented Mar 13, 2024

Uh oh!

thienlnam commented Mar 13, 2024

Uh oh!

This comment has been minimized.

c3024 commented Mar 14, 2024

Uh oh!

c3024 commented Mar 14, 2024

Uh oh!

c3024 commented Mar 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

BartoszGrajdek commented Mar 26, 2024

Uh oh!

c3024 commented Mar 26, 2024

Uh oh!

BartoszGrajdek commented Mar 27, 2024

Uh oh!

thienlnam commented Mar 27, 2024

Uh oh!

github-actions bot commented Mar 27, 2024

Uh oh!

shubham1206agra commented Mar 27, 2024

Uh oh!

shubham1206agra commented Mar 27, 2024

Uh oh!

Skalakid commented Mar 27, 2024

Uh oh!

BartoszGrajdek commented Mar 27, 2024

Uh oh!

thienlnam left a comment

Choose a reason for hiding this comment

Uh oh!

thienlnam commented Mar 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

OSBotify commented Mar 27, 2024

Uh oh!

BartoszGrajdek commented Mar 28, 2024

Uh oh!

OSBotify commented Mar 29, 2024

Uh oh!

OSBotify commented Apr 2, 2024

Uh oh!

rayane-d Dec 10, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

Skalakid commented Mar 12, 2024 •

edited

Loading

c3024 commented Mar 14, 2024 •

edited

Loading

thienlnam commented Mar 27, 2024 •

edited

Loading