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

Remove Confirmation from plaid bank flow #48767

Merged
merged 16 commits into from
Sep 17, 2024

Conversation

parasharrajat
Copy link
Member

@parasharrajat parasharrajat commented Sep 8, 2024

Details

Fixed Issues

$ #48730
$ #48732
PROPOSAL:

Tests

Same as QA steps.

  • Verify that no errors appear in the JS console

Offline tests

  1. Sign up with a Gmail account added to Workspace feeds beta

  2. Enable Expensify Card in more features

  3. Select Issue card to kick off the enablement flow.

  4. Start setup using credentials from option 3 in the SO.

    For Plaid flow.
     This Flow can not be completed while offline. 
    
    For manual Flow.
     a. After you have added routing and account number, click next. 
     b. Verify that the confirmation screen is not shown again on step 1. 
    
  5. Finish the bank account flow.

  6. Go through the issue card flow, and land on the card name step.

  7. verify that the cad name field is not prefilled with a suggestion.

QA Steps

  1. Sign up with a Gmail account added to Workspace feeds beta

  2. Enable Expensify Card in more features

  3. Select Issue card to kick off the enablement flow.

  4. Start setup using credentials from option 3 in the SO.

    For Plaid flow.
     a. After plaid flow is completed, select the account on the Step 1. 
     b. Verify that clicking next does not reconfim the selected account. 
    
    For manual Flow.
     a. After you have added routing and account number, click next. 
     b. Verify that the confirmation screen is not shown again on step 1. 
    
  5. Finish the bank account flow.

  6. Go through the issue card flow, and land on the card name step.

  7. verify that the cad name field is not prefilled with a suggestion.

  • 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
      • 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
16.09.2024_23.05.52_REC.mp4
MacOS: Chrome / Safari
16.09.2024_22.43.14_REC.mp4
16.09.2024_23.02.21_REC.mp4
MacOS: Desktop

@parasharrajat
Copy link
Member Author

@ishpaul777 You can start testing it now and let me know if something is off. I am thinking to add videos when you give a signal.

@ishpaul777
Copy link
Contributor

ishpaul777 commented Sep 8, 2024

## 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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • 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

Android: Native
Screen.Recording.2024-09-16.at.9.58.23.PM-1.mov
Screen.Recording.2024-09-16.at.10.07.20.PM-1.mov
Android: mWeb Chrome

Uploading Screen Recording 2024-09-16 at 10.24.18 PM-1.mov…

iOS: Native
Screen.Recording.2024-09-16.at.9.39.50.PM.mov
iOS: mWeb Safari
Screen.Recording.2024-09-16.at.9.44.59.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-09-09.at.4.21.08.PM.mov
Screen.Recording.2024-09-09.at.4.50.06.PM.mov
Screen.Recording.2024-09-16.at.9.13.14.PM.mov
MacOS: Desktop
Screen.Recording.2024-09-16.at.10.24.18.PM-1.mov

@ishpaul777
Copy link
Contributor

ishpaul777 commented Sep 8, 2024

Bug: [Desktop] after adding a account and clicking next shows error for first time

Screen.Recording.2024-09-08.at.8.29.19.PM.mov

edit: reproducable on web also

Can't reproduce on main

@ishpaul777
Copy link
Contributor

@parasharrajat ^

@parasharrajat
Copy link
Member Author

I noticed this error too. It is very strange issue. It is happening because the first time bank account details is not being sent to backend. it seems that the second render populates the bank account values.

We call onNext directly after setting the account in the draft in the Plaid step https://github.com/parasharrajat/App/blob/88cb276d8df9e22d1dc1b1fdec6d98e486fee641/src/pages/ReimbursementAccount/BankInfo/substeps/Plaid.tsx#L55 . It called onfinished https://github.com/parasharrajat/App/blame/88cb276d8df9e22d1dc1b1fdec6d98e486fee641/src/pages/ReimbursementAccount/BankInfo/BankInfo.tsx#L63 directly with the old callback which does not have correct bank account values.

What do you suggest we do to solve this?

@ishpaul777
Copy link
Contributor

ishpaul777 commented Sep 8, 2024

Haven't tried and tested this yet myself but Can we try pass correct details in submit (onfinished) from params

onNext(correctdetails)-> onfinished(correctDetails) -> submit(correctDetails)

@parasharrajat
Copy link
Member Author

@ishpaul777 Fixed that issue. Could you please check?

@ishpaul777
Copy link
Contributor

Nice it looks good and works well

Screen.Recording.2024-09-09.at.4.21.08.PM.mov

lets remove the unused Confirmation component also

@ishpaul777
Copy link
Contributor

I guess we have a similar issue with manual flow, first time next button dont work

Screen.Recording.2024-09-09.at.4.42.34.PM.mov

@ishpaul777
Copy link
Contributor

@parasharrajat Any update ^

@parasharrajat
Copy link
Member Author

I don't have this issue when I use the manual flow directly. I am trying to reproduce the exact scenario from your video. Do you have steps for it?

@ishpaul777
Copy link
Contributor

ishpaul777 commented Sep 10, 2024

Steps to repro:

  1. Start plaid flow, complete it until any step after "What your legal name"
  2. exit flow, and restart it from "Continue with setup"

@trjExpensify
Copy link
Contributor

