solid_queue_web 0.6.0 → 0.7.0

data/app/controllers/solid_queue_web/jobs_controller.rb

@@ -1,6 +1,6 @@
 module SolidQueueWeb
   class JobsController < ApplicationController
-    before_action :set_status, only: [ :destroy, :discard_all, :discard_selected ]
+    before_action :set_status, only: [:destroy, :discard_all, :discard_selected]
 
     def index
       @status = params[:status].presence_in(Job::STATUSES) || "ready"

data/app/controllers/solid_queue_web/queues/jobs_controller.rb

@@ -2,7 +2,7 @@ module SolidQueueWeb
   module Queues
     class JobsController < ApplicationController
       before_action :set_queue
-      before_action :set_status, only: [ :destroy, :discard_all ]
+      before_action :set_status, only: [:destroy, :discard_all]
 
       def index
         @status = params[:status].presence_in(Job::STATUSES) || "ready"

data/app/controllers/solid_queue_web/queues_controller.rb

@@ -2,6 +2,21 @@ module SolidQueueWeb
   class QueuesController < ApplicationController
     def index
       @queues = SolidQueue::Queue.all.sort_by(&:name)
+
+      now = Time.current
+      @completed_24h = SolidQueue::Job
+        .where(finished_at: 24.hours.ago..now)
+        .group(:queue_name)
+        .count
+      @failed_24h = SolidQueue::FailedExecution
+        .joins(:job)
+        .where(created_at: 24.hours.ago..now)
+        .group("solid_queue_jobs.queue_name")
+        .count
+      @oldest_ready = SolidQueue::ReadyExecution
+        .joins(:job)
+        .group("solid_queue_jobs.queue_name")
+        .minimum("solid_queue_jobs.created_at")
     end
 
     def pause

data/app/helpers/solid_queue_web/application_helper.rb

@@ -1,8 +1,22 @@
 module SolidQueueWeb
   module ApplicationHelper
     def inline_styles
-      css = SolidQueueWeb::Engine.root.join("app/assets/stylesheets/solid_queue_web/application.css").read
+      dir = SolidQueueWeb::Engine.root.join("app/assets/stylesheets/solid_queue_web")
+      css = dir.glob("_*.css").sort.map(&:read).join("\n")
       content_tag(:style, css.html_safe)
     end
+
+    def format_duration(seconds)
+      s = seconds.to_i
+      return "< 1s" if s < 1
+
+      if s < 60
+        "#{s}s"
+      elsif s < 3600
+        "#{s / 60}m #{s % 60}s"
+      else
+        "#{s / 3600}h #{(s % 3600) / 60}m"
+      end
+    end
   end
 end

data/app/javascript/solid_queue_web/refresh_controller.js

