@hyper-fetch/react 9.6.0 → 9.6.2

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 (102) hide show
  1. package/__tests__/features/helpers/use-request-events/use-request-events.async-mapper.spec.ts +243 -0
  2. package/__tests__/features/helpers/use-tracked-state/use-tacked-state.actions.spec.ts +1 -1
  3. package/__tests__/features/helpers/use-tracked-state/use-tracked-state.keys.spec.ts +294 -0
  4. package/__tests__/features/helpers/utils.spec.ts +127 -0
  5. package/__tests__/features/provider/provider.config.spec.tsx +172 -0
  6. package/__tests__/features/use-app-manager/use-app-manager.events.spec.tsx +497 -0
  7. package/__tests__/features/use-cache/use-cache.state.spec.tsx +326 -0
  8. package/__tests__/features/use-emitter/use-emitter.lifecycle.spec.tsx +417 -0
  9. package/__tests__/features/use-fetch/use-fetch.bounce-timers.spec.ts +199 -0
  10. package/__tests__/features/use-fetch/use-fetch.cache-events.spec.ts +212 -0
  11. package/__tests__/features/use-fetch/use-fetch.callbacks.spec.tsx +359 -0
  12. package/__tests__/features/use-fetch/use-fetch.cancel.spec.ts +6 -3
  13. package/__tests__/features/use-fetch/use-fetch.debounce.spec.ts +72 -80
  14. package/__tests__/features/use-fetch/use-fetch.hydration.spec.tsx +126 -0
  15. package/__tests__/features/use-fetch/use-fetch.infinite.spec.ts +146 -0
  16. package/__tests__/features/use-fetch/use-fetch.initial-state.spec.ts +340 -0
  17. package/__tests__/features/use-fetch/use-fetch.keys.spec.tsx +559 -0
  18. package/__tests__/features/use-fetch/use-fetch.lifecycle.spec.ts +348 -0
  19. package/__tests__/features/use-fetch/use-fetch.mounting.spec.tsx +411 -0
  20. package/__tests__/features/use-fetch/use-fetch.pagination.spec.ts +177 -0
  21. package/__tests__/features/use-fetch/use-fetch.refresh-interval.spec.ts +355 -0
  22. package/__tests__/features/use-fetch/use-fetch.refresh.spec.ts +36 -13
  23. package/__tests__/features/use-fetch/use-fetch.response-order.spec.ts +105 -0
  24. package/__tests__/features/use-fetch/use-fetch.retry.spec.ts +235 -0
  25. package/__tests__/features/use-fetch/use-fetch.return-types.spec.ts +186 -0
  26. package/__tests__/features/use-fetch/use-fetch.scope.spec.ts +333 -0
  27. package/__tests__/features/use-fetch/use-fetch.ssr.spec.tsx +195 -0
  28. package/__tests__/features/use-fetch/use-fetch.suspense-edge.spec.tsx +391 -0
  29. package/__tests__/features/use-fetch/use-fetch.throwing-callbacks.spec.tsx +112 -0
  30. package/__tests__/features/use-fetch/use-fetch.tracking.spec.tsx +364 -0
  31. package/__tests__/features/use-fetch/use-fetch.utils.spec.ts +11 -2
  32. package/__tests__/features/use-fetch/use-fetch.window-events.spec.ts +300 -0
  33. package/__tests__/features/use-infinite-fetch/use-infinite-fetch.parity.spec.tsx +1027 -0
  34. package/__tests__/features/use-infinite-fetch/use-infinite-fetch.resubscribe.spec.tsx +267 -0
  35. package/__tests__/features/use-infinite-fetch/use-infinite-fetch.typescript.spec.ts +64 -1
  36. package/__tests__/features/use-is-fetching/use-is-fetching.base.spec.tsx +19 -9
  37. package/__tests__/features/use-is-fetching/use-is-fetching.lifecycle.spec.tsx +301 -0
  38. package/__tests__/features/use-listener/use-listener.lifecycle.spec.tsx +507 -0
  39. package/__tests__/features/use-listener/use-listener.ssr.spec.tsx +89 -0
  40. package/__tests__/features/use-queue/use-queue.controls.spec.tsx +593 -0
  41. package/__tests__/features/use-queue/use-queue.list.spec.tsx +560 -0
  42. package/__tests__/features/use-queue/use-queue.progress.spec.tsx +650 -0
  43. package/__tests__/features/use-submit/use-submit.abort.spec.tsx +270 -0
  44. package/__tests__/features/use-submit/use-submit.actions.spec.tsx +446 -0
  45. package/__tests__/features/use-submit/use-submit.arguments.spec.tsx +732 -0
  46. package/__tests__/features/use-submit/use-submit.bounce.spec.tsx +644 -0
  47. package/__tests__/features/use-submit/use-submit.callbacks.spec.tsx +860 -0
  48. package/__tests__/features/use-submit/use-submit.chaining.spec.tsx +167 -0
  49. package/__tests__/features/use-submit/use-submit.concurrency.spec.ts +2 -1
  50. package/__tests__/features/use-submit/use-submit.debounce.spec.ts +100 -124
  51. package/__tests__/features/use-submit/use-submit.double-submit.spec.tsx +552 -0
  52. package/__tests__/features/use-submit/use-submit.offline.spec.tsx +285 -0
  53. package/__tests__/features/use-submit/use-submit.optimistic-cache.spec.tsx +619 -0
  54. package/__tests__/features/use-submit/use-submit.optimistic-settlement.spec.ts +8 -1
  55. package/__tests__/features/use-submit/use-submit.optimistic.spec.ts +5 -1
  56. package/__tests__/features/use-submit/use-submit.retry.spec.ts +51 -35
  57. package/__tests__/features/use-submit/use-submit.state.spec.tsx +1025 -0
  58. package/__tests__/features/use-submit/use-submit.submit-types.spec.ts +194 -0
  59. package/__tests__/features/use-submit/use-submit.submitting.spec.tsx +180 -0
  60. package/__tests__/features/use-submit/use-submit.unmount.spec.ts +2 -1
  61. package/__tests__/utils/gate.utils.ts +103 -0
  62. package/__tests__/utils/gated-client.utils.ts +158 -0
  63. package/__tests__/utils/helpers.utils.ts +19 -0
  64. package/__tests__/utils/use-queue.utils.ts +8 -4
  65. package/dist/helpers/use-request-events/use-request-events.hooks.d.ts.map +1 -1
  66. package/dist/helpers/use-request-events/use-request-events.types.d.ts +1 -1
  67. package/dist/helpers/use-request-events/use-request-events.types.d.ts.map +1 -1
  68. package/dist/helpers/use-tracked-state/use-tracked-state.hooks.d.ts.map +1 -1
  69. package/dist/helpers/use-tracked-state/use-tracked-state.utils.d.ts +8 -0
  70. package/dist/helpers/use-tracked-state/use-tracked-state.utils.d.ts.map +1 -1
  71. package/dist/hooks/use-cache/use-cache.hooks.d.ts.map +1 -1
  72. package/dist/hooks/use-fetch/use-fetch.hooks.d.ts.map +1 -1
  73. package/dist/hooks/use-infinite-fetch/use-infinite-fetch.hooks.d.ts.map +1 -1
  74. package/dist/hooks/use-infinite-fetch/use-infinite-fetch.store.d.ts +3 -0
  75. package/dist/hooks/use-infinite-fetch/use-infinite-fetch.store.d.ts.map +1 -1
  76. package/dist/hooks/use-infinite-fetch/use-infinite-fetch.types.d.ts +5 -3
  77. package/dist/hooks/use-infinite-fetch/use-infinite-fetch.types.d.ts.map +1 -1
  78. package/dist/hooks/use-infinite-fetch/use-infinite-fetch.utils.d.ts +11 -1
  79. package/dist/hooks/use-infinite-fetch/use-infinite-fetch.utils.d.ts.map +1 -1
  80. package/dist/hooks/use-listener/use-listener.hooks.d.ts.map +1 -1
  81. package/dist/hooks/use-queue/use-queue.hooks.d.ts.map +1 -1
  82. package/dist/hooks/use-submit/use-submit.hooks.d.ts.map +1 -1
  83. package/dist/index.mjs +633 -347
  84. package/dist/index.mjs.map +1 -1
  85. package/dist/provider/provider.d.ts.map +1 -1
  86. package/package.json +1 -1
  87. package/src/helpers/use-request-events/use-request-events.hooks.ts +147 -32
  88. package/src/helpers/use-request-events/use-request-events.types.ts +1 -1
  89. package/src/helpers/use-tracked-state/use-tracked-state.hooks.ts +148 -101
  90. package/src/helpers/use-tracked-state/use-tracked-state.utils.ts +26 -5
  91. package/src/hooks/use-cache/use-cache.hooks.ts +20 -5
  92. package/src/hooks/use-fetch/use-fetch.hooks.ts +194 -113
  93. package/src/hooks/use-infinite-fetch/use-infinite-fetch.hooks.ts +55 -26
  94. package/src/hooks/use-infinite-fetch/use-infinite-fetch.store.ts +35 -29
  95. package/src/hooks/use-infinite-fetch/use-infinite-fetch.types.ts +5 -3
  96. package/src/hooks/use-infinite-fetch/use-infinite-fetch.utils.ts +25 -1
  97. package/src/hooks/use-listener/use-listener.hooks.ts +2 -1
  98. package/src/hooks/use-queue/use-queue.hooks.ts +85 -60
  99. package/src/hooks/use-submit/use-submit.hooks.ts +163 -53
  100. package/src/provider/provider.tsx +9 -1
  101. package/__tests__/features/use-fetch/use-fetch.pagination.ts +0 -36
  102. package/__tests__/features/use-fetch/use-fetch.retry.ts +0 -38
@@ -0,0 +1,340 @@
1
+ import type { RequestInstance } from "@hyper-fetch/core";
2
+ import { act, renderHook } from "@testing-library/react";
3
+ import type { UseFetchOptionsType } from "hooks/use-fetch";
4
+ import { useFetch } from "hooks/use-fetch";
5
+
6
+ import { client, createRequest } from "../../utils";
7
+ import { advance, 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
+ /**
14
+ * Renders the hook and records the values returned by every render,
15
+ * so the very first render (before any effect) can be asserted.
16
+ */
17
+ const renderWithHistory = <T extends RequestInstance>(request: T, options?: UseFetchOptionsType<T>) => {
18
+ const renders: { data: unknown; loading: boolean; success: boolean; status: unknown; error: unknown }[] = [];
19
+ const view = renderHook(() => {
20
+ const state = useFetch(request, options);
21
+ renders.push({
22
+ data: state.data,
23
+ loading: state.loading,
24
+ success: state.success,
25
+ status: state.status,
26
+ error: state.error,
27
+ });
28
+ return state;
29
+ });
30
+ return { ...view, renders };
31
+ };
32
+
33
+ describe("useFetch [ Initial State ]", () => {
34
+ let request = createRequest<User>();
35
+ let calls = gateRequest(request);
36
+
37
+ beforeEach(() => {
38
+ vi.useFakeTimers();
39
+ client.clear();
40
+ request = createRequest<User>();
41
+ calls = gateRequest(request);
42
+ });
43
+
44
+ afterEach(() => {
45
+ vi.useRealTimers();
46
+ });
47
+
48
+ describe("when there is no data", () => {
49
+ it("should start with empty loading state", async () => {
50
+ const { result, renders } = renderWithHistory(request);
51
+
52
+ expect(renders[0]).toStrictEqual({ data: null, loading: true, success: false, status: null, error: null });
53
+ expect(result.current.retries).toBe(0);
54
+ expect(result.current.responseTimestamp).toBeNull();
55
+ expect(result.current.requestTimestamp).toBeNull();
56
+ });
57
+ it("should send exactly one request", async () => {
58
+ renderWithHistory(request);
59
+ await advance();
60
+
61
+ expect(calls).toHaveLength(1);
62
+ });
63
+ it.each([true, false])("should send the request when revalidate is %s", async (revalidate) => {
64
+ const { renders } = renderWithHistory(request, { revalidate });
65
+ await advance();
66
+
67
+ expect(renders[0].loading).toBeTrue();
68
+ expect(calls).toHaveLength(1);
69
+ });
70
+ it("should not load nor send the request when disabled", async () => {
71
+ const { renders } = renderWithHistory(request, { disabled: true });
72
+ await advance();
73
+
74
+ expect(renders).toHaveLength(1);
75
+ expect(renders[0]).toStrictEqual({ data: null, loading: false, success: false, status: null, error: null });
76
+ expect(calls).toHaveLength(0);
77
+ });
78
+ it("should expose the default adapter extra", async () => {
79
+ const { result } = renderWithHistory(request);
80
+
81
+ expect(result.current.extra).toStrictEqual(client.adapter.defaultExtra);
82
+ });
83
+ });
84
+
85
+ describe("when cache holds fresh data", () => {
86
+ beforeEach(() => {
87
+ setCacheResponse(request, user);
88
+ });
89
+
90
+ it("should return cached data on the very first render", async () => {
91
+ const { renders, result } = renderWithHistory(request);
92
+
93
+ expect(renders[0].data).toStrictEqual(user);
94
+ expect(renders[0].success).toBeTrue();
95
+ expect(renders[0].status).toBe(200);
96
+ expect(renders[0].error).toBeNull();
97
+ expect(result.current.responseTimestamp).toBeDate();
98
+ expect(result.current.requestTimestamp).toBeDate();
99
+ });
100
+ it("should revalidate it in the background by default", async () => {
101
+ const { result } = renderWithHistory(request);
102
+ await advance();
103
+
104
+ expect(calls).toHaveLength(1);
105
+ expect(result.current.loading).toBeTrue();
106
+ expect(result.current.data).toStrictEqual(user);
107
+ });
108
+ it("should not send any request when revalidate is off", async () => {
109
+ const { renders } = renderWithHistory(request, { revalidate: false });
110
+ await advance();
111
+
112
+ expect(calls).toHaveLength(0);
113
+ expect(renders.every((render) => !render.loading)).toBeTrue();
114
+ expect(renders.at(-1)?.data).toStrictEqual(user);
115
+ });
116
+ it("should not send any request when disabled", async () => {
117
+ const { renders } = renderWithHistory(request, { disabled: true });
118
+ await advance();
119
+
120
+ expect(calls).toHaveLength(0);
121
+ expect(renders.every((render) => !render.loading)).toBeTrue();
122
+ expect(renders.at(-1)?.data).toStrictEqual(user);
123
+ });
124
+ it("should keep the cached data reference", async () => {
125
+ const cached = client.cache.get(request.cacheKey)?.data;
126
+ const { result } = renderWithHistory(request, { revalidate: false });
127
+
128
+ expect(result.current.data).toBe(cached);
129
+ });
130
+ });
131
+
132
+ describe("when cache holds stale data", () => {
133
+ beforeEach(() => {
134
+ request = createRequest<User>({ staleTime: 1000 });
135
+ calls = gateRequest(request);
136
+ setCacheResponse(request, user);
137
+ vi.advanceTimersByTime(1001);
138
+ });
139
+
140
+ it("should show stale data while revalidating", async () => {
141
+ const { renders, result } = renderWithHistory(request);
142
+ await advance();
143
+
144
+ expect(renders[0].data).toStrictEqual(user);
145
+ expect(result.current.data).toStrictEqual(user);
146
+ expect(result.current.loading).toBeTrue();
147
+ expect(calls).toHaveLength(1);
148
+ });
149
+ it("should refetch stale data even when revalidate is off", async () => {
150
+ const { result } = renderWithHistory(request, { revalidate: false });
151
+ await advance();
152
+
153
+ expect(calls).toHaveLength(1);
154
+ expect(result.current.loading).toBeTrue();
155
+ expect(result.current.data).toStrictEqual(user);
156
+ });
157
+ it("should not refetch stale data when disabled", async () => {
158
+ const { result } = renderWithHistory(request, { disabled: true });
159
+ await advance();
160
+
161
+ expect(calls).toHaveLength(0);
162
+ expect(result.current.loading).toBeFalse();
163
+ expect(result.current.data).toStrictEqual(user);
164
+ });
165
+ it("should replace stale data with the response", async () => {
166
+ const { result } = renderWithHistory(request);
167
+ await advance();
168
+
169
+ calls[0].succeed({ id: 1, name: "Updated" });
170
+ await settle();
171
+
172
+ expect(result.current.data).toStrictEqual({ id: 1, name: "Updated" });
173
+ expect(result.current.loading).toBeFalse();
174
+ });
175
+ it("should treat data right before the stale time as fresh", async () => {
176
+ client.clear();
177
+ request = createRequest<User>({ staleTime: 1000 });
178
+ calls = gateRequest(request);
179
+ setCacheResponse(request, user);
180
+ vi.advanceTimersByTime(999);
181
+
182
+ renderWithHistory(request, { revalidate: false });
183
+ await advance();
184
+
185
+ expect(calls).toHaveLength(0);
186
+ });
187
+ });
188
+
189
+ describe("when initial response is provided", () => {
190
+ const initialResponse = { data: { id: 99, name: "Initial" }, status: 200, success: true };
191
+
192
+ it("should return it on the very first render", async () => {
193
+ const { renders } = renderWithHistory(request, { initialResponse });
194
+
195
+ expect(renders[0].data).toStrictEqual(initialResponse.data);
196
+ expect(renders[0].status).toBe(200);
197
+ expect(renders[0].success).toBeTrue();
198
+ });
199
+ it("should still fetch the real data", async () => {
200
+ const { result } = renderWithHistory(request, { initialResponse });
201
+ await advance();
202
+ expect(calls).toHaveLength(1);
203
+
204
+ calls[0].succeed(user);
205
+ await settle();
206
+
207
+ expect(result.current.data).toStrictEqual(user);
208
+ });
209
+ it("should keep it without any request when disabled", async () => {
210
+ const { result } = renderWithHistory(request, { initialResponse, disabled: true });
211
+ await advance();
212
+
213
+ expect(calls).toHaveLength(0);
214
+ expect(result.current.data).toStrictEqual(initialResponse.data);
215
+ expect(result.current.loading).toBeFalse();
216
+ });
217
+ it("should prefer the cached data", async () => {
218
+ setCacheResponse(request, user);
219
+ const { renders } = renderWithHistory(request, { initialResponse, revalidate: false });
220
+
221
+ expect(renders[0].data).toStrictEqual(user);
222
+ });
223
+ it("should not write the initial response to the cache", async () => {
224
+ renderWithHistory(request, { initialResponse, disabled: true });
225
+ await advance();
226
+
227
+ expect(client.cache.get(request.cacheKey)).toBeUndefined();
228
+ });
229
+ it.each([0, false, ""])("should accept falsy initial data: %j", async (data) => {
230
+ const falsyRequest = createRequest<typeof data>();
231
+ const { renders } = renderWithHistory(falsyRequest, { initialResponse: { data }, disabled: true });
232
+
233
+ expect(renders[0].data).toBe(data);
234
+ });
235
+ it("should allow to pass an error as initial response", async () => {
236
+ const error = new Error("Initial error");
237
+ const { renders } = renderWithHistory(request, {
238
+ initialResponse: { data: null, error, success: false, status: 500 },
239
+ disabled: true,
240
+ });
241
+
242
+ expect(renders[0]).toStrictEqual({ data: null, loading: false, success: false, status: 500, error });
243
+ });
244
+ });
245
+
246
+ describe("when the request is already running", () => {
247
+ it("should join the running request instead of sending another one", async () => {
248
+ act(() => {
249
+ client.fetchDispatcher.add(request);
250
+ });
251
+ await advance();
252
+
253
+ const { renders, result } = renderWithHistory(request);
254
+ await advance();
255
+
256
+ expect(renders[0].loading).toBeTrue();
257
+ expect(calls).toHaveLength(1);
258
+
259
+ calls[0].succeed(user);
260
+ await settle();
261
+
262
+ expect(result.current.data).toStrictEqual(user);
263
+ expect(result.current.loading).toBeFalse();
264
+ });
265
+ it("should show loading in the disabled hook", async () => {
266
+ act(() => {
267
+ client.fetchDispatcher.add(request);
268
+ });
269
+ await advance();
270
+
271
+ const { renders, result } = renderWithHistory(request, { disabled: true });
272
+
273
+ expect(renders[0].loading).toBeTrue();
274
+
275
+ calls[0].succeed(user);
276
+ await settle();
277
+
278
+ expect(calls).toHaveLength(1);
279
+ expect(result.current.data).toStrictEqual(user);
280
+ expect(result.current.loading).toBeFalse();
281
+ });
282
+ it("should not start in loading state when the queue is stopped", async () => {
283
+ act(() => {
284
+ client.fetchDispatcher.stop(request.queryKey);
285
+ });
286
+
287
+ const { renders } = renderWithHistory(request);
288
+
289
+ expect(renders[0].loading).toBeFalse();
290
+ });
291
+ });
292
+
293
+ describe("when options are passed as undefined", () => {
294
+ it("should use the default values", async () => {
295
+ setCacheResponse(request, user);
296
+ const { result } = renderWithHistory(request, {
297
+ revalidate: undefined,
298
+ disabled: undefined,
299
+ dependencies: undefined,
300
+ deepCompare: undefined,
301
+ refresh: undefined,
302
+ refreshTime: undefined,
303
+ initialResponse: undefined,
304
+ keepPreviousData: undefined,
305
+ });
306
+ await advance();
307
+
308
+ // Default revalidation still happens
309
+ expect(calls).toHaveLength(1);
310
+ expect(result.current.data).toStrictEqual(user);
311
+ });
312
+ });
313
+
314
+ describe("when options are not passed", () => {
315
+ it("should work without the options argument", async () => {
316
+ const { result } = renderHook(() => {
317
+ const { data } = useFetch(request);
318
+ return { data };
319
+ });
320
+ await advance();
321
+
322
+ calls[0].succeed(user);
323
+ await settle();
324
+
325
+ expect(result.current.data).toStrictEqual(user);
326
+ });
327
+ it("should work with empty options", async () => {
328
+ const { result } = renderHook(() => {
329
+ const { data } = useFetch(request, {});
330
+ return { data };
331
+ });
332
+ await advance();
333
+
334
+ calls[0].succeed(user);
335
+ await settle();
336
+
337
+ expect(result.current.data).toStrictEqual(user);
338
+ });
339
+ });
340
+ });