qs 0.4.0 → 0.5.0

data/lib/qs/daemon.rb

@@ -63,6 +63,10 @@ module Qs
         @daemon_data.name
       end
 
+      def process_label
+        @daemon_data.process_label
+      end
+
       def pid_file
         @daemon_data.pid_file
       end
@@ -129,10 +133,19 @@ module Qs
           self.daemon_data.min_workers,
           self.daemon_data.max_workers
         ){ |queue_item| process(queue_item) }
+
+        # add internal callbacks
         wp.on_worker_error do |worker, exception, queue_item|
           handle_worker_exception(exception, queue_item)
         end
         wp.on_worker_sleep{ @worker_available_io.write(SIGNAL) }
+
+        # add any configured callbacks
+        self.daemon_data.worker_start_procs.each{ |cb| wp.on_worker_start(&cb) }
+        self.daemon_data.worker_shutdown_procs.each{ |cb|  wp.on_worker_shutdown(&cb) }
+        self.daemon_data.worker_sleep_procs.each{ |cb| wp.on_worker_sleep(&cb) }
+        self.daemon_data.worker_wakeup_procs.each{ |cb| wp.on_worker_wakeup(&cb) }
+
         wp.start
         wp
       end
@@ -246,6 +259,22 @@ module Qs
         self.max_workers(*args)
       end
 
+      def on_worker_start(&block)
+        self.configuration.worker_start_procs << block
+      end
+
+      def on_worker_shutdown(&block)
+        self.configuration.worker_shutdown_procs << block
+      end
+
+      def on_worker_sleep(&block)
+        self.configuration.worker_sleep_procs << block
+      end
+
+      def on_worker_wakeup(&block)
+        self.configuration.worker_wakeup_procs << block
+      end
+
       def verbose_logging(*args)
         self.configuration.verbose_logging(*args)
       end
@@ -286,14 +315,20 @@ module Qs
 
       option :shutdown_timeout
 
+      attr_accessor :process_label
       attr_accessor :init_procs, :error_procs
       attr_accessor :queues
+      attr_reader :worker_start_procs, :worker_shutdown_procs
+      attr_reader :worker_sleep_procs, :worker_wakeup_procs
 
       def initialize(values = nil)
         super(values)
+        @process_label = !(v = ENV['QS_PROCESS_LABEL'].to_s).empty? ? v : self.name
         @init_procs, @error_procs = [], []
+        @worker_start_procs, @worker_shutdown_procs = [], []
+        @worker_sleep_procs, @worker_wakeup_procs   = [], []
         @queues = []
-        @valid = nil
+        @valid  = nil
       end
 
       def routes
@@ -302,9 +337,14 @@ module Qs
 
       def to_hash
         super.merge({
-          :error_procs      => self.error_procs,
-          :queue_redis_keys => self.queues.map(&:redis_key),
-          :routes           => self.routes
+          :process_label         => self.process_label,
+          :error_procs           => self.error_procs,
+          :worker_start_procs    => self.worker_start_procs,
+          :worker_shutdown_procs => self.worker_shutdown_procs,
+          :worker_sleep_procs    => self.worker_sleep_procs,
+          :worker_wakeup_procs   => self.worker_wakeup_procs,
+          :routes                => self.routes,
+          :queue_redis_keys      => self.queues.map(&:redis_key)
         })
       end
 

data/lib/qs/daemon_data.rb

@@ -7,9 +7,11 @@ module Qs
     # options one time here and memoize their values. This way, we don't pay the
     # NsOptions overhead when reading them while handling a message.
 
-    attr_reader :name
+    attr_reader :name, :process_label
     attr_reader :pid_file
     attr_reader :min_workers, :max_workers
+    attr_reader :worker_start_procs, :worker_shutdown_procs
+    attr_reader :worker_sleep_procs, :worker_wakeup_procs
     attr_reader :logger, :verbose_logging
     attr_reader :shutdown_timeout
     attr_reader :error_procs
@@ -17,16 +19,21 @@ module Qs
 
     def initialize(args = nil)
       args ||= {}
-      @name             = args[:name]
-      @pid_file         = args[:pid_file]
-      @min_workers      = args[:min_workers]
-      @max_workers      = args[:max_workers]
-      @logger           = args[:logger]
-      @verbose_logging  = !!args[:verbose_logging]
-      @shutdown_timeout = args[:shutdown_timeout]
-      @error_procs      = args[:error_procs] || []
-      @queue_redis_keys = args[:queue_redis_keys] || []
-      @routes           = build_routes(args[:routes] || [])
+      @name                  = args[:name]
+      @process_label         = args[:process_label]
+      @pid_file              = args[:pid_file]
+      @min_workers           = args[:min_workers]
+      @max_workers           = args[:max_workers]
+      @worker_start_procs    = args[:worker_start_procs]
+      @worker_shutdown_procs = args[:worker_shutdown_procs]
+      @worker_sleep_procs    = args[:worker_sleep_procs]
+      @worker_wakeup_procs   = args[:worker_wakeup_procs]
+      @logger                = args[:logger]
+      @verbose_logging       = !!args[:verbose_logging]
+      @shutdown_timeout      = args[:shutdown_timeout]
+      @error_procs           = args[:error_procs] || []
+      @queue_redis_keys      = args[:queue_redis_keys] || []
+      @routes                = build_routes(args[:routes] || [])
     end
 
     def route_for(route_id)

data/lib/qs/process.rb

@@ -17,8 +17,7 @@ module Qs
     def initialize(daemon, options = nil)
       options ||= {}
       @daemon = daemon
-      process_label = ignore_if_blank(ENV['QS_PROCESS_LABEL']) || @daemon.name
-      @name   = "qs: #{process_label}"
+      @name   = "qs: #{@daemon.process_label}"
       @logger = @daemon.logger
 
       @pid_file    = PIDFile.new(@daemon.pid_file)

data/lib/qs/version.rb

@@ -1,3 +1,3 @@
 module Qs
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/qs.gemspec

@@ -23,6 +23,6 @@ Gem::Specification.new do |gem|
   gem.add_dependency("ns-options",      ["~> 1.1"])
   gem.add_dependency("SystemTimer",     ["~> 1.2"])
 
-  gem.add_development_dependency("assert", ["~> 2.14"])
+  gem.add_development_dependency("assert", ["~> 2.15"])
   gem.add_development_dependency("scmd",   ["~> 2.3"])
 end

data/test/unit/daemon_data_tests.rb

@@ -9,37 +9,50 @@ class Qs::DaemonData
   class UnitTests < Assert::Context
     desc "Qs::DaemonData"
     setup do
-      @name = Factory.string
-      @pid_file = Factory.file_path
-      @min_workers = Factory.integer
-      @max_workers = Factory.integer
-      @logger = Factory.string
-      @verbose_logging = Factory.boolean
+      @name             = Factory.string
+      @process_label    = Factory.string
+      @pid_file         = Factory.file_path
+      @min_workers      = Factory.integer
+      @max_workers      = Factory.integer
+      @start_procs      = Factory.integer(3).times.map{ proc{} }
+      @shutdown_procs   = Factory.integer(3).times.map{ proc{} }
+      @sleep_procs      = Factory.integer(3).times.map{ proc{} }
+      @wakeup_procs     = Factory.integer(3).times.map{ proc{} }
+      @logger           = Factory.string
+      @verbose_logging  = Factory.boolean
       @shutdown_timeout = Factory.integer
-      @error_procs = [ proc{ Factory.string } ]
-      @queue_redis_keys = (0..Factory.integer(3)).map{ Factory.string }
+      @error_procs      = [ proc{ Factory.string } ]
+      @queue_redis_keys = Factory.integer(3).times.map{ Factory.string }
+
       @routes = (0..Factory.integer(3)).map do
         Qs::Route.new(Factory.string, TestHandler.to_s).tap(&:validate!)
       end
 
       @daemon_data = Qs::DaemonData.new({
-        :name             => @name,
-        :pid_file         => @pid_file,
-        :min_workers      => @min_workers,
-        :max_workers      => @max_workers,
-        :logger           => @logger,
-        :verbose_logging  => @verbose_logging,
-        :shutdown_timeout => @shutdown_timeout,
-        :error_procs      => @error_procs,
-        :queue_redis_keys => @queue_redis_keys,
-        :routes           => @routes
+        :name                  => @name,
+        :process_label         => @process_label,
+        :pid_file              => @pid_file,
+        :min_workers           => @min_workers,
+        :max_workers           => @max_workers,
+        :worker_start_procs    => @start_procs,
+        :worker_shutdown_procs => @shutdown_procs,
+        :worker_sleep_procs    => @sleep_procs,
+        :worker_wakeup_procs   => @wakeup_procs,
+        :logger                => @logger,
+        :verbose_logging       => @verbose_logging,
+        :shutdown_timeout      => @shutdown_timeout,
+        :error_procs           => @error_procs,
+        :queue_redis_keys      => @queue_redis_keys,
+        :routes                => @routes
       })
     end
     subject{ @daemon_data }
 
-    should have_readers :name
+    should have_readers :name, :process_label
     should have_readers :pid_file
     should have_readers :min_workers, :max_workers
+    should have_readers :worker_start_procs, :worker_shutdown_procs
+    should have_readers :worker_sleep_procs, :worker_wakeup_procs
     should have_readers :logger, :verbose_logging
     should have_readers :shutdown_timeout
     should have_readers :error_procs
@@ -48,9 +61,14 @@ class Qs::DaemonData
 
     should "know its attributes" do
       assert_equal @name,             subject.name
+      assert_equal @process_label,    subject.process_label
       assert_equal @pid_file,         subject.pid_file
       assert_equal @min_workers,      subject.min_workers
       assert_equal @max_workers,      subject.max_workers
+      assert_equal @start_procs,      subject.worker_start_procs
+      assert_equal @shutdown_procs,   subject.worker_shutdown_procs
+      assert_equal @sleep_procs,      subject.worker_sleep_procs
+      assert_equal @wakeup_procs,     subject.worker_wakeup_procs
       assert_equal @logger,           subject.logger
       assert_equal @verbose_logging,  subject.verbose_logging
       assert_equal @shutdown_timeout, subject.shutdown_timeout

data/test/unit/daemon_tests.rb

@@ -20,6 +20,8 @@ module Qs::Daemon
     should have_imeths :configuration
     should have_imeths :name, :pid_file
     should have_imeths :min_workers, :max_workers, :workers
+    should have_imeths :on_worker_start, :on_worker_shutdown
+    should have_imeths :on_worker_sleep, :on_worker_wakeup
     should have_imeths :verbose_logging, :logger
     should have_imeths :shutdown_timeout
     should have_imeths :init, :error, :queue
@@ -68,6 +70,22 @@ module Qs::Daemon
       assert_equal new_workers, subject.max_workers
     end
 
+    should "allow reading/writing its configuration worker procs" do
+      p = proc{}
+
+      subject.on_worker_start(&p)
+      assert_equal [p], subject.configuration.worker_start_procs
+
+      subject.on_worker_shutdown(&p)
+      assert_equal [p], subject.configuration.worker_shutdown_procs
+
+      subject.on_worker_sleep(&p)
+      assert_equal [p], subject.configuration.worker_sleep_procs
+
+      subject.on_worker_wakeup(&p)
+      assert_equal [p], subject.configuration.worker_wakeup_procs
+    end
+
     should "allow reading/writing its configuration verbose logging" do
       new_verbose = Factory.boolean
       subject.verbose_logging(new_verbose)
@@ -114,16 +132,26 @@ module Qs::Daemon
       @qs_init_called = false
       Assert.stub(Qs, :init){ @qs_init_called = true }
 
-      @queue = Qs::Queue.new do
-        name(Factory.string)
-        job 'test', TestHandler.to_s
-      end
       @daemon_class.name Factory.string
       @daemon_class.pid_file Factory.file_path
       @daemon_class.workers Factory.integer
       @daemon_class.verbose_logging Factory.boolean
       @daemon_class.shutdown_timeout Factory.integer
       @daemon_class.error{ Factory.string }
+
+      @start_procs    = Factory.integer(3).times.map{ proc{} }
+      @shutdown_procs = Factory.integer(3).times.map{ proc{} }
+      @sleep_procs    = Factory.integer(3).times.map{ proc{} }
+      @wakeup_procs   = Factory.integer(3).times.map{ proc{} }
+      @start_procs.each    { |p| @daemon_class.on_worker_start(&p) }
+      @shutdown_procs.each { |p| @daemon_class.on_worker_shutdown(&p) }
+      @sleep_procs.each    { |p| @daemon_class.on_worker_sleep(&p) }
+      @wakeup_procs.each   { |p| @daemon_class.on_worker_wakeup(&p) }
+
+      @queue = Qs::Queue.new do
+        name(Factory.string)
+        job 'test', TestHandler.to_s
+      end
       @daemon_class.queue @queue
 
       @client_spy = nil
@@ -148,13 +176,19 @@ module Qs::Daemon
   class InitTests < InitSetupTests
     desc "when init"
     setup do
+      @current_env_process_label = ENV['QS_PROCESS_LABEL']
+      ENV['QS_PROCESS_LABEL'] = Factory.string
+
       @daemon = @daemon_class.new
     end
+    teardown do
+      ENV['QS_PROCESS_LABEL'] = @current_env_process_label
+    end
     subject{ @daemon }
 
     should have_readers :daemon_data, :logger
     should have_readers :signals_redis_key, :queue_redis_keys
-    should have_imeths :name, :pid_file
+    should have_imeths :name, :process_label, :pid_file
     should have_imeths :running?
     should have_imeths :start, :stop, :halt
 
@@ -171,15 +205,24 @@ module Qs::Daemon
       data = subject.daemon_data
 
       assert_instance_of Qs::DaemonData, data
-      assert_equal configuration.name,             data.name
-      assert_equal configuration.pid_file,         data.pid_file
-      assert_equal configuration.min_workers,      data.min_workers
-      assert_equal configuration.max_workers,      data.max_workers
+      assert_equal configuration.name,          data.name
+      assert_equal configuration.process_label, data.process_label
+      assert_equal configuration.pid_file,      data.pid_file
+      assert_equal configuration.min_workers,   data.min_workers
+      assert_equal configuration.max_workers,   data.max_workers
+
+      assert_equal configuration.worker_start_procs,    data.worker_start_procs
+      assert_equal configuration.worker_shutdown_procs, data.worker_shutdown_procs
+      assert_equal configuration.worker_sleep_procs,    data.worker_sleep_procs
+      assert_equal configuration.worker_wakeup_procs,   data.worker_wakeup_procs
+
       assert_equal configuration.verbose_logging,  data.verbose_logging
       assert_equal configuration.shutdown_timeout, data.shutdown_timeout
       assert_equal configuration.error_procs,      data.error_procs
-      assert_equal [@queue.redis_key], data.queue_redis_keys
+
+      assert_equal [@queue.redis_key],   data.queue_redis_keys
       assert_equal configuration.routes, data.routes.values
+
       assert_instance_of configuration.logger.class, data.logger
     end
 
@@ -190,10 +233,11 @@ module Qs::Daemon
       assert_equal data.queue_redis_keys, subject.queue_redis_keys
     end
 
-    should "know its name and pid file" do
+    should "know its name, process label and pid file" do
       data = subject.daemon_data
-      assert_equal data.name,     subject.name
-      assert_equal data.pid_file, subject.pid_file
+      assert_equal data.name,          subject.name
+      assert_equal data.process_label, subject.process_label
+      assert_equal data.pid_file,      subject.pid_file
     end
 
     should "build a client" do
@@ -242,8 +286,22 @@ module Qs::Daemon
       assert_not_nil @worker_pool_spy
       assert_equal @daemon_class.min_workers, @worker_pool_spy.min_workers
       assert_equal @daemon_class.max_workers, @worker_pool_spy.max_workers
-      assert_equal 1, @worker_pool_spy.on_worker_error_callbacks.size
-      assert_equal 1, @worker_pool_spy.on_worker_sleep_callbacks.size
+
+      exp = 1
+      assert_equal exp, @worker_pool_spy.on_worker_error_callbacks.size
+
+      exp = @start_procs.size
+      assert_equal exp, @worker_pool_spy.on_worker_start_callbacks.size
+
+      exp = @shutdown_procs.size
+      assert_equal exp, @worker_pool_spy.on_worker_shutdown_callbacks.size
+
+      exp = @sleep_procs.size + 1 # configured plus 1 internal
+      assert_equal exp, @worker_pool_spy.on_worker_sleep_callbacks.size
+
+      exp = @wakeup_procs.size
+      assert_equal exp, @worker_pool_spy.on_worker_wakeup_callbacks.size
+
       assert_true @worker_pool_spy.start_called
     end
 
@@ -549,8 +607,11 @@ module Qs::Daemon
     should have_options :min_workers, :max_workers
     should have_options :verbose_logging, :logger
     should have_options :shutdown_timeout
+    should have_accessors :process_label
     should have_accessors :init_procs, :error_procs
     should have_accessors :queues
+    should have_readers :worker_start_procs, :worker_shutdown_procs
+    should have_readers :worker_sleep_procs, :worker_wakeup_procs
     should have_imeths :routes
     should have_imeths :to_hash
     should have_imeths :valid?, :validate!
@@ -559,7 +620,7 @@ module Qs::Daemon
       assert_includes NsOptions::Proxy, subject.class
     end
 
-    should "default its options" do
+    should "default its options and attrs" do
       config = Configuration.new
       assert_nil config.name
       assert_nil config.pid_file
@@ -568,12 +629,36 @@ module Qs::Daemon
       assert_true config.verbose_logging
       assert_instance_of Qs::NullLogger, config.logger
       assert_nil subject.shutdown_timeout
+
+      assert_nil config.process_label
       assert_equal [], config.init_procs
       assert_equal [], config.error_procs
+      assert_equal [], subject.worker_start_procs
+      assert_equal [], subject.worker_shutdown_procs
+      assert_equal [], subject.worker_sleep_procs
+      assert_equal [], subject.worker_wakeup_procs
       assert_equal [], config.queues
       assert_equal [], config.routes
     end
 
+    should "prefer an env var for the label but fall back to the name option" do
+      current_env_process_label = ENV['QS_PROCESS_LABEL']
+
+      ENV['QS_PROCESS_LABEL'] = Factory.string
+      config = Configuration.new(:name => Factory.string)
+      assert_equal ENV['QS_PROCESS_LABEL'], config.process_label
+
+      ENV['QS_PROCESS_LABEL'] = ''
+      config = Configuration.new(:name => Factory.string)
+      assert_equal config.name, config.process_label
+
+      ENV.delete('QS_PROCESS_LABEL')
+      config = Configuration.new(:name => Factory.string)
+      assert_equal config.name, config.process_label
+
+      ENV['QS_PROCESS_LABEL'] = current_env_process_label
+    end
+
     should "not be valid by default" do
       assert_false subject.valid?
     end
@@ -582,12 +667,20 @@ module Qs::Daemon
       assert_equal subject.queues.map(&:routes).flatten, subject.routes
     end
 
-    should "include its error procs, queue redis keys and routes in its hash" do
+    should "include some attrs (not just the options) in its hash" do
       config_hash = subject.to_hash
-      assert_equal subject.error_procs, config_hash[:error_procs]
-      expected = subject.queues.map(&:redis_key)
-      assert_equal expected, config_hash[:queue_redis_keys]
-      assert_equal subject.routes, config_hash[:routes]
+
+      assert_equal subject.process_label, config_hash[:process_label]
+      assert_equal subject.error_procs,   config_hash[:error_procs]
+      assert_equal subject.routes,        config_hash[:routes]
+
+      exp = subject.queues.map(&:redis_key)
+      assert_equal exp, config_hash[:queue_redis_keys]
+
+      assert_equal subject.worker_start_procs,    config_hash[:worker_start_procs]
+      assert_equal subject.worker_shutdown_procs, config_hash[:worker_shutdown_procs]
+      assert_equal subject.worker_sleep_procs,    config_hash[:worker_sleep_procs]
+      assert_equal subject.worker_wakeup_procs,   config_hash[:worker_wakeup_procs]
     end
 
     should "call its init procs when validated" do

data/test/unit/process_tests.rb

@@ -22,9 +22,7 @@ class Qs::Process
   class InitTests < UnitTests
     desc "when init"
     setup do
-      @current_env_process_label  = ENV['QS_PROCESS_LABEL']
       @current_env_skip_daemonize = ENV['QS_SKIP_DAEMONIZE']
-      ENV.delete('QS_PROCESS_LABEL')
       ENV.delete('QS_SKIP_DAEMONIZE')
 
       @daemon_spy = DaemonSpy.new
@@ -41,7 +39,6 @@ class Qs::Process
     end
     teardown do
       ENV['QS_SKIP_DAEMONIZE'] = @current_env_skip_daemonize
-      ENV['QS_PROCESS_LABEL']  = @current_env_process_label
     end
     subject{ @process }
 
@@ -54,24 +51,12 @@ class Qs::Process
     end
 
     should "know its name, pid file, signal io and restart cmd" do
-      assert_equal "qs: #{@daemon_spy.name}", subject.name
+      assert_equal "qs: #{@daemon_spy.process_label}", subject.name
       assert_equal @pid_file_spy, subject.pid_file
       assert_instance_of Qs::IOPipe, subject.signal_io
       assert_equal @restart_cmd_spy, subject.restart_cmd
     end
 
-    should "set its name using env vars" do
-      ENV['QS_PROCESS_LABEL'] = Factory.string
-      process = @process_class.new(@daemon_spy)
-      assert_equal "qs: #{ENV['QS_PROCESS_LABEL']}", process.name
-    end
-
-    should "ignore blank env values for its name" do
-      ENV['QS_PROCESS_LABEL'] = ''
-      process = @process_class.new(@daemon_spy)
-      assert_equal "qs: #{@daemon_spy.name}", process.name
-     end
-
     should "not daemonize by default" do
       process = @process_class.new(@daemon_spy)
       assert_false process.daemonize?
@@ -415,11 +400,15 @@ class Qs::Process
 
     queue Qs::Queue.new{ name Factory.string }
 
+    attr_accessor :process_label
     attr_accessor :start_called, :stop_called, :halt_called
     attr_reader :start_args, :stop_args, :halt_args
 
     def initialize(*args)
       super
+
+      @process_label = Factory.string
+
       @start_args   = nil
       @start_called = false
       @stop_args    = nil

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: qs
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 11
   prerelease: 
   segments: 
   - 0
-  - 4
+  - 5
   - 0
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Kelly Redding
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2015-08-04 00:00:00 Z
+date: 2015-09-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement 
@@ -84,11 +84,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 31
+        hash: 29
         segments: 
         - 2
-        - 14
-        version: "2.14"
+        - 15
+        version: "2.15"
   type: :development
   name: assert
   version_requirements: *id005
@@ -238,7 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.29
 signing_key: 
 specification_version: 3
 summary: Define message queues. Process jobs and events. Profit.