sequent 7.2.0 → 8.0.0

data/lib/sequent/core/helpers/attribute_support.rb

@@ -63,13 +63,13 @@ module Sequent
                 Sequent::Core::Helpers::DefaultValidators.for(type).add_validations_for(self, attribute)
               end
 
-              if type.instance_of?(Sequent::Core::Helpers::ArrayWithType)
-                associations << attribute
-              elsif included_modules.include?(ActiveModel::Validations) &&
-                    type.included_modules.include?(Sequent::Core::Helpers::AttributeSupport)
-                associations << attribute
-              end
+              is_array = type.instance_of?(Sequent::Core::Helpers::ArrayWithType)
+              needs_validation = !is_array && included_modules.include?(ActiveModel::Validations) &&
+                                 type.included_modules.include?(Sequent::Core::Helpers::AttributeSupport)
+
+              associations << attribute if is_array || needs_validation
             end
+
             if included_modules.include?(ActiveModel::Validations) && associations.present?
               validates_with Sequent::Core::Helpers::AssociationValidator, associations: associations
             end
@@ -168,7 +168,7 @@ EOS
 
         def attributes
           hash = HashWithIndifferentAccess.new
-          self.class.types.each do |name, _|
+          self.class.types.each_key do |name|
             value = instance_variable_get("@#{name}")
             hash[name] = if value.respond_to?(:attributes)
                            value.attributes
@@ -181,7 +181,7 @@ EOS
 
         def as_json(opts = {})
           hash = HashWithIndifferentAccess.new
-          self.class.types.each do |name, _|
+          self.class.types.each_key do |name|
             value = instance_variable_get("@#{name}")
             hash[name] = if value.respond_to?(:as_json)
                            value.as_json(opts)

data/lib/sequent/core/helpers/equal_support.rb

@@ -13,7 +13,7 @@ module Sequent
           return false if other.nil?
           return false if self.class != other.class
 
-          self.class.types.each do |name, _|
+          self.class.types.each_key do |name|
             self_value = send(name)
             other_value = other.send(name)
             if self_value.class == DateTime && other_value.class == DateTime
@@ -28,8 +28,8 @@ module Sequent
 
         def hash
           hash = 17
-          self.class.types.each do |name, _|
-            hash = hash * 31 + send(name).hash
+          self.class.types.each_key do |name|
+            hash = (hash * 31) + send(name).hash
           end
           hash
         end

data/lib/sequent/core/helpers/message_matchers/has_attrs.rb

@@ -20,10 +20,12 @@ module Sequent
           end
 
           def to_s
+            # rubocop:disable Layout/LineEndStringConcatenationIndentation
             'has_attrs(' \
               "#{MessageMatchers::ArgumentSerializer.serialize_value(message_matcher)}, " \
               "#{AttrMatchers::ArgumentSerializer.serialize_value(expected_attrs)}" \
             ')'
+            # rubocop:enable Layout/LineEndStringConcatenationIndentation
           end
 
           private

data/lib/sequent/core/helpers/message_router.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative './attr_matchers/attr_matchers'
-require_relative './message_matchers/message_matchers'
+require_relative 'attr_matchers/attr_matchers'
+require_relative 'message_matchers/message_matchers'
 
 module Sequent
   module Core

data/lib/sequent/core/helpers/param_support.rb

@@ -79,9 +79,7 @@ module Sequent
         def value_to_string(val)
           if val.is_a?(Sequent::Core::ValueObject)
             val.as_params
-          elsif val.is_a? DateTime
-            val.iso8601
-          elsif val.is_a? Date
+          elsif val.is_a?(DateTime) || val.is_a?(Date)
             val.iso8601
           elsif val.is_a? Time
             val.iso8601(Sequent.configuration.time_precision)

data/lib/sequent/core/helpers/pgsql_helpers.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Sequent
+  module Core
+    module Helpers
+      module PgsqlHelpers
+        def call_procedure(connection, procedure, params)
+          fail ArgumentError if procedure.blank?
+
+          statement = "CALL #{quote_ident(procedure)}(#{bind_placeholders(params)})"
+          connection.exec_update(statement, procedure, params)
+        end
+
+        def query_function(connection, function, params, columns: [])
+          fail ArgumentError if function.blank?
+
+          cols = columns.blank? ? '*' : columns.map { |c| PG::Connection.quote_ident(c) }.join(', ')
+          query = "SELECT #{cols} FROM #{quote_ident(function)}(#{bind_placeholders(params)})"
+          connection.exec_query(query, function, params)
+        end
+
+        private
+
+        def bind_placeholders(params)
+          (1..params.size).map { |n| "$#{n}" }.join(', ')
+        end
+
+        def quote_ident(...) = PG::Connection.quote_ident(...)
+      end
+    end
+  end
+end

