inst-jobs 3.0.10 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80d0bc1d05ae57467d66361e81fa51a5b45e3fa391250005c59229554757ec08
-  data.tar.gz: 32d3df9f6085199fa1e9586330c6ba255f898602eb546ea94f49de52b628e7df
+  metadata.gz: 37ca25ff97580c47a56d0d40a1ab2f78c62a2f47629d0c2e5ba6c8e5c4ace0bd
+  data.tar.gz: 16d4a060bfc0c23f84360d305e35adb5482d0d96f50b50c1a45a8a0b02739c90
 SHA512:
-  metadata.gz: 3befc529f42b4ebcba81aacea9bb4c4401a9daa06708c545572b6d6485db85b3d650b9d12baec0dadad9c7387b30ec5e051493b2992a0f6cd41ced9bcfca2485
-  data.tar.gz: 3a3629c08198e0e17455468fd670f4acdd05b28d76b4fbe88516f50692852b6edaf4ed29b6fc26babdfbcca669c9502e88c37616a24cbed5e82611664a3262de
+  metadata.gz: 7f981418c6f0493c84114777193674559f8a0a15006547600bc00cc44eaaff08232c7695f801a3b84c2919167c68c7fb7d91562aa1d4d47d9f98d28a1362b0e3
+  data.tar.gz: 4b31d64c30f9208c54b32796d6ad99f22f9beb3f405a8b4585398306d03b15063d3fde88fce2d063f4f76949da1e350bf4607b8bcf6709a4a20ff686f5c87b6d

data/db/migrate/20220328152900_add_failed_jobs_indicies.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class AddFailedJobsIndicies < ActiveRecord::Migration[5.2]
+  disable_ddl_transaction!
+
+  def change
+    add_index :failed_jobs, :failed_at, algorithm: :concurrently
+    add_index :failed_jobs, :strand, where: "strand IS NOT NULL", algorithm: :concurrently
+    add_index :failed_jobs, :singleton, where: "singleton IS NOT NULL", algorithm: :concurrently
+    add_index :failed_jobs, :tag, algorithm: :concurrently
+  end
+end

data/lib/delayed/backend/active_record.rb

@@ -579,6 +579,10 @@ module Delayed
         class Failed < Job
           include Delayed::Backend::Base
           self.table_name = :failed_jobs
+
+          def self.cleanup_old_jobs(before_date, batch_size: 10_000)
+            where("failed_at < ?", before_date).in_batches(of: batch_size).delete_all
+          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],

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/settings.rb

@@ -33,6 +33,7 @@ module Delayed
 
     SETTINGS_WITH_ARGS = %i[
       job_detailed_log_format
+      job_short_log_format
       num_strands
     ].freeze
 
@@ -137,6 +138,7 @@ module Delayed
     self.job_detailed_log_format = lambda { |job|
       job.to_json(include_root: false, only: %w[tag strand singleton priority attempts created_at max_attempts source])
     }
+    self.job_short_log_format = ->(_job) { "" }
 
     # Send workers KILL after QUIT if they haven't exited within the
     # slow_exit_timeout

data/lib/delayed/version.rb

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

data/lib/delayed/worker.rb

@@ -220,7 +220,7 @@ module Delayed
             end
             job.destroy
           end
-          logger.info("Completed #{log_job(job)} #{format('%.0fms', (runtime * 1000))}")
+          logger.info("Completed #{log_job(job, :short)} #{format('%.0fms', (runtime * 1000))}")
         end
       rescue ::Delayed::RetriableError => e
         can_retry = job.attempts + 1 < job.inferred_max_attempts
@@ -269,14 +269,14 @@ module Delayed
       when :long
         "#{job.full_name} #{Settings.job_detailed_log_format.call(job)}"
       else
-        job.full_name
+        "#{job.full_name} #{Settings.job_short_log_format.call(job)}".strip
       end
     end
 
     # 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

@@ -100,6 +100,15 @@ describe "Delayed::Backed::ActiveRecord::Job" do
         failed_count = Delayed::Job::Failed.count
         expect(Delayed::Job.bulk_update("destroy", flavor: "failed", query: @query)).to eq(failed_count)
       end
+
+      it "deletes all failed jobs before a given date" do
+        Delayed::Job::Failed.first.update!(failed_at: 3.hours.ago)
+        Delayed::Job::Failed.last.update!(failed_at: 1.hour.ago)
+
+        expect(Delayed::Job::Failed.count).to eq 2
+        Delayed::Job::Failed.cleanup_old_jobs(2.hours.ago)
+        expect(Delayed::Job::Failed.count).to eq 1
+      end
     end
   end
 

data/spec/delayed/worker_spec.rb

@@ -85,13 +85,14 @@ describe Delayed::Worker do
     end
 
     it "logging format can be changed with settings" do
-      Delayed::Settings.job_detailed_log_format = ->(job) { "override format #{job.strand}" }
+      Delayed::Settings.job_detailed_log_format = ->(job) { "override format detailed #{job.strand}" }
+      Delayed::Settings.job_short_log_format = ->(_job) { "override format short" }
       payload = double(perform: nil)
       job = Delayed::Job.new(payload_object: payload, priority: 25, strand: "test_jobs")
       short_log_format = subject.log_job(job, :short)
-      expect(short_log_format).to eq("RSpec::Mocks::Double")
+      expect(short_log_format).to eq("RSpec::Mocks::Double override format short")
       long_format = subject.log_job(job, :long)
-      expect(long_format).to eq("RSpec::Mocks::Double override format test_jobs")
+      expect(long_format).to eq("RSpec::Mocks::Double override format detailed test_jobs")
     end
   end
 

data/spec/shared/shared_backend.rb

@@ -35,6 +35,22 @@ 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
+    called_args = nil
+
+    Delayed::Worker.lifecycle.after(:create) do |args|
+      called = true
+      called_args = args
+    end
+
+    job = SimpleJob.new
+    Delayed::Job.enqueue(job)
+
+    expect(called).to be_truthy
+    expect(called_args[:payload_object]).to eq job
+  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)
@@ -389,7 +405,7 @@ shared_examples_for "a backend" do
         expect(job1.reload.handler).to include("ErrorJob")
       end
 
-      context "next_in_strand management - deadlocks and race conditions", non_transactional: true do
+      context "next_in_strand management - deadlocks and race conditions", non_transactional: true, slow: true do
         # The following unit tests are fairly slow and non-deterministic. It may be
         # easier to make them fail quicker and more consistently by adding a random
         # sleep into the appropriate trigger(s).

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,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: inst-jobs
 version: !ruby/object:Gem::Version
-  version: 3.0.10
+  version: 3.1.0
 platform: ruby
 authors:
 - Cody Cutrer
 - Ethan Vizitei
 - Jacob Burroughs
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-21 00:00:00.000000000 Z
+date: 2022-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -410,7 +410,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - cody@instructure.com
 - evizitei@instructure.com
@@ -459,6 +459,7 @@ files:
 - db/migrate/20220128084800_update_insert_trigger_for_singleton_unique_constraint_change.rb
 - 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
 - exe/inst_jobs
 - lib/delayed/backend/active_record.rb
 - lib/delayed/backend/base.rb
@@ -526,7 +527,7 @@ homepage: https://github.com/instructure/inst-jobs
 licenses: []
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -541,32 +542,32 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Instructure-maintained fork of delayed_job
 test_files:
-- spec/sample_jobs.rb
-- spec/spec_helper.rb
-- spec/shared_jobs_specs.rb
-- spec/shared/performable_method.rb
-- spec/shared/testing.rb
-- spec/shared/delayed_batch.rb
-- spec/shared/worker.rb
-- spec/shared/delayed_method.rb
-- spec/shared/shared_backend.rb
-- spec/migrate/20140924140513_add_story_table.rb
-- spec/delayed/server_spec.rb
+- spec/active_record_job_spec.rb
 - spec/delayed/cli_spec.rb
 - spec/delayed/daemon_spec.rb
-- spec/delayed/worker_spec.rb
-- spec/delayed/periodic_spec.rb
 - spec/delayed/message_sending_spec.rb
+- spec/delayed/periodic_spec.rb
+- spec/delayed/server_spec.rb
 - spec/delayed/settings_spec.rb
 - spec/delayed/work_queue/in_process_spec.rb
-- spec/delayed/work_queue/parent_process_spec.rb
 - spec/delayed/work_queue/parent_process/client_spec.rb
 - spec/delayed/work_queue/parent_process/server_spec.rb
-- spec/delayed/worker/health_check_spec.rb
+- spec/delayed/work_queue/parent_process_spec.rb
 - spec/delayed/worker/consul_health_check_spec.rb
-- spec/active_record_job_spec.rb
+- spec/delayed/worker/health_check_spec.rb
+- spec/delayed/worker_spec.rb
+- spec/migrate/20140924140513_add_story_table.rb
+- spec/sample_jobs.rb
+- spec/shared/delayed_batch.rb
+- spec/shared/delayed_method.rb
+- spec/shared/performable_method.rb
+- spec/shared/shared_backend.rb
+- spec/shared/testing.rb
+- spec/shared/worker.rb
+- spec/shared_jobs_specs.rb
+- spec/spec_helper.rb