Cleanups and logger feature.

Author: chadrem

Gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: .
   specs:
-    tribe (0.6.0)
+    tribe (0.6.1)
       workers (~> 0.4)
 
 GEM

README.md

@@ -471,6 +471,17 @@ To support in the tens of thousands, hundreds of thousands, or potentially milli
     # The pool size is back to the default size.
     puts "Pool size (after): #{Workers.pool.size}"
 
+## Logging
+
+Tribe provides a shared instance of ````Logger```` for your convenience:
+
+    Tribe.logger
+
+Every actor also has access to it through the ````logger```` convenience method.
+
+By default, the logger will log to STDOUT.
+You should change this to a file in your application.
+
 ## Debugging
 
 Tribe is written in pure Ruby so it will work with all existing debuggers that support Ruby & threads.

lib/tribe.rb

@@ -1,4 +1,6 @@
 require 'set'
+require 'logger'
+require 'thread'
 
 require 'workers'
 
@@ -16,11 +18,36 @@
 require 'tribe/root'
 
 module Tribe
+  @lock = Monitor.new
+
+  class << self
+    attr_reader :lock
+  end
+
   def self.registry
-    return @registry ||= Tribe::Registry.new
+    @lock.synchronize do
+      @registry ||= Tribe::Registry.new
+    end
   end
 
   def self.root
-    @root ||= Tribe::Root.new(:name => 'root', :permit_root => true)
+    @lock.synchronize do
+      @root ||= Tribe::Root.new(:name => 'root', :permit_root => true)
+    end
+  end
+
+  def self.logger
+    @lock.synchronize do
+      @logger
+    end
+  end
+
+  def self.logger=(val)
+    @lock.synchronize do
+      @logger = val
+    end
   end
 end
+
+Tribe.logger = Logger.new(STDOUT)
+Tribe.logger.level = Logger::DEBUG

lib/tribe/actable.rb

@@ -2,25 +2,26 @@ module Tribe
   module Actable
     include Workers::Helpers
 
+    private
+
     #
     # Initialization method.
     # Notes: Call this in your constructor.
     #
 
-    private
-
     def init_actable(options = {})
       # Symbols aren't GCed in JRuby so force string names.
       if options[:name] && !options[:name].is_a?(String)
         raise Tribe::ActorNameError.new('Name must be a string.')
       end
 
-      @logger = Workers::LogProxy.new(options[:logger])
       @_actable = Tribe::ActorState.new
+
       @_actable.dedicated = options[:dedicated] || false
       @_actable.pool = @_actable.dedicated ? Workers::Pool.new(:size => 1) : (options[:pool] || Workers.pool)
       @_actable.mailbox = Tribe::Mailbox.new(@_actable.pool)
       @_actable.registry = options[:registry] || Tribe.registry
+      @_actable.logger = Workers::LogProxy.new(options[:logger] || Tribe.logger)
       @_actable.scheduler = options[:scheduler] || Workers.scheduler
       @_actable.name = options[:name]
       @_actable.parent = options[:parent]
@@ -47,38 +48,21 @@ def deliver_event!(event)
         process_events
       end
 
-      return nil
+      nil
     end
 
     def direct_message!(command, data = nil, src = nil)
       deliver_event!(Tribe::Event.new(command, data, src))
 
-      return nil
-    end
-
-    def message!(dest, command, data = nil)
-      event = Tribe::Event.new(command, data, self)
-
-      dest.deliver_event!(event)
-
-      return nil
-    end
-
-    def future!(dest, command, data = nil)
-      event = Tribe::Event.new(command, data, self)
-      event.future = future = Tribe::Future.new(self)
-
-      dest.deliver_event!(event)
-
-      return future
+      nil
     end
 
     def shutdown!
-      return direct_message!(:__shutdown__)
+      direct_message!(:__shutdown__)
     end
 
     def perform!(&block)
-      return direct_message!(:__perform__, block)
+      direct_message!(:__perform__, block)
     end
 
     def spawn!(klass, actor_options = {}, spawn_options = {})
@@ -102,7 +86,7 @@ def spawn!(klass, actor_options = {}, spawn_options = {})
         @_actable.supervisees.add(child)
       end
 
-      return child
+      child
     end
 
     def alive?
@@ -114,23 +98,27 @@ def dead?
     end
 
     def name
-      return @_actable.name
+      @_actable.name
     end
 
     def identifier
-      return @_actable.name ? "#{object_id}:#{@_actable.name}" : object_id
+      @_actable.name ? "#{object_id}:#{@_actable.name}" : object_id
     end
 
     def exception
-      return @_actable.exception
+      @_actable.exception
     end
 
     def registry
-      return @_actable.registry
+      @_actable.registry
     end
 
     def pool
-      return @_actable.pool
+      @_actable.pool
+    end
+
+    def logger
+      @_actable.logger
     end
 
     #
@@ -179,7 +167,7 @@ def process_events
         process_events
       end
 
-      return nil
+      nil
     end
 
     def event_handler(event)
@@ -220,7 +208,7 @@ def custom_event_handler(event)
         @_actable.active_event = nil
       end
 
-      return nil
+      nil
     end
 
     def initialize_handler(event)
@@ -236,9 +224,14 @@ def exception_handler(exception)
       @_actable.children.clear
       @_actable.supervisees.clear
 
+      log_exception_handler(exception)
       on_exception(Event.new(:exception, {:exception => exception}))
 
-      return nil
+      nil
+    end
+
+    def log_exception_handler(exception)
+      logger.error("EXCEPTION: #{exception.message}\n#{exception.backtrace.join("\n")}\n--")
     end
 
     def shutdown_handler(event)
@@ -252,13 +245,13 @@ def shutdown_handler(event)
 
       on_shutdown(Event.new(:shutdown, {}))
 
-      return nil
+      nil
     end
 
     def perform_handler(event)
       event.data.call
 
-      return nil
+      nil
     end
 
     def cleanup_handler(exception = nil)
@@ -268,7 +261,7 @@ def cleanup_handler(exception = nil)
       @_actable.registry.unregister(self)
       @_actable.timers.each { |t| t.cancel } if @_actable.timers
 
-      return nil
+      nil
     end
 
     def child_died_handler(child, exception)
@@ -281,7 +274,7 @@ def child_died_handler(child, exception)
         raise Tribe::ActorChildDied.new("#{child.identifier} died.")
       end
 
-      return nil
+      nil
     end
 
     def child_shutdown_handler(child)
@@ -290,14 +283,14 @@ def child_shutdown_handler(child)
 
       on_child_shutdown(Event.new(:child_shutdown, {:child => child}))
 
-      return nil
+      nil
     end
 
     def parent_died_handler(parent, exception)
       on_parent_died(Event.new(:parent_died, {:parent => parent, :exception => exception}))
       raise Tribe::ActorParentDied.new("#{parent.identifier} died.")
 
-      return nil
+      nil
     end
 
     #
@@ -307,6 +300,23 @@ def parent_died_handler(parent, exception)
 
     private
 
+    def message!(dest, command, data = nil)
+      event = Tribe::Event.new(command, data, self)
+
+      dest.deliver_event!(event)
+
+      nil
+    end
+
+    def future!(dest, command, data = nil)
+      event = Tribe::Event.new(command, data, self)
+      event.future = future = Tribe::Future.new(self)
+
+      dest.deliver_event!(event)
+
+      future
+    end
+
     def timer!(delay, command, data = nil)
       timer = Workers::Timer.new(delay, :scheduler => @_actable.scheduler) do
         @_actable.timers.delete(timer)
@@ -315,7 +325,7 @@ def timer!(delay, command, data = nil)
 
       @_actable.timers.add(timer)
 
-      return timer
+      timer
     end
 
     def periodic_timer!(delay, command, data = nil)
@@ -329,19 +339,19 @@ def periodic_timer!(delay, command, data = nil)
 
       @_actable.timers.add(timer)
 
-      return timer
+      timer
     end
 
     def forward!(dest)
       dest.deliver_event!(@_actable.active_event)
       @_actable.active_event = nil
 
-      return nil
+      nil
     end
 
     # Wrap blocking code using this method to automatically expand/contract the pool.
-    # This way you avoid potential deadlock with blocking code.
-    # Not needed for dedicated actors since they already have their own thread.
+    # This way you avoid potential thread starvation. Not needed for dedicated actors
+    # since they already have their own thread.
     def blocking!
       if @_actable.dedicated
         yield

lib/tribe/actor_state.rb

@@ -12,5 +12,6 @@ class ActorState
     attr_accessor :children
     attr_accessor :supervisees
     attr_accessor :exception
+    attr_accessor :logger
   end
 end

test/test_helper.rb

@@ -36,4 +36,6 @@ def poll(seconds = 5)
   raise 'Poll timeout.' unless yield
 end
 
+Tribe.logger = nil
+
 require 'minitest/autorun'