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
49 lines
1.6 KiB
JSON
49 lines
1.6 KiB
JSON
{
|
|
"name": "download.update \u2014 refile a task into another category",
|
|
"description": "Moving saveDir moves the file on disk in the same operation, which is what makes a drag onto the category tree one RPC.",
|
|
"request": {
|
|
"jsonrpc": "2.0",
|
|
"id": 25,
|
|
"method": "download.update",
|
|
"params": {
|
|
"taskId": "$taskId",
|
|
"patch": {
|
|
"categoryId": "video",
|
|
"saveDir": "/home/sami/Downloads/Video",
|
|
"description": "Ubuntu 26.04 desktop image"
|
|
}
|
|
}
|
|
},
|
|
"response": {
|
|
"jsonrpc": "2.0",
|
|
"id": 25,
|
|
"result": {
|
|
"taskId": "3f7a2b1c-5d6e-4f80-9a1b-2c3d4e5f6071",
|
|
"filename": "ubuntu-26.04-desktop-amd64.iso",
|
|
"saveDir": "/home/sami/Downloads/Video",
|
|
"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": "video",
|
|
"queueId": null,
|
|
"queuePosition": null,
|
|
"description": "Ubuntu 26.04 desktop image",
|
|
"createdAt": "$isoDate",
|
|
"lastTryAt": "$isoDate",
|
|
"completedAt": null,
|
|
"error": null
|
|
}
|
|
},
|
|
"assertions": [
|
|
"the file and its .veloxpart.meta move together, or neither moves",
|
|
"the new saveDir is canonicalized and checked against the allowed roots first",
|
|
"a running task is not re-segmented underneath the user"
|
|
]
|
|
}
|