sequent 5.0.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1dea4b53205452eaa68007ed47688b3fa074229677186e9342265cdd7a31d4db
-  data.tar.gz: 2d342b9a013372ca99b441c4980432f642a56741746291d814c68ad60cf6c26e
+  metadata.gz: 24d2ee32c038b179c4386d2df97025af873487c5fe333952e5fedbe5d3ed47d8
+  data.tar.gz: 8d0464ac057a6e458ee7f131caba027fbddbd751af5b9d4314907ed248d0734d
 SHA512:
-  metadata.gz: cea76a7429f29dcff3e73789f608c968030ade74446493effcf6cf6b51f39c3815da7e5ccc040cf0392a797a6978fa773b5f8f2791f907ebbb31830ab7ae56bc
-  data.tar.gz: e03569382132ffefabd44ebc973d78a2c1745291cf64ef17c0dc744bd513d5fe72c816a0cfb69da7297ddd076df81139a53058816f02bc215f58ad48c0b7bc67
+  metadata.gz: 5b064934ae367d2e57baaa081c0b3f392bb932a1bb12fed00db337a6365f32c0949e5c6c4fe3eae6fa4a1374d931db517cf33efa911fdc265883bb122e8ce6ab
+  data.tar.gz: b5570de3a8b9deb24c1006486c37166f6e17d06d23a30d38a9de9b1e0755f1cbf4e57e1a2c1890ff9a68908f2077e90d7f8d1e79240ae3c5943de23f185be6f1

data/bin/sequent

@@ -31,7 +31,7 @@ def new_project(args)
       bundle exec rake sequent:migrate:offline
 
     Run the example specs:
-      RACK_ENV=test bundle exec rake sequent:db:create
+      SEQUENT_ENV=test bundle exec rake sequent:db:create
       bundle exec rspec spec
 
     To generate new aggregates use:

data/db/sequent_schema.rb

@@ -1,7 +1,7 @@
 ActiveRecord::Schema.define do
 
   create_table "event_records", :force => true do |t|
-    t.string "aggregate_id", :null => false
+    t.uuid "aggregate_id", :null => false
     t.integer "sequence_number", :null => false
     t.datetime "created_at", :null => false
     t.string "event_type", :null => false
@@ -27,7 +27,7 @@ CREATE INDEX snapshot_events ON event_records (aggregate_id, sequence_number DES
 
   create_table "command_records", :force => true do |t|
     t.string "user_id"
-    t.string "aggregate_id"
+    t.uuid "aggregate_id"
     t.string "command_type", :null => false
     t.string "event_aggregate_id"
     t.integer "event_sequence_number"
@@ -40,7 +40,7 @@ CREATE INDEX snapshot_events ON event_records (aggregate_id, sequence_number DES
   create_table "stream_records", :force => true do |t|
     t.datetime "created_at", :null => false
     t.string "aggregate_type", :null => false
-    t.string "aggregate_id", :null => false
+    t.uuid "aggregate_id", :null => false
     t.integer "snapshot_threshold"
   end
 

data/lib/sequent/configuration.rb

@@ -32,6 +32,8 @@ module Sequent
 
     DEFAULT_ERROR_LOCALE_RESOLVER = -> { I18n.locale || :en }
 
+    DEFAULT_TIME_PRECISION = ActiveSupport::JSON::Encoding.time_precision
+
     attr_accessor :aggregate_repository,
                   :event_store,
                   :command_service,
@@ -43,6 +45,7 @@ module Sequent
                   :event_record_hooks_class,
                   :command_handlers,
                   :command_filters,
+                  :command_middleware,
                   :event_handlers,
                   :uuid_generator,
                   :disable_event_handlers,
@@ -56,7 +59,11 @@ module Sequent
                   :database_config_directory,
                   :database_schema_directory,
                   :event_store_schema_name,
-                  :strict_check_attributes_on_apply_events
+                  :strict_check_attributes_on_apply_events,
+                  :enable_multiple_database_support,
+                  :primary_database_role,
+                  :primary_database_key,
+                  :time_precision
 
     attr_reader :migrations_class_name,
                 :versions_table_name,
@@ -78,6 +85,7 @@ module Sequent
       self.command_handlers = []
       self.command_filters = []
       self.event_handlers = []
+      self.command_middleware = Sequent::Core::Middleware::Chain.new
 
       self.aggregate_repository = Sequent::Core::AggregateRepository.new
       self.event_store = Sequent::Core::EventStore.new
@@ -107,6 +115,16 @@ module Sequent
 
       self.logger = Logger.new(STDOUT).tap { |l| l.level = Logger::INFO }
       self.error_locale_resolver = DEFAULT_ERROR_LOCALE_RESOLVER
+
+      self.enable_multiple_database_support = false
+      self.primary_database_role = :writing
+      self.primary_database_key = :primary
+
+      self.time_precision = DEFAULT_TIME_PRECISION
+    end
+
+    def can_use_multiple_databases?
+      enable_multiple_database_support && ActiveRecord.version > Gem::Version.new('6.1.0')
     end
 
     def replayed_ids_table_name=(table_name)

data/lib/sequent/core/aggregate_root.rb

@@ -39,14 +39,10 @@ module Sequent
       include Helpers::MessageHandler
       include Helpers::AutosetAttributes
       include SnapshotConfiguration
+      extend ActiveSupport::DescendantsTracker
 
       attr_reader :id, :uncommitted_events, :sequence_number, :event_stream
 
-      def self.inherited(subclass)
-        super
-        AggregateRoots << subclass
-      end
-
       def self.load_from_history(stream, events)
         first, *rest = events
         if first.is_a? SnapshotEvent
@@ -127,7 +123,7 @@ module Sequent
       # Provide subclasses nice DSL to 'apply' events via:
       #
       #   def send_invoice
-      #     apply InvoiceSentEvent, send_date: DateTime.now
+      #     apply InvoiceSentEvent, send_date: Time.now
       #   end
       #
       def apply(event, params = {})

data/lib/sequent/core/aggregate_roots.rb

@@ -3,21 +3,17 @@
 module Sequent
   module Core
     #
-    # Utility class containing all subclasses of AggregateRoot
+    # Utility class containing all subclasses of AggregateRoot.
     #
     class AggregateRoots
       class << self
         def aggregate_roots
-          @aggregate_roots ||= []
+          Sequent::AggregateRoot.descendants
         end
 
         def all
           aggregate_roots
         end
-
-        def <<(aggregate_root)
-          aggregate_roots << aggregate_root
-        end
       end
     end
   end

data/lib/sequent/core/command.rb

@@ -28,17 +28,17 @@ module Sequent
       include ActiveModel::Validations
       include ActiveModel::Validations::Callbacks
       include Sequent::Core::Helpers::TypeConversionSupport
+      extend ActiveSupport::DescendantsTracker
 
-      attrs created_at: DateTime
+      attrs created_at: Time
+
+      define_model_callbacks :initialize, only: :after
 
       def initialize(args = {})
         update_all_attributes args
-        @created_at = DateTime.now
-      end
+        @created_at = Time.now
 
-      def self.inherited(subclass)
-        super
-        Commands << subclass
+        _run_initialize_callbacks
       end
     end
 
@@ -56,22 +56,18 @@ module Sequent
     end
 
     #
-    # Utility class containing all subclasses of BaseCommand
+    # Utility class containing all subclasses of BaseCommand.
     #
     class Commands
       class << self
         def commands
-          @commands ||= []
+          Sequent::Core::BaseCommand.descendants
         end
 
         def all
           commands
         end
 
-        def <<(command)
-          commands << command
-        end
-
         def find(command_name)
           commands.find { |c| c.name == command_name }
         end

data/lib/sequent/core/command_service.rb

@@ -50,7 +50,12 @@ module Sequent
       def process_commands
         Sequent::Util.skip_if_already_processing(:command_service_process_commands) do
           transaction_provider.transactional do
-            process_command(command_queue.pop) until command_queue.empty?
+            until command_queue.empty?
+              command = command_queue.pop
+              command_middleware.invoke(command) do
+                process_command(command)
+              end
+            end
             Sequent::Util.done_processing(:command_service_process_commands)
           end
         ensure
@@ -66,7 +71,9 @@ module Sequent
 
         filters.each { |filter| filter.execute(command) }
 
-        fail CommandNotValid, command unless command.valid?
+        I18n.with_locale(Sequent.configuration.error_locale_resolver.call) do
+          fail CommandNotValid, command unless command.valid?
+        end
 
         parsed_command = command.parse_attrs_to_correct_types
         command_handlers.select do |h|
@@ -98,6 +105,10 @@ module Sequent
       def command_handlers
         Sequent.configuration.command_handlers
       end
+
+      def command_middleware
+        Sequent.configuration.command_middleware
+      end
     end
 
     # Raised when BaseCommand.valid? returns false

data/lib/sequent/core/core.rb

@@ -4,6 +4,7 @@ require_relative 'sequent_oj'
 require_relative 'helpers/helpers'
 require_relative 'persistors/persistors'
 require_relative 'transactions/transactions'
+require_relative 'middleware/middleware'
 require_relative 'event'
 require_relative 'aggregate_repository'
 require_relative 'aggregate_root'

data/lib/sequent/core/event.rb

@@ -13,14 +13,14 @@ module Sequent
       include Sequent::Core::Helpers::AttributeSupport
       include Sequent::Core::Helpers::EqualSupport
       include Sequent::Core::Helpers::StringSupport
-      attrs aggregate_id: String, sequence_number: Integer, created_at: DateTime
+      attrs aggregate_id: String, sequence_number: Integer, created_at: Time
 
       def initialize(args = {})
         update_all_attributes args
         fail 'Missing aggregate_id' unless @aggregate_id
         fail 'Missing sequence_number' unless @sequence_number
 
-        @created_at ||= DateTime.now
+        @created_at ||= Time.now
       end
 
       def payload

data/lib/sequent/core/event_store.rb

@@ -26,8 +26,21 @@ module Sequent
         end
       end
 
-      def initialize
-        @event_types = ThreadSafe::Cache.new
+      ##
+      # Disables event type caching (ie. for in development).
+      #
+      class NoEventTypesCache
+        def fetch_or_store(event_type)
+          yield(event_type)
+        end
+      end
+
+      def initialize(cache_event_types: true)
+        @event_types = if cache_event_types
+                         ThreadSafe::Cache.new
+                       else
+                         NoEventTypesCache.new
+                       end
       end
 
       ##

data/lib/sequent/core/ext/ext.rb

@@ -68,6 +68,23 @@ class DateTime
   end
 end
 
+class Time
+  def self.from_params(value)
+    value.blank? ? nil : Time.iso8601(value.dup)
+  rescue ArgumentError
+    value
+  end
+
+  def self.deserialize_from_json(value)
+    value.blank? ? nil : Time.iso8601(value.dup)
+  rescue ArgumentError => e
+    return Time.parse(value.dup) if e.message =~ /invalid xmlschema format/ # ruby >= 3
+    return Time.parse(value.dup) if e.message =~ /invalid date:/ # ruby 2.7
+
+    raise
+  end
+end
+
 class Array
   def self.deserialize_from_json(value)
     value

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

@@ -6,6 +6,7 @@ require_relative 'array_with_type'
 require_relative 'default_validators'
 require_relative 'type_conversion_support'
 require_relative 'date_time_validator'
+require_relative 'time_validator'
 require_relative 'association_validator'
 
 module Sequent

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

@@ -17,6 +17,9 @@ module Sequent
           Date => ->(klass, field) do
             klass.validates field, 'sequent::Core::Helpers::Date' => true
           end,
+          Time => ->(klass, field) do
+            klass.validates field, 'sequent::Core::Helpers::Time' => true
+          end,
           DateTime => ->(klass, field) do
             klass.validates field, 'sequent::Core::Helpers::DateTime' => true
           end,

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

@@ -83,6 +83,8 @@ module Sequent
             val.iso8601
           elsif val.is_a? Date
             val.iso8601
+          elsif val.is_a? Time
+            val.iso8601(Sequent.configuration.time_precision)
           else
             val
           end

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

@@ -16,6 +16,7 @@ module Sequent
           ::Boolean => ->(value) { parse_to_bool(value) },
           ::Date => ->(value) { parse_to_date(value) },
           ::DateTime => ->(value) { parse_to_date_time(value) },
+          ::Time => ->(value) { parse_to_time(value) },
           ::Sequent::Core::Helpers::ArrayWithType => ->(values, type_in_array) { parse_array(values, type_in_array) },
           ::Sequent::Core::Helpers::Secret => ->(value) { Sequent::Core::Helpers::Secret.new(value).encrypt },
         }.freeze
@@ -52,6 +53,10 @@ module Sequent
           value.is_a?(DateTime) ? value : DateTime.deserialize_from_json(value)
         end
 
+        def self.parse_to_time(value)
+          value.is_a?(Time) ? value : Time.deserialize_from_json(value)
+        end
+
         def self.parse_array(values, type_in_array)
           fail "invalid value for array(): \"#{values}\"" unless values.is_a?(Array)
 

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'active_model'
+
+module Sequent
+  module Core
+    module Helpers
+      # Validates Time
+      # Automatically included when using a
+      #
+      #   attrs value: Time
+      class TimeValidator < ActiveModel::EachValidator
+        def validate_each(subject, attribute, value)
+          return if value.is_a?(Time)
+
+          Time.deserialize_from_json(value)
+        rescue StandardError
+          subject.errors.add attribute, :invalid_time
+        end
+      end
+    end
+  end
+end

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

@@ -16,6 +16,7 @@ module Sequent
           ::Integer => ->(value) { valid_integer?(value) },
           ::Boolean => ->(value) { valid_bool?(value) },
           ::Date => ->(value) { valid_date?(value) },
+          ::Time => ->(value) { valid_time?(value) },
           ::DateTime => ->(value) { valid_date_time?(value) },
         }.freeze
 
@@ -53,6 +54,16 @@ module Sequent
           end
         end
 
+        def self.valid_time?(value)
+          return true if value.blank?
+
+          begin
+            value.is_a?(Time) || !!Time.iso8601(value.dup)
+          rescue StandardError
+            false
+          end
+        end
+
         def self.valid_string?(value)
           return true if value.nil?
 

data/lib/sequent/core/middleware/chain.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Sequent
+  module Core
+    module Middleware
+      class Chain
+        attr_reader :entries
+
+        def initialize
+          clear
+        end
+
+        def add(middleware)
+          @entries.push(middleware)
+        end
+
+        def clear
+          @entries = []
+        end
+
+        def invoke(*args, &invoker)
+          chain = @entries.dup
+
+          traverse_chain = -> do
+            if chain.empty?
+              invoker.call
+            else
+              chain.shift.call(*args, &traverse_chain)
+            end
+          end
+
+          traverse_chain.call
+        end
+      end
+    end
+  end
+end

data/lib/sequent/core/middleware/middleware.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'chain'

data/lib/sequent/core/projector.rb

@@ -86,17 +86,13 @@ module Sequent
       extend Forwardable
       include Helpers::MessageHandler
       include Migratable
+      extend ActiveSupport::DescendantsTracker
 
       def initialize(persistor = Sequent::Core::Persistors::ActiveRecordPersistor.new)
         ensure_valid!
         @persistor = persistor
       end
 
-      def self.inherited(subclass)
-        super
-        Projectors << subclass
-      end
-
       def self.replay_persistor
         nil
       end
@@ -132,22 +128,18 @@ module Sequent
     end
 
     #
-    # Utility class containing all subclasses of Projector
+    # Utility class containing all subclasses of Projector.
     #
     class Projectors
       class << self
         def projectors
-          @projectors ||= []
+          Sequent::Projector.descendants
         end
 
         def all
           projectors
         end
 
-        def <<(projector)
-          projectors << projector
-        end
-
         def find(projector_name)
           projectors.find { |c| c.name == projector_name }
         end

data/lib/sequent/core/workflow.rb

@@ -7,11 +7,7 @@ module Sequent
   module Core
     class Workflow
       include Helpers::MessageHandler
-
-      def self.inherited(subclass)
-        super
-        Workflows << subclass
-      end
+      extend ActiveSupport::DescendantsTracker
 
       def self.on(*args, **opts, &block)
         decorated_block = ->(event) do
@@ -49,22 +45,18 @@ module Sequent
     end
 
     #
-    # Utility class containing all subclasses of Workflow
+    # Utility class containing all subclasses of Workflow.
     #
     class Workflows
       class << self
         def workflows
-          @workflows ||= []
+          Sequent::Workflow.descendants
         end
 
         def all
           workflows
         end
 
-        def <<(workflow)
-          workflows << workflow
-        end
-
         def find(workflow_name)
           workflows.find { |c| c.name == workflow_name }
         end

data/lib/sequent/generator/template_project/Rakefile

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

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

@@ -1,7 +1,7 @@
 ActiveRecord::Schema.define do
 
   create_table "event_records", :force => true do |t|
-    t.string "aggregate_id", :null => false
+    t.uuid "aggregate_id", :null => false
     t.integer "sequence_number", :null => false
     t.datetime "created_at", :null => false
     t.string "event_type", :null => false
@@ -27,7 +27,7 @@ CREATE INDEX snapshot_events ON event_records (aggregate_id, sequence_number DES
 
   create_table "command_records", :force => true do |t|
     t.string "user_id"
-    t.string "aggregate_id"
+    t.uuid "aggregate_id"
     t.string "command_type", :null => false
     t.text "command_json", :null => false
     t.datetime "created_at", :null => false
@@ -36,7 +36,7 @@ CREATE INDEX snapshot_events ON event_records (aggregate_id, sequence_number DES
   create_table "stream_records", :force => true do |t|
     t.datetime "created_at", :null => false
     t.string "aggregate_type", :null => false
-    t.string "aggregate_id", :null => false
+    t.uuid "aggregate_id", :null => false
     t.integer "snapshot_threshold"
   end
 

data/lib/sequent/generator/template_project/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 require 'bundler/setup'
 Bundler.setup
 
-ENV['RACK_ENV'] ||= 'test'
+ENV['SEQUENT_ENV'] ||= 'test'
 
 require 'sequent/test'
 require 'database_cleaner'

data/lib/sequent/migrations/migrations.rb

@@ -9,3 +9,4 @@ require_relative 'migrate_events'
 require_relative 'projectors'
 require_relative 'view_schema'
 require_relative 'functions'
+require_relative 'sequent_schema'

data/lib/sequent/migrations/projectors.rb

@@ -5,11 +5,11 @@ module Sequent
   module Migrations
     class Projectors
       def self.versions
-        fail 'Define your own Sequent::Migrations::List class that extends this class and implements this method'
+        fail "Define your own #{name} class that extends this class and implements this method"
       end
 
       def self.version
-        fail 'Define your own Sequent::Migrations::List class that extends this class and implements this method'
+        fail "Define your own #{name} class that extends this class and implements this method"
       end
 
       def self.migrations_between(old, new)

data/lib/sequent/migrations/sequent_schema.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Sequent
+  module Migrations
+    class SequentSchema
+      FAIL_IF_EXISTS = ->(schema_name) { fail "Schema #{schema_name} already exists in the database" }
+
+      class << self
+        #
+        # Creates the sequent schema if it does not exist yet
+        #
+        # @param env [String] The environment used to setup database connection
+        # @param fail_if_exists [Boolean] When true fails if the schema exists, otherwise just return.
+        def create_sequent_schema_if_not_exists(env:, fail_if_exists: true)
+          fail ArgumentError, 'env is required' if env.blank?
+
+          db_config = Sequent::Support::Database.read_config(env)
+
+          Sequent::Support::Database.establish_connection(db_config)
+
+          event_store_schema = Sequent.configuration.event_store_schema_name
+          schema_exists = Sequent::Support::Database.schema_exists?(event_store_schema)
+
+          FAIL_IF_EXISTS.call(event_store_schema) if schema_exists && fail_if_exists
+          return if schema_exists
+
+          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
+
+          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
+        end
+      end
+    end
+  end
+end