-
Notifications
You must be signed in to change notification settings - Fork 86
/
index.ts
175 lines (158 loc) · 5.09 KB
/
index.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
import {useEffect, useCallback, useRef} from 'react';
import {useForceUpdate} from '@huse/update';
import {useOriginalDeepCopy} from '@huse/previous-value';
import {
QueryStrategy,
QuerySet,
acceptLatest,
createStrategy,
keepEarliest,
keepEarliestSuccess,
waitAccept,
findQuery,
} from 'query-shape';
export type ResponseStrategy = 'acceptLatest' | 'keepEarliest' | 'keepEarliestSuccess' | 'waitAccept';
export type Request<K, O> = (key: K) => Promise<O>;
export interface RequestOptions {
strategy?: ResponseStrategy;
idempotent?: boolean;
}
export interface RequestResult<O = void, E = Error> {
pending: boolean;
pendingCount?: number;
data?: O;
error?: E;
nextData?: O;
nextError?: E;
accept(): void;
}
const builtInStrategies: {[K in ResponseStrategy]: QueryStrategy} = {
acceptLatest: createStrategy(acceptLatest),
keepEarliest: createStrategy(keepEarliest),
keepEarliestSuccess: createStrategy(keepEarliestSuccess),
waitAccept: createStrategy(waitAccept),
};
export function useRequestCallback<K, O = void, E = Error>(
task: Request<K, O>,
params: K,
options?: RequestOptions
): [() => void, RequestResult<O, E>] {
const {strategy = 'acceptLatest', idempotent = false} = options || {};
if (!builtInStrategies.hasOwnProperty(strategy)) {
throw new Error(`Strategy named ${strategy} is not supported in useRequest`);
}
const implement = builtInStrategies[strategy];
const unmounted = useRef(false);
const querySets = useRef(new WeakMap<typeof task, QuerySet<K, O, E>>());
const forceUpdate = useForceUpdate();
const safeForceUpdate = useCallback(
() => {
if (!unmounted.current) {
forceUpdate();
}
},
[forceUpdate]
);
const fetch = useCallback(
(key: K) => {
const querySet = querySets.current.get(task) as QuerySet<K, O, E>;
querySets.current.set(task, implement.fetch(querySet, key));
safeForceUpdate();
},
[safeForceUpdate, implement, task]
);
const receive = useCallback(
(key: K, data: O) => {
const querySet = querySets.current.get(task) as QuerySet<K, O, E>;
querySets.current.set(task, implement.receive(querySet, key, data));
safeForceUpdate();
},
[safeForceUpdate, implement, task]
);
const error = useCallback(
(key: K, error: E) => {
const querySet = querySets.current.get(task) as QuerySet<K, O, E>;
querySets.current.set(task, implement.error(querySet, key, error));
safeForceUpdate();
},
[safeForceUpdate, implement, task]
);
const key = useOriginalDeepCopy(params);
const querySet = querySets.current.get(task);
const query = querySet && findQuery(querySet, key);
const skipEffect = idempotent && !!query;
const request = useCallback(
() => {
if (skipEffect) {
return;
}
if (!querySets.current.has(task)) {
querySets.current.set(task, implement.initialize());
}
fetch(key);
task(key).then(
data => receive(key, data),
ex => error(key, ex)
);
},
[error, fetch, implement, key, receive, skipEffect, task]
);
const acceptCurrentKey = useCallback(
() => {
const querySet = querySets.current.get(task) as QuerySet<K, O, E>;
querySets.current.set(task, implement.accept(querySet, key));
safeForceUpdate();
},
[safeForceUpdate, implement, key, task]
);
useEffect(
() => {
unmounted.current = false;
return () => {
unmounted.current = true;
};
},
[]
);
if (!query) {
return [
request,
{
accept: acceptCurrentKey,
pending: false,
},
];
}
return [
request,
{
accept: acceptCurrentKey,
pendingCount: query.pendingMutex,
pending: query.pendingMutex > 0,
data: query.response?.data ?? undefined,
error: query.response?.error ?? undefined,
nextData: query.nextResponse?.data ?? undefined,
nextError: query.nextResponse?.error ?? undefined,
},
];
}
export function useRequest<K, O = void, E = Error>(
task: Request<K, O>,
params: K,
options?: RequestOptions
): RequestResult<O, E> {
const [request, result] = useRequestCallback<K, O, E>(task, params, options);
// Since `useRequestCallback` triggers request manually, its initial `pending` is `false`,
// however in `useRequest` we need initial `pending` to be `true`.
const resultFixedForEffect: RequestResult<O, E> = {
...result,
pending: result.pendingCount === undefined ? true : result.pending,
};
useEffect(
() => {
request();
},
[request]
);
return resultFixedForEffect;
}