good_job 2.11.1 → 2.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c72b452a727d8f42ffb1a261669eb55a684ae5b9643d0f5660db7585d69416af
-  data.tar.gz: fe50c11e3b2c5c5aca4f86dadbfc8ab8c8bf3bd3f8898fccd25e4fb8ca47a151
+  metadata.gz: 398864eebf8f617924967bf2a73679bd0584493299570c20ea6dbc9598d23ff3
+  data.tar.gz: d781885d188ec4b3dab51f9609ba7a3935027426edf6cbf8147ae2b11a51ac72
 SHA512:
-  metadata.gz: ead055bb27d8a25f3c199d731d6ad56390ac934a85dae640fb4aa2d35baae8aec0b0cb0e30354b2972591b69269caf30574df60d8ecbd3dca445170dd0e1598a
-  data.tar.gz: 396f2a76423df8033811186c993fad03007e25a1aaa85b3565b375d1a89b9934bcc4c42ebb7eda1fb1f5b00d89452a4315e642e155df4328a13fc25ec044f60e
+  metadata.gz: e9830078953d473bb48ec24cfcd4841029614be85c910b493d670eb1cfbbad287e95ce854a65aec609dd97954d6bb19f3a30c6a95cfd5d18c6913d777bab4d0f
+  data.tar.gz: ba0beb2c46d7f7044d1a7f2d5b1cb006ee67433432fb18e7bb04c7d4452df2e10ad45eff884c66bd7c1069ec47fee4fa18d776814dde4adf5b8a5bb4fb722904

data/CHANGELOG.md

@@ -1,5 +1,57 @@
 # Changelog
 
