delayed 0.5.3 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a6428c0614b28cf06d2921310bea48cc8e0bcc891a9772b7aed44238dbf1533
-  data.tar.gz: fa61f990945d382d21dd856170ce10dc52ecf44f2360a5be8ac9ec3463f9b5ac
+  metadata.gz: ae36c9e652d4fb6ce28f8897b0e7b03b7777ce9907a74973924111b735bca3ae
+  data.tar.gz: 0d4c27d0bf1f7e256fa85914086a0711c6406b4be5e88f211eccbd921c001718
 SHA512:
-  metadata.gz: 46152e349a8b725978c3ef8a281789e288301e1d605b67fe4a8562733dac1742d5a9783a329c1569dce69910e73249b1134f8a5a1b19956ccb2b3a3a355dddd9
-  data.tar.gz: f6bd7af40fd73a4d4d9fe5c2af5eb307241d627a43ecf972cc7fb6510ba1a0d2ad0b2e065fdf935bb2bc3f03ffa912f91d2cead31cd01a2ab5aa6e70d446203a
+  metadata.gz: cbae79e450983c1dd968b5f9959b4497758c32cc2c21a45ecea5b41dc1d7829fac2699d0a8cea635369d276eaec5b07ce8d7fa292674578ff62690823bc163fc
+  data.tar.gz: df37746eee87f40792499e02421f82a2fc4afa4317e168bdb440f3bed1ba737c761469092098f99e2aa3fb163f50981e6b19a83a4859e91871ac8f046363f630

data/README.md

@@ -491,6 +491,14 @@ Delayed::Worker.min_priority = nil
 Delayed::Worker.max_priority = nil
 ```
 
+Job priorities can specified by using the name of the desired range (i.e. :user_visible).
+By default, the value for a named priority will be the first value in that range.
+To set each priority's default value to the middle of its range (i.e. 15 for :user_visible), Delayed::Priority can be configured with:
+
+```ruby
+Delayed::Priority.assign_at_midpoint = true
+```
+
 Logging verbosity is also configurable. The gem will attempt to default to `Rails.logger` with an
 "info" log level.
 

data/lib/delayed/active_job_adapter.rb

@@ -1,5 +1,11 @@
 module Delayed
   class ActiveJobAdapter
+    class UnsafeEnqueueError < RuntimeError; end
+
+    def enqueue_after_transaction_commit?
+      false
+    end
+
     def enqueue(job)
       _enqueue(job)
     end
@@ -11,6 +17,10 @@ module Delayed
     private
 
     def _enqueue(job, opts = {})
+      if job.class.respond_to?(:enqueue_after_transaction_commit) && job.class.enqueue_after_transaction_commit == :always
+        raise UnsafeEnqueueError, "The ':delayed' ActiveJob adapter is not compatible with enqueue_after_transaction_commit"
+      end
+
       opts.merge!({ queue: job.queue_name, priority: job.priority }.compact)
         .merge!(job.provider_attributes || {})
 

data/lib/delayed/priority.rb

@@ -57,6 +57,8 @@ module Delayed
     }.freeze
 
     class << self
+      attr_writer :assign_at_midpoint
+
       def names
         @names || default_names
       end
@@ -70,6 +72,7 @@ module Delayed
 
         @ranges = nil
         @alerts = nil
+        @names_to_priority = nil
         @names = names&.sort_by(&:last)&.to_h&.transform_values { |v| new(v) }
       end
 
@@ -82,12 +85,25 @@ module Delayed
         @alerts = alerts&.sort_by { |k, _| names.keys.index(k) }&.to_h
       end
 
+      def assign_at_midpoint?
+        @assign_at_midpoint || false
+      end
+
       def ranges
         @ranges ||= names.zip(names.except(names.keys.first)).each_with_object({}) do |((name, lower), (_, upper)), obj|
           obj[name] = (lower...(upper || Float::INFINITY))
         end
       end
 
+      def names_to_priority
+        @names_to_priority ||=
+          if assign_at_midpoint?
+            names_to_midpoint_priority
+          else
+            names
+          end
+      end
+
       private
 
       def default_names
@@ -98,13 +114,23 @@ module Delayed
         @names ? {} : DEFAULT_ALERTS
       end
 
+      def names_to_midpoint_priority
+        names.each_cons(2).to_h { |(name, priority_value), (_, next_priority_value)|
+          [name, new(midpoint(priority_value, next_priority_value))]
+        }.merge(names.keys.last => new(names.values.last + 5))
+      end
+
+      def midpoint(low, high)
+        low + ((high - low).to_d / 2).ceil
+      end
+
       def respond_to_missing?(method_name, include_private = false)
-        names.key?(method_name) || super
+        names_to_priority.key?(method_name) || super
       end
 
       def method_missing(method_name, *args)
-        if names.key?(method_name) && args.none?
-          names[method_name]
+        if names_to_priority.key?(method_name) && args.none?
+          names_to_priority[method_name]
         else
           super
         end
@@ -118,7 +144,7 @@ module Delayed
 
     def initialize(value)
       super()
-      value = self.class.names[value] if value.is_a?(Symbol)
+      value = self.class.names_to_priority[value] if value.is_a?(Symbol)
       @value = value.to_i
     end
 
@@ -147,6 +173,20 @@ module Delayed
       to_i <=> other
     end
 
+    def -(other)
+      other = other.to_i if other.is_a?(self.class)
+      self.class.new(to_i - other)
+    end
+
+    def +(other)
+      other = other.to_i if other.is_a?(self.class)
+      self.class.new(to_i + other)
+    end
+
+    def to_d
+      to_i.to_d
+    end
+
     private
 
     def respond_to_missing?(method_name, include_private = false)

data/lib/delayed/worker.rb

@@ -89,22 +89,17 @@ module Delayed
     # Exit early if interrupted.
     def work_off(num = 100)
       success = Concurrent::AtomicFixnum.new(0)
-      failure = Concurrent::AtomicFixnum.new(0)
+      total = 0
 
-      num.times do
+      while total < num
         jobs = reserve_jobs
         break if jobs.empty?
 
+        total += jobs.length
         pool = Concurrent::FixedThreadPool.new(jobs.length)
         jobs.each do |job|
           pool.post do
-            run_thread_callbacks(job) do
-              if run_job(job)
-                success.increment
-              else
-                failure.increment
-              end
-            end
+            success.increment if run_job(job)
           end
         end
 
@@ -114,7 +109,7 @@ module Delayed
         break if stop? # leave if we're exiting
       end
 
-      [success, failure].map(&:value)
+      [success.value, total - success.value]
     end
 
     def run_thread_callbacks(job, &block)
@@ -122,30 +117,33 @@ module Delayed
     end
 
     def run(job)
-      metadata = {
-        status: 'RUNNING',
-        name: job.name,
-        run_at: job.run_at,
-        created_at: job.created_at,
-        priority: job.priority,
-        queue: job.queue,
-        attempts: job.attempts,
-        enqueued_for: (Time.current - job.created_at).round,
-      }
-      job_say job, metadata.to_json
-      run_time = Benchmark.realtime do
-        Timeout.timeout(max_run_time(job).to_i, WorkerTimeout) do
-          job.invoke_job
+      run_thread_callbacks(job) do
+        metadata = {
+          status: 'RUNNING',
+          name: job.name,
+          run_at: job.run_at,
+          created_at: job.created_at,
+          priority: job.priority,
+          queue: job.queue,
+          attempts: job.attempts,
+          enqueued_for: (Time.current - job.created_at).round,
+        }
+        job_say job, metadata.to_json
+        run_time = Benchmark.realtime do
+          Timeout.timeout(max_run_time(job).to_i, WorkerTimeout) do
+            job.invoke_job
+          end
+          job.destroy
         end
-        job.destroy
+        job_say job, format('COMPLETED after %.4f seconds', run_time)
       end
-      job_say job, format('COMPLETED after %.4f seconds', run_time)
       true # did work
     rescue DeserializationError => e
       job_say job, "FAILED permanently with #{e.class.name}: #{e.message}", 'error'
 
       job.error = e
       failed(job)
+      false # work failed
     rescue Exception => e # rubocop:disable Lint/RescueException
       self.class.lifecycle.run_callbacks(:error, self, job) { handle_failed_job(job, e) }
       false # work failed

data/spec/delayed/active_job_adapter_spec.rb

@@ -287,6 +287,30 @@ RSpec.describe Delayed::ActiveJobAdapter do
       end
     end
 
+    if ActiveJob.gem_version.release >= Gem::Version.new('7.2')
+      context 'when the given job sets enqueue_after_transaction_commit to :always' do
+        before do
+          JobClass.include ActiveJob::EnqueueAfterTransactionCommit # normally run in an ActiveJob railtie
+          JobClass.enqueue_after_transaction_commit = :always
+        end
+
+        it 'raises an exception on enqueue' do
+          expect { JobClass.perform_later }.to raise_error(Delayed::ActiveJobAdapter::UnsafeEnqueueError)
+        end
+      end
+
+      context 'when the given job sets enqueue_after_transaction_commit to :never' do
+        before do
+          JobClass.include ActiveJob::EnqueueAfterTransactionCommit # normally run in an ActiveJob railtie
+          JobClass.enqueue_after_transaction_commit = :never
+        end
+
+        it 'does not raises an exception on enqueue' do
+          expect { JobClass.perform_later }.not_to raise_error(Delayed::ActiveJobAdapter::UnsafeEnqueueError)
+        end
+      end
+    end
+
     context 'when using the ActiveJob test adapter' do
       let(:queue_adapter) { :test }
 

data/spec/delayed/priority_spec.rb

@@ -3,8 +3,10 @@ require 'helper'
 RSpec.describe Delayed::Priority do
   let(:custom_names) { nil }
   let(:custom_alerts) { nil }
+  let(:assign_at_midpoint) { nil }
 
   around do |example|
+    described_class.assign_at_midpoint = assign_at_midpoint
     described_class.names = custom_names
     described_class.alerts = custom_alerts
     example.run
@@ -13,7 +15,7 @@ RSpec.describe Delayed::Priority do
     described_class.names = nil
   end
 
-  describe '.names, .ranges, .alerts, method_missing' do
+  describe '.names, .ranges, .alerts, .names_to_priority, method_missing' do
     it 'defaults to interactive, user_visible, eventual, reporting' do
       expect(described_class.names).to eq(
         interactive: 0,
@@ -33,6 +35,12 @@ RSpec.describe Delayed::Priority do
         eventual: { age: 1.5.hours, run_time: 5.minutes, attempts: 8 },
         reporting: { age: 4.hours, run_time: 10.minutes, attempts: 8 },
       )
+      expect(described_class.names_to_priority).to eq(
+        interactive: 0,
+        user_visible: 10,
+        eventual: 20,
+        reporting: 30,
+      )
       expect(described_class).to respond_to(:interactive)
       expect(described_class).to respond_to(:user_visible)
       expect(described_class).to respond_to(:eventual)
@@ -43,6 +51,23 @@ RSpec.describe Delayed::Priority do
       expect(described_class.reporting).to eq 30
     end
 
+    context 'when assign_at_midpoint is set to true' do
+      let(:assign_at_midpoint) { true }
+
+      it 'returns the midpoint value' do
+        expect(described_class.names_to_priority).to eq(
+          interactive: 5,
+          user_visible: 15,
+          eventual: 25,
+          reporting: 35,
+        )
+        expect(described_class.interactive).to eq 5
+        expect(described_class.user_visible).to eq 15
+        expect(described_class.eventual).to eq 25
+        expect(described_class.reporting).to eq 35
+      end
+    end
+
     context 'when customized to high, medium, low' do
       let(:custom_names) { { high: 0, medium: 100, low: 500 } }
 
@@ -57,6 +82,11 @@ RSpec.describe Delayed::Priority do
           medium: (100...500),
           low: (500...Float::INFINITY),
         )
+        expect(described_class.names_to_priority).to eq(
+          high: 0,
+          medium: 100,
+          low: 500,
+        )
         expect(described_class.alerts).to eq({})
         expect(described_class).not_to respond_to(:interactive)
         expect(described_class).not_to respond_to(:user_visible)
@@ -81,6 +111,21 @@ RSpec.describe Delayed::Priority do
           )
         end
       end
+
+      context 'when assign_at_midpoint is set to true' do
+        let(:assign_at_midpoint) { true }
+
+        it 'returns the midpoint value' do
+          expect(described_class.names_to_priority).to eq(
+            high: 50,
+            medium: 300,
+            low: 505,
+          )
+          expect(described_class.high).to eq 50
+          expect(described_class.medium).to eq 300
+          expect(described_class.low).to eq 505
+        end
+      end
     end
   end
 
@@ -110,6 +155,36 @@ RSpec.describe Delayed::Priority do
     expect(described_class.new(-123).interactive?).to eq false
   end
 
+  context 'when assign_at_midpoint is set to true' do
+    let(:assign_at_midpoint) { true }
+
+    it 'provides the name of the priority range' do
+      expect(described_class.new(0).name).to eq :interactive
+      expect(described_class.new(3).name).to eq :interactive
+      expect(described_class.new(10).name).to eq :user_visible
+      expect(described_class.new(29).name).to eq :eventual
+      expect(described_class.new(999).name).to eq :reporting
+      expect(described_class.new(-123).name).to eq nil
+    end
+
+    it 'supports initialization by symbol value' do
+      expect(described_class.new(:interactive)).to eq(5)
+      expect(described_class.new(:user_visible)).to eq(15)
+      expect(described_class.new(:eventual)).to eq(25)
+      expect(described_class.new(:reporting)).to eq(35)
+    end
+
+    it "supports predicate ('?') methods" do
+      expect(described_class.new(0).interactive?).to eq true
+      expect(described_class.new(3)).to be_interactive
+      expect(described_class.new(3).user_visible?).to eq false
+      expect(described_class.new(10)).to be_user_visible
+      expect(described_class.new(29)).to be_eventual
+      expect(described_class.new(999)).to be_reporting
+      expect(described_class.new(-123).interactive?).to eq false
+    end
+  end
+
   it 'supports alert threshold methods' do
     described_class.alerts = {
       interactive: { age: 77.seconds },
@@ -151,4 +226,13 @@ RSpec.describe Delayed::Priority do
       ].sort,
     ).to eq [-13, 3, 5, 40]
   end
+
+  it 'supports addition and subtraction' do
+    expect(described_class.new(0) + 10).to eq(10)
+    expect(10 + described_class.new(5)).to eq(15)
+    expect(described_class.new(0) + described_class.new(33)).to eq(33)
+    expect(described_class.new(10) - 5).to eq(5)
+    expect(15 - described_class.new(10)).to eq(5)
+    expect(described_class.new(5) - described_class.new(15)).to eq(-10)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: delayed
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.5
 platform: ruby
 authors:
 - Nathan Griffith
@@ -16,10 +16,10 @@ authors:
 - Matt Griffin
 - Steve Richert
 - Tobias Lütke
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-31 00:00:00.000000000 Z
+date: 2024-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -124,7 +124,7 @@ metadata:
   bug_tracker_uri: https://github.com/betterment/delayed/issues
   source_code_uri: https://github.com/betterment/delayed
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -139,30 +139,30 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: a multi-threaded, SQL-driven ActiveJob backend used at Betterment to process
   millions of background jobs per day
 test_files:
-- spec/sample_jobs.rb
-- spec/lifecycle_spec.rb
-- spec/performable_method_spec.rb
-- spec/helper.rb
-- spec/psych_ext_spec.rb
-- spec/worker_spec.rb
-- spec/autoloaded/struct.rb
 - spec/autoloaded/clazz.rb
 - spec/autoloaded/instance_clazz.rb
 - spec/autoloaded/instance_struct.rb
+- spec/autoloaded/struct.rb
 - spec/database.yml
-- spec/delayed/priority_spec.rb
-- spec/delayed/plugins/instrumentation_spec.rb
+- spec/delayed/active_job_adapter_spec.rb
+- spec/delayed/job_spec.rb
 - spec/delayed/monitor_spec.rb
+- spec/delayed/plugins/instrumentation_spec.rb
+- spec/delayed/priority_spec.rb
 - spec/delayed/serialization/active_record_spec.rb
 - spec/delayed/tasks_spec.rb
-- spec/delayed/job_spec.rb
-- spec/delayed/active_job_adapter_spec.rb
+- spec/helper.rb
+- spec/lifecycle_spec.rb
 - spec/message_sending_spec.rb
 - spec/performable_mailer_spec.rb
+- spec/performable_method_spec.rb
+- spec/psych_ext_spec.rb
+- spec/sample_jobs.rb
+- spec/worker_spec.rb
 - spec/yaml_ext_spec.rb