@hyper-fetch/react 9.5.1 → 9.6.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/__tests__/features/helpers/use-request-events/use-request-events.mapper-failure.spec.ts +215 -0
- package/__tests__/features/use-infinite-fetch/use-infinite-fetch.base.spec.tsx +745 -0
- package/__tests__/features/use-infinite-fetch/use-infinite-fetch.boundaries.spec.tsx +362 -0
- package/__tests__/features/use-infinite-fetch/use-infinite-fetch.edge.spec.tsx +1043 -0
- package/__tests__/features/use-infinite-fetch/use-infinite-fetch.matrix.spec.tsx +441 -0
- package/__tests__/features/use-infinite-fetch/use-infinite-fetch.random.spec.tsx +121 -0
- package/__tests__/features/use-infinite-fetch/use-infinite-fetch.refetch.spec.tsx +567 -0
- package/__tests__/features/use-infinite-fetch/use-infinite-fetch.start-over.spec.tsx +353 -0
- package/__tests__/features/use-infinite-fetch/use-infinite-fetch.typescript.spec.ts +128 -0
- package/__tests__/features/use-submit/use-submit.unmount.spec.ts +310 -0
- package/__tests__/utils/use-infinite-fetch.modes.ts +131 -0
- package/__tests__/utils/use-infinite-fetch.utils.ts +90 -0
- package/dist/helpers/use-request-events/use-request-events.hooks.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.map +1 -1
- package/dist/hooks/use-infinite-fetch/index.d.ts +4 -0
- package/dist/hooks/use-infinite-fetch/index.d.ts.map +1 -0
- package/dist/hooks/use-infinite-fetch/use-infinite-fetch.constants.d.ts +22 -0
- package/dist/hooks/use-infinite-fetch/use-infinite-fetch.constants.d.ts.map +1 -0
- package/dist/hooks/use-infinite-fetch/use-infinite-fetch.hooks.d.ts +21 -0
- package/dist/hooks/use-infinite-fetch/use-infinite-fetch.hooks.d.ts.map +1 -0
- package/dist/hooks/use-infinite-fetch/use-infinite-fetch.requests.d.ts +19 -0
- package/dist/hooks/use-infinite-fetch/use-infinite-fetch.requests.d.ts.map +1 -0
- package/dist/hooks/use-infinite-fetch/use-infinite-fetch.store.d.ts +119 -0
- package/dist/hooks/use-infinite-fetch/use-infinite-fetch.store.d.ts.map +1 -0
- package/dist/hooks/use-infinite-fetch/use-infinite-fetch.store.types.d.ts +48 -0
- package/dist/hooks/use-infinite-fetch/use-infinite-fetch.store.types.d.ts.map +1 -0
- package/dist/hooks/use-infinite-fetch/use-infinite-fetch.types.d.ts +172 -0
- package/dist/hooks/use-infinite-fetch/use-infinite-fetch.types.d.ts.map +1 -0
- package/dist/hooks/use-infinite-fetch/use-infinite-fetch.utils.d.ts +15 -0
- package/dist/hooks/use-infinite-fetch/use-infinite-fetch.utils.d.ts.map +1 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.mjs +934 -13
- package/dist/index.mjs.map +1 -1
- package/dist/provider/provider.types.d.ts +2 -0
- package/dist/provider/provider.types.d.ts.map +1 -1
- package/package.json +2 -3
- package/src/helpers/use-request-events/use-request-events.hooks.ts +13 -7
- package/src/helpers/use-tracked-state/use-tracked-state.hooks.ts +3 -5
- package/src/helpers/use-tracked-state/use-tracked-state.utils.ts +4 -5
- package/src/hooks/use-infinite-fetch/index.ts +3 -0
- package/src/hooks/use-infinite-fetch/use-infinite-fetch.constants.ts +25 -0
- package/src/hooks/use-infinite-fetch/use-infinite-fetch.hooks.ts +389 -0
- package/src/hooks/use-infinite-fetch/use-infinite-fetch.requests.ts +98 -0
- package/src/hooks/use-infinite-fetch/use-infinite-fetch.store.ts +780 -0
- package/src/hooks/use-infinite-fetch/use-infinite-fetch.store.types.ts +49 -0
- package/src/hooks/use-infinite-fetch/use-infinite-fetch.types.ts +195 -0
- package/src/hooks/use-infinite-fetch/use-infinite-fetch.utils.ts +44 -0
- package/src/index.ts +1 -0
- package/src/provider/provider.types.ts +3 -0
- package/__tests__/features/use-fetch/use-fetch.infinite.ts +0 -39
|
@@ -0,0 +1,362 @@
|
|
|
1
|
+
/* eslint-disable react/state-in-constructor, react/no-set-state */
|
|
2
|
+
import { Client, fetchInfinite } from "@hyper-fetch/core";
|
|
3
|
+
import { act, render, screen, waitFor } from "@testing-library/react";
|
|
4
|
+
import { useInfiniteFetch } from "hooks/use-infinite-fetch";
|
|
5
|
+
import { Hydrate } from "hydrate";
|
|
6
|
+
import { Provider } from "provider";
|
|
7
|
+
import React, { Suspense } from "react";
|
|
8
|
+
import { hydrateRoot } from "react-dom/client";
|
|
9
|
+
import { renderToString } from "react-dom/server";
|
|
10
|
+
|
|
11
|
+
import { baseUrl, createListServer, failure, pageItems, settleRequests } from "../../utils/use-infinite-fetch.utils";
|
|
12
|
+
|
|
13
|
+
const { startServer, stopServer, resetMocks, mockList, calls, resetCalls } = createListServer();
|
|
14
|
+
|
|
15
|
+
type Post = { id: number };
|
|
16
|
+
|
|
17
|
+
class Boundary extends React.Component<
|
|
18
|
+
{ children: React.ReactNode; onError?: (error: unknown) => void },
|
|
19
|
+
{ hasError: boolean }
|
|
20
|
+
> {
|
|
21
|
+
state = { hasError: false };
|
|
22
|
+
|
|
23
|
+
static getDerivedStateFromError() {
|
|
24
|
+
return { hasError: true };
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
componentDidCatch(error: unknown) {
|
|
28
|
+
this.props.onError?.(error);
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
render() {
|
|
32
|
+
if (this.state.hasError) {
|
|
33
|
+
return (
|
|
34
|
+
<button type="button" onClick={() => this.setState({ hasError: false })}>
|
|
35
|
+
boundary
|
|
36
|
+
</button>
|
|
37
|
+
);
|
|
38
|
+
}
|
|
39
|
+
return this.props.children;
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
describe("useInfiniteFetch [ Boundaries ]", () => {
|
|
44
|
+
let client: Client;
|
|
45
|
+
|
|
46
|
+
const createPosts = (testClient: Client = client) =>
|
|
47
|
+
testClient.createRequest<{ response: Post[]; queryParams: { page?: number } }>()({ endpoint: "/posts" });
|
|
48
|
+
|
|
49
|
+
const pagination = { page: "page" } as const;
|
|
50
|
+
|
|
51
|
+
beforeAll(() => startServer());
|
|
52
|
+
afterAll(() => stopServer());
|
|
53
|
+
|
|
54
|
+
beforeEach(() => {
|
|
55
|
+
client = new Client({ url: baseUrl });
|
|
56
|
+
resetCalls();
|
|
57
|
+
mockList("/posts", ({ query }) => pageItems(Number(query.page)));
|
|
58
|
+
});
|
|
59
|
+
|
|
60
|
+
afterEach(async () => {
|
|
61
|
+
await settleRequests(client);
|
|
62
|
+
resetMocks();
|
|
63
|
+
});
|
|
64
|
+
|
|
65
|
+
describe("suspense", () => {
|
|
66
|
+
const List = () => {
|
|
67
|
+
const { items, fetchNextPage, isFetchingNextPage } = useInfiniteFetch(createPosts(), {
|
|
68
|
+
pagination,
|
|
69
|
+
suspense: true,
|
|
70
|
+
});
|
|
71
|
+
return (
|
|
72
|
+
<button type="button" onClick={() => fetchNextPage()}>
|
|
73
|
+
items:{items.length} next:{String(isFetchingNextPage)}
|
|
74
|
+
</button>
|
|
75
|
+
);
|
|
76
|
+
};
|
|
77
|
+
|
|
78
|
+
it("should suspend until the first page and send one request", async () => {
|
|
79
|
+
render(
|
|
80
|
+
<Suspense fallback="loading">
|
|
81
|
+
<List />
|
|
82
|
+
</Suspense>,
|
|
83
|
+
);
|
|
84
|
+
|
|
85
|
+
expect(screen.getByText("loading")).toBeInTheDocument();
|
|
86
|
+
await screen.findByText(/items:2/);
|
|
87
|
+
expect(calls).toHaveLength(1);
|
|
88
|
+
});
|
|
89
|
+
|
|
90
|
+
it("should not suspend for later pages", async () => {
|
|
91
|
+
render(
|
|
92
|
+
<Suspense fallback="loading">
|
|
93
|
+
<List />
|
|
94
|
+
</Suspense>,
|
|
95
|
+
);
|
|
96
|
+
await screen.findByText(/items:2/);
|
|
97
|
+
|
|
98
|
+
act(() => screen.getByRole("button").click());
|
|
99
|
+
|
|
100
|
+
expect(screen.queryByText("loading")).not.toBeInTheDocument();
|
|
101
|
+
await screen.findByText(/items:4/);
|
|
102
|
+
});
|
|
103
|
+
|
|
104
|
+
it("should not suspend when the pages are cached", async () => {
|
|
105
|
+
client.cache.set(createPosts().setQueryParams({ page: 1 }), {
|
|
106
|
+
data: pageItems(1),
|
|
107
|
+
error: null,
|
|
108
|
+
status: 200,
|
|
109
|
+
success: true,
|
|
110
|
+
extra: {},
|
|
111
|
+
requestTimestamp: Date.now(),
|
|
112
|
+
responseTimestamp: Date.now(),
|
|
113
|
+
} as any);
|
|
114
|
+
|
|
115
|
+
render(
|
|
116
|
+
<Suspense fallback="loading">
|
|
117
|
+
<List />
|
|
118
|
+
</Suspense>,
|
|
119
|
+
);
|
|
120
|
+
|
|
121
|
+
expect(screen.queryByText("loading")).not.toBeInTheDocument();
|
|
122
|
+
expect(screen.getByText(/items:2/)).toBeInTheDocument();
|
|
123
|
+
});
|
|
124
|
+
|
|
125
|
+
it("should render the error of the first page instead of suspending forever", async () => {
|
|
126
|
+
mockList("/posts", () => failure());
|
|
127
|
+
const ErrorList = () => {
|
|
128
|
+
const { error } = useInfiniteFetch(createPosts(), { pagination, suspense: true });
|
|
129
|
+
return <div>{error ? "failed" : "fine"}</div>;
|
|
130
|
+
};
|
|
131
|
+
|
|
132
|
+
render(
|
|
133
|
+
<Suspense fallback="loading">
|
|
134
|
+
<ErrorList />
|
|
135
|
+
</Suspense>,
|
|
136
|
+
);
|
|
137
|
+
|
|
138
|
+
await screen.findByText("failed");
|
|
139
|
+
expect(calls).toHaveLength(1);
|
|
140
|
+
});
|
|
141
|
+
});
|
|
142
|
+
|
|
143
|
+
describe("throwOnError", () => {
|
|
144
|
+
let consoleError: ReturnType<typeof vi.spyOn>;
|
|
145
|
+
|
|
146
|
+
beforeEach(() => {
|
|
147
|
+
consoleError = vi.spyOn(console, "error").mockImplementation(() => null);
|
|
148
|
+
});
|
|
149
|
+
|
|
150
|
+
afterEach(() => consoleError.mockRestore());
|
|
151
|
+
|
|
152
|
+
const List = ({ throwOnError = true }: { throwOnError?: boolean | ((error: unknown) => boolean) }) => {
|
|
153
|
+
const { items } = useInfiniteFetch(createPosts(), { pagination, throwOnError });
|
|
154
|
+
return <div>items:{items.length}</div>;
|
|
155
|
+
};
|
|
156
|
+
|
|
157
|
+
it("should throw the error to the boundary", async () => {
|
|
158
|
+
mockList("/posts", () => failure());
|
|
159
|
+
const onError = vi.fn();
|
|
160
|
+
|
|
161
|
+
render(
|
|
162
|
+
<Boundary onError={onError}>
|
|
163
|
+
<List />
|
|
164
|
+
</Boundary>,
|
|
165
|
+
);
|
|
166
|
+
|
|
167
|
+
await screen.findByText("boundary");
|
|
168
|
+
expect(onError).toHaveBeenCalled();
|
|
169
|
+
});
|
|
170
|
+
|
|
171
|
+
it("should let a function decide", async () => {
|
|
172
|
+
mockList("/posts", () => failure());
|
|
173
|
+
|
|
174
|
+
render(
|
|
175
|
+
<Boundary>
|
|
176
|
+
<List throwOnError={() => false} />
|
|
177
|
+
</Boundary>,
|
|
178
|
+
);
|
|
179
|
+
|
|
180
|
+
await waitFor(() => expect(calls).toHaveLength(1));
|
|
181
|
+
await new Promise((resolve) => {
|
|
182
|
+
setTimeout(resolve, 30);
|
|
183
|
+
});
|
|
184
|
+
expect(screen.getByText("items:0")).toBeInTheDocument();
|
|
185
|
+
});
|
|
186
|
+
|
|
187
|
+
it("should load the list again after the boundary resets", async () => {
|
|
188
|
+
mockList("/posts", () => failure());
|
|
189
|
+
render(
|
|
190
|
+
<Boundary>
|
|
191
|
+
<List />
|
|
192
|
+
</Boundary>,
|
|
193
|
+
);
|
|
194
|
+
await screen.findByText("boundary");
|
|
195
|
+
await new Promise((resolve) => {
|
|
196
|
+
setTimeout(resolve, 5);
|
|
197
|
+
});
|
|
198
|
+
|
|
199
|
+
mockList("/posts", ({ query }) => pageItems(Number(query.page)));
|
|
200
|
+
act(() => screen.getByRole("button").click());
|
|
201
|
+
|
|
202
|
+
await screen.findByText("items:2");
|
|
203
|
+
});
|
|
204
|
+
});
|
|
205
|
+
|
|
206
|
+
describe("suspense with throwOnError", () => {
|
|
207
|
+
it("should load a list that never mounted again after the boundary resets", async () => {
|
|
208
|
+
const consoleError = vi.spyOn(console, "error").mockImplementation(() => null);
|
|
209
|
+
mockList("/posts", () => failure());
|
|
210
|
+
|
|
211
|
+
const List = () => {
|
|
212
|
+
const { items } = useInfiniteFetch(createPosts(), { pagination, suspense: true, throwOnError: true });
|
|
213
|
+
return <div>items:{items.length}</div>;
|
|
214
|
+
};
|
|
215
|
+
|
|
216
|
+
render(
|
|
217
|
+
<Boundary>
|
|
218
|
+
<Suspense fallback="loading">
|
|
219
|
+
<List />
|
|
220
|
+
</Suspense>
|
|
221
|
+
</Boundary>,
|
|
222
|
+
);
|
|
223
|
+
await screen.findByText("boundary");
|
|
224
|
+
await new Promise((resolve) => {
|
|
225
|
+
setTimeout(resolve, 5);
|
|
226
|
+
});
|
|
227
|
+
|
|
228
|
+
mockList("/posts", ({ query }) => pageItems(Number(query.page)));
|
|
229
|
+
act(() => screen.getByRole("button").click());
|
|
230
|
+
|
|
231
|
+
await screen.findByText("items:2");
|
|
232
|
+
consoleError.mockRestore();
|
|
233
|
+
});
|
|
234
|
+
});
|
|
235
|
+
|
|
236
|
+
describe("provider", () => {
|
|
237
|
+
it("should use the defaults of the provider and let the hook override them", async () => {
|
|
238
|
+
const Disabled = (options: { disabled?: boolean }) => {
|
|
239
|
+
const { items } = useInfiniteFetch(createPosts(), { pagination, ...options });
|
|
240
|
+
return <div>items:{items.length}</div>;
|
|
241
|
+
};
|
|
242
|
+
|
|
243
|
+
const { rerender } = render(
|
|
244
|
+
<Provider config={{ useInfiniteFetchConfig: { disabled: true } }}>
|
|
245
|
+
<Disabled />
|
|
246
|
+
</Provider>,
|
|
247
|
+
);
|
|
248
|
+
await new Promise((resolve) => {
|
|
249
|
+
setTimeout(resolve, 30);
|
|
250
|
+
});
|
|
251
|
+
expect(calls).toHaveLength(0);
|
|
252
|
+
|
|
253
|
+
rerender(
|
|
254
|
+
<Provider config={{ useInfiniteFetchConfig: { disabled: true } }}>
|
|
255
|
+
<Disabled disabled={false} />
|
|
256
|
+
</Provider>,
|
|
257
|
+
);
|
|
258
|
+
|
|
259
|
+
await screen.findByText("items:2");
|
|
260
|
+
});
|
|
261
|
+
});
|
|
262
|
+
|
|
263
|
+
describe("server rendering", () => {
|
|
264
|
+
const List = ({ testClient }: { testClient: Client }) => {
|
|
265
|
+
const { items, loading } = useInfiniteFetch(createPosts(testClient), { pagination, dependencyTracking: false });
|
|
266
|
+
return <div data-testid="list">{loading ? "loading" : items.map((item) => item.id).join(",")}</div>;
|
|
267
|
+
};
|
|
268
|
+
|
|
269
|
+
it("should fetch the first pages one after another", async () => {
|
|
270
|
+
const result = await fetchInfinite(createPosts(), { pagination, pages: 2 });
|
|
271
|
+
|
|
272
|
+
expect(calls.map((call) => call.query.page)).toEqual(["1", "2"]);
|
|
273
|
+
expect(result.items.map((item) => item.id)).toEqual([1, 2, 3, 4]);
|
|
274
|
+
expect(result.dehydrated).toHaveLength(2);
|
|
275
|
+
expect(client.cache.keys()).toHaveLength(0);
|
|
276
|
+
});
|
|
277
|
+
|
|
278
|
+
it("should render all the prefetched pages on the server", async () => {
|
|
279
|
+
const server = new Client({ url: baseUrl, mode: "server" } as any);
|
|
280
|
+
const { dehydrated } = await fetchInfinite(createPosts(server), { pagination, pages: 2 });
|
|
281
|
+
|
|
282
|
+
const html = renderToString(
|
|
283
|
+
<Hydrate client={server} data={dehydrated}>
|
|
284
|
+
<List testClient={server} />
|
|
285
|
+
</Hydrate>,
|
|
286
|
+
);
|
|
287
|
+
|
|
288
|
+
expect(html).toContain("1,2,3,4");
|
|
289
|
+
expect(server.cache.keys()).toHaveLength(0);
|
|
290
|
+
});
|
|
291
|
+
|
|
292
|
+
it("should keep renders of different users apart on one server client", async () => {
|
|
293
|
+
const server = new Client({ url: baseUrl, mode: "server" } as any);
|
|
294
|
+
const first = await fetchInfinite(createPosts(server), { pagination });
|
|
295
|
+
mockList("/posts", () => [{ id: 77 }]);
|
|
296
|
+
const second = await fetchInfinite(createPosts(server), { pagination });
|
|
297
|
+
|
|
298
|
+
const renderList = (data: typeof first.dehydrated) =>
|
|
299
|
+
renderToString(
|
|
300
|
+
<Hydrate client={server} data={data}>
|
|
301
|
+
<List testClient={server} />
|
|
302
|
+
</Hydrate>,
|
|
303
|
+
);
|
|
304
|
+
|
|
305
|
+
expect(renderList(first.dehydrated)).toContain("1,2");
|
|
306
|
+
expect(renderList(second.dehydrated)).toContain(">77<");
|
|
307
|
+
expect(renderList(first.dehydrated)).toContain("1,2");
|
|
308
|
+
});
|
|
309
|
+
|
|
310
|
+
it("should hydrate without a mismatch or a request", async () => {
|
|
311
|
+
const server = new Client({ url: baseUrl, mode: "server" } as any);
|
|
312
|
+
const { dehydrated } = await fetchInfinite(createPosts(server), { pagination, pages: 2 });
|
|
313
|
+
// Data crosses from the server to the browser as JSON
|
|
314
|
+
// oxlint-disable-next-line unicorn/prefer-structured-clone
|
|
315
|
+
const wire = JSON.parse(JSON.stringify(dehydrated));
|
|
316
|
+
const html = renderToString(
|
|
317
|
+
<Hydrate client={server} data={wire}>
|
|
318
|
+
<List testClient={server} />
|
|
319
|
+
</Hydrate>,
|
|
320
|
+
);
|
|
321
|
+
resetCalls();
|
|
322
|
+
|
|
323
|
+
const spy = vi.spyOn(console, "error");
|
|
324
|
+
const container = document.createElement("div");
|
|
325
|
+
container.innerHTML = html;
|
|
326
|
+
document.body.append(container);
|
|
327
|
+
|
|
328
|
+
await act(async () => {
|
|
329
|
+
hydrateRoot(
|
|
330
|
+
container,
|
|
331
|
+
<Hydrate client={client} data={wire}>
|
|
332
|
+
<List testClient={client} />
|
|
333
|
+
</Hydrate>,
|
|
334
|
+
);
|
|
335
|
+
});
|
|
336
|
+
|
|
337
|
+
expect(container.textContent).toBe("1,2,3,4");
|
|
338
|
+
expect(spy).not.toHaveBeenCalled();
|
|
339
|
+
await new Promise((resolve) => {
|
|
340
|
+
setTimeout(resolve, 30);
|
|
341
|
+
});
|
|
342
|
+
expect(calls).toHaveLength(0);
|
|
343
|
+
expect(client.cache.keys()).toHaveLength(2);
|
|
344
|
+
|
|
345
|
+
spy.mockRestore();
|
|
346
|
+
container.remove();
|
|
347
|
+
});
|
|
348
|
+
|
|
349
|
+
it("should stop prefetching at the end of the list and on a failure", async () => {
|
|
350
|
+
mockList("/posts", ({ query }) => (query.page === "1" ? pageItems(1) : []));
|
|
351
|
+
const finished = await fetchInfinite(createPosts(), { pagination, pages: 5 });
|
|
352
|
+
expect(finished.pages).toHaveLength(1 + 1);
|
|
353
|
+
expect(finished.hasNextPage).toBe(false);
|
|
354
|
+
|
|
355
|
+
mockList("/posts", ({ query }) => (query.page === "1" ? pageItems(1) : failure()));
|
|
356
|
+
const failed = await fetchInfinite(createPosts(), { pagination, pages: 5 });
|
|
357
|
+
expect(failed.pages).toHaveLength(1);
|
|
358
|
+
expect(failed.error).toBeTruthy();
|
|
359
|
+
expect(failed.dehydrated).toHaveLength(1);
|
|
360
|
+
});
|
|
361
|
+
});
|
|
362
|
+
});
|