good_job 3.19.2 → 3.19.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec598c88f135d5ebf9ec8fd1275e633cb26ec203287236bae56f5d143ff2b8fe
-  data.tar.gz: 2648b15cb11ac4996cb6637126507ba1a7ab37fe652759f7379ae2b6ffa66481
+  metadata.gz: 7b2fd15bbee1a5d3cbe17a0154fa15fdd960c9b5fc39a55b60831792095538e0
+  data.tar.gz: 831a78bc9a7e569fb72601f817bb4397b702ad89dc4f1e5776b3c8fc28ab042e
 SHA512:
-  metadata.gz: f6fc1208753c103a7a9edc06533cd778f4c4a7232e1965897795d7f82d063f41afb75424dff0d43ba30896f6ae579c324350da6c15b2785118ddbabd275b7e5d
-  data.tar.gz: d71c68f923c1640e639e38e17bc23f9cb31c85ab1efbd629012cc8454b65c7eb73618a67f556a5164b070cc48ae8945ea9b05bb9ea7615554aeab2dd0ed2020d
+  metadata.gz: c598627e0a4999e7faef09edb7c286344019a4c20fb7cf952bf0026a2247aa1f4aef4f9e9530e8cc105ec502cbf258f41f58ad5a1ec62ce7e2453f8dd4f0f92c
+  data.tar.gz: 40dfbac0623a460c22f55889cd80bccc77a7391c3c05b42692267424c136af3224d20d042735906dca506540a699a5f7a592d8eda16ff79255089fc15b390829

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## [v3.19.4](https://github.com/bensheldon/good_job/tree/v3.19.4) (2023-10-04)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v3.19.3...v3.19.4)
+
+**Closed issues:**
+
+- Including GoodJob::ActiveJobExtensions::Concurrency triggers rails deprecation notice [\#1096](https://github.com/bensheldon/good_job/issues/1096)
+- Add retries exhaused callback [\#1080](https://github.com/bensheldon/good_job/issues/1080)
+
+**Merged pull requests:**
+
+- Address rails 7.1 deprecation when using `ActiveJobExtensions::Concurrency` [\#1097](https://github.com/bensheldon/good_job/pull/1097) ([Earlopain](https://github.com/Earlopain))
+
+## [v3.19.3](https://github.com/bensheldon/good_job/tree/v3.19.3) (2023-09-28)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v3.19.2...v3.19.3)
+
+**Closed issues:**
+
+- Explicitly write that jobs with higher priority jobs run first \(unlike Que or DelayedJob\) at readme. [\#991](https://github.com/bensheldon/good_job/issues/991)
+
+**Merged pull requests:**
+
+- Correct `discrete_execution#status` method [\#1092](https://github.com/bensheldon/good_job/pull/1092) ([coreyaus](https://github.com/coreyaus))
+- Use ActiveSupport::BroadcastLogger [\#1089](https://github.com/bensheldon/good_job/pull/1089) ([bensheldon](https://github.com/bensheldon))
+- Log thread name for gem development debugging [\#1085](https://github.com/bensheldon/good_job/pull/1085) ([bensheldon](https://github.com/bensheldon))
+- Describe ApplicationController hook in README [\#1082](https://github.com/bensheldon/good_job/pull/1082) ([maxim](https://github.com/maxim))
+- \[Docs\] Explain how `priority` works in GoodJob [\#1005](https://github.com/bensheldon/good_job/pull/1005) ([coreyaus](https://github.com/coreyaus))
+
 ## [v3.19.2](https://github.com/bensheldon/good_job/tree/v3.19.2) (2023-09-22)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v3.19.1...v3.19.2)
@@ -1044,7 +1073,7 @@
 
 - Add cron\_enabled attribute to good\_job and pass it to process current state [\#675](https://github.com/bensheldon/good_job/pull/675) ([saksham-jain](https://github.com/saksham-jain))
 - Reverse Dashboard Filter Hierarchy to be: queues+jobs then state [\#666](https://github.com/bensheldon/good_job/pull/666) ([bensheldon](https://github.com/bensheldon))
-- Allow cron entries to be temporarily disabled and re-enabled through the Dashboard [\#649](https://github.com/bensheldon/good_job/pull/649) ([alex-klepa](https://github.com/alex-klepa))
+- Allow cron entries to be temporarily disabled and re-enabled through the Dashboard [\#649](https://github.com/bensheldon/good_job/pull/649) ([sasha-id](https://github.com/sasha-id))
 - Add Configuration.total\_estimated\_threads to report number of threads consumed by GoodJob [\#645](https://github.com/bensheldon/good_job/pull/645) ([bensheldon](https://github.com/bensheldon))
 
 **Closed issues:**

data/README.md

@@ -40,7 +40,8 @@ For more of the story of GoodJob, read the [introductory blog post](https://isla
     - [Global options](#global-options)
     - [Dashboard](#dashboard)
         - [API-only Rails applications](#api-only-rails-applications)
-        - [Live Polling](#live-polling)
+        - [Live polling](#live-polling)
+    - [Job priority](#job-priority)
     - [Concurrency controls](#concurrency-controls)
         - [How concurrency controls work](#how-concurrency-controls-work)
     - [Cron-style repeating/recurring jobs](#cron-style-repeatingrecurring-jobs)
@@ -290,6 +291,7 @@ Available configuration options are:
 - `inline_execution_respects_schedule` (boolean) Opt-in to future behavior of inline execution respecting scheduled jobs. Defaults to `false`.
 - `logger` ([Rails Logger](https://api.rubyonrails.org/classes/ActiveSupport/Logger.html)) lets you set a custom logger for GoodJob. It should be an instance of a Rails `Logger` (Default: `Rails.logger`).
 - `preserve_job_records` (boolean) keeps job records in your database even after jobs are completed. (Default: `true`)
+- `smaller_number_is_higher_priority` (boolean) allows you to specifiy that jobs should be run in ascending order of priority (smallest priority numbers first). This will be enabled by default in the next major version of GoodJob (v4.0), but jobs with the highest priority number are run first by default in all earlier versions of GoodJob.
 - `retry_on_unhandled_error` (boolean) causes jobs to be re-queued and retried if they raise an instance of `StandardError`. Be advised this may lead to jobs being repeated infinitely ([see below for more on retries](#retries)). Instances of `Exception`, like SIGINT, will *always* be retried, regardless of this attribute’s value. (Default: `false`)
 - `on_thread_error` (proc, lambda, or callable) will be called when there is an Exception. It can be useful for logging errors to bug tracking services, like Sentry or Airbrake. Example:
 
@@ -380,6 +382,24 @@ GoodJob includes a Dashboard as a mountable `Rails::Engine`.
     end
     ```
 
+    To support custom authentication, you can extend GoodJob's `ApplicationController` using the following hook:
+
+    ```ruby
+    # config/initializers/good_job.rb
+
+    ActiveSupport.on_load(:good_job_application_controller) do
+      # context here is GoodJob::ApplicationController
+
+      before_action do
+        raise ActionController::RoutingError.new('Not Found') unless current_user&.admin?
+      end
+
+      def current_user
+        # load current user
+      end
+    end
+    ```
+
 _To view finished jobs (succeeded and discarded) on the Dashboard, GoodJob must be configured to preserve job records. Preservation is enabled by default._
 
 **Troubleshooting the Dashboard:** Some applications are unable to autoload the Goodjob Engine. To work around this, explicitly require the Engine at the top of your `config/application.rb` file, immediately after Rails is required and before Bundler requires the Rails' groups.
@@ -409,10 +429,14 @@ module MyApp
 end
 ```
 
-#### Live Polling
+#### Live polling
 
 The Dashboard can be set to automatically refresh by checking "Live Poll" in the Dashboard header, or by setting `?poll=10` with the interval in seconds (default 30 seconds).
 
+### Job priority
+
+Higher priority numbers run first in all versions of GoodJob v3.x and below. GoodJob v4.x will change job `priority` to give smaller numbers higher priority (default: `0`), in accordance with Active Job's definition of priority (see #524). To opt-in to this behavior now, set `config.good_job.smaller_number_is_higher_priority = true` in your GoodJob initializer or `application.rb`.
+
 ### Concurrency controls
 
 GoodJob can extend ActiveJob to provide limits on concurrently running jobs, either at time of _enqueue_ or at _perform_. Limiting concurrency can help prevent duplicate, double or unnecessary jobs from being enqueued, or race conditions when performing, for example when interacting with 3rd-party APIs.
@@ -792,7 +816,7 @@ GoodJob.on_thread_error = -> (exception) { Rails.error.report(exception) }
 
 By default, GoodJob relies on ActiveJob's retry functionality.
 
-ActiveJob can be configured to retry an infinite number of times, with an exponential backoff. Using ActiveJob's `retry_on` prevents exceptions from reaching GoodJob:
+ActiveJob can be configured to retry an infinite number of times, with a polynomial backoff. Using ActiveJob's `retry_on` prevents exceptions from reaching GoodJob:
 
 ```ruby
 class ApplicationJob < ActiveJob::Base

data/app/models/good_job/discrete_execution.rb

@@ -40,10 +40,10 @@ module GoodJob # :nodoc:
 
     def status
       if finished_at.present?
-        if error.present?
-          :retried
-        elsif error.present? && job.finished_at.present?
+        if error.present? && job.finished_at.present?
           :discarded
+        elsif error.present?
+          :retried
         else
           :succeeded
         end

data/lib/good_job/active_job_extensions/concurrency.rb

@@ -36,10 +36,16 @@ module GoodJob
           end
         end
 
+        wait_key = if ActiveJob.gem_version >= Gem::Version.new("7.1.0.a")
+                     :polynomially_longer
+                   else
+                     :exponentially_longer
+                   end
+
         retry_on(
           GoodJob::ActiveJobExtensions::Concurrency::ConcurrencyExceededError,
           attempts: Float::INFINITY,
-          wait: :exponentially_longer
+          wait: wait_key
         )
 
         before_perform do |job|

data/lib/good_job/log_subscriber.rb

@@ -208,13 +208,15 @@ module GoodJob
       # each of the loggers in {LogSubscriber.loggers}.
       # @return [Logger]
       def logger
-        @_logger ||= begin
-          logger = Logger.new(StringIO.new)
-          loggers.each do |each_logger|
-            logger.extend(ActiveSupport::Logger.broadcast(each_logger))
-          end
-          logger
-        end
+        @_logger ||= if defined?(ActiveSupport::BroadcastLogger)
+                       ActiveSupport::BroadcastLogger.new(*loggers)
+                     else
+                       logger = Logger.new(StringIO.new)
+                       loggers.each do |each_logger|
+                         logger.extend(ActiveSupport::Logger.broadcast(each_logger))
+                       end
+                       logger
+                     end
       end
 
       # Reset {LogSubscriber.logger} and force it to rebuild a new shortcut to

data/lib/good_job/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 3.19.2
+  version: 3.19.4
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-22 00:00:00.000000000 Z
+date: 2023-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob