Aniworld Web Application Development Instructions

This document provides detailed tasks for AI agents to implement a modern web application for the Aniworld anime download manager. All tasks should follow the coding guidelines specified in the project's copilot instructions.

Project Overview

The goal is to create a FastAPI-based web application that provides a modern interface for the existing Aniworld anime download functionality. The core anime logic should remain in SeriesApp.py while the web layer provides REST API endpoints and a responsive UI.

Architecture Principles

Single Responsibility: Each file/class has one clear purpose
Dependency Injection: Use FastAPI's dependency system
Clean Separation: Web layer calls core logic, never the reverse
File Size Limit: Maximum 500 lines per file
Type Hints: Use comprehensive type annotations
Error Handling: Proper exception handling and logging

Additional Implementation Guidelines

Code Style and Standards

Type Hints: Use comprehensive type annotations throughout all modules
Docstrings: Follow PEP 257 for function and class documentation
Error Handling: Implement custom exception classes with meaningful messages
Logging: Use structured logging with appropriate log levels
Security: Validate all inputs and sanitize outputs
Performance: Use async/await patterns for I/O operations

📞 Escalation

If you encounter:

Architecture issues requiring design decisions
Tests that conflict with documented requirements
Breaking changes needed
Unclear requirements or expectations

Document the issue and escalate rather than guessing.

📚 Helpful Commands

# Run all tests
conda run -n AniWorld python -m pytest tests/ -v --tb=short

# Run specific test file
conda run -n AniWorld python -m pytest tests/unit/test_websocket_service.py -v

# Run specific test class
conda run -n AniWorld python -m pytest tests/unit/test_websocket_service.py::TestWebSocketService -v

# Run specific test
conda run -n AniWorld python -m pytest tests/unit/test_websocket_service.py::TestWebSocketService::test_broadcast_download_progress -v

# Run with extra verbosity
conda run -n AniWorld python -m pytest tests/ -vv

# Run with full traceback
conda run -n AniWorld python -m pytest tests/ -v --tb=long

# Run and stop at first failure
conda run -n AniWorld python -m pytest tests/ -v -x

# Run tests matching pattern
conda run -n AniWorld python -m pytest tests/ -v -k "auth"

# Show all print statements
conda run -n AniWorld python -m pytest tests/ -v -s

#Run app
conda run -n AniWorld python -m uvicorn src.server.fastapi_app:app --host 127.0.0.1 --port 8000 --reload

Final Implementation Notes

Incremental Development: Implement features incrementally, testing each component thoroughly before moving to the next
Code Review: Review all generated code for adherence to project standards
Documentation: Document all public APIs and complex logic
Testing: Maintain test coverage above 80% for all new code
Performance: Profile and optimize critical paths, especially download and streaming operations
Security: Regular security audits and dependency updates
Monitoring: Implement comprehensive monitoring and alerting
Maintenance: Plan for regular maintenance and updates

Task Completion Checklist

For each task completed:

Implementation follows coding standards
Unit tests written and passing
Integration tests passing
Documentation updated
Error handling implemented
Logging added
Security considerations addressed
Performance validated
Code reviewed
Task marked as complete in instructions.md
Infrastructure.md updated
Changes committed to git

Tasks

📋 All Tasks Complete! ✅

All phases of the download queue simplification have been successfully implemented:

✅ Phase 1: Backend simplification (DownloadService + API endpoints)
✅ Phase 2: Frontend simplification (queue.html + queue.js + CSS cleanup)
✅ Phase 3: Testing (Unit tests + API tests)
✅ Phase 4: Documentation (features.md + infrastructure.md)

Success Criteria

All 5 requirements from feature list are met
No auto-processing or background queue processing
Only one download active at a time
Manual start required to begin downloads
Stop prevents new downloads but allows current to complete
All unit tests passing (≥80% coverage)
All API tests passing
Manual testing checklist 100% complete
No browser console errors
WebSocket updates working in real-time
Documentation updated (features.md, infrastructure.md)
Code follows project coding standards
No breaking changes to other features

Notes

This is a simplification that removes complexity while maintaining core functionality
Improves user experience with explicit manual control
Easier to understand, test, and maintain
Good foundation for future enhancements if needed
No database schema changes required
WebSocket infrastructure remains unchanged

5.2 KiB Raw Blame History