@tanstack/query-sync-storage-persister 5.59.17 → 5.60.4

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.
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/utils.ts"],"sourcesContent":["export function noop() {}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAO,SAAS,OAAO;AAAC;","names":[]}
1
+ {"version":3,"sources":["../../src/utils.ts"],"sourcesContent":["export function noop(): void {}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAO,SAAS,OAAa;AAAC;","names":[]}
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/utils.ts"],"sourcesContent":["export function noop() {}\n"],"mappings":";AAAO,SAAS,OAAO;AAAC;","names":[]}
1
+ {"version":3,"sources":["../../src/utils.ts"],"sourcesContent":["export function noop(): void {}\n"],"mappings":";AAAO,SAAS,OAAa;AAAC;","names":[]}
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/utils.ts"],"sourcesContent":["export function noop() {}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAO,SAAS,OAAO;AAAC;","names":[]}
1
+ {"version":3,"sources":["../../src/utils.ts"],"sourcesContent":["export function noop(): void {}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAO,SAAS,OAAa;AAAC;","names":[]}
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/utils.ts"],"sourcesContent":["export function noop() {}\n"],"mappings":";AAAO,SAAS,OAAO;AAAC;","names":[]}
1
+ {"version":3,"sources":["../../src/utils.ts"],"sourcesContent":["export function noop(): void {}\n"],"mappings":";AAAO,SAAS,OAAa;AAAC;","names":[]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tanstack/query-sync-storage-persister",
3
- "version": "5.59.17",
3
+ "version": "5.60.4",
4
4
  "description": "A persister for synchronous storages, to be used with TanStack/Query",
5
5
  "author": "tannerlinsley",
6
6
  "license": "MIT",
@@ -34,11 +34,12 @@
34
34
  "sideEffects": false,
35
35
  "files": [
36
36
  "build",
37
- "src"
37
+ "src",
38
+ "!src/__tests__"
38
39
  ],
39
40
  "dependencies": {
40
- "@tanstack/query-core": "5.59.17",
41
- "@tanstack/query-persist-client-core": "5.59.17"
41
+ "@tanstack/query-persist-client-core": "5.59.20",
42
+ "@tanstack/query-core": "5.59.20"
42
43
  },
43
44
  "scripts": {}
44
45
  }
package/src/utils.ts CHANGED
@@ -1 +1 @@
1
- export function noop() {}
1
+ export function noop(): void {}
@@ -1,192 +0,0 @@
1
- import { describe, expect, test } from 'vitest'
2
- import {
3
- MutationCache,
4
- QueryCache,
5
- QueryClient,
6
- dehydrate,
7
- } from '@tanstack/query-core'
8
- import { removeOldestQuery } from '@tanstack/query-persist-client-core'
9
- import { createSyncStoragePersister } from '../index'
10
- import { sleep } from './utils'
11
-
12
- function getMockStorage(limitSize?: number) {
13
- const dataSet = new Map<string, string>()
14
- return {
15
- getItem(key: string): string | null {
16
- const value = dataSet.get(key)
17
- return value === undefined ? null : value
18
- },
19
-
20
- setItem(key: string, value: string) {
21
- if (limitSize !== undefined) {
22
- const currentSize = Array.from(dataSet.entries()).reduce(
23
- (n, d) => d[0].length + d[1].length + n,
24
- 0,
25
- )
26
- if (
27
- currentSize - (dataSet.get(key)?.length || 0) + value.length >
28
- limitSize
29
- ) {
30
- throw Error(
31
- `Failed to execute 'setItem' on 'Storage': Setting the value of '${key}' exceeded the quota.`,
32
- )
33
- }
34
- }
35
- return dataSet.set(key, value)
36
- },
37
- removeItem(key: string) {
38
- return dataSet.delete(key)
39
- },
40
- } as any as Storage
41
- }
42
-
43
- describe('create persister', () => {
44
- test('basic store and recover', async () => {
45
- const queryCache = new QueryCache()
46
- const mutationCache = new MutationCache()
47
- const queryClient = new QueryClient({ queryCache, mutationCache })
48
-
49
- const storage = getMockStorage()
50
- const persister = createSyncStoragePersister({
51
- throttleTime: 0,
52
- storage,
53
- })
54
-
55
- await queryClient.prefetchQuery({
56
- queryKey: ['string'],
57
- queryFn: () => Promise.resolve('string'),
58
- })
59
- await queryClient.prefetchQuery({
60
- queryKey: ['number'],
61
- queryFn: () => Promise.resolve(1),
62
- })
63
- await queryClient.prefetchQuery({
64
- queryKey: ['boolean'],
65
- queryFn: () => Promise.resolve(true),
66
- })
67
- await queryClient.prefetchQuery({
68
- queryKey: ['null'],
69
- queryFn: () => Promise.resolve(null),
70
- })
71
- await queryClient.prefetchQuery({
72
- queryKey: ['array'],
73
- queryFn: () => Promise.resolve(['string', 0]),
74
- })
75
-
76
- const persistClient = {
77
- buster: 'test-buster',
78
- timestamp: Date.now(),
79
- clientState: dehydrate(queryClient),
80
- }
81
- persister.persistClient(persistClient)
82
- await sleep(1)
83
- const restoredClient = await persister.restoreClient()
84
- expect(restoredClient).toEqual(persistClient)
85
- })
86
-
87
- test('should clean the old queries when storage full', async () => {
88
- const queryCache = new QueryCache()
89
- const mutationCache = new MutationCache()
90
- const queryClient = new QueryClient({ queryCache, mutationCache })
91
-
92
- const N = 2000
93
- const storage = getMockStorage(N * 5) // can save 4 items;
94
- const persister = createSyncStoragePersister({
95
- throttleTime: 0,
96
- storage,
97
- retry: removeOldestQuery,
98
- })
99
-
100
- await queryClient.prefetchQuery({
101
- queryKey: ['A'],
102
- queryFn: () => Promise.resolve('A'.repeat(N)),
103
- })
104
- await sleep(1)
105
- await queryClient.prefetchQuery({
106
- queryKey: ['B'],
107
- queryFn: () => Promise.resolve('B'.repeat(N)),
108
- })
109
- await sleep(1)
110
- await queryClient.prefetchQuery({
111
- queryKey: ['C'],
112
- queryFn: () => Promise.resolve('C'.repeat(N)),
113
- })
114
- await sleep(1)
115
- await queryClient.prefetchQuery({
116
- queryKey: ['D'],
117
- queryFn: () => Promise.resolve('D'.repeat(N)),
118
- })
119
-
120
- await sleep(1)
121
- await queryClient.prefetchQuery({
122
- queryKey: ['E'],
123
- queryFn: () => Promise.resolve('E'.repeat(N)),
124
- })
125
-
126
- const persistClient = {
127
- buster: 'test-limit',
128
- timestamp: Date.now(),
129
- clientState: dehydrate(queryClient),
130
- }
131
- persister.persistClient(persistClient)
132
- await sleep(10)
133
- const restoredClient = await persister.restoreClient()
134
- expect(restoredClient?.clientState.queries.length).toEqual(4)
135
- expect(
136
- restoredClient?.clientState.queries.find((q) => q.queryKey[0] === 'A'),
137
- ).toBeUndefined()
138
- expect(
139
- restoredClient?.clientState.queries.find((q) => q.queryKey[0] === 'B'),
140
- ).not.toBeUndefined()
141
-
142
- // update query Data
143
- await queryClient.prefetchQuery({
144
- queryKey: ['A'],
145
- queryFn: () => Promise.resolve('a'.repeat(N)),
146
- })
147
- const updatedPersistClient = {
148
- buster: 'test-limit',
149
- timestamp: Date.now(),
150
- clientState: dehydrate(queryClient),
151
- }
152
- persister.persistClient(updatedPersistClient)
153
- await sleep(10)
154
- const restoredClient2 = await persister.restoreClient()
155
- expect(restoredClient2?.clientState.queries.length).toEqual(4)
156
- expect(
157
- restoredClient2?.clientState.queries.find((q) => q.queryKey[0] === 'A'),
158
- ).toHaveProperty('state.data', 'a'.repeat(N))
159
- expect(
160
- restoredClient2?.clientState.queries.find((q) => q.queryKey[0] === 'B'),
161
- ).toBeUndefined()
162
- })
163
- test('should clear storage as default error handling', async () => {
164
- const queryCache = new QueryCache()
165
- const mutationCache = new MutationCache()
166
- const queryClient = new QueryClient({ queryCache, mutationCache })
167
-
168
- const N = 2000
169
- const storage = getMockStorage(0)
170
- const persister = createSyncStoragePersister({
171
- throttleTime: 0,
172
- storage,
173
- retry: removeOldestQuery,
174
- })
175
-
176
- await queryClient.prefetchQuery({
177
- queryKey: ['A'],
178
- queryFn: () => Promise.resolve('A'.repeat(N)),
179
- })
180
- await sleep(1)
181
-
182
- const persistClient = {
183
- buster: 'test-limit',
184
- timestamp: Date.now(),
185
- clientState: dehydrate(queryClient),
186
- }
187
- persister.persistClient(persistClient)
188
- await sleep(10)
189
- const restoredClient = await persister.restoreClient()
190
- expect(restoredClient).toEqual(undefined)
191
- })
192
- })
@@ -1,5 +0,0 @@
1
- export function sleep(timeout: number): Promise<void> {
2
- return new Promise((resolve, _reject) => {
3
- setTimeout(resolve, timeout)
4
- })
5
- }