[NO QA] [POC] Tidy up and formalise `./patches` #61498

war-in · 2025-05-06T15:01:45Z

Explanation of Change

Problem

Currently, when updating dependencies (react-native or other libs) we don't know if the patch is still needed or when it was introduced (it requires digging into github because blame often loses track of the first PR e.g. when renaming). That increases migration time and makes the process more difficult.

Solution

Split patches directory into per-library directories

patches/

├── react-native-pdf/
│   ├── details.md
│   ├── react-native-pdf+6.7.3+001+initial.patch
│   ├── react-native-pdf+6.7.3+002+fix-incorrect-decoding.patch
|   └── react-native-pdf+6.7.3+003+update-podspec.patch

├── react-native/
│   ├── details.md
│   ├── patch1.patch
│   └──....patch

Each details.md file would contain a table (to discuss) with link to patch, reason explaining why the patch has been added and links to App and upstream PRs

# `react-native-pdf` patches

| Patch File                                                                                                         | Reason                                                                  | Upstream PR/Issue |                 PR Introducing Patch                  |
|--------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|:-----------------:|:-----------------------------------------------------:|
| [react-native-pdf+6.7.3+001+initial.patch](react-native-pdf+6.7.3+001+initial.patch)                               | Explanation/details                                                     |        🛑         | [#13767](https://github.com/Expensify/App/pull/13767) |
| [react-native-pdf+6.7.3+002+fix-incorrect-decoding.patch](react-native-pdf+6.7.3+002+fix-incorrect-decoding.patch) | If the file name contains accented characters, then the load will fail. |        🛑         | [#50043](https://github.com/Expensify/App/pull/50043) |
| [react-native-pdf+6.7.3+003+update-podspec.patch](react-native-pdf+6.7.3+003+update-podspec.patch)                 | Explanation/details                                                     |        🛑         | [#51475](https://github.com/Expensify/App/pull/51475) |

That way, we will be able to keep track of our patches and make sure the upstream PRs are raised

Fixed Issues

$ #61814
PROPOSAL:

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

github-actions · 2025-05-06T15:01:58Z

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

mountiny · 2025-05-06T15:09:48Z

Love it, i think we can refine it in slack with others, but more structure into the patch management will be beneficial in general, curious what @roryabraham thinks too before you make the p/s in slack

roryabraham · 2025-05-06T17:05:00Z

This looks like a beneficial change to me (avoiding the need to go through GitHub history is great. However, I feel like a missing piece is enforcing that the table is updated whenever patches are changed. It feels somewhat likely that people will miss that. Though even if they did, we'd be no worse-off than we are now. So it's NAB.

I'd be happy to continue reviewing and merge this PR 👍🏼

This reverts commit ff4a4ba.

This reverts commit cf48e75.

war-in · 2025-05-12T15:03:05Z

I modified the details.md structure a bit and added a second version
I like the table for its simplicity (when rendered), but dislike the way it looks in plaintext

The bullet list seems more readable when not rendered and should be easier to maintain

Any thoughts @mountiny @roryabraham?

melvin-bot · 2025-05-12T15:13:40Z

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

mountiny · 2025-05-12T20:29:46Z

I am team bullet points

roryabraham · 2025-05-14T00:45:51Z

Sure, bullets seem fine 👍🏼

Alternatively, you could use a pure HTML table instead of a markdown table. I feel like that might actually expand better into a list-like structure while still looking clean for render (.md tables are a bit fussy)

Whatever you choose is fine with me

war-in · 2025-05-19T15:56:48Z

@roryabraham @mountiny I switched to bullet points and added a guide about patches

roryabraham

We should also validate that every patch that we have matches the version of the package from pacakge.json

.github/scripts/validatePatchDetails.sh

.github/workflows/validatePatchDetails.yml

.github/scripts/validatePatchDetails.sh

contributingGuides/PATCHES.md

Co-authored-by: Rory Abraham <47436092+roryabraham@users.noreply.github.com>

…patches-poc

patches/react-native-pdf/details.md

war-in · 2025-05-20T11:44:42Z

@mountiny @roryabraham I looked at the patches more carefully and found out that they can be merged into one 👀

The second and the third were reverting changes added in the first, so I removed them and adjusted the first patch.
I also found the upstream PR for the initial patch and it's already released in the v6.7.5 (we currently have v6.7.3) so we might want to update the dep in a follow-up PR

mountiny

Thanks, looks good to me, thanks for updating the patches

abdulrahuman5196 · 2025-05-21T11:03:44Z

Hi, Do we need C+ here?

mountiny · 2025-05-21T13:50:11Z

@abdulrahuman5196 no need, thanks!

.github/workflows/validatePatches.yml

scripts/validatePatches.sh

mountiny

All yours @roryabraham

roryabraham · 2025-05-23T17:31:23Z

Ignoring failing Validate GitHub Actions check because I know it's unrelated and already fixed on main.

roryabraham · 2025-05-23T17:31:39Z

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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
I verified tests pass on all platforms & I tested again on:
- Android: HybridApp
- Android: mWeb Chrome
- iOS: HybridApp
- 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 there are no new alerts related to the canBeMissing param for useOnyx
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: HybridApp

Android: mWeb Chrome

iOS: HybridApp

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2025-05-23T17:32:40Z

@roryabraham looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

OSBotify · 2025-05-23T17:42: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.

github-actions · 2025-05-23T19:30:13Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 9.1.51-0 🚀

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

github-actions · 2025-05-26T19:16:02Z

🚀 Deployed to production by https://github.com/arosiclair in version: 9.1.51-6 🚀

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

war-in added 2 commits May 6, 2025 16:39

move patches and add details.md

a6d779c

modify applyPatches.sh

fa93710

war-in changed the title ~~[NO QA] [POC] Tidy up and formalize ./patches~~ [NO QA] [POC] Tidy up and formalise ./patches May 6, 2025

mountiny assigned war-in May 9, 2025

war-in added 2 commits May 12, 2025 15:58

add Validate Patches check

53ca91f

fix script

f8ebb52

war-in force-pushed the war-in/patches-poc branch from de6f0f6 to f8ebb52 Compare May 12, 2025 14:41

war-in added 5 commits May 12, 2025 16:46

remove patch 003 entry from details.md to verify the script

cf48e75

remove details.md to verify the script

ff4a4ba

Revert "remove details.md to verify the script"

7882ad4

This reverts commit ff4a4ba.

Revert "remove patch 003 entry from details.md to verify the script"

c73f12b

This reverts commit cf48e75.

add second version for patches details

38499da

war-in marked this pull request as ready for review May 12, 2025 15:13

war-in requested a review from a team as a code owner May 12, 2025 15:13

melvin-bot bot requested review from abdulrahuman5196 and removed request for a team May 12, 2025 15:13

add contributingGuides/PATCHES.md with instructions

1b136a7

roryabraham requested changes May 19, 2025

View reviewed changes

war-in and others added 3 commits May 20, 2025 12:37

Update contributingGuides/PATCHES.md

6332add

Co-authored-by: Rory Abraham <47436092+roryabraham@users.noreply.github.com>

apply review suggestions

6bedaaa

Merge remote-tracking branch 'origin/war-in/patches-poc' into war-in/…

d5c7f90

…patches-poc

mountiny reviewed May 20, 2025

View reviewed changes

patches/react-native-pdf/details.md Outdated Show resolved Hide resolved

war-in added 3 commits May 20, 2025 13:00

fix patch after moving the script

d268a29

Merge branch 'refs/heads/main' into war-in/patches-poc

6e14621

simplify patches and add a link to the upstream PR

4f2989d

mountiny previously approved these changes May 20, 2025

View reviewed changes

roryabraham requested changes May 21, 2025

View reviewed changes

roryabraham mentioned this pull request May 21, 2025

Bump React Native to 0.79 #60421

Merged

50 tasks

review suggestions

99596e0

war-in dismissed mountiny’s stale review via 99596e0 May 22, 2025 09:45

mountiny approved these changes May 22, 2025

View reviewed changes

roryabraham approved these changes May 23, 2025

View reviewed changes

roryabraham merged commit 4caee5b into Expensify:main May 23, 2025
16 of 19 checks passed

melvin-bot bot added the Emergency label May 23, 2025

roryabraham removed the Emergency label May 23, 2025

github-actions bot mentioned this pull request May 23, 2025

Deploy Checklist: New Expensify 2025-05-23 #62662

Closed

melvin-bot bot mentioned this pull request May 26, 2025

[Due for payment 2025-06-02] Clean up and formalise patch management #61814

Closed

mountiny mentioned this pull request Jun 6, 2025

Tracking: Remove VisionCamera CameraSession on Fabric patch once the library was fully migrated to New Arch #49988

Closed

roryabraham mentioned this pull request Jun 25, 2025

Enable 16KB memory page size on Android #64640

Closed

51 tasks

[NO QA] [POC] Tidy up and formalise ./patches #61498

[NO QA] [POC] Tidy up and formalise ./patches #61498

Uh oh!

Conversation

war-in commented May 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation of Change

Problem

Solution

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

github-actions bot commented May 6, 2025

Uh oh!

mountiny commented May 6, 2025

Uh oh!

roryabraham commented May 6, 2025

Uh oh!

war-in commented May 12, 2025

Uh oh!

melvin-bot bot commented May 12, 2025

Uh oh!

mountiny commented May 12, 2025

Uh oh!

roryabraham commented May 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

war-in commented May 19, 2025

Uh oh!

roryabraham left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

war-in commented May 20, 2025

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

abdulrahuman5196 commented May 21, 2025

Uh oh!

mountiny commented May 21, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

roryabraham commented May 23, 2025

Uh oh!

roryabraham commented May 23, 2025

Reviewer Checklist

Screenshots/Videos

Uh oh!

Uh oh!

melvin-bot bot commented May 23, 2025

Uh oh!

OSBotify commented May 23, 2025

Uh oh!

github-actions bot commented May 23, 2025

Uh oh!

github-actions bot commented May 26, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

[NO QA] [POC] Tidy up and formalise `./patches` #61498

[NO QA] [POC] Tidy up and formalise `./patches` #61498

war-in commented May 6, 2025 •

edited

Loading

roryabraham commented May 14, 2025 •

edited

Loading