upcoming: [M3-7430] - Implement Account Switching Functionality #10064

jaalah-akamai · 2024-01-12T19:52:08Z

Description 📝

Presently, there's no way for resellers to seamlessly log into indirect customer accounts. To overcome this obstacle, we aim to introduce a new feature. This feature allows users within the reseller account to choose an indirect customer account, obtaining the EUUID (Entity Unique User ID) in the process. Subsequently, this EUUID becomes instrumental in making a necessary endpoint call, triggering the generation of an ephemeral token allowing for the reseller to authenticate into a proxy account within the main indirect reseller's account. The primary goal of this token is to streamline the transition, providing reseller users with a frictionless experience when logging into the proxy account.

Changes 🔄

Moved the rendering of child accounts into a new component called ChildAccountList.tsx
Implemented functionality / logic to:
- Request ephemeral token to log into the proxy account of a specific indirect customer account.
- Set both reseller and proxy token in local storage to allow for account switching, utilizing the original /authentication/ token as the active account.
- Account for loading and error states if requests fail or tokens expire.
Added unit test for SwitchAccountButton.tsx

Preview 📷

Note

All PAT in this demo have been revoked. 👌

Fetch Proxy Token, Set Storage, Switch Accounts
parent-account-switching.mp4

Note

We will most likely be removing the toast when some of the errors are shown (as in not to show both a notice and a toast). While this is still in draft, I wanted to get some UX input.

Description	Preview
Loading of indirect customer accounts
Error in loading indirect customer accounts
No indirect customer accounts
Error switching to indirect customer accounts	error-switching-to-child.mp4
- Success toast when logging into proxy account - Error if parent token is expired	indirect-customer-login-and-expiry.mp4

How to test 🧪

Important

You won't see any actual UI changes when performing the switch account feature until we're off mocks.

Prerequisites

(How to setup test environment)

Add REACT_APP_PROXY_PAT to your .env file with a temporary PAT that you've created (could be the same account for testing)
Enable Parent / Child Account feature flag
Turn on Mock Service Worker (MSW)
Open dev tools > Application > and clear local storage
Ensure that { user_type: 'parent' } in serverHandlers.ts

Reproduction & Verification steps

(How to reproduce the issue, if applicable)

⭐ Parent View

Open dev tools > Application > and make note of payload under authentication/token
Open user menu in Cloud Manager and click/press "Switch Account"
Select any child account in the list
Observe that tokens have been created for parent/proxy accounts and that:
- Original token has been stored under authentication/parent_token/token
- authentication/token and authentication/proxy_token/token contain the same token indicating we've switched to a proxy account.

⭐ Proxy View: Switching Into Another Proxy

Open dev tools > Application > and make note of token value under authentication/token
Open user menu in Cloud Manager and click/press "Switch Account"
Select any child account in the list
Observe that:
- authentication/parent_token/token remains the same
- authentication/token and authentication/proxy_token/token have new token values

⭐ Proxy View: Switching Back to Parent

Open dev tools > Application > and make note of token value under authentication/token (should still mirror proxy token)
Update user type { user_type: 'proxy' } in serverHandlers.ts
Open user menu in Cloud Manager and click/press "Switch Account"
Select "switch back to your account"
Observe that authentication/token token value matches authentication/parent_token/token

As an Author I have considered 🤔

Check all that apply

jcallahan-akamai · 2024-01-12T22:12:19Z

packages/manager/src/features/Account/SwitchAccountDrawer.tsx

+        const proxyToken = await getProxyToken({ euuid, headers });
+
+        // We don't need to worry about this if we're a proxy user.
+        if (!isProxyUser) {


Minor/nit: the readability of this sequence could be improved slightly IMO– I was confused how we could get a proxy token AS another proxy user. (It became clearer once I saw how the headers argument was used).

Conceptually, maybe the getProxyToken function itself should decide what the headers should be based on whether it's a parent/sibling account? (Instead of taking in arbitrary headers).

Great suggestion - I like that idea! 👍

jaalah-akamai · 2024-01-17T04:17:57Z

packages/manager/src/features/Account/SwitchAccountDrawer.tsx

+        });
+      } catch (error) {
+        setIsProxyTokenError(error as APIError[]);
+        throw error;


This will cause the try block in handleSwitchToChildAccount to error.

jaalah-akamai · 2024-01-17T04:24:33Z

packages/manager/src/features/Account/SwitchAccountDrawer.tsx

+          euuid,
+          token: isProxyUser
+            ? getStorage('authentication/parent_token/token')
+            : currentTokenWithBearer,


For 'proxy' userType, use the stored parent token in the request. Otherwise, if 'parent' use current token.

jaalah-akamai · 2024-01-17T04:25:45Z

packages/manager/src/features/Account/SwitchAccountDrawer.tsx

-  }, [childAccounts, error, isLoading]);
+    updateCurrentTokenBasedOnUserType({ userType: 'parent' });
+    handleClose();
+  }, [handleClose, isProxyUser]);


Switching back to parent is simpler. Validate parent token in local storage and swap to it.

mjac0bs

Here's some more feedback; I will give this an additional pass through to make sure that all loading and error states are addressed once this stuff is addressed.

