prosody 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c19c30d17efd4507beb32278585c05188db05bb0b375c563edf29d24de76cff4
-  data.tar.gz: 38d1dc9257ac999358813eefcb9995b62da528ca98d0052c59fde8c70893c3f6
+  metadata.gz: f51af8dfb50cdab48f5a2a60c0ae761f26ce082ce3be41c538c1642a7147871e
+  data.tar.gz: 293c854498dbb467a1ea5aaccb774bc4d4db997e432f03b407cc7b6518de15e7
 SHA512:
-  metadata.gz: fddcd444897b7b3ef656d701395d921a47057489ea7e0cd63180fad07e4df5bc94b55386d4b6cc314e4f32653aa85401675d42ced8e3dc7810c3562bf2d97f5e
-  data.tar.gz: 9068019d952021ce16d10c3eb9c0000f97de3071f922c20ed59a1fccbb93ed20eddc015f7792f076e537cb0dd689dd0e742a29afb3a09da7bc88da4ac3c10ed4
+  metadata.gz: 4f7f4a6ec8fb471110213bcf7ba47d38bd06393f0a072afe403fe25a1ed8ee3924444ecd91e26a06207807916c22f4d0c1e803679f9aa75dec80e35f3d64c361
+  data.tar.gz: 584bd14a5ea9e2e806434ee06eea31ace62930b53f7e8c926e8536193d6500389b86f40fe4c7702b9fe06913d347c16f82a1e280c7bff381d2c0d46b14fb2d12

data/.config/rail.toml

@@ -0,0 +1,26 @@
+[plan.work.ci]
+paths = [".config/rail.toml", ".github/**", ".taplo.toml", "Makefile"]
+scope = "repository"
+
+[plan.work.ruby]
+paths = [
+    ".rspec",
+    ".ruby-version",
+    ".standard.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "Rakefile",
+    "Steepfile",
+    "bin/**",
+    "examples/**",
+    "ext/prosody/extconf.rb",
+    "lib/**",
+    "prosody.gemspec",
+    "sig-private/**",
+    "sig/**",
+    "spec/**",
+    "steep_expectations.yml",
+    "typecheck/**",
+    "typecheck_negative/**",
+]
+scope = "repository"

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.5.1"
+  ".": "0.6.0"
 }

data/.ruby-version

@@ -1 +1 @@
-3.3.7
+3.3.12

data/.taplo.toml

@@ -1,4 +1,4 @@
-include = ["*.toml", ".cargo/*.toml", "ext/**/*.toml"]
+include = ["*.toml", ".cargo/*.toml", ".config/*.toml", "ext/**/*.toml"]
 
 [formatting]
 indent_string = "    "

data/AGENTS.md

@@ -10,11 +10,11 @@ Ruby/Rust bridge in depth — read it before touching the extension.
 
 These come before everything else. Every change is judged against them.
 
-**Write code that is simple, clear, well-factored, elegant, easy to
-understand, correct, and idiomatic.** A reader should grasp the intent without
-effort. If a change makes the code harder to read, the change is wrong, even
-if it is faster or shorter. If two designs are correct, pick the one that is
-easier to delete.
+**Write code that is simple, clear, well-factored, DRY, performant, elegant,
+easy to understand, correct, and idiomatic.** A reader should grasp the intent
+without effort. If a change makes the code harder to read, the change is
+wrong, even if it is faster or shorter. If two designs are correct, pick the
+one that is easier to delete.
 
 **Make invalid states unrepresentable in the type system.** When a compiler
 or type checker can prove a contract, no test, comment, or convention has to.
@@ -26,9 +26,10 @@ uncompilable, do that instead of writing a runtime check.
 **Delete more than you add.** Every change should leave the codebase smaller,
 simpler, or both. If you must add code, look first for duplication you can
 fold, abstractions that no longer pay rent, dead branches, and stale comments.
-The end-state diff should net negative whenever the task allows. Line count is
-not the only axis: plain duplicated arms often read better than generic
-machinery.
+The end-state diff should net negative whenever the task allows. Each added
+line must be inherent to the problem, not incidental to the solution. Line
+count is not the only axis: plain duplicated arms often read better than
+generic machinery.
 
 **Identify, document, and enforce invariants.** For every load-bearing piece
 of state: name the invariant, write it down near the type or function that
@@ -40,6 +41,15 @@ not yet understand the code well enough to change it.
 encouraged when they are scoped to the area you are already touching. Do not
 sprawl — but do not walk past obvious cleanup either.
 
+**Do not break users without a reason.** The published package has real
+users. A release can break them only for a clear improvement that the
+owner decided on: a fixed defect, an invalid state that the types now
+prevent, or a need of a new feature. "Nothing in this repo calls it" is
+not a reason to remove, rename, or narrow a public member, an error
+class, a log text, or a dependency floor. When you are not sure, keep
+the old shape. List each break under `## Breaking changes` in the PR
+body.
+
 ## Definition of Done
 
 No change is complete until every line below holds. These are acts, not
@@ -60,7 +70,8 @@ aspirations — perform each one; do not merely agree with it:
    vocabulary (see Redesign hygiene). "The new thing works" is half done.
 7. Every claim written this session — doc cross-reference, "covered by" note,
    exemplar path — was verified to resolve, not recalled from memory.
-8. The diff is net-negative, or each addition is individually justified.
+8. The diff is net-negative, or each addition is individually justified as
+   inherent to the problem.
 
 ## Development Setup
 
@@ -216,6 +227,8 @@ half-deleted designs are where bloat and bug re-introduction live:
 
 **Style:**
 
+- Structure function bodies as logical paragraphs. Keep statements for one
+  operation together. Add a blank line before a new concept or operation.
 - Prefer `use` statements over fully qualified prefixes
 - Methods without `self` should be functions (except `new` and similar)
 - Ask before large structural changes
