fix: Ensure query key is prefix by session scope

Author: razor-x

src/lib/seam/SeamQueryProvider.tsx

@@ -21,6 +21,7 @@ export interface SeamQueryContext {
   publishableKey?: string | undefined
   userIdentifierKey?: string | undefined
   clientSessionToken?: string | undefined
+  queryKeyPrefix?: string | undefined
 }
 
 export type SeamQueryProviderProps =
@@ -31,6 +32,7 @@ export type SeamQueryProviderProps =
 export interface SeamQueryProviderPropsWithClient
   extends SeamQueryProviderBaseProps {
   client: SeamHttp
+  queryKeyPrefix: string
 }
 
 export interface SeamQueryProviderPropsWithPublishableKey
@@ -126,6 +128,11 @@ const createSeamQueryContextValue = (
   options: SeamQueryProviderProps
 ): SeamQueryContext => {
   if (isSeamQueryProviderPropsWithClient(options)) {
+    if (options.queryKeyPrefix == null) {
+      throw new InvalidSeamQueryProviderProps(
+        'The client prop must be used with a queryKeyPrefix prop.'
+      )
+    }
     return {
       ...options,
       endpointClient: null,

src/lib/seam/use-seam-client.ts

@@ -8,6 +8,7 @@ import { useSeamQueryContext } from './SeamQueryProvider.js'
 export function useSeamClient(): {
   client: SeamHttp | null
   endpointClient: SeamHttpEndpoints | null
+  queryKeyPrefix: string[]
   isPending: boolean
   isError: boolean
   error: unknown
@@ -17,6 +18,7 @@ export function useSeamClient(): {
     clientOptions,
     publishableKey,
     clientSessionToken,
+    queryKeyPrefix,
     ...context
   } = useSeamQueryContext()
   const userIdentifierKey = useUserIdentifierKeyOrFingerprint(
@@ -27,6 +29,7 @@ export function useSeamClient(): {
     [SeamHttp, SeamHttpEndpoints]
   >({
     queryKey: [
+      'seam',
       'client',
       {
         client,
@@ -73,6 +76,15 @@ export function useSeamClient(): {
   return {
     client: data?.[0] ?? null,
     endpointClient: data?.[1] ?? null,
+    queryKeyPrefix: [
+      'seam',
+      queryKeyPrefix ??
+        getQueryKeyPrefix({
+          userIdentifierKey,
+          publishableKey,
+          clientSessionToken,
+        }),
+    ],
     isPending,
     isError,
     error,
@@ -117,3 +129,23 @@ This is not recommended because the client session is now bound to this machine
 
   return fingerprint
 }
+
+const getQueryKeyPrefix = ({
+  userIdentifierKey,
+  publishableKey,
+  clientSessionToken,
+}: {
+  userIdentifierKey: string
+  publishableKey: string | undefined
+  clientSessionToken: string | undefined
+}): string => {
+  if (clientSessionToken != null) {
+    return clientSessionToken
+  }
+
+  if (publishableKey != null) {
+    return [publishableKey, userIdentifierKey].join(':')
+  }
+
+  throw new Error('Could not determine a queryKeyPrefix')
+}

src/lib/seam/use-seam-query.ts

@@ -23,11 +23,15 @@ export function useSeamQuery<T extends SeamHttpEndpointQueryPaths>(
   options: Parameters<SeamHttpEndpoints[T]>[1] &
     QueryOptions<QueryData<T>, SeamHttpApiError> = {}
 ): UseSeamQueryResult<T> {
-  const { endpointClient: client } = useSeamClient()
+  const { endpointClient: client, queryKeyPrefix } = useSeamClient()
   return useQuery({
     enabled: client != null,
     ...options,
-    queryKey: [endpointPath, parameters],
+    queryKey: [
+      ...queryKeyPrefix,
+      ...endpointPath.split('/').filter((v) => v !== ''),
+      parameters,
+    ],
     queryFn: async () => {
       if (client == null) return null
       // Using @ts-expect-error over any is preferred, but not possible here because TypeScript will run out of memory.