data/lib/sequent/core/helpers/string_support.rb

@@ -15,7 +15,7 @@ module Sequent
             value = instance_variable_get(name.to_s)
             s += "#{name}=[#{value}], "
           end
-          '{' + s.chomp(', ') + '}'
+          "{#{s.chomp(', ')}}"
         end
       end
     end

data/lib/sequent/core/helpers/string_to_value_parsers.rb

@@ -39,7 +39,7 @@ module Sequent
           if value.blank? && !(value.is_a?(TrueClass) || value.is_a?(FalseClass))
             nil
           else
-            (value.is_a?(TrueClass) || value == 'true')
+            value.is_a?(TrueClass) || value == 'true'
           end
         end
 

data/lib/sequent/core/persistors/active_record_persistor.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'active_record'
-require_relative './persistor'
+require_relative 'persistor'
 
 module Sequent
   module Core

data/lib/sequent/core/persistors/replay_optimized_postgres_persistor.rb

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
-require 'set'
 require 'active_record'
 require 'csv'
-require_relative './persistor'
+require_relative 'persistor'
 
 module Sequent
   module Core
@@ -177,7 +176,7 @@ module Sequent
           end
 
           indices.each do |record_class, indexed_columns|
-            columns = indexed_columns.flatten(1).map(&:to_sym).to_set + default_indexed_columns
+            columns = indexed_columns.flatten(1).to_set(&:to_sym) + default_indexed_columns
             @record_index[record_class] = Index.new(columns & record_class.column_names.map(&:to_sym))
           end
 
@@ -358,7 +357,7 @@ module Sequent
 
         def clear
           @record_store.clear
-          @record_index.values.each(&:clear)
+          @record_index.each_value(&:clear)
         end
 
         private

data/lib/sequent/core/projector.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'helpers/message_handler'
-require_relative './persistors/active_record_persistor'
+require_relative 'persistors/active_record_persistor'
 
 module Sequent
   module Core

data/lib/sequent/core/snapshot_record.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require_relative 'sequent_oj'
+require_relative '../application_record'
+
+module Sequent
+  module Core
+    class SnapshotRecord < Sequent::ApplicationRecord
+      include SerializesEvent
+
+      self.primary_key = %i[aggregate_id sequence_number]
+      self.table_name = 'snapshot_records'
+
+      belongs_to :stream_record, foreign_key: :aggregate_id, primary_key: :aggregate_id
+
+      validates_presence_of :aggregate_id, :sequence_number, :snapshot_json, :stream_record
+      validates_numericality_of :sequence_number, only_integer: true, greater_than: 0
+
+      private
+
+      def event_type
+        snapshot_type
+      end
+
+      def event_type=(type)
+        self.snapshot_type = type
+      end
+
+      def event_json
+        snapshot_json
+      end
+
+      def event_json=(json)
+        self.snapshot_json = json
+      end
+
+      def serialize_json?
+        json_column_type = self.class.columns_hash['snapshot_json'].sql_type_metadata.type
+        %i[json jsonb].exclude? json_column_type
+      end
+    end
+  end
+end

