[No QA] Include newest version of eslint-config-expensify with new rule of no-multiple-onyx-in-file #27840

studentofcoding · 2023-09-20T08:29:11Z

Details

ESLint Rules extend - Create an ESLint rule to detect multiple uses of withOnyx

This change only affects local development and does not need to be QAed and Affected files (MoneyRequestConfirmPage.js, MoneyRequestTagPage.js, EditRequestPage.js, and OptionRowLHNData.js) would have // eslint-disable-next-line right now & would be fixed separately on Another issue after the PR is merged, based on our last discussion here

Fixed Issues

$ #27463
PROPOSAL: #27463 (comment)

Tests

Check that we have the correct version of "eslint-config-expensify": "^2.0.39", and re-install the Project (better if we do a clean install)

Search withOnyx({ on your code editor and click project with more than 1 withOnyx({ like on src/components/LHNOptionsList/OptionRowLHNData.js below

App/src/components/LHNOptionsList/OptionRowLHNData.js

Lines 182 to 217 in 70e9fa0

    
           withOnyx({ 
        
               fullReport: { 
        
                   key: (props) => ONYXKEYS.COLLECTION.REPORT + props.reportID, 
        
               }, 
        
               reportActions: { 
        
                   key: ({reportID}) => `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${reportID}`, 
        
                   canEvict: false, 
        
               }, 
        
               personalDetails: { 
        
                   key: ONYXKEYS.PERSONAL_DETAILS_LIST, 
        
                   selector: personalDetailsSelector, 
        
               }, 
        
               preferredLocale: { 
        
                   key: ONYXKEYS.NVP_PREFERRED_LOCALE, 
        
               }, 
        
           }), 
        
           withOnyx({ 
        
               parentReportActions: { 
        
                   key: ({fullReport}) => `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${fullReport.parentReportID}`, 
        
                   canEvict: false, 
        
               }, 
        
               policy: { 
        
                   key: ({fullReport}) => `${ONYXKEYS.COLLECTION.POLICY}${fullReport.policyID}`, 
        
               }, 
        
               // Ideally, we aim to access only the last transaction for the current report by listening to changes in reportActions. 
        
               // In some scenarios, a transaction might be created after reportActions have been modified. 
        
               // This can lead to situations where `lastTransaction` doesn't update and retains the previous value. 
        
               // However, performance overhead of this is minimized by using memos inside the component. 
        
               receiptTransactions: {key: ONYXKEYS.COLLECTION.TRANSACTION}, 
        
           }), 
        
           withOnyx({ 
        
               transaction: { 
        
                   key: ({fullReport, parentReportActions}) => 
        
                       `${ONYXKEYS.COLLECTION.TRANSACTION}${lodashGet(parentReportActions, [fullReport.parentReportActionID, 'originalMessage', 'IOUTransactionID'], '')}`, 
        
               }, 
        
           }),

We will see the error appearing as it has more than 1 withOnyx({

4. Also we can check the rule on another file that only have 1 `withOnyx({` and add another `withOnyx({` with random details and see that the error appear

Verify that no errors appear in the JS console

Offline tests

QA Steps

This change only affects local development and does not need to be QAed

Verify that no errors appear in the JS console

PR Author Checklist

cc: @neil-marcellini @mollfpr @tgolen

melvin-bot · 2023-09-21T04:14:46Z

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

…0.39

mollfpr · 2023-09-21T04:23:12Z

@studentofcoding I think you put the issue link wrong; that's why Melvin doesn't pull the correct engineer.

studentofcoding · 2023-09-21T04:25:52Z

27463

Hmm, It's included on the right Issue I believe @mollfpr ?

mollfpr · 2023-09-21T04:30:13Z

Yes, the link is correct, but you paste it wrong. You should only paste the link #27463, not 27463.

studentofcoding · 2023-09-21T04:34:41Z

Yes, the link is correct, but you paste it wrong. You should only paste the link #27463, not 27463.

Noted, It's edited, do I need to do anything else @mollfpr ?

mollfpr · 2023-09-21T04:36:08Z

@studentofcoding Nope, it looks good now! Just make sure you doing it right on the next PR 👍

studentofcoding · 2023-09-21T04:37:12Z

@studentofcoding Nope, it looks good now! Just make sure you doing it right on the next PR 👍

Yess, will do @mollfpr, thanks for pointing it out!

src/pages/iou/MoneyRequestTagPage.js

studentofcoding · 2023-09-21T04:59:40Z

Hey @cristipaval, This PR is a follow up PR for new eslint-config-expensiy, looking forward to your approval!

mollfpr · 2023-09-21T05:01:59Z

@studentofcoding Neil Is the one assigned to the issue. Also, the internal engineer will review after C+ approves the PR. So you can wait till that time before ping them again.

…rulesdir/no-multiple-onyx-in-file`

studentofcoding · 2023-09-21T05:31:05Z

@studentofcoding Neil Is the one assigned to the issue. Also, the internal engineer will review after C+ approves the PR. So you can wait till that time before ping them again.

Noted thanks!

tgolen

Looks great, thank you!

studentofcoding · 2023-09-21T06:13:04Z

Looks great, thank you!

Thank you too!

.eslintrc.js

studentofcoding · 2023-09-21T06:34:13Z

Please, kindly check, re-approve again @tgolen @mollfpr

mollfpr · 2023-09-21T06:34:20Z

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

mollfpr

LGTM and tests well 👍

melvin-bot · 2023-09-21T06:49:10Z

🎯 @mollfpr, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #27916.

studentofcoding · 2023-09-21T06:50:55Z

LGTM and tests well 👍

Thanks!

cristipaval · 2023-09-21T12:57:09Z

Merging, as @tgolen already approved this.

OSBotify · 2023-09-21T13:08:44Z

✋ 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-09-22T13:59:50Z

🚀 Deployed to staging by https://github.com/cristipaval in version: 1.3.73-0 🚀

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

OSBotify · 2023-09-25T09:34:41Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.73-1 🚀

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

OSBotify · 2023-09-25T10:06:42Z

🚀 Deployed to staging by https://github.com/cristipaval in version: 1.3.74-0 🚀

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

OSBotify · 2023-09-28T18:49:03Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.74-3 🚀

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

Include newest version of eslint-config-expensify = 2.0.39

00ddd45

studentofcoding changed the title ~~Include newest version of eslint-config-expensify with new rule of no-multiple-onyx-in-file~~ [No QA] Include newest version of eslint-config-expensify with new rule of no-multiple-onyx-in-file Sep 20, 2023

studentofcoding added 2 commits September 20, 2023 16:58

Add // eslint-disable-next-line for Affected files

b0dd5f6

Update package.json for eslint-config-expensify 2.0.39

74871ce

studentofcoding marked this pull request as ready for review September 21, 2023 04:14

studentofcoding requested a review from a team as a code owner September 21, 2023 04:14

melvin-bot bot removed the request for review from a team September 21, 2023 04:14

melvin-bot bot requested a review from cristipaval September 21, 2023 04:14

studentofcoding added 2 commits September 21, 2023 11:15

Merge branch 'main' into Add-rules-Handle-No-Multiple-Onyx-in-file

ea6425e

Revert package.json order after Update for eslint-config-expensify 2.…

6b70fff

…0.39

Update fix lint

e9435a9

studentofcoding mentioned this pull request Sep 21, 2023

[$500] Create an ESLint rule to detect multiple uses of withOnyx #27463

Closed

mollfpr reviewed Sep 21, 2023

View reviewed changes

src/pages/iou/MoneyRequestTagPage.js Outdated Show resolved Hide resolved

tgolen requested changes Sep 21, 2023

View reviewed changes

src/pages/iou/MoneyRequestTagPage.js Outdated Show resolved Hide resolved

src/pages/iou/MoneyRequestTagPage.js Outdated Show resolved Hide resolved

studentofcoding added 2 commits September 21, 2023 12:20

Revert added deleted withOnyx

6d9c795

Update // eslint-disable-next-line to `// eslint-disable-next-line …

9ebea36

…rulesdir/no-multiple-onyx-in-file`

studentofcoding requested review from tgolen and mollfpr September 21, 2023 05:31

tgolen previously approved these changes Sep 21, 2023

View reviewed changes

mollfpr reviewed Sep 21, 2023

View reviewed changes

.eslintrc.js Outdated Show resolved Hide resolved

Update .eslintrc.js

977e79d

studentofcoding dismissed tgolen’s stale review via 977e79d September 21, 2023 06:32

studentofcoding requested review from tgolen and mollfpr September 21, 2023 06:33

mollfpr approved these changes Sep 21, 2023

View reviewed changes

melvin-bot bot mentioned this pull request Sep 21, 2023

Payment issue for E/App PR#27840 #27916

Closed

cristipaval approved these changes Sep 21, 2023

View reviewed changes

cristipaval merged commit ee023d8 into Expensify:main Sep 21, 2023
13 of 15 checks passed

OSBotify mentioned this pull request Sep 22, 2023

Deploy Checklist: New Expensify 2023-09-22 #28013

Closed

96 tasks

This was referenced Sep 25, 2023

Deploy Checklist: New Expensify DUPE 2023-09-25 #28118

Closed

Deploy Checklist: New Expensify 2023-09-25 #28119

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA] Include newest version of eslint-config-expensify with new rule of no-multiple-onyx-in-file #27840

[No QA] Include newest version of eslint-config-expensify with new rule of no-multiple-onyx-in-file #27840

studentofcoding commented Sep 20, 2023 •

edited

Loading

melvin-bot bot commented Sep 21, 2023

mollfpr commented Sep 21, 2023

studentofcoding commented Sep 21, 2023

mollfpr commented Sep 21, 2023

studentofcoding commented Sep 21, 2023

mollfpr commented Sep 21, 2023

studentofcoding commented Sep 21, 2023

studentofcoding commented Sep 21, 2023

mollfpr commented Sep 21, 2023

studentofcoding commented Sep 21, 2023

tgolen left a comment

studentofcoding commented Sep 21, 2023

studentofcoding commented Sep 21, 2023

mollfpr commented Sep 21, 2023 •

edited

Loading

mollfpr left a comment

melvin-bot bot commented Sep 21, 2023

studentofcoding commented Sep 21, 2023

cristipaval commented Sep 21, 2023

OSBotify commented Sep 21, 2023

OSBotify commented Sep 22, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 28, 2023

	withOnyx({
	fullReport: {
	key: (props) => ONYXKEYS.COLLECTION.REPORT + props.reportID,
	},
	reportActions: {
	key: ({reportID}) => `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${reportID}`,
	canEvict: false,
	},
	personalDetails: {
	key: ONYXKEYS.PERSONAL_DETAILS_LIST,
	selector: personalDetailsSelector,
	},
	preferredLocale: {
	key: ONYXKEYS.NVP_PREFERRED_LOCALE,
	},
	}),
	withOnyx({
	parentReportActions: {
	key: ({fullReport}) => `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${fullReport.parentReportID}`,
	canEvict: false,
	},
	policy: {
	key: ({fullReport}) => `${ONYXKEYS.COLLECTION.POLICY}${fullReport.policyID}`,
	},
	// Ideally, we aim to access only the last transaction for the current report by listening to changes in reportActions.
	// In some scenarios, a transaction might be created after reportActions have been modified.
	// This can lead to situations where `lastTransaction` doesn't update and retains the previous value.
	// However, performance overhead of this is minimized by using memos inside the component.
	receiptTransactions: {key: ONYXKEYS.COLLECTION.TRANSACTION},
	}),
	withOnyx({
	transaction: {
	key: ({fullReport, parentReportActions}) =>
	`${ONYXKEYS.COLLECTION.TRANSACTION}${lodashGet(parentReportActions, [fullReport.parentReportActionID, 'originalMessage', 'IOUTransactionID'], '')}`,
	},
	}),

[No QA] Include newest version of eslint-config-expensify with new rule of no-multiple-onyx-in-file #27840

[No QA] Include newest version of eslint-config-expensify with new rule of no-multiple-onyx-in-file #27840

Conversation

studentofcoding commented Sep 20, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

melvin-bot bot commented Sep 21, 2023

mollfpr commented Sep 21, 2023

studentofcoding commented Sep 21, 2023

mollfpr commented Sep 21, 2023

studentofcoding commented Sep 21, 2023

mollfpr commented Sep 21, 2023

studentofcoding commented Sep 21, 2023

studentofcoding commented Sep 21, 2023

mollfpr commented Sep 21, 2023

studentofcoding commented Sep 21, 2023

tgolen left a comment

Choose a reason for hiding this comment

studentofcoding commented Sep 21, 2023

studentofcoding commented Sep 21, 2023

mollfpr commented Sep 21, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

mollfpr left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Sep 21, 2023

studentofcoding commented Sep 21, 2023

cristipaval commented Sep 21, 2023

OSBotify commented Sep 21, 2023

OSBotify commented Sep 22, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 28, 2023

studentofcoding commented Sep 20, 2023 •

edited

Loading

mollfpr commented Sep 21, 2023 •

edited

Loading