Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c1895d3b75 | ||
|
|
dd26b5a251 | ||
|
|
40ed85cc24 | ||
|
|
88c351ad98 | ||
|
|
419542595c | ||
|
|
7a98259ad5 |
174 changed files with 1256 additions and 15531 deletions
2
.github/workflows/cultmesh-portability.yml
vendored
2
.github/workflows/cultmesh-portability.yml
vendored
|
|
@ -158,7 +158,7 @@ jobs:
|
||||||
# (only the interop example built, inside the C# store tests). The target directory is under RUNNER_TEMP, away from the checkout.
|
# (only the interop example built, inside the C# store tests). The target directory is under RUNNER_TEMP, away from the checkout.
|
||||||
- name: Verify the CultCache document owner with the Rust cache
|
- name: Verify the CultCache document owner with the Rust cache
|
||||||
shell: bash
|
shell: bash
|
||||||
run: CARGO_TARGET_DIR="$RUNNER_TEMP/cultcache-rs-target" cargo test --locked --manifest-path packages/cultcache-rs/Cargo.toml
|
run: CARGO_TARGET_DIR="$RUNNER_TEMP/cultcache-rs-target" cargo test --manifest-path packages/cultcache-rs/Cargo.toml
|
||||||
|
|
||||||
# tests/GameCult.Caching.Tests, the C# reference cache's own suite (about 1,260 tests, under a minute), ran in no
|
# tests/GameCult.Caching.Tests, the C# reference cache's own suite (about 1,260 tests, under a minute), ran in no
|
||||||
# forge workflow; only the Mesh tests above exercised the reference.
|
# forge workflow; only the Mesh tests above exercised the reference.
|
||||||
|
|
|
||||||
10
.github/workflows/cultnet-interop.yml
vendored
10
.github/workflows/cultnet-interop.yml
vendored
|
|
@ -29,12 +29,6 @@ jobs:
|
||||||
steps:
|
steps:
|
||||||
- name: Check out CultLib
|
- name: Check out CultLib
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
with:
|
|
||||||
# packages/cultnet-py/tests/test_declared_dependency_ranges.py reads the cultcache-py
|
|
||||||
# release tags and their file contents with `git show`; a shallow checkout has no tags
|
|
||||||
# and the test skips itself.
|
|
||||||
fetch-depth: 0
|
|
||||||
fetch-tags: true
|
|
||||||
|
|
||||||
- name: Set up .NET
|
- name: Set up .NET
|
||||||
uses: actions/setup-dotnet@v4
|
uses: actions/setup-dotnet@v4
|
||||||
|
|
@ -135,10 +129,10 @@ jobs:
|
||||||
python -m unittest discover -s packages/cultmesh-py/tests
|
python -m unittest discover -s packages/cultmesh-py/tests
|
||||||
|
|
||||||
- name: Verify Rust RUDP reliability
|
- name: Verify Rust RUDP reliability
|
||||||
run: cargo test --locked --manifest-path packages/cultnet-rs/Cargo.toml rudp
|
run: cargo test --manifest-path packages/cultnet-rs/Cargo.toml rudp
|
||||||
|
|
||||||
- name: Verify Rust CultMesh runtime-local surface
|
- name: Verify Rust CultMesh runtime-local surface
|
||||||
run: cargo test --locked --manifest-path packages/cultmesh-rs/Cargo.toml
|
run: cargo test --manifest-path packages/cultmesh-rs/Cargo.toml
|
||||||
|
|
||||||
- name: Verify C# RUDP reliability
|
- name: Verify C# RUDP reliability
|
||||||
run: dotnet test tests/GameCult.Networking.Tests/GameCult.Networking.Tests.csproj --filter "FullyQualifiedName~Rudp"
|
run: dotnet test tests/GameCult.Networking.Tests/GameCult.Networking.Tests.csproj --filter "FullyQualifiedName~Rudp"
|
||||||
|
|
|
||||||
|
|
@ -212,8 +212,8 @@ identity-owned C# session after provider route replacement.
|
||||||
Rust package tests:
|
Rust package tests:
|
||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
cargo test --locked --manifest-path packages/cultcache-rs/Cargo.toml
|
cargo test --manifest-path packages/cultcache-rs/Cargo.toml
|
||||||
cargo test --locked --manifest-path packages/cultnet-rs/Cargo.toml
|
cargo test --manifest-path packages/cultnet-rs/Cargo.toml
|
||||||
```
|
```
|
||||||
|
|
||||||
Kotlin package build:
|
Kotlin package build:
|
||||||
|
|
|
||||||
|
|
@ -115,7 +115,7 @@
|
||||||
"validPutPayloadHex": "81A16101",
|
"validPutPayloadHex": "81A16101",
|
||||||
"whiteSpaceCodePoints": ["0009","000A","000B","000C","000D","0020","0085","00A0","1680","2000","2001","2002","2003","2004","2005","2006","2007","2008","2009","200A","2028","2029","202F","205F","3000"],
|
"whiteSpaceCodePoints": ["0009","000A","000B","000C","000D","0020","0085","00A0","1680","2000","2001","2002","2003","2004","2005","2006","2007","2008","2009","200A","2028","2029","202F","205F","3000"],
|
||||||
"notWhiteSpaceCodePoints": ["200B","200C","200D","2060","FEFF","180E","001C","001D","001E","001F"],
|
"notWhiteSpaceCodePoints": ["200B","200C","200D","2060","FEFF","180E","001C","001D","001E","001F"],
|
||||||
"codePointCases": "For every code point in whiteSpaceCodePoints, each of schemaId, recordKey, storedAt, sourceRuntimeId, sourceAgentId, sourceRole and one tags entry, set alone to a string of just that code point (and to that code point repeated three times), is refused; for every code point in notWhiteSpaceCodePoints the same string in each of those fields except storedAt is not blank and the put is admitted (a storedAt must be a stamp: a non-blank storedAt that is no stamp is refused message_invalid, field document, after the write authority, and is covered by tests/vectors/stored-at-stamp).",
|
"codePointCases": "For every code point in whiteSpaceCodePoints, each of schemaId, recordKey, storedAt, sourceRuntimeId, sourceAgentId, sourceRole and one tags entry, set alone to a string of just that code point (and to that code point repeated three times), is refused; for every code point in notWhiteSpaceCodePoints the same string is not blank and the put is admitted.",
|
||||||
"cases": [
|
"cases": [
|
||||||
{ "name": "valid_document_is_admitted", "set": {}, "outcome": "admitted" },
|
{ "name": "valid_document_is_admitted", "set": {}, "outcome": "admitted" },
|
||||||
{ "name": "empty_schema_id", "set": { "schemaId": "" }, "outcome": "refused" },
|
{ "name": "empty_schema_id", "set": { "schemaId": "" }, "outcome": "refused" },
|
||||||
|
|
@ -140,7 +140,7 @@
|
||||||
{ "name": "zero_width_space_schema_id_is_a_name", "set": { "schemaId": "\u200b" }, "outcome": "admitted" },
|
{ "name": "zero_width_space_schema_id_is_a_name", "set": { "schemaId": "\u200b" }, "outcome": "admitted" },
|
||||||
{ "name": "zero_width_space_record_key_is_a_name", "set": { "recordKey": "\u200b" }, "outcome": "admitted" },
|
{ "name": "zero_width_space_record_key_is_a_name", "set": { "recordKey": "\u200b" }, "outcome": "admitted" },
|
||||||
{ "name": "zero_width_space_tag_is_a_name", "set": { "tags": ["\u200b"] }, "outcome": "admitted" },
|
{ "name": "zero_width_space_tag_is_a_name", "set": { "tags": ["\u200b"] }, "outcome": "admitted" },
|
||||||
{ "name": "bom_record_key_is_a_name", "set": { "recordKey": "\ufeff" }, "outcome": "admitted" },
|
{ "name": "bom_stored_at_is_a_name", "set": { "storedAt": "\ufeff" }, "outcome": "admitted" },
|
||||||
{ "name": "mongolian_vowel_separator_source_role_is_a_name", "set": { "sourceRole": "\u180e" }, "outcome": "admitted" },
|
{ "name": "mongolian_vowel_separator_source_role_is_a_name", "set": { "sourceRole": "\u180e" }, "outcome": "admitted" },
|
||||||
{ "name": "padded_name_is_a_name", "set": { "schemaId": "\u00a0a\u2003", "tags": [" a"] }, "outcome": "admitted" },
|
{ "name": "padded_name_is_a_name", "set": { "schemaId": "\u00a0a\u2003", "tags": [" a"] }, "outcome": "admitted" },
|
||||||
{ "name": "file_separator_schema_id_is_a_name", "set": { "schemaId": "\u001c" }, "outcome": "admitted" },
|
{ "name": "file_separator_schema_id_is_a_name", "set": { "schemaId": "\u001c" }, "outcome": "admitted" },
|
||||||
|
|
|
||||||
|
|
@ -40,7 +40,7 @@ A connection is receipt-capable when its `cultnet.hello.v0` (sent before its fir
|
||||||
- **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.
|
- **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.
|
- **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.
|
- **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 put or delete that is 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"`, the fixed unreadable text 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. Names nothing means, on a put or delete, a `schemaId` or `recordKey` that is blank; on a put's document, also a `storedAt` that is blank, a `payload` of zero bytes (a MessagePack value is at least one byte, so an empty payload is no document), a `sourceRuntimeId`, `sourceAgentId` or `sourceRole` that is present and blank, and a `tags` entry that is blank. **Blank** means empty or made only of Unicode White_Space code points (the PropList property) and nothing else, in every runtime, whatever its platform's own whitespace test says. The set is exactly U+0009 to U+000D, U+0020, U+0085, U+00A0, U+1680, U+2000 to U+200A, U+2028, U+2029, U+202F, U+205F and U+3000. U+200B, U+200C, U+200D, U+2060, U+FEFF, U+180E and U+001C to U+001F are not White_Space (some platforms' whitespace tests accept U+001C to U+001F or U+180E, for example Java's `Character.isWhitespace` and older .NET, so a runtime must check the list, not its platform test): a string of them names something. The vectors list both sets (`whiteSpaceCodePoints`, `notWhiteSpaceCodePoints`) and a runtime checks every code point in every covered field. A put's `storedAt` is the exception to "present and not blank is a name": it must be a stamp, so a non-blank `storedAt` that is no stamp (`tests/vectors/stored-at-stamp`) is refused `message_invalid` with `details.field` `"document"`, after the write authority has decided (an ungranted peer is told `write_not_authorized` first), and nothing is stored or minted; only a blank `storedAt` is refused as unreadable with field `"message"`, before the authority. The non-White_Space code point rows therefore name something in every covered field except `storedAt`. Absent or nil source ids and tags, and an empty `tags` list, are valid. The rule holds on every connection, receipt-capable or not (a legacy connection is refused with the `error.v0` of the same code, details and text); the vectors' `blankFields` section lists each case.
|
- **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 put or delete that is 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"`, the fixed unreadable text 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. Names nothing means, on a put or delete, a `schemaId` or `recordKey` that is blank; on a put's document, also a `storedAt` that is blank, a `payload` of zero bytes (a MessagePack value is at least one byte, so an empty payload is no document), a `sourceRuntimeId`, `sourceAgentId` or `sourceRole` that is present and blank, and a `tags` entry that is blank. **Blank** means empty or made only of Unicode White_Space code points (the PropList property) and nothing else, in every runtime, whatever its platform's own whitespace test says. The set is exactly U+0009 to U+000D, U+0020, U+0085, U+00A0, U+1680, U+2000 to U+200A, U+2028, U+2029, U+202F, U+205F and U+3000. U+200B, U+200C, U+200D, U+2060, U+FEFF, U+180E and U+001C to U+001F are not White_Space (some platforms' whitespace tests accept U+001C to U+001F or U+180E, for example Java's `Character.isWhitespace` and older .NET, so a runtime must check the list, not its platform test): a string of them names something. The vectors list both sets (`whiteSpaceCodePoints`, `notWhiteSpaceCodePoints`) and a runtime checks every code point in every covered field. Absent or nil source ids and tags, and an empty `tags` list, are valid. The rule holds on every connection, receipt-capable or not (a legacy connection is refused with the `error.v0` of the same code, details and text); the vectors' `blankFields` section lists each case.
|
||||||
- **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: the message could not be read` (a frame that does not decode, or a write that names nothing; the text is the same for both and never carries a decoder's own wording), `message_invalid: receipt sessions require the reliable channel`, `limit_reached: the session's remembered-write limit is full`.
|
- **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: the message could not be read` (a frame that does not decode, or a write that names nothing; the text is the same for both and never carries a decoder's own wording), `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. The server refuses a sequenced write whenever it can read the write's id: from the delivered frame, and from a superseded packet that carries its whole frame. A write sent as several fragments whose frame is superseded is dropped whole and may go unanswered; the client's unconfirmed outcome covers it. A repeat of a packet the server already took, or a packet too far ahead to be taken, draws no further answer (rule 1).
|
- **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. The server refuses a sequenced write whenever it can read the write's id: from the delivered frame, and from a superseded packet that carries its whole frame. A write sent as several fragments whose frame is superseded is dropped whole and may go unanswered; the client's unconfirmed outcome covers it. A repeat of a packet the server already took, or a packet too far ahead to be taken, draws no further answer (rule 1).
|
||||||
- Past the session (or a server's longer retention, if it keeps one) a resend is a new write.
|
- Past the session (or a server's longer retention, if it keeps one) a resend is a new write.
|
||||||
|
|
|
||||||
|
|
@ -259,7 +259,7 @@ landed in `ead5260c`, Python in `5618d8dd`, Rust in `c028c511`. TypeScript is no
|
||||||
| Runtime | Owner of the decision (constant and walker) | Doors routed through it |
|
| Runtime | Owner of the decision (constant and walker) | Doors routed through it |
|
||||||
|---|---|---|
|
|---|---|---|
|
||||||
| C# | `CultPayloadDepth.Check` (`src/GameCult.Caching.MessagePack/CultPayloadDepth.cs`), limit `CultMessagePackSecurity.MaximumPayloadDepth`. MessagePack's own graph counter is set to the same value as a backstop only. | Write: `CultDocumentMessagePackSerialization.SerializeUntyped`. Read: `DeserializeUntyped`. The cache store (`SerializePayload`/`DeserializePayload`), the directory store, `CultMesh` and single-file documents all call those two; C# has no separate raw-envelope or prepared-batch door. |
|
| C# | `CultPayloadDepth.Check` (`src/GameCult.Caching.MessagePack/CultPayloadDepth.cs`), limit `CultMessagePackSecurity.MaximumPayloadDepth`. MessagePack's own graph counter is set to the same value as a backstop only. | Write: `CultDocumentMessagePackSerialization.SerializeUntyped`. Read: `DeserializeUntyped`. The cache store (`SerializePayload`/`DeserializePayload`), the directory store, `CultMesh` and single-file documents all call those two; C# has no separate raw-envelope or prepared-batch door. |
|
||||||
| Rust | `check_record_payload` (private; depth, then no bytes after the first value) over `first_value_end`, and `MAX_PAYLOAD_DEPTH`; `cultcache_rs::check_payload_depth` is the depth-only probe for outside callers (`packages/cultcache-rs/src/lib.rs`). | Read: `decode_payload` (get, list, `validate_envelope`/`put_envelope`, `finish_prepared_entry`). Write: `put`/`prepare_entry`/`prepare_entry_named` reach it through `finish_prepared_entry`, which decodes what it just encoded. Raw envelope: `put_raw_envelope`, the door CultMesh network puts use (`cultmesh-rs` `lib.rs`, two call sites). Prepared batch: `put_prepared_batch` via `require_record_payload`. Load: `pull_all_backing_stores` and `load_soa` run `require_record_payload` on every record, so a store holding a payload past the bound (or with bytes after it) is refused at load, and the cache then refuses every write and removal (`CultCacheLoadRefused`) until a load succeeds. cultnet-rs: every free-form or skippable wire payload decodes through `cultcache_rs::decode_payload` (message decode in `contracts.rs`, `provider_session`, `media_stream_wire`, `replication`, `service_identity`). |
|
| Rust | `cultcache_rs::check_payload_depth` and `MAX_PAYLOAD_DEPTH` (`packages/cultcache-rs/src/lib.rs`). | Read: `decode_payload` (get, list, `validate_envelope`/`put_envelope`, `finish_prepared_entry`). Write: `put`/`prepare_entry`/`prepare_entry_named` reach it through `finish_prepared_entry`, which decodes what it just encoded. Raw envelope: `put_raw_envelope`, the door CultMesh network puts use (`cultmesh-rs` `lib.rs`, two call sites). Prepared batch: `put_prepared_batch` via `require_payload_depth`. cultnet-rs: every free-form or skippable wire payload decodes through `cultcache_rs::decode_payload` (message decode in `contracts.rs`, `provider_session`, `media_stream_wire`, `replication`, `service_identity`). |
|
||||||
| Python | `_refuse_past_depth_limit` and `MAX_PAYLOAD_DEPTH` (`packages/cultcache-py/src/cultcache_py/documents.py`); a msgpack `StackError` on read maps to the same error. | `DocumentDefinition.encode_payload` (write) and `decode_payload` (read). `CultCache.put`, `put_envelope`, `put_envelopes` and load-time hydration go through them; there is no raw-envelope door. cultmesh-py round trips call the same pair. |
|
| Python | `_refuse_past_depth_limit` and `MAX_PAYLOAD_DEPTH` (`packages/cultcache-py/src/cultcache_py/documents.py`); a msgpack `StackError` on read maps to the same error. | `DocumentDefinition.encode_payload` (write) and `decode_payload` (read). `CultCache.put`, `put_envelope`, `put_envelopes` and load-time hydration go through them; there is no raw-envelope door. cultmesh-py round trips call the same pair. |
|
||||||
|
|
||||||
- **Doors deliberately not routed.** cultnet-rs `idunn_lifecycle_brake`, `provider_health_contracts` and
|
- **Doors deliberately not routed.** cultnet-rs `idunn_lifecycle_brake`, `provider_health_contracts` and
|
||||||
|
|
|
||||||
|
|
@ -1620,7 +1620,7 @@ The one door per runtime, and who walks through it:
|
||||||
- **Shared paths.** Open, flush, commit, `ReadDurable`, `ReplaceDurable`. Rust `pull_all` RS:1243 also checks `is_absent` on the store and on the lock path before it takes the shared lock; that skips lock creation only, and the verdict stays with the reader.
|
- **Shared paths.** Open, flush, commit, `ReadDurable`, `ReplaceDurable`. Rust `pull_all` RS:1243 also checks `is_absent` on the store and on the lock path before it takes the shared lock; that skips lock creation only, and the verdict stays with the reader.
|
||||||
- **Cut line.** `merge-r1` h2 (C#) and h4/h6 (TS `readStoreBytes`); `mesh-single-file-reader` h1.
|
- **Cut line.** `merge-r1` h2 (C#) and h4/h6 (TS `readStoreBytes`); `mesh-single-file-reader` h1.
|
||||||
- **Pinned by.** C#: `StoreReadabilityTests` `ADanglingFileLinkIsAnIoErrorOnOpenNotAnEmptyStore` :208, `ADanglingDirectoryLinkIsAnIoErrorOnOpenNotAnEmptyStore` :185, and the commit variants :196, :219. Mesh: `ADanglingLinkIsAnIoErrorOnTypedWriteRawWriteAndReadNeverAMissingFile` :107 and `OnlyNothingAtThePathIsAMissingFile` :134 (`CultMeshSingleFileStoreTests.cs`). Rust: `a_dangling_symlink_at_the_store_path_is_an_error_and_nothing_is_written` RS:5832. TS: "readStoreBytes reports nothing at the path only when the lstat finds nothing too".
|
- **Pinned by.** C#: `StoreReadabilityTests` `ADanglingFileLinkIsAnIoErrorOnOpenNotAnEmptyStore` :208, `ADanglingDirectoryLinkIsAnIoErrorOnOpenNotAnEmptyStore` :185, and the commit variants :196, :219. Mesh: `ADanglingLinkIsAnIoErrorOnTypedWriteRawWriteAndReadNeverAMissingFile` :107 and `OnlyNothingAtThePathIsAMissingFile` :134 (`CultMeshSingleFileStoreTests.cs`). Rust: `a_dangling_symlink_at_the_store_path_is_an_error_and_nothing_is_written` RS:5832. TS: "readStoreBytes reports nothing at the path only when the lstat finds nothing too".
|
||||||
- **Known gaps.** The writer no longer tolerates a dangling link: the reader's refusal stands for every write, whole-store `pushAll` included (Rust `a_push_all_through_a_dangling_link_is_refused_like_push_and_writes_nothing`, TS `a pushAll through a dangling link is refused like push`; `variants:follow_up:writer-dangling-link-tolerance`). What a replace does to a live link is `variants:follow_up:store-replace-cut` item 2. Windows junction behavior was proven at `42f05f66` and `b1ff2dcb`, not at the final head.
|
- **Known gaps.** The writer side still tolerates a dangling link: Rust `write_all_unlocked` RS:992-996 and TS `pushAll` TS:94-100 replace it on a whole-store write (`variants:follow_up:writer-dangling-link-tolerance`, owner `c2a-write-set`). What a replace does to a live link is `variants:follow_up:store-replace-cut` item 2. Windows junction behavior was proven at `42f05f66` and `b1ff2dcb`, not at the final head.
|
||||||
|
|
||||||
### C. Zero-byte file
|
### C. Zero-byte file
|
||||||
|
|
||||||
|
|
@ -1672,7 +1672,7 @@ The one door per runtime, and who walks through it:
|
||||||
- **Shared paths.** TS `pushAll` and Rust `push_all` only.
|
- **Shared paths.** TS `pushAll` and Rust `push_all` only.
|
||||||
- **Cut line.** `merge-r1` h4 (TS) and h6 (Rust).
|
- **Cut line.** `merge-r1` h4 (TS) and h6 (Rust).
|
||||||
- **Pinned by.** The manifest walks run a soft flush over every vector in TS (the `softPushAll` operation, TS test :2336) and Rust (`soft_push_all`, RS:5149), each with an absent and a dangling-link case; `a_soft_push_all_writes_where_nothing_is_and_refuses_a_dangling_link` RS:6019.
|
- **Pinned by.** The manifest walks run a soft flush over every vector in TS (the `softPushAll` operation, TS test :2336) and Rust (`soft_push_all`, RS:5149), each with an absent and a dangling-link case; `a_soft_push_all_writes_where_nothing_is_and_refuses_a_dangling_link` RS:6019.
|
||||||
- **Known gaps.** C# and Python have no soft decision, and the C# Mesh flag is dead; no follow-up is registered (h6 `undone` names it). `writer-dangling-link-tolerance` is settled: the non-soft branch refuses a dangling link too.
|
- **Known gaps.** C# and Python have no soft decision, and the C# Mesh flag is dead; no follow-up is registered (h6 `undone` names it). `writer-dangling-link-tolerance` applies to the non-soft branch.
|
||||||
|
|
||||||
### What no cut owns yet
|
### What no cut owns yet
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -3,7 +3,7 @@
|
||||||
CultLib measures its C# test suites with Stryker.NET, pinned as a repo-local
|
CultLib measures its C# test suites with Stryker.NET, pinned as a repo-local
|
||||||
tool in `dotnet-tools.json`. Coverage is added project by project; a project
|
tool in `dotnet-tools.json`. Coverage is added project by project; a project
|
||||||
with no `stryker-config.json` next to its test project has not been scoped
|
with no `stryker-config.json` next to its test project has not been scoped
|
||||||
yet (see "Scope and follow-ups" below for what's outstanding).
|
yet (see "Follow-ups" below for what's outstanding).
|
||||||
|
|
||||||
## Running it
|
## Running it
|
||||||
|
|
||||||
|
|
@ -126,17 +126,14 @@ project as precedent for the `vstest` caveat itself - that caveat is
|
||||||
`mtp`-runner-specific and documented above for `static readonly` field
|
`mtp`-runner-specific and documented above for `static readonly` field
|
||||||
initializers, and GameCult.Geometry has never actually hit it.
|
initializers, and GameCult.Geometry has never actually hit it.
|
||||||
|
|
||||||
## Scope and follow-ups
|
## Follow-ups
|
||||||
|
|
||||||
CultMath.Tests, GameCult.Geometry.Tests and GameCult.Caching.Tests are the
|
CultMath.Tests and GameCult.Geometry.Tests are the only projects currently
|
||||||
projects currently scoped. GameCult.Geometry's `stryker-config.json` has no
|
scoped. GameCult.Geometry's `stryker-config.json` has no `test-runner`
|
||||||
`test-runner` entry: the project is NUnit 4 with `NUnit3TestAdapter` and
|
entry: the project is NUnit 4 with `NUnit3TestAdapter` and
|
||||||
`Microsoft.NET.Test.Sdk`, so Stryker's default `vstest` runner applies
|
`Microsoft.NET.Test.Sdk`, so Stryker's default `vstest` runner applies
|
||||||
directly (no `mtp` workaround needed, unlike CultMath.Tests's xunit.v3
|
directly (no `mtp` workaround needed, unlike CultMath.Tests's xunit.v3
|
||||||
suite). GameCult.Caching.Tests is the same shape (NUnit, default `vstest`)
|
suite).
|
||||||
and its `stryker-config.json` is driven the same way, by the repo-local
|
|
||||||
`dotnet-stryker` tool: `dotnet tool restore` once, then `dotnet tool run
|
|
||||||
dotnet-stryker` from `tests/GameCult.Caching.Tests`.
|
|
||||||
|
|
||||||
GameCult.Geometry has only ever been run `--since:`-scoped to the cut that
|
GameCult.Geometry has only ever been run `--since:`-scoped to the cut that
|
||||||
added surface nets; a full-project baseline (running mutation against all of
|
added surface nets; a full-project baseline (running mutation against all of
|
||||||
|
|
@ -154,83 +151,7 @@ file, anything under `Fixtures/`) loses `--since` line-level scoping for that
|
||||||
run; a future cut whose diff is C#-only, against a base commit that already
|
run; a future cut whose diff is C#-only, against a base commit that already
|
||||||
has `stryker-config.json`, should scope correctly.
|
has `stryker-config.json`, should scope correctly.
|
||||||
|
|
||||||
### GameCult.Caching.Tests
|
`GameCult.Caching`, `GameCult.Mesh` (+ `.Quic`, `.Quic.Native`),
|
||||||
|
|
||||||
`tests/GameCult.Caching.Tests/stryker-config.json` mutates all of
|
|
||||||
`src/GameCult.Caching` (the project is `GameCult.Caching.csproj`; Standard
|
|
||||||
mutation level, `break` 0, the same thresholds as Geometry). Caching was
|
|
||||||
scoped before Networking because its suite is deterministic and quick (1415
|
|
||||||
tests, about 40 s) over about 7.8k lines of source, where GameCult.Networking
|
|
||||||
is about 20k lines and its tests lean on socket timing, so a mutant timing out
|
|
||||||
there says little about the test. A full Caching run is about 2,900 candidate
|
|
||||||
mutants (3,602 created, minus 730 that fail to compile) at 1.25 to 1.6 s
|
|
||||||
each, so about 1 to 1.3 hours; run it detached and read the JSON report,
|
|
||||||
never as one attached session.
|
|
||||||
|
|
||||||
The first measurement was a narrow pass over the three files that carry the
|
|
||||||
store-replace and element-id machinery, from `tests/GameCult.Caching.Tests`:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
dotnet tool run dotnet-stryker \
|
|
||||||
-m '**/src/GameCult.Caching/StoreReplace.cs' \
|
|
||||||
-m '**/src/GameCult.Caching/CultStoreLinks.cs' \
|
|
||||||
-m '**/src/GameCult.Caching/CultElementIds.cs'
|
|
||||||
```
|
|
||||||
|
|
||||||
A clean single run of that command tests 243 to 265 mutants (the count moves with the revision) and scored 85.28% on
|
|
||||||
568a60fa, before any test of this scope was added; 86.79% on d38b5728, with
|
|
||||||
the first batch of tests; and 87.17% on 76d9e7d1, with the throwing-enumerator
|
|
||||||
case, in about 10 minutes. The first measurement of it overlapped two Stryker
|
|
||||||
runs, so its numbers (and the 114 survivors it showed for `CultElementIds.cs`,
|
|
||||||
where tests that kill a mutant by hand reported `Survived` or `Timeout`) are
|
|
||||||
not measurements and are not quoted here. Never run two Stryker runs against
|
|
||||||
one checkout at once, and check `ps` before starting one. A clean single run
|
|
||||||
on `CultElementIds.cs` alone, after the tests below, tested 228 mutants: 208
|
|
||||||
`Killed`, 8 `Timeout`, 12 `Survived`, a score of 94.74%. The 12th survivor
|
|
||||||
was 321, which the throwing-enumerator case in `ListsOfValuesHoldNoIds` now
|
|
||||||
kills; the other 11 are equivalent mutants. With that case a clean single run
|
|
||||||
on `CultElementIds.cs` is 209 `Killed`, 8 `Timeout`, 11 `Survived`, 95.18%.
|
|
||||||
|
|
||||||
Real gaps that run exposed, each now pinned by `ElementIdWalkTests` (and each
|
|
||||||
failing when its mutant is applied by hand): the order of the id path (the
|
|
||||||
codec refuses at the first type MessagePack cannot allow, so order is what an
|
|
||||||
error names first; `Append` to `Prepend` at 163, 167 and 180); the
|
|
||||||
union-cycle guard in `ConcreteTypes` (248; the mutant is a stack overflow, so
|
|
||||||
the red is a crashed test host: a depth guard would need production code in
|
|
||||||
`ConcreteTypes`, since the recursion is private and a stack overflow cannot be
|
|
||||||
caught by the test, so the regression test is left to crash loudly); a list of values reporting that it holds an
|
|
||||||
id (`Holds`, 322); `[Key]` read through an override (`KeyOf`, 583); and the
|
|
||||||
`IsWrittenWhole` and `IsKeyed` predicates (629 to 631 and 636: formatter,
|
|
||||||
`[MessagePackObject]` and `KeyAsPropertyName` inherited from a base, and the
|
|
||||||
`[DataContract]` without `[MessagePackObject]` and `||` arms).
|
|
||||||
|
|
||||||
Equivalent survivors in `CultElementIds.cs` (11), each hand-checked against the full
|
|
||||||
suite; none can be told apart by any test:
|
|
||||||
|
|
||||||
- 142, 251, 636 (second arm), 506 (`IsDefined(UnionAttribute, false)` to
|
|
||||||
`true`): `UnionAttribute` is `Inherited = false`, so its `inherit` argument
|
|
||||||
changes nothing. Likewise 630's `DataContractAttribute` `inherit` argument
|
|
||||||
(`DataContractAttribute` is `Inherited = false`).
|
|
||||||
- 264, 542: `group.First()` to `FirstOrDefault()` over `GroupBy` groups, which
|
|
||||||
are never empty.
|
|
||||||
- 491: `new StringBuilder(bytes.Length * 2)` to `/ 2` changes only the initial
|
|
||||||
capacity.
|
|
||||||
- 578: removing the `Nullable.GetUnderlyingType` unwrap in `WalksAsOwner`;
|
|
||||||
`Classify` unwraps nullables itself, so the unwrap is dead. A cut
|
|
||||||
candidate, not a test gap.
|
|
||||||
- 645, 657: `Append(type)` to `Prepend(type)` in `ElementTypeOf` and
|
|
||||||
`MapTypes`; `type` matches only when it is itself `IEnumerable<>`,
|
|
||||||
`IDictionary<,>` or `IReadOnlyDictionary<,>`, and none of those has a second
|
|
||||||
matching interface, so the position of `type` never decides the answer.
|
|
||||||
|
|
||||||
The Windows-only P/Invoke group is exercised only on Windows: its mutants are
|
|
||||||
`NoCoverage` on Linux and are a target for a Windows-leg mutation run, not a
|
|
||||||
Linux gap or a finding. `StoreReplace.cs` line 45 is a different case: its
|
|
||||||
negated `IsOSPlatform(Windows)` mutant is `Survived` on Linux, because the
|
|
||||||
negated branch calls `ReplaceWindows`, whose `DllNotFound` fallback gives the
|
|
||||||
same result.
|
|
||||||
|
|
||||||
`GameCult.Mesh` (+ `.Quic`, `.Quic.Native`),
|
|
||||||
`GameCult.Networking` (+ `.WebSockets`), and the non-.NET runtimes
|
`GameCult.Networking` (+ `.WebSockets`), and the non-.NET runtimes
|
||||||
(`cultcache-rs/py/ts`, `cultmesh-*`, `cultnet-*`) each still need their own
|
(`cultcache-rs/py/ts`, `cultmesh-*`, `cultnet-*`) each still need their own
|
||||||
`stryker-config.json` (or ecosystem-equivalent tool: `cargo-mutants` for
|
`stryker-config.json` (or ecosystem-equivalent tool: `cargo-mutants` for
|
||||||
|
|
|
||||||
|
|
@ -16,10 +16,10 @@ this page.
|
||||||
|
|
||||||
| | CultCache | CultMath | Geometry | CultNet | CultMesh |
|
| | CultCache | CultMath | Geometry | CultNet | CultMesh |
|
||||||
| --- | --- | --- | --- | --- | --- |
|
| --- | --- | --- | --- | --- | --- |
|
||||||
| **C#** | [first call, tested](#c-first-call); [update, tested](#c-update-with-retry) | [package](../../packages/cultmath/README.md); snippet not yet | [package](../../src/GameCult.Geometry/README.md); snippet not yet | [first call, tested](#c-cultnet-first-call); [package](../../src/GameCult.Networking) | [quickstart](../../src/GameCult.Mesh/docs/durable-node-quickstart.md); run by `scripts/verify-eve-getting-started.ps1` |
|
| **C#** | [first call, tested](#c-first-call) | [package](../../packages/cultmath/README.md); snippet not yet | [package](../../src/GameCult.Geometry/README.md); snippet not yet | [first call, tested](#c-cultnet-first-call); [package](../../src/GameCult.Networking) | [quickstart](../../src/GameCult.Mesh/docs/durable-node-quickstart.md); run by `scripts/verify-eve-getting-started.ps1` |
|
||||||
| **TypeScript** | [first call, tested](#typescript-first-call); [update, tested](#typescript-update-with-retry) | not yet | not yet | [first call, tested](#typescript-cultnet-first-call); [package](../../packages/cultnet-ts/README.md) | [package](../../packages/cultmesh-ts/README.md); snippet not yet; [recipe: two-client .io game](io-game.md), tested with two live clients, browser page not yet run |
|
| **TypeScript** | [first call, tested](#typescript-first-call) | not yet | not yet | [first call, tested](#typescript-cultnet-first-call); [package](../../packages/cultnet-ts/README.md) | [package](../../packages/cultmesh-ts/README.md); snippet not yet; [recipe: two-client .io game](io-game.md), tested with two live clients, browser page not yet run |
|
||||||
| **Rust** | [first call, tested](#rust-first-call); [update, tested](#rust-update-with-retry) | [native core](../../packages/cultmath/native/cultmath-core); snippet not yet | not yet | [first call, tested](#rust-cultnet-first-call); [package](../../packages/cultnet-rs/README.md), [examples](../../packages/cultnet-rs/examples) | [package](../../packages/cultmesh-rs); snippet not yet |
|
| **Rust** | [first call, tested](#rust-first-call) | [native core](../../packages/cultmath/native/cultmath-core); snippet not yet | not yet | [first call, tested](#rust-cultnet-first-call); [package](../../packages/cultnet-rs/README.md), [examples](../../packages/cultnet-rs/examples) | [package](../../packages/cultmesh-rs); snippet not yet |
|
||||||
| **Python** | [first call, tested](#python-first-call); [update, tested](#python-update-with-retry) | not yet | not yet | [first call, tested](#python-cultnet-first-call); [package](../../packages/cultnet-py/README.md) | [package](../../packages/cultmesh-py/README.md); snippet not yet |
|
| **Python** | [first call, tested](#python-first-call) | not yet | not yet | [first call, tested](#python-cultnet-first-call); [package](../../packages/cultnet-py/README.md) | [package](../../packages/cultmesh-py/README.md); snippet not yet |
|
||||||
|
|
||||||
For the whole
|
For the whole
|
||||||
picture of what each piece is for, see the
|
picture of what each piece is for, see the
|
||||||
|
|
@ -70,37 +70,6 @@ public static class FirstCall
|
||||||
|
|
||||||
`FirstCall.Run` is the call; a second test in that file fails if the block above stops matching it. More: `src/GameCult.Caching/README.md`.
|
`FirstCall.Run` is the call; a second test in that file fails if the block above stops matching it. More: `src/GameCult.Caching/README.md`.
|
||||||
|
|
||||||
## C# update with retry
|
|
||||||
|
|
||||||
Change a record you may not be the only one changing. `Update` reads the record as its store holds it, hands your function a fresh
|
|
||||||
copy of it, and commits the result only if the record is still the one it read. If another writer got there first, it
|
|
||||||
reads again and runs your function again, up to five times. The source is
|
|
||||||
[`tests/GameCult.Caching.Tests/UpdateCallTests.cs`](../../tests/GameCult.Caching.Tests/UpdateCallTests.cs); the
|
|
||||||
snippet reuses `Item` from the first call.
|
|
||||||
|
|
||||||
```csharp
|
|
||||||
using GameCult.Caching;
|
|
||||||
using GameCult.Caching.MessagePack;
|
|
||||||
|
|
||||||
public static class UpdateCall
|
|
||||||
{
|
|
||||||
public static CultUpdateResult<Item> Restock(string path, CultRecordKey key)
|
|
||||||
{
|
|
||||||
var cache = CultCacheMessagePack.Create(path);
|
|
||||||
return cache.Update<Item>(key, item =>
|
|
||||||
{
|
|
||||||
item ??= new Item { Name = "Potion", Category = "Consumable" };
|
|
||||||
item.Value += 10;
|
|
||||||
return item;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
The write is durable when `Update` returns, with no `PushAll`. A lost race re-runs the function, so keep it free of
|
|
||||||
side effects; when the attempts run out the result says `LostRace` instead of throwing. `UpsertAsync` plus
|
|
||||||
`PushAll` is the blind opt-out: last writer wins.
|
|
||||||
|
|
||||||
## TypeScript first call
|
## TypeScript first call
|
||||||
|
|
||||||
Same shape in TypeScript: the document is a name, a schema id and a `parse`-able schema (zod here),
|
Same shape in TypeScript: the document is a name, a schema id and a `parse`-able schema (zod here),
|
||||||
|
|
@ -150,36 +119,12 @@ async function firstCall(path: string) {
|
||||||
The test imports from `../src/index` where the block reads `@gamecult/cultcache-ts`; a second test in that file fails if the block stops matching the rest. More:
|
The test imports from `../src/index` where the block reads `@gamecult/cultcache-ts`; a second test in that file fails if the block stops matching the rest. More:
|
||||||
`packages/cultcache-ts/README.md`.
|
`packages/cultcache-ts/README.md`.
|
||||||
|
|
||||||
## TypeScript update with retry
|
|
||||||
|
|
||||||
`update` changes a record from what the store holds now and commits only if it is still that record. The source is the
|
|
||||||
second region of
|
|
||||||
[`packages/cultcache-ts/test/first-call.test.ts`](../../packages/cultcache-ts/test/first-call.test.ts), which uses the
|
|
||||||
definitions of the first call above; a test in that file fails if the block stops matching the file.
|
|
||||||
|
|
||||||
```ts
|
|
||||||
async function restock(path: string) {
|
|
||||||
const cache = CultCache.builder()
|
|
||||||
.withRegistry(registry)
|
|
||||||
.withGenericStore(new SingleFileMessagePackBackingStore(path))
|
|
||||||
.build();
|
|
||||||
await cache.pullAllBackingStores();
|
|
||||||
return cache.update(itemDocument, "item:potion", (item) => {
|
|
||||||
const current = item ?? { name: "Potion", category: "Consumable", value: 0 };
|
|
||||||
return { ...current, value: current.value + 10 };
|
|
||||||
});
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
The write is durable when the promise resolves. A lost race re-runs the function, so keep it free of side effects; when the
|
|
||||||
attempts run out the result says `lostRace` instead of throwing. `put` is the blind opt-out: last writer wins.
|
|
||||||
|
|
||||||
## Rust first call
|
## Rust first call
|
||||||
|
|
||||||
Same shape with `derive(DatabaseEntry)`: slots are `#[cultcache(key = N)]`, so the `.cc` payload is the
|
Same shape with `derive(DatabaseEntry)`: slots are `#[cultcache(key = N)]`, so the `.cc` payload is the
|
||||||
slot-indexed array the C# runtime writes. The source is
|
slot-indexed array the C# runtime writes. The source is
|
||||||
[`packages/cultcache-rs/tests/first_call.rs`](../../packages/cultcache-rs/tests/first_call.rs), run by
|
[`packages/cultcache-rs/tests/first_call.rs`](../../packages/cultcache-rs/tests/first_call.rs), run by
|
||||||
`cargo test --locked --test first_call` in `packages/cultcache-rs`; a second test in that file fails if the block
|
`cargo test --test first_call` in `packages/cultcache-rs`; a second test in that file fails if the block
|
||||||
below stops matching the file. The Rust runtime has no name lookup, so the read-back is by key. More:
|
below stops matching the file. The Rust runtime has no name lookup, so the read-back is by key. More:
|
||||||
`packages/cultcache-rs/README.md`.
|
`packages/cultcache-rs/README.md`.
|
||||||
|
|
||||||
|
|
@ -220,36 +165,6 @@ fn first_call() -> anyhow::Result<()> {
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
## Rust update with retry
|
|
||||||
|
|
||||||
`update` changes a record from what the store holds now and commits only if it is still that record. The source is the
|
|
||||||
second region of
|
|
||||||
[`packages/cultcache-rs/tests/first_call.rs`](../../packages/cultcache-rs/tests/first_call.rs), which uses the `Item` of
|
|
||||||
the first call above; a test in that file fails if the block stops matching the file.
|
|
||||||
|
|
||||||
```rust
|
|
||||||
fn restock(path: &Path) -> anyhow::Result<CultUpdateResult<Item>> {
|
|
||||||
let mut cache = CultCache::new();
|
|
||||||
cache.register_entry_type::<Item>()?;
|
|
||||||
cache.add_generic_backing_store(SingleFileMessagePackBackingStore::new(path))?;
|
|
||||||
cache.pull_all_backing_stores()?;
|
|
||||||
cache.update::<Item, _>("item:potion", |item| {
|
|
||||||
// The store's copy of the record, or nothing if it has none; this may run again on a lost race.
|
|
||||||
let mut item = item.unwrap_or(Item {
|
|
||||||
name: "Potion".to_string(),
|
|
||||||
category: "Consumable".to_string(),
|
|
||||||
value: 0,
|
|
||||||
});
|
|
||||||
item.value += 10;
|
|
||||||
Some(item)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
The write is durable when `update` returns. A lost race re-runs the closure, so keep it free of side effects; when the
|
|
||||||
attempts run out (five, or the bound `update_with_attempts` takes) the outcome says `LostRace` instead of failing, and
|
|
||||||
returning `None` writes nothing and says `Declined`. `put` is the blind opt-out: last writer wins.
|
|
||||||
|
|
||||||
## Python first call
|
## Python first call
|
||||||
|
|
||||||
A document is a definition with an encoder and decoder; `name=` registers the name lookup, `indexes=` unique lookups and
|
A document is a definition with an encoder and decoder; `name=` registers the name lookup, `indexes=` unique lookups and
|
||||||
|
|
@ -305,29 +220,6 @@ def first_call() -> Item:
|
||||||
return reopened.get_required(item_doc, "item:potion")
|
return reopened.get_required(item_doc, "item:potion")
|
||||||
```
|
```
|
||||||
|
|
||||||
## Python update with retry
|
|
||||||
|
|
||||||
`update` changes a record from what the store holds now and commits only if it is still that record. The source is the
|
|
||||||
`update` region of
|
|
||||||
[`packages/cultcache-py/tests/test_first_call.py`](../../packages/cultcache-py/tests/test_first_call.py), which uses the
|
|
||||||
definitions of the first call above; a test in that file fails if the block stops matching the file.
|
|
||||||
|
|
||||||
```python
|
|
||||||
def restock(path: Path):
|
|
||||||
cache = (
|
|
||||||
CultCache.builder()
|
|
||||||
.register_document_type(item_doc)
|
|
||||||
.add_generic_store(SingleFileMessagePackBackingStore(path))
|
|
||||||
.build()
|
|
||||||
)
|
|
||||||
cache.pull_all_backing_stores()
|
|
||||||
return cache.update(item_doc, "item:potion", lambda item: Item("Potion", "Consumable", (item.value if item else 0) + 10))
|
|
||||||
```
|
|
||||||
|
|
||||||
The write is durable when `update` returns. A lost race re-runs the function, so keep it free of side effects; when the
|
|
||||||
attempts run out the result's `outcome` is `UpdateOutcome.LOST_RACE` instead of a raise. `put` is the blind opt-out: last
|
|
||||||
writer wins.
|
|
||||||
|
|
||||||
## CultNet first calls
|
## CultNet first calls
|
||||||
|
|
||||||
CultNet is schema-v0 messages in length-prefixed frames. The first call in each runtime is the same
|
CultNet is schema-v0 messages in length-prefixed frames. The first call in each runtime is the same
|
||||||
|
|
@ -449,7 +341,7 @@ async function firstCall() {
|
||||||
### Rust CultNet first call
|
### Rust CultNet first call
|
||||||
|
|
||||||
Source: [`packages/cultnet-rs/tests/first_call.rs`](../../packages/cultnet-rs/tests/first_call.rs), run by
|
Source: [`packages/cultnet-rs/tests/first_call.rs`](../../packages/cultnet-rs/tests/first_call.rs), run by
|
||||||
`cargo test --locked --test first_call` in `packages/cultnet-rs`. More: `packages/cultnet-rs/README.md`.
|
`cargo test --test first_call` in `packages/cultnet-rs`. More: `packages/cultnet-rs/README.md`.
|
||||||
|
|
||||||
```rust
|
```rust
|
||||||
use std::net::{TcpListener, TcpStream};
|
use std::net::{TcpListener, TcpStream};
|
||||||
|
|
|
||||||
|
|
@ -107,8 +107,8 @@ Authority map (also in the spec):
|
||||||
- `variants:follow_up:public-store-writes-behind-cache`: **leave**. It asks who may stage behind an attached cache (API
|
- `variants:follow_up:public-store-writes-behind-cache`: **leave**. It asks who may stage behind an attached cache (API
|
||||||
shape); this cut changes what any staging is judged by. No collision: direct `Push`/`CommitBatch` reach the same on-disk
|
shape); this cut changes what any staging is judged by. No collision: direct `Push`/`CommitBatch` reach the same on-disk
|
||||||
judge, so they get the per-key rule for free. Hands must not give direct staging a different predicate.
|
judge, so they get the per-key rule for free. Hands must not give direct staging a different predicate.
|
||||||
- `variants:follow_up:writer-dangling-link-tolerance`: **settled** (the reader owns the verdict; every runtime's whole-store
|
- `variants:follow_up:writer-dangling-link-tolerance`: **leave**. Rust/TS whole-store `push_all` reading a dangling link is
|
||||||
`push_all` refuses a dangling link, as `push` does).
|
a reader/writer tolerance question, not ownership; this cut touches no leaf.
|
||||||
|
|
||||||
## Deferred doc findings this cut fixes
|
## Deferred doc findings this cut fixes
|
||||||
|
|
||||||
|
|
|
||||||
6
package-lock.json
generated
6
package-lock.json
generated
|
|
@ -1205,7 +1205,7 @@
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@gamecult/cultcache-ts": "^0.15.0",
|
"@gamecult/cultcache-ts": "^0.15.0",
|
||||||
"@gamecult/cultnet-ts": "^0.4.0"
|
"@gamecult/cultnet-ts": "^0.3.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@gamecult/cultmesh-ts": "^0.2.0",
|
"@gamecult/cultmesh-ts": "^0.2.0",
|
||||||
|
|
@ -1222,7 +1222,7 @@
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@gamecult/cultcache-ts": "^0.15.0",
|
"@gamecult/cultcache-ts": "^0.15.0",
|
||||||
"@gamecult/cultnet-ts": "^0.4.0",
|
"@gamecult/cultnet-ts": "^0.3.0",
|
||||||
"koffi": "3.3.0"
|
"koffi": "3.3.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
|
|
@ -1236,7 +1236,7 @@
|
||||||
},
|
},
|
||||||
"packages/cultnet-ts": {
|
"packages/cultnet-ts": {
|
||||||
"name": "@gamecult/cultnet-ts",
|
"name": "@gamecult/cultnet-ts",
|
||||||
"version": "0.4.0",
|
"version": "0.3.0",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@gamecult/cultcache-ts": "^0.15.0",
|
"@gamecult/cultcache-ts": "^0.15.0",
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build:ts": "node scripts/run-typescript-workspaces.mjs build",
|
"build:ts": "node scripts/run-typescript-workspaces.mjs build",
|
||||||
"test:ts": "node scripts/run-typescript-workspaces.mjs test",
|
"test:ts": "node scripts/run-typescript-workspaces.mjs test",
|
||||||
"test:pack:ts": "node --test scripts/test-declared-dependency-ranges.test.mjs && node scripts/test-typescript-package-closure.mjs && node scripts/test-declared-dependency-ranges.mjs",
|
"test:pack:ts": "node scripts/test-typescript-package-closure.mjs && node scripts/test-declared-dependency-ranges.mjs",
|
||||||
"test:eve-browser-network": "node scripts/verify-eve-browser-network.mjs"
|
"test:eve-browser-network": "node scripts/verify-eve-browser-network.mjs"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
|
|
|
||||||
|
|
@ -2,31 +2,17 @@
|
||||||
|
|
||||||
## Unreleased
|
## Unreleased
|
||||||
|
|
||||||
### Changed
|
|
||||||
|
|
||||||
- `parse_stored_at` (was `_parse_stored_at`) is public: cultmesh-py judges a peer's `storedAt` by it. A peer's `document_put_raw` whose `storedAt` is missing, empty or not a stamp is refused `message_invalid` (field `document`) and nothing is minted or stored (variants:ruling:raw-put-without-stamp-refused). A subscribed server's stampless put now raises `ValueError` from `CultMeshClient.read_next_change` instead of being stored under a minted stamp.
|
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- `CultCache.update` and `update_global` return `UpdateResult(outcome, document)`; `UpdateOutcome` is `UPDATED`, `DECLINED` or `LOST_RACE`. The single-file store gains `read(key)` (the record and its content version, the SHA-256 C# computes) and `commit_if(envelope, expected)`, the version is the SHA-256 of the record re-encoded as `[key, schemaId, storedAt, payload]` with minimal MessagePack encodings, which is the SHA-256 of the record's stored bytes exactly when the writer encoded it minimally (every writer in this library does; a record another writer encoded with a wider-than-needed length or integer has the version of its minimal form, not of its bytes). Both looked up by the cache and not `BackingStore` protocol members (variants:cut_spec:cut-update-with-retry-py).
|
|
||||||
- `read_payload_tree(type_name, payload, decoder=None)`: the exported owner of the one-value, depth-first payload read that `decode_payload` uses, for payloads read outside a definition (`cultnet-py`'s witness bundle decode needs it, so `cultnet-py` now requires `cultcache-py>=0.4.0`). The manifest version is 0.4.0, the minor these Unreleased breaking changes imply, set in this change so the workspace install resolves the new bound; the `## Unreleased` heading becomes `## [0.4.0]` when it is tagged.
|
- `read_payload_tree(type_name, payload, decoder=None)`: the exported owner of the one-value, depth-first payload read that `decode_payload` uses, for payloads read outside a definition (`cultnet-py`'s witness bundle decode needs it, so `cultnet-py` now requires `cultcache-py>=0.4.0`). The manifest version is 0.4.0, the minor these Unreleased breaking changes imply, set in this change so the workspace install resolves the new bound; the `## Unreleased` heading becomes `## [0.4.0]` when it is tagged.
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
|
||||||
- A write that replaces a record is stored at a later `stored_at` than the record it replaces, in the single-file store, the JSONL store and a store-less cache, with no exception for identical content (`variants:ruling:py-rs-update-follow-csharp-restamp`); the cache holds the stamp the store wrote. A stored_at is read only in the shape the runtimes write (an RFC 3339 date-time with T, a fraction of 1 to 9 digits, Z or a numeric offset), the same on every Python; any other text, or an instant outside `datetime`'s range, is not a stamp and a write over it is stamped at now. A write over a record stamped at the last instant `datetime` can hold (9999-12-31T23:59:59.999999Z) is refused with `ValueError` and writes nothing.
|
|
||||||
- `store_write_lock` looks for a link at the store path again once the lock is held, so a link put at the path while a writer waited on the lock is refused with `StoreLinkedError` and the lock released, instead of being replaced. `JsonLinesBackingStore` takes no cross-process lock (only its thread lock, under which it already refuses a link), so it has no lock wait to re-check across. Pinned by a test that puts the link while a foreign process holds the lock.
|
|
||||||
- `CultCache.is_writable` does not look at store paths: a link at a store path is not predicted, and the write refuses it with `StoreLinkedError`. Pinned by a test through a cache attached to a linked store.
|
|
||||||
- `JsonLinesBackingStore` writes LF line endings on Windows. It wrote CRLF there, through `write_text` newline translation, before the commit_store_file change (#154, adbbb780).
|
|
||||||
- `msgpack` is a hard dependency, as `pyproject.toml` declared it. The optional-import fallbacks and the `cultcache-py[msgpack]` extra they named (which never existed) are gone: a missing msgpack is an `ImportError` at import.
|
- `msgpack` is a hard dependency, as `pyproject.toml` declared it. The optional-import fallbacks and the `cultcache-py[msgpack]` extra they named (which never existed) are gone: a missing msgpack is an `ImportError` at import.
|
||||||
- `JsonLinesBackingStore` writes through the same `commit_store_file` as the single-file store: a unique staged file, fsynced before the replace and removed when the replace fails, so a refused replace no longer leaves `<path>.tmp` behind. It staged a fixed `<path>.tmp` without an fsync.
|
|
||||||
- The single-file store's `push`, `push_all` and `delete` take the cross-process lock on `<path>.lock` (flock; LockFileEx over the whole file on Windows) across the read and the replace, waiting up to `lock_timeout` seconds (30 by default, `TimeoutError` after), and exclude the C#, Rust and TypeScript runtimes' writers. The staged file is `<path>.tmp-<pid>-<uuid>`, fsynced before the replace, with a directory fsync after it off Windows. A fixed `<path>.tmp` is no longer used.
|
- The single-file store's `push`, `push_all` and `delete` take the cross-process lock on `<path>.lock` (flock; LockFileEx over the whole file on Windows) across the read and the replace, waiting up to `lock_timeout` seconds (30 by default, `TimeoutError` after), and exclude the C#, Rust and TypeScript runtimes' writers. The staged file is `<path>.tmp-<pid>-<uuid>`, fsynced before the replace, with a directory fsync after it off Windows. A fixed `<path>.tmp` is no longer used.
|
||||||
|
|
||||||
### Breaking
|
### Breaking
|
||||||
|
|
||||||
- `update(document, key, apply, *, max_attempts=5)` and `update_global(document, apply, *, max_attempts=5)` replace the blind pair. Each attempt reads the record from the home store, runs `apply` on a copy (None when absent) outside every lock, and commits only if the record is unchanged, running `apply` again on a lost race; it returns `UpdateResult`, not the value. `apply` returning None writes nothing; a lost race that outlasts `max_attempts` returns `LOST_RACE`; a store without `read` and `commit_if` (JSON lines among them) refuses before `apply`. `put` is the blind write.
|
|
||||||
- `push` returns the `stored_at` it wrote and `push_all` a dict of them by key (`{}` when a soft push skipped); a store returning None keeps the cache's own stamp.
|
|
||||||
- `push_all(envelopes, soft=False)` on the single-file and JSONL stores and on the `BackingStore` protocol takes the soft flag, as TypeScript, Rust and C# do: a soft push writes only where nothing is at the path; over a store the reader reads, empty included, it returns without writing, and over a file the reader cannot read it refuses (`StoreUnreadableError` for the single-file store). The `BackingStore` protocol has `pull_or_absent()`: the envelopes the reader reads, `None` when nothing is at the path, a raise when the path cannot be read; its default is `pull_all()`, which cannot say absent, so a store that inherits it is always read. The default `push_all` decides soft by it (writes where it says absent, skips over a store it read, refuses where it raises), and the single-file and JSONL stores expose their pull through it; an inheriting store that can tell nothing-at-the-path overrides `pull_or_absent`, not `push_all`. Before, a soft push through the default always skipped. A store kind that overrides `push_all(envelopes)` without the keyword fails when a caller passes `soft`.
|
|
||||||
- A write at a store path that is a link, live or dangling, is refused with the new `StoreLinkedError` (an `OSError`, exported from `cultcache_py`; `.path` names the path) before the lock and the replace, for the single-file store and for `JsonLinesBackingStore` (`push`, `push_all`, `delete`), and nothing is written. Before, a write at a live link replaced the link with a regular file, and at a dangling link both stores raised `FileNotFoundError`. A caller catching `FileNotFoundError` there now catches `StoreLinkedError` (`OSError`); configure the link's target as the store path. On Windows a junction or any reparse point counts as a link. Reads through a live link work.
|
|
||||||
- A record whose payload carries a slot past its reader's declared slots, at any depth (the document, a nested record, a list element, a union arm, a unit arm), is read, held read-only, and every write or removal of its key (`put`, `put_global`, `update`, `put_envelope`, `put_envelopes`, `delete`, `delete_global`) is refused with `SchemaConflictError` before any store is touched (`cultlib-gaps:ruling:extra-trailing-slots`). Reading dropped those slots silently and the next write shed them. `SchemaConflictError.unread_slots` is an `UnreadSlots(type_name, slot_count, declared_count, occurrences, depth0_only)` and the message names the type and both counts, never a slot value. A depth-0 mark is consented, and the record writable, only when the record is stored under an id the document lists in `compatible_schema_ids` and that id's catalog entry has slots past the document's, covering the mark's slot count (`cultlib-gaps:ruling:slot-mark-consent`); a nested mark, or a mark under the document's own id, keeps the record read-only whatever is declared. Missing trailing slots keep their declared defaults. An untouched marked record keeps its stored bytes through every other write. Added `CultCache.is_writable(document, key)` (advisory; the write still decides: it also answers False for a foreign-carried key, for a key held as a type the document does not own, and for a global document at a non-global key; `delete` asks the same judges, so removing a key held as another type is refused with `SchemaConflictError` unless the document owns that record's schema id (its own or one it lists compatible), in which case the removal removes that record, its file row and its lookups, as a write of the key would replace it; it returned silently and removed nothing), `DocumentDefinition.decode_payload_marked`, and `UnreadSlots`. A document with a custom `decode` (no slot codec) never marks. A store holding a variant record is still unreadable here. Implies a minor bump while the version is 0.x (0.3.0 to 0.4.0): code that wrote back a record from a newer writer now gets `SchemaConflictError`.
|
- A record whose payload carries a slot past its reader's declared slots, at any depth (the document, a nested record, a list element, a union arm, a unit arm), is read, held read-only, and every write or removal of its key (`put`, `put_global`, `update`, `put_envelope`, `put_envelopes`, `delete`, `delete_global`) is refused with `SchemaConflictError` before any store is touched (`cultlib-gaps:ruling:extra-trailing-slots`). Reading dropped those slots silently and the next write shed them. `SchemaConflictError.unread_slots` is an `UnreadSlots(type_name, slot_count, declared_count, occurrences, depth0_only)` and the message names the type and both counts, never a slot value. A depth-0 mark is consented, and the record writable, only when the record is stored under an id the document lists in `compatible_schema_ids` and that id's catalog entry has slots past the document's, covering the mark's slot count (`cultlib-gaps:ruling:slot-mark-consent`); a nested mark, or a mark under the document's own id, keeps the record read-only whatever is declared. Missing trailing slots keep their declared defaults. An untouched marked record keeps its stored bytes through every other write. Added `CultCache.is_writable(document, key)` (advisory; the write still decides: it also answers False for a foreign-carried key, for a key held as a type the document does not own, and for a global document at a non-global key; `delete` asks the same judges, so removing a key held as another type is refused with `SchemaConflictError` unless the document owns that record's schema id (its own or one it lists compatible), in which case the removal removes that record, its file row and its lookups, as a write of the key would replace it; it returned silently and removed nothing), `DocumentDefinition.decode_payload_marked`, and `UnreadSlots`. A document with a custom `decode` (no slot codec) never marks. A store holding a variant record is still unreadable here. Implies a minor bump while the version is 0.x (0.3.0 to 0.4.0): code that wrote back a record from a newer writer now gets `SchemaConflictError`.
|
||||||
- A payload is one MessagePack value: `DocumentDefinition.decode_payload` refuses bytes after it, by count, with `ValueError` `<type> payload has N bytes after its first MessagePack value (refused on read).` (never the bytes, never the depth refusal; a payload that ends early stays the decoder's), as the C# reference does (`tests/vectors/union-parity/bytes-after-outcomes.msgpack`). It raised `msgpack.ExtraData` (a `ValueError`, so only a caller naming `msgpack.ExtraData` is affected); this is a minor-version bump while pre-1.0. The refused set is unchanged. Cache loads, `get` and every definition built on the MessagePack decoder go through it; a user `payload_decoder` that raises `ExtraData` is refused the same way. Depth is judged first, so a value nested past 256 with a tail is the depth refusal, as in C#.
|
- A payload is one MessagePack value: `DocumentDefinition.decode_payload` refuses bytes after it, by count, with `ValueError` `<type> payload has N bytes after its first MessagePack value (refused on read).` (never the bytes, never the depth refusal; a payload that ends early stays the decoder's), as the C# reference does (`tests/vectors/union-parity/bytes-after-outcomes.msgpack`). It raised `msgpack.ExtraData` (a `ValueError`, so only a caller naming `msgpack.ExtraData` is affected); this is a minor-version bump while pre-1.0. The refused set is unchanged. Cache loads, `get` and every definition built on the MessagePack decoder go through it; a user `payload_decoder` that raises `ExtraData` is refused the same way. Depth is judged first, so a value nested past 256 with a tail is the depth refusal, as in C#.
|
||||||
- A cache holds one record per key whatever its type (`variants:ruling:cache-refuses-retype`). A `put`, `put_envelope`, `put_envelopes` or `put_global` of a second type under a key the cache holds, or under a key a store carries foreign, is refused with `SchemaConflictError` naming the key, even with no store, and changes nothing; retype a key by deleting it, then putting the new type. A write may replace another registered type's record only when the written type owns its schema id (declares it or lists it compatible) and both types share one home store. A load that reads one key from two stores, whatever the types, is refused with `CultCacheError` naming the key and both types, and admits nothing. A store that holds a record no registered type claims now loads and is carried: the cache does not serve it, the store keeps its bytes through every write, `delete` or `put` at its key is refused with `SchemaConflictError`, and registering a type that declares its schema id claims it at the next load. It raised `CultCacheError` "Unknown persisted document type". Two global types share the key `__global__`, so a second global type in one cache is now refused, and a store that already holds two global types at `__global__` (a JSONL store written by caches that never pulled could produce one) no longer loads: the pull raises `CultCacheError` and admits nothing. C# refuses a second persisted global on pull the same way (`cultcache-store-composition.md`, "Globals never invented"); repair such a file by deleting one of the two records with the runtime that wrote it.
|
- A cache holds one record per key whatever its type (`variants:ruling:cache-refuses-retype`). A `put`, `put_envelope`, `put_envelopes` or `put_global` of a second type under a key the cache holds, or under a key a store carries foreign, is refused with `SchemaConflictError` naming the key, even with no store, and changes nothing; retype a key by deleting it, then putting the new type. A write may replace another registered type's record only when the written type owns its schema id (declares it or lists it compatible) and both types share one home store. A load that reads one key from two stores, whatever the types, is refused with `CultCacheError` naming the key and both types, and admits nothing. A store that holds a record no registered type claims now loads and is carried: the cache does not serve it, the store keeps its bytes through every write, `delete` or `put` at its key is refused with `SchemaConflictError`, and registering a type that declares its schema id claims it at the next load. It raised `CultCacheError` "Unknown persisted document type". Two global types share the key `__global__`, so a second global type in one cache is now refused, and a store that already holds two global types at `__global__` (a JSONL store written by caches that never pulled could produce one) no longer loads: the pull raises `CultCacheError` and admits nothing. C# refuses a second persisted global on pull the same way (`cultcache-store-composition.md`, "Globals never invented"); repair such a file by deleting one of the two records with the runtime that wrote it.
|
||||||
|
|
|
||||||
|
|
@ -94,7 +94,8 @@ store.
|
||||||
- `put(...)`
|
- `put(...)`
|
||||||
- `put_envelopes(...)`
|
- `put_envelopes(...)`
|
||||||
- `put_global(...)`
|
- `put_global(...)`
|
||||||
- `update(document, key, apply, *, max_attempts=5)` and `update_global(document, apply, *, max_attempts=5)`: the conditional golden path; reads the record as its home store holds it now, runs `apply` on a fresh copy, writes only if the record is unchanged and runs `apply` again on a lost race; returns `UpdateResult(outcome, document)` with `UpdateOutcome.UPDATED`, `DECLINED` (`apply` returned `None`) or `LOST_RACE` (see below)
|
- `update(...)`
|
||||||
|
- `update_global(...)`
|
||||||
- `delete(...)`
|
- `delete(...)`
|
||||||
- `delete_global(...)`
|
- `delete_global(...)`
|
||||||
- `is_writable(document, key)` (advisory: would a write or removal of the key be refused; see below)
|
- `is_writable(document, key)` (advisory: would a write or removal of the key be refused; see below)
|
||||||
|
|
@ -142,8 +143,6 @@ used by the TypeScript, Rust, and C# runtimes:
|
||||||
canonicalSchemaJson, compatibleSchemaIds, members]`
|
canonicalSchemaJson, compatibleSchemaIds, members]`
|
||||||
- records: `[key, schemaId, storedAt, payload]`
|
- records: `[key, schemaId, storedAt, payload]`
|
||||||
|
|
||||||
`update` needs a home store with the optional `read(key)` (the record at the key, of any type, and its content version, from one read) and `commit_if(envelope, expected)` (write only if the record at the key is still that version, under the store's write lock). The content version is the lowercase hex SHA-256 of the record re-encoded as the store writes it, `[key, schemaId, storedAt, payload]` with minimal MessagePack encodings, the same value C# computes (`tests/vectors/content-version`). It equals the SHA-256 of the record's bytes in the file exactly when the writer encoded the record minimally, as every writer in this library does; a record encoded with a wider-than-needed length or integer has the version of its minimal form. The single-file store has both; `JsonLinesBackingStore` and a store without them refuse `update` before `apply` runs. A cache with no store copies its held instance. Every write that replaces a record is stored at a later `stored_at` than the one it replaces, in each store kind and in a store-less cache; `push` and `push_all` return the stamp written, and the cache holds that stamp.
|
|
||||||
|
|
||||||
Large corpora should use a sharded store or a real database. A single snapshot file is a scalpel, not a forklift.
|
Large corpora should use a sharded store or a real database. A single snapshot file is a scalpel, not a forklift.
|
||||||
|
|
||||||
## Store format and rollback
|
## Store format and rollback
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
from .backing_store import BackingStore, CultCacheEnvelope
|
from .backing_store import BackingStore, CultCacheEnvelope
|
||||||
from .backing_store import CultCacheSchemaCatalogEntry, CultCacheSchemaCatalogMember
|
from .backing_store import CultCacheSchemaCatalogEntry, CultCacheSchemaCatalogMember
|
||||||
from . import leaves
|
from . import leaves
|
||||||
from .cache import CultCache, CultCacheBuilder, ForeignRecord, UpdateOutcome, UpdateResult
|
from .cache import CultCache, CultCacheBuilder, ForeignRecord
|
||||||
from .documents import (
|
from .documents import (
|
||||||
MAX_PAYLOAD_DEPTH,
|
MAX_PAYLOAD_DEPTH,
|
||||||
MAX_SLOT_KEY,
|
MAX_SLOT_KEY,
|
||||||
|
|
@ -19,7 +19,7 @@ from .documents import (
|
||||||
read_payload_tree,
|
read_payload_tree,
|
||||||
)
|
)
|
||||||
from .leaves import SlotCodec
|
from .leaves import SlotCodec
|
||||||
from .stores import JsonLinesBackingStore, SchemaConflictError, SingleFileMessagePackBackingStore, StoreLinkedError, StoreUnreadableError
|
from .stores import JsonLinesBackingStore, SchemaConflictError, SingleFileMessagePackBackingStore, StoreUnreadableError
|
||||||
|
|
||||||
__all__ = [
|
__all__ = [
|
||||||
"BackingStore",
|
"BackingStore",
|
||||||
|
|
@ -38,12 +38,9 @@ __all__ = [
|
||||||
"SchemaConflictError",
|
"SchemaConflictError",
|
||||||
"SingleFileMessagePackBackingStore",
|
"SingleFileMessagePackBackingStore",
|
||||||
"SlotCodec",
|
"SlotCodec",
|
||||||
"StoreLinkedError",
|
|
||||||
"StoreUnreadableError",
|
"StoreUnreadableError",
|
||||||
"UnionArm",
|
"UnionArm",
|
||||||
"UnreadSlots",
|
"UnreadSlots",
|
||||||
"UpdateOutcome",
|
|
||||||
"UpdateResult",
|
|
||||||
"read_payload_tree",
|
"read_payload_tree",
|
||||||
"leaves",
|
"leaves",
|
||||||
"database_entry_field",
|
"database_entry_field",
|
||||||
|
|
|
||||||
|
|
@ -58,36 +58,19 @@ class CultCacheEnvelope:
|
||||||
|
|
||||||
|
|
||||||
class BackingStore(Protocol):
|
class BackingStore(Protocol):
|
||||||
"""The members every store has. A store may also offer `read(key) -> tuple[CultCacheEnvelope, str] | None` (the record at the
|
|
||||||
key, of any type, and its content version, from one read) and `commit_if(envelope, expected: str | None) -> str | None` (write
|
|
||||||
only if the record at the key is still the version `expected`, None meaning no record; returns the stored_at written, or None
|
|
||||||
with nothing written). They are looked up with getattr, not Protocol members, and `CultCache.update` needs both. `push` and
|
|
||||||
`push_all` may report the stored_at they wrote (`str` and `dict[str, str]` by key); None keeps the cache's own stamp. A store
|
|
||||||
stamps a record that replaces another strictly later than the one it replaces."""
|
|
||||||
|
|
||||||
def pull_all(self) -> list[CultCacheEnvelope]:
|
def pull_all(self) -> list[CultCacheEnvelope]:
|
||||||
...
|
...
|
||||||
|
|
||||||
def push(self, envelope: CultCacheEnvelope) -> str | None:
|
def push(self, envelope: CultCacheEnvelope) -> None:
|
||||||
...
|
...
|
||||||
|
|
||||||
def delete(self, type: str, key: str) -> None:
|
def delete(self, type: str, key: str) -> None:
|
||||||
...
|
...
|
||||||
|
|
||||||
def pull_or_absent(self) -> list[CultCacheEnvelope] | None:
|
def push_all(self, envelopes: list[CultCacheEnvelope]) -> None:
|
||||||
"""The envelopes the reader reads (empty included), None when nothing is at the path; raises when the path cannot be read.
|
existing = {
|
||||||
|
(envelope.type, envelope.key): envelope for envelope in self.pull_all()
|
||||||
The default is pull_all, which cannot say absent: a store that inherits it is always a store the reader read. A store kind
|
}
|
||||||
that can tell nothing-at-the-path overrides this, and the default push_all then writes where nothing is on a soft push."""
|
|
||||||
return self.pull_all()
|
|
||||||
|
|
||||||
def push_all(self, envelopes: list[CultCacheEnvelope], soft: bool = False) -> dict[str, str] | None:
|
|
||||||
# Soft: write only where pull_or_absent says nothing is; skip over a store it read, empty included; its raise refuses.
|
|
||||||
pulled = self.pull_or_absent()
|
|
||||||
if soft and pulled is not None:
|
|
||||||
return
|
|
||||||
pulled = pulled or []
|
|
||||||
existing = {(envelope.type, envelope.key): envelope for envelope in pulled}
|
|
||||||
for envelope in envelopes:
|
for envelope in envelopes:
|
||||||
existing[(envelope.type, envelope.key)] = envelope
|
existing[(envelope.type, envelope.key)] = envelope
|
||||||
self._replace_all(list(existing.values()))
|
self._replace_all(list(existing.values()))
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,5 @@
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import enum
|
|
||||||
import functools
|
import functools
|
||||||
import math
|
import math
|
||||||
import threading
|
import threading
|
||||||
|
|
@ -10,39 +9,13 @@ from typing import Any, Callable, Generic, Iterable, TypeVar
|
||||||
|
|
||||||
from .backing_store import BackingStore, CultCacheEnvelope
|
from .backing_store import BackingStore, CultCacheEnvelope
|
||||||
from .documents import DocumentDefinition, UnreadSlots, extract_value
|
from .documents import DocumentDefinition, UnreadSlots, extract_value
|
||||||
from .stores import SchemaConflictError, parse_stored_at, retyped, stored_at_over, written_owns
|
from .stores import SchemaConflictError, retyped, written_owns
|
||||||
|
|
||||||
T = TypeVar("T")
|
T = TypeVar("T")
|
||||||
F = TypeVar("F", bound=Callable[..., Any])
|
F = TypeVar("F", bound=Callable[..., Any])
|
||||||
GLOBAL_KEY = "__global__"
|
GLOBAL_KEY = "__global__"
|
||||||
|
|
||||||
|
|
||||||
class UpdateOutcome(enum.Enum):
|
|
||||||
UPDATED = "updated"
|
|
||||||
DECLINED = "declined"
|
|
||||||
LOST_RACE = "lost_race"
|
|
||||||
|
|
||||||
|
|
||||||
@dataclass(frozen=True)
|
|
||||||
class UpdateResult(Generic[T]):
|
|
||||||
"""What `CultCache.update` did and the cache's record at the key after it (None when it holds nothing). The document decides
|
|
||||||
nothing: it is a read after the outcome."""
|
|
||||||
|
|
||||||
outcome: UpdateOutcome
|
|
||||||
document: T | None
|
|
||||||
|
|
||||||
|
|
||||||
@dataclass(frozen=True)
|
|
||||||
class _Expected:
|
|
||||||
"""What an update's commit requires to still hold. A cache with no store requires the held envelope object at the key (None:
|
|
||||||
nothing held); a store-backed one requires the type's home to be `store` and the record there to have content version
|
|
||||||
`version` (None: no record)."""
|
|
||||||
|
|
||||||
held: CultCacheEnvelope | None = None
|
|
||||||
store: BackingStore | None = None
|
|
||||||
version: str | None = None
|
|
||||||
|
|
||||||
|
|
||||||
def _locked(method: F) -> F:
|
def _locked(method: F) -> F:
|
||||||
"""Runs a read holding the cache's lock. Reads are reentrant and may run inside a mutation."""
|
"""Runs a read holding the cache's lock. Reads are reentrant and may run inside a mutation."""
|
||||||
|
|
||||||
|
|
@ -509,7 +482,7 @@ class CultCache:
|
||||||
def put(self, document: DocumentDefinition[T], key: str, value: T) -> None:
|
def put(self, document: DocumentDefinition[T], key: str, value: T) -> None:
|
||||||
self._put(document, key, value)
|
self._put(document, key, value)
|
||||||
|
|
||||||
def _put(self, document: DocumentDefinition[T], key: str, value: T, expected: _Expected | None = None) -> str:
|
def _put(self, document: DocumentDefinition[T], key: str, value: T) -> None:
|
||||||
self._assert_registered(document)
|
self._assert_registered(document)
|
||||||
if document.global_document and key != GLOBAL_KEY:
|
if document.global_document and key != GLOBAL_KEY:
|
||||||
raise CultCacheError(f"Global document {document.type} must use key {GLOBAL_KEY}")
|
raise CultCacheError(f"Global document {document.type} must use key {GLOBAL_KEY}")
|
||||||
|
|
@ -521,7 +494,7 @@ class CultCache:
|
||||||
schema_id=catalog_entry.schema_id,
|
schema_id=catalog_entry.schema_id,
|
||||||
catalog_entry=catalog_entry,
|
catalog_entry=catalog_entry,
|
||||||
)
|
)
|
||||||
return self._write(document, [(envelope, value)], batch=False, expected=expected)
|
self._write(document, [(envelope, value)], batch=False)
|
||||||
|
|
||||||
@_mutating
|
@_mutating
|
||||||
def put_envelope(self, document: DocumentDefinition[T], envelope: CultCacheEnvelope) -> T:
|
def put_envelope(self, document: DocumentDefinition[T], envelope: CultCacheEnvelope) -> T:
|
||||||
|
|
@ -589,12 +562,9 @@ class CultCache:
|
||||||
*,
|
*,
|
||||||
batch: bool,
|
batch: bool,
|
||||||
unread: dict[str, UnreadSlots | None] | None = None,
|
unread: dict[str, UnreadSlots | None] | None = None,
|
||||||
expected: _Expected | None = None,
|
) -> None:
|
||||||
) -> str:
|
|
||||||
"""Validates every record (home and name and index extractors included) before the store is
|
"""Validates every record (home and name and index extractors included) before the store is
|
||||||
touched; once the store accepts, applying to the cache has no fallible step. With `expected` (an update's commit) the write
|
touched; once the store accepts, applying to the cache has no fallible step."""
|
||||||
also requires the record to be unchanged since it was read and returns 'mismatch', having written and installed nothing,
|
|
||||||
when it is not; otherwise 'committed'. A record is held under the stored_at its store reports writing."""
|
|
||||||
type = document.type
|
type = document.type
|
||||||
# A batch naming a key twice lands the last record for it, as C# CultCacheBatch stages one operation per key. The
|
# A batch naming a key twice lands the last record for it, as C# CultCacheBatch stages one operation per key. The
|
||||||
# judge, the store and the apply all read this one list.
|
# judge, the store and the apply all read this one list.
|
||||||
|
|
@ -614,34 +584,13 @@ class CultCache:
|
||||||
)
|
)
|
||||||
store = self._store_for_type(type)
|
store = self._store_for_type(type)
|
||||||
legacy_key = self._state.legacy_global_keys.get(type)
|
legacy_key = self._state.legacy_global_keys.get(type)
|
||||||
stamps: dict[str, Any] = {}
|
if store is not None:
|
||||||
if expected is not None:
|
|
||||||
if legacy_key is not None:
|
|
||||||
raise self._legacy_global_refusal(document, legacy_key)
|
|
||||||
if expected.store is None:
|
|
||||||
held = self._state.envelopes.get(type, {}).get(records[0][0].key)
|
|
||||||
if store is not None or held is not expected.held:
|
|
||||||
return "mismatch"
|
|
||||||
elif store is not expected.store:
|
|
||||||
return "mismatch"
|
|
||||||
else:
|
|
||||||
stamp = store.commit_if(records[0][0], expected.version) # type: ignore[attr-defined]
|
|
||||||
if stamp is None:
|
|
||||||
return "mismatch"
|
|
||||||
stamps[records[0][0].key] = stamp
|
|
||||||
elif store is not None:
|
|
||||||
if batch:
|
if batch:
|
||||||
reported = store.push_all([envelope for envelope, _ in records])
|
store.push_all([envelope for envelope, _ in records])
|
||||||
stamps = reported if isinstance(reported, dict) else {}
|
|
||||||
else:
|
else:
|
||||||
stamps[records[0][0].key] = store.push(records[0][0])
|
store.push(records[0][0])
|
||||||
if legacy_key is not None:
|
if legacy_key is not None:
|
||||||
self._retire_legacy_global(store, type, legacy_key)
|
self._retire_legacy_global(store, type, legacy_key)
|
||||||
else:
|
|
||||||
for envelope, _ in records:
|
|
||||||
held_at = next((held for held in (by_type.get(envelope.key) for by_type in self._state.envelopes.values()) if held is not None), None)
|
|
||||||
if held_at is not None:
|
|
||||||
stamps[envelope.key] = stored_at_over(envelope.stored_at, held_at.stored_at)
|
|
||||||
self._state.legacy_global_keys.pop(type, None)
|
self._state.legacy_global_keys.pop(type, None)
|
||||||
values = self._state.values.setdefault(type, {})
|
values = self._state.values.setdefault(type, {})
|
||||||
envelopes = self._state.envelopes.setdefault(type, {})
|
envelopes = self._state.envelopes.setdefault(type, {})
|
||||||
|
|
@ -649,9 +598,6 @@ class CultCache:
|
||||||
for other, key in displaced:
|
for other, key in displaced:
|
||||||
self._drop(other, key)
|
self._drop(other, key)
|
||||||
for envelope, value, keys in admitted:
|
for envelope, value, keys in admitted:
|
||||||
stamp = stamps.get(envelope.key)
|
|
||||||
if isinstance(stamp, str) and parse_stored_at(stamp) is not None:
|
|
||||||
envelope = replace(envelope, stored_at=stamp)
|
|
||||||
self._remove_lookups(type, envelope.key)
|
self._remove_lookups(type, envelope.key)
|
||||||
values[envelope.key] = value
|
values[envelope.key] = value
|
||||||
envelopes[envelope.key] = envelope
|
envelopes[envelope.key] = envelope
|
||||||
|
|
@ -663,7 +609,6 @@ class CultCache:
|
||||||
self._state.names[(type, keys.name)] = envelope.key
|
self._state.names[(type, keys.name)] = envelope.key
|
||||||
for index, index_value in keys.indexes.items():
|
for index, index_value in keys.indexes.items():
|
||||||
self._state.indexes[(type, index, index_value)] = envelope.key
|
self._state.indexes[(type, index, index_value)] = envelope.key
|
||||||
return "committed"
|
|
||||||
|
|
||||||
def _refuse_retype(self, document: DocumentDefinition[Any], written: list[CultCacheEnvelope]) -> list[tuple[str, str]]:
|
def _refuse_retype(self, document: DocumentDefinition[Any], written: list[CultCacheEnvelope]) -> list[tuple[str, str]]:
|
||||||
"""The one key-identity judge (variants:ruling:cache-refuses-retype): a key holds one record whatever its type, so a write
|
"""The one key-identity judge (variants:ruling:cache-refuses-retype): a key holds one record whatever its type, so a write
|
||||||
|
|
@ -691,8 +636,7 @@ class CultCache:
|
||||||
a record held read-only (its payload carried slots past the declared ones, at any depth, and nothing consents to the loss, so
|
a record held read-only (its payload carried slots past the declared ones, at any depth, and nothing consents to the loss, so
|
||||||
writing it would drop data a newer writer stored), for a key a store carries foreign, and for a key held as another type's
|
writing it would drop data a newer writer stored), for a key a store carries foreign, and for a key held as another type's
|
||||||
record this document does not own. Advisory (the write still decides): it answers at call time, and a key nothing holds is
|
record this document does not own. Advisory (the write still decides): it answers at call time, and a key nothing holds is
|
||||||
writable. It does not look at store paths: a link at a store path is not predicted, and the write refuses it with
|
writable."""
|
||||||
`StoreLinkedError`."""
|
|
||||||
self._assert_registered(document)
|
self._assert_registered(document)
|
||||||
try:
|
try:
|
||||||
self._refuse_at(document, key)
|
self._refuse_at(document, key)
|
||||||
|
|
@ -718,34 +662,18 @@ class CultCache:
|
||||||
if held is None:
|
if held is None:
|
||||||
continue
|
continue
|
||||||
type, slots = held
|
type, slots = held
|
||||||
raise self._read_only_refusal(self._state.documents[type], key, self._state.envelopes[type][key].schema_id, slots)
|
raise SchemaConflictError(
|
||||||
|
self._state.envelopes[type][key].schema_id or type,
|
||||||
@staticmethod
|
[self._state.documents[type].catalog_entry().schema_name],
|
||||||
def _read_only_refusal(
|
key,
|
||||||
document: DocumentDefinition[Any], key: str, schema_id: str | None, slots: UnreadSlots
|
message=(
|
||||||
) -> SchemaConflictError:
|
f"{self._state.documents[type].catalog_entry().schema_name} record {key} is read-only: {slots.type_name} was read with "
|
||||||
"""The one refusal of a write to a record that carries slots this build would drop: a record the cache holds read-only,
|
f"{slots.slot_count} slots where this build declares {slots.declared_count} ({slots.occurrences} object(s) in the "
|
||||||
or one an update reads from the store."""
|
"record). Writing it would drop data a newer writer stored; read it with types that declare those slots, or "
|
||||||
name = document.catalog_entry().schema_name
|
"write it from that build."
|
||||||
return SchemaConflictError(
|
),
|
||||||
schema_id or document.type,
|
unread_slots=slots,
|
||||||
[name],
|
)
|
||||||
key,
|
|
||||||
message=(
|
|
||||||
f"{name} record {key} is read-only: {slots.type_name} was read with "
|
|
||||||
f"{slots.slot_count} slots where this build declares {slots.declared_count} ({slots.occurrences} object(s) in the "
|
|
||||||
"record). Writing it would drop data a newer writer stored; read it with types that declare those slots, or "
|
|
||||||
"write it from that build."
|
|
||||||
),
|
|
||||||
unread_slots=slots,
|
|
||||||
)
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def _legacy_global_refusal(document: DocumentDefinition[Any], legacy_key: str) -> CultCacheError:
|
|
||||||
return CultCacheError(
|
|
||||||
f"Global {document.type} is held under the legacy key {legacy_key!r}; update cannot copy it. "
|
|
||||||
"put_global writes the global and retires the legacy key."
|
|
||||||
)
|
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
def _foreign_refusal(record: ForeignRecord) -> SchemaConflictError:
|
def _foreign_refusal(record: ForeignRecord) -> SchemaConflictError:
|
||||||
|
|
@ -778,81 +706,20 @@ class CultCache:
|
||||||
self._assert_global(document)
|
self._assert_global(document)
|
||||||
self._put(document, GLOBAL_KEY, value)
|
self._put(document, GLOBAL_KEY, value)
|
||||||
|
|
||||||
def update(
|
@_mutating
|
||||||
self, document: DocumentDefinition[T], key: str, apply: Callable[[T | None], T | None], *, max_attempts: int = 5
|
def update(self, document: DocumentDefinition[T], key: str, updater: Any) -> T:
|
||||||
) -> UpdateResult[T]:
|
return self._update(document, key, updater)
|
||||||
"""Reads the record at the key as its home store holds it, applies `apply` to a fresh copy of it, and commits the result
|
|
||||||
only if the record is still the one that was read; when another writer got there first it reads again and runs `apply`
|
|
||||||
again, up to `max_attempts` times.
|
|
||||||
|
|
||||||
`apply` may run up to `max_attempts` times, on a fresh copy of the record as the store holds it now (None when the key
|
def _update(self, document: DocumentDefinition[T], key: str, updater: Any) -> T:
|
||||||
holds nothing), which it may change and return. It must not write the same key through this cache or have side effects.
|
current = self.get_required(document, key)
|
||||||
Returning None writes nothing (DECLINED). A lost race that outlasts `max_attempts` returns LOST_RACE and does not raise;
|
updated = updater(current)
|
||||||
a refusal, or a raise from `apply`, propagates and is not retried. The write is durable when update returns. The
|
self._put(document, key, updated)
|
||||||
result's document is the cache's record after the outcome. `put` is the blind write. A cache with no store copies its
|
return updated
|
||||||
held instance; a store without `read` and `commit_if` (the JSON lines store among them) refuses before `apply` runs."""
|
|
||||||
if not callable(apply):
|
|
||||||
raise TypeError("CultCache update needs a function to apply.")
|
|
||||||
if not isinstance(max_attempts, int) or isinstance(max_attempts, bool):
|
|
||||||
raise TypeError(f"CultCache update max_attempts must be an int, not {type(max_attempts).__name__}.")
|
|
||||||
if max_attempts < 1:
|
|
||||||
raise ValueError(f"CultCache update max_attempts must be at least 1, not {max_attempts}.")
|
|
||||||
for attempt in range(1, max_attempts + 1):
|
|
||||||
copy, expected = self._read_for_update(document, key)
|
|
||||||
# Outside the cache's lock and the store's: apply may take its time and may write other keys through this cache.
|
|
||||||
next_value = apply(copy)
|
|
||||||
if next_value is None:
|
|
||||||
return UpdateResult(UpdateOutcome.DECLINED, self.get(document, key))
|
|
||||||
if self._commit_update(document, key, next_value, expected) == "committed":
|
|
||||||
return UpdateResult(UpdateOutcome.UPDATED, self.get(document, key))
|
|
||||||
# Display only: the cache shows what the winner left.
|
|
||||||
if self._state.stores_by_type or self._state.generic_store is not None:
|
|
||||||
self.pull_all_backing_stores()
|
|
||||||
return UpdateResult(UpdateOutcome.LOST_RACE, self.get(document, key))
|
|
||||||
|
|
||||||
@_mutating
|
@_mutating
|
||||||
def _read_for_update(self, document: DocumentDefinition[T], key: str) -> tuple[T | None, _Expected]:
|
def update_global(self, document: DocumentDefinition[T], updater: Any) -> T:
|
||||||
"""One attempt's read: the copy to hand `apply` and the condition its commit holds. Every refusal that does not depend on
|
|
||||||
what `apply` returns is raised here, so `apply` never runs for a write that cannot land. Installs nothing."""
|
|
||||||
self._assert_registered(document)
|
|
||||||
self._refuse_at(document, key)
|
|
||||||
legacy_key = self._state.legacy_global_keys.get(document.type)
|
|
||||||
if legacy_key is not None:
|
|
||||||
raise self._legacy_global_refusal(document, legacy_key)
|
|
||||||
store = self._store_for_type(document.type)
|
|
||||||
if store is None:
|
|
||||||
held = self._state.envelopes.get(document.type, {}).get(key)
|
|
||||||
return (None if held is None else document.decode_payload(held.payload)), _Expected(held=held)
|
|
||||||
read, commit_if = getattr(store, "read", None), getattr(store, "commit_if", None)
|
|
||||||
if read is None or commit_if is None:
|
|
||||||
raise CultCacheError(
|
|
||||||
f"Backing store {type(store).__name__} for {document.type} cannot write conditionally; "
|
|
||||||
"update needs a store with read and commit_if."
|
|
||||||
)
|
|
||||||
if document.global_document:
|
|
||||||
for envelope in store.pull_all():
|
|
||||||
if envelope.key != GLOBAL_KEY and self._resolve_document_for_envelope(envelope) is document:
|
|
||||||
raise self._legacy_global_refusal(document, envelope.key)
|
|
||||||
found = read(key)
|
|
||||||
if found is None:
|
|
||||||
return None, _Expected(store=store)
|
|
||||||
envelope, version = found
|
|
||||||
if self._resolve_document_for_envelope(envelope) is not document:
|
|
||||||
raise CultCacheError(f"Record {key} is not a {document.type}; update cannot copy it.")
|
|
||||||
value, unread = self._decode_marked(document, envelope)
|
|
||||||
if unread is not None:
|
|
||||||
raise self._read_only_refusal(document, key, envelope.schema_id, unread)
|
|
||||||
return value, _Expected(store=store, version=version)
|
|
||||||
|
|
||||||
@_mutating
|
|
||||||
def _commit_update(self, document: DocumentDefinition[T], key: str, value: T, expected: _Expected) -> str:
|
|
||||||
return self._put(document, key, value, expected)
|
|
||||||
|
|
||||||
def update_global(
|
|
||||||
self, document: DocumentDefinition[T], apply: Callable[[T | None], T | None], *, max_attempts: int = 5
|
|
||||||
) -> UpdateResult[T]:
|
|
||||||
self._assert_global(document)
|
self._assert_global(document)
|
||||||
return self.update(document, GLOBAL_KEY, apply, max_attempts=max_attempts)
|
return self._update(document, GLOBAL_KEY, updater)
|
||||||
|
|
||||||
@_mutating
|
@_mutating
|
||||||
def delete(self, document: DocumentDefinition[Any], key: str) -> None:
|
def delete(self, document: DocumentDefinition[Any], key: str) -> None:
|
||||||
|
|
|
||||||
|
|
@ -1,17 +1,13 @@
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import base64
|
import base64
|
||||||
import hashlib
|
|
||||||
import json
|
import json
|
||||||
import os
|
import os
|
||||||
import re
|
|
||||||
import sys
|
import sys
|
||||||
import threading
|
import threading
|
||||||
import time
|
import time
|
||||||
import uuid
|
import uuid
|
||||||
from contextlib import contextmanager
|
from contextlib import contextmanager
|
||||||
from dataclasses import replace
|
|
||||||
from datetime import datetime, timedelta, timezone
|
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Any, Callable, Iterator, TypeVar
|
from typing import Any, Callable, Iterator, TypeVar
|
||||||
|
|
||||||
|
|
@ -80,17 +76,10 @@ class JsonLinesBackingStore:
|
||||||
self._lock = threading.RLock()
|
self._lock = threading.RLock()
|
||||||
|
|
||||||
def pull_all(self) -> list[CultCacheEnvelope]:
|
def pull_all(self) -> list[CultCacheEnvelope]:
|
||||||
return self._pull() or []
|
|
||||||
|
|
||||||
def pull_or_absent(self) -> list[CultCacheEnvelope] | None:
|
|
||||||
return self._pull()
|
|
||||||
|
|
||||||
def _pull(self) -> list[CultCacheEnvelope] | None:
|
|
||||||
"""The envelopes the reader reads, or None when nothing is at the path."""
|
|
||||||
with self._lock:
|
with self._lock:
|
||||||
text = _read_store(self.path, lambda path: path.read_text(encoding="utf-8"))
|
text = _read_store(self.path, lambda path: path.read_text(encoding="utf-8"))
|
||||||
if text is None:
|
if text is None:
|
||||||
return None
|
return []
|
||||||
envelopes: list[CultCacheEnvelope] = []
|
envelopes: list[CultCacheEnvelope] = []
|
||||||
for line_number, line in enumerate(text.splitlines(), start=1):
|
for line_number, line in enumerate(text.splitlines(), start=1):
|
||||||
if not line.strip():
|
if not line.strip():
|
||||||
|
|
@ -111,41 +100,27 @@ class JsonLinesBackingStore:
|
||||||
raise ValueError(f"Malformed CultCache JSONL envelope at {self.path}:{line_number}: missing {exc}") from exc
|
raise ValueError(f"Malformed CultCache JSONL envelope at {self.path}:{line_number}: missing {exc}") from exc
|
||||||
return envelopes
|
return envelopes
|
||||||
|
|
||||||
def push(self, envelope: CultCacheEnvelope) -> str | None:
|
def push(self, envelope: CultCacheEnvelope) -> None:
|
||||||
return self.push_all([envelope])[envelope.key]
|
with self._lock:
|
||||||
|
existing = {(item.type, item.key): item for item in self.pull_all()}
|
||||||
|
existing[(envelope.type, envelope.key)] = envelope
|
||||||
|
self._replace_all(list(existing.values()))
|
||||||
|
|
||||||
def push_all(self, envelopes: list[CultCacheEnvelope], soft: bool = False) -> dict[str, str]:
|
def push_all(self, envelopes: list[CultCacheEnvelope]) -> None:
|
||||||
"""Merges the envelopes, each stored later than any record it replaces, and returns the stamps written by key
|
with self._lock:
|
||||||
({} when a soft push skipped)."""
|
existing = {(item.type, item.key): item for item in self.pull_all()}
|
||||||
stamps: dict[str, str] = {}
|
|
||||||
|
|
||||||
def merge(existing: dict[tuple[str, str], CultCacheEnvelope]) -> None:
|
|
||||||
for envelope in envelopes:
|
for envelope in envelopes:
|
||||||
replaced = existing.get((envelope.type, envelope.key))
|
|
||||||
if replaced is not None:
|
|
||||||
envelope = replace(envelope, stored_at=stored_at_over(envelope.stored_at, replaced.stored_at))
|
|
||||||
existing[(envelope.type, envelope.key)] = envelope
|
existing[(envelope.type, envelope.key)] = envelope
|
||||||
stamps[envelope.key] = envelope.stored_at
|
self._replace_all(list(existing.values()))
|
||||||
self._rewrite(merge, soft)
|
|
||||||
return stamps
|
|
||||||
|
|
||||||
def delete(self, type: str, key: str) -> None:
|
def delete(self, type: str, key: str) -> None:
|
||||||
self._rewrite(lambda existing: existing.pop((type, key), None))
|
|
||||||
|
|
||||||
def _rewrite(self, change: Callable[[dict[tuple[str, str], CultCacheEnvelope]], object], soft: bool = False) -> None:
|
|
||||||
"""The one entry of every write: refuses a link at the path, then reads the file (a soft write stops here when the
|
|
||||||
reader read it), applies the change and replaces it."""
|
|
||||||
with self._lock:
|
with self._lock:
|
||||||
_refuse_linked(self.path)
|
existing = [item for item in self.pull_all() if not (item.type == type and item.key == key)]
|
||||||
arrived = self._pull()
|
self._replace_all(existing)
|
||||||
if soft and arrived is not None:
|
|
||||||
return
|
|
||||||
existing = {(item.type, item.key): item for item in arrived or []}
|
|
||||||
change(existing)
|
|
||||||
self._replace_all(list(existing.values()))
|
|
||||||
|
|
||||||
def _replace_all(self, envelopes: list[CultCacheEnvelope]) -> None:
|
def _replace_all(self, envelopes: list[CultCacheEnvelope]) -> None:
|
||||||
self.path.parent.mkdir(parents=True, exist_ok=True)
|
self.path.parent.mkdir(parents=True, exist_ok=True)
|
||||||
|
temp = self.path.with_suffix(self.path.suffix + ".tmp")
|
||||||
lines = []
|
lines = []
|
||||||
for envelope in sorted(envelopes, key=lambda item: (item.type, item.key)):
|
for envelope in sorted(envelopes, key=lambda item: (item.type, item.key)):
|
||||||
lines.append(json.dumps({
|
lines.append(json.dumps({
|
||||||
|
|
@ -154,7 +129,8 @@ class JsonLinesBackingStore:
|
||||||
"payload": base64.b64encode(envelope.payload).decode("ascii"),
|
"payload": base64.b64encode(envelope.payload).decode("ascii"),
|
||||||
"stored_at": envelope.stored_at,
|
"stored_at": envelope.stored_at,
|
||||||
}, ensure_ascii=False, sort_keys=True))
|
}, ensure_ascii=False, sort_keys=True))
|
||||||
commit_store_file(self.path, ("\n".join(lines) + ("\n" if lines else "")).encode("utf-8"))
|
temp.write_text("\n".join(lines) + ("\n" if lines else ""), encoding="utf-8")
|
||||||
|
temp.replace(self.path)
|
||||||
|
|
||||||
|
|
||||||
class SingleFileMessagePackBackingStore:
|
class SingleFileMessagePackBackingStore:
|
||||||
|
|
@ -166,20 +142,13 @@ class SingleFileMessagePackBackingStore:
|
||||||
self._format = STORE_FORMAT_VERSION
|
self._format = STORE_FORMAT_VERSION
|
||||||
|
|
||||||
def pull_all(self) -> list[CultCacheEnvelope]:
|
def pull_all(self) -> list[CultCacheEnvelope]:
|
||||||
return self._pull() or []
|
|
||||||
|
|
||||||
def pull_or_absent(self) -> list[CultCacheEnvelope] | None:
|
|
||||||
return self._pull()
|
|
||||||
|
|
||||||
def _pull(self) -> list[CultCacheEnvelope] | None:
|
|
||||||
"""The envelopes the reader reads, or None when nothing is at the path."""
|
|
||||||
with self._lock:
|
with self._lock:
|
||||||
# An empty file is not a store (no writer leaves one), so it is decoded and refused.
|
# An empty file is not a store (no writer leaves one), so it is decoded and refused.
|
||||||
# The disk decides the header: a file that is gone is not marked.
|
# The disk decides the header: a file that is gone is not marked.
|
||||||
self._format = STORE_FORMAT_VERSION
|
self._format = STORE_FORMAT_VERSION
|
||||||
data = _read_store(self.path, Path.read_bytes)
|
data = _read_store(self.path, Path.read_bytes)
|
||||||
if data is None:
|
if data is None:
|
||||||
return None
|
return []
|
||||||
try:
|
try:
|
||||||
decoded = msgpack.unpackb(data, raw=False)
|
decoded = msgpack.unpackb(data, raw=False)
|
||||||
snapshot = _decode_snapshot(decoded)
|
snapshot = _decode_snapshot(decoded)
|
||||||
|
|
@ -190,40 +159,18 @@ class SingleFileMessagePackBackingStore:
|
||||||
except Exception as exc:
|
except Exception as exc:
|
||||||
raise StoreUnreadableError(self.path, exc) from exc
|
raise StoreUnreadableError(self.path, exc) from exc
|
||||||
|
|
||||||
def push(self, envelope: CultCacheEnvelope) -> str | None:
|
def push(self, envelope: CultCacheEnvelope) -> None:
|
||||||
with self._write_transaction():
|
with self._write_transaction():
|
||||||
return self._replace_all([envelope], self.pull_all())[envelope.key]
|
self._replace_all([envelope], self.pull_all())
|
||||||
|
|
||||||
def push_all(self, envelopes: list[CultCacheEnvelope], soft: bool = False) -> dict[str, str]:
|
def push_all(self, envelopes: list[CultCacheEnvelope]) -> None:
|
||||||
"""A soft push writes only where nothing is at the path: a store the reader reads is left byte for byte, and a file it
|
|
||||||
cannot read is refused by the same read, as in TS and Rust. Returns the stamps written by key ({} when skipped)."""
|
|
||||||
with self._write_transaction():
|
with self._write_transaction():
|
||||||
arrived = self._pull()
|
self._replace_all(list(envelopes), self.pull_all())
|
||||||
if soft and arrived is not None:
|
|
||||||
return {}
|
|
||||||
return self._replace_all(list(envelopes), arrived or [])
|
|
||||||
|
|
||||||
def delete(self, type: str, key: str) -> None:
|
def delete(self, type: str, key: str) -> None:
|
||||||
with self._write_transaction():
|
with self._write_transaction():
|
||||||
self._replace_all([], [item for item in self.pull_all() if not (item.type == type and item.key == key)])
|
self._replace_all([], [item for item in self.pull_all() if not (item.type == type and item.key == key)])
|
||||||
|
|
||||||
def read(self, key: str) -> tuple[CultCacheEnvelope, str] | None:
|
|
||||||
"""The record at the key, of any type, and its content version, from one read; None when the key holds nothing."""
|
|
||||||
for envelope in self._pull() or []:
|
|
||||||
if envelope.key == key:
|
|
||||||
return envelope, record_version(envelope)
|
|
||||||
return None
|
|
||||||
|
|
||||||
def commit_if(self, envelope: CultCacheEnvelope, expected: str | None) -> str | None:
|
|
||||||
"""Writes the envelope only if the record at its key (any type) is still the one whose version is `expected`
|
|
||||||
(None: no record), judged under the write lock; returns the stored_at written, or None with nothing written."""
|
|
||||||
with self._write_transaction():
|
|
||||||
arrived = self._pull() or []
|
|
||||||
current = next((item for item in arrived if item.key == envelope.key), None)
|
|
||||||
if (None if current is None else record_version(current)) != expected:
|
|
||||||
return None
|
|
||||||
return self._replace_all([envelope], arrived)[envelope.key]
|
|
||||||
|
|
||||||
@contextmanager
|
@contextmanager
|
||||||
def _write_transaction(self) -> Iterator[None]:
|
def _write_transaction(self) -> Iterator[None]:
|
||||||
"""The thread lock, then the cross-process lock on `<path>.lock`, held across the read and the replace so two
|
"""The thread lock, then the cross-process lock on `<path>.lock`, held across the read and the replace so two
|
||||||
|
|
@ -233,10 +180,8 @@ class SingleFileMessagePackBackingStore:
|
||||||
with store_write_lock(self.path, self.lock_timeout):
|
with store_write_lock(self.path, self.lock_timeout):
|
||||||
yield
|
yield
|
||||||
|
|
||||||
def _replace_all(self, supplied: list[CultCacheEnvelope], arrived: list[CultCacheEnvelope]) -> dict[str, str]:
|
def _replace_all(self, supplied: list[CultCacheEnvelope], arrived: list[CultCacheEnvelope]) -> None:
|
||||||
snapshot, stamps = _encode_snapshot(supplied, arrived, self._format)
|
commit_store_file(self.path, msgpack.packb(_encode_snapshot(supplied, arrived, self._format), use_bin_type=True))
|
||||||
commit_store_file(self.path, msgpack.packb(snapshot, use_bin_type=True))
|
|
||||||
return stamps
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -337,7 +282,7 @@ def written_owns(held: CultCacheEnvelope, written: CultCacheEnvelope) -> bool:
|
||||||
|
|
||||||
def _encode_snapshot(
|
def _encode_snapshot(
|
||||||
supplied: list[CultCacheEnvelope], arrived: list[CultCacheEnvelope], format_version: str
|
supplied: list[CultCacheEnvelope], arrived: list[CultCacheEnvelope], format_version: str
|
||||||
) -> tuple[list[Any], dict[str, str]]:
|
) -> list[Any]:
|
||||||
# A key names one record whatever its type, so a supplied record replaces the arrived one by key alone, and only of the
|
# A key names one record whatever its type, so a supplied record replaces the arrived one by key alone, and only of the
|
||||||
# type that owns it: retyping a key is a removal and an add, so a record another type owns under the key refuses the write.
|
# type that owns it: retyping a key is a removal and an add, so a record another type owns under the key refuses the write.
|
||||||
held_by_key = {envelope.key: envelope for envelope in arrived}
|
held_by_key = {envelope.key: envelope for envelope in arrived}
|
||||||
|
|
@ -346,12 +291,8 @@ def _encode_snapshot(
|
||||||
for held in (landing.get(envelope.key), held_by_key.get(envelope.key)):
|
for held in (landing.get(envelope.key), held_by_key.get(envelope.key)):
|
||||||
if held is not None and not written_owns(held, envelope):
|
if held is not None and not written_owns(held, envelope):
|
||||||
raise retyped(held, envelope)
|
raise retyped(held, envelope)
|
||||||
held = held_by_key.get(envelope.key)
|
|
||||||
if held is not None:
|
|
||||||
envelope = replace(envelope, stored_at=stored_at_over(envelope.stored_at, held.stored_at))
|
|
||||||
landing[envelope.key] = envelope
|
landing[envelope.key] = envelope
|
||||||
supplied = list(landing.values())
|
supplied = list(landing.values())
|
||||||
stamps = {envelope.key: envelope.stored_at for envelope in supplied}
|
|
||||||
replaced = set(landing)
|
replaced = set(landing)
|
||||||
kept = [envelope for envelope in arrived if envelope.key not in replaced]
|
kept = [envelope for envelope in arrived if envelope.key not in replaced]
|
||||||
envelopes = [*kept, *supplied]
|
envelopes = [*kept, *supplied]
|
||||||
|
|
@ -366,7 +307,7 @@ def _encode_snapshot(
|
||||||
[envelope.key, _schema_id_for(envelope), envelope.stored_at, envelope.payload]
|
[envelope.key, _schema_id_for(envelope), envelope.stored_at, envelope.payload]
|
||||||
for envelope in sorted(envelopes, key=lambda item: item.key)
|
for envelope in sorted(envelopes, key=lambda item: item.key)
|
||||||
]
|
]
|
||||||
return [format_version, catalog, records], stamps
|
return [format_version, catalog, records]
|
||||||
|
|
||||||
def commit_store_file(path: Path, data: bytes) -> None:
|
def commit_store_file(path: Path, data: bytes) -> None:
|
||||||
"""Writes `data` to a unique staged file beside the store, fsyncs it, replaces the store with it and, off Windows,
|
"""Writes `data` to a unique staged file beside the store, fsyncs it, replaces the store with it and, off Windows,
|
||||||
|
|
@ -382,7 +323,7 @@ def commit_store_file(path: Path, data: bytes) -> None:
|
||||||
os.fsync(fd)
|
os.fsync(fd)
|
||||||
finally:
|
finally:
|
||||||
os.close(fd)
|
os.close(fd)
|
||||||
_replace_store(staged, path)
|
os.replace(staged, path)
|
||||||
except BaseException:
|
except BaseException:
|
||||||
try:
|
try:
|
||||||
os.unlink(staged)
|
os.unlink(staged)
|
||||||
|
|
@ -397,136 +338,11 @@ def commit_store_file(path: Path, data: bytes) -> None:
|
||||||
os.close(directory)
|
os.close(directory)
|
||||||
|
|
||||||
|
|
||||||
REPLACE_ATTEMPTS = 25
|
|
||||||
REPLACE_RETRY_SECONDS = 0.02
|
|
||||||
_ERROR_ACCESS_DENIED = 5
|
|
||||||
_ERROR_SHARING_VIOLATION = 32
|
|
||||||
_ERROR_LOCK_VIOLATION = 33
|
|
||||||
_POSIX_UNSUPPORTED = (1, 50, 87) # incorrect function, not supported, invalid parameter: FAT, exFAT, before Windows 10 1607
|
|
||||||
MOVEFILE_REPLACE_WRITE_THROUGH = 0x9 # MOVEFILE_REPLACE_EXISTING | MOVEFILE_WRITE_THROUGH
|
|
||||||
|
|
||||||
|
|
||||||
class ReplaceKernel:
|
|
||||||
"""The kernel32 calls a Windows store replace needs, each answering 0 or a Win32 error code."""
|
|
||||||
|
|
||||||
def rename_posix(self, staged: str, destination: str) -> int:
|
|
||||||
"""CreateFileW(staged, DELETE|SYNCHRONIZE), then FileRenameInfoEx with REPLACE_IF_EXISTS|POSIX_SEMANTICS, then CloseHandle."""
|
|
||||||
raise NotImplementedError
|
|
||||||
|
|
||||||
def move_file_ex(self, staged: str, destination: str, flags: int) -> int:
|
|
||||||
raise NotImplementedError
|
|
||||||
|
|
||||||
def sleep(self, seconds: float) -> None:
|
|
||||||
time.sleep(seconds)
|
|
||||||
|
|
||||||
|
|
||||||
def _replace_store(staged: str | os.PathLike[str], destination: str | os.PathLike[str]) -> None:
|
|
||||||
"""Replaces `destination` with `staged`: POSIX-semantics rename first on Windows (so a reader holding the store open
|
|
||||||
keeps it and rarely sees it absent; a stalled rename can still leave it absent for 5-47 ms on NTFS,
|
|
||||||
variants:ruling:posix-rename-absent-window-document), os.replace elsewhere."""
|
|
||||||
if sys.platform == "win32":
|
|
||||||
replace_store_windows(os.fspath(staged), os.fspath(destination), WindowsReplaceKernel())
|
|
||||||
else:
|
|
||||||
os.replace(staged, destination)
|
|
||||||
|
|
||||||
|
|
||||||
def replace_store_windows(staged: str, destination: str, kernel: ReplaceKernel) -> None:
|
|
||||||
"""POSIX-semantics rename, falling back for the rest of the call to write-through MoveFileExW where POSIX semantics are
|
|
||||||
unsupported; errors 5, 32 and 33 retry up to 25 times 20 ms apart, any other code raises at once. The TypeScript and C#
|
|
||||||
runtimes take the same decision table."""
|
|
||||||
posix = True
|
|
||||||
last = 0
|
|
||||||
for _ in range(REPLACE_ATTEMPTS):
|
|
||||||
code = kernel.rename_posix(staged, destination) if posix else kernel.move_file_ex(staged, destination, MOVEFILE_REPLACE_WRITE_THROUGH)
|
|
||||||
if posix and code in _POSIX_UNSUPPORTED:
|
|
||||||
posix = False
|
|
||||||
code = kernel.move_file_ex(staged, destination, MOVEFILE_REPLACE_WRITE_THROUGH)
|
|
||||||
if code == 0:
|
|
||||||
return
|
|
||||||
if code not in (_ERROR_ACCESS_DENIED, _ERROR_SHARING_VIOLATION, _ERROR_LOCK_VIOLATION):
|
|
||||||
raise _replace_error(f"CultCache could not replace the store: Win32 error {code}.", code)
|
|
||||||
last = code
|
|
||||||
kernel.sleep(REPLACE_RETRY_SECONDS)
|
|
||||||
raise _replace_error(f"CultCache could not replace the store after {REPLACE_ATTEMPTS} attempts: last Win32 error {last}.", last)
|
|
||||||
|
|
||||||
|
|
||||||
def _replace_error(message: str, code: int) -> OSError:
|
|
||||||
error = OSError(message)
|
|
||||||
error.winerror = code # type: ignore[attr-defined]
|
|
||||||
return error
|
|
||||||
|
|
||||||
|
|
||||||
class WindowsReplaceKernel(ReplaceKernel):
|
|
||||||
"""kernel32 bound by ctypes, as _try_lock_windows binds it. Windows only."""
|
|
||||||
|
|
||||||
def __init__(self) -> None:
|
|
||||||
import ctypes
|
|
||||||
from ctypes import wintypes
|
|
||||||
|
|
||||||
self._ctypes = ctypes
|
|
||||||
k = self._k = ctypes.WinDLL("kernel32", use_last_error=True)
|
|
||||||
k.CreateFileW.restype = wintypes.HANDLE
|
|
||||||
k.CreateFileW.argtypes = [wintypes.LPCWSTR, wintypes.DWORD, wintypes.DWORD, ctypes.c_void_p, wintypes.DWORD, wintypes.DWORD, wintypes.HANDLE]
|
|
||||||
k.SetFileInformationByHandle.restype = wintypes.BOOL
|
|
||||||
k.SetFileInformationByHandle.argtypes = [wintypes.HANDLE, ctypes.c_int, ctypes.c_void_p, wintypes.DWORD]
|
|
||||||
k.CloseHandle.restype = wintypes.BOOL
|
|
||||||
k.CloseHandle.argtypes = [wintypes.HANDLE]
|
|
||||||
k.MoveFileExW.restype = wintypes.BOOL
|
|
||||||
k.MoveFileExW.argtypes = [wintypes.LPCWSTR, wintypes.LPCWSTR, wintypes.DWORD]
|
|
||||||
|
|
||||||
def rename_posix(self, staged: str, destination: str) -> int:
|
|
||||||
ctypes, k = self._ctypes, self._k
|
|
||||||
delete_synchronize, share_all, open_existing, normal = 0x00110000, 0x7, 3, 0x80
|
|
||||||
handle = k.CreateFileW(staged, delete_synchronize, share_all, None, open_existing, normal, None)
|
|
||||||
if handle is None or ctypes.c_void_p(handle).value in (None, ctypes.c_void_p(-1).value):
|
|
||||||
return ctypes.get_last_error()
|
|
||||||
try:
|
|
||||||
# FILE_RENAME_INFO: Flags (DWORD), RootDirectory (pointer-aligned HANDLE), FileNameLength (DWORD), FileName (WCHAR[]).
|
|
||||||
name = os.path.abspath(destination).encode("utf-16-le")
|
|
||||||
pointer = ctypes.sizeof(ctypes.c_void_p)
|
|
||||||
length_at = pointer + pointer
|
|
||||||
info = ctypes.create_string_buffer(length_at + 4 + len(name) + 2)
|
|
||||||
info[0:4] = (0x3).to_bytes(4, "little") # FILE_RENAME_FLAG_REPLACE_IF_EXISTS | FILE_RENAME_FLAG_POSIX_SEMANTICS
|
|
||||||
info[length_at:length_at + 4] = len(name).to_bytes(4, "little")
|
|
||||||
info[length_at + 4:length_at + 4 + len(name)] = name
|
|
||||||
file_rename_info_ex = 22
|
|
||||||
if k.SetFileInformationByHandle(handle, file_rename_info_ex, info, len(info)):
|
|
||||||
return 0
|
|
||||||
return ctypes.get_last_error()
|
|
||||||
finally:
|
|
||||||
k.CloseHandle(handle)
|
|
||||||
|
|
||||||
def move_file_ex(self, staged: str, destination: str, flags: int) -> int:
|
|
||||||
return 0 if self._k.MoveFileExW(staged, destination, flags) else self._ctypes.get_last_error()
|
|
||||||
|
|
||||||
|
|
||||||
class StoreLinkedError(OSError):
|
|
||||||
"""A write was asked of a store path that is a link: a replace there would swap the link for a regular file."""
|
|
||||||
|
|
||||||
def __init__(self, path: Path) -> None:
|
|
||||||
super().__init__(f"CultCache store {path} is a link, and a write at it would replace the link; configure the link's target as the store path.")
|
|
||||||
self.path = path
|
|
||||||
|
|
||||||
|
|
||||||
def _refuse_linked(path: Path) -> None:
|
|
||||||
"""Refuses a link at the store path: a file or directory link, and on Windows a junction or any reparse point (islink misses
|
|
||||||
junctions before Python 3.12). Absent is not a link."""
|
|
||||||
linked = os.path.islink(path)
|
|
||||||
if not linked and sys.platform == "win32":
|
|
||||||
try:
|
|
||||||
linked = bool(os.lstat(path).st_file_attributes & 0x400) # FILE_ATTRIBUTE_REPARSE_POINT
|
|
||||||
except FileNotFoundError:
|
|
||||||
pass
|
|
||||||
if linked:
|
|
||||||
raise StoreLinkedError(path)
|
|
||||||
|
|
||||||
|
|
||||||
@contextmanager
|
@contextmanager
|
||||||
def store_write_lock(path: Path, timeout: float = LOCK_TIMEOUT_SECONDS) -> Iterator[None]:
|
def store_write_lock(path: Path, timeout: float = LOCK_TIMEOUT_SECONDS) -> Iterator[None]:
|
||||||
"""Holds the exclusive store lock on `<path>.lock`, the lock the C#, Rust and TypeScript runtimes take: flock on Unix,
|
"""Holds the exclusive store lock on `<path>.lock`, the lock the C#, Rust and TypeScript runtimes take: flock on Unix,
|
||||||
LockFileEx over the whole file on Windows, polled every 10 ms with no handle held between polls. The lock file is
|
LockFileEx over the whole file on Windows, polled every 10 ms with no handle held between polls. The lock file is
|
||||||
created if absent and never written or deleted."""
|
created if absent and never written or deleted."""
|
||||||
_refuse_linked(path)
|
|
||||||
lock_path = path.with_name(path.name + ".lock")
|
lock_path = path.with_name(path.name + ".lock")
|
||||||
deadline = time.monotonic() + timeout
|
deadline = time.monotonic() + timeout
|
||||||
while True:
|
while True:
|
||||||
|
|
@ -537,8 +353,6 @@ def store_write_lock(path: Path, timeout: float = LOCK_TIMEOUT_SECONDS) -> Itera
|
||||||
raise TimeoutError(f"CultCache timed out after {timeout} s waiting for the store lock {lock_path}.")
|
raise TimeoutError(f"CultCache timed out after {timeout} s waiting for the store lock {lock_path}.")
|
||||||
time.sleep(_LOCK_POLL_SECONDS)
|
time.sleep(_LOCK_POLL_SECONDS)
|
||||||
try:
|
try:
|
||||||
# A link may have been put at the path while the lock was awaited; the look above only saw the path before.
|
|
||||||
_refuse_linked(path)
|
|
||||||
yield
|
yield
|
||||||
finally:
|
finally:
|
||||||
release()
|
release()
|
||||||
|
|
@ -775,65 +589,6 @@ def _schema_id_for(envelope: CultCacheEnvelope) -> str:
|
||||||
return envelope.schema_id or envelope.type
|
return envelope.schema_id or envelope.type
|
||||||
|
|
||||||
|
|
||||||
_STORED_AT_SHAPE = re.compile(
|
|
||||||
r"([0-9]{4})-([0-9]{2})-([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2})(?:\.([0-9]{1,9}))?(?:(Z)|([+-])([01][0-9]|2[0-3]):([0-5][0-9]))"
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def parse_stored_at(text: Any) -> datetime | None:
|
|
||||||
"""The UTC instant a stored_at text names, or None. Only the shape the runtimes write is a stamp: an RFC 3339 date-time with T,
|
|
||||||
an optional fraction of 1 to 9 digits (cut to the microsecond) and Z or a numeric offset of hours 00-23 and minutes 00-59. Checked here, not left to
|
|
||||||
fromisoformat, whose accepted set differs by interpreter (3.10 and 3.13) and from Rust and TypeScript. An instant outside
|
|
||||||
datetime's range is not a stamp."""
|
|
||||||
if not isinstance(text, str):
|
|
||||||
return None
|
|
||||||
shape = _STORED_AT_SHAPE.fullmatch(text)
|
|
||||||
if shape is None:
|
|
||||||
return None
|
|
||||||
year, month, day, hour, minute, second, fraction, zulu, sign, offset_hours, offset_minutes = shape.groups()
|
|
||||||
try:
|
|
||||||
offset = timezone.utc if zulu else timezone(
|
|
||||||
(-1 if sign == "-" else 1) * timedelta(hours=int(offset_hours), minutes=int(offset_minutes))
|
|
||||||
)
|
|
||||||
local = datetime(
|
|
||||||
int(year), int(month), int(day), int(hour), int(minute), int(second), int(((fraction or "") + "000000")[:6]), offset
|
|
||||||
)
|
|
||||||
return local.astimezone(timezone.utc)
|
|
||||||
except (ValueError, OverflowError):
|
|
||||||
return None
|
|
||||||
|
|
||||||
|
|
||||||
def mint_stored_at(previous: str | None, now: datetime) -> str:
|
|
||||||
"""A stored_at later than `previous` (C# MintStoredAt): `now`, or the microsecond after `previous` when `now` is not later.
|
|
||||||
A previous that does not parse leaves `now`. Raises ValueError, nothing minted, when `previous` is the last instant a stamp
|
|
||||||
can name, so a write over it is refused and writes nothing."""
|
|
||||||
now = now.astimezone(timezone.utc)
|
|
||||||
last = parse_stored_at(previous)
|
|
||||||
if last is not None and now <= last:
|
|
||||||
try:
|
|
||||||
now = last + timedelta(microseconds=1)
|
|
||||||
except OverflowError:
|
|
||||||
raise ValueError(f"stored_at {previous!r} is the last instant a stamp can name; a write over it cannot be stored later") from None
|
|
||||||
return now.isoformat(timespec="microseconds")
|
|
||||||
|
|
||||||
|
|
||||||
def stored_at_over(staged: str, replaced: str) -> str:
|
|
||||||
"""The stored_at a record replacing `replaced` is written with (C# StoredAtOver): `staged` when both parse and it is strictly
|
|
||||||
later, else one minted over `replaced`. No content is compared: every replacing write is stamped later."""
|
|
||||||
later, earlier = parse_stored_at(staged), parse_stored_at(replaced)
|
|
||||||
if later is not None and earlier is not None and later > earlier:
|
|
||||||
return staged
|
|
||||||
return mint_stored_at(replaced, datetime.now(timezone.utc))
|
|
||||||
|
|
||||||
|
|
||||||
def record_version(envelope: CultCacheEnvelope) -> str:
|
|
||||||
"""The content version of a stored record: the lowercase hex SHA-256 of its persisted encoding, the array
|
|
||||||
[key, schema id, stored_at, payload] exactly as the single-file store writes it
|
|
||||||
(variants:ruling:write-set-content-version-declared-ownership)."""
|
|
||||||
record = [envelope.key, _schema_id_for(envelope), envelope.stored_at, envelope.payload]
|
|
||||||
return hashlib.sha256(msgpack.packb(record, use_bin_type=True)).hexdigest()
|
|
||||||
|
|
||||||
|
|
||||||
def _default_catalog_entry(envelope: CultCacheEnvelope) -> CultCacheSchemaCatalogEntry:
|
def _default_catalog_entry(envelope: CultCacheEnvelope) -> CultCacheSchemaCatalogEntry:
|
||||||
schema_id = _schema_id_for(envelope)
|
schema_id = _schema_id_for(envelope)
|
||||||
return CultCacheSchemaCatalogEntry(
|
return CultCacheSchemaCatalogEntry(
|
||||||
|
|
|
||||||
|
|
@ -1,38 +0,0 @@
|
||||||
from __future__ import annotations
|
|
||||||
|
|
||||||
import shutil
|
|
||||||
import tempfile
|
|
||||||
import unittest
|
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
import msgpack
|
|
||||||
|
|
||||||
from cultcache_py import SingleFileMessagePackBackingStore
|
|
||||||
from cultcache_py.stores import record_version
|
|
||||||
|
|
||||||
# variants:ruling:write-set-content-version-declared-ownership. The vector in tests/vectors/content-version is written only by
|
|
||||||
# the C# reference; every row of it is computed here from the store file, by the store's read and by record_version.
|
|
||||||
VECTORS = Path(__file__).resolve().parents[3] / "tests" / "vectors" / "content-version"
|
|
||||||
|
|
||||||
|
|
||||||
class ContentVersionVectorTests(unittest.TestCase):
|
|
||||||
def test_every_row_of_the_vector_equals_this_runtimes_version(self) -> None:
|
|
||||||
rows = msgpack.unpackb((VECTORS / "versions.msgpack").read_bytes(), raw=False)
|
|
||||||
self.assertEqual([key for key, _ in rows], ["alpha", "beta"])
|
|
||||||
directory = Path(tempfile.mkdtemp())
|
|
||||||
self.addCleanup(shutil.rmtree, directory, ignore_errors=True)
|
|
||||||
copy = directory / "store.cc"
|
|
||||||
shutil.copyfile(VECTORS / "store.cc", copy)
|
|
||||||
store = SingleFileMessagePackBackingStore(copy)
|
|
||||||
by_key = {envelope.key: envelope for envelope in store.pull_all()}
|
|
||||||
for key, version in rows:
|
|
||||||
with self.subTest(key=key):
|
|
||||||
found = store.read(key)
|
|
||||||
self.assertIsNotNone(found)
|
|
||||||
self.assertEqual(found[1], version)
|
|
||||||
self.assertEqual(record_version(by_key[key]), version)
|
|
||||||
self.assertIsNone(store.read("gamma"))
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
unittest.main()
|
|
||||||
|
|
@ -12,7 +12,6 @@ from cultcache_py import (
|
||||||
CultCache,
|
CultCache,
|
||||||
JsonLinesBackingStore,
|
JsonLinesBackingStore,
|
||||||
SingleFileMessagePackBackingStore,
|
SingleFileMessagePackBackingStore,
|
||||||
StoreLinkedError,
|
|
||||||
StoreUnreadableError,
|
StoreUnreadableError,
|
||||||
define_database_entry_type,
|
define_database_entry_type,
|
||||||
define_document_type,
|
define_document_type,
|
||||||
|
|
@ -86,7 +85,7 @@ class CultCacheTests(unittest.TestCase):
|
||||||
)
|
)
|
||||||
cache.pull_all_backing_stores()
|
cache.pull_all_backing_stores()
|
||||||
cache.put(document, "item:potion", Item(name="Potion", category="Consumable", value=50))
|
cache.put(document, "item:potion", Item(name="Potion", category="Consumable", value=50))
|
||||||
cache.put(document, "item:potion", Item(name="Potion", category="Consumable", value=55))
|
cache.update(document, "item:potion", lambda item: Item(item.name, item.category, item.value + 5))
|
||||||
self.assertEqual(cache.get_required(document, "item:potion").value, 55)
|
self.assertEqual(cache.get_required(document, "item:potion").value, 55)
|
||||||
cache.delete(document, "item:potion")
|
cache.delete(document, "item:potion")
|
||||||
self.assertIsNone(cache.get(document, "item:potion"))
|
self.assertIsNone(cache.get(document, "item:potion"))
|
||||||
|
|
@ -1432,10 +1431,10 @@ class CultCacheTests(unittest.TestCase):
|
||||||
self.assertNotIn("SECRET", str(caught.exception))
|
self.assertNotIn("SECRET", str(caught.exception))
|
||||||
self.assertIn("not a valid store", str(caught.exception))
|
self.assertIn("not a valid store", str(caught.exception))
|
||||||
|
|
||||||
# A write at a store path that is a link is refused: a replace there would swap the link for a regular file and
|
# What a write does through a symbolic link today. R3 decides whether a write resolves
|
||||||
# detach the store from its target. Reads through a live link keep working.
|
# the link or refuses it; this pins the current behaviour so that change is deliberate.
|
||||||
@unittest.skipIf(os.name != "posix", "symbolic links need POSIX here")
|
@unittest.skipIf(os.name != "posix", "symbolic links need POSIX here")
|
||||||
def test_a_write_at_a_live_link_is_refused_and_nothing_changes_while_a_read_through_it_works(self) -> None:
|
def test_r3_decides_resolve_or_refuse_a_push_through_a_live_link_replaces_the_link(self) -> None:
|
||||||
with tempfile.TemporaryDirectory() as tmp:
|
with tempfile.TemporaryDirectory() as tmp:
|
||||||
volume = Path(tmp) / "volume"
|
volume = Path(tmp) / "volume"
|
||||||
volume.mkdir()
|
volume.mkdir()
|
||||||
|
|
@ -1443,91 +1442,12 @@ class CultCacheTests(unittest.TestCase):
|
||||||
envelope = CultCacheEnvelope(key="a", type="t", payload=b"\x90", stored_at="2026-09-30T00:00:00Z")
|
envelope = CultCacheEnvelope(key="a", type="t", payload=b"\x90", stored_at="2026-09-30T00:00:00Z")
|
||||||
SingleFileMessagePackBackingStore(target).push(envelope)
|
SingleFileMessagePackBackingStore(target).push(envelope)
|
||||||
before = target.read_bytes()
|
before = target.read_bytes()
|
||||||
volume_before = sorted(p.name for p in volume.iterdir())
|
link = Path(tmp) / "store.cc"
|
||||||
link = Path(tmp) / "link.cc"
|
|
||||||
link.symlink_to(target)
|
link.symlink_to(target)
|
||||||
store = SingleFileMessagePackBackingStore(link)
|
SingleFileMessagePackBackingStore(link).push(replace(envelope, key="b"))
|
||||||
for write in (
|
self.assertFalse(link.is_symlink())
|
||||||
lambda: store.push(replace(envelope, key="b")),
|
self.assertTrue(link.is_file())
|
||||||
lambda: store.push_all([replace(envelope, key="b")]),
|
|
||||||
lambda: store.delete("t", "a"),
|
|
||||||
):
|
|
||||||
with self.assertRaises(StoreLinkedError) as caught:
|
|
||||||
write()
|
|
||||||
self.assertIn(str(link), str(caught.exception))
|
|
||||||
self.assertTrue(link.is_symlink())
|
|
||||||
self.assertEqual(target.read_bytes(), before)
|
self.assertEqual(target.read_bytes(), before)
|
||||||
self.assertEqual(sorted(p.name for p in Path(tmp).iterdir()), ["link.cc", "volume"])
|
|
||||||
self.assertEqual(sorted(p.name for p in volume.iterdir()), volume_before)
|
|
||||||
self.assertEqual([item.key for item in store.pull_all()], ["a"])
|
|
||||||
|
|
||||||
@unittest.skipIf(os.name != "posix", "symbolic links need POSIX here")
|
|
||||||
def test_a_json_lines_write_at_a_live_link_is_refused_and_the_link_survives(self) -> None:
|
|
||||||
with tempfile.TemporaryDirectory() as tmp:
|
|
||||||
volume = Path(tmp) / "volume"
|
|
||||||
volume.mkdir()
|
|
||||||
target = volume / "store.jsonl"
|
|
||||||
envelope = CultCacheEnvelope(key="a", type="t", payload=b"\x90", stored_at="2026-09-30T00:00:00Z")
|
|
||||||
JsonLinesBackingStore(target).push(envelope)
|
|
||||||
before = target.read_bytes()
|
|
||||||
link = Path(tmp) / "link.jsonl"
|
|
||||||
link.symlink_to(target)
|
|
||||||
store = JsonLinesBackingStore(link)
|
|
||||||
for write in (
|
|
||||||
lambda: store.push(replace(envelope, key="b")),
|
|
||||||
lambda: store.push_all([replace(envelope, key="b")]),
|
|
||||||
lambda: store.delete("t", "a"),
|
|
||||||
):
|
|
||||||
with self.assertRaises(StoreLinkedError):
|
|
||||||
write()
|
|
||||||
self.assertTrue(link.is_symlink())
|
|
||||||
self.assertEqual(target.read_bytes(), before)
|
|
||||||
self.assertEqual(sorted(p.name for p in Path(tmp).iterdir()), ["link.jsonl", "volume"])
|
|
||||||
self.assertEqual(sorted(p.name for p in volume.iterdir()), ["store.jsonl"])
|
|
||||||
|
|
||||||
# The advisory query answers for the held record and the cache's judges; a link at the store path is the write's to refuse.
|
|
||||||
@unittest.skipIf(os.name != "posix", "symbolic links need POSIX here")
|
|
||||||
def test_is_writable_over_a_store_at_a_live_link_answers_true_while_the_cache_write_is_refused(self) -> None:
|
|
||||||
with tempfile.TemporaryDirectory() as tmp:
|
|
||||||
volume = Path(tmp) / "volume"
|
|
||||||
volume.mkdir()
|
|
||||||
target = volume / "store.cc"
|
|
||||||
document = item_doc()
|
|
||||||
seed = CultCache.builder().register_document_type(document).add_generic_store(SingleFileMessagePackBackingStore(target)).build()
|
|
||||||
seed.put(document, "held", Item(name="Held", category="c", value=1))
|
|
||||||
before = target.read_bytes()
|
|
||||||
link = Path(tmp) / "link.cc"
|
|
||||||
link.symlink_to(target)
|
|
||||||
cache = CultCache.builder().register_document_type(document).add_generic_store(SingleFileMessagePackBackingStore(link)).build()
|
|
||||||
cache.pull_all_backing_stores()
|
|
||||||
names_before = (sorted(p.name for p in Path(tmp).iterdir()), sorted(p.name for p in volume.iterdir()))
|
|
||||||
|
|
||||||
self.assertTrue(cache.is_writable(document, "held"))
|
|
||||||
self.assertTrue(cache.is_writable(document, "fresh"))
|
|
||||||
with self.assertRaises(StoreLinkedError) as caught:
|
|
||||||
cache.put(document, "fresh", Item(name="Fresh", category="d", value=2))
|
|
||||||
self.assertEqual(Path(caught.exception.path), link)
|
|
||||||
self.assertTrue(link.is_symlink())
|
|
||||||
self.assertEqual(target.read_bytes(), before)
|
|
||||||
self.assertEqual((sorted(p.name for p in Path(tmp).iterdir()), sorted(p.name for p in volume.iterdir())), names_before)
|
|
||||||
|
|
||||||
def test_store_linked_error_is_an_os_error_carrying_the_path(self) -> None:
|
|
||||||
error = StoreLinkedError(Path("some/store.cc"))
|
|
||||||
self.assertIsInstance(error, OSError)
|
|
||||||
self.assertEqual(error.path, Path("some/store.cc"))
|
|
||||||
|
|
||||||
@unittest.skipIf(os.name != "posix", "symbolic links need POSIX here")
|
|
||||||
def test_a_write_at_a_live_directory_link_is_refused_as_a_link(self) -> None:
|
|
||||||
with tempfile.TemporaryDirectory() as tmp:
|
|
||||||
real = Path(tmp) / "real"
|
|
||||||
real.mkdir()
|
|
||||||
link = Path(tmp) / "dirlink"
|
|
||||||
link.symlink_to(real, target_is_directory=True)
|
|
||||||
with self.assertRaises(StoreLinkedError):
|
|
||||||
SingleFileMessagePackBackingStore(link).push(
|
|
||||||
CultCacheEnvelope(key="a", type="t", payload=b"\x90", stored_at="2026-09-30T00:00:00Z"))
|
|
||||||
self.assertTrue(link.is_symlink())
|
|
||||||
self.assertEqual(list(real.iterdir()), [])
|
|
||||||
|
|
||||||
@unittest.skipIf(os.name != "posix", "symbolic links need POSIX here")
|
@unittest.skipIf(os.name != "posix", "symbolic links need POSIX here")
|
||||||
def test_a_dangling_symlink_at_a_store_path_is_an_os_error_and_nothing_is_written(self) -> None:
|
def test_a_dangling_symlink_at_a_store_path_is_an_os_error_and_nothing_is_written(self) -> None:
|
||||||
|
|
@ -1540,7 +1460,7 @@ class CultCacheTests(unittest.TestCase):
|
||||||
store = store_type(path)
|
store = store_type(path)
|
||||||
with self.assertRaises(FileNotFoundError):
|
with self.assertRaises(FileNotFoundError):
|
||||||
store.pull_all()
|
store.pull_all()
|
||||||
with self.assertRaises(StoreLinkedError):
|
with self.assertRaises(FileNotFoundError):
|
||||||
store.push(CultCacheEnvelope(key="k", type="t", payload=b"\x90", stored_at="2026-09-30T00:00:00Z"))
|
store.push(CultCacheEnvelope(key="k", type="t", payload=b"\x90", stored_at="2026-09-30T00:00:00Z"))
|
||||||
self.assertTrue(path.is_symlink())
|
self.assertTrue(path.is_symlink())
|
||||||
self.assertEqual(list(volume.iterdir()), [])
|
self.assertEqual(list(volume.iterdir()), [])
|
||||||
|
|
|
||||||
|
|
@ -4,8 +4,6 @@
|
||||||
import unittest
|
import unittest
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
from cultcache_py import UpdateOutcome
|
|
||||||
|
|
||||||
# snippet:begin
|
# snippet:begin
|
||||||
import tempfile
|
import tempfile
|
||||||
from dataclasses import asdict, dataclass
|
from dataclasses import asdict, dataclass
|
||||||
|
|
@ -53,44 +51,15 @@ def first_call() -> Item:
|
||||||
# snippet:end
|
# snippet:end
|
||||||
|
|
||||||
|
|
||||||
# snippet:update:begin
|
|
||||||
def restock(path: Path):
|
|
||||||
cache = (
|
|
||||||
CultCache.builder()
|
|
||||||
.register_document_type(item_doc)
|
|
||||||
.add_generic_store(SingleFileMessagePackBackingStore(path))
|
|
||||||
.build()
|
|
||||||
)
|
|
||||||
cache.pull_all_backing_stores()
|
|
||||||
return cache.update(item_doc, "item:potion", lambda item: Item("Potion", "Consumable", (item.value if item else 0) + 10))
|
|
||||||
# snippet:update:end
|
|
||||||
|
|
||||||
|
|
||||||
class FirstCallTests(unittest.TestCase):
|
class FirstCallTests(unittest.TestCase):
|
||||||
def test_first_call_round_trips_through_a_second_cache(self) -> None:
|
def test_first_call_round_trips_through_a_second_cache(self) -> None:
|
||||||
self.assertEqual(first_call(), Item("Potion", "Consumable", 50))
|
self.assertEqual(first_call(), Item("Potion", "Consumable", 50))
|
||||||
|
|
||||||
def test_update_with_retry_through_a_second_cache(self) -> None:
|
def test_docs_show_the_tested_snippet(self) -> None:
|
||||||
path = Path(tempfile.mkdtemp()) / "restock.cc"
|
|
||||||
restock(path)
|
|
||||||
result = restock(path)
|
|
||||||
self.assertIs(result.outcome, UpdateOutcome.UPDATED)
|
|
||||||
reopened = (
|
|
||||||
CultCache.builder()
|
|
||||||
.register_document_type(item_doc)
|
|
||||||
.add_generic_store(SingleFileMessagePackBackingStore(path))
|
|
||||||
.build()
|
|
||||||
)
|
|
||||||
reopened.pull_all_backing_stores()
|
|
||||||
self.assertEqual(reopened.get_required(item_doc, "item:potion"), Item("Potion", "Consumable", 20))
|
|
||||||
|
|
||||||
def test_docs_show_the_tested_snippets(self) -> None:
|
|
||||||
source = Path(__file__).read_text(encoding="utf-8")
|
source = Path(__file__).read_text(encoding="utf-8")
|
||||||
|
snippet = source.split("# snippet:begin\n", 1)[1].split("# snippet:end\n", 1)[0]
|
||||||
docs = (Path(__file__).parents[3] / "docs" / "start" / "README.md").read_text(encoding="utf-8")
|
docs = (Path(__file__).parents[3] / "docs" / "start" / "README.md").read_text(encoding="utf-8")
|
||||||
for region in ("snippet", "snippet:update"):
|
self.assertIn("```python\n" + snippet + "```", docs)
|
||||||
with self.subTest(region=region):
|
|
||||||
snippet = source.split(f"# {region}:begin\n", 1)[1].split(f"# {region}:end\n", 1)[0]
|
|
||||||
self.assertIn("```python\n" + snippet + "```", docs)
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
|
|
|
||||||
|
|
@ -16,7 +16,6 @@ from cultcache_py import (
|
||||||
SlotCodec,
|
SlotCodec,
|
||||||
SchemaConflictError,
|
SchemaConflictError,
|
||||||
SingleFileMessagePackBackingStore,
|
SingleFileMessagePackBackingStore,
|
||||||
StoreUnreadableError,
|
|
||||||
UnionArm,
|
UnionArm,
|
||||||
UnreadSlots,
|
UnreadSlots,
|
||||||
database_entry_field,
|
database_entry_field,
|
||||||
|
|
@ -179,22 +178,6 @@ class StoreRowTests(unittest.TestCase):
|
||||||
return slot_unit_document
|
return slot_unit_document
|
||||||
return declaring_document if store == "extra-slot-consent.cc" else surface_document
|
return declaring_document if store == "extra-slot-consent.cc" else surface_document
|
||||||
|
|
||||||
def test_the_variant_row_is_refused_as_a_store_not_walked_and_the_rest_of_the_store_reads_without_it(self) -> None:
|
|
||||||
# This runtime holds no variant records (ruling: refuse, not carry; the reference's marked-variant row, the one
|
|
||||||
# row with a flattenRefusedBy, is the C# reader's). A five-slot persisted record makes the whole store
|
|
||||||
# unreadable, the file is left as it was, and the store without exactly that row reads.
|
|
||||||
variants = [row for row in _rows() if row[8] is not None]
|
|
||||||
self.assertEqual([(row[0], row[1], row[8]) for row in variants], [("extra-slot-store.cc", "marked-variant", "marked")])
|
|
||||||
path = self.tmp / "extra-slot-store.cc"
|
|
||||||
shutil.copyfile(VECTORS / "extra-slot-store.cc", path)
|
|
||||||
before = path.read_bytes()
|
|
||||||
with self.assertRaises(StoreUnreadableError):
|
|
||||||
_open(path, surface_document, slot_unit_document)
|
|
||||||
self.assertEqual(path.read_bytes(), before)
|
|
||||||
_, cache = self._store("extra-slot-store.cc")
|
|
||||||
self.assertIsNone(cache.get(surface_document, "marked-variant"))
|
|
||||||
self.assertIsNotNone(cache.get(surface_document, "marked"))
|
|
||||||
|
|
||||||
def test_every_row_is_writable_exactly_where_the_vector_says_and_refuses_with_its_mark(self) -> None:
|
def test_every_row_is_writable_exactly_where_the_vector_says_and_refuses_with_its_mark(self) -> None:
|
||||||
walked = 0
|
walked = 0
|
||||||
for store, key, writable, explained, type_name, carried, declared, occurrences, flatten in _rows():
|
for store, key, writable, explained, type_name, carried, declared, occurrences, flatten in _rows():
|
||||||
|
|
|
||||||
|
|
@ -1,140 +0,0 @@
|
||||||
from __future__ import annotations
|
|
||||||
|
|
||||||
import shutil
|
|
||||||
import tempfile
|
|
||||||
import unittest
|
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
from cultcache_py import JsonLinesBackingStore, SingleFileMessagePackBackingStore, StoreUnreadableError
|
|
||||||
from cultcache_py.backing_store import BackingStore, CultCacheEnvelope
|
|
||||||
|
|
||||||
|
|
||||||
def envelope(key: str) -> CultCacheEnvelope:
|
|
||||||
return CultCacheEnvelope(key=key, type="t", payload=b"\x01", stored_at="2026-11-06T00:00:00Z")
|
|
||||||
|
|
||||||
|
|
||||||
class SoftPushAllTests(unittest.TestCase):
|
|
||||||
"""A soft push writes where nothing is, skips a store it reads, and refuses one it cannot read (TS and Rust parity)."""
|
|
||||||
|
|
||||||
def setUp(self) -> None:
|
|
||||||
self.dir = Path(tempfile.mkdtemp())
|
|
||||||
self.addCleanup(shutil.rmtree, self.dir, ignore_errors=True)
|
|
||||||
self.path = self.dir / "state.cc"
|
|
||||||
|
|
||||||
def test_over_a_readable_store_it_leaves_the_file_byte_for_byte(self) -> None:
|
|
||||||
for make in (SingleFileMessagePackBackingStore, JsonLinesBackingStore):
|
|
||||||
with self.subTest(make.__name__):
|
|
||||||
path = self.dir / make.__name__
|
|
||||||
store = make(path)
|
|
||||||
store.push_all([envelope("a")])
|
|
||||||
before = path.read_bytes()
|
|
||||||
store.push_all([envelope("b")], soft=True)
|
|
||||||
self.assertEqual(before, path.read_bytes())
|
|
||||||
self.assertEqual(["a"], [item.key for item in make(path).pull_all()])
|
|
||||||
store.push_all([envelope("b")]) # a plain push still lands what the caller holds
|
|
||||||
self.assertEqual(["a", "b"], sorted(item.key for item in make(path).pull_all()))
|
|
||||||
|
|
||||||
def test_over_a_readable_store_holding_no_records_it_leaves_the_file_byte_for_byte(self) -> None:
|
|
||||||
for make in (SingleFileMessagePackBackingStore, JsonLinesBackingStore):
|
|
||||||
with self.subTest(make.__name__):
|
|
||||||
path = self.dir / make.__name__
|
|
||||||
store = make(path)
|
|
||||||
store.push_all([envelope("a")])
|
|
||||||
store.delete("t", "a")
|
|
||||||
self.assertTrue(path.exists())
|
|
||||||
self.assertEqual([], make(path).pull_all())
|
|
||||||
before = path.read_bytes()
|
|
||||||
store.push_all([envelope("b")], soft=True)
|
|
||||||
self.assertEqual(before, path.read_bytes())
|
|
||||||
self.assertEqual([], make(path).pull_all())
|
|
||||||
|
|
||||||
def test_over_an_absent_path_it_writes(self) -> None:
|
|
||||||
for make in (SingleFileMessagePackBackingStore, JsonLinesBackingStore):
|
|
||||||
with self.subTest(make.__name__):
|
|
||||||
path = self.dir / make.__name__
|
|
||||||
make(path).push_all([envelope("a")], soft=True)
|
|
||||||
self.assertEqual(["a"], [item.key for item in make(path).pull_all()])
|
|
||||||
|
|
||||||
def test_over_an_unreadable_file_it_refuses_and_leaves_it(self) -> None:
|
|
||||||
junk = b"\xc1\x01\x02\x03"
|
|
||||||
self.path.write_bytes(junk)
|
|
||||||
with self.assertRaises(StoreUnreadableError):
|
|
||||||
SingleFileMessagePackBackingStore(self.path).push_all([envelope("a")], soft=True)
|
|
||||||
self.assertEqual(junk, self.path.read_bytes())
|
|
||||||
|
|
||||||
def test_over_an_unreadable_jsonl_file_it_refuses_and_leaves_it(self) -> None:
|
|
||||||
junk = b"this is not json\n"
|
|
||||||
self.path.write_bytes(junk)
|
|
||||||
with self.assertRaises(ValueError):
|
|
||||||
JsonLinesBackingStore(self.path).push_all([envelope("a")], soft=True)
|
|
||||||
self.assertEqual(junk, self.path.read_bytes())
|
|
||||||
|
|
||||||
def test_the_protocol_default_push_all_decides_soft_by_what_pull_or_absent_says(self) -> None:
|
|
||||||
class Memory(BackingStore):
|
|
||||||
def __init__(self) -> None:
|
|
||||||
self.items: list[CultCacheEnvelope] | None = None # None: nothing at the path
|
|
||||||
|
|
||||||
def pull_all(self) -> list[CultCacheEnvelope]:
|
|
||||||
return list(self.items or [])
|
|
||||||
|
|
||||||
def pull_or_absent(self) -> list[CultCacheEnvelope] | None:
|
|
||||||
return None if self.items is None else list(self.items)
|
|
||||||
|
|
||||||
def _replace_all(self, envelopes: list[CultCacheEnvelope]) -> None:
|
|
||||||
self.items = list(envelopes)
|
|
||||||
|
|
||||||
store = Memory()
|
|
||||||
store.push_all([envelope("a")], soft=True) # nothing at the path: writes
|
|
||||||
self.assertEqual(["a"], [item.key for item in store.items or []])
|
|
||||||
store.push_all([envelope("b")], soft=True) # a store with records: skips
|
|
||||||
self.assertEqual(["a"], [item.key for item in store.items or []])
|
|
||||||
store.items = []
|
|
||||||
store.push_all([envelope("b")], soft=True) # a store the reader read, empty: skips
|
|
||||||
self.assertEqual([], store.items)
|
|
||||||
store.push_all([envelope("b")]) # plain: lands
|
|
||||||
self.assertEqual(["b"], [item.key for item in store.items])
|
|
||||||
|
|
||||||
def test_a_store_that_only_pulls_all_is_read_so_a_soft_push_skips_it(self) -> None:
|
|
||||||
class PullOnly(BackingStore):
|
|
||||||
def __init__(self) -> None:
|
|
||||||
self.items: list[CultCacheEnvelope] = []
|
|
||||||
|
|
||||||
def pull_all(self) -> list[CultCacheEnvelope]:
|
|
||||||
return list(self.items)
|
|
||||||
|
|
||||||
def _replace_all(self, envelopes: list[CultCacheEnvelope]) -> None:
|
|
||||||
self.items = list(envelopes)
|
|
||||||
|
|
||||||
store = PullOnly()
|
|
||||||
store.push_all([envelope("a")], soft=True)
|
|
||||||
self.assertEqual([], store.items)
|
|
||||||
|
|
||||||
def test_the_single_file_and_jsonl_stores_say_absent_and_read_through_pull_or_absent(self) -> None:
|
|
||||||
for make in (SingleFileMessagePackBackingStore, JsonLinesBackingStore):
|
|
||||||
with self.subTest(make.__name__):
|
|
||||||
path = self.dir / make.__name__
|
|
||||||
store = make(path)
|
|
||||||
self.assertIsNone(store.pull_or_absent())
|
|
||||||
store.push_all([envelope("a")])
|
|
||||||
self.assertEqual(["a"], [item.key for item in store.pull_or_absent() or []])
|
|
||||||
|
|
||||||
def test_the_protocol_default_push_all_refuses_where_its_pull_refuses(self) -> None:
|
|
||||||
class Unreadable(BackingStore):
|
|
||||||
replaced = False
|
|
||||||
|
|
||||||
def pull_all(self) -> list[CultCacheEnvelope]:
|
|
||||||
raise StoreUnreadableError(Path("x"), ValueError("junk"))
|
|
||||||
|
|
||||||
def pull_or_absent(self) -> list[CultCacheEnvelope] | None:
|
|
||||||
raise StoreUnreadableError(Path("x"), ValueError("junk"))
|
|
||||||
|
|
||||||
def _replace_all(self, envelopes: list[CultCacheEnvelope]) -> None:
|
|
||||||
Unreadable.replaced = True
|
|
||||||
|
|
||||||
with self.assertRaises(StoreUnreadableError):
|
|
||||||
Unreadable().push_all([envelope("a")], soft=True)
|
|
||||||
self.assertFalse(Unreadable.replaced)
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
unittest.main()
|
|
||||||
|
|
@ -1,25 +1,21 @@
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import os
|
import os
|
||||||
import select
|
|
||||||
import shutil
|
import shutil
|
||||||
import subprocess
|
import subprocess
|
||||||
import sys
|
import sys
|
||||||
import tempfile
|
import tempfile
|
||||||
import threading
|
|
||||||
import time
|
import time
|
||||||
import unittest
|
import unittest
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from unittest import mock
|
from unittest import mock
|
||||||
|
|
||||||
from cultcache_py import SingleFileMessagePackBackingStore, stores
|
from cultcache_py import SingleFileMessagePackBackingStore, stores
|
||||||
from cultcache_py.stores import StoreLinkedError, store_write_lock
|
|
||||||
from cultcache_py.backing_store import CultCacheEnvelope
|
from cultcache_py.backing_store import CultCacheEnvelope
|
||||||
|
|
||||||
REPO = Path(__file__).resolve().parents[3]
|
REPO = Path(__file__).resolve().parents[3]
|
||||||
TS_STORE_FILE = REPO / "packages" / "cultcache-ts" / "dist" / "store-file.js"
|
TS_STORE_FILE = REPO / "packages" / "cultcache-ts" / "dist" / "store-file.js"
|
||||||
HOLD_SECONDS = 1.5
|
HOLD_SECONDS = 1.5
|
||||||
HELD_WAIT_SECONDS = 3
|
|
||||||
|
|
||||||
# A holder that takes the lock the way the Rust runtime does (an exclusive file lock), not through this package.
|
# A holder that takes the lock the way the Rust runtime does (an exclusive file lock), not through this package.
|
||||||
PY_HOLDER = """
|
PY_HOLDER = """
|
||||||
|
|
@ -45,14 +41,7 @@ def envelope(key: str) -> CultCacheEnvelope:
|
||||||
|
|
||||||
def start_holder(argv: list[str]) -> subprocess.Popen[str]:
|
def start_holder(argv: list[str]) -> subprocess.Popen[str]:
|
||||||
holder = subprocess.Popen(argv, stdout=subprocess.PIPE, text=True)
|
holder = subprocess.Popen(argv, stdout=subprocess.PIPE, text=True)
|
||||||
assert holder.stdout is not None
|
assert holder.stdout is not None and holder.stdout.readline().strip() == "HELD"
|
||||||
ready, _, _ = select.select([holder.stdout], [], [], HELD_WAIT_SECONDS) # a holder blocked on a leaked lock never prints
|
|
||||||
if not ready:
|
|
||||||
holder.kill()
|
|
||||||
holder.wait()
|
|
||||||
holder.stdout.close()
|
|
||||||
raise AssertionError(f"the holder never took {argv[-2]}.lock within {HELD_WAIT_SECONDS} s: an earlier writer leaked the lock")
|
|
||||||
assert holder.stdout.readline().strip() == "HELD"
|
|
||||||
holder.held_at = time.monotonic() # type: ignore[attr-defined]
|
holder.held_at = time.monotonic() # type: ignore[attr-defined]
|
||||||
return holder
|
return holder
|
||||||
|
|
||||||
|
|
@ -84,48 +73,6 @@ class StoreLockTests(unittest.TestCase):
|
||||||
holder = start_holder(["node", "-e", TS_HOLDER, str(TS_STORE_FILE), str(self.path), str(HOLD_SECONDS)])
|
holder = start_holder(["node", "-e", TS_HOLDER, str(TS_STORE_FILE), str(self.path), str(HOLD_SECONDS)])
|
||||||
self.assert_write_waits_for(holder)
|
self.assert_write_waits_for(holder)
|
||||||
|
|
||||||
def test_a_link_put_while_a_writer_waits_on_the_lock_is_refused_once_it_holds_it(self) -> None:
|
|
||||||
target = self.dir / "volume" / "store.cc"
|
|
||||||
target.parent.mkdir()
|
|
||||||
SingleFileMessagePackBackingStore(target).push(envelope("a"))
|
|
||||||
before = target.read_bytes()
|
|
||||||
writes = {
|
|
||||||
"push": lambda store: store.push(envelope("b")),
|
|
||||||
"push_all": lambda store: store.push_all([envelope("b")]),
|
|
||||||
"delete": lambda store: store.delete("t", "a"),
|
|
||||||
}
|
|
||||||
missing = self.dir / "volume" / "missing.cc"
|
|
||||||
for (name, write), link_to in [(item, to) for item in writes.items() for to in (target, missing)]:
|
|
||||||
with self.subTest(name, dangling=link_to == missing):
|
|
||||||
if os.path.lexists(self.path):
|
|
||||||
os.unlink(self.path)
|
|
||||||
holder = start_holder([sys.executable, "-c", PY_HOLDER, str(self.path), str(HOLD_SECONDS)])
|
|
||||||
self.addCleanup(holder.wait)
|
|
||||||
self.addCleanup(holder.stdout.close) # type: ignore[union-attr]
|
|
||||||
outcome: list[BaseException | None] = []
|
|
||||||
|
|
||||||
def run() -> None:
|
|
||||||
try:
|
|
||||||
write(SingleFileMessagePackBackingStore(self.path, lock_timeout=10))
|
|
||||||
outcome.append(None)
|
|
||||||
except BaseException as exc: # noqa: BLE001 - the thread hands the outcome to the test
|
|
||||||
outcome.append(exc)
|
|
||||||
|
|
||||||
writer = threading.Thread(target=run)
|
|
||||||
writer.start()
|
|
||||||
time.sleep(0.3)
|
|
||||||
os.symlink(link_to, self.path) # after the writer's pre-lock look, while it waits
|
|
||||||
writer.join()
|
|
||||||
holder.wait()
|
|
||||||
self.assertEqual(1, len(outcome))
|
|
||||||
self.assertIsInstance(outcome[0], StoreLinkedError)
|
|
||||||
self.assertTrue(os.path.islink(self.path), "the link was replaced")
|
|
||||||
self.assertEqual(before, target.read_bytes())
|
|
||||||
self.assertFalse(missing.exists(), "the dangling target was created")
|
|
||||||
os.unlink(self.path) # a link is refused before the lock, so remove it to probe the writer's own lock file
|
|
||||||
with store_write_lock(self.path, timeout=0.2): # the lock is free
|
|
||||||
pass
|
|
||||||
|
|
||||||
def test_the_lock_is_released_after_each_write(self) -> None:
|
def test_the_lock_is_released_after_each_write(self) -> None:
|
||||||
store = SingleFileMessagePackBackingStore(self.path, lock_timeout=0.2)
|
store = SingleFileMessagePackBackingStore(self.path, lock_timeout=0.2)
|
||||||
for key in "abc":
|
for key in "abc":
|
||||||
|
|
|
||||||
|
|
@ -1,137 +0,0 @@
|
||||||
from __future__ import annotations
|
|
||||||
|
|
||||||
import os
|
|
||||||
import sys
|
|
||||||
import tempfile
|
|
||||||
import unittest
|
|
||||||
from pathlib import Path
|
|
||||||
from unittest import mock
|
|
||||||
|
|
||||||
from cultcache_py import SingleFileMessagePackBackingStore, stores
|
|
||||||
from cultcache_py.backing_store import CultCacheEnvelope
|
|
||||||
from cultcache_py.stores import MOVEFILE_REPLACE_WRITE_THROUGH, ReplaceKernel, replace_store_windows
|
|
||||||
|
|
||||||
|
|
||||||
class FakeKernel(ReplaceKernel):
|
|
||||||
def __init__(self, posix: list[int], move_ex: list[int]) -> None:
|
|
||||||
self.posix, self.move_ex = list(posix), list(move_ex)
|
|
||||||
self.log: list[str] = []
|
|
||||||
self.sleeps: list[float] = []
|
|
||||||
|
|
||||||
def rename_posix(self, staged, destination):
|
|
||||||
self.log.append("posix")
|
|
||||||
return self.posix.pop(0) if self.posix else 0
|
|
||||||
|
|
||||||
def move_file_ex(self, staged, destination, flags):
|
|
||||||
self.log.append(f"moveex:{flags}")
|
|
||||||
return self.move_ex.pop(0) if self.move_ex else 0
|
|
||||||
|
|
||||||
def sleep(self, seconds):
|
|
||||||
self.sleeps.append(seconds)
|
|
||||||
|
|
||||||
|
|
||||||
def run(posix, move_ex):
|
|
||||||
kernel = FakeKernel(posix, move_ex)
|
|
||||||
return kernel, lambda: replace_store_windows("a", "b", kernel)
|
|
||||||
|
|
||||||
|
|
||||||
class WindowsReplaceTable(unittest.TestCase):
|
|
||||||
def test_falls_back_to_write_through_move_where_posix_rename_is_unsupported(self):
|
|
||||||
self.assertEqual(MOVEFILE_REPLACE_WRITE_THROUGH, 0x9)
|
|
||||||
for unsupported in (1, 50, 87):
|
|
||||||
kernel, go = run([unsupported], [0])
|
|
||||||
go()
|
|
||||||
self.assertEqual(kernel.log, ["posix", "moveex:9"])
|
|
||||||
|
|
||||||
def test_once_on_move_the_rest_of_the_call_stays_there(self):
|
|
||||||
kernel, go = run([87], [32, 0])
|
|
||||||
go()
|
|
||||||
self.assertEqual(kernel.log, ["posix", "moveex:9", "moveex:9"])
|
|
||||||
|
|
||||||
def test_transient_codes_retry_the_same_primitive(self):
|
|
||||||
for transient in (5, 32, 33):
|
|
||||||
kernel, go = run([transient, transient, 0], [])
|
|
||||||
go()
|
|
||||||
self.assertEqual(kernel.log, ["posix", "posix", "posix"])
|
|
||||||
self.assertEqual(kernel.sleeps, [0.02, 0.02])
|
|
||||||
|
|
||||||
def test_a_working_posix_rename_is_the_whole_replace(self):
|
|
||||||
kernel, go = run([0], [])
|
|
||||||
go()
|
|
||||||
self.assertEqual(kernel.log, ["posix"])
|
|
||||||
self.assertEqual(kernel.sleeps, [])
|
|
||||||
|
|
||||||
def test_unsupported_after_the_fallback_is_an_error_not_another_fallback(self):
|
|
||||||
kernel, go = run([87], [32, 87])
|
|
||||||
with self.assertRaisesRegex(OSError, "Win32 error 87") as caught:
|
|
||||||
go()
|
|
||||||
self.assertEqual(caught.exception.winerror, 87)
|
|
||||||
self.assertEqual(kernel.log, ["posix", "moveex:9", "moveex:9"])
|
|
||||||
for unsupported in (1, 50, 87):
|
|
||||||
kernel, go = run([87], [unsupported])
|
|
||||||
with self.assertRaisesRegex(OSError, f"Win32 error {unsupported}"):
|
|
||||||
go()
|
|
||||||
self.assertEqual(kernel.log, ["posix", "moveex:9"])
|
|
||||||
|
|
||||||
def test_gives_up_after_25_attempts_naming_the_last_code(self):
|
|
||||||
kernel, go = run([32] * 30, [])
|
|
||||||
with self.assertRaisesRegex(OSError, "after 25 attempts: last Win32 error 32\\."):
|
|
||||||
go()
|
|
||||||
self.assertEqual(len(kernel.log), 25)
|
|
||||||
|
|
||||||
def test_other_codes_fail_at_once(self):
|
|
||||||
kernel, go = run([2], [])
|
|
||||||
with self.assertRaisesRegex(OSError, "Win32 error 2"):
|
|
||||||
go()
|
|
||||||
self.assertEqual(len(kernel.log), 1)
|
|
||||||
kernel, go = run([87], [3])
|
|
||||||
with self.assertRaisesRegex(OSError, "Win32 error 3"):
|
|
||||||
go()
|
|
||||||
|
|
||||||
|
|
||||||
class StoreWritesRouteThroughTheReplace(unittest.TestCase):
|
|
||||||
def test_both_stores_replace_through_replace_store(self):
|
|
||||||
seen: list[tuple[Path, Path]] = []
|
|
||||||
real = stores._replace_store
|
|
||||||
|
|
||||||
def spy(staged, destination):
|
|
||||||
seen.append((Path(staged), Path(destination)))
|
|
||||||
real(staged, destination)
|
|
||||||
|
|
||||||
with tempfile.TemporaryDirectory() as directory, mock.patch.object(stores, "_replace_store", spy):
|
|
||||||
envelope = CultCacheEnvelope(key="k", type="t", payload=b"\x01", stored_at="2026-11-06T00:00:00Z")
|
|
||||||
binary = Path(directory) / "s.cc"
|
|
||||||
SingleFileMessagePackBackingStore(binary).push_all([envelope])
|
|
||||||
lines = Path(directory) / "s.jsonl"
|
|
||||||
stores.JsonLinesBackingStore(lines).push_all([envelope])
|
|
||||||
self.assertEqual([destination for _, destination in seen], [binary, lines])
|
|
||||||
self.assertTrue(binary.read_bytes() and lines.read_text())
|
|
||||||
|
|
||||||
def test_a_failed_jsonl_replace_leaves_no_staged_file_and_the_old_store(self):
|
|
||||||
envelope = CultCacheEnvelope(key="k", type="t", payload=b"\x01", stored_at="2026-11-06T00:00:00Z")
|
|
||||||
with tempfile.TemporaryDirectory() as directory:
|
|
||||||
lines = Path(directory) / "s.jsonl"
|
|
||||||
store = stores.JsonLinesBackingStore(lines)
|
|
||||||
store.push_all([envelope])
|
|
||||||
before = lines.read_bytes()
|
|
||||||
with mock.patch.object(stores, "_replace_store", side_effect=OSError("replace refused")):
|
|
||||||
with self.assertRaises(OSError):
|
|
||||||
store.push_all([CultCacheEnvelope(key="k2", type="t", payload=b"\x02", stored_at="2026-11-06T00:00:00Z")])
|
|
||||||
self.assertEqual(lines.read_bytes(), before)
|
|
||||||
self.assertEqual([p.name for p in Path(directory).iterdir() if ".tmp" in p.name], [])
|
|
||||||
|
|
||||||
@unittest.skipUnless(sys.platform == "win32", "needs a real Windows")
|
|
||||||
def test_real_kernel_replaces_through_both_primitives(self):
|
|
||||||
kernel = stores.WindowsReplaceKernel()
|
|
||||||
with tempfile.TemporaryDirectory() as directory:
|
|
||||||
for name, replace in (("posix", kernel.rename_posix), ("moveex", lambda s, d: kernel.move_file_ex(s, d, MOVEFILE_REPLACE_WRITE_THROUGH))):
|
|
||||||
staged, store = Path(directory, name + ".tmp"), Path(directory, name)
|
|
||||||
store.write_bytes(b"old")
|
|
||||||
staged.write_bytes(b"new")
|
|
||||||
self.assertEqual(replace(str(staged), str(store)), 0)
|
|
||||||
self.assertEqual(store.read_bytes(), b"new")
|
|
||||||
self.assertEqual(kernel.rename_posix(str(Path(directory, "missing")), str(Path(directory, "x"))), 2)
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
unittest.main()
|
|
||||||
|
|
@ -148,6 +148,7 @@ class UniqueIndexTests(unittest.TestCase):
|
||||||
"put": lambda cache, d, k, i: cache.put(d, k, i),
|
"put": lambda cache, d, k, i: cache.put(d, k, i),
|
||||||
"put_envelope": lambda cache, d, k, i: cache.put_envelope(d, envelope(d, k, i)),
|
"put_envelope": lambda cache, d, k, i: cache.put_envelope(d, envelope(d, k, i)),
|
||||||
"put_envelopes": lambda cache, d, k, i: cache.put_envelopes(d, [envelope(d, k, i)]),
|
"put_envelopes": lambda cache, d, k, i: cache.put_envelopes(d, [envelope(d, k, i)]),
|
||||||
|
"update": lambda cache, d, k, i: cache.update(d, k, lambda _held: i),
|
||||||
}
|
}
|
||||||
for name, write in paths.items():
|
for name, write in paths.items():
|
||||||
with self.subTest(alias=alias, path=name):
|
with self.subTest(alias=alias, path=name):
|
||||||
|
|
|
||||||
|
|
@ -1,731 +0,0 @@
|
||||||
"""CultCache.update (variants:cut_spec:cut-update-with-retry-py): read the record as its home store holds it, apply a function,
|
|
||||||
commit only if the record is unchanged, run the function again on a lost race. Mirrors C# UpdateTests and the TS update tests."""
|
|
||||||
|
|
||||||
from __future__ import annotations
|
|
||||||
|
|
||||||
import shutil
|
|
||||||
import tempfile
|
|
||||||
import threading
|
|
||||||
import time
|
|
||||||
import unittest
|
|
||||||
from dataclasses import asdict, dataclass
|
|
||||||
from datetime import datetime, timezone
|
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
from cultcache_py import (
|
|
||||||
CultCache,
|
|
||||||
CultCacheEnvelope,
|
|
||||||
JsonLinesBackingStore,
|
|
||||||
SchemaConflictError,
|
|
||||||
SingleFileMessagePackBackingStore,
|
|
||||||
UpdateOutcome,
|
|
||||||
UpdateResult,
|
|
||||||
database_entry_field,
|
|
||||||
define_database_entry_type,
|
|
||||||
define_document_type,
|
|
||||||
leaves as t,
|
|
||||||
)
|
|
||||||
from cultcache_py.cache import GLOBAL_KEY, CultCacheError
|
|
||||||
from cultcache_py.stores import parse_stored_at, mint_stored_at, record_version, stored_at_over
|
|
||||||
|
|
||||||
|
|
||||||
@dataclass
|
|
||||||
class Item:
|
|
||||||
name: str = "n"
|
|
||||||
value: int = 0
|
|
||||||
sku: str | None = None
|
|
||||||
|
|
||||||
|
|
||||||
def _doc(type: str, **extra):
|
|
||||||
return define_document_type(type, encode=asdict, decode=lambda raw: Item(**raw), **extra)
|
|
||||||
|
|
||||||
|
|
||||||
item_doc = _doc("item")
|
|
||||||
other_doc = _doc("other")
|
|
||||||
sku_doc = _doc("skuitem", indexes={"sku": "sku"})
|
|
||||||
global_doc = _doc("gitem", global_document=True)
|
|
||||||
|
|
||||||
@dataclass
|
|
||||||
class Wide:
|
|
||||||
name: str = ""
|
|
||||||
extra: str = ""
|
|
||||||
|
|
||||||
|
|
||||||
@dataclass
|
|
||||||
class Narrow:
|
|
||||||
name: str = ""
|
|
||||||
|
|
||||||
|
|
||||||
ALPHA = "2099-01-01T00:00:00.0000000Z"
|
|
||||||
|
|
||||||
|
|
||||||
class Fixture(unittest.TestCase):
|
|
||||||
def setUp(self) -> None:
|
|
||||||
self.dir = Path(tempfile.mkdtemp())
|
|
||||||
self.addCleanup(shutil.rmtree, self.dir, ignore_errors=True)
|
|
||||||
self.path = self.dir / "state.cc"
|
|
||||||
|
|
||||||
def cache(self, *documents, path: Path | None = None, store=True) -> CultCache:
|
|
||||||
builder = CultCache.builder()
|
|
||||||
for document in documents or (item_doc,):
|
|
||||||
builder.register_document_type(document)
|
|
||||||
if store:
|
|
||||||
builder.add_generic_store(SingleFileMessagePackBackingStore(path or self.path))
|
|
||||||
cache = builder.build()
|
|
||||||
if store:
|
|
||||||
cache.pull_all_backing_stores()
|
|
||||||
return cache
|
|
||||||
|
|
||||||
def stored(self, key: str = "k", document=item_doc):
|
|
||||||
"""What a fresh cache reads at the key."""
|
|
||||||
return self.cache(document).get(document, key)
|
|
||||||
|
|
||||||
def bytes(self) -> bytes | None:
|
|
||||||
return self.path.read_bytes() if self.path.exists() else None
|
|
||||||
|
|
||||||
|
|
||||||
class Counting:
|
|
||||||
"""An apply that records what it was given."""
|
|
||||||
|
|
||||||
def __init__(self, fn=None) -> None:
|
|
||||||
self.seen: list = []
|
|
||||||
self.fn = fn or (lambda item, calls: Item("n", (item.value if item else 0) + 1))
|
|
||||||
|
|
||||||
def __call__(self, item):
|
|
||||||
self.seen.append(None if item is None else item.value)
|
|
||||||
# An always-losing apply must fail by assertion when the attempt bound is gone, not hang.
|
|
||||||
assert len(self.seen) <= 10, "apply ran past the attempt bound"
|
|
||||||
return self.fn(item, len(self.seen))
|
|
||||||
|
|
||||||
@property
|
|
||||||
def calls(self) -> int:
|
|
||||||
return len(self.seen)
|
|
||||||
|
|
||||||
|
|
||||||
class UpdateTests(Fixture):
|
|
||||||
def test_two_writers_updating_lose_no_increment(self) -> None:
|
|
||||||
results: list[UpdateResult] = []
|
|
||||||
calls = [0]
|
|
||||||
lock = threading.Lock()
|
|
||||||
a, b = self.cache(), self.cache()
|
|
||||||
a.put(item_doc, "k", Item("n", 0))
|
|
||||||
|
|
||||||
def bump(item):
|
|
||||||
with lock:
|
|
||||||
calls[0] += 1
|
|
||||||
time.sleep(0)
|
|
||||||
return Item("n", item.value + 1)
|
|
||||||
|
|
||||||
def run(cache) -> None:
|
|
||||||
for _ in range(50):
|
|
||||||
results.append(cache.update(item_doc, "k", bump, max_attempts=200))
|
|
||||||
|
|
||||||
threads = [threading.Thread(target=run, args=(cache,)) for cache in (a, b)]
|
|
||||||
for thread in threads:
|
|
||||||
thread.start()
|
|
||||||
for thread in threads:
|
|
||||||
thread.join()
|
|
||||||
self.assertTrue(all(result.outcome is UpdateOutcome.UPDATED for result in results))
|
|
||||||
self.assertEqual(self.stored().value, 100)
|
|
||||||
self.assertGreater(calls[0], 100)
|
|
||||||
|
|
||||||
def test_a_lost_attempt_reruns_apply_on_the_fresh_value(self) -> None:
|
|
||||||
cache, rival = self.cache(), self.cache()
|
|
||||||
cache.put(item_doc, "k", Item("n", 1))
|
|
||||||
rival.pull_all_backing_stores()
|
|
||||||
apply = Counting(lambda item, calls: (rival.put(item_doc, "k", Item("n", 100)) if calls == 1 else None) or Item("n", item.value + 1))
|
|
||||||
result = cache.update(item_doc, "k", apply)
|
|
||||||
self.assertEqual(apply.seen, [1, 100])
|
|
||||||
self.assertIs(result.outcome, UpdateOutcome.UPDATED)
|
|
||||||
self.assertEqual(result.document.value, 101)
|
|
||||||
self.assertEqual(self.stored().value, 101)
|
|
||||||
|
|
||||||
def test_exhausted_attempts_return_lost_race(self) -> None:
|
|
||||||
cache, rival = self.cache(), self.cache()
|
|
||||||
cache.put(item_doc, "k", Item("n", 1))
|
|
||||||
rival.pull_all_backing_stores()
|
|
||||||
apply = Counting(lambda item, calls: rival.put(item_doc, "k", Item("n", 100 * calls)) or Item("n", -1))
|
|
||||||
result = cache.update(item_doc, "k", apply, max_attempts=3)
|
|
||||||
self.assertEqual(apply.calls, 3)
|
|
||||||
self.assertIs(result.outcome, UpdateOutcome.LOST_RACE)
|
|
||||||
self.assertEqual(result.document.value, 300) # the pull before LOST_RACE shows the winner
|
|
||||||
self.assertEqual(self.stored().value, 300)
|
|
||||||
|
|
||||||
def test_max_attempts_bounds(self) -> None:
|
|
||||||
cache, rival = self.cache(), self.cache()
|
|
||||||
cache.put(item_doc, "k", Item("n", 1))
|
|
||||||
rival.pull_all_backing_stores()
|
|
||||||
|
|
||||||
def always_losing(item, calls):
|
|
||||||
rival.put(item_doc, "k", Item("n", 100 + calls))
|
|
||||||
return Item("n", -1)
|
|
||||||
|
|
||||||
apply = Counting(always_losing)
|
|
||||||
result = cache.update(item_doc, "k", apply, max_attempts=1)
|
|
||||||
self.assertEqual((apply.calls, result.outcome), (1, UpdateOutcome.LOST_RACE))
|
|
||||||
for bad, error in ((0, ValueError), (-1, ValueError), (True, TypeError), (1.5, TypeError), (None, TypeError)):
|
|
||||||
with self.subTest(max_attempts=bad):
|
|
||||||
untouched = Counting()
|
|
||||||
with self.assertRaises(error):
|
|
||||||
cache.update(item_doc, "k", untouched, max_attempts=bad)
|
|
||||||
self.assertEqual(untouched.calls, 0)
|
|
||||||
with self.assertRaises(TypeError):
|
|
||||||
cache.update(item_doc, "k", "not callable")
|
|
||||||
with self.assertRaises(TypeError):
|
|
||||||
cache.update(item_doc, "k", None)
|
|
||||||
|
|
||||||
def test_apply_gets_a_fresh_copy(self) -> None:
|
|
||||||
cache, rival = self.cache(), self.cache()
|
|
||||||
cache.put(item_doc, "k", Item("n", 1))
|
|
||||||
rival.pull_all_backing_stores()
|
|
||||||
arguments: list[Item] = []
|
|
||||||
|
|
||||||
def apply(item):
|
|
||||||
arguments.append(item)
|
|
||||||
self.assertIsNot(item, cache.get(item_doc, "k"))
|
|
||||||
if len(arguments) == 1:
|
|
||||||
item.value = 777 # changing the copy in place changes nothing the cache or the next attempt sees
|
|
||||||
rival.put(item_doc, "k", Item("n", 5))
|
|
||||||
self.assertEqual(cache.get(item_doc, "k").value, 1)
|
|
||||||
return Item("n", item.value + 1)
|
|
||||||
|
|
||||||
result = cache.update(item_doc, "k", apply)
|
|
||||||
self.assertEqual([item.value for item in arguments], [777, 5])
|
|
||||||
self.assertIsNot(arguments[0], arguments[1])
|
|
||||||
self.assertEqual(result.document.value, 6)
|
|
||||||
|
|
||||||
def test_an_in_place_change_to_the_held_value_is_neither_applied_nor_persisted(self) -> None:
|
|
||||||
cache = self.cache()
|
|
||||||
cache.put(item_doc, "k", Item("n", 1))
|
|
||||||
cache.get(item_doc, "k").value = 999
|
|
||||||
apply = Counting(lambda item, calls: Item("n", item.value + 1))
|
|
||||||
result = cache.update(item_doc, "k", apply)
|
|
||||||
self.assertEqual(apply.seen, [1])
|
|
||||||
self.assertEqual(self.stored().value, 2)
|
|
||||||
result.document.value = 999
|
|
||||||
cache.update(item_doc, "k", apply)
|
|
||||||
self.assertEqual(apply.seen, [1, 2])
|
|
||||||
self.assertEqual(self.stored().value, 3)
|
|
||||||
|
|
||||||
bare = self.cache(store=False) # a cache with no store copies its held instance
|
|
||||||
bare.put(item_doc, "k", Item("n", 1))
|
|
||||||
bare.get(item_doc, "k").value = 999
|
|
||||||
seen = Counting(lambda item, calls: Item("n", item.value + 1))
|
|
||||||
self.assertEqual(bare.update(item_doc, "k", seen).document.value, 2)
|
|
||||||
self.assertEqual(seen.seen, [1])
|
|
||||||
|
|
||||||
def test_none_declines(self) -> None:
|
|
||||||
cache = self.cache()
|
|
||||||
cache.put(item_doc, "k", Item("n", 1))
|
|
||||||
before = self.bytes()
|
|
||||||
result = cache.update(item_doc, "k", lambda item: None)
|
|
||||||
self.assertIs(result.outcome, UpdateOutcome.DECLINED)
|
|
||||||
self.assertEqual(result.document, cache.get(item_doc, "k"))
|
|
||||||
self.assertEqual(self.bytes(), before)
|
|
||||||
absent = cache.update(item_doc, "missing", lambda item: None)
|
|
||||||
self.assertEqual((absent.outcome, absent.document), (UpdateOutcome.DECLINED, None))
|
|
||||||
self.assertEqual(self.bytes(), before)
|
|
||||||
empty = Fixture.cache(self, path=self.dir / "empty.cc")
|
|
||||||
self.assertEqual(empty.update(item_doc, "k", lambda item: None).outcome, UpdateOutcome.DECLINED)
|
|
||||||
self.assertFalse((self.dir / "empty.cc").exists())
|
|
||||||
|
|
||||||
def test_a_declined_or_lost_attempt_installs_nothing(self) -> None:
|
|
||||||
cache, rival = self.cache(), self.cache()
|
|
||||||
cache.put(item_doc, "k", Item("n", 1))
|
|
||||||
rival.pull_all_backing_stores()
|
|
||||||
rival.put(item_doc, "k", Item("n", 5))
|
|
||||||
self.assertIs(cache.update(item_doc, "k", lambda item: None).outcome, UpdateOutcome.DECLINED)
|
|
||||||
self.assertEqual(cache.get(item_doc, "k").value, 1)
|
|
||||||
cache.pull_all_backing_stores()
|
|
||||||
self.assertEqual(cache.get(item_doc, "k").value, 5)
|
|
||||||
|
|
||||||
during: list[int] = []
|
|
||||||
|
|
||||||
def apply(item, calls):
|
|
||||||
during.append(cache.get(item_doc, "k").value)
|
|
||||||
if calls == 1:
|
|
||||||
rival.put(item_doc, "k", Item("n", 9))
|
|
||||||
return Item("n", item.value + 1)
|
|
||||||
|
|
||||||
cache.update(item_doc, "k", Counting(apply))
|
|
||||||
self.assertEqual(during, [5, 5]) # the lost attempt published nothing mid-update
|
|
||||||
|
|
||||||
def test_absent_key_rival_removal_and_a_store_that_holds_nothing(self) -> None:
|
|
||||||
a, b = self.cache(), self.cache()
|
|
||||||
bump = lambda item: Item("n", (item.value if item else 0) + 1) # noqa: E731
|
|
||||||
self.assertIs(a.update(item_doc, "k", bump).outcome, UpdateOutcome.UPDATED)
|
|
||||||
self.assertIs(b.update(item_doc, "k", bump).outcome, UpdateOutcome.UPDATED)
|
|
||||||
self.assertEqual(self.stored().value, 2)
|
|
||||||
|
|
||||||
cache, rival = self.cache(), self.cache()
|
|
||||||
cache.put(item_doc, "d", Item("n", 1))
|
|
||||||
rival.pull_all_backing_stores()
|
|
||||||
apply = Counting(lambda item, calls: (rival.delete(item_doc, "d") if calls == 1 else None) or Item("n", (item.value if item else 0) + 1))
|
|
||||||
cache.update(item_doc, "d", apply)
|
|
||||||
self.assertEqual(apply.seen, [1, None])
|
|
||||||
self.assertEqual(self.stored("d").value, 1)
|
|
||||||
|
|
||||||
holder = self.cache()
|
|
||||||
holder.put(item_doc, "h", Item("n", 3))
|
|
||||||
rival.pull_all_backing_stores()
|
|
||||||
rival.delete(item_doc, "h")
|
|
||||||
nothing = Counting(lambda item, calls: Item("n", 1))
|
|
||||||
holder.update(item_doc, "h", nothing)
|
|
||||||
self.assertEqual(nothing.seen, [None])
|
|
||||||
|
|
||||||
def test_a_rival_writing_and_restoring_the_value_still_reruns_apply(self) -> None:
|
|
||||||
cache, rival = self.cache(), self.cache()
|
|
||||||
cache.put(item_doc, "k", Item("n", 1))
|
|
||||||
rival.pull_all_backing_stores()
|
|
||||||
|
|
||||||
def apply(item, calls):
|
|
||||||
if calls == 1:
|
|
||||||
rival.put(item_doc, "k", Item("n", 5))
|
|
||||||
rival.put(item_doc, "k", Item("n", 1))
|
|
||||||
return Item("n", item.value + 1)
|
|
||||||
|
|
||||||
counting = Counting(apply)
|
|
||||||
cache.update(item_doc, "k", counting)
|
|
||||||
self.assertEqual(counting.seen, [1, 1])
|
|
||||||
self.assertEqual(self.stored().value, 2)
|
|
||||||
|
|
||||||
def test_a_stale_caches_first_attempt_reads_the_store(self) -> None:
|
|
||||||
a, b = self.cache(), self.cache()
|
|
||||||
a.put(item_doc, "k", Item("n", 1))
|
|
||||||
b.pull_all_backing_stores()
|
|
||||||
a.put(item_doc, "k", Item("n", 7))
|
|
||||||
apply = Counting(lambda item, calls: Item("n", item.value + 1))
|
|
||||||
b.update(item_doc, "k", apply)
|
|
||||||
self.assertEqual(apply.seen, [7])
|
|
||||||
self.assertEqual(self.stored().value, 8)
|
|
||||||
|
|
||||||
|
|
||||||
class UpdateRefusalTests(Fixture):
|
|
||||||
def refused(self, cache: CultCache, key: str = "k", document=item_doc, *errors) -> None:
|
|
||||||
before = self.bytes()
|
|
||||||
apply = Counting()
|
|
||||||
with self.assertRaises(errors or (CultCacheError, SchemaConflictError)):
|
|
||||||
cache.update(document, key, apply)
|
|
||||||
self.assertEqual(apply.calls, 0)
|
|
||||||
self.assertEqual(self.bytes(), before)
|
|
||||||
|
|
||||||
def test_refusals_before_apply(self) -> None:
|
|
||||||
writer = self.cache(item_doc, other_doc)
|
|
||||||
writer.put(other_doc, "k", Item("n", 1))
|
|
||||||
self.refused(writer) # the record at the key is another document's, held
|
|
||||||
self.refused(self.fresh(item_doc, other_doc)) # unpulled: the store's record is another document's
|
|
||||||
self.refused(self.cache(item_doc)) # foreign: the store holds a type this cache never registered
|
|
||||||
self.refused(self.fresh(item_doc))
|
|
||||||
storeless = self.cache(item_doc, other_doc, store=False)
|
|
||||||
storeless.put(other_doc, "k", Item("n", 1))
|
|
||||||
apply = Counting()
|
|
||||||
with self.assertRaises((CultCacheError, SchemaConflictError)):
|
|
||||||
storeless.update(item_doc, "k", apply)
|
|
||||||
self.assertEqual(apply.calls, 0)
|
|
||||||
|
|
||||||
def fresh(self, *documents) -> CultCache:
|
|
||||||
"""A cache that has not pulled: whatever it reads, it reads from the store at update."""
|
|
||||||
builder = CultCache.builder()
|
|
||||||
for document in documents:
|
|
||||||
builder.register_document_type(document)
|
|
||||||
return builder.add_generic_store(SingleFileMessagePackBackingStore(self.path)).build()
|
|
||||||
|
|
||||||
def test_a_home_without_read_and_commit_if_refuses(self) -> None:
|
|
||||||
jsonl = JsonLinesBackingStore(self.dir / "state.jsonl")
|
|
||||||
cache = CultCache.builder().register_document_type(item_doc).add_generic_store(jsonl).build()
|
|
||||||
cache.pull_all_backing_stores()
|
|
||||||
cache.put(item_doc, "k", Item("n", 1))
|
|
||||||
before = (self.dir / "state.jsonl").read_bytes()
|
|
||||||
apply = Counting()
|
|
||||||
with self.assertRaisesRegex(CultCacheError, "cannot write conditionally"):
|
|
||||||
cache.update(item_doc, "k", apply)
|
|
||||||
self.assertEqual(apply.calls, 0)
|
|
||||||
self.assertEqual((self.dir / "state.jsonl").read_bytes(), before)
|
|
||||||
self.assertFalse(hasattr(JsonLinesBackingStore, "read") or hasattr(JsonLinesBackingStore, "commit_if"))
|
|
||||||
|
|
||||||
class Bare:
|
|
||||||
def pull_all(self):
|
|
||||||
return []
|
|
||||||
|
|
||||||
def push(self, envelope):
|
|
||||||
raise AssertionError("update wrote through a store that cannot write conditionally")
|
|
||||||
|
|
||||||
def push_all(self, envelopes, soft=False):
|
|
||||||
raise AssertionError("push_all")
|
|
||||||
|
|
||||||
def delete(self, type, key):
|
|
||||||
raise AssertionError("delete")
|
|
||||||
|
|
||||||
bare = CultCache.builder().register_document_type(item_doc).add_generic_store(Bare()).build()
|
|
||||||
with self.assertRaisesRegex(CultCacheError, "Bare"):
|
|
||||||
bare.update(item_doc, "k", apply)
|
|
||||||
self.assertEqual(apply.calls, 0)
|
|
||||||
|
|
||||||
def test_read_only_records_refuse_before_apply(self) -> None:
|
|
||||||
wide = define_database_entry_type(
|
|
||||||
"tests.rw",
|
|
||||||
[database_entry_field("name", 0, codec=t.string), database_entry_field("extra", 1, codec=t.string)],
|
|
||||||
cls=Wide,
|
|
||||||
schema_id="tests.rw.v1",
|
|
||||||
)
|
|
||||||
narrow = define_database_entry_type("tests.rw", [database_entry_field("name", 0, codec=t.string)], cls=Narrow, schema_id="tests.rw.v1")
|
|
||||||
self.cache(wide).put(wide, "k", Wide("n", "x"))
|
|
||||||
before = self.bytes()
|
|
||||||
for pulled in (True, False): # held read-only, then a store record the cache never loaded
|
|
||||||
with self.subTest(pulled=pulled):
|
|
||||||
cache = self.cache(narrow) if pulled else self.fresh(narrow)
|
|
||||||
apply = Counting()
|
|
||||||
with self.assertRaises(SchemaConflictError) as caught:
|
|
||||||
cache.update(narrow, "k", apply)
|
|
||||||
self.assertEqual(caught.exception.record_key, "k")
|
|
||||||
self.assertEqual(apply.calls, 0)
|
|
||||||
self.assertEqual(self.bytes(), before)
|
|
||||||
|
|
||||||
def test_a_non_global_key_for_a_global_document_refuses(self) -> None:
|
|
||||||
cache = self.cache(global_doc)
|
|
||||||
apply = Counting()
|
|
||||||
with self.assertRaises(CultCacheError):
|
|
||||||
cache.update(global_doc, "not-global", apply)
|
|
||||||
self.assertEqual(apply.calls, 0)
|
|
||||||
|
|
||||||
def test_refusals_after_apply_are_not_retried(self) -> None:
|
|
||||||
cache = self.cache()
|
|
||||||
cache.put(item_doc, "k", Item("n", 1))
|
|
||||||
before = self.bytes()
|
|
||||||
boom = Counting(lambda item, calls: (_ for _ in ()).throw(RuntimeError("boom")))
|
|
||||||
with self.assertRaisesRegex(RuntimeError, "boom"):
|
|
||||||
cache.update(item_doc, "k", boom)
|
|
||||||
self.assertEqual(boom.calls, 1)
|
|
||||||
self.assertEqual(self.bytes(), before)
|
|
||||||
|
|
||||||
indexed = self.cache(sku_doc, path=self.dir / "sku.cc")
|
|
||||||
indexed.put(sku_doc, "a", Item("n", 1, "X"))
|
|
||||||
indexed.put(sku_doc, "b", Item("n", 1, "Y"))
|
|
||||||
before = (self.dir / "sku.cc").read_bytes()
|
|
||||||
clash = Counting(lambda item, calls: Item("n", 2, "X"))
|
|
||||||
with self.assertRaisesRegex(CultCacheError, "unique index"):
|
|
||||||
indexed.update(sku_doc, "b", clash)
|
|
||||||
self.assertEqual(clash.calls, 1)
|
|
||||||
self.assertEqual((self.dir / "sku.cc").read_bytes(), before)
|
|
||||||
|
|
||||||
|
|
||||||
class UpdateOwnWritesTests(Fixture):
|
|
||||||
def test_own_writes_and_the_held_instance(self) -> None:
|
|
||||||
cache = self.cache()
|
|
||||||
cache.put(item_doc, "k", Item("n", 1))
|
|
||||||
apply = Counting(lambda item, calls: Item("n", item.value + 1))
|
|
||||||
cache.update(item_doc, "k", apply)
|
|
||||||
second = cache.update(item_doc, "k", apply)
|
|
||||||
self.assertEqual(apply.calls, 2)
|
|
||||||
self.assertIs(second.document, cache.get(item_doc, "k"))
|
|
||||||
self.assertEqual(second.document.value, 3)
|
|
||||||
|
|
||||||
def sideways(item, calls):
|
|
||||||
cache.put(item_doc, "side", Item("n", 5)) # apply runs outside the cache's hold
|
|
||||||
return Item("n", item.value + 1)
|
|
||||||
|
|
||||||
sideways_apply = Counting(sideways)
|
|
||||||
result = cache.update(item_doc, "k", sideways_apply)
|
|
||||||
self.assertEqual((result.outcome, sideways_apply.calls), (UpdateOutcome.UPDATED, 1))
|
|
||||||
self.assertEqual(self.stored("side").value, 5)
|
|
||||||
|
|
||||||
def test_store_less_cache(self) -> None:
|
|
||||||
cache = self.cache(store=False)
|
|
||||||
cache.put(item_doc, "k", Item("n", 0))
|
|
||||||
results: list[UpdateResult] = []
|
|
||||||
|
|
||||||
def bump(item):
|
|
||||||
time.sleep(0)
|
|
||||||
return Item("n", item.value + 1)
|
|
||||||
|
|
||||||
def run() -> None:
|
|
||||||
for _ in range(50):
|
|
||||||
results.append(cache.update(item_doc, "k", bump, max_attempts=500))
|
|
||||||
|
|
||||||
threads = [threading.Thread(target=run) for _ in range(2)]
|
|
||||||
for thread in threads:
|
|
||||||
thread.start()
|
|
||||||
for thread in threads:
|
|
||||||
thread.join()
|
|
||||||
self.assertTrue(all(result.outcome is UpdateOutcome.UPDATED for result in results))
|
|
||||||
self.assertEqual(cache.get(item_doc, "k").value, 100)
|
|
||||||
|
|
||||||
# A store that becomes the type's home while apply runs holds a record the cache never read: the commit loses.
|
|
||||||
cache = self.cache(store=False) # holds no record of the type, so a store may become its home
|
|
||||||
other = self.cache(path=self.dir / "late.cc")
|
|
||||||
other.put(item_doc, "fresh", Item("n", 40))
|
|
||||||
late = SingleFileMessagePackBackingStore(self.dir / "late.cc")
|
|
||||||
|
|
||||||
def attach(item, calls):
|
|
||||||
if calls == 1:
|
|
||||||
cache.add_generic_store(late)
|
|
||||||
return Item("n", (item.value if item else 0) + 1)
|
|
||||||
|
|
||||||
apply = Counting(attach)
|
|
||||||
result = cache.update(item_doc, "fresh", apply)
|
|
||||||
self.assertEqual(apply.seen, [None, 40])
|
|
||||||
self.assertIs(result.outcome, UpdateOutcome.UPDATED)
|
|
||||||
self.assertEqual(self.cache(path=self.dir / "late.cc").get(item_doc, "fresh").value, 41)
|
|
||||||
|
|
||||||
def test_a_home_attached_while_apply_runs_is_reread_or_refused(self) -> None:
|
|
||||||
"""The cache's home for the type changes between the read and the commit (attaching is allowed while it holds no record
|
|
||||||
of the type): the version read from the old home is no condition on the new one."""
|
|
||||||
cache = self.cache(path=self.dir / "generic.cc")
|
|
||||||
late = SingleFileMessagePackBackingStore(self.dir / "late.cc")
|
|
||||||
|
|
||||||
def attach(item, calls):
|
|
||||||
if calls == 1:
|
|
||||||
cache.add_backing_store(late, ["item"])
|
|
||||||
return Item("n", 1)
|
|
||||||
|
|
||||||
apply = Counting(attach)
|
|
||||||
self.assertIs(cache.update(item_doc, "k", apply).outcome, UpdateOutcome.UPDATED)
|
|
||||||
self.assertEqual(apply.seen, [None, None]) # reread from the new home, not committed with the old home's version
|
|
||||||
self.assertEqual(self.cache(path=self.dir / "late.cc").get(item_doc, "k").value, 1)
|
|
||||||
|
|
||||||
cache = self.cache(path=self.dir / "generic2.cc")
|
|
||||||
jsonl = JsonLinesBackingStore(self.dir / "late.jsonl")
|
|
||||||
|
|
||||||
def attach_jsonl(item, calls):
|
|
||||||
cache.add_backing_store(jsonl, ["item"])
|
|
||||||
return Item("n", 1)
|
|
||||||
|
|
||||||
apply = Counting(attach_jsonl)
|
|
||||||
with self.assertRaisesRegex(CultCacheError, "cannot write conditionally"):
|
|
||||||
cache.update(item_doc, "k", apply)
|
|
||||||
self.assertEqual(apply.calls, 1)
|
|
||||||
self.assertFalse((self.dir / "late.jsonl").exists())
|
|
||||||
|
|
||||||
def test_ledger_under_contention(self) -> None:
|
|
||||||
caches = [self.cache() for _ in range(3)]
|
|
||||||
outcomes: list[UpdateOutcome] = []
|
|
||||||
|
|
||||||
def run(cache) -> None:
|
|
||||||
for _ in range(25):
|
|
||||||
outcomes.append(cache.update(item_doc, "k", lambda item: Item("n", (item.value if item else 0) + 1)).outcome)
|
|
||||||
|
|
||||||
threads = [threading.Thread(target=run, args=(cache,)) for cache in caches]
|
|
||||||
for thread in threads:
|
|
||||||
thread.start()
|
|
||||||
for thread in threads:
|
|
||||||
thread.join()
|
|
||||||
self.assertEqual(self.stored().value, outcomes.count(UpdateOutcome.UPDATED))
|
|
||||||
self.assertEqual(len(outcomes), 75)
|
|
||||||
|
|
||||||
|
|
||||||
class UpdateLegacyGlobalTests(Fixture):
|
|
||||||
def plant(self, key: str = "legacy") -> None:
|
|
||||||
entry = global_doc.catalog_entry()
|
|
||||||
SingleFileMessagePackBackingStore(self.path).push(
|
|
||||||
CultCacheEnvelope.create(key=key, type=global_doc.type, payload=global_doc.encode_payload(Item("n", 1)), schema_id=entry.schema_id, catalog_entry=entry)
|
|
||||||
)
|
|
||||||
|
|
||||||
def test_update_global_updates_the_global_record(self) -> None:
|
|
||||||
cache = self.cache(global_doc)
|
|
||||||
result = cache.update_global(global_doc, lambda item: Item("n", (item.value if item else 0) + 1))
|
|
||||||
self.assertIs(result.outcome, UpdateOutcome.UPDATED)
|
|
||||||
self.assertEqual(self.cache(global_doc).get(global_doc, GLOBAL_KEY).value, 1)
|
|
||||||
|
|
||||||
def test_a_legacy_global_is_refused_until_put_global_retires_it(self) -> None:
|
|
||||||
self.plant()
|
|
||||||
cache = self.cache(global_doc) # loaded from the legacy key
|
|
||||||
before = self.bytes()
|
|
||||||
for call in (lambda a: cache.update_global(global_doc, a), lambda a: cache.update(global_doc, GLOBAL_KEY, a)):
|
|
||||||
apply = Counting()
|
|
||||||
with self.assertRaisesRegex(CultCacheError, "put_global"):
|
|
||||||
call(apply)
|
|
||||||
self.assertEqual(apply.calls, 0)
|
|
||||||
self.assertEqual(self.bytes(), before)
|
|
||||||
# Judged from the cache's load, not only from the store: the legacy record is gone from the store, the cache still holds it.
|
|
||||||
SingleFileMessagePackBackingStore(self.path).delete(global_doc.type, "legacy")
|
|
||||||
apply = Counting()
|
|
||||||
with self.assertRaisesRegex(CultCacheError, "put_global"):
|
|
||||||
cache.update_global(global_doc, apply)
|
|
||||||
self.assertEqual(apply.calls, 0)
|
|
||||||
cache.put_global(global_doc, Item("n", 5))
|
|
||||||
self.assertEqual(cache.update_global(global_doc, lambda item: Item("n", item.value + 1)).document.value, 6)
|
|
||||||
|
|
||||||
def test_a_pull_inside_apply_that_loads_a_legacy_global_fails_the_commit(self) -> None:
|
|
||||||
cache = self.cache(global_doc)
|
|
||||||
|
|
||||||
def apply(item):
|
|
||||||
self.plant()
|
|
||||||
cache.pull_all_backing_stores()
|
|
||||||
return Item("n", 9)
|
|
||||||
|
|
||||||
with self.assertRaisesRegex(CultCacheError, "put_global"):
|
|
||||||
cache.update_global(global_doc, apply)
|
|
||||||
self.assertEqual([envelope.key for envelope in SingleFileMessagePackBackingStore(self.path).pull_all()], ["legacy"])
|
|
||||||
|
|
||||||
def test_an_unpulled_cache_judges_the_legacy_global_from_the_store(self) -> None:
|
|
||||||
self.plant()
|
|
||||||
before = self.bytes()
|
|
||||||
cache = SingleFileMessagePackBackingStore(self.path)
|
|
||||||
unpulled = CultCache.builder().register_document_type(global_doc).add_generic_store(cache).build()
|
|
||||||
apply = Counting()
|
|
||||||
with self.assertRaisesRegex(CultCacheError, "put_global"):
|
|
||||||
unpulled.update_global(global_doc, apply)
|
|
||||||
self.assertEqual(apply.calls, 0)
|
|
||||||
self.assertEqual(self.bytes(), before)
|
|
||||||
|
|
||||||
|
|
||||||
class StoreRestampTests(Fixture):
|
|
||||||
def envelope(self, value: int, stored_at: str = ALPHA, key: str = "k") -> CultCacheEnvelope:
|
|
||||||
entry = item_doc.catalog_entry()
|
|
||||||
return CultCacheEnvelope(key, "item", item_doc.encode_payload(Item("n", value)), stored_at, entry.schema_id, entry)
|
|
||||||
|
|
||||||
def stamp_on_disk(self, store, key: str = "k") -> str:
|
|
||||||
return next(envelope.stored_at for envelope in store.pull_all() if envelope.key == key)
|
|
||||||
|
|
||||||
def later_than_alpha(self, text: str) -> bool:
|
|
||||||
return parse_stored_at(text) > parse_stored_at(ALPHA)
|
|
||||||
|
|
||||||
def test_commit_if_and_the_restamp_at_the_store(self) -> None:
|
|
||||||
store = SingleFileMessagePackBackingStore(self.path)
|
|
||||||
self.assertIsNone(store.read("k"))
|
|
||||||
stamp = store.commit_if(self.envelope(1), None) # None against an absent key commits
|
|
||||||
self.assertEqual(stamp, ALPHA)
|
|
||||||
envelope, version = store.read("k")
|
|
||||||
self.assertEqual(version, record_version(envelope))
|
|
||||||
before = self.bytes()
|
|
||||||
self.assertIsNone(store.commit_if(self.envelope(2, "2100-01-01T00:00:00Z"), None)) # a record is there: not absent
|
|
||||||
self.assertIsNone(store.commit_if(self.envelope(2, "2100-01-01T00:00:00Z"), "0" * 64))
|
|
||||||
self.assertEqual(self.bytes(), before)
|
|
||||||
written = store.commit_if(self.envelope(2), version) # a staged stamp that is no later is minted over
|
|
||||||
self.assertTrue(self.later_than_alpha(written))
|
|
||||||
self.assertEqual(self.stamp_on_disk(store), written)
|
|
||||||
self.assertEqual(stamp_of(store, "k"), written)
|
|
||||||
|
|
||||||
def test_every_replacing_write_is_stored_strictly_later(self) -> None:
|
|
||||||
for make in (SingleFileMessagePackBackingStore, JsonLinesBackingStore):
|
|
||||||
for name in ("push", "push_all", "commit_if"):
|
|
||||||
if name == "commit_if" and make is JsonLinesBackingStore:
|
|
||||||
continue
|
|
||||||
with self.subTest(store=make.__name__, write=name):
|
|
||||||
path = self.dir / f"{make.__name__}-{name}"
|
|
||||||
store = make(path)
|
|
||||||
store.push(self.envelope(1))
|
|
||||||
if name == "push":
|
|
||||||
reported = store.push(self.envelope(2))
|
|
||||||
elif name == "push_all":
|
|
||||||
reported = store.push_all([self.envelope(2)])["k"]
|
|
||||||
else:
|
|
||||||
reported = store.commit_if(self.envelope(2), store.read("k")[1])
|
|
||||||
self.assertTrue(self.later_than_alpha(reported))
|
|
||||||
self.assertEqual(self.stamp_on_disk(store), reported)
|
|
||||||
|
|
||||||
def test_the_cache_holds_the_stamp_the_store_wrote(self) -> None:
|
|
||||||
for name in ("put", "put_envelope", "put_envelopes", "update"):
|
|
||||||
with self.subTest(write=name):
|
|
||||||
path = self.dir / name
|
|
||||||
SingleFileMessagePackBackingStore(path).push(self.envelope(1))
|
|
||||||
cache = self.cache(path=path)
|
|
||||||
self.assertEqual(cache.get_envelope(item_doc, "k").stored_at, ALPHA)
|
|
||||||
if name == "put":
|
|
||||||
cache.put(item_doc, "k", Item("n", 2))
|
|
||||||
elif name == "put_envelope":
|
|
||||||
cache.put_envelope(item_doc, self.envelope(2))
|
|
||||||
elif name == "put_envelopes":
|
|
||||||
cache.put_envelopes(item_doc, [self.envelope(2)])
|
|
||||||
else:
|
|
||||||
cache.update(item_doc, "k", lambda item: Item("n", 2))
|
|
||||||
held = cache.get_envelope(item_doc, "k").stored_at
|
|
||||||
self.assertTrue(self.later_than_alpha(held))
|
|
||||||
self.assertEqual(held, self.stamp_on_disk(SingleFileMessagePackBackingStore(path)))
|
|
||||||
|
|
||||||
def test_a_store_less_cache_stamps_a_replacing_write_later(self) -> None:
|
|
||||||
cache = self.cache(store=False)
|
|
||||||
cache.put_envelope(item_doc, self.envelope(1))
|
|
||||||
cache.put_envelope(item_doc, self.envelope(2, "2000-01-01T00:00:00Z"))
|
|
||||||
self.assertTrue(self.later_than_alpha(cache.get_envelope(item_doc, "k").stored_at))
|
|
||||||
|
|
||||||
def test_only_the_stamp_shape_the_runtimes_write_parses(self) -> None:
|
|
||||||
"""An RFC 3339 date-time with T, a fraction of 1 to 9 digits and Z or a numeric offset, on every interpreter (the shape is
|
|
||||||
checked here, not by fromisoformat), so a stamp reads the same on 3.10 and 3.13. The edges follow RFC 3339: offset hours 00-23,
|
|
||||||
minutes 00-59."""
|
|
||||||
utc = timezone.utc
|
|
||||||
accepted = {
|
|
||||||
"2026-01-01T00:00:00Z": datetime(2026, 1, 1, tzinfo=utc),
|
|
||||||
"2026-01-01T00:00:00.1Z": datetime(2026, 1, 1, 0, 0, 0, 100000, utc),
|
|
||||||
"2026-01-01T00:00:00.123456789Z": datetime(2026, 1, 1, 0, 0, 0, 123456, utc),
|
|
||||||
"2026-01-01T00:00:00.1234567+00:00": datetime(2026, 1, 1, 0, 0, 0, 123456, utc),
|
|
||||||
"2026-01-01T05:30:00+05:30": datetime(2026, 1, 1, tzinfo=utc),
|
|
||||||
"2025-12-31T19:00:00-05:00": datetime(2026, 1, 1, tzinfo=utc),
|
|
||||||
"2026-01-01T23:59:00+23:59": datetime(2026, 1, 1, 0, 0, tzinfo=utc),
|
|
||||||
}
|
|
||||||
for text, instant in accepted.items():
|
|
||||||
with self.subTest(text=text):
|
|
||||||
self.assertEqual(parse_stored_at(text), instant)
|
|
||||||
for text in (
|
|
||||||
"2026-01-01", "20260101T000000Z", "2026-W01-1T00:00:00Z", "2026-01-01 00:00:00Z", "2026-01-01T00:00:00,5Z",
|
|
||||||
"2026-01-01T00Z", "2026-01-01T00:00:00", "2026-01-01T00:00:00.Z", "2026-01-01T00:00:00.1234567890Z",
|
|
||||||
"2026-01-01T00:00:00z", " 2026-01-01T00:00:00Z", "2026-01-01T00:00:00Z ", "2026-01-01T24:00:00Z",
|
|
||||||
"2026-13-01T00:00:00Z", "2026-01-01T00:00:00+24:00", "2026-01-01T00:00:00+05:60", "2026-01-01T00:00:00+05:75", "2026-01-01T00:00Z", "2026-01-01T00:00+00:00",
|
|
||||||
"026-01-01T00:00:00Z", "12026-01-01T00:00:00Z", "2026-01-01T00:00:00+5:00", "2026-01-01T00:00:00+0000", "\u0662026-01-01T00:00:00Z",
|
|
||||||
"", "garbage",
|
|
||||||
):
|
|
||||||
with self.subTest(text=text):
|
|
||||||
self.assertIsNone(parse_stored_at(text))
|
|
||||||
|
|
||||||
def test_a_stamp_outside_the_range_is_unparseable_and_one_at_the_edge_refuses_a_later_stamp(self) -> None:
|
|
||||||
for text in ("9999-12-31T23:30:00-05:00", "0001-01-01T00:00:00+05:00"):
|
|
||||||
with self.subTest(text=text):
|
|
||||||
self.assertIsNone(parse_stored_at(text))
|
|
||||||
now = datetime(2030, 1, 1, tzinfo=timezone.utc)
|
|
||||||
self.assertEqual(mint_stored_at("9999-12-31T23:30:00-05:00", now), "2030-01-01T00:00:00.000000+00:00")
|
|
||||||
edge = "9999-12-31T23:59:59.9999999Z"
|
|
||||||
with self.assertRaisesRegex(ValueError, "last instant"):
|
|
||||||
mint_stored_at(edge, now)
|
|
||||||
with self.assertRaisesRegex(ValueError, "last instant"):
|
|
||||||
stored_at_over("2000-01-01T00:00:00Z", edge)
|
|
||||||
# A write over a record stamped at the edge is refused by the store and writes nothing, from push, commit_if and update.
|
|
||||||
store = SingleFileMessagePackBackingStore(self.path)
|
|
||||||
entry = item_doc.catalog_entry()
|
|
||||||
record = lambda value, at: CultCacheEnvelope("k", "item", item_doc.encode_payload(Item("n", value)), at, entry.schema_id, entry) # noqa: E731
|
|
||||||
store.push(record(1, edge))
|
|
||||||
before = self.bytes()
|
|
||||||
version = store.read("k")[1]
|
|
||||||
for write in (lambda: store.push(record(2, ALPHA)), lambda: store.push_all([record(2, ALPHA)]), lambda: store.commit_if(record(2, ALPHA), version)):
|
|
||||||
with self.assertRaises(ValueError):
|
|
||||||
write()
|
|
||||||
cache = self.cache()
|
|
||||||
apply = Counting()
|
|
||||||
with self.assertRaises(ValueError):
|
|
||||||
cache.update(item_doc, "k", apply)
|
|
||||||
self.assertEqual(apply.calls, 1)
|
|
||||||
self.assertEqual(self.bytes(), before)
|
|
||||||
self.assertEqual(cache.get_envelope(item_doc, "k").stored_at, edge)
|
|
||||||
|
|
||||||
def test_stamp_parsing_and_install(self) -> None:
|
|
||||||
for text in ("2026-01-01T00:00:00.1234567+00:00", "2026-01-01T00:00:00Z", "2026-01-01T00:00:00.123456+00:00"):
|
|
||||||
with self.subTest(text=text):
|
|
||||||
self.assertIsNotNone(parse_stored_at(text))
|
|
||||||
self.assertEqual(parse_stored_at(text).tzinfo, timezone.utc)
|
|
||||||
self.assertIsNone(parse_stored_at("garbage"))
|
|
||||||
self.assertIsNone(parse_stored_at(None))
|
|
||||||
now = datetime(2030, 1, 1, tzinfo=timezone.utc)
|
|
||||||
self.assertEqual(mint_stored_at("garbage", now), "2030-01-01T00:00:00.000000+00:00")
|
|
||||||
self.assertEqual(stored_at_over("2000-01-01T00:00:00Z", "2000-01-01T00:00:00Z")[:4], str(datetime.now(timezone.utc).year)) # no later: minted at now
|
|
||||||
self.assertEqual(mint_stored_at("2030-01-01T00:00:00Z", now), "2030-01-01T00:00:00.000001+00:00") # equal is not later
|
|
||||||
self.assertEqual(mint_stored_at("2099-01-01T00:00:00.1234567Z", now), "2099-01-01T00:00:00.123457+00:00")
|
|
||||||
self.assertEqual(stored_at_over("2000-01-01T00:00:00Z", "2099-01-01T00:00:00.1234567Z"), "2099-01-01T00:00:00.123457+00:00")
|
|
||||||
|
|
||||||
for reported in (True, 1, "garbage"):
|
|
||||||
with self.subTest(reported=reported):
|
|
||||||
class Lying(SingleFileMessagePackBackingStore):
|
|
||||||
def push(self, envelope):
|
|
||||||
super().push(envelope)
|
|
||||||
return reported
|
|
||||||
|
|
||||||
cache = CultCache.builder().register_document_type(item_doc).add_generic_store(Lying(self.dir / f"lying-{reported}")).build()
|
|
||||||
cache.pull_all_backing_stores()
|
|
||||||
cache.put_envelope(item_doc, self.envelope(1, "2026-02-02T00:00:00.000000+00:00"))
|
|
||||||
self.assertEqual(cache.get_envelope(item_doc, "k").stored_at, "2026-02-02T00:00:00.000000+00:00")
|
|
||||||
|
|
||||||
|
|
||||||
def stamp_of(store, key: str) -> str:
|
|
||||||
return store.read(key)[0].stored_at
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
unittest.main()
|
|
||||||
1
packages/cultcache-rs/.gitignore
vendored
1
packages/cultcache-rs/.gitignore
vendored
|
|
@ -1 +1,2 @@
|
||||||
/target
|
/target
|
||||||
|
Cargo.lock
|
||||||
|
|
|
||||||
|
|
@ -6,34 +6,8 @@ only in git history.
|
||||||
|
|
||||||
## Unreleased
|
## Unreleased
|
||||||
|
|
||||||
### Added
|
|
||||||
|
|
||||||
- `CultCache::update_with_attempts` and the conditional `update`: each attempt reads the record from its home store with its content version in one read, applies a function to a copy and commits only over that version, rerunning on a lost race (default five attempts). The result is `CultUpdateResult<T>`, outcome `Updated`, `Declined` (the function returned `None`) or `LostRace`, with the cache's document. Public types `CultStoredRecord`, `CultCommitIf`, `CultUpdateOutcome`, `CultUpdateResult`.
|
|
||||||
- `CacheBackingStore::read(key)` and `commit_if(entry, expected)`, provided methods whose defaults refuse with an error naming the store kind; `SingleFileMessagePackBackingStore` implements both. The content version is the lowercase hex SHA-256 of the record re-encoded as the store file writes it (key, schema id, `stored_at`, payload). It equals the SHA-256 of the record's bytes in the file, and so the C# reference's `tests/vectors/content-version`, whenever the file's MessagePack encodings are minimal, which every runtime's writer produces; a hand-edited file with a non-minimal encoding (for example a `str8` key that fits a fixstr) hashes differently from its slice here. New dependency `sha2` 0.10 and eight new lockfile crates: `sha2`, `digest`, `block-buffer`, `crypto-common`, `generic-array`, `typenum`, `cpufeatures`, `version_check`.
|
|
||||||
|
|
||||||
### Changed
|
|
||||||
|
|
||||||
- `is_stored_at_stamp(&str)` (new, public) is the one shape a peer's `storedAt` must parse as, pinned by `tests/vectors/stored-at-stamp` (RFC 3339 `YYYY-MM-DDThh:mm:ss`, a 1 to 9 digit fraction, `Z` or `+hh:mm`/`-hh:mm`; uppercase `T`/`Z`, a real date, seconds 00-59, years 0001-9999), hand-checked because `chrono`'s RFC 3339 reader takes other shapes. `put_raw_envelope` and `put_prepared_batch` refuse a `stored_at` that is not a stamp (before: only a blank one) and mint nothing (variants:ruling:raw-put-without-stamp-refused).
|
|
||||||
- The single-file store's `push`, `push_all` and `commit_if` stamp a replacing write strictly later than the record it replaces at the same key (a staged stamp stands only when it parses and is strictly later; otherwise the stamp is minted as the replaced stamp plus one microsecond, or now if later), with no identical-content exception, as C# does. A stamp with no successor (the replaced stamp is at year 9999's last microsecond) refuses the write and writes nothing, as C# `MintStoredAt` does. `commit_if` replaces only the record of the entry's own type under the key, so a retype is refused as `push` refuses it. The cache holds the stamp the store wrote. The redb stores and the store-level exact-envelope writes (`compare_and_swap_entry` and its family) still write the caller's envelope unchanged.
|
|
||||||
- The single-file store re-checks for a link once the store lock is held (every write and the try-exchange), so a link put at the path while a writer waited on the lock is refused with `StoreLinkedError` and the lock released, as C# does, instead of being replaced. Pinned by a test that puts the link while a second holder owns the lock.
|
|
||||||
- `CultCache::is_writable` does not look at store paths: a link at a store path is not predicted, and the write refuses it with `StoreLinkedError`. Pinned by a test through a cache attached to a linked store.
|
|
||||||
|
|
||||||
### Breaking
|
### Breaking
|
||||||
|
|
||||||
Semver: this is a breaking change in the 0.x line (0.3.x to 0.4.0).
|
|
||||||
|
|
||||||
- `CultCache::update` is replaced, not extended: `update::<T, _>(key, apply)` takes `FnMut(Option<T>) -> Option<T>` and returns `Result<CultUpdateResult<T>>`. The blind `FnOnce(Option<T>) -> T` form that returned `T` is gone; use `put` for a blind write. It reads the home store, not the cache's image, so a cache whose store has no `read` and `commit_if` (the redb stores, a custom store) refuses it before `apply` runs.
|
|
||||||
- `CacheBackingStore::push` returns `Result<String>`, the `stored_at` written, and `push_all` returns `Result<Vec<String>>`, one stamp per entry given in order (a soft write that wrote nothing returns an empty vec). A custom store must return what it wrote; the redb stores return the entries' own stamps. Huginn implements `CacheBackingStore` in five test stores under a pinned git rev: they change at its next bump.
|
|
||||||
- A write at a store path that is a symbolic link, live or dangling, is refused with the new public `StoreLinkedError` (`error.downcast_ref::<StoreLinkedError>()`) before the lock and the replace, and writes nothing: `push`, `push_all`, `delete`, the exchanges, and a soft `push_all`, which used to skip a link and now refuses. Before, a write at a live link replaced the link with a regular file and a dangling link failed with `io::ErrorKind::NotFound`. The redb stores (`RedbMessagePackBackingStore`, `OwnedRedbMessagePackBackingStore`) are exempt: they are ruled migrated and deleted (`paged-store-redb-migrate-and-delete`) and still open a live link's target. Configure the link's target as the store path. Reads through a live link work.
|
|
||||||
- A record whose payload carries unread slots is read-only. A payload with a slot past its type's declared slots, at any depth (record, nested record, list element, union arm, unit arm), still decodes, and every write or removal of its key is now refused before any store is touched: `put`, `put_envelope`, `put_raw_envelope`, `put_prepared_batch` (the whole batch) and `delete`, so `update` too. The refusal is `SchemaConflictError` with the new `unread_slots`; its message names the type and both slot counts and never a slot value. Holders of such a record used to overwrite it and drop the extra slots silently. The payload nesting refusal still runs first. A held payload this build cannot read at all (an arm it lacks from a newer writer, or a corrupt record) is read-only too: every write or removal is refused with an error naming the type and key (a newer writer's record is read with that build; a corrupt one is restored from a backup or removed at the store itself, as no cache call removes it), and `is_writable` answers false. `load_soa` is a write of every held key it omits or changes, so it refuses to drop or replace a read-only record. `is_writable` also answers false for a key a store carries as a foreign record and for a type other than the one holding the key, as the writes do. Each write over a held key decodes the held payload once to ask (about 40% of a `put` of a 200,000-element record, measured in release); keys nothing holds pay nothing.
|
|
||||||
- cultmesh-rs `pull_rudp_catalog_snapshot` applies a snapshot as one cache commit (`put_prepared_batch`), as C# does: a snapshot document for a key the node holds read-only, or any other refusal, applies nothing. It used to apply document by document, so a refusal ended the pull with the earlier documents kept. A snapshot whose types route to different backing stores is now refused whole, as a batch cannot span stores. C# `CultCache.Commit` refuses a cross-store commit the same way (`The batch spans A and B; a commit lands in one home store`), so the two agree; a test pins it.
|
|
||||||
- `SchemaConflictError` gains the public field `unread_slots: Option<UnreadSlots>`; code that builds it with a struct literal must set it (`None`).
|
|
||||||
- A unit arm with slots (`[N, [extra...]]`) decodes as the unit arm and marks the record, where the derive refused it.
|
|
||||||
- The registration map's value changes from the schema name to a private struct holding the schema name and the unread-slots check.
|
|
||||||
- A cache whose last `pull_all_backing_stores` was refused (a tail, a payload past the nesting bound, a duplicate unique-index value, a retype conflict, a record from the wrong store) refuses every `put`, `put_envelope`, `put_raw_envelope`, `put_prepared_batch`, `update` and `delete` with `CultCacheLoadRefused` until a pull succeeds. Before, it stayed writable over an empty image, and the next batch write replaced the store with only the new records.
|
|
||||||
- `CacheBackingStore::push_all` writes the given entries onto the store as it is when the write lands, under the store's lock or transaction: a record under the same identity is replaced and no other record is removed. It used to replace everything the store held, so a cache whose image was stale (another writer had added a record since its pull) wiped that record with `put_prepared_batch`. `put_prepared_batch` now hands the store its staged records alone, as C# `CommitBatch` and Python `push_all` do; the lay-back of foreign records is gone because they are never rewritten. A custom `CacheBackingStore` must give `push_all` merge semantics. `push_all` reads the store, so through a dangling link it is refused like `push` and no longer replaces the link; a soft flush is unchanged.
|
|
||||||
- A cache with a backing store also refuses every write and removal, with `CultCacheLoadRefused`, until it has pulled: a cache that never pulled, or that gained a store since its last pull, holds no image of its stores, and a batch from it replaced a populated store with only the new records. `is_writable` answers false meanwhile. A cache with no store needs no pull. Callers that attach a store and write (cultmesh nodes created with `pull_on_start: false`) must call `pull_all_backing_stores` first.
|
|
||||||
- `decode_payload`, `put_raw_envelope` and prepared batches refuse a payload with bytes after its first MessagePack value (`payload has {n} bytes after its first MessagePack value`), by count; the tail is never walked or quoted. They used to read the first value and keep or drop the tail, so a record with a stray tail was served and rewritten without it. A store holding such a record (single-file, redb, `load_soa`) is refused at load, naming the type, the key and the count, and stays unreadable until the record is repaired; the same check now runs on every record at load, as the C# and Python runtimes do at open. The nesting bound is part of that check, so a stored payload nested past it is refused at load too, where it used to load and refuse on read.
|
|
||||||
- A single-file store written as `cultcache.store.v3` is read and written: a store the C# runtime marked v3 (it holds a record with an element id: an owned list element with a `[CultElementId]` member) keeps its header here, and is carried through every rewrite with its ids; this runtime never drops the mark. A runtime from before this change refuses a v3 store by name. Rolling back to an older release after a store has been written as v3 is one-way: there is no carry-back, so restore from a copy taken before upgrading.
|
- A single-file store written as `cultcache.store.v3` is read and written: a store the C# runtime marked v3 (it holds a record with an element id: an owned list element with a `[CultElementId]` member) keeps its header here, and is carried through every rewrite with its ids; this runtime never drops the mark. A runtime from before this change refuses a v3 store by name. Rolling back to an older release after a store has been written as v3 is one-way: there is no carry-back, so restore from a copy taken before upgrading.
|
||||||
- A write over a file the reader refuses (a zero-byte file, a truncated store, a stamp this runtime does not read) refuses with `CultCacheStoreUnreadable` and leaves the file as it is. A whole-store write used to replace such a file. This reverses 0.3.1, where `push_all` replaced a file with no readable stamp (healing it); the stamp rule now has one owner, the reader every write asks under the lock, and it accepts v1 and v3 (0.3.1 refused v3).
|
- A write over a file the reader refuses (a zero-byte file, a truncated store, a stamp this runtime does not read) refuses with `CultCacheStoreUnreadable` and leaves the file as it is. A whole-store write used to replace such a file. This reverses 0.3.1, where `push_all` replaced a file with no readable stamp (healing it); the stamp rule now has one owner, the reader every write asks under the lock, and it accepts v1 and v3 (0.3.1 refused v3).
|
||||||
- `#[cultcache(index)]` means unique, as in C# `RefuseIndexSharing`: within one type and one alias no two records hold one non-blank value. A put, batch, push or load that would make two records hold a value is refused, naming both keys and the alias, and a store that already holds a duplicate does not open. A grouping index is no longer expressible; a consumer that relied on shared values must drop the `index` and look up by another way.
|
- `#[cultcache(index)]` means unique, as in C# `RefuseIndexSharing`: within one type and one alias no two records hold one non-blank value. A put, batch, push or load that would make two records hold a value is refused, naming both keys and the alias, and a store that already holds a duplicate does not open. A grouping index is no longer expressible; a consumer that relied on shared values must drop the `index` and look up by another way.
|
||||||
|
|
@ -48,7 +22,6 @@ Semver: this is a breaking change in the 0.x line (0.3.x to 0.4.0).
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- `UnreadSlots { type_name, slot_count, declared_count, occurrences }`, `decode_payload_marked` (the decode that returns the mark) and `CultCache::is_writable(type, key)`. The derives' slot visitors note into a thread-local scope the decode entry opens (`__enter_slots`, `__note_unread_slots`, `__UnitArmSlots`, doc-hidden); a decode outside that entry notes nothing.
|
|
||||||
- `CultCache::foreign_records()` and `ForeignRecord { key, schema_id, schema_name, stored_at }`: the records the last pull found that no registered type claims, sorted by key.
|
- `CultCache::foreign_records()` and `ForeignRecord { key, schema_id, schema_name, stored_at }`: the records the last pull found that no registered type claims, sorted by key.
|
||||||
- Lookups, matching the C# `GetByName`, `GetByIndex` and `GetGlobal`. `#[cultcache(name)]` and `#[cultcache(index)]` / `#[cultcache(index = "alias")]` on `DatabaseEntry` fields and `#[cultcache(global)]` on the struct give `CultCache::get_by_name`, `get_by_index` and `get_global`. An empty name and a blank index value are not found; records of one type sharing a name find the one with the smallest key (an index value is unique, below). A second record of a global type under another key is refused on every write path and on load with `CultCacheSecondGlobal`. Two `name` members, or two members with one index alias, are refused at compile time. A member's text comes from `CultLookupValue` (`String`, `Option` of one, integers, `bool`, `char`).
|
- Lookups, matching the C# `GetByName`, `GetByIndex` and `GetGlobal`. `#[cultcache(name)]` and `#[cultcache(index)]` / `#[cultcache(index = "alias")]` on `DatabaseEntry` fields and `#[cultcache(global)]` on the struct give `CultCache::get_by_name`, `get_by_index` and `get_global`. An empty name and a blank index value are not found; records of one type sharing a name find the one with the smallest key (an index value is unique, below). A second record of a global type under another key is refused on every write path and on load with `CultCacheSecondGlobal`. Two `name` members, or two members with one index alias, are refused at compile time. A member's text comes from `CultLookupValue` (`String`, `Option` of one, integers, `bool`, `char`).
|
||||||
- `SchemaConflictError`, the typed refusal of a write the catalog cannot describe: records of different types under one schema id, or an arrived schema and a registered one that share an id and disagree on the schema name. A whole-store write (`push_all`) refuses with it, names the schema id, the names involved and a record key, writes nothing and leaves the file as it is. A caller tells it apart with `error.downcast_ref::<SchemaConflictError>()`.
|
- `SchemaConflictError`, the typed refusal of a write the catalog cannot describe: records of different types under one schema id, or an arrived schema and a registered one that share an id and disagree on the schema name. A whole-store write (`push_all`) refuses with it, names the schema id, the names involved and a record key, writes nothing and leaves the file as it is. A caller tells it apart with `error.downcast_ref::<SchemaConflictError>()`.
|
||||||
|
|
|
||||||
802
packages/cultcache-rs/Cargo.lock
generated
802
packages/cultcache-rs/Cargo.lock
generated
|
|
@ -1,802 +0,0 @@
|
||||||
# This file is automatically @generated by Cargo.
|
|
||||||
# It is not intended for manual editing.
|
|
||||||
version = 4
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "android_system_properties"
|
|
||||||
version = "0.1.6"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "ae221649c9976a6f6c56ae1facf410f3ddb33cc661c4b7b61020a912d4237fbc"
|
|
||||||
dependencies = [
|
|
||||||
"libc",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "anyhow"
|
|
||||||
version = "1.0.104"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "330a5ed07fa54e4702c9d6c4174f74427fc0ef6e214bbd677ae50a5099946470"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "ar_archive_writer"
|
|
||||||
version = "0.5.5"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "523e5e187fff36fcb8d1d19ccf0ca4ca43ec3d158316057f66dc6f72716bc5ec"
|
|
||||||
dependencies = [
|
|
||||||
"object",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "autocfg"
|
|
||||||
version = "1.5.1"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "f2032f911046de80f0a198e0901378627c33f59ea0ac00e363d481118bd70a53"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "bitflags"
|
|
||||||
version = "2.13.2"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "3ded4057c258ba199e2d26386d3af3780957ecaee6c4ef4041c6b4b8b97c0b06"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "block-buffer"
|
|
||||||
version = "0.10.4"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "3078c7629b62d3f0439517fa394996acacc5cbc91c5a20d8c658e77abd503a71"
|
|
||||||
dependencies = [
|
|
||||||
"generic-array",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "bumpalo"
|
|
||||||
version = "3.20.3"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "72f5acc6cb2ba439de613abc23857ec3d78374d8ed5ac84e9d11336e87da8649"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "cc"
|
|
||||||
version = "1.11.1"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "4ff2a8126fff0f8c839080d619675a585e61720bb12d2baceae45769fd66f155"
|
|
||||||
dependencies = [
|
|
||||||
"find-msvc-tools",
|
|
||||||
"shlex",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "cfg-if"
|
|
||||||
version = "1.0.5"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "4e7648175b45a9a48536d676f68d918270699102aa8dab5496df06904c914600"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "chrono"
|
|
||||||
version = "0.4.45"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "1aa79e62e7697b8e29b513a68abacf485adcd1fe8284a4316c5ae868e6633327"
|
|
||||||
dependencies = [
|
|
||||||
"iana-time-zone",
|
|
||||||
"js-sys",
|
|
||||||
"num-traits",
|
|
||||||
"serde",
|
|
||||||
"wasm-bindgen",
|
|
||||||
"windows-link",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "core-foundation-sys"
|
|
||||||
version = "0.8.7"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "773648b94d0e5d620f64f280777445740e61fe701025087ec8b57f45c791888b"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "cpufeatures"
|
|
||||||
version = "0.2.17"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "59ed5838eebb26a2bb2e58f6d5b5316989ae9d08bab10e0e6d103e656d1b0280"
|
|
||||||
dependencies = [
|
|
||||||
"libc",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "crypto-common"
|
|
||||||
version = "0.1.7"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "78c8292055d1c1df0cce5d180393dc8cce0abec0a7102adb6c7b1eef6016d60a"
|
|
||||||
dependencies = [
|
|
||||||
"generic-array",
|
|
||||||
"typenum",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "cultcache-rs"
|
|
||||||
version = "0.3.1"
|
|
||||||
dependencies = [
|
|
||||||
"anyhow",
|
|
||||||
"chrono",
|
|
||||||
"cultcache-rs-derive",
|
|
||||||
"fs2",
|
|
||||||
"pretty_assertions",
|
|
||||||
"redb",
|
|
||||||
"rmp-serde",
|
|
||||||
"serde",
|
|
||||||
"serde_bytes",
|
|
||||||
"serde_json",
|
|
||||||
"serde_stacker",
|
|
||||||
"sha2",
|
|
||||||
"stacker",
|
|
||||||
"tempfile",
|
|
||||||
"uuid",
|
|
||||||
"windows-sys 0.59.0",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "cultcache-rs-derive"
|
|
||||||
version = "0.2.0"
|
|
||||||
dependencies = [
|
|
||||||
"proc-macro2",
|
|
||||||
"quote",
|
|
||||||
"syn 2.0.119",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "diff"
|
|
||||||
version = "0.1.13"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "56254986775e3233ffa9c4d7d3faaf6d36a2c09d30b20687e9f88bc8bafc16c8"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "digest"
|
|
||||||
version = "0.10.7"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "9ed9a281f7bc9b7576e61468ba615a66a5c8cfdff42420a70aa82701a3b1e292"
|
|
||||||
dependencies = [
|
|
||||||
"block-buffer",
|
|
||||||
"crypto-common",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "errno"
|
|
||||||
version = "0.3.15"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "e35d6e78f4cebb90e51d543db8fe41528851d6deeef6ef21ebd4bfdc1e784776"
|
|
||||||
dependencies = [
|
|
||||||
"libc",
|
|
||||||
"windows-sys 0.61.2",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "fastrand"
|
|
||||||
version = "2.5.0"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "da7c62ceae207dd37ea5b845da6a0696c799f85e97da1ab5b7910be3c1c80223"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "find-msvc-tools"
|
|
||||||
version = "0.1.15"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "1c66915cc5391097de7a2b0b972e8505aa33c0df401fd3a6811dbdb32881ba48"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "fs2"
|
|
||||||
version = "0.4.3"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "9564fc758e15025b46aa6643b1b77d047d1a56a1aea6e01002ac0c7026876213"
|
|
||||||
dependencies = [
|
|
||||||
"libc",
|
|
||||||
"winapi",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "futures-core"
|
|
||||||
version = "0.3.34"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "92d699e522242e69e3003b94ecc1f960f3a5e015aa7c5d7486e65ad01dd94f5e"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "futures-task"
|
|
||||||
version = "0.3.34"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "cd417de3d1d015fc3bfd2b1ea46dfc7bab72ef86f1cc7cc9c78e728b34a6d1fd"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "futures-util"
|
|
||||||
version = "0.3.34"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "0d50a92467f8ba5dd6e3ee5d4bd04d73ab2e4e1c44474a0674821dfce14b79bc"
|
|
||||||
dependencies = [
|
|
||||||
"futures-core",
|
|
||||||
"futures-task",
|
|
||||||
"pin-project-lite",
|
|
||||||
"slab",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "generic-array"
|
|
||||||
version = "0.14.7"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "85649ca51fd72272d7821adaf274ad91c288277713d9c18820d8499a7ff69e9a"
|
|
||||||
dependencies = [
|
|
||||||
"typenum",
|
|
||||||
"version_check",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "getrandom"
|
|
||||||
version = "0.4.3"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "300e883d756b2e4ec94e02791f39b04b522276138852cfc41d9fb7e904106099"
|
|
||||||
dependencies = [
|
|
||||||
"cfg-if",
|
|
||||||
"libc",
|
|
||||||
"r-efi",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "iana-time-zone"
|
|
||||||
version = "0.1.65"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "e31bc9ad994ba00e440a8aa5c9ef0ec67d5cb5e5cb0cc7f8b744a35b389cc470"
|
|
||||||
dependencies = [
|
|
||||||
"android_system_properties",
|
|
||||||
"core-foundation-sys",
|
|
||||||
"iana-time-zone-haiku",
|
|
||||||
"js-sys",
|
|
||||||
"log",
|
|
||||||
"wasm-bindgen",
|
|
||||||
"windows-core",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "iana-time-zone-haiku"
|
|
||||||
version = "0.1.2"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "f31827a206f56af32e590ba56d5d2d085f558508192593743f16b2306495269f"
|
|
||||||
dependencies = [
|
|
||||||
"cc",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "itoa"
|
|
||||||
version = "1.0.19"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "3bd1574e617a9a6c1f8f8181bd7e841e1f20e4277607ef28945765188d6284d4"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "js-sys"
|
|
||||||
version = "0.3.107"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "8dc09d2154098bbf4ef54eab6b117a3c24cbbffe94046b16ee6d6d4510584d3a"
|
|
||||||
dependencies = [
|
|
||||||
"cfg-if",
|
|
||||||
"futures-util",
|
|
||||||
"wasm-bindgen",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "libc"
|
|
||||||
version = "0.2.191"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "65cd87c9a6d60536580b316ad985726104730a5151c99845f2490428ef91240a"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "linux-raw-sys"
|
|
||||||
version = "0.12.1"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "32a66949e030da00e8c7d4434b251670a91556f4144941d37452769c25d58a53"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "log"
|
|
||||||
version = "0.4.35"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "5d15f86d12da44cd8d4ec3c73984537eb7f4cadcb9776a575a0a8a05ca11005c"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "memchr"
|
|
||||||
version = "2.8.3"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "cf8baf1c55e62ffcace7a9f06f4bd9cd3f0c4beb022d3b367256b91b87513d98"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "num-traits"
|
|
||||||
version = "0.2.19"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "071dfc062690e90b734c0b2273ce72ad0ffa95f0c74596bc250dcfd960262841"
|
|
||||||
dependencies = [
|
|
||||||
"autocfg",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "object"
|
|
||||||
version = "0.39.1"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "2e5a6c098c7a3b6547378093f5cc30bc54fd361ce711e05293a5cc589562739b"
|
|
||||||
dependencies = [
|
|
||||||
"memchr",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "once_cell"
|
|
||||||
version = "1.21.4"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "pin-project-lite"
|
|
||||||
version = "0.2.17"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "a89322df9ebe1c1578d689c92318e070967d1042b512afbe49518723f4e6d5cd"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "pretty_assertions"
|
|
||||||
version = "1.4.1"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "3ae130e2f271fbc2ac3a40fb1d07180839cdbbe443c7a27e1e3c13c5cac0116d"
|
|
||||||
dependencies = [
|
|
||||||
"diff",
|
|
||||||
"yansi",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "proc-macro2"
|
|
||||||
version = "1.0.107"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "985e7ec9bb745e6ce6535b544d84d6cd6f7ad8bd711c398938ae983b91a766d9"
|
|
||||||
dependencies = [
|
|
||||||
"unicode-ident",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "psm"
|
|
||||||
version = "0.1.32"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "4dcd034599e63b970727f70d79e02d62390a4a84f7c6b827c27c46d5ac3fa622"
|
|
||||||
dependencies = [
|
|
||||||
"ar_archive_writer",
|
|
||||||
"cc",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "quote"
|
|
||||||
version = "1.0.47"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "1fbf4db142a473a8d80c26bbf18454ed458bf8d26c8219c331daecfdbd079001"
|
|
||||||
dependencies = [
|
|
||||||
"proc-macro2",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "r-efi"
|
|
||||||
version = "6.0.0"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "f8dcc9c7d52a811697d2151c701e0d08956f92b0e24136cf4cf27b57a6a0d9bf"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "redb"
|
|
||||||
version = "4.5.0"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "8b317ef681e18f6091efbfab532eaf924a135c492d9d0299d0fbfae07e92a39b"
|
|
||||||
dependencies = [
|
|
||||||
"libc",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "rmp"
|
|
||||||
version = "0.8.15"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "4ba8be72d372b2c9b35542551678538b562e7cf86c3315773cae48dfbfe7790c"
|
|
||||||
dependencies = [
|
|
||||||
"num-traits",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "rmp-serde"
|
|
||||||
version = "1.3.1"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "72f81bee8c8ef9b577d1681a70ebbc962c232461e397b22c208c43c04b67a155"
|
|
||||||
dependencies = [
|
|
||||||
"rmp",
|
|
||||||
"serde",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "rustix"
|
|
||||||
version = "1.1.6"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "e5e76742e5294153d4dde1207dbec5bdd81eef6fabdc0d2118babadabfd858aa"
|
|
||||||
dependencies = [
|
|
||||||
"bitflags",
|
|
||||||
"errno",
|
|
||||||
"libc",
|
|
||||||
"linux-raw-sys",
|
|
||||||
"windows-sys 0.61.2",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "rustversion"
|
|
||||||
version = "1.0.23"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "cf54715a573b99ac80df0bc206da022bcd442c974952c7b9720069370852e21f"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "serde"
|
|
||||||
version = "1.0.229"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "4148590afebada386688f18773da617792bf2ef03ffc1e4cbd2b1d45b023e0ba"
|
|
||||||
dependencies = [
|
|
||||||
"serde_core",
|
|
||||||
"serde_derive",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "serde_bytes"
|
|
||||||
version = "0.11.19"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "a5d440709e79d88e51ac01c4b72fc6cb7314017bb7da9eeff678aa94c10e3ea8"
|
|
||||||
dependencies = [
|
|
||||||
"serde",
|
|
||||||
"serde_core",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "serde_core"
|
|
||||||
version = "1.0.229"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "67dca2c9c51e58a4791a4b1ed58308b39c64224d349a935ab5039aa360942a48"
|
|
||||||
dependencies = [
|
|
||||||
"serde_derive",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "serde_derive"
|
|
||||||
version = "1.0.229"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "e7a5d71263a5a7d47b41f6b3f06ba276f10cc18b0931f1799f710578e2309348"
|
|
||||||
dependencies = [
|
|
||||||
"proc-macro2",
|
|
||||||
"quote",
|
|
||||||
"syn 3.0.10",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "serde_json"
|
|
||||||
version = "1.0.154"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "e7e9cc8b1b85264074fbcc02a88680c4096b1e47df8f739dceb03bf482f04bd6"
|
|
||||||
dependencies = [
|
|
||||||
"itoa",
|
|
||||||
"memchr",
|
|
||||||
"serde",
|
|
||||||
"serde_core",
|
|
||||||
"zmij",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "serde_stacker"
|
|
||||||
version = "0.1.14"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "d4936375d50c4be7eff22293a9344f8e46f323ed2b3c243e52f89138d9bb0f4a"
|
|
||||||
dependencies = [
|
|
||||||
"serde",
|
|
||||||
"serde_core",
|
|
||||||
"stacker",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "sha2"
|
|
||||||
version = "0.10.9"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "a7507d819769d01a365ab707794a4084392c824f54a7a6a7862f8c3d0892b283"
|
|
||||||
dependencies = [
|
|
||||||
"cfg-if",
|
|
||||||
"cpufeatures",
|
|
||||||
"digest",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "shlex"
|
|
||||||
version = "2.0.1"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "f8fadd59c855ef2080decdef8ff161eb6661b86933c9d82e5ba29dc602a55aba"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "slab"
|
|
||||||
version = "0.4.12"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "0c790de23124f9ab44544d7ac05d60440adc586479ce501c1d6d7da3cd8c9cf5"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "stacker"
|
|
||||||
version = "0.1.25"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "707f49d46706bacf8a2b00d51dace3f9de527c13eec3778f570c411f89e69967"
|
|
||||||
dependencies = [
|
|
||||||
"cc",
|
|
||||||
"cfg-if",
|
|
||||||
"libc",
|
|
||||||
"psm",
|
|
||||||
"windows-sys 0.61.2",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "syn"
|
|
||||||
version = "2.0.119"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "872831b642d1a07999a962a351ed35b955ea2cfc8f3862091e2a240a84f17297"
|
|
||||||
dependencies = [
|
|
||||||
"proc-macro2",
|
|
||||||
"quote",
|
|
||||||
"unicode-ident",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "syn"
|
|
||||||
version = "3.0.10"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "4ae9ccbea3a7b0b09443036490c8f34a8b1b760fd345e5c0dae0aac718faea79"
|
|
||||||
dependencies = [
|
|
||||||
"proc-macro2",
|
|
||||||
"quote",
|
|
||||||
"unicode-ident",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "tempfile"
|
|
||||||
version = "3.27.0"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "32497e9a4c7b38532efcdebeef879707aa9f794296a4f0244f6f69e9bc8574bd"
|
|
||||||
dependencies = [
|
|
||||||
"fastrand",
|
|
||||||
"getrandom",
|
|
||||||
"once_cell",
|
|
||||||
"rustix",
|
|
||||||
"windows-sys 0.61.2",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "typenum"
|
|
||||||
version = "1.20.1"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "b6f5e870be6c3b371b77fe0ee0bafb859fa4964b4404c27de1d380043c4dda20"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "unicode-ident"
|
|
||||||
version = "1.0.27"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "a2c754d6c33795a1c324727428e5a7dedb5b06195f9890bdbcba760d3e246563"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "uuid"
|
|
||||||
version = "1.29.2"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "bed99139f7dac9b5cfe5f17be4d66dc7079a34dee1d74bcc77217119240e267c"
|
|
||||||
dependencies = [
|
|
||||||
"getrandom",
|
|
||||||
"js-sys",
|
|
||||||
"wasm-bindgen",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "version_check"
|
|
||||||
version = "0.9.5"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "0b928f33d975fc6ad9f86c8f283853ad26bdd5b10b7f1542aa2fa15e2289105a"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "wasm-bindgen"
|
|
||||||
version = "0.2.130"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "a0181c14ddd6c7b8b0b0132a5f1ea2f32be0d893cd3ea97b6e3b28886b8a3d1c"
|
|
||||||
dependencies = [
|
|
||||||
"cfg-if",
|
|
||||||
"rustversion",
|
|
||||||
"wasm-bindgen-macro",
|
|
||||||
"wasm-bindgen-shared",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "wasm-bindgen-macro"
|
|
||||||
version = "0.2.130"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "6e931a02a39abdbf66966fc35902b5ed58344750a70885bed4ebb3d8eaf28ed9"
|
|
||||||
dependencies = [
|
|
||||||
"quote",
|
|
||||||
"wasm-bindgen-macro-support",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "wasm-bindgen-macro-support"
|
|
||||||
version = "0.2.130"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "2ca4b54280e455bd831e33a6b8e734baf432fe63fbc35c42ac14ce67a043a53a"
|
|
||||||
dependencies = [
|
|
||||||
"bumpalo",
|
|
||||||
"proc-macro2",
|
|
||||||
"quote",
|
|
||||||
"syn 3.0.10",
|
|
||||||
"wasm-bindgen-shared",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "wasm-bindgen-shared"
|
|
||||||
version = "0.2.130"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "3b1f9c3798725016c6ee5f2f57869ec0831e8bbc0ab0310a86e787e97f41389e"
|
|
||||||
dependencies = [
|
|
||||||
"unicode-ident",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "winapi"
|
|
||||||
version = "0.3.9"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419"
|
|
||||||
dependencies = [
|
|
||||||
"winapi-i686-pc-windows-gnu",
|
|
||||||
"winapi-x86_64-pc-windows-gnu",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "winapi-i686-pc-windows-gnu"
|
|
||||||
version = "0.4.0"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "winapi-x86_64-pc-windows-gnu"
|
|
||||||
version = "0.4.0"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "windows-core"
|
|
||||||
version = "0.62.2"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "b8e83a14d34d0623b51dce9581199302a221863196a1dde71a7663a4c2be9deb"
|
|
||||||
dependencies = [
|
|
||||||
"windows-implement",
|
|
||||||
"windows-interface",
|
|
||||||
"windows-link",
|
|
||||||
"windows-result",
|
|
||||||
"windows-strings",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "windows-implement"
|
|
||||||
version = "0.60.2"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "053e2e040ab57b9dc951b72c264860db7eb3b0200ba345b4e4c3b14f67855ddf"
|
|
||||||
dependencies = [
|
|
||||||
"proc-macro2",
|
|
||||||
"quote",
|
|
||||||
"syn 2.0.119",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "windows-interface"
|
|
||||||
version = "0.59.3"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "3f316c4a2570ba26bbec722032c4099d8c8bc095efccdc15688708623367e358"
|
|
||||||
dependencies = [
|
|
||||||
"proc-macro2",
|
|
||||||
"quote",
|
|
||||||
"syn 2.0.119",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "windows-link"
|
|
||||||
version = "0.2.1"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "f0805222e57f7521d6a62e36fa9163bc891acd422f971defe97d64e70d0a4fe5"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "windows-result"
|
|
||||||
version = "0.4.1"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "7781fa89eaf60850ac3d2da7af8e5242a5ea78d1a11c49bf2910bb5a73853eb5"
|
|
||||||
dependencies = [
|
|
||||||
"windows-link",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "windows-strings"
|
|
||||||
version = "0.5.1"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "7837d08f69c77cf6b07689544538e017c1bfcf57e34b4c0ff58e6c2cd3b37091"
|
|
||||||
dependencies = [
|
|
||||||
"windows-link",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "windows-sys"
|
|
||||||
version = "0.59.0"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "1e38bc4d79ed67fd075bcc251a1c39b32a1776bbe92e5bef1f0bf1f8c531853b"
|
|
||||||
dependencies = [
|
|
||||||
"windows-targets",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "windows-sys"
|
|
||||||
version = "0.61.2"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "ae137229bcbd6cdf0f7b80a31df61766145077ddf49416a728b02cb3921ff3fc"
|
|
||||||
dependencies = [
|
|
||||||
"windows-link",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "windows-targets"
|
|
||||||
version = "0.52.6"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "9b724f72796e036ab90c1021d4780d4d3d648aca59e491e6b98e725b84e99973"
|
|
||||||
dependencies = [
|
|
||||||
"windows_aarch64_gnullvm",
|
|
||||||
"windows_aarch64_msvc",
|
|
||||||
"windows_i686_gnu",
|
|
||||||
"windows_i686_gnullvm",
|
|
||||||
"windows_i686_msvc",
|
|
||||||
"windows_x86_64_gnu",
|
|
||||||
"windows_x86_64_gnullvm",
|
|
||||||
"windows_x86_64_msvc",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "windows_aarch64_gnullvm"
|
|
||||||
version = "0.52.6"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "32a4622180e7a0ec044bb555404c800bc9fd9ec262ec147edd5989ccd0c02cd3"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "windows_aarch64_msvc"
|
|
||||||
version = "0.52.6"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "09ec2a7bb152e2252b53fa7803150007879548bc709c039df7627cabbd05d469"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "windows_i686_gnu"
|
|
||||||
version = "0.52.6"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "8e9b5ad5ab802e97eb8e295ac6720e509ee4c243f69d781394014ebfe8bbfa0b"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "windows_i686_gnullvm"
|
|
||||||
version = "0.52.6"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "0eee52d38c090b3caa76c563b86c3a4bd71ef1a819287c19d586d7334ae8ed66"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "windows_i686_msvc"
|
|
||||||
version = "0.52.6"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "240948bc05c5e7c6dabba28bf89d89ffce3e303022809e73deaefe4f6ec56c66"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "windows_x86_64_gnu"
|
|
||||||
version = "0.52.6"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "147a5c80aabfbf0c7d901cb5895d1de30ef2907eb21fbbab29ca94c5b08b1a78"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "windows_x86_64_gnullvm"
|
|
||||||
version = "0.52.6"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "24d5b23dc417412679681396f2b49f3de8c1473deb516bd34410872eff51ed0d"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "windows_x86_64_msvc"
|
|
||||||
version = "0.52.6"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "yansi"
|
|
||||||
version = "1.0.1"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "cfe53a6657fd280eaa890a3bc59152892ffa3e30101319d168b781ed6529b049"
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "zmij"
|
|
||||||
version = "1.0.23"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "29666d0abbfad1e3dc4dcf6144730dd3a3ab225bbbdac83319345b1b44ccfc1b"
|
|
||||||
|
|
@ -23,7 +23,6 @@ serde = { version = "1", features = ["derive"] }
|
||||||
serde_bytes = "0.11"
|
serde_bytes = "0.11"
|
||||||
serde_json = "1"
|
serde_json = "1"
|
||||||
serde_stacker = "0.1.14"
|
serde_stacker = "0.1.14"
|
||||||
sha2 = "0.10"
|
|
||||||
stacker = "0.1.25"
|
stacker = "0.1.25"
|
||||||
uuid = { version = "1", features = ["v4"] }
|
uuid = { version = "1", features = ["v4"] }
|
||||||
|
|
||||||
|
|
@ -32,4 +31,4 @@ pretty_assertions = "1.4"
|
||||||
tempfile = "3"
|
tempfile = "3"
|
||||||
|
|
||||||
[target.'cfg(windows)'.dependencies]
|
[target.'cfg(windows)'.dependencies]
|
||||||
windows-sys = { version = "0.59", features = ["Win32_Foundation", "Win32_Storage_FileSystem", "Win32_Security", "Win32_System_WindowsProgramming"] }
|
windows-sys = { version = "0.59", features = ["Win32_Foundation", "Win32_Storage_FileSystem"] }
|
||||||
|
|
|
||||||
|
|
@ -39,8 +39,8 @@ CultCache is a domain cache with persistence adapters.
|
||||||
file access with a sidecar lock file.
|
file access with a sidecar lock file.
|
||||||
|
|
||||||
This is not an ORM, not a database, and not distributed consensus in a novelty
|
This is not an ORM, not a database, and not distributed consensus in a novelty
|
||||||
hat. Several processes may write the same single-file store, one at a time under
|
hat. If multiple processes write the same backing file, use an external lock or
|
||||||
its sidecar lock; write ordering across keys or stores needs a coordinator.
|
a coordinator.
|
||||||
|
|
||||||
## Current API
|
## Current API
|
||||||
|
|
||||||
|
|
@ -186,7 +186,7 @@ without pretending Rust has runtime reflection hiding under the floorboards.
|
||||||
- `soa::<T>`
|
- `soa::<T>`
|
||||||
- `put::<T>`
|
- `put::<T>`
|
||||||
- `put_envelope::<T>`
|
- `put_envelope::<T>`
|
||||||
- `update::<T>` and `update_with_attempts::<T>`: the conditional golden-path write (read the stored record, apply, commit only over what was read, rerun on a lost race)
|
- `update::<T>`
|
||||||
- `delete::<T>`
|
- `delete::<T>`
|
||||||
- `snapshot`
|
- `snapshot`
|
||||||
- `snapshot_soa`
|
- `snapshot_soa`
|
||||||
|
|
@ -236,17 +236,6 @@ assert_eq!(rmp_serde::from_slice::<Node>(&bytes)?, tree);
|
||||||
# Ok::<(), Box<dyn std::error::Error>>(())
|
# Ok::<(), Box<dyn std::error::Error>>(())
|
||||||
```
|
```
|
||||||
|
|
||||||
## Records written by a newer build
|
|
||||||
|
|
||||||
A payload that carries a slot past the slots its type declares, in a record, a nested record, a list element or a union
|
|
||||||
arm (a unit arm declares none), still decodes: the extra slots are skipped. The cache then holds that record read-only,
|
|
||||||
because writing it would drop what the newer writer stored. `put`, `put_envelope`, `put_raw_envelope`,
|
|
||||||
`put_prepared_batch` and `delete` of its key are refused with `SchemaConflictError`, whose `unread_slots` names the type
|
|
||||||
and the slot counts and never a value; `CultCache::is_writable(type, key)` answers the same check. An untouched
|
|
||||||
read-only record keeps its bytes through every other write. A short payload (missing trailing slots) is not marked, and
|
|
||||||
a payload nested past `MAX_PAYLOAD_DEPTH` is refused before anything is read. `decode_payload_marked` is the decode that
|
|
||||||
returns the `UnreadSlots` mark. This runtime has no compatible schema ids, so no mark is consented.
|
|
||||||
|
|
||||||
## Structure Of Arrays
|
## Structure Of Arrays
|
||||||
|
|
||||||
The C# CultCache hot path exposes CPU-local SoA scans as:
|
The C# CultCache hot path exposes CPU-local SoA scans as:
|
||||||
|
|
@ -304,14 +293,6 @@ The contract, shared with every runtime, is one home store per document type
|
||||||
|
|
||||||
## Persistence Semantics
|
## Persistence Semantics
|
||||||
|
|
||||||
`update` is the golden path for changing a record another writer may also change: each attempt reads the record and its content
|
|
||||||
version from the home store, hands `apply` a copy, and commits only if the store still holds that version. `put` is the blind
|
|
||||||
write. The single-file store stamps a replacing write (`push`, `push_all` and `update`'s commit) strictly later than the record
|
|
||||||
it replaces, and the cache holds the stamp the store reports; the redb stores and the exact-envelope family
|
|
||||||
(`compare_and_swap_entry` and the other store-level conditional writes) write the caller's envelope byte for byte. A store
|
|
||||||
needs `read` and `commit_if` to serve `update`; the redb stores do not have them.
|
|
||||||
The version is the SHA-256 of the record re-encoded as the store file writes it; that equals the hash of the record's bytes in the file (and the C# reference's vector) whenever the file's MessagePack encodings are minimal, as every runtime's writer produces.
|
|
||||||
|
|
||||||
`put` persists before mutating the in-memory cache. If persistence fails, the
|
`put` persists before mutating the in-memory cache. If persistence fails, the
|
||||||
cache does not pretend the write succeeded.
|
cache does not pretend the write succeeded.
|
||||||
|
|
||||||
|
|
@ -392,10 +373,10 @@ an empty store. Any other failure to reach it, such as a symlink loop, a file
|
||||||
where a parent directory should be, or a missing permission, is an I/O error.
|
where a parent directory should be, or a missing permission, is an I/O error.
|
||||||
A store file that exists and holds zero bytes is `Undecodable`: no CultCache
|
A store file that exists and holds zero bytes is `Undecodable`: no CultCache
|
||||||
writer leaves one. A symbolic link whose target is gone is not a missing store:
|
writer leaves one. A symbolic link whose target is gone is not a missing store:
|
||||||
reading it is an I/O error. A write at a store path that is a link, live or dangling, is
|
reading it is an I/O error, so a read-then-write (`push`, `delete`, the exchanges)
|
||||||
refused with `StoreLinkedError` (`error.downcast_ref::<StoreLinkedError>()`) before the
|
fails before writing. Writes do not yet follow links: a write through a live link,
|
||||||
lock and the replace, so no write swaps a link for a regular file; configure the link's
|
and a `push_all` through a dangling one, replace the link with a regular file and
|
||||||
target as the store path. Reads through a live link work. A refusal names no
|
leave its target alone. A refusal names no
|
||||||
value read from the file; it names a record only by its key and schema id, and
|
value read from the file; it names a record only by its key and schema id, and
|
||||||
a header only when it has the shape `cultcache.store.v<digits>`.
|
a header only when it has the shape `cultcache.store.v<digits>`.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -381,7 +381,6 @@ fn slot_codec(ident: &syn::Ident, slots: &[CultCacheSlot]) -> proc_macro2::Token
|
||||||
where
|
where
|
||||||
__A: ::serde::de::SeqAccess<'de>,
|
__A: ::serde::de::SeqAccess<'de>,
|
||||||
{
|
{
|
||||||
let __ticket = ::cultcache_rs::__enter_slots();
|
|
||||||
#(#option_declarations)*
|
#(#option_declarations)*
|
||||||
let mut index = 0usize;
|
let mut index = 0usize;
|
||||||
while index <= #max_slot {
|
while index <= #max_slot {
|
||||||
|
|
@ -391,15 +390,7 @@ fn slot_codec(ident: &syn::Ident, slots: &[CultCacheSlot]) -> proc_macro2::Token
|
||||||
}
|
}
|
||||||
index += 1;
|
index += 1;
|
||||||
}
|
}
|
||||||
// The slots past the declared ones are skipped and counted: the decode entry marks the record
|
while let ::std::option::Option::Some(_) = seq.next_element::<::serde::de::IgnoredAny>()? {}
|
||||||
// that carried them read-only.
|
|
||||||
let mut __extra = 0usize;
|
|
||||||
while seq.next_element::<::serde::de::IgnoredAny>()?.is_some() {
|
|
||||||
__extra += 1;
|
|
||||||
}
|
|
||||||
if __extra > 0 {
|
|
||||||
::cultcache_rs::__note_unread_slots(__ticket, stringify!(#ident), #max_slot + 1 + __extra, #max_slot + 1);
|
|
||||||
}
|
|
||||||
Ok(#ident {
|
Ok(#ident {
|
||||||
#(#build_fields),*
|
#(#build_fields),*
|
||||||
})
|
})
|
||||||
|
|
@ -576,13 +567,10 @@ fn union_codec(input: DeriveInput) -> syn::Result<proc_macro2::TokenStream> {
|
||||||
quote! {
|
quote! {
|
||||||
#key => {
|
#key => {
|
||||||
match seq
|
match seq
|
||||||
.next_element::<::std::option::Option<::cultcache_rs::__UnitArmSlots>>()
|
.next_element::<::std::option::Option<[(); 0]>>()
|
||||||
.map_err(|_| ::serde::de::Error::custom(#arity_message))?
|
.map_err(|_| ::serde::de::Error::custom(#arity_message))?
|
||||||
{
|
{
|
||||||
::std::option::Option::Some(::std::option::Option::Some(slots)) => {
|
::std::option::Option::Some(::std::option::Option::Some(_)) => #ident::#variant,
|
||||||
slots.note(stringify!(#variant));
|
|
||||||
#ident::#variant
|
|
||||||
}
|
|
||||||
::std::option::Option::Some(::std::option::Option::None) => {
|
::std::option::Option::Some(::std::option::Option::None) => {
|
||||||
return ::std::result::Result::Err(::serde::de::Error::custom(
|
return ::std::result::Result::Err(::serde::de::Error::custom(
|
||||||
format!(#nil_slots_message, #key),
|
format!(#nil_slots_message, #key),
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,6 @@
|
||||||
use anyhow::Result;
|
use anyhow::Result;
|
||||||
use anyhow::anyhow;
|
use anyhow::anyhow;
|
||||||
use cultcache_rs::CultCache;
|
use cultcache_rs::CultCache;
|
||||||
use cultcache_rs::CultSlots;
|
|
||||||
use cultcache_rs::CultUnion;
|
|
||||||
use cultcache_rs::DatabaseEntry;
|
use cultcache_rs::DatabaseEntry;
|
||||||
use cultcache_rs::SingleFileMessagePackBackingStore;
|
use cultcache_rs::SingleFileMessagePackBackingStore;
|
||||||
use serde_json::json;
|
use serde_json::json;
|
||||||
|
|
@ -41,100 +39,6 @@ struct CultCacheInteropDeck {
|
||||||
marks: Vec<CultCacheInteropMark>,
|
marks: Vec<CultCacheInteropMark>,
|
||||||
}
|
}
|
||||||
|
|
||||||
// A union field and nested bytes: the shapes a Bifrost-style store holds beyond plain strings.
|
|
||||||
#[derive(Clone, Debug, PartialEq, Eq, CultUnion)]
|
|
||||||
enum InteropArm {
|
|
||||||
#[cultcache(key = 0)]
|
|
||||||
Text(InteropTextArm),
|
|
||||||
#[cultcache(key = 1)]
|
|
||||||
Pack(InteropPackArm),
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, PartialEq, Eq, CultSlots)]
|
|
||||||
struct InteropTextArm {
|
|
||||||
#[cultcache(key = 0)]
|
|
||||||
text: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, PartialEq, Eq, CultSlots)]
|
|
||||||
struct InteropPackArm {
|
|
||||||
#[cultcache(key = 0)]
|
|
||||||
label: String,
|
|
||||||
#[cultcache(key = 1)]
|
|
||||||
chunks: Vec<serde_bytes::ByteBuf>,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, PartialEq, Eq, DatabaseEntry)]
|
|
||||||
#[cultcache(type = "cultcache.interop-shape", schema = "CultCacheInteropShape")]
|
|
||||||
struct CultCacheInteropShape {
|
|
||||||
#[cultcache(key = 0)]
|
|
||||||
document_id: String,
|
|
||||||
#[cultcache(key = 1)]
|
|
||||||
arm: InteropArm,
|
|
||||||
#[cultcache(key = 2)]
|
|
||||||
raw: serde_bytes::ByteBuf,
|
|
||||||
}
|
|
||||||
|
|
||||||
fn shapes() -> Vec<CultCacheInteropShape> {
|
|
||||||
vec![
|
|
||||||
CultCacheInteropShape {
|
|
||||||
document_id: "shape:text".into(),
|
|
||||||
arm: InteropArm::Text(InteropTextArm { text: "union arm 0".into() }),
|
|
||||||
raw: (0..=255u8).collect::<Vec<_>>().into(),
|
|
||||||
},
|
|
||||||
CultCacheInteropShape {
|
|
||||||
document_id: "shape:pack".into(),
|
|
||||||
arm: InteropArm::Pack(InteropPackArm {
|
|
||||||
label: "union arm 1".into(),
|
|
||||||
chunks: vec![vec![0xc0, 0xc1, 0x00].into(), vec![].into(), vec![0x92, 0x01, 0x02].into()],
|
|
||||||
}),
|
|
||||||
raw: vec![0xde, 0xad, 0xbe, 0xef].into(),
|
|
||||||
},
|
|
||||||
]
|
|
||||||
}
|
|
||||||
|
|
||||||
fn write_shapes(file: &str) -> Result<()> {
|
|
||||||
let mut cache = CultCache::new();
|
|
||||||
cache.register_entry_type::<CultCacheInteropShape>()?;
|
|
||||||
cache.add_generic_backing_store(SingleFileMessagePackBackingStore::new(file))?;
|
|
||||||
cache.pull_all_backing_stores()?;
|
|
||||||
for shape in shapes() {
|
|
||||||
cache.put(&shape.document_id, &shape)?;
|
|
||||||
}
|
|
||||||
print_shapes(shapes())
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Opens the store through the read-only snapshot door: no lock file, no staging file, no rewrite.
|
|
||||||
fn read_shapes(file: &str) -> Result<()> {
|
|
||||||
let envelopes = SingleFileMessagePackBackingStore::new(file).pull_all_read_only_snapshot()?;
|
|
||||||
let mut found = Vec::new();
|
|
||||||
for envelope in envelopes.iter().filter(|envelope| envelope.r#type == CultCacheInteropShape::TYPE) {
|
|
||||||
found.push(cultcache_rs::decode_payload::<CultCacheInteropShape>(&envelope.payload)?);
|
|
||||||
}
|
|
||||||
print_shapes(found)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn print_shapes(mut found: Vec<CultCacheInteropShape>) -> Result<()> {
|
|
||||||
let hex = |bytes: &[u8]| bytes.iter().map(|byte| format!("{byte:02X}")).collect::<String>();
|
|
||||||
found.sort_by(|a, b| a.document_id.cmp(&b.document_id));
|
|
||||||
let rows: Vec<_> = found
|
|
||||||
.iter()
|
|
||||||
.map(|shape| {
|
|
||||||
let arm = match &shape.arm {
|
|
||||||
InteropArm::Text(text) => json!({ "kind": "text", "text": text.text }),
|
|
||||||
InteropArm::Pack(pack) => json!({
|
|
||||||
"kind": "pack",
|
|
||||||
"label": pack.label,
|
|
||||||
"chunks": pack.chunks.iter().map(|chunk| hex(chunk)).collect::<Vec<_>>(),
|
|
||||||
}),
|
|
||||||
};
|
|
||||||
json!({ "documentId": shape.document_id, "arm": arm, "raw": hex(&shape.raw) })
|
|
||||||
})
|
|
||||||
.collect();
|
|
||||||
println!("{}", serde_json::to_string(&rows)?);
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
fn read_deck(file: &str) -> Result<()> {
|
fn read_deck(file: &str) -> Result<()> {
|
||||||
let mut cache = CultCache::new();
|
let mut cache = CultCache::new();
|
||||||
cache.register_entry_type::<CultCacheInteropDeck>()?;
|
cache.register_entry_type::<CultCacheInteropDeck>()?;
|
||||||
|
|
@ -166,8 +70,6 @@ fn main() -> Result<()> {
|
||||||
"write" => write_note(file, require_arg(&options, "runtime-id")?)?,
|
"write" => write_note(file, require_arg(&options, "runtime-id")?)?,
|
||||||
"read" => read_note(file)?,
|
"read" => read_note(file)?,
|
||||||
"read-deck" => read_deck(file)?,
|
"read-deck" => read_deck(file)?,
|
||||||
"write-shapes" => write_shapes(file)?,
|
|
||||||
"read-shapes" => read_shapes(file)?,
|
|
||||||
"hold-lock" => hold_lock(file, require_arg(&options, "ms")?.parse()?)?,
|
"hold-lock" => hold_lock(file, require_arg(&options, "ms")?.parse()?)?,
|
||||||
_ => return Err(anyhow!("unknown mode {mode}")),
|
_ => return Err(anyhow!("unknown mode {mode}")),
|
||||||
}
|
}
|
||||||
|
|
|
||||||
File diff suppressed because it is too large
Load diff
|
|
@ -1,235 +0,0 @@
|
||||||
//! The union-parity vectors' types and constructed value, shared by the test files that walk them.
|
|
||||||
#![allow(dead_code)]
|
|
||||||
|
|
||||||
use std::path::PathBuf;
|
|
||||||
|
|
||||||
use cultcache_rs::CultSlots;
|
|
||||||
use cultcache_rs::CultUnion;
|
|
||||||
use cultcache_rs::DatabaseEntry;
|
|
||||||
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, PartialEq, CultUnion)]
|
|
||||||
pub enum Node {
|
|
||||||
#[cultcache(key = 0)]
|
|
||||||
Box(BoxArm),
|
|
||||||
#[cultcache(key = 1)]
|
|
||||||
Text(TextArm),
|
|
||||||
#[cultcache(key = 2)]
|
|
||||||
Use(UseArm),
|
|
||||||
#[cultcache(key = 5)]
|
|
||||||
Image(ImageArm),
|
|
||||||
#[cultcache(key = 6)]
|
|
||||||
Wrap(WrapArm),
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, PartialEq, CultSlots)]
|
|
||||||
pub struct WrapArm {
|
|
||||||
#[cultcache(key = 0)]
|
|
||||||
pub inner: Option<std::boxed::Box<Node>>,
|
|
||||||
#[cultcache(key = 1)]
|
|
||||||
pub id: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, PartialEq, CultSlots)]
|
|
||||||
pub struct BoxArm {
|
|
||||||
#[cultcache(key = 0)]
|
|
||||||
pub id: String,
|
|
||||||
#[cultcache(key = 1)]
|
|
||||||
pub children: Vec<Node>,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, PartialEq, CultSlots)]
|
|
||||||
pub struct TextArm {
|
|
||||||
#[cultcache(key = 0)]
|
|
||||||
pub id: String,
|
|
||||||
#[cultcache(key = 1)]
|
|
||||||
pub content: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, PartialEq, CultSlots)]
|
|
||||||
pub struct UseArm {
|
|
||||||
#[cultcache(key = 0)]
|
|
||||||
pub id: String,
|
|
||||||
#[cultcache(key = 1)]
|
|
||||||
pub composition: Composition,
|
|
||||||
#[cultcache(key = 2)]
|
|
||||||
pub slots: Vec<Option<Node>>,
|
|
||||||
}
|
|
||||||
|
|
||||||
// Slot 2 is retired: a gap written nil.
|
|
||||||
#[derive(Clone, Debug, PartialEq, CultSlots)]
|
|
||||||
pub struct ImageArm {
|
|
||||||
#[cultcache(key = 0)]
|
|
||||||
pub id: String,
|
|
||||||
#[cultcache(key = 1)]
|
|
||||||
pub uri: String,
|
|
||||||
#[cultcache(key = 3)]
|
|
||||||
pub alt: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, PartialEq, CultSlots)]
|
|
||||||
pub struct Composition {
|
|
||||||
#[cultcache(key = 0)]
|
|
||||||
pub name: String,
|
|
||||||
#[cultcache(key = 1)]
|
|
||||||
pub body: Option<std::boxed::Box<Node>>,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, PartialEq, CultUnion)]
|
|
||||||
pub enum Outcome {
|
|
||||||
#[cultcache(key = 0)]
|
|
||||||
Pending(PendingArm),
|
|
||||||
#[cultcache(key = 1)]
|
|
||||||
Completed(CompletedArm),
|
|
||||||
#[cultcache(key = 2)]
|
|
||||||
Denied(IdArm),
|
|
||||||
#[cultcache(key = -2147483648)]
|
|
||||||
Floor(IdArm),
|
|
||||||
#[cultcache(key = 2147483647)]
|
|
||||||
Ceiling(IdArm),
|
|
||||||
}
|
|
||||||
|
|
||||||
// The codec's unit arm (no members, written [key, []]), kept apart from the golden: a document list's arms carry ids.
|
|
||||||
#[derive(Clone, Debug, PartialEq, CultUnion)]
|
|
||||||
pub enum UnitOutcome {
|
|
||||||
#[cultcache(key = 2)]
|
|
||||||
Denied,
|
|
||||||
#[cultcache(key = -2147483648)]
|
|
||||||
Floor,
|
|
||||||
#[cultcache(key = 2147483647)]
|
|
||||||
Ceiling,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, PartialEq, CultSlots)]
|
|
||||||
pub struct PendingArm {
|
|
||||||
#[cultcache(key = 0)]
|
|
||||||
pub message: String,
|
|
||||||
#[cultcache(key = 1)]
|
|
||||||
pub id: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
// An arm with no members of its own: just its element id.
|
|
||||||
#[derive(Clone, Debug, PartialEq, CultSlots)]
|
|
||||||
pub struct IdArm {
|
|
||||||
#[cultcache(key = 0)]
|
|
||||||
pub id: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, PartialEq, CultSlots)]
|
|
||||||
pub struct CompletedArm {
|
|
||||||
#[cultcache(key = 0)]
|
|
||||||
pub source_version: i32,
|
|
||||||
#[cultcache(key = 1)]
|
|
||||||
pub id: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, PartialEq, CultSlots)]
|
|
||||||
pub struct NamedArm {
|
|
||||||
#[cultcache(key = 0)]
|
|
||||||
pub name: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, PartialEq, CultSlots)]
|
|
||||||
pub struct UsesArm {
|
|
||||||
#[cultcache(key = 0)]
|
|
||||||
pub name: String,
|
|
||||||
#[cultcache(key = 1)]
|
|
||||||
pub uses: i32,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, PartialEq, CultSlots)]
|
|
||||||
pub struct CountArm {
|
|
||||||
#[cultcache(key = 0)]
|
|
||||||
pub name: String,
|
|
||||||
#[cultcache(key = 1)]
|
|
||||||
pub count: i32,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, PartialEq, CultUnion)]
|
|
||||||
pub enum Item {
|
|
||||||
#[cultcache(key = 0)]
|
|
||||||
Gem(NamedArm),
|
|
||||||
#[cultcache(key = 1)]
|
|
||||||
Tool(UsesArm),
|
|
||||||
#[cultcache(key = 2)]
|
|
||||||
Part(CountArm),
|
|
||||||
}
|
|
||||||
|
|
||||||
// The same arms as Item under its own keys: key 2 is unknown to it.
|
|
||||||
#[derive(Clone, Debug, PartialEq, CultUnion)]
|
|
||||||
pub enum CraftedItem {
|
|
||||||
#[cultcache(key = 0)]
|
|
||||||
Tool(UsesArm),
|
|
||||||
#[cultcache(key = 1)]
|
|
||||||
Part(CountArm),
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, PartialEq, DatabaseEntry)]
|
|
||||||
#[cultcache(type = "tests.union_surface", schema = "tests.union_surface.v1")]
|
|
||||||
pub struct UnionSurface {
|
|
||||||
#[cultcache(key = 0)]
|
|
||||||
pub id: String,
|
|
||||||
#[cultcache(key = 1)]
|
|
||||||
pub version: i32,
|
|
||||||
#[cultcache(key = 2)]
|
|
||||||
pub root: Option<Node>,
|
|
||||||
#[cultcache(key = 3)]
|
|
||||||
pub outcomes: Vec<Outcome>,
|
|
||||||
#[cultcache(key = 4)]
|
|
||||||
pub part: Option<Item>,
|
|
||||||
#[cultcache(key = 5)]
|
|
||||||
pub crafted: Option<CraftedItem>,
|
|
||||||
#[cultcache(key = 6)]
|
|
||||||
pub missing: Option<Node>,
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn text(id: &str, content: &str) -> Node {
|
|
||||||
Node::Text(TextArm { id: id.into(), content: content.into() })
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn image(id: &str, uri: &str, alt: &str) -> Node {
|
|
||||||
Node::Image(ImageArm { id: id.into(), uri: uri.into(), alt: alt.into() })
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn boxed(id: &str, children: Vec<Node>) -> Node {
|
|
||||||
Node::Box(BoxArm { id: id.into(), children })
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn constructed() -> UnionSurface {
|
|
||||||
let inner = boxed("0000000000d0", vec![text("0000000000d1", "x"), image("0000000000d2", "uri://a", "alt")]);
|
|
||||||
UnionSurface {
|
|
||||||
id: "surface".into(),
|
|
||||||
version: 3,
|
|
||||||
root: Some(boxed(
|
|
||||||
"0000000000c0",
|
|
||||||
vec![
|
|
||||||
text("0000000000c1", "hello"),
|
|
||||||
Node::Use(UseArm {
|
|
||||||
id: "0000000000c2".into(),
|
|
||||||
composition: Composition { name: "comp".into(), body: Some(std::boxed::Box::new(inner)) },
|
|
||||||
slots: vec![Some(text("0000000000e1", "slot")), None, Some(boxed("0000000000e2", vec![]))],
|
|
||||||
}),
|
|
||||||
image("0000000000c3", "uri://b", ""),
|
|
||||||
],
|
|
||||||
)),
|
|
||||||
outcomes: vec![
|
|
||||||
Outcome::Pending(PendingArm { message: "wait".into(), id: "0000000000a1".into() }),
|
|
||||||
Outcome::Completed(CompletedArm { source_version: 7, id: "0000000000a2".into() }),
|
|
||||||
Outcome::Denied(id_arm("0000000000a3")),
|
|
||||||
],
|
|
||||||
part: Some(Item::Tool(UsesArm { name: "hammer".into(), uses: 12 })),
|
|
||||||
crafted: Some(CraftedItem::Part(CountArm { name: "gear".into(), count: 4 })),
|
|
||||||
missing: None,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn id_arm(id: &str) -> IdArm {
|
|
||||||
IdArm { id: id.into() }
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn vector(name: &str) -> Vec<u8> {
|
|
||||||
let path = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
|
|
||||||
.join("../../tests/vectors/union-parity")
|
|
||||||
.join(name);
|
|
||||||
std::fs::read(&path).unwrap_or_else(|error| panic!("{}: {error}", path.display()))
|
|
||||||
}
|
|
||||||
|
|
@ -1,26 +0,0 @@
|
||||||
//! `tests/vectors/content-version`, written only by the C# reference: the content version of a stored record is the lowercase
|
|
||||||
//! hex SHA-256 of its persisted encoding (`variants:ruling:write-set-content-version-declared-ownership`). The store reports
|
|
||||||
//! the version of every record of the committed `store.cc` as `versions.msgpack` says.
|
|
||||||
|
|
||||||
use std::path::PathBuf;
|
|
||||||
|
|
||||||
use cultcache_rs::{CacheBackingStore, SingleFileMessagePackBackingStore};
|
|
||||||
|
|
||||||
fn vectors() -> PathBuf {
|
|
||||||
PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("../../tests/vectors/content-version")
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn read_reports_every_version_the_reference_reads() {
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = dir.path().join("store.cc");
|
|
||||||
std::fs::copy(vectors().join("store.cc"), &path).unwrap();
|
|
||||||
let rows: Vec<(String, String)> = rmp_serde::from_slice(&std::fs::read(vectors().join("versions.msgpack")).unwrap()).unwrap();
|
|
||||||
assert!(rows.len() >= 2);
|
|
||||||
let store = SingleFileMessagePackBackingStore::new(&path);
|
|
||||||
for (key, version) in rows {
|
|
||||||
let record = store.read(&key).unwrap().unwrap_or_else(|| panic!("no record {key}"));
|
|
||||||
assert_eq!(record.version, version, "{key}");
|
|
||||||
}
|
|
||||||
assert_eq!(store.read("absent").unwrap(), None);
|
|
||||||
}
|
|
||||||
|
|
@ -1,9 +1,7 @@
|
||||||
//! The Rust CultCache first call and update from docs/start/README.md. The docs show each region between its
|
//! The Rust CultCache first call from docs/start/README.md. The docs show the region between the
|
||||||
//! `snippet` markers verbatim, and `docs_show_the_tested_snippets` fails when they differ.
|
//! `snippet` markers verbatim, and `docs_show_the_tested_snippet` fails when they differ.
|
||||||
|
|
||||||
use std::path::Path;
|
use cultcache_rs::{CultCache, DatabaseEntry, SingleFileMessagePackBackingStore};
|
||||||
|
|
||||||
use cultcache_rs::{CultCache, CultUpdateResult, DatabaseEntry, SingleFileMessagePackBackingStore};
|
|
||||||
|
|
||||||
// snippet:begin
|
// snippet:begin
|
||||||
#[derive(Clone, Debug, PartialEq, Eq, DatabaseEntry)]
|
#[derive(Clone, Debug, PartialEq, Eq, DatabaseEntry)]
|
||||||
|
|
@ -42,59 +40,17 @@ fn first_call() -> anyhow::Result<()> {
|
||||||
}
|
}
|
||||||
// snippet:end
|
// snippet:end
|
||||||
|
|
||||||
// snippet:update:begin
|
|
||||||
fn restock(path: &Path) -> anyhow::Result<CultUpdateResult<Item>> {
|
|
||||||
let mut cache = CultCache::new();
|
|
||||||
cache.register_entry_type::<Item>()?;
|
|
||||||
cache.add_generic_backing_store(SingleFileMessagePackBackingStore::new(path))?;
|
|
||||||
cache.pull_all_backing_stores()?;
|
|
||||||
cache.update::<Item, _>("item:potion", |item| {
|
|
||||||
// The store's copy of the record, or nothing if it has none; this may run again on a lost race.
|
|
||||||
let mut item = item.unwrap_or(Item {
|
|
||||||
name: "Potion".to_string(),
|
|
||||||
category: "Consumable".to_string(),
|
|
||||||
value: 0,
|
|
||||||
});
|
|
||||||
item.value += 10;
|
|
||||||
Some(item)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
// snippet:update:end
|
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn first_call_round_trips_through_a_second_cache() {
|
fn first_call_round_trips_through_a_second_cache() {
|
||||||
first_call().unwrap();
|
first_call().unwrap();
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn restock_twice_reads_twenty_through_a_second_cache() {
|
fn docs_show_the_tested_snippet() {
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = dir.path().join("restock.cc");
|
|
||||||
assert_eq!(restock(&path).unwrap().outcome, cultcache_rs::CultUpdateOutcome::Updated);
|
|
||||||
let second = restock(&path).unwrap();
|
|
||||||
assert_eq!(second.outcome, cultcache_rs::CultUpdateOutcome::Updated);
|
|
||||||
assert_eq!(second.document.unwrap().value, 20);
|
|
||||||
|
|
||||||
let mut reopened = CultCache::new();
|
|
||||||
reopened.register_entry_type::<Item>().unwrap();
|
|
||||||
reopened.add_generic_backing_store(SingleFileMessagePackBackingStore::new(&path)).unwrap();
|
|
||||||
reopened.pull_all_backing_stores().unwrap();
|
|
||||||
assert_eq!(reopened.get_required::<Item>("item:potion").unwrap().value, 20);
|
|
||||||
}
|
|
||||||
|
|
||||||
/// The docs show the region between `// snippet:<region>begin` and `end` of this file as one fenced block.
|
|
||||||
fn docs_show_region(region: &str) {
|
|
||||||
let source = std::fs::read_to_string(concat!(env!("CARGO_MANIFEST_DIR"), "/tests/first_call.rs")).unwrap();
|
let source = std::fs::read_to_string(concat!(env!("CARGO_MANIFEST_DIR"), "/tests/first_call.rs")).unwrap();
|
||||||
let (begin_marker, end_marker) = (format!("// snippet:{region}begin\n"), format!("// snippet:{region}end\n"));
|
let begin = source.find("// snippet:begin\n").unwrap() + "// snippet:begin\n".len();
|
||||||
let begin = source.find(&begin_marker).unwrap() + begin_marker.len();
|
let end = source.find("// snippet:end\n").unwrap();
|
||||||
let end = source.find(&end_marker).unwrap();
|
|
||||||
let docs = std::fs::read_to_string(concat!(env!("CARGO_MANIFEST_DIR"), "/../../docs/start/README.md")).unwrap();
|
let docs = std::fs::read_to_string(concat!(env!("CARGO_MANIFEST_DIR"), "/../../docs/start/README.md")).unwrap();
|
||||||
let block = format!("```rust\n{}```", &source[begin..end]);
|
let block = format!("```rust\n{}```", &source[begin..end]);
|
||||||
assert!(docs.contains(&block), "docs/start/README.md no longer shows the {region:?} region of tests/first_call.rs verbatim");
|
assert!(docs.contains(&block), "docs/start/README.md no longer shows tests/first_call.rs verbatim");
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn docs_show_the_tested_snippets() {
|
|
||||||
docs_show_region("");
|
|
||||||
docs_show_region("update:");
|
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,165 +0,0 @@
|
||||||
//! A consumer of a single-file store reads the schema version a record was published under from the store's catalog, through the
|
|
||||||
//! public surface only: `pull_all`, `pull_schema_catalog` and `resolve_schema_entry`
|
|
||||||
//! (`cultlib-gaps:follow_up:rs-snapshot-schema-version`).
|
|
||||||
|
|
||||||
use std::path::PathBuf;
|
|
||||||
|
|
||||||
use cultcache_rs::{
|
|
||||||
CacheBackingStore, CultCache, DatabaseEntry, SchemaCatalogEntry, SingleFileMessagePackBackingStore, resolve_schema_entry,
|
|
||||||
};
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, PartialEq, Eq, DatabaseEntry)]
|
|
||||||
#[cultcache(type = "tests.sc_one", schema = "tests.sc_one")]
|
|
||||||
struct One {
|
|
||||||
#[cultcache(key = 0)]
|
|
||||||
text: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, PartialEq, Eq, DatabaseEntry)]
|
|
||||||
#[cultcache(type = "tests.sc_two", schema = "tests.sc_two")]
|
|
||||||
struct Two {
|
|
||||||
#[cultcache(key = 0)]
|
|
||||||
text: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
fn vectors(folder: &str) -> PathBuf {
|
|
||||||
PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("../../tests/vectors").join(folder)
|
|
||||||
}
|
|
||||||
|
|
||||||
/// The version a store publishes for each record, in key order: `(key, schema name, schema version)`.
|
|
||||||
fn versions(store: &SingleFileMessagePackBackingStore) -> Vec<(String, String, String)> {
|
|
||||||
let catalog = store.pull_schema_catalog().unwrap();
|
|
||||||
let mut rows: Vec<_> = store
|
|
||||||
.pull_all()
|
|
||||||
.unwrap()
|
|
||||||
.iter()
|
|
||||||
.map(|envelope| {
|
|
||||||
let id = envelope.schema_id.as_deref().unwrap();
|
|
||||||
let entry = resolve_schema_entry(&catalog, id).unwrap_or_else(|| panic!("no entry for {id}"));
|
|
||||||
(envelope.key.clone(), entry.schema_name.clone(), entry.schema_version.clone())
|
|
||||||
})
|
|
||||||
.collect();
|
|
||||||
rows.sort();
|
|
||||||
rows
|
|
||||||
}
|
|
||||||
|
|
||||||
fn copy(from: PathBuf) -> (tempfile::TempDir, SingleFileMessagePackBackingStore) {
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = dir.path().join("store.cc");
|
|
||||||
std::fs::copy(from, &path).unwrap();
|
|
||||||
(dir, SingleFileMessagePackBackingStore::new(&path))
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn a_consumer_reads_the_version_of_each_type_a_rust_store_holds() {
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = dir.path().join("store.cc");
|
|
||||||
let mut cache = CultCache::new();
|
|
||||||
cache.register_entry_type::<One>().unwrap();
|
|
||||||
cache.register_entry_type::<Two>().unwrap();
|
|
||||||
cache.add_backing_store(SingleFileMessagePackBackingStore::new(&path), ["tests.sc_one", "tests.sc_two"]).unwrap();
|
|
||||||
cache.pull_all_backing_stores().unwrap();
|
|
||||||
cache.put("a", &One { text: "1".into() }).unwrap();
|
|
||||||
cache.put("b", &Two { text: "2".into() }).unwrap();
|
|
||||||
drop(cache);
|
|
||||||
|
|
||||||
let consumer = SingleFileMessagePackBackingStore::new(&path);
|
|
||||||
assert_eq!(
|
|
||||||
versions(&consumer),
|
|
||||||
vec![
|
|
||||||
("a".to_string(), "tests.sc_one".to_string(), "tests.sc_one.v1".to_string()),
|
|
||||||
("b".to_string(), "tests.sc_two".to_string(), "tests.sc_two.v1".to_string()),
|
|
||||||
]
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn an_id_only_an_entry_lists_as_compatible_resolves_to_that_entry() {
|
|
||||||
let (_dir, store) = copy(vectors("document-variants-c2a/readability/compatible-id-only-v3.bin"));
|
|
||||||
let catalog = store.pull_schema_catalog().unwrap();
|
|
||||||
assert_eq!(catalog.len(), 1);
|
|
||||||
assert_eq!(catalog[0].schema_id, "vectors.item.next");
|
|
||||||
assert_eq!(catalog[0].compatible_schema_ids, vec!["vectors.item".to_string()]);
|
|
||||||
let entry = resolve_schema_entry(&catalog, "vectors.item").unwrap();
|
|
||||||
assert_eq!(entry.schema_id, "vectors.item.next");
|
|
||||||
assert_eq!(entry.schema_version, "vectors.item.v1");
|
|
||||||
assert_eq!(resolve_schema_entry(&catalog, "vectors.nowhere"), None);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn an_id_an_entry_owns_resolves_to_its_owner_not_to_an_entry_listing_it() {
|
|
||||||
for vector in ["own-id-over-compatible-v3.bin", "compatible-before-owner-v3.bin"] {
|
|
||||||
let (_dir, store) = copy(vectors("document-variants-c2a/readability").join(vector));
|
|
||||||
let catalog = store.pull_schema_catalog().unwrap();
|
|
||||||
assert_eq!(catalog.len(), 2, "{vector}");
|
|
||||||
let entry = resolve_schema_entry(&catalog, "vectors.item").unwrap();
|
|
||||||
assert_eq!((entry.schema_id.as_str(), entry.schema_version.as_str()), ("vectors.item", "vectors.item.v1"), "{vector}");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn a_legacy_array_and_an_absent_file_publish_no_catalog() {
|
|
||||||
let (_dir, store) = copy(vectors("document-variants-c2a/readability/legacy-envelopes.bin"));
|
|
||||||
assert!(!store.pull_all().unwrap().is_empty());
|
|
||||||
assert_eq!(store.pull_schema_catalog().unwrap(), Vec::<SchemaCatalogEntry>::new());
|
|
||||||
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let absent = SingleFileMessagePackBackingStore::new(dir.path().join("none.cc"));
|
|
||||||
assert_eq!(absent.pull_schema_catalog().unwrap(), Vec::<SchemaCatalogEntry>::new());
|
|
||||||
assert!(!dir.path().join("none.cc").exists() && !dir.path().join("none.cc.lock").exists(), "reading an absent store creates nothing");
|
|
||||||
}
|
|
||||||
|
|
||||||
// `tests/vectors/key-identity/foreign-store.cc` is written by the C# reference: two types, each published with its version.
|
|
||||||
#[test]
|
|
||||||
fn a_store_the_csharp_reference_wrote_gives_its_versions() {
|
|
||||||
let (_dir, store) = copy(vectors("key-identity/foreign-store.cc"));
|
|
||||||
assert_eq!(
|
|
||||||
versions(&store),
|
|
||||||
vec![
|
|
||||||
("j".to_string(), "tests.ki_alpha".to_string(), "tests.ki_alpha.v1".to_string()),
|
|
||||||
("k".to_string(), "tests.ki_gamma".to_string(), "tests.ki_gamma.v1".to_string()),
|
|
||||||
]
|
|
||||||
);
|
|
||||||
let catalog = store.pull_schema_catalog().unwrap();
|
|
||||||
assert_eq!(catalog[0].content_hash, "sha256:02f0c8b7ea07c11705c1365fc29136ada08c8076209cacfb8d5526229461ce7a");
|
|
||||||
}
|
|
||||||
|
|
||||||
type Entry = (&'static str, &'static str, &'static str, &'static str, &'static str, Vec<&'static str>, Vec<()>);
|
|
||||||
|
|
||||||
// A hand-built v3 store whose versions are not the `<name>.v1` the writers above publish, so a version read from anywhere but the
|
|
||||||
// version slot cannot pass. `shared` is listed by two entries (the first lister wins); `id.c` is owned by one entry and listed by
|
|
||||||
// an earlier one (the owner wins).
|
|
||||||
#[test]
|
|
||||||
fn distinct_versions_come_through_with_the_decoders_resolution() {
|
|
||||||
let catalog: Vec<Entry> = vec![
|
|
||||||
("id.a", "N.a", "9.9.9", "hash-a", "{}", vec!["id.a", "shared"], vec![]),
|
|
||||||
("id.b", "N.b", "7.0", "hash-b", "{}", vec!["id.b", "shared", "id.c"], vec![]),
|
|
||||||
("id.c", "N.c", "3", "hash-c", "{}", vec!["id.c"], vec![]),
|
|
||||||
];
|
|
||||||
let record = |key: &str, id: &str| (key.to_string(), id.to_string(), "2026-11-13T00:00:00Z".to_string(), b"x".to_vec());
|
|
||||||
let records = vec![record("r1", "shared"), record("r2", "id.c"), record("r3", "id.b"), record("r4", "id.a")];
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = dir.path().join("store.cc");
|
|
||||||
std::fs::write(&path, rmp_serde::to_vec(&("cultcache.store.v3", catalog, records)).unwrap()).unwrap();
|
|
||||||
|
|
||||||
let store = SingleFileMessagePackBackingStore::new(&path);
|
|
||||||
let listed = store.pull_schema_catalog().unwrap();
|
|
||||||
assert_eq!(listed.iter().map(|e| e.schema_version.as_str()).collect::<Vec<_>>(), vec!["9.9.9", "7.0", "3"]);
|
|
||||||
assert_eq!(listed[1].content_hash, "hash-b");
|
|
||||||
assert_eq!(listed[1].compatible_schema_ids, vec!["id.b", "shared", "id.c"]);
|
|
||||||
let got: Vec<(String, String, String)> = {
|
|
||||||
let mut rows: Vec<_> = store
|
|
||||||
.pull_all()
|
|
||||||
.unwrap()
|
|
||||||
.iter()
|
|
||||||
.map(|e| {
|
|
||||||
let entry = resolve_schema_entry(&listed, e.schema_id.as_deref().unwrap()).unwrap();
|
|
||||||
(e.key.clone(), entry.schema_name.clone(), entry.schema_version.clone())
|
|
||||||
})
|
|
||||||
.collect();
|
|
||||||
rows.sort();
|
|
||||||
rows
|
|
||||||
};
|
|
||||||
let row = |k: &str, n: &str, v: &str| (k.to_string(), n.to_string(), v.to_string());
|
|
||||||
assert_eq!(got, vec![row("r1", "N.a", "9.9.9"), row("r2", "N.c", "3"), row("r3", "N.b", "7.0"), row("r4", "N.a", "9.9.9")]);
|
|
||||||
}
|
|
||||||
|
|
@ -1,541 +0,0 @@
|
||||||
//! A record whose payload carries unread slots at any depth is read-only: the C# reference's union-parity vectors
|
|
||||||
//! (README "Extra trailing slot" and "Slot stores") walked through the cache. This runtime has no compatible schema
|
|
||||||
//! ids, so every mark is unconsented and no `explained` outcome can arise.
|
|
||||||
|
|
||||||
mod common;
|
|
||||||
|
|
||||||
use std::path::Path;
|
|
||||||
|
|
||||||
use common::*;
|
|
||||||
use cultcache_rs::CultCache;
|
|
||||||
use cultcache_rs::CultCacheEnvelope;
|
|
||||||
use cultcache_rs::DatabaseEntry;
|
|
||||||
use cultcache_rs::SchemaConflictError;
|
|
||||||
use cultcache_rs::SingleFileMessagePackBackingStore;
|
|
||||||
use cultcache_rs::UnreadSlots;
|
|
||||||
use cultcache_rs::decode_payload_marked;
|
|
||||||
|
|
||||||
/// A row of `slot-outcomes.msgpack`: store, key, writable, explained, type, slots, declared, occurrences, flattenRefusedBy.
|
|
||||||
type SlotRow = (String, String, bool, Option<bool>, Option<String>, Option<usize>, Option<usize>, Option<usize>, Option<String>);
|
|
||||||
|
|
||||||
const SLOT_VALUE: &str = "extra-slot";
|
|
||||||
|
|
||||||
/// `tests.slot_unit`, a document `[Name, Outcome: UnitOutcome]`.
|
|
||||||
#[derive(Clone, Debug, PartialEq, DatabaseEntry)]
|
|
||||||
#[cultcache(type = "tests.slot_unit", schema = "tests.slot_unit.v1")]
|
|
||||||
struct SlotUnit {
|
|
||||||
#[cultcache(key = 0)]
|
|
||||||
name: String,
|
|
||||||
#[cultcache(key = 1)]
|
|
||||||
outcome: UnitOutcome,
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Two declared slots, the second defaulted: a payload of one slot is short, not marked.
|
|
||||||
#[derive(Clone, Debug, PartialEq, DatabaseEntry)]
|
|
||||||
#[cultcache(type = "tests.shortened", schema = "tests.shortened.v1")]
|
|
||||||
struct Shortened {
|
|
||||||
#[cultcache(key = 0)]
|
|
||||||
id: String,
|
|
||||||
#[cultcache(key = 1, default)]
|
|
||||||
note: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
fn registered() -> CultCache {
|
|
||||||
let mut cache = CultCache::new();
|
|
||||||
cache.register_entry_type::<UnionSurface>().unwrap();
|
|
||||||
cache.register_entry_type::<SlotUnit>().unwrap();
|
|
||||||
cache
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Any MessagePack value a store holds, enough to drop one record from a store and write the rest back.
|
|
||||||
#[derive(serde::Serialize, serde::Deserialize)]
|
|
||||||
#[serde(untagged)]
|
|
||||||
enum Packed {
|
|
||||||
Nil(()),
|
|
||||||
Bool(bool),
|
|
||||||
Int(i64),
|
|
||||||
Text(String),
|
|
||||||
Bin(#[serde(with = "serde_bytes")] Vec<u8>),
|
|
||||||
Array(Vec<Packed>),
|
|
||||||
}
|
|
||||||
|
|
||||||
/// The committed store without its `marked-variant` record. A variant is a five-slot record, which this runtime's
|
|
||||||
/// store reader refuses whole (`the_variant_row_...`), so the other rows are walked from a copy without it.
|
|
||||||
fn without_variant_row(store: &[u8]) -> Vec<u8> {
|
|
||||||
let Packed::Array(mut parts) = rmp_serde::from_slice(store).unwrap() else { panic!("a store is an array") };
|
|
||||||
let Packed::Array(records) = parts.last_mut().unwrap() else { panic!("a store ends in its records") };
|
|
||||||
let before = records.len();
|
|
||||||
records.retain(|record| !matches!(record, Packed::Array(fields) if matches!(fields.first(), Some(Packed::Text(key)) if key == "marked-variant")));
|
|
||||||
assert_eq!(records.len(), before - 1);
|
|
||||||
rmp_serde::to_vec(&parts).unwrap()
|
|
||||||
}
|
|
||||||
|
|
||||||
/// A copy of a committed store, opened with both types registered; the vector itself is never written. The slot store
|
|
||||||
/// is read without its variant row.
|
|
||||||
fn open_copy(file: &str, dir: &Path) -> (CultCache, std::path::PathBuf) {
|
|
||||||
let path = dir.join(file);
|
|
||||||
let bytes = if file == "extra-slot-store.cc" { without_variant_row(&vector(file)) } else { vector(file) };
|
|
||||||
std::fs::write(&path, bytes).unwrap();
|
|
||||||
let mut cache = registered();
|
|
||||||
cache.add_generic_backing_store(SingleFileMessagePackBackingStore::new(&path)).unwrap();
|
|
||||||
cache.pull_all_backing_stores().unwrap();
|
|
||||||
(cache, path)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn envelope(key: &str, payload: Vec<u8>) -> CultCacheEnvelope {
|
|
||||||
CultCacheEnvelope {
|
|
||||||
key: key.into(),
|
|
||||||
r#type: UnionSurface::TYPE.into(),
|
|
||||||
payload,
|
|
||||||
stored_at: "2026-01-01T00:00:00Z".into(),
|
|
||||||
schema_id: None,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn conflict(error: &anyhow::Error) -> &SchemaConflictError {
|
|
||||||
error.downcast_ref::<SchemaConflictError>().unwrap_or_else(|| panic!("not a schema conflict: {error:#}"))
|
|
||||||
}
|
|
||||||
|
|
||||||
fn mark(type_name: &str, slot_count: usize, declared_count: usize, occurrences: usize) -> UnreadSlots {
|
|
||||||
UnreadSlots { type_name: type_name.into(), slot_count, declared_count, occurrences }
|
|
||||||
}
|
|
||||||
|
|
||||||
/// The marks the README table pins, by `detail`. The reference names an arm by its class; here an arm is the
|
|
||||||
/// `...Arm` struct the union wraps.
|
|
||||||
fn expected_mark(detail: &str) -> UnreadSlots {
|
|
||||||
match detail {
|
|
||||||
"record" | "depth" => mark("UnionSurface", 8, 7, 1),
|
|
||||||
"nested-record" => mark("Composition", 3, 2, 1),
|
|
||||||
"arm" => mark("BoxArm", 3, 2, 1),
|
|
||||||
"list-element" => mark("TextArm", 3, 2, 1),
|
|
||||||
other => panic!("unknown detail {other}"),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn assert_refused_with(error: &anyhow::Error, key: &str, expected: &UnreadSlots) {
|
|
||||||
let refusal = conflict(error);
|
|
||||||
assert_eq!(refusal.unread_slots.as_ref(), Some(expected));
|
|
||||||
assert_eq!(refusal.record_key, key);
|
|
||||||
assert_eq!(refusal.schema_names.len(), 1);
|
|
||||||
let message = error.to_string();
|
|
||||||
assert!(message.contains(&expected.type_name), "{message}");
|
|
||||||
assert!(message.contains(&expected.slot_count.to_string()) && message.contains(&expected.declared_count.to_string()), "{message}");
|
|
||||||
assert!(!message.contains(SLOT_VALUE), "a refusal echoed the slot value: {message}");
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn every_read_only_vector_decodes_marked_and_is_not_writable() {
|
|
||||||
let rows: Vec<(String, String, String, Option<i64>, String)> = rmp_serde::from_slice(&vector("outcomes.msgpack")).unwrap();
|
|
||||||
assert_eq!(rows.len(), 9);
|
|
||||||
let bounds: Vec<serde_json::Value> = rmp_serde::from_slice(&vector("bounds-outcomes.msgpack")).unwrap();
|
|
||||||
let mut cases: Vec<(String, String)> = rows
|
|
||||||
.into_iter()
|
|
||||||
.filter(|(_, outcome, ..)| outcome == "read-only")
|
|
||||||
.map(|(file, _, _, _, detail)| (file, detail))
|
|
||||||
.collect();
|
|
||||||
for entry in &bounds[1..] {
|
|
||||||
let fields: Vec<&str> = entry.as_array().unwrap().iter().filter_map(|field| field.as_str()).collect();
|
|
||||||
if fields[1] == "read-only" {
|
|
||||||
cases.push((fields[0].to_string(), fields[3].to_string()));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
assert_eq!(cases.len(), 5);
|
|
||||||
for (file, detail) in cases {
|
|
||||||
let payload = vector(&file);
|
|
||||||
let (value, found) = decode_payload_marked::<UnionSurface>(&payload).unwrap_or_else(|error| panic!("{file}: {error:#}"));
|
|
||||||
assert_eq!(value, constructed(), "{file}");
|
|
||||||
assert_eq!(found, Some(expected_mark(&detail)), "{file}");
|
|
||||||
|
|
||||||
let mut cache = registered();
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
cache.add_generic_backing_store(SingleFileMessagePackBackingStore::new(dir.path().join("s.cc"))).unwrap();
|
|
||||||
cache.pull_all_backing_stores().unwrap();
|
|
||||||
cache.put_raw_envelope(envelope("k", payload.clone())).unwrap();
|
|
||||||
assert_eq!(cache.get::<UnionSurface>("k").unwrap(), Some(constructed()), "{file}");
|
|
||||||
assert!(!cache.is_writable(UnionSurface::TYPE, "k").unwrap(), "{file}");
|
|
||||||
assert!(cache.is_writable(UnionSurface::TYPE, "unheld").unwrap(), "{file}");
|
|
||||||
let error = cache.put("k", &constructed()).unwrap_err();
|
|
||||||
assert_refused_with(&error, "k", &expected_mark(&detail));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn clean_and_short_payloads_are_writable_and_unmarked() {
|
|
||||||
let (value, found) = decode_payload_marked::<UnionSurface>(&vector("union-surface.msgpack")).unwrap();
|
|
||||||
assert_eq!((value, found), (constructed(), None));
|
|
||||||
// A payload short of its declared slots keeps its defaults and does not mark.
|
|
||||||
let (value, found) = decode_payload_marked::<Shortened>(&rmp_serde::to_vec(&("only",)).unwrap()).unwrap();
|
|
||||||
assert_eq!((value.id.as_str(), value.note.as_str(), found), ("only", "", None));
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn a_payload_past_the_nesting_limit_is_refused_never_marked() {
|
|
||||||
for file in ["depth-skipped-past-limit.msgpack", "depth-past-limit.msgpack"] {
|
|
||||||
let error = decode_payload_marked::<UnionSurface>(&vector(file)).unwrap_err();
|
|
||||||
assert!(error.to_string().contains("the limit is 256"), "{file}: {error:#}");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn a_plain_serde_decode_marks_nothing_and_does_not_leak_a_scope() {
|
|
||||||
// No scope is open: the visitors note into nothing.
|
|
||||||
let value: UnionSurface = rmp_serde::from_slice(&vector("extra-slot-record.msgpack")).unwrap();
|
|
||||||
assert_eq!(value, constructed());
|
|
||||||
// A marked decode followed by a clean one: the first mark does not survive into the second.
|
|
||||||
assert!(decode_payload_marked::<UnionSurface>(&vector("extra-slot-record.msgpack")).unwrap().1.is_some());
|
|
||||||
assert_eq!(decode_payload_marked::<UnionSurface>(&vector("union-surface.msgpack")).unwrap().1, None);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn the_slot_store_rows_walk_through_the_cache() {
|
|
||||||
let rows: Vec<SlotRow> =
|
|
||||||
rmp_serde::from_slice(&vector("slot-outcomes.msgpack")).unwrap();
|
|
||||||
assert_eq!(rows.len(), 8);
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let mut walked = 0;
|
|
||||||
for (store, key, writable, _explained, type_name, slots, declared, occurrences, flatten_refused_by) in rows {
|
|
||||||
// The variant row is a record this runtime cannot hold: see the variant test. The consent store's `writable` and
|
|
||||||
// `explained` answer the compatible-id declaration, which this runtime has none of; its marks are walked below.
|
|
||||||
if flatten_refused_by.is_some() || store == "extra-slot-consent.cc" {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
let case = dir.path().join(&key);
|
|
||||||
std::fs::create_dir_all(&case).unwrap();
|
|
||||||
let (mut cache, _) = open_copy(&store, &case);
|
|
||||||
let type_id = if key == "unit-arm" { SlotUnit::TYPE } else { UnionSurface::TYPE };
|
|
||||||
assert_eq!(cache.is_writable(type_id, &key).unwrap(), writable, "{store} {key}");
|
|
||||||
let removal = if key == "unit-arm" { cache.delete::<SlotUnit>(&key) } else { cache.delete::<UnionSurface>(&key) };
|
|
||||||
match writable {
|
|
||||||
true => assert!(removal.unwrap()),
|
|
||||||
false => {
|
|
||||||
let found = conflict(&removal.unwrap_err()).unread_slots.clone().unwrap();
|
|
||||||
// The reference names the unit arm's class, Denied2; here the variant.
|
|
||||||
let expected_type = match type_name.as_deref().unwrap() {
|
|
||||||
"Denied2" => "Denied",
|
|
||||||
other => other,
|
|
||||||
};
|
|
||||||
assert_eq!((found.type_name.as_str(), Some(found.slot_count), Some(found.declared_count), Some(found.occurrences)), (expected_type, slots, declared, occurrences));
|
|
||||||
assert!(cache.snapshot_envelopes().iter().any(|held| held.key == key), "a refused removal removed {key}");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
walked += 1;
|
|
||||||
}
|
|
||||||
assert_eq!(walked, 3);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn the_consent_store_marks_are_unconsented_here() {
|
|
||||||
let rows: Vec<SlotRow> =
|
|
||||||
rmp_serde::from_slice(&vector("slot-outcomes.msgpack")).unwrap();
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let mut found = 0;
|
|
||||||
for (store, key, _writable, _explained, _type_name, slots, declared, occurrences, _) in rows {
|
|
||||||
if store != "extra-slot-consent.cc" {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
let (cache, _) = open_copy(&store, dir.path());
|
|
||||||
let held = cache.snapshot_envelopes().into_iter().find(|held| held.key == key).unwrap();
|
|
||||||
let (_, mark) = decode_payload_marked::<UnionSurface>(&held.payload).unwrap();
|
|
||||||
match slots {
|
|
||||||
// The reference's `consented` row is writable there (a listed compatible id covers it); here every mark refuses.
|
|
||||||
None => assert_eq!(mark, None, "{key}"),
|
|
||||||
Some(slots) => {
|
|
||||||
let mark = mark.unwrap_or_else(|| panic!("{key} carried no mark"));
|
|
||||||
// The first type read is the document, whose reference name is SurfaceDeclaring.
|
|
||||||
assert_eq!(mark.type_name, "UnionSurface", "{key}");
|
|
||||||
assert_eq!((Some(mark.slot_count), Some(mark.declared_count), Some(mark.occurrences)), (Some(slots), declared, occurrences), "{key}");
|
|
||||||
assert!(!cache.is_writable(UnionSurface::TYPE, &key).unwrap(), "{key}");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
found += 1;
|
|
||||||
}
|
|
||||||
assert_eq!(found, 4);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn every_write_entry_refuses_a_marked_key_before_any_store_is_touched() {
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let (mut cache, path) = open_copy("extra-slot-store.cc", dir.path());
|
|
||||||
let expected = mark("Composition", 3, 2, 1);
|
|
||||||
let before = std::fs::read(&path).unwrap();
|
|
||||||
let held = cache.snapshot_envelopes().into_iter().find(|held| held.key == "marked").unwrap();
|
|
||||||
let clean = cache.snapshot_envelopes().into_iter().find(|held| held.key == "clean").unwrap();
|
|
||||||
assert!(!cache.is_writable(UnionSurface::TYPE, "marked").unwrap());
|
|
||||||
assert!(cache.is_writable(UnionSurface::TYPE, "clean").unwrap());
|
|
||||||
|
|
||||||
let replacing = envelope("marked", rmp_serde::to_vec(&constructed()).unwrap());
|
|
||||||
assert_refused_with(&cache.put("marked", &constructed()).unwrap_err(), "marked", &expected);
|
|
||||||
assert_refused_with(&cache.put_envelope::<UnionSurface>(replacing.clone()).unwrap_err(), "marked", &expected);
|
|
||||||
assert_refused_with(&cache.put_raw_envelope(replacing.clone()).unwrap_err(), "marked", &expected);
|
|
||||||
assert_refused_with(&cache.put_prepared_batch(vec![replacing]).unwrap_err(), "marked", &expected);
|
|
||||||
assert_refused_with(&cache.delete::<UnionSurface>("marked").unwrap_err(), "marked", &expected);
|
|
||||||
assert_refused_with(
|
|
||||||
&cache.update::<UnionSurface, _>("marked", |current| current).unwrap_err(),
|
|
||||||
"marked",
|
|
||||||
&expected,
|
|
||||||
);
|
|
||||||
|
|
||||||
// A batch with a marked key refuses whole: its clean member is not written either.
|
|
||||||
let mut rewritten = clean.clone();
|
|
||||||
rewritten.payload = rmp_serde::to_vec(&UnionSurface { version: 9, ..constructed() }).unwrap();
|
|
||||||
let batch = vec![rewritten, envelope("marked", rmp_serde::to_vec(&constructed()).unwrap())];
|
|
||||||
assert_refused_with(&cache.put_prepared_batch(batch).unwrap_err(), "marked", &expected);
|
|
||||||
|
|
||||||
assert_eq!(std::fs::read(&path).unwrap(), before, "a refused write touched the store");
|
|
||||||
assert_eq!(cache.snapshot_envelopes().into_iter().find(|entry| entry.key == "marked").unwrap(), held);
|
|
||||||
assert_eq!(cache.snapshot_envelopes().into_iter().find(|entry| entry.key == "clean").unwrap(), clean);
|
|
||||||
|
|
||||||
// A write to another key succeeds, and the marked record's bytes, schema id and stored-at are carried unchanged.
|
|
||||||
cache.put("clean", &UnionSurface { version: 9, ..constructed() }).unwrap();
|
|
||||||
cache.put("other", &constructed()).unwrap();
|
|
||||||
assert!(cache.delete::<UnionSurface>("other").unwrap());
|
|
||||||
let mut reopened = registered();
|
|
||||||
reopened.add_generic_backing_store(SingleFileMessagePackBackingStore::new(&path)).unwrap();
|
|
||||||
reopened.pull_all_backing_stores().unwrap();
|
|
||||||
let carried = reopened.snapshot_envelopes().into_iter().find(|entry| entry.key == "marked").unwrap();
|
|
||||||
assert_eq!(carried, held);
|
|
||||||
assert_eq!(carried.payload, vector("extra-slot-nested-record.msgpack"));
|
|
||||||
assert_eq!(reopened.get::<UnionSurface>("clean").unwrap().unwrap().version, 9);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn a_unit_arm_with_slots_decodes_as_the_unit_arm_and_marks() {
|
|
||||||
let (document, found) = decode_payload_marked::<SlotUnit>(&unit_arm_payload()).unwrap();
|
|
||||||
assert_eq!(document, SlotUnit { name: "unit-arm".into(), outcome: UnitOutcome::Denied });
|
|
||||||
assert_eq!(found, Some(mark("Denied", 1, 0, 1)));
|
|
||||||
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let (mut cache, _) = open_copy("extra-slot-store.cc", dir.path());
|
|
||||||
assert_eq!(cache.get::<SlotUnit>("unit-arm").unwrap(), Some(document.clone()));
|
|
||||||
assert!(!cache.is_writable(SlotUnit::TYPE, "unit-arm").unwrap());
|
|
||||||
let error = cache.put("unit-arm", &document).unwrap_err();
|
|
||||||
assert_refused_with(&error, "unit-arm", &mark("Denied", 1, 0, 1));
|
|
||||||
assert_refused_with(&cache.delete::<SlotUnit>("unit-arm").unwrap_err(), "unit-arm", &mark("Denied", 1, 0, 1));
|
|
||||||
|
|
||||||
// Several elements are still one marked object, and a clean unit arm is unmarked.
|
|
||||||
let (_, found) = decode_payload_marked::<UnitOutcome>(&rmp_serde::to_vec(&(2u64, ("a", "b", "c"))).unwrap()).unwrap();
|
|
||||||
assert_eq!(found, Some(mark("Denied", 3, 0, 1)));
|
|
||||||
let (_, found) = decode_payload_marked::<UnitOutcome>(&vector("unit-arm-denied.msgpack")).unwrap();
|
|
||||||
assert_eq!(found, None);
|
|
||||||
}
|
|
||||||
|
|
||||||
fn unit_arm_payload() -> Vec<u8> {
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let (cache, _) = open_copy("extra-slot-store.cc", dir.path());
|
|
||||||
cache.snapshot_envelopes().into_iter().find(|held| held.key == "unit-arm").unwrap().payload
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn the_variant_row_of_the_slot_store_is_refused_whole_by_the_store_reader() {
|
|
||||||
// `marked-variant` is a five-slot record (a variant): this runtime holds no variants, and its v1 snapshot reader
|
|
||||||
// refuses such a record, so the store as written cannot load here and the other rows are walked without it.
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = dir.path().join("extra-slot-store.cc");
|
|
||||||
std::fs::write(&path, vector("extra-slot-store.cc")).unwrap();
|
|
||||||
let mut cache = registered();
|
|
||||||
cache.add_generic_backing_store(SingleFileMessagePackBackingStore::new(&path)).unwrap();
|
|
||||||
let error = cache.pull_all_backing_stores().unwrap_err();
|
|
||||||
assert!(format!("{error:#}").contains("is not decodable"), "{error:#}");
|
|
||||||
}
|
|
||||||
|
|
||||||
fn slot_unit_envelope(key: &str, payload: Vec<u8>) -> CultCacheEnvelope {
|
|
||||||
CultCacheEnvelope { r#type: SlotUnit::TYPE.into(), ..envelope(key, payload) }
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn a_held_payload_the_type_cannot_read_is_read_only_and_refused_by_name() {
|
|
||||||
let mut cache = registered();
|
|
||||||
// A newer writer's record: an arm this build lacks and an extra root slot. get cannot read it, and it is the data
|
|
||||||
// read-only exists to protect.
|
|
||||||
let newer = rmp_serde::to_vec(&("CANARY-name", (99u64, ("x",)), "CANARY-extra")).unwrap();
|
|
||||||
cache.put_raw_envelope(slot_unit_envelope("n", newer)).unwrap();
|
|
||||||
assert!(cache.get::<SlotUnit>("n").is_err());
|
|
||||||
assert!(!cache.is_writable(SlotUnit::TYPE, "n").unwrap());
|
|
||||||
let replacement = SlotUnit { name: "n".into(), outcome: UnitOutcome::Denied };
|
|
||||||
let held = cache.snapshot_envelopes();
|
|
||||||
for error in [
|
|
||||||
cache.put("n", &replacement).unwrap_err(),
|
|
||||||
cache.put_raw_envelope(slot_unit_envelope("n", rmp_serde::to_vec(&replacement).unwrap())).unwrap_err(),
|
|
||||||
cache.delete::<SlotUnit>("n").unwrap_err(),
|
|
||||||
] {
|
|
||||||
let message = format!("{error:#}");
|
|
||||||
assert!(message.contains("\"n\"") && message.contains("tests.slot_unit") && message.contains("read-only"), "{message}");
|
|
||||||
assert!(!message.contains("CANARY"), "{message}");
|
|
||||||
}
|
|
||||||
assert_eq!(cache.snapshot_envelopes(), held);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn a_corrupt_held_payload_is_refused_naming_the_key_never_its_bytes() {
|
|
||||||
let mut cache = registered();
|
|
||||||
cache.put_raw_envelope(envelope("broken", rmp_serde::to_vec(&("CANARY-id", "CANARY-version")).unwrap())).unwrap();
|
|
||||||
assert!(!cache.is_writable(UnionSurface::TYPE, "broken").unwrap());
|
|
||||||
let error = cache.delete::<UnionSurface>("broken").unwrap_err();
|
|
||||||
let message = format!("{error:#}");
|
|
||||||
assert!(message.contains("\"broken\"") && message.contains("backup") && message.contains("store"), "{message}");
|
|
||||||
assert!(!message.contains("build that wrote it"), "{message}");
|
|
||||||
assert!(!message.contains("CANARY"), "{message}");
|
|
||||||
assert!(cache.is_writable("tests.unregistered", "broken").is_err());
|
|
||||||
}
|
|
||||||
|
|
||||||
fn held_marked_and_clean() -> (CultCache, tempfile::TempDir, std::path::PathBuf) {
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let (cache, path) = open_copy("extra-slot-store.cc", dir.path());
|
|
||||||
(cache, dir, path)
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn load_soa_does_not_replace_or_drop_a_marked_record() {
|
|
||||||
use cultcache_rs::CultCacheSoaTable;
|
|
||||||
let (mut cache, _dir, path) = held_marked_and_clean();
|
|
||||||
let all = cache.snapshot_envelopes();
|
|
||||||
let held = all.iter().find(|held| held.key == "marked").unwrap().clone();
|
|
||||||
let without: Vec<_> = all.iter().filter(|held| held.key != "marked").cloned().collect();
|
|
||||||
let mut replaced = all.clone();
|
|
||||||
replaced.iter_mut().find(|held| held.key == "marked").unwrap().payload = rmp_serde::to_vec(&constructed()).unwrap();
|
|
||||||
for table in [without, replaced] {
|
|
||||||
let error = cache.load_soa(CultCacheSoaTable::from_envelopes(table)).unwrap_err();
|
|
||||||
assert_refused_with(&error, "marked", &mark("Composition", 3, 2, 1));
|
|
||||||
assert_eq!(cache.snapshot_envelopes(), all, "a refused load changed the image");
|
|
||||||
}
|
|
||||||
// The same record carried unchanged, with another key added, loads.
|
|
||||||
let mut kept = all.clone();
|
|
||||||
kept.push(envelope("added", rmp_serde::to_vec(&constructed()).unwrap()));
|
|
||||||
cache.load_soa(CultCacheSoaTable::from_envelopes(kept)).unwrap();
|
|
||||||
assert_eq!(cache.snapshot_envelopes().iter().find(|held| held.key == "marked"), Some(&held));
|
|
||||||
// A clean record may be dropped by a load.
|
|
||||||
let no_clean: Vec<_> = cache.snapshot_envelopes().into_iter().filter(|held| held.key != "clean").collect();
|
|
||||||
cache.load_soa(CultCacheSoaTable::from_envelopes(no_clean)).unwrap();
|
|
||||||
// The marked record is still on disk after the next batch.
|
|
||||||
let rewrite = envelope("added", rmp_serde::to_vec(&UnionSurface { version: 5, ..constructed() }).unwrap());
|
|
||||||
cache.put_prepared_batch(vec![rewrite]).unwrap();
|
|
||||||
let mut reopened = registered();
|
|
||||||
reopened.add_generic_backing_store(SingleFileMessagePackBackingStore::new(&path)).unwrap();
|
|
||||||
reopened.pull_all_backing_stores().unwrap();
|
|
||||||
assert_eq!(reopened.snapshot_envelopes().iter().find(|held| held.key == "marked"), Some(&held));
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn is_writable_agrees_with_the_writes_for_foreign_keys_and_other_types() {
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
// Only UnionSurface registered: the store's unit-arm record is foreign here.
|
|
||||||
let path = dir.path().join("extra-slot-store.cc");
|
|
||||||
std::fs::write(&path, without_variant_row(&vector("extra-slot-store.cc"))).unwrap();
|
|
||||||
let mut cache = CultCache::new();
|
|
||||||
cache.register_entry_type::<UnionSurface>().unwrap();
|
|
||||||
cache.add_generic_backing_store(SingleFileMessagePackBackingStore::new(&path)).unwrap();
|
|
||||||
cache.pull_all_backing_stores().unwrap();
|
|
||||||
assert!(cache.put("unit-arm", &constructed()).is_err());
|
|
||||||
assert!(!cache.is_writable(UnionSurface::TYPE, "unit-arm").unwrap());
|
|
||||||
assert!(cache.is_writable(UnionSurface::TYPE, "unheld").unwrap());
|
|
||||||
|
|
||||||
// Another registered type at a key a record of this one holds.
|
|
||||||
let (mut cache, _dir, _) = held_marked_and_clean();
|
|
||||||
let other = SlotUnit { name: "clean".into(), outcome: UnitOutcome::Denied };
|
|
||||||
assert!(cache.put("clean", &other).is_err());
|
|
||||||
assert!(!cache.is_writable(SlotUnit::TYPE, "clean").unwrap());
|
|
||||||
assert!(!cache.is_writable(SlotUnit::TYPE, "marked").unwrap());
|
|
||||||
assert!(cache.is_writable(UnionSurface::TYPE, "clean").unwrap());
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn a_marked_key_refuses_a_batch_wherever_it_sits() {
|
|
||||||
let (mut cache, _dir, path) = held_marked_and_clean();
|
|
||||||
let before = std::fs::read(&path).unwrap();
|
|
||||||
let marked = envelope("marked", rmp_serde::to_vec(&constructed()).unwrap());
|
|
||||||
let clean = |key: &str| envelope(key, rmp_serde::to_vec(&constructed()).unwrap());
|
|
||||||
for batch in [
|
|
||||||
vec![marked.clone(), clean("a"), clean("b")],
|
|
||||||
vec![clean("a"), marked.clone(), clean("b")],
|
|
||||||
vec![clean("a"), clean("b"), marked.clone()],
|
|
||||||
] {
|
|
||||||
let error = cache.put_prepared_batch(batch).unwrap_err();
|
|
||||||
assert_refused_with(&error, "marked", &mark("Composition", 3, 2, 1));
|
|
||||||
assert_eq!(std::fs::read(&path).unwrap(), before);
|
|
||||||
assert!(cache.snapshot_envelopes().iter().all(|held| held.key != "a" && held.key != "b"));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn a_marked_decode_leaves_no_scope_open() {
|
|
||||||
assert_eq!(cultcache_rs::__enter_slots(), 0);
|
|
||||||
decode_payload_marked::<UnionSurface>(&vector("extra-slot-record.msgpack")).unwrap();
|
|
||||||
assert_eq!(cultcache_rs::__enter_slots(), 0, "a marked decode left its scope open on this thread");
|
|
||||||
let _ = decode_payload_marked::<UnionSurface>(&vector("depth-skipped-past-limit.msgpack"));
|
|
||||||
assert_eq!(cultcache_rs::__enter_slots(), 0);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn is_writable_is_false_for_a_type_with_no_home_store() {
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let mut cache = registered();
|
|
||||||
// One store, routed to SlotUnit only: UnionSurface has no home.
|
|
||||||
cache.add_backing_store(SingleFileMessagePackBackingStore::new(dir.path().join("s.cc")), [SlotUnit::TYPE]).unwrap();
|
|
||||||
cache.pull_all_backing_stores().unwrap();
|
|
||||||
assert!(cache.put("k", &constructed()).is_err());
|
|
||||||
assert!(!cache.is_writable(UnionSurface::TYPE, "k").unwrap());
|
|
||||||
assert!(cache.is_writable(SlotUnit::TYPE, "k").unwrap());
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn load_soa_refuses_a_same_length_replacement_of_a_marked_record() {
|
|
||||||
use cultcache_rs::CultCacheSoaTable;
|
|
||||||
let (mut cache, _dir, _) = held_marked_and_clean();
|
|
||||||
let all = cache.snapshot_envelopes();
|
|
||||||
let marked = all.iter().find(|held| held.key == "marked").unwrap();
|
|
||||||
// One value (a bin16) of the marked record's length: same length, different bytes. A value followed by padding
|
|
||||||
// would be refused at admission as bytes after the value, before the read-only check is reached.
|
|
||||||
let length = marked.payload.len();
|
|
||||||
let mut same_length = vec![0u8; length];
|
|
||||||
same_length[..3].copy_from_slice(&[0xc5, ((length - 3) >> 8) as u8, (length - 3) as u8]);
|
|
||||||
assert_eq!(same_length.len(), marked.payload.len());
|
|
||||||
let mut replaced = all.clone();
|
|
||||||
replaced.iter_mut().find(|held| held.key == "marked").unwrap().payload = same_length;
|
|
||||||
let error = cache.load_soa(CultCacheSoaTable::from_envelopes(replaced)).unwrap_err();
|
|
||||||
assert_refused_with(&error, "marked", &mark("Composition", 3, 2, 1));
|
|
||||||
assert_eq!(cache.snapshot_envelopes(), all);
|
|
||||||
}
|
|
||||||
|
|
||||||
// The payload check runs before the mark scope opens: a tail on a slot-bearing payload is refused by count, never marked.
|
|
||||||
#[test]
|
|
||||||
fn a_tail_on_a_slot_payload_is_refused_before_any_mark() {
|
|
||||||
let mut tailed = vector("extra-slot-record.msgpack");
|
|
||||||
tailed.push(0xc0);
|
|
||||||
let error = decode_payload_marked::<UnionSurface>(&tailed).unwrap_err();
|
|
||||||
assert!(format!("{error:#}").contains("payload has 1 bytes after its first MessagePack value"), "{error:#}");
|
|
||||||
// Nothing leaked: the next marked decode finds exactly its own mark.
|
|
||||||
let found = decode_payload_marked::<UnionSurface>(&vector("extra-slot-record.msgpack")).unwrap().1.unwrap();
|
|
||||||
assert_eq!(found.occurrences, 1);
|
|
||||||
}
|
|
||||||
|
|
||||||
// A store holding marked records and one with a tail is refused at load; the cache then refuses every write with the load
|
|
||||||
// refusal (not a per-key mark conflict), and the store file is untouched.
|
|
||||||
#[test]
|
|
||||||
fn a_store_with_marked_records_and_a_tail_is_refused_and_its_cache_writes_nothing() {
|
|
||||||
use cultcache_rs::CacheBackingStore;
|
|
||||||
use cultcache_rs::CultCacheLoadRefused;
|
|
||||||
let (mut held, _dir, path) = held_marked_and_clean();
|
|
||||||
let mut tailed = vector("union-surface.msgpack");
|
|
||||||
tailed.push(0xc0);
|
|
||||||
SingleFileMessagePackBackingStore::new(&path).push(&envelope("tailed", tailed)).unwrap();
|
|
||||||
let before = std::fs::read(&path).unwrap();
|
|
||||||
// The cache that held the store re-reads it and is refused.
|
|
||||||
assert!(format!("{:#}", held.pull_all_backing_stores().unwrap_err()).contains("bytes after"));
|
|
||||||
let fresh_value = constructed();
|
|
||||||
let mut fresh = registered();
|
|
||||||
fresh.add_generic_backing_store(SingleFileMessagePackBackingStore::new(&path)).unwrap();
|
|
||||||
assert!(fresh.pull_all_backing_stores().is_err());
|
|
||||||
for cache in [&mut held, &mut fresh] {
|
|
||||||
let staged = cache.prepare_entry("new", &fresh_value).unwrap().0;
|
|
||||||
let errors = [
|
|
||||||
cache.put("new", &fresh_value).unwrap_err(),
|
|
||||||
cache.put_prepared_batch(vec![staged.clone()]).unwrap_err(),
|
|
||||||
cache.put_raw_envelope(staged).unwrap_err(),
|
|
||||||
cache.delete::<UnionSurface>("new").unwrap_err(),
|
|
||||||
];
|
|
||||||
for error in errors {
|
|
||||||
assert!(error.downcast_ref::<CultCacheLoadRefused>().is_some(), "{error:#}");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
assert_eq!(std::fs::read(&path).unwrap(), before);
|
|
||||||
}
|
|
||||||
|
|
@ -1,58 +0,0 @@
|
||||||
//! `tests/vectors/stored-at-stamp`: the one shape a peer's `storedAt` must parse as. Every row is walked against
|
|
||||||
//! `is_stored_at_stamp`, and each row that is no stamp against the cache's two raw doors, `put_raw_envelope` and
|
|
||||||
//! `put_prepared_batch`: refused, nothing stored or minted, the store still writable after
|
|
||||||
//! (`variants:ruling:raw-put-without-stamp-refused`).
|
|
||||||
|
|
||||||
use std::path::PathBuf;
|
|
||||||
|
|
||||||
use cultcache_rs::{CacheBackingStore, CultCache, DatabaseEntry, SingleFileMessagePackBackingStore, is_stored_at_stamp};
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, PartialEq, Eq, DatabaseEntry)]
|
|
||||||
#[cultcache(type = "tests.stamp_note", schema = "tests.stamp_note")]
|
|
||||||
struct Note {
|
|
||||||
#[cultcache(key = 0)]
|
|
||||||
text: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
fn rows() -> Vec<(String, bool)> {
|
|
||||||
let path = PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("../../tests/vectors/stored-at-stamp/stamps.msgpack");
|
|
||||||
rmp_serde::from_slice(&std::fs::read(path).unwrap()).unwrap()
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn the_stamp_check_agrees_with_every_vector_row() {
|
|
||||||
let rows = rows();
|
|
||||||
assert!(rows.len() > 30, "the vector was not read");
|
|
||||||
for (text, parses) in rows {
|
|
||||||
assert_eq!(is_stored_at_stamp(&text), parses, "{text:?}");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn a_raw_envelope_that_is_no_stamp_is_refused_and_nothing_is_stored() {
|
|
||||||
let directory = tempfile::tempdir().unwrap();
|
|
||||||
let path = directory.path().join("stamps.cc");
|
|
||||||
let mut cache = CultCache::new();
|
|
||||||
cache.register_entry_type::<Note>().unwrap();
|
|
||||||
cache.add_generic_backing_store(SingleFileMessagePackBackingStore::new(&path)).unwrap();
|
|
||||||
cache.pull_all_backing_stores().unwrap();
|
|
||||||
for (text, parses) in rows() {
|
|
||||||
if parses {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
let (mut entry, _) = cache.prepare_entry("a", &Note { text: "peer".into() }).unwrap();
|
|
||||||
entry.stored_at = text.clone();
|
|
||||||
let error = cache.put_raw_envelope(entry.clone()).unwrap_err();
|
|
||||||
assert!(format!("{error:#}").contains("stored_at"), "{text:?}: {error:#}");
|
|
||||||
let error = cache.put_prepared_batch(vec![entry]).unwrap_err();
|
|
||||||
assert!(format!("{error:#}").contains("stored_at"), "{text:?}: {error:#}");
|
|
||||||
assert!(cache.get::<Note>("a").unwrap().is_none(), "{text:?} was stored");
|
|
||||||
assert!(!path.exists() || SingleFileMessagePackBackingStore::new(&path).pull_all().unwrap().is_empty(), "{text:?} reached the file");
|
|
||||||
}
|
|
||||||
// Refused writes left the store writable: a stamped one lands under the stamp it carries.
|
|
||||||
let (mut entry, _) = cache.prepare_entry("b", &Note { text: "stamped".into() }).unwrap();
|
|
||||||
entry.stored_at = "2026-11-07T00:00:00Z".into();
|
|
||||||
cache.put_raw_envelope(entry).unwrap();
|
|
||||||
assert_eq!(cache.get::<Note>("b").unwrap().unwrap().text, "stamped");
|
|
||||||
assert!(cache.get::<Note>("a").unwrap().is_none());
|
|
||||||
}
|
|
||||||
|
|
@ -1,21 +1,244 @@
|
||||||
//! The Rust runtime held to tests/vectors/union-parity, written by the C# reference.
|
//! The Rust runtime held to tests/vectors/union-parity, written by the C# reference.
|
||||||
//! Bytes and outcomes are read from the committed files; only the constructed value is spelled here.
|
//! Bytes and outcomes are read from the committed files; only the constructed value is spelled here.
|
||||||
|
|
||||||
|
use std::path::PathBuf;
|
||||||
|
|
||||||
use cultcache_rs::CultCache;
|
use cultcache_rs::CultCache;
|
||||||
use cultcache_rs::CacheBackingStore;
|
use cultcache_rs::CacheBackingStore;
|
||||||
use cultcache_rs::CultCacheEnvelope;
|
use cultcache_rs::CultCacheEnvelope;
|
||||||
use cultcache_rs::CultCacheLoadRefused;
|
|
||||||
use cultcache_rs::CultCacheSoaTable;
|
|
||||||
use cultcache_rs::MAX_PAYLOAD_DEPTH;
|
use cultcache_rs::MAX_PAYLOAD_DEPTH;
|
||||||
use cultcache_rs::PayloadTooDeep;
|
use cultcache_rs::PayloadTooDeep;
|
||||||
use cultcache_rs::check_payload_depth;
|
use cultcache_rs::check_payload_depth;
|
||||||
use cultcache_rs::decode_payload;
|
use cultcache_rs::CultSlots;
|
||||||
use cultcache_rs::RedbMessagePackBackingStore;
|
use cultcache_rs::CultUnion;
|
||||||
use cultcache_rs::DatabaseEntry;
|
use cultcache_rs::DatabaseEntry;
|
||||||
use cultcache_rs::SingleFileMessagePackBackingStore;
|
use cultcache_rs::SingleFileMessagePackBackingStore;
|
||||||
|
|
||||||
mod common;
|
#[derive(Clone, Debug, PartialEq, CultUnion)]
|
||||||
use common::*;
|
enum Node {
|
||||||
|
#[cultcache(key = 0)]
|
||||||
|
Box(BoxArm),
|
||||||
|
#[cultcache(key = 1)]
|
||||||
|
Text(TextArm),
|
||||||
|
#[cultcache(key = 2)]
|
||||||
|
Use(UseArm),
|
||||||
|
#[cultcache(key = 5)]
|
||||||
|
Image(ImageArm),
|
||||||
|
#[cultcache(key = 6)]
|
||||||
|
Wrap(WrapArm),
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Debug, PartialEq, CultSlots)]
|
||||||
|
struct WrapArm {
|
||||||
|
#[cultcache(key = 0)]
|
||||||
|
inner: Option<std::boxed::Box<Node>>,
|
||||||
|
#[cultcache(key = 1)]
|
||||||
|
id: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Debug, PartialEq, CultSlots)]
|
||||||
|
struct BoxArm {
|
||||||
|
#[cultcache(key = 0)]
|
||||||
|
id: String,
|
||||||
|
#[cultcache(key = 1)]
|
||||||
|
children: Vec<Node>,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Debug, PartialEq, CultSlots)]
|
||||||
|
struct TextArm {
|
||||||
|
#[cultcache(key = 0)]
|
||||||
|
id: String,
|
||||||
|
#[cultcache(key = 1)]
|
||||||
|
content: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Debug, PartialEq, CultSlots)]
|
||||||
|
struct UseArm {
|
||||||
|
#[cultcache(key = 0)]
|
||||||
|
id: String,
|
||||||
|
#[cultcache(key = 1)]
|
||||||
|
composition: Composition,
|
||||||
|
#[cultcache(key = 2)]
|
||||||
|
slots: Vec<Option<Node>>,
|
||||||
|
}
|
||||||
|
|
||||||
|
// Slot 2 is retired: a gap written nil.
|
||||||
|
#[derive(Clone, Debug, PartialEq, CultSlots)]
|
||||||
|
struct ImageArm {
|
||||||
|
#[cultcache(key = 0)]
|
||||||
|
id: String,
|
||||||
|
#[cultcache(key = 1)]
|
||||||
|
uri: String,
|
||||||
|
#[cultcache(key = 3)]
|
||||||
|
alt: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Debug, PartialEq, CultSlots)]
|
||||||
|
struct Composition {
|
||||||
|
#[cultcache(key = 0)]
|
||||||
|
name: String,
|
||||||
|
#[cultcache(key = 1)]
|
||||||
|
body: Option<std::boxed::Box<Node>>,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Debug, PartialEq, CultUnion)]
|
||||||
|
enum Outcome {
|
||||||
|
#[cultcache(key = 0)]
|
||||||
|
Pending(PendingArm),
|
||||||
|
#[cultcache(key = 1)]
|
||||||
|
Completed(CompletedArm),
|
||||||
|
#[cultcache(key = 2)]
|
||||||
|
Denied(IdArm),
|
||||||
|
#[cultcache(key = -2147483648)]
|
||||||
|
Floor(IdArm),
|
||||||
|
#[cultcache(key = 2147483647)]
|
||||||
|
Ceiling(IdArm),
|
||||||
|
}
|
||||||
|
|
||||||
|
// The codec's unit arm (no members, written [key, []]), kept apart from the golden: a document list's arms carry ids.
|
||||||
|
#[derive(Clone, Debug, PartialEq, CultUnion)]
|
||||||
|
enum UnitOutcome {
|
||||||
|
#[cultcache(key = 2)]
|
||||||
|
Denied,
|
||||||
|
#[cultcache(key = -2147483648)]
|
||||||
|
Floor,
|
||||||
|
#[cultcache(key = 2147483647)]
|
||||||
|
Ceiling,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Debug, PartialEq, CultSlots)]
|
||||||
|
struct PendingArm {
|
||||||
|
#[cultcache(key = 0)]
|
||||||
|
message: String,
|
||||||
|
#[cultcache(key = 1)]
|
||||||
|
id: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
// An arm with no members of its own: just its element id.
|
||||||
|
#[derive(Clone, Debug, PartialEq, CultSlots)]
|
||||||
|
struct IdArm {
|
||||||
|
#[cultcache(key = 0)]
|
||||||
|
id: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Debug, PartialEq, CultSlots)]
|
||||||
|
struct CompletedArm {
|
||||||
|
#[cultcache(key = 0)]
|
||||||
|
source_version: i32,
|
||||||
|
#[cultcache(key = 1)]
|
||||||
|
id: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Debug, PartialEq, CultSlots)]
|
||||||
|
struct NamedArm {
|
||||||
|
#[cultcache(key = 0)]
|
||||||
|
name: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Debug, PartialEq, CultSlots)]
|
||||||
|
struct UsesArm {
|
||||||
|
#[cultcache(key = 0)]
|
||||||
|
name: String,
|
||||||
|
#[cultcache(key = 1)]
|
||||||
|
uses: i32,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Debug, PartialEq, CultSlots)]
|
||||||
|
struct CountArm {
|
||||||
|
#[cultcache(key = 0)]
|
||||||
|
name: String,
|
||||||
|
#[cultcache(key = 1)]
|
||||||
|
count: i32,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Debug, PartialEq, CultUnion)]
|
||||||
|
enum Item {
|
||||||
|
#[cultcache(key = 0)]
|
||||||
|
Gem(NamedArm),
|
||||||
|
#[cultcache(key = 1)]
|
||||||
|
Tool(UsesArm),
|
||||||
|
#[cultcache(key = 2)]
|
||||||
|
Part(CountArm),
|
||||||
|
}
|
||||||
|
|
||||||
|
// The same arms as Item under its own keys: key 2 is unknown to it.
|
||||||
|
#[derive(Clone, Debug, PartialEq, CultUnion)]
|
||||||
|
enum CraftedItem {
|
||||||
|
#[cultcache(key = 0)]
|
||||||
|
Tool(UsesArm),
|
||||||
|
#[cultcache(key = 1)]
|
||||||
|
Part(CountArm),
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Debug, PartialEq, DatabaseEntry)]
|
||||||
|
#[cultcache(type = "tests.union_surface", schema = "tests.union_surface.v1")]
|
||||||
|
struct UnionSurface {
|
||||||
|
#[cultcache(key = 0)]
|
||||||
|
id: String,
|
||||||
|
#[cultcache(key = 1)]
|
||||||
|
version: i32,
|
||||||
|
#[cultcache(key = 2)]
|
||||||
|
root: Option<Node>,
|
||||||
|
#[cultcache(key = 3)]
|
||||||
|
outcomes: Vec<Outcome>,
|
||||||
|
#[cultcache(key = 4)]
|
||||||
|
part: Option<Item>,
|
||||||
|
#[cultcache(key = 5)]
|
||||||
|
crafted: Option<CraftedItem>,
|
||||||
|
#[cultcache(key = 6)]
|
||||||
|
missing: Option<Node>,
|
||||||
|
}
|
||||||
|
|
||||||
|
fn text(id: &str, content: &str) -> Node {
|
||||||
|
Node::Text(TextArm { id: id.into(), content: content.into() })
|
||||||
|
}
|
||||||
|
|
||||||
|
fn image(id: &str, uri: &str, alt: &str) -> Node {
|
||||||
|
Node::Image(ImageArm { id: id.into(), uri: uri.into(), alt: alt.into() })
|
||||||
|
}
|
||||||
|
|
||||||
|
fn boxed(id: &str, children: Vec<Node>) -> Node {
|
||||||
|
Node::Box(BoxArm { id: id.into(), children })
|
||||||
|
}
|
||||||
|
|
||||||
|
fn constructed() -> UnionSurface {
|
||||||
|
let inner = boxed("0000000000d0", vec![text("0000000000d1", "x"), image("0000000000d2", "uri://a", "alt")]);
|
||||||
|
UnionSurface {
|
||||||
|
id: "surface".into(),
|
||||||
|
version: 3,
|
||||||
|
root: Some(boxed(
|
||||||
|
"0000000000c0",
|
||||||
|
vec![
|
||||||
|
text("0000000000c1", "hello"),
|
||||||
|
Node::Use(UseArm {
|
||||||
|
id: "0000000000c2".into(),
|
||||||
|
composition: Composition { name: "comp".into(), body: Some(std::boxed::Box::new(inner)) },
|
||||||
|
slots: vec![Some(text("0000000000e1", "slot")), None, Some(boxed("0000000000e2", vec![]))],
|
||||||
|
}),
|
||||||
|
image("0000000000c3", "uri://b", ""),
|
||||||
|
],
|
||||||
|
)),
|
||||||
|
outcomes: vec![
|
||||||
|
Outcome::Pending(PendingArm { message: "wait".into(), id: "0000000000a1".into() }),
|
||||||
|
Outcome::Completed(CompletedArm { source_version: 7, id: "0000000000a2".into() }),
|
||||||
|
Outcome::Denied(id_arm("0000000000a3")),
|
||||||
|
],
|
||||||
|
part: Some(Item::Tool(UsesArm { name: "hammer".into(), uses: 12 })),
|
||||||
|
crafted: Some(CraftedItem::Part(CountArm { name: "gear".into(), count: 4 })),
|
||||||
|
missing: None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn id_arm(id: &str) -> IdArm {
|
||||||
|
IdArm { id: id.into() }
|
||||||
|
}
|
||||||
|
|
||||||
|
fn vector(name: &str) -> Vec<u8> {
|
||||||
|
let path = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
|
||||||
|
.join("../../tests/vectors/union-parity")
|
||||||
|
.join(name);
|
||||||
|
std::fs::read(&path).unwrap_or_else(|error| panic!("{}: {error}", path.display()))
|
||||||
|
}
|
||||||
|
|
||||||
fn decode(bytes: &[u8]) -> Result<UnionSurface, String> {
|
fn decode(bytes: &[u8]) -> Result<UnionSurface, String> {
|
||||||
rmp_serde::from_slice(bytes).map_err(|error| error.to_string())
|
rmp_serde::from_slice(bytes).map_err(|error| error.to_string())
|
||||||
|
|
@ -102,10 +325,11 @@ fn an_unknown_arm_lists_the_declared_keys_and_never_echoes_the_payload() {
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn a_union_that_is_not_a_key_and_slots_pair_is_refused_naming_the_enum() {
|
fn a_union_that_is_not_a_key_and_slots_pair_is_refused_naming_the_enum() {
|
||||||
let cases: [(&str, Vec<u8>); 3] = [
|
let cases: [(&str, Vec<u8>); 4] = [
|
||||||
("an empty array", vec![0x90]),
|
("an empty array", vec![0x90]),
|
||||||
("a trailing element", rmp_serde::to_vec(&(1u64, (7u8,), 0u8)).unwrap()),
|
("a trailing element", rmp_serde::to_vec(&(1u64, (7u8,), 0u8)).unwrap()),
|
||||||
("a string key", rmp_serde::to_vec(&("CANARY-key", (7u8,))).unwrap()),
|
("a string key", rmp_serde::to_vec(&("CANARY-key", (7u8,))).unwrap()),
|
||||||
|
("a unit arm with slots", rmp_serde::to_vec(&(2u64, ("CANARY-slot",))).unwrap()),
|
||||||
];
|
];
|
||||||
for (label, bytes) in cases {
|
for (label, bytes) in cases {
|
||||||
let message = rmp_serde::from_slice::<UnitOutcome>(&bytes).unwrap_err().to_string();
|
let message = rmp_serde::from_slice::<UnitOutcome>(&bytes).unwrap_err().to_string();
|
||||||
|
|
@ -468,7 +692,7 @@ fn envelope(key: &str, payload: &[u8]) -> CultCacheEnvelope {
|
||||||
}
|
}
|
||||||
|
|
||||||
// A payload past the bound cannot be admitted through the cache, so a store file written behind its
|
// A payload past the bound cannot be admitted through the cache, so a store file written behind its
|
||||||
// back stands in for one a peer or an older runtime left; load or read refuses it.
|
// back stands in for one a peer or an older runtime left.
|
||||||
fn through_cache(payload: &[u8]) -> Result<UnionSurface, String> {
|
fn through_cache(payload: &[u8]) -> Result<UnionSurface, String> {
|
||||||
let temp = tempfile::tempdir().unwrap();
|
let temp = tempfile::tempdir().unwrap();
|
||||||
let path = temp.path().join("foreign.cc");
|
let path = temp.path().join("foreign.cc");
|
||||||
|
|
@ -476,10 +700,7 @@ fn through_cache(payload: &[u8]) -> Result<UnionSurface, String> {
|
||||||
let mut cache = CultCache::new();
|
let mut cache = CultCache::new();
|
||||||
cache.register_entry_type::<UnionSurface>().unwrap();
|
cache.register_entry_type::<UnionSurface>().unwrap();
|
||||||
cache.add_generic_backing_store(SingleFileMessagePackBackingStore::new(&path)).unwrap();
|
cache.add_generic_backing_store(SingleFileMessagePackBackingStore::new(&path)).unwrap();
|
||||||
// The payload check runs at load, so a payload past the bound is refused there, before any read.
|
cache.pull_all_backing_stores().unwrap();
|
||||||
if let Err(error) = cache.pull_all_backing_stores() {
|
|
||||||
return Err(format!("{error:#}"));
|
|
||||||
}
|
|
||||||
match cache.get::<UnionSurface>("k") {
|
match cache.get::<UnionSurface>("k") {
|
||||||
Ok(value) => Ok(value.expect("the envelope was stored")),
|
Ok(value) => Ok(value.expect("the envelope was stored")),
|
||||||
Err(error) => Err(format!("{error:#}")),
|
Err(error) => Err(format!("{error:#}")),
|
||||||
|
|
@ -536,174 +757,6 @@ fn bounds_vectors() {
|
||||||
assert_eq!((accepted, refused, read_only), (4, 7, 1));
|
assert_eq!((accepted, refused, read_only), (4, 7, 1));
|
||||||
}
|
}
|
||||||
|
|
||||||
// A payload is one MessagePack value (bytes-after-outcomes.msgpack): every door refuses a tail by
|
|
||||||
// its count, names the clause, never the depth limit (the tail is not walked) and never a value.
|
|
||||||
#[test]
|
|
||||||
fn bytes_after_vectors() {
|
|
||||||
let rows: Vec<serde_json::Value> = rmp_serde::from_slice(&vector("bytes-after-outcomes.msgpack")).unwrap();
|
|
||||||
assert_eq!(rows.len(), 4);
|
|
||||||
let surface = vector("union-surface.msgpack");
|
|
||||||
for row in &rows {
|
|
||||||
let fields = row.as_array().unwrap();
|
|
||||||
let (file, outcome, union, detail) = (fields[0].as_str().unwrap(), fields[1].as_str().unwrap(), fields[2].as_str().unwrap(), fields[4].as_str().unwrap());
|
|
||||||
assert_eq!((outcome, union, detail), ("refused", "UnionSurface", "bytes-after"), "{file}");
|
|
||||||
let bytes = vector(file);
|
|
||||||
assert_eq!(&bytes[..surface.len()], &surface[..], "{file}");
|
|
||||||
let clause = format!("payload has {} bytes after its first MessagePack value", bytes.len() - surface.len());
|
|
||||||
let check = |door: &str, message: &str| {
|
|
||||||
assert!(message.contains(&clause), "{file} {door}: {message}");
|
|
||||||
assert!(!message.contains("the limit is"), "{file} {door} walked the tail: {message}");
|
|
||||||
assert!(!message.contains("CANARY-bytes-after-7d1e"), "{file} {door} echoed the tail: {message}");
|
|
||||||
assert!(!message.contains(CANARY), "{file} {door} echoed a value: {message}");
|
|
||||||
};
|
|
||||||
let error = decode_payload::<UnionSurface>(&bytes).unwrap_err();
|
|
||||||
assert!(error.downcast_ref::<PayloadTooDeep>().is_none(), "{file}");
|
|
||||||
check("decode_payload", &format!("{error:#}"));
|
|
||||||
// A store written behind the cache's back is refused at load, naming the type, the key and the count.
|
|
||||||
let temp = tempfile::tempdir().unwrap();
|
|
||||||
let path = temp.path().join("foreign.cc");
|
|
||||||
SingleFileMessagePackBackingStore::new(&path).push(&envelope("k", &bytes)).unwrap();
|
|
||||||
let mut single = CultCache::new();
|
|
||||||
single.register_entry_type::<UnionSurface>().unwrap();
|
|
||||||
single.add_generic_backing_store(SingleFileMessagePackBackingStore::new(&path)).unwrap();
|
|
||||||
let message = format!("{:#}", single.pull_all_backing_stores().unwrap_err());
|
|
||||||
check("single-file load", &message);
|
|
||||||
assert!(message.contains("\"k\"") && message.contains(UnionSurface::TYPE), "{file}: {message}");
|
|
||||||
let redb_path = temp.path().join("foreign.redb");
|
|
||||||
RedbMessagePackBackingStore::new(&redb_path).unwrap().push(&envelope("k", &bytes)).unwrap();
|
|
||||||
let mut redb = CultCache::new();
|
|
||||||
redb.register_entry_type::<UnionSurface>().unwrap();
|
|
||||||
redb.add_generic_backing_store(RedbMessagePackBackingStore::new(&redb_path).unwrap()).unwrap();
|
|
||||||
let message = format!("{:#}", redb.pull_all_backing_stores().unwrap_err());
|
|
||||||
check("redb load", &message);
|
|
||||||
assert!(message.contains("\"k\"") && message.contains(UnionSurface::TYPE), "{file}: {message}");
|
|
||||||
let mut soa = CultCache::new();
|
|
||||||
soa.register_entry_type::<UnionSurface>().unwrap();
|
|
||||||
let message = format!("{:#}", soa.load_soa(CultCacheSoaTable::from_envelopes(vec![envelope("k", &bytes)])).unwrap_err());
|
|
||||||
check("load_soa", &message);
|
|
||||||
assert!(message.contains("\"k\"") && message.contains(UnionSurface::TYPE), "{file}: {message}");
|
|
||||||
assert!(soa.snapshot().is_empty(), "{file}");
|
|
||||||
// Raw admission refuses and stages nothing.
|
|
||||||
let mut raw = CultCache::new();
|
|
||||||
raw.register_entry_type::<UnionSurface>().unwrap();
|
|
||||||
let message = format!("{:#}", raw.put_raw_envelope(envelope("k", &bytes)).unwrap_err());
|
|
||||||
check("put_raw_envelope", &message);
|
|
||||||
assert!(raw.snapshot().is_empty(), "{file}");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Depth is found inside the first value, so a tail never hides it: a payload nested past the bound
|
|
||||||
// with a tail after it is the depth refusal, not bytes after.
|
|
||||||
#[test]
|
|
||||||
fn depth_beats_a_tail() {
|
|
||||||
let mut deep = vec![0x91u8; MAX_PAYLOAD_DEPTH + 1];
|
|
||||||
deep.push(0xc0);
|
|
||||||
deep.push(0xc0);
|
|
||||||
let error = decode_payload::<UnionSurface>(&deep).unwrap_err();
|
|
||||||
assert_eq!(error.downcast_ref::<PayloadTooDeep>(), Some(&TOO_DEEP), "{error:#}");
|
|
||||||
}
|
|
||||||
|
|
||||||
// Depth is refused where the payload is loaded: a store holding one nested past the bound is not read.
|
|
||||||
#[test]
|
|
||||||
fn depth_is_refused_at_load() {
|
|
||||||
let mut deep = vec![0x91u8; MAX_PAYLOAD_DEPTH + 1];
|
|
||||||
deep.push(0xc0);
|
|
||||||
let temp = tempfile::tempdir().unwrap();
|
|
||||||
let path = temp.path().join("deep.cc");
|
|
||||||
SingleFileMessagePackBackingStore::new(&path).push(&envelope("k", &deep)).unwrap();
|
|
||||||
let mut cache = CultCache::new();
|
|
||||||
cache.register_entry_type::<UnionSurface>().unwrap();
|
|
||||||
cache.add_generic_backing_store(SingleFileMessagePackBackingStore::new(&path)).unwrap();
|
|
||||||
let error = cache.pull_all_backing_stores().unwrap_err();
|
|
||||||
assert_eq!(error.downcast_ref::<PayloadTooDeep>(), Some(&TOO_DEEP), "{error:#}");
|
|
||||||
assert!(cache.snapshot().is_empty());
|
|
||||||
}
|
|
||||||
|
|
||||||
// load_soa is a load too: a table holding a payload nested past the bound is refused with the typed depth refusal, the
|
|
||||||
// prior view is kept, and a tail behind the depth is still the depth refusal.
|
|
||||||
#[test]
|
|
||||||
fn load_soa_refuses_a_payload_nested_past_the_bound() {
|
|
||||||
let mut deep = vec![0x91u8; MAX_PAYLOAD_DEPTH + 1];
|
|
||||||
deep.push(0xc0);
|
|
||||||
let mut cache = CultCache::new();
|
|
||||||
cache.register_entry_type::<UnionSurface>().unwrap();
|
|
||||||
cache.load_soa(CultCacheSoaTable::from_envelopes(vec![envelope("kept", &vector("union-surface.msgpack"))])).unwrap();
|
|
||||||
let before = cache.snapshot();
|
|
||||||
for payload in [deep.clone(), [deep.clone(), vec![0xc0]].concat()] {
|
|
||||||
let error = cache.load_soa(CultCacheSoaTable::from_envelopes(vec![envelope("k", &payload)])).unwrap_err();
|
|
||||||
assert_eq!(error.downcast_ref::<PayloadTooDeep>(), Some(&TOO_DEEP), "{error:#}");
|
|
||||||
assert_eq!(cache.snapshot(), before, "a refused load keeps the prior view");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// A cache whose load was refused refuses every write and removal and leaves the store as it was: a
|
|
||||||
// later write would otherwise persist the empty image over the records it never read.
|
|
||||||
#[test]
|
|
||||||
fn a_refused_load_refuses_every_write() {
|
|
||||||
let tail = {
|
|
||||||
let mut bytes = vector("union-surface.msgpack");
|
|
||||||
bytes.push(0xc0);
|
|
||||||
bytes
|
|
||||||
};
|
|
||||||
let good = envelope("good", &vector("union-surface.msgpack"));
|
|
||||||
let bad = envelope("bad", &tail);
|
|
||||||
for redb in [false, true] {
|
|
||||||
let temp = tempfile::tempdir().unwrap();
|
|
||||||
let path = temp.path().join(if redb { "seed.redb" } else { "seed.cc" });
|
|
||||||
let mut cache = CultCache::new();
|
|
||||||
cache.register_entry_type::<UnionSurface>().unwrap();
|
|
||||||
if redb {
|
|
||||||
let mut store = RedbMessagePackBackingStore::new(&path).unwrap();
|
|
||||||
store.push(&good).unwrap();
|
|
||||||
store.push(&bad).unwrap();
|
|
||||||
drop(store);
|
|
||||||
cache.add_generic_backing_store(RedbMessagePackBackingStore::new(&path).unwrap()).unwrap();
|
|
||||||
} else {
|
|
||||||
let mut store = SingleFileMessagePackBackingStore::new(&path);
|
|
||||||
store.push(&good).unwrap();
|
|
||||||
store.push(&bad).unwrap();
|
|
||||||
cache.add_generic_backing_store(SingleFileMessagePackBackingStore::new(&path)).unwrap();
|
|
||||||
}
|
|
||||||
let load = cache.pull_all_backing_stores().unwrap_err();
|
|
||||||
assert!(format!("{load:#}").contains("bytes after"), "{load:#}");
|
|
||||||
let before = std::fs::read(&path).unwrap();
|
|
||||||
let value = constructed();
|
|
||||||
let staged = cache.prepare_entry("new", &value).unwrap().0;
|
|
||||||
let results: Vec<(&str, anyhow::Error)> = vec![
|
|
||||||
("put", cache.put("new", &value).unwrap_err()),
|
|
||||||
("put_prepared_batch", cache.put_prepared_batch(vec![staged.clone()]).unwrap_err()),
|
|
||||||
("put_envelope", cache.put_envelope::<UnionSurface>(staged.clone()).unwrap_err()),
|
|
||||||
("put_raw_envelope", cache.put_raw_envelope(staged.clone()).unwrap_err()),
|
|
||||||
("update", cache.update::<UnionSurface, _>("good", |current| Some(current.unwrap_or_else(constructed))).unwrap_err()),
|
|
||||||
("delete", cache.delete::<UnionSurface>("good").unwrap_err()),
|
|
||||||
("delete a key the image lacks", cache.delete::<UnionSurface>("absent").unwrap_err()),
|
|
||||||
];
|
|
||||||
for (door, error) in results {
|
|
||||||
let refusal = error.downcast_ref::<CultCacheLoadRefused>().unwrap_or_else(|| panic!("{door} redb={redb}: {error:#}"));
|
|
||||||
assert!(refusal.to_string().contains("bytes after"), "{door}: {refusal}");
|
|
||||||
}
|
|
||||||
assert_eq!(std::fs::read(&path).unwrap(), before, "redb={redb}: the store changed");
|
|
||||||
assert!(cache.snapshot().is_empty());
|
|
||||||
// Repairing the store and loading again lifts it.
|
|
||||||
if redb {
|
|
||||||
RedbMessagePackBackingStore::new(&path).unwrap().delete(&bad).unwrap();
|
|
||||||
} else {
|
|
||||||
SingleFileMessagePackBackingStore::new(&path).delete(&bad).unwrap();
|
|
||||||
}
|
|
||||||
cache.pull_all_backing_stores().unwrap();
|
|
||||||
cache.put("new", &value).unwrap();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// A payload that ends early is not bytes after the value: the decoder refuses it, not the check.
|
|
||||||
#[test]
|
|
||||||
fn a_truncated_payload_is_the_decoders_not_bytes_after() {
|
|
||||||
let mut truncated = vec![0x91, 0xd9, 0x40];
|
|
||||||
truncated.extend_from_slice(b"short");
|
|
||||||
let message = format!("{:#}", decode_payload::<UnionSurface>(&truncated).unwrap_err());
|
|
||||||
assert!(!message.contains("bytes after"), "{message}");
|
|
||||||
}
|
|
||||||
|
|
||||||
fn wrap_chain(wraps: usize, leaf: Node) -> UnionSurface {
|
fn wrap_chain(wraps: usize, leaf: Node) -> UnionSurface {
|
||||||
let mut node = leaf;
|
let mut node = leaf;
|
||||||
for _ in 0..wraps {
|
for _ in 0..wraps {
|
||||||
|
|
@ -735,7 +788,6 @@ fn write_refused_past_limit() {
|
||||||
let mut cache = CultCache::new();
|
let mut cache = CultCache::new();
|
||||||
cache.register_entry_type::<UnionSurface>().unwrap();
|
cache.register_entry_type::<UnionSurface>().unwrap();
|
||||||
cache.add_generic_backing_store(SingleFileMessagePackBackingStore::new(&path)).unwrap();
|
cache.add_generic_backing_store(SingleFileMessagePackBackingStore::new(&path)).unwrap();
|
||||||
cache.pull_all_backing_stores().unwrap();
|
|
||||||
|
|
||||||
let at_limit = wrap_chain(126, boxed("0000000000f0", vec![]));
|
let at_limit = wrap_chain(126, boxed("0000000000f0", vec![]));
|
||||||
assert_eq!(cache.put("at", &at_limit).unwrap(), at_limit);
|
assert_eq!(cache.put("at", &at_limit).unwrap(), at_limit);
|
||||||
|
|
@ -819,7 +871,6 @@ fn the_raw_doors_hold_the_bound_for_arms_maps_and_arrays() {
|
||||||
cache.register_entry_type::<UnionSurface>().unwrap();
|
cache.register_entry_type::<UnionSurface>().unwrap();
|
||||||
cache.register_entry_type::<MapDoc>().unwrap();
|
cache.register_entry_type::<MapDoc>().unwrap();
|
||||||
cache.add_generic_backing_store(SingleFileMessagePackBackingStore::new(&path)).unwrap();
|
cache.add_generic_backing_store(SingleFileMessagePackBackingStore::new(&path)).unwrap();
|
||||||
cache.pull_all_backing_stores().unwrap();
|
|
||||||
cache.put_raw_envelope(raw(type_name, "at-raw", at.clone())).unwrap();
|
cache.put_raw_envelope(raw(type_name, "at-raw", at.clone())).unwrap();
|
||||||
cache.put_prepared_batch(vec![raw(type_name, "at-batch", at.clone())]).unwrap();
|
cache.put_prepared_batch(vec![raw(type_name, "at-batch", at.clone())]).unwrap();
|
||||||
let stored = cache.snapshot_envelopes();
|
let stored = cache.snapshot_envelopes();
|
||||||
|
|
|
||||||
|
|
@ -6,7 +6,7 @@
|
||||||
use std::path::{Path, PathBuf};
|
use std::path::{Path, PathBuf};
|
||||||
|
|
||||||
use cultcache_rs::{
|
use cultcache_rs::{
|
||||||
CultCache, CultCacheEnvelope, CultCacheLoadRefused, CultCacheSoaTable, DatabaseEntry, SingleFileMessagePackBackingStore,
|
CultCache, CultCacheEnvelope, CultCacheSoaTable, DatabaseEntry, SingleFileMessagePackBackingStore,
|
||||||
};
|
};
|
||||||
use serde::Deserialize;
|
use serde::Deserialize;
|
||||||
|
|
||||||
|
|
@ -221,7 +221,7 @@ fn a_record_rewriting_its_own_key_keeps_its_value_and_a_change_releases_the_old_
|
||||||
assert_eq!(cache.get_by_index::<Unique>("Sku", "S").unwrap().unwrap().sku, "S");
|
assert_eq!(cache.get_by_index::<Unique>("Sku", "S").unwrap().unwrap().sku, "S");
|
||||||
assert_eq!(cache.get_by_index::<Unique>("Sku", "T").unwrap().unwrap().sku, "T");
|
assert_eq!(cache.get_by_index::<Unique>("Sku", "T").unwrap().unwrap().sku, "T");
|
||||||
// Updating through `update` is the same rule.
|
// Updating through `update` is the same rule.
|
||||||
assert!(cache.update::<Unique, _>("k", |_| Some(unique("S"))).is_err());
|
assert!(cache.update::<Unique, _>("k", |_| unique("S")).is_err());
|
||||||
assert_eq!(cache.get::<Unique>("k").unwrap().unwrap().sku, "T");
|
assert_eq!(cache.get::<Unique>("k").unwrap().unwrap().sku, "T");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -326,7 +326,7 @@ fn every_write_path_refuses_and_changes_nothing() {
|
||||||
assert_eq!(text, refusal(first, second, "Multi", alias));
|
assert_eq!(text, refusal(first, second, "Multi", alias));
|
||||||
};
|
};
|
||||||
pick(&error_text(cache.put("m:new", clash)));
|
pick(&error_text(cache.put("m:new", clash)));
|
||||||
pick(&error_text(cache.update::<Multi, _>("m:new", |_| Some(clash.clone()))));
|
pick(&error_text(cache.update::<Multi, _>("m:new", |_| clash.clone())));
|
||||||
let envelope = staged(&cache, &[("m:new", clash.clone())]).remove(0);
|
let envelope = staged(&cache, &[("m:new", clash.clone())]).remove(0);
|
||||||
pick(&error_text(cache.put_envelope::<Multi>(envelope.clone())));
|
pick(&error_text(cache.put_envelope::<Multi>(envelope.clone())));
|
||||||
pick(&error_text(cache.put_raw_envelope(envelope.clone())));
|
pick(&error_text(cache.put_raw_envelope(envelope.clone())));
|
||||||
|
|
@ -419,54 +419,6 @@ fn a_load_of_a_duplicate_image_is_refused_and_keeps_the_prior_view() {
|
||||||
soa.put("item:y", &unique("K")).unwrap();
|
soa.put("item:y", &unique("K")).unwrap();
|
||||||
}
|
}
|
||||||
|
|
||||||
// A pull refused for a duplicate unique-index value, or for one key held under two types in two stores, closes the same
|
|
||||||
// write gate a payload refusal does: the cache holds no image of its stores, so a write would lay the empty image over them.
|
|
||||||
#[test]
|
|
||||||
fn a_pull_refused_for_a_duplicate_index_or_a_retype_closes_every_write() {
|
|
||||||
fn assert_gated(cache: &mut CultCache, path: &Path, door_label: &str) {
|
|
||||||
let before = std::fs::read(path).unwrap();
|
|
||||||
let errors = [
|
|
||||||
("put", cache.put("item:new", &unique("N")).unwrap_err()),
|
|
||||||
("put_raw_envelope", cache.put_raw_envelope(cache.prepare_entry("item:new", &unique("N")).unwrap().0).unwrap_err()),
|
|
||||||
("delete", cache.delete::<Unique>("item:keep").unwrap_err()),
|
|
||||||
];
|
|
||||||
for (door, error) in errors {
|
|
||||||
assert!(error.downcast_ref::<CultCacheLoadRefused>().is_some(), "{door_label} {door}: {error:#}");
|
|
||||||
}
|
|
||||||
assert_eq!(std::fs::read(path).unwrap(), before, "{door_label}: the store changed");
|
|
||||||
}
|
|
||||||
|
|
||||||
// Duplicate index value found in the stored image.
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = dir.path().join("dup.cc");
|
|
||||||
let mut cache = cache_at(&path);
|
|
||||||
cache.put("item:keep", &unique("K")).unwrap();
|
|
||||||
let mut twin = twin_cache_at(&path);
|
|
||||||
twin.put("item:b", &Twin { sku: "S".into(), category: "c".into() }).unwrap();
|
|
||||||
twin.put("item:a", &Twin { sku: "S".into(), category: "c".into() }).unwrap();
|
|
||||||
assert!(error_text(cache.pull_all_backing_stores()).contains("both hold unique index 'Sku'"));
|
|
||||||
assert_gated(&mut cache, &path, "duplicate index");
|
|
||||||
|
|
||||||
// One key held under two types by two stores. The cache pulled cleanly first, so only the refused pull can close the gate.
|
|
||||||
let (first, second) = (dir.path().join("first.cc"), dir.path().join("second.cc"));
|
|
||||||
let mut cache = CultCache::new();
|
|
||||||
cache.register_entry_type::<Plain>().unwrap();
|
|
||||||
cache.register_entry_type::<Other>().unwrap();
|
|
||||||
cache.register_entry_type::<Unique>().unwrap();
|
|
||||||
cache.add_backing_store(SingleFileMessagePackBackingStore::new(&first), [Plain::TYPE]).unwrap();
|
|
||||||
cache.add_backing_store(SingleFileMessagePackBackingStore::new(&second), [Other::TYPE]).unwrap();
|
|
||||||
cache.pull_all_backing_stores().unwrap();
|
|
||||||
cache.put("k", &Plain { value: "p".into() }).unwrap();
|
|
||||||
let mut seed = CultCache::new();
|
|
||||||
seed.register_entry_type::<Other>().unwrap();
|
|
||||||
seed.add_generic_backing_store(SingleFileMessagePackBackingStore::new(&second)).unwrap();
|
|
||||||
seed.pull_all_backing_stores().unwrap();
|
|
||||||
seed.put("k", &Other { sku: "o".into() }).unwrap();
|
|
||||||
assert!(error_text(cache.pull_all_backing_stores()).contains("\"k\""));
|
|
||||||
assert_gated(&mut cache, &first, "retype");
|
|
||||||
assert_eq!(cache.get::<Plain>("k").unwrap().unwrap().value, "p", "a refused pull keeps the prior view");
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn a_multi_index_store_with_a_duplicate_on_the_second_alias_refuses_to_open() {
|
fn a_multi_index_store_with_a_duplicate_on_the_second_alias_refuses_to_open() {
|
||||||
let dir = tempfile::tempdir().unwrap();
|
let dir = tempfile::tempdir().unwrap();
|
||||||
|
|
|
||||||
|
|
@ -1,770 +0,0 @@
|
||||||
//! `CultCache::update`: read the record as its home store holds it, apply, commit only over what was read, rerun on a lost race
|
|
||||||
//! (C# `CultCache.Update`, as amended by PR #170). A rival is a second `CultCache` on the same file.
|
|
||||||
|
|
||||||
use std::cell::Cell;
|
|
||||||
use std::path::{Path, PathBuf};
|
|
||||||
use std::sync::atomic::{AtomicUsize, Ordering};
|
|
||||||
use std::sync::{Arc, Barrier};
|
|
||||||
|
|
||||||
use cultcache_rs::{
|
|
||||||
CacheBackingStore, CultCache, CultCacheEnvelope, CultCommitIf, CultStoredRecord, CultUpdateOutcome, DatabaseEntry,
|
|
||||||
PushAllOptions, RedbMessagePackBackingStore, SingleFileMessagePackBackingStore,
|
|
||||||
};
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, PartialEq, Eq, DatabaseEntry)]
|
|
||||||
#[cultcache(type = "counter")]
|
|
||||||
struct Counter {
|
|
||||||
#[cultcache(key = 0)]
|
|
||||||
n: u32,
|
|
||||||
}
|
|
||||||
|
|
||||||
/// The same type with a second slot: a record it writes carries a slot `Counter` does not read.
|
|
||||||
#[derive(Clone, Debug, PartialEq, Eq, DatabaseEntry)]
|
|
||||||
#[cultcache(type = "counter")]
|
|
||||||
struct WideCounter {
|
|
||||||
#[cultcache(key = 0)]
|
|
||||||
n: u32,
|
|
||||||
#[cultcache(key = 1)]
|
|
||||||
extra: u32,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, PartialEq, Eq, DatabaseEntry)]
|
|
||||||
#[cultcache(type = "note")]
|
|
||||||
struct Note {
|
|
||||||
#[cultcache(key = 0)]
|
|
||||||
text: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, PartialEq, Eq, DatabaseEntry)]
|
|
||||||
#[cultcache(type = "unique_sku")]
|
|
||||||
struct Sku {
|
|
||||||
#[cultcache(key = 0, index = "Sku")]
|
|
||||||
sku: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
fn counter(n: u32) -> Counter {
|
|
||||||
Counter { n }
|
|
||||||
}
|
|
||||||
|
|
||||||
fn open(path: &Path) -> CultCache {
|
|
||||||
let mut cache = CultCache::new();
|
|
||||||
cache.register_entry_type::<Counter>().unwrap();
|
|
||||||
cache.register_entry_type::<Note>().unwrap();
|
|
||||||
cache.register_entry_type::<Sku>().unwrap();
|
|
||||||
cache.add_generic_backing_store(SingleFileMessagePackBackingStore::new(path)).unwrap();
|
|
||||||
cache.pull_all_backing_stores().unwrap();
|
|
||||||
cache
|
|
||||||
}
|
|
||||||
|
|
||||||
fn path_in(dir: &tempfile::TempDir) -> PathBuf {
|
|
||||||
dir.path().join("store.cc")
|
|
||||||
}
|
|
||||||
|
|
||||||
/// What a fresh cache reads at `key`.
|
|
||||||
fn stored(path: &Path, key: &str) -> Option<u32> {
|
|
||||||
open(path).get::<Counter>(key).unwrap().map(|counter| counter.n)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn file(path: &Path) -> Option<Vec<u8>> {
|
|
||||||
std::fs::read(path).ok()
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn two_writers_updating_lose_no_increment() {
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = path_in(&dir);
|
|
||||||
let calls = Arc::new(AtomicUsize::new(0));
|
|
||||||
let start = Arc::new(Barrier::new(2));
|
|
||||||
let threads: Vec<_> = (0..2)
|
|
||||||
.map(|_| {
|
|
||||||
let (path, calls, start) = (path.clone(), calls.clone(), start.clone());
|
|
||||||
std::thread::spawn(move || {
|
|
||||||
let mut cache = open(&path);
|
|
||||||
start.wait();
|
|
||||||
for _ in 0..50 {
|
|
||||||
let result = cache
|
|
||||||
.update_with_attempts::<Counter, _>("c", 100, |current| {
|
|
||||||
calls.fetch_add(1, Ordering::SeqCst);
|
|
||||||
// The window a rival can land in.
|
|
||||||
std::thread::sleep(std::time::Duration::from_millis(1));
|
|
||||||
Some(counter(current.map_or(0, |held| held.n) + 1))
|
|
||||||
})
|
|
||||||
.unwrap();
|
|
||||||
assert_eq!(result.outcome, CultUpdateOutcome::Updated);
|
|
||||||
}
|
|
||||||
})
|
|
||||||
})
|
|
||||||
.collect();
|
|
||||||
for thread in threads {
|
|
||||||
thread.join().unwrap();
|
|
||||||
}
|
|
||||||
assert_eq!(stored(&path, "c"), Some(100));
|
|
||||||
assert!(calls.load(Ordering::SeqCst) > 100, "no apply was rerun, so no race was exercised");
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn a_lost_attempt_reruns_apply_on_the_fresh_value() {
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = path_in(&dir);
|
|
||||||
let mut cache = open(&path);
|
|
||||||
cache.put("c", &counter(1)).unwrap();
|
|
||||||
let mut rival = open(&path);
|
|
||||||
let mut seen = Vec::new();
|
|
||||||
let result = cache
|
|
||||||
.update::<Counter, _>("c", |current| {
|
|
||||||
let current = current.unwrap().n;
|
|
||||||
if seen.is_empty() {
|
|
||||||
rival.put("c", &counter(100)).unwrap();
|
|
||||||
}
|
|
||||||
seen.push(current);
|
|
||||||
Some(counter(current + 1))
|
|
||||||
})
|
|
||||||
.unwrap();
|
|
||||||
assert_eq!(seen, [1, 100]);
|
|
||||||
assert_eq!(result.outcome, CultUpdateOutcome::Updated);
|
|
||||||
assert_eq!(result.document, Some(counter(101)));
|
|
||||||
assert_eq!(stored(&path, "c"), Some(101));
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn exhausted_attempts_return_lost_race() {
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = path_in(&dir);
|
|
||||||
let mut cache = open(&path);
|
|
||||||
cache.put("c", &counter(1)).unwrap();
|
|
||||||
let mut rival = open(&path);
|
|
||||||
let mut calls = 0;
|
|
||||||
let result = cache
|
|
||||||
.update_with_attempts::<Counter, _>("c", 3, |current| {
|
|
||||||
calls += 1;
|
|
||||||
rival.put("c", &counter(100 * calls)).unwrap();
|
|
||||||
current
|
|
||||||
})
|
|
||||||
.unwrap();
|
|
||||||
assert_eq!(calls, 3);
|
|
||||||
assert_eq!(result.outcome, CultUpdateOutcome::LostRace);
|
|
||||||
// The pull before LostRace shows the value that won.
|
|
||||||
assert_eq!(result.document, Some(counter(300)));
|
|
||||||
assert_eq!(stored(&path, "c"), Some(300));
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn max_attempts_bounds() {
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = path_in(&dir);
|
|
||||||
let mut cache = open(&path);
|
|
||||||
cache.put("c", &counter(1)).unwrap();
|
|
||||||
let mut rival = open(&path);
|
|
||||||
// Always loses; panics past 10 calls so a weakened bound fails here instead of hanging.
|
|
||||||
let mut losing = |calls: &Cell<u32>| {
|
|
||||||
let n = calls.get() + 1;
|
|
||||||
calls.set(n);
|
|
||||||
assert!(n <= 10, "apply ran past the bound");
|
|
||||||
rival.put("c", &counter(1000 + n)).unwrap();
|
|
||||||
Some(counter(n))
|
|
||||||
};
|
|
||||||
|
|
||||||
let calls = Cell::new(0);
|
|
||||||
let one = cache.update_with_attempts::<Counter, _>("c", 1, |_| losing(&calls)).unwrap();
|
|
||||||
assert_eq!((calls.get(), one.outcome), (1, CultUpdateOutcome::LostRace));
|
|
||||||
|
|
||||||
let calls = Cell::new(0);
|
|
||||||
assert!(cache.update_with_attempts::<Counter, _>("c", 0, |_| losing(&calls)).is_err());
|
|
||||||
assert_eq!(calls.get(), 0);
|
|
||||||
|
|
||||||
// The default bound is 5.
|
|
||||||
let calls = Cell::new(0);
|
|
||||||
let default = cache.update::<Counter, _>("c", |_| losing(&calls)).unwrap();
|
|
||||||
assert_eq!((calls.get(), default.outcome), (5, CultUpdateOutcome::LostRace));
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn none_declines_and_writes_nothing() {
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = path_in(&dir);
|
|
||||||
let mut cache = open(&path);
|
|
||||||
let absent = cache.update::<Counter, _>("c", |current| {
|
|
||||||
assert_eq!(current, None);
|
|
||||||
None
|
|
||||||
});
|
|
||||||
let absent = absent.unwrap();
|
|
||||||
assert_eq!((absent.outcome, absent.document), (CultUpdateOutcome::Declined, None));
|
|
||||||
assert_eq!(file(&path), None, "a declined update created the store");
|
|
||||||
|
|
||||||
cache.put("c", &counter(1)).unwrap();
|
|
||||||
let before = file(&path);
|
|
||||||
let held = cache.update::<Counter, _>("c", |_| None).unwrap();
|
|
||||||
assert_eq!((held.outcome, held.document), (CultUpdateOutcome::Declined, Some(counter(1))));
|
|
||||||
assert_eq!(file(&path), before);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn a_declined_update_installs_nothing() {
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = path_in(&dir);
|
|
||||||
let mut cache = open(&path);
|
|
||||||
cache.put("c", &counter(1)).unwrap();
|
|
||||||
let mut rival = open(&path);
|
|
||||||
rival.put("c", &counter(7)).unwrap();
|
|
||||||
let mut seen = None;
|
|
||||||
let result = cache
|
|
||||||
.update::<Counter, _>("c", |current| {
|
|
||||||
seen = current;
|
|
||||||
None
|
|
||||||
})
|
|
||||||
.unwrap();
|
|
||||||
assert_eq!(seen, Some(counter(7)), "apply saw the held copy, not the store's");
|
|
||||||
assert_eq!(result.document, Some(counter(1)));
|
|
||||||
assert_eq!(cache.get::<Counter>("c").unwrap(), Some(counter(1)));
|
|
||||||
cache.pull_all_backing_stores().unwrap();
|
|
||||||
assert_eq!(cache.get::<Counter>("c").unwrap(), Some(counter(7)));
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn absent_key_rival_removal_and_a_store_holding_nothing() {
|
|
||||||
// Two writers creating one absent key.
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = path_in(&dir);
|
|
||||||
let start = Arc::new(Barrier::new(2));
|
|
||||||
let threads: Vec<_> = (0..2)
|
|
||||||
.map(|_| {
|
|
||||||
let (path, start) = (path.clone(), start.clone());
|
|
||||||
std::thread::spawn(move || {
|
|
||||||
let mut cache = open(&path);
|
|
||||||
start.wait();
|
|
||||||
let result = cache
|
|
||||||
.update_with_attempts::<Counter, _>("new", 20, |current| {
|
|
||||||
std::thread::sleep(std::time::Duration::from_millis(1));
|
|
||||||
Some(counter(current.map_or(0, |held| held.n) + 1))
|
|
||||||
})
|
|
||||||
.unwrap();
|
|
||||||
assert_eq!(result.outcome, CultUpdateOutcome::Updated);
|
|
||||||
})
|
|
||||||
})
|
|
||||||
.collect();
|
|
||||||
for thread in threads {
|
|
||||||
thread.join().unwrap();
|
|
||||||
}
|
|
||||||
assert_eq!(stored(&path, "new"), Some(2));
|
|
||||||
|
|
||||||
// A rival deletes the record inside apply: the retry sees nothing.
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = path_in(&dir);
|
|
||||||
let mut cache = open(&path);
|
|
||||||
cache.put("c", &counter(1)).unwrap();
|
|
||||||
let mut rival = open(&path);
|
|
||||||
let mut seen = Vec::new();
|
|
||||||
let result = cache
|
|
||||||
.update::<Counter, _>("c", |current| {
|
|
||||||
if seen.is_empty() {
|
|
||||||
assert!(rival.delete::<Counter>("c").unwrap());
|
|
||||||
}
|
|
||||||
seen.push(current.clone());
|
|
||||||
Some(counter(current.map_or(0, |held| held.n) + 1))
|
|
||||||
})
|
|
||||||
.unwrap();
|
|
||||||
assert_eq!(seen, [Some(counter(1)), None]);
|
|
||||||
assert_eq!(result.outcome, CultUpdateOutcome::Updated);
|
|
||||||
assert_eq!(stored(&path, "c"), Some(1));
|
|
||||||
|
|
||||||
// The cache holds a record the store no longer has: apply is handed None.
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = path_in(&dir);
|
|
||||||
let mut cache = open(&path);
|
|
||||||
cache.put("c", &counter(5)).unwrap();
|
|
||||||
assert!(open(&path).delete::<Counter>("c").unwrap());
|
|
||||||
let mut seen = Vec::new();
|
|
||||||
cache
|
|
||||||
.update::<Counter, _>("c", |current| {
|
|
||||||
seen.push(current);
|
|
||||||
Some(counter(1))
|
|
||||||
})
|
|
||||||
.unwrap();
|
|
||||||
assert_eq!(seen, [None]);
|
|
||||||
assert_eq!(stored(&path, "c"), Some(1));
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn a_rival_writing_and_restoring_the_value_still_reruns_apply() {
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = path_in(&dir);
|
|
||||||
let mut cache = open(&path);
|
|
||||||
cache.put("c", &counter(1)).unwrap();
|
|
||||||
let mut rival = open(&path);
|
|
||||||
let mut seen = Vec::new();
|
|
||||||
cache
|
|
||||||
.update::<Counter, _>("c", |current| {
|
|
||||||
let current = current.unwrap().n;
|
|
||||||
if seen.is_empty() {
|
|
||||||
rival.put("c", &counter(5)).unwrap();
|
|
||||||
rival.put("c", &counter(1)).unwrap();
|
|
||||||
}
|
|
||||||
seen.push(current);
|
|
||||||
Some(counter(current + 1))
|
|
||||||
})
|
|
||||||
.unwrap();
|
|
||||||
assert_eq!(seen, [1, 1]);
|
|
||||||
assert_eq!(stored(&path, "c"), Some(2));
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn a_stale_caches_first_attempt_reads_the_store() {
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = path_in(&dir);
|
|
||||||
let mut a = open(&path);
|
|
||||||
a.put("c", &counter(1)).unwrap();
|
|
||||||
let mut b = open(&path);
|
|
||||||
a.put("c", &counter(7)).unwrap();
|
|
||||||
let mut seen = Vec::new();
|
|
||||||
b.update::<Counter, _>("c", |current| {
|
|
||||||
seen.push(current.clone());
|
|
||||||
current.map(|held| counter(held.n + 1))
|
|
||||||
})
|
|
||||||
.unwrap();
|
|
||||||
assert_eq!(seen, [Some(counter(7))]);
|
|
||||||
assert_eq!(stored(&path, "c"), Some(8));
|
|
||||||
}
|
|
||||||
|
|
||||||
/// A custom store over the single-file store that has no `read` or `commit_if`.
|
|
||||||
struct ReadlessStore(SingleFileMessagePackBackingStore);
|
|
||||||
|
|
||||||
impl CacheBackingStore for ReadlessStore {
|
|
||||||
fn pull_all(&self) -> anyhow::Result<Vec<CultCacheEnvelope>> {
|
|
||||||
self.0.pull_all()
|
|
||||||
}
|
|
||||||
fn push(&mut self, entry: &CultCacheEnvelope) -> anyhow::Result<String> {
|
|
||||||
self.0.push(entry)
|
|
||||||
}
|
|
||||||
fn delete(&mut self, entry: &CultCacheEnvelope) -> anyhow::Result<()> {
|
|
||||||
self.0.delete(entry)
|
|
||||||
}
|
|
||||||
fn push_all(&mut self, entries: &[CultCacheEnvelope], options: PushAllOptions) -> anyhow::Result<Vec<String>> {
|
|
||||||
self.0.push_all(entries, options)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Runs `update` with an apply that counts its calls; the refusal must come before the first.
|
|
||||||
fn refused(cache: &mut CultCache, path: &Path, key: &str) -> String {
|
|
||||||
let before = file(path);
|
|
||||||
let calls = Cell::new(0);
|
|
||||||
let error = cache
|
|
||||||
.update::<Counter, _>(key, |current| {
|
|
||||||
calls.set(calls.get() + 1);
|
|
||||||
current
|
|
||||||
})
|
|
||||||
.expect_err("the update must be refused");
|
|
||||||
assert_eq!(calls.get(), 0, "apply ran before the refusal: {error:#}");
|
|
||||||
assert_eq!(file(path), before, "a refused update touched the store");
|
|
||||||
format!("{error:#}")
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn refusals_come_before_apply() {
|
|
||||||
// Another type's record written at the key since the pull: the read resolves it.
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = path_in(&dir);
|
|
||||||
let mut cache = open(&path);
|
|
||||||
open(&path).put("k", &Note { text: "n".into() }).unwrap();
|
|
||||||
let text = refused(&mut cache, &path, "k");
|
|
||||||
assert!(text.contains("update cannot copy it"), "{text}");
|
|
||||||
|
|
||||||
// Another type held at the key.
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = path_in(&dir);
|
|
||||||
let mut cache = open(&path);
|
|
||||||
cache.put("k", &Note { text: "n".into() }).unwrap();
|
|
||||||
refused(&mut cache, &path, "k");
|
|
||||||
|
|
||||||
// A cache with no store holds another type at the key.
|
|
||||||
let mut memory = CultCache::new();
|
|
||||||
memory.register_entry_type::<Counter>().unwrap();
|
|
||||||
memory.register_entry_type::<Note>().unwrap();
|
|
||||||
memory.put("k", &Note { text: "n".into() }).unwrap();
|
|
||||||
let calls = Cell::new(0);
|
|
||||||
assert!(memory
|
|
||||||
.update::<Counter, _>("k", |current| {
|
|
||||||
calls.set(calls.get() + 1);
|
|
||||||
current
|
|
||||||
})
|
|
||||||
.is_err());
|
|
||||||
assert_eq!(calls.get(), 0);
|
|
||||||
|
|
||||||
// A foreign record (no registered type claims it) held at the key, and one that appears after the pull.
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = path_in(&dir);
|
|
||||||
open(&path).put("k", &Note { text: "n".into() }).unwrap();
|
|
||||||
let mut only_counter = CultCache::new();
|
|
||||||
only_counter.register_entry_type::<Counter>().unwrap();
|
|
||||||
only_counter.add_generic_backing_store(SingleFileMessagePackBackingStore::new(&path)).unwrap();
|
|
||||||
only_counter.pull_all_backing_stores().unwrap();
|
|
||||||
refused(&mut only_counter, &path, "k");
|
|
||||||
let mut later = CultCache::new();
|
|
||||||
later.register_entry_type::<Counter>().unwrap();
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = path_in(&dir);
|
|
||||||
later.add_generic_backing_store(SingleFileMessagePackBackingStore::new(&path)).unwrap();
|
|
||||||
later.pull_all_backing_stores().unwrap();
|
|
||||||
open(&path).put("z", &Note { text: "n".into() }).unwrap();
|
|
||||||
let text = refused(&mut later, &path, "z");
|
|
||||||
assert!(text.contains("update cannot copy it"), "{text}");
|
|
||||||
|
|
||||||
// A redb home and a custom store without read.
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let redb_path = dir.path().join("store.redb");
|
|
||||||
let mut redb = CultCache::new();
|
|
||||||
redb.register_entry_type::<Counter>().unwrap();
|
|
||||||
redb.add_generic_backing_store(RedbMessagePackBackingStore::new(&redb_path).unwrap()).unwrap();
|
|
||||||
redb.pull_all_backing_stores().unwrap();
|
|
||||||
redb.put("c", &counter(1)).unwrap();
|
|
||||||
let text = refused(&mut redb, &redb_path, "c");
|
|
||||||
assert!(text.contains("read and commit_if"), "{text}");
|
|
||||||
let path = path_in(&dir);
|
|
||||||
let mut custom = CultCache::new();
|
|
||||||
custom.register_entry_type::<Counter>().unwrap();
|
|
||||||
custom.add_generic_backing_store(ReadlessStore(SingleFileMessagePackBackingStore::new(&path))).unwrap();
|
|
||||||
custom.pull_all_backing_stores().unwrap();
|
|
||||||
custom.put("c", &counter(1)).unwrap();
|
|
||||||
let text = refused(&mut custom, &path, "c");
|
|
||||||
assert!(text.contains("read and commit_if"), "{text}");
|
|
||||||
|
|
||||||
// A held read-only record, and a store record with slots the cache never loaded.
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = path_in(&dir);
|
|
||||||
let mut wide = CultCache::new();
|
|
||||||
wide.register_entry_type::<WideCounter>().unwrap();
|
|
||||||
wide.add_generic_backing_store(SingleFileMessagePackBackingStore::new(&path)).unwrap();
|
|
||||||
wide.pull_all_backing_stores().unwrap();
|
|
||||||
wide.put("held", &WideCounter { n: 1, extra: 2 }).unwrap();
|
|
||||||
let mut cache = open(&path);
|
|
||||||
let text = refused(&mut cache, &path, "held");
|
|
||||||
assert!(text.contains("held"), "{text}");
|
|
||||||
wide.put("unloaded", &WideCounter { n: 1, extra: 2 }).unwrap();
|
|
||||||
refused(&mut cache, &path, "unloaded");
|
|
||||||
|
|
||||||
// An unpulled cache.
|
|
||||||
let mut unpulled = CultCache::new();
|
|
||||||
unpulled.register_entry_type::<Counter>().unwrap();
|
|
||||||
unpulled.add_generic_backing_store(SingleFileMessagePackBackingStore::new(&path)).unwrap();
|
|
||||||
refused(&mut unpulled, &path, "held");
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn a_refusal_after_apply_is_not_retried() {
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = path_in(&dir);
|
|
||||||
let mut cache = open(&path);
|
|
||||||
cache.put("a", &Sku { sku: "S".into() }).unwrap();
|
|
||||||
cache.put("b", &Sku { sku: "T".into() }).unwrap();
|
|
||||||
let before = file(&path);
|
|
||||||
let calls = Cell::new(0);
|
|
||||||
let error = cache
|
|
||||||
.update::<Sku, _>("b", |_| {
|
|
||||||
calls.set(calls.get() + 1);
|
|
||||||
Some(Sku { sku: "S".into() })
|
|
||||||
})
|
|
||||||
.expect_err("a unique-index clash");
|
|
||||||
assert_eq!(calls.get(), 1, "{error:#}");
|
|
||||||
assert_eq!(file(&path), before);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn own_writes_and_the_store_less_cache() {
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = path_in(&dir);
|
|
||||||
let mut cache = open(&path);
|
|
||||||
cache.put("c", &counter(1)).unwrap();
|
|
||||||
let calls = Cell::new(0);
|
|
||||||
for expected in [2, 3] {
|
|
||||||
let result = cache
|
|
||||||
.update::<Counter, _>("c", |current| {
|
|
||||||
calls.set(calls.get() + 1);
|
|
||||||
current.map(|held| counter(held.n + 1))
|
|
||||||
})
|
|
||||||
.unwrap();
|
|
||||||
assert_eq!(result.outcome, CultUpdateOutcome::Updated);
|
|
||||||
assert_eq!(result.document, Some(counter(expected)));
|
|
||||||
assert_eq!(result.document, cache.get::<Counter>("c").unwrap());
|
|
||||||
}
|
|
||||||
assert_eq!(calls.get(), 2);
|
|
||||||
|
|
||||||
let mut memory = CultCache::new();
|
|
||||||
memory.register_entry_type::<Counter>().unwrap();
|
|
||||||
let calls = Cell::new(0);
|
|
||||||
let result = memory
|
|
||||||
.update::<Counter, _>("c", |current| {
|
|
||||||
calls.set(calls.get() + 1);
|
|
||||||
Some(counter(current.map_or(0, |held| held.n) + 1))
|
|
||||||
})
|
|
||||||
.unwrap();
|
|
||||||
assert_eq!((calls.get(), result.outcome, result.document), (1, CultUpdateOutcome::Updated, Some(counter(1))));
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn the_ledger_holds_under_contention() {
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = path_in(&dir);
|
|
||||||
let start = Arc::new(Barrier::new(3));
|
|
||||||
let threads: Vec<_> = (0..3)
|
|
||||||
.map(|_| {
|
|
||||||
let (path, start) = (path.clone(), start.clone());
|
|
||||||
std::thread::spawn(move || {
|
|
||||||
let mut cache = open(&path);
|
|
||||||
start.wait();
|
|
||||||
(0..25)
|
|
||||||
.filter(|_| {
|
|
||||||
let result = cache
|
|
||||||
.update::<Counter, _>("c", |current| Some(counter(current.map_or(0, |held| held.n) + 1)))
|
|
||||||
.unwrap();
|
|
||||||
result.outcome == CultUpdateOutcome::Updated
|
|
||||||
})
|
|
||||||
.count() as u32
|
|
||||||
})
|
|
||||||
})
|
|
||||||
.collect();
|
|
||||||
let updated: u32 = threads.into_iter().map(|thread| thread.join().unwrap()).sum();
|
|
||||||
assert_eq!(stored(&path, "c"), Some(updated));
|
|
||||||
}
|
|
||||||
|
|
||||||
fn envelope_of<T: DatabaseEntry>(cache: &CultCache, key: &str, value: &T, stamp: &str) -> CultCacheEnvelope {
|
|
||||||
let (mut entry, _) = cache.prepare_entry(key, value).unwrap();
|
|
||||||
entry.stored_at = stamp.to_string();
|
|
||||||
entry
|
|
||||||
}
|
|
||||||
|
|
||||||
const FUTURE: &str = "2099-01-01T00:00:00Z";
|
|
||||||
|
|
||||||
fn later_than_future(stamp: &str) -> bool {
|
|
||||||
chrono::DateTime::parse_from_rfc3339(stamp).unwrap() > chrono::DateTime::parse_from_rfc3339(FUTURE).unwrap()
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn commit_if_writes_only_over_the_version_it_was_given() {
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = path_in(&dir);
|
|
||||||
let cache = open(&path);
|
|
||||||
let mut store = SingleFileMessagePackBackingStore::new(&path);
|
|
||||||
assert_eq!(store.read("c").unwrap(), None);
|
|
||||||
let one = envelope_of(&cache, "c", &counter(1), FUTURE);
|
|
||||||
// Against an absent key, expecting a version mismatches; expecting nothing commits.
|
|
||||||
assert_eq!(store.commit_if(&one, Some("0000")).unwrap(), CultCommitIf::Mismatch);
|
|
||||||
assert_eq!(file(&path), None);
|
|
||||||
assert_eq!(store.commit_if(&one, None).unwrap(), CultCommitIf::Committed { stored_at: FUTURE.to_string() });
|
|
||||||
let CultStoredRecord { envelope, version } = store.read("c").unwrap().unwrap();
|
|
||||||
assert_eq!(envelope.stored_at, FUTURE);
|
|
||||||
|
|
||||||
let before = file(&path);
|
|
||||||
let two = envelope_of(&cache, "c", &counter(2), FUTURE);
|
|
||||||
assert_eq!(store.commit_if(&two, None).unwrap(), CultCommitIf::Mismatch);
|
|
||||||
assert_eq!(store.commit_if(&two, Some("not-the-version")).unwrap(), CultCommitIf::Mismatch);
|
|
||||||
assert_eq!(file(&path), before, "a mismatch wrote");
|
|
||||||
let CultCommitIf::Committed { stored_at } = store.commit_if(&two, Some(&version)).unwrap() else { panic!("the version matches") };
|
|
||||||
assert!(later_than_future(&stored_at), "{stored_at}");
|
|
||||||
assert_eq!(stored(&path, "c"), Some(2));
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn the_cache_facing_writes_stamp_over_a_replaced_record() {
|
|
||||||
let seeded = |dir: &tempfile::TempDir| {
|
|
||||||
let path = path_in(dir);
|
|
||||||
let seed = open(&path);
|
|
||||||
let mut store = SingleFileMessagePackBackingStore::new(&path);
|
|
||||||
store.push(&envelope_of(&seed, "c", &counter(1), FUTURE)).unwrap();
|
|
||||||
(path, seed)
|
|
||||||
};
|
|
||||||
let on_disk = |path: &Path| {
|
|
||||||
let mut store = SingleFileMessagePackBackingStore::new(path);
|
|
||||||
let stamp = store.read("c").unwrap().unwrap().envelope.stored_at;
|
|
||||||
let _ = &mut store;
|
|
||||||
stamp
|
|
||||||
};
|
|
||||||
|
|
||||||
// The store: push, push_all and commit_if each return the stamp they wrote, strictly later than what they replaced.
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let (path, seed) = seeded(&dir);
|
|
||||||
let mut store = SingleFileMessagePackBackingStore::new(&path);
|
|
||||||
let stamp = store.push(&envelope_of(&seed, "c", &counter(2), FUTURE)).unwrap();
|
|
||||||
assert!(later_than_future(&stamp) && stamp == on_disk(&path), "push: {stamp}");
|
|
||||||
let stamps = store.push_all(&[envelope_of(&seed, "c", &counter(3), FUTURE)], PushAllOptions::default()).unwrap();
|
|
||||||
assert!(later_than_future(&stamps[0]) && stamps[0] == on_disk(&path), "push_all: {stamps:?}");
|
|
||||||
let version = store.read("c").unwrap().unwrap().version;
|
|
||||||
let CultCommitIf::Committed { stored_at } = store.commit_if(&envelope_of(&seed, "c", &counter(4), FUTURE), Some(&version)).unwrap()
|
|
||||||
else {
|
|
||||||
panic!("matching version")
|
|
||||||
};
|
|
||||||
assert!(later_than_future(&stored_at) && stored_at == on_disk(&path), "commit_if: {stored_at}");
|
|
||||||
// One stamp per input, in order, a duplicate getting the stamp of the entry that landed; a soft write that wrote nothing none.
|
|
||||||
let stamps = store
|
|
||||||
.push_all(
|
|
||||||
&[envelope_of(&seed, "c", &counter(5), FUTURE), envelope_of(&seed, "d", &counter(6), FUTURE), envelope_of(&seed, "c", &counter(7), FUTURE)],
|
|
||||||
PushAllOptions::default(),
|
|
||||||
)
|
|
||||||
.unwrap();
|
|
||||||
assert_eq!(stamps.len(), 3);
|
|
||||||
assert_eq!(stamps[0], stamps[2]);
|
|
||||||
assert_eq!(stamps[1], FUTURE, "a record replacing nothing keeps its stamp");
|
|
||||||
assert_eq!(stamps[0], on_disk(&path));
|
|
||||||
assert!(store.push_all(&[envelope_of(&seed, "e", &counter(1), FUTURE)], PushAllOptions { soft: true }).unwrap().is_empty());
|
|
||||||
|
|
||||||
// The cache holds the stamp the store wrote after every write entry.
|
|
||||||
type Write = fn(&mut CultCache) -> ();
|
|
||||||
let writes: [(&str, Write); 5] = [
|
|
||||||
("put", |cache| drop(cache.put("c", &counter(9)).unwrap())),
|
|
||||||
("put_envelope", |cache| {
|
|
||||||
let entry = envelope_of(cache, "c", &counter(9), FUTURE);
|
|
||||||
drop(cache.put_envelope::<Counter>(entry).unwrap())
|
|
||||||
}),
|
|
||||||
("put_raw_envelope", |cache| {
|
|
||||||
let entry = envelope_of(cache, "c", &counter(9), FUTURE);
|
|
||||||
cache.put_raw_envelope(entry).unwrap()
|
|
||||||
}),
|
|
||||||
("put_prepared_batch", |cache| {
|
|
||||||
let entry = envelope_of(cache, "c", &counter(9), FUTURE);
|
|
||||||
cache.put_prepared_batch(vec![entry]).unwrap()
|
|
||||||
}),
|
|
||||||
("update", |cache| drop(cache.update::<Counter, _>("c", |_| Some(counter(9))).unwrap())),
|
|
||||||
];
|
|
||||||
for (name, write) in writes {
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let (path, _) = seeded(&dir);
|
|
||||||
let mut cache = open(&path);
|
|
||||||
write(&mut cache);
|
|
||||||
let held = cache.get_envelope::<Counter>("c").unwrap().unwrap().stored_at;
|
|
||||||
assert!(later_than_future(&held), "{name}: {held}");
|
|
||||||
assert_eq!(held, on_disk(&path), "{name}: the cache holds a stamp the store did not write");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn the_byte_exact_writers_keep_the_callers_stamp() {
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = path_in(&dir);
|
|
||||||
let cache = open(&path);
|
|
||||||
let mut store = SingleFileMessagePackBackingStore::new(&path);
|
|
||||||
let held = envelope_of(&cache, "c", &counter(1), FUTURE);
|
|
||||||
store.push(&held).unwrap();
|
|
||||||
let swapped = envelope_of(&cache, "c", &counter(2), "2026-01-01T00:00:00Z");
|
|
||||||
assert!(store.compare_and_swap_entry(&held, swapped.clone()).unwrap());
|
|
||||||
assert_eq!(store.read("c").unwrap().unwrap().envelope, swapped, "compare_and_swap_entry restamped");
|
|
||||||
|
|
||||||
let redb_path = dir.path().join("store.redb");
|
|
||||||
let mut redb = RedbMessagePackBackingStore::new(&redb_path).unwrap();
|
|
||||||
redb.push(&held).unwrap();
|
|
||||||
let older = envelope_of(&cache, "c", &counter(3), "2026-01-01T00:00:00Z");
|
|
||||||
assert_eq!(redb.push(&older).unwrap(), older.stored_at);
|
|
||||||
assert_eq!(redb.pull_all().unwrap(), vec![older.clone()]);
|
|
||||||
assert_eq!(redb.push_all(std::slice::from_ref(&held), PushAllOptions::default()).unwrap(), vec![held.stored_at.clone()]);
|
|
||||||
assert_eq!(redb.pull_all().unwrap(), vec![held]);
|
|
||||||
}
|
|
||||||
|
|
||||||
/// A single-file store that reports whatever stamp it is told to, as a custom store might.
|
|
||||||
struct ReportingStore {
|
|
||||||
inner: SingleFileMessagePackBackingStore,
|
|
||||||
report: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl CacheBackingStore for ReportingStore {
|
|
||||||
fn pull_all(&self) -> anyhow::Result<Vec<CultCacheEnvelope>> {
|
|
||||||
self.inner.pull_all()
|
|
||||||
}
|
|
||||||
fn push(&mut self, entry: &CultCacheEnvelope) -> anyhow::Result<String> {
|
|
||||||
self.inner.push(entry)?;
|
|
||||||
Ok(self.report.clone())
|
|
||||||
}
|
|
||||||
fn delete(&mut self, entry: &CultCacheEnvelope) -> anyhow::Result<()> {
|
|
||||||
self.inner.delete(entry)
|
|
||||||
}
|
|
||||||
fn push_all(&mut self, entries: &[CultCacheEnvelope], options: PushAllOptions) -> anyhow::Result<Vec<String>> {
|
|
||||||
self.inner.push_all(entries, options)?;
|
|
||||||
Ok(entries.iter().map(|_| self.report.clone()).collect())
|
|
||||||
}
|
|
||||||
fn read(&self, key: &str) -> anyhow::Result<Option<CultStoredRecord>> {
|
|
||||||
self.inner.read(key)
|
|
||||||
}
|
|
||||||
fn commit_if(&mut self, entry: &CultCacheEnvelope, expected: Option<&str>) -> anyhow::Result<CultCommitIf> {
|
|
||||||
Ok(match self.inner.commit_if(entry, expected)? {
|
|
||||||
CultCommitIf::Committed { .. } => CultCommitIf::Committed { stored_at: self.report.clone() },
|
|
||||||
CultCommitIf::Mismatch => CultCommitIf::Mismatch,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn the_cache_holds_a_reported_stamp_only_when_it_parses_as_rfc3339() {
|
|
||||||
type Write = fn(&mut CultCache);
|
|
||||||
let writes: [(&str, Write); 4] = [
|
|
||||||
("put", |cache| drop(cache.put("c", &counter(1)).unwrap())),
|
|
||||||
("put_raw_envelope", |cache| {
|
|
||||||
let entry = envelope_of(cache, "c", &counter(1), "2020-01-01T00:00:00Z");
|
|
||||||
cache.put_raw_envelope(entry).unwrap()
|
|
||||||
}),
|
|
||||||
("put_prepared_batch", |cache| {
|
|
||||||
let entry = envelope_of(cache, "c", &counter(1), "2020-01-01T00:00:00Z");
|
|
||||||
cache.put_prepared_batch(vec![entry]).unwrap()
|
|
||||||
}),
|
|
||||||
("update", |cache| drop(cache.update::<Counter, _>("c", |_| Some(counter(1))).unwrap())),
|
|
||||||
];
|
|
||||||
for (report, parses) in [
|
|
||||||
("2030-01-01T00:00:00Z", true),
|
|
||||||
("2030-01-01T00:00:00.123456+00:00", true),
|
|
||||||
("not a stamp", false),
|
|
||||||
("", false),
|
|
||||||
("2030-01-01", false),
|
|
||||||
("2030-01-01 00:00:00", false),
|
|
||||||
("2030-01-01T00:00:00", false),
|
|
||||||
("1893456000", false),
|
|
||||||
] {
|
|
||||||
for (name, write) in writes {
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = path_in(&dir);
|
|
||||||
let mut cache = CultCache::new();
|
|
||||||
cache.register_entry_type::<Counter>().unwrap();
|
|
||||||
cache
|
|
||||||
.add_generic_backing_store(ReportingStore { inner: SingleFileMessagePackBackingStore::new(&path), report: report.to_string() })
|
|
||||||
.unwrap();
|
|
||||||
cache.pull_all_backing_stores().unwrap();
|
|
||||||
write(&mut cache);
|
|
||||||
let held = cache.get_envelope::<Counter>("c").unwrap().unwrap().stored_at;
|
|
||||||
if parses {
|
|
||||||
assert_eq!(held, report, "{name}");
|
|
||||||
} else {
|
|
||||||
assert_ne!(held, report, "{name} held a stamp that is not RFC 3339");
|
|
||||||
assert!(chrono::DateTime::parse_from_rfc3339(&held).is_ok(), "{name}: {held}");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn a_stamp_with_no_successor_refuses_every_single_file_write_and_writes_nothing() {
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = path_in(&dir);
|
|
||||||
let cache = open(&path);
|
|
||||||
let mut store = SingleFileMessagePackBackingStore::new(&path);
|
|
||||||
let last = "9999-12-31T23:59:59.999999Z";
|
|
||||||
store.push(&envelope_of(&cache, "c", &counter(1), last)).unwrap();
|
|
||||||
let before = file(&path);
|
|
||||||
let version = store.read("c").unwrap().unwrap().version;
|
|
||||||
let next = envelope_of(&cache, "c", &counter(2), "2020-01-01T00:00:00Z");
|
|
||||||
assert!(store.push(&next).is_err());
|
|
||||||
assert!(store.push_all(std::slice::from_ref(&next), PushAllOptions::default()).is_err());
|
|
||||||
assert!(store.commit_if(&next, Some(&version)).is_err());
|
|
||||||
assert_eq!(file(&path), before, "a refused mint wrote");
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn commit_if_refuses_a_retype_as_push_does() {
|
|
||||||
let dir = tempfile::tempdir().unwrap();
|
|
||||||
let path = path_in(&dir);
|
|
||||||
let cache = open(&path);
|
|
||||||
let mut store = SingleFileMessagePackBackingStore::new(&path);
|
|
||||||
let note = envelope_of(&cache, "k", &Note { text: "n".into() }, "2020-01-01T00:00:00Z");
|
|
||||||
store.push(¬e).unwrap();
|
|
||||||
let version = store.read("k").unwrap().unwrap().version;
|
|
||||||
let before = file(&path);
|
|
||||||
let counter_at_k = envelope_of(&cache, "k", &counter(1), "2020-01-01T00:00:00Z");
|
|
||||||
let error = store.commit_if(&counter_at_k, Some(&version)).expect_err("a retype");
|
|
||||||
assert!(error.downcast_ref::<cultcache_rs::SchemaConflictError>().is_some(), "{error:#}");
|
|
||||||
assert!(store.push(&counter_at_k).is_err());
|
|
||||||
assert_eq!(file(&path), before, "a refused retype wrote");
|
|
||||||
assert_eq!(store.read("k").unwrap().unwrap().envelope.r#type, "note");
|
|
||||||
}
|
|
||||||
|
|
@ -5,25 +5,8 @@ All notable changes to `@gamecult/cultcache-ts` are recorded here, following
|
||||||
|
|
||||||
## [Unreleased]
|
## [Unreleased]
|
||||||
|
|
||||||
## [0.16.0] - 2026-11-14
|
|
||||||
|
|
||||||
### Added
|
|
||||||
|
|
||||||
- `isStoredAtStamp(text)` (package and browser entries): whether a `storedAt` is a stamp, the one shape pinned in `tests/vectors/stored-at-stamp/` (an RFC 3339 date-time with `T`, an optional 1 to 9 digit fraction, `Z` or `+hh:mm`/`-hh:mm`, a real calendar date, seconds 00-59, years 0001-9999). cultnet-ts and cultmesh-ts judge a peer's put by it (variants:ruling:raw-put-without-stamp-refused).
|
|
||||||
- `CacheBackingStore` gains the optional `read(key)` (the record at the key with its content version, from one read) and `commitIf(entry, expectedVersion)` (write only if the version still holds, under the store's write lock; returns the storedAt written). The single-file store implements both. The content version is the lowercase hex SHA-256 of the record's persisted encoding `[key, schemaId, storedAt, payload]`, equal to the C# reference's on `tests/vectors/content-version`. A store without them still works for everything except `update`.
|
|
||||||
- `CultCacheUpdateResult` and `CultCacheUpdateOptions` (`maxAttempts`, default 5), exported from the package entry and the browser entry.
|
|
||||||
|
|
||||||
### Changed
|
|
||||||
|
|
||||||
- A write that replaces a record at its key with different content (another schema id or other payload bytes) is stored strictly later than it: a supplied `storedAt` not later than the stored one is written one millisecond after it, so a content version that includes `storedAt` never repeats across writes. A rewrite of identical content (same schema id and payload bytes) keeps the stored stamp and so its version, which is what keeps a periodic flush of an unchanged cache from changing every record's version; C# re-mints every replacing write, so this is a departure from it, and the writer's type and catalog entry are written either way. `push`, `pushAll` and `commitIf` alike; the single-file store's `push` returns the stamp it wrote (`CacheBackingStore.push` may resolve `{ storedAt }`), and `put`, `putGlobal` and `putEnvelope` install that stamp in the cache, so the cache and the file agree after a put over a record stamped at or after now (a push result that is not a parseable stamp is ignored). A stamp that would pass 9999-12-31T23:59:59.999Z is refused with `RangeError` and nothing is written.
|
|
||||||
- `withStoreWriteLock` looks for a link at the store path again once the lock is held, so a link put at the path while a writer waited on the lock is refused with `StoreLinkedError` and the lock released, instead of being replaced. Pinned by a test that puts the link while another holder owns the lock.
|
|
||||||
- `CultCache.isWritable` does not look at store paths: a link at a store path is not predicted, and the write refuses it with `StoreLinkedError`. Pinned by a test through a cache attached to a linked store.
|
|
||||||
|
|
||||||
### Breaking
|
### Breaking
|
||||||
|
|
||||||
- `update` and `updateGlobal` are the conditional golden path and no longer the blind pair. `update(definition, key, apply, options?)` reads the record and its content version from the store, passes `apply` a fresh copy (never the held instance), commits only if the version still holds and runs `apply` again on a lost race, up to `maxAttempts`. `apply` may be async, may return `undefined` to write nothing, and must be free of side effects. It resolves to `{ outcome: "updated" | "declined" | "lostRace", document }` instead of the written value, so a caller reads `result.document`; a lost race that outlasts the attempts is `lostRace`, not a throw. `apply` returning `undefined` or `null` declines. `maxAttempts` is an integer of at least 1; `undefined` is the default 5 and `null` is refused with `RangeError`. A conditional write over a global loaded from a legacy key is refused wherever it enters (`updateGlobal`, or `update` at `CultCache.GLOBAL_KEY`) and leaves the legacy record untouched; `apply` may have run once before the write is refused. A store attached to a store-less cache while `apply` awaits makes that attempt a lost race. It needs a store with `read` and `commitIf` (the single-file store has them); a cache with no store compares the held entry. `put` and `putGlobal` are the blind writes and are unchanged.
|
|
||||||
- A write at a single-file store path that is a symbolic link, live or dangling, is refused with the new `StoreLinkedError` (exported from the package entry; `error.path` names the path) before the lock and the replace, and writes nothing: `push`, `pushAll`, `delete` and a soft flush alike. Before, a write at a live link replaced the link with a regular file, a dangling link failed with `ENOENT` (or, for `pushAll`, was replaced), and a soft flush at a link skipped. A caller catching `ENOENT` around a write at a dangling link now catches `StoreLinkedError`; configure the link's target as the store path. Reads through a live link work. An `lstat` failure other than `ENOENT` (`ENOTDIR`, `EACCES`, `ELOOP`) is rethrown as it is.
|
|
||||||
- `SingleFileMessagePackBackingStore.pushAll` writes the given entries onto the store as it is under the lock, as `push` does: a record under the same key is replaced and no other is removed. It used to replace the whole file with the entries, so `CultMesh.flush()` from a cache that held less than the store (a node created with `pullOnStart: false`, or one whose image was stale) wiped the records it never read. A caller that relied on `pushAll` to reset a store removes the file first. A soft flush is unchanged. `CultCache.storedSnapshot()` is the image as the stores hold it (a global loaded from a legacy key under that key) and is what `CultMesh.flush` persists, so a flush no longer leaves such a global under two keys; `snapshot()` is unchanged.
|
|
||||||
- A single-file store marked `cultcache.store.v3` (it holds an element id, written by the C# runtime) is read, and a rewrite keeps the mark and the ids; this runtime does not decide when a document carries ids. A runtime from before this change refuses a v3 store by name, so rolling back to an older release after a store has been written as v3 is one-way: there is no carry-back, so restore from a copy taken before upgrading.
|
- A single-file store marked `cultcache.store.v3` (it holds an element id, written by the C# runtime) is read, and a rewrite keeps the mark and the ids; this runtime does not decide when a document carries ids. A runtime from before this change refuses a v3 store by name, so rolling back to an older release after a store has been written as v3 is one-way: there is no carry-back, so restore from a copy taken before upgrading.
|
||||||
- `indexes` are unique, as C# `[CultIndex]`: a write or a load that leaves two records of a type holding one non-blank
|
- `indexes` are unique, as C# `[CultIndex]`: a write or a load that leaves two records of a type holding one non-blank
|
||||||
value under one alias is refused naming both keys and the alias, and writes nothing. Index text is the C# canonical
|
value under one alias is refused naming both keys and the alias, and writes nothing. Index text is the C# canonical
|
||||||
|
|
@ -32,21 +15,18 @@ All notable changes to `@gamecult/cultcache-ts` are recorded here, following
|
||||||
the many-row selection aliases (never indexed for lookup, same catalog `indexAlias`). The per-key migration rule is
|
the many-row selection aliases (never indexed for lookup, same catalog `indexAlias`). The per-key migration rule is
|
||||||
in the README; classify every key before the CultLib your tools load is updated. The refusal verdict is the contract, its text is informational.
|
in the README; classify every key before the CultLib your tools load is updated. The refusal verdict is the contract, its text is informational.
|
||||||
- The single-file reader (v1 and the legacy envelope array) refuses a store that holds two records under one key as `StoreUnreadableError`; a store that opened before may now be refused. Repair it by removing the extra record with the runtime that wrote it.
|
- The single-file reader (v1 and the legacy envelope array) refuses a store that holds two records under one key as `StoreUnreadableError`; a store that opened before may now be refused. Repair it by removing the extra record with the runtime that wrote it.
|
||||||
- A `put`, `push` or `pushAll` that would land a second type under a held key (against the file, or within one batch) is refused with `SchemaConflictError`, and nothing is written. The written type may replace the record when its catalog entry carries the stored schema id as its own or lists it compatible (a type renamed under a stable id restamps the record, as C# does, when its payload changes; an identical payload keeps the stamp); otherwise retyping a key is a delete, then a put. The C# allowance for an undeclared older id of the same schema name that reads whole is not ported: a same-named type keeps passing, including one that drops persisted slots, which C# refuses.
|
- A `put`, `push` or `pushAll` that would land a second type under a held key (against the file, or within one batch) is refused with `SchemaConflictError`, and nothing is written. The written type may replace the record when its catalog entry carries the stored schema id as its own or lists it compatible (a type renamed under a stable id restamps the record, as C# does); otherwise retyping a key is a delete, then a put. The C# allowance for an undeclared older id of the same schema name that reads whole is not ported: a same-named type keeps passing, including one that drops persisted slots, which C# refuses.
|
||||||
- Same-type writes replace by key; in one `pushAll` batch the last entry for a key wins.
|
- Same-type writes replace by key; in one `pushAll` batch the last entry for a key wins.
|
||||||
- A store whose canonical-schema catalog slot is not a string is refused as `StoreUnreadableError`.
|
- A store whose canonical-schema catalog slot is not a string is refused as `StoreUnreadableError`.
|
||||||
- The cache holds one record per key (variants:ruling:cache-refuses-retype). A `put` or `putEnvelope` that lands a second type under a key the cache holds, or under a key a store carries foreign, is refused with `SchemaConflictError` naming the key, even with no store (a memory-only cache used to hold both types at the key). A type that owns the held record's schema id (as for the store) replaces it, unless the held record is in a store other than the written type's home: that rename is refused with `SchemaConflictError` (remove the record first). Two stores holding one key, registered or foreign, refuse the load and admit nothing. A store's `delete` removes the record whose stored schema id the removal's type owns, whatever the arrived record's `type` string.
|
- The cache holds one record per key (variants:ruling:cache-refuses-retype). A `put` or `putEnvelope` that lands a second type under a key the cache holds, or under a key a store carries foreign, is refused with `SchemaConflictError` naming the key, even with no store (a memory-only cache used to hold both types at the key). A type that owns the held record's schema id (as for the store) replaces it, unless the held record is in a store other than the written type's home: that rename is refused with `SchemaConflictError` (remove the record first). Two stores holding one key, registered or foreign, refuse the load and admit nothing. A store's `delete` removes the record whose stored schema id the removal's type owns, whatever the arrived record's `type` string.
|
||||||
- A store holding a record no registered type claims now loads (it used to throw "No schema is registered..."): the cache does not serve the record, lists it in `foreignRecords()`, keeps its bytes through every write, and refuses a `put` or a `delete` at its key with `SchemaConflictError` (variants:ruling:unheld-removal-refused-at-commit). Registering a type that claims its schema id serves it at the next `pullAllBackingStores`.
|
- A store holding a record no registered type claims now loads (it used to throw "No schema is registered..."): the cache does not serve the record, lists it in `foreignRecords()`, keeps its bytes through every write, and refuses a `put` or a `delete` at its key with `SchemaConflictError` (variants:ruling:unheld-removal-refused-at-commit). Registering a type that claims its schema id serves it at the next `pullAllBackingStores`.
|
||||||
- A record whose payload carries a slot past its reader's declared slots, at any depth (the record, a nested record, a list element, a union arm, a unit arm), is now held read-only: it loads and reads, and every `put`, `putEnvelope`, `update` or `delete` of its key is refused with `SchemaConflictError` before a store is touched (cultlib-gaps:ruling:extra-trailing-slots, as the C# reference). A load used to skip the extra slots silently and a later write shed them. The refusal names the schema, the key, the type that was read with extra slots and both slot counts, never a slot value, and carries them as `SchemaConflictError.unreadSlots`. An untouched record keeps its bytes through writes of other keys. Missing trailing slots keep their declared defaults and mark nothing. A `put` never marks (the value is encoded by this runtime); a `putEnvelope` of a payload carrying extra slots lands its bytes and holds the record read-only. A mark at depth 0 is consented to only when the record arrived under a schema id other than the reader's own that the reader lists compatible, and that id's catalog entry lists those slots (a writer that adds a slot and keeps the reader's id is never consented to) (`unreadSlots.explained`); every other mark refuses whatever is declared. New: `CultCache.isWritable(definition, key)` (live, advisory), `CultCache.unreadSlots(definition, key)` and the exported `CultCacheUnreadSlots`. Documents with no slot codec (a plain map, a user formatter) never mark. A `delete` is by key: a type that owns the schema id of the record held at the key as another type removes that one record (one store call, the cache dropped once the store has removed it), and a type that does not own it is refused with `SchemaConflictError`, as a `put` is; `isWritable` answers both. Implied semver: a minor bump (0.16.0) while the package is 0.x; a major one at 1.0 and after.
|
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- `checkPayloadDepth` returns the offset where the first value ends, or `undefined` when the payload ends early (a header, a container or a str/bin/scalar body cut short; it was `void`); it still refuses only depth. The bytes-after refusal is internal (`checkPayloadIsOneValue`, not exported); no new public name.
|
|
||||||
- `CultCache.foreignRecords()`: the `{key, schemaId, schemaName, storedAt}` of every record the last pull carried and no registered type claims, sorted by key ordinal.
|
- `CultCache.foreignRecords()`: the `{key, schemaId, schemaName, storedAt}` of every record the last pull carried and no registered type claims, sorted by key ordinal.
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
|
||||||
- A document payload is exactly one MessagePack value (cultlib-gaps:ruling:trailing-bytes-refuse). `decodeDocumentPayload`, the one reader (store loads, `put`/`putEnvelope`, CultNet replication, the provider command), and the inspector refuse bytes after the first value with `document type "T" payload has N bytes after its first MessagePack value.`, counted from the walk's end and never walked or echoed; a payload that ends early stays the decoder's to refuse. The refused set is unchanged; only the text changed (it was `@msgpack`'s `RangeError` "Extra N of M byte(s)" for a plain document and the codec reader's "bytes after its value" for a codec document, and the inspector's preview no longer shows a tail), so code matching either text must match this one. `readWire` reads one value and no longer checks what follows. Stated limit: a definition with its own `formatter` is not walked, so whether its payload is one value is the formatter's. Implied bump: 0.16.0 (pre-1.0 minor, with the Breaking entries above).
|
|
||||||
- Opening a legacy (pre-v1) store is a pure read: payloads that were not bytes are normalized in memory and the
|
- Opening a legacy (pre-v1) store is a pure read: payloads that were not bytes are normalized in memory and the
|
||||||
file is left as it was, so a codec that refuses the content cannot lose the old bytes. The next push, delete or
|
file is left as it was, so a codec that refuses the content cannot lose the old bytes. The next push, delete or
|
||||||
flush rewrites the file as v1, merging what the open read.
|
flush rewrites the file as v1, merging what the open read.
|
||||||
|
|
|
||||||
|
|
@ -49,9 +49,7 @@ through `decodeDocumentPayload`, and when you need the bytes themselves (hashing
|
||||||
write) take them with `documentPayloadBytes`, the sanctioned escape.
|
write) take them with `documentPayloadBytes`, the sanctioned escape.
|
||||||
|
|
||||||
- `decodeDocumentPayload(definition, payload)` reads a payload through the definition's formatter,
|
- `decodeDocumentPayload(definition, payload)` reads a payload through the definition's formatter,
|
||||||
codec or plain map and then its schema. The definition is required. A payload is exactly one
|
codec or plain map and then its schema. The definition is required.
|
||||||
MessagePack value: bytes after the first are refused by count, naming the type, and never walked or
|
|
||||||
echoed (a payload that ends early is the decoder's to refuse).
|
|
||||||
- `encodeDocumentPayload(definition, value)` is the writer: the schema first, then the formatter,
|
- `encodeDocumentPayload(definition, value)` is the writer: the schema first, then the formatter,
|
||||||
codec or plain map.
|
codec or plain map.
|
||||||
- `documentPayloadFromBytes(bytes)` is where bytes enter (a record you validated, a store read, a
|
- `documentPayloadFromBytes(bytes)` is where bytes enter (a record you validated, a store read, a
|
||||||
|
|
@ -168,11 +166,13 @@ const settings = cache.getRequiredGlobal(settingsDocument);
|
||||||
- `getByIndex(...)`
|
- `getByIndex(...)`
|
||||||
- `getGlobal(...)`
|
- `getGlobal(...)`
|
||||||
- `getRequiredGlobal(...)`
|
- `getRequiredGlobal(...)`
|
||||||
- `update(...)` and `updateGlobal(...)`, the conditional golden path: apply a function to a fresh copy of the record as the store holds it, commit only if it is unchanged, re-run on a lost race (`updated`, `declined` or `lostRace`)
|
- `put(...)`
|
||||||
- `put(...)` and `putGlobal(...)`, the blind opt-out: last writer wins
|
- `putGlobal(...)`
|
||||||
|
- `update(...)`
|
||||||
|
- `updateGlobal(...)`
|
||||||
- `delete(...)`
|
- `delete(...)`
|
||||||
- `deleteGlobal(...)`
|
- `deleteGlobal(...)`
|
||||||
- `snapshot()` (the logical image) and `storedSnapshot()` (the image as the stores hold it, for a whole flush)
|
- `snapshot()`
|
||||||
- `getEnvelope(...)`
|
- `getEnvelope(...)`
|
||||||
- `getRequiredEnvelope(...)`
|
- `getRequiredEnvelope(...)`
|
||||||
- `getGlobalEnvelope(...)`
|
- `getGlobalEnvelope(...)`
|
||||||
|
|
@ -327,7 +327,7 @@ If you do not supply one, `CultCacheTS` uses MessagePack plus Zod validation by
|
||||||
|
|
||||||
The 256-container nesting bound (`MAX_PAYLOAD_DEPTH`, refused with `CultCachePayloadDepthError`) covers the MessagePack the
|
The 256-container nesting bound (`MAX_PAYLOAD_DEPTH`, refused with `CultCachePayloadDepthError`) covers the MessagePack the
|
||||||
library itself writes: the default format and a codec. A payload your formatter writes is opaque bytes in any format, so the
|
library itself writes: the default format and a codec. A payload your formatter writes is opaque bytes in any format, so the
|
||||||
library does not walk it as MessagePack; its format, its bounds and whether it is one value are your formatter's.
|
library does not walk it as MessagePack; its format and its bounds are your formatter's.
|
||||||
|
|
||||||
Zod is no longer mandatory. Any schema object with a `parse(...)` function will
|
Zod is no longer mandatory. Any schema object with a `parse(...)` function will
|
||||||
do, which means generated Ajv-backed JSON-schema contracts can feed the cache
|
do, which means generated Ajv-backed JSON-schema contracts can feed the cache
|
||||||
|
|
@ -371,11 +371,8 @@ const sceneDocument = defineDocumentType({
|
||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
- A slot is `[name, codec, default?]`. A gap is written nil and skipped on read; an extra trailing slot is read past and
|
- A slot is `[name, codec, default?]`. A gap is written nil and skipped on read; an extra trailing slot is skipped; a
|
||||||
marks the record read-only (every write or removal of its key is refused with `SchemaConflictError`, `cache.isWritable`
|
slot missing from the payload (or nil, when a default is declared) takes its default, and is refused without one.
|
||||||
asks first). The one writable case is a depth-0 extra slot of a record that arrived under a schema id other than the reader's own, which the
|
|
||||||
reader lists in `compatibleSchemaIds`, whose catalog entry lists those slots: declaring that id consents to the loss, and a write restamps
|
|
||||||
the record. A nested slot, or a writer that keeps the reader's own id, is never consented to. A slot missing from the payload (or nil, when a default is declared) takes its default, and is refused without one.
|
|
||||||
- A union refuses an undeclared arm key on read, naming the union, the key and the declared keys. Nothing falls back
|
- A union refuses an undeclared arm key on read, naming the union, the key and the declared keys. Nothing falls back
|
||||||
to a default arm. An arm with no slots is `codecs.unit` and is written `[key, []]`.
|
to a default arm. An arm with no slots is `codecs.unit` and is written `[key, []]`.
|
||||||
- A refusal names the union, the field and the slot; it never echoes the value it refused.
|
- A refusal names the union, the field and the slot; it never echoes the value it refused.
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
{
|
{
|
||||||
"name": "@gamecult/cultcache-ts",
|
"name": "@gamecult/cultcache-ts",
|
||||||
"version": "0.16.0",
|
"version": "0.15.0",
|
||||||
"description": "CultCache-style typed persistence for TypeScript with schema-backed polymorphic MessagePack storage.",
|
"description": "CultCache-style typed persistence for TypeScript with schema-backed polymorphic MessagePack storage.",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
"types": "dist/index.d.ts",
|
"types": "dist/index.d.ts",
|
||||||
|
|
|
||||||
|
|
@ -16,7 +16,6 @@ export {
|
||||||
} from "./document";
|
} from "./document";
|
||||||
export { CultCachePayloadDepthError, MAX_PAYLOAD_DEPTH } from "./payload-depth";
|
export { CultCachePayloadDepthError, MAX_PAYLOAD_DEPTH } from "./payload-depth";
|
||||||
export type { DocumentPayload } from "./document";
|
export type { DocumentPayload } from "./document";
|
||||||
export { isStoredAtStamp } from "./stored-at";
|
|
||||||
export { SchemaConflictError, StoreUnreadableError } from "./store-format";
|
export { SchemaConflictError, StoreUnreadableError } from "./store-format";
|
||||||
export type {
|
export type {
|
||||||
AnyCultCacheDocumentDefinition,
|
AnyCultCacheDocumentDefinition,
|
||||||
|
|
@ -35,9 +34,6 @@ export type {
|
||||||
CultCacheIndexScalar,
|
CultCacheIndexScalar,
|
||||||
InferCultCacheSchemaValue,
|
InferCultCacheSchemaValue,
|
||||||
CultCacheStoreRegistration,
|
CultCacheStoreRegistration,
|
||||||
CultCacheUnreadSlots,
|
|
||||||
CultCacheUpdateOptions,
|
|
||||||
CultCacheUpdateResult,
|
|
||||||
PushAllOptions,
|
PushAllOptions,
|
||||||
} from "./types";
|
} from "./types";
|
||||||
export type {
|
export type {
|
||||||
|
|
|
||||||
|
|
@ -198,66 +198,6 @@ type SlotSpec<TValue, TName extends string = string> =
|
||||||
|
|
||||||
type SlotsSpec<TValue> = Readonly<Record<number, { [K in keyof TValue & string]: SlotSpec<TValue[K], K> }[keyof TValue & string]>>;
|
type SlotsSpec<TValue> = Readonly<Record<number, { [K in keyof TValue & string]: SlotSpec<TValue[K], K> }[keyof TValue & string]>>;
|
||||||
|
|
||||||
// The slots a payload decode read past, noted by `slots` and the unit arm while the one decode entry (decodeNoting) has a scope
|
|
||||||
// open, and read out by that entry. Module-scoped as the reference's is thread-bound: a decode is synchronous, and a decode
|
|
||||||
// outside the entry (a codec called directly, a CultMesh read) notes nothing. No codec signature carries it.
|
|
||||||
export interface NotedSlots {
|
|
||||||
/** The first type read with extra slots, outermost first. */
|
|
||||||
readonly typeName: string;
|
|
||||||
readonly slotCount: number;
|
|
||||||
readonly declaredCount: number;
|
|
||||||
readonly occurrences: number;
|
|
||||||
/** True when every noted object was the document's own: a union adds no depth, each record or arm inside a field adds one. */
|
|
||||||
readonly depth0Only: boolean;
|
|
||||||
}
|
|
||||||
|
|
||||||
interface SlotScope {
|
|
||||||
depth: number;
|
|
||||||
found?: { typeName: string; slotCount: number; declaredCount: number; occurrences: number; depth0Only: boolean };
|
|
||||||
}
|
|
||||||
|
|
||||||
let scope: SlotScope | undefined;
|
|
||||||
|
|
||||||
/** The one decode entry: runs the decode with a scope open and returns its value with what it noted. */
|
|
||||||
export function decodeNoting<T>(decode: () => T): { value: T; unreadSlots?: NotedSlots } {
|
|
||||||
const outer = scope;
|
|
||||||
const mine: SlotScope = { depth: 0 };
|
|
||||||
scope = mine;
|
|
||||||
try {
|
|
||||||
const value = decode();
|
|
||||||
return mine.found ? { value, unreadSlots: mine.found } : { value };
|
|
||||||
} finally {
|
|
||||||
scope = outer;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function noteExtraSlots(typeName: string, slotCount: number, declaredCount: number): void {
|
|
||||||
if (!scope) return;
|
|
||||||
const found = scope.found;
|
|
||||||
if (found) {
|
|
||||||
found.occurrences += 1;
|
|
||||||
found.depth0Only &&= scope.depth === 0;
|
|
||||||
} else {
|
|
||||||
scope.found = { typeName, slotCount, declaredCount, occurrences: 1, depth0Only: scope.depth === 0 };
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// What a record inside a field reads at: one deeper than the record holding the field.
|
|
||||||
function nested<T>(read: () => T): T {
|
|
||||||
if (!scope) return read();
|
|
||||||
scope.depth += 1;
|
|
||||||
try {
|
|
||||||
return read();
|
|
||||||
} finally {
|
|
||||||
scope.depth -= 1;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// The reference's type name for a mark: the type, not its namespace or the type it is nested in.
|
|
||||||
function simpleTypeName(typeName: string | undefined): string {
|
|
||||||
return typeName === undefined ? "record" : typeName.slice(Math.max(typeName.lastIndexOf("."), typeName.lastIndexOf("+")) + 1);
|
|
||||||
}
|
|
||||||
|
|
||||||
const INT32_MIN = -(2 ** 31);
|
const INT32_MIN = -(2 ** 31);
|
||||||
const INT32_MAX = 2 ** 31 - 1;
|
const INT32_MAX = 2 ** 31 - 1;
|
||||||
|
|
||||||
|
|
@ -292,7 +232,7 @@ function pascalCase(name: string): string {
|
||||||
}
|
}
|
||||||
|
|
||||||
// A positional record: slot `key` holds field `name`. Gaps are written nil and skipped on read, extra trailing slots
|
// A positional record: slot `key` holds field `name`. Gaps are written nil and skipped on read, extra trailing slots
|
||||||
// are read past and noted (decodeNoting): the record that carried them is read-only, never rewritten without them, and a slot missing from the payload takes its declared default or is refused. A default fills only a
|
// are skipped, and a slot missing from the payload takes its declared default or is refused. A default fills only a
|
||||||
// missing trailing slot, never a nil: as in the reference, a nil in a reference slot (string, bytes, record, union,
|
// missing trailing slot, never a nil: as in the reference, a nil in a reference slot (string, bytes, record, union,
|
||||||
// list) reads as null and writes back as nil, so a record the reference wrote re-encodes byte-identical, and a nil in
|
// list) reads as null and writes back as nil, so a record the reference wrote re-encodes byte-identical, and a nil in
|
||||||
// a value slot (int, float, bool) is refused unless the slot is nullable.
|
// a value slot (int, float, bool) is refused unless the slot is nullable.
|
||||||
|
|
@ -341,9 +281,6 @@ export function slots<TValue extends object>(spec: SlotsSpec<TValue>, typeName?:
|
||||||
decode(raw) {
|
decode(raw) {
|
||||||
expect(raw, "an array of slots", Array.isArray(raw));
|
expect(raw, "an array of slots", Array.isArray(raw));
|
||||||
const input = raw as unknown[];
|
const input = raw as unknown[];
|
||||||
if (input.length > length) {
|
|
||||||
noteExtraSlots(simpleTypeName(typeName), input.length, length);
|
|
||||||
}
|
|
||||||
const out: Record<string, unknown> = {};
|
const out: Record<string, unknown> = {};
|
||||||
for (const field of fields) {
|
for (const field of fields) {
|
||||||
const present = field.key < input.length;
|
const present = field.key < input.length;
|
||||||
|
|
@ -354,7 +291,7 @@ export function slots<TValue extends object>(spec: SlotsSpec<TValue>, typeName?:
|
||||||
? defaultOf(field)
|
? defaultOf(field)
|
||||||
: input[field.key] === null && !field.codec.valueType
|
: input[field.key] === null && !field.codec.valueType
|
||||||
? null
|
? null
|
||||||
: at(`${field.name} (slot ${field.key})`, () => nested(() => field.codec.decode(input[field.key])));
|
: at(`${field.name} (slot ${field.key})`, () => field.codec.decode(input[field.key]));
|
||||||
}
|
}
|
||||||
return out as TValue;
|
return out as TValue;
|
||||||
},
|
},
|
||||||
|
|
@ -426,9 +363,6 @@ export function union<TValue extends { kind: string }>(
|
||||||
if (arm === undefined) {
|
if (arm === undefined) {
|
||||||
throw new Error(`Union ${name}: unknown arm key ${key} (declared keys: ${declared}).`);
|
throw new Error(`Union ${name}: unknown arm key ${key} (declared keys: ${declared}).`);
|
||||||
}
|
}
|
||||||
if (arm.body === unit && raw[1].length > 0) {
|
|
||||||
noteExtraSlots(arm.armName, raw[1].length, 0);
|
|
||||||
}
|
|
||||||
const fields = arm.body === unit ? {} : at(`arm ${arm.armName}`, () => (arm.body as SlotsCodec<any>).decode(raw[1]));
|
const fields = arm.body === unit ? {} : at(`arm ${arm.armName}`, () => (arm.body as SlotsCodec<any>).decode(raw[1]));
|
||||||
return { kind: arm.armName, ...fields } as unknown as TValue;
|
return { kind: arm.armName, ...fields } as unknown as TValue;
|
||||||
},
|
},
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
import { decode } from "@msgpack/msgpack";
|
import { decode } from "@msgpack/msgpack";
|
||||||
|
|
||||||
import { checkPayloadDepth, checkPayloadIsOneValue } from "./payload-depth";
|
import { checkPayloadDepth } from "./payload-depth";
|
||||||
import { type StoreFormat, isStoreSnapshot, refuseUnreadStoreBytes, requireStoreSlots, requireV1RecordSlots } from "./store-format";
|
import { type StoreFormat, isStoreSnapshot, refuseUnreadStoreBytes, requireStoreSlots, requireV1RecordSlots } from "./store-format";
|
||||||
|
|
||||||
export interface CultCacheInspection {
|
export interface CultCacheInspection {
|
||||||
|
|
@ -235,22 +235,12 @@ function decodeLegacyEnvelope(value: unknown): InspectedRecord {
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
// The inspector's one payload read: the depth walk first, so a payload past the limit is refused before any decoder sees it,
|
// The inspector's one payload read: the depth walk first, so a payload past the limit is refused before any decoder sees it.
|
||||||
// and bytes after the first value are refused with the shared clause (the tail is never decoded or shown).
|
|
||||||
function decodeBoundedPayload(payload: Uint8Array): unknown {
|
function decodeBoundedPayload(payload: Uint8Array): unknown {
|
||||||
checkPayloadIsOneValue(payload, "document payload");
|
checkPayloadDepth(payload);
|
||||||
return decode(payload);
|
return decode(payload);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Where the first value ends (the whole payload when it ends early or cannot be walked): a preview never shows a tail.
|
|
||||||
function valueEnd(payload: Uint8Array): number {
|
|
||||||
try {
|
|
||||||
return checkPayloadDepth(payload) ?? payload.length;
|
|
||||||
} catch {
|
|
||||||
return payload.length;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function previewPayload(payload: Uint8Array): Pick<InspectedRecord, "payloadPreview" | "payloadDecodeError"> {
|
function previewPayload(payload: Uint8Array): Pick<InspectedRecord, "payloadPreview" | "payloadDecodeError"> {
|
||||||
try {
|
try {
|
||||||
return { payloadPreview: toJsonSafe(decodeBoundedPayload(payload)) };
|
return { payloadPreview: toJsonSafe(decodeBoundedPayload(payload)) };
|
||||||
|
|
@ -258,7 +248,7 @@ function previewPayload(payload: Uint8Array): Pick<InspectedRecord, "payloadPrev
|
||||||
return {
|
return {
|
||||||
payloadPreview: {
|
payloadPreview: {
|
||||||
bytes: payload.length,
|
bytes: payload.length,
|
||||||
hexPrefix: [...payload.slice(0, Math.min(32, valueEnd(payload)))]
|
hexPrefix: [...payload.slice(0, 32)]
|
||||||
.map((value) => value.toString(16).padStart(2, "0"))
|
.map((value) => value.toString(16).padStart(2, "0"))
|
||||||
.join(" "),
|
.join(" "),
|
||||||
},
|
},
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
import {
|
import {
|
||||||
declaresRole,
|
declaresRole,
|
||||||
decodeDocumentPayloadMarked,
|
decodeDocumentPayload,
|
||||||
documentPayloadBytes,
|
documentPayloadBytes,
|
||||||
documentPayloadFromBytes,
|
documentPayloadFromBytes,
|
||||||
encodeDocumentPayload,
|
encodeDocumentPayload,
|
||||||
|
|
@ -8,7 +8,6 @@ import {
|
||||||
schemaIdentityOf,
|
schemaIdentityOf,
|
||||||
} from "./document";
|
} from "./document";
|
||||||
import { resolveDocumentFormatter } from "./document-formatter";
|
import { resolveDocumentFormatter } from "./document-formatter";
|
||||||
import type { NotedSlots } from "./codec";
|
|
||||||
import type { DocumentPayload } from "./document";
|
import type { DocumentPayload } from "./document";
|
||||||
import { SchemaConflictError, schemaIdForEnvelope, writtenOwns } from "./store-format";
|
import { SchemaConflictError, schemaIdForEnvelope, writtenOwns } from "./store-format";
|
||||||
import type {
|
import type {
|
||||||
|
|
@ -21,9 +20,6 @@ import type {
|
||||||
CultCacheEnvelope,
|
CultCacheEnvelope,
|
||||||
CultCacheSchemaCatalogEntry,
|
CultCacheSchemaCatalogEntry,
|
||||||
CultCacheStoreRegistration,
|
CultCacheStoreRegistration,
|
||||||
CultCacheUnreadSlots,
|
|
||||||
CultCacheUpdateOptions,
|
|
||||||
CultCacheUpdateResult,
|
|
||||||
} from "./types";
|
} from "./types";
|
||||||
|
|
||||||
type Accessor = (value: unknown) => string | undefined;
|
type Accessor = (value: unknown) => string | undefined;
|
||||||
|
|
@ -31,7 +27,7 @@ type Accessor = (value: unknown) => string | undefined;
|
||||||
// A registered definition reads and writes its documents through the owner, on payloads the cache has cloned.
|
// A registered definition reads and writes its documents through the owner, on payloads the cache has cloned.
|
||||||
type RegisteredFormatter = {
|
type RegisteredFormatter = {
|
||||||
encode(value: unknown): DocumentPayload;
|
encode(value: unknown): DocumentPayload;
|
||||||
decode(payload: DocumentPayload): { value: unknown; unreadSlots?: NotedSlots };
|
decode(payload: DocumentPayload): unknown;
|
||||||
};
|
};
|
||||||
|
|
||||||
type RegisteredDefinition = {
|
type RegisteredDefinition = {
|
||||||
|
|
@ -50,18 +46,10 @@ type EntryLookups = {
|
||||||
readonly indexes: ReadonlyMap<string, string>;
|
readonly indexes: ReadonlyMap<string, string>;
|
||||||
};
|
};
|
||||||
|
|
||||||
// What a conditional write requires of the record at its key: the content version its store reported (null: no record), or for a
|
|
||||||
// cache with no store the entry it held. Every write installs a new entry object, so the identity catches an A-B-A.
|
|
||||||
type WriteCondition = { readonly version: string | null } | { readonly held: HydratedEntry | undefined };
|
|
||||||
|
|
||||||
type HydratedEntry = CultCacheEnvelope & {
|
type HydratedEntry = CultCacheEnvelope & {
|
||||||
catalogEntry: NonNullable<CultCacheEnvelope["catalogEntry"]>;
|
catalogEntry: NonNullable<CultCacheEnvelope["catalogEntry"]>;
|
||||||
value: unknown;
|
value: unknown;
|
||||||
lookups: EntryLookups;
|
lookups: EntryLookups;
|
||||||
// What the payload decode read past: set when the record was admitted, and it makes the record read-only unless explained.
|
|
||||||
unreadSlots?: CultCacheUnreadSlots;
|
|
||||||
// The schema id the record arrived under, before it was admitted under its reader's: what an unread-slots refusal names.
|
|
||||||
storedSchemaId?: string;
|
|
||||||
};
|
};
|
||||||
|
|
||||||
// Everything a pull replaces. Built whole, then swapped in with one assignment.
|
// Everything a pull replaces. Built whole, then swapped in with one assignment.
|
||||||
|
|
@ -96,20 +84,6 @@ type DerivedTypeLookups = {
|
||||||
readonly indexMaps: Map<string, Map<string, string>>;
|
readonly indexMaps: Map<string, Map<string, string>>;
|
||||||
};
|
};
|
||||||
|
|
||||||
// The consent a compatible-id declaration gives (cultlib-gaps:ruling:slot-mark-consent): a mark is explained only when the record
|
|
||||||
// arrived under an id other than the reader's own that the reader lists compatible, it is at
|
|
||||||
// depth 0 and the schema comparison of the catalog entry the record arrived with against the reader's own reported the slots it
|
|
||||||
// carries as ignored, so its slot count is at most the highest ignored slot plus one. A record written or put through the cache
|
|
||||||
// arrives under the reader's own entry, which ignores nothing, so no mark of it is explained.
|
|
||||||
function explainedBy(noted: NotedSlots, reader: CultCacheSchemaCatalogEntry, arrivedId: string, arrived: CultCacheSchemaCatalogEntry | undefined): boolean {
|
|
||||||
if (arrivedId === reader.schemaId || !(reader.compatibleSchemaIds ?? []).includes(arrivedId)) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
const declared = new Set((reader.members ?? []).map((member) => member.slot));
|
|
||||||
const ignored = (arrived?.members ?? []).map((member) => member.slot).filter((slot) => !declared.has(slot));
|
|
||||||
return noted.depth0Only && noted.slotCount <= Math.max(-1, ...ignored) + 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
function emptyHydratedState(): HydratedState {
|
function emptyHydratedState(): HydratedState {
|
||||||
return {
|
return {
|
||||||
entries: new Map(),
|
entries: new Map(),
|
||||||
|
|
@ -308,88 +282,85 @@ export class CultCache {
|
||||||
// HydratedState, running every check and every user accessor, and replaces the cache's state
|
// HydratedState, running every check and every user accessor, and replaces the cache's state
|
||||||
// in one assignment only once the build finishes. A refused load admits nothing.
|
// in one assignment only once the build finishes. A refused load admits nothing.
|
||||||
pullAllBackingStores(): Promise<void> {
|
pullAllBackingStores(): Promise<void> {
|
||||||
return this.#serial(() => this.#pullNow());
|
return this.#serial(async () => {
|
||||||
}
|
const next = emptyHydratedState();
|
||||||
|
const persistedGlobalKeys = new Map<string, string>();
|
||||||
|
|
||||||
// The pull itself, for a caller already inside a serial operation.
|
for (const registration of this.#stores) {
|
||||||
async #pullNow(): Promise<void> {
|
const entries = await registration.store.pullAll();
|
||||||
const next = emptyHydratedState();
|
|
||||||
const persistedGlobalKeys = new Map<string, string>();
|
|
||||||
|
|
||||||
for (const registration of this.#stores) {
|
for (const entry of entries) {
|
||||||
const entries = await registration.store.pullAll();
|
const registered = this.#resolveDefinitionForEnvelope(entry);
|
||||||
|
if (!registered) {
|
||||||
|
// A store may hold what this cache has no type for; it is carried, not served, and not a reason to refuse the load.
|
||||||
|
next.foreign.push({
|
||||||
|
key: entry.key,
|
||||||
|
schemaId: schemaIdForEnvelope(entry),
|
||||||
|
schemaName: entry.catalogEntry?.schemaName ?? entry.type,
|
||||||
|
storedAt: entry.storedAt,
|
||||||
|
});
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
for (const entry of entries) {
|
const type = registered.definition.type;
|
||||||
const registered = this.#resolveDefinitionForEnvelope(entry);
|
const home = this.#resolveRegistration(type);
|
||||||
if (!registered) {
|
if (home?.store !== registration.store) {
|
||||||
// A store may hold what this cache has no type for; it is carried, not served, and not a reason to refuse the load.
|
|
||||||
next.foreign.push({
|
|
||||||
key: entry.key,
|
|
||||||
schemaId: schemaIdForEnvelope(entry),
|
|
||||||
schemaName: entry.catalogEntry?.schemaName ?? entry.type,
|
|
||||||
storedAt: entry.storedAt,
|
|
||||||
});
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
const type = registered.definition.type;
|
|
||||||
const home = this.#resolveRegistration(type);
|
|
||||||
if (home?.store !== registration.store) {
|
|
||||||
throw new Error(
|
|
||||||
`CultCache "${type}" record "${entry.key}" was loaded from ${this.#describe(registration)}, ` +
|
|
||||||
`but its home is ${this.#describe(home)}.`,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
const payload = this.#cloneBytes(entry.payload);
|
|
||||||
const { value, unreadSlots } = registered.formatter.decode(payload);
|
|
||||||
let admitted: CultCacheEnvelope = { ...entry, type, payload };
|
|
||||||
if (registered.global) {
|
|
||||||
const persistedKey = persistedGlobalKeys.get(type);
|
|
||||||
if (persistedKey !== undefined) {
|
|
||||||
throw new Error(
|
throw new Error(
|
||||||
`CultCache global document type "${type}" has multiple persisted entries: "${persistedKey}" and "${entry.key}".`,
|
`CultCache "${type}" record "${entry.key}" was loaded from ${this.#describe(registration)}, ` +
|
||||||
|
`but its home is ${this.#describe(home)}.`,
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
persistedGlobalKeys.set(type, entry.key);
|
|
||||||
if (entry.key !== CultCache.GLOBAL_KEY) {
|
const payload = this.#cloneBytes(entry.payload);
|
||||||
next.legacyGlobals.set(type, admitted);
|
const value = registered.formatter.decode(payload);
|
||||||
admitted = { ...admitted, key: CultCache.GLOBAL_KEY };
|
let admitted: CultCacheEnvelope = { ...entry, type, payload };
|
||||||
|
if (registered.global) {
|
||||||
|
const persistedKey = persistedGlobalKeys.get(type);
|
||||||
|
if (persistedKey !== undefined) {
|
||||||
|
throw new Error(
|
||||||
|
`CultCache global document type "${type}" has multiple persisted entries: "${persistedKey}" and "${entry.key}".`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
persistedGlobalKeys.set(type, entry.key);
|
||||||
|
if (entry.key !== CultCache.GLOBAL_KEY) {
|
||||||
|
next.legacyGlobals.set(type, admitted);
|
||||||
|
admitted = { ...admitted, key: CultCache.GLOBAL_KEY };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
const hydrated = this.#admitEntry(next, registered, admitted, value);
|
||||||
|
const other = this.#heldUnderOtherType(next, type, hydrated.key);
|
||||||
|
if (other !== undefined) {
|
||||||
|
throw new Error(`Record ${hydrated.key} is held by two stores, as type "${other.type}" and as type "${type}".`);
|
||||||
|
}
|
||||||
|
this.#installEntry(next, registered, hydrated);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const foreignByKey = new Map<string, string>();
|
||||||
|
for (const record of next.foreign) {
|
||||||
|
const first = foreignByKey.get(record.key);
|
||||||
|
if (first !== undefined) {
|
||||||
|
throw new Error(`Record ${record.key} is held by two stores, as schema "${first}" and as schema "${record.schemaName}".`);
|
||||||
|
}
|
||||||
|
foreignByKey.set(record.key, record.schemaName);
|
||||||
|
const other = [...this.#definitions.keys()].map((type) => next.entries.get(this.#entryId(type, record.key))).find((held) => held !== undefined);
|
||||||
|
if (other !== undefined) {
|
||||||
|
throw new Error(`Record ${record.key} is held by two stores, as type "${other.type}" and as schema "${record.schemaName}".`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Judged whole, once: the refusal names the least violation of the state this load would leave, whatever the
|
||||||
|
// order of the stores and of the entries in them.
|
||||||
|
refuseLeastIndexSharing(function* () {
|
||||||
|
for (const entry of next.entries.values()) {
|
||||||
|
for (const [alias, value] of entry.lookups.indexes) {
|
||||||
|
yield { type: entry.type, schemaName: entry.catalogEntry.schemaName, alias, value, key: entry.key };
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
const hydrated = this.#admitEntry(next, registered, admitted, value, unreadSlots);
|
}());
|
||||||
const other = this.#heldUnderOtherType(next, type, hydrated.key);
|
|
||||||
if (other !== undefined) {
|
|
||||||
throw new Error(`Record ${hydrated.key} is held by two stores, as type "${other.type}" and as type "${type}".`);
|
|
||||||
}
|
|
||||||
this.#installEntry(next, registered, hydrated);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const foreignByKey = new Map<string, string>();
|
this.#hydrated = next;
|
||||||
for (const record of next.foreign) {
|
});
|
||||||
const first = foreignByKey.get(record.key);
|
|
||||||
if (first !== undefined) {
|
|
||||||
throw new Error(`Record ${record.key} is held by two stores, as schema "${first}" and as schema "${record.schemaName}".`);
|
|
||||||
}
|
|
||||||
foreignByKey.set(record.key, record.schemaName);
|
|
||||||
const other = [...this.#definitions.keys()].map((type) => next.entries.get(this.#entryId(type, record.key))).find((held) => held !== undefined);
|
|
||||||
if (other !== undefined) {
|
|
||||||
throw new Error(`Record ${record.key} is held by two stores, as type "${other.type}" and as schema "${record.schemaName}".`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Judged whole, once: the refusal names the least violation of the state this load would leave, whatever the
|
|
||||||
// order of the stores and of the entries in them.
|
|
||||||
refuseLeastIndexSharing(function* () {
|
|
||||||
for (const entry of next.entries.values()) {
|
|
||||||
for (const [alias, value] of entry.lookups.indexes) {
|
|
||||||
yield { type: entry.type, schemaName: entry.catalogEntry.schemaName, alias, value, key: entry.key };
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}());
|
|
||||||
|
|
||||||
this.#hydrated = next;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
get<TDefinition extends AnyCultCacheDocumentDefinition>(
|
get<TDefinition extends AnyCultCacheDocumentDefinition>(
|
||||||
|
|
@ -522,16 +493,12 @@ export class CultCache {
|
||||||
return key ? this.get(definition, key) : undefined;
|
return key ? this.get(definition, key) : undefined;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* The blind write: the record at the key becomes `value`, whatever it held, and the last writer wins. `update` is the
|
|
||||||
* conditional path, which changes a record from what the store holds now and re-runs on a lost race.
|
|
||||||
*/
|
|
||||||
put<TDefinition extends AnyCultCacheDocumentDefinition>(
|
put<TDefinition extends AnyCultCacheDocumentDefinition>(
|
||||||
definition: TDefinition,
|
definition: TDefinition,
|
||||||
key: string,
|
key: string,
|
||||||
value: CultCacheDocumentValue<TDefinition>,
|
value: CultCacheDocumentValue<TDefinition>,
|
||||||
): Promise<CultCacheDocumentValue<TDefinition>> {
|
): Promise<CultCacheDocumentValue<TDefinition>> {
|
||||||
return this.#serial(async () => (await this.#putNow(definition, key, value)).value);
|
return this.#serial(() => this.#putNow(definition, key, value));
|
||||||
}
|
}
|
||||||
|
|
||||||
putEnvelope<TDefinition extends AnyCultCacheDocumentDefinition>(
|
putEnvelope<TDefinition extends AnyCultCacheDocumentDefinition>(
|
||||||
|
|
@ -551,9 +518,10 @@ export class CultCache {
|
||||||
if (!envelope.storedAt || envelope.storedAt.trim().length === 0) {
|
if (!envelope.storedAt || envelope.storedAt.trim().length === 0) {
|
||||||
throw new Error(`CultCache envelope storedAt for type "${definition.type}" must be non-empty.`);
|
throw new Error(`CultCache envelope storedAt for type "${definition.type}" must be non-empty.`);
|
||||||
}
|
}
|
||||||
|
this.#requireGlobalKey(registered, envelope.key);
|
||||||
|
|
||||||
const payload = this.#cloneBytes(envelope.payload);
|
const payload = this.#cloneBytes(envelope.payload);
|
||||||
const { value: parsed, unreadSlots } = registered.formatter.decode(payload) as { value: CultCacheDocumentValue<TDefinition>; unreadSlots?: NotedSlots };
|
const parsed = registered.formatter.decode(payload) as CultCacheDocumentValue<TDefinition>;
|
||||||
const entry: CultCacheEnvelope = {
|
const entry: CultCacheEnvelope = {
|
||||||
key: envelope.key,
|
key: envelope.key,
|
||||||
type: envelope.type,
|
type: envelope.type,
|
||||||
|
|
@ -564,7 +532,7 @@ export class CultCache {
|
||||||
schemaId: registered.catalogEntry.schemaId,
|
schemaId: registered.catalogEntry.schemaId,
|
||||||
catalogEntry: registered.catalogEntry,
|
catalogEntry: registered.catalogEntry,
|
||||||
};
|
};
|
||||||
await this.#writeNow(registered, entry, parsed, unreadSlots);
|
await this.#writeNow(registered, entry, parsed);
|
||||||
return parsed;
|
return parsed;
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
@ -573,68 +541,31 @@ export class CultCache {
|
||||||
definition: TDefinition,
|
definition: TDefinition,
|
||||||
value: CultCacheDocumentValue<TDefinition>,
|
value: CultCacheDocumentValue<TDefinition>,
|
||||||
): Promise<CultCacheDocumentValue<TDefinition>> {
|
): Promise<CultCacheDocumentValue<TDefinition>> {
|
||||||
return this.#serial(async () => {
|
return this.#serial(() => {
|
||||||
this.#requireGlobal(definition);
|
this.#requireGlobal(definition);
|
||||||
return (await this.#putNow(definition, CultCache.GLOBAL_KEY, value)).value;
|
return this.#putNow(definition, CultCache.GLOBAL_KEY, value);
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
update<TDefinition extends AnyCultCacheDocumentDefinition>(
|
||||||
* Changes the record at the key from what the store holds now. `apply` may run up to `maxAttempts` times (default 5): each
|
|
||||||
* attempt gets a fresh copy of the record as the store holds it (undefined when absent), which it may change and return, and
|
|
||||||
* the result is written only if the record is still that version; a lost race runs `apply` again on the newer record. It must
|
|
||||||
* not write this cache or have side effects. Returning undefined writes nothing (`declined`). A lost race that outlasts
|
|
||||||
* `maxAttempts` returns `lostRace` and does not throw; a refusal, or a throw from `apply`, rejects and is not retried. The
|
|
||||||
* write is durable when the promise resolves. `document` is the cache's record after the outcome. `put` is the blind write.
|
|
||||||
*/
|
|
||||||
async update<TDefinition extends AnyCultCacheDocumentDefinition>(
|
|
||||||
definition: TDefinition,
|
definition: TDefinition,
|
||||||
key: string,
|
key: string,
|
||||||
apply: (
|
updater: (
|
||||||
current: CultCacheDocumentValue<TDefinition> | undefined,
|
current: CultCacheDocumentValue<TDefinition> | undefined,
|
||||||
) => CultCacheDocumentValue<TDefinition> | undefined | Promise<CultCacheDocumentValue<TDefinition> | undefined>,
|
) => CultCacheDocumentValue<TDefinition>,
|
||||||
options: CultCacheUpdateOptions = {},
|
): Promise<CultCacheDocumentValue<TDefinition>> {
|
||||||
): Promise<CultCacheUpdateResult<CultCacheDocumentValue<TDefinition>>> {
|
return this.#serial(() => this.#putNow(definition, key, updater(this.get(definition, key))));
|
||||||
if (typeof apply !== "function") {
|
|
||||||
throw new TypeError("CultCache update needs a function to apply.");
|
|
||||||
}
|
|
||||||
// undefined is the default; anything else must be an integer of at least 1, so null is refused.
|
|
||||||
const maxAttempts = options.maxAttempts === undefined ? 5 : options.maxAttempts;
|
|
||||||
if (!Number.isInteger(maxAttempts) || maxAttempts < 1) {
|
|
||||||
throw new RangeError(`CultCache update maxAttempts must be an integer of at least 1, not ${String(maxAttempts)}.`);
|
|
||||||
}
|
|
||||||
|
|
||||||
for (let attempt = 1; ; attempt++) {
|
|
||||||
const { expected, copy } = await this.#serial(() => this.#readForUpdate(definition, key));
|
|
||||||
// Outside the serial queue and the store's lock: apply may await, and may write this cache through other keys.
|
|
||||||
const next = await apply(copy as CultCacheDocumentValue<TDefinition> | undefined);
|
|
||||||
if (next === undefined || next === null) {
|
|
||||||
return { outcome: "declined", document: this.get(definition, key) };
|
|
||||||
}
|
|
||||||
const written = await this.#serial(() => this.#putNow(definition, key, next, expected));
|
|
||||||
if (written.outcome === "committed") {
|
|
||||||
return { outcome: "updated", document: this.get(definition, key) as CultCacheDocumentValue<TDefinition> };
|
|
||||||
}
|
|
||||||
if (attempt === maxAttempts) {
|
|
||||||
// Display only. A cache with no store has nothing to pull, and a pull would replace what it holds with nothing.
|
|
||||||
if (this.#stores.length > 0) {
|
|
||||||
await this.#serial(() => this.#pullNow());
|
|
||||||
}
|
|
||||||
return { outcome: "lostRace", document: this.get(definition, key) };
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/** `update` of the type's global record. */
|
updateGlobal<TDefinition extends AnyCultCacheDocumentDefinition>(
|
||||||
async updateGlobal<TDefinition extends AnyCultCacheDocumentDefinition>(
|
|
||||||
definition: TDefinition,
|
definition: TDefinition,
|
||||||
apply: (
|
updater: (
|
||||||
current: CultCacheDocumentValue<TDefinition> | undefined,
|
current: CultCacheDocumentValue<TDefinition> | undefined,
|
||||||
) => CultCacheDocumentValue<TDefinition> | undefined | Promise<CultCacheDocumentValue<TDefinition> | undefined>,
|
) => CultCacheDocumentValue<TDefinition>,
|
||||||
options: CultCacheUpdateOptions = {},
|
): Promise<CultCacheDocumentValue<TDefinition>> {
|
||||||
): Promise<CultCacheUpdateResult<CultCacheDocumentValue<TDefinition>>> {
|
return this.#serial(() =>
|
||||||
this.#requireGlobal(definition);
|
this.#putNow(definition, CultCache.GLOBAL_KEY, updater(this.getGlobal(definition))),
|
||||||
return this.update(definition, CultCache.GLOBAL_KEY, apply, options);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
delete<TDefinition extends AnyCultCacheDocumentDefinition>(
|
delete<TDefinition extends AnyCultCacheDocumentDefinition>(
|
||||||
|
|
@ -654,30 +585,6 @@ export class CultCache {
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/** What the record's payload carried past this build's declared slots, or undefined: the held record is read-only unless `explained`. */
|
|
||||||
unreadSlots(definition: AnyCultCacheDocumentDefinition, key: string): CultCacheUnreadSlots | undefined {
|
|
||||||
return this.#hydrated.entries.get(this.#entryId(this.#requireDefinition(definition).definition.type, key))?.unreadSlots;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Whether a write of the record's own type at the key would be let through: it asks the judge #writeNow asks, of the record the
|
|
||||||
* cache holds (a key a store carries foreign, a record of another type the write does not own or cannot replace, a global at
|
|
||||||
* another key, a record carrying unread slots nothing consents to). It answers the WRITE form. A removal asks the judge's
|
|
||||||
* removal form and differs in two states: an owner's `delete` of a record held in another store than its own home succeeds
|
|
||||||
* where this is false (a write would push to the wrong store), and `delete` of a global type at a key other than __global__ is
|
|
||||||
* the plain false of an unheld key where this is false. It does not look at store paths: a link at a store path is not predicted, and
|
|
||||||
* the write refuses it with `StoreLinkedError`. Live and advisory: the write or removal still decides.
|
|
||||||
*/
|
|
||||||
isWritable(definition: AnyCultCacheDocumentDefinition, key: string): boolean {
|
|
||||||
const registered = this.#requireDefinition(definition);
|
|
||||||
try {
|
|
||||||
this.#judge(registered, key, this.#probe(registered, key));
|
|
||||||
return true;
|
|
||||||
} catch {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// What the last pull found that no registered type claims, by key ordinal. A later registration claims a record at the next pull.
|
// What the last pull found that no registered type claims, by key ordinal. A later registration claims a record at the next pull.
|
||||||
foreignRecords(): readonly CultCacheForeignRecord[] {
|
foreignRecords(): readonly CultCacheForeignRecord[] {
|
||||||
return [...this.#hydrated.foreign].sort((left, right) => compareOrdinal(left.key, right.key));
|
return [...this.#hydrated.foreign].sort((left, right) => compareOrdinal(left.key, right.key));
|
||||||
|
|
@ -687,13 +594,6 @@ export class CultCache {
|
||||||
return [...this.#hydrated.entries.values()].map((entry) => this.#toEnvelope(entry));
|
return [...this.#hydrated.entries.values()].map((entry) => this.#toEnvelope(entry));
|
||||||
}
|
}
|
||||||
|
|
||||||
// The image as the stores hold it, for persisting it whole (a flush): a global loaded from a legacy key is handed out under
|
|
||||||
// that key until its first write retires it, so a flush cannot leave the store holding it under two keys. `snapshot` is the
|
|
||||||
// logical image and always names a global by CultCache.GLOBAL_KEY.
|
|
||||||
storedSnapshot(): CultCacheEnvelope[] {
|
|
||||||
return [...this.#hydrated.entries.values()].map((entry) => this.#hydrated.legacyGlobals.get(entry.type) ?? this.#toEnvelope(entry));
|
|
||||||
}
|
|
||||||
|
|
||||||
#registerNow(definition: AnyCultCacheDocumentDefinition): void {
|
#registerNow(definition: AnyCultCacheDocumentDefinition): void {
|
||||||
// Every registration refusal is a SchemaConflictError naming the new definition's schema id and both schema names.
|
// Every registration refusal is a SchemaConflictError naming the new definition's schema id and both schema names.
|
||||||
const refuse = (holder: RegisteredDefinition, claimed: CultCacheSchemaCatalogEntry, what: string) =>
|
const refuse = (holder: RegisteredDefinition, claimed: CultCacheSchemaCatalogEntry, what: string) =>
|
||||||
|
|
@ -774,58 +674,15 @@ export class CultCache {
|
||||||
this.#stores.push(candidate);
|
this.#stores.push(candidate);
|
||||||
}
|
}
|
||||||
|
|
||||||
// One attempt's read for update: the record at the key as its home holds it now, the condition a commit must meet, and a copy of
|
|
||||||
// the record for apply to change. A store-backed cache asks its store, which reports the record and its version from one read;
|
|
||||||
// a cache with no store has only the held entry, whose identity is the condition and whose admitted payload is the copy.
|
|
||||||
async #readForUpdate(
|
|
||||||
definition: AnyCultCacheDocumentDefinition,
|
|
||||||
key: string,
|
|
||||||
): Promise<{ expected: WriteCondition; copy: unknown }> {
|
|
||||||
const registered = this.#requireDefinition(definition);
|
|
||||||
this.#requireGlobalKey(registered, key);
|
|
||||||
const type = definition.type;
|
|
||||||
this.#refuseLegacyConditional(type);
|
|
||||||
const home = this.#homeStore(type);
|
|
||||||
if (home === undefined) {
|
|
||||||
const held = this.#hydrated.entries.get(this.#entryId(type, key));
|
|
||||||
if (held === undefined && this.#heldUnderOtherType(this.#hydrated, type, key) !== undefined) {
|
|
||||||
throw new Error(`Record ${key} is not a "${type}"; update cannot copy it.`);
|
|
||||||
}
|
|
||||||
return { expected: { held }, copy: held ? registered.formatter.decode(this.#cloneBytes(held.payload)).value : undefined };
|
|
||||||
}
|
|
||||||
if (home.read === undefined || home.commitIf === undefined) {
|
|
||||||
throw new Error(`CultCache backing store for type "${type}" cannot write conditionally; update needs a store with read and commitIf.`);
|
|
||||||
}
|
|
||||||
const found = await home.read(key);
|
|
||||||
if (found === undefined) {
|
|
||||||
return { expected: { version: null }, copy: undefined };
|
|
||||||
}
|
|
||||||
if (this.#resolveDefinitionForEnvelope(found.envelope) !== registered) {
|
|
||||||
throw new Error(`Record ${key} is not a "${type}"; update cannot copy it.`);
|
|
||||||
}
|
|
||||||
return { expected: { version: found.version }, copy: registered.formatter.decode(this.#cloneBytes(found.envelope.payload)).value };
|
|
||||||
}
|
|
||||||
|
|
||||||
#putNow<TDefinition extends AnyCultCacheDocumentDefinition>(
|
|
||||||
definition: TDefinition,
|
|
||||||
key: string,
|
|
||||||
value: CultCacheDocumentValue<TDefinition>,
|
|
||||||
): Promise<{ outcome: "committed"; value: CultCacheDocumentValue<TDefinition> }>;
|
|
||||||
#putNow<TDefinition extends AnyCultCacheDocumentDefinition>(
|
|
||||||
definition: TDefinition,
|
|
||||||
key: string,
|
|
||||||
value: CultCacheDocumentValue<TDefinition>,
|
|
||||||
expected: WriteCondition,
|
|
||||||
): Promise<{ outcome: "committed"; value: CultCacheDocumentValue<TDefinition> } | { outcome: "mismatch" }>;
|
|
||||||
async #putNow<TDefinition extends AnyCultCacheDocumentDefinition>(
|
async #putNow<TDefinition extends AnyCultCacheDocumentDefinition>(
|
||||||
definition: TDefinition,
|
definition: TDefinition,
|
||||||
key: string,
|
key: string,
|
||||||
value: CultCacheDocumentValue<TDefinition>,
|
value: CultCacheDocumentValue<TDefinition>,
|
||||||
expected?: WriteCondition,
|
): Promise<CultCacheDocumentValue<TDefinition>> {
|
||||||
): Promise<{ outcome: "committed"; value: CultCacheDocumentValue<TDefinition> } | { outcome: "mismatch" }> {
|
|
||||||
const registered = this.#requireDefinition(definition);
|
const registered = this.#requireDefinition(definition);
|
||||||
|
this.#requireGlobalKey(registered, key);
|
||||||
const payload = registered.formatter.encode(value);
|
const payload = registered.formatter.encode(value);
|
||||||
const { value: parsed, unreadSlots } = registered.formatter.decode(payload) as { value: CultCacheDocumentValue<TDefinition>; unreadSlots?: NotedSlots };
|
const parsed = registered.formatter.decode(payload) as CultCacheDocumentValue<TDefinition>;
|
||||||
const entry: CultCacheEnvelope = {
|
const entry: CultCacheEnvelope = {
|
||||||
key,
|
key,
|
||||||
type: definition.type,
|
type: definition.type,
|
||||||
|
|
@ -834,55 +691,29 @@ export class CultCache {
|
||||||
schemaId: registered.catalogEntry.schemaId,
|
schemaId: registered.catalogEntry.schemaId,
|
||||||
catalogEntry: registered.catalogEntry,
|
catalogEntry: registered.catalogEntry,
|
||||||
};
|
};
|
||||||
const outcome = await this.#writeNow(registered, entry, parsed, unreadSlots, expected);
|
await this.#writeNow(registered, entry, parsed);
|
||||||
return outcome === "committed" ? { outcome, value: parsed } : { outcome };
|
return parsed;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Validates the whole write (home, global singleton, name and index accessors) before the store
|
// Validates the whole write (home, global singleton, name and index accessors) before the store
|
||||||
// is touched; once the store accepts, applying to the cache has no fallible step.
|
// is touched; once the store accepts, applying to the cache has no fallible step.
|
||||||
// With a condition, the write lands only if the record at the key is still the one the caller read: the store's version
|
async #writeNow(registered: RegisteredDefinition, entry: CultCacheEnvelope, value: unknown): Promise<void> {
|
||||||
// (commitIf), or for a cache with no store the held entry itself. Otherwise nothing is written or installed and the answer is
|
|
||||||
// "mismatch". Without one the write is blind, as put's.
|
|
||||||
async #writeNow(
|
|
||||||
registered: RegisteredDefinition,
|
|
||||||
entry: CultCacheEnvelope,
|
|
||||||
value: unknown,
|
|
||||||
unreadSlots?: NotedSlots,
|
|
||||||
expected?: WriteCondition,
|
|
||||||
): Promise<"committed" | "mismatch"> {
|
|
||||||
const home = this.#homeStore(entry.type);
|
const home = this.#homeStore(entry.type);
|
||||||
const retyped = this.#judge(registered, entry.key, entry);
|
const retyped = this.#refuseRetype(entry);
|
||||||
const hydrated = this.#admitEntry(this.#hydrated, registered, entry, value, unreadSlots);
|
if (retyped !== undefined && this.#homeStore(retyped.type) !== home) {
|
||||||
|
// The write owns the held record's id and would replace it, but the held record is in another store; the push
|
||||||
|
// reaches only this type's home, so the old record would stay in its own file and load as a second holder.
|
||||||
|
throw new SchemaConflictError(
|
||||||
|
schemaIdForEnvelope(entry),
|
||||||
|
[retyped.type, entry.type],
|
||||||
|
entry.key,
|
||||||
|
`CultCache holds record "${entry.key}" as type "${retyped.type}" in another store than the home of type "${entry.type}", so the rename cannot replace it; remove the record first.`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
const hydrated = this.#admitEntry(this.#hydrated, registered, entry, value);
|
||||||
this.#refuseIndexSharing(this.#hydrated, entry.type, registered.catalogEntry.schemaName, entry.key, hydrated.lookups);
|
this.#refuseIndexSharing(this.#hydrated, entry.type, registered.catalogEntry.schemaName, entry.key, hydrated.lookups);
|
||||||
const legacy = this.#hydrated.legacyGlobals.get(entry.type);
|
const legacy = this.#hydrated.legacyGlobals.get(entry.type);
|
||||||
// A conditional write over a legacy global is refused here too (a pull while apply awaited can have loaded one): the condition
|
await home?.push(entry);
|
||||||
// was read from the global's own key, the record sits under its legacy key, and the retire below would delete it unseen.
|
|
||||||
if (expected !== undefined) {
|
|
||||||
this.#refuseLegacyConditional(entry.type);
|
|
||||||
}
|
|
||||||
if (expected !== undefined && "held" in expected) {
|
|
||||||
// The condition was fixed at read for a cache with no store. A store attached since has its own record at the key that
|
|
||||||
// this read never saw, so the held identity no longer judges the write: lose the race and read again.
|
|
||||||
if (home !== undefined || this.#hydrated.entries.get(this.#entryId(entry.type, entry.key)) !== expected.held) {
|
|
||||||
return "mismatch";
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if (expected !== undefined && "version" in expected) {
|
|
||||||
if (home?.commitIf === undefined) {
|
|
||||||
throw new Error(`CultCache backing store for type "${entry.type}" cannot write conditionally; update needs a store with read and commitIf.`);
|
|
||||||
}
|
|
||||||
const committed = await home.commitIf(entry, expected.version);
|
|
||||||
if (committed.outcome === "mismatch") {
|
|
||||||
return "mismatch";
|
|
||||||
}
|
|
||||||
hydrated.storedAt = committed.storedAt;
|
|
||||||
} else {
|
|
||||||
// A store that re-stamps a write (storedAt later than the record it replaces) reports the stamp; the cache holds that one.
|
|
||||||
const pushed = await home?.push(entry);
|
|
||||||
if (typeof pushed === "object" && pushed !== null && typeof pushed.storedAt === "string" && !Number.isNaN(Date.parse(pushed.storedAt))) {
|
|
||||||
hydrated.storedAt = pushed.storedAt;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if (home && legacy) {
|
if (home && legacy) {
|
||||||
await this.#retireLegacyGlobal(home, legacy, entry);
|
await this.#retireLegacyGlobal(home, legacy, entry);
|
||||||
}
|
}
|
||||||
|
|
@ -892,96 +723,6 @@ export class CultCache {
|
||||||
this.#removeEntry(this.#hydrated, this.#definitions.get(retyped.type)!, retyped);
|
this.#removeEntry(this.#hydrated, this.#definitions.get(retyped.type)!, retyped);
|
||||||
}
|
}
|
||||||
this.#installEntry(this.#hydrated, registered, hydrated);
|
this.#installEntry(this.#hydrated, registered, hydrated);
|
||||||
return "committed";
|
|
||||||
}
|
|
||||||
|
|
||||||
// The one rule that a conditional write (update, whichever entry reaches it) never touches a global loaded from a legacy key:
|
|
||||||
// only putGlobal retires that key. Asked before apply runs and again at the write.
|
|
||||||
#refuseLegacyConditional(type: string): void {
|
|
||||||
if (this.#hydrated.legacyGlobals.has(type)) {
|
|
||||||
throw new Error(
|
|
||||||
`CultCache global "${type}" was loaded from a legacy key; write it once with putGlobal to retire its legacy key.`,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// An envelope of the definition's type at the key, carrying nothing: what the judge asks about a write or a removal by that type.
|
|
||||||
#probe(registered: RegisteredDefinition, key: string): CultCacheEnvelope {
|
|
||||||
return {
|
|
||||||
key, type: registered.definition.type, payload: documentPayloadFromBytes(new Uint8Array(0)), storedAt: "",
|
|
||||||
schemaId: registered.catalogEntry.schemaId, catalogEntry: registered.catalogEntry,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
// The one judge of whether a key may be written (a written envelope) or removed (none), before any store is touched: it throws the
|
|
||||||
// refusal, and #writeNow, #deleteNow and isWritable all ask it, so the query cannot disagree with the write. For a write it
|
|
||||||
// returns the held record of another type that the write owns and so restamps, if any. A refusal names keys and schemas,
|
|
||||||
// never a payload or a slot value.
|
|
||||||
#judge(registered: RegisteredDefinition, key: string, written?: CultCacheEnvelope): HydratedEntry | undefined {
|
|
||||||
const type = registered.definition.type;
|
|
||||||
const held = this.#hydrated.entries.get(this.#entryId(type, key));
|
|
||||||
if (written === undefined) {
|
|
||||||
// A removal is by key: the record it removes is the one held at the key, of this type or of another type whose schema id
|
|
||||||
// this type owns (the record a write of this type would replace). A held record of a type it does not own is refused.
|
|
||||||
this.#refuseForeignKey(key, type, "removed");
|
|
||||||
this.#refuseUnread(held);
|
|
||||||
if (held !== undefined) {
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
const other = this.#heldUnderOtherType(this.#hydrated, type, key);
|
|
||||||
if (other === undefined) {
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
if (!writtenOwns(this.#probe(registered, key), schemaIdForEnvelope(other))) {
|
|
||||||
throw new SchemaConflictError(
|
|
||||||
registered.catalogEntry.schemaId,
|
|
||||||
[other.type, type],
|
|
||||||
key,
|
|
||||||
`CultCache holds record "${key}" as type "${other.type}", so type "${type}" cannot remove it.`,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
this.#refuseUnread(other);
|
|
||||||
return other;
|
|
||||||
}
|
|
||||||
this.#requireGlobalKey(registered, key);
|
|
||||||
const retyped = this.#refuseRetype(written);
|
|
||||||
this.#refuseUnread(held);
|
|
||||||
this.#refuseUnread(retyped);
|
|
||||||
if (retyped !== undefined && this.#homeStore(retyped.type) !== this.#homeStore(type)) {
|
|
||||||
// The write owns the held record's id and would replace it, but the held record is in another store; the push
|
|
||||||
// reaches only this type's home, so the old record would stay in its own file and load as a second holder.
|
|
||||||
throw new SchemaConflictError(
|
|
||||||
schemaIdForEnvelope(written),
|
|
||||||
[retyped.type, type],
|
|
||||||
key,
|
|
||||||
`CultCache holds record "${key}" as type "${retyped.type}" in another store than the home of type "${type}", so the rename cannot replace it; remove the record first.`,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
return retyped;
|
|
||||||
}
|
|
||||||
|
|
||||||
// The one refusal of a record held read-only for the slots its payload carries past this build's: a write or a removal of
|
|
||||||
// its key. It names the type and the counts, never a slot value. A mark that is explained (see #admitEntry) is consented to.
|
|
||||||
#unreadRefusal(held: HydratedEntry | undefined): SchemaConflictError | undefined {
|
|
||||||
const unread = held?.unreadSlots;
|
|
||||||
if (held === undefined || unread === undefined || unread.explained) {
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
return new SchemaConflictError(
|
|
||||||
held.storedSchemaId ?? held.schemaId ?? held.type,
|
|
||||||
[held.catalogEntry.schemaName],
|
|
||||||
held.key,
|
|
||||||
`${held.catalogEntry.schemaName} record ${held.key} is read-only: ${unread.typeName} was read with ${unread.slotCount} slots where this build declares ${unread.declaredCount} ` +
|
|
||||||
`(${unread.occurrences} object(s) in the record). Writing it would drop data a newer writer stored; read it with types that declare those slots, or write it from that build.`,
|
|
||||||
unread,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
#refuseUnread(held: HydratedEntry | undefined): void {
|
|
||||||
const refusal = this.#unreadRefusal(held);
|
|
||||||
if (refusal !== undefined) {
|
|
||||||
throw refusal;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// The one key-identity judge of the cache: may this write land at its key, given what the cache holds there under
|
// The one key-identity judge of the cache: may this write land at its key, given what the cache holds there under
|
||||||
|
|
@ -1041,20 +782,18 @@ export class CultCache {
|
||||||
key: string,
|
key: string,
|
||||||
): Promise<boolean> {
|
): Promise<boolean> {
|
||||||
const registered = this.#requireDefinition(definition);
|
const registered = this.#requireDefinition(definition);
|
||||||
// variants:ruling:unheld-removal-refused-at-commit: a key a store carries foreign is refused, a key held by nobody is the
|
const entry = this.#hydrated.entries.get(this.#entryId(definition.type, key));
|
||||||
// existing false; a key held as another type is removed by an owner of its id and refused to any other type.
|
|
||||||
// Removal is by key, in one store call: the record held at the key of this type, else the one of another type this type owns.
|
|
||||||
const owned = this.#judge(registered, key);
|
|
||||||
const entry = this.#hydrated.entries.get(this.#entryId(definition.type, key)) ?? owned;
|
|
||||||
if (!entry) {
|
if (!entry) {
|
||||||
|
// variants:ruling:unheld-removal-refused-at-commit: a key a store carries foreign is refused, a key held under
|
||||||
|
// another type or by nobody is the existing false.
|
||||||
|
this.#refuseForeignKey(key, definition.type, "removed");
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
// The cache drops the record only once the store has removed it.
|
const home = this.#homeStore(definition.type);
|
||||||
const home = this.#homeStore(entry.type);
|
await home?.delete(this.#hydrated.legacyGlobals.get(definition.type) ?? this.#toEnvelope(entry));
|
||||||
await home?.delete(this.#hydrated.legacyGlobals.get(entry.type) ?? this.#toEnvelope(entry));
|
this.#hydrated.legacyGlobals.delete(definition.type);
|
||||||
this.#hydrated.legacyGlobals.delete(entry.type);
|
this.#removeEntry(this.#hydrated, registered, entry);
|
||||||
this.#removeEntry(this.#hydrated, this.#definitions.get(entry.type)!, entry);
|
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -1081,7 +820,7 @@ export class CultCache {
|
||||||
|
|
||||||
return {
|
return {
|
||||||
encode: (value: unknown) => this.#cloneBytes(encodeDocumentPayload(definition, value)),
|
encode: (value: unknown) => this.#cloneBytes(encodeDocumentPayload(definition, value)),
|
||||||
decode: (payload: DocumentPayload) => decodeDocumentPayloadMarked(definition, this.#cloneBytes(payload)),
|
decode: (payload: DocumentPayload) => decodeDocumentPayload(definition, this.#cloneBytes(payload)),
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -1261,7 +1000,6 @@ export class CultCache {
|
||||||
registered: RegisteredDefinition,
|
registered: RegisteredDefinition,
|
||||||
entry: CultCacheEnvelope,
|
entry: CultCacheEnvelope,
|
||||||
value: unknown,
|
value: unknown,
|
||||||
noted?: NotedSlots,
|
|
||||||
): HydratedEntry {
|
): HydratedEntry {
|
||||||
if (registered.global) {
|
if (registered.global) {
|
||||||
const currentGlobalKey = state.globalKeys.get(entry.type);
|
const currentGlobalKey = state.globalKeys.get(entry.type);
|
||||||
|
|
@ -1282,8 +1020,6 @@ export class CultCache {
|
||||||
catalogEntry: registered.catalogEntry,
|
catalogEntry: registered.catalogEntry,
|
||||||
value,
|
value,
|
||||||
lookups,
|
lookups,
|
||||||
storedSchemaId: entry.schemaId ?? entry.type,
|
|
||||||
...(noted ? { unreadSlots: { ...noted, explained: explainedBy(noted, registered.catalogEntry, entry.schemaId ?? entry.type, entry.catalogEntry) } } : {}),
|
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
import { decode, encode } from "@msgpack/msgpack";
|
import { decode, encode } from "@msgpack/msgpack";
|
||||||
|
|
||||||
import { MAX_PAYLOAD_DEPTH } from "./payload-depth";
|
import { MAX_PAYLOAD_DEPTH } from "./payload-depth";
|
||||||
import { decodeNoting, type NotedSlots, type SlotsCodec } from "./codec";
|
import type { SlotsCodec } from "./codec";
|
||||||
import type { AnyCultCacheDocumentDefinition, CultCacheDocumentFormatter } from "./types";
|
import type { AnyCultCacheDocumentDefinition, CultCacheDocumentFormatter } from "./types";
|
||||||
import { readWire, writeWire } from "./wire";
|
import { readWire, writeWire } from "./wire";
|
||||||
|
|
||||||
|
|
@ -16,13 +16,6 @@ export function resolveDocumentFormatter(definition: AnyCultCacheDocumentDefinit
|
||||||
return definition.formatter ?? (definition.codec ? codecFormatter(definition.codec) : plainDocumentFormatter);
|
return definition.formatter ?? (definition.codec ? codecFormatter(definition.codec) : plainDocumentFormatter);
|
||||||
}
|
}
|
||||||
|
|
||||||
// The one decode of a document's bytes, with the slots it read past. A plain formatter or a user formatter has no slot codec
|
|
||||||
// and carries everything, so it notes nothing.
|
|
||||||
export function decodeMarked(definition: AnyCultCacheDocumentDefinition, bytes: Uint8Array): { value: unknown; unreadSlots?: NotedSlots } {
|
|
||||||
const formatter = resolveDocumentFormatter(definition);
|
|
||||||
return decodeNoting(() => formatter.decode(bytes));
|
|
||||||
}
|
|
||||||
|
|
||||||
const plainDocumentFormatter: CultCacheDocumentFormatter<unknown> = {
|
const plainDocumentFormatter: CultCacheDocumentFormatter<unknown> = {
|
||||||
// The encoder's own depth refusal (100 by default) is set above the limit, so the payload walk decides.
|
// The encoder's own depth refusal (100 by default) is set above the limit, so the payload walk decides.
|
||||||
encode: (value: unknown) => encode(value, { maxDepth: MAX_PAYLOAD_DEPTH * 2 }),
|
encode: (value: unknown) => encode(value, { maxDepth: MAX_PAYLOAD_DEPTH * 2 }),
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,5 @@
|
||||||
import type { NotedSlots } from "./codec";
|
import { resolveDocumentFormatter } from "./document-formatter";
|
||||||
import { decodeMarked, resolveDocumentFormatter } from "./document-formatter";
|
import { checkPayloadDepth } from "./payload-depth";
|
||||||
import { checkPayloadDepth, checkPayloadIsOneValue } from "./payload-depth";
|
|
||||||
import type {
|
import type {
|
||||||
AnyCultCacheDocumentDefinition,
|
AnyCultCacheDocumentDefinition,
|
||||||
CultCacheSchemaCatalogMember,
|
CultCacheSchemaCatalogMember,
|
||||||
|
|
@ -119,24 +118,10 @@ export function decodeDocumentPayload<TDefinition extends AnyCultCacheDocumentDe
|
||||||
definition: TDefinition,
|
definition: TDefinition,
|
||||||
payload: DocumentPayload,
|
payload: DocumentPayload,
|
||||||
): CultCacheDocumentValue<TDefinition> {
|
): CultCacheDocumentValue<TDefinition> {
|
||||||
return decodeDocumentPayloadMarked(definition, payload).value;
|
|
||||||
}
|
|
||||||
|
|
||||||
// The same read with the slots it read past (cult-cache-ts slot-readonly). The depth check runs first: a payload past the
|
|
||||||
// limit is refused, never marked.
|
|
||||||
export function decodeDocumentPayloadMarked<TDefinition extends AnyCultCacheDocumentDefinition>(
|
|
||||||
definition: TDefinition,
|
|
||||||
payload: DocumentPayload,
|
|
||||||
): { value: CultCacheDocumentValue<TDefinition>; unreadSlots?: NotedSlots } {
|
|
||||||
const bytes = documentPayloadBytes(payload);
|
const bytes = documentPayloadBytes(payload);
|
||||||
if (writesLibraryMessagePack(definition)) {
|
if (writesLibraryMessagePack(definition)) checkPayloadDepth(bytes, `document type "${definition.type}" payload`);
|
||||||
// A payload is exactly one MessagePack value: bytes after the first are refused by count before any formatter reads,
|
const decoded = resolveDocumentFormatter(definition).decode(bytes);
|
||||||
// so a tail is refused before any slot is marked.
|
return definition.schema.parse(decoded) as CultCacheDocumentValue<TDefinition>;
|
||||||
checkPayloadIsOneValue(bytes, `document type "${definition.type}" payload`);
|
|
||||||
}
|
|
||||||
const { value: decoded, unreadSlots } = decodeMarked(definition, bytes);
|
|
||||||
const value = definition.schema.parse(decoded) as CultCacheDocumentValue<TDefinition>;
|
|
||||||
return unreadSlots ? { value, unreadSlots } : { value };
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// The one writer: the definition's schema first, then its formatter, codec or plain map.
|
// The one writer: the definition's schema first, then its formatter, codec or plain map.
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,2 @@
|
||||||
export * from "./browser";
|
export * from "./browser";
|
||||||
export { SingleFileMessagePackBackingStore, readSingleFileStore, type SingleFileStoreRead } from "./single-file-messagepack-backing-store";
|
export { SingleFileMessagePackBackingStore, readSingleFileStore, type SingleFileStoreRead } from "./single-file-messagepack-backing-store";
|
||||||
export { StoreLinkedError } from "./store-file";
|
|
||||||
|
|
|
||||||
|
|
@ -12,9 +12,8 @@ export class CultCachePayloadDepthError extends Error {
|
||||||
|
|
||||||
// Walks the headers of one MessagePack value iteratively (a count stack bounded by the limit, scalars skipped by length,
|
// Walks the headers of one MessagePack value iteratively (a count stack bounded by the limit, scalars skipped by length,
|
||||||
// nothing read) and throws at the first container past the limit. The message names the subject, the depth and the limit,
|
// nothing read) and throws at the first container past the limit. The message names the subject, the depth and the limit,
|
||||||
// never payload bytes. Returns the offset where the first value ends, or undefined when the payload ends early (the
|
// never payload bytes. A payload that ends early is the reader's to refuse.
|
||||||
// reader's to refuse); what follows that offset is never walked, and whether it may exist is the caller's rule.
|
export function checkPayloadDepth(bytes: Uint8Array, subject = "document payload"): void {
|
||||||
export function checkPayloadDepth(bytes: Uint8Array, subject = "document payload"): number | undefined {
|
|
||||||
const view = new DataView(bytes.buffer, bytes.byteOffset, bytes.byteLength);
|
const view = new DataView(bytes.buffer, bytes.byteOffset, bytes.byteLength);
|
||||||
const remaining = new Float64Array(MAX_PAYLOAD_DEPTH);
|
const remaining = new Float64Array(MAX_PAYLOAD_DEPTH);
|
||||||
let depth = 0;
|
let depth = 0;
|
||||||
|
|
@ -34,12 +33,12 @@ export function checkPayloadDepth(bytes: Uint8Array, subject = "document payload
|
||||||
else if (code <= 0x8f) { container = true; header = 1; children = 2 * (code & 0x0f); }
|
else if (code <= 0x8f) { container = true; header = 1; children = 2 * (code & 0x0f); }
|
||||||
else if (code <= 0x9f) { container = true; header = 1; children = code & 0x0f; }
|
else if (code <= 0x9f) { container = true; header = 1; children = code & 0x0f; }
|
||||||
else if (code <= 0xbf) skip = 1 + (code & 0x1f);
|
else if (code <= 0xbf) skip = 1 + (code & 0x1f);
|
||||||
else if (code === 0xc4 || code === 0xd9) { const n = width(1); if (n === undefined) return undefined; skip = 2 + n; }
|
else if (code === 0xc4 || code === 0xd9) { const n = width(1); if (n === undefined) return; skip = 2 + n; }
|
||||||
else if (code === 0xc5 || code === 0xda) { const n = width(2); if (n === undefined) return undefined; skip = 3 + n; }
|
else if (code === 0xc5 || code === 0xda) { const n = width(2); if (n === undefined) return; skip = 3 + n; }
|
||||||
else if (code === 0xc6 || code === 0xdb) { const n = width(4); if (n === undefined) return undefined; skip = 5 + n; }
|
else if (code === 0xc6 || code === 0xdb) { const n = width(4); if (n === undefined) return; skip = 5 + n; }
|
||||||
else if (code === 0xc7) { const n = width(1); if (n === undefined) return undefined; skip = 3 + n; }
|
else if (code === 0xc7) { const n = width(1); if (n === undefined) return; skip = 3 + n; }
|
||||||
else if (code === 0xc8) { const n = width(2); if (n === undefined) return undefined; skip = 4 + n; }
|
else if (code === 0xc8) { const n = width(2); if (n === undefined) return; skip = 4 + n; }
|
||||||
else if (code === 0xc9) { const n = width(4); if (n === undefined) return undefined; skip = 6 + n; }
|
else if (code === 0xc9) { const n = width(4); if (n === undefined) return; skip = 6 + n; }
|
||||||
else if (code === 0xca || code === 0xce || code === 0xd2) skip = 5;
|
else if (code === 0xca || code === 0xce || code === 0xd2) skip = 5;
|
||||||
else if (code === 0xcb || code === 0xcf || code === 0xd3) skip = 9;
|
else if (code === 0xcb || code === 0xcf || code === 0xd3) skip = 9;
|
||||||
else if (code === 0xcc || code === 0xd0) skip = 2;
|
else if (code === 0xcc || code === 0xd0) skip = 2;
|
||||||
|
|
@ -48,10 +47,10 @@ export function checkPayloadDepth(bytes: Uint8Array, subject = "document payload
|
||||||
else if (code === 0xd6) skip = 6;
|
else if (code === 0xd6) skip = 6;
|
||||||
else if (code === 0xd7) skip = 10;
|
else if (code === 0xd7) skip = 10;
|
||||||
else if (code === 0xd8) skip = 18;
|
else if (code === 0xd8) skip = 18;
|
||||||
else if (code === 0xdc) { const n = width(2); if (n === undefined) return undefined; container = true; header = 3; children = n; }
|
else if (code === 0xdc) { const n = width(2); if (n === undefined) return; container = true; header = 3; children = n; }
|
||||||
else if (code === 0xdd) { const n = width(4); if (n === undefined) return undefined; container = true; header = 5; children = n; }
|
else if (code === 0xdd) { const n = width(4); if (n === undefined) return; container = true; header = 5; children = n; }
|
||||||
else if (code === 0xde) { const n = width(2); if (n === undefined) return undefined; container = true; header = 3; children = 2 * n; }
|
else if (code === 0xde) { const n = width(2); if (n === undefined) return; container = true; header = 3; children = 2 * n; }
|
||||||
else { const n = width(4); if (n === undefined) return undefined; container = true; header = 5; children = 2 * n; }
|
else { const n = width(4); if (n === undefined) return; container = true; header = 5; children = 2 * n; }
|
||||||
|
|
||||||
if (container) {
|
if (container) {
|
||||||
if (depth === MAX_PAYLOAD_DEPTH) throw new CultCachePayloadDepthError(MAX_PAYLOAD_DEPTH + 1, MAX_PAYLOAD_DEPTH, subject);
|
if (depth === MAX_PAYLOAD_DEPTH) throw new CultCachePayloadDepthError(MAX_PAYLOAD_DEPTH + 1, MAX_PAYLOAD_DEPTH, subject);
|
||||||
|
|
@ -64,20 +63,8 @@ export function checkPayloadDepth(bytes: Uint8Array, subject = "document payload
|
||||||
position += skip;
|
position += skip;
|
||||||
}
|
}
|
||||||
|
|
||||||
// A scalar whose declared length runs past the payload is an early end, not a value.
|
|
||||||
if (position > bytes.length) return undefined;
|
|
||||||
// One element is complete; close every container it was the last element of.
|
// One element is complete; close every container it was the last element of.
|
||||||
while (depth > 0 && --remaining[depth - 1] === 0) depth--;
|
while (depth > 0 && --remaining[depth - 1] === 0) depth--;
|
||||||
if (depth === 0) return position;
|
if (depth === 0) return;
|
||||||
}
|
}
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
// The one rule that a payload is exactly one MessagePack value: the depth walk, then a refusal of bytes after the first
|
|
||||||
// value, by count, naming the subject, from the walk's end. The tail is never walked or echoed; a payload that ends early
|
|
||||||
// stays the decoder's to refuse. decodeDocumentPayload and the inspector speak this clause and no other.
|
|
||||||
export function checkPayloadIsOneValue(bytes: Uint8Array, subject: string): number | undefined {
|
|
||||||
const end = checkPayloadDepth(bytes, subject);
|
|
||||||
if (end !== undefined && end < bytes.length) throw new Error(`${subject} has ${bytes.length - end} bytes after its first MessagePack value.`);
|
|
||||||
return end;
|
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,3 @@
|
||||||
import { createHash } from "node:crypto";
|
|
||||||
import { lstatSync, readFileSync } from "node:fs";
|
import { lstatSync, readFileSync } from "node:fs";
|
||||||
import { mkdir } from "node:fs/promises";
|
import { mkdir } from "node:fs/promises";
|
||||||
import { dirname, resolve } from "node:path";
|
import { dirname, resolve } from "node:path";
|
||||||
|
|
@ -56,42 +55,14 @@ export class SingleFileMessagePackBackingStore implements CacheBackingStore {
|
||||||
return disk.envelopes;
|
return disk.envelopes;
|
||||||
}
|
}
|
||||||
|
|
||||||
async push(entry: CultCacheEnvelope): Promise<{ storedAt: string }> {
|
async push(entry: CultCacheEnvelope): Promise<void> {
|
||||||
return this.#enqueue(async () => {
|
await this.#enqueue(async () => {
|
||||||
const disk = this.#readDisk();
|
const disk = this.#readDisk();
|
||||||
this.#format = disk.format;
|
this.#format = disk.format;
|
||||||
const existing = disk.envelopes;
|
const existing = disk.envelopes;
|
||||||
requireOneTypePerKey(this.filePath, [entry], existing);
|
requireOneTypePerKey(this.filePath, [entry], existing);
|
||||||
const [written] = await this.#writeAll([entry], existing);
|
const filtered = existing.filter((candidate) => candidate.key !== entry.key);
|
||||||
return { storedAt: written!.storedAt };
|
await this.#writeAll([entry], filtered);
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
// The record at the key as the file holds it now, with its content version, from one read. Like pullAll it takes no lock: a
|
|
||||||
// reader sees a whole file (the commit renames one over the other), and the version it reports is the one commitIf judges.
|
|
||||||
async read(key: string): Promise<{ envelope: CultCacheEnvelope; version: string } | undefined> {
|
|
||||||
const envelope = readSingleFileStore(this.filePath).envelopes.find((candidate) => candidate.key === key);
|
|
||||||
return envelope === undefined ? undefined : { envelope, version: recordVersion(envelope) };
|
|
||||||
}
|
|
||||||
|
|
||||||
// Writes `entry` the way push does, but only if the record at its key (of any type) still has `expectedVersion`; null expects
|
|
||||||
// none. The comparison and the write are one hold of the write lock, so no other writer lands between them.
|
|
||||||
async commitIf(
|
|
||||||
entry: CultCacheEnvelope,
|
|
||||||
expectedVersion: string | null,
|
|
||||||
): Promise<{ outcome: "committed"; storedAt: string } | { outcome: "mismatch" }> {
|
|
||||||
return this.#enqueue(async () => {
|
|
||||||
const disk = this.#readDisk();
|
|
||||||
this.#format = disk.format;
|
|
||||||
const existing = disk.envelopes;
|
|
||||||
const current = existing.find((candidate) => candidate.key === entry.key);
|
|
||||||
if ((current === undefined ? null : recordVersion(current)) !== expectedVersion) {
|
|
||||||
return { outcome: "mismatch" as const };
|
|
||||||
}
|
|
||||||
|
|
||||||
requireOneTypePerKey(this.filePath, [entry], existing);
|
|
||||||
const [written] = await this.#writeAll([entry], existing);
|
|
||||||
return { outcome: "committed" as const, storedAt: written!.storedAt };
|
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -111,24 +82,31 @@ export class SingleFileMessagePackBackingStore implements CacheBackingStore {
|
||||||
|
|
||||||
async pushAll(entries: CultCacheEnvelope[], options: PushAllOptions = {}): Promise<void> {
|
async pushAll(entries: CultCacheEnvelope[], options: PushAllOptions = {}): Promise<void> {
|
||||||
await this.#enqueue(async () => {
|
await this.#enqueue(async () => {
|
||||||
// A flush writes `entries` onto the store as it is under the lock, the way a push does: a record under the same key
|
// A flush of the whole store writes the header the file on disk carries, read now: a file marked for element ids
|
||||||
// is replaced and no other is removed, so a cache whose image is stale (or empty, never pulled) cannot drop what
|
// stays marked, and one that is not (or is gone or legacy) is written unmarked. The file is read by the same
|
||||||
// another writer added. The store is read by the same reader as `pullAll`, so one it would refuse (not exactly one
|
// reader as `pullAll`, so one it would refuse (not exactly one store, a variant, a body it cannot decode) is refused
|
||||||
// store, a variant, a body it cannot decode) is refused and left as it is. A soft flush asks that reader too: nothing
|
// and left as it is. A soft flush asks that reader too: nothing at the path is written, a store is left alone.
|
||||||
// at the path is written, a store is left alone.
|
try {
|
||||||
// The reader owns the verdict on what is at the path: a dangling link is refused here as it is for open and push.
|
const disk = this.#readDisk();
|
||||||
const disk = this.#readDisk();
|
if (options.soft && !disk.absent) {
|
||||||
if (options.soft && !disk.absent) {
|
return;
|
||||||
return;
|
}
|
||||||
|
|
||||||
|
this.#format = disk.format;
|
||||||
|
} catch (error) {
|
||||||
|
// Only a dangling link reaches here with ENOENT: it holds no store, so a whole-store flush has no header to keep and
|
||||||
|
// replaces the link (R3 pins this). A soft flush does not replace what it cannot read, and every merging writer
|
||||||
|
// has already refused the link when it read the current entries.
|
||||||
|
if (options.soft || (error as NodeJS.ErrnoException).code !== "ENOENT") {
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
|
||||||
|
this.#format = STORE_FORMAT_VERSION;
|
||||||
}
|
}
|
||||||
|
|
||||||
this.#format = disk.format;
|
requireOneTypePerKey(this.filePath, entries, []);
|
||||||
const held = disk.envelopes;
|
|
||||||
|
|
||||||
// A key is held once: of same-type entries sharing a key in one batch, the last is kept.
|
// A key is held once: of same-type entries sharing a key in one batch, the last is kept.
|
||||||
const supplied = [...new Map(entries.map((entry) => [entry.key, entry])).values()];
|
await this.#writeAll([...new Map(entries.map((entry) => [entry.key, entry])).values()], []);
|
||||||
requireOneTypePerKey(this.filePath, entries, held);
|
|
||||||
await this.#writeAll(supplied, held);
|
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -155,67 +133,13 @@ export class SingleFileMessagePackBackingStore implements CacheBackingStore {
|
||||||
return result;
|
return result;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Writes the supplied records onto the arrived ones and returns the supplied records as written. A supplied record whose
|
async #writeAll(supplied: CultCacheEnvelope[], arrived: CultCacheEnvelope[]): Promise<void> {
|
||||||
// schema id and payload bytes differ from the arrived one it replaces is never stamped earlier than the record it replaces, so a content version that includes storedAt
|
|
||||||
// cannot repeat across writes (variants:ruling:storedat-on-change): one not later than the arrived stamp is written one
|
|
||||||
// millisecond after it.
|
|
||||||
async #writeAll(supplied: CultCacheEnvelope[], arrived: CultCacheEnvelope[]): Promise<CultCacheEnvelope[]> {
|
|
||||||
const arrivedByKey = new Map(arrived.map((entry) => [entry.key, entry]));
|
|
||||||
const written = supplied.map((entry) => {
|
|
||||||
const prior = arrivedByKey.get(entry.key);
|
|
||||||
if (prior === undefined) {
|
|
||||||
return entry;
|
|
||||||
}
|
|
||||||
// A rewrite of the identical record (same schema id and payload bytes) keeps the stamp and so the version it has; the
|
|
||||||
// writer's type and catalog entry still go down with it.
|
|
||||||
if (sameContent(entry, prior)) {
|
|
||||||
return { ...entry, storedAt: prior.storedAt };
|
|
||||||
}
|
|
||||||
return { ...entry, storedAt: laterStoredAt(entry.storedAt, prior.storedAt) };
|
|
||||||
});
|
|
||||||
await mkdir(dirname(this.filePath), { recursive: true });
|
await mkdir(dirname(this.filePath), { recursive: true });
|
||||||
|
|
||||||
await commitStoreFile(this.filePath, encode(encodeSnapshot(written, arrived, this.#format)));
|
await commitStoreFile(this.filePath, encode(encodeSnapshot(supplied, arrived, this.#format)));
|
||||||
return written;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// The content version of a stored record: the lowercase hex SHA-256 of its persisted encoding, the MessagePack array
|
|
||||||
// [key, schemaId, storedAt, payload] as the store writes it (the C# reference's StoredVersion). Private to this module so
|
|
||||||
// node:crypto stays out of the browser-safe cache.
|
|
||||||
export function recordVersion(entry: CultCacheEnvelope): string {
|
|
||||||
return createHash("sha256")
|
|
||||||
.update(encode([entry.key, schemaIdForEnvelope(entry), entry.storedAt, documentPayloadBytes(entry.payload)]))
|
|
||||||
.digest("hex");
|
|
||||||
}
|
|
||||||
|
|
||||||
function sameContent(a: CultCacheEnvelope, b: CultCacheEnvelope): boolean {
|
|
||||||
if (schemaIdForEnvelope(a) !== schemaIdForEnvelope(b)) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
const x = documentPayloadBytes(a.payload);
|
|
||||||
const y = documentPayloadBytes(b.payload);
|
|
||||||
return x.length === y.length && x.every((byte, i) => byte === y[i]);
|
|
||||||
}
|
|
||||||
|
|
||||||
// `storedAt` if it is later than `prior`, else `prior` plus one millisecond. A stamp that does not parse is not later; a prior
|
|
||||||
// that does not parse leaves nothing to be later than.
|
|
||||||
function laterStoredAt(storedAt: string, prior: string): string {
|
|
||||||
const priorMs = Date.parse(prior);
|
|
||||||
if (Number.isNaN(priorMs)) {
|
|
||||||
return storedAt;
|
|
||||||
}
|
|
||||||
const storedMs = Date.parse(storedAt);
|
|
||||||
if (!(Number.isNaN(storedMs) || storedMs <= priorMs)) {
|
|
||||||
return storedAt;
|
|
||||||
}
|
|
||||||
// The stamp is ISO-8601 with a four-digit year; one past 9999-12-31T23:59:59.999Z would print as an extended year.
|
|
||||||
if (priorMs + 1 > Date.UTC(9999, 11, 31, 23, 59, 59, 999)) {
|
|
||||||
throw new RangeError(`CultCache cannot stamp a write later than the record it replaces (${prior}): the stamp would leave the four-digit years.`);
|
|
||||||
}
|
|
||||||
return new Date(priorMs + 1).toISOString();
|
|
||||||
}
|
|
||||||
|
|
||||||
// A store holds a key once, and the reader refuses a file that holds it twice, so a write that would put a second type under a
|
// A store holds a key once, and the reader refuses a file that holds it twice, so a write that would put a second type under a
|
||||||
// key (against a record on disk, or within its own batch) is refused before anything is written. Retyping a record is a delete
|
// key (against a record on disk, or within its own batch) is refused before anything is written. Retyping a record is a delete
|
||||||
// of the old type followed by a put of the new one.
|
// of the old type followed by a put of the new one.
|
||||||
|
|
|
||||||
|
|
@ -5,7 +5,7 @@
|
||||||
// lazily inside `loadKernel`, so a consumer that never writes a store never loads it.
|
// lazily inside `loadKernel`, so a consumer that never writes a store never loads it.
|
||||||
|
|
||||||
import { closeSync, openSync, constants as fsConstants } from "node:fs";
|
import { closeSync, openSync, constants as fsConstants } from "node:fs";
|
||||||
import { lstat, mkdir, open, rename, rm } from "node:fs/promises";
|
import { mkdir, open, rename, rm } from "node:fs/promises";
|
||||||
import type { FileHandle } from "node:fs/promises";
|
import type { FileHandle } from "node:fs/promises";
|
||||||
import { dirname } from "node:path";
|
import { dirname } from "node:path";
|
||||||
|
|
||||||
|
|
@ -25,30 +25,6 @@ export class StoreReplacedNotDurableError extends Error {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Thrown when a write is asked of a store path that is a link: a replace there would swap the link for a regular file. */
|
|
||||||
export class StoreLinkedError extends Error {
|
|
||||||
constructor(readonly path: string) {
|
|
||||||
super(`CultCache store ${path} is a link, and a write at it would replace the link; configure the link's target as the store path.`);
|
|
||||||
this.name = "StoreLinkedError";
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Refuses a link at the store path (file or directory link; libuv reports Windows junctions as links). Absent is not a link. */
|
|
||||||
export async function refuseLinkedStore(storePath: string): Promise<void> {
|
|
||||||
let linked = false;
|
|
||||||
try {
|
|
||||||
linked = (await lstat(storePath)).isSymbolicLink();
|
|
||||||
} catch (error) {
|
|
||||||
if ((error as NodeJS.ErrnoException).code !== "ENOENT") {
|
|
||||||
throw error;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (linked) {
|
|
||||||
throw new StoreLinkedError(storePath);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The file operations of one commit. Tests record or fail them; production uses `nodeStoreFileOps`. */
|
/** The file operations of one commit. Tests record or fail them; production uses `nodeStoreFileOps`. */
|
||||||
export interface StoreFileOps {
|
export interface StoreFileOps {
|
||||||
createExclusive(path: string): Promise<FileHandle>;
|
createExclusive(path: string): Promise<FileHandle>;
|
||||||
|
|
@ -201,7 +177,6 @@ export async function withStoreWriteLock<T>(
|
||||||
): Promise<T> {
|
): Promise<T> {
|
||||||
const lockPath = `${storePath}.lock`;
|
const lockPath = `${storePath}.lock`;
|
||||||
const timeoutMs = options.timeoutMs ?? LOCK_TIMEOUT_MS;
|
const timeoutMs = options.timeoutMs ?? LOCK_TIMEOUT_MS;
|
||||||
await refuseLinkedStore(storePath);
|
|
||||||
await mkdir(dirname(lockPath), { recursive: true });
|
await mkdir(dirname(lockPath), { recursive: true });
|
||||||
|
|
||||||
const started = Date.now();
|
const started = Date.now();
|
||||||
|
|
@ -218,8 +193,6 @@ export async function withStoreWriteLock<T>(
|
||||||
}
|
}
|
||||||
|
|
||||||
try {
|
try {
|
||||||
// A link may have been put at the path while the lock was awaited; the look above only saw the path before.
|
|
||||||
await refuseLinkedStore(storePath);
|
|
||||||
return await operation();
|
return await operation();
|
||||||
} finally {
|
} finally {
|
||||||
release();
|
release();
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
import { decode } from "@msgpack/msgpack";
|
import { decode } from "@msgpack/msgpack";
|
||||||
|
|
||||||
import type { CultCacheEnvelope, CultCacheUnreadSlots } from "./types";
|
import type { CultCacheEnvelope } from "./types";
|
||||||
|
|
||||||
export const STORE_FORMAT_VERSION = "cultcache.store.v1";
|
export const STORE_FORMAT_VERSION = "cultcache.store.v1";
|
||||||
|
|
||||||
|
|
@ -83,16 +83,13 @@ export class SchemaConflictError extends Error {
|
||||||
readonly schemaId: string;
|
readonly schemaId: string;
|
||||||
readonly schemaNames: string[];
|
readonly schemaNames: string[];
|
||||||
readonly recordKey: string;
|
readonly recordKey: string;
|
||||||
/** Set when the refusal is for unread slots; undefined for every other refusal. */
|
|
||||||
readonly unreadSlots?: CultCacheUnreadSlots;
|
|
||||||
|
|
||||||
constructor(schemaId: string, schemaNames: string[], recordKey: string, message?: string, unreadSlots?: CultCacheUnreadSlots) {
|
constructor(schemaId: string, schemaNames: string[], recordKey: string, message?: string) {
|
||||||
super(message ?? `Schema id "${schemaId}" cannot describe record "${recordKey}": ${schemaNames.map((name) => `"${name}"`).join(", ")}.`);
|
super(message ?? `Schema id "${schemaId}" cannot describe record "${recordKey}": ${schemaNames.map((name) => `"${name}"`).join(", ")}.`);
|
||||||
this.name = "SchemaConflictError";
|
this.name = "SchemaConflictError";
|
||||||
this.schemaId = schemaId;
|
this.schemaId = schemaId;
|
||||||
this.schemaNames = schemaNames;
|
this.schemaNames = schemaNames;
|
||||||
this.recordKey = recordKey;
|
this.recordKey = recordKey;
|
||||||
this.unreadSlots = unreadSlots;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,33 +0,0 @@
|
||||||
// The one shape a `storedAt` stamp has (tests/vectors/stored-at-stamp/README.md; reference `parse_stored_at` in cultcache-py): an
|
|
||||||
// RFC 3339 date-time `YYYY-MM-DDThh:mm:ss`, an optional fraction of 1 to 9 digits, and `Z` or `+hh:mm` / `-hh:mm` (hours 00-23,
|
|
||||||
// minutes 00-59). A real calendar date, seconds 00-59, and an instant within years 0001-9999. Checked here, not left to
|
|
||||||
// `Date.parse`, which accepts shapes this one does not and whose accepted set differs by engine.
|
|
||||||
const STAMP = /^([0-9]{4})-([0-9]{2})-([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2})(?:\.[0-9]{1,9})?(?:Z|([+-])([01][0-9]|2[0-3]):([0-5][0-9]))$/;
|
|
||||||
|
|
||||||
const MS_PER_MINUTE = 60_000;
|
|
||||||
|
|
||||||
/** True when `text` is a string that is a stamp. Anything else (missing, empty, wrong type, other shapes) is not. */
|
|
||||||
export function isStoredAtStamp(text: unknown): text is string {
|
|
||||||
if (typeof text !== "string") return false;
|
|
||||||
const shape = STAMP.exec(text);
|
|
||||||
if (shape === null) return false;
|
|
||||||
const [year, month, day, hour, minute, second] = shape.slice(1, 7).map(Number) as [number, number, number, number, number, number];
|
|
||||||
const leap = (year % 4 === 0 && year % 100 !== 0) || year % 400 === 0;
|
|
||||||
const daysInMonth = [31, leap ? 29 : 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31][month - 1];
|
|
||||||
if (year < 1 || month < 1 || month > 12 || day < 1 || day > (daysInMonth as number) || hour > 23 || minute > 59 || second > 59) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
// The UTC instant must stay within years 0001-9999, so an offset can push a boundary date out of range.
|
|
||||||
const local = new Date(0);
|
|
||||||
local.setUTCFullYear(year, month - 1, day);
|
|
||||||
local.setUTCHours(hour, minute, second, 0);
|
|
||||||
const offsetMinutes = shape[7] === undefined ? 0 : (shape[7] === "-" ? -1 : 1) * (Number(shape[8]) * 60 + Number(shape[9]));
|
|
||||||
const utcMs = local.getTime() - offsetMinutes * MS_PER_MINUTE;
|
|
||||||
const first = new Date(0);
|
|
||||||
first.setUTCFullYear(1, 0, 1);
|
|
||||||
first.setUTCHours(0, 0, 0, 0);
|
|
||||||
const last = new Date(0);
|
|
||||||
last.setUTCFullYear(9999, 11, 31);
|
|
||||||
last.setUTCHours(23, 59, 59, 999);
|
|
||||||
return utcMs >= first.getTime() && utcMs <= last.getTime();
|
|
||||||
}
|
|
||||||
|
|
@ -99,60 +99,15 @@ export interface CultCacheEnvelope {
|
||||||
catalogEntry?: CultCacheSchemaCatalogEntry;
|
catalogEntry?: CultCacheSchemaCatalogEntry;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* What a payload decode found past the slots this build declares, at any depth: the first type read with extra slots, how many
|
|
||||||
* slots it carried against how many it declares, and how many objects in the record did. It holds no slot value, so a refusal
|
|
||||||
* can name it. A record carrying it is read-only unless `explained`.
|
|
||||||
*/
|
|
||||||
export interface CultCacheUnreadSlots {
|
|
||||||
/** The first type read with extra slots (the unit arm's arm name for a unit arm). */
|
|
||||||
readonly typeName: string;
|
|
||||||
readonly slotCount: number;
|
|
||||||
readonly declaredCount: number;
|
|
||||||
readonly occurrences: number;
|
|
||||||
/** True when every mark sat in the document's own object. */
|
|
||||||
readonly depth0Only: boolean;
|
|
||||||
/**
|
|
||||||
* True only when every mark is at depth 0 and the schema comparison of the id the record was stored under reported every slot
|
|
||||||
* the mark carries (slotCount is at most the highest reported slot plus one): the loss a compatible-id declaration consents to.
|
|
||||||
*/
|
|
||||||
readonly explained: boolean;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface PushAllOptions {
|
export interface PushAllOptions {
|
||||||
soft?: boolean;
|
soft?: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface CacheBackingStore {
|
export interface CacheBackingStore {
|
||||||
pullAll(): Promise<CultCacheEnvelope[]>;
|
pullAll(): Promise<CultCacheEnvelope[]>;
|
||||||
/** A store that re-stamps the write returns the storedAt it wrote; the cache then holds that stamp, not its own. */
|
push(entry: CultCacheEnvelope): Promise<void>;
|
||||||
push(entry: CultCacheEnvelope): Promise<void | { storedAt: string }>;
|
|
||||||
delete(entry: CultCacheEnvelope): Promise<void>;
|
delete(entry: CultCacheEnvelope): Promise<void>;
|
||||||
pushAll?(entries: CultCacheEnvelope[], options?: PushAllOptions): Promise<void>;
|
pushAll?(entries: CultCacheEnvelope[], options?: PushAllOptions): Promise<void>;
|
||||||
/**
|
|
||||||
* The record at the key as the store holds it now, with its content version, from one read; undefined when the store holds
|
|
||||||
* none. The version is the store's own: the cache carries it from `read` to `commitIf` and never computes it.
|
|
||||||
*/
|
|
||||||
read?(key: string): Promise<{ envelope: CultCacheEnvelope; version: string } | undefined>;
|
|
||||||
/**
|
|
||||||
* Writes the entry only if the record at its key still has `expectedVersion` (null: no record), judged and written under the
|
|
||||||
* store's write lock. A mismatch writes nothing. A commit returns the storedAt actually written.
|
|
||||||
*/
|
|
||||||
commitIf?(
|
|
||||||
entry: CultCacheEnvelope,
|
|
||||||
expectedVersion: string | null,
|
|
||||||
): Promise<{ outcome: "committed"; storedAt: string } | { outcome: "mismatch" }>;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The outcome of `CultCache.update`: what `apply` wrote, declined to write, or lost to a rival writer. */
|
|
||||||
export type CultCacheUpdateResult<TValue> =
|
|
||||||
| { outcome: "updated"; document: TValue }
|
|
||||||
| { outcome: "declined"; document: TValue | undefined }
|
|
||||||
| { outcome: "lostRace"; document: TValue | undefined };
|
|
||||||
|
|
||||||
export interface CultCacheUpdateOptions {
|
|
||||||
/** How many times `apply` may run before a lost race is returned as `lostRace`. An integer of at least 1; default 5. */
|
|
||||||
maxAttempts?: number;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface CultCacheStoreRegistration {
|
export interface CultCacheStoreRegistration {
|
||||||
|
|
|
||||||
|
|
@ -128,6 +128,7 @@ export function readWire(payload: Uint8Array): unknown {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// One value is read; the caller owns what follows it (decodeDocumentPayload refuses a payload with a tail).
|
const tree = next();
|
||||||
return next();
|
if (offset !== payload.length) throw new Error("the MessagePack payload has bytes after its value.");
|
||||||
|
return tree;
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -15,7 +15,6 @@ import { CultCache } from "../src/cult-cache";
|
||||||
import { inspectCultCacheBytes } from "../src/cult-cache-inspector";
|
import { inspectCultCacheBytes } from "../src/cult-cache-inspector";
|
||||||
import { defineDocumentRegistry, defineDocumentType, documentPayloadBytes, documentPayloadFromBytes } from "../src/document";
|
import { defineDocumentRegistry, defineDocumentType, documentPayloadBytes, documentPayloadFromBytes } from "../src/document";
|
||||||
import { SingleFileMessagePackBackingStore, readSingleFileStore, readStoreBytes } from "../src/single-file-messagepack-backing-store";
|
import { SingleFileMessagePackBackingStore, readSingleFileStore, readStoreBytes } from "../src/single-file-messagepack-backing-store";
|
||||||
import { StoreLinkedError, withStoreWriteLock } from "../src/store-file";
|
|
||||||
import { SchemaConflictError, StoreUnreadableError, refuseUnreadStoreBytes } from "../src/store-format";
|
import { SchemaConflictError, StoreUnreadableError, refuseUnreadStoreBytes } from "../src/store-format";
|
||||||
import type { AnyCultCacheDocumentDefinition, CacheBackingStore, CultCacheEnvelope, CultCacheSchema } from "../src/types";
|
import type { AnyCultCacheDocumentDefinition, CacheBackingStore, CultCacheEnvelope, CultCacheSchema } from "../src/types";
|
||||||
|
|
||||||
|
|
@ -34,7 +33,8 @@ const cultcacheRsRoot = existsSync(resolve(cultLibRoot, "packages", "cultcache-r
|
||||||
? resolve(cultLibRoot, "packages", "cultcache-rs")
|
? resolve(cultLibRoot, "packages", "cultcache-rs")
|
||||||
: resolve(cultCacheTsRoot, "..", "cultcache-rs");
|
: resolve(cultCacheTsRoot, "..", "cultcache-rs");
|
||||||
const rustInteropBinary = resolve(
|
const rustInteropBinary = resolve(
|
||||||
process.env.CARGO_TARGET_DIR ?? resolve(cultcacheRsRoot, "target"),
|
cultcacheRsRoot,
|
||||||
|
"target",
|
||||||
"debug",
|
"debug",
|
||||||
"examples",
|
"examples",
|
||||||
process.platform === "win32" ? "cultcache_interop.exe" : "cultcache_interop",
|
process.platform === "win32" ? "cultcache_interop.exe" : "cultcache_interop",
|
||||||
|
|
@ -1019,7 +1019,6 @@ test("legacyKeyGlobalLoadsWithoutWritingAndFirstWriteLeavesOneGlobal", async ()
|
||||||
assert.deepEqual(reloaded.getRequiredGlobal(settingsDocument), { t: "new" });
|
assert.deepEqual(reloaded.getRequiredGlobal(settingsDocument), { t: "new" });
|
||||||
|
|
||||||
// Deleting an adopted global removes the legacy record.
|
// Deleting an adopted global removes the legacy record.
|
||||||
await rm(storePath);
|
|
||||||
await new SingleFileMessagePackBackingStore(storePath).pushAll([legacy]);
|
await new SingleFileMessagePackBackingStore(storePath).pushAll([legacy]);
|
||||||
const deleting = build();
|
const deleting = build();
|
||||||
await deleting.pullAllBackingStores();
|
await deleting.pullAllBackingStores();
|
||||||
|
|
@ -1027,30 +1026,10 @@ test("legacyKeyGlobalLoadsWithoutWritingAndFirstWriteLeavesOneGlobal", async ()
|
||||||
assert.deepEqual(await new SingleFileMessagePackBackingStore(storePath).pullAll(), []);
|
assert.deepEqual(await new SingleFileMessagePackBackingStore(storePath).pullAll(), []);
|
||||||
|
|
||||||
// Two globals of one type on disk, under any keys, are refused.
|
// Two globals of one type on disk, under any keys, are refused.
|
||||||
await rm(storePath);
|
|
||||||
await new SingleFileMessagePackBackingStore(storePath).pushAll([legacy, { ...legacy, key: CultCache.GLOBAL_KEY }]);
|
await new SingleFileMessagePackBackingStore(storePath).pushAll([legacy, { ...legacy, key: CultCache.GLOBAL_KEY }]);
|
||||||
await assert.rejects(build().pullAllBackingStores(), /has multiple persisted entries/u);
|
await assert.rejects(build().pullAllBackingStores(), /has multiple persisted entries/u);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("a flush of a cache that loaded a legacy-key global leaves the store reopenable", async () => {
|
|
||||||
const settingsDocument = defineDocumentType({ type: "settings", schema: z.object({ t: z.string() }), global: true });
|
|
||||||
const storePath = join(await mkdtemp(join(tmpdir(), "cultcache-legacy-flush-")), "generic.cc");
|
|
||||||
const store = new SingleFileMessagePackBackingStore(storePath);
|
|
||||||
const build = () => CultCache.builder().withRegistry(defineDocumentRegistry(settingsDocument)).withGenericStore(store).build();
|
|
||||||
const seed = CultCache.builder().withRegistry(defineDocumentRegistry(settingsDocument)).build();
|
|
||||||
await seed.putGlobal(settingsDocument, { t: "old" });
|
|
||||||
await store.push({ ...seed.getRequiredEnvelope(settingsDocument, CultCache.GLOBAL_KEY), key: "legacy" });
|
|
||||||
|
|
||||||
const cache = build();
|
|
||||||
await cache.pullAllBackingStores();
|
|
||||||
assert.equal(cache.snapshot()[0]!.key, CultCache.GLOBAL_KEY, "the logical image names the global by the global key");
|
|
||||||
await store.pushAll(cache.storedSnapshot());
|
|
||||||
assert.deepEqual((await store.pullAll()).map((entry) => entry.key), ["legacy"], "the flush wrote the record under the key the store holds it");
|
|
||||||
const reopened = build();
|
|
||||||
await reopened.pullAllBackingStores();
|
|
||||||
assert.deepEqual(reopened.getRequiredGlobal(settingsDocument), { t: "old" });
|
|
||||||
});
|
|
||||||
|
|
||||||
test("concurrentPutAndAttachCannotLandRecordInNonHomeStore", async () => {
|
test("concurrentPutAndAttachCannotLandRecordInNonHomeStore", async () => {
|
||||||
const settingsDocument = defineDocumentType({ type: "settings", schema: z.object({ t: z.string() }) });
|
const settingsDocument = defineDocumentType({ type: "settings", schema: z.object({ t: z.string() }) });
|
||||||
const tempDir = await mkdtemp(join(tmpdir(), "cultcache-put-attach-race-"));
|
const tempDir = await mkdtemp(join(tmpdir(), "cultcache-put-attach-race-"));
|
||||||
|
|
@ -1273,48 +1252,6 @@ test("CultCache v1 MessagePack stores are readable across TS, Rust, C#, and Pyth
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
// A Bifrost-shaped store (a union field, nested bytes) written by one of C# and Rust is opened by the other: C# reads through
|
|
||||||
// its store, Rust through the read-only snapshot door, which takes no lock and writes nothing. Leftover staging files from an
|
|
||||||
// interrupted write of either runtime sit beside the store; a read neither deletes them nor lets them change what it reads, and
|
|
||||||
// the store file's bytes are the same after every read.
|
|
||||||
test("A store written by C# or Rust with a union and nested bytes is read back equal by the other, read-only, past leftover staging files", async () => {
|
|
||||||
await buildInteropPeers();
|
|
||||||
const tempDir = await mkdtemp(join(tmpdir(), "cultcache-shapes-"));
|
|
||||||
const rustRead = (file: string) => runJsonCommand("rust-read-shapes", rustInteropBinary, ["read-shapes", "--file", file], cultcacheRsRoot);
|
|
||||||
const csharpRead = (file: string) => runJsonCommand("csharp-read-shapes", dotnetCommand, [csharpInteropDll, "read-shapes", "--file", file], cultLibRoot);
|
|
||||||
const peers = [
|
|
||||||
{
|
|
||||||
writer: "csharp",
|
|
||||||
write: (file: string) => runJsonCommand("csharp-write-shapes", dotnetCommand, [csharpInteropDll, "write-shapes", "--file", file], cultLibRoot),
|
|
||||||
read: rustRead,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
writer: "rust",
|
|
||||||
write: (file: string) => runJsonCommand("rust-write-shapes", rustInteropBinary, ["write-shapes", "--file", file], cultcacheRsRoot),
|
|
||||||
read: csharpRead,
|
|
||||||
},
|
|
||||||
];
|
|
||||||
for (const { writer, write, read } of peers) {
|
|
||||||
const file = join(tempDir, `${writer}.cc`);
|
|
||||||
const written = await write(file);
|
|
||||||
assert.equal(written.length, 2);
|
|
||||||
// The leftovers an interrupted write leaves: C# stages as `.<name>.<guid N>.tmp`, Rust as `<name>.<guid>.tmp`; both hold partial bytes.
|
|
||||||
const leftovers = [
|
|
||||||
join(tempDir, `.${writer}.cc.0123456789abcdef0123456789abcdef.tmp`),
|
|
||||||
join(tempDir, `${writer}.cc.00000000-0000-4000-8000-000000000000.tmp`),
|
|
||||||
];
|
|
||||||
for (const leftover of leftovers) {
|
|
||||||
await writeFile(leftover, Buffer.from([0x93, 0xb2]));
|
|
||||||
}
|
|
||||||
const before = await readFile(file);
|
|
||||||
assert.deepEqual(await read(file), written, `${writer}'s store did not read back equal`);
|
|
||||||
assert.deepEqual(await readFile(file), before, `reading ${writer}'s store changed its bytes`);
|
|
||||||
for (const leftover of leftovers) {
|
|
||||||
assert.ok(await exists(leftover), `reading ${writer}'s store removed ${leftover}`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
// Records and catalog entries a runtime does not own survive its writes. C# writes a store and each other runtime writes its own
|
// Records and catalog entries a runtime does not own survive its writes. C# writes a store and each other runtime writes its own
|
||||||
// note into it: C# reads its note back, and its record and catalog entry are as C# wrote them. C# then writes again, and the other
|
// note into it: C# reads its note back, and its record and catalog entry are as C# wrote them. C# then writes again, and the other
|
||||||
// runtime's record and catalog entry are as that runtime wrote them. Identity is compared on the decoded MessagePack values, every
|
// runtime's record and catalog entry are as that runtime wrote them. Identity is compared on the decoded MessagePack values, every
|
||||||
|
|
@ -2106,7 +2043,7 @@ async function readTsInteropStore(file: string): Promise<InteropNote> {
|
||||||
|
|
||||||
async function buildInteropPeers(): Promise<void> {
|
async function buildInteropPeers(): Promise<void> {
|
||||||
if (!(await exists(rustInteropBinary))) {
|
if (!(await exists(rustInteropBinary))) {
|
||||||
await execAsync(`"${cargoCommand}" build --locked --quiet --example cultcache_interop`, {
|
await execAsync(`"${cargoCommand}" build --quiet --example cultcache_interop`, {
|
||||||
cwd: cultcacheRsRoot,
|
cwd: cultcacheRsRoot,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
@ -2324,7 +2261,7 @@ test("a stamp this runtime reads, followed by bytes that are not UTF-8, gets the
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
test("pushAll leaves a store it reads alone when soft, and writes onto one it reads otherwise", async () => {
|
test("pushAll leaves a store it reads alone when soft, and replaces one it reads otherwise", async () => {
|
||||||
const vector = await readFile(resolve(cultLibRoot, "tests", "vectors", "document-variants-c2a", "v3-base.msgpack"));
|
const vector = await readFile(resolve(cultLibRoot, "tests", "vectors", "document-variants-c2a", "v3-base.msgpack"));
|
||||||
const envelope = { key: "probe", type: "probe", payload: documentPayloadFromBytes(new Uint8Array([0x80])), storedAt: "2026-10-22T00:00:00Z" };
|
const envelope = { key: "probe", type: "probe", payload: documentPayloadFromBytes(new Uint8Array([0x80])), storedAt: "2026-10-22T00:00:00Z" };
|
||||||
const existing = join(await mkdtemp(join(tmpdir(), "cultcache-pushall-soft-")), "store.msgpack");
|
const existing = join(await mkdtemp(join(tmpdir(), "cultcache-pushall-soft-")), "store.msgpack");
|
||||||
|
|
@ -2336,7 +2273,7 @@ test("pushAll leaves a store it reads alone when soft, and writes onto one it re
|
||||||
const store = new SingleFileMessagePackBackingStore(own);
|
const store = new SingleFileMessagePackBackingStore(own);
|
||||||
await store.pushAll([envelope]);
|
await store.pushAll([envelope]);
|
||||||
await store.pushAll([{ ...envelope, key: "second" }]);
|
await store.pushAll([{ ...envelope, key: "second" }]);
|
||||||
assert.deepEqual((await store.pullAll()).map((entry) => entry.key), ["probe", "second"]);
|
assert.deepEqual((await store.pullAll()).map((entry) => entry.key), ["second"]);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("SingleFileMessagePackBackingStore reads only a missing store as empty", async () => {
|
test("SingleFileMessagePackBackingStore reads only a missing store as empty", async () => {
|
||||||
|
|
@ -2467,36 +2404,12 @@ test("SingleFileMessagePackBackingStore refuses a dangling symlink at its path a
|
||||||
() => store.pullAll(),
|
() => store.pullAll(),
|
||||||
(error: NodeJS.ErrnoException) => error.code === "ENOENT" && error.message.includes("symbolic link") && error.message.includes(file),
|
(error: NodeJS.ErrnoException) => error.code === "ENOENT" && error.message.includes("symbolic link") && error.message.includes(file),
|
||||||
);
|
);
|
||||||
await assert.rejects(() => store.push(envelope), (error: unknown) => error instanceof StoreLinkedError);
|
await assert.rejects(() => store.push(envelope), (error: NodeJS.ErrnoException) => error.code === "ENOENT");
|
||||||
await assert.rejects(() => store.pushAll([envelope], { soft: true }), (error: unknown) => error instanceof StoreLinkedError);
|
await assert.rejects(() => store.pushAll([envelope], { soft: true }), (error: NodeJS.ErrnoException) => error.code === "ENOENT");
|
||||||
assert.ok((await lstat(file)).isSymbolicLink());
|
assert.ok((await lstat(file)).isSymbolicLink());
|
||||||
assert.deepEqual(await readdir(volume), []);
|
assert.deepEqual(await readdir(volume), []);
|
||||||
});
|
});
|
||||||
|
|
||||||
// The advisory query answers for the held record and the cache's judges; a link at the store path is the write's to refuse.
|
|
||||||
test("isWritable over a store at a live link answers true while the cache write is refused", { skip: process.platform === "win32" }, async () => {
|
|
||||||
const dir = await mkdtemp(join(tmpdir(), "cultcache-writable-link-"));
|
|
||||||
const volume = join(dir, "volume");
|
|
||||||
await mkdir(volume);
|
|
||||||
const target = join(volume, "store.cc");
|
|
||||||
const link = join(dir, "link.cc");
|
|
||||||
const document = defineDocumentType({ type: "note", schema: z.object({ text: z.string() }) });
|
|
||||||
await CultCache.builder().withDocumentType(document).withGenericStore(new SingleFileMessagePackBackingStore(target)).build()
|
|
||||||
.put(document, "held", { text: "held" });
|
|
||||||
const before = await readFile(target);
|
|
||||||
await symlink(target, link);
|
|
||||||
const cache = CultCache.builder().withDocumentType(document).withGenericStore(new SingleFileMessagePackBackingStore(link)).build();
|
|
||||||
await cache.pullAllBackingStores();
|
|
||||||
const namesBefore = [(await readdir(dir)).sort(), (await readdir(volume)).sort()];
|
|
||||||
|
|
||||||
assert.equal(cache.isWritable(document, "held"), true);
|
|
||||||
assert.equal(cache.isWritable(document, "fresh"), true);
|
|
||||||
await assert.rejects(() => cache.put(document, "fresh", { text: "fresh" }), (error: unknown) => error instanceof StoreLinkedError && error.path === link);
|
|
||||||
assert.ok((await lstat(link)).isSymbolicLink());
|
|
||||||
assert.deepEqual(await readFile(target), before);
|
|
||||||
assert.deepEqual([(await readdir(dir)).sort(), (await readdir(volume)).sort()], namesBefore);
|
|
||||||
});
|
|
||||||
|
|
||||||
// The second look of the read, staged: nothing is at the path only when the read and the lstat both find nothing. A path
|
// The second look of the read, staged: nothing is at the path only when the read and the lstat both find nothing. A path
|
||||||
// that changed between them (a link in a parent swapped for a file, a store that appeared) is never an empty store.
|
// that changed between them (a link in a parent swapped for a file, a store that appeared) is never an empty store.
|
||||||
test("readStoreBytes reports nothing at the path only when the lstat finds nothing too", async () => {
|
test("readStoreBytes reports nothing at the path only when the lstat finds nothing too", async () => {
|
||||||
|
|
@ -2533,9 +2446,9 @@ test("SingleFileMessagePackBackingStore record refusal names only a string key",
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
// A write at a store path that is a link is refused: a replace there would swap the link for a regular file and
|
// What a write does through a symbolic link today. R3 decides whether a write resolves the link
|
||||||
// detach the store from its target. Reads through a live link keep working.
|
// or refuses it; these pin the current behaviour so that change is deliberate.
|
||||||
test("a write at a live link is refused and nothing changes, while a read through it still works", { skip: process.platform === "win32" }, async () => {
|
test("R3 decides resolve-or-refuse: a push through a live link replaces the link", { skip: process.platform === "win32" }, async () => {
|
||||||
const dir = await mkdtemp(join(tmpdir(), "cultcache-live-link-"));
|
const dir = await mkdtemp(join(tmpdir(), "cultcache-live-link-"));
|
||||||
const volume = join(dir, "volume");
|
const volume = join(dir, "volume");
|
||||||
await mkdir(volume);
|
await mkdir(volume);
|
||||||
|
|
@ -2543,42 +2456,21 @@ test("a write at a live link is refused and nothing changes, while a read throug
|
||||||
const envelope = { key: "a", type: "t", payload: documentPayloadFromBytes(Uint8Array.of(0x90)), storedAt: "2026-09-30T00:00:00Z" };
|
const envelope = { key: "a", type: "t", payload: documentPayloadFromBytes(Uint8Array.of(0x90)), storedAt: "2026-09-30T00:00:00Z" };
|
||||||
await new SingleFileMessagePackBackingStore(target).push(envelope);
|
await new SingleFileMessagePackBackingStore(target).push(envelope);
|
||||||
const before = await readFile(target);
|
const before = await readFile(target);
|
||||||
const volumeBefore = (await readdir(volume)).sort();
|
const link = join(dir, "store.cc");
|
||||||
const link = join(dir, "link.cc");
|
|
||||||
await symlink(target, link);
|
await symlink(target, link);
|
||||||
const store = new SingleFileMessagePackBackingStore(link);
|
await new SingleFileMessagePackBackingStore(link).push({ ...envelope, key: "b" });
|
||||||
const refused = (error: unknown) => error instanceof StoreLinkedError && error.path === link && error.message.includes(link);
|
assert.ok((await lstat(link)).isFile());
|
||||||
await assert.rejects(() => store.push({ ...envelope, key: "b" }), refused);
|
|
||||||
await assert.rejects(() => store.pushAll([{ ...envelope, key: "b" }]), refused);
|
|
||||||
await assert.rejects(() => store.delete(envelope), refused);
|
|
||||||
assert.ok((await lstat(link)).isSymbolicLink());
|
|
||||||
assert.deepEqual(await readFile(target), before);
|
assert.deepEqual(await readFile(target), before);
|
||||||
assert.deepEqual((await readdir(dir)).sort(), ["link.cc", "volume"]);
|
|
||||||
assert.deepEqual((await readdir(volume)).sort(), volumeBefore);
|
|
||||||
assert.deepEqual((await store.pullAll()).map((e) => e.key), ["a"]);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
test("a write at a live directory link is refused as a link", { skip: process.platform === "win32" }, async () => {
|
test("R3 decides resolve-or-refuse: a pushAll through a dangling link replaces the link", { skip: process.platform === "win32" }, async () => {
|
||||||
const dir = await mkdtemp(join(tmpdir(), "cultcache-dir-link-"));
|
|
||||||
const realDir = join(dir, "real");
|
|
||||||
await mkdir(realDir);
|
|
||||||
const link = join(dir, "dirlink");
|
|
||||||
await symlink(realDir, link);
|
|
||||||
const envelope = { key: "a", type: "t", payload: documentPayloadFromBytes(Uint8Array.of(0x90)), storedAt: "2026-09-30T00:00:00Z" };
|
|
||||||
await assert.rejects(() => new SingleFileMessagePackBackingStore(link).push(envelope), (error: unknown) => error instanceof StoreLinkedError);
|
|
||||||
assert.ok((await lstat(link)).isSymbolicLink());
|
|
||||||
assert.deepEqual(await readdir(realDir), []);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a pushAll through a dangling link is refused like push, and the link and its volume are left as they were", { skip: process.platform === "win32" }, async () => {
|
|
||||||
const dir = await mkdtemp(join(tmpdir(), "cultcache-dangling-push-all-"));
|
const dir = await mkdtemp(join(tmpdir(), "cultcache-dangling-push-all-"));
|
||||||
const volume = join(dir, "volume");
|
const volume = join(dir, "volume");
|
||||||
await mkdir(volume);
|
await mkdir(volume);
|
||||||
const link = join(dir, "store.cc");
|
const link = join(dir, "store.cc");
|
||||||
await symlink(join(volume, "store.cc"), link);
|
await symlink(join(volume, "store.cc"), link);
|
||||||
const envelope = { key: "a", type: "t", payload: documentPayloadFromBytes(Uint8Array.of(0x90)), storedAt: "2026-09-30T00:00:00Z" };
|
await new SingleFileMessagePackBackingStore(link).pushAll([{ key: "a", type: "t", payload: documentPayloadFromBytes(Uint8Array.of(0x90)), storedAt: "2026-09-30T00:00:00Z" }]);
|
||||||
await assert.rejects(() => new SingleFileMessagePackBackingStore(link).pushAll([envelope]), (error: unknown) => error instanceof StoreLinkedError);
|
assert.ok((await lstat(link)).isFile());
|
||||||
assert.ok((await lstat(link)).isSymbolicLink());
|
|
||||||
assert.deepEqual(await readdir(volume), []);
|
assert.deepEqual(await readdir(volume), []);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|
@ -2683,7 +2575,7 @@ test("SingleFileMessagePackBackingStore pushAll refuses a store whose header it
|
||||||
|
|
||||||
// A file is replaced by a rewrite exactly when this runtime's own reader opens it: one verdict per file, asked by pullAll,
|
// A file is replaced by a rewrite exactly when this runtime's own reader opens it: one verdict per file, asked by pullAll,
|
||||||
// pushAll, soft pushAll, push and delete alike; a soft flush leaves the files that read as they are. The bytes and every runtime's verdict: tests/vectors/document-variants-c2a/readability.
|
// pushAll, soft pushAll, push and delete alike; a soft flush leaves the files that read as they are. The bytes and every runtime's verdict: tests/vectors/document-variants-c2a/readability.
|
||||||
test("SingleFileMessagePackBackingStore rewrites a file exactly when it reads", async () => {
|
test("SingleFileMessagePackBackingStore replaces a file exactly when it reads", async () => {
|
||||||
const root = join(c2aVectors, "readability");
|
const root = join(c2aVectors, "readability");
|
||||||
const rows = (await readFile(join(root, "manifest.txt"), "utf8"))
|
const rows = (await readFile(join(root, "manifest.txt"), "utf8"))
|
||||||
.split(/\r?\n/u)
|
.split(/\r?\n/u)
|
||||||
|
|
@ -2720,7 +2612,6 @@ test("SingleFileMessagePackBackingStore rewrites a file exactly when it reads",
|
||||||
? store.push(envelopes[0]!)
|
? store.push(envelopes[0]!)
|
||||||
: store.delete(envelopes[0]!);
|
: store.delete(envelopes[0]!);
|
||||||
if (reads) {
|
if (reads) {
|
||||||
const heldBefore = operation === "pushAll" ? (await new SingleFileMessagePackBackingStore(file).pullAll()).map((entry) => entry.key) : [];
|
|
||||||
await run();
|
await run();
|
||||||
if (operation === "pullAll") {
|
if (operation === "pullAll") {
|
||||||
continue;
|
continue;
|
||||||
|
|
@ -2737,8 +2628,7 @@ test("SingleFileMessagePackBackingStore rewrites a file exactly when it reads",
|
||||||
assert.equal((decode(await readFile(file)) as unknown[])[0], vector.includes("v3") ? "cultcache.store.v3" : "cultcache.store.v1", `${vector} ${operation}`);
|
assert.equal((decode(await readFile(file)) as unknown[])[0], vector.includes("v3") ? "cultcache.store.v3" : "cultcache.store.v1", `${vector} ${operation}`);
|
||||||
const keys = (await new SingleFileMessagePackBackingStore(file).pullAll()).map((entry) => entry.key);
|
const keys = (await new SingleFileMessagePackBackingStore(file).pullAll()).map((entry) => entry.key);
|
||||||
if (operation === "pushAll") {
|
if (operation === "pushAll") {
|
||||||
assert.deepEqual(envelopes.map((entry) => entry.key).filter((key) => !keys.includes(key)), [], `${vector} ${operation}: every written key is held`);
|
assert.deepEqual(keys, envelopes.map((entry) => entry.key).sort(), `${vector} ${operation}`);
|
||||||
assert.deepEqual(heldBefore.filter((key) => !keys.includes(key)), [], `${vector} ${operation}: nothing else is removed`);
|
|
||||||
} else if (operation === "push") {
|
} else if (operation === "push") {
|
||||||
assert.ok(keys.includes(envelopes[0]!.key), `${vector} ${operation}`);
|
assert.ok(keys.includes(envelopes[0]!.key), `${vector} ${operation}`);
|
||||||
} else {
|
} else {
|
||||||
|
|
@ -2872,6 +2762,7 @@ test("every registration refusal is a SchemaConflictError naming the id and both
|
||||||
// Cross-runtime store lock: each runtime's writer excludes the others on `<file>.lock`.
|
// Cross-runtime store lock: each runtime's writer excludes the others on `<file>.lock`.
|
||||||
|
|
||||||
import { spawn } from "node:child_process";
|
import { spawn } from "node:child_process";
|
||||||
|
import { withStoreWriteLock } from "../src/store-file";
|
||||||
|
|
||||||
type LockHolder = { exited: Promise<number | null>; stderr: () => string };
|
type LockHolder = { exited: Promise<number | null>; stderr: () => string };
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -46,21 +46,6 @@ async function firstCall(path: string) {
|
||||||
}
|
}
|
||||||
// snippet:end
|
// snippet:end
|
||||||
|
|
||||||
// The update snippet, which docs/start/README.md shows after the first call and which uses its definitions.
|
|
||||||
// snippet:update:begin
|
|
||||||
async function restock(path: string) {
|
|
||||||
const cache = CultCache.builder()
|
|
||||||
.withRegistry(registry)
|
|
||||||
.withGenericStore(new SingleFileMessagePackBackingStore(path))
|
|
||||||
.build();
|
|
||||||
await cache.pullAllBackingStores();
|
|
||||||
return cache.update(itemDocument, "item:potion", (item) => {
|
|
||||||
const current = item ?? { name: "Potion", category: "Consumable", value: 0 };
|
|
||||||
return { ...current, value: current.value + 10 };
|
|
||||||
});
|
|
||||||
}
|
|
||||||
// snippet:update:end
|
|
||||||
|
|
||||||
test("define, store and read back a typed document", async () => {
|
test("define, store and read back a typed document", async () => {
|
||||||
const dir = await mkdtemp(join(tmpdir(), "cultcache-first-call-"));
|
const dir = await mkdtemp(join(tmpdir(), "cultcache-first-call-"));
|
||||||
try {
|
try {
|
||||||
|
|
@ -72,35 +57,13 @@ test("define, store and read back a typed document", async () => {
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
test("update with retry: restock twice reads value 20 through a second cache", async () => {
|
test("docs show the tested snippet", async () => {
|
||||||
const dir = await mkdtemp(join(tmpdir(), "cultcache-first-call-"));
|
|
||||||
try {
|
|
||||||
const path = join(dir, "restock.cc");
|
|
||||||
assert.equal((await restock(path)).outcome, "updated");
|
|
||||||
assert.equal((await restock(path)).outcome, "updated");
|
|
||||||
const reopened = CultCache.builder()
|
|
||||||
.withRegistry(registry)
|
|
||||||
.withGenericStore(new SingleFileMessagePackBackingStore(path))
|
|
||||||
.build();
|
|
||||||
await reopened.pullAllBackingStores();
|
|
||||||
assert.equal(reopened.get(itemDocument, "item:potion")?.value, 20);
|
|
||||||
} finally {
|
|
||||||
await rm(dir, { recursive: true, force: true });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
// The docs show the region between `// snippet:<region>begin` and `end` markers verbatim, the package import aside.
|
|
||||||
async function assertDocsShow(region: "" | "update:") {
|
|
||||||
// Compiled to dist-test/test/first-call.test.js, so the package root is two levels up.
|
// Compiled to dist-test/test/first-call.test.js, so the package root is two levels up.
|
||||||
const source = await readFile(join(__dirname, "..", "..", "test", "first-call.test.ts"), "utf8");
|
const source = await readFile(join(__dirname, "..", "..", "test", "first-call.test.ts"), "utf8");
|
||||||
const snippet = source
|
const snippet = source
|
||||||
.split(`// snippet:${region}begin\n`)[1]
|
.split("// snippet:begin\n")[1]
|
||||||
.split(`// snippet:${region}end\n`)[0]
|
.split("// snippet:end\n")[0]
|
||||||
.replace('"../src/index"', '"@gamecult/cultcache-ts"');
|
.replace('"../src/index"', '"@gamecult/cultcache-ts"');
|
||||||
const docs = (await readFile(join(__dirname, "..", "..", "..", "..", "docs", "start", "README.md"), "utf8")).replace(/\r\n/g, "\n");
|
const docs = (await readFile(join(__dirname, "..", "..", "..", "..", "docs", "start", "README.md"), "utf8")).replace(/\r\n/g, "\n");
|
||||||
assert.ok(docs.includes("```ts\n" + snippet + "```"), `docs/start/README.md no longer shows the ${region || "first-call "}region of test/first-call.test.ts`);
|
assert.ok(docs.includes("```ts\n" + snippet + "```"), "docs/start/README.md no longer shows test/first-call.test.ts");
|
||||||
}
|
});
|
||||||
|
|
||||||
test("docs show the tested snippet", () => assertDocsShow(""));
|
|
||||||
|
|
||||||
test("docs show the tested update snippet", () => assertDocsShow("update:"));
|
|
||||||
|
|
|
||||||
|
|
@ -119,19 +119,6 @@ test("a payload that ends early, is empty or carries trailing bytes is the reade
|
||||||
assert.doesNotThrow(() => checkPayloadDepth(bytes(0xc0)));
|
assert.doesNotThrow(() => checkPayloadDepth(bytes(0xc0)));
|
||||||
});
|
});
|
||||||
|
|
||||||
test("the walk returns where the first value ends, and undefined when the payload ends early", () => {
|
|
||||||
assert.equal(checkPayloadDepth(bytes(0xc0)), 1);
|
|
||||||
assert.equal(checkPayloadDepth(bytes(0xc0, 0xc1, 0xc1)), 1, "a top-level scalar ends at its own length; the tail is not judged");
|
|
||||||
assert.equal(checkPayloadDepth(bytes(0x92, 0x01, 0xa1, 0x61, 0xc0)), 5 - 1, "a container ends when its last child completes");
|
|
||||||
assert.equal(checkPayloadDepth(cat(bytes(0x90), arrays(L + 50))), 1, "the tail is never walked");
|
|
||||||
assert.equal(checkPayloadDepth(bytes()), undefined);
|
|
||||||
assert.equal(checkPayloadDepth(bytes(0x92, 0x01)), undefined);
|
|
||||||
assert.equal(checkPayloadDepth(bytes(0xd9)), undefined);
|
|
||||||
for (const cut of [[0xcc], [0xcb, 0x3f, 0xf8], [0xa5, 0x61, 0x62, 0x63], [0xc4, 0x02, 0x01], [0xd7, 0x01]]) {
|
|
||||||
assert.equal(checkPayloadDepth(bytes(...cut)), undefined, `a scalar cut short: ${cut.map((value) => value.toString(16)).join(" ")}`);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
test("the walk is iterative: 100000 nested arrays are refused with the depth error, not a RangeError", () => {
|
test("the walk is iterative: 100000 nested arrays are refused with the depth error, not a RangeError", () => {
|
||||||
refused(arrays(100_000), "100000 nested arrays");
|
refused(arrays(100_000), "100000 nested arrays");
|
||||||
refused(chain(bytes(0x81, 0x00), 100_000), "100000 nested maps");
|
refused(chain(bytes(0x81, 0x00), 100_000), "100000 nested maps");
|
||||||
|
|
@ -211,13 +198,6 @@ test("the inspector previews a payload at the limit and reports one past it, or
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
test("the inspector refuses bytes after a payload's first value with the shared clause and previews no tail", async () => {
|
|
||||||
const file = await storeWith(bytes(0xc0, 0xc1, 0xc1));
|
|
||||||
const record = inspectCultCacheBytes(file, await readFile(file)).records[0]!;
|
|
||||||
assert.equal(record.payloadDecodeError, "document payload has 2 bytes after its first MessagePack value.");
|
|
||||||
assert.deepEqual(record.payloadPreview, { bytes: 3, hexPrefix: "c0" });
|
|
||||||
});
|
|
||||||
|
|
||||||
// A header whose length or count needs all four bytes: the low sixteen bits of the length are small, the whole is not.
|
// A header whose length or count needs all four bytes: the low sixteen bits of the length are small, the whole is not.
|
||||||
const be32 = (n: number) => bytes((n >>> 24) & 0xff, (n >>> 16) & 0xff, (n >>> 8) & 0xff, n & 0xff);
|
const be32 = (n: number) => bytes((n >>> 24) & 0xff, (n >>> 16) & 0xff, (n >>> 8) & 0xff, n & 0xff);
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,461 +0,0 @@
|
||||||
import assert from "node:assert/strict";
|
|
||||||
import { copyFile, mkdtemp, readFile, writeFile } from "node:fs/promises";
|
|
||||||
import { tmpdir } from "node:os";
|
|
||||||
import { join } from "node:path";
|
|
||||||
import { test } from "node:test";
|
|
||||||
|
|
||||||
import { decode, encode } from "@msgpack/msgpack";
|
|
||||||
import { z } from "zod";
|
|
||||||
|
|
||||||
import { codecs } from "../src";
|
|
||||||
import { CultCache } from "../src/cult-cache";
|
|
||||||
import { defineDocumentType, documentPayloadBytes, documentPayloadFromBytes } from "../src/document";
|
|
||||||
import { SingleFileMessagePackBackingStore, readSingleFileStore } from "../src/single-file-messagepack-backing-store";
|
|
||||||
import { SchemaConflictError, StoreUnreadableError } from "../src/store-format";
|
|
||||||
import type { CacheBackingStore, CultCacheEnvelope, CultCacheUnreadSlots } from "../src/types";
|
|
||||||
import {
|
|
||||||
type Surface, envelopeOf, golden, hex, memoryStore, read, slotUnitDocument, surfaceCodec, surfaceDeclaringDocument, surfaceDocument, surfaceSchema, vectors,
|
|
||||||
} from "./union-surface-fixture";
|
|
||||||
|
|
||||||
// cultlib-gaps:cut:slot-readonly-ts. A payload carrying a slot past its reader's declared slots, at any depth, is read, held
|
|
||||||
// read-only, and every write or removal of its key is refused before a store is touched. The vectors are written by the C#
|
|
||||||
// reference: tests/vectors/union-parity/README.md, "Extra trailing slot" and "Slot stores".
|
|
||||||
|
|
||||||
const { slots, string } = codecs;
|
|
||||||
const SLOT_VALUE = "extra-slot";
|
|
||||||
|
|
||||||
function mark(typeName: string, slotCount: number, declaredCount: number, depth0Only: boolean, explained = false, occurrences = 1): CultCacheUnreadSlots {
|
|
||||||
return { typeName, slotCount, declaredCount, occurrences, depth0Only, explained };
|
|
||||||
}
|
|
||||||
|
|
||||||
// File, then the mark the README table gives for it.
|
|
||||||
const PAYLOAD_ROWS: [string, CultCacheUnreadSlots][] = [
|
|
||||||
["extra-slot-record.msgpack", mark("UnionSurface", 8, 7, true)],
|
|
||||||
["extra-slot-nested-record.msgpack", mark("Composition", 3, 2, false)],
|
|
||||||
["extra-slot-arm.msgpack", mark("Box", 3, 2, false)],
|
|
||||||
["extra-slot-list-element.msgpack", mark("Text", 3, 2, false)],
|
|
||||||
["depth-skipped-at-limit.msgpack", mark("UnionSurface", 8, 7, true)],
|
|
||||||
];
|
|
||||||
|
|
||||||
async function readOnlyFiles(name: string): Promise<string[]> {
|
|
||||||
const rows = decode(await read(name)) as unknown[][];
|
|
||||||
return rows.filter((row) => row[1] === "read-only").map((row) => row[0] as string);
|
|
||||||
}
|
|
||||||
|
|
||||||
test("the read-only payload vectors are exactly the ones this walker names: four in outcomes, one in bounds", async () => {
|
|
||||||
const listed = [...(await readOnlyFiles("outcomes.msgpack")), ...(await readOnlyFiles("bounds-outcomes.msgpack"))];
|
|
||||||
assert.deepEqual(listed.sort(), PAYLOAD_ROWS.map(([file]) => file).sort());
|
|
||||||
});
|
|
||||||
|
|
||||||
for (const [file, expected] of PAYLOAD_ROWS) {
|
|
||||||
test(`${file}: read past the extra slot, held read-only with the mark, every write and removal of the key refused`, async () => {
|
|
||||||
const document = surfaceDocument();
|
|
||||||
const entries = [envelopeOf(await read(file))];
|
|
||||||
const before = hex(documentPayloadBytes(entries[0]!.payload));
|
|
||||||
const cache = CultCache.builder().withDocumentType(document).withGenericStore(memoryStore(entries)).build();
|
|
||||||
await cache.pullAllBackingStores();
|
|
||||||
|
|
||||||
assert.deepEqual(cache.get(document, "surface"), golden, "the extra slot is read past");
|
|
||||||
assert.deepEqual(cache.unreadSlots(document, "surface"), expected);
|
|
||||||
assert.equal(cache.isWritable(document, "surface"), false);
|
|
||||||
assert.equal(cache.isWritable(document, "another"), true);
|
|
||||||
|
|
||||||
const refused = (error: unknown) => {
|
|
||||||
assert.ok(error instanceof SchemaConflictError, "a SchemaConflictError");
|
|
||||||
assert.deepEqual(error.unreadSlots, expected);
|
|
||||||
assert.equal(error.recordKey, "surface");
|
|
||||||
assert.ok(error.message.includes(expected.typeName), error.message);
|
|
||||||
assert.ok(error.message.includes(`read with ${expected.slotCount} slots where this build declares ${expected.declaredCount} (${expected.occurrences} object(s)`), error.message);
|
|
||||||
assert.ok(!error.message.includes(SLOT_VALUE), "the refusal never holds a slot value");
|
|
||||||
return true;
|
|
||||||
};
|
|
||||||
await assert.rejects(() => cache.put(document, "surface", golden), refused);
|
|
||||||
await assert.rejects(() => cache.update(document, "surface", (value) => ({ ...value!, version: 4 })), refused);
|
|
||||||
const replacement = envelopeOf(await read("union-surface.msgpack"));
|
|
||||||
await assert.rejects(() => cache.putEnvelope(document, replacement), refused);
|
|
||||||
await assert.rejects(() => cache.delete(document, "surface"), refused);
|
|
||||||
assert.equal(entries.length, 1, "nothing reached the store");
|
|
||||||
assert.equal(hex(documentPayloadBytes(entries[0]!.payload)), before, "the held bytes are untouched");
|
|
||||||
assert.deepEqual(cache.get(document, "surface"), golden, "the record is still held");
|
|
||||||
|
|
||||||
await cache.put(document, "another", golden);
|
|
||||||
assert.equal(entries.length, 2, "another key of the same store writes");
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
test("a clean payload and a short one are writable: missing trailing slots keep the defaults and mark nothing", async () => {
|
|
||||||
const document = surfaceDocument();
|
|
||||||
const short = encode([...(decode(await read("union-surface.msgpack")) as unknown[]).slice(0, 6)]);
|
|
||||||
const entries = [envelopeOf(await read("union-surface.msgpack")), { ...envelopeOf(short), key: "short" }];
|
|
||||||
const cache = CultCache.builder().withDocumentType(document).withGenericStore(memoryStore(entries)).build();
|
|
||||||
await cache.pullAllBackingStores();
|
|
||||||
for (const key of ["surface", "short"]) {
|
|
||||||
assert.equal(cache.unreadSlots(document, key), undefined);
|
|
||||||
assert.equal(cache.isWritable(document, key), true);
|
|
||||||
}
|
|
||||||
await cache.put(document, "short", golden);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a payload past the nesting limit is refused, never marked", async () => {
|
|
||||||
const entries = [envelopeOf(await read("depth-skipped-past-limit.msgpack"))];
|
|
||||||
const cache = CultCache.builder().withDocumentType(surfaceDocument()).withGenericStore(memoryStore(entries)).build();
|
|
||||||
await assert.rejects(() => cache.pullAllBackingStores(), /nesting|depth/iu);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("putEnvelope of a payload carrying extra slots lands the bytes and holds the record read-only", async () => {
|
|
||||||
const document = surfaceDocument();
|
|
||||||
const entries: ReturnType<typeof envelopeOf>[] = [];
|
|
||||||
const cache = CultCache.builder().withDocumentType(document).withGenericStore(memoryStore(entries)).build();
|
|
||||||
const marked = envelopeOf(await read("extra-slot-nested-record.msgpack"));
|
|
||||||
await cache.putEnvelope(document, marked);
|
|
||||||
assert.equal(hex(documentPayloadBytes(entries[0]!.payload)), hex(await read("extra-slot-nested-record.msgpack")), "the bytes are carried");
|
|
||||||
assert.deepEqual(cache.unreadSlots(document, "surface"), mark("Composition", 3, 2, false));
|
|
||||||
assert.equal(cache.isWritable(document, "surface"), false);
|
|
||||||
await assert.rejects(() => cache.put(document, "surface", golden), SchemaConflictError);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a key a store carries foreign is not writable", async () => {
|
|
||||||
const document = surfaceDocument();
|
|
||||||
const foreign = { ...envelopeOf(await read("union-surface.msgpack")), key: "stranger", type: "tests.unknown", schemaId: "tests.unknown.v1" };
|
|
||||||
const cache = CultCache.builder().withDocumentType(document).withGenericStore(memoryStore([foreign])).build();
|
|
||||||
await cache.pullAllBackingStores();
|
|
||||||
assert.equal(cache.isWritable(document, "stranger"), false);
|
|
||||||
assert.equal(cache.isWritable(document, "other"), true);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a write by a type that owns the held record's id restamps it, and is refused when that record carries unread slots", async () => {
|
|
||||||
const typed = (type: string, schemaId: string, compatibleSchemaIds: string[] = []) =>
|
|
||||||
defineDocumentType({ type, schemaId, schemaName: type, schemaVersion: `${type}.v1`, compatibleSchemaIds, schema: surfaceSchema, codec: surfaceCodec, name: "id" });
|
|
||||||
const older = typed("tests.surface_older", "tests.surface_older.v1");
|
|
||||||
const newer = typed("tests.surface_newer", "tests.surface_newer.v1", ["tests.surface_older.v1"]);
|
|
||||||
for (const [file, lands] of [["union-surface.msgpack", true], ["extra-slot-record.msgpack", false]] as const) {
|
|
||||||
const held = { ...envelopeOf(await read(file)), type: older.type, schemaId: "tests.surface_older.v1" };
|
|
||||||
const cache = CultCache.builder().withDocumentType(older).withDocumentType(newer).withGenericStore(memoryStore([held])).build();
|
|
||||||
await cache.pullAllBackingStores();
|
|
||||||
assert.equal(cache.isWritable(newer, "surface"), lands, `${file}: isWritable agrees with the write by the type that owns the id`);
|
|
||||||
const write = cache.put(newer, "surface", golden);
|
|
||||||
if (lands) {
|
|
||||||
await write;
|
|
||||||
} else {
|
|
||||||
await assert.rejects(() => write, (error: unknown) => error instanceof SchemaConflictError && error.unreadSlots?.typeName === "UnionSurface");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
// The store vectors. TS has no variant records: extra-slot-store.cc carries one (marked-variant), so the whole file is refused
|
|
||||||
// by name, and the walk runs over the file without that record.
|
|
||||||
async function copyOf(name: string): Promise<string> {
|
|
||||||
const path = join(await mkdtemp(join(tmpdir(), "slot-readonly-")), name);
|
|
||||||
await copyFile(join(vectors, name), path);
|
|
||||||
return path;
|
|
||||||
}
|
|
||||||
|
|
||||||
async function withoutVariant(path: string): Promise<void> {
|
|
||||||
const [format, catalog, records] = decode(await readFile(path)) as [unknown, unknown[], unknown[][]];
|
|
||||||
await writeFile(path, encode([format, catalog, records.filter((record) => record[0] !== "marked-variant")]));
|
|
||||||
}
|
|
||||||
|
|
||||||
type SlotRow = [string, string, boolean, boolean | null, string | null, number | null, number | null, number | null, string | null];
|
|
||||||
|
|
||||||
async function slotRows(): Promise<SlotRow[]> {
|
|
||||||
return decode(await read("slot-outcomes.msgpack")) as SlotRow[];
|
|
||||||
}
|
|
||||||
|
|
||||||
// The catalog entry the file publishes for a schema: its id and the reference's content hash, which a store rewrites with the
|
|
||||||
// definition's own.
|
|
||||||
async function catalogOf(file: string, schemaName: string): Promise<[string, string]> {
|
|
||||||
const [, catalog] = decode(await read(file)) as [unknown, string[][]];
|
|
||||||
const entry = catalog.find((candidate) => candidate[1] === schemaName)!;
|
|
||||||
return [entry[0]!, entry[3]!];
|
|
||||||
}
|
|
||||||
|
|
||||||
async function openStore(file: string, consent: boolean) {
|
|
||||||
const path = await copyOf(file);
|
|
||||||
if (file === "extra-slot-store.cc") await withoutVariant(path);
|
|
||||||
const surface = consent ? surfaceDeclaringDocument() : surfaceDocument(...(await catalogOf(file, "tests.union_surface")));
|
|
||||||
const slotUnit = consent ? undefined : slotUnitDocument(...(await catalogOf(file, "tests.slot_unit")));
|
|
||||||
const builder = CultCache.builder().withDocumentType(surface).withGenericStore(new SingleFileMessagePackBackingStore(path));
|
|
||||||
const cache = (slotUnit ? builder.withDocumentType(slotUnit) : builder).build();
|
|
||||||
await cache.pullAllBackingStores();
|
|
||||||
return { path, cache, surface, slotUnit };
|
|
||||||
}
|
|
||||||
|
|
||||||
test("extra-slot-store.cc carries a variant, which this runtime refuses by name; the rest of the file is walked", async () => {
|
|
||||||
const path = await copyOf("extra-slot-store.cc");
|
|
||||||
assert.throws(() => readSingleFileStore(path), StoreUnreadableError);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("every slot-outcomes row holds: the mark, IsWritable, and the removal refused exactly where the record is not writable", async () => {
|
|
||||||
const rows = await slotRows();
|
|
||||||
assert.equal(rows.length, 8);
|
|
||||||
let walked = 0;
|
|
||||||
for (const [file, key, writable, explained, typeName, slots, declared, occurrences, flattenRefusedBy] of rows) {
|
|
||||||
if (flattenRefusedBy !== null) continue; // a variant: this runtime holds none
|
|
||||||
walked += 1;
|
|
||||||
const { path, cache, surface, slotUnit } = await openStore(file!, file === "extra-slot-consent.cc");
|
|
||||||
const document = key === "unit-arm" ? slotUnit! : surface;
|
|
||||||
const label = `${file} ${key}`;
|
|
||||||
const found = cache.unreadSlots(document, key!);
|
|
||||||
if (typeName === null) {
|
|
||||||
assert.equal(found, undefined, label);
|
|
||||||
} else {
|
|
||||||
assert.ok(found, label);
|
|
||||||
assert.deepEqual([found.explained, found.typeName, found.slotCount, found.declaredCount, found.occurrences], [explained, typeName, slots, declared, occurrences], label);
|
|
||||||
}
|
|
||||||
assert.equal(cache.isWritable(document, key!), writable, label);
|
|
||||||
|
|
||||||
const original = await readFile(path);
|
|
||||||
if (writable) {
|
|
||||||
assert.equal(await cache.delete(document, key!), true, label);
|
|
||||||
} else {
|
|
||||||
await assert.rejects(
|
|
||||||
() => cache.delete(document, key!),
|
|
||||||
(error: unknown) => error instanceof SchemaConflictError && error.unreadSlots?.typeName === typeName && !error.message.includes(SLOT_VALUE),
|
|
||||||
label,
|
|
||||||
);
|
|
||||||
assert.equal(Buffer.compare(original, await readFile(path)), 0, `${label}: the file is unchanged`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
assert.equal(walked, 7);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("consent: a write of the explained record lands; the over-consent write is refused; the nested mark is refused", async () => {
|
|
||||||
const consented = await openStore("extra-slot-consent.cc", true);
|
|
||||||
const value = consented.cache.get(consented.surface, "consented") as Surface;
|
|
||||||
assert.deepEqual(value, golden);
|
|
||||||
await consented.cache.put(consented.surface, "consented", value);
|
|
||||||
assert.equal(consented.cache.unreadSlots(consented.surface, "consented"), undefined, "the write dropped the explained slot and the mark with it");
|
|
||||||
assert.equal(readSingleFileStore(consented.path).envelopes.find((e) => e.key === "consented")!.schemaId, "tests.union_surface.v2");
|
|
||||||
|
|
||||||
for (const key of ["over-consent", "nested"]) {
|
|
||||||
const refused = await openStore("extra-slot-consent.cc", true);
|
|
||||||
await assert.rejects(
|
|
||||||
() => refused.cache.put(refused.surface, key, golden),
|
|
||||||
(error: unknown) => error instanceof SchemaConflictError && error.schemaId === "tests.union_surface.wide",
|
|
||||||
`${key}: the refusal names the id the record was stored under`,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
test("carried: after writing another record, the marked record's bytes, schema id, stored-at and every catalog entry are the originals", async () => {
|
|
||||||
const { path, cache, surface } = await openStore("extra-slot-store.cc", false);
|
|
||||||
const originals = readSingleFileStore(path);
|
|
||||||
await cache.put(surface, "clean", golden);
|
|
||||||
const after = readSingleFileStore(path);
|
|
||||||
for (const key of ["marked", "unit-arm"]) {
|
|
||||||
const was = originals.envelopes.find((e) => e.key === key)!;
|
|
||||||
const now = after.envelopes.find((e) => e.key === key)!;
|
|
||||||
assert.equal(hex(documentPayloadBytes(now.payload)), hex(documentPayloadBytes(was.payload)), key);
|
|
||||||
assert.equal(now.schemaId, was.schemaId, key);
|
|
||||||
assert.equal(now.storedAt, was.storedAt, key);
|
|
||||||
assert.deepEqual(now.catalogEntry, was.catalogEntry, key);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
// A writer that adds a slot and keeps its schema id (TS ids are hand-written; C# ids hash the members): the reader of that
|
|
||||||
// same id has declared nothing, so it consents to nothing.
|
|
||||||
test("a wider writer under the reader's own schema id is read-only, and a real round trip does not shed the slot", async () => {
|
|
||||||
const doc = (columns: 1 | 2, compatibleSchemaIds: string[] = []) => defineDocumentType({
|
|
||||||
type: "tests.own_id",
|
|
||||||
schemaId: "tests.own_id.v1",
|
|
||||||
schemaName: "tests.own_id",
|
|
||||||
compatibleSchemaIds,
|
|
||||||
schema: z.object({ n: z.string(), extra: z.string().optional() }),
|
|
||||||
codec: columns === 2
|
|
||||||
? slots<{ n: string; extra: string }>({ 0: ["n", string], 1: ["extra", string] }, "Own")
|
|
||||||
: slots<{ n: string }>({ 0: ["n", string] }, "Own"),
|
|
||||||
name: "n",
|
|
||||||
});
|
|
||||||
const path = join(await mkdtemp(join(tmpdir(), "slot-readonly-")), "own.cc");
|
|
||||||
const wide = doc(2);
|
|
||||||
const writer = CultCache.builder().withDocumentType(wide).withGenericStore(new SingleFileMessagePackBackingStore(path)).build();
|
|
||||||
await writer.put(wide, "k", { n: "n1", extra: "kept" });
|
|
||||||
const bytes = await readFile(path);
|
|
||||||
|
|
||||||
for (const compatible of [[], ["tests.own_id.v1"]]) {
|
|
||||||
const reader = doc(1, compatible);
|
|
||||||
const cache = CultCache.builder().withDocumentType(reader).withGenericStore(new SingleFileMessagePackBackingStore(path)).build();
|
|
||||||
await cache.pullAllBackingStores();
|
|
||||||
assert.deepEqual(cache.unreadSlots(reader, "k"), mark("Own", 2, 1, true), "unexplained: the arrived id is the reader's own");
|
|
||||||
assert.equal(cache.isWritable(reader, "k"), false);
|
|
||||||
await assert.rejects(() => cache.put(reader, "k", { n: "n2" }), SchemaConflictError);
|
|
||||||
await assert.rejects(() => cache.delete(reader, "k"), SchemaConflictError);
|
|
||||||
assert.equal(Buffer.compare(bytes, await readFile(path)), 0, "the file still holds the slot");
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a record that arrived under an id the reader does not list compatible is never consented to", async () => {
|
|
||||||
const path = await copyOf("extra-slot-consent.cc");
|
|
||||||
const reader = surfaceDocument("tests.union_surface.v2"); // resolves by type name; lists nothing
|
|
||||||
const cache = CultCache.builder().withDocumentType(reader).withGenericStore(new SingleFileMessagePackBackingStore(path)).build();
|
|
||||||
await cache.pullAllBackingStores();
|
|
||||||
assert.equal(cache.unreadSlots(reader, "consented")?.explained, false);
|
|
||||||
assert.equal(cache.isWritable(reader, "consented"), false);
|
|
||||||
});
|
|
||||||
|
|
||||||
// isWritable is the write's own judge, not a second one: for every key state it answers what put does.
|
|
||||||
test("isWritable equals the outcome of put for every key state the write judges", async () => {
|
|
||||||
const typed = (type: string, schemaId: string, extra: Record<string, unknown> = {}) =>
|
|
||||||
defineDocumentType({ type, schemaId, schemaName: type, schemaVersion: `${type}.v1`, schema: surfaceSchema, codec: surfaceCodec, name: "id", ...extra });
|
|
||||||
const older = typed("tests.surface_older", "tests.surface_older.v1");
|
|
||||||
const newer = typed("tests.surface_newer", "tests.surface_newer.v1", { compatibleSchemaIds: ["tests.surface_older.v1"] });
|
|
||||||
const stranger = typed("tests.surface_stranger", "tests.surface_stranger.v1");
|
|
||||||
const global = typed("tests.surface_global", "tests.surface_global.v1", { global: true });
|
|
||||||
const clean = (key: string, type: string, schemaId: string) => ({ ...envelopeOf(new Uint8Array()), key, type, schemaId });
|
|
||||||
const held = async (key: string, file: string, type: string, schemaId: string) =>
|
|
||||||
({ ...envelopeOf(await read(file)), key, type, schemaId });
|
|
||||||
|
|
||||||
type Row = { name: string; build: () => Promise<{ cache: CultCache; target: typeof older; key: string }> };
|
|
||||||
const rows: Row[] = [
|
|
||||||
{ name: "owned clean record in the writer's own store", build: async () => {
|
|
||||||
const cache = CultCache.builder().withDocumentType(older).withDocumentType(newer)
|
|
||||||
.withGenericStore(memoryStore([await held("k", "union-surface.msgpack", older.type, older.schemaId!)])).build();
|
|
||||||
return { cache, target: newer, key: "k" };
|
|
||||||
} },
|
|
||||||
{ name: "owned record held in a store other than the writer's home", build: async () => {
|
|
||||||
const cache = CultCache.builder().withDocumentType(older).withDocumentType(newer)
|
|
||||||
.withBackingStore(memoryStore([await held("k", "union-surface.msgpack", older.type, older.schemaId!)]), older)
|
|
||||||
.withBackingStore(memoryStore([]), newer).build();
|
|
||||||
return { cache, target: newer, key: "k" };
|
|
||||||
} },
|
|
||||||
{ name: "a record of a type that does not own the writer's id", build: async () => {
|
|
||||||
const cache = CultCache.builder().withDocumentType(older).withDocumentType(stranger)
|
|
||||||
.withGenericStore(memoryStore([await held("k", "union-surface.msgpack", older.type, older.schemaId!)])).build();
|
|
||||||
return { cache, target: stranger, key: "k" };
|
|
||||||
} },
|
|
||||||
{ name: "a global type at a key other than the global key", build: async () => {
|
|
||||||
const cache = CultCache.builder().withDocumentType(global).withGenericStore(memoryStore([])).build();
|
|
||||||
return { cache, target: global, key: "x" };
|
|
||||||
} },
|
|
||||||
{ name: "a key a store carries foreign", build: async () => {
|
|
||||||
const cache = CultCache.builder().withDocumentType(older)
|
|
||||||
.withGenericStore(memoryStore([{ ...clean("k", "tests.unknown", "tests.unknown.v1"), payload: documentPayloadFromBytes(await read("union-surface.msgpack")) }])).build();
|
|
||||||
return { cache, target: older, key: "k" };
|
|
||||||
} },
|
|
||||||
{ name: "a marked record of the writer's own type", build: async () => {
|
|
||||||
const cache = CultCache.builder().withDocumentType(older)
|
|
||||||
.withGenericStore(memoryStore([await held("k", "extra-slot-record.msgpack", older.type, older.schemaId!)])).build();
|
|
||||||
return { cache, target: older, key: "k" };
|
|
||||||
} },
|
|
||||||
{ name: "an unheld key", build: async () => ({ cache: CultCache.builder().withDocumentType(older).withGenericStore(memoryStore([])).build(), target: older, key: "k" }) },
|
|
||||||
];
|
|
||||||
const outcomes: [string, boolean, boolean][] = [];
|
|
||||||
for (const row of rows) {
|
|
||||||
const { cache, target, key } = await row.build();
|
|
||||||
await cache.pullAllBackingStores();
|
|
||||||
const predicted = cache.isWritable(target, key);
|
|
||||||
const landed = await cache.put(target, key === "x" ? "x" : key, golden).then(() => true, () => false);
|
|
||||||
assert.equal(predicted, landed, row.name);
|
|
||||||
outcomes.push([row.name, predicted, landed]);
|
|
||||||
}
|
|
||||||
assert.deepEqual(outcomes.map(([, writable]) => writable), [true, false, false, false, false, false, true]);
|
|
||||||
// The same judge refuses a removal of a key held read-only or carried foreign.
|
|
||||||
const removals = CultCache.builder().withDocumentType(older)
|
|
||||||
.withGenericStore(memoryStore([await held("k", "extra-slot-record.msgpack", older.type, older.schemaId!)])).build();
|
|
||||||
await removals.pullAllBackingStores();
|
|
||||||
await assert.rejects(() => removals.delete(older, "k"), SchemaConflictError);
|
|
||||||
const stranger2 = CultCache.builder().withDocumentType(older)
|
|
||||||
.withGenericStore(memoryStore([{ ...envelopeOf(await read("union-surface.msgpack")), key: "f", type: "tests.unknown", schemaId: "tests.unknown.v1" }])).build();
|
|
||||||
await stranger2.pullAllBackingStores();
|
|
||||||
await assert.rejects(() => stranger2.delete(older, "f"), SchemaConflictError);
|
|
||||||
});
|
|
||||||
|
|
||||||
// A removal is by key (C# Remove): the owner of a held record's id removes the one record that exists, in one store call and
|
|
||||||
// with the cache dropped only once the store has; a type that does not own it is refused like put, and isWritable agrees.
|
|
||||||
test("delete of a key held as another type: the owner removes it once, a stranger is refused, a failing store leaves cache and store agreeing", async () => {
|
|
||||||
const typed = (type: string, schemaId: string, extra: Record<string, unknown> = {}) =>
|
|
||||||
defineDocumentType({ type, schemaId, schemaName: type, schemaVersion: `${type}.v1`, schema: surfaceSchema, codec: surfaceCodec, name: "id", ...extra });
|
|
||||||
const older = typed("tests.surface_older", "tests.surface_older.v1");
|
|
||||||
const newer = typed("tests.surface_newer", "tests.surface_newer.v1", { compatibleSchemaIds: ["tests.surface_older.v1"] });
|
|
||||||
const stranger = typed("tests.surface_stranger", "tests.surface_stranger.v1");
|
|
||||||
const heldRecord = async (): Promise<CultCacheEnvelope> => ({ ...envelopeOf(await read("union-surface.msgpack")), key: "k", type: older.type, schemaId: older.schemaId });
|
|
||||||
const open = async (failing = false) => {
|
|
||||||
const rows = [await heldRecord()];
|
|
||||||
const calls: string[] = [];
|
|
||||||
const store: CacheBackingStore = {
|
|
||||||
async pullAll() { return rows.map((row) => ({ ...row })); },
|
|
||||||
async push(entry) { rows.push(entry); },
|
|
||||||
async delete(entry) {
|
|
||||||
calls.push(entry.key);
|
|
||||||
if (failing) throw new Error("store refused the removal");
|
|
||||||
rows.splice(rows.findIndex((row) => row.key === entry.key), 1);
|
|
||||||
},
|
|
||||||
};
|
|
||||||
const cache = CultCache.builder().withDocumentType(older).withDocumentType(newer).withDocumentType(stranger).withGenericStore(store).build();
|
|
||||||
await cache.pullAllBackingStores();
|
|
||||||
return { cache, rows, calls };
|
|
||||||
};
|
|
||||||
|
|
||||||
const owner = await open();
|
|
||||||
assert.equal(owner.cache.isWritable(newer, "k"), true);
|
|
||||||
assert.equal(await owner.cache.delete(newer, "k"), true, "the owner's removal removes the one record");
|
|
||||||
assert.deepEqual([owner.rows.length, owner.calls.length, owner.cache.get(older, "k")], [0, 1, undefined], "one store call, record gone from store and cache");
|
|
||||||
|
|
||||||
const refused = await open();
|
|
||||||
assert.equal(refused.cache.isWritable(stranger, "k"), false);
|
|
||||||
await assert.rejects(() => refused.cache.delete(stranger, "k"), SchemaConflictError);
|
|
||||||
assert.deepEqual([refused.rows.length, refused.calls.length, refused.cache.get(older, "k") !== undefined], [1, 0, true]);
|
|
||||||
|
|
||||||
const failing = await open(true);
|
|
||||||
await assert.rejects(() => failing.cache.delete(newer, "k"), /store refused/u);
|
|
||||||
assert.deepEqual([failing.rows.length, failing.calls.length, failing.cache.get(older, "k") !== undefined], [1, 1, true], "the store failed: neither side dropped it");
|
|
||||||
|
|
||||||
const same = await open();
|
|
||||||
assert.equal(await same.cache.delete(older, "k"), true);
|
|
||||||
assert.equal(await same.cache.delete(older, "k"), false, "an unheld key is still the plain false");
|
|
||||||
});
|
|
||||||
|
|
||||||
// The removal form's three finer behaviours (cultlib-gaps:finding:cut-slot-readonly-ts.s4.removal-form-unpinned).
|
|
||||||
test("an owner's delete: refused for a marked record, taken from the held record's store, and clears the held type's lookups", async () => {
|
|
||||||
const typed = (type: string, schemaId: string, extra: Record<string, unknown> = {}) =>
|
|
||||||
defineDocumentType({ type, schemaId, schemaName: type, schemaVersion: `${type}.v1`, schema: surfaceSchema, codec: surfaceCodec, name: "id", ...extra });
|
|
||||||
const older = typed("tests.surface_older", "tests.surface_older.v1", { indexes: { byVersion: (value: Surface) => String(value.version) } });
|
|
||||||
const newer = typed("tests.surface_newer", "tests.surface_newer.v1", { compatibleSchemaIds: ["tests.surface_older.v1"] });
|
|
||||||
const heldIn = async (file: string): Promise<CultCacheEnvelope> =>
|
|
||||||
({ ...envelopeOf(await read(file)), key: "k", type: older.type, schemaId: older.schemaId });
|
|
||||||
const recording = (rows: CultCacheEnvelope[]) => {
|
|
||||||
const removed: string[] = [];
|
|
||||||
const store: CacheBackingStore = {
|
|
||||||
async pullAll() { return rows.map((row) => ({ ...row })); },
|
|
||||||
async push(entry) { rows.push(entry); },
|
|
||||||
async delete(entry) { removed.push(entry.key); rows.splice(rows.findIndex((row) => row.key === entry.key), 1); },
|
|
||||||
};
|
|
||||||
return { store, removed, rows };
|
|
||||||
};
|
|
||||||
|
|
||||||
// 1. The owner may not remove a record carrying unread slots nothing consents to.
|
|
||||||
const marked = recording([await heldIn("extra-slot-record.msgpack")]);
|
|
||||||
const markedCache = CultCache.builder().withDocumentType(older).withDocumentType(newer).withGenericStore(marked.store).build();
|
|
||||||
await markedCache.pullAllBackingStores();
|
|
||||||
await assert.rejects(() => markedCache.delete(newer, "k"), (error: unknown) => error instanceof SchemaConflictError && error.unreadSlots?.typeName === "UnionSurface");
|
|
||||||
assert.deepEqual([marked.rows.length, marked.removed.length, markedCache.get(older, "k") !== undefined], [1, 0, true]);
|
|
||||||
|
|
||||||
// 2. The removal goes to the store of the record that exists, not the deleting type's; there the write form is false (it would
|
|
||||||
// push to the wrong store) while the removal succeeds.
|
|
||||||
const olderStore = recording([await heldIn("union-surface.msgpack")]);
|
|
||||||
const newerStore = recording([]);
|
|
||||||
const split = CultCache.builder().withDocumentType(older).withDocumentType(newer)
|
|
||||||
.withBackingStore(olderStore.store, older).withBackingStore(newerStore.store, newer).build();
|
|
||||||
await split.pullAllBackingStores();
|
|
||||||
assert.equal(split.isWritable(newer, "k"), false, "isWritable answers the write form: the rename cannot replace a record in another store");
|
|
||||||
assert.equal(await split.delete(newer, "k"), true);
|
|
||||||
assert.deepEqual([olderStore.removed, newerStore.removed, split.get(older, "k")], [["k"], [], undefined]);
|
|
||||||
|
|
||||||
// 3. The held type's name and index lookups are cleared with the record.
|
|
||||||
const single = recording([await heldIn("union-surface.msgpack")]);
|
|
||||||
const cache = CultCache.builder().withDocumentType(older).withDocumentType(newer).withGenericStore(single.store).build();
|
|
||||||
await cache.pullAllBackingStores();
|
|
||||||
assert.equal(cache.getKeyByName(older, "surface"), "k");
|
|
||||||
assert.equal(cache.getKeyByIndex(older, "byVersion", "3"), "k");
|
|
||||||
await cache.delete(newer, "k");
|
|
||||||
assert.equal(cache.getKeyByName(older, "surface"), undefined);
|
|
||||||
assert.equal(cache.getKeyByIndex(older, "byVersion", "3"), undefined);
|
|
||||||
assert.equal(cache.getAll(older).length, 0);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a global type at a key other than the global key: isWritable is false and delete is the plain false of an unheld key", async () => {
|
|
||||||
const global = defineDocumentType({ type: "tests.surface_global", schemaId: "tests.surface_global.v1", schemaName: "tests.surface_global", schemaVersion: "tests.surface_global.v1", schema: surfaceSchema, codec: surfaceCodec, name: "id", global: true });
|
|
||||||
const cache = CultCache.builder().withDocumentType(global).withGenericStore(memoryStore([])).build();
|
|
||||||
assert.equal(cache.isWritable(global, "x"), false);
|
|
||||||
assert.equal(await cache.delete(global, "x"), false);
|
|
||||||
});
|
|
||||||
|
|
@ -1,175 +0,0 @@
|
||||||
import assert from "node:assert/strict";
|
|
||||||
import { createHash } from "node:crypto";
|
|
||||||
import { existsSync, readFileSync } from "node:fs";
|
|
||||||
import { copyFile, mkdtemp, readFile, rm } from "node:fs/promises";
|
|
||||||
import { tmpdir } from "node:os";
|
|
||||||
import { join, resolve } from "node:path";
|
|
||||||
import test from "node:test";
|
|
||||||
|
|
||||||
import { decode, encode } from "@msgpack/msgpack";
|
|
||||||
|
|
||||||
import { documentPayloadBytes, documentPayloadFromBytes } from "../src/document";
|
|
||||||
import { SingleFileMessagePackBackingStore, readSingleFileStore, recordVersion } from "../src/single-file-messagepack-backing-store";
|
|
||||||
import { schemaIdForEnvelope } from "../src/store-format";
|
|
||||||
import type { CultCacheEnvelope } from "../src/types";
|
|
||||||
|
|
||||||
// The store owns the content version and the conditional verdict (variants:ruling:write-set-content-version-declared-ownership):
|
|
||||||
// read reports a record with its version, commitIf writes only while the version holds, and a write that replaces a record
|
|
||||||
// is stamped later than it (variants:ruling:storedat-on-change).
|
|
||||||
|
|
||||||
function findVectors(from: string): string {
|
|
||||||
for (let dir = from; ; dir = resolve(dir, "..")) {
|
|
||||||
if (existsSync(join(dir, "tests", "vectors", "content-version"))) return join(dir, "tests", "vectors", "content-version");
|
|
||||||
if (resolve(dir, "..") === dir) throw new Error("tests/vectors/content-version not found above the test.");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const entry = (key: string, byte: number, storedAt = "2026-01-01T00:00:00.000Z", type = "t"): CultCacheEnvelope => ({
|
|
||||||
key,
|
|
||||||
type,
|
|
||||||
payload: documentPayloadFromBytes(Uint8Array.of(0x91, byte)),
|
|
||||||
storedAt,
|
|
||||||
});
|
|
||||||
|
|
||||||
async function scratch(): Promise<string> {
|
|
||||||
return mkdtemp(join(tmpdir(), "cultcache-conditional-"));
|
|
||||||
}
|
|
||||||
|
|
||||||
test("the content version of every record of the C#-written store equals the version the reference read", async () => {
|
|
||||||
const vectors = findVectors(__dirname);
|
|
||||||
const rows = decode(readFileSync(join(vectors, "versions.msgpack"))) as Array<[string, string]>;
|
|
||||||
assert.equal(rows.length, 2);
|
|
||||||
const directory = await scratch();
|
|
||||||
try {
|
|
||||||
const path = join(directory, "store.cc");
|
|
||||||
await copyFile(join(vectors, "store.cc"), path);
|
|
||||||
const store = new SingleFileMessagePackBackingStore(path);
|
|
||||||
for (const [key, version] of rows) {
|
|
||||||
const found = await store.read(key);
|
|
||||||
assert.equal(found?.version, version, `read(${key}).version`);
|
|
||||||
assert.equal(recordVersion(found!.envelope), version, `recordVersion(${key})`);
|
|
||||||
}
|
|
||||||
assert.equal(await store.read("absent"), undefined);
|
|
||||||
} finally {
|
|
||||||
await rm(directory, { recursive: true, force: true });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
test("the version is the SHA-256 of the record's persisted encoding and changes with every field of it", async () => {
|
|
||||||
const base = entry("k", 1);
|
|
||||||
const hex = (e: CultCacheEnvelope) =>
|
|
||||||
createHash("sha256").update(encode([e.key, schemaIdForEnvelope(e), e.storedAt, documentPayloadBytes(e.payload)])).digest("hex");
|
|
||||||
assert.equal(recordVersion(base), hex(base));
|
|
||||||
const versions = new Set([base, entry("k", 2), entry("k", 1, "2026-01-01T00:00:00.001Z"), entry("j", 1), { ...base, schemaId: "sha256:other" }].map(recordVersion));
|
|
||||||
assert.equal(versions.size, 5);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("commitIf writes nothing when the version does not hold, and commits when it does", async () => {
|
|
||||||
const directory = await scratch();
|
|
||||||
try {
|
|
||||||
const path = join(directory, "store.cc");
|
|
||||||
const store = new SingleFileMessagePackBackingStore(path);
|
|
||||||
// null expects no record: it commits over an absent key and mismatches over a present one.
|
|
||||||
assert.deepEqual(await store.commitIf(entry("k", 1), "not-a-version"), { outcome: "mismatch" });
|
|
||||||
assert.equal(existsSync(path), false, "a mismatch creates no file");
|
|
||||||
assert.equal((await store.commitIf(entry("k", 1), null)).outcome, "committed");
|
|
||||||
const first = (await store.read("k"))!;
|
|
||||||
const before = await readFile(path);
|
|
||||||
assert.deepEqual(await store.commitIf(entry("k", 2), null), { outcome: "mismatch" });
|
|
||||||
assert.deepEqual(await store.commitIf(entry("k", 2), "0".repeat(64)), { outcome: "mismatch" });
|
|
||||||
assert.deepEqual([...(await readFile(path))], [...before], "a mismatch leaves the bytes identical");
|
|
||||||
assert.equal((await store.commitIf(entry("k", 2), first.version)).outcome, "committed");
|
|
||||||
const second = (await store.read("k"))!;
|
|
||||||
assert.notEqual(second.version, first.version);
|
|
||||||
assert.deepEqual([...documentPayloadBytes(second.envelope.payload)], [0x91, 2]);
|
|
||||||
} finally {
|
|
||||||
await rm(directory, { recursive: true, force: true });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
test("commitIf judges the record at the key whatever its type, and a record of another key does not matter", async () => {
|
|
||||||
const directory = await scratch();
|
|
||||||
try {
|
|
||||||
const store = new SingleFileMessagePackBackingStore(join(directory, "store.cc"));
|
|
||||||
await store.push(entry("a", 1, undefined, "u"));
|
|
||||||
await store.push(entry("b", 1));
|
|
||||||
const other = (await store.read("a"))!;
|
|
||||||
assert.deepEqual(await store.commitIf(entry("b", 2), other.version), { outcome: "mismatch" });
|
|
||||||
assert.equal((await store.commitIf(entry("b", 2), recordVersion((await store.read("b"))!.envelope))).outcome, "committed");
|
|
||||||
assert.deepEqual([...documentPayloadBytes((await store.read("a"))!.envelope.payload)], [0x91, 1], "the record at another key is untouched");
|
|
||||||
} finally {
|
|
||||||
await rm(directory, { recursive: true, force: true });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a write that replaces a record is stored strictly later than it, whatever the write's own storedAt", async () => {
|
|
||||||
const directory = await scratch();
|
|
||||||
try {
|
|
||||||
const store = new SingleFileMessagePackBackingStore(join(directory, "store.cc"));
|
|
||||||
const at = "2026-03-04T05:06:07.100Z";
|
|
||||||
await store.push(entry("k", 1, at));
|
|
||||||
// Not later (equal, earlier, unparseable) is written one millisecond after the record it replaces, by push, pushAll and commitIf.
|
|
||||||
await store.push(entry("k", 2, at));
|
|
||||||
assert.equal((await store.read("k"))!.envelope.storedAt, "2026-03-04T05:06:07.101Z");
|
|
||||||
await store.push(entry("k", 3, "2020-01-01T00:00:00.000Z"));
|
|
||||||
assert.equal((await store.read("k"))!.envelope.storedAt, "2026-03-04T05:06:07.102Z");
|
|
||||||
await store.pushAll([entry("k", 4, "not a time")]);
|
|
||||||
assert.equal((await store.read("k"))!.envelope.storedAt, "2026-03-04T05:06:07.103Z");
|
|
||||||
const committed = await store.commitIf(entry("k", 5, "2020-01-01T00:00:00.000Z"), (await store.read("k"))!.version);
|
|
||||||
assert.deepEqual(committed, { outcome: "committed", storedAt: "2026-03-04T05:06:07.104Z" });
|
|
||||||
assert.equal((await store.read("k"))!.envelope.storedAt, "2026-03-04T05:06:07.104Z");
|
|
||||||
// A later stamp is kept as it is, and a key with no record before it is stamped as it is.
|
|
||||||
await store.push(entry("k", 6, "2030-01-01T00:00:00.000Z"));
|
|
||||||
await store.push(entry("fresh", 1, "2000-01-01T00:00:00.000Z"));
|
|
||||||
assert.equal((await store.read("k"))!.envelope.storedAt, "2030-01-01T00:00:00.000Z");
|
|
||||||
assert.equal((await store.read("fresh"))!.envelope.storedAt, "2000-01-01T00:00:00.000Z");
|
|
||||||
assert.equal(readSingleFileStore(join(directory, "store.cc")).envelopes.length, 2);
|
|
||||||
} finally {
|
|
||||||
await rm(directory, { recursive: true, force: true });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a replacing write that would stamp past year 9999 is refused and writes nothing", async () => {
|
|
||||||
const directory = await scratch();
|
|
||||||
try {
|
|
||||||
const store = new SingleFileMessagePackBackingStore(join(directory, "store.cc"));
|
|
||||||
const last = "9999-12-31T23:59:59.999Z";
|
|
||||||
await store.push(entry("k", 1, last));
|
|
||||||
await assert.rejects(() => store.push(entry("k", 2, last)), RangeError);
|
|
||||||
assert.equal((await store.read("k"))!.envelope.storedAt, last);
|
|
||||||
assert.deepEqual([...documentPayloadBytes((await store.read("k"))!.envelope.payload)], [0x91, 1]);
|
|
||||||
} finally {
|
|
||||||
await rm(directory, { recursive: true, force: true });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a write that restores an earlier value does not restore its version", async () => {
|
|
||||||
const directory = await scratch();
|
|
||||||
try {
|
|
||||||
const store = new SingleFileMessagePackBackingStore(join(directory, "store.cc"));
|
|
||||||
const at = "2026-03-04T05:06:07.100Z";
|
|
||||||
await store.push(entry("k", 1, at));
|
|
||||||
const first = (await store.read("k"))!.version;
|
|
||||||
await store.push(entry("k", 5, at));
|
|
||||||
await store.push(entry("k", 1, at));
|
|
||||||
assert.notEqual((await store.read("k"))!.version, first, "an A-B-A within one millisecond keeps no version");
|
|
||||||
assert.deepEqual(await store.commitIf(entry("k", 9, at), first), { outcome: "mismatch" });
|
|
||||||
} finally {
|
|
||||||
await rm(directory, { recursive: true, force: true });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
test("two stores on one file never both commit against the same version", async () => {
|
|
||||||
const directory = await scratch();
|
|
||||||
try {
|
|
||||||
const path = join(directory, "store.cc");
|
|
||||||
const left = new SingleFileMessagePackBackingStore(path);
|
|
||||||
const right = new SingleFileMessagePackBackingStore(path);
|
|
||||||
await left.push(entry("k", 0));
|
|
||||||
const version = (await left.read("k"))!.version;
|
|
||||||
const outcomes = await Promise.all(Array.from({ length: 6 }, (_, i) => (i % 2 === 0 ? left : right).commitIf(entry("k", i + 1), version)));
|
|
||||||
assert.equal(outcomes.filter((o) => o.outcome === "committed").length, 1);
|
|
||||||
} finally {
|
|
||||||
await rm(directory, { recursive: true, force: true });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
@ -10,7 +10,6 @@ import { promisify } from "node:util";
|
||||||
|
|
||||||
import { decode, encode } from "@msgpack/msgpack";
|
import { decode, encode } from "@msgpack/msgpack";
|
||||||
|
|
||||||
import { StoreLinkedError as PackageStoreLinkedError } from "../src/index";
|
|
||||||
import { documentPayloadBytes, documentPayloadFromBytes } from "../src/document";
|
import { documentPayloadBytes, documentPayloadFromBytes } from "../src/document";
|
||||||
import { SingleFileMessagePackBackingStore } from "../src/single-file-messagepack-backing-store";
|
import { SingleFileMessagePackBackingStore } from "../src/single-file-messagepack-backing-store";
|
||||||
import { SchemaConflictError, StoreUnreadableError } from "../src/store-format";
|
import { SchemaConflictError, StoreUnreadableError } from "../src/store-format";
|
||||||
|
|
@ -24,7 +23,6 @@ import {
|
||||||
replaceStoreFile,
|
replaceStoreFile,
|
||||||
replaceStoreFileWindows,
|
replaceStoreFileWindows,
|
||||||
windowsKernel,
|
windowsKernel,
|
||||||
refuseLinkedStore,
|
|
||||||
withStoreWriteLock,
|
withStoreWriteLock,
|
||||||
} from "../src/store-file";
|
} from "../src/store-file";
|
||||||
import type { ReplaceKernel, StoreFileOps } from "../src/store-file";
|
import type { ReplaceKernel, StoreFileOps } from "../src/store-file";
|
||||||
|
|
@ -417,43 +415,6 @@ test("a second writer in this process waits for the store lock and runs after re
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
test("a link put while a writer waits on the store lock is refused once it holds the lock", { skip: process.platform === "win32" }, async () => {
|
|
||||||
const directory = await scratch();
|
|
||||||
try {
|
|
||||||
const target = join(directory, "target.cc");
|
|
||||||
await new SingleFileMessagePackBackingStore(target).push(noteEnvelope("a"));
|
|
||||||
const before = await readFile(target);
|
|
||||||
const writes: Array<[string, (store: SingleFileMessagePackBackingStore) => Promise<void>]> = [
|
|
||||||
["push", async (store) => void (await store.push(noteEnvelope("b")))],
|
|
||||||
["pushAll", (store) => store.pushAll([noteEnvelope("b")])],
|
|
||||||
["delete", (store) => store.delete(noteEnvelope("a"))],
|
|
||||||
];
|
|
||||||
const missing = join(directory, "missing.cc");
|
|
||||||
for (const [name, write, linkTo] of writes.flatMap(([n, w]) => [[n, w, target], [`${n} (dangling)`, w, missing]] as const)) {
|
|
||||||
const link = join(directory, `${name.replace(/\W+/g, "-")}.cc`);
|
|
||||||
let writer: Promise<void> | undefined;
|
|
||||||
await withStoreWriteLock(link, async () => {
|
|
||||||
writer = write(new SingleFileMessagePackBackingStore(link));
|
|
||||||
writer.catch(() => undefined);
|
|
||||||
await sleepFor(150);
|
|
||||||
await fsp.symlink(linkTo, link); // after the writer's pre-lock look, while it waits
|
|
||||||
});
|
|
||||||
await assert.rejects(writer!, (error: unknown) => error instanceof PackageStoreLinkedError, name);
|
|
||||||
assert.ok((await fsp.lstat(link)).isSymbolicLink(), `${name}: the link was replaced`);
|
|
||||||
assert.deepEqual(await readFile(target), before, `${name}: the target changed`);
|
|
||||||
await assert.rejects(fsp.lstat(missing), { code: "ENOENT" }, `${name}: the dangling target was created`);
|
|
||||||
await rm(link); // the link is refused before the lock, so remove it to probe the lock
|
|
||||||
assert.equal(await withStoreWriteLock(link, async () => "free", { timeoutMs: 200 }), "free", `${name}: the lock is held`);
|
|
||||||
}
|
|
||||||
} finally {
|
|
||||||
await rm(directory, { recursive: true, force: true });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
function noteEnvelope(key: string): CultCacheEnvelope {
|
|
||||||
return { key, type: "note", payload: documentPayloadFromBytes(Uint8Array.of(0x91, 1)), storedAt: "2026-10-20T00:00:00Z" };
|
|
||||||
}
|
|
||||||
|
|
||||||
test("the store lock gives up after its wait bound and names the lock path", async () => {
|
test("the store lock gives up after its wait bound and names the lock path", async () => {
|
||||||
const directory = await scratch();
|
const directory = await scratch();
|
||||||
try {
|
try {
|
||||||
|
|
@ -709,7 +670,7 @@ test("delete removes only the record at that type and key", async () => {
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
test("pushAll writes onto the store as it is: it replaces by key and removes nothing, and a soft pushAll leaves an existing store alone", async () => {
|
test("pushAll replaces the whole store, and a soft pushAll leaves an existing store alone", async () => {
|
||||||
const directory = await scratch();
|
const directory = await scratch();
|
||||||
try {
|
try {
|
||||||
const path = join(directory, "store.cc");
|
const path = join(directory, "store.cc");
|
||||||
|
|
@ -720,14 +681,7 @@ test("pushAll writes onto the store as it is: it replaces by key and removes not
|
||||||
await store.pushAll([entryOf("b", "t", 2)], { soft: true });
|
await store.pushAll([entryOf("b", "t", 2)], { soft: true });
|
||||||
assert.deepEqual([...(await readFile(path))], [...before], "soft leaves an existing store byte for byte");
|
assert.deepEqual([...(await readFile(path))], [...before], "soft leaves an existing store byte for byte");
|
||||||
await store.pushAll([entryOf("b", "t", 2)]);
|
await store.pushAll([entryOf("b", "t", 2)]);
|
||||||
assert.deepEqual(await snapshotOf(store), ["t/a:1", "t/b:2"], "a record the batch does not name stays");
|
assert.deepEqual(await snapshotOf(store), ["t/b:2"]);
|
||||||
await store.pushAll([entryOf("a", "t", 7)]);
|
|
||||||
assert.deepEqual(await snapshotOf(store), ["t/a:7", "t/b:2"], "a record the batch names is replaced");
|
|
||||||
await store.pushAll([]);
|
|
||||||
assert.deepEqual(await snapshotOf(store), ["t/a:7", "t/b:2"], "an empty flush from a cache that holds nothing wipes nothing");
|
|
||||||
const before2 = [...(await readFile(path))];
|
|
||||||
await assert.rejects(() => store.pushAll([entryOf("a", "u", 1)]), SchemaConflictError);
|
|
||||||
assert.deepEqual([...(await readFile(path))], before2, "a batch that retypes a held key is refused and the file is unchanged");
|
|
||||||
} finally {
|
} finally {
|
||||||
await rm(directory, { recursive: true, force: true });
|
await rm(directory, { recursive: true, force: true });
|
||||||
}
|
}
|
||||||
|
|
@ -857,35 +811,3 @@ test("opening writes nothing: a missing store leaves no lock file, a legacy stor
|
||||||
await rm(directory, { recursive: true, force: true });
|
await rm(directory, { recursive: true, force: true });
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
test("StoreLinkedError is importable from the package entry and is what a write at a link throws", { skip: process.platform === "win32" }, async () => {
|
|
||||||
const directory = await scratch();
|
|
||||||
try {
|
|
||||||
const target = join(directory, "target.cc");
|
|
||||||
await writeFile(target, "x");
|
|
||||||
const link = join(directory, "link.cc");
|
|
||||||
await fsp.symlink(target, link);
|
|
||||||
await assert.rejects(
|
|
||||||
() => refuseLinkedStore(link),
|
|
||||||
(error: unknown) => error instanceof PackageStoreLinkedError && error.path === link && error.name === "StoreLinkedError",
|
|
||||||
);
|
|
||||||
await assert.rejects(() => new SingleFileMessagePackBackingStore(link).pushAll([]), (error: unknown) => error instanceof PackageStoreLinkedError);
|
|
||||||
} finally {
|
|
||||||
await rm(directory, { recursive: true, force: true });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
test("refuseLinkedStore lets a path that is absent pass and rethrows any other lstat failure", { skip: process.platform === "win32" }, async () => {
|
|
||||||
const directory = await scratch();
|
|
||||||
try {
|
|
||||||
await refuseLinkedStore(join(directory, "absent.cc"));
|
|
||||||
const file = join(directory, "file");
|
|
||||||
await writeFile(file, "x");
|
|
||||||
await assert.rejects(
|
|
||||||
() => refuseLinkedStore(join(file, "child.cc")),
|
|
||||||
(error: unknown) => (error as NodeJS.ErrnoException).code === "ENOTDIR",
|
|
||||||
);
|
|
||||||
} finally {
|
|
||||||
await rm(directory, { recursive: true, force: true });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
|
||||||
|
|
@ -1,20 +0,0 @@
|
||||||
// isStoredAtStamp agrees with every row of tests/vectors/stored-at-stamp/stamps.msgpack, the one shape a peer's storedAt must parse as.
|
|
||||||
import assert from "node:assert/strict";
|
|
||||||
import { readFileSync } from "node:fs";
|
|
||||||
import { join } from "node:path";
|
|
||||||
import test from "node:test";
|
|
||||||
import { decode } from "@msgpack/msgpack";
|
|
||||||
import { isStoredAtStamp } from "../src";
|
|
||||||
|
|
||||||
// dist-test/test -> the repository root.
|
|
||||||
export const STAMP_VECTOR = join(__dirname, "..", "..", "..", "..", "tests", "vectors", "stored-at-stamp", "stamps.msgpack");
|
|
||||||
|
|
||||||
test("isStoredAtStamp answers every row of the stored-at-stamp vector", () => {
|
|
||||||
const rows = decode(readFileSync(STAMP_VECTOR)) as [string, boolean][];
|
|
||||||
assert.ok(rows.length > 20, "the vector was read");
|
|
||||||
for (const [text, parses] of rows) assert.equal(isStoredAtStamp(text), parses, JSON.stringify(text));
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a stamp is a string: anything else is not one", () => {
|
|
||||||
for (const value of [undefined, null, 0, 1_700_000_000_000, true, {}, [], new Date()]) assert.equal(isStoredAtStamp(value), false);
|
|
||||||
});
|
|
||||||
|
|
@ -1,7 +1,8 @@
|
||||||
import assert from "node:assert/strict";
|
import assert from "node:assert/strict";
|
||||||
|
import { existsSync } from "node:fs";
|
||||||
import { mkdtemp, readFile, writeFile } from "node:fs/promises";
|
import { mkdtemp, readFile, writeFile } from "node:fs/promises";
|
||||||
import { tmpdir } from "node:os";
|
import { tmpdir } from "node:os";
|
||||||
import { join } from "node:path";
|
import { join, resolve } from "node:path";
|
||||||
import { test } from "node:test";
|
import { test } from "node:test";
|
||||||
|
|
||||||
import { decode, encode } from "@msgpack/msgpack";
|
import { decode, encode } from "@msgpack/msgpack";
|
||||||
|
|
@ -21,14 +22,190 @@ import {
|
||||||
encodeDocumentPayload,
|
encodeDocumentPayload,
|
||||||
} from "../src/document";
|
} from "../src/document";
|
||||||
import { SingleFileMessagePackBackingStore } from "../src/single-file-messagepack-backing-store";
|
import { SingleFileMessagePackBackingStore } from "../src/single-file-messagepack-backing-store";
|
||||||
import type { AnyCultCacheDocumentDefinition, CultCacheEnvelope } from "../src/types";
|
import type { AnyCultCacheDocumentDefinition, CacheBackingStore, CultCacheEnvelope } from "../src/types";
|
||||||
|
|
||||||
import {
|
|
||||||
CANARY, type Node, type Surface, golden, hex, node, outcome, read, surfaceCodec, surfaceDocument, surfaceSchema, vectors, envelopeOf, memoryStore,
|
|
||||||
} from "./union-surface-fixture";
|
|
||||||
|
|
||||||
const { array, boolean, bytes, float32, float64, int32, int64, lazy, list, nullable, slots, string, union, unit } = codecs;
|
const { array, boolean, bytes, float32, float64, int32, int64, lazy, list, nullable, slots, string, union, unit } = codecs;
|
||||||
|
|
||||||
|
// The names the C# reference gives the fixture's types (CultSchemaTypeNames.FromType), as union-surface.cc carries them.
|
||||||
|
const CS = "GameCult.Caching.Tests.UnionParityVectorTests+";
|
||||||
|
|
||||||
|
// The golden is tests/vectors/union-parity, written by the C# reference. Everything below that is bytes or an expected
|
||||||
|
// outcome is read from those committed files; only the value the payload must decode to is spelled here.
|
||||||
|
function findVectors(from: string): string {
|
||||||
|
for (let dir = from; ; dir = resolve(dir, "..")) {
|
||||||
|
if (existsSync(join(dir, "tests", "vectors", "union-parity"))) return join(dir, "tests", "vectors", "union-parity");
|
||||||
|
if (resolve(dir, "..") === dir) throw new Error("tests/vectors/union-parity not found above the test.");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
const vectors = findVectors(__dirname);
|
||||||
|
const read = async (name: string) => new Uint8Array(await readFile(join(vectors, name)));
|
||||||
|
|
||||||
|
// The string the C# writer put inside every refusal payload, to prove a refusal never echoes the payload.
|
||||||
|
const CANARY = "CANARY-union-golden-4c2a";
|
||||||
|
|
||||||
|
type Node =
|
||||||
|
| { kind: "Box"; id: string; children: (Node | null)[] }
|
||||||
|
| { kind: "Text"; id: string; content: string }
|
||||||
|
| { kind: "Use"; id: string; composition: Composition; slots: (Node | null)[] }
|
||||||
|
| { kind: "Image"; id: string; uri: string; alt: string }
|
||||||
|
| { kind: "Wrap"; inner: Node | null; id: string };
|
||||||
|
interface Composition { name: string; body: Node | null }
|
||||||
|
type Outcome = { kind: "Pending"; message: string } | { kind: "Completed"; sourceVersion: number } | { kind: "Denied" } | { kind: "Floor" } | { kind: "Ceiling" };
|
||||||
|
// The golden's Outcome: the arms of a list carry an element id, so Denied, Floor and Ceiling are one-slot records.
|
||||||
|
type GoldenOutcome =
|
||||||
|
| { kind: "Pending"; message: string; id: string }
|
||||||
|
| { kind: "Completed"; sourceVersion: number; id: string }
|
||||||
|
| { kind: "Denied"; id: string }
|
||||||
|
| { kind: "Floor"; id: string }
|
||||||
|
| { kind: "Ceiling"; id: string };
|
||||||
|
type Item = { kind: "Gem"; name: string } | { kind: "Tool"; name: string; uses: number } | { kind: "Part"; name: string; count: number };
|
||||||
|
type CraftedItem = { kind: "Tool"; name: string; uses: number } | { kind: "Part"; name: string; count: number };
|
||||||
|
interface Surface {
|
||||||
|
id: string;
|
||||||
|
version: number;
|
||||||
|
root: Node | null;
|
||||||
|
outcomes: (GoldenOutcome | null)[];
|
||||||
|
part: Item | null;
|
||||||
|
crafted: CraftedItem | null;
|
||||||
|
missing: Node | null;
|
||||||
|
}
|
||||||
|
|
||||||
|
const composition = slots<Composition>({ 0: ["name", string], 1: ["body", lazy(() => node)] }, `${CS}Composition`);
|
||||||
|
const node: Codec<Node | null> = union<Node>("Node", {
|
||||||
|
0: ["Box", slots<{ id: string; children: (Node | null)[] }>({ 0: ["id", string], 1: ["children", list(lazy(() => node))] })],
|
||||||
|
1: ["Text", slots<{ id: string; content: string }>({ 0: ["id", string], 1: ["content", string] })],
|
||||||
|
2: ["Use", slots<{ id: string; composition: Composition; slots: (Node | null)[] }>({
|
||||||
|
0: ["id", string], 1: ["composition", composition], 2: ["slots", list(lazy(() => node))],
|
||||||
|
})],
|
||||||
|
5: ["Image", slots<{ id: string; uri: string; alt: string }>({ 0: ["id", string], 1: ["uri", string], 3: ["alt", string] })],
|
||||||
|
6: ["Wrap", slots<{ inner: Node | null; id: string }>({ 0: ["inner", lazy(() => node)], 1: ["id", string] })],
|
||||||
|
}, `${CS}Node`);
|
||||||
|
const outcome = union<Outcome>("Outcome", {
|
||||||
|
0: ["Pending", slots<{ message: string }>({ 0: ["message", string] })],
|
||||||
|
1: ["Completed", slots<{ sourceVersion: number }>({ 0: ["sourceVersion", int32] })],
|
||||||
|
2: ["Denied", unit],
|
||||||
|
[-2147483648]: ["Floor", unit],
|
||||||
|
2147483647: ["Ceiling", unit],
|
||||||
|
}, `${CS}Outcome`);
|
||||||
|
const idOnly = slots<{ id: string }>({ 0: ["id", string] });
|
||||||
|
const goldenOutcome = union<GoldenOutcome>("Outcome", {
|
||||||
|
0: ["Pending", slots<{ message: string; id: string }>({ 0: ["message", string], 1: ["id", string] })],
|
||||||
|
1: ["Completed", slots<{ sourceVersion: number; id: string }>({ 0: ["sourceVersion", int32], 1: ["id", string] })],
|
||||||
|
2: ["Denied", idOnly],
|
||||||
|
[-2147483648]: ["Floor", idOnly],
|
||||||
|
2147483647: ["Ceiling", idOnly],
|
||||||
|
}, `${CS}Outcome`);
|
||||||
|
const toolArm = slots<{ name: string; uses: number }>({ 0: ["name", string], 1: ["uses", int32] });
|
||||||
|
const partArm = slots<{ name: string; count: number }>({ 0: ["name", string], 1: ["count", int32] });
|
||||||
|
const item = union<Item>("Item", {
|
||||||
|
0: ["Gem", slots<{ name: string }>({ 0: ["name", string] })],
|
||||||
|
1: ["Tool", toolArm],
|
||||||
|
2: ["Part", partArm],
|
||||||
|
}, `${CS}Item`);
|
||||||
|
const craftedItem = union<CraftedItem>("CraftedItem", { 0: ["Tool", toolArm], 1: ["Part", partArm] }, `${CS}CraftedItem`);
|
||||||
|
const surfaceCodec = slots<Surface>({
|
||||||
|
0: ["id", string],
|
||||||
|
1: ["version", int32],
|
||||||
|
2: ["root", node],
|
||||||
|
3: ["outcomes", list(goldenOutcome)],
|
||||||
|
4: ["part", item],
|
||||||
|
5: ["crafted", craftedItem],
|
||||||
|
6: ["missing", node, null],
|
||||||
|
}, `${CS}UnionSurface`);
|
||||||
|
|
||||||
|
const nodeSchema: z.ZodType<Node | null> = z.lazy(() =>
|
||||||
|
z.union([
|
||||||
|
z.null(),
|
||||||
|
z.discriminatedUnion("kind", [
|
||||||
|
z.object({ kind: z.literal("Box"), id: z.string(), children: z.array(nodeSchema) }),
|
||||||
|
z.object({ kind: z.literal("Text"), id: z.string(), content: z.string() }),
|
||||||
|
z.object({
|
||||||
|
kind: z.literal("Use"),
|
||||||
|
id: z.string(),
|
||||||
|
composition: z.object({ name: z.string(), body: nodeSchema }),
|
||||||
|
slots: z.array(nodeSchema),
|
||||||
|
}),
|
||||||
|
z.object({ kind: z.literal("Image"), id: z.string(), uri: z.string(), alt: z.string() }),
|
||||||
|
z.object({ kind: z.literal("Wrap"), inner: nodeSchema, id: z.string() }),
|
||||||
|
]),
|
||||||
|
]));
|
||||||
|
const surfaceSchema = z.object({
|
||||||
|
id: z.string(),
|
||||||
|
version: z.number(),
|
||||||
|
root: nodeSchema,
|
||||||
|
outcomes: z.array(z.union([
|
||||||
|
z.null(),
|
||||||
|
z.discriminatedUnion("kind", [
|
||||||
|
z.object({ kind: z.literal("Pending"), message: z.string(), id: z.string() }),
|
||||||
|
z.object({ kind: z.literal("Completed"), sourceVersion: z.number(), id: z.string() }),
|
||||||
|
z.object({ kind: z.literal("Denied"), id: z.string() }),
|
||||||
|
z.object({ kind: z.literal("Floor"), id: z.string() }),
|
||||||
|
z.object({ kind: z.literal("Ceiling"), id: z.string() }),
|
||||||
|
]),
|
||||||
|
])),
|
||||||
|
part: z.union([z.null(), z.discriminatedUnion("kind", [
|
||||||
|
z.object({ kind: z.literal("Gem"), name: z.string() }),
|
||||||
|
z.object({ kind: z.literal("Tool"), name: z.string(), uses: z.number() }),
|
||||||
|
z.object({ kind: z.literal("Part"), name: z.string(), count: z.number() }),
|
||||||
|
])]),
|
||||||
|
crafted: z.union([z.null(), z.discriminatedUnion("kind", [
|
||||||
|
z.object({ kind: z.literal("Tool"), name: z.string(), uses: z.number() }),
|
||||||
|
z.object({ kind: z.literal("Part"), name: z.string(), count: z.number() }),
|
||||||
|
])]),
|
||||||
|
missing: nodeSchema,
|
||||||
|
}) as unknown as z.ZodType<Surface>;
|
||||||
|
|
||||||
|
function surfaceDocument(schemaId?: string) {
|
||||||
|
return defineDocumentType({
|
||||||
|
type: "tests.union_surface",
|
||||||
|
schemaId: schemaId ?? "tests.union_surface.v1",
|
||||||
|
schemaName: "tests.union_surface",
|
||||||
|
schemaVersion: "tests.union_surface.v1",
|
||||||
|
schema: surfaceSchema,
|
||||||
|
codec: surfaceCodec,
|
||||||
|
name: "id",
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
const golden: Surface = {
|
||||||
|
id: "surface",
|
||||||
|
version: 3,
|
||||||
|
root: {
|
||||||
|
kind: "Box",
|
||||||
|
id: "0000000000c0",
|
||||||
|
children: [
|
||||||
|
{ kind: "Text", id: "0000000000c1", content: "hello" },
|
||||||
|
{
|
||||||
|
kind: "Use",
|
||||||
|
id: "0000000000c2",
|
||||||
|
composition: {
|
||||||
|
name: "comp",
|
||||||
|
body: {
|
||||||
|
kind: "Box",
|
||||||
|
id: "0000000000d0",
|
||||||
|
children: [
|
||||||
|
{ kind: "Text", id: "0000000000d1", content: "x" },
|
||||||
|
{ kind: "Image", id: "0000000000d2", uri: "uri://a", alt: "alt" },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
slots: [{ kind: "Text", id: "0000000000e1", content: "slot" }, null, { kind: "Box", id: "0000000000e2", children: [] }],
|
||||||
|
},
|
||||||
|
{ kind: "Image", id: "0000000000c3", uri: "uri://b", alt: "" },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
outcomes: [
|
||||||
|
{ kind: "Pending", message: "wait", id: "0000000000a1" },
|
||||||
|
{ kind: "Completed", sourceVersion: 7, id: "0000000000a2" },
|
||||||
|
{ kind: "Denied", id: "0000000000a3" },
|
||||||
|
],
|
||||||
|
part: { kind: "Tool", name: "hammer", uses: 12 },
|
||||||
|
crafted: { kind: "Part", name: "gear", count: 4 },
|
||||||
|
missing: null,
|
||||||
|
};
|
||||||
|
|
||||||
|
const hex = (data: Uint8Array) => Buffer.from(data).toString("hex");
|
||||||
|
|
||||||
async function outcomeEntries() {
|
async function outcomeEntries() {
|
||||||
const entries = decode(await read("outcomes.msgpack")) as [string, string, string, number | null, string][];
|
const entries = decode(await read("outcomes.msgpack")) as [string, string, string, number | null, string][];
|
||||||
return entries.map(([file, outcome, unionName, key, detail]) => ({ file, outcome, unionName, key, detail }));
|
return entries.map(([file, outcome, unionName, key, detail]) => ({ file, outcome, unionName, key, detail }));
|
||||||
|
|
@ -338,7 +515,7 @@ test("the wire reader keeps 64-bit integers whole, tells a float from an integer
|
||||||
assert.throws(() => readWire(fromHex("dd")), /truncated/u);
|
assert.throws(() => readWire(fromHex("dd")), /truncated/u);
|
||||||
assert.throws(() => readWire(fromHex("ddffffffff")), /truncated/u, "a huge array header reserves nothing");
|
assert.throws(() => readWire(fromHex("ddffffffff")), /truncated/u, "a huge array header reserves nothing");
|
||||||
assert.throws(() => readWire(fromHex("a5616263")), /truncated/u);
|
assert.throws(() => readWire(fromHex("a5616263")), /truncated/u);
|
||||||
assert.equal(readWire(fromHex("0102")), 1, "the reader reads one value; the document owner refuses what follows");
|
assert.throws(() => readWire(fromHex("0102")), /bytes after its value/u);
|
||||||
assert.throws(() => readWire(fromHex("81a161a162")), /map, extension or reserved/u);
|
assert.throws(() => readWire(fromHex("81a161a162")), /map, extension or reserved/u);
|
||||||
assert.throws(() => readWire(fromHex("c1")), /map, extension or reserved/u);
|
assert.throws(() => readWire(fromHex("c1")), /map, extension or reserved/u);
|
||||||
assert.throws(() => readWire(fromHex("d4010a")), /map, extension or reserved/u);
|
assert.throws(() => readWire(fromHex("d4010a")), /map, extension or reserved/u);
|
||||||
|
|
@ -552,6 +729,19 @@ test("the Int32 edges of an arm key: the largest is an arm, one past either end
|
||||||
assert.throws(() => edge.decode(readWire(fromHex("92d3ffffffff8000000090"))), { message: "Union U: unknown arm key -2147483648 (declared keys: 2147483647)." });
|
assert.throws(() => edge.decode(readWire(fromHex("92d3ffffffff8000000090"))), { message: "Union U: unknown arm key -2147483648 (declared keys: 2147483647)." });
|
||||||
});
|
});
|
||||||
|
|
||||||
|
function envelopeOf(payload: Uint8Array): CultCacheEnvelope {
|
||||||
|
return { key: "surface", type: "tests.union_surface", payload: documentPayloadFromBytes(payload), storedAt: new Date().toISOString() };
|
||||||
|
}
|
||||||
|
|
||||||
|
function memoryStore(entries: CultCacheEnvelope[]): CacheBackingStore & { entries: CultCacheEnvelope[] } {
|
||||||
|
return {
|
||||||
|
entries,
|
||||||
|
async pullAll() { return entries.map((entry) => ({ ...entry })); },
|
||||||
|
async push(entry) { entries.push(entry); },
|
||||||
|
async delete() {},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
test("arm keys span Int32 and are listed ascending; slot keys are non-negative Int32", () => {
|
test("arm keys span Int32 and are listed ascending; slot keys are non-negative Int32", () => {
|
||||||
const keys = union<{ kind: "High" | "Zero" | "Neg" | "Low" }>("U", {
|
const keys = union<{ kind: "High" | "Zero" | "Neg" | "Low" }>("U", {
|
||||||
2147483647: ["High", unit],
|
2147483647: ["High", unit],
|
||||||
|
|
@ -725,114 +915,3 @@ test("a cache load refuses a store whose record is past the limit, naming the ty
|
||||||
const refusing = CultCache.builder().withDocumentType(document).withGenericStore(memoryStore([envelopeOf(await read("depth-past-limit.msgpack"))])).build();
|
const refusing = CultCache.builder().withDocumentType(document).withGenericStore(memoryStore([envelopeOf(await read("depth-past-limit.msgpack"))])).build();
|
||||||
await assert.rejects(() => refusing.pullAllBackingStores(), (error: Error) => error instanceof CultCachePayloadDepthError && !error.message.includes(CANARY));
|
await assert.rejects(() => refusing.pullAllBackingStores(), (error: Error) => error instanceof CultCachePayloadDepthError && !error.message.includes(CANARY));
|
||||||
});
|
});
|
||||||
|
|
||||||
// ---- bytes-after vectors: a payload is exactly one MessagePack value (tests/vectors/union-parity/README.md) ----
|
|
||||||
|
|
||||||
// The C# reference writes the vectors: union-surface.msgpack followed by a tail the first value does not own. The one
|
|
||||||
// owner refuses by count, naming the type, from the walk's end; it never walks or echoes the tail.
|
|
||||||
async function bytesAfterEntries() {
|
|
||||||
const raw = decode(await read("bytes-after-outcomes.msgpack")) as unknown[][];
|
|
||||||
return raw.map(([file, outcome, unionName, key, detail]) => ({ file: file as string, outcome: outcome as string, unionName: unionName as string, key: key as number | null, detail: detail as string }));
|
|
||||||
}
|
|
||||||
|
|
||||||
// The C# vector writer's canary (BytesAfterVectorTests): it sits in the deep tail, so an echo of the tail would carry it.
|
|
||||||
const TAIL_CANARY = "CANARY-bytes-after-7d1e";
|
|
||||||
const valueLength = async () => (await read("union-surface.msgpack")).length;
|
|
||||||
const plainDocument = () => defineDocumentType({ type: "tests.plain_surface", schema: z.unknown() });
|
|
||||||
const codecDocument = () => defineDocumentType({ type: "tests.codec_surface", schema: surfaceSchema, codec: surfaceCodec });
|
|
||||||
|
|
||||||
async function assertBytesAfterRefused(file: string, tail: number, run: () => unknown | Promise<unknown>, type: string) {
|
|
||||||
const clause = `${type}`;
|
|
||||||
await assert.rejects(
|
|
||||||
async () => run(),
|
|
||||||
(error: Error) => {
|
|
||||||
assert.ok(!(error instanceof CultCachePayloadDepthError), `${file}: the tail was walked`);
|
|
||||||
assert.ok(!error.message.includes(CANARY) && !error.message.includes(TAIL_CANARY), `${file}: the refusal echoed the tail`);
|
|
||||||
assert.ok(!error.message.includes("the limit is"), `${file}: the depth refusal`);
|
|
||||||
assert.ok(error.message.includes(clause), `${file}: names the type: ${error.message}`);
|
|
||||||
assert.ok(error.message.includes(`${tail} bytes after its first MessagePack value`), `${file}: names the count: ${error.message}`);
|
|
||||||
return true;
|
|
||||||
},
|
|
||||||
file,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
test("every bytes-after vector is refused by the one owner, by count, on the codec, plain and store paths", async () => {
|
|
||||||
const entries = await bytesAfterEntries();
|
|
||||||
assert.equal(entries.length, 4);
|
|
||||||
const length = await valueLength();
|
|
||||||
const surface = surfaceDocument();
|
|
||||||
const plain = plainDocument();
|
|
||||||
const codecOnly = codecDocument();
|
|
||||||
const dir = await mkdtemp(join(tmpdir(), "bytes-after-"));
|
|
||||||
for (const { file, outcome, unionName, detail } of entries) {
|
|
||||||
assert.equal(outcome, "refused");
|
|
||||||
assert.equal(unionName, "UnionSurface");
|
|
||||||
assert.equal(detail, "bytes-after");
|
|
||||||
const bytes = await read(file);
|
|
||||||
const tail = bytes.length - length;
|
|
||||||
assert.ok(tail > 0, file);
|
|
||||||
if (file === "bytes-after-deep-tail.msgpack") assert.ok(Buffer.from(bytes).includes(TAIL_CANARY), "the deep tail carries the canary the assertions look for");
|
|
||||||
const payload = documentPayloadFromBytes(bytes);
|
|
||||||
await assertBytesAfterRefused(file, tail, () => decodeDocumentPayload(surface, payload), surface.type);
|
|
||||||
await assertBytesAfterRefused(file, tail, () => decodeDocumentPayload(plain, payload), plain.type);
|
|
||||||
await assertBytesAfterRefused(file, tail, () => decodeDocumentPayload(codecOnly, payload), codecOnly.type);
|
|
||||||
|
|
||||||
// The store path: a single-file store holding the vector as a record payload refuses on load.
|
|
||||||
const path = join(dir, `${file}.cc`);
|
|
||||||
await new SingleFileMessagePackBackingStore(path).push(envelopeOf(bytes));
|
|
||||||
const cache = CultCache.builder().withDocumentType(surface).withGenericStore(new SingleFileMessagePackBackingStore(path)).build();
|
|
||||||
await assertBytesAfterRefused(file, tail, () => cache.pullAllBackingStores(), surface.type);
|
|
||||||
|
|
||||||
// The put path: an envelope arriving with the tail is refused and held nowhere.
|
|
||||||
const written: CultCacheEnvelope[] = [];
|
|
||||||
const held = CultCache.builder().withDocumentType(surface).withGenericStore(memoryStore(written)).build();
|
|
||||||
await assertBytesAfterRefused(file, tail, () => held.putEnvelope(surface, envelopeOf(bytes)), surface.type);
|
|
||||||
assert.equal(written.length, 0, `${file}: nothing reached the store`);
|
|
||||||
assert.equal(held.get(surface, "surface"), undefined, `${file}: nothing is held in memory`);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a payload with an unread slot and a tail is refused by count before any slot is marked or the record held", async () => {
|
|
||||||
const withSlot = await read("extra-slot-record.msgpack");
|
|
||||||
const surface = surfaceDocument();
|
|
||||||
const tailed = Uint8Array.from([...withSlot, 0xc0]);
|
|
||||||
const whole = CultCache.builder().withDocumentType(surface).withGenericStore(memoryStore([envelopeOf(withSlot)])).build();
|
|
||||||
await whole.pullAllBackingStores();
|
|
||||||
assert.ok(whole.unreadSlots(surface, "surface"), "without a tail the record is held with its unread slots");
|
|
||||||
|
|
||||||
const loading = CultCache.builder().withDocumentType(surface).withGenericStore(memoryStore([envelopeOf(tailed)])).build();
|
|
||||||
await assertBytesAfterRefused("extra-slot-record+tail", 1, () => loading.pullAllBackingStores(), surface.type);
|
|
||||||
assert.equal(loading.get(surface, "surface"), undefined);
|
|
||||||
assert.equal(loading.unreadSlots(surface, "surface"), undefined);
|
|
||||||
|
|
||||||
const written: CultCacheEnvelope[] = [];
|
|
||||||
const putting = CultCache.builder().withDocumentType(surface).withGenericStore(memoryStore(written)).build();
|
|
||||||
await assertBytesAfterRefused("extra-slot-record+tail", 1, () => putting.putEnvelope(surface, envelopeOf(tailed)), surface.type);
|
|
||||||
assert.equal(written.length, 0);
|
|
||||||
assert.equal(putting.get(surface, "surface"), undefined);
|
|
||||||
assert.equal(putting.unreadSlots(surface, "surface"), undefined);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a payload that ends early is not bytes after its value: the decoder refuses it, and a user formatter's bytes are not walked", async () => {
|
|
||||||
const whole = await read("union-surface.msgpack");
|
|
||||||
const surface = surfaceDocument();
|
|
||||||
for (const cut of [0, 1, 10, whole.length - 1]) {
|
|
||||||
assert.throws(
|
|
||||||
() => decodeDocumentPayload(surface, documentPayloadFromBytes(whole.slice(0, cut))),
|
|
||||||
(error: Error) => !error.message.includes("bytes after") && !(error instanceof CultCachePayloadDepthError),
|
|
||||||
`truncated at ${cut}`,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
// A header cut short of its length is an early end too, whatever width it declares.
|
|
||||||
for (const early of ["dc00", "dd000000", "de00", "c4", "d9", "a5616263", "9291"]) {
|
|
||||||
assert.throws(
|
|
||||||
() => decodeDocumentPayload(surface, documentPayloadFromBytes(fromHex(early))),
|
|
||||||
(error: Error) => !error.message.includes("bytes after") && !(error instanceof CultCachePayloadDepthError),
|
|
||||||
`early end ${early}`,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
const opaque = defineDocumentType({ type: "tests.opaque", schema: z.unknown(), formatter: { encode: (value: Uint8Array) => value, decode: (bytes: Uint8Array) => bytes } });
|
|
||||||
const tailed = await read("bytes-after-nil.msgpack");
|
|
||||||
assert.equal((decodeDocumentPayload(opaque, documentPayloadFromBytes(tailed)) as Uint8Array).length, tailed.length);
|
|
||||||
});
|
|
||||||
|
|
|
||||||
|
|
@ -1,251 +0,0 @@
|
||||||
import { existsSync } from "node:fs";
|
|
||||||
import { readFile } from "node:fs/promises";
|
|
||||||
import { join, resolve } from "node:path";
|
|
||||||
|
|
||||||
import { z } from "zod";
|
|
||||||
|
|
||||||
import { codecs } from "../src";
|
|
||||||
import type { Codec } from "../src/codec";
|
|
||||||
import { defineDocumentType, documentPayloadFromBytes } from "../src/document";
|
|
||||||
import { recordVersion } from "../src/single-file-messagepack-backing-store";
|
|
||||||
import type { CacheBackingStore, CultCacheEnvelope } from "../src/types";
|
|
||||||
|
|
||||||
// The union-surface fixture: the codecs, schema and value tests/vectors/union-parity was written from, shared by the
|
|
||||||
// union-parity walker and the slot-readonly walker so the shape is spelled once.
|
|
||||||
const { list, int32, lazy, slots, string, union, unit } = codecs;
|
|
||||||
|
|
||||||
|
|
||||||
// The names the C# reference gives the fixture's types (CultSchemaTypeNames.FromType), as union-surface.cc carries them.
|
|
||||||
export const CS = "GameCult.Caching.Tests.UnionParityVectorTests+";
|
|
||||||
|
|
||||||
// The golden is tests/vectors/union-parity, written by the C# reference. Everything below that is bytes or an expected
|
|
||||||
// outcome is read from those committed files; only the value the payload must decode to is spelled here.
|
|
||||||
export function findVectors(from: string): string {
|
|
||||||
for (let dir = from; ; dir = resolve(dir, "..")) {
|
|
||||||
if (existsSync(join(dir, "tests", "vectors", "union-parity"))) return join(dir, "tests", "vectors", "union-parity");
|
|
||||||
if (resolve(dir, "..") === dir) throw new Error("tests/vectors/union-parity not found above the test.");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
export const vectors = findVectors(__dirname);
|
|
||||||
export const read = async (name: string) => new Uint8Array(await readFile(join(vectors, name)));
|
|
||||||
|
|
||||||
// The string the C# writer put inside every refusal payload, to prove a refusal never echoes the payload.
|
|
||||||
export const CANARY = "CANARY-union-golden-4c2a";
|
|
||||||
|
|
||||||
export type Node =
|
|
||||||
| { kind: "Box"; id: string; children: (Node | null)[] }
|
|
||||||
| { kind: "Text"; id: string; content: string }
|
|
||||||
| { kind: "Use"; id: string; composition: Composition; slots: (Node | null)[] }
|
|
||||||
| { kind: "Image"; id: string; uri: string; alt: string }
|
|
||||||
| { kind: "Wrap"; inner: Node | null; id: string };
|
|
||||||
export interface Composition { name: string; body: Node | null }
|
|
||||||
export type Outcome = { kind: "Pending"; message: string } | { kind: "Completed"; sourceVersion: number } | { kind: "Denied" } | { kind: "Floor" } | { kind: "Ceiling" };
|
|
||||||
// The golden's Outcome: the arms of a list carry an element id, so Denied, Floor and Ceiling are one-slot records.
|
|
||||||
export type GoldenOutcome =
|
|
||||||
| { kind: "Pending"; message: string; id: string }
|
|
||||||
| { kind: "Completed"; sourceVersion: number; id: string }
|
|
||||||
| { kind: "Denied"; id: string }
|
|
||||||
| { kind: "Floor"; id: string }
|
|
||||||
| { kind: "Ceiling"; id: string };
|
|
||||||
export type Item = { kind: "Gem"; name: string } | { kind: "Tool"; name: string; uses: number } | { kind: "Part"; name: string; count: number };
|
|
||||||
export type CraftedItem = { kind: "Tool"; name: string; uses: number } | { kind: "Part"; name: string; count: number };
|
|
||||||
export interface Surface {
|
|
||||||
id: string;
|
|
||||||
version: number;
|
|
||||||
root: Node | null;
|
|
||||||
outcomes: (GoldenOutcome | null)[];
|
|
||||||
part: Item | null;
|
|
||||||
crafted: CraftedItem | null;
|
|
||||||
missing: Node | null;
|
|
||||||
}
|
|
||||||
|
|
||||||
export const composition = slots<Composition>({ 0: ["name", string], 1: ["body", lazy(() => node)] }, `${CS}Composition`);
|
|
||||||
export const node: Codec<Node | null> = union<Node>("Node", {
|
|
||||||
0: ["Box", slots<{ id: string; children: (Node | null)[] }>({ 0: ["id", string], 1: ["children", list(lazy(() => node))] }, `${CS}Box`)],
|
|
||||||
1: ["Text", slots<{ id: string; content: string }>({ 0: ["id", string], 1: ["content", string] }, `${CS}Text`)],
|
|
||||||
2: ["Use", slots<{ id: string; composition: Composition; slots: (Node | null)[] }>({
|
|
||||||
0: ["id", string], 1: ["composition", composition], 2: ["slots", list(lazy(() => node))],
|
|
||||||
})],
|
|
||||||
5: ["Image", slots<{ id: string; uri: string; alt: string }>({ 0: ["id", string], 1: ["uri", string], 3: ["alt", string] })],
|
|
||||||
6: ["Wrap", slots<{ inner: Node | null; id: string }>({ 0: ["inner", lazy(() => node)], 1: ["id", string] })],
|
|
||||||
}, `${CS}Node`);
|
|
||||||
export const outcome = union<Outcome>("Outcome", {
|
|
||||||
0: ["Pending", slots<{ message: string }>({ 0: ["message", string] })],
|
|
||||||
1: ["Completed", slots<{ sourceVersion: number }>({ 0: ["sourceVersion", int32] })],
|
|
||||||
2: ["Denied", unit],
|
|
||||||
[-2147483648]: ["Floor", unit],
|
|
||||||
2147483647: ["Ceiling", unit],
|
|
||||||
}, `${CS}Outcome`);
|
|
||||||
export const idOnly = slots<{ id: string }>({ 0: ["id", string] });
|
|
||||||
export const goldenOutcome = union<GoldenOutcome>("Outcome", {
|
|
||||||
0: ["Pending", slots<{ message: string; id: string }>({ 0: ["message", string], 1: ["id", string] })],
|
|
||||||
1: ["Completed", slots<{ sourceVersion: number; id: string }>({ 0: ["sourceVersion", int32], 1: ["id", string] })],
|
|
||||||
2: ["Denied", idOnly],
|
|
||||||
[-2147483648]: ["Floor", idOnly],
|
|
||||||
2147483647: ["Ceiling", idOnly],
|
|
||||||
}, `${CS}Outcome`);
|
|
||||||
export const toolArm = slots<{ name: string; uses: number }>({ 0: ["name", string], 1: ["uses", int32] });
|
|
||||||
export const partArm = slots<{ name: string; count: number }>({ 0: ["name", string], 1: ["count", int32] });
|
|
||||||
export const item = union<Item>("Item", {
|
|
||||||
0: ["Gem", slots<{ name: string }>({ 0: ["name", string] })],
|
|
||||||
1: ["Tool", toolArm],
|
|
||||||
2: ["Part", partArm],
|
|
||||||
}, `${CS}Item`);
|
|
||||||
export const craftedItem = union<CraftedItem>("CraftedItem", { 0: ["Tool", toolArm], 1: ["Part", partArm] }, `${CS}CraftedItem`);
|
|
||||||
export const surfaceCodecOf = (typeName: string) => slots<Surface>({
|
|
||||||
0: ["id", string],
|
|
||||||
1: ["version", int32],
|
|
||||||
2: ["root", node],
|
|
||||||
3: ["outcomes", list(goldenOutcome)],
|
|
||||||
4: ["part", item],
|
|
||||||
5: ["crafted", craftedItem],
|
|
||||||
6: ["missing", node, null],
|
|
||||||
}, typeName);
|
|
||||||
export const surfaceCodec = surfaceCodecOf(`${CS}UnionSurface`);
|
|
||||||
|
|
||||||
export const nodeSchema: z.ZodType<Node | null> = z.lazy(() =>
|
|
||||||
z.union([
|
|
||||||
z.null(),
|
|
||||||
z.discriminatedUnion("kind", [
|
|
||||||
z.object({ kind: z.literal("Box"), id: z.string(), children: z.array(nodeSchema) }),
|
|
||||||
z.object({ kind: z.literal("Text"), id: z.string(), content: z.string() }),
|
|
||||||
z.object({
|
|
||||||
kind: z.literal("Use"),
|
|
||||||
id: z.string(),
|
|
||||||
composition: z.object({ name: z.string(), body: nodeSchema }),
|
|
||||||
slots: z.array(nodeSchema),
|
|
||||||
}),
|
|
||||||
z.object({ kind: z.literal("Image"), id: z.string(), uri: z.string(), alt: z.string() }),
|
|
||||||
z.object({ kind: z.literal("Wrap"), inner: nodeSchema, id: z.string() }),
|
|
||||||
]),
|
|
||||||
]));
|
|
||||||
export const surfaceSchema = z.object({
|
|
||||||
id: z.string(),
|
|
||||||
version: z.number(),
|
|
||||||
root: nodeSchema,
|
|
||||||
outcomes: z.array(z.union([
|
|
||||||
z.null(),
|
|
||||||
z.discriminatedUnion("kind", [
|
|
||||||
z.object({ kind: z.literal("Pending"), message: z.string(), id: z.string() }),
|
|
||||||
z.object({ kind: z.literal("Completed"), sourceVersion: z.number(), id: z.string() }),
|
|
||||||
z.object({ kind: z.literal("Denied"), id: z.string() }),
|
|
||||||
z.object({ kind: z.literal("Floor"), id: z.string() }),
|
|
||||||
z.object({ kind: z.literal("Ceiling"), id: z.string() }),
|
|
||||||
]),
|
|
||||||
])),
|
|
||||||
part: z.union([z.null(), z.discriminatedUnion("kind", [
|
|
||||||
z.object({ kind: z.literal("Gem"), name: z.string() }),
|
|
||||||
z.object({ kind: z.literal("Tool"), name: z.string(), uses: z.number() }),
|
|
||||||
z.object({ kind: z.literal("Part"), name: z.string(), count: z.number() }),
|
|
||||||
])]),
|
|
||||||
crafted: z.union([z.null(), z.discriminatedUnion("kind", [
|
|
||||||
z.object({ kind: z.literal("Tool"), name: z.string(), uses: z.number() }),
|
|
||||||
z.object({ kind: z.literal("Part"), name: z.string(), count: z.number() }),
|
|
||||||
])]),
|
|
||||||
missing: nodeSchema,
|
|
||||||
}) as unknown as z.ZodType<Surface>;
|
|
||||||
|
|
||||||
// The reference's SurfaceDeclaring: the same layout, schema tests.union_surface.v2, listing the older wide id compatible.
|
|
||||||
export function surfaceDeclaringDocument() {
|
|
||||||
return defineDocumentType({
|
|
||||||
type: "tests.union_surface",
|
|
||||||
schemaId: "tests.union_surface.v2",
|
|
||||||
schemaName: "tests.union_surface",
|
|
||||||
schemaVersion: "tests.union_surface.v2",
|
|
||||||
compatibleSchemaIds: ["tests.union_surface.wide"],
|
|
||||||
schema: surfaceSchema,
|
|
||||||
codec: surfaceCodecOf(`${CS}SurfaceDeclaring`),
|
|
||||||
name: "id",
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
export function surfaceDocument(schemaId?: string, contentHash?: string) {
|
|
||||||
return defineDocumentType({
|
|
||||||
...(contentHash === undefined ? {} : { contentHash }),
|
|
||||||
type: "tests.union_surface",
|
|
||||||
schemaId: schemaId ?? "tests.union_surface.v1",
|
|
||||||
schemaName: "tests.union_surface",
|
|
||||||
schemaVersion: "tests.union_surface.v1",
|
|
||||||
schema: surfaceSchema,
|
|
||||||
codec: surfaceCodec,
|
|
||||||
name: "id",
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
export const golden: Surface = {
|
|
||||||
id: "surface",
|
|
||||||
version: 3,
|
|
||||||
root: {
|
|
||||||
kind: "Box",
|
|
||||||
id: "0000000000c0",
|
|
||||||
children: [
|
|
||||||
{ kind: "Text", id: "0000000000c1", content: "hello" },
|
|
||||||
{
|
|
||||||
kind: "Use",
|
|
||||||
id: "0000000000c2",
|
|
||||||
composition: {
|
|
||||||
name: "comp",
|
|
||||||
body: {
|
|
||||||
kind: "Box",
|
|
||||||
id: "0000000000d0",
|
|
||||||
children: [
|
|
||||||
{ kind: "Text", id: "0000000000d1", content: "x" },
|
|
||||||
{ kind: "Image", id: "0000000000d2", uri: "uri://a", alt: "alt" },
|
|
||||||
],
|
|
||||||
},
|
|
||||||
},
|
|
||||||
slots: [{ kind: "Text", id: "0000000000e1", content: "slot" }, null, { kind: "Box", id: "0000000000e2", children: [] }],
|
|
||||||
},
|
|
||||||
{ kind: "Image", id: "0000000000c3", uri: "uri://b", alt: "" },
|
|
||||||
],
|
|
||||||
},
|
|
||||||
outcomes: [
|
|
||||||
{ kind: "Pending", message: "wait", id: "0000000000a1" },
|
|
||||||
{ kind: "Completed", sourceVersion: 7, id: "0000000000a2" },
|
|
||||||
{ kind: "Denied", id: "0000000000a3" },
|
|
||||||
],
|
|
||||||
part: { kind: "Tool", name: "hammer", uses: 12 },
|
|
||||||
crafted: { kind: "Part", name: "gear", count: 4 },
|
|
||||||
missing: null,
|
|
||||||
};
|
|
||||||
export const hex = (data: Uint8Array) => Buffer.from(data).toString("hex");
|
|
||||||
|
|
||||||
// tests.slot_unit: a document [Name, Outcome: UnitOutcome], whose one arm Denied2 is a unit arm (extra-slot-store.cc, record
|
|
||||||
// unit-arm). The reader's names are the reference's: a mark names Denied2.
|
|
||||||
export const unitOutcome = union<{ kind: "Denied2" }>("UnitOutcome", { 2: ["Denied2", unit] }, `${CS}UnitOutcome`);
|
|
||||||
export function slotUnitDocument(schemaId: string, contentHash?: string) {
|
|
||||||
return defineDocumentType({
|
|
||||||
...(contentHash === undefined ? {} : { contentHash }),
|
|
||||||
type: "tests.slot_unit",
|
|
||||||
schemaId,
|
|
||||||
schemaName: "tests.slot_unit",
|
|
||||||
schemaVersion: "tests.slot_unit.v1",
|
|
||||||
schema: z.object({ name: z.string(), outcome: z.union([z.null(), z.object({ kind: z.literal("Denied2") })]) }),
|
|
||||||
codec: slots<{ name: string; outcome: { kind: "Denied2" } | null }>({ 0: ["name", string], 1: ["outcome", unitOutcome] }, `${CS}SlotUnit`),
|
|
||||||
name: "name",
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
export function envelopeOf(payload: Uint8Array): CultCacheEnvelope {
|
|
||||||
return { key: "surface", type: "tests.union_surface", payload: documentPayloadFromBytes(payload), storedAt: new Date().toISOString() };
|
|
||||||
}
|
|
||||||
|
|
||||||
export function memoryStore(entries: CultCacheEnvelope[]): CacheBackingStore & { entries: CultCacheEnvelope[] } {
|
|
||||||
return {
|
|
||||||
entries,
|
|
||||||
async pullAll() { return entries.map((entry) => ({ ...entry })); },
|
|
||||||
async push(entry) { entries.push(entry); },
|
|
||||||
async delete() {},
|
|
||||||
async read(key) {
|
|
||||||
const envelope = [...entries].reverse().find((entry) => entry.key === key);
|
|
||||||
return envelope === undefined ? undefined : { envelope, version: recordVersion(envelope) };
|
|
||||||
},
|
|
||||||
async commitIf(entry, expectedVersion) {
|
|
||||||
const current = [...entries].reverse().find((candidate) => candidate.key === entry.key);
|
|
||||||
if ((current === undefined ? null : recordVersion(current)) !== expectedVersion) return { outcome: "mismatch" };
|
|
||||||
entries.push(entry);
|
|
||||||
return { outcome: "committed", storedAt: entry.storedAt };
|
|
||||||
},
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
@ -1,600 +0,0 @@
|
||||||
import assert from "node:assert/strict";
|
|
||||||
import { mkdtemp, readFile, rm } from "node:fs/promises";
|
|
||||||
import { tmpdir } from "node:os";
|
|
||||||
import { join } from "node:path";
|
|
||||||
import test from "node:test";
|
|
||||||
import { setImmediate as tick } from "node:timers/promises";
|
|
||||||
|
|
||||||
import { decode, encode } from "@msgpack/msgpack";
|
|
||||||
import { z } from "zod";
|
|
||||||
|
|
||||||
import { CultCache } from "../src/cult-cache";
|
|
||||||
import { defineDocumentRegistry, defineDocumentType, documentPayloadBytes, documentPayloadFromBytes } from "../src/document";
|
|
||||||
import { SingleFileMessagePackBackingStore, readSingleFileStore } from "../src/single-file-messagepack-backing-store";
|
|
||||||
import { SchemaConflictError, schemaIdForEnvelope } from "../src/store-format";
|
|
||||||
import type { CacheBackingStore } from "../src/types";
|
|
||||||
import { envelopeOf, memoryStore, read, surfaceDocument } from "./union-surface-fixture";
|
|
||||||
|
|
||||||
// CultCache.update: read the record and its content version from the store, apply a function to a copy, commit only if the
|
|
||||||
// version still holds, run again on a lost race (variants:cut_spec:cut-update-with-retry-ts.r1; the C# tests in
|
|
||||||
// tests/GameCult.Caching.Tests/UpdateTests.cs are the parity).
|
|
||||||
|
|
||||||
const counterDocument = defineDocumentType({
|
|
||||||
type: "update.counter",
|
|
||||||
schemaId: "update.counter.v1",
|
|
||||||
schemaName: "update.counter",
|
|
||||||
schemaVersion: "update.counter.v1",
|
|
||||||
schema: z.object({ value: z.number().int() }),
|
|
||||||
});
|
|
||||||
const tallyDocument = defineDocumentType({
|
|
||||||
type: "update.tally",
|
|
||||||
schemaId: "update.tally.v1",
|
|
||||||
schemaName: "update.tally",
|
|
||||||
schemaVersion: "update.tally.v1",
|
|
||||||
schema: z.object({ count: z.number().int() }),
|
|
||||||
});
|
|
||||||
const registry = defineDocumentRegistry(counterDocument, tallyDocument);
|
|
||||||
const settingsFields = { schemaName: "update.settings", schemaVersion: "update.settings.v1", schemaId: "update.settings.v1", schema: z.object({ theme: z.string() }) };
|
|
||||||
const settingsDocument = defineDocumentType({ type: "update.settings", ...settingsFields, global: true });
|
|
||||||
const plainSettingsDocument = defineDocumentType({ type: "update.settings", ...settingsFields });
|
|
||||||
|
|
||||||
const KEY = "counter";
|
|
||||||
|
|
||||||
async function withDirectory<T>(body: (path: string) => Promise<T>): Promise<T> {
|
|
||||||
const directory = await mkdtemp(join(tmpdir(), "cultcache-update-"));
|
|
||||||
try {
|
|
||||||
return await body(join(directory, "store.cc"));
|
|
||||||
} finally {
|
|
||||||
await rm(directory, { recursive: true, force: true });
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
type Registry = Parameters<ReturnType<typeof CultCache.builder>["withRegistry"]>[0];
|
|
||||||
|
|
||||||
async function open(path: string, documents: Registry = registry): Promise<CultCache> {
|
|
||||||
const cache = CultCache.builder().withRegistry(documents).withGenericStore(new SingleFileMessagePackBackingStore(path)).build();
|
|
||||||
await cache.pullAllBackingStores();
|
|
||||||
return cache;
|
|
||||||
}
|
|
||||||
|
|
||||||
// What the file holds at the key, read without a cache.
|
|
||||||
function stored(path: string, key = KEY): number | undefined {
|
|
||||||
const envelope = readSingleFileStore(path).envelopes.find((candidate) => candidate.key === key);
|
|
||||||
return envelope === undefined ? undefined : (decode(documentPayloadBytes(envelope.payload)) as { value: number }).value;
|
|
||||||
}
|
|
||||||
|
|
||||||
const plus = (n: number) => (current: { value: number } | undefined) => ({ value: (current?.value ?? 0) + n });
|
|
||||||
|
|
||||||
test("two writers updating lose no increment", async () => {
|
|
||||||
await withDirectory(async (path) => {
|
|
||||||
const [left, right] = [await open(path), await open(path)];
|
|
||||||
let calls = 0;
|
|
||||||
const loop = async (cache: CultCache) => {
|
|
||||||
const outcomes: string[] = [];
|
|
||||||
for (let i = 0; i < 50; i++) {
|
|
||||||
const result = await cache.update(counterDocument, KEY, async (current) => {
|
|
||||||
calls++;
|
|
||||||
await tick();
|
|
||||||
return { value: (current?.value ?? 0) + 1 };
|
|
||||||
}, { maxAttempts: 50 });
|
|
||||||
outcomes.push(result.outcome);
|
|
||||||
}
|
|
||||||
return outcomes;
|
|
||||||
};
|
|
||||||
const outcomes = (await Promise.all([loop(left), loop(right)])).flat();
|
|
||||||
assert.ok(outcomes.every((outcome) => outcome === "updated"), outcomes.join());
|
|
||||||
assert.equal(stored(path), 100);
|
|
||||||
assert.ok(calls > 100, `the caches raced: apply ran ${calls} times`);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a lost attempt reruns apply on the fresh value", async () => {
|
|
||||||
await withDirectory(async (path) => {
|
|
||||||
const [cache, rival] = [await open(path), await open(path)];
|
|
||||||
await cache.put(counterDocument, KEY, { value: 1 });
|
|
||||||
const seen: Array<number | undefined> = [];
|
|
||||||
const result = await cache.update(counterDocument, KEY, async (current) => {
|
|
||||||
seen.push(current?.value);
|
|
||||||
if (seen.length === 1) await rival.put(counterDocument, KEY, { value: 100 });
|
|
||||||
return { value: current!.value + 1 };
|
|
||||||
});
|
|
||||||
assert.deepEqual(seen, [1, 100]);
|
|
||||||
assert.equal(result.outcome, "updated");
|
|
||||||
assert.equal(result.document?.value, 101);
|
|
||||||
assert.equal(stored(path), 101);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("exhausted attempts return lostRace, and the cache then shows the store", async () => {
|
|
||||||
await withDirectory(async (path) => {
|
|
||||||
const [cache, rival] = [await open(path), await open(path)];
|
|
||||||
await cache.put(counterDocument, KEY, { value: 1 });
|
|
||||||
let calls = 0;
|
|
||||||
const result = await cache.update(
|
|
||||||
counterDocument,
|
|
||||||
KEY,
|
|
||||||
async (current) => {
|
|
||||||
calls++;
|
|
||||||
await rival.put(counterDocument, KEY, { value: 100 * calls });
|
|
||||||
return { value: current!.value + 1 };
|
|
||||||
},
|
|
||||||
{ maxAttempts: 3 },
|
|
||||||
);
|
|
||||||
assert.equal(calls, 3);
|
|
||||||
assert.equal(result.outcome, "lostRace");
|
|
||||||
assert.equal(result.document?.value, 300);
|
|
||||||
assert.equal(stored(path), 300);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("five attempts by default", async () => {
|
|
||||||
await withDirectory(async (path) => {
|
|
||||||
const [cache, rival] = [await open(path), await open(path)];
|
|
||||||
let calls = 0;
|
|
||||||
const result = await cache.update(counterDocument, KEY, async () => {
|
|
||||||
calls++;
|
|
||||||
await rival.put(counterDocument, KEY, { value: calls });
|
|
||||||
return { value: -1 };
|
|
||||||
});
|
|
||||||
assert.equal(result.outcome, "lostRace");
|
|
||||||
assert.equal(calls, 5);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("maxAttempts 1 makes one call", async () => {
|
|
||||||
await withDirectory(async (path) => {
|
|
||||||
const [cache, rival] = [await open(path), await open(path)];
|
|
||||||
await cache.put(counterDocument, KEY, { value: 1 });
|
|
||||||
let calls = 0;
|
|
||||||
const apply = async (current: { value: number } | undefined) => {
|
|
||||||
calls++;
|
|
||||||
await rival.put(counterDocument, KEY, { value: 50 + calls });
|
|
||||||
return { value: current!.value + 1 };
|
|
||||||
};
|
|
||||||
assert.equal((await cache.update(counterDocument, KEY, apply, { maxAttempts: 1 })).outcome, "lostRace");
|
|
||||||
assert.equal(calls, 1);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
// An apply that declines resolves at once whatever the bound, so a validation that lets a bad value through fails the assertion
|
|
||||||
// below instead of looping: no apply here ever loses a race.
|
|
||||||
test("invalid maxAttempts (undefined is the default, null is refused) and a non-function reject before any call", async () => {
|
|
||||||
await withDirectory(async (path) => {
|
|
||||||
const cache = await open(path);
|
|
||||||
let calls = 0;
|
|
||||||
const apply = () => (calls++, undefined);
|
|
||||||
for (const maxAttempts of [0, -1, 1.5, Number.NaN, Number.POSITIVE_INFINITY, null as never]) {
|
|
||||||
await assert.rejects(() => cache.update(counterDocument, KEY, apply, { maxAttempts }), RangeError, `maxAttempts ${String(maxAttempts)}`);
|
|
||||||
}
|
|
||||||
await assert.rejects(() => cache.update(counterDocument, KEY, "no" as never), TypeError);
|
|
||||||
assert.equal(calls, 0);
|
|
||||||
assert.equal((await cache.update(counterDocument, KEY, apply, { maxAttempts: undefined })).outcome, "declined");
|
|
||||||
assert.equal(calls, 1);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("null from apply declines as undefined does: nothing is written", async () => {
|
|
||||||
await withDirectory(async (path) => {
|
|
||||||
const cache = await open(path);
|
|
||||||
await cache.put(counterDocument, KEY, { value: 1 });
|
|
||||||
const before = await readFile(path);
|
|
||||||
const result = await cache.update(counterDocument, KEY, () => null as never);
|
|
||||||
assert.deepEqual(result, { outcome: "declined", document: cache.get(counterDocument, KEY) });
|
|
||||||
assert.deepEqual([...(await readFile(path))], [...before]);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a cache with no store refuses a key held as another type before apply runs", async () => {
|
|
||||||
const cache = CultCache.builder().withRegistry(registry).build();
|
|
||||||
await cache.put(tallyDocument, KEY, { count: 1 });
|
|
||||||
let calls = 0;
|
|
||||||
await assert.rejects(() => cache.update(counterDocument, KEY, () => (calls++, { value: 1 })), /is not a "update.counter"/);
|
|
||||||
assert.equal(calls, 0);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a store attached while apply awaits turns the commit into a lost race, never a blind push", async () => {
|
|
||||||
await withDirectory(async (path) => {
|
|
||||||
const writer = await open(path);
|
|
||||||
await writer.put(counterDocument, KEY, { value: 50 });
|
|
||||||
const cache = CultCache.builder().withRegistry(registry).build();
|
|
||||||
const seen: Array<number | undefined> = [];
|
|
||||||
const result = await cache.update(counterDocument, KEY, async (current) => {
|
|
||||||
seen.push(current?.value);
|
|
||||||
if (seen.length === 1) cache.addBackingStore(new SingleFileMessagePackBackingStore(path));
|
|
||||||
return { value: (current?.value ?? 0) + 1 };
|
|
||||||
});
|
|
||||||
assert.deepEqual(seen, [undefined, 50], "the second attempt reads the store's record");
|
|
||||||
assert.equal(result.outcome, "updated");
|
|
||||||
assert.equal(stored(path), 51);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("put installs the storedAt the store stamped, so the cache and the file agree", async () => {
|
|
||||||
await withDirectory(async (path) => {
|
|
||||||
const cache = await open(path);
|
|
||||||
await cache.put(counterDocument, KEY, { value: 1 });
|
|
||||||
const store = new SingleFileMessagePackBackingStore(path);
|
|
||||||
const [envelope] = readSingleFileStore(path).envelopes;
|
|
||||||
await store.push({ ...envelope!, payload: documentPayloadFromBytes(encode({ value: 99 })), storedAt: "2099-01-01T00:00:00.000Z" });
|
|
||||||
await cache.put(counterDocument, KEY, { value: 2 });
|
|
||||||
const onDisk = readSingleFileStore(path).envelopes[0]!.storedAt;
|
|
||||||
assert.equal(onDisk, "2099-01-01T00:00:00.001Z");
|
|
||||||
assert.equal(cache.getEnvelope(counterDocument, KEY)!.storedAt, onDisk);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("apply gets a fresh copy: changing it changes nothing held, and a lost attempt's change is not seen by the next", async () => {
|
|
||||||
await withDirectory(async (path) => {
|
|
||||||
const [cache, rival] = [await open(path), await open(path)];
|
|
||||||
await cache.put(counterDocument, KEY, { value: 1 });
|
|
||||||
const argument: Array<{ value: number } | undefined> = [];
|
|
||||||
const seen: number[] = [];
|
|
||||||
await cache.update(counterDocument, KEY, async (current) => {
|
|
||||||
argument.push(current);
|
|
||||||
assert.notEqual(current, cache.get(counterDocument, KEY));
|
|
||||||
seen.push(current!.value);
|
|
||||||
current!.value += 1000;
|
|
||||||
assert.equal(cache.get(counterDocument, KEY)!.value, 1);
|
|
||||||
if (seen.length === 1) await rival.put(counterDocument, KEY, { value: 7 });
|
|
||||||
return { value: current!.value + 1 };
|
|
||||||
});
|
|
||||||
assert.deepEqual(seen, [1, 7], "the second attempt does not see the first one's change");
|
|
||||||
assert.notEqual(argument[0], argument[1]);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("an in-place change to the held value is neither applied nor persisted", async () => {
|
|
||||||
await withDirectory(async (path) => {
|
|
||||||
const [cache, fresh] = [await open(path), await open(path)];
|
|
||||||
await cache.put(counterDocument, KEY, { value: 1 });
|
|
||||||
cache.get(counterDocument, KEY)!.value = 999;
|
|
||||||
const seen: number[] = [];
|
|
||||||
const result = await cache.update(counterDocument, KEY, (current) => {
|
|
||||||
seen.push(current!.value);
|
|
||||||
return { value: current!.value + 1 };
|
|
||||||
});
|
|
||||||
assert.deepEqual(seen, [1]);
|
|
||||||
assert.equal(stored(path), 2);
|
|
||||||
await fresh.pullAllBackingStores();
|
|
||||||
assert.equal(fresh.get(counterDocument, KEY)!.value, 2);
|
|
||||||
result.document!.value = 999;
|
|
||||||
await cache.update(counterDocument, KEY, plus(1));
|
|
||||||
assert.equal(stored(path), 3);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("undefined from apply declines: nothing is written", async () => {
|
|
||||||
await withDirectory(async (path) => {
|
|
||||||
const cache = await open(path);
|
|
||||||
await cache.put(counterDocument, KEY, { value: 1 });
|
|
||||||
const before = await readFile(path);
|
|
||||||
const held = await cache.update(counterDocument, KEY, () => undefined);
|
|
||||||
assert.equal(held.outcome, "declined");
|
|
||||||
assert.equal(held.document, cache.get(counterDocument, KEY));
|
|
||||||
const absent = await cache.update(counterDocument, "absent", () => undefined);
|
|
||||||
assert.deepEqual(absent, { outcome: "declined", document: undefined });
|
|
||||||
assert.deepEqual([...(await readFile(path))], [...before]);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("an absent key is created once under a race", async () => {
|
|
||||||
await withDirectory(async (path) => {
|
|
||||||
const [left, right] = [await open(path), await open(path)];
|
|
||||||
const outcomes = await Promise.all(
|
|
||||||
[left, right].map((cache) =>
|
|
||||||
cache.update(counterDocument, KEY, async (current) => {
|
|
||||||
await tick();
|
|
||||||
return { value: (current?.value ?? 0) + 1 };
|
|
||||||
}),
|
|
||||||
),
|
|
||||||
);
|
|
||||||
assert.deepEqual(outcomes.map((result) => result.outcome), ["updated", "updated"]);
|
|
||||||
assert.equal(stored(path), 2);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a rival writing and restoring the value still reruns apply", async () => {
|
|
||||||
await withDirectory(async (path) => {
|
|
||||||
const [cache, rival] = [await open(path), await open(path)];
|
|
||||||
await cache.put(counterDocument, KEY, { value: 1 });
|
|
||||||
const seen: number[] = [];
|
|
||||||
await cache.update(counterDocument, KEY, async (current) => {
|
|
||||||
seen.push(current!.value);
|
|
||||||
if (seen.length === 1) {
|
|
||||||
await rival.put(counterDocument, KEY, { value: 5 });
|
|
||||||
await rival.put(counterDocument, KEY, { value: 1 });
|
|
||||||
}
|
|
||||||
return { value: current!.value + 1 };
|
|
||||||
});
|
|
||||||
assert.deepEqual(seen, [1, 1]);
|
|
||||||
assert.equal(stored(path), 2);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a rival removal is seen as undefined", async () => {
|
|
||||||
await withDirectory(async (path) => {
|
|
||||||
const [cache, rival] = [await open(path), await open(path)];
|
|
||||||
await cache.put(counterDocument, KEY, { value: 1 });
|
|
||||||
const seen: Array<number | undefined> = [];
|
|
||||||
await cache.update(counterDocument, KEY, async (current) => {
|
|
||||||
seen.push(current?.value);
|
|
||||||
if (seen.length === 1) {
|
|
||||||
await rival.pullAllBackingStores();
|
|
||||||
await rival.delete(counterDocument, KEY);
|
|
||||||
}
|
|
||||||
return { value: (current?.value ?? 0) + 1 };
|
|
||||||
});
|
|
||||||
assert.deepEqual(seen, [1, undefined]);
|
|
||||||
assert.equal(stored(path), 1);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a stale cache's first attempt reads the store", async () => {
|
|
||||||
await withDirectory(async (path) => {
|
|
||||||
const [stale, rival] = [await open(path), await open(path)];
|
|
||||||
await rival.put(counterDocument, KEY, { value: 1 });
|
|
||||||
await stale.pullAllBackingStores();
|
|
||||||
await rival.put(counterDocument, KEY, { value: 7 });
|
|
||||||
const seen: number[] = [];
|
|
||||||
await stale.update(counterDocument, KEY, (current) => {
|
|
||||||
seen.push(current!.value);
|
|
||||||
return { value: current!.value + 1 };
|
|
||||||
});
|
|
||||||
assert.deepEqual(seen, [7]);
|
|
||||||
assert.equal(stored(path), 8);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("refusals are not retried and apply is not called for a record it cannot copy", async () => {
|
|
||||||
await withDirectory(async (path) => {
|
|
||||||
const cache = await open(path);
|
|
||||||
await cache.put(tallyDocument, "tally", { count: 1 });
|
|
||||||
const before = await readFile(path);
|
|
||||||
let calls = 0;
|
|
||||||
const apply = (current: { value: number } | undefined) => {
|
|
||||||
calls++;
|
|
||||||
return { value: (current?.value ?? 0) + 1 };
|
|
||||||
};
|
|
||||||
// Another type at the key.
|
|
||||||
await assert.rejects(() => cache.update(counterDocument, "tally", apply), /not a "update.counter"/);
|
|
||||||
// A foreign record: a type this cache has no definition for.
|
|
||||||
const narrow = await open(path, defineDocumentRegistry(counterDocument));
|
|
||||||
await assert.rejects(() => narrow.update(counterDocument, "tally", apply), /not a "update.counter"/);
|
|
||||||
assert.equal(calls, 0);
|
|
||||||
assert.deepEqual([...(await readFile(path))], [...before]);
|
|
||||||
|
|
||||||
// A store without read and commitIf cannot take a conditional write.
|
|
||||||
const bare: CacheBackingStore = { pullAll: async () => [], push: async () => {}, delete: async () => {} };
|
|
||||||
const plain = CultCache.builder().withRegistry(registry).withGenericStore(bare).build();
|
|
||||||
await plain.pullAllBackingStores();
|
|
||||||
await assert.rejects(() => plain.update(counterDocument, KEY, apply), /read and commitIf/);
|
|
||||||
assert.equal(calls, 0);
|
|
||||||
|
|
||||||
// A record held read-only is refused by the judge after apply ran once; apply that throws is not retried either.
|
|
||||||
const surface = surfaceDocument();
|
|
||||||
const entries = [envelopeOf(await read("extra-slot-record.msgpack"))];
|
|
||||||
const readOnly = CultCache.builder().withDocumentType(surface).withGenericStore(memoryStore(entries)).build();
|
|
||||||
await readOnly.pullAllBackingStores();
|
|
||||||
let surfaceCalls = 0;
|
|
||||||
await assert.rejects(() => readOnly.update(surface, "surface", (value) => (surfaceCalls++, value)), SchemaConflictError);
|
|
||||||
assert.equal(surfaceCalls, 1);
|
|
||||||
assert.equal(entries.length, 1, "nothing reached the store");
|
|
||||||
await assert.rejects(
|
|
||||||
() => cache.update(counterDocument, KEY, () => { calls++; throw new Error("boom"); }),
|
|
||||||
/boom/,
|
|
||||||
);
|
|
||||||
assert.equal(calls, 1);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("own writes cause no retry, and updated returns the held instance", async () => {
|
|
||||||
await withDirectory(async (path) => {
|
|
||||||
const cache = await open(path);
|
|
||||||
await cache.put(counterDocument, KEY, { value: 1 });
|
|
||||||
let calls = 0;
|
|
||||||
const apply = (current: { value: number } | undefined) => {
|
|
||||||
calls++;
|
|
||||||
return { value: current!.value + 1 };
|
|
||||||
};
|
|
||||||
await cache.update(counterDocument, KEY, apply);
|
|
||||||
const second = await cache.update(counterDocument, KEY, apply);
|
|
||||||
assert.equal(calls, 2);
|
|
||||||
assert.equal(second.outcome, "updated");
|
|
||||||
assert.equal(second.document, cache.get(counterDocument, KEY));
|
|
||||||
assert.equal(stored(path), 3);
|
|
||||||
// The cache holds the record as the store wrote it, the stamp the store chose included: over a record stamped in the future
|
|
||||||
// the store writes one millisecond after it, whatever the clock says.
|
|
||||||
const future = readSingleFileStore(path).envelopes[0]!;
|
|
||||||
await new SingleFileMessagePackBackingStore(path).push({ ...future, payload: documentPayloadFromBytes(encode({ value: 99 })), storedAt: "2099-01-01T00:00:00.000Z" });
|
|
||||||
await cache.update(counterDocument, KEY, apply);
|
|
||||||
assert.equal(readSingleFileStore(path).envelopes[0]!.storedAt, "2099-01-01T00:00:00.001Z");
|
|
||||||
assert.equal(cache.getEnvelope(counterDocument, KEY)!.storedAt, "2099-01-01T00:00:00.001Z");
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("apply runs outside the cache's serial queue", async () => {
|
|
||||||
await withDirectory(async (path) => {
|
|
||||||
const cache = await open(path);
|
|
||||||
let calls = 0;
|
|
||||||
const result = await cache.update(counterDocument, KEY, async (current) => {
|
|
||||||
calls++;
|
|
||||||
await Promise.race([
|
|
||||||
cache.put(tallyDocument, "other", { count: 1 }),
|
|
||||||
new Promise((_, reject) => setTimeout(() => reject(new Error("a cache call from apply did not finish")), 5000).unref()),
|
|
||||||
]);
|
|
||||||
return { value: (current?.value ?? 0) + 1 };
|
|
||||||
});
|
|
||||||
assert.equal(result.outcome, "updated");
|
|
||||||
assert.equal(calls, 1);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a cache with no store loses no increment under interleaved updates", async () => {
|
|
||||||
const cache = CultCache.builder().withRegistry(registry).build();
|
|
||||||
await cache.pullAllBackingStores();
|
|
||||||
let calls = 0;
|
|
||||||
const loop = async () => {
|
|
||||||
let updated = 0;
|
|
||||||
for (let i = 0; i < 50; i++) {
|
|
||||||
const result = await cache.update(counterDocument, KEY, async (current) => {
|
|
||||||
calls++;
|
|
||||||
await tick();
|
|
||||||
return { value: (current?.value ?? 0) + 1 };
|
|
||||||
});
|
|
||||||
if (result.outcome === "updated") updated++;
|
|
||||||
}
|
|
||||||
return updated;
|
|
||||||
};
|
|
||||||
// The two loops run in lockstep, so one may lose every round (a lostRace is the answer, not a lost write): what is held is
|
|
||||||
// exactly what the updated outcomes wrote.
|
|
||||||
const updated = (await Promise.all([loop(), loop()])).reduce((sum, n) => sum + n, 0);
|
|
||||||
assert.equal(cache.get(counterDocument, KEY)!.value, updated);
|
|
||||||
assert.ok(calls > updated, `the loops raced: apply ran ${calls} times for ${updated} writes`);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a store-less cache copies the bytes it admitted, not the held value", async () => {
|
|
||||||
const cache = CultCache.builder().withRegistry(registry).build();
|
|
||||||
await cache.put(counterDocument, KEY, { value: 1 });
|
|
||||||
cache.get(counterDocument, KEY)!.value = 999;
|
|
||||||
const seen: number[] = [];
|
|
||||||
await cache.update(counterDocument, KEY, (current) => (seen.push(current!.value), { value: current!.value + 1 }));
|
|
||||||
assert.deepEqual(seen, [1]);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("updateGlobal updates the global record and refuses one loaded from a legacy key until putGlobal retires it", async () => {
|
|
||||||
await withDirectory(async (path) => {
|
|
||||||
const settings = defineDocumentRegistry(settingsDocument);
|
|
||||||
const cache = await open(path, settings);
|
|
||||||
const first = await cache.updateGlobal(settingsDocument, (current) => ({ theme: `${current?.theme ?? ""}a` }));
|
|
||||||
assert.equal(first.outcome, "updated");
|
|
||||||
assert.deepEqual(cache.getGlobal(settingsDocument), { theme: "a" });
|
|
||||||
assert.equal(readSingleFileStore(path).envelopes[0]!.key, CultCache.GLOBAL_KEY);
|
|
||||||
await rm(path);
|
|
||||||
|
|
||||||
const legacy = await open(path, defineDocumentRegistry(plainSettingsDocument));
|
|
||||||
await legacy.put(plainSettingsDocument, "old-settings", { theme: "x" });
|
|
||||||
const loaded = await open(path, settings);
|
|
||||||
let calls = 0;
|
|
||||||
await assert.rejects(() => loaded.updateGlobal(settingsDocument, (current) => (calls++, current)), /putGlobal to retire its legacy key/);
|
|
||||||
assert.equal(calls, 0);
|
|
||||||
// Every path to the write is refused, the global's own key included, and the legacy record survives.
|
|
||||||
const before = await readFile(path);
|
|
||||||
await assert.rejects(() => loaded.update(settingsDocument, CultCache.GLOBAL_KEY, () => ({ theme: "lost" })), /putGlobal to retire its legacy key/);
|
|
||||||
assert.deepEqual([...(await readFile(path))], [...before]);
|
|
||||||
assert.deepEqual(readSingleFileStore(path).envelopes.map((e) => e.key), ["old-settings"]);
|
|
||||||
await loaded.putGlobal(settingsDocument, { theme: "y" });
|
|
||||||
assert.equal((await loaded.updateGlobal(settingsDocument, (current) => ({ theme: `${current!.theme}z` }))).outcome, "updated");
|
|
||||||
assert.deepEqual(loaded.getGlobal(settingsDocument), { theme: "yz" });
|
|
||||||
await assert.rejects(() => cache.update(settingsDocument, "not-global", () => ({ theme: "q" })), /must use key/);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a legacy global that a pull loads while apply awaits is refused at the write, and its legacy record survives", async () => {
|
|
||||||
await withDirectory(async (path) => {
|
|
||||||
const settings = defineDocumentRegistry(settingsDocument);
|
|
||||||
const cache = await open(path, settings);
|
|
||||||
const legacy = await open(path, defineDocumentRegistry(plainSettingsDocument));
|
|
||||||
await assert.rejects(
|
|
||||||
() =>
|
|
||||||
cache.update(settingsDocument, CultCache.GLOBAL_KEY, async () => {
|
|
||||||
await legacy.put(plainSettingsDocument, "old-settings", { theme: "x" });
|
|
||||||
await cache.pullAllBackingStores();
|
|
||||||
return { theme: "lost" };
|
|
||||||
}),
|
|
||||||
/putGlobal to retire its legacy key/,
|
|
||||||
);
|
|
||||||
assert.deepEqual(readSingleFileStore(path).envelopes.map((e) => e.key), ["old-settings"]);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("the ledger holds under contention: the stored value is the number of updated outcomes", async () => {
|
|
||||||
await withDirectory(async (path) => {
|
|
||||||
const caches = await Promise.all([open(path), open(path), open(path)]);
|
|
||||||
const results = await Promise.all(
|
|
||||||
caches.map(async (cache) => {
|
|
||||||
let updated = 0;
|
|
||||||
for (let i = 0; i < 25; i++) {
|
|
||||||
const result = await cache.update(counterDocument, KEY, async (current) => {
|
|
||||||
await tick();
|
|
||||||
return { value: (current?.value ?? 0) + 1 };
|
|
||||||
});
|
|
||||||
if (result.outcome === "updated") updated++;
|
|
||||||
}
|
|
||||||
return updated;
|
|
||||||
}),
|
|
||||||
);
|
|
||||||
assert.equal(stored(path), results.reduce((sum, n) => sum + n, 0));
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a flush of an unchanged cache rewrites the file byte for byte, and an update does not lose a race to it", async () => {
|
|
||||||
await withDirectory(async (path) => {
|
|
||||||
const cache = await open(path);
|
|
||||||
await cache.put(counterDocument, KEY, { value: 1 });
|
|
||||||
await cache.put(counterDocument, "other", { value: 7 });
|
|
||||||
const store = new SingleFileMessagePackBackingStore(path);
|
|
||||||
const before = await readFile(path);
|
|
||||||
// What CultMesh.flush does: push the whole stored image, twice.
|
|
||||||
await store.pushAll(await store.pullAll());
|
|
||||||
await store.pushAll(await store.pullAll());
|
|
||||||
assert.deepEqual(await readFile(path), before);
|
|
||||||
const result = await cache.update(counterDocument, KEY, async (current) => {
|
|
||||||
await store.pushAll(await store.pullAll());
|
|
||||||
return { value: current!.value + 1 };
|
|
||||||
}, { maxAttempts: 1 });
|
|
||||||
assert.equal(result.outcome, "updated");
|
|
||||||
assert.equal(stored(path), 2);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a changed record is re-stamped later than the one it replaces, and a revert to earlier bytes too", async () => {
|
|
||||||
await withDirectory(async (path) => {
|
|
||||||
const store = new SingleFileMessagePackBackingStore(path);
|
|
||||||
const cache = await open(path);
|
|
||||||
await cache.put(counterDocument, KEY, { value: 1 });
|
|
||||||
const first = readSingleFileStore(path).envelopes[0]!;
|
|
||||||
const same = await store.push({ ...first, storedAt: "2099-01-01T00:00:00.000Z" });
|
|
||||||
assert.equal(same.storedAt, first.storedAt, "identical content keeps its stamp");
|
|
||||||
await cache.put(counterDocument, KEY, { value: 2 });
|
|
||||||
const second = readSingleFileStore(path).envelopes[0]!;
|
|
||||||
const reverted = await store.push({ ...first, storedAt: second.storedAt });
|
|
||||||
assert.ok(Date.parse(reverted.storedAt) > Date.parse(second.storedAt));
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a push result that is not a parseable stamp is ignored", async () => {
|
|
||||||
for (const result of [true, {}, "", "garbage", { storedAt: "" }, { storedAt: "garbage" }]) {
|
|
||||||
const entries: Parameters<typeof memoryStore>[0] = [];
|
|
||||||
const store = { ...memoryStore(entries), push: async (entry: (typeof entries)[number]) => { entries.push(entry); return result as never; } };
|
|
||||||
const cache = CultCache.builder().withRegistry(registry).withGenericStore(store).build();
|
|
||||||
await cache.put(counterDocument, KEY, { value: 1 });
|
|
||||||
const held = cache.getEnvelope(counterDocument, KEY)!.storedAt;
|
|
||||||
assert.equal(Number.isNaN(Date.parse(held)), false, `held stamp ${held} after a push result of ${JSON.stringify(result)}`);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a rewrite of identical content keeps the stamp but writes the writer's type and catalog entry", async () => {
|
|
||||||
await withDirectory(async (path) => {
|
|
||||||
const old = defineDocumentType({ type: "update.rn.old", schemaId: "update.rn.v1", schemaName: "update.rn.old", schemaVersion: "update.rn.v1", schema: z.object({ value: z.number().int() }) });
|
|
||||||
const renamed = defineDocumentType({ type: "update.rn.new", schemaId: "update.rn.v1", schemaName: "update.rn.new", schemaVersion: "update.rn.v1", schema: z.object({ value: z.number().int() }) });
|
|
||||||
await (await open(path, defineDocumentRegistry(old))).put(old, KEY, { value: 1 });
|
|
||||||
const before = readSingleFileStore(path).envelopes[0]!;
|
|
||||||
await (await open(path, defineDocumentRegistry(renamed))).put(renamed, KEY, { value: 1 });
|
|
||||||
const after = readSingleFileStore(path).envelopes[0]!;
|
|
||||||
assert.equal(after.storedAt, before.storedAt, "identical content keeps its stamp");
|
|
||||||
assert.equal(after.type, "update.rn.new", "the writer's type is what the file says");
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a rewrite of the same bytes under another schema id is a changed record: stamped later, written under the new id", async () => {
|
|
||||||
await withDirectory(async (path) => {
|
|
||||||
const v1 = defineDocumentType({ type: "update.sid", schemaId: "update.sid.v1", schemaName: "update.sid", schemaVersion: "update.sid.v1", schema: z.object({ value: z.number().int() }) });
|
|
||||||
const v2 = defineDocumentType({ type: "update.sid", schemaId: "update.sid.v2", schemaName: "update.sid", schemaVersion: "update.sid.v2", compatibleSchemaIds: ["update.sid.v1"], schema: z.object({ value: z.number().int() }) });
|
|
||||||
await (await open(path, defineDocumentRegistry(v1))).put(v1, KEY, { value: 1 });
|
|
||||||
const before = readSingleFileStore(path).envelopes[0]!;
|
|
||||||
await (await open(path, defineDocumentRegistry(v2))).put(v2, KEY, { value: 1 });
|
|
||||||
const after = readSingleFileStore(path).envelopes[0]!;
|
|
||||||
assert.ok(Date.parse(after.storedAt) > Date.parse(before.storedAt));
|
|
||||||
assert.equal(schemaIdForEnvelope(after), "update.sid.v2");
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
@ -147,8 +147,8 @@ CultMath names with tests instead of copied project-local helper drift.
|
||||||
```powershell
|
```powershell
|
||||||
dotnet build packages/cultmath/src/CultMath/CultMath.csproj
|
dotnet build packages/cultmath/src/CultMath/CultMath.csproj
|
||||||
dotnet test packages/cultmath/tests/CultMath.Tests/CultMath.Tests.csproj
|
dotnet test packages/cultmath/tests/CultMath.Tests/CultMath.Tests.csproj
|
||||||
cargo test --locked --manifest-path packages/cultmath/native/cultmath-core/Cargo.toml
|
cargo test --manifest-path packages/cultmath/native/cultmath-core/Cargo.toml
|
||||||
cargo build --locked --release --manifest-path packages/cultmath/native/cultmath-core/Cargo.toml
|
cargo build --release --manifest-path packages/cultmath/native/cultmath-core/Cargo.toml
|
||||||
.\packages\cultmath\scripts\build-unity-package.ps1
|
.\packages\cultmath\scripts\build-unity-package.ps1
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -9,10 +9,6 @@ All notable changes to `@gamecult/cultmesh-browser` are recorded here, following
|
||||||
|
|
||||||
- The package is renamed `cultmesh-browser` to `@gamecult/cultmesh-browser` (the repo already scopes `@gamecult/cultcache-ts`), so the unscoped name cannot be claimed by someone else. Import from `@gamecult/cultmesh-browser` and its subpaths; the API is unchanged. Depends on `@gamecult/cultnet-ts`; the interop test uses `@gamecult/cultmesh-ts`.
|
- The package is renamed `cultmesh-browser` to `@gamecult/cultmesh-browser` (the repo already scopes `@gamecult/cultcache-ts`), so the unscoped name cannot be claimed by someone else. Import from `@gamecult/cultmesh-browser` and its subpaths; the API is unchanged. Depends on `@gamecult/cultnet-ts`; the interop test uses `@gamecult/cultmesh-ts`.
|
||||||
|
|
||||||
### Dependencies
|
|
||||||
|
|
||||||
- Needs `@gamecult/cultnet-ts` `^0.4.0` (was `^0.3.0`), moving with the `cultnet-ts` 0.4.0 release.
|
|
||||||
|
|
||||||
## [0.4.0]
|
## [0.4.0]
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
|
||||||
|
|
@ -41,8 +41,8 @@
|
||||||
"node": ">=20"
|
"node": ">=20"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@gamecult/cultcache-ts": "^0.16.0",
|
"@gamecult/cultcache-ts": "^0.15.0",
|
||||||
"@gamecult/cultnet-ts": "^0.4.0"
|
"@gamecult/cultnet-ts": "^0.3.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/node": "^24.0.0",
|
"@types/node": "^24.0.0",
|
||||||
|
|
|
||||||
|
|
@ -12,7 +12,6 @@ from typing import Any, Callable
|
||||||
from cultcache_py import CultCache, CultCacheEnvelope, SingleFileMessagePackBackingStore
|
from cultcache_py import CultCache, CultCacheEnvelope, SingleFileMessagePackBackingStore
|
||||||
from cultcache_py.cache import CultCacheError, index_text
|
from cultcache_py.cache import CultCacheError, index_text
|
||||||
from cultcache_py.documents import DocumentDefinition, extract_value
|
from cultcache_py.documents import DocumentDefinition, extract_value
|
||||||
from cultnet_py.replication import raw_record_to_envelope
|
|
||||||
from cultnet_py import (
|
from cultnet_py import (
|
||||||
CultNetAppliedRecord,
|
CultNetAppliedRecord,
|
||||||
CultNetFileShardMutationLogStore,
|
CultNetFileShardMutationLogStore,
|
||||||
|
|
@ -571,14 +570,12 @@ class CultMeshDatabase:
|
||||||
catalog_entry=catalog_entry,
|
catalog_entry=catalog_entry,
|
||||||
)
|
)
|
||||||
value = self.cache.put_envelope(registered, envelope)
|
value = self.cache.put_envelope(registered, envelope)
|
||||||
# The stamp the write was stored at, which a replacing write mints later than the record it replaces: the cache holds it.
|
|
||||||
stored_at = self.cache.get_required_envelope(registered, key).stored_at
|
|
||||||
self._publish_local_change(registered, key, "added" if previous is None else "updated", value, previous)
|
self._publish_local_change(registered, key, "added" if previous is None else "updated", value, previous)
|
||||||
message = document_put_raw(
|
message = document_put_raw(
|
||||||
message_id=message_id,
|
message_id=message_id,
|
||||||
key=key,
|
key=key,
|
||||||
schema_id=envelope.schema_id or catalog_entry.schema_id,
|
schema_id=envelope.schema_id or catalog_entry.schema_id,
|
||||||
stored_at=stored_at,
|
stored_at=envelope.stored_at,
|
||||||
payload=envelope.payload,
|
payload=envelope.payload,
|
||||||
source_runtime_id=self.runtime_id,
|
source_runtime_id=self.runtime_id,
|
||||||
shard_id=shard_id,
|
shard_id=shard_id,
|
||||||
|
|
@ -665,10 +662,10 @@ class CultMeshDatabase:
|
||||||
):
|
):
|
||||||
return None
|
return None
|
||||||
try:
|
try:
|
||||||
document = self._raw_put_document(message)
|
prepared = self._raw_put_envelope(message)
|
||||||
except Exception: # noqa: BLE001 - any other malformed shape
|
except Exception: # noqa: BLE001 - any other malformed shape
|
||||||
return None
|
return None
|
||||||
return None if document is None else (document.catalog_entry().schema_id, document_record["recordKey"])
|
return None if prepared is None else (prepared[0].catalog_entry().schema_id, prepared[1].key)
|
||||||
|
|
||||||
def raw_delete_target(self, message: dict[str, Any]) -> tuple[str, str] | None:
|
def raw_delete_target(self, message: dict[str, Any]) -> tuple[str, str] | None:
|
||||||
"""The canonical schema id and record key a raw delete names, or None when its schema is not registered."""
|
"""The canonical schema id and record key a raw delete names, or None when its schema is not registered."""
|
||||||
|
|
@ -686,11 +683,10 @@ class CultMeshDatabase:
|
||||||
value = self.cache.put_envelope(document, envelope)
|
value = self.cache.put_envelope(document, envelope)
|
||||||
change_kind = "added" if previous is None else "updated"
|
change_kind = "added" if previous is None else "updated"
|
||||||
change = self._publish_local_change(document, record_key, change_kind, value, previous)
|
change = self._publish_local_change(document, record_key, change_kind, value, previous)
|
||||||
# The log carries the stamp the cache holds, which a replacing put mints later than the record it replaces, not the peer's.
|
self._append_shard_log_put(CultNetMessage(
|
||||||
stored_at = self.cache.get_required_envelope(document, record_key).stored_at
|
"cultnet.document_put_raw.v0",
|
||||||
logged = {key: value for key, value in message.items() if key != "schemaVersion"}
|
{key: value for key, value in message.items() if key != "schemaVersion"},
|
||||||
logged["document"] = {**message["document"], "storedAt": stored_at}
|
), change_kind)
|
||||||
self._append_shard_log_put(CultNetMessage("cultnet.document_put_raw.v0", logged), change_kind)
|
|
||||||
return change
|
return change
|
||||||
|
|
||||||
def raw_put_served_alone(self, message: dict[str, Any], *, message_id: str) -> dict[str, Any] | None:
|
def raw_put_served_alone(self, message: dict[str, Any], *, message_id: str) -> dict[str, Any] | None:
|
||||||
|
|
@ -707,25 +703,27 @@ class CultMeshDatabase:
|
||||||
documents=(self._served_record(prepared[1]),),
|
documents=(self._served_record(prepared[1]),),
|
||||||
).to_wire()
|
).to_wire()
|
||||||
|
|
||||||
def _raw_put_document(self, message: dict[str, Any]) -> DocumentDefinition[Any] | None:
|
def _raw_put_envelope(
|
||||||
"""The registered document a raw put names, or None when its record is not a map or its schema is not registered."""
|
self, message: dict[str, Any]
|
||||||
|
) -> tuple[DocumentDefinition[Any], CultCacheEnvelope] | None:
|
||||||
document_record = message.get("document")
|
document_record = message.get("document")
|
||||||
if not isinstance(document_record, dict):
|
if not isinstance(document_record, dict):
|
||||||
return None
|
return None
|
||||||
schema_id = str(document_record.get("schemaId") or "")
|
schema_id = str(document_record.get("schemaId") or "")
|
||||||
|
documents_by_schema_id = schema_document_map(self.documents)
|
||||||
try:
|
try:
|
||||||
return resolve_document_for_raw_record(schema_document_map(self.documents), schema_id, document_record)
|
document = resolve_document_for_raw_record(documents_by_schema_id, schema_id, document_record)
|
||||||
except KeyError:
|
except KeyError:
|
||||||
return None
|
return None
|
||||||
|
# One id: the local schema id, under which the cache stores the record.
|
||||||
def _raw_put_envelope(
|
return document, CultCacheEnvelope(
|
||||||
self, message: dict[str, Any]
|
key=str(document_record["recordKey"]),
|
||||||
) -> tuple[DocumentDefinition[Any], CultCacheEnvelope] | None:
|
type=document.type,
|
||||||
document = self._raw_put_document(message)
|
schema_id=document.catalog_entry().schema_id,
|
||||||
if document is None:
|
payload=bytes(document_record["payload"]),
|
||||||
return None
|
stored_at=str(document_record.get("storedAt") or ""),
|
||||||
# One id: the local schema id, under which the cache stores the record. The stamp is judged where a record becomes an envelope.
|
catalog_entry=document.catalog_entry(),
|
||||||
return document, raw_record_to_envelope(document, document.catalog_entry().schema_id, message["document"])
|
)
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
def _served_record(envelope: CultCacheEnvelope) -> CultNetRawDocumentRecord:
|
def _served_record(envelope: CultCacheEnvelope) -> CultNetRawDocumentRecord:
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,6 @@ from typing import Any
|
||||||
|
|
||||||
import msgpack
|
import msgpack
|
||||||
|
|
||||||
from cultcache_py.stores import parse_stored_at
|
|
||||||
from cultnet_py import (
|
from cultnet_py import (
|
||||||
error_message,
|
error_message,
|
||||||
message_invalid_error,
|
message_invalid_error,
|
||||||
|
|
@ -687,11 +686,9 @@ class CultMeshLocalServer:
|
||||||
message_id=str(message.get("messageId") or ""),
|
message_id=str(message.get("messageId") or ""),
|
||||||
code="unregistered_document_put",
|
code="unregistered_document_put",
|
||||||
)]
|
)]
|
||||||
# Subscribers are sent the stamp the store holds, which a replacing put mints later than the record it replaces, not the peer's.
|
|
||||||
stored = self.node.database.cache.get_required_envelope(change.document, change.record_key).stored_at
|
|
||||||
return self._database_change_notifications(
|
return self._database_change_notifications(
|
||||||
message,
|
message,
|
||||||
{**document_record, "storedAt": stored},
|
document_record,
|
||||||
change.change_kind,
|
change.change_kind,
|
||||||
subscriptions,
|
subscriptions,
|
||||||
resolved_schema_id=change.schema_id,
|
resolved_schema_id=change.schema_id,
|
||||||
|
|
@ -970,7 +967,7 @@ class CultMeshLocalServer:
|
||||||
as a snapshot would serve it under the shortest message id, must fit max_snapshot_bytes;
|
as a snapshot would serve it under the shortest message id, must fit max_snapshot_bytes;
|
||||||
a put arriving over RUDP must also fit, as fragments of rudp_max_fragment_bytes, in one
|
a put arriving over RUDP must also fit, as fragments of rudp_max_fragment_bytes, in one
|
||||||
message and the peer's reliable queue. A put whose document has no string recordKey or
|
message and the peer's reliable queue. A put whose document has no string recordKey or
|
||||||
binary payload, or a storedAt that is no stamp, could never be stored or served, and is refused as malformed."""
|
binary payload could never be stored or served, and is refused as malformed."""
|
||||||
document_record = message.get("document")
|
document_record = message.get("document")
|
||||||
if not (
|
if not (
|
||||||
isinstance(document_record, dict)
|
isinstance(document_record, dict)
|
||||||
|
|
@ -978,8 +975,6 @@ class CultMeshLocalServer:
|
||||||
and isinstance(document_record.get("payload"), (bytes, bytearray))
|
and isinstance(document_record.get("payload"), (bytes, bytearray))
|
||||||
):
|
):
|
||||||
return self._message_invalid(message, "document", "Raw put documents must carry a string recordKey and a binary payload.")
|
return self._message_invalid(message, "document", "Raw put documents must carry a string recordKey and a binary payload.")
|
||||||
if parse_stored_at(document_record.get("storedAt")) is None:
|
|
||||||
return self._message_invalid(message, "document", "Raw put documents must carry a storedAt stamp.")
|
|
||||||
if self.max_snapshot_bytes is None and not over_rudp:
|
if self.max_snapshot_bytes is None and not over_rudp:
|
||||||
return None
|
return None
|
||||||
alone = self.node.database.raw_put_served_alone(message, message_id=_SHORTEST_SERVED_MESSAGE_ID)
|
alone = self.node.database.raw_put_served_alone(message, message_id=_SHORTEST_SERVED_MESSAGE_ID)
|
||||||
|
|
|
||||||
|
|
@ -19,7 +19,6 @@ from typing import Any, Callable
|
||||||
import msgpack
|
import msgpack
|
||||||
from cultcache_py import (
|
from cultcache_py import (
|
||||||
CultCache,
|
CultCache,
|
||||||
CultCacheEnvelope,
|
|
||||||
SingleFileMessagePackBackingStore,
|
SingleFileMessagePackBackingStore,
|
||||||
define_database_entry_type,
|
define_database_entry_type,
|
||||||
define_document_type,
|
define_document_type,
|
||||||
|
|
@ -797,51 +796,6 @@ class CultMeshTests(unittest.TestCase):
|
||||||
self.assertEqual(node.get_required(document, "note:second").body, "second catalog publication")
|
self.assertEqual(node.get_required(document, "note:second").body, "second catalog publication")
|
||||||
self.assertIsInstance(node.get_required(alias, "note:second"), UiNote)
|
self.assertIsInstance(node.get_required(alias, "note:second"), UiNote)
|
||||||
|
|
||||||
def test_raw_put_publishes_and_logs_the_stamp_the_store_wrote(self) -> None:
|
|
||||||
document = define_database_entry_type("mesh.stamp_item", [("name", 0), ("category", 1), ("value", 2, 0)], cls=Item)
|
|
||||||
node = create_node(runtime_id="python-node")
|
|
||||||
node.register_document(document)
|
|
||||||
cache = node.database.cache
|
|
||||||
entry = document.catalog_entry()
|
|
||||||
future = "2099-01-01T00:00:00.000000+00:00"
|
|
||||||
cache.put_envelope(
|
|
||||||
document,
|
|
||||||
CultCacheEnvelope(
|
|
||||||
key="item:stamp",
|
|
||||||
type=document.type,
|
|
||||||
payload=document.encode_payload(Item("old", "gear", 1)),
|
|
||||||
stored_at=future,
|
|
||||||
schema_id=entry.schema_id,
|
|
||||||
catalog_entry=entry,
|
|
||||||
),
|
|
||||||
)
|
|
||||||
# A replacing write is stored later than the record it replaces, so the stamp is not the one the write was created with.
|
|
||||||
wire = node.put_raw_message(document, "item:stamp", Item("new", "gear", 2), shard_id="mesh", shard_epoch=1).to_wire()
|
|
||||||
held = cache.get_required_envelope(document, "item:stamp").stored_at
|
|
||||||
self.assertGreater(held, future)
|
|
||||||
self.assertEqual(wire["document"]["storedAt"], held)
|
|
||||||
self.assertEqual(node.database._shard_logs["mesh"][-1]["put"]["document"]["storedAt"], held)
|
|
||||||
|
|
||||||
def test_applied_raw_put_logs_the_stamp_the_cache_holds(self) -> None:
|
|
||||||
document = define_database_entry_type("mesh.applied_stamp", [("name", 0), ("category", 1), ("value", 2, 0)], cls=Item)
|
|
||||||
node = create_node(runtime_id="python-node")
|
|
||||||
node.register_document(document)
|
|
||||||
cache = node.database.cache
|
|
||||||
entry = document.catalog_entry()
|
|
||||||
|
|
||||||
def envelope(value: int, stored_at: str) -> CultCacheEnvelope:
|
|
||||||
return CultCacheEnvelope("item:applied", document.type, document.encode_payload(Item("n", "gear", value)), stored_at, entry.schema_id, entry)
|
|
||||||
|
|
||||||
cache.put_envelope(document, envelope(1, "2099-01-01T00:00:00.000000+00:00"))
|
|
||||||
peer = node.put_raw_message(document, "item:peer", Item("peer", "gear", 2)).to_wire() # a well-formed put to replay
|
|
||||||
peer["document"] = {**peer["document"], "recordKey": "item:applied", "storedAt": "2000-01-01T00:00:00Z",
|
|
||||||
"payload": envelope(2, "x").payload}
|
|
||||||
peer["shardId"], peer["shardEpoch"] = "mesh", 1
|
|
||||||
node.database.apply_raw_put_message(peer)
|
|
||||||
held = cache.get_required_envelope(document, "item:applied").stored_at
|
|
||||||
self.assertGreater(held, "2099-01-01T00:00:00.000000+00:00")
|
|
||||||
self.assertEqual(node.database._shard_logs["mesh"][-1]["put"]["document"]["storedAt"], held)
|
|
||||||
|
|
||||||
def test_cultmesh_node_emits_raw_put_and_delete_messages_for_local_writes(self) -> None:
|
def test_cultmesh_node_emits_raw_put_and_delete_messages_for_local_writes(self) -> None:
|
||||||
document = define_database_entry_type(
|
document = define_database_entry_type(
|
||||||
"mesh.emit_item",
|
"mesh.emit_item",
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,6 @@ the peer the connection loop would pass, and one test drives the same path over
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import json
|
import json
|
||||||
import tempfile
|
|
||||||
import unittest
|
import unittest
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
@ -24,7 +23,7 @@ from cultmesh_py import (
|
||||||
CultMeshServerPeer,
|
CultMeshServerPeer,
|
||||||
create_node,
|
create_node,
|
||||||
)
|
)
|
||||||
from cultmesh_py.server import CultMeshLocalServer, _DatabaseSubscription
|
from cultmesh_py.server import CultMeshLocalServer
|
||||||
from cultnet_py import CultNetPeerError, create_rudp_schema_transport, document_delete, document_put_raw, error_message
|
from cultnet_py import CultNetPeerError, create_rudp_schema_transport, document_delete, document_put_raw, error_message
|
||||||
|
|
||||||
SCHEMA_ID = "sha256:authority-note"
|
SCHEMA_ID = "sha256:authority-note"
|
||||||
|
|
@ -56,12 +55,12 @@ class Recording:
|
||||||
return self._decide(request)
|
return self._decide(request)
|
||||||
|
|
||||||
|
|
||||||
def put_of(key: str, text: str, *, schema_id: str = SCHEMA_ID, stored_at: str = "2026-11-07T00:00:00Z") -> dict[str, Any]:
|
def put_of(key: str, text: str, *, schema_id: str = SCHEMA_ID) -> dict[str, Any]:
|
||||||
return document_put_raw(
|
return document_put_raw(
|
||||||
message_id="wire",
|
message_id="wire",
|
||||||
key=key,
|
key=key,
|
||||||
schema_id=schema_id,
|
schema_id=schema_id,
|
||||||
stored_at=stored_at,
|
stored_at="2026-11-07T00:00:00Z",
|
||||||
payload=NOTE.encode_payload({"schema_version": "tests.authority_note.v1", "text": text}),
|
payload=NOTE.encode_payload({"schema_version": "tests.authority_note.v1", "text": text}),
|
||||||
shard_id=SHARD_ID,
|
shard_id=SHARD_ID,
|
||||||
shard_epoch=1,
|
shard_epoch=1,
|
||||||
|
|
@ -74,64 +73,6 @@ def delete_of(key: str, *, schema_id: str = SCHEMA_ID) -> dict[str, Any]:
|
||||||
).to_wire()
|
).to_wire()
|
||||||
|
|
||||||
|
|
||||||
class NotificationStampTests(unittest.TestCase):
|
|
||||||
"""A subscriber is sent the stamp the store holds after a peer's put, as the shard log is, not the peer's stamp."""
|
|
||||||
|
|
||||||
def test_the_notification_carries_the_stamp_the_cache_holds(self) -> None:
|
|
||||||
local, peer_stamp = "2099-01-01T00:00:00.000000+00:00", "2000-01-01T00:00:00Z"
|
|
||||||
with tempfile.TemporaryDirectory() as directory:
|
|
||||||
for backing in (None, Path(directory) / "node.cc"): # store-less, then store-backed
|
|
||||||
with self.subTest(store=backing is not None):
|
|
||||||
node = create_node(backing, runtime_id="stamp-server")
|
|
||||||
node.database.register_document(NOTE)
|
|
||||||
server = CultMeshLocalServer(node=node, port=0, write_authority=CultMeshGrantAllWrites())
|
|
||||||
node.database.apply_raw_put_message(put_of(KEY_A, "server", stored_at=local))
|
|
||||||
subscriptions = {"s": _DatabaseSubscription("s", set(), set())}
|
|
||||||
replies = server._handle_connection_message(put_of(KEY_A, "peer", stored_at=peer_stamp), subscriptions, peer=PEER)
|
|
||||||
held = node.cache.get_required_envelope(NOTE, KEY_A).stored_at
|
|
||||||
self.assertGreater(held, local)
|
|
||||||
self.assertEqual([reply["document"]["storedAt"] for reply in replies], [held])
|
|
||||||
self.assertEqual(node.database._shard_logs[SHARD_ID][-1]["put"]["document"]["storedAt"], held)
|
|
||||||
|
|
||||||
|
|
||||||
class StamplessPutTests(unittest.TestCase):
|
|
||||||
"""A peer's put with no storedAt, or one that is no stamp, is refused message_invalid; nothing is minted or stored."""
|
|
||||||
|
|
||||||
def test_a_put_without_a_stamp_is_refused_and_the_store_stays_writable(self) -> None:
|
|
||||||
with tempfile.TemporaryDirectory() as directory:
|
|
||||||
node = create_node(Path(directory) / "node.cc", runtime_id="stampless-server")
|
|
||||||
node.database.register_document(NOTE)
|
|
||||||
server = CultMeshLocalServer(node=node, port=0, write_authority=CultMeshGrantAllWrites())
|
|
||||||
sized = CultMeshLocalServer(node=node, port=0, write_authority=CultMeshGrantAllWrites(), max_snapshot_bytes=10**6)
|
|
||||||
rudp = CultMeshLocalServer(node=node, port=0, write_authority=CultMeshGrantAllWrites())
|
|
||||||
for label, stamp in (("missing", None), ("empty", ""), ("garbage", "yesterday"), ("no zone", "2026-11-07T00:00:00")):
|
|
||||||
with self.subTest(label):
|
|
||||||
message = put_of(KEY_A, "peer")
|
|
||||||
del message["document"]["storedAt"]
|
|
||||||
if stamp is not None:
|
|
||||||
message["document"]["storedAt"] = stamp
|
|
||||||
# The size-limited and RUDP paths measure the document as a snapshot would serve it, so they must refuse first.
|
|
||||||
for limited in (server, sized, rudp):
|
|
||||||
[refusal] = limited._handle_connection_message(message, {}, over_rudp=limited is rudp, peer=PEER)
|
|
||||||
self.assertEqual(refusal["code"], "message_invalid")
|
|
||||||
self.assertEqual(refusal["details"]["field"], "document")
|
|
||||||
with self.assertRaises(ValueError):
|
|
||||||
node.database.apply_raw_put_message(message)
|
|
||||||
self.assertIsNone(node.cache.get(NOTE, KEY_A))
|
|
||||||
self.assertNotIn(SHARD_ID, node.database._shard_logs)
|
|
||||||
# An aliased put with a bad stamp still asks the authority about the canonical id, and is refused before the stamp is judged.
|
|
||||||
authority = Recording(lambda request: CultMeshRemoteWriteDecision.refuse("no"))
|
|
||||||
guarded = CultMeshLocalServer(node=node, port=0, write_authority=authority)
|
|
||||||
aliased = put_of(KEY_A, "peer", schema_id=ALIAS, stored_at="yesterday")
|
|
||||||
[refusal] = guarded._handle_connection_message(aliased, {}, peer=PEER)
|
|
||||||
self.assertEqual(refusal["code"], "write_not_authorized")
|
|
||||||
self.assertEqual(authority.requests[0].schema_id, SCHEMA_ID)
|
|
||||||
# The refused puts left the file readable: the next put of any key is stored.
|
|
||||||
replies = server._handle_connection_message(put_of(KEY_B, "stamped"), {}, peer=PEER)
|
|
||||||
self.assertEqual(replies, [])
|
|
||||||
self.assertEqual(node.cache.get(NOTE, KEY_B)["text"], "stamped")
|
|
||||||
|
|
||||||
|
|
||||||
class RemoteWriteAuthorityTests(unittest.TestCase):
|
class RemoteWriteAuthorityTests(unittest.TestCase):
|
||||||
def build(self, authority: Any = None) -> CultMeshLocalServer:
|
def build(self, authority: Any = None) -> CultMeshLocalServer:
|
||||||
node = create_node(runtime_id="authority-server")
|
node = create_node(runtime_id="authority-server")
|
||||||
|
|
@ -239,21 +180,6 @@ class RemoteWriteAuthorityTests(unittest.TestCase):
|
||||||
reply = self.send(granting, unowned)
|
reply = self.send(granting, unowned)
|
||||||
self.assertEqual(reply[0]["code"], "unregistered_document_put", "a granted put still meets the store's refusal")
|
self.assertEqual(reply[0]["code"], "unregistered_document_put", "a granted put still meets the store's refusal")
|
||||||
|
|
||||||
def test_a_put_with_a_payload_tail_and_an_unknown_schema_id_is_refused_whole_under_the_canonical_id(self) -> None:
|
|
||||||
# The payload head names the registered schema, so the put routes by stamp; the tail makes the payload more
|
|
||||||
# than one MessagePack value. It is answered message_invalid (not unregistered_document_put), nothing is
|
|
||||||
# stored, and the authority is asked under the canonical id, not the id as sent.
|
|
||||||
authority = Recording(lambda _: CultMeshRemoteWriteDecision.grant())
|
|
||||||
server = self.build(authority)
|
|
||||||
tailed = put_of(KEY_A, "x", schema_id="sha256:nobody-owns-this")
|
|
||||||
tailed["document"]["payload"] = bytes(tailed["document"]["payload"]) + b"\x01"
|
|
||||||
|
|
||||||
replies = self.send(server, tailed)
|
|
||||||
|
|
||||||
self.assertEqual([(reply["code"], reply["details"]["field"]) for reply in replies], [("message_invalid", "document")])
|
|
||||||
self.assertIsNone(self.text_of(server, KEY_A))
|
|
||||||
self.assertEqual([request.schema_id for request in authority.requests], [SCHEMA_ID])
|
|
||||||
|
|
||||||
def test_an_authority_that_raises_refuses_and_is_logged_as_an_error(self) -> None:
|
def test_an_authority_that_raises_refuses_and_is_logged_as_an_error(self) -> None:
|
||||||
def explode(_: Any) -> Any:
|
def explode(_: Any) -> Any:
|
||||||
raise RuntimeError("authority exploded")
|
raise RuntimeError("authority exploded")
|
||||||
|
|
|
||||||
|
|
@ -1,212 +0,0 @@
|
||||||
"""A record a peer replicates to this node is stored under the stamp it carries, so one with no stamp is refused where it becomes an envelope.
|
|
||||||
|
|
||||||
The stamp shape is tests/vectors/stored-at-stamp/stamps.msgpack, held to the same answers as the raw put of the server
|
|
||||||
(variants:ruling:raw-put-without-stamp-refused). A snapshot response is refused whole with ValueError before anything is stored (as a record of an unregistered schema is refused whole). A shard log is
|
|
||||||
refused whole too: every put it would apply is judged for its stamp before the first entry is stored (a put of an unregistered schema is skipped, as ever, and is not judged). The refusal of a put is
|
|
||||||
message_invalid (field `document`), tested in test_remote_write_authority.py.
|
|
||||||
"""
|
|
||||||
|
|
||||||
from __future__ import annotations
|
|
||||||
|
|
||||||
import tempfile
|
|
||||||
import unittest
|
|
||||||
from pathlib import Path
|
|
||||||
from typing import Any
|
|
||||||
|
|
||||||
import msgpack
|
|
||||||
from cultcache_py import define_database_entry_type
|
|
||||||
from cultcache_py.stores import parse_stored_at
|
|
||||||
from cultmesh_py import CultMeshGrantAllWrites, CultMeshServerPeer, create_node
|
|
||||||
from cultmesh_py.client import CultMeshDocumentSubscription
|
|
||||||
from cultmesh_py.server import CultMeshLocalServer
|
|
||||||
from cultnet_py import CultNetDatabaseChange, document_put_raw
|
|
||||||
|
|
||||||
SCHEMA_ID = "sha256:stampless-note"
|
|
||||||
SHARD_ID = "stampless-shard"
|
|
||||||
PEER = CultMeshServerPeer("127.0.0.1:50000", "tcp")
|
|
||||||
VECTOR = Path(__file__).resolve().parents[3] / "tests/vectors/stored-at-stamp/stamps.msgpack"
|
|
||||||
ROWS: list[tuple[str, bool]] = [(text, parses) for text, parses in msgpack.unpackb(VECTOR.read_bytes(), raw=False)]
|
|
||||||
# The vector's texts, plus the shapes a record can lack a stamp in: the field missing, and not a string at all.
|
|
||||||
REFUSED: list[tuple[str, Any]] = [(f"vector {text!r}", text) for text, parses in ROWS if not parses] + [
|
|
||||||
("missing", None),
|
|
||||||
("not a string", 12345),
|
|
||||||
]
|
|
||||||
|
|
||||||
NOTE = define_database_entry_type(
|
|
||||||
"tests.stampless_note",
|
|
||||||
[("schema_version", 0), ("text", 1)],
|
|
||||||
schema_id=SCHEMA_ID,
|
|
||||||
schema_name="tests.stampless_note",
|
|
||||||
schema_version="tests.stampless_note.v1",
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def record_of(key: str, text: str, stamp: Any = "2026-11-07T00:00:00Z") -> dict[str, Any]:
|
|
||||||
record = {
|
|
||||||
"schemaId": SCHEMA_ID,
|
|
||||||
"recordKey": key,
|
|
||||||
"payloadEncoding": "messagepack",
|
|
||||||
"payload": NOTE.encode_payload({"schema_version": "tests.stampless_note.v1", "text": text}),
|
|
||||||
}
|
|
||||||
if stamp is not None:
|
|
||||||
record["storedAt"] = stamp
|
|
||||||
return record
|
|
||||||
|
|
||||||
|
|
||||||
def snapshot_of(*records: dict[str, Any]) -> dict[str, Any]:
|
|
||||||
return {"schemaVersion": "cultnet.snapshot_response_raw.v0", "messageId": "snapshot", "documents": list(records)}
|
|
||||||
|
|
||||||
|
|
||||||
def shard_log_of(*records: dict[str, Any]) -> dict[str, Any]:
|
|
||||||
entries = [
|
|
||||||
{
|
|
||||||
"sequence": index + 1,
|
|
||||||
"committedAt": "2026-11-07T00:00:00Z",
|
|
||||||
"changeKind": "added",
|
|
||||||
"put": document_put_raw(
|
|
||||||
message_id=f"put-{index}", key=record["recordKey"], schema_id=SCHEMA_ID, stored_at="2026-11-07T00:00:00Z",
|
|
||||||
payload=record["payload"], shard_id=SHARD_ID, shard_epoch=1,
|
|
||||||
).to_wire() | {"document": record},
|
|
||||||
}
|
|
||||||
for index, record in enumerate(records)
|
|
||||||
]
|
|
||||||
return {
|
|
||||||
"schemaVersion": "cultnet.shard_log_response.v0", "messageId": "log", "shardId": SHARD_ID, "shardEpoch": 1,
|
|
||||||
"entries": entries, "resyncRequired": False,
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
class StampVectorTests(unittest.TestCase):
|
|
||||||
def test_python_parses_every_row_of_the_vector_as_the_vector_says(self) -> None:
|
|
||||||
self.assertGreater(len(ROWS), 30)
|
|
||||||
for text, parses in ROWS:
|
|
||||||
with self.subTest(text=text):
|
|
||||||
self.assertEqual(parse_stored_at(text) is not None, parses)
|
|
||||||
|
|
||||||
def test_every_vector_row_through_the_server_put_handler_is_stored_or_refused_as_the_vector_says(self) -> None:
|
|
||||||
with tempfile.TemporaryDirectory() as directory:
|
|
||||||
node = create_node(Path(directory) / "node.cc", runtime_id="vector-server")
|
|
||||||
node.database.register_document(NOTE)
|
|
||||||
server = CultMeshLocalServer(node=node, port=0, write_authority=CultMeshGrantAllWrites())
|
|
||||||
sized = CultMeshLocalServer(node=node, port=0, write_authority=CultMeshGrantAllWrites(), max_snapshot_bytes=10**6)
|
|
||||||
for index, (text, parses) in enumerate(ROWS):
|
|
||||||
for label, handler, over_rudp in (("plain", server, False), ("sized", sized, False), ("rudp", server, True)):
|
|
||||||
with self.subTest(text=text, path=label):
|
|
||||||
key = f"vector:{index}:{label}"
|
|
||||||
message = document_put_raw(
|
|
||||||
message_id="wire", key=key, schema_id=SCHEMA_ID, stored_at=text,
|
|
||||||
payload=record_of(key, "peer")["payload"], shard_id=SHARD_ID, shard_epoch=1,
|
|
||||||
).to_wire()
|
|
||||||
replies = handler._handle_connection_message(message, {}, over_rudp=over_rudp, peer=PEER)
|
|
||||||
if parses:
|
|
||||||
self.assertEqual(replies, [])
|
|
||||||
self.assertEqual(node.cache.get(NOTE, key)["text"], "peer")
|
|
||||||
else:
|
|
||||||
self.assertEqual([(r["code"], r["details"]["field"]) for r in replies], [("message_invalid", "document")])
|
|
||||||
self.assertIsNone(node.cache.get(NOTE, key))
|
|
||||||
|
|
||||||
|
|
||||||
class StamplessSnapshotTests(unittest.TestCase):
|
|
||||||
def build(self, directory: str) -> Any:
|
|
||||||
node = create_node(Path(directory) / "node.cc", runtime_id="stampless-client")
|
|
||||||
node.database.register_document(NOTE)
|
|
||||||
node.database.pull()
|
|
||||||
return node
|
|
||||||
|
|
||||||
def test_a_snapshot_with_a_stampless_record_is_refused_whole_and_the_store_survives_a_reopen(self) -> None:
|
|
||||||
for label, stamp in REFUSED:
|
|
||||||
with self.subTest(label), tempfile.TemporaryDirectory() as directory:
|
|
||||||
node = self.build(directory)
|
|
||||||
good, bad = record_of("note:good", "good"), record_of("note:bad", "bad", stamp)
|
|
||||||
for order in ((good, bad), (bad, good)):
|
|
||||||
with self.assertRaises(ValueError):
|
|
||||||
node.database.apply_snapshot_response(snapshot_of(*order))
|
|
||||||
self.assertIsNone(node.cache.get(NOTE, "note:good"), "a refused snapshot stores none of its records")
|
|
||||||
self.assertIsNone(node.cache.get(NOTE, "note:bad"))
|
|
||||||
# The store file reads back, and is still writable by a snapshot of stamped records.
|
|
||||||
reopened = self.build(directory)
|
|
||||||
self.assertIsNone(reopened.cache.get(NOTE, "note:bad"))
|
|
||||||
applied = reopened.database.apply_snapshot_response(snapshot_of(good))
|
|
||||||
self.assertEqual([a.record_key for a in applied], ["note:good"])
|
|
||||||
self.assertEqual(self.build(directory).cache.get(NOTE, "note:good")["text"], "good")
|
|
||||||
|
|
||||||
def test_a_snapshot_of_every_stamped_vector_row_is_stored(self) -> None:
|
|
||||||
with tempfile.TemporaryDirectory() as directory:
|
|
||||||
node = self.build(directory)
|
|
||||||
rows = [(index, text) for index, (text, parses) in enumerate(ROWS) if parses]
|
|
||||||
node.database.apply_snapshot_response(snapshot_of(*[record_of(f"stamped:{i}", "ok", text) for i, text in rows]))
|
|
||||||
self.assertEqual(len(self.build(directory).cache.get_all(NOTE)), len(rows))
|
|
||||||
for index, _ in rows:
|
|
||||||
self.assertEqual(node.cache.get(NOTE, f"stamped:{index}")["text"], "ok")
|
|
||||||
|
|
||||||
|
|
||||||
class StamplessShardLogTests(unittest.TestCase):
|
|
||||||
def test_a_shard_log_put_with_no_stamp_is_refused_and_the_store_stays_writable(self) -> None:
|
|
||||||
for label, stamp in REFUSED:
|
|
||||||
with self.subTest(label), tempfile.TemporaryDirectory() as directory:
|
|
||||||
node = create_node(Path(directory) / "node.cc", runtime_id="stampless-log")
|
|
||||||
node.database.register_document(NOTE)
|
|
||||||
with self.assertRaises(ValueError):
|
|
||||||
node.database.apply_shard_log_response(shard_log_of(record_of("note:bad", "bad", stamp)))
|
|
||||||
self.assertIsNone(node.cache.get(NOTE, "note:bad"))
|
|
||||||
reopened = create_node(Path(directory) / "node.cc", runtime_id="stampless-log")
|
|
||||||
reopened.database.register_document(NOTE)
|
|
||||||
reopened.database.pull()
|
|
||||||
reopened.database.apply_shard_log_response(shard_log_of(record_of("note:good", "good")))
|
|
||||||
self.assertEqual(reopened.cache.get(NOTE, "note:good")["text"], "good")
|
|
||||||
again = create_node(Path(directory) / "node.cc", runtime_id="stampless-log")
|
|
||||||
again.database.register_document(NOTE)
|
|
||||||
again.database.pull()
|
|
||||||
self.assertEqual(again.cache.get(NOTE, "note:good")["text"], "good")
|
|
||||||
|
|
||||||
|
|
||||||
def test_a_shard_log_with_a_bad_entry_in_the_middle_stores_nothing_and_tells_no_watcher(self) -> None:
|
|
||||||
for label, stamp in REFUSED:
|
|
||||||
with self.subTest(label), tempfile.TemporaryDirectory() as directory:
|
|
||||||
node = create_node(Path(directory) / "node.cc", runtime_id="stampless-multi")
|
|
||||||
node.database.register_document(NOTE)
|
|
||||||
seen: list[Any] = []
|
|
||||||
node.database.watch(seen.append)
|
|
||||||
log = shard_log_of(record_of("note:a", "a"), record_of("note:b", "b", stamp), record_of("note:c", "c"))
|
|
||||||
with self.assertRaises(ValueError):
|
|
||||||
node.database.apply_shard_log_response(log)
|
|
||||||
for key in ("note:a", "note:b", "note:c"):
|
|
||||||
self.assertIsNone(node.cache.get(NOTE, key), f"{key} was not stored")
|
|
||||||
self.assertEqual(seen, [], "no watcher heard of a refused log")
|
|
||||||
node.database.apply_shard_log_response(shard_log_of(record_of("note:a", "a"), record_of("note:c", "c")))
|
|
||||||
self.assertEqual([node.cache.get(NOTE, k)["text"] for k in ("note:a", "note:c")], ["a", "c"])
|
|
||||||
self.assertEqual(len(seen), 2, "a later good log applies and is heard")
|
|
||||||
|
|
||||||
|
|
||||||
class _StubSubscription:
|
|
||||||
def __init__(self, change: CultNetDatabaseChange) -> None:
|
|
||||||
self._change = change
|
|
||||||
|
|
||||||
def read_next_change(self) -> CultNetDatabaseChange:
|
|
||||||
return self._change
|
|
||||||
|
|
||||||
|
|
||||||
class StamplessClientReplayTests(unittest.TestCase):
|
|
||||||
def test_a_subscribed_put_with_no_stamp_is_refused_by_read_next_change_and_nothing_is_stored(self) -> None:
|
|
||||||
for label, stamp in REFUSED:
|
|
||||||
with self.subTest(label), tempfile.TemporaryDirectory() as directory:
|
|
||||||
node = create_node(Path(directory) / "node.cc", runtime_id="stampless-subscriber")
|
|
||||||
node.database.register_document(NOTE)
|
|
||||||
subscription = CultMeshDocumentSubscription(client=None, database=node.database, document=NOTE, key="note:bad") # type: ignore[arg-type]
|
|
||||||
|
|
||||||
def deliver(record: dict[str, Any]) -> Any:
|
|
||||||
message = {
|
|
||||||
"schemaVersion": "cultnet.database_change_raw.v0", "messageId": "change", "changeKind": "added",
|
|
||||||
"schemaId": SCHEMA_ID, "recordKey": record["recordKey"], "document": record,
|
|
||||||
}
|
|
||||||
subscription._subscription = _StubSubscription(CultNetDatabaseChange.from_wire(message)) # type: ignore[assignment]
|
|
||||||
return subscription.read_next_change()
|
|
||||||
|
|
||||||
with self.assertRaises(ValueError):
|
|
||||||
deliver(record_of("note:bad", "bad", stamp))
|
|
||||||
self.assertIsNone(node.cache.get(NOTE, "note:bad"))
|
|
||||||
self.assertEqual(deliver(record_of("note:bad", "stamped")).value["text"], "stamped")
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
unittest.main()
|
|
||||||
1
packages/cultmesh-rs/Cargo.lock
generated
1
packages/cultmesh-rs/Cargo.lock
generated
|
|
@ -213,7 +213,6 @@ dependencies = [
|
||||||
"serde_bytes",
|
"serde_bytes",
|
||||||
"serde_json",
|
"serde_json",
|
||||||
"serde_stacker",
|
"serde_stacker",
|
||||||
"sha2",
|
|
||||||
"stacker",
|
"stacker",
|
||||||
"uuid",
|
"uuid",
|
||||||
"windows-sys 0.59.0",
|
"windows-sys 0.59.0",
|
||||||
|
|
|
||||||
|
|
@ -732,37 +732,21 @@ impl CultMeshNode {
|
||||||
let cultnet_rs::CultNetMessage::SnapshotResponseRaw { documents, .. } = response else {
|
let cultnet_rs::CultNetMessage::SnapshotResponseRaw { documents, .. } = response else {
|
||||||
anyhow::bail!("expected cultnet.snapshot_response_raw.v0");
|
anyhow::bail!("expected cultnet.snapshot_response_raw.v0");
|
||||||
};
|
};
|
||||||
self.apply_raw_snapshot_documents(documents)
|
let mut applied = 0usize;
|
||||||
}
|
|
||||||
|
|
||||||
/// Applies the snapshot documents as one cache commit, as C# does: a refusal (a key this node holds read-only because
|
|
||||||
/// of unread slots from a newer peer or a payload this build cannot read, or any other the cache judges) applies
|
|
||||||
/// nothing. A schema id the registry does not know is skipped, except one with a `.vN` suffix, which is taken as
|
|
||||||
/// registered and refuses the commit when its type is not (C# throws on an unknown schema too). The commit lands in
|
|
||||||
/// one backing store, so a snapshot spanning stores is refused whole; C# `CultCache.Commit` refuses a cross-store batch too
|
|
||||||
/// ("The batch spans A and B; a commit lands in one home store"), so the two agree.
|
|
||||||
fn apply_raw_snapshot_documents(
|
|
||||||
&mut self,
|
|
||||||
documents: Vec<cultnet_rs::CultNetRawDocumentRecord>,
|
|
||||||
) -> Result<usize> {
|
|
||||||
let mut staged = Vec::new();
|
|
||||||
for document in documents {
|
for document in documents {
|
||||||
let Some(document_type) =
|
let Some(document_type) =
|
||||||
registered_document_type_for_schema(&self.documents, &document.schema_id)
|
registered_document_type_for_schema(&self.documents, &document.schema_id)
|
||||||
else {
|
else {
|
||||||
continue;
|
continue;
|
||||||
};
|
};
|
||||||
staged.push(CultCacheEnvelope {
|
self.cache.put_raw_envelope(CultCacheEnvelope {
|
||||||
key: document.record_key,
|
key: document.record_key,
|
||||||
r#type: document_type,
|
r#type: document_type,
|
||||||
payload: document.payload,
|
payload: document.payload,
|
||||||
stored_at: document.stored_at,
|
stored_at: document.stored_at,
|
||||||
schema_id: Some(document.schema_id),
|
schema_id: Some(document.schema_id),
|
||||||
});
|
})?;
|
||||||
}
|
applied += 1;
|
||||||
let applied = staged.len();
|
|
||||||
if applied > 0 {
|
|
||||||
self.cache.put_prepared_batch(staged)?;
|
|
||||||
}
|
}
|
||||||
Ok(applied)
|
Ok(applied)
|
||||||
}
|
}
|
||||||
|
|
@ -1211,135 +1195,10 @@ mod tests {
|
||||||
body: String,
|
body: String,
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Clone, Debug, PartialEq, Eq, cultcache_rs::DatabaseEntry)]
|
|
||||||
#[cultcache(type = "cultmesh.test.memo", schema = "CultMeshTestMemo")]
|
|
||||||
struct Memo {
|
|
||||||
#[cultcache(key = 0)]
|
|
||||||
body: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
cultmesh_documents!(TestDocuments {
|
cultmesh_documents!(TestDocuments {
|
||||||
Note => "cultmesh.test.note.v0",
|
Note => "cultmesh.test.note.v0",
|
||||||
});
|
});
|
||||||
|
|
||||||
cultmesh_documents!(TwoTypeDocuments {
|
|
||||||
Note => "cultmesh.test.note.v0",
|
|
||||||
Memo => "cultmesh.test.memo.v0",
|
|
||||||
});
|
|
||||||
|
|
||||||
fn raw_note(key: &str, payload: Vec<u8>) -> cultnet_rs::CultNetRawDocumentRecord {
|
|
||||||
cultnet_rs::CultNetRawDocumentRecord {
|
|
||||||
schema_id: "cultmesh.test.note.v0".to_string(),
|
|
||||||
record_key: key.to_string(),
|
|
||||||
stored_at: "2026-01-01T00:00:00Z".to_string(),
|
|
||||||
payload_encoding: cultnet_rs::CultNetRawPayloadEncoding::Messagepack,
|
|
||||||
payload,
|
|
||||||
source_runtime_id: None,
|
|
||||||
source_agent_id: None,
|
|
||||||
source_role: None,
|
|
||||||
tags: None,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn a_snapshot_document_for_a_read_only_key_refuses_the_whole_pull_as_csharp_does() -> Result<()> {
|
|
||||||
let temp = tempfile::tempdir()?;
|
|
||||||
let mut node = CultMesh::create_node(temp.path().join("m.cc"), TestDocuments, Default::default())?;
|
|
||||||
// A newer peer's note: one slot past the declared one.
|
|
||||||
let newer = rmp_serde::to_vec(&("newer body", "extra slot"))?;
|
|
||||||
let plain = |body: &str| rmp_serde::to_vec(&(body,));
|
|
||||||
assert_eq!(node.apply_raw_snapshot_documents(vec![raw_note("held", newer)])?, 1);
|
|
||||||
assert_eq!(node.get_required::<Note>("held")?.body, "newer body");
|
|
||||||
|
|
||||||
let error = node
|
|
||||||
.apply_raw_snapshot_documents(vec![
|
|
||||||
raw_note("before", plain("b")?),
|
|
||||||
raw_note("held", plain("overwrite")?),
|
|
||||||
raw_note("after", plain("a")?),
|
|
||||||
])
|
|
||||||
.unwrap_err();
|
|
||||||
let conflict = error.downcast_ref::<cultcache_rs::SchemaConflictError>().expect("typed refusal");
|
|
||||||
assert_eq!(conflict.record_key, "held");
|
|
||||||
assert!(conflict.unread_slots.is_some());
|
|
||||||
assert!(!error.to_string().contains("extra slot"));
|
|
||||||
assert!(node.get::<Note>("before")?.is_none());
|
|
||||||
assert_eq!(node.get_required::<Note>("held")?.body, "newer body");
|
|
||||||
assert!(node.get::<Note>("after")?.is_none());
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn a_snapshot_spanning_two_backing_stores_is_refused_whole_and_applies_nothing() -> Result<()> {
|
|
||||||
let temp = tempfile::tempdir()?;
|
|
||||||
let mut node = CultMesh::create_node(temp.path().join("m.cc"), TwoTypeDocuments, Default::default())?;
|
|
||||||
// A node has one store through the public API; route Memo to a second one by hand (C# refuses the same commit).
|
|
||||||
node.cache.add_backing_store(
|
|
||||||
SingleFileMessagePackBackingStore::new(temp.path().join("memo.cc")),
|
|
||||||
[Memo::TYPE],
|
|
||||||
)?;
|
|
||||||
node.cache.pull_all_backing_stores()?;
|
|
||||||
let plain = |body: &str| rmp_serde::to_vec(&(body,));
|
|
||||||
let memo = |key: &str, payload| {
|
|
||||||
let mut record = raw_note(key, payload);
|
|
||||||
record.schema_id = "cultmesh.test.memo.v0".to_string();
|
|
||||||
record
|
|
||||||
};
|
|
||||||
let error = node
|
|
||||||
.apply_raw_snapshot_documents(vec![
|
|
||||||
raw_note("n", plain("note")?),
|
|
||||||
memo("m", plain("memo")?),
|
|
||||||
])
|
|
||||||
.unwrap_err();
|
|
||||||
assert!(error.to_string().contains("cannot span backing stores"), "{error}");
|
|
||||||
assert!(node.get::<Note>("n")?.is_none());
|
|
||||||
assert!(node.get::<Memo>("m")?.is_none());
|
|
||||||
assert!(!temp.path().join("m.cc").exists() && !temp.path().join("memo.cc").exists());
|
|
||||||
|
|
||||||
// Each store alone still takes its own snapshot.
|
|
||||||
assert_eq!(node.apply_raw_snapshot_documents(vec![memo("m", plain("memo")?)])?, 1);
|
|
||||||
assert_eq!(node.get_required::<Memo>("m")?.body, "memo");
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
/// The node's store is the second owner of the stamp rule: a snapshot document whose `storedAt` is no stamp refuses
|
|
||||||
/// the whole pull, nothing is minted or stored, and the node stays writable.
|
|
||||||
#[test]
|
|
||||||
fn a_snapshot_document_whose_stored_at_is_no_stamp_refuses_the_pull_and_stores_nothing() -> Result<()> {
|
|
||||||
let temp = tempfile::tempdir()?;
|
|
||||||
let path = temp.path().join("m.cc");
|
|
||||||
let mut node = CultMesh::create_node(&path, TestDocuments, Default::default())?;
|
|
||||||
let plain = |body: &str| rmp_serde::to_vec(&(body,));
|
|
||||||
for bad in ["", "yesterday", "2026-01-01T00:00:00", "2026-01-01t00:00:00z", "2026-01-01T00:00:60Z"] {
|
|
||||||
let mut stampless = raw_note("bad", plain("bad")?);
|
|
||||||
stampless.stored_at = bad.to_string();
|
|
||||||
let error = node
|
|
||||||
.apply_raw_snapshot_documents(vec![raw_note("good", plain("good")?), stampless])
|
|
||||||
.unwrap_err();
|
|
||||||
assert!(format!("{error:#}").contains("stored_at"), "{bad:?}: {error:#}");
|
|
||||||
assert!(node.get::<Note>("good")?.is_none() && node.get::<Note>("bad")?.is_none(), "{bad:?}");
|
|
||||||
}
|
|
||||||
assert_eq!(node.apply_raw_snapshot_documents(vec![raw_note("after", plain("after")?)])?, 1);
|
|
||||||
let reopened = CultMesh::create_node(&path, TestDocuments, Default::default())?;
|
|
||||||
assert_eq!(reopened.get_required::<Note>("after")?.body, "after");
|
|
||||||
assert!(reopened.get::<Note>("good")?.is_none());
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn a_snapshot_applied_to_a_stale_node_keeps_the_records_another_writer_added() -> Result<()> {
|
|
||||||
let temp = tempfile::tempdir()?;
|
|
||||||
let path = temp.path().join("m.cc");
|
|
||||||
let mut node = CultMesh::create_node(&path, TestDocuments, Default::default())?;
|
|
||||||
let mut other = CultMesh::create_node(&path, TestDocuments, Default::default())?;
|
|
||||||
other.put("added", &Note { body: "other writer".to_string() })?;
|
|
||||||
let plain = |body: &str| rmp_serde::to_vec(&(body,));
|
|
||||||
assert_eq!(node.apply_raw_snapshot_documents(vec![raw_note("snap", plain("s")?)])?, 1);
|
|
||||||
let reopened = CultMesh::create_node(&path, TestDocuments, Default::default())?;
|
|
||||||
assert_eq!(reopened.get_required::<Note>("added")?.body, "other writer");
|
|
||||||
assert_eq!(reopened.get_required::<Note>("snap")?.body, "s");
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn node_round_trips_registered_documents() -> Result<()> {
|
fn node_round_trips_registered_documents() -> Result<()> {
|
||||||
let temp = tempfile::tempdir()?;
|
let temp = tempfile::tempdir()?;
|
||||||
|
|
|
||||||
|
|
@ -69,8 +69,7 @@ pub struct CultMeshRudpSnapshotQuery {
|
||||||
pub trait CultMeshRudpRawDocumentSink {
|
pub trait CultMeshRudpRawDocumentSink {
|
||||||
/// Whether this put may be written, decided without writing it. A receipt-capable session asks it only
|
/// Whether this put may be written, decided without writing it. A receipt-capable session asks it only
|
||||||
/// the first time it sees a message id; a resend is answered from what the session remembers
|
/// the first time it sees a message id; a resend is answered from what the session remembers
|
||||||
/// (write-receipt.md, rule 5). A legacy session asks it only for a put whose `storedAt` is no stamp, so the
|
/// (write-receipt.md, rule 5). The default admits everything and leaves the decision to
|
||||||
/// authority's refusal comes before the stamp's. The default admits everything and leaves the decision to
|
|
||||||
/// `accept_raw_document`.
|
/// `accept_raw_document`.
|
||||||
fn authorize_raw_document(&mut self, _receipt: &CultMeshRudpRawDocumentReceipt) -> Result<()> {
|
fn authorize_raw_document(&mut self, _receipt: &CultMeshRudpRawDocumentReceipt) -> Result<()> {
|
||||||
Ok(())
|
Ok(())
|
||||||
|
|
@ -294,9 +293,6 @@ pub enum CultMeshRudpRejectionReason {
|
||||||
DocumentMissing,
|
DocumentMissing,
|
||||||
/// A receipt-capable session's put or delete has a null or missing `schemaId`.
|
/// A receipt-capable session's put or delete has a null or missing `schemaId`.
|
||||||
SchemaIdMissing,
|
SchemaIdMissing,
|
||||||
/// A put's `storedAt` is not a stamp (`cultcache_rs::is_stored_at_stamp`). It is judged after the sink's
|
|
||||||
/// authorization and before the document is measured or the sink commits it: nothing is minted or stored.
|
|
||||||
StoredAtNotStamp,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl std::fmt::Display for CultMeshRudpRejectionReason {
|
impl std::fmt::Display for CultMeshRudpRejectionReason {
|
||||||
|
|
@ -311,7 +307,6 @@ impl std::fmt::Display for CultMeshRudpRejectionReason {
|
||||||
Self::ChannelNotReliable => f.write_str("a receipt session's write arrived on an unreliable channel"),
|
Self::ChannelNotReliable => f.write_str("a receipt session's write arrived on an unreliable channel"),
|
||||||
Self::DocumentMissing => f.write_str("the write has no document"),
|
Self::DocumentMissing => f.write_str("the write has no document"),
|
||||||
Self::SchemaIdMissing => f.write_str("the write has no schemaId"),
|
Self::SchemaIdMissing => f.write_str("the write has no schemaId"),
|
||||||
Self::StoredAtNotStamp => f.write_str("the document's storedAt is not a stamp"),
|
|
||||||
Self::DocumentUnservable {
|
Self::DocumentUnservable {
|
||||||
response_bytes,
|
response_bytes,
|
||||||
max_snapshot_response_bytes,
|
max_snapshot_response_bytes,
|
||||||
|
|
@ -352,7 +347,7 @@ impl std::fmt::Display for CultMeshRudpRejectionReason {
|
||||||
/// The texts a refused peer is sent, one per rejection variant. They are fixed:
|
/// The texts a refused peer is sent, one per rejection variant. They are fixed:
|
||||||
/// a sink's or source's error text can quote what a peer sent, so it stays with
|
/// a sink's or source's error text can quote what a peer sent, so it stays with
|
||||||
/// the caller that receives the rejection and never reaches the wire.
|
/// the caller that receives the rejection and never reaches the wire.
|
||||||
pub(crate) const REFUSAL_TEXTS: [&str; 18] = [
|
pub(crate) const REFUSAL_TEXTS: [&str; 17] = [
|
||||||
"the catalog refused the document",
|
"the catalog refused the document",
|
||||||
"the document can never be served",
|
"the document can never be served",
|
||||||
"the snapshot source failed",
|
"the snapshot source failed",
|
||||||
|
|
@ -370,7 +365,6 @@ pub(crate) const REFUSAL_TEXTS: [&str; 18] = [
|
||||||
"receipt sessions require the reliable channel",
|
"receipt sessions require the reliable channel",
|
||||||
"document is required",
|
"document is required",
|
||||||
"schemaId is required",
|
"schemaId is required",
|
||||||
"document must carry a storedAt stamp",
|
|
||||||
];
|
];
|
||||||
|
|
||||||
impl CultMeshRudpRejectionReason {
|
impl CultMeshRudpRejectionReason {
|
||||||
|
|
@ -399,8 +393,7 @@ impl CultMeshRudpRejectionReason {
|
||||||
13 => Self::MessageIdTooLong,
|
13 => Self::MessageIdTooLong,
|
||||||
14 => Self::ChannelNotReliable,
|
14 => Self::ChannelNotReliable,
|
||||||
15 => Self::DocumentMissing,
|
15 => Self::DocumentMissing,
|
||||||
16 => Self::SchemaIdMissing,
|
_ => Self::SchemaIdMissing,
|
||||||
_ => Self::StoredAtNotStamp,
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -423,7 +416,6 @@ impl CultMeshRudpRejectionReason {
|
||||||
Self::ChannelNotReliable => 14,
|
Self::ChannelNotReliable => 14,
|
||||||
Self::DocumentMissing => 15,
|
Self::DocumentMissing => 15,
|
||||||
Self::SchemaIdMissing => 16,
|
Self::SchemaIdMissing => 16,
|
||||||
Self::StoredAtNotStamp => 17,
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
@ -506,7 +498,6 @@ impl CultMeshRudpApplicationRejection {
|
||||||
(CultMeshRudpRejectionReason::MessageIdTooLong, _) => message_invalid_message("messageId", text),
|
(CultMeshRudpRejectionReason::MessageIdTooLong, _) => message_invalid_message("messageId", text),
|
||||||
(CultMeshRudpRejectionReason::DocumentMissing, _) => message_invalid_message("document", text),
|
(CultMeshRudpRejectionReason::DocumentMissing, _) => message_invalid_message("document", text),
|
||||||
(CultMeshRudpRejectionReason::SchemaIdMissing, _) => message_invalid_message("schemaId", text),
|
(CultMeshRudpRejectionReason::SchemaIdMissing, _) => message_invalid_message("schemaId", text),
|
||||||
(CultMeshRudpRejectionReason::StoredAtNotStamp, _) => message_invalid_message("document", text),
|
|
||||||
(CultMeshRudpRejectionReason::ChannelNotReliable, _) => message_invalid_message("channel", text),
|
(CultMeshRudpRejectionReason::ChannelNotReliable, _) => message_invalid_message("channel", text),
|
||||||
(CultMeshRudpRejectionReason::WriteLimitReached, _) => CultNetMessage::Error {
|
(CultMeshRudpRejectionReason::WriteLimitReached, _) => CultNetMessage::Error {
|
||||||
error: format!("limit_reached: {text}"),
|
error: format!("limit_reached: {text}"),
|
||||||
|
|
@ -1610,19 +1601,11 @@ where
|
||||||
receipt: CultMeshRudpRawDocumentReceipt,
|
receipt: CultMeshRudpRawDocumentReceipt,
|
||||||
authorize: bool,
|
authorize: bool,
|
||||||
) -> std::result::Result<(), CultMeshRudpRejectionReason> {
|
) -> std::result::Result<(), CultMeshRudpRejectionReason> {
|
||||||
let stamped = cultcache_rs::is_stored_at_stamp(&receipt.document.stored_at);
|
if authorize {
|
||||||
// The authority speaks first. A legacy session's sink decides at `accept_raw_document`, so it is asked here
|
|
||||||
// only when the stamp is bad: an ungranted peer is refused `write_not_authorized`, not told its stamp is wrong.
|
|
||||||
if authorize || !stamped {
|
|
||||||
if let Err(error) = self.sink.authorize_raw_document(&receipt) {
|
if let Err(error) = self.sink.authorize_raw_document(&receipt) {
|
||||||
return Err(CultMeshRudpRejectionReason::SinkRefused(format!("{error:#}")));
|
return Err(CultMeshRudpRejectionReason::SinkRefused(format!("{error:#}")));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
// A peer's put is stored under the stamp it carries, so one that is no stamp is refused before anything is
|
|
||||||
// measured, minted or handed to the sink.
|
|
||||||
if !stamped {
|
|
||||||
return Err(CultMeshRudpRejectionReason::StoredAtNotStamp);
|
|
||||||
}
|
|
||||||
let document = &receipt.document;
|
let document = &receipt.document;
|
||||||
// Admit only what some snapshot request can return: the smallest
|
// Admit only what some snapshot request can return: the smallest
|
||||||
// response that could carry this document is the record the snapshot
|
// response that could carry this document is the record the snapshot
|
||||||
|
|
|
||||||
|
|
@ -3546,10 +3546,6 @@ fn blank_means_exactly_the_unicode_white_space_code_points_in_every_field() -> R
|
||||||
for (index, (hex, blank)) in space.iter().map(|h| (h, true)).chain(not_space.iter().map(|h| (h, false))).enumerate() {
|
for (index, (hex, blank)) in space.iter().map(|h| (h, true)).chain(not_space.iter().map(|h| (h, false))).enumerate() {
|
||||||
let hex = hex.as_str().unwrap();
|
let hex = hex.as_str().unwrap();
|
||||||
for (field_index, field) in fields.iter().enumerate() {
|
for (field_index, field) in fields.iter().enumerate() {
|
||||||
// A storedAt must be a stamp: a non-blank one that is no stamp is not a name (write-receipt.md, Required fields).
|
|
||||||
if !blank && *field == "storedAt" {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
// A session that is sent refusals is allowed to end, so each code point and field gets its own.
|
// A session that is sent refusals is allowed to end, so each code point and field gets its own.
|
||||||
let sink = Sink::default();
|
let sink = Sink::default();
|
||||||
let mut server = server(Default::default(), Clock::new(70_000), sink.clone(), Source::default())?;
|
let mut server = server(Default::default(), Clock::new(70_000), sink.clone(), Source::default())?;
|
||||||
|
|
@ -3630,177 +3626,3 @@ fn an_unreadable_frame_on_a_receipt_connection_is_sent_exactly_the_fixed_text()
|
||||||
);
|
);
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
// ---- A peer's `storedAt` must be a stamp (variants:ruling:raw-put-without-stamp-refused) ----
|
|
||||||
//
|
|
||||||
// `tests/vectors/stored-at-stamp/stamps.msgpack`: `[text, parses]` rows. Every row that is no stamp is refused and
|
|
||||||
// nothing reaches the sink. A blank text names nothing, so it is refused as a frame that does not read (field
|
|
||||||
// "message", write-receipt.md, Required fields); any other text that is no stamp is refused field "document".
|
|
||||||
|
|
||||||
fn stamp_rows() -> Vec<(String, bool)> {
|
|
||||||
let path = std::path::Path::new(env!("CARGO_MANIFEST_DIR")).join("../../tests/vectors/stored-at-stamp/stamps.msgpack");
|
|
||||||
rmp_serde::from_slice(&std::fs::read(path).unwrap()).unwrap()
|
|
||||||
}
|
|
||||||
|
|
||||||
fn is_blank(text: &str) -> bool {
|
|
||||||
text.chars().all(char::is_whitespace)
|
|
||||||
}
|
|
||||||
|
|
||||||
/// A put of `key` whose `storedAt` is `stamp` as it would arrive: a blank one is swapped into the bytes, since the
|
|
||||||
/// encoder refuses it.
|
|
||||||
fn put_stamped_bytes(id: &str, key: &str, payload: Vec<u8>, stamp: &str) -> Result<Vec<u8>> {
|
|
||||||
let mut record = document(key, payload);
|
|
||||||
record.stored_at = if is_blank(stamp) { "zz-stamp-zz".into() } else { stamp.into() };
|
|
||||||
let bytes = encode_cultnet_message_to_vec(
|
|
||||||
&CultNetMessage::DocumentPutRaw { message_id: id.into(), document: record },
|
|
||||||
CultNetWireContract::CultNetSchemaV0,
|
|
||||||
)?;
|
|
||||||
Ok(if is_blank(stamp) { swap_fixstr(&bytes, "zz-stamp-zz", stamp) } else { bytes })
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn a_receipt_session_put_that_is_no_stamp_is_refused_for_every_vector_row_and_the_store_stays_writable() -> Result<()> {
|
|
||||||
let rows = stamp_rows();
|
|
||||||
assert!(rows.len() > 30);
|
|
||||||
let sink = Sink::default();
|
|
||||||
let mut server = server(Default::default(), Clock::new(70_000), sink.clone(), Source::default())?;
|
|
||||||
let mut peer = client(server.local_addr()?, 700)?;
|
|
||||||
connect(&mut server, &mut [&mut peer])?;
|
|
||||||
send_reliable(&mut peer, &receipt_hello())?;
|
|
||||||
assert_eq!(frames_after(&mut server, &mut peer, 1)?, vec![server_hello()]);
|
|
||||||
let mut expected = Vec::new();
|
|
||||||
let mut answers = Vec::new();
|
|
||||||
for (index, (text, parses)) in rows.iter().enumerate() {
|
|
||||||
let id = format!("r{index}");
|
|
||||||
peer.send_reliable("schema", put_stamped_bytes(&id, &format!("note:{index}"), vec![1, 2, 3], text)?)?;
|
|
||||||
expected.push((id, text.clone(), *parses));
|
|
||||||
// One write in flight at a time: the answer arrives before the next row is sent.
|
|
||||||
answers.extend(frames_after(&mut server, &mut peer, 1)?);
|
|
||||||
}
|
|
||||||
peer.send_reliable("schema", valid_put("after"))?;
|
|
||||||
answers.extend(frames_after(&mut server, &mut peer, 1)?);
|
|
||||||
for (answer, (id, text, parses)) in answers.iter().zip(&expected) {
|
|
||||||
if *parses {
|
|
||||||
assert_eq!(*answer, admitted(id, &id.replace('r', "note:")), "{text:?}");
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
assert_eq!(refusal_of(answer), (Some(CultNetErrorCode::MessageInvalid), Some(id.clone())), "{text:?}");
|
|
||||||
let field = if is_blank(text) { "message" } else { "document" };
|
|
||||||
assert_eq!(error_text_and_field(answer).1, Some(field.into()), "{text:?}");
|
|
||||||
}
|
|
||||||
// Every stamp row was stored exactly as sent; no refused row was stored; the put after them all was.
|
|
||||||
let state = sink.0.lock().unwrap();
|
|
||||||
let stored: Vec<&str> = state.receipts.iter().map(|receipt| receipt.document.stored_at.as_str()).collect();
|
|
||||||
let stamps: Vec<&str> = rows.iter().filter(|(_, parses)| *parses).map(|(text, _)| text.as_str()).collect();
|
|
||||||
assert_eq!(&stored[..stamps.len()], &stamps[..]);
|
|
||||||
assert_eq!(stored.len(), stamps.len() + 1, "only the stamped puts and the final put were stored");
|
|
||||||
assert_eq!(answers.last(), Some(&admitted("put-after", "after")));
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn a_put_with_no_storedat_key_is_refused_and_a_resend_replays_the_refusal() -> Result<()> {
|
|
||||||
let sink = Sink::default();
|
|
||||||
let mut server = server(Default::default(), Clock::new(70_000), sink.clone(), Source::default())?;
|
|
||||||
let mut peer = client(server.local_addr()?, 701)?;
|
|
||||||
connect(&mut server, &mut [&mut peer])?;
|
|
||||||
send_reliable(&mut peer, &receipt_hello())?;
|
|
||||||
let missing = swap_fixstr(&valid_put("a"), "storedAt", "storedAx");
|
|
||||||
peer.send_reliable("schema", missing)?;
|
|
||||||
// The same garbage stamp twice under one id: the refusal is remembered (by index) and replays as it was.
|
|
||||||
peer.send_reliable("schema", put_stamped_bytes("g1", "note:g", vec![1], "yesterday")?)?;
|
|
||||||
peer.send_reliable("schema", put_stamped_bytes("g1", "note:g", vec![1], "yesterday")?)?;
|
|
||||||
let answers = answers_after(&mut server, &mut peer, 3)?;
|
|
||||||
assert_eq!(error_text_and_field(&answers[0]).1, Some("message".into()));
|
|
||||||
assert_eq!(refusal_of(&answers[1]), (Some(CultNetErrorCode::MessageInvalid), Some("g1".into())));
|
|
||||||
assert_eq!(error_text_and_field(&answers[1]).1, Some("document".into()));
|
|
||||||
assert_eq!(answers[2], answers[1]);
|
|
||||||
assert!(sink.0.lock().unwrap().receipts.is_empty());
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn a_legacy_session_put_that_is_no_stamp_is_refused_for_every_vector_row_and_nothing_is_stored() -> Result<()> {
|
|
||||||
let sink = Sink::default();
|
|
||||||
let mut server = server(Default::default(), Clock::new(70_000), sink.clone(), Source::default())?;
|
|
||||||
let mut connection_id = 800;
|
|
||||||
for (text, parses) in stamp_rows() {
|
|
||||||
if parses {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
connection_id += 1;
|
|
||||||
let mut peer = client(server.local_addr()?, connection_id)?;
|
|
||||||
connect(&mut server, &mut [&mut peer])?;
|
|
||||||
let receipt = peer.send_reliable("schema", put_stamped_bytes("bad", "note:bad", vec![1, 2, 3], &text)?)?;
|
|
||||||
let reason = poll_until_rejected_or_stored(&mut server, &mut peer, &sink, 1)?;
|
|
||||||
if is_blank(&text) {
|
|
||||||
assert!(matches!(reason, Some(CultMeshRudpRejectionReason::MessageUnreadable(_))), "{text:?}: {reason:?}");
|
|
||||||
} else {
|
|
||||||
assert_eq!(reason, Some(CultMeshRudpRejectionReason::StoredAtNotStamp), "{text:?}");
|
|
||||||
let (error, code, details) = typed_refusal_seen_by(&mut peer, &receipt, Some(&mut server))?;
|
|
||||||
assert_eq!(code, Some(CultNetErrorCode::MessageInvalid), "{text:?}: {error}");
|
|
||||||
assert_eq!(details.and_then(|d| d.field), Some("document".into()), "{text:?}");
|
|
||||||
}
|
|
||||||
assert!(sink.0.lock().unwrap().receipts.is_empty(), "{text:?} reached the sink");
|
|
||||||
}
|
|
||||||
// The server and its sink are still writable.
|
|
||||||
connection_id += 1;
|
|
||||||
let mut peer = client(server.local_addr()?, connection_id)?;
|
|
||||||
connect(&mut server, &mut [&mut peer])?;
|
|
||||||
stored_after_poll(&mut server, &mut peer, &sink, 1)?;
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
/// The size gate measures the document as a snapshot would serve it: a put over the bound that is also no stamp is
|
|
||||||
/// refused for its stamp first, and nothing is measured for one that is.
|
|
||||||
#[test]
|
|
||||||
fn the_stamp_is_judged_before_the_size_limit() -> Result<()> {
|
|
||||||
let over = document("big", vec![7; 101]);
|
|
||||||
let options = CultMeshRudpDocumentServerOptions {
|
|
||||||
max_snapshot_response_bytes: served_alone_bytes(&over)? - 1,
|
|
||||||
..Default::default()
|
|
||||||
};
|
|
||||||
let sink = Sink::default();
|
|
||||||
let mut server = server(options, Clock::new(70_000), sink.clone(), Source::default())?;
|
|
||||||
let mut peer = client(server.local_addr()?, 900)?;
|
|
||||||
connect(&mut server, &mut [&mut peer])?;
|
|
||||||
peer.send_reliable("schema", put_stamped_bytes("o1", "big", vec![7; 101], "yesterday")?)?;
|
|
||||||
assert_eq!(
|
|
||||||
poll_until_rejected_or_stored(&mut server, &mut peer, &sink, 1)?,
|
|
||||||
Some(CultMeshRudpRejectionReason::StoredAtNotStamp)
|
|
||||||
);
|
|
||||||
let mut stamped = client(server.local_addr()?, 901)?;
|
|
||||||
connect(&mut server, &mut [&mut stamped])?;
|
|
||||||
stamped.send_reliable("schema", put_stamped_bytes("o2", "big", vec![7; 101], "2026-06-25T00:00:00Z")?)?;
|
|
||||||
assert!(matches!(
|
|
||||||
poll_until_rejected_or_stored(&mut server, &mut stamped, &sink, 1)?,
|
|
||||||
Some(CultMeshRudpRejectionReason::DocumentUnservable { .. })
|
|
||||||
));
|
|
||||||
assert!(sink.0.lock().unwrap().receipts.is_empty());
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
/// An ungranted peer is refused `write_not_authorized` before its stamp is judged, on a receipt session and on a
|
|
||||||
/// legacy one, and the authority is asked about the write.
|
|
||||||
#[test]
|
|
||||||
fn an_ungranted_peer_is_refused_for_authority_before_its_stamp_is_judged() -> Result<()> {
|
|
||||||
let sink = Sink::denying(&["secret"]);
|
|
||||||
let mut server = server(Default::default(), Clock::new(70_000), sink.clone(), Source::default())?;
|
|
||||||
let mut receipt_peer = client(server.local_addr()?, 950)?;
|
|
||||||
connect(&mut server, &mut [&mut receipt_peer])?;
|
|
||||||
send_reliable(&mut receipt_peer, &receipt_hello())?;
|
|
||||||
receipt_peer.send_reliable("schema", put_stamped_bytes("a1", "secret", vec![1], "yesterday")?)?;
|
|
||||||
let answers = answers_after(&mut server, &mut receipt_peer, 1)?;
|
|
||||||
assert_eq!(refusal_of(&answers[0]), (Some(CultNetErrorCode::WriteNotAuthorized), Some("a1".into())));
|
|
||||||
assert_eq!(sink.0.lock().unwrap().authorized, vec!["a1".to_string()]);
|
|
||||||
|
|
||||||
let mut legacy_peer = client(server.local_addr()?, 951)?;
|
|
||||||
connect(&mut server, &mut [&mut legacy_peer])?;
|
|
||||||
legacy_peer.send_reliable("schema", put_stamped_bytes("a2", "secret", vec![1], "yesterday")?)?;
|
|
||||||
assert!(matches!(
|
|
||||||
poll_until_rejected_or_stored(&mut server, &mut legacy_peer, &sink, 1)?,
|
|
||||||
Some(CultMeshRudpRejectionReason::SinkRefused(_))
|
|
||||||
));
|
|
||||||
assert!(sink.0.lock().unwrap().receipts.is_empty());
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
|
||||||
|
|
@ -11,7 +11,6 @@ All notable changes to `@gamecult/cultmesh-ts` are recorded here, following
|
||||||
|
|
||||||
### Breaking
|
### Breaking
|
||||||
|
|
||||||
- `createRudpDocumentServer` refuses a peer put whose `storedAt` is missing, empty or not a stamp (`isStoredAtStamp`, the shape pinned in `tests/vectors/stored-at-stamp/`) with `message_invalid` naming `document`, after the write authority has been asked and before the put is sized; `onDocumentPutRaw` is not called, so nothing is stored and no stamp is minted (variants:ruling:raw-put-without-stamp-refused). `CultMeshRudpDocumentPut.storedAt` is the stamp the peer sent, never a server clock; a document synced from a peer with a stampless record is refused by the registry.
|
|
||||||
- `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.
|
- `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.
|
||||||
|
|
@ -30,8 +29,6 @@ All notable changes to `@gamecult/cultmesh-ts` are recorded here, following
|
||||||
|
|
||||||
- Needs the cultcache-ts release that ships with this change (its manifest range moves with that release): it imports `schemaIdentityOf` and `SchemaConflictError`, which 0.14.x does not export.
|
- Needs the cultcache-ts release that ships with this change (its manifest range moves with that release): it imports `schemaIdentityOf` and `SchemaConflictError`, which 0.14.x does not export.
|
||||||
|
|
||||||
- Needs `@gamecult/cultnet-ts` `^0.4.0` (was `^0.3.0`): this package imports names that `cultnet-ts` 0.3.0 does not export (`cultNetMessageInvalidError`, `cultNetTextError`, `cultNetWriteNotAuthorizedError`, `WriteTracker`, `CULTNET_WRITE_RECEIPT_MESSAGE_VERSIONS`, `helloAdvertisesWriteReceipts`, `resultWindowMs`). The declared-range check (`npm run test:pack:ts`) found the old range admitting a release that lacks them.
|
|
||||||
|
|
||||||
## [0.2.0]
|
## [0.2.0]
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
|
||||||
|
|
@ -49,8 +49,8 @@
|
||||||
"node": ">=20"
|
"node": ">=20"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@gamecult/cultcache-ts": "^0.16.0",
|
"@gamecult/cultcache-ts": "^0.15.0",
|
||||||
"@gamecult/cultnet-ts": "^0.4.0",
|
"@gamecult/cultnet-ts": "^0.3.0",
|
||||||
"koffi": "3.3.0"
|
"koffi": "3.3.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
|
|
|
||||||
|
|
@ -5,7 +5,6 @@ import {
|
||||||
CultCache,
|
CultCache,
|
||||||
SchemaConflictError,
|
SchemaConflictError,
|
||||||
SingleFileMessagePackBackingStore,
|
SingleFileMessagePackBackingStore,
|
||||||
isStoredAtStamp,
|
|
||||||
schemaIdentityOf,
|
schemaIdentityOf,
|
||||||
type AnyCultCacheDocumentDefinition,
|
type AnyCultCacheDocumentDefinition,
|
||||||
type CacheBackingStore,
|
type CacheBackingStore,
|
||||||
|
|
@ -3934,7 +3933,7 @@ export class CultMeshNode {
|
||||||
}
|
}
|
||||||
|
|
||||||
public async flush(soft = false): Promise<void> {
|
public async flush(soft = false): Promise<void> {
|
||||||
await this.store.pushAll?.(this.cache.storedSnapshot(), { soft });
|
await this.store.pushAll?.(this.cache.snapshot(), { soft });
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -5814,12 +5813,6 @@ export class CultMesh {
|
||||||
));
|
));
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
// A peer's put is stored under the stamp it carries: one that is no stamp is refused, after the authority
|
|
||||||
// has spoken and before the put is sized, so the size-limited path never measures it. Nothing is minted.
|
|
||||||
if (!isStoredAtStamp(message.document.storedAt)) {
|
|
||||||
sendSchemaMessage(record, cultNetMessageInvalidError("document", "Raw put documents must carry a storedAt stamp."));
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
if (options.onDocumentPutRaw) {
|
if (options.onDocumentPutRaw) {
|
||||||
const unservable = unservablePut(message);
|
const unservable = unservablePut(message);
|
||||||
|
|
@ -6642,7 +6635,7 @@ function normalizeRudpDocumentPut(
|
||||||
return {
|
return {
|
||||||
schemaId: document.schemaId,
|
schemaId: document.schemaId,
|
||||||
recordKey: document.recordKey,
|
recordKey: document.recordKey,
|
||||||
storedAt: document.storedAt,
|
storedAt: document.storedAt ?? new Date().toISOString(),
|
||||||
sourceRuntimeId: document.sourceRuntimeId ?? null,
|
sourceRuntimeId: document.sourceRuntimeId ?? null,
|
||||||
sourceAgentId: document.sourceAgentId ?? null,
|
sourceAgentId: document.sourceAgentId ?? null,
|
||||||
sourceRole: document.sourceRole ?? null,
|
sourceRole: document.sourceRole ?? null,
|
||||||
|
|
|
||||||
|
|
@ -6,7 +6,7 @@ import test from "node:test";
|
||||||
import assert from "node:assert/strict";
|
import assert from "node:assert/strict";
|
||||||
import { decodeWireValue, encodeWireValue } from "@gamecult/cultnet-ts/wire";
|
import { decodeWireValue, encodeWireValue } from "@gamecult/cultnet-ts/wire";
|
||||||
import { z } from "zod";
|
import { z } from "zod";
|
||||||
import { SchemaConflictError, SingleFileMessagePackBackingStore, defineDocumentType, documentPayloadBytes, documentPayloadFromBytes } from "@gamecult/cultcache-ts";
|
import { SchemaConflictError, defineDocumentType, documentPayloadBytes, documentPayloadFromBytes } from "@gamecult/cultcache-ts";
|
||||||
import {
|
import {
|
||||||
CultNetDocumentRegistry,
|
CultNetDocumentRegistry,
|
||||||
CultNetPeer,
|
CultNetPeer,
|
||||||
|
|
@ -109,34 +109,6 @@ test("CultMesh TS opens a durable local node and registers document bindings", a
|
||||||
assert.ok(reopened.documents.getBySchemaId("cultmesh.note.v0"));
|
assert.ok(reopened.documents.getBySchemaId("cultmesh.note.v0"));
|
||||||
});
|
});
|
||||||
|
|
||||||
test("CultMesh TS flush from a node that never pulled leaves the records the store holds", async () => {
|
|
||||||
const filePath = join(await mkdtemp(join(tmpdir(), "cultmesh-ts-flush-")), "node.ccmp");
|
|
||||||
const first = await CultMesh.startNode(filePath, { documents: [noteDocument] });
|
|
||||||
await first.put(noteDocument, "note:held", { noteId: "note:held", body: "already in the store" });
|
|
||||||
await first.flush();
|
|
||||||
|
|
||||||
const unpulled = await CultMesh.startNode(filePath, { documents: [noteDocument], pullOnStart: false });
|
|
||||||
await unpulled.flush();
|
|
||||||
|
|
||||||
const reopened = await CultMesh.startNode(filePath, { documents: [noteDocument] });
|
|
||||||
assert.equal(reopened.getRequired(noteDocument, "note:held").body, "already in the store");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("CultMesh TS flush of a node that loaded a legacy-key global leaves the store reopenable", async () => {
|
|
||||||
const settings = defineDocumentType({ type: "cultmesh.settings", schema: z.object({ theme: z.string() }), global: true });
|
|
||||||
const filePath = join(await mkdtemp(join(tmpdir(), "cultmesh-ts-legacy-flush-")), "node.ccmp");
|
|
||||||
const seed = await CultMesh.startNode(join(await mkdtemp(join(tmpdir(), "cultmesh-ts-seed-")), "seed.ccmp"), { documents: [settings] });
|
|
||||||
await seed.cache.putGlobal(settings, { theme: "iron" });
|
|
||||||
const legacy = { ...seed.cache.getRequiredEnvelope(settings, "__global__"), key: "legacy" };
|
|
||||||
await new SingleFileMessagePackBackingStore(filePath).push(legacy);
|
|
||||||
|
|
||||||
const node = await CultMesh.startNode(filePath, { documents: [settings] });
|
|
||||||
await node.flush();
|
|
||||||
|
|
||||||
const reopened = await CultMesh.startNode(filePath, { documents: [settings] });
|
|
||||||
assert.deepEqual(reopened.cache.getRequiredGlobal(settings), { theme: "iron" });
|
|
||||||
});
|
|
||||||
|
|
||||||
test("CultMesh TS document handles hide local cache plumbing behind typed reactive reads", async () => {
|
test("CultMesh TS document handles hide local cache plumbing behind typed reactive reads", async () => {
|
||||||
const filePath = join(await mkdtemp(join(tmpdir(), "cultmesh-ts-doc-")), "node.ccmp");
|
const filePath = join(await mkdtemp(join(tmpdir(), "cultmesh-ts-doc-")), "node.ccmp");
|
||||||
const node = await CultMesh.startNode(filePath, {
|
const node = await CultMesh.startNode(filePath, {
|
||||||
|
|
@ -3423,12 +3395,11 @@ const servedBoundRegistry = () =>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A put's own storedAt, kept by the served record and replaced in the receipt by the server's
|
* A put's own storedAt, kept by the served record and replaced in the receipt by the server's
|
||||||
* 24-character clock. `SERVED_STORED_AT` is as long as a stamp can be (a stamp is judged before a put is
|
* 24-character clock. `SERVED_STORED_AT` is long, so an echoed receipt is smaller than the served
|
||||||
* sized, so padding one is refused), so an echoed receipt is smaller than the served reply;
|
* reply; `RECEIPT_STORED_AT` is short, so an echoed receipt is the larger reply, which shows that
|
||||||
* `RECEIPT_STORED_AT` is short, so an echoed receipt is the larger reply, which shows that
|
|
||||||
* admission sizes only the served reply.
|
* admission sizes only the served reply.
|
||||||
*/
|
*/
|
||||||
const SERVED_STORED_AT = "2026-09-30T00:00:00.123456789+00:00"; // the longest a stamp can be, 35 characters
|
const SERVED_STORED_AT = `2026-09-30T00:00:00.000Z${"~".repeat(200)}`;
|
||||||
const RECEIPT_STORED_AT = "2026-09-30T00:00:00.000Z";
|
const RECEIPT_STORED_AT = "2026-09-30T00:00:00.000Z";
|
||||||
const SERVED_BOUND_SERVER = "cultmesh-ts-served-bound-server";
|
const SERVED_BOUND_SERVER = "cultmesh-ts-served-bound-server";
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -122,7 +122,7 @@ const rust: Target = {
|
||||||
name: "rust",
|
name: "rust",
|
||||||
payload: (text) => encode({ text }),
|
payload: (text) => encode({ text }),
|
||||||
async start() {
|
async start() {
|
||||||
if (!prebuilt) await execFileAsync(cargo, ["build", "--locked", "--example", "receipt_interop_server", "--message-format", "short"], { cwd: rustManifestDir });
|
if (!prebuilt) await execFileAsync(cargo, ["build", "--example", "receipt_interop_server", "--message-format", "short"], { cwd: rustManifestDir });
|
||||||
const metadata = spawnSync(cargo, ["metadata", "--format-version", "1", "--no-deps"], { cwd: rustManifestDir, encoding: "utf8" });
|
const metadata = spawnSync(cargo, ["metadata", "--format-version", "1", "--no-deps"], { cwd: rustManifestDir, encoding: "utf8" });
|
||||||
if (metadata.status !== 0) throw new Error(`cargo metadata failed: ${metadata.stderr}`);
|
if (metadata.status !== 0) throw new Error(`cargo metadata failed: ${metadata.stderr}`);
|
||||||
const exe = join(JSON.parse(metadata.stdout).target_directory, "debug", "examples", `receipt_interop_server${process.platform === "win32" ? ".exe" : ""}`);
|
const exe = join(JSON.parse(metadata.stdout).target_directory, "debug", "examples", `receipt_interop_server${process.platform === "win32" ? ".exe" : ""}`);
|
||||||
|
|
|
||||||
|
|
@ -83,16 +83,3 @@ test("a provider command that is not a map, or lacks a required field, is refuse
|
||||||
(error: Error) => error.message === "CultMesh provider command must be a MessagePack map.",
|
(error: Error) => error.message === "CultMesh provider command must be a MessagePack map.",
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("a provider command payload with bytes after its first value is refused by count, without echoing the tail", () => {
|
|
||||||
const command = { commandId: "c1", commandKind: "k", providerId: "p", serviceInstanceId: "s", payload: { n: 1 } };
|
|
||||||
const whole = documentPayloadBytes(encodeDocumentPayload(providerCommandDocument, command));
|
|
||||||
const tailed = documentPayloadFromBytes(Uint8Array.from([...whole, ...Buffer.from("canary-tail-8c1f")]));
|
|
||||||
assert.throws(
|
|
||||||
() => decodeProviderCommandDocument({
|
|
||||||
schemaId: cultMeshProviderSessionSchemas.command, recordKey: "p/s/c1", storedAt: "2026-10-11T00:00:00Z",
|
|
||||||
payloadEncoding: "messagepack" as const, payload: tailed,
|
|
||||||
}),
|
|
||||||
(error: Error) => error.message.includes("16 bytes after its first MessagePack value") && !error.message.includes("canary-tail-8c1f"),
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
|
||||||
|
|
@ -7,7 +7,6 @@ import { join } from "node:path";
|
||||||
import test from "node:test";
|
import test from "node:test";
|
||||||
import { z } from "zod";
|
import { z } from "zod";
|
||||||
import { documentPayloadFromBytes, defineDocumentType } from "@gamecult/cultcache-ts";
|
import { documentPayloadFromBytes, defineDocumentType } from "@gamecult/cultcache-ts";
|
||||||
import { decode } from "@msgpack/msgpack";
|
|
||||||
import { decodeRudpPacket } from "@gamecult/cultnet-ts";
|
import { decodeRudpPacket } from "@gamecult/cultnet-ts";
|
||||||
import { encodeWireValue } from "@gamecult/cultnet-ts/wire";
|
import { encodeWireValue } from "@gamecult/cultnet-ts/wire";
|
||||||
import {
|
import {
|
||||||
|
|
@ -311,64 +310,6 @@ test("the refusal on the wire is the pinned error-vectors bytes", async () => {
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
// A peer's put is stored under the stamp it carries: every row of the shared vector goes through the real handler. A row that
|
|
||||||
// is no stamp is refused message_invalid naming `document`, on the plain, the size-limited and (RUDP is this server's only
|
|
||||||
// transport) the capped path; the handler never runs, so nothing is stored or minted, and a stamped put after it still lands.
|
|
||||||
const STAMP_VECTOR = join(__dirname, "..", "..", "..", "..", "tests", "vectors", "stored-at-stamp", "stamps.msgpack");
|
|
||||||
|
|
||||||
test("a put whose storedAt is no stamp is refused message_invalid (document), for every row of the stamp vector", async () => {
|
|
||||||
const rows = decode(readFileSync(STAMP_VECTOR)) as [string, boolean][];
|
|
||||||
const cases: [string, unknown, boolean][] = [...rows.map(([text, parses]): [string, unknown, boolean] => [JSON.stringify(text), text, parses]),
|
|
||||||
["missing", undefined, false], ["number", 1_700_000_000_000, false]];
|
|
||||||
for (const extra of [{}, { maxPayloadBytes: 4096 }]) {
|
|
||||||
await using(await rig(new CultMeshGrantAllWrites(), extra), async (r) => {
|
|
||||||
let accepted = 0;
|
|
||||||
for (const [label, storedAt, parses] of cases) {
|
|
||||||
const message = put(KEY_A) as unknown as { document: Record<string, unknown> };
|
|
||||||
if (storedAt === undefined) delete message.document.storedAt; else message.document.storedAt = storedAt;
|
|
||||||
const seen = r.replies.length;
|
|
||||||
const handled = r.puts.length;
|
|
||||||
r.peer.send(message as unknown as CultNetMessage);
|
|
||||||
await sleep(40);
|
|
||||||
if (parses) {
|
|
||||||
accepted += 1;
|
|
||||||
assert.equal(r.puts.length, handled + 1, `${label}: a stamp reaches the handler`);
|
|
||||||
assert.equal(r.replies.length, seen, label);
|
|
||||||
} else {
|
|
||||||
assert.equal(r.puts.length, handled, `${label}: nothing handled, so nothing minted or stored`);
|
|
||||||
const reply = r.replies[seen] as { schemaVersion?: string; code?: string; details?: { field?: string } } | undefined;
|
|
||||||
assert.equal(reply?.schemaVersion, "cultnet.error.v0", label);
|
|
||||||
assert.equal(reply?.code, "message_invalid", label);
|
|
||||||
assert.equal(reply?.details?.field, "document", label);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
assert.ok(accepted > 0);
|
|
||||||
assert.deepEqual(r.errors, []);
|
|
||||||
// The large put under a garbage stamp is refused for its stamp, before it is measured.
|
|
||||||
const large = put(KEY_A, {}, SCHEMA_ID, new Uint8Array(20_000)) as unknown as { document: Record<string, unknown> };
|
|
||||||
large.document.storedAt = "yesterday";
|
|
||||||
r.peer.send(large as unknown as CultNetMessage);
|
|
||||||
await sleep(60);
|
|
||||||
const last = r.replies[r.replies.length - 1] as { code?: string; details?: { field?: string } };
|
|
||||||
assert.equal(last.code, "message_invalid");
|
|
||||||
assert.equal(last.details?.field, "document");
|
|
||||||
});
|
|
||||||
}
|
|
||||||
// The stamp is judged after the authority: an ungranted peer hears write_not_authorized, aliased or not.
|
|
||||||
const refusing = new Recording(() => ({ granted: false, reason: "no" }));
|
|
||||||
await using(await rig(refusing), async (r) => {
|
|
||||||
const aliased = put(KEY_A, {}, ALIAS) as unknown as { document: Record<string, unknown> };
|
|
||||||
aliased.document.storedAt = "yesterday";
|
|
||||||
r.peer.send(aliased as unknown as CultNetMessage);
|
|
||||||
r.peer.send(put(KEY_B));
|
|
||||||
await r.settle();
|
|
||||||
assertRefused(r.replies[0], KEY_A);
|
|
||||||
assertRefused(r.replies[1], KEY_B);
|
|
||||||
assert.equal(refusing.requests[0]?.schemaId, SCHEMA_ID, "an aliased put asks under the canonical id");
|
|
||||||
assert.equal(r.puts.length, 0);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("wrong-typed shard fields on a put are judged with null shard fields, then refused as malformed once granted", async () => {
|
test("wrong-typed shard fields on a put are judged with null shard fields, then refused as malformed once granted", async () => {
|
||||||
const authority = new Recording(grant);
|
const authority = new Recording(grant);
|
||||||
await using(await rig(authority), async (r) => {
|
await using(await rig(authority), async (r) => {
|
||||||
|
|
|
||||||
|
|
@ -2,8 +2,7 @@
|
||||||
|
|
||||||
## Unreleased (breaking; version 0.x, so the next minor)
|
## Unreleased (breaking; version 0.x, so the next minor)
|
||||||
|
|
||||||
- `raw_record_to_envelope`, where a replicated record becomes an envelope, refuses a record whose `storedAt` is missing, empty or not a stamp (`cultcache_py.stores.parse_stored_at`, the shape pinned by `tests/vectors/stored-at-stamp`) with `ValueError`, nothing minted or stored (`variants:ruling:raw-put-without-stamp-refused`). `apply_raw_document_record`, `apply_raw_snapshot` and `apply_shard_log_response` come through it: a snapshot response with such a record is refused whole before any of its records is stored, as one naming an unregistered schema is; a shard log refuses at that entry, the entries before it already applied. It stored the record under `""`, and the next open of the store raised `CultCacheError` `Missing envelope`. `cultmesh-py`'s raw put builds its envelope through the same function, so there is one owner of the check there; its server gate still answers a peer's put `message_invalid`. A client's `read_next_change` lets the `ValueError` out.
|
- `decode_witness_artifact_bundle_payload` (and `CultNetWitnessArtifactBundle.from_payload`) read the payload through `cultcache_py.read_payload_tree`: bytes after its first MessagePack value raise `ValueError` `cultnet.witness_artifact_bundle payload has N bytes after its first MessagePack value (refused on read).` instead of `msgpack.ExtraData`, and a payload nested past 256 raises `CultCachePayloadDepthError`. Needs `cultcache-py` 0.4.0, the release that exports `read_payload_tree`: the dependency is now `cultcache-py>=0.4.0` (it was `>=0.2.0`, which admits releases whose `import cultnet_py` fails), and `tests/test_declared_dependency_ranges.py` fails when a declared bound admits a tagged release lacking a name the package imports. The same check found `cultmesh-py` importing `cache.index_text`, which `cultcache-py` 0.2.0 lacks; its bound is `cultcache-py>=0.4.0` too (it has no changelog of its own). A raw record with bytes after its first value gives no schema hint to `resolve_document_for_raw_record`, so an unknown schema id stays `KeyError` rather than being routed; a registered one is refused by count when applied.
|
||||||
- `decode_witness_artifact_bundle_payload` (and `CultNetWitnessArtifactBundle.from_payload`) read the payload through `cultcache_py.read_payload_tree`: bytes after its first MessagePack value raise `ValueError` `cultnet.witness_artifact_bundle payload has N bytes after its first MessagePack value (refused on read).` instead of `msgpack.ExtraData`, and a payload nested past 256 raises `CultCachePayloadDepthError`. Needs `cultcache-py` 0.4.0, the release that exports `read_payload_tree`: the dependency is now `cultcache-py>=0.4.0` (it was `>=0.2.0`, which admits releases whose `import cultnet_py` fails), and `tests/test_declared_dependency_ranges.py` fails when a declared bound admits a tagged release lacking a name the package imports. The same check found `cultmesh-py` importing `cache.index_text`, which `cultcache-py` 0.2.0 lacks; its bound is `cultcache-py>=0.4.0` too (it has no changelog of its own). `resolve_document_for_raw_record` reads the schema hint from a raw record's first value whether or not bytes follow it, so a record routed by its stamp is refused by count when applied (`ValueError`, in a snapshot, a shard log and a direct apply) like one routed by a registered schema id; `apply_shard_log_response` used to skip it silently as an unknown schema. A tail on a payload whose first value names no registered schema is still `KeyError`, which a shard log skips.
|
|
||||||
- `apply_raw_document_record` and `apply_raw_snapshot` raise `SchemaConflictError` when a remote record is of another type than the one the cache holds at its key (`cultcache-py` holds one record per key whatever its type); the cache is unchanged, and the caller decides whether to drop the record or the peer. `cultmesh-py`'s server answers such a put with `message_invalid`; its client's `read_next_change` lets the error out.
|
- `apply_raw_document_record` and `apply_raw_snapshot` raise `SchemaConflictError` when a remote record is of another type than the one the cache holds at its key (`cultcache-py` holds one record per key whatever its type); the cache is unchanged, and the caller decides whether to drop the record or the peer. `cultmesh-py`'s server answers such a put with `message_invalid`; its client's `read_next_change` lets the error out.
|
||||||
- `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.
|
- `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.
|
- 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.
|
||||||
|
|
|
||||||
|
|
@ -5,7 +5,6 @@ from typing import Any, Iterable
|
||||||
|
|
||||||
from cultcache_py import CultCache, CultCacheEnvelope
|
from cultcache_py import CultCache, CultCacheEnvelope
|
||||||
from cultcache_py.documents import DocumentDefinition
|
from cultcache_py.documents import DocumentDefinition
|
||||||
from cultcache_py.stores import parse_stored_at
|
|
||||||
|
|
||||||
from .shard_log import CultNetShardLogResponse
|
from .shard_log import CultNetShardLogResponse
|
||||||
from .snapshot import CultNetRawDocumentRecord, CultNetRawSnapshotResponse
|
from .snapshot import CultNetRawDocumentRecord, CultNetRawSnapshotResponse
|
||||||
|
|
@ -51,29 +50,17 @@ def apply_raw_document_record(
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def require_stored_at_stamp(record: dict[str, Any]) -> str:
|
|
||||||
"""The storedAt a replicated raw record carries; ValueError when it is missing or no stamp. The one place the rule is judged."""
|
|
||||||
stored_at = record.get("storedAt")
|
|
||||||
if parse_stored_at(stored_at) is None:
|
|
||||||
raise ValueError("A replicated raw record must carry a storedAt stamp.")
|
|
||||||
return stored_at
|
|
||||||
|
|
||||||
|
|
||||||
def raw_record_to_envelope(
|
def raw_record_to_envelope(
|
||||||
document: DocumentDefinition[Any],
|
document: DocumentDefinition[Any],
|
||||||
schema_id: str,
|
schema_id: str,
|
||||||
record: dict[str, Any],
|
record: dict[str, Any],
|
||||||
) -> CultCacheEnvelope:
|
) -> CultCacheEnvelope:
|
||||||
"""The envelope a replicated raw record is stored as; the one place a record becomes an envelope (a direct apply, a snapshot and a
|
|
||||||
shard log all come through here). A peer's record is stored under the stamp it carries, so one whose storedAt is missing, empty or
|
|
||||||
no stamp is refused with ValueError and nothing is minted or stored (variants:ruling:raw-put-without-stamp-refused)."""
|
|
||||||
stored_at = require_stored_at_stamp(record)
|
|
||||||
return CultCacheEnvelope(
|
return CultCacheEnvelope(
|
||||||
key=str(record["recordKey"]),
|
key=str(record["recordKey"]),
|
||||||
type=document.type,
|
type=document.type,
|
||||||
schema_id=schema_id,
|
schema_id=schema_id,
|
||||||
payload=bytes(record["payload"]),
|
payload=bytes(record["payload"]),
|
||||||
stored_at=stored_at,
|
stored_at=str(record.get("storedAt") or ""),
|
||||||
catalog_entry=document.catalog_entry(),
|
catalog_entry=document.catalog_entry(),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
@ -130,12 +117,6 @@ def apply_shard_log_response(
|
||||||
reason = response.get("reason") or "unspecified"
|
reason = response.get("reason") or "unspecified"
|
||||||
raise ValueError(f"Shard log response requires resync: {reason}")
|
raise ValueError(f"Shard log response requires resync: {reason}")
|
||||||
documents_by_schema_id = schema_document_map(documents)
|
documents_by_schema_id = schema_document_map(documents)
|
||||||
# The whole log is refused before anything is stored: every put that would be applied is judged for its stamp first.
|
|
||||||
for entry in response.get("entries", []):
|
|
||||||
if isinstance(entry, dict) and entry.get("changeKind") in ("added", "updated") and isinstance(entry.get("put"), dict):
|
|
||||||
record = entry["put"]["document"]
|
|
||||||
if can_resolve_document_for_raw_record(documents_by_schema_id, str(record["schemaId"]), record):
|
|
||||||
require_stored_at_stamp(record)
|
|
||||||
applied: list[CultNetAppliedRecord] = []
|
applied: list[CultNetAppliedRecord] = []
|
||||||
for entry in response.get("entries", []):
|
for entry in response.get("entries", []):
|
||||||
if not isinstance(entry, dict):
|
if not isinstance(entry, dict):
|
||||||
|
|
@ -193,11 +174,10 @@ def _infer_schema_version_from_payload(payload: bytes) -> str | None:
|
||||||
import msgpack # type: ignore
|
import msgpack # type: ignore
|
||||||
try:
|
try:
|
||||||
decoded = msgpack.unpackb(payload, raw=False)
|
decoded = msgpack.unpackb(payload, raw=False)
|
||||||
except msgpack.ExtraData as extra:
|
except msgpack.ExtraData:
|
||||||
# The hint is read from the first value; the tail is not this function's to judge. The routed definition refuses
|
# A payload with bytes after its value gives no routing hint: the record is unroutable by inference, and a
|
||||||
# it by count when the record is applied, as it does for a record routed by a registered schema id. Treating a
|
# registered schema id routes it to a definition whose decode refuses the tail by count.
|
||||||
# tail as "no hint" made a stamp-routed record look like an unknown schema, which a shard log skips silently.
|
return None
|
||||||
decoded = extra.unpacked
|
|
||||||
except Exception:
|
except Exception:
|
||||||
return None
|
return None
|
||||||
if isinstance(decoded, list) and decoded and isinstance(decoded[0], str):
|
if isinstance(decoded, list) and decoded and isinstance(decoded[0], str):
|
||||||
|
|
|
||||||
|
|
@ -1971,7 +1971,7 @@ class CultNetTests(unittest.TestCase):
|
||||||
apply_raw_document_record(cache, schema_document_map([first, second]), raw(first)) # the same type still replaces
|
apply_raw_document_record(cache, schema_document_map([first, second]), raw(first)) # the same type still replaces
|
||||||
self.assertEqual(cache.get_required(first, "shared").name, "remote")
|
self.assertEqual(cache.get_required(first, "shared").name, "remote")
|
||||||
|
|
||||||
def test_a_raw_record_with_a_tail_is_routed_by_its_stamp_and_refused_by_count_on_every_apply_path(self) -> None:
|
def test_a_raw_record_with_a_tail_is_unroutable_by_inference_and_refused_by_count_when_routed(self) -> None:
|
||||||
import msgpack # type: ignore
|
import msgpack # type: ignore
|
||||||
from cultcache_py import define_document_type
|
from cultcache_py import define_document_type
|
||||||
from cultnet_py import resolve_document_for_raw_record
|
from cultnet_py import resolve_document_for_raw_record
|
||||||
|
|
@ -1986,33 +1986,18 @@ class CultNetTests(unittest.TestCase):
|
||||||
"payloadEncoding": "messagepack", "payload": payload}
|
"payloadEncoding": "messagepack", "payload": payload}
|
||||||
|
|
||||||
documents = schema_document_map([document])
|
documents = schema_document_map([document])
|
||||||
# The stamp is read from the first value whether or not a tail follows, so an unknown schema id whose payload names
|
# Routing by inference reads a hint, not a payload: a payload with a tail gives no hint, so an unknown schema id
|
||||||
# a registered schema routes to it; the tail is then refused by count where the record is applied.
|
# stays the unknown-schema error (KeyError) even when the first value names a registered schema.
|
||||||
self.assertIs(resolve_document_for_raw_record(documents, "unknown", raw("unknown", head + b"\xc0")), document)
|
self.assertIs(resolve_document_for_raw_record(documents, "unknown", raw("unknown", head)), document)
|
||||||
for schema_id in (known, "unknown"):
|
|
||||||
cache = CultCache()
|
|
||||||
cache.register_document_type(document)
|
|
||||||
with self.assertRaises(ValueError, msg=schema_id) as caught:
|
|
||||||
apply_raw_document_record(cache, documents, raw(schema_id, head + b"\xc0"))
|
|
||||||
self.assertIn("1 bytes after its first MessagePack value", str(caught.exception))
|
|
||||||
self.assertIsNone(cache.get(document, "k"))
|
|
||||||
snapshot = {"schemaVersion": "cultnet.snapshot_response_raw.v0", "messageId": "s",
|
|
||||||
"documents": [raw(schema_id, head + b"\xc0")]}
|
|
||||||
with self.assertRaises(ValueError, msg=schema_id):
|
|
||||||
apply_raw_snapshot(cache, [document], snapshot)
|
|
||||||
log = {"schemaVersion": "cultnet.shard_log_response.v0", "messageId": "l", "shardId": "s", "shardEpoch": 1,
|
|
||||||
"resyncRequired": False,
|
|
||||||
"entries": [{"sequence": 0, "changeKind": "updated",
|
|
||||||
"put": {"schemaVersion": "cultnet.document_put_raw.v0", "messageId": "p",
|
|
||||||
"document": raw(schema_id, head + b"\xc0"), "shardId": "s", "shardEpoch": 1}}]}
|
|
||||||
with self.assertRaises(ValueError, msg=schema_id) as caught:
|
|
||||||
apply_shard_log_response(cache, [document], log)
|
|
||||||
self.assertIn("1 bytes after its first MessagePack value", str(caught.exception))
|
|
||||||
self.assertIsNone(cache.get(document, "k"))
|
|
||||||
# A tail on a payload that names no registered schema is still an unknown schema, which a shard log skips.
|
|
||||||
stranger = msgpack.packb(["tests.stranger.v1", "x"], use_bin_type=True) + b"\xc0"
|
|
||||||
with self.assertRaises(KeyError):
|
with self.assertRaises(KeyError):
|
||||||
resolve_document_for_raw_record(documents, "unknown", raw("unknown", stranger))
|
resolve_document_for_raw_record(documents, "unknown", raw("unknown", head + b"\xc0"))
|
||||||
|
# A registered schema id routes, and the tail is refused by count when the record is applied.
|
||||||
|
cache = CultCache()
|
||||||
|
cache.register_document_type(document)
|
||||||
|
with self.assertRaises(ValueError) as caught:
|
||||||
|
apply_raw_document_record(cache, documents, raw(known, head + b"\xc0"))
|
||||||
|
self.assertIn("1 bytes after its first MessagePack value", str(caught.exception))
|
||||||
|
self.assertIsNone(cache.get(document, "k"))
|
||||||
|
|
||||||
def test_cultnet_replication_helpers_apply_raw_snapshot_and_shard_log(self) -> None:
|
def test_cultnet_replication_helpers_apply_raw_snapshot_and_shard_log(self) -> None:
|
||||||
document = define_database_entry_type(
|
document = define_database_entry_type(
|
||||||
|
|
|
||||||
|
|
@ -1,57 +0,0 @@
|
||||||
"""raw_record_to_envelope is the one place a replicated raw record becomes an envelope; it refuses a record whose storedAt is no stamp.
|
|
||||||
|
|
||||||
The stamp shape is tests/vectors/stored-at-stamp/stamps.msgpack (variants:ruling:raw-put-without-stamp-refused); cultmesh-py tests the
|
|
||||||
whole replication paths, this tests the function itself.
|
|
||||||
"""
|
|
||||||
|
|
||||||
from __future__ import annotations
|
|
||||||
|
|
||||||
import unittest
|
|
||||||
from pathlib import Path
|
|
||||||
from typing import Any
|
|
||||||
|
|
||||||
import msgpack
|
|
||||||
from cultcache_py import define_database_entry_type
|
|
||||||
from cultnet_py.replication import raw_record_to_envelope
|
|
||||||
|
|
||||||
VECTOR = Path(__file__).resolve().parents[3] / "tests/vectors/stored-at-stamp/stamps.msgpack"
|
|
||||||
ROWS: list[tuple[str, bool]] = [(text, parses) for text, parses in msgpack.unpackb(VECTOR.read_bytes(), raw=False)]
|
|
||||||
NOTE = define_database_entry_type(
|
|
||||||
"tests.envelope_note",
|
|
||||||
[("schema_version", 0), ("text", 1)],
|
|
||||||
schema_id="sha256:envelope-note",
|
|
||||||
schema_name="tests.envelope_note",
|
|
||||||
schema_version="tests.envelope_note.v1",
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def record_with(stamp: Any) -> dict[str, Any]:
|
|
||||||
record = {
|
|
||||||
"schemaId": "sha256:envelope-note",
|
|
||||||
"recordKey": "note:1",
|
|
||||||
"payload": NOTE.encode_payload({"schema_version": "tests.envelope_note.v1", "text": "t"}),
|
|
||||||
}
|
|
||||||
if stamp is not None:
|
|
||||||
record["storedAt"] = stamp
|
|
||||||
return record
|
|
||||||
|
|
||||||
|
|
||||||
class RawRecordToEnvelopeStampTests(unittest.TestCase):
|
|
||||||
def test_every_vector_row_is_an_envelope_or_a_refusal_as_the_vector_says(self) -> None:
|
|
||||||
self.assertGreater(len(ROWS), 30)
|
|
||||||
for text, parses in ROWS:
|
|
||||||
with self.subTest(text=text):
|
|
||||||
if parses:
|
|
||||||
self.assertEqual(raw_record_to_envelope(NOTE, "sha256:envelope-note", record_with(text)).stored_at, text)
|
|
||||||
else:
|
|
||||||
with self.assertRaises(ValueError):
|
|
||||||
raw_record_to_envelope(NOTE, "sha256:envelope-note", record_with(text))
|
|
||||||
|
|
||||||
def test_a_missing_or_non_string_stamp_is_refused(self) -> None:
|
|
||||||
for stamp in (None, 12345, b"2026-11-07T00:00:00Z"):
|
|
||||||
with self.subTest(stamp=stamp), self.assertRaises(ValueError):
|
|
||||||
raw_record_to_envelope(NOTE, "sha256:envelope-note", record_with(stamp))
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
unittest.main()
|
|
||||||
1
packages/cultnet-rs/.gitignore
vendored
1
packages/cultnet-rs/.gitignore
vendored
|
|
@ -1 +1,2 @@
|
||||||
/target
|
/target
|
||||||
|
Cargo.lock
|
||||||
|
|
|
||||||
|
|
@ -15,6 +15,5 @@ only in git history.
|
||||||
|
|
||||||
### Breaking
|
### Breaking
|
||||||
|
|
||||||
- A CultNet frame with bytes after its message is refused, by count (through `cultcache_rs::decode_payload`); the decoder used to read the message and drop the tail. No producer emits one. Behaviour change: the next release is a minor bump (0.x breaking).
|
|
||||||
- `CultNetDocumentRegistry::register` returns `Result<&mut Self>` where it returned `&mut Self`. A binding that claims a document type or a schema id another binding already holds is refused with `cultcache_rs::SchemaConflictError` (naming the new binding's schema id and both document types) and nothing is bound; binding a type to the schema id it already holds still replaces that binding. Callers chain `register(...)?`.
|
- `CultNetDocumentRegistry::register` returns `Result<&mut Self>` where it returned `&mut Self`. A binding that claims a document type or a schema id another binding already holds is refused with `cultcache_rs::SchemaConflictError` (naming the new binding's schema id and both document types) and nothing is bound; binding a type to the schema id it already holds still replaces that binding. Callers chain `register(...)?`.
|
||||||
- `CultMeshCdnChunkRef` gains a public `id` field, the decimal text of `offset` (the reference's element id, slot 4). A manifest written before ids reads `""`; encoding writes the slot.
|
- `CultMeshCdnChunkRef` gains a public `id` field, the decimal text of `offset` (the reference's element id, slot 4). A manifest written before ids reads `""`; encoding writes the slot.
|
||||||
|
|
|
||||||
1228
packages/cultnet-rs/Cargo.lock
generated
1228
packages/cultnet-rs/Cargo.lock
generated
File diff suppressed because it is too large
Load diff
|
|
@ -30,7 +30,7 @@ knock on the contract before touching the furniture.
|
||||||
## Receipts
|
## Receipts
|
||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
cargo test --locked
|
cargo test
|
||||||
```
|
```
|
||||||
|
|
||||||
The initial tests prove:
|
The initial tests prove:
|
||||||
|
|
|
||||||
|
|
@ -7,7 +7,7 @@
|
||||||
//! traffic crosses the same schedule. The schedule is `policy.rs`.
|
//! traffic crosses the same schedule. The schedule is `policy.rs`.
|
||||||
//!
|
//!
|
||||||
//! ```text
|
//! ```text
|
||||||
//! cargo run --locked --release --example cultnet_impair -- \
|
//! cargo run --release --example cultnet_impair -- \
|
||||||
//! --listen 0.0.0.0:17890 --upstream 127.0.0.1:17990 \
|
//! --listen 0.0.0.0:17890 --upstream 127.0.0.1:17990 \
|
||||||
//! --profile tests/impairment/loss-1pct.toml --seed 424242 --metrics loss-1pct.csv
|
//! --profile tests/impairment/loss-1pct.toml --seed 424242 --metrics loss-1pct.csv
|
||||||
//! ```
|
//! ```
|
||||||
|
|
|
||||||
|
|
@ -51,7 +51,6 @@ fn write_record(path: &Path, key: &str, ty: &str, schema: &str, payload: Vec<u8>
|
||||||
stored_at: "2026-10-29T00:00:00Z".into(),
|
stored_at: "2026-10-29T00:00:00Z".into(),
|
||||||
schema_id: Some(schema.into()),
|
schema_id: Some(schema.into()),
|
||||||
})
|
})
|
||||||
.map(|_| ())
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// ------------------------------------------------------------------ fake host
|
// ------------------------------------------------------------------ fake host
|
||||||
|
|
|
||||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue