mirror of https://github.com/ChuckBuilds/LEDMatrix.git synced 2026-04-10 13:02:59 +00:00

Files

Chuck 8fb2800495 feat: add error detection, monitoring, and code quality improvements (#223 )

* feat: add error detection, monitoring, and code quality improvements

This comprehensive update addresses automatic error detection, code
quality, and plugin development experience:

## Error Detection & Monitoring
- Add ErrorAggregator service for centralized error tracking
- Add pattern detection for recurring errors (5+ in 60 min)
- Add error dashboard API endpoints (/api/v3/errors/*)
- Integrate error recording into plugin executor

## Code Quality
- Remove 10 silent `except: pass` blocks in sports.py and football.py
- Remove hardcoded debug log paths
- Add pre-commit hooks to prevent future bare except clauses

## Validation & Type Safety
- Add warnings when plugins lack config_schema.json
- Add config key collision detection for plugins
- Improve type coercion logging in BasePlugin

## Testing
- Add test_config_validation_edge_cases.py
- Add test_plugin_loading_failures.py
- Add test_error_aggregator.py

## Documentation
- Add PLUGIN_ERROR_HANDLING.md guide
- Add CONFIG_DEBUGGING.md guide

Note: GitHub Actions CI workflow is available in the plan but requires
workflow scope to push. Add .github/workflows/ci.yml manually.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix: address code review issues

- Fix GitHub issues URL in CONFIG_DEBUGGING.md
- Use RLock in error_aggregator.py to prevent deadlock in export_to_file
- Distinguish missing vs invalid schema files in plugin_manager.py
- Add assertions to test_null_value_for_required_field test
- Remove unused initial_count variable in test_plugin_load_error_recorded
- Add validation for max_age_hours in clear_old_errors API endpoint

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

---------

Co-authored-by: Chuck <chuck@example.com>
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>

2026-01-30 10:05:09 -05:00

blueprints

feat: add error detection, monitoring, and code quality improvements (#223 )

2026-01-30 10:05:09 -05:00

static/v3

Feature/vegas scroll mode (#215 )

2026-01-29 10:23:56 -05:00

templates/v3

fix(web): ensure unchecked checkboxes save as false in main config forms (#222 )

2026-01-29 21:49:29 -05:00

__init__.py

Plugins (#145 )

2025-12-27 14:15:49 -05:00

app.py

fix(web-ui): Fix file upload widget and plugin action buttons (#165 )

2025-12-30 19:04:21 -05:00

cache.py

Plugins (#145 )

2025-12-27 14:15:49 -05:00

logging_config.py

Plugins (#145 )

2025-12-27 14:15:49 -05:00

README.md

Plugins (#145 )

2025-12-27 14:15:49 -05:00

requirements.txt

Plugins (#145 )

2025-12-27 14:15:49 -05:00

run.sh

Plugins (#145 )

2025-12-27 14:15:49 -05:00

start.py

Plugins (#145 )

2025-12-27 14:15:49 -05:00

README.md

LED Matrix Web Interface V3

Modern, production web interface for controlling the LED Matrix display.

Overview

This directory contains the active V3 web interface with the following features:

Real-time display preview via Server-Sent Events (SSE)
Plugin management and configuration
System monitoring and logs
Modern, responsive UI
RESTful API

Directory Structure

web_interface/
├── app.py                    # Main Flask application
├── start.py                  # Startup script
├── run.sh                    # Shell runner script
├── requirements.txt          # Python dependencies
├── blueprints/               # Flask blueprints
│   ├── api_v3.py            # API endpoints
│   └── pages_v3.py          # Page routes
├── templates/                # HTML templates
│   └── v3/
│       ├── base.html
│       ├── index.html
│       └── partials/
└── static/                   # CSS/JS assets
    └── v3/
        ├── app.css
        └── app.js

Running the Web Interface

Standalone (Development)

From the project root:

python3 web_interface/start.py

Or using the shell script:

./web_interface/run.sh

As a Service (Production)

The web interface can run as a systemd service that starts automatically based on the web_display_autostart configuration setting:

sudo systemctl start ledmatrix-web
sudo systemctl enable ledmatrix-web  # Start on boot

Accessing the Interface

Once running, access the web interface at:

Local: http://localhost:5000
Network: http://:5000

Configuration

The web interface reads configuration from:

config/config.json - Main configuration
config/secrets.json - API keys and secrets

API Documentation

The V3 API is available at /api/v3/ with the following endpoints:

Configuration

GET /api/v3/config/main - Get main configuration
POST /api/v3/config/main - Save main configuration
GET /api/v3/config/secrets - Get secrets configuration
POST /api/v3/config/secrets - Save secrets configuration

Display Control

POST /api/v3/display/start - Start display service
POST /api/v3/display/stop - Stop display service
POST /api/v3/display/restart - Restart display service
GET /api/v3/display/status - Get display service status

Plugins

GET /api/v3/plugins - List installed plugins
GET /api/v3/plugins/<id> - Get plugin details
POST /api/v3/plugins/<id>/config - Update plugin configuration
GET /api/v3/plugins/<id>/enable - Enable plugin
GET /api/v3/plugins/<id>/disable - Disable plugin

Plugin Store

GET /api/v3/store/plugins - List available plugins
POST /api/v3/store/install/<id> - Install plugin
POST /api/v3/store/uninstall/<id> - Uninstall plugin
POST /api/v3/store/update/<id> - Update plugin

Real-time Streams (SSE)

GET /api/v3/stream/stats - System statistics stream
GET /api/v3/stream/display - Display preview stream
GET /api/v3/stream/logs - Service logs stream

Development

When making changes to the web interface:

Edit files in this directory
Test changes by running python3 web_interface/start.py
Restart the service if running: sudo systemctl restart ledmatrix-web

Notes

Templates and static files use the v3/ prefix to allow for future versions
The interface uses Flask blueprints for modular organization
SSE streams provide real-time updates without polling