@crvouga/mockingbird-service-docker 1.2.0 → 1.3.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 +8 -2
- package/DISCOVERY.md +23 -0
- package/README.md +29 -11
- package/dist/chunk-NSZYARVW.js +5989 -0
- package/dist/chunk-NSZYARVW.js.map +7 -0
- package/dist/{chunk-TR75ZFCZ.js → chunk-Y4JH3Q6Z.js} +3 -2
- package/dist/{chunk-TR75ZFCZ.js.map → chunk-Y4JH3Q6Z.js.map} +2 -2
- package/dist/cli.js +135 -25
- package/dist/cli.js.map +3 -3
- package/dist/index.d.ts +356 -44
- package/dist/index.js +1 -1
- package/dist/server.d.ts +695 -84
- package/dist/server.js +2 -2
- package/package.json +3 -2
- package/dist/chunk-5I542RFL.js +0 -4198
- package/dist/chunk-5I542RFL.js.map +0 -7
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,200 @@ 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
|
+
};
|
|
449
|
+
/** Controls for one namespace. */
|
|
450
|
+
type NamespaceControls$1 = {
|
|
451
|
+
/** Seeds every random choice: fault rates, jitter, and whatever the service invents. */
|
|
452
|
+
seed?: number | string;
|
|
453
|
+
clock?: ClockControls$1;
|
|
454
|
+
/**
|
|
455
|
+
* Spend injected waits (latency, fault delays, timeouts) on the mock clock instead of the
|
|
456
|
+
* wall clock: the request returns at once, the clock has moved, and the journal records
|
|
457
|
+
* the wait exactly. Default `false`: waits are real, so a client's own timeout can fire.
|
|
458
|
+
*/
|
|
459
|
+
virtualTime?: boolean;
|
|
460
|
+
/** Baseline response time for every vendor request. A bare duration is its `delay`. */
|
|
461
|
+
latency?: Duration$1 | LatencyControls$1;
|
|
462
|
+
faults?: readonly FaultInput$1[];
|
|
463
|
+
/** Start from this state instead of the service's own seed data. */
|
|
464
|
+
snapshot?: SnapshotDocument$1;
|
|
465
|
+
};
|
|
466
|
+
/** {@link NamespaceControls} for every namespace, with per-namespace overrides. */
|
|
467
|
+
type MockControls$1 = NamespaceControls$1 & {
|
|
468
|
+
/** Vendor credential → namespace, for SDKs that cannot send a namespace header. */
|
|
469
|
+
credentials?: Record<string, string>;
|
|
470
|
+
/** Overrides for named namespaces. A key given here replaces the shared value. */
|
|
471
|
+
namespaces?: Record<string, NamespaceControls$1>;
|
|
472
|
+
};
|
|
473
|
+
/** A latency rule in milliseconds. */
|
|
474
|
+
type LatencyRule$1 = {
|
|
475
|
+
delayMs: number;
|
|
476
|
+
jitterMs: number;
|
|
477
|
+
};
|
|
478
|
+
/** Baseline latency for a namespace, normalized. */
|
|
479
|
+
type LatencyState$1 = LatencyRule$1 & {
|
|
480
|
+
operations: Record<string, LatencyRule$1>;
|
|
481
|
+
};
|
|
482
|
+
/** What {@link controlHeaders} turns into request headers. */
|
|
483
|
+
type ControlHeaderInput$1 = {
|
|
484
|
+
namespace?: string;
|
|
485
|
+
adminKey?: string;
|
|
486
|
+
branch?: string;
|
|
487
|
+
at?: string;
|
|
488
|
+
reset?: boolean;
|
|
489
|
+
restore?: string;
|
|
490
|
+
seed?: number | string;
|
|
491
|
+
time?: Instant$1 | Date;
|
|
492
|
+
advance?: Duration$1;
|
|
493
|
+
virtualTime?: boolean;
|
|
494
|
+
delay?: Duration$1;
|
|
495
|
+
timeout?: Duration$1;
|
|
496
|
+
/** A status, `"drop"`, a preset name, or a fault rule. */
|
|
497
|
+
fault?: number | string | Record<string, unknown>;
|
|
498
|
+
snapshot?: string;
|
|
291
499
|
};
|
|
292
500
|
|
|
293
501
|
/**
|
|
@@ -327,6 +535,8 @@ type RequestLog$1 = {
|
|
|
327
535
|
unmatched: boolean;
|
|
328
536
|
/** Set when a fault rule produced the response. */
|
|
329
537
|
faultId?: string;
|
|
538
|
+
/** Milliseconds of injected wait: latency, fault delays and timeouts. Absent when none. */
|
|
539
|
+
delayMs?: number;
|
|
330
540
|
/** Resource ids the handler touched (`userId`, `orderId`, …), when the service reports them. */
|
|
331
541
|
ids?: Record<string, string>;
|
|
332
542
|
/** Set when the service created a resource the request referred to but that did not exist. */
|
|
@@ -372,6 +582,12 @@ type JournalQuery$1 = {
|
|
|
372
582
|
/** Only this namespace. Omit for every namespace, oldest first across all of them. */
|
|
373
583
|
namespace?: string;
|
|
374
584
|
operationId?: string;
|
|
585
|
+
/** Only this HTTP method, case-insensitive. */
|
|
586
|
+
method?: string;
|
|
587
|
+
/** Only this exact path. */
|
|
588
|
+
path?: string;
|
|
589
|
+
/** Only requests this fault rule answered or shaped. */
|
|
590
|
+
faultId?: string;
|
|
375
591
|
status?: number;
|
|
376
592
|
/** Only entries at or after this instant (epoch ms). */
|
|
377
593
|
since?: number;
|
|
@@ -386,6 +602,50 @@ type Journal$1 = {
|
|
|
386
602
|
clear(namespace?: string): void;
|
|
387
603
|
};
|
|
388
604
|
|
|
605
|
+
/**
|
|
606
|
+
* Baseline response time, per namespace: how long every vendor request takes before any
|
|
607
|
+
* fault is considered. Jitter draws from a stream the caller owns, one per namespace and
|
|
608
|
+
* separate from the fault stream, so adding latency never shifts which requests a `rate`
|
|
609
|
+
* fault hits.
|
|
610
|
+
*/
|
|
611
|
+
type LatencyRegistry$1 = {
|
|
612
|
+
get(namespace: string): LatencyState$1;
|
|
613
|
+
set(namespace: string, state: LatencyState$1): LatencyState$1;
|
|
614
|
+
/** Remove one namespace's latency, or every namespace's. */
|
|
615
|
+
clear(namespace?: string): void;
|
|
616
|
+
/** Milliseconds this request waits. Draws jitter, so call it once per request. */
|
|
617
|
+
take(namespace: string, operationId: string | undefined): number;
|
|
618
|
+
};
|
|
619
|
+
|
|
620
|
+
/** Clock state as the admin API reports it. */
|
|
621
|
+
type ControlClock$1 = ClockState$1 & {
|
|
622
|
+
/** `now`, as ISO-8601. */
|
|
623
|
+
iso: string;
|
|
624
|
+
/** Milliseconds the clock steps before every vendor request. */
|
|
625
|
+
autoAdvanceMs: number;
|
|
626
|
+
};
|
|
627
|
+
/** One namespace's controls: the body of `GET /__admin/controls`. */
|
|
628
|
+
type ControlState$1 = {
|
|
629
|
+
namespace: string;
|
|
630
|
+
seed: number | string;
|
|
631
|
+
clock: ControlClock$1;
|
|
632
|
+
virtualTime: boolean;
|
|
633
|
+
latency: LatencyState$1;
|
|
634
|
+
faults: FaultListing$1[];
|
|
635
|
+
};
|
|
636
|
+
|
|
637
|
+
/** What `GET /__admin/snapshots` lists for each snapshot. */
|
|
638
|
+
type SnapshotInfo$1 = {
|
|
639
|
+
id: string;
|
|
640
|
+
namespace: string;
|
|
641
|
+
/** Stored rows in the snapshot. */
|
|
642
|
+
records: number;
|
|
643
|
+
/** The namespace clock when it was taken, epoch ms. */
|
|
644
|
+
at: number;
|
|
645
|
+
/** Whether `GET /snapshots/:id` can return it as a {@link SnapshotDocument}. */
|
|
646
|
+
portable: boolean;
|
|
647
|
+
};
|
|
648
|
+
|
|
389
649
|
/** Credential → namespace mapping behind `PUT /__admin/credentials`. */
|
|
390
650
|
type CredentialRegistry$1 = {
|
|
391
651
|
set(credential: string, namespace: string): void;
|
|
@@ -540,7 +800,10 @@ type ServiceInstance$1 = FetchAPI$2 & {
|
|
|
540
800
|
};
|
|
541
801
|
type ServiceTimelineState$1 = Readonly<{
|
|
542
802
|
snapshot: NamespaceSnapshot$1;
|
|
543
|
-
clock
|
|
803
|
+
/** `pinned`: the namespace's clock was frozen itself, not just following a frozen base. */
|
|
804
|
+
clock: Readonly<ClockState$1 & {
|
|
805
|
+
pinned?: boolean;
|
|
806
|
+
}>;
|
|
544
807
|
rngState: number;
|
|
545
808
|
}>;
|
|
546
809
|
type ServiceCheckpoint$1 = Checkpoint$1<ServiceTimelineState$1>;
|
|
@@ -553,14 +816,18 @@ type ServiceRuntime$1<T extends ServiceInstance$1> = FetchAPI$2 & {
|
|
|
553
816
|
readonly sqlite: SqliteClient$2;
|
|
554
817
|
readonly clock: Clock$1;
|
|
555
818
|
readonly faults: FaultRegistry$1;
|
|
819
|
+
/** Baseline response time per namespace. */
|
|
820
|
+
readonly latency: LatencyRegistry$1;
|
|
556
821
|
readonly metrics: Metrics$1;
|
|
557
822
|
readonly journal: Journal$1;
|
|
558
823
|
readonly rng: Rng$1;
|
|
559
824
|
readonly credentials: CredentialRegistry$1;
|
|
560
825
|
/** The webhook hub, when the service has outbound webhooks. */
|
|
561
826
|
readonly webhooks: WebhookHub$1 | undefined;
|
|
562
|
-
/**
|
|
563
|
-
|
|
827
|
+
/**
|
|
828
|
+
* A namespace's clock. Each follows the base clock, {@link ServiceRuntime.clock}, with an
|
|
829
|
+
* offset and a freeze of its own, so moving one never moves another.
|
|
830
|
+
*/
|
|
564
831
|
namespaceClock(namespace?: string): Clock$1;
|
|
565
832
|
namespaceOf(request: Request): string;
|
|
566
833
|
/** Opaque in-process checkpoint including records, controls and webhook history. */
|
|
@@ -572,8 +839,38 @@ type ServiceRuntime$1<T extends ServiceInstance$1> = FetchAPI$2 & {
|
|
|
572
839
|
instance(namespace?: string): T;
|
|
573
840
|
/** Public names of every namespace created so far. */
|
|
574
841
|
namespaces(): string[];
|
|
575
|
-
/**
|
|
842
|
+
/** Return one namespace to its boot state, or every namespace with `"*"`. */
|
|
576
843
|
reset(namespace?: string): Promise<void>;
|
|
844
|
+
/** Reset a namespace and forget it, releasing everything it held. */
|
|
845
|
+
dropNamespace(namespace: string): Promise<void>;
|
|
846
|
+
/** A namespace's controls: seed, clock, virtual time, latency, faults and snapshots. */
|
|
847
|
+
controls(namespace?: string): ControlState$1 & {
|
|
848
|
+
snapshots: SnapshotInfo$1[];
|
|
849
|
+
};
|
|
850
|
+
/** Apply a control document to a namespace. A given key replaces that control. */
|
|
851
|
+
configure(controls: NamespaceControls$1, namespace?: string): ControlState$1 & {
|
|
852
|
+
snapshots: SnapshotInfo$1[];
|
|
853
|
+
};
|
|
854
|
+
/** Named snapshots of a namespace: records, clock, random streams, faults and latency. */
|
|
855
|
+
readonly snapshots: {
|
|
856
|
+
/** Capture the namespace now. Reusing a name replaces that snapshot. */
|
|
857
|
+
create(options?: {
|
|
858
|
+
name?: string;
|
|
859
|
+
namespace?: string;
|
|
860
|
+
}): SnapshotInfo$1;
|
|
861
|
+
list(namespace?: string): SnapshotInfo$1[];
|
|
862
|
+
/** The snapshot as portable JSON, to commit beside a suite or boot another mock from. */
|
|
863
|
+
export(id: string, namespace?: string): SnapshotDocument$1;
|
|
864
|
+
/** Store a document as a snapshot without restoring it. */
|
|
865
|
+
import(document: SnapshotDocument$1, options?: {
|
|
866
|
+
name?: string;
|
|
867
|
+
namespace?: string;
|
|
868
|
+
}): SnapshotInfo$1;
|
|
869
|
+
restore(id: string, namespace?: string): void;
|
|
870
|
+
delete(id: string, namespace?: string): boolean;
|
|
871
|
+
};
|
|
872
|
+
/** Request headers that carry controls, checked: spread them into a `fetch` or an SDK's defaults. */
|
|
873
|
+
headers(input: ControlHeaderInput$1): Record<string, string>;
|
|
577
874
|
snapshot(namespace?: string): NamespaceSnapshot$1;
|
|
578
875
|
restore(snapshot: NamespaceSnapshot$1, namespace?: string): void;
|
|
579
876
|
/** Capture the current branch. Mutating HTTP calls do this automatically. */
|
|
@@ -616,6 +913,8 @@ type CommonServeOptions = {
|
|
|
616
913
|
adminKey: string | undefined;
|
|
617
914
|
seed: string | undefined;
|
|
618
915
|
onLog: ((entry: RequestLog$1) => void) | undefined;
|
|
916
|
+
/** Admin controls to boot with: clock, latency, faults, a starting snapshot. */
|
|
917
|
+
adminControls?: MockControls$1;
|
|
619
918
|
/** Synthetic provider fixture objects supplied by a fleet entry. */
|
|
620
919
|
fixtures?: Record<string, unknown>;
|
|
621
920
|
baseUrl?: string;
|
|
@@ -1011,7 +1310,7 @@ type ClockState = {
|
|
|
1011
1310
|
now: number;
|
|
1012
1311
|
/** True while time does not advance on its own. */
|
|
1013
1312
|
frozen: boolean;
|
|
1014
|
-
/** Milliseconds
|
|
1313
|
+
/** Milliseconds a running clock adds to its underlying source. `0` while frozen. */
|
|
1015
1314
|
offsetMs: number;
|
|
1016
1315
|
};
|
|
1017
1316
|
type Clock = {
|
|
@@ -1047,7 +1346,10 @@ type Rng = {
|
|
|
1047
1346
|
state(): number;
|
|
1048
1347
|
/** Restore a state previously returned by {@link state}. */
|
|
1049
1348
|
setState(state: number): void;
|
|
1050
|
-
seed
|
|
1349
|
+
/** Restart the stream from a new seed. `reset` then returns to this seed. */
|
|
1350
|
+
reseed(seed: number | string): void;
|
|
1351
|
+
/** The seed the stream currently starts from. */
|
|
1352
|
+
readonly seed: number;
|
|
1051
1353
|
};
|
|
1052
1354
|
|
|
1053
1355
|
/**
|
|
@@ -1056,44 +1358,83 @@ type Rng = {
|
|
|
1056
1358
|
* This is how a suite reaches the vendor's failure modes without the vendor: the
|
|
1057
1359
|
* quota error that only appears when a shared sandbox is full, the 429 that only
|
|
1058
1360
|
* appears under load, the 5xx that proves a retry path works.
|
|
1361
|
+
*
|
|
1362
|
+
* A rule has three parts. What it **matches** (`operationId`, `method`, `path`, …), **when**
|
|
1363
|
+
* it fires among the matching requests (`after`, `every`, `count`, `rate`, `from`, `until`),
|
|
1364
|
+
* and what it **does** (`status`, `delay`, `timeout`, `drop`, `truncate`, `effect`).
|
|
1059
1365
|
*/
|
|
1060
1366
|
type FaultRule = {
|
|
1061
|
-
/** Stable id, so a suite can retire exactly the rule it added. */
|
|
1367
|
+
/** Stable id, so a suite can retire exactly the rule it added. Unique within a namespace. */
|
|
1062
1368
|
id: string;
|
|
1063
1369
|
/** Fault only this operation. Omit to match every operation. */
|
|
1064
1370
|
operationId?: string;
|
|
1065
1371
|
/** Fault only this HTTP method, case-insensitive. Omit to match every method. */
|
|
1066
1372
|
method?: string;
|
|
1373
|
+
/** Fault only this exact path. */
|
|
1374
|
+
path?: string;
|
|
1067
1375
|
/** Fault only paths starting with this prefix. Omit to match every path. */
|
|
1068
1376
|
pathPrefix?: string;
|
|
1377
|
+
/** Fault only paths matching this regular expression (JavaScript syntax, unanchored). */
|
|
1378
|
+
pathPattern?: string;
|
|
1379
|
+
/** Fault only requests carrying these headers. `"*"` matches any value. */
|
|
1380
|
+
requestHeaders?: Record<string, string>;
|
|
1381
|
+
/** Fault only requests carrying these query parameters. `"*"` matches any value. */
|
|
1382
|
+
query?: Record<string, string>;
|
|
1069
1383
|
/**
|
|
1070
1384
|
* Fault only this namespace. Omit (or `"*"`) to fault every namespace — which is what
|
|
1071
1385
|
* an in-process caller usually wants, and what a parallel worker usually does not:
|
|
1072
1386
|
* rules added through `POST /__admin/faults` default to the calling namespace.
|
|
1073
1387
|
*/
|
|
1074
1388
|
namespace?: string;
|
|
1389
|
+
/** Let this many matching requests through first. */
|
|
1390
|
+
after?: number;
|
|
1391
|
+
/** Then fault only every nth matching request: `3` faults the 3rd, 6th, 9th. */
|
|
1392
|
+
every?: number;
|
|
1393
|
+
/** Retire the rule after this many faults. Omit to keep it until removed. */
|
|
1394
|
+
count?: number;
|
|
1395
|
+
/** Fault this fraction of the remaining requests, `0`–`1`, drawn from the seed. Default `1`. */
|
|
1396
|
+
rate?: number;
|
|
1397
|
+
/**
|
|
1398
|
+
* Fault only from this instant on the namespace clock. A duration (`"5m"`) counts from the
|
|
1399
|
+
* clock when the rule was added. Listed as epoch ms.
|
|
1400
|
+
*/
|
|
1401
|
+
from?: Instant | Duration;
|
|
1402
|
+
/** Stop faulting at this instant on the namespace clock. A duration counts from when added. */
|
|
1403
|
+
until?: Instant | Duration;
|
|
1075
1404
|
/**
|
|
1076
|
-
* Status of the injected response. Omit for a rule that only delays
|
|
1077
|
-
*
|
|
1078
|
-
* the request then still reaches the service.
|
|
1405
|
+
* Status of the injected response. Omit for a rule that only delays, times out, drops,
|
|
1406
|
+
* truncates, or switches on an `effect`: the request then still reaches the service.
|
|
1079
1407
|
*/
|
|
1080
1408
|
status?: number;
|
|
1081
1409
|
/** Response body, serialized as JSON. A string is sent as-is. */
|
|
1082
1410
|
body?: unknown;
|
|
1411
|
+
/** Response headers. */
|
|
1083
1412
|
headers?: Record<string, string>;
|
|
1084
|
-
/**
|
|
1085
|
-
|
|
1086
|
-
/**
|
|
1087
|
-
rate?: number;
|
|
1088
|
-
/** Hold the response back this long, to exercise timeouts. */
|
|
1413
|
+
/** Hold the response back this long. Listed as `delayMs`. */
|
|
1414
|
+
delay?: Duration;
|
|
1415
|
+
/** `delay`, in milliseconds. */
|
|
1089
1416
|
delayMs?: number;
|
|
1090
1417
|
/** Alias of `delayMs`. */
|
|
1091
1418
|
latencyMs?: number;
|
|
1419
|
+
/** Extra seeded delay in `[0, jitter]`. Listed as `jitterMs`. */
|
|
1420
|
+
jitter?: Duration;
|
|
1421
|
+
jitterMs?: number;
|
|
1422
|
+
/**
|
|
1423
|
+
* Never answer: hold the request this long, then drop the connection. Listed as
|
|
1424
|
+
* `timeoutMs`. With virtual time the wait is spent on the mock clock.
|
|
1425
|
+
*/
|
|
1426
|
+
timeout?: Duration;
|
|
1427
|
+
timeoutMs?: number;
|
|
1092
1428
|
/**
|
|
1093
1429
|
* Drop the connection instead of answering: an in-process `fetch` rejects with a
|
|
1094
1430
|
* `TypeError`, and a served mock destroys the socket. Models "unknown outcome" failures.
|
|
1095
1431
|
*/
|
|
1096
1432
|
drop?: boolean;
|
|
1433
|
+
/**
|
|
1434
|
+
* Cut the response body off after this many bytes: the status and headers arrive, then
|
|
1435
|
+
* the connection dies mid-body.
|
|
1436
|
+
*/
|
|
1437
|
+
truncate?: number;
|
|
1097
1438
|
/**
|
|
1098
1439
|
* A named service behaviour to switch on for the matching request instead of (or
|
|
1099
1440
|
* before) a canned response, e.g. `created_but_500` or `numeric_tracking_id`. Services
|
|
@@ -1102,8 +1443,8 @@ type FaultRule = {
|
|
|
1102
1443
|
effect?: string;
|
|
1103
1444
|
/** Parameters for `effect`. */
|
|
1104
1445
|
params?: Record<string, unknown>;
|
|
1105
|
-
/**
|
|
1106
|
-
|
|
1446
|
+
/** The preset this rule was expanded from, if any. */
|
|
1447
|
+
fromPreset?: string;
|
|
1107
1448
|
};
|
|
1108
1449
|
/** A fault that fired for one request. */
|
|
1109
1450
|
type FaultHit = {
|
|
@@ -1111,6 +1452,10 @@ type FaultHit = {
|
|
|
1111
1452
|
/** The injected response; absent when the rule only delays, drops, or sets an effect. */
|
|
1112
1453
|
response?: Response;
|
|
1113
1454
|
drop?: boolean;
|
|
1455
|
+
/** Set with `drop` when the rule held the request for its `timeout` first. */
|
|
1456
|
+
timeout?: boolean;
|
|
1457
|
+
/** Bytes of response body to let through before the connection dies. */
|
|
1458
|
+
truncate?: number;
|
|
1114
1459
|
effect?: {
|
|
1115
1460
|
name: string;
|
|
1116
1461
|
params: Record<string, unknown>;
|
|
@@ -1135,38 +1480,200 @@ type FaultCandidate = {
|
|
|
1135
1480
|
method: string;
|
|
1136
1481
|
path: string;
|
|
1137
1482
|
namespace: string;
|
|
1483
|
+
/** Request headers and query, for rules that match on them. */
|
|
1484
|
+
headers?: Headers;
|
|
1485
|
+
query?: URLSearchParams;
|
|
1486
|
+
/** The namespace clock, for `from` / `until`. Rules with a window are skipped without it. */
|
|
1487
|
+
now?: number;
|
|
1488
|
+
/** How to spend a delay for this request. Default: the registry's own sleep. */
|
|
1489
|
+
wait?: (ms: number) => Promise<void>;
|
|
1490
|
+
};
|
|
1491
|
+
/** A stored rule and how often it was consulted. */
|
|
1492
|
+
type FaultListing = FaultRule & {
|
|
1493
|
+
/** Faults left before the rule retires. `null` when it has no `count`. */
|
|
1494
|
+
remaining: number | null;
|
|
1495
|
+
/** Times the rule faulted a request. */
|
|
1496
|
+
hits: number;
|
|
1497
|
+
/** Requests that matched the rule, faulted or not. */
|
|
1498
|
+
seen: number;
|
|
1499
|
+
};
|
|
1500
|
+
/** A namespace's own rules, with their counters, in the order they are tried. */
|
|
1501
|
+
type FaultSnapshot = {
|
|
1502
|
+
/**
|
|
1503
|
+
* `position` is how many `"*"` rules are tried before the rule, which is what its place
|
|
1504
|
+
* in the order means to a request and holds in any process.
|
|
1505
|
+
*/
|
|
1506
|
+
rules: (FaultListing & {
|
|
1507
|
+
position?: number;
|
|
1508
|
+
})[];
|
|
1509
|
+
/** How many `fault_<n>` ids the namespace has handed out. */
|
|
1510
|
+
nextId?: number;
|
|
1138
1511
|
};
|
|
1139
1512
|
type FaultRegistry = {
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
rules: (FaultRule & {
|
|
1143
|
-
remaining: number | null;
|
|
1144
|
-
hits: number;
|
|
1145
|
-
position: number;
|
|
1146
|
-
})[];
|
|
1147
|
-
rngState: number;
|
|
1148
|
-
};
|
|
1513
|
+
snapshot(namespace: string): FaultSnapshot;
|
|
1514
|
+
/** Add a rule, or replace the rule with the same id in the same namespace. */
|
|
1149
1515
|
add(rule: FaultRule): FaultRule;
|
|
1150
|
-
|
|
1151
|
-
|
|
1152
|
-
|
|
1153
|
-
|
|
1154
|
-
|
|
1155
|
-
|
|
1156
|
-
|
|
1157
|
-
|
|
1158
|
-
|
|
1159
|
-
|
|
1160
|
-
|
|
1161
|
-
})[];
|
|
1162
|
-
rngState: number;
|
|
1163
|
-
}): void;
|
|
1516
|
+
/** The next unused `fault_<n>` id in `namespace`. */
|
|
1517
|
+
nextId(namespace: string): string;
|
|
1518
|
+
/** Every rule, or the rules a namespace's requests can hit: its own and the global ones. */
|
|
1519
|
+
list(namespace?: string): FaultListing[];
|
|
1520
|
+
get(id: string, namespace?: string): FaultListing | undefined;
|
|
1521
|
+
/** Remove a rule by id: from `namespace` (its own, then a global one), or wherever it is. */
|
|
1522
|
+
remove(id: string, namespace?: string): boolean;
|
|
1523
|
+
/** Remove every rule, or one namespace's own rules. */
|
|
1524
|
+
clear(namespace?: string): void;
|
|
1525
|
+
/** Replace a namespace's own rules with a snapshot's, wherever the snapshot was taken. */
|
|
1526
|
+
restore(namespace: string, state: FaultSnapshot): void;
|
|
1164
1527
|
/**
|
|
1165
1528
|
* Every fault this request should get, in rule order, stopping at the first that answers
|
|
1166
1529
|
* or drops (effect-only and delay-only rules let later rules match too). Consumes one of
|
|
1167
1530
|
* each matching rule's remaining uses.
|
|
1168
1531
|
*/
|
|
1169
1532
|
take(candidate: FaultCandidate): Promise<FaultHit[]>;
|
|
1533
|
+
/**
|
|
1534
|
+
* Fire these rules at one request without storing them: no matching, no schedule, in order,
|
|
1535
|
+
* stopping at the first that answers or drops. Jitter draws from the namespace's stream.
|
|
1536
|
+
*/
|
|
1537
|
+
fire(rules: readonly FaultRule[], candidate: FaultCandidate): Promise<FaultHit[]>;
|
|
1538
|
+
};
|
|
1539
|
+
|
|
1540
|
+
/**
|
|
1541
|
+
* The admin controls every mock shares, as one document.
|
|
1542
|
+
*
|
|
1543
|
+
* The same shape is accepted in three places, and means the same thing in each:
|
|
1544
|
+
*
|
|
1545
|
+
* - at boot: `createRuntime({ adminControls })`, `serve --admin-controls`,
|
|
1546
|
+
* `MOCKINGBIRD_ADMIN_CONTROLS`
|
|
1547
|
+
* - over HTTP: `PUT /__admin/controls`
|
|
1548
|
+
* - per request: the `x-mockingbird-*` headers in {@link CONTROL_HEADERS}
|
|
1549
|
+
*
|
|
1550
|
+
* Every control is deterministic: given the same seed, clock and requests, a mock answers
|
|
1551
|
+
* the same bytes. Nothing here reads the wall clock or `Math.random`.
|
|
1552
|
+
*/
|
|
1553
|
+
/** Milliseconds, or a string like `"250ms"`, `"2s"`, `"15m"`, `"1h"`, `"3d"`. */
|
|
1554
|
+
type Duration = number | string;
|
|
1555
|
+
/** Epoch milliseconds, or an ISO-8601 string. */
|
|
1556
|
+
type Instant = number | string;
|
|
1557
|
+
type ClockControls = {
|
|
1558
|
+
/** Move the clock to this instant. */
|
|
1559
|
+
now?: Instant;
|
|
1560
|
+
/** Stop time. A frozen clock moves only when told to, so timestamps replay exactly. */
|
|
1561
|
+
frozen?: boolean;
|
|
1562
|
+
/**
|
|
1563
|
+
* Step the clock forward by this much before every vendor request. With a frozen clock
|
|
1564
|
+
* each request still gets its own, reproducible timestamp.
|
|
1565
|
+
*/
|
|
1566
|
+
autoAdvance?: Duration;
|
|
1567
|
+
};
|
|
1568
|
+
/** How long a response takes: a fixed delay plus seeded jitter in `[0, jitter]`. */
|
|
1569
|
+
type LatencyRuleInput = {
|
|
1570
|
+
delay?: Duration;
|
|
1571
|
+
jitter?: Duration;
|
|
1572
|
+
};
|
|
1573
|
+
type LatencyControls = LatencyRuleInput & {
|
|
1574
|
+
/** Per-operation overrides, keyed by operationId. A bare duration is its `delay`. */
|
|
1575
|
+
operations?: Record<string, Duration | LatencyRuleInput>;
|
|
1576
|
+
};
|
|
1577
|
+
/** A fault to add: a rule (the id is assigned when omitted), or a named preset with overrides. */
|
|
1578
|
+
type FaultInput = (Omit<FaultRule, "id"> & {
|
|
1579
|
+
id?: string;
|
|
1580
|
+
}) | ({
|
|
1581
|
+
preset: string;
|
|
1582
|
+
} & Partial<FaultRule>);
|
|
1583
|
+
/** Identifies a {@link SnapshotDocument}. */
|
|
1584
|
+
declare const SNAPSHOT_FORMAT = "mockingbird.snapshot/v1";
|
|
1585
|
+
/**
|
|
1586
|
+
* A namespace, as portable JSON: what `GET /__admin/snapshots/:id` returns and what
|
|
1587
|
+
* `PUT /__admin/snapshots/:id` and the boot `snapshot` control accept. Only `format` and
|
|
1588
|
+
* `records` are required, so a hand-written seed file is a valid snapshot.
|
|
1589
|
+
*/
|
|
1590
|
+
type SnapshotDocument = {
|
|
1591
|
+
format: typeof SNAPSHOT_FORMAT;
|
|
1592
|
+
/** The service that wrote it. A snapshot is rejected by any other service. */
|
|
1593
|
+
service?: string;
|
|
1594
|
+
/**
|
|
1595
|
+
* Stored rows. `seq` orders a collection; omitted, rows keep their listed order. `raw` is
|
|
1596
|
+
* the stored text of a row that is not a plain record, and replaces `value` when present.
|
|
1597
|
+
*/
|
|
1598
|
+
records: {
|
|
1599
|
+
collection: string;
|
|
1600
|
+
id: string;
|
|
1601
|
+
seq?: number;
|
|
1602
|
+
value?: unknown;
|
|
1603
|
+
raw?: string;
|
|
1604
|
+
}[];
|
|
1605
|
+
/** Id counters, so the next generated id continues where the snapshot left off. */
|
|
1606
|
+
sequences?: {
|
|
1607
|
+
name: string;
|
|
1608
|
+
kind: string;
|
|
1609
|
+
value: number;
|
|
1610
|
+
}[];
|
|
1611
|
+
clock?: {
|
|
1612
|
+
now: number;
|
|
1613
|
+
frozen: boolean;
|
|
1614
|
+
autoAdvanceMs?: number;
|
|
1615
|
+
};
|
|
1616
|
+
seed?: number | string;
|
|
1617
|
+
/** Positions of the seeded random streams. */
|
|
1618
|
+
rng?: {
|
|
1619
|
+
state: number;
|
|
1620
|
+
faults?: number;
|
|
1621
|
+
latency?: number;
|
|
1622
|
+
};
|
|
1623
|
+
faults?: unknown;
|
|
1624
|
+
latency?: unknown;
|
|
1625
|
+
virtualTime?: boolean;
|
|
1626
|
+
};
|
|
1627
|
+
/** Controls for one namespace. */
|
|
1628
|
+
type NamespaceControls = {
|
|
1629
|
+
/** Seeds every random choice: fault rates, jitter, and whatever the service invents. */
|
|
1630
|
+
seed?: number | string;
|
|
1631
|
+
clock?: ClockControls;
|
|
1632
|
+
/**
|
|
1633
|
+
* Spend injected waits (latency, fault delays, timeouts) on the mock clock instead of the
|
|
1634
|
+
* wall clock: the request returns at once, the clock has moved, and the journal records
|
|
1635
|
+
* the wait exactly. Default `false`: waits are real, so a client's own timeout can fire.
|
|
1636
|
+
*/
|
|
1637
|
+
virtualTime?: boolean;
|
|
1638
|
+
/** Baseline response time for every vendor request. A bare duration is its `delay`. */
|
|
1639
|
+
latency?: Duration | LatencyControls;
|
|
1640
|
+
faults?: readonly FaultInput[];
|
|
1641
|
+
/** Start from this state instead of the service's own seed data. */
|
|
1642
|
+
snapshot?: SnapshotDocument;
|
|
1643
|
+
};
|
|
1644
|
+
/** {@link NamespaceControls} for every namespace, with per-namespace overrides. */
|
|
1645
|
+
type MockControls = NamespaceControls & {
|
|
1646
|
+
/** Vendor credential → namespace, for SDKs that cannot send a namespace header. */
|
|
1647
|
+
credentials?: Record<string, string>;
|
|
1648
|
+
/** Overrides for named namespaces. A key given here replaces the shared value. */
|
|
1649
|
+
namespaces?: Record<string, NamespaceControls>;
|
|
1650
|
+
};
|
|
1651
|
+
/** A latency rule in milliseconds. */
|
|
1652
|
+
type LatencyRule = {
|
|
1653
|
+
delayMs: number;
|
|
1654
|
+
jitterMs: number;
|
|
1655
|
+
};
|
|
1656
|
+
/** Baseline latency for a namespace, normalized. */
|
|
1657
|
+
type LatencyState = LatencyRule & {
|
|
1658
|
+
operations: Record<string, LatencyRule>;
|
|
1659
|
+
};
|
|
1660
|
+
/** What {@link controlHeaders} turns into request headers. */
|
|
1661
|
+
type ControlHeaderInput = {
|
|
1662
|
+
namespace?: string;
|
|
1663
|
+
adminKey?: string;
|
|
1664
|
+
branch?: string;
|
|
1665
|
+
at?: string;
|
|
1666
|
+
reset?: boolean;
|
|
1667
|
+
restore?: string;
|
|
1668
|
+
seed?: number | string;
|
|
1669
|
+
time?: Instant | Date;
|
|
1670
|
+
advance?: Duration;
|
|
1671
|
+
virtualTime?: boolean;
|
|
1672
|
+
delay?: Duration;
|
|
1673
|
+
timeout?: Duration;
|
|
1674
|
+
/** A status, `"drop"`, a preset name, or a fault rule. */
|
|
1675
|
+
fault?: number | string | Record<string, unknown>;
|
|
1676
|
+
snapshot?: string;
|
|
1170
1677
|
};
|
|
1171
1678
|
|
|
1172
1679
|
/**
|
|
@@ -1206,6 +1713,8 @@ type RequestLog = {
|
|
|
1206
1713
|
unmatched: boolean;
|
|
1207
1714
|
/** Set when a fault rule produced the response. */
|
|
1208
1715
|
faultId?: string;
|
|
1716
|
+
/** Milliseconds of injected wait: latency, fault delays and timeouts. Absent when none. */
|
|
1717
|
+
delayMs?: number;
|
|
1209
1718
|
/** Resource ids the handler touched (`userId`, `orderId`, …), when the service reports them. */
|
|
1210
1719
|
ids?: Record<string, string>;
|
|
1211
1720
|
/** Set when the service created a resource the request referred to but that did not exist. */
|
|
@@ -1251,6 +1760,12 @@ type JournalQuery = {
|
|
|
1251
1760
|
/** Only this namespace. Omit for every namespace, oldest first across all of them. */
|
|
1252
1761
|
namespace?: string;
|
|
1253
1762
|
operationId?: string;
|
|
1763
|
+
/** Only this HTTP method, case-insensitive. */
|
|
1764
|
+
method?: string;
|
|
1765
|
+
/** Only this exact path. */
|
|
1766
|
+
path?: string;
|
|
1767
|
+
/** Only requests this fault rule answered or shaped. */
|
|
1768
|
+
faultId?: string;
|
|
1254
1769
|
status?: number;
|
|
1255
1770
|
/** Only entries at or after this instant (epoch ms). */
|
|
1256
1771
|
since?: number;
|
|
@@ -1265,6 +1780,38 @@ type Journal = {
|
|
|
1265
1780
|
clear(namespace?: string): void;
|
|
1266
1781
|
};
|
|
1267
1782
|
|
|
1783
|
+
/**
|
|
1784
|
+
* Baseline response time, per namespace: how long every vendor request takes before any
|
|
1785
|
+
* fault is considered. Jitter draws from a stream the caller owns, one per namespace and
|
|
1786
|
+
* separate from the fault stream, so adding latency never shifts which requests a `rate`
|
|
1787
|
+
* fault hits.
|
|
1788
|
+
*/
|
|
1789
|
+
type LatencyRegistry = {
|
|
1790
|
+
get(namespace: string): LatencyState;
|
|
1791
|
+
set(namespace: string, state: LatencyState): LatencyState;
|
|
1792
|
+
/** Remove one namespace's latency, or every namespace's. */
|
|
1793
|
+
clear(namespace?: string): void;
|
|
1794
|
+
/** Milliseconds this request waits. Draws jitter, so call it once per request. */
|
|
1795
|
+
take(namespace: string, operationId: string | undefined): number;
|
|
1796
|
+
};
|
|
1797
|
+
|
|
1798
|
+
/** Clock state as the admin API reports it. */
|
|
1799
|
+
type ControlClock = ClockState & {
|
|
1800
|
+
/** `now`, as ISO-8601. */
|
|
1801
|
+
iso: string;
|
|
1802
|
+
/** Milliseconds the clock steps before every vendor request. */
|
|
1803
|
+
autoAdvanceMs: number;
|
|
1804
|
+
};
|
|
1805
|
+
/** One namespace's controls: the body of `GET /__admin/controls`. */
|
|
1806
|
+
type ControlState = {
|
|
1807
|
+
namespace: string;
|
|
1808
|
+
seed: number | string;
|
|
1809
|
+
clock: ControlClock;
|
|
1810
|
+
virtualTime: boolean;
|
|
1811
|
+
latency: LatencyState;
|
|
1812
|
+
faults: FaultListing[];
|
|
1813
|
+
};
|
|
1814
|
+
|
|
1268
1815
|
type AdminRequest = {
|
|
1269
1816
|
request: Request;
|
|
1270
1817
|
url: URL;
|
|
@@ -1281,6 +1828,17 @@ type AdminRoute = (request: AdminRequest) => Response | Promise<Response>;
|
|
|
1281
1828
|
* `:param` segments — e.g. `"POST /orders/:id/transition"`.
|
|
1282
1829
|
*/
|
|
1283
1830
|
type AdminRoutes = Record<string, AdminRoute>;
|
|
1831
|
+
/** What `GET /__admin/snapshots` lists for each snapshot. */
|
|
1832
|
+
type SnapshotInfo = {
|
|
1833
|
+
id: string;
|
|
1834
|
+
namespace: string;
|
|
1835
|
+
/** Stored rows in the snapshot. */
|
|
1836
|
+
records: number;
|
|
1837
|
+
/** The namespace clock when it was taken, epoch ms. */
|
|
1838
|
+
at: number;
|
|
1839
|
+
/** Whether `GET /snapshots/:id` can return it as a {@link SnapshotDocument}. */
|
|
1840
|
+
portable: boolean;
|
|
1841
|
+
};
|
|
1284
1842
|
|
|
1285
1843
|
/** Credential → namespace mapping behind `PUT /__admin/credentials`. */
|
|
1286
1844
|
type CredentialRegistry = {
|
|
@@ -1525,14 +2083,26 @@ type RuntimeOptions<T extends ServiceInstance> = {
|
|
|
1525
2083
|
sqlite?: SqliteClient$1;
|
|
1526
2084
|
/** Defaults to a live clock over `Date.now`. */
|
|
1527
2085
|
clock?: Clock;
|
|
1528
|
-
/** Seeds every random choice the runtime makes (fault rates). Default `0`. */
|
|
2086
|
+
/** Seeds every random choice the runtime makes (fault rates, jitter). Default `0`. */
|
|
1529
2087
|
seed?: number | string;
|
|
2088
|
+
/**
|
|
2089
|
+
* Admin controls to boot with: clock, latency, faults, a starting snapshot, credential
|
|
2090
|
+
* mappings and per-namespace overrides. `reset` returns a namespace to exactly this.
|
|
2091
|
+
*/
|
|
2092
|
+
adminControls?: MockControls;
|
|
1530
2093
|
/** Extra `GET /__admin/health` fields, such as the loaded corpus version. */
|
|
1531
2094
|
describe?: () => Record<string, unknown>;
|
|
1532
2095
|
/** Service-specific admin routes, given the runtime so they can reach any namespace. */
|
|
1533
2096
|
admin?: (runtime: ServiceRuntime<T>) => AdminRoutes;
|
|
1534
2097
|
/** Reserved tree for every internal HTTP endpoint, UI and namespace carrier. Default /__admin. */
|
|
1535
2098
|
adminPrefix?: string;
|
|
2099
|
+
/**
|
|
2100
|
+
* A namespace's clock was moved — by `/__admin/clock`, a header, a restore, a reset, or a
|
|
2101
|
+
* wait spent in virtual time. Run whatever the service schedules by that clock, so what
|
|
2102
|
+
* came due is seen at once and not on the next request. Moving the base clock in process
|
|
2103
|
+
* (`runtime.clock`) is the caller's own doing and is not reported here.
|
|
2104
|
+
*/
|
|
2105
|
+
onClockChange?: (namespace: string) => void;
|
|
1536
2106
|
/** Invalidate transient handles before replacing an existing instance's stored state. */
|
|
1537
2107
|
beforeRestore?: (instance: T) => void;
|
|
1538
2108
|
/** Require this value in `x-mockingbird-admin-key` on admin data routes. */
|
|
@@ -1550,7 +2120,10 @@ type RuntimeOptions<T extends ServiceInstance> = {
|
|
|
1550
2120
|
* `sigV4AccessKeyId`.
|
|
1551
2121
|
*/
|
|
1552
2122
|
credential?: (request: Request) => string | undefined;
|
|
1553
|
-
/**
|
|
2123
|
+
/**
|
|
2124
|
+
* Named faults, switched on with `POST /__admin/faults {"preset": "<name>"}`. They join the
|
|
2125
|
+
* standard presets every mock has; one with a standard name replaces it.
|
|
2126
|
+
*/
|
|
1554
2127
|
presets?: Record<string, FaultPreset>;
|
|
1555
2128
|
/** Outbound webhooks; adds the `/__admin/webhooks*` routes and clears on reset. */
|
|
1556
2129
|
webhooks?: WebhookHub;
|
|
@@ -1573,11 +2146,15 @@ type RuntimeOptions<T extends ServiceInstance> = {
|
|
|
1573
2146
|
type RuntimeIO = {
|
|
1574
2147
|
wallNow(): number;
|
|
1575
2148
|
monotonicNow(): number;
|
|
1576
|
-
|
|
2149
|
+
/** Wait on the wall clock. Rejects with the signal's reason when it aborts first. */
|
|
2150
|
+
sleep(ms: number, signal?: AbortSignal): Promise<void>;
|
|
1577
2151
|
};
|
|
1578
2152
|
type ServiceTimelineState = Readonly<{
|
|
1579
2153
|
snapshot: NamespaceSnapshot;
|
|
1580
|
-
clock
|
|
2154
|
+
/** `pinned`: the namespace's clock was frozen itself, not just following a frozen base. */
|
|
2155
|
+
clock: Readonly<ClockState & {
|
|
2156
|
+
pinned?: boolean;
|
|
2157
|
+
}>;
|
|
1581
2158
|
rngState: number;
|
|
1582
2159
|
}>;
|
|
1583
2160
|
type ServiceCheckpoint = Checkpoint<ServiceTimelineState>;
|
|
@@ -1590,14 +2167,18 @@ type ServiceRuntime<T extends ServiceInstance> = FetchAPI & {
|
|
|
1590
2167
|
readonly sqlite: SqliteClient$1;
|
|
1591
2168
|
readonly clock: Clock;
|
|
1592
2169
|
readonly faults: FaultRegistry;
|
|
2170
|
+
/** Baseline response time per namespace. */
|
|
2171
|
+
readonly latency: LatencyRegistry;
|
|
1593
2172
|
readonly metrics: Metrics;
|
|
1594
2173
|
readonly journal: Journal;
|
|
1595
2174
|
readonly rng: Rng;
|
|
1596
2175
|
readonly credentials: CredentialRegistry;
|
|
1597
2176
|
/** The webhook hub, when the service has outbound webhooks. */
|
|
1598
2177
|
readonly webhooks: WebhookHub | undefined;
|
|
1599
|
-
/**
|
|
1600
|
-
|
|
2178
|
+
/**
|
|
2179
|
+
* A namespace's clock. Each follows the base clock, {@link ServiceRuntime.clock}, with an
|
|
2180
|
+
* offset and a freeze of its own, so moving one never moves another.
|
|
2181
|
+
*/
|
|
1601
2182
|
namespaceClock(namespace?: string): Clock;
|
|
1602
2183
|
namespaceOf(request: Request): string;
|
|
1603
2184
|
/** Opaque in-process checkpoint including records, controls and webhook history. */
|
|
@@ -1609,8 +2190,38 @@ type ServiceRuntime<T extends ServiceInstance> = FetchAPI & {
|
|
|
1609
2190
|
instance(namespace?: string): T;
|
|
1610
2191
|
/** Public names of every namespace created so far. */
|
|
1611
2192
|
namespaces(): string[];
|
|
1612
|
-
/**
|
|
2193
|
+
/** Return one namespace to its boot state, or every namespace with `"*"`. */
|
|
1613
2194
|
reset(namespace?: string): Promise<void>;
|
|
2195
|
+
/** Reset a namespace and forget it, releasing everything it held. */
|
|
2196
|
+
dropNamespace(namespace: string): Promise<void>;
|
|
2197
|
+
/** A namespace's controls: seed, clock, virtual time, latency, faults and snapshots. */
|
|
2198
|
+
controls(namespace?: string): ControlState & {
|
|
2199
|
+
snapshots: SnapshotInfo[];
|
|
2200
|
+
};
|
|
2201
|
+
/** Apply a control document to a namespace. A given key replaces that control. */
|
|
2202
|
+
configure(controls: NamespaceControls, namespace?: string): ControlState & {
|
|
2203
|
+
snapshots: SnapshotInfo[];
|
|
2204
|
+
};
|
|
2205
|
+
/** Named snapshots of a namespace: records, clock, random streams, faults and latency. */
|
|
2206
|
+
readonly snapshots: {
|
|
2207
|
+
/** Capture the namespace now. Reusing a name replaces that snapshot. */
|
|
2208
|
+
create(options?: {
|
|
2209
|
+
name?: string;
|
|
2210
|
+
namespace?: string;
|
|
2211
|
+
}): SnapshotInfo;
|
|
2212
|
+
list(namespace?: string): SnapshotInfo[];
|
|
2213
|
+
/** The snapshot as portable JSON, to commit beside a suite or boot another mock from. */
|
|
2214
|
+
export(id: string, namespace?: string): SnapshotDocument;
|
|
2215
|
+
/** Store a document as a snapshot without restoring it. */
|
|
2216
|
+
import(document: SnapshotDocument, options?: {
|
|
2217
|
+
name?: string;
|
|
2218
|
+
namespace?: string;
|
|
2219
|
+
}): SnapshotInfo;
|
|
2220
|
+
restore(id: string, namespace?: string): void;
|
|
2221
|
+
delete(id: string, namespace?: string): boolean;
|
|
2222
|
+
};
|
|
2223
|
+
/** Request headers that carry controls, checked: spread them into a `fetch` or an SDK's defaults. */
|
|
2224
|
+
headers(input: ControlHeaderInput): Record<string, string>;
|
|
1614
2225
|
snapshot(namespace?: string): NamespaceSnapshot;
|
|
1615
2226
|
restore(snapshot: NamespaceSnapshot, namespace?: string): void;
|
|
1616
2227
|
/** Capture the current branch. Mutating HTTP calls do this automatically. */
|
|
@@ -1752,7 +2363,7 @@ declare class DockerLifecycle {
|
|
|
1752
2363
|
cancelWaits(): void;
|
|
1753
2364
|
}
|
|
1754
2365
|
|
|
1755
|
-
type DockerRuntimeOptions = Pick<RuntimeOptions<DockerAPI>, "sqlite" | "clock" | "seed" | "adminKey" | "onLog" | "journalSize" | "maxCheckpoints"> & Pick<DockerAPIOptions, "onAttach">;
|
|
2366
|
+
type DockerRuntimeOptions = Pick<RuntimeOptions<DockerAPI>, "sqlite" | "clock" | "seed" | "adminKey" | "adminControls" | "onLog" | "journalSize" | "maxCheckpoints"> & Pick<DockerAPIOptions, "onAttach">;
|
|
1756
2367
|
type DockerRuntime = ServiceRuntime<DockerAPI> & {
|
|
1757
2368
|
close(): void;
|
|
1758
2369
|
};
|