[TS migration] Migrate HTMLRenderers components #35462

ruben-rebelo · 2024-01-31T10:36:16Z

Details

[TS migration] Migrate HTMLRenderers components to TypeScript

Fixed Issues

$ #25154
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console

Test HTMLRenderers:

Test the following chat message types:

File attachments
Code snippers
Edited message
Image
Mention here
Mention user
Formated test message

All the above should render and work as previously

Offline tests

N/A

QA Steps

Verify that no errors appear in the JS console

Same as in the Tests section.

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

# Conflicts: # src/components/HTMLEngineProvider/HTMLRenderers/MentionUserRenderer.tsx

# Conflicts: # src/components/ReportActionItem/ReportActionItemImage.tsx

ruben-rebelo · 2024-01-31T15:03:14Z

@blazejkustra, I'm sorry about this but Last PR was closed due to an issue with rebasing. I've created this new PR with cherry picked commits.
Can you please have an extra look here? Should be the same
Thank you!

melvin-bot · 2024-02-02T09:51:04Z

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

mollfpr · 2024-02-05T09:57:13Z

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 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 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 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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

35462.Android.mp4

Android: mWeb Chrome

35462.mWeb-Chrome.mp4

iOS: Native

35462.iOS.mov

iOS: mWeb Safari

35462.mWeb-Safri.mov

MacOS: Chrome / Safari

35462.Web.mp4

MacOS: Desktop

35462.Desktop.mp4

melvin-bot · 2024-02-05T10:02:21Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #25154 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

mollfpr · 2024-02-07T14:10:59Z

Whoops we have a conflict. @ruben-rebelo Could you resolve the conflict? Thank you!

# Conflicts: # src/components/HTMLEngineProvider/HTMLRenderers/MentionUserRenderer.js # src/components/HTMLEngineProvider/HTMLRenderers/NextStepEmailRenderer.tsx

ruben-rebelo · 2024-02-07T16:02:19Z

Hello @mollfpr, thanks for the review, I've resolved the conflicts!

ruben-rebelo · 2024-02-08T15:13:50Z

Hello @mountiny, Seems the bot didn't assign any engineer here.
Can you please give us an hand here?
Thank you!

# Conflicts: # src/components/HTMLEngineProvider/HTMLRenderers/MentionUserRenderer.js

mollfpr · 2024-02-08T18:37:30Z

@techievivek Could you review the PR? Thank you!

mountiny · 2024-02-08T20:23:29Z

@techievivek can you please review?

techievivek

Looks good.

OSBotify · 2024-02-09T05:14:07Z

✋ 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-02-12T14:20:49Z

🚀 Deployed to staging by https://github.com/techievivek in version: 1.4.40-0 🚀

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

OSBotify · 2024-02-13T18:26:10Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.40-5 🚀

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

mollfpr · 2024-03-09T15:32:11Z

src/components/HTMLEngineProvider/HTMLRenderers/AnchorRenderer.tsx

-            style={{...props.style, ...parentStyle, ...styles.textUnderlinePositionUnder, ...styles.textDecorationSkipInkNone}}
-            key={props.key}
-            displayName={displayName}
+            style={[parentStyle, styles.textUnderlinePositionUnder, styles.textDecorationSkipInkNone, style]}


✋ Coming from #36349

We seem to have messed out the style because the props position changed.

jjcoffee · 2024-03-12T10:28:05Z

src/components/HTMLEngineProvider/HTMLRenderers/MentionUserRenderer.tsx

+        const user = personalDetails.htmlAttribAccountID;
+        accountID = parseInt(htmlAttribAccountID, 10);
+        // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
+        displayNameOrLogin = LocalePhoneNumber.formatPhoneNumber(user?.login ?? '') || user?.displayName || translate('common.hidden');


Coming from #36443, a regression came from here as we changed the order from the JS file. More info here.

ruben-rebelo added 10 commits January 30, 2024 17:14

[TS migration] HTMLRenderers components migration

170ae46

# Conflicts: # src/components/HTMLEngineProvider/HTMLRenderers/MentionUserRenderer.tsx

[TS migration] Code improvements

90bd42a

[TS migration] Addressed suggestions HTMLRenderers

66461db

[TS migration] HTMLRenderers prettified

5b7cd2b

[TS migration] HTMLRenderers applied code suggestion

42cbbd5

[TS migration] Comment style

7164056

[TS migration] HTMLRenderers better check for typesafety

3b36267

[TS migration] Fixed issues after merge with master

a068c0c

[TS migration] Lint fixes

2e0f786

[TS migration][HTMlRenderers] After merge code changes

61fc9c6

# Conflicts: # src/components/HTMLEngineProvider/HTMLRenderers/MentionUserRenderer.tsx

ruben-rebelo changed the title ~~Ts migration/html renderers~~ [TS migration] Migrate HTMLRenderers components Jan 31, 2024