data/lib/sequent/core/snapshot_store.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require_relative 'sequent_oj'
+require_relative 'helpers/pgsql_helpers'
+
+module Sequent
+  module Core
+    module SnapshotStore
+      include Helpers::PgsqlHelpers
+
+      def store_snapshots(snapshots)
+        json = Sequent::Core::Oj.dump(
+          snapshots.map do |snapshot|
+            {
+              aggregate_id: snapshot.aggregate_id,
+              sequence_number: snapshot.sequence_number,
+              created_at: snapshot.created_at,
+              snapshot_type: snapshot.class.name,
+              snapshot_json: snapshot,
+            }
+          end,
+        )
+
+        call_procedure(connection, 'store_snapshots', [json])
+      end
+
+      def load_latest_snapshot(aggregate_id)
+        snapshot_hash = query_function(connection, 'load_latest_snapshot', [aggregate_id]).first
+        deserialize_event(snapshot_hash) unless snapshot_hash['aggregate_id'].nil?
+      end
+
+      # Deletes all snapshots for all aggregates
+      def delete_all_snapshots
+        call_procedure(connection, 'delete_all_snapshots', [Time.now])
+      end
+
+      # Deletes all snapshots for aggregate_id with a sequence_number lower than the specified sequence number.
+      def delete_snapshots_before(aggregate_id, sequence_number)
+        call_procedure(connection, 'delete_snapshots_before', [aggregate_id, sequence_number, Time.now])
+      end
+
+      # Marks an aggregate for snapshotting. Marked aggregates will be
+      # picked up by the background snapshotting task. Another way to
+      # mark aggregates for snapshotting is to pass the
+      # +EventStream#snapshot_outdated_at+ property to the
+      # +#store_events+ method as is done automatically by the
+      # +AggregateRepository+ based on the aggregate's
+      # +snapshot_threshold+.
+      def mark_aggregate_for_snapshotting(aggregate_id, snapshot_outdated_at: Time.now)
+        connection.exec_update(<<~EOS, 'mark_aggregate_for_snapshotting', [aggregate_id, snapshot_outdated_at])
+          INSERT INTO aggregates_that_need_snapshots AS row (aggregate_id, snapshot_outdated_at)
+          VALUES ($1, $2)
+              ON CONFLICT (aggregate_id) DO UPDATE
+             SET snapshot_outdated_at = LEAST(row.snapshot_outdated_at, EXCLUDED.snapshot_outdated_at),
+                 snapshot_scheduled_at = NULL
+        EOS
+      end
+
+      # Stops snapshotting the specified aggregate. Any existing
+      # snapshots for this aggregate are also deleted.
+      def clear_aggregate_for_snapshotting(aggregate_id)
+        connection.exec_update(
+          'DELETE FROM aggregates_that_need_snapshots WHERE aggregate_id = $1',
+          'clear_aggregate_for_snapshotting',
+          [aggregate_id],
+        )
+      end
+
+      # Stops snapshotting all aggregates where the last event
+      # occurred before the indicated timestamp. Any existing
+      # snapshots for this aggregate are also deleted.
+      def clear_aggregates_for_snapshotting_with_last_event_before(timestamp)
+        connection.exec_update(<<~EOS, 'clear_aggregates_for_snapshotting_with_last_event_before', [timestamp])
+          DELETE FROM aggregates_that_need_snapshots s
+           WHERE NOT EXISTS (SELECT *
+                               FROM aggregates a
+                               JOIN events e ON (a.aggregate_id, a.events_partition_key) = (e.aggregate_id, e.partition_key)
+                              WHERE a.aggregate_id = s.aggregate_id AND e.created_at >= $1)
+        EOS
+      end
+
+      ##
+      # Returns the ids of aggregates that need a new snapshot.
+      #
+      def aggregates_that_need_snapshots(last_aggregate_id, limit = 10)
+        query_function(
+          connection,
+          'aggregates_that_need_snapshots',
+          [last_aggregate_id, limit],
+          columns: ['aggregate_id'],
+        )
+          .pluck('aggregate_id')
+      end
+
+      def select_aggregates_for_snapshotting(limit:, reschedule_snapshots_scheduled_before: nil)
+        query_function(
+          connection,
+          'select_aggregates_for_snapshotting',
+          [limit, reschedule_snapshots_scheduled_before, Time.now],
+          columns: ['aggregate_id'],
+        ).pluck('aggregate_id')
+      end
+    end
+  end
+end

data/lib/sequent/core/stream_record.rb

@@ -4,38 +4,33 @@ require 'active_record'
 
 module Sequent
   module Core
-    class EventStream
-      attr_accessor :aggregate_type, :aggregate_id, :snapshot_threshold, :stream_record_id
-
-      def initialize(aggregate_type:, aggregate_id:, snapshot_threshold: nil, stream_record_id: nil)
-        @aggregate_type = aggregate_type
-        @aggregate_id = aggregate_id
-        @snapshot_threshold = snapshot_threshold
-        @stream_record_id = stream_record_id
+    EventStream = Data.define(:aggregate_type, :aggregate_id, :events_partition_key, :snapshot_outdated_at) do
+      def initialize(aggregate_type:, aggregate_id:, events_partition_key: '', snapshot_outdated_at: nil)
+        super
       end
     end
 
     class StreamRecord < Sequent::ApplicationRecord
