[No QA] Fail patch-package on errors or warnings by roryabraham · Pull Request #44589 · Expensify/App

roryabraham · 2024-06-28T01:27:29Z

Details

This PR adds a PR check that verifies all patches in are applied cleanly by patch-package. This ensures that we don't upgrade a dependency and break a patch without noticing, or keep a patch that is no longer needed. Hopefully this will help keep our patches a bit more in-control. We have a lot of them.

After a timely slack discussion, the approach in this PR has been simplified a bit. Instead of adding a new PR check, this PR just adds a wrapper script around patch-package that will fail if there's an error or warning, and runs that script in postInstall.sh.

This will act as a PR check, because any action (such as test or lint) using setupNode will fail at npm ci as well. But it also prevents developers from making the mistake locally or missing that one of their patches is broken, which is easy to miss and can lead to errors in the dev environment that wastes time.

Fixed Issues

$ #3677

Tests

Completely break a patch such that patch-package fails instead of warns.
Run npm install, verify that it fails.
Revert the change from (1)
Change the version number on one or more patches, but otherwise leave it untouched.
Run npm install, verify that it fails.
Revert the change from (4)
Run npm install, verify that it passes.

Verify that no errors appear in the JS console

Offline tests

None.

QA Steps

None.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

roryabraham · 2024-06-28T02:09:34Z

patches/react-native-keyboard-controller+1.12.2.patch

This patch version matched, it just ended in .patch.patch for some reason. Renamed it to just .patch and that worked.

roryabraham · 2024-06-28T02:09:54Z

patches/@expensify+react-native-live-markdown+0.1.88.patch

Renamed without changes. Created upstream PR, which was missing: Expensify/react-native-live-markdown#406

melvin-bot · 2024-06-28T02:11:27Z

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

roryabraham · 2024-06-28T02:11:47Z

No C+ review needed here.

melvin-bot · 2024-06-28T02:12:06Z

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

roryabraham · 2024-06-28T02:13:19Z

scripts/verifyPatches.sh

+
+# Run patch-package and capture its output and exit code
+TEMP_OUTPUT="$(mktemp)"
+npx patch-package --error-on-fail 2>&1 | tee "$TEMP_OUTPUT"


Using tee so that you can see the original output in the workflow

roryabraham · 2024-06-28T17:27:53Z

Reassure failure is a temporary issue (installing on an older version of the code that has warnings on patch-package). I think we can ignore it

AndrewGable · 2024-07-01T17:43:24Z

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

OSBotify · 2024-07-01T17:56: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-07-03T20:02:51Z

🚀 Deployed to staging by https://github.com/AndrewGable in version: 9.0.4-0 🚀

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

OSBotify · 2024-07-04T22:15:18Z

🚀 Cherry-picked to staging by https://github.com/tgolen in version: 9.0.4-5 🚀

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

OSBotify · 2024-07-10T11:03:59Z

🚀 Deployed to production by https://github.com/Julesssss in version: 9.0.5-13 🚀

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

OSBotify · 2024-07-15T20:22:26Z

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.6-8 🚀

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

roryabraham · 2024-07-18T14:48:30Z

I definitely linked the wrong issue here 😅

Add verifyPatches PR check

49d875b

roryabraham self-assigned this Jun 28, 2024

roryabraham added 4 commits June 27, 2024 18:44

Preserve output

5187fe6

Update version number in react-native-live-markdown patch

e37a91d

Fix funky patch name in react-native-keyboard-controller

bf2b11b

Correctly preserve exit status using PIPESTATUS

1845b09

roryabraham commented Jun 28, 2024

View reviewed changes

roryabraham changed the title ~~[WIP] [No QA] Add verifyPatches PR check~~ [No QA] Add verifyPatches PR check Jun 28, 2024

roryabraham marked this pull request as ready for review June 28, 2024 02:11

roryabraham requested a review from a team as a code owner June 28, 2024 02:11

melvin-bot bot requested review from parasharrajat and removed request for a team June 28, 2024 02:11

roryabraham requested review from a team and removed request for parasharrajat June 28, 2024 02:11

melvin-bot bot removed the request for review from a team June 28, 2024 02:12

melvin-bot bot requested a review from parasharrajat June 28, 2024 02:12

roryabraham removed the request for review from parasharrajat June 28, 2024 02:12

roryabraham commented Jun 28, 2024

View reviewed changes

roryabraham requested a review from AndrewGable June 28, 2024 02:14

roryabraham added 6 commits June 28, 2024 08:56

Preserve colorization in output

7b9ceef

Rename script to applyPatches and remove the PR check

526f18f

Check for a more generic warning message

502b380

Improve comments

54ebd8b

Run applyPatches in postInstall

197d68a

Pet peeve: add newline to output

cd6b97d

roryabraham changed the title ~~[No QA] Add verifyPatches PR check~~ [No QA] Fail patch-package on errors or warnings Jun 28, 2024

roryabraham added 2 commits June 28, 2024 09:50

Fail postInstall if any command fails

debcf7a

Add comment

84585b6

fabioh8010 approved these changes Jun 28, 2024

View reviewed changes

fabioh8010 mentioned this pull request Jun 28, 2024

[No QA] Make postInstall.sh script fail if any of its commands exits with a non-zero status #44602

Closed

50 tasks

AndrewGable approved these changes Jul 1, 2024

View reviewed changes

AndrewGable merged commit 9cb7543 into main Jul 1, 2024

AndrewGable deleted the Rory-VerifyPatches branch July 1, 2024 17:48

AndrewGable mentioned this pull request Jul 1, 2024

Revert "[No QA] Fail patch-package on errors or warnings" #44704

Merged

ikevin127 mentioned this pull request Jul 1, 2024

Update copy based on accounting integration #44691

Merged

50 tasks

github-actions bot mentioned this pull request Jul 3, 2024

Deploy Checklist: New Expensify 2024-07-03 #44782

Closed

roryabraham mentioned this pull request Jul 9, 2024

[No QA] Fail patch-package on errors or warnings (round 2) #45098

Merged

50 tasks

melvin-bot bot mentioned this pull request Jul 10, 2024

[HOLD for payment 2024-07-22] [HOLD for payment 2024-07-17] Context Menu and hover menu is visible on message being Edited #3677

Closed

Conversation

roryabraham commented Jun 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

roryabraham Jun 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

roryabraham Jun 28, 2024

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Jun 28, 2024

Uh oh!

roryabraham commented Jun 28, 2024

Uh oh!

melvin-bot bot commented Jun 28, 2024

Uh oh!

roryabraham Jun 28, 2024

Choose a reason for hiding this comment

Uh oh!

roryabraham commented Jun 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AndrewGable commented Jul 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

OSBotify commented Jul 1, 2024

Uh oh!

OSBotify commented Jul 3, 2024

Uh oh!

OSBotify commented Jul 4, 2024

Uh oh!

OSBotify commented Jul 10, 2024

Uh oh!

OSBotify commented Jul 15, 2024

Uh oh!

roryabraham commented Jul 18, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

roryabraham commented Jun 28, 2024 •

edited

Loading

roryabraham Jun 28, 2024 •

edited

Loading

roryabraham commented Jun 28, 2024 •

edited

Loading

AndrewGable commented Jul 1, 2024 •

edited

Loading