solid_stack_web 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d97689a002516820708b4d0fcd852eadb94d4c24cd67b2d6d9760cc842df2033
-  data.tar.gz: 14bb1935a9b57b09768ddfd32677b5b16a447d13c96ac605c8bd4f7491412240
+  metadata.gz: f5c82dfa829278df1d7fe7b59637d2b7c7b2ef31ea8ec9fb7ff2fe1234133658
+  data.tar.gz: eb1e7519de019b3921c5ef3536b806b902790a51eac340d94084e59e1ef4650c
 SHA512:
-  metadata.gz: e2f8057a998ccc88c642f5805fd63e850b9e23e60f3b02b48685a55f64d30958e1e2775caae4dc59f58ca68f58e40539df0c282b844c2f196b18bcaa06999887
-  data.tar.gz: e4ecd5a93a76121efc58e5f66ae50ceaa9590b065af359b840c0d6f7622ee8f0417ad3ff397152672828c645b37826f8e51c7a3a4cf3da32d8c50a62d81c3d58
+  metadata.gz: 33821254738d6f8c2ee5cc177ef01f600988d905ccf7020285b4a3368b29db7c5f19811aabaf45ade463a433304e70639047bf8120bc0718ee2c9442a93686a7
+  data.tar.gz: 780cbf594e35533f5ee0374e41945a6a1319c22151c6fb2b9b7a82f1aaf256651b6e836777e3939b305bcff510144a5d3d84de014f6e8bc67cab67959f761725

data/app/controllers/solid_stack_web/application_controller.rb

@@ -22,7 +22,7 @@ module SolidStackWeb
 
     def current_section
       case controller_name
-      when "jobs", "failed_jobs", "queues", "processes", "history", "scheduled_jobs", "recurring_tasks" then :queue
+      when "jobs", "failed_jobs", "queues", "processes", "history", "scheduled_jobs", "recurring_tasks", "audit" then :queue
       when "cache", "cache_entries" then :cache
       when "cable" then :cable
       else :overview
@@ -51,6 +51,28 @@ module SolidStackWeb
       request_http_basic_authentication("Solid Stack Dashboard")
     end
 
+    def record_audit(action, job_class: nil, queue_name: nil, item_count: 1)
+      AuditEvent.create!(
+        action:     action,
+        actor:      resolve_current_actor,
+        job_class:  job_class,
+        queue_name: queue_name,
+        item_count: item_count
+      )
+    rescue => e
+      Rails.logger.error("[SolidStackWeb] Audit log failed: #{e.message}")
+    end
+
+    def resolve_current_actor
+      block = SolidStackWeb.current_actor
+      return nil unless block
+
+      instance_exec(&block)
+    rescue => e
+      Rails.logger.error("[SolidStackWeb] current_actor resolution failed: #{e.message}")
+      nil
+    end
+
     def render_not_found
       render "solid_stack_web/errors/not_found", status: :not_found
     end

data/app/controllers/solid_stack_web/audit_controller.rb

@@ -0,0 +1,49 @@
+module SolidStackWeb
+  class AuditController < ApplicationController
+    def index
+      unless AuditEvent.table_exists?
+        redirect_to root_path,
+                    alert: "Audit log requires running `rails solid_stack_web:install:migrations && rails db:migrate`."
+        return
+      end
+
+      set_filters
+      scope = audit_scope
+
+      respond_to do |format|
+        format.html { @pagy, @events = pagy(scope) }
+        format.csv do
+          send_data audit_csv(scope),
+                    filename: "audit-log-#{Date.today}.csv",
+                    type: "text/csv", disposition: "attachment"
+        end
+      end
+    end
+
+    private
+
+    def set_filters
+      @action_filter = params[:audit_action].presence_in(AuditEvent::ACTIONS)
+      @actor_filter  = params[:actor].presence
+      @queue_filter  = params[:queue].presence
+    end
+
+    def audit_scope
+      scope = AuditEvent.recent
+      scope = scope.where(action: @action_filter)     if @action_filter
+      scope = scope.where(actor: @actor_filter)       if @actor_filter
+      scope = scope.where(queue_name: @queue_filter)  if @queue_filter
+      scope
+    end
+
+    def audit_csv(scope)
+      CSV.generate(headers: true) do |csv|
+        csv << %w[id action actor job_class queue_name item_count created_at]
+        scope.each do |event|
+          csv << [event.id, event.action, event.actor, event.job_class,
+                  event.queue_name, event.item_count, event.created_at.iso8601]
+        end
+      end
+    end
+  end
+end

