Centralize ExpensiMark usage with a dedicated Parser module #44732

blazejkustra · 2024-07-02T13:55:48Z

Details

All details behind this change are described in the issue linked below.

Fixed Issues

$ #44451
PROPOSAL: N/A

Tests

Test Live Markdown features of the composer (heading, bold, strikethrough, quote, mentions etc)
Verify that app doesn't crash on any of the screen where the parser is used (e.g. chat screen, list of reports)

Offline tests

N/A

QA Steps

Same as tests

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

Android: mWeb Chrome

and-web.webm

iOS: Native

ios.mp4

iOS: mWeb Safari

ios-web.mp4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

melvin-bot · 2024-07-02T16:09:38Z

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

Skalakid

LGTM, left one small comment

.eslintrc.js

blazejkustra · 2024-07-03T15:26:00Z

Hey @hoangzinh! What's your ETA for review on this one?

hoangzinh · 2024-07-03T15:45:21Z

@blazejkustra I plan to review it today.

blazejkustra · 2024-07-03T15:48:51Z

Thank you!

BartoszGrajdek

LGTM 😄

blazejkustra · 2024-07-04T06:27:04Z

@hoangzinh I merged the newest main for you 😄

src/stories/Composer.stories.tsx

hoangzinh · 2024-07-04T11:52:34Z

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

Screen.Recording.2024-07-04.at.19.43.48.android.mov

Android: mWeb Chrome

Screen.Recording.2024-07-04.at.19.36.25.android.chrome.mov

iOS: Native

Screen.Recording.2024-07-04.at.19.46.43.ios.mov

iOS: mWeb Safari

Screen.Recording.2024-07-04.at.19.51.29.ios.safari.mov

MacOS: Chrome / Safari

Screen.Recording.2024-07-04.at.18.39.19.web.mov

MacOS: Desktop

Screen.Recording.2024-07-04.at.18.43.46.desktop.mov

neil-marcellini

Looks great, thank you

neil-marcellini · 2024-07-08T21:38:29Z

src/libs/Parser.ts

+    videoAttributeCache?: Record<string, string>;
+};
+
+class ExpensiMarkWithContext extends ExpensiMark {


NAB: Can we please have a comment at the top of the file, or above this class (your choice), which explains the purpose of this briefly? I think it will be helpful for future readers.

OSBotify · 2024-07-08T22:07:24Z

✋ 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-07-10T11:20:17Z

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 9.0.6-0 🚀

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

OSBotify · 2024-07-10T11:37:31Z

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 9.0.6-0 🚀

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

OSBotify · 2024-07-11T10:17:46Z

🚀 Cherry-picked to staging by https://github.com/Julesssss in version: 9.0.6-1 🚀

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.

OSBotify · 2024-07-11T10:37:22Z

🚀 Cherry-picked to staging by https://github.com/Julesssss in version: 9.0.6-1 🚀

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

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

OSBotify · 2024-07-15T20:24:38Z

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.6-8 🚀

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

OSBotify · 2024-07-17T00:20:01Z

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.7-8 🚀

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

blazejkustra added 7 commits July 2, 2024 15:37

Implement Parser

36b4b23

Disallow importing ExpeniMark

2947064

Ignore ExpeniMark import

1912a36

Change usage of OnyxAwareParser

00b1c98

set the logger in PArser lib

01e3d01

Remove all ExpeniMark imports and use PArser instead

69bafc7

Add eslint disable for storybook ExpeniMark import

a4d0160

blazejkustra marked this pull request as ready for review July 2, 2024 16:09

blazejkustra requested a review from a team as a code owner July 2, 2024 16:09

melvin-bot bot requested review from hoangzinh and removed request for a team July 2, 2024 16:09

blazejkustra mentioned this pull request Jul 2, 2024

[Payment due][$250] Centralize ExpensiMark usage with a dedicated Parser module #44451

Closed

Skalakid approved these changes Jul 3, 2024

View reviewed changes

.eslintrc.js Show resolved Hide resolved

Merge branch 'main' into refactor/centralize-expensimark

a9b73ca

BartoszGrajdek approved these changes Jul 3, 2024

View reviewed changes

Merge branch 'main' into refactor/centralize-expensimark

e08b275

hoangzinh reviewed Jul 4, 2024

View reviewed changes

src/stories/Composer.stories.tsx Show resolved Hide resolved

hoangzinh approved these changes Jul 4, 2024

View reviewed changes

melvin-bot bot requested a review from neil-marcellini July 4, 2024 12:54

blazejkustra added 3 commits July 8, 2024 10:11

Merge branch 'main' into refactor/centralize-expensimark

d7a15e5

Change ExpensiMark usage to Parser

6c32800

Merge branch 'main' into refactor/centralize-expensimark

5570f03

neil-marcellini approved these changes Jul 8, 2024

View reviewed changes

neil-marcellini merged commit b419c06 into Expensify:main Jul 8, 2024
15 checks passed

github-actions bot mentioned this pull request Jul 10, 2024

Deploy Checklist: New Expensify 2024-07-10 #45144

Closed

nkdengineer mentioned this pull request Jul 19, 2024

[HOLD for payment][$250] Mention-Numbers are displayed when editing an email mention of a user that is not a contact #45259

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Centralize ExpensiMark usage with a dedicated Parser module #44732

Centralize ExpensiMark usage with a dedicated Parser module #44732

blazejkustra commented Jul 2, 2024 •

edited

Loading

melvin-bot bot commented Jul 2, 2024

Skalakid left a comment

blazejkustra commented Jul 3, 2024

hoangzinh commented Jul 3, 2024

blazejkustra commented Jul 3, 2024

BartoszGrajdek left a comment

blazejkustra commented Jul 4, 2024

hoangzinh commented Jul 4, 2024 •

edited

Loading

neil-marcellini left a comment

neil-marcellini Jul 8, 2024

OSBotify commented Jul 8, 2024

OSBotify commented Jul 10, 2024

OSBotify commented Jul 10, 2024

OSBotify commented Jul 11, 2024

OSBotify commented Jul 11, 2024

OSBotify commented Jul 15, 2024

OSBotify commented Jul 17, 2024

Centralize ExpensiMark usage with a dedicated Parser module #44732

Centralize ExpensiMark usage with a dedicated Parser module #44732

Conversation

blazejkustra commented Jul 2, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 2, 2024

Skalakid left a comment

Choose a reason for hiding this comment

blazejkustra commented Jul 3, 2024

hoangzinh commented Jul 3, 2024

blazejkustra commented Jul 3, 2024

BartoszGrajdek left a comment

Choose a reason for hiding this comment

blazejkustra commented Jul 4, 2024

hoangzinh commented Jul 4, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

neil-marcellini left a comment

Choose a reason for hiding this comment

neil-marcellini Jul 8, 2024

Choose a reason for hiding this comment

OSBotify commented Jul 8, 2024

OSBotify commented Jul 10, 2024

OSBotify commented Jul 10, 2024

OSBotify commented Jul 11, 2024

OSBotify commented Jul 11, 2024

OSBotify commented Jul 15, 2024

OSBotify commented Jul 17, 2024

blazejkustra commented Jul 2, 2024 •

edited

Loading

hoangzinh commented Jul 4, 2024 •

edited

Loading