inst-jobs 2.3.3 → 2.4.0

data/lib/delayed/yaml_extensions.rb

@@ -2,36 +2,37 @@
 
 # New definitions for YAML to aid in serialization and deserialization of delayed jobs.
 
-require 'yaml'
+require "yaml"
 
 # These two added domain types are for backwards compatibility with jobs created
 # using the old syck tags, as syck didn't have built-in module/class dumping. We
 # now use Psych's built-in tags, which are `!ruby/module` and `!ruby/class`. At
 # some point we can remove these, once there are no more jobs in any queues with
 # these tags.
-Psych.add_domain_type("ruby/object", "Module") do |type, val|
+Psych.add_domain_type("ruby/object", "Module") do |_type, val|
   val.constantize
 end
-Psych.add_domain_type("ruby/object", "Class") do |type, val|
+Psych.add_domain_type("ruby/object", "Class") do |_type, val|
   val.constantize
 end
 
 # Tell YAML how to intelligently load ActiveRecord objects, using the
 # database rather than just serializing their attributes to the YAML. This
 # ensures the object is up to date when we use it in the job.
-class ActiveRecord::Base
-  def encode_with(coder)
-    if id.nil?
-      raise("Can't serialize unsaved ActiveRecord object for delayed job: #{self.inspect}")
+module ActiveRecord
+  class Base
+    def encode_with(coder)
+      raise("Can't serialize unsaved ActiveRecord object for delayed job: #{inspect}") if id.nil?
+
+      coder.scalar("!ruby/ActiveRecord:#{self.class.name}", id.to_s)
     end
-    coder.scalar("!ruby/ActiveRecord:#{self.class.name}", id.to_s)
   end
 end
 
 module Delayed
   module PsychExt
     module ToRuby
-      def visit_Psych_Nodes_Scalar(object)
+      def visit_Psych_Nodes_Scalar(object) # rubocop:disable Naming/MethodName
         case object.tag
         when %r{^!ruby/ActiveRecord:(.+)$}
           begin
@@ -50,7 +51,8 @@ module Delayed
       end
 
       def resolve_class(klass_name)
-        return nil if !klass_name || klass_name.empty?
+        return nil if klass_name.blank?
+
         klass_name.constantize
       rescue
         super

data/lib/delayed_job.rb

@@ -14,44 +14,43 @@ module Delayed
   end
 end
 
-require 'rails'
-require 'active_support/core_ext/module/attribute_accessors'
-require 'active_record'
-require 'after_transaction_commit'
-require 'debug_inspector'
-
-require 'delayed/core_ext/kernel'
-
-require 'delayed/settings'
-require 'delayed/yaml_extensions'
-
-require 'delayed/backend/base'
-require 'delayed/backend/active_record'
-require 'delayed/backend/redis/job'
-require 'delayed/batch'
-require 'delayed/cli'
-require 'delayed/daemon'
-require 'delayed/job_tracking'
-require 'delayed/lifecycle'
-require 'delayed/log_tailer'
-require 'delayed/logging'
-require 'delayed/message_sending'
-require 'delayed/performable_method'
-require 'delayed/periodic'
-require 'delayed/plugin'
-require 'delayed/pool'
-require 'delayed/worker'
-
-require 'delayed/worker/health_check'
-require 'delayed/worker/consul_health_check'
-require 'delayed/worker/null_health_check'
-
-require 'delayed/work_queue/in_process'
-require 'delayed/work_queue/parent_process'
-
-require 'delayed/engine'
+require "rails"
+require "active_support/core_ext/module/attribute_accessors"
+require "active_record"
+require "after_transaction_commit"
+require "debug_inspector"
+
+require "delayed/core_ext/kernel"
+
+require "delayed/settings"
+require "delayed/yaml_extensions"
+
+require "delayed/backend/base"
+require "delayed/backend/active_record"
+require "delayed/batch"
+require "delayed/cli"
+require "delayed/daemon"
+require "delayed/job_tracking"
+require "delayed/lifecycle"
+require "delayed/log_tailer"
+require "delayed/logging"
+require "delayed/message_sending"
+require "delayed/performable_method"
+require "delayed/periodic"
+require "delayed/plugin"
+require "delayed/pool"
+require "delayed/worker"
+
+require "delayed/worker/health_check"
+require "delayed/worker/consul_health_check"
+require "delayed/worker/null_health_check"
+
+require "delayed/work_queue/in_process"
+require "delayed/work_queue/parent_process"
+
+require "delayed/engine"
 
 Delayed.select_backend(Delayed::Backend::ActiveRecord::Job)
 
