inst-jobs 3.0.13 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1369efb0e72de3f01f922b7f77a95a6c5dd1979aaec11cfd76cdc4507202428
-  data.tar.gz: 244a543711c3ceab301f4ea0f30bb238e47330921059ec27133a7a2de44389f7
+  metadata.gz: 95bdbd537405c6325f378bed05570a3149053ba8a2e290893010c590df72ea9a
+  data.tar.gz: 6f0d577f1fba37bb01e3e0a4ec05b600e65ebb77d001e29e38b479f6facde73b
 SHA512:
-  metadata.gz: '09ce7c560febe39082502641d62e9309f515d026eb95d840e3645fbb2725d9eb6c70f2b147402a44d462bc5761c8f4727739e87a7f4a6acbed391868ae024d2e'
-  data.tar.gz: d0332dc2e652adf67b93f61122d535a7e48f20d48e9d66a08d2e5fc75d08c4be1c7e15b4656c7f1bfc4102a389bd23d256b4d43cb88b914e98ce9a0ea67ddd3c
+  metadata.gz: 38392cab25180d44f40960ffb15b2dd3241bd739980b9d0962b93020a809497bb1a9022caf7a05f4ba40f4cc3792281f03468946c33a1fc62891dec3b411f7cf
+  data.tar.gz: cbea2ab6e762a876994179ac1c9ffd414ea2ec13905931b2cddb087d816664e8b682ecf8f9406726d8f80a0867b8e44bc1331b6e0e73de3415b4ab31090d1ee9

data/db/migrate/20220519204546_add_requeued_job_id_to_failed_jobs.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddRequeuedJobIdToFailedJobs < ActiveRecord::Migration[6.0]
+  def change
+    add_column :failed_jobs, :requeued_job_id, :integer, limit: 8
+  end
+end

data/lib/delayed/backend/active_record.rb

@@ -583,6 +583,21 @@ module Delayed
           def self.cleanup_old_jobs(before_date, batch_size: 10_000)
             where("failed_at < ?", before_date).in_batches(of: batch_size).delete_all
           end
+
+          def requeue!
+            attrs = attributes.except("id", "last_error", "locked_at", "failed_at", "locked_by", "original_job_id",
+                                      "requeued_job_id")
+            self.class.transaction do
+              job = nil
+              Delayed::Worker.lifecycle.run_callbacks(:create, attrs.merge("payload_object" => payload_object)) do
+                job = Job.create(attrs)
+              end
+              self.requeued_job_id = job.id
+              save!
+              JobTracking.job_created(job)
+              job
+            end
+          end
         end
       end
     end

data/lib/delayed/backend/base.rb

@@ -86,8 +86,12 @@ module Delayed
             kwargs.merge!(n_strand_options(full_strand_name, num_strands))
           end
 
+          job = nil
+
           if singleton
-            job = create(**kwargs)
+            Delayed::Worker.lifecycle.run_callbacks(:create, kwargs) do
+              job = create(**kwargs)
+            end
           elsif batches && strand.nil? && run_at.nil?
             batch_enqueue_args = kwargs.slice(*self.batch_enqueue_args)
             batches[batch_enqueue_args] << kwargs
@@ -95,7 +99,9 @@ module Delayed
           else
             raise ArgumentError, "on_conflict can only be provided with singleton" if kwargs[:on_conflict]
 
-            job = create(**kwargs)
+            Delayed::Worker.lifecycle.run_callbacks(:create, kwargs) do
+              job = create(**kwargs)
+            end
           end
 
           JobTracking.job_created(job)

data/lib/delayed/lifecycle.rb

