Viewing files at commit b76ab8b42dfdCommit detailsView latest

scripts/oakbench/rows.py 407 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", "scale")
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
    # Scale lane (suites/scale): every row names its tier and fixture identity
101
    # and states that it is development evidence until the calibrated campaign.
102
    "scale": (
103
        "bench_id",
104
        "profile",
105
        "scenario",
106
        "operation",
107
        "run",
108
        "subject",
109
        "subject_kind",
110
        "elapsed_ms",
111
        "returncode",
112
        "command",
113
        "tier",
114
        "fixture_id",
115
        "fixture_manifest_sha256",
116
        "evidence_class",
117
        "claim_eligible",
118
    ),
119
    # Platform lane: hosted-workflow rows are only comparable when both sides
120
    # ran the same semantics class under the same protection variant, so that
121
    # fairness context is part of every row — including skip rows. Runner
122
    # identity (ADR-0007) is required because this lane measures network
123
    # services from a specific vantage point.
124
    "platform": (
125
        "bench_id",
126
        "profile",
127
        "scenario",
128
        "operation",
129
        "run",
130
        "platform",
131
        "driver",
132
        "platform_semantics_version",
133
        "platform_semantics_class",
134
        "protection_variant",
135
        "platform_comparison_key",
136
        "semantic_contract_match",
137
        "elapsed_ms",
138
        "returncode",
139
        "command",
140
        "runner_id",
141
        "runner_class",
142
    ),
143
}
144
145
NUMERIC_KEYS = ("elapsed_ms",)
146
INTEGER_KEYS = ("returncode", "run")
147
SKIP_RETURNCODE = 77
148
149
# Optional metrics with constrained types/ranges when present. None is always
150
# legal (ADR-0002); a present value must be well-formed so consumers never
151
# need defensive parsing of the durable format.
152
OPTIONAL_NON_NEGATIVE_INT_KEYS = (
153
    "peak_rss_bytes",
154
    "tool_call_count",
155
    "probe_output_bytes",
156
    "changed_files_expected",
157
    "changed_files_recovered",
158
    "changed_files_reported",
159
    "changed_files_false_positive",
160
    "first_payload_bytes_server_to_client",
161
    "poll_iterations",
162
    "false_close_count",
163
    "close_eligible_n",
164
    "false_vcs_merge_safe_count",
165
    "vcs_merge_safe_n",
166
    "false_merge_allowed_count",
167
    "merge_allowed_n",
168
    "branches_scored",
169
    "branches_expected",
170
)
171
OPTIONAL_NON_NEGATIVE_NUMBER_KEYS = (
172
    "ttfd_ms",
173
    "observed_wait_ms",
174
    "settle_elapsed_ms",
175
    "poll_interval_s",
176
    "poll_quantization_ms",
177
    "status_post_elapsed_ms",
178
    "pacing_injected_ms",
179
)
180
OPTIONAL_UNIT_INTERVAL_KEYS = ("information_recall", "information_precision", "triage_recall", "triage_precision")
181
OPTIONAL_STRING_KEYS = (
182
    "runner_id",
183
    "runner_class",
184
    "fixture_id",
185
    "fixture_generator",
186
    "fixture_version",
187
    "fixture_seed",
188
    "fixture_manifest_sha256",
189
    "binary_sha256",
190
    "env_isolation_version",
191
    "platform_semantics_version",
192
    "platform_semantics_class",
193
    "protection_variant",
194
    "platform_comparison_key",
195
)
196
OPTIONAL_OBJECT_KEYS = ("runner_profile",)
197
198
199
class RowContractViolation(SystemExit):
200
    """Raised after rows are persisted; fails the producing run loudly."""
201
202
203
def validate_rows(rows: list[dict[str, Any]], lane: str) -> list[str]:
204
    if lane not in LANE_REQUIRED_KEYS:
205
        return [f"unknown lane {lane!r}; known: {', '.join(LANES)}"]
206
    required = LANE_REQUIRED_KEYS[lane]
207
    errors: list[str] = []
208
    for index, row in enumerate(rows, 1):
209
        if not isinstance(row, dict):
210
            errors.append(f"row {index}: expected object, got {type(row).__name__}")
211
            continue
212
        for key in required:
213
            if key not in row:
214
                errors.append(f"row {index} ({row.get('operation', '?')}): missing required key {key!r}")
215
        for key in NUMERIC_KEYS:
