upcoming: [M3-7413] - Update existing user account endpoints and mocks for Parent/Child Account Switching #9942

mjac0bs · 2023-11-28T21:07:26Z

Description 📝

GET /account/users and GET /account/users/<username> requests will return a new user_type field to allow us to distinguish between users.

GET /account/users/<username>/grants will return a new grant type: child_account_access, which will be true for parent accounts with access to child account endpoints.

These additions to existing endpoints set us up to implement account switching and user permissions flows.

Changes 🔄

Updated the User interface and factory to include the new user_type field
Updated the Account interface and Grant factory to include the new child_account_access field
Updated the MSW account/users endpoint to include a child, parent, and proxy user
- IRL, we'd never see all three parent, proxy, and child users on one account, but mocking each user type will allow us to implement the upcoming User & Grants and User Permissions tickets for every user.

Preview 📷

GET /account/users

GET /account/users/<username>

GET /account/users/<username>/grants

How to test 🧪

Prerequisites

(How to setup test environment)

Check out this branch and yarn up.
Turn the Mock Service Worker on.

Verification steps

(How to verify changes)

Open the browser dev tools and navigate to the Network tab.
Go to localhost:3000/accounts/users (the Users & Grants page).
See the internal ticket for a link to the API spec and verify that section 6.2 (existing endpoints) reflects the changes in this PR. Specifically:
- Examine the payload of GET /account/users and verify the user_type field is present and accurate with parent/child/proxy accounts and null in all other cases.
- Visit the ParentUser's permissions page (http://localhost:3000/account/users/ParentUser/permissions) and verify the payload of GET /account/users/<username>/grants returns child_account_access set to true. In all other cases, it should be false.
- Navigate to various users' user/profile or user/permissions pages and verify that GET /account/users/<username> returns the expected value for user_type in the payload.

As an Author I have considered 🤔

Check all that apply

mjac0bs · 2023-11-28T21:08:22Z

packages/api-v4/src/account/types.ts

+  ssh_keys: string[];
+  tfa_enabled: boolean;
+  username: string;
+  user_type: UserType | null;


This is the new user_type field. All of the other changes in the User interface were just reordering.

mjac0bs · 2023-11-28T21:09:50Z

packages/api-v4/src/account/types.ts

@@ -169,6 +172,7 @@ export type GlobalGrantTypes =
  | 'add_longview'
  | 'longview_subscription'
  | 'account_access'
+  | 'child_account_access'


This is the new child_account_access grant that returns true for all admin parent accounts and any additional parent accounts that the admin parent grants permission to access the child accounts.

Not that I am very privy to this architecture, but I was expecting an array of child accounts the parent has access to instead of just a boolean. I know it's handled in another way but just putting this thought out there for posterity.

The array of child accounts will be returned by a new API endpoint, GET /account/child-accounts! This boolean is a new global grant that allows an unrestricted parent account to decide whether or not any other users associated with that parent account (i.e. non-admin, potentially restricted parent account users) will also have access to the data returned in GET /account/child-accounts.

mjac0bs · 2023-11-28T21:11:45Z

packages/manager/src/mocks/serverHandlers.ts

-    return res(ctx.json(profileFactory.build()));
+    return res(ctx.json(accountUserFactory.build()));


This was an existing bug... The mock request to*/account/users/:user was returning profile instead of account data.

mjac0bs · 2023-11-28T21:12:24Z

packages/manager/src/mocks/serverHandlers.ts

+              add_domains: false,
+              add_firewalls: false,
+              add_images: false,
+              add_linodes: false,
+              add_longview: false,
+              add_nodebalancers: false,
+              add_stackscripts: false,
+              add_volumes: false,
+              add_vpcs: false,
+              cancel_account: false,


Proxy accounts have read only permissions by default and cannot be canceled.

mjac0bs · 2023-11-28T21:12:50Z

packages/manager/src/mocks/serverHandlers.ts

