@kirrosh/zond 0.21.0 → 0.23.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 +758 -3
- package/README.md +78 -15
- package/package.json +17 -10
- package/src/cli/argv.ts +122 -0
- package/src/cli/commands/add-api.ts +134 -0
- package/src/cli/commands/api/annotate/idempotency.ts +59 -0
- package/src/cli/commands/api/annotate/index.ts +525 -0
- package/src/cli/commands/api/annotate/lifecycle.ts +74 -0
- package/src/cli/commands/api/annotate/overlay.ts +206 -0
- package/src/cli/commands/api/annotate/pagination.ts +60 -0
- package/src/cli/commands/api/annotate/prompts.ts +183 -0
- package/src/cli/commands/api/annotate/readback.ts +58 -0
- package/src/cli/commands/api/annotate/resources.ts +91 -0
- package/src/cli/commands/api/annotate/seed-bodies.ts +61 -0
- package/src/cli/commands/audit.ts +480 -0
- package/src/cli/commands/bootstrap.ts +710 -0
- package/src/cli/commands/catalog.ts +35 -0
- package/src/cli/commands/check.ts +348 -0
- package/src/cli/commands/checks.ts +756 -0
- package/src/cli/commands/ci-init.ts +55 -6
- package/src/cli/commands/clean.ts +212 -0
- package/src/cli/commands/cleanup.ts +262 -0
- package/src/cli/commands/completions.ts +192 -0
- package/src/cli/commands/coverage.ts +605 -132
- package/src/cli/commands/db.ts +180 -8
- package/src/cli/commands/describe.ts +37 -2
- package/src/cli/commands/discover.ts +1236 -0
- package/src/cli/commands/doctor.ts +607 -0
- package/src/cli/commands/fixtures.ts +402 -0
- package/src/cli/commands/generate.ts +420 -47
- package/src/cli/commands/init/agents-md.ts +61 -0
- package/src/cli/commands/init/bootstrap.ts +108 -0
- package/src/cli/commands/init/index.ts +244 -0
- package/src/cli/commands/init/skills.ts +98 -0
- package/src/cli/commands/init/templates/agents.md +77 -0
- package/src/cli/commands/init/templates/markdown.d.ts +4 -0
- package/src/cli/commands/init/templates/skills/zond-checks.md +397 -0
- package/src/cli/commands/init/templates/skills/zond-triage.md +210 -0
- package/src/cli/commands/init/templates/skills/zond.md +651 -0
- package/src/cli/commands/init/templates/zond-config.yml +14 -0
- package/src/cli/commands/prepare-fixtures.ts +135 -0
- package/src/cli/commands/probe/mass-assignment.ts +503 -0
- package/src/cli/commands/probe/security.ts +454 -0
- package/src/cli/commands/probe/static.ts +255 -0
- package/src/cli/commands/probe/webhooks.ts +161 -0
- package/src/cli/commands/probe.ts +459 -0
- package/src/cli/commands/reference.ts +87 -0
- package/src/cli/commands/refresh-api.ts +169 -0
- package/src/cli/commands/remove-api.ts +150 -0
- package/src/cli/commands/report-bundle.ts +318 -0
- package/src/cli/commands/report.ts +241 -0
- package/src/cli/commands/request.ts +379 -4
- package/src/cli/commands/run.ts +911 -33
- package/src/cli/commands/session.ts +244 -0
- package/src/cli/commands/use.ts +74 -0
- package/src/cli/index.ts +36 -607
- package/src/cli/json-envelope.ts +112 -3
- package/src/cli/json-schemas.ts +263 -0
- package/src/cli/program.ts +218 -0
- package/src/cli/resolve.ts +105 -0
- package/src/cli/status-filter.ts +124 -0
- package/src/cli/util/api-context.ts +85 -0
- package/src/cli/version.ts +8 -0
- package/src/core/anti-fp/bootstrap.ts +34 -0
- package/src/core/anti-fp/index.ts +33 -0
- package/src/core/anti-fp/registry.ts +44 -0
- package/src/core/anti-fp/rules/baseline-echo.ts +74 -0
- package/src/core/anti-fp/rules/schemathesis/body_negation_becomes_valid.ts +52 -0
- package/src/core/anti-fp/rules/schemathesis/coverage_phase_boundary_positive.ts +38 -0
- package/src/core/anti-fp/rules/schemathesis/has_unverifiable_mutations.ts +35 -0
- package/src/core/anti-fp/rules/schemathesis/index.ts +24 -0
- package/src/core/anti-fp/rules/schemathesis/string_type_mutation_becomes_valid.ts +53 -0
- package/src/core/anti-fp/rules/subscription-gated/index.ts +11 -0
- package/src/core/anti-fp/rules/subscription-gated/paid-plan-403.ts +75 -0
- package/src/core/anti-fp/types.ts +68 -0
- package/src/core/checks/checks/_crud-helpers.ts +133 -0
- package/src/core/checks/checks/_negative_mutator.ts +133 -0
- package/src/core/checks/checks/_readback-helpers.ts +133 -0
- package/src/core/checks/checks/content_type_conformance.ts +39 -0
- package/src/core/checks/checks/cross_call_references.ts +134 -0
- package/src/core/checks/checks/ensure_resource_availability.ts +62 -0
- package/src/core/checks/checks/idempotency_replay.ts +246 -0
- package/src/core/checks/checks/ignored_auth.ts +211 -0
- package/src/core/checks/checks/index.ts +65 -0
- package/src/core/checks/checks/lifecycle_transitions.ts +273 -0
- package/src/core/checks/checks/missing_required_header.ts +40 -0
- package/src/core/checks/checks/negative_data_rejection.ts +45 -0
- package/src/core/checks/checks/not_a_server_error.ts +27 -0
- package/src/core/checks/checks/open_cors_on_sensitive.ts +131 -0
- package/src/core/checks/checks/pagination_invariants.ts +238 -0
- package/src/core/checks/checks/positive_data_acceptance.ts +36 -0
- package/src/core/checks/checks/rate_limit_headers_absent.ts +77 -0
- package/src/core/checks/checks/response_headers_conformance.ts +74 -0
- package/src/core/checks/checks/response_schema_conformance.ts +30 -0
- package/src/core/checks/checks/status_code_conformance.ts +61 -0
- package/src/core/checks/checks/unsupported_method.ts +63 -0
- package/src/core/checks/checks/use_after_free.ts +78 -0
- package/src/core/checks/index.ts +30 -0
- package/src/core/checks/mode.ts +79 -0
- package/src/core/checks/recommended-action.ts +64 -0
- package/src/core/checks/registry.ts +78 -0
- package/src/core/checks/runner.ts +874 -0
- package/src/core/checks/sarif.ts +230 -0
- package/src/core/checks/stateful.ts +121 -0
- package/src/core/checks/types.ts +189 -0
- package/src/core/classifier/recommended-action.ts +222 -0
- package/src/core/context/current.ts +51 -0
- package/src/core/context/session.ts +78 -0
- package/src/core/coverage/loader.ts +185 -0
- package/src/core/coverage/reasons.ts +300 -0
- package/src/core/diagnostics/db-analysis.ts +161 -12
- package/src/core/diagnostics/failure-class.ts +120 -0
- package/src/core/diagnostics/failure-hints.ts +212 -9
- package/src/core/diagnostics/spec-pointer.ts +99 -0
- package/src/core/diagnostics/suggested-fixes.ts +156 -0
- package/src/core/exporter/case-study/index.ts +270 -0
- package/src/core/exporter/curl.ts +40 -0
- package/src/core/exporter/exporter.ts +48 -0
- package/src/core/exporter/html-report/escape.ts +24 -0
- package/src/core/exporter/html-report/index.ts +479 -0
- package/src/core/exporter/html-report/script.ts +100 -0
- package/src/core/exporter/html-report/styles.ts +408 -0
- package/src/core/generator/chunker.ts +53 -15
- package/src/core/generator/coverage-phase.ts +0 -0
- package/src/core/generator/create-body.ts +89 -0
- package/src/core/generator/data-factory.ts +490 -33
- package/src/core/generator/describe.ts +1 -1
- package/src/core/generator/fixtures-builder.ts +325 -0
- package/src/core/generator/index.ts +7 -5
- package/src/core/generator/openapi-reader.ts +55 -3
- package/src/core/generator/path-param-disambig.ts +114 -0
- package/src/core/generator/resources-builder.ts +648 -0
- package/src/core/generator/schema-utils.ts +11 -3
- package/src/core/generator/serializer.ts +114 -15
- package/src/core/generator/suite-generator.ts +484 -77
- package/src/core/generator/types.ts +8 -0
- package/src/core/identity/identity-file.ts +129 -0
- package/src/core/lint/affects.ts +28 -0
- package/src/core/lint/config.ts +96 -0
- package/src/core/lint/format.ts +42 -0
- package/src/core/lint/index.ts +94 -0
- package/src/core/lint/reporter.ts +128 -0
- package/src/core/lint/rules/consistency.ts +158 -0
- package/src/core/lint/rules/heuristics.ts +97 -0
- package/src/core/lint/rules/strictness.ts +109 -0
- package/src/core/lint/types.ts +96 -0
- package/src/core/lint/walker.ts +248 -0
- package/src/core/meta/meta-store.ts +6 -73
- package/src/core/output/README.md +91 -0
- package/src/core/output/index.ts +13 -0
- package/src/core/output/run.ts +126 -0
- package/src/core/output/types.ts +129 -0
- package/src/core/parser/env-interpolation.ts +104 -0
- package/src/core/parser/filter.ts +57 -0
- package/src/core/parser/schema.ts +132 -5
- package/src/core/parser/types.ts +29 -2
- package/src/core/parser/variables.ts +0 -0
- package/src/core/parser/yaml-parser.ts +108 -13
- package/src/core/probe/bootstrap.ts +34 -0
- package/src/core/probe/dry-run-envelope.ts +57 -0
- package/src/core/probe/mass-assignment-probe-class.ts +198 -0
- package/src/core/probe/mass-assignment-probe.ts +1122 -0
- package/src/core/probe/mass-assignment-template.ts +212 -0
- package/src/core/probe/method-probe.ts +164 -0
- package/src/core/probe/method-shared.ts +69 -0
- package/src/core/probe/negative-probe.ts +691 -0
- package/src/core/probe/orphan-tracker.ts +188 -0
- package/src/core/probe/path-discovery.ts +440 -0
- package/src/core/probe/probe-harness.ts +120 -0
- package/src/core/probe/registry.ts +89 -0
- package/src/core/probe/runner.ts +136 -0
- package/src/core/probe/security-probe-class.ts +201 -0
- package/src/core/probe/security-probe.ts +1453 -0
- package/src/core/probe/shared.ts +505 -0
- package/src/core/probe/static-probe-class.ts +125 -0
- package/src/core/probe/types.ts +165 -0
- package/src/core/probe/verdict-aggregator.ts +33 -0
- package/src/core/probe/webhooks-probe.ts +284 -0
- package/src/core/reporter/console.ts +69 -4
- package/src/core/reporter/index.ts +2 -3
- package/src/core/reporter/json.ts +15 -2
- package/src/core/reporter/junit.ts +27 -12
- package/src/core/reporter/ndjson.ts +37 -0
- package/src/core/reporter/types.ts +3 -0
- package/src/core/runner/assertions.ts +62 -2
- package/src/core/runner/async-pool.ts +108 -0
- package/src/core/runner/auth-path.ts +8 -0
- package/src/core/runner/ci-context.ts +72 -0
- package/src/core/runner/executor.ts +391 -52
- package/src/core/runner/form-encode.ts +51 -0
- package/src/core/runner/http-client.ts +115 -7
- package/src/core/runner/learn-drift.ts +293 -0
- package/src/core/runner/preflight-vars.ts +149 -0
- package/src/core/runner/progress-tracker.ts +73 -0
- package/src/core/runner/rate-limiter.ts +203 -0
- package/src/core/runner/run-kind.ts +39 -0
- package/src/core/runner/schema-validator.ts +312 -0
- package/src/core/runner/send-request.ts +153 -20
- package/src/core/runner/types.ts +38 -0
- package/src/core/secrets/registry.ts +164 -0
- package/src/core/secrets/secrets-file.ts +115 -0
- package/src/core/selectors/operation-filter.ts +144 -0
- package/src/core/setup-api.ts +419 -17
- package/src/core/severity/category.ts +94 -0
- package/src/core/severity/index.ts +121 -0
- package/src/core/spec/layers.ts +154 -0
- package/src/core/util/format-eta.ts +21 -0
- package/src/core/utils.ts +5 -1
- package/src/core/workspace/config.ts +129 -0
- package/src/core/workspace/manifest.ts +283 -0
- package/src/core/workspace/output-rotation.ts +62 -0
- package/src/core/workspace/root.ts +94 -0
- package/src/core/workspace/triage-path.ts +87 -0
- package/src/db/lint-runs.ts +47 -0
- package/src/db/migrate.ts +126 -0
- package/src/db/migrations/0001_run_kind.sql +25 -0
- package/src/db/migrations/sql.d.ts +4 -0
- package/src/db/queries/collections.ts +133 -0
- package/src/db/queries/coverage.ts +9 -0
- package/src/db/queries/dashboard.ts +59 -0
- package/src/db/queries/results.ts +128 -0
- package/src/db/queries/runs.ts +235 -0
- package/src/db/queries/sessions.ts +42 -0
- package/src/db/queries/settings.ts +28 -0
- package/src/db/queries/types.ts +172 -0
- package/src/db/queries.ts +72 -802
- package/src/db/schema.ts +179 -48
- package/src/cli/commands/export.ts +0 -144
- package/src/cli/commands/guide.ts +0 -127
- package/src/cli/commands/init.ts +0 -57
- package/src/cli/commands/serve.ts +0 -81
- package/src/cli/commands/sync.ts +0 -269
- package/src/cli/commands/update.ts +0 -189
- package/src/cli/commands/validate.ts +0 -34
- package/src/core/exporter/postman.ts +0 -963
- package/src/core/generator/guide-builder.ts +0 -253
- package/src/core/meta/types.ts +0 -21
- package/src/core/parser/index.ts +0 -21
- package/src/core/runner/execute-run.ts +0 -132
- package/src/core/runner/index.ts +0 -12
- package/src/core/sync/spec-differ.ts +0 -38
- package/src/web/data/collection-state.ts +0 -362
- package/src/web/routes/api.ts +0 -314
- package/src/web/routes/dashboard.ts +0 -350
- package/src/web/routes/runs.ts +0 -64
- package/src/web/schemas.ts +0 -121
- package/src/web/server.ts +0 -134
- package/src/web/static/htmx.min.cjs +0 -1
- package/src/web/static/style.css +0 -1148
- package/src/web/views/endpoints-tab.ts +0 -174
- package/src/web/views/explorer-tab.ts +0 -402
- package/src/web/views/health-strip.ts +0 -92
- package/src/web/views/layout.ts +0 -48
- package/src/web/views/results.ts +0 -210
- package/src/web/views/runs-tab.ts +0 -126
- package/src/web/views/suites-tab.ts +0 -181
|
@@ -1,29 +1,90 @@
|
|
|
1
1
|
import type { HttpRequest, HttpResponse } from "./types.ts";
|
|
2
|
+
import { type RateLimiter, parseRetryAfter, parseRateLimitHeaders } from "./rate-limiter.ts";
|
|
2
3
|
|
|
3
4
|
export interface FetchOptions {
|
|
4
5
|
timeout: number;
|
|
5
6
|
retries: number;
|
|
6
7
|
retry_delay: number;
|
|
7
8
|
follow_redirects: boolean;
|
|
9
|
+
rate_limiter?: RateLimiter;
|
|
10
|
+
rate_limit_retries: number;
|
|
11
|
+
rate_limit_max_delay_ms: number;
|
|
12
|
+
/** TASK-144: number of network-level retries (ECONNRESET, EPIPE, socket hang
|
|
13
|
+
* up, fetch failed without HTTP response, timeout without response). HTTP
|
|
14
|
+
* status codes are NEVER retried by this path. Exponential backoff with
|
|
15
|
+
* jitter, base = `network_retry_base_ms`. Default 0 (CLI sets it to 1). */
|
|
16
|
+
network_retries: number;
|
|
17
|
+
network_retry_base_ms: number;
|
|
18
|
+
network_retry_max_delay_ms: number;
|
|
8
19
|
}
|
|
9
20
|
|
|
10
|
-
|
|
21
|
+
const DEFAULT_FETCH_OPTIONS: FetchOptions = {
|
|
11
22
|
timeout: 30000,
|
|
12
23
|
retries: 0,
|
|
13
24
|
retry_delay: 1000,
|
|
14
25
|
follow_redirects: true,
|
|
26
|
+
rate_limit_retries: 5,
|
|
27
|
+
rate_limit_max_delay_ms: 30000,
|
|
28
|
+
network_retries: 0,
|
|
29
|
+
network_retry_base_ms: 250,
|
|
30
|
+
network_retry_max_delay_ms: 8000,
|
|
15
31
|
};
|
|
16
32
|
|
|
33
|
+
/**
|
|
34
|
+
* Recognise transient TCP/transport-level errors that warrant a retry. We
|
|
35
|
+
* deliberately do NOT include HTTP status codes — a 5xx is a real response
|
|
36
|
+
* the server chose to send, not a flaky socket. Patterns cover Node/Bun
|
|
37
|
+
* error codes (`ECONNRESET`, `EPIPE`, `ECONNREFUSED`, `ETIMEDOUT`,
|
|
38
|
+
* `EAI_AGAIN`), the WHATWG `fetch failed` wrapper Bun throws, classic
|
|
39
|
+
* `socket hang up`, and `AbortError` raised by our own timeout watchdog.
|
|
40
|
+
*/
|
|
41
|
+
export function isTransientNetworkError(err: unknown): boolean {
|
|
42
|
+
if (!err) return false;
|
|
43
|
+
const e = err as { code?: string; cause?: unknown; name?: string; message?: string };
|
|
44
|
+
const code = e.code ?? (e.cause as { code?: string } | undefined)?.code;
|
|
45
|
+
if (code) {
|
|
46
|
+
if (
|
|
47
|
+
code === "ECONNRESET" ||
|
|
48
|
+
code === "EPIPE" ||
|
|
49
|
+
code === "ECONNREFUSED" ||
|
|
50
|
+
code === "ETIMEDOUT" ||
|
|
51
|
+
code === "EAI_AGAIN" ||
|
|
52
|
+
code === "ENOTFOUND" ||
|
|
53
|
+
code === "ENETUNREACH"
|
|
54
|
+
) {
|
|
55
|
+
return true;
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
const msg = (e.message ?? String(err)).toLowerCase();
|
|
59
|
+
if (e.name === "AbortError" || msg.includes("aborted")) return true;
|
|
60
|
+
if (msg.includes("socket hang up")) return true;
|
|
61
|
+
if (msg.includes("fetch failed")) return true;
|
|
62
|
+
if (msg.includes("connection reset") || msg.includes("econnreset")) return true;
|
|
63
|
+
if (msg.includes("epipe")) return true;
|
|
64
|
+
if (msg.includes("network error")) return true;
|
|
65
|
+
return false;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
/** Exponential backoff with full jitter (AWS-style): pick uniformly in
|
|
69
|
+
* [0, min(cap, base * 2^attempt)). Returns ms. */
|
|
70
|
+
export function networkBackoffMs(attempt: number, baseMs: number, capMs: number): number {
|
|
71
|
+
const exp = Math.min(capMs, baseMs * 2 ** attempt);
|
|
72
|
+
return Math.floor(Math.random() * exp);
|
|
73
|
+
}
|
|
74
|
+
|
|
17
75
|
export async function executeRequest(
|
|
18
76
|
request: HttpRequest,
|
|
19
77
|
options?: Partial<FetchOptions>,
|
|
20
78
|
): Promise<HttpResponse> {
|
|
21
79
|
const opts = { ...DEFAULT_FETCH_OPTIONS, ...options };
|
|
22
80
|
let lastError: Error | undefined;
|
|
81
|
+
let networkAttempt = 0;
|
|
82
|
+
let networkRetryCount = 0;
|
|
83
|
+
let rate429Attempt = 0;
|
|
23
84
|
|
|
24
|
-
|
|
25
|
-
if (
|
|
26
|
-
await
|
|
85
|
+
while (true) {
|
|
86
|
+
if (opts.rate_limiter) {
|
|
87
|
+
await opts.rate_limiter.acquire();
|
|
27
88
|
}
|
|
28
89
|
|
|
29
90
|
try {
|
|
@@ -43,6 +104,20 @@ export async function executeRequest(
|
|
|
43
104
|
clearTimeout(timeoutId);
|
|
44
105
|
const duration_ms = Math.round(performance.now() - start);
|
|
45
106
|
|
|
107
|
+
if (response.status === 429 && rate429Attempt < opts.rate_limit_retries) {
|
|
108
|
+
const retryAfterMs = parseRetryAfter(response.headers.get("retry-after"));
|
|
109
|
+
const backoffMs = Math.min(
|
|
110
|
+
opts.retry_delay * 2 ** rate429Attempt,
|
|
111
|
+
opts.rate_limit_max_delay_ms,
|
|
112
|
+
);
|
|
113
|
+
const waitMs = Math.min(retryAfterMs ?? backoffMs, opts.rate_limit_max_delay_ms);
|
|
114
|
+
rate429Attempt++;
|
|
115
|
+
// Drain body so the connection can be reused
|
|
116
|
+
await response.text().catch(() => undefined);
|
|
117
|
+
await Bun.sleep(waitMs);
|
|
118
|
+
continue;
|
|
119
|
+
}
|
|
120
|
+
|
|
46
121
|
const bodyText = await response.text();
|
|
47
122
|
let body_parsed: unknown = undefined;
|
|
48
123
|
const contentType = response.headers.get("content-type") ?? "";
|
|
@@ -69,11 +144,44 @@ export async function executeRequest(
|
|
|
69
144
|
headers[k] = v;
|
|
70
145
|
});
|
|
71
146
|
|
|
72
|
-
|
|
147
|
+
// Feed ratelimit-* headers back into the limiter so it can pause the
|
|
148
|
+
// stream proactively when the window is nearly exhausted (TASK-81).
|
|
149
|
+
if (opts.rate_limiter?.note) {
|
|
150
|
+
const meta = parseRateLimitHeaders(headers);
|
|
151
|
+
if (meta.remaining !== undefined || meta.reset !== undefined) {
|
|
152
|
+
opts.rate_limiter.note(meta);
|
|
153
|
+
}
|
|
154
|
+
}
|
|
155
|
+
|
|
156
|
+
return {
|
|
157
|
+
status: response.status,
|
|
158
|
+
headers,
|
|
159
|
+
body: bodyText,
|
|
160
|
+
body_parsed,
|
|
161
|
+
duration_ms,
|
|
162
|
+
network_retry_count: networkRetryCount,
|
|
163
|
+
};
|
|
73
164
|
} catch (err) {
|
|
74
165
|
lastError = err instanceof Error ? err : new Error(String(err));
|
|
166
|
+
const isNet = isTransientNetworkError(lastError);
|
|
167
|
+
// TASK-144 path: dedicated network-retry budget with exp+jitter backoff.
|
|
168
|
+
if (isNet && networkRetryCount < opts.network_retries) {
|
|
169
|
+
const wait = networkBackoffMs(
|
|
170
|
+
networkRetryCount,
|
|
171
|
+
opts.network_retry_base_ms,
|
|
172
|
+
opts.network_retry_max_delay_ms,
|
|
173
|
+
);
|
|
174
|
+
networkRetryCount++;
|
|
175
|
+
await Bun.sleep(wait);
|
|
176
|
+
continue;
|
|
177
|
+
}
|
|
178
|
+
// Legacy linear path (yaml suite.config.retries).
|
|
179
|
+
if (networkAttempt < opts.retries) {
|
|
180
|
+
networkAttempt++;
|
|
181
|
+
await Bun.sleep(opts.retry_delay);
|
|
182
|
+
continue;
|
|
183
|
+
}
|
|
184
|
+
throw lastError;
|
|
75
185
|
}
|
|
76
186
|
}
|
|
77
|
-
|
|
78
|
-
throw lastError!;
|
|
79
187
|
}
|
|
@@ -0,0 +1,293 @@
|
|
|
1
|
+
import { readFile, writeFile, mkdir } from "node:fs/promises";
|
|
2
|
+
import { dirname } from "node:path";
|
|
3
|
+
import type { TestRunResult, AssertionResult, StepResult } from "./types.ts";
|
|
4
|
+
|
|
5
|
+
export interface DriftCase {
|
|
6
|
+
suite_name: string;
|
|
7
|
+
suite_file?: string;
|
|
8
|
+
step_name: string;
|
|
9
|
+
method?: string;
|
|
10
|
+
path?: string;
|
|
11
|
+
expected: number;
|
|
12
|
+
observed: number;
|
|
13
|
+
schema_validated: boolean;
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* Detect status-code drift cases: step would have passed if `expect.status`
|
|
18
|
+
* matched the observed status, every body/header assertion is green, and the
|
|
19
|
+
* response body matches the OpenAPI schema (no `kind: schema` failures).
|
|
20
|
+
*
|
|
21
|
+
* Skipped on purpose:
|
|
22
|
+
* - `error` steps (network/transport — not a drift signal)
|
|
23
|
+
* - `expect.status` arrays (`one of [...]`) — drift only triggers on a single
|
|
24
|
+
* expected value; arrays already encode tolerance
|
|
25
|
+
* - steps without `kind: schema` evidence — treated as drift_without_schema
|
|
26
|
+
* and surfaced separately to the caller via `schema_validated: false`
|
|
27
|
+
*/
|
|
28
|
+
export interface DetectOptions {
|
|
29
|
+
/** True when the run was launched with a schema validator attached. The
|
|
30
|
+
* validator produces no assertions on success, so step.assertions alone
|
|
31
|
+
* can't distinguish "schema ok" from "no validator". */
|
|
32
|
+
schemaValidatorAttached: boolean;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
export function detectStatusDrifts(results: TestRunResult[], opts: DetectOptions = { schemaValidatorAttached: false }): DriftCase[] {
|
|
36
|
+
const cases: DriftCase[] = [];
|
|
37
|
+
for (const r of results) {
|
|
38
|
+
for (const step of r.steps) {
|
|
39
|
+
const drift = classifyStep(step, opts);
|
|
40
|
+
if (!drift) continue;
|
|
41
|
+
cases.push({
|
|
42
|
+
suite_name: r.suite_name,
|
|
43
|
+
suite_file: r.suite_file,
|
|
44
|
+
step_name: step.name,
|
|
45
|
+
method: step.request?.method,
|
|
46
|
+
path: extractPathFromUrl(step.request?.url),
|
|
47
|
+
expected: drift.expected,
|
|
48
|
+
observed: drift.observed,
|
|
49
|
+
schema_validated: drift.schemaValidated,
|
|
50
|
+
});
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
return cases;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
interface StepDrift {
|
|
57
|
+
expected: number;
|
|
58
|
+
observed: number;
|
|
59
|
+
schemaValidated: boolean;
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
function classifyStep(step: StepResult, opts: DetectOptions): StepDrift | null {
|
|
63
|
+
if (step.status !== "fail") return null;
|
|
64
|
+
if (!step.response) return null;
|
|
65
|
+
|
|
66
|
+
const statusFails = step.assertions.filter(
|
|
67
|
+
a => a.field === "status" && !a.passed && typeof a.rule === "string" && a.rule.startsWith("equals "),
|
|
68
|
+
);
|
|
69
|
+
if (statusFails.length !== 1) return null;
|
|
70
|
+
|
|
71
|
+
const otherFails = step.assertions.filter(a => !a.passed && a !== statusFails[0]);
|
|
72
|
+
if (otherFails.length > 0) return null;
|
|
73
|
+
|
|
74
|
+
const expected = parseExpected(statusFails[0]!);
|
|
75
|
+
if (expected === null) return null;
|
|
76
|
+
|
|
77
|
+
const observed = step.response.status;
|
|
78
|
+
if (expected === observed) return null;
|
|
79
|
+
|
|
80
|
+
// Schema validation evidence — when the validator was attached, assertions
|
|
81
|
+
// contain `kind: "schema"` entries on failure and nothing on success. So
|
|
82
|
+
// "validator attached AND no failing schema assertion" is the success case.
|
|
83
|
+
const schemaFails = step.assertions.filter(a => a.kind === "schema" && !a.passed);
|
|
84
|
+
if (schemaFails.length > 0) return null; // body diverges from spec — not a drift
|
|
85
|
+
const schemaValidated = opts.schemaValidatorAttached;
|
|
86
|
+
|
|
87
|
+
return { expected, observed, schemaValidated };
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
function parseExpected(a: AssertionResult): number | null {
|
|
91
|
+
if (typeof a.expected === "number") return a.expected;
|
|
92
|
+
if (typeof a.expected === "string") {
|
|
93
|
+
const n = Number(a.expected);
|
|
94
|
+
return Number.isFinite(n) ? n : null;
|
|
95
|
+
}
|
|
96
|
+
return null;
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
function extractPathFromUrl(url: string | undefined): string | undefined {
|
|
100
|
+
if (!url) return undefined;
|
|
101
|
+
try {
|
|
102
|
+
return new URL(url).pathname;
|
|
103
|
+
} catch {
|
|
104
|
+
return url;
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
export function formatDriftPlan(cases: DriftCase[]): string {
|
|
109
|
+
if (cases.length === 0) return "No status-code drift detected.\n";
|
|
110
|
+
const lines: string[] = [];
|
|
111
|
+
lines.push(`Drift detected (${cases.length} case${cases.length === 1 ? "" : "s"}):`);
|
|
112
|
+
for (const c of cases) {
|
|
113
|
+
const ep = `${c.method ?? "?"} ${c.path ?? "?"}`.padEnd(40);
|
|
114
|
+
const schema = c.schema_validated ? "body-schema=ok" : "body-schema=unverified";
|
|
115
|
+
lines.push(` ${ep} spec=${c.expected} observed=${c.observed} ${schema} → suggest: update test, or add to drifts`);
|
|
116
|
+
}
|
|
117
|
+
lines.push("");
|
|
118
|
+
lines.push("Run with --learn-apply --learn-target=test to rewrite expect.status in YAML");
|
|
119
|
+
lines.push("Run with --learn-apply --learn-target=drifts to record in apis/<name>/tolerated-drifts.yaml");
|
|
120
|
+
return lines.join("\n") + "\n";
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
export interface ApplyResult {
|
|
124
|
+
updated: number;
|
|
125
|
+
errors: { suite_file: string; step_name: string; reason: string }[];
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
/**
|
|
129
|
+
* Rewrite `expect.status: <expected>` → `<observed>` in each suite file.
|
|
130
|
+
*
|
|
131
|
+
* Implementation is line-based: locate the step block by `name:`, then scan
|
|
132
|
+
* forward until the next sibling step or dedent looking for the first
|
|
133
|
+
* `status:` line at a deeper indent. We don't reparse the YAML — preserves
|
|
134
|
+
* comments, key order, and trailing whitespace so the diff is minimal.
|
|
135
|
+
*/
|
|
136
|
+
export async function applyDriftsToTests(cases: DriftCase[]): Promise<ApplyResult> {
|
|
137
|
+
const result: ApplyResult = { updated: 0, errors: [] };
|
|
138
|
+
|
|
139
|
+
// Group by file — read once, write once per file.
|
|
140
|
+
const byFile = new Map<string, DriftCase[]>();
|
|
141
|
+
for (const c of cases) {
|
|
142
|
+
if (!c.suite_file) {
|
|
143
|
+
result.errors.push({ suite_file: "<unknown>", step_name: c.step_name, reason: "suite_file missing" });
|
|
144
|
+
continue;
|
|
145
|
+
}
|
|
146
|
+
const list = byFile.get(c.suite_file) ?? [];
|
|
147
|
+
list.push(c);
|
|
148
|
+
byFile.set(c.suite_file, list);
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
for (const [file, fileCases] of byFile) {
|
|
152
|
+
let content: string;
|
|
153
|
+
try {
|
|
154
|
+
content = await readFile(file, "utf-8");
|
|
155
|
+
} catch (err) {
|
|
156
|
+
for (const c of fileCases) {
|
|
157
|
+
result.errors.push({ suite_file: file, step_name: c.step_name, reason: `read failed: ${(err as Error).message}` });
|
|
158
|
+
}
|
|
159
|
+
continue;
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
let lines = content.split("\n");
|
|
163
|
+
let touched = false;
|
|
164
|
+
for (const c of fileCases) {
|
|
165
|
+
const edited = rewriteExpectStatus(lines, c.step_name, c.expected, c.observed);
|
|
166
|
+
if (edited.ok) {
|
|
167
|
+
lines = edited.lines;
|
|
168
|
+
touched = true;
|
|
169
|
+
result.updated++;
|
|
170
|
+
} else {
|
|
171
|
+
result.errors.push({ suite_file: file, step_name: c.step_name, reason: edited.reason });
|
|
172
|
+
}
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
if (touched) {
|
|
176
|
+
try {
|
|
177
|
+
await writeFile(file, lines.join("\n"), "utf-8");
|
|
178
|
+
} catch (err) {
|
|
179
|
+
for (const c of fileCases) {
|
|
180
|
+
result.errors.push({ suite_file: file, step_name: c.step_name, reason: `write failed: ${(err as Error).message}` });
|
|
181
|
+
}
|
|
182
|
+
}
|
|
183
|
+
}
|
|
184
|
+
}
|
|
185
|
+
|
|
186
|
+
return result;
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
function rewriteExpectStatus(
|
|
190
|
+
lines: string[],
|
|
191
|
+
stepName: string,
|
|
192
|
+
expected: number,
|
|
193
|
+
observed: number,
|
|
194
|
+
): { ok: true; lines: string[] } | { ok: false; reason: string } {
|
|
195
|
+
// Match `- name: foo` or `- name: "foo"` — capture indent of the dash so we
|
|
196
|
+
// know where the step block ends.
|
|
197
|
+
const nameRe = new RegExp(`^(\\s*)-\\s+name:\\s+["']?${escapeRegExp(stepName)}["']?\\s*$`);
|
|
198
|
+
let stepStart = -1;
|
|
199
|
+
let stepIndent = 0;
|
|
200
|
+
for (let i = 0; i < lines.length; i++) {
|
|
201
|
+
const m = lines[i]!.match(nameRe);
|
|
202
|
+
if (m) {
|
|
203
|
+
stepStart = i;
|
|
204
|
+
stepIndent = m[1]!.length;
|
|
205
|
+
break;
|
|
206
|
+
}
|
|
207
|
+
}
|
|
208
|
+
if (stepStart < 0) return { ok: false, reason: `step "${stepName}" not found in YAML` };
|
|
209
|
+
|
|
210
|
+
// Step block ends at next sibling (`- name:` at the same indent) or at the
|
|
211
|
+
// first line that dedents past the step's column.
|
|
212
|
+
let stepEnd = lines.length;
|
|
213
|
+
for (let i = stepStart + 1; i < lines.length; i++) {
|
|
214
|
+
const line = lines[i]!;
|
|
215
|
+
if (line.trim() === "") continue;
|
|
216
|
+
const indent = line.match(/^(\s*)/)![1]!.length;
|
|
217
|
+
if (indent <= stepIndent) {
|
|
218
|
+
stepEnd = i;
|
|
219
|
+
break;
|
|
220
|
+
}
|
|
221
|
+
}
|
|
222
|
+
|
|
223
|
+
const statusRe = new RegExp(`^(\\s*)status:\\s*${expected}\\s*(#.*)?$`);
|
|
224
|
+
for (let i = stepStart + 1; i < stepEnd; i++) {
|
|
225
|
+
const m = lines[i]!.match(statusRe);
|
|
226
|
+
if (m) {
|
|
227
|
+
const tail = m[2] ? ` ${m[2]}` : "";
|
|
228
|
+
lines[i] = `${m[1]}status: ${observed}${tail}`;
|
|
229
|
+
return { ok: true, lines };
|
|
230
|
+
}
|
|
231
|
+
}
|
|
232
|
+
return { ok: false, reason: `expect.status: ${expected} not found within step "${stepName}"` };
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
function escapeRegExp(s: string): string {
|
|
236
|
+
return s.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
/**
|
|
240
|
+
* Append drift cases to `<apiDir>/tolerated-drifts.yaml`. The file is a flat
|
|
241
|
+
* `drifts:` list; we de-duplicate on (method, path, expected, observed).
|
|
242
|
+
*
|
|
243
|
+
* Format kept intentionally minimal — runner-side enforcement (skip the
|
|
244
|
+
* status assertion when a tolerated drift matches) is a follow-up task; this
|
|
245
|
+
* call just records the data so a human can review.
|
|
246
|
+
*/
|
|
247
|
+
export async function appendToleratedDrifts(apiDir: string, cases: DriftCase[]): Promise<{ written: number; file: string }> {
|
|
248
|
+
const file = `${apiDir}/tolerated-drifts.yaml`;
|
|
249
|
+
let existing = "";
|
|
250
|
+
try {
|
|
251
|
+
existing = await readFile(file, "utf-8");
|
|
252
|
+
} catch {
|
|
253
|
+
// new file — keep empty
|
|
254
|
+
}
|
|
255
|
+
|
|
256
|
+
const seen = new Set<string>();
|
|
257
|
+
const driftRe = /^\s*-\s*method:\s*(\w+)\s*$\n\s*path:\s*(\S+)\s*$\n\s*expected:\s*(\d+)\s*$\n\s*observed:\s*(\d+)/gm;
|
|
258
|
+
let m: RegExpExecArray | null;
|
|
259
|
+
while ((m = driftRe.exec(existing)) !== null) {
|
|
260
|
+
seen.add(`${m[1]!.toUpperCase()} ${m[2]} ${m[3]}->${m[4]}`);
|
|
261
|
+
}
|
|
262
|
+
|
|
263
|
+
const fresh: DriftCase[] = [];
|
|
264
|
+
for (const c of cases) {
|
|
265
|
+
const key = `${(c.method ?? "?").toUpperCase()} ${c.path ?? "?"} ${c.expected}->${c.observed}`;
|
|
266
|
+
if (seen.has(key)) continue;
|
|
267
|
+
seen.add(key);
|
|
268
|
+
fresh.push(c);
|
|
269
|
+
}
|
|
270
|
+
|
|
271
|
+
if (fresh.length === 0) return { written: 0, file };
|
|
272
|
+
|
|
273
|
+
let body = existing;
|
|
274
|
+
if (!/^drifts:\s*$/m.test(body)) {
|
|
275
|
+
body = body.trim();
|
|
276
|
+
if (body.length > 0) body += "\n";
|
|
277
|
+
body += "drifts:\n";
|
|
278
|
+
} else if (!body.endsWith("\n")) {
|
|
279
|
+
body += "\n";
|
|
280
|
+
}
|
|
281
|
+
|
|
282
|
+
for (const c of fresh) {
|
|
283
|
+
body += ` - method: ${c.method ?? "?"}\n`;
|
|
284
|
+
body += ` path: ${c.path ?? "?"}\n`;
|
|
285
|
+
body += ` expected: ${c.expected}\n`;
|
|
286
|
+
body += ` observed: ${c.observed}\n`;
|
|
287
|
+
body += ` note: ""\n`;
|
|
288
|
+
}
|
|
289
|
+
|
|
290
|
+
await mkdir(dirname(file), { recursive: true });
|
|
291
|
+
await writeFile(file, body, "utf-8");
|
|
292
|
+
return { written: fresh.length, file };
|
|
293
|
+
}
|
|
@@ -0,0 +1,149 @@
|
|
|
1
|
+
import type { TestSuite, TestStep, AssertionRule } from "../parser/types.ts";
|
|
2
|
+
import { GENERATORS } from "../parser/variables.ts";
|
|
3
|
+
|
|
4
|
+
const VAR_PATTERN = /\{\{([^{}]+)\}\}/g;
|
|
5
|
+
|
|
6
|
+
function scanRefs(value: unknown, out: Set<string>): void {
|
|
7
|
+
if (typeof value === "string") {
|
|
8
|
+
for (const match of value.matchAll(VAR_PATTERN)) {
|
|
9
|
+
const key = match[1]!.trim();
|
|
10
|
+
if (!key.startsWith("$")) out.add(key);
|
|
11
|
+
}
|
|
12
|
+
} else if (Array.isArray(value)) {
|
|
13
|
+
for (const item of value) scanRefs(item, out);
|
|
14
|
+
} else if (typeof value === "object" && value !== null) {
|
|
15
|
+
for (const v of Object.values(value)) scanRefs(v, out);
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
function collectCapturesAndSets(step: TestStep, out: Set<string>): void {
|
|
20
|
+
if (step.set) {
|
|
21
|
+
for (const k of Object.keys(step.set)) out.add(k);
|
|
22
|
+
}
|
|
23
|
+
if (step.for_each?.var) out.add(step.for_each.var);
|
|
24
|
+
const scanRule = (rule: AssertionRule | undefined): void => {
|
|
25
|
+
if (!rule) return;
|
|
26
|
+
if (rule.capture) out.add(rule.capture);
|
|
27
|
+
if (rule.each) {
|
|
28
|
+
for (const r of Object.values(rule.each)) scanRule(r);
|
|
29
|
+
}
|
|
30
|
+
if (rule.contains_item) {
|
|
31
|
+
for (const r of Object.values(rule.contains_item)) scanRule(r);
|
|
32
|
+
}
|
|
33
|
+
};
|
|
34
|
+
if (step.expect?.body) {
|
|
35
|
+
for (const r of Object.values(step.expect.body)) scanRule(r);
|
|
36
|
+
}
|
|
37
|
+
if (step.expect?.headers) {
|
|
38
|
+
for (const v of Object.values(step.expect.headers)) {
|
|
39
|
+
if (typeof v === "object" && v !== null) scanRule(v as AssertionRule);
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
export interface MissingVarHit {
|
|
45
|
+
suite: string;
|
|
46
|
+
file?: string;
|
|
47
|
+
step?: string;
|
|
48
|
+
variable: string;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* Pre-flight scan: find {{var}} references in suites that have no producer
|
|
53
|
+
* (env value, suite-level parameterize/set, prior-step capture). Excludes
|
|
54
|
+
* built-in $generators.
|
|
55
|
+
*
|
|
56
|
+
* Conservative: per-suite — accumulates all captures/sets across steps, so
|
|
57
|
+
* forward references inside the suite are tolerated (correctness requires
|
|
58
|
+
* runtime ordering checks anyway).
|
|
59
|
+
*/
|
|
60
|
+
export function preflightCheckVars(
|
|
61
|
+
suites: TestSuite[],
|
|
62
|
+
env: Record<string, string>,
|
|
63
|
+
): MissingVarHit[] {
|
|
64
|
+
const hits: MissingVarHit[] = [];
|
|
65
|
+
const generatorKeys = new Set(Object.keys(GENERATORS));
|
|
66
|
+
|
|
67
|
+
for (const suite of suites) {
|
|
68
|
+
const known = new Set<string>(Object.keys(env));
|
|
69
|
+
if (suite.parameterize) {
|
|
70
|
+
for (const k of Object.keys(suite.parameterize)) known.add(k);
|
|
71
|
+
}
|
|
72
|
+
for (const step of suite.tests) collectCapturesAndSets(step, known);
|
|
73
|
+
|
|
74
|
+
const scanStepRefs = (step: TestStep): Set<string> => {
|
|
75
|
+
const refs = new Set<string>();
|
|
76
|
+
scanRefs(step.path, refs);
|
|
77
|
+
scanRefs(step.headers, refs);
|
|
78
|
+
scanRefs(step.json, refs);
|
|
79
|
+
scanRefs(step.form, refs);
|
|
80
|
+
scanRefs(step.multipart, refs);
|
|
81
|
+
scanRefs(step.query, refs);
|
|
82
|
+
if (step.skip_if) scanRefs(step.skip_if, refs);
|
|
83
|
+
if (step.retry_until) scanRefs(step.retry_until.condition, refs);
|
|
84
|
+
if (step.set) scanRefs(step.set, refs);
|
|
85
|
+
if (step.for_each) scanRefs(step.for_each.in, refs);
|
|
86
|
+
return refs;
|
|
87
|
+
};
|
|
88
|
+
|
|
89
|
+
const suiteRefs = new Set<string>();
|
|
90
|
+
if (suite.base_url) scanRefs(suite.base_url, suiteRefs);
|
|
91
|
+
if (suite.headers) scanRefs(suite.headers, suiteRefs);
|
|
92
|
+
for (const v of suiteRefs) {
|
|
93
|
+
if (!known.has(v) && !generatorKeys.has(v)) {
|
|
94
|
+
hits.push({ suite: suite.name, file: suite.filePath, variable: v });
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
for (const step of suite.tests) {
|
|
99
|
+
const refs = scanStepRefs(step);
|
|
100
|
+
for (const v of refs) {
|
|
101
|
+
if (!known.has(v) && !generatorKeys.has(v)) {
|
|
102
|
+
hits.push({
|
|
103
|
+
suite: suite.name,
|
|
104
|
+
file: suite.filePath,
|
|
105
|
+
step: step.name,
|
|
106
|
+
variable: v,
|
|
107
|
+
});
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
return hits;
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
export function formatMissingVarLine(hit: MissingVarHit): string {
|
|
117
|
+
const where = hit.step ? `${hit.suite} → ${hit.step}` : hit.suite;
|
|
118
|
+
const file = hit.file ? ` (${hit.file})` : "";
|
|
119
|
+
return `Undefined variable {{${hit.variable}}} in ${where}${file}`;
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
/**
|
|
123
|
+
* TASK-248: collapse per-(suite,step,variable) hits into one summary line per
|
|
124
|
+
* unique variable. When the same {{var}} is referenced in 8–12 places (typical
|
|
125
|
+
* when running outside a workspace and `.env.yaml` is missing), per-hit emit
|
|
126
|
+
* spams stderr — the aggregated form keeps signal (the *names* of the missing
|
|
127
|
+
* vars) while dropping noise.
|
|
128
|
+
*/
|
|
129
|
+
export function summarizeMissingVars(hits: MissingVarHit[]): string[] {
|
|
130
|
+
if (hits.length === 0) return [];
|
|
131
|
+
const byVar = new Map<string, { refs: number; suites: Set<string> }>();
|
|
132
|
+
for (const h of hits) {
|
|
133
|
+
let entry = byVar.get(h.variable);
|
|
134
|
+
if (!entry) {
|
|
135
|
+
entry = { refs: 0, suites: new Set() };
|
|
136
|
+
byVar.set(h.variable, entry);
|
|
137
|
+
}
|
|
138
|
+
entry.refs++;
|
|
139
|
+
entry.suites.add(h.suite);
|
|
140
|
+
}
|
|
141
|
+
const names = [...byVar.keys()].sort();
|
|
142
|
+
const totalRefs = hits.length;
|
|
143
|
+
const totalSuites = new Set(hits.map((h) => h.suite)).size;
|
|
144
|
+
const head = names.slice(0, 6).map((n) => `{{${n}}}`).join(", ");
|
|
145
|
+
const tail = names.length > 6 ? `, … and ${names.length - 6} more` : "";
|
|
146
|
+
return [
|
|
147
|
+
`Undefined variables: ${head}${tail} (${totalRefs} reference${totalRefs === 1 ? "" : "s"} across ${totalSuites} suite${totalSuites === 1 ? "" : "s"})`,
|
|
148
|
+
];
|
|
149
|
+
}
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* ARV-249: lightweight progress tracker for `zond run`. A separate module
|
|
3
|
+
* so the formatter can be unit-tested without spinning up an executor.
|
|
4
|
+
*
|
|
5
|
+
* Architecture: run.ts owns the tracker + `setInterval`. Every completed
|
|
6
|
+
* step calls `tracker.recordStep(...)` via `RunSuiteOptions.onStepDone`,
|
|
7
|
+
* the interval ticks every PROGRESS_INTERVAL_MS and writes one stderr
|
|
8
|
+
* line, and run.ts clears the interval before printing the final report.
|
|
9
|
+
*/
|
|
10
|
+
import { formatEta } from "../util/format-eta.ts";
|
|
11
|
+
import type { StepResult } from "./types.ts";
|
|
12
|
+
|
|
13
|
+
export const PROGRESS_INTERVAL_MS = 5000;
|
|
14
|
+
/** Wait this long before emitting the first progress line. Short runs
|
|
15
|
+
* that finish under the threshold stay silent. */
|
|
16
|
+
export const PROGRESS_QUIET_MS = 5000;
|
|
17
|
+
|
|
18
|
+
export interface ProgressSnapshot {
|
|
19
|
+
elapsedMs: number;
|
|
20
|
+
completedSteps: number;
|
|
21
|
+
totalSteps: number;
|
|
22
|
+
httpRequests: number;
|
|
23
|
+
effectiveRps: number;
|
|
24
|
+
etaSeconds: number;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
export class ProgressTracker {
|
|
28
|
+
private completedSteps = 0;
|
|
29
|
+
private httpRequests = 0;
|
|
30
|
+
private readonly startedAt: number;
|
|
31
|
+
|
|
32
|
+
constructor(private readonly totalSteps: number, now: number = Date.now()) {
|
|
33
|
+
this.startedAt = now;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
recordStep(step: StepResult): void {
|
|
37
|
+
this.completedSteps += 1;
|
|
38
|
+
if (step.status !== "skip" && step.response !== undefined) {
|
|
39
|
+
this.httpRequests += 1;
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
snapshot(now: number = Date.now()): ProgressSnapshot {
|
|
44
|
+
const elapsedMs = Math.max(0, now - this.startedAt);
|
|
45
|
+
const elapsedSec = elapsedMs / 1000;
|
|
46
|
+
const effectiveRps = elapsedSec > 0 ? this.httpRequests / elapsedSec : 0;
|
|
47
|
+
const remaining = Math.max(0, this.totalSteps - this.completedSteps);
|
|
48
|
+
const stepRate = elapsedSec > 0 ? this.completedSteps / elapsedSec : 0;
|
|
49
|
+
const etaSeconds = stepRate > 0 ? remaining / stepRate : Infinity;
|
|
50
|
+
return {
|
|
51
|
+
elapsedMs,
|
|
52
|
+
completedSteps: this.completedSteps,
|
|
53
|
+
totalSteps: this.totalSteps,
|
|
54
|
+
httpRequests: this.httpRequests,
|
|
55
|
+
effectiveRps,
|
|
56
|
+
etaSeconds,
|
|
57
|
+
};
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
/** Format a progress snapshot for stderr. Stable wording — agents may
|
|
62
|
+
* grep the line. */
|
|
63
|
+
export function formatProgressLine(snap: ProgressSnapshot): string {
|
|
64
|
+
const elapsed = formatEta(snap.elapsedMs / 1000);
|
|
65
|
+
const pct = snap.totalSteps > 0
|
|
66
|
+
? Math.min(100, Math.floor((snap.completedSteps / snap.totalSteps) * 100))
|
|
67
|
+
: 0;
|
|
68
|
+
const rps = snap.effectiveRps >= 10
|
|
69
|
+
? Math.round(snap.effectiveRps).toString()
|
|
70
|
+
: snap.effectiveRps.toFixed(1);
|
|
71
|
+
const eta = Number.isFinite(snap.etaSeconds) ? formatEta(snap.etaSeconds) : "?";
|
|
72
|
+
return `zond: [${elapsed}] ${snap.completedSteps}/${snap.totalSteps} steps (${pct}%), ${snap.httpRequests} req, ~${rps} req/s, ETA ${eta}`;
|
|
73
|
+
}
|