Console error cleanup: patch react-native-render-html by JKobrynski · Pull Request #52917 · Expensify/App

JKobrynski · 2024-11-21T15:35:18Z

Explanation of Change

This PR introduces a patch to the react-native-render-html library that gets rid of the following console warning we've been seeing on the web/desktop:

Warning: TRenderEngineProvider: Support for defaultProps will be removed from function components in a future major release. Use JavaScript default parameters instead.

It basically removes all occurrences of .defaultProps and related code from the TS, JS and JS map files in the library.

Here is a related issue in the package's repository. Based on the discussion it seems like the library won't be updated anytime soon (the last release was ~2 years ago) and the only solution the community has at the moment is applying a patch.

Fixed Issues

$ #49035 #51099
PROPOSAL: N/A

Tests

Run the web app
Log into the app
Navigate to a report with emojis and attachments (if necessary create one)
Make sure the emojis and all attachments (images, videos) look all right
Repeat the process in the desktop app

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as Tests section above

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-11-22T09:18:01Z

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

paultsimura · 2024-11-22T09:26:54Z

In #49035, we've decided we'll hold for the upstream fix, which is being worked on (but super slow, ngl): meliorence/react-native-render-html#674

@lakchote did we change the decision? Should we apply the patch?

lakchote · 2024-11-22T09:51:32Z

In #49035, we've decided we'll hold for the upstream fix, which is being worked on (but super slow, ngl): meliorence/react-native-render-html#674

@lakchote did we change the decision? Should we apply the patch?

We didn't change decision, as far as I know. I'm not fond of doing patches, except if it's for a critical issue/use case.

It was decided here to wait for the upstream fix. cc @blazejkustra

rezkiy37

One minor comment, besides LGTM.

rezkiy37 · 2024-11-22T11:21:21Z

patches/react-native-render-html+6.3.1+001+initial.patch

@@ -22,4 +22,4 @@ index 6ac80d8..0000000
 -  s.source_files  = "ios/**/*.{h,m}"
 -
 -  s.dependency 'React-Core'
-end


Add a last empty line.

paultsimura · 2024-11-22T11:24:30Z

@JKobrynski @rezkiy37 please see #52917 (comment)

fabioh8010

@JKobrynski I wonder if we need to change the .js.map files for this patch 🤔

fabioh8010 · 2024-11-22T11:02:01Z

patches/react-native-render-html+6.3.1+001+initial.patch

Can we revert any changes here @JKobrynski ?

lakchote · 2024-11-22T14:09:08Z

@JKobrynski I wonder if we need to change the .js.map files for this patch 🤔

@fabioh8010 see #52917 (comment)

JKobrynski · 2024-11-26T15:04:39Z

Closing the PR as it was decided to wait for the upstream to be fixed.

lakchote · 2024-12-10T09:38:19Z

@JKobrynski considering there has been no movements/changes from the upstream library, let's go the patch route cc @fabioh8010 @paultsimura @rezkiy37

Thank you!

paultsimura · 2024-12-10T14:42:31Z

@JKobrynski could you please address the existing comments and ping me for a final review? 🙏

JKobrynski · 2024-12-10T14:53:55Z

@paultsimura of course!

JKobrynski · 2024-12-12T13:34:13Z

PR updated, comments addressed!

CC: @lakchote @paultsimura @fabioh8010 @rezkiy37

JKobrynski · 2024-12-13T13:11:21Z

@lakchote @paultsimura kindly bump 🙏

paultsimura · 2024-12-13T13:50:42Z

Reviewing today

paultsimura · 2024-12-13T23:11:01Z

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 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.ts 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.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
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

paultsimura

Tests well, and the errors are gone.
LGTM ✔️

OSBotify · 2024-12-17T09:16:25Z

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

github-actions · 2024-12-18T13:36:56Z

🚀 Deployed to staging by https://github.com/lakchote in version: 9.0.77-0 🚀

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

…derHTML" This reverts commit 01c2b1b, reversing changes made to d86024e.

lakchote · 2024-12-19T10:36:42Z

@paultsimura @JKobrynski we had to revert this. Please fix it.

paultsimura · 2024-12-19T11:00:46Z

@paultsimura @JKobrynski we had to revert this. Please fix it.

Bump on #49035 (comment) please, so we can know what to look at more precisely.

github-actions · 2024-12-23T20:59:07Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.77-6 🚀

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

remove .defaultProps and related code from the library

cab51e8

JKobrynski marked this pull request as ready for review November 22, 2024 09:17

JKobrynski requested a review from a team as a code owner November 22, 2024 09:17

melvin-bot bot requested review from paultsimura and removed request for a team November 22, 2024 09:18

split the patch into two files

8758645

rezkiy37 suggested changes Nov 22, 2024

View reviewed changes

fabioh8010 reviewed Nov 22, 2024

View reviewed changes

JKobrynski closed this Nov 26, 2024

kubabutkiewicz mentioned this pull request Nov 28, 2024

[HOLD for payment 2024-11-29] Console error cleanup. #51099

Closed

lakchote reopened this Dec 10, 2024

remove .js.map file patches, add newline

c8e1a86

JKobrynski requested review from fabioh8010 and rezkiy37 December 12, 2024 13:33

paultsimura approved these changes Dec 13, 2024

View reviewed changes

melvin-bot bot requested a review from lakchote December 13, 2024 23:20

lakchote approved these changes Dec 16, 2024

View reviewed changes

lakchote merged commit 01c2b1b into Expensify:main Dec 17, 2024

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

Deploy Checklist: New Expensify 2024-12-18 #54292

Closed

72 tasks

lakchote mentioned this pull request Dec 18, 2024

[CP Staging] Revert "Console error cleanup: patch react-native-render-html " #54309

Merged

59 tasks

amyevans mentioned this pull request Dec 18, 2024

Mark down - Link is not underlined, heading text is not bold #54301

Closed

8 tasks

amyevans added a commit that referenced this pull request Dec 18, 2024

Revert "Merge pull request #52917 from JKobrynski/patchReactNativeRen…

c4d48a3

…derHTML" This reverts commit 01c2b1b, reversing changes made to d86024e.

JKobrynski mentioned this pull request Jan 3, 2025

Console error cleanup: patch react-native-render-html #54781

Merged

50 tasks

Conversation

JKobrynski commented Nov 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Nov 22, 2024

Uh oh!

paultsimura commented Nov 22, 2024

Uh oh!

lakchote commented Nov 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rezkiy37 left a comment

Choose a reason for hiding this comment

Uh oh!

rezkiy37 Nov 22, 2024

Choose a reason for hiding this comment

Uh oh!

JKobrynski Dec 12, 2024

Choose a reason for hiding this comment

Uh oh!

paultsimura commented Nov 22, 2024

Uh oh!

fabioh8010 left a comment

Choose a reason for hiding this comment

Uh oh!

fabioh8010 Nov 22, 2024

Choose a reason for hiding this comment

Uh oh!

JKobrynski Dec 12, 2024

Choose a reason for hiding this comment

Uh oh!

lakchote commented Nov 22, 2024

Uh oh!

JKobrynski commented Nov 26, 2024

Uh oh!

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

Uh oh!

Uh oh!

paultsimura commented Dec 10, 2024

Uh oh!

JKobrynski commented Dec 10, 2024

Uh oh!

JKobrynski commented Dec 12, 2024

Uh oh!

JKobrynski commented Dec 13, 2024

Uh oh!

paultsimura commented Dec 13, 2024

Uh oh!

paultsimura commented Dec 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

paultsimura left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Dec 17, 2024

Uh oh!

github-actions bot commented Dec 18, 2024

Uh oh!

lakchote commented Dec 19, 2024

Uh oh!

paultsimura commented Dec 19, 2024

Uh oh!

github-actions bot commented Dec 23, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

JKobrynski commented Nov 21, 2024 •

edited

Loading

lakchote commented Nov 22, 2024 •

edited

Loading

lakchote commented Dec 10, 2024 •

edited

Loading

paultsimura commented Dec 13, 2024 •

edited

Loading