-
Notifications
You must be signed in to change notification settings - Fork 554
/
types.ts
464 lines (395 loc) · 10.7 KB
/
types.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
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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
import {
ResponseType,
ResponseTypeNames,
ResponseTypeStrings,
XRPCError as XRPCClientError,
} from '@atproto/xrpc'
import express from 'express'
import { IncomingMessage } from 'http'
import { isHttpError } from 'http-errors'
import { Readable } from 'stream'
import zod from 'zod'
export type CatchallHandler = (
req: express.Request,
_res: express.Response,
next: express.NextFunction,
) => unknown
export type Options = {
validateResponse?: boolean
catchall?: CatchallHandler
payload?: {
jsonLimit?: number
blobLimit?: number
textLimit?: number
}
rateLimits?: {
creator: RateLimiterCreator
global?: ServerRateLimitDescription[]
shared?: ServerRateLimitDescription[]
}
}
export type UndecodedParams = (typeof express.request)['query']
export type Primitive = string | number | boolean
export type Params = Record<string, Primitive | Primitive[] | undefined>
export const handlerInput = zod.object({
encoding: zod.string(),
body: zod.any(),
})
export type HandlerInput = zod.infer<typeof handlerInput>
export const handlerAuth = zod.object({
credentials: zod.any(),
artifacts: zod.any(),
})
export type HandlerAuth = zod.infer<typeof handlerAuth>
export const headersSchema = zod.record(zod.string())
export const handlerSuccess = zod.object({
encoding: zod.string(),
body: zod.any(),
headers: headersSchema.optional(),
})
export type HandlerSuccess = zod.infer<typeof handlerSuccess>
export const handlerPipeThroughBuffer = zod.object({
encoding: zod.string(),
buffer: zod.instanceof(Buffer),
headers: headersSchema.optional(),
})
export type HandlerPipeThroughBuffer = zod.infer<
typeof handlerPipeThroughBuffer
>
export const handlerPipeThroughStream = zod.object({
encoding: zod.string(),
stream: zod.instanceof(Readable),
headers: headersSchema.optional(),
})
export type HandlerPipeThroughStream = zod.infer<
typeof handlerPipeThroughStream
>
export const handlerPipeThrough = zod.union([
handlerPipeThroughBuffer,
handlerPipeThroughStream,
])
export type HandlerPipeThrough = zod.infer<typeof handlerPipeThrough>
export const handlerError = zod.object({
status: zod.number(),
error: zod.string().optional(),
message: zod.string().optional(),
})
export type HandlerError = zod.infer<typeof handlerError>
export type HandlerOutput = HandlerSuccess | HandlerPipeThrough | HandlerError
export type XRPCReqContext = {
auth: HandlerAuth | undefined
params: Params
input: HandlerInput | undefined
req: express.Request
res: express.Response
}
export type XRPCHandler = (
ctx: XRPCReqContext,
) => Promise<HandlerOutput> | HandlerOutput | undefined
export type XRPCStreamHandler = (ctx: {
auth: HandlerAuth | undefined
params: Params
req: IncomingMessage
signal: AbortSignal
}) => AsyncIterable<unknown>
export type AuthOutput = HandlerAuth | HandlerError
export interface AuthVerifierContext {
req: express.Request
res: express.Response
}
export type AuthVerifier = (
ctx: AuthVerifierContext,
) => Promise<AuthOutput> | AuthOutput
export interface StreamAuthVerifierContext {
req: IncomingMessage
}
export type StreamAuthVerifier = (
ctx: StreamAuthVerifierContext,
) => Promise<AuthOutput> | AuthOutput
export type CalcKeyFn = (ctx: XRPCReqContext) => string | null
export type CalcPointsFn = (ctx: XRPCReqContext) => number
export interface RateLimiterI {
consume: RateLimiterConsume
}
export type RateLimiterConsume = (
ctx: XRPCReqContext,
opts?: { calcKey?: CalcKeyFn; calcPoints?: CalcPointsFn },
) => Promise<RateLimiterStatus | RateLimitExceededError | null>
export type RateLimiterCreator = (opts: {
keyPrefix: string
durationMs: number
points: number
calcKey?: CalcKeyFn
calcPoints?: CalcPointsFn
}) => RateLimiterI
export type ServerRateLimitDescription = {
name: string
durationMs: number
points: number
calcKey?: CalcKeyFn
calcPoints?: CalcPointsFn
}
export type SharedRateLimitOpts = {
name: string
calcKey?: CalcKeyFn
calcPoints?: CalcPointsFn
}
export type RouteRateLimitOpts = {
durationMs: number
points: number
calcKey?: CalcKeyFn
calcPoints?: CalcPointsFn
}
export type HandlerRateLimitOpts = SharedRateLimitOpts | RouteRateLimitOpts
export const isShared = (
opts: HandlerRateLimitOpts,
): opts is SharedRateLimitOpts => {
return typeof opts['name'] === 'string'
}
export type RateLimiterStatus = {
limit: number
duration: number
remainingPoints: number
msBeforeNext: number
consumedPoints: number
isFirstInDuration: boolean
}
export type RouteOpts = {
blobLimit?: number
}
export type XRPCHandlerConfig = {
opts?: RouteOpts
rateLimit?: HandlerRateLimitOpts | HandlerRateLimitOpts[]
auth?: AuthVerifier
handler: XRPCHandler
}
export type XRPCStreamHandlerConfig = {
auth?: StreamAuthVerifier
handler: XRPCStreamHandler
}
export class XRPCError extends Error {
constructor(
public type: ResponseType,
public errorMessage?: string,
public customErrorName?: string,
options?: ErrorOptions,
) {
super(errorMessage, options)
}
get payload() {
return {
error: this.customErrorName ?? this.typeName,
message:
this.type === ResponseType.InternalServerError
? this.typeStr // Do not respond with error details for 500s
: this.errorMessage || this.typeStr,
}
}
get typeName(): string | undefined {
return ResponseTypeNames[this.type]
}
get typeStr(): string | undefined {
return ResponseTypeStrings[this.type]
}
static fromError(cause: unknown): XRPCError {
if (cause instanceof XRPCError) {
return cause
}
if (cause instanceof XRPCClientError) {
return new XRPCError(cause.status, cause.message, cause.error, { cause })
}
if (isHttpError(cause)) {
return new XRPCError(cause.status, cause.message, cause.name, { cause })
}
if (isHandlerError(cause)) {
return this.fromHandlerError(cause)
}
if (cause instanceof Error) {
return new InternalServerError(cause.message, undefined, { cause })
}
return new InternalServerError(
'Unexpected internal server error',
undefined,
{ cause },
)
}
static fromHandlerError(err: HandlerError): XRPCError {
return new XRPCError(err.status, err.message, err.error, { cause: err })
}
}
export function isHandlerError(v: unknown): v is HandlerError {
return (
!!v &&
typeof v === 'object' &&
typeof v['status'] === 'number' &&
(v['error'] === undefined || typeof v['error'] === 'string') &&
(v['message'] === undefined || typeof v['message'] === 'string')
)
}
export function isHandlerPipeThroughBuffer(
v: HandlerOutput,
): v is HandlerPipeThroughBuffer {
// We only need to discriminate between possible HandlerOutput values
return v['buffer'] !== undefined
}
export function isHandlerPipeThroughStream(
v: HandlerOutput,
): v is HandlerPipeThroughStream {
// We only need to discriminate between possible HandlerOutput values
return v['stream'] !== undefined
}
export class InvalidRequestError extends XRPCError {
constructor(
errorMessage?: string,
customErrorName?: string,
options?: ErrorOptions,
) {
super(ResponseType.InvalidRequest, errorMessage, customErrorName, options)
}
[Symbol.hasInstance](instance: unknown): boolean {
return (
instance instanceof XRPCError &&
instance.type === ResponseType.InvalidRequest
)
}
}
export class AuthRequiredError extends XRPCError {
constructor(
errorMessage?: string,
customErrorName?: string,
options?: ErrorOptions,
) {
super(ResponseType.AuthRequired, errorMessage, customErrorName, options)
}
[Symbol.hasInstance](instance: unknown): boolean {
return (
instance instanceof XRPCError &&
instance.type === ResponseType.AuthRequired
)
}
}
export class ForbiddenError extends XRPCError {
constructor(
errorMessage?: string,
customErrorName?: string,
options?: ErrorOptions,
) {
super(ResponseType.Forbidden, errorMessage, customErrorName, options)
}
[Symbol.hasInstance](instance: unknown): boolean {
return (
instance instanceof XRPCError && instance.type === ResponseType.Forbidden
)
}
}
export class RateLimitExceededError extends XRPCError {
constructor(
public status: RateLimiterStatus,
errorMessage?: string,
customErrorName?: string,
options?: ErrorOptions,
) {
super(
ResponseType.RateLimitExceeded,
errorMessage,
customErrorName,
options,
)
}
[Symbol.hasInstance](instance: unknown): boolean {
return (
instance instanceof XRPCError &&
instance.type === ResponseType.RateLimitExceeded
)
}
}
export class InternalServerError extends XRPCError {
constructor(
errorMessage?: string,
customErrorName?: string,
options?: ErrorOptions,
) {
super(
ResponseType.InternalServerError,
errorMessage,
customErrorName,
options,
)
}
[Symbol.hasInstance](instance: unknown): boolean {
return (
instance instanceof XRPCError &&
instance.type === ResponseType.InternalServerError
)
}
}
export class UpstreamFailureError extends XRPCError {
constructor(
errorMessage?: string,
customErrorName?: string,
options?: ErrorOptions,
) {
super(ResponseType.UpstreamFailure, errorMessage, customErrorName, options)
}
[Symbol.hasInstance](instance: unknown): boolean {
return (
instance instanceof XRPCError &&
instance.type === ResponseType.UpstreamFailure
)
}
}
export class NotEnoughResourcesError extends XRPCError {
constructor(
errorMessage?: string,
customErrorName?: string,
options?: ErrorOptions,
) {
super(
ResponseType.NotEnoughResources,
errorMessage,
customErrorName,
options,
)
}
[Symbol.hasInstance](instance: unknown): boolean {
return (
instance instanceof XRPCError &&
instance.type === ResponseType.NotEnoughResources
)
}
}
export class UpstreamTimeoutError extends XRPCError {
constructor(
errorMessage?: string,
customErrorName?: string,
options?: ErrorOptions,
) {
super(ResponseType.UpstreamTimeout, errorMessage, customErrorName, options)
}
[Symbol.hasInstance](instance: unknown): boolean {
return (
instance instanceof XRPCError &&
instance.type === ResponseType.UpstreamTimeout
)
}
}
export class MethodNotImplementedError extends XRPCError {
constructor(
errorMessage?: string,
customErrorName?: string,
options?: ErrorOptions,
) {
super(
ResponseType.MethodNotImplemented,
errorMessage,
customErrorName,
options,
)
}
[Symbol.hasInstance](instance: unknown): boolean {
return (
instance instanceof XRPCError &&
instance.type === ResponseType.MethodNotImplemented
)
}
}