Viewing files at commit f2acb751aa96Commit detailsView latest

scripts/oakbench/rows.py 404 lines · 14.4 KB · python
1
"""The row contract: canonical accessors and per-lane validation.
2
3
A Row is one JSONL object for one measured operation — the durable source of
4
truth (CONTEXT.md). This module is the single definition of how consumers read
5
the best-available token/tool/output values from any lane's rows, and of what
6
every lane's emitter must include. ResultsStore validates at write time, so a
7
contract violation fails the producing run instead of corrupting a dashboard.
8
9
Null means unmeasured (ADR-0002): validation checks presence and types, and
10
treats null as a legitimate value wherever a signal is probe-dependent.
11
"""
12
13
from __future__ import annotations
14
15
import math
16
from typing import Any, Optional
17
18
LANES = ("core", "workflow", "agent", "contention", "mount", "task-loop", "platform", "robustness")
19
20
# Required top-level keys per lane. Deliberately the intersection that every
21
# row of the lane carries — including diagnostic rows (determinism probes,
22
# skip rows), which is why token fields are not required at this layer.
23
LANE_REQUIRED_KEYS: dict[str, tuple[str, ...]] = {
24
    "core": (
25
        "bench_id",
26
        "profile",
27
        "scenario",
28
        "operation",
29
        "run",
30
        "subject",
31
        "subject_kind",
32
        "elapsed_ms",
33
        "returncode",
34
        "command",
35
    ),
36
    "workflow": (
37
        "bench_id",
38
        "profile",
39
        "scenario",
40
        "workflow",
41
        "phase",
42
        "operation",
43
        "run",
44
        "subject",
45
        "subject_kind",
46
        "elapsed_ms",
47
        "returncode",
48
        "process_returncode",
49
        "command",
50
    ),
51
    "agent": (
52
        "schema_version",
53
        "bench_id",
54
        "scenario",
55
        "operation",
56
        "run",
57
        "subject",
58
        "subject_kind",
59
        "elapsed_ms",
60
        "returncode",
61
        "token_metrics",
62
        "turn_metrics",
63
        "tool_call_metrics",
64
    ),
65
    "contention": (
66
        "bench_id",
67
        "profile",
68
        "scenario",
69
        "contention_mode",
70
        "workers",
71
        "operation",
72
        "run",
73
        "subject",
74
        "subject_kind",
75
        "elapsed_ms",
76
        "returncode",
77
    ),
78
    "mount": (
79
        "bench_id",
80
        "profile",
81
        "scenario",
82
        "operation",
83
        "run",
84
        "subject",
85
        "elapsed_ms",
86
        "returncode",
87
    ),
88
    "task-loop": (
89
        "bench_id",
90
        "profile",
91
        "scenario",
92
        "operation",
93
        "run",
94
        "subject",
95
        "subject_kind",
96
        "elapsed_ms",
97
        "returncode",
98
        "command",
99
    ),
100
    # Platform lane: hosted-workflow rows are only comparable when both sides
101
    # ran the same semantics class under the same protection variant, so that
102
    # fairness context is part of every row — including skip rows. Runner
103
    # identity (ADR-0007) is required because this lane measures network
104
    # services from a specific vantage point.
105
    "platform": (
106
        "bench_id",
107
        "profile",
108
        "scenario",
109
        "operation",
110
        "run",
111
        "platform",
112
        "driver",
113
        "platform_semantics_version",
114
        "platform_semantics_class",
115
        "protection_variant",
116
        "platform_comparison_key",
117
        "semantic_contract_match",
118
        "elapsed_ms",
119
        "returncode",
120
        "command",
121
        "runner_id",
122
        "runner_class",
123
    ),
124
    # Robustness lane (suites/robustness): one row per fault case, judged by
125
    # independent readers. classification is held | violated | unsupported |
126
    # harness_error; unsupported cases are skip rows (returncode 77).
127
    "robustness": (
128
        "bench_id",
129
        "scenario",
130
        "operation",
131
        "run",
132
        "subject",
133
        "subject_kind",
134
        "elapsed_ms",
135
        "returncode",
136
        "classification",
137
        "fault_family",
138
        "fault_point",
139
    ),
140
}
141
142
NUMERIC_KEYS = ("elapsed_ms",)
143
INTEGER_KEYS = ("returncode", "run")
144
SKIP_RETURNCODE = 77
145
146
# Optional metrics with constrained types/ranges when present. None is always
147
# legal (ADR-0002); a present value must be well-formed so consumers never
148
# need defensive parsing of the durable format.
149
OPTIONAL_NON_NEGATIVE_INT_KEYS = (
150
    "peak_rss_bytes",
151
    "tool_call_count",
152
    "probe_output_bytes",
153
    "changed_files_expected",
154
    "changed_files_recovered",
155
    "changed_files_reported",
156
    "changed_files_false_positive",
157
    "first_payload_bytes_server_to_client",
158
    "poll_iterations",
159
    "false_close_count",
160
    "close_eligible_n",
161
    "false_vcs_merge_safe_count",
162
    "vcs_merge_safe_n",
163
    "false_merge_allowed_count",
164
    "merge_allowed_n",
165
    "branches_scored",
166
    "branches_expected",
167
)
168
OPTIONAL_NON_NEGATIVE_NUMBER_KEYS = (
169
    "ttfd_ms",
170
    "observed_wait_ms",
171
    "settle_elapsed_ms",
172
    "poll_interval_s",
173
    "poll_quantization_ms",
174
    "status_post_elapsed_ms",
175
    "pacing_injected_ms",
176
)
177
OPTIONAL_UNIT_INTERVAL_KEYS = ("information_recall", "information_precision", "triage_recall", "triage_precision")
178
OPTIONAL_STRING_KEYS = (
179
    "runner_id",
180
    "runner_class",
181
    "fixture_id",
182
    "fixture_generator",
183
    "fixture_version",
184
    "fixture_seed",
185
    "fixture_manifest_sha256",
186
    "binary_sha256",
187
    "env_isolation_version",
188
    "platform_semantics_version",
189
    "platform_semantics_class",
190
    "protection_variant",
191
    "platform_comparison_key",
192
)
193
OPTIONAL_OBJECT_KEYS = ("runner_profile",)
194
195
196
class RowContractViolation(SystemExit):
197
    """Raised after rows are persisted; fails the producing run loudly."""
