good_job 2.15.0 → 2.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b978264b509be9bd83e1e5e67f291b2889deff86c8316f876ab9def8264a7dd0
-  data.tar.gz: 9b4172f97c1c7406d3c51ec81f926adaca801baa004aed743a8cac757bb2ce86
+  metadata.gz: 1811646b013e9432de87917a2be838ee634902b22ecc942bae74a7fefab82487
+  data.tar.gz: 14a301ce871b2761484d1c40d71dc76a64ce40131b6c4f3ff5573c1a2201ee58
 SHA512:
-  metadata.gz: a2696f821699ea080d2b77bb7704192222e6347d1b2be7fcf7a5e049d7b8979ceea3f5236c165fb27bb17fa5f9d8c7d2e5bb863b9c7298de9efb892facb6bca7
-  data.tar.gz: 0ab7a37d403e1bec9c0638835c903aff4a1168f33143c7c27acd87c07bf95a61c1475c3e61bea0a7590d167144761cc64b7bc81566746c854c2ae9698aa999fe
+  metadata.gz: f719e920a42b626b022ea6e90572344a660adf9fac9978fcde0ae98abbb0433d89a32af25f51e14a7250ffa2ffb128accc95fce9121630cc178b957f114e2fdf
+  data.tar.gz: 83265d3360d14d249303179d5ef506e39709ddf9fbbc87df99b42e5b6057d1e9acc0a59712e8b82f0d79df69b868a26b0f5de9ebf0e1adac2e421f0b1288b94f

data/CHANGELOG.md

@@ -1,11 +1,52 @@
 # Changelog
 
