sequent 6.0.1 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e420a9289f17d8552364afd49977cdb8cdbc0b37f39445a0a7ce310f9c1a180f
-  data.tar.gz: 116144ee36558de52bc381b8e99e13d44aad3bedda6d531b380d93b3d7b96445
+  metadata.gz: 2271f62c7221e3eb21eb7707ad2f7df52b9adeae3154c0856b860133af872457
+  data.tar.gz: dc3b99bc7c06957f98f5c45be5cff4082ae0d9cca493a9ea3431fc14eea67e08
 SHA512:
-  metadata.gz: 434eb99e05dda79479a8c8a6529a0d2b3bfa2fc3e02c7143ad314f27a2140d33c6a01f1d3d1a147892b1dafefcd899bed8bde9cbe3b0c76520f3561b5dfa2b05
-  data.tar.gz: 6fd8a9df8cac32aaad084fd2b472caab478c13840da563b8d3a8e8c9e1d86c32bfc3d43a7e8d7031386a36a127c9be6648d3baaa241dcfb45d92f3d7721a9d4d
+  metadata.gz: 150cff9d3a13c1b230dfb71f6897f740c1c4c5ac3448dbb0fd334858229ae1bf3ff67e1bdad897145e5bc0a2a5cd70a31a430e93939857ba753f2f9895a84fa1
+  data.tar.gz: ae8ae17080b36ed4b60f361aefb3d9b816b12b037f9eb4022c00969c2b9ce2c78cdfe6f4c67358d02c376ec37479d5951ad10e92944ba4b3e6b056b3fd8c2b5e

data/lib/sequent/configuration.rb

@@ -36,6 +36,7 @@ module Sequent
 
     attr_accessor :aggregate_repository,
                   :event_store,
+                  :event_store_cache_event_types,
                   :command_service,
                   :event_record_class,
                   :stream_record_class,
@@ -63,7 +64,8 @@ module Sequent
                   :enable_multiple_database_support,
                   :primary_database_role,
                   :primary_database_key,
-                  :time_precision
+                  :time_precision,
+                  :enable_autoregistration
 
     attr_reader :migrations_class_name,
                 :versions_table_name,
@@ -73,10 +75,13 @@ module Sequent
       @instance ||= new
     end
 
+    # Create a new instance of Configuration
     def self.reset
       @instance = new
     end
 
+    # Restore the given Configuration
+    # @param configuration [Sequent::Configuration]
     def self.restore(configuration)
       @instance = configuration
     end
@@ -88,6 +93,7 @@ module Sequent
       self.command_middleware = Sequent::Core::Middleware::Chain.new
 
       self.aggregate_repository = Sequent::Core::AggregateRepository.new
+      self.event_store_cache_event_types = true
       self.event_store = Sequent::Core::EventStore.new
       self.command_service = Sequent::Core::CommandService.new
       self.event_record_class = Sequent::Core::EventRecord
@@ -121,6 +127,8 @@ module Sequent
       self.primary_database_key = :primary
 
       self.time_precision = DEFAULT_TIME_PRECISION
+
+      self.enable_autoregistration = false
     end
 
     def can_use_multiple_databases?
@@ -149,5 +157,53 @@ module Sequent
 
       @migrations_class_name = class_name
     end
+
+    def autoregister!
+      return unless enable_autoregistration
+
+      # Only autoregister the AggregateSnapshotter if the autoregistration is enabled
+      Sequent::Core::AggregateSnapshotter.skip_autoregister = false
+
+      Rails.autoloaders.main.eager_load(force: true) if defined?(Rails)
+
+      self.class.instance.command_handlers ||= []
+      for_each_autoregisterable_descenant_of(Sequent::CommandHandler) do |command_handler_class|
+        Sequent.logger.debug("[Configuration] Autoregistering CommandHandler #{command_handler_class}")
+        self.class.instance.command_handlers << command_handler_class.new
+      end
+
+      self.class.instance.event_handlers ||= []
+      for_each_autoregisterable_descenant_of(Sequent::Projector) do |projector_class|
+        Sequent.logger.debug("[Configuration] Autoregistering Projector #{projector_class}")
+        self.class.instance.event_handlers << projector_class.new
+      end
+
+      for_each_autoregisterable_descenant_of(Sequent::Workflow) do |workflow_class|
+        Sequent.logger.debug("[Configuration] Autoregistering Workflow #{workflow_class}")
+        self.class.instance.event_handlers << workflow_class.new
+      end
+
+      self.class.instance.command_handlers.map(&:class).tally.each do |(clazz, count)|
+        if count > 1
+          fail "CommandHandler #{clazz} is registered #{count} times. A CommandHandler can only be registered once"
+        end
+      end
+
+      self.class.instance.event_handlers.map(&:class).tally.each do |(clazz, count)|
+        if count > 1
+          fail "EventHandler #{clazz} is registered #{count} times. An EventHandler can only be registered once"
+        end
+      end
+    end
+
+    private
+
+    def for_each_autoregisterable_descenant_of(clazz, &block)
+      clazz
+        .descendants
+        .reject(&:abstract_class)
+        .reject(&:skip_autoregister)
+        .each(&block)
+    end
   end
 end

data/lib/sequent/core/aggregate_repository.rb

@@ -79,8 +79,8 @@ module Sequent
           .configuration
           .event_store
           .stream_events_for_aggregate(aggregate_id, load_until: load_until) do |event_stream|
-          aggregate.stream_from_history(event_stream)
-        end
+            aggregate.stream_from_history(event_stream)
+          end
 
         if clazz
           fail TypeError, "#{aggregate.class} is not a #{clazz}" unless aggregate.class <= clazz

data/lib/sequent/core/aggregate_snapshotter.rb

@@ -15,6 +15,10 @@ module Sequent
     end
 
     class AggregateSnapshotter < BaseCommandHandler
+      # By default skip autoregistering this CommandHandler.
+      # The AggregateSnapshotter is only autoregistered if autoregistration is enabled.
+      self.skip_autoregister = true
+
       on SnapshotCommand do |command|
         aggregate_ids = Sequent.configuration.event_store.aggregates_that_need_snapshots(
           @last_aggregate_id,

data/lib/sequent/core/base_command_handler.rb

@@ -21,6 +21,11 @@ module Sequent
     class BaseCommandHandler
       include Sequent::Core::Helpers::UuidHelper
       include Sequent::Core::Helpers::MessageHandler
+      extend ActiveSupport::DescendantsTracker
+
+      class << self
+        attr_accessor :abstract_class, :skip_autoregister
+      end
 
       protected
 

data/lib/sequent/core/core.rb

@@ -16,7 +16,7 @@ require_relative 'projector'
 require_relative 'event_store'
 require_relative 'event_record'
 require_relative 'command_record'
-require_relative 'aggregate_snapshotter'
 require_relative 'workflow'
 require_relative 'random_uuid_generator'
 require_relative 'event_publisher'
+require_relative 'aggregate_snapshotter'

data/lib/sequent/core/event.rb

@@ -29,8 +29,8 @@ module Sequent
           .reject { |k| payload_variables.include?(k) }
           .select { |k| self.class.types.keys.include?(to_attribute_name(k)) }
           .each do |k|
-          result[k.to_s[1..-1].to_sym] = instance_variable_get(k)
-        end
+            result[k.to_s[1..-1].to_sym] = instance_variable_get(k)
+          end
         result
       end
 

data/lib/sequent/core/event_store.rb

@@ -35,14 +35,6 @@ module Sequent
         end
       end
 
-      def initialize(cache_event_types: true)
-        @event_types = if cache_event_types
-                         ThreadSafe::Cache.new
-                       else
-                         NoEventTypesCache.new
-                       end
-      end
-
       ##
       # Stores the events in the EventStore and publishes the events
       # to the registered event_handlers.
@@ -114,13 +106,13 @@ module Sequent
         events
           .group_by(&:aggregate_id)
           .map do |aggregate_id, es|
-          [
-            streams.find do |stream_record|
-              stream_record.aggregate_id == aggregate_id
-            end.event_stream,
-            es,
-          ]
-        end
+            [
+              streams.find do |stream_record|
+                stream_record.aggregate_id == aggregate_id
+              end.event_stream,
+              es,
+            ]
+          end
       end
 
       def aggregate_query(aggregate_id)
@@ -217,6 +209,14 @@ module Sequent
 
       private
 
+      def event_types
+        @event_types = if Sequent.configuration.event_store_cache_event_types
+                         ThreadSafe::Cache.new
+                       else
+                         NoEventTypesCache.new
+                       end
+      end
+
       def column_names
         @column_names ||= Sequent
           .configuration
@@ -238,7 +238,7 @@ module Sequent
       end
 
       def resolve_event_type(event_type)
-        @event_types.fetch_or_store(event_type) { |k| Class.const_get(k) }
+        event_types.fetch_or_store(event_type) { |k| Class.const_get(k) }
       end
 
       def publish_events(events)

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

@@ -79,8 +79,8 @@ module Sequent
                 super if defined?(super)
                 ensure_known_attributes(attrs)
                 #{@types.map do |attribute, _|
-                    "@#{attribute} = attrs[:#{attribute}]"
-                  end.join("\n            ")}
+                  "@#{attribute} = attrs[:#{attribute}]"
+                end.join("\n            ")}
                 self
               end
 EOS
@@ -89,8 +89,8 @@ EOS
                def update_all_attributes_from_json(attrs)
                  super if defined?(super)
                  #{@types.map do |attribute, type|
-                     "@#{attribute} = #{type}.deserialize_from_json(attrs['#{attribute}'])"
-                   end.join("\n           ")}
+                   "@#{attribute} = #{type}.deserialize_from_json(attrs['#{attribute}'])"
+                 end.join("\n           ")}
                end
 EOS
           end
@@ -206,10 +206,10 @@ EOS
               value
                 .select { |val| val.respond_to?(:validation_errors) }
                 .each_with_index do |val, index|
-                val.validation_errors.each do |k, v|
-                  result["#{field[0]}_#{index}_#{k}".to_sym] = v
+                  val.validation_errors.each do |k, v|
+                    result["#{field[0]}_#{index}_#{k}".to_sym] = v
+                  end
                 end
-              end
             end
           end
           prefix ? HashWithIndifferentAccess[result.map { |k, v| ["#{prefix}_#{k}", v] }] : result

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

@@ -12,7 +12,10 @@ module Sequent
         def dispatch_message(message)
           @message_router
             .match_message(message)
-            .each { |handler| @context.instance_exec(message, &handler) }
+            .each do |handler|
+              Sequent.logger.debug("[MessageDispatcher] Handler #{@context.class} handling #{message.class}")
+              @context.instance_exec(message, &handler)
+            end
         end
       end
     end

data/lib/sequent/core/projector.rb

@@ -88,6 +88,10 @@ module Sequent
       include Migratable
       extend ActiveSupport::DescendantsTracker
 
+      class << self
+        attr_accessor :abstract_class, :skip_autoregister
+      end
+
       def initialize(persistor = Sequent::Core::Persistors::ActiveRecordPersistor.new)
         ensure_valid!
         @persistor = persistor

data/lib/sequent/core/transactions/active_record_transaction_provider.rb

@@ -30,8 +30,9 @@ module Sequent
       #
       class ActiveRecordTransactionProvider
         def transactional(&block)
-          Sequent::ApplicationRecord.transaction(requires_new: true, &block)
+          result = Sequent::ApplicationRecord.transaction(requires_new: true, &block)
           after_commit_queue.pop.call until after_commit_queue.empty?
+          result
         ensure
           clear_after_commit_queue
         end

data/lib/sequent/core/workflow.rb

@@ -9,6 +9,10 @@ module Sequent
       include Helpers::MessageHandler
       extend ActiveSupport::DescendantsTracker
 
+      class << self
+        attr_accessor :abstract_class, :skip_autoregister
+      end
+
       def self.on(*args, **opts, &block)
         decorated_block = ->(event) do
           begin

data/lib/sequent/migrations/migrations.rb

@@ -5,7 +5,6 @@ module Sequent
   end
 end
 
-require_relative 'migrate_events'
 require_relative 'projectors'
 require_relative 'view_schema'
 require_relative 'functions'

data/lib/sequent/migrations/planner.rb

@@ -69,10 +69,10 @@ module Sequent
           .each_with_index
           .select { |migration, _index| migration.instance_of?(AlterTable) }
           .select do |migration, index|
-                       migrations
-                         .slice((index + 1)..-1)
-                         .find { |m| m.instance_of?(ReplayTable) && m.record_class == migration.record_class }
-                     end.map(&:first)
+            migrations
+              .slice((index + 1)..-1)
+              .find { |m| m.instance_of?(ReplayTable) && m.record_class == migration.record_class }
+          end.map(&:first)
       end
 
       def remove_redundancy(grouped_migrations)

data/lib/sequent/migrations/view_schema.rb

@@ -387,8 +387,8 @@ module Sequent
           unless ids.empty?
             exec_sql(
               "insert into #{ReplayedIds.table_name} (event_id) values #{ids.map do |id|
-                                                                           "(#{id})"
-                                                                         end.join(',')}",
+                "(#{id})"
+              end.join(',')}",
             )
           end
           Sequent::Core::EventStore::PRINT_PROGRESS[progress, done, ids] if progress > 0

data/lib/sequent/sequent.rb

@@ -22,21 +22,14 @@ module Sequent
   # A minimal setup could look like this:
   #
   #   Sequent.configure do |config|
-  #     config.event_handlers = [
-  #       MyProjector.new,
-  #       AnotherProjector.new,
-  #       MyWorkflow.new,
-  #     ]
-  #
-  #     config.command_handlers = [
-  #       MyCommandHandler.new,
-  #     ]
-  #
+  #     config.enable_autoregistration = true
   #   end
   #
-  #
+  # Calling configure a second time will create a new configuration
   def self.configure
+    Configuration.reset
     yield Configuration.instance
+    Configuration.instance.autoregister!
   end
 
   def self.configuration

data/lib/sequent/support/database.rb

@@ -53,7 +53,9 @@ module Sequent
           db_config = db_config.deep_merge(
             Sequent.configuration.primary_database_key => db_config_overrides,
           ).stringify_keys
-          ActiveRecord.legacy_connection_handling = false
+          if Gem.loaded_specs['activerecord'].version < Gem::Version.create('7.1.0')
+            ActiveRecord.legacy_connection_handling = false
+          end
           ActiveRecord::Base.configurations = db_config.stringify_keys
           ActiveRecord::Base.connects_to database: {
             Sequent.configuration.primary_database_role => Sequent.configuration.primary_database_key,

data/lib/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sequent
 version: !ruby/object:Gem::Version
-  version: 6.0.1
+  version: 7.0.0
 platform: ruby
 authors:
 - Lars Vonk
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-28 00:00:00.000000000 Z
+date: 2023-11-02 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: '7.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -33,7 +33,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.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: '7.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -53,7 +53,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: bcrypt
   requirement: !ruby/object:Gem::Requirement
@@ -430,7 +430,6 @@ files:
 - lib/sequent/generator/template_project/spec/spec_helper.rb
 - lib/sequent/migrations/executor.rb
 - lib/sequent/migrations/functions.rb
-- lib/sequent/migrations/migrate_events.rb
 - lib/sequent/migrations/migrations.rb
 - lib/sequent/migrations/planner.rb
 - lib/sequent/migrations/projectors.rb

data/lib/sequent/migrations/migrate_events.rb

@@ -1,67 +0,0 @@
-# frozen_string_literal: true
-
-##
-# When you need to upgrade the event store based on information of the previous schema version
-# this is the place you need to implement a migration.
-# Examples are: corrupt events (due to insufficient testing for instance...)
-# or adding extra events to the event stream if a new concept is introduced.
-#
-# To implement a migration you should create a class according to the following contract:
-# module Database
-#   class MigrateToVersionXXX
-#     def initialize(env)
-#       @env = env
-#     end
-#
-#     def migrate
-#       # your migration code here...
-#     end
-#   end
-# end
-#
-module Sequent
-  module Migrations
-    class MigrateEvents
-      ##
-      # @param env The string representing the current environment. E.g. "development", "production"
-      def initialize(env)
-        warn <<~EOS
-          [DEPRECATED] Use of MigrateEvents is deprecated and will be removed from future version. Please use Sequent::Migrations::ViewSchema instead. See the changelog on how to update.
-        EOS
-        @env = env
-      end
-
-      ##
-      #
-      # @param current_version The current version of the application. E.g. 10
-      # @param new_version The version to migrate to. E.g. 11
-      # @param &after_migration_block an optional block (with the current upgrade version as param)
-      #   to run after the migrations run. E.g. close resources
-      #
-      def execute_migrations(current_version, new_version)
-        migrations(current_version, new_version).each do |migration_class|
-          migration = migration_class.new(@env)
-          begin
-            migration.migrate
-          ensure
-            yield(migration.version) if block_given?
-          end
-        end
-      end
-
-      def migrations(current_version, new_version)
-        return [] if current_version == 0
-
-        ((current_version + 1)..new_version).map do |upgrade_to_version|
-          Class.const_get("Database::MigrateToVersion#{upgrade_to_version}")
-        rescue NameError
-          nil
-        end.compact
-      end
-
-      def has_migrations?(current_version, new_version)
-        migrations(current_version, new_version).any?
-      end
-    end
-  end
-end