job_board 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfca59214924a123a70c43a88852ea184782d00ca60107c07808b79cf6c3c3ac
-  data.tar.gz: 0e64e1a67b82fb40227e2f9d87729fb647fe2b7d00bfc6bb9cab0ecf331ba3c6
+  metadata.gz: 18b3b4aa806ccbda04e2bd2100e4561eefec8b1ec665975b3d34d22d9ababadf
+  data.tar.gz: 31ba104259fe986f5c2eceee2f335d153246d7d21f6c9baf22764420091fbfa2
 SHA512:
-  metadata.gz: da74ce333cc798a40a50f3ee1cafae15d7e882713eb7a8e2afa6b80773d1f0a31bcd47ad88a88e43fb321053a0ca8a8242642a3a2bc90282fee16c447d2e8224
-  data.tar.gz: 7e979f3d406ef8038fddc553e47cb72a0af08320a3da0a936d5319e929f8177fa067ec2323093273fa0fee9adb4d24d28886e11b0cace363f6591636039f6360
+  metadata.gz: 746ddd882343564e9cec4dfe8a621b84e8410dc5aaac35adbce9a6adc8223fdddbf3a392ed6a9486fa5208268829a6daa470304dea9a27ec06aec300d2d9f8a3
+  data.tar.gz: 13bae2092fa89294028c00c03bbd528fbab80c2cef3156bfb1d6a09177dc1629b5898b58db93df75091508bef54e0d1adecd7a64e2b83b3aa7861bdbcbea35ef

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.5.0
+
+- Queues (home) page: new **Running** column showing how many jobs are currently
+  claimed by a worker and in progress for each queue. Positive counts link to that
+  queue's in-progress jobs; the count refreshes live with the page's auto-refresh.
+
+  ![Queues table with a Running column](doc/running-count-0.5.0.png)
+
 ## 0.4.0
 
 - Queues (home) page: a real-time **Throughput** line chart at the top, plotting jobs

data/app/controllers/job_board/application_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JobBoard
   class ApplicationController < ActionController::Base
     protect_from_forgery with: :exception

data/app/controllers/job_board/assets_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JobBoard
   class AssetsController < ApplicationController
     skip_forgery_protection
@@ -15,7 +17,7 @@ module JobBoard
 
       expires_in 1.year, public: true
       send_file JobBoard::Engine.root.join("lib/job_board/assets", name),
-        type: content_type, disposition: :inline
+                type: content_type, disposition: :inline
     end
   end
 end

data/app/controllers/job_board/jobs_controller.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module JobBoard
   class JobsController < ApplicationController
-    before_action :set_query, only: [:index, :retry_all, :discard_all]
+    before_action :set_query, only: %i[index retry_all discard_all]
 
     def index
       @page = @query.page(before: params[:before], limit: JobBoard.config.per_page)
@@ -72,13 +74,13 @@ module JobBoard
         .find(params[:id])
     end
 
-    def failed_jobs_in_batches(&block)
+    def failed_jobs_in_batches(&)
       query = JobsQuery.new(
         status: "failed",
         queue_name: params[:queue_name].presence,
         class_name: params[:class_name].presence
       )
-      query.failed_jobs_relation.find_in_batches(batch_size: 500, &block)
+      query.failed_jobs_relation.find_in_batches(batch_size: 500, &)
     end
 
     def failed_jobs_path

data/app/controllers/job_board/metrics_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JobBoard
   class MetricsController < ApplicationController
     def show

data/app/controllers/job_board/processes_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JobBoard
   class ProcessesController < ApplicationController
     def index

data/app/controllers/job_board/queues/pauses_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JobBoard
   module Queues
     class PausesController < ApplicationController

data/app/controllers/job_board/queues_controller.rb

@@ -1,9 +1,13 @@
+# frozen_string_literal: true
+
 module JobBoard
   class QueuesController < ApplicationController
     def index
       @queue_list = QueueList.build
       @failed_counts = SolidQueue::FailedExecution.joins(:job)
-        .group("solid_queue_jobs.queue_name").count
+                                                  .group("solid_queue_jobs.queue_name").count
+      @running_counts = SolidQueue::ClaimedExecution.joins(:job)
+                                                    .group("solid_queue_jobs.queue_name").count
     end
   end
 end

data/app/controllers/job_board/recurring_tasks/runs_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JobBoard
   module RecurringTasks
     class RunsController < ApplicationController
@@ -9,8 +11,9 @@ module JobBoard
         elsif task.enqueue(at: Time.current)
           redirect_to recurring_tasks_path, notice: "Enqueued \"#{task.key}\"."
         else
-          redirect_to recurring_tasks_path,
-            alert: "\"#{task.key}\" was not enqueued — it already ran at this exact time or the enqueue failed."
+          alert = "\"#{task.key}\" was not enqueued — it already ran at " \
+                  "this exact time or the enqueue failed."
+          redirect_to recurring_tasks_path, alert: alert
         end
       end
     end

data/app/controllers/job_board/recurring_tasks_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JobBoard
   class RecurringTasksController < ApplicationController
     def index

data/app/helpers/job_board/application_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JobBoard
   module ApplicationHelper
     def status_badge(status)