+## [v2.16.0](https://github.com/bensheldon/good_job/tree/v2.16.0) (2022-06-17)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v2.15.2...v2.16.0)
+
+**Closed issues:**
+
+- Upgrading zeitwerk to 2.6.0 causes a warning related to good\_job [\#616](https://github.com/bensheldon/good_job/issues/616)
+
+**Merged pull requests:**
+
+- Allow inline executor to respect scheduled jobs; deprecate old behavior. Add `GoodJob.perform_inline` [\#615](https://github.com/bensheldon/good_job/pull/615) ([bensheldon](https://github.com/bensheldon))
+
+## [v2.15.2](https://github.com/bensheldon/good_job/tree/v2.15.2) (2022-06-17)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v2.15.1...v2.15.2)
+
+**Closed issues:**
+
+- ActiveRecord::StatementInvalid PG::ProgramLimitExceeded:  ERROR: index row size 3296 exceeds btree version 4 maximum 2704 for index [\#612](https://github.com/bensheldon/good_job/issues/612)
+
+**Merged pull requests:**
+
+- Zeitwerk ignore `lib/active_job` [\#617](https://github.com/bensheldon/good_job/pull/617) ([bensheldon](https://github.com/bensheldon))
+
+## [v2.15.1](https://github.com/bensheldon/good_job/tree/v2.15.1) (2022-05-24)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v2.15.0...v2.15.1)
+
+**Closed issues:**
+
+- dashboard/engine – i18n: Wrong translation scope [\#605](https://github.com/bensheldon/good_job/issues/605)
+- Concurrency not properly putting jobs in the queue [\#603](https://github.com/bensheldon/good_job/issues/603)
+- Some dashboard actions have a routing error [\#602](https://github.com/bensheldon/good_job/issues/602)
+
+**Merged pull requests:**
+
+- Fix/i18n status scopes [\#607](https://github.com/bensheldon/good_job/pull/607) ([Jay-Schneider](https://github.com/Jay-Schneider))
+- Make "Live Polling" ToC entry clickable [\#606](https://github.com/bensheldon/good_job/pull/606) ([aried3r](https://github.com/aried3r))
+- Update readme explaining Concurrency implementation and how to integrate Dashboard with API-only Rails apps [\#604](https://github.com/bensheldon/good_job/pull/604) ([bensheldon](https://github.com/bensheldon))
+
 ## [v2.15.0](https://github.com/bensheldon/good_job/tree/v2.15.0) (2022-05-18)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v2.14.4...v2.15.0)
 
 **Implemented enhancements:**
 
+- Remove ability to destroy individual Executions from Dashboard; rename "Toggle" to "Inspect" everywhere [\#601](https://github.com/bensheldon/good_job/pull/601) ([bensheldon](https://github.com/bensheldon))
 - Adds the ability to delete jobs on the dashboard; add `cleanup_discarded_jobs` option to retain discarded jobs during cleanup [\#597](https://github.com/bensheldon/good_job/pull/597) ([TAGraves](https://github.com/TAGraves))
 - Dashboard: show more details about jobs [\#575](https://github.com/bensheldon/good_job/pull/575) ([bkeepers](https://github.com/bkeepers))
 
@@ -15,7 +56,6 @@
 
 **Merged pull requests:**
 
-- Remove ability to destroy individual Executions from Dashboard; rename "Toggle" to "Inspect" everywhere [\#601](https://github.com/bensheldon/good_job/pull/601) ([bensheldon](https://github.com/bensheldon))
 - Disable ActiveRecord Connection Reaper in test [\#600](https://github.com/bensheldon/good_job/pull/600) ([bensheldon](https://github.com/bensheldon))
 - Update README dashboard screenshot [\#599](https://github.com/bensheldon/good_job/pull/599) ([aried3r](https://github.com/aried3r))
 

data/README.md

@@ -39,7 +39,10 @@ For more of the story of GoodJob, read the [introductory blog post](https://isla
     - [Configuration options](#configuration-options)
     - [Global options](#global-options)
     - [Dashboard](#dashboard)
+        - [API-only Rails applications](#api-only-rails-applications)
+        - [Live Polling](#live-polling)
     - [ActiveJob concurrency](#activejob-concurrency)
+        - [How concurrency controls work](#how-concurrency-controls-work)
     - [Cron-style repeating/recurring jobs](#cron-style-repeatingrecurring-jobs)
     - [Updating](#updating)
         - [Upgrading minor versions](#upgrading-minor-versions)
@@ -56,6 +59,7 @@ For more of the story of GoodJob, read the [introductory blog post](https://isla
     - [Execute jobs async / in-process](#execute-jobs-async--in-process)
     - [Migrate to GoodJob from a different ActiveJob backend](#migrate-to-goodjob-from-a-different-activejob-backend)
     - [Monitor and preserve worked jobs](#monitor-and-preserve-worked-jobs)
+    - [Write tests](#write-tests)
     - [PgBouncer compatibility](#pgbouncer-compatibility)
     - [CLI HTTP health check probes](#cli-http-health-check-probes)
 - [Contribute](#contribute)
@@ -273,6 +277,7 @@ Available configuration options are:
 - `cleanup_preserved_jobs_before_seconds_ago` (integer) number of seconds to preserve jobs when using the `$ good_job cleanup_preserved_jobs` CLI command or calling `GoodJob.cleanup_preserved_jobs`. Defaults to `86400` (1 day). Can also be set with  the environment variable `GOOD_JOB_CLEANUP_PRESERVED_JOBS_BEFORE_SECONDS_AGO`.  _This configuration is only used when {GoodJob.preserve_job_records} is `true`._
 - `cleanup_interval_jobs` (integer) Number of jobs a Scheduler will execute before cleaning up preserved jobs. Defaults to `nil`. Can also be set with  the environment variable `GOOD_JOB_CLEANUP_INTERVAL_JOBS`.
 - `cleanup_interval_seconds` (integer) Number of seconds a Scheduler will wait before cleaning up preserved jobs. Defaults to `nil`. Can also be set with  the environment variable `GOOD_JOB_CLEANUP_INTERVAL_SECONDS`.
+- `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: `false`)
 - `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: `true`)
@@ -368,6 +373,23 @@ GoodJob includes a Dashboard as a mountable `Rails::Engine`.
     end
     ```
 
+#### API-only Rails applications
+
+API-only Rails applications may not have all of the required Rack middleware for the GoodJob Dashboard to function. To re-add the middlware:
+
+```ruby
+# config/application.rb
+module MyApp
+  class Application < Rails::Application
+    #...
+    config.middleware.use Rack::MethodOverride
+    config.middleware.use ActionDispatch::Flash
+    config.middleware.use ActionDispatch::Cookies
+    config.middleware.use ActionDispatch::Session::CookieStore
+  end
+end
+```
+
 #### 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).
@@ -420,6 +442,13 @@ job = MyJob.perform_later("Alice")
 job.good_job_concurrency_key #=> "Unique-Alice"
 ```
 
+#### How concurrency controls work
+
+GoodJob's concurrency control strategy for `perform_limit` is "optimistic retry with an incremental backoff". The [code is readable](https://github.com/bensheldon/good_job/blob/main/lib/good_job/active_job_extensions/concurrency.rb).
+
+- "Optimistic" meaning that the implementation's performance trade-off assumes that collisions are atypical (e.g. two users enqueue the same job at the same time) rather than regular (e.g. the system enqueues thousands of colliding jobs at the same time).
+- "Retry with an incremental backoff" means that when `perform_limit` is exceeded, the job will raise a `GoodJob::ActiveJobExtensions::Concurrency::ConcurrencyExceededError` which is caught by a `retry_on` handler which re-schedules the job to execute in the near future with an incremental backoff.
+
 ### Cron-style repeating/recurring jobs
 
 GoodJob can enqueue jobs on a recurring basis that can be used as a replacement for cron.
@@ -851,6 +880,23 @@ It is also necessary to destroy these preserved jobs from the database after a c
     bundle exec good_job cleanup_preserved_jobs --before-seconds-ago=86400
     ```
 
+### Write tests
+
+By default, GoodJob uses its inline adapter in the test environment; the inline adapter is designed for the test environment. When enquing a job with GoodJob's inline adapter, the job will be executed immediately on the current thread; unhandled exceptions will be raised.
+
+In GoodJob 2.0, the inline adapter will execute future scheduled jobs immediately. In the next major release, GoodJob 3.0, the inline adapter will not execute future scheduled jobs and instead enqueue them in the database.
+
+To opt into this behavior immediately set: `config.good_job.inline_execution_respects_schedule = true`
+
+To perform jobs inline at any time, use `GoodJob.perform_inline`. For example, using time helpers within an integration test:
+
+```ruby
+MyJob.set(wait: 10.minutes).perform_later
+travel_to(15.minutes.from_now) { GoodJob.perform_inline }
+```
+
+_Note: Rails `travel`/`travel_to` time helpers do not have millisecond precision, so you must leave at least 1 second between the schedule and time traveling for the job to be executed. This [behavior may change in Rails 7.1](https://github.com/rails/rails/pull/44088)._
+
 ### PgBouncer compatibility
 
 GoodJob is not compatible with PgBouncer in _transaction_ mode, but is compatible with PgBouncer's _connection_ mode. GoodJob uses connection-based advisory locks and LISTEN/NOTIFY, both of which require full database connections.

data/engine/app/assets/good_job/style.css

@@ -34,3 +34,8 @@
 .toast-container {
   z-index: 1;
 }
+
+.translation_missing {
+  background-color: red;
+  color: white;
+}

data/engine/app/helpers/good_job/application_helper.rb

@@ -41,7 +41,7 @@ module GoodJob
     }.freeze
 
     def status_badge(status)
-      content_tag :span, status_icon(status, class: "text-white") + t(status, scope: '.status'),
+      content_tag :span, status_icon(status, class: "text-white") + t(status, scope: 'good_job.status'),
                   class: "badge rounded-pill bg-#{STATUS_COLOR.fetch(status)} d-inline-flex gap-2 ps-1 pe-3 align-items-center"
     end
 

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

@@ -10,7 +10,7 @@
       <% filter.states.each do |name, count| %>
         <li class="nav-item">
           <%= link_to url_for({state: name}), class: "nav-link #{"active" if params[:state] == name}" do %>
-            <%= t(name, scope: '.status') %>
+            <%= t(name, scope: 'good_job.status') %>
             <span class="badge bg-primary rounded-pill <%= "bg-secondary" if count == 0 %>"><%= count %></span>
           <% end %>
         </li>

data/lib/good_job/adapter.rb

@@ -62,19 +62,48 @@ module GoodJob
     # @param timestamp [Integer, nil] the epoch time to perform the job
     # @return [GoodJob::Execution]
     def enqueue_at(active_job, timestamp)
+      scheduled_at = timestamp ? Time.zone.at(timestamp) : nil
+
+      if execute_inline?
+        future_scheduled = (scheduled_at.nil? || scheduled_at > Time.current)
+        will_execute_inline = !future_scheduled || (future_scheduled && !@configuration.inline_execution_respects_schedule?)
+      end
+
       execution = GoodJob::Execution.enqueue(
         active_job,
-        scheduled_at: timestamp ? Time.zone.at(timestamp) : nil,
-        create_with_advisory_lock: execute_inline?
+        scheduled_at: scheduled_at,
+        create_with_advisory_lock: will_execute_inline
       )
 
-      if execute_inline?
+      if will_execute_inline
+        if future_scheduled && !@configuration.inline_execution_respects_schedule?
+          ActiveSupport::Deprecation.warn(<<~DEPRECATION)
+            In the next major release, GoodJob will not *inline* execute
+            future-scheduled jobs.
+
+            To opt into this behavior immediately set:
+            `config.good_job.inline_execution_respects_schedule = true`
+
+            To perform jobs inline at any time, use `GoodJob.perform_inline`.
+
+            For example, using time helpers within an integration test:
+
+            ```
+            MyJob.set(wait: 10.minutes).perform_later
+            travel_to(15.minutes.from_now) { GoodJob.perform_inline }
+            ```
+
+            Note: Rails `travel`/`travel_to` time helpers do not have millisecond
+            precision, so you must leave at least 1 second between the schedule
+            and time traveling for the job to be executed.
+          DEPRECATION
+        end
+
         begin
           result = execution.perform
         ensure
           execution.advisory_unlock
         end
-
         raise result.unhandled_error if result.unhandled_error
       else
         job_state = { queue_name: execution.queue_name }

data/lib/good_job/configuration.rb

@@ -119,6 +119,10 @@ module GoodJob
       end
     end
 
+    def inline_execution_respects_schedule?
+      !!rails_config[:inline_execution_respects_schedule]
+    end
+
     # The maximum number of future-scheduled jobs to store in memory.
     # Storing future-scheduled jobs in memory reduces execution latency
     # at the cost of increased memory usage. 10,000 stored jobs = ~20MB.

data/lib/good_job/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module GoodJob
   # GoodJob gem version.
-  VERSION = '2.15.0'
+  VERSION = '2.16.0'
 end

data/lib/good_job.rb

@@ -8,7 +8,9 @@ Zeitwerk::Loader.for_gem.tap do |loader|
   loader.inflector.inflect({
                              "cli" => "CLI",
                            })
-  loader.ignore(File.join(File.dirname(__FILE__), "generators"))
+  loader.ignore("#{__dir__}/generators")
+  loader.ignore("#{__dir__}/active_job")
+  loader.push_dir("#{__dir__}/active_job/queue_adapters", namespace: ActiveJob::QueueAdapters)
   loader.setup
 end
 
@@ -151,6 +153,20 @@ module GoodJob
     end
   end
 
+  # Perform all queued jobs in the current thread.
+  # This is primarily intended for usage in a test environment.
+  # Unhandled job errors will be raised.
+  # @param queue_string [String] Queues to execute jobs from
+  # @return [void]
+  def self.perform_inline(queue_string = "*")
+    job_performer = JobPerformer.new(queue_string)
+    loop do
+      result = job_performer.next
+      break unless result
+      raise result.unhandled_error if result.unhandled_error
+    end
+  end
+
   def self._executables
     [].concat(
       CronManager.instances,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 2.15.0
+  version: 2.16.0
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-18 00:00:00.000000000 Z
+date: 2022-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob