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

Optimistic update for moving tasks for "Manage Team's Expenses" to #admins room #52314

Merged
merged 35 commits into from
Dec 2, 2024

Conversation

c3024
Copy link
Contributor

@c3024 c3024 commented Nov 11, 2024

Explanation of Change

This PR moves the onboarding tasks to #admins room.

Fixed Issues

$ #51443
PROPOSAL: NA

Tests

  1. Logon to ND with a new account.
  2. Click on "Manage my team's expenses" intent on the onboarding flow and complete the onboarding.
  3. Verify that the onboarding tasks show up in the #admins room.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

Same as Tests

  • 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
guideAndroid.mp4
Android: mWeb Chrome
Screenrecorder-2024-11-26-14-13-37-829.mp4
iOS: Native
guideiOS.mp4
iOS: mWeb Safari
guideiOSmWeb-compressed.mp4
MacOS: Chrome / Safari
guideChrome.mp4
MacOS: Desktop
guideDesktop.mp4

@c3024 c3024 changed the title [WIP] Optimistic update for moving tasks for "Manage Team's Expenses" to #admins room Optimistic update for moving tasks for "Manage Team's Expenses" to #admins room Nov 12, 2024
@c3024
Copy link
Contributor Author

c3024 commented Nov 12, 2024

moveTasksToAdminsRoom.mp4

@@ -3437,10 +3437,10 @@ function completeOnboarding(
}

const integrationName = userReportedIntegration ? CONST.ONBOARDING_ACCOUNTING_MAPPING[userReportedIntegration] : '';
const actorAccountID = CONST.ACCOUNT_ID.CONCIERGE;
const targetChatReport = ReportUtils.getChatByParticipants([actorAccountID, currentUserAccountID]);
const actorAccountID = engagementChoice === CONST.ONBOARDING_CHOICES.MANAGE_TEAM ? CONST.ACCOUNT_ID.QA_GUIDE : CONST.ACCOUNT_ID.CONCIERGE;
Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

These are required for generating optimistic actions.

However, I will remove it from the params passed to CompleteGuidedSetup if it is not used in the backend.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removing this from the params of the API request pushes the "Here are some important tasks" message generated from frontend below the tasks for some reason.

Screenshot 2024-11-19 at 12 02 59 PM

@c3024 c3024 marked this pull request as ready for review November 19, 2024 06:35
@c3024 c3024 requested a review from a team as a code owner November 19, 2024 06:35
@melvin-bot melvin-bot bot requested review from jjcoffee and removed request for a team November 19, 2024 06:35
Copy link

melvin-bot bot commented Nov 19, 2024

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

src/CONST.ts Outdated
@@ -2093,6 +2094,7 @@ const CONST = {
NOTIFICATIONS: Number(Config?.EXPENSIFY_ACCOUNT_ID_NOTIFICATIONS ?? 11665625),
PAYROLL: Number(Config?.EXPENSIFY_ACCOUNT_ID_PAYROLL ?? 9679724),
QA: Number(Config?.EXPENSIFY_ACCOUNT_ID_QA ?? 3126513),
QA_GUIDE: Number(Config?.EXPENSIFY_ACCOUNT_ID_QA_GUIDE ?? 14365522),
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This seems to be not a problem anymore. CreateWorkspace does not still return a personal detail for qa.guide. So, I retained this for the optimistic detail update.

We can use Concierge or currentUserAccountID instead of qa.guide for the optimistic report action generation. Backend overwrites these with qa.guide as the actor.

Copy link
Contributor

Choose a reason for hiding this comment

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

Can you try to use the guide's details that are sent along with their intro message following the call to CreatePolicy earlier in the guided setup flow?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

When I checked this last time, CreateWorkspace was not returning qa.guide details. Let me check now again.

Copy link
Contributor Author

@c3024 c3024 Nov 23, 2024

Choose a reason for hiding this comment

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

@yuwenmemon

CompleteGuidedSetup returns the assigned guide details. These optimistic task report actions etc. are created just after clicking on the accounting step and the assigned guide details are not available at that time.

The sender appears for the tasks as qa.guide briefly before they are replaced with the actual guide details sent in the response for CompleteGuidedSetup.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

guideDetailOnCompleteGuidedSetup.mov

Copy link
Contributor

Choose a reason for hiding this comment

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

Look closer at that CreateWorkspace response. You should see that you have the email of the assigned guide:
Screenshot 2024-11-25 at 11 00 32 AM

Please do not use the qa.guide account as a placeholder. It is an internal testing account and should never be seen by the end user.

@@ -43,6 +43,20 @@ function BaseOnboardingEmployees({shouldUseNativeStyles, route}: BaseOnboardingE
});
}, [translate, selectedCompanySize]);