@@ -9,14 +11,14 @@ module JobBoard
 
       time = Time.zone.parse(time) if time.is_a?(String)
       tag.time("#{duration((Time.current - time).abs)} #{time.future? ? "from now" : "ago"}",
-        title: time.iso8601, datetime: time.iso8601)
+               title: time.iso8601, datetime: time.iso8601)
     end
 
     def duration(seconds)
       seconds = seconds.to_i
       return "0s" if seconds <= 0
 
-      parts = { "d" => 86400, "h" => 3600, "m" => 60, "s" => 1 }.filter_map do |unit, size|
+      parts = { "d" => 86_400, "h" => 3600, "m" => 60, "s" => 1 }.filter_map do |unit, size|
         value, seconds = seconds.divmod(size)
         "#{value}#{unit}" if value.positive?
       end

data/app/models/job_board/cron_description.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "fugit"
 
 module JobBoard
@@ -44,6 +46,7 @@ module JobBoard
       if (step = seconds_step)
         # Sub-minute schedules only describe cleanly when nothing else is constrained.
         return nil unless cron.minutes.nil? && cron.hours.nil?
+
         "Every #{step} seconds"
       elsif cron.seconds && cron.seconds != [0]
         nil
@@ -60,7 +63,7 @@ module JobBoard
       else
         times = cron.hours.product(cron.minutes || [0]).sort
         if times.size <= 4
-          "At #{join_and(times.map { |h, m| format("%02d:%02d", h, m) })}"
+          "At #{join_and(times.map { |h, m| format("%<h>02d:%<m>02d", h: h, m: m) })}"
         else
           "At #{numbers("minute", cron.minutes)} past #{numbers("hour", cron.hours)}"
         end
@@ -79,17 +82,19 @@ module JobBoard
       return nil if cron.weekdays.nil?
 
       plain = cron.weekdays.select { |_, nth| nth.nil? }.map { |day,| day % 7 }.sort.uniq
-      nth = cron.weekdays.reject { |_, nth| nth.nil? }.map do |day, n|
+      nth = cron.weekdays.filter_map do |day, n|
+        next if n.nil?
+
         "the #{n == -1 ? "last" : n.ordinalize} #{DAYS[day % 7]} of the month"
       end
 
       phrases = []
       if plain.any?
         phrases << if plain.size > 2 && consecutive?(plain)
-          "#{DAYS[plain.first]} through #{DAYS[plain.last]}"
-        else
-          join_and(plain.map { |day| DAYS[day] })
-        end
+                     "#{DAYS[plain.first]} through #{DAYS[plain.last]}"
+                   else
+                     join_and(plain.map { |day| DAYS[day] })
+                   end
       end
       "on #{join_and(phrases + nth)}"
     end
@@ -99,7 +104,7 @@ module JobBoard
 
       # "0 0 1 1 *" reads better as "on January 1" than "on day 1 of the month in January".
       if cron.monthdays.size == 1 && cron.monthdays.first.positive? &&
-          cron.months&.size == 1 && cron.weekdays.nil?
+         cron.months&.size == 1 && cron.weekdays.nil?
         @month_consumed = true
         return "on #{MONTHS[cron.months.first - 1]} #{cron.monthdays.first}"
       end

data/app/models/job_board/job_presenter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JobBoard
   # Detail-page wrapper around a SolidQueue::Job loaded with all five
   # has_one execution associations preloaded.

data/app/models/job_board/job_row.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JobBoard
   # Uniform row facade so the jobs table doesn't care whether a row came from
   # an execution record or a finished job.

data/app/models/job_board/jobs_query.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JobBoard
   # Status-scoped job finder. Each status is driven by its execution table so a
   # row's status is known without calling Job#status (which needs 5 preloads).
@@ -71,8 +73,11 @@ module JobBoard
 
     def filtered(scope, own_queue_column:)
       if queue_name
-        scope = own_queue_column ? scope.where(queue_name: queue_name)
-                                 : scope.joins(:job).where(solid_queue_jobs: { queue_name: queue_name })
+        scope = if own_queue_column
+                  scope.where(queue_name: queue_name)
+                else
+                  scope.joins(:job).where(solid_queue_jobs: { queue_name: queue_name })
+                end
       end
       scope = scope.joins(:job).where(solid_queue_jobs: { class_name: class_name }) if class_name
       scope

data/app/models/job_board/latency_sla.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module JobBoard
   # Detects a queue's latency SLA from explicit configuration or from the
   # within_* naming convention (e.g. "within_5_minutes" => 300).
   module LatencySla
-    UNITS = { "second" => 1, "minute" => 60, "hour" => 3600, "day" => 86400 }.freeze
+    UNITS = { "second" => 1, "minute" => 60, "hour" => 3600, "day" => 86_400 }.freeze
 
     # Seconds, or nil when the queue has no detectable SLA.
     def self.detect(queue_name)
@@ -24,7 +26,7 @@ module JobBoard
 
     def self.from_name(queue_name)
       match = /\Awithin_(\d+)_(second|minute|hour|day)s?\z/i.match(queue_name.to_s)
-      match && match[1].to_i * UNITS.fetch(match[2].downcase)
+      match && (match[1].to_i * UNITS.fetch(match[2].downcase))
     end
     private_class_method :from_name
   end

data/app/models/job_board/page.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JobBoard
   # Keyset pagination over a relation ordered by id DESC.
   # Fetches limit + 1 records to detect whether an older page exists.
@@ -24,8 +26,8 @@ module JobBoard
       records.last&.id
     end
 
-    def each(&block)
-      rows.each(&block)
+    def each(&)
+      rows.each(&)
     end
 
     def empty?

data/app/models/job_board/process_tree.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JobBoard
   # Supervisor -> supervisee tree of SolidQueue processes with staleness flags,
   # claimed-job counts, and the in-progress jobs each worker holds.
@@ -12,11 +14,11 @@ module JobBoard
 
     def initialize(stale_threshold:)
       processes = SolidQueue::Process.order(:id).to_a
-      ids = processes.map(&:id).to_set
+      ids = processes.to_set(&:id)
       counts = SolidQueue::ClaimedExecution.group(:process_id).count
       @claimed_by_process =
         SolidQueue::ClaimedExecution.where(process_id: processes.map(&:id))
-          .includes(:job).group_by(&:process_id)
+                                    .includes(:job).group_by(&:process_id)
 
       cutoff = stale_threshold.ago
       children = processes.group_by(&:supervisor_id)

data/app/models/job_board/queue_list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JobBoard
   # Partitions queues into active and inactive based on when each queue last
   # had a job enqueued. A queue is inactive when its newest job is older than
@@ -9,8 +11,8 @@ module JobBoard
 
     def self.build(window: JobBoard.config.queue_activity_window)
       new(LatencySla.sort(SolidQueue::Queue.all),
-        last_enqueued_at: SolidQueue::Job.group(:queue_name).maximum(:created_at),
-        window: window)
+          last_enqueued_at: SolidQueue::Job.group(:queue_name).maximum(:created_at),
+          window: window)
     end
 
     def initialize(queues, last_enqueued_at:, window: nil)

data/app/models/job_board/throughput.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module JobBoard
   class Throughput
-    READY_AT = "COALESCE(scheduled_at, created_at)".freeze
+    READY_AT = "COALESCE(scheduled_at, created_at)"
 
     class << self
       def snapshot(since:)

data/app/views/job_board/queues/_table.html.erb

@@ -3,6 +3,7 @@
     <tr>
       <th>Queue</th>
       <th class="num">Ready jobs</th>
+      <th class="num">Running</th>
       <th class="num">Failed</th>
       <th class="num">Latency</th>
       <th>Last enqueued</th>
@@ -15,6 +16,14 @@
       <tr>
         <td><%= link_to queue.name, jobs_path(status: "ready", queue_name: queue.name) %></td>
         <td class="num"><%= queue.size %></td>
+        <td class="num">
+          <% running = @running_counts[queue.name] || 0 %>
+          <% if running.positive? %>
+            <%= link_to running, jobs_path(status: "in_progress", queue_name: queue.name), class: "running-count" %>
+          <% else %>
+            <span class="muted">0</span>
+          <% end %>
+        </td>
         <td class="num">
           <% failed = @failed_counts[queue.name] || 0 %>
           <% if failed.positive? %>

data/config/routes.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 JobBoard::Engine.routes.draw do
   root to: "queues#index"
 
   get "queues", to: "queues#index", as: :queues
-  scope "queues/:queue_name", constraints: { queue_name: /[^\/]+/ }, format: false do
+  scope "queues/:queue_name", constraints: { queue_name: %r{[^/]+} }, format: false do
     post   "pause", to: "queues/pauses#create", as: :queue_pause
     delete "pause", to: "queues/pauses#destroy"
   end
 
-  resources :jobs, only: [:index, :show] do
+  resources :jobs, only: %i[index show] do
     member do
       post :retry
       delete :discard
@@ -20,7 +22,7 @@ JobBoard::Engine.routes.draw do
 
   resources :processes, only: :index
   resources :recurring_tasks, only: :index
-  scope "recurring_tasks/:key", constraints: { key: /[^\/]+/ }, format: false do
+  scope "recurring_tasks/:key", constraints: { key: %r{[^/]+} }, format: false do
     post "run", to: "recurring_tasks/runs#create", as: :recurring_task_run
   end
 

data/lib/job_board/assets/application.css

@@ -196,6 +196,7 @@ code.cron {
 .latency { font-weight: 600; }
 .latency--high { color: var(--danger); }
 .failed-count { color: var(--danger); font-weight: 600; }
+.running-count { color: var(--warning); font-weight: 600; }
 
 /* Tabs */
 .tabs {

data/lib/job_board/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JobBoard
   class Configuration
     # nil, or { name: "...", password: "..." } to protect the UI with HTTP Basic auth.

data/lib/job_board/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JobBoard
   class Engine < ::Rails::Engine
     isolate_namespace JobBoard

data/lib/job_board/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JobBoard
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/job_board.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "solid_queue"
 
 require "job_board/version"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: job_board
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Mike