good_job 4.9.0 → 4.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e647f9e6432f6972951bdf902f2de80d9cc0001ee37c9bb355fedbfaae2c0dd6
-  data.tar.gz: 432488ed94165af462f1702aa08cdf26b771fa2815ba5f345d7acc48fa040a42
+  metadata.gz: eebb74f90c823f1b2dd3dbeeecffc6279b072d5929182c7734357ce98ebd3a1a
+  data.tar.gz: f0df3c322938cb34d9a5686a344db8e412a2878473ff778928006855ab8339a1
 SHA512:
-  metadata.gz: 68824597423a7149136168819e25d75f2ae427a574188352a793a0e8405eda879e032c4cfde00decab70e509c353dd3ea89752619099d1f4ddc80771ef3a7035
-  data.tar.gz: 90c3b1c09665ca5c2cbb3dcda3067949e69e02edb68dfea4ffb42c3a128a9603bde4ffb8ee9082fddab98651b9eea0c7096af71f5653c9af1588df7377e05d6b
+  metadata.gz: a91aae2a4768af8c89c8b0e2b04898d70dbe145b8808f2e1cc60fd18dd63faafd3679ca7444abd9e6863b7991b778ee709ba8949ac791362ff850c7aca3dcb5c
+  data.tar.gz: e3df10dbd134f6e335938578c0050e838d2b0073a6a3d7f64a90313e70afd214e76307df146be840dc8fecfcfca32bcb4ea9671f7549573c2e0e32adb8006a7a

data/CHANGELOG.md

@@ -1,5 +1,35 @@
 # Changelog
 
