@tanstack/query-sync-storage-persister 4.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.js +92 -0
- package/build/cjs/index.js.map +1 -0
- package/build/esm/index.js +88 -0
- package/build/esm/index.js.map +1 -0
- package/build/stats-html.html +2689 -0
- package/build/umd/index.development.js +98 -0
- package/build/umd/index.development.js.map +1 -0
- package/build/umd/index.production.js +12 -0
- package/build/umd/index.production.js.map +1 -0
- package/package.json +25 -0
- package/src/__tests__/storageIsFull.test.ts +157 -0
- package/src/index.ts +111 -0
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* query-sync-storage-persister
|
|
3
|
+
*
|
|
4
|
+
* Copyright (c) TanStack
|
|
5
|
+
*
|
|
6
|
+
* This source code is licensed under the MIT license found in the
|
|
7
|
+
* LICENSE.md file in the root directory of this source tree.
|
|
8
|
+
*
|
|
9
|
+
* @license MIT
|
|
10
|
+
*/
|
|
11
|
+
(function (global, factory) {
|
|
12
|
+
typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
|
|
13
|
+
typeof define === 'function' && define.amd ? define(['exports'], factory) :
|
|
14
|
+
(global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.QuerySyncStoragePersister = {}));
|
|
15
|
+
})(this, (function (exports) { 'use strict';
|
|
16
|
+
|
|
17
|
+
function createSyncStoragePersister({
|
|
18
|
+
storage,
|
|
19
|
+
key = "REACT_QUERY_OFFLINE_CACHE",
|
|
20
|
+
throttleTime = 1000,
|
|
21
|
+
serialize = JSON.stringify,
|
|
22
|
+
deserialize = JSON.parse,
|
|
23
|
+
retry
|
|
24
|
+
}) {
|
|
25
|
+
if (typeof storage !== 'undefined') {
|
|
26
|
+
const trySave = persistedClient => {
|
|
27
|
+
try {
|
|
28
|
+
storage.setItem(key, serialize(persistedClient));
|
|
29
|
+
} catch (error) {
|
|
30
|
+
return error;
|
|
31
|
+
}
|
|
32
|
+
};
|
|
33
|
+
|
|
34
|
+
return {
|
|
35
|
+
persistClient: throttle(persistedClient => {
|
|
36
|
+
let client = persistedClient;
|
|
37
|
+
let error = trySave(client);
|
|
38
|
+
let errorCount = 0;
|
|
39
|
+
|
|
40
|
+
while (error && client) {
|
|
41
|
+
errorCount++;
|
|
42
|
+
client = retry == null ? void 0 : retry({
|
|
43
|
+
persistedClient: client,
|
|
44
|
+
error,
|
|
45
|
+
errorCount
|
|
46
|
+
});
|
|
47
|
+
|
|
48
|
+
if (client) {
|
|
49
|
+
error = trySave(client);
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
}, throttleTime),
|
|
53
|
+
restoreClient: () => {
|
|
54
|
+
const cacheString = storage.getItem(key);
|
|
55
|
+
|
|
56
|
+
if (!cacheString) {
|
|
57
|
+
return;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
return deserialize(cacheString);
|
|
61
|
+
},
|
|
62
|
+
removeClient: () => {
|
|
63
|
+
storage.removeItem(key);
|
|
64
|
+
}
|
|
65
|
+
};
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
return {
|
|
69
|
+
persistClient: noop,
|
|
70
|
+
restoreClient: () => undefined,
|
|
71
|
+
removeClient: noop
|
|
72
|
+
};
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
function throttle(func, wait = 100) {
|
|
76
|
+
let timer = null;
|
|
77
|
+
let params;
|
|
78
|
+
return function (...args) {
|
|
79
|
+
params = args;
|
|
80
|
+
|
|
81
|
+
if (timer === null) {
|
|
82
|
+
timer = setTimeout(() => {
|
|
83
|
+
func(...params);
|
|
84
|
+
timer = null;
|
|
85
|
+
}, wait);
|
|
86
|
+
}
|
|
87
|
+
};
|
|
88
|
+
} // eslint-disable-next-line @typescript-eslint/no-empty-function
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
function noop() {}
|
|
92
|
+
|
|
93
|
+
exports.createSyncStoragePersister = createSyncStoragePersister;
|
|
94
|
+
|
|
95
|
+
Object.defineProperty(exports, '__esModule', { value: true });
|
|
96
|
+
|
|
97
|
+
}));
|
|
98
|
+
//# sourceMappingURL=index.development.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.development.js","sources":["../../src/index.ts"],"sourcesContent":["import {\n PersistedClient,\n Persister,\n PersistRetryer,\n} from '@tanstack/react-query-persist-client'\n\ninterface Storage {\n getItem: (key: string) => string | null\n setItem: (key: string, value: string) => void\n removeItem: (key: string) => void\n}\n\ninterface CreateSyncStoragePersisterOptions {\n /** The storage client used for setting and retrieving items from cache.\n * For SSR pass in `undefined`.\n */\n storage: Storage | undefined\n /** The key to use when storing the cache */\n key?: string\n /** To avoid spamming,\n * pass a time in ms to throttle saving the cache to disk */\n throttleTime?: number\n /**\n * How to serialize the data to storage.\n * @default `JSON.stringify`\n */\n serialize?: (client: PersistedClient) => string\n /**\n * How to deserialize the data from storage.\n * @default `JSON.parse`\n */\n deserialize?: (cachedString: string) => PersistedClient\n\n retry?: PersistRetryer\n}\n\nexport function createSyncStoragePersister({\n storage,\n key = `REACT_QUERY_OFFLINE_CACHE`,\n throttleTime = 1000,\n serialize = JSON.stringify,\n deserialize = JSON.parse,\n retry,\n}: CreateSyncStoragePersisterOptions): Persister {\n if (typeof storage !== 'undefined') {\n const trySave = (persistedClient: PersistedClient): Error | undefined => {\n try {\n storage.setItem(key, serialize(persistedClient))\n } catch (error) {\n return error as Error\n }\n }\n return {\n persistClient: throttle((persistedClient) => {\n let client: PersistedClient | undefined = persistedClient\n let error = trySave(client)\n let errorCount = 0\n while (error && client) {\n errorCount++\n client = retry?.({\n persistedClient: client,\n error,\n errorCount,\n })\n\n if (client) {\n error = trySave(client)\n }\n }\n }, throttleTime),\n restoreClient: () => {\n const cacheString = storage.getItem(key)\n\n if (!cacheString) {\n return\n }\n\n return deserialize(cacheString) as PersistedClient\n },\n removeClient: () => {\n storage.removeItem(key)\n },\n }\n }\n\n return {\n persistClient: noop,\n restoreClient: () => undefined,\n removeClient: noop,\n }\n}\n\nfunction throttle<TArgs extends any[]>(\n func: (...args: TArgs) => any,\n wait = 100,\n) {\n let timer: ReturnType<typeof setTimeout> | null = null\n let params: TArgs\n return function (...args: TArgs) {\n params = args\n if (timer === null) {\n timer = setTimeout(() => {\n func(...params)\n timer = null\n }, wait)\n }\n }\n}\n\n// eslint-disable-next-line @typescript-eslint/no-empty-function\nfunction noop() {}\n"],"names":["createSyncStoragePersister","storage","key","throttleTime","serialize","JSON","stringify","deserialize","parse","retry","trySave","persistedClient","setItem","error","persistClient","throttle","client","errorCount","restoreClient","cacheString","getItem","removeClient","removeItem","noop","undefined","func","wait","timer","params","args","setTimeout"],"mappings":";;;;;;;;;;;;;;;;EAoCO,SAASA,0BAAT,CAAoC;IACzCC,OADyC;EAEzCC,EAAAA,GAAG,GAFsC,2BAAA;EAGzCC,EAAAA,YAAY,GAAG,IAH0B;IAIzCC,SAAS,GAAGC,IAAI,CAACC,SAJwB;IAKzCC,WAAW,GAAGF,IAAI,CAACG,KALsB;EAMzCC,EAAAA,KAAAA;EANyC,CAApC,EAO0C;EAC/C,EAAA,IAAI,OAAOR,OAAP,KAAmB,WAAvB,EAAoC;MAClC,MAAMS,OAAO,GAAIC,eAAD,IAAyD;QACvE,IAAI;UACFV,OAAO,CAACW,OAAR,CAAgBV,GAAhB,EAAqBE,SAAS,CAACO,eAAD,CAA9B,CAAA,CAAA;SADF,CAEE,OAAOE,KAAP,EAAc;EACd,QAAA,OAAOA,KAAP,CAAA;EACD,OAAA;OALH,CAAA;;MAOA,OAAO;EACLC,MAAAA,aAAa,EAAEC,QAAQ,CAAEJ,eAAD,IAAqB;UAC3C,IAAIK,MAAmC,GAAGL,eAA1C,CAAA;EACA,QAAA,IAAIE,KAAK,GAAGH,OAAO,CAACM,MAAD,CAAnB,CAAA;UACA,IAAIC,UAAU,GAAG,CAAjB,CAAA;;UACA,OAAOJ,KAAK,IAAIG,MAAhB,EAAwB;YACtBC,UAAU,EAAA,CAAA;EACVD,UAAAA,MAAM,GAAGP,KAAH,IAAGA,IAAAA,GAAAA,KAAAA,CAAAA,GAAAA,KAAK,CAAG;EACfE,YAAAA,eAAe,EAAEK,MADF;cAEfH,KAFe;EAGfI,YAAAA,UAAAA;EAHe,WAAH,CAAd,CAAA;;EAMA,UAAA,IAAID,MAAJ,EAAY;EACVH,YAAAA,KAAK,GAAGH,OAAO,CAACM,MAAD,CAAf,CAAA;EACD,WAAA;EACF,SAAA;SAfoB,EAgBpBb,YAhBoB,CADlB;EAkBLe,MAAAA,aAAa,EAAE,MAAM;EACnB,QAAA,MAAMC,WAAW,GAAGlB,OAAO,CAACmB,OAAR,CAAgBlB,GAAhB,CAApB,CAAA;;UAEA,IAAI,CAACiB,WAAL,EAAkB;EAChB,UAAA,OAAA;EACD,SAAA;;UAED,OAAOZ,WAAW,CAACY,WAAD,CAAlB,CAAA;SAzBG;EA2BLE,MAAAA,YAAY,EAAE,MAAM;UAClBpB,OAAO,CAACqB,UAAR,CAAmBpB,GAAnB,CAAA,CAAA;EACD,OAAA;OA7BH,CAAA;EA+BD,GAAA;;IAED,OAAO;EACLY,IAAAA,aAAa,EAAES,IADV;MAELL,aAAa,EAAE,MAAMM,SAFhB;EAGLH,IAAAA,YAAY,EAAEE,IAAAA;KAHhB,CAAA;EAKD,CAAA;;EAED,SAASR,QAAT,CACEU,IADF,EAEEC,IAAI,GAAG,GAFT,EAGE;IACA,IAAIC,KAA2C,GAAG,IAAlD,CAAA;EACA,EAAA,IAAIC,MAAJ,CAAA;IACA,OAAO,UAAU,GAAGC,IAAb,EAA0B;EAC/BD,IAAAA,MAAM,GAAGC,IAAT,CAAA;;MACA,IAAIF,KAAK,KAAK,IAAd,EAAoB;QAClBA,KAAK,GAAGG,UAAU,CAAC,MAAM;UACvBL,IAAI,CAAC,GAAGG,MAAJ,CAAJ,CAAA;EACAD,QAAAA,KAAK,GAAG,IAAR,CAAA;SAFgB,EAGfD,IAHe,CAAlB,CAAA;EAID,KAAA;KAPH,CAAA;EASD;;;EAGD,SAASH,IAAT,GAAgB;;;;;;;;;;"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* query-sync-storage-persister
|
|
3
|
+
*
|
|
4
|
+
* Copyright (c) TanStack
|
|
5
|
+
*
|
|
6
|
+
* This source code is licensed under the MIT license found in the
|
|
7
|
+
* LICENSE.md file in the root directory of this source tree.
|
|
8
|
+
*
|
|
9
|
+
* @license MIT
|
|
10
|
+
*/
|
|
11
|
+
!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self).QuerySyncStoragePersister={})}(this,(function(e){"use strict";function t(e,t=100){let r,n=null;return function(...i){r=i,null===n&&(n=setTimeout((()=>{e(...r),n=null}),t))}}function r(){}e.createSyncStoragePersister=function({storage:e,key:n="REACT_QUERY_OFFLINE_CACHE",throttleTime:i=1e3,serialize:o=JSON.stringify,deserialize:s=JSON.parse,retry:l}){if(void 0!==e){const r=t=>{try{e.setItem(n,o(t))}catch(e){return e}};return{persistClient:t((e=>{let t=e,n=r(t),i=0;for(;n&&t;)i++,t=null==l?void 0:l({persistedClient:t,error:n,errorCount:i}),t&&(n=r(t))}),i),restoreClient:()=>{const t=e.getItem(n);if(t)return s(t)},removeClient:()=>{e.removeItem(n)}}}return{persistClient:r,restoreClient:()=>{},removeClient:r}},Object.defineProperty(e,"__esModule",{value:!0})}));
|
|
12
|
+
//# sourceMappingURL=index.production.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.production.js","sources":["../../src/index.ts"],"sourcesContent":["import {\n PersistedClient,\n Persister,\n PersistRetryer,\n} from '@tanstack/react-query-persist-client'\n\ninterface Storage {\n getItem: (key: string) => string | null\n setItem: (key: string, value: string) => void\n removeItem: (key: string) => void\n}\n\ninterface CreateSyncStoragePersisterOptions {\n /** The storage client used for setting and retrieving items from cache.\n * For SSR pass in `undefined`.\n */\n storage: Storage | undefined\n /** The key to use when storing the cache */\n key?: string\n /** To avoid spamming,\n * pass a time in ms to throttle saving the cache to disk */\n throttleTime?: number\n /**\n * How to serialize the data to storage.\n * @default `JSON.stringify`\n */\n serialize?: (client: PersistedClient) => string\n /**\n * How to deserialize the data from storage.\n * @default `JSON.parse`\n */\n deserialize?: (cachedString: string) => PersistedClient\n\n retry?: PersistRetryer\n}\n\nexport function createSyncStoragePersister({\n storage,\n key = `REACT_QUERY_OFFLINE_CACHE`,\n throttleTime = 1000,\n serialize = JSON.stringify,\n deserialize = JSON.parse,\n retry,\n}: CreateSyncStoragePersisterOptions): Persister {\n if (typeof storage !== 'undefined') {\n const trySave = (persistedClient: PersistedClient): Error | undefined => {\n try {\n storage.setItem(key, serialize(persistedClient))\n } catch (error) {\n return error as Error\n }\n }\n return {\n persistClient: throttle((persistedClient) => {\n let client: PersistedClient | undefined = persistedClient\n let error = trySave(client)\n let errorCount = 0\n while (error && client) {\n errorCount++\n client = retry?.({\n persistedClient: client,\n error,\n errorCount,\n })\n\n if (client) {\n error = trySave(client)\n }\n }\n }, throttleTime),\n restoreClient: () => {\n const cacheString = storage.getItem(key)\n\n if (!cacheString) {\n return\n }\n\n return deserialize(cacheString) as PersistedClient\n },\n removeClient: () => {\n storage.removeItem(key)\n },\n }\n }\n\n return {\n persistClient: noop,\n restoreClient: () => undefined,\n removeClient: noop,\n }\n}\n\nfunction throttle<TArgs extends any[]>(\n func: (...args: TArgs) => any,\n wait = 100,\n) {\n let timer: ReturnType<typeof setTimeout> | null = null\n let params: TArgs\n return function (...args: TArgs) {\n params = args\n if (timer === null) {\n timer = setTimeout(() => {\n func(...params)\n timer = null\n }, wait)\n }\n }\n}\n\n// eslint-disable-next-line @typescript-eslint/no-empty-function\nfunction noop() {}\n"],"names":["throttle","func","wait","params","timer","args","setTimeout","noop","storage","key","throttleTime","serialize","JSON","stringify","deserialize","parse","retry","trySave","persistedClient","setItem","error","persistClient","client","errorCount","restoreClient","cacheString","getItem","removeClient","removeItem"],"mappings":";;;;;;;;;;iQA4FA,SAASA,EACPC,EACAC,EAAO,KAEP,IACIC,EADAC,EAA8C,KAElD,OAAO,YAAaC,GAClBF,EAASE,EACK,OAAVD,IACFA,EAAQE,YAAW,KACjBL,KAAQE,GACRC,EAAQ,OACPF,KAMT,SAASK,kCA1EF,UAAoCC,QACzCA,EADyCC,IAEzCA,EAFyC,4BAAAC,aAGzCA,EAAe,IAH0BC,UAIzCA,EAAYC,KAAKC,UAJwBC,YAKzCA,EAAcF,KAAKG,MALsBC,MAMzCA,IAEA,QAAuB,IAAZR,EAAyB,CAClC,MAAMS,EAAWC,IACf,IACEV,EAAQW,QAAQV,EAAKE,EAAUO,IAC/B,MAAOE,GACP,OAAOA,IAGX,MAAO,CACLC,cAAerB,GAAUkB,IACvB,IAAII,EAAsCJ,EACtCE,EAAQH,EAAQK,GAChBC,EAAa,EACjB,KAAOH,GAASE,GACdC,IACAD,EAASN,MAAAA,OAAAA,EAAAA,EAAQ,CACfE,gBAAiBI,EACjBF,QACAG,eAGED,IACFF,EAAQH,EAAQK,MAGnBZ,GACHc,cAAe,KACb,MAAMC,EAAcjB,EAAQkB,QAAQjB,GAEpC,GAAKgB,EAIL,OAAOX,EAAYW,IAErBE,aAAc,KACZnB,EAAQoB,WAAWnB,KAKzB,MAAO,CACLY,cAAed,EACfiB,cAAe,OACfG,aAAcpB"}
|
package/package.json
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@tanstack/query-sync-storage-persister",
|
|
3
|
+
"version": "4.0.0",
|
|
4
|
+
"description": "TODO",
|
|
5
|
+
"author": "tannerlinsley",
|
|
6
|
+
"license": "MIT",
|
|
7
|
+
"repository": "tanstack/query",
|
|
8
|
+
"homepage": "https://tanstack.com/query",
|
|
9
|
+
"funding": {
|
|
10
|
+
"type": "github",
|
|
11
|
+
"url": "https://github.com/sponsors/tannerlinsley"
|
|
12
|
+
},
|
|
13
|
+
"module": "build/esm/index.js",
|
|
14
|
+
"main": "build/cjs/index.js",
|
|
15
|
+
"browser": "build/umd/index.production.js",
|
|
16
|
+
"types": "build/types/packages/query-sync-storage-persister/src/index.d.ts",
|
|
17
|
+
"files": [
|
|
18
|
+
"build",
|
|
19
|
+
"src"
|
|
20
|
+
],
|
|
21
|
+
"scripts": {
|
|
22
|
+
"test:eslint": "../../node_modules/.bin/eslint --ext .ts,.tsx ./src",
|
|
23
|
+
"compile": "../../node_modules/.bin/tsc -p tsconfig.json --noEmit --emitDeclarationOnly false"
|
|
24
|
+
}
|
|
25
|
+
}
|
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
import {
|
|
2
|
+
dehydrate,
|
|
3
|
+
MutationCache,
|
|
4
|
+
QueryCache,
|
|
5
|
+
QueryClient,
|
|
6
|
+
} from '@tanstack/query-core'
|
|
7
|
+
import { removeOldestQuery } from '@tanstack/react-query-persist-client'
|
|
8
|
+
import { createSyncStoragePersister } from '../index'
|
|
9
|
+
import { sleep } from '../../../../tests/utils'
|
|
10
|
+
|
|
11
|
+
function getMockStorage(limitSize?: number) {
|
|
12
|
+
const dataSet = new Map<string, string>()
|
|
13
|
+
return {
|
|
14
|
+
getItem(key: string): string | null {
|
|
15
|
+
const value = dataSet.get(key)
|
|
16
|
+
return value === undefined ? null : value
|
|
17
|
+
},
|
|
18
|
+
|
|
19
|
+
setItem(key: string, value: string) {
|
|
20
|
+
if (typeof limitSize !== 'undefined') {
|
|
21
|
+
const currentSize = Array.from(dataSet.entries()).reduce(
|
|
22
|
+
(n, d) => d[0].length + d[1].length + n,
|
|
23
|
+
0,
|
|
24
|
+
)
|
|
25
|
+
if (
|
|
26
|
+
currentSize - (dataSet.get(key)?.length || 0) + value.length >
|
|
27
|
+
limitSize
|
|
28
|
+
) {
|
|
29
|
+
throw Error(
|
|
30
|
+
`Failed to execute 'setItem' on 'Storage': Setting the value of '${key}' exceeded the quota.`,
|
|
31
|
+
)
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
return dataSet.set(key, value)
|
|
35
|
+
},
|
|
36
|
+
removeItem(key: string) {
|
|
37
|
+
return dataSet.delete(key)
|
|
38
|
+
},
|
|
39
|
+
} as any as Storage
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
describe('createpersister ', () => {
|
|
43
|
+
test('basic store and recover', async () => {
|
|
44
|
+
const queryCache = new QueryCache()
|
|
45
|
+
const mutationCache = new MutationCache()
|
|
46
|
+
const queryClient = new QueryClient({ queryCache, mutationCache })
|
|
47
|
+
|
|
48
|
+
const storage = getMockStorage()
|
|
49
|
+
const persister = createSyncStoragePersister({
|
|
50
|
+
throttleTime: 0,
|
|
51
|
+
storage,
|
|
52
|
+
})
|
|
53
|
+
|
|
54
|
+
await queryClient.prefetchQuery(['string'], () => Promise.resolve('string'))
|
|
55
|
+
await queryClient.prefetchQuery(['number'], () => Promise.resolve(1))
|
|
56
|
+
await queryClient.prefetchQuery(['boolean'], () => Promise.resolve(true))
|
|
57
|
+
await queryClient.prefetchQuery(['null'], () => Promise.resolve(null))
|
|
58
|
+
await queryClient.prefetchQuery(['array'], () =>
|
|
59
|
+
Promise.resolve(['string', 0]),
|
|
60
|
+
)
|
|
61
|
+
|
|
62
|
+
const persistClient = {
|
|
63
|
+
buster: 'test-buster',
|
|
64
|
+
timestamp: Date.now(),
|
|
65
|
+
clientState: dehydrate(queryClient),
|
|
66
|
+
}
|
|
67
|
+
persister.persistClient(persistClient)
|
|
68
|
+
await sleep(1)
|
|
69
|
+
const restoredClient = await persister.restoreClient()
|
|
70
|
+
expect(restoredClient).toEqual(persistClient)
|
|
71
|
+
})
|
|
72
|
+
|
|
73
|
+
test('should clean the old queries when storage full', async () => {
|
|
74
|
+
const queryCache = new QueryCache()
|
|
75
|
+
const mutationCache = new MutationCache()
|
|
76
|
+
const queryClient = new QueryClient({ queryCache, mutationCache })
|
|
77
|
+
|
|
78
|
+
const N = 2000
|
|
79
|
+
const storage = getMockStorage(N * 5) // can save 4 items;
|
|
80
|
+
const persister = createSyncStoragePersister({
|
|
81
|
+
throttleTime: 0,
|
|
82
|
+
storage,
|
|
83
|
+
retry: removeOldestQuery,
|
|
84
|
+
})
|
|
85
|
+
|
|
86
|
+
await queryClient.prefetchQuery(['A'], () => Promise.resolve('A'.repeat(N)))
|
|
87
|
+
await sleep(1)
|
|
88
|
+
await queryClient.prefetchQuery(['B'], () => Promise.resolve('B'.repeat(N)))
|
|
89
|
+
await sleep(1)
|
|
90
|
+
await queryClient.prefetchQuery(['C'], () => Promise.resolve('C'.repeat(N)))
|
|
91
|
+
await sleep(1)
|
|
92
|
+
await queryClient.prefetchQuery(['D'], () => Promise.resolve('D'.repeat(N)))
|
|
93
|
+
|
|
94
|
+
await sleep(1)
|
|
95
|
+
await queryClient.prefetchQuery(['E'], () => Promise.resolve('E'.repeat(N)))
|
|
96
|
+
|
|
97
|
+
const persistClient = {
|
|
98
|
+
buster: 'test-limit',
|
|
99
|
+
timestamp: Date.now(),
|
|
100
|
+
clientState: dehydrate(queryClient),
|
|
101
|
+
}
|
|
102
|
+
persister.persistClient(persistClient)
|
|
103
|
+
await sleep(10)
|
|
104
|
+
const restoredClient = await persister.restoreClient()
|
|
105
|
+
expect(restoredClient?.clientState.queries.length).toEqual(4)
|
|
106
|
+
expect(
|
|
107
|
+
restoredClient?.clientState.queries.find((q) => q.queryKey[0] === 'A'),
|
|
108
|
+
).toBeUndefined()
|
|
109
|
+
expect(
|
|
110
|
+
restoredClient?.clientState.queries.find((q) => q.queryKey[0] === 'B'),
|
|
111
|
+
).not.toBeUndefined()
|
|
112
|
+
|
|
113
|
+
// update query Data
|
|
114
|
+
await queryClient.prefetchQuery(['A'], () => Promise.resolve('a'.repeat(N)))
|
|
115
|
+
const updatedPersistClient = {
|
|
116
|
+
buster: 'test-limit',
|
|
117
|
+
timestamp: Date.now(),
|
|
118
|
+
clientState: dehydrate(queryClient),
|
|
119
|
+
}
|
|
120
|
+
persister.persistClient(updatedPersistClient)
|
|
121
|
+
await sleep(10)
|
|
122
|
+
const restoredClient2 = await persister.restoreClient()
|
|
123
|
+
expect(restoredClient2?.clientState.queries.length).toEqual(4)
|
|
124
|
+
expect(
|
|
125
|
+
restoredClient2?.clientState.queries.find((q) => q.queryKey[0] === 'A'),
|
|
126
|
+
).toHaveProperty('state.data', 'a'.repeat(N))
|
|
127
|
+
expect(
|
|
128
|
+
restoredClient2?.clientState.queries.find((q) => q.queryKey[0] === 'B'),
|
|
129
|
+
).toBeUndefined()
|
|
130
|
+
})
|
|
131
|
+
test('should clear storage as default error handling', async () => {
|
|
132
|
+
const queryCache = new QueryCache()
|
|
133
|
+
const mutationCache = new MutationCache()
|
|
134
|
+
const queryClient = new QueryClient({ queryCache, mutationCache })
|
|
135
|
+
|
|
136
|
+
const N = 2000
|
|
137
|
+
const storage = getMockStorage(0)
|
|
138
|
+
const persister = createSyncStoragePersister({
|
|
139
|
+
throttleTime: 0,
|
|
140
|
+
storage,
|
|
141
|
+
retry: removeOldestQuery,
|
|
142
|
+
})
|
|
143
|
+
|
|
144
|
+
await queryClient.prefetchQuery(['A'], () => Promise.resolve('A'.repeat(N)))
|
|
145
|
+
await sleep(1)
|
|
146
|
+
|
|
147
|
+
const persistClient = {
|
|
148
|
+
buster: 'test-limit',
|
|
149
|
+
timestamp: Date.now(),
|
|
150
|
+
clientState: dehydrate(queryClient),
|
|
151
|
+
}
|
|
152
|
+
persister.persistClient(persistClient)
|
|
153
|
+
await sleep(10)
|
|
154
|
+
const restoredClient = await persister.restoreClient()
|
|
155
|
+
expect(restoredClient).toEqual(undefined)
|
|
156
|
+
})
|
|
157
|
+
})
|
package/src/index.ts
ADDED
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
import {
|
|
2
|
+
PersistedClient,
|
|
3
|
+
Persister,
|
|
4
|
+
PersistRetryer,
|
|
5
|
+
} from '@tanstack/react-query-persist-client'
|
|
6
|
+
|
|
7
|
+
interface Storage {
|
|
8
|
+
getItem: (key: string) => string | null
|
|
9
|
+
setItem: (key: string, value: string) => void
|
|
10
|
+
removeItem: (key: string) => void
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
interface CreateSyncStoragePersisterOptions {
|
|
14
|
+
/** The storage client used for setting and retrieving items from cache.
|
|
15
|
+
* For SSR pass in `undefined`.
|
|
16
|
+
*/
|
|
17
|
+
storage: Storage | undefined
|
|
18
|
+
/** The key to use when storing the cache */
|
|
19
|
+
key?: string
|
|
20
|
+
/** To avoid spamming,
|
|
21
|
+
* pass a time in ms to throttle saving the cache to disk */
|
|
22
|
+
throttleTime?: number
|
|
23
|
+
/**
|
|
24
|
+
* How to serialize the data to storage.
|
|
25
|
+
* @default `JSON.stringify`
|
|
26
|
+
*/
|
|
27
|
+
serialize?: (client: PersistedClient) => string
|
|
28
|
+
/**
|
|
29
|
+
* How to deserialize the data from storage.
|
|
30
|
+
* @default `JSON.parse`
|
|
31
|
+
*/
|
|
32
|
+
deserialize?: (cachedString: string) => PersistedClient
|
|
33
|
+
|
|
34
|
+
retry?: PersistRetryer
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
export function createSyncStoragePersister({
|
|
38
|
+
storage,
|
|
39
|
+
key = `REACT_QUERY_OFFLINE_CACHE`,
|
|
40
|
+
throttleTime = 1000,
|
|
41
|
+
serialize = JSON.stringify,
|
|
42
|
+
deserialize = JSON.parse,
|
|
43
|
+
retry,
|
|
44
|
+
}: CreateSyncStoragePersisterOptions): Persister {
|
|
45
|
+
if (typeof storage !== 'undefined') {
|
|
46
|
+
const trySave = (persistedClient: PersistedClient): Error | undefined => {
|
|
47
|
+
try {
|
|
48
|
+
storage.setItem(key, serialize(persistedClient))
|
|
49
|
+
} catch (error) {
|
|
50
|
+
return error as Error
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
return {
|
|
54
|
+
persistClient: throttle((persistedClient) => {
|
|
55
|
+
let client: PersistedClient | undefined = persistedClient
|
|
56
|
+
let error = trySave(client)
|
|
57
|
+
let errorCount = 0
|
|
58
|
+
while (error && client) {
|
|
59
|
+
errorCount++
|
|
60
|
+
client = retry?.({
|
|
61
|
+
persistedClient: client,
|
|
62
|
+
error,
|
|
63
|
+
errorCount,
|
|
64
|
+
})
|
|
65
|
+
|
|
66
|
+
if (client) {
|
|
67
|
+
error = trySave(client)
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
}, throttleTime),
|
|
71
|
+
restoreClient: () => {
|
|
72
|
+
const cacheString = storage.getItem(key)
|
|
73
|
+
|
|
74
|
+
if (!cacheString) {
|
|
75
|
+
return
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
return deserialize(cacheString) as PersistedClient
|
|
79
|
+
},
|
|
80
|
+
removeClient: () => {
|
|
81
|
+
storage.removeItem(key)
|
|
82
|
+
},
|
|
83
|
+
}
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
return {
|
|
87
|
+
persistClient: noop,
|
|
88
|
+
restoreClient: () => undefined,
|
|
89
|
+
removeClient: noop,
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
function throttle<TArgs extends any[]>(
|
|
94
|
+
func: (...args: TArgs) => any,
|
|
95
|
+
wait = 100,
|
|
96
|
+
) {
|
|
97
|
+
let timer: ReturnType<typeof setTimeout> | null = null
|
|
98
|
+
let params: TArgs
|
|
99
|
+
return function (...args: TArgs) {
|
|
100
|
+
params = args
|
|
101
|
+
if (timer === null) {
|
|
102
|
+
timer = setTimeout(() => {
|
|
103
|
+
func(...params)
|
|
104
|
+
timer = null
|
|
105
|
+
}, wait)
|
|
106
|
+
}
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
// eslint-disable-next-line @typescript-eslint/no-empty-function
|
|
111
|
+
function noop() {}
|