@@ -23,7 +23,8 @@ export default class extends Controller {
 
   async _reload() {
     clearTimeout(this._timer)
-    if (!document.hidden) {
+    const hasSelection = this.element.querySelector("input[type='checkbox']:checked")
+    if (!document.hidden && !hasSelection) {
       try {
         const response = await fetch(window.location.href, {
           headers: { "Turbo-Frame": this.element.id, Accept: "text/html" }
@@ -44,7 +45,7 @@ export default class extends Controller {
   _onVisibilityChange() {
     if (document.hidden) {
       clearTimeout(this._timer)
-    } else {
+    } else if (!this.element.querySelector("input[type='checkbox']:checked")) {
       this._reload()
     }
   }

data/app/views/layouts/solid_queue_web/application.html.erb

@@ -26,6 +26,7 @@
           <li><%= link_to "Dashboard", root_path, class: current_page?(root_path) ? "active" : "", aria: { current: current_page?(root_path) ? "page" : nil } %></li>
           <li><%= link_to "Queues", queues_path, class: current_page?(queues_path) ? "active" : "", aria: { current: current_page?(queues_path) ? "page" : nil } %></li>
           <li><%= link_to "Jobs", jobs_path, class: current_page?(jobs_path) ? "active" : "", aria: { current: current_page?(jobs_path) ? "page" : nil } %></li>
+          <li><%= link_to "History", history_path, class: current_page?(history_path) ? "active" : "", aria: { current: current_page?(history_path) ? "page" : nil } %></li>
           <li><%= link_to "Failed", failed_jobs_path, class: current_page?(failed_jobs_path) ? "active" : "", aria: { current: current_page?(failed_jobs_path) ? "page" : nil } %></li>
           <li><%= link_to "Recurring", recurring_tasks_path, class: current_page?(recurring_tasks_path) ? "active" : "", aria: { current: current_page?(recurring_tasks_path) ? "page" : nil } %></li>
           <li><%= link_to "Processes", processes_path, class: current_page?(processes_path) ? "active" : "", aria: { current: current_page?(processes_path) ? "page" : nil } %></li>

data/app/views/solid_queue_web/dashboard/index.html.erb

@@ -34,6 +34,44 @@
     <div class="sqd-stat__value"><%= @stats[:processes] %></div>
     <div class="sqd-stat__label">Processes</div>
   <% end %>
+  <%= link_to history_path(period: "1h"), class: "sqd-stat sqd-stat--done sqd-stat--link" do %>
+    <div class="sqd-stat__value"><%= @throughput[:completed_1h] %></div>
+    <div class="sqd-stat__label">Done (1h)</div>
+  <% end %>
+  <%= link_to history_path(period: "24h"), class: "sqd-stat sqd-stat--done sqd-stat--link" do %>
+    <div class="sqd-stat__value"><%= @throughput[:completed_24h] %></div>
+    <div class="sqd-stat__label">Done (24h)</div>
+  <% end %>
+</div>
+
+<% max_val = [@sparkline.max, 1].max %>
+<div class="sqd-card" style="margin-bottom: 1rem;">
+  <div class="sqd-card__header">
+    <span class="sqd-card__title">Throughput &mdash; Last 12 Hours</span>
+    <div class="sqd-throughput__summary">
+      <span>1h: <strong><%= @throughput[:completed_1h] %></strong></span>
+      <span>24h: <strong><%= @throughput[:completed_24h] %></strong></span>
+    </div>
+  </div>
+  <% if @throughput[:completed_24h] == 0 %>
+    <div class="sqd-sparkline__empty">No completed jobs in the last 24 hours</div>
+  <% else %>
+    <div class="sqd-sparkline" aria-label="Jobs completed per hour over the last 12 hours">
+      <% @sparkline.each_with_index do |count, i| %>
+        <% pct = (count.to_f / max_val * 100).round %>
+        <% hour_start = (12 - i).hours.ago %>
+        <% show_tick = [0, 3, 6, 9, 11].include?(i) %>
+        <div class="sqd-sparkline__col">
+          <div class="sqd-sparkline__bar-wrap">
+            <div class="sqd-sparkline__bar"
+                 style="height: <%= [pct, 3].max %>%"
+                 title="<%= hour_start.strftime('%-I%p').downcase %>: <%= count %> <%= "job".pluralize(count) %>"></div>
+          </div>
+          <div class="sqd-sparkline__tick"><%= show_tick ? (i == 11 ? "now" : hour_start.strftime("%-I%p").downcase) : "" %></div>
+        </div>
+      <% end %>
+    </div>
+  <% end %>
 </div>
 
 <div style="display:grid; grid-template-columns: 1fr 1fr; gap: 1rem;">

data/app/views/solid_queue_web/failed_jobs/index.html.erb

@@ -24,7 +24,6 @@
   <input class="sqd-search__input" type="search" name="q" value="<%= @search %>"
          placeholder="Filter by job class…" autocomplete="off" aria-label="Filter by job class"
          data-action="input->search#filter">
-  <button type="submit" class="sqd-btn sqd-btn--muted">Search</button>
   <% if @search.present? %>
     <%= link_to "Clear", failed_jobs_path(queue: @queue, period: @period), class: "sqd-btn sqd-btn--muted" %>
   <% end %>

data/app/views/solid_queue_web/history/index.html.erb

@@ -0,0 +1,67 @@
+<%= turbo_frame_tag "history-table", data: { controller: "refresh", refresh_interval_value: 10000 } do %>
+<div class="sqd-page-header">
+  <h1 class="sqd-page-title">Job History</h1>
+</div>
+
+<form class="sqd-search" action="<%= history_path %>" method="get" data-controller="search">
+  <% if @queue.present? %>
+    <input type="hidden" name="queue" value="<%= @queue %>">
+  <% end %>
+  <input type="hidden" name="period" value="<%= @period %>">
+  <input class="sqd-search__input" type="search" name="q" value="<%= @search %>"
+         placeholder="Filter by job class…" autocomplete="off" aria-label="Filter by job class"
+         data-action="input->search#filter">
+  <% if @search.present? %>
+    <%= link_to "Clear", history_path(queue: @queue, period: @period), class: "sqd-btn sqd-btn--muted" %>
+  <% end %>
+  <div class="sqd-period-filter" role="group" aria-label="Time period">
+    <%= link_to "All",  history_path(queue: @queue, q: @search),                      class: @period.nil?       ? "active" : "", aria: { current: @period.nil?       ? "true" : nil } %>
+    <%= link_to "1h",   history_path(queue: @queue, q: @search, period: "1h"),  class: @period == "1h"  ? "active" : "", aria: { current: @period == "1h"  ? "true" : nil } %>
+    <%= link_to "24h",  history_path(queue: @queue, q: @search, period: "24h"), class: @period == "24h" ? "active" : "", aria: { current: @period == "24h" ? "true" : nil } %>
+    <%= link_to "7d",   history_path(queue: @queue, q: @search, period: "7d"),  class: @period == "7d"  ? "active" : "", aria: { current: @period == "7d"  ? "true" : nil } %>
+  </div>
+</form>
+
+<% if @queue.present? %>
+  <p style="margin-top: 0.5rem; font-size: 13px; color: var(--muted);">
+    Filtering by queue: <strong><%= @queue %></strong> &mdash;
+    <%= link_to "Clear filter", history_path(q: @search, period: @period) %>
+  </p>
+<% end %>
+
+<% if @jobs.any? %>
+  <div class="sqd-card">
+    <table>
+      <thead>
+        <tr>
+          <th scope="col">Job Class</th>
+          <th scope="col">Queue</th>
+          <th scope="col">Duration</th>
+          <th scope="col">Finished At</th>
+        </tr>
+      </thead>
+      <tbody>
+        <% @jobs.each do |job| %>
+          <tr>
+            <td><%= link_to job.class_name, job_path(job) %></td>
+            <td>
+              <%= link_to job.queue_name, history_path(queue: job.queue_name, q: @search, period: @period),
+                    class: "sqd-mono", style: "color: inherit;" %>
+            </td>
+            <td class="sqd-mono"><%= format_duration(job.finished_at - job.created_at) %></td>
+            <td class="sqd-mono"><%= job.finished_at.strftime("%Y-%m-%d %H:%M:%S") %></td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+<% else %>
+  <div class="sqd-card">
+    <div class="sqd-empty">No finished jobs found.</div>
+  </div>
+<% end %>
+
+<% if @pagy.last > 1 %>
+  <%= @pagy.series_nav.html_safe %>
+<% end %>
+<% end %>

data/app/views/solid_queue_web/jobs/index.html.erb

@@ -28,7 +28,6 @@
   <input class="sqd-search__input" type="search" name="q" value="<%= @search %>"
          placeholder="Filter by job class…" autocomplete="off" aria-label="Filter by job class"
          data-action="input->search#filter">
-  <button type="submit" class="sqd-btn sqd-btn--muted">Search</button>
   <% if @search.present? %>
     <%= link_to "Clear", jobs_path(status: @status, period: @period), class: "sqd-btn sqd-btn--muted" %>
   <% end %>

data/app/views/solid_queue_web/queues/index.html.erb

@@ -10,6 +10,8 @@
           <th scope="col">Name</th>
           <th scope="col">Size</th>
           <th scope="col">Latency</th>
+          <th scope="col">Done (24h)</th>
+          <th scope="col">Failed (24h)</th>
           <th scope="col">Status</th>
           <th scope="col"><span class="sqd-sr-only">Actions</span></th>
         </tr>
@@ -19,7 +21,19 @@
           <tr>
             <td class="sqd-mono"><%= queue.name %></td>
             <td><%= queue.size %></td>
-            <td><%= queue.human_latency %></td>
+            <td>
+              <% if (oldest = @oldest_ready[queue.name]) %>
+                <% age = Time.current - oldest %>
+                <% latency_color = age > 86_400 ? "var(--danger)" : age > 3_600 ? "var(--warning)" : "inherit" %>
+                <abbr title="<%= oldest.strftime("%Y-%m-%d %H:%M:%S UTC") %>">
+                  <span style="color: <%= latency_color %>"><%= format_duration(age) %></span>
+                </abbr>
+              <% else %>
+                <span style="color: var(--muted)">—</span>
+              <% end %>
+            </td>
+            <td style="color: var(--success);"><%= @completed_24h[queue.name] || 0 %></td>
+            <td style="color: <%= (@failed_24h[queue.name] || 0) > 0 ? "var(--danger)" : "inherit" %>;"><%= @failed_24h[queue.name] || 0 %></td>
             <td>
               <% if queue.paused? %>
                 <span class="sqd-badge sqd-badge--paused">Paused</span>

data/config/routes.rb

@@ -2,15 +2,16 @@ SolidQueueWeb::Engine.routes.draw do
   root to: "dashboard#index"
 
   get "search", to: "search#index", as: :search
+  get "history", to: "history#index", as: :history
 
-  resources :recurring_tasks, only: [ :index ]
-  resources :processes, only: [ :index ]
-  resources :queues, only: [ :index ], param: :name do
+  resources :recurring_tasks, only: [:index]
+  resources :processes, only: [:index]
+  resources :queues, only: [:index], param: :name do
     member do
       post :pause
       post :resume
     end
-    resources :jobs, path: "list", only: [ :index, :destroy ], controller: "queues/jobs" do
+    resources :jobs, path: "list", only: [:index, :destroy], controller: "queues/jobs" do
       collection do
         post :discard_all
       end
@@ -19,16 +20,16 @@ SolidQueueWeb::Engine.routes.draw do
 
   # Singular selection resources must be defined before the member routes of their
   # parent resources, otherwise DELETE /list/selection matches /list/:id first.
-  resource :job_selection, path: "list/selection", only: [ :destroy ], controller: "jobs/selections"
-  resources :jobs, path: "list", only: [ :index, :show, :destroy ] do
+  resource :job_selection, path: "list/selection", only: [:destroy], controller: "jobs/selections"
+  resources :jobs, path: "list", only: [:index, :show, :destroy] do
     collection do
       post :discard_all
     end
   end
 
-  resource :failed_job_selection, path: "failed_jobs/selection", only: [ :create, :destroy ],
+  resource :failed_job_selection, path: "failed_jobs/selection", only: [:create, :destroy],
            controller: "failed_jobs/selections"
-  resources :failed_jobs, only: [ :index, :destroy ] do
+  resources :failed_jobs, only: [:index, :destroy] do
     collection do
       post :retry_all
       post :discard_all

data/lib/solid_queue_web/version.rb

@@ -1,3 +1,3 @@
 module SolidQueueWeb
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solid_queue_web
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Chuck Smith
@@ -91,11 +91,23 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/assets/stylesheets/solid_queue_web/_01_base.css
+- app/assets/stylesheets/solid_queue_web/_02_layout.css
+- app/assets/stylesheets/solid_queue_web/_03_stats.css
+- app/assets/stylesheets/solid_queue_web/_04_table.css
+- app/assets/stylesheets/solid_queue_web/_05_badges.css
+- app/assets/stylesheets/solid_queue_web/_06_buttons.css
+- app/assets/stylesheets/solid_queue_web/_07_forms.css
+- app/assets/stylesheets/solid_queue_web/_08_detail.css
+- app/assets/stylesheets/solid_queue_web/_09_pagination.css
+- app/assets/stylesheets/solid_queue_web/_10_responsive.css
+- app/assets/stylesheets/solid_queue_web/_11_throughput.css
 - app/assets/stylesheets/solid_queue_web/application.css
 - app/controllers/solid_queue_web/application_controller.rb
 - app/controllers/solid_queue_web/dashboard_controller.rb
 - app/controllers/solid_queue_web/failed_jobs/selections_controller.rb
 - app/controllers/solid_queue_web/failed_jobs_controller.rb
+- app/controllers/solid_queue_web/history_controller.rb
 - app/controllers/solid_queue_web/jobs/selections_controller.rb
 - app/controllers/solid_queue_web/jobs_controller.rb
 - app/controllers/solid_queue_web/processes_controller.rb
@@ -114,6 +126,7 @@ files:
 - app/views/layouts/solid_queue_web/application.html.erb
 - app/views/solid_queue_web/dashboard/index.html.erb
 - app/views/solid_queue_web/failed_jobs/index.html.erb
+- app/views/solid_queue_web/history/index.html.erb
 - app/views/solid_queue_web/jobs/destroy.turbo_stream.erb
 - app/views/solid_queue_web/jobs/index.html.erb
 - app/views/solid_queue_web/jobs/show.html.erb