workhorse 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 713d9c117c06a2e448ec9b963b216df9e46741f81f7e5e80c62f4b3648b1d29b
-  data.tar.gz: f625a84d3173812546d200feac847cbd16dcd800ee6d2f188e44302c79078211
+  metadata.gz: d44a186907b790e7c3841ebfa08c4d6adf15906276c85c562e18b77927198c4c
+  data.tar.gz: e9d2e237c2980ce22783cbf9f5352824dffe2fc2ac055499e9578c30a0b237f1
 SHA512:
-  metadata.gz: 25818f59461494d50b08a00f863c81d48521998462643134454fac6b8ba7c6c7d2358213342373c01b4dbc5ef1dd4d02bdd561e1a1c9c5294d840095e1e5b931
-  data.tar.gz: 833e6132e223e85060253f678109dad5624802ad163c990caae78fc8a6de44820318505c36bb5709e2f7fd591f4ce7ed71aa2ed2487b6de43d3cec17eeb085da
+  metadata.gz: 88f2d387aeedf2c8128bc0d733d764eb5094be3c458c1ee954578647203b7cbd4907ec0159e81e05a7426674776ee0a53b2b7355523ee67be1ac1dc42d331243
+  data.tar.gz: 5630d627210c264dd14c9b29a233631a99dfbd1fe1e49e64ffa2cfd2f0e1d71f63869153e175a437c0b07152278ed687a713f8d58e7450b6242fb4ed32a1ca17

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Workhorse Change log
 
