Schemas for the whole v1 surface: 38 methods, 9 events, 25 named types and the
JSON-RPC envelope, with x-privileged / x-transports / x-deadlineMs / x-errors
annotations that both generators emit as data rather than prose.
Four generators over one IR (contracts/codegen/schema_ir.py), so the C++ structs,
the TypeScript types and the OpenRPC document cannot disagree about what the
contract says:
gen_cpp.py -> core/generated/velox_proto.{hpp,cpp}
gen_ts.py -> extension/src/shared/protocol/
gen_openrpc.py -> contracts/openrpc.json
gen_cpp_conformance.py -> tests/conformance/cpp/fixture_dispatcher.hpp
Inbound parsing never throws: parse<T>() returns std::expected<T, ParseError> and
nlohmann's throwing ADL from_json is deliberately not emitted. Schema constraints
(minimum, maxLength, pattern, ...) become real runtime checks in both languages —
the daemon does not trust the extension and the extension does not trust the
daemon.
59 golden fixtures: a success case per method, 12 error cases, 9 events. Replayed
by tests/conformance/ against both the generated C++ and a live server over both
transports. tools/mockd serves the same fixtures with unhappy-path flags so the
GUI and EXT lanes never wait for veloxd.
run.sh also proves capture.offer fails open: with a daemon answering slower than
750 ms the client gives up and lets Firefox take the download.
core/generated/ is libveloxproto, a separate target from libveloxcore, which
still never sees JSON — see docs/adr/0009.
Co-Authored-By: Claude Opus 5 <[email protected]>
Claude-Session: https://claude.ai/code/session_012fgjnqFCS5h5L7gZTZo3rV
78 lines
2.3 KiB
JSON
78 lines
2.3 KiB
JSON
{
|
|
"name": "download.get \u2014 full detail with per-segment state",
|
|
"description": "Backs the progress dialog. This is the only place segment-level detail crosses the wire.",
|
|
"request": {
|
|
"jsonrpc": "2.0",
|
|
"id": 14,
|
|
"method": "download.get",
|
|
"params": {
|
|
"taskId": "$taskId"
|
|
}
|
|
},
|
|
"response": {
|
|
"jsonrpc": "2.0",
|
|
"id": 14,
|
|
"result": {
|
|
"summary": {
|
|
"taskId": "3f7a2b1c-5d6e-4f80-9a1b-2c3d4e5f6071",
|
|
"filename": "ubuntu-26.04-desktop-amd64.iso",
|
|
"saveDir": "/home/sami/Downloads/Programs",
|
|
"url": "https://releases.ubuntu.com/26.04/ubuntu-26.04-desktop-amd64.iso",
|
|
"effectiveUrl": "https://releases.ubuntu.com/26.04/ubuntu-26.04-desktop-amd64.iso",
|
|
"sizeBytes": 6228541440,
|
|
"downloadedBytes": 2941190144,
|
|
"state": "downloading",
|
|
"speedBps": 29796556,
|
|
"etaSeconds": 110,
|
|
"resumable": true,
|
|
"segments": 8,
|
|
"categoryId": "programs",
|
|
"queueId": null,
|
|
"queuePosition": null,
|
|
"description": null,
|
|
"createdAt": "$isoDate",
|
|
"lastTryAt": "$isoDate",
|
|
"completedAt": null,
|
|
"error": null
|
|
},
|
|
"segmentDetail": [
|
|
{
|
|
"index": 0,
|
|
"startByte": 0,
|
|
"endByte": 778567679,
|
|
"downloadedBytes": 402653184,
|
|
"speedBps": 4089446,
|
|
"state": "receiving",
|
|
"httpStatus": 206
|
|
},
|
|
{
|
|
"index": 1,
|
|
"startByte": 778567680,
|
|
"endByte": 1557135359,
|
|
"downloadedBytes": 356515840,
|
|
"speedBps": 3565158,
|
|
"state": "receiving",
|
|
"httpStatus": 206
|
|
}
|
|
],
|
|
"headers": {
|
|
"User-Agent": "Velox/0.1",
|
|
"Referer": "https://releases.ubuntu.com/26.04/"
|
|
},
|
|
"referrer": "https://releases.ubuntu.com/26.04/",
|
|
"userAgent": "Velox/0.1",
|
|
"mime": "application/octet-stream",
|
|
"bufferBytes": 4194304,
|
|
"partPath": "/home/sami/Downloads/Programs/ubuntu-26.04-desktop-amd64.iso.veloxpart",
|
|
"checksum": null,
|
|
"checksumVerified": null,
|
|
"averageSpeedBps": 27262976,
|
|
"retryCount": 0
|
|
}
|
|
},
|
|
"assertions": [
|
|
"segment ranges are contiguous and cover exactly [0, sizeBytes)",
|
|
"the GUI draws one bar per entry and is never told what a segment steal is"
|
|
]
|
|
}
|