solid_queue_monitor 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 264dd6a6542855e5209702c11fbb46c1c267b5c8d48d530887030f924bdb929f
-  data.tar.gz: 4d5a33c4152f29d0c3ba4c9fd6c59582e7af9694e85469a78cde9a9d173a4433
+  metadata.gz: d2911139409c2a387a2c425c0ef9927071a05dcf5f718e5aefc7bfb86cc4b7b6
+  data.tar.gz: 398de34669f64b9d4cab2cf1ed7e1f19da6fcd56b67df8da2c2682410308a905
 SHA512:
-  metadata.gz: 704927588ba7329d988a7533ab70e6b444254abc64a15684fbeccce47221c929c39701abd8fbb02dbebf444c0c3a9521cbcc84260d06d3c6fdafca6e01ad2be5
-  data.tar.gz: 8b0a608d0ae89c54719dd5286e9de77cb4145d1f1c3dc7c3f8c1b46a521ae1b2e0ad37d35e7c2796a187122fc38f401b423a46109cc81328cff6805274338357
+  metadata.gz: 9357fee483f20555b92b1fd913224c536ae934bb8442968f42470c672c1cc19a8388d13a5cd7741f36158a67c594913074b5cdafbeae8caaa6aa67e5161cc373
+  data.tar.gz: 32a1c6d65dbbcf9d837ded2fca261d0d715546c446a716073881c7a199d7ee3d561a94971880f5c144f270484199e265fd0b367230babd811891409b56849a2e

data/README.md

@@ -15,13 +15,16 @@ A lightweight, zero-dependency web interface for monitoring Solid Queue backgrou
 
 ## Features
 
-- **Dashboard Overview**: Get a quick snapshot of your job queue with statistics and counts
-- **Job Filtering**: Filter jobs by class name, queue name, and status
-- **Job Management**: Execute scheduled jobs on demand
-- **Failed Job Inspection**: View detailed error information for failed jobs
-- **Queue Monitoring**: Track job distribution across different queues
-- **Recurring Jobs**: Monitor and manage recurring background tasks
-- **Pagination**: Navigate through large job lists with ease
+- **Dashboard Overview**: Get a quick snapshot of your queue's health with statistics on all job types
+- **Ready Jobs**: View jobs that are ready to be executed
+- **In Progress Jobs**: Monitor jobs currently being processed by workers
+- **Scheduled Jobs**: See upcoming jobs scheduled for future execution
+- **Recurring Jobs**: Manage periodic jobs that run on a schedule
+- **Failed Jobs**: Track and debug failed jobs, with the ability to retry or discard them
+- **Queue Management**: View and filter jobs by queue
+- **Advanced Job Filtering**: Filter jobs by class name, queue, status, and job arguments
+- **Quick Actions**: Retry or discard failed jobs directly from any view
+- **Performance Optimized**: Designed for high-volume applications with smart pagination
 - **Optional Authentication**: Secure your dashboard with HTTP Basic Authentication
 - **Responsive Design**: Works on desktop and mobile devices
 - **Zero Dependencies**: No additional JavaScript libraries or frameworks required
@@ -30,7 +33,7 @@ A lightweight, zero-dependency web interface for monitoring Solid Queue backgrou
 
 ### Dashboard Overview
 
-![Dashboard Overview](screenshots/dashboard.png)
+![Dashboard Overview](screenshots/dashboard-2.png)
 
 ### Failed Jobs
 