Merge branch 'main' into ts-migration/HTMLRenderers

fbafb0f

# Conflicts: # src/components/ReportActionItem/ReportActionItemImage.tsx

blazejkustra approved these changes Jan 31, 2024

View reviewed changes

ruben-rebelo marked this pull request as ready for review February 2, 2024 09:50

ruben-rebelo requested a review from a team as a code owner February 2, 2024 09:50

melvin-bot bot removed the request for review from a team February 2, 2024 09:51

melvin-bot bot requested a review from mollfpr February 2, 2024 09:51

mollfpr approved these changes Feb 5, 2024

View reviewed changes

Merge branch 'main' into ts-migration/HTMLRenderers

5c7dbb8

# Conflicts: # src/components/HTMLEngineProvider/HTMLRenderers/MentionUserRenderer.js # src/components/HTMLEngineProvider/HTMLRenderers/NextStepEmailRenderer.tsx

Merge branch 'main' into ts-migration/HTMLRenderers

54821c2

# Conflicts: # src/components/HTMLEngineProvider/HTMLRenderers/MentionUserRenderer.js

mountiny requested a review from techievivek February 8, 2024 20:23

mountiny assigned ruben-rebelo Feb 8, 2024

techievivek approved these changes Feb 9, 2024

View reviewed changes

techievivek merged commit 9463e22 into Expensify:main Feb 9, 2024
15 checks passed

github-actions bot mentioned this pull request Feb 12, 2024

Deploy Checklist: New Expensify 2024-02-12 #36335

Closed

90 tasks

ikevin127 mentioned this pull request Feb 12, 2024

[HOLD for payment 2024-02-20] [$250] Text with single backtick code block is not rendered correctly #36348

Closed

6 tasks

fedirjh mentioned this pull request Feb 12, 2024

[HOLD for payment 2024-02-20] [$500] Task – User with the custom name is shown as Hidden in task assignee field #36341

Closed

6 tasks

aldo-expensify mentioned this pull request Feb 12, 2024

[CP Staging] Revert typescript migration change #36360

Merged

50 tasks

situchan mentioned this pull request Feb 13, 2024

[HOLD for payment 2024-03-06] [$250] Strikethrough line is white on links and emails #36349

Closed

6 tasks

melvin-bot bot mentioned this pull request Feb 13, 2024

[HOLD for payment 2024-03-07] [TS migration] Migrate 'HTMLRenderers' component to TypeScript #25154

Closed

mkhutornyi mentioned this pull request Feb 13, 2024

[$500] Domain name is not dropped when sending text with user mention from same domain #36347

Closed

6 tasks

jjcoffee mentioned this pull request Feb 15, 2024

[$500] Task – Assignee with the custom name is shown as email in a task name #36443

Closed

6 tasks

mollfpr reviewed Mar 9, 2024

View reviewed changes

jjcoffee reviewed Mar 12, 2024

View reviewed changes

bernhardoj mentioned this pull request Apr 5, 2024

[HOLD][$250] Android - Chat - Sending code block message with italic is not applied& preview inconsistent #39623

Open

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate HTMLRenderers components #35462

[TS migration] Migrate HTMLRenderers components #35462

ruben-rebelo commented Jan 31, 2024

ruben-rebelo commented Jan 31, 2024

melvin-bot bot commented Feb 2, 2024

mollfpr commented Feb 5, 2024 •

edited

Loading

melvin-bot bot commented Feb 5, 2024

mollfpr commented Feb 7, 2024

ruben-rebelo commented Feb 7, 2024

ruben-rebelo commented Feb 8, 2024

mollfpr commented Feb 8, 2024

mountiny commented Feb 8, 2024

techievivek left a comment

OSBotify commented Feb 9, 2024

OSBotify commented Feb 12, 2024

OSBotify commented Feb 13, 2024

mollfpr Mar 9, 2024

jjcoffee Mar 12, 2024

[TS migration] Migrate HTMLRenderers components #35462

[TS migration] Migrate HTMLRenderers components #35462

Conversation

ruben-rebelo commented Jan 31, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

ruben-rebelo commented Jan 31, 2024

melvin-bot bot commented Feb 2, 2024

mollfpr commented Feb 5, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

melvin-bot bot commented Feb 5, 2024

mollfpr commented Feb 7, 2024

ruben-rebelo commented Feb 7, 2024

ruben-rebelo commented Feb 8, 2024

mollfpr commented Feb 8, 2024

mountiny commented Feb 8, 2024

techievivek left a comment

Choose a reason for hiding this comment

OSBotify commented Feb 9, 2024

OSBotify commented Feb 12, 2024

OSBotify commented Feb 13, 2024

mollfpr Mar 9, 2024

Choose a reason for hiding this comment

jjcoffee Mar 12, 2024

Choose a reason for hiding this comment

mollfpr commented Feb 5, 2024 •

edited

Loading