Skip to content
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

Refactor PLAID_DATA and fix plaid bankAccounts selector #11750

Merged
merged 11 commits into from
Oct 13, 2022

Conversation

nkuoch
Copy link
Contributor

@nkuoch nkuoch commented Oct 12, 2022

Details

  • Some views where unnecessarily re-rendering because too many "independent" things where stored in PLAID_DATA.
  • There was a placeholder to plaid bank account selectors, which value (undefined) was somehow passed when selecting another item, due to multiple simultaneous re-rendering.
  • So, now I made sure only useful data where stored, in appropriate places

Fixed Issues

$ #11554
$ #11769

Tests

  • Test adding a personal bank account
  • Test adding a VBBA
  • Verify that no errors appear in the JS console

PR Review Checklist

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 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 included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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
  • 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 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.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

PR Reviewer Checklist

The reviewer will copy/paste it into a new comment and complete it after the author checklist is completed

  • 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 verified tests pass on all platforms & I tested again on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

QA Steps

  • Test adding a personal bank account
  • Test adding a VBBA
  • Verify that no errors appear in the JS console

Screenshots

Web

Add a personal bank account via Plaid

2022-10-12_21-35-54.mp4

Add a VBBA via Plaid. Make sure no error occurs

vbba.mp4

Mobile Web - Chrome

Screen.Recording.2022-10-12.at.20.27.03.mov

Mobile Web - Safari

Kapture.2022-10-12.at.16.19.05.mp4

Desktop

Kapture.2022-10-12.at.16.24.13.mp4

iOS

Kapture.2022-10-12.at.17.02.47.mp4

Android

Kapture.2022-10-12.at.17.47.30.mp4

@nkuoch nkuoch self-assigned this Oct 12, 2022
@nkuoch nkuoch changed the title Move isPlaidDisabled to a separate Onyx key to avoid rerendering unne… Move isPlaidDisabled to a separate Onyx key to avoid rerendering unnecessarily when other attributes of PLAID_DATA change Oct 12, 2022
@nkuoch nkuoch force-pushed the nat-isPlaidDisabled branch 2 times, most recently from 418f4f0 to b34d8c6 Compare October 12, 2022 09:39
…cessarily when other attributes of PLAID_DATA change
@nkuoch nkuoch force-pushed the nat-isPlaidDisabled branch from b34d8c6 to ee52b44 Compare October 12, 2022 10:02
@nkuoch nkuoch changed the title Move isPlaidDisabled to a separate Onyx key to avoid rerendering unnecessarily when other attributes of PLAID_DATA change Refactor PLAID_DATA Oct 12, 2022
Copy link
Contributor

@MariaHCD MariaHCD left a comment

Choose a reason for hiding this comment

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

I think the proposals being discussed here are probably related and would conflict with this PR.

