sequent 5.0.0 → 6.0.0

data/lib/sequent/migrations/view_schema.rb

@@ -79,6 +79,29 @@ module Sequent
 
       attr_reader :view_schema, :db_config, :logger
 
+      class << self
+        # @see #create_view_tables
+        # @param env [String] The environment used for connecting the database
+        def create_view_tables(env:)
+          fail ArgumentError, 'env is required' if env.blank?
+
+          db_config = Sequent::Support::Database.read_config(env)
+          Sequent::Support::Database.establish_connection(db_config)
+          new(db_config: db_config).create_view_tables
+        end
+
+        # @see #create_view_schema_if_not_exists
+        # @param env [String] The environment used for connecting the database
+        def create_view_schema_if_not_exists(env:)
+          fail ArgumentError, 'env is required' if env.blank?
+
+          db_config = Sequent::Support::Database.read_config(env)
+          Sequent::Support::Database.establish_connection(db_config)
+
+          new(db_config: db_config).create_view_schema_if_not_exists
+        end
+      end
+
       def initialize(db_config:)
         @db_config = db_config
         @view_schema = Sequent.configuration.view_schema_name
@@ -98,6 +121,9 @@ module Sequent
       # the entire view schema without replaying the events
       def create_view_tables
         create_view_schema_if_not_exists
+        return if Sequent.migration_class == Sequent::Migrations::Projectors
+        return if Sequent.new_version == current_version
+
         in_view_schema do
           Sequent::Core::Migratable.all.flat_map(&:managed_tables).each do |table|
             sql_file = "#{Sequent.configuration.migration_sql_files_directory}/#{table.table_name}.sql"
@@ -112,6 +138,7 @@ module Sequent
               statements.each(&method(:exec_sql))
             end
           end
+          Versions.create!(version: Sequent.new_version)
         end
       end
 
@@ -119,8 +146,12 @@ module Sequent
       # Utility method that replays events for all managed_tables from all Sequent::Core::Projector's
       #
       # This method is mainly useful in test scenario's or development tasks
-      def replay_all!
-        replay!(Sequent.configuration.online_replay_persistor_class.new)
+      def replay_all!(group_exponent: 1)
+        replay!(
+          Sequent.configuration.online_replay_persistor_class.new,
+          projectors: Core::Migratable.projectors,
+          group_exponent: group_exponent,
+        )
       end
 
       ##
@@ -158,6 +189,8 @@ module Sequent
       #   These tables will be called `table_name_VERSION`.
       # 3. Replay all events to populate the tables
       #   It keeps track of all events that are already replayed.
+      # 4. Resets the table names of the activerecord models (projections)
+      #   back to their original values (so without the VERSION suffix)
       #
       # If anything fails an exception is raised and everything is rolled back
       #
@@ -178,6 +211,7 @@ module Sequent
         in_view_schema do
           executor.create_indexes_after_execute_online(plan)
         end
+        executor.reset_table_names(plan)
         # rubocop:disable Lint/RescueException
       rescue Exception => e
         # rubocop:enable Lint/RescueException
@@ -391,7 +425,9 @@ module Sequent
             .where("NOT EXISTS (SELECT 1 FROM #{ReplayedIds.table_name} WHERE event_id = event_records.id)")
         end
         event_stream = event_stream.where('event_records.created_at > ?', 1.day.ago) if exclude_already_replayed
-        event_stream.order('sequence_number ASC').select('id, event_type, event_json, sequence_number')
+        event_stream
+          .order('aggregate_id ASC, sequence_number ASC')
+          .select('id, event_type, event_json, sequence_number')
       end
 
       ## shortcut methods

data/lib/sequent/rake/migration_tasks.rb

@@ -6,6 +6,7 @@ require 'rake/tasklib'
 
 require 'sequent/support'
 require 'sequent/migrations/view_schema'
+require 'sequent/migrations/sequent_schema'
 
 module Sequent
   module Rake
@@ -15,24 +16,35 @@ module Sequent
       def register_tasks!
         namespace :sequent do
           desc <<~EOS
-            Rake task that runs before all sequent rake tasks. Hook applications can use to for instance run other rake tasks.
+            Set the SEQUENT_ENV to RAILS_ENV or RACK_ENV if not already set
           EOS
-          task :init
+          task :set_env_var do
+            ENV['SEQUENT_ENV'] ||= ENV['RAILS_ENV'] || ENV['RACK_ENV']
+          end
+
+          desc <<~EOS
+            Rake task that runs before all sequent rake tasks and after the environment is set.
+            Hook applications can use to for instance run other rake tasks:
+
+              Rake::Task['sequent:init'].enhance(['my_task'])
+
+          EOS
+          task init: :set_env_var
 
           namespace :db do
             desc 'Creates the database and initializes the event_store schema for the current env'
             task create: ['sequent:init'] do
-              ensure_rack_env_set!
+              ensure_sequent_env_set!
 
               db_config = Sequent::Support::Database.read_config(@env)
               Sequent::Support::Database.create!(db_config)
 
-              create_event_store(db_config)
+              Sequent::Migrations::SequentSchema.create_sequent_schema_if_not_exists(env: @env, fail_if_exists: true)
             end
 
             desc 'Drops the database for the current env'
             task :drop, [:production] => ['sequent:init'] do |_t, args|
-              ensure_rack_env_set!
+              ensure_sequent_env_set!
 
               if @env == 'production' && args[:production] != 'yes_drop_production'
                 fail <<~OES
@@ -46,39 +58,30 @@ module Sequent
 
             desc 'Creates the view schema for the current env'
             task create_view_schema: ['sequent:init'] do
-              ensure_rack_env_set!
+              ensure_sequent_env_set!
 
-              db_config = Sequent::Support::Database.read_config(@env)
-              Sequent::Support::Database.establish_connection(db_config)
-              Sequent::Migrations::ViewSchema.new(db_config: db_config).create_view_schema_if_not_exists
+              Sequent::Migrations::ViewSchema.create_view_schema_if_not_exists(env: @env)
             end
 
             desc 'Creates the event_store schema for the current env'
             task create_event_store: ['sequent:init'] do
-              ensure_rack_env_set!
-              db_config = Sequent::Support::Database.read_config(@env)
-              create_event_store(db_config)
+              ensure_sequent_env_set!
+              Sequent::Migrations::SequentSchema.create_sequent_schema_if_not_exists(env: @env, fail_if_exists: true)
             end
 
-            # rubocop:disable Lint/NestedMethodDefinition
-            def create_event_store(db_config)
-              event_store_schema = Sequent.configuration.event_store_schema_name
-              sequent_schema = File.join(Sequent.configuration.database_schema_directory, "#{event_store_schema}.rb")
-              unless File.exist?(sequent_schema)
-                fail "File #{sequent_schema} does not exist. Check your Sequent configuration."
-              end
+            desc 'Utility tasks that can be used to guard against unsafe usage of rails db:migrate directly'
+            task :dont_use_db_migrate_directly do
+              fail <<~EOS unless ENV['SEQUENT_MIGRATION_SCHEMAS'].present?
+                Don't call rails db:migrate directly but wrap in your own task instead:
 
-              Sequent::Support::Database.establish_connection(db_config)
-              if Sequent::Support::Database.schema_exists?(event_store_schema)
-                fail "Schema #{event_store_schema} already exists in the database"
-              end
+                  task :migrate_db do
+                    ENV['SEQUENT_MIGRATION_SCHEMAS'] = 'public'
+                    Rake::Task['db:migrate'].invoke
+                  end
 
-              Sequent::Support::Database.create_schema(event_store_schema)
-              Sequent::Support::Database.with_schema_search_path(event_store_schema, db_config, @env) do
-                load(sequent_schema)
-              end
+                You can choose whatever name for migrate_db you like.
+              EOS
             end
-            # rubocop:enable Lint/NestedMethodDefinition
           end
 
           namespace :migrate do
@@ -89,7 +92,7 @@ module Sequent
 
             desc 'Prints the current version in the database'
             task current_version: ['sequent:init', :init] do
-              ensure_rack_env_set!
+              ensure_sequent_env_set!
 
               Sequent::Support::Database.connect!(@env)
 
@@ -100,7 +103,7 @@ module Sequent
               Migrates the Projectors while the app is running. Call +sequent:migrate:offline+ after this successfully completed.
             EOS
             task online: ['sequent:init', :init] do
-              ensure_rack_env_set!
+              ensure_sequent_env_set!
 
               db_config = Sequent::Support::Database.read_config(@env)
               view_schema = Sequent::Migrations::ViewSchema.new(db_config: db_config)
@@ -112,7 +115,7 @@ module Sequent
               Migrates the events inserted while +online+ was running. It is expected +sequent:migrate:online+ ran first.
             EOS
             task offline: ['sequent:init', :init] do
-              ensure_rack_env_set!
+              ensure_sequent_env_set!
 
               db_config = Sequent::Support::Database.read_config(@env)
               view_schema = Sequent::Migrations::ViewSchema.new(db_config: db_config)
@@ -160,8 +163,8 @@ module Sequent
       private
 
       # rubocop:disable Naming/MemoizedInstanceVariableName
-      def ensure_rack_env_set!
-        @env ||= ENV['RACK_ENV'] || fail('RACK_ENV not set')
+      def ensure_sequent_env_set!
+        @env ||= ENV['SEQUENT_ENV'] || fail('SEQUENT_ENV not set')
       end
       # rubocop:enable Naming/MemoizedInstanceVariableName
     end

data/lib/sequent/support/database.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'erb'
 require 'active_support/hash_with_indifferent_access'
 
 module Sequent
@@ -30,17 +31,37 @@ module Sequent
       end
 
       def self.create!(db_config)
-        ActiveRecord::Base.establish_connection(db_config.merge(database: 'postgres'))
-        ActiveRecord::Base.connection.create_database(db_config[:database])
+        establish_connection(db_config, {database: 'postgres'})
+        ActiveRecord::Base.connection.create_database(get_db_config_attribute(db_config, :database))
       end
 
       def self.drop!(db_config)
-        ActiveRecord::Base.establish_connection(db_config.merge(database: 'postgres'))
-        ActiveRecord::Base.connection.drop_database(db_config[:database])
+        establish_connection(db_config, {database: 'postgres'})
+        ActiveRecord::Base.connection.drop_database(get_db_config_attribute(db_config, :database))
       end
 
-      def self.establish_connection(db_config)
-        ActiveRecord::Base.establish_connection(db_config)
+      def self.get_db_config_attribute(db_config, attribute)
+        if Sequent.configuration.can_use_multiple_databases?
+          db_config[Sequent.configuration.primary_database_key][attribute]
+        else
+          db_config[attribute]
+        end
+      end
+
+      def self.establish_connection(db_config, db_config_overrides = {})
+        if Sequent.configuration.can_use_multiple_databases?
+          db_config = db_config.deep_merge(
+            Sequent.configuration.primary_database_key => db_config_overrides,
+          ).stringify_keys
+          ActiveRecord.legacy_connection_handling = false
+          ActiveRecord::Base.configurations = db_config.stringify_keys
+          ActiveRecord::Base.connects_to database: {
+            Sequent.configuration.primary_database_role => Sequent.configuration.primary_database_key,
+          }
+        else
+          db_config = db_config.merge(db_config_overrides)
+          ActiveRecord::Base.establish_connection(db_config)
+        end
       end
 
       def self.disconnect!
@@ -62,25 +83,20 @@ module Sequent
         execute_sql "DROP SCHEMA if exists #{schema_name} cascade"
       end
 
-      def self.with_schema_search_path(search_path, db_config, env = ENV['RACK_ENV'])
+      def self.with_schema_search_path(search_path, db_config, env = ENV['SEQUENT_ENV'])
         fail ArgumentError, 'env is required' unless env
 
         disconnect!
-        original_search_paths = db_config[:schema_search_path].dup
 
         if ActiveRecord::VERSION::MAJOR < 6
           ActiveRecord::Base.configurations[env.to_s] =
             ActiveSupport::HashWithIndifferentAccess.new(db_config).stringify_keys
         end
 
-        db_config[:schema_search_path] = search_path
-
-        ActiveRecord::Base.establish_connection db_config
-
+        establish_connection(db_config, {schema_search_path: search_path})
         yield
       ensure
         disconnect!
-        db_config[:schema_search_path] = original_search_paths
         establish_connection(db_config)
       end
 

data/lib/sequent/test/command_handler_helpers.rb

@@ -125,7 +125,7 @@ module Sequent
         def aggregate_type_for_event(event)
           @event_to_aggregate_type ||= ThreadSafe::Cache.new
           @event_to_aggregate_type.fetch_or_store(event.class) do |klass|
-            Sequent::Core::AggregateRoots.all.find { |x| x.message_mapping.key?(klass) }
+            Sequent::Core::AggregateRoot.descendants.find { |x| x.message_mapping.key?(klass) }
           end
         end
 

data/lib/sequent/test/database_helpers.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Sequent
+  module Test
+    module DatabaseHelpers
+      ALLOWED_ENVS = %w[development test spec].freeze
+
+      class << self
+        # Utility method to let Sequent handle creation of sequent_schema and view_schema
+        # rather than using the available rake tasks.
+        def maintain_test_database_schema(env: 'test')
+          fail ArgumentError, "env must one of [#{ALLOWED_ENVS.join(',')}] '#{env}'" unless ALLOWED_ENVS.include?(env)
+
+          Migrations::SequentSchema.create_sequent_schema_if_not_exists(env: env, fail_if_exists: false)
+          Migrations::ViewSchema.create_view_tables(env: env)
+        end
+      end
+    end
+  end
+end

data/lib/sequent/test/time_comparison.rb

@@ -17,11 +17,8 @@ module Sequent
         # omit nsec in datetime comparisons
         def <=>(other)
           if other&.is_a?(DateTimePatches::Normalize)
-            result = normalize.iso8601 <=> other.normalize.iso8601
-            return result unless result == 0
-
-            # use usec here, which *truncates* the nsec (ie. like Postgres)
-            return normalize.usec <=> other.normalize.usec
+            precision = Sequent.configuration.time_precision
+            return normalize.iso8601(precision) <=> other.normalize.iso8601(precision)
           end
           public_send(:'___<=>', other)
         end

data/lib/sequent/test/{event_handler_helpers.rb → workflow_helpers.rb}

@@ -5,7 +5,7 @@ module Sequent
     ##
     # Use in tests
     #
-    # This provides a nice DSL for testing your event handlers.
+    # This provides a nice DSL for testing your Workflows.
     # E.g.
     #
     # when_event UserWasRegistered.new(args)
@@ -14,12 +14,15 @@ module Sequent
     # Example for Rspec config
     #
     # RSpec.configure do |config|
-    #   config.include Sequent::Test::WorkflowHelpers
+    #   config.include Sequent::Test::WorkflowHelpers, workflows: true
     # end
     #
-    # Then in a spec
+    # Please note that you **must** add the metadata tag `workflows` since
+    # the WorkflowHelpers will use a `FakeCommandService` to track
+    # the commands enqueued for execution. You can set the metadata
+    # on group level or on an individual spec.
     #
-    # describe SendWelcomeMailWorkflow do
+    # describe SendWelcomeMailWorkflow, workflows: true do
     #   let(:workflow) { SendWelcomeMailWorkflow.new }
     #
     #   it "sends a welcome mail" do
@@ -75,7 +78,9 @@ module Sequent
       end
 
       def when_event(event)
-        workflow.handle_message event
+        fake_transaction_provider.transactional do
+          workflow.handle_message event
+        end
       end
 
       def then_commands(*commands)
@@ -86,13 +91,22 @@ module Sequent
       end
 
       def self.included(spec)
+        fail "Missing metadata argument `workflows: true` when including #{name}" unless spec.metadata[:workflows]
+
         spec.let(:fake_command_service) { FakeCommandService.new }
         spec.let(:fake_transaction_provider) { FakeTransactionProvider.new }
-        spec.before do
-          Sequent.configure do |c|
-            c.command_service = fake_command_service
-            c.transaction_provider = fake_transaction_provider
-          end
+        spec.let(:old_config) { Sequent.configuration }
+        spec.before :each, :workflows do
+          new_config = old_config.dup
+
+          new_config.command_service = fake_command_service
+          new_config.transaction_provider = fake_transaction_provider
+
+          Sequent::Configuration.restore(new_config)
+        end
+
+        spec.after :each, :workflows do
+          Sequent::Configuration.restore(old_config)
         end
       end
     end

data/lib/sequent/test.rb

@@ -3,4 +3,5 @@
 require_relative 'sequent'
 require_relative 'test/command_handler_helpers'
 require_relative 'test/event_stream_helpers'
-require_relative 'test/event_handler_helpers'
+require_relative 'test/workflow_helpers'
+require_relative 'test/database_helpers'

data/lib/sequent/util/dry_run.rb

@@ -66,7 +66,7 @@ module Sequent
         end
 
         def process_event(event)
-          [*Sequent::Core::Workflows.all, *Sequent::Core::Projectors.all].each do |handler_class|
+          [*Sequent::Core::Workflow.descendants, *Sequent::Core::Projector.descendants].each do |handler_class|
             next unless handler_class.handles_message?(event)
 
             if handler_class < Sequent::Workflow

data/lib/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sequent
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Lars Vonk
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-16 00:00:00.000000000 Z
+date: 2023-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -119,7 +119,7 @@ dependencies:
         version: 2.6.5
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
   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.2'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -304,7 +304,7 @@ email:
 - bforma@zilverline.com
 - erozendaal@zilverline.com
 - mvdiepen@zilverline.com
-- svdiepen@zilverline.com
+- stephan@vandiepen.info
 executables:
 - sequent
 extensions: []
@@ -370,9 +370,12 @@ files:
 - lib/sequent/core/helpers/string_support.rb
 - lib/sequent/core/helpers/string_to_value_parsers.rb
 - lib/sequent/core/helpers/string_validator.rb
+- lib/sequent/core/helpers/time_validator.rb
 - lib/sequent/core/helpers/type_conversion_support.rb
 - lib/sequent/core/helpers/uuid_helper.rb
 - lib/sequent/core/helpers/value_validators.rb
+- lib/sequent/core/middleware/chain.rb
+- lib/sequent/core/middleware/middleware.rb
 - lib/sequent/core/persistors/active_record_persistor.rb
 - lib/sequent/core/persistors/persistor.rb
 - lib/sequent/core/persistors/persistors.rb
@@ -425,10 +428,10 @@ files:
 - lib/sequent/migrations/migrations.rb
 - lib/sequent/migrations/planner.rb
 - lib/sequent/migrations/projectors.rb
+- lib/sequent/migrations/sequent_schema.rb
 - lib/sequent/migrations/sql.rb
 - lib/sequent/migrations/view_schema.rb
 - lib/sequent/rake/migration_tasks.rb
-- lib/sequent/rake/tasks.rb
 - lib/sequent/sequent.rb
 - lib/sequent/support.rb
 - lib/sequent/support/database.rb
@@ -436,9 +439,10 @@ files:
 - lib/sequent/support/view_schema.rb
 - lib/sequent/test.rb
 - lib/sequent/test/command_handler_helpers.rb
-- lib/sequent/test/event_handler_helpers.rb
+- lib/sequent/test/database_helpers.rb
 - lib/sequent/test/event_stream_helpers.rb
 - lib/sequent/test/time_comparison.rb
+- lib/sequent/test/workflow_helpers.rb
 - lib/sequent/util/dry_run.rb
 - lib/sequent/util/printer.rb
 - lib/sequent/util/skip_if_already_processing.rb

data/lib/sequent/rake/tasks.rb

@@ -1,121 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_record'
-require 'rake'
-require 'rake/tasklib'
-
-require 'sequent/support'
-
-module Sequent
-  module Rake
-    class Tasks < ::Rake::TaskLib
-      include ::Rake::DSL
-
-      DEFAULT_OPTIONS = {
-        migrations_path: 'db/migrate',
-        event_store_schema: 'public',
-      }.freeze
-
-      attr_reader :options
-
-      def initialize(options)
-        super()
-        @options = DEFAULT_OPTIONS.merge(options)
-      end
-
-      def display_deprecation_warning
-        warn '[DEPRECATED] Sequent::Rake::Tasks is deprecated. Please use Sequent::Rake::MigrationTasks tasks instead.'
-      end
-
-      def register!
-        display_deprecation_warning
-
-        register_db_tasks!
-        register_view_schema_tasks!
-      end
-
-      def register_db_tasks!
-        namespace :db do
-          desc 'Create the database'
-          task :create do
-            display_deprecation_warning
-
-            current_environments.each do |env|
-              env_db = db_config(env)
-              puts "Create database #{env_db['database']}"
-              Sequent::Support::Database.create!(env_db)
-            end
-          end
-
-          desc 'Drop the database'
-          task :drop do
-            display_deprecation_warning
-
-            current_environments.each do |env|
-              env_db = db_config(env)
-              puts "Drop database #{env_db['database']}"
-              Sequent::Support::Database.drop!(env_db)
-            end
-          end
-
-          task :establish_connection do
-            env_db = db_config(options.fetch(:environment))
-            ActiveRecord::Base.establish_connection(env_db)
-          end
-
-          desc 'Migrate the database'
-          task migrate: :establish_connection do
-            display_deprecation_warning
-
-            database.create_schema!(options.fetch(:event_store_schema))
-            database.migrate(options.fetch(:migrations_path))
-          end
-        end
-      end
-
-      def register_view_schema_tasks!
-        namespace :view_schema do
-          desc 'Build the view schema'
-          task build: :'db:establish_connection' do
-            display_deprecation_warning
-
-            if database.schema_exists?(view_projection.schema_name)
-              puts "View version #{view_projection.version} already exists; no need to build it"
-            else
-              database.create_schema!(view_projection.schema_name)
-              view_projection.build!
-            end
-          end
-
-          desc 'Drop the view schema'
-          task drop: :'db:establish_connection' do
-            display_deprecation_warning
-
-            database.drop_schema!(view_projection.schema_name)
-          end
-        end
-      end
-
-      private
-
-      def current_environments
-        environment = options.fetch(:environment)
-        envs = [environment]
-        envs << 'test' if environment == 'development'
-        envs
-      end
-
-      def database
-        @database ||= Sequent::Support::Database.new
-      end
-
-      def db_config(environment)
-        options.fetch(:db_config_supplier)[environment] or fail "No database config for #{environment}"
-      end
-
-      def view_projection
-        options.fetch(:view_projection)
-      end
-    end
-  end
-end