Implement Live Markdown for task descriptions by Skalakid · Pull Request #39519 · Expensify/App

Skalakid · 2024-04-03T16:31:25Z

Details

This PR adds live markdown support for form text inputs and enables them in task description pages

Fixed Issues

$ #39189
PROPOSAL:

Tests

Enter any chat
Click + on the left side of main composer
Click Create task
Enter the title and description
Verify if in the description form text input live markdown is enabled
Click Next
Click description preview
Try to edit it and verify if markdown styles are applied in real time
Save the description and create the task
After the task creation, click the task item inside the chat
Click the description preview once again
Verify if you can edit the task description and if live markdown preview is enabled
Save a new task description

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

Android: mWeb Chrome

chrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

safari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

melvin-bot · 2024-04-03T16:31:29Z

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

melvin-bot · 2024-04-05T10:17:21Z

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

jjcoffee · 2024-04-05T15:05:38Z

Reviewing Monday!

jjcoffee · 2024-04-08T09:46:38Z

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-app-2024-04-09_10.50.09.mp4

Android: mWeb Chrome

android-chrome-2024-04-09_10.58.44.mp4

iOS: Native

ios-app-2024-04-09_11.39.35.mp4

iOS: mWeb Safari

ios-safari-2024-04-09_11.47.14.mp4

MacOS: Chrome / Safari

Uploading desktop-chrome-2024-04-09_10.36.58.mp4…

MacOS: Desktop

desktop-app-2024-04-09_10.41.58.mp4

jjcoffee · 2024-04-08T17:35:09Z

Apologies I had higher priority work to get to today. Top of the list for tomorrow!

Skalakid · 2024-04-10T09:18:34Z

@jjcoffee good catch, thanks! I forgot to add Expensify markdown styles on native platforms. Because of that heading font size was much bigger. Now it should be correct

Skalakid · 2024-04-10T09:19:40Z

Minor bug: when entering some italics markdown after a title (#), the italics are too close to the edge of the text input:

@jjcoffee I think this styling bug is also reproducable on normal TextInputs on the staging. Should I fix it?

jjcoffee · 2024-04-10T13:30:33Z

@jjcoffee I think this styling bug is also reproducable on normal TextInputs on the staging. Should I fix it?

Thanks, fixing the other bug fixed this one too! I guess there could be a little more spacing, but it's the same as on main now.

jjcoffee · 2024-04-10T15:38:02Z

Just waiting on confirmation on this before approving.

src/components/TextInput/BaseTextInput/index.tsx

roryabraham · 2024-04-11T18:29:40Z

@jjcoffee feel free to proceed with the review and approval of this PR

Skalakid · 2024-04-12T08:40:37Z

@roryabraham @jjcoffee Prop name changed 🫡

jjcoffee

LGTM!

roryabraham

It's ironic that we've split BaseTextInput into a web and native implementation. It's not longer a shared base component

OSBotify · 2024-04-12T16:08: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 · 2024-04-18T04:56:11Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.4.63-0 🚀

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

OSBotify · 2024-04-22T14:57:10Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.63-21 🚀

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

alitoshmatov · 2024-10-27T17:36:13Z

src/components/TextInput/BaseTextInput/index.native.tsx

                                selection={inputProps.selection}
                                readOnly={isReadOnly}
                                defaultValue={defaultValue}
+                                markdownStyle={markdownStyle}


Markdown does not grow correctly in room descriptions resulting in half cut lines, ref: #48281

Skalakid added 3 commits April 3, 2024 12:16

Enable live markdown in form text inputs

699a61a

Bump react-native-live-markdown version to fix onSubmitEditing prop

1f331cd

Add live markdown to new task description page

da3a7fa

Skalakid mentioned this pull request Apr 3, 2024

[HOLD for Payment 4/29][$250] Implement Live Markdown for task descriptions #39189

Closed

6 tasks

Skalakid added 5 commits April 4, 2024 14:34

Change markdown enabling prop name

d82b1c0

Merge branch 'main' into @Skalakid/new-task-page-live-markdown

2e6e9e3

Update Podfile

cb7ae41

Merge branch 'main' into @Skalakid/new-task-page-live-markdown

17cd16e

Enable live markdown in native BaseTextInput

77813bb

Skalakid marked this pull request as ready for review April 5, 2024 10:17

Skalakid requested a review from a team as a code owner April 5, 2024 10:17

melvin-bot bot requested review from jjcoffee and removed request for a team April 5, 2024 10:17

ShridharGoel mentioned this pull request Apr 5, 2024

[hold for payment 2024-04-29] [$500] Live markdown for money request description #39192

Closed

6 tasks

nexarvo mentioned this pull request Apr 9, 2024

[$250] Live markdown for private notes #39194

Closed

6 tasks

This comment was marked as resolved.

Sign in to view

Skalakid added 2 commits April 10, 2024 10:14

Merge branch 'main' into @Skalakid/new-task-page-live-markdown

a47a00b

Add markdown styles on native platforms

bf7cced

roryabraham requested changes Apr 11, 2024

View reviewed changes

src/components/TextInput/BaseTextInput/index.tsx Outdated Show resolved Hide resolved

Change prop name

a0cd3d7

jjcoffee approved these changes Apr 12, 2024

View reviewed changes

melvin-bot bot requested a review from roryabraham April 12, 2024 08:49

roryabraham approved these changes Apr 12, 2024

View reviewed changes

roryabraham merged commit dff9542 into Expensify:main Apr 12, 2024

roryabraham mentioned this pull request Apr 12, 2024

Add markdown for workspace description #39686

Merged

50 tasks

github-actions bot mentioned this pull request Apr 18, 2024

Deploy Checklist: New Expensify 2024-04-18 #40392

Closed

alitoshmatov reviewed Oct 27, 2024

View reviewed changes

alitoshmatov mentioned this pull request Oct 27, 2024

[HOLD for payment 2024-10-25] [HOLD for payment 2024-10-24] [$250] Android - Room -On entering multiline text with header markdown, 2nd line is not visible #48281

Closed

6 tasks

Conversation

Skalakid commented Apr 3, 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 3, 2024

Uh oh!

melvin-bot bot commented Apr 5, 2024

Uh oh!

jjcoffee commented Apr 5, 2024

Uh oh!

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

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

jjcoffee commented Apr 8, 2024

Uh oh!

This comment was marked as resolved.

This comment was marked as resolved.

Skalakid commented Apr 10, 2024

Uh oh!

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

Uh oh!

Uh oh!

jjcoffee commented Apr 10, 2024

Uh oh!

jjcoffee commented Apr 10, 2024

Uh oh!

Uh oh!

roryabraham commented Apr 11, 2024

Uh oh!

Skalakid commented Apr 12, 2024

Uh oh!

jjcoffee left a comment

Choose a reason for hiding this comment

Uh oh!

roryabraham left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Apr 12, 2024

Uh oh!

OSBotify commented Apr 18, 2024

Uh oh!

OSBotify commented Apr 22, 2024

Uh oh!

alitoshmatov Oct 27, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Skalakid commented Apr 3, 2024 •

edited

Loading

jjcoffee commented Apr 8, 2024 •

edited

Loading

Skalakid commented Apr 10, 2024 •

edited

Loading