198
199
200
def validate_rows(rows: list[dict[str, Any]], lane: str) -> list[str]:
201
    if lane not in LANE_REQUIRED_KEYS:
202
        return [f"unknown lane {lane!r}; known: {', '.join(LANES)}"]
203
    required = LANE_REQUIRED_KEYS[lane]
204
    errors: list[str] = []
205
    for index, row in enumerate(rows, 1):
206
        if not isinstance(row, dict):
207
            errors.append(f"row {index}: expected object, got {type(row).__name__}")
208
            continue
209
        for key in required:
210
            if key not in row:
211
                errors.append(f"row {index} ({row.get('operation', '?')}): missing required key {key!r}")
212
        for key in NUMERIC_KEYS:
213
            value = row.get(key)
214
            diagnostic_timing = (lane == "core" and key == "elapsed_ms" and value is None
215
                and row.get("measurement_phase") == "output_diagnostic"
216
                and row.get("operation") in {
217
                    f"{operation}.{probe}" for operation in ("status.clean", "status.dirty", "diff.dirty", "diff.full")
218
                    for probe in ("inforecall", "determinism")})
219
            if diagnostic_timing:
220
                continue
221
            if key in row and (
222
                isinstance(value, bool)
223
                or not isinstance(value, (int, float))
224
                or not math.isfinite(float(value))
225
                or float(value) < 0
226
            ):
227
                errors.append(f"row {index}: {key} must be numeric, got {type(value).__name__}")
228
        for key in INTEGER_KEYS:
229
            value = row.get(key)
