Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/heavy-suns-divide.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Fixes a bug where billing hooks would attempt to fetch billing information for an organization member with insufficient permissions, resulting in a 403 error.
5 changes: 5 additions & 0 deletions .changeset/thin-swans-punch.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': minor
---

Billing hooks now accept a `{ enabled: boolean }` option, that controls the whether or not a request will fire.
Original file line numberDiff line numberDiff line change
Expand Up@@ -85,8 +85,8 @@ describe('OrganizationProfile', () => {

render(<OrganizationProfile />, { wrapper });
await waitFor(() => expect(screen.queryByText('Billing')).toBeNull());
expect(fixtures.clerk.billing.getSubscription).toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).toHaveBeenCalled();
expect(fixtures.clerk.billing.getSubscription).not.toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).not.toHaveBeenCalled();
});

it('does not include Billing when missing billing permission even with paid plans', async () => {
Expand All@@ -109,9 +109,8 @@ describe('OrganizationProfile', () => {
render(<OrganizationProfile />, { wrapper });
await waitFor(() => expect(screen.queryByText('Billing')).toBeNull());

// TODO(@RQ_MIGRATION): Offer a way to disable these, because they fire unnecessary requests.
expect(fixtures.clerk.billing.getSubscription).toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).toHaveBeenCalled();
expect(fixtures.clerk.billing.getSubscription).not.toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).not.toHaveBeenCalled();
});
it('does not include Billing when organization billing is disabled', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,11 @@ describe('PricingTable - plans visibility', () => {
// Should show plans when signed out
expect(getByRole('heading', { name: 'Test Plan' })).toBeVisible();
});

// Ensure API args reflect user context by default
expect(fixtures.clerk.billing.getPlans).toHaveBeenCalledWith(expect.objectContaining({ for: 'user' }));
// Signed-out users should not fetch subscriptions
expect(fixtures.clerk.billing.getSubscription).not.toHaveBeenCalled();
});
Comment thread
panteliselef marked this conversation as resolved.

it('shows no plans when user is signed in but subscription is null', async () => {
Expand DownExpand Up@@ -517,7 +522,15 @@ describe('PricingTable - plans visibility', () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({ email_addresses: ['test@clerk.com'], organization_memberships: ['Org1'] });
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:manage'],
},
],
});
});

// Set legacy prop via context provider
Expand DownExpand Up@@ -572,7 +585,15 @@ describe('PricingTable - plans visibility', () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({ email_addresses: ['test@clerk.com'], organization_memberships: ['Org1'] });
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:read'],
},
],
});
});

// Set new prop via context provider
Expand Down
55 changes: 28 additions & 27 deletions packages/clerk-js/src/ui/contexts/components/Plans.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import {
__experimental_useStatements,
__experimental_useSubscription,
useClerk,
useOrganization,
useSession,
} from '@clerk/shared/react';
import type {
Expand All@@ -15,6 +16,7 @@ import type {
} from '@clerk/shared/types';
import { useCallback, useMemo } from 'react';

import { useProtect } from '@/ui/common/Gate';
import { getClosestProfileScrollBox } from '@/ui/utils/getClosestProfileScrollBox';

import type { LocalizationKey } from '../../localization';
Expand All@@ -28,44 +30,42 @@ export function normalizeFormatted(formatted: string) {
return formatted.endsWith('.00') ? formatted.slice(0, -3) : formatted;
}

// TODO(@COMMERCE): Rename payment sources to payment methods at the API level
export const usePaymentMethods = () => {
const useBillingHookParams = () => {
const subscriberType = useSubscriberTypeContext();
return __experimental_usePaymentMethods({
const { organization } = useOrganization();
const allowBillingRoutes = useProtect(
has =>
has({
permission: 'org:sys_billing:read',
}) || has({ permission: 'org:sys_billing:manage' }),
);

return {
for: subscriberType,
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
});
// If the user is in an organization, only fetch billing data if they have the necessary permissions
enabled: subscriberType === 'organization' ? Boolean(organization) && allowBillingRoutes : true,
};
};

export const usePaymentMethods = () => {
const params = useBillingHookParams();
return __experimental_usePaymentMethods(params);
};

export const usePaymentAttempts = () => {
const subscriberType = useSubscriberTypeContext();
return __experimental_usePaymentAttempts({
for: subscriberType,
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
});
const params = useBillingHookParams();
return __experimental_usePaymentAttempts(params);
};

export const useStatements = (params?: { mode: 'cache' }) => {
const subscriberType = useSubscriberTypeContext();
return __experimental_useStatements({
for: subscriberType,
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
__experimental_mode: params?.mode,
});
export const useStatements = (externalParams?: { mode: 'cache' }) => {
const params = useBillingHookParams();
return __experimental_useStatements({ ...params, __experimental_mode: externalParams?.mode });
};

export const useSubscription = () => {
const subscriberType = useSubscriberTypeContext();
const subscription = __experimental_useSubscription({
for: subscriberType,
keepPreviousData: true,
});
const params = useBillingHookParams();
const subscription = __experimental_useSubscription(params);
const subscriptionItems = useMemo(
() => subscription.data?.subscriptionItems || [],
[subscription.data?.subscriptionItems],
Expand All@@ -85,6 +85,7 @@ export const usePlans = (params?: { mode: 'cache' }) => {
initialPage: 1,
pageSize: 50,
keepPreviousData: true,
enabled: true,
__experimental_mode: params?.mode,
});
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,26 @@ describe('createBillingPaginatedHook', () => {
expect(result.current.isFetching).toBe(false);
});

it('does not fetch when enabled is false', () => {
const { result } = renderHook(() => useDummyAuth({ initialPage: 1, pageSize: 4, enabled: false }), { wrapper });

expect(useFetcherMock).toHaveBeenCalledWith('user');

expect(fetcherMock).not.toHaveBeenCalled();
expect(result.current.isLoading).toBe(false);
expect(result.current.isFetching).toBe(false);
expect(result.current.data).toEqual([]);
});

it('fetches when enabled is true', async () => {
const { result } = renderHook(() => useDummyAuth({ initialPage: 1, pageSize: 4, enabled: true }), { wrapper });

await waitFor(() => expect(result.current.isLoading).toBe(false));
expect(useFetcherMock).toHaveBeenCalledWith('user');
expect(fetcherMock).toHaveBeenCalled();
expect(fetcherMock.mock.calls[0][0]).toStrictEqual({ initialPage: 1, pageSize: 4 });
});

it('authenticated hook: does not fetch when user is null', () => {
mockUser = null;

Expand Down
15 changes: 12 additions & 3 deletions packages/shared/src/react/hooks/createBillingPaginatedHook.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,14 +43,23 @@ export function createBillingPaginatedHook<TResource extends ClerkResource, TPar
useFetcher,
options,
}: BillingHookConfig<TResource, TParams>) {
type HookParams = PaginatedHookConfig<PagesOrInfiniteOptions> & {
type HookParams = PaginatedHookConfig<
PagesOrInfiniteOptions & {
/**
* If `true`, a request will be triggered when the hook is mounted.
*
* @default true
*/
enabled?: boolean;
}
> & {
for?: ForPayerType;
};

return function useBillingHook<T extends HookParams>(
params?: T,
): PaginatedResources<TResource, T extends { infinite: true } ? true : false> {
const { for: _for, ...paginationParams } = params || ({} as Partial<T>);
const { for: _for, enabled: externalEnabled, ...paginationParams } = params || ({} as Partial<T>);

const safeFor = _for || 'user';

Expand DownExpand Up@@ -90,7 +99,7 @@ export function createBillingPaginatedHook<TResource extends ClerkResource, TPar
? environment?.commerceSettings.billing.organization.enabled
: environment?.commerceSettings.billing.user.enabled;

const isEnabled = !!hookParams && clerk.loaded && !!billingEnabled;
const isEnabled = !!hookParams && clerk.loaded && !!billingEnabled && (externalEnabled ?? true);

const result = usePagesOrInfinite<TParams, ClerkPaginatedResponse<TResource>>(
(hookParams || {}) as TParams,
Expand Down
10 changes: 6 additions & 4 deletions packages/shared/src/react/hooks/useSubscription.rq.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ import {
} from '../contexts';
import type { SubscriptionResult, UseSubscriptionParams } from './useSubscription.types';

const hookName = 'useSubscription';
const HOOK_NAME = 'useSubscription';

/**
* This is the new implementation of useSubscription using React Query.
Expand All@@ -21,7 +21,7 @@ const hookName = 'useSubscription';
* @internal
*/
export function useSubscription(params?: UseSubscriptionParams): SubscriptionResult {
useAssertWrappedByClerkProvider(hookName);
useAssertWrappedByClerkProvider(HOOK_NAME);

const clerk = useClerkInstanceContext();
const user = useUserContext();
Expand All@@ -30,7 +30,7 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes
// @ts-expect-error `__unstable__environment` is not typed
const environment = clerk.__unstable__environment as unknown as EnvironmentResource | null | undefined;

clerk.telemetry?.record(eventMethodCalled(hookName));
clerk.telemetry?.record(eventMethodCalled(HOOK_NAME));

const isOrganization = params?.for === 'organization';
const billingEnabled = isOrganization
Expand All@@ -49,14 +49,16 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes
];
}, [user?.id, isOrganization, organization?.id]);

const queriesEnabled = Boolean(user?.id && billingEnabled) && (params?.enabled ?? true);

const query = useClerkQuery({
queryKey,
queryFn: ({ queryKey }) => {
const obj = queryKey[1] as { args: { orgId?: string } };
return clerk.billing.getSubscription(obj.args);
},
staleTime: 1_000 * 60,
enabled: Boolean(user?.id && billingEnabled) && ((params as any)?.enabled ?? true),
enabled: queriesEnabled,
// TODO(@RQ_MIGRATION): Add support for keepPreviousData
});

Expand Down
3 changes: 2 additions & 1 deletion packages/shared/src/react/hooks/useSubscription.swr.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,9 +35,10 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes
const billingEnabled = isOrganization
? environment?.commerceSettings.billing.organization.enabled
: environment?.commerceSettings.billing.user.enabled;
const isEnabled = (params?.enabled ?? true) && billingEnabled;

const swr = useSWR(
billingEnabled
isEnabled
? {
type: 'commerce-subscription',
userId: user?.id,
Expand Down
6 changes: 6 additions & 0 deletions packages/shared/src/react/hooks/useSubscription.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,12 @@ export type UseSubscriptionParams = {
* Defaults to false.
*/
keepPreviousData?: boolean;
/**
* If `true`, a request will be triggered when the hook is mounted.
*
* @default true
*/
enabled?: boolean;
};

export type SubscriptionResult = {
Expand Down
Loading
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/heavy-suns-divide.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Fixes a bug where billing hooks would attempt to fetch billing information for an organization member with insufficient permissions, resulting in a 403 error.
5 changes: 5 additions & 0 deletions .changeset/thin-swans-punch.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': minor
---

Billing hooks now accept a `{ enabled: boolean }` option, that controls the whether or not a request will fire.
Original file line numberDiff line numberDiff line change
Expand Up@@ -85,8 +85,8 @@ describe('OrganizationProfile', () => {

render(<OrganizationProfile />, { wrapper });
await waitFor(() => expect(screen.queryByText('Billing')).toBeNull());
expect(fixtures.clerk.billing.getSubscription).toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).toHaveBeenCalled();
expect(fixtures.clerk.billing.getSubscription).not.toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).not.toHaveBeenCalled();
});

it('does not include Billing when missing billing permission even with paid plans', async () => {
Expand All@@ -109,9 +109,8 @@ describe('OrganizationProfile', () => {
render(<OrganizationProfile />, { wrapper });
await waitFor(() => expect(screen.queryByText('Billing')).toBeNull());

// TODO(@RQ_MIGRATION): Offer a way to disable these, because they fire unnecessary requests.
expect(fixtures.clerk.billing.getSubscription).toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).toHaveBeenCalled();
expect(fixtures.clerk.billing.getSubscription).not.toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).not.toHaveBeenCalled();
});
it('does not include Billing when organization billing is disabled', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,11 @@ describe('PricingTable - plans visibility', () => {
// Should show plans when signed out
expect(getByRole('heading', { name: 'Test Plan' })).toBeVisible();
});

// Ensure API args reflect user context by default
expect(fixtures.clerk.billing.getPlans).toHaveBeenCalledWith(expect.objectContaining({ for: 'user' }));
// Signed-out users should not fetch subscriptions
expect(fixtures.clerk.billing.getSubscription).not.toHaveBeenCalled();
});
Comment thread
panteliselef marked this conversation as resolved.

it('shows no plans when user is signed in but subscription is null', async () => {
Expand DownExpand Up@@ -517,7 +522,15 @@ describe('PricingTable - plans visibility', () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({ email_addresses: ['test@clerk.com'], organization_memberships: ['Org1'] });
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:manage'],
},
],
});
});

// Set legacy prop via context provider
Expand DownExpand Up@@ -572,7 +585,15 @@ describe('PricingTable - plans visibility', () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({ email_addresses: ['test@clerk.com'], organization_memberships: ['Org1'] });
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:read'],
},
],
});
});