+      self.primary_key = %i[aggregate_id]
       self.table_name = 'stream_records'
+      self.ignored_columns = %w[snapshot_threshold]
 
       validates_presence_of :aggregate_type, :aggregate_id
-      validates_numericality_of :snapshot_threshold, only_integer: true, greater_than: 0, allow_nil: true
 
-      has_many :event_records
+      has_many :event_records, foreign_key: :aggregate_id, primary_key: :aggregate_id
 
       def event_stream
         EventStream.new(
-          aggregate_type: aggregate_type,
-          aggregate_id: aggregate_id,
-          snapshot_threshold: snapshot_threshold,
-          stream_record_id: id,
+          aggregate_type:,
+          aggregate_id:,
+          events_partition_key:,
         )
       end
 
       def event_stream=(data)
         self.aggregate_type = data.aggregate_type
         self.aggregate_id = data.aggregate_id
-        self.snapshot_threshold = data.snapshot_threshold
+        self.events_partition_key = data.events_partition_key
       end
     end
   end

data/lib/sequent/dry_run/read_only_replay_optimized_postgres_persistor.rb

@@ -15,7 +15,7 @@ module Sequent
         # Running in dryrun mode, not committing anything.
         ending = Process.clock_gettime(Process::CLOCK_MONOTONIC)
         elapsed = ending - @starting
-        count = @record_store.values.map(&:size).sum
+        count = @record_store.values.sum(&:size)
         Sequent.logger.info(
           "dryrun: processed #{count} records in #{elapsed.round(2)} s (#{(count / elapsed).round(2)} records/s)",
         )

data/lib/sequent/dry_run/view_schema.rb

@@ -9,7 +9,7 @@ module Sequent
     # This migration does not insert anything into the database, mainly usefull
     # for performance testing migrations.
     class ViewSchema < Migrations::ViewSchema
-      def migrate_dryrun(regex:, group_exponent: 3, limit: nil, offset: nil)
+      def migrate_dryrun(regex:)
         persistor = DryRun::ReadOnlyReplayOptimizedPostgresPersistor.new
 
         projectors = Sequent::Core::Migratable.all.select { |p| p.replay_persistor.nil? && p.name.match(regex || /.*/) }
@@ -17,8 +17,7 @@ module Sequent
           Sequent.logger.info "Dry run using the following projectors: #{projectors.map(&:name).join(', ')}"
 
           starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-          groups = groups(group_exponent: group_exponent, limit: limit, offset: offset)
-          replay!(persistor, projectors: projectors, groups: groups)
+          replay!(persistor, projectors:)
           ending = Process.clock_gettime(Process::CLOCK_MONOTONIC)
 
           Sequent.logger.info("Done migrate_dryrun for version #{Sequent.new_version} in #{ending - starting} s")

data/lib/sequent/generator/project.rb

@@ -12,9 +12,10 @@ module Sequent
       end
 
       def execute
+        fail TargetAlreadyExists if File.exist?(path)
+
         make_directory
         copy_files
-        rename_ruby_version
         rename_app_file
         replace_app_name
       end
@@ -27,12 +28,9 @@ module Sequent
 
       def copy_files
         FileUtils.copy_entry(File.expand_path('template_project', __dir__), path)
-      end
-
-      # Hidden files are by default excluded from gem build.
-      # Therefor we need to rename the ruby-version to .ruby-version.
-      def rename_ruby_version
-        FileUtils.mv("#{path}/ruby-version", "#{path}/.ruby-version")
+        ['.ruby-version', 'db'].each do |file|
+          FileUtils.copy_entry(File.expand_path("../../../#{file}", __dir__), "#{path}/#{file}")
+        end
       end
 
       def rename_app_file

data/lib/sequent/generator/template_aggregate/template_aggregate/commands.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 class AddTemplateAggregate < Sequent::Command
 end

data/lib/sequent/generator/template_aggregate/template_aggregate/events.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 class TemplateAggregateAdded < Sequent::Event
 end

data/lib/sequent/generator/template_aggregate/template_aggregate/template_aggregate.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class TemplateAggregate < Sequent::AggregateRoot
   def initialize(command)
     super(command.aggregate_id)

data/lib/sequent/generator/template_aggregate/template_aggregate/template_aggregate_command_handler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class TemplateAggregateCommandHandler < Sequent::CommandHandler
   on AddTemplateAggregate do |command|
     repository.add_aggregate TemplateAggregate.new(command)

data/lib/sequent/generator/template_aggregate/template_aggregate.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'template_aggregate/commands'
 require_relative 'template_aggregate/events'
 require_relative 'template_aggregate/template_aggregate'

data/lib/sequent/generator/template_project/Gemfile

@@ -1,10 +1,13 @@
-source "https://rubygems.org"
-ruby file: ".ruby-version"
+# frozen_string_literal: true
 
+source 'https://rubygems.org'
+ruby file: '.ruby-version'
+
+gem 'csv'
 gem 'rake'
-gem 'sequent'
+gem 'sequent', '>= 8'
 
 group :test do
-  gem 'rspec'
   gem 'database_cleaner'
+  gem 'rspec'
 end

data/lib/sequent/generator/template_project/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ENV['SEQUENT_ENV'] ||= 'development'
 
 require './my_app'
@@ -5,8 +7,8 @@ require 'sequent/rake/migration_tasks'
 
 Sequent::Rake::MigrationTasks.new.register_tasks!
 
-task "sequent:migrate:init" => [:db_connect]
+task 'sequent:migrate:init' => [:db_connect]
 
-task "db_connect" do
+task 'db_connect' do
   Sequent::Support::Database.connect!(ENV['SEQUENT_ENV'])
 end

data/lib/sequent/generator/template_project/app/projectors/post_projector.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../records/post_record'
 require_relative '../../lib/post/events'
 

data/lib/sequent/generator/template_project/app/records/post_record.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 class PostRecord < Sequent::ApplicationRecord
 end

data/lib/sequent/generator/template_project/config/initializers/sequent.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require './db/migrations'
 
 Sequent.configure do |config|

data/lib/sequent/generator/template_project/db/migrations.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sequent/migrations/projectors'
 
 VIEW_SCHEMA_VERSION = 1
@@ -9,9 +11,7 @@ class Migrations < Sequent::Migrations::Projectors
 
   def self.versions
     {
-      '1' => [
-        PostProjector
-      ]
+      '1' => [PostProjector],
     }
   end
 end

data/lib/sequent/generator/template_project/lib/post/commands.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class AddPost < Sequent::Command
   attrs author: String, title: String, content: String
   validates_presence_of :author, :title, :content

data/lib/sequent/generator/template_project/lib/post/events.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class PostAdded < Sequent::Event
 end
 

data/lib/sequent/generator/template_project/lib/post/post.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Post < Sequent::AggregateRoot
   def initialize(command)
     super(command.aggregate_id)

data/lib/sequent/generator/template_project/lib/post/post_command_handler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class PostCommandHandler < Sequent::CommandHandler
   on AddPost do |command|
     repository.add_aggregate Post.new(command)

data/lib/sequent/generator/template_project/lib/post.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'post/commands'
 require_relative 'post/events'
 require_relative 'post/post'

data/lib/sequent/generator/template_project/my_app.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sequent'
 require 'sequent/support'
 require 'erb'
@@ -7,5 +9,4 @@ require_relative 'app/projectors/post_projector'
 require_relative 'config/initializers/sequent'
 
 module MyApp
-
 end

data/lib/sequent/generator/template_project/spec/app/projectors/post_projector_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require_relative '../../../app/projectors/post_projector'
 

data/lib/sequent/generator/template_project/spec/lib/post/post_command_handler_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require_relative '../../../lib/post'
 
@@ -9,12 +11,17 @@ describe PostCommandHandler do
   end
 
   it 'creates a post' do
-    when_command AddPost.new(aggregate_id: aggregate_id, author: 'ben', title: 'My first blogpost', content: 'Hello World!')
+    when_command AddPost.new(
+      aggregate_id: aggregate_id,
+      author: 'ben',
+      title: 'My first blogpost',
+      content: 'Hello World!',
+    )
     then_events(
       PostAdded.new(aggregate_id: aggregate_id, sequence_number: 1),
       PostAuthorChanged.new(aggregate_id: aggregate_id, sequence_number: 2, author: 'ben'),
       PostTitleChanged,
-      PostContentChanged
+      PostContentChanged,
     )
   end
 end