Uh oh!
There was an error while loading. Please reload this page.
fix(clerk-js): Hide Members page of OrgProfile if user doesn't have any member related permissions#2138
Uh oh!
There was an error while loading. Please reload this page.
There are no files selected for viewing
This file contains hidden or 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,5 @@ | ||
| --- | ||
| '@clerk/clerk-js': patch | ||
| --- | ||
| Hide members page of <OrganizationProfile/> if user doesn't have any membership related permissions. |
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 |
|---|---|---|
| @@ -70,7 +70,7 @@ describe('OrganizationMembers', () => { | ||
| f.withOrganizations(); | ||
| f.withUser({ | ||
| email_addresses: ['test@clerk.com'], | ||
| organization_memberships: [{ name: 'Org1', permissions: ['org:sys_memberships:read'] }], | ||
| }); | ||
| }); | ||
| @@ -85,6 +85,26 @@ describe('OrganizationMembers', () => { | ||
| }); | ||
| }); | ||
| it('does not show members tab or navbar route if user is lacking permissions', async () => { | ||
| const { wrapper, fixtures } = await createFixtures(f => { | ||
| f.withOrganizations(); | ||
| f.withUser({ | ||
| email_addresses: ['test@clerk.com'], | ||
| organization_memberships: [{ name: 'Org1', permissions: [] }], | ||
| }); | ||
| }); | ||
| fixtures.clerk.organization?.getRoles.mockRejectedValue(null); | ||
| const { queryByRole } = render(<OrganizationMembers />, { wrapper }); | ||
| await waitFor(() => { | ||
| expect(queryByRole('tab', { name: 'Members' })).not.toBeInTheDocument(); | ||
| expect(queryByRole('tab', { name: 'Invitations' })).not.toBeInTheDocument(); | ||
| expect(queryByRole('tab', { name: 'Requests' })).not.toBeInTheDocument(); | ||
| }); | ||
| }); | ||
| it('navigates to invite screen when user clicks on Invite button', async () => { | ||
| const { wrapper, fixtures } = await createFixtures(f => { | ||
| f.withOrganizations(); | ||
This file contains hidden or 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 |
|---|---|---|
| @@ -53,4 +53,24 @@ describe('OrganizationProfile', () => { | ||
| expect(getByText('Custom1')).toBeDefined(); | ||
| expect(getByText('ExternalLink')).toBeDefined(); | ||
| }); | ||
| it('removes member nav item if user is lacking permissions', async () => { | ||
| const { wrapper } = await createFixtures(f => { | ||
| f.withOrganizations(); | ||
| f.withUser({ | ||
| email_addresses: ['test@clerk.com'], | ||
| organization_memberships: [ | ||
| { | ||
| name: 'Org1', | ||
| permissions: [], | ||
| }, | ||
| ], | ||
| }); | ||
| }); | ||
| const { queryByText } = render(<OrganizationProfile />, { wrapper }); | ||
| expect(queryByText('Org1')).toBeInTheDocument(); | ||
| expect(queryByText('Members')).not.toBeInTheDocument(); | ||
| expect(queryByText('Settings')).toBeInTheDocument(); | ||
| }); | ||
| }); | ||
This file contains hidden or 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 |
|---|---|---|
| @@ -22,12 +22,13 @@ export const OrganizationMembers = withCardStateProvider(() => { | ||
| const { organizationSettings } = useEnvironment(); | ||
| const card = useCardState(); | ||
| const { isAuthorizedUser: canManageMemberships } = useGate({ permission: 'org:sys_memberships:manage' }); | ||
| const { isAuthorizedUser: canReadMemberships } = useGate({ permission: 'org:sys_memberships:read' }); | ||
| const isDomainsEnabled = organizationSettings?.domains?.enabled; | ||
| const { membershipRequests } = useCoreOrganization({ | ||
| membershipRequests: isDomainsEnabled || undefined, | ||
| }); | ||
| // @ts-expect-error This property is not typed. It is used by our dashboard in order to render a billing widget. | ||
| const { __unstable_manageBillingUrl } = useOrganizationProfileContext(); | ||
| if (canManageMemberships === null) { | ||
| @@ -55,7 +56,9 @@ export const OrganizationMembers = withCardStateProvider(() => { | ||
| </Header.Root> | ||
| <Tabs> | ||
| <TabsList> | ||
| {canReadMemberships && ( | ||
| <Tab localizationKey={localizationKeys('organizationProfile.membersPage.start.headerTitle__members')} /> | ||
| )} | ||
| {canManageMemberships && ( | ||
| <Tab | ||
| localizationKey={localizationKeys('organizationProfile.membersPage.start.headerTitle__invitations')} | ||
| @@ -68,18 +71,20 @@ export const OrganizationMembers = withCardStateProvider(() => { | ||
| )} | ||
| </TabsList> | ||
| <TabPanels> | ||
| {canReadMemberships && ( | ||
| <TabPanel sx={{ width: '100%' }}> | ||
| <Flex | ||
| gap={4} | ||
| direction='col' | ||
| sx={{ | ||
| width: '100%', | ||
| }} | ||
| > | ||
| {canManageMemberships && __unstable_manageBillingUrl && <MembershipWidget />} | ||
| <ActiveMembersList /> | ||
| </Flex> | ||
| </TabPanel> | ||
| )} | ||
| {canManageMemberships && ( | ||
| <TabPanel sx={{ width: '100%' }}> | ||
| <OrganizationMembersTabInvitations /> | ||
This file contains hidden or 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 |
|---|---|---|
| @@ -1,5 +1,7 @@ | ||
| import React from 'react'; | ||
| import { useGate } from '../../../ui/common'; | ||
| import { ORGANIZATION_PROFILE_NAVBAR_ROUTE_ID } from '../../../ui/constants'; | ||
| import { useCoreOrganization, useOrganizationProfileContext } from '../../contexts'; | ||
| import { Breadcrumbs, NavBar, NavbarContextProvider, OrganizationPreview } from '../../elements'; | ||
| import type { PropsOfComponent } from '../../styledSystem'; | ||
| @@ -10,6 +12,17 @@ export const OrganizationProfileNavbar = ( | ||
| const { organization } = useCoreOrganization(); | ||
| const { pages } = useOrganizationProfileContext(); | ||
| const { isAuthorizedUser: allowMembersRoute } = useGate({ | ||
| some: [ | ||
| { | ||
| permission: 'org:sys_memberships:read', | ||
| }, | ||
| { | ||
| permission: 'org:sys_memberships:manage', | ||
| }, | ||
| ], | ||
| }); | ||
| if (!organization) { | ||
| return null; | ||
| } | ||
| @@ -24,7 +37,11 @@ export const OrganizationProfileNavbar = ( | ||
| sx={t => ({ margin: `0 0 ${t.space.$4} ${t.space.$2}` })} | ||
| /> | ||
| } | ||
| routes={pages.routes.filter( | ||
| r => | ||
| r.id !== ORGANIZATION_PROFILE_NAVBAR_ROUTE_ID.MEMBERS || | ||
| (r.id === ORGANIZATION_PROFILE_NAVBAR_ROUTE_ID.MEMBERS && allowMembersRoute), | ||
| )} | ||
| contentRef={props.contentRef} | ||
| /> | ||
| {props.children} | ||
This file contains hidden or 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 |
|---|---|---|
| @@ -129,7 +129,12 @@ export const OrganizationProfileRoutes = (props: PropsOfComponent<typeof Profile | ||
| </Gate> | ||
| </Route> | ||
| <Route index> | ||
| <Gate | ||
| some={[{ permission: 'org:sys_memberships:read' }, { permission: 'org:sys_memberships:manage' }]} | ||
| redirectTo={isSettingsPageRoot ? '../' : './organization-settings'} | ||
| > | ||
| <OrganizationMembers /> | ||
| </Gate> | ||
| </Route> | ||
| </Switch> | ||
| </Route> | ||
This file contains hidden or 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 |
|---|---|---|
| @@ -70,7 +70,7 @@ describe('OrganizationMembers', () => { | ||
| f.withOrganizations(); | ||
| f.withUser({ | ||
| email_addresses: ['test@clerk.com'], | ||
| organization_memberships: [{ name: 'Org1', permissions: ['org:sys_memberships:read'] }], | ||
| }); | ||
| }); | ||
| @@ -85,6 +85,26 @@ describe('OrganizationMembers', () => { | ||
| }); | ||
| }); | ||
| it('does not show members tab or navbar route if user is lacking permissions', async () => { | ||
| const { wrapper, fixtures } = await createFixtures(f => { | ||
| f.withOrganizations(); | ||
| f.withUser({ | ||
| email_addresses: ['test@clerk.com'], | ||
| organization_memberships: [{ name: 'Org1', permissions: [] }], | ||
| }); | ||
| }); | ||
| fixtures.clerk.organization?.getRoles.mockRejectedValue(null); | ||
| const { queryByRole } = render(<OrganizationMembers />, { wrapper }); | ||
| await waitFor(() => { | ||
| expect(queryByRole('tab', { name: 'Members' })).not.toBeInTheDocument(); | ||
| expect(queryByRole('tab', { name: 'Invitations' })).not.toBeInTheDocument(); | ||
| expect(queryByRole('tab', { name: 'Requests' })).not.toBeInTheDocument(); | ||
| }); | ||
| }); | ||
| it('navigates to invite screen when user clicks on Invite button', async () => { | ||
| const { wrapper, fixtures } = await createFixtures(f => { | ||
| f.withOrganizations(); | ||
This file contains hidden or 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 |
|---|---|---|
| @@ -53,4 +53,24 @@ describe('OrganizationProfile', () => { | ||
| expect(getByText('Custom1')).toBeDefined(); | ||
| expect(getByText('ExternalLink')).toBeDefined(); | ||
| }); | ||
| it('removes member nav item if user is lacking permissions', async () => { | ||
| const { wrapper } = await createFixtures(f => { | ||
| f.withOrganizations(); | ||
| f.withUser({ | ||
| email_addresses: ['test@clerk.com'], | ||
| organization_memberships: [ | ||
| { | ||
| name: 'Org1', | ||
| permissions: [], | ||
| }, | ||
| ], | ||
| }); | ||
| }); | ||
| const { queryByText } = render(<OrganizationProfile />, { wrapper }); | ||
| expect(queryByText('Org1')).toBeInTheDocument(); | ||
| expect(queryByText('Members')).not.toBeInTheDocument(); | ||
| expect(queryByText('Settings')).toBeInTheDocument(); | ||
| }); | ||
| }); | ||
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👏