// Set new prop via context provider
Expand Down
55 changes: 28 additions & 27 deletions packages/clerk-js/src/ui/contexts/components/Plans.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import {
__experimental_useStatements,
__experimental_useSubscription,
useClerk,
useOrganization,
useSession,
} from '@clerk/shared/react';
import type {
Expand All@@ -15,6 +16,7 @@ import type {
} from '@clerk/shared/types';
import { useCallback, useMemo } from 'react';

import { useProtect } from '@/ui/common/Gate';
import { getClosestProfileScrollBox } from '@/ui/utils/getClosestProfileScrollBox';

import type { LocalizationKey } from '../../localization';
Expand All@@ -28,44 +30,42 @@ export function normalizeFormatted(formatted: string) {
return formatted.endsWith('.00') ? formatted.slice(0, -3) : formatted;
}

// TODO(@COMMERCE): Rename payment sources to payment methods at the API level
export const usePaymentMethods = () => {
const useBillingHookParams = () => {
const subscriberType = useSubscriberTypeContext();
return __experimental_usePaymentMethods({
const { organization } = useOrganization();
const allowBillingRoutes = useProtect(
has =>
has({
permission: 'org:sys_billing:read',
}) || has({ permission: 'org:sys_billing:manage' }),
);

return {
for: subscriberType,
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
});
// If the user is in an organization, only fetch billing data if they have the necessary permissions
enabled: subscriberType === 'organization' ? Boolean(organization) && allowBillingRoutes : true,
};
};

export const usePaymentMethods = () => {
const params = useBillingHookParams();
return __experimental_usePaymentMethods(params);
};

export const usePaymentAttempts = () => {
const subscriberType = useSubscriberTypeContext();
return __experimental_usePaymentAttempts({
for: subscriberType,
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
});
const params = useBillingHookParams();
return __experimental_usePaymentAttempts(params);
};

export const useStatements = (params?: { mode: 'cache' }) => {
const subscriberType = useSubscriberTypeContext();
return __experimental_useStatements({
for: subscriberType,
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
__experimental_mode: params?.mode,
});
export const useStatements = (externalParams?: { mode: 'cache' }) => {
const params = useBillingHookParams();
return __experimental_useStatements({ ...params, __experimental_mode: externalParams?.mode });
};

export const useSubscription = () => {
const subscriberType = useSubscriberTypeContext();
const subscription = __experimental_useSubscription({
for: subscriberType,
keepPreviousData: true,
});
const params = useBillingHookParams();
const subscription = __experimental_useSubscription(params);
const subscriptionItems = useMemo(
() => subscription.data?.subscriptionItems || [],
[subscription.data?.subscriptionItems],
Expand All@@ -85,6 +85,7 @@ export const usePlans = (params?: { mode: 'cache' }) => {
initialPage: 1,
pageSize: 50,
keepPreviousData: true,
enabled: true,
__experimental_mode: params?.mode,
});
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,26 @@ describe('createBillingPaginatedHook', () => {
expect(result.current.isFetching).toBe(false);
});

it('does not fetch when enabled is false', () => {
const { result } = renderHook(() => useDummyAuth({ initialPage: 1, pageSize: 4, enabled: false }), { wrapper });

expect(useFetcherMock).toHaveBeenCalledWith('user');

expect(fetcherMock).not.toHaveBeenCalled();
expect(result.current.isLoading).toBe(false);
expect(result.current.isFetching).toBe(false);
expect(result.current.data).toEqual([]);
});

it('fetches when enabled is true', async () => {
const { result } = renderHook(() => useDummyAuth({ initialPage: 1, pageSize: 4, enabled: true }), { wrapper });

await waitFor(() => expect(result.current.isLoading).toBe(false));
expect(useFetcherMock).toHaveBeenCalledWith('user');
expect(fetcherMock).toHaveBeenCalled();
expect(fetcherMock.mock.calls[0][0]).toStrictEqual({ initialPage: 1, pageSize: 4 });
});

it('authenticated hook: does not fetch when user is null', () => {
mockUser = null;

Expand Down
15 changes: 12 additions & 3 deletions packages/shared/src/react/hooks/createBillingPaginatedHook.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,14 +43,23 @@ export function createBillingPaginatedHook<TResource extends ClerkResource, TPar
useFetcher,
options,
}: BillingHookConfig<TResource, TParams>) {
type HookParams = PaginatedHookConfig<PagesOrInfiniteOptions> & {
type HookParams = PaginatedHookConfig<
PagesOrInfiniteOptions & {
/**
* If `true`, a request will be triggered when the hook is mounted.
*
* @default true
*/
enabled?: boolean;
}
> & {
for?: ForPayerType;
};

return function useBillingHook<T extends HookParams>(
params?: T,
): PaginatedResources<TResource, T extends { infinite: true } ? true : false> {
const { for: _for, ...paginationParams } = params || ({} as Partial<T>);
const { for: _for, enabled: externalEnabled, ...paginationParams } = params || ({} as Partial<T>);

const safeFor = _for || 'user';

Expand DownExpand Up@@ -90,7 +99,7 @@ export function createBillingPaginatedHook<TResource extends ClerkResource, TPar
? environment?.commerceSettings.billing.organization.enabled
: environment?.commerceSettings.billing.user.enabled;

const isEnabled = !!hookParams && clerk.loaded && !!billingEnabled;
const isEnabled = !!hookParams && clerk.loaded && !!billingEnabled && (externalEnabled ?? true);

const result = usePagesOrInfinite<TParams, ClerkPaginatedResponse<TResource>>(
(hookParams || {}) as TParams,
Expand Down
10 changes: 6 additions & 4 deletions packages/shared/src/react/hooks/useSubscription.rq.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ import {
} from '../contexts';
import type { SubscriptionResult, UseSubscriptionParams } from './useSubscription.types';

const hookName = 'useSubscription';
const HOOK_NAME = 'useSubscription';

/**
* This is the new implementation of useSubscription using React Query.
Expand All@@ -21,7 +21,7 @@ const hookName = 'useSubscription';
* @internal
*/
export function useSubscription(params?: UseSubscriptionParams): SubscriptionResult {
useAssertWrappedByClerkProvider(hookName);
useAssertWrappedByClerkProvider(HOOK_NAME);

const clerk = useClerkInstanceContext();
const user = useUserContext();
Expand All@@ -30,7 +30,7 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes
// @ts-expect-error `__unstable__environment` is not typed
const environment = clerk.__unstable__environment as unknown as EnvironmentResource | null | undefined;

clerk.telemetry?.record(eventMethodCalled(hookName));
clerk.telemetry?.record(eventMethodCalled(HOOK_NAME));

const isOrganization = params?.for === 'organization';
const billingEnabled = isOrganization
Expand All@@ -49,14 +49,16 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes
];
}, [user?.id, isOrganization, organization?.id]);

const queriesEnabled = Boolean(user?.id && billingEnabled) && (params?.enabled ?? true);

const query = useClerkQuery({
queryKey,
queryFn: ({ queryKey }) => {
const obj = queryKey[1] as { args: { orgId?: string } };
return clerk.billing.getSubscription(obj.args);
},
staleTime: 1_000 * 60,
enabled: Boolean(user?.id && billingEnabled) && ((params as any)?.enabled ?? true),
enabled: queriesEnabled,
// TODO(@RQ_MIGRATION): Add support for keepPreviousData
});

Expand Down
3 changes: 2 additions & 1 deletion packages/shared/src/react/hooks/useSubscription.swr.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,9 +35,10 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes
const billingEnabled = isOrganization
? environment?.commerceSettings.billing.organization.enabled
: environment?.commerceSettings.billing.user.enabled;
const isEnabled = (params?.enabled ?? true) && billingEnabled;

const swr = useSWR(
billingEnabled
isEnabled
? {
type: 'commerce-subscription',
userId: user?.id,
Expand Down
6 changes: 6 additions & 0 deletions packages/shared/src/react/hooks/useSubscription.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,12 @@ export type UseSubscriptionParams = {
* Defaults to false.
*/
keepPreviousData?: boolean;
/**
* If `true`, a request will be triggered when the hook is mounted.
*
* @default true
*/
enabled?: boolean;
};

export type SubscriptionResult = {
Expand Down
Loading
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/heavy-suns-divide.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Fixes a bug where billing hooks would attempt to fetch billing information for an organization member with insufficient permissions, resulting in a 403 error.
5 changes: 5 additions & 0 deletions .changeset/thin-swans-punch.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': minor
---

Billing hooks now accept a `{ enabled: boolean }` option, that controls the whether or not a request will fire.
Original file line numberDiff line numberDiff line change
Expand Up@@ -85,8 +85,8 @@ describe('OrganizationProfile', () => {

render(<OrganizationProfile />, { wrapper });
await waitFor(() => expect(screen.queryByText('Billing')).toBeNull());
expect(fixtures.clerk.billing.getSubscription).toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).toHaveBeenCalled();
expect(fixtures.clerk.billing.getSubscription).not.toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).not.toHaveBeenCalled();
});

it('does not include Billing when missing billing permission even with paid plans', async () => {
Expand All@@ -109,9 +109,8 @@ describe('OrganizationProfile', () => {
render(<OrganizationProfile />, { wrapper });
await waitFor(() => expect(screen.queryByText('Billing')).toBeNull());

// TODO(@RQ_MIGRATION): Offer a way to disable these, because they fire unnecessary requests.
expect(fixtures.clerk.billing.getSubscription).toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).toHaveBeenCalled();
expect(fixtures.clerk.billing.getSubscription).not.toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).not.toHaveBeenCalled();
});
it('does not include Billing when organization billing is disabled', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,11 @@ describe('PricingTable - plans visibility', () => {
// Should show plans when signed out
expect(getByRole('heading', { name: 'Test Plan' })).toBeVisible();
});

// Ensure API args reflect user context by default
expect(fixtures.clerk.billing.getPlans).toHaveBeenCalledWith(expect.objectContaining({ for: 'user' }));
// Signed-out users should not fetch subscriptions
expect(fixtures.clerk.billing.getSubscription).not.toHaveBeenCalled();
});
Comment thread
panteliselef marked this conversation as resolved.

it('shows no plans when user is signed in but subscription is null', async () => {
Expand DownExpand Up@@ -517,7 +522,15 @@ describe('PricingTable - plans visibility', () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({ email_addresses: ['test@clerk.com'], organization_memberships: ['Org1'] });
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:manage'],
},
],
});
});

// Set legacy prop via context provider
Expand DownExpand Up@@ -572,7 +585,15 @@ describe('PricingTable - plans visibility', () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({ email_addresses: ['test@clerk.com'], organization_memberships: ['Org1'] });
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:read'],
},
],
});
});

