sequent 4.2.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7e291ad7f19e869e7606e8dc49282a545db07d4a656f5ee44d71ed5c2e33170
-  data.tar.gz: fb73e4b00b0f0e9ef94cab2152922c280b51d3568f5f9ecb7a9cdaa00afed97e
+  metadata.gz: feea2aeb3dba28570a36615392e4ecc1037bfdfd1c2d667bcc787113e4c7fdba
+  data.tar.gz: 79dc60b21109885a56f3f68cf97185afee5692167f54db1934eaa89dc9d030de
 SHA512:
-  metadata.gz: df076f1efbe41c17c75c99c5331d7f1e23ff8c52607c9a0e709a9dd46504a2b6e78d471ed247dff4e5913809de28bc328a820ce00779d0a97fb64f669a10670e
-  data.tar.gz: 552dca913ac052facd09d2602c08a38fa33c66e3d4c092d38a6fcd018dabca2683ef93d5f3ddef8b105fa043c6d99bf765be38ad2f69171a08e5af63df3783ad
+  metadata.gz: bb74d9c6cbb946bab9b00cb2ea73eab80caed4737d12ce2115a6c97348ca0e9452a14280b3d0de9ecba237c201fdd8b2914382751569224c89cae92128d5d3f5
+  data.tar.gz: 5fe084735eb4df8855b8102e68d027ca828a8dd7540d577b6e0a97616bbd22815432e684f20d48d04ad111db962fe935af4bff50afd8ebc7242f5c15f01b97a7

data/lib/sequent/core/aggregate_repository.rb

@@ -57,6 +57,37 @@ module Sequent
         load_aggregates([aggregate_id], clazz)[0]
       end
 
+      # Optimised for loading lots of events and ignore snapshot events. To get the correct historical state of an
+      # AggregateRoot it is necessary to be able to ignore snapshots. For a nested AggregateRoot, there will not be a
+      # sequence number known, so a load_until timestamp can be used instead.
+      #
+      # +aggregate_id+ The id of the aggregate to be loaded
+      #
+      # +clazz+ Optional argument that checks if aggregate is of type +clazz+
+      #
+      # +load_until+ Optional argument that defines up until what point in time the AggregateRoot will be rebuilt.
+      def load_aggregate_for_snapshotting(aggregate_id, clazz = nil, load_until: nil)
+        fail ArgumentError, 'aggregate_id is required' if aggregate_id.blank?
+
+        stream = Sequent
+          .configuration
+          .event_store
+          .find_event_stream(aggregate_id)
+        aggregate = Class.const_get(stream.aggregate_type).stream_from_history(stream)
+
+        Sequent
+          .configuration
+          .event_store
+          .stream_events_for_aggregate(aggregate_id, load_until: load_until) do |event_stream|
+          aggregate.stream_from_history(event_stream)
+        end
+
+        if clazz
+          fail TypeError, "#{aggregate.class} is not a #{clazz}" unless aggregate.class <= clazz
+        end
+        aggregate
+      end
+
       ##
       # Loads multiple aggregates at once.
       # Returns the ones in the current Unit Of Work otherwise loads it from history.

data/lib/sequent/core/aggregate_root.rb

@@ -80,6 +80,26 @@ module Sequent
         events.each { |event| apply_event(event) }
       end
 
+      def initialize_for_streaming(stream)
+        @uncommitted_events = []
+        @sequence_number = 1
+        @event_stream = stream
+      end
+
+      def stream_from_history(stream_events)
+        _stream, event = stream_events
+        fail 'Empty history' if event.blank?
+
+        @id ||= event.aggregate_id
+        apply_event(event)
+      end
+
+      def self.stream_from_history(stream)
+        aggregate_root = allocate
+        aggregate_root.initialize_for_streaming(stream)
+        aggregate_root
+      end
+
       def to_s
         "#{self.class.name}: #{@id}"
       end

data/lib/sequent/core/event_store.rb

@@ -51,7 +51,38 @@ module Sequent
       end
 
       ##
-      # Returns all events for the aggregate ordered by sequence_number
+      # Returns all events for the AggregateRoot ordered by sequence_number, disregarding snapshot events.
+      #
+      # This streaming is done in batches to prevent loading many events in memory all at once. A usecase for ignoring
+      # the snapshots is when events of a nested AggregateRoot need to be loaded up until a certain moment in time.
+      #
+      # @param aggregate_id Aggregate id of the AggregateRoot
+      # @param load_until The timestamp up until which you want to built the aggregate. Optional.
+      # @param &block Block that should be passed to handle the batches returned from this method
+      def stream_events_for_aggregate(aggregate_id, load_until: nil, &block)
+        stream = find_event_stream(aggregate_id)
+        fail ArgumentError, 'no stream found for this aggregate' if stream.blank?
+
+        q = Sequent
+          .configuration
+          .event_record_class
+          .where(aggregate_id: aggregate_id)
+          .where.not(event_type: Sequent.configuration.snapshot_event_class.name)
+          .order(:sequence_number)
+        q = q.where('created_at < ?', load_until) if load_until.present?
+        has_events = false
+
+        q.select('event_type, event_json').each_row do |event_hash|
+          has_events = true
+          event = deserialize_event(event_hash)
+          block.call([stream, event])
+        end
+        fail ArgumentError, 'no events for this aggregate' unless has_events
+      end
+
+      ##
+      # Returns all events for the aggregate ordered by sequence_number, loading them from the latest snapshot
+      # event onwards, if a snapshot is present
       #
       def load_events(aggregate_id)
         load_events_for_aggregates([aggregate_id])[0]

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sequent
-  VERSION = '4.2.0'
+  VERSION = '4.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sequent
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.3.0
 platform: ruby
 authors:
 - Lars Vonk
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-30 00:00:00.000000000 Z
+date: 2022-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -23,7 +23,7 @@ dependencies:
         version: '5.0'
     - - "<="
       - !ruby/object:Gem::Version
-        version: 6.1.4.4
+        version: 7.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -33,7 +33,7 @@ dependencies:
         version: '5.0'
     - - "<="
       - !ruby/object:Gem::Version
-        version: 6.1.4.4
+        version: 7.0.2
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -43,7 +43,7 @@ dependencies:
         version: '5.0'
     - - "<="
       - !ruby/object:Gem::Version
-        version: 6.1.4.4
+        version: 7.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -53,7 +53,7 @@ dependencies:
         version: '5.0'
     - - "<="
       - !ruby/object:Gem::Version
-        version: 6.1.4.4
+        version: 7.0.2
 - !ruby/object:Gem::Dependency
   name: bcrypt
   requirement: !ruby/object:Gem::Requirement
@@ -119,7 +119,7 @@ dependencies:
         version: 2.6.5
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -129,7 +129,7 @@ dependencies:
         version: 2.6.5
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -443,7 +443,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Event sourcing framework for Ruby