@hyper-fetch/react 9.6.1 → 9.7.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.
Files changed (98) hide show
  1. package/__tests__/features/helpers/use-tracked-state/use-tacked-state.actions.spec.ts +1 -1
  2. package/__tests__/features/helpers/use-tracked-state/use-tracked-state.keys.spec.ts +294 -0
  3. package/__tests__/features/helpers/utils.spec.ts +127 -0
  4. package/__tests__/features/provider/provider.config.spec.tsx +172 -0
  5. package/__tests__/features/use-app-manager/use-app-manager.events.spec.tsx +497 -0
  6. package/__tests__/features/use-cache/use-cache.state.spec.tsx +326 -0
  7. package/__tests__/features/use-emitter/use-emitter.lifecycle.spec.tsx +417 -0
  8. package/__tests__/features/use-fetch/use-fetch.bounce-timers.spec.ts +199 -0
  9. package/__tests__/features/use-fetch/use-fetch.cache-events.spec.ts +212 -0
  10. package/__tests__/features/use-fetch/use-fetch.callbacks.spec.tsx +359 -0
  11. package/__tests__/features/use-fetch/use-fetch.hydration.spec.tsx +126 -0
  12. package/__tests__/features/use-fetch/use-fetch.infinite.spec.ts +146 -0
  13. package/__tests__/features/use-fetch/use-fetch.initial-state.spec.ts +340 -0
  14. package/__tests__/features/use-fetch/use-fetch.keys.spec.tsx +559 -0
  15. package/__tests__/features/use-fetch/use-fetch.lifecycle.spec.ts +348 -0
  16. package/__tests__/features/use-fetch/use-fetch.mounting.spec.tsx +411 -0
  17. package/__tests__/features/use-fetch/use-fetch.pagination.spec.ts +177 -0
  18. package/__tests__/features/use-fetch/use-fetch.refresh-interval.spec.ts +355 -0
  19. package/__tests__/features/use-fetch/use-fetch.response-order.spec.ts +105 -0
  20. package/__tests__/features/use-fetch/use-fetch.retry.spec.ts +235 -0
  21. package/__tests__/features/use-fetch/use-fetch.return-types.spec.ts +186 -0
  22. package/__tests__/features/use-fetch/use-fetch.scope.spec.ts +333 -0
  23. package/__tests__/features/use-fetch/use-fetch.ssr.spec.tsx +195 -0
  24. package/__tests__/features/use-fetch/use-fetch.suspense-edge.spec.tsx +391 -0
  25. package/__tests__/features/use-fetch/use-fetch.throwing-callbacks.spec.tsx +112 -0
  26. package/__tests__/features/use-fetch/use-fetch.tracking.spec.tsx +364 -0
  27. package/__tests__/features/use-fetch/use-fetch.window-events.spec.ts +300 -0
  28. package/__tests__/features/use-infinite-fetch/use-infinite-fetch.parity.spec.tsx +1027 -0
  29. package/__tests__/features/use-infinite-fetch/use-infinite-fetch.resubscribe.spec.tsx +267 -0
  30. package/__tests__/features/use-infinite-fetch/use-infinite-fetch.typescript.spec.ts +64 -1
  31. package/__tests__/features/use-is-fetching/use-is-fetching.lifecycle.spec.tsx +301 -0
  32. package/__tests__/features/use-listener/use-listener.lifecycle.spec.tsx +507 -0
  33. package/__tests__/features/use-listener/use-listener.ssr.spec.tsx +89 -0
  34. package/__tests__/features/use-queue/use-queue.controls.spec.tsx +593 -0
  35. package/__tests__/features/use-queue/use-queue.list.spec.tsx +560 -0
  36. package/__tests__/features/use-queue/use-queue.progress.spec.tsx +650 -0
  37. package/__tests__/features/use-submit/use-submit.abort.spec.tsx +270 -0
  38. package/__tests__/features/use-submit/use-submit.actions.spec.tsx +446 -0
  39. package/__tests__/features/use-submit/use-submit.arguments.spec.tsx +732 -0
  40. package/__tests__/features/use-submit/use-submit.bounce.spec.tsx +644 -0
  41. package/__tests__/features/use-submit/use-submit.callbacks.spec.tsx +860 -0
  42. package/__tests__/features/use-submit/use-submit.chaining.spec.tsx +167 -0
  43. package/__tests__/features/use-submit/use-submit.double-submit.spec.tsx +552 -0
  44. package/__tests__/features/use-submit/use-submit.offline.spec.tsx +285 -0
  45. package/__tests__/features/use-submit/use-submit.optimistic-cache.spec.tsx +619 -0
  46. package/__tests__/features/use-submit/use-submit.optimistic-helpers.spec.tsx +455 -0
  47. package/__tests__/features/use-submit/use-submit.optimistic-settlement.spec.ts +6 -0
  48. package/__tests__/features/use-submit/use-submit.optimistic.spec.ts +5 -1
  49. package/__tests__/features/use-submit/use-submit.state.spec.tsx +1025 -0
  50. package/__tests__/features/use-submit/use-submit.submit-types.spec.ts +194 -0
  51. package/__tests__/features/use-submit/use-submit.submitting.spec.tsx +180 -0
  52. package/__tests__/utils/gate.utils.ts +103 -0
  53. package/__tests__/utils/gated-client.utils.ts +158 -0
  54. package/__tests__/utils/helpers.utils.ts +19 -0
  55. package/dist/helpers/use-request-events/use-request-events.hooks.d.ts.map +1 -1
  56. package/dist/helpers/use-request-events/use-request-events.types.d.ts +1 -1
  57. package/dist/helpers/use-request-events/use-request-events.types.d.ts.map +1 -1
  58. package/dist/helpers/use-tracked-state/use-tracked-state.hooks.d.ts.map +1 -1
  59. package/dist/helpers/use-tracked-state/use-tracked-state.utils.d.ts +8 -0
  60. package/dist/helpers/use-tracked-state/use-tracked-state.utils.d.ts.map +1 -1
  61. package/dist/hooks/use-cache/use-cache.hooks.d.ts.map +1 -1
  62. package/dist/hooks/use-fetch/use-fetch.hooks.d.ts.map +1 -1
  63. package/dist/hooks/use-infinite-fetch/use-infinite-fetch.hooks.d.ts.map +1 -1
  64. package/dist/hooks/use-infinite-fetch/use-infinite-fetch.store.d.ts +3 -0
  65. package/dist/hooks/use-infinite-fetch/use-infinite-fetch.store.d.ts.map +1 -1
  66. package/dist/hooks/use-infinite-fetch/use-infinite-fetch.types.d.ts +5 -3
  67. package/dist/hooks/use-infinite-fetch/use-infinite-fetch.types.d.ts.map +1 -1
  68. package/dist/hooks/use-infinite-fetch/use-infinite-fetch.utils.d.ts +11 -1
  69. package/dist/hooks/use-infinite-fetch/use-infinite-fetch.utils.d.ts.map +1 -1
  70. package/dist/hooks/use-listener/use-listener.hooks.d.ts.map +1 -1
  71. package/dist/hooks/use-queue/use-queue.hooks.d.ts.map +1 -1
  72. package/dist/hooks/use-submit/use-submit.constants.d.ts +1 -1
  73. package/dist/hooks/use-submit/use-submit.constants.d.ts.map +1 -1
  74. package/dist/hooks/use-submit/use-submit.hooks.d.ts.map +1 -1
  75. package/dist/hooks/use-submit/use-submit.types.d.ts +6 -1
  76. package/dist/hooks/use-submit/use-submit.types.d.ts.map +1 -1
  77. package/dist/index.mjs +633 -346
  78. package/dist/index.mjs.map +1 -1
  79. package/dist/provider/provider.d.ts.map +1 -1
  80. package/package.json +1 -1
  81. package/src/helpers/use-request-events/use-request-events.hooks.ts +141 -28
  82. package/src/helpers/use-request-events/use-request-events.types.ts +1 -1
  83. package/src/helpers/use-tracked-state/use-tracked-state.hooks.ts +148 -101
  84. package/src/helpers/use-tracked-state/use-tracked-state.utils.ts +26 -5
  85. package/src/hooks/use-cache/use-cache.hooks.ts +20 -5
  86. package/src/hooks/use-fetch/use-fetch.hooks.ts +194 -113
  87. package/src/hooks/use-infinite-fetch/use-infinite-fetch.hooks.ts +55 -26
  88. package/src/hooks/use-infinite-fetch/use-infinite-fetch.store.ts +35 -29
  89. package/src/hooks/use-infinite-fetch/use-infinite-fetch.types.ts +5 -3
  90. package/src/hooks/use-infinite-fetch/use-infinite-fetch.utils.ts +25 -1
  91. package/src/hooks/use-listener/use-listener.hooks.ts +2 -1
  92. package/src/hooks/use-queue/use-queue.hooks.ts +85 -60
  93. package/src/hooks/use-submit/use-submit.constants.ts +3 -1
  94. package/src/hooks/use-submit/use-submit.hooks.ts +167 -53
  95. package/src/hooks/use-submit/use-submit.types.ts +6 -0
  96. package/src/provider/provider.tsx +9 -1
  97. package/__tests__/features/use-fetch/use-fetch.pagination.ts +0 -36
  98. package/__tests__/features/use-fetch/use-fetch.retry.ts +0 -38