Noteworthy:

Without a page reload, I don't think we can actually account switch, even if we were off mocks. Updating local storage isn't enough without a refresh. Is that not the case?
We lost a feature flag in canSwitchBetweenParentOrProxyAccount and so there's still a regression in the user menu.

Looks like there's a failure on SwitchAccountDrawer.test.tsx that probably came about when ChildAccountList was pulled out into its own component:

packages/manager/src/features/TopMenu/UserMenu/UserMenu.tsx

packages/manager/src/features/Account/utils.ts

packages/manager/src/features/TopMenu/UserMenu/UserMenu.tsx

packages/manager/src/features/Account/SwitchAccounts/ChildAccountList.tsx

packages/manager/src/features/Account/utils.ts

mjac0bs · 2024-01-17T22:27:37Z

packages/manager/src/features/Account/utils.ts

+  if (userToken) {
+    setStorage('authentication/token', userToken);
+    setStorage('authentication/scopes', userScope);
+    setStorage('authentication/expire', userExpiry);
+  }


In the POC, after swapping the tokens in local storage, we then had to trigger a page reload in order for the account switch to occur. Wouldn't that still be the case here (even though we can't test this yet easily without API returning a valid user_type)?

@mjac0bs I'm using the useHistory as to not force an entire page refresh. We'll have to test this when the API is ready.

I gave that a try back in my old POC branch to try account switching with real accounts off mocks and see what would happen, and wasn't able to successfully account switch so not sure about this. But I've forgotten exactly why it was that we needed the refresh for the new token to take affect, so if you want to leave as is until we can test for certain in the dev environment, that's fine.

mjac0bs · 2024-01-17T22:30:23Z

packages/manager/src/features/Account/SwitchAccountButton.test.tsx

Thanks for adding this!

mjac0bs · 2024-01-17T22:31:29Z

packages/manager/src/features/TopMenu/UserMenu/UserMenu.tsx

+  const userName =
+    (hasParentChildAccountAccess && isProxyUser ? parentProfile : profile)
+      ?.username ?? '';


Much cleaner than the function that was doing this before - thanks!

Co-authored-by: Mariah Jacobs <114685994+mjac0bs@users.noreply.github.com>

…untList.tsx Co-authored-by: Mariah Jacobs <114685994+mjac0bs@users.noreply.github.com>

Co-authored-by: Mariah Jacobs <114685994+mjac0bs@users.noreply.github.com>

github-actions · 2024-01-18T21:01:28Z

Coverage Report: ✅
Base Coverage: 79.95%
Current Coverage: 79.95%

carrillo-erik · 2024-01-19T15:42:59Z

I've verified the switch account flow as described in the reproduction steps. I was able to observe the updates to the authentication/token, authentication/parent_token/token, and authentication/proxy_token/token upon switching accounts. Also, after changing the user_type I verified that authentication/token matched the authentication/parent_token/token.

Regarding the note on the error states, I'm all for removing the toast in favor of displaying an error notice.

jaalah-akamai · 2024-01-19T17:41:09Z

Toasts should be removed for error states 👍

mjac0bs

Thanks for addressing all the little pieces of feedback! 🙌🏼

Confirmed:

When feature flag is off, no regressions in user menu.
When feature flag is on with user_type: null, no regressions in user menu.
When feature flag is on with user_type: child, no regressions in user menu.
When feature flag is on with user_type: parent, user menu displays the parent's company name with a clickable Switch Account button, which opens the Switch Account drawer. Clicking a child account swaps the proxy token into local storage active token as saves the current token as the local storage parent token.
When feature flag is on with user_type: proxy, user menu displays the child's company name with a clickable Switch Account button, which opens the Switch Account drawer. Drawer allows user to select another proxy account or switch back to parent account (swapping parent token into local storage active token).
Switch Account drawer gracefully handles an error when switching to a child account (shows error notice in drawer).
Switch Account drawer gracefully handles loading state and error loading child accounts (shows error copy and Try Again button in drawer, which tries to load accounts again when clicked).
Switch Account drawer gracefully handles error with expired parent token when switching back to parent account from proxy (shows error notice in drawer).
Same behavior as above for the Switch Account button on the Account Landing page.

Notes:

I don't think we have any loading state when clicking a child account and completing the account switch. May be worth adding as a follow up.

This LGTM. I'm still not certain the actual switching will work as expected, as I commented, but we know token swapping is. Looking forward to re-confirming all this with actual API data.

packages/manager/src/features/Account/SwitchAccountDrawer.tsx

jaalah-akamai · 2024-01-19T22:22:50Z

I don't think we have any loading state when clicking a child account and completing the account switch. May be worth adding as a follow up.

I'll make a note, it may get lost with the refresh / switch itself, but something we can test against API.

upcoming: [M3-7430] - Implement Account Switching Functionality

7b89fd3

jaalah-akamai added Work in Progress Parent / Child Account labels Jan 12, 2024

jaalah-akamai self-assigned this Jan 12, 2024

jaalah added 3 commits January 12, 2024 15:09

Move parent token expiry check

3d04000

Update verbiage

a10ca99

