Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions FEATURES.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,18 @@ What each generator implements, and the conformance fixtures that prove it. A cl

| Feature | rust ≥ 1.85.0 | typescript ≥ 5.0 |
|---|---|---|
| structs <br><sub>`structs`</sub> | ✅ supported <br><sub>proven by `primitives`, `optional_and_arrays`, `type_refs` +16 more</sub> | ✅ supported <br><sub>proven by `primitives`, `optional_and_arrays`, `type_refs` +17 more</sub> |
| structs <br><sub>`structs`</sub> | ✅ supported <br><sub>proven by `primitives`, `optional_and_arrays`, `type_refs` +17 more</sub> | ✅ supported <br><sub>proven by `primitives`, `optional_and_arrays`, `type_refs` +18 more</sub> |
| enums <br><sub>`enums`</sub> | ✅ supported <br><sub>proven by `enum_basic`</sub> | ✅ supported <br><sub>proven by `enum_basic`</sub> |
| optional fields <br><sub>`optional-fields`</sub> | ✅ supported <br><sub>proven by `optional_and_arrays`, `type_refs`, `shapes` +4 more</sub> | ✅ supported <br><sub>proven by `optional_and_arrays`, `type_refs`, `shapes` +5 more</sub> |
| arrays <br><sub>`arrays`</sub> | ✅ supported <br><sub>proven by `optional_and_arrays`, `type_refs`, `shapes` +4 more</sub> | ✅ supported <br><sub>proven by `optional_and_arrays`, `type_refs`, `shapes` +5 more</sub> |
| arrays <br><sub>`arrays`</sub> | ✅ supported <br><sub>proven by `optional_and_arrays`, `type_refs`, `shapes` +5 more</sub> | ✅ supported <br><sub>proven by `optional_and_arrays`, `type_refs`, `shapes` +6 more</sub> |
| fixed-length arrays <br><sub>`fixed-arrays`</sub> | ✅ supported <br><sub>proven by `shapes`</sub> | 🟡 partial: rendered as `T[]`: the length isn't part of the type <br><sub>proven by `shapes`, `large_fixed_arrays_nested`</sub> |
| fixed arrays over 32 elements, nested <br><sub>`large-fixed-arrays-nested`</sub> | ❌ unsupported: a fixed array over 32 elements renders only as a struct or error field's own, non-optional type (serde's derive stops at 32) <br><sub>proven by `large_fixed_arrays_nested`</sub> | 🟡 partial: rendered as `T[]`: the length isn't part of the type <br><sub>proven by `large_fixed_arrays_nested`</sub> |
| unions <br><sub>`unions`</sub> | ❌ unsupported: Rust has no anonymous sum type to render one as <br><sub>proven by `unions`</sub> | ✅ supported <br><sub>proven by `unions`</sub> |
| type aliases <br><sub>`type-aliases`</sub> | ✅ supported <br><sub>proven by `validators`, `validators_on_decode`, `bounds`</sub> | ✅ supported <br><sub>proven by `validators`, `validators_on_decode`, `unions` +1 more</sub> |
| constants <br><sub>`constants`</sub> | ✅ supported <br><sub>proven by `constant`, `shapes`, `validators` +1 more</sub> | ✅ supported <br><sub>proven by `constant`, `shapes`, `validators` +1 more</sub> |
| protocols <br><sub>`protocols`</sub> | ✅ supported <br><sub>proven by `protocol`, `error_shapes`, `validators` +13 more</sub> | ✅ supported <br><sub>proven by `protocol`, `error_shapes`, `validators` +12 more</sub> |
| errors <br><sub>`errors`</sub> | ✅ supported <br><sub>proven by `protocol`, `error_shapes`, `format_json` +1 more</sub> | ✅ supported <br><sub>proven by `protocol`, `error_shapes`, `format_json`</sub> |
| functions that throw <br><sub>`throws`</sub> | ✅ supported <br><sub>proven by `protocol`, `error_shapes`, `format_json` +1 more</sub> | ✅ supported <br><sub>proven by `protocol`, `error_shapes`, `format_json`</sub> |
| protocols <br><sub>`protocols`</sub> | ✅ supported <br><sub>proven by `protocol`, `error_shapes`, `validators` +15 more</sub> | ✅ supported <br><sub>proven by `protocol`, `error_shapes`, `validators` +14 more</sub> |
| errors <br><sub>`errors`</sub> | ✅ supported <br><sub>proven by `protocol`, `error_shapes`, `lockstep` +2 more</sub> | ✅ supported <br><sub>proven by `protocol`, `error_shapes`, `lockstep` +1 more</sub> |
| functions that throw <br><sub>`throws`</sub> | ✅ supported <br><sub>proven by `protocol`, `error_shapes`, `lockstep` +2 more</sub> | ✅ supported <br><sub>proven by `protocol`, `error_shapes`, `lockstep` +1 more</sub> |
| validators <br><sub>`validators`</sub> | ✅ supported <br><sub>proven by `validators`, `validators_on_decode`</sub> | ⚪ ignored: the types are generated; the checks aren't run yet (core#96) <br><sub>proven by `validators`, `validators_on_decode`</sub> |
| imports between schemas <br><sub>`imports`</sub> | ✅ supported <br><sub>proven by `cross_schema`, `import_alias`, `import_glob` +6 more</sub> | ✅ supported <br><sub>proven by `cross_schema`, `import_alias`, `import_glob` +6 more</sub> |
| nested namespaces <br><sub>`nested-namespaces`</sub> | ✅ supported <br><sub>proven by `nested_namespace`, `external_std`, `validators` +4 more</sub> | ✅ supported <br><sub>proven by `nested_namespace`, `external_std`, `validators` +4 more</sub> |
Expand All @@ -26,11 +26,11 @@ What each generator implements, and the conformance fixtures that prove it. A cl
| `validate_on_decode` <br><sub>`validate-on-decode`</sub> | ✅ supported <br><sub>proven by `validators_on_decode`</sub> | ⚪ ignored: no checks are generated to run on decode yet (core#96) <br><sub>proven by `validators_on_decode`</sub> |
| JSON-RPC framing <br><sub>`framing-jsonrpc`</sub> | ✅ supported <br><sub>proven by `framing_jsonrpc`, `connections_jsonrpc`</sub> | ✅ supported <br><sub>proven by `framing_jsonrpc`, `connections_jsonrpc`</sub> |
| no handshake <br><sub>`handshake-none`</sub> | ✅ supported <br><sub>proven by `handshake_none`</sub> | ✅ supported <br><sub>proven by `handshake_none`</sub> |
| `datagram@3` framing <br><sub>`framing-datagram3`</sub> | ✅ supported <br><sub>proven by `framing_datagram3`, `handshake_comline2`, `dependency_protocol` +2 more</sub> | ✅ supported <br><sub>proven by `framing_datagram3`, `handshake_comline2`, `dependency_protocol` +2 more</sub> |
| `comline@2` handshake <br><sub>`handshake-comline2`</sub> | ✅ supported <br><sub>proven by `handshake_comline2`, `dependency_protocol`, `dependency_and_own_protocols` +1 more</sub> | ✅ supported <br><sub>proven by `handshake_comline2`, `dependency_protocol`, `dependency_and_own_protocols` +1 more</sub> |
| connections <br><sub>`connections`</sub> | ✅ supported <br><sub>proven by `protocol`, `error_shapes`, `validators` +12 more</sub> | ✅ supported <br><sub>proven by `protocol`, `error_shapes`, `validators` +11 more</sub> |
| `datagram@3` framing <br><sub>`framing-datagram3`</sub> | ✅ supported <br><sub>proven by `framing_datagram3`, `handshake_comline2`, `connections_default` +3 more</sub> | ✅ supported <br><sub>proven by `framing_datagram3`, `handshake_comline2`, `connections_default` +3 more</sub> |
| `comline@2` handshake <br><sub>`handshake-comline2`</sub> | ✅ supported <br><sub>proven by `handshake_comline2`, `connections_default`, `dependency_protocol` +2 more</sub> | ✅ supported <br><sub>proven by `handshake_comline2`, `connections_default`, `dependency_protocol` +2 more</sub> |
| connections <br><sub>`connections`</sub> | ✅ supported <br><sub>proven by `protocol`, `error_shapes`, `validators` +13 more</sub> | ✅ supported <br><sub>proven by `protocol`, `error_shapes`, `validators` +12 more</sub> |
| `async` <br><sub>`async`</sub> | ✅ supported <br><sub>proven by `connections_async`</sub> | ⚪ ignored: handlers and senders always return Promises: the output is async either way <br><sub>proven by `connections_async`</sub> |
| the `packed@1` format <br><sub>`format-packed`</sub> | ✅ supported <br><sub>proven by `protocol`, `error_shapes`, `validators` +9 more</sub> | ✅ supported <br><sub>proven by `protocol`, `error_shapes`, `validators` +9 more</sub> |
| the `packed@1` format <br><sub>`format-packed`</sub> | ✅ supported <br><sub>proven by `protocol`, `error_shapes`, `validators` +11 more</sub> | ✅ supported <br><sub>proven by `protocol`, `error_shapes`, `validators` +11 more</sub> |
| the `json@1` format <br><sub>`format-json`</sub> | ✅ supported <br><sub>proven by `format_json`</sub> | ✅ supported <br><sub>proven by `format_json`</sub> |
| the `msgpack@1` format <br><sub>`format-msgpack`</sub> | ✅ supported <br><sub>proven by `format_msgpack`</sub> | ❌ unsupported: `@comline/runtime` has no MessagePack codec yet <br><sub>proven by `format_msgpack`</sub> |
| bounds <br><sub>`bounds`</sub> | ✅ supported <br><sub>proven by `bounds`</sub> | ✅ supported <br><sub>proven by `bounds`</sub> |
Expand Down
83 changes: 83 additions & 0 deletions conformance/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -130,9 +130,11 @@ pub fn corpus() -> Vec<Fixture> {
handshake_none(),
framing_datagram3(),
handshake_comline2(),
lockstep(),
connections(),
connections_async(),
connections_jsonrpc(),
connections_default(),
format_json(),
format_msgpack(),
bounds(),
Expand Down Expand Up @@ -1029,6 +1031,45 @@ fn handshake_none() -> Fixture {
)
}

/// The Protocols guide's `Mail`, on the lockstep `datagram` framing (no
/// version), which gets a `<Proto>Dispatcher` and a `<Proto>Client`: a
/// function that returns a string and throws, with a call
/// timeout, and one that returns an array.
fn lockstep() -> Fixture {
let send_message = FrozenUnit::Function {
docstring: String::new(),
parameters: vec![FrozenUnit::Property { name: "timeout_ms".to_string(), value: ConfigValue::Integer(1000) }],
name: "send_message".to_string(),
arguments: vec![FrozenArgument {
name: "message".to_string(),
ty: type_of("Message"),
span: (0, 0),
parameters: vec![],
}],
_return: Some(type_of("string")),
throws: vec![0],
span: (0, 0),
};
Fixture::one(
"lockstep",
"conformance",
vec![
structure("Message", vec![field("body", "string", false)]),
error(0, "RecipientNotFound"),
FrozenUnit::Protocol {
docstring: "Lockstep".to_string(),
parameters: vec![FrozenUnit::Property {
name: "framing".to_string(),
value: ConfigValue::Str("datagram".to_string()),
}],
name: "Mail".to_string(),
functions: vec![send_message, function("fetch_inbox", vec![], Some("Message[]"), vec![])],
span: (0, 0),
},
],
)
}

/// Two protocols on one connection: `Chat`, which the accepting side
/// provides over `datagram@2`, and `Events`, which the dialling side does.
/// `connections`, with `async`: the same protocols, generated for an async
Expand Down Expand Up @@ -1100,6 +1141,48 @@ fn connections() -> Fixture {
)
}

/// [`connections`] under the defaults core writes into a protocol, `datagram@3`
/// and `comline@2`: the server's `Services`, the client's `ClientServices`, and
/// the handshake between them.
fn connections_default() -> Fixture {
let defaults = || {
vec![
FrozenUnit::Property { name: "framing".to_string(), value: ConfigValue::Str("datagram@3".to_string()) },
FrozenUnit::Property { name: "handshake".to_string(), value: ConfigValue::Str("comline@2".to_string()) },
]
};
Fixture::one(
"connections_default",
"conformance",
vec![
FrozenUnit::Protocol {
docstring: "What the server provides".to_string(),
parameters: defaults(),
name: "Chat".to_string(),
functions: vec![function("send", vec![arg("n", PrimitiveType::U32)], Some("u32"), vec![])],
span: (0, 0),
},
FrozenUnit::Protocol {
docstring: "What the client provides".to_string(),
parameters: [
vec![FrozenUnit::Property {
name: "provider".to_string(),
value: ConfigValue::Name("Client".to_string()),
}],
defaults(),
]
.concat(),
name: "Events".to_string(),
functions: vec![
function("shown", vec![arg("n", PrimitiveType::U32)], Some("bool"), vec![]),
function("ping", vec![], None, vec![]),
],
span: (0, 0),
},
],
)
}

/// [`protocol`] under `wire.format = "json@1"`.
fn format_json() -> Fixture {
Fixture { name: "format_json", ..protocol() }.with_format("json@1")
Expand Down
Loading
Loading