@crvouga/mockingbird-service-resend 3.2.0 → 3.4.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/CHANGELOG.md +18 -4
- package/DISCOVERY.md +23 -0
- package/README.md +17 -7
- package/dist/{chunk-M73LWCCP.js → chunk-6Z2MR3PO.js} +33 -3
- package/dist/{chunk-M73LWCCP.js.map → chunk-6Z2MR3PO.js.map} +2 -2
- package/dist/chunk-KPX5JPKL.js +8720 -0
- package/dist/chunk-KPX5JPKL.js.map +7 -0
- package/dist/chunk-ZB42MLNS.js +4835 -0
- package/dist/chunk-ZB42MLNS.js.map +7 -0
- package/dist/cli.js +3 -3
- package/dist/crypto-II2ETGQQ.js +21 -0
- package/dist/{helpers-BMHFVPFA.js → helpers-5D4ROPWG.js} +2 -2
- package/dist/index.d.ts +362 -42
- package/dist/index.js +2 -2
- package/dist/server.d.ts +717 -83
- package/dist/server.js +3 -3
- package/package.json +3 -2
- package/dist/chunk-WMQIKI4U.js +0 -915
- package/dist/chunk-WMQIKI4U.js.map +0 -7
- package/dist/chunk-XQ4BQDIK.js +0 -6736
- package/dist/chunk-XQ4BQDIK.js.map +0 -7
- package/dist/crypto-I5AVO7Q3.js +0 -15
- /package/dist/{crypto-I5AVO7Q3.js.map → crypto-II2ETGQQ.js.map} +0 -0
- /package/dist/{helpers-BMHFVPFA.js.map → helpers-5D4ROPWG.js.map} +0 -0
package/dist/server.d.ts
CHANGED
|
@@ -145,7 +145,7 @@ type ClockState$1 = {
|
|
|
145
145
|
now: number;
|
|
146
146
|
/** True while time does not advance on its own. */
|
|
147
147
|
frozen: boolean;
|
|
148
|
-
/** Milliseconds
|
|
148
|
+
/** Milliseconds a running clock adds to its underlying source. `0` while frozen. */
|
|
149
149
|
offsetMs: number;
|
|
150
150
|
};
|
|
151
151
|
type Clock$1 = {
|
|
@@ -181,7 +181,10 @@ type Rng$1 = {
|
|
|
181
181
|
state(): number;
|
|
182
182
|
/** Restore a state previously returned by {@link state}. */
|
|
183
183
|
setState(state: number): void;
|
|
184
|
-
seed
|
|
184
|
+
/** Restart the stream from a new seed. `reset` then returns to this seed. */
|
|
185
|
+
reseed(seed: number | string): void;
|
|
186
|
+
/** The seed the stream currently starts from. */
|
|
187
|
+
readonly seed: number;
|
|
185
188
|
};
|
|
186
189
|
|
|
187
190
|
/**
|
|
@@ -190,44 +193,83 @@ type Rng$1 = {
|
|
|
190
193
|
* This is how a suite reaches the vendor's failure modes without the vendor: the
|
|
191
194
|
* quota error that only appears when a shared sandbox is full, the 429 that only
|
|
192
195
|
* appears under load, the 5xx that proves a retry path works.
|
|
196
|
+
*
|
|
197
|
+
* A rule has three parts. What it **matches** (`operationId`, `method`, `path`, …), **when**
|
|
198
|
+
* it fires among the matching requests (`after`, `every`, `count`, `rate`, `from`, `until`),
|
|
199
|
+
* and what it **does** (`status`, `delay`, `timeout`, `drop`, `truncate`, `effect`).
|
|
193
200
|
*/
|
|
194
201
|
type FaultRule$1 = {
|
|
195
|
-
/** Stable id, so a suite can retire exactly the rule it added. */
|
|
202
|
+
/** Stable id, so a suite can retire exactly the rule it added. Unique within a namespace. */
|
|
196
203
|
id: string;
|
|
197
204
|
/** Fault only this operation. Omit to match every operation. */
|
|
198
205
|
operationId?: string;
|
|
199
206
|
/** Fault only this HTTP method, case-insensitive. Omit to match every method. */
|
|
200
207
|
method?: string;
|
|
208
|
+
/** Fault only this exact path. */
|
|
209
|
+
path?: string;
|
|
201
210
|
/** Fault only paths starting with this prefix. Omit to match every path. */
|
|
202
211
|
pathPrefix?: string;
|
|
212
|
+
/** Fault only paths matching this regular expression (JavaScript syntax, unanchored). */
|
|
213
|
+
pathPattern?: string;
|
|
214
|
+
/** Fault only requests carrying these headers. `"*"` matches any value. */
|
|
215
|
+
requestHeaders?: Record<string, string>;
|
|
216
|
+
/** Fault only requests carrying these query parameters. `"*"` matches any value. */
|
|
217
|
+
query?: Record<string, string>;
|
|
203
218
|
/**
|
|
204
219
|
* Fault only this namespace. Omit (or `"*"`) to fault every namespace — which is what
|
|
205
220
|
* an in-process caller usually wants, and what a parallel worker usually does not:
|
|
206
221
|
* rules added through `POST /__admin/faults` default to the calling namespace.
|
|
207
222
|
*/
|
|
208
223
|
namespace?: string;
|
|
224
|
+
/** Let this many matching requests through first. */
|
|
225
|
+
after?: number;
|
|
226
|
+
/** Then fault only every nth matching request: `3` faults the 3rd, 6th, 9th. */
|
|
227
|
+
every?: number;
|
|
228
|
+
/** Retire the rule after this many faults. Omit to keep it until removed. */
|
|
229
|
+
count?: number;
|
|
230
|
+
/** Fault this fraction of the remaining requests, `0`–`1`, drawn from the seed. Default `1`. */
|
|
231
|
+
rate?: number;
|
|
232
|
+
/**
|
|
233
|
+
* Fault only from this instant on the namespace clock. A duration (`"5m"`) counts from the
|
|
234
|
+
* clock when the rule was added. Listed as epoch ms.
|
|
235
|
+
*/
|
|
236
|
+
from?: Instant$1 | Duration$1;
|
|
237
|
+
/** Stop faulting at this instant on the namespace clock. A duration counts from when added. */
|
|
238
|
+
until?: Instant$1 | Duration$1;
|
|
209
239
|
/**
|
|
210
|
-
* Status of the injected response. Omit for a rule that only delays
|
|
211
|
-
*
|
|
212
|
-
* the request then still reaches the service.
|
|
240
|
+
* Status of the injected response. Omit for a rule that only delays, times out, drops,
|
|
241
|
+
* truncates, or switches on an `effect`: the request then still reaches the service.
|
|
213
242
|
*/
|
|
214
243
|
status?: number;
|
|
215
244
|
/** Response body, serialized as JSON. A string is sent as-is. */
|
|
216
245
|
body?: unknown;
|
|
246
|
+
/** Response headers. */
|
|
217
247
|
headers?: Record<string, string>;
|
|
218
|
-
/**
|
|
219
|
-
|
|
220
|
-
/**
|
|
221
|
-
rate?: number;
|
|
222
|
-
/** Hold the response back this long, to exercise timeouts. */
|
|
248
|
+
/** Hold the response back this long. Listed as `delayMs`. */
|
|
249
|
+
delay?: Duration$1;
|
|
250
|
+
/** `delay`, in milliseconds. */
|
|
223
251
|
delayMs?: number;
|
|
224
252
|
/** Alias of `delayMs`. */
|
|
225
253
|
latencyMs?: number;
|
|
254
|
+
/** Extra seeded delay in `[0, jitter]`. Listed as `jitterMs`. */
|
|
255
|
+
jitter?: Duration$1;
|
|
256
|
+
jitterMs?: number;
|
|
257
|
+
/**
|
|
258
|
+
* Never answer: hold the request this long, then drop the connection. Listed as
|
|
259
|
+
* `timeoutMs`. With virtual time the wait is spent on the mock clock.
|
|
260
|
+
*/
|
|
261
|
+
timeout?: Duration$1;
|
|
262
|
+
timeoutMs?: number;
|
|
226
263
|
/**
|
|
227
264
|
* Drop the connection instead of answering: an in-process `fetch` rejects with a
|
|
228
265
|
* `TypeError`, and a served mock destroys the socket. Models "unknown outcome" failures.
|
|
229
266
|
*/
|
|
230
267
|
drop?: boolean;
|
|
268
|
+
/**
|
|
269
|
+
* Cut the response body off after this many bytes: the status and headers arrive, then
|
|
270
|
+
* the connection dies mid-body.
|
|
271
|
+
*/
|
|
272
|
+
truncate?: number;
|
|
231
273
|
/**
|
|
232
274
|
* A named service behaviour to switch on for the matching request instead of (or
|
|
233
275
|
* before) a canned response, e.g. `created_but_500` or `numeric_tracking_id`. Services
|
|
@@ -236,8 +278,8 @@ type FaultRule$1 = {
|
|
|
236
278
|
effect?: string;
|
|
237
279
|
/** Parameters for `effect`. */
|
|
238
280
|
params?: Record<string, unknown>;
|
|
239
|
-
/**
|
|
240
|
-
|
|
281
|
+
/** The preset this rule was expanded from, if any. */
|
|
282
|
+
fromPreset?: string;
|
|
241
283
|
};
|
|
242
284
|
/** A fault that fired for one request. */
|
|
243
285
|
type FaultHit$1 = {
|
|
@@ -245,6 +287,10 @@ type FaultHit$1 = {
|
|
|
245
287
|
/** The injected response; absent when the rule only delays, drops, or sets an effect. */
|
|
246
288
|
response?: Response;
|
|
247
289
|
drop?: boolean;
|
|
290
|
+
/** Set with `drop` when the rule held the request for its `timeout` first. */
|
|
291
|
+
timeout?: boolean;
|
|
292
|
+
/** Bytes of response body to let through before the connection dies. */
|
|
293
|
+
truncate?: number;
|
|
248
294
|
effect?: {
|
|
249
295
|
name: string;
|
|
250
296
|
params: Record<string, unknown>;
|
|
@@ -256,38 +302,202 @@ type FaultCandidate$1 = {
|
|
|
256
302
|
method: string;
|
|
257
303
|
path: string;
|
|
258
304
|
namespace: string;
|
|
305
|
+
/** Request headers and query, for rules that match on them. */
|
|
306
|
+
headers?: Headers;
|
|
307
|
+
query?: URLSearchParams;
|
|
308
|
+
/** The namespace clock, for `from` / `until`. Rules with a window are skipped without it. */
|
|
309
|
+
now?: number;
|
|
310
|
+
/** How to spend a delay for this request. Default: the registry's own sleep. */
|
|
311
|
+
wait?: (ms: number) => Promise<void>;
|
|
312
|
+
};
|
|
313
|
+
/** A stored rule and how often it was consulted. */
|
|
314
|
+
type FaultListing$1 = FaultRule$1 & {
|
|
315
|
+
/** Faults left before the rule retires. `null` when it has no `count`. */
|
|
316
|
+
remaining: number | null;
|
|
317
|
+
/** Times the rule faulted a request. */
|
|
318
|
+
hits: number;
|
|
319
|
+
/** Requests that matched the rule, faulted or not. */
|
|
320
|
+
seen: number;
|
|
321
|
+
};
|
|
322
|
+
/** A namespace's own rules, with their counters, in the order they are tried. */
|
|
323
|
+
type FaultSnapshot$1 = {
|
|
324
|
+
/**
|
|
325
|
+
* `position` is how many `"*"` rules are tried before the rule, which is what its place
|
|
326
|
+
* in the order means to a request and holds in any process.
|
|
327
|
+
*/
|
|
328
|
+
rules: (FaultListing$1 & {
|
|
329
|
+
position?: number;
|
|
330
|
+
})[];
|
|
331
|
+
/** How many `fault_<n>` ids the namespace has handed out. */
|
|
332
|
+
nextId?: number;
|
|
259
333
|
};
|
|
260
334
|
type FaultRegistry$1 = {
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
rules: (FaultRule$1 & {
|
|
264
|
-
remaining: number | null;
|
|
265
|
-
hits: number;
|
|
266
|
-
position: number;
|
|
267
|
-
})[];
|
|
268
|
-
rngState: number;
|
|
269
|
-
};
|
|
335
|
+
snapshot(namespace: string): FaultSnapshot$1;
|
|
336
|
+
/** Add a rule, or replace the rule with the same id in the same namespace. */
|
|
270
337
|
add(rule: FaultRule$1): FaultRule$1;
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
})[];
|
|
283
|
-
rngState: number;
|
|
284
|
-
}): void;
|
|
338
|
+
/** The next unused `fault_<n>` id in `namespace`. */
|
|
339
|
+
nextId(namespace: string): string;
|
|
340
|
+
/** Every rule, or the rules a namespace's requests can hit: its own and the global ones. */
|
|
341
|
+
list(namespace?: string): FaultListing$1[];
|
|
342
|
+
get(id: string, namespace?: string): FaultListing$1 | undefined;
|
|
343
|
+
/** Remove a rule by id: from `namespace` (its own, then a global one), or wherever it is. */
|
|
344
|
+
remove(id: string, namespace?: string): boolean;
|
|
345
|
+
/** Remove every rule, or one namespace's own rules. */
|
|
346
|
+
clear(namespace?: string): void;
|
|
347
|
+
/** Replace a namespace's own rules with a snapshot's, wherever the snapshot was taken. */
|
|
348
|
+
restore(namespace: string, state: FaultSnapshot$1): void;
|
|
285
349
|
/**
|
|
286
350
|
* Every fault this request should get, in rule order, stopping at the first that answers
|
|
287
351
|
* or drops (effect-only and delay-only rules let later rules match too). Consumes one of
|
|
288
352
|
* each matching rule's remaining uses.
|
|
289
353
|
*/
|
|
290
354
|
take(candidate: FaultCandidate$1): Promise<FaultHit$1[]>;
|
|
355
|
+
/**
|
|
356
|
+
* Fire these rules at one request without storing them: no matching, no schedule, in order,
|
|
357
|
+
* stopping at the first that answers or drops. Jitter draws from the namespace's stream.
|
|
358
|
+
*/
|
|
359
|
+
fire(rules: readonly FaultRule$1[], candidate: FaultCandidate$1): Promise<FaultHit$1[]>;
|
|
360
|
+
};
|
|
361
|
+
|
|
362
|
+
/**
|
|
363
|
+
* The admin controls every mock shares, as one document.
|
|
364
|
+
*
|
|
365
|
+
* The same shape is accepted in three places, and means the same thing in each:
|
|
366
|
+
*
|
|
367
|
+
* - at boot: `createRuntime({ adminControls })`, `serve --admin-controls`,
|
|
368
|
+
* `MOCKINGBIRD_ADMIN_CONTROLS`
|
|
369
|
+
* - over HTTP: `PUT /__admin/controls`
|
|
370
|
+
* - per request: the `x-mockingbird-*` headers in {@link CONTROL_HEADERS}
|
|
371
|
+
*
|
|
372
|
+
* Every control is deterministic: given the same seed, clock and requests, a mock answers
|
|
373
|
+
* the same bytes. Nothing here reads the wall clock or `Math.random`.
|
|
374
|
+
*/
|
|
375
|
+
/** Milliseconds, or a string like `"250ms"`, `"2s"`, `"15m"`, `"1h"`, `"3d"`. */
|
|
376
|
+
type Duration$1 = number | string;
|
|
377
|
+
/** Epoch milliseconds, or an ISO-8601 string. */
|
|
378
|
+
type Instant$1 = number | string;
|
|
379
|
+
type ClockControls$1 = {
|
|
380
|
+
/** Move the clock to this instant. */
|
|
381
|
+
now?: Instant$1;
|
|
382
|
+
/** Stop time. A frozen clock moves only when told to, so timestamps replay exactly. */
|
|
383
|
+
frozen?: boolean;
|
|
384
|
+
/**
|
|
385
|
+
* Step the clock forward by this much before every vendor request. With a frozen clock
|
|
386
|
+
* each request still gets its own, reproducible timestamp.
|
|
387
|
+
*/
|
|
388
|
+
autoAdvance?: Duration$1;
|
|
389
|
+
};
|
|
390
|
+
/** How long a response takes: a fixed delay plus seeded jitter in `[0, jitter]`. */
|
|
391
|
+
type LatencyRuleInput$1 = {
|
|
392
|
+
delay?: Duration$1;
|
|
393
|
+
jitter?: Duration$1;
|
|
394
|
+
};
|
|
395
|
+
type LatencyControls$1 = LatencyRuleInput$1 & {
|
|
396
|
+
/** Per-operation overrides, keyed by operationId. A bare duration is its `delay`. */
|
|
397
|
+
operations?: Record<string, Duration$1 | LatencyRuleInput$1>;
|
|
398
|
+
};
|
|
399
|
+
/** A fault to add: a rule (the id is assigned when omitted), or a named preset with overrides. */
|
|
400
|
+
type FaultInput$1 = (Omit<FaultRule$1, "id"> & {
|
|
401
|
+
id?: string;
|
|
402
|
+
}) | ({
|
|
403
|
+
preset: string;
|
|
404
|
+
} & Partial<FaultRule$1>);
|
|
405
|
+
/** Identifies a {@link SnapshotDocument}. */
|
|
406
|
+
declare const SNAPSHOT_FORMAT$1 = "mockingbird.snapshot/v1";
|
|
407
|
+
/**
|
|
408
|
+
* A namespace, as portable JSON: what `GET /__admin/snapshots/:id` returns and what
|
|
409
|
+
* `PUT /__admin/snapshots/:id` and the boot `snapshot` control accept. Only `format` and
|
|
410
|
+
* `records` are required, so a hand-written seed file is a valid snapshot.
|
|
411
|
+
*/
|
|
412
|
+
type SnapshotDocument$1 = {
|
|
413
|
+
format: typeof SNAPSHOT_FORMAT$1;
|
|
414
|
+
/** The service that wrote it. A snapshot is rejected by any other service. */
|
|
415
|
+
service?: string;
|
|
416
|
+
/**
|
|
417
|
+
* Stored rows. `seq` orders a collection; omitted, rows keep their listed order. `raw` is
|
|
418
|
+
* the stored text of a row that is not a plain record, and replaces `value` when present.
|
|
419
|
+
*/
|
|
420
|
+
records: {
|
|
421
|
+
collection: string;
|
|
422
|
+
id: string;
|
|
423
|
+
seq?: number;
|
|
424
|
+
value?: unknown;
|
|
425
|
+
raw?: string;
|
|
426
|
+
}[];
|
|
427
|
+
/** Id counters, so the next generated id continues where the snapshot left off. */
|
|
428
|
+
sequences?: {
|
|
429
|
+
name: string;
|
|
430
|
+
kind: string;
|
|
431
|
+
value: number;
|
|
432
|
+
}[];
|
|
433
|
+
clock?: {
|
|
434
|
+
now: number;
|
|
435
|
+
frozen: boolean;
|
|
436
|
+
autoAdvanceMs?: number;
|
|
437
|
+
};
|
|
438
|
+
seed?: number | string;
|
|
439
|
+
/** Positions of the seeded random streams. */
|
|
440
|
+
rng?: {
|
|
441
|
+
state: number;
|
|
442
|
+
faults?: number;
|
|
443
|
+
latency?: number;
|
|
444
|
+
};
|
|
445
|
+
faults?: unknown;
|
|
446
|
+
latency?: unknown;
|
|
447
|
+
virtualTime?: boolean;
|
|
448
|
+
/** Quiescent webhook endpoints, delivery history and fault state. Contains private configuration. */
|
|
449
|
+
webhooks?: unknown;
|
|
450
|
+
};
|
|
451
|
+
/** Controls for one namespace. */
|
|
452
|
+
type NamespaceControls$1 = {
|
|
453
|
+
/** Seeds every random choice: fault rates, jitter, and whatever the service invents. */
|
|
454
|
+
seed?: number | string;
|
|
455
|
+
clock?: ClockControls$1;
|
|
456
|
+
/**
|
|
457
|
+
* Spend injected waits (latency, fault delays, timeouts) on the mock clock instead of the
|
|
458
|
+
* wall clock: the request returns at once, the clock has moved, and the journal records
|
|
459
|
+
* the wait exactly. Default `false`: waits are real, so a client's own timeout can fire.
|
|
460
|
+
*/
|
|
461
|
+
virtualTime?: boolean;
|
|
462
|
+
/** Baseline response time for every vendor request. A bare duration is its `delay`. */
|
|
463
|
+
latency?: Duration$1 | LatencyControls$1;
|
|
464
|
+
faults?: readonly FaultInput$1[];
|
|
465
|
+
/** Start from this state instead of the service's own seed data. */
|
|
466
|
+
snapshot?: SnapshotDocument$1;
|
|
467
|
+
};
|
|
468
|
+
/** {@link NamespaceControls} for every namespace, with per-namespace overrides. */
|
|
469
|
+
type MockControls$1 = NamespaceControls$1 & {
|
|
470
|
+
/** Vendor credential → namespace, for SDKs that cannot send a namespace header. */
|
|
471
|
+
credentials?: Record<string, string>;
|
|
472
|
+
/** Overrides for named namespaces. A key given here replaces the shared value. */
|
|
473
|
+
namespaces?: Record<string, NamespaceControls$1>;
|
|
474
|
+
};
|
|
475
|
+
/** A latency rule in milliseconds. */
|
|
476
|
+
type LatencyRule$1 = {
|
|
477
|
+
delayMs: number;
|
|
478
|
+
jitterMs: number;
|
|
479
|
+
};
|
|
480
|
+
/** Baseline latency for a namespace, normalized. */
|
|
481
|
+
type LatencyState$1 = LatencyRule$1 & {
|
|
482
|
+
operations: Record<string, LatencyRule$1>;
|
|
483
|
+
};
|
|
484
|
+
/** What {@link controlHeaders} turns into request headers. */
|
|
485
|
+
type ControlHeaderInput$1 = {
|
|
486
|
+
namespace?: string;
|
|
487
|
+
adminKey?: string;
|
|
488
|
+
branch?: string;
|
|
489
|
+
at?: string;
|
|
490
|
+
reset?: boolean;
|
|
491
|
+
restore?: string;
|
|
492
|
+
seed?: number | string;
|
|
493
|
+
time?: Instant$1 | Date;
|
|
494
|
+
advance?: Duration$1;
|
|
495
|
+
virtualTime?: boolean;
|
|
496
|
+
delay?: Duration$1;
|
|
497
|
+
timeout?: Duration$1;
|
|
498
|
+
/** A status, `"drop"`, a preset name, or a fault rule. */
|
|
499
|
+
fault?: number | string | Record<string, unknown>;
|
|
500
|
+
snapshot?: string;
|
|
291
501
|
};
|
|
292
502
|
|
|
293
503
|
/**
|
|
@@ -327,6 +537,8 @@ type RequestLog$1 = {
|
|
|
327
537
|
unmatched: boolean;
|
|
328
538
|
/** Set when a fault rule produced the response. */
|
|
329
539
|
faultId?: string;
|
|
540
|
+
/** Milliseconds of injected wait: latency, fault delays and timeouts. Absent when none. */
|
|
541
|
+
delayMs?: number;
|
|
330
542
|
/** Resource ids the handler touched (`userId`, `orderId`, …), when the service reports them. */
|
|
331
543
|
ids?: Record<string, string>;
|
|
332
544
|
/** Set when the service created a resource the request referred to but that did not exist. */
|
|
@@ -372,6 +584,12 @@ type JournalQuery$1 = {
|
|
|
372
584
|
/** Only this namespace. Omit for every namespace, oldest first across all of them. */
|
|
373
585
|
namespace?: string;
|
|
374
586
|
operationId?: string;
|
|
587
|
+
/** Only this HTTP method, case-insensitive. */
|
|
588
|
+
method?: string;
|
|
589
|
+
/** Only this exact path. */
|
|
590
|
+
path?: string;
|
|
591
|
+
/** Only requests this fault rule answered or shaped. */
|
|
592
|
+
faultId?: string;
|
|
375
593
|
status?: number;
|
|
376
594
|
/** Only entries at or after this instant (epoch ms). */
|
|
377
595
|
since?: number;
|
|
@@ -386,6 +604,50 @@ type Journal$1 = {
|
|
|
386
604
|
clear(namespace?: string): void;
|
|
387
605
|
};
|
|
388
606
|
|
|
607
|
+
/**
|
|
608
|
+
* Baseline response time, per namespace: how long every vendor request takes before any
|
|
609
|
+
* fault is considered. Jitter draws from a stream the caller owns, one per namespace and
|
|
610
|
+
* separate from the fault stream, so adding latency never shifts which requests a `rate`
|
|
611
|
+
* fault hits.
|
|
612
|
+
*/
|
|
613
|
+
type LatencyRegistry$1 = {
|
|
614
|
+
get(namespace: string): LatencyState$1;
|
|
615
|
+
set(namespace: string, state: LatencyState$1): LatencyState$1;
|
|
616
|
+
/** Remove one namespace's latency, or every namespace's. */
|
|
617
|
+
clear(namespace?: string): void;
|
|
618
|
+
/** Milliseconds this request waits. Draws jitter, so call it once per request. */
|
|
619
|
+
take(namespace: string, operationId: string | undefined): number;
|
|
620
|
+
};
|
|
621
|
+
|
|
622
|
+
/** Clock state as the admin API reports it. */
|
|
623
|
+
type ControlClock$1 = ClockState$1 & {
|
|
624
|
+
/** `now`, as ISO-8601. */
|
|
625
|
+
iso: string;
|
|
626
|
+
/** Milliseconds the clock steps before every vendor request. */
|
|
627
|
+
autoAdvanceMs: number;
|
|
628
|
+
};
|
|
629
|
+
/** One namespace's controls: the body of `GET /__admin/controls`. */
|
|
630
|
+
type ControlState$1 = {
|
|
631
|
+
namespace: string;
|
|
632
|
+
seed: number | string;
|
|
633
|
+
clock: ControlClock$1;
|
|
634
|
+
virtualTime: boolean;
|
|
635
|
+
latency: LatencyState$1;
|
|
636
|
+
faults: FaultListing$1[];
|
|
637
|
+
};
|
|
638
|
+
|
|
639
|
+
/** What `GET /__admin/snapshots` lists for each snapshot. */
|
|
640
|
+
type SnapshotInfo$1 = {
|
|
641
|
+
id: string;
|
|
642
|
+
namespace: string;
|
|
643
|
+
/** Stored rows in the snapshot. */
|
|
644
|
+
records: number;
|
|
645
|
+
/** The namespace clock when it was taken, epoch ms. */
|
|
646
|
+
at: number;
|
|
647
|
+
/** Whether `GET /snapshots/:id` can return it as a {@link SnapshotDocument}. */
|
|
648
|
+
portable: boolean;
|
|
649
|
+
};
|
|
650
|
+
|
|
389
651
|
/** Credential → namespace mapping behind `PUT /__admin/credentials`. */
|
|
390
652
|
type CredentialRegistry$1 = {
|
|
391
653
|
set(credential: string, namespace: string): void;
|
|
@@ -398,6 +660,8 @@ type CredentialRegistry$1 = {
|
|
|
398
660
|
}[];
|
|
399
661
|
};
|
|
400
662
|
|
|
663
|
+
type OwnedTransport$1 = (request: Request, namespace: string, send: typeof fetch) => Promise<Response>;
|
|
664
|
+
|
|
401
665
|
/**
|
|
402
666
|
* A point-in-time copy of everything a service namespace holds.
|
|
403
667
|
*
|
|
@@ -515,8 +779,16 @@ type PublishInput$1 = {
|
|
|
515
779
|
id?: string;
|
|
516
780
|
};
|
|
517
781
|
type WebhookHub$1 = {
|
|
782
|
+
observeDeliveries(listener: (event: {
|
|
783
|
+
namespace: string;
|
|
784
|
+
state: string;
|
|
785
|
+
deliveryId: string;
|
|
786
|
+
}) => void): () => void;
|
|
787
|
+
setTransportPolicy(policy: OwnedTransport$1): void;
|
|
518
788
|
pending(namespace: string): number;
|
|
519
789
|
snapshot(namespace: string): unknown;
|
|
790
|
+
exportSnapshot(handle: unknown): unknown;
|
|
791
|
+
importSnapshot(namespace: string, document: unknown): unknown;
|
|
520
792
|
restore(namespace: string, snapshot: unknown): void;
|
|
521
793
|
publish(input: PublishInput$1): WebhookMessage$1;
|
|
522
794
|
/** Replace a namespace's own endpoints (`PUT /__admin/webhook-endpoints`). */
|
|
@@ -529,7 +801,7 @@ type WebhookHub$1 = {
|
|
|
529
801
|
/** Run every pending retry (and release held reordered messages) now, and every retry those attempts schedule, until nothing is pending. */
|
|
530
802
|
flush(): Promise<void>;
|
|
531
803
|
/** Resolve once nothing is in flight. */
|
|
532
|
-
idle(): Promise<void>;
|
|
804
|
+
idle(namespace?: string): Promise<void>;
|
|
533
805
|
fault(namespace: string, fault: WebhookFault$1): void;
|
|
534
806
|
clear(namespace?: string): void;
|
|
535
807
|
};
|
|
@@ -540,7 +812,10 @@ type ServiceInstance$1 = FetchAPI$2 & {
|
|
|
540
812
|
};
|
|
541
813
|
type ServiceTimelineState$1 = Readonly<{
|
|
542
814
|
snapshot: NamespaceSnapshot$1;
|
|
543
|
-
clock
|
|
815
|
+
/** `pinned`: the namespace's clock was frozen itself, not just following a frozen base. */
|
|
816
|
+
clock: Readonly<ClockState$1 & {
|
|
817
|
+
pinned?: boolean;
|
|
818
|
+
}>;
|
|
544
819
|
rngState: number;
|
|
545
820
|
}>;
|
|
546
821
|
type ServiceCheckpoint$1 = Checkpoint$1<ServiceTimelineState$1>;
|
|
@@ -553,27 +828,63 @@ type ServiceRuntime$1<T extends ServiceInstance$1> = FetchAPI$2 & {
|
|
|
553
828
|
readonly sqlite: SqliteClient$3;
|
|
554
829
|
readonly clock: Clock$1;
|
|
555
830
|
readonly faults: FaultRegistry$1;
|
|
831
|
+
/** Baseline response time per namespace. */
|
|
832
|
+
readonly latency: LatencyRegistry$1;
|
|
556
833
|
readonly metrics: Metrics$1;
|
|
557
834
|
readonly journal: Journal$1;
|
|
558
835
|
readonly rng: Rng$1;
|
|
559
836
|
readonly credentials: CredentialRegistry$1;
|
|
560
837
|
/** The webhook hub, when the service has outbound webhooks. */
|
|
561
838
|
readonly webhooks: WebhookHub$1 | undefined;
|
|
562
|
-
/**
|
|
563
|
-
|
|
839
|
+
/**
|
|
840
|
+
* A namespace's clock. Each follows the base clock, {@link ServiceRuntime.clock}, with an
|
|
841
|
+
* offset and a freeze of its own, so moving one never moves another.
|
|
842
|
+
*/
|
|
564
843
|
namespaceClock(namespace?: string): Clock$1;
|
|
565
844
|
namespaceOf(request: Request): string;
|
|
566
845
|
/** Opaque in-process checkpoint including records, controls and webhook history. */
|
|
567
846
|
fleetSnapshot(namespace: string): object;
|
|
568
847
|
fleetRestore(snapshot: unknown, namespace: string): void;
|
|
848
|
+
fleetExport(snapshot: unknown): SnapshotDocument$1;
|
|
849
|
+
fleetImport(namespace: string, document: unknown): object;
|
|
569
850
|
/** Expand a named preset into fault rules (and webhook faults) for `namespace`. */
|
|
570
851
|
applyPreset(name: string, namespace?: string, overrides?: Partial<FaultRule$1>): FaultRule$1[];
|
|
571
852
|
/** The instance behind `namespace` (the default one when omitted), created on first use. */
|
|
572
853
|
instance(namespace?: string): T;
|
|
573
854
|
/** Public names of every namespace created so far. */
|
|
574
855
|
namespaces(): string[];
|
|
575
|
-
/**
|
|
856
|
+
/** Return one namespace to its boot state, or every namespace with `"*"`. */
|
|
576
857
|
reset(namespace?: string): Promise<void>;
|
|
858
|
+
/** Reset a namespace and forget it, releasing everything it held. */
|
|
859
|
+
dropNamespace(namespace: string): Promise<void>;
|
|
860
|
+
/** A namespace's controls: seed, clock, virtual time, latency, faults and snapshots. */
|
|
861
|
+
controls(namespace?: string): ControlState$1 & {
|
|
862
|
+
snapshots: SnapshotInfo$1[];
|
|
863
|
+
};
|
|
864
|
+
/** Apply a control document to a namespace. A given key replaces that control. */
|
|
865
|
+
configure(controls: NamespaceControls$1, namespace?: string): ControlState$1 & {
|
|
866
|
+
snapshots: SnapshotInfo$1[];
|
|
867
|
+
};
|
|
868
|
+
/** Named snapshots of a namespace: records, clock, random streams, faults and latency. */
|
|
869
|
+
readonly snapshots: {
|
|
870
|
+
/** Capture the namespace now. Reusing a name replaces that snapshot. */
|
|
871
|
+
create(options?: {
|
|
872
|
+
name?: string;
|
|
873
|
+
namespace?: string;
|
|
874
|
+
}): SnapshotInfo$1;
|
|
875
|
+
list(namespace?: string): SnapshotInfo$1[];
|
|
876
|
+
/** The snapshot as portable JSON, to commit beside a suite or boot another mock from. */
|
|
877
|
+
export(id: string, namespace?: string): SnapshotDocument$1;
|
|
878
|
+
/** Store a document as a snapshot without restoring it. */
|
|
879
|
+
import(document: SnapshotDocument$1, options?: {
|
|
880
|
+
name?: string;
|
|
881
|
+
namespace?: string;
|
|
882
|
+
}): SnapshotInfo$1;
|
|
883
|
+
restore(id: string, namespace?: string): void;
|
|
884
|
+
delete(id: string, namespace?: string): boolean;
|
|
885
|
+
};
|
|
886
|
+
/** Request headers that carry controls, checked: spread them into a `fetch` or an SDK's defaults. */
|
|
887
|
+
headers(input: ControlHeaderInput$1): Record<string, string>;
|
|
577
888
|
snapshot(namespace?: string): NamespaceSnapshot$1;
|
|
578
889
|
restore(snapshot: NamespaceSnapshot$1, namespace?: string): void;
|
|
579
890
|
/** Capture the current branch. Mutating HTTP calls do this automatically. */
|
|
@@ -616,6 +927,8 @@ type CommonServeOptions = {
|
|
|
616
927
|
adminKey: string | undefined;
|
|
617
928
|
seed: string | undefined;
|
|
618
929
|
onLog: ((entry: RequestLog$1) => void) | undefined;
|
|
930
|
+
/** Admin controls to boot with: clock, latency, faults, a starting snapshot. */
|
|
931
|
+
adminControls?: MockControls$1;
|
|
619
932
|
/** Synthetic provider fixture objects supplied by a fleet entry. */
|
|
620
933
|
fixtures?: Record<string, unknown>;
|
|
621
934
|
baseUrl?: string;
|
|
@@ -626,6 +939,7 @@ type CommonServeOptions = {
|
|
|
626
939
|
* `serveTarget`, which is also how `serve --config` finds services by name.
|
|
627
940
|
*/
|
|
628
941
|
type ServeTarget = {
|
|
942
|
+
packageVersion?: string;
|
|
629
943
|
name: string;
|
|
630
944
|
defaultPort: number;
|
|
631
945
|
/** Serve flags beyond the common ones. */
|
|
@@ -836,7 +1150,7 @@ type ClockState = {
|
|
|
836
1150
|
now: number;
|
|
837
1151
|
/** True while time does not advance on its own. */
|
|
838
1152
|
frozen: boolean;
|
|
839
|
-
/** Milliseconds
|
|
1153
|
+
/** Milliseconds a running clock adds to its underlying source. `0` while frozen. */
|
|
840
1154
|
offsetMs: number;
|
|
841
1155
|
};
|
|
842
1156
|
type Clock = {
|
|
@@ -872,7 +1186,10 @@ type Rng = {
|
|
|
872
1186
|
state(): number;
|
|
873
1187
|
/** Restore a state previously returned by {@link state}. */
|
|
874
1188
|
setState(state: number): void;
|
|
875
|
-
seed
|
|
1189
|
+
/** Restart the stream from a new seed. `reset` then returns to this seed. */
|
|
1190
|
+
reseed(seed: number | string): void;
|
|
1191
|
+
/** The seed the stream currently starts from. */
|
|
1192
|
+
readonly seed: number;
|
|
876
1193
|
};
|
|
877
1194
|
|
|
878
1195
|
/**
|
|
@@ -881,44 +1198,83 @@ type Rng = {
|
|
|
881
1198
|
* This is how a suite reaches the vendor's failure modes without the vendor: the
|
|
882
1199
|
* quota error that only appears when a shared sandbox is full, the 429 that only
|
|
883
1200
|
* appears under load, the 5xx that proves a retry path works.
|
|
1201
|
+
*
|
|
1202
|
+
* A rule has three parts. What it **matches** (`operationId`, `method`, `path`, …), **when**
|
|
1203
|
+
* it fires among the matching requests (`after`, `every`, `count`, `rate`, `from`, `until`),
|
|
1204
|
+
* and what it **does** (`status`, `delay`, `timeout`, `drop`, `truncate`, `effect`).
|
|
884
1205
|
*/
|
|
885
1206
|
type FaultRule = {
|
|
886
|
-
/** Stable id, so a suite can retire exactly the rule it added. */
|
|
1207
|
+
/** Stable id, so a suite can retire exactly the rule it added. Unique within a namespace. */
|
|
887
1208
|
id: string;
|
|
888
1209
|
/** Fault only this operation. Omit to match every operation. */
|
|
889
1210
|
operationId?: string;
|
|
890
1211
|
/** Fault only this HTTP method, case-insensitive. Omit to match every method. */
|
|
891
1212
|
method?: string;
|
|
1213
|
+
/** Fault only this exact path. */
|
|
1214
|
+
path?: string;
|
|
892
1215
|
/** Fault only paths starting with this prefix. Omit to match every path. */
|
|
893
1216
|
pathPrefix?: string;
|
|
1217
|
+
/** Fault only paths matching this regular expression (JavaScript syntax, unanchored). */
|
|
1218
|
+
pathPattern?: string;
|
|
1219
|
+
/** Fault only requests carrying these headers. `"*"` matches any value. */
|
|
1220
|
+
requestHeaders?: Record<string, string>;
|
|
1221
|
+
/** Fault only requests carrying these query parameters. `"*"` matches any value. */
|
|
1222
|
+
query?: Record<string, string>;
|
|
894
1223
|
/**
|
|
895
1224
|
* Fault only this namespace. Omit (or `"*"`) to fault every namespace — which is what
|
|
896
1225
|
* an in-process caller usually wants, and what a parallel worker usually does not:
|
|
897
1226
|
* rules added through `POST /__admin/faults` default to the calling namespace.
|
|
898
1227
|
*/
|
|
899
1228
|
namespace?: string;
|
|
1229
|
+
/** Let this many matching requests through first. */
|
|
1230
|
+
after?: number;
|
|
1231
|
+
/** Then fault only every nth matching request: `3` faults the 3rd, 6th, 9th. */
|
|
1232
|
+
every?: number;
|
|
1233
|
+
/** Retire the rule after this many faults. Omit to keep it until removed. */
|
|
1234
|
+
count?: number;
|
|
1235
|
+
/** Fault this fraction of the remaining requests, `0`–`1`, drawn from the seed. Default `1`. */
|
|
1236
|
+
rate?: number;
|
|
900
1237
|
/**
|
|
901
|
-
*
|
|
902
|
-
*
|
|
903
|
-
|
|
1238
|
+
* Fault only from this instant on the namespace clock. A duration (`"5m"`) counts from the
|
|
1239
|
+
* clock when the rule was added. Listed as epoch ms.
|
|
1240
|
+
*/
|
|
1241
|
+
from?: Instant | Duration;
|
|
1242
|
+
/** Stop faulting at this instant on the namespace clock. A duration counts from when added. */
|
|
1243
|
+
until?: Instant | Duration;
|
|
1244
|
+
/**
|
|
1245
|
+
* Status of the injected response. Omit for a rule that only delays, times out, drops,
|
|
1246
|
+
* truncates, or switches on an `effect`: the request then still reaches the service.
|
|
904
1247
|
*/
|
|
905
1248
|
status?: number;
|
|
906
1249
|
/** Response body, serialized as JSON. A string is sent as-is. */
|
|
907
1250
|
body?: unknown;
|
|
1251
|
+
/** Response headers. */
|
|
908
1252
|
headers?: Record<string, string>;
|
|
909
|
-
/**
|
|
910
|
-
|
|
911
|
-
/**
|
|
912
|
-
rate?: number;
|
|
913
|
-
/** Hold the response back this long, to exercise timeouts. */
|
|
1253
|
+
/** Hold the response back this long. Listed as `delayMs`. */
|
|
1254
|
+
delay?: Duration;
|
|
1255
|
+
/** `delay`, in milliseconds. */
|
|
914
1256
|
delayMs?: number;
|
|
915
1257
|
/** Alias of `delayMs`. */
|
|
916
1258
|
latencyMs?: number;
|
|
1259
|
+
/** Extra seeded delay in `[0, jitter]`. Listed as `jitterMs`. */
|
|
1260
|
+
jitter?: Duration;
|
|
1261
|
+
jitterMs?: number;
|
|
1262
|
+
/**
|
|
1263
|
+
* Never answer: hold the request this long, then drop the connection. Listed as
|
|
1264
|
+
* `timeoutMs`. With virtual time the wait is spent on the mock clock.
|
|
1265
|
+
*/
|
|
1266
|
+
timeout?: Duration;
|
|
1267
|
+
timeoutMs?: number;
|
|
917
1268
|
/**
|
|
918
1269
|
* Drop the connection instead of answering: an in-process `fetch` rejects with a
|
|
919
1270
|
* `TypeError`, and a served mock destroys the socket. Models "unknown outcome" failures.
|
|
920
1271
|
*/
|
|
921
1272
|
drop?: boolean;
|
|
1273
|
+
/**
|
|
1274
|
+
* Cut the response body off after this many bytes: the status and headers arrive, then
|
|
1275
|
+
* the connection dies mid-body.
|
|
1276
|
+
*/
|
|
1277
|
+
truncate?: number;
|
|
922
1278
|
/**
|
|
923
1279
|
* A named service behaviour to switch on for the matching request instead of (or
|
|
924
1280
|
* before) a canned response, e.g. `created_but_500` or `numeric_tracking_id`. Services
|
|
@@ -927,8 +1283,8 @@ type FaultRule = {
|
|
|
927
1283
|
effect?: string;
|
|
928
1284
|
/** Parameters for `effect`. */
|
|
929
1285
|
params?: Record<string, unknown>;
|
|
930
|
-
/**
|
|
931
|
-
|
|
1286
|
+
/** The preset this rule was expanded from, if any. */
|
|
1287
|
+
fromPreset?: string;
|
|
932
1288
|
};
|
|
933
1289
|
/** A fault that fired for one request. */
|
|
934
1290
|
type FaultHit = {
|
|
@@ -936,6 +1292,10 @@ type FaultHit = {
|
|
|
936
1292
|
/** The injected response; absent when the rule only delays, drops, or sets an effect. */
|
|
937
1293
|
response?: Response;
|
|
938
1294
|
drop?: boolean;
|
|
1295
|
+
/** Set with `drop` when the rule held the request for its `timeout` first. */
|
|
1296
|
+
timeout?: boolean;
|
|
1297
|
+
/** Bytes of response body to let through before the connection dies. */
|
|
1298
|
+
truncate?: number;
|
|
939
1299
|
effect?: {
|
|
940
1300
|
name: string;
|
|
941
1301
|
params: Record<string, unknown>;
|
|
@@ -947,38 +1307,202 @@ type FaultCandidate = {
|
|
|
947
1307
|
method: string;
|
|
948
1308
|
path: string;
|
|
949
1309
|
namespace: string;
|
|
1310
|
+
/** Request headers and query, for rules that match on them. */
|
|
1311
|
+
headers?: Headers;
|
|
1312
|
+
query?: URLSearchParams;
|
|
1313
|
+
/** The namespace clock, for `from` / `until`. Rules with a window are skipped without it. */
|
|
1314
|
+
now?: number;
|
|
1315
|
+
/** How to spend a delay for this request. Default: the registry's own sleep. */
|
|
1316
|
+
wait?: (ms: number) => Promise<void>;
|
|
1317
|
+
};
|
|
1318
|
+
/** A stored rule and how often it was consulted. */
|
|
1319
|
+
type FaultListing = FaultRule & {
|
|
1320
|
+
/** Faults left before the rule retires. `null` when it has no `count`. */
|
|
1321
|
+
remaining: number | null;
|
|
1322
|
+
/** Times the rule faulted a request. */
|
|
1323
|
+
hits: number;
|
|
1324
|
+
/** Requests that matched the rule, faulted or not. */
|
|
1325
|
+
seen: number;
|
|
1326
|
+
};
|
|
1327
|
+
/** A namespace's own rules, with their counters, in the order they are tried. */
|
|
1328
|
+
type FaultSnapshot = {
|
|
1329
|
+
/**
|
|
1330
|
+
* `position` is how many `"*"` rules are tried before the rule, which is what its place
|
|
1331
|
+
* in the order means to a request and holds in any process.
|
|
1332
|
+
*/
|
|
1333
|
+
rules: (FaultListing & {
|
|
1334
|
+
position?: number;
|
|
1335
|
+
})[];
|
|
1336
|
+
/** How many `fault_<n>` ids the namespace has handed out. */
|
|
1337
|
+
nextId?: number;
|
|
950
1338
|
};
|
|
951
1339
|
type FaultRegistry = {
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
rules: (FaultRule & {
|
|
955
|
-
remaining: number | null;
|
|
956
|
-
hits: number;
|
|
957
|
-
position: number;
|
|
958
|
-
})[];
|
|
959
|
-
rngState: number;
|
|
960
|
-
};
|
|
1340
|
+
snapshot(namespace: string): FaultSnapshot;
|
|
1341
|
+
/** Add a rule, or replace the rule with the same id in the same namespace. */
|
|
961
1342
|
add(rule: FaultRule): FaultRule;
|
|
962
|
-
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-
|
|
966
|
-
|
|
967
|
-
|
|
968
|
-
|
|
969
|
-
|
|
970
|
-
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
})[];
|
|
974
|
-
rngState: number;
|
|
975
|
-
}): void;
|
|
1343
|
+
/** The next unused `fault_<n>` id in `namespace`. */
|
|
1344
|
+
nextId(namespace: string): string;
|
|
1345
|
+
/** Every rule, or the rules a namespace's requests can hit: its own and the global ones. */
|
|
1346
|
+
list(namespace?: string): FaultListing[];
|
|
1347
|
+
get(id: string, namespace?: string): FaultListing | undefined;
|
|
1348
|
+
/** Remove a rule by id: from `namespace` (its own, then a global one), or wherever it is. */
|
|
1349
|
+
remove(id: string, namespace?: string): boolean;
|
|
1350
|
+
/** Remove every rule, or one namespace's own rules. */
|
|
1351
|
+
clear(namespace?: string): void;
|
|
1352
|
+
/** Replace a namespace's own rules with a snapshot's, wherever the snapshot was taken. */
|
|
1353
|
+
restore(namespace: string, state: FaultSnapshot): void;
|
|
976
1354
|
/**
|
|
977
1355
|
* Every fault this request should get, in rule order, stopping at the first that answers
|
|
978
1356
|
* or drops (effect-only and delay-only rules let later rules match too). Consumes one of
|
|
979
1357
|
* each matching rule's remaining uses.
|
|
980
1358
|
*/
|
|
981
1359
|
take(candidate: FaultCandidate): Promise<FaultHit[]>;
|
|
1360
|
+
/**
|
|
1361
|
+
* Fire these rules at one request without storing them: no matching, no schedule, in order,
|
|
1362
|
+
* stopping at the first that answers or drops. Jitter draws from the namespace's stream.
|
|
1363
|
+
*/
|
|
1364
|
+
fire(rules: readonly FaultRule[], candidate: FaultCandidate): Promise<FaultHit[]>;
|
|
1365
|
+
};
|
|
1366
|
+
|
|
1367
|
+
/**
|
|
1368
|
+
* The admin controls every mock shares, as one document.
|
|
1369
|
+
*
|
|
1370
|
+
* The same shape is accepted in three places, and means the same thing in each:
|
|
1371
|
+
*
|
|
1372
|
+
* - at boot: `createRuntime({ adminControls })`, `serve --admin-controls`,
|
|
1373
|
+
* `MOCKINGBIRD_ADMIN_CONTROLS`
|
|
1374
|
+
* - over HTTP: `PUT /__admin/controls`
|
|
1375
|
+
* - per request: the `x-mockingbird-*` headers in {@link CONTROL_HEADERS}
|
|
1376
|
+
*
|
|
1377
|
+
* Every control is deterministic: given the same seed, clock and requests, a mock answers
|
|
1378
|
+
* the same bytes. Nothing here reads the wall clock or `Math.random`.
|
|
1379
|
+
*/
|
|
1380
|
+
/** Milliseconds, or a string like `"250ms"`, `"2s"`, `"15m"`, `"1h"`, `"3d"`. */
|
|
1381
|
+
type Duration = number | string;
|
|
1382
|
+
/** Epoch milliseconds, or an ISO-8601 string. */
|
|
1383
|
+
type Instant = number | string;
|
|
1384
|
+
type ClockControls = {
|
|
1385
|
+
/** Move the clock to this instant. */
|
|
1386
|
+
now?: Instant;
|
|
1387
|
+
/** Stop time. A frozen clock moves only when told to, so timestamps replay exactly. */
|
|
1388
|
+
frozen?: boolean;
|
|
1389
|
+
/**
|
|
1390
|
+
* Step the clock forward by this much before every vendor request. With a frozen clock
|
|
1391
|
+
* each request still gets its own, reproducible timestamp.
|
|
1392
|
+
*/
|
|
1393
|
+
autoAdvance?: Duration;
|
|
1394
|
+
};
|
|
1395
|
+
/** How long a response takes: a fixed delay plus seeded jitter in `[0, jitter]`. */
|
|
1396
|
+
type LatencyRuleInput = {
|
|
1397
|
+
delay?: Duration;
|
|
1398
|
+
jitter?: Duration;
|
|
1399
|
+
};
|
|
1400
|
+
type LatencyControls = LatencyRuleInput & {
|
|
1401
|
+
/** Per-operation overrides, keyed by operationId. A bare duration is its `delay`. */
|
|
1402
|
+
operations?: Record<string, Duration | LatencyRuleInput>;
|
|
1403
|
+
};
|
|
1404
|
+
/** A fault to add: a rule (the id is assigned when omitted), or a named preset with overrides. */
|
|
1405
|
+
type FaultInput = (Omit<FaultRule, "id"> & {
|
|
1406
|
+
id?: string;
|
|
1407
|
+
}) | ({
|
|
1408
|
+
preset: string;
|
|
1409
|
+
} & Partial<FaultRule>);
|
|
1410
|
+
/** Identifies a {@link SnapshotDocument}. */
|
|
1411
|
+
declare const SNAPSHOT_FORMAT = "mockingbird.snapshot/v1";
|
|
1412
|
+
/**
|
|
1413
|
+
* A namespace, as portable JSON: what `GET /__admin/snapshots/:id` returns and what
|
|
1414
|
+
* `PUT /__admin/snapshots/:id` and the boot `snapshot` control accept. Only `format` and
|
|
1415
|
+
* `records` are required, so a hand-written seed file is a valid snapshot.
|
|
1416
|
+
*/
|
|
1417
|
+
type SnapshotDocument = {
|
|
1418
|
+
format: typeof SNAPSHOT_FORMAT;
|
|
1419
|
+
/** The service that wrote it. A snapshot is rejected by any other service. */
|
|
1420
|
+
service?: string;
|
|
1421
|
+
/**
|
|
1422
|
+
* Stored rows. `seq` orders a collection; omitted, rows keep their listed order. `raw` is
|
|
1423
|
+
* the stored text of a row that is not a plain record, and replaces `value` when present.
|
|
1424
|
+
*/
|
|
1425
|
+
records: {
|
|
1426
|
+
collection: string;
|
|
1427
|
+
id: string;
|
|
1428
|
+
seq?: number;
|
|
1429
|
+
value?: unknown;
|
|
1430
|
+
raw?: string;
|
|
1431
|
+
}[];
|
|
1432
|
+
/** Id counters, so the next generated id continues where the snapshot left off. */
|
|
1433
|
+
sequences?: {
|
|
1434
|
+
name: string;
|
|
1435
|
+
kind: string;
|
|
1436
|
+
value: number;
|
|
1437
|
+
}[];
|
|
1438
|
+
clock?: {
|
|
1439
|
+
now: number;
|
|
1440
|
+
frozen: boolean;
|
|
1441
|
+
autoAdvanceMs?: number;
|
|
1442
|
+
};
|
|
1443
|
+
seed?: number | string;
|
|
1444
|
+
/** Positions of the seeded random streams. */
|
|
1445
|
+
rng?: {
|
|
1446
|
+
state: number;
|
|
1447
|
+
faults?: number;
|
|
1448
|
+
latency?: number;
|
|
1449
|
+
};
|
|
1450
|
+
faults?: unknown;
|
|
1451
|
+
latency?: unknown;
|
|
1452
|
+
virtualTime?: boolean;
|
|
1453
|
+
/** Quiescent webhook endpoints, delivery history and fault state. Contains private configuration. */
|
|
1454
|
+
webhooks?: unknown;
|
|
1455
|
+
};
|
|
1456
|
+
/** Controls for one namespace. */
|
|
1457
|
+
type NamespaceControls = {
|
|
1458
|
+
/** Seeds every random choice: fault rates, jitter, and whatever the service invents. */
|
|
1459
|
+
seed?: number | string;
|
|
1460
|
+
clock?: ClockControls;
|
|
1461
|
+
/**
|
|
1462
|
+
* Spend injected waits (latency, fault delays, timeouts) on the mock clock instead of the
|
|
1463
|
+
* wall clock: the request returns at once, the clock has moved, and the journal records
|
|
1464
|
+
* the wait exactly. Default `false`: waits are real, so a client's own timeout can fire.
|
|
1465
|
+
*/
|
|
1466
|
+
virtualTime?: boolean;
|
|
1467
|
+
/** Baseline response time for every vendor request. A bare duration is its `delay`. */
|
|
1468
|
+
latency?: Duration | LatencyControls;
|
|
1469
|
+
faults?: readonly FaultInput[];
|
|
1470
|
+
/** Start from this state instead of the service's own seed data. */
|
|
1471
|
+
snapshot?: SnapshotDocument;
|
|
1472
|
+
};
|
|
1473
|
+
/** {@link NamespaceControls} for every namespace, with per-namespace overrides. */
|
|
1474
|
+
type MockControls = NamespaceControls & {
|
|
1475
|
+
/** Vendor credential → namespace, for SDKs that cannot send a namespace header. */
|
|
1476
|
+
credentials?: Record<string, string>;
|
|
1477
|
+
/** Overrides for named namespaces. A key given here replaces the shared value. */
|
|
1478
|
+
namespaces?: Record<string, NamespaceControls>;
|
|
1479
|
+
};
|
|
1480
|
+
/** A latency rule in milliseconds. */
|
|
1481
|
+
type LatencyRule = {
|
|
1482
|
+
delayMs: number;
|
|
1483
|
+
jitterMs: number;
|
|
1484
|
+
};
|
|
1485
|
+
/** Baseline latency for a namespace, normalized. */
|
|
1486
|
+
type LatencyState = LatencyRule & {
|
|
1487
|
+
operations: Record<string, LatencyRule>;
|
|
1488
|
+
};
|
|
1489
|
+
/** What {@link controlHeaders} turns into request headers. */
|
|
1490
|
+
type ControlHeaderInput = {
|
|
1491
|
+
namespace?: string;
|
|
1492
|
+
adminKey?: string;
|
|
1493
|
+
branch?: string;
|
|
1494
|
+
at?: string;
|
|
1495
|
+
reset?: boolean;
|
|
1496
|
+
restore?: string;
|
|
1497
|
+
seed?: number | string;
|
|
1498
|
+
time?: Instant | Date;
|
|
1499
|
+
advance?: Duration;
|
|
1500
|
+
virtualTime?: boolean;
|
|
1501
|
+
delay?: Duration;
|
|
1502
|
+
timeout?: Duration;
|
|
1503
|
+
/** A status, `"drop"`, a preset name, or a fault rule. */
|
|
1504
|
+
fault?: number | string | Record<string, unknown>;
|
|
1505
|
+
snapshot?: string;
|
|
982
1506
|
};
|
|
983
1507
|
|
|
984
1508
|
/**
|
|
@@ -1018,6 +1542,8 @@ type RequestLog = {
|
|
|
1018
1542
|
unmatched: boolean;
|
|
1019
1543
|
/** Set when a fault rule produced the response. */
|
|
1020
1544
|
faultId?: string;
|
|
1545
|
+
/** Milliseconds of injected wait: latency, fault delays and timeouts. Absent when none. */
|
|
1546
|
+
delayMs?: number;
|
|
1021
1547
|
/** Resource ids the handler touched (`userId`, `orderId`, …), when the service reports them. */
|
|
1022
1548
|
ids?: Record<string, string>;
|
|
1023
1549
|
/** Set when the service created a resource the request referred to but that did not exist. */
|
|
@@ -1063,6 +1589,12 @@ type JournalQuery = {
|
|
|
1063
1589
|
/** Only this namespace. Omit for every namespace, oldest first across all of them. */
|
|
1064
1590
|
namespace?: string;
|
|
1065
1591
|
operationId?: string;
|
|
1592
|
+
/** Only this HTTP method, case-insensitive. */
|
|
1593
|
+
method?: string;
|
|
1594
|
+
/** Only this exact path. */
|
|
1595
|
+
path?: string;
|
|
1596
|
+
/** Only requests this fault rule answered or shaped. */
|
|
1597
|
+
faultId?: string;
|
|
1066
1598
|
status?: number;
|
|
1067
1599
|
/** Only entries at or after this instant (epoch ms). */
|
|
1068
1600
|
since?: number;
|
|
@@ -1077,6 +1609,50 @@ type Journal = {
|
|
|
1077
1609
|
clear(namespace?: string): void;
|
|
1078
1610
|
};
|
|
1079
1611
|
|
|
1612
|
+
/**
|
|
1613
|
+
* Baseline response time, per namespace: how long every vendor request takes before any
|
|
1614
|
+
* fault is considered. Jitter draws from a stream the caller owns, one per namespace and
|
|
1615
|
+
* separate from the fault stream, so adding latency never shifts which requests a `rate`
|
|
1616
|
+
* fault hits.
|
|
1617
|
+
*/
|
|
1618
|
+
type LatencyRegistry = {
|
|
1619
|
+
get(namespace: string): LatencyState;
|
|
1620
|
+
set(namespace: string, state: LatencyState): LatencyState;
|
|
1621
|
+
/** Remove one namespace's latency, or every namespace's. */
|
|
1622
|
+
clear(namespace?: string): void;
|
|
1623
|
+
/** Milliseconds this request waits. Draws jitter, so call it once per request. */
|
|
1624
|
+
take(namespace: string, operationId: string | undefined): number;
|
|
1625
|
+
};
|
|
1626
|
+
|
|
1627
|
+
/** Clock state as the admin API reports it. */
|
|
1628
|
+
type ControlClock = ClockState & {
|
|
1629
|
+
/** `now`, as ISO-8601. */
|
|
1630
|
+
iso: string;
|
|
1631
|
+
/** Milliseconds the clock steps before every vendor request. */
|
|
1632
|
+
autoAdvanceMs: number;
|
|
1633
|
+
};
|
|
1634
|
+
/** One namespace's controls: the body of `GET /__admin/controls`. */
|
|
1635
|
+
type ControlState = {
|
|
1636
|
+
namespace: string;
|
|
1637
|
+
seed: number | string;
|
|
1638
|
+
clock: ControlClock;
|
|
1639
|
+
virtualTime: boolean;
|
|
1640
|
+
latency: LatencyState;
|
|
1641
|
+
faults: FaultListing[];
|
|
1642
|
+
};
|
|
1643
|
+
|
|
1644
|
+
/** What `GET /__admin/snapshots` lists for each snapshot. */
|
|
1645
|
+
type SnapshotInfo = {
|
|
1646
|
+
id: string;
|
|
1647
|
+
namespace: string;
|
|
1648
|
+
/** Stored rows in the snapshot. */
|
|
1649
|
+
records: number;
|
|
1650
|
+
/** The namespace clock when it was taken, epoch ms. */
|
|
1651
|
+
at: number;
|
|
1652
|
+
/** Whether `GET /snapshots/:id` can return it as a {@link SnapshotDocument}. */
|
|
1653
|
+
portable: boolean;
|
|
1654
|
+
};
|
|
1655
|
+
|
|
1080
1656
|
/** Credential → namespace mapping behind `PUT /__admin/credentials`. */
|
|
1081
1657
|
type CredentialRegistry = {
|
|
1082
1658
|
set(credential: string, namespace: string): void;
|
|
@@ -1107,6 +1683,8 @@ declare class IdempotencyStore {
|
|
|
1107
1683
|
run(key: string, fingerprint: string, errors: IdempotencyErrors, handler: () => Promise<Response> | Response, replayable?: (status: number) => boolean): Promise<Response>;
|
|
1108
1684
|
}
|
|
1109
1685
|
|
|
1686
|
+
type OwnedTransport = (request: Request, namespace: string, send: typeof fetch) => Promise<Response>;
|
|
1687
|
+
|
|
1110
1688
|
/**
|
|
1111
1689
|
* A point-in-time copy of everything a service namespace holds.
|
|
1112
1690
|
*
|
|
@@ -1224,8 +1802,16 @@ type PublishInput = {
|
|
|
1224
1802
|
id?: string;
|
|
1225
1803
|
};
|
|
1226
1804
|
type WebhookHub = {
|
|
1805
|
+
observeDeliveries(listener: (event: {
|
|
1806
|
+
namespace: string;
|
|
1807
|
+
state: string;
|
|
1808
|
+
deliveryId: string;
|
|
1809
|
+
}) => void): () => void;
|
|
1810
|
+
setTransportPolicy(policy: OwnedTransport): void;
|
|
1227
1811
|
pending(namespace: string): number;
|
|
1228
1812
|
snapshot(namespace: string): unknown;
|
|
1813
|
+
exportSnapshot(handle: unknown): unknown;
|
|
1814
|
+
importSnapshot(namespace: string, document: unknown): unknown;
|
|
1229
1815
|
restore(namespace: string, snapshot: unknown): void;
|
|
1230
1816
|
publish(input: PublishInput): WebhookMessage;
|
|
1231
1817
|
/** Replace a namespace's own endpoints (`PUT /__admin/webhook-endpoints`). */
|
|
@@ -1238,7 +1824,7 @@ type WebhookHub = {
|
|
|
1238
1824
|
/** Run every pending retry (and release held reordered messages) now, and every retry those attempts schedule, until nothing is pending. */
|
|
1239
1825
|
flush(): Promise<void>;
|
|
1240
1826
|
/** Resolve once nothing is in flight. */
|
|
1241
|
-
idle(): Promise<void>;
|
|
1827
|
+
idle(namespace?: string): Promise<void>;
|
|
1242
1828
|
fault(namespace: string, fault: WebhookFault): void;
|
|
1243
1829
|
clear(namespace?: string): void;
|
|
1244
1830
|
};
|
|
@@ -1249,7 +1835,10 @@ type ServiceInstance = FetchAPI$1 & {
|
|
|
1249
1835
|
};
|
|
1250
1836
|
type ServiceTimelineState = Readonly<{
|
|
1251
1837
|
snapshot: NamespaceSnapshot;
|
|
1252
|
-
clock
|
|
1838
|
+
/** `pinned`: the namespace's clock was frozen itself, not just following a frozen base. */
|
|
1839
|
+
clock: Readonly<ClockState & {
|
|
1840
|
+
pinned?: boolean;
|
|
1841
|
+
}>;
|
|
1253
1842
|
rngState: number;
|
|
1254
1843
|
}>;
|
|
1255
1844
|
type ServiceCheckpoint = Checkpoint<ServiceTimelineState>;
|
|
@@ -1262,27 +1851,63 @@ type ServiceRuntime<T extends ServiceInstance> = FetchAPI$1 & {
|
|
|
1262
1851
|
readonly sqlite: SqliteClient$2;
|
|
1263
1852
|
readonly clock: Clock;
|
|
1264
1853
|
readonly faults: FaultRegistry;
|
|
1854
|
+
/** Baseline response time per namespace. */
|
|
1855
|
+
readonly latency: LatencyRegistry;
|
|
1265
1856
|
readonly metrics: Metrics;
|
|
1266
1857
|
readonly journal: Journal;
|
|
1267
1858
|
readonly rng: Rng;
|
|
1268
1859
|
readonly credentials: CredentialRegistry;
|
|
1269
1860
|
/** The webhook hub, when the service has outbound webhooks. */
|
|
1270
1861
|
readonly webhooks: WebhookHub | undefined;
|
|
1271
|
-
/**
|
|
1272
|
-
|
|
1862
|
+
/**
|
|
1863
|
+
* A namespace's clock. Each follows the base clock, {@link ServiceRuntime.clock}, with an
|
|
1864
|
+
* offset and a freeze of its own, so moving one never moves another.
|
|
1865
|
+
*/
|
|
1273
1866
|
namespaceClock(namespace?: string): Clock;
|
|
1274
1867
|
namespaceOf(request: Request): string;
|
|
1275
1868
|
/** Opaque in-process checkpoint including records, controls and webhook history. */
|
|
1276
1869
|
fleetSnapshot(namespace: string): object;
|
|
1277
1870
|
fleetRestore(snapshot: unknown, namespace: string): void;
|
|
1871
|
+
fleetExport(snapshot: unknown): SnapshotDocument;
|
|
1872
|
+
fleetImport(namespace: string, document: unknown): object;
|
|
1278
1873
|
/** Expand a named preset into fault rules (and webhook faults) for `namespace`. */
|
|
1279
1874
|
applyPreset(name: string, namespace?: string, overrides?: Partial<FaultRule>): FaultRule[];
|
|
1280
1875
|
/** The instance behind `namespace` (the default one when omitted), created on first use. */
|
|
1281
1876
|
instance(namespace?: string): T;
|
|
1282
1877
|
/** Public names of every namespace created so far. */
|
|
1283
1878
|
namespaces(): string[];
|
|
1284
|
-
/**
|
|
1879
|
+
/** Return one namespace to its boot state, or every namespace with `"*"`. */
|
|
1285
1880
|
reset(namespace?: string): Promise<void>;
|
|
1881
|
+
/** Reset a namespace and forget it, releasing everything it held. */
|
|
1882
|
+
dropNamespace(namespace: string): Promise<void>;
|
|
1883
|
+
/** A namespace's controls: seed, clock, virtual time, latency, faults and snapshots. */
|
|
1884
|
+
controls(namespace?: string): ControlState & {
|
|
1885
|
+
snapshots: SnapshotInfo[];
|
|
1886
|
+
};
|
|
1887
|
+
/** Apply a control document to a namespace. A given key replaces that control. */
|
|
1888
|
+
configure(controls: NamespaceControls, namespace?: string): ControlState & {
|
|
1889
|
+
snapshots: SnapshotInfo[];
|
|
1890
|
+
};
|
|
1891
|
+
/** Named snapshots of a namespace: records, clock, random streams, faults and latency. */
|
|
1892
|
+
readonly snapshots: {
|
|
1893
|
+
/** Capture the namespace now. Reusing a name replaces that snapshot. */
|
|
1894
|
+
create(options?: {
|
|
1895
|
+
name?: string;
|
|
1896
|
+
namespace?: string;
|
|
1897
|
+
}): SnapshotInfo;
|
|
1898
|
+
list(namespace?: string): SnapshotInfo[];
|
|
1899
|
+
/** The snapshot as portable JSON, to commit beside a suite or boot another mock from. */
|
|
1900
|
+
export(id: string, namespace?: string): SnapshotDocument;
|
|
1901
|
+
/** Store a document as a snapshot without restoring it. */
|
|
1902
|
+
import(document: SnapshotDocument, options?: {
|
|
1903
|
+
name?: string;
|
|
1904
|
+
namespace?: string;
|
|
1905
|
+
}): SnapshotInfo;
|
|
1906
|
+
restore(id: string, namespace?: string): void;
|
|
1907
|
+
delete(id: string, namespace?: string): boolean;
|
|
1908
|
+
};
|
|
1909
|
+
/** Request headers that carry controls, checked: spread them into a `fetch` or an SDK's defaults. */
|
|
1910
|
+
headers(input: ControlHeaderInput): Record<string, string>;
|
|
1286
1911
|
snapshot(namespace?: string): NamespaceSnapshot;
|
|
1287
1912
|
restore(snapshot: NamespaceSnapshot, namespace?: string): void;
|
|
1288
1913
|
/** Capture the current branch. Mutating HTTP calls do this automatically. */
|
|
@@ -1456,6 +2081,11 @@ type ProviderOptions = APIOptions & {
|
|
|
1456
2081
|
fallbackUser?: AuthFallback;
|
|
1457
2082
|
publicNamespace?: string;
|
|
1458
2083
|
adminPrefix?: string;
|
|
2084
|
+
/**
|
|
2085
|
+
* A seeded stream of `[0, 1)` that ids and tokens are minted from, so a run replays from
|
|
2086
|
+
* its seed. Default: the platform's randomness.
|
|
2087
|
+
*/
|
|
2088
|
+
random?: () => number;
|
|
1459
2089
|
};
|
|
1460
2090
|
|
|
1461
2091
|
/**
|
|
@@ -1593,7 +2223,7 @@ type SendOutcomeEvent = {
|
|
|
1593
2223
|
namespace: string;
|
|
1594
2224
|
emailId?: string;
|
|
1595
2225
|
};
|
|
1596
|
-
type ResendAPIOptions = APIOptions$1 & Pick<ProviderOptions, "tokens" | "baseUrl" | "publicNamespace" | "adminPrefix"> & {
|
|
2226
|
+
type ResendAPIOptions = APIOptions$1 & Pick<ProviderOptions, "tokens" | "baseUrl" | "publicNamespace" | "adminPrefix" | "random"> & {
|
|
1597
2227
|
fixtures?: ResendSeedConfig;
|
|
1598
2228
|
/** The public namespace name, for `/__admin/ns/<name>` download URLs. Default: the default namespace. */
|
|
1599
2229
|
adminPrefix?: string;
|
|
@@ -1660,6 +2290,8 @@ type ForwardTarget = {
|
|
|
1660
2290
|
adminPrefix?: string;
|
|
1661
2291
|
/** Its `x-mockingbird-admin-key`, when it has one. */
|
|
1662
2292
|
adminKey?: string;
|
|
2293
|
+
/** Admin controls to boot with: clock, latency, faults, seed, a starting snapshot. */
|
|
2294
|
+
adminControls?: MockControls;
|
|
1663
2295
|
/** Give up on a forward after this long (the send still succeeds). Default 2000 ms. */
|
|
1664
2296
|
timeoutMs?: number;
|
|
1665
2297
|
fetch?: (request: Request) => Promise<Response>;
|
|
@@ -1675,6 +2307,8 @@ type ResendRuntimeOptions = Pick<ResendAPIOptions, "fixtures" | "baseUrl" | "tok
|
|
|
1675
2307
|
seed?: number | string;
|
|
1676
2308
|
adminPrefix?: string;
|
|
1677
2309
|
adminKey?: string;
|
|
2310
|
+
/** Admin controls to boot with: clock, latency, faults, seed, a starting snapshot. */
|
|
2311
|
+
adminControls?: MockControls;
|
|
1678
2312
|
onLog?: (entry: RequestLog) => void;
|
|
1679
2313
|
/**
|
|
1680
2314
|
* Where `email.received` webhooks go (`POST /messaging/inbound/email`), signed with the
|