[TS migration] Migrate HTMLEngineProvider component #33643

ruben-rebelo · 2023-12-27T12:11:40Z

Details

[TS migration] Migrate HTMLEngineProvider component

Fixed Issues

$ #25097

PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console

How to test

Open a chat
Send/View the following types of messages:

Email address
Website
Attachment
Image
Mention of user
here tag mention
Task with checkbox

All of the above should work as normally, they work if you press them depending on the functionality

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

Android: mWeb Chrome

android-web.mov

iOS: Native

ios-native.mov

iOS: mWeb Safari

ios-web.mov

MacOS: Chrome / Safari

macos-web.mov

MacOS: Desktop

macos-desktop.mov

src/components/HTMLEngineProvider/index.native.tsx

src/components/HTMLEngineProvider/BaseHTMLEngineProvider.tsx

VickyStash

LGTM

src/components/HTMLEngineProvider/BaseHTMLEngineProvider.tsx

# Conflicts: # src/components/HTMLEngineProvider/BaseHTMLEngineProvider.tsx

melvin-bot · 2024-01-08T11:51:27Z

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

s77rt · 2024-01-08T17:18:55Z

src/components/HTMLEngineProvider/types.ts

+    /** Optional debug flag. Prints the TRT in the console when true. */
+    debug?: boolean;


We don't seem to be using this prop. BaseHTMLEngineProvider does not make any use of it

s77rt · 2024-01-08T17:23:41Z

src/components/HTMLEngineProvider/types.ts

+
+type HTMLEngineProviderProps = {
+    /** Children to wrap in HTMLEngineProvider. */
+    children?: ReactNode;


children is a required prop.

(Since we will be removing debug let's just use ChildrenProps)

s77rt · 2024-01-08T17:24:33Z

src/components/HTMLEngineProvider/index.tsx

+    return (
+        <BaseHTMLEngineProvider
+            debug={debug}
+            textSelectable={!DeviceCapabilities.canUseTouchScreen() || isSmallScreenWidth}


Suggested change

textSelectable={!DeviceCapabilities.canUseTouchScreen() || isSmallScreenWidth}

textSelectable={!DeviceCapabilities.canUseTouchScreen() || !isSmallScreenWidth}

s77rt · 2024-01-08T17:44:48Z

src/components/HTMLEngineProvider/htmlEngineUtils.ts

 */
-function isCommentTag(tagName) {
+function isCommentTag(tagName?: string): boolean {


Suggested change

function isCommentTag(tagName?: string): boolean {

function isCommentTag(tagName: string): boolean {

It does not make much sense to call this function with an undefined tag name

s77rt · 2024-01-08T17:53:24Z

src/components/HTMLEngineProvider/htmlEngineUtils.ts

-function isChildOfComment(tnode) {
-    return isChildOfNode(tnode, (node) => isCommentTag(lodashGet(node, 'domNode.name', '')));
+function isChildOfComment(tnode: TNode): boolean {
+    return isChildOfNode(tnode, (node) => isCommentTag(node.domNode?.name));


Suggested change

return isChildOfNode(tnode, (node) => isCommentTag(node.domNode?.name));

return isChildOfNode(tnode, (node) => node.domNode?.name != null && isCommentTag(node.domNode.name));

s77rt · 2024-01-08T17:59:35Z

src/components/HTMLEngineProvider/htmlEngineUtils.ts

-function isChildOfH1(tnode) {
-    return isChildOfNode(tnode, (node) => lodashGet(node, 'domNode.name', '').toLowerCase() === 'h1');
+function isChildOfH1(tnode: TNode): boolean {
+    return isChildOfNode(tnode, (node) => node.domNode?.name.toLowerCase() === 'h1');


Suggested change

return isChildOfNode(tnode, (node) => node.domNode?.name.toLowerCase() === 'h1');

return isChildOfNode(tnode, (node) => node.domNode?.name != null && node.domNode.name.toLowerCase() === 'h1');

This is causing a crash. Apparently ts is not able to detect that name can be undefined and it's just okey with calling toLowerCase()

s77rt · 2024-01-08T18:03:09Z

src/components/HTMLEngineProvider/htmlEngineUtils.ts

-function computeEmbeddedMaxWidth(tagName, contentWidth) {
+function computeEmbeddedMaxWidth(contentWidth: number, tagName: string): number {


This is interesting were we doing something wrong the whole time? Isn't this param swapping a breaking change?

This is something that was actually wrong the whole time, if you take a look at function computeEmbeddedMaxWidth from react-native-render-html the parameters order is the one that we have provided now.
I couldn't find any version where this parameters were swapped by the package maintainer.

s77rt · 2024-01-08T18:03:45Z

src/components/HTMLEngineProvider/htmlEngineUtils.ts

+ * @param tagName - The name of the tag for which max width should be constrained.
+ * @param contentWidth - The content width provided to the HTML


NAB. Swap the comments lines, first param goes first

ruben-rebelo · 2024-01-09T10:25:34Z

Hello @s77rt, Thank you so much for your review, I've agreed and applied your suggestions, please take a look.

s77rt · 2024-01-09T14:00:13Z

src/components/HTMLEngineProvider/types.ts

-    /** Optional debug flag. Prints the TRT in the console when true. */
-    debug?: boolean;
-};
+type HTMLEngineProviderProps = ChildrenProps;


We don't need to define a type that is just another type. We can just use ChildrenProps and remove HTMLEngineProviderProps

s77rt · 2024-01-09T14:01:28Z

src/components/HTMLEngineProvider/index.tsx


-function HTMLEngineProvider({debug = false, children = null}: HTMLEngineProviderProps) {
+function HTMLEngineProvider({children = null}: HTMLEngineProviderProps) {


Suggested change

function HTMLEngineProvider({children = null}: HTMLEngineProviderProps) {

function HTMLEngineProvider({children}: HTMLEngineProviderProps) {

No default value is needed since the prop is required

s77rt · 2024-01-09T14:06:45Z

src/components/HTMLEngineProvider/htmlEngineUtils.ts

@@ -47,15 +47,15 @@ function isChildOfNode(tnode: TNode, predicate: Predicate): boolean {
 * Finding node with name 'comment' flags that we are rendering a comment.
 */
 function isChildOfComment(tnode: TNode): boolean {
-    return isChildOfNode(tnode, (node) => isCommentTag(node.domNode?.name));
+    return isChildOfNode(tnode, (node) => node.domNode?.name !== undefined && isCommentTag(node.domNode?.name));


Suggested change

return isChildOfNode(tnode, (node) => node.domNode?.name !== undefined && isCommentTag(node.domNode?.name));

return isChildOfNode(tnode, (node) => node.domNode?.name !== undefined && isCommentTag(node.domNode.name));

s77rt · 2024-01-09T14:10:28Z

src/components/HTMLEngineProvider/htmlEngineUtils.ts

 }

 /**
 * Check if there is an ancestor node with the name 'h1'.
 * Finding a node with the name 'h1' flags that we are rendering inside an h1 element.
 */
 function isChildOfH1(tnode: TNode): boolean {
-    return isChildOfNode(tnode, (node) => node.domNode?.name.toLowerCase() === 'h1');
+    return isChildOfNode(tnode, (node) => node.domNode?.name !== null && node.domNode?.name.toLowerCase() === 'h1');


Suggested change

return isChildOfNode(tnode, (node) => node.domNode?.name !== null && node.domNode?.name.toLowerCase() === 'h1');

return isChildOfNode(tnode, (node) => node.domNode?.name !== undefined && node.domNode.name.toLowerCase() === 'h1');

The name is never null, it's either a string or undefined so the condition will always be true and it will cause the app to crash

ruben-rebelo · 2024-01-10T09:49:36Z

Hi @s77rt, thank you so much again.
I've applied this changes!

s77rt · 2024-01-10T16:14:42Z

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

s77rt · 2024-01-10T16:14:54Z

@ruben-rebelo Thank you!

melvin-bot · 2024-01-10T16:15:08Z

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

ruben-rebelo · 2024-01-12T09:39:48Z

Hello @mountiny, It seems there was an error with the melvin-bot and it didn't assign any engineer from Expensify.
Can you please give us an hand here?
Thank you!

s77rt · 2024-01-12T10:05:14Z

@nkuoch

OSBotify · 2024-01-12T12:59:29Z

✋ 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-01-15T11:57:11Z

🚀 Deployed to staging by https://github.com/nkuoch in version: 1.4.25-0 🚀

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

OSBotify · 2024-01-17T01:14:55Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.25-10 🚀

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

ruben-rebelo changed the title ~~[ts-migration] Migrate HTMLEngineProvider component~~ [TS migration] Migrate HTMLEngineProvider component Dec 27, 2023

VickyStash reviewed Dec 27, 2023

View reviewed changes

VickyStash approved these changes Dec 28, 2023

View reviewed changes

blazejkustra approved these changes Jan 2, 2024

View reviewed changes

src/components/HTMLEngineProvider/BaseHTMLEngineProvider.tsx Show resolved Hide resolved

ruben-rebelo added 2 commits January 8, 2024 11:20

[ts-migration] Migrate HTMLEngineProvider component

d487449

[TS migration] Code improvements

4ba8eb2

ruben-rebelo force-pushed the ts-migration/HTMLEngineProvider-component branch from 471a606 to 4ba8eb2 Compare January 8, 2024 11:20

ruben-rebelo added 2 commits January 8, 2024 11:45

[TS migration] Prettier changes

71ee3aa

Merge branch 'main' into ts-migration/HTMLEngineProvider-component

aebd554

# Conflicts: # src/components/HTMLEngineProvider/BaseHTMLEngineProvider.tsx

ruben-rebelo marked this pull request as ready for review January 8, 2024 11:51

ruben-rebelo requested a review from a team as a code owner January 8, 2024 11:51

melvin-bot bot requested review from s77rt and removed request for a team January 8, 2024 11:51

s77rt suggested changes Jan 8, 2024

View reviewed changes

ruben-rebelo added 2 commits January 9, 2024 10:19

[TS migration] Code improvements

5b9473f

[TS migration] Code style improvements

c8813dc

s77rt suggested changes Jan 9, 2024

View reviewed changes

ruben-rebelo added 2 commits January 10, 2024 09:38

[TS migration] Code improvements and variable cleanup

baa1577

[TS migration] Fix lint issues

f75c0fa

s77rt approved these changes Jan 10, 2024

View reviewed changes

Merge branch 'main' into ts-migration/HTMLEngineProvider-component

7c3cfd3

nkuoch self-requested a review January 12, 2024 11:53

nkuoch approved these changes Jan 12, 2024

View reviewed changes

nkuoch merged commit 964548a into Expensify:main Jan 12, 2024
15 checks passed

ruben-rebelo deleted the ts-migration/HTMLEngineProvider-component branch January 12, 2024 17:45

github-actions bot mentioned this pull request Jan 15, 2024

Deploy Checklist: New Expensify 2024-01-15 #34493

Closed

83 tasks

lanitochka17 mentioned this pull request Jan 15, 2024

[HOLD for payment 2024-01-25] [HOLD for payment 2024-01-24] Android & iOS - Attachment - App crashes when closing attachment while it is loading #34510

Closed

6 tasks

melvin-bot bot mentioned this pull request Jan 17, 2024

[HOLD for payment 2024-01-24] [TS migration] Migrate 'HTMLEngineProvider' component to TypeScript #25097

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate HTMLEngineProvider component #33643

[TS migration] Migrate HTMLEngineProvider component #33643

ruben-rebelo commented Dec 27, 2023

VickyStash left a comment

melvin-bot bot commented Jan 8, 2024

s77rt Jan 8, 2024

s77rt Jan 8, 2024

s77rt Jan 8, 2024

s77rt Jan 8, 2024

s77rt Jan 8, 2024

s77rt Jan 8, 2024

s77rt Jan 8, 2024

ruben-rebelo Jan 9, 2024

s77rt Jan 8, 2024

ruben-rebelo commented Jan 9, 2024

s77rt Jan 9, 2024

s77rt Jan 9, 2024

s77rt Jan 9, 2024

s77rt Jan 9, 2024

ruben-rebelo commented Jan 10, 2024

s77rt commented Jan 10, 2024

s77rt commented Jan 10, 2024

melvin-bot bot commented Jan 10, 2024

ruben-rebelo commented Jan 12, 2024

s77rt commented Jan 12, 2024

OSBotify commented Jan 12, 2024

OSBotify commented Jan 15, 2024

OSBotify commented Jan 17, 2024

		/** Optional debug flag. Prints the TRT in the console when true. */
		debug?: boolean;

	textSelectable={!DeviceCapabilities.canUseTouchScreen() \|\| isSmallScreenWidth}
	textSelectable={!DeviceCapabilities.canUseTouchScreen() \|\| !isSmallScreenWidth}

	function isCommentTag(tagName?: string): boolean {
	function isCommentTag(tagName: string): boolean {

	return isChildOfNode(tnode, (node) => isCommentTag(node.domNode?.name));
	return isChildOfNode(tnode, (node) => node.domNode?.name != null && isCommentTag(node.domNode.name));

		function computeEmbeddedMaxWidth(tagName, contentWidth) {
		function computeEmbeddedMaxWidth(contentWidth: number, tagName: string): number {

		* @param tagName - The name of the tag for which max width should be constrained.
		* @param contentWidth - The content width provided to the HTML


		function HTMLEngineProvider({debug = false, children = null}: HTMLEngineProviderProps) {
		function HTMLEngineProvider({children = null}: HTMLEngineProviderProps) {

	function HTMLEngineProvider({children = null}: HTMLEngineProviderProps) {
	function HTMLEngineProvider({children}: HTMLEngineProviderProps) {

[TS migration] Migrate HTMLEngineProvider component #33643

[TS migration] Migrate HTMLEngineProvider component #33643

Conversation

ruben-rebelo commented Dec 27, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

VickyStash left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Jan 8, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ruben-rebelo commented Jan 9, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ruben-rebelo commented Jan 10, 2024

s77rt commented Jan 10, 2024

Reviewer Checklist

Screenshots/Videos

s77rt commented Jan 10, 2024

melvin-bot bot commented Jan 10, 2024

ruben-rebelo commented Jan 12, 2024

s77rt commented Jan 12, 2024

OSBotify commented Jan 12, 2024

OSBotify commented Jan 15, 2024

OSBotify commented Jan 17, 2024