216
            value = row.get(key)
217
            diagnostic_timing = (lane == "core" and key == "elapsed_ms" and value is None
218
                and row.get("measurement_phase") == "output_diagnostic"
219
                and row.get("operation") in {
220
                    f"{operation}.{probe}" for operation in ("status.clean", "status.dirty", "diff.dirty", "diff.full")
221
                    for probe in ("inforecall", "determinism")})
222
            if diagnostic_timing:
223
                continue
224
            if key in row and (
225
                isinstance(value, bool)
226
                or not isinstance(value, (int, float))
227
                or not math.isfinite(float(value))
228
                or float(value) < 0
229
            ):
230
                errors.append(f"row {index}: {key} must be numeric, got {type(value).__name__}")
231
        for key in INTEGER_KEYS:
232
            value = row.get(key)
233
            if key in row and (isinstance(value, bool) or not isinstance(value, int)):
234
                errors.append(f"row {index}: {key} must be an integer, got {type(value).__name__}")
235
        for key in OPTIONAL_NON_NEGATIVE_INT_KEYS:
236
            value = row.get(key)
237
            if key in row and value is not None:
238
                if isinstance(value, bool) or not isinstance(value, int) or value < 0:
239
                    errors.append(f"row {index}: {key} must be a non-negative integer or null, got {value!r}")
240
        for key in OPTIONAL_NON_NEGATIVE_NUMBER_KEYS:
241
            value = row.get(key)
242
            if key in row and value is not None:
243
                if isinstance(value, bool) or not isinstance(value, (int, float)) or not math.isfinite(value) or value < 0:
244
                    errors.append(f"row {index}: {key} must be a non-negative finite number or null, got {value!r}")
245
        for key in OPTIONAL_UNIT_INTERVAL_KEYS:
246
            value = row.get(key)
247
            if key in row and value is not None:
248
                if not isinstance(value, (int, float)) or isinstance(value, bool) or not 0.0 <= float(value) <= 1.0:
249
                    errors.append(f"row {index}: {key} must be in [0, 1] or null, got {value!r}")
250
        for key in OPTIONAL_STRING_KEYS:
251
            value = row.get(key)
252
            if key in row and value is not None and not isinstance(value, str):
253
                errors.append(f"row {index}: {key} must be a string or null, got {type(value).__name__}")
254
        for key in OPTIONAL_OBJECT_KEYS:
255
            value = row.get(key)
256
            if key in row and value is not None and not isinstance(value, dict):
257
                errors.append(f"row {index}: {key} must be an object or null, got {type(value).__name__}")
258
        # Skip-row coherence: a skip is a recorded coverage gap, and consumers
259
        # key off both signals. Half-marked skips silently become failures
260
        # (or worse, successes) downstream.
261
        returncode = row.get("returncode")
262
        if returncode == SKIP_RETURNCODE:
263
            if not row.get("skipped"):
264
                errors.append(f"row {index} ({row.get('operation', '?')}): returncode 77 requires skipped: true")
265
            if not str(row.get("skip_reason") or "").strip():
266
                errors.append(f"row {index} ({row.get('operation', '?')}): skip rows require a non-empty skip_reason")
267
        elif row.get("skipped"):
268
            errors.append(
269
                f"row {index} ({row.get('operation', '?')}): skipped: true requires returncode {SKIP_RETURNCODE}"
270
            )
271
    return errors
272
273
274
def number_or_none(value: Any) -> Optional[float]:
275
    if value is None or isinstance(value, bool):
276
        return None
277
    try:
278
        parsed = float(value)
279
    except (TypeError, ValueError):
280
        return None
281
    if not math.isfinite(parsed):
282
        return None
283
    return parsed
284
285
286
def row_returncode(row: dict[str, Any]) -> int:
287
    """Row returncode with missing/null treated as failure, never a crash."""
288
    value = row.get("returncode")
289
    if value is None:
290
        return 1
291
    try:
292
        return int(value)
293
    except (TypeError, ValueError):
294
        return 1
295
296
297
def transcript_metrics_complete(row: dict[str, Any]) -> bool:
298
    source = row.get("source")
299
    execution = source.get("agent_execution") if isinstance(source, dict) else None
300
    is_agent = isinstance(row.get("agent"), dict) or str(row.get("operation", "")).startswith("agent.") or isinstance(execution, dict)
