fix: Refactor completeOnboarding to use a parameter object. by Krishna2323 · Pull Request #58532 · Expensify/App

Krishna2323 · 2025-03-15T22:24:23Z

Explanation of Change

Fixed Issues

$ #57259
PROPOSAL: #57259 (comment)

Tests

Sign up with a new account
Select onboarding purpose > Fill up all the details
Complete onboarding and verify everything works as expected.

e.g. If you have selected Manage my team's expenses > Any team size > Verify you are taken to staging.expensify.com > Click browser back button > Verify a workspace is created and there are several tasks like Set up categories, Set up tags, Add expense approvals & Invite your team.

Repeat the same steps with all other onboarding purposes

Verify that no errors appear in the JS console

Offline tests

Needs internet connection

QA Steps

Sign up with a new account
Select onboarding purpose > Fill up all the details
Complete onboarding and verify everything works as expected.

e.g. If you have selected Manage my team's expenses > Any team size > Verify you are taken to staging.expensify.com > Click browser back button > Verify a workspace is created and there are several tasks like Set up categories, Set up tags, Add expense approvals & Invite your team.

Repeat the same steps with all other onboarding purposes

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android_native.mp4

Android: mWeb Chrome

android_chrome.mp4

iOS: Native

ios_native.mp4

iOS: mWeb Safari

ios_safari.mp4

MacOS: Chrome / Safari

web_chrome.mp4

MacOS: Desktop

desktop_app.mp4

Signed-off-by: krishna2323 <belivethatkg@gmail.com>

melvin-bot · 2025-03-20T12:30:09Z

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

mananjadhav · 2025-03-21T17:55:14Z

Complete onboarding and verify everything works as expected.

@Krishna2323 Can provide give 1-2 examples here?

Krishna2323 · 2025-03-22T21:14:04Z

@mananjadhav, updated.

mananjadhav · 2025-03-25T18:01:17Z

src/libs/actions/Report.ts

-    data: ValueOf<typeof CONST.ONBOARDING_MESSAGES>,
+function completeOnboarding({
+    engagementChoice,
+    data,


I know this is an existing param, but now that it's a named arg, let's use a better name instead of data. I think we can call it onboardingMessage.

mananjadhav

One small comment. Rest looks good. I'll start with the QA.

Signed-off-by: krishna2323 <belivethatkg@gmail.com>

mananjadhav · 2025-03-30T19:35:46Z

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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
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 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.ts 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.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
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-complete-onboarding-refactor.mov

Android: mWeb Chrome

mweb-chrome-complete-onboarding-refactor.mov

iOS: Native

ios-complete-onboarding-refactor.mov

iOS: mWeb Safari

mweb-safari-complete-onboarding-refactor.mov

MacOS: Chrome / Safari

web-completing-onboarding-refactor.mov

web-onboarding-tasks.mov

MacOS: Desktop

desktop-completing-onboarding-refactor.mov

mananjadhav

The not here links on the iOS is because of different ports. I've added a second recording for the onboarding tasks in the Web section.

neil-marcellini

Great works, thanks. You can address the NAB in a follow up if you like. I'm ok with it either way.

neil-marcellini · 2025-03-31T20:46:21Z

src/libs/actions/Report.ts

+}: {
+    engagementChoice: OnboardingPurpose;
+    onboardingMessage: ValueOf<typeof CONST.ONBOARDING_MESSAGES>;
+    firstName?: string;
+    lastName?: string;
+    adminsChatReportID?: string;
+    onboardingPolicyID?: string;
+    paymentSelected?: string;
+    companySize?: OnboardingCompanySize;
+    userReportedIntegration?: OnboardingAccounting;
+    wasInvited?: boolean;
+}) {


NAB: I prefer declaring the type separately and naming it.

neil-marcellini · 2025-03-31T20:47:53Z

src/libs/actions/Report.ts

-    data: ValueOf<typeof CONST.ONBOARDING_MESSAGES>,
+function completeOnboarding({
+    engagementChoice,
+    onboardingMessage,


Thanks, that's a much better name than data 😄

OSBotify · 2025-03-31T20:59:43Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

github-actions · 2025-04-01T15:38:28Z

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 9.1.22-0 🚀

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

github-actions · 2025-04-03T11:39:50Z

🚀 Deployed to production by https://github.com/grgia in version: 9.1.22-10 🚀

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

Krishna2323 added 2 commits March 16, 2025 03:48

fix: Refactor completeOnboarding to use a parameter object.

be47c37

Signed-off-by: krishna2323 <belivethatkg@gmail.com>

fix ESLint.

3dd6a22

Signed-off-by: krishna2323 <belivethatkg@gmail.com>

Krishna2323 marked this pull request as ready for review March 20, 2025 12:30

Krishna2323 requested a review from a team as a code owner March 20, 2025 12:30

melvin-bot bot requested review from mananjadhav and removed request for a team March 20, 2025 12:30

Merge branch 'Expensify:main' into krishna2323/issue/57259

c96225f

mananjadhav reviewed Mar 25, 2025

View reviewed changes

Krishna2323 added 3 commits March 26, 2025 06:02

Merge branch 'Expensify:main' into krishna2323/issue/57259

b6cbeac

update argument for completeOnboarding.

f89d811

Signed-off-by: krishna2323 <belivethatkg@gmail.com>

Merge branch 'Expensify:main' into krishna2323/issue/57259

8fd2257

mananjadhav approved these changes Mar 30, 2025

View reviewed changes

melvin-bot bot requested a review from neil-marcellini March 30, 2025 19:53

neil-marcellini mentioned this pull request Mar 31, 2025

[Tracking] Refactor functions with many parameters to use parameter objects #50368

Closed

3 tasks

neil-marcellini approved these changes Mar 31, 2025

View reviewed changes

neil-marcellini merged commit 45ca125 into Expensify:main Mar 31, 2025
18 checks passed

github-actions bot mentioned this pull request Apr 1, 2025

Deploy Checklist: New Expensify 2025-04-01 #59448

Closed

60 tasks

melvin-bot bot mentioned this pull request Apr 3, 2025

[Due for payment 2025-04-10] [$125] Refactor completeOnboarding to use a parameter object #57259

Closed

Conversation

Krishna2323 commented Mar 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Mar 20, 2025

Uh oh!

mananjadhav commented Mar 21, 2025

Uh oh!

Krishna2323 commented Mar 22, 2025

Uh oh!

mananjadhav Mar 25, 2025

Choose a reason for hiding this comment

Uh oh!

Krishna2323 Mar 26, 2025

Choose a reason for hiding this comment

Uh oh!

mananjadhav left a comment

Choose a reason for hiding this comment

Uh oh!

mananjadhav commented Mar 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

mananjadhav left a comment

Choose a reason for hiding this comment

Uh oh!

neil-marcellini left a comment

Choose a reason for hiding this comment

Uh oh!

neil-marcellini Mar 31, 2025

Choose a reason for hiding this comment

Uh oh!

neil-marcellini Mar 31, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

OSBotify commented Mar 31, 2025

Uh oh!

github-actions bot commented Apr 1, 2025

Uh oh!

github-actions bot commented Apr 3, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Krishna2323 commented Mar 15, 2025 •

edited

Loading

mananjadhav commented Mar 30, 2025 •

edited

Loading