// Set new prop via context provider
Expand Down
55 changes: 28 additions & 27 deletions packages/clerk-js/src/ui/contexts/components/Plans.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import {
__experimental_useStatements,
__experimental_useSubscription,
useClerk,
useOrganization,
useSession,
} from '@clerk/shared/react';
import type {
Expand All@@ -15,6 +16,7 @@ import type {
} from '@clerk/shared/types';
import { useCallback, useMemo } from 'react';

import { useProtect } from '@/ui/common/Gate';
import { getClosestProfileScrollBox } from '@/ui/utils/getClosestProfileScrollBox';

import type { LocalizationKey } from '../../localization';
Expand All@@ -28,44 +30,42 @@ export function normalizeFormatted(formatted: string) {
return formatted.endsWith('.00') ? formatted.slice(0, -3) : formatted;
}

// TODO(@COMMERCE): Rename payment sources to payment methods at the API level
export const usePaymentMethods = () => {
const useBillingHookParams = () => {
const subscriberType = useSubscriberTypeContext();
return __experimental_usePaymentMethods({
const { organization } = useOrganization();
const allowBillingRoutes = useProtect(
has =>
has({
permission: 'org:sys_billing:read',
}) || has({ permission: 'org:sys_billing:manage' }),
);

return {
for: subscriberType,
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
});
// If the user is in an organization, only fetch billing data if they have the necessary permissions
enabled: subscriberType === 'organization' ? Boolean(organization) && allowBillingRoutes : true,
};
};

export const usePaymentMethods = () => {
const params = useBillingHookParams();
return __experimental_usePaymentMethods(params);
};

export const usePaymentAttempts = () => {
const subscriberType = useSubscriberTypeContext();
return __experimental_usePaymentAttempts({
for: subscriberType,
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
});
const params = useBillingHookParams();
return __experimental_usePaymentAttempts(params);
};

export const useStatements = (params?: { mode: 'cache' }) => {
const subscriberType = useSubscriberTypeContext();
return __experimental_useStatements({
for: subscriberType,
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
__experimental_mode: params?.mode,
});
export const useStatements = (externalParams?: { mode: 'cache' }) => {
const params = useBillingHookParams();
return __experimental_useStatements({ ...params, __experimental_mode: externalParams?.mode });
};

export const useSubscription = () => {
const subscriberType = useSubscriberTypeContext();
const subscription = __experimental_useSubscription({
for: subscriberType,
keepPreviousData: true,
});
const params = useBillingHookParams();
const subscription = __experimental_useSubscription(params);
const subscriptionItems = useMemo(
() => subscription.data?.subscriptionItems || [],
[subscription.data?.subscriptionItems],
Expand All@@ -85,6 +85,7 @@ export const usePlans = (params?: { mode: 'cache' }) => {
initialPage: 1,
pageSize: 50,
keepPreviousData: true,
enabled: true,
__experimental_mode: params?.mode,
});
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,26 @@ describe('createBillingPaginatedHook', () => {
expect(result.current.isFetching).toBe(false);
});

it('does not fetch when enabled is false', () => {
const { result } = renderHook(() => useDummyAuth({ initialPage: 1, pageSize: 4, enabled: false }), { wrapper });

expect(useFetcherMock).toHaveBeenCalledWith('user');

expect(fetcherMock).not.toHaveBeenCalled();
expect(result.current.isLoading).toBe(false);
expect(result.current.isFetching).toBe(false);
expect(result.current.data).toEqual([]);
});

it('fetches when enabled is true', async () => {
const { result } = renderHook(() => useDummyAuth({ initialPage: 1, pageSize: 4, enabled: true }), { wrapper });

await waitFor(() => expect(result.current.isLoading).toBe(false));
expect(useFetcherMock).toHaveBeenCalledWith('user');
expect(fetcherMock).toHaveBeenCalled();
expect(fetcherMock.mock.calls[0][0]).toStrictEqual({ initialPage: 1, pageSize: 4 });
});

it('authenticated hook: does not fetch when user is null', () => {
mockUser = null;

Expand Down
15 changes: 12 additions & 3 deletions packages/shared/src/react/hooks/createBillingPaginatedHook.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,14 +43,23 @@ export function createBillingPaginatedHook<TResource extends ClerkResource, TPar
useFetcher,
options,
}: BillingHookConfig<TResource, TParams>) {
type HookParams = PaginatedHookConfig<PagesOrInfiniteOptions> & {
type HookParams = PaginatedHookConfig<
PagesOrInfiniteOptions & {
/**
* If `true`, a request will be triggered when the hook is mounted.
*
* @default true
*/
enabled?: boolean;
}
> & {
for?: ForPayerType;
};

return function useBillingHook<T extends HookParams>(
params?: T,
): PaginatedResources<TResource, T extends { infinite: true } ? true : false> {
const { for: _for, ...paginationParams } = params || ({} as Partial<T>);
const { for: _for, enabled: externalEnabled, ...paginationParams } = params || ({} as Partial<T>);

const safeFor = _for || 'user';

Expand DownExpand Up@@ -90,7 +99,7 @@ export function createBillingPaginatedHook<TResource extends ClerkResource, TPar
? environment?.commerceSettings.billing.organization.enabled
: environment?.commerceSettings.billing.user.enabled;

const isEnabled = !!hookParams && clerk.loaded && !!billingEnabled;
const isEnabled = !!hookParams && clerk.loaded && !!billingEnabled && (externalEnabled ?? true);

const result = usePagesOrInfinite<TParams, ClerkPaginatedResponse<TResource>>(
(hookParams || {}) as TParams,
Expand Down
10 changes: 6 additions & 4 deletions packages/shared/src/react/hooks/useSubscription.rq.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ import {
} from '../contexts';
import type { SubscriptionResult, UseSubscriptionParams } from './useSubscription.types';

const hookName = 'useSubscription';
const HOOK_NAME = 'useSubscription';

/**
* This is the new implementation of useSubscription using React Query.
Expand All@@ -21,7 +21,7 @@ const hookName = 'useSubscription';
* @internal
*/
export function useSubscription(params?: UseSubscriptionParams): SubscriptionResult {
useAssertWrappedByClerkProvider(hookName);
useAssertWrappedByClerkProvider(HOOK_NAME);

const clerk = useClerkInstanceContext();
const user = useUserContext();
Expand All@@ -30,7 +30,7 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes
// @ts-expect-error `__unstable__environment` is not typed
const environment = clerk.__unstable__environment as unknown as EnvironmentResource | null | undefined;

clerk.telemetry?.record(eventMethodCalled(hookName));
clerk.telemetry?.record(eventMethodCalled(HOOK_NAME));

const isOrganization = params?.for === 'organization';
const billingEnabled = isOrganization
Expand All@@ -49,14 +49,16 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes
];
}, [user?.id, isOrganization, organization?.id]);

const queriesEnabled = Boolean(user?.id && billingEnabled) && (params?.enabled ?? true);

const query = useClerkQuery({
queryKey,
queryFn: ({ queryKey }) => {
const obj = queryKey[1] as { args: { orgId?: string } };
return clerk.billing.getSubscription(obj.args);
},
staleTime: 1_000 * 60,
enabled: Boolean(user?.id && billingEnabled) && ((params as any)?.enabled ?? true),
enabled: queriesEnabled,
// TODO(@RQ_MIGRATION): Add support for keepPreviousData
});

Expand Down
3 changes: 2 additions & 1 deletion packages/shared/src/react/hooks/useSubscription.swr.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,9 +35,10 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes
const billingEnabled = isOrganization
? environment?.commerceSettings.billing.organization.enabled
: environment?.commerceSettings.billing.user.enabled;
const isEnabled = (params?.enabled ?? true) && billingEnabled;

const swr = useSWR(
billingEnabled
isEnabled
? {
type: 'commerce-subscription',
userId: user?.id,
Expand Down
6 changes: 6 additions & 0 deletions packages/shared/src/react/hooks/useSubscription.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,12 @@ export type UseSubscriptionParams = {
* Defaults to false.
*/
keepPreviousData?: boolean;
/**
* If `true`, a request will be triggered when the hook is mounted.
*
* @default true
*/
enabled?: boolean;
};

export type SubscriptionResult = {
Expand Down
Loading
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/heavy-suns-divide.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Fixes a bug where billing hooks would attempt to fetch billing information for an organization member with insufficient permissions, resulting in a 403 error.
5 changes: 5 additions & 0 deletions .changeset/thin-swans-punch.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': minor
---

Billing hooks now accept a `{ enabled: boolean }` option, that controls the whether or not a request will fire.
Original file line numberDiff line numberDiff line change
Expand Up@@ -85,8 +85,8 @@ describe('OrganizationProfile', () => {

render(<OrganizationProfile />, { wrapper });
await waitFor(() => expect(screen.queryByText('Billing')).toBeNull());
expect(fixtures.clerk.billing.getSubscription).toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).toHaveBeenCalled();
expect(fixtures.clerk.billing.getSubscription).not.toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).not.toHaveBeenCalled();
});

it('does not include Billing when missing billing permission even with paid plans', async () => {
Expand All@@ -109,9 +109,8 @@ describe('OrganizationProfile', () => {
render(<OrganizationProfile />, { wrapper });
await waitFor(() => expect(screen.queryByText('Billing')).toBeNull());

// TODO(@RQ_MIGRATION): Offer a way to disable these, because they fire unnecessary requests.
expect(fixtures.clerk.billing.getSubscription).toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).toHaveBeenCalled();
expect(fixtures.clerk.billing.getSubscription).not.toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).not.toHaveBeenCalled();
});
it('does not include Billing when organization billing is disabled', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,11 @@ describe('PricingTable - plans visibility', () => {
// Should show plans when signed out
expect(getByRole('heading', { name: 'Test Plan' })).toBeVisible();
});

// Ensure API args reflect user context by default
expect(fixtures.clerk.billing.getPlans).toHaveBeenCalledWith(expect.objectContaining({ for: 'user' }));
// Signed-out users should not fetch subscriptions
expect(fixtures.clerk.billing.getSubscription).not.toHaveBeenCalled();
});
Comment thread
panteliselef marked this conversation as resolved.

it('shows no plans when user is signed in but subscription is null', async () => {
Expand DownExpand Up@@ -517,7 +522,15 @@ describe('PricingTable - plans visibility', () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({ email_addresses: ['test@clerk.com'], organization_memberships: ['Org1'] });
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:manage'],
},
],
});
});

// Set legacy prop via context provider
Expand DownExpand Up@@ -572,7 +585,15 @@ describe('PricingTable - plans visibility', () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({ email_addresses: ['test@clerk.com'], organization_memberships: ['Org1'] });
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:read'],
},
],
});
});