@@ -41,7 +44,7 @@ A lightweight, zero-dependency web interface for monitoring Solid Queue backgrou
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'solid_queue_monitor', '~> 0.2.0'
+gem 'solid_queue_monitor', '~> 0.3.0'
 ```
 
 Then execute:
@@ -109,6 +112,17 @@ The dashboard provides several views:
 
 For API-only Rails applications, SolidQueueMonitor works out of the box without requiring you to enable the asset pipeline or webpacker. This makes it an ideal choice for monitoring background jobs in modern API-based architectures.
 
+### Job Filtering
+
+You can filter jobs by:
+
+- **Class Name**: Filter by job class name
+- **Queue Name**: Filter by queue name
+- **Job Arguments**: Search within job arguments using case-insensitive partial matching
+- **Status**: Filter by job status (completed, failed, scheduled, pending)
+
+This makes it easy to find specific jobs when debugging issues in your application.
+
 ## Use Cases
 
 - **Production Monitoring**: Keep an eye on your background job processing in production environments
@@ -151,4 +165,4 @@ Everyone interacting in the SolidQueueMonitor project's codebases, issue tracker
 
 - [Solid Queue](https://github.com/rails/solid_queue) - The official Rails background job framework
 - [Rails](https://github.com/rails/rails) - The web application framework
-- [ActiveJob](https://github.com/rails/rails/tree/main/activejob) - Rails job frameworkk
+- [ActiveJob](https://github.com/rails/rails/tree/main/activejob) - Rails job framework

data/Rakefile

@@ -1,23 +1,23 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
 
 namespace :db do
-  task :setup do
+  task setup: :environment do
     require 'fileutils'
     FileUtils.mkdir_p 'spec/dummy/db'
-    system("cd spec/dummy && bundle exec rails db:environment:set RAILS_ENV=test")
-    system("cd spec/dummy && bundle exec rails db:schema:load RAILS_ENV=test")
+    system('cd spec/dummy && bundle exec rails db:environment:set RAILS_ENV=test')
+    system('cd spec/dummy && bundle exec rails db:schema:load RAILS_ENV=test')
   end
 end
 
-task :prepare_test_env do
-  Rake::Task["db:setup"].invoke
+task prepare_test_env: :environment do
+  Rake::Task['db:setup'].invoke
 end
 
-task :spec => :prepare_test_env
+task spec: :prepare_test_env

data/app/controllers/solid_queue_monitor/application_controller.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module SolidQueueMonitor
+  class ApplicationController < ActionController::Base
+    include ActionController::HttpAuthentication::Basic::ControllerMethods
+    include ActionController::Flash
+
+    before_action :authenticate, if: -> { SolidQueueMonitor::AuthenticationService.authentication_required? }
+    layout false
+    skip_before_action :verify_authenticity_token
+
+    def set_flash_message(message, type)
+      session[:flash_message] = message
+      session[:flash_type] = type
+    end
+
+    private
+
+    def authenticate
+      authenticate_or_request_with_http_basic do |username, password|
+        SolidQueueMonitor::AuthenticationService.authenticate(username, password)
+      end
+    end
+  end
+end

data/app/controllers/solid_queue_monitor/base_controller.rb

@@ -1,26 +1,7 @@
-module SolidQueueMonitor
-  class BaseController < ActionController::Base
-    include ActionController::HttpAuthentication::Basic::ControllerMethods
-    include ActionController::Flash
-
-    before_action :authenticate, if: -> { SolidQueueMonitor::AuthenticationService.authentication_required? }
-    layout false
-    skip_before_action :verify_authenticity_token
-    
-    # Define a helper method for setting flash messages
-    def set_flash_message(message, type)
-      session[:flash_message] = message
-      session[:flash_type] = type
-    end
-    
-    private
-
-    def authenticate
-      authenticate_or_request_with_http_basic do |username, password|
-        SolidQueueMonitor::AuthenticationService.authenticate(username, password)
-      end
-    end
+# frozen_string_literal: true
 
+module SolidQueueMonitor
+  class BaseController < SolidQueueMonitor::ApplicationController
     def paginate(relation)
       PaginationService.new(relation, current_page, per_page).paginate
     end
@@ -29,18 +10,18 @@ module SolidQueueMonitor
       # Get flash message from session
       message = session[:flash_message]
       message_type = session[:flash_type]
-      
+
       # Clear the flash message from session after using it
       session.delete(:flash_message)
       session.delete(:flash_type)
-      
+
       html = SolidQueueMonitor::HtmlGenerator.new(
         title: title,
         content: content,
         message: message,
         message_type: message_type
       ).generate
-      
+
       render html: html.html_safe
     end
 
@@ -55,22 +36,22 @@ module SolidQueueMonitor
     # Preload job statuses to avoid N+1 queries
     def preload_job_statuses(jobs)
       return if jobs.empty?
-      
+
       # Get all job IDs
       job_ids = jobs.map(&:id)
-      
+
       # Find all failed jobs in a single query
       failed_job_ids = SolidQueue::FailedExecution.where(job_id: job_ids).pluck(:job_id)
-      
+
       # Find all scheduled jobs in a single query
       scheduled_job_ids = SolidQueue::ScheduledExecution.where(job_id: job_ids).pluck(:job_id)
-      
+
       # Attach the status information to each job
       jobs.each do |job|
         job.instance_variable_set(:@failed, failed_job_ids.include?(job.id))
         job.instance_variable_set(:@scheduled, scheduled_job_ids.include?(job.id))
       end
-      
+
       # Define the method to check if a job is failed
       SolidQueue::Job.class_eval do
         def failed?
@@ -80,7 +61,7 @@ module SolidQueueMonitor
             SolidQueue::FailedExecution.exists?(job_id: id)
           end
         end
-        
+
         def scheduled?
           if instance_variable_defined?(:@scheduled)
             @scheduled
@@ -92,9 +73,10 @@ module SolidQueueMonitor
     end
 
     def filter_jobs(relation)
-      relation = relation.where("class_name LIKE ?", "%#{params[:class_name]}%") if params[:class_name].present?
-      relation = relation.where("queue_name LIKE ?", "%#{params[:queue_name]}%") if params[:queue_name].present?
-      
+      relation = relation.where('class_name LIKE ?', "%#{params[:class_name]}%") if params[:class_name].present?
+      relation = relation.where('queue_name LIKE ?', "%#{params[:queue_name]}%") if params[:queue_name].present?
+      relation = filter_by_arguments(relation) if params[:arguments].present?
+
       if params[:status].present?
         case params[:status]
         when 'completed'
@@ -110,76 +92,96 @@ module SolidQueueMonitor
           failed_job_ids = SolidQueue::FailedExecution.pluck(:job_id)
           scheduled_job_ids = SolidQueue::ScheduledExecution.pluck(:job_id)
           relation = relation.where(finished_at: nil)
-                            .where.not(id: failed_job_ids + scheduled_job_ids)
+                             .where.not(id: failed_job_ids + scheduled_job_ids)
         end
       end
-      
+
       relation
     end
 
+    def filter_by_arguments(relation)
+      # Use ILIKE for case-insensitive search in PostgreSQL
+      relation.where('arguments::text ILIKE ?', "%#{params[:arguments]}%")
+    end
+
     def filter_ready_jobs(relation)
-      return relation unless params[:class_name].present? || params[:queue_name].present?
-      
+      return relation unless params[:class_name].present? || params[:queue_name].present? || params[:arguments].present?
+
       if params[:class_name].present?
-        job_ids = SolidQueue::Job.where("class_name LIKE ?", "%#{params[:class_name]}%").pluck(:id)
+        job_ids = SolidQueue::Job.where('class_name LIKE ?', "%#{params[:class_name]}%").pluck(:id)
         relation = relation.where(job_id: job_ids)
       end
-      
-      if params[:queue_name].present?
-        relation = relation.where("queue_name LIKE ?", "%#{params[:queue_name]}%")
+
+      relation = relation.where('queue_name LIKE ?', "%#{params[:queue_name]}%") if params[:queue_name].present?
+
+      # Add arguments filtering
+      if params[:arguments].present?
+        job_ids = SolidQueue::Job.where('arguments::text ILIKE ?', "%#{params[:arguments]}%").pluck(:id)
+        relation = relation.where(job_id: job_ids)
       end
-      
+
       relation
     end
 
     def filter_scheduled_jobs(relation)
-      return relation unless params[:class_name].present? || params[:queue_name].present?
-      
+      return relation unless params[:class_name].present? || params[:queue_name].present? || params[:arguments].present?
+
       if params[:class_name].present?
-        job_ids = SolidQueue::Job.where("class_name LIKE ?", "%#{params[:class_name]}%").pluck(:id)
+        job_ids = SolidQueue::Job.where('class_name LIKE ?', "%#{params[:class_name]}%").pluck(:id)
         relation = relation.where(job_id: job_ids)
       end
-      
-      if params[:queue_name].present?
-        relation = relation.where("queue_name LIKE ?", "%#{params[:queue_name]}%")
+
+      relation = relation.where('queue_name LIKE ?', "%#{params[:queue_name]}%") if params[:queue_name].present?
+
+      # Add arguments filtering
+      if params[:arguments].present?
+        job_ids = SolidQueue::Job.where('arguments::text ILIKE ?', "%#{params[:arguments]}%").pluck(:id)
+        relation = relation.where(job_id: job_ids)
       end
-      
+
       relation
     end
 
     def filter_recurring_jobs(relation)
-      return relation unless params[:class_name].present? || params[:queue_name].present?
-      
-      if params[:class_name].present?
-        relation = relation.where("class_name LIKE ?", "%#{params[:class_name]}%")
-      end
-      
-      if params[:queue_name].present?
-        relation = relation.where("queue_name LIKE ?", "%#{params[:queue_name]}%")
+      return relation unless params[:class_name].present? || params[:queue_name].present? || params[:arguments].present?
+
+      relation = relation.where('class_name LIKE ?', "%#{params[:class_name]}%") if params[:class_name].present?
+      relation = relation.where('queue_name LIKE ?', "%#{params[:queue_name]}%") if params[:queue_name].present?
+
+      # Add arguments filtering if the model has arguments column
+      if params[:arguments].present? && relation.column_names.include?('arguments')
+        relation = relation.where('arguments::text ILIKE ?',
+                                  "%#{params[:arguments]}%")
       end
-      
+
       relation
     end
 
     def filter_failed_jobs(relation)
-      return relation unless params[:class_name].present? || params[:queue_name].present?
-      
+      return relation unless params[:class_name].present? || params[:queue_name].present? || params[:arguments].present?
+
       if params[:class_name].present?
-        job_ids = SolidQueue::Job.where("class_name LIKE ?", "%#{params[:class_name]}%").pluck(:id)
+        job_ids = SolidQueue::Job.where('class_name LIKE ?', "%#{params[:class_name]}%").pluck(:id)
         relation = relation.where(job_id: job_ids)
       end
-      
+
       if params[:queue_name].present?
         # Check if FailedExecution has queue_name column
         if relation.column_names.include?('queue_name')
-          relation = relation.where("queue_name LIKE ?", "%#{params[:queue_name]}%")
+          relation = relation.where('queue_name LIKE ?', "%#{params[:queue_name]}%")
         else
           # If not, filter by job's queue_name
-          job_ids = SolidQueue::Job.where("queue_name LIKE ?", "%#{params[:queue_name]}%").pluck(:id)
+          job_ids = SolidQueue::Job.where('queue_name LIKE ?', "%#{params[:queue_name]}%").pluck(:id)
           relation = relation.where(job_id: job_ids)
         end
       end
-      
+
+      # Add arguments filtering
+      if params[:arguments].present?
+        job_ids = SolidQueue::Job.where('arguments::text ILIKE ?', "%#{params[:arguments]}%").pluck(:id)
+        relation = relation.where(job_id: job_ids)
+      end
+
       relation
     end
 
@@ -187,8 +189,9 @@ module SolidQueueMonitor
       {
         class_name: params[:class_name],
         queue_name: params[:queue_name],
+        arguments: params[:arguments],
         status: params[:status]
       }
     end
   end
-end 
+end

data/app/controllers/solid_queue_monitor/failed_jobs_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SolidQueueMonitor
   class FailedJobsController < BaseController
     def index
@@ -5,10 +7,9 @@ module SolidQueueMonitor
       @failed_jobs = paginate(filter_failed_jobs(base_query))
 
       render_page('Failed Jobs', SolidQueueMonitor::FailedJobsPresenter.new(@failed_jobs[:records],
-        current_page: @failed_jobs[:current_page],
-        total_pages: @failed_jobs[:total_pages],
-        filters: filter_params
-      ).render)
+                                                                            current_page: @failed_jobs[:current_page],
+                                                                            total_pages: @failed_jobs[:total_pages],
+                                                                            filters: filter_params).render)
     end
 
     def retry
@@ -21,7 +22,7 @@ module SolidQueueMonitor
         set_flash_message("Failed to retry job #{id}.", 'error')
       end
 
-      redirect_to params[:redirect_to].present? ? params[:redirect_to] : failed_jobs_path
+      redirect_to(params[:redirect_to].presence || failed_jobs_path)
     end
 
     def discard
@@ -34,7 +35,7 @@ module SolidQueueMonitor
         set_flash_message("Failed to discard job #{id}.", 'error')
       end
 
-      redirect_to params[:redirect_to].present? ? params[:redirect_to] : failed_jobs_path
+      redirect_to(params[:redirect_to].presence || failed_jobs_path)
     end
 
     def retry_all
@@ -59,4 +60,4 @@ module SolidQueueMonitor
       redirect_to failed_jobs_path
     end
   end
-end
+end

data/app/controllers/solid_queue_monitor/in_progress_jobs_controller.rb

@@ -1,27 +1,33 @@
+# frozen_string_literal: true
+
 module SolidQueueMonitor
   class InProgressJobsController < BaseController
     def index
       base_query = SolidQueue::ClaimedExecution.includes(:job).order(created_at: :desc)
       @in_progress_jobs = paginate(filter_in_progress_jobs(base_query))
-      
+
       render_page('In Progress Jobs', SolidQueueMonitor::InProgressJobsPresenter.new(@in_progress_jobs[:records],
-        current_page: @in_progress_jobs[:current_page],
-        total_pages: @in_progress_jobs[:total_pages],
-        filters: filter_params
-      ).render)
+                                                                                     current_page: @in_progress_jobs[:current_page],
+                                                                                     total_pages: @in_progress_jobs[:total_pages],
+                                                                                     filters: filter_params).render)
     end
 
     private
 
     def filter_in_progress_jobs(relation)
-      return relation unless params[:class_name].present?
-      
+      return relation if params[:class_name].blank? && params[:arguments].blank?
+
       if params[:class_name].present?
-        job_ids = SolidQueue::Job.where("class_name LIKE ?", "%#{params[:class_name]}%").pluck(:id)
+        job_ids = SolidQueue::Job.where('class_name LIKE ?', "%#{params[:class_name]}%").pluck(:id)
         relation = relation.where(job_id: job_ids)
       end
-      
+
+      if params[:arguments].present?
+        job_ids = SolidQueue::Job.where('arguments::text ILIKE ?', "%#{params[:arguments]}%").pluck(:id)
+        relation = relation.where(job_id: job_ids)
+      end
+
       relation
     end
   end
-end 
+end

data/app/controllers/solid_queue_monitor/overview_controller.rb

@@ -1,25 +1,26 @@
+# frozen_string_literal: true
+
 module SolidQueueMonitor
   class OverviewController < BaseController
     def index
       @stats = SolidQueueMonitor::StatsCalculator.calculate
-      
+
       recent_jobs_query = SolidQueue::Job.order(created_at: :desc).limit(100)
       @recent_jobs = paginate(filter_jobs(recent_jobs_query))
-      
+
       preload_job_statuses(@recent_jobs[:records])
-      
+
       render_page('Overview', generate_overview_content)
     end
-    
+
     private
-    
+
     def generate_overview_content
-      SolidQueueMonitor::StatsPresenter.new(@stats).render + 
-      SolidQueueMonitor::JobsPresenter.new(@recent_jobs[:records], 
-        current_page: @recent_jobs[:current_page],
-        total_pages: @recent_jobs[:total_pages],
-        filters: filter_params
-      ).render
+      SolidQueueMonitor::StatsPresenter.new(@stats).render +
+        SolidQueueMonitor::JobsPresenter.new(@recent_jobs[:records],
+                                             current_page: @recent_jobs[:current_page],
+                                             total_pages: @recent_jobs[:total_pages],
+                                             filters: filter_params).render
     end
   end
-end 
+end

data/app/controllers/solid_queue_monitor/queues_controller.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 module SolidQueueMonitor
   class QueuesController < BaseController
     def index
       @queues = SolidQueue::Job.group(:queue_name)
                                .select('queue_name, COUNT(*) as job_count')
                                .order('job_count DESC')
-      
+
       render_page('Queues', SolidQueueMonitor::QueuesPresenter.new(@queues).render)
     end
   end
-end 
+end

data/app/controllers/solid_queue_monitor/ready_jobs_controller.rb

@@ -1,14 +1,15 @@
+# frozen_string_literal: true
+
 module SolidQueueMonitor
   class ReadyJobsController < BaseController
     def index
       base_query = SolidQueue::ReadyExecution.includes(:job).order(created_at: :desc)
       @ready_jobs = paginate(filter_ready_jobs(base_query))
-      
-      render_page('Ready Jobs', SolidQueueMonitor::ReadyJobsPresenter.new(@ready_jobs[:records], 
-        current_page: @ready_jobs[:current_page],
-        total_pages: @ready_jobs[:total_pages],
-        filters: filter_params
-      ).render)
+
+      render_page('Ready Jobs', SolidQueueMonitor::ReadyJobsPresenter.new(@ready_jobs[:records],
+                                                                          current_page: @ready_jobs[:current_page],
+                                                                          total_pages: @ready_jobs[:total_pages],
+                                                                          filters: filter_params).render)
     end
   end
-end 
+end

data/app/controllers/solid_queue_monitor/recurring_jobs_controller.rb

@@ -1,14 +1,15 @@
+# frozen_string_literal: true
+
 module SolidQueueMonitor
   class RecurringJobsController < BaseController
     def index
       base_query = filter_recurring_jobs(SolidQueue::RecurringTask.order(:key))
       @recurring_jobs = paginate(base_query)
-      
+
       render_page('Recurring Jobs', SolidQueueMonitor::RecurringJobsPresenter.new(@recurring_jobs[:records],
-        current_page: @recurring_jobs[:current_page],
-        total_pages: @recurring_jobs[:total_pages],
-        filters: filter_params
-      ).render)
+                                                                                  current_page: @recurring_jobs[:current_page],
+                                                                                  total_pages: @recurring_jobs[:total_pages],
+                                                                                  filters: filter_params).render)
     end
   end
-end 
+end

data/app/controllers/solid_queue_monitor/scheduled_jobs_controller.rb

@@ -1,16 +1,17 @@
+# frozen_string_literal: true
+
 module SolidQueueMonitor
   class ScheduledJobsController < BaseController
     def index
       base_query = SolidQueue::ScheduledExecution.includes(:job).order(scheduled_at: :asc)
       @scheduled_jobs = paginate(filter_scheduled_jobs(base_query))
-      
+
       render_page('Scheduled Jobs', SolidQueueMonitor::ScheduledJobsPresenter.new(@scheduled_jobs[:records],
-        current_page: @scheduled_jobs[:current_page],
-        total_pages: @scheduled_jobs[:total_pages],
-        filters: filter_params
-      ).render)
+                                                                                  current_page: @scheduled_jobs[:current_page],
+                                                                                  total_pages: @scheduled_jobs[:total_pages],
+                                                                                  filters: filter_params).render)
     end
-    
+
     def create
       if params[:job_ids].present?
         SolidQueueMonitor::ExecuteJobService.new.execute_many(params[:job_ids])
@@ -21,4 +22,4 @@ module SolidQueueMonitor
       redirect_to scheduled_jobs_path
     end
   end
-end 
+end