data/app/controllers/solid_stack_web/failed_jobs/selections_controller.rb

@@ -6,6 +6,7 @@ module SolidStackWeb
       def create
         count = @ids.size
         SolidQueue::FailedExecution.where(id: @ids).each(&:retry)
+        record_audit("failed_jobs_retried", item_count: count)
         redirect_to failed_jobs_path, notice: "#{count} #{count == 1 ? "job" : "jobs"} retried."
       rescue => e
         redirect_to failed_jobs_path, alert: "Could not retry jobs: #{e.message}"
@@ -14,6 +15,7 @@ module SolidStackWeb
       def destroy
         job_ids = SolidQueue::FailedExecution.where(id: @ids).pluck(:job_id)
         count = SolidQueue::Job.where(id: job_ids).destroy_all.size
+        record_audit("failed_jobs_discarded", item_count: count)
         redirect_to failed_jobs_path, notice: "#{count} #{count == 1 ? "job" : "jobs"} discarded."
       rescue => e
         redirect_to failed_jobs_path, alert: "Could not discard jobs: #{e.message}"

data/app/controllers/solid_stack_web/failed_jobs_controller.rb

@@ -28,7 +28,10 @@ module SolidStackWeb
 
     def destroy
       @execution = ::SolidQueue::FailedExecution.find(params[:id])
+      job_class  = @execution.job.class_name
+      queue_name = @execution.job.queue_name
       @execution.job.destroy!
+      record_audit("failed_job_discarded", job_class: job_class, queue_name: queue_name)
       @executions_remain = ::SolidQueue::FailedExecution.exists?
       @notice = "Job discarded."
 
@@ -40,6 +43,7 @@ module SolidStackWeb
 
     def retry
       execution = ::SolidQueue::FailedExecution.find(params[:id])
+      record_audit("failed_job_retried", job_class: execution.job.class_name, queue_name: execution.job.queue_name)
       execution.retry
       redirect_to failed_jobs_path, notice: "Job retried."
     end

data/app/controllers/solid_stack_web/jobs/selections_controller.rb

@@ -8,6 +8,7 @@ module SolidStackWeb
         ids     = Array(params[:job_ids]).map(&:to_i).reject(&:zero?)
         job_ids = Job::EXECUTION_MODELS[status].where(id: ids).pluck(:job_id)
         count   = SolidQueue::Job.where(id: job_ids).destroy_all.size
