import { asyncThrottle } from './asyncThrottle' import { noop } from './utils' import type { AsyncStorage, MaybePromise, PersistedClient, Persister, Promisable, } from '@tanstack/query-persist-client-core' export type AsyncPersistRetryer = (props: { persistedClient: PersistedClient error: Error errorCount: number }) => Promisable interface CreateAsyncStoragePersisterOptions { /** The storage client used for setting and retrieving items from cache. * For SSR pass in `undefined`. Note that window.localStorage can be * `null` in Android WebViews depending on how they are configured. */ storage: AsyncStorage | undefined | null /** The key to use when storing the cache */ key?: string /** To avoid spamming, * pass a time in ms to throttle saving the cache to disk */ throttleTime?: number /** * How to serialize the data to storage. * @default `JSON.stringify` */ serialize?: (client: PersistedClient) => MaybePromise /** * How to deserialize the data from storage. * @default `JSON.parse` */ deserialize?: (cachedString: string) => MaybePromise retry?: AsyncPersistRetryer } export const createAsyncStoragePersister = ({ storage, key = `REACT_QUERY_OFFLINE_CACHE`, throttleTime = 1000, serialize = JSON.stringify, deserialize = JSON.parse, retry, }: CreateAsyncStoragePersisterOptions): Persister => { if (storage) { const trySave = async ( persistedClient: PersistedClient, ): Promise => { try { const serialized = await serialize(persistedClient) await storage.setItem(key, serialized) return } catch (error) { return error as Error } } return { persistClient: asyncThrottle( async (persistedClient) => { let client: PersistedClient | undefined = persistedClient let error = await trySave(client) let errorCount = 0 while (error && client) { errorCount++ client = await retry?.({ persistedClient: client, error, errorCount, }) if (client) { error = await trySave(client) } } }, { interval: throttleTime }, ), restoreClient: async () => { const cacheString = await storage.getItem(key) if (!cacheString) { return } return await deserialize(cacheString) }, removeClient: () => storage.removeItem(key), } } return { persistClient: noop, restoreClient: () => Promise.resolve(undefined), removeClient: noop, } }