@crvouga/mockingbird-service-rxvortex 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 +14 -11
- package/dist/chunk-5NISHHYG.js +4830 -0
- package/dist/chunk-5NISHHYG.js.map +7 -0
- package/dist/chunk-IGSGSEGS.js +6493 -0
- package/dist/chunk-IGSGSEGS.js.map +7 -0
- package/dist/cli.js +2 -2
- package/dist/index.d.ts +354 -41
- package/dist/index.js +1 -1
- package/dist/server.d.ts +709 -82
- package/dist/server.js +2 -2
- package/package.json +3 -2
- package/dist/chunk-7HMXBWW2.js +0 -911
- package/dist/chunk-7HMXBWW2.js.map +0 -7
- package/dist/chunk-V2QVAS5F.js +0 -4520
- package/dist/chunk-V2QVAS5F.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,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$2;
|
|
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. */
|
|
@@ -862,7 +1176,7 @@ type ClockState = {
|
|
|
862
1176
|
now: number;
|
|
863
1177
|
/** True while time does not advance on its own. */
|
|
864
1178
|
frozen: boolean;
|
|
865
|
-
/** Milliseconds
|
|
1179
|
+
/** Milliseconds a running clock adds to its underlying source. `0` while frozen. */
|
|
866
1180
|
offsetMs: number;
|
|
867
1181
|
};
|
|
868
1182
|
type Clock = {
|
|
@@ -898,7 +1212,10 @@ type Rng = {
|
|
|
898
1212
|
state(): number;
|
|
899
1213
|
/** Restore a state previously returned by {@link state}. */
|
|
900
1214
|
setState(state: number): void;
|
|
901
|
-
seed
|
|
1215
|
+
/** Restart the stream from a new seed. `reset` then returns to this seed. */
|
|
1216
|
+
reseed(seed: number | string): void;
|
|
1217
|
+
/** The seed the stream currently starts from. */
|
|
1218
|
+
readonly seed: number;
|
|
902
1219
|
};
|
|
903
1220
|
|
|
904
1221
|
/**
|
|
@@ -907,44 +1224,83 @@ type Rng = {
|
|
|
907
1224
|
* This is how a suite reaches the vendor's failure modes without the vendor: the
|
|
908
1225
|
* quota error that only appears when a shared sandbox is full, the 429 that only
|
|
909
1226
|
* appears under load, the 5xx that proves a retry path works.
|
|
1227
|
+
*
|
|
1228
|
+
* A rule has three parts. What it **matches** (`operationId`, `method`, `path`, …), **when**
|
|
1229
|
+
* it fires among the matching requests (`after`, `every`, `count`, `rate`, `from`, `until`),
|
|
1230
|
+
* and what it **does** (`status`, `delay`, `timeout`, `drop`, `truncate`, `effect`).
|
|
910
1231
|
*/
|
|
911
1232
|
type FaultRule = {
|
|
912
|
-
/** Stable id, so a suite can retire exactly the rule it added. */
|
|
1233
|
+
/** Stable id, so a suite can retire exactly the rule it added. Unique within a namespace. */
|
|
913
1234
|
id: string;
|
|
914
1235
|
/** Fault only this operation. Omit to match every operation. */
|
|
915
1236
|
operationId?: string;
|
|
916
1237
|
/** Fault only this HTTP method, case-insensitive. Omit to match every method. */
|
|
917
1238
|
method?: string;
|
|
1239
|
+
/** Fault only this exact path. */
|
|
1240
|
+
path?: string;
|
|
918
1241
|
/** Fault only paths starting with this prefix. Omit to match every path. */
|
|
919
1242
|
pathPrefix?: string;
|
|
1243
|
+
/** Fault only paths matching this regular expression (JavaScript syntax, unanchored). */
|
|
1244
|
+
pathPattern?: string;
|
|
1245
|
+
/** Fault only requests carrying these headers. `"*"` matches any value. */
|
|
1246
|
+
requestHeaders?: Record<string, string>;
|
|
1247
|
+
/** Fault only requests carrying these query parameters. `"*"` matches any value. */
|
|
1248
|
+
query?: Record<string, string>;
|
|
920
1249
|
/**
|
|
921
1250
|
* Fault only this namespace. Omit (or `"*"`) to fault every namespace — which is what
|
|
922
1251
|
* an in-process caller usually wants, and what a parallel worker usually does not:
|
|
923
1252
|
* rules added through `POST /__admin/faults` default to the calling namespace.
|
|
924
1253
|
*/
|
|
925
1254
|
namespace?: string;
|
|
1255
|
+
/** Let this many matching requests through first. */
|
|
1256
|
+
after?: number;
|
|
1257
|
+
/** Then fault only every nth matching request: `3` faults the 3rd, 6th, 9th. */
|
|
1258
|
+
every?: number;
|
|
1259
|
+
/** Retire the rule after this many faults. Omit to keep it until removed. */
|
|
1260
|
+
count?: number;
|
|
1261
|
+
/** Fault this fraction of the remaining requests, `0`–`1`, drawn from the seed. Default `1`. */
|
|
1262
|
+
rate?: number;
|
|
1263
|
+
/**
|
|
1264
|
+
* Fault only from this instant on the namespace clock. A duration (`"5m"`) counts from the
|
|
1265
|
+
* clock when the rule was added. Listed as epoch ms.
|
|
1266
|
+
*/
|
|
1267
|
+
from?: Instant | Duration;
|
|
1268
|
+
/** Stop faulting at this instant on the namespace clock. A duration counts from when added. */
|
|
1269
|
+
until?: Instant | Duration;
|
|
926
1270
|
/**
|
|
927
|
-
* Status of the injected response. Omit for a rule that only delays
|
|
928
|
-
*
|
|
929
|
-
* the request then still reaches the service.
|
|
1271
|
+
* Status of the injected response. Omit for a rule that only delays, times out, drops,
|
|
1272
|
+
* truncates, or switches on an `effect`: the request then still reaches the service.
|
|
930
1273
|
*/
|
|
931
1274
|
status?: number;
|
|
932
1275
|
/** Response body, serialized as JSON. A string is sent as-is. */
|
|
933
1276
|
body?: unknown;
|
|
1277
|
+
/** Response headers. */
|
|
934
1278
|
headers?: Record<string, string>;
|
|
935
|
-
/**
|
|
936
|
-
|
|
937
|
-
/**
|
|
938
|
-
rate?: number;
|
|
939
|
-
/** Hold the response back this long, to exercise timeouts. */
|
|
1279
|
+
/** Hold the response back this long. Listed as `delayMs`. */
|
|
1280
|
+
delay?: Duration;
|
|
1281
|
+
/** `delay`, in milliseconds. */
|
|
940
1282
|
delayMs?: number;
|
|
941
1283
|
/** Alias of `delayMs`. */
|
|
942
1284
|
latencyMs?: number;
|
|
1285
|
+
/** Extra seeded delay in `[0, jitter]`. Listed as `jitterMs`. */
|
|
1286
|
+
jitter?: Duration;
|
|
1287
|
+
jitterMs?: number;
|
|
1288
|
+
/**
|
|
1289
|
+
* Never answer: hold the request this long, then drop the connection. Listed as
|
|
1290
|
+
* `timeoutMs`. With virtual time the wait is spent on the mock clock.
|
|
1291
|
+
*/
|
|
1292
|
+
timeout?: Duration;
|
|
1293
|
+
timeoutMs?: number;
|
|
943
1294
|
/**
|
|
944
1295
|
* Drop the connection instead of answering: an in-process `fetch` rejects with a
|
|
945
1296
|
* `TypeError`, and a served mock destroys the socket. Models "unknown outcome" failures.
|
|
946
1297
|
*/
|
|
947
1298
|
drop?: boolean;
|
|
1299
|
+
/**
|
|
1300
|
+
* Cut the response body off after this many bytes: the status and headers arrive, then
|
|
1301
|
+
* the connection dies mid-body.
|
|
1302
|
+
*/
|
|
1303
|
+
truncate?: number;
|
|
948
1304
|
/**
|
|
949
1305
|
* A named service behaviour to switch on for the matching request instead of (or
|
|
950
1306
|
* before) a canned response, e.g. `created_but_500` or `numeric_tracking_id`. Services
|
|
@@ -953,8 +1309,8 @@ type FaultRule = {
|
|
|
953
1309
|
effect?: string;
|
|
954
1310
|
/** Parameters for `effect`. */
|
|
955
1311
|
params?: Record<string, unknown>;
|
|
956
|
-
/**
|
|
957
|
-
|
|
1312
|
+
/** The preset this rule was expanded from, if any. */
|
|
1313
|
+
fromPreset?: string;
|
|
958
1314
|
};
|
|
959
1315
|
/** A fault that fired for one request. */
|
|
960
1316
|
type FaultHit = {
|
|
@@ -962,6 +1318,10 @@ type FaultHit = {
|
|
|
962
1318
|
/** The injected response; absent when the rule only delays, drops, or sets an effect. */
|
|
963
1319
|
response?: Response;
|
|
964
1320
|
drop?: boolean;
|
|
1321
|
+
/** Set with `drop` when the rule held the request for its `timeout` first. */
|
|
1322
|
+
timeout?: boolean;
|
|
1323
|
+
/** Bytes of response body to let through before the connection dies. */
|
|
1324
|
+
truncate?: number;
|
|
965
1325
|
effect?: {
|
|
966
1326
|
name: string;
|
|
967
1327
|
params: Record<string, unknown>;
|
|
@@ -973,38 +1333,202 @@ type FaultCandidate = {
|
|
|
973
1333
|
method: string;
|
|
974
1334
|
path: string;
|
|
975
1335
|
namespace: string;
|
|
1336
|
+
/** Request headers and query, for rules that match on them. */
|
|
1337
|
+
headers?: Headers;
|
|
1338
|
+
query?: URLSearchParams;
|
|
1339
|
+
/** The namespace clock, for `from` / `until`. Rules with a window are skipped without it. */
|
|
1340
|
+
now?: number;
|
|
1341
|
+
/** How to spend a delay for this request. Default: the registry's own sleep. */
|
|
1342
|
+
wait?: (ms: number) => Promise<void>;
|
|
1343
|
+
};
|
|
1344
|
+
/** A stored rule and how often it was consulted. */
|
|
1345
|
+
type FaultListing = FaultRule & {
|
|
1346
|
+
/** Faults left before the rule retires. `null` when it has no `count`. */
|
|
1347
|
+
remaining: number | null;
|
|
1348
|
+
/** Times the rule faulted a request. */
|
|
1349
|
+
hits: number;
|
|
1350
|
+
/** Requests that matched the rule, faulted or not. */
|
|
1351
|
+
seen: number;
|
|
1352
|
+
};
|
|
1353
|
+
/** A namespace's own rules, with their counters, in the order they are tried. */
|
|
1354
|
+
type FaultSnapshot = {
|
|
1355
|
+
/**
|
|
1356
|
+
* `position` is how many `"*"` rules are tried before the rule, which is what its place
|
|
1357
|
+
* in the order means to a request and holds in any process.
|
|
1358
|
+
*/
|
|
1359
|
+
rules: (FaultListing & {
|
|
1360
|
+
position?: number;
|
|
1361
|
+
})[];
|
|
1362
|
+
/** How many `fault_<n>` ids the namespace has handed out. */
|
|
1363
|
+
nextId?: number;
|
|
976
1364
|
};
|
|
977
1365
|
type FaultRegistry = {
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
rules: (FaultRule & {
|
|
981
|
-
remaining: number | null;
|
|
982
|
-
hits: number;
|
|
983
|
-
position: number;
|
|
984
|
-
})[];
|
|
985
|
-
rngState: number;
|
|
986
|
-
};
|
|
1366
|
+
snapshot(namespace: string): FaultSnapshot;
|
|
1367
|
+
/** Add a rule, or replace the rule with the same id in the same namespace. */
|
|
987
1368
|
add(rule: FaultRule): FaultRule;
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
})[];
|
|
1000
|
-
rngState: number;
|
|
1001
|
-
}): void;
|
|
1369
|
+
/** The next unused `fault_<n>` id in `namespace`. */
|
|
1370
|
+
nextId(namespace: string): string;
|
|
1371
|
+
/** Every rule, or the rules a namespace's requests can hit: its own and the global ones. */
|
|
1372
|
+
list(namespace?: string): FaultListing[];
|
|
1373
|
+
get(id: string, namespace?: string): FaultListing | undefined;
|
|
1374
|
+
/** Remove a rule by id: from `namespace` (its own, then a global one), or wherever it is. */
|
|
1375
|
+
remove(id: string, namespace?: string): boolean;
|
|
1376
|
+
/** Remove every rule, or one namespace's own rules. */
|
|
1377
|
+
clear(namespace?: string): void;
|
|
1378
|
+
/** Replace a namespace's own rules with a snapshot's, wherever the snapshot was taken. */
|
|
1379
|
+
restore(namespace: string, state: FaultSnapshot): void;
|
|
1002
1380
|
/**
|
|
1003
1381
|
* Every fault this request should get, in rule order, stopping at the first that answers
|
|
1004
1382
|
* or drops (effect-only and delay-only rules let later rules match too). Consumes one of
|
|
1005
1383
|
* each matching rule's remaining uses.
|
|
1006
1384
|
*/
|
|
1007
1385
|
take(candidate: FaultCandidate): Promise<FaultHit[]>;
|
|
1386
|
+
/**
|
|
1387
|
+
* Fire these rules at one request without storing them: no matching, no schedule, in order,
|
|
1388
|
+
* stopping at the first that answers or drops. Jitter draws from the namespace's stream.
|
|
1389
|
+
*/
|
|
1390
|
+
fire(rules: readonly FaultRule[], candidate: FaultCandidate): Promise<FaultHit[]>;
|
|
1391
|
+
};
|
|
1392
|
+
|
|
1393
|
+
/**
|
|
1394
|
+
* The admin controls every mock shares, as one document.
|
|
1395
|
+
*
|
|
1396
|
+
* The same shape is accepted in three places, and means the same thing in each:
|
|
1397
|
+
*
|
|
1398
|
+
* - at boot: `createRuntime({ adminControls })`, `serve --admin-controls`,
|
|
1399
|
+
* `MOCKINGBIRD_ADMIN_CONTROLS`
|
|
1400
|
+
* - over HTTP: `PUT /__admin/controls`
|
|
1401
|
+
* - per request: the `x-mockingbird-*` headers in {@link CONTROL_HEADERS}
|
|
1402
|
+
*
|
|
1403
|
+
* Every control is deterministic: given the same seed, clock and requests, a mock answers
|
|
1404
|
+
* the same bytes. Nothing here reads the wall clock or `Math.random`.
|
|
1405
|
+
*/
|
|
1406
|
+
/** Milliseconds, or a string like `"250ms"`, `"2s"`, `"15m"`, `"1h"`, `"3d"`. */
|
|
1407
|
+
type Duration = number | string;
|
|
1408
|
+
/** Epoch milliseconds, or an ISO-8601 string. */
|
|
1409
|
+
type Instant = number | string;
|
|
1410
|
+
type ClockControls = {
|
|
1411
|
+
/** Move the clock to this instant. */
|
|
1412
|
+
now?: Instant;
|
|
1413
|
+
/** Stop time. A frozen clock moves only when told to, so timestamps replay exactly. */
|
|
1414
|
+
frozen?: boolean;
|
|
1415
|
+
/**
|
|
1416
|
+
* Step the clock forward by this much before every vendor request. With a frozen clock
|
|
1417
|
+
* each request still gets its own, reproducible timestamp.
|
|
1418
|
+
*/
|
|
1419
|
+
autoAdvance?: Duration;
|
|
1420
|
+
};
|
|
1421
|
+
/** How long a response takes: a fixed delay plus seeded jitter in `[0, jitter]`. */
|
|
1422
|
+
type LatencyRuleInput = {
|
|
1423
|
+
delay?: Duration;
|
|
1424
|
+
jitter?: Duration;
|
|
1425
|
+
};
|
|
1426
|
+
type LatencyControls = LatencyRuleInput & {
|
|
1427
|
+
/** Per-operation overrides, keyed by operationId. A bare duration is its `delay`. */
|
|
1428
|
+
operations?: Record<string, Duration | LatencyRuleInput>;
|
|
1429
|
+
};
|
|
1430
|
+
/** A fault to add: a rule (the id is assigned when omitted), or a named preset with overrides. */
|
|
1431
|
+
type FaultInput = (Omit<FaultRule, "id"> & {
|
|
1432
|
+
id?: string;
|
|
1433
|
+
}) | ({
|
|
1434
|
+
preset: string;
|
|
1435
|
+
} & Partial<FaultRule>);
|
|
1436
|
+
/** Identifies a {@link SnapshotDocument}. */
|
|
1437
|
+
declare const SNAPSHOT_FORMAT = "mockingbird.snapshot/v1";
|
|
1438
|
+
/**
|
|
1439
|
+
* A namespace, as portable JSON: what `GET /__admin/snapshots/:id` returns and what
|
|
1440
|
+
* `PUT /__admin/snapshots/:id` and the boot `snapshot` control accept. Only `format` and
|
|
1441
|
+
* `records` are required, so a hand-written seed file is a valid snapshot.
|
|
1442
|
+
*/
|
|
1443
|
+
type SnapshotDocument = {
|
|
1444
|
+
format: typeof SNAPSHOT_FORMAT;
|
|
1445
|
+
/** The service that wrote it. A snapshot is rejected by any other service. */
|
|
1446
|
+
service?: string;
|
|
1447
|
+
/**
|
|
1448
|
+
* Stored rows. `seq` orders a collection; omitted, rows keep their listed order. `raw` is
|
|
1449
|
+
* the stored text of a row that is not a plain record, and replaces `value` when present.
|
|
1450
|
+
*/
|
|
1451
|
+
records: {
|
|
1452
|
+
collection: string;
|
|
1453
|
+
id: string;
|
|
1454
|
+
seq?: number;
|
|
1455
|
+
value?: unknown;
|
|
1456
|
+
raw?: string;
|
|
1457
|
+
}[];
|
|
1458
|
+
/** Id counters, so the next generated id continues where the snapshot left off. */
|
|
1459
|
+
sequences?: {
|
|
1460
|
+
name: string;
|
|
1461
|
+
kind: string;
|
|
1462
|
+
value: number;
|
|
1463
|
+
}[];
|
|
1464
|
+
clock?: {
|
|
1465
|
+
now: number;
|
|
1466
|
+
frozen: boolean;
|
|
1467
|
+
autoAdvanceMs?: number;
|
|
1468
|
+
};
|
|
1469
|
+
seed?: number | string;
|
|
1470
|
+
/** Positions of the seeded random streams. */
|
|
1471
|
+
rng?: {
|
|
1472
|
+
state: number;
|
|
1473
|
+
faults?: number;
|
|
1474
|
+
latency?: number;
|
|
1475
|
+
};
|
|
1476
|
+
faults?: unknown;
|
|
1477
|
+
latency?: unknown;
|
|
1478
|
+
virtualTime?: boolean;
|
|
1479
|
+
/** Quiescent webhook endpoints, delivery history and fault state. Contains private configuration. */
|
|
1480
|
+
webhooks?: unknown;
|
|
1481
|
+
};
|
|
1482
|
+
/** Controls for one namespace. */
|
|
1483
|
+
type NamespaceControls = {
|
|
1484
|
+
/** Seeds every random choice: fault rates, jitter, and whatever the service invents. */
|
|
1485
|
+
seed?: number | string;
|
|
1486
|
+
clock?: ClockControls;
|
|
1487
|
+
/**
|
|
1488
|
+
* Spend injected waits (latency, fault delays, timeouts) on the mock clock instead of the
|
|
1489
|
+
* wall clock: the request returns at once, the clock has moved, and the journal records
|
|
1490
|
+
* the wait exactly. Default `false`: waits are real, so a client's own timeout can fire.
|
|
1491
|
+
*/
|
|
1492
|
+
virtualTime?: boolean;
|
|
1493
|
+
/** Baseline response time for every vendor request. A bare duration is its `delay`. */
|
|
1494
|
+
latency?: Duration | LatencyControls;
|
|
1495
|
+
faults?: readonly FaultInput[];
|
|
1496
|
+
/** Start from this state instead of the service's own seed data. */
|
|
1497
|
+
snapshot?: SnapshotDocument;
|
|
1498
|
+
};
|
|
1499
|
+
/** {@link NamespaceControls} for every namespace, with per-namespace overrides. */
|
|
1500
|
+
type MockControls = NamespaceControls & {
|
|
1501
|
+
/** Vendor credential → namespace, for SDKs that cannot send a namespace header. */
|
|
1502
|
+
credentials?: Record<string, string>;
|
|
1503
|
+
/** Overrides for named namespaces. A key given here replaces the shared value. */
|
|
1504
|
+
namespaces?: Record<string, NamespaceControls>;
|
|
1505
|
+
};
|
|
1506
|
+
/** A latency rule in milliseconds. */
|
|
1507
|
+
type LatencyRule = {
|
|
1508
|
+
delayMs: number;
|
|
1509
|
+
jitterMs: number;
|
|
1510
|
+
};
|
|
1511
|
+
/** Baseline latency for a namespace, normalized. */
|
|
1512
|
+
type LatencyState = LatencyRule & {
|
|
1513
|
+
operations: Record<string, LatencyRule>;
|
|
1514
|
+
};
|
|
1515
|
+
/** What {@link controlHeaders} turns into request headers. */
|
|
1516
|
+
type ControlHeaderInput = {
|
|
1517
|
+
namespace?: string;
|
|
1518
|
+
adminKey?: string;
|
|
1519
|
+
branch?: string;
|
|
1520
|
+
at?: string;
|
|
1521
|
+
reset?: boolean;
|
|
1522
|
+
restore?: string;
|
|
1523
|
+
seed?: number | string;
|
|
1524
|
+
time?: Instant | Date;
|
|
1525
|
+
advance?: Duration;
|
|
1526
|
+
virtualTime?: boolean;
|
|
1527
|
+
delay?: Duration;
|
|
1528
|
+
timeout?: Duration;
|
|
1529
|
+
/** A status, `"drop"`, a preset name, or a fault rule. */
|
|
1530
|
+
fault?: number | string | Record<string, unknown>;
|
|
1531
|
+
snapshot?: string;
|
|
1008
1532
|
};
|
|
1009
1533
|
|
|
1010
1534
|
/**
|
|
@@ -1044,6 +1568,8 @@ type RequestLog = {
|
|
|
1044
1568
|
unmatched: boolean;
|
|
1045
1569
|
/** Set when a fault rule produced the response. */
|
|
1046
1570
|
faultId?: string;
|
|
1571
|
+
/** Milliseconds of injected wait: latency, fault delays and timeouts. Absent when none. */
|
|
1572
|
+
delayMs?: number;
|
|
1047
1573
|
/** Resource ids the handler touched (`userId`, `orderId`, …), when the service reports them. */
|
|
1048
1574
|
ids?: Record<string, string>;
|
|
1049
1575
|
/** Set when the service created a resource the request referred to but that did not exist. */
|
|
@@ -1089,6 +1615,12 @@ type JournalQuery = {
|
|
|
1089
1615
|
/** Only this namespace. Omit for every namespace, oldest first across all of them. */
|
|
1090
1616
|
namespace?: string;
|
|
1091
1617
|
operationId?: string;
|
|
1618
|
+
/** Only this HTTP method, case-insensitive. */
|
|
1619
|
+
method?: string;
|
|
1620
|
+
/** Only this exact path. */
|
|
1621
|
+
path?: string;
|
|
1622
|
+
/** Only requests this fault rule answered or shaped. */
|
|
1623
|
+
faultId?: string;
|
|
1092
1624
|
status?: number;
|
|
1093
1625
|
/** Only entries at or after this instant (epoch ms). */
|
|
1094
1626
|
since?: number;
|
|
@@ -1103,6 +1635,50 @@ type Journal = {
|
|
|
1103
1635
|
clear(namespace?: string): void;
|
|
1104
1636
|
};
|
|
1105
1637
|
|
|
1638
|
+
/**
|
|
1639
|
+
* Baseline response time, per namespace: how long every vendor request takes before any
|
|
1640
|
+
* fault is considered. Jitter draws from a stream the caller owns, one per namespace and
|
|
1641
|
+
* separate from the fault stream, so adding latency never shifts which requests a `rate`
|
|
1642
|
+
* fault hits.
|
|
1643
|
+
*/
|
|
1644
|
+
type LatencyRegistry = {
|
|
1645
|
+
get(namespace: string): LatencyState;
|
|
1646
|
+
set(namespace: string, state: LatencyState): LatencyState;
|
|
1647
|
+
/** Remove one namespace's latency, or every namespace's. */
|
|
1648
|
+
clear(namespace?: string): void;
|
|
1649
|
+
/** Milliseconds this request waits. Draws jitter, so call it once per request. */
|
|
1650
|
+
take(namespace: string, operationId: string | undefined): number;
|
|
1651
|
+
};
|
|
1652
|
+
|
|
1653
|
+
/** Clock state as the admin API reports it. */
|
|
1654
|
+
type ControlClock = ClockState & {
|
|
1655
|
+
/** `now`, as ISO-8601. */
|
|
1656
|
+
iso: string;
|
|
1657
|
+
/** Milliseconds the clock steps before every vendor request. */
|
|
1658
|
+
autoAdvanceMs: number;
|
|
1659
|
+
};
|
|
1660
|
+
/** One namespace's controls: the body of `GET /__admin/controls`. */
|
|
1661
|
+
type ControlState = {
|
|
1662
|
+
namespace: string;
|
|
1663
|
+
seed: number | string;
|
|
1664
|
+
clock: ControlClock;
|
|
1665
|
+
virtualTime: boolean;
|
|
1666
|
+
latency: LatencyState;
|
|
1667
|
+
faults: FaultListing[];
|
|
1668
|
+
};
|
|
1669
|
+
|
|
1670
|
+
/** What `GET /__admin/snapshots` lists for each snapshot. */
|
|
1671
|
+
type SnapshotInfo = {
|
|
1672
|
+
id: string;
|
|
1673
|
+
namespace: string;
|
|
1674
|
+
/** Stored rows in the snapshot. */
|
|
1675
|
+
records: number;
|
|
1676
|
+
/** The namespace clock when it was taken, epoch ms. */
|
|
1677
|
+
at: number;
|
|
1678
|
+
/** Whether `GET /snapshots/:id` can return it as a {@link SnapshotDocument}. */
|
|
1679
|
+
portable: boolean;
|
|
1680
|
+
};
|
|
1681
|
+
|
|
1106
1682
|
/** Credential → namespace mapping behind `PUT /__admin/credentials`. */
|
|
1107
1683
|
type CredentialRegistry = {
|
|
1108
1684
|
set(credential: string, namespace: string): void;
|
|
@@ -1115,6 +1691,8 @@ type CredentialRegistry = {
|
|
|
1115
1691
|
}[];
|
|
1116
1692
|
};
|
|
1117
1693
|
|
|
1694
|
+
type OwnedTransport = (request: Request, namespace: string, send: typeof fetch) => Promise<Response>;
|
|
1695
|
+
|
|
1118
1696
|
/**
|
|
1119
1697
|
* A point-in-time copy of everything a service namespace holds.
|
|
1120
1698
|
*
|
|
@@ -1232,8 +1810,16 @@ type PublishInput = {
|
|
|
1232
1810
|
id?: string;
|
|
1233
1811
|
};
|
|
1234
1812
|
type WebhookHub = {
|
|
1813
|
+
observeDeliveries(listener: (event: {
|
|
1814
|
+
namespace: string;
|
|
1815
|
+
state: string;
|
|
1816
|
+
deliveryId: string;
|
|
1817
|
+
}) => void): () => void;
|
|
1818
|
+
setTransportPolicy(policy: OwnedTransport): void;
|
|
1235
1819
|
pending(namespace: string): number;
|
|
1236
1820
|
snapshot(namespace: string): unknown;
|
|
1821
|
+
exportSnapshot(handle: unknown): unknown;
|
|
1822
|
+
importSnapshot(namespace: string, document: unknown): unknown;
|
|
1237
1823
|
restore(namespace: string, snapshot: unknown): void;
|
|
1238
1824
|
publish(input: PublishInput): WebhookMessage;
|
|
1239
1825
|
/** Replace a namespace's own endpoints (`PUT /__admin/webhook-endpoints`). */
|
|
@@ -1246,7 +1832,7 @@ type WebhookHub = {
|
|
|
1246
1832
|
/** Run every pending retry (and release held reordered messages) now, and every retry those attempts schedule, until nothing is pending. */
|
|
1247
1833
|
flush(): Promise<void>;
|
|
1248
1834
|
/** Resolve once nothing is in flight. */
|
|
1249
|
-
idle(): Promise<void>;
|
|
1835
|
+
idle(namespace?: string): Promise<void>;
|
|
1250
1836
|
fault(namespace: string, fault: WebhookFault): void;
|
|
1251
1837
|
clear(namespace?: string): void;
|
|
1252
1838
|
};
|
|
@@ -1257,7 +1843,10 @@ type ServiceInstance = FetchAPI$1 & {
|
|
|
1257
1843
|
};
|
|
1258
1844
|
type ServiceTimelineState = Readonly<{
|
|
1259
1845
|
snapshot: NamespaceSnapshot;
|
|
1260
|
-
clock
|
|
1846
|
+
/** `pinned`: the namespace's clock was frozen itself, not just following a frozen base. */
|
|
1847
|
+
clock: Readonly<ClockState & {
|
|
1848
|
+
pinned?: boolean;
|
|
1849
|
+
}>;
|
|
1261
1850
|
rngState: number;
|
|
1262
1851
|
}>;
|
|
1263
1852
|
type ServiceCheckpoint = Checkpoint<ServiceTimelineState>;
|
|
@@ -1270,27 +1859,63 @@ type ServiceRuntime<T extends ServiceInstance> = FetchAPI$1 & {
|
|
|
1270
1859
|
readonly sqlite: SqliteClient$1;
|
|
1271
1860
|
readonly clock: Clock;
|
|
1272
1861
|
readonly faults: FaultRegistry;
|
|
1862
|
+
/** Baseline response time per namespace. */
|
|
1863
|
+
readonly latency: LatencyRegistry;
|
|
1273
1864
|
readonly metrics: Metrics;
|
|
1274
1865
|
readonly journal: Journal;
|
|
1275
1866
|
readonly rng: Rng;
|
|
1276
1867
|
readonly credentials: CredentialRegistry;
|
|
1277
1868
|
/** The webhook hub, when the service has outbound webhooks. */
|
|
1278
1869
|
readonly webhooks: WebhookHub | undefined;
|
|
1279
|
-
/**
|
|
1280
|
-
|
|
1870
|
+
/**
|
|
1871
|
+
* A namespace's clock. Each follows the base clock, {@link ServiceRuntime.clock}, with an
|
|
1872
|
+
* offset and a freeze of its own, so moving one never moves another.
|
|
1873
|
+
*/
|
|
1281
1874
|
namespaceClock(namespace?: string): Clock;
|
|
1282
1875
|
namespaceOf(request: Request): string;
|
|
1283
1876
|
/** Opaque in-process checkpoint including records, controls and webhook history. */
|
|
1284
1877
|
fleetSnapshot(namespace: string): object;
|
|
1285
1878
|
fleetRestore(snapshot: unknown, namespace: string): void;
|
|
1879
|
+
fleetExport(snapshot: unknown): SnapshotDocument;
|
|
1880
|
+
fleetImport(namespace: string, document: unknown): object;
|
|
1286
1881
|
/** Expand a named preset into fault rules (and webhook faults) for `namespace`. */
|
|
1287
1882
|
applyPreset(name: string, namespace?: string, overrides?: Partial<FaultRule>): FaultRule[];
|
|
1288
1883
|
/** The instance behind `namespace` (the default one when omitted), created on first use. */
|
|
1289
1884
|
instance(namespace?: string): T;
|
|
1290
1885
|
/** Public names of every namespace created so far. */
|
|
1291
1886
|
namespaces(): string[];
|
|
1292
|
-
/**
|
|
1887
|
+
/** Return one namespace to its boot state, or every namespace with `"*"`. */
|
|
1293
1888
|
reset(namespace?: string): Promise<void>;
|
|
1889
|
+
/** Reset a namespace and forget it, releasing everything it held. */
|
|
1890
|
+
dropNamespace(namespace: string): Promise<void>;
|
|
1891
|
+
/** A namespace's controls: seed, clock, virtual time, latency, faults and snapshots. */
|
|
1892
|
+
controls(namespace?: string): ControlState & {
|
|
1893
|
+
snapshots: SnapshotInfo[];
|
|
1894
|
+
};
|
|
1895
|
+
/** Apply a control document to a namespace. A given key replaces that control. */
|
|
1896
|
+
configure(controls: NamespaceControls, namespace?: string): ControlState & {
|
|
1897
|
+
snapshots: SnapshotInfo[];
|
|
1898
|
+
};
|
|
1899
|
+
/** Named snapshots of a namespace: records, clock, random streams, faults and latency. */
|
|
1900
|
+
readonly snapshots: {
|
|
1901
|
+
/** Capture the namespace now. Reusing a name replaces that snapshot. */
|
|
1902
|
+
create(options?: {
|
|
1903
|
+
name?: string;
|
|
1904
|
+
namespace?: string;
|
|
1905
|
+
}): SnapshotInfo;
|
|
1906
|
+
list(namespace?: string): SnapshotInfo[];
|
|
1907
|
+
/** The snapshot as portable JSON, to commit beside a suite or boot another mock from. */
|
|
1908
|
+
export(id: string, namespace?: string): SnapshotDocument;
|
|
1909
|
+
/** Store a document as a snapshot without restoring it. */
|
|
1910
|
+
import(document: SnapshotDocument, options?: {
|
|
1911
|
+
name?: string;
|
|
1912
|
+
namespace?: string;
|
|
1913
|
+
}): SnapshotInfo;
|
|
1914
|
+
restore(id: string, namespace?: string): void;
|
|
1915
|
+
delete(id: string, namespace?: string): boolean;
|
|
1916
|
+
};
|
|
1917
|
+
/** Request headers that carry controls, checked: spread them into a `fetch` or an SDK's defaults. */
|
|
1918
|
+
headers(input: ControlHeaderInput): Record<string, string>;
|
|
1294
1919
|
snapshot(namespace?: string): NamespaceSnapshot;
|
|
1295
1920
|
restore(snapshot: NamespaceSnapshot, namespace?: string): void;
|
|
1296
1921
|
/** Capture the current branch. Mutating HTTP calls do this automatically. */
|
|
@@ -1495,6 +2120,8 @@ type RxVortexRuntimeOptions = {
|
|
|
1495
2120
|
seed?: number | string;
|
|
1496
2121
|
adminPrefix?: string;
|
|
1497
2122
|
adminKey?: string;
|
|
2123
|
+
/** Admin controls to boot with: clock, latency, faults, seed, a starting snapshot. */
|
|
2124
|
+
adminControls?: MockControls;
|
|
1498
2125
|
onLog?: (entry: RequestLog) => void;
|
|
1499
2126
|
/**
|
|
1500
2127
|
* Rows every namespace starts with, and returns to on `POST /__admin/reset` (`serve
|