Compare commits

..

5 Commits

Author SHA1 Message Date
01e4dec8d7 chore: bump version 2026-06-05 21:08:23 +02:00
ecef21eec4 feat(setup): track unresolved folders for manual key resolution
When SetupService cannot auto-resolve a provider key for an anime folder,
the folder is now tracked in the new 'unresolved_folders' table instead of
being silently skipped. Users can then resolve these via the new API:

- GET /api/setup/unresolved - list unresolved folders with search suggestions
- POST /api/setup/unresolved/{folder}/resolve - provide key to resolve folder

The SetupService.run() now:
- Tracks unresolved folders instead of skipping them
- Re-creates AnimeSeries for previously unresolved folders that are now resolved
- Includes unresolved count in logs

New files:
- src/server/api/setup_endpoints.py - API endpoints for unresolved management
- tests/unit/test_unresolved_folder_service.py - service and model tests

Modified:
- src/server/database/models.py - add UnresolvedFolder model
- src/server/database/service.py - add UnresolvedFolderService
- src/server/services/setup_service.py - track unresolved folders
- src/server/fastapi_app.py - include setup router
2026-06-05 21:07:52 +02:00
d9738ffb78 docs: add fuzzy series key resolution to features.md
- Add Folder Management section with fuzzy title matching feature
- Tolerates title variations like (TV), (OVA), (Movie) suffixes during library setup
2026-06-05 20:49:27 +02:00
6aec2a1733 docs: add SetupService to architecture, update changelog and testing docs
- ARCHITECTURE.md: add setup_service.py to services list
- CHANGELOG.md: add Unreleased section with folder scan key resolution fix
- TESTING.md: add SetupService testing section with example tests
2026-06-05 20:42:26 +02:00
84487d7571 fix: use fuzzy title matching in _resolve_key_via_search
- Add _normalize_title() to strip anime suffixes (TV, OVA, Movie, etc.)
- Add _titles_match() using SequenceMatcher for similarity (threshold 0.85)
- Replace exact string match with fuzzy match to fix skipped folders
- Add debug logging for title mismatches and multiple results
- Set LOG_LEVEL=DEBUG in docker-compose.yml
2026-06-05 20:37:06 +02:00
14 changed files with 1067 additions and 79 deletions

View File

@@ -1 +1 @@
v1.4.1
v1.4.2

View File

@@ -38,6 +38,7 @@ services:
condition: service_healthy
environment:
- PYTHONUNBUFFERED=1
- LOG_LEVEL=DEBUG
volumes:
- app-data:/app/data
- app-logs:/app/logs

View File

@@ -81,6 +81,7 @@ src/server/
| +-- websocket_service.py# WebSocket broadcasting
| +-- queue_repository.py # Database persistence
| +-- nfo_service.py # NFO metadata management
| +-- setup_service.py # Series key resolution from folder names
| +-- folder_scan_service.py # Daily folder maintenance scan
+-- models/ # Pydantic models
| +-- auth.py # Auth request/response models

View File