+## [v2.12.0](https://github.com/bensheldon/good_job/tree/v2.12.0) (2022-04-05)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v2.11.3...v2.12.0)
+
+**Closed issues:**
+
+- TimeTask timeouts are now ignored as these were not able to be implemented correctly [\#555](https://github.com/bensheldon/good_job/issues/555)
+- undefined method `relative\_time' when include\_all\_helpers is false [\#550](https://github.com/bensheldon/good_job/issues/550)
+- ArgumentError: wrong number of arguments \(given 1, expected 0; required keyword: schedule\) - cron [\#546](https://github.com/bensheldon/good_job/issues/546)
+
+**Merged pull requests:**
+
+- Deprecate Adapter configuration of job execution/cron [\#558](https://github.com/bensheldon/good_job/pull/558) ([bensheldon](https://github.com/bensheldon))
+- Remove usage of Concurrent::TimerTask's timeout\_interval [\#557](https://github.com/bensheldon/good_job/pull/557) ([bensheldon](https://github.com/bensheldon))
+- Include locale in html lang attribute [\#556](https://github.com/bensheldon/good_job/pull/556) ([bensheldon](https://github.com/bensheldon))
+- Rename `GoodJob::BaseController` to `GoodJob::ApplicationController` [\#553](https://github.com/bensheldon/good_job/pull/553) ([shouichi](https://github.com/shouichi))
+- Internationalize/I18n the Dashboard Engine [\#497](https://github.com/bensheldon/good_job/pull/497) ([JuanVqz](https://github.com/JuanVqz))
+
+## [v2.11.3](https://github.com/bensheldon/good_job/tree/v2.11.3) (2022-03-30)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v2.11.2...v2.11.3)
+
+**Fixed bugs:**
+
+- Add explicit `kwargs:` key to cron configuration [\#548](https://github.com/bensheldon/good_job/pull/548) ([bensheldon](https://github.com/bensheldon))
+
+**Closed issues:**
+
+- How to run clean up preserved jobs in cron? [\#541](https://github.com/bensheldon/good_job/issues/541)
+- Erroring with "Too many open files" when good\_job tries reconnecting to database [\#530](https://github.com/bensheldon/good_job/issues/530)
+- Can't cast Array [\#529](https://github.com/bensheldon/good_job/issues/529)
+
+**Merged pull requests:**
+
+- Use bundle add instead [\#542](https://github.com/bensheldon/good_job/pull/542) ([glaucocustodio](https://github.com/glaucocustodio))
+- Update Readme to better explain queues, pools, threads, and database connections; update CLI to frontload queue option [\#539](https://github.com/bensheldon/good_job/pull/539) ([bensheldon](https://github.com/bensheldon))
+
+## [v2.11.2](https://github.com/bensheldon/good_job/tree/v2.11.2) (2022-03-03)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v2.11.1...v2.11.2)
+
+**Closed issues:**
+
+- Best practices in deploying and monitoring a queue [\#523](https://github.com/bensheldon/good_job/issues/523)
+
+**Merged pull requests:**
+
+- Wrap Rspec before and example blocks with a mutex for JRuby [\#537](https://github.com/bensheldon/good_job/pull/537) ([bensheldon](https://github.com/bensheldon))
+- Delegate `ActiveJobJob.table_name` to `Execution` and prevent it from being directly assignable [\#536](https://github.com/bensheldon/good_job/pull/536) ([bensheldon](https://github.com/bensheldon))
+- Enable DB table names customization [\#535](https://github.com/bensheldon/good_job/pull/535) ([dimvic](https://github.com/dimvic))
+- Added a chapter on how to prepare for production. [\#525](https://github.com/bensheldon/good_job/pull/525) ([stas](https://github.com/stas))
+
 ## [v2.11.1](https://github.com/bensheldon/good_job/tree/v2.11.1) (2022-03-01)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v2.11.0...v2.11.1)

data/README.md

@@ -52,6 +52,7 @@ For more of the story of GoodJob, read the [introductory blog post](https://isla
     - [Timeouts](#timeouts)
     - [Optimize queues, threads, and processes](#optimize-queues-threads-and-processes)
     - [Database connections](#database-connections)
+        - [Production setup](#production-setup)
     - [Execute jobs async / in-process](#execute-jobs-async--in-process)
     - [Migrate to GoodJob from a different ActiveJob backend](#migrate-to-goodjob-from-a-different-activejob-backend)
     - [Monitor and preserve worked jobs](#monitor-and-preserve-worked-jobs)
@@ -64,16 +65,10 @@ For more of the story of GoodJob, read the [introductory blog post](https://isla
 
 ## Set up
 
-1. Add `good_job` to your application's Gemfile:
+1. Add `good_job` to your application's Gemfile and install the gem:
 
-    ```ruby
-    gem 'good_job'
-    ```
-
-1. Install the gem:
-
-    ```bash
-    bundle install
+    ```sh
+    bundle add good_job
     ```
 
 1. Run the GoodJob install generator. This will generate a database migration to create a table for GoodJob's job records:
@@ -164,8 +159,8 @@ Usage:
   good_job start
 
 Options:
-  [--max-threads=COUNT]        # Maximum number of threads to use for working jobs. (env var: GOOD_JOB_MAX_THREADS, default: 5)
-  [--queues=QUEUE_LIST]        # Queues to work from. (env var: GOOD_JOB_QUEUES, default: *)
+  [--queues=QUEUE_LIST]        # Queues or pools to work from. (env var: GOOD_JOB_QUEUES, default: *)
+  [--max-threads=COUNT]        # Default number of threads per pool to use for working jobs. (env var: GOOD_JOB_MAX_THREADS, default: 5)
   [--poll-interval=SECONDS]    # Interval between polls for available jobs in seconds (env var: GOOD_JOB_POLL_INTERVAL, default: 1)
   [--max-cache=COUNT]          # Maximum number of scheduled jobs to cache in memory (env var: GOOD_JOB_MAX_CACHE, default: 10000)
   [--shutdown-timeout=SECONDS] # Number of seconds to wait for jobs to finish when shutting down before stopping the thread. (env var: GOOD_JOB_SHUTDOWN_TIMEOUT, default: -1 (forever))
@@ -229,12 +224,12 @@ Rails.application.configure do
   config.good_job.retry_on_unhandled_error = false
   config.good_job.on_thread_error = -> (exception) { Raven.capture_exception(exception) }
   config.good_job.execution_mode = :async
+  config.good_job.queues = '*'
   config.good_job.max_threads = 5
   config.good_job.poll_interval = 30 # seconds
   config.good_job.shutdown_timeout = 25 # seconds
   config.good_job.enable_cron = true
   config.good_job.cron = { example: { cron: '0 * * * *', class: 'ExampleJob'  } }
-  config.good_job.queues = '*'
 
   # ...or all at once.
   config.good_job = {
@@ -242,6 +237,7 @@ Rails.application.configure do
     retry_on_unhandled_error: false,
     on_thread_error: -> (exception) { Raven.capture_exception(exception) },
     execution_mode: :async,
+    queues: '*',
     max_threads: 5,
     poll_interval: 30,
     shutdown_timeout: 25,
@@ -252,7 +248,6 @@ Rails.application.configure do
         class: 'ExampleJob'
       },
     },
