sidekiq_queue_manager 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0b811d2bd12bbf0f5ed238d7e9a2f1a48ed6e7034313697cc7d3ea23c136840
-  data.tar.gz: 127dbcf05fbafdde46f77fab0fb7d4306f560718b34f1b395b9e3d20df704410
+  metadata.gz: 3b2640e2b918627c813a711db3487c4261b08f153a4ed3717fa5a6f9eb3811f7
+  data.tar.gz: 833e2540f832309dbbd3dd06387ce5b0b92c8ef0a2970638aa6eefe90bc186b2
 SHA512:
-  metadata.gz: dff9898513e4b040c8302ed81778e515d90ca401ff9c65eabac31c0caa03171398060e9d39c85a3448d84741f58b4ae1b89be2449e2374526d4a0b3eb70e8468
-  data.tar.gz: 49831b2810880b5bd5813c73fc28af465b67f8d24550d030320eb2196b0da3f3c31ff5490436bc77e9178aecdd175de23de7b3d29075fbf02d8a6313556bc022
+  metadata.gz: 712ae0ef4321710938a3af0295de9983d09d62ea02c73068da3f3a4003d12c131850ff2c74ab78e4cccccc9d5de49be6bbcb723703efba12c4ab1de93464ef58
+  data.tar.gz: f72ebc6d34524cad3d7f7a0bbd38d3a873403706b1900bfed6edc438b4e3883afbfa527048ffe0ee9e56b1d3b21c06f82c0a004d9343e6defa1f10995ff09215

data/INSTALLATION.md

@@ -22,7 +22,8 @@ Create `config/initializers/sidekiq_queue_manager.rb`:
 
 ```ruby
 SidekiqQueueManager.configure do |config|
-  # REQUIRED: Set basic auth password (follows Sidekiq Web UI pattern)
+  # Enable authentication (recommended for production)
+  config.basic_auth_enabled = true
   config.basic_auth_password = 'your-secure-password-here'
   
   # Optional: Protect critical queues
@@ -30,7 +31,7 @@ SidekiqQueueManager.configure do |config|
 end
 ```
 
-**⚠️ Professional Standard**: Like Sidekiq Web UI, this gem requires explicit authentication configuration. You must set a password or configure custom authentication.
+**🔒 Security Note**: Authentication is **disabled by default** for easy development setup. **Enable it for production** by setting `basic_auth_enabled = true` and providing a secure password.
 
 ### **2. Mount the Engine**
 

data/README.md