230
            if key in row and (isinstance(value, bool) or not isinstance(value, int)):
231
                errors.append(f"row {index}: {key} must be an integer, got {type(value).__name__}")
232
        for key in OPTIONAL_NON_NEGATIVE_INT_KEYS:
233
            value = row.get(key)
234
            if key in row and value is not None:
235
                if isinstance(value, bool) or not isinstance(value, int) or value < 0:
236
                    errors.append(f"row {index}: {key} must be a non-negative integer or null, got {value!r}")
237
        for key in OPTIONAL_NON_NEGATIVE_NUMBER_KEYS:
238
            value = row.get(key)
239
            if key in row and value is not None:
240
                if isinstance(value, bool) or not isinstance(value, (int, float)) or not math.isfinite(value) or value < 0:
241
                    errors.append(f"row {index}: {key} must be a non-negative finite number or null, got {value!r}")
242
        for key in OPTIONAL_UNIT_INTERVAL_KEYS:
243
            value = row.get(key)
244
            if key in row and value is not None:
245
                if not isinstance(value, (int, float)) or isinstance(value, bool) or not 0.0 <= float(value) <= 1.0:
246
                    errors.append(f"row {index}: {key} must be in [0, 1] or null, got {value!r}")
247
        for key in OPTIONAL_STRING_KEYS:
248
            value = row.get(key)
249
            if key in row and value is not None and not isinstance(value, str):
250
                errors.append(f"row {index}: {key} must be a string or null, got {type(value).__name__}")
251
        for key in OPTIONAL_OBJECT_KEYS:
252
            value = row.get(key)
253
            if key in row and value is not None and not isinstance(value, dict):
254
                errors.append(f"row {index}: {key} must be an object or null, got {type(value).__name__}")
255
        # Skip-row coherence: a skip is a recorded coverage gap, and consumers
256
        # key off both signals. Half-marked skips silently become failures
257
        # (or worse, successes) downstream.
258
        returncode = row.get("returncode")
259
        if returncode == SKIP_RETURNCODE:
260
            if not row.get("skipped"):
261
                errors.append(f"row {index} ({row.get('operation', '?')}): returncode 77 requires skipped: true")
262
            if not str(row.get("skip_reason") or "").strip():
263
                errors.append(f"row {index} ({row.get('operation', '?')}): skip rows require a non-empty skip_reason")
264
        elif row.get("skipped"):
265
            errors.append(
266
                f"row {index} ({row.get('operation', '?')}): skipped: true requires returncode {SKIP_RETURNCODE}"
267
            )
268
    return errors
269
270
271
def number_or_none(value: Any) -> Optional[float]:
272
    if value is None or isinstance(value, bool):
273
        return None
274
    try:
275
        parsed = float(value)
276
    except (TypeError, ValueError):
277
        return None
278
    if not math.isfinite(parsed):
279
        return None
280
    return parsed
281
282
283
def row_returncode(row: dict[str, Any]) -> int:
284
    """Row returncode with missing/null treated as failure, never a crash."""
285
    value = row.get("returncode")
286
    if value is None:
287
        return 1
288
    try:
289
        return int(value)
290
    except (TypeError, ValueError):
291
        return 1
292
293
294
def transcript_metrics_complete(row: dict[str, Any]) -> bool:
295
    source = row.get("source")
296
    execution = source.get("agent_execution") if isinstance(source, dict) else None
297
    is_agent = isinstance(row.get("agent"), dict) or str(row.get("operation", "")).startswith("agent.") or isinstance(execution, dict)
298
    return not ((is_agent and row.get("output_truncated") is True) or (isinstance(execution, dict) and
299
        (execution.get("usage_complete") is False or execution.get("transcript_metrics_complete") is False)))
300
301
302
def token_total(row: dict[str, Any]) -> Optional[float]:
303
    """Best-available token total for a row, preferring provider-reported usage."""
304
    if not transcript_metrics_complete(row):
305
        return None
306
    token_metrics = row.get("token_metrics")