// Set new prop via context provider
Expand Down
55 changes: 28 additions & 27 deletions packages/clerk-js/src/ui/contexts/components/Plans.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import {
__experimental_useStatements,
__experimental_useSubscription,
useClerk,
useOrganization,
useSession,
} from '@clerk/shared/react';
import type {
Expand All@@ -15,6 +16,7 @@ import type {
} from '@clerk/shared/types';
import { useCallback, useMemo } from 'react';

import { useProtect } from '@/ui/common/Gate';
import { getClosestProfileScrollBox } from '@/ui/utils/getClosestProfileScrollBox';

import type { LocalizationKey } from '../../localization';
Expand All@@ -28,44 +30,42 @@ export function normalizeFormatted(formatted: string) {
return formatted.endsWith('.00') ? formatted.slice(0, -3) : formatted;
}

// TODO(@COMMERCE): Rename payment sources to payment methods at the API level
export const usePaymentMethods = () => {
const useBillingHookParams = () => {
const subscriberType = useSubscriberTypeContext();
return __experimental_usePaymentMethods({
const { organization } = useOrganization();
const allowBillingRoutes = useProtect(
has =>
has({
permission: 'org:sys_billing:read',
}) || has({ permission: 'org:sys_billing:manage' }),
);

return {
for: subscriberType,
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
});
// If the user is in an organization, only fetch billing data if they have the necessary permissions
enabled: subscriberType === 'organization' ? Boolean(organization) && allowBillingRoutes : true,
};
};

export const usePaymentMethods = () => {
const params = useBillingHookParams();
return __experimental_usePaymentMethods(params);
};

export const usePaymentAttempts = () => {
const subscriberType = useSubscriberTypeContext();
return __experimental_usePaymentAttempts({
for: subscriberType,
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
});
const params = useBillingHookParams();
return __experimental_usePaymentAttempts(params);
};

export const useStatements = (params?: { mode: 'cache' }) => {
const subscriberType = useSubscriberTypeContext();
return __experimental_useStatements({
for: subscriberType,
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
__experimental_mode: params?.mode,
});
export const useStatements = (externalParams?: { mode: 'cache' }) => {
const params = useBillingHookParams();
return __experimental_useStatements({ ...params, __experimental_mode: externalParams?.mode });
};

export const useSubscription = () => {
const subscriberType = useSubscriberTypeContext();
const subscription = __experimental_useSubscription({
for: subscriberType,
keepPreviousData: true,
});
const params = useBillingHookParams();
const subscription = __experimental_useSubscription(params);
const subscriptionItems = useMemo(
() => subscription.data?.subscriptionItems || [],
[subscription.data?.subscriptionItems],
Expand All@@ -85,6 +85,7 @@ export const usePlans = (params?: { mode: 'cache' }) => {
initialPage: 1,
pageSize: 50,
keepPreviousData: true,
enabled: true,
__experimental_mode: params?.mode,
});
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,26 @@ describe('createBillingPaginatedHook', () => {
expect(result.current.isFetching).toBe(false);
});

it('does not fetch when enabled is false', () => {
const { result } = renderHook(() => useDummyAuth({ initialPage: 1, pageSize: 4, enabled: false }), { wrapper });

expect(useFetcherMock).toHaveBeenCalledWith('user');

expect(fetcherMock).not.toHaveBeenCalled();
expect(result.current.isLoading).toBe(false);
expect(result.current.isFetching).toBe(false);
expect(result.current.data).toEqual([]);
});

it('fetches when enabled is true', async () => {
const { result } = renderHook(() => useDummyAuth({ initialPage: 1, pageSize: 4, enabled: true }), { wrapper });

await waitFor(() => expect(result.current.isLoading).toBe(false));
expect(useFetcherMock).toHaveBeenCalledWith('user');
expect(fetcherMock).toHaveBeenCalled();
expect(fetcherMock.mock.calls[0][0]).toStrictEqual({ initialPage: 1, pageSize: 4 });
});

it('authenticated hook: does not fetch when user is null', () => {
mockUser = null;

Expand Down
15 changes: 12 additions & 3 deletions packages/shared/src/react/hooks/createBillingPaginatedHook.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,14 +43,23 @@ export function createBillingPaginatedHook<TResource extends ClerkResource, TPar
useFetcher,
options,
}: BillingHookConfig<TResource, TParams>) {
type HookParams = PaginatedHookConfig<PagesOrInfiniteOptions> & {
type HookParams = PaginatedHookConfig<
PagesOrInfiniteOptions & {
/**
* If `true`, a request will be triggered when the hook is mounted.
*
* @default true
*/
enabled?: boolean;
}
> & {
for?: ForPayerType;
};

return function useBillingHook<T extends HookParams>(
params?: T,
): PaginatedResources<TResource, T extends { infinite: true } ? true : false> {
const { for: _for, ...paginationParams } = params || ({} as Partial<T>);
const { for: _for, enabled: externalEnabled, ...paginationParams } = params || ({} as Partial<T>);

const safeFor = _for || 'user';

Expand DownExpand Up@@ -90,7 +99,7 @@ export function createBillingPaginatedHook<TResource extends ClerkResource, TPar
? environment?.commerceSettings.billing.organization.enabled
: environment?.commerceSettings.billing.user.enabled;

const isEnabled = !!hookParams && clerk.loaded && !!billingEnabled;
const isEnabled = !!hookParams && clerk.loaded && !!billingEnabled && (externalEnabled ?? true);

const result = usePagesOrInfinite<TParams, ClerkPaginatedResponse<TResource>>(
(hookParams || {}) as TParams,
Expand Down
10 changes: 6 additions & 4 deletions packages/shared/src/react/hooks/useSubscription.rq.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ import {
} from '../contexts';
import type { SubscriptionResult, UseSubscriptionParams } from './useSubscription.types';

const hookName = 'useSubscription';
const HOOK_NAME = 'useSubscription';

/**
* This is the new implementation of useSubscription using React Query.
Expand All@@ -21,7 +21,7 @@ const hookName = 'useSubscription';
* @internal
*/
export function useSubscription(params?: UseSubscriptionParams): SubscriptionResult {
useAssertWrappedByClerkProvider(hookName);
useAssertWrappedByClerkProvider(HOOK_NAME);

const clerk = useClerkInstanceContext();
const user = useUserContext();
Expand All@@ -30,7 +30,7 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes
// @ts-expect-error `__unstable__environment` is not typed
const environment = clerk.__unstable__environment as unknown as EnvironmentResource | null | undefined;

clerk.telemetry?.record(eventMethodCalled(hookName));
clerk.telemetry?.record(eventMethodCalled(HOOK_NAME));

const isOrganization = params?.for === 'organization';
const billingEnabled = isOrganization
Expand All@@ -49,14 +49,16 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes
];
}, [user?.id, isOrganization, organization?.id]);

const queriesEnabled = Boolean(user?.id && billingEnabled) && (params?.enabled ?? true);

const query = useClerkQuery({
queryKey,
queryFn: ({ queryKey }) => {
const obj = queryKey[1] as { args: { orgId?: string } };
return clerk.billing.getSubscription(obj.args);
},
staleTime: 1_000 * 60,
enabled: Boolean(user?.id && billingEnabled) && ((params as any)?.enabled ?? true),
enabled: queriesEnabled,
// TODO(@RQ_MIGRATION): Add support for keepPreviousData
});

Expand Down
3 changes: 2 additions & 1 deletion packages/shared/src/react/hooks/useSubscription.swr.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,9 +35,10 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes
const billingEnabled = isOrganization
? environment?.commerceSettings.billing.organization.enabled
: environment?.commerceSettings.billing.user.enabled;
const isEnabled = (params?.enabled ?? true) && billingEnabled;

const swr = useSWR(
billingEnabled
isEnabled
? {
type: 'commerce-subscription',
userId: user?.id,
Expand Down
6 changes: 6 additions & 0 deletions packages/shared/src/react/hooks/useSubscription.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,12 @@ export type UseSubscriptionParams = {
* Defaults to false.
*/
keepPreviousData?: boolean;
/**
* If `true`, a request will be triggered when the hook is mounted.
*
* @default true
*/
enabled?: boolean;
};

export type SubscriptionResult = {
Expand Down
Loading
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/heavy-suns-divide.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Fixes a bug where billing hooks would attempt to fetch billing information for an organization member with insufficient permissions, resulting in a 403 error.
5 changes: 5 additions & 0 deletions .changeset/thin-swans-punch.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': minor
---

Billing hooks now accept a `{ enabled: boolean }` option, that controls the whether or not a request will fire.
Original file line numberDiff line numberDiff line change
Expand Up@@ -85,8 +85,8 @@ describe('OrganizationProfile', () => {

render(<OrganizationProfile />, { wrapper });
await waitFor(() => expect(screen.queryByText('Billing')).toBeNull());
expect(fixtures.clerk.billing.getSubscription).toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).toHaveBeenCalled();
expect(fixtures.clerk.billing.getSubscription).not.toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).not.toHaveBeenCalled();
});

it('does not include Billing when missing billing permission even with paid plans', async () => {
Expand All@@ -109,9 +109,8 @@ describe('OrganizationProfile', () => {
render(<OrganizationProfile />, { wrapper });
await waitFor(() => expect(screen.queryByText('Billing')).toBeNull());

// TODO(@RQ_MIGRATION): Offer a way to disable these, because they fire unnecessary requests.
expect(fixtures.clerk.billing.getSubscription).toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).toHaveBeenCalled();
expect(fixtures.clerk.billing.getSubscription).not.toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).not.toHaveBeenCalled();
});
it('does not include Billing when organization billing is disabled', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,11 @@ describe('PricingTable - plans visibility', () => {
// Should show plans when signed out
expect(getByRole('heading', { name: 'Test Plan' })).toBeVisible();
});

// Ensure API args reflect user context by default
expect(fixtures.clerk.billing.getPlans).toHaveBeenCalledWith(expect.objectContaining({ for: 'user' }));
// Signed-out users should not fetch subscriptions
expect(fixtures.clerk.billing.getSubscription).not.toHaveBeenCalled();
});
Comment thread
panteliselef marked this conversation as resolved.

it('shows no plans when user is signed in but subscription is null', async () => {
Expand DownExpand Up@@ -517,7 +522,15 @@ describe('PricingTable - plans visibility', () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({ email_addresses: ['test@clerk.com'], organization_memberships: ['Org1'] });
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:manage'],
},
],
});
});

// Set legacy prop via context provider
Expand DownExpand Up@@ -572,7 +585,15 @@ describe('PricingTable - plans visibility', () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({ email_addresses: ['test@clerk.com'], organization_memberships: ['Org1'] });
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:read'],
},
],
});
});

// Set new prop via context provider
Expand Down
55 changes: 28 additions & 27 deletions packages/clerk-js/src/ui/contexts/components/Plans.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import {
__experimental_useStatements,
__experimental_useSubscription,
useClerk,
useOrganization,
useSession,
} from '@clerk/shared/react';
import type {
Expand All@@ -15,6 +16,7 @@ import type {
} from '@clerk/shared/types';
import { useCallback, useMemo } from 'react';

import { useProtect } from '@/ui/common/Gate';
import { getClosestProfileScrollBox } from '@/ui/utils/getClosestProfileScrollBox';

import type { LocalizationKey } from '../../localization';
Expand All@@ -28,44 +30,42 @@ export function normalizeFormatted(formatted: string) {
return formatted.endsWith('.00') ? formatted.slice(0, -3) : formatted;
}

// TODO(@COMMERCE): Rename payment sources to payment methods at the API level
export const usePaymentMethods = () => {
const useBillingHookParams = () => {
const subscriberType = useSubscriberTypeContext();
return __experimental_usePaymentMethods({
const { organization } = useOrganization();
const allowBillingRoutes = useProtect(
has =>
has({
permission: 'org:sys_billing:read',
}) || has({ permission: 'org:sys_billing:manage' }),
);

return {
for: subscriberType,
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
});
// If the user is in an organization, only fetch billing data if they have the necessary permissions
enabled: subscriberType === 'organization' ? Boolean(organization) && allowBillingRoutes : true,
};
};

export const usePaymentMethods = () => {
const params = useBillingHookParams();
return __experimental_usePaymentMethods(params);
};

export const usePaymentAttempts = () => {
const subscriberType = useSubscriberTypeContext();
return __experimental_usePaymentAttempts({
for: subscriberType,
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
});
const params = useBillingHookParams();
return __experimental_usePaymentAttempts(params);
};

export const useStatements = (params?: { mode: 'cache' }) => {
const subscriberType = useSubscriberTypeContext();
return __experimental_useStatements({
for: subscriberType,
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
__experimental_mode: params?.mode,
});
export const useStatements = (externalParams?: { mode: 'cache' }) => {
const params = useBillingHookParams();
return __experimental_useStatements({ ...params, __experimental_mode: externalParams?.mode });
};

export const useSubscription = () => {
const subscriberType = useSubscriberTypeContext();
const subscription = __experimental_useSubscription({
for: subscriberType,
keepPreviousData: true,
});
const params = useBillingHookParams();
const subscription = __experimental_useSubscription(params);
const subscriptionItems = useMemo(
() => subscription.data?.subscriptionItems || [],
[subscription.data?.subscriptionItems],
Expand All@@ -85,6 +85,7 @@ export const usePlans = (params?: { mode: 'cache' }) => {
initialPage: 1,
pageSize: 50,
keepPreviousData: true,
enabled: true,
__experimental_mode: params?.mode,
});
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,26 @@ describe('createBillingPaginatedHook', () => {
expect(result.current.isFetching).toBe(false);
});

it('does not fetch when enabled is false', () => {
const { result } = renderHook(() => useDummyAuth({ initialPage: 1, pageSize: 4, enabled: false }), { wrapper });

expect(useFetcherMock).toHaveBeenCalledWith('user');

expect(fetcherMock).not.toHaveBeenCalled();
expect(result.current.isLoading).toBe(false);
expect(result.current.isFetching).toBe(false);
expect(result.current.data).toEqual([]);
});

it('fetches when enabled is true', async () => {
const { result } = renderHook(() => useDummyAuth({ initialPage: 1, pageSize: 4, enabled: true }), { wrapper });

await waitFor(() => expect(result.current.isLoading).toBe(false));
expect(useFetcherMock).toHaveBeenCalledWith('user');
expect(fetcherMock).toHaveBeenCalled();
expect(fetcherMock.mock.calls[0][0]).toStrictEqual({ initialPage: 1, pageSize: 4 });
});

it('authenticated hook: does not fetch when user is null', () => {
mockUser = null;

Expand Down
15 changes: 12 additions & 3 deletions packages/shared/src/react/hooks/createBillingPaginatedHook.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,14 +43,23 @@ export function createBillingPaginatedHook<TResource extends ClerkResource, TPar
useFetcher,
options,
}: BillingHookConfig<TResource, TParams>) {
type HookParams = PaginatedHookConfig<PagesOrInfiniteOptions> & {
type HookParams = PaginatedHookConfig<
PagesOrInfiniteOptions & {
/**
* If `true`, a request will be triggered when the hook is mounted.
*
* @default true
*/
enabled?: boolean;
}
> & {
for?: ForPayerType;
};

return function useBillingHook<T extends HookParams>(
params?: T,
): PaginatedResources<TResource, T extends { infinite: true } ? true : false> {
const { for: _for, ...paginationParams } = params || ({} as Partial<T>);
const { for: _for, enabled: externalEnabled, ...paginationParams } = params || ({} as Partial<T>);

const safeFor = _for || 'user';

Expand DownExpand Up@@ -90,7 +99,7 @@ export function createBillingPaginatedHook<TResource extends ClerkResource, TPar
? environment?.commerceSettings.billing.organization.enabled
: environment?.commerceSettings.billing.user.enabled;

const isEnabled = !!hookParams && clerk.loaded && !!billingEnabled;
const isEnabled = !!hookParams && clerk.loaded && !!billingEnabled && (externalEnabled ?? true);

const result = usePagesOrInfinite<TParams, ClerkPaginatedResponse<TResource>>(
(hookParams || {}) as TParams,
Expand Down
10 changes: 6 additions & 4 deletions packages/shared/src/react/hooks/useSubscription.rq.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ import {
} from '../contexts';
import type { SubscriptionResult, UseSubscriptionParams } from './useSubscription.types';

const hookName = 'useSubscription';
const HOOK_NAME = 'useSubscription';

/**
* This is the new implementation of useSubscription using React Query.
Expand All@@ -21,7 +21,7 @@ const hookName = 'useSubscription';
* @internal
*/
export function useSubscription(params?: UseSubscriptionParams): SubscriptionResult {
useAssertWrappedByClerkProvider(hookName);
useAssertWrappedByClerkProvider(HOOK_NAME);

const clerk = useClerkInstanceContext();
const user = useUserContext();
Expand All@@ -30,7 +30,7 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes
// @ts-expect-error `__unstable__environment` is not typed
const environment = clerk.__unstable__environment as unknown as EnvironmentResource | null | undefined;

clerk.telemetry?.record(eventMethodCalled(hookName));
clerk.telemetry?.record(eventMethodCalled(HOOK_NAME));

const isOrganization = params?.for === 'organization';
const billingEnabled = isOrganization
Expand All@@ -49,14 +49,16 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes
];
}, [user?.id, isOrganization, organization?.id]);

const queriesEnabled = Boolean(user?.id && billingEnabled) && (params?.enabled ?? true);

const query = useClerkQuery({
queryKey,
queryFn: ({ queryKey }) => {
const obj = queryKey[1] as { args: { orgId?: string } };
return clerk.billing.getSubscription(obj.args);
},
staleTime: 1_000 * 60,
enabled: Boolean(user?.id && billingEnabled) && ((params as any)?.enabled ?? true),
enabled: queriesEnabled,
// TODO(@RQ_MIGRATION): Add support for keepPreviousData
});

Expand Down
3 changes: 2 additions & 1 deletion packages/shared/src/react/hooks/useSubscription.swr.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,9 +35,10 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes
const billingEnabled = isOrganization
? environment?.commerceSettings.billing.organization.enabled
: environment?.commerceSettings.billing.user.enabled;
const isEnabled = (params?.enabled ?? true) && billingEnabled;

const swr = useSWR(
billingEnabled
isEnabled
? {
type: 'commerce-subscription',
userId: user?.id,
Expand Down
6 changes: 6 additions & 0 deletions packages/shared/src/react/hooks/useSubscription.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,12 @@ export type UseSubscriptionParams = {
* Defaults to false.
*/
keepPreviousData?: boolean;
/**
* If `true`, a request will be triggered when the hook is mounted.
*
* @default true
*/
enabled?: boolean;
};

export type SubscriptionResult = {
Expand Down
Loading
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/heavy-suns-divide.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Fixes a bug where billing hooks would attempt to fetch billing information for an organization member with insufficient permissions, resulting in a 403 error.
5 changes: 5 additions & 0 deletions .changeset/thin-swans-punch.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': minor
---

Billing hooks now accept a `{ enabled: boolean }` option, that controls the whether or not a request will fire.
Original file line numberDiff line numberDiff line change
Expand Up@@ -85,8 +85,8 @@ describe('OrganizationProfile', () => {

render(<OrganizationProfile />, { wrapper });
await waitFor(() => expect(screen.queryByText('Billing')).toBeNull());
expect(fixtures.clerk.billing.getSubscription).toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).toHaveBeenCalled();
expect(fixtures.clerk.billing.getSubscription).not.toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).not.toHaveBeenCalled();
});

it('does not include Billing when missing billing permission even with paid plans', async () => {
Expand All@@ -109,9 +109,8 @@ describe('OrganizationProfile', () => {
render(<OrganizationProfile />, { wrapper });
await waitFor(() => expect(screen.queryByText('Billing')).toBeNull());

// TODO(@RQ_MIGRATION): Offer a way to disable these, because they fire unnecessary requests.
expect(fixtures.clerk.billing.getSubscription).toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).toHaveBeenCalled();
expect(fixtures.clerk.billing.getSubscription).not.toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).not.toHaveBeenCalled();
});
it('does not include Billing when organization billing is disabled', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,11 @@ describe('PricingTable - plans visibility', () => {
// Should show plans when signed out
expect(getByRole('heading', { name: 'Test Plan' })).toBeVisible();
});

// Ensure API args reflect user context by default
expect(fixtures.clerk.billing.getPlans).toHaveBeenCalledWith(expect.objectContaining({ for: 'user' }));
// Signed-out users should not fetch subscriptions
expect(fixtures.clerk.billing.getSubscription).not.toHaveBeenCalled();
});
Comment thread
panteliselef marked this conversation as resolved.

it('shows no plans when user is signed in but subscription is null', async () => {
Expand DownExpand Up@@ -517,7 +522,15 @@ describe('PricingTable - plans visibility', () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({ email_addresses: ['test@clerk.com'], organization_memberships: ['Org1'] });
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:manage'],
},
],
});
});

// Set legacy prop via context provider
Expand DownExpand Up@@ -572,7 +585,15 @@ describe('PricingTable - plans visibility', () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({ email_addresses: ['test@clerk.com'], organization_memberships: ['Org1'] });
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:read'],
},
],
});
});

