cultnet-py: change messages carry commitId/commitCount; schema catalog lists both
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This commit is contained in:
parent
7c7ab30f4d
commit
52f7e9b185
4 changed files with 55 additions and 0 deletions
|
|
@ -2,6 +2,7 @@
|
|||
|
||||
## Unreleased (breaking; version 0.x, so the next minor)
|
||||
|
||||
- `CultNetDatabaseChange` carries `commit_id` and `commit_count` (`commitId`/`commitCount`; None outside a multi-record commit, as C# writes nil): `from_wire` refuses an empty or non-string id and a count that is not an integer of at least 2, `to_wire` writes them when set, and the published `database_change_raw` schema lists both. Python applies no batch. The `simulation_fact` document's `shard`, `frame`, `subject` and `claim_kind` aliases are `roles` (many facts share each); the catalog bytes do not move.
|
||||
- Decodes the write receipt frames of `contracts/cultnet/interop/write-receipt.md`: `parse_message` validates `cultnet.write_admitted.v0` and `cultnet.error.v1` against their closed schemas (unknown keys, empty or non-string ids, an unknown operation or code are refused; `error.v1` requires `messageId`, string or null; `limit_reached` is `error.v1` only). Added `CULTNET_ERROR_V1_CODES`, `CULTNET_WRITE_RECEIPT_MESSAGE_VERSIONS`, `write_content_hash` and `hello_advertises_write_receipts`; `hello` takes `supported_message_versions`. `tests/test_write_receipt.py` replays the vectors' `contentHash`, `wire` and `schemaInvalid` sections. Not implemented here: the client write tracker (`scenarios`) and the server rules (`dedupe`, `blankFields`); this package has no receipt server and no write client.
|
||||
- Added `message_invalid` to `CULTNET_ERROR_CODES` and `message_invalid_error(field, reason)`, byte-identical to the C# `ForMessageInvalid`. `cultmesh-py` refuses a malformed put or delete with it instead of the out-of-schema `malformed_document_put` and `malformed_document_delete`, which are removed.
|
||||
- Added `CultNetRudpSocketTransportServer` (`cultnet_py.rudp_server`): one UDP socket serving many RUDP peers, one session per
|
||||
|
|
|
|||
|
|
@ -432,6 +432,8 @@ def wire_message_schema_properties(schema_version: str) -> dict[str, Any]:
|
|||
"document": {"$ref": "#/$defs/rawDocumentRecord"},
|
||||
"schemaId": common["schemaId"],
|
||||
"recordKey": common["recordKey"],
|
||||
"commitId": {"type": ["string", "null"], "minLength": 1},
|
||||
"commitCount": {"type": ["integer", "null"], "minimum": 2},
|
||||
},
|
||||
"cultnet.shard_catalog_request.v0": {
|
||||
**common,
|
||||
|
|
|
|||
|
|
@ -15,6 +15,10 @@ class CultNetDatabaseChange:
|
|||
raw_document: CultNetRawDocumentRecord | None = None
|
||||
schema_id: str | None = None
|
||||
record_key: str | None = None
|
||||
commit_id: str | None = None
|
||||
"""Set on every change of one multi-record commit, the same for all of them; None outside one (C# writes nil)."""
|
||||
commit_count: int | None = None
|
||||
"""How many changes the commit holds (>= 2); None outside one. Carried data: Python applies no batch."""
|
||||
|
||||
@classmethod
|
||||
def from_wire(cls, message: dict[str, Any]) -> "CultNetDatabaseChange":
|
||||
|
|
@ -31,6 +35,12 @@ class CultNetDatabaseChange:
|
|||
if raw_document is not None:
|
||||
schema_id = schema_id or raw_document.schema_id
|
||||
record_key = record_key or raw_document.record_key
|
||||
commit_id = message.get("commitId")
|
||||
if commit_id is not None and not (isinstance(commit_id, str) and commit_id):
|
||||
raise ValueError(f"database change commitId must be a non-empty string, received {commit_id!r}")
|
||||
commit_count = message.get("commitCount")
|
||||
if commit_count is not None and (isinstance(commit_count, bool) or not isinstance(commit_count, int) or commit_count < 2):
|
||||
raise ValueError(f"database change commitCount must be an integer of at least 2, received {commit_count!r}")
|
||||
return cls(
|
||||
message_id=str(message.get("messageId") or ""),
|
||||
subscription_id=str(message.get("subscriptionId") or ""),
|
||||
|
|
@ -39,6 +49,8 @@ class CultNetDatabaseChange:
|
|||
raw_document=raw_document,
|
||||
schema_id=schema_id,
|
||||
record_key=record_key,
|
||||
commit_id=commit_id,
|
||||
commit_count=commit_count,
|
||||
)
|
||||
|
||||
def to_wire(self) -> dict[str, Any]:
|
||||
|
|
@ -56,6 +68,10 @@ class CultNetDatabaseChange:
|
|||
wire["schemaId"] = self.schema_id
|
||||
if self.record_key is not None:
|
||||
wire["recordKey"] = self.record_key
|
||||
if self.commit_id is not None:
|
||||
wire["commitId"] = self.commit_id
|
||||
if self.commit_count is not None:
|
||||
wire["commitCount"] = self.commit_count
|
||||
return wire
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1566,6 +1566,40 @@ class CultNetTests(unittest.TestCase):
|
|||
self.assertEqual(delete_change.schema_id, "schema-note")
|
||||
self.assertEqual(delete_change.to_wire()["recordKey"], "note:1")
|
||||
|
||||
def test_cultnet_database_change_commit_fields(self) -> None:
|
||||
base = {
|
||||
"schemaVersion": "cultnet.database_change_raw.v0",
|
||||
"messageId": "change-commit",
|
||||
"subscriptionId": "sub-1",
|
||||
"changeKind": "removed",
|
||||
"schemaId": "schema-note",
|
||||
"recordKey": "note:1",
|
||||
}
|
||||
grouped = CultNetDatabaseChange.from_wire({**base, "commitId": "commit-7", "commitCount": 3})
|
||||
self.assertEqual((grouped.commit_id, grouped.commit_count), ("commit-7", 3))
|
||||
self.assertEqual(grouped.to_wire()["commitId"], "commit-7")
|
||||
self.assertEqual(grouped.to_wire()["commitCount"], 3)
|
||||
self.assertEqual(CultNetDatabaseChange.from_wire(grouped.to_wire()), grouped)
|
||||
|
||||
for absent in (base, {**base, "commitId": None, "commitCount": None}): # C# writes nil outside a commit
|
||||
change = CultNetDatabaseChange.from_wire(absent)
|
||||
self.assertIsNone(change.commit_id)
|
||||
self.assertIsNone(change.commit_count)
|
||||
self.assertNotIn("commitId", change.to_wire())
|
||||
self.assertNotIn("commitCount", change.to_wire())
|
||||
|
||||
for field, bad in (
|
||||
("commitId", ""),
|
||||
("commitId", 7),
|
||||
("commitCount", 1),
|
||||
("commitCount", 0),
|
||||
("commitCount", True),
|
||||
("commitCount", 2.0),
|
||||
("commitCount", "3"),
|
||||
):
|
||||
with self.subTest(field=field, bad=bad), self.assertRaisesRegex(ValueError, field):
|
||||
CultNetDatabaseChange.from_wire({**base, field: bad})
|
||||
|
||||
def test_cultnet_raw_put_helper_carries_message_id(self) -> None:
|
||||
put = document_put_raw(
|
||||
message_id="put-1",
|
||||
|
|
@ -2272,6 +2306,8 @@ class CultNetTests(unittest.TestCase):
|
|||
self.assertIn("document", change_schema["properties"])
|
||||
self.assertIn("schemaId", change_schema["properties"])
|
||||
self.assertIn("recordKey", change_schema["properties"])
|
||||
self.assertEqual(change_schema["properties"]["commitId"], {"type": ["string", "null"], "minLength": 1})
|
||||
self.assertEqual(change_schema["properties"]["commitCount"], {"type": ["integer", "null"], "minimum": 2})
|
||||
|
||||
log_schema = json.loads(by_version["cultnet.shard_log_response.v0"]["schemaJson"])
|
||||
self.assertIn("entries", log_schema["required"])
|
||||
|
|
|
|||
Loading…
Reference in a new issue