Should this be converted to an open PR in review at this point?

@parasharrajat
Copy link
Member Author

parasharrajat commented Sep 10, 2024

This is happening due to same reason. I try to find a solution which does not break existing substeps flow but couldn't figure out a direct way.

Here is the summary:

  1. form submission is handled with this hook
    const handleSubmit = useReimbursementAccountStepFormSubmit({
  2. Which is directly called onNext after we save a draft and thus the submit is called before values are updated. https://github.com/Expensify/App/blame/fe4d19e592d68684fb471f2bba93787c88a3a3f3/src/hooks/useStepFormSubmit.ts#L35

Are there any patterns that we use to solve such issues? @ishpaul777 Do you have any suggestions on it?

@ishpaul777
Copy link
Contributor

Which is directly called onNext after we save a draft and thus the submit is called before values are updated. https://github.com/Expensify/App/blame/fe4d19e592d68684fb471f2bba93787c88a3a3f3/src/hooks/useStepFormSubmit.ts#L35

I am sorry but i dont agree with this root cause, with my investigation it appears that isEditing is true here when we click Next the first time thats why it early return and never call submit

if (isEditing.current) {
isEditing.current = false;
setScreenIndex(bodyContent.length - 1);
return;
}

its turned true from here, moveTo() call

if (setupType === CONST.BANK_ACCOUNT.SETUP_TYPE.MANUAL && values.bankName !== '' && !redirectedFromPlaidToManual) {
setRedirectedFromPlaidToManual(true);
moveTo(0);
}
}, [moveTo, redirectedFromPlaidToManual, setupType, values]);

I am not sure the correct solution to this for now, i'll keep investigating though let me knw if you find any...

@parasharrajat
Copy link
Member Author

Thanks for the help. I will debug this again.

@parasharrajat
Copy link
Member Author

May be we should just remove the substeps logic all along from this screen.

@parasharrajat parasharrajat marked this pull request as ready for review September 10, 2024 16:30
@parasharrajat parasharrajat requested a review from a team as a code owner September 10, 2024 16:30
Copy link

melvin-bot bot commented Sep 10, 2024

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

@melvin-bot melvin-bot bot removed the request for review from a team September 10, 2024 16:30
@parasharrajat
Copy link
Member Author

parasharrajat commented Sep 10, 2024

I tried removing this substeps flow from this component but I am not sure the use of this effect. How to handle this?

https://github.com/Expensify/App/pull/48767/files#diff-d650bba894bab52c66832a82cfac2df40c3b8ed758d199961274b86ed5cd2147L60-L66

I have pushed the latest changes so that you can take a look.

@ishpaul777
Copy link
Contributor

@parasharrajat if you havent noticed perf tests is failing

@parasharrajat
Copy link
Member Author

Looks like a patching issue. A patch is not being applied correctly.

@ishpaul777
Copy link
Contributor

Remerge main maybe a one time issue ?

@ishpaul777
Copy link
Contributor

Tests all good, we just need to figure out failing tests

@melvin-bot melvin-bot bot requested a review from mountiny September 16, 2024 17:13
@parasharrajat
Copy link
Member Author

I am stuck with the account verification step. it is asking for 3 transaction values.

@mountiny
Copy link
Contributor

I am stuck with the account verification step. it is asking for 3 transaction values.

Did you put in credentials_good in the plaid modal for the mobile verification?

@parasharrajat
Copy link
Member Author

parasharrajat commented Sep 16, 2024

Nope. I will try that.

@mountiny
Copy link
Contributor

@parasharrajat, can you merge the main? The patch was not applied correctly in the test but I can see the action succeed on other PRs

@parasharrajat
Copy link
Member Author

parasharrajat commented Sep 16, 2024

Now, this new check is failing 🤔 .

@ishpaul777
Copy link
Contributor

the migration 😆 withOnyx -> useOnyx https://expensify.slack.com/archives/C01GTK53T8Q/p1726169039084589

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

Changes look good to me have you tested this after the useOnyx migration @ishpaul777 @parasharrajat?

}
}, [setupType, values, bankAccountID, policyID]);
const submit = useCallback(
(submitData: unknown) => {
Copy link
Contributor

Choose a reason for hiding this comment

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

Any way we could improve this type? @koko57 @blazejkustra @fabioh8010

@mountiny
Copy link
Contributor

It was quite a lot of changes so would be great to confirm that it works well

Thanks for working on this @parasharrajat @ishpaul777

@ishpaul777
Copy link
Contributor

Sorry i left yesterday, testing in few minutes...

Copy link
Contributor

@ishpaul777 ishpaul777 left a comment

Choose a reason for hiding this comment

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

LGTM!

@melvin-bot melvin-bot bot requested a review from mountiny September 17, 2024 09:46
Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

Thanks everyone!

@mountiny mountiny merged commit 2190f62 into Expensify:main Sep 17, 2024
20 checks passed
@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/mountiny in version: 9.0.37-0 🚀

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

@m-natarajan
Copy link

@parasharrajat Can you explain the step 1

Sign up with a Gmail account added to Workspace feeds beta

@mountiny
Copy link
Contributor

@m-natarajan the beta is no longer relevant, you can use any account and you should be able to enable the cards there

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/grgia in version: 9.0.38-4 🚀

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

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