+        record_audit("jobs_discarded", item_count: count)
 
         redirect_to jobs_path(
           status:    status,

data/app/controllers/solid_stack_web/jobs_controller.rb

@@ -31,7 +31,10 @@ module SolidStackWeb
     def destroy
       if params[:id]
         @execution = Job::EXECUTION_MODELS[@status].find(params[:id])
+        job_class  = @execution.job.class_name
+        queue_name = @execution.job.queue_name
         @execution.job.destroy!
+        record_audit("job_discarded", job_class: job_class, queue_name: queue_name)
         @executions_remain = Job::EXECUTION_MODELS[@status].exists?
         @notice = "Job discarded."
 
@@ -42,6 +45,7 @@ module SolidStackWeb
       else
         job_ids = filtered_scope.pluck(:job_id)
         count = SolidQueue::Job.where(id: job_ids).destroy_all.size
+        record_audit("jobs_discarded", item_count: count)
         redirect_to jobs_path(status: @status, q: @search, queue: @queue, period: @period, priority: @priority, sort: @sort, direction: @direction),
                     notice: "#{count} #{count == 1 ? "job" : "jobs"} discarded."
       end

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

@@ -2,11 +2,13 @@ module SolidStackWeb
   class Queues::PausesController < ApplicationController
     def create
       ::SolidQueue::Pause.find_or_create_by!(queue_name: params[:queue_id])
+      record_audit("queue_paused", queue_name: params[:queue_id])
       redirect_back_or_to queues_path
     end
 
     def destroy
       ::SolidQueue::Pause.find_by(queue_name: params[:queue_id])&.destroy
+      record_audit("queue_resumed", queue_name: params[:queue_id])
       redirect_back_or_to queues_path
     end
   end

data/app/helpers/solid_stack_web/application_helper.rb

@@ -87,6 +87,15 @@ module SolidStackWeb
       end
     end
 
+    def audit_action_badge_class(action)
+      case action
+      when /discard/ then "sqw-badge--failed"
+      when /retry/   then "sqw-badge--scheduled"
+      when "queue_paused"  then "sqw-badge--blocked"
+      when "queue_resumed" then "sqw-badge--ready"
+      end
+    end
+
     def sort_header_th(label, col, url_proc, current_sort:, current_dir:)
       is_active = current_sort == col
       next_dir  = (is_active && current_dir == "desc") ? "asc" : "desc"

data/app/models/solid_stack_web/audit_event.rb

@@ -0,0 +1,17 @@
+module SolidStackWeb
+  class AuditEvent < ActiveRecord::Base
+    self.table_name = "solid_stack_web_audit_events"
+
+    ACTIONS = %w[
+      job_discarded jobs_discarded
+      failed_job_retried failed_jobs_retried
+      failed_job_discarded failed_jobs_discarded
+      queue_paused queue_resumed
+    ].freeze
+
+    validates :action,     presence: true, inclusion: { in: ACTIONS }
+    validates :item_count, numericality: { greater_than: 0 }
+
+    scope :recent, -> { order(created_at: :desc) }
+  end
+end

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

@@ -65,6 +65,8 @@
               class: "sqw-subnav__link#{" sqw-subnav__link--active" if controller_name == "history"}" %>
         <%= link_to "Processes", processes_path,
               class: "sqw-subnav__link#{" sqw-subnav__link--active" if controller_name == "processes"}" %>
+        <%= link_to "Audit", audit_path,
+              class: "sqw-subnav__link#{" sqw-subnav__link--active" if controller_name == "audit"}" %>
       </div>
     </nav>
   <% end %>

data/app/views/solid_stack_web/audit/index.html.erb

@@ -0,0 +1,86 @@
+<div class="sqw-page-header sqw-page-header--split">
+  <h1 class="sqw-page-title">Audit Log</h1>
+  <% if @events&.any? %>
+    <%= link_to "Export CSV",
+          audit_path(format: :csv, audit_action: @action_filter, actor: @actor_filter, queue: @queue_filter),
+          class: "sqw-btn sqw-btn--muted sqw-btn--sm", data: { turbo: false } %>
+  <% end %>
+</div>
+
+<form class="sqw-filters" action="<%= audit_path %>" method="get">
+  <select name="audit_action" class="sqw-select" aria-label="Filter by action"
+          onchange="this.form.submit()">
+    <option value="">All actions</option>
+    <% SolidStackWeb::AuditEvent::ACTIONS.each do |action| %>
+      <option value="<%= action %>" <%= "selected" if @action_filter == action %>><%= action.tr("_", " ") %></option>
+    <% end %>
+  </select>
+
+  <% if @actor_filter.present? %>
+    <span class="sqw-badge">
+      Actor: <%= @actor_filter %>
+      <%= link_to "×", audit_path(audit_action: @action_filter, queue: @queue_filter), class: "sqw-muted", aria: { label: "Clear actor filter" } %>
+    </span>
+  <% end %>
+
+  <% if @queue_filter.present? %>
+    <span class="sqw-badge">
+      Queue: <%= @queue_filter %>
+      <%= link_to "×", audit_path(audit_action: @action_filter, actor: @actor_filter), class: "sqw-muted", aria: { label: "Clear queue filter" } %>
+    </span>
+  <% end %>
+
+  <% if @action_filter.present? || @actor_filter.present? || @queue_filter.present? %>
+    <%= link_to "Clear all", audit_path, class: "sqw-btn sqw-btn--muted sqw-btn--sm" %>
+  <% end %>
+</form>
+
+<% if @events.any? %>
+  <table class="sqw-table">
+    <thead>
+      <tr>
+        <th scope="col">Time</th>
+        <th scope="col">Action</th>
+        <th scope="col">Actor</th>
+        <th scope="col">Job Class</th>
+        <th scope="col">Queue</th>
+        <th scope="col">Count</th>
+      </tr>
+    </thead>
+    <tbody>
+      <% @events.each do |event| %>
+        <tr>
+          <td class="sqw-muted"><%= local_time(event.created_at, format: :long) %></td>
+          <td>
+            <span class="sqw-badge <%= audit_action_badge_class(event.action) %>">
+              <%= event.action.tr("_", " ") %>
+            </span>
+          </td>
+          <td>
+            <% if event.actor.present? %>
+              <%= link_to event.actor, audit_path(audit_action: @action_filter, actor: event.actor, queue: @queue_filter) %>
+            <% else %>
+              <span class="sqw-muted">—</span>
+            <% end %>
+          </td>
+          <td class="sqw-monospace"><%= event.job_class.presence || content_tag(:span, "—", class: "sqw-muted") %></td>
+          <td>
+            <% if event.queue_name.present? %>
+              <span class="sqw-badge sqw-badge--queue">
+                <%= link_to event.queue_name, audit_path(audit_action: @action_filter, actor: @actor_filter, queue: event.queue_name) %>
+              </span>
+            <% else %>
+              <span class="sqw-muted">—</span>
+            <% end %>
+          </td>
+          <td><%= event.item_count %></td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+  <%== @pagy.series_nav(aria_label: "Pagination") if @pagy.pages > 1 %>
+<% else %>
+  <div class="sqw-empty" id="sqd-empty">
+    <p class="sqw-muted">No audit events recorded yet.</p>
+  </div>
+<% end %>

data/config/importmap.rb

@@ -1,6 +1,7 @@
 pin "@hotwired/turbo", to: "https://cdn.jsdelivr.net/npm/@hotwired/turbo@8.0.23/dist/turbo.es2017-esm.js"
 pin "@hotwired/stimulus", to: "https://cdn.jsdelivr.net/npm/@hotwired/stimulus@3.2.2/dist/stimulus.js"
 pin "solid_stack_web", to: "solid_stack_web/application.js"
+pin "solid_stack_web/filter_persist_controller", to: "solid_stack_web/filter_persist_controller.js"
 pin "solid_stack_web/refresh_controller", to: "solid_stack_web/refresh_controller.js"
 pin "solid_stack_web/search_controller", to: "solid_stack_web/search_controller.js"
 pin "solid_stack_web/selection_controller", to: "solid_stack_web/selection_controller.js"

data/config/routes.rb

@@ -36,6 +36,7 @@ SolidStackWeb::Engine.routes.draw do
   get "metrics", to: "metrics#index", as: :metrics
   get "stats",   to: "stats#index",   as: :stats
   get "history", to: "history#index", as: :history
+  get "audit",   to: "audit#index",   as: :audit
   get "cache", to: "cache#index", as: :cache
   resources :cache_entries, only: [:index, :show, :destroy], path: "cache/entries"
   resource  :cache_flush,   only: [:destroy],         path: "cache/flush",    controller: "cache/flushes"

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

@@ -0,0 +1,24 @@
+require "rails/generators/base"
+require "rails/generators/migration"
+
+module SolidStackWeb
+  module Generators
+    class MigrationsGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Generates the solid_stack_web_audit_events migration"
+
+      def self.next_migration_number(dirname)
+        next_migration_number = current_migration_number(dirname) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_number)
+      end
+
+      def create_migration_file
+        migration_template "create_solid_stack_web_audit_events.rb.tt",
+                           "db/migrate/create_solid_stack_web_audit_events.rb"
+      end
+    end
+  end
+end

data/lib/generators/solid_stack_web/install/templates/create_solid_stack_web_audit_events.rb.tt

@@ -0,0 +1,16 @@
+class CreateSolidStackWebAuditEvents < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :solid_stack_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_stack_web_audit_events, :created_at
+    add_index :solid_stack_web_audit_events, :action
+    add_index :solid_stack_web_audit_events, :actor
+  end
+end

data/lib/generators/solid_stack_web/install/templates/initializer.rb

@@ -47,6 +47,13 @@ SolidStackWeb.configure do |config|
   #   "critical" => 50,
   #   "default"  => 500
   # }
+  # Audit log actor — block runs in controller context, return a string identifying the current user.
+  # Requires running `rails solid_stack_web:install:migrations && rails db:migrate` first.
+  #
+  #   config.current_actor do
+  #     current_user&.email
+  #   end
+
   # config.alert_slow_job_count_threshold  = 3       # fire when N+ claimed jobs exceed slow_job_threshold duration
   # config.alert_stale_process_threshold   = 1       # fire when N+ workers have a stale heartbeat (>5 min old)
   # config.alert_webhook_cooldown          = 3600    # seconds between repeat alerts

data/lib/solid_stack_web/version.rb

@@ -1,3 +1,3 @@
 module SolidStackWeb
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

