-
Notifications
You must be signed in to change notification settings - Fork 367
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: [M3-7786] - Convert isRestrictedGlobalGrantType to hook
- Loading branch information
Showing
6 changed files
with
112 additions
and
68 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
69 changes: 69 additions & 0 deletions
69
packages/manager/src/hooks/useRestrictedGlobalGrantCheck.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| import { renderHook } from '@testing-library/react-hooks'; | ||
|
|
||
| import { useRestrictedGlobalGrantCheck } from './useRestrictedGlobalGrantCheck'; | ||
|
|
||
| const queryMocks = vi.hoisted(() => ({ | ||
| useGrants: vi.fn().mockReturnValue({}), | ||
| useProfile: vi.fn().mockReturnValue({}), | ||
| })); | ||
|
|
||
| vi.mock('src/queries/profile', async () => { | ||
| const actual = await vi.importActual('src/queries/profile'); | ||
| return { | ||
| ...actual, | ||
| useGrants: queryMocks.useGrants, | ||
| useProfile: queryMocks.useProfile, | ||
| }; | ||
| }); | ||
|
|
||
| describe('useRestrictedGlobalGrantCheck', () => { | ||
| it('returns true for restricted access with non-permitted grant level', () => { | ||
| queryMocks.useGrants.mockReturnValue({ | ||
| data: { global: { account_access: 'read_only' } }, | ||
| }); | ||
| queryMocks.useProfile.mockReturnValue({ data: { restricted: true } }); | ||
|
|
||
| const { result } = renderHook(() => | ||
| useRestrictedGlobalGrantCheck({ | ||
| globalGrantType: 'account_access', | ||
| permittedGrantLevel: 'read_write', | ||
| }) | ||
| ); | ||
|
|
||
| expect(result.current).toBe(true); | ||
| }); | ||
|
|
||
| it('returns false for unrestricted access with permitted grant level', () => { | ||
| queryMocks.useGrants.mockReturnValue({ | ||
| data: { global: { account_access: 'read_write' } }, | ||
| }); | ||
| queryMocks.useProfile.mockReturnValue({ data: { restricted: false } }); | ||
|
|
||
| const { result } = renderHook(() => | ||
| useRestrictedGlobalGrantCheck({ | ||
| globalGrantType: 'account_access', | ||
| permittedGrantLevel: 'read_write', | ||
| }) | ||
| ); | ||
|
|
||
| expect(result.current).toBe(false); | ||
| }); | ||
|
|
||
| it('returns true for restricted access to non-account_access resource', () => { | ||
| queryMocks.useGrants.mockReturnValue({ | ||
| data: { global: { add_linodes: false } }, | ||
| }); | ||
| queryMocks.useProfile.mockReturnValue({ data: { restricted: true } }); | ||
|
|
||
| const { result } = renderHook(() => | ||
| useRestrictedGlobalGrantCheck({ | ||
| globalGrantType: 'add_linodes', | ||
| permittedGrantLevel: 'read_write', // This param is ignored for non-account_access types | ||
| }) | ||
| ); | ||
|
|
||
| expect(result.current).toBe(true); | ||
| }); | ||
|
|
||
| // Add more tests as needed to cover different scenarios and edge cases | ||
| }); |
31 changes: 31 additions & 0 deletions
31
packages/manager/src/hooks/useRestrictedGlobalGrantCheck.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| import { useGrants, useProfile } from 'src/queries/profile'; | ||
|
|
||
| import type { RestrictedGlobalGrantType } from 'src/features/Account/utils'; | ||
|
|
||
| /** | ||
| * Determine whether the user has restricted access to a specific resource. | ||
| * | ||
| * @example | ||
| * // If account access does not equal 'read_write', the user has restricted access. | ||
| * useRestrictedGlobalGrantCheck({ | ||
| * globalGrantType: 'account_access', | ||
| * permittedGrantLevel: 'read_write', | ||
| * }); | ||
| * // Returns: true | ||
| */ | ||
| export const useRestrictedGlobalGrantCheck = ({ | ||
| globalGrantType, | ||
| permittedGrantLevel, | ||
| }: RestrictedGlobalGrantType): boolean => { | ||
| const { data: grants } = useGrants(); | ||
| const { data: profile } = useProfile(); | ||
|
|
||
| if (globalGrantType !== 'account_access') { | ||
| return Boolean(profile?.restricted) && !grants?.global[globalGrantType]; | ||
| } | ||
|
|
||
| return ( | ||
| Boolean(profile?.restricted) && | ||
| grants?.global[globalGrantType] !== permittedGrantLevel | ||
| ); | ||
| }; |