@tanstack/query-persist-client-core 5.59.17 → 5.59.20

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/query-persist-client-core",
-  "version": "5.59.17",
+  "version": "5.59.20",
   "description": "Set of utilities for interacting with persisters, which can save your queryClient for later use",
   "author": "tannerlinsley",
   "license": "MIT",
@@ -34,10 +34,11 @@
   "sideEffects": false,
   "files": [
     "build",
-    "src"
+    "src",
+    "!src/__tests__"
   ],
   "dependencies": {
-    "@tanstack/query-core": "5.59.17"
+    "@tanstack/query-core": "5.59.20"
   },
   "scripts": {}
 }

package/src/__tests__/createPersister.test.ts

@@ -1,375 +0,0 @@
-import { describe, expect, test, vi } from 'vitest'
-import { Query, QueryCache, hashKey } from '@tanstack/query-core'
-import {
-  PERSISTER_KEY_PREFIX,
-  experimental_createPersister,
-} from '../createPersister'
-import { sleep } from './utils'
-import type { StoragePersisterOptions } from '../createPersister'
-import type { QueryKey } from '@tanstack/query-core'
-
-function getFreshStorage() {
-  const storage = new Map()
-  return {
-    getItem: (key: string) => Promise.resolve(storage.get(key)),
-    setItem: async (key: string, value: unknown) => {
-      storage.set(key, value)
-    },
-    removeItem: async (key: string) => {
-      storage.delete(key)
-    },
-  }
-}
-
-function setupPersister(
-  queryKey: QueryKey,
-  persisterOptions: StoragePersisterOptions,
-) {
-  const context = {
-    meta: { foo: 'bar' },
-    queryKey,
-    // @ts-expect-error
-    signal: undefined as AbortSignal,
-  }
-  const queryHash = hashKey(queryKey)
-  const storageKey = `${PERSISTER_KEY_PREFIX}-${queryHash}`
-
-  const queryFn = vi.fn()
-
-  const persisterFn = experimental_createPersister(persisterOptions)
-
-  const query = new Query({
-    cache: new QueryCache(),
-    queryHash,
-    queryKey,
-  })
-
-  return {
-    context,
-    persisterFn,
-    query,
-    queryFn,
-    queryHash,
-    queryKey,
-    storageKey,
-  }
-}
-
-describe('createPersister', () => {
-  test('should fetch if storage is not provided', async () => {
-    const { context, persisterFn, query, queryFn } = setupPersister(['foo'], {
-      storage: undefined,
-    })
-
-    await persisterFn(queryFn, context, query)
-
-    expect(queryFn).toHaveBeenCalledOnce()
-    expect(queryFn).toHaveBeenCalledWith(context)
-  })
-
-  test('should fetch if there is no stored data', async () => {
-    const storage = getFreshStorage()
-    const { context, persisterFn, query, queryFn } = setupPersister(['foo'], {
-      storage,
-    })
-
-    await persisterFn(queryFn, context, query)
-
-    expect(queryFn).toHaveBeenCalledOnce()
-    expect(queryFn).toHaveBeenCalledWith(context)
-  })
-
-  test('should fetch if query already has data', async () => {
-    const storage = getFreshStorage()
-    const { context, persisterFn, query, queryFn } = setupPersister(['foo'], {
-      storage,
-    })
-    query.state.data = 'baz'
-
-    await persisterFn(queryFn, context, query)
-
-    expect(queryFn).toHaveBeenCalledOnce()
-    expect(queryFn).toHaveBeenCalledWith(context)
-  })
-
-  test('should fetch if deserialization fails', async () => {
-    const storage = getFreshStorage()
-    const { context, persisterFn, query, queryFn, storageKey } = setupPersister(
-      ['foo'],
-      {
-        storage,
-      },
-    )
-
-    await storage.setItem(storageKey, '{invalid[item')
-
-    await persisterFn(queryFn, context, query)
-
-    expect(await storage.getItem(storageKey)).toBeUndefined()
-
-    expect(queryFn).toHaveBeenCalledOnce()
-    expect(queryFn).toHaveBeenCalledWith(context)
-  })
-
-  test('should remove stored item if `dataUpdatedAt` is empty', async () => {
-    const storage = getFreshStorage()
-    const { context, persisterFn, query, queryFn, storageKey } = setupPersister(
-      ['foo'],
-      {
-        storage,
-      },
-    )
-
-    await storage.setItem(
-      storageKey,
-      JSON.stringify({
-        buster: '',
-        state: { dataUpdatedAt: undefined },
-      }),
-    )
-
-    await persisterFn(queryFn, context, query)
-
-    expect(await storage.getItem(storageKey)).toBeUndefined()
-
-    expect(queryFn).toHaveBeenCalledOnce()
-    expect(queryFn).toHaveBeenCalledWith(context)
-  })
-
-  test('should remove stored item if its expired', async () => {
-    const storage = getFreshStorage()
-    const { context, persisterFn, query, queryFn, storageKey } = setupPersister(
-      ['foo'],
-      {
-        storage,
-        maxAge: 100,
-      },
-    )
-
-    await storage.setItem(
-      storageKey,
-      JSON.stringify({
-        buster: '',
-        state: { dataUpdatedAt: Date.now() - 200 },
-      }),
-    )
-
-    await persisterFn(queryFn, context, query)
-
-    expect(await storage.getItem(storageKey)).toBeUndefined()
-
-    expect(queryFn).toHaveBeenCalledOnce()
-    expect(queryFn).toHaveBeenCalledWith(context)
-  })
-
-  test('should remove stored item if its busted', async () => {
-    const storage = getFreshStorage()
-    const { context, persisterFn, query, queryFn, storageKey } = setupPersister(
-      ['foo'],
-      {
-        storage,
-      },
-    )
-
-    await storage.setItem(
-      storageKey,
-      JSON.stringify({
-        buster: 'bust',
-        state: { dataUpdatedAt: Date.now() },
-      }),
-    )
-
-    await persisterFn(queryFn, context, query)
-
-    expect(await storage.getItem(storageKey)).toBeUndefined()
-
-    expect(queryFn).toHaveBeenCalledOnce()
-    expect(queryFn).toHaveBeenCalledWith(context)
-  })
-
-  test('should restore item from the storage and set proper `updatedAt` values', async () => {
-    const storage = getFreshStorage()
-    const { context, persisterFn, query, queryFn, storageKey } = setupPersister(
-      ['foo'],
-      {
-        storage,
-      },
-    )
-
-    const dataUpdatedAt = Date.now()
-
-    await storage.setItem(
-      storageKey,
-      JSON.stringify({
-        buster: '',
-        state: { dataUpdatedAt },
-      }),
-    )
-
-    await persisterFn(queryFn, context, query)
-    query.state.data = 'data0'
-    query.fetch = vi.fn()
-    expect(query.state.dataUpdatedAt).toEqual(0)
-
-    await sleep(0)
-
-    expect(queryFn).toHaveBeenCalledTimes(0)
-    expect(query.fetch).toHaveBeenCalledTimes(0)
-    expect(query.state.dataUpdatedAt).toEqual(dataUpdatedAt)
-  })
-
-  test('should restore item from the storage and refetch when `stale`', async () => {
-    const storage = getFreshStorage()
-    const { context, persisterFn, query, queryFn, storageKey } = setupPersister(
-      ['foo'],
-      {
-        storage,
-      },
-    )
-
-    await storage.setItem(
-      storageKey,
-      JSON.stringify({
-        buster: '',
-        state: { dataUpdatedAt: Date.now() },
-      }),
-    )
-
-    await persisterFn(queryFn, context, query)
-    query.state.isInvalidated = true
-    query.fetch = vi.fn()
-
-    await sleep(0)
-
-    expect(queryFn).toHaveBeenCalledTimes(0)
-    expect(query.fetch).toHaveBeenCalledTimes(1)
-  })
-
-  test('should store item after successful fetch', async () => {
-    const storage = getFreshStorage()
-    const {
-      context,
-      persisterFn,
-      query,
-      queryFn,
-      queryHash,
-      queryKey,
-      storageKey,
-    } = setupPersister(['foo'], {
-      storage,
-    })
-
-    await persisterFn(queryFn, context, query)
-    query.setData('baz')
-
-    await sleep(0)
-
-    expect(queryFn).toHaveBeenCalledOnce()
-    expect(queryFn).toHaveBeenCalledWith(context)
-
-    expect(JSON.parse(await storage.getItem(storageKey))).toMatchObject({
-      buster: '',
-      queryHash,
-      queryKey,
-      state: {
-        data: 'baz',
-      },
-    })
-  })
-
-  test('should skip stored item if not matched by filters', async () => {
-    const storage = getFreshStorage()
-    const { context, persisterFn, query, queryFn, storageKey } = setupPersister(
-      ['foo'],
-      {
-        storage,
-        filters: {
-          predicate: () => {
-            return false
-          },
-        },
-      },
-    )
-
-    const dataUpdatedAt = Date.now()
-
-    await storage.setItem(
-      storageKey,
-      JSON.stringify({
-        buster: '',
-        state: { dataUpdatedAt },
-      }),
-    )
-
-    await persisterFn(queryFn, context, query)
-    query.fetch = vi.fn()
-
-    await sleep(0)
-
-    expect(queryFn).toHaveBeenCalledTimes(1)
-    expect(query.fetch).toHaveBeenCalledTimes(0)
-  })
-
-  test('should restore item from the storage with async deserializer', async () => {
-    const storage = getFreshStorage()
-    const { context, persisterFn, query, queryFn, storageKey } = setupPersister(
-      ['foo'],
-      {
-        storage,
-        deserialize: (cachedString: string) =>
-          new Promise((resolve) => resolve(JSON.parse(cachedString))),
-      },
-    )
-
-    await storage.setItem(
-      storageKey,
-      JSON.stringify({
-        buster: '',
-        state: { dataUpdatedAt: Date.now() },
-      }),
-    )
-
-    await persisterFn(queryFn, context, query)
-    query.state.isInvalidated = true
-    query.fetch = vi.fn()
-
-    await sleep(0)
-
-    expect(queryFn).toHaveBeenCalledTimes(0)
-    expect(query.fetch).toHaveBeenCalledTimes(1)
-  })
-
-  test('should store item after successful fetch with async serializer', async () => {
-    const storage = getFreshStorage()
-    const {
-      context,
-      persisterFn,
-      query,
-      queryFn,
-      queryHash,
-      queryKey,
-      storageKey,
-    } = setupPersister(['foo'], {
-      storage,
-      serialize: (persistedQuery) =>
-        new Promise((resolve) => resolve(JSON.stringify(persistedQuery))),
-    })
-
-    await persisterFn(queryFn, context, query)
-    query.setData('baz')
-
-    await sleep(0)
-
-    expect(queryFn).toHaveBeenCalledOnce()
-    expect(queryFn).toHaveBeenCalledWith(context)
-
-    expect(JSON.parse(await storage.getItem(storageKey))).toMatchObject({
-      buster: '',
-      queryHash,
-      queryKey,
-      state: {
-        data: 'baz',
-      },
-    })
-  })
-})

package/src/__tests__/persist.test.ts

@@ -1,65 +0,0 @@
-import { describe, expect, test, vi } from 'vitest'
-import { QueriesObserver } from '@tanstack/query-core'
-import { persistQueryClientSubscribe } from '../persist'
-import {
-  createMockPersister,
-  createQueryClient,
-  createSpyPersister,
-} from './utils'
-
-describe('persistQueryClientSubscribe', () => {
-  test('should persist mutations', async () => {
-    const queryClient = createQueryClient()
-
-    const persister = createMockPersister()
-
-    const unsubscribe = persistQueryClientSubscribe({
-      queryClient,
-      persister,
-      dehydrateOptions: { shouldDehydrateMutation: () => true },
-    })
-
-    queryClient.getMutationCache().build(queryClient, {
-      mutationFn: async (text: string) => text,
-    })
-
-    const result = await persister.restoreClient()
-
-    expect(result?.clientState.mutations).toHaveLength(1)
-
-    unsubscribe()
-  })
-})
-
-describe('persistQueryClientSave', () => {
-  test('should not be triggered on observer type events', async () => {
-    const queryClient = createQueryClient()
-
-    const persister = createSpyPersister()
-
-    const unsubscribe = persistQueryClientSubscribe({
-      queryClient,
-      persister,
-    })
-
-    const queryKey = ['test']
-    const queryFn = vi.fn().mockReturnValue(1)
-    const observer = new QueriesObserver(queryClient, [{ queryKey, queryFn }])
-    const unsubscribeObserver = observer.subscribe(vi.fn())
-    observer
-      .getObservers()[0]
-      ?.setOptions({ queryKey, refetchOnWindowFocus: false })
-    unsubscribeObserver()
-
-    queryClient.setQueryData(queryKey, 2)
-
-    // persistClient should be called 3 times:
-    // 1. When query is added
-    // 2. When queryFn is resolved
-    // 3. When setQueryData is called
-    // All events fired by manipulating observers are ignored
-    expect(persister.persistClient).toHaveBeenCalledTimes(3)
-
-    unsubscribe()
-  })
-})

package/src/__tests__/utils.ts

@@ -1,39 +0,0 @@
-import { vi } from 'vitest'
-import { QueryClient } from '@tanstack/query-core'
-import type { QueryClientConfig } from '@tanstack/query-core'
-import type { PersistedClient, Persister } from '../persist'
-
-export function createQueryClient(config?: QueryClientConfig): QueryClient {
-  return new QueryClient(config)
-}
-
-export function sleep(timeout: number): Promise<void> {
-  return new Promise((resolve, _reject) => {
-    setTimeout(resolve, timeout)
-  })
-}
-
-export function createMockPersister(): Persister {
-  let storedState: PersistedClient | undefined
-
-  return {
-    async persistClient(persistClient: PersistedClient) {
-      storedState = persistClient
-    },
-    async restoreClient() {
-      await sleep(10)
-      return storedState
-    },
-    removeClient() {
-      storedState = undefined
-    },
-  }
-}
-
-export function createSpyPersister(): Persister {
-  return {
-    persistClient: vi.fn(),
-    restoreClient: vi.fn(),
-    removeClient: vi.fn(),
-  }
-}