-Object.send(:include, Delayed::MessageSending)
-Module.send(:include, Delayed::MessageSending::ClassMethods)
+Object.include Delayed::MessageSending
+Module.include Delayed::MessageSending::ClassMethods

data/lib/inst-jobs.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require 'delayed_job'
+require "delayed_job"

data/spec/active_record_job_spec.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require File.expand_path("../spec_helper", __FILE__)
-
-describe 'Delayed::Backed::ActiveRecord::Job' do
+describe "Delayed::Backed::ActiveRecord::Job" do
   before :all do
     Delayed.select_backend(Delayed::Backend::ActiveRecord::Job)
   end
@@ -11,207 +9,202 @@ describe 'Delayed::Backed::ActiveRecord::Job' do
     Delayed::Testing.clear_all!
   end
 
-  include_examples 'a delayed_jobs implementation'
+  include_examples "a delayed_jobs implementation"
 
-  it "should recover as well as possible from a failure failing a job" do
+  it "recovers as well as possible from a failure failing a job" do
     allow(Delayed::Job::Failed).to receive(:create).and_raise(RuntimeError)
     job = "test".delay(ignore_transaction: true).reverse
     job_id = job.id
-    proc { job.fail! }.should raise_error(RuntimeError)
-    proc { Delayed::Job.find(job_id) }.should raise_error(ActiveRecord::RecordNotFound)
-    Delayed::Job.count.should == 0
+    expect { job.fail! }.to raise_error(RuntimeError)
+    expect { Delayed::Job.find(job_id) }.to raise_error(ActiveRecord::RecordNotFound)
+    expect(Delayed::Job.count).to eq(0)
   end
 
   context "when another worker has worked on a task since the job was found to be available, it" do
-    before :each do
-      @job = Delayed::Job.create :payload_object => SimpleJob.new
-      @job_copy_for_worker_2 = Delayed::Job.find(@job.id)
+    before do
+      @job = Delayed::Job.create payload_object: SimpleJob.new
+      @job_copy_for_worker2 = Delayed::Job.find(@job.id)
     end
 
-    it "should not allow a second worker to get exclusive access if already successfully processed by worker1" do
+    it "does not allow a second worker to get exclusive access if already successfully processed by worker1" do
       @job.destroy
-      @job_copy_for_worker_2.send(:lock_exclusively!, 'worker2').should == false
+      expect(@job_copy_for_worker2.send(:lock_exclusively!, "worker2")).to eq(false)
     end
 
-    it "should not allow a second worker to get exclusive access if failed to be processed by worker1 and run_at time is now in future (due to backing off behaviour)" do
-      @job.update(:attempts => 1, :run_at => 1.day.from_now)
-      @job_copy_for_worker_2.send(:lock_exclusively!, 'worker2').should == false
+    it "doesn't  allow a second worker to get exclusive access if failed to be processed by worker1 and
+        run_at time is now in future (due to backing off behaviour)" do
+      @job.update(attempts: 1, run_at: 1.day.from_now)
+      expect(@job_copy_for_worker2.send(:lock_exclusively!, "worker2")).to eq(false)
     end
 
-    it "should select the next job at random if enabled" do
-      begin
-        Delayed::Settings.select_random_from_batch = true
-        15.times { "test".delay.length }
-        founds = []
-        15.times do
-          job = Delayed::Job.get_and_lock_next_available('tester')
-          founds << job
-          job.unlock
-          job.save!
-        end
-        founds.uniq.size.should > 1
-      ensure
-        Delayed::Settings.select_random_from_batch = false
+    it "selects the next job at random if enabled" do
+      Delayed::Settings.select_random_from_batch = true
+      15.times { "test".delay.length }
+      founds = []
+      15.times do
+        job = Delayed::Job.get_and_lock_next_available("tester")
+        founds << job
+        job.unlock
+        job.save!
       end
+      expect(founds.uniq.size).to be > 1
+    ensure
+      Delayed::Settings.select_random_from_batch = false
     end
   end
 
-  it "should unlock a successfully locked job and persist the job's unlocked state" do
-    job = Delayed::Job.create :payload_object => SimpleJob.new
-    job.send(:lock_exclusively!, 'worker1').should == true
+  it "unlocks a successfully locked job and persist the job's unlocked state" do
+    job = Delayed::Job.create payload_object: SimpleJob.new
+    expect(job.send(:lock_exclusively!, "worker1")).to eq(true)
     job.reload
     job.unlock
     job.save!
     job.reload
-    job.locked_by.should == nil
-    job.locked_at.should == nil
+    expect(job.locked_by).to eq(nil)
+    expect(job.locked_at).to eq(nil)
   end
 
   describe "bulk_update failed jobs" do
     context "holding/unholding failed jobs" do
-      before :each do
-        @job = Delayed::Job.create :payload_object => SimpleJob.new
-        Delayed::Job.get_and_lock_next_available('worker1').should == @job
+      before do
+        @job = Delayed::Job.create payload_object: SimpleJob.new
+        expect(Delayed::Job.get_and_lock_next_available("worker1")).to eq(@job)
         @job.fail!
       end
 
-      it "should raise error when holding failed jobs" do
-        expect { Delayed::Job.bulk_update('hold', :flavor => 'failed', :query => @query) }.to raise_error(RuntimeError)
+      it "raises error when holding failed jobs" do
+        expect { Delayed::Job.bulk_update("hold", flavor: "failed", query: @query) }.to raise_error(RuntimeError)
       end
 
-      it "should raise error unholding failed jobs" do
-        expect { Delayed::Job.bulk_update('unhold', :flavor => 'failed', :query => @query) }.to raise_error(RuntimeError)
+      it "raises error unholding failed jobs" do
+        expect { Delayed::Job.bulk_update("unhold", flavor: "failed", query: @query) }.to raise_error(RuntimeError)
       end
     end
 
     context "deleting failed jobs" do
-      before :each do
-        2.times {
-          j = Delayed::Job.create(:payload_object => SimpleJob.new)
-          j.send(:lock_exclusively!, 'worker1').should == true
+      before do
+        2.times do
+          j = Delayed::Job.create(payload_object: SimpleJob.new)
+          expect(j.send(:lock_exclusively!, "worker1")).to eq(true)
           j.fail!
-        }
+        end
       end
 
-      it "should delete failed jobs by id" do
-        target_ids = Delayed::Job::Failed.all[0..2].map { |j| j.id }
-        Delayed::Job.bulk_update('destroy', :ids => target_ids, :flavor => 'failed', :query => @query).should == target_ids.length
+      it "deletes failed jobs by id" do
+        target_ids = Delayed::Job::Failed.all[0..2].map(&:id)
+        expect(Delayed::Job.bulk_update("destroy", ids: target_ids, flavor: "failed",
+                                                   query: @query)).to eq(target_ids.length)
       end
 
-      it "should delete all failed jobs" do
+      it "deletes all failed jobs" do
         failed_count = Delayed::Job::Failed.count
-        Delayed::Job.bulk_update('destroy', :flavor => 'failed', :query => @query).should == failed_count
+        expect(Delayed::Job.bulk_update("destroy", flavor: "failed", query: @query)).to eq(failed_count)
       end
     end
   end
 
-  context 'n_strand' do
-    it "should default to 1" do
-      expect(Delayed::Job).to receive(:rand).never
-      job = Delayed::Job.enqueue(SimpleJob.new, :n_strand => 'njobs')
-      job.strand.should == "njobs"
+  context "n_strand" do
+    it "defaults to 1" do
+      expect(Delayed::Job).not_to receive(:rand)
+      job = Delayed::Job.enqueue(SimpleJob.new, n_strand: "njobs")
+      expect(job.strand).to eq("njobs")
     end
 
-    it "should set max_concurrent based on num_strands" do
-      change_setting(Delayed::Settings, :num_strands, ->(strand_name) { expect(strand_name).to eql "njobs"; "3" }) do
-        job = Delayed::Job.enqueue(SimpleJob.new, :n_strand => 'njobs')
-        job.strand.should == "njobs"
-        job.max_concurrent.should == 3
+    it "sets max_concurrent based on num_strands" do
+      change_setting(Delayed::Settings, :num_strands, lambda { |strand_name|
+                                                        expect(strand_name).to eql "njobs"
+                                                        "3"
+                                                      }) do
+        job = Delayed::Job.enqueue(SimpleJob.new, n_strand: "njobs")
+        expect(job.strand).to eq("njobs")
+        expect(job.max_concurrent).to eq(3)
       end
     end
 
     context "with two parameters" do
-      it "should use the first param as the setting to read" do
-        job = Delayed::Job.enqueue(SimpleJob.new, n_strand: ["njobs", "123"])
-        job.strand.should == "njobs/123"
-        change_setting(Delayed::Settings, :num_strands, ->(strand_name) {
+      it "uses the first param as the setting to read" do
+        job = Delayed::Job.enqueue(SimpleJob.new, n_strand: %w[njobs 123])
+        expect(job.strand).to eq("njobs/123")
+        change_setting(Delayed::Settings, :num_strands, lambda { |strand_name|
           case strand_name
-          when "njobs"; 3
-          else nil
+          when "njobs" then 3
           end
         }) do
-          job = Delayed::Job.enqueue(SimpleJob.new, n_strand: ["njobs", "123"])
-          job.strand.should == "njobs/123"
-          job.max_concurrent.should == 3
+          job = Delayed::Job.enqueue(SimpleJob.new, n_strand: %w[njobs 123])
+          expect(job.strand).to eq("njobs/123")
+          expect(job.max_concurrent).to eq(3)
         end
       end
 
-      it "should allow overridding the setting based on the second param" do
-        change_setting(Delayed::Settings, :num_strands, ->(strand_name) {
+      it "allows overridding the setting based on the second param" do
+        change_setting(Delayed::Settings, :num_strands, lambda { |strand_name|
           case strand_name
-          when "njobs/123"; 5
-          else nil
+          when "njobs/123" then 5
           end
         }) do
-          job = Delayed::Job.enqueue(SimpleJob.new, n_strand: ["njobs", "123"])
-          job.strand.should == "njobs/123"
-          job.max_concurrent.should == 5
-          job = Delayed::Job.enqueue(SimpleJob.new, n_strand: ["njobs", "456"])
-          job.strand.should == "njobs/456"
-          job.max_concurrent.should == 1
+          job = Delayed::Job.enqueue(SimpleJob.new, n_strand: %w[njobs 123])
+          expect(job.strand).to eq("njobs/123")
+          expect(job.max_concurrent).to eq(5)
+          job = Delayed::Job.enqueue(SimpleJob.new, n_strand: %w[njobs 456])
+          expect(job.strand).to eq("njobs/456")
+          expect(job.max_concurrent).to eq(1)
         end
 
-        change_setting(Delayed::Settings, :num_strands, ->(strand_name) {
+        change_setting(Delayed::Settings, :num_strands, lambda { |strand_name|
           case strand_name
-          when "njobs/123"; 5
-          when "njobs"; 3
-          else nil
+          when "njobs/123" then 5
+          when "njobs" then 3
           end
         }) do
-          job = Delayed::Job.enqueue(SimpleJob.new, n_strand: ["njobs", "123"])
-          job.strand.should == "njobs/123"
-          job.max_concurrent.should == 5
-          job = Delayed::Job.enqueue(SimpleJob.new, n_strand: ["njobs", "456"])
-          job.strand.should == "njobs/456"
-          job.max_concurrent.should == 3
+          job = Delayed::Job.enqueue(SimpleJob.new, n_strand: %w[njobs 123])
+          expect(job.strand).to eq("njobs/123")
+          expect(job.max_concurrent).to eq(5)
+          job = Delayed::Job.enqueue(SimpleJob.new, n_strand: %w[njobs 456])
+          expect(job.strand).to eq("njobs/456")
+          expect(job.max_concurrent).to eq(3)
         end
       end
     end
 
     context "max_concurrent triggers" do
-      before do
-        skip("postgres specific") unless ActiveRecord::Base.connection.adapter_name == 'PostgreSQL'
-      end
-
-      it "should set one job as next_in_strand at a time with max_concurrent of 1" do
+      it "sets one job as next_in_strand at a time with max_concurrent of 1" do
         job1 = Delayed::Job.enqueue(SimpleJob.new, n_strand: ["njobs"])
         job1.reload
-        job1.next_in_strand.should == true
+        expect(job1.next_in_strand).to eq(true)
         job2 = Delayed::Job.enqueue(SimpleJob.new, n_strand: ["njobs"])
         job2.reload
-        job2.next_in_strand.should == false
+        expect(job2.next_in_strand).to eq(false)
         run_job(job1)
         job2.reload
-        job2.next_in_strand.should == true
+        expect(job2.next_in_strand).to eq(true)
       end
 
-      it "should set multiple jobs as next_in_strand at a time based on max_concurrent" do
-        change_setting(Delayed::Settings, :num_strands, ->(strand_name) {
+      it "sets multiple jobs as next_in_strand at a time based on max_concurrent" do
+        change_setting(Delayed::Settings, :num_strands, lambda { |strand_name|
           case strand_name
-          when "njobs"; 2
-          else nil
+          when "njobs" then 2
           end
         }) do
           job1 = Delayed::Job.enqueue(SimpleJob.new, n_strand: ["njobs"])
           job1.reload
-          job1.next_in_strand.should == true
+          expect(job1.next_in_strand).to eq(true)
           job2 = Delayed::Job.enqueue(SimpleJob.new, n_strand: ["njobs"])
           job2.reload
-          job2.next_in_strand.should == true
+          expect(job2.next_in_strand).to eq(true)
           job3 = Delayed::Job.enqueue(SimpleJob.new, n_strand: ["njobs"])
           job3.reload
-          job3.next_in_strand.should == false
+          expect(job3.next_in_strand).to eq(false)
           run_job(job1)
           job3.reload
-          job3.next_in_strand.should == true
+          expect(job3.next_in_strand).to eq(true)
         end
       end
     end
   end
 
   it "unlocks orphaned prefetched_jobs" do
-    job1 = Delayed::Job.new(:tag => 'tag')
-    job2 = Delayed::Job.new(:tag => 'tag')
+    job1 = Delayed::Job.new(tag: "tag")
+    job2 = Delayed::Job.new(tag: "tag")
 
     job1.create_and_lock!("prefetch:a")
     job1.locked_at = Delayed::Job.db_time_now - 15 * 60
@@ -222,49 +215,49 @@ describe 'Delayed::Backed::ActiveRecord::Job' do
     expect(Delayed::Job.unlock_orphaned_prefetched_jobs).to eq 0
 
     expect(Delayed::Job.find(job1.id).locked_by).to be_nil
-    expect(Delayed::Job.find(job2.id).locked_by).to eq 'prefetch:a'
+    expect(Delayed::Job.find(job2.id).locked_by).to eq "prefetch:a"
   end
 
   it "gets process ids from locked_by" do
-    3.times.map { Delayed::Job.create :payload_object => SimpleJob.new }
-    locked_jobs = Delayed::Job.get_and_lock_next_available(['job42:2', 'job42:9001'])
-    expect(Delayed::Job.processes_locked_locally(name: 'job42').sort).to eq [2, 9001]
-    expect(Delayed::Job.processes_locked_locally(name: 'jobnotme')).to be_empty
+    3.times.map { Delayed::Job.create payload_object: SimpleJob.new }
+    Delayed::Job.get_and_lock_next_available(["job42:2", "job42:9001"])
+    expect(Delayed::Job.processes_locked_locally(name: "job42").sort).to eq [2, 9001]
+    expect(Delayed::Job.processes_locked_locally(name: "jobnotme")).to be_empty
   end
 
   it "allows fetching multiple jobs at once" do
-    jobs = 3.times.map { Delayed::Job.create :payload_object => SimpleJob.new }
-    locked_jobs = Delayed::Job.get_and_lock_next_available(['worker1', 'worker2'])
-    locked_jobs.length.should == 2
-    locked_jobs.keys.should == ['worker1', 'worker2']
-    locked_jobs.values.should == jobs[0..1]
-    jobs.map(&:reload).map(&:locked_by).should == ['worker1', 'worker2', nil]
+    jobs = 3.times.map { Delayed::Job.create payload_object: SimpleJob.new }
+    locked_jobs = Delayed::Job.get_and_lock_next_available(%w[worker1 worker2])
+    expect(locked_jobs.length).to eq(2)
+    expect(locked_jobs.keys).to eq(%w[worker1 worker2])
+    expect(locked_jobs.values).to eq(jobs[0..1])
+    expect(jobs.map(&:reload).map(&:locked_by)).to eq(["worker1", "worker2", nil])
   end
 
   it "allows fetching extra jobs" do
-    jobs = 5.times.map { Delayed::Job.create :payload_object => SimpleJob.new }
-    locked_jobs = Delayed::Job.get_and_lock_next_available(['worker1'],
+    jobs = 5.times.map { Delayed::Job.create payload_object: SimpleJob.new }
+    locked_jobs = Delayed::Job.get_and_lock_next_available(["worker1"],
                                                            prefetch: 2,
-                                                           prefetch_owner: 'work_queue')
+                                                           prefetch_owner: "work_queue")
     expect(locked_jobs.length).to eq 2
-    expect(locked_jobs.keys).to eq ['worker1', 'work_queue']
-    expect(locked_jobs['worker1']).to eq jobs[0]
-    expect(locked_jobs['work_queue']).to eq jobs[1..2]
-    jobs.map(&:reload).map(&:locked_by).should == ['worker1', 'work_queue', 'work_queue', nil, nil]
+    expect(locked_jobs.keys).to eq %w[worker1 work_queue]
+    expect(locked_jobs["worker1"]).to eq jobs[0]
+    expect(locked_jobs["work_queue"]).to eq jobs[1..2]
+    expect(jobs.map(&:reload).map(&:locked_by)).to eq(["worker1", "work_queue", "work_queue", nil, nil])
   end
 
-
-  it "should not find jobs scheduled for now when we have forced latency" do
+  it "does not find jobs scheduled for now when we have forced latency" do
     job = create_job
-    Delayed::Job.get_and_lock_next_available('worker', forced_latency: 60.0).should be_nil
-    Delayed::Job.get_and_lock_next_available('worker').should eq job
+    expect(Delayed::Job.get_and_lock_next_available("worker", forced_latency: 60.0)).to be_nil
+    expect(Delayed::Job.get_and_lock_next_available("worker")).to eq job
   end
 
   context "non-transactional", non_transactional: true do
     it "creates a stranded job in a single statement" do
       allow(Delayed::Job.connection).to receive(:prepared_statements).and_return(false)
-      allow(Delayed::Job.connection).to receive(:execute).with(be_include("pg_advisory_xact_lock"), anything).and_call_original.once
-      allow(Delayed::Job.connection).to receive(:insert).never
+      allow(Delayed::Job.connection).to receive(:execute).with(be_include("pg_advisory_xact_lock"),
+                                                               anything).and_call_original.once
+      expect(Delayed::Job.connection).not_to receive(:insert)
       j = create_job(strand: "test1")
       allow(Delayed::Job.connection).to receive(:execute).and_call_original
       expect(Delayed::Job.find(j.id)).to eq j
@@ -277,7 +270,7 @@ describe 'Delayed::Backed::ActiveRecord::Job' do
         call_count += 1
         m.call(arg1, arg2)
       end
-      allow(Delayed::Job.connection).to receive(:insert).never
+      expect(Delayed::Job.connection).not_to receive(:insert)
       j = create_job(strand: "test1")
       expect(call_count).to eq 1
       expect(Delayed::Job.find(j.id)).to eq j
@@ -293,7 +286,7 @@ describe 'Delayed::Backed::ActiveRecord::Job' do
         expect(args.first).not_to include("pg_advisory_xact_lock")
         original.call(*args)
       end
-      allow(Delayed::Job.connection).to receive(:insert).never
+      expect(Delayed::Job.connection).not_to receive(:insert)
       j.fail!
       allow(Delayed::Job.connection).to receive(:execute).and_call_original
     end