// Set new prop via context provider
Expand Down
55 changes: 28 additions & 27 deletions packages/clerk-js/src/ui/contexts/components/Plans.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import {
__experimental_useStatements,
__experimental_useSubscription,
useClerk,
useOrganization,
useSession,
} from '@clerk/shared/react';
import type {
Expand All@@ -15,6 +16,7 @@ import type {
} from '@clerk/shared/types';
import { useCallback, useMemo } from 'react';

import { useProtect } from '@/ui/common/Gate';
import { getClosestProfileScrollBox } from '@/ui/utils/getClosestProfileScrollBox';

import type { LocalizationKey } from '../../localization';
Expand All@@ -28,44 +30,42 @@ export function normalizeFormatted(formatted: string) {
return formatted.endsWith('.00') ? formatted.slice(0, -3) : formatted;
}

// TODO(@COMMERCE): Rename payment sources to payment methods at the API level
export const usePaymentMethods = () => {
const useBillingHookParams = () => {
const subscriberType = useSubscriberTypeContext();
return __experimental_usePaymentMethods({
const { organization } = useOrganization();
const allowBillingRoutes = useProtect(
has =>
has({
permission: 'org:sys_billing:read',
}) || has({ permission: 'org:sys_billing:manage' }),
);

return {
for: subscriberType,
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
});
// If the user is in an organization, only fetch billing data if they have the necessary permissions
enabled: subscriberType === 'organization' ? Boolean(organization) && allowBillingRoutes : true,
};
};

export const usePaymentMethods = () => {
const params = useBillingHookParams();
return __experimental_usePaymentMethods(params);
};

export const usePaymentAttempts = () => {
const subscriberType = useSubscriberTypeContext();
return __experimental_usePaymentAttempts({
for: subscriberType,
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
});
const params = useBillingHookParams();
return __experimental_usePaymentAttempts(params);
};

export const useStatements = (params?: { mode: 'cache' }) => {
const subscriberType = useSubscriberTypeContext();
return __experimental_useStatements({
for: subscriberType,
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
__experimental_mode: params?.mode,
});
export const useStatements = (externalParams?: { mode: 'cache' }) => {
const params = useBillingHookParams();
return __experimental_useStatements({ ...params, __experimental_mode: externalParams?.mode });
};

export const useSubscription = () => {
const subscriberType = useSubscriberTypeContext();
const subscription = __experimental_useSubscription({
for: subscriberType,
keepPreviousData: true,
});
const params = useBillingHookParams();
const subscription = __experimental_useSubscription(params);
const subscriptionItems = useMemo(
() => subscription.data?.subscriptionItems || [],
[subscription.data?.subscriptionItems],
Expand All@@ -85,6 +85,7 @@ export const usePlans = (params?: { mode: 'cache' }) => {
initialPage: 1,
pageSize: 50,
keepPreviousData: true,
enabled: true,
__experimental_mode: params?.mode,
});
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,26 @@ describe('createBillingPaginatedHook', () => {
expect(result.current.isFetching).toBe(false);
});

it('does not fetch when enabled is false', () => {
const { result } = renderHook(() => useDummyAuth({ initialPage: 1, pageSize: 4, enabled: false }), { wrapper });

expect(useFetcherMock).toHaveBeenCalledWith('user');

expect(fetcherMock).not.toHaveBeenCalled();
expect(result.current.isLoading).toBe(false);
expect(result.current.isFetching).toBe(false);
expect(result.current.data).toEqual([]);
});

it('fetches when enabled is true', async () => {
const { result } = renderHook(() => useDummyAuth({ initialPage: 1, pageSize: 4, enabled: true }), { wrapper });

await waitFor(() => expect(result.current.isLoading).toBe(false));
expect(useFetcherMock).toHaveBeenCalledWith('user');
expect(fetcherMock).toHaveBeenCalled();
expect(fetcherMock.mock.calls[0][0]).toStrictEqual({ initialPage: 1, pageSize: 4 });
});

it('authenticated hook: does not fetch when user is null', () => {
mockUser = null;

Expand Down
15 changes: 12 additions & 3 deletions packages/shared/src/react/hooks/createBillingPaginatedHook.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,14 +43,23 @@ export function createBillingPaginatedHook<TResource extends ClerkResource, TPar
useFetcher,
options,
}: BillingHookConfig<TResource, TParams>) {
type HookParams = PaginatedHookConfig<PagesOrInfiniteOptions> & {
type HookParams = PaginatedHookConfig<
PagesOrInfiniteOptions & {
/**
* If `true`, a request will be triggered when the hook is mounted.
*
* @default true
*/
enabled?: boolean;
}
> & {
for?: ForPayerType;
};

return function useBillingHook<T extends HookParams>(
params?: T,
): PaginatedResources<TResource, T extends { infinite: true } ? true : false> {
const { for: _for, ...paginationParams } = params || ({} as Partial<T>);
const { for: _for, enabled: externalEnabled, ...paginationParams } = params || ({} as Partial<T>);

const safeFor = _for || 'user';

Expand DownExpand Up@@ -90,7 +99,7 @@ export function createBillingPaginatedHook<TResource extends ClerkResource, TPar
? environment?.commerceSettings.billing.organization.enabled
: environment?.commerceSettings.billing.user.enabled;

const isEnabled = !!hookParams && clerk.loaded && !!billingEnabled;
const isEnabled = !!hookParams && clerk.loaded && !!billingEnabled && (externalEnabled ?? true);

const result = usePagesOrInfinite<TParams, ClerkPaginatedResponse<TResource>>(
(hookParams || {}) as TParams,
Expand Down
10 changes: 6 additions & 4 deletions packages/shared/src/react/hooks/useSubscription.rq.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ import {
} from '../contexts';
import type { SubscriptionResult, UseSubscriptionParams } from './useSubscription.types';

const hookName = 'useSubscription';
const HOOK_NAME = 'useSubscription';

/**
* This is the new implementation of useSubscription using React Query.
Expand All@@ -21,7 +21,7 @@ const hookName = 'useSubscription';
* @internal
*/
export function useSubscription(params?: UseSubscriptionParams): SubscriptionResult {
useAssertWrappedByClerkProvider(hookName);
useAssertWrappedByClerkProvider(HOOK_NAME);

const clerk = useClerkInstanceContext();
const user = useUserContext();
Expand All@@ -30,7 +30,7 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes
// @ts-expect-error `__unstable__environment` is not typed
const environment = clerk.__unstable__environment as unknown as EnvironmentResource | null | undefined;

clerk.telemetry?.record(eventMethodCalled(hookName));
clerk.telemetry?.record(eventMethodCalled(HOOK_NAME));

const isOrganization = params?.for === 'organization';
const billingEnabled = isOrganization
Expand All@@ -49,14 +49,16 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes
];
}, [user?.id, isOrganization, organization?.id]);

const queriesEnabled = Boolean(user?.id && billingEnabled) && (params?.enabled ?? true);

const query = useClerkQuery({
queryKey,
queryFn: ({ queryKey }) => {
const obj = queryKey[1] as { args: { orgId?: string } };
return clerk.billing.getSubscription(obj.args);
},
staleTime: 1_000 * 60,
enabled: Boolean(user?.id && billingEnabled) && ((params as any)?.enabled ?? true),
enabled: queriesEnabled,
// TODO(@RQ_MIGRATION): Add support for keepPreviousData
});

Expand Down
3 changes: 2 additions & 1 deletion packages/shared/src/react/hooks/useSubscription.swr.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,9 +35,10 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes
const billingEnabled = isOrganization
? environment?.commerceSettings.billing.organization.enabled
: environment?.commerceSettings.billing.user.enabled;
const isEnabled = (params?.enabled ?? true) && billingEnabled;

const swr = useSWR(
billingEnabled
isEnabled
? {
type: 'commerce-subscription',
userId: user?.id,
Expand Down
6 changes: 6 additions & 0 deletions packages/shared/src/react/hooks/useSubscription.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,12 @@ export type UseSubscriptionParams = {
* Defaults to false.
*/
keepPreviousData?: boolean;
/**
* If `true`, a request will be triggered when the hook is mounted.
*
* @default true
*/
enabled?: boolean;
};

export type SubscriptionResult = {
Expand Down
Loading
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/heavy-suns-divide.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Fixes a bug where billing hooks would attempt to fetch billing information for an organization member with insufficient permissions, resulting in a 403 error.
5 changes: 5 additions & 0 deletions .changeset/thin-swans-punch.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': minor
---

Billing hooks now accept a `{ enabled: boolean }` option, that controls the whether or not a request will fire.
Original file line numberDiff line numberDiff line change
Expand Up@@ -85,8 +85,8 @@ describe('OrganizationProfile', () => {

render(<OrganizationProfile />, { wrapper });
await waitFor(() => expect(screen.queryByText('Billing')).toBeNull());
expect(fixtures.clerk.billing.getSubscription).toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).toHaveBeenCalled();
expect(fixtures.clerk.billing.getSubscription).not.toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).not.toHaveBeenCalled();
});

it('does not include Billing when missing billing permission even with paid plans', async () => {
Expand All@@ -109,9 +109,8 @@ describe('OrganizationProfile', () => {
render(<OrganizationProfile />, { wrapper });
await waitFor(() => expect(screen.queryByText('Billing')).toBeNull());

// TODO(@RQ_MIGRATION): Offer a way to disable these, because they fire unnecessary requests.
expect(fixtures.clerk.billing.getSubscription).toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).toHaveBeenCalled();
expect(fixtures.clerk.billing.getSubscription).not.toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).not.toHaveBeenCalled();
});
it('does not include Billing when organization billing is disabled', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,11 @@ describe('PricingTable - plans visibility', () => {
// Should show plans when signed out
expect(getByRole('heading', { name: 'Test Plan' })).toBeVisible();
});

// Ensure API args reflect user context by default
expect(fixtures.clerk.billing.getPlans).toHaveBeenCalledWith(expect.objectContaining({ for: 'user' }));
// Signed-out users should not fetch subscriptions
expect(fixtures.clerk.billing.getSubscription).not.toHaveBeenCalled();
});
Comment thread
panteliselef marked this conversation as resolved.

it('shows no plans when user is signed in but subscription is null', async () => {
Expand DownExpand Up@@ -517,7 +522,15 @@ describe('PricingTable - plans visibility', () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({ email_addresses: ['test@clerk.com'], organization_memberships: ['Org1'] });
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:manage'],
},
],
});
});

// Set legacy prop via context provider
Expand DownExpand Up@@ -572,7 +585,15 @@ describe('PricingTable - plans visibility', () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({ email_addresses: ['test@clerk.com'], organization_memberships: ['Org1'] });
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:read'],
},
],
});
});

