synapse-core 0.5.3 → 0.5.4

data/lib/synapse/command.rb

@@ -38,3 +38,5 @@ require 'synapse/command/gateway'
 require 'synapse/command/gateway/retry_scheduler'
 require 'synapse/command/gateway/interval_retry_scheduler'
 require 'synapse/command/gateway/retrying_callback'
+
+require 'synapse/command/callbacks/future'

data/lib/synapse/command/callbacks/future.rb

@@ -0,0 +1,50 @@
+module Synapse
+  module Command
+    # Callback that provides a deferred result or exception from the execution of a command
+    class FutureCallback < CommandCallback
+      def initialize
+        @mutex = Mutex.new
+        @condition = ConditionVariable.new
+      end
+
+      # @raise [Exception] If an exception occured during command execution
+      # @param [Float] timeout
+      # @return [Object] The result from the command handler
+      def result(timeout = nil)
+        @mutex.synchronize do
+          unless @dispatched
+            @condition.wait @mutex, timeout
+          end
+
+          if @exception
+            raise @exception
+          end
+
+          @result
+        end
+      end
+
+      # @param [Object] result The result from the command handler
+      # @return [undefined]
+      def on_success(result)
+        @mutex.synchronize do
+          @dispatched = true
+          @result = result
+
+          @condition.broadcast
+        end
+      end
+
+      # @param [Exception] exception The cause of the failure
+      # @return [undefined]
+      def on_failure(exception)
+        @mutex.synchronize do
+          @dispatched = true
+          @exception = exception
+
+          @condition.broadcast
+        end
+      end
+    end # FutureCallback
+  end # Command
+end

data/lib/synapse/command/command_callback.rb

@@ -14,52 +14,5 @@ module Synapse
       # @return [undefined]
       def on_failure(exception); end
     end # CommandCallback
-
-    # Callback that provides a deferred result or exception from the execution of a command
-    class FutureCallback < CommandCallback
-      def initialize
-        @mutex = Mutex.new
-        @condition = ConditionVariable.new
-      end
-
-      # @raise [Exception] If an exception occured during command execution
-      # @param [Float] timeout
-      # @return [Object] The result from the command handler
-      def result(timeout = nil)
-        @mutex.synchronize do
-          unless @dispatched
-            @condition.wait @mutex, timeout
-          end
-
-          if @exception
-            raise @exception
-          end
-
-          @result
-        end
-      end
-
-      # @param [Object] result The result from the command handler
-      # @return [undefined]
-      def on_success(result)
-        @mutex.synchronize do
-          @dispatched = true
-          @result = result
-
-          @condition.broadcast
-        end
-      end
-
-      # @param [Exception] exception The cause of the failure
-      # @return [undefined]
-      def on_failure(exception)
-        @mutex.synchronize do
-          @dispatched = true
-          @exception = exception
-
-          @condition.broadcast
-        end
-      end
-    end # FutureCallback
   end # Command
 end

data/lib/synapse/command/message.rb

@@ -12,7 +12,7 @@ module Synapse
     class CommandMessageBuilder < MessageBuilder
       # @return [CommandMessage]
       def build
-        CommandMessage.new @id, @metadata, @payload
+        CommandMessage.new @id, @metadata, @payload, @timestamp
       end
     end
   end

data/lib/synapse/common.rb

@@ -3,6 +3,7 @@ require 'synapse/common/identifier'
 require 'synapse/common/message'
 require 'synapse/common/message_builder'
 
+require 'synapse/common/concurrency/executor'
 require 'synapse/common/concurrency/identifier_lock'
 require 'synapse/common/concurrency/public_lock'
 

data/lib/synapse/common/concurrency/executor.rb

@@ -0,0 +1,13 @@
+module Synapse
+  class Executor
+    # @return [undefined]
+    def execute(&block); end
+  end
+
+  class DirectExecutor < Executor
+    # @return [undefined]
+    def execute(&block)
+      block.call
+    end
+  end
+end

data/lib/synapse/common/message.rb

@@ -22,14 +22,20 @@ module Synapse
     # @return [Object]
     attr_reader :payload
 
+    # Timestamp recorded when the message was created
+    # @return [Time]
+    attr_reader :timestamp
+
     # @param [String] id
     # @param [Hash] metadata
     # @param [Object] payload
+    # @param [Time] timestamp
     # @return [undefined]
-    def initialize(id, metadata, payload)
+    def initialize(id, metadata, payload, timestamp)
       @id = id
       @metadata = metadata
       @payload = payload
+      @timestamp = timestamp
 
       @metadata.freeze
     end
@@ -88,7 +94,7 @@ module Synapse
     # @yield [MessageBuilder]
     # @return [Message]
     def self.build(&block)
-      builder.build(&block)
+      builder.build &block
     end
 
     # Returns the type of builder that can be used to build this type of message
@@ -108,6 +114,7 @@ module Synapse
       builder.id = @id
       builder.metadata = metadata
       builder.payload = @payload
+      builder.timestamp = @timestamp
     end
   end
 end

data/lib/synapse/common/message_builder.rb

@@ -10,6 +10,9 @@ module Synapse
     # @return [Object]
     attr_accessor :payload
 
+    # @return [Time]
+    attr_accessor :timestamp
+
     # Convenience method that yields a new builder, populates defaults and returns the newly
     # built message instance
     #
@@ -26,13 +29,14 @@ module Synapse
 
     # @return [Message]
     def build
-      Message.new @id, @metadata, @payload
+      Message.new @id, @metadata, @payload, @timestamp
     end
 
     # @return [undefined]
     def populate_defaults
       @id ||= IdentifierFactory.instance.generate
       @metadata ||= Hash.new
+      @timestamp ||= Time.now
     end
   end
 end

data/lib/synapse/configuration.rb

@@ -5,6 +5,7 @@ require 'synapse/configuration/definition_builder'
 require 'synapse/configuration/dependent'
 require 'synapse/configuration/ext'
 
+require 'synapse/configuration/component/mixin/thread_pool'
 require 'synapse/configuration/component/command_bus'
 require 'synapse/configuration/component/event_bus'
 # Has to be loaded before event sourcing

data/lib/synapse/configuration/component/command_bus/async_command_bus.rb

@@ -12,13 +12,7 @@ module Synapse
     #     use_threads 8, 12
     #   end
     class AsynchronousCommandBusDefinitionBuilder < SimpleCommandBusDefinitionBuilder
-      # @param [Integer] min_threads
-      # @param [Integer] max_threads
-      # @return [undefined]
-      def use_threads(min_threads, max_threads = nil)
-        @min_threads = min_threads
-        @max_threads = max_threads
-      end
+      include ThreadPoolDefinitionBuilder
 
     protected
 
@@ -32,7 +26,7 @@ module Synapse
       # @return [AsynchronousCommandBus]
       def create_command_bus(unit_factory)
         command_bus = Command::AsynchronousCommandBus.new unit_factory
-        command_bus.thread_pool = Thread.pool @min_threads, @max_threads
+        command_bus.thread_pool = create_thread_pool
 
         command_bus
       end

data/lib/synapse/configuration/component/event_sourcing.rb

@@ -1,5 +1,5 @@
-require 'synapse/configuration/component/event_sourcing/aggregate_snapshot_taker'
-require 'synapse/configuration/component/event_sourcing/interval_snapshot_policy'
+require 'synapse/configuration/component/event_sourcing/snapshot/aggregate_taker'
+require 'synapse/configuration/component/event_sourcing/snapshot/interval_policy'
 require 'synapse/configuration/component/event_sourcing/repository'
 
 module Synapse
@@ -9,7 +9,7 @@ module Synapse
       builder :es_repository, EventSourcingRepositoryDefinitionBuilder
 
       # Creates and configures an aggregate snapshot taker
-      builder :aggregate_snapshot_taker, AggregateSnapshotTakerDefinitionBuilder
+      builder :snapshot_taker, AggregateSnapshotTakerDefinitionBuilder
 
       # Creates and configures an interval-based snapshot policy
       builder :interval_snapshot_policy, IntervalSnapshotPolicyDefinitionBuilder

data/lib/synapse/configuration/component/event_sourcing/repository.rb

