good_job 2.16.0 → 2.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1811646b013e9432de87917a2be838ee634902b22ecc942bae74a7fefab82487
-  data.tar.gz: 14a301ce871b2761484d1c40d71dc76a64ce40131b6c4f3ff5573c1a2201ee58
+  metadata.gz: 869350074426db7d14fdf229402edf5f86be6eccb0403c160f464e36844586dd
+  data.tar.gz: 972188f8afb342c260b3c5417988ece4a0d2a42dfcaf42da18b72a8a472f24a4
 SHA512:
-  metadata.gz: f719e920a42b626b022ea6e90572344a660adf9fac9978fcde0ae98abbb0433d89a32af25f51e14a7250ffa2ffb128accc95fce9121630cc178b957f114e2fdf
-  data.tar.gz: 83265d3360d14d249303179d5ef506e39709ddf9fbbc87df99b42e5b6057d1e9acc0a59712e8b82f0d79df69b868a26b0f5de9ebf0e1adac2e421f0b1288b94f
+  metadata.gz: e25f2531c4e6310304e3152a9e93291f0daa158ae78c2937a59d0a680abe705ba063b510cc1680cf1c856f45112789365fed8ddf9d15cf46eabb62afd5c9770d
+  data.tar.gz: d35c3de5c5bdb857af39e17376500792e017ba66dea78ab0da21c37635cf37ea1af1af36af3d6dd0bd19328d2a8fea0ff01765d841fce9c3b5ed1b9b8090a74f

data/CHANGELOG.md

@@ -1,17 +1,57 @@
 # Changelog
 
-## [v2.16.0](https://github.com/bensheldon/good_job/tree/v2.16.0) (2022-06-17)
+## [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.15.2...v2.16.0)
+[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:**
 
-- Upgrading zeitwerk to 2.6.0 causes a warning related to good\_job [\#616](https://github.com/bensheldon/good_job/issues/616)
+- 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)
+
+**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

@@ -116,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:
 
@@ -332,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
@@ -353,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
@@ -373,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:

data/lib/good_job/adapter.rb

@@ -65,7 +65,7 @@ module GoodJob
       scheduled_at = timestamp ? Time.zone.at(timestamp) : nil
 
       if execute_inline?
-        future_scheduled = (scheduled_at.nil? || scheduled_at > Time.current)
+        future_scheduled = scheduled_at && scheduled_at > Time.current
         will_execute_inline = !future_scheduled || (future_scheduled && !@configuration.inline_execution_respects_schedule?)
       end
 

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.16.0'
+  VERSION = '2.17.1'
 end

data/lib/good_job.rb

@@ -1,20 +1,19 @@
 # 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.push_dir("#{__dir__}/models")
   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.
 #

data/lib/{good_job → 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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 2.16.0
+  version: 2.17.1
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-17 00:00:00.000000000 Z
+date: 2022-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -360,56 +360,55 @@ 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/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,10 +422,8 @@ 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
 - lib/good_job/cleanup_tracker.rb
 - lib/good_job/cli.rb
 - lib/good_job/configuration.rb
@@ -435,7 +432,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,10 +444,12 @@ 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
+- lib/models/good_job/active_job_job.rb
+- lib/models/good_job/base_record.rb
+- lib/models/good_job/execution.rb
+- lib/models/good_job/process.rb
 homepage: https://github.com/bensheldon/good_job
 licenses:
 - MIT
@@ -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