+        ctx.json(
+          grantsFactory.build({
+            global: {
+              cancel_account: false,


Child accounts cannot be canceled while they have a user_type of "child".

mjac0bs · 2023-11-28T21:14:07Z

packages/manager/src/mocks/serverHandlers.ts

+              cancel_account: false,
+              child_account_access: true,


Parent accounts cannot be canceled while they have a user_type of "parent". This "admin" parent account has default child_account_access granted.

abailly-akamai

Tested locally and confirmed scenari outlined in PR description

payload of GET /account/users and verify the user_type field is present and accurate with parent/child/proxy accounts and null in all other cases.
ParentUser's permissions page returns child_account_access set to true. In all other cases, it should be false.
other users verify that GET /account/users/ returns the expected value for user_type in the payload.

abailly-akamai · 2023-11-29T16:57:01Z

packages/api-v4/src/account/types.ts

@@ -169,6 +172,7 @@ export type GlobalGrantTypes =
  | 'add_longview'
  | 'longview_subscription'
  | 'account_access'
+  | 'child_account_access'


Not that I am very privy to this architecture, but I was expecting an array of child accounts the parent has access to instead of just a boolean. I know it's handled in another way but just putting this thought out there for posterity.

jaalah-akamai

👪 ✅

mjac0bs added 7 commits November 28, 2023 09:47

Update accountUser factory

46211da

Add mock proxy user; cleanup

6b25bb4

Fix a stray comment from cleanup

254eac2

Add child_account_access grant

e6057da

Add more mocks for different user types

cb784ff

Clean up

56b5898

Use better request urls

a57e4f4

mjac0bs added the Parent / Child Account label Nov 28, 2023

mjac0bs self-assigned this Nov 28, 2023

mjac0bs added 2 commits November 28, 2023 13:18

Undo unintentional change

2c84041

Add changesets

361cc57

mjac0bs commented Nov 28, 2023

View reviewed changes

mjac0bs marked this pull request as ready for review November 28, 2023 21:47

mjac0bs requested a review from a team as a code owner November 28, 2023 21:47

mjac0bs requested review from jdamore-linode, dwiley-akamai and jaalah-akamai and removed request for a team November 28, 2023 21:47

abailly-akamai approved these changes Nov 29, 2023

View reviewed changes

jdamore-linode approved these changes Nov 29, 2023

View reviewed changes

mjac0bs added the @linode/api-v4 Changes are made to the @linode/api-v4 package label Nov 29, 2023

mjac0bs mentioned this pull request Nov 29, 2023

feat: [M3-7412] - Add new Parent/Child api-v4 endpoints #9944

Merged

12 tasks

jaalah-akamai approved these changes Nov 29, 2023

View reviewed changes

mjac0bs merged commit a02081f into linode:develop Nov 29, 2023
13 checks passed

This was referenced Dec 7, 2023

upcoming: [M3-7414] - Add mocks and update queries for new Parent/Child endpoints #9977

Merged

Release v1.108.0 - staging → master #9986

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

upcoming: [M3-7413] - Update existing user account endpoints and mocks for Parent/Child Account Switching #9942

upcoming: [M3-7413] - Update existing user account endpoints and mocks for Parent/Child Account Switching #9942

mjac0bs commented Nov 28, 2023 •

edited

Loading

mjac0bs Nov 28, 2023

mjac0bs Nov 28, 2023

abailly-akamai Nov 29, 2023

mjac0bs Nov 29, 2023

mjac0bs Nov 28, 2023

mjac0bs Nov 28, 2023

mjac0bs Nov 28, 2023

mjac0bs Nov 28, 2023

abailly-akamai left a comment

abailly-akamai Nov 29, 2023

jaalah-akamai left a comment

		return res(ctx.json(profileFactory.build()));
		return res(ctx.json(accountUserFactory.build()));

upcoming: [M3-7413] - Update existing user account endpoints and mocks for Parent/Child Account Switching #9942

upcoming: [M3-7413] - Update existing user account endpoints and mocks for Parent/Child Account Switching #9942

Conversation

mjac0bs commented Nov 28, 2023 • edited Loading

Description 📝

Changes 🔄

Preview 📷

How to test 🧪

Prerequisites

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abailly-akamai left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jaalah-akamai left a comment

Choose a reason for hiding this comment

mjac0bs commented Nov 28, 2023 •

edited

Loading