-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
use-swr-infinite.ts
231 lines (203 loc) · 6.24 KB
/
use-swr-infinite.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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
import { useContext, useRef, useState, useEffect, useCallback } from 'react'
import defaultConfig, { cache } from './config'
import SWRConfigContext from './swr-config-context'
import useSWR from './use-swr'
import { keyType, fetcherFn, ConfigInterface, responseInterface } from './types'
type KeyLoader<Data = any> = (
index: number,
previousPageData: Data | null
) => keyType
type SWRInfiniteConfigInterface<Data = any, Error = any> = ConfigInterface<
Data[],
Error,
fetcherFn<Data[]>
> & {
initialSize?: number
revalidateAll?: boolean
persistSize?: boolean
}
type SWRInfiniteResponseInterface<Data = any, Error = any> = responseInterface<
Data[],
Error
> & {
size: number
setSize: (
size: number | ((size: number) => number)
) => Promise<Data[] | undefined>
}
function useSWRInfinite<Data = any, Error = any>(
getKey: KeyLoader<Data>
): SWRInfiniteResponseInterface<Data, Error>
function useSWRInfinite<Data = any, Error = any>(
getKey: KeyLoader<Data>,
config?: SWRInfiniteConfigInterface<Data, Error>
): SWRInfiniteResponseInterface<Data, Error>
function useSWRInfinite<Data = any, Error = any>(
getKey: KeyLoader<Data>,
fn?: fetcherFn<Data>,
config?: SWRInfiniteConfigInterface<Data, Error>
): SWRInfiniteResponseInterface<Data, Error>
function useSWRInfinite<Data = any, Error = any>(
...args
): SWRInfiniteResponseInterface<Data, Error> {
let getKey: KeyLoader<Data>,
fn: fetcherFn<Data> | undefined,
config: SWRInfiniteConfigInterface<Data, Error> = {}
if (args.length >= 1) {
getKey = args[0]
}
if (args.length > 2) {
fn = args[1]
config = args[2]
} else {
if (typeof args[1] === 'function') {
fn = args[1]
} else if (typeof args[1] === 'object') {
config = args[1]
}
}
config = Object.assign(
{},
defaultConfig,
useContext(SWRConfigContext),
config
)
let {
initialSize = 1,
revalidateAll = false,
persistSize = false,
fetcher: defaultFetcher,
...extraConfig
} = config
if (typeof fn === 'undefined') {
// use the global fetcher
// we have to convert the type here
fn = (defaultFetcher as unknown) as fetcherFn<Data>
}
// get the serialized key of the first page
let firstPageKey: string | null = null
try {
;[firstPageKey] = cache.serializeKey(getKey(0, null))
} catch (err) {
// not ready
}
const rerender = useState<boolean>(false)[1]
// we use cache to pass extra info (context) to fetcher so it can be globally shared
// here we get the key of the fetcher context cache
let contextCacheKey: string | null = null
if (firstPageKey) {
contextCacheKey = 'context@' + firstPageKey
}
// page count is cached as well, so when navigating the list can be restored
let pageCountCacheKey: string | null = null
let cachedPageSize
if (firstPageKey) {
pageCountCacheKey = 'size@' + firstPageKey
cachedPageSize = cache.get(pageCountCacheKey)
}
const pageCountRef = useRef<number>(cachedPageSize || initialSize)
const didMountRef = useRef<boolean>(false)
// every time the key changes, we reset the page size if it's not persisted
useEffect(() => {
if (didMountRef.current) {
if (!persistSize) {
pageCountRef.current = initialSize
}
} else {
didMountRef.current = true
}
}, [firstPageKey])
// actual swr of all pages
const swr = useSWR<Data[], Error>(
firstPageKey ? ['many', firstPageKey] : null,
async () => {
// get the revalidate context
const { originalData, force } = cache.get(contextCacheKey) || {}
// return an array of page data
const data: Data[] = []
let previousPageData = null
for (let i = 0; i < pageCountRef.current; ++i) {
const [pageKey, pageArgs] = cache.serializeKey(
getKey(i, previousPageData)
)
if (!pageKey) {
// pageKey is falsy, stop fetching next pages
break
}
// get the current page cache
let pageData = cache.get(pageKey)
// must revalidate if:
// - forced to revalidate all
// - we revalidate the first page by default (e.g.: upon focus)
// - page has changed
// - the offset has changed so the cache is missing
const shouldRevalidatePage =
revalidateAll ||
force ||
(typeof force === 'undefined' && i === 0 && originalData) ||
(originalData && !config.compare(originalData[i], pageData)) ||
typeof pageData === 'undefined'
if (shouldRevalidatePage) {
if (pageArgs !== null) {
pageData = await fn(...pageArgs)
} else {
pageData = await fn(pageKey)
}
cache.set(pageKey, pageData)
}
data.push(pageData)
previousPageData = pageData
}
// once we executed the data fetching based on the context, clear the context
cache.delete(contextCacheKey)
// return the data
return data
},
extraConfig
)
// keep the data inside a ref
const dataRef = useRef<Data[]>(swr.data)
useEffect(() => {
dataRef.current = swr.data
}, [swr.data])
const mutate = useCallback(
(data, shouldRevalidate = true) => {
if (shouldRevalidate && typeof data !== 'undefined') {
// we only revalidate the pages that are changed
const originalData = dataRef.current
cache.set(contextCacheKey, { originalData, force: false })
} else if (shouldRevalidate) {
// calling `mutate()`, we revalidate all pages
cache.set(contextCacheKey, { force: true })
}
return swr.mutate(data, shouldRevalidate)
},
[swr.mutate, contextCacheKey]
)
// extend the SWR API
const size = pageCountRef.current
const setSize = useCallback(
arg => {
if (typeof arg === 'function') {
pageCountRef.current = arg(pageCountRef.current)
} else if (typeof arg === 'number') {
pageCountRef.current = arg
}
cache.set(pageCountCacheKey, pageCountRef.current)
rerender(v => !v)
return mutate(v => v)
},
[mutate, pageCountCacheKey]
)
return {
...swr,
mutate,
size,
setSize
} as SWRInfiniteResponseInterface<Data, Error>
}
export {
useSWRInfinite,
SWRInfiniteConfigInterface,
SWRInfiniteResponseInterface
}