// Set new prop via context provider
Expand Down
55 changes: 28 additions & 27 deletions packages/clerk-js/src/ui/contexts/components/Plans.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import {
__experimental_useStatements,
__experimental_useSubscription,
useClerk,
useOrganization,
useSession,
} from '@clerk/shared/react';
import type {
Expand All@@ -15,6 +16,7 @@ import type {
} from '@clerk/shared/types';
import { useCallback, useMemo } from 'react';

import { useProtect } from '@/ui/common/Gate';
import { getClosestProfileScrollBox } from '@/ui/utils/getClosestProfileScrollBox';

import type { LocalizationKey } from '../../localization';
Expand All@@ -28,44 +30,42 @@ export function normalizeFormatted(formatted: string) {
return formatted.endsWith('.00') ? formatted.slice(0, -3) : formatted;
}

// TODO(@COMMERCE): Rename payment sources to payment methods at the API level
export const usePaymentMethods = () => {
const useBillingHookParams = () => {
const subscriberType = useSubscriberTypeContext();
return __experimental_usePaymentMethods({
const { organization } = useOrganization();
const allowBillingRoutes = useProtect(
has =>
has({
permission: 'org:sys_billing:read',
}) || has({ permission: 'org:sys_billing:manage' }),
);

return {
for: subscriberType,
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
});
// If the user is in an organization, only fetch billing data if they have the necessary permissions
enabled: subscriberType === 'organization' ? Boolean(organization) && allowBillingRoutes : true,
};
};

export const usePaymentMethods = () => {
const params = useBillingHookParams();
return __experimental_usePaymentMethods(params);
};

export const usePaymentAttempts = () => {
const subscriberType = useSubscriberTypeContext();
return __experimental_usePaymentAttempts({
for: subscriberType,
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
});
const params = useBillingHookParams();
return __experimental_usePaymentAttempts(params);
};

export const useStatements = (params?: { mode: 'cache' }) => {
const subscriberType = useSubscriberTypeContext();
return __experimental_useStatements({
for: subscriberType,
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
__experimental_mode: params?.mode,
});
export const useStatements = (externalParams?: { mode: 'cache' }) => {
const params = useBillingHookParams();
return __experimental_useStatements({ ...params, __experimental_mode: externalParams?.mode });
};

export const useSubscription = () => {
const subscriberType = useSubscriberTypeContext();
const subscription = __experimental_useSubscription({
for: subscriberType,
keepPreviousData: true,
});
const params = useBillingHookParams();
const subscription = __experimental_useSubscription(params);
const subscriptionItems = useMemo(
() => subscription.data?.subscriptionItems || [],
[subscription.data?.subscriptionItems],
Expand All@@ -85,6 +85,7 @@ export const usePlans = (params?: { mode: 'cache' }) => {
initialPage: 1,
pageSize: 50,
keepPreviousData: true,
enabled: true,
__experimental_mode: params?.mode,
});
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,26 @@ describe('createBillingPaginatedHook', () => {
expect(result.current.isFetching).toBe(false);
});

it('does not fetch when enabled is false', () => {
const { result } = renderHook(() => useDummyAuth({ initialPage: 1, pageSize: 4, enabled: false }), { wrapper });

expect(useFetcherMock).toHaveBeenCalledWith('user');

expect(fetcherMock).not.toHaveBeenCalled();
expect(result.current.isLoading).toBe(false);
expect(result.current.isFetching).toBe(false);
expect(result.current.data).toEqual([]);
});

it('fetches when enabled is true', async () => {
const { result } = renderHook(() => useDummyAuth({ initialPage: 1, pageSize: 4, enabled: true }), { wrapper });

await waitFor(() => expect(result.current.isLoading).toBe(false));
expect(useFetcherMock).toHaveBeenCalledWith('user');
expect(fetcherMock).toHaveBeenCalled();
expect(fetcherMock.mock.calls[0][0]).toStrictEqual({ initialPage: 1, pageSize: 4 });
});

it('authenticated hook: does not fetch when user is null', () => {
mockUser = null;

Expand Down
15 changes: 12 additions & 3 deletions packages/shared/src/react/hooks/createBillingPaginatedHook.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,14 +43,23 @@ export function createBillingPaginatedHook<TResource extends ClerkResource, TPar
useFetcher,
options,
}: BillingHookConfig<TResource, TParams>) {
type HookParams = PaginatedHookConfig<PagesOrInfiniteOptions> & {
type HookParams = PaginatedHookConfig<
PagesOrInfiniteOptions & {
/**
* If `true`, a request will be triggered when the hook is mounted.
*
* @default true
*/
enabled?: boolean;
}
> & {
for?: ForPayerType;
};

return function useBillingHook<T extends HookParams>(
params?: T,
): PaginatedResources<TResource, T extends { infinite: true } ? true : false> {
const { for: _for, ...paginationParams } = params || ({} as Partial<T>);
const { for: _for, enabled: externalEnabled, ...paginationParams } = params || ({} as Partial<T>);

const safeFor = _for || 'user';

Expand DownExpand Up@@ -90,7 +99,7 @@ export function createBillingPaginatedHook<TResource extends ClerkResource, TPar
? environment?.commerceSettings.billing.organization.enabled
: environment?.commerceSettings.billing.user.enabled;

const isEnabled = !!hookParams && clerk.loaded && !!billingEnabled;
const isEnabled = !!hookParams && clerk.loaded && !!billingEnabled && (externalEnabled ?? true);

const result = usePagesOrInfinite<TParams, ClerkPaginatedResponse<TResource>>(
(hookParams || {}) as TParams,
Expand Down
10 changes: 6 additions & 4 deletions packages/shared/src/react/hooks/useSubscription.rq.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ import {
} from '../contexts';
import type { SubscriptionResult, UseSubscriptionParams } from './useSubscription.types';

const hookName = 'useSubscription';
const HOOK_NAME = 'useSubscription';

/**
* This is the new implementation of useSubscription using React Query.
Expand All@@ -21,7 +21,7 @@ const hookName = 'useSubscription';
* @internal
*/
export function useSubscription(params?: UseSubscriptionParams): SubscriptionResult {
useAssertWrappedByClerkProvider(hookName);
useAssertWrappedByClerkProvider(HOOK_NAME);

const clerk = useClerkInstanceContext();
const user = useUserContext();
Expand All@@ -30,7 +30,7 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes
// @ts-expect-error `__unstable__environment` is not typed
const environment = clerk.__unstable__environment as unknown as EnvironmentResource | null | undefined;

clerk.telemetry?.record(eventMethodCalled(hookName));
clerk.telemetry?.record(eventMethodCalled(HOOK_NAME));

const isOrganization = params?.for === 'organization';
const billingEnabled = isOrganization
Expand All@@ -49,14 +49,16 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes
];
}, [user?.id, isOrganization, organization?.id]);

const queriesEnabled = Boolean(user?.id && billingEnabled) && (params?.enabled ?? true);

const query = useClerkQuery({
queryKey,
queryFn: ({ queryKey }) => {
const obj = queryKey[1] as { args: { orgId?: string } };
return clerk.billing.getSubscription(obj.args);
},
staleTime: 1_000 * 60,
enabled: Boolean(user?.id && billingEnabled) && ((params as any)?.enabled ?? true),
enabled: queriesEnabled,
// TODO(@RQ_MIGRATION): Add support for keepPreviousData
});

Expand Down
3 changes: 2 additions & 1 deletion packages/shared/src/react/hooks/useSubscription.swr.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,9 +35,10 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes
const billingEnabled = isOrganization
? environment?.commerceSettings.billing.organization.enabled
: environment?.commerceSettings.billing.user.enabled;
const isEnabled = (params?.enabled ?? true) && billingEnabled;

const swr = useSWR(
billingEnabled
isEnabled
? {
type: 'commerce-subscription',
userId: user?.id,
Expand Down
6 changes: 6 additions & 0 deletions packages/shared/src/react/hooks/useSubscription.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,12 @@ export type UseSubscriptionParams = {
* Defaults to false.
*/
keepPreviousData?: boolean;
/**
* If `true`, a request will be triggered when the hook is mounted.
*
* @default true
*/
enabled?: boolean;
};

export type SubscriptionResult = {
Expand Down
Loading
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/heavy-suns-divide.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Fixes a bug where billing hooks would attempt to fetch billing information for an organization member with insufficient permissions, resulting in a 403 error.
5 changes: 5 additions & 0 deletions .changeset/thin-swans-punch.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': minor
---

Billing hooks now accept a `{ enabled: boolean }` option, that controls the whether or not a request will fire.
Original file line numberDiff line numberDiff line change
Expand Up@@ -85,8 +85,8 @@ describe('OrganizationProfile', () => {

render(<OrganizationProfile />, { wrapper });
await waitFor(() => expect(screen.queryByText('Billing')).toBeNull());
expect(fixtures.clerk.billing.getSubscription).toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).toHaveBeenCalled();
expect(fixtures.clerk.billing.getSubscription).not.toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).not.toHaveBeenCalled();
});

it('does not include Billing when missing billing permission even with paid plans', async () => {
Expand All@@ -109,9 +109,8 @@ describe('OrganizationProfile', () => {
render(<OrganizationProfile />, { wrapper });
await waitFor(() => expect(screen.queryByText('Billing')).toBeNull());

// TODO(@RQ_MIGRATION): Offer a way to disable these, because they fire unnecessary requests.
expect(fixtures.clerk.billing.getSubscription).toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).toHaveBeenCalled();
expect(fixtures.clerk.billing.getSubscription).not.toHaveBeenCalled();
expect(fixtures.clerk.billing.getStatements).not.toHaveBeenCalled();
});
it('does not include Billing when organization billing is disabled', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,11 @@ describe('PricingTable - plans visibility', () => {
// Should show plans when signed out
expect(getByRole('heading', { name: 'Test Plan' })).toBeVisible();
});

// Ensure API args reflect user context by default
expect(fixtures.clerk.billing.getPlans).toHaveBeenCalledWith(expect.objectContaining({ for: 'user' }));
// Signed-out users should not fetch subscriptions
expect(fixtures.clerk.billing.getSubscription).not.toHaveBeenCalled();
});
Comment thread
panteliselef marked this conversation as resolved.

it('shows no plans when user is signed in but subscription is null', async () => {
Expand DownExpand Up@@ -517,7 +522,15 @@ describe('PricingTable - plans visibility', () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({ email_addresses: ['test@clerk.com'], organization_memberships: ['Org1'] });
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:manage'],
},
],
});
});

// Set legacy prop via context provider
Expand DownExpand Up@@ -572,7 +585,15 @@ describe('PricingTable - plans visibility', () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({ email_addresses: ['test@clerk.com'], organization_memberships: ['Org1'] });
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:read'],
},
],
});
});

