mirror of
https://github.com/nomadkaraoke/karaoke-gen.git
synced 2026-11-20 13:07:57 +09:00
Follow-up to #1220 (mobile Phase 6), from its whole-branch review. ## Problem Cloud Run Job workers run inside `asyncio.run(...)`. `JobManager._send_push_notification` (and the completion email / idle reminder) used `loop.create_task(...)` and the worker returned immediately, so `asyncio.run` cancelled the send. Prod logs: all 62 "Push notifications sent" lines in 14 days came from the API service, none from worker jobs. Separately, worker jobs never had `ENABLE_PUSH_NOTIFICATIONS` / VAPID keys, so even a delivered Web Push would have been skipped. ## Customer impact check (emails) Checked 2026-09-25 → 2026-10-25 (full log retention): **no customer emails were lost.** 289 COMPLETE transitions → 11 deliberately suppressed re-renders, 278 completion emails scheduled and 278 sent (email_log has 297 completion records, all with Postmark MessageIDs; Postmark outbound ≥ email_log). The email coroutines happen to do all their I/O synchronously, so they finished in the task's first step before `asyncio.run` cancelled; pushes hand off to a thread and were cancelled. The drain removes that fragility for emails too. **Only pushes were lost** (0 worker pushes in 14 days). ## Fix - Notification tasks are tracked; every worker `main()` wraps its job in `with_notification_drain` (bounded 10 s wait on our coroutines; provider calls keep their own timeouts). The API server path stays fire-and-forget. - `failure_push_sent` is written only after the push was attempted; in-flight id cleared via done-callback. - Worker jobs (audio-download, audio-separation, bulk-search, lyrics-transcription, video-encoding) get `ENABLE_PUSH_NOTIFICATIONS=true` + `VAPID_PUBLIC_KEY`/`VAPID_PRIVATE_KEY` (same secrets as the API). CI-pinned jobs now `ignore_changes` their image (CI owns it), so a targeted `pulumi up` changes env only. - Expo messages carry `channelId: "jobs"` (the app's Android channel). ## Deploy After merge, a targeted `pulumi up` from main on the 5 jobs. Preview (read-only, from this branch): 5 updates, each only +`ENABLE_PUSH_NOTIFICATIONS`/+`VAPID_*`, no removals, no image change, 283 unchanged. **Behaviour change:** Web Push subscribers will start receiving the worker-triggered pushes (video ready, needs review, failed) they were always meant to get. ## Tests 6901 backend tests pass (emulator-integration file excluded: local env). Tests reproduce the cancellation through each worker's real `main()`. Per-task review + local CodeRabbit (no findings). @coderabbitai ignore 🤖 Generated with [Claude Code](https://claude.com/claude-code) https://claude.ai/code/session_01CZf1cM9vefnNw5djARRhyA --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
205 lines
6.9 KiB
TOML
205 lines
6.9 KiB
TOML
[tool.poetry]
|
|
name = "karaoke-gen"
|
|
version = "0.284.1"
|
|
description = "Generate karaoke videos with synchronized lyrics. Handles the entire process from downloading audio and lyrics to creating the final video with title screens."
|
|
authors = ["Andrew Beveridge <andrew@beveridge.uk>"]
|
|
license = "MIT"
|
|
readme = "README.md"
|
|
packages = [
|
|
{ include = "karaoke_gen" },
|
|
{ include = "backend" }
|
|
]
|
|
include = [
|
|
# The Next.js static export is generated at build time and gitignored (see #876).
|
|
# Poetry's plain-string include respects .gitignore and would DROP a gitignored
|
|
# path from the wheel; the dict form with an explicit `format` overrides .gitignore
|
|
# so the built frontend is still bundled (needed for the CLI local-review UI).
|
|
# Wheel-only: the sdist would balloon past PyPI's 10 GB cap, so bundle in the wheel only.
|
|
{ path = "karaoke_gen/nextjs_frontend/out/**/*", format = ["wheel"] },
|
|
"karaoke_gen/lyrics_transcriber/output/fonts/*",
|
|
"karaoke_gen/lyrics_transcriber/output/cdgmaker/images/*",
|
|
"karaoke_gen/lyrics_transcriber/output/cdgmaker/transitions/*",
|
|
# Skip/include lists for the YouTube description backfill worker (must ship in
|
|
# the Cloud Run image so the scheduled worker can read them).
|
|
"backend/data/youtube_backfill/*.txt"
|
|
]
|
|
homepage = "https://github.com/nomadkaraoke/karaoke-gen"
|
|
repository = "https://github.com/nomadkaraoke/karaoke-gen"
|
|
documentation = "https://github.com/nomadkaraoke/karaoke-gen/blob/main/README.md"
|
|
|
|
[tool.poetry.dependencies]
|
|
python = ">=3.10,<3.14"
|
|
torch = ">=2.7"
|
|
requests = ">=2"
|
|
beautifulsoup4 = ">=4"
|
|
flacfetch = ">=0.9.0"
|
|
lyricsgenius = ">=3"
|
|
fetch-lyrics-from-genius = ">=0.1"
|
|
pillow = ">=10.1"
|
|
pyinstaller = ">=6.3"
|
|
google-api-python-client = "2.193.0"
|
|
google-auth = "2.49.1"
|
|
google-auth-oauthlib = "1.3.0"
|
|
google-auth-httplib2 = "0.3.0"
|
|
thefuzz = ">=0.22"
|
|
numpy = ">=2"
|
|
audio-separator = { version = ">=0.43.0", extras = ["cpu"] }
|
|
lyrics-converter = ">=0.2.1"
|
|
# lyrics_transcriber is now a subpackage of karaoke_gen (karaoke_gen/lyrics_transcriber/)
|
|
# Dependencies from vendored lyrics_transcriber:
|
|
mutagen = ">=1.47" # For LRCLIB provider to get track duration for better matching
|
|
python-slugify = ">=8"
|
|
syrics = ">=0"
|
|
karaoke-lyrics-processor = ">=0.6"
|
|
dropbox = ">=12"
|
|
spacy = ">=3.8.7"
|
|
srsly = ">=2.5.1"
|
|
tqdm = ">=4.67"
|
|
python-levenshtein = ">=0.26"
|
|
transformers = ">=4.47"
|
|
metaphone = ">=0.6"
|
|
nltk = ">=3.9"
|
|
spacy-syllables = ">=3"
|
|
syllables = ">=1"
|
|
fonttools = ">=4.55"
|
|
ollama = ">=0.4.7"
|
|
shortuuid = ">=1.0.13"
|
|
nest-asyncio = ">=1.5"
|
|
openai = ">=1.63.2"
|
|
langgraph = ">=0.2.0"
|
|
langchain = ">=0.3.0"
|
|
langchain-core = ">=0.3.0"
|
|
langchain-openai = ">=0.2.0"
|
|
langchain-anthropic = ">=0.2.0"
|
|
anthropic = ">=0.109.0" # direct dep: auto-correct structured outputs (output_config)
|
|
langchain-ollama = ">=0.2.0"
|
|
langchain-google-genai = ">=2.0.0"
|
|
langfuse = ">=3.0.0"
|
|
jiwer = ">=3.0.0"
|
|
kbputils = "^0.0.16"
|
|
attrs = ">=24.2.0"
|
|
cattrs = ">=24.1.2"
|
|
toml = ">=0.10"
|
|
argparse = ">=1.4.0"
|
|
psutil = "^7.0.0"
|
|
pyperclip = "*"
|
|
pytest-asyncio = "*"
|
|
ffmpeg-python = "^0.2.0"
|
|
python-multipart = "^0.0.20"
|
|
python-docx = ">=1.1.0"
|
|
yt-dlp = ">=2024.0.0"
|
|
matplotlib = ">=3"
|
|
# Backend API dependencies
|
|
fastapi = ">=0.104.0"
|
|
uvicorn = { version = ">=0.24.0", extras = ["standard"] }
|
|
pydantic = ">=2.5.0"
|
|
pydantic-settings = ">=2.1.0"
|
|
httpx = ">=0.25.0"
|
|
tenacity = "^8.2.0" # Retry logic for external service calls
|
|
google-cloud-firestore = "2.26.0"
|
|
google-cloud-compute = "^1.0.0"
|
|
google-cloud-storage = "3.10.1"
|
|
google-cloud-secret-manager = "2.26.0"
|
|
google-cloud-monitoring = "2.29.1" # Cloud Monitoring for YouTube API quota metrics
|
|
google-cloud-tasks = "2.21.0" # Cloud Tasks for worker coordination (Phase 1 scalability)
|
|
google-cloud-run = "0.15.0" # Cloud Run Jobs for long-running video encoding (Phase 2 scalability)
|
|
google-cloud-logging = ">=3.9.0" # Cloud Logging for error monitoring
|
|
python-dotenv = ">=1.0.0"
|
|
pydub = ">=0.25.1"
|
|
# Google / Apple ID-token verification (JWKS) for mobile sign-in
|
|
pyjwt = { version = ">=2.8.0", extras = ["crypto"] }
|
|
# Payment and email services
|
|
stripe = "^14.1.0"
|
|
email-validator = ">=2.0.0" # For Pydantic EmailStr validation
|
|
# Web Push notifications
|
|
pywebpush = ">=2.0.0"
|
|
# OpenTelemetry for distributed tracing
|
|
opentelemetry-api = ">=1.20.0"
|
|
opentelemetry-sdk = ">=1.20.0"
|
|
opentelemetry-instrumentation-fastapi = ">=0.41b0"
|
|
opentelemetry-instrumentation-httpx = ">=0.41b0"
|
|
opentelemetry-instrumentation-logging = ">=0.41b0"
|
|
opentelemetry-exporter-gcp-trace = ">=1.6.0"
|
|
opentelemetry-resourcedetector-gcp = ">=1.6.0a0"
|
|
# Optional: Local Whisper transcription (install with: pip install karaoke-gen[local-whisper])
|
|
whisper-timestamped = { version = ">=1.15.0", optional = true }
|
|
aiohttp = "^3.13.2"
|
|
|
|
[tool.poetry.group.dev.dependencies]
|
|
black = ">=23"
|
|
poetry = "*"
|
|
pytest = ">=7.0"
|
|
pytest-cov = ">=4.0"
|
|
pytest-mock = ">=3.10"
|
|
pytest-asyncio = "*"
|
|
|
|
# Make dev dependencies available as optional extras for pip install
|
|
# These need to be declared as optional dependencies first
|
|
[tool.poetry.dependencies.black]
|
|
version = ">=23"
|
|
optional = true
|
|
|
|
[tool.poetry.dependencies.pytest]
|
|
version = ">=7.0"
|
|
optional = true
|
|
|
|
[tool.poetry.dependencies.pytest-cov]
|
|
version = ">=4.0"
|
|
optional = true
|
|
|
|
[tool.poetry.dependencies.pytest-mock]
|
|
version = ">=3.10"
|
|
optional = true
|
|
|
|
[tool.poetry.extras]
|
|
# Local Whisper transcription support - optional, heavy dependencies
|
|
# Install with: pip install karaoke-gen[local-whisper]
|
|
# For CPU-only installation (recommended for systems without GPU):
|
|
# pip install torch torchaudio --index-url https://download.pytorch.org/whl/cpu
|
|
# pip install karaoke-gen[local-whisper]
|
|
local-whisper = ["whisper-timestamped"]
|
|
|
|
# Development/testing dependencies (pytest-asyncio is already a main dependency)
|
|
# Install with: pip install -e ".[dev]" or pip install -e ".[local-whisper,dev]"
|
|
dev = ["black", "pytest", "pytest-cov", "pytest-mock"]
|
|
|
|
[tool.poetry.scripts]
|
|
karaoke-gen = 'karaoke_gen.utils.gen_cli:main'
|
|
karaoke-gen-remote = 'karaoke_gen.utils.remote_cli:main'
|
|
karaoke-bulk = 'karaoke_gen.utils.bulk_cli:main'
|
|
|
|
[tool.black]
|
|
line-length = 140
|
|
|
|
[build-system]
|
|
requires = ["poetry-core"]
|
|
build-backend = "poetry.core.masonry.api"
|
|
|
|
[tool.pytest.ini_options]
|
|
testpaths = ["tests/unit", "tests/integration", "backend/tests"]
|
|
python_files = ["test_*.py"]
|
|
addopts = [
|
|
"--asyncio-mode=auto",
|
|
"-v",
|
|
"--tb=short",
|
|
]
|
|
markers = [
|
|
"slow: marks tests as slow (deselect with '-m \"not slow\"')",
|
|
"integration: marks tests as integration tests",
|
|
"asyncio: mark test as async",
|
|
"emulator: marks tests requiring GCP emulators",
|
|
]
|
|
filterwarnings = [
|
|
"ignore::DeprecationWarning",
|
|
"ignore:'audioop' is deprecated:DeprecationWarning",
|
|
"ignore::RuntimeWarning",
|
|
"ignore::UserWarning",
|
|
]
|
|
|
|
[tool.coverage.run]
|
|
# Exclude lyrics_transcriber subpackage from coverage since it was a separate vendored package
|
|
# with its own test suite - including it in karaoke_gen coverage would unfairly lower the percentage
|
|
omit = [
|
|
"karaoke_gen/lyrics_transcriber/*",
|
|
]
|