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>
Backend Development Setup
One-Time Setup
1. Create Virtual Environment
cd /Users/andrew/Projects/karaoke-gen
python3 -m venv backend/venv
2. Activate Virtual Environment
source backend/venv/bin/activate
3. Install Dependencies
IMPORTANT: Use Python 3.12 (not 3.13/3.14 - pydantic has compatibility issues)
# Backend dependencies
pip install -r backend/requirements.txt
# Install karaoke_gen in development mode
pip install -e .
# Install lyrics_transcriber submodule
pip install -e lyrics_transcriber_local/
# Install Google API client (for YouTube upload)
pip install google-api-python-client google-auth-httplib2 google-auth-oauthlib
4. Add Shell Alias (Optional)
Add to ~/.zshrc:
alias backend='cd /Users/andrew/Projects/karaoke-gen && source backend/venv/bin/activate'
Then you can just run:
backend
# Now you're in the project directory with venv activated!
Daily Workflow
Before Making Changes
# Activate venv
source backend/venv/bin/activate
# Or if you set up the alias:
backend
After Making Changes
# 1. Run full validation (catches import errors!)
python3 backend/validate.py
# 2. If validation passes, deploy
./scripts/deploy.sh
Validation Options
Full Validation (Recommended - Requires venv)
source backend/venv/bin/activate
python3 backend/validate.py
Catches:
- ✅ Syntax errors
- ✅ Import errors (like the processing_service issue!)
- ✅ Configuration issues
- ✅ FastAPI app creation problems
- ✅ Missing dependencies
This would have caught the ModuleNotFoundError!
Quick Check (No venv needed)
./backend/quick-check.sh
Catches:
- ✅ Syntax errors
- ✅ Missing files
- ✅ Some obvious import issues
Good for quick checks, but won't catch all import errors
Example: Complete Development Session
# 1. Activate environment
backend # or: source backend/venv/bin/activate
# 2. Make your changes
vim backend/api/routes/jobs.py
# 3. Validate (catches import errors!)
python3 backend/validate.py
# ✅ All validations passed!
# 4. Deploy
./scripts/deploy.sh
# 5. Test
export BACKEND_URL="https://karaoke-backend-ipzqd2k4yq-uc.a.run.app"
export AUTH_TOKEN=$(gcloud auth print-identity-token)
curl -H "Authorization: Bearer $AUTH_TOKEN" $BACKEND_URL/api/health
What About karaoke_gen Imports?
The backend imports from karaoke_gen (the CLI package):
from karaoke_gen.karaoke_gen import KaraokePrep
from karaoke_gen.audio_processor import AudioProcessor
Options:
Option 1: Install in development mode (Recommended)
source backend/venv/bin/activate
pip install -e .
This makes karaoke_gen available in the venv without copying files.
Option 2: Use system Python
Your system Python already has karaoke_gen installed, so validation will work even if the venv doesn't have it (Python will fall back to system packages).
Running the Backend Locally
# Activate venv
source backend/venv/bin/activate
# Set required environment variables
export GOOGLE_CLOUD_PROJECT="nomadkaraoke"
export GCS_BUCKET_NAME="karaoke-gen-storage-nomadkaraoke"
# Optional: Point to local credentials
export GOOGLE_APPLICATION_CREDENTIALS="/path/to/service-account-key.json"
# Run the server
cd backend
uvicorn main:app --reload --port 8080
Visit: http://localhost:8080/api/health
Troubleshooting
"No module named 'fastapi'"
Fix:
source backend/venv/bin/activate
pip install -r backend/requirements.txt
"No module named 'karaoke_gen'"
Fix:
source backend/venv/bin/activate
cd /Users/andrew/Projects/karaoke-gen
pip install -e .
Validation passes locally but fails in Cloud Run
Check:
- Is
requirements.txtup to date? - Did you add a new dependency without adding it to
requirements.txt? - Run:
pip freeze | grep <package-name>
Updating Dependencies
When you add new packages:
# 1. Install in venv
source backend/venv/bin/activate
pip install new-package
# 2. Update requirements.txt
pip freeze > backend/requirements.txt
# 3. Or manually add just the new package:
echo "new-package==1.2.3" >> backend/requirements.txt
# 4. Validate
python3 backend/validate.py
# 5. Deploy
./scripts/deploy.sh
Summary
Best practice workflow:
- One-time setup: Create venv and install dependencies
- Daily: Activate venv when working on backend
- Before deploy: Run
python3 backend/validate.py(catches import errors!) - Deploy: Use
./scripts/deploy.sh
The import error would have been caught if you ran validation in a venv! ✅