@hyper-fetch/react 7.5.3 → 8.0.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/.eslintrc.cjs +12 -0
- package/__tests__/features/helpers/use-request-events/use-request-events.base.spec.ts +4 -4
- package/__tests__/features/helpers/use-request-events/use-request-events.utils.spec.ts +3 -3
- package/__tests__/features/helpers/use-socket-state/use-socket-state.base.spec.ts +44 -6
- package/__tests__/features/helpers/use-tracked-state/use-tacked-state.actions.spec.ts +177 -9
- package/__tests__/features/helpers/use-tracked-state/use-tracked-state.base.spec.ts +47 -8
- package/__tests__/features/helpers/use-tracked-state/use-tracked-state.utils.spec.ts +6 -6
- package/__tests__/features/provider/provider.hydration.spec.tsx +7 -3
- package/__tests__/features/provider/use-config-provider.base.spec.tsx +2 -1
- package/__tests__/features/use-app-manager/use-app-manager.base.spec.ts +1 -1
- package/__tests__/features/use-cache/use-cache.base.spec.ts +9 -6
- package/__tests__/features/use-cache/use-cache.helpers.ts +1 -1
- package/__tests__/features/use-cache/use-cache.typescript.spec.ts +111 -0
- package/__tests__/features/use-emitter/use-emitter.base.spec.ts +2 -2
- package/__tests__/features/use-fetch/use-fetch.base.spec.ts +103 -15
- package/__tests__/features/use-fetch/use-fetch.cancel.spec.ts +2 -2
- package/__tests__/features/use-fetch/use-fetch.clear-state.spec.ts +82 -0
- package/__tests__/features/use-fetch/use-fetch.concurrency.spec.ts +3 -3
- package/__tests__/features/use-fetch/use-fetch.debounce.spec.ts +5 -5
- package/__tests__/features/use-fetch/use-fetch.deduplication.spec.ts +1 -1
- package/__tests__/features/use-fetch/use-fetch.infinite.ts +1 -1
- package/__tests__/features/use-fetch/use-fetch.integration.spec.tsx +3 -3
- package/__tests__/features/use-fetch/use-fetch.keep-previous-data.spec.ts +215 -0
- package/__tests__/features/use-fetch/use-fetch.methods.spec.ts +34 -34
- package/__tests__/features/use-fetch/use-fetch.offline.spec.ts +3 -3
- package/__tests__/features/use-fetch/use-fetch.pagination.ts +1 -1
- package/__tests__/features/use-fetch/use-fetch.prefetch.spec.tsx +1 -1
- package/__tests__/features/use-fetch/use-fetch.refresh.spec.ts +41 -7
- package/__tests__/features/use-fetch/use-fetch.rerender.spec.tsx +2 -2
- package/__tests__/features/use-fetch/use-fetch.retry.ts +1 -1
- package/__tests__/features/use-fetch/use-fetch.revalidate.spec.ts +6 -4
- package/__tests__/features/use-fetch/use-fetch.suspense.spec.tsx +505 -0
- package/__tests__/features/use-fetch/use-fetch.typescript.spec.ts +179 -56
- package/__tests__/features/use-fetch/use-fetch.window.spec.ts +75 -3
- package/__tests__/features/use-listener/use-listener.base.spec.ts +3 -3
- package/__tests__/features/use-queue/use-queue.actions.spec.ts +1 -1
- package/__tests__/features/use-queue/use-queue.base.spec.ts +259 -1
- package/__tests__/features/use-queue/use-queue.resolve.spec.ts +173 -0
- package/__tests__/features/use-stream/use-stream.base.spec.ts +481 -0
- package/__tests__/features/use-submit/use-submit.base.spec.ts +2 -2
- package/__tests__/features/use-submit/use-submit.cancel.spec.ts +1 -1
- package/__tests__/features/use-submit/use-submit.concurrency.spec.ts +1 -1
- package/__tests__/features/use-submit/use-submit.debounce.spec.ts +8 -8
- package/__tests__/features/use-submit/use-submit.methods.spec.ts +44 -46
- package/__tests__/features/use-submit/use-submit.optimistic.spec.ts +548 -0
- package/__tests__/features/use-submit/use-submit.queue.spec.ts +3 -3
- package/__tests__/features/use-submit/use-submit.retry.spec.ts +4 -4
- package/__tests__/features/use-submit/use-submit.revalidate.spec.ts +5 -5
- package/__tests__/features/use-submit/use-submit.submit.spec.ts +4 -3
- package/__tests__/features/use-submit/use-submit.typescript.spec.ts +325 -0
- package/__tests__/shared/isolation.tests.ts +1 -1
- package/__tests__/shared/response.tests.ts +5 -4
- package/__tests__/tsconfig.json +21 -2
- package/__tests__/utils/cache.utils.ts +6 -4
- package/__tests__/utils/emitter.utils.ts +3 -2
- package/__tests__/utils/listener.utils.ts +3 -2
- package/__tests__/utils/request.utils.ts +6 -6
- package/__tests__/utils/state.utils.ts +1 -1
- package/__tests__/utils/use-app-manager.utils.ts +1 -1
- package/__tests__/utils/use-cache.utils.ts +3 -2
- package/__tests__/utils/use-emitter.utils.ts +3 -2
- package/__tests__/utils/use-fetch.utils.ts +4 -3
- package/__tests__/utils/use-listener.utils.ts +3 -2
- package/__tests__/utils/use-queue.utils.ts +4 -2
- package/__tests__/utils/use-request-events.utils.ts +3 -2
- package/__tests__/utils/use-socket-state.utils.ts +3 -2
- package/__tests__/utils/use-submit.utils.ts +3 -2
- package/__tests__/utils/use-tracked-state.utils.ts +3 -2
- package/__tests__/vitest.setup.ts +8 -0
- package/dist/helpers/index.d.ts +4 -0
- package/dist/helpers/index.d.ts.map +1 -0
- package/dist/helpers/use-request-events/index.d.ts +3 -0
- package/dist/helpers/use-request-events/index.d.ts.map +1 -0
- package/dist/helpers/use-request-events/use-request-events.hooks.d.ts +10 -0
- package/dist/helpers/use-request-events/use-request-events.hooks.d.ts.map +1 -0
- package/dist/helpers/use-request-events/use-request-events.types.d.ts +78 -0
- package/dist/helpers/use-request-events/use-request-events.types.d.ts.map +1 -0
- package/dist/helpers/use-socket-state/index.d.ts +4 -0
- package/dist/helpers/use-socket-state/index.d.ts.map +1 -0
- package/dist/helpers/use-socket-state/use-socket-state.constants.d.ts +4 -0
- package/dist/helpers/use-socket-state/use-socket-state.constants.d.ts.map +1 -0
- package/dist/helpers/use-socket-state/use-socket-state.hooks.d.ts +24 -0
- package/dist/helpers/use-socket-state/use-socket-state.hooks.d.ts.map +1 -0
- package/dist/helpers/use-socket-state/use-socket-state.types.d.ts +12 -0
- package/dist/helpers/use-socket-state/use-socket-state.types.d.ts.map +1 -0
- package/dist/helpers/use-tracked-state/index.d.ts +5 -0
- package/dist/helpers/use-tracked-state/index.d.ts.map +1 -0
- package/dist/helpers/use-tracked-state/use-tracked-state.constants.d.ts +3 -0
- package/dist/helpers/use-tracked-state/use-tracked-state.constants.d.ts.map +1 -0
- package/dist/helpers/use-tracked-state/use-tracked-state.hooks.d.ts +12 -0
- package/dist/helpers/use-tracked-state/use-tracked-state.hooks.d.ts.map +1 -0
- package/dist/helpers/use-tracked-state/use-tracked-state.types.d.ts +113 -0
- package/dist/helpers/use-tracked-state/use-tracked-state.types.d.ts.map +1 -0
- package/dist/helpers/use-tracked-state/use-tracked-state.utils.d.ts +29 -0
- package/dist/helpers/use-tracked-state/use-tracked-state.utils.d.ts.map +1 -0
- package/dist/hooks/use-app-manager/index.d.ts +3 -0
- package/dist/hooks/use-app-manager/index.d.ts.map +1 -0
- package/dist/hooks/use-app-manager/use-app-manager.hooks.d.ts +4 -0
- package/dist/hooks/use-app-manager/use-app-manager.hooks.d.ts.map +1 -0
- package/dist/hooks/use-app-manager/use-app-manager.types.d.ts +19 -0
- package/dist/hooks/use-app-manager/use-app-manager.types.d.ts.map +1 -0
- package/dist/hooks/use-cache/index.d.ts +4 -0
- package/dist/hooks/use-cache/index.d.ts.map +1 -0
- package/dist/hooks/use-cache/use-cache.constants.d.ts +6 -0
- package/dist/hooks/use-cache/use-cache.constants.d.ts.map +1 -0
- package/dist/hooks/use-cache/use-cache.hooks.d.ts +4 -0
- package/dist/hooks/use-cache/use-cache.hooks.d.ts.map +1 -0
- package/dist/hooks/use-cache/use-cache.types.d.ts +24 -0
- package/dist/hooks/use-cache/use-cache.types.d.ts.map +1 -0
- package/dist/hooks/use-emitter/index.d.ts +3 -0
- package/dist/hooks/use-emitter/index.d.ts.map +1 -0
- package/dist/hooks/use-emitter/use-emitter.hooks.d.ts +26 -0
- package/dist/hooks/use-emitter/use-emitter.hooks.d.ts.map +1 -0
- package/dist/hooks/use-emitter/use-emitter.types.d.ts +4 -0
- package/dist/hooks/use-emitter/use-emitter.types.d.ts.map +1 -0
- package/dist/hooks/use-fetch/index.d.ts +5 -0
- package/dist/hooks/use-fetch/index.d.ts.map +1 -0
- package/dist/hooks/use-fetch/use-fetch.constants.d.ts +8 -0
- package/dist/hooks/use-fetch/use-fetch.constants.d.ts.map +1 -0
- package/dist/hooks/use-fetch/use-fetch.hooks.d.ts +10 -0
- package/dist/hooks/use-fetch/use-fetch.hooks.d.ts.map +1 -0
- package/dist/hooks/use-fetch/use-fetch.types.d.ts +118 -0
- package/dist/hooks/use-fetch/use-fetch.types.d.ts.map +1 -0
- package/dist/hooks/use-fetch/use-fetch.utils.d.ts +2 -0
- package/dist/hooks/use-fetch/use-fetch.utils.d.ts.map +1 -0
- package/dist/hooks/use-listener/index.d.ts +3 -0
- package/dist/hooks/use-listener/index.d.ts.map +1 -0
- package/dist/hooks/use-listener/use-listener.hooks.d.ts +31 -0
- package/dist/hooks/use-listener/use-listener.hooks.d.ts.map +1 -0
- package/dist/hooks/use-listener/use-listener.types.d.ts +4 -0
- package/dist/hooks/use-listener/use-listener.types.d.ts.map +1 -0
- package/dist/hooks/use-queue/index.d.ts +4 -0
- package/dist/hooks/use-queue/index.d.ts.map +1 -0
- package/dist/hooks/use-queue/use-queue.constants.d.ts +4 -0
- package/dist/hooks/use-queue/use-queue.constants.d.ts.map +1 -0
- package/dist/hooks/use-queue/use-queue.hooks.d.ts +10 -0
- package/dist/hooks/use-queue/use-queue.hooks.d.ts.map +1 -0
- package/dist/hooks/use-queue/use-queue.types.d.ts +58 -0
- package/dist/hooks/use-queue/use-queue.types.d.ts.map +1 -0
- package/dist/hooks/use-stream/index.d.ts +3 -0
- package/dist/hooks/use-stream/index.d.ts.map +1 -0
- package/dist/hooks/use-stream/use-stream.hooks.d.ts +11 -0
- package/dist/hooks/use-stream/use-stream.hooks.d.ts.map +1 -0
- package/dist/hooks/use-stream/use-stream.types.d.ts +52 -0
- package/dist/hooks/use-stream/use-stream.types.d.ts.map +1 -0
- package/dist/hooks/use-submit/index.d.ts +4 -0
- package/dist/hooks/use-submit/index.d.ts.map +1 -0
- package/dist/hooks/use-submit/use-submit.constants.d.ts +8 -0
- package/dist/hooks/use-submit/use-submit.constants.d.ts.map +1 -0
- package/dist/hooks/use-submit/use-submit.hooks.d.ts +10 -0
- package/dist/hooks/use-submit/use-submit.hooks.d.ts.map +1 -0
- package/dist/hooks/use-submit/use-submit.types.d.ts +115 -0
- package/dist/hooks/use-submit/use-submit.types.d.ts.map +1 -0
- package/dist/index.d.ts +12 -733
- package/dist/index.d.ts.map +1 -0
- package/dist/index.mjs +1935 -0
- package/dist/index.mjs.map +1 -0
- package/dist/provider/index.d.ts +3 -0
- package/dist/provider/index.d.ts.map +1 -0
- package/dist/provider/provider.d.ts +13 -0
- package/dist/provider/provider.d.ts.map +1 -0
- package/dist/provider/provider.types.d.ts +31 -0
- package/dist/provider/provider.types.d.ts.map +1 -0
- package/dist/utils/bounce.utils.d.ts +8 -0
- package/dist/utils/bounce.utils.d.ts.map +1 -0
- package/dist/utils/deep-equal.utils.d.ts +14 -0
- package/dist/utils/deep-equal.utils.d.ts.map +1 -0
- package/dist/utils/index.d.ts +4 -0
- package/dist/utils/index.d.ts.map +1 -0
- package/dist/utils/tracked-proxy.utils.d.ts +7 -0
- package/dist/utils/tracked-proxy.utils.d.ts.map +1 -0
- package/package.json +21 -13
- package/src/helpers/use-request-events/use-request-events.hooks.ts +60 -14
- package/src/helpers/use-request-events/use-request-events.types.ts +19 -12
- package/src/helpers/use-socket-state/use-socket-state.constants.ts +2 -2
- package/src/helpers/use-socket-state/use-socket-state.hooks.ts +47 -13
- package/src/helpers/use-socket-state/use-socket-state.types.ts +1 -1
- package/src/helpers/use-tracked-state/use-tracked-state.constants.ts +1 -1
- package/src/helpers/use-tracked-state/use-tracked-state.hooks.ts +74 -22
- package/src/helpers/use-tracked-state/use-tracked-state.types.ts +7 -2
- package/src/helpers/use-tracked-state/use-tracked-state.utils.ts +39 -4
- package/src/hooks/use-app-manager/use-app-manager.hooks.ts +2 -2
- package/src/hooks/use-cache/use-cache.hooks.ts +33 -41
- package/src/hooks/use-cache/use-cache.types.ts +3 -3
- package/src/hooks/use-emitter/use-emitter.hooks.ts +17 -16
- package/src/hooks/use-fetch/use-fetch.constants.ts +5 -2
- package/src/hooks/use-fetch/use-fetch.hooks.ts +109 -51
- package/src/hooks/use-fetch/use-fetch.types.ts +18 -3
- package/src/hooks/use-listener/use-listener.hooks.ts +19 -27
- package/src/hooks/use-queue/use-queue.constants.ts +2 -2
- package/src/hooks/use-queue/use-queue.hooks.ts +25 -6
- package/src/hooks/use-queue/use-queue.types.ts +8 -2
- package/src/hooks/use-stream/index.ts +2 -0
- package/src/hooks/use-stream/use-stream.hooks.ts +164 -0
- package/src/hooks/use-stream/use-stream.types.ts +53 -0
- package/src/hooks/use-submit/use-submit.constants.ts +2 -2
- package/src/hooks/use-submit/use-submit.hooks.ts +43 -48
- package/src/hooks/use-submit/use-submit.types.ts +9 -9
- package/src/index.ts +1 -0
- package/src/provider/provider.tsx +1 -1
- package/src/provider/provider.types.ts +8 -8
- package/src/utils/index.ts +1 -0
- package/src/utils/tracked-proxy.utils.ts +19 -0
- package/tsconfig.json +1 -1
- package/vite.config.ts +45 -0
- package/.eslintrc.json +0 -11
- package/__tests__/features/use-fetch/use-fetch.suspense.ts +0 -37
- package/__tests__/global.d.ts +0 -1
- package/__tests__/jest.setup.ts +0 -9
- package/dist/index.js +0 -1541
- package/dist/index.js.map +0 -7
- package/jest.config.ts +0 -6
|
@@ -0,0 +1,173 @@
|
|
|
1
|
+
import { act, waitFor } from "@testing-library/react";
|
|
2
|
+
import { createHttpMockingServer } from "@hyper-fetch/testing";
|
|
3
|
+
import { getRequestDispatcher, scopeKey } from "@hyper-fetch/core";
|
|
4
|
+
|
|
5
|
+
import { addQueueElement, client, createRequest, renderUseQueue } from "../../utils";
|
|
6
|
+
|
|
7
|
+
const { resetMocks, startServer, stopServer, mockRequest } = createHttpMockingServer();
|
|
8
|
+
|
|
9
|
+
describe("useQueue [ Resolve Queue Items ]", () => {
|
|
10
|
+
let request = createRequest({ method: "POST" });
|
|
11
|
+
|
|
12
|
+
beforeAll(() => {
|
|
13
|
+
startServer();
|
|
14
|
+
});
|
|
15
|
+
|
|
16
|
+
afterEach(() => {
|
|
17
|
+
resetMocks();
|
|
18
|
+
});
|
|
19
|
+
|
|
20
|
+
afterAll(() => {
|
|
21
|
+
stopServer();
|
|
22
|
+
});
|
|
23
|
+
|
|
24
|
+
beforeEach(() => {
|
|
25
|
+
vi.resetModules();
|
|
26
|
+
client.clear();
|
|
27
|
+
request = createRequest({ method: "POST" });
|
|
28
|
+
});
|
|
29
|
+
|
|
30
|
+
describe("given queue event contains class instances", () => {
|
|
31
|
+
describe("when the queue change event fires", () => {
|
|
32
|
+
it("should pass them through without transformation", async () => {
|
|
33
|
+
mockRequest(request);
|
|
34
|
+
const { result } = renderUseQueue(request);
|
|
35
|
+
|
|
36
|
+
act(() => {
|
|
37
|
+
addQueueElement(request, { stop: true });
|
|
38
|
+
});
|
|
39
|
+
|
|
40
|
+
await waitFor(() => {
|
|
41
|
+
expect(result.current.requests).toHaveLength(1);
|
|
42
|
+
expect(result.current.requests[0].request).toBe(request);
|
|
43
|
+
});
|
|
44
|
+
});
|
|
45
|
+
});
|
|
46
|
+
});
|
|
47
|
+
|
|
48
|
+
describe("given queue event contains JSON-serialized requests", () => {
|
|
49
|
+
describe("when the queue change event fires", () => {
|
|
50
|
+
it("should reconstruct JSON items into Request class instances", async () => {
|
|
51
|
+
mockRequest(request);
|
|
52
|
+
const [dispatcher] = getRequestDispatcher(request, "auto");
|
|
53
|
+
const queryKey = scopeKey(request.queryKey, request.scope);
|
|
54
|
+
|
|
55
|
+
dispatcher.stop(queryKey);
|
|
56
|
+
const { result } = renderUseQueue(request);
|
|
57
|
+
|
|
58
|
+
const json = request.toJSON();
|
|
59
|
+
|
|
60
|
+
act(() => {
|
|
61
|
+
dispatcher.events.emitQueueChanged({
|
|
62
|
+
queryKey,
|
|
63
|
+
stopped: true,
|
|
64
|
+
requests: [
|
|
65
|
+
{
|
|
66
|
+
requestId: "json-request-1",
|
|
67
|
+
request: json as any,
|
|
68
|
+
retries: 0,
|
|
69
|
+
timestamp: +new Date(),
|
|
70
|
+
stopped: false,
|
|
71
|
+
resolved: false,
|
|
72
|
+
},
|
|
73
|
+
],
|
|
74
|
+
});
|
|
75
|
+
});
|
|
76
|
+
|
|
77
|
+
await waitFor(() => {
|
|
78
|
+
expect(result.current.requests).toHaveLength(1);
|
|
79
|
+
expect(result.current.requests[0].requestId).toBe("json-request-1");
|
|
80
|
+
expect(result.current.requests[0].request).not.toBe(json);
|
|
81
|
+
expect(result.current.requests[0].request.endpoint).toBe(request.endpoint);
|
|
82
|
+
expect(result.current.requests[0].request.method).toBe(request.method);
|
|
83
|
+
});
|
|
84
|
+
});
|
|
85
|
+
|
|
86
|
+
it("should reconstruct JSON items from status change events", async () => {
|
|
87
|
+
mockRequest(request);
|
|
88
|
+
const [dispatcher] = getRequestDispatcher(request, "auto");
|
|
89
|
+
const queryKey = scopeKey(request.queryKey, request.scope);
|
|
90
|
+
|
|
91
|
+
dispatcher.stop(queryKey);
|
|
92
|
+
const { result } = renderUseQueue(request);
|
|
93
|
+
|
|
94
|
+
const json = request.toJSON();
|
|
95
|
+
|
|
96
|
+
act(() => {
|
|
97
|
+
dispatcher.events.emitQueueStatusChanged({
|
|
98
|
+
queryKey,
|
|
99
|
+
stopped: false,
|
|
100
|
+
requests: [
|
|
101
|
+
{
|
|
102
|
+
requestId: "json-status-1",
|
|
103
|
+
request: json as any,
|
|
104
|
+
retries: 0,
|
|
105
|
+
timestamp: +new Date(),
|
|
106
|
+
stopped: false,
|
|
107
|
+
resolved: false,
|
|
108
|
+
},
|
|
109
|
+
],
|
|
110
|
+
});
|
|
111
|
+
});
|
|
112
|
+
|
|
113
|
+
await waitFor(() => {
|
|
114
|
+
expect(result.current.requests).toHaveLength(1);
|
|
115
|
+
expect(result.current.requests[0].requestId).toBe("json-status-1");
|
|
116
|
+
expect(result.current.requests[0].request.endpoint).toBe(request.endpoint);
|
|
117
|
+
});
|
|
118
|
+
});
|
|
119
|
+
});
|
|
120
|
+
});
|
|
121
|
+
|
|
122
|
+
describe("given queue event contains a mix of class instances and JSON", () => {
|
|
123
|
+
describe("when the queue change event fires", () => {
|
|
124
|
+
it("should resolve JSON items while keeping class instances intact", async () => {
|
|
125
|
+
mockRequest(request);
|
|
126
|
+
const [dispatcher] = getRequestDispatcher(request, "auto");
|
|
127
|
+
const queryKey = scopeKey(request.queryKey, request.scope);
|
|
128
|
+
|
|
129
|
+
dispatcher.stop(queryKey);
|
|
130
|
+
const { result } = renderUseQueue(request);
|
|
131
|
+
|
|
132
|
+
const json = request.toJSON();
|
|
133
|
+
|
|
134
|
+
act(() => {
|
|
135
|
+
dispatcher.events.emitQueueChanged({
|
|
136
|
+
queryKey,
|
|
137
|
+
stopped: true,
|
|
138
|
+
requests: [
|
|
139
|
+
{
|
|
140
|
+
requestId: "class-instance-1",
|
|
141
|
+
request,
|
|
142
|
+
retries: 0,
|
|
143
|
+
timestamp: +new Date(),
|
|
144
|
+
stopped: false,
|
|
145
|
+
resolved: false,
|
|
146
|
+
},
|
|
147
|
+
{
|
|
148
|
+
requestId: "json-item-1",
|
|
149
|
+
request: json as any,
|
|
150
|
+
retries: 0,
|
|
151
|
+
timestamp: +new Date(),
|
|
152
|
+
stopped: false,
|
|
153
|
+
resolved: false,
|
|
154
|
+
},
|
|
155
|
+
],
|
|
156
|
+
});
|
|
157
|
+
});
|
|
158
|
+
|
|
159
|
+
await waitFor(() => {
|
|
160
|
+
expect(result.current.requests).toHaveLength(2);
|
|
161
|
+
|
|
162
|
+
const classItem = result.current.requests.find((r: any) => r.requestId === "class-instance-1");
|
|
163
|
+
const jsonItem = result.current.requests.find((r: any) => r.requestId === "json-item-1");
|
|
164
|
+
|
|
165
|
+
expect(classItem?.request).toBe(request);
|
|
166
|
+
expect(jsonItem?.request).not.toBe(json);
|
|
167
|
+
expect(jsonItem?.request.endpoint).toBe(request.endpoint);
|
|
168
|
+
expect(jsonItem?.request.method).toBe(request.method);
|
|
169
|
+
});
|
|
170
|
+
});
|
|
171
|
+
});
|
|
172
|
+
});
|
|
173
|
+
});
|
|
@@ -0,0 +1,481 @@
|
|
|
1
|
+
import { renderHook, act, waitFor } from "@testing-library/react";
|
|
2
|
+
|
|
3
|
+
import { useStream } from "hooks/use-stream";
|
|
4
|
+
import { client } from "../../utils";
|
|
5
|
+
|
|
6
|
+
const createStreamRequest = () => {
|
|
7
|
+
return client.createRequest<{ response: any }>()({
|
|
8
|
+
endpoint: "/stream-endpoint" as any,
|
|
9
|
+
method: "GET",
|
|
10
|
+
});
|
|
11
|
+
};
|
|
12
|
+
|
|
13
|
+
const createReadableStream = (chunks: string[]) => {
|
|
14
|
+
const encoder = new TextEncoder();
|
|
15
|
+
let index = 0;
|
|
16
|
+
|
|
17
|
+
return new ReadableStream<Uint8Array>({
|
|
18
|
+
pull(controller) {
|
|
19
|
+
if (index < chunks.length) {
|
|
20
|
+
controller.enqueue(encoder.encode(chunks[index]));
|
|
21
|
+
index += 1;
|
|
22
|
+
} else {
|
|
23
|
+
controller.close();
|
|
24
|
+
}
|
|
25
|
+
},
|
|
26
|
+
});
|
|
27
|
+
};
|
|
28
|
+
|
|
29
|
+
const createFailingReadableStream = (errorMessage: string) => {
|
|
30
|
+
return new ReadableStream<Uint8Array>({
|
|
31
|
+
start(controller) {
|
|
32
|
+
controller.error(new Error(errorMessage));
|
|
33
|
+
},
|
|
34
|
+
});
|
|
35
|
+
};
|
|
36
|
+
|
|
37
|
+
const renderUseStream = (request: any, options?: { autoStart?: boolean }) => {
|
|
38
|
+
return renderHook(() => useStream(request, options));
|
|
39
|
+
};
|
|
40
|
+
|
|
41
|
+
describe("useStream [ Base ]", () => {
|
|
42
|
+
let request = createStreamRequest();
|
|
43
|
+
|
|
44
|
+
beforeEach(() => {
|
|
45
|
+
vi.resetModules();
|
|
46
|
+
client.clear();
|
|
47
|
+
request = createStreamRequest();
|
|
48
|
+
});
|
|
49
|
+
|
|
50
|
+
describe("when hook is initialized", () => {
|
|
51
|
+
it("should have initial state", () => {
|
|
52
|
+
const { result } = renderUseStream(request);
|
|
53
|
+
|
|
54
|
+
expect(result.current.text).toBe("");
|
|
55
|
+
expect(result.current.chunks).toEqual([]);
|
|
56
|
+
expect(result.current.streaming).toBe(false);
|
|
57
|
+
expect(result.current.done).toBe(false);
|
|
58
|
+
expect(result.current.error).toBe(null);
|
|
59
|
+
expect(result.current.extra).toBe(null);
|
|
60
|
+
expect(result.current.status).toBe(null);
|
|
61
|
+
expect(typeof result.current.start).toBe("function");
|
|
62
|
+
expect(typeof result.current.abort).toBe("function");
|
|
63
|
+
expect(typeof result.current.reset).toBe("function");
|
|
64
|
+
});
|
|
65
|
+
});
|
|
66
|
+
|
|
67
|
+
describe("when start is called with a ReadableStream response", () => {
|
|
68
|
+
it("should stream text chunks and set done when complete", async () => {
|
|
69
|
+
const chunks = ["Hello ", "World", "!"];
|
|
70
|
+
const stream = createReadableStream(chunks);
|
|
71
|
+
|
|
72
|
+
const sendMock = vi.fn().mockResolvedValue({
|
|
73
|
+
data: stream,
|
|
74
|
+
error: null,
|
|
75
|
+
status: 200,
|
|
76
|
+
extra: { headers: {} },
|
|
77
|
+
});
|
|
78
|
+
|
|
79
|
+
const mockRequest = {
|
|
80
|
+
...request,
|
|
81
|
+
setOptions: vi.fn().mockReturnValue({
|
|
82
|
+
send: sendMock,
|
|
83
|
+
}),
|
|
84
|
+
client: request.client,
|
|
85
|
+
abortKey: request.abortKey,
|
|
86
|
+
scope: request.scope,
|
|
87
|
+
};
|
|
88
|
+
|
|
89
|
+
const { result } = renderUseStream(mockRequest);
|
|
90
|
+
|
|
91
|
+
await act(async () => {
|
|
92
|
+
result.current.start();
|
|
93
|
+
});
|
|
94
|
+
|
|
95
|
+
await waitFor(() => {
|
|
96
|
+
expect(result.current.done).toBe(true);
|
|
97
|
+
});
|
|
98
|
+
|
|
99
|
+
expect(result.current.text).toBe("Hello World!");
|
|
100
|
+
expect(result.current.chunks).toHaveLength(3);
|
|
101
|
+
expect(result.current.streaming).toBe(false);
|
|
102
|
+
expect(result.current.status).toBe(200);
|
|
103
|
+
expect(result.current.extra).toEqual({ headers: {} });
|
|
104
|
+
expect(result.current.error).toBe(null);
|
|
105
|
+
});
|
|
106
|
+
|
|
107
|
+
it("should set streaming to true while consuming", async () => {
|
|
108
|
+
let resolvePull: (() => void) | null = null;
|
|
109
|
+
const pullPromise = new Promise<void>((r) => {
|
|
110
|
+
resolvePull = r;
|
|
111
|
+
});
|
|
112
|
+
|
|
113
|
+
const encoder = new TextEncoder();
|
|
114
|
+
const stream = new ReadableStream<Uint8Array>({
|
|
115
|
+
async pull(controller) {
|
|
116
|
+
controller.enqueue(encoder.encode("data"));
|
|
117
|
+
await pullPromise;
|
|
118
|
+
controller.close();
|
|
119
|
+
},
|
|
120
|
+
});
|
|
121
|
+
|
|
122
|
+
const sendMock = vi.fn().mockResolvedValue({
|
|
123
|
+
data: stream,
|
|
124
|
+
error: null,
|
|
125
|
+
status: 200,
|
|
126
|
+
extra: null,
|
|
127
|
+
});
|
|
128
|
+
|
|
129
|
+
const mockRequest = {
|
|
130
|
+
...request,
|
|
131
|
+
setOptions: vi.fn().mockReturnValue({ send: sendMock }),
|
|
132
|
+
client: request.client,
|
|
133
|
+
abortKey: request.abortKey,
|
|
134
|
+
scope: request.scope,
|
|
135
|
+
};
|
|
136
|
+
|
|
137
|
+
const { result } = renderUseStream(mockRequest);
|
|
138
|
+
|
|
139
|
+
act(() => {
|
|
140
|
+
result.current.start();
|
|
141
|
+
});
|
|
142
|
+
|
|
143
|
+
await waitFor(() => {
|
|
144
|
+
expect(result.current.streaming).toBe(true);
|
|
145
|
+
});
|
|
146
|
+
|
|
147
|
+
await act(async () => {
|
|
148
|
+
resolvePull!();
|
|
149
|
+
});
|
|
150
|
+
|
|
151
|
+
await waitFor(() => {
|
|
152
|
+
expect(result.current.streaming).toBe(false);
|
|
153
|
+
expect(result.current.done).toBe(true);
|
|
154
|
+
});
|
|
155
|
+
});
|
|
156
|
+
});
|
|
157
|
+
|
|
158
|
+
describe("when start is called and response has an error", () => {
|
|
159
|
+
it("should set error state", async () => {
|
|
160
|
+
const errorData = { message: "Server error" };
|
|
161
|
+
|
|
162
|
+
const sendMock = vi.fn().mockResolvedValue({
|
|
163
|
+
data: null,
|
|
164
|
+
error: errorData,
|
|
165
|
+
status: 500,
|
|
166
|
+
extra: { headers: {} },
|
|
167
|
+
});
|
|
168
|
+
|
|
169
|
+
const mockRequest = {
|
|
170
|
+
...request,
|
|
171
|
+
setOptions: vi.fn().mockReturnValue({ send: sendMock }),
|
|
172
|
+
client: request.client,
|
|
173
|
+
abortKey: request.abortKey,
|
|
174
|
+
scope: request.scope,
|
|
175
|
+
};
|
|
176
|
+
|
|
177
|
+
const { result } = renderUseStream(mockRequest);
|
|
178
|
+
|
|
179
|
+
await act(async () => {
|
|
180
|
+
result.current.start();
|
|
181
|
+
});
|
|
182
|
+
|
|
183
|
+
await waitFor(() => {
|
|
184
|
+
expect(result.current.error).toEqual(errorData);
|
|
185
|
+
});
|
|
186
|
+
|
|
187
|
+
expect(result.current.streaming).toBe(false);
|
|
188
|
+
expect(result.current.status).toBe(500);
|
|
189
|
+
expect(result.current.extra).toEqual({ headers: {} });
|
|
190
|
+
});
|
|
191
|
+
});
|
|
192
|
+
|
|
193
|
+
describe("when response data is a plain string (non-stream fallback)", () => {
|
|
194
|
+
it("should set text directly from the string data", async () => {
|
|
195
|
+
const sendMock = vi.fn().mockResolvedValue({
|
|
196
|
+
data: "plain text response",
|
|
197
|
+
error: null,
|
|
198
|
+
status: 200,
|
|
199
|
+
extra: null,
|
|
200
|
+
});
|
|
201
|
+
|
|
202
|
+
const mockRequest = {
|
|
203
|
+
...request,
|
|
204
|
+
setOptions: vi.fn().mockReturnValue({ send: sendMock }),
|
|
205
|
+
client: request.client,
|
|
206
|
+
abortKey: request.abortKey,
|
|
207
|
+
scope: request.scope,
|
|
208
|
+
};
|
|
209
|
+
|
|
210
|
+
const { result } = renderUseStream(mockRequest);
|
|
211
|
+
|
|
212
|
+
await act(async () => {
|
|
213
|
+
result.current.start();
|
|
214
|
+
});
|
|
215
|
+
|
|
216
|
+
await waitFor(() => {
|
|
217
|
+
expect(result.current.done).toBe(true);
|
|
218
|
+
});
|
|
219
|
+
|
|
220
|
+
expect(result.current.text).toBe("plain text response");
|
|
221
|
+
expect(result.current.streaming).toBe(false);
|
|
222
|
+
});
|
|
223
|
+
});
|
|
224
|
+
|
|
225
|
+
describe("when response data is a non-string value (JSON.stringify fallback)", () => {
|
|
226
|
+
it("should JSON.stringify the data", async () => {
|
|
227
|
+
const objectData = { key: "value", num: 42 };
|
|
228
|
+
|
|
229
|
+
const sendMock = vi.fn().mockResolvedValue({
|
|
230
|
+
data: objectData,
|
|
231
|
+
error: null,
|
|
232
|
+
status: 200,
|
|
233
|
+
extra: null,
|
|
234
|
+
});
|
|
235
|
+
|
|
236
|
+
const mockRequest = {
|
|
237
|
+
...request,
|
|
238
|
+
setOptions: vi.fn().mockReturnValue({ send: sendMock }),
|
|
239
|
+
client: request.client,
|
|
240
|
+
abortKey: request.abortKey,
|
|
241
|
+
scope: request.scope,
|
|
242
|
+
};
|
|
243
|
+
|
|
244
|
+
const { result } = renderUseStream(mockRequest);
|
|
245
|
+
|
|
246
|
+
await act(async () => {
|
|
247
|
+
result.current.start();
|
|
248
|
+
});
|
|
249
|
+
|
|
250
|
+
await waitFor(() => {
|
|
251
|
+
expect(result.current.done).toBe(true);
|
|
252
|
+
});
|
|
253
|
+
|
|
254
|
+
expect(result.current.text).toBe(JSON.stringify(objectData));
|
|
255
|
+
expect(result.current.streaming).toBe(false);
|
|
256
|
+
});
|
|
257
|
+
});
|
|
258
|
+
|
|
259
|
+
describe("when stream reader throws an error", () => {
|
|
260
|
+
it("should set error state from the reader exception", async () => {
|
|
261
|
+
const stream = createFailingReadableStream("Stream read error");
|
|
262
|
+
|
|
263
|
+
const sendMock = vi.fn().mockResolvedValue({
|
|
264
|
+
data: stream,
|
|
265
|
+
error: null,
|
|
266
|
+
status: 200,
|
|
267
|
+
extra: null,
|
|
268
|
+
});
|
|
269
|
+
|
|
270
|
+
const mockRequest = {
|
|
271
|
+
...request,
|
|
272
|
+
setOptions: vi.fn().mockReturnValue({ send: sendMock }),
|
|
273
|
+
client: request.client,
|
|
274
|
+
abortKey: request.abortKey,
|
|
275
|
+
scope: request.scope,
|
|
276
|
+
};
|
|
277
|
+
|
|
278
|
+
const { result } = renderUseStream(mockRequest);
|
|
279
|
+
|
|
280
|
+
await act(async () => {
|
|
281
|
+
result.current.start();
|
|
282
|
+
});
|
|
283
|
+
|
|
284
|
+
await waitFor(() => {
|
|
285
|
+
expect(result.current.error).toBeTruthy();
|
|
286
|
+
});
|
|
287
|
+
|
|
288
|
+
expect(result.current.streaming).toBe(false);
|
|
289
|
+
});
|
|
290
|
+
});
|
|
291
|
+
|
|
292
|
+
describe("when abort is called", () => {
|
|
293
|
+
it("should stop streaming", async () => {
|
|
294
|
+
let resolvePull: (() => void) | null = null;
|
|
295
|
+
const pullPromise = new Promise<void>((r) => {
|
|
296
|
+
resolvePull = r;
|
|
297
|
+
});
|
|
298
|
+
|
|
299
|
+
const encoder = new TextEncoder();
|
|
300
|
+
const stream = new ReadableStream<Uint8Array>({
|
|
301
|
+
async pull(controller) {
|
|
302
|
+
controller.enqueue(encoder.encode("chunk"));
|
|
303
|
+
await pullPromise;
|
|
304
|
+
controller.close();
|
|
305
|
+
},
|
|
306
|
+
});
|
|
307
|
+
|
|
308
|
+
const abortSpy = vi.fn();
|
|
309
|
+
|
|
310
|
+
const sendMock = vi.fn().mockResolvedValue({
|
|
311
|
+
data: stream,
|
|
312
|
+
error: null,
|
|
313
|
+
status: 200,
|
|
314
|
+
extra: null,
|
|
315
|
+
});
|
|
316
|
+
|
|
317
|
+
const mockRequest = {
|
|
318
|
+
...request,
|
|
319
|
+
setOptions: vi.fn().mockReturnValue({ send: sendMock }),
|
|
320
|
+
client: {
|
|
321
|
+
...request.client,
|
|
322
|
+
requestManager: {
|
|
323
|
+
...request.client.requestManager,
|
|
324
|
+
abortByKey: abortSpy,
|
|
325
|
+
},
|
|
326
|
+
},
|
|
327
|
+
abortKey: request.abortKey,
|
|
328
|
+
scope: request.scope,
|
|
329
|
+
};
|
|
330
|
+
|
|
331
|
+
const { result } = renderUseStream(mockRequest);
|
|
332
|
+
|
|
333
|
+
act(() => {
|
|
334
|
+
result.current.start();
|
|
335
|
+
});
|
|
336
|
+
|
|
337
|
+
await waitFor(() => {
|
|
338
|
+
expect(result.current.streaming).toBe(true);
|
|
339
|
+
});
|
|
340
|
+
|
|
341
|
+
act(() => {
|
|
342
|
+
result.current.abort();
|
|
343
|
+
});
|
|
344
|
+
|
|
345
|
+
expect(result.current.streaming).toBe(false);
|
|
346
|
+
expect(abortSpy).toHaveBeenCalled();
|
|
347
|
+
|
|
348
|
+
await act(async () => {
|
|
349
|
+
resolvePull!();
|
|
350
|
+
});
|
|
351
|
+
});
|
|
352
|
+
});
|
|
353
|
+
|
|
354
|
+
describe("when reset is called", () => {
|
|
355
|
+
it("should reset all state to initial values", async () => {
|
|
356
|
+
const sendMock = vi.fn().mockResolvedValue({
|
|
357
|
+
data: "some data",
|
|
358
|
+
error: null,
|
|
359
|
+
status: 200,
|
|
360
|
+
extra: { headers: {} },
|
|
361
|
+
});
|
|
362
|
+
|
|
363
|
+
const mockRequest = {
|
|
364
|
+
...request,
|
|
365
|
+
setOptions: vi.fn().mockReturnValue({ send: sendMock }),
|
|
366
|
+
client: request.client,
|
|
367
|
+
abortKey: request.abortKey,
|
|
368
|
+
scope: request.scope,
|
|
369
|
+
};
|
|
370
|
+
|
|
371
|
+
const { result } = renderUseStream(mockRequest);
|
|
372
|
+
|
|
373
|
+
await act(async () => {
|
|
374
|
+
result.current.start();
|
|
375
|
+
});
|
|
376
|
+
|
|
377
|
+
await waitFor(() => {
|
|
378
|
+
expect(result.current.done).toBe(true);
|
|
379
|
+
});
|
|
380
|
+
|
|
381
|
+
expect(result.current.text).toBe("some data");
|
|
382
|
+
|
|
383
|
+
act(() => {
|
|
384
|
+
result.current.reset();
|
|
385
|
+
});
|
|
386
|
+
|
|
387
|
+
expect(result.current.text).toBe("");
|
|
388
|
+
expect(result.current.chunks).toEqual([]);
|
|
389
|
+
expect(result.current.streaming).toBe(false);
|
|
390
|
+
expect(result.current.done).toBe(false);
|
|
391
|
+
expect(result.current.error).toBe(null);
|
|
392
|
+
expect(result.current.extra).toBe(null);
|
|
393
|
+
expect(result.current.status).toBe(null);
|
|
394
|
+
});
|
|
395
|
+
});
|
|
396
|
+
|
|
397
|
+
describe("when autoStart is true", () => {
|
|
398
|
+
it("should start streaming automatically on mount", async () => {
|
|
399
|
+
const sendMock = vi.fn().mockResolvedValue({
|
|
400
|
+
data: "auto-started",
|
|
401
|
+
error: null,
|
|
402
|
+
status: 200,
|
|
403
|
+
extra: null,
|
|
404
|
+
});
|
|
405
|
+
|
|
406
|
+
const mockRequest = {
|
|
407
|
+
...request,
|
|
408
|
+
setOptions: vi.fn().mockReturnValue({ send: sendMock }),
|
|
409
|
+
client: request.client,
|
|
410
|
+
abortKey: request.abortKey,
|
|
411
|
+
scope: request.scope,
|
|
412
|
+
};
|
|
413
|
+
|
|
414
|
+
const { result } = renderUseStream(mockRequest, { autoStart: true });
|
|
415
|
+
|
|
416
|
+
await waitFor(() => {
|
|
417
|
+
expect(result.current.done).toBe(true);
|
|
418
|
+
});
|
|
419
|
+
|
|
420
|
+
expect(result.current.text).toBe("auto-started");
|
|
421
|
+
expect(sendMock).toHaveBeenCalled();
|
|
422
|
+
});
|
|
423
|
+
});
|
|
424
|
+
|
|
425
|
+
describe("when start is called while already streaming", () => {
|
|
426
|
+
it("should not start a second stream", async () => {
|
|
427
|
+
let resolvePull: (() => void) | null = null;
|
|
428
|
+
const pullPromise = new Promise<void>((r) => {
|
|
429
|
+
resolvePull = r;
|
|
430
|
+
});
|
|
431
|
+
|
|
432
|
+
const encoder = new TextEncoder();
|
|
433
|
+
const stream = new ReadableStream<Uint8Array>({
|
|
434
|
+
async pull(controller) {
|
|
435
|
+
controller.enqueue(encoder.encode("data"));
|
|
436
|
+
await pullPromise;
|
|
437
|
+
controller.close();
|
|
438
|
+
},
|
|
439
|
+
});
|
|
440
|
+
|
|
441
|
+
const sendMock = vi.fn().mockResolvedValue({
|
|
442
|
+
data: stream,
|
|
443
|
+
error: null,
|
|
444
|
+
status: 200,
|
|
445
|
+
extra: null,
|
|
446
|
+
});
|
|
447
|
+
|
|
448
|
+
const mockRequest = {
|
|
449
|
+
...request,
|
|
450
|
+
setOptions: vi.fn().mockReturnValue({ send: sendMock }),
|
|
451
|
+
client: request.client,
|
|
452
|
+
abortKey: request.abortKey,
|
|
453
|
+
scope: request.scope,
|
|
454
|
+
};
|
|
455
|
+
|
|
456
|
+
const { result } = renderUseStream(mockRequest);
|
|
457
|
+
|
|
458
|
+
act(() => {
|
|
459
|
+
result.current.start();
|
|
460
|
+
});
|
|
461
|
+
|
|
462
|
+
await waitFor(() => {
|
|
463
|
+
expect(result.current.streaming).toBe(true);
|
|
464
|
+
});
|
|
465
|
+
|
|
466
|
+
act(() => {
|
|
467
|
+
result.current.start();
|
|
468
|
+
});
|
|
469
|
+
|
|
470
|
+
expect(sendMock).toHaveBeenCalledTimes(1);
|
|
471
|
+
|
|
472
|
+
await act(async () => {
|
|
473
|
+
resolvePull!();
|
|
474
|
+
});
|
|
475
|
+
|
|
476
|
+
await waitFor(() => {
|
|
477
|
+
expect(result.current.done).toBe(true);
|
|
478
|
+
});
|
|
479
|
+
});
|
|
480
|
+
});
|
|
481
|
+
});
|
|
@@ -7,7 +7,7 @@ import { testInitialState, testSuccessState } from "../../shared";
|
|
|
7
7
|
const { resetMocks, startServer, stopServer, mockRequest } = createHttpMockingServer();
|
|
8
8
|
|
|
9
9
|
describe("useSubmit [ Base ]", () => {
|
|
10
|
-
let request = createRequest
|
|
10
|
+
let request = createRequest({ method: "POST" });
|
|
11
11
|
|
|
12
12
|
beforeAll(() => {
|
|
13
13
|
startServer();
|
|
@@ -22,7 +22,7 @@ describe("useSubmit [ Base ]", () => {
|
|
|
22
22
|
});
|
|
23
23
|
|
|
24
24
|
beforeEach(() => {
|
|
25
|
-
|
|
25
|
+
vi.resetModules();
|
|
26
26
|
client.clear();
|
|
27
27
|
request = createRequest({ method: "POST" });
|
|
28
28
|
});
|
|
@@ -24,7 +24,7 @@ describe("useSubmit [ Concurrency ]", () => {
|
|
|
24
24
|
});
|
|
25
25
|
|
|
26
26
|
beforeEach(() => {
|
|
27
|
-
|
|
27
|
+
vi.resetModules();
|
|
28
28
|
client.clear();
|
|
29
29
|
client = createClient({ url: "http://localhost:3000" });
|
|
30
30
|
request = client.createRequest<{ response: null; payload: null }>()({ method: "POST", endpoint: "" });
|