Add changeset

4ff97e9

jcallahan-akamai reviewed Jan 12, 2024

View reviewed changes

mjac0bs mentioned this pull request Jan 16, 2024

upcoming: [M3-7475] - Add Switch Account button to Account Landing page #10052

Merged

12 tasks

Review updates. Cleaned up variable names to clarify intent

8629972

jaalah-akamai commented Jan 17, 2024

View reviewed changes

jaalah added 2 commits January 16, 2024 23:21

Remove toasts

20cbaf3

Fix where we get tokens

ce91607

jaalah-akamai commented Jan 17, 2024

View reviewed changes

More cleanup

f533d7c

jaalah-akamai marked this pull request as ready for review January 17, 2024 04:30

jaalah-akamai requested a review from a team as a code owner January 17, 2024 04:30

jaalah-akamai requested review from jdamore-linode and carrillo-erik and removed request for a team January 17, 2024 04:30

jaalah-akamai added Ready for Review and removed Work in Progress labels Jan 17, 2024

jaalah-akamai requested a review from mjac0bs January 17, 2024 04:31

Update variable name

ba332c3

mjac0bs reviewed Jan 17, 2024

View reviewed changes

jaalah-akamai and others added 4 commits January 18, 2024 13:11

Update packages/manager/src/features/Account/utils.ts

789dac9

Co-authored-by: Mariah Jacobs <114685994+mjac0bs@users.noreply.github.com>

Update packages/manager/src/features/Account/utils.ts

be7d508

Co-authored-by: Mariah Jacobs <114685994+mjac0bs@users.noreply.github.com>

Update packages/manager/src/features/Account/SwitchAccounts/ChildAcco…

6815590

…untList.tsx Co-authored-by: Mariah Jacobs <114685994+mjac0bs@users.noreply.github.com>

Update packages/manager/src/features/TopMenu/UserMenu/UserMenu.tsx

de1cab7

Co-authored-by: Mariah Jacobs <114685994+mjac0bs@users.noreply.github.com>

jaalah added 3 commits January 18, 2024 13:21

Review updates

1e20a5f

Merge branch 'develop' of github.com:linode/manager into M3-7430

42eb357

Review updates

60e9a71

jaalah-akamai requested a review from mjac0bs January 18, 2024 21:07

mjac0bs approved these changes Jan 19, 2024

View reviewed changes

packages/manager/src/features/Account/SwitchAccountDrawer.tsx Outdated Show resolved Hide resolved

mjac0bs added the Add'tl Approval Needed Waiting on another approval! label Jan 19, 2024

Review update

1f29290

carrillo-erik approved these changes Jan 23, 2024

View reviewed changes

mjac0bs added Approved Multiple approvals and ready to merge! and removed Add'tl Approval Needed Waiting on another approval! Ready for Review labels Jan 23, 2024

jaalah-akamai merged commit b84275a into linode:develop Jan 23, 2024
18 checks passed

jdamore-linode mentioned this pull request Jan 25, 2024

test: [M3-7516] - Cypress tests for Parent → Child account switching flows #10110

Merged

12 tasks

cpathipa mentioned this pull request Feb 1, 2024

Release v1.111.0 - release → staging #10136

Merged

12 tasks

mjac0bs mentioned this pull request Feb 1, 2024

fix: [M3-7728] - Token issues when account switching #10138

Merged

12 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

upcoming: [M3-7430] - Implement Account Switching Functionality #10064

upcoming: [M3-7430] - Implement Account Switching Functionality #10064

jaalah-akamai commented Jan 12, 2024 •

edited

jcallahan-akamai Jan 12, 2024

jaalah-akamai Jan 17, 2024

jaalah-akamai Jan 17, 2024

jaalah-akamai Jan 17, 2024

jaalah-akamai Jan 17, 2024

mjac0bs left a comment

mjac0bs Jan 17, 2024

jaalah-akamai Jan 18, 2024

mjac0bs Jan 19, 2024

mjac0bs Jan 17, 2024

mjac0bs Jan 17, 2024

github-actions bot commented Jan 18, 2024 •

edited

carrillo-erik commented Jan 19, 2024

jaalah-akamai commented Jan 19, 2024

mjac0bs left a comment •

edited

jaalah-akamai commented Jan 19, 2024 •

edited

upcoming: [M3-7430] - Implement Account Switching Functionality #10064

upcoming: [M3-7430] - Implement Account Switching Functionality #10064

Conversation

jaalah-akamai commented Jan 12, 2024 • edited

Description 📝

Changes 🔄

Preview 📷

How to test 🧪

Prerequisites

Reproduction & Verification steps

As an Author I have considered 🤔

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mjac0bs left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jan 18, 2024 • edited

carrillo-erik commented Jan 19, 2024

jaalah-akamai commented Jan 19, 2024

mjac0bs left a comment • edited

Choose a reason for hiding this comment

jaalah-akamai commented Jan 19, 2024 • edited

jaalah-akamai commented Jan 12, 2024 •

edited

github-actions bot commented Jan 18, 2024 •

edited

mjac0bs left a comment •

edited

jaalah-akamai commented Jan 19, 2024 •

edited