-    queues: '*',
   }
 end
 ```
@@ -264,8 +259,8 @@ Available configuration options are:
     - `:external` causes the adapter to enqueue jobs, but not execute them. When using this option (the default for production environments), you’ll need to use the command-line tool to actually execute your jobs.
     - `:async` (or `:async_server`) executes jobs in separate threads within the Rails web server process (`bundle exec rails server`). It can be more economical for small workloads because you don’t need a separate machine or environment for running your jobs, but if your web server is under heavy load or your jobs require a lot of resources, you should choose `:external` instead.  When not in the Rails web server, jobs will execute in `:external` mode to ensure jobs are not executed within `rails console`, `rails db:migrate`, `rails assets:prepare`, etc.
     - `:async_all` executes jobs in separate threads in _any_ Rails process.
-- `max_threads` (integer) sets the maximum number of threads to use when `execution_mode` is set to `:async`. You can also set this with the environment variable `GOOD_JOB_MAX_THREADS`.
-- `queues` (string) determines which queues to execute jobs from when `execution_mode` is set to `:async`. See the description of `good_job start` for more details on the format of this string. You can also set this with the environment variable `GOOD_JOB_QUEUES`.
+- `queues` (string) sets queues or pools to execute jobs. You can also set this with the environment variable `GOOD_JOB_QUEUES`.
+- `max_threads` (integer) sets the default number of threads per pool to use for working jobs. You can also set this with the environment variable `GOOD_JOB_MAX_THREADS`.
 - `poll_interval` (integer) sets the number of seconds between polls for jobs when `execution_mode` is set to `:async`. You can also set this with the environment variable `GOOD_JOB_POLL_INTERVAL`. A poll interval of `-1` disables polling completely.
 - `max_cache` (integer) sets the maximum number of scheduled jobs that will be stored in memory to reduce execution latency when also polling for scheduled jobs. Caching 10,000 scheduled jobs uses approximately 20MB of memory. You can also set this with the environment variable `GOOD_JOB_MAX_CACHE`.
 - `shutdown_timeout` (float) number of seconds to wait for jobs to finish when shutting down before stopping the thread. Defaults to forever: `-1`. You can also set this with the environment variable `GOOD_JOB_SHUTDOWN_TIMEOUT`.
@@ -441,7 +436,8 @@ config.good_job.cron = {
   frequent_task: { # each recurring job must have a unique key
     cron: "*/15 * * * *", # cron-style scheduling format by fugit gem
     class: "ExampleJob", # reference the Job class with a string
-    args: [42, { name: "Alice" }], # arguments to pass; can also be a proc e.g. `-> { { when: Time.now } }`
+    args: [42, "life"], # positional arguments to pass; can also be a proc e.g. `-> { [Time.now] }`
+    kwargs: { name: "Alice" }, # keyword arguments to pass; can also be a proc e.g. `-> { { name: NAMES.sample } }`
     set: { priority: -10 }, # additional ActiveJob properties; can also be a lambda/proc e.g. `-> { { priority: [1,2].sample } }`
     description: "Something helpful", # optional description that appears in Dashboard (coming soon!)
   },
@@ -674,13 +670,38 @@ Keep in mind, queue operations and management is an advanced discipline. This st
 
 ### Database connections
 
-Each GoodJob execution thread requires its own database connection that is automatically checked out from Rails’ connection pool. _Allowing GoodJob to create more threads than available database connections can lead to timeouts and is not recommended._ For example:
+Each GoodJob execution thread requires its own database connection that is automatically checked out from Rails’ connection pool. For example:
 
 ```yaml
 # config/database.yml
