synapse-core 0.5.6 → 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ecce43088ffbcd564924205697ffcf99a1b5c7d
+  data.tar.gz: 7366f73d7fb0ff57bb7f786b80615beaa6de0ccc
+SHA512:
+  metadata.gz: 74a8511d2dcff70321d63c0dc54c6c170cf63bb2c710e70bebdbbc1996bd81afb8e5cc799d7d7f99240a937b806924239ae0a5e2ca719c37191e73dcba8efb6d
+  data.tar.gz: 7d2af413072cd726cdbab5c9775692a691c7505c12b4b2ed9a872ceec4b335fd26d788b330c00f9c8740e5a4675d3ebb48d7a8ac5ce0b5a80a4c22b676d0ce0c

data/lib/synapse-core.rb

@@ -1 +1,31 @@
-require 'synapse'
+require 'active_support'
+require 'active_support/core_ext'
+require 'atomic'
+require 'contender'
+require 'forwardable'
+require 'logging'
+require 'ref'
+require 'set'
+
+require 'synapse/common'
+require 'synapse/version'
+
+module Synapse
+  # Core components
+  autoload :Command, 'synapse/command'
+  autoload :Domain, 'synapse/domain'
+  autoload :EventBus, 'synapse/event_bus'
+  autoload :Mapping, 'synapse/mapping'
+  autoload :Repository, 'synapse/repository'
+  autoload :Serialization, 'synapse/serialization'
+  autoload :UnitOfWork, 'synapse/uow'
+
+  # Optional components
+  autoload :Auditing, 'synapse/auditing'
+  autoload :Configuration, 'synapse/configuration'
+  autoload :EventSourcing, 'synapse/event_sourcing'
+  autoload :EventStore, 'synapse/event_store'
+  autoload :ProcessManager, 'synapse/process_manager'
+  autoload :Upcasting, 'synapse/upcasting'
+end
+

data/lib/synapse/command.rb

@@ -40,3 +40,4 @@ require 'synapse/command/gateway/interval_retry_scheduler'
 require 'synapse/command/gateway/retrying_callback'
 
 require 'synapse/command/callbacks/future'
+require 'synapse/command/callbacks/void'

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

@@ -5,6 +5,8 @@ module Synapse
       def initialize
         @mutex = Mutex.new
         @condition = ConditionVariable.new
+
+        @dispatched = false
       end
 
       # @raise [Exception] If an exception occured during command execution
@@ -16,9 +18,7 @@ module Synapse
             @condition.wait @mutex, timeout
           end
 
-          if @exception
-            raise @exception
-          end
+          raise @exception if @exception
 
           @result
         end

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

@@ -0,0 +1,14 @@
+module Synapse
+  module Command
+    # Implementation of a command callback that does nothing
+    class VoidCallback < CommandCallback
+      # @param [Object] result The result from the command handler
+      # @return [undefined]
+      def on_success(result); end
+
+      # @param [Exception] exception The cause of the failure
+      # @return [undefined]
+      def on_failure(exception); end
+    end # VoidCallback
+  end # Command
+end

data/lib/synapse/command/command_bus.rb

@@ -34,7 +34,7 @@ module Synapse
       #
       # @param [Class] command_type
       # @param [CommandHandler] handler
-      # @return [undefined]
+      # @return [CommandHandler] The command handler being replaced, if any
       def subscribe(command_type, handler)
         raise NotImplementedError
       end
@@ -44,7 +44,7 @@ module Synapse
       #
       # @param [Class] command_type
       # @param [CommandHandler] handler
-      # @return [undefined]
+      # @return [Boolean] True if command handler was unsubscribed from command handler
       def unsubscribe(command_type, handler)
         raise NotImplementedError
       end

data/lib/synapse/command/command_callback.rb

@@ -1,18 +1,25 @@
 module Synapse
   module Command
     # Callback that is notified of the outcome of the dispatch of a command
+    # @abstract
     class CommandCallback
       # Called when a dispatch is successful
       #
+      # @abstract
       # @param [Object] result The result from the command handler
       # @return [undefined]
-      def on_success(result); end
+      def on_success(result)
+        raise NotImplementedError
+      end
 
       # Called when a dispatch fails due to an exception
       #
+      # @abstract
       # @param [Exception] exception The cause of the failure
       # @return [undefined]
-      def on_failure(exception); end
+      def on_failure(exception)
+        raise NotImplementedError
+      end
     end # CommandCallback
   end # Command
 end

data/lib/synapse/command/gateway.rb

@@ -3,7 +3,7 @@ module Synapse
     # Simplified interface to the command bus
     # @api public
     class CommandGateway
-      # @return [Array]
+      # @return [Array<CommandFilter>]
       attr_reader :filters
 
       # @return [RetryScheduler]

data/lib/synapse/command/gateway/interval_retry_scheduler.rb

@@ -8,17 +8,17 @@ module Synapse
     # This implementation uses EventMachine to schedule one-shot timers.
     class IntervalRetryScheduler < RetryScheduler
       # @param [Float] interval
-      # @param [Integer] maxRetries
+      # @param [Integer] max_retries
       # @return [undefined]
-      def initialize(interval, maxRetries)
+      def initialize(interval, max_retries)
         @interval = interval
-        @maxRetries = maxRetries
+        @max_retries = max_retries
 
         @logger = Logging.logger[self.class]
       end
 
       # @param [CommandMessage] command
-      # @param [Array] failures
+      # @param [Array<Exception>] failures
       # @param [Proc] dispatcher
       # @return [Boolean]
       def schedule(command, failures, dispatcher)
@@ -33,7 +33,7 @@ module Synapse
 
         failureCount = failures.size
 
-        if failureCount > @maxRetries
+        if failureCount > @max_retries
           @logger.info 'Dispatch of command [%s] [%s] resulted in exception [%s] times' %
             [command.payload_type, command.id, failureCount]
 
@@ -42,7 +42,7 @@ module Synapse
 
         if @logger.info?
           @logger.info 'Dispatch of command [%s] [%s] resulted in exception; will retry up to [%s] more times' %
-            [command.payload_type, command.id, @maxRetries - failureCount]
+            [command.payload_type, command.id, @max_retries - failureCount]
         end
 
         perform_schedule command, dispatcher

data/lib/synapse/command/gateway/retry_scheduler.rb

@@ -16,11 +16,14 @@ module Synapse
       # the failure will be interpreted as terminal and the callback will be invoked with the
       # last recorded failure.
       #
+      # @abstract
       # @param [CommandMessage] command
-      # @param [Array] failures
+      # @param [Array<Exception>] failures
       # @param [Proc] dispatcher
       # @return [Boolean]
-      def schedule(command, failures, dispatcher); end
-    end
-  end
+      def schedule(command, failures, dispatcher)
+        raise NotImplementedError
+      end
+    end # RetryScheduler
+  end # Command
 end

data/lib/synapse/command/interceptor_chain.rb

@@ -8,7 +8,7 @@ module Synapse
     # command message that will be passed on in the chain.
     class InterceptorChain
       # @param [UnitOfWork] unit The current unit of work for this command dispatch
-      # @param [Array] interceptors
+      # @param [Array<DispatchInterceptor>] interceptors
       # @param [CommandHandler] handler
       # @return [undefined]
       def initialize(unit, interceptors, handler)

data/lib/synapse/command/interceptors/serialization.rb

@@ -4,6 +4,7 @@ module Synapse
     # serialization-aware message. This provides optimization in cases where storage (in an event
     # store) and publication (on the event bus) use the same serialization mechansim.
     class SerializationOptimizingInterceptor < DispatchInterceptor
+      # @return [undefined]
       def initialize
         @listener = SerializationOptimizingListener.new
       end
@@ -32,4 +33,4 @@ module Synapse
       end
     end # SerializationOptimizingListener
   end
-end
+end

data/lib/synapse/command/simple_command_bus.rb

@@ -6,10 +6,10 @@ module Synapse
       # @return [RollbackPolicy]
       attr_accessor :rollback_policy
 
-      # @return [Array]
+      # @return [Array<CommandFilter>]
       attr_reader :filters
 
-      # @return [Array]
+      # @return [Array<DispatchInterceptor>]
       attr_reader :interceptors
 
       # @param [UnitOfWorkFactory] unit_factory
@@ -30,7 +30,7 @@ module Synapse
       # @param [CommandMessage] command
       # @return [undefined]
       def dispatch(command)
-        dispatch_with_callback command, CommandCallback.new
+        dispatch_with_callback command, VoidCallback.new
       end
 
       # @api public
@@ -42,9 +42,9 @@ module Synapse
           result = perform_dispatch command
           callback.on_success result
         rescue => exception
-          backtrace = exception.backtrace.join $/
-          @logger.error 'Exception occured while dispatching command [%s] [%s]: %s %s' %
-            [command.payload_type, command.id, exception.inspect, backtrace]
+          backtrace = exception.backtrace.join $RS
+          @logger.error "Exception occured while dispatching command {#{command.payload_type}} {#{command.id}}:\n" +
+            "#{exception.inspect} #{backtrace}"
 
           callback.on_failure exception
         end
@@ -53,39 +53,29 @@ module Synapse
       # @api public
       # @param [Class] command_type
       # @param [CommandHandler] handler
-      # @return [undefined]
+      # @return [CommandHandler] The command handler being replaced, if any
       def subscribe(command_type, handler)
-        if @handlers.has_key? command_type
-          current_handler = @handlers.fetch command_type
-          @logger.info 'Command handler [%s] is being replaced by [%s] for command type [%s]' %
-            [current_handler.class, handler.class, command_type]
-        else
-          @logger.debug 'Command handler [%s] subscribed to command type [%s]' %
-            [handler.class, command_type]
-        end
+        current = @handlers.fetch command_type, nil
 
         @handlers.store command_type, handler
+        @logger.debug "Command handler {#{handler.class}} subscribed to command type {#{command_type}}"
+
+        current
       end
 
       # @api public
       # @param [Class] command_type
       # @param [CommandHandler] handler
-      # @return [undefined]
+      # @return [Boolean] True if command handler was unsubscribed from command handler
       def unsubscribe(command_type, handler)
-        if @handlers.has_key? command_type
-          current_handler = @handlers.fetch command_type
-          if current_handler.equal? handler
-            @handlers.delete command_type
+        current = @handlers.fetch command_type, nil
 
-            @logger.debug 'Command handler [%s] unsubscribed from command type [%s]' %
-              [handler.class, command_type]
-          else
-            @logger.info 'Command type [%s] subscribed to handler [%s] not [%s]' %
-              [command_type, current_handler.class, handler.class]
-          end
-        else
-          @logger.info 'Command type [%s] not subscribed to any handler' % command_type
-        end
+        return false unless current === handler
+
+        @handlers.delete command_type
+        @logger.debug "Command handler {#{handler.class}} unsubscribed from command type {#{command_type}}"
+
+        return true
       end
 
     protected
@@ -107,8 +97,7 @@ module Synapse
         chain = InterceptorChain.new unit, @interceptors, handler
 
         begin
-          @logger.info 'Dispatching command [%s] [%s] to handler [%s]' %
-            [command.id, command.payload_type, handler.class]
+          @logger.info "Dispatching command {#{command.id}} {#{command.payload_type}} to handler {#{handler.class}}"
 
           result = chain.proceed command
         rescue => exception
@@ -132,12 +121,12 @@ module Synapse
       # @param [CommandMessage] command
       # @return [CommandHandler]
       def handler_for(command)
-        type = command.payload_type
+        command_type = command.payload_type
 
         begin
-          @handlers.fetch type
+          @handlers.fetch command_type
         rescue KeyError
-          raise NoHandlerError, 'No handler subscribed for command [%s]' % type
+          raise NoHandlerError, "No handler subscribed for command {#{command_type}}"
         end
       end
     end # SimpleCommandBus

data/lib/synapse/common.rb

@@ -3,7 +3,7 @@ require 'synapse/common/identifier'
 require 'synapse/common/message'
 require 'synapse/common/message_builder'
 
-require 'synapse/common/concurrency/identifier_lock'
-require 'synapse/common/concurrency/public_lock'
+require 'synapse/common/concurrency/disposable_lock'
+require 'synapse/common/concurrency/identifier_lock_manager'
 
 require 'synapse/common/duplication'

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

@@ -0,0 +1,157 @@
+module Synapse
+  # @api private
+  class DisposableLock
+    # @return [Boolean]
+    attr_reader :closed
+
+    alias_method :closed?, :closed
+
+    # @return [Thread]
+    attr_reader :owner
+
+    # @return [Array]
+    attr_reader :waiters
+
+    # @return [undefined]
+    def initialize
+      @mutex = Mutex.new
+
+      @closed = false
+      @hold_count = 0
+      @owner = nil
+      @waiters = Array.new
+    end
+
+    # @return [Boolean]
+    def owned?
+      @owner == Thread.current
+    end
+
+    # @param [Thread] thread
+    # @return [Boolean]
+    def owned_by?(thread)
+      @owner == thread
+    end
+
+    # @return [Boolean]
+    def locked?
+      @hold_count > 0
+    end
+
+    # @return [Boolean] False if lock has been closed
+    def lock
+      @mutex.synchronize do
+        unless owned?
+          if @hold_count == 0
+            @owner = Thread.current
+          else
+            @waiters.push Thread.current
+
+            begin
+              wait_for_lock
+            ensure
+              @waiters.delete Thread.current
+            end
+
+            return unless owned?
+          end
+        end
+
+        @hold_count += 1
+      end
+
+      if closed?
+        unlock
+        return false
+      end
+
+      return true
+    end
+
+    # @return [Boolean]
+    def try_lock
+      @mutex.synchronize do
+        unless owned?
+          if @hold_count == 0
+            @owner = Thread.current
+          else
+            return false
+          end
+        end
+
+        @hold_count += 1
+        return true
+      end
+    end
+
+    # @raise [RuntimeError] If caller does not own the lock
+    # @return [undefined]
+    def unlock
+      @mutex.synchronize do
+        raise RuntimeError unless owned?
+
+        @hold_count -= 1
+
+        if @hold_count == 0
+          @owner = nil
+          wakeup_next_waiter
+        end
+      end
+    end
+
+    # @return [Boolean] True if lock was closed
+    def try_close
+      return false unless try_lock
+
+      begin
+        if @hold_count == 1
+          @closed = true
+          return true
+        end
+
+        return false
+      ensure
+        unlock
+      end
+    end
+
+  private
+
+    # @raise [DeadlockError]
+    # @return [undefined]
+    def check_for_deadlock
+      return if owned?
+      return unless locked?
+
+      for waiter in IdentifierLockManager.waiters_for_locks_owned_by(Thread.current)
+        if owned_by? waiter
+          raise DeadlockError
+        end
+      end
+    end
+
+    # Mutex must be locked to perform this operation
+    # @return [undefined]
+    def wait_for_lock
+      loop do
+        if @hold_count == 0
+          @owner = Thread.current
+          return
+        end
+
+        check_for_deadlock
+        @mutex.sleep 0.1 # Sleep for 100 milliseconds
+      end
+    end
+
+    # @return [undefined]
+    def wakeup_next_waiter
+      begin
+        n = @waiters.shift
+        n.wakeup if n
+      rescue ThreadError
+        retry
+      end
+    end
+  end # DisposableLock
+end