sequent 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73d2ee9247b64d69617de99ffed129de86385e4a58f463b52d5558126ccf89ba
-  data.tar.gz: 32b61b477f9a7ff2d0df8b93a7a704705a20b661cdeab3b9388431e4ec4b9d8d
+  metadata.gz: ee34fdc286ef0c550e0ccd50b64f1e726457c3e58e656797e84cb36bd9e36aa0
+  data.tar.gz: 77546ab25b533fc77ce08cfee7252df089362d533b52d2c09e885298e197c737
 SHA512:
-  metadata.gz: 784e843cfc6a86120b9f48779fad3104d3504fd7d472ab925a19f0de897fd2b0f745d1fb4e8c77bcecbb254976e0148443d18bed52dabd8f9400cf1551c451d3
-  data.tar.gz: 9f027d9bb65d643ecb5cf2b37c854890d4c3b3bba840373088e3a1b35db92de0d7f22bc76ebc92910d076e6ed102aba9d20fe96f5195e0e9ed3f36bd5a53ee4c
+  metadata.gz: 91d3d4c9e946d75488adf4e3b86fb20c99c90f4c324d3d29f276518357f5ec8ba2db12707f48ecf0a577eb15582dce38c01fd1a6885501faea1e1a384c967ccf
+  data.tar.gz: 007c283a04b967879769152a4e0b2e5f84b4571f64de751621e5337d75b39e17473be44f8a61358e3fcbfe8e73d9bec64c3d83b7d8d0823ebdf2e5740cb3f22c

data/bin/sequent

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+require_relative '../lib/sequent/generator'
+
+def new_project(args)
+  name, _ = args
+  abort('Please specify a directory name. i.e. `sequent new myapp`') if name.empty?
+
+  Sequent::Generator::Project.new(name).execute
+  puts <<~NEXTSTEPS
+
+    Success!
+
+    Your brand spanking new sequent app is waiting for you in:
+      #{File.expand_path(name, __dir__)}
+
+    To finish setting up your app:
+      cd #{name}
+      bundle install
+      bundle exec rake sequent:db:create
+      bundle exec rake sequent:migrate:online
+      bundle exec rake sequent:migrate:offline
+
+    Run the example specs:
+      RACK_ENV=test bundle exec rake sequent:db:create
+      bundle exec rspec spec
+
+    To generate new aggregates use:
+      sequent generate <aggregate_name>. e.g. sequent generate address
+
+    For more information see:
+      sequent.io
+
+    Happy coding!
+
+  NEXTSTEPS
+end
+
+def generate(args)
+  entity, _ = args
+  abort('Please specify a command. i.e. `sequent g aggregate user`') if entity.empty?
+
+  case entity
+    when 'aggregate'
+      _, aggregate_name = args
+      abort('Please specify a aggregate name. i.e. `sequent g aggregate user`') if !aggregate_name || aggregate_name.empty?
+
+      Sequent::Generator::Aggregate.new(aggregate_name).execute
+      puts "#{aggregate_name} aggregate has been generated"
+    else
+      abort("Unknown argument #{entity} for `generate`. Try `sequent g aggregate user`")
+  end
+end
+
+command = ARGV[0].to_s.strip
+abort('Please specify a command. i.e. `sequent new myapp`') if command.empty?
+args = ARGV[1..10].map(&:to_s).map(&:strip)
+
+case command
+when 'new'
+  new_project(args)
+when 'generate', 'g'
+  generate(args)
+else
+  abort("Unknown command #{command}. Try `sequent new myapp`")
+end

data/db/sequent_schema.rb

@@ -10,14 +10,6 @@ ActiveRecord::Schema.define do
     t.integer "stream_record_id", :null => false
   end
 
-  create_table "command_records", :force => true do |t|
-    t.string "user_id"
-    t.string "aggregate_id"
-    t.string "command_type", :null => false
-    t.text "command_json", :null => false
-    t.datetime "created_at", :null => false
-  end
-
   execute %Q{
 CREATE UNIQUE INDEX unique_event_per_aggregate ON event_records (
   aggregate_id,
@@ -28,10 +20,19 @@ CREATE UNIQUE INDEX unique_event_per_aggregate ON event_records (
   execute %Q{
 CREATE INDEX snapshot_events ON event_records (aggregate_id, sequence_number DESC) WHERE event_type = 'Sequent::Core::SnapshotEvent'
 }
+
   add_index "event_records", ["command_record_id"], :name => "index_event_records_on_command_record_id"
   add_index "event_records", ["event_type"], :name => "index_event_records_on_event_type"
   add_index "event_records", ["created_at"], :name => "index_event_records_on_created_at"
 
+  create_table "command_records", :force => true do |t|
+    t.string "user_id"
+    t.string "aggregate_id"
+    t.string "command_type", :null => false
+    t.text "command_json", :null => false
+    t.datetime "created_at", :null => false
+  end
+
   create_table "stream_records", :force => true do |t|
     t.datetime "created_at", :null => false
     t.string "aggregate_type", :null => false

data/lib/sequent.rb

@@ -1 +1,4 @@
 require_relative 'sequent/sequent'
+require_relative 'sequent/core/core'
+require_relative 'sequent/util/util'
+require_relative 'sequent/migrations/migrations'

data/lib/sequent/configuration.rb

@@ -2,9 +2,28 @@ require_relative 'core/event_store'
 require_relative 'core/command_service'
 require_relative 'core/transactions/no_transactions'
 require_relative 'core/aggregate_repository'
+require_relative 'core/persistors/active_record_persistor'
+require 'logger'
 
 module Sequent
   class Configuration
+
+    DEFAULT_VERSIONS_TABLE_NAME = 'sequent_versions'
+    DEFAULT_REPLAYED_IDS_TABLE_NAME = 'sequent_replayed_ids'
+
+    DEFAULT_MIGRATION_SQL_FILES_DIRECTORY = 'db/tables'
+    DEFAULT_DATABASE_CONFIG_DIRECTORY = 'db'
+
+    DEFAULT_VIEW_SCHEMA_NAME = 'view_schema'
+    DEFAULT_EVENT_STORE_SCHEMA_NAME= 'sequent_schema'
+
+    MIGRATIONS_CLASS_NAME = 'Sequent::Migrations::Projectors'
+
+    DEFAULT_NUMBER_OF_REPLAY_PROCESSES = 4
+
+    DEFAULT_OFFLINE_REPLAY_PERSISTOR_CLASS = Sequent::Core::Persistors::ActiveRecordPersistor
+    DEFAULT_ONLINE_REPLAY_PERSISTOR_CLASS = Sequent::Core::Persistors::ActiveRecordPersistor
+
     attr_accessor :aggregate_repository
 
     attr_accessor :event_store,
@@ -24,6 +43,20 @@ module Sequent
 
     attr_accessor :disable_event_handlers
 
+    attr_accessor :logger
+
+    attr_accessor :migration_sql_files_directory,
+                  :view_schema_name,
+                  :offline_replay_persistor_class,
+                  :online_replay_persistor_class,
+                  :number_of_replay_processes,
+                  :database_config_directory,
+                  :event_store_schema_name
+
+    attr_reader :migrations_class_name,
+                :versions_table_name,
+                :replayed_ids_table_name
+
     def self.instance
       @instance ||= new
     end
@@ -51,6 +84,40 @@ module Sequent
       self.uuid_generator = Sequent::Core::RandomUuidGenerator
       self.event_publisher = Sequent::Core::EventPublisher.new
       self.disable_event_handlers = false
+      self.versions_table_name = DEFAULT_VERSIONS_TABLE_NAME
+      self.replayed_ids_table_name = DEFAULT_REPLAYED_IDS_TABLE_NAME
+      self.migration_sql_files_directory = DEFAULT_MIGRATION_SQL_FILES_DIRECTORY
+      self.view_schema_name = DEFAULT_VIEW_SCHEMA_NAME
+      self.event_store_schema_name = DEFAULT_EVENT_STORE_SCHEMA_NAME
+      self.migrations_class_name = MIGRATIONS_CLASS_NAME
+      self.number_of_replay_processes = DEFAULT_NUMBER_OF_REPLAY_PROCESSES
+
+      self.offline_replay_persistor_class = DEFAULT_OFFLINE_REPLAY_PERSISTOR_CLASS
+      self.online_replay_persistor_class = DEFAULT_ONLINE_REPLAY_PERSISTOR_CLASS
+      self.database_config_directory = DEFAULT_DATABASE_CONFIG_DIRECTORY
+
+      self.logger = Logger.new(STDOUT).tap {|l| l.level = Logger::INFO }
+    end
+
+    def replayed_ids_table_name=(table_name)
+      fail ArgumentError.new('table_name can not be nil') unless table_name
+
+      @replayed_ids_table_name = table_name
+      Sequent::Migrations::ViewSchema::ReplayedIds.table_name = table_name
+    end
+
+    def versions_table_name=(table_name)
+      fail ArgumentError.new('table_name can not be nil') unless table_name
+
+      @versions_table_name = table_name
+      Sequent::Migrations::ViewSchema::Versions.table_name = table_name
     end
+
+    def migrations_class_name=(class_name)
+      migration_class = Class.const_get(class_name)
+      fail ArgumentError.new("#{migration_class} must extend Sequent::Migrations::Projectors") unless migration_class <= Sequent::Migrations::Projectors
+      @migrations_class_name = class_name
+    end
+
   end
 end

data/lib/sequent/core/aggregate_repository.rb

@@ -10,7 +10,7 @@ module Sequent
     # queried for uncommitted events. After persisting these events
     # the uncommitted events are cleared from the aggregate.
     #
-    # The repository is keeps track of the Unit-Of-Work per thread,
+    # The repository keeps track of the Unit-Of-Work per thread,
     # so can be shared between threads.
     class AggregateRepository
       # Key used in thread local

data/lib/sequent/core/core.rb

@@ -1,6 +1,6 @@
 require_relative 'sequent_oj'
 require_relative 'helpers/helpers'
-require_relative 'record_sessions/record_sessions'
+require_relative 'persistors/persistors'
 require_relative 'transactions/transactions'
 require_relative 'event'
 require_relative 'aggregate_repository'
@@ -9,7 +9,7 @@ require_relative 'base_command_handler'
 require_relative 'command'
 require_relative 'command_service'
 require_relative 'value_object'
-require_relative 'base_event_handler'
+require_relative 'projector'
 require_relative 'event_store'
 require_relative 'event_record'
 require_relative 'command_record'

data/lib/sequent/core/event_store.rb

@@ -119,9 +119,9 @@ ORDER BY sequence_number ASC, (CASE event_type WHEN #{quote Sequent.configuratio
 
       PRINT_PROGRESS = lambda do |progress, done, _|
         if done
-          puts "Done replaying #{progress} events"
+          Sequent.logger.debug "Done replaying #{progress} events"
         else
-          puts "Replayed #{progress} events"
+          Sequent.logger.debug "Replayed #{progress} events"
         end
       end
 

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

@@ -2,6 +2,9 @@ require 'active_support'
 require_relative '../ext/ext'
 require_relative 'array_with_type'
 require_relative 'default_validators'
+require_relative 'type_conversion_support'
+require_relative 'date_time_validator'
+require_relative 'association_validator'
 
 module Sequent
   module Core

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

@@ -3,7 +3,7 @@ module Sequent
     module Helpers
       ##
       # Creates ability to use DSL like:
-      # class MyEventHandler < Sequent::Core::BaseEventHandler
+      # class MyEventHandler < Sequent::Core::Projector
       #
       #   on MyEvent do |event|
       #     do_some_logic

data/lib/sequent/core/{record_sessions/active_record_session.rb → persistors/active_record_persistor.rb}

@@ -1,15 +1,21 @@
 require 'active_record'
+require_relative './persistor'
 
 module Sequent
   module Core
-    module RecordSessions
+    module Persistors
 
       #
-      # Session objects are used to update view state
+      # The ActiveRecordPersistor uses ActiveRecord to update the projection
       #
-      # The ActiveRecordSession object can be used when you use ActiveRecord as view state store.
+      # This is the default persistor in Sequent, but when your event store
+      # is growing it is not the best choice as persistor while rebuilding
+      # a projection when migrating to a new version of that projection.
       #
-      class ActiveRecordSession
+      # Please see the +ReplayOptimizedPostgresPersistor+ as alternative
+      # for migrating projections to a new version.
+      class ActiveRecordPersistor
+        include Persistor
 
         def update_record(record_class, event, where_clause = {aggregate_id: event.aggregate_id}, options = {}, &block)
           record = record_class.unscoped.where(where_clause).first
@@ -23,10 +29,6 @@ module Sequent
           record.save!
         end
 
-        def execute(statement)
-          ActiveRecord::Base.connection.execute(statement)
-        end
-
         def create_record(record_class, values)
           record = new_record(record_class, values)
           yield record if block_given?
@@ -46,7 +48,7 @@ module Sequent
             insert_manager.to_sql
           end.join(";")
 
-          execute(query)
+          execute_sql(query)
         end
 
         def create_or_update_record(record_class, values, created_at = Time.now)
@@ -101,6 +103,14 @@ module Sequent
           record_class.unscoped.where(where_clause).last
         end
 
+        def execute_sql(statement)
+          ActiveRecord::Base.connection.execute(statement)
+        end
+
+        def commit
+          # noop
+        end
+
         private
 
         def new_record(record_class, values)
@@ -108,19 +118,11 @@ module Sequent
         end
 
         def new_insert_manager
-          if ActiveRecord::VERSION::MAJOR <= 4
-            Arel::InsertManager.new(ActiveRecord::Base)
-          else
-            Arel::InsertManager.new
-          end
+          Arel::InsertManager.new
         end
 
         def convert_to_values(key, table, value)
-          if ActiveRecord::VERSION::MAJOR <= 4
-            [table[key], value]
-          else
-            [table[key], table.type_cast_for_database(key, value)]
-          end
+          [table[key], table.type_cast_for_database(key, value)]
         end
       end
     end

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

@@ -0,0 +1,84 @@
+module Sequent
+  module Core
+    module Persistors
+      # Defines the methods that can be implemented by the specific +Persistors+
+      #
+      # See
+      # - +ActiveRecordPersistor+
+      # - +ReplayOptimizedPostgresPersistor+
+      module Persistor
+        # Updates the view state
+        def update_record
+          fail "Method not supported in this persistor"
+        end
+
+        # Create a single record in the view state
+        def create_record
+          fail "Method not supported in this persistor"
+        end
+
+        # Creates multiple records at once in the view state
+        def create_records
+          fail "Method not supported in this persistor"
+        end
+
+        # Creates or updates a record in the view state.
+        def create_or_update_record
+          fail "Method not supported in this persistor"
+        end
+        # Gets a record from the view state, fails if it not exists
+        def get_record!
+          fail "Method not supported in this persistor"
+        end
+
+        # Gets a record from the view state, returns +nil+ if it not exists
+        def get_record
+          fail "Method not supported in this persistor"
+        end
+
+        # Deletes all records given a where
+        def delete_all_records
+          fail "Method not supported in this persistor"
+        end
+
+        # Updates all record given a where and an update clause
+        def update_all_records
+          fail "Method not supported in this persistor"
+        end
+
+        # Decide for yourself what to do with the records
+        # @deprecated
+        def do_with_records
+          fail "Method not supported in this persistor"
+        end
+
+        # Decide for yourself what to do with a single record
+        # @deprecated
+        def do_with_record
+          fail "Method not supported in this persistor"
+        end
+
+        # Delete a single record
+        # @deprecated
+        def delete_record
+          fail "Method not supported in this persistor"
+        end
+
+        # Find records given a where
+        def find_records
+          fail "Method not supported in this persistor"
+        end
+
+        # Returns the last record given a where
+        def last_record
+          fail "Method not supported in this persistor"
+        end
+
+        # Hook to implement for instance the persistor batches statements
+        def commit
+          fail "Method not supported in this persistor"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+require_relative 'persistor'
+require_relative 'active_record_persistor'
+require_relative 'replay_optimized_postgres_persistor'

data/lib/sequent/core/{record_sessions/replay_events_session.rb → persistors/replay_optimized_postgres_persistor.rb}

@@ -1,14 +1,22 @@
 require 'set'
 require 'active_record'
 require 'csv'
+require_relative './persistor'
 
 module Sequent
   module Core
-    module RecordSessions
+    module Persistors
       #
-      # Session objects are used to update view state
+      # The ReplayOptimizedPostgresPersistor is optimized for bulk loading records in a Postgres database.
       #
-      # The ReplayEventsSession is optimized for bulk loading records in a Postgres database using CSV import.
+      # Depending on the amount of records it uses CSV import, otherwise statements are batched
+      # using normal sql.
+      #
+      # Rebuilding the view state (or projection) of an aggregate typically consists
+      # of an initial insert and then many updates and maybe a delete. With a normal Persistor (like ActiveRecordPersistor)
+      # each action is executed to the database. This persitor creates an inmemory store first and finally flushes
+      # the in memory store to the database. This can significantly reduces the amount of queries to the database.
+      # E.g. 1 insert, 6 updates is only a single insert using this Persistor.
       #
       # After lot of experimenting this turned out to be the fastest way to to bulk inserts in the database.
       # You can tweak the amount of records in the CSV via +insert_with_csv_size+ before
@@ -19,7 +27,7 @@ module Sequent
       #
       # Example:
       #
-      #   class InvoiceEventHandler < Sequent::Core::Projector
+      #   class InvoiceProjector < Sequent::Core::Projector
       #     on RecipientMovedEvent do |event|
       #       update_all_records InvoiceRecord, recipient_id: event.recipient.aggregate_id do |record|
       #         record.recipient_street = record.recipient.street
@@ -31,11 +39,12 @@ module Sequent
       #
       # Example:
       #
-      #   ReplayEventsSession.new(
+      #   ReplayOptimizedPostgresPersistor.new(
       #     50,
       #     {InvoiceRecord => [[:recipient_id]]}
       #   )
-      class ReplayEventsSession
+      class ReplayOptimizedPostgresPersistor
+        include Persistor
 
         attr_reader :record_store
         attr_accessor :insert_with_csv_size
@@ -186,7 +195,7 @@ module Sequent
               end
             EOD
             eval("#{class_def}")
-            struct_class = ReplayEventsSession.const_get(struct_class_name)
+            struct_class = ReplayOptimizedPostgresPersistor.const_get(struct_class_name)
             self.class.struct_cache[struct_class_name] = struct_class
           end
           record = struct_class.new.set_values(values)