const [allPersonalDetails] = useOnyx(ONYXKEYS.PERSONAL_DETAILS_LIST);

const setOptimticQAGuidePersonalDetail = () => {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This too is for the optimistic generation of report actions because CreateWorkspace's response still does not have the personal detail value for qa.guide. This can be omitted if we use Concierge or currentUserAccountID as the actor for the optimistic report actions. The actor is overwritten with qa.guide in backend's response.

@@ -3437,10 +3437,10 @@ function completeOnboarding(
}

const integrationName = userReportedIntegration ? CONST.ONBOARDING_ACCOUNTING_MAPPING[userReportedIntegration] : '';
const actorAccountID = CONST.ACCOUNT_ID.CONCIERGE;
const targetChatReport = ReportUtils.getChatByParticipants([actorAccountID, currentUserAccountID]);
const actorAccountID = engagementChoice === CONST.ONBOARDING_CHOICES.MANAGE_TEAM ? CONST.ACCOUNT_ID.QA_GUIDE : CONST.ACCOUNT_ID.CONCIERGE;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removing this from the params of the API request pushes the "Here are some important tasks" message generated from frontend below the tasks for some reason.

Screenshot 2024-11-19 at 12 02 59 PM

@jjcoffee
Copy link
Contributor

@c3024 Is this ready for testing online or should I only be testing offline for now?

@c3024
Copy link
Contributor Author

c3024 commented Nov 19, 2024

This is ready for testing online too!

@jjcoffee

This comment was marked as resolved.

@c3024
Copy link
Contributor Author

c3024 commented Nov 26, 2024

@yuwenmemon
Thank you! Removed the QA guide placeholders. Now, using the guide details sent.

@jjcoffee
Uploaded all videos.

@jjcoffee
Copy link
Contributor

I guess the only thing outstanding now is waiting for the BE change to accept whatever we send from FE to avoid duplication?

This will change shortly, and we'll send the updated message reflected in the mocks.

@yuwenmemon
Copy link
Contributor

Let's send only the tasks in order to not have duplicates. Let the guide message come from the backend.

const [introSelected] = useOnyx(ONYXKEYS.NVP_INTRO_SELECTED);
const session = useSession();

// A guide is assigned to the user if they choose the 'MANAGE_TEAM' onboarding option, except for users with emails containing '+'.
Copy link
Contributor

Choose a reason for hiding this comment

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

@c3024 I was thinking of something a bit more concise like "Guides are assigned for the MANAGE_TEAM onboarding action, except for emails that have +.". I think the rest is self-explanatory/easy to understand from a quick read of the code.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done!

@@ -3489,10 +3490,29 @@ function prepareOnboardingOptimisticData(
}
}

// A guide is assigned to the user if they choose the 'MANAGE_TEAM' onboarding option, except for users with emails containing '+'.
Copy link
Contributor

Choose a reason for hiding this comment

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

@c3024 Also could you make this one similarly more concise.

@jjcoffee
Copy link
Contributor

@yuwenmemon Just to check the expected result, if we're offline before CreateWorkspace, here's what we'll get:

image

@c3024
Copy link
Contributor Author

c3024 commented Nov 27, 2024

@yuwenmemon Just to check the expected result, if we're offline before CreateWorkspace, here's what we'll get:

image

If we go offline before receiving the CreateWorkspace response, we do not have the guide's email. So, I used the "Setup Specialist" as the placeholder name for this case because I saw in some cases, the guide's name is shown as "Setup Specialist - <Guide's name>". Let me know if we wanna use a different placeholder.

Copy link
Contributor

@jjcoffee jjcoffee left a comment

Choose a reason for hiding this comment

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

All good from my side, just this comment for you to check @yuwenmemon.

@melvin-bot melvin-bot bot requested a review from yuwenmemon November 27, 2024 10:37
@yuwenmemon
Copy link
Contributor

Think that's fine for now yeah!

@yuwenmemon yuwenmemon merged commit 473822d into Expensify:main Dec 2, 2024
18 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Dec 2, 2024

✋ 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

github-actions bot commented Dec 2, 2024

🚀 Deployed to staging by https://github.com/yuwenmemon in version: 9.0.70-0 🚀

platform result
🤖 android 🤖 false ❌
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅
🤖🔄 android HybridApp 🤖🔄 success ✅
🍎🔄 iOS HybridApp 🍎🔄 success ✅

Copy link
Contributor

github-actions bot commented Dec 4, 2024

🚀 Deployed to production by https://github.com/AndrewGable in version: 9.0.70-9 🚀

platform result
🤖 android 🤖 skipped 🚫
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅
🤖🔄 android HybridApp 🤖🔄 failure ❌
🍎🔄 iOS HybridApp 🍎🔄 failure ❌

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.

5 participants