Skip to content

[No QA] Make the html-entities worklet patch idempotent - #98395

Open
roryabraham wants to merge 1 commit into
mainfrom
rory/fix-html-entities-patch-idempotency
Open

[No QA] Make the html-entities worklet patch idempotent#98395
roryabraham wants to merge 1 commit into
mainfrom
rory/fix-html-entities-patch-idempotency

Conversation

@roryabraham

@roryabraham roryabraham commented Aug 12, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Explanation of Change

patches/html-entities/html-entities+2.5.3+001+use-worklet.patch was not idempotent, so it re-applied on every npm install and accumulated duplicate "worklet"; directives in node_modules. This is a problem because it corrupts npm run gh-actions-build such that there's a duplicated worklet line for every npm i that you run between builds.

The patch added the directive as a new line above "use strict";:

@@ -1,2 +1,3 @@
+"worklet"; // This function is used in react-native-live-markdown parser ...
 "use strict";var __assign=this&&this.__assign||function(){...

Because that is a pure insertion, the context line it anchors on ("use strict";var __assign=...) still matches after the patch has been applied — just shifted down by one line. patch-package applies it again at the new offset instead of recognising it as already applied, and reports success while doing so. Every subsequent npm install adds another copy.

The fix prepends the directive to the existing "use strict"; line rather than adding a line of its own:

@@ -1,2 +1,2 @@
-"use strict";var __assign=this&&this.__assign||function(){...
+"worklet"; /* ... */ "use strict";var __assign=this&&this.__assign||function(){...

The patch now modifies a line instead of only inserting one, so once applied its removal context no longer matches and patch-package correctly detects the patch as already applied and leaves the file alone.

The comment changes from // to /* */ because the directive now shares a line with the code that follows it.

Both remain directives. A block comment does not interrupt the directive prologue, so "use strict" still takes effect and "worklet" is still the first directive — which is what react-native-reanimated requires.

Fixed Issues

$ n/a - annoying development quirk.

Tests

  1. Run npm install several times so the patch would previously have applied more than once
  2. Run npm run gh-actions-build
  3. Run grep -c 'must be a worklet' .github/actions/javascript/proposalPoliceComment/index.js and verify it prints 1
  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

N/A

  • Verify that no errors appear in the JS console

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
  • 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 verified there are no new alerts related to the canBeMissing param for useOnyx
  • 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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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 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 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.ts 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 new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user 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.

Screenshots/Videos

N/A

@roryabraham
fix: make the html-entities worklet patch idempotent
ea71ea7 
The patch added "worklet"; as a new line above "use strict";. Because
that was a pure insertion, its context still matched once applied, so
patch-package never recognised the patch as already applied and inserted
another copy on every run. Anyone who ran npm install more than once
accumulated duplicate directives in node_modules, which then leaked into
the bundled GitHub Actions and failed Validate Github Actions against
CI's clean install, on PRs that had nothing to do with this patch.

Prepend the directive to the existing "use strict"; line instead. The
removal context then stops matching once applied, so patch-package
detects the patch as already applied and leaves the file alone.

Both remain directives: a block comment does not interrupt the directive
prologue, so "use strict" still takes effect and "worklet" is still
first. Verified against a pristine html-entities@2.5.3 that three
consecutive patch-package runs leave exactly one directive, exit 0, and
emit no warnings (applyPatches.sh treats any warning as a failure).
@roryabraham

roryabraham commented Aug 12, 2026

Copy link
Copy Markdown
Contributor Author

@codex review

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Aug 12, 2026

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. You're on a roll.

Reviewed commit: ea71ea764e

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

@roryabraham
roryabraham marked this pull request as ready for review August 12, 2026 05:28
@roryabraham
roryabraham requested a review from a team as a code owner August 12, 2026 05:28
@melvin-bot
melvin-bot Bot requested a review from NicolasBonet August 12, 2026 05:29
@melvin-bot

melvin-bot Bot commented Aug 12, 2026

Copy link
Copy Markdown

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

@melvin-bot
melvin-bot Bot removed the request for review from a team August 12, 2026 05:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@NicolasBonet NicolasBonet Awaiting requested review from NicolasBonet

At least 1 approving review is required to merge this pull request.

Assignees

@roryabraham roryabraham

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@roryabraham