mirror of
https://github.com/pacnpal/Pac-cogs.git
synced 2025-12-21 03:11:07 -05:00
b26dedd5b1
- Verify no cyclic dependencies in processor components - Document dependency management strategies in systemPatterns.md - Update activeContext.md with current verification status - Confirm proper use of TYPE_CHECKING and late initialization
111 lines
2.9 KiB
Markdown
111 lines
2.9 KiB
Markdown
# System Patterns
|
|
|
|
## High-Level Architecture
|
|
|
|
The videoarchiver module is organized into several key components:
|
|
|
|
- processor: Handles core processing logic
|
|
- queue: Manages video processing queue
|
|
- database: Handles data persistence
|
|
- ffmpeg: Manages video processing
|
|
- utils: Provides utility functions
|
|
- core: Contains core bot functionality
|
|
- config: Manages configuration
|
|
|
|
## Cyclic Dependencies Analysis
|
|
|
|
### Current Dependency Chain (Verified 2024)
|
|
|
|
1. VideoProcessor (core.py)
|
|
- Uses TYPE_CHECKING for handler imports
|
|
- Late initialization of handlers
|
|
- Clean dependency structure with no cycles
|
|
|
|
2. MessageHandler (message_handler.py)
|
|
- Imports from config, queue, and utils
|
|
- No circular dependencies detected
|
|
- Clean dependency structure
|
|
|
|
3. QueueHandler (queue_handler.py)
|
|
- Imports from database, utils, and config
|
|
- No circular dependencies detected
|
|
- Clean dependency structure
|
|
|
|
### Mitigation Strategies Used
|
|
|
|
1. TYPE_CHECKING conditional imports
|
|
- Used effectively in core.py
|
|
- Prevents runtime circular imports
|
|
- Maintains type safety during development
|
|
|
|
2. Late imports
|
|
- Used in VideoProcessor.__init__ to avoid circular dependencies
|
|
- Handlers are imported only when needed
|
|
|
|
3. Forward references
|
|
- Type hints use string literals for types that aren't yet defined
|
|
|
|
## Core Technical Patterns
|
|
|
|
1. Component Initialization Pattern
|
|
- Core processor initializes handlers
|
|
- Handlers are loosely coupled through interfaces
|
|
- Dependencies are injected through constructor
|
|
|
|
2. Message Processing Pipeline
|
|
- Message validation
|
|
- URL extraction
|
|
- Queue management
|
|
- Progress tracking
|
|
|
|
3. Cleanup Management
|
|
- Staged cleanup process
|
|
- Multiple cleanup strategies
|
|
- Resource tracking and monitoring
|
|
|
|
## Data Flow
|
|
|
|
1. Message Processing Flow
|
|
- Message received → MessageHandler
|
|
- Validation → URL Extraction
|
|
- Queue addition → Processing
|
|
|
|
2. Video Processing Flow
|
|
- Queue item → Download
|
|
- Processing → Archival
|
|
- Cleanup → Completion
|
|
|
|
## Key Technical Decisions
|
|
|
|
1. Dependency Management
|
|
- Use of TYPE_CHECKING for circular import prevention
|
|
- Late initialization of components
|
|
- Clear separation of concerns between handlers
|
|
|
|
2. Error Handling
|
|
- Each component has dedicated error types
|
|
- Comprehensive error tracking
|
|
- Graceful degradation
|
|
|
|
3. State Management
|
|
- Clear state transitions
|
|
- Progress tracking
|
|
- Health monitoring
|
|
|
|
4. Resource Management
|
|
- Staged cleanup process
|
|
- Multiple cleanup strategies
|
|
- Resource tracking
|
|
|
|
## Recommendations
|
|
|
|
1. Current Structure
|
|
- The current architecture effectively manages dependencies
|
|
- No immediate issues requiring refactoring
|
|
- Clean dependency structure verified
|
|
|
|
2. Future Improvements
|
|
- Consider using dependency injection container
|
|
- Implement interface segregation for cleaner dependencies
|
|
- Add more comprehensive health checks
|