Skip to content

[PropTypes / Default Props] Modify components to be compatible with new Onyx Lint rule #15590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 34 commits into from
Mar 23, 2023
Merged

[PropTypes / Default Props] Modify components to be compatible with new Onyx Lint rule #15590

merged 34 commits into from
Mar 23, 2023

Conversation

Prince-Mendiratta
Copy link
Contributor

Details

With this PR, we are bumping eslint-config-expensify to v2.0.31, to add the use of the new lint rule that checks and insists that any props originating from withOnyx should be optional and a default value should be provided.

This PR also modifies the existing components using the withOnyx HOC so that the above mentioned code style is followed.

Related PR: Expensify/eslint-config-expensify#58, more details there and in the proposal.

Fixed Issues

$ #14309
PROPOSAL: #14309 (comment)

Tests

The list of components affected by this PR are listed below, a total of 55 files, 51 components:

BaseAnchorForAttachmentsOnly
ArchivedReportFooter
DeeplinkWrapper/index.website
EmojiPicker/EmojiPickerMenu/index
EmojiPicker/EmojiPickerMenu/index.native
IOUBadge
IOUConfirmationList
kycWallPropTypes
IOUPreview
ReportWelcomeText
SettlementButton
createOnyxContext
withCurrentUserPersonalDetails
AuthScreens
ConciergePage
DetailsPage
OnfidoPrivacy
TermsStep
GetAssistancePage
LogOutPreviousUserPage
NewChatPage
BankAccountStep
CompanyStep
EnableStep
ReimbursementAccountPage
RequestorOnfidoStep
ReportDetailsPage
ReportParticipantsPage
ReportSettingsPage
RequestCallPage
SearchPage
ValidateLoginPage
HeaderView
ReportScreen
IOUDetailsModal
IOUModal
IOUAmountPage
IOUParticipantsRequest
IOUParticipantsSplit
InitialSettingsPage
paymentsPagePropTypes
PriorityModePage
CloseAccountPage
ResendValidationForm
WalletStatementPage
WorkspaceInitialPage
WorkspaceInvitePage
WorkspaceMembersPage
WorkspaceNewRoomPage
WorkspaceSettingsPage
WorkspaceBillsFirstSection
WorkspaceCardVBANoECardView
SidebarLinks

Each of these need to be navigated to ensure that no console errors are thrown.

Also, to test the rule itself a sample new component can be added making use of the withOnyx HOC and ensure that no error is thrown if the coding style is followed correctly.

  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

All the components mentioned above need to be navigated to and ensure no console errors are thrown.

  • 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 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 correct English and 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 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

N/A

@Prince-Mendiratta Prince-Mendiratta requested a review from a team as a code owner March 1, 2023 09:45
@melvin-bot melvin-bot bot requested review from grgia and mollfpr and removed request for a team March 1, 2023 09:45
@MelvinBot
Copy link

@grgia @mollfpr One of you needs to 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]

Copy link
Contributor Author

@Prince-Mendiratta Prince-Mendiratta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have added a few places where some extra attention / verification might be required, please resolve these too!

@@ -83,7 +87,7 @@ class WalletStatementPage extends React.Component {
}

render() {
moment.locale(lodashGet(this.props, 'preferredLocale', 'en'));
moment.locale(this.props.preferredLocale);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this alright? Had to do this to avoid the 'unused prop' error.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is the preferredLocale prop being added here?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Based on the comment from the code added, it's used to change the modal title according to the current locale.

@mollfpr
Copy link
Contributor

mollfpr commented Mar 5, 2023

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 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 correct English and 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 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


/** Session of currently logged in user */
session: PropTypes.shape({
email: PropTypes.string.isRequired,
}).isRequired,
}),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Prince-Mendiratta It's weird that the session is not detected as unused if it has a shape type but detected as unused if objectOf.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mollfpr That is super interesting, changing PropTypes.shape to PropTypes.objectOf reveals a big bunch of unused props across the app.

Copy link
Contributor Author

@Prince-Mendiratta Prince-Mendiratta Mar 5, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are around 20 such cases.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

redundant prop, removed.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Prince-Mendiratta Yeah, but it is not part of your lint so let it slide for now.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@grgia Maybe we can create another issue to deal with removing unused Onyx keys and props across the app?

email: null,
},
chatReport: {
participants: [],
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is the default value only participants and the type for chatReport is only reportID?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm unsure what to do here, do we add participants to propTypes or reportID to defaultProps? The other instance for a similar component is:

https://github.com/Expensify/App/blob/main/src/components/ReportActionItem/IOUAction.js

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, let's just fix what the lint complains about.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not clear either what the function needs from the report data. I'll take a look deeper into this.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Prince-Mendiratta, we need all the keys from chatReport. For example, getPayMoneyRequestParams is updating the report data.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mollfpr I'm not too sure about the keys required in the chatReport, is this all?

    /** chatReport associated with iouReport */
    chatReport: PropTypes.shape({
        /** Report ID associated with the transaction */
        reportID: PropTypes.string,

        /** The participants of this report */
        participants: PropTypes.arrayOf(PropTypes.string),

        /** Whether the chat report has an outstanding IOU */
        hasOutstandingIOU: PropTypes.bool.isRequired,
    }),

Copy link
Contributor

@mollfpr mollfpr Mar 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@grgia Any suggestion on what we should put for the chatReport type?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Prince-Mendiratta At this moment, we can use the above snippet code.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mollfpr cool, updated.

@mollfpr
Copy link
Contributor

mollfpr commented Mar 6, 2023

@Prince-Mendiratta We have a conflict.

@grgia
Copy link
Contributor

grgia commented Mar 20, 2023

@Prince-Mendiratta @mollfpr how can I best help here? Are all of the mentioned issues not reproducible locally? Maybe I need to trigger a fresh build? Or if tests are working well we can talk about a plan for final review and merge

@mollfpr
Copy link
Contributor

mollfpr commented Mar 21, 2023

#15590 (comment) This issue only reproduces if the domain is not staging.new.expensify.com.

Screen.Recording.2023-03-21.at.19.28.20.mov

I tried running the web on the latest main with ngrok and got the issue. You can use the deep link on DEV with the domain staging.new.expensify.com or new.expensify.com.

@mollfpr
Copy link
Contributor

mollfpr commented Mar 21, 2023

#15590 (comment) Still not able to reproduce it in DEV. @grgia @Prince-Mendiratta any idea?

Here's the error from the https://15590.pr-testing.expensify.com/

Screenshot 2023-03-21 at 19 36 43

@grgia
Copy link
Contributor

grgia commented Mar 22, 2023

@mollfpr Did you update/merge main on DEV? If so then perhaps the build URL is outdated?

@Prince-Mendiratta
Copy link
Contributor Author

@grgia I tried to reproduce this by merging the PR with upstream main branch, was still not able to reproduce either of the 2 issues on dev.

I assume that both these issues are related to the testing domain https://15590.pr-testing.expensify.com itself, since both the redirection issue and uploading a file issue are impacted by domain checks.

cc @mollfpr

@grgia
Copy link
Contributor

grgia commented Mar 23, 2023

@mollfpr @Prince-Mendiratta how do you feel about merging the conflict and then merging this? It seems like besides the URL tests, it tests fairly well? Have we addressed all the outstanding errors we encountered?

Signed-off-by: Prince Mendiratta <[email protected]>
Signed-off-by: Prince Mendiratta <[email protected]>
@Prince-Mendiratta
Copy link
Contributor Author

@grgia Looks like we are good to go!

cc @mollfpr

@mollfpr
Copy link
Contributor

mollfpr commented Mar 23, 2023

@grgia I think it's safe to merge it; some of the concerns about the change have already been addressed and resolved it. The above issues are most likely due to the domain.

@mollfpr
Copy link
Contributor

mollfpr commented Mar 23, 2023

@Prince-Mendiratta Could you resolve this lint error?

Screenshot 2023-03-23 at 21 04 12

Signed-off-by: Prince Mendiratta <[email protected]>
@Prince-Mendiratta
Copy link
Contributor Author

@mollfpr Resolved!

mollfpr
mollfpr previously approved these changes Mar 23, 2023
Copy link
Contributor

@mollfpr mollfpr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@grgia I'll approve this in case you want to merge it.

@mollfpr
Copy link
Contributor

mollfpr commented Mar 23, 2023

@Prince-Mendiratta another conflict 🤣

Signed-off-by: Prince Mendiratta <[email protected]>
@Prince-Mendiratta
Copy link
Contributor Author

@mollfpr resolved!

I swear it's almost as if each time a new PR is merged on main, a conflict arises here haha 🥲

Signed-off-by: Prince Mendiratta <[email protected]>
Copy link
Contributor

@grgia grgia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mollfpr I think this is safe to merge as well. Our best bet is going to be regression tests. I am going to merge this to prevent more conflicts.

@grgia grgia merged commit 51ce2b3 into Expensify:main Mar 23, 2023
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

🚀 Deployed to staging by https://github.com/grgia in version: 1.2.89-0 🚀

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

@mvtglobally
Copy link

@Prince-Mendiratta @mollfpr @roryabraham Can you validate this internally? We are not able to easily identify each component

@luacmartins
Copy link
Contributor

I validated this and it seems to be working well.

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 1.2.89-0 🚀

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

@Prince-Mendiratta Prince-Mendiratta deleted the onyx-props-eslint branch March 27, 2023 10:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants