good_job 4.19.2 → 4.19.4

data/app/frontend/good_job/style.css

@@ -3,6 +3,103 @@
   height: 200px;
 }
 
+.chart-range-selection {
+  position: absolute;
+  pointer-events: none;
+  background-color: rgba(var(--bs-primary-rgb), 0.2);
+  border: 1px solid rgba(var(--bs-primary-rgb), 0.75);
+}
+
+.performance-range-control {
+  align-items: stretch;
+  display: flex;
+  flex-wrap: wrap;
+  gap: 0.25rem;
+  justify-content: flex-start;
+  max-width: 100%;
+  width: 100%;
+}
+
+.performance-range-state,
+.performance-range-control .btn {
+  align-items: center;
+  display: inline-flex;
+}
+
+.performance-range-state {
+  background-color: var(--bs-body-bg);
+  border: var(--bs-border-width) solid var(--bs-border-color);
+  border-radius: var(--bs-border-radius);
+  color: var(--bs-body-color);
+  font-size: 1rem;
+  line-height: 1.5;
+  padding: 0.375rem 0.75rem;
+  white-space: nowrap;
+}
+
+.performance-range-date {
+  cursor: pointer;
+  gap: 0.25rem;
+  position: relative;
+}
+
+.performance-range-native-input {
+  cursor: pointer;
+  height: 100%;
+  inset: 0;
+  opacity: 0;
+  position: absolute;
+  width: 100%;
+  z-index: 1;
+}
+
+.performance-range-date:focus-within {
+  border-color: var(--bs-primary);
+  box-shadow: 0 0 0 0.125rem var(--bs-body-bg);
+  outline: 0.1875rem solid var(--bs-primary);
+  outline-offset: 0.125rem;
+  z-index: 2;
+}
+
+.performance-range-date:has(.performance-range-native-input:invalid) {
+  border-color: var(--bs-danger);
+}
+
+.performance-range-toggle {
+  margin-left: calc(-1 * var(--bs-border-width));
+}
+
+.performance-range-toggle:focus-visible {
+  border-color: var(--bs-primary);
+  box-shadow: 0 0 0 0.125rem var(--bs-body-bg);
+  outline: 0.1875rem solid var(--bs-primary);
+  outline-offset: 0.125rem;
+  position: relative;
+  z-index: 2;
+}
+
+.performance-range-key,
+.performance-range-option-key {
+  justify-content: center;
+  min-width: 2.5rem;
+}
+
+.performance-range-menu {
+  min-width: 14rem;
+}
+
+.performance-name {
+  overflow-wrap: anywhere;
+  white-space: normal;
+}
+
+@media (max-width: 575.98px) {
+  .performance-range-control {
+    gap: 0.125rem;
+    width: 100%;
+  }
+}
+
 .legend-item-color-box {
   display: inline-block;
   flex-shrink: 0;

data/app/helpers/good_job/application_helper.rb

@@ -34,6 +34,22 @@ module GoodJob
       end
     end
 
+    def format_performance_bucket_size(seconds)
+      if seconds >= 365.days && (seconds % 365.days.to_i).zero?
+        t "good_job.performance.range.bucket_size.years", count: seconds / 365.days.to_i
+      elsif seconds >= 30.days && (seconds % 30.days.to_i).zero?
+        t "good_job.performance.range.bucket_size.months", count: seconds / 30.days.to_i
+      elsif seconds >= 1.day && (seconds % 1.day.to_i).zero?
+        t "good_job.performance.range.bucket_size.days", count: seconds / 1.day.to_i
+      elsif (seconds % 1.hour.to_i).zero?
+        t "good_job.performance.range.bucket_size.hours", count: seconds / 1.hour.to_i
+      elsif (seconds % 1.minute.to_i).zero?
+        t "good_job.performance.range.bucket_size.minutes", count: seconds / 1.minute.to_i
+      else
+        t "good_job.performance.range.bucket_size.seconds", count: seconds
+      end
+    end
+
     def relative_time(timestamp, **options)
       options = options.reverse_merge({ scope: "good_job.datetime.distance_in_words" })
       text = t("good_job.helpers.relative_time.#{timestamp.future? ? 'future' : 'past'}", time: time_ago_in_words(timestamp, **options))

data/app/models/good_job/cron_entry.rb

@@ -13,6 +13,15 @@ module GoodJob # :nodoc:
 
     attr_reader :params
 
+    VALUE_TYPES = {
+      args: Array,
+      kwargs: Hash,
+      set: Hash,
+    }.freeze
+
+    validate :validate_job_class
+    validate :validate_value_types
+
     def self.all(configuration: nil)
       configuration ||= GoodJob.configuration
       configuration.cron_entries
@@ -28,8 +37,8 @@ module GoodJob # :nodoc:
 
       join_clause = <<~SQL.squish
         CROSS JOIN LATERAL (
-          SELECT * FROM good_jobs
-          WHERE good_jobs.cron_key = cron_keys.cron_key
+          SELECT * FROM #{GoodJob::Job.quoted_table_name}
+          WHERE #{GoodJob::Job.quoted_table_name}.cron_key = cron_keys.cron_key
           ORDER BY cron_at DESC NULLS LAST
           LIMIT 1
         ) AS lateral_jobs
@@ -126,8 +135,7 @@ module GoodJob # :nodoc:
         current_thread.cron_at = cron_at
 
         I18n.with_locale(I18n.default_locale) do
-          job_klass = job_class_value
-          job_klass = job_klass.constantize if job_klass.is_a?(String)
+          job_klass = resolve_job_class
           next unless job_klass.is_a?(Class)
 
           configured_job = job_klass.set(set_value)
@@ -175,6 +183,28 @@ module GoodJob # :nodoc:
 
     private
 
+    def validate_job_class
+      return if job_class.blank? || job_class.is_a?(Class) || job_class.respond_to?(:call)
+
+      resolve_job_class
+    rescue NameError
+      errors.add(:class, "'#{job_class}' does not exist")
+    end
+
+    def validate_value_types
+      VALUE_TYPES.each do |attribute, type|
+        value = public_send(attribute)
+        next if value.blank? || value.respond_to?(:call) || value.is_a?(type)
+
+        errors.add(attribute, "must be a #{type}")
+      end
+    end
+
+    def resolve_job_class
+      value = job_class_value
+      value.is_a?(String) ? value.constantize : value
+    end
+
     def cron
       params.fetch(:cron)
     end

data/app/models/good_job/setting.rb

@@ -101,10 +101,22 @@ module GoodJob
       setting.save!
     end
 
-    def self.paused?(queue: nil, job_class: nil, label: nil)
-      raise ArgumentError, "Must provide at most one of queue, job_class, or label" if [queue, job_class, label].many?(&:present?)
+    def self.paused?(active_job: nil, queue: nil, job_class: nil, label: nil)
+      raise ArgumentError, "Must provide at most one of active_job, queue, job_class, or label" if [active_job, queue, job_class, label].many?(&:present?)
 
-      if queue
+      if active_job
+        pauses = paused
+
+        return :queue_name_paused if pauses[:queues].include?(active_job.queue_name.to_s)
+        return :job_class_paused if pauses[:job_classes].include?(active_job.class.to_s)
+
+        labels = active_job.respond_to?(:good_job_labels) ? Array(active_job.good_job_labels) : []
+        labels = labels.filter_map { |label| label.to_s.presence }.uniq
+
+        return :label_paused if (labels & pauses[:labels]).any?
+
+        false
+      elsif queue
         queue.in? paused(:queues)
       elsif job_class
         job_class.in? paused(:job_classes)
@@ -116,7 +128,7 @@ module GoodJob
     end
 
     def self.paused(type = nil)
-      setting = find_by(key: PAUSES)
+      setting = uncached { find_by(key: PAUSES) }
       pauses = setting&.value&.deep_dup || { "queues" => [], "job_classes" => [], "labels" => [] }
       pauses = pauses.with_indifferent_access
 

data/app/views/good_job/batches/show.html.erb

@@ -25,7 +25,7 @@
 <div class="my-4">
   <h5><%= t ".attributes" %></h5>
   <div class="bg-dark text-secondary p-3 rounded">
-    <%= tag.pre JSON.pretty_generate @batch.display_attributes, class: 'text-wrap text-break' %>
+    <%= tag.pre JSON.pretty_generate(@batch.display_attributes), class: 'text-wrap text-break' %>
   </div>
 </div>
 

data/app/views/good_job/performance/_range.erb

@@ -0,0 +1,91 @@
+<% range_badge_label = performance_range.key || t(".custom_range") %>
+<% reload_range_label = t(".reload_range") %>
+<% reload_range_query = range_context.merge(performance_range.reload_params).to_query %>
+<% reload_range_path = reload_range_query.present? ? "#{range_path}?#{reload_range_query}" : range_path %>
+<% custom_range_path = "#{range_path}?#{range_context.merge(performance_range.custom_params).to_query}" %>
+<% time_zone_label = Time.zone.name %>
+<% range_form_data = {
+  action: "submit->performance-range#prepareSubmission",
+  controller: "performance-range",
+  performance_range_application_time_zone_value: time_zone_label,
+  performance_range_application_time_zone_identifier_value: Time.zone.tzinfo.name,
+  performance_range_end_fallback_value: performance_range.end_local_value,
+  performance_range_end_label_value: performance_range.end_label,
+  performance_range_end_timestamp_value: performance_range.canonical_timestamp(performance_range.end_time),
+  performance_range_label_style_value: performance_range.label_style,
+  performance_range_maximum_value: GoodJob::PerformanceRange::MAXIMUM_LOCAL_VALUE,
+  performance_range_minimum_value: GoodJob::PerformanceRange::MINIMUM_LOCAL_VALUE,
+  performance_range_start_fallback_value: performance_range.start_local_value,
+  performance_range_start_label_value: performance_range.start_label,
+  performance_range_start_timestamp_value: performance_range.canonical_timestamp(performance_range.start_time),
+} %>
+
+<%= tag.form(
+      action: range_path,
+      method: "get",
+      class: "performance-range-toolbar mb-3",
+      aria: { describedby: "performance-range-time-zone", labelledby: "performance-range-name" },
+      data: range_form_data
+    ) do %>
+  <span class="visually-hidden" id="performance-range-name"><%= t ".time_range" %></span>
+  <% if range_context["locale"] %>
+    <%= hidden_field_tag "locale", range_context["locale"] %>
+  <% end %>
+  <%= hidden_field_tag "chart_start", performance_range.canonical_timestamp(performance_range.start_time), disabled: true, id: nil, data: { performance_range_target: "startCanonicalInput" } %>
+  <%= hidden_field_tag "chart_end", performance_range.canonical_timestamp(performance_range.end_time), disabled: true, id: nil, data: { performance_range_target: "endCanonicalInput" } %>
+  <%= hidden_field_tag GoodJob::PerformanceRange::TIME_ZONE_PARAMETER_KEY, nil, disabled: true, id: nil, data: { performance_range_target: "timeZoneInput" } %>
+  <div class="performance-range-control">
+    <label class="performance-range-state performance-range-date" title="<%= t ".start_time" %>">
+      <%= render_icon "clock", class: "me-1" %>
+      <span data-performance-range-target="startLabel"><%= performance_range.start_label %></span>
+      <%= datetime_local_field_tag "chart_start", performance_range.start_local_value, min: GoodJob::PerformanceRange::MINIMUM_LOCAL_VALUE, max: GoodJob::PerformanceRange::MAXIMUM_LOCAL_VALUE, step: 1, required: true, class: "performance-range-native-input", aria: { describedby: "performance-range-time-zone", label: t(".start_time") }, data: { performance_range_target: "startInput", action: "input->performance-range#edit input->performance-range#constrain change->performance-range#constrain change->performance-range#submitRange click->performance-range#openPicker" } %>
+    </label>
+    <label class="performance-range-state performance-range-date" title="<%= t ".end_time" %>">
+      <span data-performance-range-target="endLabel"><%= performance_range.end_label %></span>
+      <%= datetime_local_field_tag "chart_end", performance_range.end_local_value, min: GoodJob::PerformanceRange::MINIMUM_LOCAL_VALUE, max: GoodJob::PerformanceRange::MAXIMUM_LOCAL_VALUE, step: 1, required: true, class: "performance-range-native-input", aria: { describedby: "performance-range-time-zone", label: t(".end_time") }, data: { performance_range_target: "endInput", action: "input->performance-range#edit input->performance-range#constrain change->performance-range#constrain change->performance-range#submitRange click->performance-range#openPicker" } %>
+    </label>
+    <div class="performance-range-selector d-inline-flex position-relative">
+      <span class="performance-range-state performance-range-key rounded-end-0">
+        <%= range_badge_label %>
+      </span>
+      <button class="btn btn-outline-secondary dropdown-toggle dropdown-toggle-split performance-range-toggle rounded-start-0" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-label="<%= t ".open_time_ranges" %>">
+        <span class="visually-hidden"><%= t ".open_time_ranges" %></span>
+      </button>
+      <ul class="dropdown-menu dropdown-menu-end performance-range-menu">
+        <li><h6 class="dropdown-header"><%= t ".quick_ranges" %></h6></li>
+        <% performance_range.options.each do |range| %>
+          <% active = performance_range.key == range[:key] %>
+          <% preset_range_path = "#{range_path}?#{range_context.merge('chart_range' => range[:key]).to_query}" %>
+          <li>
+            <%= link_to preset_range_path, class: ["dropdown-item", "performance-range-menu-item", "d-flex", "align-items-center", "gap-2", ("active" if active)], aria: { current: ("page" if active) } do %>
+              <span class="performance-range-option-key"><%= range[:label] %></span>
+              <span class="flex-grow-1"><%= t ".range_options.#{range[:key]}" %></span>
+            <% end %>
+          </li>
+        <% end %>
+        <li><hr class="dropdown-divider"></li>
+        <li>
+          <%= link_to custom_range_path, class: ["dropdown-item", "performance-range-menu-item", "d-flex", "align-items-center", "gap-2", "performance-range-custom", ("active" if performance_range.custom?)], aria: { current: ("page" if performance_range.custom?) } do %>
+            <span class="performance-range-option-key">#</span>
+            <span class="flex-grow-1"><%= t ".custom_range" %></span>
+            <% if local_assigns[:drag_enabled] %>
+              <small class="text-body-secondary text-nowrap"><%= t ".custom_range_hint" %></small>
+            <% end %>
+          <% end %>
+        </li>
+      </ul>
+    </div>
+    <%= link_to reload_range_path, class: %w[btn btn-outline-secondary performance-range-reload flex-shrink-0], aria: { label: reload_range_label }, data: { turbo: false }, title: reload_range_label do %>
+      <%= render_icon "arrow_clockwise" %>
+      <span class="visually-hidden"><%= reload_range_label %></span>
+    <% end %>
+  </div>
+  <div class="performance-range-meta small text-body-secondary mt-2" id="performance-range-time-zone">
+    <span><%= t ".time_zone" %></span>
+    <span data-performance-range-target="timeZoneLabel"><%= time_zone_label %></span>
+    <% if local_assigns[:bucket_size] %>
+      <span class="mx-1" aria-hidden="true">·</span>
+      <span class="performance-chart-bucket-size"><%= t ".chart_bucket_size", size: bucket_size %></span>
+    <% end %>
+  </div>
+<% end %>

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

@@ -1,8 +1,12 @@
-<div class="border-bottom">
+<div class="border-bottom mb-3">
   <h2 class="pt-3 pb-2"><%= t ".title" %></h2>
 </div>
 
-<%= render 'good_job/shared/chart_container', chart_data: GoodJob::PerformanceIndexChart.new.data %>
+<%= render "range", performance_range: @performance_range, drag_enabled: true, range_context: @performance_range_context, range_path: performance_index_path(locale: nil), bucket_size: format_performance_bucket_size(@performance_range.interval_seconds) %>
+
+<%= render 'good_job/shared/chart_container', chart_data: @chart_data %>
+
+<% performance_range_query = @performance_range_context.merge(@performance_range.navigation_params).to_query %>
 
 <div class="my-3 card">
   <div class="list-group list-group-flush text-nowrap" role="table">
@@ -16,12 +20,16 @@
       </div>
     </header>
 
+    <% if @performances.empty? %>
+      <div role="row" class="list-group-item py-3 text-body-secondary"><%= t ".no_executions" %></div>
+    <% end %>
+
     <% @performances.each do |performance| %>
       <div role="row" class="list-group-item py-3">
         <div class="row align-items-center">
-          <div class="col-12 col-lg-4">
+          <div class="col-12 col-lg-4 performance-name">
             <div class="d-flex gap-3 justify-content-between">
-              <%= link_to performance.job_class, performance_path(performance.job_class) %>
+              <%= link_to performance.job_class, "#{performance_path(performance.job_class, locale: nil)}?#{performance_range_query}" %>
             </div>
           </div>
           <div class="col-6 col-lg-2 text-wrap">
@@ -58,10 +66,14 @@
       </div>
     </header>
 
+    <% if @queue_performances.empty? %>
+      <div role="row" class="list-group-item py-3 text-body-secondary"><%= t ".no_executions" %></div>
+    <% end %>
+
     <% @queue_performances.each do |performance| %>
       <div role="row" class="list-group-item py-3">
         <div class="row align-items-center">
-          <div class="col-12 col-lg-4">
+          <div class="col-12 col-lg-4 performance-name">
             <div class="d-flex gap-3 justify-content-between">
               <%= performance.queue_name %>
             </div>

data/app/views/good_job/performance/show.html.erb

@@ -1,5 +1,7 @@
-<div class="border-bottom">
+<div class="border-bottom mb-3">
   <h2 class="pt-3 pb-2"><%= t ".title" %> - <%= @job_class %></h2>
 </div>
 
-<%= render 'good_job/shared/chart_container', chart_data: GoodJob::PerformanceShowChart.new(@job_class).data %>
+<%= render "range", performance_range: @performance_range, range_context: @performance_range_context, range_path: performance_path(@job_class, locale: nil) %>
+
+<%= render 'good_job/shared/chart_container', chart_data: @chart_data %>