feat: Add comprehensive web dashboard for Hammerwork job queue monitoring #1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ring Implement a complete web-based admin dashboard as a separate optional crate to provide real-time monitoring and management of Hammerwork job queues. ## New Features ### Web Dashboard (hammerwork-web crate) - **Separate optional crate** for easy installation and deployment - **Modern responsive UI** with HTML5, CSS3, and vanilla JavaScript - **Real-time monitoring** with WebSocket support for live updates - **Complete job management** with create, view, retry, and delete operations - **Queue statistics** with visual charts and metrics - **Multi-database support** for both PostgreSQL and MySQL backends ### Core Components - **REST API endpoints** for all job and queue operations - **WebSocket server** for real-time dashboard updates - **Authentication system** with basic auth and rate limiting - **Configuration management** with TOML file support - **CLI interface** with comprehensive command-line options ### Dashboard Features - **System overview** with key metrics and health status - **Interactive charts** using Chart.js for throughput and queue status - **Job search and filtering** with pagination support - **Queue management** with clear, pause, and resume operations - **Real-time updates** via WebSocket connections - **Responsive design** that works on desktop and mobile devices ### API Endpoints - `/api/queues` - Queue listing and management - `/api/jobs` - Job operations (list, create, retry, delete) - `/api/stats` - System statistics and monitoring data - `/api/system` - System information and maintenance - `/health` - Health check endpoint - `/ws` - WebSocket endpoint for real-time updates ### Technical Implementation - **Warp web framework** for HTTP server and routing - **Database abstraction** supporting both PostgreSQL and MySQL - **Type-safe API** with comprehensive error handling - **Modular architecture** with clear separation of concerns - **Production-ready** with proper logging and monitoring ## Usage ```bash # Install the web dashboard cargo install --path hammerwork-web --features postgres # Run the dashboard hammerwork-web --database-url postgresql://localhost/hammerwork --bind 0.0.0.0 --port 8080 # Or with configuration file hammerwork-web --config dashboard.toml ``` ## Breaking Changes None - this is a purely additive feature in a separate crate. ## Documentation - Comprehensive CLI help and usage examples - Configuration file documentation - API endpoint specifications - WebSocket message protocol 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
This commit encompasses comprehensive improvements across the Hammerwork workspace: ## Web Dashboard Documentation Enhancements - Add comprehensive doctests to all hammerwork-web modules for improved docs.rs experience - Document REST API endpoints with practical usage examples - Add configuration examples using builder patterns - Include authentication, WebSocket, and server setup examples - Create CHANGELOG.md and README.md for hammerwork-web crate ## Clippy Warning Fixes - Fix collapsible if statements in workflow.rs - Replace and_then with map for ResultStorage parsing - Remove shadowing to_string methods in tracing.rs - Use derive(Default) instead of manual implementations - Rename confusing from_str methods to parse_from_db - Fix redundant pattern matching across multiple modules - Handle unused variables properly ## Technical Improvements - Add base64 dependency for authentication credential parsing - Fix type system conflicts with multiple database features - Improve conditional compilation for PostgreSQL/MySQL support - Add Serialize trait to CreateJobRequest for doctest compatibility ## Documentation Coverage - 40 comprehensive doctests covering all major components - Real-world usage examples for job management, queue operations, statistics, and system administration - WebSocket implementation examples for real-time communication - Authentication system documentation with security best practices All doctests pass successfully with PostgreSQL, MySQL, and all-features configurations. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
Fix MySQL dequeue query field completeness issues and test infrastructure improvements.
- Fixed MySQL ColumnNotFound("trace_id") errors by adding missing tracing fields to dequeue queries
- Updated MySQL dequeue() and dequeue_with_priority_weights() to SELECT all 34 required JobRow fields
- Improved test isolation and fixed race conditions in result storage tests
- Fixed 6 failing doctests in worker.rs with proper async/await usage
- All tests now passing: 228 unit tests, 135 doctests, 0 failures
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This pull request introduces a comprehensive web dashboard for Hammerwork job queue monitoring and management. The dashboard provides a modern, real-time interface for administrators to monitor job queues, manage jobs, and access system insights through both a web interface and REST API.
🎯 Key Features
🏗️ Architecture
The web dashboard is implemented as a separate
hammerwork-webcrate that provides:📚 Documentation
🔧 Code Quality Improvements
This PR also includes comprehensive code quality improvements across the workspace:
🧪 Testing
Test Plan
--features postgres--features mysql--all-featuresFiles Added
Core Web Dashboard
hammerwork-web/- New crate for web dashboardhammerwork-web/src/lib.rs- Main library interfacehammerwork-web/src/main.rs- CLI application entry pointhammerwork-web/src/server.rs- Web server implementationhammerwork-web/src/config.rs- Configuration managementhammerwork-web/src/auth.rs- Authentication middlewareREST API
hammerwork-web/src/api/mod.rs- API framework and utilitieshammerwork-web/src/api/jobs.rs- Job management endpointshammerwork-web/src/api/queues.rs- Queue management endpointshammerwork-web/src/api/stats.rs- Statistics and monitoring endpointshammerwork-web/src/api/system.rs- System administration endpointsReal-time Features
hammerwork-web/src/websocket.rs- WebSocket implementation for live updatesFrontend Assets
hammerwork-web/assets/index.html- Modern responsive web interfacehammerwork-web/assets/dashboard.css- Styling and responsive designhammerwork-web/assets/dashboard.js- Interactive dashboard functionalityDocumentation & Testing
hammerwork-web/README.md- Comprehensive usage documentationhammerwork-web/CHANGELOG.md- Version history and changeshammerwork-web/tests/integration_tests.rs- Integration test suiteBreaking Changes
None. This is a purely additive feature that doesn't modify existing Hammerwork functionality.
Documentation
Updated main README.md to prominently feature the web dashboard as the first listed feature, with installation instructions and links to detailed documentation.
🤖 Generated with Claude Code