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

Feature/20459 sub steps refactor #51231

Open
wants to merge 52 commits into
base: main
Choose a base branch
from

Conversation

burczu
Copy link
Contributor

@burczu burczu commented Oct 22, 2024

Details

In this PR I've refactored some parts of the code related to sub-steps forms that we recently use more extensively in the App. These improvements was discussed with @koko57 and @MrMuzyk - it will be useful in the Global Reimbursement project where we create more sub-steps forms. The PR introduces few re-usable common form components like FullNameStep, DateOfBirthStep, AddressStep or SingleFieldStep (that can be used for e.g. phone numbers or social security numbers) ones and uses them wherever applicable. It also makes the InteractiveStepWrapper component more re-usable.

Fixed Issues

$ #50893
PROPOSAL: n/a

Tests

Enable payments:

  1. Log in to the App
  2. Go to Settings -> Wallet
  3. Add bank account
  4. Click "Enable wallet"
  5. Test all the "Personal info" steps linke full name, address, date of birth

Reimbursement account - personal info:

  1. Log in to the App
  2. Create new workspace
  3. Add new member
  4. Go to More features section and enable Expensify Card option
  5. Go to Expensify Card section that just appeared
  6. Tap Issue new card
  7. Go through the process of connecting to the bank account etc. (use testing data described in this Slack thread: https://callstack-hq.slack.com/archives/C01GTK53T8Q/p1711049879962529)
  8. At some point of the process you'll need to provide requestor information like first and last name, date of birth etc. - test if it works correctly

Reimbursement account - beneficial owner info:

  1. Repeat steps 1-7 described above
  2. On the later steps of the process, you'll be asked: "Do you own 25% or more of Alberta Bobbeth Charleson?" - select "No"
  3. On the next step: "Do any individuals own 25% or more of Alberta Bobbeth Charleson?" - select "Yes"
  4. You'll land on the next personal info multiple steps form - test it if it works correctly

Missing personal info for issuing the card:

  1. Log in to the App as User A
  2. Go to the Workspace that you are admin of
  3. Invite completely new user (User B)
  4. Turn on Expensify Card for this workspace if not done yet
  5. Set it up
  6. Tap "Issue new card" and issue the card for User B
  7. Log in to the App as User B
  8. Go to the Workspace chat - you should see the "Add shipping details" button - tap it
  9. You'll see the multiple step form asking you to fill your personal details - test it
  • Verify that no errors appear in the JS console

Offline tests

Same as above

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: 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

Enable payments:

Screen.Recording.2024-10-24.at.09.02.09.mov

Reimbursement account - personal info:

Screen.Recording.2024-10-24.at.09.10.28.mov

Reimbursement account - beneficial owner info:

Screen.Recording.2024-10-24.at.09.13.44.mov

Missing personal info for issuing the card:

Screen.Recording.2024-10-24.at.09.18.03.mov
Android: mWeb Chrome

Enable payments:

Screen.Recording.2024-10-24.at.10.32.27.mov

Reimbursement account - personal info:

Screen.Recording.2024-10-24.at.10.40.06.mov

Reimbursement account - beneficial owner info:

Screen.Recording.2024-10-24.at.10.43.18.mov

Missing personal info for issuing the card:

Screen.Recording.2024-10-24.at.10.36.08.mov
iOS: Native

Enable payments:

Screen.Recording.2024-10-24.at.08.27.37.mov

Reimbursement account - personal info:

Screen.Recording.2024-10-24.at.08.31.24.mov

Reimbursement account - beneficial owner info:

Screen.Recording.2024-10-24.at.08.36.38.mov

Missing personal info for issuing the card:

Screen.Recording.2024-10-24.at.08.45.54.mov
iOS: mWeb Safari

Enable payments:

Screen.Recording.2024-10-24.at.09.41.31.mov

Reimbursement account - personal info:

Screen.Recording.2024-10-24.at.10.15.04.mov

Reimbursement account - beneficial owner info:

Screen.Recording.2024-10-24.at.10.24.29.mov

Missing personal info for issuing the card:

Screen.Recording.2024-10-24.at.09.50.48.mov
MacOS: Chrome / Safari

Enable payments:

Screen.Recording.2024-10-23.at.09.31.28.mov

Reimbursement account - personal info:

Screen.Recording.2024-10-24.at.07.27.46.mov

Reimbursement account - beneficial owner info:

Screen.Recording.2024-10-24.at.07.45.42.mov

Missing personal info for issuing the card:

Screen.Recording.2024-10-24.at.07.51.18.mov
MacOS: Desktop

Enable payments:

Screen.Recording.2024-10-24.at.08.03.18.mov

Reimbursement account - personal info:

Screen.Recording.2024-10-24.at.08.06.26.mov

Reimbursement account - beneficial owner info:

Screen.Recording.2024-10-24.at.08.09.56.mov

Missing personal info for issuing the card:

Screen.Recording.2024-10-24.at.08.13.40.mov

@burczu burczu force-pushed the feature/20459-sub-steps-refactor branch from 7125bea to 0136b74 Compare October 23, 2024 05:35
@burczu burczu marked this pull request as ready for review October 24, 2024 09:32
@burczu burczu requested a review from a team as a code owner October 24, 2024 09:32
@melvin-bot melvin-bot bot requested review from hungvu193 and removed request for a team October 24, 2024 09:32
Copy link

melvin-bot bot commented Oct 24, 2024

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

@koko57
Copy link
Contributor

koko57 commented Oct 24, 2024

at first glance looks nice! great job!

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.

2 participants