refactor: [M3-7687] - Linodes Restricted User Experience 2/2 by jaalah-akamai · Pull Request #10227 · linode/manager

jaalah-akamai · 2024-02-23T20:53:36Z

Description 📝

Overall improvement to the Linode restricted experience. This PR disables lot's of buttons and fields that a user doesn't have access to.

Changes 🔄

Removed the banners from beneath each tab on the Linodes detail page since we will display an overall banner at the top of the page.
If you don't have add_linodes grant, we disable create buttons. If you do have the grant, you will be able to initiate the creation of Linodes, as well as manage those you have personally established. However, restrictions may still apply for modifying of Linodes configured by the administrator.

Target release date 🗓️

03/04/2024

Preview 📷

BEFORE

AFTER

How to test 🧪

Prerequisites

(How to setup test environment)

Log into two accounts side by side:
- An unrestricted admin user account: full access
- A restricted user account (use Incognito for this)
  - Start with Read Only for everything

Reproduction steps

(How to reproduce the issue, if applicable)

Create a linode from an unrestricted admin account and give your restricted user view only access.
Observe that before changes, a user can attempt to edit/modify linodes that they don't have access to edit/modify and they will get denied by the API. This is what we're looking to prevent.

Verification steps

(How to verify changes)

Verify that restricted users can access only what they have permissions for.
Verify that navigating via URL still display correct banners

As an Author I have considered 🤔

Check all that apply

jaalah-akamai · 2024-02-23T20:57:00Z

packages/manager/src/components/EmptyLandingPageResources/ResourcesSection.tsx

  children: string;
+  disabled?: boolean;
  onClick: () => void;
+  tooltipText?: string;


These are conditional props to disable the empty state landing page button

jaalah-akamai · 2024-02-23T21:02:05Z

packages/manager/src/features/Linodes/LinodeEntityDetail.tsx

+            resourceType: 'Linodes',
+          })}
+          important
+          variant="warning"


New page level notice

jaalah-akamai · 2024-02-23T21:02:25Z

packages/manager/src/features/Linodes/LinodeEntityDetail.tsx

+        }
+        footer={
+          <LinodeEntityDetailFooter
+            isLinodesReadOnly


New prop... rest of this file is unchanged

jaalah-akamai · 2024-02-23T21:05:55Z

packages/manager/src/features/Linodes/LinodesDetail/LinodeBackup/BackupsPlaceholder.tsx


  return (
    <>
-      {disabled && <LinodePermissionsError />}


No longer need notice here - it's at page level (same with similar deletions)

jaalah-akamai · 2024-02-23T21:09:13Z

...res/Linodes/LinodesDetail/LinodeNetworking/NetworkingSummaryPanel/NetworkingSummaryPanel.tsx


  return (
-    <>
-      {readOnly && <LinodePermissionsError />}


Removed notice and fragment - otherwise unchanged - no additions in this file

jaalah-akamai · 2024-02-23T21:10:03Z

packages/manager/src/features/Linodes/LinodesDetail/LinodeResize/LinodeResize.tsx

    >
      <form onSubmit={formik.handleSubmit}>
-        {unauthorized && <LinodePermissionsError />}
+        {isLinodesReadOnly && <LinodePermissionsError />}


This is a drawer, so we're keeping the error notice.

packages/manager/src/features/Linodes/LinodesDetail/LinodeStorage/LinodeVolumes.tsx

jaalah-akamai · 2024-02-23T21:16:19Z

packages/manager/src/features/Linodes/LinodesLanding/LinodesLanding.tsx


+    const isLinodesReadOnly =
+      Boolean(profile.data?.restricted) &&
+      !grants.data?.global?.['add_linodes'];


Class component 😢 Otherwise I'd use our hook.

jaalah-akamai · 2024-02-23T21:17:01Z

packages/manager/src/utilities/linodes.ts

-  );
-
-  return linodeGrants ? linodeGrants.permissions : 'read_write';
-};


🗑️ 🧹

mjac0bs

Most everything looks to be disabled correctly.

I'm seeing the unit test failures on ImageAndPassword.test.tsx and I'm a bit confused why they're happening. It seems like that component is only used in the Create Disk Drawer, which isn't accessible to a restricted user because the Add a Disk button is disabled and you can't reach it by URL. It's complaining that it's getting the wrong error message.

packages/manager/src/components/TagCell/TagCell.tsx

jaalah-akamai · 2024-02-29T18:50:26Z

Other tag-related UX changes are being tackled by @hkhalil-akamai

github-actions · 2024-02-29T19:28:51Z

Coverage Report: ✅
Base Coverage: 81.38%
Current Coverage: 81.39%

mjac0bs

Thanks for doing this, I know disabling everything can be tedious. Tests look good now; the one CI e2e failure looks unrelated on resize-volume.spec, which passes locally. Approving pending a couple minor things are addressed.

Here are the last things I found:

Creating a linode from a backup allows you to select a linode and backup. The similiar clone flow disables the selections for the radio button and card.

In the Create flow, Firewall selection dropdown is not disabled, which differs from other selections in the form (e.g. VPC).

When a user has read/write privileges on Volumes but not linodes, they can attempt to attach or detach a linode from the volumes landing action menu and receive the following errors. Do we also want to disable those action menu items for those actions tied to another resource that is read only?

packages/manager/.changeset/pr-10227-tech-stories-1708986866364.md

mjac0bs · 2024-03-01T17:18:10Z

packages/manager/src/components/TagsPanel/TagsPanel.tsx

    isLoading: userTagsLoading,
  } = useTagSuggestions(!profile?.restricted);

