good_job 2.6.0 → 2.6.1

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module GoodJob
+  class ScheduledByQueueChart
+    def initialize(filter)
+      @filter = filter
+    end
+
+    def data
+      end_time = Time.current
+      start_time = end_time - 1.day
+
+      count_query = Arel.sql(GoodJob::Execution.pg_or_jdbc_query(<<~SQL.squish))
+        SELECT *
+        FROM generate_series(
+          date_trunc('hour', $1::timestamp),
+          date_trunc('hour', $2::timestamp),
+          '1 hour'
+        ) timestamp
+        LEFT JOIN (
+          SELECT
+              date_trunc('hour', scheduled_at) AS scheduled_at,
+              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}
+            ) sources
+            GROUP BY date_trunc('hour', scheduled_at), queue_name
+        ) sources ON sources.scheduled_at = timestamp
+        ORDER BY timestamp ASC
+      SQL
+
+      binds = [[nil, start_time], [nil, end_time]]
+      executions_data = GoodJob::Execution.connection.exec_query(GoodJob::Execution.pg_or_jdbc_query(count_query), "GoodJob Dashboard Chart", binds)
+
+      queue_names = executions_data.reject { |d| d['count'].nil? }.map { |d| d['queue_name'] || BaseFilter::EMPTY }.uniq
+      labels = []
+      queues_data = executions_data.to_a.group_by { |d| d['timestamp'] }.each_with_object({}) do |(timestamp, values), hash|
+        labels << timestamp.in_time_zone.strftime('%H:%M')
+        queue_names.each do |queue_name|
+          (hash[queue_name] ||= []) << values.find { |d| d['queue_name'] == queue_name }&.[]('count')
+        end
+      end
+
+      {
+        labels: labels,
+        datasets: queues_data.map do |queue, data|
+          label = queue || '(none)'
+          {
+            label: label,
+            data: data,
+            backgroundColor: string_to_hsl(label),
+            borderColor: string_to_hsl(label),
+          }
+        end,
+      }
+    end
+
+    def string_to_hsl(string)
+      hash_value = string.sum
+
+      hue = hash_value % 360
+      saturation = (hash_value % 50) + 50
+      lightness = '50'
+
+      "hsl(#{hue}, #{saturation}%, #{lightness}%)"
+    end
+  end
+end

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

@@ -15,18 +15,18 @@ module GoodJob
       render file: GoodJob::Engine.root.join("app", "assets", "vendor", "bootstrap", "bootstrap.bundle.min.js")
     end
 
-    def chartist_css
-      render file: GoodJob::Engine.root.join("app", "assets", "vendor", "chartist", "chartist.css")
-    end
-
-    def chartist_js
-      render file: GoodJob::Engine.root.join("app", "assets", "vendor", "chartist", "chartist.js")
+    def chartjs_js
+      render file: GoodJob::Engine.root.join("app", "assets", "vendor", "chartjs", "chart.min.js")
     end
 
     def rails_ujs_js
       render file: GoodJob::Engine.root.join("app", "assets", "vendor", "rails_ujs.js")
     end
 
+    def scripts_js
+      render file: GoodJob::Engine.root.join("app", "assets", "scripts.js")
+    end
+
     def style_css
       render file: GoodJob::Engine.root.join("app", "assets", "style.css")
     end

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

@@ -2,6 +2,7 @@
 module GoodJob
   class BaseFilter
     DEFAULT_LIMIT = 25
+    EMPTY = '[none]'
 
     attr_accessor :params, :base_query
 
@@ -31,7 +32,7 @@ module GoodJob
 
     def queues
       base_query.group(:queue_name).count
-                .sort_by { |name, _count| name.to_s }
+                .sort_by { |name, _count| name.to_s || EMPTY }
                 .to_h
     end
 
@@ -39,58 +40,18 @@ module GoodJob
       raise NotImplementedError
     end
 
-    def to_params(override)
+    def to_params(override = {})
       {
         job_class: params[:job_class],
         limit: params[:limit],
         queue_name: params[:queue_name],
+        query: params[:query],
         state: params[:state],
-      }.merge(override).delete_if { |_, v| v.nil? }
+      }.merge(override).delete_if { |_, v| v.blank? }
     end
 
