solid_queue_web 1.4.0 → 1.6.0

data/config/locales/en.yml

@@ -0,0 +1,330 @@
+en:
+  solid_queue_web:
+    layout:
+      title: "Solid Queue Dashboard"
+      logo: "Solid Queue"
+      theme_toggle: "Switch to dark mode"
+      nav:
+        main_navigation: "Main navigation"
+        toggle: "Toggle navigation"
+        dashboard: "Dashboard"
+        queues: "Queues"
+        jobs: "Jobs"
+        history: "History"
+        performance: "Performance"
+        failed: "Failed"
+        recurring: "Recurring"
+        processes: "Processes"
+        search: "Search"
+        audit: "Audit"
+    shared:
+      actions: "Actions"
+      period_filter:
+        label: "Time period"
+        all: "All"
+        one_hour: "1h"
+        twenty_four_hours: "24h"
+        seven_days: "7d"
+      clear: "Clear"
+      export_csv: "Export CSV"
+      select_all: "Select all"
+      filtering_by_queue: "Filtering by queue:"
+      clear_filter: "Clear filter"
+    dashboard:
+      title: "Dashboard"
+      ready: "Ready"
+      scheduled: "Scheduled"
+      running: "Running"
+      blocked: "Blocked"
+      failed: "Failed"
+      queues: "Queues"
+      recurring: "Recurring"
+      processes: "Processes"
+      done_1h: "Done (1h)"
+      done_24h: "Done (24h)"
+      throughput_label: "Throughput — Last 12 Hours"
+      queue_depth_label: "Queue Depth — Last 12 Hours"
+      failures_label: "Failures — Last 12 Hours"
+      throughput_1h: "1h:"
+      throughput_24h: "24h:"
+      queue_depth_now: "Now:"
+      failures_total: "Total:"
+      no_completed_jobs: "No completed jobs in the last 24 hours"
+      no_active_jobs: "No active jobs in the last 12 hours"
+      no_failures: "No failures in the last 12 hours"
+      quick_links: "Quick Links"
+      view_ready_jobs: "View all ready jobs"
+      view_scheduled_jobs: "View scheduled jobs"
+      view_failed_jobs: "View failed jobs"
+      manage_queues: "Manage queues"
+      view_recurring_tasks: "View recurring tasks"
+      failed_jobs_card: "Failed Jobs"
+      need_attention:
+        one: "1 failed job needs attention."
+        other: "%{count} failed jobs need attention."
+      retry_all_failed: "Retry All Failed"
+      confirm_retry_all_failed:
+        one: "Retry all 1 failed job?"
+        other: "Retry all %{count} failed jobs?"
+      review: "Review →"
+      slow_jobs_card: "Slow Jobs"
+      slow_jobs_warning:
+        one: "1 job running longer than %{threshold}."
+        other: "%{count} jobs running longer than %{threshold}."
+      blocked_jobs_card: "Blocked Jobs"
+      blocked_jobs_count:
+        one: "1 blocked job."
+        other: "%{count} blocked jobs."
+      discard_all_blocked: "Discard All Blocked"
+      confirm_discard_all_blocked:
+        one: "Discard 1 blocked job? This cannot be undone."
+        other: "Discard all %{count} blocked jobs? This cannot be undone."
+      axis_now: "now"
+    jobs:
+      title: "Jobs"
+      export_csv: "Export CSV"
+      tab_ready: "Ready"
+      tab_scheduled: "Scheduled"
+      tab_running: "Running"
+      tab_blocked: "Blocked"
+      tab_failed: "Failed"
+      placeholder_job_class: "Filter by job class…"
+      aria_filter_job_class: "Filter by job class"
+      aria_filter_priority: "Filter by priority"
+      all_priorities: "All priorities"
+      priority_option: "Priority %{n}"
+      clear_search: "Clear"
+      col_job_class: "Job Class"
+      col_queue: "Queue"
+      col_priority: "Priority"
+      col_scheduled_at: "Scheduled At"
+      col_enqueued_at: "Enqueued At"
+      col_running_for: "Running For"
+      col_wait_time: "Wait Time"
+      actions: "Actions"
+      run_all_now: "Run All Now"
+      discard_all: "Discard All"
+      run_now: "Run Now"
+      discard: "Discard"
+      discard_selected: "Discard Selected"
+      confirm_run_all_now: "Run all %{count} scheduled jobs immediately?"
+      confirm_run_now: "Run this job immediately?"
+      confirm_discard: "Discard this job?"
+      confirm_discard_all: "Discard all %{count} %{status} jobs? This cannot be undone."
+      confirm_discard_selected: "Discard selected jobs? This cannot be undone."
+      no_jobs: "No %{status} jobs."
+      select_job: "Select job %{class_name}"
+      select_all_jobs: "Select all jobs"
+      selected_label: "selected"
+    jobs_show:
+      breadcrumb: "Jobs"
+      detail: "Detail"
+      section_details: "Details"
+      section_arguments: "Arguments"
+      section_error: "Error"
+      retry: "Retry"
+      discard: "Discard"
+      confirm_discard: "Discard this job?"
+      field_status: "Status"
+      field_queue: "Queue"
+      field_priority: "Priority"
+      field_active_job_id: "Active Job ID"
+      field_concurrency_key: "Concurrency Key"
+      field_blocked_until: "Blocked Until"
+      field_enqueued_at: "Enqueued At"
+      field_scheduled_at: "Scheduled At"
+      field_finished_at: "Finished At"
+      arguments_aria_label: "Job arguments JSON"
+      retry_with_args: "Retry with these arguments"
+    failed_jobs:
+      title: "Failed Jobs"
+      export_csv: "Export CSV"
+      error_summary: "Error Summary"
+      retry_all: "Retry All"
+      discard_all: "Discard All"
+      confirm_retry_all: "Retry all %{count} failed jobs?"
+      confirm_discard_all: "Discard all %{count} failed jobs? This cannot be undone."
+      confirm_discard: "Discard this job?"
+      confirm_discard_selected: "Discard selected jobs? This cannot be undone."
+      col_job_class: "Job Class"
+      col_queue: "Queue"
+      col_error: "Error"
+      col_failed_at: "Failed At"
+      retry: "Retry"
+      discard: "Discard"
+      retry_selected: "Retry Selected"
+      discard_selected: "Discard Selected"
+      select_all: "Select all failed jobs"
+      select_job: "Select job %{class_name}"
+      empty: "No failed jobs. All clear!"
+      stagger_title: "Retry all, staggered %{interval} apart"
+      confirm_stagger: "Retry %{count} failed jobs staggered %{interval} apart?"
+    failed_job_errors:
+      title: "Error Summary"
+      back: "← Failed Jobs"
+      col_error_class: "Error Class"
+      col_message: "Message"
+      col_count: "Count"
+      empty: "No failed jobs. All clear!"
+    queues:
+      title: "Queues"
+      col_name: "Name"
+      col_size: "Size"
+      col_latency: "Latency"
+      col_done_24h: "Done (24h)"
+      col_failed_24h: "Failed (24h)"
+      col_failure_rate: "Failure Rate (12h)"
+      col_status: "Status"
+      actions: "Actions"
+      status_paused: "Paused"
+      status_running: "Running"
+      pause: "Pause"
+      resume: "Resume"
+      confirm_pause: "Pause queue \"%{name}\"?"
+      empty: "No queues found."
+      failure_rate_aria: "Failure rate last 12 hours for %{queue}"
+    queue_jobs:
+      title: "Jobs"
+      breadcrumb_queues: "Queues"
+      tab_ready: "Ready"
+      tab_scheduled: "Scheduled"
+      tab_running: "Running"
+      tab_blocked: "Blocked"
+      tab_failed: "Failed"
+      discard_all: "Discard All"
+      confirm_discard_all: "Discard all %{count} %{status} jobs in %{queue}? This cannot be undone."
+      col_job_class: "Job Class"
+      col_priority: "Priority"
+      col_scheduled_at: "Scheduled At"
+      col_enqueued_at: "Enqueued At"
+      actions: "Actions"
+      discard: "Discard"
+      confirm_discard: "Discard this job?"
+      search_button: "Search"
+      placeholder_job_class: "Filter by job class…"
+      aria_filter_job_class: "Filter by job class"
+      no_jobs: "No %{status} jobs in %{queue}."
+    processes:
+      title: "Processes"
+      col_kind: "Kind"
+      col_name: "Name"
+      col_pid: "PID"
+      col_host: "Host"
+      col_details: "Details"
+      col_last_heartbeat: "Last Heartbeat"
+      col_status: "Status"
+      status_stale: "Stale"
+      status_healthy: "Healthy"
+      threads: "%{count} threads"
+      polling_interval: "every %{interval}s"
+      last_heartbeat_ago: "%{time} ago"
+      queues_title: "Queues"
+      empty: "No processes registered."
+    recurring_tasks:
+      title: "Recurring Tasks"
+      col_key: "Key"
+      col_schedule: "Schedule"
+      col_job_command: "Job / Command"
+      col_queue: "Queue"
+      col_next_run: "Next Run"
+      col_last_run: "Last Run"
+      col_type: "Type"
+      type_static: "Static"
+      type_dynamic: "Dynamic"
+      run_now: "Run Now"
+      confirm_run_now: "Run \"%{key}\" immediately?"
+      empty: "No recurring tasks configured."
+    history:
+      title: "Job History"
+      export_csv: "Export CSV"
+      col_job_class: "Job Class"
+      col_queue: "Queue"
+      col_duration: "Duration"
+      col_finished_at: "Finished At"
+      placeholder_filter: "Filter by job class…"
+      aria_filter: "Filter by job class"
+      clear: "Clear"
+      empty: "No finished jobs found."
+    performance:
+      title: "Performance"
+      col_job_class: "Job Class"
+      col_runs: "Runs"
+      col_avg: "Avg"
+      col_p50: "p50"
+      col_p95: "p95"
+      col_p99: "p99"
+      col_std_dev: "Std Dev"
+      col_min: "Min"
+      col_max: "Max"
+      empty: "No finished jobs found."
+      empty_with_period: "No finished jobs found in the last %{period}."
+    audit:
+      title: "Audit Log"
+      export_csv: "Export CSV"
+      all_actions: "All actions"
+      aria_filter_action: "Filter by action"
+      actor_label: "Actor:"
+      queue_label: "Queue:"
+      clear_all: "Clear"
+      col_time: "Time"
+      col_action: "Action"
+      col_actor: "Actor"
+      col_job_class: "Job Class"
+      col_queue: "Queue"
+      col_count: "Count"
+      empty: "No audit events recorded."
+    search:
+      title: "Search Jobs"
+      placeholder: "Search by job class name…"
+      aria_label: "Search all jobs by class name"
+      clear: "Clear"
+      no_results: "No jobs found matching \"%{query}\"."
+      matches:
+        one: "1 match"
+        other: "%{count} matches"
+      showing_first: "— showing first %{limit}"
+      view_all: "View all →"
+      col_job_class: "Job Class"
+      col_queue: "Queue"
+      col_enqueued_at: "Enqueued At"
+    flash:
+      job_discarded: "Job discarded."
+      jobs_discarded:
+        one: "1 job discarded."
+        other: "%{count} jobs discarded."
+      blocked_jobs_discarded:
+        one: "1 blocked job discarded."
+        other: "%{count} blocked jobs discarded."
+      job_run_immediately: "Job scheduled to run immediately."
+      jobs_run_immediately:
+        one: "1 job scheduled to run immediately."
+        other: "%{count} jobs scheduled to run immediately."
+      job_rescheduled: "Job rescheduled by +%{offset}."
+      jobs_retried:
+        one: "1 job queued for retry."
+        other: "%{count} jobs queued for retry."
+      jobs_retried_staggered:
+        one: "1 job queued for retry, staggered %{stagger} apart."
+        other: "%{count} jobs queued for retry, staggered %{stagger} apart."
+      arguments_updated: "Job arguments updated and queued for retry."
+      task_queued: "\"%{key}\" queued for immediate execution."
+      queue_paused: "Queue \"%{name}\" paused."
+      queue_resumed: "Queue \"%{name}\" resumed."
+      cannot_discard: "Cannot discard %{status} jobs."
+      cannot_discard_from_queue: "Cannot discard %{status} jobs from this page."
+      cannot_discard_job: "Could not discard job: %{error}"
+      cannot_discard_jobs: "Could not discard jobs: %{error}"
+      cannot_discard_blocked_jobs: "Could not discard blocked jobs: %{error}"
+      cannot_retry_jobs: "Could not retry jobs: %{error}"
+      cannot_retry_job: "Could not retry job: %{error}"
+      cannot_run_jobs: "Could not run jobs: %{error}"
+      cannot_reschedule_job: "Could not reschedule job: %{error}"
+      cannot_update_job: "Could not update job: %{error}"
+      cannot_pause_queue: "Could not pause queue: %{error}"
+      cannot_resume_queue: "Could not resume queue: %{error}"
+      cannot_enqueue_task: "Could not enqueue \"%{key}\" — it may have just run."
+      task_not_found: "Recurring task not found."
+      cannot_run_task: "Could not run task: %{error}"
+      invalid_json: "Invalid JSON: could not parse arguments."
+      invalid_offset: "Invalid offset."
+      invalid_stagger: "Invalid stagger interval."

data/config/routes.rb

@@ -3,6 +3,7 @@ SolidQueueWeb::Engine.routes.draw do
   resource :blocked_jobs, only: [:destroy]
 
   get "metrics", to: "metrics#index", as: :metrics, defaults: { format: :json }
+  get "audit",       to: "audit#index",       as: :audit
   get "search",      to: "search#index",      as: :search
   get "history",     to: "history#index",     as: :history
   get "performance", to: "performance#index", as: :performance

data/db/migrate/01_create_solid_queue_web_audit_events.rb

@@ -0,0 +1,16 @@
+class CreateSolidQueueWebAuditEvents < ActiveRecord::Migration[7.1]
+  def change
+    create_table :solid_queue_web_audit_events do |t|
+      t.string  :action,     null: false
+      t.string  :actor
+      t.string  :job_class
+      t.string  :queue_name
+      t.integer :item_count, null: false, default: 1
+      t.datetime :created_at, null: false
+    end
+
+    add_index :solid_queue_web_audit_events, :created_at
+    add_index :solid_queue_web_audit_events, :action
+    add_index :solid_queue_web_audit_events, :actor
+  end
+end

data/lib/generators/solid_queue_web/install/migrations_generator.rb

@@ -0,0 +1,24 @@
+require "rails/generators"
+require "rails/generators/active_record"
+
+module SolidQueueWeb
+  module Install
+    class MigrationsGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("templates", __dir__)
+      desc "Copy SolidQueueWeb migrations to your application."
+
+      def self.next_migration_number(path)
+        ActiveRecord::Generators::Base.next_migration_number(path)
+      end
+
+      def create_migration_file
+        migration_template(
+          "create_solid_queue_web_audit_events.rb.tt",
+          "db/migrate/create_solid_queue_web_audit_events.rb"
+        )
+      end
+    end
+  end
+end

data/lib/generators/solid_queue_web/install/templates/create_solid_queue_web_audit_events.rb.tt

@@ -0,0 +1,16 @@
+class CreateSolidQueueWebAuditEvents < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :solid_queue_web_audit_events do |t|
+      t.string  :action,     null: false
+      t.string  :actor
+      t.string  :job_class
+      t.string  :queue_name
+      t.integer :item_count, null: false, default: 1
+      t.datetime :created_at, null: false
+    end
+
+    add_index :solid_queue_web_audit_events, :created_at
+    add_index :solid_queue_web_audit_events, :action
+    add_index :solid_queue_web_audit_events, :actor
+  end
+end

data/lib/solid_queue_web/engine.rb

@@ -8,6 +8,7 @@ module SolidQueueWeb
     isolate_namespace SolidQueueWeb
 
     config.i18n.load_path += Gem.find_files("pagy/locales/en.yml")
+    config.i18n.load_path += Dir[root.join("config/locales/*.yml").to_s]
 
     initializer "solid_queue_web.assets" do |app|
       if app.config.respond_to?(:assets)

data/lib/solid_queue_web/version.rb

@@ -1,3 +1,3 @@
 module SolidQueueWeb
-  VERSION = "1.4.0"
+  VERSION = "1.6.0"
 end

data/lib/solid_queue_web.rb

@@ -7,7 +7,7 @@ module SolidQueueWeb
     attr_writer :page_size, :dashboard_refresh_interval, :default_refresh_interval, :search_results_limit,
                 :slow_job_threshold, :alert_webhook_url, :alert_failure_threshold, :alert_webhook_cooldown,
                 :alert_queue_thresholds, :alert_slow_job_count_threshold, :alert_stale_process_threshold,
-                :connects_to, :time_zone
+                :connects_to, :time_zone, :available_locales, :nav_links, :dashboard_cards
 
     def page_size
       @page_size || 25
@@ -61,6 +61,18 @@ module SolidQueueWeb
       @time_zone
     end
 
+    def available_locales
+      @available_locales || %i[en]
+    end
+
+    def nav_links
+      @nav_links || []
+    end
+
+    def dashboard_cards
+      @dashboard_cards || []
+    end
+
     def configure
       yield self
     end
@@ -69,5 +81,10 @@ module SolidQueueWeb
       @authenticate = block if block_given?
       @authenticate
     end
+
+    def current_actor(&block)
+      @current_actor = block if block_given?
+      @current_actor
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solid_queue_web
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Chuck Smith
@@ -122,6 +122,7 @@ files:
 - app/assets/stylesheets/solid_queue_web/_12_dark_mode.css
 - app/assets/stylesheets/solid_queue_web/application.css
 - app/controllers/solid_queue_web/application_controller.rb
+- app/controllers/solid_queue_web/audit_controller.rb
 - app/controllers/solid_queue_web/blocked_jobs_controller.rb
 - app/controllers/solid_queue_web/dashboard_controller.rb
 - app/controllers/solid_queue_web/failed_jobs/arguments_controller.rb
@@ -151,6 +152,7 @@ files:
 - app/javascript/solid_queue_web/theme_controller.js
 - app/jobs/solid_queue_web/application_job.rb
 - app/models/solid_queue_web/application_record.rb
+- app/models/solid_queue_web/audit_event.rb
 - app/models/solid_queue_web/job.rb
 - app/services/solid_queue_web/alert_webhook.rb
 - app/services/solid_queue_web/dashboard_stats.rb
@@ -162,6 +164,7 @@ files:
 - app/services/solid_queue_web/slow_job_alert.rb
 - app/services/solid_queue_web/stale_process_alert.rb
 - app/views/layouts/solid_queue_web/application.html.erb
+- app/views/solid_queue_web/audit/index.html.erb
 - app/views/solid_queue_web/dashboard/index.html.erb
 - app/views/solid_queue_web/failed_jobs/errors/index.html.erb
 - app/views/solid_queue_web/failed_jobs/index.html.erb
@@ -178,7 +181,11 @@ files:
 - app/views/solid_queue_web/scheduled_jobs/update.turbo_stream.erb
 - app/views/solid_queue_web/search/index.html.erb
 - config/importmap.rb
+- config/locales/en.yml
 - config/routes.rb
+- db/migrate/01_create_solid_queue_web_audit_events.rb
+- lib/generators/solid_queue_web/install/migrations_generator.rb
+- lib/generators/solid_queue_web/install/templates/create_solid_queue_web_audit_events.rb.tt
 - lib/solid_queue_web.rb
 - lib/solid_queue_web/engine.rb
 - lib/solid_queue_web/version.rb