-pool: <%= [ENV.fetch("RAILS_MAX_THREADS", 5).to_i, ENV.fetch("GOOD_JOB_MAX_THREADS", 4).to_i].max %>
+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:
+
+- 1 connection dedicated to the scheduler aka `LISTEN/NOTIFY`
+- 1 connection per query pool thread e.g. `--queues=mice:2;elephants:1` is 3 threads. Pool thread size defaults to `--max-threads`
+- (optional) 2 connections for Cron scheduler if you're running it
+- (optional) 1 connection per subthread, if your application makes multithreaded database queries within a job
+- When running `:async`, you must also add the number of threads by the webserver
+
+The queue process will not crash if the connections pool is exhausted, instead it will report an exception (eg. `ActiveRecord::ConnectionTimeoutError`).
+
+#### Production setup
+
+When running GoodJob in a production environment, you should be mindful of:
+
+- [Execution mode](execute-jobs-async--in-process)
+- [Database connection pool size](#database-connections)
+- [Health check probes](#cli-http-health-check-probes) and potentially the [instrumentation support](#monitor-and-preserve-worked-jobs)
+
+The recommended way to monitor the queue in production is:
+
+- have an exception notifier callback (see `on_thread_error`)
+- if possible, run the queue as a dedicated instance and use available HTTP health check probes instead of pid-based monitoring
+- keep an eye on the number of jobs in the queue (abnormal high number of unscheduled jobs means the queue could be underperforming)
+- consider performance monitoring services which support the built-in Rails instrumentation (eg. Sentry, Skylight, etc.)
+
 ### Execute jobs async / in-process
 
 GoodJob can execute jobs "async" in the same process as the web server (e.g. `bin/rails s`). GoodJob's async execution mode offers benefits of economy by not requiring a separate job worker process, but with the tradeoff of increased complexity. Async mode can be configured in two ways:

data/engine/app/charts/good_job/scheduled_by_queue_chart.rb

@@ -9,6 +9,7 @@ module GoodJob
     def data
       end_time = Time.current
       start_time = end_time - 1.day
+      table_name = GoodJob::ActiveJobJob.table_name
 
       count_query = Arel.sql(GoodJob::Execution.pg_or_jdbc_query(<<~SQL.squish))
         SELECT *
@@ -23,7 +24,7 @@ module GoodJob
               queue_name,
               count(*) AS count
             FROM (
-              #{@filter.filtered_query.except(:select, :order).select('queue_name', 'COALESCE(good_jobs.scheduled_at, good_jobs.created_at)::timestamp AS scheduled_at').to_sql}
+              #{@filter.filtered_query.except(:select, :order).select('queue_name', "COALESCE(#{table_name}.scheduled_at, #{table_name}.created_at)::timestamp AS scheduled_at").to_sql}
             ) sources
             GROUP BY date_trunc('hour', scheduled_at), queue_name
         ) sources ON sources.scheduled_at = timestamp

data/engine/app/controllers/good_job/{base_controller.rb → application_controller.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module GoodJob
-  class BaseController < ActionController::Base # rubocop:disable Rails/ApplicationController
+  class ApplicationController < ActionController::Base
     protect_from_forgery with: :exception
 
     around_action :switch_locale
@@ -24,10 +24,28 @@ module GoodJob
       request.content_security_policy_nonce_generator = ->(_request) { SecureRandom.base64(16) }
     end
 
+    def default_url_options(options = {})
+      { locale: I18n.locale }.merge(options)
+    end
+
     private
 
     def switch_locale(&action)
-      I18n.with_locale(:en, &action)
+      I18n.with_locale(current_locale, &action)
+    end
+
+    def current_locale
+      if params[:locale]
+        params[:locale]
+      elsif good_job_available_locales.exclude?(I18n.default_locale) && I18n.available_locales.include?(:en)
+        :en
+      else
+        I18n.default_locale
+      end
+    end
+
+    def good_job_available_locales
+      @_good_job_available_locales ||= GoodJob::Engine.root.join("config/locales").glob("*.yml").map { |path| File.basename(path, ".yml").to_sym }.uniq
     end
   end
 end

data/engine/app/controllers/good_job/cron_entries_controller.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module GoodJob
-  class CronEntriesController < GoodJob::BaseController
+  class CronEntriesController < GoodJob::ApplicationController
     def index
       @cron_entries = CronEntry.all
     end

data/engine/app/controllers/good_job/executions_controller.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module GoodJob
-  class ExecutionsController < GoodJob::BaseController
+  class ExecutionsController < GoodJob::ApplicationController
     def index
       @filter = ExecutionsFilter.new(params)
     end

data/engine/app/controllers/good_job/jobs_controller.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module GoodJob
-  class JobsController < GoodJob::BaseController
+  class JobsController < GoodJob::ApplicationController
     rescue_from GoodJob::ActiveJobJob::AdapterNotGoodJobError,
                 GoodJob::ActiveJobJob::ActionForStateMismatchError,
                 with: :redirect_on_error

data/engine/app/controllers/good_job/processes_controller.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module GoodJob
-  class ProcessesController < GoodJob::BaseController
+  class ProcessesController < GoodJob::ApplicationController
     def index
       @processes = GoodJob::Process.active.order(created_at: :desc) if GoodJob::Process.migrated?
     end

data/engine/app/filters/good_job/jobs_filter.rb

@@ -14,7 +14,7 @@ module GoodJob
 
     def filtered_query
       query = base_query.includes(:executions)
-                        .joins_advisory_locks.select('good_jobs.*', 'pg_locks.locktype AS locktype')
+                        .joins_advisory_locks.select("#{GoodJob::ActiveJobJob.table_name}.*", 'pg_locks.locktype AS locktype')
 
       query = query.job_class(params[:job_class]) if params[:job_class].present?
       query = query.where(queue_name: params[:queue_name]) if params[:queue_name].present?
@@ -31,7 +31,7 @@ module GoodJob
         when 'scheduled'
           query = query.scheduled
         when 'running'
-          query = query.running.select('good_jobs.*', 'pg_locks.locktype')
+          query = query.running.select("#{GoodJob::ActiveJobJob.table_name}.*", 'pg_locks.locktype')
         when 'queued'
           query = query.queued
         end

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

@@ -0,0 +1,13 @@
+<% if notice %>
+  <div class="alert alert-success alert-dismissible fade show d-flex align-items-center offset-md-3 col-6" role="alert">
+    <%= render "good_job/shared/icons/check", class: "flex-shrink-0 me-2" %>
+    <div><%= notice %></div>
+    <button type="button" class="btn-close" data-bs-dismiss="alert" aria-label="Close"></button>
+  </div>
+<% elsif alert %>
+  <div class="alert alert-warning alert-dismissible fade show d-flex align-items-center offset-md-3 col-6" role="alert">
+    <%= render "good_job/shared/icons/exclamation", class: "flex-shrink-0 me-2" %>
+    <div><%= alert %></div>
+    <button type="button" class="btn-close" data-bs-dismiss="alert" aria-label="Close"></button>
+  </div>
+<% end %>

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

@@ -0,0 +1,7 @@
+<div class="card border-warning text-dark my-3">
+  <div class="card-body">
+    <p class="card-text">
+      <%= t(".work_in_progress_html") %>
+    </p>
+  </div>
+</div>

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

@@ -0,0 +1,15 @@
+<footer class="footer mt-auto py-3 bg-light fixed-bottom" id="footer" data-gj-poll-replace>
+  <div class="container-fluid">
+    <div class="row">
+      <div class="col-6">
+        <span class="text-muted">
+          <%= t(".last_update_html", time: Time.current.utc.iso8601) %>
+        </span>
+      </div>
+
+      <div class="col-6 text-end">
+        <%= t(".wording") %>
+      </div>
+    </div>
+  </div>
+</footer>

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

@@ -0,0 +1,49 @@
+<nav class="navbar navbar-expand-lg navbar-light bg-light">
+  <div class="container-fluid">
+    <%= link_to t(".name"), root_path, class: "navbar-brand mb-0 h1" %>
+    <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
+      <span class="navbar-toggler-icon"></span>
+    </button>
+
+    <div class="collapse navbar-collapse" id="navbarSupportedContent">
+      <ul class="navbar-nav me-auto">
+        <li class="nav-item">
+          <%= link_to t(".executions"), root_path, class: ["nav-link", ("active" if current_page?(root_path))] %>
+        </li>
+        <li class="nav-item">
+          <%= link_to t(".jobs"), jobs_path, class: ["nav-link", ("active" if current_page?(jobs_path))] %>
+        </li>
+        <li class="nav-item">
+          <%= link_to t(".cron_schedules"), cron_entries_path, class: ["nav-link", ("active" if current_page?(cron_entries_path))] %>
+        </li>
+        <li class="nav-item">
+          <%= link_to t(".processes"), processes_path, class: ["nav-link", ("active" if current_page?(processes_path))] %>
+        </li>
+        <li class="nav-item">
+          <div class="nav-link">
+            <span class="badge bg-secondary"><%= t(".coming_soon") %></span>
+          </div>
+        </li>
+      </ul>
+      <div class="nav-item pe-2">
+        <div class="form-check">
+          <input type="checkbox" id="toggle-poll" name="toggle-poll" data-gj-action='change#togglePoll' <%= 'checked' if params[:poll].present? %>>
+          <label for="toggle-poll"><%= t(".live_poll") %></label>
+        </div>
+      </div>
+      <ul class="navbar-nav">
+        <li class="nav-item dropdown">
+          <a href="#" class="nav-link dropdown-toggle" type="button" id="localeOptions" data-bs-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+            <%= I18n.locale %>
+          </a>
+
+          <ul class="dropdown-menu" aria-labelledby="localeOptions">
+            <% I18n.available_locales.reject { |locale| locale == I18n.locale }.each do |locale| %>
+              <li><%= link_to locale, url_for(locale: locale), class: "dropdown-item" %></li>
+            <% end %>
+          </ul>
+        </li>
+      </ul>
+    </div>
+  </div>
+</nav>

data/engine/app/views/layouts/good_job/application.html.erb

@@ -0,0 +1,32 @@
+<!DOCTYPE html>
+<html lang="<%= I18n.locale %>">
+<head>
+  <title>Good Job Dashboard</title>
+  <meta charset="utf-8">
+  <meta content="width=device-width, initial-scale=1, shrink-to-fit=no" name="viewport">
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%# Assets must use *_url route helpers to avoid being overriden by config.asset_host %>
+  <%= stylesheet_link_tag bootstrap_url(format: :css, v: GoodJob::VERSION), skip_pipeline: true %>
+  <%= stylesheet_link_tag style_url(format: :css, v: GoodJob::VERSION) %>
+
+  <%= javascript_include_tag bootstrap_url(format: :js, v: GoodJob::VERSION), nonce: true %>
+  <%= javascript_include_tag chartjs_url(format: :js, v: GoodJob::VERSION), nonce: true %>
+  <%= javascript_include_tag scripts_url(format: :js, v: GoodJob::VERSION), nonce: true %>
+
+  <%= javascript_include_tag rails_ujs_url(format: :js, v: GoodJob::VERSION), nonce: true %>
+</head>
+<body>
+  <%= render "good_job/shared/navbar" %>
+
+  <div class="container-fluid">
+    <%= render "good_job/shared/announcement" %>
+    <%= render "good_job/shared/alert" %>
+
+    <%= yield %>
+  </div>
+
+    <%= render "good_job/shared/footer" %>
+</body>
+</html>

data/engine/config/locales/en.yml

@@ -0,0 +1,56 @@
+---
+en:
+  datetime:
+    distance_in_words:
+      about_x_hours:
+        one: about 1 hour
+        other: about %{count} hours
+      about_x_months:
+        one: about 1 month
+        other: about %{count} months
+      about_x_years:
+        one: about 1 year
+        other: about %{count} years
+      almost_x_years:
+        one: almost 1 year
+        other: almost %{count} years
+      half_a_minute: half a minute
+      less_than_x_minutes:
+        one: less than a minute
+        other: less than %{count} minutes
+      less_than_x_seconds:
+        one: less than 1 second
+        other: less than %{count} seconds
+      over_x_years:
+        one: over 1 year
+        other: over %{count} years
+      x_days:
+        one: 1 day
+        other: "%{count} days"
+      x_minutes:
+        one: 1 minute
+        other: "%{count} minutes"
+      x_months:
+        one: 1 month
+        other: "%{count} months"
+      x_seconds:
+        one: 1 second
+        other: "%{count} seconds"
+      x_years:
+        one: 1 year
+        other: "%{count} years"
+  good_job:
+    shared:
+      announcement:
+        work_in_progress_html: "🚧 GoodJob's dashboard is a work in progress. Please contribute ideas and code on <a href=\"https://github.com/bensheldon/good_job/issues\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Github</a>."
+      footer:
+        last_update_html: Last updated <time id="page-updated-at" datetime="%{time}">%{time}</time>
+        wording: Remember, you're doing a Good Job too!
+      navbar:
+        coming_soon: More views coming soon
+        cron_schedules: Cron Schedules
+        executions: All Executions
+        jobs: All Jobs
+        live_poll: Live Poll
+        name: "GoodJob 👍"
+        processes: Processes

data/engine/config/locales/es.yml

@@ -0,0 +1,56 @@
+---
+es:
+  datetime:
+    distance_in_words:
+      about_x_hours:
+        one: alrededor de 1 hora
+        other: alrededor de %{count} horas
+      about_x_months:
+        one: alrededor de 1 mes
+        other: alrededor de %{count} meses
+      about_x_years:
+        one: alrededor de 1 año
+        other: alrededor de %{count} años
+      almost_x_years:
+        one: casi 1 año
+        other: casi %{count} años
+      half_a_minute: medio minuto
+      less_than_x_minutes:
+        one: menos de un minuto
+        other: menos de %{count} minutos
+      less_than_x_seconds:
+        one: menos de 1 segundo
+        other: menos de %{count} segundos
+      over_x_years:
+        one: más de 1 año
+        other: durante %{count} años
+      x_days:
+        one: 1 día
+        other: "%{count} días"
+      x_minutes:
+        one: 1 minuto
+        other: "%{count} minutos"
+      x_months:
+        one: 1 mes
+        other: "%{count} meses"
+      x_seconds:
+        one: 1 segundo
+        other: "%{count} segundos"
+      x_years:
+        one: 1 año
+        other: "%{count} años"
+  good_job:
+    shared:
+      announcement:
+        work_in_progress_html: "🚧 GoodJob se encuentra en desarrollo. Por favor contribuya en <a href=\"https://github.com/bensheldon/good_job/issues\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">GoodJob</a> con ideas y código."
+      footer:
+        last_update_html: Última actualización <time id="page-updated-at" datetime="%{time}">%{time}</time>
+        wording: "¡Recuerda, también tú estás haciendo un buen trabajo!"
+      navbar:
+        coming_soon: Próximamente más vistas
+        cron_schedules: Tareas Programadas
+        executions: Ejecuciones
+        jobs: Tareas
+        live_poll: En vivo
+        name: "GoodJob 👍"
+        processes: Procesos

data/lib/good_job/active_job_job.rb

@@ -15,7 +15,14 @@ module GoodJob
     # Attached to a Job's Execution when the Job is discarded.
     DiscardJobError = Class.new(StandardError)
 
-    self.table_name = 'good_jobs'
+    class << self
+      delegate :table_name, to: Execution
+
+      def table_name=(_value)
+        raise NotImplementedError, 'Assign GoodJob::Execution.table_name directly'
+      end
+    end
+
     self.primary_key = 'active_job_id'
     self.advisory_lockable_column = 'active_job_id'
 

data/lib/good_job/adapter.rb

@@ -27,7 +27,13 @@ module GoodJob
     # @param queues [String, nil] determines which queues to execute jobs from when +execution_mode+ is set to +:async+. See {file:README.md#optimize-queues-threads-and-processes} for more details on the format of this string. You can also set this with the environment variable +GOOD_JOB_QUEUES+. Defaults to +"*"+.
     # @param poll_interval [Integer, nil] sets the number of seconds between polls for jobs when +execution_mode+ is set to +:async+. You can also set this with the environment variable +GOOD_JOB_POLL_INTERVAL+. Defaults to +1+.
     # @param start_async_on_initialize [Boolean] whether to start the async scheduler when the adapter is initialized.
-    def initialize(execution_mode: nil, queues: nil, max_threads: nil, poll_interval: nil, start_async_on_initialize: GoodJob.async_ready?)
+    def initialize(execution_mode: nil, queues: nil, max_threads: nil, poll_interval: nil, start_async_on_initialize: nil)
+      if execution_mode || queues || max_threads || poll_interval || start_async_on_initialize
+        ActiveSupport::Deprecation.warn(
+          "The GoodJob::Adapter's initialization parameters have been deprecated and will be removed in GoodJob v3. These options should be configured through GoodJob global configuration instead."
+        )
+      end
+
       @configuration = GoodJob::Configuration.new(
         {
           execution_mode: execution_mode,
@@ -39,7 +45,7 @@ module GoodJob
       @configuration.validate!
       self.class.instances << self
 
-      start_async if start_async_on_initialize
+      start_async if start_async_on_initialize || GoodJob.async_ready?
     end
 
     # Enqueues the ActiveJob job to be performed.

data/lib/good_job/cli.rb

@@ -50,14 +50,14 @@ module GoodJob
       separate isolated execution pools with semicolons and threads with colons.
 
     DESCRIPTION
-    method_option :max_threads,
-                  type: :numeric,
-                  banner: 'COUNT',
-                  desc: "Maximum number of threads to use for working jobs. (env var: GOOD_JOB_MAX_THREADS, default: 5)"
     method_option :queues,
                   type: :string,
                   banner: "QUEUE_LIST",
-                  desc: "Queues to work from. (env var: GOOD_JOB_QUEUES, default: *)"
+                  desc: "Queues or queue pools to work from. (env var: GOOD_JOB_QUEUES, default: *)"
+    method_option :max_threads,
+                  type: :numeric,
+                  banner: 'COUNT',
+                  desc: "Default number of threads per pool to use for working jobs. (env var: GOOD_JOB_MAX_THREADS, default: 5)"
     method_option :poll_interval,
                   type: :numeric,
                   banner: 'SECONDS',

data/lib/good_job/cron_entry.rb

@@ -52,6 +52,10 @@ module GoodJob # :nodoc:
       params[:args]
     end
 
+    def kwargs
+      params[:kwargs]
+    end
+
     def description
       params[:description]
     end
@@ -87,7 +91,8 @@ module GoodJob # :nodoc:
         current_thread.cron_key = key
         current_thread.cron_at = cron_at
 
-        job_class.constantize.set(set_value).perform_later(*args_value)
+        configured_job = job_class.constantize.set(set_value)
+        kwargs_value.present? ? configured_job.perform_later(*args_value, **kwargs_value) : configured_job.perform_later(*args_value)
       end
     rescue ActiveRecord::RecordNotUnique
       false
@@ -124,6 +129,11 @@ module GoodJob # :nodoc:
       value.respond_to?(:call) ? value.call : value
     end
 
+    def kwargs_value
+      value = kwargs || nil
+      value.respond_to?(:call) ? value.call : value
+    end
+
     def display_property(value)
       case value
       when NilClass

data/lib/good_job/poller.rb

@@ -6,13 +6,10 @@ module GoodJob # :nodoc:
   # Pollers regularly wake up execution threads to check for new work.
   #
   class Poller
-    TIMEOUT_INTERVAL = 5
-
     # Defaults for instance of Concurrent::TimerTask.
     # The timer controls how and when sleeping threads check for new work.
     DEFAULT_TIMER_OPTIONS = {
       execution_interval: Configuration::DEFAULT_POLL_INTERVAL,
-      timeout_interval: TIMEOUT_INTERVAL,
       run_now: true,
     }.freeze
 

data/lib/good_job/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 2.11.1
+  version: 2.12.0
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-01 00:00:00.000000000 Z
+date: 2022-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -367,8 +367,8 @@ files:
 - engine/app/assets/vendor/chartjs/chart.min.js
 - engine/app/assets/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/base_controller.rb
 - engine/app/controllers/good_job/cron_entries_controller.rb
 - engine/app/controllers/good_job/executions_controller.rb
 - engine/app/controllers/good_job/jobs_controller.rb
@@ -385,8 +385,12 @@ files:
 - 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/_announcement.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/_exclamation.html.erb
@@ -394,7 +398,9 @@ files:
 - 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/base.html.erb
+- engine/app/views/layouts/good_job/application.html.erb
+- engine/config/locales/en.yml
+- engine/config/locales/es.yml
 - engine/config/routes.rb
 - engine/lib/good_job/engine.rb
 - exe/good_job

data/engine/app/views/layouts/good_job/base.html.erb

@@ -1,96 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <title>Good Job Dashboard</title>
-  <meta charset="utf-8">
-  <meta content="width=device-width, initial-scale=1, shrink-to-fit=no" name="viewport">
-  <%= csrf_meta_tags %>
-  <%= csp_meta_tag %>
-
-  <%# Assets must use *_url route helpers to avoid being overriden by config.asset_host %>
-  <%= stylesheet_link_tag bootstrap_url(format: :css, v: GoodJob::VERSION), skip_pipeline: true %>
-  <%= stylesheet_link_tag style_url(format: :css, v: GoodJob::VERSION) %>
-
-  <%= javascript_include_tag bootstrap_url(format: :js, v: GoodJob::VERSION), nonce: true %>
-  <%= javascript_include_tag chartjs_url(format: :js, v: GoodJob::VERSION), nonce: true %>
-  <%= javascript_include_tag scripts_url(format: :js, v: GoodJob::VERSION), nonce: true %>
-
-  <%= javascript_include_tag rails_ujs_url(format: :js, v: GoodJob::VERSION), nonce: true %>
-</head>
-<body>
-  <nav class="navbar navbar-expand-lg navbar-light bg-light">
-    <div class="container-fluid">
-      <%= link_to "GoodJob 👍", root_path, class: 'navbar-brand mb-0 h1' %>
-      <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
-        <span class="navbar-toggler-icon"></span>
-      </button>
-
-      <div class="collapse navbar-collapse" id="navbarSupportedContent">
-        <ul class="navbar-nav me-auto">
-          <li class="nav-item">
-            <%= link_to "All Executions", root_path, class: ["nav-link", ("active" if current_page?(root_path))] %>
-          </li>
-          <li class="nav-item">
-            <%= link_to "All Jobs", jobs_path, class: ["nav-link", ("active" if current_page?(jobs_path))] %>
-          </li>
-          <li class="nav-item">
-            <%= link_to "Cron Schedules", cron_entries_path, class: ["nav-link", ("active" if current_page?(cron_entries_path))] %>
-          </li>
-          <li class="nav-item">
-            <%= link_to "Processes", processes_path, class: ["nav-link", ("active" if current_page?(processes_path))] %>
-          </li>
-          <li class="nav-item">
-            <div class="nav-link">
-              <span class="badge bg-secondary">More views coming soon</span>
-            </div>
-          </li>
-        </ul>
-        <div>
-          <input type="checkbox" id="toggle-poll" name="toggle-poll" data-gj-action='change#togglePoll' <%= 'checked' if params[:poll].present? %>>
-          <label for="toggle-poll">Live Poll</label>
-        </div>
-      </div>
-    </div>
-  </nav>
-
-  <div class="container-fluid">
-    <div class="card border-warning text-dark my-3">
-      <div class="card-body">
-        <p class="card-text">🚧 GoodJob's dashboard is a work in progress. Please contribute ideas and code on <a href="https://github.com/bensheldon/good_job/issues" target="_blank" rel="nofollow noopener noreferrer">Github</a>.</p>
-      </div>
-    </div>
-
-    <% if notice %>
-      <div class="alert alert-success alert-dismissible fade show d-flex align-items-center offset-md-3 col-6" role="alert">
-        <%= render "good_job/shared/icons/check", class: "flex-shrink-0 me-2" %>
-        <div><%= notice %></div>
-        <button type="button" class="btn-close" data-bs-dismiss="alert" aria-label="Close"></button>
-      </div>
-    <% elsif alert %>
-      <div class="alert alert-warning alert-dismissible fade show d-flex align-items-center offset-md-3 col-6" role="alert">
-        <%= render "good_job/shared/icons/exclamation", class: "flex-shrink-0 me-2" %>
-        <div><%= alert %></div>
-        <button type="button" class="btn-close" data-bs-dismiss="alert" aria-label="Close"></button>
-      </div>
-    <% end %>
-
-    <%= yield %>
-  </div>
-
-  <footer class="footer mt-auto py-3 bg-light fixed-bottom" id="footer" data-gj-poll-replace>
-    <div class="container-fluid">
-      <div class="row">
-        <div class="col-6">
-          <span class="text-muted">
-            Last updated: <time id="page-updated-at" datetime="<%= Time.current.utc.iso8601 %>"><%= Time.current %></time>
-          </span>
-        </div>
-
-        <div class="col-6 text-end">
-          Remember, you're doing a Good Job too!
-        </div>
-      </div>
-    </div>
-  </footer>
-</body>
-</html>