@@ -5,6 +5,7 @@ module Delayed
 
   class Lifecycle
     EVENTS = {
+      create: [:args],
       error: %i[worker job exception],
       exceptional_exit: %i[worker exception],
       execute: [:worker],
@@ -76,7 +77,7 @@ module Delayed
     def execute(*args, &block)
       @before.each { |c| c.call(*args) }
       result = @around.call(*args, &block)
-      @after.each { |c| c.call(*args) }
+      @after.each { |c| c.call(*args, result: result) }
       result
     end
 

data/lib/delayed/server.rb

@@ -16,7 +16,7 @@ module Delayed
       # Rails will take care of establishing the DB connection for us if there is
       # an application present
       if using_active_record? && !ActiveRecord::Base.connected?
-        ActiveRecord::Base.establish_connection(ENV["DATABASE_URL"])
+        ActiveRecord::Base.establish_connection(ENV.fetch("DATABASE_URL", nil))
       end
 
       @allow_update = args.length.positive? && args[0][:update]

data/lib/delayed/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Delayed
-  VERSION = "3.0.13"
+  VERSION = "3.1.2"
 end

data/lib/delayed/worker.rb

@@ -276,7 +276,7 @@ module Delayed
     # set up the session context information, so that it gets logged with the job log lines
     # also set up a unique tmpdir, which will get removed at the end of the job.
     def configure_for_job(job)
-      previous_tmpdir = ENV["TMPDIR"]
+      previous_tmpdir = ENV.fetch("TMPDIR", nil)
 
       self.class.running_job(job) do
         dir = Dir.mktmpdir("job-#{job.id}-#{name.gsub(/[^\w.]/, '.')}-")

data/spec/active_record_job_spec.rb

@@ -300,4 +300,27 @@ describe "Delayed::Backed::ActiveRecord::Job" do
       allow(Delayed::Job.connection).to receive(:execute).and_call_original
     end
   end
+
+  context "Failed#requeue!" do
+    it "requeues a failed job" do
+      j = create_job(attempts: 1, max_attempts: 1)
+      fj = j.fail!
+
+      lifecycle_args = nil
+      Delayed::Worker.lifecycle.after(:create) do |args|
+        lifecycle_args = args
+      end
+      j2 = fj.requeue!
+      expect(lifecycle_args["payload_object"].class).to eq SimpleJob
+      expect(fj.reload.requeued_job_id).to eq j2.id
+
+      orig_atts = j.attributes.except("id", "locked_at", "locked_by")
+      new_atts = j2.attributes.except("id", "locked_at", "locked_by")
+      expect(orig_atts).to eq(new_atts)
+
+      # ensure the requeued job actually runs even though `attempts` are maxed out
+      # (so it will not be retried after being manually requeued)
+      expect { run_job(j2) }.to change(SimpleJob, :runs).by(1)
+    end
+  end
 end

data/spec/shared/shared_backend.rb

@@ -35,6 +35,23 @@ shared_examples_for "a backend" do
     expect(Delayed::Job.jobs_count(:current)).to eq(1)
   end
 
+  it "triggers the lifecycle event around the create" do
+    called = false
+    created_job = nil
+
+    Delayed::Worker.lifecycle.after(:create) do |_, result:|
+      called = true
+      created_job = result
+    end
+
+    job = SimpleJob.new
+    Delayed::Job.enqueue(job)
+
+    expect(called).to be_truthy
+    expect(created_job).to be_kind_of Delayed::Job
+    expect(created_job.tag).to eq "SimpleJob#perform"
+  end
+
   it "is able to set priority when enqueuing items" do
     @job = Delayed::Job.enqueue SimpleJob.new, priority: 5
     expect(@job.priority).to eq(5)
@@ -65,7 +82,7 @@ shared_examples_for "a backend" do
   it "works with jobs in modules" do
     M::ModuleJob.runs = 0
     job = Delayed::Job.enqueue M::ModuleJob.new
-    expect { job.invoke_job }.to change { M::ModuleJob.runs }.from(0).to(1)
+    expect { job.invoke_job }.to change(M::ModuleJob, :runs).from(0).to(1)
   end
 
   it "raises an DeserializationError when the job class is totally unknown" do

data/spec/shared/worker.rb

@@ -347,7 +347,7 @@ shared_examples_for "Delayed::Worker" do
 
     it "does not run expired jobs" do
       Delayed::Job.enqueue SimpleJob.new, expires_at: Delayed::Job.db_time_now - 1.day
-      expect { @worker.run }.to change(SimpleJob, :runs).by(0)
+      expect { @worker.run }.not_to change(SimpleJob, :runs)
     end
 
     it "reports a permanent failure when an expired job is dequeued" do

data/spec/spec_helper.rb

@@ -47,14 +47,14 @@ RSpec::Core::ExampleGroup.include(NoYamlDump)
 
 ENV["TEST_ENV_NUMBER"] ||= "1"
 ENV["TEST_DB_HOST"] ||= "localhost"
-ENV["TEST_DB_DATABASE"] ||= "inst-jobs-test-#{ENV['TEST_ENV_NUMBER']}"
+ENV["TEST_DB_DATABASE"] ||= "inst-jobs-test-#{ENV.fetch('TEST_ENV_NUMBER', nil)}"
 
 connection_config = {
   adapter: :postgresql,
   host: ENV["TEST_DB_HOST"].presence,
   encoding: "utf8",
-  username: ENV["TEST_DB_USERNAME"],
-  database: ENV["TEST_DB_DATABASE"],
+  username: ENV.fetch("TEST_DB_USERNAME", nil),
+  database: ENV.fetch("TEST_DB_DATABASE", nil),
   min_messages: "notice",
   # Ensure the pool is big enough the deadlock tests don't get starved for connections by rails instead
   pool: 20

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inst-jobs
 version: !ruby/object:Gem::Version
-  version: 3.0.13
+  version: 3.1.2
 platform: ruby
 authors:
 - Cody Cutrer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-05 00:00:00.000000000 Z
+date: 2022-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -460,6 +460,7 @@ files:
 - db/migrate/20220128084900_update_delete_trigger_for_singleton_unique_constraint_change.rb
 - db/migrate/20220203063200_remove_old_singleton_index.rb
 - db/migrate/20220328152900_add_failed_jobs_indicies.rb
+- db/migrate/20220519204546_add_requeued_job_id_to_failed_jobs.rb
 - exe/inst_jobs
 - lib/delayed/backend/active_record.rb
 - lib/delayed/backend/base.rb