good_job 2.17.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92c29f2bed6e36f449e880b5433c089351c63d1365cdc094b774122202407fb3
-  data.tar.gz: 4125a6cfb9e3c0d3de88bd8cdfb64acb450f8c6072fc2aa6a0907f9b51083add
+  metadata.gz: a4f4e14bae83760bdeb35557a727116d053e47a9b7dbf501914606dbc45c2ef7
+  data.tar.gz: c06e9165b7ac5d87af0ab75291fedd0194018752f34332c1a16930ddca53e3dd
 SHA512:
-  metadata.gz: cd6b4fbce879de227852b9399bbb65739933b50732dfc5be5a3563162c55375d1d366d4796bf163c4d12683a7f03668ef7a80d73e229343debe622c7e7ccd2b1
-  data.tar.gz: 5f4fac41e04a0844b93cc482e24b910e599ccabf411ac6841e7519cb6d573a6d7bb82070f6a35ffc40a1937256f910e9e6995cc5a9090e779c9b2eac33a8d901
+  metadata.gz: 949cfcf1506ff658666113e035a875ed4ab44fa3e2c674e4d5d1440bf484d39793a1ee595ae0cb6f719136ce5541aae09a7fc2d66a049ea1bcf973b0165dc8a4
+  data.tar.gz: 9c9ff56251e01d60823a50f4edcea74034a36ef93929cf59adc588273da86d1e04f67c1b25d7d35efecda9309acf7f49f81d29fbc7f94249be0e3732087f9081

data/CHANGELOG.md

@@ -1,5 +1,53 @@
 # Changelog
 
