chore(shared): Refactor clearing cache in RQ hooks#7330

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
panteliselef merged 1 commit into from
Nov 28, 2025
Merged

chore(shared): Refactor clearing cache in RQ hooks #7330

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

Filter by extension

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

Refactor clearing cache in RQ hooks when a use signs out.

@coderabbitaicoderabbitaiBotNov 28, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix typo: "use" should be "user".

The changeset description has a typo that will appear in the published changelog.

-Refactor clearing cache in RQ hooks when a use signs out.+Refactor clearing cache in RQ hooks when a user signs out.
📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Refactor clearing cache in RQ hooks when a use signs out.
Refactor clearing cache in RQ hooks when a user signs out.
🧰 Tools
🪛 LanguageTool

[grammar] ~5-~5: Ensure spelling is correct
Context: ...actor clearing cache in RQ hooks when a use signs out.

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🤖 Prompt for AI Agents
In .changeset/smooth-lamps-raise.md around line 5, the changeset description
contains a typo: "use" should be "user"; edit that line to replace "use" with
"user" so the published changelog reads "Refactor clearing cache in RQ hooks
when a user signs out." Ensure spelling is corrected and commit the updated
changeset.

2 changes: 1 addition & 1 deletion packages/shared/src/react/hooks/createBillingPaginatedHook.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -129,7 +129,7 @@ export function createBillingPaginatedHook<TResource extends ClerkResource, TPar
keepPreviousData: safeValues.keepPreviousData,
infinite: safeValues.infinite,
enabled: isEnabled,
...(options?.unauthenticated ? {} : { isSignedIn: Boolean(user) }),
...(options?.unauthenticated ? {} : { isSignedIn: user !== null }),
__experimental_mode: safeValues.__experimental_mode,
initialPage: safeValues.initialPage,
pageSize: safeValues.pageSize,
Expand Down
64 changes: 64 additions & 0 deletions packages/shared/src/react/hooks/useClearQueriesOnSignOut.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
import { useEffect, useRef } from 'react';

import { useClerkQueryClient } from '../clerk-rq/use-clerk-query-client';
import { usePreviousValue } from './usePreviousValue';

export const withInfiniteKey = <T extends string>(key: T) => [key, `${key}-inf`] as const;

type ClearQueriesOnSignOutOptions = {
isSignedOut: boolean;
stableKeys: string | readonly string[];
/**
* Whether the queries for this hook are keyed as authenticated.
* If this is not `true`, the effect becomes a no-op.
*/
authenticated?: boolean;
/**
* Optional callback that will run after queries are cleared on sign-out.
*/
onCleanup?: () => void;
};

/**
* Clears React Query caches associated with the given stable prefixes when
* the authenticated state transitions from signed-in to signed-out.
*
* @internal
*/
export function useClearQueriesOnSignOut(options: ClearQueriesOnSignOutOptions) {
const { isSignedOut, stableKeys, authenticated = true, onCleanup } = options;
const stableKeysRef = useRef(stableKeys);
Comment thread
panteliselef marked this conversation as resolved.

const [queryClient] = useClerkQueryClient();
const previousIsSignedIn = usePreviousValue(!isSignedOut);

// If this hook's cache keys are not authenticated, skip all cleanup logic.

if (authenticated !== true) {
return;
}

// Calling this effect conditionally because we make sure that `authenticated` is always the same throughout the component lifecycle.
// eslint-disable-next-line react-hooks/rules-of-hooks
useEffect(() => {
Comment thread
panteliselef marked this conversation as resolved.
const isNowSignedOut = isSignedOut === true;

if (previousIsSignedIn && isNowSignedOut) {
queryClient.removeQueries({
predicate: query => {
const [cachedStableKey, queryAuthenticated] = query.queryKey;

return (
queryAuthenticated === true &&
typeof cachedStableKey === 'string' &&
(Array.isArray(stableKeysRef.current)
? stableKeysRef.current.includes(cachedStableKey)
: stableKeysRef.current === cachedStableKey)
);
},
});

onCleanup?.();
}
}, [isSignedOut, previousIsSignedIn, queryClient]);
}
32 changes: 9 additions & 23 deletions packages/shared/src/react/hooks/usePagesOrInfinite.rq.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
import { useCallback, useMemo, useRef, useState } from 'react';

import type { ClerkPaginatedResponse } from '../../types';
import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
import { useClerkQueryClient } from '../clerk-rq/use-clerk-query-client';
import { useClerkInfiniteQuery } from '../clerk-rq/useInfiniteQuery';
import { useClerkQuery } from '../clerk-rq/useQuery';
import type { CacheSetter, ValueOrSetter } from '../types';
import { useClearQueriesOnSignOut, withInfiniteKey } from './useClearQueriesOnSignOut';
import type { UsePagesOrInfiniteSignature } from './usePageOrInfinite.types';
import { useWithSafeValues } from './usePagesOrInfinite.shared';
import { usePreviousValue } from './usePreviousValue';

export const usePagesOrInfinite: UsePagesOrInfiniteSignature = params => {
const { fetcher, config, keys } = params;
Expand DownExpand Up@@ -98,32 +98,18 @@ export const usePagesOrInfinite: UsePagesOrInfiniteSignature = params => {
enabled: queriesEnabled && triggerInfinite,
});

// Track previous isSignedIn state to detect sign-out transitions
const previousIsSignedIn = usePreviousValue(isSignedIn);

// Detect sign-out and clear queries
useEffect(() => {
const isNowSignedOut = isSignedIn === false;

if (previousIsSignedIn && isNowSignedOut) {
queryClient.removeQueries({
predicate: query => {
const [stablePrefix, authenticated] = query.queryKey;
return (
authenticated === true &&
typeof stablePrefix === 'string' &&
(stablePrefix === keys.queryKey[0] || stablePrefix === keys.queryKey[0] + '-inf')
);
},
});

useClearQueriesOnSignOut({
isSignedOut: isSignedIn === false,
authenticated: keys.authenticated,
stableKeys: withInfiniteKey(keys.stableKey),
onCleanup: () => {
// Reset paginated page to initial
setPaginatedPage(initialPageRef.current);

// Force re-render to reflect cache changes
void Promise.resolve().then(() => forceUpdate(n => n + 1));
}
}, [isSignedIn, queryClient, previousIsSignedIn, forceUpdate]);
},
});

// Compute data, count and page from the same data source to ensure consistency
const computedValues = useMemo(() => {
Expand Down
9 changes: 8 additions & 1 deletion packages/shared/src/react/hooks/usePaymentAttemptQuery.rq.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
import { useClerkQuery } from '../clerk-rq/useQuery';
import { useClerkInstanceContext, useOrganizationContext, useUserContext } from '../contexts';
import { useBillingHookEnabled } from './useBillingHookEnabled';
import { useClearQueriesOnSignOut } from './useClearQueriesOnSignOut';
import { usePaymentAttemptQueryCacheKeys } from './usePaymentAttemptQuery.shared';
import type { PaymentAttemptQueryResult, UsePaymentAttemptQueryParams } from './usePaymentAttemptQuery.types';

Expand All@@ -17,7 +18,7 @@ function usePaymentAttemptQuery(params: UsePaymentAttemptQueryParams): PaymentAt
const organizationId = forType === 'organization' ? (organization?.id ?? null) : null;
const userId = user?.id ?? null;

const { queryKey } = usePaymentAttemptQueryCacheKeys({
const { queryKey, stableKey, authenticated } = usePaymentAttemptQueryCacheKeys({
paymentAttemptId,
userId,
orgId: organizationId,
Expand All@@ -28,6 +29,12 @@ function usePaymentAttemptQuery(params: UsePaymentAttemptQueryParams): PaymentAt

const queryEnabled = Boolean(paymentAttemptId) && billingEnabled;

useClearQueriesOnSignOut({
isSignedOut: user === null, // works with the transitive state
authenticated,
stableKeys: stableKey,
});

const query = useClerkQuery({
queryKey,
queryFn: ({ queryKey }) => {
Expand Down
9 changes: 8 additions & 1 deletion packages/shared/src/react/hooks/useStatementQuery.rq.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
import { useClerkQuery } from '../clerk-rq/useQuery';
import { useClerkInstanceContext, useOrganizationContext, useUserContext } from '../contexts';
import { useBillingHookEnabled } from './useBillingHookEnabled';
import { useClearQueriesOnSignOut } from './useClearQueriesOnSignOut';
import { useStatementQueryCacheKeys } from './useStatementQuery.shared';
import type { StatementQueryResult, UseStatementQueryParams } from './useStatementQuery.types';

Expand All@@ -17,7 +18,7 @@ function useStatementQuery(params: UseStatementQueryParams = {}): StatementQuery
const organizationId = forType === 'organization' ? (organization?.id ?? null) : null;
const userId = user?.id ?? null;

const { queryKey } = useStatementQueryCacheKeys({
const { queryKey, stableKey, authenticated } = useStatementQueryCacheKeys({
statementId,
userId,
orgId: organizationId,
Expand All@@ -28,6 +29,12 @@ function useStatementQuery(params: UseStatementQueryParams = {}): StatementQuery

const queryEnabled = Boolean(statementId) && billingEnabled;

useClearQueriesOnSignOut({
isSignedOut: user === null,
authenticated,
stableKeys: stableKey,
});

const query = useClerkQuery({
queryKey,
queryFn: () => {
Expand Down
8 changes: 7 additions & 1 deletion packages/shared/src/react/hooks/useSubscription.rq.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ import {
useUserContext,
} from '../contexts';
import { useBillingHookEnabled } from './useBillingHookEnabled';
import { useClearQueriesOnSignOut } from './useClearQueriesOnSignOut';
import { useSubscriptionCacheKeys } from './useSubscription.shared';
import type { SubscriptionResult, UseSubscriptionParams } from './useSubscription.types';

Expand All@@ -37,13 +38,18 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes

const [queryClient] = useClerkQueryClient();

const { queryKey, invalidationKey } = useSubscriptionCacheKeys({
const { queryKey, invalidationKey, stableKey, authenticated } = useSubscriptionCacheKeys({
userId: user?.id,
orgId: organization?.id,
for: params?.for,
});

const queriesEnabled = Boolean(user?.id && billingEnabled);
useClearQueriesOnSignOut({
isSignedOut: user === null,
authenticated,
stableKeys: stableKey,
});

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

Skip to content
chore(shared): Refactor clearing cache in RQ hooks#7330

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 1 commit into

from

Nov 28, 2025
 Merged


chore(shared): Refactor clearing cache in RQ hooks
#7330
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/smooth-lamps-raise.md

View file


Open in desktop

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

Refactor clearing cache in RQ hooks when a use signs out.
@coderabbitaicoderabbitaiBotNov 28, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor
Fix typo: "use" should be "user".
The changeset description has a typo that will appear in the published changelog.
-Refactor clearing cache in RQ hooks when a use signs out.+Refactor clearing cache in RQ hooks when a user signs out.
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

Refactor clearing cache in RQ hooks when a use signs out.
Refactor clearing cache in RQ hooks when a user signs out.
🧰 Tools
🪛 LanguageTool
[grammar] ~5-~5: Ensure spelling is correct

Context: ...actor clearing cache in RQ hooks when a use signs out.
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
In .changeset/smooth-lamps-raise.md around line 5, the changeset description
contains a typo: "use" should be "user"; edit that line to replace "use" with
"user" so the published changelog reads "Refactor clearing cache in RQ hooks
when a user signs out." Ensure spelling is corrected and commit the updated
changeset.


2 changes: 1 addition & 1 deletion
packages/shared/src/react/hooks/createBillingPaginatedHook.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -129,7 +129,7 @@ export function createBillingPaginatedHook<TResource extends ClerkResource, TPar
 keepPreviousData: safeValues.keepPreviousData,
 infinite: safeValues.infinite,
 enabled: isEnabled,
 ...(options?.unauthenticated ? {} : { isSignedIn: Boolean(user) }),
 ...(options?.unauthenticated ? {} : { isSignedIn: user !== null }),
 __experimental_mode: safeValues.__experimental_mode,
 initialPage: safeValues.initialPage,
 pageSize: safeValues.pageSize,
Expand Down

64 changes: 64 additions & 0 deletions
packages/shared/src/react/hooks/useClearQueriesOnSignOut.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
import { useEffect, useRef } from 'react';

import { useClerkQueryClient } from '../clerk-rq/use-clerk-query-client';
import { usePreviousValue } from './usePreviousValue';

export const withInfiniteKey = <T extends string>(key: T) => [key, `${key}-inf`] as const;

type ClearQueriesOnSignOutOptions = {
 isSignedOut: boolean;
 stableKeys: string | readonly string[];
 /**
 * Whether the queries for this hook are keyed as authenticated.
 * If this is not `true`, the effect becomes a no-op.
 */
 authenticated?: boolean;
 /**
 * Optional callback that will run after queries are cleared on sign-out.
 */
 onCleanup?: () => void;
};

/**
 * Clears React Query caches associated with the given stable prefixes when
 * the authenticated state transitions from signed-in to signed-out.
 *
 * @internal
 */
export function useClearQueriesOnSignOut(options: ClearQueriesOnSignOutOptions) {
 const { isSignedOut, stableKeys, authenticated = true, onCleanup } = options;
 const stableKeysRef = useRef(stableKeys);
Comment thread
panteliselef marked this conversation as resolved.


 const [queryClient] = useClerkQueryClient();
 const previousIsSignedIn = usePreviousValue(!isSignedOut);

 // If this hook's cache keys are not authenticated, skip all cleanup logic.

 if (authenticated !== true) {
 return;
 }

 // Calling this effect conditionally because we make sure that `authenticated` is always the same throughout the component lifecycle.
 // eslint-disable-next-line react-hooks/rules-of-hooks
 useEffect(() => {
Comment thread
panteliselef marked this conversation as resolved.

 const isNowSignedOut = isSignedOut === true;

 if (previousIsSignedIn && isNowSignedOut) {
 queryClient.removeQueries({
 predicate: query => {
 const [cachedStableKey, queryAuthenticated] = query.queryKey;

 return (
 queryAuthenticated === true &&
 typeof cachedStableKey === 'string' &&
 (Array.isArray(stableKeysRef.current)
 ? stableKeysRef.current.includes(cachedStableKey)
 : stableKeysRef.current === cachedStableKey)
 );
 },
 });

 onCleanup?.();
 }
 }, [isSignedOut, previousIsSignedIn, queryClient]);
}

32 changes: 9 additions & 23 deletions
packages/shared/src/react/hooks/usePagesOrInfinite.rq.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
import { useCallback, useMemo, useRef, useState } from 'react';

import type { ClerkPaginatedResponse } from '../../types';
import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
import { useClerkQueryClient } from '../clerk-rq/use-clerk-query-client';
import { useClerkInfiniteQuery } from '../clerk-rq/useInfiniteQuery';
import { useClerkQuery } from '../clerk-rq/useQuery';
import type { CacheSetter, ValueOrSetter } from '../types';
import { useClearQueriesOnSignOut, withInfiniteKey } from './useClearQueriesOnSignOut';
import type { UsePagesOrInfiniteSignature } from './usePageOrInfinite.types';
import { useWithSafeValues } from './usePagesOrInfinite.shared';
import { usePreviousValue } from './usePreviousValue';

export const usePagesOrInfinite: UsePagesOrInfiniteSignature = params => {
 const { fetcher, config, keys } = params;
Expand DownExpand Up@@ -98,32 +98,18 @@ export const usePagesOrInfinite: UsePagesOrInfiniteSignature = params => {
 enabled: queriesEnabled && triggerInfinite,
 });

 // Track previous isSignedIn state to detect sign-out transitions
 const previousIsSignedIn = usePreviousValue(isSignedIn);

 // Detect sign-out and clear queries
 useEffect(() => {
 const isNowSignedOut = isSignedIn === false;

 if (previousIsSignedIn && isNowSignedOut) {
 queryClient.removeQueries({
 predicate: query => {
 const [stablePrefix, authenticated] = query.queryKey;
 return (
 authenticated === true &&
 typeof stablePrefix === 'string' &&
 (stablePrefix === keys.queryKey[0] || stablePrefix === keys.queryKey[0] + '-inf')
 );
 },
 });

 useClearQueriesOnSignOut({
 isSignedOut: isSignedIn === false,
 authenticated: keys.authenticated,
 stableKeys: withInfiniteKey(keys.stableKey),
 onCleanup: () => {
 // Reset paginated page to initial
 setPaginatedPage(initialPageRef.current);

 // Force re-render to reflect cache changes
 void Promise.resolve().then(() => forceUpdate(n => n + 1));
 }
 }, [isSignedIn, queryClient, previousIsSignedIn, forceUpdate]);
 },
 });

 // Compute data, count and page from the same data source to ensure consistency
 const computedValues = useMemo(() => {
Expand Down

9 changes: 8 additions & 1 deletion
packages/shared/src/react/hooks/usePaymentAttemptQuery.rq.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
import { useClerkQuery } from '../clerk-rq/useQuery';
import { useClerkInstanceContext, useOrganizationContext, useUserContext } from '../contexts';
import { useBillingHookEnabled } from './useBillingHookEnabled';
import { useClearQueriesOnSignOut } from './useClearQueriesOnSignOut';
import { usePaymentAttemptQueryCacheKeys } from './usePaymentAttemptQuery.shared';
import type { PaymentAttemptQueryResult, UsePaymentAttemptQueryParams } from './usePaymentAttemptQuery.types';

Expand All@@ -17,7 +18,7 @@ function usePaymentAttemptQuery(params: UsePaymentAttemptQueryParams): PaymentAt
 const organizationId = forType === 'organization' ? (organization?.id ?? null) : null;
 const userId = user?.id ?? null;

 const { queryKey } = usePaymentAttemptQueryCacheKeys({
 const { queryKey, stableKey, authenticated } = usePaymentAttemptQueryCacheKeys({
 paymentAttemptId,
 userId,
 orgId: organizationId,
Expand All@@ -28,6 +29,12 @@ function usePaymentAttemptQuery(params: UsePaymentAttemptQueryParams): PaymentAt

 const queryEnabled = Boolean(paymentAttemptId) && billingEnabled;

 useClearQueriesOnSignOut({
 isSignedOut: user === null, // works with the transitive state
 authenticated,
 stableKeys: stableKey,
 });

 const query = useClerkQuery({
 queryKey,
 queryFn: ({ queryKey }) => {
Expand Down

9 changes: 8 additions & 1 deletion
packages/shared/src/react/hooks/useStatementQuery.rq.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
import { useClerkQuery } from '../clerk-rq/useQuery';
import { useClerkInstanceContext, useOrganizationContext, useUserContext } from '../contexts';
import { useBillingHookEnabled } from './useBillingHookEnabled';
import { useClearQueriesOnSignOut } from './useClearQueriesOnSignOut';
import { useStatementQueryCacheKeys } from './useStatementQuery.shared';
import type { StatementQueryResult, UseStatementQueryParams } from './useStatementQuery.types';

Expand All@@ -17,7 +18,7 @@ function useStatementQuery(params: UseStatementQueryParams = {}): StatementQuery
 const organizationId = forType === 'organization' ? (organization?.id ?? null) : null;
 const userId = user?.id ?? null;

 const { queryKey } = useStatementQueryCacheKeys({
 const { queryKey, stableKey, authenticated } = useStatementQueryCacheKeys({
 statementId,
 userId,
 orgId: organizationId,
Expand All@@ -28,6 +29,12 @@ function useStatementQuery(params: UseStatementQueryParams = {}): StatementQuery

 const queryEnabled = Boolean(statementId) && billingEnabled;

 useClearQueriesOnSignOut({
 isSignedOut: user === null,
 authenticated,
 stableKeys: stableKey,
 });

 const query = useClerkQuery({
 queryKey,
 queryFn: () => {
Expand Down

8 changes: 7 additions & 1 deletion
packages/shared/src/react/hooks/useSubscription.rq.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ import {
 useUserContext,
} from '../contexts';
import { useBillingHookEnabled } from './useBillingHookEnabled';
import { useClearQueriesOnSignOut } from './useClearQueriesOnSignOut';
import { useSubscriptionCacheKeys } from './useSubscription.shared';
import type { SubscriptionResult, UseSubscriptionParams } from './useSubscription.types';

Expand All@@ -37,13 +38,18 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes

 const [queryClient] = useClerkQueryClient();

 const { queryKey, invalidationKey } = useSubscriptionCacheKeys({
 const { queryKey, invalidationKey, stableKey, authenticated } = useSubscriptionCacheKeys({
 userId: user?.id,
 orgId: organization?.id,
 for: params?.for,
 });

 const queriesEnabled = Boolean(user?.id && billingEnabled);
 useClearQueriesOnSignOut({
 isSignedOut: user === null,
 authenticated,
 stableKeys: stableKey,
 });

 const query = useClerkQuery({
 queryKey,
Expand Down

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

Skip to content
chore(shared): Refactor clearing cache in RQ hooks#7330

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 1 commit into

from

Nov 28, 2025
 Merged


chore(shared): Refactor clearing cache in RQ hooks
#7330
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/smooth-lamps-raise.md

View file


Open in desktop

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

Refactor clearing cache in RQ hooks when a use signs out.
@coderabbitaicoderabbitaiBotNov 28, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor
Fix typo: "use" should be "user".
The changeset description has a typo that will appear in the published changelog.
-Refactor clearing cache in RQ hooks when a use signs out.+Refactor clearing cache in RQ hooks when a user signs out.
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

Refactor clearing cache in RQ hooks when a use signs out.
Refactor clearing cache in RQ hooks when a user signs out.
🧰 Tools
🪛 LanguageTool
[grammar] ~5-~5: Ensure spelling is correct

Context: ...actor clearing cache in RQ hooks when a use signs out.
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
In .changeset/smooth-lamps-raise.md around line 5, the changeset description
contains a typo: "use" should be "user"; edit that line to replace "use" with
"user" so the published changelog reads "Refactor clearing cache in RQ hooks
when a user signs out." Ensure spelling is corrected and commit the updated
changeset.


2 changes: 1 addition & 1 deletion
packages/shared/src/react/hooks/createBillingPaginatedHook.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -129,7 +129,7 @@ export function createBillingPaginatedHook<TResource extends ClerkResource, TPar
 keepPreviousData: safeValues.keepPreviousData,
 infinite: safeValues.infinite,
 enabled: isEnabled,
 ...(options?.unauthenticated ? {} : { isSignedIn: Boolean(user) }),
 ...(options?.unauthenticated ? {} : { isSignedIn: user !== null }),
 __experimental_mode: safeValues.__experimental_mode,
 initialPage: safeValues.initialPage,
 pageSize: safeValues.pageSize,
Expand Down

64 changes: 64 additions & 0 deletions
packages/shared/src/react/hooks/useClearQueriesOnSignOut.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
import { useEffect, useRef } from 'react';

import { useClerkQueryClient } from '../clerk-rq/use-clerk-query-client';
import { usePreviousValue } from './usePreviousValue';

export const withInfiniteKey = <T extends string>(key: T) => [key, `${key}-inf`] as const;

type ClearQueriesOnSignOutOptions = {
 isSignedOut: boolean;
 stableKeys: string | readonly string[];
 /**
 * Whether the queries for this hook are keyed as authenticated.
 * If this is not `true`, the effect becomes a no-op.
 */
 authenticated?: boolean;
 /**
 * Optional callback that will run after queries are cleared on sign-out.
 */
 onCleanup?: () => void;
};

/**
 * Clears React Query caches associated with the given stable prefixes when
 * the authenticated state transitions from signed-in to signed-out.
 *
 * @internal
 */
export function useClearQueriesOnSignOut(options: ClearQueriesOnSignOutOptions) {
 const { isSignedOut, stableKeys, authenticated = true, onCleanup } = options;
 const stableKeysRef = useRef(stableKeys);
Comment thread
panteliselef marked this conversation as resolved.


 const [queryClient] = useClerkQueryClient();
 const previousIsSignedIn = usePreviousValue(!isSignedOut);

 // If this hook's cache keys are not authenticated, skip all cleanup logic.

 if (authenticated !== true) {
 return;
 }

 // Calling this effect conditionally because we make sure that `authenticated` is always the same throughout the component lifecycle.
 // eslint-disable-next-line react-hooks/rules-of-hooks
 useEffect(() => {
Comment thread
panteliselef marked this conversation as resolved.

 const isNowSignedOut = isSignedOut === true;

 if (previousIsSignedIn && isNowSignedOut) {
 queryClient.removeQueries({
 predicate: query => {
 const [cachedStableKey, queryAuthenticated] = query.queryKey;

 return (
 queryAuthenticated === true &&
 typeof cachedStableKey === 'string' &&
 (Array.isArray(stableKeysRef.current)
 ? stableKeysRef.current.includes(cachedStableKey)
 : stableKeysRef.current === cachedStableKey)
 );
 },
 });

 onCleanup?.();
 }
 }, [isSignedOut, previousIsSignedIn, queryClient]);
}

32 changes: 9 additions & 23 deletions
packages/shared/src/react/hooks/usePagesOrInfinite.rq.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
import { useCallback, useMemo, useRef, useState } from 'react';

import type { ClerkPaginatedResponse } from '../../types';
import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
import { useClerkQueryClient } from '../clerk-rq/use-clerk-query-client';
import { useClerkInfiniteQuery } from '../clerk-rq/useInfiniteQuery';
import { useClerkQuery } from '../clerk-rq/useQuery';
import type { CacheSetter, ValueOrSetter } from '../types';
import { useClearQueriesOnSignOut, withInfiniteKey } from './useClearQueriesOnSignOut';
import type { UsePagesOrInfiniteSignature } from './usePageOrInfinite.types';
import { useWithSafeValues } from './usePagesOrInfinite.shared';
import { usePreviousValue } from './usePreviousValue';

export const usePagesOrInfinite: UsePagesOrInfiniteSignature = params => {
 const { fetcher, config, keys } = params;
Expand DownExpand Up@@ -98,32 +98,18 @@ export const usePagesOrInfinite: UsePagesOrInfiniteSignature = params => {
 enabled: queriesEnabled && triggerInfinite,
 });

 // Track previous isSignedIn state to detect sign-out transitions
 const previousIsSignedIn = usePreviousValue(isSignedIn);

 // Detect sign-out and clear queries
 useEffect(() => {
 const isNowSignedOut = isSignedIn === false;

 if (previousIsSignedIn && isNowSignedOut) {
 queryClient.removeQueries({
 predicate: query => {
 const [stablePrefix, authenticated] = query.queryKey;
 return (
 authenticated === true &&
 typeof stablePrefix === 'string' &&
 (stablePrefix === keys.queryKey[0] || stablePrefix === keys.queryKey[0] + '-inf')
 );
 },
 });

 useClearQueriesOnSignOut({
 isSignedOut: isSignedIn === false,
 authenticated: keys.authenticated,
 stableKeys: withInfiniteKey(keys.stableKey),
 onCleanup: () => {
 // Reset paginated page to initial
 setPaginatedPage(initialPageRef.current);

 // Force re-render to reflect cache changes
 void Promise.resolve().then(() => forceUpdate(n => n + 1));
 }
 }, [isSignedIn, queryClient, previousIsSignedIn, forceUpdate]);
 },
 });

 // Compute data, count and page from the same data source to ensure consistency
 const computedValues = useMemo(() => {
Expand Down

9 changes: 8 additions & 1 deletion
packages/shared/src/react/hooks/usePaymentAttemptQuery.rq.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
import { useClerkQuery } from '../clerk-rq/useQuery';
import { useClerkInstanceContext, useOrganizationContext, useUserContext } from '../contexts';
import { useBillingHookEnabled } from './useBillingHookEnabled';
import { useClearQueriesOnSignOut } from './useClearQueriesOnSignOut';
import { usePaymentAttemptQueryCacheKeys } from './usePaymentAttemptQuery.shared';
import type { PaymentAttemptQueryResult, UsePaymentAttemptQueryParams } from './usePaymentAttemptQuery.types';

Expand All@@ -17,7 +18,7 @@ function usePaymentAttemptQuery(params: UsePaymentAttemptQueryParams): PaymentAt
 const organizationId = forType === 'organization' ? (organization?.id ?? null) : null;
 const userId = user?.id ?? null;

 const { queryKey } = usePaymentAttemptQueryCacheKeys({
 const { queryKey, stableKey, authenticated } = usePaymentAttemptQueryCacheKeys({
 paymentAttemptId,
 userId,
 orgId: organizationId,
Expand All@@ -28,6 +29,12 @@ function usePaymentAttemptQuery(params: UsePaymentAttemptQueryParams): PaymentAt

 const queryEnabled = Boolean(paymentAttemptId) && billingEnabled;

 useClearQueriesOnSignOut({
 isSignedOut: user === null, // works with the transitive state
 authenticated,
 stableKeys: stableKey,
 });

 const query = useClerkQuery({
 queryKey,
 queryFn: ({ queryKey }) => {
Expand Down

9 changes: 8 additions & 1 deletion
packages/shared/src/react/hooks/useStatementQuery.rq.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
import { useClerkQuery } from '../clerk-rq/useQuery';
import { useClerkInstanceContext, useOrganizationContext, useUserContext } from '../contexts';
import { useBillingHookEnabled } from './useBillingHookEnabled';
import { useClearQueriesOnSignOut } from './useClearQueriesOnSignOut';
import { useStatementQueryCacheKeys } from './useStatementQuery.shared';
import type { StatementQueryResult, UseStatementQueryParams } from './useStatementQuery.types';

Expand All@@ -17,7 +18,7 @@ function useStatementQuery(params: UseStatementQueryParams = {}): StatementQuery
 const organizationId = forType === 'organization' ? (organization?.id ?? null) : null;
 const userId = user?.id ?? null;

 const { queryKey } = useStatementQueryCacheKeys({
 const { queryKey, stableKey, authenticated } = useStatementQueryCacheKeys({
 statementId,
 userId,
 orgId: organizationId,
Expand All@@ -28,6 +29,12 @@ function useStatementQuery(params: UseStatementQueryParams = {}): StatementQuery

 const queryEnabled = Boolean(statementId) && billingEnabled;

 useClearQueriesOnSignOut({
 isSignedOut: user === null,
 authenticated,
 stableKeys: stableKey,
 });

 const query = useClerkQuery({
 queryKey,
 queryFn: () => {
Expand Down

8 changes: 7 additions & 1 deletion
packages/shared/src/react/hooks/useSubscription.rq.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ import {
 useUserContext,
} from '../contexts';
import { useBillingHookEnabled } from './useBillingHookEnabled';
import { useClearQueriesOnSignOut } from './useClearQueriesOnSignOut';
import { useSubscriptionCacheKeys } from './useSubscription.shared';
import type { SubscriptionResult, UseSubscriptionParams } from './useSubscription.types';

Expand All@@ -37,13 +38,18 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes

 const [queryClient] = useClerkQueryClient();

 const { queryKey, invalidationKey } = useSubscriptionCacheKeys({
 const { queryKey, invalidationKey, stableKey, authenticated } = useSubscriptionCacheKeys({
 userId: user?.id,
 orgId: organization?.id,
 for: params?.for,
 });

 const queriesEnabled = Boolean(user?.id && billingEnabled);
 useClearQueriesOnSignOut({
 isSignedOut: user === null,
 authenticated,
 stableKeys: stableKey,
 });

 const query = useClerkQuery({
 queryKey,
Expand Down

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

Skip to content
chore(shared): Refactor clearing cache in RQ hooks#7330

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 1 commit into

from

Nov 28, 2025
 Merged


chore(shared): Refactor clearing cache in RQ hooks
#7330
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/smooth-lamps-raise.md

View file


Open in desktop

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

Refactor clearing cache in RQ hooks when a use signs out.
@coderabbitaicoderabbitaiBotNov 28, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor
Fix typo: "use" should be "user".
The changeset description has a typo that will appear in the published changelog.
-Refactor clearing cache in RQ hooks when a use signs out.+Refactor clearing cache in RQ hooks when a user signs out.
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

Refactor clearing cache in RQ hooks when a use signs out.
Refactor clearing cache in RQ hooks when a user signs out.
🧰 Tools
🪛 LanguageTool
[grammar] ~5-~5: Ensure spelling is correct

Context: ...actor clearing cache in RQ hooks when a use signs out.
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
In .changeset/smooth-lamps-raise.md around line 5, the changeset description
contains a typo: "use" should be "user"; edit that line to replace "use" with
"user" so the published changelog reads "Refactor clearing cache in RQ hooks
when a user signs out." Ensure spelling is corrected and commit the updated
changeset.


2 changes: 1 addition & 1 deletion
packages/shared/src/react/hooks/createBillingPaginatedHook.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -129,7 +129,7 @@ export function createBillingPaginatedHook<TResource extends ClerkResource, TPar
 keepPreviousData: safeValues.keepPreviousData,
 infinite: safeValues.infinite,
 enabled: isEnabled,
 ...(options?.unauthenticated ? {} : { isSignedIn: Boolean(user) }),
 ...(options?.unauthenticated ? {} : { isSignedIn: user !== null }),
 __experimental_mode: safeValues.__experimental_mode,
 initialPage: safeValues.initialPage,
 pageSize: safeValues.pageSize,
Expand Down

64 changes: 64 additions & 0 deletions
packages/shared/src/react/hooks/useClearQueriesOnSignOut.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
import { useEffect, useRef } from 'react';

import { useClerkQueryClient } from '../clerk-rq/use-clerk-query-client';
import { usePreviousValue } from './usePreviousValue';

export const withInfiniteKey = <T extends string>(key: T) => [key, `${key}-inf`] as const;

type ClearQueriesOnSignOutOptions = {
 isSignedOut: boolean;
 stableKeys: string | readonly string[];
 /**
 * Whether the queries for this hook are keyed as authenticated.
 * If this is not `true`, the effect becomes a no-op.
 */
 authenticated?: boolean;
 /**
 * Optional callback that will run after queries are cleared on sign-out.
 */
 onCleanup?: () => void;
};

/**
 * Clears React Query caches associated with the given stable prefixes when
 * the authenticated state transitions from signed-in to signed-out.
 *
 * @internal
 */
export function useClearQueriesOnSignOut(options: ClearQueriesOnSignOutOptions) {
 const { isSignedOut, stableKeys, authenticated = true, onCleanup } = options;
 const stableKeysRef = useRef(stableKeys);
Comment thread
panteliselef marked this conversation as resolved.


 const [queryClient] = useClerkQueryClient();
 const previousIsSignedIn = usePreviousValue(!isSignedOut);

 // If this hook's cache keys are not authenticated, skip all cleanup logic.

 if (authenticated !== true) {
 return;
 }

 // Calling this effect conditionally because we make sure that `authenticated` is always the same throughout the component lifecycle.
 // eslint-disable-next-line react-hooks/rules-of-hooks
 useEffect(() => {
Comment thread
panteliselef marked this conversation as resolved.

 const isNowSignedOut = isSignedOut === true;

 if (previousIsSignedIn && isNowSignedOut) {
 queryClient.removeQueries({
 predicate: query => {
 const [cachedStableKey, queryAuthenticated] = query.queryKey;

 return (
 queryAuthenticated === true &&
 typeof cachedStableKey === 'string' &&
 (Array.isArray(stableKeysRef.current)
 ? stableKeysRef.current.includes(cachedStableKey)
 : stableKeysRef.current === cachedStableKey)
 );
 },
 });

 onCleanup?.();
 }
 }, [isSignedOut, previousIsSignedIn, queryClient]);
}

32 changes: 9 additions & 23 deletions
packages/shared/src/react/hooks/usePagesOrInfinite.rq.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
import { useCallback, useMemo, useRef, useState } from 'react';

import type { ClerkPaginatedResponse } from '../../types';
import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
import { useClerkQueryClient } from '../clerk-rq/use-clerk-query-client';
import { useClerkInfiniteQuery } from '../clerk-rq/useInfiniteQuery';
import { useClerkQuery } from '../clerk-rq/useQuery';
import type { CacheSetter, ValueOrSetter } from '../types';
import { useClearQueriesOnSignOut, withInfiniteKey } from './useClearQueriesOnSignOut';
import type { UsePagesOrInfiniteSignature } from './usePageOrInfinite.types';
import { useWithSafeValues } from './usePagesOrInfinite.shared';
import { usePreviousValue } from './usePreviousValue';

export const usePagesOrInfinite: UsePagesOrInfiniteSignature = params => {
 const { fetcher, config, keys } = params;
Expand DownExpand Up@@ -98,32 +98,18 @@ export const usePagesOrInfinite: UsePagesOrInfiniteSignature = params => {
 enabled: queriesEnabled && triggerInfinite,
 });

 // Track previous isSignedIn state to detect sign-out transitions
 const previousIsSignedIn = usePreviousValue(isSignedIn);

 // Detect sign-out and clear queries
 useEffect(() => {
 const isNowSignedOut = isSignedIn === false;

 if (previousIsSignedIn && isNowSignedOut) {
 queryClient.removeQueries({
 predicate: query => {
 const [stablePrefix, authenticated] = query.queryKey;
 return (
 authenticated === true &&
 typeof stablePrefix === 'string' &&
 (stablePrefix === keys.queryKey[0] || stablePrefix === keys.queryKey[0] + '-inf')
 );
 },
 });

 useClearQueriesOnSignOut({
 isSignedOut: isSignedIn === false,
 authenticated: keys.authenticated,
 stableKeys: withInfiniteKey(keys.stableKey),
 onCleanup: () => {
 // Reset paginated page to initial
 setPaginatedPage(initialPageRef.current);

 // Force re-render to reflect cache changes
 void Promise.resolve().then(() => forceUpdate(n => n + 1));
 }
 }, [isSignedIn, queryClient, previousIsSignedIn, forceUpdate]);
 },
 });

 // Compute data, count and page from the same data source to ensure consistency
 const computedValues = useMemo(() => {
Expand Down

9 changes: 8 additions & 1 deletion
packages/shared/src/react/hooks/usePaymentAttemptQuery.rq.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
import { useClerkQuery } from '../clerk-rq/useQuery';
import { useClerkInstanceContext, useOrganizationContext, useUserContext } from '../contexts';
import { useBillingHookEnabled } from './useBillingHookEnabled';
import { useClearQueriesOnSignOut } from './useClearQueriesOnSignOut';
import { usePaymentAttemptQueryCacheKeys } from './usePaymentAttemptQuery.shared';
import type { PaymentAttemptQueryResult, UsePaymentAttemptQueryParams } from './usePaymentAttemptQuery.types';

Expand All@@ -17,7 +18,7 @@ function usePaymentAttemptQuery(params: UsePaymentAttemptQueryParams): PaymentAt
 const organizationId = forType === 'organization' ? (organization?.id ?? null) : null;
 const userId = user?.id ?? null;

 const { queryKey } = usePaymentAttemptQueryCacheKeys({
 const { queryKey, stableKey, authenticated } = usePaymentAttemptQueryCacheKeys({
 paymentAttemptId,
 userId,
 orgId: organizationId,
Expand All@@ -28,6 +29,12 @@ function usePaymentAttemptQuery(params: UsePaymentAttemptQueryParams): PaymentAt

 const queryEnabled = Boolean(paymentAttemptId) && billingEnabled;

 useClearQueriesOnSignOut({
 isSignedOut: user === null, // works with the transitive state
 authenticated,
 stableKeys: stableKey,
 });

 const query = useClerkQuery({
 queryKey,
 queryFn: ({ queryKey }) => {
Expand Down

9 changes: 8 additions & 1 deletion
packages/shared/src/react/hooks/useStatementQuery.rq.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
import { useClerkQuery } from '../clerk-rq/useQuery';
import { useClerkInstanceContext, useOrganizationContext, useUserContext } from '../contexts';
import { useBillingHookEnabled } from './useBillingHookEnabled';
import { useClearQueriesOnSignOut } from './useClearQueriesOnSignOut';
import { useStatementQueryCacheKeys } from './useStatementQuery.shared';
import type { StatementQueryResult, UseStatementQueryParams } from './useStatementQuery.types';

Expand All@@ -17,7 +18,7 @@ function useStatementQuery(params: UseStatementQueryParams = {}): StatementQuery
 const organizationId = forType === 'organization' ? (organization?.id ?? null) : null;
 const userId = user?.id ?? null;

 const { queryKey } = useStatementQueryCacheKeys({
 const { queryKey, stableKey, authenticated } = useStatementQueryCacheKeys({
 statementId,
 userId,
 orgId: organizationId,
Expand All@@ -28,6 +29,12 @@ function useStatementQuery(params: UseStatementQueryParams = {}): StatementQuery

 const queryEnabled = Boolean(statementId) && billingEnabled;

 useClearQueriesOnSignOut({
 isSignedOut: user === null,
 authenticated,
 stableKeys: stableKey,
 });

 const query = useClerkQuery({
 queryKey,
 queryFn: () => {
Expand Down

8 changes: 7 additions & 1 deletion
packages/shared/src/react/hooks/useSubscription.rq.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ import {
 useUserContext,
} from '../contexts';
import { useBillingHookEnabled } from './useBillingHookEnabled';
import { useClearQueriesOnSignOut } from './useClearQueriesOnSignOut';
import { useSubscriptionCacheKeys } from './useSubscription.shared';
import type { SubscriptionResult, UseSubscriptionParams } from './useSubscription.types';

Expand All@@ -37,13 +38,18 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes

 const [queryClient] = useClerkQueryClient();

 const { queryKey, invalidationKey } = useSubscriptionCacheKeys({
 const { queryKey, invalidationKey, stableKey, authenticated } = useSubscriptionCacheKeys({
 userId: user?.id,
 orgId: organization?.id,
 for: params?.for,
 });

 const queriesEnabled = Boolean(user?.id && billingEnabled);
 useClearQueriesOnSignOut({
 isSignedOut: user === null,
 authenticated,
 stableKeys: stableKey,
 });

 const query = useClerkQuery({
 queryKey,
Expand Down

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

Skip to content
chore(shared): Refactor clearing cache in RQ hooks#7330

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 1 commit into

from

Nov 28, 2025
 Merged


chore(shared): Refactor clearing cache in RQ hooks
#7330
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/smooth-lamps-raise.md

View file


Open in desktop

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

Refactor clearing cache in RQ hooks when a use signs out.
@coderabbitaicoderabbitaiBotNov 28, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor
Fix typo: "use" should be "user".
The changeset description has a typo that will appear in the published changelog.
-Refactor clearing cache in RQ hooks when a use signs out.+Refactor clearing cache in RQ hooks when a user signs out.
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

Refactor clearing cache in RQ hooks when a use signs out.
Refactor clearing cache in RQ hooks when a user signs out.
🧰 Tools
🪛 LanguageTool
[grammar] ~5-~5: Ensure spelling is correct

Context: ...actor clearing cache in RQ hooks when a use signs out.
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
In .changeset/smooth-lamps-raise.md around line 5, the changeset description
contains a typo: "use" should be "user"; edit that line to replace "use" with
"user" so the published changelog reads "Refactor clearing cache in RQ hooks
when a user signs out." Ensure spelling is corrected and commit the updated
changeset.


2 changes: 1 addition & 1 deletion
packages/shared/src/react/hooks/createBillingPaginatedHook.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -129,7 +129,7 @@ export function createBillingPaginatedHook<TResource extends ClerkResource, TPar
 keepPreviousData: safeValues.keepPreviousData,
 infinite: safeValues.infinite,
 enabled: isEnabled,
 ...(options?.unauthenticated ? {} : { isSignedIn: Boolean(user) }),
 ...(options?.unauthenticated ? {} : { isSignedIn: user !== null }),
 __experimental_mode: safeValues.__experimental_mode,
 initialPage: safeValues.initialPage,
 pageSize: safeValues.pageSize,
Expand Down

64 changes: 64 additions & 0 deletions
packages/shared/src/react/hooks/useClearQueriesOnSignOut.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
import { useEffect, useRef } from 'react';

import { useClerkQueryClient } from '../clerk-rq/use-clerk-query-client';
import { usePreviousValue } from './usePreviousValue';

export const withInfiniteKey = <T extends string>(key: T) => [key, `${key}-inf`] as const;

type ClearQueriesOnSignOutOptions = {
 isSignedOut: boolean;
 stableKeys: string | readonly string[];
 /**
 * Whether the queries for this hook are keyed as authenticated.
 * If this is not `true`, the effect becomes a no-op.
 */
 authenticated?: boolean;
 /**
 * Optional callback that will run after queries are cleared on sign-out.
 */
 onCleanup?: () => void;
};

/**
 * Clears React Query caches associated with the given stable prefixes when
 * the authenticated state transitions from signed-in to signed-out.
 *
 * @internal
 */
export function useClearQueriesOnSignOut(options: ClearQueriesOnSignOutOptions) {
 const { isSignedOut, stableKeys, authenticated = true, onCleanup } = options;
 const stableKeysRef = useRef(stableKeys);
Comment thread
panteliselef marked this conversation as resolved.


 const [queryClient] = useClerkQueryClient();
 const previousIsSignedIn = usePreviousValue(!isSignedOut);

 // If this hook's cache keys are not authenticated, skip all cleanup logic.

 if (authenticated !== true) {
 return;
 }

 // Calling this effect conditionally because we make sure that `authenticated` is always the same throughout the component lifecycle.
 // eslint-disable-next-line react-hooks/rules-of-hooks
 useEffect(() => {
Comment thread
panteliselef marked this conversation as resolved.

 const isNowSignedOut = isSignedOut === true;

 if (previousIsSignedIn && isNowSignedOut) {
 queryClient.removeQueries({
 predicate: query => {
 const [cachedStableKey, queryAuthenticated] = query.queryKey;

 return (
 queryAuthenticated === true &&
 typeof cachedStableKey === 'string' &&
 (Array.isArray(stableKeysRef.current)
 ? stableKeysRef.current.includes(cachedStableKey)
 : stableKeysRef.current === cachedStableKey)
 );
 },
 });

 onCleanup?.();
 }
 }, [isSignedOut, previousIsSignedIn, queryClient]);
}

32 changes: 9 additions & 23 deletions
packages/shared/src/react/hooks/usePagesOrInfinite.rq.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
import { useCallback, useMemo, useRef, useState } from 'react';

import type { ClerkPaginatedResponse } from '../../types';
import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
import { useClerkQueryClient } from '../clerk-rq/use-clerk-query-client';
import { useClerkInfiniteQuery } from '../clerk-rq/useInfiniteQuery';
import { useClerkQuery } from '../clerk-rq/useQuery';
import type { CacheSetter, ValueOrSetter } from '../types';
import { useClearQueriesOnSignOut, withInfiniteKey } from './useClearQueriesOnSignOut';
import type { UsePagesOrInfiniteSignature } from './usePageOrInfinite.types';
import { useWithSafeValues } from './usePagesOrInfinite.shared';
import { usePreviousValue } from './usePreviousValue';

export const usePagesOrInfinite: UsePagesOrInfiniteSignature = params => {
 const { fetcher, config, keys } = params;
Expand DownExpand Up@@ -98,32 +98,18 @@ export const usePagesOrInfinite: UsePagesOrInfiniteSignature = params => {
 enabled: queriesEnabled && triggerInfinite,
 });

 // Track previous isSignedIn state to detect sign-out transitions
 const previousIsSignedIn = usePreviousValue(isSignedIn);

 // Detect sign-out and clear queries
 useEffect(() => {
 const isNowSignedOut = isSignedIn === false;

 if (previousIsSignedIn && isNowSignedOut) {
 queryClient.removeQueries({
 predicate: query => {
 const [stablePrefix, authenticated] = query.queryKey;
 return (
 authenticated === true &&
 typeof stablePrefix === 'string' &&
 (stablePrefix === keys.queryKey[0] || stablePrefix === keys.queryKey[0] + '-inf')
 );
 },
 });

 useClearQueriesOnSignOut({
 isSignedOut: isSignedIn === false,
 authenticated: keys.authenticated,
 stableKeys: withInfiniteKey(keys.stableKey),
 onCleanup: () => {
 // Reset paginated page to initial
 setPaginatedPage(initialPageRef.current);

 // Force re-render to reflect cache changes
 void Promise.resolve().then(() => forceUpdate(n => n + 1));
 }
 }, [isSignedIn, queryClient, previousIsSignedIn, forceUpdate]);
 },
 });

 // Compute data, count and page from the same data source to ensure consistency
 const computedValues = useMemo(() => {
Expand Down

9 changes: 8 additions & 1 deletion
packages/shared/src/react/hooks/usePaymentAttemptQuery.rq.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
import { useClerkQuery } from '../clerk-rq/useQuery';
import { useClerkInstanceContext, useOrganizationContext, useUserContext } from '../contexts';
import { useBillingHookEnabled } from './useBillingHookEnabled';
import { useClearQueriesOnSignOut } from './useClearQueriesOnSignOut';
import { usePaymentAttemptQueryCacheKeys } from './usePaymentAttemptQuery.shared';
import type { PaymentAttemptQueryResult, UsePaymentAttemptQueryParams } from './usePaymentAttemptQuery.types';

Expand All@@ -17,7 +18,7 @@ function usePaymentAttemptQuery(params: UsePaymentAttemptQueryParams): PaymentAt
 const organizationId = forType === 'organization' ? (organization?.id ?? null) : null;
 const userId = user?.id ?? null;

 const { queryKey } = usePaymentAttemptQueryCacheKeys({
 const { queryKey, stableKey, authenticated } = usePaymentAttemptQueryCacheKeys({
 paymentAttemptId,
 userId,
 orgId: organizationId,
Expand All@@ -28,6 +29,12 @@ function usePaymentAttemptQuery(params: UsePaymentAttemptQueryParams): PaymentAt

 const queryEnabled = Boolean(paymentAttemptId) && billingEnabled;

 useClearQueriesOnSignOut({
 isSignedOut: user === null, // works with the transitive state
 authenticated,
 stableKeys: stableKey,
 });

 const query = useClerkQuery({
 queryKey,
 queryFn: ({ queryKey }) => {
Expand Down

9 changes: 8 additions & 1 deletion
packages/shared/src/react/hooks/useStatementQuery.rq.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
import { useClerkQuery } from '../clerk-rq/useQuery';
import { useClerkInstanceContext, useOrganizationContext, useUserContext } from '../contexts';
import { useBillingHookEnabled } from './useBillingHookEnabled';
import { useClearQueriesOnSignOut } from './useClearQueriesOnSignOut';
import { useStatementQueryCacheKeys } from './useStatementQuery.shared';
import type { StatementQueryResult, UseStatementQueryParams } from './useStatementQuery.types';

Expand All@@ -17,7 +18,7 @@ function useStatementQuery(params: UseStatementQueryParams = {}): StatementQuery
 const organizationId = forType === 'organization' ? (organization?.id ?? null) : null;
 const userId = user?.id ?? null;

 const { queryKey } = useStatementQueryCacheKeys({
 const { queryKey, stableKey, authenticated } = useStatementQueryCacheKeys({
 statementId,
 userId,
 orgId: organizationId,
Expand All@@ -28,6 +29,12 @@ function useStatementQuery(params: UseStatementQueryParams = {}): StatementQuery

 const queryEnabled = Boolean(statementId) && billingEnabled;

 useClearQueriesOnSignOut({
 isSignedOut: user === null,
 authenticated,
 stableKeys: stableKey,
 });

 const query = useClerkQuery({
 queryKey,
 queryFn: () => {
Expand Down

8 changes: 7 additions & 1 deletion
packages/shared/src/react/hooks/useSubscription.rq.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ import {
 useUserContext,
} from '../contexts';
import { useBillingHookEnabled } from './useBillingHookEnabled';
import { useClearQueriesOnSignOut } from './useClearQueriesOnSignOut';
import { useSubscriptionCacheKeys } from './useSubscription.shared';
import type { SubscriptionResult, UseSubscriptionParams } from './useSubscription.types';

Expand All@@ -37,13 +38,18 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes

 const [queryClient] = useClerkQueryClient();

 const { queryKey, invalidationKey } = useSubscriptionCacheKeys({
 const { queryKey, invalidationKey, stableKey, authenticated } = useSubscriptionCacheKeys({
 userId: user?.id,
 orgId: organization?.id,
 for: params?.for,
 });

 const queriesEnabled = Boolean(user?.id && billingEnabled);
 useClearQueriesOnSignOut({
 isSignedOut: user === null,
 authenticated,
 stableKeys: stableKey,
 });

 const query = useClerkQuery({
 queryKey,
Expand Down

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

Skip to content
chore(shared): Refactor clearing cache in RQ hooks#7330

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 1 commit into

from

Nov 28, 2025
 Merged


chore(shared): Refactor clearing cache in RQ hooks
#7330
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/smooth-lamps-raise.md

View file


Open in desktop

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

Refactor clearing cache in RQ hooks when a use signs out.
@coderabbitaicoderabbitaiBotNov 28, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor
Fix typo: "use" should be "user".
The changeset description has a typo that will appear in the published changelog.
-Refactor clearing cache in RQ hooks when a use signs out.+Refactor clearing cache in RQ hooks when a user signs out.
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

Refactor clearing cache in RQ hooks when a use signs out.
Refactor clearing cache in RQ hooks when a user signs out.
🧰 Tools
🪛 LanguageTool
[grammar] ~5-~5: Ensure spelling is correct

Context: ...actor clearing cache in RQ hooks when a use signs out.
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
In .changeset/smooth-lamps-raise.md around line 5, the changeset description
contains a typo: "use" should be "user"; edit that line to replace "use" with
"user" so the published changelog reads "Refactor clearing cache in RQ hooks
when a user signs out." Ensure spelling is corrected and commit the updated
changeset.


2 changes: 1 addition & 1 deletion
packages/shared/src/react/hooks/createBillingPaginatedHook.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -129,7 +129,7 @@ export function createBillingPaginatedHook<TResource extends ClerkResource, TPar
 keepPreviousData: safeValues.keepPreviousData,
 infinite: safeValues.infinite,
 enabled: isEnabled,
 ...(options?.unauthenticated ? {} : { isSignedIn: Boolean(user) }),
 ...(options?.unauthenticated ? {} : { isSignedIn: user !== null }),
 __experimental_mode: safeValues.__experimental_mode,
 initialPage: safeValues.initialPage,
 pageSize: safeValues.pageSize,
Expand Down

64 changes: 64 additions & 0 deletions
packages/shared/src/react/hooks/useClearQueriesOnSignOut.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
import { useEffect, useRef } from 'react';

import { useClerkQueryClient } from '../clerk-rq/use-clerk-query-client';
import { usePreviousValue } from './usePreviousValue';

export const withInfiniteKey = <T extends string>(key: T) => [key, `${key}-inf`] as const;

type ClearQueriesOnSignOutOptions = {
 isSignedOut: boolean;
 stableKeys: string | readonly string[];
 /**
 * Whether the queries for this hook are keyed as authenticated.
 * If this is not `true`, the effect becomes a no-op.
 */
 authenticated?: boolean;
 /**
 * Optional callback that will run after queries are cleared on sign-out.
 */
 onCleanup?: () => void;
};

/**
 * Clears React Query caches associated with the given stable prefixes when
 * the authenticated state transitions from signed-in to signed-out.
 *
 * @internal
 */
export function useClearQueriesOnSignOut(options: ClearQueriesOnSignOutOptions) {
 const { isSignedOut, stableKeys, authenticated = true, onCleanup } = options;
 const stableKeysRef = useRef(stableKeys);
Comment thread
panteliselef marked this conversation as resolved.


 const [queryClient] = useClerkQueryClient();
 const previousIsSignedIn = usePreviousValue(!isSignedOut);

 // If this hook's cache keys are not authenticated, skip all cleanup logic.

 if (authenticated !== true) {
 return;
 }

 // Calling this effect conditionally because we make sure that `authenticated` is always the same throughout the component lifecycle.
 // eslint-disable-next-line react-hooks/rules-of-hooks
 useEffect(() => {
Comment thread
panteliselef marked this conversation as resolved.

 const isNowSignedOut = isSignedOut === true;

 if (previousIsSignedIn && isNowSignedOut) {
 queryClient.removeQueries({
 predicate: query => {
 const [cachedStableKey, queryAuthenticated] = query.queryKey;

 return (
 queryAuthenticated === true &&
 typeof cachedStableKey === 'string' &&
 (Array.isArray(stableKeysRef.current)
 ? stableKeysRef.current.includes(cachedStableKey)
 : stableKeysRef.current === cachedStableKey)
 );
 },
 });

 onCleanup?.();
 }
 }, [isSignedOut, previousIsSignedIn, queryClient]);
}

32 changes: 9 additions & 23 deletions
packages/shared/src/react/hooks/usePagesOrInfinite.rq.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
import { useCallback, useMemo, useRef, useState } from 'react';

import type { ClerkPaginatedResponse } from '../../types';
import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
import { useClerkQueryClient } from '../clerk-rq/use-clerk-query-client';
import { useClerkInfiniteQuery } from '../clerk-rq/useInfiniteQuery';
import { useClerkQuery } from '../clerk-rq/useQuery';
import type { CacheSetter, ValueOrSetter } from '../types';
import { useClearQueriesOnSignOut, withInfiniteKey } from './useClearQueriesOnSignOut';
import type { UsePagesOrInfiniteSignature } from './usePageOrInfinite.types';
import { useWithSafeValues } from './usePagesOrInfinite.shared';
import { usePreviousValue } from './usePreviousValue';

export const usePagesOrInfinite: UsePagesOrInfiniteSignature = params => {
 const { fetcher, config, keys } = params;
Expand DownExpand Up@@ -98,32 +98,18 @@ export const usePagesOrInfinite: UsePagesOrInfiniteSignature = params => {
 enabled: queriesEnabled && triggerInfinite,
 });

 // Track previous isSignedIn state to detect sign-out transitions
 const previousIsSignedIn = usePreviousValue(isSignedIn);

 // Detect sign-out and clear queries
 useEffect(() => {
 const isNowSignedOut = isSignedIn === false;

 if (previousIsSignedIn && isNowSignedOut) {
 queryClient.removeQueries({
 predicate: query => {
 const [stablePrefix, authenticated] = query.queryKey;
 return (
 authenticated === true &&
 typeof stablePrefix === 'string' &&
 (stablePrefix === keys.queryKey[0] || stablePrefix === keys.queryKey[0] + '-inf')
 );
 },
 });

 useClearQueriesOnSignOut({
 isSignedOut: isSignedIn === false,
 authenticated: keys.authenticated,
 stableKeys: withInfiniteKey(keys.stableKey),
 onCleanup: () => {
 // Reset paginated page to initial
 setPaginatedPage(initialPageRef.current);

 // Force re-render to reflect cache changes
 void Promise.resolve().then(() => forceUpdate(n => n + 1));
 }
 }, [isSignedIn, queryClient, previousIsSignedIn, forceUpdate]);
 },
 });

 // Compute data, count and page from the same data source to ensure consistency
 const computedValues = useMemo(() => {
Expand Down

9 changes: 8 additions & 1 deletion
packages/shared/src/react/hooks/usePaymentAttemptQuery.rq.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
import { useClerkQuery } from '../clerk-rq/useQuery';
import { useClerkInstanceContext, useOrganizationContext, useUserContext } from '../contexts';
import { useBillingHookEnabled } from './useBillingHookEnabled';
import { useClearQueriesOnSignOut } from './useClearQueriesOnSignOut';
import { usePaymentAttemptQueryCacheKeys } from './usePaymentAttemptQuery.shared';
import type { PaymentAttemptQueryResult, UsePaymentAttemptQueryParams } from './usePaymentAttemptQuery.types';

Expand All@@ -17,7 +18,7 @@ function usePaymentAttemptQuery(params: UsePaymentAttemptQueryParams): PaymentAt
 const organizationId = forType === 'organization' ? (organization?.id ?? null) : null;
 const userId = user?.id ?? null;

 const { queryKey } = usePaymentAttemptQueryCacheKeys({
 const { queryKey, stableKey, authenticated } = usePaymentAttemptQueryCacheKeys({
 paymentAttemptId,
 userId,
 orgId: organizationId,
Expand All@@ -28,6 +29,12 @@ function usePaymentAttemptQuery(params: UsePaymentAttemptQueryParams): PaymentAt

 const queryEnabled = Boolean(paymentAttemptId) && billingEnabled;

 useClearQueriesOnSignOut({
 isSignedOut: user === null, // works with the transitive state
 authenticated,
 stableKeys: stableKey,
 });

 const query = useClerkQuery({
 queryKey,
 queryFn: ({ queryKey }) => {
Expand Down

9 changes: 8 additions & 1 deletion
packages/shared/src/react/hooks/useStatementQuery.rq.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
import { useClerkQuery } from '../clerk-rq/useQuery';
import { useClerkInstanceContext, useOrganizationContext, useUserContext } from '../contexts';
import { useBillingHookEnabled } from './useBillingHookEnabled';
import { useClearQueriesOnSignOut } from './useClearQueriesOnSignOut';
import { useStatementQueryCacheKeys } from './useStatementQuery.shared';
import type { StatementQueryResult, UseStatementQueryParams } from './useStatementQuery.types';

Expand All@@ -17,7 +18,7 @@ function useStatementQuery(params: UseStatementQueryParams = {}): StatementQuery
 const organizationId = forType === 'organization' ? (organization?.id ?? null) : null;
 const userId = user?.id ?? null;

 const { queryKey } = useStatementQueryCacheKeys({
 const { queryKey, stableKey, authenticated } = useStatementQueryCacheKeys({
 statementId,
 userId,
 orgId: organizationId,
Expand All@@ -28,6 +29,12 @@ function useStatementQuery(params: UseStatementQueryParams = {}): StatementQuery

 const queryEnabled = Boolean(statementId) && billingEnabled;

 useClearQueriesOnSignOut({
 isSignedOut: user === null,
 authenticated,
 stableKeys: stableKey,
 });

 const query = useClerkQuery({
 queryKey,
 queryFn: () => {
Expand Down

8 changes: 7 additions & 1 deletion
packages/shared/src/react/hooks/useSubscription.rq.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ import {
 useUserContext,
} from '../contexts';
import { useBillingHookEnabled } from './useBillingHookEnabled';
import { useClearQueriesOnSignOut } from './useClearQueriesOnSignOut';
import { useSubscriptionCacheKeys } from './useSubscription.shared';
import type { SubscriptionResult, UseSubscriptionParams } from './useSubscription.types';

Expand All@@ -37,13 +38,18 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes

 const [queryClient] = useClerkQueryClient();

 const { queryKey, invalidationKey } = useSubscriptionCacheKeys({
 const { queryKey, invalidationKey, stableKey, authenticated } = useSubscriptionCacheKeys({
 userId: user?.id,
 orgId: organization?.id,
 for: params?.for,
 });

 const queriesEnabled = Boolean(user?.id && billingEnabled);
 useClearQueriesOnSignOut({
 isSignedOut: user === null,
 authenticated,
 stableKeys: stableKey,
 });

 const query = useClerkQuery({
 queryKey,
Expand Down

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

Skip to content
chore(shared): Refactor clearing cache in RQ hooks#7330

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 1 commit into

from

Nov 28, 2025
 Merged


chore(shared): Refactor clearing cache in RQ hooks
#7330
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/smooth-lamps-raise.md

View file


Open in desktop

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

Refactor clearing cache in RQ hooks when a use signs out.
@coderabbitaicoderabbitaiBotNov 28, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor
Fix typo: "use" should be "user".
The changeset description has a typo that will appear in the published changelog.
-Refactor clearing cache in RQ hooks when a use signs out.+Refactor clearing cache in RQ hooks when a user signs out.
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

Refactor clearing cache in RQ hooks when a use signs out.
Refactor clearing cache in RQ hooks when a user signs out.
🧰 Tools
🪛 LanguageTool
[grammar] ~5-~5: Ensure spelling is correct

Context: ...actor clearing cache in RQ hooks when a use signs out.
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
In .changeset/smooth-lamps-raise.md around line 5, the changeset description
contains a typo: "use" should be "user"; edit that line to replace "use" with
"user" so the published changelog reads "Refactor clearing cache in RQ hooks
when a user signs out." Ensure spelling is corrected and commit the updated
changeset.


2 changes: 1 addition & 1 deletion
packages/shared/src/react/hooks/createBillingPaginatedHook.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -129,7 +129,7 @@ export function createBillingPaginatedHook<TResource extends ClerkResource, TPar
 keepPreviousData: safeValues.keepPreviousData,
 infinite: safeValues.infinite,
 enabled: isEnabled,
 ...(options?.unauthenticated ? {} : { isSignedIn: Boolean(user) }),
 ...(options?.unauthenticated ? {} : { isSignedIn: user !== null }),
 __experimental_mode: safeValues.__experimental_mode,
 initialPage: safeValues.initialPage,
 pageSize: safeValues.pageSize,
Expand Down

64 changes: 64 additions & 0 deletions
packages/shared/src/react/hooks/useClearQueriesOnSignOut.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
import { useEffect, useRef } from 'react';

import { useClerkQueryClient } from '../clerk-rq/use-clerk-query-client';
import { usePreviousValue } from './usePreviousValue';

export const withInfiniteKey = <T extends string>(key: T) => [key, `${key}-inf`] as const;

type ClearQueriesOnSignOutOptions = {
 isSignedOut: boolean;
 stableKeys: string | readonly string[];
 /**
 * Whether the queries for this hook are keyed as authenticated.
 * If this is not `true`, the effect becomes a no-op.
 */
 authenticated?: boolean;
 /**
 * Optional callback that will run after queries are cleared on sign-out.
 */
 onCleanup?: () => void;
};

/**
 * Clears React Query caches associated with the given stable prefixes when
 * the authenticated state transitions from signed-in to signed-out.
 *
 * @internal
 */
export function useClearQueriesOnSignOut(options: ClearQueriesOnSignOutOptions) {
 const { isSignedOut, stableKeys, authenticated = true, onCleanup } = options;
 const stableKeysRef = useRef(stableKeys);
Comment thread
panteliselef marked this conversation as resolved.


 const [queryClient] = useClerkQueryClient();
 const previousIsSignedIn = usePreviousValue(!isSignedOut);

 // If this hook's cache keys are not authenticated, skip all cleanup logic.

 if (authenticated !== true) {
 return;
 }

 // Calling this effect conditionally because we make sure that `authenticated` is always the same throughout the component lifecycle.
 // eslint-disable-next-line react-hooks/rules-of-hooks
 useEffect(() => {
Comment thread
panteliselef marked this conversation as resolved.

 const isNowSignedOut = isSignedOut === true;

 if (previousIsSignedIn && isNowSignedOut) {
 queryClient.removeQueries({
 predicate: query => {
 const [cachedStableKey, queryAuthenticated] = query.queryKey;

 return (
 queryAuthenticated === true &&
 typeof cachedStableKey === 'string' &&
 (Array.isArray(stableKeysRef.current)
 ? stableKeysRef.current.includes(cachedStableKey)
 : stableKeysRef.current === cachedStableKey)
 );
 },
 });

 onCleanup?.();
 }
 }, [isSignedOut, previousIsSignedIn, queryClient]);
}

32 changes: 9 additions & 23 deletions
packages/shared/src/react/hooks/usePagesOrInfinite.rq.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
import { useCallback, useMemo, useRef, useState } from 'react';

import type { ClerkPaginatedResponse } from '../../types';
import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
import { useClerkQueryClient } from '../clerk-rq/use-clerk-query-client';
import { useClerkInfiniteQuery } from '../clerk-rq/useInfiniteQuery';
import { useClerkQuery } from '../clerk-rq/useQuery';
import type { CacheSetter, ValueOrSetter } from '../types';
import { useClearQueriesOnSignOut, withInfiniteKey } from './useClearQueriesOnSignOut';
import type { UsePagesOrInfiniteSignature } from './usePageOrInfinite.types';
import { useWithSafeValues } from './usePagesOrInfinite.shared';
import { usePreviousValue } from './usePreviousValue';

export const usePagesOrInfinite: UsePagesOrInfiniteSignature = params => {
 const { fetcher, config, keys } = params;
Expand DownExpand Up@@ -98,32 +98,18 @@ export const usePagesOrInfinite: UsePagesOrInfiniteSignature = params => {
 enabled: queriesEnabled && triggerInfinite,
 });

 // Track previous isSignedIn state to detect sign-out transitions
 const previousIsSignedIn = usePreviousValue(isSignedIn);

 // Detect sign-out and clear queries
 useEffect(() => {
 const isNowSignedOut = isSignedIn === false;

 if (previousIsSignedIn && isNowSignedOut) {
 queryClient.removeQueries({
 predicate: query => {
 const [stablePrefix, authenticated] = query.queryKey;
 return (
 authenticated === true &&
 typeof stablePrefix === 'string' &&
 (stablePrefix === keys.queryKey[0] || stablePrefix === keys.queryKey[0] + '-inf')
 );
 },
 });

 useClearQueriesOnSignOut({
 isSignedOut: isSignedIn === false,
 authenticated: keys.authenticated,
 stableKeys: withInfiniteKey(keys.stableKey),
 onCleanup: () => {
 // Reset paginated page to initial
 setPaginatedPage(initialPageRef.current);

 // Force re-render to reflect cache changes
 void Promise.resolve().then(() => forceUpdate(n => n + 1));
 }
 }, [isSignedIn, queryClient, previousIsSignedIn, forceUpdate]);
 },
 });

 // Compute data, count and page from the same data source to ensure consistency
 const computedValues = useMemo(() => {
Expand Down

9 changes: 8 additions & 1 deletion
packages/shared/src/react/hooks/usePaymentAttemptQuery.rq.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
import { useClerkQuery } from '../clerk-rq/useQuery';
import { useClerkInstanceContext, useOrganizationContext, useUserContext } from '../contexts';
import { useBillingHookEnabled } from './useBillingHookEnabled';
import { useClearQueriesOnSignOut } from './useClearQueriesOnSignOut';
import { usePaymentAttemptQueryCacheKeys } from './usePaymentAttemptQuery.shared';
import type { PaymentAttemptQueryResult, UsePaymentAttemptQueryParams } from './usePaymentAttemptQuery.types';

Expand All@@ -17,7 +18,7 @@ function usePaymentAttemptQuery(params: UsePaymentAttemptQueryParams): PaymentAt
 const organizationId = forType === 'organization' ? (organization?.id ?? null) : null;
 const userId = user?.id ?? null;

 const { queryKey } = usePaymentAttemptQueryCacheKeys({
 const { queryKey, stableKey, authenticated } = usePaymentAttemptQueryCacheKeys({
 paymentAttemptId,
 userId,
 orgId: organizationId,
Expand All@@ -28,6 +29,12 @@ function usePaymentAttemptQuery(params: UsePaymentAttemptQueryParams): PaymentAt

 const queryEnabled = Boolean(paymentAttemptId) && billingEnabled;

 useClearQueriesOnSignOut({
 isSignedOut: user === null, // works with the transitive state
 authenticated,
 stableKeys: stableKey,
 });

 const query = useClerkQuery({
 queryKey,
 queryFn: ({ queryKey }) => {
Expand Down

9 changes: 8 additions & 1 deletion
packages/shared/src/react/hooks/useStatementQuery.rq.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
import { useClerkQuery } from '../clerk-rq/useQuery';
import { useClerkInstanceContext, useOrganizationContext, useUserContext } from '../contexts';
import { useBillingHookEnabled } from './useBillingHookEnabled';
import { useClearQueriesOnSignOut } from './useClearQueriesOnSignOut';
import { useStatementQueryCacheKeys } from './useStatementQuery.shared';
import type { StatementQueryResult, UseStatementQueryParams } from './useStatementQuery.types';

Expand All@@ -17,7 +18,7 @@ function useStatementQuery(params: UseStatementQueryParams = {}): StatementQuery
 const organizationId = forType === 'organization' ? (organization?.id ?? null) : null;
 const userId = user?.id ?? null;

 const { queryKey } = useStatementQueryCacheKeys({
 const { queryKey, stableKey, authenticated } = useStatementQueryCacheKeys({
 statementId,
 userId,
 orgId: organizationId,
Expand All@@ -28,6 +29,12 @@ function useStatementQuery(params: UseStatementQueryParams = {}): StatementQuery

 const queryEnabled = Boolean(statementId) && billingEnabled;

 useClearQueriesOnSignOut({
 isSignedOut: user === null,
 authenticated,
 stableKeys: stableKey,
 });

 const query = useClerkQuery({
 queryKey,
 queryFn: () => {
Expand Down

8 changes: 7 additions & 1 deletion
packages/shared/src/react/hooks/useSubscription.rq.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ import {
 useUserContext,
} from '../contexts';
import { useBillingHookEnabled } from './useBillingHookEnabled';
import { useClearQueriesOnSignOut } from './useClearQueriesOnSignOut';
import { useSubscriptionCacheKeys } from './useSubscription.shared';
import type { SubscriptionResult, UseSubscriptionParams } from './useSubscription.types';

Expand All@@ -37,13 +38,18 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes

 const [queryClient] = useClerkQueryClient();

 const { queryKey, invalidationKey } = useSubscriptionCacheKeys({
 const { queryKey, invalidationKey, stableKey, authenticated } = useSubscriptionCacheKeys({
 userId: user?.id,
 orgId: organization?.id,
 for: params?.for,
 });

 const queriesEnabled = Boolean(user?.id && billingEnabled);
 useClearQueriesOnSignOut({
 isSignedOut: user === null,
 authenticated,
 stableKeys: stableKey,
 });

 const query = useClerkQuery({
 queryKey,
Expand Down

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

Skip to content
chore(shared): Refactor clearing cache in RQ hooks#7330

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 1 commit into

from

Nov 28, 2025
 Merged


chore(shared): Refactor clearing cache in RQ hooks
#7330
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/smooth-lamps-raise.md

View file


Open in desktop

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

Refactor clearing cache in RQ hooks when a use signs out.
@coderabbitaicoderabbitaiBotNov 28, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor
Fix typo: "use" should be "user".
The changeset description has a typo that will appear in the published changelog.
-Refactor clearing cache in RQ hooks when a use signs out.+Refactor clearing cache in RQ hooks when a user signs out.
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

Refactor clearing cache in RQ hooks when a use signs out.
Refactor clearing cache in RQ hooks when a user signs out.
🧰 Tools
🪛 LanguageTool
[grammar] ~5-~5: Ensure spelling is correct

Context: ...actor clearing cache in RQ hooks when a use signs out.
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
In .changeset/smooth-lamps-raise.md around line 5, the changeset description
contains a typo: "use" should be "user"; edit that line to replace "use" with
"user" so the published changelog reads "Refactor clearing cache in RQ hooks
when a user signs out." Ensure spelling is corrected and commit the updated
changeset.


2 changes: 1 addition & 1 deletion
packages/shared/src/react/hooks/createBillingPaginatedHook.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -129,7 +129,7 @@ export function createBillingPaginatedHook<TResource extends ClerkResource, TPar
 keepPreviousData: safeValues.keepPreviousData,
 infinite: safeValues.infinite,
 enabled: isEnabled,
 ...(options?.unauthenticated ? {} : { isSignedIn: Boolean(user) }),
 ...(options?.unauthenticated ? {} : { isSignedIn: user !== null }),
 __experimental_mode: safeValues.__experimental_mode,
 initialPage: safeValues.initialPage,
 pageSize: safeValues.pageSize,
Expand Down

64 changes: 64 additions & 0 deletions
packages/shared/src/react/hooks/useClearQueriesOnSignOut.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
import { useEffect, useRef } from 'react';

import { useClerkQueryClient } from '../clerk-rq/use-clerk-query-client';
import { usePreviousValue } from './usePreviousValue';

export const withInfiniteKey = <T extends string>(key: T) => [key, `${key}-inf`] as const;

type ClearQueriesOnSignOutOptions = {
 isSignedOut: boolean;
 stableKeys: string | readonly string[];
 /**
 * Whether the queries for this hook are keyed as authenticated.
 * If this is not `true`, the effect becomes a no-op.
 */
 authenticated?: boolean;
 /**
 * Optional callback that will run after queries are cleared on sign-out.
 */
 onCleanup?: () => void;
};

/**
 * Clears React Query caches associated with the given stable prefixes when
 * the authenticated state transitions from signed-in to signed-out.
 *
 * @internal
 */
export function useClearQueriesOnSignOut(options: ClearQueriesOnSignOutOptions) {
 const { isSignedOut, stableKeys, authenticated = true, onCleanup } = options;
 const stableKeysRef = useRef(stableKeys);
Comment thread
panteliselef marked this conversation as resolved.


 const [queryClient] = useClerkQueryClient();
 const previousIsSignedIn = usePreviousValue(!isSignedOut);

 // If this hook's cache keys are not authenticated, skip all cleanup logic.

 if (authenticated !== true) {
 return;
 }

 // Calling this effect conditionally because we make sure that `authenticated` is always the same throughout the component lifecycle.
 // eslint-disable-next-line react-hooks/rules-of-hooks
 useEffect(() => {
Comment thread
panteliselef marked this conversation as resolved.

 const isNowSignedOut = isSignedOut === true;

 if (previousIsSignedIn && isNowSignedOut) {
 queryClient.removeQueries({
 predicate: query => {
 const [cachedStableKey, queryAuthenticated] = query.queryKey;

 return (
 queryAuthenticated === true &&
 typeof cachedStableKey === 'string' &&
 (Array.isArray(stableKeysRef.current)
 ? stableKeysRef.current.includes(cachedStableKey)
 : stableKeysRef.current === cachedStableKey)
 );
 },
 });

 onCleanup?.();
 }
 }, [isSignedOut, previousIsSignedIn, queryClient]);
}

32 changes: 9 additions & 23 deletions
packages/shared/src/react/hooks/usePagesOrInfinite.rq.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
import { useCallback, useMemo, useRef, useState } from 'react';

import type { ClerkPaginatedResponse } from '../../types';
import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
import { useClerkQueryClient } from '../clerk-rq/use-clerk-query-client';
import { useClerkInfiniteQuery } from '../clerk-rq/useInfiniteQuery';
import { useClerkQuery } from '../clerk-rq/useQuery';
import type { CacheSetter, ValueOrSetter } from '../types';
import { useClearQueriesOnSignOut, withInfiniteKey } from './useClearQueriesOnSignOut';
import type { UsePagesOrInfiniteSignature } from './usePageOrInfinite.types';
import { useWithSafeValues } from './usePagesOrInfinite.shared';
import { usePreviousValue } from './usePreviousValue';

export const usePagesOrInfinite: UsePagesOrInfiniteSignature = params => {
 const { fetcher, config, keys } = params;
Expand DownExpand Up@@ -98,32 +98,18 @@ export const usePagesOrInfinite: UsePagesOrInfiniteSignature = params => {
 enabled: queriesEnabled && triggerInfinite,
 });

 // Track previous isSignedIn state to detect sign-out transitions
 const previousIsSignedIn = usePreviousValue(isSignedIn);

 // Detect sign-out and clear queries
 useEffect(() => {
 const isNowSignedOut = isSignedIn === false;

 if (previousIsSignedIn && isNowSignedOut) {
 queryClient.removeQueries({
 predicate: query => {
 const [stablePrefix, authenticated] = query.queryKey;
 return (
 authenticated === true &&
 typeof stablePrefix === 'string' &&
 (stablePrefix === keys.queryKey[0] || stablePrefix === keys.queryKey[0] + '-inf')
 );
 },
 });

 useClearQueriesOnSignOut({
 isSignedOut: isSignedIn === false,
 authenticated: keys.authenticated,
 stableKeys: withInfiniteKey(keys.stableKey),
 onCleanup: () => {
 // Reset paginated page to initial
 setPaginatedPage(initialPageRef.current);

 // Force re-render to reflect cache changes
 void Promise.resolve().then(() => forceUpdate(n => n + 1));
 }
 }, [isSignedIn, queryClient, previousIsSignedIn, forceUpdate]);
 },
 });

 // Compute data, count and page from the same data source to ensure consistency
 const computedValues = useMemo(() => {
Expand Down

9 changes: 8 additions & 1 deletion
packages/shared/src/react/hooks/usePaymentAttemptQuery.rq.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
import { useClerkQuery } from '../clerk-rq/useQuery';
import { useClerkInstanceContext, useOrganizationContext, useUserContext } from '../contexts';
import { useBillingHookEnabled } from './useBillingHookEnabled';
import { useClearQueriesOnSignOut } from './useClearQueriesOnSignOut';
import { usePaymentAttemptQueryCacheKeys } from './usePaymentAttemptQuery.shared';
import type { PaymentAttemptQueryResult, UsePaymentAttemptQueryParams } from './usePaymentAttemptQuery.types';

Expand All@@ -17,7 +18,7 @@ function usePaymentAttemptQuery(params: UsePaymentAttemptQueryParams): PaymentAt
 const organizationId = forType === 'organization' ? (organization?.id ?? null) : null;
 const userId = user?.id ?? null;

 const { queryKey } = usePaymentAttemptQueryCacheKeys({
 const { queryKey, stableKey, authenticated } = usePaymentAttemptQueryCacheKeys({
 paymentAttemptId,
 userId,
 orgId: organizationId,
Expand All@@ -28,6 +29,12 @@ function usePaymentAttemptQuery(params: UsePaymentAttemptQueryParams): PaymentAt

 const queryEnabled = Boolean(paymentAttemptId) && billingEnabled;

 useClearQueriesOnSignOut({
 isSignedOut: user === null, // works with the transitive state
 authenticated,
 stableKeys: stableKey,
 });

 const query = useClerkQuery({
 queryKey,
 queryFn: ({ queryKey }) => {
Expand Down

9 changes: 8 additions & 1 deletion
packages/shared/src/react/hooks/useStatementQuery.rq.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
import { useClerkQuery } from '../clerk-rq/useQuery';
import { useClerkInstanceContext, useOrganizationContext, useUserContext } from '../contexts';
import { useBillingHookEnabled } from './useBillingHookEnabled';
import { useClearQueriesOnSignOut } from './useClearQueriesOnSignOut';
import { useStatementQueryCacheKeys } from './useStatementQuery.shared';
import type { StatementQueryResult, UseStatementQueryParams } from './useStatementQuery.types';

Expand All@@ -17,7 +18,7 @@ function useStatementQuery(params: UseStatementQueryParams = {}): StatementQuery
 const organizationId = forType === 'organization' ? (organization?.id ?? null) : null;
 const userId = user?.id ?? null;

 const { queryKey } = useStatementQueryCacheKeys({
 const { queryKey, stableKey, authenticated } = useStatementQueryCacheKeys({
 statementId,
 userId,
 orgId: organizationId,
Expand All@@ -28,6 +29,12 @@ function useStatementQuery(params: UseStatementQueryParams = {}): StatementQuery

 const queryEnabled = Boolean(statementId) && billingEnabled;

 useClearQueriesOnSignOut({
 isSignedOut: user === null,
 authenticated,
 stableKeys: stableKey,
 });

 const query = useClerkQuery({
 queryKey,
 queryFn: () => {
Expand Down

8 changes: 7 additions & 1 deletion
packages/shared/src/react/hooks/useSubscription.rq.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ import {
 useUserContext,
} from '../contexts';
import { useBillingHookEnabled } from './useBillingHookEnabled';
import { useClearQueriesOnSignOut } from './useClearQueriesOnSignOut';
import { useSubscriptionCacheKeys } from './useSubscription.shared';
import type { SubscriptionResult, UseSubscriptionParams } from './useSubscription.types';

Expand All@@ -37,13 +38,18 @@ export function useSubscription(params?: UseSubscriptionParams): SubscriptionRes

 const [queryClient] = useClerkQueryClient();

 const { queryKey, invalidationKey } = useSubscriptionCacheKeys({
 const { queryKey, invalidationKey, stableKey, authenticated } = useSubscriptionCacheKeys({
 userId: user?.id,
 orgId: organization?.id,
 for: params?.for,
 });

 const queriesEnabled = Boolean(user?.id && billingEnabled);
 useClearQueriesOnSignOut({
 isSignedOut: user === null,
 authenticated,
 stableKeys: stableKey,
 });

 const query = useClerkQuery({
 queryKey,
Expand Down