fix(clerk-js): Fetching custom role in OrganizationSwitcher with cache (#2430)#2450

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
panteliselef merged 1 commit into from
Jan 2, 2024
Merged

fix(clerk-js): Fetching custom role in OrganizationSwitcher with cache (#2430) #2450

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/two-crews-talk.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Bug fix: fetch custom roles in OrganizationSwitcher
4 changes: 2 additions & 2 deletions packages/clerk-js/src/ui/components/OrganizationProfile/RemoveDomainPage.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ export const RemoveDomainPage = () => {
const { params } = useRouter();

const ref = React.useRef<OrganizationDomainResource>();
const { data: domain, status: domainStatus } = useFetch(
const { data: domain, isLoading: domainIsLoading } = useFetch(
organization?.getDomain,
{
domainId: params.id,
Expand All@@ -37,7 +37,7 @@ export const RemoveDomainPage = () => {
return null;
}

if (domainStatus.isLoading || !domain) {
if (domainIsLoading || !domain) {
return (
<Flex
direction={'row'}
Expand Down
8 changes: 4 additions & 4 deletions packages/clerk-js/src/ui/components/OrganizationProfile/VerifiedDomainPage.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { LinkButtonWithDescription } from '../UserProfile/LinkButtonWithDescript
import { OrganizationProfileBreadcrumbs } from './OrganizationProfileNavbar';

const useCalloutLabel = (
domain: OrganizationDomainResource | null,
domain: OrganizationDomainResource | undefined | null,
{
infoLabel: infoLabelKey,
}: {
Expand DownExpand Up@@ -120,7 +120,7 @@ export const VerifiedDomainPage = withCardStateProvider(() => {
type: 'checkbox',
});

const { data: domain, status: domainStatus } = useFetch(
const { data: domain, isLoading: domainIsLoading } = useFetch(
organization?.getDomain,
{
domainId: params.id,
Expand DownExpand Up@@ -168,7 +168,7 @@ export const VerifiedDomainPage = withCardStateProvider(() => {
return null;
}

if (domainStatus.isLoading || !domain) {
if (domainIsLoading || !domain) {
return (
<Flex
direction={'row'}
Expand DownExpand Up@@ -264,7 +264,7 @@ export const VerifiedDomainPage = withCardStateProvider(() => {
localizationKey={localizationKeys(
'organizationProfile.verifiedDomainPage.enrollmentTab.formButton__save',
)}
isDisabled={domainStatus.isLoading || !domain || !isFormDirty}
isDisabled={domainIsLoading || !domain || !isFormDirty}
/>
</Form.Root>
</TabPanel>
Expand Down
4 changes: 2 additions & 2 deletions packages/clerk-js/src/ui/components/OrganizationProfile/VerifyDomainPage.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ export const VerifyDomainPage = withCardStateProvider(() => {

const [success, setSuccess] = React.useState(false);

const { data: domain, status: domainStatus } = useFetch(organization?.getDomain, {
const { data: domain, isLoading: domainIsLoading } = useFetch(organization?.getDomain, {
domainId: params.id,
});
const title = localizationKeys('organizationProfile.verifyDomainPage.title');
Expand DownExpand Up@@ -122,7 +122,7 @@ export const VerifyDomainPage = withCardStateProvider(() => {
});
};

if (domainStatus.isLoading || !domain) {
if (domainIsLoading || !domain) {
return (
<Flex
direction={'row'}
Expand Down
4 changes: 4 additions & 0 deletions packages/clerk-js/src/ui/components/OrganizationProfile/__tests__/InviteMembersPage.test.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,12 +6,16 @@ import React from 'react';

import { ClerkAPIResponseError } from '../../../../core/resources';
import { render } from '../../../../testUtils';
import { clearFetchCache } from '../../../hooks';
import { bindCreateFixtures } from '../../../utils/test/createFixtures';
import { InviteMembersPage } from '../InviteMembersPage';

const { createFixtures } = bindCreateFixtures('OrganizationProfile');

describe('InviteMembersPage', () => {
beforeEach(() => {
clearFetchCache();
});
it('renders the component', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.withOrganizations();
Expand Down
8 changes: 8 additions & 0 deletions ...ges/clerk-js/src/ui/components/OrganizationProfile/__tests__/OrganizationMembers.test.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import { act, waitFor } from '@testing-library/react';
import userEvent from '@testing-library/user-event';

import { render } from '../../../../testUtils';
import { clearFetchCache } from '../../../hooks/useFetch';
import { bindCreateFixtures } from '../../../utils/test/createFixtures';
import { runFakeTimers } from '../../../utils/test/runFakeTimers';
import { OrganizationMembers } from '../OrganizationMembers';
Expand All@@ -12,6 +13,13 @@ import { createFakeMember, createFakeOrganizationInvitation, createFakeOrganizat
const { createFixtures } = bindCreateFixtures('OrganizationProfile');

describe('OrganizationMembers', () => {
/**
* `<OrganizationMembers/>` internally uses useFetch which caches the results, be sure to clear the cache before each test
*/
beforeEach(() => {
clearFetchCache();
});

it('renders the Organization Members page', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.withOrganizations();
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/ui/components/OrganizationSwitcher/OrganizationSwitcherPopover.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -145,6 +145,7 @@ export const OrganizationSwitcherPopover = React.forwardRef<HTMLDivElement, Orga
gap={4}
organization={currentOrg}
user={user}
fetchRoles
sx={theme => t => ({ padding: `0 ${theme.space.$6}`, marginBottom: t.space.$2 })}
/>
<Actions role='menu'>
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/ui/components/OrganizationSwitcher/OrganizationSwitcherTrigger.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,7 @@ export const OrganizationSwitcherTrigger = withAvatarShimmer(
elementId={'organizationSwitcher'}
gap={3}
size={'sm'}
fetchRoles
organization={organization}
sx={{ maxWidth: '30ch' }}
/>
Expand Down
1 change: 1 addition & 0 deletions ...s/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,7 @@ describe('OrganizationSwitcher', () => {
});
});

fixtures.clerk.organization?.getRoles.mockRejectedValue(null);
fixtures.clerk.user?.getOrganizationInvitations.mockReturnValueOnce(
Promise.resolve({
data: [],
Expand Down
13 changes: 10 additions & 3 deletions packages/clerk-js/src/ui/elements/OrganizationPreview.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,8 @@ import type { OrganizationPreviewId, UserOrganizationInvitationResource, UserRes
import React from 'react';

import { descriptors, Flex, Text } from '../customizables';
import { useFetchRoles, useLocalizeCustomRoles } from '../hooks/useFetchRoles';
import type { PropsOfComponent, ThemableCssProp } from '../styledSystem';
import { roleLocalizationKey } from '../utils';
import { OrganizationAvatar } from './OrganizationAvatar';

export type OrganizationPreviewProps = Omit<PropsOfComponent<typeof Flex>, 'elementId'> & {
Expand All@@ -16,6 +16,7 @@ export type OrganizationPreviewProps = Omit<PropsOfComponent<typeof Flex>, 'elem
badge?: React.ReactNode;
rounded?: boolean;
elementId?: OrganizationPreviewId;
fetchRoles?: boolean;
};

export const OrganizationPreview = (props: OrganizationPreviewProps) => {
Expand All@@ -24,6 +25,7 @@ export const OrganizationPreview = (props: OrganizationPreviewProps) => {
size = 'md',
icon,
rounded = false,
fetchRoles = false,
badge,
sx,
user,
Expand All@@ -32,7 +34,12 @@ export const OrganizationPreview = (props: OrganizationPreviewProps) => {
elementId,
...rest
} = props;
const role = user?.organizationMemberships.find(membership => membership.organization.id === organization.id)?.role;

const { localizeCustomRole } = useLocalizeCustomRoles();
const { options } = useFetchRoles(fetchRoles);

const membership = user?.organizationMemberships.find(membership => membership.organization.id === organization.id);
const unlocalizedRoleLabel = options?.find(a => a.value === membership?.role)?.label;

return (
<Flex
Expand DownExpand Up@@ -80,7 +87,7 @@ export const OrganizationPreview = (props: OrganizationPreviewProps) => {
<Text
elementDescriptor={descriptors.organizationPreviewSecondaryIdentifier}
elementId={descriptors.organizationPreviewSecondaryIdentifier.setId(elementId)}
localizationKey={role && roleLocalizationKey(role)}
localizationKey={localizeCustomRole(membership?.role) || unlocalizedRoleLabel}
variant='smallRegular'
colorScheme='neutral'
truncate
Expand Down
119 changes: 97 additions & 22 deletions packages/clerk-js/src/ui/hooks/useFetch.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,119 @@
import { useEffect, useRef } from 'react';
import { useCallback, useEffect, useRef, useSyncExternalStore } from 'react';

import { useLoadingStatus } from './useLoadingStatus';
import { useSafeState } from './useSafeState';
export type State<Data = any, Error = any> = {
data: Data | null;
error: Error | null;
/**
* if there's an ongoing request and no "loaded data"
*/
isLoading: boolean;
/**
* if there's a request or revalidation loading
*/
isValidating: boolean;
cachedAt?: number;
};

/**
* Global cache for storing status of fetched resources
*/
let requestCache = new Map<string, State>();

/**
* A set to store subscribers in order to notify when the value of a key of `requestCache` changes
*/
const subscribers = new Set<() => void>();

/**
* This utility should only be used in tests to clear previously fetched data
*/
export const clearFetchCache = () => {
requestCache = new Map<string, State>();
};

const serialize = (obj: unknown) => JSON.stringify(obj);

export const useFetch = <T>(
const useCache = <K = any, V = any>(
key: K,
): {
getCache: () => State<V> | undefined;
setCache: (state: State) => void;
subscribeCache: (callback: () => void) => () => void;
} => {
const serializedKey = serialize(key);
const get = useCallback(() => requestCache.get(serializedKey), [serializedKey]);
const set = useCallback(
(data: State) => {
requestCache.set(serializedKey, data);
subscribers.forEach(callback => callback());
},
[serializedKey],
);
const subscribe = useCallback((callback: () => void) => {
subscribers.add(callback);
return () => subscribers.delete(callback);
}, []);

return {
getCache: get,
setCache: set,
subscribeCache: subscribe,
};
};

export const useFetch = <K, T>(
fetcher: ((...args: any) => Promise<T>) | undefined,
params: any,
params: K,
callbacks?: {
onSuccess?: (data: T) => void;
},
) => {
const [data, setData] = useSafeState<T | null>(null);
const requestStatus = useLoadingStatus({
status: 'loading',
});

const { subscribeCache, getCache, setCache } = useCache<K, T>(params);
const fetcherRef = useRef(fetcher);

const cached = useSyncExternalStore(subscribeCache, getCache);

useEffect(() => {
if (!fetcherRef.current) {
const fetcherMissing = !fetcherRef.current;
const isCacheStale = Date.now() - (getCache()?.cachedAt || 0) < 1000 * 60 * 2; //cache for 2 minutes;
const isRequestOnGoing = getCache()?.isValidating;

if (fetcherMissing || isCacheStale || isRequestOnGoing) {
return;
}
requestStatus.setLoading();
fetcherRef
.current(params)

setCache({
data: null,
isLoading: !getCache(),
isValidating: true,
error: null,
});
fetcherRef.current!(params)
.then(result => {
requestStatus.setIdle();
if (typeof result !== 'undefined') {
setData(typeof result === 'object' ? { ...result } : result);
callbacks?.onSuccess?.(typeof result === 'object' ? { ...result } : result);
const data = typeof result === 'object' ? { ...result } : result;
setCache({
data,
isLoading: false,
isValidating: false,
error: null,
cachedAt: Date.now(),
});
callbacks?.onSuccess?.(data);
}
})
.catch(() => {
requestStatus.setError();
setData(null);
setCache({
data: null,
isLoading: false,
isValidating: false,
error: true,
cachedAt: Date.now(),
});
});
}, [JSON.stringify(params)]);
}, [serialize(params), setCache, getCache]);

return {
status: requestStatus,
data,
...cached,
};
};
6 changes: 3 additions & 3 deletions packages/clerk-js/src/ui/hooks/useFetchRoles.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,12 +10,12 @@ const getRolesParams = {
*/
pageSize: 20,
};
export const useFetchRoles = () => {
export const useFetchRoles = (enabled = true) => {
const { organization } = useCoreOrganization();
const { data, status } = useFetch(organization?.getRoles, getRolesParams);
const { data, isLoading } = useFetch(enabled ? organization?.getRoles : undefined, getRolesParams);

return {
isLoading: status.isLoading,
isLoading,
options: data?.data?.map(role => ({ value: role.key, label: role.name })),
};
};
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
fix(clerk-js): Fetching custom role in OrganizationSwitcher with cache (#2430)#2450

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 1 commit into

from

Jan 2, 2024
 Merged


fix(clerk-js): Fetching custom role in OrganizationSwitcher with cache (#2430)
#2450
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/two-crews-talk.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Bug fix: fetch custom roles in OrganizationSwitcher

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/RemoveDomainPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ export const RemoveDomainPage = () => {
 const { params } = useRouter();

 const ref = React.useRef<OrganizationDomainResource>();
 const { data: domain, status: domainStatus } = useFetch(
 const { data: domain, isLoading: domainIsLoading } = useFetch(
 organization?.getDomain,
 {
 domainId: params.id,
Expand All@@ -37,7 +37,7 @@ export const RemoveDomainPage = () => {
 return null;
 }

 if (domainStatus.isLoading || !domain) {
 if (domainIsLoading || !domain) {
 return (
 <Flex
 direction={'row'}
Expand Down

8 changes: 4 additions & 4 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/VerifiedDomainPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { LinkButtonWithDescription } from '../UserProfile/LinkButtonWithDescript
import { OrganizationProfileBreadcrumbs } from './OrganizationProfileNavbar';

const useCalloutLabel = (
 domain: OrganizationDomainResource | null,
 domain: OrganizationDomainResource | undefined | null,
 {
 infoLabel: infoLabelKey,
 }: {
Expand DownExpand Up@@ -120,7 +120,7 @@ export const VerifiedDomainPage = withCardStateProvider(() => {
 type: 'checkbox',
 });

 const { data: domain, status: domainStatus } = useFetch(
 const { data: domain, isLoading: domainIsLoading } = useFetch(
 organization?.getDomain,
 {
 domainId: params.id,
Expand DownExpand Up@@ -168,7 +168,7 @@ export const VerifiedDomainPage = withCardStateProvider(() => {
 return null;
 }

 if (domainStatus.isLoading || !domain) {
 if (domainIsLoading || !domain) {
 return (
 <Flex
 direction={'row'}
Expand DownExpand Up@@ -264,7 +264,7 @@ export const VerifiedDomainPage = withCardStateProvider(() => {
 localizationKey={localizationKeys(
 'organizationProfile.verifiedDomainPage.enrollmentTab.formButton__save',
 )}
 isDisabled={domainStatus.isLoading || !domain || !isFormDirty}
 isDisabled={domainIsLoading || !domain || !isFormDirty}
 />
 </Form.Root>
 </TabPanel>
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/VerifyDomainPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ export const VerifyDomainPage = withCardStateProvider(() => {

 const [success, setSuccess] = React.useState(false);

 const { data: domain, status: domainStatus } = useFetch(organization?.getDomain, {
 const { data: domain, isLoading: domainIsLoading } = useFetch(organization?.getDomain, {
 domainId: params.id,
 });
 const title = localizationKeys('organizationProfile.verifyDomainPage.title');
Expand DownExpand Up@@ -122,7 +122,7 @@ export const VerifyDomainPage = withCardStateProvider(() => {
 });
 };

 if (domainStatus.isLoading || !domain) {
 if (domainIsLoading || !domain) {
 return (
 <Flex
 direction={'row'}
Expand Down

4 changes: 4 additions & 0 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/__tests__/InviteMembersPage.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,12 +6,16 @@ import React from 'react';

import { ClerkAPIResponseError } from '../../../../core/resources';
import { render } from '../../../../testUtils';
import { clearFetchCache } from '../../../hooks';
import { bindCreateFixtures } from '../../../utils/test/createFixtures';
import { InviteMembersPage } from '../InviteMembersPage';

const { createFixtures } = bindCreateFixtures('OrganizationProfile');

describe('InviteMembersPage', () => {
 beforeEach(() => {
 clearFetchCache();
 });
 it('renders the component', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withOrganizations();
Expand Down

8 changes: 8 additions & 0 deletions
...ges/clerk-js/src/ui/components/OrganizationProfile/__tests__/OrganizationMembers.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import { act, waitFor } from '@testing-library/react';
import userEvent from '@testing-library/user-event';

import { render } from '../../../../testUtils';
import { clearFetchCache } from '../../../hooks/useFetch';
import { bindCreateFixtures } from '../../../utils/test/createFixtures';
import { runFakeTimers } from '../../../utils/test/runFakeTimers';
import { OrganizationMembers } from '../OrganizationMembers';
Expand All@@ -12,6 +13,13 @@ import { createFakeMember, createFakeOrganizationInvitation, createFakeOrganizat
const { createFixtures } = bindCreateFixtures('OrganizationProfile');

describe('OrganizationMembers', () => {
 /**
 * `<OrganizationMembers/>` internally uses useFetch which caches the results, be sure to clear the cache before each test
 */
 beforeEach(() => {
 clearFetchCache();
 });

 it('renders the Organization Members page', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withOrganizations();
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/ui/components/OrganizationSwitcher/OrganizationSwitcherPopover.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -145,6 +145,7 @@ export const OrganizationSwitcherPopover = React.forwardRef<HTMLDivElement, Orga
 gap={4}
 organization={currentOrg}
 user={user}
 fetchRoles
 sx={theme => t => ({ padding: `0 ${theme.space.$6}`, marginBottom: t.space.$2 })}
 />
 <Actions role='menu'>
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/ui/components/OrganizationSwitcher/OrganizationSwitcherTrigger.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,7 @@ export const OrganizationSwitcherTrigger = withAvatarShimmer(
 elementId={'organizationSwitcher'}
 gap={3}
 size={'sm'}
 fetchRoles
 organization={organization}
 sx={{ maxWidth: '30ch' }}
 />
Expand Down

1 change: 1 addition & 0 deletions
...s/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,7 @@ describe('OrganizationSwitcher', () => {
 });
 });

 fixtures.clerk.organization?.getRoles.mockRejectedValue(null);
 fixtures.clerk.user?.getOrganizationInvitations.mockReturnValueOnce(
 Promise.resolve({
 data: [],
Expand Down

13 changes: 10 additions & 3 deletions
packages/clerk-js/src/ui/elements/OrganizationPreview.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,8 @@ import type { OrganizationPreviewId, UserOrganizationInvitationResource, UserRes
import React from 'react';

import { descriptors, Flex, Text } from '../customizables';
import { useFetchRoles, useLocalizeCustomRoles } from '../hooks/useFetchRoles';
import type { PropsOfComponent, ThemableCssProp } from '../styledSystem';
import { roleLocalizationKey } from '../utils';
import { OrganizationAvatar } from './OrganizationAvatar';

export type OrganizationPreviewProps = Omit<PropsOfComponent<typeof Flex>, 'elementId'> & {
Expand All@@ -16,6 +16,7 @@ export type OrganizationPreviewProps = Omit<PropsOfComponent<typeof Flex>, 'elem
 badge?: React.ReactNode;
 rounded?: boolean;
 elementId?: OrganizationPreviewId;
 fetchRoles?: boolean;
};

export const OrganizationPreview = (props: OrganizationPreviewProps) => {
Expand All@@ -24,6 +25,7 @@ export const OrganizationPreview = (props: OrganizationPreviewProps) => {
 size = 'md',
 icon,
 rounded = false,
 fetchRoles = false,
 badge,
 sx,
 user,
Expand All@@ -32,7 +34,12 @@ export const OrganizationPreview = (props: OrganizationPreviewProps) => {
 elementId,
 ...rest
 } = props;
 const role = user?.organizationMemberships.find(membership => membership.organization.id === organization.id)?.role;

 const { localizeCustomRole } = useLocalizeCustomRoles();
 const { options } = useFetchRoles(fetchRoles);

 const membership = user?.organizationMemberships.find(membership => membership.organization.id === organization.id);
 const unlocalizedRoleLabel = options?.find(a => a.value === membership?.role)?.label;

 return (
 <Flex
Expand DownExpand Up@@ -80,7 +87,7 @@ export const OrganizationPreview = (props: OrganizationPreviewProps) => {
 <Text
 elementDescriptor={descriptors.organizationPreviewSecondaryIdentifier}
 elementId={descriptors.organizationPreviewSecondaryIdentifier.setId(elementId)}
 localizationKey={role && roleLocalizationKey(role)}
 localizationKey={localizeCustomRole(membership?.role) || unlocalizedRoleLabel}
 variant='smallRegular'
 colorScheme='neutral'
 truncate
Expand Down

119 changes: 97 additions & 22 deletions
packages/clerk-js/src/ui/hooks/useFetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,44 +1,119 @@
import { useEffect, useRef } from 'react';
import { useCallback, useEffect, useRef, useSyncExternalStore } from 'react';

import { useLoadingStatus } from './useLoadingStatus';
import { useSafeState } from './useSafeState';
export type State<Data = any, Error = any> = {
 data: Data | null;
 error: Error | null;
 /**
 * if there's an ongoing request and no "loaded data"
 */
 isLoading: boolean;
 /**
 * if there's a request or revalidation loading
 */
 isValidating: boolean;
 cachedAt?: number;
};

/**
 * Global cache for storing status of fetched resources
 */
let requestCache = new Map<string, State>();

/**
 * A set to store subscribers in order to notify when the value of a key of `requestCache` changes
 */
const subscribers = new Set<() => void>();

/**
 * This utility should only be used in tests to clear previously fetched data
 */
export const clearFetchCache = () => {
 requestCache = new Map<string, State>();
};

const serialize = (obj: unknown) => JSON.stringify(obj);

export const useFetch = <T>(
const useCache = <K = any, V = any>(
 key: K,
): {
 getCache: () => State<V> | undefined;
 setCache: (state: State) => void;
 subscribeCache: (callback: () => void) => () => void;
} => {
 const serializedKey = serialize(key);
 const get = useCallback(() => requestCache.get(serializedKey), [serializedKey]);
 const set = useCallback(
 (data: State) => {
 requestCache.set(serializedKey, data);
 subscribers.forEach(callback => callback());
 },
 [serializedKey],
 );
 const subscribe = useCallback((callback: () => void) => {
 subscribers.add(callback);
 return () => subscribers.delete(callback);
 }, []);

 return {
 getCache: get,
 setCache: set,
 subscribeCache: subscribe,
 };
};

export const useFetch = <K, T>(
 fetcher: ((...args: any) => Promise<T>) | undefined,
 params: any,
 params: K,
 callbacks?: {
 onSuccess?: (data: T) => void;
 },
) => {
 const [data, setData] = useSafeState<T | null>(null);
 const requestStatus = useLoadingStatus({
 status: 'loading',
 });

 const { subscribeCache, getCache, setCache } = useCache<K, T>(params);
 const fetcherRef = useRef(fetcher);

 const cached = useSyncExternalStore(subscribeCache, getCache);

 useEffect(() => {
 if (!fetcherRef.current) {
 const fetcherMissing = !fetcherRef.current;
 const isCacheStale = Date.now() - (getCache()?.cachedAt || 0) < 1000 * 60 * 2; //cache for 2 minutes;
 const isRequestOnGoing = getCache()?.isValidating;

 if (fetcherMissing || isCacheStale || isRequestOnGoing) {
 return;
 }
 requestStatus.setLoading();
 fetcherRef
 .current(params)

 setCache({
 data: null,
 isLoading: !getCache(),
 isValidating: true,
 error: null,
 });
 fetcherRef.current!(params)
 .then(result => {
 requestStatus.setIdle();
 if (typeof result !== 'undefined') {
 setData(typeof result === 'object' ? { ...result } : result);
 callbacks?.onSuccess?.(typeof result === 'object' ? { ...result } : result);
 const data = typeof result === 'object' ? { ...result } : result;
 setCache({
 data,
 isLoading: false,
 isValidating: false,
 error: null,
 cachedAt: Date.now(),
 });
 callbacks?.onSuccess?.(data);
 }
 })
 .catch(() => {
 requestStatus.setError();
 setData(null);
 setCache({
 data: null,
 isLoading: false,
 isValidating: false,
 error: true,
 cachedAt: Date.now(),
 });
 });
 }, [JSON.stringify(params)]);
 }, [serialize(params), setCache, getCache]);

 return {
 status: requestStatus,
 data,
 ...cached,
 };
};

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/hooks/useFetchRoles.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,12 +10,12 @@ const getRolesParams = {
 */
 pageSize: 20,
};
export const useFetchRoles = () => {
export const useFetchRoles = (enabled = true) => {
 const { organization } = useCoreOrganization();
 const { data, status } = useFetch(organization?.getRoles, getRolesParams);
 const { data, isLoading } = useFetch(enabled ? organization?.getRoles : undefined, getRolesParams);

 return {
 isLoading: status.isLoading,
 isLoading,
 options: data?.data?.map(role => ({ value: role.key, label: role.name })),
 };
};
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(clerk-js): Fetching custom role in OrganizationSwitcher with cache (#2430)#2450

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 1 commit into

from

Jan 2, 2024
 Merged


fix(clerk-js): Fetching custom role in OrganizationSwitcher with cache (#2430)
#2450
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/two-crews-talk.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Bug fix: fetch custom roles in OrganizationSwitcher

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/RemoveDomainPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ export const RemoveDomainPage = () => {
 const { params } = useRouter();

 const ref = React.useRef<OrganizationDomainResource>();
 const { data: domain, status: domainStatus } = useFetch(
 const { data: domain, isLoading: domainIsLoading } = useFetch(
 organization?.getDomain,
 {
 domainId: params.id,
Expand All@@ -37,7 +37,7 @@ export const RemoveDomainPage = () => {
 return null;
 }

 if (domainStatus.isLoading || !domain) {
 if (domainIsLoading || !domain) {
 return (
 <Flex
 direction={'row'}
Expand Down

8 changes: 4 additions & 4 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/VerifiedDomainPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { LinkButtonWithDescription } from '../UserProfile/LinkButtonWithDescript
import { OrganizationProfileBreadcrumbs } from './OrganizationProfileNavbar';

const useCalloutLabel = (
 domain: OrganizationDomainResource | null,
 domain: OrganizationDomainResource | undefined | null,
 {
 infoLabel: infoLabelKey,
 }: {
Expand DownExpand Up@@ -120,7 +120,7 @@ export const VerifiedDomainPage = withCardStateProvider(() => {
 type: 'checkbox',
 });

 const { data: domain, status: domainStatus } = useFetch(
 const { data: domain, isLoading: domainIsLoading } = useFetch(
 organization?.getDomain,
 {
 domainId: params.id,
Expand DownExpand Up@@ -168,7 +168,7 @@ export const VerifiedDomainPage = withCardStateProvider(() => {
 return null;
 }

 if (domainStatus.isLoading || !domain) {
 if (domainIsLoading || !domain) {
 return (
 <Flex
 direction={'row'}
Expand DownExpand Up@@ -264,7 +264,7 @@ export const VerifiedDomainPage = withCardStateProvider(() => {
 localizationKey={localizationKeys(
 'organizationProfile.verifiedDomainPage.enrollmentTab.formButton__save',
 )}
 isDisabled={domainStatus.isLoading || !domain || !isFormDirty}
 isDisabled={domainIsLoading || !domain || !isFormDirty}
 />
 </Form.Root>
 </TabPanel>
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/VerifyDomainPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ export const VerifyDomainPage = withCardStateProvider(() => {

 const [success, setSuccess] = React.useState(false);

 const { data: domain, status: domainStatus } = useFetch(organization?.getDomain, {
 const { data: domain, isLoading: domainIsLoading } = useFetch(organization?.getDomain, {
 domainId: params.id,
 });
 const title = localizationKeys('organizationProfile.verifyDomainPage.title');
Expand DownExpand Up@@ -122,7 +122,7 @@ export const VerifyDomainPage = withCardStateProvider(() => {
 });
 };

 if (domainStatus.isLoading || !domain) {
 if (domainIsLoading || !domain) {
 return (
 <Flex
 direction={'row'}
Expand Down

4 changes: 4 additions & 0 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/__tests__/InviteMembersPage.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,12 +6,16 @@ import React from 'react';

import { ClerkAPIResponseError } from '../../../../core/resources';
import { render } from '../../../../testUtils';
import { clearFetchCache } from '../../../hooks';
import { bindCreateFixtures } from '../../../utils/test/createFixtures';
import { InviteMembersPage } from '../InviteMembersPage';

const { createFixtures } = bindCreateFixtures('OrganizationProfile');

describe('InviteMembersPage', () => {
 beforeEach(() => {
 clearFetchCache();
 });
 it('renders the component', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withOrganizations();
Expand Down

8 changes: 8 additions & 0 deletions
...ges/clerk-js/src/ui/components/OrganizationProfile/__tests__/OrganizationMembers.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import { act, waitFor } from '@testing-library/react';
import userEvent from '@testing-library/user-event';

import { render } from '../../../../testUtils';
import { clearFetchCache } from '../../../hooks/useFetch';
import { bindCreateFixtures } from '../../../utils/test/createFixtures';
import { runFakeTimers } from '../../../utils/test/runFakeTimers';
import { OrganizationMembers } from '../OrganizationMembers';
Expand All@@ -12,6 +13,13 @@ import { createFakeMember, createFakeOrganizationInvitation, createFakeOrganizat
const { createFixtures } = bindCreateFixtures('OrganizationProfile');

describe('OrganizationMembers', () => {
 /**
 * `<OrganizationMembers/>` internally uses useFetch which caches the results, be sure to clear the cache before each test
 */
 beforeEach(() => {
 clearFetchCache();
 });

 it('renders the Organization Members page', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withOrganizations();
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/ui/components/OrganizationSwitcher/OrganizationSwitcherPopover.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -145,6 +145,7 @@ export const OrganizationSwitcherPopover = React.forwardRef<HTMLDivElement, Orga
 gap={4}
 organization={currentOrg}
 user={user}
 fetchRoles
 sx={theme => t => ({ padding: `0 ${theme.space.$6}`, marginBottom: t.space.$2 })}
 />
 <Actions role='menu'>
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/ui/components/OrganizationSwitcher/OrganizationSwitcherTrigger.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,7 @@ export const OrganizationSwitcherTrigger = withAvatarShimmer(
 elementId={'organizationSwitcher'}
 gap={3}
 size={'sm'}
 fetchRoles
 organization={organization}
 sx={{ maxWidth: '30ch' }}
 />
Expand Down

1 change: 1 addition & 0 deletions
...s/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,7 @@ describe('OrganizationSwitcher', () => {
 });
 });

 fixtures.clerk.organization?.getRoles.mockRejectedValue(null);
 fixtures.clerk.user?.getOrganizationInvitations.mockReturnValueOnce(
 Promise.resolve({
 data: [],
Expand Down

13 changes: 10 additions & 3 deletions
packages/clerk-js/src/ui/elements/OrganizationPreview.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,8 @@ import type { OrganizationPreviewId, UserOrganizationInvitationResource, UserRes
import React from 'react';

import { descriptors, Flex, Text } from '../customizables';
import { useFetchRoles, useLocalizeCustomRoles } from '../hooks/useFetchRoles';
import type { PropsOfComponent, ThemableCssProp } from '../styledSystem';
import { roleLocalizationKey } from '../utils';
import { OrganizationAvatar } from './OrganizationAvatar';

export type OrganizationPreviewProps = Omit<PropsOfComponent<typeof Flex>, 'elementId'> & {
Expand All@@ -16,6 +16,7 @@ export type OrganizationPreviewProps = Omit<PropsOfComponent<typeof Flex>, 'elem
 badge?: React.ReactNode;
 rounded?: boolean;
 elementId?: OrganizationPreviewId;
 fetchRoles?: boolean;
};

export const OrganizationPreview = (props: OrganizationPreviewProps) => {
Expand All@@ -24,6 +25,7 @@ export const OrganizationPreview = (props: OrganizationPreviewProps) => {
 size = 'md',
 icon,
 rounded = false,
 fetchRoles = false,
 badge,
 sx,
 user,
Expand All@@ -32,7 +34,12 @@ export const OrganizationPreview = (props: OrganizationPreviewProps) => {
 elementId,
 ...rest
 } = props;
 const role = user?.organizationMemberships.find(membership => membership.organization.id === organization.id)?.role;

 const { localizeCustomRole } = useLocalizeCustomRoles();
 const { options } = useFetchRoles(fetchRoles);

 const membership = user?.organizationMemberships.find(membership => membership.organization.id === organization.id);
 const unlocalizedRoleLabel = options?.find(a => a.value === membership?.role)?.label;

 return (
 <Flex
Expand DownExpand Up@@ -80,7 +87,7 @@ export const OrganizationPreview = (props: OrganizationPreviewProps) => {
 <Text
 elementDescriptor={descriptors.organizationPreviewSecondaryIdentifier}
 elementId={descriptors.organizationPreviewSecondaryIdentifier.setId(elementId)}
 localizationKey={role && roleLocalizationKey(role)}
 localizationKey={localizeCustomRole(membership?.role) || unlocalizedRoleLabel}
 variant='smallRegular'
 colorScheme='neutral'
 truncate
Expand Down

119 changes: 97 additions & 22 deletions
packages/clerk-js/src/ui/hooks/useFetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,44 +1,119 @@
import { useEffect, useRef } from 'react';
import { useCallback, useEffect, useRef, useSyncExternalStore } from 'react';

import { useLoadingStatus } from './useLoadingStatus';
import { useSafeState } from './useSafeState';
export type State<Data = any, Error = any> = {
 data: Data | null;
 error: Error | null;
 /**
 * if there's an ongoing request and no "loaded data"
 */
 isLoading: boolean;
 /**
 * if there's a request or revalidation loading
 */
 isValidating: boolean;
 cachedAt?: number;
};

/**
 * Global cache for storing status of fetched resources
 */
let requestCache = new Map<string, State>();

/**
 * A set to store subscribers in order to notify when the value of a key of `requestCache` changes
 */
const subscribers = new Set<() => void>();

/**
 * This utility should only be used in tests to clear previously fetched data
 */
export const clearFetchCache = () => {
 requestCache = new Map<string, State>();
};

const serialize = (obj: unknown) => JSON.stringify(obj);

export const useFetch = <T>(
const useCache = <K = any, V = any>(
 key: K,
): {
 getCache: () => State<V> | undefined;
 setCache: (state: State) => void;
 subscribeCache: (callback: () => void) => () => void;
} => {
 const serializedKey = serialize(key);
 const get = useCallback(() => requestCache.get(serializedKey), [serializedKey]);
 const set = useCallback(
 (data: State) => {
 requestCache.set(serializedKey, data);
 subscribers.forEach(callback => callback());
 },
 [serializedKey],
 );
 const subscribe = useCallback((callback: () => void) => {
 subscribers.add(callback);
 return () => subscribers.delete(callback);
 }, []);

 return {
 getCache: get,
 setCache: set,
 subscribeCache: subscribe,
 };
};

export const useFetch = <K, T>(
 fetcher: ((...args: any) => Promise<T>) | undefined,
 params: any,
 params: K,
 callbacks?: {
 onSuccess?: (data: T) => void;
 },
) => {
 const [data, setData] = useSafeState<T | null>(null);
 const requestStatus = useLoadingStatus({
 status: 'loading',
 });

 const { subscribeCache, getCache, setCache } = useCache<K, T>(params);
 const fetcherRef = useRef(fetcher);

 const cached = useSyncExternalStore(subscribeCache, getCache);

 useEffect(() => {
 if (!fetcherRef.current) {
 const fetcherMissing = !fetcherRef.current;
 const isCacheStale = Date.now() - (getCache()?.cachedAt || 0) < 1000 * 60 * 2; //cache for 2 minutes;
 const isRequestOnGoing = getCache()?.isValidating;

 if (fetcherMissing || isCacheStale || isRequestOnGoing) {
 return;
 }
 requestStatus.setLoading();
 fetcherRef
 .current(params)

 setCache({
 data: null,
 isLoading: !getCache(),
 isValidating: true,
 error: null,
 });
 fetcherRef.current!(params)
 .then(result => {
 requestStatus.setIdle();
 if (typeof result !== 'undefined') {
 setData(typeof result === 'object' ? { ...result } : result);
 callbacks?.onSuccess?.(typeof result === 'object' ? { ...result } : result);
 const data = typeof result === 'object' ? { ...result } : result;
 setCache({
 data,
 isLoading: false,
 isValidating: false,
 error: null,
 cachedAt: Date.now(),
 });
 callbacks?.onSuccess?.(data);
 }
 })
 .catch(() => {
 requestStatus.setError();
 setData(null);
 setCache({
 data: null,
 isLoading: false,
 isValidating: false,
 error: true,
 cachedAt: Date.now(),
 });
 });
 }, [JSON.stringify(params)]);
 }, [serialize(params), setCache, getCache]);

 return {
 status: requestStatus,
 data,
 ...cached,
 };
};

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/hooks/useFetchRoles.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,12 +10,12 @@ const getRolesParams = {
 */
 pageSize: 20,
};
export const useFetchRoles = () => {
export const useFetchRoles = (enabled = true) => {
 const { organization } = useCoreOrganization();
 const { data, status } = useFetch(organization?.getRoles, getRolesParams);
 const { data, isLoading } = useFetch(enabled ? organization?.getRoles : undefined, getRolesParams);

 return {
 isLoading: status.isLoading,
 isLoading,
 options: data?.data?.map(role => ({ value: role.key, label: role.name })),
 };
};
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(clerk-js): Fetching custom role in OrganizationSwitcher with cache (#2430)#2450

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 1 commit into

from

Jan 2, 2024
 Merged


fix(clerk-js): Fetching custom role in OrganizationSwitcher with cache (#2430)
#2450
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/two-crews-talk.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Bug fix: fetch custom roles in OrganizationSwitcher

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/RemoveDomainPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ export const RemoveDomainPage = () => {
 const { params } = useRouter();

 const ref = React.useRef<OrganizationDomainResource>();
 const { data: domain, status: domainStatus } = useFetch(
 const { data: domain, isLoading: domainIsLoading } = useFetch(
 organization?.getDomain,
 {
 domainId: params.id,
Expand All@@ -37,7 +37,7 @@ export const RemoveDomainPage = () => {
 return null;
 }

 if (domainStatus.isLoading || !domain) {
 if (domainIsLoading || !domain) {
 return (
 <Flex
 direction={'row'}
Expand Down

8 changes: 4 additions & 4 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/VerifiedDomainPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { LinkButtonWithDescription } from '../UserProfile/LinkButtonWithDescript
import { OrganizationProfileBreadcrumbs } from './OrganizationProfileNavbar';

const useCalloutLabel = (
 domain: OrganizationDomainResource | null,
 domain: OrganizationDomainResource | undefined | null,
 {
 infoLabel: infoLabelKey,
 }: {
Expand DownExpand Up@@ -120,7 +120,7 @@ export const VerifiedDomainPage = withCardStateProvider(() => {
 type: 'checkbox',
 });

 const { data: domain, status: domainStatus } = useFetch(
 const { data: domain, isLoading: domainIsLoading } = useFetch(
 organization?.getDomain,
 {
 domainId: params.id,
Expand DownExpand Up@@ -168,7 +168,7 @@ export const VerifiedDomainPage = withCardStateProvider(() => {
 return null;
 }

 if (domainStatus.isLoading || !domain) {
 if (domainIsLoading || !domain) {
 return (
 <Flex
 direction={'row'}
Expand DownExpand Up@@ -264,7 +264,7 @@ export const VerifiedDomainPage = withCardStateProvider(() => {
 localizationKey={localizationKeys(
 'organizationProfile.verifiedDomainPage.enrollmentTab.formButton__save',
 )}
 isDisabled={domainStatus.isLoading || !domain || !isFormDirty}
 isDisabled={domainIsLoading || !domain || !isFormDirty}
 />
 </Form.Root>
 </TabPanel>
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/VerifyDomainPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ export const VerifyDomainPage = withCardStateProvider(() => {

 const [success, setSuccess] = React.useState(false);

 const { data: domain, status: domainStatus } = useFetch(organization?.getDomain, {
 const { data: domain, isLoading: domainIsLoading } = useFetch(organization?.getDomain, {
 domainId: params.id,
 });
 const title = localizationKeys('organizationProfile.verifyDomainPage.title');
Expand DownExpand Up@@ -122,7 +122,7 @@ export const VerifyDomainPage = withCardStateProvider(() => {
 });
 };

 if (domainStatus.isLoading || !domain) {
 if (domainIsLoading || !domain) {
 return (
 <Flex
 direction={'row'}
Expand Down

4 changes: 4 additions & 0 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/__tests__/InviteMembersPage.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,12 +6,16 @@ import React from 'react';

import { ClerkAPIResponseError } from '../../../../core/resources';
import { render } from '../../../../testUtils';
import { clearFetchCache } from '../../../hooks';
import { bindCreateFixtures } from '../../../utils/test/createFixtures';
import { InviteMembersPage } from '../InviteMembersPage';

const { createFixtures } = bindCreateFixtures('OrganizationProfile');

describe('InviteMembersPage', () => {
 beforeEach(() => {
 clearFetchCache();
 });
 it('renders the component', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withOrganizations();
Expand Down

8 changes: 8 additions & 0 deletions
...ges/clerk-js/src/ui/components/OrganizationProfile/__tests__/OrganizationMembers.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import { act, waitFor } from '@testing-library/react';
import userEvent from '@testing-library/user-event';

import { render } from '../../../../testUtils';
import { clearFetchCache } from '../../../hooks/useFetch';
import { bindCreateFixtures } from '../../../utils/test/createFixtures';
import { runFakeTimers } from '../../../utils/test/runFakeTimers';
import { OrganizationMembers } from '../OrganizationMembers';
Expand All@@ -12,6 +13,13 @@ import { createFakeMember, createFakeOrganizationInvitation, createFakeOrganizat
const { createFixtures } = bindCreateFixtures('OrganizationProfile');

describe('OrganizationMembers', () => {
 /**
 * `<OrganizationMembers/>` internally uses useFetch which caches the results, be sure to clear the cache before each test
 */
 beforeEach(() => {
 clearFetchCache();
 });

 it('renders the Organization Members page', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withOrganizations();
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/ui/components/OrganizationSwitcher/OrganizationSwitcherPopover.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -145,6 +145,7 @@ export const OrganizationSwitcherPopover = React.forwardRef<HTMLDivElement, Orga
 gap={4}
 organization={currentOrg}
 user={user}
 fetchRoles
 sx={theme => t => ({ padding: `0 ${theme.space.$6}`, marginBottom: t.space.$2 })}
 />
 <Actions role='menu'>
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/ui/components/OrganizationSwitcher/OrganizationSwitcherTrigger.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,7 @@ export const OrganizationSwitcherTrigger = withAvatarShimmer(
 elementId={'organizationSwitcher'}
 gap={3}
 size={'sm'}
 fetchRoles
 organization={organization}
 sx={{ maxWidth: '30ch' }}
 />
Expand Down

1 change: 1 addition & 0 deletions
...s/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,7 @@ describe('OrganizationSwitcher', () => {
 });
 });

 fixtures.clerk.organization?.getRoles.mockRejectedValue(null);
 fixtures.clerk.user?.getOrganizationInvitations.mockReturnValueOnce(
 Promise.resolve({
 data: [],
Expand Down

13 changes: 10 additions & 3 deletions
packages/clerk-js/src/ui/elements/OrganizationPreview.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,8 @@ import type { OrganizationPreviewId, UserOrganizationInvitationResource, UserRes
import React from 'react';

import { descriptors, Flex, Text } from '../customizables';
import { useFetchRoles, useLocalizeCustomRoles } from '../hooks/useFetchRoles';
import type { PropsOfComponent, ThemableCssProp } from '../styledSystem';
import { roleLocalizationKey } from '../utils';
import { OrganizationAvatar } from './OrganizationAvatar';

export type OrganizationPreviewProps = Omit<PropsOfComponent<typeof Flex>, 'elementId'> & {
Expand All@@ -16,6 +16,7 @@ export type OrganizationPreviewProps = Omit<PropsOfComponent<typeof Flex>, 'elem
 badge?: React.ReactNode;
 rounded?: boolean;
 elementId?: OrganizationPreviewId;
 fetchRoles?: boolean;
};

export const OrganizationPreview = (props: OrganizationPreviewProps) => {
Expand All@@ -24,6 +25,7 @@ export const OrganizationPreview = (props: OrganizationPreviewProps) => {
 size = 'md',
 icon,
 rounded = false,
 fetchRoles = false,
 badge,
 sx,
 user,
Expand All@@ -32,7 +34,12 @@ export const OrganizationPreview = (props: OrganizationPreviewProps) => {
 elementId,
 ...rest
 } = props;
 const role = user?.organizationMemberships.find(membership => membership.organization.id === organization.id)?.role;

 const { localizeCustomRole } = useLocalizeCustomRoles();
 const { options } = useFetchRoles(fetchRoles);

 const membership = user?.organizationMemberships.find(membership => membership.organization.id === organization.id);
 const unlocalizedRoleLabel = options?.find(a => a.value === membership?.role)?.label;

 return (
 <Flex
Expand DownExpand Up@@ -80,7 +87,7 @@ export const OrganizationPreview = (props: OrganizationPreviewProps) => {
 <Text
 elementDescriptor={descriptors.organizationPreviewSecondaryIdentifier}
 elementId={descriptors.organizationPreviewSecondaryIdentifier.setId(elementId)}
 localizationKey={role && roleLocalizationKey(role)}
 localizationKey={localizeCustomRole(membership?.role) || unlocalizedRoleLabel}
 variant='smallRegular'
 colorScheme='neutral'
 truncate
Expand Down

119 changes: 97 additions & 22 deletions
packages/clerk-js/src/ui/hooks/useFetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,44 +1,119 @@
import { useEffect, useRef } from 'react';
import { useCallback, useEffect, useRef, useSyncExternalStore } from 'react';

import { useLoadingStatus } from './useLoadingStatus';
import { useSafeState } from './useSafeState';
export type State<Data = any, Error = any> = {
 data: Data | null;
 error: Error | null;
 /**
 * if there's an ongoing request and no "loaded data"
 */
 isLoading: boolean;
 /**
 * if there's a request or revalidation loading
 */
 isValidating: boolean;
 cachedAt?: number;
};

/**
 * Global cache for storing status of fetched resources
 */
let requestCache = new Map<string, State>();

/**
 * A set to store subscribers in order to notify when the value of a key of `requestCache` changes
 */
const subscribers = new Set<() => void>();

/**
 * This utility should only be used in tests to clear previously fetched data
 */
export const clearFetchCache = () => {
 requestCache = new Map<string, State>();
};

const serialize = (obj: unknown) => JSON.stringify(obj);

export const useFetch = <T>(
const useCache = <K = any, V = any>(
 key: K,
): {
 getCache: () => State<V> | undefined;
 setCache: (state: State) => void;
 subscribeCache: (callback: () => void) => () => void;
} => {
 const serializedKey = serialize(key);
 const get = useCallback(() => requestCache.get(serializedKey), [serializedKey]);
 const set = useCallback(
 (data: State) => {
 requestCache.set(serializedKey, data);
 subscribers.forEach(callback => callback());
 },
 [serializedKey],
 );
 const subscribe = useCallback((callback: () => void) => {
 subscribers.add(callback);
 return () => subscribers.delete(callback);
 }, []);

 return {
 getCache: get,
 setCache: set,
 subscribeCache: subscribe,
 };
};

export const useFetch = <K, T>(
 fetcher: ((...args: any) => Promise<T>) | undefined,
 params: any,
 params: K,
 callbacks?: {
 onSuccess?: (data: T) => void;
 },
) => {
 const [data, setData] = useSafeState<T | null>(null);
 const requestStatus = useLoadingStatus({
 status: 'loading',
 });

 const { subscribeCache, getCache, setCache } = useCache<K, T>(params);
 const fetcherRef = useRef(fetcher);

 const cached = useSyncExternalStore(subscribeCache, getCache);

 useEffect(() => {
 if (!fetcherRef.current) {
 const fetcherMissing = !fetcherRef.current;
 const isCacheStale = Date.now() - (getCache()?.cachedAt || 0) < 1000 * 60 * 2; //cache for 2 minutes;
 const isRequestOnGoing = getCache()?.isValidating;

 if (fetcherMissing || isCacheStale || isRequestOnGoing) {
 return;
 }
 requestStatus.setLoading();
 fetcherRef
 .current(params)

 setCache({
 data: null,
 isLoading: !getCache(),
 isValidating: true,
 error: null,
 });
 fetcherRef.current!(params)
 .then(result => {
 requestStatus.setIdle();
 if (typeof result !== 'undefined') {
 setData(typeof result === 'object' ? { ...result } : result);
 callbacks?.onSuccess?.(typeof result === 'object' ? { ...result } : result);
 const data = typeof result === 'object' ? { ...result } : result;
 setCache({
 data,
 isLoading: false,
 isValidating: false,
 error: null,
 cachedAt: Date.now(),
 });
 callbacks?.onSuccess?.(data);
 }
 })
 .catch(() => {
 requestStatus.setError();
 setData(null);
 setCache({
 data: null,
 isLoading: false,
 isValidating: false,
 error: true,
 cachedAt: Date.now(),
 });
 });
 }, [JSON.stringify(params)]);
 }, [serialize(params), setCache, getCache]);

 return {
 status: requestStatus,
 data,
 ...cached,
 };
};

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/hooks/useFetchRoles.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,12 +10,12 @@ const getRolesParams = {
 */
 pageSize: 20,
};
export const useFetchRoles = () => {
export const useFetchRoles = (enabled = true) => {
 const { organization } = useCoreOrganization();
 const { data, status } = useFetch(organization?.getRoles, getRolesParams);
 const { data, isLoading } = useFetch(enabled ? organization?.getRoles : undefined, getRolesParams);

 return {
 isLoading: status.isLoading,
 isLoading,
 options: data?.data?.map(role => ({ value: role.key, label: role.name })),
 };
};
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
fix(clerk-js): Fetching custom role in OrganizationSwitcher with cache (#2430)#2450

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 1 commit into

from

Jan 2, 2024
 Merged


fix(clerk-js): Fetching custom role in OrganizationSwitcher with cache (#2430)
#2450
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/two-crews-talk.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Bug fix: fetch custom roles in OrganizationSwitcher

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/RemoveDomainPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ export const RemoveDomainPage = () => {
 const { params } = useRouter();

 const ref = React.useRef<OrganizationDomainResource>();
 const { data: domain, status: domainStatus } = useFetch(
 const { data: domain, isLoading: domainIsLoading } = useFetch(
 organization?.getDomain,
 {
 domainId: params.id,
Expand All@@ -37,7 +37,7 @@ export const RemoveDomainPage = () => {
 return null;
 }

 if (domainStatus.isLoading || !domain) {
 if (domainIsLoading || !domain) {
 return (
 <Flex
 direction={'row'}
Expand Down

8 changes: 4 additions & 4 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/VerifiedDomainPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { LinkButtonWithDescription } from '../UserProfile/LinkButtonWithDescript
import { OrganizationProfileBreadcrumbs } from './OrganizationProfileNavbar';

const useCalloutLabel = (
 domain: OrganizationDomainResource | null,
 domain: OrganizationDomainResource | undefined | null,
 {
 infoLabel: infoLabelKey,
 }: {
Expand DownExpand Up@@ -120,7 +120,7 @@ export const VerifiedDomainPage = withCardStateProvider(() => {
 type: 'checkbox',
 });

 const { data: domain, status: domainStatus } = useFetch(
 const { data: domain, isLoading: domainIsLoading } = useFetch(
 organization?.getDomain,
 {
 domainId: params.id,
Expand DownExpand Up@@ -168,7 +168,7 @@ export const VerifiedDomainPage = withCardStateProvider(() => {
 return null;
 }

 if (domainStatus.isLoading || !domain) {
 if (domainIsLoading || !domain) {
 return (
 <Flex
 direction={'row'}
Expand DownExpand Up@@ -264,7 +264,7 @@ export const VerifiedDomainPage = withCardStateProvider(() => {
 localizationKey={localizationKeys(
 'organizationProfile.verifiedDomainPage.enrollmentTab.formButton__save',
 )}
 isDisabled={domainStatus.isLoading || !domain || !isFormDirty}
 isDisabled={domainIsLoading || !domain || !isFormDirty}
 />
 </Form.Root>
 </TabPanel>
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/VerifyDomainPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ export const VerifyDomainPage = withCardStateProvider(() => {

 const [success, setSuccess] = React.useState(false);

 const { data: domain, status: domainStatus } = useFetch(organization?.getDomain, {
 const { data: domain, isLoading: domainIsLoading } = useFetch(organization?.getDomain, {
 domainId: params.id,
 });
 const title = localizationKeys('organizationProfile.verifyDomainPage.title');
Expand DownExpand Up@@ -122,7 +122,7 @@ export const VerifyDomainPage = withCardStateProvider(() => {
 });
 };

 if (domainStatus.isLoading || !domain) {
 if (domainIsLoading || !domain) {
 return (
 <Flex
 direction={'row'}
Expand Down

4 changes: 4 additions & 0 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/__tests__/InviteMembersPage.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,12 +6,16 @@ import React from 'react';

import { ClerkAPIResponseError } from '../../../../core/resources';
import { render } from '../../../../testUtils';
import { clearFetchCache } from '../../../hooks';
import { bindCreateFixtures } from '../../../utils/test/createFixtures';
import { InviteMembersPage } from '../InviteMembersPage';

const { createFixtures } = bindCreateFixtures('OrganizationProfile');

describe('InviteMembersPage', () => {
 beforeEach(() => {
 clearFetchCache();
 });
 it('renders the component', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withOrganizations();
Expand Down

8 changes: 8 additions & 0 deletions
...ges/clerk-js/src/ui/components/OrganizationProfile/__tests__/OrganizationMembers.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import { act, waitFor } from '@testing-library/react';
import userEvent from '@testing-library/user-event';

import { render } from '../../../../testUtils';
import { clearFetchCache } from '../../../hooks/useFetch';
import { bindCreateFixtures } from '../../../utils/test/createFixtures';
import { runFakeTimers } from '../../../utils/test/runFakeTimers';
import { OrganizationMembers } from '../OrganizationMembers';
Expand All@@ -12,6 +13,13 @@ import { createFakeMember, createFakeOrganizationInvitation, createFakeOrganizat
const { createFixtures } = bindCreateFixtures('OrganizationProfile');

describe('OrganizationMembers', () => {
 /**
 * `<OrganizationMembers/>` internally uses useFetch which caches the results, be sure to clear the cache before each test
 */
 beforeEach(() => {
 clearFetchCache();
 });

 it('renders the Organization Members page', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withOrganizations();
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/ui/components/OrganizationSwitcher/OrganizationSwitcherPopover.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -145,6 +145,7 @@ export const OrganizationSwitcherPopover = React.forwardRef<HTMLDivElement, Orga
 gap={4}
 organization={currentOrg}
 user={user}
 fetchRoles
 sx={theme => t => ({ padding: `0 ${theme.space.$6}`, marginBottom: t.space.$2 })}
 />
 <Actions role='menu'>
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/ui/components/OrganizationSwitcher/OrganizationSwitcherTrigger.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,7 @@ export const OrganizationSwitcherTrigger = withAvatarShimmer(
 elementId={'organizationSwitcher'}
 gap={3}
 size={'sm'}
 fetchRoles
 organization={organization}
 sx={{ maxWidth: '30ch' }}
 />
Expand Down

1 change: 1 addition & 0 deletions
...s/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,7 @@ describe('OrganizationSwitcher', () => {
 });
 });

 fixtures.clerk.organization?.getRoles.mockRejectedValue(null);
 fixtures.clerk.user?.getOrganizationInvitations.mockReturnValueOnce(
 Promise.resolve({
 data: [],
Expand Down

13 changes: 10 additions & 3 deletions
packages/clerk-js/src/ui/elements/OrganizationPreview.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,8 @@ import type { OrganizationPreviewId, UserOrganizationInvitationResource, UserRes
import React from 'react';

import { descriptors, Flex, Text } from '../customizables';
import { useFetchRoles, useLocalizeCustomRoles } from '../hooks/useFetchRoles';
import type { PropsOfComponent, ThemableCssProp } from '../styledSystem';
import { roleLocalizationKey } from '../utils';
import { OrganizationAvatar } from './OrganizationAvatar';

export type OrganizationPreviewProps = Omit<PropsOfComponent<typeof Flex>, 'elementId'> & {
Expand All@@ -16,6 +16,7 @@ export type OrganizationPreviewProps = Omit<PropsOfComponent<typeof Flex>, 'elem
 badge?: React.ReactNode;
 rounded?: boolean;
 elementId?: OrganizationPreviewId;
 fetchRoles?: boolean;
};

export const OrganizationPreview = (props: OrganizationPreviewProps) => {
Expand All@@ -24,6 +25,7 @@ export const OrganizationPreview = (props: OrganizationPreviewProps) => {
 size = 'md',
 icon,
 rounded = false,
 fetchRoles = false,
 badge,
 sx,
 user,
Expand All@@ -32,7 +34,12 @@ export const OrganizationPreview = (props: OrganizationPreviewProps) => {
 elementId,
 ...rest
 } = props;
 const role = user?.organizationMemberships.find(membership => membership.organization.id === organization.id)?.role;

 const { localizeCustomRole } = useLocalizeCustomRoles();
 const { options } = useFetchRoles(fetchRoles);

 const membership = user?.organizationMemberships.find(membership => membership.organization.id === organization.id);
 const unlocalizedRoleLabel = options?.find(a => a.value === membership?.role)?.label;

 return (
 <Flex
Expand DownExpand Up@@ -80,7 +87,7 @@ export const OrganizationPreview = (props: OrganizationPreviewProps) => {
 <Text
 elementDescriptor={descriptors.organizationPreviewSecondaryIdentifier}
 elementId={descriptors.organizationPreviewSecondaryIdentifier.setId(elementId)}
 localizationKey={role && roleLocalizationKey(role)}
 localizationKey={localizeCustomRole(membership?.role) || unlocalizedRoleLabel}
 variant='smallRegular'
 colorScheme='neutral'
 truncate
Expand Down

119 changes: 97 additions & 22 deletions
packages/clerk-js/src/ui/hooks/useFetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,44 +1,119 @@
import { useEffect, useRef } from 'react';
import { useCallback, useEffect, useRef, useSyncExternalStore } from 'react';

import { useLoadingStatus } from './useLoadingStatus';
import { useSafeState } from './useSafeState';
export type State<Data = any, Error = any> = {
 data: Data | null;
 error: Error | null;
 /**
 * if there's an ongoing request and no "loaded data"
 */
 isLoading: boolean;
 /**
 * if there's a request or revalidation loading
 */
 isValidating: boolean;
 cachedAt?: number;
};

/**
 * Global cache for storing status of fetched resources
 */
let requestCache = new Map<string, State>();

/**
 * A set to store subscribers in order to notify when the value of a key of `requestCache` changes
 */
const subscribers = new Set<() => void>();

/**
 * This utility should only be used in tests to clear previously fetched data
 */
export const clearFetchCache = () => {
 requestCache = new Map<string, State>();
};

const serialize = (obj: unknown) => JSON.stringify(obj);

export const useFetch = <T>(
const useCache = <K = any, V = any>(
 key: K,
): {
 getCache: () => State<V> | undefined;
 setCache: (state: State) => void;
 subscribeCache: (callback: () => void) => () => void;
} => {
 const serializedKey = serialize(key);
 const get = useCallback(() => requestCache.get(serializedKey), [serializedKey]);
 const set = useCallback(
 (data: State) => {
 requestCache.set(serializedKey, data);
 subscribers.forEach(callback => callback());
 },
 [serializedKey],
 );
 const subscribe = useCallback((callback: () => void) => {
 subscribers.add(callback);
 return () => subscribers.delete(callback);
 }, []);

 return {
 getCache: get,
 setCache: set,
 subscribeCache: subscribe,
 };
};

export const useFetch = <K, T>(
 fetcher: ((...args: any) => Promise<T>) | undefined,
 params: any,
 params: K,
 callbacks?: {
 onSuccess?: (data: T) => void;
 },
) => {
 const [data, setData] = useSafeState<T | null>(null);
 const requestStatus = useLoadingStatus({
 status: 'loading',
 });

 const { subscribeCache, getCache, setCache } = useCache<K, T>(params);
 const fetcherRef = useRef(fetcher);

 const cached = useSyncExternalStore(subscribeCache, getCache);

 useEffect(() => {
 if (!fetcherRef.current) {
 const fetcherMissing = !fetcherRef.current;
 const isCacheStale = Date.now() - (getCache()?.cachedAt || 0) < 1000 * 60 * 2; //cache for 2 minutes;
 const isRequestOnGoing = getCache()?.isValidating;

 if (fetcherMissing || isCacheStale || isRequestOnGoing) {
 return;
 }
 requestStatus.setLoading();
 fetcherRef
 .current(params)

 setCache({
 data: null,
 isLoading: !getCache(),
 isValidating: true,
 error: null,
 });
 fetcherRef.current!(params)
 .then(result => {
 requestStatus.setIdle();
 if (typeof result !== 'undefined') {
 setData(typeof result === 'object' ? { ...result } : result);
 callbacks?.onSuccess?.(typeof result === 'object' ? { ...result } : result);
 const data = typeof result === 'object' ? { ...result } : result;
 setCache({
 data,
 isLoading: false,
 isValidating: false,
 error: null,
 cachedAt: Date.now(),
 });
 callbacks?.onSuccess?.(data);
 }
 })
 .catch(() => {
 requestStatus.setError();
 setData(null);
 setCache({
 data: null,
 isLoading: false,
 isValidating: false,
 error: true,
 cachedAt: Date.now(),
 });
 });
 }, [JSON.stringify(params)]);
 }, [serialize(params), setCache, getCache]);

 return {
 status: requestStatus,
 data,
 ...cached,
 };
};

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/hooks/useFetchRoles.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,12 +10,12 @@ const getRolesParams = {
 */
 pageSize: 20,
};
export const useFetchRoles = () => {
export const useFetchRoles = (enabled = true) => {
 const { organization } = useCoreOrganization();
 const { data, status } = useFetch(organization?.getRoles, getRolesParams);
 const { data, isLoading } = useFetch(enabled ? organization?.getRoles : undefined, getRolesParams);

 return {
 isLoading: status.isLoading,
 isLoading,
 options: data?.data?.map(role => ({ value: role.key, label: role.name })),
 };
};
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(clerk-js): Fetching custom role in OrganizationSwitcher with cache (#2430)#2450

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 1 commit into

from

Jan 2, 2024
 Merged


fix(clerk-js): Fetching custom role in OrganizationSwitcher with cache (#2430)
#2450
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/two-crews-talk.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Bug fix: fetch custom roles in OrganizationSwitcher

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/RemoveDomainPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ export const RemoveDomainPage = () => {
 const { params } = useRouter();

 const ref = React.useRef<OrganizationDomainResource>();
 const { data: domain, status: domainStatus } = useFetch(
 const { data: domain, isLoading: domainIsLoading } = useFetch(
 organization?.getDomain,
 {
 domainId: params.id,
Expand All@@ -37,7 +37,7 @@ export const RemoveDomainPage = () => {
 return null;
 }

 if (domainStatus.isLoading || !domain) {
 if (domainIsLoading || !domain) {
 return (
 <Flex
 direction={'row'}
Expand Down

8 changes: 4 additions & 4 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/VerifiedDomainPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { LinkButtonWithDescription } from '../UserProfile/LinkButtonWithDescript
import { OrganizationProfileBreadcrumbs } from './OrganizationProfileNavbar';

const useCalloutLabel = (
 domain: OrganizationDomainResource | null,
 domain: OrganizationDomainResource | undefined | null,
 {
 infoLabel: infoLabelKey,
 }: {
Expand DownExpand Up@@ -120,7 +120,7 @@ export const VerifiedDomainPage = withCardStateProvider(() => {
 type: 'checkbox',
 });

 const { data: domain, status: domainStatus } = useFetch(
 const { data: domain, isLoading: domainIsLoading } = useFetch(
 organization?.getDomain,
 {
 domainId: params.id,
Expand DownExpand Up@@ -168,7 +168,7 @@ export const VerifiedDomainPage = withCardStateProvider(() => {
 return null;
 }

 if (domainStatus.isLoading || !domain) {
 if (domainIsLoading || !domain) {
 return (
 <Flex
 direction={'row'}
Expand DownExpand Up@@ -264,7 +264,7 @@ export const VerifiedDomainPage = withCardStateProvider(() => {
 localizationKey={localizationKeys(
 'organizationProfile.verifiedDomainPage.enrollmentTab.formButton__save',
 )}
 isDisabled={domainStatus.isLoading || !domain || !isFormDirty}
 isDisabled={domainIsLoading || !domain || !isFormDirty}
 />
 </Form.Root>
 </TabPanel>
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/VerifyDomainPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ export const VerifyDomainPage = withCardStateProvider(() => {

 const [success, setSuccess] = React.useState(false);

 const { data: domain, status: domainStatus } = useFetch(organization?.getDomain, {
 const { data: domain, isLoading: domainIsLoading } = useFetch(organization?.getDomain, {
 domainId: params.id,
 });
 const title = localizationKeys('organizationProfile.verifyDomainPage.title');
Expand DownExpand Up@@ -122,7 +122,7 @@ export const VerifyDomainPage = withCardStateProvider(() => {
 });
 };

 if (domainStatus.isLoading || !domain) {
 if (domainIsLoading || !domain) {
 return (
 <Flex
 direction={'row'}
Expand Down

4 changes: 4 additions & 0 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/__tests__/InviteMembersPage.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,12 +6,16 @@ import React from 'react';

import { ClerkAPIResponseError } from '../../../../core/resources';
import { render } from '../../../../testUtils';
import { clearFetchCache } from '../../../hooks';
import { bindCreateFixtures } from '../../../utils/test/createFixtures';
import { InviteMembersPage } from '../InviteMembersPage';

const { createFixtures } = bindCreateFixtures('OrganizationProfile');

describe('InviteMembersPage', () => {
 beforeEach(() => {
 clearFetchCache();
 });
 it('renders the component', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withOrganizations();
Expand Down

8 changes: 8 additions & 0 deletions
...ges/clerk-js/src/ui/components/OrganizationProfile/__tests__/OrganizationMembers.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import { act, waitFor } from '@testing-library/react';
import userEvent from '@testing-library/user-event';

import { render } from '../../../../testUtils';
import { clearFetchCache } from '../../../hooks/useFetch';
import { bindCreateFixtures } from '../../../utils/test/createFixtures';
import { runFakeTimers } from '../../../utils/test/runFakeTimers';
import { OrganizationMembers } from '../OrganizationMembers';
Expand All@@ -12,6 +13,13 @@ import { createFakeMember, createFakeOrganizationInvitation, createFakeOrganizat
const { createFixtures } = bindCreateFixtures('OrganizationProfile');

describe('OrganizationMembers', () => {
 /**
 * `<OrganizationMembers/>` internally uses useFetch which caches the results, be sure to clear the cache before each test
 */
 beforeEach(() => {
 clearFetchCache();
 });

 it('renders the Organization Members page', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withOrganizations();
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/ui/components/OrganizationSwitcher/OrganizationSwitcherPopover.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -145,6 +145,7 @@ export const OrganizationSwitcherPopover = React.forwardRef<HTMLDivElement, Orga
 gap={4}
 organization={currentOrg}
 user={user}
 fetchRoles
 sx={theme => t => ({ padding: `0 ${theme.space.$6}`, marginBottom: t.space.$2 })}
 />
 <Actions role='menu'>
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/ui/components/OrganizationSwitcher/OrganizationSwitcherTrigger.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,7 @@ export const OrganizationSwitcherTrigger = withAvatarShimmer(
 elementId={'organizationSwitcher'}
 gap={3}
 size={'sm'}
 fetchRoles
 organization={organization}
 sx={{ maxWidth: '30ch' }}
 />
Expand Down

1 change: 1 addition & 0 deletions
...s/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,7 @@ describe('OrganizationSwitcher', () => {
 });
 });

 fixtures.clerk.organization?.getRoles.mockRejectedValue(null);
 fixtures.clerk.user?.getOrganizationInvitations.mockReturnValueOnce(
 Promise.resolve({
 data: [],
Expand Down

13 changes: 10 additions & 3 deletions
packages/clerk-js/src/ui/elements/OrganizationPreview.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,8 @@ import type { OrganizationPreviewId, UserOrganizationInvitationResource, UserRes
import React from 'react';

import { descriptors, Flex, Text } from '../customizables';
import { useFetchRoles, useLocalizeCustomRoles } from '../hooks/useFetchRoles';
import type { PropsOfComponent, ThemableCssProp } from '../styledSystem';
import { roleLocalizationKey } from '../utils';
import { OrganizationAvatar } from './OrganizationAvatar';

export type OrganizationPreviewProps = Omit<PropsOfComponent<typeof Flex>, 'elementId'> & {
Expand All@@ -16,6 +16,7 @@ export type OrganizationPreviewProps = Omit<PropsOfComponent<typeof Flex>, 'elem
 badge?: React.ReactNode;
 rounded?: boolean;
 elementId?: OrganizationPreviewId;
 fetchRoles?: boolean;
};

export const OrganizationPreview = (props: OrganizationPreviewProps) => {
Expand All@@ -24,6 +25,7 @@ export const OrganizationPreview = (props: OrganizationPreviewProps) => {
 size = 'md',
 icon,
 rounded = false,
 fetchRoles = false,
 badge,
 sx,
 user,
Expand All@@ -32,7 +34,12 @@ export const OrganizationPreview = (props: OrganizationPreviewProps) => {
 elementId,
 ...rest
 } = props;
 const role = user?.organizationMemberships.find(membership => membership.organization.id === organization.id)?.role;

 const { localizeCustomRole } = useLocalizeCustomRoles();
 const { options } = useFetchRoles(fetchRoles);

 const membership = user?.organizationMemberships.find(membership => membership.organization.id === organization.id);
 const unlocalizedRoleLabel = options?.find(a => a.value === membership?.role)?.label;

 return (
 <Flex
Expand DownExpand Up@@ -80,7 +87,7 @@ export const OrganizationPreview = (props: OrganizationPreviewProps) => {
 <Text
 elementDescriptor={descriptors.organizationPreviewSecondaryIdentifier}
 elementId={descriptors.organizationPreviewSecondaryIdentifier.setId(elementId)}
 localizationKey={role && roleLocalizationKey(role)}
 localizationKey={localizeCustomRole(membership?.role) || unlocalizedRoleLabel}
 variant='smallRegular'
 colorScheme='neutral'
 truncate
Expand Down

119 changes: 97 additions & 22 deletions
packages/clerk-js/src/ui/hooks/useFetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,44 +1,119 @@
import { useEffect, useRef } from 'react';
import { useCallback, useEffect, useRef, useSyncExternalStore } from 'react';

import { useLoadingStatus } from './useLoadingStatus';
import { useSafeState } from './useSafeState';
export type State<Data = any, Error = any> = {
 data: Data | null;
 error: Error | null;
 /**
 * if there's an ongoing request and no "loaded data"
 */
 isLoading: boolean;
 /**
 * if there's a request or revalidation loading
 */
 isValidating: boolean;
 cachedAt?: number;
};

/**
 * Global cache for storing status of fetched resources
 */
let requestCache = new Map<string, State>();

/**
 * A set to store subscribers in order to notify when the value of a key of `requestCache` changes
 */
const subscribers = new Set<() => void>();

/**
 * This utility should only be used in tests to clear previously fetched data
 */
export const clearFetchCache = () => {
 requestCache = new Map<string, State>();
};

const serialize = (obj: unknown) => JSON.stringify(obj);

export const useFetch = <T>(
const useCache = <K = any, V = any>(
 key: K,
): {
 getCache: () => State<V> | undefined;
 setCache: (state: State) => void;
 subscribeCache: (callback: () => void) => () => void;
} => {
 const serializedKey = serialize(key);
 const get = useCallback(() => requestCache.get(serializedKey), [serializedKey]);
 const set = useCallback(
 (data: State) => {
 requestCache.set(serializedKey, data);
 subscribers.forEach(callback => callback());
 },
 [serializedKey],
 );
 const subscribe = useCallback((callback: () => void) => {
 subscribers.add(callback);
 return () => subscribers.delete(callback);
 }, []);

 return {
 getCache: get,
 setCache: set,
 subscribeCache: subscribe,
 };
};

export const useFetch = <K, T>(
 fetcher: ((...args: any) => Promise<T>) | undefined,
 params: any,
 params: K,
 callbacks?: {
 onSuccess?: (data: T) => void;
 },
) => {
 const [data, setData] = useSafeState<T | null>(null);
 const requestStatus = useLoadingStatus({
 status: 'loading',
 });

 const { subscribeCache, getCache, setCache } = useCache<K, T>(params);
 const fetcherRef = useRef(fetcher);

 const cached = useSyncExternalStore(subscribeCache, getCache);

 useEffect(() => {
 if (!fetcherRef.current) {
 const fetcherMissing = !fetcherRef.current;
 const isCacheStale = Date.now() - (getCache()?.cachedAt || 0) < 1000 * 60 * 2; //cache for 2 minutes;
 const isRequestOnGoing = getCache()?.isValidating;

 if (fetcherMissing || isCacheStale || isRequestOnGoing) {
 return;
 }
 requestStatus.setLoading();
 fetcherRef
 .current(params)

 setCache({
 data: null,
 isLoading: !getCache(),
 isValidating: true,
 error: null,
 });
 fetcherRef.current!(params)
 .then(result => {
 requestStatus.setIdle();
 if (typeof result !== 'undefined') {
 setData(typeof result === 'object' ? { ...result } : result);
 callbacks?.onSuccess?.(typeof result === 'object' ? { ...result } : result);
 const data = typeof result === 'object' ? { ...result } : result;
 setCache({
 data,
 isLoading: false,
 isValidating: false,
 error: null,
 cachedAt: Date.now(),
 });
 callbacks?.onSuccess?.(data);
 }
 })
 .catch(() => {
 requestStatus.setError();
 setData(null);
 setCache({
 data: null,
 isLoading: false,
 isValidating: false,
 error: true,
 cachedAt: Date.now(),
 });
 });
 }, [JSON.stringify(params)]);
 }, [serialize(params), setCache, getCache]);

 return {
 status: requestStatus,
 data,
 ...cached,
 };
};

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/hooks/useFetchRoles.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,12 +10,12 @@ const getRolesParams = {
 */
 pageSize: 20,
};
export const useFetchRoles = () => {
export const useFetchRoles = (enabled = true) => {
 const { organization } = useCoreOrganization();
 const { data, status } = useFetch(organization?.getRoles, getRolesParams);
 const { data, isLoading } = useFetch(enabled ? organization?.getRoles : undefined, getRolesParams);

 return {
 isLoading: status.isLoading,
 isLoading,
 options: data?.data?.map(role => ({ value: role.key, label: role.name })),
 };
};
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(clerk-js): Fetching custom role in OrganizationSwitcher with cache (#2430)#2450

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 1 commit into

from

Jan 2, 2024
 Merged


fix(clerk-js): Fetching custom role in OrganizationSwitcher with cache (#2430)
#2450
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/two-crews-talk.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Bug fix: fetch custom roles in OrganizationSwitcher

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/RemoveDomainPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ export const RemoveDomainPage = () => {
 const { params } = useRouter();

 const ref = React.useRef<OrganizationDomainResource>();
 const { data: domain, status: domainStatus } = useFetch(
 const { data: domain, isLoading: domainIsLoading } = useFetch(
 organization?.getDomain,
 {
 domainId: params.id,
Expand All@@ -37,7 +37,7 @@ export const RemoveDomainPage = () => {
 return null;
 }

 if (domainStatus.isLoading || !domain) {
 if (domainIsLoading || !domain) {
 return (
 <Flex
 direction={'row'}
Expand Down

8 changes: 4 additions & 4 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/VerifiedDomainPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { LinkButtonWithDescription } from '../UserProfile/LinkButtonWithDescript
import { OrganizationProfileBreadcrumbs } from './OrganizationProfileNavbar';

const useCalloutLabel = (
 domain: OrganizationDomainResource | null,
 domain: OrganizationDomainResource | undefined | null,
 {
 infoLabel: infoLabelKey,
 }: {
Expand DownExpand Up@@ -120,7 +120,7 @@ export const VerifiedDomainPage = withCardStateProvider(() => {
 type: 'checkbox',
 });

 const { data: domain, status: domainStatus } = useFetch(
 const { data: domain, isLoading: domainIsLoading } = useFetch(
 organization?.getDomain,
 {
 domainId: params.id,
Expand DownExpand Up@@ -168,7 +168,7 @@ export const VerifiedDomainPage = withCardStateProvider(() => {
 return null;
 }

 if (domainStatus.isLoading || !domain) {
 if (domainIsLoading || !domain) {
 return (
 <Flex
 direction={'row'}
Expand DownExpand Up@@ -264,7 +264,7 @@ export const VerifiedDomainPage = withCardStateProvider(() => {
 localizationKey={localizationKeys(
 'organizationProfile.verifiedDomainPage.enrollmentTab.formButton__save',
 )}
 isDisabled={domainStatus.isLoading || !domain || !isFormDirty}
 isDisabled={domainIsLoading || !domain || !isFormDirty}
 />
 </Form.Root>
 </TabPanel>
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/VerifyDomainPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ export const VerifyDomainPage = withCardStateProvider(() => {

 const [success, setSuccess] = React.useState(false);

 const { data: domain, status: domainStatus } = useFetch(organization?.getDomain, {
 const { data: domain, isLoading: domainIsLoading } = useFetch(organization?.getDomain, {
 domainId: params.id,
 });
 const title = localizationKeys('organizationProfile.verifyDomainPage.title');
Expand DownExpand Up@@ -122,7 +122,7 @@ export const VerifyDomainPage = withCardStateProvider(() => {
 });
 };

 if (domainStatus.isLoading || !domain) {
 if (domainIsLoading || !domain) {
 return (
 <Flex
 direction={'row'}
Expand Down

4 changes: 4 additions & 0 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/__tests__/InviteMembersPage.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,12 +6,16 @@ import React from 'react';

import { ClerkAPIResponseError } from '../../../../core/resources';
import { render } from '../../../../testUtils';
import { clearFetchCache } from '../../../hooks';
import { bindCreateFixtures } from '../../../utils/test/createFixtures';
import { InviteMembersPage } from '../InviteMembersPage';

const { createFixtures } = bindCreateFixtures('OrganizationProfile');

describe('InviteMembersPage', () => {
 beforeEach(() => {
 clearFetchCache();
 });
 it('renders the component', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withOrganizations();
Expand Down

8 changes: 8 additions & 0 deletions
...ges/clerk-js/src/ui/components/OrganizationProfile/__tests__/OrganizationMembers.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import { act, waitFor } from '@testing-library/react';
import userEvent from '@testing-library/user-event';

import { render } from '../../../../testUtils';
import { clearFetchCache } from '../../../hooks/useFetch';
import { bindCreateFixtures } from '../../../utils/test/createFixtures';
import { runFakeTimers } from '../../../utils/test/runFakeTimers';
import { OrganizationMembers } from '../OrganizationMembers';
Expand All@@ -12,6 +13,13 @@ import { createFakeMember, createFakeOrganizationInvitation, createFakeOrganizat
const { createFixtures } = bindCreateFixtures('OrganizationProfile');

describe('OrganizationMembers', () => {
 /**
 * `<OrganizationMembers/>` internally uses useFetch which caches the results, be sure to clear the cache before each test
 */
 beforeEach(() => {
 clearFetchCache();
 });

 it('renders the Organization Members page', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withOrganizations();
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/ui/components/OrganizationSwitcher/OrganizationSwitcherPopover.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -145,6 +145,7 @@ export const OrganizationSwitcherPopover = React.forwardRef<HTMLDivElement, Orga
 gap={4}
 organization={currentOrg}
 user={user}
 fetchRoles
 sx={theme => t => ({ padding: `0 ${theme.space.$6}`, marginBottom: t.space.$2 })}
 />
 <Actions role='menu'>
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/ui/components/OrganizationSwitcher/OrganizationSwitcherTrigger.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,7 @@ export const OrganizationSwitcherTrigger = withAvatarShimmer(
 elementId={'organizationSwitcher'}
 gap={3}
 size={'sm'}
 fetchRoles
 organization={organization}
 sx={{ maxWidth: '30ch' }}
 />
Expand Down

1 change: 1 addition & 0 deletions
...s/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,7 @@ describe('OrganizationSwitcher', () => {
 });
 });

 fixtures.clerk.organization?.getRoles.mockRejectedValue(null);
 fixtures.clerk.user?.getOrganizationInvitations.mockReturnValueOnce(
 Promise.resolve({
 data: [],
Expand Down

13 changes: 10 additions & 3 deletions
packages/clerk-js/src/ui/elements/OrganizationPreview.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,8 @@ import type { OrganizationPreviewId, UserOrganizationInvitationResource, UserRes
import React from 'react';

import { descriptors, Flex, Text } from '../customizables';
import { useFetchRoles, useLocalizeCustomRoles } from '../hooks/useFetchRoles';
import type { PropsOfComponent, ThemableCssProp } from '../styledSystem';
import { roleLocalizationKey } from '../utils';
import { OrganizationAvatar } from './OrganizationAvatar';

export type OrganizationPreviewProps = Omit<PropsOfComponent<typeof Flex>, 'elementId'> & {
Expand All@@ -16,6 +16,7 @@ export type OrganizationPreviewProps = Omit<PropsOfComponent<typeof Flex>, 'elem
 badge?: React.ReactNode;
 rounded?: boolean;
 elementId?: OrganizationPreviewId;
 fetchRoles?: boolean;
};

export const OrganizationPreview = (props: OrganizationPreviewProps) => {
Expand All@@ -24,6 +25,7 @@ export const OrganizationPreview = (props: OrganizationPreviewProps) => {
 size = 'md',
 icon,
 rounded = false,
 fetchRoles = false,
 badge,
 sx,
 user,
Expand All@@ -32,7 +34,12 @@ export const OrganizationPreview = (props: OrganizationPreviewProps) => {
 elementId,
 ...rest
 } = props;
 const role = user?.organizationMemberships.find(membership => membership.organization.id === organization.id)?.role;

 const { localizeCustomRole } = useLocalizeCustomRoles();
 const { options } = useFetchRoles(fetchRoles);

 const membership = user?.organizationMemberships.find(membership => membership.organization.id === organization.id);
 const unlocalizedRoleLabel = options?.find(a => a.value === membership?.role)?.label;

 return (
 <Flex
Expand DownExpand Up@@ -80,7 +87,7 @@ export const OrganizationPreview = (props: OrganizationPreviewProps) => {
 <Text
 elementDescriptor={descriptors.organizationPreviewSecondaryIdentifier}
 elementId={descriptors.organizationPreviewSecondaryIdentifier.setId(elementId)}
 localizationKey={role && roleLocalizationKey(role)}
 localizationKey={localizeCustomRole(membership?.role) || unlocalizedRoleLabel}
 variant='smallRegular'
 colorScheme='neutral'
 truncate
Expand Down

119 changes: 97 additions & 22 deletions
packages/clerk-js/src/ui/hooks/useFetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,44 +1,119 @@
import { useEffect, useRef } from 'react';
import { useCallback, useEffect, useRef, useSyncExternalStore } from 'react';

import { useLoadingStatus } from './useLoadingStatus';
import { useSafeState } from './useSafeState';
export type State<Data = any, Error = any> = {
 data: Data | null;
 error: Error | null;
 /**
 * if there's an ongoing request and no "loaded data"
 */
 isLoading: boolean;
 /**
 * if there's a request or revalidation loading
 */
 isValidating: boolean;
 cachedAt?: number;
};

/**
 * Global cache for storing status of fetched resources
 */
let requestCache = new Map<string, State>();

/**
 * A set to store subscribers in order to notify when the value of a key of `requestCache` changes
 */
const subscribers = new Set<() => void>();

/**
 * This utility should only be used in tests to clear previously fetched data
 */
export const clearFetchCache = () => {
 requestCache = new Map<string, State>();
};

const serialize = (obj: unknown) => JSON.stringify(obj);

export const useFetch = <T>(
const useCache = <K = any, V = any>(
 key: K,
): {
 getCache: () => State<V> | undefined;
 setCache: (state: State) => void;
 subscribeCache: (callback: () => void) => () => void;
} => {
 const serializedKey = serialize(key);
 const get = useCallback(() => requestCache.get(serializedKey), [serializedKey]);
 const set = useCallback(
 (data: State) => {
 requestCache.set(serializedKey, data);
 subscribers.forEach(callback => callback());
 },
 [serializedKey],
 );
 const subscribe = useCallback((callback: () => void) => {
 subscribers.add(callback);
 return () => subscribers.delete(callback);
 }, []);

 return {
 getCache: get,
 setCache: set,
 subscribeCache: subscribe,
 };
};

export const useFetch = <K, T>(
 fetcher: ((...args: any) => Promise<T>) | undefined,
 params: any,
 params: K,
 callbacks?: {
 onSuccess?: (data: T) => void;
 },
) => {
 const [data, setData] = useSafeState<T | null>(null);
 const requestStatus = useLoadingStatus({
 status: 'loading',
 });

 const { subscribeCache, getCache, setCache } = useCache<K, T>(params);
 const fetcherRef = useRef(fetcher);

 const cached = useSyncExternalStore(subscribeCache, getCache);

 useEffect(() => {
 if (!fetcherRef.current) {
 const fetcherMissing = !fetcherRef.current;
 const isCacheStale = Date.now() - (getCache()?.cachedAt || 0) < 1000 * 60 * 2; //cache for 2 minutes;
 const isRequestOnGoing = getCache()?.isValidating;

 if (fetcherMissing || isCacheStale || isRequestOnGoing) {
 return;
 }
 requestStatus.setLoading();
 fetcherRef
 .current(params)

 setCache({
 data: null,
 isLoading: !getCache(),
 isValidating: true,
 error: null,
 });
 fetcherRef.current!(params)
 .then(result => {
 requestStatus.setIdle();
 if (typeof result !== 'undefined') {
 setData(typeof result === 'object' ? { ...result } : result);
 callbacks?.onSuccess?.(typeof result === 'object' ? { ...result } : result);
 const data = typeof result === 'object' ? { ...result } : result;
 setCache({
 data,
 isLoading: false,
 isValidating: false,
 error: null,
 cachedAt: Date.now(),
 });
 callbacks?.onSuccess?.(data);
 }
 })
 .catch(() => {
 requestStatus.setError();
 setData(null);
 setCache({
 data: null,
 isLoading: false,
 isValidating: false,
 error: true,
 cachedAt: Date.now(),
 });
 });
 }, [JSON.stringify(params)]);
 }, [serialize(params), setCache, getCache]);

 return {
 status: requestStatus,
 data,
 ...cached,
 };
};

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/hooks/useFetchRoles.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,12 +10,12 @@ const getRolesParams = {
 */
 pageSize: 20,
};
export const useFetchRoles = () => {
export const useFetchRoles = (enabled = true) => {
 const { organization } = useCoreOrganization();
 const { data, status } = useFetch(organization?.getRoles, getRolesParams);
 const { data, isLoading } = useFetch(enabled ? organization?.getRoles : undefined, getRolesParams);

 return {
 isLoading: status.isLoading,
 isLoading,
 options: data?.data?.map(role => ({ value: role.key, label: role.name })),
 };
};
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
fix(clerk-js): Fetching custom role in OrganizationSwitcher with cache (#2430)#2450

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 1 commit into

from

Jan 2, 2024
 Merged


fix(clerk-js): Fetching custom role in OrganizationSwitcher with cache (#2430)
#2450
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/two-crews-talk.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Bug fix: fetch custom roles in OrganizationSwitcher

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/RemoveDomainPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ export const RemoveDomainPage = () => {
 const { params } = useRouter();

 const ref = React.useRef<OrganizationDomainResource>();
 const { data: domain, status: domainStatus } = useFetch(
 const { data: domain, isLoading: domainIsLoading } = useFetch(
 organization?.getDomain,
 {
 domainId: params.id,
Expand All@@ -37,7 +37,7 @@ export const RemoveDomainPage = () => {
 return null;
 }

 if (domainStatus.isLoading || !domain) {
 if (domainIsLoading || !domain) {
 return (
 <Flex
 direction={'row'}
Expand Down

8 changes: 4 additions & 4 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/VerifiedDomainPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { LinkButtonWithDescription } from '../UserProfile/LinkButtonWithDescript
import { OrganizationProfileBreadcrumbs } from './OrganizationProfileNavbar';

const useCalloutLabel = (
 domain: OrganizationDomainResource | null,
 domain: OrganizationDomainResource | undefined | null,
 {
 infoLabel: infoLabelKey,
 }: {
Expand DownExpand Up@@ -120,7 +120,7 @@ export const VerifiedDomainPage = withCardStateProvider(() => {
 type: 'checkbox',
 });

 const { data: domain, status: domainStatus } = useFetch(
 const { data: domain, isLoading: domainIsLoading } = useFetch(
 organization?.getDomain,
 {
 domainId: params.id,
Expand DownExpand Up@@ -168,7 +168,7 @@ export const VerifiedDomainPage = withCardStateProvider(() => {
 return null;
 }

 if (domainStatus.isLoading || !domain) {
 if (domainIsLoading || !domain) {
 return (
 <Flex
 direction={'row'}
Expand DownExpand Up@@ -264,7 +264,7 @@ export const VerifiedDomainPage = withCardStateProvider(() => {
 localizationKey={localizationKeys(
 'organizationProfile.verifiedDomainPage.enrollmentTab.formButton__save',
 )}
 isDisabled={domainStatus.isLoading || !domain || !isFormDirty}
 isDisabled={domainIsLoading || !domain || !isFormDirty}
 />
 </Form.Root>
 </TabPanel>
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/VerifyDomainPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ export const VerifyDomainPage = withCardStateProvider(() => {

 const [success, setSuccess] = React.useState(false);

 const { data: domain, status: domainStatus } = useFetch(organization?.getDomain, {
 const { data: domain, isLoading: domainIsLoading } = useFetch(organization?.getDomain, {
 domainId: params.id,
 });
 const title = localizationKeys('organizationProfile.verifyDomainPage.title');
Expand DownExpand Up@@ -122,7 +122,7 @@ export const VerifyDomainPage = withCardStateProvider(() => {
 });
 };

 if (domainStatus.isLoading || !domain) {
 if (domainIsLoading || !domain) {
 return (
 <Flex
 direction={'row'}
Expand Down

4 changes: 4 additions & 0 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/__tests__/InviteMembersPage.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,12 +6,16 @@ import React from 'react';

import { ClerkAPIResponseError } from '../../../../core/resources';
import { render } from '../../../../testUtils';
import { clearFetchCache } from '../../../hooks';
import { bindCreateFixtures } from '../../../utils/test/createFixtures';
import { InviteMembersPage } from '../InviteMembersPage';

const { createFixtures } = bindCreateFixtures('OrganizationProfile');

describe('InviteMembersPage', () => {
 beforeEach(() => {
 clearFetchCache();
 });
 it('renders the component', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withOrganizations();
Expand Down

8 changes: 8 additions & 0 deletions
...ges/clerk-js/src/ui/components/OrganizationProfile/__tests__/OrganizationMembers.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import { act, waitFor } from '@testing-library/react';
import userEvent from '@testing-library/user-event';

import { render } from '../../../../testUtils';
import { clearFetchCache } from '../../../hooks/useFetch';
import { bindCreateFixtures } from '../../../utils/test/createFixtures';
import { runFakeTimers } from '../../../utils/test/runFakeTimers';
import { OrganizationMembers } from '../OrganizationMembers';
Expand All@@ -12,6 +13,13 @@ import { createFakeMember, createFakeOrganizationInvitation, createFakeOrganizat
const { createFixtures } = bindCreateFixtures('OrganizationProfile');

describe('OrganizationMembers', () => {
 /**
 * `<OrganizationMembers/>` internally uses useFetch which caches the results, be sure to clear the cache before each test
 */
 beforeEach(() => {
 clearFetchCache();
 });

 it('renders the Organization Members page', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withOrganizations();
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/ui/components/OrganizationSwitcher/OrganizationSwitcherPopover.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -145,6 +145,7 @@ export const OrganizationSwitcherPopover = React.forwardRef<HTMLDivElement, Orga
 gap={4}
 organization={currentOrg}
 user={user}
 fetchRoles
 sx={theme => t => ({ padding: `0 ${theme.space.$6}`, marginBottom: t.space.$2 })}
 />
 <Actions role='menu'>
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/ui/components/OrganizationSwitcher/OrganizationSwitcherTrigger.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,7 @@ export const OrganizationSwitcherTrigger = withAvatarShimmer(
 elementId={'organizationSwitcher'}
 gap={3}
 size={'sm'}
 fetchRoles
 organization={organization}
 sx={{ maxWidth: '30ch' }}
 />
Expand Down

1 change: 1 addition & 0 deletions
...s/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,7 @@ describe('OrganizationSwitcher', () => {
 });
 });

 fixtures.clerk.organization?.getRoles.mockRejectedValue(null);
 fixtures.clerk.user?.getOrganizationInvitations.mockReturnValueOnce(
 Promise.resolve({
 data: [],
Expand Down

13 changes: 10 additions & 3 deletions
packages/clerk-js/src/ui/elements/OrganizationPreview.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,8 @@ import type { OrganizationPreviewId, UserOrganizationInvitationResource, UserRes
import React from 'react';

import { descriptors, Flex, Text } from '../customizables';
import { useFetchRoles, useLocalizeCustomRoles } from '../hooks/useFetchRoles';
import type { PropsOfComponent, ThemableCssProp } from '../styledSystem';
import { roleLocalizationKey } from '../utils';
import { OrganizationAvatar } from './OrganizationAvatar';

export type OrganizationPreviewProps = Omit<PropsOfComponent<typeof Flex>, 'elementId'> & {
Expand All@@ -16,6 +16,7 @@ export type OrganizationPreviewProps = Omit<PropsOfComponent<typeof Flex>, 'elem
 badge?: React.ReactNode;
 rounded?: boolean;
 elementId?: OrganizationPreviewId;
 fetchRoles?: boolean;
};

export const OrganizationPreview = (props: OrganizationPreviewProps) => {
Expand All@@ -24,6 +25,7 @@ export const OrganizationPreview = (props: OrganizationPreviewProps) => {
 size = 'md',
 icon,
 rounded = false,
 fetchRoles = false,
 badge,
 sx,
 user,
Expand All@@ -32,7 +34,12 @@ export const OrganizationPreview = (props: OrganizationPreviewProps) => {
 elementId,
 ...rest
 } = props;
 const role = user?.organizationMemberships.find(membership => membership.organization.id === organization.id)?.role;

 const { localizeCustomRole } = useLocalizeCustomRoles();
 const { options } = useFetchRoles(fetchRoles);

 const membership = user?.organizationMemberships.find(membership => membership.organization.id === organization.id);
 const unlocalizedRoleLabel = options?.find(a => a.value === membership?.role)?.label;

 return (
 <Flex
Expand DownExpand Up@@ -80,7 +87,7 @@ export const OrganizationPreview = (props: OrganizationPreviewProps) => {
 <Text
 elementDescriptor={descriptors.organizationPreviewSecondaryIdentifier}
 elementId={descriptors.organizationPreviewSecondaryIdentifier.setId(elementId)}
 localizationKey={role && roleLocalizationKey(role)}
 localizationKey={localizeCustomRole(membership?.role) || unlocalizedRoleLabel}
 variant='smallRegular'
 colorScheme='neutral'
 truncate
Expand Down

119 changes: 97 additions & 22 deletions
packages/clerk-js/src/ui/hooks/useFetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,44 +1,119 @@
import { useEffect, useRef } from 'react';
import { useCallback, useEffect, useRef, useSyncExternalStore } from 'react';

import { useLoadingStatus } from './useLoadingStatus';
import { useSafeState } from './useSafeState';
export type State<Data = any, Error = any> = {
 data: Data | null;
 error: Error | null;
 /**
 * if there's an ongoing request and no "loaded data"
 */
 isLoading: boolean;
 /**
 * if there's a request or revalidation loading
 */
 isValidating: boolean;
 cachedAt?: number;
};

/**
 * Global cache for storing status of fetched resources
 */
let requestCache = new Map<string, State>();

/**
 * A set to store subscribers in order to notify when the value of a key of `requestCache` changes
 */
const subscribers = new Set<() => void>();

/**
 * This utility should only be used in tests to clear previously fetched data
 */
export const clearFetchCache = () => {
 requestCache = new Map<string, State>();
};

const serialize = (obj: unknown) => JSON.stringify(obj);

export const useFetch = <T>(
const useCache = <K = any, V = any>(
 key: K,
): {
 getCache: () => State<V> | undefined;
 setCache: (state: State) => void;
 subscribeCache: (callback: () => void) => () => void;
} => {
 const serializedKey = serialize(key);
 const get = useCallback(() => requestCache.get(serializedKey), [serializedKey]);
 const set = useCallback(
 (data: State) => {
 requestCache.set(serializedKey, data);
 subscribers.forEach(callback => callback());
 },
 [serializedKey],
 );
 const subscribe = useCallback((callback: () => void) => {
 subscribers.add(callback);
 return () => subscribers.delete(callback);
 }, []);

 return {
 getCache: get,
 setCache: set,
 subscribeCache: subscribe,
 };
};

export const useFetch = <K, T>(
 fetcher: ((...args: any) => Promise<T>) | undefined,
 params: any,
 params: K,
 callbacks?: {
 onSuccess?: (data: T) => void;
 },
) => {
 const [data, setData] = useSafeState<T | null>(null);
 const requestStatus = useLoadingStatus({
 status: 'loading',
 });

 const { subscribeCache, getCache, setCache } = useCache<K, T>(params);
 const fetcherRef = useRef(fetcher);

 const cached = useSyncExternalStore(subscribeCache, getCache);

 useEffect(() => {
 if (!fetcherRef.current) {
 const fetcherMissing = !fetcherRef.current;
 const isCacheStale = Date.now() - (getCache()?.cachedAt || 0) < 1000 * 60 * 2; //cache for 2 minutes;
 const isRequestOnGoing = getCache()?.isValidating;

 if (fetcherMissing || isCacheStale || isRequestOnGoing) {
 return;
 }
 requestStatus.setLoading();
 fetcherRef
 .current(params)

 setCache({
 data: null,
 isLoading: !getCache(),
 isValidating: true,
 error: null,
 });
 fetcherRef.current!(params)
 .then(result => {
 requestStatus.setIdle();
 if (typeof result !== 'undefined') {
 setData(typeof result === 'object' ? { ...result } : result);
 callbacks?.onSuccess?.(typeof result === 'object' ? { ...result } : result);
 const data = typeof result === 'object' ? { ...result } : result;
 setCache({
 data,
 isLoading: false,
 isValidating: false,
 error: null,
 cachedAt: Date.now(),
 });
 callbacks?.onSuccess?.(data);
 }
 })
 .catch(() => {
 requestStatus.setError();
 setData(null);
 setCache({
 data: null,
 isLoading: false,
 isValidating: false,
 error: true,
 cachedAt: Date.now(),
 });
 });
 }, [JSON.stringify(params)]);
 }, [serialize(params), setCache, getCache]);

 return {
 status: requestStatus,
 data,
 ...cached,
 };
};

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/hooks/useFetchRoles.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,12 +10,12 @@ const getRolesParams = {
 */
 pageSize: 20,
};
export const useFetchRoles = () => {
export const useFetchRoles = (enabled = true) => {
 const { organization } = useCoreOrganization();
 const { data, status } = useFetch(organization?.getRoles, getRolesParams);
 const { data, isLoading } = useFetch(enabled ? organization?.getRoles : undefined, getRolesParams);

 return {
 isLoading: status.isLoading,
 isLoading,
 options: data?.data?.map(role => ({ value: role.key, label: role.name })),
 };
};
Expand Down