@@ -46,6 +46,18 @@ module Synapse
         @aggregate_factory = aggregate_factory
       end
 
+      # Changes the cache store that will be used to cache aggregates
+      #
+      # Note that if this is set, a caching implementation of the repository will be used in place
+      # of the non-caching implementation
+      #
+      # @see ActiveSupport::Cache::Store
+      # @param [Symbol] cache
+      # @return [undefined]
+      def use_cache(cache)
+        @cache = cache
+      end
+
       # @see EventSourcing::ConflictResolver
       # @param [Symbol] conflict_resolver
       # @return [undefined]
@@ -86,11 +98,16 @@ module Synapse
         use_snapshot_taker :snapshot_taker
 
         use_factory do
-          aggregate_factory = resolve @aggregate_factory
+          factory = resolve @aggregate_factory
           event_store = resolve @event_store
           lock_manager = build_lock_manager
 
-          repository = EventSourcing::EventSourcingRepository.new aggregate_factory, event_store, lock_manager
+          if @cache
+            repository = EventSourcing::CachingEventSourcingRepository.new factory, event_store, lock_manager
+            repository.cache = resolve @cache
+          else
+            repository = EventSourcing::EventSourcingRepository.new factory, event_store, lock_manager
+          end
 
           # Optional dependencies
           repository.conflict_resolver = resolve @conflict_resolver, true

data/lib/synapse/configuration/component/event_sourcing/{aggregate_snapshot_taker.rb → snapshot/aggregate_taker.rb}

@@ -3,10 +3,10 @@ module Synapse
     # Definition builder used to create aggregate snapshot takers
     #
     # @example The minimum possible effort to build an aggregate snapshot taker
-    #   aggregate_snapshot_taker
+    #   snapshot_taker
     #
     # @example Build an aggregate snapshot taker using an alternate event store and factory tag
-    #   aggregate_snapshot_taker :alt_snapshot_taker do
+    #   snapshot_taker :alt_snapshot_taker do
     #     use_aggregate_factory_tag :alt_factory_tag
     #     use_event_store :alt_event_store
     #   end
@@ -40,8 +40,8 @@ module Synapse
         use_event_store :event_store
 
         use_factory do
-          event_store = resolve @event_store
-          snapshot_taker = EventSourcing::AggregateSnapshotTaker.new event_store
+          snapshot_taker = EventSourcing::AggregateSnapshotTaker.new
+          snapshot_taker.event_store = resolve @event_store
 
           with_tagged @aggregate_factory_tag do |factory|
             snapshot_taker.register_factory factory

data/lib/synapse/configuration/component/mixin/thread_pool.rb

@@ -0,0 +1,26 @@
+module Synapse
+  module Configuration
+    # Mixin for a definition builder that creates a service that is backed by a thread pool
+    module ThreadPoolDefinitionBuilder
+      extend ActiveSupport::Concern
+
+      # Sets the upper and lower limits of the size of the thread pool
+      #
+      # @param [Integer] min_threads
+      # @param [Integer] max_threads
+      # @return [undefined]
+      def use_threads(min_threads, max_threads = nil)
+        @min_threads = min_threads
+        @max_threads = max_threads
+      end
+
+    protected
+
+      # Creates a thread pool with the configured options
+      # @return [Thread::Pool]
+      def create_thread_pool
+        Thread.pool @min_threads, @max_threads
+      end
+    end # ThreadPoolDefinitionBuilder
+  end # Configuration
+end

data/lib/synapse/domain/message.rb

@@ -4,34 +4,10 @@ module Synapse
     # to another component of the application. It contains the relevant data for other
     # components to act upon.
     class EventMessage < Message
-      # The timestamp of when the event was reported
-      # @return [Time]
-      attr_reader :timestamp
-
-      # @param [String] id
-      # @param [Hash] metadata
-      # @param [Object] payload
-      # @param [Time] timestamp
-      # @return [undefined]
-      def initialize(id, metadata, payload, timestamp)
-        super id, metadata, payload
-        @timestamp = timestamp
-      end
-
       # @return [Class]
       def self.builder
         EventMessageBuilder
       end
-
-    protected
-
-      # @param [EventMessageBuilder] builder
-      # @param [Hash] metadata
-      # @return [undefined]
-      def build_duplicate(builder, metadata)
-        super
-        builder.timestamp = @timestamp
-      end
     end
 
     # Message that contains a domain event as a payload that represents a state change in the domain.

data/lib/synapse/domain/message_builder.rb

@@ -2,19 +2,10 @@ module Synapse
   module Domain
     # Message builder capable of producing EventMessage instances
     class EventMessageBuilder < MessageBuilder
-      # @return [Time]
-      attr_accessor :timestamp
-
       # @return [EventMessage]
       def build
         EventMessage.new @id, @metadata, @payload, @timestamp
       end
-
-      # @return [undefined]
-      def populate_defaults
-        super
-        @timestamp ||= Time.now
-      end
     end
 
     # Message builder capable of producing DomainEventMessage instances

data/lib/synapse/event_sourcing.rb

@@ -1,7 +1,7 @@
 require 'synapse/event_sourcing/aggregate_factory'
 require 'synapse/event_sourcing/conflict_resolver'
 require 'synapse/event_sourcing/repository'
-require 'synapse/event_sourcing/storage_listener'
+require 'synapse/event_sourcing/caching'
 require 'synapse/event_sourcing/stream_decorator'
 
 require 'synapse/event_sourcing/member'

data/lib/synapse/event_sourcing/aggregate_root.rb

@@ -49,7 +49,8 @@ module Synapse
           raise 'Aggregate has already been initialized'
         end
 
-        pre_initialize
+        # If this is loaded from a snapshot, don't pre-initialize
+        pre_initialize unless @initial_version
 
         @initial_version = stream.peek.sequence_number
 

data/lib/synapse/event_sourcing/caching.rb

@@ -0,0 +1,66 @@
+module Synapse
+  module EventSourcing
+    # Implementation of an event sourcing repository that uses a cache to improve performance when
+    # loading aggregates
+    #
+    # Caching is not compatible with optimistic locking
+    #
+    # Note that if an error occurs while saving an aggregate, it will be invalidated from the cache
+    # to prevent aggregates being returned from the cache that were not fully persisted to disk.
+    class CachingEventSourcingRepository < EventSourcingRepository
+      # @return [ActiveSupport::Cache::Store]
+      attr_accessor :cache
+
+    protected
+
+      # @raise [AggregateNotFoundError]
+      #   If the aggregate with the given identifier could not be found
+      # @raise [AggregateDeletedError]
+      #   If the loaded aggregate has been marked as deleted
+      # @raise [ConflictingModificationError]
+      #   If the expected version doesn't match the aggregate's actual version
+      # @param [Object] aggregate_id
+      # @param [Integer] expected_version
+      # @return [AggregateRoot]
+      def perform_load(aggregate_id, expected_version)
+        aggregate = @cache.fetch aggregate_id
+
+        if aggregate.nil?
+          aggregate = super aggregate_id, expected_version
+        elsif aggregate.deleted?
+          raise AggregateDeletedError
+        end
+
+        register_listener CacheClearingUnitOfWorkListener.new aggregate_id, @cache
+
+        aggregate
+      end
+
+      # @param [AggregateRoot] aggregate
+      # @return [undefined]
+      def save_aggregate(aggregate)
+        super aggregate
+        @cache.write aggregate.id, aggregate
+      end
+    end # CachingEventSourcingRepository
+
+    # Listener that removes an aggregate from the cache if the unit of work is rolled back
+    # @api private
+    class CacheClearingUnitOfWorkListener < UnitOfWork::UnitOfWorkListener
+      # @param [Object] aggregate_id
+      # @param [ActiveSupport::Cache::Store] cache
+      # @return [undefined]
+      def initialize(aggregate_id, cache)
+        @aggregate_id = aggregate_id
+        @cache = cache
+      end
+
+      # @param [UnitOfWork] unit
+      # @param [Error] cause
+      # @return [undefined]
+      def on_rollback(unit, cause = nil)
+        @cache.delete @aggregate_id
+      end
+    end # CacheClearingUnitOfWorkListener
+  end # EventSourcing
+end