good_job 2.15.0 → 2.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b978264b509be9bd83e1e5e67f291b2889deff86c8316f876ab9def8264a7dd0
-  data.tar.gz: 9b4172f97c1c7406d3c51ec81f926adaca801baa004aed743a8cac757bb2ce86
+  metadata.gz: bef9bcf112b4c04ebbc2ebb05a6253bfafcf8d6b077ac177e2da7dc51beb2530
+  data.tar.gz: c5379f8a78edf855415b67f0879e65ad469eebf73c535576d572a0069ae7feff
 SHA512:
-  metadata.gz: a2696f821699ea080d2b77bb7704192222e6347d1b2be7fcf7a5e049d7b8979ceea3f5236c165fb27bb17fa5f9d8c7d2e5bb863b9c7298de9efb892facb6bca7
-  data.tar.gz: 0ab7a37d403e1bec9c0638835c903aff4a1168f33143c7c27acd87c07bf95a61c1475c3e61bea0a7590d167144761cc64b7bc81566746c854c2ae9698aa999fe
+  metadata.gz: 6f668a1496b0a5ef3b9c0a8d126fe4b6709bcabd1cb96466fe4c8530620dffeed9ac2c10ca103773bf2a7196441d8bc8981893a4f01c91bd5cddf318d08fbf05
+  data.tar.gz: 26f017289703d8017dd69183b425a602d1501e835b11c4552ecfca789ed43ee192d56aaed2c204ecc06343ac07908b19ad56b23d978a0cae5869a10236e75dbd

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## [v2.15.1](https://github.com/bensheldon/good_job/tree/v2.15.1) (2022-05-24)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v2.15.0...v2.15.1)
+
+**Closed issues:**
+
+- dashboard/engine – i18n: Wrong translation scope [\#605](https://github.com/bensheldon/good_job/issues/605)
+- Concurrency not properly putting jobs in the queue [\#603](https://github.com/bensheldon/good_job/issues/603)
+- Some dashboard actions have a routing error [\#602](https://github.com/bensheldon/good_job/issues/602)
+
+**Merged pull requests:**
+
+- Fix/i18n status scopes [\#607](https://github.com/bensheldon/good_job/pull/607) ([Jay-Schneider](https://github.com/Jay-Schneider))
+- Make "Live Polling" ToC entry clickable [\#606](https://github.com/bensheldon/good_job/pull/606) ([aried3r](https://github.com/aried3r))
+- Update readme explaining Concurrency implementation and how to integrate Dashboard with API-only Rails apps [\#604](https://github.com/bensheldon/good_job/pull/604) ([bensheldon](https://github.com/bensheldon))
+
 ## [v2.15.0](https://github.com/bensheldon/good_job/tree/v2.15.0) (2022-05-18)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v2.14.4...v2.15.0)

data/README.md

@@ -39,7 +39,10 @@ For more of the story of GoodJob, read the [introductory blog post](https://isla
     - [Configuration options](#configuration-options)
     - [Global options](#global-options)
     - [Dashboard](#dashboard)
+        - [API-only Rails applications](#api-only-rails-applications)
+        - [Live Polling](#live-polling)
     - [ActiveJob concurrency](#activejob-concurrency)
+        - [How concurrency controls work](#how-concurrency-controls-work)
     - [Cron-style repeating/recurring jobs](#cron-style-repeatingrecurring-jobs)
     - [Updating](#updating)
         - [Upgrading minor versions](#upgrading-minor-versions)
@@ -368,6 +371,23 @@ GoodJob includes a Dashboard as a mountable `Rails::Engine`.
     end
     ```
 
+#### 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:
+
+```ruby
+# config/application.rb
+module MyApp
+  class Application < Rails::Application
+    #...
+    config.middleware.use Rack::MethodOverride
+    config.middleware.use ActionDispatch::Flash
+    config.middleware.use ActionDispatch::Cookies
+    config.middleware.use ActionDispatch::Session::CookieStore
+  end
+end
+```
+
 #### Live Polling
 
 The Dashboard can be set to automatically refresh by checking "Live Poll" in the Dashboard header, or by setting `?poll=10` with the interval in seconds (default 30 seconds).
@@ -420,6 +440,13 @@ job = MyJob.perform_later("Alice")
 job.good_job_concurrency_key #=> "Unique-Alice"
 ```
 
+#### How concurrency controls work
+
+GoodJob's concurrency control strategy for `perform_limit` is "optimistic retry with an incremental backoff". The [code is readable](https://github.com/bensheldon/good_job/blob/main/lib/good_job/active_job_extensions/concurrency.rb).
+
+- "Optimistic" meaning that the implementation's performance trade-off assumes that collisions are atypical (e.g. two users enqueue the same job at the same time) rather than regular (e.g. the system enqueues thousands of colliding jobs at the same time).
+- "Retry with an incremental backoff" means that when `perform_limit` is exceeded, the job will raise a `GoodJob::ActiveJobExtensions::Concurrency::ConcurrencyExceededError` which is caught by a `retry_on` handler which re-schedules the job to execute in the near future with an incremental backoff.
+
 ### Cron-style repeating/recurring jobs
 
 GoodJob can enqueue jobs on a recurring basis that can be used as a replacement for cron.

data/engine/app/assets/good_job/style.css

@@ -34,3 +34,8 @@
 .toast-container {
   z-index: 1;
 }
+
+.translation_missing {
+  background-color: red;
+  color: white;
+}

data/engine/app/helpers/good_job/application_helper.rb

@@ -41,7 +41,7 @@ module GoodJob
     }.freeze
 
     def status_badge(status)
-      content_tag :span, status_icon(status, class: "text-white") + t(status, scope: '.status'),
+      content_tag :span, status_icon(status, class: "text-white") + t(status, scope: 'good_job.status'),
                   class: "badge rounded-pill bg-#{STATUS_COLOR.fetch(status)} d-inline-flex gap-2 ps-1 pe-3 align-items-center"
     end
 

data/engine/app/views/good_job/shared/_filter.erb

@@ -10,7 +10,7 @@
       <% filter.states.each do |name, count| %>
         <li class="nav-item">
           <%= link_to url_for({state: name}), class: "nav-link #{"active" if params[:state] == name}" do %>
-            <%= t(name, scope: '.status') %>
+            <%= t(name, scope: 'good_job.status') %>
             <span class="badge bg-primary rounded-pill <%= "bg-secondary" if count == 0 %>"><%= count %></span>
           <% end %>
         </li>

data/lib/good_job/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 2.15.0
+  version: 2.15.1
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-18 00:00:00.000000000 Z
+date: 2022-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob