good_job 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 381f27d5c5f8fe4be355f3b2ea1e1f0bcd76f545d7378183b4faca9d6770a6cd
-  data.tar.gz: 20b315936f49810e9aa70e0bc8c2a37c140436212f2e84d15e05d275c93715ee
+  metadata.gz: 03dafffb596eaa6c7cf0994a40586039ac38215dcb0942850b1067deec0ac04d
+  data.tar.gz: 917cbb1baebf9e6f8f7767d54606d0a07b02d3c28971e65369603f71500abf34
 SHA512:
-  metadata.gz: f0f107ba18b85211856391873650309997a63e16d2ddc34e55bdbdb3f8563e595f2e3176cfaa1e13f65eaca70e75df0ff950562740d51c1a82bc885dfd3421ea
-  data.tar.gz: cc47bc865ca1264238b5253f9ab06c8ebdc840e5adaf3220366f622626f8fac872c5fec5cd3b939acfd60137af6d984a0b2a61aad19ccd3ea277708f3c291414
+  metadata.gz: fd0c36fee775613d86ba832c6777eb9c72b651630f24b6236ea1b5373957d045121c3d5a0aea528cded163da638b7b6e41c3b155915186350bd1675e27b3ffee
+  data.tar.gz: 041f30d08e8128d81ffdbf59e19f958761b809d9993facb5919119346cfc30b2f8da715658be47e94f317ffed3953381a93141a6bdc6540ab3f0b186604970f0

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## [v3.0.2](https://github.com/bensheldon/good_job/tree/v3.0.2) (2022-07-10)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v3.0.1...v3.0.2)
+
+**Fixed bugs:**
+
+- Copy forward concurrency key value when retrying a job, rather than regenerating it [\#622](https://github.com/bensheldon/good_job/issues/622)
+- All concurrency controlled jobs throw exceptions and are rescheduled if they are called using perform\_now [\#591](https://github.com/bensheldon/good_job/issues/591)
+
+**Closed issues:**
+
+- Queue config not respecting limits [\#659](https://github.com/bensheldon/good_job/issues/659)
+- UI engine does not work without explicit require [\#646](https://github.com/bensheldon/good_job/issues/646)
+- Should `:inline` adapter mode retry jobs? [\#611](https://github.com/bensheldon/good_job/issues/611)
+- Error Job Not Preserved  [\#594](https://github.com/bensheldon/good_job/issues/594)
+- Jobs never get run... [\#516](https://github.com/bensheldon/good_job/issues/516)
+- Release GoodJob 3.0 [\#507](https://github.com/bensheldon/good_job/issues/507)
+- Improve security of Gem releases [\#422](https://github.com/bensheldon/good_job/issues/422)
+
+**Merged pull requests:**
+
+- Preserve initial concurrency key when retrying jobs [\#657](https://github.com/bensheldon/good_job/pull/657) ([bensheldon](https://github.com/bensheldon))
+- Add Dashboard troubleshooting note to explicitly require the engine [\#654](https://github.com/bensheldon/good_job/pull/654) ([bensheldon](https://github.com/bensheldon))
+- Removes wrong parentheses [\#653](https://github.com/bensheldon/good_job/pull/653) ([esasse](https://github.com/esasse))
+
 ## [v3.0.1](https://github.com/bensheldon/good_job/tree/v3.0.1) (2022-07-02)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v3.0.0...v3.0.1)

data/README.md

@@ -370,6 +370,16 @@ GoodJob includes a Dashboard as a mountable `Rails::Engine`.
 
     See more at [Monitor and preserve worked jobs](#monitor-and-preserve-worked-jobs)
 
+**Troubleshooting the Dashboard:** Some applications are unable to autoload the Goodjob Engine. To work around this, explicitly require the Engine at the top of your `config/application.rb` file, immediately after Rails is required and before Bundler requires the Rails' groups.
+
+```ruby
+# config/application.rb
+require_relative 'boot'
+require 'rails/all'
+require 'good_job/engine' # <= Add this line
+# ...
+```
+
 #### 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:
@@ -713,7 +723,7 @@ Each GoodJob execution thread requires its own database connection that is autom
 
 ```yaml
 # config/database.yml
-pool: <%= ENV.fetch("RAILS_MAX_THREADS", 5).to_i + 3 + (ENV.fetch("GOOD_JOB_MAX_THREADS", 5).to_i %>
+pool: <%= ENV.fetch("RAILS_MAX_THREADS", 5).to_i + 3 + ENV.fetch("GOOD_JOB_MAX_THREADS", 5).to_i %>
 ```
 
 To calculate the total number of the database connections you'll need:

data/lib/good_job/active_job_extensions/concurrency.rb

@@ -10,8 +10,18 @@ module GoodJob
         end
       end
 
+      module Prepends
+        def deserialize(job_data)
+          super
+          self.good_job_concurrency_key = job_data['good_job_concurrency_key']
+        end
+      end
+
       included do
+        prepend Prepends
+
         class_attribute :good_job_concurrency_config, instance_accessor: false, default: {}
+        attr_writer :good_job_concurrency_key
 
         around_enqueue do |job, block|
           # Don't attempt to enforce concurrency limits with other queue adapters.
@@ -27,6 +37,8 @@ module GoodJob
                       (total_limit.present? && (0...Float::INFINITY).cover?(total_limit))
           next(block.call) unless has_limit
 
+          # Only generate the concurrency key on the initial enqueue in case it is dynamic
+          job.good_job_concurrency_key ||= job._good_job_concurrency_key
           key = job.good_job_concurrency_key
           next(block.call) if key.blank?
 
@@ -80,7 +92,15 @@ module GoodJob
         end
       end
 
+      # Existing or dynamically generated concurrency key
+      # @return [Object] concurrency key
       def good_job_concurrency_key
+        @good_job_concurrency_key || _good_job_concurrency_key
+      end
+
+      # Generates the concurrency key from the configuration
+      # @return [Object] concurrency key
+      def _good_job_concurrency_key
         key = self.class.good_job_concurrency_config[:key]
         return if key.blank?
 

data/lib/good_job/version.rb

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

data/lib/models/good_job/execution.rb

@@ -330,6 +330,7 @@ module GoodJob
       serialized_params.deep_dup
                        .tap do |job_data|
         job_data["provider_job_id"] = id
+        job_data["good_job_concurrency_key"] = concurrency_key if concurrency_key
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-02 00:00:00.000000000 Z
+date: 2022-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob