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 beneficial owner form is not shown after revisiting the page #32278

Merged

Conversation

bernhardoj
Copy link
Contributor

Details

The beneficial owner form depends on the form input values state. When revisiting the page, the form is mounted with an empty input values state. This PR initialize the state with the form draft values.

Fixed Issues

$ #31848
PROPOSAL: #31848 (comment)

Tests

Same as QA Steps

  • Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

  1. Open Settings > Workspaces > Select any workspace > Bank account
  2. Start the bank account process and fill the first 3 steps
  3. On the 4th step, check the "Somebody else owns more than 25% of ..."
  4. Verify a beneficial owner form is shown
  5. Close the bank account page
  6. Reopen the bank account and press "Continue with setup". The 4th step will open
  7. Verify "Somebody else owns more than 25% of ..." is checked and the beneficial owner form is shown
  • 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: 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 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 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.

Screenshots/Videos

Android: Native
Screen.Recording.2023-12-01.at.00.11.33.mov
Android: mWeb Chrome
Screen.Recording.2023-12-01.at.00.14.14.mov
iOS: Native
Screen.Recording.2023-12-01.at.00.09.53.mov
iOS: mWeb Safari
Screen.Recording.2023-12-01.at.00.03.04.mov
MacOS: Chrome / Safari
Screen.Recording.2023-12-01.at.00.00.07.mov
MacOS: Desktop
Screen.Recording.2023-12-01.at.00.02.14.mov

@bernhardoj bernhardoj requested a review from a team as a code owner November 30, 2023 16:59
@melvin-bot melvin-bot bot removed the request for review from a team November 30, 2023 16:59
Copy link

melvin-bot bot commented Nov 30, 2023

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

@melvin-bot melvin-bot bot requested a review from cubuspl42 November 30, 2023 16:59
Copy link

melvin-bot bot commented Nov 30, 2023

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

@cubuspl42
Copy link
Contributor

@bernhardoj Is it the only place in the app where this bug occured? Or is there any way to skip the Onfido flow?

@bernhardoj
Copy link
Contributor Author

Yeah, I think it's the only place.

I use this information to avoid Onfido.

Routing number: 011401533
Account number: 1111222233331111

First name: Alberta
Last name: Charleson

@cubuspl42
Copy link
Contributor

I have various issues with this form ☹️

I provided your suggested data in Step 1, but Step 2 fails:

image

And when it does, it also "forgets" the data I entered into various fields and restores it with some old data.

@cubuspl42
Copy link
Contributor

But it also fails this way on staging (although not on prod). I think this might be some temporary issue on main which hopefully will be gone soon

@cubuspl42

This comment was marked as off-topic.

@bernhardoj
Copy link
Contributor Author

I provided your suggested data in Step 1, but Step 2 fails:
And when it does, it also "forgets" the data I entered into various fields and restores it with some old data.

Hmm, yeah, I just experienced this. I don't know if there is an issue with that, but I think we should wait until it's resolved

I have this issue (a "launching loop"):

I never tried opening a /transition route deep link, but it should be unrelated to our issue, right?

@cubuspl42
Copy link
Contributor

I never tried opening a /transition route deep link, but it should be unrelated to our issue, right?

This was supposed to land in another issue. Too many open Expensify tabs. Sorry!

@bernhardoj
Copy link
Contributor Author

@cubuspl42 looks like the issue is gone now.

@cubuspl42
Copy link
Contributor

cubuspl42 commented Dec 5, 2023

I use this information to avoid Onfido.

Doesn't skip Onfido for me 🙁

Edit: I worked around it with hardcoding the current step:

const currentStep = CONST.BANK_ACCOUNT.STEP.ACH_CONTRACT;

@cubuspl42
Copy link
Contributor

cubuspl42 commented Dec 5, 2023

Console error:

 ERROR  Warning: Failed prop type: Invalid prop `draftValues.beneficialOwners` supplied to `Form`, expected one of type [string, boolean, number].

@bernhardoj
Copy link
Contributor Author

Edit: I worked around it with hardcoding the current step:

Nice

Console error:

Yeah, I notice that on main too. Do we want to update the prop types to include array of strings too?

@cubuspl42
Copy link
Contributor

@bernhardoj I wasn't aware that this occurred on main; it sounded related to our changes. Let's treat this as unrelated.

@cubuspl42
Copy link
Contributor

Please merge main

@cubuspl42
Copy link
Contributor

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

Screenshots/Videos

Web
form-initial-draft-web.mp4
Mobile Web - Chrome
form-initial-draft-android-web-compressed.mp4
Mobile Web - Safari
form-initial-draft-ios-web.mp4
Desktop
form-initial-draft-desktop.mp4
iOS
form-initial-draft-ios.mp4
Android
form-initial-draft-android-compressed.mp4

Copy link
Contributor

@cubuspl42 cubuspl42 left a comment

Choose a reason for hiding this comment

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

I tested using a trick with hardcoding the flow's current step, as I couldn't find a way to skip the Onfido flow.

The fix itself is very straight-forward and looks good.

@bernhardoj
Copy link
Contributor Author

Merged with main

@cubuspl42
Copy link
Contributor

@tylerkaraszewski All yours 🙂

@tylerkaraszewski tylerkaraszewski merged commit 7cfa027 into Expensify:main Dec 11, 2023
15 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/tylerkaraszewski in version: 1.4.12-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/tylerkaraszewski in version: 1.4.12-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/tylerkaraszewski in version: 1.4.12-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.12-2 🚀

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.

4 participants