@@ -37,6 +37,17 @@ This changelog follows [Keep a Changelog](https://keepachangelog.com/) principle
---
## [Unreleased] - 2026-06-05
### Fixed
- **Folder scan series key resolution**: Fixed "Could not resolve series key for folder, skipping" warnings during library setup. `_resolve_key_via_search()` now uses fuzzy title matching instead of exact string comparison.
- Added `_normalize_title()` to strip anime suffixes: `(TV)`, `(Anime)`, `(OAD)`, `(OVA)`, `(Special)`, `(Movie)`, `(Spin-Off)`
- Added `_titles_match()` using `difflib.SequenceMatcher` with 0.85 similarity threshold for tolerance of minor title variations
- Added debug logging for title mismatches and multiple search results
---
## [1.3.1] - 2026-02-22
### Added

View File

@@ -73,40 +73,31 @@ from src.server.models.download import DownloadItem, EpisodeIdentifier
class MockQueueRepository:
def __init__(self):
self._items: Dict[str, DownloadItem] = {}
async def save_item(self, item: DownloadItem) -> DownloadItem:
self._items[item.id] = item
return item
async def get_item(self, item_id: str) -> Optional[DownloadItem]:
return self._items.get(item_id)
async def get_all_items(self) -> List[DownloadItem]:
return list(self._items.values())
async def set_error(self, item_id: str, error: str) -> bool:
if item_id in self._items:
self._items[item_id].error = error
return True
return False
async def delete_item(self, item_id: str) -> bool:
if item_id in self._items:
del self._items[item_id]
return True
return False
async def clear_all(self) -> int:
count = len(self._items)
self._items.clear()
return count
```
**Key points:**
- The mock uses in-memory storage, no database required
- All async methods are implemented (even if just pass-through)
- `save_item` uses `item.id` as key (must be set before calling)
- Suitable for unit tests only (no persistence)
### Testing SetupService
SetupService handles series key resolution from folder names during library setup. Test file: `tests/unit/test_setup_service.py`.
Key methods tested:
- `_extract_year_from_folder_name()` — parses `(YYYY)` suffix
- `_extract_title_from_folder_name()` — strips year suffix
- `_resolve_key_via_search()` — resolves provider key via fuzzy title matching
```python
@pytest.mark.asyncio
async def test_returns_key_when_single_exact_match(self):
"""Search returns 1 result with same name → returns key."""
mock_series_app = AsyncMock()
mock_series_app.search.return_value = [
{'title': 'Attack on Titan', 'link': '/anime/stream/attack-on-titan'}
]
with patch('src.server.services.setup_service.get_series_app', return_value=mock_series_app):
result = await SetupService._resolve_key_via_search("Attack on Titan")
assert result == 'attack-on-titan'
```
### Mocking aiohttp Sessions

View File

@@ -107,6 +107,10 @@ The application now features a comprehensive configuration system that allows us
- **Progress Tracking**: Live progress updates for downloads and scans
- **System Notifications**: Real-time system messages and alerts
## Folder Management
- **Fuzzy Series Key Resolution**: Automatic series key resolution from folder names using fuzzy title matching — tolerates title variations like `(TV)`, `(OVA)`, `(Movie)` suffixes and uses similarity matching to resolve provider keys during library setup
## Core Functionality Overview
The web application provides a complete interface for managing anime downloads with user-friendly pages for configuration, library management, search capabilities, and download monitoring. All operations are tracked in real-time with comprehensive progress reporting and error handling.

View File

@@ -1,6 +1,6 @@
{
"name": "aniworld-web",
"version": "1.4.1",
"version": "1.4.2",
"description": "Aniworld Anime Download Manager - Web Frontend",
"type": "module",
"scripts": {

View File

@@ -0,0 +1,313 @@
"""API endpoints for setup and unresolved folder management.
Provides endpoints to:
- List unresolved folders that couldn't be auto-resolved during setup
- Get suggestions/search results for an unresolved folder
- Resolve an unresolved folder by providing a provider key
"""
import json
import logging
from typing import Any, Optional
from fastapi import APIRouter, Depends, HTTPException, status
from pydantic import BaseModel, Field
from src.server.database.connection import get_db_session
from src.server.database.service import AnimeSeriesService, UnresolvedFolderService
from src.server.utils.dependencies import (
get_database_session,
get_series_app,
require_auth,
)
logger = logging.getLogger(__name__)
router = APIRouter(prefix="/api/setup", tags=["setup"])
class UnresolvedFolderResponse(BaseModel):
"""Response model for an unresolved folder."""
folder_name: str = Field(..., description="Original filesystem folder name")
title: str = Field(..., description="Extracted title from folder name")
year: Optional[int] = Field(None, description="Extracted release year")
search_attempts: int = Field(..., description="Number of search attempts made")
search_suggestions: list[dict[str, Any]] = Field(
default_factory=list,
description="Cached search results for potential matches"
)
class Config:
from_attributes = True
class ResolveFolderRequest(BaseModel):
"""Request model for resolving an unresolved folder."""
provider_key: str = Field(
...,
min_length=1,
max_length=255,
description="Provider key to associate with this folder"
)
class ResolveFolderResponse(BaseModel):
"""Response model for resolving an unresolved folder."""
status: str = Field(..., description="Operation status")
message: str = Field(..., description="Human-readable message")
folder_name: str = Field(..., description="Folder name that was resolved")
key: str = Field(..., description="Provider key that was used")
series_id: int = Field(..., description="Database ID of the created series")
@router.get("/unresolved", response_model=list[UnresolvedFolderResponse])
async def list_unresolved_folders(
db=Depends(get_database_session),
) -> list[UnresolvedFolderResponse]:
"""List all unresolved folders that need manual key resolution.
Returns folders that couldn't be auto-resolved during setup,
including cached search suggestions when available.
Returns:
List of UnresolvedFolderResponse objects
"""
folders = await UnresolvedFolderService.get_all_unresolved(db)
result = []
for folder in folders:
suggestions = []
if folder.last_search_result:
try:
suggestions = json.loads(folder.last_search_result)
except json.JSONDecodeError:
logger.warning(
"Failed to parse search result for folder: %s",
folder.folder_name
)
result.append(UnresolvedFolderResponse(
folder_name=folder.folder_name,
title=folder.title,
year=folder.year,
search_attempts=folder.search_attempts,
search_suggestions=suggestions,
))
return result
@router.get("/unresolved/{folder_name}", response_model=UnresolvedFolderResponse)
async def get_unresolved_folder(
folder_name: str,
db=Depends(get_database_session),
) -> UnresolvedFolderResponse:
"""Get details for a specific unresolved folder.
Args:
folder_name: URL-encoded folder name to look up
Returns:
UnresolvedFolderResponse for the specified folder
Raises:
HTTPException: 404 if folder not found or already resolved
"""
folder = await UnresolvedFolderService.get_by_folder_name(db, folder_name)
if not folder:
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail=f"Unresolved folder not found: {folder_name}"
)
if folder.is_resolved:
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail=f"Folder already resolved: {folder_name}"
)
suggestions = []
if folder.last_search_result:
try:
suggestions = json.loads(folder.last_search_result)
except json.JSONDecodeError:
pass
return UnresolvedFolderResponse(
folder_name=folder.folder_name,
title=folder.title,
year=folder.year,
search_attempts=folder.search_attempts,
search_suggestions=suggestions,
)
@router.post("/unresolved/{folder_name}/resolve", response_model=ResolveFolderResponse)
async def resolve_unresolved_folder(
folder_name: str,
request: ResolveFolderRequest,
db=Depends(get_database_session),
) -> ResolveFolderResponse:
"""Resolve an unresolved folder by providing the correct provider key.
This endpoint:
1. Validates the provider key format
2. Updates the UnresolvedFolder record as resolved
3. Creates the AnimeSeries record in the database
4. Returns the created series information
Args:
folder_name: URL-encoded folder name to resolve
request: ResolveFolderRequest with the provider_key
Returns:
ResolveFolderResponse with created series details
Raises:
HTTPException: 404 if folder not found
HTTPException: 400 if key is invalid or series already exists
"""
# Check if folder exists and is unresolved
unresolved = await UnresolvedFolderService.get_by_folder_name(db, folder_name)
if not unresolved:
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail=f"Unresolved folder not found: {folder_name}"
)
if unresolved.is_resolved:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=f"Folder already resolved: {folder_name}"
)
# Check if a series with this key already exists
existing_series = await AnimeSeriesService.get_by_key(db, request.provider_key)
if existing_series:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=f"Series with key '{request.provider_key}' already exists"
)
# Mark as resolved
await UnresolvedFolderService.resolve(db, folder_name, request.provider_key)
# Create the AnimeSeries record
series = await AnimeSeriesService.create(
db=db,
key=request.provider_key,
name=unresolved.title,
site="https://aniworld.to",
folder=folder_name,
year=unresolved.year,
loading_status="pending",
episodes_loaded=False,
logo_loaded=False,
images_loaded=False,
)
logger.info(
"Resolved unresolved folder via API: %s -> key=%s (series_id=%d)",
folder_name, request.provider_key, series.id
)
return ResolveFolderResponse(
status="success",
message=f"Successfully resolved and added series: {unresolved.title}",
folder_name=folder_name,
key=request.provider_key,
series_id=series.id,
)
@router.post("/unresolved/{folder_name}/search", response_model=UnresolvedFolderResponse)
async def search_unresolved_folder(
folder_name: str,
db=Depends(get_database_session),
) -> UnresolvedFolderResponse:
"""Re-search for a specific unresolved folder to get fresh suggestions.
Performs a new search using the folder's title and caches the results.
Args:
folder_name: URL-encoded folder name to search for
Returns:
UnresolvedFolderResponse with updated search suggestions
Raises:
HTTPException: 404 if folder not found or already resolved
"""
from pathlib import Path
folder = await UnresolvedFolderService.get_by_folder_name(db, folder_name)
if not folder:
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail=f"Unresolved folder not found: {folder_name}"
)
if folder.is_resolved:
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail=f"Folder already resolved: {folder_name}"
)
# Perform search
series_app = get_series_app()
try:
results = await series_app.search(folder.title)
search_result_json = json.dumps(results) if results else "[]"
except Exception as e:
logger.warning(
"Search failed for unresolved folder: %s, error: %s",
folder_name, str(e)
)
search_result_json = "[]"
results = []
# Update the folder with new search results
await UnresolvedFolderService.update_search_result(db, folder_name, search_result_json)
return UnresolvedFolderResponse(
folder_name=folder.folder_name,
title=folder.title,
year=folder.year,
search_attempts=folder.search_attempts,
search_suggestions=results,
)
@router.delete("/unresolved/{folder_name}")
async def delete_unresolved_folder(
folder_name: str,
db=Depends(get_database_session),
) -> dict[str, str]:
"""Delete an unresolved folder tracking record.
Use this when you've manually added the series outside of this flow
(e.g., via POST /api/anime/add) to clean up the unresolved tracker.
Args:
folder_name: URL-encoded folder name to delete
Returns:
Dict with status message
Raises:
HTTPException: 404 if folder not found
"""
deleted = await UnresolvedFolderService.delete(db, folder_name)
if not deleted:
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail=f"Unresolved folder not found: {folder_name}"
)
return {"status": "success", "message": f"Deleted unresolved folder: {folder_name}"}

View File

@@ -626,6 +626,96 @@ class UserSession(Base, TimestampMixin):
self.is_active = False
class UnresolvedFolder(Base, TimestampMixin):
"""SQLAlchemy model for folders that couldn't be resolved during setup.
Tracks anime folders whose provider key couldn't be auto-resolved
during the initial setup scan. Users can provide the correct key
via the API to complete the series registration.
Attributes:
id: Primary key
folder_name: Original filesystem folder name
title: Extracted title from folder name
year: Extracted release year (optional)
provider_key: User-provided provider key to resolve this folder
search_attempts: Number of auto-search attempts made
last_search_result: Cached search results (JSON string) for UI suggestions
resolved_at: Timestamp when provider_key was provided
created_at: Creation timestamp (from TimestampMixin)
updated_at: Last update timestamp (from TimestampMixin)
"""
__tablename__ = "unresolved_folders"
# Primary key
id: Mapped[int] = mapped_column(
Integer, primary_key=True, autoincrement=True
)
# Folder metadata
folder_name: Mapped[str] = mapped_column(
String(1000), unique=True, nullable=False, index=True,
doc="Original filesystem folder name"
)
title: Mapped[str] = mapped_column(
String(500), nullable=False,
doc="Extracted title from folder name"
)
year: Mapped[Optional[int]] = mapped_column(
Integer, nullable=True,
doc="Extracted release year"
)
# Resolution data
provider_key: Mapped[Optional[str]] = mapped_column(
String(255), nullable=True,
doc="User-provided provider key to resolve this folder"
)
search_attempts: Mapped[int] = mapped_column(
Integer, nullable=False, default=0, server_default="0",
doc="Number of auto-search attempts made"
)
last_search_result: Mapped[Optional[str]] = mapped_column(
Text, nullable=True,
doc="Cached search results (JSON) for UI display"
)
resolved_at: Mapped[Optional[datetime]] = mapped_column(
DateTime(timezone=True), nullable=True,
doc="Timestamp when this folder was resolved"
)
@validates('folder_name')
def validate_folder_name(self, key: str, value: str) -> str:
"""Validate folder name is not empty."""
if not value or not value.strip():
raise ValueError("Folder name cannot be empty")
if len(value) > 1000:
raise ValueError("Folder name must be 1000 characters or less")
return value.strip()
@validates('title')
def validate_title(self, key: str, value: str) -> str:
"""Validate title is not empty."""
if not value or not value.strip():
raise ValueError("Title cannot be empty")
if len(value) > 500:
raise ValueError("Title must be 500 characters or less")
return value.strip()
@property
def is_resolved(self) -> bool:
"""Check if this folder has been resolved with a provider key."""
return self.provider_key is not None and self.resolved_at is not None
def __repr__(self) -> str:
return (
f"<UnresolvedFolder(id={self.id}, "
f"folder_name='{self.folder_name}', "
f"title='{self.title}', "
f"resolved={self.is_resolved})>"
)
class SystemSettings(Base, TimestampMixin):
"""SQLAlchemy model for system-wide settings and state.

View File

@@ -34,6 +34,7 @@ from src.server.database.models import (
AnimeSeries,
DownloadQueueItem,
Episode,
UnresolvedFolder,
UserSession,
)
@@ -1364,3 +1365,176 @@ class UserSessionService:
return new_session
# ============================================================================
# Unresolved Folder Service
# ============================================================================
class UnresolvedFolderService:
"""Service for tracking and resolving folders that couldn't be auto-resolved.
During initial setup, some folders may not resolve to a provider key
(no search match or multiple ambiguous matches). These are tracked as
UnresolvedFolder records and can later be resolved by the user providing
the correct provider key.
"""
@staticmethod
async def create(
db: AsyncSession,
folder_name: str,
title: str,
year: int | None = None,
search_attempts: int = 1,
last_search_result: str | None = None,
) -> UnresolvedFolder:
"""Create a new unresolved folder tracking record.
Args:
db: Database session
folder_name: Original filesystem folder name
title: Extracted title from folder name
year: Extracted release year (optional)
search_attempts: Number of search attempts made (default: 1)
last_search_result: JSON string of search results for UI (optional)
Returns:
Created UnresolvedFolder instance
"""
folder = UnresolvedFolder(
folder_name=folder_name,
title=title,
year=year,
search_attempts=search_attempts,
last_search_result=last_search_result,
)
db.add(folder)
await db.flush()
await db.refresh(folder)
logger.info(
"Created unresolved folder tracking: %s (title=%s, year=%s)",
folder_name, title, year
)
return folder
@staticmethod
async def get_by_folder_name(
db: AsyncSession,
folder_name: str,
) -> Optional[UnresolvedFolder]:
"""Get unresolved folder by folder name.
Args:
db: Database session
folder_name: Filesystem folder name to look up
Returns:
UnresolvedFolder instance or None if not found
"""
result = await db.execute(
select(UnresolvedFolder).where(
UnresolvedFolder.folder_name == folder_name
)
)
return result.scalar_one_or_none()
@staticmethod
async def get_all_unresolved(
db: AsyncSession,
) -> list[UnresolvedFolder]:
"""Get all unresolved folders that haven't been resolved yet.
Args:
db: Database session
Returns:
List of unresolved UnresolvedFolder instances
"""
result = await db.execute(
select(UnresolvedFolder)
.where(UnresolvedFolder.provider_key.is_(None))
.order_by(UnresolvedFolder.created_at)
)
return list(result.scalars().all())
@staticmethod
async def resolve(
db: AsyncSession,
folder_name: str,
provider_key: str,
) -> Optional[UnresolvedFolder]:
"""Mark an unresolved folder as resolved with the given provider key.
Args:
db: Database session
folder_name: Filesystem folder name to resolve
provider_key: Provider key to associate with this folder
Returns:
Updated UnresolvedFolder instance or None if not found
"""
from datetime import datetime, timezone
folder = await UnresolvedFolderService.get_by_folder_name(db, folder_name)
if not folder:
return None
folder.provider_key = provider_key
folder.resolved_at = datetime.now(timezone.utc)
await db.flush()
await db.refresh(folder)
logger.info(
"Resolved unresolved folder: %s -> key=%s",
folder_name, provider_key
)
return folder
@staticmethod
async def delete(
db: AsyncSession,
folder_name: str,
) -> bool:
"""Delete an unresolved folder record (e.g., after manual add).
Args:
db: Database session
folder_name: Filesystem folder name to delete
Returns:
True if deleted, False if not found
"""
folder = await UnresolvedFolderService.get_by_folder_name(db, folder_name)
if not folder:
return False
await db.delete(folder)
await db.flush()
return True
@staticmethod
async def update_search_result(
db: AsyncSession,
folder_name: str,
search_result: str,
) -> Optional[UnresolvedFolder]:
"""Update the cached search result for an unresolved folder.
Args:
db: Database session
folder_name: Filesystem folder name to update
search_result: JSON string of search results
Returns:
Updated UnresolvedFolder instance or None if not found
"""
folder = await UnresolvedFolderService.get_by_folder_name(db, folder_name)
if not folder:
return None
folder.search_attempts += 1
folder.last_search_result = search_result
await db.flush()
await db.refresh(folder)
return folder

View File

@@ -27,6 +27,7 @@ from src.server.api.health import router as health_router
from src.server.api.logging import router as logging_router
from src.server.api.nfo import router as nfo_router
from src.server.api.scheduler import router as scheduler_router
from src.server.api.setup_endpoints import router as setup_router
from src.server.api.websocket import router as websocket_router
from src.server.controllers.error_controller import (
not_found_handler,
@@ -648,6 +649,7 @@ app.include_router(scheduler_router)
app.include_router(anime_router)
app.include_router(download_router)
app.include_router(nfo_router)
app.include_router(setup_router)
app.include_router(logging_router)
app.include_router(websocket_router)

View File

@@ -20,7 +20,7 @@ import structlog
from src.config.settings import settings
from src.server.database.connection import get_db_session
from src.server.database.service import AnimeSeriesService
from src.server.database.service import AnimeSeriesService, UnresolvedFolderService
from src.server.utils.dependencies import get_series_app
logger = structlog.get_logger(__name__)
@@ -74,6 +74,61 @@ class SetupService:
"""
return re.sub(r'\s*\(\d{4}\)\s*$', '', folder_name).strip()
@staticmethod
def _normalize_title(title: str) -> str:
"""Normalize title for fuzzy matching.
Strips common suffixes and lowercases for comparison.
Args:
title: The title to normalize
Returns:
Normalized title string
"""
# Remove common anime suffixes (case-insensitive)
suffixes = [
r'\s*\(TV\)\s*$',
r'\s*\(Anime\)\s*$',
r'\s*\(OAD\)\s*$',
r'\s*\(OVA\)\s*$',
r'\s*\(Special\)\s*$',
r'\s*\(Movie\)\s*$',
r'\s*\(Spin-Off\)\s*$',
]
normalized = title.lower().strip()
for suffix_pattern in suffixes:
normalized = re.sub(suffix_pattern, '', normalized, flags=re.IGNORECASE).strip()
return normalized
@staticmethod
def _titles_match(title1: str, title2: str, threshold: float = 0.85) -> bool:
"""Check if two titles match using fuzzy comparison.
Args:
title1: First title
title2: Second title
threshold: Similarity threshold (0.0 to 1.0)
Returns:
True if titles match within threshold
"""
norm1 = SetupService._normalize_title(title1)
norm2 = SetupService._normalize_title(title2)
# Direct match after normalization
if norm1 == norm2:
return True
# Containment check (e.g., "Attack on Titan" in "Attack on Titan (TV)")
if norm1 in norm2 or norm2 in norm1:
return True
# Similarity ratio check using SequenceMatcher
from difflib import SequenceMatcher
ratio = SequenceMatcher(None, norm1, norm2).ratio()
return ratio >= threshold
@staticmethod
async def _resolve_key_via_search(title: str) -> str:
"""Resolve provider key by searching for the title.
@@ -93,11 +148,32 @@ class SetupService:
results = await series_app.search(title)
if len(results) == 1:
result_name = results[0].get('title', '').lower()
if result_name == title.lower():
link = results[0].get('link', '')
if link and '/anime/stream/' in link:
return link.split('/anime/stream/')[-1].split('/')[0]
result_name = results[0].get('title', '')
result_link = results[0].get('link', '')
if SetupService._titles_match(result_name, title):
if result_link and '/anime/stream/' in result_link:
return result_link.split('/anime/stream/')[-1].split('/')[0]
else:
logger.debug(
"Series key resolved but link format unexpected",
folder_title=title,
result_title=result_name,
link=result_link
)
else:
logger.debug(
"Series search result title mismatch",
folder_title=title,
result_title=result_name,
link=result_link
)
elif len(results) > 1:
logger.debug(
"Multiple search results for title, skipping fuzzy match",
title=title,
result_count=len(results)
)
except Exception as e:
logger.warning(
"Provider search failed for folder",
@@ -205,6 +281,7 @@ class SetupService:
created_count = 0
skipped_existing = 0
unresolved_count = 0
try:
series_app = get_series_app()
@@ -224,6 +301,43 @@ class SetupService:
skipped_existing += 1
continue
# Check if already tracked as unresolved
existing_unresolved = await UnresolvedFolderService.get_by_folder_name(
db, folder_name
)
if existing_unresolved and existing_unresolved.is_resolved:
# Was previously unresolved but now resolved - create the series
resolved_key = existing_unresolved.provider_key
year = cls._extract_year_from_folder_name(folder_name)
title = cls._extract_title_from_folder_name(folder_name)
props = cls._get_series_properties(folder)
series = await AnimeSeriesService.create(
db=db,
key=resolved_key,
name=title,
site="https://aniworld.to",
folder=folder_name,
year=year,
loading_status="completed",
episodes_loaded=True,
logo_loaded=props.logo_loaded,
images_loaded=props.images_loaded,
has_nfo=props.has_nfo,
nfo_path=props.nfo_path,
nfo_created_at=props.nfo_created_at,
nfo_updated_at=props.nfo_updated_at,
)
created_count += 1
# Delete the unresolved tracking now that series is created
await UnresolvedFolderService.delete(db, folder_name)
continue
elif existing_unresolved:
# Already tracked as unresolved, skip
unresolved_count += 1
continue
# Extract title and year from folder name
year = cls._extract_year_from_folder_name(folder_name)
title = cls._extract_title_from_folder_name(folder_name)
@@ -239,8 +353,24 @@ class SetupService:
resolved_key = await cls._resolve_key_via_search(title)
if not resolved_key:
# Track unresolved folder for later manual resolution
import json
try:
series_results = await series_app.search(title)
search_result_json = json.dumps(series_results) if series_results else None
except Exception:
search_result_json = None
await UnresolvedFolderService.create(
db=db,
folder_name=folder_name,
title=title,
year=year,
search_attempts=1,
last_search_result=search_result_json,
)
logger.warning(
"Could not resolve series key for folder, skipping: %s",
"Could not resolve series key for folder, tracking as unresolved: %s",
folder_name
)
continue
@@ -281,7 +411,8 @@ class SetupService:
logger.info(
"Setup complete",
created=created_count,
skipped_existing=skipped_existing
skipped_existing=skipped_existing,
unresolved=unresolved_count
)
except Exception as e:

View File

@@ -153,14 +153,15 @@ class TestSetupServiceRun:
@pytest.mark.asyncio
async def test_creates_series_for_new_folders(self, tmp_path):
"""Folders without DB entries → creates AnimeSeries records."""
"""Folders without DB entries and single search match → creates AnimeSeries records.
Note: This test verifies the logic flow when search returns a single match.
The actual search call goes through SeriesApp which uses run_in_executor,
so we test the flow with a resolved key being passed through.
"""
anime_dir = tmp_path / "anime"
anime_dir.mkdir()
(anime_dir / "Attack on Titan (2013)").mkdir()
(anime_dir / "OnePiece").mkdir()
mock_series_app = AsyncMock()
mock_series_app.search.return_value = []
mock_db = AsyncMock()
mock_get_db = MagicMock()
@@ -170,10 +171,6 @@ class TestSetupServiceRun:
with patch(
'src.server.services.setup_service.settings'
) as mock_settings, \
patch(
'src.server.services.setup_service.get_series_app',
return_value=mock_series_app
), \
patch(
'src.server.services.setup_service.get_db_session',
return_value=mock_get_db
@@ -182,16 +179,28 @@ class TestSetupServiceRun:
'src.server.services.setup_service.AnimeSeriesService.get_by_folder',
new_callable=AsyncMock, return_value=None
), \
patch(
'src.server.services.setup_service.UnresolvedFolderService.get_by_folder_name',
new_callable=AsyncMock, return_value=None
), \
patch(
'src.server.services.setup_service.AnimeSeriesService.create',
new_callable=AsyncMock
) as mock_create:
mock_settings.anime_directory = str(anime_dir)
# Directly test the flow by patching _resolve_key_via_search
# to return a key (simulating successful search)
with patch.object(
SetupService, '_resolve_key_via_search',
new_callable=AsyncMock, return_value='attack-on-titan'
):
result = await SetupService.run()
result = await SetupService.run()
assert result == 2
assert mock_create.call_count == 2
assert result == 1
mock_create.assert_called_once()
call_kwargs = mock_create.call_args.kwargs
assert call_kwargs['key'] == 'attack-on-titan'
@pytest.mark.asyncio
async def test_skips_existing_folders(self, tmp_path):
@@ -236,16 +245,15 @@ class TestSetupServiceRun:
@pytest.mark.asyncio
async def test_resolves_key_for_single_match(self, tmp_path):
"""Single search match with same name → uses that key."""
"""Single search match with same name → uses that key.
This tests that when _resolve_key_via_search returns a key,
the series is created with that key.
"""
anime_dir = tmp_path / "anime"
anime_dir.mkdir()
(anime_dir / "Attack on Titan (2013)").mkdir()
mock_series_app = AsyncMock()
mock_series_app.search.return_value = [
{'title': 'Attack on Titan', 'link': '/anime/stream/attack-on-titan'}
]
mock_db = AsyncMock()
mock_get_db = MagicMock()
mock_get_db.__aenter__.return_value = mock_db
@@ -254,10 +262,6 @@ class TestSetupServiceRun:
with patch(
'src.server.services.setup_service.settings'
) as mock_settings, \
patch(
'src.server.services.setup_service.get_series_app',
return_value=mock_series_app
), \
patch(
'src.server.services.setup_service.get_db_session',
return_value=mock_get_db
@@ -266,13 +270,22 @@ class TestSetupServiceRun:
'src.server.services.setup_service.AnimeSeriesService.get_by_folder',
new_callable=AsyncMock, return_value=None
), \
patch(
'src.server.services.setup_service.UnresolvedFolderService.get_by_folder_name',
new_callable=AsyncMock, return_value=None
), \
patch(
'src.server.services.setup_service.AnimeSeriesService.create',
new_callable=AsyncMock
) as mock_create:
mock_settings.anime_directory = str(anime_dir)
await SetupService.run()
# Simulate successful search returning a key
with patch.object(
SetupService, '_resolve_key_via_search',
new_callable=AsyncMock, return_value='attack-on-titan'
):
await SetupService.run()
# Verify create was called with resolved key
call_kwargs = mock_create.call_args.kwargs
@@ -281,8 +294,8 @@ class TestSetupServiceRun:
assert call_kwargs['year'] == 2013
@pytest.mark.asyncio
async def test_empty_key_for_no_match(self, tmp_path):
"""No search match → empty key."""
async def test_tracks_unresolved_when_no_match(self, tmp_path):
"""No search match → tracks folder as unresolved, doesn't create series."""
anime_dir = tmp_path / "anime"
anime_dir.mkdir()
(anime_dir / "Unknown Series (2020)").mkdir()
@@ -311,16 +324,24 @@ class TestSetupServiceRun:
new_callable=AsyncMock, return_value=None
), \
patch(
'src.server.services.setup_service.AnimeSeriesService.create',
'src.server.services.setup_service.UnresolvedFolderService.get_by_folder_name',
new_callable=AsyncMock, return_value=None
), \
patch(
'src.server.services.setup_service.UnresolvedFolderService.create',
new_callable=AsyncMock
) as mock_create:
) as mock_create_unresolved:
mock_settings.anime_directory = str(anime_dir)
await SetupService.run()
result = await SetupService.run()
call_kwargs = mock_create.call_args.kwargs
assert call_kwargs['key'] == ''
assert call_kwargs['name'] == 'Unknown Series'
# Should return 0 since no series was created
assert result == 0
# Should track as unresolved instead of creating series
mock_create_unresolved.assert_called_once()
call_kwargs = mock_create_unresolved.call_args.kwargs
assert call_kwargs['folder_name'] == 'Unknown Series (2020)'
assert call_kwargs['title'] == 'Unknown Series'
assert call_kwargs['year'] == 2020
@pytest.mark.asyncio
@@ -381,15 +402,20 @@ class TestSetupServiceRun:
new_callable=AsyncMock, return_value=None
), \
patch(
'src.server.services.setup_service.AnimeSeriesService.create',
'src.server.services.setup_service.UnresolvedFolderService.get_by_folder_name',
new_callable=AsyncMock, return_value=None
), \
patch(
'src.server.services.setup_service.UnresolvedFolderService.create',
new_callable=AsyncMock
) as mock_create:
) as mock_create_unresolved:
mock_settings.anime_directory = str(anime_dir)
result = await SetupService.run()
assert result == 1
mock_create.assert_called_once()
# Empty search results → folder tracked as unresolved, not created
assert result == 0
mock_create_unresolved.assert_called_once()
class TestCheckNfoFile:

View File

@@ -0,0 +1,244 @@
"""Tests for UnresolvedFolderService and UnresolvedFolder model."""
from datetime import datetime, timezone
from unittest.mock import AsyncMock, MagicMock, patch
import pytest
from src.server.database.models import UnresolvedFolder
from src.server.database.service import UnresolvedFolderService
class TestUnresolvedFolderModel:
"""Test UnresolvedFolder model."""
def test_is_resolved_false_when_no_key(self):
"""provider_key is None → is_resolved is False."""
folder = UnresolvedFolder(
folder_name="Test (2020)",
title="Test",
year=2020,
provider_key=None,
resolved_at=None,
)
assert folder.is_resolved is False
def test_is_resolved_false_when_key_but_no_timestamp(self):
"""provider_key set but resolved_at is None → is_resolved is False."""
folder = UnresolvedFolder(
folder_name="Test (2020)",
title="Test",
year=2020,
provider_key="test-key",
resolved_at=None,
)
assert folder.is_resolved is False
def test_is_resolved_true_when_both_set(self):
"""Both provider_key and resolved_at set → is_resolved is True."""
folder = UnresolvedFolder(
folder_name="Test (2020)",
title="Test",
year=2020,
provider_key="test-key",
resolved_at=datetime.now(timezone.utc),
)
assert folder.is_resolved is True
def test_validate_folder_name_empty_raises(self):
"""Empty folder_name → raises ValueError during construction."""
with pytest.raises(ValueError, match="Folder name cannot be empty"):
UnresolvedFolder(
folder_name="",
title="Test",
)
def test_validate_folder_name_too_long_raises(self):
"""Folder name > 1000 chars → raises ValueError during construction."""
long_name = "x" * 1001
with pytest.raises(ValueError, match="Folder name must be 1000 characters"):
UnresolvedFolder(
folder_name=long_name,
title="Test",
)
def test_validate_title_empty_raises(self):
"""Empty title → raises ValueError during construction."""
with pytest.raises(ValueError, match="Title cannot be empty"):
UnresolvedFolder(
folder_name="Test (2020)",
title="",
)
class TestUnresolvedFolderService:
"""Test UnresolvedFolderService methods."""
@pytest.mark.asyncio
async def test_create(self):
"""Creates a new unresolved folder record."""
mock_db = AsyncMock()
mock_db.flush = AsyncMock()
mock_db.refresh = AsyncMock()
folder = await UnresolvedFolderService.create(
db=mock_db,
folder_name="Test (2020)",
title="Test",
year=2020,
search_attempts=1,
)
assert folder.folder_name == "Test (2020)"
assert folder.title == "Test"
assert folder.year == 2020
assert folder.search_attempts == 1
mock_db.add.assert_called_once()
mock_db.flush.assert_called_once()
@pytest.mark.asyncio
async def test_get_by_folder_name_found(self):
"""Found → returns UnresolvedFolder."""
mock_db = AsyncMock()
mock_result = MagicMock()
mock_result.scalar_one_or_none.return_value = UnresolvedFolder(
folder_name="Test (2020)",
title="Test",
year=2020,
)
mock_db.execute.return_value = mock_result
folder = await UnresolvedFolderService.get_by_folder_name(mock_db, "Test (2020)")
assert folder is not None
assert folder.folder_name == "Test (2020)"
@pytest.mark.asyncio
async def test_get_by_folder_name_not_found(self):
"""Not found → returns None."""
mock_db = AsyncMock()
mock_result = MagicMock()
mock_result.scalar_one_or_none.return_value = None
mock_db.execute.return_value = mock_result
folder = await UnresolvedFolderService.get_by_folder_name(mock_db, "Unknown")
assert folder is None
@pytest.mark.asyncio
async def test_get_all_unresolved(self):
"""Returns only unresolved folders (no provider_key)."""
mock_db = AsyncMock()
mock_result = MagicMock()
mock_result.scalars.return_value.all.return_value = [
UnresolvedFolder(folder_name="Folder1", title="Title1", year=2020),
UnresolvedFolder(folder_name="Folder2", title="Title2", year=2021),
]
mock_db.execute.return_value = mock_result
folders = await UnresolvedFolderService.get_all_unresolved(mock_db)
assert len(folders) == 2
mock_db.execute.assert_called_once()
@pytest.mark.asyncio
async def test_resolve(self):
"""Marks folder as resolved with provider_key."""
mock_db = AsyncMock()
mock_db.flush = AsyncMock()
mock_db.refresh = AsyncMock()
existing = UnresolvedFolder(
folder_name="Test (2020)",
title="Test",
year=2020,
provider_key=None,
resolved_at=None,
)
with patch.object(
UnresolvedFolderService, 'get_by_folder_name',
new_callable=AsyncMock, return_value=existing
):
result = await UnresolvedFolderService.resolve(
mock_db, "Test (2020)", "test-key"
)
assert result.provider_key == "test-key"
assert result.resolved_at is not None
mock_db.flush.assert_called_once()
@pytest.mark.asyncio
async def test_resolve_not_found(self):
"""Folder not found → returns None."""
mock_db = AsyncMock()
with patch.object(
UnresolvedFolderService, 'get_by_folder_name',
new_callable=AsyncMock, return_value=None
):
result = await UnresolvedFolderService.resolve(
mock_db, "Unknown", "test-key"
)
assert result is None
@pytest.mark.asyncio
async def test_delete(self):
"""Deletes unresolved folder record."""
mock_db = AsyncMock()
mock_db.flush = AsyncMock()
existing = UnresolvedFolder(
folder_name="Test (2020)",
title="Test",
year=2020,
)
with patch.object(
UnresolvedFolderService, 'get_by_folder_name',
new_callable=AsyncMock, return_value=existing
):
result = await UnresolvedFolderService.delete(mock_db, "Test (2020)")
assert result is True
mock_db.delete.assert_called_once_with(existing)
mock_db.flush.assert_called_once()
@pytest.mark.asyncio
async def test_delete_not_found(self):
"""Folder not found → returns False."""
mock_db = AsyncMock()
with patch.object(
UnresolvedFolderService, 'get_by_folder_name',
new_callable=AsyncMock, return_value=None
):
result = await UnresolvedFolderService.delete(mock_db, "Unknown")
assert result is False
@pytest.mark.asyncio
async def test_update_search_result(self):
"""Increments search_attempts and updates last_search_result."""
mock_db = AsyncMock()
mock_db.flush = AsyncMock()
mock_db.refresh = AsyncMock()
existing = UnresolvedFolder(
folder_name="Test (2020)",
title="Test",
year=2020,
search_attempts=1,
last_search_result=None,
)
with patch.object(
UnresolvedFolderService, 'get_by_folder_name',
new_callable=AsyncMock, return_value=existing
):
result = await UnresolvedFolderService.update_search_result(
mock_db, "Test (2020)", '[{"title": "Test"}]'
)
assert result.search_attempts == 2
assert result.last_search_result == '[{"title": "Test"}]'