Merge into single restoreQueries function

Author: rklomp

docs/framework/react/plugins/createPersister.md

@@ -111,18 +111,17 @@ This function can be used to sporadically clean up stoage from `expired`, `buste
 For this function to work, your storage must expose `entries` method that would return a `key-value tuple array`.  
 For example `Object.entries(localStorage)` for `localStorage` or `entries` from `idb-keyval`.
 
-### `persisterRestoreAll(queryClient: QueryClient): Promise<void>`
+### `restoreQueries(queryClient: QueryClient, filters): Promise<void>`
 
-This function can be used to restore all queries that are currently stored by persister in one go.  
-For example when your app is starting up in offline mode, or you want all data from previous session to be immediately available without intermediate `loading` state.
+This function can be used to restore queries that are currently stored by persister.  
+For example when your app is starting up in offline mode, or you want all or only specific data from previous session to be immediately available without intermediate `loading` state.
 
-For this function to work, your storage must expose `entries` method that would return a `key-value tuple array`.  
-For example `Object.entries(localStorage)` for `localStorage` or `entries` from `idb-keyval`.
-
-### `persisterRestoreByKey(queryClient: QueryClient, queryKey: QueryKey, exact: boolean = false): Promise<void>`
+The filter object supports the following properties:
 
-This function can be used to restore a specific query or multiple queries that partial match the provided queryKey.  
-For example when your app is starting up in offline mode, or you want only specific data from previous session to be immediately available without intermediate `loading` state.
+- `queryKey?: QueryKey`
+  - Set this property to define a query key to match on.
+- `exact?: boolean`
+  - If you don't want to search queries inclusively by query key, you can pass the `exact: true` option to return only the query with the exact query key you have passed.
 
 For this function to work, your storage must expose `entries` method that would return a `key-value tuple array`.  
 For example `Object.entries(localStorage)` for `localStorage` or `entries` from `idb-keyval`.

packages/query-persist-client-core/src/__tests__/createPersister.test.ts

@@ -497,7 +497,7 @@ describe('createPersister', () => {
     })
   })
 
-  describe('persisterRestoreAll', () => {
+  describe('restoreQueries', () => {
     test('should properly clean storage from busted entries', async () => {
       const storage = getFreshStorage()
       const { persister, client, query, queryKey } = setupPersister(['foo'], {
@@ -513,11 +513,11 @@ describe('createPersister', () => {
 
       expect(await storage.entries()).toHaveLength(1)
 
-      await persister.persisterRestoreAll(client)
+      await persister.restoreQueries(client)
       expect(await storage.entries()).toHaveLength(0)
     })
 
-    test('should properly restore queries from cache', async () => {
+    test('should properly restore queries from cache without filters', async () => {
       const storage = getFreshStorage()
       const { persister, client, queryKey } = setupPersister(['foo'], {
         storage,
@@ -530,14 +530,12 @@ describe('createPersister', () => {
       client.clear()
       expect(client.getQueryCache().getAll()).toHaveLength(0)
 
-      await persister.persisterRestoreAll(client)
+      await persister.restoreQueries(client)
       expect(client.getQueryCache().getAll()).toHaveLength(1)
 
       expect(client.getQueryData(queryKey)).toEqual('foo')
     })
-  })
 
-  describe('persisterRestoreByKey', () => {
     test('should properly restore queries from cache', async () => {
       const storage = getFreshStorage()
       const { persister, client, queryKey } = setupPersister(['foo', 'bar'], {
@@ -551,7 +549,7 @@ describe('createPersister', () => {
       client.clear()
       expect(client.getQueryCache().getAll()).toHaveLength(0)
 
-      await persister.persisterRestoreByKey(client, queryKey)
+      await persister.restoreQueries(client, { queryKey })
       expect(client.getQueryCache().getAll()).toHaveLength(1)
 
       expect(client.getQueryData(queryKey)).toEqual('foo')
@@ -570,7 +568,7 @@ describe('createPersister', () => {
       client.clear()
       expect(client.getQueryCache().getAll()).toHaveLength(0)
 
-      await persister.persisterRestoreByKey(client, ['bar'])
+      await persister.restoreQueries(client, { queryKey: ['bar'] })
       expect(client.getQueryCache().getAll()).toHaveLength(0)
     })
 
@@ -587,7 +585,7 @@ describe('createPersister', () => {
       client.clear()
       expect(client.getQueryCache().getAll()).toHaveLength(0)
 
-      await persister.persisterRestoreByKey(client, ['foo'])
+      await persister.restoreQueries(client, { queryKey: ['foo'] })
       expect(client.getQueryCache().getAll()).toHaveLength(1)
 
       expect(client.getQueryData(queryKey)).toEqual('foo')
@@ -606,7 +604,7 @@ describe('createPersister', () => {
       client.clear()
       expect(client.getQueryCache().getAll()).toHaveLength(0)
 
-      await persister.persisterRestoreByKey(client, ['foo'], true)
+      await persister.restoreQueries(client, { queryKey: ['foo'], exact: true })
       expect(client.getQueryCache().getAll()).toHaveLength(0)
     })
 
@@ -623,7 +621,10 @@ describe('createPersister', () => {
       client.clear()
       expect(client.getQueryCache().getAll()).toHaveLength(0)
 
-      await persister.persisterRestoreByKey(client, queryKey, true)
+      await persister.restoreQueries(client, {
+        queryKey: queryKey,
+        exact: true,
+      })
       expect(client.getQueryCache().getAll()).toHaveLength(1)
     })
   })

packages/query-persist-client-core/src/createPersister.ts

@@ -240,15 +240,12 @@ export function experimental_createQueryPersister<TStorageValue = string>({
     }
   }
 
-  async function persisterRestoreAll(queryClient: QueryClient) {
-    return persisterRestoreByKey(queryClient, [])
-  }
-
-  async function persisterRestoreByKey(
+  async function restoreQueries(
     queryClient: QueryClient,
-    queryKey: QueryKey,
-    exact: boolean = false,
+    filters: Pick<QueryFilters, 'queryKey' | 'exact'> = {},
   ): Promise<void> {
+    const { exact, queryKey } = filters
+
     if (storage?.entries) {
       const entries = await storage.entries()
       for (const [key, value] of entries) {
@@ -260,12 +257,14 @@ export function experimental_createQueryPersister<TStorageValue = string>({
             continue
           }
 
-          if (exact) {
-            if (persistedQuery.queryHash !== hashKey(queryKey)) {
+          if (queryKey) {
+            if (exact) {
+              if (persistedQuery.queryHash !== hashKey(queryKey)) {
+                continue
+              }
+            } else if (!partialMatchKey(persistedQuery.queryKey, queryKey)) {
               continue
             }
-          } else if (!partialMatchKey(persistedQuery.queryKey, queryKey)) {
-            continue
           }
 
           queryClient.setQueryData(
@@ -290,7 +289,6 @@ export function experimental_createQueryPersister<TStorageValue = string>({
     persistQueryByKey,
     retrieveQuery,
     persisterGc,
-    persisterRestoreAll,
-    persisterRestoreByKey,
+    restoreQueries,
   }
 }