[No QA] fix for eslint bug #15261 #22597

HLEDYA · 2023-07-10T23:21:18Z

Details

Only the last restricted import from the same path is checked and others are ignored when there are multiple imports due to the eslint bug

Fixed Issues

$ #22459
PROPOSAL: #22459 (comment)

Tests

open a random component file such as src/components/AddressSearch/index.js
at the top of the file, import one of the following packages from react-native
- useWindowDimensions
- TouchableOpacity
- TouchableWithoutFeedback
- TouchableNativeFeedback
- TouchableHighlight
- StatusBar
for each imported component above, see an eslint error appears in VS Code if ESLint extension is added (a hint for error is shown when hovering mouse over the imported component.)

Verify that no errors appear in the JS console

Offline tests

Same steps above

QA Steps

Same steps above

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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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

Since it is not a UI issue, no ui screenshots are added. Eslint gives console error when a restricted component is used as shown in the following:

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

melvin-bot · 2023-07-10T23:21:23Z

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

github-actions · 2023-07-10T23:21:32Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

HLEDYA · 2023-07-11T00:07:02Z

I have read the CLA Document and I hereby sign the CLA

…22459

allroundexperts · 2023-07-11T10:30:06Z

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.

Screen.Recording.2023-07-11.at.10.08.28.PM.mov

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

blazejkustra · 2023-07-11T13:03:38Z

.eslintrc.js

