yes-core 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 657f96d2dc9f3d762a91b42976783cfead117aae5be6473e547b4e1568cc8e83
-  data.tar.gz: 0c5b51b64f133b09cf14ef1d9c99fc7fcdd94f67f479f410dca443545b13ce56
+  metadata.gz: 7c8f35e4035dc9922ec9a9cd70d87d17147053e62636a8dfcd305f4d17107783
+  data.tar.gz: 27f5bce1fbb5b148043020b9197716d591c6108026679d28c9227194cb597423
 SHA512:
-  metadata.gz: cecd619ffb8384612a3ad7a1640fbe6ed9f8d8b73b01f0da6bc8d1892bce474af92274444d8a3c7b16e1bfc622a1cadccbc793f51d61196dd48a57abbd3e0ec5
-  data.tar.gz: a8f5aee284c9e77715b839b395e4aefa99375275d76d47f9003e9aaf510cd77db88c5fc39c37046523247a01e958c8e1e689da8afc0044bb0928692bd311147c
+  metadata.gz: 92ab4144796e842ee51cc15c9edd1a34a61c652dd13731ca2c3ee286014e886559514e017d8bfcf2016d1271a602da50a9ca259e7039af870d7bd21671872844
+  data.tar.gz: 3b66c7247e0322a96ddef754167af357ba10f2e7951ff7a941e99e9c8cdac87e810c86a37d5ed84d1e3c31e6869ca3272cd2fcd5def17bf48448eea2380cd4f8

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## [2.6.0] - 2026-10-28
+- See root CHANGELOG.md for details.
+
 ## [2.5.0] - 2026-10-08
 - See root CHANGELOG.md for details.
 

data/lib/yes/core/read_model/builder.rb

@@ -23,7 +23,13 @@ module Yes
         READ_MODEL_CLASS_REGEXP =
           /(?<context>\w+)::ReadModels::(?<version>V\d+)?(::)?(?<aggregate>\w+)/
 
-        # Based on event type class it distributes event to a proper event handler
+        # Column of the read model that holds the revision of the last processed event of its stream
+        REVISION_COLUMN = :revision
+
+        # Based on event type class it distributes event to a proper event handler. After the handler ran, the
+        # stream revision of the event is stored in the read model's `revision` column (see #write_stream_revision).
+        # Events that were not handled (no handler, locale not available) do not change the revision, because
+        # the read model does not reflect them.
         # @param event [Yes::Core::Event]
         # @param read_model [ActiveRecord::Base] AR object
         # @return [void]
@@ -47,6 +53,8 @@ module Yes
           ensure
             otl_record_processed(read_model, event, handler)
           end
+
+          write_stream_revision(read_model, event)
         end
         otl_trackable :call, OpenTelemetry::OtlSpan::OtlData.new(
           span_kind: :consumer,
@@ -172,6 +180,30 @@ module Yes
             READ_MODEL_CLASS_REGEXP.match(self.class.to_s)
         end
 
+        # Stores the stream revision of the event in the read model's `revision` column, so a consumer can tell
+        # how far a read model fed by a subscription has caught up with its stream. It only moves forward and
+        # skips read models without the column. Per-aggregate columns (e.g. `shop_order_revision`) belong to
+        # the aggregates that write them and are never touched here.
+        # It only writes for events of the read model's own stream: a builder may also react to events of
+        # other streams (e.g. a product event for an order item), whose revision says nothing about this row.
+        # Only the stream id is compared, not the context or the stream name. A read model fed by two streams
+        # that share the same id would get a mixed revision, so such read models must not rely on it.
+        # A read model whose `revision` column an aggregate writes must not also be fed by a builder:
+        # use per-aggregate revision columns or project the events through the aggregate instead.
+        # @param read_model [ActiveRecord::Base, nil] the read model, nil if the event maps to no row
+        # @param event [Yes::Core::Event] the event that was handled
+        # @return [void]
+        def write_stream_revision(read_model, event)
+          revision = event.stream_revision
+          return unless revision && read_model&.persisted? && read_model.has_attribute?(REVISION_COLUMN)
+          return unless event.stream&.stream_id == read_model.id
+
+          # a nullable column may still be NULL before the first event
+          return unless revision > (read_model[REVISION_COLUMN] || -1)
+
+          read_model.update_column(REVISION_COLUMN, revision)
+        end
+
         # @param locale [Symbol] locale to check
         # @return [Boolean] true if locale is available
         def correct_locale?(locale)

data/lib/yes/core/version.rb

@@ -2,6 +2,6 @@
 
 module Yes
   module Core
-    VERSION = '2.5.0'
+    VERSION = '2.6.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yes-core
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Nico Ritsche