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

Give users on a domain the ability to join their colleagues when the company is already using Expensify #51681

Merged
merged 25 commits into from
Dec 13, 2024

Conversation

allroundexperts
Copy link
Contributor

@allroundexperts allroundexperts commented Oct 29, 2024

Details

$ #48189

Fixed Issues

$ #48189
PROPOSAL: #48189 (comment)

Tests

This PR is merging in some code that will not be live yet. Please only test the onboarding flows for any regressions.

PLEASE IGNORE TESTS BELOW THIS LINE

  1. Login using an email that is private (Make sure that another user exists on the same private domain and has several workspaces created)
  2. Verify that an onboarding modal appears, asking to input your name.
  3. Enter your name, and verify that after clicking next, you're prompted to enter the OTP.
  4. Enter the OTP, and verify that after clicking next, you're shown a list of workspaces to join.
  5. Join any workspace, and verify that you're redirected to the workspace page.
  • Verify that no errors appear in the JS console

Offline tests

N/A

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 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-11-07.at.2.50.21.AM.mov
Android: mWeb Chrome
Screen.Recording.2024-11-07.at.2.48.24.AM.mov
iOS: Native
Screen.Recording.2024-11-07.at.2.45.43.AM.mov
iOS: mWeb Safari
Screen.Recording.2024-11-07.at.2.42.30.AM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-11-07.at.2.28.30.AM.mov
MacOS: Desktop
Screen.Recording.2024-11-07.at.2.35.28.AM.mov

Copy link
Contributor

github-actions bot commented Oct 29, 2024

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@parasharrajat
Copy link
Member

@allroundexperts looks like you need to sign all the commits.

@allroundexperts
Copy link
Contributor Author

Just trying to make the flow work right now. Will do this as soon as I'm done!

@allroundexperts allroundexperts marked this pull request as ready for review November 6, 2024 22:00
@allroundexperts allroundexperts requested a review from a team as a code owner November 6, 2024 22:00
@melvin-bot melvin-bot bot requested a review from parasharrajat November 6, 2024 22:00
Copy link

melvin-bot bot commented Nov 6, 2024

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

@melvin-bot melvin-bot bot removed the request for review from a team November 6, 2024 22:00
@parasharrajat
Copy link
Member

Testing...

@parasharrajat
Copy link
Member

BUG: Onboarding in running in loops when we skip validation step.

09.11.2024_02.44.23_REC.mp4

src/ONYXKEYS.ts Outdated Show resolved Hide resolved
src/ROUTES.ts Outdated Show resolved Hide resolved
src/libs/actions/Policy/Member.ts Outdated Show resolved Hide resolved
src/libs/actions/User.ts Outdated Show resolved Hide resolved
src/pages/OnboardingPrivateDomain/index.tsx Outdated Show resolved Hide resolved
@allroundexperts
Copy link
Contributor Author

BUG: Onboarding in running in loops when we skip validation step.

09.11.2024_02.44.23_REC.mp4

Fixed.

@marcaaron
Copy link
Contributor

How's this one going?

@allroundexperts
Copy link
Contributor Author

How's this one going?

Addressed all comments. Waiting on the review again.

@parasharrajat
Copy link
Member

Rechecking..

@danielrvidal
Copy link
Contributor

@parasharrajat anything to report back?

@parasharrajat
Copy link
Member

I will drop the next review in the morning. It was supposed to be today but weekend stretched a bit.

Apologies for the delay.

@parasharrajat
Copy link
Member

BUG: Pressing back on the Personal details modal, takes the user to the purpose selection screen. Then Pressing next does not take the user through private domain flow.

Steps:

  1. Login.
  2. Press back arrow on the onboarding modal from the personal details step.
  3. Now select a purpose and complete the flow.

@allroundexperts
Copy link
Contributor Author

BUG: When there are no workspaces to join, the page jumps back to onboarding purpose as expected. But there is an error below. IMO, there should be no error given.

@marcaaron Probably we'll need another API command / or pusher sending some data on OpenApp command to check if there are workspaces available to join for a particular private domain?

@shawnborton
Copy link
Contributor

I'm not following this:

And makes me realize that it's a bit weird to say that there are workspaces to join. But there might not be. So, what do we show in that case?

What is the exact scenario where we tell the user that there are workspaces to join but there actually are none to join?

@marcaaron
Copy link
Contributor

marcaaron commented Dec 11, 2024

@marcaaron Probably we'll need another API command / or pusher sending some data on OpenApp command to check if there are workspaces available to join for a particular private domain?

