celluloid 0.18.0.pre → 0.18.0

data/lib/celluloid/supervision/constants.rb

@@ -0,0 +1,123 @@
+module Celluloid
+  module Supervision
+    # TODO: Do not hard-code. Allow configurable values.
+    INSTANCE_RETRY_WAIT = 3
+    INSTANCE_RETRY_LIMIT = 5
+
+    module Error
+      class NoPublicService < Celluloid::Error; end
+    end
+
+    class Configuration
+      module Error
+        class AlreadyDefined < Celluloid::Error; end
+        class InvalidSupervisor < Celluloid::Error; end
+        class InvalidValues < Celluloid::Error; end
+        class Incomplete < Celluloid::Error; end
+        class Invalid < Celluloid::Error; end
+      end
+
+      # Using class variable so that parameters can be added by plugins.
+
+      @@parameters = {
+
+        mandatory: [:type],
+
+        optional: %i[
+          as
+          args
+          block
+        ],
+
+        # TODO: Move these into Behaviors.
+        plugins: [
+          # de :size,        # Supervision::Pool
+          # de :routers,     # Supervision::Coordinator
+          # de :supervises   # Supervision::Tree
+        ],
+
+        meta: %i[
+          registry
+          branch
+          method
+        ]
+      }
+
+      @@arity = {
+        type: :args
+      }
+
+      @@aliases = {
+        name: :as,
+        kind: :type,
+        # de :pool => :size,   # TODO: Move into Behaviors.
+        # de :supervise => :supervises
+      }
+
+      @@defaults = {}
+
+      class << self
+        def save_defaults
+          @@defaults = {
+            parameters: @@parameters.each_with_object({}) { |(k, v), p| p[k] = v.dup; },
+            aliases: @@aliases.dup,
+            arity: @@arity.dup
+          }
+        end
+
+        def resync_parameters
+          @@parameters = @@defaults[:parameters].each_with_object({}) { |(k, v), p| p[k] = v.dup; }
+          @@aliases = @@defaults[:aliases].dup
+          @@arity = @@defaults[:arity].dup
+        end
+
+        def parameters(*args)
+          args.inject([]) { |parameters, p| parameters += @@parameters[p]; parameters }
+        end
+
+        def parameter!(key, value)
+          @@parameters[key] << value unless @@parameters[key].include? value
+        end
+
+        def arity
+          @@arity
+        end
+
+        def arity!(key, value)
+          @@arity[key] = value
+        end
+
+        def aliases
+          @@aliases
+        end
+
+        def alias!(aliased, original)
+          @@aliases[aliased] = original
+        end
+      end
+
+      save_defaults
+      resync_parameters
+
+      # This was originally added for `#pool` and `PoolManager
+      # `:before_initialize` was added to allow detecting `:size => N`
+      # and turning that into a pool. Other uses could be for `coordinator`
+      # appointing a `router` by detecting `:routers => N`, and many other uses.
+
+      ################ These are applied inside Supervision::Member ################
+
+      REMOVE_AT_EXPORT = %i[
+        configuration
+        behavior
+      ].freeze
+
+      INJECTIONS = %i[
+        configuration
+        before_initialization
+        after_initialization
+        before_start
+        before_restart
+      ].freeze
+    end
+  end
+end

data/lib/celluloid/supervision/container.rb