+## [v4.9.2](https://github.com/bensheldon/good_job/tree/v4.9.2) (2025-03-09)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v4.9.1...v4.9.2)
+
+**Fixed bugs:**
+
+- Quiet duplicate cron enqueue logging by pretending it was halted at before\_enqueue [\#1615](https://github.com/bensheldon/good_job/pull/1615) ([bensheldon](https://github.com/bensheldon))
+
+## [v4.9.1](https://github.com/bensheldon/good_job/tree/v4.9.1) (2025-03-09)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v4.9.0...v4.9.1)
+
+**Implemented enhancements:**
+
+- Order Dashboard jobs in more "natural" order [\#1604](https://github.com/bensheldon/good_job/pull/1604) ([francois](https://github.com/francois))
+
+**Fixed bugs:**
+
+- \[dashboard\] Scheduled tasks are shown "backwards" [\#1580](https://github.com/bensheldon/good_job/issues/1580)
+- Update `form_with` calls to be compatible with Rails 8 [\#1610](https://github.com/bensheldon/good_job/pull/1610) ([sallyhall](https://github.com/sallyhall))
+- Add index on good\_jobs: \[:concurrency\_key, :created\_at\] to improve performance of throttling \(\#1603\) [\#1605](https://github.com/bensheldon/good_job/pull/1605) ([Intrepidd](https://github.com/Intrepidd))
+
+**Closed issues:**
+
+- Cron did not enqueue jobs [\#1600](https://github.com/bensheldon/good_job/issues/1600)
+- Same job performed by all threads [\#1599](https://github.com/bensheldon/good_job/issues/1599)
+- Option for bin/rails g good\_job:install to purge Solid gems [\#1593](https://github.com/bensheldon/good_job/issues/1593)
+- Jobs are not being picked up at the expected rate [\#1578](https://github.com/bensheldon/good_job/issues/1578)
+- Question about GoodJob Batches in tests [\#1479](https://github.com/bensheldon/good_job/issues/1479)
+
 ## [v4.9.0](https://github.com/bensheldon/good_job/tree/v4.9.0) (2025-02-07)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v4.8.2...v4.9.0)

data/README.md

@@ -1032,7 +1032,7 @@ To detect the start of a graceful shutdown from within a performing job, for exa
 ```ruby
 def perform(lots_of_records)
   lots_of_records.each do |record|
-    break if GoodJob.current_thread_shutting_down? # or `unless GoodJob.current_thread.running?`
+    break if GoodJob.current_thread_shutting_down? # or `unless GoodJob.current_thread_running?`
     # process record ...
   end
 end

data/app/filters/good_job/base_filter.rb

@@ -13,12 +13,15 @@ module GoodJob
     end
 
     def records
-      after_scheduled_at = params[:after_scheduled_at].present? ? Time.zone.parse(params[:after_scheduled_at]) : nil
+      after_at = params[:after_at].present? ? Time.zone.parse(params[:after_at]) : nil
+      after_id = params[:after_id] if after_at
+      limit = params.fetch(:limit, DEFAULT_LIMIT)
 
       query_for_records.display_all(
-        after_scheduled_at: after_scheduled_at,
-        after_id: params[:after_id]
-      ).limit(params.fetch(:limit, DEFAULT_LIMIT))
+        ordered_by: ordered_by,
+        after_at: after_at,
+        after_id: after_id
+      ).limit(limit)
     end
 
     def last
@@ -66,6 +69,19 @@ module GoodJob
       filtered_query.count
     end
 
+    def ordered_by
+      %w[created_at desc]
+    end
+
+    def next_page_params
+      order_column = ordered_by.first
+
+      {
+        after_at: records.last&.send(order_column),
+        after_id: records.last&.id,
+      }.merge(to_params)
+    end
+
     private
 
     def query_for_records

data/app/filters/good_job/batches_filter.rb

@@ -2,19 +2,14 @@
 
 module GoodJob
   class BatchesFilter < BaseFilter
-    def records
-      after_created_at = params[:after_created_at].present? ? Time.zone.parse(params[:after_created_at]) : nil
-
-      filtered_query.display_all(
-        after_created_at: after_created_at,
-        after_id: params[:after_id]
-      ).limit(params.fetch(:limit, DEFAULT_LIMIT))
-    end
-
     def filtered_query(_filtered_params = params)
       base_query
     end
 
+    def query_for_records
+      default_base_query
+    end
+
     def default_base_query
       GoodJob::BatchRecord.includes(:jobs)
     end

data/app/filters/good_job/jobs_filter.rb

@@ -53,6 +53,19 @@ module GoodJob
       @_filtered_count ||= filtered_query.unscope(:select).count
     end
 
+    def ordered_by
+      case params[:state]
+      when "scheduled", "retried", "pending", "queued"
+        %w[scheduled_at asc]
+      when "running"
+        %w[performed_at desc]
+      when "finished", "discarded"
+        %w[finished_at desc]
+      else
+        %w[created_at desc]
+      end
+    end
+
     private
 
     def query_for_records

data/app/models/concerns/good_job/filterable.rb

@@ -7,21 +7,27 @@ module GoodJob
 
     included do
       # Get records in display order with optional keyset pagination.
-      # @!method display_all(after_scheduled_at: nil, after_id: nil)
+      # @!method display_all(ordered_by: ["created_at", "desc"], after_at: nil, after_id: nil)
       # @!scope class
-      # @param after_scheduled_at [DateTime, String, nil]
-      #   Display records scheduled after this time for keyset pagination
+      # @param ordered_by [Array<String>]
+      #   Order to display records, from Filter#ordered_by
+      # @param after_at [DateTime, String, nil]
+      #   Display records after this time for keyset pagination
       # @param after_id [Numeric, String, nil]
       #   Display records after this ID for keyset pagination
       # @return [ActiveRecord::Relation]
-      scope :display_all, (lambda do |after_scheduled_at: nil, after_id: nil|
-        query = order(Arel.sql('scheduled_at DESC, id DESC'))
-        if after_scheduled_at.present? && after_id.present?
-          query = query.where Arel::Nodes::Grouping.new([arel_table["scheduled_at"], arel_table["id"]]).lt(Arel::Nodes::Grouping.new([bind_value('scheduled_at', after_scheduled_at, ActiveRecord::Type::DateTime), bind_value('id', after_id, ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Uuid)]))
-        elsif after_scheduled_at.present?
-          query = query.where arel_table["scheduled_at"].lt(bind_value('scheduled_at', after_scheduled_at, ActiveRecord::Type::DateTime))
+      scope :display_all, (lambda do |ordered_by: %w[created_at desc], after_at: nil, after_id: nil|
+        order_column, order_direction = ordered_by
+        query = self
+
+        if after_at.present? && after_id.present?
+          query = query.where Arel::Nodes::Grouping.new([arel_table[order_column], arel_table[primary_key]]).send(
+            order_direction == 'asc' ? :gteq : :lt,
+            Arel::Nodes::Grouping.new([bind_value(order_column, after_at, ActiveRecord::Type::DateTime), bind_value(primary_key, after_id, ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Uuid)])
+          )
         end
-        query
+
+        query.order Arel.sql("#{order_column} #{order_direction}, #{primary_key} #{order_direction}")
       end)
 
       # Search records by text query.

data/app/models/good_job/batch_record.rb

@@ -5,6 +5,7 @@ require 'active_job/arguments'
 module GoodJob
   class BatchRecord < BaseRecord
     include AdvisoryLockable
+    include Filterable
 
     self.table_name = 'good_job_batches'
     self.implicit_order_column = 'created_at'
@@ -24,20 +25,6 @@ module GoodJob
     alias_attribute :discarded?, :discarded_at
     alias_attribute :finished?, :finished_at
 
-    scope :display_all, (lambda do |after_created_at: nil, after_id: nil|
-      query = order(created_at: :desc, id: :desc)
-      if after_created_at.present? && after_id.present?
-        query = if Gem::Version.new(Rails.version) < Gem::Version.new('7.0.0.a') || Concurrent.on_jruby?
-                  query.where(Arel.sql('(created_at, id) < (:after_created_at, :after_id)'), after_created_at: after_created_at, after_id: after_id)
-                else
-                  query.where Arel::Nodes::Grouping.new([arel_table["created_at"], arel_table["id"]]).lt(Arel::Nodes::Grouping.new([bind_value('created_at', after_created_at, ActiveRecord::Type::DateTime), bind_value('id', after_id, ActiveRecord::Type::String)]))
-                end
-      elsif after_created_at.present?
-        query = query.where arel_table["created_at"].lt(bind_value('created_at', after_created_at, ActiveRecord::Type::DateTime))
-      end
-      query
-    end)
-
     def self.jobs_finished_at_migrated?
       column_names.include?('jobs_finished_at')
     end

data/app/models/good_job/cron_entry.rb

@@ -110,8 +110,6 @@ module GoodJob # :nodoc:
           kwargs_value.present? ? configured_job.perform_later(*args_value, **kwargs_value) : configured_job.perform_later(*args_value)
         end
       end
-    rescue ActiveRecord::RecordNotUnique
-      false
     end
 
     def display_properties

data/app/models/good_job/job.rb

@@ -387,7 +387,16 @@ module GoodJob
         end
 
         instrument_payload[:job] = job
-        job.save!
+        begin
+          job.save!
+        rescue ActiveRecord::RecordNotUnique
+          raise unless job.cron_key
+
+          # Active Job doesn't have a clean way to cancel an enqueue for unexceptional reasons
+          # This is a workaround to mark it as having been halted in before_enqueue
+          active_job.send(:halted_callback_hook, "duplicate_cron_key", "good_job")
+          return false
+        end
 
         CurrentThread.retried_job = job if retried
 

data/app/views/good_job/batches/index.html.erb

@@ -7,7 +7,7 @@
   <nav aria-label="Batch pagination" class="mt-3">
     <ul class="pagination">
       <li class="page-item">
-        <%= link_to(@filter.to_params(after_created_at: @filter.last.created_at, after_id: @filter.last.id), class: "page-link") do %>
+        <%= link_to(@filter.next_page_params, class: "page-link") do %>
           <%= t ".older_batches" %> <span aria-hidden="true">&raquo;</span>
         <% end %>
       </li>

data/app/views/good_job/jobs/_table.erb

@@ -1,4 +1,4 @@
-<%= form_with(url: mass_update_jobs_path(filter.to_params), method: :put, local: true, data: { "checkbox-toggle": "job_ids" }) do |form| %>
+<%= form_with(model: false, url: mass_update_jobs_path(filter.to_params), method: :put, local: true, data: { "checkbox-toggle": "job_ids" }) do |form| %>
   <div class="my-3 card" data-gj-poll-replace id="jobs-table">
     <div class="list-group list-group-flush text-nowrap table-jobs" role="table">
       <header class="list-group-item bg-body-tertiary">

data/app/views/good_job/jobs/index.html.erb

@@ -7,7 +7,7 @@
     <nav aria-label="<%= t ".job_pagination" %>" class="mt-3">
       <ul class="pagination">
         <li class="page-item">
-          <%= link_to(@filter.to_params(after_scheduled_at: @filter.last.scheduled_at || @filter.last.created_at, after_id: @filter.last.id), class: "page-link") do %>
+          <%= link_to(@filter.next_page_params, class: "page-link") do %>
             <%= t ".older_jobs" %> <span aria-hidden="true">&raquo;</span>
           <% end %>
         </li>

data/app/views/good_job/shared/_filter.erb

@@ -4,7 +4,7 @@
       <h2 class="pt-3 pb-2"><%= title %></h2>
     </div>
 
-    <%= form_with(url: "", method: :get, local: true, id: "filter_form", class: "") do |form| %>
+    <%= form_with(model: false, url: "", method: :get, local: true, id: "filter_form", class: "") do |form| %>
       <%= hidden_field_tag :poll, params[:poll] %>
       <%= hidden_field_tag :state, params[:state] %>
       <%= hidden_field_tag :locale, params[:locale] if params[:locale] %>

data/lib/generators/good_job/templates/install/migrations/create_good_jobs.rb.erb

@@ -82,6 +82,7 @@ class CreateGoodJobs < ActiveRecord::Migration<%= migration_version %>
     add_index :good_jobs, [:queue_name, :scheduled_at], where: "(finished_at IS NULL)", name: :index_good_jobs_on_queue_name_and_scheduled_at
     add_index :good_jobs, [:active_job_id, :created_at], name: :index_good_jobs_on_active_job_id_and_created_at
     add_index :good_jobs, :concurrency_key, where: "(finished_at IS NULL)", name: :index_good_jobs_on_concurrency_key_when_unfinished
+    add_index :good_jobs, [:concurrency_key, :created_at], name: :index_good_jobs_on_concurrency_key_and_created_at
     add_index :good_jobs, [:cron_key, :created_at], where: "(cron_key IS NOT NULL)", name: :index_good_jobs_on_cron_key_and_created_at_cond
     add_index :good_jobs, [:cron_key, :cron_at], where: "(cron_key IS NOT NULL)", unique: true, name: :index_good_jobs_on_cron_key_and_cron_at_cond
     add_index :good_jobs, [:finished_at], where: "retried_good_job_id IS NULL AND finished_at IS NOT NULL", name: :index_good_jobs_jobs_on_finished_at

data/lib/generators/good_job/templates/update/migrations/03_add_index_good_jobs_concurrency_key_created_at.rb.erb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class AddIndexGoodJobsConcurrencyKeyCreatedAt < ActiveRecord::Migration<%= migration_version %>
+  disable_ddl_transaction!
+
+  def change
+    reversible do |dir|
+      dir.up do
+        # Ensure this incremental update migration is idempotent
+        # with monolithic install migration.
+        return if connection.index_exists? :good_jobs, [:concurrency_key, :created_at]
+      end
+    end
+
+    add_index :good_jobs, [:concurrency_key, :created_at], algorithm: :concurrently
+  end
+end

data/lib/good_job/adapter.rb

@@ -163,8 +163,10 @@ module GoodJob
             scheduled_at: scheduled_at
           )
 
-          executed_locally = execute_async? && @capsule&.create_thread(job.job_state)
-          Notifier.notify(job.job_state) if !executed_locally && send_notify?(active_job)
+          if job
+            executed_locally = execute_async? && @capsule&.create_thread(job.job_state)
+            Notifier.notify(job.job_state) if !executed_locally && send_notify?(active_job)
+          end
         end
 
         job

data/lib/good_job/version.rb

@@ -2,7 +2,7 @@
 
 module GoodJob
   # GoodJob gem version.
-  VERSION = '4.9.0'
+  VERSION = '4.9.2'
 
   # GoodJob version as Gem::Version object
   GEM_VERSION = Gem::Version.new(VERSION)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 4.9.0
+  version: 4.9.2
 platform: ruby
 authors:
 - Ben Sheldon
 bindir: exe
 cert_chain: []
-date: 2025-02-07 00:00:00.000000000 Z
+date: 2025-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -348,6 +348,7 @@ files:
 - lib/generators/good_job/templates/install/migrations/create_good_jobs.rb.erb
 - lib/generators/good_job/templates/update/migrations/01_create_good_jobs.rb.erb
 - lib/generators/good_job/templates/update/migrations/02_add_jobs_finished_at_to_good_job_batches.rb.erb
+- lib/generators/good_job/templates/update/migrations/03_add_index_good_jobs_concurrency_key_created_at.rb.erb
 - lib/generators/good_job/update_generator.rb
 - lib/good_job.rb
 - lib/good_job/active_job_extensions/batches.rb