-    def chart_data
-      count_query = Arel.sql(GoodJob::Execution.pg_or_jdbc_query(<<~SQL.squish))
-        SELECT *
-        FROM generate_series(
-          date_trunc('hour', $1::timestamp),
-          date_trunc('hour', $2::timestamp),
-          '1 hour'
-        ) timestamp
-        LEFT JOIN (
-          SELECT
-              date_trunc('hour', scheduled_at) AS scheduled_at,
-              queue_name,
-              count(*) AS count
-            FROM (
-              #{filtered_query.except(:select).select('queue_name', 'COALESCE(good_jobs.scheduled_at, good_jobs.created_at)::timestamp AS scheduled_at').to_sql}
-            ) sources
-            GROUP BY date_trunc('hour', scheduled_at), queue_name
-        ) sources ON sources.scheduled_at = timestamp
-        ORDER BY timestamp ASC
-      SQL
-
-      current_time = Time.current
-      binds = [[nil, current_time - 1.day], [nil, current_time]]
-      executions_data = GoodJob::Execution.connection.exec_query(count_query, "GoodJob Dashboard Chart", binds)
-
-      queue_names = executions_data.map { |d| d['queue_name'] }.uniq
-      labels = []
-      queues_data = executions_data.to_a.group_by { |d| d['timestamp'] }.each_with_object({}) do |(timestamp, values), hash|
-        labels << timestamp.in_time_zone.strftime('%H:%M %z')
-        queue_names.each do |queue_name|
-          (hash[queue_name] ||= []) << values.find { |d| d['queue_name'] == queue_name }&.[]('count')
-        end
-      end
-
-      {
-        labels: labels,
-        series: queues_data.map do |queue, data|
-          {
-            name: queue,
-            data: data,
-          }
-        end,
-      }
+    def filtered_query
+      raise NotImplementedError
     end
 
     private
@@ -98,9 +59,5 @@ module GoodJob
     def default_base_query
       raise NotImplementedError
     end
-
-    def filtered_query
-      raise NotImplementedError
-    end
   end
 end

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

@@ -10,16 +10,11 @@ module GoodJob
       }
     end
 
-    private
-
-    def default_base_query
-      GoodJob::Execution.all
-    end
-
     def filtered_query
       query = base_query
-      query = query.job_class(params[:job_class]) if params[:job_class]
-      query = query.where(queue_name: params[:queue_name]) if params[:queue_name]
+      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(params['query']) if params[:query].present?
 
       if params[:state]
         case params[:state]
@@ -36,5 +31,11 @@ module GoodJob
 
       query
     end
+
+    private
+
+    def default_base_query
+      GoodJob::Execution.all
+    end
   end
 end

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

@@ -12,18 +12,13 @@ module GoodJob
       }
     end
 
-    private
-
-    def default_base_query
-      GoodJob::ActiveJobJob.all
-    end
-
     def filtered_query
       query = base_query.includes(:executions)
                         .joins_advisory_locks.select('good_jobs.*', 'pg_locks.locktype AS locktype')
 
-      query = query.job_class(params[:job_class]) if params[:job_class]
-      query = query.where(queue_name: params[:queue_name]) if params[:queue_name]
+      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(params['query']) if params[:query].present?
 
       if params[:state]
         case params[:state]
@@ -44,5 +39,11 @@ module GoodJob
 
       query
     end
+
+    private
+
+    def default_base_query
+      GoodJob::ActiveJobJob.all
+    end
   end
 end

data/engine/app/views/good_job/executions/index.html.erb

@@ -1,5 +1,5 @@
 <div class="card my-3 p-6">
-  <%= render 'good_job/shared/chart', chart_data: @filter.chart_data %>
+  <%= render 'good_job/shared/chart', chart_data: GoodJob::ScheduledByQueueChart.new(@filter).data %>
 </div>
 
 <%= render 'good_job/shared/filter', filter: @filter %>

data/engine/app/views/good_job/jobs/_table.erb

@@ -22,7 +22,7 @@
       </thead>
       <tbody>
         <% jobs.each do |job| %>
-          <tr id="<%= dom_id(job) %>">
+          <tr class="<%= dom_class(job) %>" id="<%= dom_id(job) %>">
             <td>
               <%= link_to job_path(job.id) do %>
                 <code><%= job.id %></code>

data/engine/app/views/good_job/jobs/index.html.erb

@@ -1,5 +1,5 @@
 <div class="card my-3 p-6">
-  <%= render 'good_job/shared/chart', chart_data: @filter.chart_data %>
+  <%= render 'good_job/shared/chart', chart_data: GoodJob::ScheduledByQueueChart.new(@filter).data %>
 </div>
 
 <%= render 'good_job/shared/filter', filter: @filter %>

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

@@ -1,52 +1,25 @@
-<div id="chart"></div>
+<div class="chart-wrapper">
+  <canvas id="chart"></canvas>
+</div>
 
 <%= javascript_tag nonce: true do %>
-  new Chartist.Line('#chart', <%== chart_data.to_json %>, {
-    height: '300px',
-    fullWidth: true,
-    chartPadding: {
-      right: 40,
-      top: 20,
-      bottom: 20
+  const chartData = <%== chart_data.to_json %>;
+
+  const ctx = document.getElementById('chart').getContext('2d');
+  const chart = new Chart(ctx, {
+    type: 'line',
+    data: {
+      labels: chartData.labels,
+      datasets: chartData.datasets
     },
-    axisX: {
-      labelInterpolationFnc: function(value, index) {
-        return index % 3 === 0 ? value : null;
+    options: {
+      responsive: true,
+      maintainAspectRatio: false,
+      scales: {
+        y: {
+          beginAtZero: true
+        }
       }
-    },
-    axisY: {
-      low: 0,
-      onlyInteger: true
     }
-  })
-
-  // https://www.smashingmagazine.com/2014/12/chartist-js-open-source-library-responsive-charts/
-  const chartEl = document.getElementById('chart');
-  const tooltipEl = document.createElement('div')
-
-  tooltipEl.classList.add('tooltip', 'tooltip-hidden');
-  chartEl.appendChild(tooltipEl);
-
-  document.body.addEventListener('mouseenter', function (event) {
-    if (!(event.target.matches && event.target.matches('.ct-point'))) return;
-
-    const seriesName = event.target.closest('.ct-series').getAttribute('ct:series-name');
-    const value = event.target.getAttribute('ct:value');
-
-    tooltipEl.innerText = seriesName + ': ' + value;
-    tooltipEl.classList.remove('tooltip-hidden');
-  }, true);
-
-  document.body.addEventListener('mouseleave', function (event) {
-    if (!(event.target.matches && event.target.matches('.ct-point'))) return;
-
-    tooltipEl.classList.add('tooltip-hidden');
-  }, true);
-
-  document.body.addEventListener('mousemove', function(event) {
-    if (!(event.target.matches && event.target.matches('.ct-point'))) return;
-
-    tooltipEl.style.left = (event.offsetX || event.originalEvent.layerX) + tooltipEl.offsetWidth + 10 + 'px';
-    tooltipEl.style.top = (event.offsetY || event.originalEvent.layerY) + tooltipEl.offsetHeight - 20 + 'px';
-  }, true);
+  });
 <% end %>

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

@@ -1,6 +1,6 @@
 <div class='card mb-2'>
   <div class='card-body d-flex flex-wrap'>
-    <div class='me-4'>
+    <div class='mb-2 me-4'>
       <small>Filter by job class</small>
       <br>
       <% filter.job_classes.each do |name, count| %>
@@ -16,7 +16,7 @@
       <% end %>
     </div>
 
-    <div class='me-4'>
+    <div class='mb-2 me-4'>
       <small>Filter by state</small>
       <br>
       <% filter.states.each do |name, count| %>
@@ -32,7 +32,7 @@
       <% end %>
     </div>
 
-    <div>
+    <div class='mb-2 me-4'>
       <small>Filter by queue</small>
       <br>
       <% filter.queues.each do |name, count| %>
@@ -47,5 +47,20 @@
         <% end %>
       <% end %>
     </div>
+
+    <div class="mb-2">
+      <%= form_with(url: "", method: :get, local: true) do |form| %>
+        <% filter.to_params(query: nil).each do |key, value| %>
+          <%= form.hidden_field(key.to_sym, value: value) %>
+        <% end %>
+
+        <small><%= form.label :query, "Search" %></small>
+        <div class="input-group input-group-sm">
+          <%= form.search_field :query, value: params[:query], class: "form-control" %>
+          <%= form.button "Search", type: "submit", name: nil, class: "btn btn-sm btn-outline-secondary" %>
+          <%= link_to "Clear", filter.to_params(query: nil), class: "btn btn-sm btn-outline-secondary" %>
+        </div>
+      <% end %>
+    </div>
   </div>
 </div>

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

@@ -1,16 +1,17 @@
 <!DOCTYPE html>
-<html>
+<html lang="en">
 <head>
   <title>Good Job Dashboard</title>
   <%= csrf_meta_tags %>
   <%= csp_meta_tag %>
 
   <%= stylesheet_link_tag bootstrap_path(format: :css, v: GoodJob::VERSION) %>
-  <%= stylesheet_link_tag chartist_path(format: :css, v: GoodJob::VERSION) %>
   <%= stylesheet_link_tag style_path(format: :css, v: GoodJob::VERSION) %>
 
   <%= javascript_include_tag bootstrap_path(format: :js, v: GoodJob::VERSION) %>
-  <%= javascript_include_tag chartist_path(format: :js, v: GoodJob::VERSION) %>
+  <%= javascript_include_tag chartjs_path(format: :js, v: GoodJob::VERSION) %>
+  <%= javascript_include_tag scripts_path(format: :js, v: GoodJob::VERSION) %>
+
   <%= javascript_include_tag rails_ujs_path(format: :js, v: GoodJob::VERSION) %>
 </head>
 <body>

data/engine/config/routes.rb

@@ -20,14 +20,14 @@ GoodJob::Engine.routes.draw do
   scope controller: :assets do
     constraints(format: :css) do
       get :bootstrap, action: :bootstrap_css
-      get :chartist, action: :chartist_css
       get :style, action: :style_css
     end
 
     constraints(format: :js) do
       get :bootstrap, action: :bootstrap_js
       get :rails_ujs, action: :rails_ujs_js
-      get :chartist, action: :chartist_js
+      get :chartjs, action: :chartjs_js
+      get :scripts, action: :scripts_js
     end
   end
 end

data/lib/good_job/active_job_job.rb

@@ -8,7 +8,8 @@ module GoodJob
   # @!parse
   #   class ActiveJob < ActiveRecord::Base; end
   class ActiveJobJob < Object.const_get(GoodJob.active_record_parent_class)
-    include GoodJob::Lockable
+    include Filterable
+    include Lockable
 
     # Raised when an inappropriate action is applied to a Job based on its state.
     ActionForStateMismatchError = Class.new(StandardError)
@@ -47,24 +48,6 @@ module GoodJob
     # Errored but will not be retried
     scope :discarded, -> { where.not(finished_at: nil).where.not(error: nil) }
 
-    # Get Jobs in display order with optional keyset pagination.
-    # @!method display_all(after_scheduled_at: nil, after_id: nil)
-    # @!scope class
-    # @param after_scheduled_at [DateTime, String, nil]
-    #   Display records scheduled after this time for keyset pagination
-    # @param after_id [Numeric, String, nil]
-    #   Display records after this ID for keyset pagination
-    # @return [ActiveRecord::Relation]
-    scope :display_all, (lambda do |after_scheduled_at: nil, after_id: nil|
-      query = order(Arel.sql('COALESCE(scheduled_at, created_at) DESC, id DESC'))
-      if after_scheduled_at.present? && after_id.present?
-        query = query.where(Arel.sql('(COALESCE(scheduled_at, created_at), id) < (:after_scheduled_at, :after_id)'), after_scheduled_at: after_scheduled_at, after_id: after_id)
-      elsif after_scheduled_at.present?
-        query = query.where(Arel.sql('(COALESCE(scheduled_at, created_at)) < (:after_scheduled_at)'), after_scheduled_at: after_scheduled_at)
-      end
-      query
-    end)
-
     # The job's ActiveJob UUID
     # @return [String]
     def id

data/lib/good_job/execution.rb

@@ -6,6 +6,7 @@ module GoodJob
   #   class Execution < ActiveRecord::Base; end
   class Execution < Object.const_get(GoodJob.active_record_parent_class)
     include Lockable
+    include Filterable
 
     # Raised if something attempts to execute a previously completed Execution again.
     PreviouslyPerformedError = Class.new(StandardError)
@@ -156,24 +157,6 @@ module GoodJob
       end
     end)
 
-    # Get Jobs in display order with optional keyset pagination.
-    # @!method display_all(after_scheduled_at: nil, after_id: nil)
-    # @!scope class
-    # @param after_scheduled_at [DateTime, String, nil]
-    #   Display records scheduled after this time for keyset pagination
-    # @param after_id [Numeric, String, nil]
-    #   Display records after this ID for keyset pagination
-    # @return [ActiveRecord::Relation]
-    scope :display_all, (lambda do |after_scheduled_at: nil, after_id: nil|
-      query = order(Arel.sql('COALESCE(scheduled_at, created_at) DESC, id DESC'))
-      if after_scheduled_at.present? && after_id.present?
-        query = query.where(Arel.sql('(COALESCE(scheduled_at, created_at), id) < (:after_scheduled_at, :after_id)'), after_scheduled_at: after_scheduled_at, after_id: after_id)
-      elsif after_scheduled_at.present?
-        query = query.where(Arel.sql('(COALESCE(scheduled_at, created_at)) < (:after_scheduled_at)'), after_scheduled_at: after_scheduled_at)
-      end
-      query
-    end)
-
     # Finds the next eligible Execution, acquire an advisory lock related to it, and
     # executes the job.
     # @return [ExecutionResult, nil]

data/lib/good_job/filterable.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+module GoodJob
+  # Shared methods for filtering Execution/Job records from the +good_jobs+ table.
+  module Filterable
+    extend ActiveSupport::Concern
+
+    included do
+      # Get records in display order with optional keyset pagination.
+      # @!method display_all(after_scheduled_at: nil, after_id: nil)
+      # @!scope class
+      # @param after_scheduled_at [DateTime, String, nil]
+      #   Display records scheduled after this time for keyset pagination
+      # @param after_id [Numeric, String, nil]
+      #   Display records after this ID for keyset pagination
+      # @return [ActiveRecord::Relation]
+      scope :display_all, (lambda do |after_scheduled_at: nil, after_id: nil|
+        query = order(Arel.sql('COALESCE(scheduled_at, created_at) DESC, id DESC'))
+        if after_scheduled_at.present? && after_id.present?
+          query = query.where(Arel.sql('(COALESCE(scheduled_at, created_at), id) < (:after_scheduled_at, :after_id)'), after_scheduled_at: after_scheduled_at, after_id: after_id)
+        elsif after_scheduled_at.present?
+          query = query.where(Arel.sql('(COALESCE(scheduled_at, created_at)) < (:after_scheduled_at)'), after_scheduled_at: after_scheduled_at)
+        end
+        query
+      end)
+
+      # Search records by text query.
+      # @!method search(query)
+      # @!scope class
+      # @param query [String]
+      #   Search Query
+      # @return [ActiveRecord::Relation]
+      scope :search, (lambda do |query|
+        query = query.to_s.strip
+        next if query.blank?
+
+        tsvector = "(to_tsvector('english', serialized_params) || to_tsvector('english', id::text) || to_tsvector('english', COALESCE(error, '')::text))"
+        where("#{tsvector} @@ to_tsquery(?)", query)
+          .order(sanitize_sql_for_order([Arel.sql("ts_rank(#{tsvector}, to_tsquery(?))"), query]) => 'DESC')
+      end)
+    end
+  end
+end

data/lib/good_job/notifier.rb

@@ -25,10 +25,17 @@ module GoodJob # :nodoc:
       max_queue: 1,
       fallback_policy: :discard,
     }.freeze
-    # Seconds to wait if database cannot be connected to
-    RECONNECT_INTERVAL = 5
     # Seconds to block while LISTENing for a message
     WAIT_INTERVAL = 1
+    # Seconds to wait if database cannot be connected to
+    RECONNECT_INTERVAL = 5
+    # Connection errors that will wait {RECONNECT_INTERVAL} before reconnecting
+    CONNECTION_ERRORS = %w[
+      ActiveRecord::ConnectionNotEstablished
+      ActiveRecord::StatementInvalid
+      PG::UnableToSend
+      PG::Error
+    ].freeze
 
     # @!attribute [r] instances
     #   @!scope class
@@ -115,15 +122,18 @@ module GoodJob # :nodoc:
       if thread_error
         GoodJob.on_thread_error.call(thread_error) if GoodJob.on_thread_error.respond_to?(:call)
         ActiveSupport::Notifications.instrument("notifier_notify_error.good_job", { error: thread_error })
+
+        connection_error = CONNECTION_ERRORS.any? do |error_string|
+          error_class = error_string.safe_constantize
+          next unless error_class
+
+          thread_error.is_a? error_class
+        end
       end
 
       return if shutdown?
 
-      if thread_error.is_a?(ActiveRecord::ConnectionNotEstablished) || thread_error.is_a?(ActiveRecord::StatementInvalid)
-        listen(delay: RECONNECT_INTERVAL)
-      else
-        listen
-      end
+      listen(delay: connection_error ? RECONNECT_INTERVAL : 0)
     end
 
     private

data/lib/good_job/version.rb

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