@@ -0,0 +1,144 @@
+module Celluloid
+  # Supervise actor instances in a container.
+  module Supervision
+    class Container
+      include Celluloid
+
+      trap_exit :restart_actor
+
+      class << self
+        def define(options)
+          Configuration.define(top(options))
+        end
+
+        def deploy(options)
+          Configuration.deploy(top(options))
+        end
+
+        def top(options)
+          {
+            as: options.delete(:as),
+            type: (options.delete(:type) || self),
+            branch: (options.delete(:branch) || :services),
+            supervise: options.delete(:supervise) || []
+          }
+        end
+
+        # Actors or sub-applications to be supervised
+        def blocks
+          @blocks ||= []
+        end
+
+        # Start this application (and watch it with a supervisor)
+        def run!(options = {})
+          container = new(options) do |g|
+            blocks.each do |block|
+              block.call(g)
+            end
+          end
+          container
+        end
+
+        # Run the application in the foreground with a simple watchdog
+        def run(options = {})
+          loop do
+            supervisor = run!(options)
+
+            # Take five, toplevel supervisor
+            sleep 5 while supervisor.alive? # Why 5?
+
+            Internals::Logger.error "!!! Celluloid::Supervision::Container #{self} crashed. Restarting..."
+          end
+        end
+      end
+
+      finalizer :finalize
+
+      attr_accessor :registry
+
+      # Start the container.
+      def initialize(options = {})
+        options = { registry: options } if options.is_a? Internals::Registry
+        @state = :initializing
+        @actors = [] # instances in the container
+        @registry = options.delete(:registry) || Celluloid.actor_system.registry
+        @branch = options.delete(:branch) || :services
+        yield current_actor if block_given?
+      end
+
+      execute_block_on_receiver :initialize, :supervise, :supervise_as
+
+      def add(configuration)
+        Configuration.valid?(configuration, true)
+        @actors << Instance.new(configuration.merge(registry: @registry, branch: @branch))
+        @state = :running
+        add_accessors configuration
+        Actor.current
+      end
+
+      def add_accessors(configuration)
+        if configuration[:as]
+          unless methods.include? configuration[:as]
+            self.class.instance_eval do
+              define_method(configuration[:as]) do
+                @registry[configuration[:as]]
+              end
+            end
+          end
+        end
+      end
+
+      def remove_accessors; end
+
+      def remove(actor)
+        actor = Celluloid::Actor[actor] if actor.is_a? Symbol
+        instance = find(actor)
+        instance.terminate if instance
+      end
+
+      def actors
+        @actors.map(&:actor)
+      end
+
+      def find(actor)
+        @actors.find do |instance|
+          instance.actor == actor
+        end
+      end
+
+      def [](actor_name)
+        @registry[actor_name]
+      end
+
+      # Restart a crashed actor
+      def restart_actor(actor, reason)
+        return if @state == :shutdown
+        instance = find(actor)
+        raise "a container instance went missing. This shouldn't be!" unless instance
+
+        if reason
+          exclusive { instance.restart }
+        else
+          instance.cleanup
+          @actors.delete(instance)
+        end
+      end
+
+      def shutdown
+        @state = :shutdown
+        finalize
+      end
+
+      private
+
+      def finalize
+        if @actors
+          @actors.reverse_each do |instance|
+            instance.terminate
+            @actors.delete(instance)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/celluloid/supervision/container/behavior.rb

@@ -0,0 +1,89 @@
+module Celluloid
+  module Supervision
+    class Container
+      module Behavior
+        @@injections = {}  # Hash of Class => Hash of Injections
+        @@behaviors = {}   # Hash of identifying symbol parameter => Class
+
+        module Error
+          class Mutant < Celluloid::Error; end
+        end
+
+        class << self
+          def included(klass)
+            klass.send :extend, ClassMethods
+          end
+
+          def injections
+            @@injections
+          end
+
+          def [](identifier)
+            @@behaviors[identifier]
+          end
+
+          def []=(identifier, behavior)
+            @@behaviors[identifier] = behavior
+          end
+
+          def parameter(identifier, options)
+            found = nil
+            p = Configuration.aliases.each_with_object([identifier]) { |(a, i), invoke| invoke << a if i == identifier; }
+            case p.count { |parameter| found = parameter; options.key?(parameter) }
+            when 1
+              found
+            when 0
+
+            else
+              raise Error::Mutant, "More than one kind of identifiable behavior parameter."
+            end
+          end
+
+          # Beware of order. There may be multiple behavior injections, but their order is not determined ( yet )
+          # Right now, something like a pool-coordinator-tree supervisor mutant are absolutely expected to crash.
+          # Therefore, sorry Professor X -- we kill every Mutant. On sight, no questions asked. Zero mutant love.
+          def configure(options)
+            behavior = nil
+            injection = nil
+            @@behaviors.map do |identifier, injector|
+              if identifier = parameter(identifier, options)
+                if behavior
+                  raise Error::Mutant, "More than one type of behavior expected."
+                else
+                  if @@injections[injector].include?(:configuration)
+                    injection = @@injections[behavior = injector][:configuration]
+                    options[:behavior] ||= behavior
+                  end
+                end
+              end
+            end
+
+            options[:type] ||= behavior
+            injection || proc { @configuration }
+          end
+
+          module ClassMethods
+            def identifier!(identifier, *aliases)
+              Behavior[identifier] = self
+              Configuration.parameter! :plugins, identifier
+              aliases.each do |aliased|
+                Configuration.alias! aliased, identifier
+              end
+              Configuration.save_defaults
+            end
+
+            def behavior_injections
+              Behavior.injections[self] ||= {}
+            end
+
+            Configuration::INJECTIONS.each do |point|
+              define_method(point) do |&injector|
+                behavior_injections[point] = injector
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/celluloid/supervision/container/behavior/pool.rb

@@ -0,0 +1,71 @@
+require "set"
+
+module Celluloid
+  module ClassMethods
+    extend Forwardable
+    def_delegators :"Celluloid::Supervision::Container::Pool", :pooling_options
+    # Create a new pool of workers. Accepts the following options:
+    #
+    # * size: how many workers to create. Default is worker per CPU core
+    # * args: array of arguments to pass when creating a worker
+    #
+    def pool(config = {}, &block)
+      _ = Celluloid.supervise(pooling_options(config, block: block, actors: self))
+      _.actors.last
+    end
+
+    # Same as pool, but links to the pool manager
+    def pool_link(klass, config = {}, &block)
+      Supervision::Container::Pool.new_link(pooling_options(config, block: block, actors: klass))
+    end
+  end
+
+  module Supervision
+    class Container
+      extend Forwardable
+      def_delegators :"Celluloid::Supervision::Container::Pool", :pooling_options
+
+      def pool(klass, config = {}, &block)
+        _ = supervise(pooling_options(config, block: block, actors: klass))
+        _.actors.last
+      end
+
+      class Instance
+        attr_accessor :pool, :pool_size
+      end
+
+      class << self
+        # Register a pool of actors to be launched on group startup
+        def pool(klass, config, &block)
+          blocks << lambda do |container|
+            container.pool(klass, config, &block)
+          end
+        end
+      end
+
+      class Pool
+        include Behavior
+
+        class << self
+          def pooling_options(config = {}, mixins = {})
+            combined = { type: Celluloid::Supervision::Container::Pool }.merge(config).merge(mixins)
+            combined[:args] = [%i[block actors size args].each_with_object({}) do |p, e|
+              e[p] = combined.delete(p) if combined[p]
+            end]
+            combined
+          end
+        end
+
+        identifier! :size, :pool
+
+        configuration do
+          @supervisor = Container::Pool
+          @method = "pool_link"
+          @pool = true
+          @pool_size = @configuration[:size]
+          @configuration
+        end
+      end
+    end
+  end
+end

data/lib/celluloid/supervision/container/behavior/tree.rb

@@ -0,0 +1,23 @@
+module Celluloid
+  module Supervision
+    class Container
+      class Tree
+        include Behavior
+
+        identifier! :supervises, :supervise
+
+        configuration do
+          if @configuration[:supervise].is_a? Array
+            @supervisor = @configuration.dup
+            @branch = @configuration.fetch(:branch, @configuration[:as])
+            @configuration.delete(Behavior.parameter(:supervise, @configuration))
+          elsif @configuration[:supervise].is_a?(Celluloid::Supervision::Configuration)
+            @configuration
+          else
+            raise ArgumentError, "No actors given to Tree to supervise."
+          end
+        end
+      end
+    end
+  end
+end