@@ -0,0 +1,326 @@
1
+ import { act, renderHook } from "@testing-library/react";
2
+ import { useCache } from "hooks/use-cache";
3
+ import { useFetch } from "hooks/use-fetch";
4
+ import { StrictMode } from "react";
5
+
6
+ import { client, createRequest } from "../../utils";
7
+ import { advance, countListeners, gateRequest, setCacheResponse, settle } from "../../utils/gate.utils";
8
+
9
+ type User = { id: number; name: string };
10
+
11
+ const user: User = { id: 1, name: "Maciej" };
12
+
13
+ describe("useCache [ State ]", () => {
14
+ let request = createRequest<User, any, "/users/:id">({ endpoint: "/users/:id" });
15
+ let calls = gateRequest(request);
16
+
17
+ const userRequest = (id = 1) => request.setParams({ id });
18
+
19
+ const renderUserCache = (id = 1, wrapper?: typeof StrictMode) => {
20
+ const counter = { renders: 0 };
21
+ const view = renderHook(
22
+ (props: { id: number }) => {
23
+ counter.renders += 1;
24
+ const state = useCache(userRequest(props.id));
25
+ return {
26
+ data: state.data,
27
+ loading: state.loading,
28
+ error: state.error,
29
+ success: state.success,
30
+ status: state.status,
31
+ actions: state,
32
+ };
33
+ },
34
+ { initialProps: { id }, wrapper },
35
+ );
36
+ return { ...view, counter };
37
+ };
38
+
39
+ beforeEach(() => {
40
+ vi.useFakeTimers();
41
+ client.clear();
42
+ request = createRequest<User, any, "/users/:id">({ endpoint: "/users/:id" });
43
+ calls = gateRequest(request);
44
+ });
45
+
46
+ afterEach(() => {
47
+ vi.useRealTimers();
48
+ });
49
+
50
+ describe("when the cache is empty", () => {
51
+ it("should return empty state without loading", async () => {
52
+ const { result } = renderUserCache();
53
+
54
+ expect(result.current.data).toBeNull();
55
+ expect(result.current.error).toBeNull();
56
+ expect(result.current.loading).toBeFalse();
57
+ expect(result.current.success).toBeFalse();
58
+ expect(result.current.status).toBeNull();
59
+ });
60
+ it("should never send a request", async () => {
61
+ const { rerender } = renderUserCache();
62
+ rerender({ id: 2 });
63
+ act(() => {
64
+ client.appManager.setFocused(true);
65
+ client.appManager.setOnline(true);
66
+ });
67
+ await advance(60_000);
68
+
69
+ expect(calls).toHaveLength(0);
70
+ });
71
+ it("should receive the data fetched by another hook", async () => {
72
+ const { result } = renderUserCache();
73
+ renderHook(() => useFetch(userRequest()).data);
74
+ await advance();
75
+
76
+ expect(result.current.loading).toBeTrue();
77
+
78
+ calls[0].succeed(user);
79
+ await settle();
80
+
81
+ expect(result.current.data).toStrictEqual(user);
82
+ expect(result.current.loading).toBeFalse();
83
+ expect(result.current.success).toBeTrue();
84
+ });
85
+ it("should receive the error of the request sent by another hook", async () => {
86
+ const { result } = renderUserCache();
87
+ renderHook(() => useFetch(userRequest()).data);
88
+ await advance();
89
+ calls[0].fail(new Error("Failed"), 500);
90
+ await settle();
91
+
92
+ expect(result.current.error?.message).toBe("Failed");
93
+ expect(result.current.status).toBe(500);
94
+ expect(result.current.success).toBeFalse();
95
+ });
96
+ it("should receive the data set directly in the cache", async () => {
97
+ const { result } = renderUserCache();
98
+
99
+ act(() => {
100
+ setCacheResponse(userRequest(), user);
101
+ });
102
+
103
+ expect(result.current.data).toStrictEqual(user);
104
+ });
105
+ });
106
+
107
+ describe("when the cache has data", () => {
108
+ beforeEach(() => {
109
+ setCacheResponse(userRequest(), user);
110
+ });
111
+
112
+ it("should return it on the first render", async () => {
113
+ const { result, counter } = renderUserCache();
114
+
115
+ expect(result.current.data).toStrictEqual(user);
116
+ expect(result.current.success).toBeTrue();
117
+ expect(result.current.status).toBe(200);
118
+ expect(counter.renders).toBe(1);
119
+ });
120
+ it("should not send a request for stale data", async () => {
121
+ await advance(60 * 60 * 1000);
122
+ setCacheResponse(userRequest(), user, Date.now() - 60 * 60 * 1000);
123
+
124
+ renderUserCache();
125
+ await advance();
126
+
127
+ expect(calls).toHaveLength(0);
128
+ });
129
+ it("should follow the cache updates", async () => {
130
+ const { result } = renderUserCache();
131
+
132
+ act(() => {
133
+ client.cache.update(userRequest(), { data: { id: 1, name: "Updated" } });
134
+ });
135
+
136
+ expect(result.current.data).toStrictEqual({ id: 1, name: "Updated" });
137
+ });
138
+ it("should not rerender when the cache gets equal data", async () => {
139
+ const { counter } = renderUserCache();
140
+
141
+ act(() => {
142
+ client.cache.update(userRequest(), { data: { ...user } });
143
+ });
144
+
145
+ expect(counter.renders).toBe(1);
146
+ });
147
+ it("should keep the data when the request fails later", async () => {
148
+ const { result } = renderUserCache();
149
+ act(() => {
150
+ client.fetchDispatcher.add(userRequest());
151
+ });
152
+ await advance();
153
+ calls[0].fail(new Error("Failed"));
154
+ await settle();
155
+
156
+ expect(result.current.data).toStrictEqual(user);
157
+ expect(result.current.error?.message).toBe("Failed");
158
+ });
159
+ it("should work in StrictMode", async () => {
160
+ const { result } = renderUserCache(1, StrictMode);
161
+
162
+ act(() => {
163
+ client.cache.update(userRequest(), { data: { id: 1, name: "Updated" } });
164
+ });
165
+
166
+ expect(result.current.data).toStrictEqual({ id: 1, name: "Updated" });
167
+ });
168
+ });
169
+
170
+ describe("when the request key changes", () => {
171
+ it("should show the cached data of the new key on the first render with it", async () => {
172
+ setCacheResponse(userRequest(1), user);
173
+ setCacheResponse(userRequest(2), { id: 2, name: "Second" });
174
+ const { result, rerender } = renderUserCache(1);
175
+
176
+ rerender({ id: 2 });
177
+
178
+ expect(result.current.data).toStrictEqual({ id: 2, name: "Second" });
179
+ });
180
+ it("should return empty state for the key without cache", async () => {
181
+ setCacheResponse(userRequest(1), user);
182
+ const { result, rerender } = renderUserCache(1);
183
+
184
+ rerender({ id: 2 });
185
+
186
+ expect(result.current.data).toBeNull();
187
+ expect(result.current.success).toBeFalse();
188
+ });
189
+ it("should not keep the data of the previous query params", async () => {
190
+ const listRequest = createRequest<{ page: number }, any, "/users">({ endpoint: "/users" });
191
+ setCacheResponse(listRequest.setQueryParams({ page: 1 }), { page: 1 });
192
+ const { result, rerender } = renderHook(({ page }) => useCache(listRequest.setQueryParams({ page })).data, {
193
+ initialProps: { page: 1 },
194
+ });
195
+ expect(result.current).toStrictEqual({ page: 1 });
196
+
197
+ rerender({ page: 2 });
198
+
199
+ expect(result.current).toBeNull();
200
+ });
201
+ it("should follow the cache of the new key only", async () => {
202
+ const { result, rerender } = renderUserCache(1);
203
+ rerender({ id: 2 });
204
+
205
+ act(() => {
206
+ setCacheResponse(userRequest(1), user);
207
+ });
208
+ expect(result.current.data).toBeNull();
209
+
210
+ act(() => {
211
+ setCacheResponse(userRequest(2), { id: 2, name: "Second" });
212
+ });
213
+ expect(result.current.data).toStrictEqual({ id: 2, name: "Second" });
214
+ });
215
+ });
216
+
217
+ describe("when using the actions", () => {
218
+ it("should refetch the mounted useFetch hooks on invalidate", async () => {
219
+ const { result } = renderUserCache();
220
+ renderHook(() => useFetch(userRequest()).data);
221
+ await advance();
222
+ calls[0].succeed(user);
223
+ await settle();
224
+
225
+ act(() => {
226
+ result.current.actions.invalidate();
227
+ });
228
+ await advance();
229
+
230
+ expect(calls).toHaveLength(2);
231
+ });
232
+ it("should not refetch anything on invalidate without mounted useFetch hooks", async () => {
233
+ setCacheResponse(userRequest(), user);
234
+ const { result } = renderUserCache();
235
+
236
+ act(() => {
237
+ result.current.actions.invalidate();
238
+ });
239
+ await advance();
240
+
241
+ expect(calls).toHaveLength(0);
242
+ });
243
+ it("should mark the cache entry as stale on invalidate", async () => {
244
+ setCacheResponse(userRequest(), user);
245
+ const { result } = renderUserCache();
246
+
247
+ act(() => {
248
+ result.current.actions.invalidate();
249
+ });
250
+
251
+ expect(client.cache.get(userRequest().cacheKey)?.staleTime).toBe(0);
252
+ });
253
+ it("should invalidate other requests by the given key", async () => {
254
+ const { result } = renderUserCache(1);
255
+ renderHook(() => useFetch(userRequest(2)).data);
256
+ await advance();
257
+ calls[0].succeed({ id: 2, name: "Second" });
258
+ await settle();
259
+
260
+ act(() => {
261
+ result.current.actions.invalidate(userRequest(2));
262
+ });
263
+ await advance();
264
+
265
+ expect(calls).toHaveLength(2);
266
+ expect(calls[1].request.endpoint).toBe("/users/2");
267
+ });
268
+ it("should keep setData local to the hook", async () => {
269
+ setCacheResponse(userRequest(), user);
270
+ const { result } = renderUserCache();
271
+ const other = renderUserCache();
272
+
273
+ act(() => {
274
+ result.current.actions.setData({ id: 1, name: "Local" });
275
+ });
276
+
277
+ expect(result.current.data).toStrictEqual({ id: 1, name: "Local" });
278
+ expect(other.result.current.data).toStrictEqual(user);
279
+ expect(client.cache.get(userRequest().cacheKey)?.data).toStrictEqual(user);
280
+ });
281
+ it("should reset the hook state with clearState and keep the cache", async () => {
282
+ setCacheResponse(userRequest(), user);
283
+ const { result } = renderUserCache();
284
+
285
+ act(() => {
286
+ result.current.actions.clearState();
287
+ });
288
+
289
+ expect(result.current.data).toBeNull();
290
+ expect(result.current.success).toBeFalse();
291
+ expect(client.cache.get(userRequest().cacheKey)?.data).toStrictEqual(user);
292
+ });
293
+ it("should keep the identity of the state actions between renders", async () => {
294
+ const { result, rerender } = renderUserCache();
295
+ const { setData, setError, setLoading, clearState } = result.current.actions;
296
+
297
+ rerender({ id: 1 });
298
+
299
+ expect(result.current.actions.setData).toBe(setData);
300
+ expect(result.current.actions.setError).toBe(setError);
301
+ expect(result.current.actions.setLoading).toBe(setLoading);
302
+ expect(result.current.actions.clearState).toBe(clearState);
303
+ });
304
+ });
305
+
306
+ describe("when the hook unmounts", () => {
307
+ it("should remove all the listeners", async () => {
308
+ const baseline = countListeners(client);
309
+ const { unmount, rerender } = renderUserCache();
310
+ rerender({ id: 2 });
311
+ expect(countListeners(client)).not.toStrictEqual(baseline);
312
+
313
+ unmount();
314
+
315
+ expect(countListeners(client)).toStrictEqual(baseline);
316
+ });
317
+ it("should remove all the listeners in StrictMode", async () => {
318
+ const baseline = countListeners(client);
319
+ const { unmount } = renderUserCache(1, StrictMode);
320
+
321
+ unmount();
322
+
323
+ expect(countListeners(client)).toStrictEqual(baseline);
324
+ });
325
+ });
326
+ });