fix: console error on click of connect online with plaid button

[payal-lathidadiya]

Details

Fixed Issues

$ #22448
PROPOSAL: #21778 (comment)

Tests

1. Create workspace if not created
2. Click on Workspaces in setting in left panel
3. Choose Reimbursement
4. Click the Connect bank account button
5. Click the Connect online with Plaid
6. Verify that it redirect to plaid portal and no error is displayed in console.

• Verify that no errors appear in the JS console

Offline tests

QA Steps

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

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

[melvin-bot]

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

[allroundexperts]

@Santhosh-Sellavel This is yours!

[Santhosh-Sellavel]

Otherwise Looks good, tests well!

[Santhosh-Sellavel]

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

Screen.Recording.2023-07-09.at.11.29.49.PM.mov

Desktop

Screen.Recording.2023-07-09.at.11.42.58.PM.mov

iOS & Android

Screen.Recording.2023-07-09.at.11.30.58.PM.mov

[Santhosh-Sellavel]

LGTM, all yours @francoisl!

[melvin-bot]

We did not find an internal engineer to review this PR, trying to assign a random engineer to #22448 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

[hayata-suenaga]

Simple PR to remove useLocalize and bring back withLocalize LGTM 👍

just a question, why we cannot useLocalize?

@francoisl I'll wait until you have a chance to review since you were assigned to the migration PR that caused the regression

[Santhosh-Sellavel]

just a question, why we cannot useLocalize?

We can do that too, but we need to remove withLocalizeProptypes from StepPropTypes which is common to multiple pages. Maybe could have just omitted withLocalizeProptypes from StepPropTypes for this component alone.

[Santhosh-Sellavel]

Maybe could have just omitted withLocalizeProptypes from StepPropTypes for this component alone.

@payal-lathidadiya Can you just do that, Sorry for the back and forth!

[francoisl]

Yes, as far as I know, using the useLocalize hook is the preferred way moving forward. If possible, let's keep using that and the fix the issue with the extra prop types.

[Santhosh-Sellavel]

All yours @francoisl!

[payal-lathidadiya]

Maybe could have just omitted withLocalizeProptypes from StepPropTypes for this component alone.

@payal-lathidadiya Can you just do that, Sorry for the back and forth!

np. updated and pushed.

[payal-lathidadiya]

@Santhosh-Sellavel Post omitting withLocalizeProptypes from StepPropTypes, somehow ESLint is failing for rule onyx-props-must-have-default

Not sure what's cause of this. any idea?

[hayata-suenaga]

do we have to do ..._.omit(StepPropTypes, _.keys(withLocalizePropTypes)), in components that use useLocalize and StepProps?

[payal-lathidadiya]

do we have to do ..._.omit(StepPropTypes, _.keys(withLocalizePropTypes)), in components that use useLocalize and StepProps?

Yeah, since StepProps contains withLocalizePropTypes which is from HOC and If we replace use of withLocalize HOC with useLocalize hook, we'll have to omit those props injected from that HOC.

Else, it will result in console below errors (ref #22448)

[hayata-suenaga]

Should we remove withLocalizePropTypes from StepProps down the line once all components are migrated to function components?

[Santhosh-Sellavel]

Yes we would remove @hayata-suenaga

[hayata-suenaga]

okay thanks for explaining

I re-ran the lint job again by the way. it failed for some unknow reason

[payal-lathidadiya]

@hayata-suenaga @Santhosh-Sellavel
To unblock us for now, I'm planning to revert this fix to previous where we removed useLocalize hook and add back withLocalize HOC.
Let me know if you think otherwise or 👍

[Santhosh-Sellavel]

@francoisl On the other hand let's just do nothing here as it will be eventually removed. Thoughts.? Only 3 Pages left to refactor that uses StepProps. It doesn't affect anything!

[francoisl]

That could be an option. Are those 3 refactors in progress already or still on hold? Also, to clarify, other that the console error, is this causing any crash or breaking anything at the moment?

[payal-lathidadiya]

That could be an option. Are those 3 refactors in progress already or still on hold? Also, to clarify, other that the console error, is this causing any crash or breaking anything at the moment?

@francoisl for those components, migration and refactor is still on hold.

Below is state of component which uses StepPropTypes and withLocalize HOC

1. ACHContractStep - migrated to function component
2. BankAccountStep - migrated to function component
3. BankAccountManualStep - migrated to function component
4. BankAccountPlaidStep - migrated to function component [current migration]
5. CompanyStep - class component, yet to migrate [on Hold]
6. RequestorOnfidoStep - class component, yet to migrate [on Hold]
7. RequestorStep - class component, yet to migrate [on Hold]

Also, this isn't causing any crash or breaking anything at the moment.

[francoisl]

Ok thanks. If some of those refactors are still on hold without a clear estimate of when they'll be done, I'd say it's fine to keep using the withLocalize HOC for now, but I'll defer to @hayata-suenaga for the final decision.

[hayata-suenaga]

let's use withLocalize for now 👍

[payal-lathidadiya]

Once all components which uses StepPropTypes are migrated to function component, we can remove withLocalizePropTypes from StepPropTypes down the line.

And remove withLocalize HOC reference and replace use of translate from useTranslate hook instead of props.

@francoisl / @hayata-suenaga should we create a new backlog issue for this expected refactor requirement in migration epic.

[payal-lathidadiya]

I think we already have got approvals.
If everything is good, can this be merged pls.

[hayata-suenaga]

@allroundexperts please final approve this PR when you got a moment 🙇

[allroundexperts]

Looks good!

[Santhosh-Sellavel]

bump @hayata-suenaga!

[hayata-suenaga]

👍

[OSBotify]

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.42-5 🚀

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

[kavimuru]

@payal-lathidadiya We get console error in this step Verify that it redirect to plaid portal and no error is displayed in console.
Do we need separate GH ticket for this?

[Santhosh-Sellavel]

@kavimuru please share the console error. So we can decide on that!

[kavimuru]

@Santhosh-Sellavel this is the video

22473.Web.mp4

[payal-lathidadiya]

@kavimuru
This seems to be a different issue and not related to current fix.

I just checked, this exists in production as well;

Screen.Recording.2023-07-19.at.7.51.36.PM.mov

[Santhosh-Sellavel]

@kavimuru please a new issue that's not relevant here.

[OSBotify]

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.42-26 🚀

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

[OSBotify]

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.44-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.44-2 🚀

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