samiandClaude Opus 5
53421d6cb8
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
42 lines
1.1 KiB
JSON
42 lines
1.1 KiB
JSON
{
|
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
"$id": "https://velox.dev/schema/methods/queue.upsert.schema.json",
|
|
"title": "queue.upsert",
|
|
"description": "Create or replace a queue, including its schedule and concurrency cap. Omit queueId to create. taskIds in the payload is ignored \u2014 membership changes through download.update and queue.reorder so that two clients editing at once cannot silently drop a task.",
|
|
"x-privileged": true,
|
|
"x-transports": [
|
|
"uds"
|
|
],
|
|
"x-deadlineMs": 5000,
|
|
"x-errors": [
|
|
-32003
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"params": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"queue"
|
|
],
|
|
"properties": {
|
|
"queue": {
|
|
"$ref": "https://velox.dev/schema/types/Queue.schema.json"
|
|
}
|
|
}
|
|
},
|
|
"result": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"queue"
|
|
],
|
|
"properties": {
|
|
"queue": {
|
|
"$ref": "https://velox.dev/schema/types/Queue.schema.json"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|