@crvouga/mockingbird-service-formbricks 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 +22 -5
- package/dist/chunk-HE5W4CHW.js +6983 -0
- package/dist/chunk-HE5W4CHW.js.map +7 -0
- package/dist/{chunk-GW32FLZW.js → chunk-S7RQVW5Z.js} +139 -26
- package/dist/chunk-S7RQVW5Z.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-GW32FLZW.js.map +0 -7
- package/dist/chunk-XFJAPKX5.js +0 -5103
- package/dist/chunk-XFJAPKX5.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
|
type DecodedBody = {
|
|
796
1126
|
kind: "empty";
|
|
@@ -1051,7 +1381,7 @@ type ClockState = {
|
|
|
1051
1381
|
now: number;
|
|
1052
1382
|
/** True while time does not advance on its own. */
|
|
1053
1383
|
frozen: boolean;
|
|
1054
|
-
/** Milliseconds
|
|
1384
|
+
/** Milliseconds a running clock adds to its underlying source. `0` while frozen. */
|
|
1055
1385
|
offsetMs: number;
|
|
1056
1386
|
};
|
|
1057
1387
|
type Clock = {
|
|
@@ -1087,7 +1417,10 @@ type Rng = {
|
|
|
1087
1417
|
state(): number;
|
|
1088
1418
|
/** Restore a state previously returned by {@link state}. */
|
|
1089
1419
|
setState(state: number): void;
|
|
1090
|
-
seed
|
|
1420
|
+
/** Restart the stream from a new seed. `reset` then returns to this seed. */
|
|
1421
|
+
reseed(seed: number | string): void;
|
|
1422
|
+
/** The seed the stream currently starts from. */
|
|
1423
|
+
readonly seed: number;
|
|
1091
1424
|
};
|
|
1092
1425
|
|
|
1093
1426
|
/**
|
|
@@ -1096,44 +1429,83 @@ type Rng = {
|
|
|
1096
1429
|
* This is how a suite reaches the vendor's failure modes without the vendor: the
|
|
1097
1430
|
* quota error that only appears when a shared sandbox is full, the 429 that only
|
|
1098
1431
|
* appears under load, the 5xx that proves a retry path works.
|
|
1432
|
+
*
|
|
1433
|
+
* A rule has three parts. What it **matches** (`operationId`, `method`, `path`, …), **when**
|
|
1434
|
+
* it fires among the matching requests (`after`, `every`, `count`, `rate`, `from`, `until`),
|
|
1435
|
+
* and what it **does** (`status`, `delay`, `timeout`, `drop`, `truncate`, `effect`).
|
|
1099
1436
|
*/
|
|
1100
1437
|
type FaultRule = {
|
|
1101
|
-
/** Stable id, so a suite can retire exactly the rule it added. */
|
|
1438
|
+
/** Stable id, so a suite can retire exactly the rule it added. Unique within a namespace. */
|
|
1102
1439
|
id: string;
|
|
1103
1440
|
/** Fault only this operation. Omit to match every operation. */
|
|
1104
1441
|
operationId?: string;
|
|
1105
1442
|
/** Fault only this HTTP method, case-insensitive. Omit to match every method. */
|
|
1106
1443
|
method?: string;
|
|
1444
|
+
/** Fault only this exact path. */
|
|
1445
|
+
path?: string;
|
|
1107
1446
|
/** Fault only paths starting with this prefix. Omit to match every path. */
|
|
1108
1447
|
pathPrefix?: string;
|
|
1448
|
+
/** Fault only paths matching this regular expression (JavaScript syntax, unanchored). */
|
|
1449
|
+
pathPattern?: string;
|
|
1450
|
+
/** Fault only requests carrying these headers. `"*"` matches any value. */
|
|
1451
|
+
requestHeaders?: Record<string, string>;
|
|
1452
|
+
/** Fault only requests carrying these query parameters. `"*"` matches any value. */
|
|
1453
|
+
query?: Record<string, string>;
|
|
1109
1454
|
/**
|
|
1110
1455
|
* Fault only this namespace. Omit (or `"*"`) to fault every namespace — which is what
|
|
1111
1456
|
* an in-process caller usually wants, and what a parallel worker usually does not:
|
|
1112
1457
|
* rules added through `POST /__admin/faults` default to the calling namespace.
|
|
1113
1458
|
*/
|
|
1114
1459
|
namespace?: string;
|
|
1460
|
+
/** Let this many matching requests through first. */
|
|
1461
|
+
after?: number;
|
|
1462
|
+
/** Then fault only every nth matching request: `3` faults the 3rd, 6th, 9th. */
|
|
1463
|
+
every?: number;
|
|
1464
|
+
/** Retire the rule after this many faults. Omit to keep it until removed. */
|
|
1465
|
+
count?: number;
|
|
1466
|
+
/** Fault this fraction of the remaining requests, `0`–`1`, drawn from the seed. Default `1`. */
|
|
1467
|
+
rate?: number;
|
|
1115
1468
|
/**
|
|
1116
|
-
*
|
|
1117
|
-
*
|
|
1118
|
-
|
|
1469
|
+
* Fault only from this instant on the namespace clock. A duration (`"5m"`) counts from the
|
|
1470
|
+
* clock when the rule was added. Listed as epoch ms.
|
|
1471
|
+
*/
|
|
1472
|
+
from?: Instant | Duration;
|
|
1473
|
+
/** Stop faulting at this instant on the namespace clock. A duration counts from when added. */
|
|
1474
|
+
until?: Instant | Duration;
|
|
1475
|
+
/**
|
|
1476
|
+
* Status of the injected response. Omit for a rule that only delays, times out, drops,
|
|
1477
|
+
* truncates, or switches on an `effect`: the request then still reaches the service.
|
|
1119
1478
|
*/
|
|
1120
1479
|
status?: number;
|
|
1121
1480
|
/** Response body, serialized as JSON. A string is sent as-is. */
|
|
1122
1481
|
body?: unknown;
|
|
1482
|
+
/** Response headers. */
|
|
1123
1483
|
headers?: Record<string, string>;
|
|
1124
|
-
/**
|
|
1125
|
-
|
|
1126
|
-
/**
|
|
1127
|
-
rate?: number;
|
|
1128
|
-
/** Hold the response back this long, to exercise timeouts. */
|
|
1484
|
+
/** Hold the response back this long. Listed as `delayMs`. */
|
|
1485
|
+
delay?: Duration;
|
|
1486
|
+
/** `delay`, in milliseconds. */
|
|
1129
1487
|
delayMs?: number;
|
|
1130
1488
|
/** Alias of `delayMs`. */
|
|
1131
1489
|
latencyMs?: number;
|
|
1490
|
+
/** Extra seeded delay in `[0, jitter]`. Listed as `jitterMs`. */
|
|
1491
|
+
jitter?: Duration;
|
|
1492
|
+
jitterMs?: number;
|
|
1493
|
+
/**
|
|
1494
|
+
* Never answer: hold the request this long, then drop the connection. Listed as
|
|
1495
|
+
* `timeoutMs`. With virtual time the wait is spent on the mock clock.
|
|
1496
|
+
*/
|
|
1497
|
+
timeout?: Duration;
|
|
1498
|
+
timeoutMs?: number;
|
|
1132
1499
|
/**
|
|
1133
1500
|
* Drop the connection instead of answering: an in-process `fetch` rejects with a
|
|
1134
1501
|
* `TypeError`, and a served mock destroys the socket. Models "unknown outcome" failures.
|
|
1135
1502
|
*/
|
|
1136
1503
|
drop?: boolean;
|
|
1504
|
+
/**
|
|
1505
|
+
* Cut the response body off after this many bytes: the status and headers arrive, then
|
|
1506
|
+
* the connection dies mid-body.
|
|
1507
|
+
*/
|
|
1508
|
+
truncate?: number;
|
|
1137
1509
|
/**
|
|
1138
1510
|
* A named service behaviour to switch on for the matching request instead of (or
|
|
1139
1511
|
* before) a canned response, e.g. `created_but_500` or `numeric_tracking_id`. Services
|
|
@@ -1142,8 +1514,8 @@ type FaultRule = {
|
|
|
1142
1514
|
effect?: string;
|
|
1143
1515
|
/** Parameters for `effect`. */
|
|
1144
1516
|
params?: Record<string, unknown>;
|
|
1145
|
-
/**
|
|
1146
|
-
|
|
1517
|
+
/** The preset this rule was expanded from, if any. */
|
|
1518
|
+
fromPreset?: string;
|
|
1147
1519
|
};
|
|
1148
1520
|
/** A fault that fired for one request. */
|
|
1149
1521
|
type FaultHit = {
|
|
@@ -1151,6 +1523,10 @@ type FaultHit = {
|
|
|
1151
1523
|
/** The injected response; absent when the rule only delays, drops, or sets an effect. */
|
|
1152
1524
|
response?: Response;
|
|
1153
1525
|
drop?: boolean;
|
|
1526
|
+
/** Set with `drop` when the rule held the request for its `timeout` first. */
|
|
1527
|
+
timeout?: boolean;
|
|
1528
|
+
/** Bytes of response body to let through before the connection dies. */
|
|
1529
|
+
truncate?: number;
|
|
1154
1530
|
effect?: {
|
|
1155
1531
|
name: string;
|
|
1156
1532
|
params: Record<string, unknown>;
|
|
@@ -1162,38 +1538,200 @@ type FaultCandidate = {
|
|
|
1162
1538
|
method: string;
|
|
1163
1539
|
path: string;
|
|
1164
1540
|
namespace: string;
|
|
1541
|
+
/** Request headers and query, for rules that match on them. */
|
|
1542
|
+
headers?: Headers;
|
|
1543
|
+
query?: URLSearchParams;
|
|
1544
|
+
/** The namespace clock, for `from` / `until`. Rules with a window are skipped without it. */
|
|
1545
|
+
now?: number;
|
|
1546
|
+
/** How to spend a delay for this request. Default: the registry's own sleep. */
|
|
1547
|
+
wait?: (ms: number) => Promise<void>;
|
|
1548
|
+
};
|
|
1549
|
+
/** A stored rule and how often it was consulted. */
|
|
1550
|
+
type FaultListing = FaultRule & {
|
|
1551
|
+
/** Faults left before the rule retires. `null` when it has no `count`. */
|
|
1552
|
+
remaining: number | null;
|
|
1553
|
+
/** Times the rule faulted a request. */
|
|
1554
|
+
hits: number;
|
|
1555
|
+
/** Requests that matched the rule, faulted or not. */
|
|
1556
|
+
seen: number;
|
|
1557
|
+
};
|
|
1558
|
+
/** A namespace's own rules, with their counters, in the order they are tried. */
|
|
1559
|
+
type FaultSnapshot = {
|
|
1560
|
+
/**
|
|
1561
|
+
* `position` is how many `"*"` rules are tried before the rule, which is what its place
|
|
1562
|
+
* in the order means to a request and holds in any process.
|
|
1563
|
+
*/
|
|
1564
|
+
rules: (FaultListing & {
|
|
1565
|
+
position?: number;
|
|
1566
|
+
})[];
|
|
1567
|
+
/** How many `fault_<n>` ids the namespace has handed out. */
|
|
1568
|
+
nextId?: number;
|
|
1165
1569
|
};
|
|
1166
1570
|
type FaultRegistry = {
|
|
1167
|
-
|
|
1168
|
-
|
|
1169
|
-
rules: (FaultRule & {
|
|
1170
|
-
remaining: number | null;
|
|
1171
|
-
hits: number;
|
|
1172
|
-
position: number;
|
|
1173
|
-
})[];
|
|
1174
|
-
rngState: number;
|
|
1175
|
-
};
|
|
1571
|
+
snapshot(namespace: string): FaultSnapshot;
|
|
1572
|
+
/** Add a rule, or replace the rule with the same id in the same namespace. */
|
|
1176
1573
|
add(rule: FaultRule): FaultRule;
|
|
1177
|
-
|
|
1178
|
-
|
|
1179
|
-
|
|
1180
|
-
|
|
1181
|
-
|
|
1182
|
-
|
|
1183
|
-
|
|
1184
|
-
|
|
1185
|
-
|
|
1186
|
-
|
|
1187
|
-
|
|
1188
|
-
})[];
|
|
1189
|
-
rngState: number;
|
|
1190
|
-
}): void;
|
|
1574
|
+
/** The next unused `fault_<n>` id in `namespace`. */
|
|
1575
|
+
nextId(namespace: string): string;
|
|
1576
|
+
/** Every rule, or the rules a namespace's requests can hit: its own and the global ones. */
|
|
1577
|
+
list(namespace?: string): FaultListing[];
|
|
1578
|
+
get(id: string, namespace?: string): FaultListing | undefined;
|
|
1579
|
+
/** Remove a rule by id: from `namespace` (its own, then a global one), or wherever it is. */
|
|
1580
|
+
remove(id: string, namespace?: string): boolean;
|
|
1581
|
+
/** Remove every rule, or one namespace's own rules. */
|
|
1582
|
+
clear(namespace?: string): void;
|
|
1583
|
+
/** Replace a namespace's own rules with a snapshot's, wherever the snapshot was taken. */
|
|
1584
|
+
restore(namespace: string, state: FaultSnapshot): void;
|
|
1191
1585
|
/**
|
|
1192
1586
|
* Every fault this request should get, in rule order, stopping at the first that answers
|
|
1193
1587
|
* or drops (effect-only and delay-only rules let later rules match too). Consumes one of
|
|
1194
1588
|
* each matching rule's remaining uses.
|
|
1195
1589
|
*/
|
|
1196
1590
|
take(candidate: FaultCandidate): Promise<FaultHit[]>;
|
|
1591
|
+
/**
|
|
1592
|
+
* Fire these rules at one request without storing them: no matching, no schedule, in order,
|
|
1593
|
+
* stopping at the first that answers or drops. Jitter draws from the namespace's stream.
|
|
1594
|
+
*/
|
|
1595
|
+
fire(rules: readonly FaultRule[], candidate: FaultCandidate): Promise<FaultHit[]>;
|
|
1596
|
+
};
|
|
1597
|
+
|
|
1598
|
+
/**
|
|
1599
|
+
* The admin controls every mock shares, as one document.
|
|
1600
|
+
*
|
|
1601
|
+
* The same shape is accepted in three places, and means the same thing in each:
|
|
1602
|
+
*
|
|
1603
|
+
* - at boot: `createRuntime({ adminControls })`, `serve --admin-controls`,
|
|
1604
|
+
* `MOCKINGBIRD_ADMIN_CONTROLS`
|
|
1605
|
+
* - over HTTP: `PUT /__admin/controls`
|
|
1606
|
+
* - per request: the `x-mockingbird-*` headers in {@link CONTROL_HEADERS}
|
|
1607
|
+
*
|
|
1608
|
+
* Every control is deterministic: given the same seed, clock and requests, a mock answers
|
|
1609
|
+
* the same bytes. Nothing here reads the wall clock or `Math.random`.
|
|
1610
|
+
*/
|
|
1611
|
+
/** Milliseconds, or a string like `"250ms"`, `"2s"`, `"15m"`, `"1h"`, `"3d"`. */
|
|
1612
|
+
type Duration = number | string;
|
|
1613
|
+
/** Epoch milliseconds, or an ISO-8601 string. */
|
|
1614
|
+
type Instant = number | string;
|
|
1615
|
+
type ClockControls = {
|
|
1616
|
+
/** Move the clock to this instant. */
|
|
1617
|
+
now?: Instant;
|
|
1618
|
+
/** Stop time. A frozen clock moves only when told to, so timestamps replay exactly. */
|
|
1619
|
+
frozen?: boolean;
|
|
1620
|
+
/**
|
|
1621
|
+
* Step the clock forward by this much before every vendor request. With a frozen clock
|
|
1622
|
+
* each request still gets its own, reproducible timestamp.
|
|
1623
|
+
*/
|
|
1624
|
+
autoAdvance?: Duration;
|
|
1625
|
+
};
|
|
1626
|
+
/** How long a response takes: a fixed delay plus seeded jitter in `[0, jitter]`. */
|
|
1627
|
+
type LatencyRuleInput = {
|
|
1628
|
+
delay?: Duration;
|
|
1629
|
+
jitter?: Duration;
|
|
1630
|
+
};
|
|
1631
|
+
type LatencyControls = LatencyRuleInput & {
|
|
1632
|
+
/** Per-operation overrides, keyed by operationId. A bare duration is its `delay`. */
|
|
1633
|
+
operations?: Record<string, Duration | LatencyRuleInput>;
|
|
1634
|
+
};
|
|
1635
|
+
/** A fault to add: a rule (the id is assigned when omitted), or a named preset with overrides. */
|
|
1636
|
+
type FaultInput = (Omit<FaultRule, "id"> & {
|
|
1637
|
+
id?: string;
|
|
1638
|
+
}) | ({
|
|
1639
|
+
preset: string;
|
|
1640
|
+
} & Partial<FaultRule>);
|
|
1641
|
+
/** Identifies a {@link SnapshotDocument}. */
|
|
1642
|
+
declare const SNAPSHOT_FORMAT = "mockingbird.snapshot/v1";
|
|
1643
|
+
/**
|
|
1644
|
+
* A namespace, as portable JSON: what `GET /__admin/snapshots/:id` returns and what
|
|
1645
|
+
* `PUT /__admin/snapshots/:id` and the boot `snapshot` control accept. Only `format` and
|
|
1646
|
+
* `records` are required, so a hand-written seed file is a valid snapshot.
|
|
1647
|
+
*/
|
|
1648
|
+
type SnapshotDocument = {
|
|
1649
|
+
format: typeof SNAPSHOT_FORMAT;
|
|
1650
|
+
/** The service that wrote it. A snapshot is rejected by any other service. */
|
|
1651
|
+
service?: string;
|
|
1652
|
+
/**
|
|
1653
|
+
* Stored rows. `seq` orders a collection; omitted, rows keep their listed order. `raw` is
|
|
1654
|
+
* the stored text of a row that is not a plain record, and replaces `value` when present.
|
|
1655
|
+
*/
|
|
1656
|
+
records: {
|
|
1657
|
+
collection: string;
|
|
1658
|
+
id: string;
|
|
1659
|
+
seq?: number;
|
|
1660
|
+
value?: unknown;
|
|
1661
|
+
raw?: string;
|
|
1662
|
+
}[];
|
|
1663
|
+
/** Id counters, so the next generated id continues where the snapshot left off. */
|
|
1664
|
+
sequences?: {
|
|
1665
|
+
name: string;
|
|
1666
|
+
kind: string;
|
|
1667
|
+
value: number;
|
|
1668
|
+
}[];
|
|
1669
|
+
clock?: {
|
|
1670
|
+
now: number;
|
|
1671
|
+
frozen: boolean;
|
|
1672
|
+
autoAdvanceMs?: number;
|
|
1673
|
+
};
|
|
1674
|
+
seed?: number | string;
|
|
1675
|
+
/** Positions of the seeded random streams. */
|
|
1676
|
+
rng?: {
|
|
1677
|
+
state: number;
|
|
1678
|
+
faults?: number;
|
|
1679
|
+
latency?: number;
|
|
1680
|
+
};
|
|
1681
|
+
faults?: unknown;
|
|
1682
|
+
latency?: unknown;
|
|
1683
|
+
virtualTime?: boolean;
|
|
1684
|
+
};
|
|
1685
|
+
/** Controls for one namespace. */
|
|
1686
|
+
type NamespaceControls = {
|
|
1687
|
+
/** Seeds every random choice: fault rates, jitter, and whatever the service invents. */
|
|
1688
|
+
seed?: number | string;
|
|
1689
|
+
clock?: ClockControls;
|
|
1690
|
+
/**
|
|
1691
|
+
* Spend injected waits (latency, fault delays, timeouts) on the mock clock instead of the
|
|
1692
|
+
* wall clock: the request returns at once, the clock has moved, and the journal records
|
|
1693
|
+
* the wait exactly. Default `false`: waits are real, so a client's own timeout can fire.
|
|
1694
|
+
*/
|
|
1695
|
+
virtualTime?: boolean;
|
|
1696
|
+
/** Baseline response time for every vendor request. A bare duration is its `delay`. */
|
|
1697
|
+
latency?: Duration | LatencyControls;
|
|
1698
|
+
faults?: readonly FaultInput[];
|
|
1699
|
+
/** Start from this state instead of the service's own seed data. */
|
|
1700
|
+
snapshot?: SnapshotDocument;
|
|
1701
|
+
};
|
|
1702
|
+
/** {@link NamespaceControls} for every namespace, with per-namespace overrides. */
|
|
1703
|
+
type MockControls = NamespaceControls & {
|
|
1704
|
+
/** Vendor credential → namespace, for SDKs that cannot send a namespace header. */
|
|
1705
|
+
credentials?: Record<string, string>;
|
|
1706
|
+
/** Overrides for named namespaces. A key given here replaces the shared value. */
|
|
1707
|
+
namespaces?: Record<string, NamespaceControls>;
|
|
1708
|
+
};
|
|
1709
|
+
/** A latency rule in milliseconds. */
|
|
1710
|
+
type LatencyRule = {
|
|
1711
|
+
delayMs: number;
|
|
1712
|
+
jitterMs: number;
|
|
1713
|
+
};
|
|
1714
|
+
/** Baseline latency for a namespace, normalized. */
|
|
1715
|
+
type LatencyState = LatencyRule & {
|
|
1716
|
+
operations: Record<string, LatencyRule>;
|
|
1717
|
+
};
|
|
1718
|
+
/** What {@link controlHeaders} turns into request headers. */
|
|
1719
|
+
type ControlHeaderInput = {
|
|
1720
|
+
namespace?: string;
|
|
1721
|
+
adminKey?: string;
|
|
1722
|
+
branch?: string;
|
|
1723
|
+
at?: string;
|
|
1724
|
+
reset?: boolean;
|
|
1725
|
+
restore?: string;
|
|
1726
|
+
seed?: number | string;
|
|
1727
|
+
time?: Instant | Date;
|
|
1728
|
+
advance?: Duration;
|
|
1729
|
+
virtualTime?: boolean;
|
|
1730
|
+
delay?: Duration;
|
|
1731
|
+
timeout?: Duration;
|
|
1732
|
+
/** A status, `"drop"`, a preset name, or a fault rule. */
|
|
1733
|
+
fault?: number | string | Record<string, unknown>;
|
|
1734
|
+
snapshot?: string;
|
|
1197
1735
|
};
|
|
1198
1736
|
|
|
1199
1737
|
/**
|
|
@@ -1233,6 +1771,8 @@ type RequestLog = {
|
|
|
1233
1771
|
unmatched: boolean;
|
|
1234
1772
|
/** Set when a fault rule produced the response. */
|
|
1235
1773
|
faultId?: string;
|
|
1774
|
+
/** Milliseconds of injected wait: latency, fault delays and timeouts. Absent when none. */
|
|
1775
|
+
delayMs?: number;
|
|
1236
1776
|
/** Resource ids the handler touched (`userId`, `orderId`, …), when the service reports them. */
|
|
1237
1777
|
ids?: Record<string, string>;
|
|
1238
1778
|
/** Set when the service created a resource the request referred to but that did not exist. */
|
|
@@ -1278,6 +1818,12 @@ type JournalQuery = {
|
|
|
1278
1818
|
/** Only this namespace. Omit for every namespace, oldest first across all of them. */
|
|
1279
1819
|
namespace?: string;
|
|
1280
1820
|
operationId?: string;
|
|
1821
|
+
/** Only this HTTP method, case-insensitive. */
|
|
1822
|
+
method?: string;
|
|
1823
|
+
/** Only this exact path. */
|
|
1824
|
+
path?: string;
|
|
1825
|
+
/** Only requests this fault rule answered or shaped. */
|
|
1826
|
+
faultId?: string;
|
|
1281
1827
|
status?: number;
|
|
1282
1828
|
/** Only entries at or after this instant (epoch ms). */
|
|
1283
1829
|
since?: number;
|
|
@@ -1292,6 +1838,50 @@ type Journal = {
|
|
|
1292
1838
|
clear(namespace?: string): void;
|
|
1293
1839
|
};
|
|
1294
1840
|
|
|
1841
|
+
/**
|
|
1842
|
+
* Baseline response time, per namespace: how long every vendor request takes before any
|
|
1843
|
+
* fault is considered. Jitter draws from a stream the caller owns, one per namespace and
|
|
1844
|
+
* separate from the fault stream, so adding latency never shifts which requests a `rate`
|
|
1845
|
+
* fault hits.
|
|
1846
|
+
*/
|
|
1847
|
+
type LatencyRegistry = {
|
|
1848
|
+
get(namespace: string): LatencyState;
|
|
1849
|
+
set(namespace: string, state: LatencyState): LatencyState;
|
|
1850
|
+
/** Remove one namespace's latency, or every namespace's. */
|
|
1851
|
+
clear(namespace?: string): void;
|
|
1852
|
+
/** Milliseconds this request waits. Draws jitter, so call it once per request. */
|
|
1853
|
+
take(namespace: string, operationId: string | undefined): number;
|
|
1854
|
+
};
|
|
1855
|
+
|
|
1856
|
+
/** Clock state as the admin API reports it. */
|
|
1857
|
+
type ControlClock = ClockState & {
|
|
1858
|
+
/** `now`, as ISO-8601. */
|
|
1859
|
+
iso: string;
|
|
1860
|
+
/** Milliseconds the clock steps before every vendor request. */
|
|
1861
|
+
autoAdvanceMs: number;
|
|
1862
|
+
};
|
|
1863
|
+
/** One namespace's controls: the body of `GET /__admin/controls`. */
|
|
1864
|
+
type ControlState = {
|
|
1865
|
+
namespace: string;
|
|
1866
|
+
seed: number | string;
|
|
1867
|
+
clock: ControlClock;
|
|
1868
|
+
virtualTime: boolean;
|
|
1869
|
+
latency: LatencyState;
|
|
1870
|
+
faults: FaultListing[];
|
|
1871
|
+
};
|
|
1872
|
+
|
|
1873
|
+
/** What `GET /__admin/snapshots` lists for each snapshot. */
|
|
1874
|
+
type SnapshotInfo = {
|
|
1875
|
+
id: string;
|
|
1876
|
+
namespace: string;
|
|
1877
|
+
/** Stored rows in the snapshot. */
|
|
1878
|
+
records: number;
|
|
1879
|
+
/** The namespace clock when it was taken, epoch ms. */
|
|
1880
|
+
at: number;
|
|
1881
|
+
/** Whether `GET /snapshots/:id` can return it as a {@link SnapshotDocument}. */
|
|
1882
|
+
portable: boolean;
|
|
1883
|
+
};
|
|
1884
|
+
|
|
1295
1885
|
/** Credential → namespace mapping behind `PUT /__admin/credentials`. */
|
|
1296
1886
|
type CredentialRegistry = {
|
|
1297
1887
|
set(credential: string, namespace: string): void;
|
|
@@ -1446,7 +2036,10 @@ type ServiceInstance = FetchAPI$1 & {
|
|
|
1446
2036
|
};
|
|
1447
2037
|
type ServiceTimelineState = Readonly<{
|
|
1448
2038
|
snapshot: NamespaceSnapshot;
|
|
1449
|
-
clock
|
|
2039
|
+
/** `pinned`: the namespace's clock was frozen itself, not just following a frozen base. */
|
|
2040
|
+
clock: Readonly<ClockState & {
|
|
2041
|
+
pinned?: boolean;
|
|
2042
|
+
}>;
|
|
1450
2043
|
rngState: number;
|
|
1451
2044
|
}>;
|
|
1452
2045
|
type ServiceCheckpoint = Checkpoint<ServiceTimelineState>;
|
|
@@ -1454,17 +2047,23 @@ type ServiceRuntime<T extends ServiceInstance> = FetchAPI$1 & {
|
|
|
1454
2047
|
/** Stop package-owned lifecycle timers when a supervisor closes the runtime. */
|
|
1455
2048
|
stop?(): void;
|
|
1456
2049
|
readonly name: string;
|
|
2050
|
+
/** Same-origin Fetch handler and App Router method exports, sharing this runtime. */
|
|
2051
|
+
mount(prefix: string): MountedAPI;
|
|
1457
2052
|
readonly sqlite: SqliteClient$1;
|
|
1458
2053
|
readonly clock: Clock;
|
|
1459
2054
|
readonly faults: FaultRegistry;
|
|
2055
|
+
/** Baseline response time per namespace. */
|
|
2056
|
+
readonly latency: LatencyRegistry;
|
|
1460
2057
|
readonly metrics: Metrics;
|
|
1461
2058
|
readonly journal: Journal;
|
|
1462
2059
|
readonly rng: Rng;
|
|
1463
2060
|
readonly credentials: CredentialRegistry;
|
|
1464
2061
|
/** The webhook hub, when the service has outbound webhooks. */
|
|
1465
2062
|
readonly webhooks: WebhookHub | undefined;
|
|
1466
|
-
/**
|
|
1467
|
-
|
|
2063
|
+
/**
|
|
2064
|
+
* A namespace's clock. Each follows the base clock, {@link ServiceRuntime.clock}, with an
|
|
2065
|
+
* offset and a freeze of its own, so moving one never moves another.
|
|
2066
|
+
*/
|
|
1468
2067
|
namespaceClock(namespace?: string): Clock;
|
|
1469
2068
|
namespaceOf(request: Request): string;
|
|
1470
2069
|
/** Opaque in-process checkpoint including records, controls and webhook history. */
|
|
@@ -1476,8 +2075,38 @@ type ServiceRuntime<T extends ServiceInstance> = FetchAPI$1 & {
|
|
|
1476
2075
|
instance(namespace?: string): T;
|
|
1477
2076
|
/** Public names of every namespace created so far. */
|
|
1478
2077
|
namespaces(): string[];
|
|
1479
|
-
/**
|
|
2078
|
+
/** Return one namespace to its boot state, or every namespace with `"*"`. */
|
|
1480
2079
|
reset(namespace?: string): Promise<void>;
|
|
2080
|
+
/** Reset a namespace and forget it, releasing everything it held. */
|
|
2081
|
+
dropNamespace(namespace: string): Promise<void>;
|
|
2082
|
+
/** A namespace's controls: seed, clock, virtual time, latency, faults and snapshots. */
|
|
2083
|
+
controls(namespace?: string): ControlState & {
|
|
2084
|
+
snapshots: SnapshotInfo[];
|
|
2085
|
+
};
|
|
2086
|
+
/** Apply a control document to a namespace. A given key replaces that control. */
|
|
2087
|
+
configure(controls: NamespaceControls, namespace?: string): ControlState & {
|
|
2088
|
+
snapshots: SnapshotInfo[];
|
|
2089
|
+
};
|
|
2090
|
+
/** Named snapshots of a namespace: records, clock, random streams, faults and latency. */
|
|
2091
|
+
readonly snapshots: {
|
|
2092
|
+
/** Capture the namespace now. Reusing a name replaces that snapshot. */
|
|
2093
|
+
create(options?: {
|
|
2094
|
+
name?: string;
|
|
2095
|
+
namespace?: string;
|
|
2096
|
+
}): SnapshotInfo;
|
|
2097
|
+
list(namespace?: string): SnapshotInfo[];
|
|
2098
|
+
/** The snapshot as portable JSON, to commit beside a suite or boot another mock from. */
|
|
2099
|
+
export(id: string, namespace?: string): SnapshotDocument;
|
|
2100
|
+
/** Store a document as a snapshot without restoring it. */
|
|
2101
|
+
import(document: SnapshotDocument, options?: {
|
|
2102
|
+
name?: string;
|
|
2103
|
+
namespace?: string;
|
|
2104
|
+
}): SnapshotInfo;
|
|
2105
|
+
restore(id: string, namespace?: string): void;
|
|
2106
|
+
delete(id: string, namespace?: string): boolean;
|
|
2107
|
+
};
|
|
2108
|
+
/** Request headers that carry controls, checked: spread them into a `fetch` or an SDK's defaults. */
|
|
2109
|
+
headers(input: ControlHeaderInput): Record<string, string>;
|
|
1481
2110
|
snapshot(namespace?: string): NamespaceSnapshot;
|
|
1482
2111
|
restore(snapshot: NamespaceSnapshot, namespace?: string): void;
|
|
1483
2112
|
/** Capture the current branch. Mutating HTTP calls do this automatically. */
|
|
@@ -1694,6 +2323,8 @@ type FormbricksRuntimeOptions = {
|
|
|
1694
2323
|
seed?: number | string;
|
|
1695
2324
|
adminPrefix?: string;
|
|
1696
2325
|
adminKey?: string;
|
|
2326
|
+
/** Admin controls to boot with: clock, latency, faults, seed, a starting snapshot. */
|
|
2327
|
+
adminControls?: MockControls;
|
|
1697
2328
|
onLog?: (entry: RequestLog) => void;
|
|
1698
2329
|
surveys?: readonly Survey[];
|
|
1699
2330
|
settings?: Partial<Settings>;
|