+  const isLinodesReadOnly = useIsResourceRestricted({


Can we consider naming this const/prop isLinodesGrantReadOnly throughout all of these files to make it more clear that that's what we're also checking to disable everything?

packages/manager/src/features/Linodes/LinodesDetail/LinodeStorage/LinodeVolumes.tsx

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

…-7687-v2

jaalah-akamai · 2024-03-01T20:25:58Z

I just have some tests to fix up, but thanks for those catches on this complex flow!

jaalah-akamai · 2024-03-01T20:59:23Z

If you cannot add Linodes, it doesn't matter if you own the resource in this case, we'll just disable everything.

hana-akamai

It seems that tags are incorrectly disabled for unrestricted accounts and r/w Linodes

…eature/namespace-create * 'develop' of https://github.com/vrajesh73/manager: (89 commits) fix: [M3-7269] - Display parent email in user menu when no company name is available for restricted parent user (linode#10248) fix: [M3-7817] - Show correct status of Child Account Enabled column for parent users (linode#10233) upcoming: [M3-7616] - Add Placement Groups Events and Notifications (linode#10221) upcoming: [M3-7816-v2] - Adjust logic for when to show Switch Account button (linode#10266) fix: [M3-7831] - Persisting error messages in ACLB delete dialogs (linode#10254) upcoming: [M3-7842] - Update Assign Linode Drawer and improve query skipping (linode#10263) upcoming: [M3-7704] - Disable Cloning, Private IP, Backups for edge regions (linode#10222) test: Fix test flake for Images landing page test (linode#10267) fix: [M3-7824] - ACLB TCP Rule Creation and other fixes (linode#10264) refactor: [M3-7687] - Linodes Restricted User Experience 2/2 (linode#10227) test: Resolve OBJ create and delete E2E test flake (linode#10245) upcoming: [M3-7723] - Placement Group feature flag as object (linode#10256) chore(deps): Bump sanitize-html from 2.11.0 to 2.12.1 (linode#10247) change: [M3-7813] - Allow the disabling of the TypeToConfirm input (linode#10251) upcoming: [M3-7839] - Change Business Partner to Parent User (linode#10259) upcoming: [M3-7835] - Adjust user table column count (linode#10252) upcoming: [M3 7738] - Update Placement Group Create & Edit Drawers (linode#10205) refactor: [M3-7437] - Use `@lukemorales/query-key-factory` for Profile Queries (linode#10241) fix: React Query `updateInPaginatedStore` helper function not working as expected (linode#10249) test: [M3-7497] - Add tests for child user verification banner (linode#10204) ... # Conflicts: # packages/manager/src/MainContent.tsx # packages/manager/src/dev-tools/FeatureFlagTool.tsx

refactor: [M3-7687] - Linodes Restricted User Experience 2/2

a9f7edd

jaalah-akamai added the Restricted User Access Improve UX surrounding restricted access to features label Feb 23, 2024

jaalah-akamai self-assigned this Feb 23, 2024

jaalah-akamai commented Feb 23, 2024

View reviewed changes

jaalah-akamai added the Work in Progress label Feb 23, 2024

Added changeset: Overall improvement to Linodes restricted experience.

fced8ed

jaalah-akamai added Ready for Review and removed Work in Progress labels Feb 26, 2024

jaalah-akamai marked this pull request as ready for review February 26, 2024 22:34

jaalah-akamai requested a review from a team as a code owner February 26, 2024 22:34

jaalah-akamai requested review from hana-akamai and jdamore-linode and removed request for a team February 26, 2024 22:34

mjac0bs self-requested a review February 27, 2024 17:46

mjac0bs reviewed Feb 28, 2024

View reviewed changes

packages/manager/src/components/TagCell/TagCell.tsx Show resolved Hide resolved

Review updates

a544c82

Get latest

e095f63

mjac0bs self-requested a review March 1, 2024 16:23

mjac0bs approved these changes Mar 1, 2024

View reviewed changes

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

jaalah-akamai and others added 3 commits March 1, 2024 14:22

Update packages/manager/.changeset/pr-10227-tech-stories-170898686636…

6d7d1dc

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

Card view

74ef4a4

Merge branch 'M3-7687-v2' of github.com:jaalah-akamai/manager into M3…

b83b7fa

…-7687-v2

jaalah added 2 commits March 1, 2024 15:40

Remove overly broad tests

5c64517

Revert some stuff

a4a3552

hana-akamai reviewed Mar 6, 2024

View reviewed changes

Review update

a985ffd

hana-akamai approved these changes Mar 7, 2024

View reviewed changes

hana-akamai added Approved Multiple approvals and ready to merge! and removed Add'tl Approval Needed Waiting on another approval! Ready for Review labels Mar 7, 2024

jaalah-akamai merged commit 491c106 into linode:develop Mar 7, 2024

hkhalil-akamai mentioned this pull request Mar 11, 2024

fix: [M3-7862] - Fix display of TagsPanel in read-only entities #10275

Merged

12 tasks

This was referenced Mar 18, 2024

Release v1.115.0 - release → staging #10292

Merged

Release v1.115.0 - staging → master #10293

Merged

Conversation

jaalah-akamai commented Feb 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description 📝

Changes 🔄

Target release date 🗓️

Preview 📷

BEFORE

AFTER

How to test 🧪

Prerequisites

Reproduction steps

Verification steps

As an Author I have considered 🤔

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mjac0bs left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jaalah-akamai commented Feb 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Feb 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mjac0bs left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jaalah-akamai commented Mar 1, 2024

Uh oh!

jaalah-akamai commented Mar 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hana-akamai left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jaalah-akamai commented Feb 23, 2024 •

edited

Loading

jaalah-akamai commented Feb 29, 2024 •

edited

Loading

github-actions bot commented Feb 29, 2024 •

edited

Loading

jaalah-akamai commented Mar 1, 2024 •

edited

Loading