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

add tasks for new user first workspace #55302

Merged
merged 28 commits into from
Jan 30, 2025

Conversation

ishpaul777
Copy link
Contributor

@ishpaul777 ishpaul777 commented Jan 15, 2025

Explanation of Change

Fixed Issues

$ #53509
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console
  1. Sign up with new account and choose "Track and budget expense" in onboarding user intent.
  2. Track a expense
  3. in Selfdm choose to categorize it or share it with my accountant complete the flow.
  4. Verify in you conceriege chat there are new tasks and with a message "Here are some important tasks to help get your team’s expenses under control." and a video
Screenshot 2025-01-17 at 4 25 35 AM

Test 2

  1. Sign up with new account and choose any other option than "Manage my team's expense" in onboarding flow user intent.
  2. Create a new worksapce
  3. Verify in you conceriege chat there are new tasks and with a message "Here are some important tasks to help get your team’s expenses under control." and a video
Screenshot 2025-01-17 at 4 30 19 AM

Offline tests

QA Steps

Same as test steps

  • 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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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.ts 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user 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.

Screenshots/Videos

Android: Native
Screen.Recording.2025-01-17.at.11.43.00.PM.mov
Android: mWeb Chrome
iOS: Native
Screen.Recording.2025-01-18.at.3.24.19.AM.mov
iOS: mWeb Safari
Screen.Recording.2025-01-18.at.3.41.30.AM.mov
MacOS: Chrome / Safari
Screen.Recording.2025-01-17.at.3.53.34.AM.mov
MacOS: Desktop
Screen.Recording.2025-01-30.at.1.26.58.AM.mov
Screen.Recording.2025-01-30.at.1.31.24.AM.mov

@ishpaul777 ishpaul777 marked this pull request as ready for review January 15, 2025 18:34
@ishpaul777 ishpaul777 requested a review from a team as a code owner January 15, 2025 18:34
@melvin-bot melvin-bot bot requested review from shubham1206agra and removed request for a team January 15, 2025 18:34
Copy link

melvin-bot bot commented Jan 15, 2025

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

@ishpaul777
Copy link
Contributor Author

@shubham1206agra please ignore this one


@mananjadhav will review this

@francoisl francoisl requested a review from mananjadhav January 15, 2025 18:35
@francoisl
Copy link
Contributor

Reassigning C+ for review, this is coming from #55017. Thanks

@francoisl francoisl requested review from francoisl and removed request for shubham1206agra January 15, 2025 18:35
@mananjadhav
Copy link
Collaborator

mananjadhav commented Jan 15, 2025

Checked the code, did one pass and most of it looks good. @ishpaul777 Can you complete the author checklist?

I also checked a possibility of refactoring the prepareOnboardingOptimisticData but it's too large to be moved outside of actions. I thought we could send the data with buildPolicyData.

Asking the same question here #55017 (comment).

@francoisl Should we ignore the rule for this particular instance?

@francoisl
Copy link
Contributor

francoisl commented Jan 16, 2025

Looking good - a few things:

  • We need to update this line to also include the new TRACK_WORKSPACE const – basically now any time we create a workspace, the onboarding tasks should be in the #admins room, not in the Concierge chat, and so the targetChatReportID should be the optimistic admin room's ID.

    const shouldPostTasksInAdminsRoom = engagementChoice === CONST.ONBOARDING_CHOICES.MANAGE_TEAM && !currentUserEmail?.includes('+');

  • I'm noticing a bug where the video comment is not rendering and stays as [Attachment] forever. That's a backend issue that I'm fixing now, so you can ignore for now
    image

  • Regarding the no-call-actions-from-actions failure, I'm kind of confused. The action says it's failing on line 2303, which is function createWorkspaceFromIOUPayment(), which hasn't changed here... Or is it because of prepareOnboardingOnyxData()? Regardless, as far as I can tell, that action should only fail if you call an action within an action that calls the API (https://github.com/Expensify/eslint-config-expensify/blob/acac69e60be8c/eslint-plugin-expensify/no-call-actions-from-actions.js), which neither prepareOnboardingOnyxData() nor buildPolicyData() does 🙃 I don't feel great about ignoring the rule without fully understanding why it's even erroring now.

@ishpaul777
Copy link
Contributor Author

ishpaul777 commented Jan 16, 2025

We need to update this line to also include the new TRACK_WORKSPACE const – basically now any time we create a workspace, the onboarding tasks should be in the #admins room, not in the Concierge chat, and so the targetChatReportID should be the optimistic admin room's ID.

will address this soon..

Can you complete the author checklist?

yes i'll do it right right after ^

@ishpaul777
Copy link
Contributor Author

I'm noticing a bug where the video comment is not rendering and stays as [Attachment] forever. That's a backend issue that I'm fixing now, so you can ignore for now

there is also one more bug that this message "Here are some important tasks to help get your team’s expenses under control." goes away after createworkspace api command is success, can you please check that one as well please it looks like BE issue

@ishpaul777
Copy link
Contributor Author

The action says it's failing on line 2303, which is function createWorkspaceFromIOUPayment(), which hasn't changed here... Or is it because of prepareOnboardingOnyxData()?

my best guess is that this because of prepareOnboardingOnyxData that is why its fixed with this d83382d workaround

@francoisl
Copy link
Contributor

there is also one more bug that this message "Here are some important tasks to help get your team’s expenses under control." goes away after createworkspace api command is success

I'm not even seeing that message being sent in the CreateWorkspace payload, nor the video actually 🤔

image

@francoisl
Copy link
Contributor

For some reason the video and message come back if I revert this commit.

