good_job 2.16.1 → 2.99.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f37fb872be59c7ead625a1ff54ad50d39206209c87bf11f8a88bd7f2f484676
-  data.tar.gz: 50c80eebdd8654894ad26ed052fa0ddfedac8dd30e100e260541d0b1d21d6951
+  metadata.gz: 2a19a18e7245448f7f44c99a492f4ca08f311cc96da9a50f4ba4d7b704685017
+  data.tar.gz: 07330c1a31b873b172066d9e7946b0184b250f7276fe041617c378b35ce8beca
 SHA512:
-  metadata.gz: c6aff64526dcc2989f14e6a7b4fe1a5be5a13df166a13c2055f10eada589f0f8d9586be7a98be94e4e16f81c55524c260cb28b52771a8f8a62064553fa426b5e
-  data.tar.gz: 4f64c31ecf4ff9149d35c0611b1d04158ec7ee1f92cefcbce831f1c442d551d7f406a818d4a111b7c4e848d2ecf15f66dd0968d6224f5d51c2a65394075b3237
+  metadata.gz: 7a38a4a1bc73cf7378f24850b1e58b9b7cf6fbf83ef7aff8fcdba7d2c77ce782e273a3bc946efcf21d98157523b68183bb36efcbd570d253eab73cc7e8542c99
+  data.tar.gz: c97a8235d5b0041237909d6bb551bcccf2de5a4e2fa07bbbb12496a245aa6c4408896baa2a752b0a9f3eb6a1eb037189baa68e6d9979b57ef640e08750609d27

data/CHANGELOG.md

@@ -1,25 +1,72 @@
 # Changelog
 
+## [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)
+
+**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)
 
-**Merged pull requests:**
+**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)
 
-**Closed issues:**
+**Implemented enhancements:**
 
-- Upgrading zeitwerk to 2.6.0 causes a warning related to good\_job [\#616](https://github.com/bensheldon/good_job/issues/616)
+- 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))
 
-**Merged pull requests:**
+**Closed issues:**
 
-- 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))
+- 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)
 

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)
@@ -116,7 +117,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 +333,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 +341,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 +361,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:
@@ -513,9 +510,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`.

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.1'
+  VERSION = '2.99.0'
 end

data/lib/good_job.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-require "rails"
 require "active_job"
 require "active_job/queue_adapters"
 
@@ -9,11 +8,12 @@ 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
 
-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.1
+  version: 2.99.0
 platform: ruby
 authors:
 - Ben Sheldon
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-18 00:00:00.000000000 Z
+date: 2022-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -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
@@ -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,34 +422,34 @@ 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
-- lib/good_job/cron_entry.rb
 - lib/good_job/cron_manager.rb
 - 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
 - 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
 - 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/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
@@ -461,7 +460,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
@@ -472,7 +471,6 @@ rdoc_options:
 - "--quiet"
 require_paths:
 - lib
-- engine/lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -484,8 +482,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
-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/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