+## 0.5.0 - 2019-05-22
+
+* Added support for ActiveJob
+
 ## 0.4.0 - 2019-05-15
 
 * Added instruments for clearing DbJob data. (PR #17)

data/FAQ.md

@@ -75,7 +75,3 @@ production mode.
 ## Why does workhorse not support timeouts?
 
 Generic timeout implementations are [a dangerous thing](http://www.mikeperham.com/2015/05/08/timeout-rubys-most-dangerous-api/) in Ruby. This is why we decided against providing this feature in Workhorse and recommend to implement the timeouts inside of your jobs - i.e. via network timeouts.
-
-## Why is workhorse not integrated into Rails per default?
-
-We have submitted [a pull request](https://github.com/rails/rails/pull/31504) to Rails, but they stated that they won't add any new adapters to Rails. There are plans to integrate this on the Gem side only - stay tuned.

data/README.md

@@ -345,13 +345,22 @@ Performing a reset will reset the job state to `waiting` and it will be
 processed again. All meta fields will be reset as well. See inline documentation
 of `Workhorse::DbJob#reset!` for more details.
 
-## Frequently asked questions
 
-Please consult the [FAQ](FAQ.md).
+## Using workhorse with Rails / ActiveJob
+
+While workhorse can be used though its custom interface as documented above, it
+is also fully integrated into Rails using `ActiveJob`. See [documentation of
+ActiveJob](https://edgeguides.rubyonrails.org/active_job_basics.html) for more
+information on how to use it.
 
-## Roadmap
+To use workhorse as your ActiveJob backend, set the `queue_adapter` to
+`workhorse`, either using `config.active_job.queue_adapter` in your application
+configuration or else using `self.queue_adapter` in a job class inheriting from
+`ActiveJob`. See ActiveJob documentation for more details.
 
-* [ ] ActiveJob integration for Rails
+## Frequently asked questions
+
+Please consult the [FAQ](FAQ.md).
 
 ## Copyright
 

data/Rakefile

@@ -18,6 +18,7 @@ task :gemspec do
     spec.add_development_dependency 'mysql2'
     spec.add_development_dependency 'colorize'
     spec.add_development_dependency 'benchmark-ips'
+    spec.add_development_dependency 'activejob'
     spec.add_dependency 'activesupport'
     spec.add_dependency 'activerecord'
     spec.add_dependency 'schemacop', '~> 2.0'
@@ -30,7 +31,7 @@ end
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
-  t.pattern = 'test/workhorse/**/*_test.rb'
+  t.pattern = 'test/**/*_test.rb'
   t.verbose = false
   t.libs << 'test/lib'
 end

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/lib/active_job/queue_adapters/workhorse_adapter.rb

@@ -0,0 +1,22 @@
+module ActiveJob
+  module QueueAdapters
+    # == Workhorse adapter for Active Job
+    #
+    # Workhorse is a multi-threaded job backend with database queuing for ruby.
+    # Jobs are persisted in the database using ActiveRecird.
+    # Read more about Workhorse {here}[https://github.com/sitrox/activejob].
+    #
+    # To use Workhorse, set the queue_adapter config to +:workhorse+.
+    #
+    #   Rails.application.config.active_job.queue_adapter = :workhorse
+    class WorkhorseAdapter
+      def enqueue(job) #:nodoc:
+        Workhorse.enqueue_active_job(job)
+      end
+
+      def enqueue_at(job, timestamp) #:nodoc:
+        Workhorse.enqueue_active_job(job, timestamp)
+      end
+    end
+  end
+end

data/lib/workhorse.rb

@@ -47,6 +47,7 @@ require 'workhorse/poller'
 require 'workhorse/pool'
 require 'workhorse/worker'
 require 'workhorse/jobs/run_rails_op'
+require 'workhorse/jobs/run_active_job'
 require 'workhorse/jobs/cleanup_succeeded_jobs'
 
 # Daemon functionality is not available on java platforms
@@ -54,3 +55,7 @@ if RUBY_PLATFORM != 'java'
   require 'workhorse/daemon'
   require 'workhorse/daemon/shell_handler'
 end
+
+if defined?(ActiveJob)
+  require 'active_job/queue_adapters/workhorse_adapter.rb'
+end

data/lib/workhorse/enqueuer.rb

@@ -11,8 +11,12 @@ module Workhorse
     end
 
     # Enqueue an ActiveJob job
-    def enqueue_active_job(job)
-      enqueue job, queue: job.queue_name, priority: job.priority
+    def enqueue_active_job(job, perform_at = Time.now)
+      wrapper_job = Jobs::RunActiveJob.new(job.serialize)
+      queue = job.queue_name.blank? ? nil : job.queue_name
+      db_job = enqueue(wrapper_job, queue: queue, priority: job.priority || 0, perform_at: Time.at(perform_at))
+      job.provider_job_id = db_job.id
+      return db_job
     end
 
     # Enqueue the execution of an operation by its class and params

data/lib/workhorse/jobs/run_active_job.rb

@@ -0,0 +1,11 @@
+module Workhorse::Jobs
+  class RunActiveJob
+    def initialize(job_data)
+      @job_data = job_data
+    end
+
+    def perform
+      ActiveJob::Base.execute(@job_data)
+    end
+  end
+end

data/test/active_job/queue_adapters/workhorse_adapter_test.rb

@@ -0,0 +1,93 @@
+require 'test_helper'
+
+class ActiveJob::QueueAdapters::WorkhorseAdapterTest < WorkhorseTest
+  class ApplicationJob < ActiveJob::Base; end
+  class CustomException < StandardError; end
+
+  class Job1 < ApplicationJob
+    attr_reader :result
+
+    class_attribute :results
+
+    queue_as ''
+
+    def perform(param)
+      results << param
+    end
+  end
+
+  class Job2 < Job1
+    queue_as :queue1
+  end
+
+  class Job3 < Job1
+    rescue_from CustomException do |e|
+      results << e
+    end
+
+    def perform
+      fail CustomException
+    end
+  end
+
+  class Job4 < Job1
+    after_enqueue do |job|
+      results << job.provider_job_id
+    end
+  end
+
+  def setup
+    ActiveJob::Base.queue_adapter = :workhorse
+    ActiveJob::Base.logger = nil
+    Workhorse::DbJob.delete_all
+    Job1.results = Concurrent::Array.new
+  end
+
+  def test_basic
+    Job1.perform_later 'foo'
+    work 0.5
+    assert_equal ['foo'], Job1.results
+    assert_nil Workhorse::DbJob.first.queue
+  end
+
+  def test_queue
+    Job2.perform_later 'foo'
+    work 0.5
+    assert_equal ['foo'], Job2.results
+    assert_equal 'queue1', Workhorse::DbJob.first.queue
+  end
+
+  def test_wait
+    Job2.set(wait: 2.seconds).perform_later 'foo'
+
+    work 1, polling_interval: 0.1
+    assert_equal 'waiting', Workhorse::DbJob.first.state
+
+    work 2.5, polling_interval: 0.1
+    assert_equal 'succeeded', Workhorse::DbJob.first.reload.state
+  end
+
+  def test_wait_until
+    Job2.set(wait_until: (Time.now + 2.seconds)).perform_later 'foo'
+
+    work 0.5, polling_interval: 0.1
+    assert_equal 'waiting', Workhorse::DbJob.first.state
+
+    work 1.5, polling_interval: 0.1
+    assert_equal 'succeeded', Workhorse::DbJob.first.reload.state
+  end
+
+  def test_rescue_from
+    Job3.perform_later
+    work 0.5
+    assert_equal 'succeeded', Workhorse::DbJob.first.state
+    assert Job3.results.first.is_a?(CustomException)
+  end
+
+  def test_provider_job_id
+    job = Job4.perform_later
+    db_job = Workhorse::DbJob.first
+    assert_equal db_job.id, job.provider_job_id
+    assert_equal [db_job.id], Job1.results
+  end
+end

data/test/lib/test_helper.rb

@@ -1,5 +1,6 @@
 require 'minitest/autorun'
 require 'active_record'
+require 'active_job'
 require 'mysql2'
 require 'benchmark'
 require 'jobs'

data/test/workhorse/performer_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class Workhorse::WorkerTest < WorkhorseTest
+class Workhorse::PerformerTest < WorkhorseTest
   # This test makes sure that concurrent jobs always work in different database
   # connections.
   def test_db_connections

data/workhorse.gemspec

@@ -1,18 +1,18 @@
 # -*- encoding: utf-8 -*-
-# stub: workhorse 0.4.0 ruby lib
+# stub: workhorse 0.5.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "workhorse".freeze
-  s.version = "0.4.0"
+  s.version = "0.5.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-05-15"
-  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/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_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/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-05-22"
+  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.rubygems_version = "3.0.3".freeze
   s.summary = "Multi-threaded job backend with database queuing for ruby.".freeze
-  s.test_files = ["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]
+  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]
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<mysql2>.freeze, [">= 0"])
       s.add_development_dependency(%q<colorize>.freeze, [">= 0"])
       s.add_development_dependency(%q<benchmark-ips>.freeze, [">= 0"])
+      s.add_development_dependency(%q<activejob>.freeze, [">= 0"])
       s.add_runtime_dependency(%q<activesupport>.freeze, [">= 0"])
       s.add_runtime_dependency(%q<activerecord>.freeze, [">= 0"])
       s.add_runtime_dependency(%q<schemacop>.freeze, ["~> 2.0"])
@@ -37,6 +38,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<mysql2>.freeze, [">= 0"])
       s.add_dependency(%q<colorize>.freeze, [">= 0"])
       s.add_dependency(%q<benchmark-ips>.freeze, [">= 0"])
+      s.add_dependency(%q<activejob>.freeze, [">= 0"])
       s.add_dependency(%q<activesupport>.freeze, [">= 0"])
       s.add_dependency(%q<activerecord>.freeze, [">= 0"])
       s.add_dependency(%q<schemacop>.freeze, ["~> 2.0"])
@@ -50,6 +52,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<mysql2>.freeze, [">= 0"])
     s.add_dependency(%q<colorize>.freeze, [">= 0"])
     s.add_dependency(%q<benchmark-ips>.freeze, [">= 0"])
+    s.add_dependency(%q<activejob>.freeze, [">= 0"])
     s.add_dependency(%q<activesupport>.freeze, [">= 0"])
     s.add_dependency(%q<activerecord>.freeze, [">= 0"])
     s.add_dependency(%q<schemacop>.freeze, ["~> 2.0"])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workhorse
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Sitrox
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-15 00:00:00.000000000 Z
+date: 2019-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -183,6 +197,7 @@ files:
 - Rakefile
 - VERSION
 - bin/rubocop
+- lib/active_job/queue_adapters/workhorse_adapter.rb
 - lib/generators/workhorse/install_generator.rb
 - lib/generators/workhorse/templates/bin/workhorse.rb
 - lib/generators/workhorse/templates/config/initializers/workhorse.rb
@@ -193,11 +208,13 @@ files:
 - lib/workhorse/db_job.rb
 - lib/workhorse/enqueuer.rb
 - lib/workhorse/jobs/cleanup_succeeded_jobs.rb
+- lib/workhorse/jobs/run_active_job.rb
 - lib/workhorse/jobs/run_rails_op.rb
 - lib/workhorse/performer.rb
 - lib/workhorse/poller.rb
 - lib/workhorse/pool.rb
 - lib/workhorse/worker.rb
+- test/active_job/queue_adapters/workhorse_adapter_test.rb
 - test/lib/db_schema.rb
 - test/lib/jobs.rb
 - test/lib/test_helper.rb
@@ -231,6 +248,7 @@ signing_key:
 specification_version: 4
 summary: Multi-threaded job backend with database queuing for ruby.
 test_files:
+- test/active_job/queue_adapters/workhorse_adapter_test.rb
 - test/lib/db_schema.rb
 - test/lib/jobs.rb
 - test/lib/test_helper.rb