Compare commits
41 changed files with 237 additions and 7050 deletions
|
|
@ -115,7 +115,6 @@ copies), the C# `CultNetErrorMessage` factory, the Rust `CultNetErrorCode`, and
|
||||||
`unowned_schema` (a write, or a remote put or delete, for a schema and key no shard owns),
|
`unowned_schema` (a write, or a remote put or delete, for a schema and key no shard owns),
|
||||||
`write_not_authorized` (a peer's put or delete its server's remote write authority did not grant) and
|
`write_not_authorized` (a peer's put or delete its server's remote write authority did not grant) and
|
||||||
`unsupported_schema_version` (a message whose `schemaVersion` the peer does not speak; `details` names `schemaVersion` and the offered value) and
|
`unsupported_schema_version` (a message whose `schemaVersion` the peer does not speak; `details` names `schemaVersion` and the offered value) and
|
||||||
`limit_reached` (a receipt-capable server's per-session remembered-write table is full, so a new write is refused; `details` all null) and
|
|
||||||
`message_invalid` (a request that lacks a required field or carries an ill-typed one: a document-put or delete, or a subscription without an id; `details.field` names the request field, or `message` when the whole frame cannot be read).
|
`message_invalid` (a request that lacks a required field or carries an ill-typed one: a document-put or delete, or a subscription without an id; `details.field` names the request field, or `message` when the whole frame cannot be read).
|
||||||
A malformed put or delete is `message_invalid`, not a per-operation code: the peer knows which operation it sent.
|
A malformed put or delete is `message_invalid`, not a per-operation code: the peer knows which operation it sent.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,122 +0,0 @@
|
||||||
{
|
|
||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
||||||
"$id": "https://github.com/GameCult/CultLib/contracts/cultnet/interop/cultnet.error.v1.schema.json",
|
|
||||||
"title": "CultNet Error Message v1",
|
|
||||||
"description": "cultnet.error.v0 plus messageId (write-receipt.md). Sent in place of cultnet.error.v0 only to a connection that declared the write-receipt capability. v0 is unchanged: its schema is closed (additionalProperties false), so an extra key would make a v0 peer reject the frame instead of ignoring it. Map-mode: every key is written, messageId nil when the error answers no readable message. The code enum is the v0 enum plus limit_reached (write-receipt.md, Remembered-write limits).",
|
|
||||||
"type": "object",
|
|
||||||
"required": [
|
|
||||||
"schemaVersion",
|
|
||||||
"error",
|
|
||||||
"routingHint",
|
|
||||||
"code",
|
|
||||||
"details",
|
|
||||||
"messageId"
|
|
||||||
],
|
|
||||||
"additionalProperties": false,
|
|
||||||
"properties": {
|
|
||||||
"schemaVersion": {
|
|
||||||
"const": "cultnet.error.v1"
|
|
||||||
},
|
|
||||||
"error": {
|
|
||||||
"type": "string",
|
|
||||||
"minLength": 1
|
|
||||||
},
|
|
||||||
"routingHint": {
|
|
||||||
"description": "Optional shard routing detail for an authority failure. Null for every selection/cursor refusal code (R-N).",
|
|
||||||
"type": [
|
|
||||||
"object",
|
|
||||||
"null"
|
|
||||||
],
|
|
||||||
"additionalProperties": false,
|
|
||||||
"required": [
|
|
||||||
"shard",
|
|
||||||
"reason"
|
|
||||||
],
|
|
||||||
"properties": {
|
|
||||||
"shard": {
|
|
||||||
"type": [
|
|
||||||
"object",
|
|
||||||
"null"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"reason": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"code": {
|
|
||||||
"description": "Machine-readable refusal code (R-N). Additive: a v0 peer that does not know this field ignores it. The set is a closed enum: Rust and TypeScript refuse a message whose code is not listed, so adding a code is one coordinated change across every runtime (this schema, the C# factory, the Rust CultNetErrorCode, and a captured-bytes case for each). limit_reached: a receipt-capable server refuses a NEW write because its per-session remembered-write table (1024 entries) or its server-wide memory budget is full; messageId is the write's id.",
|
|
||||||
"type": [
|
|
||||||
"string",
|
|
||||||
"null"
|
|
||||||
],
|
|
||||||
"enum": [
|
|
||||||
null,
|
|
||||||
"selection_invalid",
|
|
||||||
"cursor_stale",
|
|
||||||
"cursor_invalid",
|
|
||||||
"reference_outside_target",
|
|
||||||
"variant_unsupported",
|
|
||||||
"unowned_schema",
|
|
||||||
"write_not_authorized",
|
|
||||||
"unsupported_schema_version",
|
|
||||||
"message_invalid",
|
|
||||||
"limit_reached"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"details": {
|
|
||||||
"description": "Code-specific structured detail (R-N). Every field is populated only for the code that defines it; the others are null, not omitted.",
|
|
||||||
"type": [
|
|
||||||
"object",
|
|
||||||
"null"
|
|
||||||
],
|
|
||||||
"additionalProperties": false,
|
|
||||||
"required": [
|
|
||||||
"field",
|
|
||||||
"value",
|
|
||||||
"asOf",
|
|
||||||
"current"
|
|
||||||
],
|
|
||||||
"properties": {
|
|
||||||
"field": {
|
|
||||||
"description": "selection_invalid: the selection field that failed. variant_unsupported: \"subscriptionId\", when a subscription was ended. unowned_schema: \"schemaId\". write_not_authorized: \"recordKey\". unsupported_schema_version: \"schemaVersion\". message_invalid: the request field that is missing or ill-typed (\"message\" when the whole frame cannot be read). limit_reached: no field; details stay all null. message_invalid also names \"messageId\" (over 256 bytes), \"document\", \"schemaId\" or \"channel\" (write on an unreliable channel).",
|
|
||||||
"type": [
|
|
||||||
"string",
|
|
||||||
"null"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"value": {
|
|
||||||
"description": "selection_invalid: the offending value, when there is one string worth naming. variant_unsupported: the id of the subscription that ended. unowned_schema: the schema id no shard owns. write_not_authorized: the key of the refused write. unsupported_schema_version: the schemaVersion the peer does not speak.",
|
|
||||||
"type": [
|
|
||||||
"string",
|
|
||||||
"null"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"asOf": {
|
|
||||||
"description": "cursor_stale: the cursor's own minted asOf.",
|
|
||||||
"type": [
|
|
||||||
"integer",
|
|
||||||
"null"
|
|
||||||
],
|
|
||||||
"minimum": 0
|
|
||||||
},
|
|
||||||
"current": {
|
|
||||||
"description": "cursor_stale: the answering server's current asOf.",
|
|
||||||
"type": [
|
|
||||||
"integer",
|
|
||||||
"null"
|
|
||||||
],
|
|
||||||
"minimum": 0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"messageId": {
|
|
||||||
"description": "The messageId of the write (or other request) this error answers, echoed byte for byte. Null only when the frame was unreadable or carried no messageId.",
|
|
||||||
"type": [
|
|
||||||
"string",
|
|
||||||
"null"
|
|
||||||
],
|
|
||||||
"minLength": 1
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,16 +0,0 @@
|
||||||
{
|
|
||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
||||||
"$id": "https://github.com/GameCult/CultLib/contracts/cultnet/interop/cultnet.write-admitted.schema.json",
|
|
||||||
"title": "CultNet Write Admitted",
|
|
||||||
"description": "The receipt for one admitted document put or delete (write-receipt.md). Sent only after the write's commit point, only to a connection that declared the write-receipt capability, once per messageId. Map-mode: every key is written, none is nil. A receipt never carries an error, and an error.v1 never carries admission.",
|
|
||||||
"type": "object",
|
|
||||||
"required": ["schemaVersion", "messageId", "operation", "schemaId", "recordKey"],
|
|
||||||
"additionalProperties": false,
|
|
||||||
"properties": {
|
|
||||||
"schemaVersion": { "const": "cultnet.write_admitted.v0" },
|
|
||||||
"messageId": { "description": "The messageId of the put or delete this admits, echoed byte for byte.", "type": "string", "minLength": 1 },
|
|
||||||
"operation": { "enum": ["put", "delete"] },
|
|
||||||
"schemaId": { "description": "The schemaId of the admitted write, echoed.", "type": "string", "minLength": 1 },
|
|
||||||
"recordKey": { "description": "The recordKey of the admitted write, echoed.", "type": "string", "minLength": 1 }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
File diff suppressed because it is too large
Load diff
|
|
@ -1,83 +0,0 @@
|
||||||
# CultNet write receipt (specification)
|
|
||||||
|
|
||||||
Status: specification. No runtime implements it yet; the conformance follow-ups below do.
|
|
||||||
Rules: Heimdall's ruling of 2026-11-08 (a write completes on its result frame; an ack or a return is not admission).
|
|
||||||
Files here: `cultnet.write-admitted.schema.json`, `cultnet.error.v1.schema.json`, `write-receipt-vectors.json`. They move to `contracts/cultnet/` when the first runtime implements them.
|
|
||||||
|
|
||||||
## The problem
|
|
||||||
|
|
||||||
A put or delete today has two answers on the wire: nothing (admitted, or the server never read it) and `cultnet.error.v0` (refused, with no id saying which write). A transport ack proves delivery. Clients that completed on the ack, or on a window with no refusal, reported refused writes as done (CultLib #55 to #58 bound this with a result window; this spec replaces the window with an answer).
|
|
||||||
|
|
||||||
## Frames
|
|
||||||
|
|
||||||
**`cultnet.write_admitted.v0`**: `{ schemaVersion, messageId, operation: "put"|"delete", schemaId, recordKey }`, every key written, none nil. Sent once a put or delete is admitted. The id echoes the write's `messageId` byte for byte; `operation`, `schemaId`, `recordKey` echo the write.
|
|
||||||
|
|
||||||
**`cultnet.error.v1`**: `cultnet.error.v0` plus a required `messageId` (string or nil). The code enum is v0's plus `limit_reached` (see Remembered-write limits); `cultnet.error.v1.schema.json` is the authority for the closed set. Sent in place of `error.v0` to a receipt-capable connection. `messageId` is the id of the request the error answers; nil only when the frame was unreadable or carried no id.
|
|
||||||
|
|
||||||
Why a new error version and not an extra key on v0: the v0 schema is closed (`additionalProperties: false`) and the TypeScript decoder (Ajv over the closed schemas) rejects unknown keys and unknown `schemaVersion`s, and `parseCultNetMessage` throws on an unknown version; Rust's decoder errors on an unknown version too. Unknown-key tolerance of the Rust, Python and Kotlin error decoders was not checked, so none is assumed, so a surprise key or frame breaks an old client's whole receive path. Old clients are therefore never sent either new frame. This reverses the "old clients ignore it" assumption, which is false for today's decoders.
|
|
||||||
|
|
||||||
## Capability: opting in
|
|
||||||
|
|
||||||
A connection is receipt-capable when its `cultnet.hello.v0` (sent before its first write; the schema channel is reliable and ordered) lists both `cultnet.write_admitted.v0` and `cultnet.error.v1` in `supportedMessageVersions`. A server MUST NOT send either new frame to any other connection, and answers it exactly as before (no receipt, `error.v0`). A receipt-capable server lists both in its own hello, so a client can tell a legacy server from a receipt server that has not answered yet. A client that sends no hello gets legacy behaviour. A server advertises the two frames in its hello only if it implements the receipt rules end to end.
|
|
||||||
|
|
||||||
**The capability changes framing only; it never authorizes.** A hello authenticates nothing and grants nothing: who may write, and which keys, is decided by the server from the transport-authenticated actor exactly as without the capability. Declaring the capability never makes a refused write admitted, never widens an actor's authority, and never changes what a write does; it selects only which frame the answer arrives in.
|
|
||||||
|
|
||||||
## Server rules
|
|
||||||
|
|
||||||
1. **One answer.** For every put or delete on a receipt-capable connection the server sends exactly one of `write_admitted` or `error.v1`, carrying that write's `messageId`. Never both, never two different answers.
|
|
||||||
2. **After the commit point.** `write_admitted` is sent only after the write is committed by the same rule that makes it visible to readers. Receipt of the bytes, parse, or authorisation alone is not admission.
|
|
||||||
3. **Id on every refusal.** Every refusal of a write, whatever its code (`write_not_authorized`, `message_invalid`, `unowned_schema`, `unsupported_schema_version`, shard authority errors, ...), is an `error.v1` whose `messageId` is the write's id. When the frame is readable enough to find the id, it is found; `message_invalid` for a missing or ill-typed field still carries the id. Nil only when no id can be read.
|
|
||||||
4. **Batches.** There is no batch frame; a batch is N writes, each with its own `messageId`, each answered under rules 1 to 3. A failed batch names its member by that id. A server may not collapse a batch into one answer.
|
|
||||||
5. **Identity and idempotent resend.** A `messageId` is unique per authenticated actor and session: the client mints it, never reuses it for different content in that session, and a server never accepts the id of one actor as the id of another. The server's dedupe key is `(actor, messageId)`, where *actor* is the transport-authenticated identity, never a name the hello or the frame claims. Alongside the key it keeps the **content hash** of the write and the answer it gave. The content hash is SHA-256 of the MessagePack array `[operation, schemaId, recordKey, payload]`, where `payload` is the raw document payload as a MessagePack `bin` for a put and nil for a delete (the vectors give worked hashes). **Scope: at least the session.** The key lives for the life of the session it was made in, and a server may bound how many writes it remembers per session (see Remembered-write limits; a server never forgets an id it promised to answer). A server MAY keep the key longer for the same actor, up to `DEDUPE_RETENTION_MS` (10 minutes), but a client MUST NOT rely on it: **a reconnect is a new session, and a resend on the new session is a new write.**
|
|
||||||
- Same key, same content hash, answer was `write_admitted`: answer `write_admitted` again with the same body. The write is not applied twice.
|
|
||||||
- Same key, same content hash, answer was a refusal: the same refusal again.
|
|
||||||
- **Same key, different content hash: refuse `message_invalid` (details `field: "messageId"`) and never re-send the old receipt.** Old receipts are for the old content; showing one for new content would report an unapplied write as admitted. The original write's state is unchanged.
|
|
||||||
- **Id size.** A write's `messageId` is at most 256 bytes of UTF-8. A longer id is refused `message_invalid` (`details.field: "messageId"`, the refusal's `messageId` the id as received, text fixed per Fixed texts) BEFORE anything is remembered: no table entry, no digest, no budget charge. Such a refusal is therefore not replayed from the table; a resend is refused afresh, identically.
|
|
||||||
- **What is remembered.** Per entry a server keeps only fixed-size digests (SHA-256) of the `messageId` and of the content hash, plus the answer (`admitted`, or the refusal's code and details). Memory per entry is bounded independent of id length and payload size. Lookup compares digests.
|
|
||||||
- **Remembered-write limits.** The per-session table holds at most 1024 entries. A server MAY also enforce a server-wide memory budget across all sessions (reference: 32 MiB of remembered entries). A NEW write (a key not already in the table) that would exceed either bound is refused `limit_reached` for that write alone, `messageId` the write's id, `details` all null; the write is not applied and the session continues. A resend of a remembered key is still answered from the table.
|
|
||||||
- **Limit refusals are remembered.** A `limit_reached` refusal is remembered like any other: a resend of the same id and content hash replays `limit_reached`. No slot is freed mid-session, so an id refused at a bound never becomes admitted later in that session (a server at the cap keeps the refused digest pair in a bounded refusal set of at most 1024 per session, outside the entry budget; past it, a further new write is refused `limit_reached` without being remembered, and the session refuses every id it has not seen for the rest of its life, even if a server-wide budget has since freed, so a refusal that was not remembered is never followed by an admission of the same id). The client mints a new id on a new session.
|
|
||||||
- **Required fields.** A put or delete whose document or `schemaId` is null or missing is refused `message_invalid` with `details.field` `"document"` or `"schemaId"` (the first missing in that order) and fixed text; the write is not applied. A `schemaId` or `recordKey` that is empty or only whitespace (present but names nothing) is not "missing": the write is refused `message_invalid` exactly as a frame that does not read, with `details.field` `"message"` and the write's id (vector `error_v1_empty_schema_id_is_unreadable_and_names_the_write`), and is never applied; a server must not hand it to its store.
|
|
||||||
- **Fixed texts.** The `error` string of these refusals is fixed, so vectors can compare it: `message_invalid: messageId exceeds 256 bytes`, `message_invalid: document is required`, `message_invalid: schemaId is required`, `message_invalid: receipt sessions require the reliable channel`, `limit_reached: the session's remembered-write limit is full`.
|
|
||||||
- **Reliable channel only.** A write is accepted on a receipt session only on a channel that is reliable and not sequenced (reliable ordered and reliable unordered both qualify; a sequenced channel drops superseded packets, so a write on it can vanish without trace). A write arriving on any other channel is refused `message_invalid` with `details.field: "channel"` (the transport profile's word for it) and fixed text. Receipts and refusals travel the reliable channel; a write that could be lost without trace cannot be answered once.
|
|
||||||
- Past the session (or a server's longer retention, if it keeps one) a resend is a new write.
|
|
||||||
6. **Forwarded writes.** A server that forwards a non-primary write answers the original peer only with what the primary answered: the primary's receipt becomes `write_admitted` with the original id, its refusal becomes `error.v1` with the original id. If the forward gets no answer the server relays nothing: no receipt, no error, no synthesized refusal. The client's own rule below then reports the write as unconfirmed. A forwarder never turns an absent or ambiguous primary answer into an admission.
|
|
||||||
7. **Looks alike.** An admitted and a refused write differ in `schemaVersion`; a receipt has no `error`, an `error.v1` has no admission. A transport ack is neither.
|
|
||||||
|
|
||||||
## Client rules: three outcomes
|
|
||||||
|
|
||||||
A write settles as exactly one of:
|
|
||||||
|
|
||||||
- **admitted**: a `write_admitted` whose `messageId` is the write's.
|
|
||||||
- **refused**: an `error.v1` whose `messageId` is the write's, carrying its `code` and `details` as the typed error.
|
|
||||||
- **unconfirmed**: nothing settled it. Reasons: `window_elapsed` (the result window ran from the *send* and passed with no answer; see Result window), `session_ended` (the peer closed the session, or it ended, before the write was answered) and `local_send_failed` (the client's own send of this write failed). A local send failure is never reported as refused: no server answer exists, and the write may or may not have left the machine. Unconfirmed is not success and not refusal. APIs that return a value return the tri-state; APIs that throw throw a distinct refused error and a distinct unconfirmed error and return normally only for admitted. A caller that needs admission treats unconfirmed as not admitted. Resend with the same `messageId` and unchanged content, **on the same session**, is safe against a receipt-capable server (rule 5). After a reconnect the resend is a new write, and a legacy server may apply a resend twice: the caller resends only writes that are idempotent by record key (a put of the same content to the same key, a delete of a key), and reads the record back before resending any other.
|
|
||||||
|
|
||||||
**Result window.** Two named constants (also in the vectors): `RECEIPT_RESULT_WINDOW_MS = 5000`, the default against a receipt-capable server (its hello lists both frames); `LEGACY_RESULT_WINDOW_MS = 500`, used only as the fallback against a server whose hello does not list them (or that sent none). The window runs from the send. A receipt-capable server that has not answered within its window is reported as unconfirmed like any other; clients log it as a server that missed its window.
|
|
||||||
|
|
||||||
**Late answers.** An answer for a write that already settled `unconfirmed` does not change what the caller was told, but the client records it on the write: a late `write_admitted` makes the write's recorded state `admitted_late`, a late refusal makes it `refused_late`. The write handle exposes that state, and a caller that got `unconfirmed` MUST consult it (and the record) before resending: it must not blind-resend a write that was admitted late. A resend on the same session with the same id and content is harmless on a receipt-capable server (rule 5); across a reconnect the caller follows the idempotence rule above.
|
|
||||||
|
|
||||||
**Legacy answers.** An `error.v0`, or an `error.v1` with nil `messageId`, names no write. It is attributed to a write only when exactly one write on the connection is unanswered; it then refuses that write. With two or more unanswered writes it settles none of them and each ends unconfirmed at its window. A frame naming a `messageId` that is not in flight settles nothing.
|
|
||||||
|
|
||||||
**Batches can commit partially.** A batch is N independent writes with no atomicity: some members may be admitted while others are refused or unanswered, and nothing is rolled back. The client reports each member's outcome and a batch result is only their set: admitted if every member is admitted, refused if any member is refused (naming the members), otherwise unconfirmed (naming the unanswered members). The caller owns retry: it resends exactly the members that are not admitted, with their original ids.
|
|
||||||
|
|
||||||
## Changes to what #55 to #58 shipped
|
|
||||||
|
|
||||||
Those clients complete *successfully* when the window ends with no refusal. Under this spec that case is `unconfirmed`. The TypeScript one-shot writer (#62) already reports it so: it resolves `admitted` only on a `write_admitted` carrying the put's id, and no other frame, a put echoed under the same id included, ever counts as admission. A caller whose server cannot answer a write yet (Odin, until it is receipt-capable) opts into the explicit send-only mode per call (`sendOnly: true`), which resolves the distinct outcome `sent` once the transport has acknowledged the put and never `admitted`. The Idunn presence publisher is send-only by its own function (`sendPresenceDocument`, not the `sendOnly` option): the same `sent` result, plus a rejection if a refusal naming the put (or naming nothing) arrives by the transport ack. Receipts and send-only are both opt-in, neither is the default. The C# and Rust clients of #55 to #58 keep the window-success until their conformance work lands, and callers of those must not read it as admission.
|
|
||||||
|
|
||||||
## Vectors
|
|
||||||
|
|
||||||
`write-receipt-vectors.json`: `constants` (the named windows and retention), `contentHash` (worked dedupe hashes), `dedupe` (server replay cases for rule 5), `wire` (MessagePack hex plus the decoded message for each new frame; the bytes are spec-authored with msgpack-python and every runtime's first conformance PR re-captures them with its own encoder and must match), `schemaInvalid` (frames that must be refused by a validator, each with why), and `scenarios` (event replays with the outcome each write must settle as; the clock is abstract; each case names its window constant). A conformant client passes every scenario; a conformant server's answers for the same inputs satisfy server rules 1 to 7.
|
|
||||||
|
|
||||||
## Conformance status
|
|
||||||
|
|
||||||
| Server class | Advertises both frames | Server-wide memory budget (MAY, Remembered-write limits) |
|
|
||||||
|---|---|---|
|
|
||||||
| `CultNetDatabaseServer` | yes | not implemented: only the per-session limit of 1024 applies |
|
|
||||||
| Shard write forwarder | yes | not implemented: only the per-session limit of 1024 applies |
|
|
||||||
| Rust RUDP document server | yes | implemented (32 MiB default, `max_remembered_write_bytes`) |
|
|
||||||
| C# RUDP schema server (`CultNetRudpSchemaServer`, `src/GameCult.Networking/CultNetRudpSchemaServer.cs`) | no | n/a |
|
|
||||||
|
|
||||||
Advertising is per server class, not per transport. A class advertises both frames in its hello only if it implements the receipt rules end to end; the C# RUDP schema server stays "no" until it answers writes with receipts.
|
|
||||||
|
|
||||||
## Conformance follow-ups (not in this PR)
|
|
||||||
|
|
||||||
C# server and client, Rust, TypeScript, Python, Kotlin: emit and parse the two frames; hello capability; tri-state client outcome; replace the #55 to #58 window-success; re-capture the wire vectors in each runtime. Server write paths include the shard write forwarder (rule 6) and the Odin catalog.
|
|
||||||
|
|
@ -441,8 +441,8 @@ consumer that waits wants delivered, which is now just Acknowledged.
|
||||||
| `cultmesh-rs/src/lib.rs:781-838` `request_raw_snapshot_from_rudp_catalog` (Idunn `src/drivers.rs:5527` uses it) | a hand-rolled loop until `Acknowledged`, then the response | Cut 4: `wait_acknowledged` |
|
| `cultmesh-rs/src/lib.rs:781-838` `request_raw_snapshot_from_rudp_catalog` (Idunn `src/drivers.rs:5527` uses it) | a hand-rolled loop until `Acknowledged`, then the response | Cut 4: `wait_acknowledged` |
|
||||||
| `cultmesh-rs/src/lib.rs:870-900` `publish_cultnet_message_to_rudp_catalog` (Odin `odin-daemon`) | a hand-rolled loop until `Acknowledged`, then disconnect. The doc at `:869` claims "application admission" | Cut 4: `wait_acknowledged`; the doc says delivered to the document server's sink (`rudp_document_server.rs:343-372`) |
|
| `cultmesh-rs/src/lib.rs:870-900` `publish_cultnet_message_to_rudp_catalog` (Odin `odin-daemon`) | a hand-rolled loop until `Acknowledged`, then disconnect. The doc at `:869` claims "application admission" | Cut 4: `wait_acknowledged`; the doc says delivered to the document server's sink (`rudp_document_server.rs:343-372`) |
|
||||||
| `cultmesh-rs/src/lib.rs:918-938` `publish_cultnet_messages_to_rudp_catalog` (Ghostlight `mesh.rs:323`) | `flush_reliable`, then drop. **Several ordered frames, then close** | None; flush now means it |
|
| `cultmesh-rs/src/lib.rs:918-938` `publish_cultnet_messages_to_rudp_catalog` (Ghostlight `mesh.rs:323`) | `flush_reliable`, then drop. **Several ordered frames, then close** | None; flush now means it |
|
||||||
| `cultmesh-ts/src/index.ts:6211-6303` `publishRudpDocumentOnce` (Heimdall, StreamPixels, Stonks, weksa, Bifrost, VoidBot, Hermodr) | `peer.flush` (`cultnet-ts/src/peer.ts:109-110`), then close | None. Cut 5 moves its connect-and-wait helper (`index.ts:6603-6650`) into cultnet-ts |
|
| `cultmesh-ts/src/index.ts:6070-6098` `publishRudpDocumentOnce` (Heimdall, StreamPixels, Stonks, weksa, Bifrost, VoidBot, Hermodr) | `peer.flush` (`cultnet-ts/src/peer.ts:109-110`), then close | None. Cut 5 moves its connect-and-wait helper (`index.ts:6603-6650`) into cultnet-ts |
|
||||||
| `cultnet-ts/src/idunn-odin-presence-publisher.ts:97-136` `sendPresenceDocument` (formerly `publishDocument`), behind `createIdunnRuntimePresencePublisher`. **StreamPixels' service runs this**: `apps/service/scripts/idunn-entry.mjs` runs `deployment/idunn/runtime-presence.mjs`, which calls `createIdunnRuntimePresencePublisher` (`:46`) from its vendored CultLib `542ddd3` (StreamPixels `a49f7d8`; pass 2's `30ee8b9` is stale), where it lives under its older name `cultnet-ts/src/idunn-runtime-authority.ts:206` | a hand-rolled session loop (`:186-208`) until `outstandingReliablePacketCount === 0`. It does resend (`:205`). It drops `readyToSend` (`:198`), so promoted queued packets wait for the resend timer. It pins `initialSequence: 1` (`:103`) and never sends a Disconnect, so Odin's hub keeps each publish's peer until it times out (each publish binds a new port, so each is a new peer) | Cut 5: the socket transport, `connectAndWait`, `send("schema")`, `flush`, `close` (which sends the Disconnect, `rudp.ts:956-969`) |
|
| `cultnet-ts/src/idunn-odin-presence-publisher.ts:89-215` `publishDocument`, behind `createIdunnRuntimePresencePublisher`. **StreamPixels' service runs this**: `apps/service/scripts/idunn-entry.mjs` runs `deployment/idunn/runtime-presence.mjs`, which calls `createIdunnRuntimePresencePublisher` (`:46`) from its vendored CultLib `542ddd3` (StreamPixels `a49f7d8`; pass 2's `30ee8b9` is stale), where it lives under its older name `cultnet-ts/src/idunn-runtime-authority.ts:206` | a hand-rolled session loop (`:186-208`) until `outstandingReliablePacketCount === 0`. It does resend (`:205`). It drops `readyToSend` (`:198`), so promoted queued packets wait for the resend timer. It pins `initialSequence: 1` (`:103`) and never sends a Disconnect, so Odin's hub keeps each publish's peer until it times out (each publish binds a new port, so each is a new peer) | Cut 5: the socket transport, `connectAndWait`, `send("schema")`, `flush`, `close` (which sends the Disconnect, `rudp.ts:956-969`) |
|
||||||
| `cultnet-ts/src/signed-daemon-health.ts:104-162` `publishSignedDaemonHealth` (Hermodr, Odin `idunn-rudp.cjs`) | a hand-rolled loop: sends the packets `sendMany` admitted, waits up to 500 ms for the **first** Ack packet of any content (`:146-153`), swallows the timeout, closes. Resends run inside that wait (`:303`) but promoted queued packets are never sent | Cut 5, as above. Today a write not acked within 500 ms, or any payload over 32 packets, is reported published |
|
| `cultnet-ts/src/signed-daemon-health.ts:104-162` `publishSignedDaemonHealth` (Hermodr, Odin `idunn-rudp.cjs`) | a hand-rolled loop: sends the packets `sendMany` admitted, waits up to 500 ms for the **first** Ack packet of any content (`:146-153`), swallows the timeout, closes. Resends run inside that wait (`:303`) but promoted queued packets are never sent | Cut 5, as above. Today a write not acked within 500 ms, or any payload over 32 packets, is reported published |
|
||||||
| `cultnet-ts/src/operation-service.ts` | the operation response | none (the response is the proof) |
|
| `cultnet-ts/src/operation-service.ts` | the operation response | none (the response is the proof) |
|
||||||
| C# `FlushReliable` callers: Gjallar `Program.cs:3055-3080` (two ordered frames, flush, dispose) | flush | None |
|
| C# `FlushReliable` callers: Gjallar `Program.cs:3055-3080` (two ordered frames, flush, dispose) | flush | None |
|
||||||
|
|
|
||||||
File diff suppressed because it is too large
Load diff
File diff suppressed because it is too large
Load diff
|
|
@ -5,13 +5,8 @@ All notable changes to `@gamecult/cultmesh-ts` are recorded here, following
|
||||||
|
|
||||||
## Unreleased
|
## Unreleased
|
||||||
|
|
||||||
### Added
|
|
||||||
|
|
||||||
- `publishRudpDocumentOnce` takes `writeReceipts: true`: it sends a hello listing `cultnet.write_admitted.v0` and `cultnet.error.v1` and, against a server that lists both back, resolves only on that write's `write_admitted`, rejects with `CultMeshRudpWriteRefusedError` (now also carrying an `error.v1`) on its refusal and with the new `CultMeshRudpWriteUnconfirmedError` (`reason`: `window_elapsed` after 5000 ms, `session_ended`, or `local_send_failed`) when nothing settles it. Without the option, or against a server that did not advertise, there is no hello and the window is 500 ms; a put nothing settled in it is unconfirmed too, no longer "published" (**behaviour change**: a server that applies a put but answers nothing now yields `CultMeshRudpWriteUnconfirmedError`, as the spec requires). A legacy server's echo of the put's id is not admission: only `write_admitted` is. The flush that sends the put is bounded by the result window, and a send not acknowledged by then is `local_send_failed`. `resultWindowMs` overrides either window. `publishRudpDocumentAndWaitForReceipt` is not changed.
|
|
||||||
|
|
||||||
### Breaking
|
### Breaking
|
||||||
|
|
||||||
- `publishRudpDocumentOnce` no longer treats a window with no refusal as published: a put nothing settled in its result window (500 ms, or 5000 ms against a receipt-capable server) rejects `CultMeshRudpWriteUnconfirmedError`, and a legacy server's echo of the put's id is not admission. It now resolves `"admitted"` (only on a `write_admitted`) or `"sent"`. **Migration:** a caller whose server cannot answer a write yet (for example Odin, until it is receipt-capable) passes `sendOnly: true` per call and treats `"sent"` as "sent", never as admitted. Receipts stay opt-in (`writeReceipts: true`); neither mode is the default.
|
|
||||||
- The package is renamed `cultmesh-ts` to `@gamecult/cultmesh-ts` (the repo already scopes `@gamecult/cultcache-ts`), so the unscoped name cannot be claimed by someone else. Import from `@gamecult/cultmesh-ts` and its subpaths; the API is unchanged. Depends on `@gamecult/cultnet-ts`.
|
- The package is renamed `cultmesh-ts` to `@gamecult/cultmesh-ts` (the repo already scopes `@gamecult/cultcache-ts`), so the unscoped name cannot be claimed by someone else. Import from `@gamecult/cultmesh-ts` and its subpaths; the API is unchanged. Depends on `@gamecult/cultnet-ts`.
|
||||||
- `asSchemaAlias` is removed from `CultMeshDocumentHandle`, `CultMeshCollectionHandle` and their bound forms. Read the handle by the schema you mean.
|
- `asSchemaAlias` is removed from `CultMeshDocumentHandle`, `CultMeshCollectionHandle` and their bound forms. Read the handle by the schema you mean.
|
||||||
- `CultMeshDocumentCatalog` (`document`, `tryDocument`, `latest`, `replace`, `submitPrediction`, `authoritativeWriter`, `predictionWriter`, `watch`) and `CultMeshCollectionCatalog` (`collection`, `tryCollection`, `latest`, `watchChanges`) take `<TDocument = never, TSchema>` and yield `CultMeshCatalogValue<TDocument, TSchema>`: an explicit type argument wins, a CultCache document definition names its own value type, and a bare schema descriptor yields `unknown`. A value type is no longer inferred from a value or an expected result. The `parse` option is removed from these calls, and a lookup by type answers with that type's handle or none, not an alias of a compatible schema.
|
- `CultMeshDocumentCatalog` (`document`, `tryDocument`, `latest`, `replace`, `submitPrediction`, `authoritativeWriter`, `predictionWriter`, `watch`) and `CultMeshCollectionCatalog` (`collection`, `tryCollection`, `latest`, `watchChanges`) take `<TDocument = never, TSchema>` and yield `CultMeshCatalogValue<TDocument, TSchema>`: an explicit type argument wins, a CultCache document definition names its own value type, and a bare schema descriptor yields `unknown`. A value type is no longer inferred from a value or an expected result. The `parse` option is removed from these calls, and a lookup by type answers with that type's handle or none, not an alias of a compatible schema.
|
||||||
|
|
|
||||||
|
|
@ -20,10 +20,6 @@ import {
|
||||||
CultNetRudpSocketTransportConnection,
|
CultNetRudpSocketTransportConnection,
|
||||||
rudpClientBindHost,
|
rudpClientBindHost,
|
||||||
CultNetSchemaCatalog,
|
CultNetSchemaCatalog,
|
||||||
CULTNET_WRITE_RECEIPT_MESSAGE_VERSIONS,
|
|
||||||
WriteTracker,
|
|
||||||
helloAdvertisesWriteReceipts,
|
|
||||||
resultWindowMs,
|
|
||||||
cultNetMessageInvalidError,
|
cultNetMessageInvalidError,
|
||||||
cultNetTextError,
|
cultNetTextError,
|
||||||
cultNetWriteNotAuthorizedError,
|
cultNetWriteNotAuthorizedError,
|
||||||
|
|
@ -48,8 +44,6 @@ import {
|
||||||
type CultNetSchemaCatalogOptions,
|
type CultNetSchemaCatalogOptions,
|
||||||
type CultNetSnapshotResponseRawMessage,
|
type CultNetSnapshotResponseRawMessage,
|
||||||
type CultNetWireContract,
|
type CultNetWireContract,
|
||||||
type WriteSettlement,
|
|
||||||
type WriteUnconfirmedReason,
|
|
||||||
} from "@gamecult/cultnet-ts";
|
} from "@gamecult/cultnet-ts";
|
||||||
|
|
||||||
import {
|
import {
|
||||||
|
|
@ -4195,8 +4189,8 @@ export interface CultMeshRudpDocumentServer {
|
||||||
*/
|
*/
|
||||||
export class CultMeshRudpWriteRefusedError extends Error {
|
export class CultMeshRudpWriteRefusedError extends Error {
|
||||||
readonly code: string | undefined;
|
readonly code: string | undefined;
|
||||||
readonly response: Extract<CultNetMessage, { schemaVersion: "cultnet.error.v0" | "cultnet.error.v1" }>;
|
readonly response: Extract<CultNetMessage, { schemaVersion: "cultnet.error.v0" }>;
|
||||||
constructor(response: Extract<CultNetMessage, { schemaVersion: "cultnet.error.v0" | "cultnet.error.v1" }>) {
|
constructor(response: Extract<CultNetMessage, { schemaVersion: "cultnet.error.v0" }>) {
|
||||||
super(response.error);
|
super(response.error);
|
||||||
this.name = "CultMeshRudpWriteRefusedError";
|
this.name = "CultMeshRudpWriteRefusedError";
|
||||||
this.code = response.code ?? undefined;
|
this.code = response.code ?? undefined;
|
||||||
|
|
@ -4204,49 +4198,14 @@ export class CultMeshRudpWriteRefusedError extends Error {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Nothing settled the write (write-receipt.md, "unconfirmed"): the result window ran out with no answer, the
|
|
||||||
* session ended first, or the client's own send failed. Not success and not refusal; a caller that needs admission treats it as not admitted.
|
|
||||||
*/
|
|
||||||
export class CultMeshRudpWriteUnconfirmedError extends Error {
|
|
||||||
readonly reason: WriteUnconfirmedReason;
|
|
||||||
readonly messageId: string;
|
|
||||||
constructor(messageId: string, reason: WriteUnconfirmedReason) {
|
|
||||||
super(`Write ${messageId} was not confirmed: ${reason}.`);
|
|
||||||
this.name = "CultMeshRudpWriteUnconfirmedError";
|
|
||||||
this.reason = reason;
|
|
||||||
this.messageId = messageId;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface CultMeshRudpDocumentPublishOptions extends CultMeshRudpPeerOptions {
|
export interface CultMeshRudpDocumentPublishOptions extends CultMeshRudpPeerOptions {
|
||||||
/**
|
/**
|
||||||
* How long, counted from the send, the put may wait for its result frame. A reliable-transport ack is not
|
* How long after the put's transport ack a refusal may still arrive. A reliable-transport ack is not
|
||||||
* admission; the outcome is the peer's result frame. Default: 5000 ms against a server whose hello lists the
|
* admission; the outcome is the peer's result frame. A server that answers a put only on refusal sends no
|
||||||
* write-receipt frames, 500 ms otherwise. A put nothing settled within the window is unconfirmed, never
|
* success frame, so the put is reported published once this window passes with no refusal; a success reply
|
||||||
* published, whatever the server advertised: only a `write_admitted` is admission. The send itself is also
|
* ends the wait early. Default 500 ms.
|
||||||
* bounded by the window (`flushTimeoutMs` is the upper bound); a send not acknowledged by then is
|
|
||||||
* unconfirmed as `local_send_failed`.
|
|
||||||
*/
|
*/
|
||||||
resultWindowMs?: number;
|
resultWindowMs?: number;
|
||||||
/**
|
|
||||||
* Declare the write-receipt capability: send a hello listing `cultnet.write_admitted.v0` and `cultnet.error.v1`
|
|
||||||
* before the put. A server that lists both back is receipt-capable: the put then resolves only on its
|
|
||||||
* `write_admitted`, rejects with `CultMeshRudpWriteRefusedError` on its `error.v1`, and rejects with
|
|
||||||
* `CultMeshRudpWriteUnconfirmedError` when nothing settles it. Unset, no hello is sent and the server answers
|
|
||||||
* as it always did.
|
|
||||||
*/
|
|
||||||
writeReceipts?: boolean;
|
|
||||||
/** With `writeReceipts`, how long to wait for the server's hello before treating it as legacy. Default 500 ms. */
|
|
||||||
helloWaitMs?: number;
|
|
||||||
/**
|
|
||||||
* Send the put and report only that it was sent: no hello, no wait for a result frame. Resolves `"sent"` once the
|
|
||||||
* transport has acknowledged the put (`flushTimeoutMs`), rejects `CultMeshRudpWriteUnconfirmedError`
|
|
||||||
* (`local_send_failed`) if it cannot be sent, and never resolves `"admitted"`: whether the server applied or
|
|
||||||
* refused it is unknown. For callers whose server cannot answer a write yet. Opt-in per call; not combinable with
|
|
||||||
* `writeReceipts`.
|
|
||||||
*/
|
|
||||||
sendOnly?: boolean;
|
|
||||||
messageId?: string;
|
messageId?: string;
|
||||||
sourceRuntimeId?: string;
|
sourceRuntimeId?: string;
|
||||||
sourceAgentId?: string;
|
sourceAgentId?: string;
|
||||||
|
|
@ -6216,88 +6175,44 @@ export class CultMesh {
|
||||||
recordKey: string,
|
recordKey: string,
|
||||||
value: CultCacheDocumentValue<TDefinition>,
|
value: CultCacheDocumentValue<TDefinition>,
|
||||||
options: CultMeshRudpDocumentPublishOptions = {},
|
options: CultMeshRudpDocumentPublishOptions = {},
|
||||||
): Promise<"admitted" | "sent"> {
|
): Promise<void> {
|
||||||
requireNonEmpty(runtimeId, "runtimeId");
|
requireNonEmpty(runtimeId, "runtimeId");
|
||||||
requireNonEmpty(recordKey, "recordKey");
|
requireNonEmpty(recordKey, "recordKey");
|
||||||
if (options.sendOnly && options.writeReceipts) throw new TypeError("sendOnly and writeReceipts cannot be combined.");
|
|
||||||
const registry = new CultNetDocumentRegistry([binding]);
|
const registry = new CultNetDocumentRegistry([binding]);
|
||||||
const messageId = options.messageId ?? `${runtimeId}:${binding.definition.type}:${recordKey}`;
|
const messageId = options.messageId ?? `${runtimeId}:${binding.definition.type}:${recordKey}`;
|
||||||
// Built before any connection and outside every try: a put that cannot be built is the caller's error, with its cause.
|
|
||||||
const put = registry.createRawDocumentPutMessage(
|
|
||||||
binding,
|
|
||||||
messageId,
|
|
||||||
recordKey,
|
|
||||||
value,
|
|
||||||
{
|
|
||||||
sourceRuntimeId: options.sourceRuntimeId ?? runtimeId,
|
|
||||||
sourceAgentId: options.sourceAgentId,
|
|
||||||
sourceRole: options.sourceRole,
|
|
||||||
tags: options.tags,
|
|
||||||
},
|
|
||||||
);
|
|
||||||
const peer = await CultMesh.createRudpPeer(runtimeId, connectionId, endpoint, options);
|
const peer = await CultMesh.createRudpPeer(runtimeId, connectionId, endpoint, options);
|
||||||
try {
|
try {
|
||||||
if (options.sendOnly) {
|
// A transport ack is not admission: the put completes on its result frame. A refusal rejects with the
|
||||||
try {
|
// typed error whether it arrives before the ack, after it, or inside the result window.
|
||||||
peer.send(put);
|
let refusal: CultMeshRudpWriteRefusedError | undefined;
|
||||||
await peer.flush(options.flushTimeoutMs ?? 30_000);
|
let succeeded = false;
|
||||||
} catch {
|
|
||||||
throw new CultMeshRudpWriteUnconfirmedError(messageId, "local_send_failed");
|
|
||||||
}
|
|
||||||
return "sent";
|
|
||||||
}
|
|
||||||
// A transport ack is not admission: the put completes on its result frame, and the WriteTracker alone decides
|
|
||||||
// how it settles (write-receipt.md, "Client rules"). This function only maps the settlement to resolve/throw.
|
|
||||||
let receiptCapable = false;
|
|
||||||
let tracker: WriteTracker | undefined;
|
|
||||||
let settlement: WriteSettlement | undefined;
|
|
||||||
let wake: (() => void) | undefined;
|
let wake: (() => void) | undefined;
|
||||||
let serverHello: (() => void) | undefined;
|
|
||||||
peer.on("message", (message: CultNetMessage) => {
|
peer.on("message", (message: CultNetMessage) => {
|
||||||
if (message.schemaVersion === "cultnet.hello.v0") {
|
if (message.schemaVersion === "cultnet.error.v0") refusal ??= new CultMeshRudpWriteRefusedError(message);
|
||||||
receiptCapable = helloAdvertisesWriteReceipts(message);
|
else if ("messageId" in message && message.messageId === messageId) succeeded = true;
|
||||||
serverHello?.();
|
else return;
|
||||||
} else {
|
wake?.();
|
||||||
tracker?.frame(message, Date.now());
|
|
||||||
}
|
|
||||||
});
|
});
|
||||||
peer.on("close", () => tracker?.sessionEnd(Date.now()));
|
peer.send(registry.createRawDocumentPutMessage(
|
||||||
if (options.writeReceipts) {
|
binding,
|
||||||
const answered = new Promise<void>((resolve) => { serverHello = resolve; });
|
messageId,
|
||||||
peer.sendHello({
|
recordKey,
|
||||||
schemaVersion: "cultnet.hello.v0", runtimeId, runtimeKind: "cultmesh-ts",
|
value,
|
||||||
supportedMessageVersions: [...CULTNET_WRITE_RECEIPT_MESSAGE_VERSIONS],
|
{
|
||||||
});
|
sourceRuntimeId: options.sourceRuntimeId ?? runtimeId,
|
||||||
let helloTimer: NodeJS.Timeout | undefined;
|
sourceAgentId: options.sourceAgentId,
|
||||||
await Promise.race([answered, new Promise<void>((resolve) => { helloTimer = setTimeout(resolve, options.helloWaitMs ?? 500); })]);
|
sourceRole: options.sourceRole,
|
||||||
clearTimeout(helloTimer);
|
tags: options.tags,
|
||||||
}
|
},
|
||||||
const writeTracker = new WriteTracker({
|
));
|
||||||
windowMs: options.resultWindowMs ?? resultWindowMs(receiptCapable),
|
await peer.flush(options.flushTimeoutMs ?? 30_000);
|
||||||
onSettle: (_id, result) => { settlement = result; wake?.(); },
|
if (!refusal && !succeeded) {
|
||||||
});
|
|
||||||
tracker = writeTracker;
|
|
||||||
writeTracker.send(messageId, Date.now());
|
|
||||||
try {
|
|
||||||
peer.send(put);
|
|
||||||
// The flush may not outlast the result window: a send nobody acknowledged by then is a local send failure.
|
|
||||||
const windowRemaining = writeTracker.nextDeadlineMs(Date.now()) ?? 0;
|
|
||||||
await peer.flush(Math.min(options.flushTimeoutMs ?? 30_000, Math.max(windowRemaining, 1)));
|
|
||||||
} catch {
|
|
||||||
// Our own send failed or was never acknowledged: the put may or may not have left. Never a refusal.
|
|
||||||
writeTracker.sendFailed(messageId, Date.now());
|
|
||||||
}
|
|
||||||
while (!settlement) {
|
|
||||||
const remaining = writeTracker.nextDeadlineMs(Date.now()) ?? 0;
|
|
||||||
await new Promise<void>((resolve) => {
|
await new Promise<void>((resolve) => {
|
||||||
const timer = setTimeout(resolve, remaining);
|
const timer = setTimeout(resolve, options.resultWindowMs ?? 500);
|
||||||
wake = () => { clearTimeout(timer); resolve(); };
|
wake = () => { clearTimeout(timer); resolve(); };
|
||||||
});
|
});
|
||||||
writeTracker.tick(Date.now());
|
|
||||||
}
|
}
|
||||||
if (settlement.outcome === "refused") throw new CultMeshRudpWriteRefusedError(settlement.response);
|
if (refusal) throw refusal;
|
||||||
if (settlement.outcome === "unconfirmed") throw new CultMeshRudpWriteUnconfirmedError(messageId, settlement.reason);
|
|
||||||
return "admitted";
|
|
||||||
} finally {
|
} finally {
|
||||||
peer.close();
|
peer.close();
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -16,7 +16,7 @@ import {
|
||||||
encodeRudpPacket,
|
encodeRudpPacket,
|
||||||
} from "@gamecult/cultnet-ts";
|
} from "@gamecult/cultnet-ts";
|
||||||
import { encodeWireValue } from "@gamecult/cultnet-ts/wire";
|
import { encodeWireValue } from "@gamecult/cultnet-ts/wire";
|
||||||
import { CultMesh, CultMeshGrantAllWrites, CultMeshRudpWriteRefusedError, CultMeshRudpWriteUnconfirmedError } from "../src/index";
|
import { CultMesh, CultMeshGrantAllWrites, CultMeshRudpWriteRefusedError } from "../src/index";
|
||||||
|
|
||||||
const isTheRefusal = (error: unknown): boolean =>
|
const isTheRefusal = (error: unknown): boolean =>
|
||||||
error instanceof CultMeshRudpWriteRefusedError && error.code === "write_not_authorized";
|
error instanceof CultMeshRudpWriteRefusedError && error.code === "write_not_authorized";
|
||||||
|
|
@ -100,7 +100,7 @@ for (const order of orders) {
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
test("a put the server applied but did not answer is unconfirmed, never published", async () => {
|
test("publishRudpDocumentOnce still publishes a put the server admitted", async () => {
|
||||||
const connectionId = nextConnection++;
|
const connectionId = nextConnection++;
|
||||||
const puts: string[] = [];
|
const puts: string[] = [];
|
||||||
const server = CultMesh.createRudpDocumentServer("completion-admit", connectionId, {
|
const server = CultMesh.createRudpDocumentServer("completion-admit", connectionId, {
|
||||||
|
|
@ -111,10 +111,7 @@ test("a put the server applied but did not answer is unconfirmed, never publishe
|
||||||
});
|
});
|
||||||
await server.start();
|
await server.start();
|
||||||
try {
|
try {
|
||||||
await assert.rejects(
|
await CultMesh.publishRudpDocumentOnce("completion-admit-client", connectionId, `rudp://127.0.0.1:${server.bind.port}`, binding, "tests:completion:a", { noteId: "a", text: "x" }, { resendDelayMs: 50, resendPollMs: 5, resultWindowMs: 200 });
|
||||||
CultMesh.publishRudpDocumentOnce("completion-admit-client", connectionId, `rudp://127.0.0.1:${server.bind.port}`, binding, "tests:completion:a", { noteId: "a", text: "x" }, { resendDelayMs: 50, resendPollMs: 5, resultWindowMs: 200 }),
|
assert.deepEqual(puts, ["tests:completion:a"]);
|
||||||
(error: unknown) => error instanceof CultMeshRudpWriteUnconfirmedError && error.reason === "window_elapsed",
|
|
||||||
);
|
|
||||||
assert.deepEqual(puts, ["tests:completion:a"], "the server did apply it; this server just does not answer");
|
|
||||||
} finally { server.close(); }
|
} finally { server.close(); }
|
||||||
});
|
});
|
||||||
|
|
|
||||||
|
|
@ -21,7 +21,7 @@ import {
|
||||||
type CultNetMessage,
|
type CultNetMessage,
|
||||||
type CultNetSnapshotResponseRawMessage,
|
type CultNetSnapshotResponseRawMessage,
|
||||||
} from "@gamecult/cultnet-ts";
|
} from "@gamecult/cultnet-ts";
|
||||||
import { CultMesh, CultMeshGrantAllWrites, CultMeshRudpUnservableDocumentError, CultMeshRudpWriteUnconfirmedError } from "../src/index";
|
import { CultMesh, CultMeshGrantAllWrites, CultMeshRudpUnservableDocumentError } from "../src/index";
|
||||||
|
|
||||||
// A record's payload as the bytes a peer would put on the wire.
|
// A record's payload as the bytes a peer would put on the wire.
|
||||||
const payloadOf = (value: unknown) => documentPayloadFromBytes(encodeWireValue(value));
|
const payloadOf = (value: unknown) => documentPayloadFromBytes(encodeWireValue(value));
|
||||||
|
|
@ -2968,30 +2968,25 @@ test("CultMesh TS publishes one registered document to a RUDP catalog", async ()
|
||||||
|
|
||||||
try {
|
try {
|
||||||
await server.start();
|
await server.start();
|
||||||
// This server answers a put with nothing, so the writer cannot know the put landed: unconfirmed, though it did.
|
await CultMesh.publishRudpDocumentOnce(
|
||||||
await assert.rejects(
|
"cultmesh-ts-muninn",
|
||||||
CultMesh.publishRudpDocumentOnce(
|
connectionId,
|
||||||
"cultmesh-ts-muninn",
|
`rudp://127.0.0.1:${server.bind.port}`,
|
||||||
connectionId,
|
defineCultNetDocumentBinding({ definition: noteDocument }),
|
||||||
`rudp://127.0.0.1:${server.bind.port}`,
|
"note:odin",
|
||||||
defineCultNetDocumentBinding({ definition: noteDocument }),
|
{
|
||||||
"note:odin",
|
noteId: "note:odin",
|
||||||
{
|
body: "pay respects once",
|
||||||
noteId: "note:odin",
|
},
|
||||||
body: "pay respects once",
|
{
|
||||||
},
|
resendDelayMs: 25,
|
||||||
{
|
resendPollMs: 5,
|
||||||
resendDelayMs: 25,
|
maxFragmentBytes: 1024,
|
||||||
resendPollMs: 5,
|
maxPendingReliablePackets: 16,
|
||||||
maxFragmentBytes: 1024,
|
connectTimeoutMs: 1_000,
|
||||||
maxPendingReliablePackets: 16,
|
flushTimeoutMs: 25,
|
||||||
connectTimeoutMs: 1_000,
|
sourceRole: "test-provider",
|
||||||
flushTimeoutMs: 25,
|
},
|
||||||
resultWindowMs: 100,
|
|
||||||
sourceRole: "test-provider",
|
|
||||||
},
|
|
||||||
),
|
|
||||||
(error: unknown) => error instanceof CultMeshRudpWriteUnconfirmedError && error.reason === "window_elapsed",
|
|
||||||
);
|
);
|
||||||
|
|
||||||
await waitFor(() => received !== undefined, "published RUDP document");
|
await waitFor(() => received !== undefined, "published RUDP document");
|
||||||
|
|
|
||||||
|
|
@ -1,243 +0,0 @@
|
||||||
// Client side of contracts/cultnet/interop/write-receipt.md in the one-shot writer: with `writeReceipts` the put
|
|
||||||
// completes only on a write_admitted carrying its id; a refusal, a silent window and a legacy server each end as the
|
|
||||||
// spec says. Each test serves the client a fake RUDP peer that acknowledges the put and answers as scripted.
|
|
||||||
import assert from "node:assert/strict";
|
|
||||||
import { createSocket, type Socket } from "node:dgram";
|
|
||||||
import test from "node:test";
|
|
||||||
import { z } from "zod";
|
|
||||||
import { defineDocumentType } from "@gamecult/cultcache-ts";
|
|
||||||
import {
|
|
||||||
CULTNET_WRITE_RECEIPT_MESSAGE_VERSIONS,
|
|
||||||
CultNetRudpSession,
|
|
||||||
decodeRudpPacket,
|
|
||||||
defineCultNetDocumentBinding,
|
|
||||||
encodeCultNetMessageForWire,
|
|
||||||
encodeRudpPacket,
|
|
||||||
type CultNetMessage,
|
|
||||||
} from "@gamecult/cultnet-ts";
|
|
||||||
import { decodeWireValue, encodeWireValue } from "@gamecult/cultnet-ts/wire";
|
|
||||||
import { CultMesh, CultMeshRudpWriteRefusedError, CultMeshRudpWriteUnconfirmedError } from "../src/index";
|
|
||||||
|
|
||||||
const note = defineDocumentType({
|
|
||||||
type: "cultmesh.receipt_note",
|
|
||||||
schemaId: "cultmesh.receipt_note.v0",
|
|
||||||
schema: z.object({ noteId: z.string(), text: z.string() }),
|
|
||||||
name: "noteId",
|
|
||||||
});
|
|
||||||
const binding = defineCultNetDocumentBinding({ definition: note });
|
|
||||||
let nextConnection = 0x10206000;
|
|
||||||
|
|
||||||
interface Script {
|
|
||||||
/** Does the server's hello list both receipt frames? */
|
|
||||||
advertise: boolean;
|
|
||||||
/** What the server answers a put with, `delayMs` after it arrives. */
|
|
||||||
answer: "admit" | "refuse" | "wrong-id" | "silence" | "goodbye" | "echo";
|
|
||||||
delayMs?: number;
|
|
||||||
/** Acknowledge the reliable packets it receives? Default true. */
|
|
||||||
ack?: boolean;
|
|
||||||
}
|
|
||||||
|
|
||||||
async function fakeServer(connectionId: number, script: Script) {
|
|
||||||
const socket: Socket = createSocket("udp4");
|
|
||||||
await new Promise<void>((resolve) => socket.bind(0, "127.0.0.1", resolve));
|
|
||||||
const session = new CultNetRudpSession({ connectionId, resendDelayMs: 50 });
|
|
||||||
const timers = new Set<NodeJS.Timeout>();
|
|
||||||
const seen: string[] = [];
|
|
||||||
let closed = false;
|
|
||||||
const send = (packet: Parameters<typeof encodeRudpPacket>[0], port: number, address: string) => {
|
|
||||||
if (!closed) socket.send(encodeRudpPacket(packet), port, address);
|
|
||||||
};
|
|
||||||
const say = (message: CultNetMessage, port: number, address: string) => {
|
|
||||||
const packets = session.sendMany("schema", encodeWireValue(encodeCultNetMessageForWire(message)), { reliable: true, ordered: true, nowMs: Date.now() });
|
|
||||||
packets.forEach((p) => send(p, port, address));
|
|
||||||
};
|
|
||||||
socket.on("message", (wire, remote) => {
|
|
||||||
const packet = decodeRudpPacket(wire);
|
|
||||||
const now = Date.now();
|
|
||||||
if (packet.packetType === "connect") {
|
|
||||||
send(session.acceptConnect(packet, now), remote.port, remote.address);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const result = session.receive(packet, now);
|
|
||||||
if (result.reply) send(result.reply, remote.port, remote.address);
|
|
||||||
for (const frame of result.delivered) {
|
|
||||||
if (frame.channelId !== "schema") continue;
|
|
||||||
const message = decodeWireValue(frame.payload) as { schemaVersion: string; messageId?: string };
|
|
||||||
seen.push(message.schemaVersion);
|
|
||||||
if (message.schemaVersion === "cultnet.hello.v0") {
|
|
||||||
say({
|
|
||||||
schemaVersion: "cultnet.hello.v0", runtimeId: "fake", runtimeKind: "fake",
|
|
||||||
...(script.advertise ? { supportedMessageVersions: [...CULTNET_WRITE_RECEIPT_MESSAGE_VERSIONS] } : {}),
|
|
||||||
}, remote.port, remote.address);
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
if (message.schemaVersion !== "cultnet.document_put_raw.v0" || script.answer === "silence") continue;
|
|
||||||
const timer = setTimeout(() => {
|
|
||||||
timers.delete(timer);
|
|
||||||
if (script.answer === "echo") {
|
|
||||||
say({ schemaVersion: "cultnet.document_put_raw.v0", messageId: message.messageId!, document: { schemaId: "cultmesh.receipt_note.v0", recordKey: "tests:receipt:a", storedAt: "t", payloadEncoding: "messagepack", payload: new Uint8Array([1]) } } as unknown as CultNetMessage, remote.port, remote.address);
|
|
||||||
} else if (script.answer === "goodbye") {
|
|
||||||
send(session.endUnsendableSession(new Error("scripted goodbye")), remote.port, remote.address);
|
|
||||||
} else if (script.answer === "refuse") {
|
|
||||||
say({ schemaVersion: "cultnet.error.v1", error: "write_not_authorized", routingHint: null, code: "write_not_authorized", details: null, messageId: message.messageId! }, remote.port, remote.address);
|
|
||||||
} else {
|
|
||||||
const messageId = script.answer === "wrong-id" ? "someone-else" : message.messageId!;
|
|
||||||
say({ schemaVersion: "cultnet.write_admitted.v0", messageId, operation: "put", schemaId: "cultmesh.receipt_note.v0", recordKey: "tests:receipt:a" }, remote.port, remote.address);
|
|
||||||
}
|
|
||||||
}, script.delayMs ?? 20);
|
|
||||||
timers.add(timer);
|
|
||||||
}
|
|
||||||
if (packet.reliable && script.ack !== false) send(session.createAckForReceived(packet.sequence), remote.port, remote.address);
|
|
||||||
});
|
|
||||||
return { endpoint: `rudp://127.0.0.1:${socket.address().port}`, seen, close: () => { closed = true; timers.forEach(clearTimeout); socket.close(); } };
|
|
||||||
}
|
|
||||||
|
|
||||||
const transport = { resendDelayMs: 50, resendPollMs: 5, flushTimeoutMs: 2_000 };
|
|
||||||
const publish = (server: { endpoint: string }, options: Record<string, unknown>) =>
|
|
||||||
CultMesh.publishRudpDocumentOnce("receipt-client", nextConnection++, server.endpoint, binding, "tests:receipt:a", { noteId: "a", text: "x" }, { ...transport, ...options });
|
|
||||||
|
|
||||||
test("a receipt-capable server's write_admitted completes the put, past the legacy 500 ms window", async () => {
|
|
||||||
const server = await fakeServer(nextConnection, { advertise: true, answer: "admit", delayMs: 700 });
|
|
||||||
try {
|
|
||||||
await publish(server, { writeReceipts: true });
|
|
||||||
assert.deepEqual(server.seen.slice(0, 2), ["cultnet.hello.v0", "cultnet.document_put_raw.v0"]);
|
|
||||||
} finally { server.close(); }
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a receipt-capable server's error.v1 refuses the put with its code", async () => {
|
|
||||||
const server = await fakeServer(nextConnection, { advertise: true, answer: "refuse" });
|
|
||||||
try {
|
|
||||||
await assert.rejects(publish(server, { writeReceipts: true }), (error: unknown) =>
|
|
||||||
error instanceof CultMeshRudpWriteRefusedError && error.code === "write_not_authorized" && error.response.schemaVersion === "cultnet.error.v1");
|
|
||||||
} finally { server.close(); }
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a receipt-capable server that stays silent leaves the put unconfirmed, never published", async () => {
|
|
||||||
const server = await fakeServer(nextConnection, { advertise: true, answer: "silence" });
|
|
||||||
try {
|
|
||||||
await assert.rejects(publish(server, { writeReceipts: true, resultWindowMs: 250 }), (error: unknown) =>
|
|
||||||
error instanceof CultMeshRudpWriteUnconfirmedError && error.reason === "window_elapsed");
|
|
||||||
} finally { server.close(); }
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a receipt for another id settles nothing", async () => {
|
|
||||||
const server = await fakeServer(nextConnection, { advertise: true, answer: "wrong-id" });
|
|
||||||
try {
|
|
||||||
await assert.rejects(publish(server, { writeReceipts: true, resultWindowMs: 250 }), CultMeshRudpWriteUnconfirmedError);
|
|
||||||
} finally { server.close(); }
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a server whose hello does not advertise leaves a silent put unconfirmed after the 500 ms window, never published", async () => {
|
|
||||||
const server = await fakeServer(nextConnection, { advertise: false, answer: "silence" });
|
|
||||||
const started = Date.now();
|
|
||||||
try {
|
|
||||||
await assert.rejects(publish(server, { writeReceipts: true }), (error: unknown) =>
|
|
||||||
error instanceof CultMeshRudpWriteUnconfirmedError && error.reason === "window_elapsed");
|
|
||||||
assert.ok(Date.now() - started >= 500, "the legacy window ran from the send");
|
|
||||||
} finally { server.close(); }
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a session that ends before any result leaves the put unconfirmed (session_ended), against a legacy server too", async () => {
|
|
||||||
for (const advertise of [false, true]) {
|
|
||||||
const server = await fakeServer(nextConnection, { advertise, answer: "goodbye" });
|
|
||||||
try {
|
|
||||||
await assert.rejects(publish(server, { writeReceipts: true, resultWindowMs: 3_000 }), (error: unknown) =>
|
|
||||||
error instanceof CultMeshRudpWriteUnconfirmedError && error.reason === "session_ended");
|
|
||||||
} finally { server.close(); }
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a put whose send is never acknowledged is unconfirmed as local_send_failed, not an untyped error", async () => {
|
|
||||||
const server = await fakeServer(nextConnection, { advertise: true, answer: "silence", ack: false });
|
|
||||||
const started = Date.now();
|
|
||||||
try {
|
|
||||||
await assert.rejects(publish(server, { writeReceipts: true, flushTimeoutMs: 300 }), (error: unknown) =>
|
|
||||||
error instanceof CultMeshRudpWriteUnconfirmedError && error.reason === "local_send_failed");
|
|
||||||
assert.ok(Date.now() - started < 2_500, "flushTimeoutMs bounds the send inside the 5 s window");
|
|
||||||
} finally { server.close(); }
|
|
||||||
});
|
|
||||||
|
|
||||||
test("the flush is bounded by the result window: a send nobody acknowledges is local_send_failed at the window, not at the flush timeout", async () => {
|
|
||||||
const server = await fakeServer(nextConnection, { advertise: true, answer: "silence", ack: false });
|
|
||||||
const started = Date.now();
|
|
||||||
try {
|
|
||||||
await assert.rejects(publish(server, { writeReceipts: true, resultWindowMs: 300, flushTimeoutMs: 20_000 }), (error: unknown) =>
|
|
||||||
error instanceof CultMeshRudpWriteUnconfirmedError && error.reason === "local_send_failed");
|
|
||||||
assert.ok(Date.now() - started < 3_000, "it did not wait out the 20 s flush timeout");
|
|
||||||
} finally { server.close(); }
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a server that does not advertise receipts and echoes the put's id back has not admitted it", async () => {
|
|
||||||
const server = await fakeServer(nextConnection, { advertise: false, answer: "echo" });
|
|
||||||
try {
|
|
||||||
await assert.rejects(publish(server, { writeReceipts: true, resultWindowMs: 300 }), (error: unknown) =>
|
|
||||||
error instanceof CultMeshRudpWriteUnconfirmedError && error.reason === "window_elapsed");
|
|
||||||
} finally { server.close(); }
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a silent server never yields admitted, in either mode: the default is unconfirmed, sendOnly is the distinct outcome sent", async () => {
|
|
||||||
const dflt = await fakeServer(nextConnection, { advertise: false, answer: "silence" });
|
|
||||||
try {
|
|
||||||
await assert.rejects(publish(dflt, { resultWindowMs: 200 }), CultMeshRudpWriteUnconfirmedError);
|
|
||||||
} finally { dflt.close(); }
|
|
||||||
const sendOnly = await fakeServer(nextConnection, { advertise: false, answer: "silence" });
|
|
||||||
try {
|
|
||||||
const outcome = await publish(sendOnly, { sendOnly: true });
|
|
||||||
assert.equal(outcome, "sent");
|
|
||||||
assert.notEqual(outcome, "admitted");
|
|
||||||
assert.deepEqual(sendOnly.seen, ["cultnet.document_put_raw.v0"], "sendOnly sends no hello");
|
|
||||||
} finally { sendOnly.close(); }
|
|
||||||
});
|
|
||||||
|
|
||||||
test("only a write_admitted resolves admitted, and sendOnly does not wait for or act on an answer", async () => {
|
|
||||||
const admitting = await fakeServer(nextConnection, { advertise: true, answer: "admit" });
|
|
||||||
try {
|
|
||||||
assert.equal(await publish(admitting, { writeReceipts: true }), "admitted");
|
|
||||||
} finally { admitting.close(); }
|
|
||||||
const refusing = await fakeServer(nextConnection, { advertise: true, answer: "refuse", delayMs: 1 });
|
|
||||||
try {
|
|
||||||
assert.equal(await publish(refusing, { sendOnly: true }), "sent", "a refusal is not awaited: sendOnly says only that the put was sent");
|
|
||||||
} finally { refusing.close(); }
|
|
||||||
});
|
|
||||||
|
|
||||||
test("sendOnly fails local_send_failed when the send is never acknowledged", async () => {
|
|
||||||
const server = await fakeServer(nextConnection, { advertise: true, answer: "silence", ack: false });
|
|
||||||
try {
|
|
||||||
await assert.rejects(publish(server, { sendOnly: true, flushTimeoutMs: 300 }), (error: unknown) =>
|
|
||||||
error instanceof CultMeshRudpWriteUnconfirmedError && error.reason === "local_send_failed");
|
|
||||||
} finally { server.close(); }
|
|
||||||
});
|
|
||||||
|
|
||||||
test("sendOnly keeps the cause of a put that cannot be built: it is not reported as local_send_failed", async () => {
|
|
||||||
const server = await fakeServer(nextConnection, { advertise: false, answer: "silence" });
|
|
||||||
try {
|
|
||||||
await assert.rejects(
|
|
||||||
CultMesh.publishRudpDocumentOnce("receipt-client", nextConnection++, server.endpoint, binding, "tests:receipt:a", { noteId: 1 } as unknown as { noteId: string; text: string }, { ...transport, sendOnly: true }),
|
|
||||||
(error: unknown) => !(error instanceof CultMeshRudpWriteUnconfirmedError) && error instanceof Error,
|
|
||||||
);
|
|
||||||
assert.deepEqual(server.seen, [], "nothing was sent");
|
|
||||||
} finally { server.close(); }
|
|
||||||
});
|
|
||||||
|
|
||||||
test("the receipt path keeps the cause of a put that cannot be built: it is not reported as local_send_failed", async () => {
|
|
||||||
const server = await fakeServer(nextConnection, { advertise: true, answer: "admit" });
|
|
||||||
try {
|
|
||||||
await assert.rejects(
|
|
||||||
CultMesh.publishRudpDocumentOnce("receipt-client", nextConnection++, server.endpoint, binding, "tests:receipt:a", { noteId: 1 } as unknown as { noteId: string; text: string }, { ...transport, writeReceipts: true }),
|
|
||||||
(error: unknown) => !(error instanceof CultMeshRudpWriteUnconfirmedError) && error instanceof Error,
|
|
||||||
);
|
|
||||||
assert.ok(!server.seen.includes("cultnet.document_put_raw.v0"), "no put was sent");
|
|
||||||
} finally { server.close(); }
|
|
||||||
});
|
|
||||||
|
|
||||||
test("sendOnly cannot be combined with writeReceipts", async () => {
|
|
||||||
await assert.rejects(publish({ endpoint: "rudp://127.0.0.1:9" }, { sendOnly: true, writeReceipts: true }), TypeError);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("without writeReceipts no hello is sent and the receipt frames are never asked for", async () => {
|
|
||||||
const server = await fakeServer(nextConnection, { advertise: true, answer: "silence" });
|
|
||||||
try {
|
|
||||||
await assert.rejects(publish(server, { resultWindowMs: 100 }), CultMeshRudpWriteUnconfirmedError);
|
|
||||||
assert.deepEqual(server.seen, ["cultnet.document_put_raw.v0"]);
|
|
||||||
} finally { server.close(); }
|
|
||||||
});
|
|
||||||
|
|
@ -249,9 +249,6 @@ pub enum CultNetErrorCode {
|
||||||
WriteNotAuthorized,
|
WriteNotAuthorized,
|
||||||
UnsupportedSchemaVersion,
|
UnsupportedSchemaVersion,
|
||||||
MessageInvalid,
|
MessageInvalid,
|
||||||
/// `cultnet.error.v1` only: the session's remembered-write limit is full. `cultnet.error.v0` neither
|
|
||||||
/// encodes nor decodes it, so its enum stays the schema's.
|
|
||||||
LimitReached,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl CultNetErrorCode {
|
impl CultNetErrorCode {
|
||||||
|
|
@ -266,7 +263,6 @@ impl CultNetErrorCode {
|
||||||
Self::WriteNotAuthorized => "write_not_authorized",
|
Self::WriteNotAuthorized => "write_not_authorized",
|
||||||
Self::UnsupportedSchemaVersion => "unsupported_schema_version",
|
Self::UnsupportedSchemaVersion => "unsupported_schema_version",
|
||||||
Self::MessageInvalid => "message_invalid",
|
Self::MessageInvalid => "message_invalid",
|
||||||
Self::LimitReached => "limit_reached",
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -281,7 +277,6 @@ impl CultNetErrorCode {
|
||||||
"write_not_authorized" => Ok(Self::WriteNotAuthorized),
|
"write_not_authorized" => Ok(Self::WriteNotAuthorized),
|
||||||
"unsupported_schema_version" => Ok(Self::UnsupportedSchemaVersion),
|
"unsupported_schema_version" => Ok(Self::UnsupportedSchemaVersion),
|
||||||
"message_invalid" => Ok(Self::MessageInvalid),
|
"message_invalid" => Ok(Self::MessageInvalid),
|
||||||
"limit_reached" => Ok(Self::LimitReached),
|
|
||||||
_ => Err(anyhow!("ErrorMessage.Code is not a recognized cultnet.error.v0 code")),
|
_ => Err(anyhow!("ErrorMessage.Code is not a recognized cultnet.error.v0 code")),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
@ -364,26 +359,6 @@ pub enum CultNetMessage {
|
||||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||||
details: Option<CultNetErrorDetails>,
|
details: Option<CultNetErrorDetails>,
|
||||||
},
|
},
|
||||||
/// `cultnet.error.v1` (contracts/cultnet/interop/write-receipt.md): `cultnet.error.v0` plus the id of the
|
|
||||||
/// request it answers. Sent only to a connection that declared the write-receipt capability.
|
|
||||||
#[serde(skip_deserializing)]
|
|
||||||
#[serde(rename = "cultnet.error.v1", rename_all = "camelCase")]
|
|
||||||
ErrorV1 {
|
|
||||||
error: String,
|
|
||||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
||||||
code: Option<CultNetErrorCode>,
|
|
||||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
||||||
details: Option<CultNetErrorDetails>,
|
|
||||||
message_id: Option<String>,
|
|
||||||
},
|
|
||||||
/// `cultnet.write_admitted.v0`: the receipt for one admitted put or delete, sent after its commit point.
|
|
||||||
#[serde(rename = "cultnet.write_admitted.v0", rename_all = "camelCase")]
|
|
||||||
WriteAdmitted {
|
|
||||||
message_id: String,
|
|
||||||
operation: String,
|
|
||||||
schema_id: String,
|
|
||||||
record_key: String,
|
|
||||||
},
|
|
||||||
#[serde(rename = "cultnet.sample.change_name.v0", rename_all = "camelCase")]
|
#[serde(rename = "cultnet.sample.change_name.v0", rename_all = "camelCase")]
|
||||||
SampleChangeName { name: String },
|
SampleChangeName { name: String },
|
||||||
#[serde(rename = "cultnet.sample.chat.v0", rename_all = "camelCase")]
|
#[serde(rename = "cultnet.sample.chat.v0", rename_all = "camelCase")]
|
||||||
|
|
@ -568,9 +543,7 @@ pub fn encode_cultnet_message_for_wire(
|
||||||
| CultNetMessage::SnapshotResponseRawV1 { .. }
|
| CultNetMessage::SnapshotResponseRawV1 { .. }
|
||||||
| CultNetMessage::ContentChunkRequest { .. }
|
| CultNetMessage::ContentChunkRequest { .. }
|
||||||
| CultNetMessage::ContentChunkResponse { .. }
|
| CultNetMessage::ContentChunkResponse { .. }
|
||||||
| CultNetMessage::Error { .. }
|
| CultNetMessage::Error { .. } => encode_raw_cultnet_schema_message(message),
|
||||||
| CultNetMessage::ErrorV1 { .. }
|
|
||||||
| CultNetMessage::WriteAdmitted { .. } => encode_raw_cultnet_schema_message(message),
|
|
||||||
_ => Ok(cultcache_rs::decode_payload(&rmp_serde::to_vec(
|
_ => Ok(cultcache_rs::decode_payload(&rmp_serde::to_vec(
|
||||||
&serde_json::to_value(message)?,
|
&serde_json::to_value(message)?,
|
||||||
)?)?),
|
)?)?),
|
||||||
|
|
@ -600,8 +573,7 @@ pub fn decode_cultnet_message_from_slice(
|
||||||
| "cultnet.snapshot_response_raw.v0"
|
| "cultnet.snapshot_response_raw.v0"
|
||||||
| "cultmesh.content_chunk_request.v1"
|
| "cultmesh.content_chunk_request.v1"
|
||||||
| "cultmesh.content_chunk_response.v1"
|
| "cultmesh.content_chunk_response.v1"
|
||||||
| "cultnet.error.v0"
|
| "cultnet.error.v0",
|
||||||
| "cultnet.error.v1",
|
|
||||||
) => parse_raw_cultnet_schema_message(&wire_value)
|
) => parse_raw_cultnet_schema_message(&wire_value)
|
||||||
.with_context(|| received_version_label(&wire_value))?,
|
.with_context(|| received_version_label(&wire_value))?,
|
||||||
_ => cultcache_rs::decode_payload::<CultNetMessage>(bytes)
|
_ => cultcache_rs::decode_payload::<CultNetMessage>(bytes)
|
||||||
|
|
@ -673,20 +645,6 @@ fn validate_message(message: &CultNetMessage) -> Result<()> {
|
||||||
require_non_empty(session, "session")?;
|
require_non_empty(session, "session")?;
|
||||||
}
|
}
|
||||||
CultNetMessage::Error { error, code: _, details: _ } => require_non_empty(error, "error")?,
|
CultNetMessage::Error { error, code: _, details: _ } => require_non_empty(error, "error")?,
|
||||||
CultNetMessage::ErrorV1 { error, message_id, .. } => {
|
|
||||||
require_non_empty(error, "error")?;
|
|
||||||
if let Some(message_id) = message_id {
|
|
||||||
require_non_empty(message_id, "messageId")?;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
CultNetMessage::WriteAdmitted { message_id, operation, schema_id, record_key } => {
|
|
||||||
require_non_empty(message_id, "messageId")?;
|
|
||||||
if operation != "put" && operation != "delete" {
|
|
||||||
return Err(anyhow!("operation must be put or delete"));
|
|
||||||
}
|
|
||||||
require_non_empty(schema_id, "schemaId")?;
|
|
||||||
require_non_empty(record_key, "recordKey")?;
|
|
||||||
}
|
|
||||||
CultNetMessage::SampleChangeName { name } => require_non_empty(name, "name")?,
|
CultNetMessage::SampleChangeName { name } => require_non_empty(name, "name")?,
|
||||||
CultNetMessage::SampleChat { text } => require_non_empty(text, "text")?,
|
CultNetMessage::SampleChat { text } => require_non_empty(text, "text")?,
|
||||||
CultNetMessage::DocumentDelete {
|
CultNetMessage::DocumentDelete {
|
||||||
|
|
@ -1063,7 +1021,7 @@ fn parse_raw_cultnet_schema_message(input: &rmpv::Value) -> Result<CultNetMessag
|
||||||
.to_vec(),
|
.to_vec(),
|
||||||
error: require_legacy_string(get("error"), "error")?,
|
error: require_legacy_string(get("error"), "error")?,
|
||||||
}),
|
}),
|
||||||
"cultnet.error.v0" | "cultnet.error.v1" => {
|
"cultnet.error.v0" => {
|
||||||
let code = get("code")
|
let code = get("code")
|
||||||
.filter(|value| !value.is_nil())
|
.filter(|value| !value.is_nil())
|
||||||
.map(|value| {
|
.map(|value| {
|
||||||
|
|
@ -1073,23 +1031,12 @@ fn parse_raw_cultnet_schema_message(input: &rmpv::Value) -> Result<CultNetMessag
|
||||||
.and_then(CultNetErrorCode::from_wire_str)
|
.and_then(CultNetErrorCode::from_wire_str)
|
||||||
})
|
})
|
||||||
.transpose()?;
|
.transpose()?;
|
||||||
if schema_version == "cultnet.error.v0" && code == Some(CultNetErrorCode::LimitReached) {
|
|
||||||
return Err(anyhow!("ErrorMessage.Code is not a recognized cultnet.error.v0 code"));
|
|
||||||
}
|
|
||||||
let details = require_error_details(get("details"), "ErrorMessage.Details")?;
|
let details = require_error_details(get("details"), "ErrorMessage.Details")?;
|
||||||
let error = require_legacy_string(get("error"), "ErrorMessage.Error")?;
|
Ok(CultNetMessage::Error {
|
||||||
if schema_version == "cultnet.error.v1" {
|
error: require_legacy_string(get("error"), "ErrorMessage.Error")?,
|
||||||
return Ok(CultNetMessage::ErrorV1 {
|
code,
|
||||||
error,
|
details,
|
||||||
code,
|
})
|
||||||
details,
|
|
||||||
message_id: match get("messageId") {
|
|
||||||
None | Some(rmpv::Value::Nil) => None,
|
|
||||||
other => Some(require_legacy_string(other, "messageId")?),
|
|
||||||
},
|
|
||||||
});
|
|
||||||
}
|
|
||||||
Ok(CultNetMessage::Error { error, code, details })
|
|
||||||
}
|
}
|
||||||
_ => Err(anyhow!(
|
_ => Err(anyhow!(
|
||||||
"Unsupported raw cultnet.schema.v0 message"
|
"Unsupported raw cultnet.schema.v0 message"
|
||||||
|
|
@ -1143,18 +1090,7 @@ fn require_legacy_optional_u64(
|
||||||
}
|
}
|
||||||
|
|
||||||
fn encode_raw_cultnet_schema_message(message: &CultNetMessage) -> Result<rmpv::Value> {
|
fn encode_raw_cultnet_schema_message(message: &CultNetMessage) -> Result<rmpv::Value> {
|
||||||
if let CultNetMessage::Error { code: Some(CultNetErrorCode::LimitReached), .. } = message {
|
|
||||||
return Err(anyhow!("limit_reached is a cultnet.error.v1 code; cultnet.error.v0 cannot carry it"));
|
|
||||||
}
|
|
||||||
Ok(rmpv::Value::Map(match message {
|
Ok(rmpv::Value::Map(match message {
|
||||||
// Spec field order (write-receipt.md), not serde_json's sorted map.
|
|
||||||
CultNetMessage::WriteAdmitted { message_id, operation, schema_id, record_key } => vec![
|
|
||||||
(rmpv::Value::from("schemaVersion"), rmpv::Value::from("cultnet.write_admitted.v0")),
|
|
||||||
(rmpv::Value::from("messageId"), rmpv::Value::from(message_id.as_str())),
|
|
||||||
(rmpv::Value::from("operation"), rmpv::Value::from(operation.as_str())),
|
|
||||||
(rmpv::Value::from("schemaId"), rmpv::Value::from(schema_id.as_str())),
|
|
||||||
(rmpv::Value::from("recordKey"), rmpv::Value::from(record_key.as_str())),
|
|
||||||
],
|
|
||||||
CultNetMessage::DocumentPutRaw {
|
CultNetMessage::DocumentPutRaw {
|
||||||
message_id,
|
message_id,
|
||||||
document,
|
document,
|
||||||
|
|
@ -1319,36 +1255,6 @@ fn encode_raw_cultnet_schema_message(message: &CultNetMessage) -> Result<rmpv::V
|
||||||
.unwrap_or(rmpv::Value::Nil),
|
.unwrap_or(rmpv::Value::Nil),
|
||||||
),
|
),
|
||||||
],
|
],
|
||||||
CultNetMessage::ErrorV1 {
|
|
||||||
error,
|
|
||||||
code,
|
|
||||||
details,
|
|
||||||
message_id,
|
|
||||||
} => vec![
|
|
||||||
(rmpv::Value::from("schemaVersion"), rmpv::Value::from("cultnet.error.v1")),
|
|
||||||
(rmpv::Value::from("error"), rmpv::Value::from(error.as_str())),
|
|
||||||
(rmpv::Value::from("routingHint"), rmpv::Value::Nil),
|
|
||||||
(
|
|
||||||
rmpv::Value::from("code"),
|
|
||||||
code.as_ref()
|
|
||||||
.map(|code| rmpv::Value::from(code.as_wire_str()))
|
|
||||||
.unwrap_or(rmpv::Value::Nil),
|
|
||||||
),
|
|
||||||
(
|
|
||||||
rmpv::Value::from("details"),
|
|
||||||
details
|
|
||||||
.as_ref()
|
|
||||||
.map(encode_error_details)
|
|
||||||
.unwrap_or(rmpv::Value::Nil),
|
|
||||||
),
|
|
||||||
(
|
|
||||||
rmpv::Value::from("messageId"),
|
|
||||||
message_id
|
|
||||||
.as_deref()
|
|
||||||
.map(rmpv::Value::from)
|
|
||||||
.unwrap_or(rmpv::Value::Nil),
|
|
||||||
),
|
|
||||||
],
|
|
||||||
_ => {
|
_ => {
|
||||||
return Err(anyhow!(
|
return Err(anyhow!(
|
||||||
"Message is not a raw cultnet.schema.v0 binary replication message"
|
"Message is not a raw cultnet.schema.v0 binary replication message"
|
||||||
|
|
@ -1978,71 +1884,3 @@ fn legacy_schema_descriptor(schema: &CultNetSchemaDescriptor) -> Result<rmpv::Va
|
||||||
),
|
),
|
||||||
]))
|
]))
|
||||||
}
|
}
|
||||||
|
|
||||||
/// The content hash a write-receipt server binds to a `(actor, messageId)` dedupe key
|
|
||||||
/// (contracts/cultnet/interop/write-receipt.md, rule 5): SHA-256 of the MessagePack array
|
|
||||||
/// `[operation, schemaId, recordKey, payload]`, `payload` a `bin` for a put and nil for a delete.
|
|
||||||
pub fn write_content_hash(
|
|
||||||
operation: &str,
|
|
||||||
schema_id: &str,
|
|
||||||
record_key: &str,
|
|
||||||
payload: Option<&[u8]>,
|
|
||||||
) -> Result<[u8; 32]> {
|
|
||||||
use sha2::{Digest, Sha256};
|
|
||||||
let value = rmpv::Value::Array(vec![
|
|
||||||
rmpv::Value::from(operation),
|
|
||||||
rmpv::Value::from(schema_id),
|
|
||||||
rmpv::Value::from(record_key),
|
|
||||||
payload.map_or(rmpv::Value::Nil, |payload| rmpv::Value::Binary(payload.to_vec())),
|
|
||||||
]);
|
|
||||||
let mut bytes = Vec::new();
|
|
||||||
rmpv::encode::write_value(&mut bytes, &value)?;
|
|
||||||
Ok(Sha256::digest(&bytes).into())
|
|
||||||
}
|
|
||||||
|
|
||||||
/// SHA-256 of a write's `messageId`: what a receipt server remembers in place of the id itself, so an
|
|
||||||
/// entry's memory does not depend on the id's length (write-receipt.md, "What is remembered").
|
|
||||||
pub fn message_id_digest(message_id: &str) -> [u8; 32] {
|
|
||||||
use sha2::{Digest, Sha256};
|
|
||||||
Sha256::digest(message_id.as_bytes()).into()
|
|
||||||
}
|
|
||||||
|
|
||||||
/// The `messageId` of a schema frame that does not decode as a message (write-receipt.md, rule 3: a refusal
|
|
||||||
/// carries the write's id whenever the frame is readable enough to find it). `None` when the bytes are not
|
|
||||||
/// a MessagePack map or hold no non-empty string `messageId`.
|
|
||||||
pub fn readable_message_id(bytes: &[u8]) -> Option<String> {
|
|
||||||
let value = rmpv::decode::read_value(&mut &*bytes).ok()?;
|
|
||||||
let rmpv::Value::Map(entries) = value else {
|
|
||||||
return None;
|
|
||||||
};
|
|
||||||
entries.into_iter().find_map(|(key, value)| match (key.as_str(), value) {
|
|
||||||
(Some("messageId"), rmpv::Value::String(id)) => id.into_str().filter(|id| !id.is_empty()),
|
|
||||||
_ => None,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
/// The first required field (`document`, then `schemaId`) that a put or delete frame lacks or holds as nil
|
|
||||||
/// (write-receipt.md, "Required fields"), with the write's operation (`"put"` or `"delete"`). `None` when the
|
|
||||||
/// bytes are not such a frame, or both fields are present. A put's `schemaId` is its document's.
|
|
||||||
pub fn missing_required_write_field(bytes: &[u8]) -> Option<(&'static str, &'static str)> {
|
|
||||||
let rmpv::Value::Map(entries) = rmpv::decode::read_value(&mut &*bytes).ok()? else {
|
|
||||||
return None;
|
|
||||||
};
|
|
||||||
let field = |entries: &[(rmpv::Value, rmpv::Value)], name: &str| {
|
|
||||||
entries
|
|
||||||
.iter()
|
|
||||||
.find(|(key, _)| key.as_str() == Some(name))
|
|
||||||
.map(|(_, value)| value.clone())
|
|
||||||
.filter(|value| !value.is_nil())
|
|
||||||
};
|
|
||||||
match field(&entries, "schemaVersion")?.as_str()? {
|
|
||||||
"cultnet.document_put_raw.v0" => match field(&entries, "document") {
|
|
||||||
Some(rmpv::Value::Map(document)) => {
|
|
||||||
field(&document, "schemaId").is_none().then_some(("put", "schemaId"))
|
|
||||||
}
|
|
||||||
_ => Some(("put", "document")),
|
|
||||||
},
|
|
||||||
"cultnet.document_delete.v0" => field(&entries, "schemaId").is_none().then_some(("delete", "schemaId")),
|
|
||||||
_ => None,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
|
||||||
|
|
@ -468,14 +468,6 @@ impl CultNetRudpSession {
|
||||||
self.create_disconnect(RUDP_REFUSED_PACKET_REASON.to_vec())
|
self.create_disconnect(RUDP_REFUSED_PACKET_REASON.to_vec())
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Ends a session because the server itself could not answer a write it owes an answer to (its answer
|
|
||||||
/// could not be encoded, queued or sent). The peer did nothing wrong: this goodbye is not the
|
|
||||||
/// "session refused a packet" of a protocol refusal.
|
|
||||||
pub fn end_local_failure_session(&mut self) -> CultNetRudpPacket {
|
|
||||||
self.reset_peer_state();
|
|
||||||
self.create_disconnect(RUDP_LOCAL_FAILURE_REASON.to_vec())
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Ends a session that owes its peer a packet that can never be sent as
|
/// Ends a session that owes its peer a packet that can never be sent as
|
||||||
/// built (see `is_permanent_send_error`). Resending it would fail forever,
|
/// built (see `is_permanent_send_error`). Resending it would fail forever,
|
||||||
/// and dropping it would leave a reliable sequence the peer waits on for
|
/// and dropping it would leave a reliable sequence the peer waits on for
|
||||||
|
|
@ -2617,8 +2609,6 @@ where
|
||||||
/// Sent to a peer whose session refused one of its packets, and reported to
|
/// Sent to a peer whose session refused one of its packets, and reported to
|
||||||
/// the local caller as the disconnect reason.
|
/// the local caller as the disconnect reason.
|
||||||
const RUDP_REFUSED_PACKET_REASON: &[u8] = b"session refused a packet";
|
const RUDP_REFUSED_PACKET_REASON: &[u8] = b"session refused a packet";
|
||||||
/// Goodbye reason of a session whose server could not answer a write (`end_local_failure_session`).
|
|
||||||
const RUDP_LOCAL_FAILURE_REASON: &[u8] = b"server could not answer a write";
|
|
||||||
const SESSION_TIMED_OUT_REASON: &[u8] = b"session timed out";
|
const SESSION_TIMED_OUT_REASON: &[u8] = b"session timed out";
|
||||||
/// Prefix of the goodbye reason for a session that owed a packet which can
|
/// Prefix of the goodbye reason for a session that owed a packet which can
|
||||||
/// never be sent; the failure's fixed name (`send_error_code`) follows it.
|
/// never be sent; the failure's fixed name (`send_error_code`) follows it.
|
||||||
|
|
|
||||||
|
|
@ -1,155 +0,0 @@
|
||||||
//! Wire parity with contracts/cultnet/interop/write-receipt-vectors.json: the content hash, and the two new frames.
|
|
||||||
|
|
||||||
use cultnet_rs::{
|
|
||||||
CultNetErrorCode, CultNetErrorDetails, CultNetMessage, CultNetWireContract, decode_cultnet_message_from_slice,
|
|
||||||
encode_cultnet_message_to_vec, write_content_hash,
|
|
||||||
};
|
|
||||||
|
|
||||||
fn hex(bytes: &[u8]) -> String {
|
|
||||||
bytes.iter().map(|byte| format!("{byte:02x}")).collect()
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn the_content_hash_matches_the_spec_vectors() {
|
|
||||||
let a = [0x81, 0xA2, 0x69, 0x64, 0xA1, 0x31];
|
|
||||||
let b = [0x81, 0xA2, 0x69, 0x64, 0xA1, 0x32];
|
|
||||||
let cases = [
|
|
||||||
(write_content_hash("put", "note.v0", "note:1", Some(&a)), "7051c10071123b6ade50fbd5075e3859cae4ea70ce358a24a0b0c6980090e95d"),
|
|
||||||
(write_content_hash("put", "note.v0", "note:1", Some(&b)), "58d3fc6b858d2605a68550c9d4811ccdca6b9db7a0c3bfebf304d279257f6f9f"),
|
|
||||||
(write_content_hash("put", "note.v0", "note:2", Some(&a)), "a248cd920e58d41bc6ccca9e108030b1d491239000047fef088122364a32b6f8"),
|
|
||||||
(write_content_hash("delete", "note.v0", "note:1", None), "232b0f96651b28aa8ab7673a6106944a9f6a8d66852b6e21291a23ed084b8b37"),
|
|
||||||
];
|
|
||||||
for (hash, expected) in cases {
|
|
||||||
assert_eq!(hex(&hash.unwrap()), expected);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn the_new_frames_decode_back_equal() {
|
|
||||||
let admitted = CultNetMessage::WriteAdmitted {
|
|
||||||
message_id: "put-1".into(),
|
|
||||||
operation: "put".into(),
|
|
||||||
schema_id: "note.v0".into(),
|
|
||||||
record_key: "note:1".into(),
|
|
||||||
};
|
|
||||||
let bytes = encode_cultnet_message_to_vec(&admitted, CultNetWireContract::CultNetSchemaV0).unwrap();
|
|
||||||
assert_eq!(
|
|
||||||
decode_cultnet_message_from_slice(&bytes, CultNetWireContract::CultNetSchemaV0).unwrap(),
|
|
||||||
admitted
|
|
||||||
);
|
|
||||||
// error.v1 with a nil id round-trips as nil, and the code enum is v0's.
|
|
||||||
let error = CultNetMessage::ErrorV1 {
|
|
||||||
error: "message_invalid: unreadable frame".into(),
|
|
||||||
code: Some(CultNetErrorCode::MessageInvalid),
|
|
||||||
details: None,
|
|
||||||
message_id: None,
|
|
||||||
};
|
|
||||||
let bytes = encode_cultnet_message_to_vec(&error, CultNetWireContract::CultNetSchemaV0).unwrap();
|
|
||||||
assert_eq!(
|
|
||||||
decode_cultnet_message_from_slice(&bytes, CultNetWireContract::CultNetSchemaV0).unwrap(),
|
|
||||||
error
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
fn unhex(text: &str) -> Vec<u8> {
|
|
||||||
(0..text.len()).step_by(2).map(|i| u8::from_str_radix(&text[i..i + 2], 16).unwrap()).collect()
|
|
||||||
}
|
|
||||||
|
|
||||||
/// The spec's wire vectors (write-receipt-vectors.json `wire`): the bytes decode to the vector's fields, not
|
|
||||||
/// merely to something that encodes back to itself.
|
|
||||||
#[test]
|
|
||||||
fn the_spec_wire_vectors_decode_to_their_expected_fields() {
|
|
||||||
let admitted = decode_cultnet_message_from_slice(
|
|
||||||
&unhex("85AD736368656D6156657273696F6EB963756C746E65742E77726974655F61646D69747465642E7630A96D6573736167654964A57075742D31A96F7065726174696F6EA3707574A8736368656D614964A76E6F74652E7630A97265636F72644B6579A66E6F74653A31"),
|
|
||||||
CultNetWireContract::CultNetSchemaV0,
|
|
||||||
)
|
|
||||||
.unwrap();
|
|
||||||
assert_eq!(
|
|
||||||
admitted,
|
|
||||||
CultNetMessage::WriteAdmitted {
|
|
||||||
message_id: "put-1".into(),
|
|
||||||
operation: "put".into(),
|
|
||||||
schema_id: "note.v0".into(),
|
|
||||||
record_key: "note:1".into(),
|
|
||||||
}
|
|
||||||
);
|
|
||||||
let refused = decode_cultnet_message_from_slice(
|
|
||||||
&unhex("86AD736368656D6156657273696F6EB063756C746E65742E6572726F722E7631A56572726F72D93677726974655F6E6F745F617574686F72697A65643A2074686520636174616C6F6720726566757365642074686520646F63756D656E74AB726F7574696E6748696E74C0A4636F6465B477726974655F6E6F745F617574686F72697A6564A764657461696C7384A56669656C64A97265636F72644B6579A576616C7565A66E6F74653A32A461734F66C0A763757272656E74C0A96D6573736167654964A57075742D32"),
|
|
||||||
CultNetWireContract::CultNetSchemaV0,
|
|
||||||
)
|
|
||||||
.unwrap();
|
|
||||||
let CultNetMessage::ErrorV1 { error, code, details, message_id } = refused else {
|
|
||||||
panic!("expected error.v1");
|
|
||||||
};
|
|
||||||
assert_eq!(error, "write_not_authorized: the catalog refused the document");
|
|
||||||
assert_eq!(code, Some(CultNetErrorCode::WriteNotAuthorized));
|
|
||||||
assert_eq!(message_id.as_deref(), Some("put-2"));
|
|
||||||
let details = details.unwrap();
|
|
||||||
assert_eq!(details.field.as_deref(), Some("recordKey"));
|
|
||||||
assert_eq!(details.value.as_deref(), Some("note:2"));
|
|
||||||
assert_eq!((details.as_of, details.current), (None, None));
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Spec vector `error_v1_limit_reached`: the bytes the server must send, and what they decode to.
|
|
||||||
#[test]
|
|
||||||
fn error_v1_limit_reached_is_the_spec_vector() {
|
|
||||||
let vector = "86AD736368656D6156657273696F6EB063756C746E65742E6572726F722E7631A56572726F72D93B6C696D69745F726561636865643A207468652073657373696F6E27732072656D656D62657265642D7772697465206C696D69742069732066756C6CAB726F7574696E6748696E74C0A4636F6465AD6C696D69745F72656163686564A764657461696C7384A56669656C64C0A576616C7565C0A461734F66C0A763757272656E74C0A96D6573736167654964A87075742D31303235";
|
|
||||||
let message = CultNetMessage::ErrorV1 {
|
|
||||||
error: "limit_reached: the session's remembered-write limit is full".into(),
|
|
||||||
code: Some(CultNetErrorCode::LimitReached),
|
|
||||||
details: Some(CultNetErrorDetails::default()),
|
|
||||||
message_id: Some("put-1025".into()),
|
|
||||||
};
|
|
||||||
let bytes = encode_cultnet_message_to_vec(&message, CultNetWireContract::CultNetSchemaV0).unwrap();
|
|
||||||
assert_eq!(bytes, unhex(vector), "encoded bytes must equal the spec vector");
|
|
||||||
let CultNetMessage::ErrorV1 { error, code, details, message_id } =
|
|
||||||
decode_cultnet_message_from_slice(&unhex(vector), CultNetWireContract::CultNetSchemaV0).unwrap()
|
|
||||||
else {
|
|
||||||
panic!("expected error.v1");
|
|
||||||
};
|
|
||||||
assert_eq!(error, "limit_reached: the session's remembered-write limit is full");
|
|
||||||
assert_eq!(code, Some(CultNetErrorCode::LimitReached));
|
|
||||||
assert_eq!(message_id.as_deref(), Some("put-1025"));
|
|
||||||
assert_eq!(details, Some(CultNetErrorDetails::default()));
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Spec vectors `write_admitted_put` and `write_admitted_delete`: the encoder emits the spec's field order.
|
|
||||||
#[test]
|
|
||||||
fn write_admitted_encodes_to_the_spec_vector_bytes() {
|
|
||||||
let cases = [
|
|
||||||
("put-1", "put", "85AD736368656D6156657273696F6EB963756C746E65742E77726974655F61646D69747465642E7630A96D6573736167654964A57075742D31A96F7065726174696F6EA3707574A8736368656D614964A76E6F74652E7630A97265636F72644B6579A66E6F74653A31"),
|
|
||||||
("del-1", "delete", "85AD736368656D6156657273696F6EB963756C746E65742E77726974655F61646D69747465642E7630A96D6573736167654964A564656C2D31A96F7065726174696F6EA664656C657465A8736368656D614964A76E6F74652E7630A97265636F72644B6579A66E6F74653A31"),
|
|
||||||
];
|
|
||||||
for (id, operation, vector) in cases {
|
|
||||||
let message = CultNetMessage::WriteAdmitted {
|
|
||||||
message_id: id.into(),
|
|
||||||
operation: operation.into(),
|
|
||||||
schema_id: "note.v0".into(),
|
|
||||||
record_key: "note:1".into(),
|
|
||||||
};
|
|
||||||
let bytes = encode_cultnet_message_to_vec(&message, CultNetWireContract::CultNetSchemaV0).unwrap();
|
|
||||||
assert_eq!(bytes, unhex(vector));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// `limit_reached` is in the error.v1 enum only: a v0 error neither encodes nor decodes it.
|
|
||||||
#[test]
|
|
||||||
fn error_v0_refuses_the_v1_only_limit_reached_code() {
|
|
||||||
let v0 = CultNetMessage::Error {
|
|
||||||
error: "x".into(),
|
|
||||||
code: Some(CultNetErrorCode::LimitReached),
|
|
||||||
details: None,
|
|
||||||
};
|
|
||||||
assert!(encode_cultnet_message_to_vec(&v0, CultNetWireContract::CultNetSchemaV0).is_err());
|
|
||||||
let v1 = CultNetMessage::ErrorV1 {
|
|
||||||
error: "x".into(),
|
|
||||||
code: Some(CultNetErrorCode::LimitReached),
|
|
||||||
details: None,
|
|
||||||
message_id: None,
|
|
||||||
};
|
|
||||||
let v1_bytes = encode_cultnet_message_to_vec(&v1, CultNetWireContract::CultNetSchemaV0).unwrap();
|
|
||||||
let at = v1_bytes.windows(16).position(|w| w == b"cultnet.error.v1").unwrap();
|
|
||||||
let mut as_v0 = v1_bytes.clone();
|
|
||||||
as_v0[at + 15] = b'0';
|
|
||||||
assert!(decode_cultnet_message_from_slice(&as_v0, CultNetWireContract::CultNetSchemaV0).is_err());
|
|
||||||
}
|
|
||||||
|
|
@ -7,7 +7,6 @@ All notable changes to `@gamecult/cultnet-ts` are recorded here, following
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- Write receipt, client side (`contracts/cultnet/interop/write-receipt.md`): `cultnet.write_admitted.v0` and `cultnet.error.v1` (v0 plus `messageId`; its closed code set adds `limit_reached`, `CULTNET_ERROR_V1_CODES`) parse and encode, and `CULTNET_WRITE_RECEIPT_MESSAGE_VERSIONS` / `helloAdvertisesWriteReceipts` name the hello capability. `cultnet.error.v0` and its code set are unchanged. `WriteTracker` settles each write as admitted, refused or unconfirmed (windows `RECEIPT_RESULT_WINDOW_MS` 5000 and `LEGACY_RESULT_WINDOW_MS` 500, counted from the send; late answers recorded as `admitted_late` / `refused_late`), and `tools/replay-write-receipt-vectors.mjs` replays the vectors against it (see README, "Write receipt replay runner"). The interop schemas are read from `contracts/cultnet/interop/`.
|
|
||||||
- `message_invalid` joins the closed `cultnet.error.v0` code set, with `cultNetMessageInvalidError(field, reason)` (`details.field` names the request field at fault), byte-identical to the C# `ForMessageInvalid`.
|
- `message_invalid` joins the closed `cultnet.error.v0` code set, with `cultNetMessageInvalidError(field, reason)` (`details.field` names the request field at fault), byte-identical to the C# `ForMessageInvalid`.
|
||||||
- `cultNetWriteNotAuthorizedError(recordKey, reason?)`: the typed `write_not_authorized` refusal (code and `details.recordKey`), byte-identical to the C# `ForRemoteWriteRefused` vector in `error-vectors.json`. `CultNetDocumentRegistry.canonicalSchemaId(schemaId)` resolves the id a put or delete writes under, for a server's write authority.
|
- `cultNetWriteNotAuthorizedError(recordKey, reason?)`: the typed `write_not_authorized` refusal (code and `details.recordKey`), byte-identical to the C# `ForRemoteWriteRefused` vector in `error-vectors.json`. `CultNetDocumentRegistry.canonicalSchemaId(schemaId)` resolves the id a put or delete writes under, for a server's write authority.
|
||||||
- `cultNetTextError(error)`: the text-only `cultnet.error.v0` refusal, with `routingHint`, `code` and `details` null. The legacy-union error decode uses it, so there is one place that spells the null members.
|
- `cultNetTextError(error)`: the text-only `cultnet.error.v0` refusal, with `routingHint`, `code` and `details` null. The legacy-union error decode uses it, so there is one place that spells the null members.
|
||||||
|
|
@ -17,7 +16,6 @@ All notable changes to `@gamecult/cultnet-ts` are recorded here, following
|
||||||
|
|
||||||
### Breaking
|
### Breaking
|
||||||
|
|
||||||
- The Idunn runtime presence publisher is send-only (`sendPresenceDocument`): it returns `"sent"` once Odin's transport has acknowledged the put and no longer waits up to 500 ms for a success reply, which was never admission. It rejects `IdunnPresenceRefusedError` for a `cultnet.error.v0`, or a `cultnet.error.v1` naming the put or nothing, that arrives by the ack; a refusal after the ack is not awaited, and no other frame, one carrying the put's id included, counts as success.
|
|
||||||
- The package is renamed `cultnet-ts` to `@gamecult/cultnet-ts` (the repo already scopes `@gamecult/cultcache-ts`), so the unscoped name cannot be claimed by someone else. Import from `@gamecult/cultnet-ts` and its subpaths; the API is unchanged.
|
- The package is renamed `cultnet-ts` to `@gamecult/cultnet-ts` (the repo already scopes `@gamecult/cultcache-ts`), so the unscoped name cannot be claimed by someone else. Import from `@gamecult/cultnet-ts` and its subpaths; the API is unchanged.
|
||||||
- `CultNetErrorMessage` carries `routingHint`, `code` and `details` (null when absent), as the reference writes them and `cultnet.error.schema.json` requires; the interface previously dropped them. New `CultNetErrorCode`, `CultNetErrorDetails` and `CultNetShardRoutingHint` types.
|
- `CultNetErrorMessage` carries `routingHint`, `code` and `details` (null when absent), as the reference writes them and `cultnet.error.schema.json` requires; the interface previously dropped them. New `CultNetErrorCode`, `CultNetErrorDetails` and `CultNetShardRoutingHint` types.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -289,33 +289,6 @@ maps them back to the exact C# union payload shape at the wire boundary.
|
||||||
serve and dial commands also exercise schema-v0 over the shared RUDP socket
|
serve and dial commands also exercise schema-v0 over the shared RUDP socket
|
||||||
transport and advertise both transport profiles.
|
transport and advertise both transport profiles.
|
||||||
|
|
||||||
## Write receipt replay runner
|
|
||||||
|
|
||||||
`WriteTracker` is the client half of `contracts/cultnet/interop/write-receipt.md`: a pure state machine on an abstract
|
|
||||||
clock that owns one decision, how each sent write settles. `tools/replay-write-receipt-vectors.mjs` replays
|
|
||||||
`write-receipt-vectors.json` against it (build first, then `node tools/replay-write-receipt-vectors.mjs`): it prints
|
|
||||||
`PASS`/`FAIL` per case and exits nonzero on any failure. Rust and C# port the same runner by implementing this interface
|
|
||||||
and replaying the same file.
|
|
||||||
|
|
||||||
Tracker interface (times are integer milliseconds on the vector's clock; the constructor takes the window):
|
|
||||||
|
|
||||||
| Call | Meaning |
|
|
||||||
| --- | --- |
|
|
||||||
| `new WriteTracker({ windowMs, onSettle })` | `windowMs` = 5000 when the server's hello lists both `cultnet.write_admitted.v0` and `cultnet.error.v1`, else 500. `onSettle(id, settlement)` fires once per write. |
|
|
||||||
| `send(id, atMs)` | A write with that `messageId` was sent. Its window runs from here, not from any transport ack. |
|
|
||||||
| `frame(message, atMs)` | A decoded frame arrived. `write_admitted` and `error.v1` settle the write they name; `error.v0`, or `error.v1` with nil `messageId`, refuses a write only when exactly one is unanswered; an id not in flight settles nothing. |
|
|
||||||
| `tick(atMs)` | Advance the clock. Every unanswered write with `atMs - sentAt >= windowMs` settles `unconfirmed(window_elapsed)`. `send`, `frame` and `sessionEnd` tick first. |
|
|
||||||
| `sessionEnd(atMs)` | Every unanswered write settles `unconfirmed(session_ended)`. |
|
|
||||||
| `state(id)` | `pending`, or the settlement plus `recorded`: `admitted_late` / `refused_late`, set by the first answer that arrives after `unconfirmed`. A settlement never changes. |
|
|
||||||
|
|
||||||
Runner, per case in `scenarios.cases` (the transport ack is not an input: delivery is not an answer):
|
|
||||||
|
|
||||||
1. The fake server states its capability the only way a real one does, in a hello (`server: "receipt"` lists both frames, `"legacy"` lists none); the window comes from that hello and must equal `constants[case.window]`.
|
|
||||||
2. Events run in `atMs` order: `send` -> `send(id)`, `frame` -> encode the frame to MessagePack, decode and validate it as the client would, then `frame(message)`, `tick` -> `tick`, `sessionEnd` -> `sessionEnd`, `transportAck` -> nothing.
|
|
||||||
3. For each id in `expect`, the settlement given to the caller has the expected `outcome` (and `code` or `reason` when given), `state(id).recorded` equals the expected `recorded` (absent when absent), and nothing settled twice or outside `expect`.
|
|
||||||
|
|
||||||
The runner also decodes each `wire[].messagePackHex` and compares the fields and the re-encoded bytes to the vector, and requires every `schemaInvalid[]` frame to be refused by the decoder. `dedupe.cases` and `contentHash` are server vectors and not replayed here.
|
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|
|
||||||
|
|
@ -9,8 +9,6 @@ import registerSchema from "../contracts/cultnet/cultnet.register.schema.json";
|
||||||
import verifySchema from "../contracts/cultnet/cultnet.verify.schema.json";
|
import verifySchema from "../contracts/cultnet/cultnet.verify.schema.json";
|
||||||
import loginSuccessSchema from "../contracts/cultnet/cultnet.login-success.schema.json";
|
import loginSuccessSchema from "../contracts/cultnet/cultnet.login-success.schema.json";
|
||||||
import errorSchema from "../contracts/cultnet/cultnet.error.schema.json";
|
import errorSchema from "../contracts/cultnet/cultnet.error.schema.json";
|
||||||
import errorV1Schema from "../contracts/cultnet/interop/cultnet.error.v1.schema.json";
|
|
||||||
import writeAdmittedSchema from "../contracts/cultnet/interop/cultnet.write-admitted.schema.json";
|
|
||||||
import sampleChangeNameSchema from "../contracts/cultnet/cultnet.sample-change-name.schema.json";
|
import sampleChangeNameSchema from "../contracts/cultnet/cultnet.sample-change-name.schema.json";
|
||||||
import sampleChatSchema from "../contracts/cultnet/cultnet.sample-chat.schema.json";
|
import sampleChatSchema from "../contracts/cultnet/cultnet.sample-chat.schema.json";
|
||||||
import documentPutSchema from "../contracts/cultnet/cultnet.document-put.schema.json";
|
import documentPutSchema from "../contracts/cultnet/cultnet.document-put.schema.json";
|
||||||
|
|
@ -64,8 +62,6 @@ export type CultNetSchemaVersion =
|
||||||
| "cultnet.verify.v0"
|
| "cultnet.verify.v0"
|
||||||
| "cultnet.login_success.v0"
|
| "cultnet.login_success.v0"
|
||||||
| "cultnet.error.v0"
|
| "cultnet.error.v0"
|
||||||
| "cultnet.error.v1"
|
|
||||||
| "cultnet.write_admitted.v0"
|
|
||||||
| "cultnet.sample.change_name.v0"
|
| "cultnet.sample.change_name.v0"
|
||||||
| "cultnet.sample.chat.v0"
|
| "cultnet.sample.chat.v0"
|
||||||
| "cultnet.document_put.v0"
|
| "cultnet.document_put.v0"
|
||||||
|
|
@ -205,11 +201,6 @@ export const CULTNET_ERROR_CODES = [
|
||||||
|
|
||||||
export type CultNetErrorCode = (typeof CULTNET_ERROR_CODES)[number];
|
export type CultNetErrorCode = (typeof CULTNET_ERROR_CODES)[number];
|
||||||
|
|
||||||
/** The closed refusal-code set of cultnet.error.v1 (contracts/cultnet/interop/cultnet.error.v1.schema.json): v0's codes plus `limit_reached`. */
|
|
||||||
export const CULTNET_ERROR_V1_CODES = [...CULTNET_ERROR_CODES, "limit_reached"] as const;
|
|
||||||
|
|
||||||
export type CultNetErrorV1Code = (typeof CULTNET_ERROR_V1_CODES)[number];
|
|
||||||
|
|
||||||
/** A refusal that carries text only: `routingHint`, `code` and `details` are written as null, as the reference writes an absent member. */
|
/** A refusal that carries text only: `routingHint`, `code` and `details` are written as null, as the reference writes an absent member. */
|
||||||
export function cultNetTextError(error: string): CultNetErrorMessage {
|
export function cultNetTextError(error: string): CultNetErrorMessage {
|
||||||
return { schemaVersion: "cultnet.error.v0", error, routingHint: null, code: null, details: null };
|
return { schemaVersion: "cultnet.error.v0", error, routingHint: null, code: null, details: null };
|
||||||
|
|
@ -264,34 +255,6 @@ export interface CultNetErrorMessage {
|
||||||
details: CultNetErrorDetails | null;
|
details: CultNetErrorDetails | null;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* cultnet.error.v0 plus the `messageId` of the request it answers (nil when no id could be read). Sent only to a
|
|
||||||
* connection whose hello listed both receipt frames (contracts/cultnet/interop/write-receipt.md).
|
|
||||||
*/
|
|
||||||
export interface CultNetErrorV1Message extends Omit<CultNetErrorMessage, "schemaVersion" | "code"> {
|
|
||||||
schemaVersion: "cultnet.error.v1";
|
|
||||||
code: CultNetErrorV1Code | null;
|
|
||||||
messageId: string | null;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The receipt for one admitted put or delete: every key written, the write's `messageId` echoed byte for byte. */
|
|
||||||
export interface CultNetWriteAdmittedMessage {
|
|
||||||
schemaVersion: "cultnet.write_admitted.v0";
|
|
||||||
messageId: string;
|
|
||||||
operation: "put" | "delete";
|
|
||||||
schemaId: string;
|
|
||||||
recordKey: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The two frames a receipt-capable hello lists in `supportedMessageVersions`; a peer lists both or neither. */
|
|
||||||
export const CULTNET_WRITE_RECEIPT_MESSAGE_VERSIONS = ["cultnet.write_admitted.v0", "cultnet.error.v1"] as const;
|
|
||||||
|
|
||||||
/** True when a hello lists both receipt frames: the only thing that makes a connection receipt-capable. */
|
|
||||||
export function helloAdvertisesWriteReceipts(hello: Pick<CultNetHelloMessage, "supportedMessageVersions">): boolean {
|
|
||||||
const listed = hello.supportedMessageVersions ?? [];
|
|
||||||
return CULTNET_WRITE_RECEIPT_MESSAGE_VERSIONS.every((version) => listed.includes(version));
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface CultNetSampleChangeNameMessage {
|
export interface CultNetSampleChangeNameMessage {
|
||||||
schemaVersion: "cultnet.sample.change_name.v0";
|
schemaVersion: "cultnet.sample.change_name.v0";
|
||||||
name: string;
|
name: string;
|
||||||
|
|
@ -807,8 +770,6 @@ export interface GhostlightAgentStateDocument {
|
||||||
|
|
||||||
export type CultNetMessage =
|
export type CultNetMessage =
|
||||||
| CultNetHelloMessage
|
| CultNetHelloMessage
|
||||||
| CultNetErrorV1Message
|
|
||||||
| CultNetWriteAdmittedMessage
|
|
||||||
| CultNetLoginMessage
|
| CultNetLoginMessage
|
||||||
| CultNetRegisterMessage
|
| CultNetRegisterMessage
|
||||||
| CultNetVerifyMessage
|
| CultNetVerifyMessage
|
||||||
|
|
@ -851,8 +812,6 @@ const CULTNET_MESSAGE_SCHEMAS = [
|
||||||
verifySchema,
|
verifySchema,
|
||||||
loginSuccessSchema,
|
loginSuccessSchema,
|
||||||
errorSchema,
|
errorSchema,
|
||||||
errorV1Schema,
|
|
||||||
writeAdmittedSchema,
|
|
||||||
sampleChangeNameSchema,
|
sampleChangeNameSchema,
|
||||||
sampleChatSchema,
|
sampleChatSchema,
|
||||||
documentPutSchema,
|
documentPutSchema,
|
||||||
|
|
@ -1576,8 +1535,6 @@ export const cultNetSchemas = {
|
||||||
verifySchema,
|
verifySchema,
|
||||||
loginSuccessSchema,
|
loginSuccessSchema,
|
||||||
errorSchema,
|
errorSchema,
|
||||||
errorV1Schema,
|
|
||||||
writeAdmittedSchema,
|
|
||||||
sampleChangeNameSchema,
|
sampleChangeNameSchema,
|
||||||
sampleChatSchema,
|
sampleChatSchema,
|
||||||
documentPutSchema,
|
documentPutSchema,
|
||||||
|
|
|
||||||
|
|
@ -52,7 +52,7 @@ export function createIdunnRuntimePresencePublisher(
|
||||||
const publish = async (detail: string) => {
|
const publish = async (detail: string) => {
|
||||||
const signed = signer.sign(detail);
|
const signed = signer.sign(detail);
|
||||||
messageSequence += 1;
|
messageSequence += 1;
|
||||||
await sendPresenceDocument(endpoint, connectionId, {
|
await publishDocument(endpoint, connectionId, {
|
||||||
schemaVersion: "cultnet.document_put_raw.v0",
|
schemaVersion: "cultnet.document_put_raw.v0",
|
||||||
messageId: `runtime-presence:${signer.authority.expected.target}:${signer.runtimeInstanceId}:${messageSequence}`,
|
messageId: `runtime-presence:${signer.authority.expected.target}:${signer.runtimeInstanceId}:${messageSequence}`,
|
||||||
document: signed.document,
|
document: signed.document,
|
||||||
|
|
@ -86,19 +86,11 @@ export function createIdunnRuntimePresencePublisher(
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
async function publishDocument(
|
||||||
* Sends one presence put and says only that it was sent (write-receipt.md: the explicit send-only mode). Odin does not
|
|
||||||
* answer a write with a receipt yet, so no frame, whatever id it carries, is admission; this never claims it. It returns
|
|
||||||
* once the transport has acknowledged the put, rejects `IdunnPresenceRefusedError` if a refusal arrives by then, and
|
|
||||||
* rejects if the put is never acknowledged.
|
|
||||||
*
|
|
||||||
* @internal exported for tests
|
|
||||||
*/
|
|
||||||
export async function sendPresenceDocument(
|
|
||||||
endpoint: { host: string; port: number },
|
endpoint: { host: string; port: number },
|
||||||
connectionId: number,
|
connectionId: number,
|
||||||
message: Record<string, unknown>,
|
message: Record<string, unknown>,
|
||||||
): Promise<"sent"> {
|
): Promise<void> {
|
||||||
const socket = dgram.createSocket(endpoint.host.includes(":") ? "udp6" : "udp4");
|
const socket = dgram.createSocket(endpoint.host.includes(":") ? "udp6" : "udp4");
|
||||||
await new Promise<void>((resolve, reject) => {
|
await new Promise<void>((resolve, reject) => {
|
||||||
socket.once("error", reject);
|
socket.once("error", reject);
|
||||||
|
|
@ -115,24 +107,26 @@ export async function sendPresenceDocument(
|
||||||
const wirePayload = encode(encodeCultNetMessageForWire(message as never, "cultnet.schema.v0"));
|
const wirePayload = encode(encodeCultNetMessageForWire(message as never, "cultnet.schema.v0"));
|
||||||
const packets = session.sendMany("schema", wirePayload, { reliable: true, ordered: true, nowMs: Date.now() });
|
const packets = session.sendMany("schema", wirePayload, { reliable: true, ordered: true, nowMs: Date.now() });
|
||||||
for (const packet of packets) await sendPacket(socket, endpoint, packet);
|
for (const packet of packets) await sendPacket(socket, endpoint, packet);
|
||||||
// The transport ack is delivery, not admission. A refusal that arrives by then rejects; no other frame means anything.
|
// The transport ack is not admission: the put completes on Odin's result frame. A refusal rejects whether
|
||||||
|
// it arrives before the ack, after it, or inside the result window; a success reply ends the wait early.
|
||||||
|
let succeeded = false;
|
||||||
const onFrame = (frame: { channelId: string; payload: Uint8Array }) => {
|
const onFrame = (frame: { channelId: string; payload: Uint8Array }) => {
|
||||||
if (frame.channelId !== "schema") return;
|
if (frame.channelId !== "schema") return;
|
||||||
const response = parseCultNetMessage(decode(frame.payload));
|
const response = parseCultNetMessage(decode(frame.payload));
|
||||||
if (response.schemaVersion === "cultnet.error.v0") throw new IdunnPresenceRefusedError(response);
|
if (response.schemaVersion === "cultnet.error.v0") throw new IdunnPresenceRefusedError(response);
|
||||||
// An error.v1 refuses this put only when it names it (or names nothing).
|
succeeded = true;
|
||||||
if (response.schemaVersion === "cultnet.error.v1" && (response.messageId === null || response.messageId === message.messageId)) {
|
|
||||||
throw new IdunnPresenceRefusedError(response);
|
|
||||||
}
|
|
||||||
};
|
};
|
||||||
await receiveUntil(receiver, session, endpoint, () => session.outstandingReliablePacketCount === 0, 2000, onFrame);
|
await receiveUntil(receiver, session, endpoint, () => session.outstandingReliablePacketCount === 0, 2000, onFrame);
|
||||||
return "sent";
|
if (!succeeded) await receiveUntil(receiver, session, endpoint, () => succeeded, RESULT_WINDOW_MS, onFrame, true);
|
||||||
} finally {
|
} finally {
|
||||||
receiver.close();
|
receiver.close();
|
||||||
socket.close();
|
socket.close();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** How long after the transport ack Odin's refusal may still arrive; a success reply ends the wait early. */
|
||||||
|
const RESULT_WINDOW_MS = 500;
|
||||||
|
|
||||||
/** Odin refused the presence put: the typed `cultnet.error.v0` it answered with. */
|
/** Odin refused the presence put: the typed `cultnet.error.v0` it answered with. */
|
||||||
export class IdunnPresenceRefusedError extends Error {
|
export class IdunnPresenceRefusedError extends Error {
|
||||||
readonly code: string | undefined;
|
readonly code: string | undefined;
|
||||||
|
|
@ -206,6 +200,7 @@ async function receiveUntil(
|
||||||
predicate: (packet: CultNetRudpPacket) => boolean,
|
predicate: (packet: CultNetRudpPacket) => boolean,
|
||||||
timeoutMs: number,
|
timeoutMs: number,
|
||||||
onDelivered?: (frame: { channelId: string; payload: Uint8Array; sequence: number }) => void,
|
onDelivered?: (frame: { channelId: string; payload: Uint8Array; sequence: number }) => void,
|
||||||
|
returnOnTimeout = false,
|
||||||
): Promise<void> {
|
): Promise<void> {
|
||||||
const deadline = Date.now() + timeoutMs;
|
const deadline = Date.now() + timeoutMs;
|
||||||
while (Date.now() < deadline) {
|
while (Date.now() < deadline) {
|
||||||
|
|
@ -220,6 +215,7 @@ async function receiveUntil(
|
||||||
}
|
}
|
||||||
for (const packet of session.dueResends(Date.now())) await sendPacket(receiver.socket, endpoint, packet);
|
for (const packet of session.dueResends(Date.now())) await sendPacket(receiver.socket, endpoint, packet);
|
||||||
}
|
}
|
||||||
|
if (returnOnTimeout) return;
|
||||||
throw new Error(`Timed out waiting for CultNet RUDP response after ${timeoutMs} ms.`);
|
throw new Error(`Timed out waiting for CultNet RUDP response after ${timeoutMs} ms.`);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -17,12 +17,6 @@ export {
|
||||||
type CultNetRawDocumentRecord,
|
type CultNetRawDocumentRecord,
|
||||||
type CultNetRawPayloadEncoding,
|
type CultNetRawPayloadEncoding,
|
||||||
CULTNET_ERROR_CODES,
|
CULTNET_ERROR_CODES,
|
||||||
CULTNET_ERROR_V1_CODES,
|
|
||||||
CULTNET_WRITE_RECEIPT_MESSAGE_VERSIONS,
|
|
||||||
helloAdvertisesWriteReceipts,
|
|
||||||
type CultNetErrorV1Code,
|
|
||||||
type CultNetErrorV1Message,
|
|
||||||
type CultNetWriteAdmittedMessage,
|
|
||||||
cultNetTextError,
|
cultNetTextError,
|
||||||
cultNetMessageInvalidError,
|
cultNetMessageInvalidError,
|
||||||
cultNetWriteNotAuthorizedError,
|
cultNetWriteNotAuthorizedError,
|
||||||
|
|
@ -255,15 +249,3 @@ export {
|
||||||
type IdunnRuntimePresencePublisher,
|
type IdunnRuntimePresencePublisher,
|
||||||
type IdunnRuntimePresencePublisherOptions,
|
type IdunnRuntimePresencePublisherOptions,
|
||||||
} from "./idunn-odin-presence-publisher";
|
} from "./idunn-odin-presence-publisher";
|
||||||
|
|
||||||
export {
|
|
||||||
LEGACY_RESULT_WINDOW_MS,
|
|
||||||
RECEIPT_RESULT_WINDOW_MS,
|
|
||||||
WriteTracker,
|
|
||||||
resultWindowMs,
|
|
||||||
type WriteRecorded,
|
|
||||||
type WriteSettlement,
|
|
||||||
type WriteState,
|
|
||||||
type WriteTrackerOptions,
|
|
||||||
type WriteUnconfirmedReason,
|
|
||||||
} from "./write-tracker";
|
|
||||||
|
|
|
||||||
|
|
@ -1,144 +0,0 @@
|
||||||
// The client half of the write receipt (contracts/cultnet/interop/write-receipt.md, "Client rules"): a pure state
|
|
||||||
// machine with an abstract clock. It owns exactly one decision, how each sent write settles. Transport, timers and
|
|
||||||
// frame decoding belong to the caller; the replay runner (tools/replay-write-receipt-vectors.mjs) drives this same
|
|
||||||
// interface from write-receipt-vectors.json.
|
|
||||||
|
|
||||||
import type { CultNetErrorMessage, CultNetErrorV1Message, CultNetMessage } from "./contracts";
|
|
||||||
|
|
||||||
/** The result window against a server whose hello lists both receipt frames. */
|
|
||||||
export const RECEIPT_RESULT_WINDOW_MS = 5000;
|
|
||||||
/** The result window against a server whose hello does not list them (or that sent none). */
|
|
||||||
export const LEGACY_RESULT_WINDOW_MS = 500;
|
|
||||||
|
|
||||||
export function resultWindowMs(serverAdvertisesReceipts: boolean): number {
|
|
||||||
return serverAdvertisesReceipts ? RECEIPT_RESULT_WINDOW_MS : LEGACY_RESULT_WINDOW_MS;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Why nothing settled a write: its window ran out, the session ended first, or the client's own send of it failed (it may or
|
|
||||||
* may not have left the machine, and is never a refusal).
|
|
||||||
*/
|
|
||||||
export type WriteUnconfirmedReason = "window_elapsed" | "session_ended" | "local_send_failed";
|
|
||||||
/** What a late answer is recorded as on a write that already settled unconfirmed. */
|
|
||||||
export type WriteRecorded = "admitted_late" | "refused_late";
|
|
||||||
|
|
||||||
/** What the caller was told. Settled once; never changed by a later frame. */
|
|
||||||
export type WriteSettlement =
|
|
||||||
| { outcome: "admitted" }
|
|
||||||
| { outcome: "refused"; code: string | null; error: string; response: CultNetErrorMessage | CultNetErrorV1Message }
|
|
||||||
| { outcome: "unconfirmed"; reason: WriteUnconfirmedReason };
|
|
||||||
|
|
||||||
/** A write's state: unanswered, or its settlement plus (after unconfirmed only) the late answer. */
|
|
||||||
export type WriteState =
|
|
||||||
| { outcome: "pending"; recorded?: undefined }
|
|
||||||
| (WriteSettlement & { recorded?: WriteRecorded });
|
|
||||||
|
|
||||||
export interface WriteTrackerOptions {
|
|
||||||
/** The result window, from the send. Use `resultWindowMs(serverAdvertisesReceipts)`. */
|
|
||||||
windowMs: number;
|
|
||||||
/** Called once per write, at the moment it settles. */
|
|
||||||
onSettle?: (messageId: string, settlement: WriteSettlement) => void;
|
|
||||||
}
|
|
||||||
|
|
||||||
interface Entry {
|
|
||||||
sentAtMs: number;
|
|
||||||
state: WriteState;
|
|
||||||
}
|
|
||||||
|
|
||||||
export class WriteTracker {
|
|
||||||
readonly #windowMs: number;
|
|
||||||
readonly #onSettle?: (messageId: string, settlement: WriteSettlement) => void;
|
|
||||||
readonly #writes = new Map<string, Entry>();
|
|
||||||
|
|
||||||
constructor(options: WriteTrackerOptions) {
|
|
||||||
this.#windowMs = options.windowMs;
|
|
||||||
this.#onSettle = options.onSettle;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Registers a write sent at `atMs`. A messageId is minted once per session: re-sending a known id is the same write. */
|
|
||||||
send(messageId: string, atMs: number): void {
|
|
||||||
this.tick(atMs);
|
|
||||||
if (!this.#writes.has(messageId)) this.#writes.set(messageId, { sentAtMs: atMs, state: { outcome: "pending" } });
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Feeds one decoded frame received at `atMs`. Frames that are not answers to a write are ignored. */
|
|
||||||
frame(message: CultNetMessage, atMs: number): void {
|
|
||||||
this.tick(atMs);
|
|
||||||
switch (message.schemaVersion) {
|
|
||||||
case "cultnet.write_admitted.v0":
|
|
||||||
this.#answer(message.messageId, { outcome: "admitted" }, "admitted_late");
|
|
||||||
return;
|
|
||||||
case "cultnet.error.v1":
|
|
||||||
if (message.messageId !== null) {
|
|
||||||
this.#answer(message.messageId, refusalOf(message), "refused_late");
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
break;
|
|
||||||
case "cultnet.error.v0":
|
|
||||||
break;
|
|
||||||
default:
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
// An error that names no write is attributable only when exactly one write is unanswered.
|
|
||||||
const unanswered = [...this.#writes].filter(([, entry]) => entry.state.outcome === "pending");
|
|
||||||
if (unanswered.length === 1) this.#settle(unanswered[0][0], unanswered[0][1], refusalOf(message));
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Advances the clock: every unanswered write whose window, counted from its send, has run settles unconfirmed. */
|
|
||||||
tick(atMs: number): void {
|
|
||||||
for (const [messageId, entry] of this.#writes) {
|
|
||||||
if (entry.state.outcome === "pending" && atMs - entry.sentAtMs >= this.#windowMs) {
|
|
||||||
this.#settle(messageId, entry, { outcome: "unconfirmed", reason: "window_elapsed" });
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The session ended: every unanswered write settles unconfirmed. */
|
|
||||||
sessionEnd(atMs: number): void {
|
|
||||||
this.tick(atMs);
|
|
||||||
for (const [messageId, entry] of this.#writes) {
|
|
||||||
if (entry.state.outcome === "pending") this.#settle(messageId, entry, { outcome: "unconfirmed", reason: "session_ended" });
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/** This client's own send of `messageId` failed: that write settles unconfirmed; the others are untouched. */
|
|
||||||
sendFailed(messageId: string, atMs: number): void {
|
|
||||||
const entry = this.#writes.get(messageId);
|
|
||||||
if (entry?.state.outcome === "pending") this.#settle(messageId, entry, { outcome: "unconfirmed", reason: "local_send_failed" });
|
|
||||||
this.tick(atMs);
|
|
||||||
}
|
|
||||||
|
|
||||||
state(messageId: string): WriteState | undefined {
|
|
||||||
return this.#writes.get(messageId)?.state;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Milliseconds from `atMs` until the next unanswered write's window runs out; undefined when none is unanswered. */
|
|
||||||
nextDeadlineMs(atMs: number): number | undefined {
|
|
||||||
let next: number | undefined;
|
|
||||||
for (const entry of this.#writes.values()) {
|
|
||||||
if (entry.state.outcome !== "pending") continue;
|
|
||||||
const remaining = Math.max(0, entry.sentAtMs + this.#windowMs - atMs);
|
|
||||||
if (next === undefined || remaining < next) next = remaining;
|
|
||||||
}
|
|
||||||
return next;
|
|
||||||
}
|
|
||||||
|
|
||||||
#answer(messageId: string, settlement: WriteSettlement, late: WriteRecorded): void {
|
|
||||||
const entry = this.#writes.get(messageId);
|
|
||||||
if (!entry) return; // names a write that is not in flight: settles nothing
|
|
||||||
if (entry.state.outcome === "pending") {
|
|
||||||
this.#settle(messageId, entry, settlement);
|
|
||||||
} else if (entry.state.outcome === "unconfirmed" && entry.state.recorded === undefined) {
|
|
||||||
entry.state = { ...entry.state, recorded: late };
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#settle(messageId: string, entry: Entry, settlement: WriteSettlement): void {
|
|
||||||
entry.state = settlement;
|
|
||||||
this.#onSettle?.(messageId, settlement);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function refusalOf(message: CultNetErrorMessage | CultNetErrorV1Message): WriteSettlement {
|
|
||||||
return { outcome: "refused", code: message.code, error: message.error, response: message };
|
|
||||||
}
|
|
||||||
|
|
@ -1,94 +0,0 @@
|
||||||
// The presence publisher is send-only (write-receipt.md): Odin answers no write with a receipt yet, so no frame, whatever
|
|
||||||
// id it carries, is admission. Each test serves it a fake Odin that acknowledges the put and answers as scripted.
|
|
||||||
import assert from "node:assert/strict";
|
|
||||||
import { createSocket, type Socket } from "node:dgram";
|
|
||||||
import test from "node:test";
|
|
||||||
import { encode, decode } from "@msgpack/msgpack";
|
|
||||||
|
|
||||||
import { encodeCultNetMessageForWire, type CultNetMessage } from "../src/contracts";
|
|
||||||
import { IdunnPresenceRefusedError, sendPresenceDocument } from "../src/idunn-odin-presence-publisher";
|
|
||||||
import { CultNetRudpSession, decodeRudpPacket, encodeRudpPacket } from "../src/rudp";
|
|
||||||
|
|
||||||
interface Script {
|
|
||||||
answer: "silence" | "echo" | "admitted" | "refuse-v0" | "refuse-v1-other" | "refuse-v1-same" | "refuse-v1-none";
|
|
||||||
/** Acknowledge the put? Default true. */
|
|
||||||
ack?: boolean;
|
|
||||||
}
|
|
||||||
|
|
||||||
async function fakeOdin(connectionId: number, script: Script) {
|
|
||||||
const socket: Socket = createSocket("udp4");
|
|
||||||
await new Promise<void>((resolve) => socket.bind(0, "127.0.0.1", resolve));
|
|
||||||
const session = new CultNetRudpSession({ connectionId, resendDelayMs: 50 });
|
|
||||||
const send = (packet: Parameters<typeof encodeRudpPacket>[0], port: number, address: string) => {
|
|
||||||
try { socket.send(encodeRudpPacket(packet), port, address); } catch { /* closed */ }
|
|
||||||
};
|
|
||||||
const say = (message: CultNetMessage, port: number, address: string) => {
|
|
||||||
const packets = session.sendMany("schema", encode(encodeCultNetMessageForWire(message, "cultnet.schema.v0")), { reliable: true, ordered: true, nowMs: Date.now() });
|
|
||||||
packets.forEach((p) => send(p, port, address));
|
|
||||||
};
|
|
||||||
socket.on("message", (wire, remote) => {
|
|
||||||
const packet = decodeRudpPacket(wire);
|
|
||||||
const now = Date.now();
|
|
||||||
if (packet.packetType === "connect") {
|
|
||||||
send(session.acceptConnect(packet, now), remote.port, remote.address);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const result = session.receive(packet, now);
|
|
||||||
if (result.reply) send(result.reply, remote.port, remote.address);
|
|
||||||
for (const frame of result.delivered) {
|
|
||||||
if (frame.channelId !== "schema") continue;
|
|
||||||
const put = decode(frame.payload) as { messageId: string; document: unknown };
|
|
||||||
if (script.answer === "echo") say({ schemaVersion: "cultnet.document_put_raw.v0", messageId: put.messageId, document: put.document } as unknown as CultNetMessage, remote.port, remote.address);
|
|
||||||
else if (script.answer === "admitted") say({ schemaVersion: "cultnet.write_admitted.v0", messageId: put.messageId, operation: "put", schemaId: "s", recordKey: "k" }, remote.port, remote.address);
|
|
||||||
else if (script.answer === "refuse-v0") say({ schemaVersion: "cultnet.error.v0", error: "no", routingHint: null, code: "write_not_authorized", details: null }, remote.port, remote.address);
|
|
||||||
else if (script.answer === "refuse-v1-other") say({ schemaVersion: "cultnet.error.v1", error: "no", routingHint: null, code: "write_not_authorized", details: null, messageId: "someone-else" }, remote.port, remote.address);
|
|
||||||
else if (script.answer === "refuse-v1-same") say({ schemaVersion: "cultnet.error.v1", error: "no", routingHint: null, code: "write_not_authorized", details: null, messageId: put.messageId }, remote.port, remote.address);
|
|
||||||
else if (script.answer === "refuse-v1-none") say({ schemaVersion: "cultnet.error.v1", error: "no", routingHint: null, code: "write_not_authorized", details: null, messageId: null }, remote.port, remote.address);
|
|
||||||
}
|
|
||||||
if (packet.reliable && script.ack !== false) send(session.createAckForReceived(packet.sequence), remote.port, remote.address);
|
|
||||||
});
|
|
||||||
return { port: socket.address().port, close: () => socket.close() };
|
|
||||||
}
|
|
||||||
|
|
||||||
let nextConnection = 0x0d1d1000;
|
|
||||||
const put = (id: string) => ({ schemaVersion: "cultnet.document_put_raw.v0", messageId: id, document: { schemaId: "s", recordKey: "k", storedAt: "t", payloadEncoding: "messagepack", payload: new Uint8Array([1]) } });
|
|
||||||
const sendTo = (server: { port: number }, id: string, connectionId: number) =>
|
|
||||||
sendPresenceDocument({ host: "127.0.0.1", port: server.port }, connectionId, put(id));
|
|
||||||
|
|
||||||
for (const answer of ["silence", "echo", "admitted", "refuse-v1-other"] as const) {
|
|
||||||
test(`a ${answer} Odin yields sent, never admitted: no frame carrying the put's id is success`, async () => {
|
|
||||||
const connectionId = nextConnection++;
|
|
||||||
const server = await fakeOdin(connectionId, { answer });
|
|
||||||
try {
|
|
||||||
const outcome = await sendTo(server, "presence-1", connectionId);
|
|
||||||
assert.equal(outcome, "sent");
|
|
||||||
assert.notEqual(outcome as string, "admitted");
|
|
||||||
} finally { server.close(); }
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
test("a refusal that arrives by the transport ack rejects the put", async () => {
|
|
||||||
const connectionId = nextConnection++;
|
|
||||||
const server = await fakeOdin(connectionId, { answer: "refuse-v0" });
|
|
||||||
try {
|
|
||||||
await assert.rejects(sendTo(server, "presence-1", connectionId), IdunnPresenceRefusedError);
|
|
||||||
} finally { server.close(); }
|
|
||||||
});
|
|
||||||
|
|
||||||
for (const answer of ["refuse-v1-same", "refuse-v1-none"] as const) {
|
|
||||||
test(`an error.v1 refusal that ${answer === "refuse-v1-same" ? "names this put" : "names no put"} rejects the put`, async () => {
|
|
||||||
const connectionId = nextConnection++;
|
|
||||||
const server = await fakeOdin(connectionId, { answer });
|
|
||||||
try {
|
|
||||||
await assert.rejects(sendTo(server, "presence-1", connectionId), IdunnPresenceRefusedError);
|
|
||||||
} finally { server.close(); }
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
test("a put the transport never acknowledges is an error, not sent", async () => {
|
|
||||||
const connectionId = nextConnection++;
|
|
||||||
const server = await fakeOdin(connectionId, { answer: "silence", ack: false });
|
|
||||||
try {
|
|
||||||
await assert.rejects(sendTo(server, "presence-1", connectionId), /Timed out/);
|
|
||||||
} finally { server.close(); }
|
|
||||||
});
|
|
||||||
|
|
@ -345,27 +345,18 @@ test("the Odin publisher publishes the signer's document to the endpoint Expecte
|
||||||
assert.equal(peer.failure, undefined, peer.failure?.message);
|
assert.equal(peer.failure, undefined, peer.failure?.message);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("the Odin publisher rejects a presence whose refusal arrives before the transport ack", async (context) => {
|
for (const order of ["ack-then-refusal", "refusal-then-ack"] as const) {
|
||||||
const endpoint = expectedFacts("service").odinEndpoint!;
|
test(`the Odin publisher does not complete on the ack of a refused presence (${order})`, async (context) => {
|
||||||
const peer = await startOdinPeer(context, endpoint);
|
const endpoint = expectedFacts("service").odinEndpoint!;
|
||||||
peer.reject = true;
|
const peer = await startOdinPeer(context, endpoint);
|
||||||
peer.order = "refusal-then-ack";
|
peer.reject = true;
|
||||||
const signer = signerFor(context, "service");
|
peer.order = order;
|
||||||
signer.reportHealth("active");
|
const signer = signerFor(context, "service");
|
||||||
const publisher = createIdunnRuntimePresencePublisher({ signer, endpoint });
|
signer.reportHealth("active");
|
||||||
await assert.rejects(publisher.publish("denied presence"), /Odin rejected runtime presence: test admission denied/);
|
const publisher = createIdunnRuntimePresencePublisher({ signer, endpoint });
|
||||||
});
|
await assert.rejects(publisher.publish("denied presence"), /Odin rejected runtime presence: test admission denied/);
|
||||||
|
});
|
||||||
test("the Odin publisher is send-only: a refusal that follows the transport ack is not awaited", async (context) => {
|
}
|
||||||
const endpoint = expectedFacts("service").odinEndpoint!;
|
|
||||||
const peer = await startOdinPeer(context, endpoint);
|
|
||||||
peer.reject = true;
|
|
||||||
peer.order = "ack-then-refusal";
|
|
||||||
const signer = signerFor(context, "service");
|
|
||||||
signer.reportHealth("active");
|
|
||||||
const publisher = createIdunnRuntimePresencePublisher({ signer, endpoint });
|
|
||||||
await publisher.publish("denied presence");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("the Odin publisher leaves a capability shortfall to the Rust correlation instead of refusing to publish", async (context) => {
|
test("the Odin publisher leaves a capability shortfall to the Rust correlation instead of refusing to publish", async (context) => {
|
||||||
const endpoint = expectedFacts("service").odinEndpoint!;
|
const endpoint = expectedFacts("service").odinEndpoint!;
|
||||||
|
|
|
||||||
|
|
@ -1,229 +0,0 @@
|
||||||
import test from "node:test";
|
|
||||||
import assert from "node:assert/strict";
|
|
||||||
import { spawnSync } from "node:child_process";
|
|
||||||
import { join } from "node:path";
|
|
||||||
|
|
||||||
import {
|
|
||||||
CULTNET_ERROR_CODES,
|
|
||||||
CULTNET_ERROR_V1_CODES,
|
|
||||||
CULTNET_WRITE_RECEIPT_MESSAGE_VERSIONS,
|
|
||||||
LEGACY_RESULT_WINDOW_MS,
|
|
||||||
RECEIPT_RESULT_WINDOW_MS,
|
|
||||||
WriteTracker,
|
|
||||||
cultNetSchemas,
|
|
||||||
helloAdvertisesWriteReceipts,
|
|
||||||
parseCultNetMessage,
|
|
||||||
resultWindowMs,
|
|
||||||
type CultNetErrorV1Message,
|
|
||||||
type CultNetMessage,
|
|
||||||
type CultNetWriteAdmittedMessage,
|
|
||||||
type WriteSettlement,
|
|
||||||
} from "../src";
|
|
||||||
|
|
||||||
const admitted = (messageId: string): CultNetWriteAdmittedMessage =>
|
|
||||||
({ schemaVersion: "cultnet.write_admitted.v0", messageId, operation: "put", schemaId: "note.v0", recordKey: "note:1" });
|
|
||||||
const refusedV1 = (messageId: string | null, code: CultNetErrorV1Message["code"] = "write_not_authorized"): CultNetErrorV1Message =>
|
|
||||||
({ schemaVersion: "cultnet.error.v1", error: "no", routingHint: null, code, details: null, messageId });
|
|
||||||
const errorV0 = (): CultNetMessage =>
|
|
||||||
({ schemaVersion: "cultnet.error.v0", error: "no", routingHint: null, code: "write_not_authorized", details: null });
|
|
||||||
|
|
||||||
test("error.v1 accepts every code of its closed enum, limit_reached included, and refuses any other", () => {
|
|
||||||
const schemaCodes = ((cultNetSchemas.errorV1Schema.properties.code as { enum: (string | null)[] }).enum).filter((c) => c !== null);
|
|
||||||
assert.deepEqual([...CULTNET_ERROR_V1_CODES].sort(), [...schemaCodes].sort());
|
|
||||||
for (const code of CULTNET_ERROR_V1_CODES) parseCultNetMessage({ ...refusedV1("w1"), code });
|
|
||||||
assert.throws(() => parseCultNetMessage({ ...refusedV1("w1"), code: "invented" }));
|
|
||||||
});
|
|
||||||
|
|
||||||
test("error.v1 echoes messageId byte for byte, allows nil, and requires the key", () => {
|
|
||||||
assert.equal((parseCultNetMessage(refusedV1("w-é 1")) as CultNetErrorV1Message).messageId, "w-é 1");
|
|
||||||
assert.equal((parseCultNetMessage(refusedV1(null)) as CultNetErrorV1Message).messageId, null);
|
|
||||||
const { messageId: _omitted, ...withoutId } = refusedV1("w1");
|
|
||||||
assert.throws(() => parseCultNetMessage(withoutId));
|
|
||||||
assert.throws(() => parseCultNetMessage(refusedV1("")));
|
|
||||||
});
|
|
||||||
|
|
||||||
test("error.v0 is unaffected: still closed, no messageId, no limit_reached", () => {
|
|
||||||
assert.deepEqual([...CULTNET_ERROR_CODES].includes("limit_reached" as never), false);
|
|
||||||
assert.throws(() => parseCultNetMessage({ ...errorV0(), code: "limit_reached" }));
|
|
||||||
assert.throws(() => parseCultNetMessage({ ...errorV0(), messageId: "w1" }));
|
|
||||||
assert.equal(parseCultNetMessage(errorV0()).schemaVersion, "cultnet.error.v0");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("write_admitted needs all five keys, a known operation and no error key", () => {
|
|
||||||
parseCultNetMessage(admitted("w1"));
|
|
||||||
parseCultNetMessage({ ...admitted("w1"), operation: "delete" });
|
|
||||||
assert.throws(() => parseCultNetMessage({ ...admitted("w1"), operation: "upsert" }));
|
|
||||||
assert.throws(() => parseCultNetMessage({ ...admitted("w1"), error: "nope" }));
|
|
||||||
const { recordKey: _omitted, ...short } = admitted("w1");
|
|
||||||
assert.throws(() => parseCultNetMessage(short));
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a hello is receipt-capable only when it lists both frames", () => {
|
|
||||||
assert.equal(helloAdvertisesWriteReceipts({ supportedMessageVersions: [...CULTNET_WRITE_RECEIPT_MESSAGE_VERSIONS] }), true);
|
|
||||||
assert.equal(helloAdvertisesWriteReceipts({ supportedMessageVersions: ["cultnet.write_admitted.v0"] }), false);
|
|
||||||
assert.equal(helloAdvertisesWriteReceipts({ supportedMessageVersions: ["cultnet.error.v1"] }), false);
|
|
||||||
assert.equal(helloAdvertisesWriteReceipts({}), false);
|
|
||||||
const hello = parseCultNetMessage({ schemaVersion: "cultnet.hello.v0", runtimeId: "r", runtimeKind: "k", supportedMessageVersions: [...CULTNET_WRITE_RECEIPT_MESSAGE_VERSIONS] });
|
|
||||||
assert.equal(hello.schemaVersion, "cultnet.hello.v0");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("the window is 5000 ms for a receipt-capable server and 500 ms otherwise", () => {
|
|
||||||
assert.equal(resultWindowMs(true), RECEIPT_RESULT_WINDOW_MS);
|
|
||||||
assert.equal(resultWindowMs(false), LEGACY_RESULT_WINDOW_MS);
|
|
||||||
assert.equal(RECEIPT_RESULT_WINDOW_MS, 5000);
|
|
||||||
assert.equal(LEGACY_RESULT_WINDOW_MS, 500);
|
|
||||||
});
|
|
||||||
|
|
||||||
function tracker(windowMs = 500) {
|
|
||||||
const told: [string, WriteSettlement][] = [];
|
|
||||||
return { told, t: new WriteTracker({ windowMs, onSettle: (id, s) => told.push([id, s]) }) };
|
|
||||||
}
|
|
||||||
|
|
||||||
test("tracker: the window is inclusive at exactly windowMs and open one ms before", () => {
|
|
||||||
const { t, told } = tracker();
|
|
||||||
t.send("w1", 100);
|
|
||||||
t.tick(599);
|
|
||||||
assert.equal(t.state("w1")?.outcome, "pending");
|
|
||||||
t.tick(600);
|
|
||||||
assert.deepEqual(told, [["w1", { outcome: "unconfirmed", reason: "window_elapsed" }]]);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("tracker: each write's window runs from its own send", () => {
|
|
||||||
const { t } = tracker();
|
|
||||||
t.send("w1", 0);
|
|
||||||
t.send("w2", 300);
|
|
||||||
t.tick(500);
|
|
||||||
assert.equal(t.state("w1")?.outcome, "unconfirmed");
|
|
||||||
assert.equal(t.state("w2")?.outcome, "pending");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("tracker: a frame arriving after the window cannot admit the write; it is recorded late", () => {
|
|
||||||
const { t, told } = tracker();
|
|
||||||
t.send("w1", 0);
|
|
||||||
t.frame(admitted("w1"), 500);
|
|
||||||
assert.deepEqual(t.state("w1"), { outcome: "unconfirmed", reason: "window_elapsed", recorded: "admitted_late" });
|
|
||||||
assert.equal(told.length, 1);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("tracker: a write settles once; later frames neither change it nor flip a late record", () => {
|
|
||||||
const { t, told } = tracker();
|
|
||||||
t.send("w1", 0);
|
|
||||||
t.frame(refusedV1("w1"), 10);
|
|
||||||
t.frame(admitted("w1"), 20);
|
|
||||||
t.frame(refusedV1("w1", "message_invalid"), 30);
|
|
||||||
t.sessionEnd(40);
|
|
||||||
assert.equal(told.length, 1);
|
|
||||||
assert.deepEqual(told[0][1], { outcome: "refused", code: "write_not_authorized", error: "no", response: refusedV1("w1") });
|
|
||||||
t.send("w2", 100);
|
|
||||||
t.tick(600);
|
|
||||||
t.frame(refusedV1("w2"), 700);
|
|
||||||
t.frame(admitted("w2"), 800);
|
|
||||||
assert.equal(t.state("w2")?.outcome === "unconfirmed" && t.state("w2")?.recorded, "refused_late");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("tracker: an id-less error refuses the single unanswered write only, counting answered writes out", () => {
|
|
||||||
const { t } = tracker();
|
|
||||||
t.send("w1", 0);
|
|
||||||
t.send("w2", 1);
|
|
||||||
t.frame(admitted("w1"), 5);
|
|
||||||
t.frame(refusedV1(null), 6);
|
|
||||||
assert.equal(t.state("w1")?.outcome, "admitted");
|
|
||||||
assert.equal(t.state("w2")?.outcome, "refused");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("tracker: an id-less error never reaches a write that already ended unconfirmed", () => {
|
|
||||||
const { t } = tracker();
|
|
||||||
t.send("w1", 0);
|
|
||||||
t.tick(500);
|
|
||||||
t.frame(errorV0(), 501);
|
|
||||||
assert.deepEqual(t.state("w1"), { outcome: "unconfirmed", reason: "window_elapsed" });
|
|
||||||
});
|
|
||||||
|
|
||||||
test("tracker: sessionEnd settles unanswered writes only, and an expired window keeps its own reason", () => {
|
|
||||||
const { t } = tracker();
|
|
||||||
t.send("w1", 0);
|
|
||||||
t.send("w2", 0);
|
|
||||||
t.send("w3", 400);
|
|
||||||
t.frame(admitted("w2"), 10);
|
|
||||||
t.sessionEnd(600);
|
|
||||||
assert.deepEqual(t.state("w1"), { outcome: "unconfirmed", reason: "window_elapsed" });
|
|
||||||
assert.equal(t.state("w2")?.outcome, "admitted");
|
|
||||||
assert.deepEqual(t.state("w3"), { outcome: "unconfirmed", reason: "session_ended" });
|
|
||||||
});
|
|
||||||
|
|
||||||
test("tracker: re-sending a known id is the same write and does not restart its window", () => {
|
|
||||||
const { t } = tracker();
|
|
||||||
t.send("w1", 0);
|
|
||||||
t.send("w1", 400);
|
|
||||||
t.tick(500);
|
|
||||||
assert.equal(t.state("w1")?.outcome, "unconfirmed");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("tracker: a send past another write's window settles that write at once", () => {
|
|
||||||
const { t, told } = tracker();
|
|
||||||
t.send("w1", 0);
|
|
||||||
t.send("w2", 600);
|
|
||||||
assert.deepEqual(told, [["w1", { outcome: "unconfirmed", reason: "window_elapsed" }]]);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("tracker: only receipt and error frames answer; any other frame naming the id settles nothing", () => {
|
|
||||||
const { t } = tracker();
|
|
||||||
t.send("w1", 0);
|
|
||||||
t.frame({ schemaVersion: "cultnet.hello.v0", runtimeId: "r", runtimeKind: "k" }, 1);
|
|
||||||
t.frame({ schemaVersion: "cultnet.document_put_raw.v0", messageId: "w1" } as unknown as CultNetMessage, 2);
|
|
||||||
assert.equal(t.state("w1")?.outcome, "pending");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("tracker: nextDeadlineMs reports the nearest unanswered window, none when all settled", () => {
|
|
||||||
const { t } = tracker();
|
|
||||||
assert.equal(t.nextDeadlineMs(0), undefined);
|
|
||||||
t.send("w1", 0);
|
|
||||||
t.send("w2", 100);
|
|
||||||
assert.equal(t.nextDeadlineMs(50), 450);
|
|
||||||
assert.equal(t.nextDeadlineMs(900), 0);
|
|
||||||
t.frame(admitted("w1"), 60);
|
|
||||||
assert.equal(t.nextDeadlineMs(150), 450);
|
|
||||||
t.frame(admitted("w2"), 160);
|
|
||||||
assert.equal(t.nextDeadlineMs(170), undefined);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("the replay runner passes every vector against this runtime", () => {
|
|
||||||
const script = join(__dirname, "..", "..", "tools", "replay-write-receipt-vectors.mjs");
|
|
||||||
const run = spawnSync(process.execPath, [script], { encoding: "utf8" });
|
|
||||||
assert.equal(run.status, 0, run.stdout + run.stderr);
|
|
||||||
assert.match(run.stdout, /^PASS scenario\/receipt_admits$/m);
|
|
||||||
assert.doesNotMatch(run.stdout, /^FAIL/m);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a failed local send settles only that write unconfirmed as local_send_failed, and an answer after it is recorded late", () => {
|
|
||||||
const settled: [string, WriteSettlement][] = [];
|
|
||||||
const tracker = new WriteTracker({ windowMs: 1000, onSettle: (id, settlement) => settled.push([id, settlement]) });
|
|
||||||
tracker.send("w1", 0);
|
|
||||||
tracker.send("w2", 0);
|
|
||||||
tracker.sendFailed("w1", 10);
|
|
||||||
assert.deepEqual(settled, [["w1", { outcome: "unconfirmed", reason: "local_send_failed" }]]);
|
|
||||||
assert.equal(tracker.state("w2")?.outcome, "pending");
|
|
||||||
tracker.frame(admitted("w1"), 20);
|
|
||||||
assert.deepEqual(tracker.state("w1"), { outcome: "unconfirmed", reason: "local_send_failed", recorded: "admitted_late" });
|
|
||||||
tracker.sendFailed("w2", 30);
|
|
||||||
tracker.sendFailed("w2", 31);
|
|
||||||
assert.equal(settled.length, 2, "a write settles once");
|
|
||||||
tracker.sendFailed("unknown", 40);
|
|
||||||
assert.equal(tracker.state("unknown"), undefined);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a failed local send advances the clock: other writes whose windows have run settle window_elapsed", () => {
|
|
||||||
const tracker = new WriteTracker({ windowMs: 1000 });
|
|
||||||
tracker.send("w1", 0);
|
|
||||||
tracker.send("w2", 500);
|
|
||||||
tracker.sendFailed("w2", 1200);
|
|
||||||
assert.deepEqual(tracker.state("w1"), { outcome: "unconfirmed", reason: "window_elapsed" });
|
|
||||||
assert.deepEqual(tracker.state("w2"), { outcome: "unconfirmed", reason: "local_send_failed" });
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a write whose own send failed settles local_send_failed even when its window has also run", () => {
|
|
||||||
const tracker = new WriteTracker({ windowMs: 1000 });
|
|
||||||
tracker.send("w1", 0);
|
|
||||||
tracker.sendFailed("w1", 1000);
|
|
||||||
assert.deepEqual(tracker.state("w1"), { outcome: "unconfirmed", reason: "local_send_failed" });
|
|
||||||
});
|
|
||||||
|
|
@ -1,116 +0,0 @@
|
||||||
#!/usr/bin/env node
|
|
||||||
// Replays contracts/cultnet/interop/write-receipt-vectors.json against this runtime: every `scenarios.cases` event
|
|
||||||
// replay through a fake server and the WriteTracker, and every `wire` / `schemaInvalid` frame through the real
|
|
||||||
// decoder. Prints PASS/FAIL per case; exit 1 on any failure. Runs against the built package (`npm run build` first).
|
|
||||||
//
|
|
||||||
// node tools/replay-write-receipt-vectors.mjs [path/to/write-receipt-vectors.json]
|
|
||||||
//
|
|
||||||
// The runner interface a port (Rust, C#) must reproduce is documented in README.md, "Write receipt replay runner".
|
|
||||||
|
|
||||||
import { readFileSync } from "node:fs";
|
|
||||||
import path from "node:path";
|
|
||||||
import { fileURLToPath } from "node:url";
|
|
||||||
import { createRequire } from "node:module";
|
|
||||||
|
|
||||||
const require = createRequire(import.meta.url);
|
|
||||||
const here = path.dirname(fileURLToPath(import.meta.url));
|
|
||||||
const { decode, encode } = require("@msgpack/msgpack");
|
|
||||||
const {
|
|
||||||
CULTNET_WRITE_RECEIPT_MESSAGE_VERSIONS, LEGACY_RESULT_WINDOW_MS, RECEIPT_RESULT_WINDOW_MS, WriteTracker,
|
|
||||||
encodeCultNetMessageForWire, helloAdvertisesWriteReceipts, parseCultNetMessage, resultWindowMs,
|
|
||||||
} = require(path.join(here, "..", "dist", "index.js"));
|
|
||||||
|
|
||||||
const vectorsPath = process.argv[2] ?? path.join(here, "..", "..", "..", "contracts", "cultnet", "interop", "write-receipt-vectors.json");
|
|
||||||
const vectors = JSON.parse(readFileSync(vectorsPath, "utf8"));
|
|
||||||
|
|
||||||
const results = [];
|
|
||||||
const check = (name, run) => {
|
|
||||||
try {
|
|
||||||
const problems = run();
|
|
||||||
results.push({ name, problems });
|
|
||||||
} catch (error) {
|
|
||||||
results.push({ name, problems: [`threw: ${error instanceof Error ? error.message : String(error)}`] });
|
|
||||||
}
|
|
||||||
};
|
|
||||||
const bytesOf = (hex) => Uint8Array.from(Buffer.from(hex, "hex"));
|
|
||||||
const hexOf = (bytes) => Buffer.from(bytes).toString("hex").toUpperCase();
|
|
||||||
// A frame reaches the client as bytes: the fake server encodes it, the client decodes and validates it.
|
|
||||||
const delivered = (frame) => parseCultNetMessage(decode(encode(frame)));
|
|
||||||
|
|
||||||
check("constants", () => [
|
|
||||||
...(vectors.constants.RECEIPT_RESULT_WINDOW_MS === RECEIPT_RESULT_WINDOW_MS ? [] : [`RECEIPT window ${RECEIPT_RESULT_WINDOW_MS} != ${vectors.constants.RECEIPT_RESULT_WINDOW_MS}`]),
|
|
||||||
...(vectors.constants.LEGACY_RESULT_WINDOW_MS === LEGACY_RESULT_WINDOW_MS ? [] : [`LEGACY window ${LEGACY_RESULT_WINDOW_MS} != ${vectors.constants.LEGACY_RESULT_WINDOW_MS}`]),
|
|
||||||
]);
|
|
||||||
|
|
||||||
for (const vector of vectors.wire) {
|
|
||||||
check(`wire/${vector.name}`, () => {
|
|
||||||
const problems = [];
|
|
||||||
const parsed = parseCultNetMessage(decode(bytesOf(vector.messagePackHex)));
|
|
||||||
if (JSON.stringify(sorted(parsed)) !== JSON.stringify(sorted(vector.message))) problems.push(`decoded ${JSON.stringify(parsed)} != ${JSON.stringify(vector.message)}`);
|
|
||||||
const reencoded = hexOf(encode(encodeCultNetMessageForWire(parsed)));
|
|
||||||
if (reencoded !== vector.messagePackHex.toUpperCase()) problems.push(`re-encoded bytes ${reencoded} != captured ${vector.messagePackHex}`);
|
|
||||||
return problems;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
for (const vector of vectors.schemaInvalid) {
|
|
||||||
check(`schemaInvalid/${vector.name}`, () => {
|
|
||||||
try {
|
|
||||||
parseCultNetMessage(decode(bytesOf(vector.messagePackHex)));
|
|
||||||
} catch {
|
|
||||||
return [];
|
|
||||||
}
|
|
||||||
return [`accepted a frame that must be refused (${vector.why})`];
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
for (const scenario of vectors.scenarios.cases) {
|
|
||||||
check(`scenario/${scenario.name}`, () => {
|
|
||||||
// The fake server states its capability the only way a real one does: in its hello.
|
|
||||||
const serverHello = { schemaVersion: "cultnet.hello.v0", runtimeId: "fake-server", runtimeKind: "fake",
|
|
||||||
...(scenario.server === "receipt" ? { supportedMessageVersions: [...CULTNET_WRITE_RECEIPT_MESSAGE_VERSIONS] } : {}) };
|
|
||||||
const windowMs = resultWindowMs(helloAdvertisesWriteReceipts(serverHello));
|
|
||||||
const problems = [];
|
|
||||||
if (windowMs !== vectors.constants[scenario.window]) problems.push(`window ${windowMs} != ${scenario.window}`);
|
|
||||||
|
|
||||||
const told = new Map(); // what the caller was told, at settle time
|
|
||||||
const tracker = new WriteTracker({ windowMs, onSettle: (id, settlement) => {
|
|
||||||
if (told.has(id)) problems.push(`${id} settled twice`);
|
|
||||||
told.set(id, settlement);
|
|
||||||
} });
|
|
||||||
for (const event of [...scenario.events].sort((a, b) => a.atMs - b.atMs)) {
|
|
||||||
if ("send" in event) tracker.send(event.send, event.atMs);
|
|
||||||
else if ("frame" in event) tracker.frame(delivered(event.frame), event.atMs);
|
|
||||||
else if ("tick" in event) tracker.tick(event.atMs);
|
|
||||||
else if ("sessionEnd" in event) tracker.sessionEnd(event.atMs);
|
|
||||||
// transportAck: delivery is not an answer; the tracker has no such input and must not need one.
|
|
||||||
}
|
|
||||||
for (const [id, want] of Object.entries(scenario.expect)) {
|
|
||||||
const got = told.get(id);
|
|
||||||
if (!got) { problems.push(`${id}: never settled, wanted ${want.outcome}`); continue; }
|
|
||||||
if (got.outcome !== want.outcome) problems.push(`${id}: told ${got.outcome}, wanted ${want.outcome}`);
|
|
||||||
if (want.code !== undefined && got.code !== want.code) problems.push(`${id}: code ${got.code}, wanted ${want.code}`);
|
|
||||||
if (want.reason !== undefined && got.reason !== want.reason) problems.push(`${id}: reason ${got.reason}, wanted ${want.reason}`);
|
|
||||||
const recorded = tracker.state(id)?.recorded;
|
|
||||||
if (recorded !== want.recorded) problems.push(`${id}: recorded ${recorded}, wanted ${want.recorded}`);
|
|
||||||
}
|
|
||||||
for (const id of told.keys()) if (!(id in scenario.expect)) problems.push(`${id}: settled but the scenario expects nothing for it`);
|
|
||||||
return problems;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
function sorted(value) {
|
|
||||||
if (Array.isArray(value)) return value.map(sorted);
|
|
||||||
if (value && typeof value === "object") return Object.fromEntries(Object.keys(value).sort().map((k) => [k, sorted(value[k])]));
|
|
||||||
return value;
|
|
||||||
}
|
|
||||||
|
|
||||||
let failed = 0;
|
|
||||||
for (const { name, problems } of results) {
|
|
||||||
if (problems.length === 0) { console.log(`PASS ${name}`); continue; }
|
|
||||||
failed++;
|
|
||||||
console.log(`FAIL ${name}`);
|
|
||||||
for (const problem of problems) console.log(` ${problem}`);
|
|
||||||
}
|
|
||||||
console.log(`${results.length - failed}/${results.length} passed`);
|
|
||||||
process.exit(failed === 0 ? 0 : 1);
|
|
||||||
|
|
@ -1017,8 +1017,6 @@ namespace GameCult.Networking
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Applies a raw document mutation after checking shard authority. This is the host's own door (and replication's):
|
/// Applies a raw document mutation after checking shard authority. This is the host's own door (and replication's):
|
||||||
/// it asks no remote write authority. A peer's put goes through <see cref="CultNetDatabaseServer"/>, which does.
|
/// it asks no remote write authority. A peer's put goes through <see cref="CultNetDatabaseServer"/>, which does.
|
||||||
/// Returning normally means the put is committed and visible to readers: a receipt-capable peer is told
|
|
||||||
/// <c>write_admitted</c> on the strength of it, so a write that has only been queued must not return.
|
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <exception cref="CultNetUnownedSchemaException">No shard owns the schema and key; nothing was written.</exception>
|
/// <exception cref="CultNetUnownedSchemaException">No shard owns the schema and key; nothing was written.</exception>
|
||||||
/// <exception cref="CultNetShardLogException">The change committed and was published, but the shard log could not record it.</exception>
|
/// <exception cref="CultNetShardLogException">The change committed and was published, but the shard log could not record it.</exception>
|
||||||
|
|
@ -1049,7 +1047,6 @@ namespace GameCult.Networking
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Applies a raw document delete after checking shard authority. This is the host's own door: it asks no remote
|
/// Applies a raw document delete after checking shard authority. This is the host's own door: it asks no remote
|
||||||
/// write authority. A peer's delete goes through <see cref="CultNetDatabaseServer"/>, which does.
|
/// write authority. A peer's delete goes through <see cref="CultNetDatabaseServer"/>, which does.
|
||||||
/// Returning normally means the delete is committed and visible to readers (see <see cref="ApplyPutAsync(CultNetDocumentPutRawMessage)"/>).
|
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <exception cref="CultNetUnownedSchemaException">No shard owns the schema and key; nothing was written.</exception>
|
/// <exception cref="CultNetUnownedSchemaException">No shard owns the schema and key; nothing was written.</exception>
|
||||||
/// <exception cref="CultNetShardLogException">The change committed and was published, but the shard log could not record it.</exception>
|
/// <exception cref="CultNetShardLogException">The change committed and was published, but the shard log could not record it.</exception>
|
||||||
|
|
|
||||||
|
|
@ -22,7 +22,6 @@ namespace GameCult.Networking
|
||||||
private readonly Func<CultNetSnapshotRequestV1Message, CultNetServerPeer, Task> _snapshotHandlerV1;
|
private readonly Func<CultNetSnapshotRequestV1Message, CultNetServerPeer, Task> _snapshotHandlerV1;
|
||||||
private readonly Func<CultNetDocumentPutRawMessage, CultNetServerPeer, Task> _putHandler;
|
private readonly Func<CultNetDocumentPutRawMessage, CultNetServerPeer, Task> _putHandler;
|
||||||
private readonly Func<CultNetDocumentDeleteMessage, CultNetServerPeer, Task> _deleteHandler;
|
private readonly Func<CultNetDocumentDeleteMessage, CultNetServerPeer, Task> _deleteHandler;
|
||||||
private readonly Func<CultNetHelloMessage, CultNetServerPeer, Task> _helloHandler;
|
|
||||||
private readonly Func<CultNetShardCatalogRequestMessage, CultNetServerPeer, Task> _shardCatalogHandler;
|
private readonly Func<CultNetShardCatalogRequestMessage, CultNetServerPeer, Task> _shardCatalogHandler;
|
||||||
private readonly Func<CultNetShardLogRequestMessage, CultNetServerPeer, Task> _shardLogHandler;
|
private readonly Func<CultNetShardLogRequestMessage, CultNetServerPeer, Task> _shardLogHandler;
|
||||||
private readonly Func<CultNetDatabaseSubscribeMessage, CultNetServerPeer, Task> _subscribeHandler;
|
private readonly Func<CultNetDatabaseSubscribeMessage, CultNetServerPeer, Task> _subscribeHandler;
|
||||||
|
|
@ -46,7 +45,6 @@ namespace GameCult.Networking
|
||||||
_snapshotHandlerV1 = HandleSnapshotRequestV1Async;
|
_snapshotHandlerV1 = HandleSnapshotRequestV1Async;
|
||||||
_putHandler = HandlePutAsync;
|
_putHandler = HandlePutAsync;
|
||||||
_deleteHandler = HandleDeleteAsync;
|
_deleteHandler = HandleDeleteAsync;
|
||||||
_helloHandler = HandleHelloAsync;
|
|
||||||
_shardCatalogHandler = HandleShardCatalogRequestAsync;
|
_shardCatalogHandler = HandleShardCatalogRequestAsync;
|
||||||
_shardLogHandler = HandleShardLogRequestAsync;
|
_shardLogHandler = HandleShardLogRequestAsync;
|
||||||
_subscribeHandler = HandleSubscribeAsync;
|
_subscribeHandler = HandleSubscribeAsync;
|
||||||
|
|
@ -57,7 +55,6 @@ namespace GameCult.Networking
|
||||||
_server.OnCultNet(_snapshotHandlerV1);
|
_server.OnCultNet(_snapshotHandlerV1);
|
||||||
_server.OnCultNet(_putHandler);
|
_server.OnCultNet(_putHandler);
|
||||||
_server.OnCultNet(_deleteHandler);
|
_server.OnCultNet(_deleteHandler);
|
||||||
_server.OnCultNet(_helloHandler);
|
|
||||||
_server.OnCultNet(_shardCatalogHandler);
|
_server.OnCultNet(_shardCatalogHandler);
|
||||||
_server.OnCultNet(_shardLogHandler);
|
_server.OnCultNet(_shardLogHandler);
|
||||||
_server.OnCultNet(_subscribeHandler);
|
_server.OnCultNet(_subscribeHandler);
|
||||||
|
|
@ -220,7 +217,6 @@ namespace GameCult.Networking
|
||||||
_server.RemoveCultNetMessageListener<CultNetSnapshotRequestV1Message>(_snapshotHandlerV1);
|
_server.RemoveCultNetMessageListener<CultNetSnapshotRequestV1Message>(_snapshotHandlerV1);
|
||||||
_server.RemoveCultNetMessageListener<CultNetDocumentPutRawMessage>(_putHandler);
|
_server.RemoveCultNetMessageListener<CultNetDocumentPutRawMessage>(_putHandler);
|
||||||
_server.RemoveCultNetMessageListener<CultNetDocumentDeleteMessage>(_deleteHandler);
|
_server.RemoveCultNetMessageListener<CultNetDocumentDeleteMessage>(_deleteHandler);
|
||||||
_server.RemoveCultNetMessageListener<CultNetHelloMessage>(_helloHandler);
|
|
||||||
_server.RemoveCultNetMessageListener<CultNetShardCatalogRequestMessage>(_shardCatalogHandler);
|
_server.RemoveCultNetMessageListener<CultNetShardCatalogRequestMessage>(_shardCatalogHandler);
|
||||||
_server.RemoveCultNetMessageListener<CultNetShardLogRequestMessage>(_shardLogHandler);
|
_server.RemoveCultNetMessageListener<CultNetShardLogRequestMessage>(_shardLogHandler);
|
||||||
_server.RemoveCultNetMessageListener<CultNetDatabaseSubscribeMessage>(_subscribeHandler);
|
_server.RemoveCultNetMessageListener<CultNetDatabaseSubscribeMessage>(_subscribeHandler);
|
||||||
|
|
@ -266,7 +262,7 @@ namespace GameCult.Networking
|
||||||
catch (Exception ex)
|
catch (Exception ex)
|
||||||
{
|
{
|
||||||
_server.Logger.LogError($"CultNet snapshot v1 request failed: {ex.Message}");
|
_server.Logger.LogError($"CultNet snapshot v1 request failed: {ex.Message}");
|
||||||
peer.SendCultNet(new CultNetErrorMessage { Error = "the snapshot request could not be answered" });
|
peer.SendCultNet(new CultNetErrorMessage { Error = ex.Message });
|
||||||
}
|
}
|
||||||
|
|
||||||
return Task.CompletedTask;
|
return Task.CompletedTask;
|
||||||
|
|
@ -286,8 +282,7 @@ namespace GameCult.Networking
|
||||||
}
|
}
|
||||||
catch (Exception ex)
|
catch (Exception ex)
|
||||||
{
|
{
|
||||||
_server.Logger.LogError($"CultNet shard log request failed: {ex.Message}");
|
peer.SendCultNet(new CultNetErrorMessage { Error = ex.Message });
|
||||||
peer.SendCultNet(new CultNetErrorMessage { Error = "the shard log request could not be answered" });
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return Task.CompletedTask;
|
return Task.CompletedTask;
|
||||||
|
|
@ -328,256 +323,74 @@ namespace GameCult.Networking
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
// A hello decides the connection's write framing if it is the first thing to (write-receipt.md, "Capability"). The
|
|
||||||
// server answers a receipt-capable hello with its own, so the client can tell a receipt server from a legacy one.
|
|
||||||
private Task HandleHelloAsync(CultNetHelloMessage hello, CultNetServerPeer peer)
|
|
||||||
{
|
|
||||||
if (peer.Transport != null && peer.Transport.SettleWriteFraming(hello))
|
|
||||||
{
|
|
||||||
Answer(peer, new CultNetHelloMessage
|
|
||||||
{
|
|
||||||
RuntimeId = "gamecult-networking-database-server",
|
|
||||||
RuntimeKind = "dotnet",
|
|
||||||
SupportedMessageVersions = [CultNetSchemaVersions.WriteAdmitted, CultNetSchemaVersions.ErrorV1]
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
return Task.CompletedTask;
|
|
||||||
}
|
|
||||||
|
|
||||||
// The write's receipt state, or null when its connection did not opt in (it is then answered exactly as before).
|
|
||||||
private CultNetReceiptedWrite? BeginReceipted(
|
|
||||||
CultNetServerPeer peer,
|
|
||||||
string operation,
|
|
||||||
string? messageId,
|
|
||||||
string? schemaId,
|
|
||||||
string? recordKey,
|
|
||||||
byte[]? payload)
|
|
||||||
{
|
|
||||||
var transport = peer.Transport;
|
|
||||||
if (transport == null) return null;
|
|
||||||
transport.SettleWriteFraming(null);
|
|
||||||
var session = transport.WriteReceipts;
|
|
||||||
return session == null
|
|
||||||
? null
|
|
||||||
: new CultNetReceiptedWrite(session, message => Answer(peer, message), operation, messageId, schemaId, recordKey, payload);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Every frame a write can be answered with. Mock point for tests: the answer leaves through the peer's transport. An
|
|
||||||
// answer that cannot be queued ends the connection: the peer settles its write as session_ended, never as silence.
|
|
||||||
private void Answer(CultNetServerPeer peer, ICultNetSchemaMessage message)
|
|
||||||
{
|
|
||||||
try
|
|
||||||
{
|
|
||||||
Send(peer, message);
|
|
||||||
}
|
|
||||||
catch (Exception ex)
|
|
||||||
{
|
|
||||||
_server.Logger.LogWarning($"CultNet write answer could not be sent; ending the connection: {ex.Message}");
|
|
||||||
peer.Transport?.End();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private static void Send(CultNetServerPeer peer, ICultNetSchemaMessage message)
|
|
||||||
{
|
|
||||||
switch (message)
|
|
||||||
{
|
|
||||||
case CultNetWriteAdmittedMessage admitted: peer.SendCultNet(admitted); break;
|
|
||||||
case CultNetErrorV1Message error: peer.SendCultNet(error); break;
|
|
||||||
case CultNetErrorMessage error: peer.SendCultNet(error); break;
|
|
||||||
case CultNetHelloMessage hello: peer.SendCultNet(hello); break;
|
|
||||||
default: throw new ArgumentException($"{message.GetType().Name} is not a write answer.", nameof(message));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// A refusal: error.v1 carrying the write's id for a receipt-capable connection, the v0 error for any other.
|
|
||||||
// An empty or blank schemaId or recordKey names no record: refused as a frame that does not read, exactly as the Rust
|
|
||||||
// server's decoder refuses it (write-receipt.md, "Required fields"), never handed to the store.
|
|
||||||
private static bool IsUnreadableWriteTarget(string? schemaId, string? recordKey) =>
|
|
||||||
string.IsNullOrWhiteSpace(schemaId) || string.IsNullOrWhiteSpace(recordKey);
|
|
||||||
|
|
||||||
private static CultNetErrorMessage UnreadableWriteTarget() =>
|
|
||||||
CultNetErrorMessage.ForMessageInvalid("message", "the message could not be read");
|
|
||||||
|
|
||||||
private static void Refuse(CultNetServerPeer peer, CultNetReceiptedWrite? write, CultNetErrorMessage error)
|
|
||||||
{
|
|
||||||
if (write != null) write.Refused(error);
|
|
||||||
else peer.SendCultNet(error);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Rule 6: a forward is answered with what the primary answered, under the original id. A refusal the primary sent is
|
|
||||||
// relayed; silence or any other failure relays nothing, so the client settles it unconfirmed.
|
|
||||||
private void RelayForwardFailure(CultNetReceiptedWrite write, Exception failure)
|
|
||||||
{
|
|
||||||
if (failure is CultNetWriteRefusedException refused)
|
|
||||||
{
|
|
||||||
write.Refused(refused.Refusal);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
_server.Logger.LogWarning($"CultNet forwarded write was not answered by its primary: {failure.Message}");
|
|
||||||
// Only a forward that provably never left (not sent) may be forwarded again. Every other failure, silence or not, is
|
|
||||||
// unconfirmed: the primary may have applied it, so the id is never forwarded again on this session.
|
|
||||||
if (failure is CultNetWriteNotSentException) write.NotSent();
|
|
||||||
else write.LeftSilent();
|
|
||||||
}
|
|
||||||
|
|
||||||
private async Task HandlePutAsync(CultNetDocumentPutRawMessage message, CultNetServerPeer peer)
|
private async Task HandlePutAsync(CultNetDocumentPutRawMessage message, CultNetServerPeer peer)
|
||||||
{
|
{
|
||||||
var write = BeginReceipted(peer, "put", message.MessageId, message.Document?.SchemaId, message.Document?.RecordKey, message.Document?.Payload);
|
|
||||||
var idRefusal = write?.IdRefusal;
|
|
||||||
if (idRefusal != null)
|
|
||||||
{
|
|
||||||
write!.Refused(idRefusal);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
var missing = message.Document == null ? "document" : message.Document.SchemaId == null ? "schemaId" : null;
|
|
||||||
if (missing != null)
|
|
||||||
{
|
|
||||||
Refuse(peer, write, CultNetErrorMessage.ForMessageInvalid(missing, $"{missing} is required"));
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (IsUnreadableWriteTarget(message.Document!.SchemaId, message.Document.RecordKey))
|
|
||||||
{
|
|
||||||
Refuse(peer, write, UnreadableWriteTarget());
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (write != null && !write.Begin()) return;
|
|
||||||
|
|
||||||
var authorize = Authorize(peer, CultNetRemoteWriteOperation.Put, message.ShardId, message.ShardEpoch);
|
|
||||||
try
|
try
|
||||||
{
|
{
|
||||||
await _database.ApplyPutAsync(message, authorize).ConfigureAwait(false);
|
await _database.ApplyPutAsync(message, Authorize(peer, CultNetRemoteWriteOperation.Put, message.ShardId, message.ShardEpoch))
|
||||||
write?.Admitted();
|
.ConfigureAwait(false);
|
||||||
}
|
}
|
||||||
catch (CultNetRemoteWriteRefusedException ex)
|
catch (CultNetRemoteWriteRefusedException ex)
|
||||||
{
|
{
|
||||||
_server.Logger.LogWarning($"CultNet raw put refused: {ex.Message}");
|
_server.Logger.LogWarning($"CultNet raw put refused: {ex.Message}");
|
||||||
Refuse(peer, write, CultNetErrorMessage.ForRemoteWriteRefused(ex.Request, ex.Reason));
|
peer.SendCultNet(CultNetErrorMessage.ForRemoteWriteRefused(ex.Request, ex.Reason));
|
||||||
}
|
}
|
||||||
catch (CultNetShardAuthorityException ex)
|
catch (CultNetShardAuthorityException ex)
|
||||||
{
|
{
|
||||||
bool forwarded;
|
if (!await TryForwardPutAsync(ex, message).ConfigureAwait(false))
|
||||||
try
|
|
||||||
{
|
|
||||||
forwarded = await TryForwardPutAsync(ex, message).ConfigureAwait(false);
|
|
||||||
}
|
|
||||||
catch (CultNetWriteUnconfirmedException) when (write == null)
|
|
||||||
{
|
|
||||||
// A peer that did not opt in is told nothing of a forward its primary left unanswered.
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
catch (Exception failure) when (write != null)
|
|
||||||
{
|
|
||||||
RelayForwardFailure(write, failure);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (forwarded)
|
|
||||||
{
|
|
||||||
write?.Admitted();
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
{
|
||||||
_server.Logger.LogError($"CultNet raw put authority failed: {ex.Message}");
|
_server.Logger.LogError($"CultNet raw put authority failed: {ex.Message}");
|
||||||
Refuse(peer, write, CreateRoutingError(ex));
|
peer.SendCultNet(CreateRoutingError(ex));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
catch (CultNetUnownedSchemaException ex)
|
catch (CultNetUnownedSchemaException ex)
|
||||||
{
|
{
|
||||||
_server.Logger.LogWarning($"CultNet raw put refused: {ex.Message}");
|
_server.Logger.LogWarning($"CultNet raw put refused: {ex.Message}");
|
||||||
Refuse(peer, write, CultNetErrorMessage.ForUnownedSchema(ex));
|
peer.SendCultNet(CultNetErrorMessage.ForUnownedSchema(ex));
|
||||||
}
|
}
|
||||||
catch (Exception ex) when (CommittedWithLogFailure(ex))
|
catch (Exception ex) when (CommittedWithLogFailure(ex))
|
||||||
{
|
{
|
||||||
// The write committed and was published; only its shard log failed, so the peer is not told it was refused.
|
// The write committed and was published; only its shard log failed, so the peer is not told it was refused.
|
||||||
_server.Logger.LogWarning($"CultNet raw put committed but its shard log failed: {ex.Message}");
|
_server.Logger.LogWarning($"CultNet raw put committed but its shard log failed: {ex.Message}");
|
||||||
write?.Admitted();
|
|
||||||
}
|
}
|
||||||
catch (Exception ex)
|
catch (Exception ex)
|
||||||
{
|
{
|
||||||
_server.Logger.LogError($"CultNet raw put failed: {ex.Message}");
|
_server.Logger.LogError($"CultNet raw put failed: {ex.Message}");
|
||||||
Refuse(peer, write, new CultNetErrorMessage { Error = CultNetWriteReceiptSession.WriteFailedText });
|
peer.SendCultNet(new CultNetErrorMessage { Error = ex.Message });
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private async Task HandleDeleteAsync(CultNetDocumentDeleteMessage message, CultNetServerPeer peer)
|
private async Task HandleDeleteAsync(CultNetDocumentDeleteMessage message, CultNetServerPeer peer)
|
||||||
{
|
{
|
||||||
var write = BeginReceipted(peer, "delete", message.MessageId, message.SchemaId, message.RecordKey, null);
|
|
||||||
var idRefusal = write?.IdRefusal;
|
|
||||||
if (idRefusal != null)
|
|
||||||
{
|
|
||||||
write!.Refused(idRefusal);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (message.SchemaId == null)
|
|
||||||
{
|
|
||||||
Refuse(peer, write, CultNetErrorMessage.ForMessageInvalid("schemaId", "schemaId is required"));
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (IsUnreadableWriteTarget(message.SchemaId, message.RecordKey))
|
|
||||||
{
|
|
||||||
Refuse(peer, write, UnreadableWriteTarget());
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (write != null && !write.Begin()) return;
|
|
||||||
|
|
||||||
var authorize = Authorize(peer, CultNetRemoteWriteOperation.Delete, message.ShardId, message.ShardEpoch);
|
|
||||||
try
|
try
|
||||||
{
|
{
|
||||||
await _database.ApplyDeleteAsync(message, authorize).ConfigureAwait(false);
|
await _database.ApplyDeleteAsync(message, Authorize(peer, CultNetRemoteWriteOperation.Delete, message.ShardId, message.ShardEpoch))
|
||||||
write?.Admitted();
|
.ConfigureAwait(false);
|
||||||
}
|
}
|
||||||
catch (CultNetRemoteWriteRefusedException ex)
|
catch (CultNetRemoteWriteRefusedException ex)
|
||||||
{
|
{
|
||||||
_server.Logger.LogWarning($"CultNet raw delete refused: {ex.Message}");
|
_server.Logger.LogWarning($"CultNet raw delete refused: {ex.Message}");
|
||||||
Refuse(peer, write, CultNetErrorMessage.ForRemoteWriteRefused(ex.Request, ex.Reason));
|
peer.SendCultNet(CultNetErrorMessage.ForRemoteWriteRefused(ex.Request, ex.Reason));
|
||||||
}
|
}
|
||||||
catch (CultNetShardAuthorityException ex)
|
catch (CultNetShardAuthorityException ex)
|
||||||
{
|
{
|
||||||
bool forwarded;
|
if (!await TryForwardDeleteAsync(ex, message).ConfigureAwait(false))
|
||||||
try
|
|
||||||
{
|
{
|
||||||
forwarded = await TryForwardDeleteAsync(ex, message).ConfigureAwait(false);
|
peer.SendCultNet(CreateRoutingError(ex));
|
||||||
}
|
|
||||||
catch (CultNetWriteUnconfirmedException) when (write == null)
|
|
||||||
{
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
catch (Exception failure) when (write != null)
|
|
||||||
{
|
|
||||||
RelayForwardFailure(write, failure);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (forwarded)
|
|
||||||
{
|
|
||||||
write?.Admitted();
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
Refuse(peer, write, CreateRoutingError(ex));
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
catch (CultNetUnownedSchemaException ex)
|
catch (CultNetUnownedSchemaException ex)
|
||||||
{
|
{
|
||||||
_server.Logger.LogWarning($"CultNet raw delete refused: {ex.Message}");
|
_server.Logger.LogWarning($"CultNet raw delete refused: {ex.Message}");
|
||||||
Refuse(peer, write, CultNetErrorMessage.ForUnownedSchema(ex));
|
peer.SendCultNet(CultNetErrorMessage.ForUnownedSchema(ex));
|
||||||
}
|
}
|
||||||
catch (Exception ex) when (CommittedWithLogFailure(ex))
|
catch (Exception ex) when (CommittedWithLogFailure(ex))
|
||||||
{
|
{
|
||||||
_server.Logger.LogWarning($"CultNet raw delete committed but its shard log failed: {ex.Message}");
|
_server.Logger.LogWarning($"CultNet raw delete committed but its shard log failed: {ex.Message}");
|
||||||
write?.Admitted();
|
|
||||||
}
|
}
|
||||||
catch (Exception ex)
|
catch (Exception ex)
|
||||||
{
|
{
|
||||||
Refuse(peer, write, new CultNetErrorMessage { Error = CultNetWriteReceiptSession.WriteFailedText });
|
peer.SendCultNet(new CultNetErrorMessage { Error = ex.Message });
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -775,7 +588,7 @@ namespace GameCult.Networking
|
||||||
var refusedKey = change.GetType().GetProperty("Key")?.GetValue(change) is CultRecordKey changed ? changed.Value : string.Empty;
|
var refusedKey = change.GetType().GetProperty("Key")?.GetValue(change) is CultRecordKey changed ? changed.Value : string.Empty;
|
||||||
lock (refused)
|
lock (refused)
|
||||||
refused.Add(refusedKey);
|
refused.Add(refusedKey);
|
||||||
sendError(new CultNetErrorMessage { Error = "the record is a variant CultNet cannot carry" });
|
sendError(new CultNetErrorMessage { Error = refusal.Message });
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -853,14 +666,11 @@ namespace GameCult.Networking
|
||||||
exception is CultNetShardLogException ||
|
exception is CultNetShardLogException ||
|
||||||
exception is AggregateException aggregate && aggregate.Flatten().InnerExceptions.Any(inner => inner is CultNetShardLogException);
|
exception is AggregateException aggregate && aggregate.Flatten().InnerExceptions.Any(inner => inner is CultNetShardLogException);
|
||||||
|
|
||||||
// Fixed text: the routing refusal never carries an exception's own message (the shard and reason travel in the hint).
|
|
||||||
internal const string RoutingRefusalText = "the write belongs to another shard primary";
|
|
||||||
|
|
||||||
private static CultNetErrorMessage CreateRoutingError(CultNetShardAuthorityException exception)
|
private static CultNetErrorMessage CreateRoutingError(CultNetShardAuthorityException exception)
|
||||||
{
|
{
|
||||||
return new CultNetErrorMessage
|
return new CultNetErrorMessage
|
||||||
{
|
{
|
||||||
Error = RoutingRefusalText,
|
Error = exception.Message,
|
||||||
RoutingHint = new CultNetShardRoutingHint
|
RoutingHint = new CultNetShardRoutingHint
|
||||||
{
|
{
|
||||||
Reason = exception.Reason,
|
Reason = exception.Reason,
|
||||||
|
|
|
||||||
|
|
@ -27,8 +27,7 @@ namespace GameCult.Networking
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Sends one schema-v0 message through the transport. Fire-and-forget: an ack or a return is not admission;
|
/// Sends one schema-v0 message through the transport. Fire-and-forget: an ack or a return is not admission;
|
||||||
/// read the result frame (<see cref="CultNetWriteCompletion"/>). Throws <see cref="CultNetWriteNotSentException"/> only
|
/// read the result frame (<see cref="CultNetWriteCompletion"/>).
|
||||||
/// when it can prove no byte was written; any other exception leaves the send ambiguous and a forwarded write unconfirmed.
|
|
||||||
/// </summary>
|
/// </summary>
|
||||||
void SendCultNet<T>(T message)
|
void SendCultNet<T>(T message)
|
||||||
where T : ICultNetSchemaMessage;
|
where T : ICultNetSchemaMessage;
|
||||||
|
|
|
||||||
|
|
@ -53,8 +53,6 @@ namespace GameCult.Networking
|
||||||
CultNetSchemaVersions.Verify => Deserialize<CultNetVerifyMessage>(payload),
|
CultNetSchemaVersions.Verify => Deserialize<CultNetVerifyMessage>(payload),
|
||||||
CultNetSchemaVersions.LoginSuccess => Deserialize<CultNetLoginSuccessMessage>(payload),
|
CultNetSchemaVersions.LoginSuccess => Deserialize<CultNetLoginSuccessMessage>(payload),
|
||||||
CultNetSchemaVersions.Error => Deserialize<CultNetErrorMessage>(payload),
|
CultNetSchemaVersions.Error => Deserialize<CultNetErrorMessage>(payload),
|
||||||
CultNetSchemaVersions.ErrorV1 => Deserialize<CultNetErrorV1Message>(payload),
|
|
||||||
CultNetSchemaVersions.WriteAdmitted => Deserialize<CultNetWriteAdmittedMessage>(payload),
|
|
||||||
CultNetSchemaVersions.SampleChangeName => Deserialize<CultNetSampleChangeNameMessage>(payload),
|
CultNetSchemaVersions.SampleChangeName => Deserialize<CultNetSampleChangeNameMessage>(payload),
|
||||||
CultNetSchemaVersions.SampleChat => Deserialize<CultNetSampleChatMessage>(payload),
|
CultNetSchemaVersions.SampleChat => Deserialize<CultNetSampleChatMessage>(payload),
|
||||||
CultNetSchemaVersions.OperationRequest => Deserialize<CultNetOperationRequestMessage>(payload),
|
CultNetSchemaVersions.OperationRequest => Deserialize<CultNetOperationRequestMessage>(payload),
|
||||||
|
|
|
||||||
|
|
@ -48,14 +48,6 @@ namespace GameCult.Networking
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public const string Error = "cultnet.error.v0";
|
public const string Error = "cultnet.error.v0";
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// error v1 contract identifier: error v0 plus the id of the request it answers (write-receipt.md).
|
|
||||||
/// </summary>
|
|
||||||
public const string ErrorV1 = "cultnet.error.v1";
|
|
||||||
/// <summary>
|
|
||||||
/// write admitted receipt contract identifier (write-receipt.md).
|
|
||||||
/// </summary>
|
|
||||||
public const string WriteAdmitted = "cultnet.write_admitted.v0";
|
|
||||||
/// <summary>
|
|
||||||
/// sample change name contract identifier.
|
/// sample change name contract identifier.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public const string SampleChangeName = "cultnet.sample.change_name.v0";
|
public const string SampleChangeName = "cultnet.sample.change_name.v0";
|
||||||
|
|
@ -546,7 +538,7 @@ namespace GameCult.Networking
|
||||||
public static CultNetErrorMessage ForUnownedSchema(CultNetUnownedSchemaException ex) =>
|
public static CultNetErrorMessage ForUnownedSchema(CultNetUnownedSchemaException ex) =>
|
||||||
new CultNetErrorMessage
|
new CultNetErrorMessage
|
||||||
{
|
{
|
||||||
Error = "unowned_schema: no shard owns the schema and key",
|
Error = $"unowned_schema: {ex.Message}",
|
||||||
Code = "unowned_schema",
|
Code = "unowned_schema",
|
||||||
Details = new CultNetErrorDetails { Field = "schemaId", Value = ex.SchemaId }
|
Details = new CultNetErrorDetails { Field = "schemaId", Value = ex.SchemaId }
|
||||||
};
|
};
|
||||||
|
|
@ -629,80 +621,6 @@ namespace GameCult.Networking
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// <c>cultnet.error.v1</c> (contracts/cultnet/interop/write-receipt.md): the v0 error plus <see cref="MessageId"/>,
|
|
||||||
/// the id of the request it answers. Sent only to a connection that declared the write-receipt capability.
|
|
||||||
/// </summary>
|
|
||||||
[MessagePackObject]
|
|
||||||
public class CultNetErrorV1Message : ICultNetSchemaMessage
|
|
||||||
{
|
|
||||||
/// <summary>Gets or sets the schema version.</summary>
|
|
||||||
[Key("schemaVersion")] public string SchemaVersion { get; set; } = CultNetSchemaVersions.ErrorV1;
|
|
||||||
/// <summary>Gets or sets the error.</summary>
|
|
||||||
[Key("error")] public string Error { get; set; } = string.Empty;
|
|
||||||
/// <summary>Gets or sets optional shard routing details for authority failures.</summary>
|
|
||||||
[Key("routingHint")] public CultNetShardRoutingHint? RoutingHint { get; set; }
|
|
||||||
/// <summary>Gets or sets the machine-readable refusal code (the v0 enum).</summary>
|
|
||||||
[Key("code")] public string? Code { get; set; }
|
|
||||||
/// <summary>Gets or sets the code-specific structured detail.</summary>
|
|
||||||
[Key("details")] public CultNetErrorDetails? Details { get; set; }
|
|
||||||
/// <summary>Gets or sets the id of the request this answers; null only when no id could be read.</summary>
|
|
||||||
[Key("messageId")] public string? MessageId { get; set; }
|
|
||||||
|
|
||||||
/// <summary>Builds the v1 form of <paramref name="error"/> answering <paramref name="messageId"/>.</summary>
|
|
||||||
public static CultNetErrorV1Message From(CultNetErrorMessage error, string? messageId)
|
|
||||||
{
|
|
||||||
if (error == null) throw new ArgumentNullException(nameof(error));
|
|
||||||
return new CultNetErrorV1Message
|
|
||||||
{
|
|
||||||
Error = error.Error,
|
|
||||||
RoutingHint = error.RoutingHint,
|
|
||||||
Code = error.Code,
|
|
||||||
Details = error.Details,
|
|
||||||
MessageId = string.IsNullOrEmpty(messageId) ? null : messageId
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// The refusal of a write a session has no room to remember (write-receipt.md, rule 5): code <c>limit_reached</c>,
|
|
||||||
/// details present and all nil. Exists only as error.v1; v0 has no such code.
|
|
||||||
/// </summary>
|
|
||||||
public static CultNetErrorV1Message LimitReached(string? messageId) => new CultNetErrorV1Message
|
|
||||||
{
|
|
||||||
Error = "limit_reached: the session's remembered-write limit is full",
|
|
||||||
Code = "limit_reached",
|
|
||||||
Details = new CultNetErrorDetails(),
|
|
||||||
MessageId = string.IsNullOrEmpty(messageId) ? null : messageId
|
|
||||||
};
|
|
||||||
|
|
||||||
/// <summary>Gets the v0 form, dropping the id.</summary>
|
|
||||||
public CultNetErrorMessage ToV0() => new CultNetErrorMessage
|
|
||||||
{
|
|
||||||
Error = Error,
|
|
||||||
RoutingHint = RoutingHint,
|
|
||||||
Code = Code,
|
|
||||||
Details = Details
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// <c>cultnet.write_admitted.v0</c>: the receipt for one admitted put or delete, sent after its commit point.
|
|
||||||
/// </summary>
|
|
||||||
[MessagePackObject]
|
|
||||||
public class CultNetWriteAdmittedMessage : ICultNetSchemaMessage
|
|
||||||
{
|
|
||||||
/// <summary>Gets or sets the schema version.</summary>
|
|
||||||
[Key("schemaVersion")] public string SchemaVersion { get; set; } = CultNetSchemaVersions.WriteAdmitted;
|
|
||||||
/// <summary>Gets or sets the messageId of the admitted write, echoed.</summary>
|
|
||||||
[Key("messageId")] public string MessageId { get; set; } = string.Empty;
|
|
||||||
/// <summary>Gets or sets <c>put</c> or <c>delete</c>.</summary>
|
|
||||||
[Key("operation")] public string Operation { get; set; } = string.Empty;
|
|
||||||
/// <summary>Gets or sets the schemaId of the admitted write, echoed.</summary>
|
|
||||||
[Key("schemaId")] public string SchemaId { get; set; } = string.Empty;
|
|
||||||
/// <summary>Gets or sets the recordKey of the admitted write, echoed.</summary>
|
|
||||||
[Key("recordKey")] public string RecordKey { get; set; } = string.Empty;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Code-specific structured detail carried on <see cref="CultNetErrorMessage"/> (R-N). Fields are
|
/// Code-specific structured detail carried on <see cref="CultNetErrorMessage"/> (R-N). Fields are
|
||||||
/// populated only for the code that defines them; every field is otherwise omitted (nil on the wire).
|
/// populated only for the code that defines them; every field is otherwise omitted (nil on the wire).
|
||||||
|
|
|
||||||
|
|
@ -10,16 +10,12 @@ namespace GameCult.Networking
|
||||||
public interface ICultNetShardWriteForwarder
|
public interface ICultNetShardWriteForwarder
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Forwards a raw document put to the shard owner. Completes only when the owner answered that it admitted the write;
|
/// Forwards a raw document put to the shard owner.
|
||||||
/// throws <see cref="CultNetWriteRefusedException"/> when it refused, <see cref="CultNetWriteNotSentException"/> when
|
|
||||||
/// nothing could have reached it (the only failure after which the id may be forwarded again), and any other exception
|
|
||||||
/// when the frame may have gone out and was not answered (unconfirmed, including <see cref="CultNetWriteUnconfirmedException"/>). The server relays to the original peer exactly what the owner answered.
|
|
||||||
/// </summary>
|
/// </summary>
|
||||||
Task ForwardPutAsync(CultNetShardDescriptor shard, CultNetDocumentPutRawMessage message);
|
Task ForwardPutAsync(CultNetShardDescriptor shard, CultNetDocumentPutRawMessage message);
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Forwards a raw document delete to the shard owner; completes, refuses and goes unconfirmed as
|
/// Forwards a raw document delete to the shard owner.
|
||||||
/// <see cref="ForwardPutAsync"/> does.
|
|
||||||
/// </summary>
|
/// </summary>
|
||||||
Task ForwardDeleteAsync(CultNetShardDescriptor shard, CultNetDocumentDeleteMessage message);
|
Task ForwardDeleteAsync(CultNetShardDescriptor shard, CultNetDocumentDeleteMessage message);
|
||||||
}
|
}
|
||||||
|
|
@ -74,12 +70,10 @@ namespace GameCult.Networking
|
||||||
public Func<ICultNetSchemaClient>? CreateClient { get; set; }
|
public Func<ICultNetSchemaClient>? CreateClient { get; set; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets or sets how long the primary has to answer a forwarded write (from the send). Its receipt completes the forward,
|
/// Gets or sets how long after a forwarded write the primary's refusal may still arrive; a refusal fails the
|
||||||
/// its refusal fails it with <see cref="CultNetWriteRefusedException"/>, and silence fails it with
|
/// forward with <see cref="CultNetWriteRefusedException"/>. Defaults to <see cref="CultNetWriteCompletion.DefaultResultWindow"/>.
|
||||||
/// <see cref="CultNetWriteUnconfirmedException"/>. Defaults to <see cref="CultNetWriteCompletion.ReceiptResultWindow"/>; a
|
|
||||||
/// primary that predates write receipts never answers, so forwarding to one is unconfirmed after this window.
|
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public TimeSpan ResultWindow { get; set; } = CultNetWriteCompletion.ReceiptResultWindow;
|
public TimeSpan ResultWindow { get; set; } = CultNetWriteCompletion.DefaultResultWindow;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
|
|
@ -98,29 +92,29 @@ namespace GameCult.Networking
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Forwards a put under its original message id and completes on the primary's result frame: a receipt returns, a refusal
|
/// Forwards a put and completes on the primary's result frame: a refusal throws
|
||||||
/// throws <see cref="CultNetWriteRefusedException"/> and silence throws <see cref="CultNetWriteUnconfirmedException"/>.
|
/// <see cref="CultNetWriteRefusedException"/>, the same failure path as an unreachable primary.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public async Task ForwardPutAsync(CultNetShardDescriptor shard, CultNetDocumentPutRawMessage message)
|
public async Task ForwardPutAsync(CultNetShardDescriptor shard, CultNetDocumentPutRawMessage message)
|
||||||
{
|
{
|
||||||
if (message == null) throw new ArgumentNullException(nameof(message));
|
if (message == null) throw new ArgumentNullException(nameof(message));
|
||||||
if (shard == null) throw new ArgumentNullException(nameof(shard));
|
var endpoint = ResolvePrimaryEndpoint(shard);
|
||||||
message.ShardId ??= shard.ShardId;
|
message.ShardId ??= shard.ShardId;
|
||||||
message.ShardEpoch ??= shard.Epoch;
|
message.ShardEpoch ??= shard.Epoch;
|
||||||
await SendAsync(shard, message, message.MessageId).ConfigureAwait(false);
|
await SendAsync(endpoint, message).ConfigureAwait(false);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Forwards a delete under its original message id; completes, refuses and goes unconfirmed as
|
/// Forwards a delete and completes on the primary's result frame: a refusal throws
|
||||||
/// <see cref="ForwardPutAsync"/> does.
|
/// <see cref="CultNetWriteRefusedException"/>.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public async Task ForwardDeleteAsync(CultNetShardDescriptor shard, CultNetDocumentDeleteMessage message)
|
public async Task ForwardDeleteAsync(CultNetShardDescriptor shard, CultNetDocumentDeleteMessage message)
|
||||||
{
|
{
|
||||||
if (message == null) throw new ArgumentNullException(nameof(message));
|
if (message == null) throw new ArgumentNullException(nameof(message));
|
||||||
if (shard == null) throw new ArgumentNullException(nameof(shard));
|
var endpoint = ResolvePrimaryEndpoint(shard);
|
||||||
message.ShardId ??= shard.ShardId;
|
message.ShardId ??= shard.ShardId;
|
||||||
message.ShardEpoch ??= shard.Epoch;
|
message.ShardEpoch ??= shard.Epoch;
|
||||||
await SendAsync(shard, message, message.MessageId).ConfigureAwait(false);
|
await SendAsync(endpoint, message).ConfigureAwait(false);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
|
|
@ -144,50 +138,19 @@ namespace GameCult.Networking
|
||||||
return (uri.Host, uri.IsDefaultPort ? 3075 : uri.Port);
|
return (uri.Host, uri.IsDefaultPort ? 3075 : uri.Port);
|
||||||
}
|
}
|
||||||
|
|
||||||
// The write frame has not been handed to the transport until this returns: any failure here is CultNetWriteNotSentException,
|
private async Task SendAsync<T>(string endpoint, T message) where T : ICultNetSchemaMessage
|
||||||
// the one failure the caller may retry under the same id.
|
|
||||||
private async Task<ICultNetSchemaClient> ConnectBeforeSendAsync(CultNetShardDescriptor shard, string messageId)
|
|
||||||
{
|
{
|
||||||
ICultNetSchemaClient? client = null;
|
var (host, port) = ParseEndpoint(endpoint);
|
||||||
try
|
using var client = CreateClient(endpoint);
|
||||||
{
|
client.Connect(host, port);
|
||||||
var endpoint = ResolvePrimaryEndpoint(shard);
|
await WaitForConnectionAsync(client, endpoint).ConfigureAwait(false);
|
||||||
var (host, port) = ParseEndpoint(endpoint);
|
await CultNetWriteCompletion.SendAndAwaitResultAsync(
|
||||||
client = CreateClient(endpoint);
|
refuse =>
|
||||||
client.Connect(host, port);
|
|
||||||
await WaitForConnectionAsync(client, endpoint).ConfigureAwait(false);
|
|
||||||
// The hello comes first on the ordered schema channel: it opts this connection in to the primary's receipts.
|
|
||||||
client.SendCultNet(new CultNetHelloMessage
|
|
||||||
{
|
{
|
||||||
RuntimeId = "gamecult-networking-shard-forwarder",
|
|
||||||
RuntimeKind = "dotnet",
|
|
||||||
SupportedMessageVersions = [CultNetSchemaVersions.WriteAdmitted, CultNetSchemaVersions.ErrorV1]
|
|
||||||
});
|
|
||||||
return client;
|
|
||||||
}
|
|
||||||
catch (Exception failure)
|
|
||||||
{
|
|
||||||
client?.Dispose();
|
|
||||||
if (failure is CultNetWriteNotSentException) throw;
|
|
||||||
throw new CultNetWriteNotSentException(messageId, failure);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private async Task SendAsync<T>(CultNetShardDescriptor shard, T message, string messageId) where T : ICultNetSchemaMessage
|
|
||||||
{
|
|
||||||
using var client = await ConnectBeforeSendAsync(shard, messageId).ConfigureAwait(false);
|
|
||||||
// From the write's send on, every failure (timeout, reset, silence, an exception from the send itself) propagates as it
|
|
||||||
// is: the frame may have gone out, so the caller treats it as unconfirmed.
|
|
||||||
await CultNetWriteCompletion.SendAndAwaitReceiptAsync(
|
|
||||||
(admitted, refuse, refuseV1) =>
|
|
||||||
{
|
|
||||||
client.OnCultNet(admitted);
|
|
||||||
client.OnCultNet(refuse);
|
client.OnCultNet(refuse);
|
||||||
client.OnCultNet(refuseV1);
|
|
||||||
return null;
|
return null;
|
||||||
},
|
},
|
||||||
() => client.SendCultNet(message),
|
() => client.SendCultNet(message),
|
||||||
messageId,
|
|
||||||
_options.ResultWindow).ConfigureAwait(false);
|
_options.ResultWindow).ConfigureAwait(false);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -3533,8 +3533,7 @@ namespace GameCult.Networking
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public sealed class LiteNetLibTransportConnection
|
public sealed class LiteNetLibTransportConnection
|
||||||
{
|
{
|
||||||
private readonly Action<byte[]>? _deliver;
|
private readonly NetPeer? _peer;
|
||||||
private readonly Action? _end;
|
|
||||||
private readonly CultNetTransportStats _stats = new CultNetTransportStats();
|
private readonly CultNetTransportStats _stats = new CultNetTransportStats();
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
|
|
@ -3542,99 +3541,10 @@ namespace GameCult.Networking
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public LiteNetLibTransportConnection(NetPeer peer, CultNetTransportProfile? profile = null)
|
public LiteNetLibTransportConnection(NetPeer peer, CultNetTransportProfile? profile = null)
|
||||||
{
|
{
|
||||||
if (peer == null) throw new ArgumentNullException(nameof(peer));
|
_peer = peer ?? throw new ArgumentNullException(nameof(peer));
|
||||||
_deliver = payload => peer.Send(payload, DeliveryMethod.ReliableOrdered);
|
|
||||||
_end = peer.Disconnect;
|
|
||||||
Profile = profile ?? CultNetTransportProfiles.CreateLiteNetLib("csharp-litenetlib-peer");
|
Profile = profile ?? CultNetTransportProfiles.CreateLiteNetLib("csharp-litenetlib-peer");
|
||||||
}
|
}
|
||||||
|
|
||||||
// The mock point for what leaves the connection: the peer's reliable ordered send.
|
|
||||||
internal LiteNetLibTransportConnection(Action<byte[]> deliver, Action? end = null)
|
|
||||||
{
|
|
||||||
_deliver = deliver ?? throw new ArgumentNullException(nameof(deliver));
|
|
||||||
_end = end;
|
|
||||||
Profile = CultNetTransportProfiles.CreateLiteNetLib("csharp-litenetlib-peer");
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Ends the connection. A write that can be neither answered nor refused is answered by this goodbye: the peer sees
|
|
||||||
/// its session end and settles the write as unconfirmed (<c>session_ended</c>), never as silence.
|
|
||||||
/// </summary>
|
|
||||||
internal void End() => _end?.Invoke();
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Answers a schema frame that did not decode with a <c>message_invalid</c> error.v1 naming its id when it holds one;
|
|
||||||
/// when that answer cannot be sent the connection ends instead.
|
|
||||||
/// </summary>
|
|
||||||
internal void AnswerUnreadableSchemaFrame(byte[] payload)
|
|
||||||
{
|
|
||||||
try
|
|
||||||
{
|
|
||||||
SendSchema(CultNetErrorV1Message.From(
|
|
||||||
CultNetErrorMessage.ForMessageInvalid("message", "the message could not be read"),
|
|
||||||
CultNetReadableMessageId.From(payload)));
|
|
||||||
}
|
|
||||||
catch (Exception)
|
|
||||||
{
|
|
||||||
End();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// A put or delete that arrived on an unreliable or sequenced channel of a receipt session (write-receipt.md, Reliable channel only):
|
|
||||||
/// answered <c>message_invalid</c>, details <c>channel</c>, fixed text, carrying the write's id, and not applied. True when
|
|
||||||
/// the frame was such a write and has been answered here.
|
|
||||||
/// </summary>
|
|
||||||
internal bool RefuseUnreliableWrite(ICultNetSchemaMessage message, DeliveryMethod method)
|
|
||||||
{
|
|
||||||
if (WriteReceipts == null) return false;
|
|
||||||
if (method is DeliveryMethod.ReliableOrdered or DeliveryMethod.ReliableUnordered) return false;
|
|
||||||
var messageId = message switch
|
|
||||||
{
|
|
||||||
CultNetDocumentPutRawMessage put => put.MessageId,
|
|
||||||
CultNetDocumentDeleteMessage delete => delete.MessageId,
|
|
||||||
_ => null
|
|
||||||
};
|
|
||||||
if (messageId == null && message is not (CultNetDocumentPutRawMessage or CultNetDocumentDeleteMessage)) return false;
|
|
||||||
try
|
|
||||||
{
|
|
||||||
SendSchema(CultNetErrorV1Message.From(
|
|
||||||
CultNetErrorMessage.ForMessageInvalid("channel", "receipt sessions require the reliable channel"), messageId));
|
|
||||||
}
|
|
||||||
catch (Exception)
|
|
||||||
{
|
|
||||||
End();
|
|
||||||
}
|
|
||||||
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
private readonly object _writeFramingGate = new();
|
|
||||||
private bool _writeFramingSettled;
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// The write-receipt state of a connection that opted in (write-receipt.md); null for every other connection, which is
|
|
||||||
/// answered exactly as before.
|
|
||||||
/// </summary>
|
|
||||||
internal CultNetWriteReceiptSession? WriteReceipts { get; private set; }
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Decides this connection's write framing once: by its first hello, or by its first write if no hello came first. A
|
|
||||||
/// later hello changes nothing. The capability changes framing only; it never authorizes. Returns true when this call
|
|
||||||
/// opted the connection in.
|
|
||||||
/// </summary>
|
|
||||||
internal bool SettleWriteFraming(CultNetHelloMessage? hello)
|
|
||||||
{
|
|
||||||
lock (_writeFramingGate)
|
|
||||||
{
|
|
||||||
if (_writeFramingSettled) return false;
|
|
||||||
_writeFramingSettled = true;
|
|
||||||
if (hello == null || !CultNetWriteReceiptCapability.Declares(hello)) return false;
|
|
||||||
WriteReceipts = new CultNetWriteReceiptSession();
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Initializes a receive-only channel-aware adapter for LiteNetLib payload classification.
|
/// Initializes a receive-only channel-aware adapter for LiteNetLib payload classification.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
|
@ -3670,14 +3580,14 @@ namespace GameCult.Networking
|
||||||
public void Send(string channelId, byte[] payload)
|
public void Send(string channelId, byte[] payload)
|
||||||
{
|
{
|
||||||
if (payload == null) throw new ArgumentNullException(nameof(payload));
|
if (payload == null) throw new ArgumentNullException(nameof(payload));
|
||||||
if (_deliver == null) throw new InvalidOperationException("A LiteNetLib peer is required to send through this transport.");
|
if (_peer == null) throw new InvalidOperationException("A LiteNetLib peer is required to send through this transport.");
|
||||||
if (!string.Equals(channelId, "schema", StringComparison.Ordinal)
|
if (!string.Equals(channelId, "schema", StringComparison.Ordinal)
|
||||||
&& !string.Equals(channelId, "legacy", StringComparison.Ordinal))
|
&& !string.Equals(channelId, "legacy", StringComparison.Ordinal))
|
||||||
{
|
{
|
||||||
throw new InvalidOperationException($"litenetlib transport only supports schema and legacy channels, got \"{channelId}\".");
|
throw new InvalidOperationException($"litenetlib transport only supports schema and legacy channels, got \"{channelId}\".");
|
||||||
}
|
}
|
||||||
|
|
||||||
_deliver(payload);
|
_peer.Send(payload, DeliveryMethod.ReliableOrdered);
|
||||||
_stats.BytesSent += payload.Length;
|
_stats.BytesSent += payload.Length;
|
||||||
_stats.FramesSent++;
|
_stats.FramesSent++;
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -24,40 +24,6 @@ namespace GameCult.Networking
|
||||||
public CultNetErrorMessage Refusal { get; }
|
public CultNetErrorMessage Refusal { get; }
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// A write nothing answered within its window: neither admitted nor refused (write-receipt.md, "unconfirmed").
|
|
||||||
/// </summary>
|
|
||||||
public sealed class CultNetWriteUnconfirmedException : Exception
|
|
||||||
{
|
|
||||||
/// <summary>Creates the exception for the write <paramref name="messageId"/>.</summary>
|
|
||||||
public CultNetWriteUnconfirmedException(string messageId)
|
|
||||||
: base($"No admission or refusal arrived for write '{messageId}'.")
|
|
||||||
{
|
|
||||||
MessageId = messageId;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>Gets the id of the unconfirmed write.</summary>
|
|
||||||
public string MessageId { get; }
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// A forwarded write that provably never left this process: the connection failed, or the send failed before any byte was
|
|
||||||
/// written. It is the only forwarding failure after which the same id may be forwarded again. A send port that cannot prove
|
|
||||||
/// nothing was written must not throw this; every other failure of a forward is unconfirmed.
|
|
||||||
/// </summary>
|
|
||||||
public sealed class CultNetWriteNotSentException : Exception
|
|
||||||
{
|
|
||||||
/// <summary>Creates the exception for the write <paramref name="messageId"/>; <paramref name="cause"/> is for logs only.</summary>
|
|
||||||
public CultNetWriteNotSentException(string messageId, Exception? cause = null)
|
|
||||||
: base($"Write '{messageId}' was not sent.", cause)
|
|
||||||
{
|
|
||||||
MessageId = messageId;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>Gets the id of the write that was not sent.</summary>
|
|
||||||
public string MessageId { get; }
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Completes a write on the peer's result frame, never on a send's return or a transport acknowledgement:
|
/// Completes a write on the peer's result frame, never on a send's return or a transport acknowledgement:
|
||||||
/// an ack proves delivery, not admission.
|
/// an ack proves delivery, not admission.
|
||||||
|
|
@ -67,49 +33,6 @@ namespace GameCult.Networking
|
||||||
/// <summary>How long after a send a refusal may still arrive when the caller names no window.</summary>
|
/// <summary>How long after a send a refusal may still arrive when the caller names no window.</summary>
|
||||||
public static readonly TimeSpan DefaultResultWindow = TimeSpan.FromMilliseconds(500);
|
public static readonly TimeSpan DefaultResultWindow = TimeSpan.FromMilliseconds(500);
|
||||||
|
|
||||||
/// <summary>How long a receipt-capable peer has to answer a write (write-receipt.md, <c>RECEIPT_RESULT_WINDOW_MS</c>).</summary>
|
|
||||||
public static readonly TimeSpan ReceiptResultWindow = TimeSpan.FromMilliseconds(5000);
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Sends one write to a receipt-capable peer and waits <paramref name="resultWindow"/> for its answer: a
|
|
||||||
/// <c>write_admitted</c> naming <paramref name="messageId"/> returns, an <c>error.v1</c> naming it throws
|
|
||||||
/// <see cref="CultNetWriteRefusedException"/>, and an id-less error (v0, or v1 with no id) is attributed to this write
|
|
||||||
/// because it is the only one in flight on the connection. Silence throws <see cref="CultNetWriteUnconfirmedException"/>.
|
|
||||||
/// </summary>
|
|
||||||
public static async Task SendAndAwaitReceiptAsync(
|
|
||||||
Func<Action<CultNetWriteAdmittedMessage>, Action<CultNetErrorMessage>, Action<CultNetErrorV1Message>, IDisposable?> subscribe,
|
|
||||||
Action send,
|
|
||||||
string messageId,
|
|
||||||
TimeSpan resultWindow,
|
|
||||||
CancellationToken cancellationToken = default)
|
|
||||||
{
|
|
||||||
if (subscribe == null) throw new ArgumentNullException(nameof(subscribe));
|
|
||||||
if (send == null) throw new ArgumentNullException(nameof(send));
|
|
||||||
var answer = new TaskCompletionSource<CultNetErrorMessage?>(TaskCreationOptions.RunContinuationsAsynchronously);
|
|
||||||
using var registration = subscribe(
|
|
||||||
admitted =>
|
|
||||||
{
|
|
||||||
if (string.Equals(admitted.MessageId, messageId, StringComparison.Ordinal)) answer.TrySetResult(null);
|
|
||||||
},
|
|
||||||
error => answer.TrySetResult(error),
|
|
||||||
error =>
|
|
||||||
{
|
|
||||||
if (error.MessageId == null || string.Equals(error.MessageId, messageId, StringComparison.Ordinal))
|
|
||||||
answer.TrySetResult(error.ToV0());
|
|
||||||
});
|
|
||||||
send();
|
|
||||||
var window = Task.Delay(resultWindow, cancellationToken);
|
|
||||||
await Task.WhenAny(answer.Task, window).ConfigureAwait(false);
|
|
||||||
if (!answer.Task.IsCompleted)
|
|
||||||
{
|
|
||||||
await window.ConfigureAwait(false);
|
|
||||||
throw new CultNetWriteUnconfirmedException(messageId);
|
|
||||||
}
|
|
||||||
|
|
||||||
var refusal = await answer.Task.ConfigureAwait(false);
|
|
||||||
if (refusal != null) throw new CultNetWriteRefusedException(refusal);
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Sends one write and waits <paramref name="resultWindow"/> for the peer's answer. A refusal frame rejects with
|
/// Sends one write and waits <paramref name="resultWindow"/> for the peer's answer. A refusal frame rejects with
|
||||||
/// <see cref="CultNetWriteRefusedException"/> whatever its order against the transport acknowledgement. A peer
|
/// <see cref="CultNetWriteRefusedException"/> whatever its order against the transport acknowledgement. A peer
|
||||||
|
|
|
||||||
|
|
@ -1,396 +0,0 @@
|
||||||
using System;
|
|
||||||
using System.Collections.Generic;
|
|
||||||
using System.Security.Cryptography;
|
|
||||||
using GameCult.Caching;
|
|
||||||
using MessagePack;
|
|
||||||
|
|
||||||
namespace GameCult.Networking
|
|
||||||
{
|
|
||||||
/// <summary>
|
|
||||||
/// The content hash a write-receipt server binds to a (peer, messageId) dedupe key
|
|
||||||
/// (contracts/cultnet/interop/write-receipt.md, rule 5).
|
|
||||||
/// </summary>
|
|
||||||
public static class CultNetWriteContentHash
|
|
||||||
{
|
|
||||||
/// <summary>
|
|
||||||
/// SHA-256 of the MessagePack array <c>[operation, schemaId, recordKey, payload]</c>, <c>payload</c> a <c>bin</c>
|
|
||||||
/// for a put and nil for a delete.
|
|
||||||
/// </summary>
|
|
||||||
public static byte[] Compute(string operation, string schemaId, string recordKey, byte[]? payload)
|
|
||||||
{
|
|
||||||
var buffer = new System.Buffers.ArrayBufferWriter<byte>();
|
|
||||||
var writer = new MessagePackWriter(buffer);
|
|
||||||
writer.WriteArrayHeader(4);
|
|
||||||
writer.Write(operation);
|
|
||||||
writer.Write(schemaId);
|
|
||||||
writer.Write(recordKey);
|
|
||||||
if (payload == null) writer.WriteNil();
|
|
||||||
else writer.Write(payload);
|
|
||||||
writer.Flush();
|
|
||||||
using var sha = SHA256.Create();
|
|
||||||
return sha.ComputeHash(buffer.WrittenSpan.ToArray());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Whether a peer's hello opted in to write receipts: it lists both <c>cultnet.write_admitted.v0</c> and
|
|
||||||
/// <c>cultnet.error.v1</c>. The capability changes framing only; it never authorizes.
|
|
||||||
/// </summary>
|
|
||||||
internal static class CultNetWriteReceiptCapability
|
|
||||||
{
|
|
||||||
public static bool Declares(CultNetHelloMessage hello)
|
|
||||||
{
|
|
||||||
var versions = hello.SupportedMessageVersions;
|
|
||||||
return versions != null
|
|
||||||
&& Array.IndexOf(versions, CultNetSchemaVersions.WriteAdmitted) >= 0
|
|
||||||
&& Array.IndexOf(versions, CultNetSchemaVersions.ErrorV1) >= 0;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>A SHA-256 digest held by value: the fixed-size stand-in for an id or a content hash.</summary>
|
|
||||||
internal readonly struct CultNetDigest : IEquatable<CultNetDigest>
|
|
||||||
{
|
|
||||||
private readonly ulong _a, _b, _c, _d;
|
|
||||||
|
|
||||||
private CultNetDigest(ulong a, ulong b, ulong c, ulong d) { _a = a; _b = b; _c = c; _d = d; }
|
|
||||||
|
|
||||||
public static CultNetDigest Of(byte[] bytes)
|
|
||||||
{
|
|
||||||
using var sha = SHA256.Create();
|
|
||||||
var hash = sha.ComputeHash(bytes);
|
|
||||||
return new CultNetDigest(
|
|
||||||
BitConverter.ToUInt64(hash, 0), BitConverter.ToUInt64(hash, 8),
|
|
||||||
BitConverter.ToUInt64(hash, 16), BitConverter.ToUInt64(hash, 24));
|
|
||||||
}
|
|
||||||
|
|
||||||
public bool Equals(CultNetDigest other) => _a == other._a && _b == other._b && _c == other._c && _d == other._d;
|
|
||||||
public override bool Equals(object? obj) => obj is CultNetDigest other && Equals(other);
|
|
||||||
public override int GetHashCode() => unchecked((int)_a ^ (int)(_a >> 32));
|
|
||||||
public static bool operator ==(CultNetDigest left, CultNetDigest right) => left.Equals(right);
|
|
||||||
public static bool operator !=(CultNetDigest left, CultNetDigest right) => !left.Equals(right);
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// What a session keeps of a refusal (write-receipt.md, What is remembered): its code, the field its details name, and its
|
|
||||||
/// routing hint (a shard descriptor the server owns). Never the write's strings or an authority's reason: the replay is built
|
|
||||||
/// from fixed text and the fields of the resend, which carries the same content.
|
|
||||||
/// </summary>
|
|
||||||
internal readonly struct CultNetRememberedRefusal
|
|
||||||
{
|
|
||||||
public string? Code { get; }
|
|
||||||
public bool HasDetails { get; }
|
|
||||||
public string? Field { get; }
|
|
||||||
public CultNetShardRoutingHint? Hint { get; }
|
|
||||||
|
|
||||||
public CultNetRememberedRefusal(string? code, bool hasDetails, string? field, CultNetShardRoutingHint? hint)
|
|
||||||
{
|
|
||||||
Code = code; HasDetails = hasDetails; Field = field; Hint = hint;
|
|
||||||
}
|
|
||||||
|
|
||||||
public static CultNetRememberedRefusal Of(CultNetErrorMessage error) =>
|
|
||||||
new(error.Code, error.Details != null, error.Details?.Field, error.RoutingHint);
|
|
||||||
|
|
||||||
private static string? NullIfEmpty(string value) => value.Length == 0 ? null : value;
|
|
||||||
|
|
||||||
/// <summary>The refusal, in fixed text, naming the write's own record key or schema id where its details do.</summary>
|
|
||||||
public CultNetErrorMessage ToError(string schemaId, string recordKey) => new()
|
|
||||||
{
|
|
||||||
Error = Code switch
|
|
||||||
{
|
|
||||||
"unowned_schema" => "unowned_schema: no shard owns the schema and key",
|
|
||||||
null => Hint != null ? CultNetDatabaseServer.RoutingRefusalText : CultNetWriteReceiptSession.WriteFailedText,
|
|
||||||
_ => Code
|
|
||||||
},
|
|
||||||
Code = Code,
|
|
||||||
RoutingHint = Hint,
|
|
||||||
Details = HasDetails
|
|
||||||
? new CultNetErrorDetails
|
|
||||||
{
|
|
||||||
Field = Field,
|
|
||||||
Value = Field switch { "recordKey" => NullIfEmpty(recordKey), "schemaId" => NullIfEmpty(schemaId), _ => null }
|
|
||||||
}
|
|
||||||
: null
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// One receipt-capable peer's writes: message id to content hash and the answer given, refusals included, so a resend of the
|
|
||||||
/// same content is answered again without being decided again and the same id with other content is refused. Ids and content
|
|
||||||
/// hashes are held as fixed-size digests; the answer is held as its kind (and, for a refusal, its code and the field its details name),
|
|
||||||
/// never the strings of the write.
|
|
||||||
/// </summary>
|
|
||||||
internal sealed class CultNetWriteReceiptSession
|
|
||||||
{
|
|
||||||
/// <summary>The most writes a peer is remembered for, refused ones included; a peer at the limit has new writes refused.</summary>
|
|
||||||
internal const int MaxRememberedWrites = 1024;
|
|
||||||
|
|
||||||
/// <summary>The most ids refused at the limit that are remembered, so their resend is judged the same way.</summary>
|
|
||||||
internal const int MaxRememberedLimitRefusals = 1024;
|
|
||||||
|
|
||||||
/// <summary>The longest messageId a write may carry, in UTF-8 bytes (write-receipt.md, Id size).</summary>
|
|
||||||
internal const int MaxMessageIdBytes = 256;
|
|
||||||
|
|
||||||
/// <summary>What a write is refused with when it failed for a reason no typed refusal names. Never an exception's own text.</summary>
|
|
||||||
internal const string WriteFailedText = "the write could not be applied";
|
|
||||||
|
|
||||||
private readonly object _gate = new();
|
|
||||||
private readonly Dictionary<CultNetDigest, Entry> _writes = new();
|
|
||||||
private readonly Dictionary<CultNetDigest, CultNetDigest> _limitRefusals = new();
|
|
||||||
|
|
||||||
private sealed class Entry
|
|
||||||
{
|
|
||||||
public Entry(CultNetDigest hash) { Hash = hash; }
|
|
||||||
public CultNetDigest Hash { get; set; }
|
|
||||||
public bool Abandoned { get; set; }
|
|
||||||
public bool Admitted { get; set; }
|
|
||||||
public CultNetRememberedRefusal? Refusal { get; set; }
|
|
||||||
}
|
|
||||||
|
|
||||||
public enum Begin { New, ReplayAdmitted, ReplayRefusal, Unanswered, DifferentContent, Full }
|
|
||||||
|
|
||||||
private static CultNetDigest IdDigest(string messageId) => CultNetDigest.Of(System.Text.Encoding.UTF8.GetBytes(messageId));
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Looks <paramref name="messageId"/> up first. An id not seen is claimed for this content (<see cref="Begin.New"/>);
|
|
||||||
/// otherwise the outcome says what already holds it, and <paramref name="refusal"/> is the refusal to repeat.
|
|
||||||
/// </summary>
|
|
||||||
public Begin TryBegin(string messageId, byte[] hash, out CultNetRememberedRefusal? refusal)
|
|
||||||
{
|
|
||||||
var id = IdDigest(messageId);
|
|
||||||
var content = CultNetDigest.Of(hash);
|
|
||||||
lock (_gate)
|
|
||||||
{
|
|
||||||
refusal = null;
|
|
||||||
if (_writes.TryGetValue(id, out var entry))
|
|
||||||
{
|
|
||||||
if (entry.Abandoned)
|
|
||||||
{
|
|
||||||
// Not sent, so judged afresh in the slot it already holds; no slot is ever freed.
|
|
||||||
entry.Abandoned = false;
|
|
||||||
entry.Hash = content;
|
|
||||||
return Begin.New;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (entry.Hash != content) return Begin.DifferentContent;
|
|
||||||
if (entry.Admitted) return Begin.ReplayAdmitted;
|
|
||||||
if (entry.Refusal != null)
|
|
||||||
{
|
|
||||||
refusal = entry.Refusal;
|
|
||||||
return Begin.ReplayRefusal;
|
|
||||||
}
|
|
||||||
|
|
||||||
// No answer yet: the first attempt is still being applied, or its primary left it unanswered for good.
|
|
||||||
return Begin.Unanswered;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (_writes.Count >= MaxRememberedWrites)
|
|
||||||
{
|
|
||||||
if (_limitRefusals.TryGetValue(id, out var refused)) return refused == content ? Begin.Full : Begin.DifferentContent;
|
|
||||||
if (_limitRefusals.Count < MaxRememberedLimitRefusals) _limitRefusals[id] = content;
|
|
||||||
return Begin.Full;
|
|
||||||
}
|
|
||||||
|
|
||||||
_writes[id] = new Entry(content);
|
|
||||||
return Begin.New;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>The write was admitted: remember it so a resend repeats the receipt.</summary>
|
|
||||||
public void Admitted(string messageId)
|
|
||||||
{
|
|
||||||
lock (_gate)
|
|
||||||
{
|
|
||||||
if (_writes.TryGetValue(IdDigest(messageId), out var entry)) entry.Admitted = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>The write was refused: remember the refusal so a resend repeats it.</summary>
|
|
||||||
public void Refused(string messageId, CultNetRememberedRefusal refusal)
|
|
||||||
{
|
|
||||||
lock (_gate)
|
|
||||||
{
|
|
||||||
if (_writes.TryGetValue(IdDigest(messageId), out var entry)) entry.Refusal = refusal;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// The write never reached anyone who could have applied it: a repeat is judged afresh. The entry keeps its slot, so
|
|
||||||
/// forgetting a write never makes room for an id that was refused at the limit.
|
|
||||||
/// </summary>
|
|
||||||
public void Abandoned(string messageId)
|
|
||||||
{
|
|
||||||
lock (_gate)
|
|
||||||
{
|
|
||||||
if (_writes.TryGetValue(IdDigest(messageId), out var entry)) entry.Abandoned = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// The messageId of a schema frame that does not decode (write-receipt.md, rule 3: a refusal carries the write's id whenever
|
|
||||||
/// the frame is readable enough to find it).
|
|
||||||
/// </summary>
|
|
||||||
internal static class CultNetReadableMessageId
|
|
||||||
{
|
|
||||||
/// <summary>The frame's top-level string <c>messageId</c>, or null when the bytes are not a map holding one.</summary>
|
|
||||||
public static string? From(byte[] payload)
|
|
||||||
{
|
|
||||||
try
|
|
||||||
{
|
|
||||||
var reader = new MessagePackReader(payload);
|
|
||||||
var entries = reader.ReadMapHeader();
|
|
||||||
for (var index = 0; index < entries; index++)
|
|
||||||
{
|
|
||||||
var key = reader.NextMessagePackType == MessagePackType.String ? reader.ReadString() : null;
|
|
||||||
if (key == "messageId" && reader.NextMessagePackType == MessagePackType.String)
|
|
||||||
{
|
|
||||||
var id = reader.ReadString();
|
|
||||||
return string.IsNullOrEmpty(id) ? null : id;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (key == null) reader.Skip();
|
|
||||||
reader.Skip();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
catch (Exception)
|
|
||||||
{
|
|
||||||
// Not a readable map: no id.
|
|
||||||
}
|
|
||||||
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// One write on a receipt-capable connection: its dedupe claim and its single answer (write-receipt.md, rules 1 to 5).
|
|
||||||
/// </summary>
|
|
||||||
internal sealed class CultNetReceiptedWrite
|
|
||||||
{
|
|
||||||
private readonly CultNetWriteReceiptSession _session;
|
|
||||||
private readonly Action<ICultNetSchemaMessage> _send;
|
|
||||||
private readonly string _operation;
|
|
||||||
private readonly string _messageId;
|
|
||||||
private readonly string _schemaId;
|
|
||||||
private readonly string _recordKey;
|
|
||||||
private readonly byte[]? _payload;
|
|
||||||
private bool _claimed;
|
|
||||||
private bool _answered;
|
|
||||||
|
|
||||||
public CultNetReceiptedWrite(
|
|
||||||
CultNetWriteReceiptSession session,
|
|
||||||
Action<ICultNetSchemaMessage> send,
|
|
||||||
string operation,
|
|
||||||
string? messageId,
|
|
||||||
string? schemaId,
|
|
||||||
string? recordKey,
|
|
||||||
byte[]? payload)
|
|
||||||
{
|
|
||||||
_session = session;
|
|
||||||
_send = send;
|
|
||||||
_operation = operation;
|
|
||||||
_messageId = messageId ?? string.Empty;
|
|
||||||
_schemaId = schemaId ?? string.Empty;
|
|
||||||
_recordKey = recordKey ?? string.Empty;
|
|
||||||
_payload = payload;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Looks the write's id up before anything else is decided (rule 5). True when the id is new and the write should go on
|
|
||||||
/// to authorization and the commit; false when it was answered here (a replay, a reused id, a full table) or is owed no
|
|
||||||
/// further answer (still in flight, or left silent by its primary).
|
|
||||||
/// </summary>
|
|
||||||
public bool Begin()
|
|
||||||
{
|
|
||||||
var outcome = _session.TryBegin(_messageId, CultNetWriteContentHash.Compute(_operation, _schemaId, _recordKey, _payload), out var refusal);
|
|
||||||
switch (outcome)
|
|
||||||
{
|
|
||||||
case CultNetWriteReceiptSession.Begin.New:
|
|
||||||
_claimed = true;
|
|
||||||
return true;
|
|
||||||
case CultNetWriteReceiptSession.Begin.ReplayAdmitted:
|
|
||||||
_answered = true;
|
|
||||||
_send(AdmittedReceipt());
|
|
||||||
return false;
|
|
||||||
case CultNetWriteReceiptSession.Begin.ReplayRefusal:
|
|
||||||
_answered = true;
|
|
||||||
_send(CultNetErrorV1Message.From(refusal!.Value.ToError(_schemaId, _recordKey), _messageId));
|
|
||||||
return false;
|
|
||||||
case CultNetWriteReceiptSession.Begin.Unanswered:
|
|
||||||
// The first attempt is still being applied and will answer this id, or its primary left it unanswered:
|
|
||||||
// then the claim stays, so the id is never sent again on this session, and the write stays unconfirmed.
|
|
||||||
_answered = true;
|
|
||||||
return false;
|
|
||||||
case CultNetWriteReceiptSession.Begin.DifferentContent:
|
|
||||||
Refused(CultNetErrorMessage.ForMessageInvalid("messageId", "the message id was already used for different content"));
|
|
||||||
return false;
|
|
||||||
default:
|
|
||||||
_answered = true;
|
|
||||||
_send(CultNetErrorV1Message.LimitReached(_messageId));
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private CultNetWriteAdmittedMessage AdmittedReceipt() => new()
|
|
||||||
{
|
|
||||||
MessageId = _messageId,
|
|
||||||
Operation = _operation,
|
|
||||||
SchemaId = _schemaId,
|
|
||||||
RecordKey = _recordKey
|
|
||||||
};
|
|
||||||
|
|
||||||
/// <summary>The write committed: remember the receipt and send it.</summary>
|
|
||||||
public void Admitted()
|
|
||||||
{
|
|
||||||
if (_answered) return;
|
|
||||||
_answered = true;
|
|
||||||
if (_claimed) _session.Admitted(_messageId);
|
|
||||||
_send(AdmittedReceipt());
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>The write was refused: remember the refusal (a resend repeats it) and send its one error.v1.</summary>
|
|
||||||
public void Refused(CultNetErrorMessage error)
|
|
||||||
{
|
|
||||||
if (_answered) return;
|
|
||||||
_answered = true;
|
|
||||||
if (_claimed)
|
|
||||||
{
|
|
||||||
// A remembered refusal is answered from what is remembered, so the replay is the refusal again.
|
|
||||||
var kept = CultNetRememberedRefusal.Of(error);
|
|
||||||
_session.Refused(_messageId, kept);
|
|
||||||
error = kept.ToError(_schemaId, _recordKey);
|
|
||||||
}
|
|
||||||
|
|
||||||
_send(CultNetErrorV1Message.From(error, _messageId));
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// A forward that may have reached its primary and is unconfirmed (silence, reset, timeout, an ambiguous send): no answer is
|
|
||||||
/// owed or possible, and the claim stays so the id is never forwarded again on this session. Sends nothing.
|
|
||||||
/// </summary>
|
|
||||||
public void LeftSilent()
|
|
||||||
{
|
|
||||||
if (_answered) return;
|
|
||||||
_answered = true;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>A forward that was provably not sent (connect failed, or the send failed before any byte was written): forget the claim, send nothing.</summary>
|
|
||||||
public void NotSent()
|
|
||||||
{
|
|
||||||
if (_answered) return;
|
|
||||||
_answered = true;
|
|
||||||
if (_claimed) _session.Abandoned(_messageId);
|
|
||||||
_claimed = false;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Why the write's id cannot be used at all, before anything is remembered: it is missing (refused with no id) or longer
|
|
||||||
/// than <see cref="CultNetWriteReceiptSession.MaxMessageIdBytes"/> UTF-8 bytes. Null when the id is usable.
|
|
||||||
/// </summary>
|
|
||||||
public CultNetErrorMessage? IdRefusal =>
|
|
||||||
_messageId.Length == 0
|
|
||||||
? CultNetErrorMessage.ForMessageInvalid("messageId", "a write needs a messageId")
|
|
||||||
: System.Text.Encoding.UTF8.GetByteCount(_messageId) > CultNetWriteReceiptSession.MaxMessageIdBytes
|
|
||||||
? CultNetErrorMessage.ForMessageInvalid("messageId", "messageId exceeds 256 bytes")
|
|
||||||
: null;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -23,7 +23,7 @@ namespace GameCult.Networking
|
||||||
private const string EmailPattern =
|
private const string EmailPattern =
|
||||||
@"^([0-9a-zA-Z]([\+\-_\.][0-9a-zA-Z]+)*)+@(([0-9a-zA-Z][-\w]*[0-9a-zA-Z]*\.)+[a-zA-Z0-9]{2,17})$";
|
@"^([0-9a-zA-Z]([\+\-_\.][0-9a-zA-Z]+)*)+@(([0-9a-zA-Z][-\w]*[0-9a-zA-Z]*\.)+[a-zA-Z0-9]{2,17})$";
|
||||||
private const string UsernamePattern = @"^[A-Za-z0-9]+(?:[ _-][A-Za-z0-9]+)*$";
|
private const string UsernamePattern = @"^[A-Za-z0-9]+(?:[ _-][A-Za-z0-9]+)*$";
|
||||||
private const int DefaultPort = 3075;
|
private const int ServerPort = 3075;
|
||||||
private const float SessionTimeoutSeconds = 1800; // 30 minutes
|
private const float SessionTimeoutSeconds = 1800; // 30 minutes
|
||||||
private const float SessionRefreshThresholdSeconds = 300; // 5 minutes
|
private const float SessionRefreshThresholdSeconds = 300; // 5 minutes
|
||||||
private const int MaxConnectionAttemptsPerMinute = 30;
|
private const int MaxConnectionAttemptsPerMinute = 30;
|
||||||
|
|
@ -63,12 +63,6 @@ namespace GameCult.Networking
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public bool LogSensitivePayloads { get; set; }
|
public bool LogSensitivePayloads { get; set; }
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets or sets the UDP port <see cref="Start"/> binds (default 3075; 0 asks the OS for a free one). After
|
|
||||||
/// <see cref="Start"/> it holds the port actually bound.
|
|
||||||
/// </summary>
|
|
||||||
public int Port { get; set; } = DefaultPort;
|
|
||||||
|
|
||||||
private float Time => (float)(_timer?.Elapsed.TotalSeconds ?? 0d);
|
private float Time => (float)(_timer?.Elapsed.TotalSeconds ?? 0d);
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
|
|
@ -80,7 +74,7 @@ namespace GameCult.Networking
|
||||||
{
|
{
|
||||||
TransportId = "litenetlib-server",
|
TransportId = "litenetlib-server",
|
||||||
Host = "0.0.0.0",
|
Host = "0.0.0.0",
|
||||||
Port = Port
|
Port = ServerPort
|
||||||
});
|
});
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
|
|
@ -363,8 +357,7 @@ namespace GameCult.Networking
|
||||||
UnsyncedEvents = true,
|
UnsyncedEvents = true,
|
||||||
NatPunchEnabled = true
|
NatPunchEnabled = true
|
||||||
};
|
};
|
||||||
_netManager.Start(Port);
|
_netManager.Start(ServerPort);
|
||||||
Port = _netManager.LocalPort;
|
|
||||||
|
|
||||||
listener.NetworkErrorEvent += (point, code) => Logger.LogInfo($"{point.Address}: Error {code}");
|
listener.NetworkErrorEvent += (point, code) => Logger.LogInfo($"{point.Address}: Error {code}");
|
||||||
|
|
||||||
|
|
@ -415,25 +408,11 @@ namespace GameCult.Networking
|
||||||
{
|
{
|
||||||
var cultNetMessage = LiteNetLibTransportConnection.DecodeSchema(frame);
|
var cultNetMessage = LiteNetLibTransportConnection.DecodeSchema(frame);
|
||||||
Logger.LogDebug($"Received CultNet schema message {cultNetMessage.SchemaVersion}");
|
Logger.LogDebug($"Received CultNet schema message {cultNetMessage.SchemaVersion}");
|
||||||
if (transport.RefuseUnreliableWrite(cultNetMessage, method)) return;
|
|
||||||
await HandleCultNetSchemaMessageAsync(peer, user, cultNetMessage).ConfigureAwait(false);
|
await HandleCultNetSchemaMessageAsync(peer, user, cultNetMessage).ConfigureAwait(false);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
Message message;
|
var message = LiteNetLibTransportConnection.DecodeLegacy(frame);
|
||||||
try
|
|
||||||
{
|
|
||||||
message = LiteNetLibTransportConnection.DecodeLegacy(frame);
|
|
||||||
}
|
|
||||||
catch (Exception ex) when (transport.WriteReceipts != null)
|
|
||||||
{
|
|
||||||
// A frame that decodes on neither channel is classed legacy, so this is where an unreadable frame lands.
|
|
||||||
// A receipt-capable peer is told which frame was unreadable (by its id, if the frame still holds one).
|
|
||||||
Logger.LogWarning($"CultNet frame unreadable: {ex.Message}");
|
|
||||||
transport.AnswerUnreadableSchemaFrame(frame.Payload);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (LogSensitivePayloads)
|
if (LogSensitivePayloads)
|
||||||
{
|
{
|
||||||
Logger.LogDebug($"Received message: {MessagePackSerializer.ConvertToJson(new ReadOnlyMemory<byte>(frame.Payload))}");
|
Logger.LogDebug($"Received message: {MessagePackSerializer.ConvertToJson(new ReadOnlyMemory<byte>(frame.Payload))}");
|
||||||
|
|
@ -528,7 +507,7 @@ namespace GameCult.Networking
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
Logger.LogInfo($"Server started on port {Port}.");
|
Logger.LogInfo($"Server started on port {ServerPort}.");
|
||||||
}
|
}
|
||||||
|
|
||||||
private async Task HandleCultNetSchemaMessageAsync(NetPeer peer, User user, ICultNetSchemaMessage message)
|
private async Task HandleCultNetSchemaMessageAsync(NetPeer peer, User user, ICultNetSchemaMessage message)
|
||||||
|
|
|
||||||
|
|
@ -418,7 +418,6 @@ namespace GameCult.Networking.Tests
|
||||||
CultNetDatabaseChangeKind.Added, VariantKey, schemaId, database.Shards[0], cache.Get<VariantWireFixture>(VariantKey)!, previousDocument: null);
|
CultNetDatabaseChangeKind.Added, VariantKey, schemaId, database.Shards[0], cache.Get<VariantWireFixture>(VariantKey)!, previousDocument: null);
|
||||||
Assert.That(Deliver(databaseServer, added, selection, refused, errors), Is.Null);
|
Assert.That(Deliver(databaseServer, added, selection, refused, errors), Is.Null);
|
||||||
Assert.That(errors, Has.Count.EqualTo(1));
|
Assert.That(errors, Has.Count.EqualTo(1));
|
||||||
Assert.That(errors[0].Error, Is.EqualTo("the record is a variant CultNet cannot carry"));
|
|
||||||
|
|
||||||
var removed = new CultNetDatabaseChange<VariantWireFixture>(
|
var removed = new CultNetDatabaseChange<VariantWireFixture>(
|
||||||
CultNetDatabaseChangeKind.Removed, VariantKey, schemaId, database.Shards[0], document: null, previousDocument: cache.Get<VariantWireFixture>(VariantKey)!);
|
CultNetDatabaseChangeKind.Removed, VariantKey, schemaId, database.Shards[0], document: null, previousDocument: cache.Get<VariantWireFixture>(VariantKey)!);
|
||||||
|
|
|
||||||
|
|
@ -178,46 +178,6 @@ namespace GameCult.Networking.Tests
|
||||||
Assert.That(scene.Logger.Errors, Has.Count.EqualTo(1));
|
Assert.That(scene.Logger.Errors, Has.Count.EqualTo(1));
|
||||||
}
|
}
|
||||||
|
|
||||||
// The RUDP schema server implements no receipt rules, so it must not advertise them (write-receipt.md, Capability and the
|
|
||||||
// conformance table): whatever hello it sends lists neither frame.
|
|
||||||
[Test]
|
|
||||||
public async Task TheRudpSchemaServerNeverAdvertisesTheReceiptFrames()
|
|
||||||
{
|
|
||||||
using var server = new RudpCultNetSchemaServer(new RudpCultNetSchemaServerOptions
|
|
||||||
{
|
|
||||||
RuntimeId = "csharp-rudp-no-receipts",
|
|
||||||
ConnectionId = ConnectionId
|
|
||||||
});
|
|
||||||
var client = await Connect(server);
|
|
||||||
try
|
|
||||||
{
|
|
||||||
SendSchema(server, client, CultNetSchemaMessageSerialization.Serialize(new CultNetHelloMessage
|
|
||||||
{
|
|
||||||
RuntimeId = "receipt-client",
|
|
||||||
RuntimeKind = "test",
|
|
||||||
SupportedMessageVersions = [CultNetSchemaVersions.WriteAdmitted, CultNetSchemaVersions.ErrorV1]
|
|
||||||
}));
|
|
||||||
await server.PollAvailableAsync(16);
|
|
||||||
|
|
||||||
var hellos = new List<CultNetHelloMessage>();
|
|
||||||
foreach (var packet in Drain(client.Socket))
|
|
||||||
foreach (var frame in client.Session.Receive(packet, 1).Delivered)
|
|
||||||
if (CultNetSchemaMessageSerialization.Deserialize(frame.Payload) is CultNetHelloMessage hello)
|
|
||||||
hellos.Add(hello);
|
|
||||||
|
|
||||||
foreach (var hello in hellos)
|
|
||||||
{
|
|
||||||
var listed = hello.SupportedMessageVersions ?? Array.Empty<string>();
|
|
||||||
Assert.That(listed, Has.None.EqualTo(CultNetSchemaVersions.WriteAdmitted));
|
|
||||||
Assert.That(listed, Has.None.EqualTo(CultNetSchemaVersions.ErrorV1));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
finally
|
|
||||||
{
|
|
||||||
client.Socket.Dispose();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private static List<CultNetErrorMessage> ErrorsReceivedBy(Client client)
|
private static List<CultNetErrorMessage> ErrorsReceivedBy(Client client)
|
||||||
{
|
{
|
||||||
var errors = new List<CultNetErrorMessage>();
|
var errors = new List<CultNetErrorMessage>();
|
||||||
|
|
|
||||||
|
|
@ -1,290 +0,0 @@
|
||||||
#nullable enable
|
|
||||||
using System;
|
|
||||||
using System.Collections.Concurrent;
|
|
||||||
using System.Collections.Generic;
|
|
||||||
using System.Linq;
|
|
||||||
using System.Threading;
|
|
||||||
using System.Threading.Tasks;
|
|
||||||
using GameCult.Caching;
|
|
||||||
using LiteNetLib;
|
|
||||||
using NUnit.Framework;
|
|
||||||
using static GameCult.Networking.Tests.NetworkingTests;
|
|
||||||
|
|
||||||
namespace GameCult.Networking.Tests
|
|
||||||
{
|
|
||||||
// The receipt server on a real socket: Server.Start on an ephemeral loopback port and real LiteNetLib clients. The
|
|
||||||
// handler-level tests (CultNetWriteReceiptServerTests) hand frames to the handlers; only a running server decides what
|
|
||||||
// a frame that does not decode is answered with.
|
|
||||||
public sealed class CultNetWriteReceiptLoopbackTests
|
|
||||||
{
|
|
||||||
private static readonly TimeSpan Cap = TimeSpan.FromSeconds(10);
|
|
||||||
private static readonly CultRecordKey KeyA = new("tests:loopback:a");
|
|
||||||
private static readonly CultRecordKey KeyB = new("tests:loopback:b");
|
|
||||||
private const string ShardId = "loopback-shard";
|
|
||||||
|
|
||||||
private sealed class Client : IDisposable
|
|
||||||
{
|
|
||||||
private readonly NetManager _manager;
|
|
||||||
private readonly NetPeer _peer;
|
|
||||||
private readonly BlockingCollection<ICultNetSchemaMessage> _received = new();
|
|
||||||
public int Closed;
|
|
||||||
|
|
||||||
public Client(int port, string key)
|
|
||||||
{
|
|
||||||
var listener = new EventBasedNetListener();
|
|
||||||
var connected = new TaskCompletionSource<bool>(TaskCreationOptions.RunContinuationsAsynchronously);
|
|
||||||
var decoder = new LiteNetLibTransportConnection();
|
|
||||||
listener.PeerConnectedEvent += _ => connected.TrySetResult(true);
|
|
||||||
listener.PeerDisconnectedEvent += (_, _) => Interlocked.Increment(ref Closed);
|
|
||||||
listener.NetworkReceiveEvent += (_, reader, _, _) =>
|
|
||||||
_received.Add(LiteNetLibTransportConnection.DecodeSchema(decoder.Receive(reader.GetRemainingBytes())));
|
|
||||||
_manager = new NetManager(listener) { UnsyncedEvents = true };
|
|
||||||
_manager.Start(0);
|
|
||||||
_peer = _manager.Connect("127.0.0.1", port, key);
|
|
||||||
if (!connected.Task.Wait(Cap)) Assert.Fail("the client did not connect");
|
|
||||||
}
|
|
||||||
|
|
||||||
public void Send<T>(T message) where T : ICultNetSchemaMessage =>
|
|
||||||
_peer.Send(CultNetSchemaMessageSerialization.Serialize(message), DeliveryMethod.ReliableOrdered);
|
|
||||||
|
|
||||||
public void SendUnreliable<T>(T message) where T : ICultNetSchemaMessage =>
|
|
||||||
_peer.Send(CultNetSchemaMessageSerialization.Serialize(message), DeliveryMethod.Unreliable);
|
|
||||||
|
|
||||||
public void Send<T>(T message, DeliveryMethod method) where T : ICultNetSchemaMessage =>
|
|
||||||
_peer.Send(CultNetSchemaMessageSerialization.Serialize(message), method);
|
|
||||||
|
|
||||||
public void SendRaw(byte[] bytes) => _peer.Send(bytes, DeliveryMethod.ReliableOrdered);
|
|
||||||
|
|
||||||
public T Next<T>() where T : ICultNetSchemaMessage
|
|
||||||
{
|
|
||||||
if (!_received.TryTake(out var message, Cap)) Assert.Fail($"no {typeof(T).Name} arrived within {Cap}");
|
|
||||||
Assert.That(message, Is.InstanceOf<T>());
|
|
||||||
return (T)message!;
|
|
||||||
}
|
|
||||||
|
|
||||||
public void ExpectNothingMore(string because)
|
|
||||||
{
|
|
||||||
// A reliable ordered channel: anything the server sent before the probe's answer has already arrived.
|
|
||||||
Assert.That(_received.Count, Is.Zero, because);
|
|
||||||
}
|
|
||||||
|
|
||||||
public void Dispose()
|
|
||||||
{
|
|
||||||
_manager.Stop();
|
|
||||||
_received.Dispose();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private sealed class Authority : ICultNetRemoteWriteAuthority
|
|
||||||
{
|
|
||||||
public CultNetRemoteWriteDecision Decide(CultNetRemoteWriteRequest request) =>
|
|
||||||
request.RecordKey.Equals(KeyB) ? CultNetRemoteWriteDecision.Refuse("denied") : CultNetRemoteWriteDecision.Grant();
|
|
||||||
}
|
|
||||||
|
|
||||||
private sealed class Running : IDisposable
|
|
||||||
{
|
|
||||||
public Server Server = null!;
|
|
||||||
public CultCache Cache = null!;
|
|
||||||
public CultNetDatabase Database = null!;
|
|
||||||
public string SchemaId = string.Empty;
|
|
||||||
private CultNetDatabaseServer _databaseServer = null!;
|
|
||||||
|
|
||||||
public static Running Start()
|
|
||||||
{
|
|
||||||
var cache = new CultCache();
|
|
||||||
var schemaId = cache.Registry.GetRequired<NetworkSchemaNote>().SchemaId;
|
|
||||||
var database = new CultNetDatabase(cache, new CultNetDatabaseOptions
|
|
||||||
{
|
|
||||||
Shards = [new CultNetShardDescriptor(ShardId, "primary", epoch: 1, isPrimary: true, schemaIds: [schemaId])]
|
|
||||||
});
|
|
||||||
var server = new Server(cache, ServerSecurityOptions.Development()) { Port = 0 };
|
|
||||||
var databaseServer = new CultNetDatabaseServer(server, database, new CultNetDatabaseServerOptions
|
|
||||||
{
|
|
||||||
RemoteWriteAuthority = new Authority()
|
|
||||||
});
|
|
||||||
server.Start();
|
|
||||||
return new Running { Server = server, Cache = cache, Database = database, SchemaId = schemaId, _databaseServer = databaseServer };
|
|
||||||
}
|
|
||||||
|
|
||||||
public Client Connect() => new(Server.Port, ServerSecurityOptions.Development().ConnectionKey);
|
|
||||||
|
|
||||||
public CultNetDocumentPutRawMessage PutOf(string id, CultRecordKey key, string text)
|
|
||||||
{
|
|
||||||
var message = Database.Documents.CreateRawDocumentPutMessage(id, new CultRecordHandle<NetworkSchemaNote>(key),
|
|
||||||
new NetworkSchemaNote { Schema = "tests.networking_note.v1", Text = text });
|
|
||||||
message.ShardId = ShardId;
|
|
||||||
message.ShardEpoch = 1;
|
|
||||||
return message;
|
|
||||||
}
|
|
||||||
|
|
||||||
public void Dispose()
|
|
||||||
{
|
|
||||||
_databaseServer.Dispose();
|
|
||||||
Server.Dispose();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private static CultNetHelloMessage HelloOf(params string[] versions) =>
|
|
||||||
new() { RuntimeId = "loopback-client", RuntimeKind = "test", SupportedMessageVersions = versions };
|
|
||||||
|
|
||||||
private static readonly string[] BothFrames = [CultNetSchemaVersions.WriteAdmitted, CultNetSchemaVersions.ErrorV1];
|
|
||||||
|
|
||||||
[Test]
|
|
||||||
public void StartBindsTheRequestedPortAndReportsTheOneBound()
|
|
||||||
{
|
|
||||||
using var running = Running.Start();
|
|
||||||
Assert.That(running.Server.Port, Is.Not.Zero.And.Not.EqualTo(3075));
|
|
||||||
}
|
|
||||||
|
|
||||||
// contracts/cultnet/interop/write-receipt-vectors.json, error_v1_unreadable_frame_has_null_message_id: code
|
|
||||||
// message_invalid, details.field "message", messageId null.
|
|
||||||
[TestCase(new byte[] { 0xC1 }, TestName = "AnUnreadableFrameFromAReceiptPeerIsAnsweredWithMessageInvalidAndNoId_NeverUsedByte")]
|
|
||||||
[TestCase(new byte[] { 0x92, 0x01, 0x02 }, TestName = "AnUnreadableFrameFromAReceiptPeerIsAnsweredWithMessageInvalidAndNoId_NotAMap")]
|
|
||||||
public void AnUnreadableFrameFromAReceiptPeerIsAnsweredWithMessageInvalidAndNoId(byte[] garbage)
|
|
||||||
{
|
|
||||||
using var running = Running.Start();
|
|
||||||
using var client = running.Connect();
|
|
||||||
client.Send(HelloOf(BothFrames));
|
|
||||||
client.Next<CultNetHelloMessage>();
|
|
||||||
|
|
||||||
client.SendRaw(garbage);
|
|
||||||
|
|
||||||
var error = client.Next<CultNetErrorV1Message>();
|
|
||||||
Assert.That(error.Code, Is.EqualTo("message_invalid"));
|
|
||||||
Assert.That(error.Details!.Field, Is.EqualTo("message"));
|
|
||||||
Assert.That(error.MessageId, Is.Null);
|
|
||||||
}
|
|
||||||
|
|
||||||
[Test]
|
|
||||||
public async Task AReceiptPeerIsStillServedAfterAnUnreadableFrameAndALegacyPeerIsAnsweredAsBefore()
|
|
||||||
{
|
|
||||||
using var running = Running.Start();
|
|
||||||
using var receipt = running.Connect();
|
|
||||||
receipt.Send(HelloOf(BothFrames));
|
|
||||||
receipt.Next<CultNetHelloMessage>();
|
|
||||||
receipt.SendRaw(new byte[] { 0xC1 });
|
|
||||||
receipt.Next<CultNetErrorV1Message>();
|
|
||||||
|
|
||||||
receipt.Send(running.PutOf("r1", KeyA, "one"));
|
|
||||||
Assert.That(receipt.Next<CultNetWriteAdmittedMessage>().MessageId, Is.EqualTo("r1"));
|
|
||||||
|
|
||||||
using var legacy = running.Connect();
|
|
||||||
legacy.Send(HelloOf()); // a hello that lists neither frame is answered with nothing
|
|
||||||
legacy.SendRaw(new byte[] { 0xC1 }); // unanswered: were it answered, error.v1 would arrive ahead of the refusal
|
|
||||||
legacy.Send(running.PutOf("l1", KeyB, "two"));
|
|
||||||
var refusal = legacy.Next<CultNetErrorMessage>();
|
|
||||||
Assert.That(refusal, Is.TypeOf<CultNetErrorMessage>());
|
|
||||||
Assert.That(refusal.Code, Is.EqualTo("write_not_authorized"));
|
|
||||||
legacy.Send(running.PutOf("l2", KeyA, "three"));
|
|
||||||
await WaitFor(() => running.Cache.Get<NetworkSchemaNote>(KeyA)?.Text == "three");
|
|
||||||
legacy.ExpectNothingMore("a legacy peer is never sent a receipt or error.v1");
|
|
||||||
Assert.That(running.Cache.Get<NetworkSchemaNote>(KeyB), Is.Null);
|
|
||||||
}
|
|
||||||
|
|
||||||
// write-receipt.md, Reliable channel only: a write on an unreliable channel of a receipt session is refused
|
|
||||||
// message_invalid, details.field "channel", fixed text, carrying the write's id; it is not applied.
|
|
||||||
[Test]
|
|
||||||
public async Task AWriteOnAnUnreliableChannelOfAReceiptPeerIsRefusedAndNotApplied()
|
|
||||||
{
|
|
||||||
using var running = Running.Start();
|
|
||||||
using var client = running.Connect();
|
|
||||||
client.Send(HelloOf(BothFrames));
|
|
||||||
client.Next<CultNetHelloMessage>();
|
|
||||||
|
|
||||||
client.SendUnreliable(running.PutOf("u1", KeyA, "lost"));
|
|
||||||
|
|
||||||
var error = client.Next<CultNetErrorV1Message>();
|
|
||||||
Assert.That(error.Code, Is.EqualTo("message_invalid"));
|
|
||||||
Assert.That(error.Details!.Field, Is.EqualTo("channel"));
|
|
||||||
Assert.That(error.Error, Is.EqualTo("message_invalid: receipt sessions require the reliable channel"));
|
|
||||||
Assert.That(error.MessageId, Is.EqualTo("u1"));
|
|
||||||
|
|
||||||
// The session goes on, and the same id on the reliable channel is a new write, not a replayed refusal.
|
|
||||||
client.Send(running.PutOf("u1", KeyA, "kept"));
|
|
||||||
Assert.That(client.Next<CultNetWriteAdmittedMessage>().MessageId, Is.EqualTo("u1"));
|
|
||||||
await WaitFor(() => running.Cache.Get<NetworkSchemaNote>(KeyA)?.Text == "kept");
|
|
||||||
}
|
|
||||||
|
|
||||||
// write-receipt.md, Reliable channel only: reliable and not sequenced. Reliable ordered and unordered qualify; reliable
|
|
||||||
// sequenced does not, and nor does any unreliable method.
|
|
||||||
[TestCase(DeliveryMethod.ReliableSequenced, true)]
|
|
||||||
[TestCase(DeliveryMethod.Sequenced, true)]
|
|
||||||
[TestCase(DeliveryMethod.Unreliable, true)]
|
|
||||||
[TestCase(DeliveryMethod.ReliableUnordered, false)]
|
|
||||||
[TestCase(DeliveryMethod.ReliableOrdered, false)]
|
|
||||||
public async Task OnlyAReliableNonSequencedChannelCarriesAWriteOfAReceiptPeer(DeliveryMethod method, bool refused)
|
|
||||||
{
|
|
||||||
using var running = Running.Start();
|
|
||||||
using var client = running.Connect();
|
|
||||||
client.Send(HelloOf(BothFrames));
|
|
||||||
client.Next<CultNetHelloMessage>();
|
|
||||||
|
|
||||||
client.Send(running.PutOf("c1", KeyA, "text"), method);
|
|
||||||
|
|
||||||
if (refused)
|
|
||||||
{
|
|
||||||
var error = client.Next<CultNetErrorV1Message>();
|
|
||||||
Assert.That(error.Details!.Field, Is.EqualTo("channel"));
|
|
||||||
Assert.That(error.MessageId, Is.EqualTo("c1"));
|
|
||||||
Assert.That(running.Cache.Get<NetworkSchemaNote>(KeyA), Is.Null);
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
Assert.That(client.Next<CultNetWriteAdmittedMessage>().MessageId, Is.EqualTo("c1"));
|
|
||||||
await WaitFor(() => running.Cache.Get<NetworkSchemaNote>(KeyA)?.Text == "text");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
[Test]
|
|
||||||
public void ADeleteOnAnUnreliableChannelOfAReceiptPeerIsRefusedWithItsId()
|
|
||||||
{
|
|
||||||
using var running = Running.Start();
|
|
||||||
using var client = running.Connect();
|
|
||||||
client.Send(HelloOf(BothFrames));
|
|
||||||
client.Next<CultNetHelloMessage>();
|
|
||||||
|
|
||||||
client.SendUnreliable(new CultNetDocumentDeleteMessage
|
|
||||||
{
|
|
||||||
MessageId = "ud1", SchemaId = running.SchemaId, RecordKey = KeyA.Value, ShardId = ShardId, ShardEpoch = 1
|
|
||||||
});
|
|
||||||
|
|
||||||
var error = client.Next<CultNetErrorV1Message>();
|
|
||||||
Assert.That(error.Code, Is.EqualTo("message_invalid"));
|
|
||||||
Assert.That(error.Details!.Field, Is.EqualTo("channel"));
|
|
||||||
Assert.That(error.MessageId, Is.EqualTo("ud1"));
|
|
||||||
}
|
|
||||||
|
|
||||||
[Test]
|
|
||||||
public async Task OnlyWritesAreRefusedOnTheUnreliableChannelAndALegacyPeerIsLeftAsBefore()
|
|
||||||
{
|
|
||||||
using var running = Running.Start();
|
|
||||||
using var receipt = running.Connect();
|
|
||||||
receipt.Send(HelloOf(BothFrames));
|
|
||||||
receipt.Next<CultNetHelloMessage>();
|
|
||||||
receipt.SendUnreliable(HelloOf(BothFrames)); // not a write: answered with nothing on the unreliable channel
|
|
||||||
receipt.Send(running.PutOf("r1", KeyA, "one"));
|
|
||||||
Assert.That(receipt.Next<CultNetWriteAdmittedMessage>().MessageId, Is.EqualTo("r1"), "nothing else was sent ahead of the receipt");
|
|
||||||
receipt.Send(running.PutOf("r2", KeyA, "two"));
|
|
||||||
Assert.That(receipt.Next<CultNetWriteAdmittedMessage>().MessageId, Is.EqualTo("r2"));
|
|
||||||
receipt.ExpectNothingMore("the unreliable hello was answered with nothing");
|
|
||||||
|
|
||||||
using var legacy = running.Connect();
|
|
||||||
legacy.Send(HelloOf());
|
|
||||||
legacy.SendUnreliable(running.PutOf("l1", KeyB, "two")); // refused by the authority, answered as v0 as before
|
|
||||||
Assert.That(legacy.Next<CultNetErrorMessage>().Code, Is.EqualTo("write_not_authorized"));
|
|
||||||
legacy.SendUnreliable(running.PutOf("l2", KeyA, "three"));
|
|
||||||
await WaitFor(() => running.Cache.Get<NetworkSchemaNote>(KeyA)?.Text == "three");
|
|
||||||
legacy.ExpectNothingMore("a legacy peer is never sent a receipt, error.v1 or a channel refusal");
|
|
||||||
}
|
|
||||||
|
|
||||||
private static async Task WaitFor(Func<bool> condition)
|
|
||||||
{
|
|
||||||
var deadline = DateTime.UtcNow + Cap;
|
|
||||||
while (!condition())
|
|
||||||
{
|
|
||||||
if (DateTime.UtcNow > deadline) Assert.Fail("the condition did not hold within the cap");
|
|
||||||
await Task.Delay(5);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
File diff suppressed because it is too large
Load diff
|
|
@ -5189,9 +5189,7 @@ namespace GameCult.Networking.Tests
|
||||||
[Test]
|
[Test]
|
||||||
public async Task CultNetSchemaWriteForwarder_Uses_SchemaClientPort()
|
public async Task CultNetSchemaWriteForwarder_Uses_SchemaClientPort()
|
||||||
{
|
{
|
||||||
var fake = new CapturingSchemaClient(message => message is CultNetDocumentDeleteMessage delete
|
var fake = new CapturingSchemaClient(_ => null);
|
||||||
? new CultNetWriteAdmittedMessage { MessageId = delete.MessageId, Operation = "delete", SchemaId = delete.SchemaId, RecordKey = delete.RecordKey }
|
|
||||||
: null);
|
|
||||||
var forwarder = new CultNetSchemaWriteForwarder(new CultNetSchemaWriteForwarderOptions
|
var forwarder = new CultNetSchemaWriteForwarder(new CultNetSchemaWriteForwarderOptions
|
||||||
{
|
{
|
||||||
CreateClient = () => fake
|
CreateClient = () => fake
|
||||||
|
|
@ -5205,16 +5203,11 @@ namespace GameCult.Networking.Tests
|
||||||
|
|
||||||
await forwarder.ForwardDeleteAsync(shard, new CultNetDocumentDeleteMessage
|
await forwarder.ForwardDeleteAsync(shard, new CultNetDocumentDeleteMessage
|
||||||
{
|
{
|
||||||
MessageId = "fwd-del",
|
|
||||||
SchemaId = "note.v0",
|
SchemaId = "note.v0",
|
||||||
RecordKey = "note:1"
|
RecordKey = "note:1"
|
||||||
});
|
});
|
||||||
|
|
||||||
var hello = (CultNetHelloMessage)fake.SentMessages[0];
|
var sent = (CultNetDocumentDeleteMessage)fake.SentMessages.Single();
|
||||||
Assert.That(hello.SupportedMessageVersions, Is.EquivalentTo(new[] { CultNetSchemaVersions.WriteAdmitted, CultNetSchemaVersions.ErrorV1 }),
|
|
||||||
"the hello opts the forwarding connection in before the write");
|
|
||||||
var sent = (CultNetDocumentDeleteMessage)fake.SentMessages[1];
|
|
||||||
Assert.That(sent.MessageId, Is.EqualTo("fwd-del"), "the write goes under its original id");
|
|
||||||
Assert.That(fake.ConnectedHost, Is.EqualTo("primary.example.test"));
|
Assert.That(fake.ConnectedHost, Is.EqualTo("primary.example.test"));
|
||||||
Assert.That(sent.ShardId, Is.EqualTo("notes"));
|
Assert.That(sent.ShardId, Is.EqualTo("notes"));
|
||||||
Assert.That(sent.ShardEpoch, Is.EqualTo(3));
|
Assert.That(sent.ShardEpoch, Is.EqualTo(3));
|
||||||
|
|
@ -5248,7 +5241,7 @@ namespace GameCult.Networking.Tests
|
||||||
}
|
}
|
||||||
|
|
||||||
[Test]
|
[Test]
|
||||||
public void CultNetSchemaWriteForwarder_SilenceIsUnconfirmedNotSuccess()
|
public async Task CultNetSchemaWriteForwarder_DoesNotCompleteOnTheSendReturning()
|
||||||
{
|
{
|
||||||
var fake = new CapturingSchemaClient(_ => null);
|
var fake = new CapturingSchemaClient(_ => null);
|
||||||
var forwarder = new CultNetSchemaWriteForwarder(new CultNetSchemaWriteForwarderOptions
|
var forwarder = new CultNetSchemaWriteForwarder(new CultNetSchemaWriteForwarderOptions
|
||||||
|
|
@ -5261,51 +5254,11 @@ namespace GameCult.Networking.Tests
|
||||||
primaryEndpoints: ["cultnet://primary.example.test:4075"]);
|
primaryEndpoints: ["cultnet://primary.example.test:4075"]);
|
||||||
var started = DateTime.UtcNow;
|
var started = DateTime.UtcNow;
|
||||||
|
|
||||||
var unconfirmed = Assert.ThrowsAsync<CultNetWriteUnconfirmedException>(() =>
|
await forwarder.ForwardDeleteAsync(shard, new CultNetDocumentDeleteMessage { SchemaId = "note.v0", RecordKey = "note:1" });
|
||||||
forwarder.ForwardDeleteAsync(shard, new CultNetDocumentDeleteMessage { MessageId = "fwd-del", SchemaId = "note.v0", RecordKey = "note:1" }));
|
|
||||||
|
|
||||||
Assert.That(unconfirmed!.MessageId, Is.EqualTo("fwd-del"));
|
|
||||||
Assert.That(DateTime.UtcNow - started, Is.GreaterThanOrEqualTo(TimeSpan.FromMilliseconds(380)));
|
Assert.That(DateTime.UtcNow - started, Is.GreaterThanOrEqualTo(TimeSpan.FromMilliseconds(380)));
|
||||||
}
|
}
|
||||||
|
|
||||||
[Test]
|
|
||||||
public void CultNetSchemaWriteForwarder_AnswersNamingAnotherWriteSettleNothing()
|
|
||||||
{
|
|
||||||
var fake = new CapturingSchemaClient(_ => null);
|
|
||||||
var forwarder = new CultNetSchemaWriteForwarder(new CultNetSchemaWriteForwarderOptions
|
|
||||||
{
|
|
||||||
CreateClient = () => fake,
|
|
||||||
ResultWindow = TimeSpan.FromMilliseconds(300)
|
|
||||||
});
|
|
||||||
var shard = new CultNetShardDescriptor(
|
|
||||||
"notes", "primary", 3, isPrimary: false,
|
|
||||||
primaryEndpoints: ["cultnet://primary.example.test:4075"]);
|
|
||||||
fake.OnSend = () =>
|
|
||||||
{
|
|
||||||
fake.Deliver(new CultNetWriteAdmittedMessage { MessageId = "someone-else", Operation = "delete", SchemaId = "note.v0", RecordKey = "note:1" });
|
|
||||||
fake.Deliver(new CultNetErrorV1Message { Error = "refused", Code = "write_not_authorized", MessageId = "someone-else" });
|
|
||||||
};
|
|
||||||
|
|
||||||
Assert.ThrowsAsync<CultNetWriteUnconfirmedException>(() =>
|
|
||||||
forwarder.ForwardDeleteAsync(shard, new CultNetDocumentDeleteMessage { MessageId = "fwd-del", SchemaId = "note.v0", RecordKey = "note:1" }));
|
|
||||||
}
|
|
||||||
|
|
||||||
[Test]
|
|
||||||
public void CultNetSchemaWriteForwarder_RejectsWithTheErrorV1NamingItsWrite()
|
|
||||||
{
|
|
||||||
var fake = new CapturingSchemaClient(_ => null);
|
|
||||||
var forwarder = new CultNetSchemaWriteForwarder(new CultNetSchemaWriteForwarderOptions { CreateClient = () => fake });
|
|
||||||
var shard = new CultNetShardDescriptor(
|
|
||||||
"notes", "primary", 3, isPrimary: false,
|
|
||||||
primaryEndpoints: ["cultnet://primary.example.test:4075"]);
|
|
||||||
fake.OnSend = () => fake.Deliver(new CultNetErrorV1Message { Error = "refused", Code = "write_not_authorized", MessageId = "fwd-del" });
|
|
||||||
|
|
||||||
var refused = Assert.ThrowsAsync<CultNetWriteRefusedException>(() =>
|
|
||||||
forwarder.ForwardDeleteAsync(shard, new CultNetDocumentDeleteMessage { MessageId = "fwd-del", SchemaId = "note.v0", RecordKey = "note:1" }));
|
|
||||||
|
|
||||||
Assert.That(refused!.Code, Is.EqualTo("write_not_authorized"));
|
|
||||||
}
|
|
||||||
|
|
||||||
[Test]
|
[Test]
|
||||||
public void CultMeshVerseCatalog_Finds_CompatibleTransferTargets()
|
public void CultMeshVerseCatalog_Finds_CompatibleTransferTargets()
|
||||||
{
|
{
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue