workhorse 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9b9363247117e0981b8b7304b3ce21d62fc7edf4d5ad3e804d707c0c39ce04e
-  data.tar.gz: 29a8d3cead2aad95cff3823ab2c88710d97ac26be534aeaba5d3b5570d6ee4a1
+  metadata.gz: 31b8b6352a1a32590d8c3d817279a0a7d2cd4c594efe27806acdbea0d1d42062
+  data.tar.gz: e68c163ad8f9dbf36ff2dbbd0e4696891b6daf0654b7c343b53f36d7404d8335
 SHA512:
-  metadata.gz: d981452366b82c427ab3a8dce44ff100c704e611a39d48e855ef2239a96d67c443d1b7b95f4c87587474a0879430a16eebe1229b89a3fdb3c4414898ed6dd01d
-  data.tar.gz: 1227833eea17e9202e4d82ea7f9eb36f685e5039a3f63795c35eda88e0eb18de1e0f03d576958177403f3e0e3e2e2842627313fd9362252d5a8eeace29f368f2
+  metadata.gz: 4472fe2d228c7c6fcac24263f1ea33473593971ebaa11bf051131ecf8a810bc162152e5f9cd30aed5c1d9d4b59224f57c0a5b75a4ecb922c3e8bc8303bf3ba48
+  data.tar.gz: cc36d41fe33f5292ae3fbf99c32be84fc0ebd577a43d6e92b7b66009c315bbad4ca650fc0e9d41a37ebb03c3b5b2e82dbfbc9300b3fe889ec30929f7768015b6

data/CHANGELOG.md

@@ -1,5 +1,36 @@
 # Workhorse Change log
 
+## 0.6.0 - 2918-07-03
+
+* Adapt {Workhorse::Daemon} to support a specific block for each worker. This
+  allows, for example, to run a scheduler like Rufus in a separate worker
+  process.
+
+  If you're using the daemon class, you will need to restructure your workhorse
+  starting script.
+
+  Since there is no `count` attribute anymore, transfer this:
+
+  ```ruby
+  Workhorse::Daemon::ShellHandler.run count: 5 do
+    # ... worker code
+  end
+  ```
+
+  into this:
+
+  ```ruby
+  Workhorse::Daemon::ShellHandler.run do |daemon|
+    5.times do
+      daemon.worker do
+        # ... worker code
+      end
+    end
+  end
+  ```
+
+  See readme for more information.
+
 ## 0.5.1 - 2019-06-27
 
 * Add daemon command `kill`

data/README.md

@@ -153,25 +153,28 @@ achieving regular execution:
 
    require './config/environment'
 
-   Workhorse::Daemon::ShellHandler.run do
-     worker = Workhorse::Worker.new(pool_size: 5, polling_interval: 10, logger: Rails.logger)
-     scheduler = Rufus::Scheduler.new
+   Workhorse::Daemon::ShellHandler.run do |daemon|
+     # Start scheduler process
+     daemon.worker 'Scheduler' do
+       scheduler = Rufus::Scheduler.new
 
-     worker.start
+       scheduler.cron '0/10 * * * *' do
+         Workhorse.enqueue Workhorse::Jobs::CleanupSucceededJobs.new
+       end
 
-     scheduler.cron '0/10 * * * *' do
-       Workhorse.enqueue Workhorse::Jobs::CleanupSucceededJobs.new
-     end
+       Signal.trap 'TERM' do
+         scheduler.shutdown
+       end
 
-     Signal.trap 'TERM' do
-       scheduler.shutdown
-       Thread.new do
-         worker.shutdown
-       end.join
+       scheduler.join
      end
 
-     scheduler.join
-     worker.wait
+     # Start 5 worker processes with 3 threads each
+     5.times do
+       daemon.worker do
+         Workhorse::Worker.new(pool_size: 3, polling_interval: 10, logger: Rails.logger)
+       end
+     end
    end
    ```
 
@@ -224,7 +227,7 @@ For this case, the workhorse install routine automatically creates the file
 The script can be called as follows:
 
 ```bash
-RAILS_ENV=production bundle exec bin/workhorse.rb start|stop|status|watch|restart|usage
+RAILS_ENV=production bundle exec bin/workhorse.rb start|stop|kill|status|watch|restart|usage
 ```
 
 #### Background and customization
@@ -233,10 +236,14 @@ Within the shell handler, you can instantiate, configure, and start a worker as
 described under [Start workers manually](#start-workers-manually):
 
 ```ruby
-Workhorse::Daemon::ShellHandler.run count: 5 do
-  # This will be run 5 times, each time in a separate process. Per process, it
-  # will be able to process 3 jobs concurrently.
-  Workhorse::Worker.start_and_wait(pool_size: 3, logger: Rails.logger)
+Workhorse::Daemon::ShellHandler.run do |daemon|
+  5.times do
+    daemon.worker do
+      # This will be run 5 times, each time in a separate process. Per process, it
+      # will be able to process 3 jobs concurrently.
+      Workhorse::Worker.start_and_wait(pool_size: 3, logger: Rails.logger)
+    end
+  end
 end
 ```
 

data/VERSION

@@ -1 +1 @@
-0.5.1
+0.6.0

data/lib/workhorse.rb

@@ -4,6 +4,7 @@ require 'active_record'
 require 'concurrent'
 
 require 'workhorse/enqueuer'
+require 'workhorse/scoped_env'
 
 module Workhorse
   # Check if the available Arel version is greater or equal than 7.0.0

data/lib/workhorse/daemon.rb

@@ -1,17 +1,32 @@
 module Workhorse
   class Daemon
-    def initialize(count: 1, pidfile: nil, quiet: false, &block)
-      @count = count
+    class Worker
+      attr_reader :id
+      attr_reader :name
+      attr_reader :block
+
+      def initialize(id, name, &block)
+        @id = id
+        @name = name
+        @block = block
+      end
+    end
+
+    def initialize(pidfile: nil, quiet: false, &block)
       @pidfile = pidfile
       @quiet = quiet
-      @block = block
+      @workers = []
+
+      yield ScopedEnv.new(self, [:worker])
 
-      fail 'Count must be an integer > 0.' unless count.is_a?(Integer) && count > 0
+      @count = @workers.count
+
+      fail 'No workers are defined.' if @count == 1
 
       FileUtils.mkdir_p('tmp/pids')
 
       if @pidfile.nil?
-        @pidfile = count > 1 ? 'tmp/pids/workhorse.%i.pid' : 'tmp/pids/workhorse.pid'
+        @pidfile = @count > 1 ? 'tmp/pids/workhorse.%i.pid' : 'tmp/pids/workhorse.pid'
       elsif @count > 1 && !@pidfile.include?('%s')
         fail 'Pidfile must include placeholder "%s" for worker id when specifying a count > 1.'
       elsif @count == 0 && @pidfile.include?('%s')
@@ -19,22 +34,26 @@ module Workhorse
       end
     end
 
+    def worker(name = 'Job Worker', &block)
+      @workers << Worker.new(@workers.size + 1, name, &block)
+    end
+
     def start
       code = 0
 
-      for_each_worker do |worker_id|
-        pid_file, pid = read_pid(worker_id)
+      for_each_worker do |worker|
+        pid_file, pid = read_pid(worker)
 
         if pid_file && pid
-          warn "Worker ##{worker_id}: Already started (PID #{pid})"
+          warn "Worker ##{worker.id} (#{worker.name}): Already started (PID #{pid})"
           code = 1
         elsif pid_file
           File.delete pid_file
-          puts "Worker ##{worker_id}: Starting (stale pid file)"
-          start_worker worker_id
+          puts "Worker ##{worker.id} (#{worker.name}): Starting (stale pid file)"
+          start_worker worker
         else
-          warn "Worker ##{worker_id}: Starting"
-          start_worker worker_id
+          warn "Worker ##{worker.id} (#{worker.name}): Starting"
+          start_worker worker
         end
       end
 
@@ -44,17 +63,17 @@ module Workhorse
     def stop(kill = false)
       code = 0
 
-      for_each_worker do |worker_id|
-        pid_file, pid = read_pid(worker_id)
+      for_each_worker do |worker|
+        pid_file, pid = read_pid(worker)
 
         if pid_file && pid
-          puts "Worker ##{worker_id}: Stopping"
+          puts "Worker (#{worker.name}) ##{worker.id}: Stopping"
           stop_worker pid_file, pid, kill
         elsif pid_file
           File.delete pid_file
-          puts "Worker ##{worker_id}: Already stopped (stale PID file)"
+          puts "Worker (#{worker.name}) ##{worker.id}: Already stopped (stale PID file)"
         else
-          warn "Worker ##{worker_id}: Already stopped"
+          warn "Worker (#{worker.name}) ##{worker.id}: Already stopped"
           code = 1
         end
       end
@@ -65,16 +84,16 @@ module Workhorse
     def status(quiet: false)
       code = 0
 
-      for_each_worker do |worker_id|
-        pid_file, pid = read_pid(worker_id)
+      for_each_worker do |worker|
+        pid_file, pid = read_pid(worker)
 
         if pid_file && pid
-          puts "Worker ##{worker_id}: Running" unless quiet
+          puts "Worker ##{worker.id} (#{worker.name}): Running" unless quiet
         elsif pid_file
-          warn "Worker ##{worker_id}: Not running (stale PID file)" unless quiet
+          warn "Worker ##{worker.id} (#{worker.name}): Not running (stale PID file)" unless quiet
           code = 1
         else
-          warn "Worker ##{worker_id}: Not running" unless quiet
+          warn "Worker ##{worker.id} (#{worker.name}): Not running" unless quiet
           code = 1
         end
       end
@@ -104,15 +123,15 @@ module Workhorse
     private
 
     def for_each_worker(&block)
-      1.upto(@count, &block)
+      @workers.each(&block)
     end
 
-    def start_worker(worker_id)
+    def start_worker(worker)
       pid = fork do
-        $0 = process_name(worker_id)
-        @block.call
+        $0 = process_name(worker)
+        worker.block.call
       end
-      IO.write(pid_file_for(worker_id), pid)
+      IO.write(pid_file_for(worker), pid)
     end
 
     def stop_worker(pid_file, pid, kill = false)
@@ -131,14 +150,14 @@ module Workhorse
       File.delete(pid_file)
     end
 
-    def process_name(worker_id)
+    def process_name(worker)
       if defined?(Rails)
         path = Rails.root
       else
         path = $PROGRAM_NAME
       end
 
-      return "Workhorse Worker ##{worker_id}: #{path}"
+      return "Workhorse #{worker.name} ##{worker.id}: #{path}"
     end
 
     def process?(pid)
@@ -150,12 +169,12 @@ module Workhorse
       end
     end
 
-    def pid_file_for(worker_id)
-      @pidfile % worker_id
+    def pid_file_for(worker)
+      @pidfile % worker.id
     end
 
-    def read_pid(worker_id)
-      file = pid_file_for(worker_id)
+    def read_pid(worker)
+      file = pid_file_for(worker)
 
       if File.exist?(file)
         pid = IO.read(file).to_i

data/lib/workhorse/scoped_env.rb

@@ -0,0 +1,23 @@
+module Workhorse
+  class ScopedEnv
+    def initialize(delegation_object, methods, backup_binding = nil)
+      @delegation_object = delegation_object
+      @methods = methods
+      @backup_binding = backup_binding
+    end
+
+    def method_missing(symbol, *args, &block)
+      if @methods.include?(symbol)
+        @delegation_object.send(symbol, *args, &block)
+      elsif @backup_binding&.respond_to?(symbol)
+        @backup_binding.send(symbol, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(symbol, include_private = false)
+      @methods.include?(symbol) || super
+    end
+  end
+end

data/workhorse.gemspec

@@ -1,15 +1,15 @@
 # -*- encoding: utf-8 -*-
-# stub: workhorse 0.5.1 ruby lib
+# stub: workhorse 0.6.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "workhorse".freeze
-  s.version = "0.5.1"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Sitrox".freeze]
-  s.date = "2019-06-27"
-  s.files = [".gitignore".freeze, ".releaser_config".freeze, ".rubocop.yml".freeze, ".travis.yml".freeze, "CHANGELOG.md".freeze, "FAQ.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "RUBY_VERSION".freeze, "Rakefile".freeze, "VERSION".freeze, "bin/rubocop".freeze, "lib/active_job/queue_adapters/workhorse_adapter.rb".freeze, "lib/generators/workhorse/install_generator.rb".freeze, "lib/generators/workhorse/templates/bin/workhorse.rb".freeze, "lib/generators/workhorse/templates/config/initializers/workhorse.rb".freeze, "lib/generators/workhorse/templates/create_table_jobs.rb".freeze, "lib/workhorse.rb".freeze, "lib/workhorse/daemon.rb".freeze, "lib/workhorse/daemon/shell_handler.rb".freeze, "lib/workhorse/db_job.rb".freeze, "lib/workhorse/enqueuer.rb".freeze, "lib/workhorse/jobs/cleanup_succeeded_jobs.rb".freeze, "lib/workhorse/jobs/run_active_job.rb".freeze, "lib/workhorse/jobs/run_rails_op.rb".freeze, "lib/workhorse/performer.rb".freeze, "lib/workhorse/poller.rb".freeze, "lib/workhorse/pool.rb".freeze, "lib/workhorse/worker.rb".freeze, "test/active_job/queue_adapters/workhorse_adapter_test.rb".freeze, "test/lib/db_schema.rb".freeze, "test/lib/jobs.rb".freeze, "test/lib/test_helper.rb".freeze, "test/workhorse/db_job_test.rb".freeze, "test/workhorse/enqueuer_test.rb".freeze, "test/workhorse/performer_test.rb".freeze, "test/workhorse/poller_test.rb".freeze, "test/workhorse/pool_test.rb".freeze, "test/workhorse/worker_test.rb".freeze, "workhorse.gemspec".freeze]
+  s.date = "2019-07-03"
+  s.files = [".gitignore".freeze, ".releaser_config".freeze, ".rubocop.yml".freeze, ".travis.yml".freeze, "CHANGELOG.md".freeze, "FAQ.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "RUBY_VERSION".freeze, "Rakefile".freeze, "VERSION".freeze, "bin/rubocop".freeze, "lib/active_job/queue_adapters/workhorse_adapter.rb".freeze, "lib/generators/workhorse/install_generator.rb".freeze, "lib/generators/workhorse/templates/bin/workhorse.rb".freeze, "lib/generators/workhorse/templates/config/initializers/workhorse.rb".freeze, "lib/generators/workhorse/templates/create_table_jobs.rb".freeze, "lib/workhorse.rb".freeze, "lib/workhorse/daemon.rb".freeze, "lib/workhorse/daemon/shell_handler.rb".freeze, "lib/workhorse/db_job.rb".freeze, "lib/workhorse/enqueuer.rb".freeze, "lib/workhorse/jobs/cleanup_succeeded_jobs.rb".freeze, "lib/workhorse/jobs/run_active_job.rb".freeze, "lib/workhorse/jobs/run_rails_op.rb".freeze, "lib/workhorse/performer.rb".freeze, "lib/workhorse/poller.rb".freeze, "lib/workhorse/pool.rb".freeze, "lib/workhorse/scoped_env.rb".freeze, "lib/workhorse/worker.rb".freeze, "test/active_job/queue_adapters/workhorse_adapter_test.rb".freeze, "test/lib/db_schema.rb".freeze, "test/lib/jobs.rb".freeze, "test/lib/test_helper.rb".freeze, "test/workhorse/db_job_test.rb".freeze, "test/workhorse/enqueuer_test.rb".freeze, "test/workhorse/performer_test.rb".freeze, "test/workhorse/poller_test.rb".freeze, "test/workhorse/pool_test.rb".freeze, "test/workhorse/worker_test.rb".freeze, "workhorse.gemspec".freeze]
   s.rubygems_version = "3.0.3".freeze
   s.summary = "Multi-threaded job backend with database queuing for ruby.".freeze
   s.test_files = ["test/active_job/queue_adapters/workhorse_adapter_test.rb".freeze, "test/lib/db_schema.rb".freeze, "test/lib/jobs.rb".freeze, "test/lib/test_helper.rb".freeze, "test/workhorse/db_job_test.rb".freeze, "test/workhorse/enqueuer_test.rb".freeze, "test/workhorse/performer_test.rb".freeze, "test/workhorse/poller_test.rb".freeze, "test/workhorse/pool_test.rb".freeze, "test/workhorse/worker_test.rb".freeze]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workhorse
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Sitrox
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-27 00:00:00.000000000 Z
+date: 2019-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -213,6 +213,7 @@ files:
 - lib/workhorse/performer.rb
 - lib/workhorse/poller.rb
 - lib/workhorse/pool.rb
+- lib/workhorse/scoped_env.rb
 - lib/workhorse/worker.rb
 - test/active_job/queue_adapters/workhorse_adapter_test.rb
 - test/lib/db_schema.rb