// Set new prop via context provider
Expand Down
55 changes: 28 additions & 27 deletions packages/clerk-js/src/ui/contexts/components/Plans.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import {
__experimental_useStatements,
__experimental_useSubscription,
useClerk,
useOrganization,
useSession,
} from '@clerk/shared/react';
import type {
Expand All@@ -15,6 +16,7 @@ import type {
} from '@clerk/shared/types';
import { useCallback, useMemo } from 'react';

import { useProtect } from '@/ui/common/Gate';
import { getClosestProfileScrollBox } from '@/ui/utils/getClosestProfileScrollBox';

import type { LocalizationKey } from '../../localization';
Expand All@@ -28,44 +30,42 @@ export function normalizeFormatted(formatted: string) {
return formatted.endsWith('.00') ? formatted.slice(0, -3) : formatted;
}

// TODO(@COMMERCE): Rename payment sources to payment methods at the API level
export const usePaymentMethods = () => {
const useBillingHookParams = () => {
const subscriberType = useSubscriberTypeContext();
return __experimental_usePaymentMethods({
const { organization } = useOrganization();
const allowBillingRoutes = useProtect(
has =>
has({
permission: 'org:sys_billing:read',
}) || has({ permission: 'org:sys_billing:manage' }),
);

return {
for: subscriberType,
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
});
// If the user is in an organization, only fetch billing data if they have the necessary permissions
enabled: subscriberType === 'organization' ? Boolean(organization) && allowBillingRoutes : true,
};
};

export const usePaymentMethods = () => {
const params = useBillingHookParams();
return __experimental_usePaymentMethods(params);
};

export const usePaymentAttempts = () => {
const subscriberType = useSubscriberTypeContext();
return __experimental_usePaymentAttempts({
for: subscriberType,
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
});
const params = useBillingHookParams();
return __experimental_usePaymentAttempts(params);
};

export const useStatements = (params?: { mode: 'cache' }) => {
const subscriberType = useSubscriberTypeContext();
return __experimental_useStatements({
for: subscriberType,
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
__experimental_mode: params?.mode,
});
export const useStatements = (externalParams?: { mode: 'cache' }) => {
const params = useBillingHookParams();
return __experimental_useStatements({ ...params, __experimental_mode: externalParams?.mode });
};

export const useSubscription = () => {
const subscriberType = useSubscriberTypeContext();
const subscription = __experimental_useSubscription({
for: subscriberType,
keepPreviousData: true,
});
const params = useBillingHookParams();
const subscription = __experimental_useSubscription(params);
const subscriptionItems = useMemo(
() => subscription.data?.subscriptionItems || [],
[subscription.data?.subscriptionItems],
Expand All@@ -85,6 +85,7 @@ export const usePlans = (params?: { mode: 'cache' }) => {
initialPage: 1,
pageSize: 50,
keepPreviousData: true,
enabled: true,
__experimental_mode: params?.mode,
});
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,26 @@ describe('createBillingPaginatedHook', () => {
expect(result.current.isFetching).toBe(false);
});

it('does not fetch when enabled is false', () => {
const { result } = renderHook(() => useDummyAuth({ initialPage: 1, pageSize: 4, enabled: false }), { wrapper });

expect(useFetcherMock).toHaveBeenCalledWith('user');

expect(fetcherMock).not.toHaveBeenCalled();
expect(result.current.isLoading).toBe(false);
expect(result.current.isFetching).toBe(false);
expect(result.current.data).toEqual([]);
});

it('fetches when enabled is true', async () => {
const { result } = renderHook(() => useDummyAuth({ initialPage: 1, pageSize: 4, enabled: true }), { wrapper });

await waitFor(() => expect(result.current.isLoading).toBe(false));
expect(useFetcherMock).toHaveBeenCalledWith('user');
expect(fetcherMock).toHaveBeenCalled();
expect(fetcherMock.mock.calls[0][0]).toStrictEqual({ initialPage: 1, pageSize: 4 });
});

it('authenticated hook: does not fetch when user is null', () => {
mockUser = null;

Expand Down
15 changes: 12 additions & 3 deletions packages/shared/src/react/hooks/createBillingPaginatedHook.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,14 +43,23 @@ export function createBillingPaginatedHook<TResource extends ClerkResource, TPar
useFetcher,
options,
}: BillingHookConfig<TResource, TParams>) {
type HookParams = PaginatedHookConfig<PagesOrInfiniteOptions> & {
type HookParams = PaginatedHookConfig<
PagesOrInfiniteOptions & {
/**
* If `true`, a request will be triggered when the hook is mounted.
*
* @default true
*/
enabled?: boolean;
}
> & {
for?: ForPayerType;
};

return function useBillingHook<T extends HookParams>(
params?: T,
): PaginatedResources<TResource, T extends { infinite: true } ? true : false> {
const { for: _for, ...paginationParams } = params || ({} as Partial<T>);
const { for: _for, enabled: externalEnabled, ...paginationParams } = params || ({} as Partial<T>);

const safeFor = _for || 'user';

Expand DownExpand Up@@ -90,7 +99,7 @@ export function createBillingPaginatedHook<TResource extends ClerkResource, TPar
? environment?.commerceSettings.billing.organization.enabled
: environment?.commerceSettings.billing.user.enabled;

const isEnabled = !!hookParams && clerk.loaded && !!billingEnabled;
const isEnabled = !!hookParams && clerk.loaded && !!billingEnabled && (externalEnabled ?? true);

const result = usePagesOrInfinite<TParams, ClerkPaginatedResponse<TResource>>(
(hookParams || {}) as TParams,
Expand Down
10 changes: 6 additions & 4 deletions packages/shared/src/react/hooks/useSubscription.rq.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ import {
} from '../contexts';
import type { SubscriptionResult, UseSubscriptionParams } from './useSubscription.types';

const hookName = 'useSubscription';
const HOOK_NAME = 'useSubscription';

/**
* This is the new implementation of useSubscription using React Query.
Expand All@@ -21,7 +21,7 @@ const hookName = 'useSubscription';
* @internal
*/
export function useSubscription(params?: UseSubscriptionParams): SubscriptionResult {
useAssertWrappedByClerkProvider(hookName);
useAssertWrappedByClerkProvider(HOOK_NAME);

const clerk = useClerkInstanceContext();
const user = useUserContext();
Expand All@@ -30,7 +30,7 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes
// @ts-expect-error `__unstable__environment` is not typed
const environment = clerk.__unstable__environment as unknown as EnvironmentResource | null | undefined;

clerk.telemetry?.record(eventMethodCalled(hookName));
clerk.telemetry?.record(eventMethodCalled(HOOK_NAME));

const isOrganization = params?.for === 'organization';
const billingEnabled = isOrganization
Expand All@@ -49,14 +49,16 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes
];
}, [user?.id, isOrganization, organization?.id]);

const queriesEnabled = Boolean(user?.id && billingEnabled) && (params?.enabled ?? true);

const query = useClerkQuery({
queryKey,
queryFn: ({ queryKey }) => {
const obj = queryKey[1] as { args: { orgId?: string } };
return clerk.billing.getSubscription(obj.args);
},
staleTime: 1_000 * 60,
enabled: Boolean(user?.id && billingEnabled) && ((params as any)?.enabled ?? true),
enabled: queriesEnabled,
// TODO(@RQ_MIGRATION): Add support for keepPreviousData
});

Expand Down
3 changes: 2 additions & 1 deletion packages/shared/src/react/hooks/useSubscription.swr.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,9 +35,10 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes
const billingEnabled = isOrganization
? environment?.commerceSettings.billing.organization.enabled
: environment?.commerceSettings.billing.user.enabled;
const isEnabled = (params?.enabled ?? true) && billingEnabled;

const swr = useSWR(
billingEnabled
isEnabled
? {
type: 'commerce-subscription',
userId: user?.id,
Expand Down
6 changes: 6 additions & 0 deletions packages/shared/src/react/hooks/useSubscription.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,12 @@ export type UseSubscriptionParams = {
* Defaults to false.
*/
keepPreviousData?: boolean;
/**
* If `true`, a request will be triggered when the hook is mounted.
*
* @default true
*/
enabled?: boolean;
};

export type SubscriptionResult = {
Expand Down
Loading