@hyper-fetch/react 9.6.1 → 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.
- package/__tests__/features/helpers/use-tracked-state/use-tacked-state.actions.spec.ts +1 -1
- package/__tests__/features/helpers/use-tracked-state/use-tracked-state.keys.spec.ts +294 -0
- package/__tests__/features/helpers/utils.spec.ts +127 -0
- package/__tests__/features/provider/provider.config.spec.tsx +172 -0
- package/__tests__/features/use-app-manager/use-app-manager.events.spec.tsx +497 -0
- package/__tests__/features/use-cache/use-cache.state.spec.tsx +326 -0
- package/__tests__/features/use-emitter/use-emitter.lifecycle.spec.tsx +417 -0
- package/__tests__/features/use-fetch/use-fetch.bounce-timers.spec.ts +199 -0
- package/__tests__/features/use-fetch/use-fetch.cache-events.spec.ts +212 -0
- package/__tests__/features/use-fetch/use-fetch.callbacks.spec.tsx +359 -0
- package/__tests__/features/use-fetch/use-fetch.hydration.spec.tsx +126 -0
- package/__tests__/features/use-fetch/use-fetch.infinite.spec.ts +146 -0
- package/__tests__/features/use-fetch/use-fetch.initial-state.spec.ts +340 -0
- package/__tests__/features/use-fetch/use-fetch.keys.spec.tsx +559 -0
- package/__tests__/features/use-fetch/use-fetch.lifecycle.spec.ts +348 -0
- package/__tests__/features/use-fetch/use-fetch.mounting.spec.tsx +411 -0
- package/__tests__/features/use-fetch/use-fetch.pagination.spec.ts +177 -0
- package/__tests__/features/use-fetch/use-fetch.refresh-interval.spec.ts +355 -0
- package/__tests__/features/use-fetch/use-fetch.response-order.spec.ts +105 -0
- package/__tests__/features/use-fetch/use-fetch.retry.spec.ts +235 -0
- package/__tests__/features/use-fetch/use-fetch.return-types.spec.ts +186 -0
- package/__tests__/features/use-fetch/use-fetch.scope.spec.ts +333 -0
- package/__tests__/features/use-fetch/use-fetch.ssr.spec.tsx +195 -0
- package/__tests__/features/use-fetch/use-fetch.suspense-edge.spec.tsx +391 -0
- package/__tests__/features/use-fetch/use-fetch.throwing-callbacks.spec.tsx +112 -0
- package/__tests__/features/use-fetch/use-fetch.tracking.spec.tsx +364 -0
- package/__tests__/features/use-fetch/use-fetch.window-events.spec.ts +300 -0
- package/__tests__/features/use-infinite-fetch/use-infinite-fetch.parity.spec.tsx +1027 -0
- package/__tests__/features/use-infinite-fetch/use-infinite-fetch.resubscribe.spec.tsx +267 -0
- package/__tests__/features/use-infinite-fetch/use-infinite-fetch.typescript.spec.ts +64 -1
- package/__tests__/features/use-is-fetching/use-is-fetching.lifecycle.spec.tsx +301 -0
- package/__tests__/features/use-listener/use-listener.lifecycle.spec.tsx +507 -0
- package/__tests__/features/use-listener/use-listener.ssr.spec.tsx +89 -0
- package/__tests__/features/use-queue/use-queue.controls.spec.tsx +593 -0
- package/__tests__/features/use-queue/use-queue.list.spec.tsx +560 -0
- package/__tests__/features/use-queue/use-queue.progress.spec.tsx +650 -0
- package/__tests__/features/use-submit/use-submit.abort.spec.tsx +270 -0
- package/__tests__/features/use-submit/use-submit.actions.spec.tsx +446 -0
- package/__tests__/features/use-submit/use-submit.arguments.spec.tsx +732 -0
- package/__tests__/features/use-submit/use-submit.bounce.spec.tsx +644 -0
- package/__tests__/features/use-submit/use-submit.callbacks.spec.tsx +860 -0
- package/__tests__/features/use-submit/use-submit.chaining.spec.tsx +167 -0
- package/__tests__/features/use-submit/use-submit.double-submit.spec.tsx +552 -0
- package/__tests__/features/use-submit/use-submit.offline.spec.tsx +285 -0
- package/__tests__/features/use-submit/use-submit.optimistic-cache.spec.tsx +619 -0
- package/__tests__/features/use-submit/use-submit.optimistic-settlement.spec.ts +6 -0
- package/__tests__/features/use-submit/use-submit.optimistic.spec.ts +5 -1
- package/__tests__/features/use-submit/use-submit.state.spec.tsx +1025 -0
- package/__tests__/features/use-submit/use-submit.submit-types.spec.ts +194 -0
- package/__tests__/features/use-submit/use-submit.submitting.spec.tsx +180 -0
- package/__tests__/utils/gate.utils.ts +103 -0
- package/__tests__/utils/gated-client.utils.ts +158 -0
- package/__tests__/utils/helpers.utils.ts +19 -0
- package/dist/helpers/use-request-events/use-request-events.hooks.d.ts.map +1 -1
- package/dist/helpers/use-request-events/use-request-events.types.d.ts +1 -1
- package/dist/helpers/use-request-events/use-request-events.types.d.ts.map +1 -1
- package/dist/helpers/use-tracked-state/use-tracked-state.hooks.d.ts.map +1 -1
- package/dist/helpers/use-tracked-state/use-tracked-state.utils.d.ts +8 -0
- package/dist/helpers/use-tracked-state/use-tracked-state.utils.d.ts.map +1 -1
- package/dist/hooks/use-cache/use-cache.hooks.d.ts.map +1 -1
- package/dist/hooks/use-fetch/use-fetch.hooks.d.ts.map +1 -1
- package/dist/hooks/use-infinite-fetch/use-infinite-fetch.hooks.d.ts.map +1 -1
- package/dist/hooks/use-infinite-fetch/use-infinite-fetch.store.d.ts +3 -0
- package/dist/hooks/use-infinite-fetch/use-infinite-fetch.store.d.ts.map +1 -1
- package/dist/hooks/use-infinite-fetch/use-infinite-fetch.types.d.ts +5 -3
- package/dist/hooks/use-infinite-fetch/use-infinite-fetch.types.d.ts.map +1 -1
- package/dist/hooks/use-infinite-fetch/use-infinite-fetch.utils.d.ts +11 -1
- package/dist/hooks/use-infinite-fetch/use-infinite-fetch.utils.d.ts.map +1 -1
- package/dist/hooks/use-listener/use-listener.hooks.d.ts.map +1 -1
- package/dist/hooks/use-queue/use-queue.hooks.d.ts.map +1 -1
- package/dist/hooks/use-submit/use-submit.hooks.d.ts.map +1 -1
- package/dist/index.mjs +630 -346
- package/dist/index.mjs.map +1 -1
- package/dist/provider/provider.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/helpers/use-request-events/use-request-events.hooks.ts +141 -28
- package/src/helpers/use-request-events/use-request-events.types.ts +1 -1
- package/src/helpers/use-tracked-state/use-tracked-state.hooks.ts +148 -101
- package/src/helpers/use-tracked-state/use-tracked-state.utils.ts +26 -5
- package/src/hooks/use-cache/use-cache.hooks.ts +20 -5
- package/src/hooks/use-fetch/use-fetch.hooks.ts +194 -113
- package/src/hooks/use-infinite-fetch/use-infinite-fetch.hooks.ts +55 -26
- package/src/hooks/use-infinite-fetch/use-infinite-fetch.store.ts +35 -29
- package/src/hooks/use-infinite-fetch/use-infinite-fetch.types.ts +5 -3
- package/src/hooks/use-infinite-fetch/use-infinite-fetch.utils.ts +25 -1
- package/src/hooks/use-listener/use-listener.hooks.ts +2 -1
- package/src/hooks/use-queue/use-queue.hooks.ts +85 -60
- package/src/hooks/use-submit/use-submit.hooks.ts +163 -53
- package/src/provider/provider.tsx +9 -1
- package/__tests__/features/use-fetch/use-fetch.pagination.ts +0 -36
- package/__tests__/features/use-fetch/use-fetch.retry.ts +0 -38
|
@@ -0,0 +1,270 @@
|
|
|
1
|
+
import { getErrorMessage, scopeKey } from "@hyper-fetch/core";
|
|
2
|
+
import { act, renderHook, waitFor } from "@testing-library/react";
|
|
3
|
+
import { useSubmit } from "hooks/use-submit";
|
|
4
|
+
import { StrictMode } from "react";
|
|
5
|
+
|
|
6
|
+
import { createGatedClient } from "../../utils/gated-client.utils";
|
|
7
|
+
|
|
8
|
+
type User = { id: number; name: string };
|
|
9
|
+
|
|
10
|
+
const setup = (options?: { queued?: boolean }) => {
|
|
11
|
+
const gated = createGatedClient();
|
|
12
|
+
const request = gated.client.createRequest<{ response: User; payload: { name: string } }>()({
|
|
13
|
+
endpoint: "/users",
|
|
14
|
+
method: "POST",
|
|
15
|
+
queued: options?.queued ?? false,
|
|
16
|
+
deduplicate: false,
|
|
17
|
+
});
|
|
18
|
+
return { ...gated, request };
|
|
19
|
+
};
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
* `abort()` takes the request out of the dispatcher. Nothing answers such a request anymore, so the removal is what
|
|
23
|
+
* ends it for the hook: the abort and the finished callbacks run, like the docs describe.
|
|
24
|
+
*/
|
|
25
|
+
describe("useSubmit [ Abort ]", () => {
|
|
26
|
+
const renderSubmit = (request: ReturnType<typeof setup>["request"], wrapper?: typeof StrictMode) => {
|
|
27
|
+
const onAbort = vi.fn();
|
|
28
|
+
const onFinished = vi.fn();
|
|
29
|
+
const onError = vi.fn();
|
|
30
|
+
const onSuccess = vi.fn();
|
|
31
|
+
const view = renderHook(
|
|
32
|
+
() => {
|
|
33
|
+
const submit = useSubmit(request, { dependencyTracking: false });
|
|
34
|
+
submit.onSubmitAbort(onAbort);
|
|
35
|
+
submit.onSubmitFinished(onFinished);
|
|
36
|
+
submit.onSubmitError(onError);
|
|
37
|
+
submit.onSubmitSuccess(onSuccess);
|
|
38
|
+
return submit;
|
|
39
|
+
},
|
|
40
|
+
{ wrapper },
|
|
41
|
+
);
|
|
42
|
+
|
|
43
|
+
return { ...view, onAbort, onFinished, onError, onSuccess };
|
|
44
|
+
};
|
|
45
|
+
|
|
46
|
+
describe("when the request in flight is aborted with the hook", () => {
|
|
47
|
+
it("should call the abort and the finished callbacks once", async () => {
|
|
48
|
+
const { request, waitForCall } = setup();
|
|
49
|
+
const { result, onAbort, onFinished, onError, onSuccess } = renderSubmit(request);
|
|
50
|
+
let promise: Promise<unknown> = Promise.resolve();
|
|
51
|
+
act(() => {
|
|
52
|
+
promise = result.current.submit({ payload: { name: "Maciej" } });
|
|
53
|
+
});
|
|
54
|
+
await waitForCall(0);
|
|
55
|
+
|
|
56
|
+
await act(async () => {
|
|
57
|
+
result.current.abort();
|
|
58
|
+
await promise;
|
|
59
|
+
});
|
|
60
|
+
await waitFor(() => {
|
|
61
|
+
expect(result.current.submitting).toBeFalse();
|
|
62
|
+
});
|
|
63
|
+
|
|
64
|
+
expect(onAbort).toHaveBeenCalledTimes(1);
|
|
65
|
+
expect(onFinished).toHaveBeenCalledTimes(1);
|
|
66
|
+
expect(onError).not.toHaveBeenCalled();
|
|
67
|
+
expect(onSuccess).not.toHaveBeenCalled();
|
|
68
|
+
});
|
|
69
|
+
|
|
70
|
+
it("should pass the response that submit resolves with", async () => {
|
|
71
|
+
const { request, waitForCall } = setup();
|
|
72
|
+
const { result, onAbort } = renderSubmit(request);
|
|
73
|
+
let promise: ReturnType<typeof result.current.submit> | undefined;
|
|
74
|
+
act(() => {
|
|
75
|
+
promise = result.current.submit({ payload: { name: "Maciej" } });
|
|
76
|
+
});
|
|
77
|
+
const call = await waitForCall(0);
|
|
78
|
+
|
|
79
|
+
let resolved: Awaited<ReturnType<typeof result.current.submit>> | undefined;
|
|
80
|
+
await act(async () => {
|
|
81
|
+
result.current.abort();
|
|
82
|
+
resolved = await promise;
|
|
83
|
+
});
|
|
84
|
+
|
|
85
|
+
const [params] = onAbort.mock.calls[0];
|
|
86
|
+
expect(params.requestId).toBe(call.requestId);
|
|
87
|
+
expect(params.details.isCanceled).toBeTrue();
|
|
88
|
+
expect(params.response.success).toBeFalse();
|
|
89
|
+
expect(params.response.data).toBeNull();
|
|
90
|
+
expect(params.response.error).toStrictEqual(getErrorMessage("deleted"));
|
|
91
|
+
expect(resolved?.error).toStrictEqual(params.response.error);
|
|
92
|
+
expect(call.aborted).toBeTrue();
|
|
93
|
+
});
|
|
94
|
+
|
|
95
|
+
it("should pass the context of the optimistic update", async () => {
|
|
96
|
+
const { request, waitForCall } = setup();
|
|
97
|
+
const optimistic = request.setOptimistic(() => ({ context: { previousName: "Old name" } }));
|
|
98
|
+
const onAbort = vi.fn();
|
|
99
|
+
const { result } = renderHook(() => {
|
|
100
|
+
const submit = useSubmit(optimistic, { dependencyTracking: false });
|
|
101
|
+
submit.onSubmitAbort(onAbort);
|
|
102
|
+
return submit;
|
|
103
|
+
});
|
|
104
|
+
let promise: Promise<unknown> = Promise.resolve();
|
|
105
|
+
act(() => {
|
|
106
|
+
promise = result.current.submit({ payload: { name: "Maciej" } });
|
|
107
|
+
});
|
|
108
|
+
await waitForCall(0);
|
|
109
|
+
|
|
110
|
+
await act(async () => {
|
|
111
|
+
result.current.abort();
|
|
112
|
+
await promise;
|
|
113
|
+
});
|
|
114
|
+
|
|
115
|
+
expect(onAbort).toHaveBeenCalledTimes(1);
|
|
116
|
+
expect(onAbort.mock.calls[0][0].mutationContext).toStrictEqual({ previousName: "Old name" });
|
|
117
|
+
});
|
|
118
|
+
|
|
119
|
+
it("should call the callbacks from the latest render", async () => {
|
|
120
|
+
const { request, waitForCall } = setup();
|
|
121
|
+
const first = vi.fn();
|
|
122
|
+
const second = vi.fn();
|
|
123
|
+
const { result, rerender } = renderHook(
|
|
124
|
+
({ onAbort }) => {
|
|
125
|
+
const submit = useSubmit(request, { dependencyTracking: false });
|
|
126
|
+
submit.onSubmitAbort(onAbort);
|
|
127
|
+
return submit;
|
|
128
|
+
},
|
|
129
|
+
{ initialProps: { onAbort: first } },
|
|
130
|
+
);
|
|
131
|
+
let promise: Promise<unknown> = Promise.resolve();
|
|
132
|
+
act(() => {
|
|
133
|
+
promise = result.current.submit({ payload: { name: "Maciej" } });
|
|
134
|
+
});
|
|
135
|
+
await waitForCall(0);
|
|
136
|
+
rerender({ onAbort: second });
|
|
137
|
+
|
|
138
|
+
await act(async () => {
|
|
139
|
+
result.current.abort();
|
|
140
|
+
await promise;
|
|
141
|
+
});
|
|
142
|
+
|
|
143
|
+
expect(first).not.toHaveBeenCalled();
|
|
144
|
+
expect(second).toHaveBeenCalledTimes(1);
|
|
145
|
+
});
|
|
146
|
+
|
|
147
|
+
it("should call the callbacks once in StrictMode", async () => {
|
|
148
|
+
const { request, waitForCall } = setup();
|
|
149
|
+
const { result, onAbort, onFinished } = renderSubmit(request, StrictMode);
|
|
150
|
+
let promise: Promise<unknown> = Promise.resolve();
|
|
151
|
+
act(() => {
|
|
152
|
+
promise = result.current.submit({ payload: { name: "Maciej" } });
|
|
153
|
+
});
|
|
154
|
+
await waitForCall(0);
|
|
155
|
+
|
|
156
|
+
await act(async () => {
|
|
157
|
+
result.current.abort();
|
|
158
|
+
await promise;
|
|
159
|
+
});
|
|
160
|
+
|
|
161
|
+
expect(onAbort).toHaveBeenCalledTimes(1);
|
|
162
|
+
expect(onFinished).toHaveBeenCalledTimes(1);
|
|
163
|
+
});
|
|
164
|
+
|
|
165
|
+
it("should let the next submit succeed", async () => {
|
|
166
|
+
const { request, waitForCall } = setup();
|
|
167
|
+
const { result, onAbort, onSuccess, onFinished } = renderSubmit(request);
|
|
168
|
+
let promise: Promise<unknown> = Promise.resolve();
|
|
169
|
+
act(() => {
|
|
170
|
+
promise = result.current.submit({ payload: { name: "First" } });
|
|
171
|
+
});
|
|
172
|
+
await waitForCall(0);
|
|
173
|
+
await act(async () => {
|
|
174
|
+
result.current.abort();
|
|
175
|
+
await promise;
|
|
176
|
+
});
|
|
177
|
+
|
|
178
|
+
act(() => {
|
|
179
|
+
promise = result.current.submit({ payload: { name: "Second" } });
|
|
180
|
+
});
|
|
181
|
+
const call = await waitForCall(1);
|
|
182
|
+
await act(async () => {
|
|
183
|
+
call.succeed({ id: 2, name: "Second" });
|
|
184
|
+
await promise;
|
|
185
|
+
});
|
|
186
|
+
|
|
187
|
+
expect(onAbort).toHaveBeenCalledTimes(1);
|
|
188
|
+
expect(onSuccess).toHaveBeenCalledTimes(1);
|
|
189
|
+
expect(onFinished).toHaveBeenCalledTimes(2);
|
|
190
|
+
expect(result.current.data).toStrictEqual({ id: 2, name: "Second" });
|
|
191
|
+
});
|
|
192
|
+
});
|
|
193
|
+
|
|
194
|
+
describe("when the request is removed from the queue before it was sent", () => {
|
|
195
|
+
it("should call the abort and the finished callbacks for the removed request only", async () => {
|
|
196
|
+
const { client, request, waitForCall } = setup({ queued: true });
|
|
197
|
+
const { result, onAbort, onFinished, onSuccess } = renderSubmit(request);
|
|
198
|
+
let promises: Promise<unknown>[] = [];
|
|
199
|
+
act(() => {
|
|
200
|
+
promises = ["First", "Second"].map((name) => result.current.submit({ payload: { name } }));
|
|
201
|
+
});
|
|
202
|
+
const call = await waitForCall(0);
|
|
203
|
+
const queryKey = scopeKey(request.queryKey, request.scope);
|
|
204
|
+
const [, waiting] = client.submitDispatcher.getQueue(queryKey).requests;
|
|
205
|
+
|
|
206
|
+
await act(async () => {
|
|
207
|
+
client.submitDispatcher.delete(queryKey, waiting.requestId, scopeKey(request.abortKey, request.scope));
|
|
208
|
+
await promises[1];
|
|
209
|
+
});
|
|
210
|
+
expect(onAbort).toHaveBeenCalledTimes(1);
|
|
211
|
+
expect(onAbort.mock.calls[0][0].requestId).toBe(waiting.requestId);
|
|
212
|
+
|
|
213
|
+
await act(async () => {
|
|
214
|
+
call.succeed({ id: 1, name: "First" });
|
|
215
|
+
await promises[0];
|
|
216
|
+
});
|
|
217
|
+
|
|
218
|
+
expect(onAbort).toHaveBeenCalledTimes(1);
|
|
219
|
+
expect(onSuccess).toHaveBeenCalledTimes(1);
|
|
220
|
+
expect(onFinished).toHaveBeenCalledTimes(2);
|
|
221
|
+
});
|
|
222
|
+
});
|
|
223
|
+
|
|
224
|
+
describe("when the request ends on its own", () => {
|
|
225
|
+
it.each([
|
|
226
|
+
["succeeds", true],
|
|
227
|
+
["fails", false],
|
|
228
|
+
])("should not call the abort callback when it %s", async (_name, success) => {
|
|
229
|
+
const { request, waitForCall } = setup();
|
|
230
|
+
const { result, onAbort, onFinished } = renderSubmit(request);
|
|
231
|
+
let promise: Promise<unknown> = Promise.resolve();
|
|
232
|
+
act(() => {
|
|
233
|
+
promise = result.current.submit({ payload: { name: "Maciej" } });
|
|
234
|
+
});
|
|
235
|
+
const call = await waitForCall(0);
|
|
236
|
+
|
|
237
|
+
await act(async () => {
|
|
238
|
+
if (success) {
|
|
239
|
+
call.succeed({ id: 1, name: "Maciej" });
|
|
240
|
+
} else {
|
|
241
|
+
call.fail({ message: "Failed" }, 400);
|
|
242
|
+
}
|
|
243
|
+
await promise;
|
|
244
|
+
});
|
|
245
|
+
|
|
246
|
+
expect(onAbort).not.toHaveBeenCalled();
|
|
247
|
+
expect(onFinished).toHaveBeenCalledTimes(1);
|
|
248
|
+
});
|
|
249
|
+
});
|
|
250
|
+
|
|
251
|
+
describe("when the hook unmounts before the request is removed", () => {
|
|
252
|
+
it("should not call any callback", async () => {
|
|
253
|
+
const { client, request, waitForCall } = setup();
|
|
254
|
+
const { result, unmount, onAbort, onFinished } = renderSubmit(request);
|
|
255
|
+
let promise: Promise<unknown> = Promise.resolve();
|
|
256
|
+
act(() => {
|
|
257
|
+
promise = result.current.submit({ payload: { name: "Maciej" } });
|
|
258
|
+
});
|
|
259
|
+
const call = await waitForCall(0);
|
|
260
|
+
unmount();
|
|
261
|
+
|
|
262
|
+
const queryKey = scopeKey(request.queryKey, request.scope);
|
|
263
|
+
client.submitDispatcher.delete(queryKey, call.requestId, scopeKey(request.abortKey, request.scope));
|
|
264
|
+
await promise;
|
|
265
|
+
|
|
266
|
+
expect(onAbort).not.toHaveBeenCalled();
|
|
267
|
+
expect(onFinished).not.toHaveBeenCalled();
|
|
268
|
+
});
|
|
269
|
+
});
|
|
270
|
+
});
|