@@ -424,7 +424,7 @@ function createWorkspaceWithPolicyDraftAndNavigateToIt(
* @param [file] Optional, avatar file for workspace
*/
function savePolicyDraftByNewWorkspace(policyID?: string, policyName?: string, policyOwnerEmail = '', makeMeAdmin = false, currency = '', file?: File) {
createWorkspace(policyOwnerEmail, makeMeAdmin, policyName, policyID, '', currency, file);
createWorkspace(policyOwnerEmail, makeMeAdmin, policyName, policyID, CONST.ONBOARDING_CHOICES.MANAGE_TEAM, currency, file);
Copy link
Collaborator

Choose a reason for hiding this comment

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

@ishpaul777 @francoisl do you see a need for adding a comment on why we're passing MANAGE_TEAM ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

no strong feelings, but it feel self explanatory if we don't typescript will yell

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 feelings either, though I think it might be more beneficial if we add an explanation in the doc of the function definition, in Policy.ts. Right now it says @param [engagementChoice] Purpose of using application selected by user in guided setup flow - we can add a note saying that the default is MANAGE_TEAM and you can change for specific policy creation flows

Copy link
Collaborator

@mananjadhav mananjadhav left a comment

Choose a reason for hiding this comment

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

Reviewed the code changes, will do a final review once more and then start testing this.

@mananjadhav
Copy link
Collaborator

mananjadhav commented Jan 29, 2025

@ishpaul777 I had raised a comment earlier regarding the markdown text. Can you please take a look? The whole text starting from Invite your account... second bullet 2. Go to *Workspaces is bold.

Screenshot 2025-01-29 at 9 31 53 PM

Also I completed the Invite Accountant flow, I don't see the tasks on the Concierge chat.

Screenshot 2025-01-29 at 9 43 20 PM

@ishpaul777
Copy link
Contributor Author

ishpaul777 commented Jan 29, 2025

Also I completed the Invite Accountant flow, I don't see the tasks on the Concierge chat.

@mananjadhav does your test account includes a + in email. the way logic currently is if you have + in email it will be posted in conceirge chat otherwise it will be posted in admins room of new workspace.

@mananjadhav
Copy link
Collaborator

I did check the #admin room. Let me try with an email with +.

@mananjadhav
Copy link
Collaborator

Sorry I think I messed up the branch or something. The test works fine. @ishpaul777 I am working on the checklist, can you please resolve the conflicts?

@mananjadhav
Copy link
Collaborator

mananjadhav commented Jan 30, 2025

Screenshots/Videos

Android: Native android-invite-accountant
Android: mWeb Chrome mweb-chrome-invite-accountant
iOS: Native ios-invite-accountant
iOS: mWeb Safari mweb-safari-invite-accountant
MacOS: Chrome / Safari
web-invite-accountant-concierge.mp4
web-invite-accountant.mov
MacOS: Desktop desktop-invite-accountant desktop-concierge-steps

@mananjadhav
Copy link
Collaborator

I am having issues with my iOS Mobile Web Safari. The signup API is giving 429 errors abruptly. Finishing the checklist without that, will uploaded it may be later.

@mananjadhav
Copy link
Collaborator

mananjadhav commented Jan 30, 2025

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

Copy link
Collaborator

@mananjadhav mananjadhav left a comment

Choose a reason for hiding this comment

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

Waiting on uploading the mobile web safari screenshot and resolving merge conflicts. Meanwhile @francoisl All yours.

@melvin-bot melvin-bot bot requested a review from francoisl January 30, 2025 18:23
@ishpaul777
Copy link
Contributor Author

I am on it! @mananjadhav

@ishpaul777
Copy link
Contributor Author

it seems like we removed logic for adding the onboarding videos in this issue

#55642 (comment)

Copy link
Contributor

🚧 @francoisl has triggered a test build. You can view the workflow run here.

@francoisl
Copy link
Contributor

it seems like we removed logic for adding the onboarding videos in this issue

#55642 (comment)

👍 I had no idea. Things change too fast 😂

Copy link
Contributor

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/55302/index.html ❌ FAILED ❌
Android The QR code can't be generated, because the iOS build failed
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/55302/NewExpensify.dmg https://55302.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@francoisl
Copy link
Contributor

Ok, tests well for me locally! Going to try to give it a quick run on Android once the ad-hoc build finishes, but so far I think it's ready to merge.

Copy link
Contributor

@francoisl francoisl left a comment

Choose a reason for hiding this comment

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

Working well for me too, let's ship this 🚀

@francoisl francoisl merged commit e39dfbc into Expensify:main Jan 30, 2025
16 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.

@roryabraham
Copy link
Contributor

Hi 👋🏼

Due to an unfortunate mistake, this code has been deleted from main, and this PR needs to be re-created from scratch. There are some additional details in slack here. Feel free to tag me in slack if you have questions. Apologies for the inconvenience 🙇🏼

@ishpaul777
Copy link
Contributor Author

here's the new PR #56141 @francoisl @mananjadhav

@francoisl francoisl mentioned this pull request Jan 31, 2025
50 tasks
@@ -3681,6 +3687,20 @@ function prepareOnboardingOptimisticData(
if (['addAccountingIntegration', 'setupCategoriesAndTags'].includes(task.type) && !userReportedIntegration) {
return false;
}
type SkipViewTourOnboardingChoices = 'newDotSubmit' | 'newDotSplitChat' | 'newDotPersonalSpend' | 'newDotEmployer';
Copy link
Contributor

Choose a reason for hiding this comment

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

@ishpaul777 @mananjadhav I don't think this is a good place to declare type.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants