concurrent-ruby-edge 0.1.0.pre2

data/lib/concurrent/actor/behaviour/terminates_children.rb

@@ -0,0 +1,14 @@
+module Concurrent
+  module Actor
+    module Behaviour
+      # Terminates all children when the actor terminates.
+      class TerminatesChildren < Abstract
+        def on_event(public, event)
+          event_name, _ = event
+          children.map { |ch| ch << :terminate! } if event_name == :terminated
+          super public, event
+        end
+      end
+    end
+  end
+end

data/lib/concurrent/actor/behaviour/termination.rb

@@ -0,0 +1,74 @@
+module Concurrent
+  module Actor
+    module Behaviour
+
+      # Handles actor termination.
+      # @note Actor rejects envelopes when terminated.
+      # @note TODO missing example
+      class Termination < Abstract
+
+        # @!attribute [r] terminated
+        #   @return [Edge::Event] event which will become set when actor is terminated.
+        # @!attribute [r] reason
+        attr_reader :terminated, :reason
+
+        def initialize(core, subsequent, core_options, trapping = false)
+          super core, subsequent, core_options
+          @terminated        = Concurrent.event
+          @public_terminated = @terminated.hide_completable
+          @reason            = nil
+          @trapping          = trapping
+        end
+
+        # @note Actor rejects envelopes when terminated.
+        # @return [true, false] if actor is terminated
+        def terminated?
+          @terminated.completed?
+        end
+
+        def trapping?
+          @trapping
+        end
+
+        def trapping=(val)
+          @trapping = !!val
+        end
+
+        def on_envelope(envelope)
+          command, reason = envelope.message
+          case command
+          when :terminated?
+            terminated?
+          when :terminate!
+            if trapping? && reason != :kill
+              pass envelope
+            else
+              terminate! reason
+            end
+          when :termination_event
+            @public_terminated
+          else
+            if terminated?
+              reject_envelope envelope
+              MESSAGE_PROCESSED
+            else
+              pass envelope
+            end
+          end
+        end
+
+        # Terminates the actor. Any Envelope received after termination is rejected.
+        # Terminates all its children, does not wait until they are terminated.
+        def terminate!(reason = :normal)
+          # TODO return after all children are terminated
+          return true if terminated?
+          @reason = reason
+          terminated.complete
+          broadcast(true, [:terminated, reason]) # TODO do not end up in Dead Letter Router
+          parent << :remove_child if parent
+          true
+        end
+      end
+    end
+  end
+end

data/lib/concurrent/actor/context.rb

@@ -0,0 +1,167 @@
+require 'concurrent/concern/logging'
+
+module Concurrent
+  module Actor
+
+    # New actor is defined by subclassing {RestartingContext}, {Context} and defining its abstract methods.
+    # {AbstractContext} can be subclassed directly to implement more specific behaviour see {Root} implementation.
+    #
+    # -   {Context}
+    #
+    #     > {include:Actor::Context}
+    #
+    # -   {RestartingContext}.
+    #
+    #     > {include:Actor::RestartingContext}
+    #
+    # Example of ac actor definition:
+    # 
+    # {include:file:doc/actor/define.out.rb}
+    #
+    # See methods of {AbstractContext} what else can be tweaked, e.g {AbstractContext#default_reference_class}
+    #
+    # @abstract implement {AbstractContext#on_message} and {AbstractContext#behaviour_definition}
+    class AbstractContext
+      include TypeCheck
+      include InternalDelegations
+      include Concern::Logging
+
+      attr_reader :core
+
+      # @abstract override to define Actor's behaviour
+      # @param [Object] message
+      # @return [Object] a result which will be used to set the Future supplied to Reference#ask
+      # @note self should not be returned (or sent to other actors), {#reference} should be used
+      #   instead
+      def on_message(message)
+        raise NotImplementedError
+      end
+
+      # override to add custom code invocation on internal events like `:terminated`, `:resumed`, `anError`.
+      def on_event(event)
+      end
+
+      # @api private
+      def on_envelope(envelope)
+        @envelope = envelope
+        on_message envelope.message
+      ensure
+        @envelope = nil
+      end
+
+      # if you want to pass the message to next behaviour, usually
+      # {Behaviour::ErrorsOnUnknownMessage}
+      def pass
+        core.behaviour!(Behaviour::ExecutesContext).pass envelope
+      end
+
+      # Defines an actor responsible for dead letters. Any rejected message send
+      # with {Reference#tell} is sent there, a message with future is considered
+      # already monitored for failures. Default behaviour is to use
+      # {AbstractContext#dead_letter_routing} of the parent, so if no
+      # {AbstractContext#dead_letter_routing} method is overridden in
+      # parent-chain the message ends up in `Actor.root.dead_letter_routing`
+      # agent which will log warning.
+      # @return [Reference]
+      def dead_letter_routing
+        parent.dead_letter_routing
+      end
+
+      # @return [Array<Array(Behavior::Abstract, Array<Object>)>]
+      def behaviour_definition
+        raise NotImplementedError
+      end
+
+      # @return [Envelope] current envelope, accessible inside #on_message processing
+      def envelope
+        @envelope or raise 'envelope not set'
+      end
+
+      # override if different class for reference is needed
+      # @return [CLass] descendant of {Reference}
+      def default_reference_class
+        Reference
+      end
+
+      # override to se different default executor, e.g. to change it to global_operation_pool
+      # @return [Executor]
+      def default_executor
+        Concurrent.global_io_executor
+      end
+
+      # tell self a message
+      def tell(message)
+        reference.tell message
+      end
+
+      def ask(message)
+        raise 'actor cannot ask itself'
+      end
+
+      alias_method :<<, :tell
+      alias_method :ask!, :ask
+
+      # Behaves as {Concurrent::Actor.spawn} but :class is auto-inserted based on receiver so it can be omitted.
+      # @example by class and name
+      #   AdHoc.spawn(:ping1) { -> message { message } }
+      #
+      # @example by option hash
+      #   inc2 = AdHoc.spawn(name:     'increment by 2',
+      #                      args:     [2],
+      #                      executor: Concurrent.configuration.global_task_pool) do |increment_by|
+      #     lambda { |number| number + increment_by }
+      #   end
+      #   inc2.ask!(2) # => 4
+      # @see Concurrent::Actor.spawn
+      def self.spawn(name_or_opts, *args, &block)
+        Actor.spawn to_spawn_options(name_or_opts, *args), &block
+      end
+
+      # behaves as {Concurrent::Actor.spawn!} but :class is auto-inserted based on receiver so it can be omitted.
+      def self.spawn!(name_or_opts, *args, &block)
+        Actor.spawn! to_spawn_options(name_or_opts, *args), &block
+      end
+
+      private
+
+      def initialize_core(core)
+        @core = Type! core, Core
+      end
+
+      def self.to_spawn_options(name_or_opts, *args)
+        if name_or_opts.is_a? Hash
+          if name_or_opts.key?(:class) && name_or_opts[:class] != self
+            raise ArgumentError,
+                  ':class option is ignored when calling on context class, use Actor.spawn instead'
+          end
+          name_or_opts.merge class: self
+        else
+          { class: self, name: name_or_opts, args: args }
+        end
+      end
+
+      # to avoid confusion with Kernel.spawn
+      undef_method :spawn
+    end
+
+    # Basic Context of an Actor. It supports only linking and it simply terminates on error.
+    # Uses {Behaviour.basic_behaviour_definition}:
+    #
+    # @abstract implement {AbstractContext#on_message}
+    class Context < AbstractContext
+      def behaviour_definition
+        Behaviour.basic_behaviour_definition
+      end
+    end
+
+    # Context of an Actor for robust systems. It supports supervision, linking, pauses on error.
+    # Uses {Behaviour.restarting_behaviour_definition}
+    #
+    # @abstract implement {AbstractContext#on_message}
+    class RestartingContext < AbstractContext
+      def behaviour_definition
+        Behaviour.restarting_behaviour_definition
+      end
+    end
+  end
+end

data/lib/concurrent/actor/core.rb

@@ -0,0 +1,220 @@
+require 'concurrent/concern/logging'
+require 'concurrent/executors'
+
+module Concurrent
+  module Actor
+
+    require 'set'
+
+    # Core of the actor.
+    # @note Whole class should be considered private. An user should use {Context}s and {Reference}s only.
+    # @note devel: core should not block on anything, e.g. it cannot wait on children to terminate
+    #   that would eat up all threads in task pool and deadlock
+    class Core < Synchronization::Object
+      include TypeCheck
+      include Concern::Logging
+
+      # @!attribute [r] reference
+      #   Reference to this actor which can be safely passed around.
+      #   @return [Reference]
+      # @!attribute [r] name
+      #   The name of actor instance, it should be uniq (not enforced). Allows easier orientation
+      #   between actor instances.
+      #   @return [String]
+      # @!attribute [r] path
+      #   Path of this actor. It is used for easier orientation and logging.
+      #   Path is constructed recursively with: `parent.path + self.name` up to a {Actor.root},
+      #   e.g. `/an_actor/its_child`.
+      #   @return [String]
+      # @!attribute [r] executor
+      #   Executor which is used to process messages.
+      #   @return [Executor]
+      # @!attribute [r] actor_class
+      #   A subclass of {AbstractContext} representing Actor's behaviour.
+      #   @return [Context]
+      attr_reader :reference, :name, :path, :executor, :context_class, :context, :behaviour_definition
+
+      # @option opts [String] name
+      # @option opts [Context] actor_class a class to be instantiated defining Actor's behaviour
+      # @option opts [Array<Object>] args arguments for actor_class instantiation
+      # @option opts [Executor] executor, default is `global_io_executor`
+      # @option opts [true, false] link, atomically link the actor to its parent (default: true)
+      # @option opts [Class] reference a custom descendant of {Reference} to use
+      # @option opts [Array<Array(Behavior::Abstract, Array<Object>)>] behaviour_definition, array of pairs
+      #   where each pair is behaviour class and its args, see {Behaviour.basic_behaviour_definition}
+      # @option opts [CompletableFuture, nil] initialized, if present it'll be set or failed after {Context} initialization
+      # @option opts [Reference, nil] parent **private api** parent of the actor (the one spawning )
+      # @option opts [Proc, nil] logger a proc accepting (level, progname, message = nil, &block) params,
+      #   can be used to hook actor instance to any logging system, see {Concurrent::Concern::Logging}
+      # @param [Proc] block for class instantiation
+      def initialize(opts = {}, &block)
+        super(&nil)
+        synchronize { ns_initialize(opts, &block) }
+      end
+
+      # A parent Actor. When actor is spawned the {Actor.current} becomes its parent.
+      # When actor is spawned from a thread outside of an actor ({Actor.current} is nil) {Actor.root} is assigned.
+      # @return [Reference, nil]
+      def parent
+        @parent_core && @parent_core.reference
+      end
+
+      # @see AbstractContext#dead_letter_routing
+      def dead_letter_routing
+        @context.dead_letter_routing
+      end
+
+      # @return [Array<Reference>] of children actors
+      def children
+        guard!
+        @children.to_a
+      end
+
+      # @api private
+      def add_child(child)
+        guard!
+        Type! child, Reference
+        @children.add child
+        nil
+      end
+
+      # @api private
+      def remove_child(child)
+        guard!
+        Type! child, Reference
+        @children.delete child
+        nil
+      end
+
+      # is executed by Reference scheduling processing of new messages
+      # can be called from other alternative Reference implementations
+      # @param [Envelope] envelope
+      def on_envelope(envelope)
+        schedule_execution do
+          log DEBUG, "was #{envelope.future ? 'asked' : 'told'} #{envelope.message.inspect} by #{envelope.sender}"
+          process_envelope envelope
+        end
+        nil
+      end
+
+      # ensures that we are inside of the executor
+      def guard!
+        unless Actor.current == reference
+          raise "can be called only inside actor #{reference} but was #{Actor.current}"
+        end
+      end
+
+      def log(level, message = nil, &block)
+        super level, @path, message, &block
+      end
+
+      # Schedules blocks to be executed on executor sequentially,
+      # sets Actress.current
+      def schedule_execution
+        @serialized_execution.post(@executor) do
+          synchronize do
+            begin
+              Thread.current[:__current_actor__] = reference
+              yield
+            rescue => e
+              log FATAL, e
+            ensure
+              Thread.current[:__current_actor__] = nil
+            end
+          end
+        end
+
+        nil
+      end
+
+      def broadcast(public, event)
+        log DEBUG, "event: #{event.inspect} (#{public ? 'public' : 'private'})"
+        @first_behaviour.on_event(public, event)
+      end
+
+      # @param [Class] behaviour_class
+      # @return [Behaviour::Abstract, nil] based on behaviour_class
+      def behaviour(behaviour_class)
+        @behaviours[behaviour_class]
+      end
+
+      # @param [Class] behaviour_class
+      # @return [Behaviour::Abstract] based on behaviour_class
+      # @raise [KeyError] when no behaviour
+      def behaviour!(behaviour_class)
+        @behaviours.fetch behaviour_class
+      end
+
+      # @api private
+      def allocate_context
+        @context = @context_class.allocate
+      end
+
+      # @api private
+      def build_context
+        @context.send :initialize_core, self
+        @context.send :initialize, *@args, &@block
+      end
+
+      # @api private
+      def process_envelope(envelope)
+        @first_behaviour.on_envelope envelope
+      end
+
+      private
+
+      def ns_initialize(opts, &block)
+        @mailbox              = Array.new
+        @serialized_execution = SerializedExecution.new
+        @children             = Set.new
+
+        @context_class = Child! opts.fetch(:class), AbstractContext
+        allocate_context
+
+        @executor = Type! opts.fetch(:executor, @context.default_executor), Concurrent::AbstractExecutorService
+        raise ArgumentError, 'ImmediateExecutor is not supported' if @executor.is_a? ImmediateExecutor
+
+        @reference = (Child! opts[:reference_class] || @context.default_reference_class, Reference).new self
+        @name      = (Type! opts.fetch(:name), String, Symbol).to_s
+
+        parent       = opts[:parent]
+        @parent_core = (Type! parent, Reference, NilClass) && parent.send(:core)
+        if @parent_core.nil? && @name != '/'
+          raise 'only root has no parent'
+        end
+
+        @path   = @parent_core ? File.join(@parent_core.path, @name) : @name
+        @logger = opts[:logger]
+
+        @parent_core.add_child reference if @parent_core
+
+        initialize_behaviours opts
+
+        @args       = opts.fetch(:args, [])
+        @block      = block
+        initialized = Type! opts[:initialized], Edge::CompletableFuture, NilClass
+
+        schedule_execution do
+          begin
+            build_context
+            initialized.success reference if initialized
+            log DEBUG, 'spawned'
+          rescue => ex
+            log ERROR, ex
+            @first_behaviour.terminate!
+            initialized.fail ex if initialized
+          end
+        end
+      end
+
+      def initialize_behaviours(opts)
+        @behaviour_definition = (Type! opts[:behaviour_definition] || @context.behaviour_definition, Array).each do |(behaviour, *args)|
+          Child! behaviour, Behaviour::Abstract
+        end
+        @behaviours           = {}
+        @first_behaviour      = @behaviour_definition.reverse.
+            reduce(nil) { |last, (behaviour, *args)| @behaviours[behaviour] = behaviour.new(self, last, opts, *args) }
+      end
+    end
+  end
+end