delayed_job_active_record 4.1.1 → 4.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3fd97d1444b2e5cbf2bfa22b304cde221619558d
-  data.tar.gz: 000b0e8eedbd1c0d2f470288d03f3349bf72f2d8
+SHA256:
+  metadata.gz: 1799d6d0f6301b5285da09c332bfe6abeb6cfb60b410a29e93f94a99aa0313b7
+  data.tar.gz: a1b0adfed07a2a7f47603390156688e193aed7bcc187184c9812b72e182fb859
 SHA512:
-  metadata.gz: 689515b8aa68f2395b5f5d3ab31f0b2fb8098bb8cdc8f3f93eb1cbcd93db84d6cb78db67e43e1b6fe93f999bd3a9d61aecf3138ec17a0bac6439c9600a387ec6
-  data.tar.gz: 2488595100525ad2b22c1112dd6a90e37507e47342e6fdb936d5ba465662dac49e0092b91d1a03bf6feb7facfaf1624161456ae682d1733943231b6c8848c14f
+  metadata.gz: c17b88c4d64f8698405c1cf9918b887baecbd2366d42a71d4d02879227d339aba4de0ba3419fc3a4cc0272b193769709efb86fd95f251a08afa4e9c00d07ac58
+  data.tar.gz: 9d8bc65f7e959d71264c8d46d2cff8c2409a975755be9c5a9f0387d033bf1054d76c20e56a0dd685f7556b9cde282dd7c76818f733c9ad9e28fc9e7cbaa67da1

data/README.md

@@ -1,15 +1,13 @@
 **If you're viewing this at https://github.com/collectiveidea/delayed_job_active_record,
 you're reading the documentation for the master branch.
 [View documentation for the latest release
-(4.1.0).](https://github.com/collectiveidea/delayed_job_active_record/tree/v4.1.0)**
+(4.1.5).](https://github.com/collectiveidea/delayed_job_active_record/tree/v4.1.5)**
 
 # DelayedJob ActiveRecord Backend
 
-[![Gem Version](https://badge.fury.io/rb/delayed_job_active_record.png)](https://rubygems.org/gems/delayed_job_active_record)
-[![Build Status](https://travis-ci.org/collectiveidea/delayed_job_active_record.png)](https://travis-ci.org/collectiveidea/delayed_job_active_record)
-[![Dependency Status](https://gemnasium.com/collectiveidea/delayed_job_active_record.png)](https://gemnasium.com/collectiveidea/delayed_job_active_record)
-[![Code Climate](https://codeclimate.com/github/collectiveidea/delayed_job_active_record.png)](https://codeclimate.com/github/collectiveidea/delayed_job_active_record)
-[![Coverage Status](https://coveralls.io/repos/collectiveidea/delayed_job_active_record/badge.png?branch=master)](https://coveralls.io/r/collectiveidea/delayed_job_active_record)
+[![Gem Version](https://img.shields.io/gem/v/delayed_job_active_record.svg)](https://rubygems.org/gems/delayed_job_active_record)
+![CI](https://github.com/collectiveidea/delayed_job_active_record/workflows/CI/badge.svg)
+[![Coverage Status](https://img.shields.io/coveralls/collectiveidea/delayed_job_active_record.svg)](https://coveralls.io/r/collectiveidea/delayed_job_active_record)
 
 ## Installation
 

data/delayed_job_active_record.gemspec

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 Gem::Specification.new do |spec|
-  spec.add_dependency "activerecord", [">= 3.0", "< 5.1"]
+  spec.add_dependency "activerecord", [">= 3.0", "< 6.2"]
   spec.add_dependency "delayed_job",  [">= 3.0", "< 5"]
   spec.authors        = ["Brian Ryckbost", "Matt Griffin", "Erik Michaels-Ober"]
   spec.description    = "ActiveRecord backend for Delayed::Job, originally authored by Tobias Lütke"
   spec.email          = ["bryckbost@gmail.com", "matt@griffinonline.org", "sferik@gmail.com"]
-  spec.files          = %w(CONTRIBUTING.md LICENSE.md README.md delayed_job_active_record.gemspec) + Dir["lib/**/*.rb"]
+  spec.files          = %w[CONTRIBUTING.md LICENSE.md README.md delayed_job_active_record.gemspec] + Dir["lib/**/*.rb"]
   spec.homepage       = "http://github.com/collectiveidea/delayed_job_active_record"
   spec.licenses       = ["MIT"]
   spec.name           = "delayed_job_active_record"
   spec.require_paths  = ["lib"]
   spec.summary        = "ActiveRecord backend for DelayedJob"
-  spec.version        = "4.1.1"
+  spec.version        = "4.1.5"
 end

data/lib/delayed/backend/active_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_record/version"
 module Delayed
   module Backend
@@ -10,7 +12,10 @@ module Delayed
         end
 
         def reserve_sql_strategy=(val)
-          raise ArgumentError, "allowed values are :optimized_sql or :default_sql" unless val == :optimized_sql || val == :default_sql
+          if !(val == :optimized_sql || val == :default_sql)
+            raise ArgumentError, "allowed values are :optimized_sql or :default_sql"
+          end
+
           @reserve_sql_strategy = val
         end
       end
@@ -34,6 +39,9 @@ module Delayed
         end
 
         scope :by_priority, lambda { order("priority ASC, run_at ASC") }
+        scope :min_priority, lambda { where("priority >= ?", Worker.min_priority) if Worker.min_priority }
+        scope :max_priority, lambda { where("priority <= ?", Worker.max_priority) if Worker.max_priority }
+        scope :for_queues, lambda { |queues = Worker.queues| where(queue: queues) if Array(queues).any? }
 
         before_save :set_default_run_at
 
@@ -45,7 +53,12 @@ module Delayed
         set_delayed_job_table_name
 
         def self.ready_to_run(worker_name, max_run_time)
-          where("(run_at <= ? AND (locked_at IS NULL OR locked_at < ?) OR locked_by = ?) AND failed_at IS NULL", db_time_now, db_time_now - max_run_time, worker_name)
+          where(
+            "((run_at <= ? AND (locked_at IS NULL OR locked_at < ?)) OR locked_by = ?) AND failed_at IS NULL",
+            db_time_now,
+            db_time_now - max_run_time,
+            worker_name
+          )
         end
 
         def self.before_fork
@@ -61,15 +74,13 @@ module Delayed
           where(locked_by: worker_name).update_all(locked_by: nil, locked_at: nil)
         end
 
-        def self.reserve(worker, max_run_time = Worker.max_run_time) # rubocop:disable CyclomaticComplexity
-          # scope to filter to records that are "ready to run"
-          ready_scope = ready_to_run(worker.name, max_run_time)
-
-          # scope to filter to the single next eligible job
-          ready_scope = ready_scope.where("priority >= ?", Worker.min_priority) if Worker.min_priority
-          ready_scope = ready_scope.where("priority <= ?", Worker.max_priority) if Worker.max_priority
-          ready_scope = ready_scope.where(queue: Worker.queues) if Worker.queues.any?
-          ready_scope = ready_scope.by_priority
+        def self.reserve(worker, max_run_time = Worker.max_run_time)
+          ready_scope =
+            ready_to_run(worker.name, max_run_time)
+            .min_priority
+            .max_priority
+            .for_queues
+            .by_priority
 
           reserve_with_scope(ready_scope, worker, db_time_now)
         end
@@ -88,41 +99,12 @@ module Delayed
 
         def self.reserve_with_scope_using_optimized_sql(ready_scope, worker, now)
           case connection.adapter_name
-          when "PostgreSQL"
-            # Custom SQL required for PostgreSQL because postgres does not support UPDATE...LIMIT
-            # This locks the single record 'FOR UPDATE' in the subquery
-            # http://www.postgresql.org/docs/9.0/static/sql-select.html#SQL-FOR-UPDATE-SHARE
-            # Note: active_record would attempt to generate UPDATE...LIMIT like
-            # SQL for Postgres if we use a .limit() filter, but it would not
-            # use 'FOR UPDATE' and we would have many locking conflicts
-            quoted_table_name = connection.quote_table_name(table_name)
-            subquery_sql      = ready_scope.limit(1).lock(true).select("id").to_sql
-            reserved          = find_by_sql(["UPDATE #{quoted_table_name} SET locked_at = ?, locked_by = ? WHERE id IN (#{subquery_sql}) RETURNING *", now, worker.name])
-            reserved[0]
+          when "PostgreSQL", "PostGIS"
+            reserve_with_scope_using_optimized_postgres(ready_scope, worker, now)
           when "MySQL", "Mysql2"
-            # Removing the millisecond precision from now(time object)
-            # MySQL 5.6.4 onwards millisecond precision exists, but the
-            # datetime object created doesn't have precision, so discarded
-            # while updating. But during the where clause, for mysql(>=5.6.4),
-            # it queries with precision as well. So removing the precision
-            now = now.change(usec: 0)
-            # This works on MySQL and possibly some other DBs that support
-            # UPDATE...LIMIT. It uses separate queries to lock and return the job
-            count = ready_scope.limit(1).update_all(locked_at: now, locked_by: worker.name)
-            return nil if count == 0
-            where(locked_at: now, locked_by: worker.name, failed_at: nil).first
+            reserve_with_scope_using_optimized_mysql(ready_scope, worker, now)
           when "MSSQL", "Teradata"
-            # The MSSQL driver doesn't generate a limit clause when update_all
-            # is called directly
-            subsubquery_sql = ready_scope.limit(1).to_sql
-            # select("id") doesn't generate a subquery, so force a subquery
-            subquery_sql = "SELECT id FROM (#{subsubquery_sql}) AS x"
-            quoted_table_name = connection.quote_table_name(table_name)
-            sql = ["UPDATE #{quoted_table_name} SET locked_at = ?, locked_by = ? WHERE id IN (#{subquery_sql})", now, worker.name]
-            count = connection.execute(sanitize_sql(sql))
-            return nil if count == 0
-            # MSSQL JDBC doesn't support OUTPUT INSERTED.* for returning a result set, so query locked row
-            where(locked_at: now, locked_by: worker.name, failed_at: nil).first
+            reserve_with_scope_using_optimized_mssql(ready_scope, worker, now)
           # Fallback for unknown / other DBMS
           else
             reserve_with_scope_using_default_sql(ready_scope, worker, now)
@@ -130,13 +112,60 @@ module Delayed
         end
 
         def self.reserve_with_scope_using_default_sql(ready_scope, worker, now)
-          # This is our old fashion, tried and true, but slower lookup
-          ready_scope.limit(worker.read_ahead).detect do |job|
+          # This is our old fashion, tried and true, but possibly slower lookup
+          # Instead of reading the entire job record for our detect loop, we select only the id,
+          # and only read the full job record after we've successfully locked the job.
+          # This can have a noticable impact on large read_ahead configurations and large payload jobs.
+          ready_scope.limit(worker.read_ahead).select(:id).detect do |job|
             count = ready_scope.where(id: job.id).update_all(locked_at: now, locked_by: worker.name)
             count == 1 && job.reload
           end
         end
 
+        def self.reserve_with_scope_using_optimized_postgres(ready_scope, worker, now)
+          # Custom SQL required for PostgreSQL because postgres does not support UPDATE...LIMIT
+          # This locks the single record 'FOR UPDATE' in the subquery
+          # http://www.postgresql.org/docs/9.0/static/sql-select.html#SQL-FOR-UPDATE-SHARE
+          # Note: active_record would attempt to generate UPDATE...LIMIT like
+          # SQL for Postgres if we use a .limit() filter, but it would not
+          # use 'FOR UPDATE' and we would have many locking conflicts
+          quoted_name = connection.quote_table_name(table_name)
+          subquery    = ready_scope.limit(1).lock(true).select("id").to_sql
+          sql         = "UPDATE #{quoted_name} SET locked_at = ?, locked_by = ? WHERE id IN (#{subquery}) RETURNING *"
+          reserved    = find_by_sql([sql, now, worker.name])
+          reserved[0]
+        end
+
+        def self.reserve_with_scope_using_optimized_mysql(ready_scope, worker, now)
+          # Removing the millisecond precision from now(time object)
+          # MySQL 5.6.4 onwards millisecond precision exists, but the
+          # datetime object created doesn't have precision, so discarded
+          # while updating. But during the where clause, for mysql(>=5.6.4),
+          # it queries with precision as well. So removing the precision
+          now = now.change(usec: 0)
+          # This works on MySQL and possibly some other DBs that support
+          # UPDATE...LIMIT. It uses separate queries to lock and return the job
+          count = ready_scope.limit(1).update_all(locked_at: now, locked_by: worker.name)
+          return nil if count == 0
+
+          where(locked_at: now, locked_by: worker.name, failed_at: nil).first
+        end
+
+        def self.reserve_with_scope_using_optimized_mssql(ready_scope, worker, now)
+          # The MSSQL driver doesn't generate a limit clause when update_all
+          # is called directly
+          subsubquery_sql = ready_scope.limit(1).to_sql
+          # select("id") doesn't generate a subquery, so force a subquery
+          subquery_sql = "SELECT id FROM (#{subsubquery_sql}) AS x"
+          quoted_table_name = connection.quote_table_name(table_name)
+          sql = "UPDATE #{quoted_table_name} SET locked_at = ?, locked_by = ? WHERE id IN (#{subquery_sql})"
+          count = connection.execute(sanitize_sql([sql, now, worker.name]))
+          return nil if count == 0
+
+          # MSSQL JDBC doesn't support OUTPUT INSERTED.* for returning a result set, so query locked row
+          where(locked_at: now, locked_by: worker.name, failed_at: nil).first
+        end
+
         # Get the current time (GMT or local depending on DB)
         # Note: This does not ping the DB to get the time, so all your clients
         # must have syncronized clocks.
@@ -146,7 +175,7 @@ module Delayed
           elsif ::ActiveRecord::Base.default_timezone == :utc
             Time.now.utc
           else
-            Time.now
+            Time.now # rubocop:disable Rails/TimeZone
           end
         end
 

data/lib/delayed/backend/active_record/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Delayed
+  module Backend
+    module ActiveRecord
+      class Railtie < ::Rails::Railtie
+        config.after_initialize do
+          require "delayed/backend/active_record"
+          Delayed::Worker.backend = :active_record
+        end
+      end
+    end
+  end
+end

data/lib/delayed_job_active_record.rb

@@ -1,5 +1,12 @@
-require "active_record"
+# frozen_string_literal: true
+
 require "delayed_job"
-require "delayed/backend/active_record"
 
-Delayed::Worker.backend = :active_record
+if defined?(Rails::Railtie)
+  require "delayed/backend/active_record/railtie"
+else
+  require "active_record"
+  require "delayed/backend/active_record"
+
+  Delayed::Worker.backend = :active_record
+end

data/lib/generators/delayed_job/active_record_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "generators/delayed_job/delayed_job_generator"
 require "generators/delayed_job/next_migration_version"
 require "rails/generators/migration"
@@ -12,11 +14,17 @@ module DelayedJob
     source_paths << File.join(File.dirname(__FILE__), "templates")
 
     def create_migration_file
-      migration_template "migration.rb", "db/migrate/create_delayed_jobs.rb"
+      migration_template "migration.rb", "db/migrate/create_delayed_jobs.rb", migration_version: migration_version
     end
 
     def self.next_migration_number(dirname)
       ActiveRecord::Generators::Base.next_migration_number dirname
     end
+
+    private
+
+    def migration_version
+      "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]" if ActiveRecord::VERSION::MAJOR >= 5
+    end
   end
 end

data/lib/generators/delayed_job/next_migration_version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DelayedJob
   module NextMigrationVersion
     # while methods have moved around this has been the implementation

data/lib/generators/delayed_job/templates/migration.rb

@@ -1,6 +1,6 @@
-class CreateDelayedJobs < ActiveRecord::Migration
+class CreateDelayedJobs < ActiveRecord::Migration<%= migration_version %>
   def self.up
-    create_table :delayed_jobs, force: true do |table|
+    create_table :delayed_jobs do |table|
       table.integer :priority, default: 0, null: false # Allows some jobs to jump to the front of the queue
       table.integer :attempts, default: 0, null: false # Provides for retries, but still fail eventually.
       table.text :handler,                 null: false # YAML-encoded string of the object that will do work

data/lib/generators/delayed_job/templates/upgrade_migration.rb

@@ -1,4 +1,4 @@
-class AddQueueToDelayedJobs < ActiveRecord::Migration
+class AddQueueToDelayedJobs < ActiveRecord::Migration<%= migration_version %>
   def self.up
     add_column :delayed_jobs, :queue, :string
   end

data/lib/generators/delayed_job/upgrade_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "generators/delayed_job/delayed_job_generator"
 require "generators/delayed_job/next_migration_version"
 require "rails/generators/migration"
@@ -5,18 +7,13 @@ require "rails/generators/active_record"
 
 # Extend the DelayedJobGenerator so that it creates an AR migration
 module DelayedJob
-  class UpgradeGenerator < ::DelayedJobGenerator
-    include Rails::Generators::Migration
-    extend NextMigrationVersion
-
-    source_paths << File.join(File.dirname(__FILE__), "templates")
-
+  class UpgradeGenerator < ActiveRecordGenerator
     def create_migration_file
-      migration_template "upgrade_migration.rb", "db/migrate/add_queue_to_delayed_jobs.rb"
-    end
-
-    def self.next_migration_number(dirname)
-      ActiveRecord::Generators::Base.next_migration_number dirname
+      migration_template(
+        "upgrade_migration.rb",
+        "db/migrate/add_queue_to_delayed_jobs.rb",
+        migration_version: migration_version
+      )
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: delayed_job_active_record
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 4.1.5
 platform: ruby
 authors:
 - Brian Ryckbost
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-16 00:00:00.000000000 Z
+date: 2020-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -21,7 +21,7 @@ dependencies:
         version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -31,7 +31,7 @@ dependencies:
         version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: delayed_job
   requirement: !ruby/object:Gem::Requirement
@@ -67,6 +67,7 @@ files:
 - README.md
 - delayed_job_active_record.gemspec
 - lib/delayed/backend/active_record.rb
+- lib/delayed/backend/active_record/railtie.rb
 - lib/delayed_job_active_record.rb
 - lib/generators/delayed_job/active_record_generator.rb
 - lib/generators/delayed_job/next_migration_version.rb
@@ -92,8 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: ActiveRecord backend for DelayedJob