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

fix: open bank account step directly in bottom down flow #48006

Merged
merged 4 commits into from
Aug 27, 2024

Conversation

hannojg
Copy link
Contributor

@hannojg hannojg commented Aug 26, 2024

Details

There is an issue where when creating a workspace from an IOU as part of the bottom up flow the opening of the plaid modal takes a long time.

The problem is that the ReimbursmentAccountPage depends on the openReimbursementAccountPage command, which can be delayed due to all intermediate calls that happen we create a new workspace (e.g. OpenReport).
For the aforementioned workflow we don't need to wait for openReimbursementAccountPage as we know that in this new workspace no bank account is setup.

The solution was to set the onyx reimbursement account state to be directly in the bank account setup step once we created a new workspace from IOU.

Note: There was one typescript issue with the ACHData where for an reimbursement account the step and subStep can be an empty string. Had to fix that as well here.

🐌 Before ✨ After
before.mov
after.mov

TODO:

  • Check if there are other flows that use createWorkspaceFromIOUPayment (checks if implementation would break any other flow)
  • Fix case where clicking on "Setup using plaid" doesn't load anything
  • Test on all platforms

Fixed Issues

$ #42756
discussion https://expensify.slack.com/archives/C05LX9D6E07/p1724434828202709
PROPOSAL: https://expensify.slack.com/archives/C05LX9D6E07/p1724673925409079?thread_ts=1724434828.202709&cid=C05LX9D6E07

Tests

  • Create a new user A
  • Create a new user B
  • With user B submit an expense to user A (IOU)
  • User A: Click on pay with expensify
  • Choose "Business Bank Account"
  • Verify that the Bank Connect Choose Modal opens instantly

Offline tests

N/A

QA Steps

Same as tests

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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 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 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 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.

Screenshots/Videos

Android: Native
Screen.Recording.2024-08-26.at.21.28.26.mov
Android: mWeb Chrome
Screen.Recording.2024-08-26.at.21.11.36.mov
iOS: Native
Screen.Recording.2024-08-26.at.21.12.06.mov
iOS: mWeb Safari
ios_mWeb.mov
MacOS: Chrome / Safari
after.mov
MacOS: Desktop
Screen.Recording.2024-08-26.at.20.46.27.mov

@hannojg hannojg requested a review from a team as a code owner August 26, 2024 14:49
@hannojg hannojg marked this pull request as draft August 26, 2024 14:49
@melvin-bot melvin-bot bot requested a review from bondydaa August 26, 2024 14:49
Copy link

melvin-bot bot commented Aug 26, 2024

@bondydaa 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 August 26, 2024 14:49
Copy link
Contributor

@MonilBhavsar MonilBhavsar left a comment

Choose a reason for hiding this comment

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

This looks good and makes sense 👍
I think it would also be good to take a look why we are calling OpenReport and ReadNewestAction api commands. Seems unnecessary to me

@hannojg
Copy link
Contributor Author

hannojg commented Aug 26, 2024

@MonilBhavsar when creating the new workspace we are navigating to it. Thus we call OpenReport and ReadNewestAction actions

@bondydaa bondydaa removed their request for review August 26, 2024 17:28
@MonilBhavsar
Copy link
Contributor

In this case, we're not redirecting. Are we? Then how are we calling the API commands, while the modal is still loading 🤔

@hannojg
Copy link
Contributor Author

hannojg commented Aug 26, 2024

In this case, we're not redirecting. Are we?

We are 😊 can share a video in a moment

@hannojg
Copy link
Contributor Author

hannojg commented Aug 26, 2024

I hope my mouse pointer annotations make it obvious what I mean 😄:

Screen.Recording.2024-08-26.at.20.27.46.mov

@MonilBhavsar
Copy link
Contributor

Oh I see now. Makes sense. Thank you! 😄

@hannojg hannojg marked this pull request as ready for review August 26, 2024 19:16
@hannojg
Copy link
Contributor Author

hannojg commented Aug 26, 2024

PR is ready for testing now! (Just need to test/upload android screenshots, still running a new build)

// All done now

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.

This approach looks good to me in general. @getusha what is your eta for the checklist? thanks!

@getusha
Copy link
Contributor

getusha commented Aug 27, 2024

@getusha what is your eta for the checklist?

Max 3 hours, i am on it.

@getusha
Copy link
Contributor

getusha commented Aug 27, 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
    • x ] 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-08-27.at.12.50.29.in.the.afternoon.mov
Android: mWeb Chrome
Screen.Recording.2024-08-27.at.12.37.58.in.the.afternoon.mov
iOS: Native
Screen.Recording.2024-08-27.at.1.01.10.in.the.afternoon.mov
iOS: mWeb Safari
Screen.Recording.2024-08-27.at.12.48.38.in.the.afternoon.mov
MacOS: Chrome / Safari
Screen.Recording.2024-08-27.at.12.33.26.in.the.afternoon.mov
MacOS: Desktop
Screen.Recording.2024-08-27.at.1.02.36.in.the.afternoon.mov

@getusha
Copy link
Contributor

getusha commented Aug 27, 2024

The bank account step doesn't open instantly from workspace chat after fresh login

Screen.Recording.2024-08-27.at.2.10.23.in.the.afternoon.mov

@melvin-bot melvin-bot bot requested a review from mountiny August 27, 2024 11:15
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.

Amazing the recordings are looking great

@getusha @hannojg I assume that lag in the video from Getusha might be that the js thread is overloaded with how much stuff we are trying to process

@hannojg
Copy link
Contributor Author

hannojg commented Aug 27, 2024

Yeah, we update the onyx value immediately before navigating to that page, so it must be some JS slowness that the value isn't set immediately when we are on the page. My hope is that in release mode the app will work a bit faster and that it won't be noticeable that much 😅
(otherwise I can investigate in a separate PR why there is the delay between setting the onyx optimistic data and it its value becoming available)

@mountiny mountiny merged commit 492b884 into Expensify:main Aug 27, 2024
17 of 61 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.26-1 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 9.0.26-6 🚀

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.

5 participants