Dymas/ani-cli-web
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Compare commits

base: Dymas/ani-cli-web:0257924785780e5c644186fadff663cc6e89b475
Branches Tags
Dymas/ani-cli-web:main Dymas/ani-cli-web:anipy_backup
...
compare: Dymas/ani-cli-web:ba408877b5831f82791b508d8f1ee251dc39a03d
Branches Tags
Dymas/ani-cli-web:main Dymas/ani-cli-web:anipy_backup
3 Commits
0257924785 ... ba408877b5
Author SHA1 Message Date
Dymas ba408877b5 Add website favicon support 2026-07-09 18:15:52 +02:00
Dymas 34c77ed9bb Reuse failed queue jobs for duplicate retries 2026-07-09 17:38:24 +02:00
Dymas 292bbedd6b Add clear failed queue action 
Add a Queue page bulk action and API route to remove all failed jobs, cover it with regression tests, and update the version, changelog, and README for the new queue workflow.
 2026-07-09 17:20:55 +02:00
11 changed files with 257 additions and 13 deletions
Expand all files Collapse all files
CHANGELOG.md
+12
View File
@@ -1,5 +1,17 @@
# Changelog # Changelog
## 0.48.2 - 2026-07-09
- Added support for a checked-in `favicon.png`, serving it from the app and wiring it into the website pages so browsers show the custom favicon.
## 0.48.1 - 2026-07-09
- Changed queue inserts so adding a download that exactly matches an existing failed job now reuses that failed entry and resets it to pending instead of creating another duplicate failed row.
## 0.48.0 - 2026-07-09
- Added a `Clear failed` bulk action to the Queue page so failed jobs can be removed without touching pending, running, finished, or canceled downloads.
## 0.47.1 - 2026-07-09 ## 0.47.1 - 2026-07-09
- Fixed `anipy-cli` fallback renaming for queued TV downloads so retried jobs now keep the requested episode numbers from the queue, avoiding cases like a retried `S02E11` being renamed as `S02E01`. - Fixed `anipy-cli` fallback renaming for queued TV downloads so retried jobs now keep the requested episode numbers from the queue, avoiding cases like a retried `S02E11` being renamed as `S02E01`.
README.md
+8 -2
View File
@@ -2,7 +2,7 @@
Local web UI for a system-wide `ani-cli` install. Local web UI for a system-wide `ani-cli` install.
Current version: `0.47.1` Current version: `0.48.2`
## What it does ## What it does
@@ -15,11 +15,12 @@ Current version: `0.47.1`
- Auto-download missing episodes for `Watching` entries after later refreshes, with a per-show `Source name` override for `ani-cli` search - Auto-download missing episodes for `Watching` entries after later refreshes, with a per-show `Source name` override for `ani-cli` search
- Move fully completed libraries into Jellyfin TV or movie folders with a tracked background handoff job - Move fully completed libraries into Jellyfin TV or movie folders with a tracked background handoff job
- Send optional Discord webhook notifications - Send optional Discord webhook notifications
- Serve a checked-in `favicon.png` as the site favicon
## Pages ## Pages
- `/`: Search and queue downloads, with poster-card search results below the selection box and alternate English titles under the main name when available - `/`: Search and queue downloads, with poster-card search results below the selection box and alternate English titles under the main name when available
- `/queue`: Monitor jobs, inspect logs, retry failed jobs, remove finished jobs - `/queue`: Monitor jobs, inspect logs, retry failed jobs, avoid duplicate re-queues for the same failed download, clear failed jobs, and remove finished jobs
- `/watchlist`: Track shows, refresh them, download all available episodes, and manage auto-download settings such as `Source name`, library `Name`, season, and episode offset - `/watchlist`: Track shows, refresh them, download all available episodes, and manage auto-download settings such as `Source name`, library `Name`, season, and episode offset
- `/config`: Save defaults, toggle `anipy-cli` fallback retries, schedule refreshes, configure Jellyfin and Discord, monitor Jellyfin handoff progress, and view runtime info and the changelog - `/config`: Save defaults, toggle `anipy-cli` fallback retries, schedule refreshes, configure Jellyfin and Discord, monitor Jellyfin handoff progress, and view runtime info and the changelog
@@ -119,6 +120,11 @@ Docker notes:
- Fallback retries keep the queued episode numbers when the downloaded `anipy-cli` filenames are renumbered from `1` - Fallback retries keep the queued episode numbers when the downloaded `anipy-cli` filenames are renumbered from `1`
- Docker images install `anipy-cli` automatically; non-Docker installs should provide it in `PATH` themselves - Docker images install `anipy-cli` automatically; non-Docker installs should provide it in `PATH` themselves
### Queue retries
- Adding a download that exactly matches an existing failed queue job reuses that failed entry and sets it back to `pending`
- This avoids stacking multiple failed rows for the same episode when you queue the same job again
### Jellyfin handoff ### Jellyfin handoff
- Optional and configured from `/config` - Optional and configured from `/config`
VERSION
+1 -1
View File
@@ -1 +1 @@
0.47.1 0.48.2
config_page.py
+1
View File
@@ -21,6 +21,7 @@ CONFIG_HTML = r"""<!doctype html>
<meta charset="utf-8"> <meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<title>ani-cli web - config</title> <title>ani-cli web - config</title>
<link rel="icon" type="image/png" sizes="32x32" href="/favicon.png">
<style> <style>
:root { :root {
color-scheme: dark; color-scheme: dark;
favicon.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.3 KiB

http_handler.py
+12
View File
@@ -27,6 +27,7 @@ from app_support import (
CLIENT_DISCONNECT_ERRORS, CLIENT_DISCONNECT_ERRORS,
MAX_JSON_BODY_BYTES, MAX_JSON_BODY_BYTES,
MODE_CHOICES, MODE_CHOICES,
PROJECT_ROOT,
VERSION, VERSION,
client_address_is_local, client_address_is_local,
configured_remote_path_roots, configured_remote_path_roots,
@@ -46,6 +47,8 @@ from app_support import (
validate_discord_webhook_url, validate_discord_webhook_url,
) )
FAVICON_PATH = PROJECT_ROOT / "favicon.png"
@dataclass(frozen=True) @dataclass(frozen=True)
class HandlerContext: class HandlerContext:
add_to_watchlist: object add_to_watchlist: object
@@ -382,6 +385,7 @@ class Handler(BaseHTTPRequestHandler):
<meta charset="utf-8"> <meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<title>{APP_NAME} sign in</title> <title>{APP_NAME} sign in</title>
<link rel="icon" type="image/png" sizes="32x32" href="/favicon.png">
<style> <style>
:root {{ :root {{
color-scheme: dark; color-scheme: dark;
@@ -545,6 +549,11 @@ class Handler(BaseHTTPRequestHandler):
self.ensure_client_access() self.ensure_client_access()
if parsed.path == "/": if parsed.path == "/":
self.html(Handler._context(self).index_html) self.html(Handler._context(self).index_html)
elif parsed.path in {"/favicon.png", "/favicon.ico"}:
if not FAVICON_PATH.exists():
self.error(HTTPStatus.NOT_FOUND, "Favicon not found")
return
self.file(FAVICON_PATH)
elif parsed.path == "/queue": elif parsed.path == "/queue":
self.html(Handler._context(self).queue_html) self.html(Handler._context(self).queue_html)
elif parsed.path == "/config": elif parsed.path == "/config":
@@ -704,6 +713,9 @@ class Handler(BaseHTTPRequestHandler):
elif parsed.path == "/api/queue/clear-finished": elif parsed.path == "/api/queue/clear-finished":
runtime = Handler._runtime(self) runtime = Handler._runtime(self)
self.json(runtime["download_queue"].clear_finished()) self.json(runtime["download_queue"].clear_finished())
elif parsed.path == "/api/queue/clear-failed":
runtime = Handler._runtime(self)
self.json(runtime["download_queue"].clear_failed())
elif parsed.path.startswith("/api/queue/"): elif parsed.path.startswith("/api/queue/"):
runtime = Handler._runtime(self) runtime = Handler._runtime(self)
parts = parsed.path.strip("/").split("/") parts = parsed.path.strip("/").split("/")
queue_jobs.py
+55 -9
View File
@@ -1136,6 +1136,51 @@ class DownloadQueue:
with self.lock: with self.lock:
return self._find(job_id) return self._find(job_id)
def _job_identity_fields(self, job):
return (
str(job.get("show_id") or "").strip(),
str(job.get("title") or "").strip(),
str(job.get("anime_name") or "").strip(),
str(job.get("media_type") or "").strip(),
str(job.get("season") or "").strip(),
str(job.get("episode_offset") or "").strip(),
str(job.get("query") or "").strip(),
job.get("result_index"),
str(job.get("mode") or "").strip().lower(),
str(job.get("quality") or "").strip().lower(),
str(job.get("episodes") or "").strip(),
str(job.get("download_dir") or "").strip(),
)
def _find_reusable_failed_job_locked(self, job):
expected = self._job_identity_fields(job)
with self._connect() as conn:
rows = conn.execute(
"""
SELECT *
FROM jobs
WHERE status = 'failed'
ORDER BY created_at DESC
"""
).fetchall()
for row in rows:
candidate = self._job_from_row(row)
if self._job_identity_fields(candidate) == expected:
return candidate
return None
def _reset_retryable_job_locked(self, job):
job["status"] = "pending"
job["exit_code"] = None
job["pid"] = None
job["started_at"] = None
job["finished_at"] = None
job["updated_at"] = now_iso()
job["cancel_requested"] = False
job["log"] = []
self._save_job_locked(job)
return job
def add(self, payload): def add(self, payload):
job = build_job(payload, self.config_getter()) job = build_job(payload, self.config_getter())
if self.job_prepare_fn is not None: if self.job_prepare_fn is not None:
@@ -1143,6 +1188,10 @@ class DownloadQueue:
if prepared is not None: if prepared is not None:
job = prepared job = prepared
with self.lock: with self.lock:
reusable = self._find_reusable_failed_job_locked(job)
if reusable is not None:
job = self._reset_retryable_job_locked(reusable)
else:
self._save_job_locked(job) self._save_job_locked(job)
self.wakeup.set() self.wakeup.set()
return job return job
@@ -1221,15 +1270,7 @@ class DownloadQueue:
raise ValueError("Running jobs cannot be retried") raise ValueError("Running jobs cannot be retried")
if job["status"] not in {"failed", "canceled"}: if job["status"] not in {"failed", "canceled"}:
raise ValueError("Only failed or canceled jobs can be retried") raise ValueError("Only failed or canceled jobs can be retried")
job["status"] = "pending" job = self._reset_retryable_job_locked(job)
job["exit_code"] = None
job["pid"] = None
job["started_at"] = None
job["finished_at"] = None
job["updated_at"] = now_iso()
job["cancel_requested"] = False
job["log"] = []
self._save_job_locked(job)
self.wakeup.set() self.wakeup.set()
return job return job
@@ -1291,6 +1332,11 @@ class DownloadQueue:
cursor = conn.execute("DELETE FROM jobs WHERE status IN ('done', 'canceled')") cursor = conn.execute("DELETE FROM jobs WHERE status IN ('done', 'canceled')")
return {"ok": True, "count": cursor.rowcount} return {"ok": True, "count": cursor.rowcount}
def clear_failed(self):
with self.lock, self._connect() as conn:
cursor = conn.execute("DELETE FROM jobs WHERE status = 'failed'")
return {"ok": True, "count": cursor.rowcount}
def _find(self, job_id): def _find(self, job_id):
with self._connect() as conn: with self._connect() as conn:
row = conn.execute("SELECT * FROM jobs WHERE id = ?", (job_id,)).fetchone() row = conn.execute("SELECT * FROM jobs WHERE id = ?", (job_id,)).fetchone()
queue_page.py
+3
View File
@@ -11,6 +11,7 @@ QUEUE_HTML = r"""<!doctype html>
<meta charset="utf-8"> <meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<title>ani-cli web queue</title> <title>ani-cli web queue</title>
<link rel="icon" type="image/png" sizes="32x32" href="/favicon.png">
<style> <style>
:root { :root {
color-scheme: dark; color-scheme: dark;
@@ -317,6 +318,7 @@ QUEUE_HTML = r"""<!doctype html>
<p class="muted">Monitor active downloads, inspect recent output, and clean up finished jobs without leaving the queue view.</p> <p class="muted">Monitor active downloads, inspect recent output, and clean up finished jobs without leaving the queue view.</p>
<div class="row"> <div class="row">
<button class="ghost" id="retryFailedBtn" type="button">Retry failed</button> <button class="ghost" id="retryFailedBtn" type="button">Retry failed</button>
<button class="ghost" id="clearFailedBtn" type="button">Clear failed</button>
<button class="ghost" id="removeFinishedBtn" type="button">Remove finished</button> <button class="ghost" id="removeFinishedBtn" type="button">Remove finished</button>
</div> </div>
</section> </section>
@@ -548,6 +550,7 @@ QUEUE_HTML = r"""<!doctype html>
} }
$("removeFinishedBtn").addEventListener("click", () => queueBulkAction("/api/queue/clear-finished", "Removed finished and canceled jobs")); $("removeFinishedBtn").addEventListener("click", () => queueBulkAction("/api/queue/clear-finished", "Removed finished and canceled jobs"));
$("clearFailedBtn").addEventListener("click", () => queueBulkAction("/api/queue/clear-failed", "Removed failed jobs"));
$("retryFailedBtn").addEventListener("click", () => queueBulkAction("/api/queue/retry-failed", "Retried failed jobs")); $("retryFailedBtn").addEventListener("click", () => queueBulkAction("/api/queue/retry-failed", "Retried failed jobs"));
(async function init() { (async function init() {
search_page.py
+1
View File
@@ -11,6 +11,7 @@ INDEX_HTML = r"""<!doctype html>
<meta charset="utf-8"> <meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<title>ani-cli web</title> <title>ani-cli web</title>
<link rel="icon" type="image/png" sizes="32x32" href="/favicon.png">
<style> <style>
:root { :root {
color-scheme: dark; color-scheme: dark;
test_app.py
+162
View File
@@ -176,6 +176,14 @@ class NetworkGuardTests(unittest.TestCase):
self.assertIn("Username", body) self.assertIn("Username", body)
self.assertIn("Password", body) self.assertIn("Password", body)
def test_favicon_route_serves_checked_in_png(self):
handler = DummyHandler("/favicon.png")
handler.command = "GET"
APP.Handler.do_GET(handler)
self.assertEqual(handler.file_path, http_handler.FAVICON_PATH)
def test_remote_login_page_escapes_hidden_next_value(self): def test_remote_login_page_escapes_hidden_next_value(self):
handler = DummyHandler('/?next="><script>alert(1)</script>') handler = DummyHandler('/?next="><script>alert(1)</script>')
handler.client_address = ("192.168.1.25", 8421) handler.client_address = ("192.168.1.25", 8421)
@@ -466,6 +474,121 @@ class QueueApiTests(unittest.TestCase):
self.assertEqual(retried["status"], "pending") self.assertEqual(retried["status"], "pending")
self.assertFalse(retried["cancel_requested"]) self.assertFalse(retried["cancel_requested"])
def test_add_reuses_matching_failed_job_instead_of_creating_duplicate(self):
payload = {
"show_id": "show-42",
"query": "Failed Show",
"title": "Failed Show",
"anime_name": "Failed Show",
"media_type": "tv",
"mode": "dub",
"quality": "best",
"episodes": "11",
"download_dir": "/tmp/example",
"season": "2",
"episode_offset": "13",
}
created = self.queue.add(payload)
with self.queue.lock:
job = self.queue._find(created["id"])
job["status"] = "failed"
job["exit_code"] = 1
job["cancel_requested"] = True
job["started_at"] = APP.now_iso()
job["finished_at"] = APP.now_iso()
job["log"] = ["Download failed"]
self.queue._save_job_locked(job)
retried = self.queue.add(payload)
listing = self.queue.list(per_page=10)
self.assertEqual(retried["id"], created["id"])
self.assertEqual(retried["status"], "pending")
self.assertEqual(retried["log"], [])
self.assertIsNone(retried["exit_code"])
self.assertFalse(retried["cancel_requested"])
self.assertEqual(listing["total"], 1)
def test_add_keeps_new_job_when_failed_job_differs(self):
created = self.queue.add(
{
"show_id": "show-42",
"query": "Failed Show",
"title": "Failed Show",
"anime_name": "Failed Show",
"media_type": "tv",
"mode": "dub",
"quality": "best",
"episodes": "11",
"download_dir": "/tmp/example",
"season": "2",
"episode_offset": "13",
}
)
with self.queue.lock:
job = self.queue._find(created["id"])
job["status"] = "failed"
self.queue._save_job_locked(job)
new_job = self.queue.add(
{
"show_id": "show-42",
"query": "Failed Show",
"title": "Failed Show",
"anime_name": "Failed Show",
"media_type": "tv",
"mode": "dub",
"quality": "720",
"episodes": "11",
"download_dir": "/tmp/example",
"season": "2",
"episode_offset": "13",
}
)
listing = self.queue.list(per_page=10)
self.assertNotEqual(new_job["id"], created["id"])
self.assertEqual(listing["total"], 2)
def test_clear_failed_removes_only_failed_jobs(self):
failed = self.queue.add(
{
"query": "Failed Show",
"title": "Failed Show",
"anime_name": "Failed Show",
"mode": "sub",
"quality": "best",
"episodes": "1",
"download_dir": "/tmp/example",
"season": "1",
}
)
done = self.queue.add(
{
"query": "Done Show",
"title": "Done Show",
"anime_name": "Done Show",
"mode": "sub",
"quality": "best",
"episodes": "1",
"download_dir": "/tmp/example",
"season": "1",
}
)
with self.queue.lock:
failed_job = self.queue._find(failed["id"])
failed_job["status"] = "failed"
self.queue._save_job_locked(failed_job)
done_job = self.queue._find(done["id"])
done_job["status"] = "done"
self.queue._save_job_locked(done_job)
result = self.queue.clear_failed()
listing = self.queue.list()
self.assertEqual(result["count"], 1)
self.assertEqual([job["id"] for job in listing["jobs"]], [done["id"]])
def test_detach_show_clears_queue_coverage_and_sync_binding(self): def test_detach_show_clears_queue_coverage_and_sync_binding(self):
created = self.queue.add( created = self.queue.add(
{ {
@@ -2817,6 +2940,33 @@ class HandlerRouteTests(unittest.TestCase):
self.assertEqual(handler.json_status, HTTPStatus.OK) self.assertEqual(handler.json_status, HTTPStatus.OK)
self.assertIn("anipy-cli", handler.json_payload) self.assertIn("anipy-cli", handler.json_payload)
def test_clear_failed_route_removes_failed_jobs(self):
with APP.DOWNLOAD_QUEUE._connect() as conn:
conn.execute("DELETE FROM jobs")
job = APP.DOWNLOAD_QUEUE.add(
{
"query": "Failed Route Show",
"title": "Failed Route Show",
"anime_name": "Failed Route Show",
"mode": "sub",
"quality": "best",
"episodes": "1",
"download_dir": "/tmp/example",
"season": "1",
}
)
with APP.DOWNLOAD_QUEUE.lock:
stored = APP.DOWNLOAD_QUEUE._find(job["id"])
stored["status"] = "failed"
APP.DOWNLOAD_QUEUE._save_job_locked(stored)
handler = DummyHandler("/api/queue/clear-failed", body=b"{}", content_length=2)
APP.Handler.do_POST(handler)
self.assertEqual(handler.json_status, HTTPStatus.OK)
self.assertEqual(handler.json_payload["count"], 1)
self.assertEqual(APP.DOWNLOAD_QUEUE.list()["total"], 0)
def test_changelog_route_returns_project_changelog_content(self): def test_changelog_route_returns_project_changelog_content(self):
handler = DummyHandler("/api/changelog") handler = DummyHandler("/api/changelog")
APP.Handler.do_GET(handler) APP.Handler.do_GET(handler)
@@ -3340,6 +3490,13 @@ class TemplateHelperTests(unittest.TestCase):
self.assertIn("async function api(path, options = {})", APP.CONFIG_HTML) self.assertIn("async function api(path, options = {})", APP.CONFIG_HTML)
self.assertIn("async function api(path, options = {})", APP.WATCHLIST_HTML) self.assertIn("async function api(path, options = {})", APP.WATCHLIST_HTML)
def test_pages_include_favicon_link(self):
expected = '<link rel="icon" type="image/png" sizes="32x32" href="/favicon.png">'
self.assertIn(expected, APP.INDEX_HTML)
self.assertIn(expected, APP.QUEUE_HTML)
self.assertIn(expected, APP.CONFIG_HTML)
self.assertIn(expected, APP.WATCHLIST_HTML)
def test_config_page_places_dependencies_before_settings_grid(self): def test_config_page_places_dependencies_before_settings_grid(self):
self.assertIn('<section class="deps" id="deps"></section>', APP.CONFIG_HTML) self.assertIn('<section class="deps" id="deps"></section>', APP.CONFIG_HTML)
self.assertIn('<div class="settings-grid">', APP.CONFIG_HTML) self.assertIn('<div class="settings-grid">', APP.CONFIG_HTML)
@@ -3366,6 +3523,11 @@ class TemplateHelperTests(unittest.TestCase):
def test_search_page_sends_watchlist_auto_download_series(self): def test_search_page_sends_watchlist_auto_download_series(self):
self.assertIn('auto_download_series: $("seasonInput").value || "1"', APP.INDEX_HTML) self.assertIn('auto_download_series: $("seasonInput").value || "1"', APP.INDEX_HTML)
def test_queue_page_includes_clear_failed_bulk_action(self):
self.assertIn('id="clearFailedBtn"', APP.QUEUE_HTML)
self.assertIn('/api/queue/clear-failed', APP.QUEUE_HTML)
self.assertIn('Removed failed jobs', APP.QUEUE_HTML)
def test_search_page_queues_selected_title_without_result_index(self): def test_search_page_queues_selected_title_without_result_index(self):
self.assertIn('query: state.selected.title,', APP.INDEX_HTML) self.assertIn('query: state.selected.title,', APP.INDEX_HTML)
self.assertNotIn('index: state.selected.index,', APP.INDEX_HTML) self.assertNotIn('index: state.selected.index,', APP.INDEX_HTML)
watchlist_page.py
+1
View File
@@ -11,6 +11,7 @@ WATCHLIST_HTML = r"""<!doctype html>
<meta charset="utf-8"> <meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<title>ani-cli web - watchlist</title> <title>ani-cli web - watchlist</title>
<link rel="icon" type="image/png" sizes="32x32" href="/favicon.png">
<style> <style>
:root { :root {
color-scheme: dark; color-scheme: dark;