@@ -295,12 +308,13 @@ Constants → Statics → Types → Implementations → Functions → Errors (bo
 
 - `sig/` — public RBS signatures; `sig-private/` — internal signatures.
   Every API change updates the signatures in the same commit.
-- `lib/prosody/native_stubs.rb` — documented Ruby stubs for the classes and
-  methods the Rust extension implements. Editors and documentation tools read
-  them; the runtime does not (the native extension provides the real
-  definitions), and Steep ignores the file. When the extension's public
-  surface changes, update the matching stub and its YARD doc in the same
-  commit.
+- Public API docs are YARD comments on the public Ruby classes. A public
+  class that the Rust extension implements (`Client`, `Context`, `Message`,
+  `Timer`) keeps a documented stub in `lib/prosody/native_stubs/`. Do not
+  write stubs for internal native classes or private methods; `sig/` and
+  `sig-private/` type them. The runtime does not load the stubs, and Steep
+  ignores them. When a public native method changes, update its stub in the
+  same commit.
 - Steep targets (`Steepfile`): `lib` checks the implementation;
   `consumer_types` (`typecheck/`) verifies a payload type flows through the
   public API; `typed_examples` checks every runnable example;

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.6.0](https://github.com/prosody-events/prosody-rb/compare/prosody/v0.5.1...prosody/v0.6.0) (2026-10-02)
+
+
+### Features
+
+* **deps:** upgrade prosody to 0.7.0 ([#51](https://github.com/prosody-events/prosody-rb/issues/51)) ([c9f265c](https://github.com/prosody-events/prosody-rb/commit/c9f265c7c5353c989886d2333afca2142e06763c))
+
 ## [0.5.1](https://github.com/prosody-events/prosody-rb/compare/prosody/v0.5.0...prosody/v0.5.1) (2026-08-20)
 
 

data/CONFIGURATION.md

@@ -10,12 +10,14 @@ The Ruby client reports values it cannot convert to Prosody types. Prosody valid
 |-----------------------------------------|---------------------------------------------------|--------------|
 | `bootstrap_servers` / `PROSODY_BOOTSTRAP_SERVERS` | Kafka servers to connect to             | -            |
 | `group_id` / `PROSODY_GROUP_ID`         | Consumer group name                               | -            |
-| `subscribed_topics` / `PROSODY_SUBSCRIBED_TOPICS` | Topics to read from                     | -            |
+| `subscribed_topics` / `PROSODY_SUBSCRIBED_TOPICS` | Topics to read from; a client that only reads published state needs none | -            |
 | `allowed_events` / `PROSODY_ALLOWED_EVENTS` | Only process events matching these prefixes   | (all)        |
 | `source_system` / `PROSODY_SOURCE_SYSTEM` | Tag for outgoing messages (prevents reprocessing)| `<group_id>` |
 | `mock` / `PROSODY_MOCK`                 | Use in-memory Kafka for testing                   | false        |
 | `mode` / -                              | Processing mode: `pipeline`, `low_latency`, or `best_effort` | `pipeline` |
-| - / `PROSODY_LOG`                       | Rust log filter, such as `info` or `prosody=debug` | `info` |
+| - / `PROSODY_LOG`                       | Rust log filter, such as `info` or `prosody=debug` | `info`, with `warn` for `scylla` and `opentelemetry` |
+
+`PROSODY_LOG` directives apply on top of the defaults above. A value that names only targets, such as `prosody=debug`, keeps other targets at `info`. Set `PROSODY_LOG=opentelemetry=info` to restore the OpenTelemetry info events.
 
 ## Requests
 
@@ -45,9 +47,9 @@ Set `subsystem` to make this client answer requests. Without it, the client cons
 | `shutdown_timeout` / `PROSODY_SHUTDOWN_TIMEOUT` | Shutdown budget; handlers run freely until cancellation fires near the end of the timeout | 30s |
 | `stall_threshold` / `PROSODY_STALL_THRESHOLD` | Report unhealthy if no progress for this long  | 5m                     |
 | `probe_port` / `PROSODY_PROBE_PORT`     | HTTP port for health checks; use `false`, `:disabled`, or the environment value `none` to disable | 8000 |
-| - / `PROSODY_STATISTICS_INTERVAL`       | How often librdkafka reports client statistics; must be between 1ms and 24h | 5s |
+| `statistics_interval` / `PROSODY_STATISTICS_INTERVAL` | How often librdkafka reports client statistics; must be between 1ms and 24h | 5s |
 | `failure_topic` / `PROSODY_FAILURE_TOPIC` | Send unprocessable messages here (dead letter queue) | -                     |
-| `idempotence_cache_size` / `PROSODY_IDEMPOTENCE_CACHE_SIZE` | Global shared cache capacity across all partitions for message deduplication. Consumer deduplication is mandatory and cannot be disabled, so this must be at least 1; setting it to 0 in the client configuration is rejected | 8192 |
+| `idempotence_cache_size` / `PROSODY_IDEMPOTENCE_CACHE_SIZE` | Capacity of the producer idempotence cache and of the consumer deduplication cache. Consumer deduplication cannot be turned off, so the value must be at least 1 | 8192 |
 | `idempotence_version` / `PROSODY_IDEMPOTENCE_VERSION` | Version string for cache-busting dedup hashes | 1              |
 | `idempotence_ttl` / `PROSODY_IDEMPOTENCE_TTL`         | TTL for dedup records in Cassandra            | 7d (604800 seconds) |
 | `slab_size` / `PROSODY_SLAB_SIZE`       | Timer storage granularity (rarely needs changing)    | 1h                     |
@@ -141,27 +143,28 @@ Register keyed-state collections before you subscribe. Persistence is backed by
 | Option / Environment Variable | Description | Default |
 |-------------------------------|-------------|---------|
 | `state_collections` / - | Keyed-state collections to register before subscribe (array of definitions or config hashes; duplicate names rejected) | (none) |
-| `subsystem` / `PROSODY_SUBSYSTEM` | Subsystem name used to advertise JSON collections whose definitions set `published: true` | (none) |
-| `state_cache_dir` / `PROSODY_STATE_CACHE_DIR` | Disk workspace for the local keyed-state cache; each live client needs its own directory. Set a mounted path in production | per-client temp dir |
+| `subsystem` / `PROSODY_SUBSYSTEM` | Subsystem name used to advertise JSON and set collections whose definitions set `published: true` | (none) |
+| `state_cache_dir` / `PROSODY_STATE_CACHE_DIR` | Directory for the local keyed-state caches. Each consumer opens its cache in a new subdirectory and removes it when the consumer stops, so clients can share the directory. Set a mounted path in production | `<temp>/prosody/keyed-state` |
 | `state_owned_cache_size` / `PROSODY_STATE_OWNED_CACHE_SIZE` | Capacity of the owning keyed-state cache; accepts sizes such as `64 MiB` or `500 MB` | storage-engine default |
+| `state_memtable_size` / `PROSODY_STATE_MEMTABLE_SIZE` | Bytes of in-memory writes the local keyed-state cache holds for each assigned partition before it flushes them to disk; accepts sizes such as `16 MiB`. Memory use scales with the number of assigned partitions | storage-engine default of 64 MiB |
 | `state_read_cache_size` / `PROSODY_STATE_READ_CACHE_SIZE` | Capacity of the published-state read cache; accepts sizes such as `1 MiB` | `state_owned_cache_size` or `PROSODY_STATE_OWNED_CACHE_SIZE` when set; otherwise 1 MiB |
 | `state_read_cache` / `PROSODY_STATE_READ_CACHE_TTL` | Default published-read cache TTL. Use `false` or the environment value `none` to bypass the cache | 5s |
-| `state_recovery_delay` / `PROSODY_STATE_RECOVERY_DELAY` | Whole-second delay between staging a provisional cell and the recovery sweep; every collection TTL must strictly exceed it | 30s |
-
-Prefer the definition constructors from the [API reference](README.md#api-reference). They serialize into `state_collections`, so you can reuse the same object with `context.state`. Each entry has these fields:
 
 Published collections require `subsystem`. Keep it configured for one deployment after removing `published: true` so readers can observe the collection's retirement.
 
+Prefer the definition constructors from the [API reference](README.md#api-reference). They serialize into `state_collections`, so you can reuse the same object with `context.state`. Each entry has these fields:
+
 | Field | Description | Default |
 |-------|-------------|---------|
 | `name` | Collection name; non-empty and unique within the client | (required) |
-| `kind` | `"value"`, `"map"`, or `"deque"` | (required) |
-| `payload` | `"json"` (JSON values) or `"message"` (the full Kafka message the handler received) | (required) |
-| `ttl_seconds` | Per-write TTL in whole seconds (at least 1; must exceed the recovery delay) | (none) |
+| `kind` | `"value"`, `"map"`, `"set"`, or `"deque"` | (required) |
+| `payload` | `"json"` (JSON values) or `"message"` (the full Kafka message the handler received). Omit it for a set, which stores membership only | (required for a value, map, or deque) |
+| `ttl_seconds` | Per-write TTL in whole seconds (at least 1) | (none) |
 | `read_uncommitted` | Opt out of transactional staging | false |
-| `published` | Allow read-only access from other consumer groups; JSON collections only | false |
-| `read_cache` | Published-read cache override: a positive duration, `false`, or inherit when omitted | inherit |
-| `keyset_limit` | Map-only; ordered-scan bound in `0..=4096` (`0` disables ordered-scan tracking) | 128 |
+| `published` | Allow read-only access from other consumer groups; JSON and set collections only | false |
+| `keyset_limit` | Map and set only; ordered-scan bound in `0..=4096` (`0` disables ordered-scan tracking) | 128 |
 | `capacity` | Deque-only window bound (at least 1); keeps at most N slots, enforced lazily on push. Runtime-only and mutable across deploys — not persisted | unbounded |
 
-Constructors set these via keyword arguments (`ttl:`, `keyset_limit:`, `capacity:`, `read_uncommitted:`, `published:`, `read_cache:`). `read_cache` is a positive duration in seconds, `false` to bypass the cache, or `nil` to inherit the client default.
+Constructors set these via keyword arguments (`ttl:`, `keyset_limit:`, `capacity:`, `read_uncommitted:`, `published:`).
+
+A JSON or set constructor also takes `read_cache:`. It is not a registration field: it applies only to the readers that `client.state` opens with the definition. `read_cache` is a positive duration in seconds, `false` to bypass the cache, or `nil` to inherit the client default.