good_job 1.2.5 → 1.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca2673887424565881a47ad6eaf9300b6281e43c87066f01ceb899b76716d43e
-  data.tar.gz: 6a0f749171316300ebfc7257d1d62efc330092391f026d6f50e20ccda5fee208
+  metadata.gz: 7bb8c33f26176b048399e596b7c4c5dcb10553209b9237fe6256e7af66b1ffcc
+  data.tar.gz: b401649bfe1dee5f83575e82cb2703407c2ddc367dabaabc05f41d9f79e4315d
 SHA512:
-  metadata.gz: 4fcef37d707e0d25f44965949abfeba914a4ee9f743ed32498e28df95751f666bdfb942c12049b23d78ff2b52e14465ca1cda2007bfae3541f9f0c53e6f74964
-  data.tar.gz: db7d224567bde1427210638226d5005dd279a2c73c97ff9c19eb40edc523ae7863973cccf7d263a08dcf56ec66fd112a492afa269dad4b12cc70b79027baf296
+  metadata.gz: d38c25e5f61a8d6509f323509ecd5e0fb49a31466b58a3eae47a5614b0e56f3b30a90725d8e57dc0d170a1cda635cb49850cc98d6b4c1c4033c8a65db691af8c
+  data.tar.gz: 31add663e7307890b66f89e14b5ea164c9c67252c695db50f0d761921308019fcf7874984db7f263ae67557d1538f6b25d15271ca9880190b6faf13dc29346f8

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## [v1.2.6](https://github.com/bensheldon/good_job/tree/v1.2.6) (2020-09-29)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v1.2.5...v1.2.6)
+
+**Implemented enhancements:**
+
+- Preserve only failed jobs [\#136](https://github.com/bensheldon/good_job/issues/136)
+- Add `GoodJob.preserve\_job\_records = :on\_unhandled\_error` option to only preserve jobs that errored [\#145](https://github.com/bensheldon/good_job/pull/145) ([morgoth](https://github.com/morgoth))
+
+**Fixed bugs:**
+
+- Fix LogSubscriber notifications for finished\_timer\_task and finished\_job\_task [\#148](https://github.com/bensheldon/good_job/pull/148) ([bensheldon](https://github.com/bensheldon))
+
+**Closed issues:**
+
+- run-once guarantee? [\#151](https://github.com/bensheldon/good_job/issues/151)
+
+**Merged pull requests:**
+
+- Add info how to setup basic auth for engine [\#153](https://github.com/bensheldon/good_job/pull/153) ([morgoth](https://github.com/morgoth))
+- Add documentation for Dashboard Rails::Engine [\#149](https://github.com/bensheldon/good_job/pull/149) ([bensheldon](https://github.com/bensheldon))
+- Style cleanup to Job error handling [\#147](https://github.com/bensheldon/good_job/pull/147) ([bensheldon](https://github.com/bensheldon))
+- Replace gerund titles in Readme [\#146](https://github.com/bensheldon/good_job/pull/146) ([bensheldon](https://github.com/bensheldon))
+- Only allow Scheduler to be initialized with max\_threads and poll\_interval; remove full access to pool and timer\_task options [\#137](https://github.com/bensheldon/good_job/pull/137) ([bensheldon](https://github.com/bensheldon))
+
 ## [v1.2.5](https://github.com/bensheldon/good_job/tree/v1.2.5) (2020-09-17)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v1.2.4...v1.2.5)
@@ -7,10 +32,15 @@
 **Implemented enhancements:**
 
 - Use Zeitwerk for auto-loading [\#87](https://github.com/bensheldon/good_job/issues/87)
+- Spike on data dashboard; pull in full Bootstrap CSS and JS [\#131](https://github.com/bensheldon/good_job/pull/131) ([bensheldon](https://github.com/bensheldon))
 
 **Fixed bugs:**
 
 - `poll-interval=-1` does not disable polling as intended [\#133](https://github.com/bensheldon/good_job/issues/133)
+- Update Gemspec to reflect that GoodJob is not compatible with Rails 5.1 [\#143](https://github.com/bensheldon/good_job/pull/143) ([bensheldon](https://github.com/bensheldon))
+- Prevent jobs hanging [\#141](https://github.com/bensheldon/good_job/pull/141) ([morgoth](https://github.com/morgoth))
+- Add explicit require\_paths to gemspec for engine [\#134](https://github.com/bensheldon/good_job/pull/134) ([bensheldon](https://github.com/bensheldon))
+- Use `connection.quote\_table\_name` and add spacing for SQL concatenation [\#124](https://github.com/bensheldon/good_job/pull/124) ([bensheldon](https://github.com/bensheldon))
 
 **Closed issues:**
 
@@ -21,17 +51,12 @@
 **Merged pull requests:**
 
 - Test GoodJob against Rails HEAD [\#144](https://github.com/bensheldon/good_job/pull/144) ([bensheldon](https://github.com/bensheldon))
-- Update Gemspec to reflect that GoodJob is not compatible with Rails 5.1 [\#143](https://github.com/bensheldon/good_job/pull/143) ([bensheldon](https://github.com/bensheldon))
 - Drop Ruby 2.4 support [\#142](https://github.com/bensheldon/good_job/pull/142) ([morgoth](https://github.com/morgoth))
-- Prevent jobs hanging [\#141](https://github.com/bensheldon/good_job/pull/141) ([morgoth](https://github.com/morgoth))
 - Remove arguments from perform method [\#140](https://github.com/bensheldon/good_job/pull/140) ([morgoth](https://github.com/morgoth))
 - Extract "execute" method to reduce "perform" method complexity [\#138](https://github.com/bensheldon/good_job/pull/138) ([morgoth](https://github.com/morgoth))
 - Correct example on how to configure multiple queues by command line. [\#135](https://github.com/bensheldon/good_job/pull/135) ([morgoth](https://github.com/morgoth))
-- Add explicit require\_paths to gemspec for engine [\#134](https://github.com/bensheldon/good_job/pull/134) ([bensheldon](https://github.com/bensheldon))
-- Spike on data dashboard; pull in full Bootstrap CSS and JS [\#131](https://github.com/bensheldon/good_job/pull/131) ([bensheldon](https://github.com/bensheldon))
 - Update ActionMailer Job class, to match the default [\#130](https://github.com/bensheldon/good_job/pull/130) ([morgoth](https://github.com/morgoth))
 - Add initial Engine scaffold [\#125](https://github.com/bensheldon/good_job/pull/125) ([bensheldon](https://github.com/bensheldon))
-- Use `connection.quote\_table\_name` and add spacing for SQL concatenation [\#124](https://github.com/bensheldon/good_job/pull/124) ([bensheldon](https://github.com/bensheldon))
 - Zeitwerk Loader Implementation [\#123](https://github.com/bensheldon/good_job/pull/123) ([gadimbaylisahil](https://github.com/gadimbaylisahil))
 - Update code-level documentation [\#111](https://github.com/bensheldon/good_job/pull/111) ([bensheldon](https://github.com/bensheldon))
 
@@ -42,6 +67,11 @@
 **Implemented enhancements:**
 
 - Add environment variable to mirror `cleanup\_preserved\_jobs --before-seconds-ago=SECONDS` [\#110](https://github.com/bensheldon/good_job/issues/110)
+- Allow env variable config for cleanups [\#114](https://github.com/bensheldon/good_job/pull/114) ([gadimbaylisahil](https://github.com/gadimbaylisahil))
+
+**Fixed bugs:**
+
+- Better table name detection for Job queries [\#119](https://github.com/bensheldon/good_job/pull/119) ([gadimbaylisahil](https://github.com/gadimbaylisahil))
 
 **Closed issues:**
 
@@ -52,9 +82,7 @@
 **Merged pull requests:**
 
 - Remove unused PgLocks class [\#120](https://github.com/bensheldon/good_job/pull/120) ([gadimbaylisahil](https://github.com/gadimbaylisahil))
-- Better table name detection for Job queries [\#119](https://github.com/bensheldon/good_job/pull/119) ([gadimbaylisahil](https://github.com/gadimbaylisahil))
 - Fix readme CommandLine option links [\#115](https://github.com/bensheldon/good_job/pull/115) ([gadimbaylisahil](https://github.com/gadimbaylisahil))
-- Allow env variable config for cleanups [\#114](https://github.com/bensheldon/good_job/pull/114) ([gadimbaylisahil](https://github.com/gadimbaylisahil))
 - Have YARD render markdown files with GFM \(Github Flavored Markdown\) [\#113](https://github.com/bensheldon/good_job/pull/113) ([bensheldon](https://github.com/bensheldon))
 - Add markdownlint to lint readme [\#109](https://github.com/bensheldon/good_job/pull/109) ([bensheldon](https://github.com/bensheldon))
 - Remove unused method in PgLocks [\#107](https://github.com/bensheldon/good_job/pull/107) ([gadimbaylisahil](https://github.com/gadimbaylisahil))
@@ -354,7 +382,6 @@
 - Add pg gem as explicit dependency [\#13](https://github.com/bensheldon/good_job/pull/13) ([bensheldon](https://github.com/bensheldon))
 - Bump nokogiri from 1.10.7 to 1.10.9 [\#12](https://github.com/bensheldon/good_job/pull/12) ([dependabot[bot]](https://github.com/apps/dependabot))
 - Add Appraisal with tests for Rails 5.1, 5.2, 6.0 [\#11](https://github.com/bensheldon/good_job/pull/11) ([bensheldon](https://github.com/bensheldon))
-- Use Rails.logger and ActiveSupport::Notifications for logging instead of puts [\#10](https://github.com/bensheldon/good_job/pull/10) ([bensheldon](https://github.com/bensheldon))
 
 ## [v0.2.0](https://github.com/bensheldon/good_job/tree/v0.2.0) (2020-03-06)
 
@@ -362,6 +389,7 @@
 
 **Merged pull requests:**
 
+- Use Rails.logger and ActiveSupport::Notifications for logging instead of puts [\#10](https://github.com/bensheldon/good_job/pull/10) ([bensheldon](https://github.com/bensheldon))
 - Remove minitest files [\#9](https://github.com/bensheldon/good_job/pull/9) ([bensheldon](https://github.com/bensheldon))
 - Use scheduled\_at and priority for scheduling [\#8](https://github.com/bensheldon/good_job/pull/8) ([bensheldon](https://github.com/bensheldon))
 - Create Github Action workflow for PRs and Issues [\#7](https://github.com/bensheldon/good_job/pull/7) ([bensheldon](https://github.com/bensheldon))

data/README.md

@@ -33,7 +33,8 @@ For more of the story of GoodJob, read the [introductory blog post](https://isla
         - [`good_job cleanup_preserved_jobs`](#good_job-cleanup_preserved_jobs)
     - [Adapter options](#adapter-options)
     - [Global options](#global-options)
-- [Going deeper](#going-deeper)
+    - [Dashboard](#dashboard)
+- [Go deeper](#go-deeper)
     - [Exceptions, retries, and reliability](#exceptions-retries-and-reliability)
         - [Exceptions](#exceptions)
         - [Retries](#retries)
@@ -41,12 +42,12 @@ For more of the story of GoodJob, read the [introductory blog post](https://isla
     - [Timeouts](#timeouts)
     - [Optimize queues, threads, and processes](#optimize-queues-threads-and-processes)
     - [Database connections](#database-connections)
-    - [Executing jobs async / in-process](#executing-jobs-async--in-process)
-    - [Migrating to GoodJob from a different ActiveJob backend](#migrating-to-goodjob-from-a-different-activejob-backend)
-    - [Monitoring and preserving worked jobs](#monitoring-and-preserving-worked-jobs)
-- [Contributing](#contributing)
+    - [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)
+- [Contribute](#contribute)
     - [Gem development](#gem-development)
-    - [Releasing](#releasing)
+    - [Release](#release)
 - [License](#license)
 
 ## Set up
@@ -221,7 +222,52 @@ GoodJob.reperform_jobs_on_standard_error = false
 GoodJob.on_thread_error = -> (exception) { Raven.capture_exception(exception) }
 ```
 
-## Going deeper
+### Dashboard
+
+_🚧 GoodJob's dashboard is a work in progress. Please contribute ideas and code on [Github](https://github.com/bensheldon/good_job/issues)._
+
+GoodJob includes a Dashboard as a mountable `Rails::Engine`.
+
+1. Explicitly require the Engine code at the top of your `config/application.rb` file, immediately after Rails is required. This is necessary because the mountable engine is an optional feature of GoodJob.
+
+    ```ruby
+    # config/application.rb
+    require_relative 'boot'
+
+    require 'rails/all'
+    require 'good_job/engine' # <= Add this line
+    # ...
+    ```
+
+1. Mount the engine in your `config/routes.rb` file. The following will mount it at `http://example.com/good_job`.
+
+    ```ruby
+    # config/routes.rb
+    # ...
+    mount GoodJob::Engine => 'good_job'
+    ```
+
+    Because jobs can potentially contain sensitive information, you should authorize access. For example, using Devise's `authenticate` helper, that might look like:
+
+    ```ruby
+    # config/routes.rb
+    # ...
+    authenticate :user, ->(user) { user.admin? } do
+      mount GoodJob::Engine => 'good_job'
+    end
+    ```
+
+    Another option is using basic auth like this:
+
+    ```ruby
+    # config/initializers/good_job.rb
+    GoodJob::Engine.middleware.use(Rack::Auth::Basic) do |username, password|
+      ActiveSupport::SecurityUtils.secure_compare(Rails.application.credentials.good_job_username, username) &&
+        ActiveSupport::SecurityUtils.secure_compare(Rails.application.credentials.good_job_password, password)
+    end
+    ```
+
+## Go deeper
 
 ### Exceptions, retries, and reliability
 
@@ -380,7 +426,7 @@ Each GoodJob execution thread requires its own database connection that is autom
 pool: <%= [ENV.fetch("RAILS_MAX_THREADS", 5).to_i, ENV.fetch("GOOD_JOB_MAX_THREADS", 4).to_i].max %>
 ```
 
-### Executing jobs async / in-process
+### Execute jobs async / in-process
 
 GoodJob can execute jobs "async" in the same process as the webserver (e.g. `bin/rail s`). GoodJob's async execution mode offers benefits of economy by not requiring a separate job worker process, but with the tradeoff of increased complexity. Async mode can be configured in two ways:
 
@@ -431,7 +477,7 @@ Depending on your application configuration, you may need to take additional ste
 
   GoodJob is compatible with Puma's `preload_app!` method.
 
-### Migrating to GoodJob from a different ActiveJob backend
+### Migrate to GoodJob from a different ActiveJob backend
 
 If your application is already using an ActiveJob backend, you will need to install GoodJob to enqueue and perform newly created jobs _and_ finish performing pre-existing jobs on the previous backend.
 
@@ -455,7 +501,7 @@ If your application is already using an ActiveJob backend, you will need to inst
 
 1. Once you are confident that no unperformed jobs remain in the previous ActiveJob backend, code and configuration for that backend can be completely removed.
 
-### Monitoring and preserving worked jobs
+### Monitor and preserve worked jobs
 
 GoodJob is fully instrumented with [`ActiveSupport::Notifications`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#introduction-to-instrumentation).
 
@@ -482,7 +528,7 @@ It is also necessary to delete these preserved jobs from the database after a ce
     $ bundle exec good_job cleanup_preserved_jobs --before-seconds-ago=86400
     ```
 
-## Contributing
+## Contribute
 
 Contributions are welcomed and appreciated 🙏
 
@@ -527,7 +573,7 @@ $ bundle install
 # => Using good_job 0.1.0 from https://github.com/bensheldon/good_job.git (at /Users/You/Projects/good_job@dc57fb0)
 ```
 
-### Releasing
+### Release
 
 Package maintainers can release this gem by running:
 

data/engine/app/views/layouts/good_job/base.html.erb

@@ -27,23 +27,34 @@
       <div class="collapse navbar-collapse" id="navbarSupportedContent">
         <ul class="navbar-nav mr-auto">
           <li class="nav-item">
-            <%= link_to "All jobs", root_path, class: ["nav-link", ("active" if current_page?(root_path))] %>
-          </li>
-          <li class="nav-item">
-            <%= link_to "Upcoming Jobs", 'todo', class: ["nav-link", ("active" if current_page?('todo'))] %>
-          </li>
-          <li class="nav-item">
-            <%= link_to "Finished Jobs", 'todo', class: ["nav-link", ("active" if current_page?('todo'))] %>
-          </li>
-          <li class="nav-item">
-            <%= link_to "Errored Jobs", 'todo', class: ["nav-link", ("active" if current_page?('todo'))] %>
+            <%= link_to root_path, class: ["nav-link", ("active" if current_page?(root_path))] do %>
+              All jobs <span class="badge badge-secondary">More views coming soon</span>
+            <% end %>
           </li>
+
+          <!-- Coming Soon
+            <li class="nav-item">
+              <%= link_to "Upcoming Jobs", 'todo', class: ["nav-link", ("active" if current_page?('todo'))] %>
+            </li>
+            <li class="nav-item">
+              <%= link_to "Finished Jobs", 'todo', class: ["nav-link", ("active" if current_page?('todo'))] %>
+            </li>
+            <li class="nav-item">
+              <%= link_to "Errored Jobs", 'todo', class: ["nav-link", ("active" if current_page?('todo'))] %>
+            </li>
+          -->
         </ul>
       </div>
     </div>
   </nav>
 
   <div class="container">
+    <div class="card border-warning text-dark my-3">
+      <div class="card-body">
+        <p class="card-text">🚧 GoodJob's dashboard is a work in progress. Please contribute ideas and code on <a href="https://github.com/bensheldon/good_job/issues" target="_blank" rel="nofollow noopener noreferrer">Github</a>.</p>
+      </div>
+    </div>
+
     <%= yield %>
   </div>
 </body>

data/lib/good_job.rb

@@ -32,6 +32,7 @@ module GoodJob
   #   Whether to preserve job records in the database after they have finished (default: +false+).
   #   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.
   #   @return [Boolean]
   mattr_accessor :preserve_job_records, default: false

data/lib/good_job/configuration.rb

@@ -5,6 +5,13 @@ module GoodJob
   # set options to get the final values for each option.
   #
   class Configuration
+    # Default number of threads to use per {Scheduler}
+    DEFAULT_MAX_THREADS = 5
+    # Default number of seconds between polls for jobs
+    DEFAULT_POLL_INTERVAL = 1
+    # Default number of seconds to preserve jobs for {CLI#cleanup_preserved_jobs}
+    DEFAULT_CLEANUP_PRESERVED_JOBS_BEFORE_SECONDS_AGO = 24 * 60 * 60
+
     # @!attribute [r] options
     #   The options that were explicitly set when initializing +Configuration+.
     #   @return [Hash]
@@ -69,7 +76,7 @@ module GoodJob
         options[:max_threads] ||
         env['GOOD_JOB_MAX_THREADS'] ||
         env['RAILS_MAX_THREADS'] ||
-        ActiveRecord::Base.connection_pool.size
+        DEFAULT_MAX_THREADS
       ).to_i
     end
 
@@ -92,7 +99,7 @@ module GoodJob
       (
         options[:poll_interval] ||
         env['GOOD_JOB_POLL_INTERVAL'] ||
-        1
+        DEFAULT_POLL_INTERVAL
       ).to_i
     end
 
@@ -100,7 +107,7 @@ module GoodJob
       (
         options[:before_seconds_ago] ||
         env['GOOD_JOB_CLEANUP_PRESERVED_JOBS_BEFORE_SECONDS_AGO'] ||
-        24 * 60 * 60
+        DEFAULT_CLEANUP_PRESERVED_JOBS_BEFORE_SECONDS_AGO
       ).to_i
     end
   end

data/lib/good_job/job.rb

@@ -189,37 +189,31 @@ module GoodJob
       self.performed_at = Time.current
       save! if GoodJob.preserve_job_records
 
-      result, rescued_error = execute
+      result, unhandled_error = execute
 
-      retry_or_discard_error = GoodJob::CurrentExecution.error_on_retry ||
-                               GoodJob::CurrentExecution.error_on_discard
-
-      error = nil
-      if rescued_error
-        error = rescued_error
-      elsif result.is_a?(Exception)
-        error = result
+      result_error = nil
+      if result.is_a?(Exception)
+        result_error = result
         result = nil
-      elsif retry_or_discard_error
-        error = retry_or_discard_error
       end
 
-      error_message = "#{error.class}: #{error.message}" if error
-      self.error = error_message
+      job_error = unhandled_error ||
+                  result_error ||
+                  GoodJob::CurrentExecution.error_on_retry ||
+                  GoodJob::CurrentExecution.error_on_discard
 
-      if rescued_error && GoodJob.reperform_jobs_on_standard_error
+      self.error = "#{job_error.class}: #{job_error.message}" if job_error
+
+      if unhandled_error && GoodJob.reperform_jobs_on_standard_error
         save!
-      else
+      elsif GoodJob.preserve_job_records == true || (unhandled_error && GoodJob.preserve_job_records == :on_unhandled_error)
         self.finished_at = Time.current
-
-        if GoodJob.preserve_job_records
-          save!
-        else
-          destroy!
-        end
+        save!
+      else
+        destroy!
       end
 
-      [result, error]
+      [result, job_error]
     end
 
     private

data/lib/good_job/log_subscriber.rb

@@ -25,8 +25,7 @@ module GoodJob
     end
 
     # @macro notification_responder
-    def timer_task_finished(event)
-      # FIXME: This method does not match any good_job notifications.
+    def finished_timer_task(event)
       exception = event.payload[:error]
       return unless exception
 
@@ -36,8 +35,7 @@ module GoodJob
     end
 
     # @macro notification_responder
-    def job_finished(event)
-      # FIXME: This method does not match any good_job notifications.
+    def finished_job_task(event)
       exception = event.payload[:error]
       return unless exception
 

data/lib/good_job/scheduler.rb

@@ -14,26 +14,26 @@ module GoodJob # :nodoc:
   # The scheduler maintains an instance of +Concurrent::TimerTask+, which wakes sleeping threads and causes them to check whether the performer has new work.
   #
   class Scheduler
-    # Defaults for instance of Concurrent::TimerTask.
-    # The timer controls how and when sleeping threads check for new work.
-    DEFAULT_TIMER_OPTIONS = {
-      execution_interval: 1,
-      timeout_interval: 1,
-      run_now: true,
-    }.freeze
-
     # Defaults for instance of Concurrent::ThreadPoolExecutor
     # The thread pool is where work is performed.
     DEFAULT_POOL_OPTIONS = {
       name: name,
       min_threads: 0,
-      max_threads: Concurrent.processor_count,
+      max_threads: Configuration::DEFAULT_MAX_THREADS,
       auto_terminate: true,
       idletime: 60,
       max_queue: -1,
       fallback_policy: :discard,
     }.freeze
 
+    # Defaults for instance of Concurrent::TimerTask.
+    # The timer controls how and when sleeping threads check for new work.
+    DEFAULT_TIMER_OPTIONS = {
+      execution_interval: Configuration::DEFAULT_POLL_INTERVAL,
+      timeout_interval: 1,
+      run_now: true,
+    }.freeze
+
     # @!attribute [r] instances
     #   @!scope class
     #   List of all instantiated Schedulers in the current process.
@@ -62,14 +62,7 @@ module GoodJob # :nodoc:
         end
         job_performer = GoodJob::Performer.new(job_query, :perform_with_advisory_lock, name: queue_string, filter: job_filter)
 
-        timer_options = {}
-        timer_options[:execution_interval] = configuration.poll_interval
-
-        pool_options = {
-          max_threads: max_threads,
-        }
-
-        GoodJob::Scheduler.new(job_performer, timer_options: timer_options, pool_options: pool_options)
+        GoodJob::Scheduler.new(job_performer, max_threads: max_threads, poll_interval: configuration.poll_interval)
       end
 
       if schedulers.size > 1
@@ -80,18 +73,20 @@ module GoodJob # :nodoc:
     end
 
     # @param performer [GoodJob::Performer]
-    # @param timer_options [Hash] Options to instantiate a Concurrent::TimerTask
-    # @param pool_options [Hash] Options to instantiate a Concurrent::ThreadPoolExecutor
-    def initialize(performer, timer_options: {}, pool_options: {})
-      # TODO: Replace `timer_options` and `pool_options` with only `poll_interval` and `max_threads`
+    # @param max_threads [Numeric, nil] the number of execution threads to use
+    # @param poll_interval [Numeric, nil] the number of seconds between polls for jobs
+    def initialize(performer, max_threads: nil, poll_interval: nil)
       raise ArgumentError, "Performer argument must implement #next" unless performer.respond_to?(:next)
 
       self.class.instances << self
 
       @performer = performer
-      @pool_options = DEFAULT_POOL_OPTIONS.merge(pool_options)
-      @timer_options = DEFAULT_TIMER_OPTIONS.merge(timer_options)
 
+      @timer_options = DEFAULT_TIMER_OPTIONS.dup
+      @timer_options[:execution_interval] = poll_interval if poll_interval.present?
+
+      @pool_options = DEFAULT_POOL_OPTIONS.dup
+      @pool_options[:max_threads] = max_threads if max_threads.present?
       @pool_options[:name] = "GoodJob::Scheduler(queues=#{@performer.name} max_threads=#{@pool_options[:max_threads]} poll_interval=#{@timer_options[:execution_interval]})"
 
       create_pools

data/lib/good_job/version.rb

@@ -1,4 +1,4 @@
 module GoodJob
   # GoodJob gem version.
-  VERSION = '1.2.5'.freeze
+  VERSION = '1.2.6'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 1.2.5
+  version: 1.2.6
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-17 00:00:00.000000000 Z
+date: 2020-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob