|
1 | 1 | import { QueryClient } from '@tanstack/query-core'; |
2 | 2 | import { afterEach, describe, expect, it, vi } from 'vitest'; |
3 | 3 |
|
| 4 | +import type { Clerk, Resources } from '@/types'; |
| 5 | +import { createDeferredPromise } from '@/utils/createDeferredPromise'; |
| 6 | + |
4 | 7 | import { |
5 | 8 | __createClerkTestQueryClient, |
6 | 9 | __resetClerkQueryClientForTest, |
7 | 10 | __setClerkQueryClientForTest, |
8 | 11 | getClerkQueryClient, |
| 12 | + registerQueryCleanupOnSignOut, |
9 | 13 | } from '../clerk-query-client'; |
10 | 14 |
|
11 | 15 | afterEach(() => { |
@@ -82,3 +86,144 @@ describe('__createClerkTestQueryClient', () => { |
82 | 86 | expect(defaults?.refetchOnMount).toBe(false); |
83 | 87 | }); |
84 | 88 | }); |
| 89 | + |
| 90 | +function resources(user: Clerk['user']): Resources { |
| 91 | + return { |
| 92 | + user, |
| 93 | + get client(): Resources['client'] { |
| 94 | + throw new Error('Sign-out cleanup must not read the client resource'); |
| 95 | + }, |
| 96 | + }; |
| 97 | +} |
| 98 | + |
| 99 | +function createClerkListener(user: Clerk['user'] = undefined) { |
| 100 | + const listeners = new Set<Parameters<Clerk['addListener']>[0]>(); |
| 101 | + const unsubscribe = vi.fn(); |
| 102 | + const clerk = { |
| 103 | + user, |
| 104 | + addListener: vi.fn<Clerk['addListener']>(callback => { |
| 105 | + listeners.add(callback); |
| 106 | + callback(resources(clerk.user)); |
| 107 | + return () => { |
| 108 | + listeners.delete(callback); |
| 109 | + unsubscribe(); |
| 110 | + }; |
| 111 | + }), |
| 112 | + }; |
| 113 | + return { |
| 114 | + clerk, |
| 115 | + unsubscribe, |
| 116 | + emit(user: Clerk['user']) { |
| 117 | + clerk.user = user; |
| 118 | + listeners.forEach(callback => callback(resources(user))); |
| 119 | + }, |
| 120 | + }; |
| 121 | +} |
| 122 | + |
| 123 | +describe('registerQueryCleanupOnSignOut', () => { |
| 124 | + it('clears registered authenticated queries on null but ignores unresolved user state', () => { |
| 125 | + const client = __createClerkTestQueryClient(); |
| 126 | + const { clerk, emit } = createClerkListener(); |
| 127 | + client.setQueryData(['sessions', true], 'private'); |
| 128 | + client.setQueryData(['sessions', false], 'public'); |
| 129 | + client.setQueryData(['billing', true], 'unrelated'); |
| 130 | + |
| 131 | + registerQueryCleanupOnSignOut(clerk, 'sessions'); |
| 132 | + emit(undefined); |
| 133 | + expect(client.getQueryData(['sessions', true])).toBe('private'); |
| 134 | + |
| 135 | + emit(null); |
| 136 | + expect(client.getQueryState(['sessions', true])).toBeUndefined(); |
| 137 | + expect(client.getQueryData(['sessions', false])).toBe('public'); |
| 138 | + expect(client.getQueryData(['billing', true])).toBe('unrelated'); |
| 139 | + }); |
| 140 | + |
| 141 | + it('clears stale entries on initial null and when another prefix registers after sign-out', () => { |
| 142 | + const client = __createClerkTestQueryClient(); |
| 143 | + const { clerk } = createClerkListener(null); |
| 144 | + client.setQueryData(['sessions', true], 'private'); |
| 145 | + client.setQueryData(['other-sessions', true], 'private'); |
| 146 | + |
| 147 | + registerQueryCleanupOnSignOut(clerk, 'sessions'); |
| 148 | + expect(client.getQueryState(['sessions', true])).toBeUndefined(); |
| 149 | + |
| 150 | + registerQueryCleanupOnSignOut(clerk, 'other-sessions'); |
| 151 | + expect(client.getQueryState(['other-sessions', true])).toBeUndefined(); |
| 152 | + expect(clerk.addListener).toHaveBeenCalledTimes(1); |
| 153 | + }); |
| 154 | + |
| 155 | + it('registers one listener across repeated registrations and clears every registered prefix', () => { |
| 156 | + const client = __createClerkTestQueryClient(); |
| 157 | + const { clerk, emit } = createClerkListener(); |
| 158 | + registerQueryCleanupOnSignOut(clerk, 'sessions'); |
| 159 | + registerQueryCleanupOnSignOut(clerk, 'sessions'); |
| 160 | + registerQueryCleanupOnSignOut(clerk, 'other-sessions'); |
| 161 | + client.setQueryData(['sessions', true], 'private'); |
| 162 | + client.setQueryData(['other-sessions', true], 'private'); |
| 163 | + |
| 164 | + emit(null); |
| 165 | + |
| 166 | + expect(clerk.addListener).toHaveBeenCalledTimes(1); |
| 167 | + expect(client.getQueryCache().getAll()).toHaveLength(0); |
| 168 | + }); |
| 169 | + |
| 170 | + it('moves the subscription to a replacement Clerk while retaining registered prefixes', () => { |
| 171 | + const client = __createClerkTestQueryClient(); |
| 172 | + const old = createClerkListener(); |
| 173 | + const next = createClerkListener(); |
| 174 | + registerQueryCleanupOnSignOut(old.clerk, 'sessions'); |
| 175 | + registerQueryCleanupOnSignOut(next.clerk, 'other-sessions'); |
| 176 | + client.setQueryData(['sessions', true], 'private'); |
| 177 | + client.setQueryData(['other-sessions', true], 'private'); |
| 178 | + |
| 179 | + old.emit(null); |
| 180 | + expect(old.unsubscribe).toHaveBeenCalledTimes(1); |
| 181 | + expect(client.getQueryCache().getAll()).toHaveLength(2); |
| 182 | + |
| 183 | + next.emit(null); |
| 184 | + expect(client.getQueryCache().getAll()).toHaveLength(0); |
| 185 | + }); |
| 186 | + |
| 187 | + it.each(['reset', 'replace'] as const)('unsubscribes when the query client is %s', action => { |
| 188 | + const original = __createClerkTestQueryClient(); |
| 189 | + const { clerk, unsubscribe } = createClerkListener(); |
| 190 | + registerQueryCleanupOnSignOut(clerk, 'sessions'); |
| 191 | + const callback = clerk.addListener.mock.calls[0]?.[0]; |
| 192 | + if (action === 'reset') { |
| 193 | + __resetClerkQueryClientForTest(); |
| 194 | + } |
| 195 | + const next = __createClerkTestQueryClient(); |
| 196 | + next.setQueryData(['sessions', true], 'new session'); |
| 197 | + callback?.(resources(null)); |
| 198 | + |
| 199 | + expect(unsubscribe).toHaveBeenCalledTimes(1); |
| 200 | + expect(next.getQueryData(['sessions', true])).toBe('new session'); |
| 201 | + expect(next).not.toBe(original); |
| 202 | + }); |
| 203 | + |
| 204 | + it('does not subscribe without a real query client', () => { |
| 205 | + __setClerkQueryClientForTest(undefined); |
| 206 | + const { clerk } = createClerkListener(); |
| 207 | + |
| 208 | + registerQueryCleanupOnSignOut(clerk, 'sessions'); |
| 209 | + |
| 210 | + expect(clerk.addListener).not.toHaveBeenCalled(); |
| 211 | + }); |
| 212 | + |
| 213 | + it('does not restore a removed entry when an in-flight request resolves', async () => { |
| 214 | + const client = __createClerkTestQueryClient(); |
| 215 | + const { clerk, emit } = createClerkListener(); |
| 216 | + registerQueryCleanupOnSignOut(clerk, 'sessions'); |
| 217 | + const deferred = createDeferredPromise(); |
| 218 | + const pending = client.fetchQuery({ queryKey: ['sessions', true], queryFn: () => deferred.promise }); |
| 219 | + const settled = pending.catch(() => undefined); |
| 220 | + |
| 221 | + emit(null); |
| 222 | + expect(client.getQueryState(['sessions', true])).toBeUndefined(); |
| 223 | + deferred.resolve('stale sessions'); |
| 224 | + await settled; |
| 225 | + await deferred.promise; |
| 226 | + |
| 227 | + expect(client.getQueryState(['sessions', true])).toBeUndefined(); |
| 228 | + }); |
| 229 | +}); |
0 commit comments