+                  {
+                    name: 'react-native',
+                    importNames: ['useWindowDimensions', 'StatusBar', 'TouchableOpacity', 'TouchableWithoutFeedback', 'TouchableNativeFeedback', 'TouchableHighlight'],
+                    message: `If you're using following components from react native:\n


NAB: I find this format is more readable:

message: [ "For 'useWindowDimensions', please use 'src/hooks/useWindowDimensions' instead.", "For 'TouchableOpacity', 'TouchableWithoutFeedback', 'TouchableNativeFeedback', 'TouchableHighlight', please use 'PressableWithFeedback' and/or 'PressableWithoutFeedback' from 'src/components/Pressable' instead.", "For 'StatusBar', please use 'src/libs/StatusBar' instead.", ].join('\n'),

Hi @blazejkustra, I edited the message format as you suggested. But I think adding one more new line at top, makes it more readable. So, in VS code the final result seems like the following:

Thank you for your advice.

allroundexperts · 2023-07-11T17:06:59Z

.eslintrc.js

+              paths: [
+                  {
+                    name: 'react-native',
+                    importNames: ['useWindowDimensions', 'StatusBar', 'TouchableOpacity', 'TouchableWithoutFeedback', 'TouchableNativeFeedback', 'TouchableHighlight'],


I think you missed to include Pressable?

thanks @allroundexperts you're right, my mistake.

allroundexperts

One minor change needed.

roryabraham · 2023-07-11T18:11:26Z

looks like there's a prettier diff that needs to be committed

allroundexperts · 2023-07-11T18:24:11Z

@HLEDYA Can you please fix the lint error?

HLEDYA · 2023-07-11T20:35:23Z

@roryabraham, @allroundexperts: sorry guys

allroundexperts · 2023-07-11T20:37:05Z

@roryabraham, @allroundexperts: sorry guys

No worries. I usually run npm run prettier before committing. This resolves the prettier issues.

allroundexperts · 2023-07-12T18:17:23Z

Hi @roryabraham!
Can you please run the workflows again?

roryabraham · 2023-07-13T00:47:52Z

FWIW I have my editor configured to run prettier whenever I save. It's pretty easy to set up that way and then I never think about formatting my code. Just type and press CMD+S and everything's formatted correctly.

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

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

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

OSBotify · 2023-07-13T02:15:10Z

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

mvtglobally · 2023-07-13T03:02:23Z

@HLEDYA @allroundexperts @roryabraham Can you pls QA this internally?

roryabraham · 2023-07-13T03:53:51Z

@mvtglobally this should have been marked as No QA, we're good to go here.

HLEDYA · 2023-07-13T04:46:29Z

FWIW I have my editor configured to run prettier whenever I save. It's pretty easy to set up that way and then I never think about formatting my code. Just type and press CMD+S and everything's formatted correctly.

Thank you @roryabraham, I also enabled format on save for my VS code ide.

OSBotify · 2023-07-14T14:44:02Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.40-5 🚀

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

fix for eslint bug Expensify#15261

408283b

HLEDYA requested a review from a team as a code owner July 10, 2023 23:21

melvin-bot bot requested review from allroundexperts and removed request for a team July 10, 2023 23:21

Merge branch 'main' into fix-eslint-restricted-imports-bug-22459

25adbba

Merge branch 'Expensify:main' into fix-eslint-restricted-imports-bug-…

cfb417f

…22459

blazejkustra reviewed Jul 11, 2023

View reviewed changes

HLEDYA added 2 commits July 11, 2023 18:50

restricted react-native import message format updated

49a0ac0

message format updated

052d400

blazejkustra approved these changes Jul 11, 2023

View reviewed changes

This comment was marked as outdated.

Sign in to view

allroundexperts reviewed Jul 11, 2023

View reviewed changes

allroundexperts suggested changes Jul 11, 2023

View reviewed changes

Pressable is re-added to the restricted importNames

e05852d

allroundexperts approved these changes Jul 11, 2023

View reviewed changes

melvin-bot bot requested a review from roryabraham July 11, 2023 17:50

roryabraham previously approved these changes Jul 11, 2023

View reviewed changes

fix for prettier error

c786bea

HLEDYA dismissed roryabraham’s stale review via c786bea July 11, 2023 20:27

roryabraham approved these changes Jul 13, 2023

View reviewed changes

roryabraham merged commit 0ff9549 into Expensify:main Jul 13, 2023

OSBotify mentioned this pull request Jul 13, 2023

Deploy Checklist: New Expensify 2023-07-13 #22783

Closed

53 tasks

roryabraham changed the title ~~fix for eslint bug #15261~~ [No QA] fix for eslint bug #15261 Jul 13, 2023

melvin-bot bot mentioned this pull request Jul 14, 2023

[HOLD for payment 2023-07-21] [$1000] Fix upstream ESLint bug #22459

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA] fix for eslint bug #15261 #22597

[No QA] fix for eslint bug #15261 #22597

HLEDYA commented Jul 10, 2023

melvin-bot bot commented Jul 10, 2023

github-actions bot commented Jul 10, 2023 •

edited

Loading

HLEDYA commented Jul 11, 2023

allroundexperts commented Jul 11, 2023 •

edited

Loading

blazejkustra Jul 11, 2023 •

edited

Loading

HLEDYA Jul 11, 2023

This comment was marked as outdated.

allroundexperts Jul 11, 2023

HLEDYA Jul 11, 2023

allroundexperts left a comment

roryabraham commented Jul 11, 2023

allroundexperts commented Jul 11, 2023

HLEDYA commented Jul 11, 2023

allroundexperts commented Jul 11, 2023

allroundexperts commented Jul 12, 2023

roryabraham commented Jul 13, 2023

OSBotify commented Jul 13, 2023

OSBotify commented Jul 13, 2023

mvtglobally commented Jul 13, 2023

roryabraham commented Jul 13, 2023

HLEDYA commented Jul 13, 2023

OSBotify commented Jul 14, 2023

[No QA] fix for eslint bug #15261 #22597

[No QA] fix for eslint bug #15261 #22597

Conversation

HLEDYA commented Jul 10, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 10, 2023

github-actions bot commented Jul 10, 2023 • edited Loading

HLEDYA commented Jul 11, 2023

allroundexperts commented Jul 11, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

blazejkustra Jul 11, 2023 • edited Loading

Choose a reason for hiding this comment

HLEDYA Jul 11, 2023

Choose a reason for hiding this comment

This comment was marked as outdated.

allroundexperts Jul 11, 2023

Choose a reason for hiding this comment

HLEDYA Jul 11, 2023

Choose a reason for hiding this comment

allroundexperts left a comment

Choose a reason for hiding this comment

roryabraham commented Jul 11, 2023

allroundexperts commented Jul 11, 2023

HLEDYA commented Jul 11, 2023

allroundexperts commented Jul 11, 2023

allroundexperts commented Jul 12, 2023

roryabraham commented Jul 13, 2023

OSBotify commented Jul 13, 2023

OSBotify commented Jul 13, 2023

mvtglobally commented Jul 13, 2023

roryabraham commented Jul 13, 2023

HLEDYA commented Jul 13, 2023

OSBotify commented Jul 14, 2023

github-actions bot commented Jul 10, 2023 •

edited

Loading

allroundexperts commented Jul 11, 2023 •

edited

Loading

blazejkustra Jul 11, 2023 •

edited

Loading