feat: add employee and accounting page to onboarding flow

[nkdengineer]

Details

Fixed Issues

$ #48745
PROPOSAL: #48745 (comment)

Tests

1. Login with a new account
2. In the first onboarding step choose Manage my team's expenses
3. Verify that the employee step appears with the correct style as design
4. Select an option and go to the next page
5. Verify that the accounting step appears with the correct style as design

• Verify that no errors appear in the JS console

Offline tests

None

QA Steps

1. Login with a new account
2. In the first onboarding step choose Manage my team's expenses
3. Verify that the employee step appears with the correct style as design
4. Select an option and go to the next page
5. Verify that the accounting step appears with the correct style as design

• 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

Screen.Recording.2024-09-16.at.15.30.48.mov

Android: mWeb Chrome

Screen.Recording.2024-09-16.at.15.27.18.mov

iOS: Native

Screen.Recording.2024-09-16.at.15.31.36.mov

iOS: mWeb Safari

Screen.Recording.2024-09-16.at.15.26.16.mov

MacOS: Chrome / Safari

Screen.Recording.2024-09-16.at.15.20.11.mov

MacOS: Desktop

Screen.Recording.2024-09-16.at.15.34.54.mov

[melvin-bot]

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

[shawnborton]

@dubielzyk-expensify what are your thoughts on the "Connect your accounting..." text below the headline?

I am thinking it should be bigger (in our normal font size, 15px) and maybe a bit more margin below it and above the options?

[s77rt]

The font size is not consistent

Screen.Recording.2024-09-16.at.1.14.10.PM.mov

[dubielzyk-expensify]

I am thinking it should be bigger (in our normal font size, 15px) and maybe a bit more margin below it and above the options?

Agree. In the mocks I've specified it as text which is our regular body 15px font size. I also have 20px margin between the text and the accounting options so let's use that

[dubielzyk-expensify]

The font size is not consistent

Agreed. All headlines should be the same here.

Also the padding here is off on @s77rt 's recording:

The text should all line up vertically on the left like so:

We use 32px padding on desktop modals and 20px on mobile :)

[nkdengineer]

Also the padding here is off on @s77rt 's recording:
The text should all line up vertically on the left like so:

This bug is fixed on the latest code.

[nkdengineer]

The font size is not consistent

Oh, that is the font-size that we use in the onboarding work step and I used this when creating new pages.

[nkdengineer]

@dubielzyk-expensify How about the spacing between the title and the description in the accounting step? Is it also 20px?

[nkdengineer]

Update two screenshots for desktop and mobile.

Screen.Recording.2024-09-17.at.11.20.45.mov

Screen.Recording.2024-09-17.at.11.21.47.mov

[dubielzyk-expensify]

The padding between the headline and the text should be 12px. Like so:

It looks a bit too big in the screenshots above

[nkdengineer]

Updated.

Screen.Recording.2024-09-17.at.12.37.48.mov

Screen.Recording.2024-09-17.at.12.37.31.mov

[s77rt]

This should be optional.

(To recheck: the BE seems to complain about the empty names)

[nkdengineer]

Should we also update the default value of this data in compleOnboarding function with the default value as empty string?

[s77rt]

Make it optional in completeOnboarding

[marcaaron]

AFAICT it is optional. Lmk what you are seeing. Yes I would update this to be optional.

I am also pretty confused about why it's being passed as an object if we can fix that while we are here. Maybe someone thought it better to parameterize the arguments? But the next person disagreed 😄

Looks inconsistent to me. Let's make it:

function completeOnboarding(
    engagementChoice: OnboardingPurposeType,
    data: ValueOf<typeof CONST.ONBOARDING_MESSAGES>,
    firstName?: string;
    lastName?: string;
    adminsChatReportID?: string,
    onboardingPolicyID?: string,
    paymentSelected?: string,
    ...
) {

[s77rt]

@marcaaron

{
    "jsonCode": 402,
    "message": "402 Missing firstName",
    "onyxData": [],
    "requestID": "8c542209db944e20-ORN"
}

[marcaaron]

Sigh... lol 😄

[nkdengineer]

@marcaaron Should we add default value for firstName and lastName in completeOnboarding because in the type CompleteGuidedSetupParams, firstName and lastName is string.

[marcaaron]

Yes let's do it. We will need it in some cases, but not for the "manage team expense" choice so it is appropriate to make optional.

[nkdengineer]

I updated.

[s77rt]

+Conflicts

[s77rt]

Let's init the employees value from onyx

Screen.Recording.2024-09-18.at.9.23.10.PM.mov

[marcaaron]

AFAICT it is optional. Lmk what you are seeing. Yes I would update this to be optional.

I am also pretty confused about why it's being passed as an object if we can fix that while we are here. Maybe someone thought it better to parameterize the arguments? But the next person disagreed 😄

Looks inconsistent to me. Let's make it:

function completeOnboarding(
    engagementChoice: OnboardingPurposeType,
    data: ValueOf<typeof CONST.ONBOARDING_MESSAGES>,
    firstName?: string;
    lastName?: string;
    adminsChatReportID?: string,
    onboardingPolicyID?: string,
    paymentSelected?: string,
    ...
) {

[nkdengineer]

Let's init the employees value from onyx

@s77rt

const [onboardingCompanySize] = useOnyx(ONYXKEYS.ONBOARDING_COMPANY_SIZE);

We have a problem in this case: the first time the component is rendered (reloading this page), onboardingCompanySize from Onyx is undefined because it's stored in cache. That means we can't focus on the selected item by using the initiallyFocusedOptionKey prop.

I added a solution that is to add an Onyx.connect in OnboardingFlow for this key then the value of the key can be stored in the cache and we can get the correct value the first time the component is rendered.

What do you think? Let's me know if you have another idea.

[s77rt]

@nkdengineer

I added a solution that is to add an Onyx.connect in OnboardingFlow for this key then the value of the key can be stored in the cache

This is a workaround. Please remove it.

Also I think the case you mentioned is not worth optimizing for, the case I reported is when we refresh on the accounting page and go back we should have a selection, this should work already without the workaround. The case you mentioned is when we refresh on the employees page, i think it's okay to have no selection.

[nkdengineer]

@s77rt Updated

Also I think the case you mentioned is not worth optimizing for, the case I reported is when we refresh on the accounting page and go back we should have a selection, this should work already without the workaround

Yes, it worked.

[s77rt]

Can we apply margin/padding to the main element instead of these fake spacers? Also currently the checkbox goes beyond the intended area

[nkdengineer]

As I mentioned, SelectionList doesn't have a prop to add style to ListItem. Then if we want to do that, we need to introduce a new prop.