301
    return not ((is_agent and row.get("output_truncated") is True) or (isinstance(execution, dict) and
302
        (execution.get("usage_complete") is False or execution.get("transcript_metrics_complete") is False)))
303
304
305
def token_total(row: dict[str, Any]) -> Optional[float]:
306
    """Best-available token total for a row, preferring provider-reported usage."""
307
    if not transcript_metrics_complete(row):
308
        return None
309
    token_metrics = row.get("token_metrics")
310
    if isinstance(token_metrics, dict):
311
        value = number_or_none(token_metrics.get("total_tokens_reported"))
312
        if value is not None:
313
            return value
314
        reported_parts = [
315
            number_or_none(token_metrics.get("input_tokens_reported")),
316
            number_or_none(token_metrics.get("output_tokens_reported")),
317
            number_or_none(token_metrics.get("reasoning_tokens_reported")),
318
        ]
319
        if any(part is not None for part in reported_parts):
320
            return sum(part or 0.0 for part in reported_parts)
321
322
    for key in ("estimated_tokens_total", "token_count", "total_tokens"):
323
        value = number_or_none(row.get(key))
324
        if value is not None:
325
            return value
326
327
    token_estimate = row.get("token_estimate")
328
    if isinstance(token_estimate, dict):
329
        value = number_or_none(token_estimate.get("total"))
330
        if value is not None:
331
            return value
332
333
    tokens = row.get("tokens")
334
    if isinstance(tokens, dict):
335
        for key in ("total", "total_tokens", "provider_total", "estimated_total"):
336
            value = number_or_none(tokens.get(key))
337
            if value is not None:
338
                return value
339
        provider = tokens.get("provider_reported")
340
        if isinstance(provider, dict):
341
            value = number_or_none(provider.get("total"))
342
            if value is not None:
343
                return value
344
345
    if isinstance(token_metrics, dict):
346
        chars = number_or_none(token_metrics.get("transcript_chars"))
347
        if chars is None:
348
            input_chars = number_or_none(token_metrics.get("normalized_input_chars"))
349
            output_chars = number_or_none(token_metrics.get("normalized_output_chars"))
350
            if input_chars is not None or output_chars is not None:
351
                chars = (input_chars or 0.0) + (output_chars or 0.0)
352
        if chars is not None:
353
            return max(1.0, math.ceil(chars / 4.0))
354
    return None
355
356
357
def tool_calls(row: dict[str, Any]) -> Optional[float]:
358
    if not transcript_metrics_complete(row):
359
        return None
360
    for key in ("tool_call_count", "total_tool_calls"):
361
        value = number_or_none(row.get(key))
362
        if value is not None:
363
            return value
364
365
    nested = row.get("tool_calls")
366
    if isinstance(nested, dict):
367
        for key in ("total", "all"):
368
            value = number_or_none(nested.get(key))
369
            if value is not None:
370
                return value
371
372
    tool_call_metrics = row.get("tool_call_metrics")
373
    if isinstance(tool_call_metrics, dict):
374
        value = number_or_none(tool_call_metrics.get("tool_calls_total"))
375
        if value is not None:
376
            return value
377
    return None
378
379
380
def output_bytes(row: dict[str, Any]) -> Optional[float]:
381
    value = number_or_none(row.get("raw_output_bytes"))
382
    if value is not None:
383
        return value
384
385
    stdout = number_or_none(row.get("stdout_bytes"))
386
    stderr = number_or_none(row.get("stderr_bytes"))
387
    if stdout is not None or stderr is not None:
388
        return (stdout or 0.0) + (stderr or 0.0)
389
390
    token_estimate = row.get("token_estimate")
391
    if isinstance(token_estimate, dict):
392
        stdout = number_or_none(token_estimate.get("stdout_bytes"))
393
        stderr = number_or_none(token_estimate.get("stderr_bytes"))
394
        if stdout is not None or stderr is not None:
395
            return (stdout or 0.0) + (stderr or 0.0)
396
    return None
397
398
399
def output_truncated(row: dict[str, Any]) -> bool:
400
    if bool(row.get("output_truncated")):
401
        return True
402
    if bool(row.get("stdout_truncated")) or bool(row.get("stderr_truncated")):
403
        return True
404
    token_estimate = row.get("token_estimate")
405
    if isinstance(token_estimate, dict):
406
        return bool(token_estimate.get("stdout_truncated")) or bool(token_estimate.get("stderr_truncated"))
407
    return False