Repository navigation
Expand file tree
/
Copy pathQueryClient.ts
More file actions
277 lines (252 loc) · 11.6 KB
/
Copy pathQueryClient.ts
File metadata and controls
277 lines (252 loc) · 11.6 KB
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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
import * as Atom from "@effect-atom/atom/Atom"
import * as AtomRegistry from "@effect-atom/atom/Registry"
import * as Cause from "effect/Cause"
import * as Chunk from "effect/Chunk"
import * as Data from "effect/Data"
import * as Effect from "effect/Effect"
import * as HashSet from "effect/HashSet"
import * as Layer from "effect/Layer"
import * as Option from "effect/Option"
import * as Stream from "effect/Stream"
import * as SubscriptionRef from "effect/SubscriptionRef"
import type { Query, QueryAtom, State as QueryState } from "./Query.js"
import {
type ErasedQueryEntry,
makeQueryCache,
mutationMatches,
QueryCacheTypeId,
QueryClient,
type QueryCache,
type QueryFetch,
queryEntry,
queryMatches,
subscriptionMatches,
type QueryClientEvent,
type QueryFilter,
type QueryMetadata
} from "./internal.js"
import type { AnyMutationState, MutationFilter, SubscriptionFilter } from "./Model.js"
export type { QueryClientEvent, QueryFilter, QueryMetadata, SubscriptionFilter }
export { QueryClient }
export interface QueryBatchFailure {
readonly name: string
readonly keyHash: number
readonly cause: Cause.Cause<unknown>
}
export class QueryBatchError extends Data.TaggedError("QueryBatchError")<{
readonly failures: ReadonlyArray<QueryBatchFailure>
}> {}
export interface Service {
/** The client's caches; package-internal. */
readonly [QueryCacheTypeId]: QueryCache
readonly resolve: <Input, Data, Error, Requirements>(
query: Query<Input, Data, Error, Requirements>,
input: Input
) => QueryAtom<Input, Data, Error, Requirements>
readonly fetch: <Input, Data, Error, Requirements>(
query: QueryAtom<Input, Data, Error, Requirements>
) => Effect.Effect<Data, Error>
readonly ensure: <Input, Data, Error, Requirements>(
query: QueryAtom<Input, Data, Error, Requirements>
) => Effect.Effect<Data, Error>
readonly prefetch: <Input, Data, Error, Requirements>(
query: QueryAtom<Input, Data, Error, Requirements>
) => Effect.Effect<void>
readonly invalidate: (
filter?: QueryFilter,
options?: { readonly refetch?: boolean }
) => Effect.Effect<void>
readonly refetch: (filter?: QueryFilter) => Effect.Effect<void, QueryBatchError>
readonly cancel: (filter?: QueryFilter) => Effect.Effect<void>
readonly remove: (filter?: QueryFilter) => Effect.Effect<void>
readonly getState: <Input, Data, Error, Requirements>(
query: QueryAtom<Input, Data, Error, Requirements>
) => Effect.Effect<Option.Option<QueryState<Data, Error>>>
readonly setData: <Input, Data, Error, Requirements>(
query: QueryAtom<Input, Data, Error, Requirements>,
update: (current: Option.Option<Data>) => Data
) => Effect.Effect<void>
readonly isFetching: (filter?: QueryFilter) => Atom.Atom<number>
readonly isMutating: (filter?: MutationFilter) => Atom.Atom<number>
readonly mutationState: (filter?: MutationFilter) => Atom.Atom<ReadonlyArray<AnyMutationState>>
/** Reopens every matching mounted subscription now (`Atom.Reset`). */
readonly reconnect: (filter?: SubscriptionFilter) => Effect.Effect<void>
readonly events: Stream.Stream<QueryClientEvent>
}
/** Await the exact fetch ticket while the query remains in this cache. */
const awaitFetch = <Data>(
cache: QueryCache,
entry: ErasedQueryEntry,
fetch: QueryFetch<Data>
): Effect.Effect<Data, unknown> => Effect.raceFirst(
fetch.await,
cache.awaitRemoval(entry).pipe(Effect.zipRight(Effect.interrupt))
)
const makeService = (
registry: AtomRegistry.Registry,
cache: QueryCache,
resolve: Service["resolve"]
): Service => {
const queriesAtom = Atom.subscriptionRef(cache.queries)
const mutationsAtom = Atom.subscriptionRef(cache.mutations)
const entries = (filter?: QueryFilter): Effect.Effect<ReadonlyArray<ErasedQueryEntry>> =>
Effect.map(SubscriptionRef.get(cache.queries), (current) =>
[...current].filter((entry) => queryMatches(registry, entry, filter)))
/** Make the entry current in the cache (restoring it if removed) and materialize its atoms. */
const entryFor = <Input, Data, Error, Requirements>(
query: QueryAtom<Input, Data, Error, Requirements>
): Effect.Effect<readonly [ReturnType<typeof queryEntry<Data>>, boolean]> => Effect.gen(function*() {
const entry = queryEntry(query)
const existed = HashSet.has(yield* SubscriptionRef.get(cache.queries), entry)
yield* cache.restoreQuery(entry)
registry.get(query)
return [entry, existed] as const
})
const fetchQuery = <Input, Data, Error, Requirements>(
query: QueryAtom<Input, Data, Error, Requirements>
): Effect.Effect<Data, Error> => Effect.gen(function*() {
const [entry, existed] = yield* entryFor(query)
const state = entry.state(registry)
if (state.fetchStatus !== "paused" && entry.hasData(registry) && !state.isStale) {
return Option.getOrThrow(entry.getData(registry))
}
const fetch = !existed && state.fetchStatus !== "paused"
? entry.join(registry)
: entry.start(registry)
return yield* awaitFetch(cache, entry, fetch) as Effect.Effect<Data, Error>
})
const ensureQuery = <Input, Data, Error, Requirements>(
query: QueryAtom<Input, Data, Error, Requirements>
): Effect.Effect<Data, Error> => Effect.gen(function*() {
const [entry, existed] = yield* entryFor(query)
if (entry.hasData(registry)) {
if (existed && entry.state(registry).isStale && entry.state(registry).fetchStatus !== "fetching") {
entry.start(registry)
}
return Option.getOrThrow(entry.getData(registry))
}
const fetch = !existed && entry.state(registry).fetchStatus !== "paused"
? entry.join(registry)
: entry.start(registry)
return yield* awaitFetch(cache, entry, fetch) as Effect.Effect<Data, Error>
})
return {
[QueryCacheTypeId]: cache,
resolve,
fetch: fetchQuery,
ensure: ensureQuery,
prefetch: (query) => Effect.ignore(fetchQuery(query)),
invalidate: (filter, options) => Effect.gen(function*() {
for (const entry of yield* entries(filter)) {
entry.invalidate(registry)
yield* cache.emit({ _tag: "QueryInvalidated", name: entry.name, keyHash: entry.keyHash })
if (options?.refetch !== false) entry.start(registry, { cancelRefetch: true })
}
}),
refetch: (filter) => Effect.gen(function*() {
const started = (yield* entries(filter)).map((entry) => ({
entry,
fetch: entry.start(registry, { cancelRefetch: true })
}))
const exits = yield* Effect.forEach(
started,
({ entry, fetch }) => Effect.exit(awaitFetch(cache, entry, fetch)),
{ concurrency: "unbounded" }
)
const failures: Array<QueryBatchFailure> = exits.flatMap((exit, index) => exit._tag === "Failure"
? [{ name: started[index]!.entry.name, keyHash: started[index]!.entry.keyHash, cause: exit.cause }]
: [])
if (failures.length > 0) return yield* new QueryBatchError({ failures })
}),
cancel: (filter) => Effect.gen(function*() {
for (const entry of yield* entries(filter)) yield* entry.cancel(registry)
}),
remove: (filter) => Effect.gen(function*() {
for (const entry of yield* entries(filter)) {
yield* cache.removeQuery(entry)
yield* entry.cancel(registry)
}
}),
getState: (query) => Effect.map(SubscriptionRef.get(cache.queries), (current) =>
HashSet.has(current, queryEntry(query))
? Option.some(registry.get(query))
: Option.none()),
setData: (query, update) => Effect.gen(function*() {
const [entry] = yield* entryFor(query)
yield* entry.setData(registry, update)
}),
isFetching: (filter) => Atom.readable((get) => {
const matching = [...get(queriesAtom)].filter((entry) => queryMatches(registry, entry, filter))
for (const entry of matching) get(entry.stateAtom)
return matching.filter((entry) => entry.state(registry).fetchStatus === "fetching").length
}),
isMutating: (filter) => Atom.readable((get) =>
Chunk.toReadonlyArray(get(mutationsAtom))
.filter((state) => mutationMatches(state, filter))
.filter((state) => state.result.waiting || state.result._tag === "Initial")
.length),
mutationState: (filter) => Atom.readable((get) =>
Chunk.toReadonlyArray(get(mutationsAtom)).filter((state) => mutationMatches(state, filter))),
reconnect: (filter) => Effect.gen(function*() {
for (const entry of yield* SubscriptionRef.get(cache.subscriptions)) {
if (subscriptionMatches(entry, filter)) entry.reconnect(registry)
}
}),
events: cache.events
}
}
/** Internal layer constructor used by a connection-scoped Client. Owns the client's caches. */
export const makeLayer = (
resolve: Service["resolve"]
): Layer.Layer<QueryClient, never, AtomRegistry.AtomRegistry> =>
Layer.scoped(QueryClient, Effect.gen(function*() {
const registry = yield* AtomRegistry.AtomRegistry
const cache = yield* makeQueryCache
return makeService(registry, cache, resolve)
}))
export const fetch = <Input, Data, Error, Requirements>(
query: Query<Input, Data, Error, Requirements>,
input: Input
): Effect.Effect<Data, Error, QueryClient> =>
Effect.flatMap(QueryClient, (client) => client.fetch(client.resolve(query, input)))
export const ensure = <Input, Data, Error, Requirements>(
query: Query<Input, Data, Error, Requirements>,
input: Input
): Effect.Effect<Data, Error, QueryClient> =>
Effect.flatMap(QueryClient, (client) => client.ensure(client.resolve(query, input)))
export const prefetch = <Input, Data, Error, Requirements>(
query: Query<Input, Data, Error, Requirements>,
input: Input
): Effect.Effect<void, never, QueryClient> =>
Effect.flatMap(QueryClient, (client) => client.prefetch(client.resolve(query, input)))
export const invalidate = (
filter?: QueryFilter,
options?: { readonly refetch?: boolean }
): Effect.Effect<void, never, QueryClient> => Effect.flatMap(QueryClient, (client) => client.invalidate(filter, options))
export const refetch = (filter?: QueryFilter): Effect.Effect<void, QueryBatchError, QueryClient> =>
Effect.flatMap(QueryClient, (client) => client.refetch(filter))
export const cancel = (filter?: QueryFilter): Effect.Effect<void, never, QueryClient> =>
Effect.flatMap(QueryClient, (client) => client.cancel(filter))
export const remove = (filter?: QueryFilter): Effect.Effect<void, never, QueryClient> =>
Effect.flatMap(QueryClient, (client) => client.remove(filter))
export const getState = <Input, Data, Error, Requirements>(
query: Query<Input, Data, Error, Requirements>,
input: Input
): Effect.Effect<Option.Option<QueryState<Data, Error>>, never, QueryClient> =>
Effect.flatMap(QueryClient, (client) => client.getState(client.resolve(query, input)))
export const setData = <Input, Data, Error, Requirements>(
query: Query<Input, Data, Error, Requirements>,
input: Input,
update: (current: Option.Option<Data>) => Data
): Effect.Effect<void, never, QueryClient> =>
Effect.flatMap(QueryClient, (client) => client.setData(client.resolve(query, input), update))
export const isFetching = (filter?: QueryFilter): Effect.Effect<Atom.Atom<number>, never, QueryClient> =>
Effect.map(QueryClient, (client) => client.isFetching(filter))
export const isMutating = (filter?: MutationFilter): Effect.Effect<Atom.Atom<number>, never, QueryClient> =>
Effect.map(QueryClient, (client) => client.isMutating(filter))
export const mutationState = (
filter?: MutationFilter
): Effect.Effect<Atom.Atom<ReadonlyArray<AnyMutationState>>, never, QueryClient> =>
Effect.map(QueryClient, (client) => client.mutationState(filter))
export const reconnect = (filter?: SubscriptionFilter): Effect.Effect<void, never, QueryClient> =>
Effect.flatMap(QueryClient, (client) => client.reconnect(filter))