307
    if isinstance(token_metrics, dict):
308
        value = number_or_none(token_metrics.get("total_tokens_reported"))
309
        if value is not None:
310
            return value
311
        reported_parts = [
312
            number_or_none(token_metrics.get("input_tokens_reported")),
313
            number_or_none(token_metrics.get("output_tokens_reported")),
314
            number_or_none(token_metrics.get("reasoning_tokens_reported")),
315
        ]
316
        if any(part is not None for part in reported_parts):
317
            return sum(part or 0.0 for part in reported_parts)
318
319
    for key in ("estimated_tokens_total", "token_count", "total_tokens"):
320
        value = number_or_none(row.get(key))
321
        if value is not None:
322
            return value
323
324
    token_estimate = row.get("token_estimate")
325
    if isinstance(token_estimate, dict):
326
        value = number_or_none(token_estimate.get("total"))
327
        if value is not None:
328
            return value
329
330
    tokens = row.get("tokens")
331
    if isinstance(tokens, dict):
332
        for key in ("total", "total_tokens", "provider_total", "estimated_total"):
333
            value = number_or_none(tokens.get(key))
334
            if value is not None:
335
                return value
336
        provider = tokens.get("provider_reported")
337
        if isinstance(provider, dict):
338
            value = number_or_none(provider.get("total"))
339
            if value is not None:
340
                return value
341
342
    if isinstance(token_metrics, dict):
343
        chars = number_or_none(token_metrics.get("transcript_chars"))
344
        if chars is None:
345
            input_chars = number_or_none(token_metrics.get("normalized_input_chars"))
346
            output_chars = number_or_none(token_metrics.get("normalized_output_chars"))
347
            if input_chars is not None or output_chars is not None:
348
                chars = (input_chars or 0.0) + (output_chars or 0.0)
349
        if chars is not None:
350
            return max(1.0, math.ceil(chars / 4.0))
351
    return None
352
353
354
def tool_calls(row: dict[str, Any]) -> Optional[float]:
355
    if not transcript_metrics_complete(row):
356
        return None
357
    for key in ("tool_call_count", "total_tool_calls"):
358
        value = number_or_none(row.get(key))
359
        if value is not None:
360
            return value
361
362
    nested = row.get("tool_calls")
363
    if isinstance(nested, dict):
364
        for key in ("total", "all"):
365
            value = number_or_none(nested.get(key))
366
            if value is not None:
367
                return value
368
369
    tool_call_metrics = row.get("tool_call_metrics")
370
    if isinstance(tool_call_metrics, dict):
371
        value = number_or_none(tool_call_metrics.get("tool_calls_total"))
372
        if value is not None:
373
            return value
374
    return None
375
376
377
def output_bytes(row: dict[str, Any]) -> Optional[float]:
378
    value = number_or_none(row.get("raw_output_bytes"))
379
    if value is not None:
380
        return value
381
382
    stdout = number_or_none(row.get("stdout_bytes"))
383
    stderr = number_or_none(row.get("stderr_bytes"))
384
    if stdout is not None or stderr is not None:
385
        return (stdout or 0.0) + (stderr or 0.0)
386
387
    token_estimate = row.get("token_estimate")
388
    if isinstance(token_estimate, dict):
389
        stdout = number_or_none(token_estimate.get("stdout_bytes"))
390
        stderr = number_or_none(token_estimate.get("stderr_bytes"))
391
        if stdout is not None or stderr is not None:
392
            return (stdout or 0.0) + (stderr or 0.0)
393
    return None
394
395
396
def output_truncated(row: dict[str, Any]) -> bool:
397
    if bool(row.get("output_truncated")):
398
        return True
399
    if bool(row.get("stdout_truncated")) or bool(row.get("stderr_truncated")):
400
        return True
401
    token_estimate = row.get("token_estimate")
402
    if isinstance(token_estimate, dict):
403
        return bool(token_estimate.get("stdout_truncated")) or bool(token_estimate.get("stderr_truncated"))
404
    return False