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

feat: add employee and accounting page to onboarding flow #49161

Merged
merged 61 commits into from
Oct 10, 2024

Conversation

nkdengineer
Copy link
Contributor

@nkdengineer nkdengineer commented Sep 13, 2024

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

@nkdengineer nkdengineer marked this pull request as ready for review September 16, 2024 09:14
@nkdengineer nkdengineer requested review from a team as code owners September 16, 2024 09:14
@melvin-bot melvin-bot bot requested review from s77rt and removed request for a team September 16, 2024 09:14
Copy link

melvin-bot bot commented Sep 16, 2024

@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
Copy link
Contributor

@dubielzyk-expensify what are your thoughts on the "Connect your accounting..." text below the headline?
CleanShot 2024-09-16 at 11 18 56@2x

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
Copy link
Contributor

s77rt commented Sep 16, 2024

The font size is not consistent

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

@dubielzyk-expensify
Copy link
Contributor

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
Copy link
Contributor

dubielzyk-expensify commented Sep 17, 2024

The font size is not consistent

Agreed. All headlines should be the same here.

Also the padding here is off on @s77rt 's recording:
CleanShot 2024-09-17 at 13 39 14@2x

The text should all line up vertically on the left like so:
CleanShot 2024-09-17 at 13 41 13@2x

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

@nkdengineer
Copy link
Contributor Author

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
Copy link
Contributor Author

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
Copy link
Contributor Author

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

@nkdengineer
Copy link
Contributor Author

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
Copy link
Contributor

The padding between the headline and the text should be 12px. Like so:
CleanShot 2024-09-17 at 14 45 59@2x

It looks a bit too big in the screenshots above

@nkdengineer
Copy link
Contributor Author

Updated.

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

@nkdengineer
Copy link
Contributor Author

@s77rt I updated.

Comment on lines +76 to +80
if (!onboardingPolicyID) {
const {adminsChatReportID, policyID} = Policy.createWorkspace(undefined, true);
Welcome.setOnboardingAdminsChatReportID(adminsChatReportID);
Welcome.setOnboardingPolicyID(policyID);
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Since we are not going to use the policy in between steps is there any reason that we create the workspace at that early step? Why not create it just before calling completeOnboarding in the accounting step?

Copy link
Contributor

Choose a reason for hiding this comment

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

Interesting. Did you have any concern about that or opinion on why it would be better to do one over the other?

Copy link
Contributor

Choose a reason for hiding this comment

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

No strong preference it's just a little questionable that we create the workspace when not really needed yet. Now I think about it more I think we may have a bug:

  1. Login as a new user
  2. On the onboarding flow, select purpose to manage team <-- This will create a workspace
  3. Logout
  4. Login in again
  5. If you try to complete the onboarding flow you will be creating another workspace since onboardingPolicyID is not on onyx

cc @nkdengineer Can you please confirm if you can reproduce this bug?

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh hmm that's an interesting edge case for sure - I'm not sure how we would completely solve that without designating a specific policy as the "onboarding policy". Though we could potentially check if a user has an existing policy.

Copy link
Contributor

Choose a reason for hiding this comment

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

Fixing the problem highlighted in #50759 may fix this as I think we will have to send the policy id from the backend

@s77rt
Copy link
Contributor

s77rt commented Oct 9, 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 android
Android: mWeb Chrome mweb-chrome
iOS: Native ios
iOS: mWeb Safari mweb-safari
MacOS: Chrome / Safari web
MacOS: Desktop desktop

@melvin-bot melvin-bot bot requested a review from marcaaron October 9, 2024 19:37
@marcaaron
Copy link
Contributor

Sorry, @nkdengineer. Changes look great, but we have conflicts now.

@nkdengineer
Copy link
Contributor Author

@marcaaron I updated.

@marcaaron
Copy link
Contributor

Conflicts again.

@nkdengineer
Copy link
Contributor Author

@marcaaron I resolved.

Copy link
Contributor

@marcaaron marcaaron left a comment

Choose a reason for hiding this comment

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

Looking great! Thanks for your patience and hard work here. And great review as always @s77rt 🙇

@marcaaron marcaaron merged commit 476d112 into Expensify:main Oct 10, 2024
17 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.

Copy link
Contributor

🚀 Deployed to staging by https://github.com/marcaaron in version: 9.0.48-0 🚀

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

@marcaaron
Copy link
Contributor

@nkdengineer are you working on adding the task next? Just making sure you are aware of that part of this ticket. Please let me know.

@marcaaron
Copy link
Contributor

Heads up that there is another bug that we found concerning the signup flow between OldDot and NewDot. Because we have a flow where we set the signupQualifier before the user arrives at this flow. We will then skip the step that creates the policy.

I'm going to be working on that one because it essentially blocks the deploy since we can't release a version of the app where this policy doesn't get created.

Copy link
Contributor

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.48-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.

6 participants