good_job 3.3.3 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f8fa4783c84a1fa080726fad9771b6414c7ece765a54bd8641e9629c658c426
-  data.tar.gz: 9de3f045df0fafdb537c454f5c7b713646e73e0e446e7b1ebe4f13ed8d3aba1c
+  metadata.gz: 73efcb35d2a5e0ccfd13e2526a9a9d4a7195c4bf2e4a7f4127894a68c7f5dbb9
+  data.tar.gz: d9fddab346e5851e23daa5d9bef8c68b1fd5472f37d687c3cb49c5ff551cc31c
 SHA512:
-  metadata.gz: 434f580b2874f78161406758b29b65f46bd30b61f1b876f3aa6450da6f3f3fd35843b98a226cd57ea4d531724f5cb5814e8c1fe34a642f4a68e877f85c2c9601
-  data.tar.gz: a06a69d3e03e3a4a4aacd34b8b0132488c91efe595c4559089392f0db3c6ea129483c2b3ca902aa95743f7f0b981a1821d63c557eb5d06ac7a07de7e38be6885
+  metadata.gz: d720ab703536db9dfd396097aeb8b3aae64f5cd55a1754a9965eaaca275a2babfc4a05d249fb13896d776d02034553bd81cdda8b0af19a6f49d9a3a4bca29045
+  data.tar.gz: 9dd2af1f00637c3db171934777cc02be231e3ee98ad953aa9fcf030b00faa9fdd2b811f6e69094120a2deee8415e6a33d2d2a4a4d7701fbf89f7c45e272658ef

data/CHANGELOG.md

@@ -1,17 +1,36 @@
 # Changelog
 
-## [v3.3.3](https://github.com/bensheldon/good_job/tree/v3.3.3) (2022-08-02)
+## [v3.4.0](https://github.com/bensheldon/good_job/tree/v3.4.0) (2022-08-05)
 
-[Full Changelog](https://github.com/bensheldon/good_job/compare/v3.3.2...v3.3.3)
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v3.3.3...v3.4.0)
+
+**Implemented enhancements:**
+
+- Add cron\_enabled attribute to good\_job and pass it to process current state [\#675](https://github.com/bensheldon/good_job/pull/675) ([saksham-jain](https://github.com/saksham-jain))
+- Reverse Dashboard Filter Hierarchy to be: queues+jobs then state [\#666](https://github.com/bensheldon/good_job/pull/666) ([bensheldon](https://github.com/bensheldon))
+- Allow cron entries to be temporarily disabled and re-enabled through the Dashboard [\#649](https://github.com/bensheldon/good_job/pull/649) ([alex-klepa](https://github.com/alex-klepa))
+- Add Configuration.total\_estimated\_threads to report number of threads consumed by GoodJob [\#645](https://github.com/bensheldon/good_job/pull/645) ([bensheldon](https://github.com/bensheldon))
 
 **Closed issues:**
 
-- Async not working Rails 7 with puma CLI [\#685](https://github.com/bensheldon/good_job/issues/685)
+- Cron Schedule jobs add disable action [\#540](https://github.com/bensheldon/good_job/issues/540)
 
 **Merged pull requests:**
 
+- Removed text that implied an existing feature had not been finished [\#688](https://github.com/bensheldon/good_job/pull/688) ([pgvsalamander](https://github.com/pgvsalamander))
+
+## [v3.3.3](https://github.com/bensheldon/good_job/tree/v3.3.3) (2022-08-02)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v3.3.2...v3.3.3)
+
+**Fixed bugs:**
+
 - Detect usage of `puma` CLI for async mode [\#686](https://github.com/bensheldon/good_job/pull/686) ([bensheldon](https://github.com/bensheldon))
 
+**Closed issues:**
+
+- Async not working Rails 7 with puma CLI [\#685](https://github.com/bensheldon/good_job/issues/685)
+
 ## [v3.3.2](https://github.com/bensheldon/good_job/tree/v3.3.2) (2022-07-27)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v3.3.1...v3.3.2)

data/README.md

@@ -472,7 +472,7 @@ config.good_job.cron = {
     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!)
+    description: "Something helpful", # optional description that appears in Dashboard
   },
   another_task: {
     cron: "0 0,12 * * *",

data/app/controllers/good_job/cron_entries_controller.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 module GoodJob
   class CronEntriesController < GoodJob::ApplicationController
+    before_action :check_settings_migration!, only: [:enable, :disable]
+
     def index
       @cron_entries = CronEntry.all
     end
@@ -15,5 +17,23 @@ module GoodJob
       @cron_entry.enqueue(Time.current)
       redirect_back(fallback_location: cron_entries_path, notice: "Cron entry has been enqueued.")
     end
+
+    def enable
+      @cron_entry = CronEntry.find(params[:cron_key])
+      @cron_entry.enable
+      redirect_back(fallback_location: cron_entries_path, notice: "Cron entry has been enabled.")
+    end
+
+    def disable
+      @cron_entry = CronEntry.find(params[:cron_key])
+      @cron_entry.disable
+      redirect_back(fallback_location: cron_entries_path, notice: "Cron entry has been disabled.")
+    end
+
+    private
+
+    def check_settings_migration!
+      redirect_back(fallback_location: cron_entries_path, alert: "Requires pending GoodJob database migration.") unless GoodJob::Setting.migrated?
+    end
   end
 end

data/app/filters/good_job/base_filter.rb

@@ -24,18 +24,19 @@ module GoodJob
       @_last ||= records.last
     end
 
-    def job_classes
-      base_query.group("serialized_params->>'job_class'").count
-                .sort_by { |name, _count| name.to_s }
-                .to_h
-    end
-
     def queues
       base_query.group(:queue_name).count
                 .sort_by { |name, _count| name.to_s || EMPTY }
                 .to_h
     end
 
+    def job_classes
+      filtered_query(params.slice(:queue_name)).unscope(:select)
+                                               .group("serialized_params->>'job_class'").count
+                                               .sort_by { |name, _count| name.to_s }
+                                               .to_h
+    end
+
     def states
       raise NotImplementedError
     end
@@ -51,7 +52,7 @@ module GoodJob
       }.merge(override).delete_if { |_, v| v.blank? }
     end
 
-    def filtered_query
+    def filtered_query(filtered_params = params)
       raise NotImplementedError
     end
 

data/app/filters/good_job/jobs_filter.rb

@@ -2,26 +2,27 @@
 module GoodJob
   class JobsFilter < BaseFilter
     def states
+      query = filtered_query(params.except(:state)).unscope(:select)
       {
-        'scheduled' =>  base_query.scheduled.count,
-        'retried' => base_query.retried.count,
-        'queued' => base_query.queued.count,
-        'running' => base_query.running.count,
-        'finished' => base_query.finished.count,
-        'discarded' => base_query.discarded.count,
+        'scheduled' =>  query.scheduled.count,
+        'retried' => query.retried.count,
+        'queued' => query.queued.count,
+        'running' => query.running.count,
+        'finished' => query.finished.count,
+        'discarded' => query.discarded.count,
       }
     end
 
-    def filtered_query
+    def filtered_query(filter_params = params)
       query = base_query.includes(:executions).includes_advisory_locks
 
-      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?
-      query = query.search_text(params[:query]) if params[:query].present?
-      query = query.where(cron_key: params[:cron_key]) if params[:cron_key].present?
+      query = query.job_class(filter_params[:job_class]) if filter_params[:job_class].present?
+      query = query.where(queue_name: filter_params[:queue_name]) if filter_params[:queue_name].present?
+      query = query.search_text(filter_params[:query]) if filter_params[:query].present?
+      query = query.where(cron_key: filter_params[:cron_key]) if filter_params[:cron_key].present?
 
-      if params[:state]
-        case params[:state]
+      if filter_params[:state]
+        case filter_params[:state]
         when 'discarded'
           query = query.discarded
         when 'finished'

data/app/models/good_job/base_record.rb

@@ -16,5 +16,15 @@ module GoodJob
       DEPRECATION
       nil
     end
+
+    # Checks for whether the schema is up to date.
+    # Can be overriden by child class.
+    # @return [Boolean]
+    def self.migrated?
+      return true if connection.table_exists?(table_name)
+
+      migration_pending_warning!
+      false
+    end
   end
 end

data/app/models/good_job/cron_entry.rb

@@ -86,6 +86,20 @@ module GoodJob # :nodoc:
       end
     end
 
+    def enabled?
+      return true unless GoodJob::Setting.migrated?
+
+      GoodJob::Setting.cron_key_enabled?(key)
+    end
+
+    def enable
+      GoodJob::Setting.cron_key_enable(key)
+    end
+
+    def disable
+      GoodJob::Setting.cron_key_disable(key)
+    end
+
     def enqueue(cron_at = nil)
       GoodJob::CurrentThread.within do |current_thread|
         current_thread.cron_key = key

data/app/models/good_job/process.rb

@@ -48,6 +48,7 @@ module GoodJob # :nodoc:
         preserve_job_records: GoodJob.preserve_job_records,
         retry_on_unhandled_error: GoodJob.retry_on_unhandled_error,
         schedulers: GoodJob::Scheduler.instances.map(&:name),
+        cron_enabled: GoodJob.configuration.enable_cron?,
       }
     end
 

data/app/models/good_job/setting.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module GoodJob
+  class Setting < BaseRecord
+    CRON_KEYS_DISABLED = "cron_keys_disabled"
+
+    self.table_name = 'good_job_settings'
+
+    def self.cron_key_enabled?(key)
+      cron_disabled = find_by(key: CRON_KEYS_DISABLED)&.value || []
+      cron_disabled.exclude?(key.to_s)
+    end
+
+    def self.cron_key_enable(key)
+      setting = GoodJob::Setting.find_by(key: CRON_KEYS_DISABLED)
+      return unless setting&.value&.include?(key.to_s)
+
+      setting.value.delete(key.to_s)
+      setting.save!
+    end
+
+    def self.cron_key_disable(key)
+      setting = find_or_initialize_by(key: CRON_KEYS_DISABLED) do |record|
+        record.value = []
+      end
+      setting.value << key
+      setting.save!
+    end
+  end
+end

data/app/views/good_job/cron_entries/index.html.erb

@@ -37,10 +37,20 @@
             <% end %>
           </div>
           <div class="col d-flex gap-3 justify-content-end">
-            <%= button_to enqueue_cron_entry_path(cron_entry.id), method: :post, class: "btn btn-sm btn-outline-primary", form_class: "d-inline-block", aria: { label: "Run cron entry now" }, title: "Run cron entry now", data: { confirm: "Confirm run cron entry now" } do %>
-              <%= render "good_job/shared/icons/play" %>
-              Run Now
+            <%= button_to enqueue_cron_entry_path(cron_entry), method: :post, class: "btn btn-sm btn-outline-primary", form_class: "d-inline-block", aria: { label: "Enqueue cron entry now" }, title: "Enqueue cron entry now", data: { confirm: "Confirm enqueue cron entry now" } do %>
+              <%= render_icon "skip_forward" %>
             <% end %>
+
+            <% if cron_entry.enabled? %>
+              <%= button_to disable_cron_entry_path(cron_entry), method: :put, class: "btn btn-sm btn-outline-primary", form_class: "d-inline-block", aria: { label: "Disable cron entry" }, title: "Disable cron entry", data: { confirm: "Confirm disable cron entry" } do %>
+                <%= render_icon "pause" %>
+              <% end %>
+            <% else %>
+              <%= button_to enable_cron_entry_path(cron_entry), method: :put, class: "btn btn-sm btn-outline-primary", form_class: "d-inline-block", aria: { label: "Enable cron entry" }, title: "Enable cron entry", data: { confirm: "Confirm enable cron entry" } do %>
+                <%= render_icon "play" %>
+              <% end %>
+            <% end %>
+
             <%= tag.button type: "button", class: "btn btn-sm text-muted", role: "button",
                            title: "Inspect",
                            data: { bs_toggle: "collapse", bs_target: "##{dom_id(cron_entry, 'properties')}" },

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

@@ -2,14 +2,53 @@
   <div class="bg-light break-out">
     <h2 class="container-fluid pt-3 pb-2"><%= title %></h2>
 
-    <ul class="nav nav-tabs bg-light px-3 mb-3">
+    <%= form_with(url: "", method: :get, local: true, id: "filter_form", class: "container-fluid") do |form| %>
+      <%= hidden_field_tag :poll, params[:poll] %>
+      <%= hidden_field_tag :state, params[:state] %>
+      <div class="d-flex flex-row w-100">
+        <div class="me-2">
+          <select name="queue_name" id="job_queue_filter" class="form-select form-select-sm">
+            <option value="" <%= "selected='selected'" if params[:queue_name].blank? %>>All queues</option>
+
+            <% filter.queues.each do |name, count| %>
+              <option value="<%= name.to_param %>" <%= "selected='selected'" if params[:queue_name] == name %>><%= name %> (<%= number_with_delimiter(count) %>)</option>
+            <% end %>
+          </select>
+        </div>
+
+        <div class="me-2">
+          <select name="job_class" id="job_class_filter" class="form-select form-select-sm">
+            <option value="" <%= "selected='selected'" if params[:job_class].blank? %>>All jobs</option>
+
+            <% filter.job_classes.each do |name, count| %>
+              <option value="<%= name.to_param %>" <%= "selected='selected'" if params[:job_class] == name %>><%= name %> (<%= number_with_delimiter(count) %>)</option>
+            <% end %>
+          </select>
+        </div>
+
+        <div class="me-2 flex-fill">
+          <%= search_field_tag "query", params[:query], class: "form-control form-control-sm", placeholder: "Search by class, job id, job params, and error text." %>
+        </div>
+
+        <div class="d-flex flex-col align-items-end">
+          <div>
+            <%= form.submit "Search", name: nil, class: "btn btn-primary btn-sm" %>
+            <%= link_to filter.to_params(job_class: nil, state: nil, queue_name: nil, query: nil), class: "btn btn-secondary btn-sm" do %>
+              Clear
+            <% end %>
+          </div>
+        </div>
+      </div>
+    <% end %>
+
+    <ul class="nav nav-tabs bg-light px-3 my-3">
       <li class="nav-item">
-        <%= link_to "All", url_for(state: nil), class: "nav-link #{"active" unless params[:state]}" %>
+        <%= link_to "All", filter.to_params(state: nil), class: "nav-link #{"active" unless params[:state].present?}" %>
       </li>
 
       <% 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 %>
+          <%= link_to filter.to_params(state: name), class: "nav-link #{"active" if params[:state] == name}" do %>
             <%= t(name, scope: 'good_job.status') %>
             <span class="badge bg-primary rounded-pill <%= "bg-secondary" if count == 0 %>"><%= number_with_delimiter(count) %></span>
           <% end %>
@@ -18,43 +57,6 @@
     </ul>
   </div>
 
-  <%= form_with(url: "", method: :get, local: true, id: "filter_form", class: "container-fluid") do |form| %>
-    <%= hidden_field_tag :poll, params[:poll] %>
-    <%= hidden_field_tag :state, params[:state] %>
-    <div class="d-flex flex-row w-100">
-      <div class="me-2">
-        <select name="job_class" id="job_class_filter" class="form-select form-select-sm">
-          <option value="" <%= "selected='selected'" if params[:job_class].blank? %>>All jobs</option>
-
-          <% filter.job_classes.each do |name, count| %>
-            <option value="<%= name.to_param %>" <%= "selected='selected'" if params[:job_class] == name %>><%= name %> (<%= count %>)</option>
-          <% end %>
-        </select>
-      </div>
-
-      <div class="me-2">
-        <select name="queue_name" id="job_queue_filter" class="form-select form-select-sm">
-          <option value="" <%= "selected='selected'" if params[:queue_name].blank? %>>All queues</option>
-
-          <% filter.queues.each do |name, count| %>
-            <option value="<%= name.to_param %>" <%= "selected='selected'" if params[:queue_name] == name %>><%= name %> (<%= count %>)</option>
-          <% end %>
-        </select>
-      </div>
-
-      <div class="me-2 flex-fill">
-        <%= search_field_tag "query", params[:query], class: "form-control form-control-sm", placeholder: "Search by class, job id, job params, and error text." %>
-      </div>
-
-      <div class="d-flex flex-col align-items-end">
-        <div>
-          <%= form.submit "Search", name: nil, class: "btn btn-primary btn-sm" %>
-          <%= link_to "Clear all", filter.to_params(job_class: nil, state: nil, queue_name: nil, query: nil), class: "btn btn-secondary btn-sm" %>
-        </div>
-      </div>
-    </div>
-  <% end %>
-
   <%= javascript_tag nonce: true do %>
     document.addEventListener("DOMContentLoaded", () => {
       document.querySelectorAll("#job_class_filter, #job_queue_filter").forEach((filter) => {

data/app/views/good_job/shared/icons/_pause.html.erb

@@ -0,0 +1,4 @@
+<!-- https://icons.getbootstrap.com/icons/pause-btn/ -->
+<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-pause" viewBox="0 0 16 16">
+  <path d="M6 3.5a.5.5 0 0 1 .5.5v8a.5.5 0 0 1-1 0V4a.5.5 0 0 1 .5-.5zm4 0a.5.5 0 0 1 .5.5v8a.5.5 0 0 1-1 0V4a.5.5 0 0 1 .5-.5z" />
+</svg>

data/config/routes.rb

@@ -18,6 +18,8 @@ GoodJob::Engine.routes.draw do
   resources :cron_entries, only: %i[index show], param: :cron_key do
     member do
       post :enqueue
+      put :enable
+      put :disable
     end
   end
 

data/lib/generators/good_job/templates/install/migrations/create_good_jobs.rb.erb

@@ -26,6 +26,13 @@ class CreateGoodJobs < ActiveRecord::Migration<%= migration_version %>
       t.jsonb :state
     end
 
+    create_table :good_job_settings, id: :uuid do |t|
+      t.timestamps
+      t.text :key
+      t.jsonb :value
+      t.index :key, unique: true
+    end
+
     add_index :good_jobs, :scheduled_at, where: "(finished_at IS NULL)", name: "index_good_jobs_on_scheduled_at"
     add_index :good_jobs, [:queue_name, :scheduled_at], where: "(finished_at IS NULL)", name: :index_good_jobs_on_queue_name_and_scheduled_at
     add_index :good_jobs, [:active_job_id, :created_at], name: :index_good_jobs_on_active_job_id_and_created_at

data/lib/generators/good_job/templates/update/migrations/02_create_good_job_settings.rb.erb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+class CreateGoodJobSettings < ActiveRecord::Migration<%= migration_version %>
+  def change
+    reversible do |dir|
+      dir.up do
+        # Ensure this incremental update migration is idempotent
+        # with monolithic install migration.
+        return if connection.table_exists?(:good_job_settings)
+      end
+    end
+
+    create_table :good_job_settings, id: :uuid do |t|
+      t.timestamps
+      t.text :key
+      t.jsonb :value
+      t.index :key, unique: true
+    end
+  end
+end

data/lib/good_job/configuration.rb

@@ -42,6 +42,34 @@ module GoodJob
     # @return [Hash]
     attr_reader :env
 
+    # Returns the maximum number of threads GoodJob might consume
+    # @param warn [Boolean] whether to print a warning when over the limit
+    # @return [Integer]
+    def self.total_estimated_threads(warn: false)
+      configuration = new({})
+
+      cron_threads = configuration.enable_cron? ? 2 : 0
+      notifier_threads = 1
+      scheduler_threads = GoodJob::Scheduler.instances.sum { |scheduler| scheduler.stats[:max_threads] }
+
+      good_job_threads = cron_threads + notifier_threads + scheduler_threads
+      puma_threads = (Puma::Server.current&.max_threads if defined?(Puma::Server)) || 0
+
+      total_threads = good_job_threads + puma_threads
+      activerecord_pool_size = ActiveRecord::Base.connection_pool&.size
+
+      if warn && activerecord_pool_size && total_threads > activerecord_pool_size
+        message = "GoodJob is using #{good_job_threads} threads, " \
+                  "#{" and Puma is using #{puma_threads} threads, " if puma_threads.positive?}" \
+                  "which is #{total_threads - activerecord_pool_size} thread(s) more than ActiveRecord's database connection pool size of #{activerecord_pool_size}. " \
+                  "Consider increasing ActiveRecord's database connection pool size in config/database.yml."
+
+        GoodJob.logger.warn message
+      end
+
+      good_job_threads
+    end
+
     # @param options [Hash] Any explicitly specified configuration options to
     #   use. Keys are symbols that match the various methods on this class.
     # @param env [Hash] A +Hash+ from which to read environment variables that

data/lib/good_job/cron_manager.rb

@@ -89,7 +89,7 @@ module GoodJob # :nodoc:
         thr_scheduler.create_task(thr_cron_entry)
 
         Rails.application.executor.wrap do
-          cron_entry.enqueue(thr_cron_at)
+          cron_entry.enqueue(thr_cron_at) if thr_cron_entry.enabled?
         end
       end
 

data/lib/good_job/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 3.3.3
+  version: 3.4.0
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-02 00:00:00.000000000 Z
+date: 2022-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -379,6 +379,7 @@ files:
 - app/models/good_job/job.rb
 - app/models/good_job/lockable.rb
 - app/models/good_job/process.rb
+- app/models/good_job/setting.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
@@ -398,6 +399,7 @@ files:
 - app/views/good_job/shared/icons/_dots.html.erb
 - app/views/good_job/shared/icons/_exclamation.html.erb
 - app/views/good_job/shared/icons/_info.html.erb
+- app/views/good_job/shared/icons/_pause.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
@@ -413,6 +415,7 @@ files:
 - lib/generators/good_job/install_generator.rb
 - lib/generators/good_job/templates/install/migrations/create_good_jobs.rb.erb
 - lib/generators/good_job/templates/update/migrations/01_create_good_jobs.rb.erb
+- lib/generators/good_job/templates/update/migrations/02_create_good_job_settings.rb.erb
 - lib/generators/good_job/update_generator.rb
 - lib/good_job.rb
 - lib/good_job/active_job_extensions/concurrency.rb
@@ -426,7 +429,6 @@ files:
 - lib/good_job/daemon.rb
 - lib/good_job/dependencies.rb
 - lib/good_job/engine.rb
-- lib/good_job/enqueuing.rb
 - lib/good_job/job_performer.rb
 - lib/good_job/log_subscriber.rb
 - lib/good_job/multi_scheduler.rb

data/lib/good_job/enqueuing.rb

@@ -1,4 +0,0 @@
-module GoodJob
-  module Enqueing
-  end
-end