yrby-actioncable 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 761e38cb9b0e73b19aef2bc906d4170bc340c54fe09cae9aa6099814a7876dbb
-  data.tar.gz: 83d55bc7f20aca3cf82e7ee46adf6c8a163638f468afb1de35b339b5167a913e
+  metadata.gz: 71d5dea23772a176b12bbe5cbfe75a2a8cbe3dfff8e8c73f909330ef9844084b
+  data.tar.gz: 78f4d54167275c9e6e2fbade09e17e5c6d2cce7e7975e662ffa7e626fb03cdc1
 SHA512:
-  metadata.gz: 07d8e355e0eb3fa8fba54bb33a9250a7e5cc932e5a0dc0ab042b4aad96f07df010b2601f8b3f20f26733f5112639ee38b0b15fc089846e8b379862c4193ef156
-  data.tar.gz: 94d632ddca4cdebab57f63eb75d82bf94264bf1a2031baf5a50151d3564b10b4b6f904815cc95fd9b7726eddfb1fad7eb7d77454b916d5d54a6089afeac50527
+  metadata.gz: b434c280c1574f2b34f3517c04b653efaf09ce1cdc279795356b6e2d23b6c68e3dcf92c5a7a42e74f59a43745ccacc305f8372fec143d038dbabf22b53a32a5c
+  data.tar.gz: 790513cb6941bb5c9e6f6c3aaa1ce5496e1780fa093872ba867771a3bc3a51ed7b610ec0f291d69e102eee4ef5b8da0f5280cfe51e11b4162e6c97fc9a5879a6

data/CHANGELOG-actioncable.md

@@ -6,6 +6,18 @@ this project aims to follow [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.3] - 2026-07-01
+
+### Changed
+- Raised the `yrby` floor to `>= 0.3.0`. That release makes
+  `Doc#handle_sync_message` answer `SyncStep1` with integrated-only (gap-free)
+  state — it no longer serves un-integrable pending structs, which previously
+  poisoned peers and drove endless resync traffic. The sync channel serves its
+  SyncStep2 response through that method, so with an older core a poisoned server
+  store would still hand the gap to clients. No code change here — pinning the
+  floor makes gap-free serving self-enforcing instead of dependent on the app
+  updating the core gem.
+
 ## [0.2.2] - 2026-07-01
 
 ### Changed

data/README.md

@@ -142,18 +142,39 @@ doc = Y::Doc.new(12345) # specific client ID (used for CRDT identity)
 
 # Encoding
 doc.encode_state_vector           # => current state vector
-doc.encode_state_as_update        # => full update
+doc.encode_state_as_update        # => full update (lossless: keeps pending)
 doc.encode_state_as_update(sv)    # => update diff against state vector
+doc.compacted_state_update        # => full update, gap-free (excludes pending)
 
 # Applying updates
 doc.apply_update(update_bytes)    # apply raw V1 update
+doc.pending?                      # => true if holding un-integrable pending structs
 
 # Sync protocol
 doc.sync_step1                    # => SyncStep1 message (this doc's state vector)
 doc.handle_sync_message(data)     # => [msg_type, sync_type, response]; answers a
-                                  #    peer's SyncStep1 with a SyncStep2
+                                  #    peer's SyncStep1 with an integrated-only
+                                  #    SyncStep2 (never serves pending structs)
 ```
 
+### Pending structs and gap-free state
+
+If a doc applies an update whose causally-prior update is missing (a "gappy"
+update), yrs parks it as a **pending** struct: the integrated state vector stays
+empty, but the pending block is held as a recovery buffer and heals if the
+missing dependency later arrives. `Doc#pending?` reports this.
+
+Pending structs are *not* document state, so they must not cross the sync
+boundary — a peer that receives one can't integrate it and gets stuck. Two
+guarantees keep serving safe:
+
+- `handle_sync_message` answers `SyncStep1` with **integrated-only** state, so a
+  server never serves a struct it can't integrate itself (this is automatic).
+- `Doc#compacted_state_update` gives you the same gap-free full-state update for
+  when you persist or hand off state yourself. It's non-destructive (the doc
+  keeps its pending), while `encode_state_as_update` stays lossless so you can
+  still preserve the raw pending bytes for recovery.
+
 ### Protocol codec (module functions)
 
 Classifying and unwrapping wire frames is stateless, so it's exposed as

data/lib/y/action_cable/version.rb

@@ -2,6 +2,6 @@
 
 module Y
   module ActionCable
-    VERSION = "0.2.2"
+    VERSION = "0.2.3"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yrby-actioncable
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - JP Camara
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: actioncable
   requirement: !ruby/object:Gem::Requirement