good_job 1.99.0 → 1.99.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe59c2b49eaef9a76ecbf1af80c6ea765fb89a5d61f01b0436595e15e377019e
-  data.tar.gz: 15c0ee082903f8316de7656e855489492a00e90b3e75e55475f59824b49c0542
+  metadata.gz: 97662bae9e8ba65e5ed3e9ba52b8b987d77974866885a548a8a3b13878045c7a
+  data.tar.gz: 415d36696796cfb4c0ff1737c7c75e2b66bbfceea15f3a90aba55b49ee5da715
 SHA512:
-  metadata.gz: 22c7de0952050994cb220cda916ce85187775d2b79692b8ee094a0e6e76f84945ad528327fc3e83e50263e46272094949d2d6270a0332c19e8f79fb0841e0d80
-  data.tar.gz: '0229a23385ed171a50a39d54ab5295a5147110d203e84518643caa49c2dab16eee16263b54c86245a376e946402e9d39d52f05c3cde6ba2906f8f32fd77046e0'
+  metadata.gz: 2d293eabb7b926386b30a1348c529de6a2252c1c734b7a92a81abad2fdd791a28abe5067850c9a4f7595182afd72d52eccc0c640d7596aaddcba467a995449ca
+  data.tar.gz: 4b981bda934dc7e58aab80bd998c16b9c8261309cf8f5ffce09253c45821f0106ef0db0249934a3649e735715d865ff6dd62232876afb7ffca76cfb4fe473179

data/CHANGELOG.md

@@ -1,5 +1,54 @@
 # Changelog
 
+## [v1.99.1](https://github.com/bensheldon/good_job/tree/v1.99.1) (2021-08-27)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v2.0.1...v1.99.1)
+
+**Closed issues:**
+
+- Does Good job support delay method? [\#344](https://github.com/bensheldon/good_job/issues/344)
+
+**Merged pull requests:**
+
+- README style/typo fixes: "web server" and possessive "Rails'" [\#350](https://github.com/bensheldon/good_job/pull/350) ([aried3r](https://github.com/aried3r))
+- Add examples of setting config.good\_job.queues [\#349](https://github.com/bensheldon/good_job/pull/349) ([zachmargolis](https://github.com/zachmargolis))
+
+## [v2.0.1](https://github.com/bensheldon/good_job/tree/v2.0.1) (2021-08-24)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v2.0.0...v2.0.1)
+
+**Implemented enhancements:**
+
+- Suppress backtrace of ConcurrencyExceededError [\#348](https://github.com/bensheldon/good_job/pull/348) ([reczy](https://github.com/reczy))
+
+**Closed issues:**
+
+- Is there any value in seeing a backtrace for ConcurrencyExceededError? [\#347](https://github.com/bensheldon/good_job/issues/347)
+- Release GoodJob 2.0 [\#307](https://github.com/bensheldon/good_job/issues/307)
+- Unhandled ActiveJob errors should trigger GoodJob.on\_thread\_error [\#247](https://github.com/bensheldon/good_job/issues/247)
+
+## [v2.0.0](https://github.com/bensheldon/good_job/tree/v2.0.0) (2021-08-24)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v1.99.0...v2.0.0)
+
+**Implemented enhancements:**
+
+- Concurrency's enqueue\_limit should exclude performing jobs from count [\#317](https://github.com/bensheldon/good_job/issues/317)
+- Rename `:async` to `:async_all`; `:async_server` to `:async` and set as Development environment default; do not poll in async development [\#343](https://github.com/bensheldon/good_job/pull/343) ([bensheldon](https://github.com/bensheldon))
+- Exclude executing jobs from Concurrency's enqueue\_limit's count [\#342](https://github.com/bensheldon/good_job/pull/342) ([bensheldon](https://github.com/bensheldon))
+- Unhandled ActiveJob errors should trigger GoodJob.on\_thread\_error [\#312](https://github.com/bensheldon/good_job/pull/312) ([bensheldon](https://github.com/bensheldon))
+
+**Closed issues:**
+
+- Swap behavior of `async` with `async_server`; rename `async` execution mode to be `async_all`; default `async` in Development; [\#340](https://github.com/bensheldon/good_job/issues/340)
+- Add hyphen to lock key. e.g. "\[table\_name\]-\[column\]" instead of "\[table\_name\]\[column\]" [\#335](https://github.com/bensheldon/good_job/issues/335)
+- Use `async_server` as default execution mode in Development environment [\#139](https://github.com/bensheldon/good_job/issues/139)
+
+**Merged pull requests:**
+
+- Remove v1.0 deprecation notices and incremental migrations [\#338](https://github.com/bensheldon/good_job/pull/338) ([bensheldon](https://github.com/bensheldon))
+- Lock GoodJob::Job on active\_job\_id instead of the row id; adds separator hyphen to lock key [\#337](https://github.com/bensheldon/good_job/pull/337) ([bensheldon](https://github.com/bensheldon))
+
 ## [v1.99.0](https://github.com/bensheldon/good_job/tree/v1.99.0) (2021-08-24)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v1.13.2...v1.99.0)

data/README.md

@@ -86,6 +86,13 @@ For more of the story of GoodJob, read the [introductory blog post](https://isla
     $ bin/rails db:migrate
     ```
 
+   Optional: If using Rails' multiple databases with the `migrations_paths` configuration option, use the `--database` option:
+
+    ```bash
+    bin/rails g good_job:install --database animals
+    bin/rails db:migrate:animals
+    ```
+
 1. Configure the ActiveJob adapter:
 
     ```ruby
@@ -419,6 +426,12 @@ To perform upgrades to the GoodJob database tables:
     bin/rails g good_job:update
     ```
 
+   Optional: If using Rails' multiple databases with the `migrations_paths` configuration option, use the `--database` option:
+
+    ```bash
+    $ bin/rails g good_job:update --database animals
+    ```
+
 1. Run the database migration locally
 
     ```bash

data/lib/generators/good_job/install_generator.rb

@@ -1,23 +1,23 @@
 # frozen_string_literal: true
 require 'rails/generators'
 require 'rails/generators/active_record'
+
 module GoodJob
   #
   # Rails generator used for setting up GoodJob in a Rails application.
   # Run it with +bin/rails g good_job:install+ in your console.
   #
   class InstallGenerator < Rails::Generators::Base
-    include Rails::Generators::Migration
+    include ActiveRecord::Generators::Migration
 
-    class << self
-      delegate :next_migration_number, to: ActiveRecord::Generators::Base
-    end
+    TEMPLATES = File.join(File.dirname(__FILE__), "templates/install")
+    source_paths << TEMPLATES
 
-    source_paths << File.join(File.dirname(__FILE__), "templates/install")
+    class_option :database, type: :string, aliases: %i(--db), desc: "The database for your migration. By default, the current environment's primary database is used."
 
     # Generates monolithic migration file that contains all database changes.
     def create_migration_file
-      migration_template 'migrations/create_good_jobs.rb.erb', 'db/migrate/create_good_jobs.rb'
+      migration_template 'migrations/create_good_jobs.rb.erb', File.join(db_migrate_path, "create_good_jobs.rb")
     end
   end
 end

data/lib/generators/good_job/templates/update/migrations/03_add_active_job_id_index_and_concurrency_key_index_to_good_jobs.rb

@@ -4,10 +4,6 @@ class AddActiveJobIdIndexAndConcurrencyKeyIndexToGoodJobs < ActiveRecord::Migrat
 
   UPDATE_BATCH_SIZE = 1_000
 
-  class GoodJobJobs < ActiveRecord::Base
-    self.table_name = "good_jobs"
-  end
-
   def change
     reversible do |dir|
       dir.up do
@@ -21,11 +17,14 @@ class AddActiveJobIdIndexAndConcurrencyKeyIndexToGoodJobs < ActiveRecord::Migrat
     add_index :good_jobs, :concurrency_key, where: "(finished_at IS NULL)", algorithm: :concurrently, name: :index_good_jobs_on_concurrency_key_when_unfinished
     add_index :good_jobs, [:cron_key, :created_at], algorithm: :concurrently, name: :index_good_jobs_on_cron_key_and_created_at
 
+    return unless defined? GoodJob::Job
+
     reversible do |dir|
       dir.up do
+        # Ensure that all `good_jobs` records have an active_job_id value
         start_time = Time.current
         loop do
-          break if GoodJobJobs.where(active_job_id: nil, finished_at: nil).where("created_at < ?", start_time).limit(UPDATE_BATCH_SIZE).update_all("active_job_id = (serialized_params->>'job_id')::uuid").zero?
+          break if GoodJob::Job.where(active_job_id: nil, finished_at: nil).where("created_at < ?", start_time).limit(UPDATE_BATCH_SIZE).update_all("active_job_id = (serialized_params->>'job_id')::uuid").zero?
         end
       end
     end

data/lib/generators/good_job/update_generator.rb

@@ -8,22 +8,20 @@ module GoodJob
   # Run it with +bin/rails g good_job:update+ in your console.
   #
   class UpdateGenerator < Rails::Generators::Base
-    include Rails::Generators::Migration
-
-    class << self
-      delegate :next_migration_number, to: ActiveRecord::Generators::Base
-    end
+    include ActiveRecord::Generators::Migration
 
     TEMPLATES = File.join(File.dirname(__FILE__), "templates/update")
     source_paths << TEMPLATES
 
+    class_option :database, type: :string, aliases: %i(--db), desc: "The database for your migration. By default, the current environment's primary database is used."
+
     # Generates incremental migration files unless they already exist.
     # All migrations should be idempotent e.g. +add_index+ is guarded with +if_index_exists?+
     def update_migration_files
       migration_templates = Dir.children(File.join(TEMPLATES, 'migrations')).sort
       migration_templates.each do |template_file|
         destination_file = template_file.match(/^\d*_(.*\.rb)/)[1] # 01_create_good_jobs.rb.erb => create_good_jobs.rb
-        migration_template "migrations/#{template_file}", "db/migrate/#{destination_file}", skip: true
+        migration_template "migrations/#{template_file}", File.join(db_migrate_path, destination_file), skip: true
       end
     end
   end

data/lib/good_job/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 1.99.0
+  version: 1.99.1
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-24 00:00:00.000000000 Z
+date: 2021-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob