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
73 lines
2.6 KiB
JSON
73 lines
2.6 KiB
JSON
{
|
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
"$id": "https://velox.dev/schema/envelope.schema.json",
|
|
"title": "Envelope",
|
|
"description": "JSON-RPC 2.0 envelope as Velox uses it, plus the project's error codes. Every transport (UDS NDJSON, native-messaging length-prefix, loopback WebSocket) carries exactly these payloads; only the framing differs.",
|
|
"$defs": {
|
|
"Id": {
|
|
"title": "Id",
|
|
"description": "Request correlation id. Velox clients always send an integer; string ids are accepted for spec compliance. A notification has no id.",
|
|
"type": ["integer", "string"]
|
|
},
|
|
"Request": {
|
|
"title": "Request",
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"required": ["jsonrpc", "method"],
|
|
"properties": {
|
|
"jsonrpc": { "const": "2.0" },
|
|
"id": { "$ref": "#/$defs/Id" },
|
|
"method": { "type": "string" },
|
|
"params": { "type": "object" }
|
|
}
|
|
},
|
|
"Response": {
|
|
"title": "Response",
|
|
"description": "Exactly one of result or error is present.",
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"required": ["jsonrpc", "id"],
|
|
"properties": {
|
|
"jsonrpc": { "const": "2.0" },
|
|
"id": { "$ref": "#/$defs/Id" },
|
|
"result": {},
|
|
"error": { "$ref": "#/$defs/Error" }
|
|
}
|
|
},
|
|
"Notification": {
|
|
"title": "Notification",
|
|
"description": "Server to client. No id, never answered.",
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"required": ["jsonrpc", "method", "params"],
|
|
"properties": {
|
|
"jsonrpc": { "const": "2.0" },
|
|
"method": { "type": "string" },
|
|
"params": { "type": "object" }
|
|
}
|
|
},
|
|
"Error": {
|
|
"title": "Error",
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"required": ["code", "message"],
|
|
"properties": {
|
|
"code": { "$ref": "https://velox.dev/schema/types/ErrorCode.schema.json" },
|
|
"message": { "type": "string" },
|
|
"data": {
|
|
"type": ["object", "null"],
|
|
"description": "Code-specific detail. -32013 carries data.httpStatus; -32011 carries data.path; -32014 carries data.retryAfterSec.",
|
|
"properties": {
|
|
"httpStatus": { "type": ["integer", "null"] },
|
|
"path": { "type": ["string", "null"] },
|
|
"retryAfterSec": { "type": ["integer", "null"] },
|
|
"taskId": { "type": ["string", "null"] },
|
|
"expected": { "type": ["string", "null"] },
|
|
"actual": { "type": ["string", "null"] }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|