+## [v3.0.0](https://github.com/bensheldon/good_job/tree/v3.0.0) (2022-06-26)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v2.99.0...v3.0.0)
+
+**Implemented enhancements:**
+
+- By default, preserve job records and automatically them clean up [\#545](https://github.com/bensheldon/good_job/pull/545) ([bensheldon](https://github.com/bensheldon))
+
+**Merged pull requests:**
+
+- Update tests to reflect default of `GoodJob.preserve_job_records = true`; update appraisal Gemfiles too [\#643](https://github.com/bensheldon/good_job/pull/643) ([bensheldon](https://github.com/bensheldon))
+- Remove database migration shims and old migrations [\#642](https://github.com/bensheldon/good_job/pull/642) ([bensheldon](https://github.com/bensheldon))
+- Remove support for EOL Rails 5.2 [\#637](https://github.com/bensheldon/good_job/pull/637) ([bensheldon](https://github.com/bensheldon))
+- Remove/rename deprecated behavior and constants for GoodJob v3  [\#633](https://github.com/bensheldon/good_job/pull/633) ([bensheldon](https://github.com/bensheldon))
+
+## [v2.99.0](https://github.com/bensheldon/good_job/tree/v2.99.0) (2022-06-26)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v2.17.1...v2.99.0)
+
+**Closed issues:**
+
+- How to accomplish user controlled recurring jobs? [\#640](https://github.com/bensheldon/good_job/issues/640)
+- "uninitialized constant GoodJob::Execution" in development env [\#634](https://github.com/bensheldon/good_job/issues/634)
+
+**Merged pull requests:**
+
+- Create upgrade instructions for v2.99 -\> v3.0.0 [\#641](https://github.com/bensheldon/good_job/pull/641) ([bensheldon](https://github.com/bensheldon))
+- Update development dependencies; delete Gemfile.lock in CI to avoid Ruby version dependency mismatches [\#639](https://github.com/bensheldon/good_job/pull/639) ([bensheldon](https://github.com/bensheldon))
+- Put more model files in `lib/models` and align specs too [\#638](https://github.com/bensheldon/good_job/pull/638) ([bensheldon](https://github.com/bensheldon))
+- Generate sha256 checksums on gem release too [\#636](https://github.com/bensheldon/good_job/pull/636) ([bensheldon](https://github.com/bensheldon))
+
+## [v2.17.1](https://github.com/bensheldon/good_job/tree/v2.17.1) (2022-06-24)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v2.17.0...v2.17.1)
+
+**Fixed bugs:**
+
+- Move models out of `app` into `lib/models` [\#635](https://github.com/bensheldon/good_job/pull/635) ([bensheldon](https://github.com/bensheldon))
+
+**Closed issues:**
+
+- dashboard "delete all" does not work [\#630](https://github.com/bensheldon/good_job/issues/630)
+- Concurrency controlled jobs cause infinite loops when perform\_limit is exceeded in test environments [\#609](https://github.com/bensheldon/good_job/issues/609)
+
+**Merged pull requests:**
+
+- Better isolate test environment: run server integration tests on port 3009 with custom pidfile; scope advisory lock counts to test database [\#632](https://github.com/bensheldon/good_job/pull/632) ([bensheldon](https://github.com/bensheldon))
+
 ## [v2.17.0](https://github.com/bensheldon/good_job/tree/v2.17.0) (2022-06-23)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v2.16.1...v2.17.0)

data/README.md

@@ -46,6 +46,7 @@ For more of the story of GoodJob, read the [introductory blog post](https://isla
     - [Cron-style repeating/recurring jobs](#cron-style-repeatingrecurring-jobs)
     - [Updating](#updating)
         - [Upgrading minor versions](#upgrading-minor-versions)
+        - [Upgrading v2 to v3](#upgrading-v2-to-v3)
         - [Upgrading v1 to v2](#upgrading-v1-to-v2)
 - [Go deeper](#go-deeper)
     - [Exceptions, retries, and reliability](#exceptions-retries-and-reliability)
@@ -143,9 +144,9 @@ For more of the story of GoodJob, read the [introductory blog post](https://isla
 
 ## Compatibility
 
-- **Ruby on Rails:** 5.2+
-- **Ruby:** MRI 2.5+. JRuby 9.2.13+
-- **Postgres:** 9.6+
+- **Ruby on Rails:** 6.0+
+- **Ruby:** Ruby 2.5+. JRuby 9.2.13+
+- **Postgres:** 10.0+
 
 ## Configuration
 
@@ -279,7 +280,7 @@ Available configuration options are:
 - `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`)
+- `preserve_job_records` (boolean) keeps job records in your database even after jobs are completed. (Default: `true`)
 - `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`)
 - `on_thread_error` (proc, lambda, or callable) will be called when an Exception. It can be useful for logging errors to bug tracking services, like Sentry or Airbrake. Example:
 
@@ -310,8 +311,8 @@ Good Job’s general behavior can also be configured via attributes directly on
 
 - **`GoodJob.active_record_parent_class`** (string) The ActiveRecord parent class inherited by GoodJob's ActiveRecord model `GoodJob::Job` (defaults to `"ActiveRecord::Base"`). Configure this when using [multiple databases with ActiveRecord](https://guides.rubyonrails.org/active_record_multiple_databases.html) or when other custom configuration is necessary for the ActiveRecord model to connect to the Postgres database. _The value must be a String to avoid premature initialization of ActiveRecord._
 - **`GoodJob.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`.
-- **`GoodJob.preserve_job_records`** (boolean) keeps job records in your database even after jobs are completed. (Default: `false`)
-- **`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: `true`)
+- **`GoodJob.preserve_job_records`** (boolean) keeps job records in your database even after jobs are completed. (Default: `true`)
+- **`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`)
 - **`GoodJob.on_thread_error`** (proc, lambda, or callable) will be called when an Exception. It can be useful for logging errors to bug tracking services, like Sentry or Airbrake.
 
 You’ll generally want to configure these in `config/initializers/good_job.rb`, like so:
@@ -394,8 +395,6 @@ The Dashboard can be set to automatically refresh by checking "Live Poll" in the
 
 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 unecessary jobs from being enqueued, or race conditions when performing, for example when interacting with 3rd-party APIs.
 
-**Note:** Limiting concurrency at _enqueue_ requires Rails 6.0+ because Rails 5.2 cannot halt ActiveJob callbacks.
-
 ```ruby
 class MyJob < ApplicationJob
   include GoodJob::ActiveJobExtensions::Concurrency
@@ -509,9 +508,25 @@ To perform upgrades to the GoodJob database tables:
 1. Commit the migration files and resulting `db/schema.rb` changes.
 1. Deploy the code, run the migrations against the production database, and restart server/worker processes.
 
+#### Upgrading v2 to v3
+
+GoodJob v3 is operationally identical to v2; upgrading to GoodJob v3 should be simple. If you are already using `>= v2.9+` no other changes are necessary.
+
+1. Upgrade to `v2.99.x`, following the minor version upgrade process, running any remaining database migrations (`rails g good_job:update`) and addressing deprecation warnings.
+1. Upgrade from `v2.99.x` to `v3.x`
+
+Notable changes:
+
+- Defaults to preserve job records, and automatically delete them after 14 days.
+- Defaults to discarding failed jobs, instead of immediately retrying them.
+- `:inline` execution mode respects job schedules. Tests can invoke  `GoodJob.perform_inline` to execute jobs.
+- `GoodJob::Adapter` can no longer can be initialized with custom execution options (`queues:`, `max_threads:`, `poll_interval:`).
+- Renames `GoodJob::ActiveJobJob` to `GoodJob::Job`.
+- Removes support for Rails 5.2.
+
 #### Upgrading v1 to v2
 
-GoodJob v2 introduces a new Advisory Lock key format that is different than the v1 advisory lock key format; it's therefore necessary to perform a simple, but staged production upgrade. If you are already using `>= v1.12+` no other changes are necessary.
+GoodJob v2 introduces a new Advisory Lock key format that is operationally different than the v1 advisory lock key format; it's therefore necessary to perform a simple, but staged production upgrade. If you are already using `>= v1.12+` no other changes are necessary.
 
 1. Upgrade your production environment to `v1.99.x` following the minor version upgrade process, including database migrations. `v1.99` is a transitional release that is safely compatible with both `v1.x` and `v2.0.0` because it uses both `v1`- and `v2`-formatted advisory locks.
 1. Address any deprecation warnings generated by `v1.99`.
@@ -547,9 +562,9 @@ GoodJob.on_thread_error = -> (exception) { Raven.capture_exception(exception) }
 
 #### Retries
 
-By default, GoodJob will automatically and immediately retry a job when an exception is raised to GoodJob.
+By default, GoodJob relies on ActiveJob's retry functionality.
 
-However, 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 an exponential backoff. Using ActiveJob's `retry_on` prevents exceptions from reaching GoodJob:
 
 ```ruby
 class ApplicationJob < ActiveJob::Base
@@ -558,14 +573,7 @@ class ApplicationJob < ActiveJob::Base
 end
 ```
 
-When using `retry_on` with _a limited number of retries_, the final exception will not be rescued and will raise to GoodJob. GoodJob can be configured to discard un-handled exceptions instead of retrying them. Be aware that if NOT setting `retry_on_unhandled_error` to `false` good_job will by default retry the failing job and may do this infinitely without pause thereby at least causing high load. In most cases `retry_on_unhandled_error` should be set as following:
-
-```ruby
-# config/initializers/good_job.rb
-GoodJob.retry_on_unhandled_error = false
-```
-
-Alternatively, pass a block to `retry_on` to handle the final exception instead of raising it to GoodJob:
+When using `retry_on` with _a limited number of retries_, the final exception will not be rescued and will raise to GoodJob's error handler. To avoid this, pass a block to `retry_on` to handle the final exception instead of raising it to GoodJob:
 
 ```ruby
 class ApplicationJob < ActiveJob::Base
@@ -596,9 +604,11 @@ class ApplicationJob < ActiveJob::Base
 end
 ```
 
+By default, jobs will not be retried unless `retry_on` is configured. This can be overridden by setting `GoodJob.retry_on_unhandled_error` to `true`; GoodJob will then retry the failing job immediately and infinitely, potentially causing high load.
+
 #### ActionMailer retries
 
-Any configuration in `ApplicationJob` will have to be duplicated on `ActionMailer::MailDeliveryJob` (`ActionMailer::DeliveryJob` in Rails 5.2 or earlier) because ActionMailer uses a custom class, `ActionMailer::MailDeliveryJob`, which inherits from `ActiveJob::Base`,  rather than your applications `ApplicationJob`.
+Any configuration in `ApplicationJob` will have to be duplicated on `ActionMailer::MailDeliveryJob` because ActionMailer uses that custom class which inherits from `ActiveJob::Base`,  rather than your application's `ApplicationJob`.
 
 You can use an initializer to configure `ActionMailer::MailDeliveryJob`, for example:
 
@@ -852,22 +862,31 @@ If your application is already using an ActiveJob backend, you will need to inst
 
 GoodJob is fully instrumented with [`ActiveSupport::Notifications`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#introduction-to-instrumentation).
 
-By default, GoodJob will destroy job records after they are run, regardless of whether they succeed or not (raising a kind of `StandardError`), unless they are interrupted (raising a kind of `Exception`).
+By default, GoodJob will preserve job records for 14 days after they are run, regardless of whether they succeed or not (raising a kind of `StandardError`), unless they are interrupted (raising a kind of `Exception`).
 
-To preserve job records for later inspection, set an initializer:
+To not preserve job records for later inspection, set an initializer:
 
 ```ruby
 # config/initializers/good_job.rb
-GoodJob.preserve_job_records = true
+GoodJob.preserve_job_records = false # defaults to true, or `false` or `:on_unhandled_error`
+```
+
+GoodJob will automatically delete these job records after 14 days. The retention period, as well as the frequency GoodJob checks for deletable records can be configured:
+
+```ruby
+
+config.cleanup_preserved_jobs_before_seconds_ago = 14.days.to_i
+config.cleanup_interval_jobs = 1_000 # Number of executed jobs between deletion sweeps.
+config.cleanup_interval_seconds = 10.minutes.to_i # Number of seconds between deletion sweeps.
 ```
 
-It is also necessary to destroy these preserved jobs from the database after a certain time period:
+It is also possible to manually trigger a cleanup:
 
 - For example, in a Rake task:
 
     ```ruby
-    GoodJob.cleanup_preserved_jobs # Will keep 1 day of job records by default.
-    GoodJob.cleanup_preserved_jobs(older_than: 7.days) # It also takes custom arguments.
+    GoodJob.cleanup_preserved_jobs # Will use default retention period
+    GoodJob.cleanup_preserved_jobs(older_than: 7.days) # custom retention period
     ```
 
 - For example, using the `good_job` command-line utility:

data/app/charts/good_job/scheduled_by_queue_chart.rb

@@ -9,7 +9,7 @@ module GoodJob
     def data
       end_time = Time.current
       start_time = end_time - 1.day
-      table_name = GoodJob::ActiveJobJob.table_name
+      table_name = GoodJob::Job.table_name
 
       count_query = Arel.sql(GoodJob::Execution.pg_or_jdbc_query(<<~SQL.squish))
         SELECT *

data/app/controllers/good_job/jobs_controller.rb

@@ -10,8 +10,8 @@ module GoodJob
       destroy: "destroyed",
     }.freeze
 
-    rescue_from GoodJob::ActiveJobJob::AdapterNotGoodJobError,
-                GoodJob::ActiveJobJob::ActionForStateMismatchError,
+    rescue_from GoodJob::Job::AdapterNotGoodJobError,
+                GoodJob::Job::ActionForStateMismatchError,
                 with: :redirect_on_error
 
     def index
@@ -26,7 +26,7 @@ module GoodJob
                JobsFilter.new(params).filtered_query
              else
                job_ids = params.fetch(:job_ids, [])
-               ActiveJobJob.where(active_job_id: job_ids)
+               Job.where(active_job_id: job_ids)
              end
 
       processed_jobs = jobs.map do |job|
@@ -42,7 +42,7 @@ module GoodJob
         end
 
         job
-      rescue GoodJob::ActiveJobJob::ActionForStateMismatchError
+      rescue GoodJob::Job::ActionForStateMismatchError
         nil
       end.compact
 
@@ -56,29 +56,29 @@ module GoodJob
     end
 
     def show
-      @job = ActiveJobJob.find(params[:id])
+      @job = Job.find(params[:id])
     end
 
     def discard
-      @job = ActiveJobJob.find(params[:id])
+      @job = Job.find(params[:id])
       @job.discard_job(DISCARD_MESSAGE)
       redirect_back(fallback_location: jobs_path, notice: "Job has been discarded")
     end
 
     def reschedule
-      @job = ActiveJobJob.find(params[:id])
+      @job = Job.find(params[:id])
       @job.reschedule_job
       redirect_back(fallback_location: jobs_path, notice: "Job has been rescheduled")
     end
 
     def retry
-      @job = ActiveJobJob.find(params[:id])
+      @job = Job.find(params[:id])
       @job.retry_job
       redirect_back(fallback_location: jobs_path, notice: "Job has been retried")
     end
 
     def destroy
-      @job = ActiveJobJob.find(params[:id])
+      @job = Job.find(params[:id])
       @job.destroy_job
       redirect_back(fallback_location: jobs_path, notice: "Job has been destroyed")
     end
@@ -87,9 +87,9 @@ module GoodJob
 
     def redirect_on_error(exception)
       alert = case exception
-              when GoodJob::ActiveJobJob::AdapterNotGoodJobError
+              when GoodJob::Job::AdapterNotGoodJobError
                 "ActiveJob Queue Adapter must be GoodJob."
-              when GoodJob::ActiveJobJob::ActionForStateMismatchError
+              when GoodJob::Job::ActionForStateMismatchError
                 "Job is not in an appropriate state for this action."
               else
                 exception.to_s

data/app/controllers/good_job/processes_controller.rb

@@ -2,7 +2,7 @@
 module GoodJob
   class ProcessesController < GoodJob::ApplicationController
     def index
-      @processes = GoodJob::Process.active.order(created_at: :desc) if GoodJob::Process.migrated?
+      @processes = GoodJob::Process.active.order(created_at: :desc)
     end
   end
 end

data/app/filters/good_job/jobs_filter.rb

@@ -31,7 +31,7 @@ module GoodJob
         when 'scheduled'
           query = query.scheduled
         when 'running'
-          query = query.running.select("#{GoodJob::ActiveJobJob.table_name}.*", 'pg_locks.locktype')
+          query = query.running.select("#{GoodJob::Job.table_name}.*", 'pg_locks.locktype')
         when 'queued'
           query = query.queued
         end
@@ -47,7 +47,7 @@ module GoodJob
     private
 
     def default_base_query
-      GoodJob::ActiveJobJob.all
+      GoodJob::Job.all
     end
   end
 end

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

@@ -3,15 +3,7 @@
 </div>
 
 <div data-live-poll-region="processes">
-  <% if !GoodJob::Process.migrated? %>
-    <div class="card my-3">
-      <div class="card-body">
-        <p class="card-text">
-          <em>Feature unavailable because of pending database migration.</em>
-        </p>
-      </div>
-    </div>
-  <% elsif @processes.present? %>
+  <% if @processes.present? %>
     <div class="card my-3">
       <div class="table-responsive">
         <table class="table card-table table-bordered table-hover table-sm mb-0">

data/app/views/layouts/good_job/application.html.erb

@@ -16,7 +16,7 @@
   <%= tag.script "", src: rails_ujs_path(format: :js, v: GoodJob::VERSION, locale: nil), nonce: content_security_policy_nonce %>
 
   <%= tag.script "", src: es_module_shims_path(format: :js, v: GoodJob::VERSION, locale: nil), async: true, nonce: content_security_policy_nonce %>
-  <% importmaps = { imports: GoodJob::AssetsController.js_modules.keys.each_with_object({}) { |module_name, imports| imports[module_name] = modules_path(module_name, format: :js, locale: nil, v: GoodJob::VERSION) } } %>
+  <% importmaps = { imports: GoodJob::AssetsController.js_modules.keys.index_with { |module_name| modules_path(module_name, format: :js, locale: nil, v: GoodJob::VERSION) } } %>
   <%= tag.script importmaps.to_json.html_safe, type: "importmap", nonce: content_security_policy_nonce %>
   <%= tag.script "", src: scripts_path(format: :js, v: GoodJob::VERSION, locale: nil), type: "module", nonce: content_security_policy_nonce %>
 </head>

data/lib/generators/good_job/templates/update/migrations/01_create_good_jobs.rb.erb

@@ -18,6 +18,12 @@ class CreateGoodJobs < ActiveRecord::Migration<%= migration_version %>
       t.text :concurrency_key
       t.text :cron_key
       t.uuid :retried_good_job_id
+      t.timestamp :cron_at
+    end
+
+    create_table :good_job_processes, id: :uuid do |t|
+      t.timestamps
+      t.jsonb :state
     end
 
     add_index :good_jobs, :scheduled_at, where: "(finished_at IS NULL)", name: "index_good_jobs_on_scheduled_at"
@@ -25,5 +31,8 @@ class CreateGoodJobs < ActiveRecord::Migration<%= migration_version %>
     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, [:cron_key, :created_at], name: :index_good_jobs_on_cron_key_and_created_at
+    add_index :good_jobs, [:cron_key, :cron_at], name: :index_good_jobs_on_cron_key_and_cron_at, unique: true
+    add_index :good_jobs, [:active_job_id], name: :index_good_jobs_on_active_job_id
+    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
   end
 end

data/lib/good_job/adapter.rb

@@ -20,32 +20,16 @@ module GoodJob
     #
     #  The default value depends on the Rails environment:
     #
-    #  - +development+ and +test+: +:inline+
+    #  - +development+: +:async:+
+    #   -+test+: +:inline+
     #  - +production+ and all other environments: +:external+
     #
-    # @param max_threads [Integer, nil] sets the number of threads per scheduler to use when +execution_mode+ is set to +:async+. The +queues+ parameter can specify a number of threads for each group of queues which will override this value. You can also set this with the environment variable +GOOD_JOB_MAX_THREADS+. Defaults to +5+.
-    # @param queues [String, nil] determines which queues to execute jobs from when +execution_mode+ is set to +:async+. See {file:README.md#optimize-queues-threads-and-processes} for more details on the format of this string. You can also set this with the environment variable +GOOD_JOB_QUEUES+. Defaults to +"*"+.
-    # @param poll_interval [Integer, nil] sets the number of seconds between polls for jobs when +execution_mode+ is set to +:async+. You can also set this with the environment variable +GOOD_JOB_POLL_INTERVAL+. Defaults to +1+.
-    # @param start_async_on_initialize [Boolean] whether to start the async scheduler when the adapter is initialized.
-    def initialize(execution_mode: nil, queues: nil, max_threads: nil, poll_interval: nil, start_async_on_initialize: nil)
-      if queues || max_threads || poll_interval || start_async_on_initialize
-        ActiveSupport::Deprecation.warn(
-          "GoodJob::Adapter's execution-related arguments (queues, max_threads, poll_interval, start_async_on_initialize) have been deprecated and will be removed in GoodJob v3. These options should be configured through GoodJob global configuration instead."
-        )
-      end
-
-      @configuration = GoodJob::Configuration.new(
-        {
-          execution_mode: execution_mode,
-          queues: queues,
-          max_threads: max_threads,
-          poll_interval: poll_interval,
-        }
-      )
+    def initialize(execution_mode: nil)
+      @configuration = GoodJob::Configuration.new({ execution_mode: execution_mode })
       @configuration.validate!
       self.class.instances << self
 
-      start_async if start_async_on_initialize || GoodJob.async_ready?
+      start_async if GoodJob.async_ready?
     end
 
     # Enqueues the ActiveJob job to be performed.
@@ -63,11 +47,7 @@ module GoodJob
     # @return [GoodJob::Execution]
     def enqueue_at(active_job, timestamp)
       scheduled_at = timestamp ? Time.zone.at(timestamp) : nil
-
-      if execute_inline?
-        future_scheduled = scheduled_at && scheduled_at > Time.current
-        will_execute_inline = !future_scheduled || (future_scheduled && !@configuration.inline_execution_respects_schedule?)
-      end
+      will_execute_inline = execute_inline? && (scheduled_at.nil? || scheduled_at <= Time.current)
 
       execution = GoodJob::Execution.enqueue(
         active_job,
@@ -76,29 +56,6 @@ module GoodJob
       )
 
       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

data/lib/good_job/configuration.rb

@@ -15,13 +15,13 @@ module GoodJob
     # Default poll interval for async in development environment
     DEFAULT_DEVELOPMENT_ASYNC_POLL_INTERVAL = -1
     # Default number of threads to use per {Scheduler}
-    DEFAULT_MAX_CACHE = 10000
+    DEFAULT_MAX_CACHE = 10_000
     # Default number of seconds to preserve jobs for {CLI#cleanup_preserved_jobs} and {GoodJob.cleanup_preserved_jobs}
-    DEFAULT_CLEANUP_PRESERVED_JOBS_BEFORE_SECONDS_AGO = 24 * 60 * 60
+    DEFAULT_CLEANUP_PRESERVED_JOBS_BEFORE_SECONDS_AGO = 14.days.to_i
     # Default number of jobs to execute between preserved job cleanup runs
-    DEFAULT_CLEANUP_INTERVAL_JOBS = nil
+    DEFAULT_CLEANUP_INTERVAL_JOBS = 1_000
     # Default number of seconds to wait between preserved job cleanup runs
-    DEFAULT_CLEANUP_INTERVAL_SECONDS = nil
+    DEFAULT_CLEANUP_INTERVAL_SECONDS = 10.minutes.to_i
     # Default to always wait for jobs to finish for {Adapter#shutdown}
     DEFAULT_SHUTDOWN_TIMEOUT = -1
     # Default to not running cron

data/lib/good_job/current_thread.rb

@@ -56,8 +56,8 @@ module GoodJob
     # Exports values to hash
     # @return [Hash]
     def self.to_h
-      ACCESSORS.each_with_object({}) do |accessor, hash|
-        hash[accessor] = send(accessor)
+      ACCESSORS.index_with do |accessor|
+        send(accessor)
       end
     end
 

data/lib/good_job/notifier/process_registration.rb

@@ -14,8 +14,6 @@ module GoodJob # :nodoc:
       # Registers the current process.
       def register_process
         GoodJob::Process.with_connection(connection) do
-          next unless Process.migrated?
-
           GoodJob::Process.cleanup
           @process = GoodJob::Process.register
         end
@@ -24,8 +22,6 @@ module GoodJob # :nodoc:
       # Deregisters the current process.
       def deregister_process
         GoodJob::Process.with_connection(connection) do
-          next unless Process.migrated?
-
           @process&.deregister
         end
       end

data/lib/good_job/version.rb

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

data/lib/good_job.rb

@@ -8,6 +8,7 @@ Zeitwerk::Loader.for_gem(**zeitwerk_options).tap do |loader|
   loader.inflector.inflect({
                              "cli" => "CLI",
                            })
+  loader.push_dir("#{__dir__}/models")
   loader.ignore("#{__dir__}/generators")
   loader.setup
 end
@@ -42,23 +43,21 @@ module GoodJob
 
   # @!attribute [rw] preserve_job_records
   #   @!scope class
-  #   Whether to preserve job records in the database after they have finished (default: +false+).
-  #   By default, GoodJob destroys job records after the job is completed successfully.
+  #   Whether to preserve job records in the database after they have finished (default: +true+).
+  #   By default, GoodJob deletes job records after the job is completed successfully.
   #   If you want to preserve jobs for latter inspection, set this to +true+.
   #   If you want to preserve only jobs that finished with error for latter inspection, set this to +:on_unhandled_error+.
-  #   If +true+, you will need to clean out jobs using the +good_job cleanup_preserved_jobs+ CLI command or
-  #   by using +Goodjob.cleanup_preserved_jobs+.
   #   @return [Boolean, nil]
-  mattr_accessor :preserve_job_records, default: false
+  mattr_accessor :preserve_job_records, default: true
 
   # @!attribute [rw] retry_on_unhandled_error
   #   @!scope class
-  #   Whether to re-perform a job when a type of +StandardError+ is raised to GoodJob (default: +true+).
+  #   Whether to re-perform a job when a type of +StandardError+ is raised to GoodJob (default: +false+).
   #   If +true+, causes jobs to be re-queued and retried if they raise an instance of +StandardError+.
   #   If +false+, jobs will be discarded or marked as finished if they raise an instance of +StandardError+.
   #   Instances of +Exception+, like +SIGINT+, will *always* be retried, regardless of this attribute's value.
   #   @return [Boolean, nil]
-  mattr_accessor :retry_on_unhandled_error, default: true
+  mattr_accessor :retry_on_unhandled_error, default: false
 
   # @!attribute [rw] on_thread_error
   #   @!scope class
@@ -142,7 +141,7 @@ module GoodJob
     include_discarded = configuration.cleanup_discarded_jobs?
 
     ActiveSupport::Notifications.instrument("cleanup_preserved_jobs.good_job", { older_than: older_than, timestamp: timestamp }) do |payload|
-      old_jobs = GoodJob::ActiveJobJob.where('finished_at <= ?', timestamp)
+      old_jobs = GoodJob::Job.where('finished_at <= ?', timestamp)
       old_jobs = old_jobs.not_discarded unless include_discarded
       old_jobs_count = old_jobs.count
 

data/lib/models/good_job/active_job_job.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+module GoodJob
+  # @deprecated Use {GoodJob::Job} instead.
+  class ActiveJobJob < Execution
+    after_initialize do |_job|
+      ActiveSupport::Deprecation.warn(
+        "The `GoodJob::ActiveJobJob` class name is deprecated. Replace with `GoodJob::Job`."
+      )
+    end
+  end
+end

data/lib/{good_job → models/good_job}/cron_entry.rb

@@ -73,13 +73,13 @@ module GoodJob # :nodoc:
     end
 
     def jobs
-      GoodJob::ActiveJobJob.where(cron_key: key)
+      GoodJob::Job.where(cron_key: key)
     end
 
     def last_at
       return if last_job.blank?
 
-      if GoodJob::ActiveJobJob.column_names.include?('cron_at')
+      if GoodJob::Job.column_names.include?('cron_at')
         (last_job.cron_at || last_job.created_at).localtime
       else
         last_job.created_at
@@ -99,7 +99,7 @@ module GoodJob # :nodoc:
     end
 
     def last_job
-      if GoodJob::ActiveJobJob.column_names.include?('cron_at')
+      if GoodJob::Job.column_names.include?('cron_at')
         jobs.order("cron_at DESC NULLS LAST").first
       else
         jobs.order(created_at: :asc).last

data/{app → lib}/models/good_job/execution.rb

@@ -51,7 +51,7 @@ module GoodJob
       end
     end
 
-    belongs_to :job, class_name: 'GoodJob::ActiveJobJob', foreign_key: 'active_job_id', primary_key: 'active_job_id', optional: true, inverse_of: :executions
+    belongs_to :job, class_name: 'GoodJob::Job', foreign_key: 'active_job_id', primary_key: 'active_job_id', optional: true, inverse_of: :executions
 
     # Get Jobs with given ActiveJob ID
     # @!method active_job_id
@@ -207,14 +207,7 @@ module GoodJob
 
         if CurrentThread.cron_key
           execution_args[:cron_key] = CurrentThread.cron_key
-
-          @cron_at_index = column_names.include?('cron_at') && connection.index_name_exists?(:good_jobs, :index_good_jobs_on_cron_key_and_cron_at) unless instance_variable_defined?(:@cron_at_index)
-
-          if @cron_at_index
-            execution_args[:cron_at] = CurrentThread.cron_at
-          else
-            migration_pending_warning!
-          end
+          execution_args[:cron_at] = CurrentThread.cron_at
         elsif CurrentThread.active_job_id && CurrentThread.active_job_id == active_job.job_id
           execution_args[:cron_key] = CurrentThread.execution.cron_key
         end
@@ -346,8 +339,7 @@ module GoodJob
         current_thread.reset
         current_thread.execution = self
 
-        # DEPRECATION: Remove deprecated `good_job:` parameter in GoodJob v3
-        ActiveSupport::Notifications.instrument("perform_job.good_job", { good_job: self, execution: self, process_id: current_thread.process_id, thread_name: current_thread.thread_name }) do
+        ActiveSupport::Notifications.instrument("perform_job.good_job", { execution: self, process_id: current_thread.process_id, thread_name: current_thread.thread_name }) do
           value = ActiveJob::Base.execute(active_job_data)
 
           if value.is_a?(Exception)

data/{app/models/good_job/active_job_job.rb → lib/models/good_job/job.rb}

@@ -3,8 +3,8 @@ module GoodJob
   # ActiveRecord model that represents an +ActiveJob+ job.
   # There is not a table in the database whose discrete rows represents "Jobs".
   # The +good_jobs+ table is a table of individual {GoodJob::Execution}s that share the same +active_job_id+.
-  # A single row from the +good_jobs+ table of executions is fetched to represent an ActiveJobJob
-  class ActiveJobJob < BaseRecord
+  # A single row from the +good_jobs+ table of executions is fetched to represent an Job
+  class Job < BaseRecord
     include Filterable
     include Lockable
 
@@ -26,7 +26,7 @@ module GoodJob
     self.primary_key = 'active_job_id'
     self.advisory_lockable_column = 'active_job_id'
 
-    has_many :executions, -> { order(created_at: :asc) }, class_name: 'GoodJob::Execution', foreign_key: 'active_job_id', inverse_of: :job # rubocop:disable Rails/HasManyOrHasOneDependent
+    has_many :executions, -> { order(created_at: :asc) }, class_name: 'GoodJob::Execution', foreign_key: 'active_job_id', inverse_of: :job
 
     # Only the most-recent unretried execution represents a "Job"
     default_scope { where(retried_good_job_id: nil) }
@@ -166,7 +166,7 @@ module GoodJob
 
         raise ActionForStateMismatchError if execution.finished_at.present?
 
-        job_error = GoodJob::ActiveJobJob::DiscardJobError.new(message)
+        job_error = GoodJob::Job::DiscardJobError.new(message)
 
         update_execution = proc do
           execution.update(

data/{app → lib}/models/good_job/process.rb

@@ -25,15 +25,6 @@ module GoodJob # :nodoc:
     # @return [ActiveRecord::Relation]
     scope :inactive, -> { advisory_unlocked }
 
-    # Whether the +good_job_processes+ table exsists.
-    # @return [Boolean]
-    def self.migrated?
-      return true if connection.table_exists?(table_name)
-
-      migration_pending_warning!
-      false
-    end
-
     # UUID that is unique to the current process and changes when forked.
     # @return [String]
     def self.current_id

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 2.17.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Ben Sheldon
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-23 00:00:00.000000000 Z
+date: 2022-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -140,16 +140,16 @@ dependencies:
   name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.35.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.35.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -294,16 +294,16 @@ dependencies:
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.142'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.142'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sigdump
   requirement: !ruby/object:Gem::Requirement
@@ -382,9 +382,6 @@ files:
 - app/filters/good_job/base_filter.rb
 - app/filters/good_job/jobs_filter.rb
 - app/helpers/good_job/application_helper.rb
-- app/models/good_job/active_job_job.rb
-- app/models/good_job/execution.rb
-- app/models/good_job/process.rb
 - app/views/good_job/cron_entries/index.html.erb
 - app/views/good_job/cron_entries/show.html.erb
 - app/views/good_job/jobs/_executions.erb
@@ -417,21 +414,15 @@ files:
 - lib/generators/good_job/install_generator.rb
 - 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_cron_at_to_good_jobs.rb.erb
-- lib/generators/good_job/templates/update/migrations/03_add_cron_key_cron_at_index_to_good_jobs.rb.erb
-- lib/generators/good_job/templates/update/migrations/04_create_good_job_processes.rb.erb
-- lib/generators/good_job/templates/update/migrations/04_index_good_job_jobs_on_finished_at.rb.erb
 - lib/generators/good_job/update_generator.rb
 - lib/good_job.rb
 - lib/good_job/active_job_extensions.rb
 - lib/good_job/active_job_extensions/concurrency.rb
 - lib/good_job/adapter.rb
 - lib/good_job/assignable_connection.rb
-- lib/good_job/base_record.rb
 - lib/good_job/cleanup_tracker.rb
 - lib/good_job/cli.rb
 - lib/good_job/configuration.rb
-- lib/good_job/cron_entry.rb
 - lib/good_job/cron_manager.rb
 - lib/good_job/current_thread.rb
 - lib/good_job/daemon.rb
@@ -439,9 +430,7 @@ files:
 - lib/good_job/engine.rb
 - lib/good_job/execution_result.rb
 - lib/good_job/filterable.rb
-- lib/good_job/job.rb
 - lib/good_job/job_performer.rb
-- lib/good_job/lockable.rb
 - lib/good_job/log_subscriber.rb
 - lib/good_job/multi_scheduler.rb
 - lib/good_job/notifier.rb
@@ -450,6 +439,13 @@ files:
 - lib/good_job/probe_server.rb
 - lib/good_job/scheduler.rb
 - lib/good_job/version.rb
+- lib/models/good_job/active_job_job.rb
+- lib/models/good_job/base_record.rb
+- lib/models/good_job/cron_entry.rb
+- lib/models/good_job/execution.rb
+- lib/models/good_job/job.rb
+- lib/models/good_job/lockable.rb
+- lib/models/good_job/process.rb
 homepage: https://github.com/bensheldon/good_job
 licenses:
 - MIT
@@ -460,7 +456,7 @@ metadata:
   homepage_uri: https://github.com/bensheldon/good_job
   source_code_uri: https://github.com/bensheldon/good_job
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options:
 - "--title"
 - GoodJob - a multithreaded, Postgres-based ActiveJob backend for Ruby on Rails
@@ -482,8 +478,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.16
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: A multithreaded, Postgres-based ActiveJob backend for Ruby on Rails
 test_files: []

data/lib/generators/good_job/templates/update/migrations/02_add_cron_at_to_good_jobs.rb.erb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-class AddCronAtToGoodJobs < ActiveRecord::Migration<%= migration_version %>
-  def change
-    reversible do |dir|
-      dir.up do
-        # Ensure this incremental update migration is idempotent
-        # with monolithic install migration.
-        return if connection.column_exists?(:good_jobs, :cron_at)
-      end
-    end
-
-    add_column :good_jobs, :cron_at, :timestamp
-  end
-end

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

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-class AddCronKeyCronAtIndexToGoodJobs < 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_name_exists?(:good_jobs, :index_good_jobs_on_cron_key_and_cron_at)
-      end
-    end
-
-    add_index :good_jobs,
-              [:cron_key, :cron_at],
-              algorithm: :concurrently,
-              name: :index_good_jobs_on_cron_key_and_cron_at,
-              unique: true
-  end
-end

data/lib/generators/good_job/templates/update/migrations/04_create_good_job_processes.rb.erb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-class CreateGoodJobProcesses < ActiveRecord::Migration<%= migration_version %>
-  def change
-    reversible do |dir|
-      dir.up do
-        # Ensure this incremental update migration is idempotent
-        # with monolithic install migration.
-        return if connection.table_exists?(:good_job_processes)
-      end
-    end
-
-    create_table :good_job_processes, id: :uuid do |t|
-      t.timestamps
-      t.jsonb :state
-    end
-  end
-end

data/lib/generators/good_job/templates/update/migrations/04_index_good_job_jobs_on_finished_at.rb.erb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-class IndexGoodJobJobsOnFinishedAt < 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_name_exists?(:good_jobs, :index_good_jobs_on_active_job_id)
-      end
-    end
-
-    add_index :good_jobs,
-              [:active_job_id],
-              name: :index_good_jobs_on_active_job_id,
-              algorithm: :concurrently
-
-    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,
-              algorithm: :concurrently
-  end
-end

data/lib/good_job/job.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-module GoodJob
-  # @deprecated Use {GoodJob::Execution} instead.
-  class Job < Execution
-    after_initialize do |_job|
-      ActiveSupport::Deprecation.warn(
-        "The `GoodJob::Job` class name is deprecated. Replace with `GoodJob::Execution`."
-      )
-    end
-  end
-end