[No QA] Fix broken lint #20488

roryabraham · 2023-06-09T00:49:23Z

Details

Fixes broken lint: https://expensify.slack.com/archives/C03V9A4TB/p1686263208777909

Fixed Issues

$ n/a

Tests

Merge this PR despite failing lint
Re-run PR checks on this unrelated PR: Clean up custom status bar implementation #20487
They should pass

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

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 / Chrome
- iOS / native
- iOS / 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 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(themeColors.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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

melvin-bot · 2023-06-09T00:49:27Z

npm has a package.json file and a package-lock.json file. It seems you updated one without the other, which is usually a sign of a mistake. If you are updating a package make sure that you update the version in package.json then run npm install

melvin-bot · 2023-06-09T00:49:52Z

@youssef-lr 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 · 2023-06-09T00:51:15Z

.github/actions/composite/setupNode/action.yml

@@ -30,11 +30,7 @@ runs:
      with:
        timeout_minutes: 30
        max_attempts: 3
-        command: npm ci --ignore-scripts


--ignore-scripts was the root of the problem here because it skips scripts such as postinstall not only for our package.json but for the package.json of all our dependencies as well

chiragsalian · 2023-06-09T00:52: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 tests pass on all platforms & I tested again on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / 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(themeColors.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 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

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

roryabraham · 2023-06-09T00:52:57Z

scripts/postInstall.sh

+# Install node_modules in subpackages, unless we're in a CI/CD environment,
+# where the node_modules for subpackages are cached separately.
+# See `.github/actions/composite/setupNode/action.yml` for more context.
+if [[ -n ${CI+x} ]]; then


Source: https://stackoverflow.com/questions/3601515/how-to-check-if-a-variable-is-set-in-bash

roryabraham · 2023-06-09T00:53:08Z

scripts/postInstall.sh

+#!/bin/bash
+
+# Go to project root
+ROOT_DIR=$(dirname "$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &> /dev/null && pwd)")


Source: https://stackoverflow.com/questions/59895/how-do-i-get-the-directory-where-a-bash-script-is-located-from-within-the-script

roryabraham · 2023-06-09T00:57:51Z

Context on why lint and validate github actions are failing here. We have to merge this for the fix to take effect.

melvin-bot · 2023-06-09T00:58:44Z

npm has a package.json file and a package-lock.json file. It seems you updated one without the other, which is usually a sign of a mistake. If you are updating a package make sure that you update the version in package.json then run npm install

roryabraham · 2023-06-09T01:02:25Z

Merging this with failing tests. Not an emergency but there's also no way around it.

melvin-bot · 2023-06-09T01:02:33Z

@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 · 2023-06-09T01:09:35Z

✋ 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 · 2023-06-13T00:33:05Z

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

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

OSBotify · 2023-06-13T01:07:14Z

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

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

OSBotify · 2023-06-14T21:23:21Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.27-7 🚀

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

roryabraham added 3 commits June 8, 2023 17:46

Move postInstall script to a shell file

3d25bd0

Remove --ignore-scripts

ccaa717

Improve comment

f46335d

roryabraham requested a review from a team as a code owner June 9, 2023 00:49

roryabraham self-assigned this Jun 9, 2023

melvin-bot bot removed the request for review from a team June 9, 2023 00:49

melvin-bot bot requested a review from youssef-lr June 9, 2023 00:49

roryabraham commented Jun 9, 2023

View reviewed changes

chiragsalian approved these changes Jun 9, 2023

View reviewed changes

roryabraham commented Jun 9, 2023

View reviewed changes

roryabraham merged commit 26a2b39 into main Jun 9, 2023

roryabraham deleted the Rory-FixLint branch June 9, 2023 01:02

melvin-bot bot added the Emergency label Jun 9, 2023

roryabraham removed the Emergency label Jun 9, 2023

roryabraham mentioned this pull request Jun 9, 2023

[No QA] Cache node modules in GitHub Actions #20436

Merged

57 tasks

OSBotify mentioned this pull request Jun 12, 2023

Deploy Checklist: New Expensify 2023-06-12 #20640

Closed

71 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA] Fix broken lint #20488

[No QA] Fix broken lint #20488

roryabraham commented Jun 9, 2023 •

edited

Loading

melvin-bot bot commented Jun 9, 2023

melvin-bot bot commented Jun 9, 2023

roryabraham Jun 9, 2023 •

edited

Loading

chiragsalian commented Jun 9, 2023 •

edited

Loading

roryabraham Jun 9, 2023

roryabraham Jun 9, 2023

roryabraham commented Jun 9, 2023

melvin-bot bot commented Jun 9, 2023

roryabraham commented Jun 9, 2023

melvin-bot bot commented Jun 9, 2023

OSBotify commented Jun 9, 2023

OSBotify commented Jun 13, 2023

OSBotify commented Jun 13, 2023

OSBotify commented Jun 14, 2023

[No QA] Fix broken lint #20488

[No QA] Fix broken lint #20488

Conversation

roryabraham commented Jun 9, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 9, 2023

melvin-bot bot commented Jun 9, 2023

roryabraham Jun 9, 2023 • edited Loading

Choose a reason for hiding this comment

chiragsalian commented Jun 9, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

roryabraham Jun 9, 2023

Choose a reason for hiding this comment

roryabraham Jun 9, 2023

Choose a reason for hiding this comment

roryabraham commented Jun 9, 2023

melvin-bot bot commented Jun 9, 2023

roryabraham commented Jun 9, 2023

melvin-bot bot commented Jun 9, 2023

OSBotify commented Jun 9, 2023

OSBotify commented Jun 13, 2023

OSBotify commented Jun 13, 2023

OSBotify commented Jun 14, 2023

roryabraham commented Jun 9, 2023 •

edited

Loading

roryabraham Jun 9, 2023 •

edited

Loading

chiragsalian commented Jun 9, 2023 •

edited

Loading