I'm not sure we want to do that. It's not the fastest thing to look up and doing it for every private domain user could make the app init performance suffer. But more importantly, it doesn't seem like information we should provide to an unvalidated user.

QA Steps:

  1. Signed in as unvalidated user with an email that has a private domain.
  2. Onboarding modal shows
  3. We show this screen
    image
  4. They enter magic code
  5. There are no workspaces to join

So, I'd propose we'd tweak this copy to suggest something like: "Enter your magic code to validate and find out if there are accessible workspaces to join" or "skip".

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.

Leaving a few comments and questions. Going to pull this branch and do some testing. Code LGTM though and AFAICT should be working so I'll see if I can repro any issues locally and make suggestions.

src/libs/actions/Session/index.ts Outdated Show resolved Hide resolved
src/libs/actions/User.ts Outdated Show resolved Hide resolved
@@ -77,6 +78,35 @@ function BaseOnboardingPersonalDetails({currentUserPersonalDetails, shouldUseNat
[onboardingPurposeSelected, onboardingAdminsChatReportID, onboardingPolicyID, route.params?.backTo, activeWorkspaceID, canUseDefaultRooms, isSmallScreenWidth, shouldUseNarrowLayout],
);

useEffect(() => {
const skippedPrivateDomainFlow = isPrivateDomain && onboardingPurposeSelected;
Copy link
Contributor

Choose a reason for hiding this comment

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

Please add a comment to that effect to explain why that would be the case since I agree it's not very obvious.

@marcaaron
Copy link
Contributor

@parasharrajat the flow described here is weird, but not really sure it's something a user would do. Sign in with the same account on our staging server in the middle of the flow? What would compel them? 😄

@marcaaron
Copy link
Contributor

marcaaron commented Dec 11, 2024

BUG: On web, I don't see the onboarding flow after login. I have to refresh the page to see the flow.

Not seeing this at all on dev FWIW so maybe there is an undeployed fix or it's not happening anymore. I am also able to get this to appear on staging so maybe it is something related to the private domain mail service we are using to test this.

@marcaaron
Copy link
Contributor

BUG: When there are no workspaces to join, the page jumps back to onboarding purpose as expected. But there is an error below. IMO, there should be no error given.

I did not encounter this error anymore.

This flow seems to work pretty well except for the case where the user has no policies to join could be smoother.

Let's keep moving on this?

This still needs to be fixed @allroundexperts

Screenshot 2024-12-11 at 1 46 57 PM

@parasharrajat
Copy link
Member

#51681 (comment)

I agree this is something that is unusual. I was trying to mimic the behaviour where the user would drop the onboarding and try to login again with the same email after some time(where the browser cache got cleared).

@allroundexperts
Copy link
Contributor Author

So, I'd propose we'd tweak this copy to suggest something like: "Enter your magic code to validate and find out if there are accessible workspaces to join" or "skip".

Do we have an agreement on this @marcaaron from the design team as well?

@marcaaron
Copy link
Contributor

@allroundexperts not yet, but let's fix the bug with the indicator without delay. We can do a follow up to improve the flow design if there are any issues. This one has been open a bit longer than anticipated. Let's push forward.

@allroundexperts
Copy link
Contributor Author

BUG: Onboarding in running in loops when we skip validation step.

09.11.2024_02.44.23_REC.mp4

Fixed.

@allroundexperts
Copy link
Contributor Author

allroundexperts commented Dec 12, 2024

@marcaaron Disabled the private domain flow by default as agreed in the channel. To enable it, just uncomment this.

@marcaaron
Copy link
Contributor

marcaaron commented Dec 13, 2024

Cool. I think with the new design we will have something like user.hasAccessibleDomainPolicies and so we won't need that method but it's fine we can clean it up in the next PR.

marcaaron
marcaaron previously approved these changes Dec 13, 2024
@marcaaron
Copy link
Contributor

marcaaron commented Dec 13, 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 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: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@marcaaron
Copy link
Contributor

I'm going to push this through so we can focus on the next steps.

Attn QA: Please just test the existing onboarding flow for regressions. But also keep in mind, there is a known issue that seems to be preventing the onboarding modal from showing up in certain cases that is still being investigated outside of this PR.

@marcaaron marcaaron self-requested a review December 13, 2024 22:06
@marcaaron marcaaron merged commit d59c91c into Expensify:main Dec 13, 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.77-0 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅
🤖🔄 android HybridApp 🤖🔄 success ✅
🍎🔄 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.

7 participants