@@ -116,9 +113,12 @@ class AddPlaidBankAccount extends React.Component {
*/
selectAccount(plaidAccountID) {
const selectedPlaidBankAccount = _.findWhere(this.getPlaidBankAccounts(), {plaidAccountID});
if (!selectedPlaidBankAccount) {
Copy link
Contributor

@MariaHCD MariaHCD Oct 12, 2022

Choose a reason for hiding this comment

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

Do we know why the selectedPlaidBankAccount can be undefined/null value here? When testing locally (on main) I started running into this error:

Screen Shot 2022-10-11 at 5 44 52 PM

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yep, it was a mix of several things that I fixed in this PR. Not it can't be undefined anymore.

@nkuoch nkuoch changed the title Refactor PLAID_DATA Refactor PLAID_DATA and fix plaid bankAccounts selector Oct 12, 2022
@nkuoch nkuoch force-pushed the nat-isPlaidDisabled branch from a291186 to 4a298ca Compare October 12, 2022 19:05
@nkuoch nkuoch marked this pull request as ready for review October 12, 2022 19:17
@nkuoch nkuoch requested a review from a team as a code owner October 12, 2022 19:17
@nkuoch nkuoch requested review from MariaHCD and removed request for a team October 12, 2022 19:17
@melvin-bot melvin-bot bot requested a review from marcochavezf October 12, 2022 19:17
@nkuoch nkuoch force-pushed the nat-isPlaidDisabled branch 2 times, most recently from 4f1aa9e to 5f0722f Compare October 12, 2022 19:48
@github-actions
Copy link
Contributor

⚠️ ⚠️ Heads up! This pull request has the CP Staging label. ⚠️ ⚠️
Merging it will cause it to be immediately deployed to staging, even if the open StagingDeployCash deploy checklist is locked.

@yuwenmemon yuwenmemon self-assigned this Oct 12, 2022
@marcochavezf
Copy link
Contributor

marcochavezf commented Oct 12, 2022

Review in progress:

  • 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:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots

Web

Add a PBA (Plaid)

Screen.Recording.2022-10-12.at.16.28.12.mov

Add a VBA (Plaid)

Screen Shot 2022-10-12 at 17 11 19

Mobile Web - Chrome

Screen.Recording.2022-10-12.at.20.27.03.mov

Mobile Web - Safari

Screen Shot 2022-10-12 at 20 44 26

Screen Shot 2022-10-12 at 20 46 49

Desktop

Screen Shot 2022-10-12 at 20 52 45

iOS

Screen.Recording.2022-10-12.at.20.38.05.mov

Android

Screen.Recording.2022-10-12.at.20.19.54.mov

@yuwenmemon
Copy link
Contributor

@marcochavezf Updated!

@marcochavezf
Copy link
Contributor

I checked that screenshots or videos are included for tests on all platforms

@yuwenmemon I think we (author and reviewer) now should add the screenshots for all platforms

@yuwenmemon
Copy link
Contributor

I'll add screenshots

@yuwenmemon
Copy link
Contributor

Added!

@@ -26,6 +26,8 @@ const propTypes = {
/** Contains plaid data */
plaidData: plaidDataPropTypes,

selectedPlaidAccountID: PropTypes.string,
Copy link
Contributor

Choose a reason for hiding this comment

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

The reviewer checklist says that all props are defined accurately and each prop has a /** comment above it */, although it's under _ If a new component is created I verified that:_ so not sure if this should be a blocker or not

Copy link
Contributor

Choose a reason for hiding this comment

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

Good catch, we should probably still do that.

@@ -31,6 +31,7 @@ const propTypes = {
error: PropTypes.string,
shouldShowSuccess: PropTypes.bool,
isLoading: PropTypes.bool,
plaidAccountID: PropTypes.string,
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe all these need to be documented too

@@ -76,7 +78,11 @@ class AddPersonalBankAccountPage extends React.Component {
* @param {Object} values - form input values passed by the Form component
Copy link
Contributor

Choose a reason for hiding this comment

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

NAB since this wasn't modified in this PR and I'm not sure if all these are mandatory, the JSDocs style guide says to Document object parameters with separate lines e.g. @param {Object} parameters followed by @param {String} parameters.field

@marcochavezf
Copy link
Contributor

Tested both flows (PBA and VBA) on every platform, added the screenshots and videos in this comment.

@marcochavezf
Copy link
Contributor

marcochavezf commented Oct 13, 2022

I checked that screenshots or videos are included for tests on all platforms

There's a missing screenshot for the Mobile Web - Chrome platform, but I'm checking off this point ^ since I tested it locally and looks good.

Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

LGTM. I left a clean up comment and I think the test steps could be more descriptive.

});
plaidAccessToken: this.props.plaidData.plaidAccessToken,
};
ReimbursementAccount.updateReimbursementAccountDraft(bankAccountData);
Copy link
Contributor

Choose a reason for hiding this comment

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

NAB we can clean this up later, but I don't think that we need this since Form automatically updates the draft data if we pass shouldSaveDraft to each input

Suggested change
ReimbursementAccount.updateReimbursementAccountDraft(bankAccountData);
ReimbursementAccount.updateReimbursementAccountDraft(bankAccountData);

Copy link
Contributor

Choose a reason for hiding this comment

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

Okay, cc @nkuoch and @MariaHCD so you're aware. You're saying that we could just remove this as long as we pass shouldSaveDraft to each form component below, yeah?

@yuwenmemon yuwenmemon merged commit 6f0d806 into main Oct 13, 2022
@yuwenmemon yuwenmemon deleted the nat-isPlaidDisabled branch October 13, 2022 03:50
OSBotify pushed a commit that referenced this pull request Oct 13, 2022
Refactor PLAID_DATA and fix plaid bankAccounts selector

(cherry picked from commit 6f0d806)
OSBotify added a commit that referenced this pull request Oct 13, 2022
@OSBotify
Copy link
Contributor

🚀 Cherry-picked to staging by @yuwenmemon in version: 1.2.13-5 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

@OSBotify
Copy link
Contributor

🚀 Deployed to production by @yuwenmemon in version: 1.2.13-5 🚀

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

@OSBotify
Copy link
Contributor

🚀 Cherry-picked to staging by https://github.com/AndrewGable in version: 1.3.28-2 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants