@crvouga/mockingbird-service-prism 3.1.0 → 3.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 +14 -2
- package/DISCOVERY.md +23 -0
- package/README.md +36 -15
- package/dist/{chunk-BXFWX7GE.js → chunk-BUVISTQJ.js} +139 -26
- package/dist/chunk-BUVISTQJ.js.map +7 -0
- package/dist/chunk-FMOVUFAE.js +5731 -0
- package/dist/chunk-FMOVUFAE.js.map +7 -0
- package/dist/cli.js +2 -2
- package/dist/index.d.ts +435 -121
- package/dist/index.js +1 -1
- package/dist/server.d.ts +819 -188
- package/dist/server.js +2 -2
- package/package.json +3 -2
- package/dist/chunk-BXFWX7GE.js.map +0 -7
- package/dist/chunk-SF36BO5M.js +0 -3851
- package/dist/chunk-SF36BO5M.js.map +0 -7
package/dist/server.d.ts
CHANGED
|
@@ -1,34 +1,16 @@
|
|
|
1
1
|
import { Server } from 'node:http';
|
|
2
2
|
import { Hono } from 'hono';
|
|
3
3
|
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
4
|
+
type MountedAPI$1 = FetchAPI$2 & {
|
|
5
|
+
readonly prefix: string;
|
|
6
|
+
GET: FetchHandler$1;
|
|
7
|
+
POST: FetchHandler$1;
|
|
8
|
+
PUT: FetchHandler$1;
|
|
9
|
+
PATCH: FetchHandler$1;
|
|
10
|
+
DELETE: FetchHandler$1;
|
|
11
|
+
HEAD: FetchHandler$1;
|
|
12
|
+
OPTIONS: FetchHandler$1;
|
|
10
13
|
};
|
|
11
|
-
/**
|
|
12
|
-
* Prepared statement bound to a {@link SqliteClient}.
|
|
13
|
-
*
|
|
14
|
-
* Pass bind values as rest arguments on each call (no sticky `bind()`).
|
|
15
|
-
*/
|
|
16
|
-
interface SqliteStatement$2 {
|
|
17
|
-
run(...params: SqliteValue$2[]): SqliteRunResult$2;
|
|
18
|
-
all<T = Record<string, unknown>>(...params: SqliteValue$2[]): T[];
|
|
19
|
-
get<T = Record<string, unknown>>(...params: SqliteValue$2[]): T | undefined;
|
|
20
|
-
}
|
|
21
|
-
/**
|
|
22
|
-
* Sync SQLite client port owned by Mockingbird.
|
|
23
|
-
*
|
|
24
|
-
* Duck-typed so `@crvouga/mockingbird-service-sqlite` `Database`, better-sqlite3, and wrapped
|
|
25
|
-
* `bun:sqlite` instances all work when they expose this surface.
|
|
26
|
-
*/
|
|
27
|
-
interface SqliteClient$2 {
|
|
28
|
-
exec(sql: string): void;
|
|
29
|
-
prepare(sql: string): SqliteStatement$2;
|
|
30
|
-
transaction<T>(fn: () => T): T;
|
|
31
|
-
}
|
|
32
14
|
|
|
33
15
|
/** A stable identifier for a point in a {@link Timeline}. */
|
|
34
16
|
type CheckpointId$1 = string;
|
|
@@ -119,6 +101,37 @@ declare class Timeline$1<T> {
|
|
|
119
101
|
interface FetchAPI$2 {
|
|
120
102
|
fetch(request: Request): Promise<Response>;
|
|
121
103
|
}
|
|
104
|
+
/** A bare function form of {@link FetchAPI}, compatible with `Bun.serve`, workerd, and Deno. */
|
|
105
|
+
type FetchHandler$1 = (request: Request) => Promise<Response>;
|
|
106
|
+
|
|
107
|
+
/** Bind values accepted by Mockingbird's SQLite port (matches sqlite-mem / better-sqlite3). */
|
|
108
|
+
type SqliteValue$2 = null | number | bigint | string | Uint8Array | boolean;
|
|
109
|
+
/** Mutation counters returned by {@link SqliteStatement.run}. */
|
|
110
|
+
type SqliteRunResult$2 = {
|
|
111
|
+
changes: number;
|
|
112
|
+
lastInsertRowid: number | bigint;
|
|
113
|
+
};
|
|
114
|
+
/**
|
|
115
|
+
* Prepared statement bound to a {@link SqliteClient}.
|
|
116
|
+
*
|
|
117
|
+
* Pass bind values as rest arguments on each call (no sticky `bind()`).
|
|
118
|
+
*/
|
|
119
|
+
interface SqliteStatement$2 {
|
|
120
|
+
run(...params: SqliteValue$2[]): SqliteRunResult$2;
|
|
121
|
+
all<T = Record<string, unknown>>(...params: SqliteValue$2[]): T[];
|
|
122
|
+
get<T = Record<string, unknown>>(...params: SqliteValue$2[]): T | undefined;
|
|
123
|
+
}
|
|
124
|
+
/**
|
|
125
|
+
* Sync SQLite client port owned by Mockingbird.
|
|
126
|
+
*
|
|
127
|
+
* Duck-typed so `@crvouga/mockingbird-service-sqlite` `Database`, better-sqlite3, and wrapped
|
|
128
|
+
* `bun:sqlite` instances all work when they expose this surface.
|
|
129
|
+
*/
|
|
130
|
+
interface SqliteClient$2 {
|
|
131
|
+
exec(sql: string): void;
|
|
132
|
+
prepare(sql: string): SqliteStatement$2;
|
|
133
|
+
transaction<T>(fn: () => T): T;
|
|
134
|
+
}
|
|
122
135
|
|
|
123
136
|
/**
|
|
124
137
|
* The single source of time for a service.
|
|
@@ -132,7 +145,7 @@ type ClockState$1 = {
|
|
|
132
145
|
now: number;
|
|
133
146
|
/** True while time does not advance on its own. */
|
|
134
147
|
frozen: boolean;
|
|
135
|
-
/** Milliseconds
|
|
148
|
+
/** Milliseconds a running clock adds to its underlying source. `0` while frozen. */
|
|
136
149
|
offsetMs: number;
|
|
137
150
|
};
|
|
138
151
|
type Clock$1 = {
|
|
@@ -168,7 +181,10 @@ type Rng$1 = {
|
|
|
168
181
|
state(): number;
|
|
169
182
|
/** Restore a state previously returned by {@link state}. */
|
|
170
183
|
setState(state: number): void;
|
|
171
|
-
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;
|
|
172
188
|
};
|
|
173
189
|
|
|
174
190
|
/**
|
|
@@ -177,44 +193,83 @@ type Rng$1 = {
|
|
|
177
193
|
* This is how a suite reaches the vendor's failure modes without the vendor: the
|
|
178
194
|
* quota error that only appears when a shared sandbox is full, the 429 that only
|
|
179
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`).
|
|
180
200
|
*/
|
|
181
201
|
type FaultRule$1 = {
|
|
182
|
-
/** 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. */
|
|
183
203
|
id: string;
|
|
184
204
|
/** Fault only this operation. Omit to match every operation. */
|
|
185
205
|
operationId?: string;
|
|
186
206
|
/** Fault only this HTTP method, case-insensitive. Omit to match every method. */
|
|
187
207
|
method?: string;
|
|
208
|
+
/** Fault only this exact path. */
|
|
209
|
+
path?: string;
|
|
188
210
|
/** Fault only paths starting with this prefix. Omit to match every path. */
|
|
189
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>;
|
|
190
218
|
/**
|
|
191
219
|
* Fault only this namespace. Omit (or `"*"`) to fault every namespace — which is what
|
|
192
220
|
* an in-process caller usually wants, and what a parallel worker usually does not:
|
|
193
221
|
* rules added through `POST /__admin/faults` default to the calling namespace.
|
|
194
222
|
*/
|
|
195
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;
|
|
196
232
|
/**
|
|
197
|
-
*
|
|
198
|
-
*
|
|
199
|
-
|
|
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;
|
|
239
|
+
/**
|
|
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.
|
|
200
242
|
*/
|
|
201
243
|
status?: number;
|
|
202
244
|
/** Response body, serialized as JSON. A string is sent as-is. */
|
|
203
245
|
body?: unknown;
|
|
246
|
+
/** Response headers. */
|
|
204
247
|
headers?: Record<string, string>;
|
|
205
|
-
/**
|
|
206
|
-
|
|
207
|
-
/**
|
|
208
|
-
rate?: number;
|
|
209
|
-
/** 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. */
|
|
210
251
|
delayMs?: number;
|
|
211
252
|
/** Alias of `delayMs`. */
|
|
212
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;
|
|
213
263
|
/**
|
|
214
264
|
* Drop the connection instead of answering: an in-process `fetch` rejects with a
|
|
215
265
|
* `TypeError`, and a served mock destroys the socket. Models "unknown outcome" failures.
|
|
216
266
|
*/
|
|
217
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;
|
|
218
273
|
/**
|
|
219
274
|
* A named service behaviour to switch on for the matching request instead of (or
|
|
220
275
|
* before) a canned response, e.g. `created_but_500` or `numeric_tracking_id`. Services
|
|
@@ -223,8 +278,8 @@ type FaultRule$1 = {
|
|
|
223
278
|
effect?: string;
|
|
224
279
|
/** Parameters for `effect`. */
|
|
225
280
|
params?: Record<string, unknown>;
|
|
226
|
-
/**
|
|
227
|
-
|
|
281
|
+
/** The preset this rule was expanded from, if any. */
|
|
282
|
+
fromPreset?: string;
|
|
228
283
|
};
|
|
229
284
|
/** A fault that fired for one request. */
|
|
230
285
|
type FaultHit$1 = {
|
|
@@ -232,6 +287,10 @@ type FaultHit$1 = {
|
|
|
232
287
|
/** The injected response; absent when the rule only delays, drops, or sets an effect. */
|
|
233
288
|
response?: Response;
|
|
234
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;
|
|
235
294
|
effect?: {
|
|
236
295
|
name: string;
|
|
237
296
|
params: Record<string, unknown>;
|
|
@@ -243,38 +302,200 @@ type FaultCandidate$1 = {
|
|
|
243
302
|
method: string;
|
|
244
303
|
path: string;
|
|
245
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;
|
|
246
333
|
};
|
|
247
334
|
type FaultRegistry$1 = {
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
rules: (FaultRule$1 & {
|
|
251
|
-
remaining: number | null;
|
|
252
|
-
hits: number;
|
|
253
|
-
position: number;
|
|
254
|
-
})[];
|
|
255
|
-
rngState: number;
|
|
256
|
-
};
|
|
335
|
+
snapshot(namespace: string): FaultSnapshot$1;
|
|
336
|
+
/** Add a rule, or replace the rule with the same id in the same namespace. */
|
|
257
337
|
add(rule: FaultRule$1): FaultRule$1;
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
})[];
|
|
270
|
-
rngState: number;
|
|
271
|
-
}): 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;
|
|
272
349
|
/**
|
|
273
350
|
* Every fault this request should get, in rule order, stopping at the first that answers
|
|
274
351
|
* or drops (effect-only and delay-only rules let later rules match too). Consumes one of
|
|
275
352
|
* each matching rule's remaining uses.
|
|
276
353
|
*/
|
|
277
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;
|
|
278
499
|
};
|
|
279
500
|
|
|
280
501
|
/**
|
|
@@ -314,6 +535,8 @@ type RequestLog$1 = {
|
|
|
314
535
|
unmatched: boolean;
|
|
315
536
|
/** Set when a fault rule produced the response. */
|
|
316
537
|
faultId?: string;
|
|
538
|
+
/** Milliseconds of injected wait: latency, fault delays and timeouts. Absent when none. */
|
|
539
|
+
delayMs?: number;
|
|
317
540
|
/** Resource ids the handler touched (`userId`, `orderId`, …), when the service reports them. */
|
|
318
541
|
ids?: Record<string, string>;
|
|
319
542
|
/** Set when the service created a resource the request referred to but that did not exist. */
|
|
@@ -359,6 +582,12 @@ type JournalQuery$1 = {
|
|
|
359
582
|
/** Only this namespace. Omit for every namespace, oldest first across all of them. */
|
|
360
583
|
namespace?: string;
|
|
361
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;
|
|
362
591
|
status?: number;
|
|
363
592
|
/** Only entries at or after this instant (epoch ms). */
|
|
364
593
|
since?: number;
|
|
@@ -373,6 +602,50 @@ type Journal$1 = {
|
|
|
373
602
|
clear(namespace?: string): void;
|
|
374
603
|
};
|
|
375
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
|
+
|
|
376
649
|
/** Credential → namespace mapping behind `PUT /__admin/credentials`. */
|
|
377
650
|
type CredentialRegistry$1 = {
|
|
378
651
|
set(credential: string, namespace: string): void;
|
|
@@ -527,7 +800,10 @@ type ServiceInstance$1 = FetchAPI$2 & {
|
|
|
527
800
|
};
|
|
528
801
|
type ServiceTimelineState$1 = Readonly<{
|
|
529
802
|
snapshot: NamespaceSnapshot$1;
|
|
530
|
-
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
|
+
}>;
|
|
531
807
|
rngState: number;
|
|
532
808
|
}>;
|
|
533
809
|
type ServiceCheckpoint$1 = Checkpoint$1<ServiceTimelineState$1>;
|
|
@@ -535,17 +811,23 @@ type ServiceRuntime$1<T extends ServiceInstance$1> = FetchAPI$2 & {
|
|
|
535
811
|
/** Stop package-owned lifecycle timers when a supervisor closes the runtime. */
|
|
536
812
|
stop?(): void;
|
|
537
813
|
readonly name: string;
|
|
814
|
+
/** Same-origin Fetch handler and App Router method exports, sharing this runtime. */
|
|
815
|
+
mount(prefix: string): MountedAPI$1;
|
|
538
816
|
readonly sqlite: SqliteClient$2;
|
|
539
817
|
readonly clock: Clock$1;
|
|
540
818
|
readonly faults: FaultRegistry$1;
|
|
819
|
+
/** Baseline response time per namespace. */
|
|
820
|
+
readonly latency: LatencyRegistry$1;
|
|
541
821
|
readonly metrics: Metrics$1;
|
|
542
822
|
readonly journal: Journal$1;
|
|
543
823
|
readonly rng: Rng$1;
|
|
544
824
|
readonly credentials: CredentialRegistry$1;
|
|
545
825
|
/** The webhook hub, when the service has outbound webhooks. */
|
|
546
826
|
readonly webhooks: WebhookHub$1 | undefined;
|
|
547
|
-
/**
|
|
548
|
-
|
|
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
|
+
*/
|
|
549
831
|
namespaceClock(namespace?: string): Clock$1;
|
|
550
832
|
namespaceOf(request: Request): string;
|
|
551
833
|
/** Opaque in-process checkpoint including records, controls and webhook history. */
|
|
@@ -557,8 +839,38 @@ type ServiceRuntime$1<T extends ServiceInstance$1> = FetchAPI$2 & {
|
|
|
557
839
|
instance(namespace?: string): T;
|
|
558
840
|
/** Public names of every namespace created so far. */
|
|
559
841
|
namespaces(): string[];
|
|
560
|
-
/**
|
|
842
|
+
/** Return one namespace to its boot state, or every namespace with `"*"`. */
|
|
561
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>;
|
|
562
874
|
snapshot(namespace?: string): NamespaceSnapshot$1;
|
|
563
875
|
restore(snapshot: NamespaceSnapshot$1, namespace?: string): void;
|
|
564
876
|
/** Capture the current branch. Mutating HTTP calls do this automatically. */
|
|
@@ -601,6 +913,11 @@ type CommonServeOptions = {
|
|
|
601
913
|
adminKey: string | undefined;
|
|
602
914
|
seed: string | undefined;
|
|
603
915
|
onLog: ((entry: RequestLog$1) => void) | undefined;
|
|
916
|
+
/** Admin controls to boot with: clock, latency, faults, a starting snapshot. */
|
|
917
|
+
adminControls?: MockControls$1;
|
|
918
|
+
/** Synthetic provider fixture objects supplied by a fleet entry. */
|
|
919
|
+
fixtures?: Record<string, unknown>;
|
|
920
|
+
baseUrl?: string;
|
|
604
921
|
};
|
|
605
922
|
/**
|
|
606
923
|
* What a service contributes to `serve`: how to build its runtime from CLI flags,
|
|
@@ -619,88 +936,16 @@ type ServeTarget = {
|
|
|
619
936
|
listening?(server: Listening): void;
|
|
620
937
|
};
|
|
621
938
|
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
939
|
+
type MountedAPI = FetchAPI$1 & {
|
|
940
|
+
readonly prefix: string;
|
|
941
|
+
GET: FetchHandler;
|
|
942
|
+
POST: FetchHandler;
|
|
943
|
+
PUT: FetchHandler;
|
|
944
|
+
PATCH: FetchHandler;
|
|
945
|
+
DELETE: FetchHandler;
|
|
946
|
+
HEAD: FetchHandler;
|
|
947
|
+
OPTIONS: FetchHandler;
|
|
628
948
|
};
|
|
629
|
-
/**
|
|
630
|
-
* Prepared statement bound to a {@link SqliteClient}.
|
|
631
|
-
*
|
|
632
|
-
* Pass bind values as rest arguments on each call (no sticky `bind()`).
|
|
633
|
-
*/
|
|
634
|
-
interface SqliteStatement$1 {
|
|
635
|
-
run(...params: SqliteValue$1[]): SqliteRunResult$1;
|
|
636
|
-
all<T = Record<string, unknown>>(...params: SqliteValue$1[]): T[];
|
|
637
|
-
get<T = Record<string, unknown>>(...params: SqliteValue$1[]): T | undefined;
|
|
638
|
-
}
|
|
639
|
-
/**
|
|
640
|
-
* Sync SQLite client port owned by Mockingbird.
|
|
641
|
-
*
|
|
642
|
-
* Duck-typed so `@crvouga/mockingbird-service-sqlite` `Database`, better-sqlite3, and wrapped
|
|
643
|
-
* `bun:sqlite` instances all work when they expose this surface.
|
|
644
|
-
*/
|
|
645
|
-
interface SqliteClient$1 {
|
|
646
|
-
exec(sql: string): void;
|
|
647
|
-
prepare(sql: string): SqliteStatement$1;
|
|
648
|
-
transaction<T>(fn: () => T): T;
|
|
649
|
-
}
|
|
650
|
-
|
|
651
|
-
/** Every stored record carries a monotonically increasing sequence for stable ordering. */
|
|
652
|
-
type Stored<T> = {
|
|
653
|
-
seq: number;
|
|
654
|
-
value: T;
|
|
655
|
-
};
|
|
656
|
-
type ListRecordsOptions<T> = {
|
|
657
|
-
/** Keep only records passing the predicate. */
|
|
658
|
-
where?: (value: T, seq: number) => boolean;
|
|
659
|
-
/** Sort order; default newest first. */
|
|
660
|
-
order?: "newest" | "oldest";
|
|
661
|
-
};
|
|
662
|
-
/**
|
|
663
|
-
* A SQLite-backed table of JSON records addressed by id. Ordering is by insertion
|
|
664
|
-
* sequence, never by id lexicographic order, so list semantics stay stable.
|
|
665
|
-
*/
|
|
666
|
-
declare class Collection<T> {
|
|
667
|
-
private readonly sqlite;
|
|
668
|
-
/** Storage namespace. Admin introspection uses this to ignore another namespace's tables. */
|
|
669
|
-
readonly namespace: string;
|
|
670
|
-
/** Table name inside the namespace. Stable across resets of the rows themselves. */
|
|
671
|
-
readonly collectionName: string;
|
|
672
|
-
constructor(sqlite: SqliteClient$1,
|
|
673
|
-
/** Storage namespace. Admin introspection uses this to ignore another namespace's tables. */
|
|
674
|
-
namespace: string,
|
|
675
|
-
/** Table name inside the namespace. Stable across resets of the rows themselves. */
|
|
676
|
-
collectionName: string);
|
|
677
|
-
private bumpCollectionSeq;
|
|
678
|
-
nextSequence(): number;
|
|
679
|
-
get(id: string): T | undefined;
|
|
680
|
-
has(id: string): boolean;
|
|
681
|
-
/** Insert a new record, assigning it the next sequence number. */
|
|
682
|
-
insert(id: string, value: T): Stored<T>;
|
|
683
|
-
/** Replace an existing record's value, keeping its position. */
|
|
684
|
-
update(id: string, value: T): Stored<T> | undefined;
|
|
685
|
-
delete(id: string): boolean;
|
|
686
|
-
/** How many records the collection holds, without reading them. */
|
|
687
|
-
count(): number;
|
|
688
|
-
list(options?: ListRecordsOptions<T>): Array<Stored<T> & {
|
|
689
|
-
id: string;
|
|
690
|
-
}>;
|
|
691
|
-
}
|
|
692
|
-
|
|
693
|
-
/**
|
|
694
|
-
* Sequential id source persisted in SQLite. Ids are deterministic for a given
|
|
695
|
-
* sequence history (`cus_` + 14 opaque chars), so reproductions stay stable.
|
|
696
|
-
*/
|
|
697
|
-
declare class IdSequence {
|
|
698
|
-
private readonly sqlite;
|
|
699
|
-
private readonly namespace;
|
|
700
|
-
private readonly salt;
|
|
701
|
-
constructor(sqlite: SqliteClient$1, namespace: string, salt?: string);
|
|
702
|
-
next(prefix: string, length?: number): string;
|
|
703
|
-
}
|
|
704
949
|
|
|
705
950
|
/** A stable identifier for a point in a {@link Timeline}. */
|
|
706
951
|
type CheckpointId = string;
|
|
@@ -791,6 +1036,91 @@ declare class Timeline<T> {
|
|
|
791
1036
|
interface FetchAPI$1 {
|
|
792
1037
|
fetch(request: Request): Promise<Response>;
|
|
793
1038
|
}
|
|
1039
|
+
/** A bare function form of {@link FetchAPI}, compatible with `Bun.serve`, workerd, and Deno. */
|
|
1040
|
+
type FetchHandler = (request: Request) => Promise<Response>;
|
|
1041
|
+
|
|
1042
|
+
/** Bind values accepted by Mockingbird's SQLite port (matches sqlite-mem / better-sqlite3). */
|
|
1043
|
+
type SqliteValue$1 = null | number | bigint | string | Uint8Array | boolean;
|
|
1044
|
+
/** Mutation counters returned by {@link SqliteStatement.run}. */
|
|
1045
|
+
type SqliteRunResult$1 = {
|
|
1046
|
+
changes: number;
|
|
1047
|
+
lastInsertRowid: number | bigint;
|
|
1048
|
+
};
|
|
1049
|
+
/**
|
|
1050
|
+
* Prepared statement bound to a {@link SqliteClient}.
|
|
1051
|
+
*
|
|
1052
|
+
* Pass bind values as rest arguments on each call (no sticky `bind()`).
|
|
1053
|
+
*/
|
|
1054
|
+
interface SqliteStatement$1 {
|
|
1055
|
+
run(...params: SqliteValue$1[]): SqliteRunResult$1;
|
|
1056
|
+
all<T = Record<string, unknown>>(...params: SqliteValue$1[]): T[];
|
|
1057
|
+
get<T = Record<string, unknown>>(...params: SqliteValue$1[]): T | undefined;
|
|
1058
|
+
}
|
|
1059
|
+
/**
|
|
1060
|
+
* Sync SQLite client port owned by Mockingbird.
|
|
1061
|
+
*
|
|
1062
|
+
* Duck-typed so `@crvouga/mockingbird-service-sqlite` `Database`, better-sqlite3, and wrapped
|
|
1063
|
+
* `bun:sqlite` instances all work when they expose this surface.
|
|
1064
|
+
*/
|
|
1065
|
+
interface SqliteClient$1 {
|
|
1066
|
+
exec(sql: string): void;
|
|
1067
|
+
prepare(sql: string): SqliteStatement$1;
|
|
1068
|
+
transaction<T>(fn: () => T): T;
|
|
1069
|
+
}
|
|
1070
|
+
|
|
1071
|
+
/** Every stored record carries a monotonically increasing sequence for stable ordering. */
|
|
1072
|
+
type Stored<T> = {
|
|
1073
|
+
seq: number;
|
|
1074
|
+
value: T;
|
|
1075
|
+
};
|
|
1076
|
+
type ListRecordsOptions<T> = {
|
|
1077
|
+
/** Keep only records passing the predicate. */
|
|
1078
|
+
where?: (value: T, seq: number) => boolean;
|
|
1079
|
+
/** Sort order; default newest first. */
|
|
1080
|
+
order?: "newest" | "oldest";
|
|
1081
|
+
};
|
|
1082
|
+
/**
|
|
1083
|
+
* A SQLite-backed table of JSON records addressed by id. Ordering is by insertion
|
|
1084
|
+
* sequence, never by id lexicographic order, so list semantics stay stable.
|
|
1085
|
+
*/
|
|
1086
|
+
declare class Collection<T> {
|
|
1087
|
+
private readonly sqlite;
|
|
1088
|
+
/** Storage namespace. Admin introspection uses this to ignore another namespace's tables. */
|
|
1089
|
+
readonly namespace: string;
|
|
1090
|
+
/** Table name inside the namespace. Stable across resets of the rows themselves. */
|
|
1091
|
+
readonly collectionName: string;
|
|
1092
|
+
constructor(sqlite: SqliteClient$1,
|
|
1093
|
+
/** Storage namespace. Admin introspection uses this to ignore another namespace's tables. */
|
|
1094
|
+
namespace: string,
|
|
1095
|
+
/** Table name inside the namespace. Stable across resets of the rows themselves. */
|
|
1096
|
+
collectionName: string);
|
|
1097
|
+
private bumpCollectionSeq;
|
|
1098
|
+
nextSequence(): number;
|
|
1099
|
+
get(id: string): T | undefined;
|
|
1100
|
+
has(id: string): boolean;
|
|
1101
|
+
/** Insert a new record, assigning it the next sequence number. */
|
|
1102
|
+
insert(id: string, value: T): Stored<T>;
|
|
1103
|
+
/** Replace an existing record's value, keeping its position. */
|
|
1104
|
+
update(id: string, value: T): Stored<T> | undefined;
|
|
1105
|
+
delete(id: string): boolean;
|
|
1106
|
+
/** How many records the collection holds, without reading them. */
|
|
1107
|
+
count(): number;
|
|
1108
|
+
list(options?: ListRecordsOptions<T>): Array<Stored<T> & {
|
|
1109
|
+
id: string;
|
|
1110
|
+
}>;
|
|
1111
|
+
}
|
|
1112
|
+
|
|
1113
|
+
/**
|
|
1114
|
+
* Sequential id source persisted in SQLite. Ids are deterministic for a given
|
|
1115
|
+
* sequence history (`cus_` + 14 opaque chars), so reproductions stay stable.
|
|
1116
|
+
*/
|
|
1117
|
+
declare class IdSequence {
|
|
1118
|
+
private readonly sqlite;
|
|
1119
|
+
private readonly namespace;
|
|
1120
|
+
private readonly salt;
|
|
1121
|
+
constructor(sqlite: SqliteClient$1, namespace: string, salt?: string);
|
|
1122
|
+
next(prefix: string, length?: number): string;
|
|
1123
|
+
}
|
|
794
1124
|
|
|
795
1125
|
/** Options every provider constructor accepts. */
|
|
796
1126
|
type APIOptions = {
|
|
@@ -817,7 +1147,7 @@ type ClockState = {
|
|
|
817
1147
|
now: number;
|
|
818
1148
|
/** True while time does not advance on its own. */
|
|
819
1149
|
frozen: boolean;
|
|
820
|
-
/** Milliseconds
|
|
1150
|
+
/** Milliseconds a running clock adds to its underlying source. `0` while frozen. */
|
|
821
1151
|
offsetMs: number;
|
|
822
1152
|
};
|
|
823
1153
|
type Clock = {
|
|
@@ -853,7 +1183,10 @@ type Rng = {
|
|
|
853
1183
|
state(): number;
|
|
854
1184
|
/** Restore a state previously returned by {@link state}. */
|
|
855
1185
|
setState(state: number): void;
|
|
856
|
-
seed
|
|
1186
|
+
/** Restart the stream from a new seed. `reset` then returns to this seed. */
|
|
1187
|
+
reseed(seed: number | string): void;
|
|
1188
|
+
/** The seed the stream currently starts from. */
|
|
1189
|
+
readonly seed: number;
|
|
857
1190
|
};
|
|
858
1191
|
|
|
859
1192
|
/**
|
|
@@ -862,44 +1195,83 @@ type Rng = {
|
|
|
862
1195
|
* This is how a suite reaches the vendor's failure modes without the vendor: the
|
|
863
1196
|
* quota error that only appears when a shared sandbox is full, the 429 that only
|
|
864
1197
|
* appears under load, the 5xx that proves a retry path works.
|
|
1198
|
+
*
|
|
1199
|
+
* A rule has three parts. What it **matches** (`operationId`, `method`, `path`, …), **when**
|
|
1200
|
+
* it fires among the matching requests (`after`, `every`, `count`, `rate`, `from`, `until`),
|
|
1201
|
+
* and what it **does** (`status`, `delay`, `timeout`, `drop`, `truncate`, `effect`).
|
|
865
1202
|
*/
|
|
866
1203
|
type FaultRule = {
|
|
867
|
-
/** Stable id, so a suite can retire exactly the rule it added. */
|
|
1204
|
+
/** Stable id, so a suite can retire exactly the rule it added. Unique within a namespace. */
|
|
868
1205
|
id: string;
|
|
869
1206
|
/** Fault only this operation. Omit to match every operation. */
|
|
870
1207
|
operationId?: string;
|
|
871
1208
|
/** Fault only this HTTP method, case-insensitive. Omit to match every method. */
|
|
872
1209
|
method?: string;
|
|
1210
|
+
/** Fault only this exact path. */
|
|
1211
|
+
path?: string;
|
|
873
1212
|
/** Fault only paths starting with this prefix. Omit to match every path. */
|
|
874
1213
|
pathPrefix?: string;
|
|
1214
|
+
/** Fault only paths matching this regular expression (JavaScript syntax, unanchored). */
|
|
1215
|
+
pathPattern?: string;
|
|
1216
|
+
/** Fault only requests carrying these headers. `"*"` matches any value. */
|
|
1217
|
+
requestHeaders?: Record<string, string>;
|
|
1218
|
+
/** Fault only requests carrying these query parameters. `"*"` matches any value. */
|
|
1219
|
+
query?: Record<string, string>;
|
|
875
1220
|
/**
|
|
876
1221
|
* Fault only this namespace. Omit (or `"*"`) to fault every namespace — which is what
|
|
877
1222
|
* an in-process caller usually wants, and what a parallel worker usually does not:
|
|
878
1223
|
* rules added through `POST /__admin/faults` default to the calling namespace.
|
|
879
1224
|
*/
|
|
880
1225
|
namespace?: string;
|
|
1226
|
+
/** Let this many matching requests through first. */
|
|
1227
|
+
after?: number;
|
|
1228
|
+
/** Then fault only every nth matching request: `3` faults the 3rd, 6th, 9th. */
|
|
1229
|
+
every?: number;
|
|
1230
|
+
/** Retire the rule after this many faults. Omit to keep it until removed. */
|
|
1231
|
+
count?: number;
|
|
1232
|
+
/** Fault this fraction of the remaining requests, `0`–`1`, drawn from the seed. Default `1`. */
|
|
1233
|
+
rate?: number;
|
|
881
1234
|
/**
|
|
882
|
-
*
|
|
883
|
-
*
|
|
884
|
-
|
|
1235
|
+
* Fault only from this instant on the namespace clock. A duration (`"5m"`) counts from the
|
|
1236
|
+
* clock when the rule was added. Listed as epoch ms.
|
|
1237
|
+
*/
|
|
1238
|
+
from?: Instant | Duration;
|
|
1239
|
+
/** Stop faulting at this instant on the namespace clock. A duration counts from when added. */
|
|
1240
|
+
until?: Instant | Duration;
|
|
1241
|
+
/**
|
|
1242
|
+
* Status of the injected response. Omit for a rule that only delays, times out, drops,
|
|
1243
|
+
* truncates, or switches on an `effect`: the request then still reaches the service.
|
|
885
1244
|
*/
|
|
886
1245
|
status?: number;
|
|
887
1246
|
/** Response body, serialized as JSON. A string is sent as-is. */
|
|
888
1247
|
body?: unknown;
|
|
1248
|
+
/** Response headers. */
|
|
889
1249
|
headers?: Record<string, string>;
|
|
890
|
-
/**
|
|
891
|
-
|
|
892
|
-
/**
|
|
893
|
-
rate?: number;
|
|
894
|
-
/** Hold the response back this long, to exercise timeouts. */
|
|
1250
|
+
/** Hold the response back this long. Listed as `delayMs`. */
|
|
1251
|
+
delay?: Duration;
|
|
1252
|
+
/** `delay`, in milliseconds. */
|
|
895
1253
|
delayMs?: number;
|
|
896
1254
|
/** Alias of `delayMs`. */
|
|
897
1255
|
latencyMs?: number;
|
|
1256
|
+
/** Extra seeded delay in `[0, jitter]`. Listed as `jitterMs`. */
|
|
1257
|
+
jitter?: Duration;
|
|
1258
|
+
jitterMs?: number;
|
|
1259
|
+
/**
|
|
1260
|
+
* Never answer: hold the request this long, then drop the connection. Listed as
|
|
1261
|
+
* `timeoutMs`. With virtual time the wait is spent on the mock clock.
|
|
1262
|
+
*/
|
|
1263
|
+
timeout?: Duration;
|
|
1264
|
+
timeoutMs?: number;
|
|
898
1265
|
/**
|
|
899
1266
|
* Drop the connection instead of answering: an in-process `fetch` rejects with a
|
|
900
1267
|
* `TypeError`, and a served mock destroys the socket. Models "unknown outcome" failures.
|
|
901
1268
|
*/
|
|
902
1269
|
drop?: boolean;
|
|
1270
|
+
/**
|
|
1271
|
+
* Cut the response body off after this many bytes: the status and headers arrive, then
|
|
1272
|
+
* the connection dies mid-body.
|
|
1273
|
+
*/
|
|
1274
|
+
truncate?: number;
|
|
903
1275
|
/**
|
|
904
1276
|
* A named service behaviour to switch on for the matching request instead of (or
|
|
905
1277
|
* before) a canned response, e.g. `created_but_500` or `numeric_tracking_id`. Services
|
|
@@ -908,8 +1280,8 @@ type FaultRule = {
|
|
|
908
1280
|
effect?: string;
|
|
909
1281
|
/** Parameters for `effect`. */
|
|
910
1282
|
params?: Record<string, unknown>;
|
|
911
|
-
/**
|
|
912
|
-
|
|
1283
|
+
/** The preset this rule was expanded from, if any. */
|
|
1284
|
+
fromPreset?: string;
|
|
913
1285
|
};
|
|
914
1286
|
/** A fault that fired for one request. */
|
|
915
1287
|
type FaultHit = {
|
|
@@ -917,6 +1289,10 @@ type FaultHit = {
|
|
|
917
1289
|
/** The injected response; absent when the rule only delays, drops, or sets an effect. */
|
|
918
1290
|
response?: Response;
|
|
919
1291
|
drop?: boolean;
|
|
1292
|
+
/** Set with `drop` when the rule held the request for its `timeout` first. */
|
|
1293
|
+
timeout?: boolean;
|
|
1294
|
+
/** Bytes of response body to let through before the connection dies. */
|
|
1295
|
+
truncate?: number;
|
|
920
1296
|
effect?: {
|
|
921
1297
|
name: string;
|
|
922
1298
|
params: Record<string, unknown>;
|
|
@@ -928,38 +1304,200 @@ type FaultCandidate = {
|
|
|
928
1304
|
method: string;
|
|
929
1305
|
path: string;
|
|
930
1306
|
namespace: string;
|
|
1307
|
+
/** Request headers and query, for rules that match on them. */
|
|
1308
|
+
headers?: Headers;
|
|
1309
|
+
query?: URLSearchParams;
|
|
1310
|
+
/** The namespace clock, for `from` / `until`. Rules with a window are skipped without it. */
|
|
1311
|
+
now?: number;
|
|
1312
|
+
/** How to spend a delay for this request. Default: the registry's own sleep. */
|
|
1313
|
+
wait?: (ms: number) => Promise<void>;
|
|
1314
|
+
};
|
|
1315
|
+
/** A stored rule and how often it was consulted. */
|
|
1316
|
+
type FaultListing = FaultRule & {
|
|
1317
|
+
/** Faults left before the rule retires. `null` when it has no `count`. */
|
|
1318
|
+
remaining: number | null;
|
|
1319
|
+
/** Times the rule faulted a request. */
|
|
1320
|
+
hits: number;
|
|
1321
|
+
/** Requests that matched the rule, faulted or not. */
|
|
1322
|
+
seen: number;
|
|
1323
|
+
};
|
|
1324
|
+
/** A namespace's own rules, with their counters, in the order they are tried. */
|
|
1325
|
+
type FaultSnapshot = {
|
|
1326
|
+
/**
|
|
1327
|
+
* `position` is how many `"*"` rules are tried before the rule, which is what its place
|
|
1328
|
+
* in the order means to a request and holds in any process.
|
|
1329
|
+
*/
|
|
1330
|
+
rules: (FaultListing & {
|
|
1331
|
+
position?: number;
|
|
1332
|
+
})[];
|
|
1333
|
+
/** How many `fault_<n>` ids the namespace has handed out. */
|
|
1334
|
+
nextId?: number;
|
|
931
1335
|
};
|
|
932
1336
|
type FaultRegistry = {
|
|
933
|
-
|
|
934
|
-
|
|
935
|
-
rules: (FaultRule & {
|
|
936
|
-
remaining: number | null;
|
|
937
|
-
hits: number;
|
|
938
|
-
position: number;
|
|
939
|
-
})[];
|
|
940
|
-
rngState: number;
|
|
941
|
-
};
|
|
1337
|
+
snapshot(namespace: string): FaultSnapshot;
|
|
1338
|
+
/** Add a rule, or replace the rule with the same id in the same namespace. */
|
|
942
1339
|
add(rule: FaultRule): FaultRule;
|
|
943
|
-
|
|
944
|
-
|
|
945
|
-
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
|
|
950
|
-
|
|
951
|
-
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
})[];
|
|
955
|
-
rngState: number;
|
|
956
|
-
}): void;
|
|
1340
|
+
/** The next unused `fault_<n>` id in `namespace`. */
|
|
1341
|
+
nextId(namespace: string): string;
|
|
1342
|
+
/** Every rule, or the rules a namespace's requests can hit: its own and the global ones. */
|
|
1343
|
+
list(namespace?: string): FaultListing[];
|
|
1344
|
+
get(id: string, namespace?: string): FaultListing | undefined;
|
|
1345
|
+
/** Remove a rule by id: from `namespace` (its own, then a global one), or wherever it is. */
|
|
1346
|
+
remove(id: string, namespace?: string): boolean;
|
|
1347
|
+
/** Remove every rule, or one namespace's own rules. */
|
|
1348
|
+
clear(namespace?: string): void;
|
|
1349
|
+
/** Replace a namespace's own rules with a snapshot's, wherever the snapshot was taken. */
|
|
1350
|
+
restore(namespace: string, state: FaultSnapshot): void;
|
|
957
1351
|
/**
|
|
958
1352
|
* Every fault this request should get, in rule order, stopping at the first that answers
|
|
959
1353
|
* or drops (effect-only and delay-only rules let later rules match too). Consumes one of
|
|
960
1354
|
* each matching rule's remaining uses.
|
|
961
1355
|
*/
|
|
962
1356
|
take(candidate: FaultCandidate): Promise<FaultHit[]>;
|
|
1357
|
+
/**
|
|
1358
|
+
* Fire these rules at one request without storing them: no matching, no schedule, in order,
|
|
1359
|
+
* stopping at the first that answers or drops. Jitter draws from the namespace's stream.
|
|
1360
|
+
*/
|
|
1361
|
+
fire(rules: readonly FaultRule[], candidate: FaultCandidate): Promise<FaultHit[]>;
|
|
1362
|
+
};
|
|
1363
|
+
|
|
1364
|
+
/**
|
|
1365
|
+
* The admin controls every mock shares, as one document.
|
|
1366
|
+
*
|
|
1367
|
+
* The same shape is accepted in three places, and means the same thing in each:
|
|
1368
|
+
*
|
|
1369
|
+
* - at boot: `createRuntime({ adminControls })`, `serve --admin-controls`,
|
|
1370
|
+
* `MOCKINGBIRD_ADMIN_CONTROLS`
|
|
1371
|
+
* - over HTTP: `PUT /__admin/controls`
|
|
1372
|
+
* - per request: the `x-mockingbird-*` headers in {@link CONTROL_HEADERS}
|
|
1373
|
+
*
|
|
1374
|
+
* Every control is deterministic: given the same seed, clock and requests, a mock answers
|
|
1375
|
+
* the same bytes. Nothing here reads the wall clock or `Math.random`.
|
|
1376
|
+
*/
|
|
1377
|
+
/** Milliseconds, or a string like `"250ms"`, `"2s"`, `"15m"`, `"1h"`, `"3d"`. */
|
|
1378
|
+
type Duration = number | string;
|
|
1379
|
+
/** Epoch milliseconds, or an ISO-8601 string. */
|
|
1380
|
+
type Instant = number | string;
|
|
1381
|
+
type ClockControls = {
|
|
1382
|
+
/** Move the clock to this instant. */
|
|
1383
|
+
now?: Instant;
|
|
1384
|
+
/** Stop time. A frozen clock moves only when told to, so timestamps replay exactly. */
|
|
1385
|
+
frozen?: boolean;
|
|
1386
|
+
/**
|
|
1387
|
+
* Step the clock forward by this much before every vendor request. With a frozen clock
|
|
1388
|
+
* each request still gets its own, reproducible timestamp.
|
|
1389
|
+
*/
|
|
1390
|
+
autoAdvance?: Duration;
|
|
1391
|
+
};
|
|
1392
|
+
/** How long a response takes: a fixed delay plus seeded jitter in `[0, jitter]`. */
|
|
1393
|
+
type LatencyRuleInput = {
|
|
1394
|
+
delay?: Duration;
|
|
1395
|
+
jitter?: Duration;
|
|
1396
|
+
};
|
|
1397
|
+
type LatencyControls = LatencyRuleInput & {
|
|
1398
|
+
/** Per-operation overrides, keyed by operationId. A bare duration is its `delay`. */
|
|
1399
|
+
operations?: Record<string, Duration | LatencyRuleInput>;
|
|
1400
|
+
};
|
|
1401
|
+
/** A fault to add: a rule (the id is assigned when omitted), or a named preset with overrides. */
|
|
1402
|
+
type FaultInput = (Omit<FaultRule, "id"> & {
|
|
1403
|
+
id?: string;
|
|
1404
|
+
}) | ({
|
|
1405
|
+
preset: string;
|
|
1406
|
+
} & Partial<FaultRule>);
|
|
1407
|
+
/** Identifies a {@link SnapshotDocument}. */
|
|
1408
|
+
declare const SNAPSHOT_FORMAT = "mockingbird.snapshot/v1";
|
|
1409
|
+
/**
|
|
1410
|
+
* A namespace, as portable JSON: what `GET /__admin/snapshots/:id` returns and what
|
|
1411
|
+
* `PUT /__admin/snapshots/:id` and the boot `snapshot` control accept. Only `format` and
|
|
1412
|
+
* `records` are required, so a hand-written seed file is a valid snapshot.
|
|
1413
|
+
*/
|
|
1414
|
+
type SnapshotDocument = {
|
|
1415
|
+
format: typeof SNAPSHOT_FORMAT;
|
|
1416
|
+
/** The service that wrote it. A snapshot is rejected by any other service. */
|
|
1417
|
+
service?: string;
|
|
1418
|
+
/**
|
|
1419
|
+
* Stored rows. `seq` orders a collection; omitted, rows keep their listed order. `raw` is
|
|
1420
|
+
* the stored text of a row that is not a plain record, and replaces `value` when present.
|
|
1421
|
+
*/
|
|
1422
|
+
records: {
|
|
1423
|
+
collection: string;
|
|
1424
|
+
id: string;
|
|
1425
|
+
seq?: number;
|
|
1426
|
+
value?: unknown;
|
|
1427
|
+
raw?: string;
|
|
1428
|
+
}[];
|
|
1429
|
+
/** Id counters, so the next generated id continues where the snapshot left off. */
|
|
1430
|
+
sequences?: {
|
|
1431
|
+
name: string;
|
|
1432
|
+
kind: string;
|
|
1433
|
+
value: number;
|
|
1434
|
+
}[];
|
|
1435
|
+
clock?: {
|
|
1436
|
+
now: number;
|
|
1437
|
+
frozen: boolean;
|
|
1438
|
+
autoAdvanceMs?: number;
|
|
1439
|
+
};
|
|
1440
|
+
seed?: number | string;
|
|
1441
|
+
/** Positions of the seeded random streams. */
|
|
1442
|
+
rng?: {
|
|
1443
|
+
state: number;
|
|
1444
|
+
faults?: number;
|
|
1445
|
+
latency?: number;
|
|
1446
|
+
};
|
|
1447
|
+
faults?: unknown;
|
|
1448
|
+
latency?: unknown;
|
|
1449
|
+
virtualTime?: boolean;
|
|
1450
|
+
};
|
|
1451
|
+
/** Controls for one namespace. */
|
|
1452
|
+
type NamespaceControls = {
|
|
1453
|
+
/** Seeds every random choice: fault rates, jitter, and whatever the service invents. */
|
|
1454
|
+
seed?: number | string;
|
|
1455
|
+
clock?: ClockControls;
|
|
1456
|
+
/**
|
|
1457
|
+
* Spend injected waits (latency, fault delays, timeouts) on the mock clock instead of the
|
|
1458
|
+
* wall clock: the request returns at once, the clock has moved, and the journal records
|
|
1459
|
+
* the wait exactly. Default `false`: waits are real, so a client's own timeout can fire.
|
|
1460
|
+
*/
|
|
1461
|
+
virtualTime?: boolean;
|
|
1462
|
+
/** Baseline response time for every vendor request. A bare duration is its `delay`. */
|
|
1463
|
+
latency?: Duration | LatencyControls;
|
|
1464
|
+
faults?: readonly FaultInput[];
|
|
1465
|
+
/** Start from this state instead of the service's own seed data. */
|
|
1466
|
+
snapshot?: SnapshotDocument;
|
|
1467
|
+
};
|
|
1468
|
+
/** {@link NamespaceControls} for every namespace, with per-namespace overrides. */
|
|
1469
|
+
type MockControls = NamespaceControls & {
|
|
1470
|
+
/** Vendor credential → namespace, for SDKs that cannot send a namespace header. */
|
|
1471
|
+
credentials?: Record<string, string>;
|
|
1472
|
+
/** Overrides for named namespaces. A key given here replaces the shared value. */
|
|
1473
|
+
namespaces?: Record<string, NamespaceControls>;
|
|
1474
|
+
};
|
|
1475
|
+
/** A latency rule in milliseconds. */
|
|
1476
|
+
type LatencyRule = {
|
|
1477
|
+
delayMs: number;
|
|
1478
|
+
jitterMs: number;
|
|
1479
|
+
};
|
|
1480
|
+
/** Baseline latency for a namespace, normalized. */
|
|
1481
|
+
type LatencyState = LatencyRule & {
|
|
1482
|
+
operations: Record<string, LatencyRule>;
|
|
1483
|
+
};
|
|
1484
|
+
/** What {@link controlHeaders} turns into request headers. */
|
|
1485
|
+
type ControlHeaderInput = {
|
|
1486
|
+
namespace?: string;
|
|
1487
|
+
adminKey?: string;
|
|
1488
|
+
branch?: string;
|
|
1489
|
+
at?: string;
|
|
1490
|
+
reset?: boolean;
|
|
1491
|
+
restore?: string;
|
|
1492
|
+
seed?: number | string;
|
|
1493
|
+
time?: Instant | Date;
|
|
1494
|
+
advance?: Duration;
|
|
1495
|
+
virtualTime?: boolean;
|
|
1496
|
+
delay?: Duration;
|
|
1497
|
+
timeout?: Duration;
|
|
1498
|
+
/** A status, `"drop"`, a preset name, or a fault rule. */
|
|
1499
|
+
fault?: number | string | Record<string, unknown>;
|
|
1500
|
+
snapshot?: string;
|
|
963
1501
|
};
|
|
964
1502
|
|
|
965
1503
|
/**
|
|
@@ -999,6 +1537,8 @@ type RequestLog = {
|
|
|
999
1537
|
unmatched: boolean;
|
|
1000
1538
|
/** Set when a fault rule produced the response. */
|
|
1001
1539
|
faultId?: string;
|
|
1540
|
+
/** Milliseconds of injected wait: latency, fault delays and timeouts. Absent when none. */
|
|
1541
|
+
delayMs?: number;
|
|
1002
1542
|
/** Resource ids the handler touched (`userId`, `orderId`, …), when the service reports them. */
|
|
1003
1543
|
ids?: Record<string, string>;
|
|
1004
1544
|
/** Set when the service created a resource the request referred to but that did not exist. */
|
|
@@ -1044,6 +1584,12 @@ type JournalQuery = {
|
|
|
1044
1584
|
/** Only this namespace. Omit for every namespace, oldest first across all of them. */
|
|
1045
1585
|
namespace?: string;
|
|
1046
1586
|
operationId?: string;
|
|
1587
|
+
/** Only this HTTP method, case-insensitive. */
|
|
1588
|
+
method?: string;
|
|
1589
|
+
/** Only this exact path. */
|
|
1590
|
+
path?: string;
|
|
1591
|
+
/** Only requests this fault rule answered or shaped. */
|
|
1592
|
+
faultId?: string;
|
|
1047
1593
|
status?: number;
|
|
1048
1594
|
/** Only entries at or after this instant (epoch ms). */
|
|
1049
1595
|
since?: number;
|
|
@@ -1058,6 +1604,50 @@ type Journal = {
|
|
|
1058
1604
|
clear(namespace?: string): void;
|
|
1059
1605
|
};
|
|
1060
1606
|
|
|
1607
|
+
/**
|
|
1608
|
+
* Baseline response time, per namespace: how long every vendor request takes before any
|
|
1609
|
+
* fault is considered. Jitter draws from a stream the caller owns, one per namespace and
|
|
1610
|
+
* separate from the fault stream, so adding latency never shifts which requests a `rate`
|
|
1611
|
+
* fault hits.
|
|
1612
|
+
*/
|
|
1613
|
+
type LatencyRegistry = {
|
|
1614
|
+
get(namespace: string): LatencyState;
|
|
1615
|
+
set(namespace: string, state: LatencyState): LatencyState;
|
|
1616
|
+
/** Remove one namespace's latency, or every namespace's. */
|
|
1617
|
+
clear(namespace?: string): void;
|
|
1618
|
+
/** Milliseconds this request waits. Draws jitter, so call it once per request. */
|
|
1619
|
+
take(namespace: string, operationId: string | undefined): number;
|
|
1620
|
+
};
|
|
1621
|
+
|
|
1622
|
+
/** Clock state as the admin API reports it. */
|
|
1623
|
+
type ControlClock = ClockState & {
|
|
1624
|
+
/** `now`, as ISO-8601. */
|
|
1625
|
+
iso: string;
|
|
1626
|
+
/** Milliseconds the clock steps before every vendor request. */
|
|
1627
|
+
autoAdvanceMs: number;
|
|
1628
|
+
};
|
|
1629
|
+
/** One namespace's controls: the body of `GET /__admin/controls`. */
|
|
1630
|
+
type ControlState = {
|
|
1631
|
+
namespace: string;
|
|
1632
|
+
seed: number | string;
|
|
1633
|
+
clock: ControlClock;
|
|
1634
|
+
virtualTime: boolean;
|
|
1635
|
+
latency: LatencyState;
|
|
1636
|
+
faults: FaultListing[];
|
|
1637
|
+
};
|
|
1638
|
+
|
|
1639
|
+
/** What `GET /__admin/snapshots` lists for each snapshot. */
|
|
1640
|
+
type SnapshotInfo = {
|
|
1641
|
+
id: string;
|
|
1642
|
+
namespace: string;
|
|
1643
|
+
/** Stored rows in the snapshot. */
|
|
1644
|
+
records: number;
|
|
1645
|
+
/** The namespace clock when it was taken, epoch ms. */
|
|
1646
|
+
at: number;
|
|
1647
|
+
/** Whether `GET /snapshots/:id` can return it as a {@link SnapshotDocument}. */
|
|
1648
|
+
portable: boolean;
|
|
1649
|
+
};
|
|
1650
|
+
|
|
1061
1651
|
/** Credential → namespace mapping behind `PUT /__admin/credentials`. */
|
|
1062
1652
|
type CredentialRegistry = {
|
|
1063
1653
|
set(credential: string, namespace: string): void;
|
|
@@ -1212,7 +1802,10 @@ type ServiceInstance = FetchAPI$1 & {
|
|
|
1212
1802
|
};
|
|
1213
1803
|
type ServiceTimelineState = Readonly<{
|
|
1214
1804
|
snapshot: NamespaceSnapshot;
|
|
1215
|
-
clock
|
|
1805
|
+
/** `pinned`: the namespace's clock was frozen itself, not just following a frozen base. */
|
|
1806
|
+
clock: Readonly<ClockState & {
|
|
1807
|
+
pinned?: boolean;
|
|
1808
|
+
}>;
|
|
1216
1809
|
rngState: number;
|
|
1217
1810
|
}>;
|
|
1218
1811
|
type ServiceCheckpoint = Checkpoint<ServiceTimelineState>;
|
|
@@ -1220,17 +1813,23 @@ type ServiceRuntime<T extends ServiceInstance> = FetchAPI$1 & {
|
|
|
1220
1813
|
/** Stop package-owned lifecycle timers when a supervisor closes the runtime. */
|
|
1221
1814
|
stop?(): void;
|
|
1222
1815
|
readonly name: string;
|
|
1816
|
+
/** Same-origin Fetch handler and App Router method exports, sharing this runtime. */
|
|
1817
|
+
mount(prefix: string): MountedAPI;
|
|
1223
1818
|
readonly sqlite: SqliteClient$1;
|
|
1224
1819
|
readonly clock: Clock;
|
|
1225
1820
|
readonly faults: FaultRegistry;
|
|
1821
|
+
/** Baseline response time per namespace. */
|
|
1822
|
+
readonly latency: LatencyRegistry;
|
|
1226
1823
|
readonly metrics: Metrics;
|
|
1227
1824
|
readonly journal: Journal;
|
|
1228
1825
|
readonly rng: Rng;
|
|
1229
1826
|
readonly credentials: CredentialRegistry;
|
|
1230
1827
|
/** The webhook hub, when the service has outbound webhooks. */
|
|
1231
1828
|
readonly webhooks: WebhookHub | undefined;
|
|
1232
|
-
/**
|
|
1233
|
-
|
|
1829
|
+
/**
|
|
1830
|
+
* A namespace's clock. Each follows the base clock, {@link ServiceRuntime.clock}, with an
|
|
1831
|
+
* offset and a freeze of its own, so moving one never moves another.
|
|
1832
|
+
*/
|
|
1234
1833
|
namespaceClock(namespace?: string): Clock;
|
|
1235
1834
|
namespaceOf(request: Request): string;
|
|
1236
1835
|
/** Opaque in-process checkpoint including records, controls and webhook history. */
|
|
@@ -1242,8 +1841,38 @@ type ServiceRuntime<T extends ServiceInstance> = FetchAPI$1 & {
|
|
|
1242
1841
|
instance(namespace?: string): T;
|
|
1243
1842
|
/** Public names of every namespace created so far. */
|
|
1244
1843
|
namespaces(): string[];
|
|
1245
|
-
/**
|
|
1844
|
+
/** Return one namespace to its boot state, or every namespace with `"*"`. */
|
|
1246
1845
|
reset(namespace?: string): Promise<void>;
|
|
1846
|
+
/** Reset a namespace and forget it, releasing everything it held. */
|
|
1847
|
+
dropNamespace(namespace: string): Promise<void>;
|
|
1848
|
+
/** A namespace's controls: seed, clock, virtual time, latency, faults and snapshots. */
|
|
1849
|
+
controls(namespace?: string): ControlState & {
|
|
1850
|
+
snapshots: SnapshotInfo[];
|
|
1851
|
+
};
|
|
1852
|
+
/** Apply a control document to a namespace. A given key replaces that control. */
|
|
1853
|
+
configure(controls: NamespaceControls, namespace?: string): ControlState & {
|
|
1854
|
+
snapshots: SnapshotInfo[];
|
|
1855
|
+
};
|
|
1856
|
+
/** Named snapshots of a namespace: records, clock, random streams, faults and latency. */
|
|
1857
|
+
readonly snapshots: {
|
|
1858
|
+
/** Capture the namespace now. Reusing a name replaces that snapshot. */
|
|
1859
|
+
create(options?: {
|
|
1860
|
+
name?: string;
|
|
1861
|
+
namespace?: string;
|
|
1862
|
+
}): SnapshotInfo;
|
|
1863
|
+
list(namespace?: string): SnapshotInfo[];
|
|
1864
|
+
/** The snapshot as portable JSON, to commit beside a suite or boot another mock from. */
|
|
1865
|
+
export(id: string, namespace?: string): SnapshotDocument;
|
|
1866
|
+
/** Store a document as a snapshot without restoring it. */
|
|
1867
|
+
import(document: SnapshotDocument, options?: {
|
|
1868
|
+
name?: string;
|
|
1869
|
+
namespace?: string;
|
|
1870
|
+
}): SnapshotInfo;
|
|
1871
|
+
restore(id: string, namespace?: string): void;
|
|
1872
|
+
delete(id: string, namespace?: string): boolean;
|
|
1873
|
+
};
|
|
1874
|
+
/** Request headers that carry controls, checked: spread them into a `fetch` or an SDK's defaults. */
|
|
1875
|
+
headers(input: ControlHeaderInput): Record<string, string>;
|
|
1247
1876
|
snapshot(namespace?: string): NamespaceSnapshot;
|
|
1248
1877
|
restore(snapshot: NamespaceSnapshot, namespace?: string): void;
|
|
1249
1878
|
/** Capture the current branch. Mutating HTTP calls do this automatically. */
|
|
@@ -1430,6 +2059,8 @@ type PrismRuntimeOptions = {
|
|
|
1430
2059
|
seed?: number | string;
|
|
1431
2060
|
adminPrefix?: string;
|
|
1432
2061
|
adminKey?: string;
|
|
2062
|
+
/** Admin controls to boot with: clock, latency, faults, seed, a starting snapshot. */
|
|
2063
|
+
adminControls?: MockControls;
|
|
1433
2064
|
onLog?: (entry: RequestLog) => void;
|
|
1434
2065
|
settings?: Partial<Settings>;
|
|
1435
2066
|
/** Run auto-advance on this real-time interval (ms). The served mock uses 100 ms. */
|