@@ -6,28 +6,35 @@
 [![Sidekiq](https://img.shields.io/badge/Sidekiq-7.0%2B-orange.svg)](https://sidekiq.org)
 [![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
 
-**Professional Sidekiq queue monitoring and management interface for Rails applications.**
+**Complete Sidekiq management suite with tabbed interface for queues, scheduled jobs, retries, and dead jobs.**
 
-A modern, real-time web interface for monitoring and managing Sidekiq queues with zero configuration required. Perfect for production environments requiring professional queue monitoring capabilities.
+A modern, real-time web interface for comprehensive Sidekiq management with zero configuration required. Features match and extend the official Sidekiq Web UI with enhanced filtering, smart number formatting, and professional design. Perfect for production environments requiring full-featured job management capabilities.
 
 ---
 
 ## ✨ Features
 
-### 🚀 **Real-Time Queue Management**
+### 🚀 **Complete Sidekiq Management Suite**
 
-- **Live Statistics** - Real-time queue metrics with 5-second auto-refresh
+- **Live Statistics** - Real-time queue metrics with smart number formatting (K, M, B, T)
 - **Universal Queue Discovery** - Automatically detects ALL Sidekiq queues
-- **Pause/Resume Operations** - Individual and bulk queue control
+- **Tabbed Interface** - Organized views for Queues, Scheduled, Retries, and Dead jobs
+- **Scheduled Jobs Management** - View, delete, enqueue, and bulk clear scheduled jobs
+- **Retry Jobs Management** - Retry now, delete, kill, or bulk operations on failed jobs
+- **Dead Jobs Management** - Resurrect, delete permanently, or bulk operations on dead jobs
 - **Advanced Queue Controls** - Set limits, block queues, manage process limits
-- **Job Management** - View, delete, and paginate through individual jobs
+- **Job Management** - View, delete, and paginate through jobs with filtering
 
 ### 🎨 **Professional Interface**
 
-- **Modern UI/UX** - Dark-mode optimized responsive design
-- **Live Pull Toggle** - Enable/disable real-time updates
-- **Custom Modal System** - Professional confirmations and prompts
-- **Mobile Responsive** - Optimized for all device sizes
+- **Modern Tabbed UI** - Organized interface with Queues, Scheduled, Retries, and Dead job views
+- **Smart Number Display** - Large numbers automatically formatted (92.9M, 1.2B, 5T) to prevent overflow
+- **Dark-mode Optimized** - Beautiful responsive design that works on all screen sizes
+- **Live Pull Toggle** - Enable/disable real-time updates with visual indicators
+- **Custom Modal System** - Professional confirmations and prompts (no browser alerts)
+- **Advanced Filtering** - Filter jobs by class name across all tabs
+- **Pagination** - Efficient browsing through large job sets
+- **Mobile Responsive** - Optimized layouts for desktop, tablet, and mobile
 - **Accessibility Ready** - ARIA labels, keyboard navigation, screen reader support
 
 ### 🔒 **Enterprise Features**
@@ -149,10 +156,41 @@ end
 
 The main dashboard provides:
 
-- **Global Statistics** - Processed, failed, busy, and enqueued job counts
-- **Queue Summary** - Total queues, paused queues, and total jobs
-- **Live Controls** - Toggle real-time updates and manual refresh
-- **Queue Table** - Detailed view of all queues with actions
+- **Enhanced Global Statistics** - Processed, failed, busy, enqueued, scheduled, retry, and dead job counts with smart formatting
+- **Tabbed Interface** - Four main sections: Queues, Scheduled, Retries, and Dead jobs with real-time counts
+- **Live Controls** - Toggle real-time updates and manual refresh with visual indicators
+- **Advanced Filtering** - Filter jobs by class name across all tabs
+- **Responsive Design** - Optimized layouts that prevent number overflow on all screen sizes
+
+### Job Management by Type
+
+#### 📅 Scheduled Jobs Tab
+
+- **View Scheduled Jobs** - Browse future jobs with execution times and time remaining
+- **Enqueue Now** - Execute scheduled jobs immediately
+- **Delete Jobs** - Remove scheduled jobs before execution
+- **Clear All** - Bulk delete all scheduled jobs (with optional filtering)
+- **Pagination** - Navigate through large lists of scheduled jobs
+- **Filtering** - Filter by job class name for easy searching
+
+#### 🔄 Retries Tab
+
+- **View Failed Jobs** - See jobs that failed and are awaiting retry
+- **Retry Now** - Execute retry jobs immediately
+- **Kill Jobs** - Move retry jobs to dead queue
+- **Delete Jobs** - Permanently remove retry jobs
+- **Retry All** - Bulk retry all failed jobs (with optional filtering)
+- **Clear All** - Bulk delete all retry jobs (with optional filtering)
+- **Progress Indicators** - Visual progress bars showing retry attempts vs limits
+
+#### ☠️ Dead Jobs Tab
+
+- **View Dead Jobs** - Browse jobs that have exhausted all retry attempts
+- **Resurrect Jobs** - Move dead jobs back to retry queue
+- **Delete Permanently** - Remove dead jobs forever
+- **Resurrect All** - Bulk resurrect all dead jobs (with optional filtering)
+- **Clear All** - Bulk delete all dead jobs permanently (with optional filtering)
+- **Error Details** - View error messages and stack traces
 
 ### Queue Operations
 
@@ -210,6 +248,36 @@ POST /queues/pause_all     # Pause all non-critical queues
 POST /queues/resume_all    # Resume all paused queues
 ```
 
+### Scheduled Jobs Endpoints
+
+```http
+GET    /scheduled                    # List scheduled jobs (paginated, filterable)
+DELETE /scheduled/:id                # Delete specific scheduled job
+POST   /scheduled/:id/enqueue        # Enqueue scheduled job immediately
+POST   /scheduled/clear              # Clear all scheduled jobs (with optional filter)
+```
+
+### Retry Jobs Endpoints
+
+```http
+GET    /retries                      # List retry jobs (paginated, filterable)
+POST   /retries/:id/retry            # Retry specific job immediately
+DELETE /retries/:id                  # Delete specific retry job
+POST   /retries/:id/kill             # Kill retry job (move to dead queue)
+POST   /retries/retry_all            # Retry all jobs (with optional filter)
+POST   /retries/clear                # Clear all retry jobs (with optional filter)
+```
+
+### Dead Jobs Endpoints
+
+```http
+GET    /dead                         # List dead jobs (paginated, filterable)
+POST   /dead/:id/resurrect           # Resurrect dead job to retry queue
+DELETE /dead/:id                     # Delete dead job permanently
+POST   /dead/resurrect_all           # Resurrect all dead jobs (with optional filter)
+POST   /dead/clear                   # Clear all dead jobs (with optional filter)
+```
+
 ### Queue-Specific Endpoints
 
 ```http
@@ -241,9 +309,14 @@ GET /live    # Server-Sent Events stream for real-time updates
 
 ### Production Recommendations
 
-1. **Authentication Required**
+1. **Enable Authentication** (disabled by default for development)
 
    ```ruby
+   # Enable basic auth
+   config.basic_auth_enabled = true
+   config.basic_auth_password = 'secure-password'
+   
+   # OR use custom authentication
    config.authentication_method = :authenticate_admin!
    ```
 
@@ -314,12 +387,46 @@ The gem works out-of-the-box on Heroku with no additional configuration needed.
 
 ### Compatibility
 
-- ✅ **Sidekiq Pro/Enterprise** - Full compatibility
+- ✅ **Sidekiq Web UI Feature Parity** - Matches and extends official Sidekiq Web functionality
+- ✅ **Sidekiq Pro/Enterprise** - Full compatibility with all Sidekiq editions
 - ✅ **Multi-process Sidekiq** - Advanced process management
-- ✅ **Existing Sidekiq setups** - Zero breaking changes
-- ✅ **All queue types** - Works with any Sidekiq job
-- ✅ **Docker/Kubernetes** - Container-ready
-- ✅ **Heroku/Cloud platforms** - Platform-agnostic
+- ✅ **Existing Sidekiq setups** - Zero breaking changes, drop-in replacement
+- ✅ **All job types** - Works with queued, scheduled, retry, and dead jobs
+- ✅ **Docker/Kubernetes** - Container-ready with health checks
+- ✅ **Heroku/Cloud platforms** - Platform-agnostic deployment
+
+---
+
+## 📝 Changelog
+
+### Version 1.1.0 (Latest)
+
+🎉 **Major Feature Release - Complete Sidekiq Management Suite**
+
+**New Features:**
+- ✨ **Tabbed Interface** - Organized views for Queues, Scheduled, Retries, and Dead jobs
+- 📅 **Scheduled Jobs Management** - View, delete, enqueue immediately, and bulk operations
+- 🔄 **Retry Jobs Management** - Retry now, delete, kill, and bulk operations with progress indicators
+- ☠️ **Dead Jobs Management** - Resurrect, delete permanently, and bulk operations
+- 📊 **Enhanced Statistics** - Added scheduled, retry, and dead job counts to main dashboard
+- 🔢 **Smart Number Formatting** - Large numbers automatically formatted (92.9M, 1.2B, 5T) to prevent overflow
+- 🔍 **Advanced Filtering** - Filter jobs by class name across all tabs
+- 📄 **Pagination** - Efficient browsing through large job sets
+- 💬 **Custom Modals** - Professional confirmation dialogs (no browser alerts)
+
+**API Enhancements:**
+- 🚀 **18 New REST Endpoints** - Complete API coverage for scheduled, retry, and dead jobs
+- 📡 **Real-time Tab Counts** - Live updates for all job type counts
+- 🎯 **Enhanced Error Handling** - Comprehensive error responses and validation
+
+**UI/UX Improvements:**
+- 📱 **Responsive Grid System** - Optimized 7-card stats layout that prevents overflow
+- 🎨 **Enhanced Visual Design** - Progress bars, status indicators, and improved typography
+- ⚡ **Performance Optimized** - Efficient loading and rendering of large job lists
+
+**Backward Compatibility:**
+- ✅ **Zero Breaking Changes** - All existing functionality preserved
+- 🔄 **Seamless Upgrade** - Drop-in replacement for previous versions
 
 ---
 
@@ -373,4 +480,4 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 **Created and maintained by [Jamal Awad](https://github.com/jamalawd)**  
 *Ruby enthusiast, tech lead, & architect passionate about open-source development*
 
-*Transform your Sidekiq monitoring experience with professional-grade queue management.*
+*Transform your Sidekiq experience with comprehensive job management - queues, scheduled jobs, retries, and dead jobs in one professional interface.*

data/app/controllers/sidekiq_queue_manager/application_controller.rb

@@ -179,12 +179,21 @@ module SidekiqQueueManager
 
     # Get the mount path from the engine's routes
     def engine_mount_path
-      # Extract mount path from the current request path
-      if request.path =~ %r{^(/[^/]+)}
-        Regexp.last_match(1)
-      else
-        '/sidekiq_manager' # Default fallback
+      # Look through Rails routes for engine mounts
+      Rails.application.routes.routes.each do |route|
+        next unless route.respond_to?(:app)
+        next unless route.app.respond_to?(:app)
+
+        # Check if this route's app is our engine
+        if route.app.app == SidekiqQueueManager::Engine
+          path_spec = route.path.spec.to_s
+          return path_spec.gsub(/\(\.:format\)$/, '').chomp('/')
+        end
       end
+
+      nil
+    rescue StandardError
+      nil
     end
 
     # Common helper for accessing main application methods

data/lib/sidekiq_queue_manager/configuration.rb

@@ -14,16 +14,19 @@ module SidekiqQueueManager
     # Internal options (sensible defaults, not typically user-configured)
     attr_reader :redis_key_prefix, :redis_timeout, :log_level, :enable_csp, :cache_ttl
 
+    # Track whether user has explicitly configured the gem
+    attr_reader :explicitly_configured
+
     def initialize
       # Essential defaults (what most users care about)
       @authentication_method = nil          # Custom auth method (optional)
       @critical_queues = []                 # No protected queues by default
       @theme = 'auto'                       # Auto light/dark theme
 
-      # Basic HTTP Authentication (professional standard - explicit configuration required)
-      @basic_auth_enabled = true            # Secure by default like Sidekiq Web UI
+      # Basic HTTP Authentication - safer defaults for gem installation
+      @basic_auth_enabled = false           # Disabled by default - user must opt-in
       @basic_auth_username = 'admin'        # Standard admin username
-      @basic_auth_password = nil            # MUST be explicitly set by user
+      @basic_auth_password = nil            # MUST be explicitly set by user when enabled
 
       # Advanced defaults (rarely changed)
       @refresh_interval = 5000              # 5 second UI refresh
@@ -37,18 +40,33 @@ module SidekiqQueueManager
       @log_level = :info                    # Standard logging level
       @enable_csp = true                    # Security headers enabled
       @cache_ttl = 300                      # 5 minute cache TTL
+
+      # Track explicit configuration
+      @explicitly_configured = false
+    end
+
+    # Mark that user has explicitly configured the gem
+    def mark_as_configured!
+      @explicitly_configured = true
     end
 
     # Validate essential user-provided configuration
-    def validate!
+    def validate!(skip_auth_unless_configured: false)
       validate_basic_settings!
-      validate_authentication!
+
+      # Only validate authentication if explicitly configured or forced
+      if skip_auth_unless_configured && !@explicitly_configured
+        Rails.logger.debug '[SidekiqQueueManager] Skipping authentication validation - not explicitly configured'
+      else
+        validate_authentication!
+      end
+
       self # Return self for method chaining (Ruby idiom)
     end
 
     # Check if configuration is valid without raising (Ruby's truthiness approach)
-    def valid?
-      validate!
+    def valid?(skip_auth_unless_configured: false)
+      validate!(skip_auth_unless_configured: skip_auth_unless_configured)
       true
     rescue ConfigurationError
       false

data/lib/sidekiq_queue_manager/engine.rb

@@ -88,8 +88,16 @@ module SidekiqQueueManager
     # Dependency validation with Ruby's case pattern matching
     def validate_and_configure!
       SidekiqQueueManager.validate_dependencies!
-      SidekiqQueueManager.configuration.validate!
-      Rails.logger.info '[SidekiqQueueManager] Configuration validated successfully'
+
+      # Skip authentication validation during startup unless explicitly configured
+      # This prevents crashes when gem is just added to Gemfile without configuration
+      SidekiqQueueManager.configuration.validate!(skip_auth_unless_configured: true)
+
+      if SidekiqQueueManager.configuration.explicitly_configured
+        Rails.logger.info '[SidekiqQueueManager] Configuration validated successfully'
+      else
+        Rails.logger.info '[SidekiqQueueManager] Engine loaded - authentication validation deferred until first access'
+      end
     end
 
     def handle_configuration_error(error)

data/lib/sidekiq_queue_manager/version.rb

@@ -7,6 +7,6 @@ module SidekiqQueueManager
   # - MAJOR: Incompatible API changes
   # - MINOR: Add functionality in backward compatible manner
   # - PATCH: Backward compatible bug fixes
-  VERSION = '1.1.0'
+  VERSION = '2.0.0'
 end
 

data/lib/sidekiq_queue_manager.rb

@@ -59,8 +59,11 @@ module SidekiqQueueManager
     # @yield [Configuration] the configuration instance
     # @return [Configuration] the updated configuration
     def configure
-      yield(configuration) if block_given?
-      configuration.tap(&:validate!) # Ruby idiom: tap for side effects
+      return configuration unless block_given?
+
+      yield(configuration)
+      configuration.mark_as_configured! # Mark as explicitly configured
+      configuration.tap(&:validate!) # Ruby idiom: tap for side effects - full validation when explicitly configured
     end
 
     # Resets configuration to defaults (primarily for testing)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_queue_manager
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Jamal Awad