good_job 2.15.2 → 2.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb6d6387b67811dec6d23e26267a4fe356c42ddc3feb14cb046f57c61c2b5802
-  data.tar.gz: 7ce4090bfeb05c67913f0d6f99fb2517a4370b669fdbfb648a17bfdca3d92efc
+  metadata.gz: 92c29f2bed6e36f449e880b5433c089351c63d1365cdc094b774122202407fb3
+  data.tar.gz: 4125a6cfb9e3c0d3de88bd8cdfb64acb450f8c6072fc2aa6a0907f9b51083add
 SHA512:
-  metadata.gz: b2efda0438bff75e52ab9e390ee3bf33bdbb64b13a4937ed3e58170100b0afd0a0ead5a3b1b9d902548c4356eba1b9f21296bd94f4f84ecd7884ef2b28fa0a09
-  data.tar.gz: d66ebb51d7c83b0b8c77d1300707a5c82df9bdafd1bc91231093ce331d59ff788c9c59539e10f3996664b572dec3b1dab019d01d2855bf497e3b4efd86929616
+  metadata.gz: cd6b4fbce879de227852b9399bbb65739933b50732dfc5be5a3563162c55375d1d366d4796bf163c4d12683a7f03668ef7a80d73e229343debe622c7e7ccd2b1
+  data.tar.gz: 5f4fac41e04a0844b93cc482e24b910e599ccabf411ac6841e7519cb6d573a6d7bb82070f6a35ffc40a1937256f910e9e6995cc5a9090e779c9b2eac33a8d901

data/CHANGELOG.md

@@ -1,5 +1,40 @@
 # Changelog
 
+## [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)
+
+**Merged pull requests:**
+
+- Remove nonexistant `engine/lib` from $LOAD\_PATH [\#629](https://github.com/bensheldon/good_job/pull/629) ([bensheldon](https://github.com/bensheldon))
+- Mention in README that dashboard can't see completed jobs unless they are preserved [\#627](https://github.com/bensheldon/good_job/pull/627) ([jrochkind](https://github.com/jrochkind))
+- Clarify README on default in development [\#623](https://github.com/bensheldon/good_job/pull/623) ([jrochkind](https://github.com/jrochkind))
+- Convert GoodJob into a single mountable engine \(instead of a plugin plus optional engine\) [\#554](https://github.com/bensheldon/good_job/pull/554) ([bensheldon](https://github.com/bensheldon))
+
+## [v2.16.1](https://github.com/bensheldon/good_job/tree/v2.16.1) (2022-06-18)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v2.16.0...v2.16.1)
+
+**Fixed bugs:**
+
+- Fix `:inline` mode with future behavior to run unscheduled jobs immediately [\#620](https://github.com/bensheldon/good_job/pull/620) ([bensheldon](https://github.com/bensheldon))
+
+**Merged pull requests:**
+
+- Version check `Zeitwerk::Loader.new(warn_on_extra_files: false)` flag [\#619](https://github.com/bensheldon/good_job/pull/619) ([bensheldon](https://github.com/bensheldon))
+
+## [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)
+
+**Implemented enhancements:**
+
+- 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))
+
+**Closed issues:**
+
+- Upgrading zeitwerk to 2.6.0 causes a warning related to good\_job [\#616](https://github.com/bensheldon/good_job/issues/616)
+
 ## [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)

data/README.md

@@ -59,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)
@@ -115,7 +116,7 @@ For more of the story of GoodJob, read the [introductory blog post](https://isla
     YourJob.set(queue: :some_queue, wait: 5.minutes, priority: 10).perform_later
     ```
 
-1. In development, GoodJob executes jobs immediately. In production, GoodJob provides different options:
+1. In development, GoodJob executes jobs immediately in a separate thread (async mode). In production, GoodJob provides different options:
 
     - By default, GoodJob separates job enqueuing from job execution so that jobs can be scaled independently of the web server.  Use the GoodJob command-line tool to execute jobs:
 
@@ -276,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`)
@@ -330,19 +332,6 @@ _🚧 GoodJob's dashboard is a work in progress. Please contribute ideas and cod
 
 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 and before Bundler requires the Rails' groups. 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
-    # ...
-    ```
-
-   Note: If you find the dashboard fails to reload due to a routing error and uninitialized constant `GoodJob::ExecutionsController`, this is likely because you are not requiring the engine early enough.
-
 1. Mount the engine in your `config/routes.rb` file. The following will mount it at `http://example.com/good_job`.
 
     ```ruby
@@ -351,7 +340,7 @@ GoodJob includes a Dashboard as a mountable `Rails::Engine`.
     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:
+1. Configure authentication. 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
@@ -371,6 +360,15 @@ GoodJob includes a Dashboard as a mountable `Rails::Engine`.
     end
     ```
 
+1. If you want to see finished (successful) and discarded (failed) jobs on the dashboard, you will have to configure job records to be preserved:
+
+    ```ruby
+    # eg in config/initializers/good_job.rb
+    GoodJob.preserve_job_records = true
+    ```
+
+    See more at [Monitor and preserve worked jobs](#monitor-and-preserve-worked-jobs)
+
 #### 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:
@@ -878,6 +876,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/{lib → app/models}/good_job/active_job_job.rb

@@ -16,7 +16,7 @@ module GoodJob
     DiscardJobError = Class.new(StandardError)
 
     class << self
-      delegate :table_name, to: Execution
+      delegate :table_name, to: GoodJob::Execution
 
       def table_name=(_value)
         raise NotImplementedError, 'Assign GoodJob::Execution.table_name directly'
@@ -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
+    has_many :executions, -> { order(created_at: :asc) }, class_name: 'GoodJob::Execution', foreign_key: 'active_job_id', inverse_of: :job # rubocop:disable Rails/HasManyOrHasOneDependent
 
     # Only the most-recent unretried execution represents a "Job"
     default_scope { where(retried_good_job_id: nil) }

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 && 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/{railtie.rb → engine.rb}

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 module GoodJob
   # Ruby on Rails integration.
-  class Railtie < ::Rails::Railtie
+  class Engine < ::Rails::Engine
+    isolate_namespace GoodJob
+
     config.good_job = ActiveSupport::OrderedOptions.new
     config.good_job.cron = {}
 

data/lib/good_job/version.rb

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

data/lib/good_job.rb

@@ -1,20 +1,18 @@
 # frozen_string_literal: true
-require "rails"
 require "active_job"
 require "active_job/queue_adapters"
 
 require "zeitwerk"
-Zeitwerk::Loader.for_gem.tap do |loader|
+zeitwerk_options = Gem::Version.new(Zeitwerk::VERSION) >= Gem::Version.new("2.6.0") ? { warn_on_extra_files: false } : {}
+Zeitwerk::Loader.for_gem(**zeitwerk_options).tap do |loader|
   loader.inflector.inflect({
                              "cli" => "CLI",
                            })
   loader.ignore("#{__dir__}/generators")
-  loader.ignore("#{__dir__}/active_job")
-  loader.push_dir("#{__dir__}/active_job/queue_adapters", namespace: ActiveJob::QueueAdapters)
   loader.setup
 end
 
-require "good_job/railtie"
+require "good_job/engine"
 
 # GoodJob is a multithreaded, Postgres-based, ActiveJob backend for Ruby on Rails.
 #
@@ -153,6 +151,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.2
+  version: 2.17.0
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-17 00:00:00.000000000 Z
+date: 2022-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -360,56 +360,58 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- engine/app/assets/good_job/modules/application.js
-- engine/app/assets/good_job/modules/charts.js
-- engine/app/assets/good_job/modules/checkbox_toggle.js
-- engine/app/assets/good_job/modules/document_ready.js
-- engine/app/assets/good_job/modules/live_poll.js
-- engine/app/assets/good_job/modules/toasts.js
-- engine/app/assets/good_job/scripts.js
-- engine/app/assets/good_job/style.css
-- engine/app/assets/good_job/vendor/bootstrap/bootstrap.bundle.min.js
-- engine/app/assets/good_job/vendor/bootstrap/bootstrap.min.css
-- engine/app/assets/good_job/vendor/chartjs/chart.min.js
-- engine/app/assets/good_job/vendor/es_module_shims.js
-- engine/app/assets/good_job/vendor/rails_ujs.js
-- engine/app/charts/good_job/scheduled_by_queue_chart.rb
-- engine/app/controllers/good_job/application_controller.rb
-- engine/app/controllers/good_job/assets_controller.rb
-- engine/app/controllers/good_job/cron_entries_controller.rb
-- engine/app/controllers/good_job/jobs_controller.rb
-- engine/app/controllers/good_job/processes_controller.rb
-- engine/app/filters/good_job/base_filter.rb
-- engine/app/filters/good_job/jobs_filter.rb
-- engine/app/helpers/good_job/application_helper.rb
-- engine/app/views/good_job/cron_entries/index.html.erb
-- engine/app/views/good_job/cron_entries/show.html.erb
-- engine/app/views/good_job/jobs/_executions.erb
-- engine/app/views/good_job/jobs/_table.erb
-- engine/app/views/good_job/jobs/index.html.erb
-- engine/app/views/good_job/jobs/show.html.erb
-- engine/app/views/good_job/processes/index.html.erb
-- engine/app/views/good_job/shared/_alert.erb
-- engine/app/views/good_job/shared/_chart.erb
-- engine/app/views/good_job/shared/_filter.erb
-- engine/app/views/good_job/shared/_footer.erb
-- engine/app/views/good_job/shared/_navbar.erb
-- engine/app/views/good_job/shared/icons/_arrow_clockwise.html.erb
-- engine/app/views/good_job/shared/icons/_check.html.erb
-- engine/app/views/good_job/shared/icons/_clock.html.erb
-- engine/app/views/good_job/shared/icons/_dash_circle.html.erb
-- engine/app/views/good_job/shared/icons/_exclamation.html.erb
-- engine/app/views/good_job/shared/icons/_play.html.erb
-- engine/app/views/good_job/shared/icons/_skip_forward.html.erb
-- engine/app/views/good_job/shared/icons/_stop.html.erb
-- engine/app/views/good_job/shared/icons/_trash.html.erb
-- engine/app/views/layouts/good_job/application.html.erb
-- engine/config/locales/en.yml
-- engine/config/locales/es.yml
-- engine/config/locales/nl.yml
-- engine/config/locales/ru.yml
-- engine/config/routes.rb
-- engine/lib/good_job/engine.rb
+- app/assets/good_job/modules/application.js
+- app/assets/good_job/modules/charts.js
+- app/assets/good_job/modules/checkbox_toggle.js
+- app/assets/good_job/modules/document_ready.js
+- app/assets/good_job/modules/live_poll.js
+- app/assets/good_job/modules/toasts.js
+- app/assets/good_job/scripts.js
+- app/assets/good_job/style.css
+- app/assets/good_job/vendor/bootstrap/bootstrap.bundle.min.js
+- app/assets/good_job/vendor/bootstrap/bootstrap.min.css
+- app/assets/good_job/vendor/chartjs/chart.min.js
+- app/assets/good_job/vendor/es_module_shims.js
+- app/assets/good_job/vendor/rails_ujs.js
+- app/charts/good_job/scheduled_by_queue_chart.rb
+- app/controllers/good_job/application_controller.rb
+- app/controllers/good_job/assets_controller.rb
+- app/controllers/good_job/cron_entries_controller.rb
+- app/controllers/good_job/jobs_controller.rb
+- app/controllers/good_job/processes_controller.rb
+- 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
+- app/views/good_job/jobs/_table.erb
+- app/views/good_job/jobs/index.html.erb
+- app/views/good_job/jobs/show.html.erb
+- app/views/good_job/processes/index.html.erb
+- app/views/good_job/shared/_alert.erb
+- app/views/good_job/shared/_chart.erb
+- app/views/good_job/shared/_filter.erb
+- app/views/good_job/shared/_footer.erb
+- app/views/good_job/shared/_navbar.erb
+- app/views/good_job/shared/icons/_arrow_clockwise.html.erb
+- app/views/good_job/shared/icons/_check.html.erb
+- app/views/good_job/shared/icons/_clock.html.erb
+- app/views/good_job/shared/icons/_dash_circle.html.erb
+- app/views/good_job/shared/icons/_exclamation.html.erb
+- app/views/good_job/shared/icons/_play.html.erb
+- app/views/good_job/shared/icons/_skip_forward.html.erb
+- app/views/good_job/shared/icons/_stop.html.erb
+- app/views/good_job/shared/icons/_trash.html.erb
+- app/views/layouts/good_job/application.html.erb
+- config/locales/en.yml
+- config/locales/es.yml
+- config/locales/nl.yml
+- config/locales/ru.yml
+- config/routes.rb
 - exe/good_job
 - lib/active_job/queue_adapters/good_job_adapter.rb
 - lib/generators/good_job/install_generator.rb
@@ -423,7 +425,6 @@ files:
 - lib/good_job.rb
 - lib/good_job/active_job_extensions.rb
 - lib/good_job/active_job_extensions/concurrency.rb
-- lib/good_job/active_job_job.rb
 - lib/good_job/adapter.rb
 - lib/good_job/assignable_connection.rb
 - lib/good_job/base_record.rb
@@ -435,7 +436,7 @@ files:
 - lib/good_job/current_thread.rb
 - lib/good_job/daemon.rb
 - lib/good_job/dependencies.rb
-- lib/good_job/execution.rb
+- lib/good_job/engine.rb
 - lib/good_job/execution_result.rb
 - lib/good_job/filterable.rb
 - lib/good_job/job.rb
@@ -447,8 +448,6 @@ files:
 - lib/good_job/notifier/process_registration.rb
 - lib/good_job/poller.rb
 - lib/good_job/probe_server.rb
-- lib/good_job/process.rb
-- lib/good_job/railtie.rb
 - lib/good_job/scheduler.rb
 - lib/good_job/version.rb
 homepage: https://github.com/bensheldon/good_job
@@ -472,7 +471,6 @@ rdoc_options:
 - "--quiet"
 require_paths:
 - lib
-- engine/lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -484,7 +482,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.3.16
 signing_key:
 specification_version: 4
 summary: A multithreaded, Postgres-based ActiveJob backend for Ruby on Rails

data/engine/lib/good_job/engine.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-module GoodJob
-  class Engine < ::Rails::Engine
-    isolate_namespace GoodJob
-  end
-end