data/lib/solid_stack_web.rb

@@ -84,6 +84,11 @@ module SolidStackWeb
       @authenticate
     end
 
+    def current_actor(&block)
+      @current_actor = block if block_given?
+      @current_actor
+    end
+
     def deprecator
       @deprecator ||= ActiveSupport::Deprecation.new("1.0", "SolidStackWeb")
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solid_stack_web
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Chuck Smith
@@ -151,6 +151,7 @@ files:
 - app/assets/stylesheets/solid_stack_web/_12_dark_mode.css
 - app/assets/stylesheets/solid_stack_web/application.css
 - app/controllers/solid_stack_web/application_controller.rb
+- app/controllers/solid_stack_web/audit_controller.rb
 - app/controllers/solid_stack_web/cable/channel_purges_controller.rb
 - app/controllers/solid_stack_web/cable/purges_controller.rb
 - app/controllers/solid_stack_web/cable_controller.rb
@@ -184,6 +185,7 @@ files:
 - app/javascript/solid_stack_web/theme_controller.js
 - app/javascript/solid_stack_web/timestamp_controller.js
 - app/models/solid_stack_web/alert_webhook.rb
+- app/models/solid_stack_web/audit_event.rb
 - app/models/solid_stack_web/cable_stats.rb
 - app/models/solid_stack_web/cable_timeline.rb
 - app/models/solid_stack_web/cache_size_stats.rb
@@ -196,6 +198,7 @@ files:
 - app/models/solid_stack_web/queue_stats.rb
 - app/models/solid_stack_web/throughput_sparkline.rb
 - app/views/layouts/solid_stack_web/application.html.erb
+- app/views/solid_stack_web/audit/index.html.erb
 - app/views/solid_stack_web/cable/index.html.erb
 - app/views/solid_stack_web/cable_messages/index.html.erb
 - app/views/solid_stack_web/cache/index.html.erb
@@ -224,6 +227,8 @@ files:
 - config/routes.rb
 - docs/screenshots/demo.gif
 - lib/generators/solid_stack_web/install/install_generator.rb
+- lib/generators/solid_stack_web/install/migrations_generator.rb
+- lib/generators/solid_stack_web/install/templates/create_solid_stack_web_audit_events.rb.tt
 - lib/generators/solid_stack_web/install/templates/initializer.rb
 - lib/solid_stack_web.rb
 - lib/solid_stack_web/engine.rb