Compare commits

..
Author SHA1 Message Date
Andrew BeveridgeandClaude Opus 4.5 940cb19d57 fix(docker): Add missing backend directory to Dockerfile.base
The backend package was added to pyproject.toml packages but the
Dockerfile.base wasn't updated to copy it, causing the editable
install to fail with "ValueError: /app/backend does not contain
any element".

This was discovered when the push notifications PR triggered a
base image rebuild due to a hash change.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-10 17:32:28 -05:00
Andrew Beveridge ☄️andClaude Opus 4.5 e57ed6ea47 feat(push): Add Web Push notifications for mobile users (#274)
## Summary
- Add push notification support so mobile users get notified when jobs
need attention or complete
- Backend: PushNotificationService with pywebpush, /api/push/* routes,
VAPID key secrets
- Frontend: Service worker, PWA manifest, usePushNotifications hook,
soft-ask banner
- CI: Enable ENABLE_PUSH_NOTIFICATIONS and add VAPID secrets to Cloud
Run deployment

## Test plan
- [x] Backend unit tests pass (35 tests)
- [x] Push service and route tests cover subscription management and
notification sending
- [x] Frontend component tests verify prompt visibility and user
interactions
- [ ] Manual test on mobile after deployment

## What it does
Users on mobile (iOS PWA or Android) can opt-in to push notifications.
When enabled:
- Get notified when lyrics need review
- Get notified when instrumental selection is needed
- Get notified when video is ready to download

Notifications are sent alongside existing email notifications
(fire-and-forget pattern).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

@coderabbitai ignore

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-10 17:26:12 -05:00
Andrew Beveridge ☄️andClaude 73632a4e15 fix(admin): Fix YouTube delete bug and show errors on partial failure (#273)
- Remove invalid enable_youtube argument from KaraokeFinalise initialization
- Return partial_success/error status when individual services fail
- Show destructive toast with service details on frontend when deletion partially fails

Co-Authored-By: Claude <noreply@anthropic.com>
2026-01-10 16:08:40 -05:00
Andrew Beveridge ☄️andClaude Opus 4.5 85db864207 feat(admin): Add delete outputs button for quality issue remediation (#272)
## Summary

Add admin functionality to delete all distributed outputs (YouTube,
Dropbox, Google Drive) for a completed job while preserving the job
record. This enables quality issue remediation by deleting outputs,
resetting to review, and re-generating.

## Changes

- Add `outputs_deleted_at` and `outputs_deleted_by` fields to Job model
- Add `POST /api/admin/jobs/{job_id}/delete-outputs` endpoint
- Add auto-clear of outputs_deleted_at flag when outputs are re-uploaded
after re-processing
- Add "Delete All Outputs" button and confirmation dialog in admin job
detail page
- Add "Outputs Deleted" badge when flag is set
- Add 13 unit tests for the new endpoint

## Testing

- [x] Backend unit tests pass (1546 passed)
- [x] Frontend unit tests pass (163 passed)
- [x] Frontend build succeeds
- [x] New endpoint tests pass (13 tests)

## Review

- [x] CodeRabbit CLI review completed locally
- [x] Review feedback addressed (2 issues fixed)

@coderabbitai ignore

---
🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-10 15:32:12 -05:00
Andrew Beveridge ☄️andClaude Opus 4.5 33b27791fd fix(gce): Respect user's instrumental selection in GCE encoding worker (#271)
## Summary
- Fix bug where GCE encoding worker ignored user's instrumental
selection and always used clean instrumental
- When both instrumentals exist in GCS, `find_file()` now respects the
`instrumental_selection` config value
- Added 9 regression tests to prevent recurrence

## Problem
User selected "with_backing" instrumental in the review UI, but the
final video was created using the clean instrumental instead. The GCE
worker's `find_file()` function had `*instrumental_clean*` pattern
first, so it always matched that regardless of user selection.

## Solution
- Read `instrumental_selection` from encoding config
- Use appropriate search patterns based on selection:
- `with_backing`: prioritizes `*instrumental_with_backing*` and
`*Backing*`
  - `clean` (default): prioritizes `*instrumental_clean*` and `*Clean*`

## Test plan
- [x] Added 9 new tests in `test_gce_encoding_worker.py`
- [x] All encoding-related tests pass (35 tests)
- [ ] Deploy and verify with affected job (7b5b21c1) can be re-run
successfully

@coderabbitai ignore

---
Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-10 15:14:58 -05:00
Andrew Beveridge ☄️andClaude Opus 4.5 c8f10e0810 docs: Emphasize automating manual testing steps as E2E tests (#270)
## Summary
- Add prominent guidance in TESTING.md about converting manual testing
steps into automated Playwright E2E tests
- Emphasize that production E2E tests are valuable even if only run once
after deployment
- Update CLAUDE.md to surface this guidance early for agents

## Changes
- **docs/TESTING.md**: Added new "Critical: Automate Manual Testing
Steps" section with:
  - Clear directive to convert manual steps to E2E tests
  - Explanation of why production E2E tests are valuable
  - Workflow for production-only E2E tests
  - Before/after example showing conversion
  - Decision table for test type selection
  - Updated "Adding Tests for New Features" section
- **CLAUDE.md**: Added callout in Testing section pointing to new
guidance

## Test plan
- [x] Docs-only change, no code affected
- [x] Ran `make test` to verify no regressions

@coderabbitai ignore

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-10 15:01:21 -05:00
Andrew Beveridge ☄️andClaude de67736ae4 fix(mfy): Fix order success redirect URL to use frontend app (#269)
## Summary
- Fixed made-for-you order checkout redirecting to non-existent page
after payment
- Customers were seeing black/404 screen at
`nomadkaraoke.com/order/success/` (doesn't exist)
- Now correctly redirects to `gen.nomadkaraoke.com/order/success` with
proper thank-you page

## Changes
- `backend/services/stripe_service.py`: Use `self.frontend_url` instead
of hardcoded wrong domain for made-for-you checkout success URL
- `frontend/app/order/success/page.tsx`: New success page for
made-for-you orders with appropriate messaging (delivery timeframe,
email notification info)
- `backend/tests/test_stripe_service.py`: Added 7 tests for Stripe
service URL generation

## Root Cause
The credit purchase checkout correctly used `self.frontend_url` to build
the success URL, but made-for-you checkout had a hardcoded URL pointing
to the marketing site (`nomadkaraoke.com`) instead of the app
(`gen.nomadkaraoke.com`).

## Testing
- [x] Backend tests pass (7 new tests)
- [x] Frontend builds successfully
- [x] New `/order/success` route appears in build output

## Review
- [x] Local CodeRabbit review completed
- [x] No issues found

@coderabbitai ignore

---
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude <noreply@anthropic.com>
2026-01-10 01:19:10 -05:00
Andrew Beveridge ☄️andClaude Opus 4.5 a51a72498d feat: Add Made For You section to landing page (#268)
## Summary
- Add Made For You ($15 full-service) section below pricing
- Update hero with dual CTAs: DIY ($5) vs Done-For-You ($15)
- Add order form with source type toggle (Auto Search / YouTube URL /
File Upload)
- Add YouTube examples link to Made For You benefits
- Add `createMadeForYouCheckout()` API function

## Related PR
- public-website: Removes Made For You from nomadkaraoke.com

## Test plan
- [x] Build passes (`npm run build`)
- [x] E2E tests pass (24 passed)
- [x] Hero shows both $5 and $15 options with comparison text
- [x] Made For You section renders below pricing
- [x] Form validation works (required fields)

@coderabbitai ignore

🤖 Generated with [Claude Code](https://claude.ai/code)

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-10 05:32:56 +00:00
Andrew Beveridge ☄️andClaude Opus 4.5 de79ccd485 fix(mfy): Centralize CDG/TXT defaults to fix made-for-you jobs missing outputs (#266)
@coderabbitai ignore

## Summary
- Made-for-you jobs were created without CDG/TXT outputs because the
webhook handler didn't set `enable_cdg`/`enable_txt` (which default to
`False` in `JobCreate`)
- Regular jobs call `resolve_cdg_txt_defaults()` which returns `True`
when a theme is set, but this logic was not shared with the made-for-you
handler
- Created centralized `job_defaults_service.py` with shared helpers for
all job creation paths

## Changes
- Add `job_defaults_service.py` with centralized helpers:
  - `resolve_cdg_txt_defaults()` for CDG/TXT resolution
  - `get_effective_distribution_settings()` for distribution defaults
- Add `DEFAULT_ENABLE_CDG` and `DEFAULT_ENABLE_TXT` settings (default:
`true`)
- Update all job creation paths (file_upload, audio_search, users.py) to
use centralized service
- Remove duplicated code from file_upload.py and audio_search.py
- Add lesson learned about centralizing job creation logic

## Test plan
- [x] Unit tests pass for made-for-you, audio_search, file_upload
- [x] CodeRabbit review passed
- [ ] E2E test with made-for-you order to verify CDG/TXT files generated

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-09 23:51:31 -05:00
Andrew Beveridge ☄️andClaude Opus 4.5 e78cc83abd feat: Add per-day rate limits and abuse prevention (#265)
## Summary

- Add per-user job rate limiting (5 jobs/day default, configurable)
- Add system-wide YouTube upload limiting (10/day default)
- Add beta enrollment abuse prevention (email normalization, disposable
domain blocklist, IP rate limiting)
- Add admin UI for managing blocklists and user overrides at
`/admin/rate-limits`
- Add comprehensive test coverage (40 backend tests, 18 Jest tests, 7
E2E tests)

## Changes

### Backend
- New `RateLimitService` for job and YouTube upload tracking
- New `EmailValidationService` for email normalization and blocklist
checking
- New admin API routes at `/api/admin/rate-limits/*`
- 429 exception handler with detailed rate limit info
- Rate limit checks in job creation and beta enrollment flows

### Frontend
- New admin page at `/admin/rate-limits` with tabs for:
  - Overview (stats and configuration)
  - Blocklists (disposable domains, blocked emails, IPs)
  - User Overrides (bypass permissions, custom limits)

### Configuration
```bash
RATE_LIMIT_JOBS_PER_DAY=5
RATE_LIMIT_YOUTUBE_UPLOADS_PER_DAY=10
RATE_LIMIT_BETA_IP_PER_DAY=1
ENABLE_RATE_LIMITING=true
```

## Test plan

- [x] Backend unit tests pass (40 rate limit tests)
- [x] Frontend Jest tests pass (18 tests)
- [x] E2E smoke tests pass (7 tests)
- [x] Full backend test suite passes (`make test`)

@coderabbitai ignore

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-09 23:30:40 -05:00
Andrew Beveridge ☄️andClaude Opus 4.5 4f838043e2 feat(ui): Simplify recent jobs layout with compact button row (#264)
## Summary
- Remove section titles for vertical compactness, display all buttons in
single wrapping row
- Combine Copy Message + Send Email into single Email button with
clipboard attachment
- Remove Delete and Show Logs from job cards (available in admin detail
page)

## Test plan
- [x] Frontend builds successfully
- [x] Unit tests pass
- [ ] Visual verification of job card layout on desktop and mobile

@coderabbitai ignore

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-10 03:51:19 +00:00
Andrew Beveridge ☄️andClaude Opus 4.5 81398d01d5 feat(preview): Add fast black background option for lyrics review preview (#263)
## Summary
- Add toggle to render preview videos with black background (~10s) vs
theme background (~30-60s)
- Default to fast black background for better UX during iterative review
- User can enable theme background via checkbox when needed

## Changes
- **Backend**: `backend/api/routes/review.py` - Accept
`use_background_image` param, conditionally skip background image lookup
- **Frontend API**: `api.ts` - Add `PreviewOptions` interface with
`use_background_image` option
- **Frontend UI**: `PreviewVideoSection.tsx` - Add checkbox toggle with
explanatory helper text
- **Docs**: Updated API.md and README.md with feature documentation
- **Version**: Bump to 0.101.0

## Testing
- [x] All tests pass locally (`make test` - 90 E2E + unit tests)
- [x] TypeScript compiles successfully

## Review
- [x] CodeRabbit CLI review completed locally (no issues found)
- [x] Documentation reviewed and updated

@coderabbitai ignore

---
🤖 Generated with [Claude Code](https://claude.ai/code)

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-09 21:34:53 -05:00
Andrew Beveridge ☄️andClaude 7cfac407e3 feat(admin): Enhanced admin job detail page with files, edit, and reset (#261)
## Summary
- Add comprehensive job management features to admin job detail view
- Enable file downloads with signed GCS URLs grouped by category
- Add inline editing of job fields (artist, title, theme, etc.)
- Add job reset actions to re-process from workflow checkpoints

## Changes

### Backend (39 new tests)
- `GET /api/admin/jobs/{job_id}/files` - Get all job files with signed
URLs (2-hour expiry)
- `PATCH /api/admin/jobs/{job_id}` - Update editable job fields with
whitelist validation
- `POST /api/admin/jobs/{job_id}/reset` - Reset job to specific workflow
checkpoint

### Frontend (13 E2E tests)
- **Files accordion** - Download job files grouped by category (input,
stems, lyrics, outputs)
- **Configuration section** - Inline editing for artist, title,
theme_id, brand_prefix, customer_email
- **Admin Actions section** - Reset buttons for pending, audio
selection, review, instrumental selection
- **Enhanced timeline** - Color-coded stages (green=complete,
blue=processing, orange=waiting, red=failed)

### Documentation
- Updated `docs/API.md` with new endpoint documentation
- Updated `docs/README.md` with feature summary
- Added lesson learned about AuthResult tuple unpacking gotcha

## Test Plan
- [x] Backend tests pass (39 new tests for files, update, reset
endpoints)
- [x] Frontend E2E tests pass (13 tests for admin job detail page)
- [x] Frontend unit tests pass (150 tests)
- [x] Frontend builds successfully
- [x] CodeRabbit review passed (2 cycles, all issues fixed)

## Screenshots
See updated admin job detail page at `/admin/jobs?id={job_id}`

@coderabbitai ignore

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude <noreply@anthropic.com>
2026-01-09 21:11:58 -05:00
Andrew Beveridge ☄️andClaude Opus 4.5 49158f99ac fix(testing): Unify test setup with auto-install and clearer guidance (#262)
## Summary

- **`make test` now runs ALL tests** (backend + frontend) and
auto-installs dependencies if missing
- Added clear "All tests must pass" guidance - agents should never
dismiss failures as "pre-existing"
- Fixed misplaced test that was always failing (tested wrong frontend)
- Fixed logo locator bug in landing-page test

## Changes

| File | Change |
|------|--------|
| `Makefile` | Auto-install deps, unified `make test`, added
`test-backend`/`test-frontend` |
| `CLAUDE.md` | Simplified to just `make test` |
| `docs/DEVELOPMENT.md` | Consolidated testing section |
| `docs/TESTING.md` | Updated guidance and quick reference |
| `frontend/e2e/regression/landing-page.spec.ts` | Fixed `getByText` →
`getByAltText` for logo |
| `frontend/e2e/manual/` | Moved `lyrics-review-mobile.spec.ts` here
with README |

## Test plan

- [x] `make test` passes all 153 tests (76 backend + 77 frontend)
- [x] Auto-install works in fresh worktree
- [x] Documentation is clear and consistent

@coderabbitai ignore

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-09 21:05:03 -05:00
Andrew Beveridge ☄️andClaude Opus 4.5 98b4636006 docs: Document admin login token feature (#260)
## Summary

- Document the admin login token feature added in PR #258
- Add README entry for one-click admin login via email
- Document admin_token URL parameter in API.md verify endpoint

## Changes

- **docs/README.md**: Added "Recent Changes" entry for admin login token
feature
- **docs/API.md**: Added note about admin_token parameter to verify
endpoint docs

## Test Plan

- [x] Documentation builds correctly
- [x] Links are valid

<!-- @coderabbitai ignore -->

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-09 20:27:21 -05:00
Andrew Beveridge ☄️andClaude Opus 4.5 483d334900 feat(email): Add one-click admin login via email token (#258)
## Summary

- Add one-click admin login via email for made-for-you orders
- Restructure admin notification email with improved format
- Add job_id to customer confirmation email
- **Fix**: Transfer job ownership to customer on made-for-you job
completion
- **New**: BCC done@nomadkaraoke.com on all job completion emails

## Changes

### Backend
- **user_service.py**: Add `create_admin_login_token()` method for
24-hour expiry tokens
- **email_service.py**: 
- Admin email: New subject format, EST deadline, restructured grey box,
admin_token link
  - Customer email: Add job_id to order details
  - Add BCC support to all email providers
- BCC done@nomadkaraoke.com on job completion and customer confirmation
emails
- **users.py**: Update ADMIN_EMAIL to madeforyou@nomadkaraoke.com,
generate admin token in webhook
- **job_manager.py**: Transfer ownership from admin to customer when
made-for-you job completes
- **test_made_for_you.py**: Update tests for new email parameters, admin
token, and ownership transfer
- **tests/emulator/test_made_for_you_integration.py**: New emulator
integration tests
- **test_email_service.py**: Update tests for BCC and new required
parameters

### Frontend
- **app/page.tsx**: Handle admin_token URL parameter for one-click login
flow
- **e2e/regression/admin-token-auth.spec.ts**: New E2E tests for admin
token authentication

## Test Plan

- [x] Backend unit tests pass (109 passed, 5 skipped for unrelated
reason)
- [x] Emulator integration tests pass (8 passed)
- [x] E2E regression tests pass (4/4 tests)
- [x] Manual test: Place test order, verify both emails, click admin
login button

<!-- @coderabbitai ignore -->

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-09 20:11:32 -05:00
Andrew Beveridge ☄️andClaude Opus 4.5 18abcd2174 docs: Archive LESSONS-LEARNED.md to reduce context size (#259)
## Summary

- Reduced `docs/LESSONS-LEARNED.md` from 2,387 lines to 219 lines (91%
reduction)
- Archived full content to
`docs/archive/2026-01-09-lessons-learned-archive.md`
- Condensed all lessons to 1-3 sentence summaries while preserving key
insights

## Why

The LESSONS-LEARNED.md file is read by `/new-worktree` to provide
context to new sessions. At 2,387 lines (~29k tokens), it was too large
to fit in context windows effectively.

## Changes

- **LESSONS-LEARNED.md**: Now 219 lines with concise summaries organized
by category
- **Archive**: Full content with all code examples preserved for
reference

## Test plan

- [x] Verified new file links work
- [x] Confirmed archive contains complete original content
- [x] No code changes (docs only)

---

@coderabbitai ignore

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-09 19:11:50 -05:00
Andrew Beveridge ☄️andClaude Opus 4.5 50eee533ce docs: Add comprehensive testing guide (#257)
## Summary

- Add `docs/TESTING.md` with comprehensive testing standards, CI
requirements, and Playwright guidance
- Adapted from karaoke-decide sister project with karaoke-gen-specific
patterns and infrastructure
- Add "read TESTING.md before planning" rule to CLAUDE.md Essential
Rules section

## Changes

### New: `docs/TESTING.md`
- **Core principles**: SOLID principles, code quality standards
- **Test types**: Unit, integration, emulator, E2E (regression vs
production)
- **Playwright usage**: Installation, running tests, writing tests,
debugging
- **CI pipeline**: Required checks, on-demand checks, path filtering
- **Production E2E**: Environment variables, getting tokens, test
coverage
- **Mocking guidelines**: When to mock, when not to, examples
- **File organization**: Accurate tree structure of test locations
- **Quick reference**: Common commands table

### Updated: `CLAUDE.md`
- Added TESTING.md to Quick Reference table
- Added rule: "Before planning any implementation work, read
docs/TESTING.md"

### Updated: `docs/README.md`
- Added TESTING.md to Quick Links table

## Test plan

- [x] Docs-only change, no tests needed
- [x] Verified all referenced test files/directories exist
- [x] Verified commands match actual Makefile targets and npm scripts

@coderabbitai ignore

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-09 18:27:49 -05:00
Andrew Beveridge ☄️andClaude Opus 4.5 4f852f6715 fix(api): Fix made-for-you job field mapping and email templates (#256)
## Summary

Fixes two bugs that were preventing made-for-you order emails from being
sent:

1. **JobManager field mapping bug**: `JobManager.create_job()` wasn't
copying `made_for_you`, `customer_email`, and `customer_notes` fields
from `JobCreate` to `Job`, causing jobs to be created with
`made_for_you=False` even when the webhook correctly set it to `True`.

2. **Email template bug**: The webhook handler was using generic
`send_email()` with inline HTML instead of the professional template
methods `send_made_for_you_order_confirmation()` and
`send_made_for_you_admin_notification()`.

## Changes

### Bug Fixes
- Add `made_for_you`, `customer_email`, `customer_notes` field mapping
in `job_manager.py`
- Replace inline HTML emails with template method calls in `users.py`
- Initialize `search_results` variable before use

### Tests Added
- 5 new tests in `test_job_manager.py` for made-for-you field mapping
- 4 new tests in `test_made_for_you.py` for email template usage

### Version
- Bump to 0.99.9

## Test Plan

- [x] All modified Python files pass syntax validation
- [x] Direct verification of JobManager field mapping
- [x] Verification that email template methods are called
- [ ] CI tests pass

@coderabbitai ignore

---
🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-09 16:58:48 -05:00
Andrew Beveridge ☄️andClaude Opus 4.5 d89ccf0edd feat(stripe): Add payment method configuration for Google Pay and Link (#255)
## Summary
- Add support for `STRIPE_PAYMENT_METHOD_CONFIG` environment variable to
enable wallet payment methods (Google Pay, Apple Pay, Link) in Stripe
Checkout sessions
- Update `docs/STRIPE-SETUP.md` with configuration instructions
- Add diagnostic scripts for testing Stripe payment method setup

## Context
Investigation revealed that Google Pay and Link require the
`payment_method_configuration` parameter to be passed to Stripe Checkout
session creation. Without this, Stripe uses defaults which may not
include all enabled wallet methods.

Additional findings:
- Link visibility is subject to Stripe A/B testing (confirmed by Stripe
support)
- Google Pay requires Chrome/Chromium browser (Firefox not supported)

## Test plan
- [x] Tested checkout session creation with payment method config on
Android Chrome
- [x] Verified Google Pay and Link appear in checkout
- [x] Verified made-for-you checkout flow shows all payment methods

@coderabbitai ignore

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-09 16:40:38 +00:00
Andrew Beveridge ☄️andClaude Opus 4.5 bcceb94822 fix(ci): Move encoding worker restart to deploy-backend with correct zone (#254)
## Summary
- Fixed encoding worker not getting code updates on deploy
- The restart was in the wrong CI job with the wrong zone

## Root Cause
Two bugs in `ci.yml`:
1. **Wrong zone**: Used `us-central1-a` but encoding worker is in
`us-central1-c`
2. **Race condition**: Restart was in `deploy-infrastructure` which runs
in parallel with `deploy-backend` (wheel upload)

This meant the encoding worker restart would silently fail (wrong zone)
or run before the new wheel was uploaded (race condition).

## Changes
- Move restart step from `deploy-infrastructure` to `deploy-backend`
- Place it immediately after wheel upload to GCS
- Fix zone to `us-central1-c`

## Testing
- Manually verified encoding worker was at v0.99.7 while backend was at
v0.99.8
- Manually restarted with correct zone - now at v0.99.8
- CI-only change, no code tests affected

@coderabbitai ignore

---
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-09 11:14:29 -05:00
Andrew Beveridge ☄️andClaude Opus 4.5 87660483f1 fix(api): Fix made-for-you webhook handler skipping audio selection (#253)
## Summary
- Fixed critical bug where made-for-you paid orders skipped the audio
selection stage entirely
- The `_handle_made_for_you_order` webhook handler was not implementing
the made-for-you flow correctly
- Added 17 comprehensive unit tests to prevent regression

## Bug Details
Job ID 77488314 (paid made-for-you order) skipped audio selection and
went straight to lyrics review. Root cause: the webhook handler was
setting `made_for_you=False`, `auto_download=True`, and using the
customer email instead of admin email for job ownership.

## Changes
- **backend/api/routes/users.py**: Fixed `_handle_made_for_you_order`
to:
  - Set `made_for_you=True` flag
  - Set `user_email=ADMIN_EMAIL` (admin owns during processing)
  - Store `customer_email` for final delivery/ownership transfer
  - Set `auto_download=False` to pause at audio selection
  - Apply distribution settings (YouTube, Dropbox, GDrive, brand prefix)
  - Mask customer email in logs to prevent PII exposure
  - Transition job to `AWAITING_AUDIO_SELECTION` state

- **backend/tests/test_made_for_you.py**: Added 17 new unit tests
covering:
  - Job creation with correct flags and email handling
  - Distribution settings (defaults and user overrides)
  - Customer notes handling
  - Audio search vs YouTube URL flows

- **docs/LESSONS-LEARNED.md**: Added testing insight about webhook
handler coverage
- **docs/README.md**: Updated recent changes
- **pyproject.toml**: Version bump to 0.99.8

## Testing
- [x] All 61 made-for-you tests pass (5 skipped due to optional
dependency)
- [x] Full test suite passes (1452 tests)
- [x] Manual verification of fix

## Review
- [x] CodeRabbit CLI review completed locally
- [x] PII exposure issue fixed (masked customer email in logs)

@coderabbitai ignore

---
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-09 03:12:32 -05:00
Andrew Beveridge ☄️andClaude 5fd7d8ae55 feat(api): Add made-for-you audio selection flow (#252)
## Summary

Refactor made-for-you order processing to pause at audio selection like
regular search jobs, giving admin control over audio source selection
before processing.

- Made-for-you orders now pause at `AWAITING_AUDIO_SELECTION` for admin
review
- Admin receives notification email with link to select audio source
- Customer receives professional order confirmation email
- On completion, ownership transfers from admin to customer for delivery

## Changes

### Backend
- Add model fields: `made_for_you`, `customer_email`, `customer_notes`
to Job and JobCreate
- Add email templates: `send_made_for_you_order_confirmation()` and
`send_made_for_you_admin_notification()`
- Add email suppression for intermediate reminders on made-for-you jobs
(internal.py)
- Add ownership transfer on job completion (video_worker.py - not in
this commit, was in prior session)

### Tests
- Add `backend/tests/test_made_for_you.py` with 50+ test cases
- Add made-for-you email tests to `test_email_service.py`
- Add model field tests to `test_models.py`

### Documentation
- Update `docs/API.md` with full made-for-you order flow
- Add "Admin-Owned Jobs with Ownership Transfer" pattern to
`docs/LESSONS-LEARNED.md`
- Add recent changes entry to `docs/README.md`

## Testing

- [x] All Python files pass syntax validation
- [x] Frontend unit tests pass (150 tests)
- [x] Email methods validated via direct Python script
- [x] Model fields validated via direct Python script
- [ ] Backend pytest has pre-existing environment issue
(lyrics_transcriber import)

## Review

- [x] Local CodeRabbit review completed
- [x] Review feedback addressed (hardcoded URL → self.frontend_url)

@coderabbitai ignore

---
🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude <noreply@anthropic.com>
2026-01-09 04:01:22 +00:00
Andrew Beveridge ☄️andClaude Opus 4.5 dacd2b58ea fix(admin): Fix impersonation button and remove Make Admin from detail page (#251)
## Summary

- Fix impersonate button not working in admin dashboard - clicking did
nothing (no network request, no errors)
- Remove Make Admin/Remove Admin button from user detail page that
should have been removed in #249

## Changes

- **auth.ts**: Fixed broken import - `adminApi` is a separate export
from `api.ts`, not nested under the `api` object.
`api.adminApi.impersonateUser()` was calling
`undefined.impersonateUser()`
- **detail/page.tsx**: Removed Make Admin button, `handleToggleRole`
function, and unused `Shield`/`ShieldOff` imports

## Test plan

- [x] Unit tests pass (150 tests)
- [x] E2E impersonation tests pass (4 tests)
- [ ] Manual: Click impersonate button on admin users list → should
redirect to /app as that user
- [ ] Manual: Visit user detail page → Make Admin button should not
appear

🤖 Generated with [Claude Code](https://claude.ai/code)

@coderabbitai ignore

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-08 20:51:14 -05:00
Andrew Beveridge ☄️andClaude Opus 4.5 686b53a9d3 refactor(api): Rename 'done for you' to 'made for you' + enhance checkout UX (#250)
## Summary

- Rename all "done for you" / "done_for_you" / "DoneForYou" references
to "made for you" variants throughout the codebase
- Enhance the Stripe checkout experience with richer product details and
more payment options

## Changes

### Naming Refactor
- Rename `DONE_FOR_YOU_PACKAGE` → `MADE_FOR_YOU_PACKAGE`
- Rename endpoint `/done-for-you/checkout` → `/made-for-you/checkout`
- Rename `DoneForYouCheckoutRequest` → `MadeForYouCheckoutRequest`
- Update Stripe metadata `order_type` from `done_for_you` →
`made_for_you`
- Update all email subjects, log messages, and documentation

### Checkout UX Improvements
- Product name now shows song info: "Karaoke Video: Artist - Title"
- Description shows service details: "Professional 4K karaoke video with
perfectly synced lyrics, delivered to your email within 24 hours"
- Added product image (Nomad Karaoke logo)
- Enabled all payment methods (Apple Pay, Google Pay, Link, Cash App,
Klarna, etc.) by removing `payment_method_types=['card']` restriction

## Test plan

- [x] Tested checkout flow locally with production Stripe keys
- [x] Verified product image displays correctly
- [x] Verified additional payment methods appear (Cash App, Klarna
shown; Apple Pay/Google Pay show on compatible devices)
- [ ] Backend tests pass

<!-- @coderabbitai ignore -->

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-09 00:58:30 +00:00
Andrew Beveridge ☄️andClaude Opus 4.5 1110d02519 feat(admin): Add user impersonation feature (#249)
## Summary
- Add user impersonation feature for admins to view the app as any user
- Replace "Make Admin" button with "Impersonate" button in admin users
page
- Display amber impersonation banner when viewing as another user

## Changes
- **Backend**: Add `POST /api/admin/users/{email}/impersonate` endpoint
that creates a session token for the target user
- **Frontend Auth**: Add `startImpersonation` / `endImpersonation`
methods to auth store with token rollback on failure and nested
impersonation prevention
- **Admin UI**: Replace role toggle button with impersonate button
(disabled for self)
- **Banner Component**: New `ImpersonationBanner` component showing
"Viewing as {email}" with Stop button
- **Tests**: 7 backend unit tests + 4 E2E tests (2 skipped - require
stateful mocks)
- **Docs**: Updated API.md with new endpoint, added testing lesson to
LESSONS-LEARNED.md

## Testing
- [x] Backend unit tests pass (7/7 impersonation tests)
- [x] Frontend E2E tests pass (4 pass, 2 skipped)
- [x] Manual testing needed for full flow

## Review
- [x] CodeRabbit CLI review completed locally
- [x] Review feedback addressed (token rollback, nested impersonation
guard)

@coderabbitai ignore

---
🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-08 19:13:48 -05:00
Andrew Beveridge ☄️andClaude Opus 4.5 addd0e1ce5 fix(frontend): Admin dashboard crash + add test jobs toggle (#248)
## Summary

- Fixes React error #310 that was crashing the admin dashboard at
`/admin`
- Adds "Show Test Jobs" toggle in user menu for admins to view E2E test
data on `/app`
- Adds ESLint to CI to prevent similar bugs in the future

## Root Cause

PR #239 added `useAdminSettings()` hook **after** conditional returns in
`admin/layout.tsx`, violating React's Rules of Hooks. The hook was only
called on some renders, causing React to crash with "Rendered more hooks
than during the previous render".

## Changes

### Bug Fix
- `frontend/app/admin/layout.tsx` - Move `useAdminSettings()` before
conditional returns

### Feature: Test Jobs Toggle
- `frontend/components/auth/AuthStatus.tsx` - Add "Show Test Jobs"
toggle in admin section of user dropdown
- `frontend/app/app/page.tsx` - Pass `exclude_test` param based on admin
preference
- `frontend/lib/api.ts` - Add `exclude_test` param to `api.listJobs()`

### CI: ESLint for Hooks
- `frontend/eslint.config.mjs` - New ESLint config with
`react-hooks/rules-of-hooks: error`
- `frontend/package.json` - Add ESLint dependencies
- `.github/workflows/ci.yml` - Add `frontend-lint` job to CI gate

## Test plan

- [x] Build passes locally
- [x] ESLint passes (no hooks violations)
- [x] 68 unit tests pass
- [ ] Verify admin dashboard loads at
https://gen.nomadkaraoke.com/admin/
- [ ] Verify "Show Test Jobs" toggle appears in user menu for admins
- [ ] Verify toggling it shows/hides test jobs on /app page

<!-- @coderabbitai ignore -->

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-08 17:13:27 -05:00
Andrew Beveridge ☄️andClaude Opus 4.5 23e28489f6 fix(video-worker): Prevent duplicate Google Drive uploads causing cleanup failures (#247)
## Summary
- Fixed duplicate Google Drive uploads that were causing E2E test
cleanup to leave orphaned files
- The orchestrator path was uploading twice: once in
`VideoWorkerOrchestrator._run_gdrive_distribution()` and again in
`_handle_native_distribution()`
- This created duplicate files with different IDs, only one set got
saved for cleanup

## Changes
- Added check for existing `gdrive_files` in
`_handle_native_distribution()` to skip upload if orchestrator already
handled it
- Added logging when upload is skipped
- Documented the issue and solution in LESSONS-LEARNED.md

## Test plan
- [x] All backend tests pass (68 passed)
- [ ] E2E happy path test should no longer leave orphaned Google Drive
files

<!-- @coderabbitai ignore -->

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-08 17:06:44 -05:00
Andrew Beveridge ☄️andClaude Opus 4.5 42c304dcdf feat(multitenancy): Implement white-label B2B portal infrastructure (#241)
## Summary

Adds multi-tenant white-label portal infrastructure for B2B customers.
Vocal Star is the first tenant at `vocalstar.nomadkaraoke.com`.

## Changes

### Backend
- **Tenant Models** (`backend/models/tenant.py`): Pydantic models for
TenantConfig with branding, features, defaults, and auth settings
- **Tenant Service** (`backend/services/tenant_service.py`): GCS-backed
config loading with 5-min cache, signed URL generation for logos
- **Tenant API** (`backend/api/routes/tenant.py`): `GET
/api/tenant/config` and `GET /api/tenant/config/{tenant_id}` endpoints
- **Tenant Middleware** (`backend/middleware/tenant.py`): Extracts
tenant from X-Tenant-ID header, query param (dev only), or Host
subdomain
- **Auth Updates**: Email domain validation for tenant-restricted auth,
sender email override
- **Feature Enforcement**: Audio search endpoint checks
`features.audio_search`, returns 403 if disabled
- **Job Scoping**: Added `tenant_id` field to JobCreate

### Frontend
- **Tenant Store** (`frontend/lib/tenant.ts`): Zustand store with tenant
state, `useTenant()` hook, CSS variable application
- **TenantProvider** (`frontend/components/tenant-provider.tsx`):
Hydration-safe initialization via useEffect
- **TenantLogo** (`frontend/components/tenant-logo.tsx`): Dynamic logo
with fallback to Nomad Karaoke
- **Feature-Flagged UI**: Tabs conditionally rendered based on tenant
features, active tab sync
- **Locked Themes**: `defaults.locked_theme` hides theme selector and
enforces specific theme
- **Output Links**: Filtered based on distribution features

### Security
- Query param tenant detection disabled in production (prevents
spoofing)
- Strict subdomain patterns: only `{tenant}.nomadkaraoke.com` or
`{tenant}.gen.nomadkaraoke.com`
- PII masking in logs (`an***@vo***.com`)
- `is_active` check prevents inactive tenants from being used

### Documentation
- ARCHITECTURE.md: New Multitenancy section
- API.md: Tenant Config endpoints
- LESSONS-LEARNED.md: 3 new lessons on multitenancy patterns
- Archive: Comprehensive implementation document

### Setup
- `scripts/setup-vocalstar-tenant.py`: Uploads theme assets, creates
tenant/theme configs in GCS

## Vocal Star Configuration

- **Subdomain**: `vocalstar.nomadkaraoke.com`
- **Features**: File upload only (no audio search, no YouTube URL)
- **Distribution**: Download only (no YouTube/Dropbox/GDrive)
- **Theme**: Locked to "vocalstar" (yellow/blue)
- **Auth**: Restricted to `@vocal-star.com` and `@vocalstarmusic.com`
emails

## Testing

- [x] Frontend TypeScript build passes
- [x] CodeRabbit CLI review completed (3 cycles, all issues fixed)
- [x] Manual testing with `?tenant=vocalstar` query param

## Next Steps (post-merge)

1. Configure DNS: CNAME for `vocalstar.nomadkaraoke.com`
2. Update Cloudflare Pages for subdomain
3. Run setup script to upload Vocal Star assets to GCS
4. Test at `https://vocalstar.nomadkaraoke.com`

@coderabbitai ignore

---
🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-08 16:39:56 -05:00
Andrew Beveridge ☄️andClaude b39f37610c feat(frontend): Display brand code prefix on completed jobs (#243)
## Summary
- Display the brand code (e.g., "NOMAD-1194:") as a prefix on completed
job titles in the Recent Jobs UI
- Brand code is already stored in `state_data.brand_code` when jobs
complete with Dropbox distribution
- This change simply displays that existing data

## Changes
- `frontend/components/job/JobCard.tsx`: Add brand code prefix to job
title display

## Testing
- [x] Unit tests pass (128/128)
- [x] Manual review of code change

## Review
- [x] CodeRabbit CLI review completed locally
- [x] No issues found

@coderabbitai ignore

---
🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude <noreply@anthropic.com>
2026-01-08 15:31:53 -05:00
Andrew Beveridge ☄️andClaude Opus 4.5 6da758dc0c docs: Add zone availability notes for c4d instances (#246)
## Summary
- Documents zone availability lesson learned during c4d-highcpu-32
deployment
- Updates performance investigation status to Phase 2 Complete

## Changes
- `docs/LESSONS-LEARNED.md`: Added note about c4d instance zone
availability (us-central1-c works when us-central1-a/b have resource
exhaustion)
- `docs/archive/2026-01-08-performance-investigation.md`: Updated status
from "In Progress" to "Complete"

## Testing
- [x] Documentation only - no code changes

## Review
- [x] Docs-only change, no code review needed

@coderabbitai ignore

---
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-08 15:30:53 -05:00
Andrew Beveridge ☄️andClaude Opus 4.5 98ea1519a1 fix(infra): Use us-central1-c for encoding worker (c4d availability) (#245)
## Summary

Quick fix for encoding worker deployment failure - c4d-highcpu-32 is
unavailable in us-central1-a.

## Changes

- Added `ENCODING_WORKER_ZONE = us-central1-c` in config.py
- Updated encoding_worker_vm.py to use the new zone constant
- Deleted the terminated instance in us-central1-a

## Context

PR #244 merged but Pulumi failed with:
> The zone 'projects/nomadkaraoke/zones/us-central1-a' does not have
enough resources available

Tested: us-central1-c has c4d-highcpu-32 capacity.

@coderabbitai ignore

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-08 19:27:27 +00:00
131 changed files with 29759 additions and 3479 deletions

No files matched your search

+393
View File
@@ -0,0 +1,393 @@
# Plan: Admin Job Details Page
**Created:** 2026-01-09
**Branch:** feat/sess-20260109-1738-admin-job-details
**Status:** In Progress (Phase 1 Complete)
## Overview
The admin jobs list page links to `/admin/jobs/{job_id}` but that route doesn't exist - the detail page is at `/admin/jobs/detail` expecting `?id=` query params. This causes a 404 when clicking jobs.
We'll fix the routing and enhance the job detail page with comprehensive admin features: full job metadata display, file downloads with signed URLs, editable fields, and job stage reset capabilities.
**Note:** Due to Next.js static export constraints (the frontend deploys to Cloudflare Pages), we cannot use dynamic routes like `/admin/jobs/[jobId]`. Instead, we use query parameters: `/admin/jobs?id={job_id}`. The single page component handles both list and detail views based on the presence of the `id` query param.
## Requirements
### Must Have
- [x] Fix 404 - use query param routing at `/admin/jobs?id={job_id}` (dynamic routes not compatible with static export)
- [ ] Display all job metadata (source, user info, request_metadata, timeline)
- [ ] Stage-by-stage breakdown with timestamps and duration calculations
- [ ] Download links for all existing files (generate signed URLs)
- [ ] View worker logs with filtering by level/worker
- [ ] Restart job from beginning (reset to PENDING)
- [ ] Edit key job fields inline (artist, title, user_email, theme_id, etc.)
### Should Have
- [ ] Reset job to specific intermediate stages (audio selection, lyrics review)
- [ ] View/edit raw JSON fields (state_data, file_urls)
- [ ] Quick actions: send completion email, clear cache, impersonate user
### Nice to Have
- [ ] Job timeline visualization (Gantt-style or vertical timeline)
- [ ] Diff view when editing fields
- [ ] Audit log of admin changes
## Technical Approach
### Routing Fix (COMPLETED)
~~Create `/admin/jobs/[jobId]/page.tsx` as a dynamic route.~~ **UPDATE:** Dynamic routes are incompatible with Next.js `output: 'export'` (static site generation for Cloudflare Pages) without `generateStaticParams()`, which doesn't work for client components.
**Actual approach:** Enhanced `/admin/jobs/page.tsx` to handle both list and detail views:
- Uses `useSearchParams()` to detect `?id=` parameter
- Shows detail view when `selectedJobId` is present, list view otherwise
- Navigation uses `router.push(\`/admin/jobs?id=${job.job_id}\`)`
- Deleted old `/admin/jobs/detail/` directory
### Backend Enhancements
1. **New endpoint**: `GET /api/admin/jobs/{job_id}/files` - returns all files with signed download URLs
2. **New endpoint**: `PATCH /api/admin/jobs/{job_id}` - update editable fields (admin only)
3. **New endpoint**: `POST /api/admin/jobs/{job_id}/reset` - reset job to specific state
### Frontend Structure
The page will have collapsible sections:
1. **Header**: Job ID, status badge, artist/title, quick actions
2. **Overview Cards**: User, dates, progress, source info
3. **Stage Timeline**: Visual breakdown of each stage with times
4. **Files**: Downloadable links for all GCS files
5. **Logs**: Filterable worker logs
6. **Configuration**: Editable job settings
7. **Raw Data**: JSON views of state_data, file_urls, full job
### Job Reset Logic
Reset to specific states requires:
- Clearing downstream state_data keys
- Resetting status
- Optionally clearing associated files
- Adding timeline event for the reset
Valid reset targets:
| Target State | Clears | Use Case |
|--------------|--------|----------|
| PENDING | Everything except input | Full restart |
| AWAITING_AUDIO_SELECTION | Audio search results | Re-search for audio |
| AWAITING_REVIEW | Review data, screens, videos | Re-do lyrics review |
| AWAITING_INSTRUMENTAL_SELECTION | Instrumental selection, finals | Re-choose instrumental |
## Implementation Steps
Testing is integrated into each phase (following TDD/"write tests immediately after" guidance).
### Phase 1: Fix Routing (COMPLETED)
1. [x] ~~Create `/frontend/app/admin/jobs/[jobId]/page.tsx`~~ Enhanced `/admin/jobs/page.tsx` with query param routing
2. [x] Combined list and detail views in single component
3. [x] Use `useSearchParams()` to detect `?id=` parameter
4. [x] Delete `/frontend/app/admin/jobs/detail/` directory
5. [x] **E2E Test**: Added `admin-job-detail.spec.ts` with 9 tests (navigation, metadata, timeline, logs, error states, delete dialog, refresh)
6. [x] Verified: All 9 E2E tests pass, build succeeds
### Phase 2: Backend - File Downloads with Signed URLs
7. [ ] **Write tests first**: Add test file `backend/tests/test_admin_job_detail.py`
8. [ ] Add tests for `GET /api/admin/jobs/{job_id}/files` (see Testing Strategy)
9. [ ] Add `GET /api/admin/jobs/{job_id}/files` endpoint
10. [ ] Traverse job.file_urls recursively
11. [ ] Generate signed URLs for each GCS path
12. [ ] Return structured response with file metadata
13. [ ] Verify: `poetry run pytest backend/tests/test_admin_job_detail.py -v` passes
14. [ ] Add frontend API method `adminApi.getJobFiles(jobId)`
### Phase 3: Frontend - Enhanced File Display
15. [ ] Create "Files" accordion section with grouped downloads
16. [ ] Group by category (input, stems, lyrics, screens, videos, finals, packages)
17. [ ] Show file name, type, download button
18. [ ] Handle missing/unavailable files gracefully
19. [ ] **E2E Test**: Add files section test to `admin-job-detail.spec.ts`
20. [ ] Verify: `npm run test:e2e` passes
### Phase 4: Backend - Job Update Endpoint
21. [ ] **Write tests first**: Add tests for `PATCH /api/admin/jobs/{job_id}`
22. [ ] Add `PATCH /api/admin/jobs/{job_id}` endpoint
23. [ ] Define editable fields whitelist
24. [ ] Validate field values (e.g., status must be valid enum)
25. [ ] Log admin changes for audit trail
26. [ ] Verify: Backend tests pass
27. [ ] Add frontend API method `adminApi.updateJob(jobId, updates)`
### Phase 5: Frontend - Editable Fields
28. [ ] Create "Configuration" section with editable fields
29. [ ] Use inline edit pattern (click to edit, enter to save)
30. [ ] Fields: artist, title, user_email, theme_id, enable_cdg, enable_txt, enable_youtube_upload
31. [ ] Show validation errors inline
32. [ ] **E2E Test**: Add inline edit test to `admin-job-detail.spec.ts`
33. [ ] Verify: `npm run test:e2e` passes
### Phase 6: Backend - Job Reset Endpoint
34. [ ] **Write tests first**: Add tests for `POST /api/admin/jobs/{job_id}/reset`
35. [ ] Add `POST /api/admin/jobs/{job_id}/reset` endpoint
36. [ ] Accept `target_state` parameter
37. [ ] Implement reset logic for each target state
38. [ ] Clear appropriate state_data keys
39. [ ] Optionally trigger workers after reset
40. [ ] Verify: Backend tests pass
41. [ ] Add frontend API method `adminApi.resetJob(jobId, targetState)`
### Phase 7: Frontend - Reset Actions
42. [ ] Add "Reset Job" dropdown/menu in header
43. [ ] Show available reset targets based on current state
44. [ ] Confirm dialog explaining what will be cleared
45. [ ] Show success/error toast after reset
46. [ ] **E2E Test**: Add reset confirmation dialog test
47. [ ] Verify: `npm run test:e2e` passes
### Phase 8: Enhanced Stage Timeline
48. [ ] Parse timeline events to calculate stage durations
49. [ ] Display stages as cards or timeline items
50. [ ] Show duration for each stage
51. [ ] Highlight current/blocking stages
52. [ ] **E2E Test**: Add timeline display test
### Phase 9: Final Verification
53. [ ] Run full backend test suite: `make test-backend`
54. [ ] Run full frontend test suite: `cd frontend && npm run test:all`
55. [ ] Manual production testing checklist (see Testing Strategy)
56. [ ] Verify CI passes on PR
## Files to Create/Modify
| File | Action | Description |
|------|--------|-------------|
| `frontend/app/admin/jobs/[jobId]/page.tsx` | Create | Dynamic route for job detail |
| `frontend/app/admin/jobs/detail/` | Delete | Remove old query-param based route |
| `backend/api/routes/admin.py` | Modify | Add files, update, reset endpoints |
| `frontend/lib/api.ts` | Modify | Add adminApi methods for new endpoints |
| `backend/tests/test_admin_job_detail.py` | Create | Backend unit tests for new endpoints |
| `frontend/e2e/regression/admin-job-detail.spec.ts` | Create | Frontend E2E regression tests |
| `frontend/e2e/fixtures/test-helper.ts` | Modify | Add admin auth helper if needed |
## Testing Strategy
Based on `docs/TESTING.md` guidelines, this feature requires:
### Test Types Required
| Type | Location | Purpose |
|------|----------|---------|
| Backend Unit Tests | `backend/tests/test_admin_job_detail.py` | Test new API endpoints |
| Frontend E2E Regression | `frontend/e2e/regression/admin-job-detail.spec.ts` | Test UI flows with mocked API |
| Manual Production E2E | N/A | Final validation on staging/prod |
### Backend Unit Tests (`backend/tests/test_admin_job_detail.py`)
**Mocking approach:** Mock Firestore and GCS (following existing patterns in `backend/tests/conftest.py`). Do NOT mock our own code - test the real `JobManager` and `StorageService` logic.
**Test cases for `GET /api/admin/jobs/{job_id}/files`:**
```python
def test_get_job_files_returns_signed_urls_for_all_files():
"""Test that all files in file_urls get signed URLs."""
def test_get_job_files_handles_nested_file_urls():
"""Test recursive traversal of stems.instrumental_clean, etc."""
def test_get_job_files_handles_missing_files_gracefully():
"""Test files that don't exist in GCS are omitted or marked."""
def test_get_job_files_requires_admin():
"""Test non-admin gets 403."""
def test_get_job_files_returns_404_for_missing_job():
"""Test invalid job_id returns 404."""
```
**Test cases for `PATCH /api/admin/jobs/{job_id}`:**
```python
def test_update_job_allows_editable_fields():
"""Test artist, title, user_email, theme_id can be updated."""
def test_update_job_rejects_non_editable_fields():
"""Test job_id, created_at, etc. cannot be updated."""
def test_update_job_validates_status_enum():
"""Test invalid status value returns 422."""
def test_update_job_validates_theme_id_exists():
"""Test non-existent theme_id returns 422."""
def test_update_job_requires_admin():
"""Test non-admin gets 403."""
def test_update_job_returns_updated_job():
"""Test response includes updated job data."""
```
**Test cases for `POST /api/admin/jobs/{job_id}/reset`:**
```python
def test_reset_to_pending_clears_all_state_data():
"""Test full reset clears everything except input."""
def test_reset_to_audio_selection_clears_search_results():
"""Test audio selection reset clears audio_search_results."""
def test_reset_to_awaiting_review_clears_review_data():
"""Test review reset clears screens, videos, review data."""
def test_reset_to_instrumental_selection_clears_finals():
"""Test instrumental reset clears encoding results."""
def test_reset_adds_timeline_event():
"""Test reset adds admin action to timeline."""
def test_reset_invalid_target_returns_422():
"""Test invalid target_state returns validation error."""
def test_reset_requires_admin():
"""Test non-admin gets 403."""
def test_reset_from_complete_to_pending_works():
"""Test can reset completed job back to start."""
```
### Frontend E2E Regression Tests (`frontend/e2e/regression/admin-job-detail.spec.ts`)
**Mocking approach:** Use Playwright route interception to mock API responses (following patterns in `frontend/e2e/fixtures/test-helper.ts`).
```typescript
import { test, expect } from '@playwright/test';
import { setupApiFixtures, setAdminAuthToken } from '../fixtures/test-helper';
test.describe('Admin Job Detail Page', () => {
test.beforeEach(async ({ page }) => {
await setAdminAuthToken(page);
});
test('navigates from jobs list to detail page', async ({ page }) => {
// Mock jobs list and single job endpoints
await page.route('**/api/admin/jobs', route => route.fulfill({
json: [{ job_id: 'test123', status: 'complete', artist: 'Test', title: 'Song' }]
}));
await page.route('**/api/jobs/test123', route => route.fulfill({
json: { job_id: 'test123', status: 'complete', artist: 'Test', title: 'Song' }
}));
await page.goto('/admin/jobs');
await page.click('text=test123');
await expect(page).toHaveURL('/admin/jobs/test123');
await expect(page.getByText('Job test123')).toBeVisible();
});
test('displays all job metadata sections', async ({ page }) => {
// Test overview cards, timeline, logs accordion, etc.
});
test('files section shows downloadable links', async ({ page }) => {
// Mock files endpoint, verify download buttons appear
});
test('edit field inline and save', async ({ page }) => {
// Click edit, change value, press Enter, verify PATCH called
});
test('reset job shows confirmation dialog', async ({ page }) => {
// Click reset, verify dialog, confirm, verify POST called
});
test('handles API errors gracefully', async ({ page }) => {
// Mock 500 response, verify error toast shown
});
});
```
### Test File Organization
```
backend/tests/
├── test_admin_job_detail.py # NEW - all backend tests for this feature
├── test_admin_api.py # Existing admin tests (keep separate)
└── conftest.py # Shared fixtures
frontend/e2e/
├── fixtures/
│ ├── test-helper.ts # Add setAdminAuthToken helper
│ └── mock-responses.ts # Add admin job detail mocks
└── regression/
└── admin-job-detail.spec.ts # NEW - E2E regression tests
```
### Mocking Guidelines
**Backend - What to mock:**
- `StorageService.generate_signed_url()` - return predictable test URLs
- `StorageService.file_exists()` - control which files "exist"
- Firestore operations via existing `mock_firestore` fixture
**Backend - What NOT to mock:**
- `JobManager` logic - test the real reset/update logic
- Validation logic - test real Pydantic validation
- Authorization checks - test real `require_admin` dependency
**Frontend - What to mock:**
- All API responses via Playwright route interception
- Time (if testing token expiry)
**Frontend - What NOT to mock:**
- React component behavior
- User interactions (click, type, etc.)
### CI Requirements
This feature will be validated by existing CI checks:
- `backend-unit-tests` - Must pass (includes new `test_admin_job_detail.py`)
- `frontend-e2e-smoke` - Must pass (includes new `admin-job-detail.spec.ts`)
- `frontend-build` - Must pass (verifies new page compiles)
### Running Tests Locally
```bash
# Backend tests only (for this feature)
poetry run pytest backend/tests/test_admin_job_detail.py -v
# All backend tests
make test-backend
# Frontend E2E regression (includes new tests)
cd frontend && npm run test:e2e
# Single E2E test file
cd frontend && npx playwright test e2e/regression/admin-job-detail.spec.ts
# With browser visible for debugging
cd frontend && npx playwright test e2e/regression/admin-job-detail.spec.ts --headed
```
### Manual Production Testing Checklist
After deployment, manually verify on production:
- [ ] Navigate `/admin/jobs` → click job → lands on `/admin/jobs/{id}` (not 404)
- [ ] All file download links work (valid signed URLs)
- [ ] Edit artist/title → refresh → changes persisted
- [ ] Reset job to pending → job status shows "pending"
- [ ] Logs section loads and filters work
- [ ] Error states handled (invalid job ID shows friendly error)
## Open Questions
1. [ ] Should we keep the old `/admin/jobs/detail?id=` route for backwards compatibility, or delete it entirely?
- **Recommendation**: Delete it. No external links depend on it.
2. [ ] Should job reset delete GCS files or just clear state_data references?
- **Recommendation**: Clear state_data only. Files can be useful for debugging. Add a separate "Delete Files" action if needed.
3. [ ] Should edits be immediately saved or require explicit "Save" button?
- **Recommendation**: Inline edit with Enter to save, Escape to cancel. Show loading indicator during save.
## Rollback Plan
If issues arise:
1. Routing: Can revert to query-param routing by restoring `detail/page.tsx` and updating navigation
2. Backend: New endpoints are additive, won't affect existing functionality
3. Reset feature: Admin-only, can be disabled by removing endpoint if problematic
## Notes
- The existing detail page has good foundational code - we're enhancing rather than replacing
- Signed URLs expire (default 60-120 min) - consider caching or refresh mechanism for long sessions
- Job reset is powerful - consider adding confirmation dialogs and logging
+317
View File
@@ -0,0 +1,317 @@
# Plan: White Label B2B Karaoke Portals
**Created:** 2026-01-08
**Branch:** feat/sess-20260108-0358-white-label-portal
**Status:** Draft
## Overview
Add multi-tenant white label portal capability to karaoke-gen, enabling B2B customers like Vocal Star to access a customized version of the generator app on their own subdomain with their branding, theme, and restricted feature set.
**First customer: Vocal Star**
- Subdomain: `vocalstar.nomadkaraoke.com`
- Workflow: Upload original + instrumental audio (no audio search)
- Theme: Custom Vocal Star karaoke theme (already exists as JSON)
- Distribution: Download only (no Dropbox/GDrive/YouTube)
- Auth: Magic link for `@vocal-star.com` / `@vocalstarmusic.com` domains, plus fixed API token option
## Requirements
### Functional Requirements
- [ ] Tenant identification via subdomain (e.g., `vocalstar.nomadkaraoke.com`)
- [ ] Per-tenant frontend branding (logo, colors, metadata)
- [ ] Per-tenant feature flags (hide audio search, hide distribution options)
- [ ] Per-tenant default theme (always use Vocal Star theme)
- [ ] Per-tenant allowed email domains for magic link auth
- [ ] Per-tenant fixed API token support (for automation)
- [ ] Jobs scoped to tenant (Vocal Star users only see Vocal Star jobs)
- [ ] Users scoped to tenant
### Non-Functional Requirements
- [ ] Minimal code duplication - single codebase serves all tenants
- [ ] Easy to add new tenants via config, not code changes
- [ ] Graceful fallback - default to Nomad Karaoke if no tenant match
- [ ] No performance impact on existing single-tenant flow
## Technical Approach
### Architecture Decision: Config-Driven Multi-Tenancy
Rather than building a full tenant management system (overkill for ~1 customer/year), we'll use a **config-driven approach**:
1. **Tenant configs stored in GCS** at `tenants/{tenant_id}/config.json`
2. **Frontend detects subdomain** and fetches tenant config from API
3. **Backend middleware** extracts tenant from request and applies config
4. **Firestore collections** get `tenant_id` field for isolation
This approach:
- Requires no database migrations for new tenants
- Configs can be managed via simple JSON files
- Easy to test locally with query param override (`?tenant=vocalstar`)
- Can evolve to admin UI later if needed
### Tenant Config Schema
```json
{
"id": "vocalstar",
"name": "Vocal Star",
"subdomain": "vocalstar.nomadkaraoke.com",
"branding": {
"logo_url": "gs://karaoke-gen-storage/tenants/vocalstar/logo.png",
"primary_color": "#ffff00",
"secondary_color": "#006CF9",
"favicon_url": "gs://karaoke-gen-storage/tenants/vocalstar/favicon.ico",
"site_title": "Vocal Star Karaoke Generator"
},
"features": {
"audio_search": false,
"file_upload": true,
"youtube_upload": false,
"dropbox_upload": false,
"gdrive_upload": false,
"theme_selection": false
},
"defaults": {
"theme_id": "vocalstar",
"distribution_mode": "download_only"
},
"auth": {
"allowed_email_domains": ["vocal-star.com", "vocalstarmusic.com"],
"fixed_tokens": ["<will be in Secret Manager>"]
}
}
```
### Key Implementation Details
#### 1. Subdomain Detection (Frontend)
- Next.js middleware checks `request.headers.host`
- If subdomain matches tenant, store tenant ID in cookie/context
- Fetch `/api/tenant/config` to get branding/features
- Apply CSS variables dynamically for colors
- Swap logo component based on config
#### 2. Tenant Middleware (Backend)
- FastAPI middleware extracts tenant from:
- `X-Tenant-ID` header (set by frontend)
- Or subdomain from `Host` header
- Or query param `?tenant=` (dev only)
- Attaches `tenant_id` to request state
- Tenant config loaded from GCS (cached 5 min like themes)
#### 3. Auth Enhancement
- `AuthService.validate_token_full()` already returns `user_email`
- Add tenant validation: check if user's email domain is in tenant's allowed list
- Support fixed tokens per tenant (stored in `auth_tokens` with `tenant_id`)
- Magic links include tenant context for proper redirect
#### 4. Data Isolation
- Add `tenant_id: Optional[str]` to User and Job models
- Default to `None` for existing Nomad Karaoke users (backwards compatible)
- Query filters: `where('tenant_id', '==', tenant_id or None)`
- No schema migration needed - new field, optional
#### 5. Theme Integration
- Upload Vocal Star theme to `themes/vocalstar/` in GCS
- Upload assets (backgrounds, fonts) to `themes/vocalstar/assets/`
- Tenant config specifies `default_theme_id: "vocalstar"`
- When `theme_selection: false`, UI hides theme picker and uses default
## Implementation Steps
### Phase 1: Backend Tenant Foundation (Day 1-2)
1. [ ] **Create tenant model and config loader**
- Create `backend/models/tenant.py` with `TenantConfig`, `TenantBranding`, `TenantFeatures`
- Create `backend/services/tenant_service.py` with GCS config loading and caching
- Add `GET /api/tenant/config` endpoint (unauthenticated, returns public config)
- Add `GET /api/tenant/config/{tenant_id}` for explicit tenant fetch
2. [ ] **Add tenant middleware**
- Create `backend/api/middleware/tenant.py`
- Extract tenant from subdomain or header
- Attach to `request.state.tenant_id` and `request.state.tenant_config`
- Add `get_tenant()` dependency for routes
3. [ ] **Update data models**
- Add `tenant_id: Optional[str] = None` to `User` model
- Add `tenant_id: Optional[str] = None` to `Job` model
- Update Firestore indexes in Pulumi for tenant-scoped queries
4. [ ] **Update auth for tenant awareness**
- Modify `AuthService` to validate email domain against tenant config
- Add tenant context to magic link generation
- Support per-tenant fixed tokens in `auth_tokens` collection
### Phase 2: Upload Vocal Star Theme (Day 2)
5. [ ] **Prepare Vocal Star theme for GCS**
- Convert local paths in `karaoke-prep-styles-vocalstar.json` to GCS paths
- Upload background images to `themes/vocalstar/assets/`
- Upload Oswald font to `themes/vocalstar/assets/`
- Upload `style_params.json` to `themes/vocalstar/`
- Create preview image and upload to `themes/vocalstar/preview.png`
- Add Vocal Star to `themes/_metadata.json`
6. [ ] **Create Vocal Star tenant config**
- Create `tenants/vocalstar/config.json` in GCS
- Upload Vocal Star logo to `tenants/vocalstar/logo.png`
- Upload favicon to `tenants/vocalstar/favicon.ico`
### Phase 3: Frontend Tenant Support (Day 3-4)
7. [ ] **Add tenant context provider**
- Create `frontend/lib/tenant.ts` with tenant config types
- Create `frontend/hooks/useTenant.ts` for tenant state
- Create `TenantProvider` component that fetches config on mount
- Detect subdomain in `_app.tsx` or middleware
8. [ ] **Dynamic branding**
- Create `TenantLogo` component that renders tenant or default logo
- Update `globals.css` to support CSS variable overrides
- Add `applyTenantColors()` function to set CSS variables from config
- Update page metadata (title, favicon) from tenant config
9. [ ] **Feature-flagged UI**
- Wrap audio search in `{tenant.features.audio_search && ...}`
- Wrap theme selector in `{tenant.features.theme_selection && ...}`
- Wrap distribution options based on tenant features
- Show simplified form for Vocal Star (just file upload fields)
10. [ ] **Update magic link flow**
- Pass tenant context when requesting magic link
- Magic link redirect goes to tenant subdomain
- Verify endpoint extracts tenant from link context
### Phase 4: Backend Feature Enforcement (Day 4-5)
11. [ ] **Enforce tenant features in API**
- Audio search endpoint: return 403 if `audio_search: false`
- File upload: check `file_upload: true`
- Distribution settings: ignore/error if disabled features requested
- Theme selection: use default if `theme_selection: false`
12. [ ] **Job creation with tenant context**
- `JobCreate` handler sets `tenant_id` from request state
- Distribution config respects tenant defaults
- Theme defaults to tenant's default theme
13. [ ] **Query scoping**
- Update `JobManager.get_jobs()` to filter by tenant_id
- Update `UserService` queries to include tenant_id
- Admin endpoints bypass tenant filter (see all tenants)
### Phase 5: Infrastructure & Deployment (Day 5-6)
14. [ ] **DNS setup**
- Add `vocalstar.nomadkaraoke.com` CNAME to Cloudflare
- Configure Cloudflare Pages to accept wildcard subdomain
- Add SSL certificate for subdomain
15. [ ] **Backend CORS update**
- Add `vocalstar.nomadkaraoke.com` to allowed origins
- Or use pattern matching for `*.nomadkaraoke.com`
16. [ ] **Pulumi updates**
- Add Firestore indexes for tenant_id queries
- Add any new secrets (tenant fixed tokens)
### Phase 6: Testing & Documentation (Day 6-7)
17. [ ] **Testing**
- Unit tests for TenantService config loading
- Unit tests for tenant middleware
- E2E test for Vocal Star flow (upload audio, generate, download)
- Test magic link works for @vocal-star.com email
18. [ ] **Documentation**
- Update CLAUDE.md with tenant info
- Create `docs/WHITE-LABEL.md` with tenant setup guide
- Document how to add new tenants
## Files to Create/Modify
| File | Action | Description |
|------|--------|-------------|
| `backend/models/tenant.py` | Create | Tenant config models |
| `backend/services/tenant_service.py` | Create | Tenant config loading/caching |
| `backend/api/routes/tenant.py` | Create | Tenant config API endpoint |
| `backend/api/middleware/tenant.py` | Create | Tenant extraction middleware |
| `backend/api/dependencies.py` | Modify | Add `get_tenant()` dependency |
| `backend/models/user.py` | Modify | Add `tenant_id` field |
| `backend/models/job.py` | Modify | Add `tenant_id` field |
| `backend/services/auth_service.py` | Modify | Tenant email domain validation |
| `backend/services/user_service.py` | Modify | Tenant-aware user queries |
| `backend/services/job_manager.py` | Modify | Tenant-aware job queries |
| `backend/api/routes/file_upload.py` | Modify | Tenant feature enforcement |
| `backend/api/routes/audio_search.py` | Modify | Tenant feature enforcement |
| `backend/main.py` | Modify | Add tenant middleware |
| `frontend/lib/tenant.ts` | Create | Tenant types and API |
| `frontend/hooks/useTenant.ts` | Create | Tenant context hook |
| `frontend/components/TenantProvider.tsx` | Create | Tenant context provider |
| `frontend/components/TenantLogo.tsx` | Create | Dynamic logo component |
| `frontend/app/layout.tsx` | Modify | Add TenantProvider |
| `frontend/app/globals.css` | Modify | CSS variable support for tenant colors |
| `frontend/app/app/page.tsx` | Modify | Feature-flag UI sections |
| `infrastructure/__main__.py` | Modify | Add tenant Firestore indexes |
| `docs/WHITE-LABEL.md` | Create | Tenant setup documentation |
## Testing Strategy
### Unit Tests
- `TenantService`: Config loading, caching, validation
- `TenantMiddleware`: Subdomain extraction, header extraction
- `AuthService`: Tenant email domain validation
- `JobManager`: Tenant-scoped queries
### Integration Tests (Emulator)
- Create job with tenant context
- Query jobs filtered by tenant
- Auth with tenant-allowed email domain
- Auth rejection for wrong email domain
### E2E Tests
- Vocal Star happy path: Upload audio files, review lyrics, download video
- Auth flow: Magic link for @vocal-star.com, verify redirect to subdomain
- Feature hiding: Verify audio search not shown on Vocal Star portal
## Open Questions
- [x] **Q: Should tenant configs be in GCS or Firestore?**
A: GCS - simpler, matches theme pattern, easy to edit JSON directly
- [x] **Q: How to handle localhost development for specific tenant?**
A: Query param override `?tenant=vocalstar` for local testing
- [x] **Q: Should admin portal be tenant-aware?**
A: No - admins see all tenants. Admin routes bypass tenant filter.
- [x] **Q: Do we need tenant-specific email sender identity?**
A: Yes - use `{tenant}@nomadkaraoke.com` (e.g., `vocalstar@nomadkaraoke.com`). Catchall is configured.
- [x] **Q: Vocal Star logo and favicon - do you have these assets?**
A: Logo provided as `vocalstar-logo.jpg` - yellow star, white text on black. Will convert to PNG with transparency for web use.
## Rollback Plan
Since this is additive (new optional `tenant_id` field), rollback is straightforward:
1. Revert frontend to not check tenant
2. Revert backend middleware to not extract tenant
3. Existing data unaffected (tenant_id = null = Nomad Karaoke)
4. No schema migration to reverse
For DNS: Simply remove CNAME record if needed.
## Success Criteria
- [ ] Vocal Star user can access `vocalstar.nomadkaraoke.com`
- [ ] Portal shows Vocal Star branding (logo, colors)
- [ ] Audio search is hidden; only file upload available
- [ ] Theme is locked to Vocal Star style
- [ ] Distribution options hidden; download only
- [ ] Magic link works for @vocal-star.com emails
- [ ] Fixed API token works for automation
- [ ] Generated videos use Vocal Star theme
- [ ] Nomad Karaoke portal unchanged at gen.nomadkaraoke.com
+36 -11
View File
@@ -67,6 +67,29 @@ jobs:
# FRONTEND TESTS (PRs only - main skips tests)
# ============================================
frontend-lint:
name: "Frontend - Lint (Rules of Hooks)"
runs-on: ubuntu-latest
needs: changes
if: github.ref != 'refs/heads/main' && needs.changes.outputs.frontend == 'true'
steps:
- uses: actions/checkout@v4
- name: Setup Node.js with caching
uses: actions/setup-node@v4
with:
node-version: '20'
cache: 'npm'
cache-dependency-path: frontend/package-lock.json
- name: Install dependencies
working-directory: frontend
run: npm ci --legacy-peer-deps
- name: Run ESLint
working-directory: frontend
run: npm run lint
frontend-unit-tests:
name: "Frontend - Unit Tests"
runs-on: ubuntu-latest
@@ -655,12 +678,14 @@ jobs:
runs-on: ubuntu-latest
# Note: frontend-e2e-full is optional (requires 'e2e' label) so not included here
# frontend-e2e-smoke IS required - fast smoke tests catch critical regressions
needs: [frontend-unit-tests, frontend-e2e-smoke, frontend-build, package-unit-tests, package-integration-tests, backend-unit-tests, backend-emulator-tests, backend-lint]
# frontend-lint IS required - catches React hooks violations that cause runtime crashes
needs: [frontend-lint, frontend-unit-tests, frontend-e2e-smoke, frontend-build, package-unit-tests, package-integration-tests, backend-unit-tests, backend-emulator-tests, backend-lint]
if: github.ref != 'refs/heads/main' && always()
steps:
- name: Check results
run: |
results=(
"${{ needs.frontend-lint.result }}"
"${{ needs.frontend-unit-tests.result }}"
"${{ needs.frontend-e2e-smoke.result }}"
"${{ needs.frontend-build.result }}"
@@ -992,7 +1017,14 @@ jobs:
# Upload to GCS (GCE worker downloads latest at job start)
gsutil cp "$WHEEL_FILE" gs://karaoke-gen-storage-${{ env.PROJECT_ID }}/wheels/
echo "✅ Wheel uploaded - GCE worker will pick up changes on next job"
echo "✅ Wheel uploaded to GCS"
- name: Restart GCE Encoding Worker
run: |
echo "🔄 Restarting encoding worker to pick up new wheel..."
gcloud compute ssh encoding-worker --zone=us-central1-c --project=nomadkaraoke \
--command="sudo systemctl restart encoding-worker" || true
echo "✅ Encoding worker restart triggered"
- name: Configure Docker for Artifact Registry
run: gcloud auth configure-docker ${{ env.REGISTRY }} --quiet
@@ -1139,8 +1171,8 @@ jobs:
--concurrency 1 \
--max-instances 50 \
--min-instances 4 \
--set-env-vars "GOOGLE_CLOUD_PROJECT=${{ env.PROJECT_ID }},GCS_BUCKET_NAME=karaoke-gen-storage-${{ env.PROJECT_ID }},FIRESTORE_COLLECTION=jobs,ENVIRONMENT=production,AUDIO_SEPARATOR_API_URL=https://nomadkaraoke--audio-separator-api.modal.run,KARAOKE_GEN_VERSION=$VERSION,DEFAULT_DROPBOX_PATH=/MediaUnsynced/Karaoke/Tracks-Organized,DEFAULT_GDRIVE_FOLDER_ID=1laRKAyxo0v817SstfM5XkpbWiNKNAMSX,ENABLE_CLOUD_TASKS=true,CLOUD_RUN_SERVICE_URL=https://api.nomadkaraoke.com,GCP_REGION=us-central1,DEFAULT_ENABLE_YOUTUBE_UPLOAD=true,DEFAULT_BRAND_PREFIX=NOMAD,USE_GCE_ENCODING=true,USE_GCE_PREVIEW_ENCODING=true" \
--set-secrets "AUDIOSHAKE_API_TOKEN=audioshake-api-key:latest,GENIUS_API_TOKEN=genius-api-key:latest,SPOTIFY_COOKIE_SP_DC=spotify-cookie:latest,RAPIDAPI_KEY=rapidapi-key:latest,DEFAULT_DISCORD_WEBHOOK_URL=discord-releases-webhook:latest,ADMIN_TOKENS=admin-tokens:latest,RED_API_KEY=red-api-key:latest,RED_API_URL=red-api-url:latest,OPS_API_KEY=ops-api-key:latest,OPS_API_URL=ops-api-url:latest,FLACFETCH_API_URL=flacfetch-api-url:latest,FLACFETCH_API_KEY=flacfetch-api-key:latest,SENDGRID_API_KEY=sendgrid-api-key:latest,STRIPE_SECRET_KEY=stripe-secret-key:latest,STRIPE_WEBHOOK_SECRET=stripe-webhook-secret:latest,LANGFUSE_PUBLIC_KEY=langfuse-public-key:latest,LANGFUSE_SECRET_KEY=langfuse-secret-key:latest,LANGFUSE_HOST=langfuse-host:latest,ENCODING_WORKER_URL=encoding-worker-url:latest,ENCODING_WORKER_API_KEY=encoding-worker-api-key:latest"
--set-env-vars "GOOGLE_CLOUD_PROJECT=${{ env.PROJECT_ID }},GCS_BUCKET_NAME=karaoke-gen-storage-${{ env.PROJECT_ID }},FIRESTORE_COLLECTION=jobs,ENVIRONMENT=production,AUDIO_SEPARATOR_API_URL=https://nomadkaraoke--audio-separator-api.modal.run,KARAOKE_GEN_VERSION=$VERSION,DEFAULT_DROPBOX_PATH=/MediaUnsynced/Karaoke/Tracks-Organized,DEFAULT_GDRIVE_FOLDER_ID=1laRKAyxo0v817SstfM5XkpbWiNKNAMSX,ENABLE_CLOUD_TASKS=true,CLOUD_RUN_SERVICE_URL=https://api.nomadkaraoke.com,GCP_REGION=us-central1,DEFAULT_ENABLE_YOUTUBE_UPLOAD=true,DEFAULT_BRAND_PREFIX=NOMAD,USE_GCE_ENCODING=true,USE_GCE_PREVIEW_ENCODING=true,ENABLE_PUSH_NOTIFICATIONS=true" \
--set-secrets "AUDIOSHAKE_API_TOKEN=audioshake-api-key:latest,GENIUS_API_TOKEN=genius-api-key:latest,SPOTIFY_COOKIE_SP_DC=spotify-cookie:latest,RAPIDAPI_KEY=rapidapi-key:latest,DEFAULT_DISCORD_WEBHOOK_URL=discord-releases-webhook:latest,ADMIN_TOKENS=admin-tokens:latest,RED_API_KEY=red-api-key:latest,RED_API_URL=red-api-url:latest,OPS_API_KEY=ops-api-key:latest,OPS_API_URL=ops-api-url:latest,FLACFETCH_API_URL=flacfetch-api-url:latest,FLACFETCH_API_KEY=flacfetch-api-key:latest,SENDGRID_API_KEY=sendgrid-api-key:latest,STRIPE_SECRET_KEY=stripe-secret-key:latest,STRIPE_WEBHOOK_SECRET=stripe-webhook-secret:latest,LANGFUSE_PUBLIC_KEY=langfuse-public-key:latest,LANGFUSE_SECRET_KEY=langfuse-secret-key:latest,LANGFUSE_HOST=langfuse-host:latest,ENCODING_WORKER_URL=encoding-worker-url:latest,ENCODING_WORKER_API_KEY=encoding-worker-api-key:latest,VAPID_PUBLIC_KEY=vapid-public-key:latest,VAPID_PRIVATE_KEY=vapid-private-key:latest"
- name: Verify deployment and version
run: |
@@ -1302,13 +1334,6 @@ jobs:
# Pulumi state is authoritative since infrastructure is only managed via Pulumi
pulumi up --yes --skip-preview --stack nomadkaraoke/karaoke-gen-infrastructure/prod
- name: Restart GCE Encoding Worker
run: |
echo "🔄 Restarting encoding worker to pick up new code..."
gcloud compute ssh encoding-worker --zone=us-central1-a --project=nomadkaraoke \
--command="sudo systemctl restart encoding-worker" || true
echo "✅ Encoding worker restart triggered"
- name: Summary
if: success()
run: |
+21 -6
View File
@@ -16,6 +16,7 @@
| Current status | `docs/README.md` |
| Architecture | `docs/ARCHITECTURE.md` |
| Dev setup & testing | `docs/DEVELOPMENT.md` |
| **Testing & code quality** | `docs/TESTING.md` |
| API reference | `docs/API.md` |
| Past learnings | `docs/LESSONS-LEARNED.md` |
| **Product communication** | `docs/PRODUCT-COMMUNICATION-GUIDE.md` |
@@ -36,15 +37,29 @@
- Create PR with summary, changes, testing info
- Merge only after CI passes
### Testing (Required Before Commit)
```bash
# Backend (10 min timeout, limit output)
make test 2>&1 | tail -n 500
### Testing (Required)
**Before planning any implementation work**, read `docs/TESTING.md` and ensure your plan includes a thorough testing strategy that follows the guidance there. This includes:
- Which test types are needed (unit, integration, E2E)
- Where tests should be placed
- What mocking approach to use
- Coverage expectations
- **Production E2E tests for user-facing features** - see below
# Frontend
cd frontend && npm run test:all 2>&1 | tail -n 200
**Critical:** If your plan includes "Manual Testing" steps, convert them to automated Playwright E2E tests. Production E2E tests (in `frontend/e2e/production/`) are valuable even if only run once after deployment - they codify expected behavior and verify the deployed code works. See `docs/TESTING.md` for details.
**Before committing**, run all tests:
```bash
make test 2>&1 | tail -n 500
```
This single command:
- Installs dependencies automatically (backend + frontend)
- Runs all backend tests (unit, integration, emulator)
- Runs all frontend tests (Jest unit + Playwright E2E)
- Takes ~5-10 minutes
**All tests must pass.** Don't dismiss failures as "pre-existing" - investigate and fix them.
### Version Bumping
- Bump `tool.poetry.version` in `pyproject.toml` for code changes
- Skip for docs-only changes
+38 -12
View File
@@ -1,34 +1,50 @@
# Makefile for karaoke-gen project
# Run `make help` to see available commands
.PHONY: help test test-unit test-backend test-integration test-e2e test-all lint clean emulators-start emulators-stop
.PHONY: help install install-backend install-frontend test test-unit test-backend test-e2e test-frontend test-all lint clean emulators-start emulators-stop
# Default target
help:
@echo "Available commands:"
@echo " make test - Run all tests (unit + backend + emulator-based)"
@echo " make test-unit - Run unit tests only (karaoke_gen)"
@echo " make test-backend - Run backend unit tests only"
@echo " make test-e2e - Run E2E tests with emulators (starts/stops automatically)"
@echo " make test-all - Alias for 'make test'"
@echo " make test - Run ALL tests (backend + frontend, installs deps automatically)"
@echo " make test-backend - Run backend tests only (unit + emulator)"
@echo " make test-frontend - Run frontend tests only (unit + E2E)"
@echo " make test-unit - Run unit tests only (karaoke_gen package)"
@echo " make test-e2e - Run emulator tests with auto-start/stop"
@echo " make install - Install all dependencies (backend + frontend)"
@echo " make lint - Run linter checks"
@echo " make emulators-start - Start GCP emulators for local development"
@echo " make emulators-stop - Stop GCP emulators"
@echo ""
@echo "Before committing, run: make test"
# Install dependencies (only if needed)
install-backend:
@if [ ! -d "$$(poetry env info --path 2>/dev/null)" ] || ! poetry run python -c "import fastapi" 2>/dev/null; then \
echo "=== Installing backend dependencies ==="; \
poetry install; \
fi
install-frontend:
@if [ ! -d "frontend/node_modules" ]; then \
echo "=== Installing frontend dependencies ==="; \
cd frontend && npm install; \
fi
install: install-backend install-frontend
# Run unit tests for karaoke_gen package
test-unit:
test-unit: install-backend
@echo "=== Running karaoke_gen unit tests ==="
poetry run pytest tests/unit/ -v --cov=karaoke_gen --cov-report=term-missing --cov-fail-under=69
# Run backend unit tests
test-backend:
# Run backend unit tests (excludes emulator tests)
test-backend-unit: install-backend
@echo "=== Running backend unit tests ==="
poetry run pytest backend/tests/ --ignore=backend/tests/emulator -v
# Run E2E integration tests with emulators
test-e2e:
test-e2e: install-backend
@echo "=== Running E2E integration tests with emulators ==="
@./scripts/start-emulators.sh || (echo "Failed to start emulators" && exit 1)
@export FIRESTORE_EMULATOR_HOST=127.0.0.1:8080 && \
@@ -42,8 +58,18 @@ test-e2e:
./scripts/stop-emulators.sh; \
exit $$TEST_RESULT
# Run all tests (use this before committing!)
test: test-unit test-backend test-e2e
# Run all backend tests (unit + emulator)
test-backend: test-unit test-backend-unit test-e2e
@echo ""
@echo "✅ Backend tests passed!"
# Run frontend tests (unit + E2E)
test-frontend: install-frontend
@echo "=== Running frontend tests ==="
cd frontend && npm run test:all
# Run ALL tests (backend + frontend) - use this before committing!
test: test-backend test-frontend
@echo ""
@echo "✅ All tests passed! Ready to commit."
+1
View File
@@ -54,6 +54,7 @@ WORKDIR /app
COPY pyproject.toml README.md LICENSE /app/
COPY karaoke_gen /app/karaoke_gen
COPY lyrics_transcriber_temp /app/lyrics_transcriber_temp
COPY backend /app/backend
# Install all Python dependencies (the slow part - cached in base image)
RUN pip install --no-cache-dir --upgrade pip && \
+736 -2
View File
@@ -8,17 +8,18 @@ Handles:
- Audio search cache management
"""
import logging
from datetime import datetime, timedelta
from datetime import datetime, timedelta, timezone
from typing import Tuple, List, Optional, Any, Dict
from fastapi import APIRouter, Depends, HTTPException
from pydantic import BaseModel
from backend.api.dependencies import require_admin
from backend.services.auth_service import UserType
from backend.services.auth_service import UserType, AuthResult
from backend.services.user_service import get_user_service, UserService, USERS_COLLECTION
from backend.services.job_manager import JobManager
from backend.services.flacfetch_client import get_flacfetch_client, FlacfetchServiceError
from backend.services.storage_service import StorageService
from backend.models.job import JobStatus
from backend.utils.test_data import is_test_email
from karaoke_gen.utils import sanitize_filename
@@ -56,6 +57,74 @@ class AdminStatsOverview(BaseModel):
total_beta_testers: int
class FileInfo(BaseModel):
"""Information about a single file with signed download URL."""
name: str
path: str # GCS path (gs://bucket/...)
download_url: str # Signed URL for download
category: str # e.g., "stems", "lyrics", "finals"
file_key: str # e.g., "instrumental_clean", "lrc"
class JobFilesResponse(BaseModel):
"""Response containing all files for a job with signed download URLs."""
job_id: str
artist: Optional[str]
title: Optional[str]
files: List[FileInfo]
total_files: int
class JobUpdateRequest(BaseModel):
"""Request model for updating job fields."""
# Editable text fields
artist: Optional[str] = None
title: Optional[str] = None
user_email: Optional[str] = None
theme_id: Optional[str] = None
brand_prefix: Optional[str] = None
discord_webhook_url: Optional[str] = None
youtube_description: Optional[str] = None
youtube_description_template: Optional[str] = None
customer_email: Optional[str] = None
customer_notes: Optional[str] = None
# Editable boolean fields
enable_cdg: Optional[bool] = None
enable_txt: Optional[bool] = None
enable_youtube_upload: Optional[bool] = None
non_interactive: Optional[bool] = None
prep_only: Optional[bool] = None
class JobUpdateResponse(BaseModel):
"""Response from job update endpoint."""
status: str
job_id: str
updated_fields: List[str]
message: str
# Fields that are allowed to be updated via PATCH endpoint
EDITABLE_JOB_FIELDS = {
"artist",
"title",
"user_email",
"theme_id",
"brand_prefix",
"discord_webhook_url",
"youtube_description",
"youtube_description_template",
"customer_email",
"customer_notes",
"enable_cdg",
"enable_txt",
"enable_youtube_upload",
"non_interactive",
"prep_only",
}
# =============================================================================
# Admin Stats Endpoints
# =============================================================================
@@ -702,6 +771,597 @@ class SendCompletionEmailResponse(BaseModel):
message: str
# =============================================================================
# Job Files Endpoint
# =============================================================================
def _extract_files_recursive(
file_urls: Dict[str, Any],
storage: StorageService,
category: str = "",
expiration_minutes: int = 120,
) -> List[FileInfo]:
"""
Recursively extract files from nested file_urls structure.
Only includes entries that are GCS paths (gs://...).
Skips non-GCS entries like YouTube URLs.
Args:
file_urls: Dictionary of file URLs (may be nested)
storage: StorageService instance for generating signed URLs
category: Current category name (for nested calls)
expiration_minutes: How long signed URLs should be valid
Returns:
List of FileInfo objects with signed download URLs
"""
files = []
for key, value in file_urls.items():
if isinstance(value, dict):
# Nested structure - recurse with key as category
nested_files = _extract_files_recursive(
value,
storage,
category=key if not category else f"{category}.{key}",
expiration_minutes=expiration_minutes,
)
files.extend(nested_files)
elif isinstance(value, str) and value.startswith("gs://"):
# GCS path - generate signed URL
try:
signed_url = storage.generate_signed_url(value, expiration_minutes=expiration_minutes)
# Extract filename from path
name = value.split("/")[-1] if "/" in value else value
files.append(FileInfo(
name=name,
path=value,
download_url=signed_url,
category=category,
file_key=key,
))
except Exception as e:
# Log but don't fail - file might not exist
logger.warning(f"Failed to generate signed URL for {value}: {e}")
# Skip non-GCS values (e.g., youtube URLs, video IDs)
return files
@router.get("/jobs/{job_id}/files", response_model=JobFilesResponse)
async def get_job_files(
job_id: str,
auth_data: Tuple[str, UserType, int] = Depends(require_admin),
):
"""
Get all files for a job with signed download URLs.
Returns a list of all files associated with the job, including:
- Input audio file
- Stem separation results (vocals, instrumentals, etc.)
- Lyrics files (LRC, ASS, corrections JSON)
- Screen files (title, end screens)
- Video files (with/without vocals)
- Final output files (various formats)
- Package files (CDG, TXT zips)
Each file includes a signed URL that's valid for 2 hours.
Non-GCS entries (like YouTube URLs) are excluded.
Requires admin authentication.
"""
job_manager = JobManager()
job = job_manager.get_job(job_id)
if not job:
raise HTTPException(status_code=404, detail=f"Job {job_id} not found")
# Extract all files with signed URLs
storage = StorageService()
file_urls = job.file_urls or {}
files = _extract_files_recursive(file_urls, storage)
return JobFilesResponse(
job_id=job.job_id,
artist=job.artist,
title=job.title,
files=files,
total_files=len(files),
)
@router.patch("/jobs/{job_id}", response_model=JobUpdateResponse)
async def update_job(
job_id: str,
request: Dict[str, Any],
auth_data: AuthResult = Depends(require_admin),
):
"""
Update editable fields of a job (admin only).
This endpoint allows admins to update certain job fields without
affecting the job's processing state. It's useful for:
- Correcting artist/title typos
- Changing user assignment
- Updating delivery settings (email, theme, etc.)
Editable fields:
- artist, title: Track metadata
- user_email: Job owner
- theme_id: Visual theme
- enable_cdg, enable_txt, enable_youtube_upload: Output options
- customer_email, customer_notes: Made-for-you order info
- brand_prefix: Brand code prefix
- non_interactive, prep_only: Workflow options
- discord_webhook_url: Notification URL
- youtube_description, youtube_description_template: YouTube settings
Non-editable fields (will return 400 error):
- job_id, status, progress: System-managed
- created_at, updated_at: Timestamps
- state_data, file_urls, timeline: Processing state
- worker_logs, worker_ids: Audit/tracking data
For status changes, use the reset endpoint instead.
"""
admin_email = auth_data.user_email or "unknown"
# Check for non-editable fields in request
non_editable_fields = set(request.keys()) - EDITABLE_JOB_FIELDS
if non_editable_fields:
raise HTTPException(
status_code=400,
detail=f"The following fields are not editable: {', '.join(sorted(non_editable_fields))}. "
f"Editable fields are: {', '.join(sorted(EDITABLE_JOB_FIELDS))}"
)
# Filter to only include provided fields (non-None values)
updates = {k: v for k, v in request.items() if v is not None}
if not updates:
raise HTTPException(
status_code=400,
detail="No valid fields provided for update. "
f"Editable fields are: {', '.join(sorted(EDITABLE_JOB_FIELDS))}"
)
job_manager = JobManager()
job = job_manager.get_job(job_id)
if not job:
raise HTTPException(status_code=404, detail=f"Job {job_id} not found")
# Perform the update
success = job_manager.update_job(job_id, updates)
if not success:
raise HTTPException(
status_code=500,
detail="Failed to update job. Please try again."
)
# Log the admin action
logger.info(
f"Admin {admin_email} updated job {job_id}. "
f"Updated fields: {list(updates.keys())}"
)
return JobUpdateResponse(
status="success",
job_id=job_id,
updated_fields=list(updates.keys()),
message=f"Successfully updated {len(updates)} field(s)",
)
# =============================================================================
# Job Reset Endpoint
# =============================================================================
class JobResetRequest(BaseModel):
"""Request model for resetting a job to a specific state."""
target_state: str
class JobResetResponse(BaseModel):
"""Response from job reset endpoint."""
status: str
job_id: str
previous_status: str
new_status: str
message: str
cleared_data: List[str]
# States that are allowed as reset targets
ALLOWED_RESET_STATES = {
"pending",
"awaiting_audio_selection",
"awaiting_review",
"awaiting_instrumental_selection",
}
# State data keys to clear for each reset target
# Keys not in this mapping are preserved
STATE_DATA_CLEAR_KEYS = {
"pending": [
"audio_search_results",
"audio_search_count",
"remote_search_id",
"audio_selection",
"review_complete",
"corrected_lyrics",
"instrumental_selection",
"video_progress",
"render_progress",
"screens_progress",
],
"awaiting_audio_selection": [
"audio_selection",
"review_complete",
"corrected_lyrics",
"instrumental_selection",
"video_progress",
"render_progress",
"screens_progress",
],
"awaiting_review": [
"review_complete",
"corrected_lyrics",
"instrumental_selection",
"video_progress",
"render_progress",
"screens_progress",
],
"awaiting_instrumental_selection": [
"instrumental_selection",
"video_progress",
"render_progress",
"screens_progress",
],
}
@router.post("/jobs/{job_id}/reset", response_model=JobResetResponse)
async def reset_job(
job_id: str,
request: JobResetRequest,
auth_data: AuthResult = Depends(require_admin),
user_service: UserService = Depends(get_user_service),
):
"""
Reset a job to a specific state for re-processing (admin only).
This endpoint allows admins to reset a job back to specific workflow
checkpoints to re-do parts of the processing. This is useful for:
- Re-running audio search after flacfetch updates
- Re-reviewing lyrics after corrections
- Re-selecting instrumental after hearing the result
- Restarting a failed job from the beginning
Allowed target states:
- pending: Restart from the beginning (clears all processing data)
- awaiting_audio_selection: Re-select audio source
- awaiting_review: Re-review lyrics (preserves audio stems)
- awaiting_instrumental_selection: Re-select instrumental (preserves review)
State data is cleared based on the target state to ensure a clean
re-processing from that point forward.
"""
admin_email = auth_data.user_email or "unknown"
target_state = request.target_state.lower()
# Validate target state
if target_state not in ALLOWED_RESET_STATES:
raise HTTPException(
status_code=400,
detail=f"Invalid target state '{target_state}'. "
f"Allowed states are: {', '.join(sorted(ALLOWED_RESET_STATES))}"
)
job_manager = JobManager()
job = job_manager.get_job(job_id)
if not job:
raise HTTPException(status_code=404, detail=f"Job {job_id} not found")
previous_status = job.status
# Build update payload
updates = {
"status": target_state,
"progress": 0,
"message": f"Job reset to {target_state} by admin",
"updated_at": datetime.utcnow().isoformat(),
}
# Clear state data keys based on target state
keys_to_clear = STATE_DATA_CLEAR_KEYS.get(target_state, [])
cleared_keys = []
current_state_data = job.state_data or {}
for key in keys_to_clear:
if key in current_state_data:
cleared_keys.append(key)
# Add timeline event
timeline_event = {
"status": target_state,
"timestamp": datetime.utcnow().isoformat(),
"message": f"Admin reset from {previous_status} to {target_state}",
}
# Perform the update with state_data clearing
# We need to set the cleared keys to DELETE_FIELD
success = job_manager.update_job(job_id, updates)
if not success:
raise HTTPException(
status_code=500,
detail="Failed to reset job. Please try again."
)
# Clear the state data keys separately using direct Firestore update
from google.cloud.firestore_v1 import DELETE_FIELD, ArrayUnion
job_ref = user_service.db.collection("jobs").document(job_id)
if cleared_keys:
clear_updates = {}
for key in cleared_keys:
clear_updates[f"state_data.{key}"] = DELETE_FIELD
# Add timeline event
clear_updates["timeline"] = ArrayUnion([timeline_event])
job_ref.update(clear_updates)
else:
# Just add timeline event
job_ref.update({
"timeline": ArrayUnion([timeline_event])
})
# Log the admin action
logger.info(
f"Admin {admin_email} reset job {job_id} from {previous_status} to {target_state}. "
f"Cleared state_data keys: {cleared_keys}"
)
return JobResetResponse(
status="success",
job_id=job_id,
previous_status=previous_status,
new_status=target_state,
message=f"Job reset from {previous_status} to {target_state}",
cleared_data=cleared_keys,
)
# =============================================================================
# Delete Job Outputs Endpoint
# =============================================================================
class DeleteOutputsResponse(BaseModel):
"""Response from delete job outputs endpoint."""
status: str
job_id: str
message: str
deleted_services: Dict[str, Any] # youtube, dropbox, gdrive results
cleared_state_data: List[str]
outputs_deleted_at: str
# State data keys to clear when deleting outputs
OUTPUT_STATE_DATA_KEYS = [
"youtube_url",
"youtube_video_id",
"dropbox_link",
"brand_code",
"gdrive_files",
]
# Terminal states that allow output deletion
TERMINAL_STATES = {"complete", "prep_complete", "failed", "cancelled"}
@router.post("/jobs/{job_id}/delete-outputs", response_model=DeleteOutputsResponse)
async def delete_job_outputs(
job_id: str,
auth_data: AuthResult = Depends(require_admin),
):
"""
Delete all distributed outputs for a job (admin only).
This endpoint deletes:
1. YouTube video (if uploaded)
2. Dropbox folder (if uploaded) - frees brand code for reuse
3. Google Drive files (if uploaded)
The job record is preserved with outputs_deleted_at timestamp set.
State data related to distribution is cleared.
Use case: Delete outputs for quality issues, then reset job to
awaiting_review or awaiting_instrumental_selection to re-process.
Args:
job_id: Job ID to delete outputs for
Returns:
Deletion results for each service
"""
import re
from google.cloud.firestore_v1 import DELETE_FIELD, ArrayUnion
admin_email = auth_data.user_email or "unknown"
job_manager = JobManager()
job = job_manager.get_job(job_id)
if not job:
raise HTTPException(status_code=404, detail=f"Job {job_id} not found")
# Verify job is in a terminal state
if job.status not in TERMINAL_STATES:
raise HTTPException(
status_code=400,
detail=f"Can only delete outputs from jobs in terminal states. "
f"Current status: {job.status}. Allowed: {', '.join(sorted(TERMINAL_STATES))}"
)
# Check if outputs already deleted
if job.outputs_deleted_at:
raise HTTPException(
status_code=400,
detail=f"Outputs were already deleted at {job.outputs_deleted_at}"
)
state_data = job.state_data or {}
results = {
"youtube": {"status": "skipped", "reason": "no youtube_url in state_data"},
"dropbox": {"status": "skipped", "reason": "no brand_code or dropbox_path"},
"gdrive": {"status": "skipped", "reason": "no gdrive_files in state_data"},
}
# Clean up YouTube
youtube_url = state_data.get('youtube_url')
if youtube_url:
try:
video_id_match = re.search(r'(?:youtu\.be/|youtube\.com/watch\?v=)([^&\s]+)', youtube_url)
if video_id_match:
video_id = video_id_match.group(1)
from karaoke_gen.karaoke_finalise.karaoke_finalise import KaraokeFinalise
from backend.services.youtube_service import get_youtube_service
youtube_service = get_youtube_service()
if youtube_service.is_configured:
finalise = KaraokeFinalise(
dry_run=False,
non_interactive=True,
user_youtube_credentials=youtube_service.get_credentials_dict()
)
success = finalise.delete_youtube_video(video_id)
results["youtube"] = {
"status": "success" if success else "failed",
"video_id": video_id
}
else:
results["youtube"] = {"status": "skipped", "reason": "YouTube credentials not configured"}
else:
results["youtube"] = {"status": "failed", "reason": f"Could not extract video ID from {youtube_url}"}
except Exception as e:
logger.error(f"Error deleting YouTube video for job {job_id}: {e}", exc_info=True)
results["youtube"] = {"status": "error", "error": str(e)}
# Clean up Dropbox
brand_code = state_data.get('brand_code')
dropbox_path = getattr(job, 'dropbox_path', None)
if brand_code and dropbox_path:
try:
from backend.services.dropbox_service import get_dropbox_service
dropbox = get_dropbox_service()
if dropbox.is_configured:
base_name = f"{job.artist} - {job.title}"
folder_name = f"{brand_code} - {base_name}"
full_path = f"{dropbox_path}/{folder_name}"
success = dropbox.delete_folder(full_path)
results["dropbox"] = {
"status": "success" if success else "failed",
"path": full_path
}
else:
results["dropbox"] = {"status": "skipped", "reason": "Dropbox credentials not configured"}
except Exception as e:
logger.error(f"Error deleting Dropbox folder for job {job_id}: {e}", exc_info=True)
results["dropbox"] = {"status": "error", "error": str(e)}
# Clean up Google Drive
gdrive_files = state_data.get('gdrive_files')
if gdrive_files:
try:
from backend.services.gdrive_service import get_gdrive_service
gdrive = get_gdrive_service()
if gdrive.is_configured:
file_ids = list(gdrive_files.values()) if isinstance(gdrive_files, dict) else []
delete_results = gdrive.delete_files(file_ids)
all_success = all(delete_results.values())
results["gdrive"] = {
"status": "success" if all_success else "partial",
"files": delete_results
}
else:
results["gdrive"] = {"status": "skipped", "reason": "Google Drive credentials not configured"}
except Exception as e:
logger.error(f"Error deleting Google Drive files for job {job_id}: {e}", exc_info=True)
results["gdrive"] = {"status": "error", "error": str(e)}
# Update job record
deletion_timestamp = datetime.now(timezone.utc)
user_service = get_user_service()
db = user_service.db
job_ref = db.collection("jobs").document(job_id)
update_payload = {
"outputs_deleted_at": deletion_timestamp,
"outputs_deleted_by": admin_email,
"updated_at": deletion_timestamp,
}
# Clear distribution-related state_data keys
cleared_keys = []
for key in OUTPUT_STATE_DATA_KEYS:
if key in state_data:
update_payload[f"state_data.{key}"] = DELETE_FIELD
cleared_keys.append(key)
# Add timeline event
timeline_event = {
"status": job.status, # Keep current status
"timestamp": deletion_timestamp.isoformat(),
"message": f"Outputs deleted by admin ({admin_email})",
}
update_payload["timeline"] = ArrayUnion([timeline_event])
job_ref.update(update_payload)
# Determine overall status based on per-service results
error_services = [s for s, r in results.items() if r["status"] == "error"]
failed_services = [s for s, r in results.items() if r["status"] == "failed"]
success_services = [s for s, r in results.items() if r["status"] == "success"]
if error_services:
overall_status = "partial_success" if success_services else "error"
error_details = "; ".join(
f"{s}: {results[s].get('error', 'unknown error')}" for s in error_services
)
message = f"Some services failed: {error_details}"
elif failed_services:
overall_status = "partial_success" if success_services else "failed"
message = f"Some deletions failed: {', '.join(failed_services)}"
else:
overall_status = "success"
message = "Outputs deleted successfully"
logger.info(
f"Admin {admin_email} deleted outputs for job {job_id}. "
f"YouTube: {results['youtube']['status']}, "
f"Dropbox: {results['dropbox']['status']}, "
f"GDrive: {results['gdrive']['status']}. "
f"Cleared state_data keys: {cleared_keys}"
)
return DeleteOutputsResponse(
status=overall_status,
job_id=job_id,
message=message,
deleted_services=results,
cleared_state_data=cleared_keys,
outputs_deleted_at=deletion_timestamp.isoformat(),
)
@router.get("/jobs/{job_id}/completion-message", response_model=CompletionMessageResponse)
async def get_job_completion_message(
job_id: str,
@@ -833,3 +1493,77 @@ async def send_job_completion_email(
status_code=500,
detail="Failed to send email. Check email service configuration."
)
# =============================================================================
# User Impersonation
# =============================================================================
class ImpersonateUserResponse(BaseModel):
"""Response from impersonate user endpoint."""
session_token: str
user_email: str
message: str
@router.post("/users/{email}/impersonate", response_model=ImpersonateUserResponse)
async def impersonate_user(
email: str,
auth_data: Tuple[str, UserType, int] = Depends(require_admin),
user_service: UserService = Depends(get_user_service),
):
"""
Create a session token to impersonate a user (admin only).
This allows admins to view the application exactly as a specific user would see it.
The admin's original session remains valid and can be restored client-side.
Security:
- Only admins can impersonate
- Creates a real session (auditable in Firestore)
- Impersonation is logged for security audit
Args:
email: Email of the user to impersonate
Returns:
session_token: A valid session token for the target user
user_email: The impersonated user's email
message: Success message
"""
admin_email = auth_data[0]
target_email = email.lower()
# Cannot impersonate yourself
if target_email == admin_email.lower():
raise HTTPException(
status_code=400,
detail="Cannot impersonate yourself"
)
# Verify target user exists
target_user = user_service.get_user(target_email)
if not target_user:
raise HTTPException(
status_code=404,
detail=f"User {target_email} not found"
)
# Create a real session for the target user
session = user_service.create_session(
user_email=target_email,
ip_address=None, # Not tracking IP for impersonation
user_agent=f"Impersonation by {admin_email}",
)
# Log impersonation for audit trail
logger.info(
f"IMPERSONATION: Admin {admin_email} started impersonating user {target_email}. "
f"Session token prefix: {session.token[:12]}..."
)
return ImpersonateUserResponse(
session_token=session.token,
user_email=target_email,
message=f"Now impersonating {target_email}",
)
+17 -34
View File
@@ -15,7 +15,7 @@ import asyncio
import logging
import os
import tempfile
from typing import Optional, List, Dict, Any, Tuple
from typing import Optional, List, Dict, Any
from fastapi import APIRouter, HTTPException, BackgroundTasks, Request, Depends
from pydantic import BaseModel, Field, validator
@@ -34,10 +34,12 @@ from backend.services.audio_search_service import (
DownloadError,
)
from backend.services.theme_service import get_theme_service
from backend.services.job_defaults_service import resolve_cdg_txt_defaults
from backend.config import get_settings
from backend.version import VERSION
from backend.api.dependencies import require_auth
from backend.services.auth_service import UserType, AuthResult
from backend.middleware.tenant import get_tenant_config_from_request
from pathlib import Path
logger = logging.getLogger(__name__)
@@ -200,35 +202,6 @@ class AudioSelectResponse(BaseModel):
selected_provider: str
def _resolve_cdg_txt_defaults(
theme_id: Optional[str],
enable_cdg: Optional[bool],
enable_txt: Optional[bool]
) -> Tuple[bool, bool]:
"""
Resolve CDG/TXT settings based on theme and explicit settings.
When a theme is selected, CDG and TXT are enabled by default.
Explicit True/False values always override the default.
Args:
theme_id: Theme identifier (if any)
enable_cdg: Explicit CDG setting (None means use default)
enable_txt: Explicit TXT setting (None means use default)
Returns:
Tuple of (resolved_enable_cdg, resolved_enable_txt)
"""
# Default based on whether theme is set
default_enabled = theme_id is not None
# Explicit values override defaults, None uses default
resolved_cdg = enable_cdg if enable_cdg is not None else default_enabled
resolved_txt = enable_txt if enable_txt is not None else default_enabled
return resolved_cdg, resolved_txt
def extract_request_metadata(request: Request, created_from: str = "audio_search") -> Dict[str, Any]:
"""Extract metadata from request for job tracking."""
headers = dict(request.headers)
@@ -479,17 +452,25 @@ async def search_audio(
):
"""
Search for audio by artist and title, creating a new job.
This endpoint:
1. Creates a job in PENDING state
2. Searches for audio using flacfetch
3. Either returns search results for user selection, or
4. If auto_download=True, automatically selects best and starts processing
Use cases:
- Interactive mode (default): Returns results, user calls /select endpoint
- Auto mode (auto_download=True): Automatically selects and downloads best
"""
# Check tenant feature flag
tenant_config = get_tenant_config_from_request(request)
if tenant_config and not tenant_config.features.audio_search:
raise HTTPException(
status_code=403,
detail="Audio search is not available for this portal"
)
try:
# Apply default distribution settings
settings = get_settings()
@@ -545,7 +526,7 @@ async def search_audio(
logger.info(f"Applying default theme: {effective_theme_id}")
# Resolve CDG/TXT defaults based on theme
resolved_cdg, resolved_txt = _resolve_cdg_txt_defaults(
resolved_cdg, resolved_txt = resolve_cdg_txt_defaults(
effective_theme_id, body.enable_cdg, body.enable_txt
)
@@ -585,8 +566,10 @@ async def search_audio(
auto_download=body.auto_download,
request_metadata=request_metadata,
non_interactive=body.non_interactive,
# Tenant scoping
tenant_id=tenant_config.id if tenant_config else None,
)
job = job_manager.create_job(job_create)
job = job_manager.create_job(job_create, is_admin=auth_result.is_admin)
job_id = job.job_id
logger.info(f"Created job {job_id} for audio search: {body.artist} - {body.title}")
+60 -84
View File
@@ -15,7 +15,6 @@ import json
import logging
import tempfile
import os
from dataclasses import dataclass
from fastapi import APIRouter, UploadFile, File, Form, HTTPException, BackgroundTasks, Request, Body, Depends
from pathlib import Path
from typing import Optional, List, Dict, Any, Tuple
@@ -29,11 +28,17 @@ from backend.services.storage_service import StorageService
from backend.services.worker_service import get_worker_service
from backend.services.credential_manager import get_credential_manager, CredentialStatus
from backend.services.theme_service import get_theme_service
from backend.services.job_defaults_service import (
get_effective_distribution_settings,
resolve_cdg_txt_defaults,
EffectiveDistributionSettings,
)
from backend.config import get_settings
from backend.version import VERSION
from backend.services.metrics import metrics
from backend.api.dependencies import require_auth
from backend.services.auth_service import UserType, AuthResult
from backend.middleware.tenant import get_tenant_config_from_request
logger = logging.getLogger(__name__)
router = APIRouter(tags=["jobs"])
@@ -263,75 +268,6 @@ async def _trigger_audio_worker_only(job_id: str) -> None:
await worker_service.trigger_audio_worker(job_id)
def _resolve_cdg_txt_defaults(
theme_id: Optional[str],
enable_cdg: Optional[bool],
enable_txt: Optional[bool]
) -> Tuple[bool, bool]:
"""
Resolve CDG/TXT settings based on theme and explicit settings.
When a theme is selected, CDG and TXT are enabled by default.
Explicit True/False values always override the default.
Args:
theme_id: Theme identifier (if any)
enable_cdg: Explicit CDG setting (None means use default)
enable_txt: Explicit TXT setting (None means use default)
Returns:
Tuple of (resolved_enable_cdg, resolved_enable_txt)
"""
# Default based on whether theme is set
default_enabled = theme_id is not None
# Resolve with explicit override taking precedence
resolved_cdg = enable_cdg if enable_cdg is not None else default_enabled
resolved_txt = enable_txt if enable_txt is not None else default_enabled
return resolved_cdg, resolved_txt
@dataclass
class EffectiveDistributionSettings:
"""Settings with defaults applied from environment variables."""
dropbox_path: Optional[str]
gdrive_folder_id: Optional[str]
discord_webhook_url: Optional[str]
brand_prefix: Optional[str]
def _get_effective_distribution_settings(
dropbox_path: Optional[str] = None,
gdrive_folder_id: Optional[str] = None,
discord_webhook_url: Optional[str] = None,
brand_prefix: Optional[str] = None,
) -> EffectiveDistributionSettings:
"""
Get distribution settings with defaults applied from environment variables.
This ensures consistent handling of defaults across all job creation endpoints.
Each parameter, if not provided (None), falls back to the corresponding
environment variable configured in settings.
Args:
dropbox_path: Explicit Dropbox path or None for default
gdrive_folder_id: Explicit Google Drive folder ID or None for default
discord_webhook_url: Explicit Discord webhook URL or None for default
brand_prefix: Explicit brand prefix or None for default
Returns:
EffectiveDistributionSettings with defaults applied
"""
settings = get_settings()
return EffectiveDistributionSettings(
dropbox_path=dropbox_path or settings.default_dropbox_path,
gdrive_folder_id=gdrive_folder_id or settings.default_gdrive_folder_id,
discord_webhook_url=discord_webhook_url or settings.default_discord_webhook_url,
brand_prefix=brand_prefix or settings.default_brand_prefix,
)
def _prepare_theme_for_job(
job_id: str,
theme_id: str,
@@ -446,6 +382,14 @@ async def upload_and_create_job(
The style_params JSON can reference the uploaded images/fonts by their original
filenames, and the backend will update the paths to GCS locations.
"""
# Check tenant feature flag
tenant_config = get_tenant_config_from_request(request)
if tenant_config and not tenant_config.features.file_upload:
raise HTTPException(
status_code=403,
detail="File upload is not available for this portal"
)
try:
# Validate main audio file type
file_ext = Path(file.filename).suffix.lower()
@@ -494,7 +438,7 @@ async def upload_and_create_job(
)
# Apply default distribution settings from environment if not provided
dist = _get_effective_distribution_settings(
dist = get_effective_distribution_settings(
dropbox_path=dropbox_path,
gdrive_folder_id=gdrive_folder_id,
discord_webhook_url=discord_webhook_url,
@@ -572,7 +516,7 @@ async def upload_and_create_job(
logger.info(f"Applying default theme: {effective_theme_id}")
# Resolve CDG/TXT defaults based on theme
resolved_cdg, resolved_txt = _resolve_cdg_txt_defaults(
resolved_cdg, resolved_txt = resolve_cdg_txt_defaults(
effective_theme_id, enable_cdg, enable_txt
)
@@ -632,10 +576,12 @@ async def upload_and_create_job(
request_metadata=request_metadata,
# Non-interactive mode
non_interactive=non_interactive,
# Tenant scoping
tenant_id=tenant_config.id if tenant_config else None,
)
job = job_manager.create_job(job_create)
job = job_manager.create_job(job_create, is_admin=auth_result.is_admin)
job_id = job.job_id
# Record job creation metric
metrics.record_job_created(job_id, source="upload")
@@ -1029,6 +975,14 @@ async def create_job_with_upload_urls(
- Works with any HTTP client (no HTTP/2 required)
- Resumable uploads possible with GCS
"""
# Check tenant feature flag
tenant_config = get_tenant_config_from_request(request)
if tenant_config and not tenant_config.features.file_upload:
raise HTTPException(
status_code=403,
detail="File upload is not available for this portal"
)
try:
# Validate files list
if not body.files:
@@ -1058,7 +1012,7 @@ async def create_job_with_upload_urls(
)
# Apply default distribution settings from environment if not provided
dist = _get_effective_distribution_settings(
dist = get_effective_distribution_settings(
dropbox_path=body.dropbox_path,
gdrive_folder_id=body.gdrive_folder_id,
discord_webhook_url=body.discord_webhook_url,
@@ -1116,7 +1070,7 @@ async def create_job_with_upload_urls(
logger.info(f"Applying default theme: {effective_theme_id}")
# Resolve CDG/TXT defaults based on theme
resolved_cdg, resolved_txt = _resolve_cdg_txt_defaults(
resolved_cdg, resolved_txt = resolve_cdg_txt_defaults(
effective_theme_id, body.enable_cdg, body.enable_txt
)
@@ -1153,8 +1107,10 @@ async def create_job_with_upload_urls(
other_stems_models=body.other_stems_models,
request_metadata=request_metadata,
non_interactive=body.non_interactive,
# Tenant scoping
tenant_id=tenant_config.id if tenant_config else None,
)
job = job_manager.create_job(job_create)
job = job_manager.create_job(job_create, is_admin=auth_result.is_admin)
job_id = job.job_id
# Record job creation metric
@@ -1481,6 +1437,14 @@ async def create_job_from_url(
Note: YouTube rate limiting may cause occasional download failures.
The backend will retry automatically.
"""
# Check tenant feature flag
tenant_config = get_tenant_config_from_request(request)
if tenant_config and not tenant_config.features.youtube_url:
raise HTTPException(
status_code=403,
detail="URL-based job creation is not available for this portal"
)
try:
# Validate URL
if not _validate_url(body.url):
@@ -1490,7 +1454,7 @@ async def create_job_from_url(
)
# Apply default distribution settings from environment if not provided
dist = _get_effective_distribution_settings(
dist = get_effective_distribution_settings(
dropbox_path=body.dropbox_path,
gdrive_folder_id=body.gdrive_folder_id,
discord_webhook_url=body.discord_webhook_url,
@@ -1549,7 +1513,7 @@ async def create_job_from_url(
logger.info(f"Applying default theme: {effective_theme_id}")
# Resolve CDG/TXT defaults based on theme
resolved_cdg, resolved_txt = _resolve_cdg_txt_defaults(
resolved_cdg, resolved_txt = resolve_cdg_txt_defaults(
effective_theme_id, body.enable_cdg, body.enable_txt
)
@@ -1583,8 +1547,10 @@ async def create_job_from_url(
other_stems_models=body.other_stems_models,
request_metadata=request_metadata,
non_interactive=body.non_interactive,
# Tenant scoping
tenant_id=tenant_config.id if tenant_config else None,
)
job = job_manager.create_job(job_create)
job = job_manager.create_job(job_create, is_admin=auth_result.is_admin)
job_id = job.job_id
# Record job creation metric
@@ -1604,7 +1570,7 @@ async def create_job_from_url(
update_data['youtube_description_template'] = youtube_desc
job_manager.update_job(job_id, update_data)
logger.info(f"Applied theme '{effective_theme_id}' to job {job_id}")
logger.info(f"Created URL-based job {job_id} for URL: {body.url}")
if artist:
logger.info(f" Artist: {artist}")
@@ -1703,6 +1669,14 @@ async def create_finalise_only_job(
The endpoint returns signed URLs for uploading all the prep files.
"""
# Check tenant feature flag - finalise-only requires file upload capability
tenant_config = get_tenant_config_from_request(request)
if tenant_config and not tenant_config.features.file_upload:
raise HTTPException(
status_code=403,
detail="File upload is not available for this portal"
)
try:
# Validate files list
if not body.files:
@@ -1750,7 +1724,7 @@ async def create_finalise_only_job(
)
# Apply default distribution settings
dist = _get_effective_distribution_settings(
dist = get_effective_distribution_settings(
dropbox_path=body.dropbox_path,
gdrive_folder_id=body.gdrive_folder_id,
discord_webhook_url=body.discord_webhook_url,
@@ -1805,7 +1779,7 @@ async def create_finalise_only_job(
logger.info(f"Applying default theme: {effective_theme_id}")
# Resolve CDG/TXT defaults based on theme
resolved_cdg, resolved_txt = _resolve_cdg_txt_defaults(
resolved_cdg, resolved_txt = resolve_cdg_txt_defaults(
effective_theme_id, body.enable_cdg, body.enable_txt
)
@@ -1834,8 +1808,10 @@ async def create_finalise_only_job(
finalise_only=True,
keep_brand_code=body.keep_brand_code,
request_metadata=request_metadata,
# Tenant scoping
tenant_id=tenant_config.id if tenant_config else None,
)
job = job_manager.create_job(job_create)
job = job_manager.create_job(job_create, is_admin=auth_result.is_admin)
job_id = job.job_id
# Record job creation metric
+6
View File
@@ -371,6 +371,12 @@ async def check_idle_reminder(
add_span_event("already_sent")
return {"status": "already_sent", "job_id": job_id, "message": "Reminder already sent"}
# Skip reminders for made-for-you jobs (admin handles these directly, no intermediate customer emails)
if getattr(job, 'made_for_you', False):
logger.info(f"[job:{job_id}] Made-for-you job, skipping customer reminder (admin handles)")
add_span_event("made_for_you_skip")
return {"status": "skipped", "job_id": job_id, "message": "Made-for-you job - admin handles directly"}
# Check if user has an email
if not job.user_email:
logger.warning(f"[job:{job_id}] No user email, cannot send reminder")
+11 -3
View File
@@ -11,7 +11,7 @@ import asyncio
import logging
import httpx
from typing import List, Optional, Dict, Any, Tuple
from fastapi import APIRouter, HTTPException, BackgroundTasks, Depends
from fastapi import APIRouter, HTTPException, BackgroundTasks, Depends, Request
from backend.models.job import Job, JobCreate, JobResponse, JobStatus
from backend.models.requests import (
@@ -30,6 +30,7 @@ from backend.config import get_settings
from backend.api.dependencies import require_admin, require_auth, require_instrumental_auth
from backend.services.auth_service import UserType, AuthResult
from backend.services.metrics import metrics
from backend.middleware.tenant import get_tenant_from_request
from backend.utils.test_data import is_test_email
@@ -117,8 +118,8 @@ async def create_job(
webhook_url=request.webhook_url,
user_email=user_email
)
job = job_manager.create_job(job_create)
job = job_manager.create_job(job_create, is_admin=auth_result.is_admin)
# Record job creation metric
metrics.record_job_created(job.job_id, source="url")
@@ -190,6 +191,7 @@ def _check_job_ownership(job: Job, auth_result: AuthResult) -> bool:
@router.get("", response_model=List[Job])
async def list_jobs(
request: Request,
status: Optional[JobStatus] = None,
environment: Optional[str] = None,
client_id: Optional[str] = None,
@@ -203,6 +205,7 @@ async def list_jobs(
List jobs with optional filters.
Regular users only see their own jobs. Admins see all jobs.
Users on tenant portals only see jobs from their tenant.
Args:
status: Filter by job status (pending, complete, failed, etc.)
@@ -247,6 +250,10 @@ async def list_jobs(
logger.warning("Non-admin auth without user_email, returning empty job list")
return []
# Get tenant_id from request for portal scoping
# Tenant users only see jobs from their tenant
tenant_id = get_tenant_from_request(request)
jobs = job_manager.list_jobs(
status=status,
environment=environment,
@@ -254,6 +261,7 @@ async def list_jobs(
created_after=created_after_dt,
created_before=created_before_dt,
user_email=user_email_filter,
tenant_id=tenant_id,
limit=limit
)
+238
View File
@@ -0,0 +1,238 @@
"""
Push Notification API routes.
Provides endpoints for managing Web Push notification subscriptions:
- GET /api/push/vapid-public-key: Get VAPID public key for client-side subscription
- POST /api/push/subscribe: Register a push subscription
- POST /api/push/unsubscribe: Remove a push subscription
- GET /api/push/subscriptions: List user's subscriptions
- POST /api/push/test: Send a test notification (admin only)
"""
import logging
from typing import Optional, Dict, List
from fastapi import APIRouter, Depends, HTTPException
from pydantic import BaseModel
from backend.config import get_settings
from backend.api.dependencies import require_auth, require_admin
from backend.services.auth_service import AuthResult
from backend.services.push_notification_service import get_push_notification_service
logger = logging.getLogger(__name__)
router = APIRouter(prefix="/push", tags=["push"])
# Request/Response Models
class VapidPublicKeyResponse(BaseModel):
"""Response containing VAPID public key."""
enabled: bool
vapid_public_key: Optional[str] = None
class SubscribeRequest(BaseModel):
"""Request to subscribe to push notifications."""
endpoint: str
keys: Dict[str, str] # p256dh and auth
device_name: Optional[str] = None
class SubscribeResponse(BaseModel):
"""Response after subscribing."""
status: str
message: str
class UnsubscribeRequest(BaseModel):
"""Request to unsubscribe from push notifications."""
endpoint: str
class UnsubscribeResponse(BaseModel):
"""Response after unsubscribing."""
status: str
message: str
class SubscriptionInfo(BaseModel):
"""Information about a push subscription."""
endpoint: str
device_name: Optional[str] = None
created_at: Optional[str] = None
last_used_at: Optional[str] = None
class SubscriptionsListResponse(BaseModel):
"""Response containing user's subscriptions."""
subscriptions: List[SubscriptionInfo]
count: int
class TestNotificationRequest(BaseModel):
"""Request to send a test notification."""
title: Optional[str] = "Test Notification"
body: Optional[str] = "This is a test push notification from Karaoke Generator"
class TestNotificationResponse(BaseModel):
"""Response after sending test notification."""
status: str
sent_count: int
message: str
# Routes
@router.get("/vapid-public-key", response_model=VapidPublicKeyResponse)
async def get_vapid_public_key():
"""
Get the VAPID public key for push subscription.
This endpoint is public - no authentication required.
Returns the public key needed for client-side PushManager.subscribe().
"""
settings = get_settings()
push_service = get_push_notification_service()
if not settings.enable_push_notifications:
return VapidPublicKeyResponse(enabled=False)
public_key = push_service.get_public_key()
if not public_key:
return VapidPublicKeyResponse(enabled=False)
return VapidPublicKeyResponse(
enabled=True,
vapid_public_key=public_key
)
@router.post("/subscribe", response_model=SubscribeResponse)
async def subscribe_push(
request: SubscribeRequest,
auth_result: AuthResult = Depends(require_auth)
):
"""
Register a push notification subscription for the current user.
Requires authentication. Users can have up to 5 subscriptions
(configurable via MAX_PUSH_SUBSCRIPTIONS_PER_USER).
"""
settings = get_settings()
if not settings.enable_push_notifications:
raise HTTPException(status_code=503, detail="Push notifications are not enabled")
if not auth_result.user_email:
raise HTTPException(status_code=401, detail="User email not available")
push_service = get_push_notification_service()
# Validate keys
if "p256dh" not in request.keys or "auth" not in request.keys:
raise HTTPException(status_code=400, detail="Missing required keys (p256dh, auth)")
success = await push_service.add_subscription(
user_email=auth_result.user_email,
endpoint=request.endpoint,
keys=request.keys,
device_name=request.device_name
)
if not success:
raise HTTPException(status_code=500, detail="Failed to save subscription")
return SubscribeResponse(
status="success",
message="Push subscription registered successfully"
)
@router.post("/unsubscribe", response_model=UnsubscribeResponse)
async def unsubscribe_push(
request: UnsubscribeRequest,
auth_result: AuthResult = Depends(require_auth)
):
"""
Remove a push notification subscription.
Requires authentication. Users can only remove their own subscriptions.
"""
if not auth_result.user_email:
raise HTTPException(status_code=401, detail="User email not available")
push_service = get_push_notification_service()
success = await push_service.remove_subscription(
user_email=auth_result.user_email,
endpoint=request.endpoint
)
if not success:
# Don't error if subscription wasn't found - might already be removed
return UnsubscribeResponse(
status="success",
message="Subscription removed (or was not found)"
)
return UnsubscribeResponse(
status="success",
message="Push subscription removed successfully"
)
@router.get("/subscriptions", response_model=SubscriptionsListResponse)
async def list_subscriptions(
auth_result: AuthResult = Depends(require_auth)
):
"""
List all push notification subscriptions for the current user.
Requires authentication.
"""
if not auth_result.user_email:
raise HTTPException(status_code=401, detail="User email not available")
push_service = get_push_notification_service()
subscriptions = await push_service.list_subscriptions(auth_result.user_email)
return SubscriptionsListResponse(
subscriptions=[SubscriptionInfo(**s) for s in subscriptions],
count=len(subscriptions)
)
@router.post("/test", response_model=TestNotificationResponse)
async def send_test_notification(
request: TestNotificationRequest,
auth_result: AuthResult = Depends(require_admin)
):
"""
Send a test push notification to the current user's devices.
Admin only. Useful for testing push notification setup.
"""
settings = get_settings()
if not settings.enable_push_notifications:
raise HTTPException(status_code=503, detail="Push notifications are not enabled")
if not auth_result.user_email:
raise HTTPException(status_code=401, detail="User email not available")
push_service = get_push_notification_service()
sent_count = await push_service.send_push(
user_email=auth_result.user_email,
title=request.title or "Test Notification",
body=request.body or "This is a test push notification",
url="/app/",
tag="test"
)
return TestNotificationResponse(
status="success",
sent_count=sent_count,
message=f"Test notification sent to {sent_count} device(s)"
)
+428
View File
@@ -0,0 +1,428 @@
"""
Admin API routes for rate limit management.
Handles:
- Rate limit statistics and monitoring
- Blocklist management (disposable domains, blocked emails, blocked IPs)
- User override management (whitelist/bypass permissions)
"""
import logging
from datetime import datetime, timezone
from typing import List, Optional
from fastapi import APIRouter, Depends, HTTPException
from pydantic import BaseModel, EmailStr
from backend.api.dependencies import require_admin
from backend.services.auth_service import AuthResult
from backend.services.rate_limit_service import get_rate_limit_service, RateLimitService
from backend.services.email_validation_service import get_email_validation_service, EmailValidationService
from backend.config import settings
logger = logging.getLogger(__name__)
router = APIRouter(prefix="/admin/rate-limits", tags=["admin", "rate-limits"])
# =============================================================================
# Response Models
# =============================================================================
class RateLimitStatsResponse(BaseModel):
"""Current rate limit statistics."""
# Configuration
jobs_per_day_limit: int
youtube_uploads_per_day_limit: int
beta_ip_per_day_limit: int
rate_limiting_enabled: bool
# Current usage
youtube_uploads_today: int
youtube_uploads_remaining: int
# Blocklist stats
disposable_domains_count: int
blocked_emails_count: int
blocked_ips_count: int
# User override stats
total_overrides: int
class UserRateLimitStatusResponse(BaseModel):
"""Rate limit status for a specific user."""
email: str
jobs_today: int
jobs_limit: int
jobs_remaining: int
has_bypass: bool
custom_limit: Optional[int]
bypass_reason: Optional[str]
class BlocklistsResponse(BaseModel):
"""All blocklist data."""
disposable_domains: List[str]
blocked_emails: List[str]
blocked_ips: List[str]
updated_at: Optional[datetime]
updated_by: Optional[str]
class DomainRequest(BaseModel):
"""Request to add/remove a domain."""
domain: str
class EmailRequest(BaseModel):
"""Request to add/remove an email."""
email: str
class IPRequest(BaseModel):
"""Request to add/remove an IP."""
ip_address: str
class UserOverride(BaseModel):
"""User override configuration."""
email: str
bypass_job_limit: bool
custom_daily_job_limit: Optional[int]
reason: str
created_by: str
created_at: datetime
class UserOverrideRequest(BaseModel):
"""Request to set/update a user override."""
bypass_job_limit: bool = False
custom_daily_job_limit: Optional[int] = None
reason: str
class UserOverridesListResponse(BaseModel):
"""List of all user overrides."""
overrides: List[UserOverride]
total: int
class SuccessResponse(BaseModel):
"""Generic success response."""
success: bool
message: str
# =============================================================================
# Statistics Endpoints
# =============================================================================
@router.get("/stats", response_model=RateLimitStatsResponse)
async def get_rate_limit_stats(
auth_result: AuthResult = Depends(require_admin),
):
"""
Get current rate limit statistics.
Returns configuration values, current usage counts, and blocklist stats.
"""
rate_limit_service = get_rate_limit_service()
email_validation = get_email_validation_service()
# Get YouTube uploads today
youtube_today = rate_limit_service.get_youtube_uploads_today()
youtube_limit = settings.rate_limit_youtube_uploads_per_day
youtube_remaining = max(0, youtube_limit - youtube_today) if youtube_limit > 0 else -1
# Get blocklist stats
blocklist_stats = email_validation.get_blocklist_stats()
# Get override count
overrides = rate_limit_service.get_all_overrides()
return RateLimitStatsResponse(
jobs_per_day_limit=settings.rate_limit_jobs_per_day,
youtube_uploads_per_day_limit=settings.rate_limit_youtube_uploads_per_day,
beta_ip_per_day_limit=settings.rate_limit_beta_ip_per_day,
rate_limiting_enabled=settings.enable_rate_limiting,
youtube_uploads_today=youtube_today,
youtube_uploads_remaining=youtube_remaining,
disposable_domains_count=blocklist_stats["disposable_domains_count"],
blocked_emails_count=blocklist_stats["blocked_emails_count"],
blocked_ips_count=blocklist_stats["blocked_ips_count"],
total_overrides=len(overrides),
)
@router.get("/users/{email}", response_model=UserRateLimitStatusResponse)
async def get_user_rate_limit_status(
email: str,
auth_result: AuthResult = Depends(require_admin),
):
"""
Get rate limit status for a specific user.
Returns their current usage and any override settings.
"""
rate_limit_service = get_rate_limit_service()
jobs_today = rate_limit_service.get_user_job_count_today(email)
override = rate_limit_service.get_user_override(email)
if override:
has_bypass = override.get("bypass_job_limit", False)
custom_limit = override.get("custom_daily_job_limit")
bypass_reason = override.get("reason")
jobs_limit = custom_limit if custom_limit is not None else settings.rate_limit_jobs_per_day
else:
has_bypass = False
custom_limit = None
bypass_reason = None
jobs_limit = settings.rate_limit_jobs_per_day
jobs_remaining = max(0, jobs_limit - jobs_today) if not has_bypass else -1
return UserRateLimitStatusResponse(
email=email,
jobs_today=jobs_today,
jobs_limit=jobs_limit,
jobs_remaining=jobs_remaining,
has_bypass=has_bypass,
custom_limit=custom_limit,
bypass_reason=bypass_reason,
)
# =============================================================================
# Blocklist Management Endpoints
# =============================================================================
@router.get("/blocklists", response_model=BlocklistsResponse)
async def get_blocklists(
auth_result: AuthResult = Depends(require_admin),
):
"""
Get all blocklist data.
Returns disposable domains, blocked emails, and blocked IPs.
"""
email_validation = get_email_validation_service()
# Force refresh to get latest data
config = email_validation.get_blocklist_config(force_refresh=True)
# Get the raw document for metadata
from google.cloud import firestore
from backend.services.firestore_service import get_firestore_client
from backend.services.email_validation_service import BLOCKLISTS_COLLECTION, BLOCKLIST_CONFIG_DOC
db = get_firestore_client()
doc = db.collection(BLOCKLISTS_COLLECTION).document(BLOCKLIST_CONFIG_DOC).get()
updated_at = None
updated_by = None
if doc.exists:
data = doc.to_dict()
updated_at = data.get("updated_at")
updated_by = data.get("updated_by")
return BlocklistsResponse(
disposable_domains=sorted(list(config["disposable_domains"])),
blocked_emails=sorted(list(config["blocked_emails"])),
blocked_ips=sorted(list(config["blocked_ips"])),
updated_at=updated_at,
updated_by=updated_by,
)
@router.post("/blocklists/disposable-domains", response_model=SuccessResponse)
async def add_disposable_domain(
request: DomainRequest,
auth_result: AuthResult = Depends(require_admin),
):
"""Add a domain to the disposable domains blocklist."""
email_validation = get_email_validation_service()
domain = request.domain.lower().strip()
if not domain or "." not in domain:
raise HTTPException(status_code=400, detail="Invalid domain format")
email_validation.add_disposable_domain(domain, auth_result.user_email)
return SuccessResponse(
success=True,
message=f"Domain '{domain}' added to disposable domains blocklist"
)
@router.delete("/blocklists/disposable-domains/{domain}", response_model=SuccessResponse)
async def remove_disposable_domain(
domain: str,
auth_result: AuthResult = Depends(require_admin),
):
"""Remove a domain from the disposable domains blocklist."""
email_validation = get_email_validation_service()
domain = domain.lower().strip()
if not email_validation.remove_disposable_domain(domain, auth_result.user_email):
raise HTTPException(status_code=404, detail="Domain not found in blocklist")
return SuccessResponse(
success=True,
message=f"Domain '{domain}' removed from disposable domains blocklist"
)
@router.post("/blocklists/blocked-emails", response_model=SuccessResponse)
async def add_blocked_email(
request: EmailRequest,
auth_result: AuthResult = Depends(require_admin),
):
"""Add an email to the blocked emails list."""
email_validation = get_email_validation_service()
email = request.email.lower().strip()
if not email or "@" not in email:
raise HTTPException(status_code=400, detail="Invalid email format")
email_validation.add_blocked_email(email, auth_result.user_email)
return SuccessResponse(
success=True,
message=f"Email '{email}' added to blocked emails list"
)
@router.delete("/blocklists/blocked-emails/{email}", response_model=SuccessResponse)
async def remove_blocked_email(
email: str,
auth_result: AuthResult = Depends(require_admin),
):
"""Remove an email from the blocked emails list."""
email_validation = get_email_validation_service()
email = email.lower().strip()
if not email_validation.remove_blocked_email(email, auth_result.user_email):
raise HTTPException(status_code=404, detail="Email not found in blocklist")
return SuccessResponse(
success=True,
message=f"Email '{email}' removed from blocked emails list"
)
@router.post("/blocklists/blocked-ips", response_model=SuccessResponse)
async def add_blocked_ip(
request: IPRequest,
auth_result: AuthResult = Depends(require_admin),
):
"""Add an IP address to the blocked IPs list."""
email_validation = get_email_validation_service()
ip_address = request.ip_address.strip()
if not ip_address:
raise HTTPException(status_code=400, detail="Invalid IP address")
email_validation.add_blocked_ip(ip_address, auth_result.user_email)
return SuccessResponse(
success=True,
message=f"IP '{ip_address}' added to blocked IPs list"
)
@router.delete("/blocklists/blocked-ips/{ip_address}", response_model=SuccessResponse)
async def remove_blocked_ip(
ip_address: str,
auth_result: AuthResult = Depends(require_admin),
):
"""Remove an IP address from the blocked IPs list."""
email_validation = get_email_validation_service()
ip_address = ip_address.strip()
if not email_validation.remove_blocked_ip(ip_address, auth_result.user_email):
raise HTTPException(status_code=404, detail="IP not found in blocklist")
return SuccessResponse(
success=True,
message=f"IP '{ip_address}' removed from blocked IPs list"
)
# =============================================================================
# User Override Management Endpoints
# =============================================================================
@router.get("/overrides", response_model=UserOverridesListResponse)
async def get_all_overrides(
auth_result: AuthResult = Depends(require_admin),
):
"""Get all user overrides."""
rate_limit_service = get_rate_limit_service()
overrides_data = rate_limit_service.get_all_overrides()
overrides = [
UserOverride(
email=email,
bypass_job_limit=data.get("bypass_job_limit", False),
custom_daily_job_limit=data.get("custom_daily_job_limit"),
reason=data.get("reason", ""),
created_by=data.get("created_by", "unknown"),
created_at=data.get("created_at", datetime.now(timezone.utc)),
)
for email, data in overrides_data.items()
]
return UserOverridesListResponse(
overrides=overrides,
total=len(overrides),
)
@router.put("/overrides/{email}", response_model=SuccessResponse)
async def set_user_override(
email: str,
request: UserOverrideRequest,
auth_result: AuthResult = Depends(require_admin),
):
"""Set or update a user override."""
rate_limit_service = get_rate_limit_service()
email = email.lower().strip()
if not email or "@" not in email:
raise HTTPException(status_code=400, detail="Invalid email format")
if not request.reason or len(request.reason.strip()) < 3:
raise HTTPException(status_code=400, detail="Reason is required (min 3 characters)")
rate_limit_service.set_user_override(
user_email=email,
bypass_job_limit=request.bypass_job_limit,
custom_daily_job_limit=request.custom_daily_job_limit,
reason=request.reason,
admin_email=auth_result.user_email,
)
return SuccessResponse(
success=True,
message=f"Override set for user '{email}'"
)
@router.delete("/overrides/{email}", response_model=SuccessResponse)
async def remove_user_override(
email: str,
auth_result: AuthResult = Depends(require_admin),
):
"""Remove a user override."""
rate_limit_service = get_rate_limit_service()
email = email.lower().strip()
if not rate_limit_service.remove_user_override(email, auth_result.user_email):
raise HTTPException(status_code=404, detail="Override not found for user")
return SuccessResponse(
success=True,
message=f"Override removed for user '{email}'"
)
+13 -6
View File
@@ -412,7 +412,10 @@ async def generate_preview_video(
# Check if GCE preview encoding is enabled
use_gce_preview = encoding_service.is_preview_enabled
logger.info(f"Job {job_id}: Generating preview video (GCE preview: {use_gce_preview})")
# Check if user wants theme background image (slower) or black background (faster, default)
use_background_image = updated_data.get("use_background_image", False)
logger.info(f"Job {job_id}: Generating preview video (GCE: {use_gce_preview}, background image: {use_background_image})")
# Use tracing and job_log_context for full observability
with create_span("generate-preview-video", {"job_id": job_id, "use_gce": use_gce_preview}) as span:
@@ -498,12 +501,16 @@ async def generate_preview_video(
# Get background image and font from style assets if available
style_assets = job.style_assets or {}
# Only use background image if user explicitly requested it
# Default is black background for faster preview generation (~10s vs ~30-60s)
background_image_gcs_path = None
for key in ["karaoke_background", "style_karaoke_background"]:
if key in style_assets:
background_image_gcs_path = f"gs://{bucket_name}/{style_assets[key]}"
gce_span.set_attribute("background_image", background_image_gcs_path)
break
if use_background_image:
for key in ["karaoke_background", "style_karaoke_background"]:
if key in style_assets:
background_image_gcs_path = f"gs://{bucket_name}/{style_assets[key]}"
gce_span.set_attribute("background_image", background_image_gcs_path)
break
gce_span.set_attribute("use_background_image", use_background_image)
font_gcs_path = None
for key in ["font", "style_font"]:
+120
View File
@@ -0,0 +1,120 @@
"""
Tenant API routes for white-label portal configuration.
These endpoints are public (no auth required) since the frontend needs
to fetch tenant branding before the user logs in.
"""
import logging
from typing import Optional
from fastapi import APIRouter, Query, Request
from backend.models.tenant import TenantConfigResponse, TenantPublicConfig
from backend.services.tenant_service import get_tenant_service
logger = logging.getLogger(__name__)
router = APIRouter(prefix="/api/tenant", tags=["tenant"])
@router.get("/config", response_model=TenantConfigResponse)
async def get_tenant_config(
request: Request,
tenant: Optional[str] = Query(
None,
description="Tenant ID override (for development). If not provided, detected from subdomain.",
),
):
"""
Get tenant configuration for the current portal.
This endpoint detects the tenant from:
1. Query parameter `tenant` (for development/testing)
2. X-Tenant-ID header (set by frontend)
3. Host header subdomain
Returns the public tenant configuration (branding, features, defaults)
or indicates this is the default Nomad Karaoke portal.
"""
tenant_service = get_tenant_service()
# Priority 1: Query parameter (for dev/testing)
tenant_id = tenant
# Priority 2: X-Tenant-ID header
if not tenant_id:
tenant_id = request.headers.get("X-Tenant-ID")
# Priority 3: Detect from Host header
if not tenant_id:
host = request.headers.get("Host", "")
# Check if this is a tenant subdomain
# Pattern: {tenant}.nomadkaraoke.com or {tenant}.gen.nomadkaraoke.com
if host and "nomadkaraoke.com" in host.lower():
parts = host.lower().split(".")
# Skip known non-tenant subdomains
if parts[0] not in ["gen", "api", "www", "buy", "admin"]:
potential_tenant = parts[0]
if tenant_service.tenant_exists(potential_tenant):
tenant_id = potential_tenant
# If no tenant detected, return default config
if not tenant_id:
logger.debug("No tenant detected, returning default config")
return TenantConfigResponse(tenant=None, is_default=True)
# Load tenant config
public_config = tenant_service.get_public_config(tenant_id)
if not public_config:
logger.warning(f"Tenant not found: {tenant_id}")
return TenantConfigResponse(tenant=None, is_default=True)
if not public_config.is_active:
logger.warning(f"Tenant is inactive: {tenant_id}")
return TenantConfigResponse(tenant=None, is_default=True)
logger.info(f"Returning config for tenant: {tenant_id}")
return TenantConfigResponse(tenant=public_config, is_default=False)
@router.get("/config/{tenant_id}", response_model=TenantConfigResponse)
async def get_tenant_config_by_id(tenant_id: str):
"""
Get tenant configuration by explicit tenant ID.
This is useful for admin tools or debugging.
"""
tenant_service = get_tenant_service()
public_config = tenant_service.get_public_config(tenant_id)
if not public_config:
return TenantConfigResponse(tenant=None, is_default=True)
# Check if tenant is active
if not public_config.is_active:
logger.warning(f"Tenant is inactive: {tenant_id}")
return TenantConfigResponse(tenant=None, is_default=True)
return TenantConfigResponse(tenant=public_config, is_default=False)
@router.get("/asset/{tenant_id}/{asset_name}")
async def get_tenant_asset(tenant_id: str, asset_name: str):
"""
Get a signed URL for a tenant asset (logo, favicon, etc.).
This redirects to the signed GCS URL for the asset.
"""
from fastapi.responses import RedirectResponse
tenant_service = get_tenant_service()
url = tenant_service.get_asset_url(tenant_id, asset_name)
if not url:
from fastapi import HTTPException
raise HTTPException(status_code=404, detail="Asset not found")
return RedirectResponse(url=url)
+227 -245
View File
@@ -8,8 +8,28 @@ Handles:
- Stripe checkout and webhooks
- Admin user management
"""
import hashlib
import logging
from typing import Optional, Tuple
def _mask_email(email: str) -> str:
"""Mask email for logging to avoid PII exposure.
Example: test@example.com -> te***@ex***.com
"""
if not email or "@" not in email:
return "***"
local, domain = email.split("@", 1)
masked_local = local[:2] + "***" if len(local) > 2 else "***"
domain_parts = domain.split(".")
if len(domain_parts) >= 2:
masked_domain = domain_parts[0][:2] + "***." + domain_parts[-1]
else:
masked_domain = "***"
return f"{masked_local}@{masked_domain}"
from fastapi import APIRouter, HTTPException, Depends, Request, Header
from pydantic import BaseModel, EmailStr
@@ -33,6 +53,10 @@ from backend.services.user_service import get_user_service, UserService, USERS_C
from backend.services.email_service import get_email_service, EmailService
from backend.services.stripe_service import get_stripe_service, StripeService, CREDIT_PACKAGES
from backend.services.theme_service import get_theme_service
from backend.services.job_defaults_service import (
get_effective_distribution_settings,
resolve_cdg_txt_defaults,
)
from backend.api.dependencies import require_admin
from backend.api.routes.file_upload import _prepare_theme_for_job
from backend.services.auth_service import UserType
@@ -60,8 +84,8 @@ class CreateCheckoutResponse(BaseModel):
message: str
class DoneForYouCheckoutRequest(BaseModel):
"""Request to create a done-for-you karaoke video order."""
class MadeForYouCheckoutRequest(BaseModel):
"""Request to create a made-for-you karaoke video order."""
email: EmailStr
artist: str
title: str
@@ -112,7 +136,11 @@ async def send_magic_link(
The user will receive an email with a link that logs them in.
Links expire after 15 minutes and can only be used once.
For white-label tenants, validates email domain against tenant config.
"""
from backend.middleware.tenant import get_tenant_from_request, get_tenant_config_from_request
# Check if email service is configured
if not email_service.is_configured():
logger.error("Email service not configured - cannot send magic links")
@@ -123,19 +151,39 @@ async def send_magic_link(
email = request.email.lower()
# Get tenant context from middleware
tenant_id = get_tenant_from_request(http_request)
tenant_config = get_tenant_config_from_request(http_request)
# Validate email domain for tenant if configured
if tenant_config and tenant_config.auth.allowed_email_domains:
if not tenant_config.is_email_allowed(email):
logger.warning(f"Email domain not allowed for tenant {tenant_id}: {_mask_email(email)}")
# Return success anyway to prevent email enumeration
return SendMagicLinkResponse(
status="success",
message="If this email is registered, you will receive a sign-in link shortly."
)
# Get client info for security logging
ip_address = http_request.client.host if http_request.client else None
user_agent = http_request.headers.get("user-agent")
# Create magic link token
# Create magic link token with tenant context
magic_link = user_service.create_magic_link(
email,
ip_address=ip_address,
user_agent=user_agent
user_agent=user_agent,
tenant_id=tenant_id
)
# Send email
sent = email_service.send_magic_link(email, magic_link.token)
# Get tenant-specific sender email
sender_email = None
if tenant_config:
sender_email = tenant_config.get_sender_email()
# Send email (with tenant-specific sender if configured)
sent = email_service.send_magic_link(email, magic_link.token, sender_email=sender_email)
if not sent:
logger.error(f"Failed to send magic link email to {email}")
@@ -159,18 +207,26 @@ async def verify_magic_link(
Verify a magic link token and create a session.
Returns a session token that should be stored and used for subsequent requests.
The session will be associated with the tenant from the magic link.
"""
# Reject empty tokens early to avoid invalid Firestore document paths
if not token or not token.strip():
raise HTTPException(status_code=401, detail="Invalid token")
# Get client info
ip_address = http_request.client.host if http_request.client else None
user_agent = http_request.headers.get("user-agent")
# Check if this is a first login BEFORE verification (which sets last_login_at)
# We need to get the user's state before verify_magic_link updates it
# Also extract tenant_id from the magic link for session creation
from backend.services.user_service import MAGIC_LINKS_COLLECTION
magic_link_doc = user_service.db.collection(MAGIC_LINKS_COLLECTION).document(token).get()
is_first_login = False
magic_link_tenant_id = None
if magic_link_doc.exists:
magic_link_data = magic_link_doc.to_dict()
magic_link_tenant_id = magic_link_data.get('tenant_id')
pre_verify_user = user_service.get_user(magic_link_data.get('email', ''))
if pre_verify_user:
is_first_login = pre_verify_user.total_jobs_created == 0 and not pre_verify_user.last_login_at
@@ -181,18 +237,19 @@ async def verify_magic_link(
if not success or not user:
raise HTTPException(status_code=401, detail=message)
# Create session
# Create session with tenant context from the magic link
session = user_service.create_session(
user.email,
ip_address=ip_address,
user_agent=user_agent
user_agent=user_agent,
tenant_id=magic_link_tenant_id
)
# Send welcome email to first-time users
if is_first_login:
email_service.send_welcome_email(user.email, user.credits)
# Return user info
# Return user info with tenant_id
user_public = UserPublic(
email=user.email,
role=user.role,
@@ -200,6 +257,7 @@ async def verify_magic_link(
display_name=user.display_name,
total_jobs_created=user.total_jobs_created,
total_jobs_completed=user.total_jobs_completed,
tenant_id=user.tenant_id,
)
return VerifyMagicLinkResponse(
@@ -340,13 +398,13 @@ async def create_checkout(
)
@router.post("/done-for-you/checkout", response_model=CreateCheckoutResponse)
async def create_done_for_you_checkout(
request: DoneForYouCheckoutRequest,
@router.post("/made-for-you/checkout", response_model=CreateCheckoutResponse)
async def create_made_for_you_checkout(
request: MadeForYouCheckoutRequest,
stripe_service: StripeService = Depends(get_stripe_service),
):
"""
Create a Stripe checkout session for a done-for-you karaoke video order.
Create a Stripe checkout session for a made-for-you karaoke video order.
This is the full-service option where Nomad Karaoke handles everything:
- Finding or processing the audio
@@ -360,7 +418,7 @@ async def create_done_for_you_checkout(
if not stripe_service.is_configured():
raise HTTPException(status_code=503, detail="Payment processing is not available")
success, checkout_url, message = stripe_service.create_done_for_you_checkout_session(
success, checkout_url, message = stripe_service.create_made_for_you_checkout_session(
customer_email=request.email,
artist=request.artist,
title=request.title,
@@ -383,22 +441,28 @@ async def create_done_for_you_checkout(
# Stripe Webhooks
# =============================================================================
# Admin email for done-for-you order notifications
ADMIN_EMAIL = "andrew@nomadkaraoke.com"
# Admin email for made-for-you order notifications
ADMIN_EMAIL = "madeforyou@nomadkaraoke.com"
async def _handle_done_for_you_order(
async def _handle_made_for_you_order(
session_id: str,
metadata: dict,
user_service: UserService,
email_service: EmailService,
) -> None:
"""
Handle a completed done-for-you order by creating a job and notifying Andrew.
Handle a completed made-for-you order by creating a job and notifying Andrew.
For orders with a YouTube URL, the job is created and workers are triggered immediately.
For orders without a URL (search mode), the audio search flow is used to find and
download the best matching audio source automatically.
The made-for-you flow:
1. Job is created with made_for_you=True, owned by admin during processing
2. For search orders: audio search runs, results stored, job pauses at AWAITING_AUDIO_SELECTION
3. Admin receives notification email with link to select audio source
4. Customer receives order confirmation email
5. Admin selects audio in UI, job proceeds through normal pipeline
6. On completion, ownership transfers to customer
For orders with a YouTube URL, workers are triggered immediately (no search needed).
Args:
session_id: Stripe checkout session ID
@@ -427,7 +491,7 @@ async def _handle_done_for_you_order(
notes = metadata.get("notes", "")
logger.info(
f"Processing done-for-you order: {artist} - {title} for {customer_email} "
f"Processing made-for-you order: {artist} - {title} for {customer_email} "
f"(session: {session_id}, source_type: {source_type})"
)
@@ -440,32 +504,55 @@ async def _handle_done_for_you_order(
theme_service = get_theme_service()
effective_theme_id = theme_service.get_default_theme_id()
if effective_theme_id:
logger.info(f"Applying default theme '{effective_theme_id}' for done-for-you order")
logger.info(f"Applying default theme '{effective_theme_id}' for made-for-you order")
# Create job for the customer
# Note: done-for-you jobs should NOT be non_interactive - Andrew needs to review
# Get distribution defaults using centralized service
dist = get_effective_distribution_settings()
# Resolve CDG/TXT defaults based on theme (uses centralized service)
# This ensures made-for-you jobs get the same CDG/TXT defaults as regular jobs
resolved_cdg, resolved_txt = resolve_cdg_txt_defaults(effective_theme_id)
# Create job with admin ownership during processing
# CRITICAL: made_for_you=True, user_email=ADMIN_EMAIL, customer_email for delivery
# auto_download=False to pause at audio selection for admin to choose
job_create = JobCreate(
url=youtube_url if youtube_url else None,
artist=artist,
title=title,
user_email=customer_email, # Customer owns the job
user_email=ADMIN_EMAIL, # Admin owns during processing
theme_id=effective_theme_id, # Apply default theme
non_interactive=False, # Andrew will review lyrics/instrumental
# Set audio search fields for search-based orders
non_interactive=False, # Admin will review lyrics/instrumental
# Made-for-you specific fields
made_for_you=True, # Flag for ownership transfer on completion
customer_email=customer_email, # Customer email for final delivery
customer_notes=notes if notes else None, # Customer's special requests
# Audio search fields for search-based orders
audio_search_artist=artist if not youtube_url else None,
audio_search_title=title if not youtube_url else None,
auto_download=True, # Auto-select best audio source
auto_download=False, # Pause at audio selection for admin to choose
# CDG/TXT settings (resolved via centralized service)
enable_cdg=resolved_cdg,
enable_txt=resolved_txt,
# Distribution settings from centralized defaults
enable_youtube_upload=dist.enable_youtube_upload,
dropbox_path=dist.dropbox_path,
gdrive_folder_id=dist.gdrive_folder_id,
brand_prefix=dist.brand_prefix,
discord_webhook_url=dist.discord_webhook_url,
youtube_description=dist.youtube_description,
)
job = job_manager.create_job(job_create)
# Made-for-you jobs are created by admin (via Stripe webhook) - bypass rate limits
job = job_manager.create_job(job_create, is_admin=True)
job_id = job.job_id
logger.info(f"Created done-for-you job {job_id} for {customer_email}")
logger.info(f"Created made-for-you job {job_id} for {_mask_email(customer_email)} (owned by {_mask_email(ADMIN_EMAIL)})")
# Prepare theme style assets for the job (same as audio_search endpoint)
if effective_theme_id:
try:
style_params_path, theme_style_assets, youtube_desc = _prepare_theme_for_job(
job_id, effective_theme_id, None # No color overrides for done-for-you
job_id, effective_theme_id, None # No color overrides for made-for-you
)
theme_update = {
'style_params_gcs_path': style_params_path,
@@ -474,9 +561,9 @@ async def _handle_done_for_you_order(
if youtube_desc:
theme_update['youtube_description_template'] = youtube_desc
job_manager.update_job(job_id, theme_update)
logger.info(f"Applied theme '{effective_theme_id}' to done-for-you job {job_id}")
logger.info(f"Applied theme '{effective_theme_id}' to made-for-you job {job_id}")
except Exception as e:
logger.warning(f"Failed to prepare theme for done-for-you job {job_id}: {e}")
logger.warning(f"Failed to prepare theme for made-for-you job {job_id}: {e}")
# Mark session as processed for idempotency
# Note: Using internal method since this isn't a credit transaction
@@ -486,23 +573,27 @@ async def _handle_done_for_you_order(
amount=0 # No credits, just tracking the session
)
# Initialize search_results for later use in email notification
search_results = None
# Handle based on whether we have a YouTube URL or need to search
if youtube_url:
# URL provided - trigger workers directly
# URL provided - trigger workers directly (no audio selection needed)
logger.info(f"Job {job_id}: YouTube URL provided, triggering workers")
await asyncio.gather(
worker_service.trigger_audio_worker(job_id),
worker_service.trigger_lyrics_worker(job_id)
)
else:
# No URL - use audio search flow with auto_download
# No URL - use audio search flow, pause for admin selection
# Made-for-you jobs require admin to select audio source
logger.info(f"Job {job_id}: No URL, using audio search for '{artist} - {title}'")
# Update job with audio search fields
job_manager.update_job(job_id, {
'audio_search_artist': artist,
'audio_search_title': title,
'auto_download': True,
'auto_download': False, # Admin must select
})
# Transition to searching state
@@ -519,7 +610,8 @@ async def _handle_done_for_you_order(
try:
search_results = audio_search_service.search(artist, title)
except NoResultsError as e:
# No results found - transition to AWAITING_AUDIO_SELECTION so Andrew can handle manually
# No results found - still transition to AWAITING_AUDIO_SELECTION
# Admin can manually provide audio
logger.warning(f"Job {job_id}: No audio sources found for '{artist} - {title}'")
job_manager.transition_to_state(
job_id=job_id,
@@ -527,7 +619,6 @@ async def _handle_done_for_you_order(
progress=10,
message=f"No automatic audio sources found. Manual intervention required."
)
# Don't fail the job - Andrew can manually provide audio
search_results = None
except AudioSearchError as e:
logger.error(f"Job {job_id}: Audio search failed: {e}")
@@ -540,7 +631,7 @@ async def _handle_done_for_you_order(
search_results = None
if search_results:
# Store search results in state_data
# Store search results in state_data for admin to review
results_dicts = [r.to_dict() for r in search_results]
state_data_update = {
'audio_search_results': results_dicts,
@@ -550,225 +641,61 @@ async def _handle_done_for_you_order(
state_data_update['remote_search_id'] = audio_search_service.last_remote_search_id
job_manager.update_job(job_id, {'state_data': state_data_update})
# Auto-select best result and download
best_index = audio_search_service.select_best(search_results)
selected = results_dicts[best_index]
# Transition to AWAITING_AUDIO_SELECTION for admin to choose
# Do NOT auto-select or download - admin must review and select
logger.info(f"Job {job_id}: Found {len(results_dicts)} audio sources, awaiting admin selection")
logger.info(f"Job {job_id}: Auto-selected result {best_index}: {selected.get('provider')} - {selected.get('title')}")
# Transition to downloading state
# Transition to AWAITING_AUDIO_SELECTION for admin to choose
# Admin will select from results in the UI, then job proceeds
job_manager.transition_to_state(
job_id=job_id,
new_status=JobStatus.DOWNLOADING_AUDIO,
new_status=JobStatus.AWAITING_AUDIO_SELECTION,
progress=10,
message=f"Downloading from {selected.get('provider')}: {selected.get('artist')} - {selected.get('title')}",
state_data_updates={
'selected_audio_index': best_index,
'selected_audio_provider': selected.get('provider'),
}
message=f"Found {len(results_dicts)} audio sources. Awaiting admin selection."
)
# Download audio
try:
is_torrent_source = selected.get('provider') in ['RED', 'OPS']
is_remote_enabled = audio_search_service.is_remote_enabled()
source_id = selected.get('source_id')
source_name = selected.get('provider')
target_file = selected.get('target_file')
download_url = selected.get('url')
remote_search_id = state_data_update.get('remote_search_id')
# Get audio source count for admin notification
# (search_results may be set from the search flow above, or None for YouTube URL orders)
audio_source_count = len(search_results) if search_results else 0
if is_torrent_source and is_remote_enabled:
# Remote torrent download - upload directly to GCS
gcs_destination = f"uploads/{job_id}/audio/"
# Generate admin login token for one-click email access (24hr expiry)
admin_login = user_service.create_admin_login_token(
email=ADMIN_EMAIL,
expiry_hours=24,
)
if source_id and source_name:
result = audio_search_service.download_by_id(
source_name=source_name,
source_id=source_id,
output_dir="",
target_file=target_file,
download_url=download_url,
gcs_path=gcs_destination,
)
else:
result = audio_search_service.download(
result_index=best_index,
output_dir="",
gcs_path=gcs_destination,
remote_search_id=remote_search_id,
)
# Extract GCS path
if result.filepath.startswith("gs://"):
parts = result.filepath.replace("gs://", "").split("/", 1)
audio_gcs_path = parts[1] if len(parts) == 2 else result.filepath
filename = os.path.basename(result.filepath)
else:
filename = os.path.basename(result.filepath)
audio_gcs_path = f"uploads/{job_id}/audio/{filename}"
else:
# Local download (YouTube or local torrent)
temp_dir = tempfile.mkdtemp(prefix=f"audio_download_{job_id}_")
import shutil
try:
if source_id and source_name and is_remote_enabled:
result = audio_search_service.download_by_id(
source_name=source_name,
source_id=source_id,
output_dir=temp_dir,
target_file=target_file,
download_url=download_url,
)
elif source_name == 'YouTube' and download_url:
# YouTube download
from backend.workers.audio_worker import download_from_url
local_path = await download_from_url(
download_url,
temp_dir,
selected.get('artist'),
selected.get('title')
)
if not local_path or not os.path.exists(local_path):
raise Exception(f"Failed to download from YouTube: {download_url}")
class DownloadResult:
def __init__(self, filepath):
self.filepath = filepath
result = DownloadResult(local_path)
else:
result = audio_search_service.download(
result_index=best_index,
output_dir=temp_dir,
remote_search_id=remote_search_id,
)
# Upload to GCS
filename = os.path.basename(result.filepath)
audio_gcs_path = f"uploads/{job_id}/audio/{filename}"
with open(result.filepath, 'rb') as f:
storage_service.upload_fileobj(f, audio_gcs_path, content_type='audio/flac')
finally:
# Always cleanup temp directory
shutil.rmtree(temp_dir, ignore_errors=True)
# Update job with GCS path
job_manager.update_job(job_id, {
'input_media_gcs_path': audio_gcs_path,
'filename': filename,
})
# Transition to DOWNLOADING and trigger workers
job_manager.transition_to_state(
job_id=job_id,
new_status=JobStatus.DOWNLOADING,
progress=15,
message="Audio downloaded, starting processing"
)
# Trigger workers
await asyncio.gather(
worker_service.trigger_audio_worker(job_id),
worker_service.trigger_lyrics_worker(job_id)
)
logger.info(f"Job {job_id}: Audio downloaded and workers triggered")
except Exception as download_error:
logger.error(f"Job {job_id}: Audio download failed: {download_error}")
# Don't fail job - transition to awaiting selection so Andrew can handle
job_manager.transition_to_state(
job_id=job_id,
new_status=JobStatus.AWAITING_AUDIO_SELECTION,
progress=10,
message=f"Auto-download failed: {download_error}. Manual intervention required."
)
# Send confirmation email to customer
email_service.send_email(
# Send confirmation email to customer using professional template
email_service.send_made_for_you_order_confirmation(
to_email=customer_email,
subject=f"Your Karaoke Video Order: {artist} - {title}",
html_content=f"""
<h2>Thank you for your order!</h2>
<p>We've received your request for a karaoke video:</p>
<ul>
<li><strong>Artist:</strong> {artist}</li>
<li><strong>Title:</strong> {title}</li>
{f'<li><strong>Notes:</strong> {notes}</li>' if notes else ''}
</ul>
<p>Our team will review and create your video within <strong>24 hours</strong>.</p>
<p>You'll receive another email with download links when your video is ready.</p>
<p>If you have any questions, reply to this email or contact us at support@nomadkaraoke.com</p>
<p>Thanks for using Nomad Karaoke!</p>
""",
text_content=f"""
Thank you for your order!
We've received your request for a karaoke video:
- Artist: {artist}
- Title: {title}
{f'- Notes: {notes}' if notes else ''}
Our team will review and create your video within 24 hours.
You'll receive another email with download links when your video is ready.
If you have any questions, reply to this email or contact us at support@nomadkaraoke.com
Thanks for using Nomad Karaoke!
""".strip(),
artist=artist,
title=title,
job_id=job_id,
notes=notes,
)
# Send notification email to Andrew
email_service.send_email(
# Send notification email to admin using professional template
email_service.send_made_for_you_admin_notification(
to_email=ADMIN_EMAIL,
subject=f"[Done For You Order] {artist} - {title}",
html_content=f"""
<h2>New Done-For-You Order</h2>
<p>A customer has ordered a karaoke video:</p>
<ul>
<li><strong>Customer:</strong> {customer_email}</li>
<li><strong>Artist:</strong> {artist}</li>
<li><strong>Title:</strong> {title}</li>
<li><strong>Source:</strong> {source_type}</li>
{f'<li><strong>YouTube URL:</strong> <a href="{youtube_url}">{youtube_url}</a></li>' if youtube_url else ''}
{f'<li><strong>Notes:</strong> {notes}</li>' if notes else ''}
</ul>
<p><strong>Job ID:</strong> {job_id}</p>
<p>View job in admin: <a href="https://gen.nomadkaraoke.com/admin/jobs/{job_id}">Admin Link</a></p>
<p>View job as customer: <a href="https://gen.nomadkaraoke.com/jobs/{job_id}">Customer Link</a></p>
<p><strong>Deadline:</strong> 24 hours from now</p>
""",
text_content=f"""
New Done-For-You Order
Customer: {customer_email}
Artist: {artist}
Title: {title}
Source: {source_type}
{f'YouTube URL: {youtube_url}' if youtube_url else ''}
{f'Notes: {notes}' if notes else ''}
Job ID: {job_id}
Admin: https://gen.nomadkaraoke.com/admin/jobs/{job_id}
Customer: https://gen.nomadkaraoke.com/jobs/{job_id}
Deadline: 24 hours from now
""".strip(),
customer_email=customer_email,
artist=artist,
title=title,
job_id=job_id,
admin_login_token=admin_login.token,
notes=notes,
audio_source_count=audio_source_count,
)
logger.info(f"Sent done-for-you order notifications for job {job_id}")
logger.info(f"Sent made-for-you order notifications for job {job_id}")
except Exception as e:
logger.error(f"Error processing done-for-you order: {e}", exc_info=True)
logger.error(f"Error processing made-for-you order: {e}", exc_info=True)
# Still try to notify Andrew of the failure
try:
email_service.send_email(
to_email=ADMIN_EMAIL,
subject=f"[FAILED] Done For You Order: {artist} - {title}",
subject=f"[FAILED] Made For You Order: {artist} - {title}",
html_content=f"""
<h2>Done-For-You Order Failed</h2>
<h2>Made-For-You Order Failed</h2>
<p>An error occurred processing this order:</p>
<ul>
<li><strong>Customer:</strong> {customer_email}</li>
@@ -779,7 +706,7 @@ Deadline: 24 hours from now
<p>Please manually create this job and notify the customer.</p>
""",
text_content=f"""
Done-For-You Order Failed
Made-For-You Order Failed
Customer: {customer_email}
Artist: {artist}
@@ -834,10 +761,10 @@ async def stripe_webhook(
logger.info(f"Skipping already processed session: {session_id}")
return {"status": "received", "type": event_type, "note": "already_processed"}
# Check if this is a done-for-you order
if metadata.get("order_type") == "done_for_you":
# Handle done-for-you order - create a job
await _handle_done_for_you_order(
# Check if this is a made-for-you order
if metadata.get("order_type") == "made_for_you":
# Handle made-for-you order - create a job
await _handle_made_for_you_order(
session_id=session_id,
metadata=metadata,
user_service=user_service,
@@ -896,6 +823,9 @@ async def enroll_beta_tester(
Returns free credits and optionally a session token for new users.
"""
from backend.services.email_validation_service import get_email_validation_service
from backend.services.rate_limit_service import get_rate_limit_service
# Check if email service is configured
if not email_service.is_configured():
logger.error("Email service not configured - cannot send beta welcome emails")
@@ -905,6 +835,52 @@ async def enroll_beta_tester(
)
email = request.email.lower()
email_validation = get_email_validation_service()
rate_limit_service = get_rate_limit_service()
# ----- ABUSE PREVENTION CHECKS -----
# 1. Validate email (disposable domain, blocked email checks)
is_valid, error_message = email_validation.validate_email_for_beta(email)
if not is_valid:
logger.warning(f"Beta enrollment rejected - email validation failed: {email} - {error_message}")
raise HTTPException(
status_code=400,
detail=error_message
)
# 2. Check IP blocking
ip_address = http_request.client.host if http_request.client else None
if ip_address and email_validation.is_ip_blocked(ip_address):
logger.warning(f"Beta enrollment rejected - IP blocked: {ip_address}")
raise HTTPException(
status_code=403,
detail="Access denied from this location"
)
# 3. Check IP-based enrollment rate limit (1 per 24h per IP)
if ip_address:
allowed, remaining, message = rate_limit_service.check_beta_ip_limit(ip_address)
if not allowed:
logger.warning(f"Beta enrollment rejected - IP rate limit: {ip_address} - {message}")
raise HTTPException(
status_code=429,
detail="Too many beta enrollments from your location. Please try again tomorrow."
)
# 4. Check for duplicate enrollment via normalized email
normalized_email = email_validation.normalize_email(email)
if normalized_email != email:
# Check if normalized version is already enrolled
normalized_user = user_service.get_user(normalized_email)
if normalized_user and normalized_user.is_beta_tester:
logger.warning(f"Beta enrollment rejected - normalized email already enrolled: {email} -> {normalized_email}")
raise HTTPException(
status_code=400,
detail="An account with this email address is already enrolled in the beta program"
)
# ----- END ABUSE PREVENTION CHECKS -----
# Validate acceptance
if not request.accept_corrections_work:
@@ -929,8 +905,7 @@ async def enroll_beta_tester(
detail="You are already enrolled in the beta program"
)
# Get client info
ip_address = http_request.client.host if http_request.client else None
# Get client info (ip_address already set above in abuse prevention)
user_agent = http_request.headers.get("user-agent")
# Enroll as beta tester
@@ -950,6 +925,13 @@ async def enroll_beta_tester(
reason="beta_tester_enrollment",
)
# Record IP enrollment for rate limiting
if ip_address:
try:
rate_limit_service.record_beta_enrollment(ip_address, email)
except Exception as e:
logger.warning(f"Failed to record beta IP enrollment: {e}")
# Create session for the user (so they can start using the service immediately)
session = user_service.create_session(email, ip_address=ip_address, user_agent=user_agent)
+25 -1
View File
@@ -101,13 +101,37 @@ class Settings(BaseSettings):
# Default values for web service jobs (YouTube/Dropbox distribution)
default_enable_youtube_upload: bool = os.getenv("DEFAULT_ENABLE_YOUTUBE_UPLOAD", "false").lower() in ("true", "1", "yes")
default_brand_prefix: Optional[str] = os.getenv("DEFAULT_BRAND_PREFIX")
# Rate Limiting Configuration
# Enable/disable rate limiting system-wide (useful for development)
enable_rate_limiting: bool = os.getenv("ENABLE_RATE_LIMITING", "true").lower() in ("true", "1", "yes")
# Maximum jobs a user can create per day (0 = unlimited)
rate_limit_jobs_per_day: int = int(os.getenv("RATE_LIMIT_JOBS_PER_DAY", "5"))
# Maximum YouTube uploads system-wide per day (0 = unlimited)
rate_limit_youtube_uploads_per_day: int = int(os.getenv("RATE_LIMIT_YOUTUBE_UPLOADS_PER_DAY", "10"))
# Maximum beta enrollments from same IP per day (0 = unlimited)
rate_limit_beta_ip_per_day: int = int(os.getenv("RATE_LIMIT_BETA_IP_PER_DAY", "1"))
default_youtube_description: str = os.getenv(
"DEFAULT_YOUTUBE_DESCRIPTION",
"Karaoke video created with Nomad Karaoke (https://nomadkaraoke.com)\n\n"
"AI-powered vocal separation and synchronized lyrics.\n\n"
"#karaoke #music #singing #instrumental #lyrics"
)
# Default CDG/TXT generation settings
# When True, CDG and TXT packages are generated by default (when a theme is set)
# These can be overridden per-request via explicit enable_cdg/enable_txt parameters
default_enable_cdg: bool = os.getenv("DEFAULT_ENABLE_CDG", "true").lower() in ("true", "1", "yes")
default_enable_txt: bool = os.getenv("DEFAULT_ENABLE_TXT", "true").lower() in ("true", "1", "yes")
# Push Notifications Configuration
# When enabled, users can subscribe to push notifications for job status updates
enable_push_notifications: bool = os.getenv("ENABLE_PUSH_NOTIFICATIONS", "false").lower() in ("true", "1", "yes")
# Maximum number of push subscriptions per user (oldest removed when exceeded)
max_push_subscriptions_per_user: int = int(os.getenv("MAX_PUSH_SUBSCRIPTIONS_PER_USER", "5"))
# VAPID subject (email or URL for push service to contact)
vapid_subject: str = os.getenv("VAPID_SUBJECT", "mailto:gen@nomadkaraoke.com")
# Secret Manager cache
_secret_cache: Dict[str, str] = {}
+66
View File
@@ -0,0 +1,66 @@
"""
Custom exceptions for the karaoke generation backend.
These exceptions are used for structured error handling across the application,
particularly for rate limiting and validation errors.
"""
class RateLimitExceededError(Exception):
"""
Raised when a rate limit is exceeded.
Includes information about when the limit will reset for client retry logic.
Attributes:
message: Human-readable error message
limit_type: Type of limit exceeded (e.g., "jobs_per_day", "youtube_uploads")
remaining_seconds: Seconds until the limit resets (for Retry-After header)
current_count: Current usage count
limit_value: The limit that was exceeded
"""
def __init__(
self,
message: str,
limit_type: str = "unknown",
remaining_seconds: int = 0,
current_count: int = 0,
limit_value: int = 0
):
self.message = message
self.limit_type = limit_type
self.remaining_seconds = remaining_seconds
self.current_count = current_count
self.limit_value = limit_value
super().__init__(message)
class EmailValidationError(Exception):
"""
Raised when email validation fails.
Attributes:
message: Human-readable error message
reason: Specific reason for failure (e.g., "disposable", "blocked", "invalid")
"""
def __init__(self, message: str, reason: str = "invalid"):
self.message = message
self.reason = reason
super().__init__(message)
class IPBlockedError(Exception):
"""
Raised when a request comes from a blocked IP address.
Attributes:
message: Human-readable error message
ip_address: The blocked IP address (may be partially masked)
"""
def __init__(self, message: str, ip_address: str = ""):
self.message = message
self.ip_address = ip_address
super().__init__(message)
+31 -1
View File
@@ -7,13 +7,14 @@ from fastapi import FastAPI
from fastapi.middleware.cors import CORSMiddleware
from backend.config import settings
from backend.api.routes import health, jobs, internal, file_upload, review, auth, audio_search, themes, users, admin
from backend.api.routes import health, jobs, internal, file_upload, review, auth, audio_search, themes, users, admin, tenant, rate_limits, push
from backend.services.tracing import setup_tracing, instrument_app, get_current_trace_id
from backend.services.structured_logging import setup_structured_logging
from backend.services.spacy_preloader import preload_spacy_model
from backend.services.nltk_preloader import preload_all_nltk_resources
from backend.services.langfuse_preloader import preload_langfuse_handler
from backend.middleware.audit_logging import AuditLoggingMiddleware
from backend.middleware.tenant import TenantMiddleware
from backend.version import VERSION
@@ -128,6 +129,9 @@ app.add_middleware(
# Add audit logging middleware (captures all requests with request_id for correlation)
app.add_middleware(AuditLoggingMiddleware)
# Add tenant detection middleware (extracts tenant from subdomain/headers)
app.add_middleware(TenantMiddleware)
# Include routers
app.include_router(health.router, prefix="/api")
app.include_router(jobs.router, prefix="/api")
@@ -139,6 +143,32 @@ app.include_router(audio_search.router, prefix="/api") # Audio search (artist+t
app.include_router(themes.router, prefix="/api") # Theme selection for styles
app.include_router(users.router, prefix="/api") # User auth, credits, and Stripe webhooks
app.include_router(admin.router, prefix="/api") # Admin dashboard and management
app.include_router(rate_limits.router, prefix="/api") # Rate limits admin management
app.include_router(push.router, prefix="/api") # Push notification subscription management
app.include_router(tenant.router) # Tenant/white-label configuration (no /api prefix, router has it)
# Exception handler for rate limiting
from fastapi import Request
from fastapi.responses import JSONResponse
from backend.exceptions import RateLimitExceededError
@app.exception_handler(RateLimitExceededError)
async def rate_limit_exception_handler(request: Request, exc: RateLimitExceededError):
"""Handle rate limit exceeded errors with 429 status."""
return JSONResponse(
status_code=429,
content={
"detail": exc.message,
"limit_type": exc.limit_type,
"current_count": exc.current_count,
"limit_value": exc.limit_value,
},
headers={
"Retry-After": str(exc.remaining_seconds),
} if exc.remaining_seconds > 0 else None,
)
@app.get("/")
+7 -1
View File
@@ -1,5 +1,11 @@
"""Middleware package for FastAPI application."""
from backend.middleware.audit_logging import AuditLoggingMiddleware
from backend.middleware.tenant import TenantMiddleware, get_tenant_from_request, get_tenant_config_from_request
__all__ = ["AuditLoggingMiddleware"]
__all__ = [
"AuditLoggingMiddleware",
"TenantMiddleware",
"get_tenant_from_request",
"get_tenant_config_from_request",
]
+192
View File
@@ -0,0 +1,192 @@
"""
Tenant detection middleware for white-label B2B portals.
This middleware extracts the tenant ID from incoming requests and attaches
the tenant configuration to the request state for use by downstream handlers.
Tenant detection priority:
1. X-Tenant-ID header (explicitly set by frontend)
2. `tenant` query parameter (for development/testing)
3. Host header subdomain detection (production flow)
The middleware is non-blocking - if no tenant is detected, the request
proceeds as a default Nomad Karaoke request (tenant_id = None).
"""
import logging
import os
from typing import Optional
from starlette.middleware.base import BaseHTTPMiddleware
from starlette.requests import Request
from starlette.responses import Response
from backend.services.tenant_service import get_tenant_service
from backend.models.tenant import TenantConfig
logger = logging.getLogger(__name__)
# Only allow query param tenant override in non-production environments
IS_PRODUCTION = os.environ.get("ENV", "").lower() == "production" or \
os.environ.get("ENVIRONMENT", "").lower() == "production"
# Known non-tenant subdomains that should be treated as default Nomad Karaoke
NON_TENANT_SUBDOMAINS = {"gen", "api", "www", "buy", "admin", "app", "beta"}
class TenantMiddleware(BaseHTTPMiddleware):
"""
Middleware that detects tenant from request and attaches config to state.
After this middleware runs, routes can access:
- request.state.tenant_id: str or None
- request.state.tenant_config: TenantConfig or None
Usage in route handlers:
```python
@router.get("/something")
async def handler(request: Request):
tenant_id = getattr(request.state, "tenant_id", None)
tenant_config = getattr(request.state, "tenant_config", None)
```
"""
async def dispatch(self, request: Request, call_next) -> Response:
# Extract tenant ID from request
tenant_id = self._extract_tenant_id(request)
# Load tenant config if tenant detected
tenant_config: Optional[TenantConfig] = None
if tenant_id:
tenant_service = get_tenant_service()
tenant_config = tenant_service.get_tenant_config(tenant_id)
if tenant_config and not tenant_config.is_active:
# Tenant exists but is inactive - treat as default
logger.warning(f"Inactive tenant requested: {tenant_id}")
tenant_id = None
tenant_config = None
# Attach to request state
request.state.tenant_id = tenant_id
request.state.tenant_config = tenant_config
# Log tenant detection for debugging
if tenant_id:
logger.debug(f"Request tenant: {tenant_id} (path: {request.url.path})")
# Process request
response = await call_next(request)
# Add tenant ID to response headers for debugging
if tenant_id:
response.headers["X-Tenant-ID"] = tenant_id
return response
def _extract_tenant_id(self, request: Request) -> Optional[str]:
"""
Extract tenant ID from request using priority-based detection.
Returns:
Tenant ID if detected, None for default Nomad Karaoke
"""
# Priority 1: X-Tenant-ID header (explicitly set by frontend)
header_tenant = request.headers.get("X-Tenant-ID")
if header_tenant:
return header_tenant.lower().strip()
# Priority 2: Query parameter (for development/testing only)
# Disabled in production to prevent tenant spoofing
if not IS_PRODUCTION:
query_tenant = request.query_params.get("tenant")
if query_tenant:
return query_tenant.lower().strip()
# Priority 3: Host header subdomain detection
host = request.headers.get("Host", "")
return self._extract_tenant_from_host(host)
def _extract_tenant_from_host(self, host: str) -> Optional[str]:
"""
Extract tenant ID from Host header subdomain.
Patterns handled:
- vocalstar.nomadkaraoke.com -> vocalstar
- vocalstar.gen.nomadkaraoke.com -> vocalstar
- localhost:3000 -> None (local dev)
- gen.nomadkaraoke.com -> None (main app)
- api.nomadkaraoke.com -> None (API)
Returns:
Tenant ID if subdomain matches tenant, None otherwise
"""
if not host:
return None
# Normalize
host_lower = host.lower()
# Remove port if present
if ":" in host_lower:
host_lower = host_lower.split(":")[0]
# Check if this is a nomadkaraoke.com domain
if "nomadkaraoke.com" not in host_lower:
return None
# Split into parts
parts = host_lower.split(".")
# Need at least 3 parts: subdomain.nomadkaraoke.com
if len(parts) < 3:
return None
# First part is the potential tenant ID
potential_tenant = parts[0]
# Skip known non-tenant subdomains
if potential_tenant in NON_TENANT_SUBDOMAINS:
return None
# Verify tenant exists in GCS
tenant_service = get_tenant_service()
if tenant_service.tenant_exists(potential_tenant):
return potential_tenant
return None
def get_tenant_from_request(request: Request) -> Optional[str]:
"""
Helper function to get tenant ID from request state.
Usage in route handlers:
```python
from backend.middleware.tenant import get_tenant_from_request
@router.get("/something")
async def handler(request: Request):
tenant_id = get_tenant_from_request(request)
```
"""
return getattr(request.state, "tenant_id", None)
def get_tenant_config_from_request(request: Request) -> Optional[TenantConfig]:
"""
Helper function to get tenant config from request state.
Usage in route handlers:
```python
from backend.middleware.tenant import get_tenant_config_from_request
@router.get("/something")
async def handler(request: Request):
config = get_tenant_config_from_request(request)
if config and not config.features.audio_search:
raise HTTPException(403, "Audio search not available")
```
"""
return getattr(request.state, "tenant_config", None)
+23 -3
View File
@@ -207,6 +207,9 @@ class Job(BaseModel):
webhook_url: Optional[str] = None # Webhook for notifications
user_email: Optional[str] = None # Email for notifications
non_interactive: bool = False # Skip interactive steps (lyrics review, instrumental selection)
# Multi-tenant support (None = default Nomad Karaoke)
tenant_id: Optional[str] = None # Tenant ID for white-label portal scoping
# Theme configuration (pre-made themes from GCS)
theme_id: Optional[str] = None # Theme identifier (e.g., "nomad", "default")
@@ -276,7 +279,16 @@ class Job(BaseModel):
review_token_expires_at: Optional[datetime] = None # Token expiry time (optional, for extra security)
instrumental_token: Optional[str] = None # Job-scoped token for instrumental review UI access (generated when entering AWAITING_INSTRUMENTAL_SELECTION)
instrumental_token_expires_at: Optional[datetime] = None # Token expiry time
# Made-for-you order tracking
made_for_you: bool = False # Flag indicating this is a made-for-you customer order
customer_email: Optional[str] = None # Customer email for final delivery (job owned by admin during processing)
customer_notes: Optional[str] = None # Notes provided by customer with their order
# Output deletion tracking (for admin cleanup without deleting job)
outputs_deleted_at: Optional[datetime] = None # Timestamp when outputs were deleted by admin
outputs_deleted_by: Optional[str] = None # Admin email who deleted outputs
# Processing state
track_output_dir: Optional[str] = None # Local output directory (temp)
audio_hash: Optional[str] = None # Hash for deduplication
@@ -474,7 +486,12 @@ class JobCreate(BaseModel):
prep_only: bool = False # Stop after review, don't run finalisation
finalise_only: bool = False # Skip prep, run only finalisation
keep_brand_code: Optional[str] = None # Preserve existing brand code instead of generating new one
# Made-for-you order tracking
made_for_you: bool = False # Flag indicating this is a made-for-you customer order
customer_email: Optional[str] = None # Customer email for final delivery (job owned by admin during processing)
customer_notes: Optional[str] = None # Notes provided by customer with their order
# Request metadata (set by API endpoint from request headers)
request_metadata: Dict[str, Any] = Field(default_factory=dict)
"""
@@ -486,7 +503,10 @@ class JobCreate(BaseModel):
- server_version: Current server version
- custom_headers: All X-* headers
"""
# Tenant scoping for white-label portals
tenant_id: Optional[str] = None # Tenant ID for job scoping
@validator('url')
def validate_url(cls, v):
"""Validate URL is not empty."""
+208
View File
@@ -0,0 +1,208 @@
"""
Tenant data models for white-label B2B portals.
Tenants are B2B customers who get their own branded portal with custom
configuration. Each tenant has:
- Custom branding (logo, colors, site title)
- Feature flags (enable/disable audio search, distribution, etc.)
- Default settings (theme, distribution mode)
- Auth configuration (allowed email domains, fixed tokens)
Tenant configs are stored in GCS at tenants/{tenant_id}/config.json
"""
from datetime import datetime
from typing import List, Optional
from pydantic import BaseModel, Field
class TenantBranding(BaseModel):
"""Branding configuration for a tenant's portal."""
logo_url: Optional[str] = Field(
None, description="URL to tenant's logo image (PNG with transparency preferred)"
)
logo_height: int = Field(40, description="Logo height in pixels for header display")
primary_color: str = Field(
"#ff5bb8", description="Primary brand color (hex format)"
)
secondary_color: str = Field(
"#8b5cf6", description="Secondary brand color (hex format)"
)
accent_color: Optional[str] = Field(
None, description="Accent color for highlights (hex format)"
)
background_color: Optional[str] = Field(
None, description="Custom background color (defaults to dark theme)"
)
favicon_url: Optional[str] = Field(None, description="URL to custom favicon")
site_title: str = Field(
"Karaoke Generator", description="Browser tab title"
)
tagline: Optional[str] = Field(
None, description="Optional tagline shown below logo"
)
class TenantFeatures(BaseModel):
"""Feature flags controlling what's available in the tenant's portal."""
# Audio input methods
audio_search: bool = Field(
True, description="Enable audio search (flacfetch integration)"
)
file_upload: bool = Field(True, description="Enable direct file upload")
youtube_url: bool = Field(True, description="Enable YouTube URL input")
# Distribution options
youtube_upload: bool = Field(True, description="Enable YouTube upload option")
dropbox_upload: bool = Field(True, description="Enable Dropbox upload option")
gdrive_upload: bool = Field(True, description="Enable Google Drive upload option")
# Customization options
theme_selection: bool = Field(
True, description="Allow user to select theme (false = use default)"
)
color_overrides: bool = Field(
True, description="Allow user to customize colors"
)
# Output formats
enable_cdg: bool = Field(True, description="Generate CDG format output")
enable_4k: bool = Field(True, description="Generate 4K video output")
# Advanced features
admin_access: bool = Field(
False, description="Allow access to admin dashboard"
)
class TenantDefaults(BaseModel):
"""Default settings applied to all jobs for this tenant."""
theme_id: Optional[str] = Field(
None, description="Default theme ID (required if theme_selection=false)"
)
locked_theme: Optional[str] = Field(
None,
description="If set, users cannot change theme - always uses this theme ID"
)
distribution_mode: str = Field(
"all",
description="Distribution mode: 'all', 'download_only', or 'cloud_only'"
)
brand_prefix: Optional[str] = Field(
None, description="Prefix for output filenames (e.g., 'VSTAR')"
)
youtube_description_template: Optional[str] = Field(
None, description="Default YouTube description template"
)
class TenantAuth(BaseModel):
"""Authentication configuration for a tenant."""
allowed_email_domains: List[str] = Field(
default_factory=list,
description="Email domains allowed for magic link auth (e.g., ['vocal-star.com'])"
)
require_email_domain: bool = Field(
True,
description="If true, only allowed domains can sign up. If false, domains get auto-approved."
)
fixed_token_ids: List[str] = Field(
default_factory=list,
description="IDs of fixed API tokens for this tenant (tokens stored in auth_tokens)"
)
sender_email: Optional[str] = Field(
None,
description="Email sender address for this tenant (e.g., 'vocalstar@nomadkaraoke.com')"
)
class TenantConfig(BaseModel):
"""Complete configuration for a white-label tenant."""
id: str = Field(..., description="Unique tenant identifier (e.g., 'vocalstar')")
name: str = Field(..., description="Display name (e.g., 'Vocal Star')")
subdomain: str = Field(
..., description="Full subdomain (e.g., 'vocalstar.nomadkaraoke.com')"
)
is_active: bool = Field(True, description="Whether tenant portal is active")
branding: TenantBranding = Field(default_factory=TenantBranding)
features: TenantFeatures = Field(default_factory=TenantFeatures)
defaults: TenantDefaults = Field(default_factory=TenantDefaults)
auth: TenantAuth = Field(default_factory=TenantAuth)
created_at: Optional[datetime] = None
updated_at: Optional[datetime] = None
def get_sender_email(self) -> str:
"""Get the email sender address for this tenant."""
if self.auth.sender_email:
return self.auth.sender_email
# Default pattern: {tenant_id}@nomadkaraoke.com
return f"{self.id}@nomadkaraoke.com"
def is_email_allowed(self, email: str) -> bool:
"""Check if an email address is allowed for this tenant."""
if not self.auth.allowed_email_domains:
# No domain restrictions
return True
email_lower = email.lower()
for domain in self.auth.allowed_email_domains:
if email_lower.endswith(f"@{domain.lower()}"):
return True
return not self.auth.require_email_domain
class TenantPublicConfig(BaseModel):
"""
Public tenant configuration returned to frontend.
This excludes sensitive auth details like token IDs.
"""
id: str
name: str
subdomain: str
is_active: bool
branding: TenantBranding
features: TenantFeatures
defaults: TenantDefaults
# Auth info limited to what frontend needs
allowed_email_domains: List[str] = Field(default_factory=list)
@classmethod
def from_config(cls, config: TenantConfig) -> "TenantPublicConfig":
"""Create public config from full config."""
return cls(
id=config.id,
name=config.name,
subdomain=config.subdomain,
is_active=config.is_active,
branding=config.branding,
features=config.features,
defaults=TenantDefaults(
theme_id=config.defaults.theme_id,
locked_theme=config.defaults.locked_theme,
distribution_mode=config.defaults.distribution_mode,
# Don't expose brand_prefix or youtube_description_template
),
allowed_email_domains=config.auth.allowed_email_domains,
)
class TenantConfigResponse(BaseModel):
"""Response from GET /api/tenant/config endpoint."""
tenant: Optional[TenantPublicConfig] = Field(
None, description="Tenant config if found, null for default Nomad Karaoke"
)
is_default: bool = Field(
True, description="True if using default Nomad Karaoke config"
)
+38 -2
View File
@@ -8,9 +8,9 @@ Supports:
- Stripe integration for payments
- Beta tester program with feedback collection
"""
from datetime import datetime
from datetime import datetime, timezone
from enum import Enum
from typing import Optional, List
from typing import Optional, List, Dict
from pydantic import BaseModel, Field
@@ -39,17 +39,37 @@ class CreditTransaction(BaseModel):
created_by: Optional[str] = None # Admin email if granted by admin
class PushSubscription(BaseModel):
"""
Web Push subscription for a user's device.
Stores the push subscription endpoint and encryption keys needed
to send push notifications to the user's browser/device.
"""
endpoint: str # Push service endpoint URL
keys: Dict[str, str] # p256dh and auth keys for encryption
device_name: Optional[str] = None # e.g., "iPhone", "Chrome on Windows"
created_at: datetime = Field(default_factory=lambda: datetime.now(timezone.utc))
last_used_at: Optional[datetime] = None # Last time a notification was sent
class User(BaseModel):
"""
User model stored in Firestore.
Users are identified by email address. Authentication is via magic links
(no passwords). Credits are consumed when creating karaoke jobs.
For multi-tenant white-label portals, users are scoped to a tenant.
Users with tenant_id=None are default Nomad Karaoke users.
"""
email: str # Primary identifier
role: UserRole = UserRole.USER
credits: int = 0
# Multi-tenant support (None = default Nomad Karaoke)
tenant_id: Optional[str] = None
# Stripe integration
stripe_customer_id: Optional[str] = None
@@ -80,6 +100,10 @@ class User(BaseModel):
beta_feedback_due_at: Optional[datetime] = None # 24hr after job completion
beta_feedback_email_sent: bool = False
# Push notification subscriptions (Web Push API)
# Users can subscribe from multiple devices/browsers
push_subscriptions: List[PushSubscription] = Field(default_factory=list)
class MagicLinkToken(BaseModel):
"""
@@ -87,6 +111,9 @@ class MagicLinkToken(BaseModel):
Tokens are short-lived (15 minutes) and single-use.
Stored in Firestore with automatic TTL.
For multi-tenant portals, the tenant_id determines which portal
the user will be redirected to after verification.
"""
token: str # Secure random token
email: str
@@ -97,6 +124,9 @@ class MagicLinkToken(BaseModel):
ip_address: Optional[str] = None
user_agent: Optional[str] = None
# Multi-tenant support (None = default Nomad Karaoke)
tenant_id: Optional[str] = None
class Session(BaseModel):
"""
@@ -104,6 +134,8 @@ class Session(BaseModel):
Sessions are created after successful magic link verification.
Sessions expire after 7 days of inactivity or 30 days absolute.
For multi-tenant portals, sessions are scoped to a tenant.
"""
token: str # Secure random session token
user_email: str
@@ -114,6 +146,9 @@ class Session(BaseModel):
user_agent: Optional[str] = None
is_active: bool = True
# Multi-tenant support (None = default Nomad Karaoke)
tenant_id: Optional[str] = None
# Pydantic models for API requests/responses
@@ -149,6 +184,7 @@ class UserPublic(BaseModel):
display_name: Optional[str] = None
total_jobs_created: int = 0
total_jobs_completed: int = 0
tenant_id: Optional[str] = None
class AddCreditsRequest(BaseModel):
+253 -6
View File
@@ -14,7 +14,9 @@ import html
import logging
import os
from abc import ABC, abstractmethod
from datetime import datetime, timedelta, timezone
from typing import Optional, List
from zoneinfo import ZoneInfo
from backend.config import get_settings
from karaoke_gen.utils import sanitize_filename
@@ -34,8 +36,21 @@ class EmailProvider(ABC):
html_content: str,
text_content: Optional[str] = None,
cc_emails: Optional[List[str]] = None,
bcc_emails: Optional[List[str]] = None,
from_email_override: Optional[str] = None,
) -> bool:
"""Send an email. Returns True if successful."""
"""
Send an email. Returns True if successful.
Args:
to_email: Recipient email address
subject: Email subject
html_content: HTML content
text_content: Plain text content (optional)
cc_emails: CC recipients (optional)
bcc_emails: BCC recipients (optional)
from_email_override: Override the default sender email (optional, for multi-tenant)
"""
pass
@@ -53,11 +68,17 @@ class ConsoleEmailProvider(EmailProvider):
html_content: str,
text_content: Optional[str] = None,
cc_emails: Optional[List[str]] = None,
bcc_emails: Optional[List[str]] = None,
from_email_override: Optional[str] = None,
) -> bool:
logger.info("=" * 60)
if from_email_override:
logger.info(f"FROM: {from_email_override}")
logger.info(f"EMAIL TO: {to_email}")
if cc_emails:
logger.info(f"CC: {', '.join(cc_emails)}")
if bcc_emails:
logger.info(f"BCC: {', '.join(bcc_emails)}")
logger.info(f"SUBJECT: {subject}")
logger.info("-" * 60)
logger.info(text_content or html_content)
@@ -85,6 +106,8 @@ class PreviewEmailProvider(EmailProvider):
html_content: str,
text_content: Optional[str] = None,
cc_emails: Optional[List[str]] = None,
bcc_emails: Optional[List[str]] = None,
from_email_override: Optional[str] = None,
) -> bool:
self.last_to_email = to_email
self.last_subject = subject
@@ -115,16 +138,21 @@ class SendGridEmailProvider(EmailProvider):
html_content: str,
text_content: Optional[str] = None,
cc_emails: Optional[List[str]] = None,
bcc_emails: Optional[List[str]] = None,
from_email_override: Optional[str] = None,
) -> bool:
try:
# Import here to avoid requiring sendgrid in all environments
from sendgrid import SendGridAPIClient
from sendgrid.helpers.mail import Mail, Email, To, Content, Cc
from sendgrid.helpers.mail import Mail, Email, To, Content, Cc, Bcc
sg = SendGridAPIClient(api_key=self.api_key)
# Use override sender if provided (for multi-tenant)
sender_email = from_email_override or self.from_email
message = Mail(
from_email=Email(self.from_email, self.from_name),
from_email=Email(sender_email, self.from_name),
to_emails=To(to_email),
subject=subject,
html_content=Content("text/html", html_content)
@@ -144,6 +172,19 @@ class SendGridEmailProvider(EmailProvider):
for cc_email in unique_cc_emails:
message.add_cc(Cc(cc_email))
# Add BCC recipients if provided (deduplicated and normalized)
if bcc_emails:
seen = set()
unique_bcc_emails = []
for bcc_email in bcc_emails:
normalized = bcc_email.strip().lower()
if normalized and normalized not in seen:
seen.add(normalized)
unique_bcc_emails.append(bcc_email.strip())
for bcc_email in unique_bcc_emails:
message.add_bcc(Bcc(bcc_email))
if text_content:
message.add_content(Content("text/plain", text_content))
@@ -151,7 +192,8 @@ class SendGridEmailProvider(EmailProvider):
if response.status_code >= 200 and response.status_code < 300:
cc_info = f" (CC: {', '.join(cc_emails)})" if cc_emails else ""
logger.info(f"Email sent to {to_email}{cc_info} via SendGrid")
bcc_info = f" (BCC: {', '.join(bcc_emails)})" if bcc_emails else ""
logger.info(f"Email sent to {to_email}{cc_info}{bcc_info} via SendGrid")
return True
else:
logger.error(f"SendGrid returned status {response.status_code}")
@@ -200,13 +242,19 @@ class EmailService:
"""Check if a real email provider is configured (not just console logging)."""
return isinstance(self.provider, SendGridEmailProvider)
def send_magic_link(self, email: str, token: str) -> bool:
def send_magic_link(
self,
email: str,
token: str,
sender_email: Optional[str] = None,
) -> bool:
"""
Send a magic link email for authentication.
Args:
email: User's email address
token: Magic link token
sender_email: Override sender email address (for multi-tenant)
Returns:
True if email was sent successfully
@@ -264,7 +312,9 @@ If you didn't request this email, you can safely ignore it.
© {self._get_year()} Nomad Karaoke
"""
return self.provider.send_email(email, subject, html_content, text_content)
return self.provider.send_email(
email, subject, html_content, text_content, from_email_override=sender_email
)
def send_credits_added(self, email: str, credits: int, total_credits: int) -> bool:
"""
@@ -1017,6 +1067,7 @@ Thanks for being part of making Nomad Karaoke better!
html_content=html_content,
text_content=message_content,
cc_emails=cc_emails,
bcc_emails=["done@nomadkaraoke.com"],
)
def send_action_reminder(
@@ -1080,6 +1131,202 @@ Thanks for being part of making Nomad Karaoke better!
text_content=message_content,
)
def send_made_for_you_order_confirmation(
self,
to_email: str,
artist: str,
title: str,
job_id: str,
notes: Optional[str] = None,
) -> bool:
"""
Send order confirmation email to customer for made-for-you orders.
Args:
to_email: Customer's email address
artist: Artist name
title: Song title
job_id: Order/job ID for reference
notes: Optional customer notes
Returns:
True if email was sent successfully
"""
subject = f"Order Confirmed: {artist} - {title} | Nomad Karaoke"
extra_styles = """
.order-details {
background-color: #f8fafc;
border-radius: 8px;
padding: 20px;
margin: 20px 0;
}
.order-details h3 {
margin-top: 0;
color: #1e293b;
}
.order-details p {
margin: 8px 0;
color: #475569;
}
.highlight {
color: #059669;
font-weight: bold;
}
"""
notes_html = ""
notes_text = ""
if notes:
notes_html = f"<p><strong>Your Notes:</strong> {html.escape(notes)}</p>"
notes_text = f"\nYour Notes: {notes}"
content = f"""
<h2>Thank You for Your Order!</h2>
<div class="order-details">
<h3>Order Details</h3>
<p><strong>Order ID:</strong> {html.escape(job_id)}</p>
<p><strong>Artist:</strong> {html.escape(artist)}</p>
<p><strong>Title:</strong> {html.escape(title)}</p>
{notes_html}
</div>
<p>Our team will create your custom karaoke video within <span class="highlight">24 hours</span>.</p>
<p>You'll receive an email with download links as soon as your video is ready.</p>
<p><strong>No action needed</strong> - sit back and we'll take care of everything!</p>
"""
text_content = f"""Thank You for Your Order!
Order Details:
Order ID: {job_id}
Artist: {artist}
Title: {title}{notes_text}
Our team will create your custom karaoke video within 24 hours.
You'll receive an email with download links as soon as your video is ready.
No action needed - sit back and we'll take care of everything!
"""
html_content = self._build_email_html(content, extra_styles)
return self.provider.send_email(
to_email=to_email,
subject=subject,
html_content=html_content,
text_content=text_content,
bcc_emails=["done@nomadkaraoke.com"],
)
def send_made_for_you_admin_notification(
self,
to_email: str,
customer_email: str,
artist: str,
title: str,
job_id: str,
admin_login_token: str,
notes: Optional[str] = None,
audio_source_count: int = 0,
) -> bool:
"""
Send notification email to admin for new made-for-you orders.
Args:
to_email: Admin email address
customer_email: Customer's email address
artist: Artist name
title: Song title
job_id: Job ID for reference
admin_login_token: Token for one-click admin login
notes: Optional customer notes
audio_source_count: Number of audio sources found
Returns:
True if email was sent successfully
"""
subject = f"Karaoke Order: {artist} - {title} [ID: {job_id}]"
extra_styles = """
.order-info {
background-color: #f8fafc;
border-radius: 8px;
padding: 20px;
margin: 20px 0;
}
.order-info p {
margin: 8px 0;
}
.action-button {
display: inline-block;
background-color: #2563eb;
color: white !important;
padding: 12px 24px;
border-radius: 6px;
text-decoration: none;
font-weight: bold;
margin-top: 16px;
}
"""
notes_html = ""
notes_text = ""
if notes:
notes_html = f"<p><strong>Customer Notes:</strong> {html.escape(notes)}</p>"
notes_text = f"\nCustomer Notes: {notes}"
# Calculate deadline (24 hours from now, converted to Eastern Time)
deadline_utc = datetime.now(timezone.utc) + timedelta(hours=24)
eastern_tz = ZoneInfo("America/New_York")
deadline_eastern = deadline_utc.astimezone(eastern_tz)
# Use "ET" (Eastern Time) to be correct for both EST and EDT
deadline_str = deadline_eastern.strftime("%B %d, %Y at %I:%M %p") + " ET"
# Link to /app/ with admin login token for one-click access
app_url = f"{self.frontend_url.rstrip('/')}/app/?admin_token={admin_login_token}"
content = f"""
<div class="order-info">
<p><strong>Order / Job ID:</strong> {html.escape(job_id)}</p>
<p><strong>Customer:</strong> {html.escape(customer_email)}</p>
<p><strong>Artist:</strong> {html.escape(artist)}</p>
<p><strong>Title:</strong> {html.escape(title)}</p>
<p><strong>Audio Sources Found:</strong> {audio_source_count}</p>
{notes_html}
<p><strong>Deliver By:</strong> {deadline_str}</p>
<p style="margin-top: 16px;"><strong>Action Required:</strong> Select an audio source to start processing.</p>
<a href="{app_url}" class="action-button">Open Job</a>
</div>
"""
text_content = f"""New Karaoke Order
Order / Job ID: {job_id}
Customer: {customer_email}
Artist: {artist}
Title: {title}
Audio Sources Found: {audio_source_count}{notes_text}
Deliver By: {deadline_str}
Action Required: Select an audio source to start processing.
Open Job: {app_url}
"""
html_content = self._build_email_html(content, extra_styles)
return self.provider.send_email(
to_email=to_email,
subject=subject,
html_content=html_content,
text_content=text_content,
)
# Global instance
_email_service = None
@@ -0,0 +1,646 @@
"""
Email Validation Service.
Provides email validation, normalization, and blocklist checking
to prevent abuse during beta enrollment and other flows.
"""
import hashlib
import logging
import re
from datetime import datetime, timezone
from typing import Optional, Tuple, Set
from google.cloud import firestore
from backend.config import settings
logger = logging.getLogger(__name__)
def _mask_email(email: str) -> str:
"""Mask an email address for privacy-safe logging."""
if not email or "@" not in email:
return "***"
local, domain = email.split("@", 1)
if len(local) <= 2:
masked_local = "*" * len(local)
else:
masked_local = local[0] + "*" * (len(local) - 2) + local[-1]
return f"{masked_local}@{domain}"
# Firestore collection for blocklist data
BLOCKLISTS_COLLECTION = "blocklists"
BLOCKLIST_CONFIG_DOC = "config"
# Default disposable email domains (can be extended via admin UI)
DEFAULT_DISPOSABLE_DOMAINS = {
# Popular temporary email services
"10minutemail.com",
"10minutemail.net",
"guerrillamail.com",
"guerrillamail.org",
"guerrillamail.net",
"guerrillamail.biz",
"guerrillamailblock.com",
"tempmail.com",
"tempmail.net",
"temp-mail.org",
"temp-mail.io",
"throwawaymail.com",
"mailinator.com",
"mailinator.net",
"mailinator.org",
"mailinator.info",
"maildrop.cc",
"yopmail.com",
"yopmail.fr",
"yopmail.net",
"fakeinbox.com",
"fakemailgenerator.com",
"dispostable.com",
"getairmail.com",
"getnada.com",
"mohmal.com",
"trashmail.com",
"trashmail.net",
"trashmail.org",
"sharklasers.com",
"grr.la",
"guerrillamail.de",
"pokemail.net",
"spam4.me",
"spamgourmet.com",
"mytrashmail.com",
"mailnesia.com",
"mailcatch.com",
"mintemail.com",
"tempr.email",
"tempail.com",
"emailondeck.com",
"incognitomail.com",
"inboxalias.com",
"33mail.com",
"spamex.com",
"spamfree24.org",
"spamspot.com",
"mailnull.com",
"mailsac.com",
"emailfake.com",
"fakemail.fr",
"tempinbox.com",
"throwaway.email",
"burnermail.io",
"anonbox.net",
"anonymbox.com",
"discard.email",
"discardmail.com",
"discardmail.de",
"mailexpire.com",
"mailforspam.com",
"meltmail.com",
"mt2009.com",
"mt2014.com",
"nospam.ze.tc",
"nospamfor.us",
"nowmymail.com",
"receiveee.com",
"safe-mail.net",
"spamavert.com",
"spambob.com",
"spambog.com",
"spambox.us",
"spamcannon.com",
"spamcannon.net",
"spamcon.org",
"spamcorptastic.com",
"spamday.com",
"spamfree.eu",
"spamherelots.com",
"spamhereplease.com",
"spamhole.com",
"spamify.com",
"spaminator.de",
"spamkill.info",
"spaml.com",
"spaml.de",
"spamoff.de",
"spamobox.com",
"spamslicer.com",
"spamstack.net",
"spamthis.co.uk",
"spamthisplease.com",
"supergreatmail.com",
"suremail.info",
"teleworm.us",
"tempemail.co.za",
"tempemail.net",
"tempmailaddress.com",
"tempmailo.com",
"thankyou2010.com",
"thisisnotmyrealemail.com",
"tm.slsrs.ru",
"tmpeml.info",
"trash-mail.at",
"trash-mail.de",
"trash2009.com",
"trashemail.de",
"trashmail.at",
"trashmailer.com",
"wegwerfmail.de",
"wegwerfmail.net",
"wegwerfmail.org",
"wh4f.org",
"willhackforfood.biz",
"willselfdestruct.com",
"xmaily.com",
"xyzfree.net",
"yep.it",
"yogamaven.com",
"yuurok.com",
"zehnminutenmail.de",
"zippymail.info",
# Additional common ones
"mailnator.com",
"bugmenot.com",
"dodgeit.com",
"dodgit.com",
"e4ward.com",
"emailsensei.com",
"hushmail.com",
"jetable.org",
"kasmail.com",
"mailblock.net",
"mailcatch.com",
"mymailoasis.com",
"nervmich.net",
"nervtmansen.de",
"oneoffemail.com",
"pookmail.com",
"shortmail.net",
"sneakemail.com",
"sogetthis.com",
"tempemailaddress.com",
"tempomail.fr",
"temporaryemail.net",
"temporaryforwarding.com",
"temporaryinbox.com",
"thankyou2010.com",
"tyldd.com",
"uggsrock.com",
"veryrealemail.com",
"yourewronghereswhy.com",
}
# Gmail-like domains that support alias normalization
GMAIL_LIKE_DOMAINS = {
"gmail.com",
"googlemail.com",
}
class EmailValidationService:
"""
Service for email validation and abuse prevention.
Features:
- Email normalization (Gmail alias stripping)
- Disposable domain detection
- Blocklist checking (emails, IPs)
- IP-based enrollment rate limiting
"""
_instance: Optional["EmailValidationService"] = None
_blocklist_cache: Optional[dict] = None
_blocklist_cache_time: Optional[datetime] = None
_cache_ttl_seconds: int = 300 # 5 minutes
def __init__(self, db: Optional[firestore.Client] = None):
"""Initialize the email validation service."""
if db is None:
from backend.services.firestore_service import get_firestore_client
db = get_firestore_client()
self.db = db
@classmethod
def get_instance(cls, db: Optional[firestore.Client] = None) -> "EmailValidationService":
"""Get singleton instance of the service."""
if cls._instance is None:
cls._instance = cls(db)
return cls._instance
def normalize_email(self, email: str) -> str:
"""
Normalize an email address.
For Gmail-like domains:
- Removes dots from local part
- Removes everything after + in local part
- Converts to lowercase
For other domains:
- Only converts to lowercase
Args:
email: Email address to normalize
Returns:
Normalized email address
Examples:
j.o.h.n+spam@gmail.com -> john@gmail.com
John.Doe@example.com -> john.doe@example.com
"""
if not email or "@" not in email:
return email.lower().strip() if email else ""
email = email.lower().strip()
local, domain = email.rsplit("@", 1)
if domain in GMAIL_LIKE_DOMAINS:
# Remove dots from local part
local = local.replace(".", "")
# Remove everything after +
if "+" in local:
local = local.split("+")[0]
return f"{local}@{domain}"
def get_blocklist_config(self, force_refresh: bool = False) -> dict:
"""
Get blocklist configuration from Firestore.
Uses caching to reduce Firestore reads.
Returns:
Dict with disposable_domains, blocked_emails, blocked_ips sets
"""
now = datetime.now(timezone.utc)
# Check cache validity
if (
not force_refresh
and self._blocklist_cache is not None
and self._blocklist_cache_time is not None
and (now - self._blocklist_cache_time).total_seconds() < self._cache_ttl_seconds
):
return self._blocklist_cache
# Fetch from Firestore
doc_ref = self.db.collection(BLOCKLISTS_COLLECTION).document(BLOCKLIST_CONFIG_DOC)
doc = doc_ref.get()
if doc.exists:
data = doc.to_dict()
config = {
"disposable_domains": set(data.get("disposable_domains", [])) | DEFAULT_DISPOSABLE_DOMAINS,
"blocked_emails": set(data.get("blocked_emails", [])),
"blocked_ips": set(data.get("blocked_ips", [])),
}
else:
# Use defaults if no config exists
config = {
"disposable_domains": DEFAULT_DISPOSABLE_DOMAINS.copy(),
"blocked_emails": set(),
"blocked_ips": set(),
}
# Update cache
EmailValidationService._blocklist_cache = config
EmailValidationService._blocklist_cache_time = now
return config
def is_disposable_domain(self, email: str) -> bool:
"""
Check if an email uses a disposable domain.
Args:
email: Email address to check
Returns:
True if the domain is known to be disposable
"""
if not email or "@" not in email:
return False
domain = email.lower().split("@")[-1]
config = self.get_blocklist_config()
return domain in config["disposable_domains"]
def is_email_blocked(self, email: str) -> bool:
"""
Check if an email is explicitly blocked.
Checks both the raw email and normalized version.
Args:
email: Email address to check
Returns:
True if the email is blocked
"""
if not email:
return False
config = self.get_blocklist_config()
email_lower = email.lower().strip()
email_normalized = self.normalize_email(email)
return (
email_lower in config["blocked_emails"]
or email_normalized in config["blocked_emails"]
)
def is_ip_blocked(self, ip_address: str) -> bool:
"""
Check if an IP address is blocked.
Args:
ip_address: IP address to check
Returns:
True if the IP is blocked
"""
if not ip_address:
return False
config = self.get_blocklist_config()
return ip_address in config["blocked_ips"]
def validate_email_for_beta(self, email: str) -> Tuple[bool, str]:
"""
Validate an email for beta enrollment.
Performs all validation checks:
1. Basic format validation
2. Disposable domain check
3. Blocked email check
Args:
email: Email address to validate
Returns:
Tuple of (is_valid, error_message)
"""
if not email or "@" not in email:
return False, "Invalid email format"
# Check disposable domain
if self.is_disposable_domain(email):
logger.warning(f"Beta enrollment blocked - disposable domain: {_mask_email(email)}")
return False, "Disposable email addresses are not allowed"
# Check blocked email
if self.is_email_blocked(email):
logger.warning(f"Beta enrollment blocked - email blocked: {_mask_email(email)}")
return False, "This email address is not allowed"
return True, ""
def hash_ip(self, ip_address: str) -> str:
"""
Hash an IP address for privacy-preserving storage.
Args:
ip_address: IP address to hash
Returns:
SHA-256 hash of the IP
"""
return hashlib.sha256(ip_address.encode()).hexdigest()
# -------------------------------------------------------------------------
# Blocklist Management (Admin)
# -------------------------------------------------------------------------
def add_disposable_domain(self, domain: str, admin_email: str) -> bool:
"""Add a domain to the disposable domains blocklist."""
domain = domain.lower().strip()
if not domain:
return False
doc_ref = self.db.collection(BLOCKLISTS_COLLECTION).document(BLOCKLIST_CONFIG_DOC)
@firestore.transactional
def update_in_transaction(transaction, doc_ref):
doc = doc_ref.get(transaction=transaction)
if doc.exists:
data = doc.to_dict()
domains = set(data.get("disposable_domains", []))
else:
data = {}
domains = set()
domains.add(domain)
data["disposable_domains"] = list(domains)
data["updated_at"] = datetime.now(timezone.utc)
data["updated_by"] = admin_email
transaction.set(doc_ref, data, merge=True)
transaction = self.db.transaction()
update_in_transaction(transaction, doc_ref)
# Invalidate cache
EmailValidationService._blocklist_cache = None
logger.info(f"Added disposable domain: {domain} by {admin_email}")
return True
def remove_disposable_domain(self, domain: str, admin_email: str) -> bool:
"""Remove a domain from the disposable domains blocklist."""
domain = domain.lower().strip()
doc_ref = self.db.collection(BLOCKLISTS_COLLECTION).document(BLOCKLIST_CONFIG_DOC)
result = {"found": False}
@firestore.transactional
def remove_in_transaction(transaction, doc_ref):
doc = doc_ref.get(transaction=transaction)
if not doc.exists:
return
data = doc.to_dict()
domains = set(data.get("disposable_domains", []))
if domain not in domains:
return
result["found"] = True
domains.discard(domain)
data["disposable_domains"] = list(domains)
data["updated_at"] = datetime.now(timezone.utc)
data["updated_by"] = admin_email
transaction.set(doc_ref, data, merge=True)
transaction = self.db.transaction()
remove_in_transaction(transaction, doc_ref)
if not result["found"]:
return False
# Invalidate cache
EmailValidationService._blocklist_cache = None
logger.info(f"Removed disposable domain: {domain} by {admin_email}")
return True
def add_blocked_email(self, email: str, admin_email: str) -> bool:
"""Add an email to the blocked emails list."""
email = email.lower().strip()
if not email:
return False
doc_ref = self.db.collection(BLOCKLISTS_COLLECTION).document(BLOCKLIST_CONFIG_DOC)
@firestore.transactional
def update_in_transaction(transaction, doc_ref):
doc = doc_ref.get(transaction=transaction)
if doc.exists:
data = doc.to_dict()
emails = set(data.get("blocked_emails", []))
else:
data = {}
emails = set()
emails.add(email)
data["blocked_emails"] = list(emails)
data["updated_at"] = datetime.now(timezone.utc)
data["updated_by"] = admin_email
transaction.set(doc_ref, data, merge=True)
transaction = self.db.transaction()
update_in_transaction(transaction, doc_ref)
# Invalidate cache
EmailValidationService._blocklist_cache = None
logger.info(f"Added blocked email: {email} by {admin_email}")
return True
def remove_blocked_email(self, email: str, admin_email: str) -> bool:
"""Remove an email from the blocked emails list."""
email = email.lower().strip()
doc_ref = self.db.collection(BLOCKLISTS_COLLECTION).document(BLOCKLIST_CONFIG_DOC)
result = {"found": False}
@firestore.transactional
def remove_in_transaction(transaction, doc_ref):
doc = doc_ref.get(transaction=transaction)
if not doc.exists:
return
data = doc.to_dict()
emails = set(data.get("blocked_emails", []))
if email not in emails:
return
result["found"] = True
emails.discard(email)
data["blocked_emails"] = list(emails)
data["updated_at"] = datetime.now(timezone.utc)
data["updated_by"] = admin_email
transaction.set(doc_ref, data, merge=True)
transaction = self.db.transaction()
remove_in_transaction(transaction, doc_ref)
if not result["found"]:
return False
# Invalidate cache
EmailValidationService._blocklist_cache = None
logger.info(f"Removed blocked email: {email} by {admin_email}")
return True
def add_blocked_ip(self, ip_address: str, admin_email: str) -> bool:
"""Add an IP address to the blocked IPs list."""
ip_address = ip_address.strip()
if not ip_address:
return False
doc_ref = self.db.collection(BLOCKLISTS_COLLECTION).document(BLOCKLIST_CONFIG_DOC)
@firestore.transactional
def update_in_transaction(transaction, doc_ref):
doc = doc_ref.get(transaction=transaction)
if doc.exists:
data = doc.to_dict()
ips = set(data.get("blocked_ips", []))
else:
data = {}
ips = set()
ips.add(ip_address)
data["blocked_ips"] = list(ips)
data["updated_at"] = datetime.now(timezone.utc)
data["updated_by"] = admin_email
transaction.set(doc_ref, data, merge=True)
transaction = self.db.transaction()
update_in_transaction(transaction, doc_ref)
# Invalidate cache
EmailValidationService._blocklist_cache = None
logger.info(f"Added blocked IP: {ip_address} by {admin_email}")
return True
def remove_blocked_ip(self, ip_address: str, admin_email: str) -> bool:
"""Remove an IP address from the blocked IPs list."""
ip_address = ip_address.strip()
doc_ref = self.db.collection(BLOCKLISTS_COLLECTION).document(BLOCKLIST_CONFIG_DOC)
result = {"found": False}
@firestore.transactional
def remove_in_transaction(transaction, doc_ref):
doc = doc_ref.get(transaction=transaction)
if not doc.exists:
return
data = doc.to_dict()
ips = set(data.get("blocked_ips", []))
if ip_address not in ips:
return
result["found"] = True
ips.discard(ip_address)
data["blocked_ips"] = list(ips)
data["updated_at"] = datetime.now(timezone.utc)
data["updated_by"] = admin_email
transaction.set(doc_ref, data, merge=True)
transaction = self.db.transaction()
remove_in_transaction(transaction, doc_ref)
if not result["found"]:
return False
# Invalidate cache
EmailValidationService._blocklist_cache = None
logger.info(f"Removed blocked IP: {ip_address} by {admin_email}")
return True
def get_blocklist_stats(self) -> dict:
"""Get statistics about current blocklists."""
config = self.get_blocklist_config(force_refresh=True)
return {
"disposable_domains_count": len(config["disposable_domains"]),
"blocked_emails_count": len(config["blocked_emails"]),
"blocked_ips_count": len(config["blocked_ips"]),
"default_disposable_domains_count": len(DEFAULT_DISPOSABLE_DOMAINS),
}
def get_email_validation_service(
db: Optional[firestore.Client] = None,
) -> EmailValidationService:
"""Get the singleton EmailValidationService instance."""
return EmailValidationService.get_instance(db)
+27
View File
@@ -116,6 +116,7 @@ class FirestoreService:
created_after: Optional[datetime] = None,
created_before: Optional[datetime] = None,
user_email: Optional[str] = None,
tenant_id: Optional[str] = None,
limit: int = 100
) -> List[Job]:
"""
@@ -128,6 +129,7 @@ class FirestoreService:
created_after: Filter jobs created after this datetime
created_before: Filter jobs created before this datetime
user_email: Filter by user_email (owner of the job)
tenant_id: Filter by tenant_id (white-label portal scoping)
limit: Maximum number of jobs to return
Returns:
@@ -150,6 +152,10 @@ class FirestoreService:
if user_email:
query = query.where(filter=FieldFilter('user_email', '==', user_email.lower()))
# Filter by tenant_id (white-label portal scoping)
if tenant_id:
query = query.where(filter=FieldFilter('tenant_id', '==', tenant_id))
# Date range filters
if created_after:
query = query.where(filter=FieldFilter('created_at', '>=', created_after))
@@ -510,3 +516,24 @@ class FirestoreService:
logger.error(f"Error listing tokens: {e}")
return []
# Singleton client instance
_firestore_client: Optional[firestore.Client] = None
def get_firestore_client() -> firestore.Client:
"""
Get a shared Firestore client instance.
This returns a raw Firestore client (not the FirestoreService) for use
in services that need direct Firestore access without the job-specific
abstractions provided by FirestoreService.
Returns:
Firestore client instance
"""
global _firestore_client
if _firestore_client is None:
_firestore_client = firestore.Client(project=settings.google_cloud_project)
return _firestore_client
+22 -8
View File
@@ -338,19 +338,33 @@ def run_encoding(job_id: str, work_dir: Path, config: dict):
# Search more specifically for karaoke video
karaoke_video = find_file(work_dir, "*Karaoke*.mkv", "*Karaoke*.mov", "*vocals*.mkv")
# Instrumental audio
instrumental = find_file(
work_dir,
"*instrumental_clean*.flac", "*Instrumental Clean*.flac",
"*instrumental*.flac", "*Instrumental*.flac",
"*instrumental*.wav"
)
# Instrumental audio - respect user's selection from encoding config
instrumental_selection = config.get("instrumental_selection", "clean")
logger.info(f"Instrumental selection from config: {instrumental_selection}")
if instrumental_selection == "with_backing":
# User selected instrumental with backing vocals
instrumental = find_file(
work_dir,
"*instrumental_with_backing*.flac", "*Instrumental Backing*.flac",
"*with_backing*.flac", "*Backing*.flac",
"*instrumental*.flac", "*Instrumental*.flac",
"*instrumental*.wav"
)
else:
# Default to clean instrumental
instrumental = find_file(
work_dir,
"*instrumental_clean*.flac", "*Instrumental Clean*.flac",
"*instrumental*.flac", "*Instrumental*.flac",
"*instrumental*.wav"
)
logger.info(f"Found files:")
logger.info(f" Title video: {title_video}")
logger.info(f" Karaoke video: {karaoke_video}")
logger.info(f" End video: {end_video}")
logger.info(f" Instrumental: {instrumental}")
logger.info(f" Instrumental ({instrumental_selection}): {instrumental}")
# Validate required files
if not title_video:
+113
View File
@@ -0,0 +1,113 @@
"""
Centralized job defaults service.
This module provides consistent handling of job creation defaults across all
endpoints (file_upload, audio_search, made-for-you webhook, etc.).
Centralizing these defaults prevents divergence between code paths and ensures
all jobs receive the same default configuration.
"""
from dataclasses import dataclass
from typing import Optional, Tuple
from backend.config import get_settings
@dataclass
class EffectiveDistributionSettings:
"""Distribution settings with defaults applied from environment variables."""
dropbox_path: Optional[str]
gdrive_folder_id: Optional[str]
discord_webhook_url: Optional[str]
brand_prefix: Optional[str]
enable_youtube_upload: bool
youtube_description: Optional[str]
def get_effective_distribution_settings(
dropbox_path: Optional[str] = None,
gdrive_folder_id: Optional[str] = None,
discord_webhook_url: Optional[str] = None,
brand_prefix: Optional[str] = None,
enable_youtube_upload: Optional[bool] = None,
youtube_description: Optional[str] = None,
) -> EffectiveDistributionSettings:
"""
Get distribution settings with defaults applied from environment variables.
This ensures consistent handling of defaults across all job creation endpoints.
Each parameter, if not provided (None), falls back to the corresponding
environment variable configured in settings.
Args:
dropbox_path: Explicit Dropbox path or None for default
gdrive_folder_id: Explicit Google Drive folder ID or None for default
discord_webhook_url: Explicit Discord webhook URL or None for default
brand_prefix: Explicit brand prefix or None for default
enable_youtube_upload: Explicit flag or None for default
youtube_description: Explicit description or None for default
Returns:
EffectiveDistributionSettings with defaults applied
"""
settings = get_settings()
return EffectiveDistributionSettings(
dropbox_path=dropbox_path or settings.default_dropbox_path,
gdrive_folder_id=gdrive_folder_id or settings.default_gdrive_folder_id,
discord_webhook_url=discord_webhook_url or settings.default_discord_webhook_url,
brand_prefix=brand_prefix or settings.default_brand_prefix,
enable_youtube_upload=enable_youtube_upload if enable_youtube_upload is not None else settings.default_enable_youtube_upload,
youtube_description=youtube_description or settings.default_youtube_description,
)
def resolve_cdg_txt_defaults(
theme_id: Optional[str],
enable_cdg: Optional[bool] = None,
enable_txt: Optional[bool] = None,
) -> Tuple[bool, bool]:
"""
Resolve CDG/TXT settings based on theme and explicit settings.
The resolution logic is:
1. If explicit True/False is provided, use that value
2. Otherwise, if a theme is set, use the server defaults (settings.default_enable_cdg/txt)
3. If no theme is set, default to False (CDG/TXT require style configuration)
This ensures CDG/TXT are only enabled when:
- A theme is configured (provides necessary style params), AND
- The server defaults allow it (DEFAULT_ENABLE_CDG=true by default)
Args:
theme_id: Theme identifier (if any)
enable_cdg: Explicit CDG setting (None means use default)
enable_txt: Explicit TXT setting (None means use default)
Returns:
Tuple of (resolved_enable_cdg, resolved_enable_txt)
"""
settings = get_settings()
# Default based on whether theme is set AND server defaults
# Theme is required because CDG/TXT need style configuration
theme_is_set = theme_id is not None
default_cdg = theme_is_set and settings.default_enable_cdg
default_txt = theme_is_set and settings.default_enable_txt
# Explicit values override defaults, None uses computed default
resolved_cdg = enable_cdg if enable_cdg is not None else default_cdg
resolved_txt = enable_txt if enable_txt is not None else default_txt
return resolved_cdg, resolved_txt
# Singleton instance (optional, for convenience)
_service_instance = None
def get_job_defaults_service():
"""Get the job defaults service (module-level functions work fine, this is for consistency)."""
return {
'get_effective_distribution_settings': get_effective_distribution_settings,
'resolve_cdg_txt_defaults': resolve_cdg_txt_defaults,
}
+132 -5
View File
@@ -14,6 +14,7 @@ from datetime import datetime
from typing import Optional, Dict, Any, List
from backend.config import settings
from backend.exceptions import RateLimitExceededError
from backend.models.job import Job, JobStatus, JobCreate, STATE_TRANSITIONS
from backend.models.worker_log import WorkerLogEntry
from backend.services.firestore_service import FirestoreService
@@ -23,6 +24,16 @@ from backend.services.storage_service import StorageService
logger = logging.getLogger(__name__)
def _mask_email(email: str) -> str:
"""Mask email for logging to protect PII. Shows first char + domain."""
if not email or "@" not in email:
return "***"
local, domain = email.split("@", 1)
if len(local) <= 1:
return f"*@{domain}"
return f"{local[0]}***@{domain}"
class JobManager:
"""Manager for job lifecycle and state."""
@@ -31,16 +42,44 @@ class JobManager:
self.firestore = FirestoreService()
self.storage = StorageService()
def create_job(self, job_create: JobCreate) -> Job:
def create_job(self, job_create: JobCreate, is_admin: bool = False) -> Job:
"""
Create a new job with initial state PENDING.
Jobs start in PENDING state and transition to DOWNLOADING
when a worker picks them up.
Args:
job_create: Job creation parameters
is_admin: Whether the requesting user is an admin (bypasses rate limits)
Raises:
ValueError: If theme_id is not provided (all jobs require a theme)
RateLimitExceededError: If user has exceeded their daily job limit
"""
# Check rate limit FIRST (before any other validation)
# This prevents wasted work if user is rate limited
if job_create.user_email:
from backend.services.rate_limit_service import get_rate_limit_service
rate_limit_service = get_rate_limit_service()
allowed, remaining, message = rate_limit_service.check_user_job_limit(
user_email=job_create.user_email,
is_admin=is_admin
)
if not allowed:
from backend.services.rate_limit_service import _seconds_until_midnight_utc
# Get actual current count - remaining is clamped to 0 which loses info
current_count = rate_limit_service.get_user_job_count_today(job_create.user_email)
raise RateLimitExceededError(
message=message,
limit_type="jobs_per_day",
remaining_seconds=_seconds_until_midnight_utc(),
current_count=current_count,
limit_value=settings.rate_limit_jobs_per_day
)
# Enforce theme requirement - all jobs must have a theme
# This prevents unstyled videos from ever being generated
if not job_create.theme_id:
@@ -85,11 +124,27 @@ class JobManager:
keep_brand_code=job_create.keep_brand_code,
# Request metadata (for tracking and filtering)
request_metadata=job_create.request_metadata,
# Tenant scoping
tenant_id=job_create.tenant_id,
# Made-for-you order fields
made_for_you=job_create.made_for_you,
customer_email=job_create.customer_email,
customer_notes=job_create.customer_notes,
)
self.firestore.create_job(job)
logger.info(f"Created new job {job_id} with status PENDING")
# Record job creation for rate limiting (after successful persistence)
if job_create.user_email:
try:
from backend.services.rate_limit_service import get_rate_limit_service
rate_limit_service = get_rate_limit_service()
rate_limit_service.record_job_creation(job_create.user_email, job_id)
except Exception as e:
# Don't fail job creation if rate limit recording fails
logger.warning(f"Failed to record job creation for rate limiting: {e}")
return job
def get_job(self, job_id: str) -> Optional[Job]:
@@ -125,6 +180,7 @@ class JobManager:
created_after: Optional[datetime] = None,
created_before: Optional[datetime] = None,
user_email: Optional[str] = None,
tenant_id: Optional[str] = None,
limit: int = 100
) -> List[Job]:
"""
@@ -137,6 +193,7 @@ class JobManager:
created_after: Filter jobs created after this datetime
created_before: Filter jobs created before this datetime
user_email: Filter by user_email (job owner)
tenant_id: Filter by tenant_id (white-label portal scoping)
limit: Maximum number of jobs to return
Returns:
@@ -149,6 +206,7 @@ class JobManager:
created_after=created_after,
created_before=created_before,
user_email=user_email,
tenant_id=tenant_id,
limit=limit
)
@@ -380,7 +438,7 @@ class JobManager:
def _trigger_state_notifications(self, job_id: str, new_status: JobStatus) -> None:
"""
Trigger email notifications based on state transitions.
Trigger email and push notifications based on state transitions.
This is fire-and-forget - notification failures don't affect job processing.
@@ -400,10 +458,14 @@ class JobManager:
# Job completion notification
if new_status == JobStatus.COMPLETE:
self._schedule_completion_email(job)
self._send_push_notification(job, "complete")
# Idle reminder scheduling for blocking states
elif new_status in [JobStatus.AWAITING_REVIEW, JobStatus.AWAITING_INSTRUMENTAL_SELECTION]:
self._schedule_idle_reminder(job, new_status)
# Send push notification for blocking states
action_type = "lyrics" if new_status == JobStatus.AWAITING_REVIEW else "instrumental"
self._send_push_notification(job, action_type)
except Exception as e:
# Never let notification failures affect job processing
@@ -413,6 +475,7 @@ class JobManager:
"""
Schedule sending a job completion email.
For made-for-you orders, also transfers ownership from admin to customer.
Uses asyncio to fire-and-forget the email sending.
"""
import asyncio
@@ -429,11 +492,22 @@ class JobManager:
dropbox_url = state_data.get('dropbox_link')
brand_code = state_data.get('brand_code')
# For made-for-you orders, send to customer and transfer ownership
recipient_email = job.user_email
if job.made_for_you and job.customer_email:
recipient_email = job.customer_email
# Transfer ownership from admin to customer (non-blocking - email still goes out if this fails)
try:
self.update_job(job.job_id, {'user_email': job.customer_email})
logger.info(f"Transferred ownership of made-for-you job {job.job_id} to {_mask_email(job.customer_email)}")
except Exception as e:
logger.error(f"Failed to transfer ownership for job {job.job_id}: {e}")
# Create async task (fire-and-forget)
async def send_email():
await notification_service.send_job_completion_email(
job_id=job.job_id,
user_email=job.user_email,
user_email=recipient_email,
user_name=None, # Could fetch from user service if needed
artist=job.artist,
title=job.title,
@@ -511,7 +585,60 @@ class JobManager:
except Exception as e:
logger.error(f"Failed to schedule idle reminder for job {job.job_id}: {e}")
def _send_push_notification(self, job: Job, action_type: str) -> None:
"""
Send a push notification for job state changes.
Fire-and-forget - failures don't affect job processing.
Args:
job: Job object
action_type: Type of notification ("lyrics", "instrumental", or "complete")
"""
import asyncio
import threading
try:
from backend.services.push_notification_service import get_push_notification_service
push_service = get_push_notification_service()
# Skip if push notifications not enabled
if not push_service.is_enabled():
logger.debug("Push notifications not enabled, skipping")
return
# Build job dict for notification service
job_dict = {
"job_id": job.job_id,
"user_email": job.user_email,
"artist": job.artist,
"title": job.title,
}
async def send_notification():
if action_type == "complete":
await push_service.send_completion_notification(job_dict)
else:
await push_service.send_blocking_notification(job_dict, action_type)
# Try to get existing event loop, create new one if none exists
try:
loop = asyncio.get_running_loop()
loop.create_task(send_notification())
except RuntimeError:
# No event loop - we're in a sync context
def run_in_thread():
asyncio.run(send_notification())
thread = threading.Thread(target=run_in_thread, daemon=True)
thread.start()
logger.debug(f"Scheduled push notification for job {job.job_id} ({action_type})")
except Exception as e:
logger.error(f"Failed to send push notification for job {job.job_id}: {e}")
def update_state_data(self, job_id: str, key: str, value: Any) -> None:
"""
Update a specific key in the job's state_data field.
@@ -0,0 +1,409 @@
"""
Push Notification Service for Web Push Notifications.
Handles sending push notifications to users' browsers/devices using the Web Push protocol.
Uses pywebpush library for VAPID authentication and push message encryption.
"""
import logging
from datetime import datetime, timezone
from typing import Optional, List
from pywebpush import webpush, WebPushException
from backend.config import get_settings
from backend.models.user import User, PushSubscription
logger = logging.getLogger(__name__)
class SubscriptionGoneError(Exception):
"""Raised when a push subscription is no longer valid (410 Gone)."""
pass
class PushNotificationService:
"""
Service for sending Web Push notifications.
Requires VAPID keys to be configured in Secret Manager:
- vapid-public-key: Base64-encoded public key
- vapid-private-key: Base64-encoded private key
"""
def __init__(self, db=None):
"""
Initialize the push notification service.
Args:
db: Firestore client (optional, will use singleton if not provided)
"""
self.settings = get_settings()
self._vapid_private_key: Optional[str] = None
self._vapid_public_key: Optional[str] = None
self._db = db
@property
def db(self):
"""Get Firestore client (lazy initialization)."""
if self._db is None:
from google.cloud import firestore
self._db = firestore.Client()
return self._db
@property
def vapid_private_key(self) -> Optional[str]:
"""Get VAPID private key from Secret Manager (cached)."""
if self._vapid_private_key is None:
self._vapid_private_key = self.settings.get_secret("vapid-private-key")
return self._vapid_private_key
@property
def vapid_public_key(self) -> Optional[str]:
"""Get VAPID public key from Secret Manager (cached)."""
if self._vapid_public_key is None:
self._vapid_public_key = self.settings.get_secret("vapid-public-key")
return self._vapid_public_key
def is_enabled(self) -> bool:
"""Check if push notifications are enabled and properly configured."""
return (
self.settings.enable_push_notifications and
self.vapid_private_key is not None and
self.vapid_public_key is not None
)
def get_public_key(self) -> Optional[str]:
"""Get the VAPID public key for client-side subscription."""
if not self.settings.enable_push_notifications:
return None
return self.vapid_public_key
async def send_push(
self,
user_email: str,
title: str,
body: str,
url: str = "/app/",
tag: Optional[str] = None
) -> int:
"""
Send a push notification to all of a user's subscribed devices.
Args:
user_email: The user's email address
title: Notification title
body: Notification body text
url: URL to open when notification is clicked
tag: Optional tag for notification grouping (replaces notifications with same tag)
Returns:
Number of notifications successfully sent
"""
if not self.is_enabled():
logger.debug("Push notifications not enabled, skipping")
return 0
# Get user from Firestore
user_doc = self.db.collection("gen_users").document(user_email).get()
if not user_doc.exists:
logger.warning(f"User {user_email} not found for push notification")
return 0
user_data = user_doc.to_dict()
subscriptions = user_data.get("push_subscriptions", [])
if not subscriptions:
logger.debug(f"User {user_email} has no push subscriptions")
return 0
# Build notification payload
import json
payload = json.dumps({
"title": title,
"body": body,
"url": url,
"tag": tag or "default",
"icon": "/nomad-logo.png"
})
# Send to each subscription
success_count = 0
invalid_subscriptions = []
for sub in subscriptions:
try:
webpush(
subscription_info={
"endpoint": sub["endpoint"],
"keys": sub["keys"]
},
data=payload,
vapid_private_key=self.vapid_private_key,
vapid_claims={
"sub": self.settings.vapid_subject
}
)
success_count += 1
logger.debug(f"Push sent to {sub.get('device_name', 'unknown device')}")
except WebPushException as e:
logger.warning(f"Push failed: {e}")
# Check if subscription is gone (410) or unauthorized (401/403)
if e.response and e.response.status_code in (404, 410):
logger.info(f"Subscription gone, will remove: {sub['endpoint'][:50]}...")
invalid_subscriptions.append(sub["endpoint"])
elif e.response and e.response.status_code in (401, 403):
logger.warning(f"Push auth failed for {sub['endpoint'][:50]}...")
except Exception as e:
logger.error(f"Unexpected error sending push: {e}")
# Remove invalid subscriptions
if invalid_subscriptions:
await self._remove_invalid_subscriptions(user_email, invalid_subscriptions)
logger.info(f"Push notifications sent to {success_count}/{len(subscriptions)} devices for {user_email}")
return success_count
async def _remove_invalid_subscriptions(self, user_email: str, endpoints: List[str]) -> None:
"""Remove invalid subscriptions from user's list."""
try:
user_ref = self.db.collection("gen_users").document(user_email)
user_doc = user_ref.get()
if not user_doc.exists:
return
user_data = user_doc.to_dict()
current_subs = user_data.get("push_subscriptions", [])
# Filter out invalid subscriptions
valid_subs = [s for s in current_subs if s["endpoint"] not in endpoints]
if len(valid_subs) < len(current_subs):
user_ref.update({"push_subscriptions": valid_subs})
logger.info(f"Removed {len(current_subs) - len(valid_subs)} invalid subscriptions for {user_email}")
except Exception as e:
logger.error(f"Failed to remove invalid subscriptions: {e}")
async def send_blocking_notification(
self,
job: dict,
action_type: str # "lyrics" or "instrumental"
) -> int:
"""
Send notification when a job enters a blocking state requiring user action.
Args:
job: Job dictionary with job_id, user_email, artist, title
action_type: Type of action needed ("lyrics" or "instrumental")
Returns:
Number of notifications sent
"""
user_email = job.get("user_email")
if not user_email:
return 0
job_id = job.get("job_id", "unknown")
artist = job.get("artist", "Unknown Artist")
title = job.get("title", "Unknown Title")
if action_type == "lyrics":
notif_title = "Review Lyrics"
notif_body = f'"{title}" by {artist} needs lyrics review'
url = f"/review/{job_id}"
tag = f"lyrics-{job_id}"
else: # instrumental
notif_title = "Select Instrumental"
notif_body = f'"{title}" by {artist} needs instrumental selection'
url = f"/instrumental/{job_id}"
tag = f"instrumental-{job_id}"
return await self.send_push(
user_email=user_email,
title=notif_title,
body=notif_body,
url=url,
tag=tag
)
async def send_completion_notification(self, job: dict) -> int:
"""
Send notification when a job completes successfully.
Args:
job: Job dictionary with job_id, user_email, artist, title
Returns:
Number of notifications sent
"""
user_email = job.get("user_email")
if not user_email:
return 0
job_id = job.get("job_id", "unknown")
artist = job.get("artist", "Unknown Artist")
title = job.get("title", "Unknown Title")
return await self.send_push(
user_email=user_email,
title="Video Ready!",
body=f'Your karaoke video for "{title}" by {artist} is ready to download',
url=f"/app/?job={job_id}",
tag=f"complete-{job_id}"
)
async def add_subscription(
self,
user_email: str,
endpoint: str,
keys: dict,
device_name: Optional[str] = None
) -> bool:
"""
Add a push subscription for a user.
Enforces max subscriptions per user - oldest removed if limit exceeded.
Args:
user_email: User's email address
endpoint: Push service endpoint URL
keys: Encryption keys (p256dh, auth)
device_name: Optional device identifier
Returns:
True if subscription was added successfully
"""
try:
user_ref = self.db.collection("gen_users").document(user_email)
user_doc = user_ref.get()
if not user_doc.exists:
logger.warning(f"User {user_email} not found")
return False
user_data = user_doc.to_dict()
subscriptions = user_data.get("push_subscriptions", [])
# Check if this endpoint already exists (update it)
existing_idx = None
for i, sub in enumerate(subscriptions):
if sub["endpoint"] == endpoint:
existing_idx = i
break
new_sub = {
"endpoint": endpoint,
"keys": keys,
"device_name": device_name,
"created_at": datetime.now(timezone.utc).isoformat(),
"last_used_at": None
}
if existing_idx is not None:
# Update existing subscription
subscriptions[existing_idx] = new_sub
logger.info(f"Updated existing push subscription for {user_email}")
else:
# Add new subscription
subscriptions.append(new_sub)
logger.info(f"Added new push subscription for {user_email}")
# Enforce max subscriptions (remove oldest)
max_subs = self.settings.max_push_subscriptions_per_user
if len(subscriptions) > max_subs:
# Sort by created_at and keep only the newest
subscriptions.sort(key=lambda s: s.get("created_at", ""), reverse=True)
removed = subscriptions[max_subs:]
subscriptions = subscriptions[:max_subs]
logger.info(f"Removed {len(removed)} old subscriptions for {user_email} (max {max_subs})")
user_ref.update({"push_subscriptions": subscriptions})
return True
except Exception as e:
logger.error(f"Failed to add subscription for {user_email}: {e}")
return False
async def remove_subscription(self, user_email: str, endpoint: str) -> bool:
"""
Remove a push subscription for a user.
Args:
user_email: User's email address
endpoint: Push service endpoint URL to remove
Returns:
True if subscription was removed
"""
try:
user_ref = self.db.collection("gen_users").document(user_email)
user_doc = user_ref.get()
if not user_doc.exists:
return False
user_data = user_doc.to_dict()
subscriptions = user_data.get("push_subscriptions", [])
# Filter out the subscription
new_subs = [s for s in subscriptions if s["endpoint"] != endpoint]
if len(new_subs) < len(subscriptions):
user_ref.update({"push_subscriptions": new_subs})
logger.info(f"Removed push subscription for {user_email}")
return True
return False
except Exception as e:
logger.error(f"Failed to remove subscription for {user_email}: {e}")
return False
async def list_subscriptions(self, user_email: str) -> List[dict]:
"""
List all push subscriptions for a user.
Args:
user_email: User's email address
Returns:
List of subscription info (endpoint, device_name, created_at, last_used_at)
"""
try:
user_doc = self.db.collection("gen_users").document(user_email).get()
if not user_doc.exists:
return []
user_data = user_doc.to_dict()
subscriptions = user_data.get("push_subscriptions", [])
# Return safe subset of subscription data
return [
{
"endpoint": s["endpoint"],
"device_name": s.get("device_name"),
"created_at": s.get("created_at"),
"last_used_at": s.get("last_used_at")
}
for s in subscriptions
]
except Exception as e:
logger.error(f"Failed to list subscriptions for {user_email}: {e}")
return []
# Singleton instance
_push_service: Optional[PushNotificationService] = None
def get_push_notification_service(db=None) -> PushNotificationService:
"""Get the push notification service singleton."""
global _push_service
if _push_service is None:
_push_service = PushNotificationService(db)
return _push_service
+641
View File
@@ -0,0 +1,641 @@
"""
Rate limiting service for job creation, YouTube uploads, and beta enrollment.
Uses Firestore for distributed rate limit tracking with date-based document IDs
that automatically reset at UTC midnight.
"""
import hashlib
import logging
from datetime import datetime, timezone
from typing import Tuple, Optional, List, Dict, Any
from google.cloud import firestore
from backend.config import settings
logger = logging.getLogger(__name__)
# Firestore collection names
RATE_LIMITS_COLLECTION = "rate_limits"
BLOCKLISTS_COLLECTION = "blocklists"
OVERRIDES_COLLECTION = "overrides"
def _get_today_date_str() -> str:
"""Get today's date in UTC as YYYY-MM-DD string."""
return datetime.now(timezone.utc).strftime("%Y-%m-%d")
def _seconds_until_midnight_utc() -> int:
"""Calculate seconds until UTC midnight (when rate limits reset)."""
now = datetime.now(timezone.utc)
midnight = now.replace(hour=0, minute=0, second=0, microsecond=0)
# Add 1 day to get next midnight
from datetime import timedelta
next_midnight = midnight + timedelta(days=1)
return int((next_midnight - now).total_seconds())
def _hash_ip(ip_address: str) -> str:
"""Hash an IP address for storage (privacy-preserving)."""
return hashlib.sha256(ip_address.encode()).hexdigest()[:16]
class RateLimitService:
"""
Service for managing rate limits across the platform.
Rate limits use Firestore for distributed tracking with automatic
reset at UTC midnight via date-based document IDs.
"""
def __init__(self, db: Optional[firestore.Client] = None):
"""Initialize rate limit service with Firestore client."""
if db is None:
self.db = firestore.Client(project=settings.google_cloud_project)
else:
self.db = db
self._blocklist_cache: Optional[Dict[str, Any]] = None
self._blocklist_cache_time: Optional[datetime] = None
self._cache_ttl_seconds = 300 # 5 minute cache
# -------------------------------------------------------------------------
# Job Rate Limiting
# -------------------------------------------------------------------------
def check_user_job_limit(self, user_email: str, is_admin: bool = False) -> Tuple[bool, int, str]:
"""
Check if a user can create a new job.
Args:
user_email: User's email address
is_admin: Whether the user is an admin (admins bypass limits)
Returns:
Tuple of (allowed, remaining, message)
- allowed: True if user can create job
- remaining: Number of jobs remaining today
- message: Human-readable status message
"""
if not settings.enable_rate_limiting:
return True, -1, "Rate limiting disabled"
if is_admin:
return True, -1, "Admin users bypass rate limits"
limit = settings.rate_limit_jobs_per_day
if limit == 0:
return True, -1, "No job limit configured"
# Check for user override
override = self.get_user_override(user_email)
if override and override.get("bypass_job_limit"):
return True, -1, "User has rate limit bypass"
if override and override.get("custom_daily_job_limit"):
limit = override["custom_daily_job_limit"]
# Get current count
current_count = self.get_user_job_count_today(user_email)
remaining = max(0, limit - current_count)
if current_count >= limit:
seconds = _seconds_until_midnight_utc()
logger.warning(
f"Rate limit exceeded for {user_email}: {current_count}/{limit} jobs today"
)
return (
False,
0,
f"Daily job limit reached ({limit} jobs per day). Resets in {seconds // 3600}h {(seconds % 3600) // 60}m."
)
return True, remaining, f"{remaining} jobs remaining today"
def get_user_job_count_today(self, user_email: str) -> int:
"""Get the number of jobs created by a user today."""
date_str = _get_today_date_str()
doc_ref = self.db.collection(RATE_LIMITS_COLLECTION).document(
f"user_jobs_{user_email}_{date_str}"
)
doc = doc_ref.get()
if not doc.exists:
return 0
return doc.to_dict().get("count", 0)
def record_job_creation(self, user_email: str, job_id: str) -> None:
"""
Record a job creation for rate limiting.
Uses Firestore transactions for atomic increment.
"""
if not settings.enable_rate_limiting:
return
date_str = _get_today_date_str()
doc_ref = self.db.collection(RATE_LIMITS_COLLECTION).document(
f"user_jobs_{user_email}_{date_str}"
)
@firestore.transactional
def update_in_transaction(transaction, doc_ref):
doc = doc_ref.get(transaction=transaction)
if doc.exists:
data = doc.to_dict()
count = data.get("count", 0) + 1
job_ids = data.get("job_ids", [])
job_ids.append(job_id)
else:
count = 1
job_ids = [job_id]
transaction.set(doc_ref, {
"user_email": user_email,
"date": date_str,
"count": count,
"job_ids": job_ids,
"updated_at": datetime.now(timezone.utc),
})
transaction = self.db.transaction()
update_in_transaction(transaction, doc_ref)
logger.info(f"Recorded job {job_id} for user {user_email} rate limiting")
# -------------------------------------------------------------------------
# YouTube Upload Rate Limiting
# -------------------------------------------------------------------------
def check_youtube_upload_limit(self) -> Tuple[bool, int, str]:
"""
Check if the system can perform a YouTube upload.
YouTube uploads are limited system-wide due to API quota constraints.
Returns:
Tuple of (allowed, remaining, message)
"""
if not settings.enable_rate_limiting:
return True, -1, "Rate limiting disabled"
limit = settings.rate_limit_youtube_uploads_per_day
if limit == 0:
return True, -1, "No YouTube upload limit configured"
current_count = self.get_youtube_uploads_today()
remaining = max(0, limit - current_count)
if current_count >= limit:
seconds = _seconds_until_midnight_utc()
logger.warning(
f"YouTube upload limit exceeded: {current_count}/{limit} uploads today"
)
return (
False,
0,
f"Daily YouTube upload limit reached ({limit} uploads per day). Resets in {seconds // 3600}h {(seconds % 3600) // 60}m."
)
return True, remaining, f"{remaining} YouTube uploads remaining today"
def get_youtube_uploads_today(self) -> int:
"""Get the number of YouTube uploads performed today (system-wide)."""
date_str = _get_today_date_str()
doc_ref = self.db.collection(RATE_LIMITS_COLLECTION).document(
f"youtube_uploads_{date_str}"
)
doc = doc_ref.get()
if not doc.exists:
return 0
return doc.to_dict().get("count", 0)
def record_youtube_upload(self, job_id: str, user_email: str) -> None:
"""
Record a YouTube upload for rate limiting.
Uses Firestore transactions for atomic increment.
"""
if not settings.enable_rate_limiting:
return
date_str = _get_today_date_str()
doc_ref = self.db.collection(RATE_LIMITS_COLLECTION).document(
f"youtube_uploads_{date_str}"
)
@firestore.transactional
def update_in_transaction(transaction, doc_ref):
doc = doc_ref.get(transaction=transaction)
if doc.exists:
data = doc.to_dict()
count = data.get("count", 0) + 1
uploads = data.get("uploads", [])
else:
count = 1
uploads = []
uploads.append({
"job_id": job_id,
"user_email": user_email,
"timestamp": datetime.now(timezone.utc),
})
transaction.set(doc_ref, {
"date": date_str,
"count": count,
"uploads": uploads,
"updated_at": datetime.now(timezone.utc),
})
transaction = self.db.transaction()
update_in_transaction(transaction, doc_ref)
logger.info(f"Recorded YouTube upload for job {job_id}")
# -------------------------------------------------------------------------
# Beta Enrollment IP Rate Limiting
# -------------------------------------------------------------------------
def check_beta_ip_limit(self, ip_address: str) -> Tuple[bool, int, str]:
"""
Check if an IP address can enroll in the beta program.
Args:
ip_address: Client IP address
Returns:
Tuple of (allowed, remaining, message)
"""
if not settings.enable_rate_limiting:
return True, -1, "Rate limiting disabled"
limit = settings.rate_limit_beta_ip_per_day
if limit == 0:
return True, -1, "No beta IP limit configured"
# Check today's enrollment count for this IP
ip_hash = _hash_ip(ip_address)
date_str = _get_today_date_str()
doc_ref = self.db.collection(RATE_LIMITS_COLLECTION).document(
f"beta_ip_{ip_hash}_{date_str}"
)
doc = doc_ref.get()
current_count = 0
if doc.exists:
current_count = doc.to_dict().get("count", 0)
remaining = max(0, limit - current_count)
if current_count >= limit:
seconds = _seconds_until_midnight_utc()
logger.warning(
f"Beta enrollment IP limit exceeded for {ip_hash}: {current_count}/{limit} enrollments today"
)
return (
False,
0,
f"Too many beta enrollments from this network today. Please try again tomorrow."
)
return True, remaining, f"{remaining} beta enrollments remaining from this IP today"
def record_beta_enrollment(self, ip_address: str, email: str) -> None:
"""
Record a beta enrollment for IP rate limiting.
Uses Firestore transactions for atomic increment.
"""
if not settings.enable_rate_limiting:
return
ip_hash = _hash_ip(ip_address)
date_str = _get_today_date_str()
doc_ref = self.db.collection(RATE_LIMITS_COLLECTION).document(
f"beta_ip_{ip_hash}_{date_str}"
)
@firestore.transactional
def update_in_transaction(transaction, doc_ref):
doc = doc_ref.get(transaction=transaction)
if doc.exists:
data = doc.to_dict()
count = data.get("count", 0) + 1
enrollments = data.get("enrollments", [])
else:
count = 1
enrollments = []
enrollments.append({
"email": email,
"timestamp": datetime.now(timezone.utc),
})
transaction.set(doc_ref, {
"ip_hash": ip_hash,
"date": date_str,
"count": count,
"enrollments": enrollments,
"updated_at": datetime.now(timezone.utc),
})
transaction = self.db.transaction()
update_in_transaction(transaction, doc_ref)
logger.info(f"Recorded beta enrollment from IP {ip_hash} for {email}")
# -------------------------------------------------------------------------
# User Overrides (Whitelist)
# -------------------------------------------------------------------------
def get_user_override(self, user_email: str) -> Optional[Dict[str, Any]]:
"""
Get rate limit override settings for a user.
Returns:
Override settings dict or None if no override exists
"""
doc_ref = self.db.collection(OVERRIDES_COLLECTION).document(user_email.lower())
doc = doc_ref.get()
if not doc.exists:
return None
return doc.to_dict()
def set_user_override(
self,
user_email: str,
bypass_job_limit: bool = False,
custom_daily_job_limit: Optional[int] = None,
reason: str = "",
admin_email: str = ""
) -> None:
"""
Set rate limit override for a user.
Args:
user_email: User to override
bypass_job_limit: If True, user bypasses all job limits
custom_daily_job_limit: Custom limit (None = use default)
reason: Reason for override
admin_email: Admin who set the override
"""
doc_ref = self.db.collection(OVERRIDES_COLLECTION).document(user_email.lower())
doc_ref.set({
"email": user_email.lower(),
"bypass_job_limit": bypass_job_limit,
"custom_daily_job_limit": custom_daily_job_limit,
"reason": reason,
"created_by": admin_email,
"created_at": datetime.now(timezone.utc),
})
logger.info(f"Set rate limit override for {user_email} by {admin_email}")
def remove_user_override(self, user_email: str, admin_email: str = "") -> bool:
"""Remove rate limit override for a user."""
doc_ref = self.db.collection(OVERRIDES_COLLECTION).document(user_email.lower())
doc = doc_ref.get()
if not doc.exists:
return False
doc_ref.delete()
logger.info(f"Removed rate limit override for {user_email} by {admin_email}")
return True
def list_user_overrides(self) -> List[Dict[str, Any]]:
"""List all user rate limit overrides."""
docs = self.db.collection(OVERRIDES_COLLECTION).stream()
return [doc.to_dict() for doc in docs]
def get_all_overrides(self) -> Dict[str, Dict[str, Any]]:
"""Get all user rate limit overrides as a dict keyed by email."""
docs = self.db.collection(OVERRIDES_COLLECTION).stream()
return {doc.id: doc.to_dict() for doc in docs}
# -------------------------------------------------------------------------
# Blocklist Management
# -------------------------------------------------------------------------
def _load_blocklist(self, force_refresh: bool = False) -> Dict[str, Any]:
"""
Load blocklist from Firestore with caching.
Returns:
Dict with keys: disposable_domains, blocked_emails, blocked_ips
"""
now = datetime.now(timezone.utc)
# Check cache
if not force_refresh and self._blocklist_cache and self._blocklist_cache_time:
cache_age = (now - self._blocklist_cache_time).total_seconds()
if cache_age < self._cache_ttl_seconds:
return self._blocklist_cache
# Load from Firestore
doc_ref = self.db.collection(BLOCKLISTS_COLLECTION).document("config")
doc = doc_ref.get()
if not doc.exists:
# Initialize with empty blocklist
self._blocklist_cache = {
"disposable_domains": [],
"blocked_emails": [],
"blocked_ips": [],
}
else:
self._blocklist_cache = doc.to_dict()
self._blocklist_cache_time = now
return self._blocklist_cache
def is_disposable_domain(self, domain: str) -> bool:
"""Check if a domain is in the disposable domains blocklist."""
blocklist = self._load_blocklist()
return domain.lower() in [d.lower() for d in blocklist.get("disposable_domains", [])]
def is_blocked_email(self, email: str) -> bool:
"""Check if an email is explicitly blocked."""
blocklist = self._load_blocklist()
return email.lower() in [e.lower() for e in blocklist.get("blocked_emails", [])]
def is_blocked_ip(self, ip_address: str) -> bool:
"""Check if an IP address is blocked."""
blocklist = self._load_blocklist()
return ip_address in blocklist.get("blocked_ips", [])
def get_blocklist(self) -> Dict[str, Any]:
"""Get all blocklist data."""
return self._load_blocklist(force_refresh=True)
def add_disposable_domain(self, domain: str, admin_email: str) -> None:
"""Add a domain to the disposable domains blocklist."""
blocklist = self._load_blocklist(force_refresh=True)
domains = set(blocklist.get("disposable_domains", []))
domains.add(domain.lower())
doc_ref = self.db.collection(BLOCKLISTS_COLLECTION).document("config")
doc_ref.set({
**blocklist,
"disposable_domains": list(domains),
"updated_at": datetime.now(timezone.utc),
"updated_by": admin_email,
}, merge=True)
self._blocklist_cache = None # Invalidate cache
logger.info(f"Added disposable domain {domain} by {admin_email}")
def remove_disposable_domain(self, domain: str) -> bool:
"""Remove a domain from the disposable domains blocklist."""
blocklist = self._load_blocklist(force_refresh=True)
domains = set(blocklist.get("disposable_domains", []))
if domain.lower() not in [d.lower() for d in domains]:
return False
domains = {d for d in domains if d.lower() != domain.lower()}
doc_ref = self.db.collection(BLOCKLISTS_COLLECTION).document("config")
doc_ref.set({
**blocklist,
"disposable_domains": list(domains),
"updated_at": datetime.now(timezone.utc),
}, merge=True)
self._blocklist_cache = None
logger.info(f"Removed disposable domain {domain}")
return True
def add_blocked_email(self, email: str, admin_email: str) -> None:
"""Add an email to the blocked emails list."""
blocklist = self._load_blocklist(force_refresh=True)
emails = set(blocklist.get("blocked_emails", []))
emails.add(email.lower())
doc_ref = self.db.collection(BLOCKLISTS_COLLECTION).document("config")
doc_ref.set({
**blocklist,
"blocked_emails": list(emails),
"updated_at": datetime.now(timezone.utc),
"updated_by": admin_email,
}, merge=True)
self._blocklist_cache = None
logger.info(f"Added blocked email {email} by {admin_email}")
def remove_blocked_email(self, email: str) -> bool:
"""Remove an email from the blocked emails list."""
blocklist = self._load_blocklist(force_refresh=True)
emails = set(blocklist.get("blocked_emails", []))
if email.lower() not in [e.lower() for e in emails]:
return False
emails = {e for e in emails if e.lower() != email.lower()}
doc_ref = self.db.collection(BLOCKLISTS_COLLECTION).document("config")
doc_ref.set({
**blocklist,
"blocked_emails": list(emails),
"updated_at": datetime.now(timezone.utc),
}, merge=True)
self._blocklist_cache = None
logger.info(f"Removed blocked email {email}")
return True
def add_blocked_ip(self, ip_address: str, admin_email: str) -> None:
"""Add an IP address to the blocked IPs list."""
blocklist = self._load_blocklist(force_refresh=True)
ips = set(blocklist.get("blocked_ips", []))
ips.add(ip_address)
doc_ref = self.db.collection(BLOCKLISTS_COLLECTION).document("config")
doc_ref.set({
**blocklist,
"blocked_ips": list(ips),
"updated_at": datetime.now(timezone.utc),
"updated_by": admin_email,
}, merge=True)
self._blocklist_cache = None
logger.info(f"Added blocked IP {ip_address} by {admin_email}")
def remove_blocked_ip(self, ip_address: str) -> bool:
"""Remove an IP address from the blocked IPs list."""
blocklist = self._load_blocklist(force_refresh=True)
ips = set(blocklist.get("blocked_ips", []))
if ip_address not in ips:
return False
ips.discard(ip_address)
doc_ref = self.db.collection(BLOCKLISTS_COLLECTION).document("config")
doc_ref.set({
**blocklist,
"blocked_ips": list(ips),
"updated_at": datetime.now(timezone.utc),
}, merge=True)
self._blocklist_cache = None
logger.info(f"Removed blocked IP {ip_address}")
return True
# -------------------------------------------------------------------------
# Stats
# -------------------------------------------------------------------------
def get_rate_limit_stats(self) -> Dict[str, Any]:
"""
Get current rate limit statistics.
Returns:
Dict with current usage stats
"""
date_str = _get_today_date_str()
# Get YouTube upload count
youtube_count = self.get_youtube_uploads_today()
# Count unique users with jobs today
users_with_jobs = set()
total_jobs_today = 0
# Query all user job documents for today
docs = self.db.collection(RATE_LIMITS_COLLECTION).where(
"date", "==", date_str
).stream()
for doc in docs:
data = doc.to_dict()
if data.get("user_email"):
users_with_jobs.add(data["user_email"])
total_jobs_today += data.get("count", 0)
return {
"date": date_str,
"youtube_uploads_today": youtube_count,
"youtube_uploads_limit": settings.rate_limit_youtube_uploads_per_day,
"total_jobs_today": total_jobs_today,
"users_with_jobs_today": len(users_with_jobs),
"job_limit_per_user": settings.rate_limit_jobs_per_day,
"beta_ip_limit_per_day": settings.rate_limit_beta_ip_per_day,
"rate_limiting_enabled": settings.enable_rate_limiting,
"seconds_until_reset": _seconds_until_midnight_utc(),
}
# Singleton instance
_rate_limit_service: Optional[RateLimitService] = None
def get_rate_limit_service() -> RateLimitService:
"""Get the singleton RateLimitService instance."""
global _rate_limit_service
if _rate_limit_service is None:
_rate_limit_service = RateLimitService()
return _rate_limit_service
+63 -37
View File
@@ -46,11 +46,12 @@ CREDIT_PACKAGES = {
},
}
# Done-for-you service package (not a credit package - creates a job directly)
DONE_FOR_YOU_PACKAGE = {
# Made-for-you service package (not a credit package - creates a job directly)
MADE_FOR_YOU_PACKAGE = {
"price_cents": 1500, # $15.00
"name": "Done For You Karaoke Video",
"description": "Full-service karaoke video creation with 24-hour delivery",
"name": "Made For You Karaoke Video",
"description": "Professional 4K karaoke video with perfectly synced lyrics, delivered to your email within 24 hours",
"images": ["https://gen.nomadkaraoke.com/nomad-logo.png"],
}
@@ -65,6 +66,10 @@ class StripeService:
self.frontend_url = os.getenv("FRONTEND_URL", "https://gen.nomadkaraoke.com")
# After consolidation, buy URL is the same as frontend URL
self.buy_url = os.getenv("BUY_URL", self.frontend_url)
# Payment method configuration ID from Stripe Dashboard
# Enables Google Pay, Apple Pay, Link, and other wallet methods
# Get this from: Dashboard > Settings > Payment methods > [Your Config] > Copy ID
self.payment_method_config = os.getenv("STRIPE_PAYMENT_METHOD_CONFIG")
if self.secret_key:
stripe.api_key = self.secret_key
@@ -72,6 +77,11 @@ class StripeService:
else:
logger.warning("STRIPE_SECRET_KEY not set - payments disabled")
if self.payment_method_config:
logger.info(f"Using payment method config: {self.payment_method_config}")
else:
logger.info("No STRIPE_PAYMENT_METHOD_CONFIG set - using Stripe defaults")
def is_configured(self) -> bool:
"""Check if Stripe is properly configured."""
return bool(self.secret_key)
@@ -113,32 +123,40 @@ class StripeService:
if not cancel_url:
cancel_url = f"{self.buy_url}?cancelled=true"
# Create checkout session
session = stripe.checkout.Session.create(
payment_method_types=['card'],
line_items=[{
# Build checkout session params
session_params = {
# Omit payment_method_types to auto-enable Apple Pay, Google Pay, Link, etc.
'line_items': [{
'price_data': {
'currency': 'usd',
'product_data': {
'name': package['name'],
'description': package['description'],
'images': ['https://gen.nomadkaraoke.com/nomad-logo.png'],
},
'unit_amount': package['price_cents'],
},
'quantity': 1,
}],
mode='payment',
success_url=success_url,
cancel_url=cancel_url,
customer_email=user_email,
metadata={
'mode': 'payment',
'success_url': success_url,
'cancel_url': cancel_url,
'customer_email': user_email,
'metadata': {
'package_id': package_id,
'credits': str(package['credits']),
'user_email': user_email,
},
# Allow promotion codes
allow_promotion_codes=True,
)
'allow_promotion_codes': True,
}
# Add payment method configuration if set (enables Google Pay, Link, etc.)
if self.payment_method_config:
session_params['payment_method_configuration'] = self.payment_method_config
# Create checkout session
session = stripe.checkout.Session.create(**session_params)
logger.info(f"Created checkout session {session.id} for {user_email}, package {package_id}")
return True, session.url, "Checkout session created"
@@ -150,7 +168,7 @@ class StripeService:
logger.error(f"Error creating checkout session: {e}")
return False, None, "Failed to create checkout session"
def create_done_for_you_checkout_session(
def create_made_for_you_checkout_session(
self,
customer_email: str,
artist: str,
@@ -162,7 +180,7 @@ class StripeService:
cancel_url: Optional[str] = None,
) -> Tuple[bool, Optional[str], str]:
"""
Create a Stripe Checkout session for a done-for-you order.
Create a Stripe Checkout session for a made-for-you order.
This is for the full-service karaoke video creation where Nomad Karaoke
handles all the work (lyrics review, instrumental selection, etc.).
@@ -184,15 +202,15 @@ class StripeService:
return False, None, "Payment processing is not configured"
try:
# Default URLs - redirect to homepage success page
# Default URLs - redirect to gen app success page
if not success_url:
success_url = "https://nomadkaraoke.com/order/success/?session_id={CHECKOUT_SESSION_ID}"
success_url = f"{self.frontend_url}/order/success?session_id={{CHECKOUT_SESSION_ID}}"
if not cancel_url:
cancel_url = "https://nomadkaraoke.com/#do-it-for-me"
# Build metadata for job creation after payment
metadata = {
'order_type': 'done_for_you',
'order_type': 'made_for_you',
'customer_email': customer_email,
'artist': artist,
'title': title,
@@ -204,39 +222,47 @@ class StripeService:
# Truncate notes to fit Stripe's 500 char limit per metadata value
metadata['notes'] = notes[:500] if len(notes) > 500 else notes
# Create checkout session
session = stripe.checkout.Session.create(
payment_method_types=['card'],
line_items=[{
# Build checkout session params
session_params = {
# Omit payment_method_types to auto-enable Apple Pay, Google Pay, Link, etc.
'line_items': [{
'price_data': {
'currency': 'usd',
'product_data': {
'name': DONE_FOR_YOU_PACKAGE['name'],
'description': f"{artist} - {title}",
'name': f"Karaoke Video: {artist} - {title}",
'description': MADE_FOR_YOU_PACKAGE['description'],
'images': MADE_FOR_YOU_PACKAGE['images'],
},
'unit_amount': DONE_FOR_YOU_PACKAGE['price_cents'],
'unit_amount': MADE_FOR_YOU_PACKAGE['price_cents'],
},
'quantity': 1,
}],
mode='payment',
success_url=success_url,
cancel_url=cancel_url,
customer_email=customer_email,
metadata=metadata,
allow_promotion_codes=True,
)
'mode': 'payment',
'success_url': success_url,
'cancel_url': cancel_url,
'customer_email': customer_email,
'metadata': metadata,
'allow_promotion_codes': True,
}
# Add payment method configuration if set (enables Google Pay, Link, etc.)
if self.payment_method_config:
session_params['payment_method_configuration'] = self.payment_method_config
# Create checkout session
session = stripe.checkout.Session.create(**session_params)
logger.info(
f"Created done-for-you checkout session {session.id} for {customer_email}, "
f"Created made-for-you checkout session {session.id} for {customer_email}, "
f"song: {artist} - {title}"
)
return True, session.url, "Checkout session created"
except stripe.error.StripeError as e:
logger.error(f"Stripe error creating done-for-you checkout session: {e}")
logger.error(f"Stripe error creating made-for-you checkout session: {e}")
return False, None, f"Payment error: {str(e)}"
except Exception as e:
logger.error(f"Error creating done-for-you checkout session: {e}")
logger.error(f"Error creating made-for-you checkout session: {e}")
return False, None, "Failed to create checkout session"
def verify_webhook_signature(self, payload: bytes, signature: str) -> Tuple[bool, Optional[Dict], str]:
+285
View File
@@ -0,0 +1,285 @@
"""
Tenant service for managing white-label B2B portal configurations.
Tenant configs are stored in GCS at tenants/{tenant_id}/config.json.
The service provides:
- Tenant config loading with caching
- Subdomain to tenant ID resolution
- Tenant validation
Similar to ThemeService, configs are cached for 5 minutes to reduce GCS reads.
"""
import logging
import threading
from datetime import datetime
from typing import Dict, Optional
from backend.models.tenant import TenantConfig, TenantPublicConfig
from backend.services.storage_service import StorageService
logger = logging.getLogger(__name__)
# GCS paths for tenant configs
TENANTS_PREFIX = "tenants"
# Default sender email (shared with EmailService for consistency)
DEFAULT_SENDER_EMAIL = "gen@nomadkaraoke.com"
class TenantService:
"""Service for managing tenant configurations from GCS."""
def __init__(self, storage: Optional[StorageService] = None):
"""
Initialize the tenant service.
Args:
storage: StorageService instance (creates new one if not provided)
"""
self.storage = storage or StorageService()
self._config_cache: Dict[str, TenantConfig] = {}
self._cache_times: Dict[str, datetime] = {}
self._subdomain_map: Dict[str, str] = {} # subdomain -> tenant_id
self._subdomain_map_time: Optional[datetime] = None
self.CACHE_TTL_SECONDS = 300 # 5 minute cache
def _get_config_path(self, tenant_id: str) -> str:
"""Get the GCS path for a tenant's config file."""
return f"{TENANTS_PREFIX}/{tenant_id}/config.json"
def _is_cache_valid(self, tenant_id: str) -> bool:
"""Check if the config cache for a tenant is still valid."""
if tenant_id not in self._config_cache or tenant_id not in self._cache_times:
return False
age = datetime.now() - self._cache_times[tenant_id]
return age.total_seconds() < self.CACHE_TTL_SECONDS
def _is_subdomain_map_valid(self) -> bool:
"""Check if the subdomain map cache is still valid."""
if not self._subdomain_map or self._subdomain_map_time is None:
return False
age = datetime.now() - self._subdomain_map_time
return age.total_seconds() < self.CACHE_TTL_SECONDS
def get_tenant_config(
self, tenant_id: str, force_refresh: bool = False
) -> Optional[TenantConfig]:
"""
Load tenant configuration from GCS with caching.
Args:
tenant_id: The tenant identifier
force_refresh: Force reload from GCS even if cache is valid
Returns:
TenantConfig if found, None otherwise
"""
if not force_refresh and self._is_cache_valid(tenant_id):
return self._config_cache[tenant_id]
try:
config_path = self._get_config_path(tenant_id)
if not self.storage.file_exists(config_path):
logger.debug(f"Tenant config not found: {tenant_id}")
return None
data = self.storage.download_json(config_path)
config = TenantConfig(**data)
# Update cache
self._config_cache[tenant_id] = config
self._cache_times[tenant_id] = datetime.now()
# Update subdomain map and its timestamp
self._subdomain_map[config.subdomain.lower()] = tenant_id
self._subdomain_map_time = datetime.now()
logger.info(f"Loaded tenant config: {tenant_id}")
return config
except Exception as e:
logger.error(f"Failed to load tenant config {tenant_id}: {e}")
return None
def get_tenant_by_subdomain(self, subdomain: str) -> Optional[TenantConfig]:
"""
Get tenant config by subdomain.
Args:
subdomain: Full subdomain (e.g., 'vocalstar.nomadkaraoke.com')
Returns:
TenantConfig if found, None otherwise
"""
subdomain_lower = subdomain.lower()
# Check cache first
if subdomain_lower in self._subdomain_map:
tenant_id = self._subdomain_map[subdomain_lower]
return self.get_tenant_config(tenant_id)
# Try to find tenant by listing all configs
# This is a fallback for when we don't have the subdomain cached
tenant_id = self._resolve_subdomain_to_tenant_id(subdomain_lower)
if tenant_id:
return self.get_tenant_config(tenant_id)
return None
def _resolve_subdomain_to_tenant_id(self, subdomain: str) -> Optional[str]:
"""
Resolve a subdomain to tenant ID by checking GCS.
This extracts the tenant ID from the subdomain pattern:
- 'vocalstar.nomadkaraoke.com' -> 'vocalstar'
- 'vocalstar.gen.nomadkaraoke.com' -> 'vocalstar'
"""
# Extract potential tenant ID from subdomain
# Pattern: {tenant}.nomadkaraoke.com or {tenant}.gen.nomadkaraoke.com
parts = subdomain.split(".")
if len(parts) >= 3:
# First part is likely the tenant ID
potential_tenant_id = parts[0]
# Check if config exists
config_path = self._get_config_path(potential_tenant_id)
if self.storage.file_exists(config_path):
return potential_tenant_id
return None
def get_public_config(self, tenant_id: str) -> Optional[TenantPublicConfig]:
"""
Get the public (frontend-safe) tenant configuration.
Args:
tenant_id: The tenant identifier
Returns:
TenantPublicConfig if found, None otherwise
"""
config = self.get_tenant_config(tenant_id)
if config:
return TenantPublicConfig.from_config(config)
return None
def get_public_config_by_subdomain(
self, subdomain: str
) -> Optional[TenantPublicConfig]:
"""
Get the public tenant configuration by subdomain.
Args:
subdomain: Full subdomain
Returns:
TenantPublicConfig if found, None otherwise
"""
config = self.get_tenant_by_subdomain(subdomain)
if config:
return TenantPublicConfig.from_config(config)
return None
def tenant_exists(self, tenant_id: str) -> bool:
"""
Check if a tenant exists.
Args:
tenant_id: The tenant identifier
Returns:
True if tenant config exists, False otherwise
"""
config_path = self._get_config_path(tenant_id)
return self.storage.file_exists(config_path)
def is_email_allowed_for_tenant(self, tenant_id: str, email: str) -> bool:
"""
Check if an email is allowed for a specific tenant.
Args:
tenant_id: The tenant identifier
email: Email address to check
Returns:
True if email is allowed, False otherwise
"""
config = self.get_tenant_config(tenant_id)
if not config:
return False
return config.is_email_allowed(email)
def get_tenant_sender_email(self, tenant_id: str) -> str:
"""
Get the email sender address for a tenant.
Args:
tenant_id: The tenant identifier
Returns:
Sender email address
"""
config = self.get_tenant_config(tenant_id)
if config:
return config.get_sender_email()
# Default fallback (consistent with EmailService)
return DEFAULT_SENDER_EMAIL
def invalidate_cache(self, tenant_id: Optional[str] = None) -> None:
"""
Invalidate tenant config cache.
Args:
tenant_id: Specific tenant to invalidate, or None for all
"""
if tenant_id:
self._config_cache.pop(tenant_id, None)
self._cache_times.pop(tenant_id, None)
# Also remove any subdomain map entries pointing to this tenant
subdomains_to_remove = [
subdomain
for subdomain, tid in self._subdomain_map.items()
if tid == tenant_id
]
for subdomain in subdomains_to_remove:
self._subdomain_map.pop(subdomain, None)
logger.info(f"Tenant config cache invalidated: {tenant_id}")
else:
self._config_cache.clear()
self._cache_times.clear()
self._subdomain_map.clear()
self._subdomain_map_time = None
logger.info("All tenant config caches invalidated")
def get_asset_url(self, tenant_id: str, asset_name: str) -> Optional[str]:
"""
Get a signed URL for a tenant asset (logo, favicon, etc.).
Args:
tenant_id: The tenant identifier
asset_name: Asset filename (e.g., 'logo.png')
Returns:
Signed URL if asset exists, None otherwise
"""
asset_path = f"{TENANTS_PREFIX}/{tenant_id}/{asset_name}"
if self.storage.file_exists(asset_path):
return self.storage.generate_signed_url(asset_path, expiration_minutes=60)
return None
# Singleton instance with thread-safe initialization
_tenant_service: Optional[TenantService] = None
_tenant_service_lock = threading.Lock()
def get_tenant_service() -> TenantService:
"""Get or create the singleton TenantService instance (thread-safe)."""
global _tenant_service
if _tenant_service is None:
with _tenant_service_lock:
# Double-check after acquiring lock
if _tenant_service is None:
_tenant_service = TenantService()
return _tenant_service
+85 -7
View File
@@ -73,16 +73,26 @@ class UserService:
logger.exception(f"Error getting user {email}")
return None
def get_or_create_user(self, email: str) -> User:
def get_or_create_user(self, email: str, tenant_id: Optional[str] = None) -> User:
"""
Get existing user or create a new one.
New users receive a welcome credit to try the service.
Args:
email: User's email address
tenant_id: Tenant ID for white-label portals (None = default Nomad Karaoke)
Note: If user exists but has a different tenant_id, the existing user is returned.
Users are uniquely identified by email, not email+tenant.
"""
email = email.lower()
user = self.get_user(email)
if user:
# If user exists but tenant_id differs, we still return the user
# This allows users to access multiple tenants with one account
# (though features may be restricted per-tenant)
return user
# Create new user with welcome credit
@@ -97,9 +107,10 @@ class UserService:
email=email,
credits=welcome_credit,
credit_transactions=[welcome_transaction],
tenant_id=tenant_id, # Associate with tenant on creation
)
self._save_user(user)
logger.info(f"Created new user: {email} with {welcome_credit} welcome credit(s)")
logger.info(f"Created new user: {email} with {welcome_credit} welcome credit(s) (tenant: {tenant_id or 'default'})")
return user
def _save_user(self, user: User) -> None:
@@ -153,6 +164,7 @@ class UserService:
display_name=user.display_name,
total_jobs_created=user.total_jobs_created,
total_jobs_completed=user.total_jobs_completed,
tenant_id=user.tenant_id,
)
# =========================================================================
@@ -163,18 +175,25 @@ class UserService:
self,
email: str,
ip_address: Optional[str] = None,
user_agent: Optional[str] = None
user_agent: Optional[str] = None,
tenant_id: Optional[str] = None
) -> MagicLinkToken:
"""
Create a magic link token for email authentication.
Returns the token object. The actual sending of the email
should be handled by the caller (or an email service).
Args:
email: User's email address
ip_address: Client IP for auditing
user_agent: Client user agent for auditing
tenant_id: Tenant ID for white-label portals (None = default Nomad Karaoke)
"""
email = email.lower()
# Ensure user exists
self.get_or_create_user(email)
# Ensure user exists (with tenant association)
self.get_or_create_user(email, tenant_id=tenant_id)
# Generate secure token
token = secrets.token_urlsafe(32)
@@ -185,6 +204,7 @@ class UserService:
expires_at=datetime.utcnow() + timedelta(minutes=MAGIC_LINK_EXPIRY_MINUTES),
ip_address=ip_address,
user_agent=user_agent,
tenant_id=tenant_id,
)
# Save to Firestore
@@ -194,6 +214,54 @@ class UserService:
logger.info(f"Created magic link for {email}")
return magic_link
def create_admin_login_token(
self,
email: str,
expiry_hours: int = 24,
) -> MagicLinkToken:
"""
Create an admin login token for email-embedded authentication links.
Similar to magic links but with configurable expiry (default 24 hours).
Used for made-for-you order notification emails to allow admin one-click login.
Args:
email: Admin's email address to authenticate as
expiry_hours: Hours until token expires (default: 24, max: 168)
Returns:
MagicLinkToken object containing the token
Raises:
ValueError: If expiry_hours is out of valid range (1-168)
"""
# Validate expiry_hours (1 hour to 7 days)
if not 1 <= expiry_hours <= 168:
raise ValueError(f"expiry_hours must be between 1 and 168, got {expiry_hours}")
email = email.lower()
# Ensure user exists
self.get_or_create_user(email)
# Generate secure token
token = secrets.token_urlsafe(32)
admin_login = MagicLinkToken(
token=token,
email=email,
expires_at=datetime.utcnow() + timedelta(hours=expiry_hours),
)
# Save to Firestore (same collection as magic links for unified verification)
doc_ref = self.db.collection(MAGIC_LINKS_COLLECTION).document(token)
doc_ref.set(admin_login.model_dump(mode='json'))
# Log with redacted email (show only domain) for PII protection
domain = email.split('@')[-1] if '@' in email else 'unknown'
logger.info(f"Created admin login token for ***@{domain} (expires in {expiry_hours}h)")
return admin_login
def verify_magic_link(self, token: str) -> Tuple[bool, Optional[User], str]:
"""
Verify a magic link token using a Firestore transaction to prevent race conditions.
@@ -262,9 +330,18 @@ class UserService:
self,
user_email: str,
ip_address: Optional[str] = None,
user_agent: Optional[str] = None
user_agent: Optional[str] = None,
tenant_id: Optional[str] = None
) -> Session:
"""Create a new session for an authenticated user."""
"""
Create a new session for an authenticated user.
Args:
user_email: User's email address
ip_address: Client IP for auditing
user_agent: Client user agent for auditing
tenant_id: Tenant ID for white-label portals (None = default Nomad Karaoke)
"""
token = secrets.token_urlsafe(32)
token_prefix = token[:12]
@@ -274,6 +351,7 @@ class UserService:
expires_at=datetime.utcnow() + timedelta(days=SESSION_ABSOLUTE_EXPIRY_DAYS),
ip_address=ip_address,
user_agent=user_agent,
tenant_id=tenant_id,
)
# Serialize and write to Firestore
+8 -1
View File
@@ -91,7 +91,14 @@ def mock_auth_dependency(request):
if 'emulator' in test_path or 'integration' in test_path:
yield
return
# Skip for service-only unit tests that don't need the FastAPI app
# Also skip tests that manage their own auth mocks (e.g., push tests use AuthResult objects)
service_only_tests = ['test_rate_limit_service', 'test_email_validation_service', 'test_rate_limits_api', 'test_gce_encoding_worker', 'test_push_routes', 'test_push_notification_service']
if any(test_name in test_path for test_name in service_only_tests):
yield
return
# Skip if FIRESTORE_EMULATOR_HOST is set (running in emulator environment)
import os
if os.environ.get('FIRESTORE_EMULATOR_HOST'):
@@ -0,0 +1,167 @@
"""
Emulator integration tests for made-for-you order features.
Tests with real Firestore emulator via API endpoints to verify:
1. Admin login token creation and verification
2. Made-for-you job fields are properly stored
Run with: scripts/run-emulator-tests.sh
"""
import pytest
import time
from .conftest import emulators_running
# Skip all tests if emulators not running
pytestmark = pytest.mark.skipif(
not emulators_running(),
reason="GCP emulators not running. Start with: scripts/start-emulators.sh"
)
class TestAdminLoginTokenIntegration:
"""
Integration tests for admin login token feature via API.
These tests verify that admin login tokens can be verified
through the actual API endpoint.
"""
def test_verify_invalid_token_returns_401(self, client):
"""Invalid token returns 401 unauthorized."""
response = client.get("/api/users/auth/verify?token=invalid-token-xyz")
assert response.status_code == 401
def test_verify_missing_token_returns_422(self, client):
"""Missing token parameter returns 422 validation error."""
response = client.get("/api/users/auth/verify")
assert response.status_code == 422
def test_verify_empty_token_returns_401(self, client):
"""Empty token returns 401."""
response = client.get("/api/users/auth/verify?token=")
assert response.status_code == 401
class TestMadeForYouJobModel:
"""
Tests for made-for-you job model fields.
Verifies that the Job model properly supports made_for_you fields.
"""
def test_job_model_has_made_for_you_fields(self):
"""Job model includes made_for_you and customer_email fields."""
from backend.models.job import Job, JobStatus
from datetime import datetime, timezone
# Create a made-for-you job directly
job = Job(
job_id="test-mfy-model",
status=JobStatus.PENDING,
created_at=datetime.now(timezone.utc),
updated_at=datetime.now(timezone.utc),
user_email="admin@nomadkaraoke.com",
made_for_you=True,
customer_email="customer@example.com",
customer_notes="Please make it perfect!",
)
assert job.made_for_you is True
assert job.customer_email == "customer@example.com"
assert job.customer_notes == "Please make it perfect!"
def test_job_model_defaults_made_for_you_false(self):
"""Regular jobs default made_for_you to False."""
from backend.models.job import Job, JobStatus
from datetime import datetime, timezone
job = Job(
job_id="test-regular-model",
status=JobStatus.PENDING,
created_at=datetime.now(timezone.utc),
updated_at=datetime.now(timezone.utc),
user_email="user@example.com",
)
# Default should be False or None
assert job.made_for_you in [False, None]
assert job.customer_email is None
class TestOwnershipTransferLogic:
"""
Tests for ownership transfer logic (unit-style, runs in emulator context).
These tests verify the conditional logic for made-for-you ownership transfer
by importing the job_manager and testing its behavior directly.
"""
def test_ownership_transfer_condition_made_for_you_true(self):
"""
Verify the condition: if made_for_you=True and customer_email exists,
ownership should transfer.
"""
# Replicate the exact logic from _schedule_completion_email
class MockJob:
made_for_you = True
customer_email = "customer@example.com"
user_email = "admin@nomadkaraoke.com"
job_id = "test-123"
job = MockJob()
# The logic being tested
recipient_email = job.user_email
should_transfer = False
if job.made_for_you and job.customer_email:
recipient_email = job.customer_email
should_transfer = True
assert should_transfer is True
assert recipient_email == "customer@example.com"
def test_ownership_transfer_condition_made_for_you_false(self):
"""
Verify: if made_for_you=False, no ownership transfer.
"""
class MockJob:
made_for_you = False
customer_email = "customer@example.com"
user_email = "user@example.com"
job_id = "test-456"
job = MockJob()
recipient_email = job.user_email
should_transfer = False
if job.made_for_you and job.customer_email:
recipient_email = job.customer_email
should_transfer = True
assert should_transfer is False
assert recipient_email == "user@example.com"
def test_ownership_transfer_condition_missing_customer_email(self):
"""
Verify: if made_for_you=True but no customer_email, no transfer.
"""
class MockJob:
made_for_you = True
customer_email = None
user_email = "admin@nomadkaraoke.com"
job_id = "test-789"
job = MockJob()
recipient_email = job.user_email
should_transfer = False
if job.made_for_you and job.customer_email:
recipient_email = job.customer_email
should_transfer = True
assert should_transfer is False
assert recipient_email == "admin@nomadkaraoke.com"
+352
View File
@@ -0,0 +1,352 @@
"""
Unit tests for admin delete job outputs endpoint.
Tests the POST /api/admin/jobs/{job_id}/delete-outputs endpoint that allows admins
to delete distributed outputs (YouTube, Dropbox, Google Drive) while preserving
the job record.
"""
import pytest
from unittest.mock import Mock, patch, MagicMock
from fastapi.testclient import TestClient
from fastapi import FastAPI
from datetime import datetime
from backend.api.routes.admin import router
from backend.api.dependencies import require_admin
from backend.models.job import Job, JobStatus
# Create a test app with the admin router
app = FastAPI()
app.include_router(router, prefix="/api")
def get_mock_admin():
"""Override for require_admin dependency."""
from backend.api.dependencies import AuthResult, UserType
return AuthResult(
is_valid=True,
user_type=UserType.ADMIN,
remaining_uses=999,
message="Admin authenticated",
user_email="admin@example.com",
is_admin=True,
)
# Override the require_admin dependency
app.dependency_overrides[require_admin] = get_mock_admin
@pytest.fixture
def client():
"""Create a test client."""
return TestClient(app)
@pytest.fixture
def mock_complete_job():
"""Create a mock job in COMPLETE status with distribution data."""
job = Mock(spec=Job)
job.job_id = "test-job-123"
job.user_email = "user@example.com"
job.artist = "Test Artist"
job.title = "Test Title"
job.status = "complete"
job.dropbox_path = "/Karaoke/Organized"
job.outputs_deleted_at = None
job.outputs_deleted_by = None
job.state_data = {
"youtube_url": "https://youtu.be/abc123",
"brand_code": "NOMAD-1234",
"dropbox_link": "https://dropbox.com/...",
"gdrive_files": {"mp4": "file_id_1", "mp4_720p": "file_id_2"},
}
job.timeline = []
return job
@pytest.fixture
def mock_job_no_outputs():
"""Create a mock job in COMPLETE status without distribution data."""
job = Mock(spec=Job)
job.job_id = "test-job-456"
job.user_email = "user@example.com"
job.artist = "Test Artist"
job.title = "Test Title"
job.status = "complete"
job.dropbox_path = None
job.outputs_deleted_at = None
job.outputs_deleted_by = None
job.state_data = {}
job.timeline = []
return job
class TestDeleteOutputsSuccess:
"""Tests for successful output deletion."""
def test_delete_outputs_success(self, client, mock_complete_job):
"""Test successfully deleting outputs from a complete job."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class, \
patch('backend.api.routes.admin.get_user_service') as mock_user_service:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_complete_job
mock_jm_class.return_value = mock_jm
# Mock Firestore
mock_db = Mock()
mock_job_ref = Mock()
mock_db.collection.return_value.document.return_value = mock_job_ref
mock_user_service.return_value.db = mock_db
response = client.post("/api/admin/jobs/test-job-123/delete-outputs")
assert response.status_code == 200
data = response.json()
assert data["status"] == "success"
assert data["job_id"] == "test-job-123"
assert "outputs_deleted_at" in data
def test_delete_outputs_clears_state_data_keys(self, client, mock_complete_job):
"""Test that output-related state_data keys are listed as cleared."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class, \
patch('backend.api.routes.admin.get_user_service') as mock_user_service:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_complete_job
mock_jm_class.return_value = mock_jm
# Mock Firestore
mock_db = Mock()
mock_job_ref = Mock()
mock_db.collection.return_value.document.return_value = mock_job_ref
mock_user_service.return_value.db = mock_db
response = client.post("/api/admin/jobs/test-job-123/delete-outputs")
assert response.status_code == 200
data = response.json()
# Should list cleared keys
assert "youtube_url" in data["cleared_state_data"]
assert "brand_code" in data["cleared_state_data"]
assert "dropbox_link" in data["cleared_state_data"]
assert "gdrive_files" in data["cleared_state_data"]
def test_delete_outputs_job_without_distribution(self, client, mock_job_no_outputs):
"""Test deleting outputs from job that has no distribution data."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class, \
patch('backend.api.routes.admin.get_user_service') as mock_user_service:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job_no_outputs
mock_jm_class.return_value = mock_jm
# Mock Firestore
mock_db = Mock()
mock_job_ref = Mock()
mock_db.collection.return_value.document.return_value = mock_job_ref
mock_user_service.return_value.db = mock_db
response = client.post("/api/admin/jobs/test-job-456/delete-outputs")
assert response.status_code == 200
data = response.json()
assert data["status"] == "success"
# All services should be skipped
assert data["deleted_services"]["youtube"]["status"] == "skipped"
assert data["deleted_services"]["dropbox"]["status"] == "skipped"
assert data["deleted_services"]["gdrive"]["status"] == "skipped"
# No keys to clear
assert data["cleared_state_data"] == []
class TestDeleteOutputsValidation:
"""Tests for validation on delete outputs endpoint."""
def test_rejects_non_terminal_status(self, client, mock_complete_job):
"""Test that jobs not in terminal states are rejected."""
mock_complete_job.status = "encoding"
with patch('backend.api.routes.admin.JobManager') as mock_jm_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_complete_job
mock_jm_class.return_value = mock_jm
response = client.post("/api/admin/jobs/test-job-123/delete-outputs")
assert response.status_code == 400
assert "terminal" in response.json()["detail"].lower()
def test_rejects_awaiting_review_status(self, client, mock_complete_job):
"""Test that AWAITING_REVIEW is rejected (not terminal)."""
mock_complete_job.status = "awaiting_review"
with patch('backend.api.routes.admin.JobManager') as mock_jm_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_complete_job
mock_jm_class.return_value = mock_jm
response = client.post("/api/admin/jobs/test-job-123/delete-outputs")
assert response.status_code == 400
def test_accepts_prep_complete_status(self, client, mock_complete_job):
"""Test that prep_complete is accepted as terminal."""
mock_complete_job.status = "prep_complete"
with patch('backend.api.routes.admin.JobManager') as mock_jm_class, \
patch('backend.api.routes.admin.get_user_service') as mock_user_service:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_complete_job
mock_jm_class.return_value = mock_jm
mock_db = Mock()
mock_job_ref = Mock()
mock_db.collection.return_value.document.return_value = mock_job_ref
mock_user_service.return_value.db = mock_db
response = client.post("/api/admin/jobs/test-job-123/delete-outputs")
assert response.status_code == 200
def test_accepts_failed_status(self, client, mock_complete_job):
"""Test that failed is accepted as terminal."""
mock_complete_job.status = "failed"
with patch('backend.api.routes.admin.JobManager') as mock_jm_class, \
patch('backend.api.routes.admin.get_user_service') as mock_user_service:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_complete_job
mock_jm_class.return_value = mock_jm
mock_db = Mock()
mock_job_ref = Mock()
mock_db.collection.return_value.document.return_value = mock_job_ref
mock_user_service.return_value.db = mock_db
response = client.post("/api/admin/jobs/test-job-123/delete-outputs")
assert response.status_code == 200
def test_rejects_already_deleted(self, client, mock_complete_job):
"""Test that already-deleted outputs cannot be deleted again."""
mock_complete_job.outputs_deleted_at = datetime(2026, 1, 9, 12, 0, 0)
with patch('backend.api.routes.admin.JobManager') as mock_jm_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_complete_job
mock_jm_class.return_value = mock_jm
response = client.post("/api/admin/jobs/test-job-123/delete-outputs")
assert response.status_code == 400
assert "already deleted" in response.json()["detail"].lower()
def test_returns_404_for_missing_job(self, client):
"""Test 404 when job doesn't exist."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class:
mock_jm = Mock()
mock_jm.get_job.return_value = None
mock_jm_class.return_value = mock_jm
response = client.post("/api/admin/jobs/nonexistent/delete-outputs")
assert response.status_code == 404
assert "not found" in response.json()["detail"].lower()
class TestDeleteOutputsServices:
"""Tests for service deletion behavior."""
def test_handles_missing_youtube(self, client, mock_complete_job):
"""Test handling when job has no YouTube URL."""
mock_complete_job.state_data = {"brand_code": "NOMAD-1234"}
with patch('backend.api.routes.admin.JobManager') as mock_jm_class, \
patch('backend.api.routes.admin.get_user_service') as mock_user_service:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_complete_job
mock_jm_class.return_value = mock_jm
mock_db = Mock()
mock_job_ref = Mock()
mock_db.collection.return_value.document.return_value = mock_job_ref
mock_user_service.return_value.db = mock_db
response = client.post("/api/admin/jobs/test-job-123/delete-outputs")
assert response.status_code == 200
data = response.json()
assert data["deleted_services"]["youtube"]["status"] == "skipped"
def test_handles_missing_dropbox_path(self, client, mock_complete_job):
"""Test handling when job has no dropbox_path."""
mock_complete_job.dropbox_path = None
mock_complete_job.state_data = {"youtube_url": "https://youtu.be/abc123"}
with patch('backend.api.routes.admin.JobManager') as mock_jm_class, \
patch('backend.api.routes.admin.get_user_service') as mock_user_service:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_complete_job
mock_jm_class.return_value = mock_jm
mock_db = Mock()
mock_job_ref = Mock()
mock_db.collection.return_value.document.return_value = mock_job_ref
mock_user_service.return_value.db = mock_db
response = client.post("/api/admin/jobs/test-job-123/delete-outputs")
assert response.status_code == 200
data = response.json()
assert data["deleted_services"]["dropbox"]["status"] == "skipped"
class TestDeleteOutputsLogging:
"""Tests for logging on delete outputs endpoint."""
def test_logs_admin_action(self, client, mock_complete_job):
"""Test that admin delete action is logged."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class, \
patch('backend.api.routes.admin.get_user_service') as mock_user_service, \
patch('backend.api.routes.admin.logger') as mock_logger:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_complete_job
mock_jm_class.return_value = mock_jm
mock_db = Mock()
mock_job_ref = Mock()
mock_db.collection.return_value.document.return_value = mock_job_ref
mock_user_service.return_value.db = mock_db
response = client.post("/api/admin/jobs/test-job-123/delete-outputs")
assert response.status_code == 200
mock_logger.info.assert_called()
log_message = mock_logger.info.call_args[0][0]
assert "admin" in log_message.lower() or "deleted" in log_message.lower()
class TestDeleteOutputsAuthorization:
"""Tests for authorization on the delete outputs endpoint."""
def test_requires_admin_access(self, client, mock_complete_job):
"""Test that non-admin users cannot access the endpoint."""
original_override = app.dependency_overrides.get(require_admin)
def get_non_admin():
from fastapi import HTTPException
raise HTTPException(status_code=403, detail="Admin access required")
app.dependency_overrides[require_admin] = get_non_admin
try:
response = client.post(
"/api/admin/jobs/test-job-123/delete-outputs",
headers={"Authorization": "Bearer user-token"}
)
assert response.status_code == 403
finally:
if original_override:
app.dependency_overrides[require_admin] = original_override
else:
app.dependency_overrides[require_admin] = get_mock_admin
+337
View File
@@ -0,0 +1,337 @@
"""
Unit tests for admin job files endpoint.
Tests the GET /api/admin/jobs/{job_id}/files endpoint that returns
all files for a job with signed download URLs.
"""
import pytest
from unittest.mock import Mock, patch
from fastapi.testclient import TestClient
from fastapi import FastAPI
from backend.api.routes.admin import router
from backend.api.dependencies import require_admin
from backend.models.job import Job, JobStatus
# Create a test app with the admin router
app = FastAPI()
app.include_router(router, prefix="/api")
def get_mock_admin():
"""Override for require_admin dependency."""
from backend.api.dependencies import AuthResult, UserType
return AuthResult(
is_valid=True,
user_type=UserType.ADMIN,
remaining_uses=999,
message="Admin authenticated",
user_email="admin@example.com",
is_admin=True,
)
# Override the require_admin dependency
app.dependency_overrides[require_admin] = get_mock_admin
@pytest.fixture
def client():
"""Create a test client."""
return TestClient(app)
@pytest.fixture
def mock_job_with_files():
"""Create a mock job with comprehensive file_urls."""
job = Mock(spec=Job)
job.job_id = "test-job-123"
job.user_email = "user@example.com"
job.artist = "Test Artist"
job.title = "Test Song"
job.status = JobStatus.COMPLETE
job.file_urls = {
"input": "gs://bucket/jobs/test-job-123/input.flac",
"stems": {
"instrumental_clean": "gs://bucket/jobs/test-job-123/stems/instrumental_clean.flac",
"vocals": "gs://bucket/jobs/test-job-123/stems/vocals.flac",
},
"lyrics": {
"corrections": "gs://bucket/jobs/test-job-123/lyrics/corrections.json",
"lrc": "gs://bucket/jobs/test-job-123/lyrics/output.lrc",
},
"finals": {
"lossy_720p_mp4": "gs://bucket/jobs/test-job-123/finals/video_720p.mp4",
},
"youtube": {
"url": "https://youtube.com/watch?v=xyz789",
"video_id": "xyz789",
},
}
return job
@pytest.fixture
def mock_job_no_files():
"""Create a mock job with empty file_urls."""
job = Mock(spec=Job)
job.job_id = "test-job-empty"
job.user_email = "user@example.com"
job.artist = "Empty Artist"
job.title = "Empty Song"
job.status = JobStatus.PENDING
job.file_urls = {}
return job
@pytest.fixture
def mock_job_partial_files():
"""Create a mock job with only some files (partial processing)."""
job = Mock(spec=Job)
job.job_id = "test-job-partial"
job.user_email = "user@example.com"
job.artist = "Partial Artist"
job.title = "Partial Song"
job.status = JobStatus.SEPARATING_STAGE1
job.file_urls = {
"input": "gs://bucket/jobs/test-job-partial/input.flac",
"stems": {
"instrumental_clean": "gs://bucket/jobs/test-job-partial/stems/instrumental_clean.flac",
},
}
return job
class TestGetJobFiles:
"""Tests for GET /api/admin/jobs/{job_id}/files endpoint."""
def test_returns_files_with_signed_urls(self, client, mock_job_with_files):
"""Test that endpoint returns all files with signed URLs."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class, \
patch('backend.api.routes.admin.StorageService') as mock_storage_class:
# Setup JobManager mock
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job_with_files
mock_jm_class.return_value = mock_jm
# Setup StorageService mock to return predictable signed URLs
mock_storage = Mock()
mock_storage.generate_signed_url.side_effect = lambda path, **kwargs: f"https://signed.url/{path}"
mock_storage_class.return_value = mock_storage
response = client.get(
"/api/admin/jobs/test-job-123/files",
headers={"Authorization": "Bearer admin-token"}
)
assert response.status_code == 200
data = response.json()
assert data["job_id"] == "test-job-123"
assert data["artist"] == "Test Artist"
assert data["title"] == "Test Song"
assert "files" in data
assert data["total_files"] > 0
def test_returns_correct_file_count(self, client, mock_job_with_files):
"""Test that file count matches actual GCS files (excluding non-GCS entries)."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class, \
patch('backend.api.routes.admin.StorageService') as mock_storage_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job_with_files
mock_jm_class.return_value = mock_jm
mock_storage = Mock()
mock_storage.generate_signed_url.side_effect = lambda path, **kwargs: f"https://signed.url/{path}"
mock_storage_class.return_value = mock_storage
response = client.get("/api/admin/jobs/test-job-123/files")
data = response.json()
# Should have: input, stems.instrumental_clean, stems.vocals,
# lyrics.corrections, lyrics.lrc, finals.lossy_720p_mp4
# NOT youtube.url or youtube.video_id (not GCS paths)
assert data["total_files"] == 6
def test_handles_nested_file_structure(self, client, mock_job_with_files):
"""Test that nested file_urls structure is properly traversed."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class, \
patch('backend.api.routes.admin.StorageService') as mock_storage_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job_with_files
mock_jm_class.return_value = mock_jm
mock_storage = Mock()
mock_storage.generate_signed_url.side_effect = lambda path, **kwargs: f"https://signed.url/{path}"
mock_storage_class.return_value = mock_storage
response = client.get("/api/admin/jobs/test-job-123/files")
data = response.json()
files = data["files"]
# Check that files from different categories are present
categories = {f["category"] for f in files}
assert "input" in categories or any(f["category"] == "" and f["file_key"] == "input" for f in files)
assert "stems" in categories
assert "lyrics" in categories
assert "finals" in categories
def test_file_info_structure(self, client, mock_job_with_files):
"""Test that each file has correct info structure."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class, \
patch('backend.api.routes.admin.StorageService') as mock_storage_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job_with_files
mock_jm_class.return_value = mock_jm
mock_storage = Mock()
mock_storage.generate_signed_url.side_effect = lambda path, **kwargs: f"https://signed.url/{path}"
mock_storage_class.return_value = mock_storage
response = client.get("/api/admin/jobs/test-job-123/files")
data = response.json()
files = data["files"]
# Every file should have these fields
for file_info in files:
assert "name" in file_info
assert "path" in file_info
assert "download_url" in file_info
assert "category" in file_info
assert "file_key" in file_info
# download_url should be a signed URL
assert file_info["download_url"].startswith("https://signed.url/")
def test_returns_404_when_job_not_found(self, client):
"""Test 404 when job doesn't exist."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class:
mock_jm = Mock()
mock_jm.get_job.return_value = None
mock_jm_class.return_value = mock_jm
response = client.get(
"/api/admin/jobs/nonexistent-job/files",
headers={"Authorization": "Bearer admin-token"}
)
assert response.status_code == 404
assert "not found" in response.json()["detail"].lower()
def test_returns_empty_files_for_new_job(self, client, mock_job_no_files):
"""Test that new jobs with no files return empty list."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class, \
patch('backend.api.routes.admin.StorageService') as mock_storage_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job_no_files
mock_jm_class.return_value = mock_jm
mock_storage = Mock()
mock_storage_class.return_value = mock_storage
response = client.get("/api/admin/jobs/test-job-empty/files")
assert response.status_code == 200
data = response.json()
assert data["job_id"] == "test-job-empty"
assert data["files"] == []
assert data["total_files"] == 0
def test_handles_partial_processing(self, client, mock_job_partial_files):
"""Test job with only some files processed."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class, \
patch('backend.api.routes.admin.StorageService') as mock_storage_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job_partial_files
mock_jm_class.return_value = mock_jm
mock_storage = Mock()
mock_storage.generate_signed_url.side_effect = lambda path, **kwargs: f"https://signed.url/{path}"
mock_storage_class.return_value = mock_storage
response = client.get("/api/admin/jobs/test-job-partial/files")
assert response.status_code == 200
data = response.json()
# Should have input + stems.instrumental_clean = 2 files
assert data["total_files"] == 2
def test_skips_non_gcs_urls(self, client, mock_job_with_files):
"""Test that non-GCS URLs (like youtube URLs) are skipped."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class, \
patch('backend.api.routes.admin.StorageService') as mock_storage_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job_with_files
mock_jm_class.return_value = mock_jm
mock_storage = Mock()
mock_storage.generate_signed_url.side_effect = lambda path, **kwargs: f"https://signed.url/{path}"
mock_storage_class.return_value = mock_storage
response = client.get("/api/admin/jobs/test-job-123/files")
data = response.json()
files = data["files"]
# Ensure no youtube URLs or video IDs are in the files
for file_info in files:
assert "youtube.com" not in file_info["path"]
assert file_info["path"].startswith("gs://")
def test_signed_url_expiration(self, client, mock_job_with_files):
"""Test that signed URLs are generated with appropriate expiration."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class, \
patch('backend.api.routes.admin.StorageService') as mock_storage_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job_with_files
mock_jm_class.return_value = mock_jm
mock_storage = Mock()
mock_storage.generate_signed_url.return_value = "https://signed.url/test"
mock_storage_class.return_value = mock_storage
client.get("/api/admin/jobs/test-job-123/files")
# Verify signed URLs were requested with expiration (default 120 minutes)
assert mock_storage.generate_signed_url.called
# Check that expiration_minutes was passed (could be any reasonable value)
call_kwargs = mock_storage.generate_signed_url.call_args_list[0][1]
if "expiration_minutes" in call_kwargs:
assert call_kwargs["expiration_minutes"] >= 60
class TestGetJobFilesAuthorization:
"""Tests for authorization on the files endpoint."""
def test_requires_admin_access(self, client, mock_job_with_files):
"""Test that non-admin users cannot access the endpoint."""
# Reset the dependency override to test auth
original_override = app.dependency_overrides.get(require_admin)
def get_non_admin():
from fastapi import HTTPException
raise HTTPException(status_code=403, detail="Admin access required")
app.dependency_overrides[require_admin] = get_non_admin
try:
response = client.get(
"/api/admin/jobs/test-job-123/files",
headers={"Authorization": "Bearer user-token"}
)
assert response.status_code == 403
finally:
# Restore the original override
if original_override:
app.dependency_overrides[require_admin] = original_override
else:
app.dependency_overrides[require_admin] = get_mock_admin
+384
View File
@@ -0,0 +1,384 @@
"""
Unit tests for admin job reset endpoint.
Tests the POST /api/admin/jobs/{job_id}/reset endpoint that allows admins
to reset a job to a specific state for re-processing.
"""
import pytest
from unittest.mock import Mock, patch
from fastapi.testclient import TestClient
from fastapi import FastAPI
from datetime import datetime
from backend.api.routes.admin import router
from backend.api.dependencies import require_admin
from backend.models.job import Job, JobStatus
# Create a test app with the admin router
app = FastAPI()
app.include_router(router, prefix="/api")
def get_mock_admin():
"""Override for require_admin dependency."""
from backend.api.dependencies import AuthResult, UserType
return AuthResult(
is_valid=True,
user_type=UserType.ADMIN,
remaining_uses=999,
message="Admin authenticated",
user_email="admin@example.com",
is_admin=True,
)
# Override the require_admin dependency
app.dependency_overrides[require_admin] = get_mock_admin
@pytest.fixture
def client():
"""Create a test client."""
return TestClient(app)
@pytest.fixture
def mock_job():
"""Create a mock job in COMPLETE status for testing."""
job = Mock(spec=Job)
job.job_id = "test-job-123"
job.user_email = "user@example.com"
job.artist = "Test Artist"
job.title = "Test Title"
job.status = JobStatus.COMPLETE
job.theme_id = "nomad"
job.file_urls = {
"input": "gs://bucket/input.flac",
"stems": {
"instrumental_clean": "gs://bucket/stems/clean.flac",
},
"lyrics": {
"corrections": "gs://bucket/lyrics/corrections.json",
},
}
job.state_data = {
"audio_search_results": [{"provider": "test"}],
"audio_selection": {"index": 0},
"review_complete": True,
"corrected_lyrics": {"lines": []},
"instrumental_selection": "clean",
"brand_code": "NOMAD-1234",
}
job.timeline = []
job.created_at = datetime(2026, 1, 9, 10, 0, 0)
job.updated_at = datetime(2026, 1, 9, 12, 0, 0)
return job
class TestResetJobToPending:
"""Tests for resetting job to PENDING state."""
def test_reset_to_pending_success(self, client, mock_job):
"""Test resetting a job to PENDING state."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job
mock_jm.update_job.return_value = True
mock_jm_class.return_value = mock_jm
response = client.post(
"/api/admin/jobs/test-job-123/reset",
json={"target_state": "pending"},
)
assert response.status_code == 200
data = response.json()
assert data["status"] == "success"
assert data["job_id"] == "test-job-123"
assert data["new_status"] == "pending"
assert "pending" in data["message"].lower()
def test_reset_to_pending_clears_state_data(self, client, mock_job):
"""Test that resetting to PENDING clears appropriate state_data keys."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job
mock_jm.update_job.return_value = True
mock_jm_class.return_value = mock_jm
response = client.post(
"/api/admin/jobs/test-job-123/reset",
json={"target_state": "pending"},
)
assert response.status_code == 200
# Verify update_job was called with cleared state_data keys
call_args = mock_jm.update_job.call_args
update_data = call_args[0][1]
# Verify status was set
assert update_data["status"] == "pending"
class TestResetJobToAwaitingAudioSelection:
"""Tests for resetting job to AWAITING_AUDIO_SELECTION state."""
def test_reset_to_awaiting_audio_selection(self, client, mock_job):
"""Test resetting a job to AWAITING_AUDIO_SELECTION state."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job
mock_jm.update_job.return_value = True
mock_jm_class.return_value = mock_jm
response = client.post(
"/api/admin/jobs/test-job-123/reset",
json={"target_state": "awaiting_audio_selection"},
)
assert response.status_code == 200
data = response.json()
assert data["new_status"] == "awaiting_audio_selection"
class TestResetJobToAwaitingReview:
"""Tests for resetting job to AWAITING_REVIEW state."""
def test_reset_to_awaiting_review(self, client, mock_job):
"""Test resetting a job to AWAITING_REVIEW state."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job
mock_jm.update_job.return_value = True
mock_jm_class.return_value = mock_jm
response = client.post(
"/api/admin/jobs/test-job-123/reset",
json={"target_state": "awaiting_review"},
)
assert response.status_code == 200
data = response.json()
assert data["new_status"] == "awaiting_review"
class TestResetJobToAwaitingInstrumentalSelection:
"""Tests for resetting job to AWAITING_INSTRUMENTAL_SELECTION state."""
def test_reset_to_awaiting_instrumental_selection(self, client, mock_job):
"""Test resetting a job to AWAITING_INSTRUMENTAL_SELECTION state."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job
mock_jm.update_job.return_value = True
mock_jm_class.return_value = mock_jm
response = client.post(
"/api/admin/jobs/test-job-123/reset",
json={"target_state": "awaiting_instrumental_selection"},
)
assert response.status_code == 200
data = response.json()
assert data["new_status"] == "awaiting_instrumental_selection"
class TestResetJobValidation:
"""Tests for reset endpoint validation."""
def test_rejects_invalid_target_state(self, client, mock_job):
"""Test that invalid target states are rejected."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job
mock_jm_class.return_value = mock_jm
response = client.post(
"/api/admin/jobs/test-job-123/reset",
json={"target_state": "encoding"},
)
assert response.status_code == 400
assert "invalid" in response.json()["detail"].lower() or "not allowed" in response.json()["detail"].lower()
def test_rejects_complete_as_target(self, client, mock_job):
"""Test that COMPLETE is not a valid reset target."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job
mock_jm_class.return_value = mock_jm
response = client.post(
"/api/admin/jobs/test-job-123/reset",
json={"target_state": "complete"},
)
assert response.status_code == 400
def test_rejects_failed_as_target(self, client, mock_job):
"""Test that FAILED is not a valid reset target."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job
mock_jm_class.return_value = mock_jm
response = client.post(
"/api/admin/jobs/test-job-123/reset",
json={"target_state": "failed"},
)
assert response.status_code == 400
def test_returns_404_when_job_not_found(self, client):
"""Test 404 when job doesn't exist."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class:
mock_jm = Mock()
mock_jm.get_job.return_value = None
mock_jm_class.return_value = mock_jm
response = client.post(
"/api/admin/jobs/nonexistent-job/reset",
json={"target_state": "pending"},
)
assert response.status_code == 404
assert "not found" in response.json()["detail"].lower()
def test_rejects_missing_target_state(self, client, mock_job):
"""Test that target_state is required."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job
mock_jm_class.return_value = mock_jm
response = client.post(
"/api/admin/jobs/test-job-123/reset",
json={},
)
assert response.status_code == 422 # Validation error
class TestResetJobLogging:
"""Tests for logging on the reset endpoint."""
def test_logs_admin_reset_action(self, client, mock_job):
"""Test that admin reset actions are logged."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class, \
patch('backend.api.routes.admin.logger') as mock_logger:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job
mock_jm.update_job.return_value = True
mock_jm_class.return_value = mock_jm
response = client.post(
"/api/admin/jobs/test-job-123/reset",
json={"target_state": "pending"},
)
assert response.status_code == 200
# Verify logging was called
mock_logger.info.assert_called()
log_message = mock_logger.info.call_args[0][0]
assert "admin" in log_message.lower() or "reset" in log_message.lower()
class TestResetJobTimeline:
"""Tests for timeline event on reset."""
def test_adds_timeline_event_on_reset(self, client, mock_job):
"""Test that a timeline event is added when job is reset."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job
mock_jm.update_job.return_value = True
mock_jm_class.return_value = mock_jm
response = client.post(
"/api/admin/jobs/test-job-123/reset",
json={"target_state": "awaiting_review"},
)
assert response.status_code == 200
data = response.json()
# Timeline event should be included in response
assert "timeline_event" in data or data.get("message")
class TestResetJobAuthorization:
"""Tests for authorization on the reset endpoint."""
def test_requires_admin_access(self, client, mock_job):
"""Test that non-admin users cannot access the endpoint."""
original_override = app.dependency_overrides.get(require_admin)
def get_non_admin():
from fastapi import HTTPException
raise HTTPException(status_code=403, detail="Admin access required")
app.dependency_overrides[require_admin] = get_non_admin
try:
response = client.post(
"/api/admin/jobs/test-job-123/reset",
json={"target_state": "pending"},
headers={"Authorization": "Bearer user-token"}
)
assert response.status_code == 403
finally:
if original_override:
app.dependency_overrides[require_admin] = original_override
else:
app.dependency_overrides[require_admin] = get_mock_admin
class TestResetJobClearsStateData:
"""Tests for state_data clearing based on target state."""
def test_reset_to_pending_clears_all_processing_data(self, client, mock_job):
"""Test that resetting to PENDING clears audio search results."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job
mock_jm.update_job.return_value = True
mock_jm_class.return_value = mock_jm
response = client.post(
"/api/admin/jobs/test-job-123/reset",
json={"target_state": "pending"},
)
assert response.status_code == 200
# The cleared_data field should list what was cleared
data = response.json()
assert "cleared_data" in data or "state_data" in str(data)
def test_reset_to_awaiting_review_preserves_audio_data(self, client, mock_job):
"""Test that resetting to AWAITING_REVIEW preserves audio stems."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job
mock_jm.update_job.return_value = True
mock_jm_class.return_value = mock_jm
response = client.post(
"/api/admin/jobs/test-job-123/reset",
json={"target_state": "awaiting_review"},
)
assert response.status_code == 200
def test_reset_to_instrumental_preserves_review_data(self, client, mock_job):
"""Test that resetting to AWAITING_INSTRUMENTAL_SELECTION preserves review data."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job
mock_jm.update_job.return_value = True
mock_jm_class.return_value = mock_jm
response = client.post(
"/api/admin/jobs/test-job-123/reset",
json={"target_state": "awaiting_instrumental_selection"},
)
assert response.status_code == 200
+326
View File
@@ -0,0 +1,326 @@
"""
Unit tests for admin job update endpoint.
Tests the PATCH /api/admin/jobs/{job_id} endpoint that allows admins
to update editable job fields.
"""
import pytest
from unittest.mock import Mock, patch
from fastapi.testclient import TestClient
from fastapi import FastAPI
from backend.api.routes.admin import router
from backend.api.dependencies import require_admin
from backend.models.job import Job, JobStatus
# Create a test app with the admin router
app = FastAPI()
app.include_router(router, prefix="/api")
def get_mock_admin():
"""Override for require_admin dependency."""
from backend.api.dependencies import AuthResult, UserType
return AuthResult(
is_valid=True,
user_type=UserType.ADMIN,
remaining_uses=999,
message="Admin authenticated",
user_email="admin@example.com",
is_admin=True,
)
# Override the require_admin dependency
app.dependency_overrides[require_admin] = get_mock_admin
@pytest.fixture
def client():
"""Create a test client."""
return TestClient(app)
@pytest.fixture
def mock_job():
"""Create a mock job for testing."""
job = Mock(spec=Job)
job.job_id = "test-job-123"
job.user_email = "user@example.com"
job.artist = "Original Artist"
job.title = "Original Title"
job.status = JobStatus.AWAITING_REVIEW
job.theme_id = "nomad"
job.enable_cdg = False
job.enable_txt = False
job.enable_youtube_upload = True
job.customer_email = None
job.customer_notes = None
job.brand_prefix = None
job.non_interactive = False
job.prep_only = False
job.discord_webhook_url = None
job.youtube_description = None
job.youtube_description_template = None
job.file_urls = {}
job.state_data = {}
job.created_at = "2026-01-09T10:00:00Z"
job.updated_at = "2026-01-09T10:30:00Z"
return job
class TestUpdateJob:
"""Tests for PATCH /api/admin/jobs/{job_id} endpoint."""
def test_update_artist_field(self, client, mock_job):
"""Test updating the artist field."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job
mock_jm.update_job.return_value = True
mock_jm_class.return_value = mock_jm
response = client.patch(
"/api/admin/jobs/test-job-123",
json={"artist": "New Artist"},
headers={"Authorization": "Bearer admin-token"}
)
assert response.status_code == 200
data = response.json()
assert data["status"] == "success"
assert data["job_id"] == "test-job-123"
assert "artist" in data["updated_fields"]
# Verify update_job was called with correct args
mock_jm.update_job.assert_called_once()
call_args = mock_jm.update_job.call_args
assert call_args[0][0] == "test-job-123"
assert call_args[0][1]["artist"] == "New Artist"
def test_update_multiple_fields(self, client, mock_job):
"""Test updating multiple fields at once."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job
mock_jm.update_job.return_value = True
mock_jm_class.return_value = mock_jm
response = client.patch(
"/api/admin/jobs/test-job-123",
json={
"artist": "New Artist",
"title": "New Title",
"theme_id": "default",
"enable_cdg": True,
},
)
assert response.status_code == 200
data = response.json()
assert len(data["updated_fields"]) == 4
assert "artist" in data["updated_fields"]
assert "title" in data["updated_fields"]
assert "theme_id" in data["updated_fields"]
assert "enable_cdg" in data["updated_fields"]
def test_update_user_email(self, client, mock_job):
"""Test updating user_email field."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job
mock_jm.update_job.return_value = True
mock_jm_class.return_value = mock_jm
response = client.patch(
"/api/admin/jobs/test-job-123",
json={"user_email": "newuser@example.com"},
)
assert response.status_code == 200
call_args = mock_jm.update_job.call_args
assert call_args[0][1]["user_email"] == "newuser@example.com"
def test_update_boolean_fields(self, client, mock_job):
"""Test updating boolean fields."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job
mock_jm.update_job.return_value = True
mock_jm_class.return_value = mock_jm
response = client.patch(
"/api/admin/jobs/test-job-123",
json={
"enable_cdg": True,
"enable_txt": True,
"enable_youtube_upload": False,
"non_interactive": True,
"prep_only": True,
},
)
assert response.status_code == 200
call_args = mock_jm.update_job.call_args
assert call_args[0][1]["enable_cdg"] is True
assert call_args[0][1]["enable_txt"] is True
assert call_args[0][1]["enable_youtube_upload"] is False
def test_rejects_non_editable_job_id(self, client, mock_job):
"""Test that job_id cannot be updated."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job
mock_jm_class.return_value = mock_jm
response = client.patch(
"/api/admin/jobs/test-job-123",
json={"job_id": "new-job-id"},
)
assert response.status_code == 400
assert "not editable" in response.json()["detail"].lower()
def test_rejects_non_editable_created_at(self, client, mock_job):
"""Test that created_at cannot be updated."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job
mock_jm_class.return_value = mock_jm
response = client.patch(
"/api/admin/jobs/test-job-123",
json={"created_at": "2025-01-01T00:00:00Z"},
)
assert response.status_code == 400
assert "not editable" in response.json()["detail"].lower()
def test_rejects_status_update(self, client, mock_job):
"""Test that status cannot be updated via PATCH (use reset endpoint)."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job
mock_jm_class.return_value = mock_jm
response = client.patch(
"/api/admin/jobs/test-job-123",
json={"status": "complete"},
)
assert response.status_code == 400
assert "not editable" in response.json()["detail"].lower()
def test_rejects_state_data_update(self, client, mock_job):
"""Test that state_data cannot be updated directly."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job
mock_jm_class.return_value = mock_jm
response = client.patch(
"/api/admin/jobs/test-job-123",
json={"state_data": {"foo": "bar"}},
)
assert response.status_code == 400
assert "not editable" in response.json()["detail"].lower()
def test_returns_404_when_job_not_found(self, client):
"""Test 404 when job doesn't exist."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class:
mock_jm = Mock()
mock_jm.get_job.return_value = None
mock_jm_class.return_value = mock_jm
response = client.patch(
"/api/admin/jobs/nonexistent-job",
json={"artist": "New Artist"},
)
assert response.status_code == 404
assert "not found" in response.json()["detail"].lower()
def test_returns_400_for_empty_update(self, client, mock_job):
"""Test 400 when no valid fields are provided."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job
mock_jm_class.return_value = mock_jm
response = client.patch(
"/api/admin/jobs/test-job-123",
json={},
)
assert response.status_code == 400
assert "no valid" in response.json()["detail"].lower()
def test_logs_admin_changes(self, client, mock_job):
"""Test that admin changes are logged."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class, \
patch('backend.api.routes.admin.logger') as mock_logger:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job
mock_jm.update_job.return_value = True
mock_jm_class.return_value = mock_jm
response = client.patch(
"/api/admin/jobs/test-job-123",
json={"artist": "New Artist"},
)
assert response.status_code == 200
# Verify logging was called
mock_logger.info.assert_called()
log_message = mock_logger.info.call_args[0][0]
assert "admin@example.com" in log_message.lower() or "admin" in log_message.lower()
def test_update_customer_fields(self, client, mock_job):
"""Test updating made-for-you customer fields."""
with patch('backend.api.routes.admin.JobManager') as mock_jm_class:
mock_jm = Mock()
mock_jm.get_job.return_value = mock_job
mock_jm.update_job.return_value = True
mock_jm_class.return_value = mock_jm
response = client.patch(
"/api/admin/jobs/test-job-123",
json={
"customer_email": "customer@example.com",
"customer_notes": "Special request: add extra countdown",
},
)
assert response.status_code == 200
call_args = mock_jm.update_job.call_args
assert call_args[0][1]["customer_email"] == "customer@example.com"
assert call_args[0][1]["customer_notes"] == "Special request: add extra countdown"
class TestUpdateJobAuthorization:
"""Tests for authorization on the update endpoint."""
def test_requires_admin_access(self, client, mock_job):
"""Test that non-admin users cannot access the endpoint."""
original_override = app.dependency_overrides.get(require_admin)
def get_non_admin():
from fastapi import HTTPException
raise HTTPException(status_code=403, detail="Admin access required")
app.dependency_overrides[require_admin] = get_non_admin
try:
response = client.patch(
"/api/admin/jobs/test-job-123",
json={"artist": "New Artist"},
headers={"Authorization": "Bearer user-token"}
)
assert response.status_code == 403
finally:
if original_override:
app.dependency_overrides[require_admin] = original_override
else:
app.dependency_overrides[require_admin] = get_mock_admin
+12 -8
View File
@@ -845,7 +845,8 @@ class TestAudioSearchThemeSupport:
This is the key behavior: selecting a theme should automatically
enable CDG and TXT output formats.
"""
from backend.api.routes.audio_search import AudioSearchRequest, _resolve_cdg_txt_defaults
from backend.api.routes.audio_search import AudioSearchRequest
from backend.services.job_defaults_service import resolve_cdg_txt_defaults
# When theme_id is set, enable_cdg/enable_txt should default to True
request = AudioSearchRequest(
@@ -855,7 +856,7 @@ class TestAudioSearchThemeSupport:
# enable_cdg and enable_txt are None (not specified)
)
resolved_cdg, resolved_txt = _resolve_cdg_txt_defaults(
resolved_cdg, resolved_txt = resolve_cdg_txt_defaults(
request.theme_id, request.enable_cdg, request.enable_txt
)
@@ -864,7 +865,8 @@ class TestAudioSearchThemeSupport:
def test_audio_search_request_no_theme_no_cdg_txt(self):
"""Test that without theme_id, CDG/TXT defaults to disabled."""
from backend.api.routes.audio_search import AudioSearchRequest, _resolve_cdg_txt_defaults
from backend.api.routes.audio_search import AudioSearchRequest
from backend.services.job_defaults_service import resolve_cdg_txt_defaults
request = AudioSearchRequest(
artist="Test Artist",
@@ -872,7 +874,7 @@ class TestAudioSearchThemeSupport:
# No theme_id, no enable_cdg, no enable_txt
)
resolved_cdg, resolved_txt = _resolve_cdg_txt_defaults(
resolved_cdg, resolved_txt = resolve_cdg_txt_defaults(
request.theme_id, request.enable_cdg, request.enable_txt
)
@@ -881,7 +883,8 @@ class TestAudioSearchThemeSupport:
def test_explicit_cdg_txt_overrides_theme_default(self):
"""Test that explicit enable_cdg/enable_txt values override theme defaults."""
from backend.api.routes.audio_search import AudioSearchRequest, _resolve_cdg_txt_defaults
from backend.api.routes.audio_search import AudioSearchRequest
from backend.services.job_defaults_service import resolve_cdg_txt_defaults
# Theme set (would default to True), but explicitly disabled
request = AudioSearchRequest(
@@ -892,7 +895,7 @@ class TestAudioSearchThemeSupport:
enable_txt=False,
)
resolved_cdg, resolved_txt = _resolve_cdg_txt_defaults(
resolved_cdg, resolved_txt = resolve_cdg_txt_defaults(
request.theme_id, request.enable_cdg, request.enable_txt
)
@@ -901,7 +904,8 @@ class TestAudioSearchThemeSupport:
def test_explicit_cdg_txt_enables_without_theme(self):
"""Test that explicit True enables CDG/TXT even without theme."""
from backend.api.routes.audio_search import AudioSearchRequest, _resolve_cdg_txt_defaults
from backend.api.routes.audio_search import AudioSearchRequest
from backend.services.job_defaults_service import resolve_cdg_txt_defaults
# No theme (would default to False), but explicitly enabled
request = AudioSearchRequest(
@@ -911,7 +915,7 @@ class TestAudioSearchThemeSupport:
enable_txt=True,
)
resolved_cdg, resolved_txt = _resolve_cdg_txt_defaults(
resolved_cdg, resolved_txt = resolve_cdg_txt_defaults(
request.theme_id, request.enable_cdg, request.enable_txt
)
+233
View File
@@ -490,3 +490,236 @@ class TestCCFunctionality:
# Verify add_cc was called
mock_mail.add_cc.assert_called()
class TestMadeForYouOrderConfirmation:
"""Tests for send_made_for_you_order_confirmation method."""
def test_send_order_confirmation_success(self):
"""Test successful order confirmation email."""
service = EmailService()
service.provider = Mock()
service.provider.send_email.return_value = True
result = service.send_made_for_you_order_confirmation(
to_email="customer@example.com",
artist="Test Artist",
title="Test Song",
job_id="test-job-123",
)
assert result is True
service.provider.send_email.assert_called_once()
# Verify BCC is set
call_kwargs = service.provider.send_email.call_args.kwargs
assert call_kwargs.get('bcc_emails') == ["done@nomadkaraoke.com"]
def test_send_order_confirmation_subject_format(self):
"""Test order confirmation has correct subject format."""
service = EmailService()
service.provider = Mock()
service.provider.send_email.return_value = True
service.send_made_for_you_order_confirmation(
to_email="customer@example.com",
artist="Seether",
title="Tonight",
job_id="test-job-456",
)
call_kwargs = service.provider.send_email.call_args.kwargs
subject = call_kwargs.get('subject')
assert "Order Confirmed" in subject
assert "Seether" in subject
assert "Tonight" in subject
def test_send_order_confirmation_with_notes(self):
"""Test order confirmation includes notes."""
service = EmailService()
service.provider = Mock()
service.provider.send_email.return_value = True
service.send_made_for_you_order_confirmation(
to_email="customer@example.com",
artist="Test Artist",
title="Test Song",
job_id="test-job-789",
notes="Wedding anniversary!",
)
call_kwargs = service.provider.send_email.call_args.kwargs
html_content = call_kwargs.get('html_content')
assert "Wedding anniversary!" in html_content
def test_send_order_confirmation_includes_delivery_promise(self):
"""Test order confirmation mentions delivery timeframe."""
service = EmailService()
service.provider = Mock()
service.provider.send_email.return_value = True
service.send_made_for_you_order_confirmation(
to_email="customer@example.com",
artist="Test Artist",
title="Test Song",
job_id="test-job-abc",
)
call_kwargs = service.provider.send_email.call_args.kwargs
html_content = call_kwargs.get('html_content', '')
text_content = call_kwargs.get('text_content', '')
# Should mention delivery timeline
assert "24" in html_content or "24" in text_content
def test_send_order_confirmation_failure(self):
"""Test handling of email send failure."""
service = EmailService()
service.provider = Mock()
service.provider.send_email.return_value = False
result = service.send_made_for_you_order_confirmation(
to_email="customer@example.com",
artist="Test Artist",
title="Test Song",
job_id="test-job-def",
)
assert result is False
class TestMadeForYouAdminNotification:
"""Tests for send_made_for_you_admin_notification method."""
def test_send_admin_notification_success(self):
"""Test successful admin notification email."""
service = EmailService()
service.provider = Mock()
service.provider.send_email.return_value = True
result = service.send_made_for_you_admin_notification(
to_email="admin@nomadkaraoke.com",
customer_email="customer@example.com",
artist="Test Artist",
title="Test Song",
job_id="job-123",
admin_login_token="test-token-abc",
)
assert result is True
service.provider.send_email.assert_called_once()
def test_send_admin_notification_subject_format(self):
"""Test admin notification has correct subject format."""
service = EmailService()
service.provider = Mock()
service.provider.send_email.return_value = True
service.send_made_for_you_admin_notification(
to_email="admin@nomadkaraoke.com",
customer_email="customer@example.com",
artist="Seether",
title="Tonight",
job_id="job-123",
admin_login_token="test-token-abc",
)
call_kwargs = service.provider.send_email.call_args.kwargs
subject = call_kwargs.get('subject')
# Subject format: "Karaoke Order: {artist} - {title} [ID: {job_id}]"
assert "Karaoke Order" in subject
assert "Seether" in subject
assert "Tonight" in subject
def test_send_admin_notification_includes_customer_email(self):
"""Test admin notification includes customer email."""
service = EmailService()
service.provider = Mock()
service.provider.send_email.return_value = True
service.send_made_for_you_admin_notification(
to_email="admin@nomadkaraoke.com",
customer_email="vip@example.com",
artist="Test Artist",
title="Test Song",
job_id="job-123",
admin_login_token="test-token-abc",
)
call_kwargs = service.provider.send_email.call_args.kwargs
html_content = call_kwargs.get('html_content')
assert "vip@example.com" in html_content
def test_send_admin_notification_includes_job_link(self):
"""Test admin notification includes job link."""
service = EmailService()
service.provider = Mock()
service.provider.send_email.return_value = True
service.send_made_for_you_admin_notification(
to_email="admin@nomadkaraoke.com",
customer_email="customer@example.com",
artist="Test Artist",
title="Test Song",
job_id="abc-def-123",
admin_login_token="test-token-abc",
)
call_kwargs = service.provider.send_email.call_args.kwargs
html_content = call_kwargs.get('html_content')
assert "abc-def-123" in html_content
def test_send_admin_notification_includes_audio_count(self):
"""Test admin notification includes audio source count."""
service = EmailService()
service.provider = Mock()
service.provider.send_email.return_value = True
service.send_made_for_you_admin_notification(
to_email="admin@nomadkaraoke.com",
customer_email="customer@example.com",
artist="Test Artist",
title="Test Song",
job_id="job-123",
admin_login_token="test-token-abc",
audio_source_count=5,
)
call_kwargs = service.provider.send_email.call_args.kwargs
html_content = call_kwargs.get('html_content')
assert "5" in html_content
def test_send_admin_notification_includes_notes(self):
"""Test admin notification includes customer notes."""
service = EmailService()
service.provider = Mock()
service.provider.send_email.return_value = True
service.send_made_for_you_admin_notification(
to_email="admin@nomadkaraoke.com",
customer_email="customer@example.com",
artist="Test Artist",
title="Test Song",
job_id="job-123",
admin_login_token="test-token-abc",
notes="Rush order please!",
)
call_kwargs = service.provider.send_email.call_args.kwargs
html_content = call_kwargs.get('html_content')
assert "Rush order please!" in html_content
def test_send_admin_notification_failure(self):
"""Test handling of email send failure."""
service = EmailService()
service.provider = Mock()
service.provider.send_email.return_value = False
result = service.send_made_for_you_admin_notification(
to_email="admin@nomadkaraoke.com",
customer_email="customer@example.com",
artist="Test Artist",
title="Test Song",
job_id="job-123",
admin_login_token="test-token-abc",
)
assert result is False
@@ -0,0 +1,298 @@
"""
Unit tests for EmailValidationService.
Tests email normalization, disposable domain detection, and blocklist management.
"""
import pytest
from unittest.mock import Mock, MagicMock, patch
# Mock Google Cloud before imports
import sys
sys.modules['google.cloud.firestore'] = MagicMock()
sys.modules['google.cloud.storage'] = MagicMock()
class TestEmailNormalization:
"""Test email normalization logic."""
@pytest.fixture
def mock_db(self):
"""Create a mock Firestore client."""
mock = MagicMock()
# Default: empty blocklist config
mock_doc = Mock()
mock_doc.exists = False
mock.collection.return_value.document.return_value.get.return_value = mock_doc
return mock
@pytest.fixture
def email_service(self, mock_db):
"""Create EmailValidationService instance with mocks."""
from backend.services.email_validation_service import EmailValidationService
service = EmailValidationService(db=mock_db)
return service
# =========================================================================
# Gmail Normalization Tests
# =========================================================================
def test_normalize_gmail_removes_dots(self, email_service):
"""Test that dots are removed from Gmail local part."""
result = email_service.normalize_email("j.o.h.n@gmail.com")
assert result == "john@gmail.com"
def test_normalize_gmail_removes_plus_suffix(self, email_service):
"""Test that +tag is removed from Gmail local part."""
result = email_service.normalize_email("john+spam@gmail.com")
assert result == "john@gmail.com"
def test_normalize_gmail_removes_dots_and_plus(self, email_service):
"""Test both dots and +tag are removed from Gmail."""
result = email_service.normalize_email("j.o.h.n+newsletter@gmail.com")
assert result == "john@gmail.com"
def test_normalize_googlemail_treated_like_gmail(self, email_service):
"""Test that googlemail.com is normalized like gmail.com."""
result = email_service.normalize_email("j.o.h.n+test@googlemail.com")
assert result == "john@googlemail.com"
def test_normalize_gmail_to_lowercase(self, email_service):
"""Test Gmail addresses are lowercased."""
result = email_service.normalize_email("JOHN.DOE+Test@GMAIL.COM")
assert result == "johndoe@gmail.com"
# =========================================================================
# Non-Gmail Normalization Tests
# =========================================================================
def test_normalize_non_gmail_preserves_dots(self, email_service):
"""Test dots are preserved for non-Gmail domains."""
result = email_service.normalize_email("j.o.h.n@example.com")
assert result == "j.o.h.n@example.com"
def test_normalize_non_gmail_preserves_plus(self, email_service):
"""Test +tag is preserved for non-Gmail domains."""
result = email_service.normalize_email("john+tag@company.com")
assert result == "john+tag@company.com"
def test_normalize_non_gmail_to_lowercase(self, email_service):
"""Test non-Gmail addresses are lowercased."""
result = email_service.normalize_email("John.Doe@Example.Com")
assert result == "john.doe@example.com"
def test_normalize_strips_whitespace(self, email_service):
"""Test whitespace is stripped."""
result = email_service.normalize_email(" john@example.com ")
assert result == "john@example.com"
# =========================================================================
# Edge Cases
# =========================================================================
def test_normalize_empty_string(self, email_service):
"""Test empty string returns empty."""
result = email_service.normalize_email("")
assert result == ""
def test_normalize_none_returns_empty(self, email_service):
"""Test None returns empty string."""
result = email_service.normalize_email(None)
assert result == ""
def test_normalize_invalid_no_at_sign(self, email_service):
"""Test email without @ is returned as-is (lowercase)."""
result = email_service.normalize_email("notanemail")
assert result == "notanemail"
class TestDisposableDomainDetection:
"""Test disposable domain detection."""
@pytest.fixture
def mock_db(self):
"""Create a mock Firestore client."""
mock = MagicMock()
mock_doc = Mock()
mock_doc.exists = False
mock.collection.return_value.document.return_value.get.return_value = mock_doc
return mock
@pytest.fixture
def email_service(self, mock_db):
"""Create EmailValidationService instance with mocks."""
from backend.services.email_validation_service import EmailValidationService
# Clear any cached blocklist
EmailValidationService._blocklist_cache = None
EmailValidationService._blocklist_cache_time = None
service = EmailValidationService(db=mock_db)
return service
def test_detect_known_disposable_domain(self, email_service):
"""Test known disposable domains are detected."""
# These are in DEFAULT_DISPOSABLE_DOMAINS
assert email_service.is_disposable_domain("user@tempmail.com") is True
assert email_service.is_disposable_domain("user@mailinator.com") is True
assert email_service.is_disposable_domain("user@guerrillamail.com") is True
def test_detect_legitimate_domain(self, email_service):
"""Test legitimate domains are not flagged."""
assert email_service.is_disposable_domain("user@gmail.com") is False
assert email_service.is_disposable_domain("user@yahoo.com") is False
assert email_service.is_disposable_domain("user@company.com") is False
def test_detect_case_insensitive(self, email_service):
"""Test domain detection is case-insensitive."""
assert email_service.is_disposable_domain("user@TEMPMAIL.COM") is True
assert email_service.is_disposable_domain("user@TempMail.Com") is True
def test_detect_invalid_email_returns_false(self, email_service):
"""Test invalid email returns False."""
assert email_service.is_disposable_domain("notanemail") is False
assert email_service.is_disposable_domain("") is False
class TestBlocklistManagement:
"""Test blocklist management functionality."""
@pytest.fixture
def mock_db(self):
"""Create a mock Firestore client with blocklist."""
mock = MagicMock()
mock_doc = Mock()
mock_doc.exists = True
mock_doc.to_dict.return_value = {
"disposable_domains": ["custom-temp.com"],
"blocked_emails": ["spammer@example.com"],
"blocked_ips": ["192.168.1.100"],
}
mock.collection.return_value.document.return_value.get.return_value = mock_doc
return mock
@pytest.fixture
def email_service(self, mock_db):
"""Create EmailValidationService instance with mocks."""
from backend.services.email_validation_service import EmailValidationService
# Clear any cached blocklist
EmailValidationService._blocklist_cache = None
EmailValidationService._blocklist_cache_time = None
service = EmailValidationService(db=mock_db)
return service
def test_is_email_blocked(self, email_service):
"""Test blocked email detection."""
assert email_service.is_email_blocked("spammer@example.com") is True
assert email_service.is_email_blocked("legitimate@example.com") is False
def test_is_email_blocked_case_insensitive(self, email_service):
"""Test blocked email detection is case-insensitive."""
assert email_service.is_email_blocked("SPAMMER@example.com") is True
assert email_service.is_email_blocked("Spammer@Example.Com") is True
def test_is_ip_blocked(self, email_service):
"""Test blocked IP detection."""
assert email_service.is_ip_blocked("192.168.1.100") is True
assert email_service.is_ip_blocked("10.0.0.1") is False
def test_custom_disposable_domain_added(self, email_service):
"""Test custom disposable domains from Firestore are included."""
assert email_service.is_disposable_domain("user@custom-temp.com") is True
def test_blocklist_caching(self, email_service, mock_db):
"""Test blocklist is cached."""
# First call
email_service.is_disposable_domain("user@test.com")
# Second call should use cache
email_service.is_disposable_domain("user@test2.com")
# Should only call Firestore once due to caching
assert mock_db.collection.return_value.document.return_value.get.call_count == 1
class TestBetaEnrollmentValidation:
"""Test beta enrollment validation."""
@pytest.fixture
def mock_db(self):
"""Create a mock Firestore client."""
mock = MagicMock()
mock_doc = Mock()
mock_doc.exists = True
mock_doc.to_dict.return_value = {
"disposable_domains": [],
"blocked_emails": ["blocked@example.com"],
"blocked_ips": [],
}
mock.collection.return_value.document.return_value.get.return_value = mock_doc
return mock
@pytest.fixture
def email_service(self, mock_db):
"""Create EmailValidationService instance with mocks."""
from backend.services.email_validation_service import EmailValidationService
EmailValidationService._blocklist_cache = None
EmailValidationService._blocklist_cache_time = None
service = EmailValidationService(db=mock_db)
return service
def test_validate_legitimate_email(self, email_service):
"""Test legitimate email passes validation."""
is_valid, error = email_service.validate_email_for_beta("user@gmail.com")
assert is_valid is True
assert error == ""
def test_validate_disposable_email_rejected(self, email_service):
"""Test disposable email is rejected."""
is_valid, error = email_service.validate_email_for_beta("user@tempmail.com")
assert is_valid is False
assert "Disposable email" in error
def test_validate_blocked_email_rejected(self, email_service):
"""Test blocked email is rejected."""
is_valid, error = email_service.validate_email_for_beta("blocked@example.com")
assert is_valid is False
assert "not allowed" in error
def test_validate_invalid_format_rejected(self, email_service):
"""Test invalid email format is rejected."""
is_valid, error = email_service.validate_email_for_beta("notanemail")
assert is_valid is False
assert "Invalid email format" in error
def test_validate_empty_email_rejected(self, email_service):
"""Test empty email is rejected."""
is_valid, error = email_service.validate_email_for_beta("")
assert is_valid is False
class TestIPHashing:
"""Test IP address hashing."""
@pytest.fixture
def email_service(self):
"""Create EmailValidationService instance with mocks."""
mock_db = MagicMock()
mock_doc = Mock()
mock_doc.exists = False
mock_db.collection.return_value.document.return_value.get.return_value = mock_doc
from backend.services.email_validation_service import EmailValidationService
return EmailValidationService(db=mock_db)
def test_hash_ip_consistent(self, email_service):
"""Test IP hashing produces consistent results."""
hash1 = email_service.hash_ip("192.168.1.1")
hash2 = email_service.hash_ip("192.168.1.1")
assert hash1 == hash2
def test_hash_ip_different_for_different_ips(self, email_service):
"""Test different IPs produce different hashes."""
hash1 = email_service.hash_ip("192.168.1.1")
hash2 = email_service.hash_ip("192.168.1.2")
assert hash1 != hash2
def test_hash_ip_is_sha256(self, email_service):
"""Test IP hash is SHA-256 (64 hex chars)."""
hash_result = email_service.hash_ip("192.168.1.1")
assert len(hash_result) == 64
assert all(c in "0123456789abcdef" for c in hash_result)
+8 -6
View File
@@ -1681,17 +1681,19 @@ class TestUploadEndpointThemeSupport:
)
def test_upload_endpoint_uses_resolve_cdg_txt_defaults(self):
"""Verify the upload endpoint uses _resolve_cdg_txt_defaults for theme-based defaults."""
"""Verify the upload endpoint uses resolve_cdg_txt_defaults for theme-based defaults."""
import inspect
from backend.api.routes import file_upload as file_upload_module
with open(file_upload_module.__file__, 'r') as f:
source_code = f.read()
source_code = inspect.getsource(file_upload_module)
has_resolve_call = '_resolve_cdg_txt_defaults(' in source_code
# Check for the centralized resolve_cdg_txt_defaults function (imported from job_defaults_service)
has_resolve_call = 'resolve_cdg_txt_defaults(' in source_code
assert has_resolve_call, (
"file_upload.py does not call _resolve_cdg_txt_defaults(). "
"When theme_id is set, enable_cdg and enable_txt should default to True."
"file_upload.py does not call resolve_cdg_txt_defaults(). "
"Theme-driven CDG/TXT defaults (controlled by DEFAULT_ENABLE_CDG/DEFAULT_ENABLE_TXT "
"settings) must be applied via the centralized job_defaults_service."
)
def test_upload_endpoint_has_optional_cdg_txt_params(self):
+229
View File
@@ -0,0 +1,229 @@
"""
Tests for GCE Encoding Worker (gce_encoding/main.py).
These tests verify the file-finding logic in the GCE encoding worker,
particularly ensuring that instrumental selection is respected.
NOTE: This test file is self-contained and doesn't import the full app
to avoid dependency issues in CI/CD environments.
"""
import pytest
from pathlib import Path
# Copy the find_file function here to test it in isolation
# This avoids importing the full gce_encoding module which has GCS dependencies
def find_file(work_dir: Path, *patterns):
'''Find a file matching any of the given glob patterns.'''
for pattern in patterns:
matches = list(work_dir.glob(f"**/{pattern}"))
if matches:
return matches[0]
return None
class TestFindFile:
"""Test the find_file function used to locate input files."""
def test_find_file_single_match(self, tmp_path):
"""Test finding a file with a single match."""
# Create test file
test_file = tmp_path / "test_instrumental.flac"
test_file.touch()
result = find_file(tmp_path, "*instrumental*.flac")
assert result is not None
assert result.name == "test_instrumental.flac"
def test_find_file_no_match(self, tmp_path):
"""Test finding a file with no matches returns None."""
result = find_file(tmp_path, "*nonexistent*.flac")
assert result is None
def test_find_file_priority_order(self, tmp_path):
"""Test that find_file returns first matching pattern."""
# Create multiple files that match different patterns
first = tmp_path / "first_pattern.flac"
second = tmp_path / "second_pattern.flac"
first.touch()
second.touch()
# First pattern should win
result = find_file(tmp_path, "*first*.flac", "*second*.flac")
assert result.name == "first_pattern.flac"
class TestInstrumentalSelection:
"""Test that instrumental selection is properly respected."""
def test_clean_instrumental_prioritized_when_selected(self, tmp_path):
"""Test that clean instrumental is found when 'clean' is selected.
When both instrumentals exist and 'clean' is selected,
the clean version should be found.
"""
# Create both instrumental files (as they exist in GCS)
clean = tmp_path / "Artist - Title (Instrumental Clean).flac"
backing = tmp_path / "Artist - Title (Instrumental Backing).flac"
clean.touch()
backing.touch()
# Simulate finding instrumental with 'clean' selection
# (mimics the logic in run_encoding when instrumental_selection == 'clean')
result = find_file(
tmp_path,
"*instrumental_clean*.flac", "*Instrumental Clean*.flac",
"*instrumental*.flac", "*Instrumental*.flac",
"*instrumental*.wav"
)
assert result is not None
assert "Clean" in result.name
def test_backing_instrumental_prioritized_when_selected(self, tmp_path):
"""Test that backing instrumental is found when 'with_backing' is selected.
When both instrumentals exist and 'with_backing' is selected,
the backing version should be found.
This test would have caught the bug where the GCE worker always
used the clean instrumental regardless of user selection.
"""
# Create both instrumental files (as they exist in GCS)
clean = tmp_path / "Artist - Title (Instrumental Clean).flac"
backing = tmp_path / "Artist - Title (Instrumental Backing).flac"
clean.touch()
backing.touch()
# Simulate finding instrumental with 'with_backing' selection
# (mimics the logic in run_encoding when instrumental_selection == 'with_backing')
result = find_file(
tmp_path,
"*instrumental_with_backing*.flac", "*Instrumental Backing*.flac",
"*with_backing*.flac", "*Backing*.flac",
"*instrumental*.flac", "*Instrumental*.flac",
"*instrumental*.wav"
)
assert result is not None
assert "Backing" in result.name
def test_backing_instrumental_with_stem_naming(self, tmp_path):
"""Test finding backing instrumental with GCS stem naming convention.
In GCS, stems are named like 'stems/instrumental_with_backing.flac'
"""
stems_dir = tmp_path / "stems"
stems_dir.mkdir()
clean = stems_dir / "instrumental_clean.flac"
backing = stems_dir / "instrumental_with_backing.flac"
clean.touch()
backing.touch()
# Simulate finding instrumental with 'with_backing' selection
result = find_file(
tmp_path,
"*instrumental_with_backing*.flac", "*Instrumental Backing*.flac",
"*with_backing*.flac", "*Backing*.flac",
"*instrumental*.flac", "*Instrumental*.flac",
"*instrumental*.wav"
)
assert result is not None
assert "with_backing" in result.name
def test_fallback_to_generic_when_specific_not_found(self, tmp_path):
"""Test fallback to generic pattern when specific not found."""
# Only create a generically named instrumental
generic = tmp_path / "instrumental.flac"
generic.touch()
# Both clean and backing selections should fall back
for selection in ["clean", "with_backing"]:
if selection == "with_backing":
patterns = (
"*instrumental_with_backing*.flac", "*Instrumental Backing*.flac",
"*with_backing*.flac", "*Backing*.flac",
"*instrumental*.flac", "*Instrumental*.flac",
"*instrumental*.wav"
)
else:
patterns = (
"*instrumental_clean*.flac", "*Instrumental Clean*.flac",
"*instrumental*.flac", "*Instrumental*.flac",
"*instrumental*.wav"
)
result = find_file(tmp_path, *patterns)
assert result is not None
assert result.name == "instrumental.flac"
class TestInstrumentalSelectionRegression:
"""Regression tests for instrumental selection bug.
Bug: User selected 'with_backing' instrumental in the UI but the final
video used the clean instrumental instead.
Root cause: The GCE worker's find_file() always prioritized
'*instrumental_clean*' patterns before generic patterns, ignoring
the user's selection.
"""
def test_bug_scenario_both_instrumentals_present(self, tmp_path):
"""Recreate the exact bug scenario where both instrumentals exist.
This is the key regression test. When both instrumentals are downloaded
from GCS (which happens with the GCE worker), the correct one must
be selected based on the user's choice.
"""
# Setup: Both instrumentals in stems/ (as downloaded from GCS)
stems = tmp_path / "stems"
stems.mkdir()
(stems / "instrumental_clean.flac").touch()
(stems / "instrumental_with_backing.flac").touch()
# Also have properly named versions in the root (from _setup_working_directory)
(tmp_path / "Artist - Song (Instrumental Clean).flac").touch()
(tmp_path / "Artist - Song (Instrumental Backing).flac").touch()
# When user selected 'with_backing', the backing version MUST be found
backing_patterns = (
"*instrumental_with_backing*.flac", "*Instrumental Backing*.flac",
"*with_backing*.flac", "*Backing*.flac",
"*instrumental*.flac", "*Instrumental*.flac",
"*instrumental*.wav"
)
result = find_file(tmp_path, *backing_patterns)
assert result is not None
# Must find a backing-related file, not the clean one
name = result.name.lower()
assert "backing" in name or "with_backing" in name, \
f"Expected backing instrumental but found: {result.name}"
def test_clean_selection_still_works(self, tmp_path):
"""Verify clean selection still works correctly after the fix."""
stems = tmp_path / "stems"
stems.mkdir()
(stems / "instrumental_clean.flac").touch()
(stems / "instrumental_with_backing.flac").touch()
(tmp_path / "Artist - Song (Instrumental Clean).flac").touch()
(tmp_path / "Artist - Song (Instrumental Backing).flac").touch()
# When user selected 'clean', the clean version must be found
clean_patterns = (
"*instrumental_clean*.flac", "*Instrumental Clean*.flac",
"*instrumental*.flac", "*Instrumental*.flac",
"*instrumental*.wav"
)
result = find_file(tmp_path, *clean_patterns)
assert result is not None
name = result.name.lower()
assert "clean" in name, f"Expected clean instrumental but found: {result.name}"
+223
View File
@@ -0,0 +1,223 @@
"""
Unit tests for user impersonation endpoint.
Tests the admin impersonation API that allows admins to view the app as other users.
"""
import pytest
from unittest.mock import Mock, patch
from fastapi.testclient import TestClient
from fastapi import FastAPI
from backend.api.routes.admin import router
from backend.api.dependencies import require_admin
from backend.services.user_service import get_user_service
from backend.models.user import User, Session
# Create a test app with the admin router
app = FastAPI()
app.include_router(router, prefix="/api")
def get_mock_admin():
"""Override for require_admin dependency - returns admin user."""
return ("admin@nomadkaraoke.com", "admin", 1)
def get_mock_regular_user():
"""Override for require_admin dependency - returns regular user (should fail)."""
# This simulates what happens when a non-admin tries to access
# In reality, require_admin raises 403, but we test the logic
return ("user@example.com", "user", 0)
@pytest.fixture
def client():
"""Create a test client with admin access."""
app.dependency_overrides[require_admin] = get_mock_admin
yield TestClient(app)
app.dependency_overrides.clear()
@pytest.fixture
def mock_user_service():
"""Create a mock user service."""
service = Mock()
return service
@pytest.fixture
def mock_target_user():
"""Create a mock target user to impersonate."""
user = Mock(spec=User)
user.email = "target@example.com"
user.credits = 5
user.role = "user"
user.is_active = True
return user
@pytest.fixture
def mock_session():
"""Create a mock session."""
session = Mock(spec=Session)
session.token = "test-session-token-12345678901234567890"
session.user_email = "target@example.com"
return session
class TestImpersonateUser:
"""Tests for POST /api/admin/users/{email}/impersonate endpoint."""
def test_admin_can_impersonate_user(self, client, mock_target_user, mock_session):
"""Admin gets session token for target user."""
with patch('backend.api.routes.admin.get_user_service') as mock_get_service:
mock_service = Mock()
mock_service.get_user.return_value = mock_target_user
mock_service.create_session.return_value = mock_session
mock_get_service.return_value = mock_service
# Override the dependency
app.dependency_overrides[get_user_service] = lambda: mock_service
response = client.post(
"/api/admin/users/target@example.com/impersonate",
headers={"Authorization": "Bearer admin-token"}
)
assert response.status_code == 200
data = response.json()
assert data["session_token"] == mock_session.token
assert data["user_email"] == "target@example.com"
assert "impersonating" in data["message"].lower()
# Verify user lookup was called
mock_service.get_user.assert_called_once_with("target@example.com")
# Verify session was created for target user
mock_service.create_session.assert_called_once()
call_args = mock_service.create_session.call_args
assert call_args.kwargs["user_email"] == "target@example.com"
assert "Impersonation by admin@nomadkaraoke.com" in call_args.kwargs["user_agent"]
def test_impersonate_nonexistent_user_returns_404(self, client):
"""Target user must exist."""
with patch('backend.api.routes.admin.get_user_service') as mock_get_service:
mock_service = Mock()
mock_service.get_user.return_value = None # User not found
mock_get_service.return_value = mock_service
app.dependency_overrides[get_user_service] = lambda: mock_service
response = client.post(
"/api/admin/users/nonexistent@example.com/impersonate",
headers={"Authorization": "Bearer admin-token"}
)
assert response.status_code == 404
assert "not found" in response.json()["detail"].lower()
def test_cannot_impersonate_self(self, client, mock_target_user):
"""Admin cannot impersonate themselves."""
with patch('backend.api.routes.admin.get_user_service') as mock_get_service:
mock_service = Mock()
# Set up user to be found (same as admin)
mock_target_user.email = "admin@nomadkaraoke.com"
mock_service.get_user.return_value = mock_target_user
mock_get_service.return_value = mock_service
app.dependency_overrides[get_user_service] = lambda: mock_service
response = client.post(
"/api/admin/users/admin@nomadkaraoke.com/impersonate",
headers={"Authorization": "Bearer admin-token"}
)
assert response.status_code == 400
assert "yourself" in response.json()["detail"].lower()
def test_impersonation_creates_valid_session(self, client, mock_target_user, mock_session):
"""Returned token is a valid session for target user."""
with patch('backend.api.routes.admin.get_user_service') as mock_get_service:
mock_service = Mock()
mock_service.get_user.return_value = mock_target_user
mock_service.create_session.return_value = mock_session
mock_get_service.return_value = mock_service
app.dependency_overrides[get_user_service] = lambda: mock_service
response = client.post(
"/api/admin/users/target@example.com/impersonate",
headers={"Authorization": "Bearer admin-token"}
)
assert response.status_code == 200
# Verify create_session was called with correct user
mock_service.create_session.assert_called_once()
call_kwargs = mock_service.create_session.call_args.kwargs
assert call_kwargs["user_email"] == "target@example.com"
def test_impersonation_logs_audit_trail(self, client, mock_target_user, mock_session):
"""Impersonation is logged for security audit."""
with patch('backend.api.routes.admin.get_user_service') as mock_get_service, \
patch('backend.api.routes.admin.logger') as mock_logger:
mock_service = Mock()
mock_service.get_user.return_value = mock_target_user
mock_service.create_session.return_value = mock_session
mock_get_service.return_value = mock_service
app.dependency_overrides[get_user_service] = lambda: mock_service
response = client.post(
"/api/admin/users/target@example.com/impersonate",
headers={"Authorization": "Bearer admin-token"}
)
assert response.status_code == 200
# Verify logging was called with impersonation info
mock_logger.info.assert_called()
log_message = mock_logger.info.call_args[0][0]
assert "IMPERSONATION" in log_message
assert "admin@nomadkaraoke.com" in log_message
assert "target@example.com" in log_message
def test_email_is_normalized_to_lowercase(self, client, mock_target_user, mock_session):
"""Email addresses are normalized to lowercase."""
with patch('backend.api.routes.admin.get_user_service') as mock_get_service:
mock_service = Mock()
mock_service.get_user.return_value = mock_target_user
mock_service.create_session.return_value = mock_session
mock_get_service.return_value = mock_service
app.dependency_overrides[get_user_service] = lambda: mock_service
response = client.post(
"/api/admin/users/TARGET@EXAMPLE.COM/impersonate",
headers={"Authorization": "Bearer admin-token"}
)
assert response.status_code == 200
# Verify user lookup was with lowercase
mock_service.get_user.assert_called_once_with("target@example.com")
class TestImpersonateUserNonAdmin:
"""Tests to verify non-admins cannot impersonate."""
def test_non_admin_cannot_impersonate(self):
"""
Regular user gets 403 Forbidden.
Note: This is enforced by the require_admin dependency at the route level.
We test that the dependency is correctly applied.
"""
# Create a fresh client without admin override
test_app = FastAPI()
test_app.include_router(router, prefix="/api")
# Don't override require_admin - it should reject non-admin requests
# In a real test, we'd mock the auth service to return a non-admin user
# For now, we just verify the endpoint requires admin via dependency
# The require_admin dependency will reject requests without proper admin auth
# This is tested implicitly by the fact that all other tests use admin override
pass # Actual enforcement tested via integration tests
@@ -128,6 +128,8 @@ class TestUserEmailExtraction:
mock_request.headers = {}
mock_request.client = Mock(host="127.0.0.1")
mock_request.url = Mock(path="/api/jobs/create-from-url")
# Mock tenant state (no tenant = default Nomad Karaoke)
mock_request.state.tenant_config = None
mock_background_tasks = Mock()
body = CreateJobFromUrlRequest(
@@ -168,6 +170,8 @@ class TestUserEmailExtraction:
mock_request.headers = {}
mock_request.client = Mock(host="127.0.0.1")
mock_request.url = Mock(path="/api/audio-search/search")
# Mock tenant state (no tenant = default Nomad Karaoke)
mock_request.state.tenant_config = None
mock_background_tasks = Mock()
body = AudioSearchRequest(
+146 -1
View File
@@ -313,9 +313,154 @@ class TestJobFailure:
assert call_args[1]['error_message'] == error_message
class TestMadeForYouFieldMapping:
"""
CRITICAL: Test that made-for-you fields are properly copied from JobCreate to Job.
These tests verify that JobManager.create_job() properly maps all fields from
JobCreate to the Job object that gets persisted to Firestore.
Bug context (2026-01-09): Production made-for-you orders were created with
made_for_you=False, customer_email=None, customer_notes=None because
JobManager.create_job() wasn't copying these fields from JobCreate to Job.
"""
def test_create_job_copies_made_for_you_flag(self, job_manager, mock_firestore_service):
"""
CRITICAL: made_for_you flag must be copied from JobCreate to Job.
This flag is essential for:
- Ownership transfer on job completion
- Email suppression for intermediate states
- Identifying made-for-you jobs in admin UI
"""
job_create = JobCreate(
artist="Test Artist",
title="Test Song",
theme_id="nomad",
made_for_you=True, # This MUST be copied to the Job
)
job = job_manager.create_job(job_create)
# CRITICAL ASSERTION: made_for_you must be True on the created Job
assert job.made_for_you is True, \
"made_for_you=True on JobCreate must be copied to Job"
# Also verify what was saved to Firestore
mock_firestore_service.create_job.assert_called_once()
saved_job = mock_firestore_service.create_job.call_args[0][0]
assert saved_job.made_for_you is True, \
"made_for_you=True must be persisted to Firestore"
def test_create_job_copies_customer_email(self, job_manager, mock_firestore_service):
"""
CRITICAL: customer_email must be copied from JobCreate to Job.
This field is essential for:
- Ownership transfer on job completion (transferring to this email)
- Sending completion email with download links to customer
"""
job_create = JobCreate(
artist="Test Artist",
title="Test Song",
theme_id="nomad",
made_for_you=True,
customer_email="customer@example.com", # This MUST be copied to the Job
)
job = job_manager.create_job(job_create)
# CRITICAL ASSERTION: customer_email must be copied
assert job.customer_email == "customer@example.com", \
"customer_email on JobCreate must be copied to Job"
# Also verify what was saved to Firestore
saved_job = mock_firestore_service.create_job.call_args[0][0]
assert saved_job.customer_email == "customer@example.com", \
"customer_email must be persisted to Firestore"
def test_create_job_copies_customer_notes(self, job_manager, mock_firestore_service):
"""
customer_notes must be copied from JobCreate to Job.
Customer notes contain special requests that admin needs to see.
"""
job_create = JobCreate(
artist="Test Artist",
title="Test Song",
theme_id="nomad",
made_for_you=True,
customer_notes="Please make this perfect for my wedding!",
)
job = job_manager.create_job(job_create)
assert job.customer_notes == "Please make this perfect for my wedding!", \
"customer_notes on JobCreate must be copied to Job"
saved_job = mock_firestore_service.create_job.call_args[0][0]
assert saved_job.customer_notes == "Please make this perfect for my wedding!", \
"customer_notes must be persisted to Firestore"
def test_create_job_full_made_for_you_config(self, job_manager, mock_firestore_service):
"""
Test complete made-for-you job creation with all fields.
This is the realistic scenario: a made-for-you order creates a job with:
- made_for_you=True
- user_email=admin (owner during processing)
- customer_email=customer (for final delivery)
- customer_notes=notes (customer's special requests)
"""
job_create = JobCreate(
artist="Avril Lavigne",
title="Complicated",
theme_id="nomad",
made_for_you=True,
user_email="admin@nomadkaraoke.com",
customer_email="customer@example.com",
customer_notes="Anniversary gift!",
# Distribution settings that should also be applied
enable_youtube_upload=True,
dropbox_path="/Production/Ready",
brand_prefix="NOMAD",
)
job = job_manager.create_job(job_create)
# Verify all made-for-you fields
assert job.made_for_you is True
assert job.user_email == "admin@nomadkaraoke.com"
assert job.customer_email == "customer@example.com"
assert job.customer_notes == "Anniversary gift!"
# Verify distribution settings too
assert job.enable_youtube_upload is True
assert job.dropbox_path == "/Production/Ready"
assert job.brand_prefix == "NOMAD"
def test_create_job_made_for_you_false_by_default(self, job_manager, mock_firestore_service):
"""
Regular jobs should have made_for_you=False by default.
"""
job_create = JobCreate(
artist="Test Artist",
title="Test Song",
theme_id="nomad",
# No made_for_you specified - should default to False
)
job = job_manager.create_job(job_create)
assert job.made_for_you is False
assert job.customer_email is None
assert job.customer_notes is None
class TestJobDeletion:
"""Test job deletion logic."""
def test_delete_job(self, job_manager, mock_firestore_service):
"""Test deleting a job."""
existing_job = Job(
File diff suppressed because it is too large. Load diff
+139
View File
@@ -913,6 +913,145 @@ class TestJobWithFullTwoPhaseConfig:
assert "title" in job.file_urls["screens"]
class TestMadeForYouFields:
"""Tests for made-for-you order tracking fields."""
def test_job_has_made_for_you_field(self):
"""Test Job model has made_for_you field with default False."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
)
assert hasattr(job, 'made_for_you')
assert job.made_for_you is False
def test_job_made_for_you_true(self):
"""Test Job model can set made_for_you to True."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
made_for_you=True,
)
assert job.made_for_you is True
def test_job_has_customer_email_field(self):
"""Test Job model has customer_email field with default None."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
)
assert hasattr(job, 'customer_email')
assert job.customer_email is None
def test_job_customer_email_set(self):
"""Test Job model can set customer_email."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
customer_email="customer@example.com",
)
assert job.customer_email == "customer@example.com"
def test_job_has_customer_notes_field(self):
"""Test Job model has customer_notes field with default None."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
)
assert hasattr(job, 'customer_notes')
assert job.customer_notes is None
def test_job_customer_notes_set(self):
"""Test Job model can set customer_notes."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
customer_notes="Please make it extra special!",
)
assert job.customer_notes == "Please make it extra special!"
def test_job_create_has_made_for_you_fields(self):
"""Test JobCreate model has all made-for-you fields."""
job_create = JobCreate(
artist="Test Artist",
title="Test Song",
)
assert hasattr(job_create, 'made_for_you')
assert hasattr(job_create, 'customer_email')
assert hasattr(job_create, 'customer_notes')
assert job_create.made_for_you is False
assert job_create.customer_email is None
assert job_create.customer_notes is None
def test_job_create_with_made_for_you_config(self):
"""Test JobCreate with full made-for-you configuration."""
job_create = JobCreate(
artist="Seether",
title="Tonight",
user_email="admin@nomadkaraoke.com",
made_for_you=True,
customer_email="customer@example.com",
customer_notes="Wedding anniversary!",
)
assert job_create.made_for_you is True
assert job_create.customer_email == "customer@example.com"
assert job_create.customer_notes == "Wedding anniversary!"
assert job_create.user_email == "admin@nomadkaraoke.com"
def test_made_for_you_serialization_roundtrip(self):
"""Test made-for-you fields survive dict serialization."""
job = Job(
job_id="test123",
status=JobStatus.AWAITING_AUDIO_SELECTION,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
made_for_you=True,
customer_email="customer@example.com",
customer_notes="Test notes",
user_email="admin@nomadkaraoke.com",
)
job_dict = job.model_dump()
assert job_dict['made_for_you'] is True
assert job_dict['customer_email'] == "customer@example.com"
assert job_dict['customer_notes'] == "Test notes"
def test_made_for_you_job_with_distribution_settings(self):
"""Test made-for-you job with distribution settings."""
job = Job(
job_id="test123",
status=JobStatus.AWAITING_AUDIO_SELECTION,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
made_for_you=True,
customer_email="customer@example.com",
user_email="admin@nomadkaraoke.com",
enable_youtube_upload=True,
dropbox_path="/Production/Ready To Upload",
gdrive_folder_id="1ABC123",
brand_prefix="NOMAD",
)
assert job.made_for_you is True
assert job.enable_youtube_upload is True
assert job.dropbox_path == "/Production/Ready To Upload"
assert job.gdrive_folder_id == "1ABC123"
assert job.brand_prefix == "NOMAD"
if __name__ == "__main__":
pytest.main([__file__, "-v"])
@@ -0,0 +1,460 @@
"""
Tests for PushNotificationService.
Tests the Web Push notification sending and subscription management.
"""
import pytest
from unittest.mock import Mock, patch, AsyncMock, MagicMock
from datetime import datetime, timezone
from backend.services.push_notification_service import (
PushNotificationService,
get_push_notification_service,
SubscriptionGoneError,
)
@pytest.fixture
def mock_settings():
"""Mock settings with push notifications enabled."""
settings = Mock()
settings.enable_push_notifications = True
settings.max_push_subscriptions_per_user = 5
settings.vapid_subject = "mailto:test@example.com"
settings.get_secret = Mock(side_effect=lambda x: {
"vapid-public-key": "test-public-key",
"vapid-private-key": "test-private-key"
}.get(x))
return settings
@pytest.fixture
def mock_db():
"""Mock Firestore client."""
return Mock()
@pytest.fixture
def push_service(mock_settings, mock_db):
"""Create PushNotificationService with mocked dependencies."""
with patch('backend.services.push_notification_service.get_settings', return_value=mock_settings):
service = PushNotificationService(db=mock_db)
return service
class TestPushNotificationServiceInit:
"""Tests for service initialization and configuration."""
def test_is_enabled_when_configured(self, push_service):
"""Service reports enabled when all config present."""
assert push_service.is_enabled() is True
def test_is_disabled_when_feature_flag_off(self, mock_db):
"""Service reports disabled when feature flag off."""
settings = Mock()
settings.enable_push_notifications = False
settings.get_secret = Mock(return_value="key")
with patch('backend.services.push_notification_service.get_settings', return_value=settings):
service = PushNotificationService(db=mock_db)
assert service.is_enabled() is False
def test_is_disabled_when_vapid_keys_missing(self, mock_db):
"""Service reports disabled when VAPID keys missing."""
settings = Mock()
settings.enable_push_notifications = True
settings.get_secret = Mock(return_value=None)
with patch('backend.services.push_notification_service.get_settings', return_value=settings):
service = PushNotificationService(db=mock_db)
assert service.is_enabled() is False
def test_get_public_key(self, push_service):
"""Service returns public key when enabled."""
assert push_service.get_public_key() == "test-public-key"
def test_get_public_key_returns_none_when_disabled(self, mock_db):
"""Service returns None for public key when disabled."""
settings = Mock()
settings.enable_push_notifications = False
settings.get_secret = Mock(return_value="key")
with patch('backend.services.push_notification_service.get_settings', return_value=settings):
service = PushNotificationService(db=mock_db)
assert service.get_public_key() is None
class TestSendPush:
"""Tests for sending push notifications."""
@pytest.mark.asyncio
async def test_send_push_skips_when_disabled(self, mock_db):
"""send_push returns 0 when push notifications disabled."""
settings = Mock()
settings.enable_push_notifications = False
settings.get_secret = Mock(return_value=None)
with patch('backend.services.push_notification_service.get_settings', return_value=settings):
service = PushNotificationService(db=mock_db)
result = await service.send_push("test@example.com", "Title", "Body")
assert result == 0
@pytest.mark.asyncio
async def test_send_push_no_user(self, push_service):
"""send_push returns 0 when user not found."""
# Mock user not existing
push_service.db.collection.return_value.document.return_value.get.return_value.exists = False
result = await push_service.send_push("unknown@example.com", "Title", "Body")
assert result == 0
@pytest.mark.asyncio
async def test_send_push_no_subscriptions(self, push_service):
"""send_push returns 0 when user has no subscriptions."""
# Mock user with no subscriptions
mock_doc = Mock()
mock_doc.exists = True
mock_doc.to_dict.return_value = {"push_subscriptions": []}
push_service.db.collection.return_value.document.return_value.get.return_value = mock_doc
result = await push_service.send_push("test@example.com", "Title", "Body")
assert result == 0
@pytest.mark.asyncio
async def test_send_push_success(self, push_service):
"""send_push successfully sends to subscription."""
# Mock user with subscription
mock_doc = Mock()
mock_doc.exists = True
mock_doc.to_dict.return_value = {
"push_subscriptions": [{
"endpoint": "https://push.example.com/endpoint",
"keys": {"p256dh": "key1", "auth": "key2"},
"device_name": "Test Device"
}]
}
push_service.db.collection.return_value.document.return_value.get.return_value = mock_doc
with patch('backend.services.push_notification_service.webpush') as mock_webpush:
result = await push_service.send_push("test@example.com", "Title", "Body")
assert result == 1
mock_webpush.assert_called_once()
call_args = mock_webpush.call_args
assert call_args[1]["subscription_info"]["endpoint"] == "https://push.example.com/endpoint"
@pytest.mark.asyncio
async def test_send_push_removes_gone_subscription(self, push_service):
"""send_push removes subscription when 410 Gone returned."""
from pywebpush import WebPushException
# Mock user with subscription
mock_doc = Mock()
mock_doc.exists = True
mock_doc.to_dict.return_value = {
"push_subscriptions": [{
"endpoint": "https://push.example.com/endpoint",
"keys": {"p256dh": "key1", "auth": "key2"},
"device_name": "Test Device"
}]
}
push_service.db.collection.return_value.document.return_value.get.return_value = mock_doc
# Mock webpush to raise 410 error
mock_response = Mock()
mock_response.status_code = 410
error = WebPushException("Gone", response=mock_response)
with patch('backend.services.push_notification_service.webpush', side_effect=error):
result = await push_service.send_push("test@example.com", "Title", "Body")
assert result == 0
# Verify invalid subscription was cleaned up
push_service.db.collection.return_value.document.return_value.update.assert_called()
class TestSubscriptionManagement:
"""Tests for adding, removing, and listing subscriptions."""
@pytest.mark.asyncio
async def test_add_subscription_new_user(self, push_service):
"""add_subscription returns False for non-existent user."""
push_service.db.collection.return_value.document.return_value.get.return_value.exists = False
result = await push_service.add_subscription(
"unknown@example.com",
"https://push.example.com/endpoint",
{"p256dh": "key1", "auth": "key2"},
"Test Device"
)
assert result is False
@pytest.mark.asyncio
async def test_add_subscription_success(self, push_service):
"""add_subscription adds new subscription."""
mock_doc = Mock()
mock_doc.exists = True
mock_doc.to_dict.return_value = {"push_subscriptions": []}
push_service.db.collection.return_value.document.return_value.get.return_value = mock_doc
result = await push_service.add_subscription(
"test@example.com",
"https://push.example.com/endpoint",
{"p256dh": "key1", "auth": "key2"},
"Test Device"
)
assert result is True
push_service.db.collection.return_value.document.return_value.update.assert_called_once()
@pytest.mark.asyncio
async def test_add_subscription_updates_existing(self, push_service):
"""add_subscription updates existing subscription with same endpoint."""
mock_doc = Mock()
mock_doc.exists = True
mock_doc.to_dict.return_value = {
"push_subscriptions": [{
"endpoint": "https://push.example.com/endpoint",
"keys": {"p256dh": "old-key", "auth": "old-auth"},
"device_name": "Old Device"
}]
}
push_service.db.collection.return_value.document.return_value.get.return_value = mock_doc
result = await push_service.add_subscription(
"test@example.com",
"https://push.example.com/endpoint",
{"p256dh": "new-key", "auth": "new-auth"},
"New Device"
)
assert result is True
# Verify update was called (subscription replaced, not added)
update_call = push_service.db.collection.return_value.document.return_value.update.call_args
subs = update_call[0][0]["push_subscriptions"]
assert len(subs) == 1
assert subs[0]["device_name"] == "New Device"
@pytest.mark.asyncio
async def test_add_subscription_enforces_max_limit(self, push_service):
"""add_subscription removes oldest when max exceeded."""
# Create 5 existing subscriptions
existing_subs = [
{
"endpoint": f"https://push.example.com/endpoint{i}",
"keys": {"p256dh": "key", "auth": "auth"},
"device_name": f"Device {i}",
"created_at": f"2024-01-0{i+1}T00:00:00Z"
}
for i in range(5)
]
mock_doc = Mock()
mock_doc.exists = True
mock_doc.to_dict.return_value = {"push_subscriptions": existing_subs}
push_service.db.collection.return_value.document.return_value.get.return_value = mock_doc
result = await push_service.add_subscription(
"test@example.com",
"https://push.example.com/new-endpoint",
{"p256dh": "new-key", "auth": "new-auth"},
"New Device"
)
assert result is True
# Verify oldest was removed (max 5 subscriptions)
update_call = push_service.db.collection.return_value.document.return_value.update.call_args
subs = update_call[0][0]["push_subscriptions"]
assert len(subs) == 5
@pytest.mark.asyncio
async def test_remove_subscription_success(self, push_service):
"""remove_subscription removes existing subscription."""
mock_doc = Mock()
mock_doc.exists = True
mock_doc.to_dict.return_value = {
"push_subscriptions": [{
"endpoint": "https://push.example.com/endpoint",
"keys": {"p256dh": "key", "auth": "auth"},
"device_name": "Test Device"
}]
}
push_service.db.collection.return_value.document.return_value.get.return_value = mock_doc
result = await push_service.remove_subscription(
"test@example.com",
"https://push.example.com/endpoint"
)
assert result is True
update_call = push_service.db.collection.return_value.document.return_value.update.call_args
subs = update_call[0][0]["push_subscriptions"]
assert len(subs) == 0
@pytest.mark.asyncio
async def test_remove_subscription_not_found(self, push_service):
"""remove_subscription returns False when subscription not found."""
mock_doc = Mock()
mock_doc.exists = True
mock_doc.to_dict.return_value = {"push_subscriptions": []}
push_service.db.collection.return_value.document.return_value.get.return_value = mock_doc
result = await push_service.remove_subscription(
"test@example.com",
"https://push.example.com/unknown-endpoint"
)
assert result is False
@pytest.mark.asyncio
async def test_list_subscriptions_success(self, push_service):
"""list_subscriptions returns user's subscriptions."""
mock_doc = Mock()
mock_doc.exists = True
mock_doc.to_dict.return_value = {
"push_subscriptions": [
{
"endpoint": "https://push.example.com/endpoint1",
"keys": {"p256dh": "key", "auth": "auth"},
"device_name": "Device 1",
"created_at": "2024-01-01T00:00:00Z",
"last_used_at": None
},
{
"endpoint": "https://push.example.com/endpoint2",
"keys": {"p256dh": "key", "auth": "auth"},
"device_name": "Device 2",
"created_at": "2024-01-02T00:00:00Z",
"last_used_at": "2024-01-03T00:00:00Z"
}
]
}
push_service.db.collection.return_value.document.return_value.get.return_value = mock_doc
result = await push_service.list_subscriptions("test@example.com")
assert len(result) == 2
assert result[0]["device_name"] == "Device 1"
assert result[1]["device_name"] == "Device 2"
# Verify keys are NOT included in response (security)
assert "keys" not in result[0]
class TestNotificationFormatting:
"""Tests for blocking and completion notification formatting."""
@pytest.mark.asyncio
async def test_send_blocking_notification_lyrics(self, push_service):
"""send_blocking_notification formats lyrics review notification."""
mock_doc = Mock()
mock_doc.exists = True
mock_doc.to_dict.return_value = {
"push_subscriptions": [{
"endpoint": "https://push.example.com/endpoint",
"keys": {"p256dh": "key", "auth": "auth"}
}]
}
push_service.db.collection.return_value.document.return_value.get.return_value = mock_doc
job = {
"job_id": "test-job-123",
"user_email": "test@example.com",
"artist": "Test Artist",
"title": "Test Song"
}
with patch('backend.services.push_notification_service.webpush') as mock_webpush:
await push_service.send_blocking_notification(job, "lyrics")
call_args = mock_webpush.call_args
import json
payload = json.loads(call_args[1]["data"])
assert payload["title"] == "Review Lyrics"
assert "Test Song" in payload["body"]
assert "Test Artist" in payload["body"]
assert "/review/test-job-123" in payload["url"]
@pytest.mark.asyncio
async def test_send_blocking_notification_instrumental(self, push_service):
"""send_blocking_notification formats instrumental selection notification."""
mock_doc = Mock()
mock_doc.exists = True
mock_doc.to_dict.return_value = {
"push_subscriptions": [{
"endpoint": "https://push.example.com/endpoint",
"keys": {"p256dh": "key", "auth": "auth"}
}]
}
push_service.db.collection.return_value.document.return_value.get.return_value = mock_doc
job = {
"job_id": "test-job-123",
"user_email": "test@example.com",
"artist": "Test Artist",
"title": "Test Song"
}
with patch('backend.services.push_notification_service.webpush') as mock_webpush:
await push_service.send_blocking_notification(job, "instrumental")
call_args = mock_webpush.call_args
import json
payload = json.loads(call_args[1]["data"])
assert payload["title"] == "Select Instrumental"
assert "/instrumental/test-job-123" in payload["url"]
@pytest.mark.asyncio
async def test_send_completion_notification(self, push_service):
"""send_completion_notification formats completion notification."""
mock_doc = Mock()
mock_doc.exists = True
mock_doc.to_dict.return_value = {
"push_subscriptions": [{
"endpoint": "https://push.example.com/endpoint",
"keys": {"p256dh": "key", "auth": "auth"}
}]
}
push_service.db.collection.return_value.document.return_value.get.return_value = mock_doc
job = {
"job_id": "test-job-123",
"user_email": "test@example.com",
"artist": "Test Artist",
"title": "Test Song"
}
with patch('backend.services.push_notification_service.webpush') as mock_webpush:
await push_service.send_completion_notification(job)
call_args = mock_webpush.call_args
import json
payload = json.loads(call_args[1]["data"])
assert payload["title"] == "Video Ready!"
assert "Test Song" in payload["body"]
assert "Test Artist" in payload["body"]
assert "download" in payload["body"].lower()
class TestSingleton:
"""Tests for singleton pattern."""
def test_get_push_notification_service_returns_singleton(self):
"""get_push_notification_service returns same instance."""
# Reset singleton for test
import backend.services.push_notification_service as module
module._push_service = None
with patch('backend.services.push_notification_service.get_settings') as mock_get_settings:
mock_settings = Mock()
mock_settings.enable_push_notifications = False
mock_settings.get_secret = Mock(return_value=None)
mock_get_settings.return_value = mock_settings
service1 = get_push_notification_service()
service2 = get_push_notification_service()
assert service1 is service2
# Clean up
module._push_service = None
+357
View File
@@ -0,0 +1,357 @@
"""
Tests for Push Notification API routes.
Tests the /api/push/* endpoints for subscription management.
"""
import pytest
from unittest.mock import Mock, patch, AsyncMock
from fastapi.testclient import TestClient
from dataclasses import dataclass
from typing import Optional
from backend.main import app
from backend.api.dependencies import require_auth, require_admin
from backend.services.auth_service import UserType, AuthResult
@pytest.fixture
def client():
"""Create test client."""
return TestClient(app)
@pytest.fixture
def mock_auth_result():
"""Create a mock AuthResult for regular user."""
return AuthResult(
is_valid=True,
user_type=UserType.UNLIMITED,
remaining_uses=-1,
message="Valid",
user_email="test@example.com",
is_admin=False,
)
@pytest.fixture
def mock_admin_auth_result():
"""Create a mock AuthResult for admin user."""
return AuthResult(
is_valid=True,
user_type=UserType.ADMIN,
remaining_uses=-1,
message="Valid",
user_email="admin@nomadkaraoke.com",
is_admin=True,
)
class TestGetVapidPublicKey:
"""Tests for GET /api/push/vapid-public-key."""
def test_returns_disabled_when_feature_off(self, client):
"""Returns enabled=false when push notifications disabled."""
with patch('backend.api.routes.push.get_settings') as mock_settings:
mock_settings.return_value.enable_push_notifications = False
response = client.get("/api/push/vapid-public-key")
assert response.status_code == 200
data = response.json()
assert data["enabled"] is False
assert data["vapid_public_key"] is None
def test_returns_key_when_enabled(self, client):
"""Returns public key when push notifications enabled."""
with patch('backend.api.routes.push.get_settings') as mock_settings, \
patch('backend.api.routes.push.get_push_notification_service') as mock_service:
mock_settings.return_value.enable_push_notifications = True
mock_service.return_value.get_public_key.return_value = "test-public-key-123"
response = client.get("/api/push/vapid-public-key")
assert response.status_code == 200
data = response.json()
assert data["enabled"] is True
assert data["vapid_public_key"] == "test-public-key-123"
class TestSubscribe:
"""Tests for POST /api/push/subscribe."""
def test_requires_authentication(self, client):
"""Returns 401 when not authenticated."""
# Clear any auth overrides to test real auth
app.dependency_overrides.clear()
response = client.post(
"/api/push/subscribe",
json={
"endpoint": "https://push.example.com/endpoint",
"keys": {"p256dh": "key1", "auth": "key2"}
}
)
assert response.status_code == 401
def test_returns_503_when_disabled(self, client, mock_auth_result):
"""Returns 503 when push notifications disabled."""
async def override_auth():
return mock_auth_result
app.dependency_overrides[require_auth] = override_auth
try:
with patch('backend.api.routes.push.get_settings') as mock_settings:
mock_settings.return_value.enable_push_notifications = False
response = client.post(
"/api/push/subscribe",
json={
"endpoint": "https://push.example.com/endpoint",
"keys": {"p256dh": "key1", "auth": "key2"}
}
)
assert response.status_code == 503
assert "not enabled" in response.json()["detail"].lower()
finally:
app.dependency_overrides.clear()
def test_validates_required_keys(self, client, mock_auth_result):
"""Returns 400 when keys missing."""
async def override_auth():
return mock_auth_result
app.dependency_overrides[require_auth] = override_auth
try:
with patch('backend.api.routes.push.get_settings') as mock_settings:
mock_settings.return_value.enable_push_notifications = True
response = client.post(
"/api/push/subscribe",
json={
"endpoint": "https://push.example.com/endpoint",
"keys": {"p256dh": "key1"} # Missing auth
}
)
assert response.status_code == 400
assert "missing" in response.json()["detail"].lower()
finally:
app.dependency_overrides.clear()
def test_successful_subscription(self, client, mock_auth_result):
"""Successfully subscribes user to push notifications."""
async def override_auth():
return mock_auth_result
app.dependency_overrides[require_auth] = override_auth
try:
with patch('backend.api.routes.push.get_settings') as mock_settings, \
patch('backend.api.routes.push.get_push_notification_service') as mock_service:
mock_settings.return_value.enable_push_notifications = True
mock_service.return_value.add_subscription = AsyncMock(return_value=True)
response = client.post(
"/api/push/subscribe",
json={
"endpoint": "https://push.example.com/endpoint",
"keys": {"p256dh": "key1", "auth": "key2"},
"device_name": "Test Device"
}
)
assert response.status_code == 200
data = response.json()
assert data["status"] == "success"
mock_service.return_value.add_subscription.assert_called_once_with(
user_email="test@example.com",
endpoint="https://push.example.com/endpoint",
keys={"p256dh": "key1", "auth": "key2"},
device_name="Test Device"
)
finally:
app.dependency_overrides.clear()
class TestUnsubscribe:
"""Tests for POST /api/push/unsubscribe."""
def test_requires_authentication(self, client):
"""Returns 401 when not authenticated."""
app.dependency_overrides.clear()
response = client.post(
"/api/push/unsubscribe",
json={"endpoint": "https://push.example.com/endpoint"}
)
assert response.status_code == 401
def test_successful_unsubscribe(self, client, mock_auth_result):
"""Successfully unsubscribes from push notifications."""
async def override_auth():
return mock_auth_result
app.dependency_overrides[require_auth] = override_auth
try:
with patch('backend.api.routes.push.get_push_notification_service') as mock_service:
mock_service.return_value.remove_subscription = AsyncMock(return_value=True)
response = client.post(
"/api/push/unsubscribe",
json={"endpoint": "https://push.example.com/endpoint"}
)
assert response.status_code == 200
data = response.json()
assert data["status"] == "success"
mock_service.return_value.remove_subscription.assert_called_once()
finally:
app.dependency_overrides.clear()
def test_unsubscribe_not_found_succeeds(self, client, mock_auth_result):
"""Returns success even when subscription not found."""
async def override_auth():
return mock_auth_result
app.dependency_overrides[require_auth] = override_auth
try:
with patch('backend.api.routes.push.get_push_notification_service') as mock_service:
mock_service.return_value.remove_subscription = AsyncMock(return_value=False)
response = client.post(
"/api/push/unsubscribe",
json={"endpoint": "https://push.example.com/unknown"}
)
assert response.status_code == 200
data = response.json()
assert data["status"] == "success"
finally:
app.dependency_overrides.clear()
class TestListSubscriptions:
"""Tests for GET /api/push/subscriptions."""
def test_requires_authentication(self, client):
"""Returns 401 when not authenticated."""
app.dependency_overrides.clear()
response = client.get("/api/push/subscriptions")
assert response.status_code == 401
def test_returns_user_subscriptions(self, client, mock_auth_result):
"""Returns list of user's subscriptions."""
async def override_auth():
return mock_auth_result
app.dependency_overrides[require_auth] = override_auth
try:
with patch('backend.api.routes.push.get_push_notification_service') as mock_service:
mock_service.return_value.list_subscriptions = AsyncMock(return_value=[
{
"endpoint": "https://push.example.com/endpoint1",
"device_name": "Device 1",
"created_at": "2024-01-01T00:00:00Z",
"last_used_at": None
},
{
"endpoint": "https://push.example.com/endpoint2",
"device_name": "Device 2",
"created_at": "2024-01-02T00:00:00Z",
"last_used_at": "2024-01-03T00:00:00Z"
}
])
response = client.get("/api/push/subscriptions")
assert response.status_code == 200
data = response.json()
assert data["count"] == 2
assert len(data["subscriptions"]) == 2
assert data["subscriptions"][0]["device_name"] == "Device 1"
finally:
app.dependency_overrides.clear()
class TestTestNotification:
"""Tests for POST /api/push/test."""
def test_requires_admin(self, client, mock_auth_result):
"""Returns 403 when not admin."""
# Use a non-admin auth result
async def override_admin():
from fastapi import HTTPException
raise HTTPException(status_code=403, detail="Admin access required")
app.dependency_overrides[require_admin] = override_admin
try:
response = client.post(
"/api/push/test",
json={"title": "Test", "body": "Test message"}
)
assert response.status_code == 403
finally:
app.dependency_overrides.clear()
def test_returns_503_when_disabled(self, client, mock_admin_auth_result):
"""Returns 503 when push notifications disabled."""
async def override_admin():
return mock_admin_auth_result
app.dependency_overrides[require_admin] = override_admin
try:
with patch('backend.api.routes.push.get_settings') as mock_settings:
mock_settings.return_value.enable_push_notifications = False
response = client.post(
"/api/push/test",
json={"title": "Test", "body": "Test message"}
)
assert response.status_code == 503
finally:
app.dependency_overrides.clear()
def test_sends_test_notification(self, client, mock_admin_auth_result):
"""Successfully sends test notification to admin."""
async def override_admin():
return mock_admin_auth_result
app.dependency_overrides[require_admin] = override_admin
try:
with patch('backend.api.routes.push.get_settings') as mock_settings, \
patch('backend.api.routes.push.get_push_notification_service') as mock_service:
mock_settings.return_value.enable_push_notifications = True
mock_service.return_value.send_push = AsyncMock(return_value=2)
response = client.post(
"/api/push/test",
json={"title": "Test Title", "body": "Test Body"}
)
assert response.status_code == 200
data = response.json()
assert data["status"] == "success"
assert data["sent_count"] == 2
mock_service.return_value.send_push.assert_called_once_with(
user_email="admin@nomadkaraoke.com",
title="Test Title",
body="Test Body",
url="/app/",
tag="test"
)
finally:
app.dependency_overrides.clear()
+396
View File
@@ -0,0 +1,396 @@
"""
Unit tests for RateLimitService.
Tests rate limiting logic for jobs, YouTube uploads, and beta enrollments.
"""
import pytest
from unittest.mock import Mock, MagicMock, patch
from datetime import datetime, timezone
# Mock Google Cloud before imports
import sys
sys.modules['google.cloud.firestore'] = MagicMock()
sys.modules['google.cloud.storage'] = MagicMock()
class TestRateLimitService:
"""Test RateLimitService functionality."""
@pytest.fixture
def mock_db(self):
"""Create a mock Firestore client."""
mock = MagicMock()
return mock
@pytest.fixture
def mock_settings(self):
"""Create mock settings."""
settings = Mock()
settings.enable_rate_limiting = True
settings.rate_limit_jobs_per_day = 5
settings.rate_limit_youtube_uploads_per_day = 10
settings.rate_limit_beta_ip_per_day = 1
return settings
@pytest.fixture
def rate_limit_service(self, mock_db, mock_settings):
"""Create RateLimitService instance with mocks."""
with patch('backend.services.rate_limit_service.settings', mock_settings):
from backend.services.rate_limit_service import RateLimitService
service = RateLimitService(db=mock_db)
return service
# =========================================================================
# User Job Rate Limiting Tests
# =========================================================================
def test_check_user_job_limit_under_limit(self, rate_limit_service, mock_db, mock_settings):
"""Test that user under limit is allowed."""
# Mock: user has 2 jobs today
mock_doc = Mock()
mock_doc.exists = True
mock_doc.to_dict.return_value = {"count": 2}
mock_db.collection.return_value.document.return_value.get.return_value = mock_doc
with patch('backend.services.rate_limit_service.settings', mock_settings):
allowed, remaining, message = rate_limit_service.check_user_job_limit("user@example.com")
assert allowed is True
assert remaining == 3 # 5 - 2
assert "3 jobs remaining" in message
def test_check_user_job_limit_at_limit(self, rate_limit_service, mock_db, mock_settings):
"""Test that user at limit is blocked."""
# Mock: user has 5 jobs today (at limit)
mock_doc = Mock()
mock_doc.exists = True
mock_doc.to_dict.return_value = {"count": 5}
mock_db.collection.return_value.document.return_value.get.return_value = mock_doc
with patch('backend.services.rate_limit_service.settings', mock_settings):
allowed, remaining, message = rate_limit_service.check_user_job_limit("user@example.com")
assert allowed is False
assert remaining == 0
assert "Daily job limit reached" in message
def test_check_user_job_limit_over_limit(self, rate_limit_service, mock_db, mock_settings):
"""Test that user over limit is blocked."""
# Mock: user somehow has 7 jobs (over limit)
mock_doc = Mock()
mock_doc.exists = True
mock_doc.to_dict.return_value = {"count": 7}
mock_db.collection.return_value.document.return_value.get.return_value = mock_doc
with patch('backend.services.rate_limit_service.settings', mock_settings):
allowed, remaining, message = rate_limit_service.check_user_job_limit("user@example.com")
assert allowed is False
assert remaining == 0
def test_check_user_job_limit_no_jobs_yet(self, rate_limit_service, mock_db, mock_settings):
"""Test user with no jobs today is allowed."""
# Mock: no document exists
mock_doc = Mock()
mock_doc.exists = False
mock_db.collection.return_value.document.return_value.get.return_value = mock_doc
with patch('backend.services.rate_limit_service.settings', mock_settings):
allowed, remaining, message = rate_limit_service.check_user_job_limit("newuser@example.com")
assert allowed is True
assert remaining == 5
def test_check_user_job_limit_with_admin_bypass(self, rate_limit_service, mock_db, mock_settings):
"""Test that admins bypass job limits."""
# Mock: user at limit
mock_doc = Mock()
mock_doc.exists = True
mock_doc.to_dict.return_value = {"count": 10}
mock_db.collection.return_value.document.return_value.get.return_value = mock_doc
with patch('backend.services.rate_limit_service.settings', mock_settings):
allowed, remaining, message = rate_limit_service.check_user_job_limit(
"admin@example.com", is_admin=True
)
assert allowed is True
assert remaining == -1 # Unlimited for admins
def test_check_user_job_limit_with_override_bypass(self, rate_limit_service, mock_db, mock_settings):
"""Test that users with bypass override are allowed."""
# Mock: user at limit
mock_job_doc = Mock()
mock_job_doc.exists = True
mock_job_doc.to_dict.return_value = {"count": 10}
# Mock: user has bypass override
mock_override_doc = Mock()
mock_override_doc.exists = True
mock_override_doc.to_dict.return_value = {"bypass_job_limit": True}
def mock_get(*args, **kwargs):
# Return different docs based on collection
return mock_override_doc if "overrides" in str(mock_db.collection.call_args) else mock_job_doc
mock_db.collection.return_value.document.return_value.get.side_effect = [mock_override_doc, mock_job_doc]
with patch('backend.services.rate_limit_service.settings', mock_settings):
allowed, remaining, message = rate_limit_service.check_user_job_limit("vip@example.com")
assert allowed is True
def test_check_user_job_limit_with_custom_limit(self, rate_limit_service, mock_db, mock_settings):
"""Test that custom limit from override is respected."""
# Mock: user has 8 jobs
mock_job_doc = Mock()
mock_job_doc.exists = True
mock_job_doc.to_dict.return_value = {"count": 8}
# Mock: user has custom limit of 20
mock_override_doc = Mock()
mock_override_doc.exists = True
mock_override_doc.to_dict.return_value = {"bypass_job_limit": False, "custom_daily_job_limit": 20}
mock_db.collection.return_value.document.return_value.get.side_effect = [mock_override_doc, mock_job_doc]
with patch('backend.services.rate_limit_service.settings', mock_settings):
allowed, remaining, message = rate_limit_service.check_user_job_limit("custom@example.com")
assert allowed is True
assert remaining == 12 # 20 - 8
def test_check_user_job_limit_rate_limiting_disabled(self, rate_limit_service, mock_settings):
"""Test that rate limiting can be disabled."""
mock_settings.enable_rate_limiting = False
with patch('backend.services.rate_limit_service.settings', mock_settings):
allowed, remaining, message = rate_limit_service.check_user_job_limit("user@example.com")
assert allowed is True
assert remaining == -1
assert "Rate limiting disabled" in message
# =========================================================================
# YouTube Upload Rate Limiting Tests
# =========================================================================
def test_check_youtube_limit_under_limit(self, rate_limit_service, mock_db, mock_settings):
"""Test YouTube upload under limit is allowed."""
mock_doc = Mock()
mock_doc.exists = True
mock_doc.to_dict.return_value = {"count": 3}
mock_db.collection.return_value.document.return_value.get.return_value = mock_doc
with patch('backend.services.rate_limit_service.settings', mock_settings):
allowed, remaining, message = rate_limit_service.check_youtube_upload_limit()
assert allowed is True
assert remaining == 7 # 10 - 3
def test_check_youtube_limit_at_limit(self, rate_limit_service, mock_db, mock_settings):
"""Test YouTube upload at limit is blocked."""
mock_doc = Mock()
mock_doc.exists = True
mock_doc.to_dict.return_value = {"count": 10}
mock_db.collection.return_value.document.return_value.get.return_value = mock_doc
with patch('backend.services.rate_limit_service.settings', mock_settings):
allowed, remaining, message = rate_limit_service.check_youtube_upload_limit()
assert allowed is False
assert remaining == 0
assert "Daily YouTube upload limit reached" in message
def test_check_youtube_limit_no_uploads_yet(self, rate_limit_service, mock_db, mock_settings):
"""Test YouTube upload with no uploads today is allowed."""
mock_doc = Mock()
mock_doc.exists = False
mock_db.collection.return_value.document.return_value.get.return_value = mock_doc
with patch('backend.services.rate_limit_service.settings', mock_settings):
allowed, remaining, message = rate_limit_service.check_youtube_upload_limit()
assert allowed is True
assert remaining == 10
def test_check_youtube_limit_zero_configured(self, rate_limit_service, mock_db, mock_settings):
"""Test that zero limit means unlimited YouTube uploads."""
mock_settings.rate_limit_youtube_uploads_per_day = 0
with patch('backend.services.rate_limit_service.settings', mock_settings):
allowed, remaining, message = rate_limit_service.check_youtube_upload_limit()
assert allowed is True
assert remaining == -1
assert "No YouTube upload limit" in message
# =========================================================================
# Beta Enrollment IP Rate Limiting Tests
# =========================================================================
def test_check_beta_ip_limit_first_enrollment(self, rate_limit_service, mock_db, mock_settings):
"""Test first enrollment from IP is allowed."""
mock_doc = Mock()
mock_doc.exists = False
mock_db.collection.return_value.document.return_value.get.return_value = mock_doc
with patch('backend.services.rate_limit_service.settings', mock_settings):
allowed, remaining, message = rate_limit_service.check_beta_ip_limit("192.168.1.1")
assert allowed is True
assert remaining == 1
def test_check_beta_ip_limit_already_enrolled(self, rate_limit_service, mock_db, mock_settings):
"""Test second enrollment from same IP is blocked."""
mock_doc = Mock()
mock_doc.exists = True
mock_doc.to_dict.return_value = {"count": 1}
mock_db.collection.return_value.document.return_value.get.return_value = mock_doc
with patch('backend.services.rate_limit_service.settings', mock_settings):
allowed, remaining, message = rate_limit_service.check_beta_ip_limit("192.168.1.1")
assert allowed is False
assert remaining == 0
assert "Too many beta enrollments" in message
# =========================================================================
# Recording Tests
# =========================================================================
def test_record_job_creation(self, rate_limit_service, mock_db, mock_settings):
"""Test recording a job creation."""
mock_transaction = Mock()
mock_db.transaction.return_value = mock_transaction
mock_doc = Mock()
mock_doc.exists = False
mock_db.collection.return_value.document.return_value.get.return_value = mock_doc
with patch('backend.services.rate_limit_service.settings', mock_settings):
with patch('backend.services.rate_limit_service.firestore') as mock_firestore:
# Mock the transactional decorator
mock_firestore.transactional = lambda f: f
rate_limit_service.record_job_creation("user@example.com", "job123")
# Verify transaction was used
mock_db.transaction.assert_called()
def test_record_youtube_upload(self, rate_limit_service, mock_db, mock_settings):
"""Test recording a YouTube upload."""
mock_transaction = Mock()
mock_db.transaction.return_value = mock_transaction
mock_doc = Mock()
mock_doc.exists = False
mock_db.collection.return_value.document.return_value.get.return_value = mock_doc
with patch('backend.services.rate_limit_service.settings', mock_settings):
with patch('backend.services.rate_limit_service.firestore') as mock_firestore:
mock_firestore.transactional = lambda f: f
rate_limit_service.record_youtube_upload("job123", "user@example.com")
mock_db.transaction.assert_called()
def test_record_skipped_when_disabled(self, rate_limit_service, mock_db, mock_settings):
"""Test that recording is skipped when rate limiting is disabled."""
mock_settings.enable_rate_limiting = False
with patch('backend.services.rate_limit_service.settings', mock_settings):
rate_limit_service.record_job_creation("user@example.com", "job123")
# Should not call Firestore
mock_db.collection.assert_not_called()
# =========================================================================
# Override Management Tests
# =========================================================================
def test_get_user_override_exists(self, rate_limit_service, mock_db):
"""Test getting an existing user override."""
mock_doc = Mock()
mock_doc.exists = True
mock_doc.to_dict.return_value = {
"email": "vip@example.com",
"bypass_job_limit": True,
"reason": "VIP user"
}
mock_db.collection.return_value.document.return_value.get.return_value = mock_doc
override = rate_limit_service.get_user_override("vip@example.com")
assert override is not None
assert override["bypass_job_limit"] is True
def test_get_user_override_not_exists(self, rate_limit_service, mock_db):
"""Test getting a non-existent user override."""
mock_doc = Mock()
mock_doc.exists = False
mock_db.collection.return_value.document.return_value.get.return_value = mock_doc
override = rate_limit_service.get_user_override("regular@example.com")
assert override is None
def test_set_user_override(self, rate_limit_service, mock_db):
"""Test setting a user override."""
rate_limit_service.set_user_override(
user_email="vip@example.com",
bypass_job_limit=True,
reason="Special access",
admin_email="admin@example.com"
)
mock_db.collection.return_value.document.return_value.set.assert_called_once()
def test_remove_user_override_exists(self, rate_limit_service, mock_db):
"""Test removing an existing user override."""
mock_doc = Mock()
mock_doc.exists = True
mock_db.collection.return_value.document.return_value.get.return_value = mock_doc
result = rate_limit_service.remove_user_override("vip@example.com", "admin@example.com")
assert result is True
mock_db.collection.return_value.document.return_value.delete.assert_called_once()
def test_remove_user_override_not_exists(self, rate_limit_service, mock_db):
"""Test removing a non-existent user override."""
mock_doc = Mock()
mock_doc.exists = False
mock_db.collection.return_value.document.return_value.get.return_value = mock_doc
result = rate_limit_service.remove_user_override("regular@example.com", "admin@example.com")
assert result is False
class TestRateLimitExceededError:
"""Test RateLimitExceededError exception."""
def test_exception_attributes(self):
"""Test exception has all expected attributes."""
from backend.exceptions import RateLimitExceededError
exc = RateLimitExceededError(
message="Limit exceeded",
limit_type="job",
remaining_seconds=3600,
current_count=5,
limit_value=5
)
assert exc.message == "Limit exceeded"
assert exc.limit_type == "job"
assert exc.remaining_seconds == 3600
assert exc.current_count == 5
assert exc.limit_value == 5
def test_exception_str(self):
"""Test exception string representation."""
from backend.exceptions import RateLimitExceededError
exc = RateLimitExceededError(message="Test message")
assert str(exc) == "Test message"
+392
View File
@@ -0,0 +1,392 @@
"""
Unit tests for rate limits admin API endpoints.
Tests the rate limit statistics, blocklist management, and user override endpoints.
"""
import pytest
from unittest.mock import Mock, patch, MagicMock
from fastapi.testclient import TestClient
from fastapi import FastAPI
from datetime import datetime, timezone
from backend.api.routes.rate_limits import router
from backend.api.dependencies import require_admin
from backend.services.auth_service import AuthResult, UserType
# Create a test app with the rate_limits router
app = FastAPI()
app.include_router(router, prefix="/api")
def get_mock_admin():
"""Override for require_admin dependency."""
return AuthResult(
is_valid=True,
user_type=UserType.ADMIN,
remaining_uses=-1,
message="Admin access granted",
user_email="admin@example.com",
is_admin=True,
)
# Override the require_admin dependency
app.dependency_overrides[require_admin] = get_mock_admin
@pytest.fixture
def client():
"""Create a test client."""
return TestClient(app)
@pytest.fixture
def mock_settings():
"""Create mock settings."""
settings = Mock()
settings.enable_rate_limiting = True
settings.rate_limit_jobs_per_day = 5
settings.rate_limit_youtube_uploads_per_day = 10
settings.rate_limit_beta_ip_per_day = 1
return settings
class TestGetRateLimitStats:
"""Tests for GET /api/admin/rate-limits/stats endpoint."""
def test_returns_stats(self, client, mock_settings):
"""Test successful stats retrieval."""
with patch('backend.api.routes.rate_limits.get_rate_limit_service') as mock_get_rls, \
patch('backend.api.routes.rate_limits.get_email_validation_service') as mock_get_evs, \
patch('backend.api.routes.rate_limits.settings', mock_settings):
# Setup rate limit service mock
mock_rls = Mock()
mock_rls.get_youtube_uploads_today.return_value = 3
mock_rls.get_all_overrides.return_value = {"user1@example.com": {}}
mock_get_rls.return_value = mock_rls
# Setup email validation service mock
mock_evs = Mock()
mock_evs.get_blocklist_stats.return_value = {
"disposable_domains_count": 100,
"blocked_emails_count": 5,
"blocked_ips_count": 2,
"default_disposable_domains_count": 130,
}
mock_get_evs.return_value = mock_evs
response = client.get(
"/api/admin/rate-limits/stats",
headers={"Authorization": "Bearer admin-token"}
)
assert response.status_code == 200
data = response.json()
assert data["jobs_per_day_limit"] == 5
assert data["youtube_uploads_per_day_limit"] == 10
assert data["youtube_uploads_today"] == 3
assert data["youtube_uploads_remaining"] == 7
assert data["disposable_domains_count"] == 100
assert data["total_overrides"] == 1
class TestGetUserRateLimitStatus:
"""Tests for GET /api/admin/rate-limits/users/{email} endpoint."""
def test_returns_user_status(self, client, mock_settings):
"""Test successful user status retrieval."""
with patch('backend.api.routes.rate_limits.get_rate_limit_service') as mock_get_rls, \
patch('backend.api.routes.rate_limits.settings', mock_settings):
mock_rls = Mock()
mock_rls.get_user_job_count_today.return_value = 2
mock_rls.get_user_override.return_value = None
mock_get_rls.return_value = mock_rls
response = client.get(
"/api/admin/rate-limits/users/user@example.com",
headers={"Authorization": "Bearer admin-token"}
)
assert response.status_code == 200
data = response.json()
assert data["email"] == "user@example.com"
assert data["jobs_today"] == 2
assert data["jobs_limit"] == 5
assert data["jobs_remaining"] == 3
assert data["has_bypass"] is False
def test_returns_user_with_bypass(self, client, mock_settings):
"""Test user with bypass override."""
with patch('backend.api.routes.rate_limits.get_rate_limit_service') as mock_get_rls, \
patch('backend.api.routes.rate_limits.settings', mock_settings):
mock_rls = Mock()
mock_rls.get_user_job_count_today.return_value = 10
mock_rls.get_user_override.return_value = {
"bypass_job_limit": True,
"reason": "VIP user"
}
mock_get_rls.return_value = mock_rls
response = client.get(
"/api/admin/rate-limits/users/vip@example.com",
headers={"Authorization": "Bearer admin-token"}
)
assert response.status_code == 200
data = response.json()
assert data["has_bypass"] is True
assert data["bypass_reason"] == "VIP user"
assert data["jobs_remaining"] == -1 # Unlimited
class TestBlocklistEndpoints:
"""Tests for blocklist management endpoints."""
def test_get_blocklists(self, client):
"""Test getting all blocklists."""
with patch('backend.api.routes.rate_limits.get_email_validation_service') as mock_get_evs, \
patch('backend.services.firestore_service.get_firestore_client') as mock_get_db:
mock_evs = Mock()
mock_evs.get_blocklist_config.return_value = {
"disposable_domains": {"tempmail.com", "mailinator.com"},
"blocked_emails": {"spammer@example.com"},
"blocked_ips": {"192.168.1.100"},
}
mock_get_evs.return_value = mock_evs
# Mock Firestore for metadata
mock_db = Mock()
mock_doc = Mock()
mock_doc.exists = True
mock_doc.to_dict.return_value = {
"updated_at": datetime.now(timezone.utc),
"updated_by": "admin@example.com"
}
mock_db.collection.return_value.document.return_value.get.return_value = mock_doc
mock_get_db.return_value = mock_db
response = client.get(
"/api/admin/rate-limits/blocklists",
headers={"Authorization": "Bearer admin-token"}
)
assert response.status_code == 200
data = response.json()
assert "tempmail.com" in data["disposable_domains"]
assert "spammer@example.com" in data["blocked_emails"]
def test_add_disposable_domain(self, client):
"""Test adding a disposable domain."""
with patch('backend.api.routes.rate_limits.get_email_validation_service') as mock_get_evs:
mock_evs = Mock()
mock_evs.add_disposable_domain.return_value = True
mock_get_evs.return_value = mock_evs
response = client.post(
"/api/admin/rate-limits/blocklists/disposable-domains",
json={"domain": "newtemp.com"},
headers={"Authorization": "Bearer admin-token"}
)
assert response.status_code == 200
data = response.json()
assert data["success"] is True
mock_evs.add_disposable_domain.assert_called_once_with("newtemp.com", "admin@example.com")
def test_add_disposable_domain_invalid(self, client):
"""Test adding invalid domain."""
response = client.post(
"/api/admin/rate-limits/blocklists/disposable-domains",
json={"domain": "invalid"}, # No dot
headers={"Authorization": "Bearer admin-token"}
)
assert response.status_code == 400
def test_remove_disposable_domain(self, client):
"""Test removing a disposable domain."""
with patch('backend.api.routes.rate_limits.get_email_validation_service') as mock_get_evs:
mock_evs = Mock()
mock_evs.remove_disposable_domain.return_value = True
mock_get_evs.return_value = mock_evs
response = client.delete(
"/api/admin/rate-limits/blocklists/disposable-domains/tempmail.com",
headers={"Authorization": "Bearer admin-token"}
)
assert response.status_code == 200
mock_evs.remove_disposable_domain.assert_called_once()
def test_remove_disposable_domain_not_found(self, client):
"""Test removing non-existent domain."""
with patch('backend.api.routes.rate_limits.get_email_validation_service') as mock_get_evs:
mock_evs = Mock()
mock_evs.remove_disposable_domain.return_value = False
mock_get_evs.return_value = mock_evs
response = client.delete(
"/api/admin/rate-limits/blocklists/disposable-domains/notfound.com",
headers={"Authorization": "Bearer admin-token"}
)
assert response.status_code == 404
def test_add_blocked_email(self, client):
"""Test adding a blocked email."""
with patch('backend.api.routes.rate_limits.get_email_validation_service') as mock_get_evs:
mock_evs = Mock()
mock_evs.add_blocked_email.return_value = True
mock_get_evs.return_value = mock_evs
response = client.post(
"/api/admin/rate-limits/blocklists/blocked-emails",
json={"email": "spammer@example.com"},
headers={"Authorization": "Bearer admin-token"}
)
assert response.status_code == 200
def test_add_blocked_ip(self, client):
"""Test adding a blocked IP."""
with patch('backend.api.routes.rate_limits.get_email_validation_service') as mock_get_evs:
mock_evs = Mock()
mock_evs.add_blocked_ip.return_value = True
mock_get_evs.return_value = mock_evs
response = client.post(
"/api/admin/rate-limits/blocklists/blocked-ips",
json={"ip_address": "192.168.1.100"},
headers={"Authorization": "Bearer admin-token"}
)
assert response.status_code == 200
class TestUserOverrideEndpoints:
"""Tests for user override management endpoints."""
def test_get_all_overrides(self, client):
"""Test getting all user overrides."""
with patch('backend.api.routes.rate_limits.get_rate_limit_service') as mock_get_rls:
mock_rls = Mock()
mock_rls.get_all_overrides.return_value = {
"vip@example.com": {
"bypass_job_limit": True,
"custom_daily_job_limit": None,
"reason": "VIP user",
"created_by": "admin@example.com",
"created_at": datetime.now(timezone.utc),
}
}
mock_get_rls.return_value = mock_rls
response = client.get(
"/api/admin/rate-limits/overrides",
headers={"Authorization": "Bearer admin-token"}
)
assert response.status_code == 200
data = response.json()
assert data["total"] == 1
assert len(data["overrides"]) == 1
assert data["overrides"][0]["email"] == "vip@example.com"
def test_set_user_override(self, client):
"""Test setting a user override."""
with patch('backend.api.routes.rate_limits.get_rate_limit_service') as mock_get_rls:
mock_rls = Mock()
mock_get_rls.return_value = mock_rls
response = client.put(
"/api/admin/rate-limits/overrides/user@example.com",
json={
"bypass_job_limit": True,
"reason": "Special access granted"
},
headers={"Authorization": "Bearer admin-token"}
)
assert response.status_code == 200
mock_rls.set_user_override.assert_called_once_with(
user_email="user@example.com",
bypass_job_limit=True,
custom_daily_job_limit=None,
reason="Special access granted",
admin_email="admin@example.com",
)
def test_set_user_override_with_custom_limit(self, client):
"""Test setting a user override with custom limit."""
with patch('backend.api.routes.rate_limits.get_rate_limit_service') as mock_get_rls:
mock_rls = Mock()
mock_get_rls.return_value = mock_rls
response = client.put(
"/api/admin/rate-limits/overrides/user@example.com",
json={
"bypass_job_limit": False,
"custom_daily_job_limit": 20,
"reason": "High volume user"
},
headers={"Authorization": "Bearer admin-token"}
)
assert response.status_code == 200
mock_rls.set_user_override.assert_called_once()
def test_set_user_override_missing_reason(self, client):
"""Test setting override without reason fails."""
response = client.put(
"/api/admin/rate-limits/overrides/user@example.com",
json={
"bypass_job_limit": True,
"reason": "ab" # Too short
},
headers={"Authorization": "Bearer admin-token"}
)
assert response.status_code == 400
def test_remove_user_override(self, client):
"""Test removing a user override."""
with patch('backend.api.routes.rate_limits.get_rate_limit_service') as mock_get_rls:
mock_rls = Mock()
mock_rls.remove_user_override.return_value = True
mock_get_rls.return_value = mock_rls
response = client.delete(
"/api/admin/rate-limits/overrides/user@example.com",
headers={"Authorization": "Bearer admin-token"}
)
assert response.status_code == 200
def test_remove_user_override_not_found(self, client):
"""Test removing non-existent override."""
with patch('backend.api.routes.rate_limits.get_rate_limit_service') as mock_get_rls:
mock_rls = Mock()
mock_rls.remove_user_override.return_value = False
mock_get_rls.return_value = mock_rls
response = client.delete(
"/api/admin/rate-limits/overrides/notfound@example.com",
headers={"Authorization": "Bearer admin-token"}
)
assert response.status_code == 404
+205
View File
@@ -0,0 +1,205 @@
"""
Tests for StripeService.
Tests cover:
- Made-for-you checkout session URL generation
- Credit purchase checkout session URL generation
- Package validation
"""
import pytest
from unittest.mock import Mock, patch, MagicMock
import os
class TestStripeServiceUrls:
"""Tests for checkout session URL generation."""
@pytest.fixture
def stripe_service(self):
"""Create a StripeService instance with mocked Stripe."""
# Set required env vars
with patch.dict(os.environ, {
'STRIPE_SECRET_KEY': 'sk_test_fake',
'FRONTEND_URL': 'https://gen.nomadkaraoke.com',
}):
# Import here to pick up env vars
from backend.services.stripe_service import StripeService
service = StripeService()
return service
def test_made_for_you_success_url_uses_frontend_url(self, stripe_service):
"""Test that made-for-you checkout uses frontend_url, not hardcoded domain."""
# Mock stripe.checkout.Session.create to capture the params
with patch('stripe.checkout.Session.create') as mock_create:
mock_session = MagicMock()
mock_session.id = 'cs_test_123'
mock_session.url = 'https://checkout.stripe.com/test'
mock_create.return_value = mock_session
success, url, message = stripe_service.create_made_for_you_checkout_session(
customer_email='customer@example.com',
artist='Test Artist',
title='Test Song',
)
# Verify the call was made
assert mock_create.called
call_kwargs = mock_create.call_args[1]
# Verify success_url uses frontend_url and correct path
success_url = call_kwargs['success_url']
assert success_url.startswith('https://gen.nomadkaraoke.com')
assert '/order/success' in success_url
assert 'session_id=' in success_url
def test_made_for_you_success_url_not_hardcoded_to_marketing_site(self, stripe_service):
"""Test that success_url is NOT the old hardcoded marketing site URL."""
with patch('stripe.checkout.Session.create') as mock_create:
mock_session = MagicMock()
mock_session.id = 'cs_test_123'
mock_session.url = 'https://checkout.stripe.com/test'
mock_create.return_value = mock_session
stripe_service.create_made_for_you_checkout_session(
customer_email='customer@example.com',
artist='Test Artist',
title='Test Song',
)
call_kwargs = mock_create.call_args[1]
success_url = call_kwargs['success_url']
# The bug was: success_url = "https://nomadkaraoke.com/order/success/"
# (note: nomadkaraoke.com WITHOUT the 'gen.' prefix - that's the marketing site)
# This should NOT be the case anymore - should use gen.nomadkaraoke.com
assert not success_url.startswith('https://nomadkaraoke.com/')
# Should use the frontend URL (gen.nomadkaraoke.com)
assert success_url.startswith('https://gen.nomadkaraoke.com')
def test_made_for_you_respects_custom_frontend_url(self):
"""Test that made-for-you checkout uses custom FRONTEND_URL if set."""
with patch.dict(os.environ, {
'STRIPE_SECRET_KEY': 'sk_test_fake',
'FRONTEND_URL': 'https://custom.example.com',
}):
from backend.services.stripe_service import StripeService
service = StripeService()
with patch('stripe.checkout.Session.create') as mock_create:
mock_session = MagicMock()
mock_session.id = 'cs_test_123'
mock_session.url = 'https://checkout.stripe.com/test'
mock_create.return_value = mock_session
service.create_made_for_you_checkout_session(
customer_email='customer@example.com',
artist='Test Artist',
title='Test Song',
)
call_kwargs = mock_create.call_args[1]
success_url = call_kwargs['success_url']
assert success_url.startswith('https://custom.example.com')
def test_credit_purchase_success_url_uses_payment_success(self, stripe_service):
"""Test that credit purchase checkout uses /payment/success path."""
with patch('stripe.checkout.Session.create') as mock_create:
mock_session = MagicMock()
mock_session.id = 'cs_test_123'
mock_session.url = 'https://checkout.stripe.com/test'
mock_create.return_value = mock_session
success, url, message = stripe_service.create_checkout_session(
package_id='1_credit',
user_email='user@example.com',
)
call_kwargs = mock_create.call_args[1]
success_url = call_kwargs['success_url']
# Credit purchases go to /payment/success
assert '/payment/success' in success_url
assert success_url.startswith('https://gen.nomadkaraoke.com')
def test_made_for_you_uses_order_success_path(self, stripe_service):
"""Test that made-for-you uses /order/success path (not /payment/success)."""
with patch('stripe.checkout.Session.create') as mock_create:
mock_session = MagicMock()
mock_session.id = 'cs_test_123'
mock_session.url = 'https://checkout.stripe.com/test'
mock_create.return_value = mock_session
stripe_service.create_made_for_you_checkout_session(
customer_email='customer@example.com',
artist='Test Artist',
title='Test Song',
)
call_kwargs = mock_create.call_args[1]
success_url = call_kwargs['success_url']
# Made-for-you orders go to /order/success (different messaging)
assert '/order/success' in success_url
# Should NOT go to /payment/success
assert '/payment/success' not in success_url
class TestStripeServiceMetadata:
"""Tests for checkout session metadata."""
@pytest.fixture
def stripe_service(self):
"""Create a StripeService instance with mocked Stripe."""
with patch.dict(os.environ, {
'STRIPE_SECRET_KEY': 'sk_test_fake',
'FRONTEND_URL': 'https://gen.nomadkaraoke.com',
}):
from backend.services.stripe_service import StripeService
return StripeService()
def test_made_for_you_includes_order_type_metadata(self, stripe_service):
"""Test that made-for-you checkout includes order_type in metadata."""
with patch('stripe.checkout.Session.create') as mock_create:
mock_session = MagicMock()
mock_session.id = 'cs_test_123'
mock_session.url = 'https://checkout.stripe.com/test'
mock_create.return_value = mock_session
stripe_service.create_made_for_you_checkout_session(
customer_email='customer@example.com',
artist='Test Artist',
title='Test Song',
notes='Special request',
)
call_kwargs = mock_create.call_args[1]
metadata = call_kwargs['metadata']
assert metadata['order_type'] == 'made_for_you'
assert metadata['customer_email'] == 'customer@example.com'
assert metadata['artist'] == 'Test Artist'
assert metadata['title'] == 'Test Song'
assert metadata['notes'] == 'Special request'
def test_made_for_you_truncates_long_notes(self, stripe_service):
"""Test that notes longer than 500 chars are truncated."""
with patch('stripe.checkout.Session.create') as mock_create:
mock_session = MagicMock()
mock_session.id = 'cs_test_123'
mock_session.url = 'https://checkout.stripe.com/test'
mock_create.return_value = mock_session
long_notes = 'x' * 600
stripe_service.create_made_for_you_checkout_session(
customer_email='customer@example.com',
artist='Test Artist',
title='Test Song',
notes=long_notes,
)
call_kwargs = mock_create.call_args[1]
metadata = call_kwargs['metadata']
assert len(metadata['notes']) == 500
+350
View File
@@ -0,0 +1,350 @@
"""
Unit tests for tenant API routes.
Tests the /api/tenant/config endpoints.
Note: We need to patch get_tenant_service in both the routes module AND the
middleware module since the middleware runs first and also calls get_tenant_service.
"""
import pytest
from unittest.mock import MagicMock, patch
from fastapi.testclient import TestClient
from backend.models.tenant import (
TenantConfig,
TenantBranding,
TenantFeatures,
TenantDefaults,
TenantAuth,
TenantPublicConfig,
)
# Sample tenant config for mocking
SAMPLE_VOCALSTAR_CONFIG = TenantConfig(
id="vocalstar",
name="Vocal Star",
subdomain="vocalstar.nomadkaraoke.com",
is_active=True,
branding=TenantBranding(
logo_url="https://example.com/logo.png",
primary_color="#ffff00",
secondary_color="#006CF9",
site_title="Vocal Star Karaoke Generator",
),
features=TenantFeatures(
audio_search=False,
youtube_url=False,
youtube_upload=False,
dropbox_upload=False,
gdrive_upload=False,
theme_selection=False,
),
defaults=TenantDefaults(
theme_id="vocalstar",
locked_theme="vocalstar",
distribution_mode="download_only",
),
auth=TenantAuth(
allowed_email_domains=["vocal-star.com", "vocalstarmusic.com"],
require_email_domain=True,
sender_email="vocalstar@nomadkaraoke.com",
),
)
INACTIVE_CONFIG = TenantConfig(
id="inactive",
name="Inactive Tenant",
subdomain="inactive.nomadkaraoke.com",
is_active=False,
)
class TestTenantConfigEndpoint:
"""Tests for GET /api/tenant/config endpoint."""
@pytest.fixture
def mock_tenant_service(self):
"""Mock the tenant service in both routes and middleware."""
service = MagicMock()
# Patch in both places: routes AND middleware
with patch("backend.api.routes.tenant.get_tenant_service", return_value=service), \
patch("backend.middleware.tenant.get_tenant_service", return_value=service):
yield service
@pytest.fixture
def client(self, mock_tenant_service):
"""Create test client with mocked tenant service."""
from backend.main import app
return TestClient(app)
def test_get_config_default(self, client, mock_tenant_service):
"""Test returns default config when no tenant detected."""
mock_tenant_service.tenant_exists.return_value = False
response = client.get("/api/tenant/config")
assert response.status_code == 200
data = response.json()
assert data["tenant"] is None
assert data["is_default"] is True
def test_get_config_with_query_param(self, client, mock_tenant_service):
"""Test tenant detection via query parameter."""
public_config = TenantPublicConfig.from_config(SAMPLE_VOCALSTAR_CONFIG)
mock_tenant_service.get_public_config.return_value = public_config
response = client.get("/api/tenant/config?tenant=vocalstar")
assert response.status_code == 200
data = response.json()
assert data["tenant"]["id"] == "vocalstar"
assert data["tenant"]["name"] == "Vocal Star"
assert data["is_default"] is False
def test_get_config_with_header(self, client, mock_tenant_service):
"""Test tenant detection via X-Tenant-ID header."""
public_config = TenantPublicConfig.from_config(SAMPLE_VOCALSTAR_CONFIG)
mock_tenant_service.get_public_config.return_value = public_config
response = client.get(
"/api/tenant/config",
headers={"X-Tenant-ID": "vocalstar"},
)
assert response.status_code == 200
data = response.json()
assert data["tenant"]["id"] == "vocalstar"
assert data["is_default"] is False
def test_get_config_query_param_takes_priority(self, client, mock_tenant_service):
"""Test query param takes priority over header."""
public_config = TenantPublicConfig.from_config(SAMPLE_VOCALSTAR_CONFIG)
mock_tenant_service.get_public_config.return_value = public_config
response = client.get(
"/api/tenant/config?tenant=vocalstar",
headers={"X-Tenant-ID": "other"},
)
assert response.status_code == 200
# Should use vocalstar from query param
mock_tenant_service.get_public_config.assert_called_with("vocalstar")
def test_get_config_tenant_not_found(self, client, mock_tenant_service):
"""Test returns default when tenant not found."""
mock_tenant_service.get_public_config.return_value = None
response = client.get("/api/tenant/config?tenant=nonexistent")
assert response.status_code == 200
data = response.json()
assert data["tenant"] is None
assert data["is_default"] is True
def test_get_config_inactive_tenant(self, client, mock_tenant_service):
"""Test returns default when tenant is inactive."""
inactive_public = TenantPublicConfig.from_config(INACTIVE_CONFIG)
mock_tenant_service.get_public_config.return_value = inactive_public
response = client.get("/api/tenant/config?tenant=inactive")
assert response.status_code == 200
data = response.json()
assert data["tenant"] is None
assert data["is_default"] is True
def test_get_config_includes_branding(self, client, mock_tenant_service):
"""Test response includes full branding config."""
public_config = TenantPublicConfig.from_config(SAMPLE_VOCALSTAR_CONFIG)
mock_tenant_service.get_public_config.return_value = public_config
response = client.get("/api/tenant/config?tenant=vocalstar")
assert response.status_code == 200
data = response.json()
branding = data["tenant"]["branding"]
assert branding["primary_color"] == "#ffff00"
assert branding["secondary_color"] == "#006CF9"
assert branding["site_title"] == "Vocal Star Karaoke Generator"
def test_get_config_includes_features(self, client, mock_tenant_service):
"""Test response includes feature flags."""
public_config = TenantPublicConfig.from_config(SAMPLE_VOCALSTAR_CONFIG)
mock_tenant_service.get_public_config.return_value = public_config
response = client.get("/api/tenant/config?tenant=vocalstar")
assert response.status_code == 200
data = response.json()
features = data["tenant"]["features"]
assert features["audio_search"] is False
assert features["file_upload"] is True
assert features["youtube_upload"] is False
def test_get_config_includes_defaults(self, client, mock_tenant_service):
"""Test response includes default settings."""
public_config = TenantPublicConfig.from_config(SAMPLE_VOCALSTAR_CONFIG)
mock_tenant_service.get_public_config.return_value = public_config
response = client.get("/api/tenant/config?tenant=vocalstar")
assert response.status_code == 200
data = response.json()
defaults = data["tenant"]["defaults"]
assert defaults["theme_id"] == "vocalstar"
assert defaults["locked_theme"] == "vocalstar"
assert defaults["distribution_mode"] == "download_only"
def test_get_config_includes_allowed_domains(self, client, mock_tenant_service):
"""Test response includes allowed email domains."""
public_config = TenantPublicConfig.from_config(SAMPLE_VOCALSTAR_CONFIG)
mock_tenant_service.get_public_config.return_value = public_config
response = client.get("/api/tenant/config?tenant=vocalstar")
assert response.status_code == 200
data = response.json()
assert "vocal-star.com" in data["tenant"]["allowed_email_domains"]
assert "vocalstarmusic.com" in data["tenant"]["allowed_email_domains"]
class TestTenantConfigByIdEndpoint:
"""Tests for GET /api/tenant/config/{tenant_id} endpoint."""
@pytest.fixture
def mock_tenant_service(self):
"""Mock the tenant service in both routes and middleware."""
service = MagicMock()
with patch("backend.api.routes.tenant.get_tenant_service", return_value=service), \
patch("backend.middleware.tenant.get_tenant_service", return_value=service):
yield service
@pytest.fixture
def client(self, mock_tenant_service):
"""Create test client with mocked tenant service."""
from backend.main import app
return TestClient(app)
def test_get_config_by_id_success(self, client, mock_tenant_service):
"""Test getting config by explicit ID."""
public_config = TenantPublicConfig.from_config(SAMPLE_VOCALSTAR_CONFIG)
mock_tenant_service.get_public_config.return_value = public_config
response = client.get("/api/tenant/config/vocalstar")
assert response.status_code == 200
data = response.json()
assert data["tenant"]["id"] == "vocalstar"
assert data["is_default"] is False
def test_get_config_by_id_not_found(self, client, mock_tenant_service):
"""Test returns default when tenant ID not found."""
mock_tenant_service.get_public_config.return_value = None
response = client.get("/api/tenant/config/nonexistent")
assert response.status_code == 200
data = response.json()
assert data["tenant"] is None
assert data["is_default"] is True
def test_get_config_by_id_inactive(self, client, mock_tenant_service):
"""Test returns default when tenant is inactive."""
inactive_public = TenantPublicConfig.from_config(INACTIVE_CONFIG)
mock_tenant_service.get_public_config.return_value = inactive_public
response = client.get("/api/tenant/config/inactive")
assert response.status_code == 200
data = response.json()
assert data["tenant"] is None
assert data["is_default"] is True
class TestTenantAssetEndpoint:
"""Tests for GET /api/tenant/asset/{tenant_id}/{asset_name} endpoint."""
@pytest.fixture
def mock_tenant_service(self):
"""Mock the tenant service in both routes and middleware."""
service = MagicMock()
with patch("backend.api.routes.tenant.get_tenant_service", return_value=service), \
patch("backend.middleware.tenant.get_tenant_service", return_value=service):
yield service
@pytest.fixture
def client(self, mock_tenant_service):
"""Create test client with mocked tenant service."""
from backend.main import app
return TestClient(app)
def test_get_asset_redirects(self, client, mock_tenant_service):
"""Test asset endpoint redirects to signed URL."""
mock_tenant_service.get_asset_url.return_value = "https://storage.googleapis.com/signed-url"
response = client.get(
"/api/tenant/asset/vocalstar/logo.png",
follow_redirects=False,
)
# Should redirect (307 Temporary Redirect is FastAPI default)
assert response.status_code == 307
assert "storage.googleapis.com" in response.headers["location"]
def test_get_asset_not_found(self, client, mock_tenant_service):
"""Test returns 404 when asset not found."""
mock_tenant_service.get_asset_url.return_value = None
response = client.get("/api/tenant/asset/vocalstar/missing.png")
assert response.status_code == 404
assert "not found" in response.json()["detail"].lower()
class TestTenantConfigResponseSchema:
"""Tests for response schema validation."""
@pytest.fixture
def mock_tenant_service(self):
"""Mock the tenant service in both routes and middleware."""
service = MagicMock()
with patch("backend.api.routes.tenant.get_tenant_service", return_value=service), \
patch("backend.middleware.tenant.get_tenant_service", return_value=service):
yield service
@pytest.fixture
def client(self, mock_tenant_service):
"""Create test client with mocked tenant service."""
from backend.main import app
return TestClient(app)
def test_response_has_required_fields(self, client, mock_tenant_service):
"""Test response always has required fields."""
mock_tenant_service.tenant_exists.return_value = False
response = client.get("/api/tenant/config")
assert response.status_code == 200
data = response.json()
assert "tenant" in data
assert "is_default" in data
def test_tenant_config_excludes_sensitive_fields(self, client, mock_tenant_service):
"""Test public config doesn't include sensitive auth data."""
public_config = TenantPublicConfig.from_config(SAMPLE_VOCALSTAR_CONFIG)
mock_tenant_service.get_public_config.return_value = public_config
response = client.get("/api/tenant/config?tenant=vocalstar")
assert response.status_code == 200
data = response.json()
tenant = data["tenant"]
# Should NOT have full auth object
assert "auth" not in tenant
# Should NOT have sensitive defaults
assert tenant["defaults"].get("brand_prefix") is None
# Should have allowed_email_domains at top level
assert "allowed_email_domains" in tenant
+345
View File
@@ -0,0 +1,345 @@
"""
Unit tests for TenantMiddleware.
Tests tenant detection from headers, query params, and subdomains,
as well as request state attachment.
"""
import pytest
from unittest.mock import MagicMock, patch, AsyncMock
import os
from starlette.requests import Request
from starlette.datastructures import Headers
from starlette.responses import Response
from backend.middleware.tenant import (
TenantMiddleware,
get_tenant_from_request,
get_tenant_config_from_request,
NON_TENANT_SUBDOMAINS,
)
from backend.models.tenant import TenantConfig, TenantFeatures
# Sample tenant config for mocking
SAMPLE_CONFIG = TenantConfig(
id="vocalstar",
name="Vocal Star",
subdomain="vocalstar.nomadkaraoke.com",
is_active=True,
features=TenantFeatures(audio_search=False),
)
INACTIVE_CONFIG = TenantConfig(
id="inactive",
name="Inactive",
subdomain="inactive.nomadkaraoke.com",
is_active=False,
)
class MockRequest:
"""Mock Request object for testing."""
def __init__(self, headers=None, query_params=None):
self.headers = headers or {}
self.query_params = query_params or {}
self.url = MagicMock()
self.url.path = "/api/test"
self.state = MagicMock()
class TestTenantMiddleware:
"""Tests for TenantMiddleware class."""
@pytest.fixture
def middleware(self):
"""Create middleware instance."""
app = MagicMock()
return TenantMiddleware(app)
@pytest.fixture
def mock_tenant_service(self):
"""Create mock tenant service."""
with patch("backend.middleware.tenant.get_tenant_service") as mock:
service = MagicMock()
mock.return_value = service
yield service
# Tests for _extract_tenant_from_host()
def test_extract_tenant_from_host_standard_subdomain(self, middleware, mock_tenant_service):
"""Test extracting tenant from vocalstar.nomadkaraoke.com."""
mock_tenant_service.tenant_exists.return_value = True
tenant_id = middleware._extract_tenant_from_host("vocalstar.nomadkaraoke.com")
assert tenant_id == "vocalstar"
def test_extract_tenant_from_host_gen_subdomain(self, middleware, mock_tenant_service):
"""Test extracting tenant from vocalstar.gen.nomadkaraoke.com."""
mock_tenant_service.tenant_exists.return_value = True
tenant_id = middleware._extract_tenant_from_host("vocalstar.gen.nomadkaraoke.com")
assert tenant_id == "vocalstar"
def test_extract_tenant_from_host_with_port(self, middleware, mock_tenant_service):
"""Test extracting tenant when host includes port."""
mock_tenant_service.tenant_exists.return_value = True
tenant_id = middleware._extract_tenant_from_host("vocalstar.nomadkaraoke.com:443")
assert tenant_id == "vocalstar"
def test_extract_tenant_from_host_case_insensitive(self, middleware, mock_tenant_service):
"""Test host parsing is case insensitive."""
mock_tenant_service.tenant_exists.return_value = True
tenant_id = middleware._extract_tenant_from_host("VOCALSTAR.NomadKaraoke.COM")
assert tenant_id == "vocalstar"
def test_extract_tenant_from_host_empty(self, middleware):
"""Test returns None for empty host."""
tenant_id = middleware._extract_tenant_from_host("")
assert tenant_id is None
def test_extract_tenant_from_host_localhost(self, middleware):
"""Test returns None for localhost."""
tenant_id = middleware._extract_tenant_from_host("localhost:3000")
assert tenant_id is None
def test_extract_tenant_from_host_non_nomad_domain(self, middleware):
"""Test returns None for non-nomadkaraoke.com domains."""
tenant_id = middleware._extract_tenant_from_host("example.com")
assert tenant_id is None
def test_extract_tenant_from_host_base_domain(self, middleware):
"""Test returns None for nomadkaraoke.com without subdomain."""
tenant_id = middleware._extract_tenant_from_host("nomadkaraoke.com")
assert tenant_id is None
@pytest.mark.parametrize("subdomain", NON_TENANT_SUBDOMAINS)
def test_extract_tenant_from_host_non_tenant_subdomains(self, middleware, subdomain):
"""Test returns None for known non-tenant subdomains."""
host = f"{subdomain}.nomadkaraoke.com"
tenant_id = middleware._extract_tenant_from_host(host)
assert tenant_id is None
def test_extract_tenant_from_host_tenant_not_exists(self, middleware, mock_tenant_service):
"""Test returns None when tenant doesn't exist in GCS."""
mock_tenant_service.tenant_exists.return_value = False
tenant_id = middleware._extract_tenant_from_host("nonexistent.nomadkaraoke.com")
assert tenant_id is None
# Tests for _extract_tenant_id()
def test_extract_tenant_id_from_header(self, middleware):
"""Test X-Tenant-ID header takes priority."""
request = MockRequest(
headers={"X-Tenant-ID": "vocalstar", "Host": "other.nomadkaraoke.com"},
query_params={"tenant": "different"},
)
tenant_id = middleware._extract_tenant_id(request)
assert tenant_id == "vocalstar"
def test_extract_tenant_id_header_normalized(self, middleware):
"""Test header value is normalized (lowercased, stripped)."""
request = MockRequest(headers={"X-Tenant-ID": " VOCALSTAR "})
tenant_id = middleware._extract_tenant_id(request)
assert tenant_id == "vocalstar"
@patch.dict(os.environ, {"ENV": ""})
def test_extract_tenant_id_from_query_param_dev(self, middleware):
"""Test query param works in non-production."""
request = MockRequest(query_params={"tenant": "vocalstar"})
tenant_id = middleware._extract_tenant_id(request)
assert tenant_id == "vocalstar"
@patch.dict(os.environ, {"ENV": "production"})
def test_extract_tenant_id_query_param_disabled_in_prod(self, middleware, mock_tenant_service):
"""Test query param is ignored in production."""
# Need to reimport to pick up new env value
import importlib
import backend.middleware.tenant as tenant_module
# Save original value
original_is_prod = tenant_module.IS_PRODUCTION
# Temporarily set to True for this test
tenant_module.IS_PRODUCTION = True
try:
mock_tenant_service.tenant_exists.return_value = False
request = MockRequest(
query_params={"tenant": "vocalstar"},
headers={"Host": "gen.nomadkaraoke.com"},
)
tenant_id = middleware._extract_tenant_id(request)
# Should not use query param, and gen subdomain is non-tenant
assert tenant_id is None
finally:
# Restore
tenant_module.IS_PRODUCTION = original_is_prod
def test_extract_tenant_id_from_host(self, middleware, mock_tenant_service):
"""Test falls back to host header subdomain detection."""
mock_tenant_service.tenant_exists.return_value = True
request = MockRequest(headers={"Host": "vocalstar.nomadkaraoke.com"})
tenant_id = middleware._extract_tenant_id(request)
assert tenant_id == "vocalstar"
def test_extract_tenant_id_no_tenant(self, middleware, mock_tenant_service):
"""Test returns None when no tenant detected."""
mock_tenant_service.tenant_exists.return_value = False
request = MockRequest(headers={"Host": "gen.nomadkaraoke.com"})
tenant_id = middleware._extract_tenant_id(request)
assert tenant_id is None
# Tests for dispatch()
@pytest.mark.asyncio
async def test_dispatch_attaches_tenant_to_state(self, middleware, mock_tenant_service):
"""Test middleware attaches tenant info to request.state."""
mock_tenant_service.get_tenant_config.return_value = SAMPLE_CONFIG
mock_tenant_service.tenant_exists.return_value = True
request = MockRequest(headers={"X-Tenant-ID": "vocalstar"})
response = Response(content="OK")
call_next = AsyncMock(return_value=response)
result = await middleware.dispatch(request, call_next)
assert request.state.tenant_id == "vocalstar"
assert request.state.tenant_config == SAMPLE_CONFIG
@pytest.mark.asyncio
async def test_dispatch_adds_header_to_response(self, middleware, mock_tenant_service):
"""Test middleware adds X-Tenant-ID header to response."""
mock_tenant_service.get_tenant_config.return_value = SAMPLE_CONFIG
mock_tenant_service.tenant_exists.return_value = True
request = MockRequest(headers={"X-Tenant-ID": "vocalstar"})
response = Response(content="OK")
call_next = AsyncMock(return_value=response)
result = await middleware.dispatch(request, call_next)
assert result.headers.get("X-Tenant-ID") == "vocalstar"
@pytest.mark.asyncio
async def test_dispatch_no_tenant(self, middleware, mock_tenant_service):
"""Test middleware handles no tenant gracefully."""
mock_tenant_service.tenant_exists.return_value = False
request = MockRequest(headers={"Host": "gen.nomadkaraoke.com"})
response = Response(content="OK")
call_next = AsyncMock(return_value=response)
result = await middleware.dispatch(request, call_next)
assert request.state.tenant_id is None
assert request.state.tenant_config is None
assert "X-Tenant-ID" not in result.headers
@pytest.mark.asyncio
async def test_dispatch_inactive_tenant(self, middleware, mock_tenant_service):
"""Test middleware treats inactive tenant as no tenant."""
mock_tenant_service.get_tenant_config.return_value = INACTIVE_CONFIG
request = MockRequest(headers={"X-Tenant-ID": "inactive"})
response = Response(content="OK")
call_next = AsyncMock(return_value=response)
result = await middleware.dispatch(request, call_next)
# Inactive tenant should be treated as default
assert request.state.tenant_id is None
assert request.state.tenant_config is None
@pytest.mark.asyncio
async def test_dispatch_calls_next(self, middleware, mock_tenant_service):
"""Test middleware calls the next handler."""
mock_tenant_service.tenant_exists.return_value = False
request = MockRequest(headers={"Host": "gen.nomadkaraoke.com"})
response = Response(content="OK")
call_next = AsyncMock(return_value=response)
await middleware.dispatch(request, call_next)
call_next.assert_called_once_with(request)
class TestHelperFunctions:
"""Tests for helper functions."""
def test_get_tenant_from_request(self):
"""Test get_tenant_from_request helper."""
request = MagicMock()
request.state.tenant_id = "vocalstar"
assert get_tenant_from_request(request) == "vocalstar"
def test_get_tenant_from_request_none(self):
"""Test get_tenant_from_request when no tenant."""
request = MagicMock()
del request.state.tenant_id # Simulate missing attribute
assert get_tenant_from_request(request) is None
def test_get_tenant_config_from_request(self):
"""Test get_tenant_config_from_request helper."""
request = MagicMock()
request.state.tenant_config = SAMPLE_CONFIG
config = get_tenant_config_from_request(request)
assert config == SAMPLE_CONFIG
assert config.features.audio_search is False
def test_get_tenant_config_from_request_none(self):
"""Test get_tenant_config_from_request when no config."""
request = MagicMock()
del request.state.tenant_config
assert get_tenant_config_from_request(request) is None
class TestNonTenantSubdomains:
"""Tests for NON_TENANT_SUBDOMAINS constant."""
def test_gen_is_non_tenant(self):
"""Test 'gen' is in non-tenant subdomains."""
assert "gen" in NON_TENANT_SUBDOMAINS
def test_api_is_non_tenant(self):
"""Test 'api' is in non-tenant subdomains."""
assert "api" in NON_TENANT_SUBDOMAINS
def test_www_is_non_tenant(self):
"""Test 'www' is in non-tenant subdomains."""
assert "www" in NON_TENANT_SUBDOMAINS
def test_admin_is_non_tenant(self):
"""Test 'admin' is in non-tenant subdomains."""
assert "admin" in NON_TENANT_SUBDOMAINS
+406
View File
@@ -0,0 +1,406 @@
"""
Unit tests for tenant data models.
Tests the TenantConfig, TenantBranding, TenantFeatures, TenantDefaults,
TenantAuth, and TenantPublicConfig models.
"""
import pytest
from datetime import datetime
from backend.models.tenant import (
TenantConfig,
TenantBranding,
TenantFeatures,
TenantDefaults,
TenantAuth,
TenantPublicConfig,
TenantConfigResponse,
)
class TestTenantBranding:
"""Tests for TenantBranding model."""
def test_default_values(self):
"""Test that TenantBranding has sensible defaults."""
branding = TenantBranding()
assert branding.logo_url is None
assert branding.logo_height == 40
assert branding.primary_color == "#ff5bb8"
assert branding.secondary_color == "#8b5cf6"
assert branding.accent_color is None
assert branding.background_color is None
assert branding.favicon_url is None
assert branding.site_title == "Karaoke Generator"
assert branding.tagline is None
def test_custom_values(self):
"""Test TenantBranding with custom values."""
branding = TenantBranding(
logo_url="https://example.com/logo.png",
logo_height=60,
primary_color="#ffff00",
secondary_color="#0000ff",
accent_color="#ff0000",
background_color="#000000",
favicon_url="https://example.com/favicon.ico",
site_title="Custom Karaoke",
tagline="Make music magic",
)
assert branding.logo_url == "https://example.com/logo.png"
assert branding.logo_height == 60
assert branding.primary_color == "#ffff00"
assert branding.site_title == "Custom Karaoke"
class TestTenantFeatures:
"""Tests for TenantFeatures model."""
def test_default_features_enabled(self):
"""Test that most features are enabled by default."""
features = TenantFeatures()
# Input methods
assert features.audio_search is True
assert features.file_upload is True
assert features.youtube_url is True
# Distribution
assert features.youtube_upload is True
assert features.dropbox_upload is True
assert features.gdrive_upload is True
# Customization
assert features.theme_selection is True
assert features.color_overrides is True
# Output formats
assert features.enable_cdg is True
assert features.enable_4k is True
# Admin is disabled by default
assert features.admin_access is False
def test_restricted_features(self):
"""Test a restricted feature set like Vocal Star would have."""
features = TenantFeatures(
audio_search=False,
youtube_url=False,
youtube_upload=False,
dropbox_upload=False,
gdrive_upload=False,
theme_selection=False,
color_overrides=False,
)
assert features.audio_search is False
assert features.file_upload is True # Still allowed
assert features.youtube_url is False
assert features.youtube_upload is False
class TestTenantDefaults:
"""Tests for TenantDefaults model."""
def test_default_values(self):
"""Test TenantDefaults has sensible defaults."""
defaults = TenantDefaults()
assert defaults.theme_id is None
assert defaults.locked_theme is None
assert defaults.distribution_mode == "all"
assert defaults.brand_prefix is None
assert defaults.youtube_description_template is None
def test_locked_theme(self):
"""Test locked_theme setting."""
defaults = TenantDefaults(
theme_id="vocalstar",
locked_theme="vocalstar",
distribution_mode="download_only",
brand_prefix="VSTAR",
)
assert defaults.locked_theme == "vocalstar"
assert defaults.distribution_mode == "download_only"
assert defaults.brand_prefix == "VSTAR"
class TestTenantAuth:
"""Tests for TenantAuth model."""
def test_default_values(self):
"""Test TenantAuth defaults."""
auth = TenantAuth()
assert auth.allowed_email_domains == []
assert auth.require_email_domain is True
assert auth.fixed_token_ids == []
assert auth.sender_email is None
def test_restricted_domains(self):
"""Test restricted email domains configuration."""
auth = TenantAuth(
allowed_email_domains=["vocal-star.com", "vocalstarmusic.com"],
require_email_domain=True,
sender_email="vocalstar@nomadkaraoke.com",
)
assert "vocal-star.com" in auth.allowed_email_domains
assert auth.require_email_domain is True
assert auth.sender_email == "vocalstar@nomadkaraoke.com"
class TestTenantConfig:
"""Tests for TenantConfig model."""
@pytest.fixture
def basic_config(self):
"""Create a basic tenant config for testing."""
return TenantConfig(
id="vocalstar",
name="Vocal Star",
subdomain="vocalstar.nomadkaraoke.com",
)
@pytest.fixture
def full_config(self):
"""Create a fully configured tenant."""
return TenantConfig(
id="vocalstar",
name="Vocal Star",
subdomain="vocalstar.nomadkaraoke.com",
is_active=True,
branding=TenantBranding(
logo_url="https://example.com/logo.png",
primary_color="#ffff00",
secondary_color="#006CF9",
site_title="Vocal Star Karaoke Generator",
),
features=TenantFeatures(
audio_search=False,
youtube_url=False,
youtube_upload=False,
dropbox_upload=False,
gdrive_upload=False,
theme_selection=False,
),
defaults=TenantDefaults(
theme_id="vocalstar",
locked_theme="vocalstar",
distribution_mode="download_only",
),
auth=TenantAuth(
allowed_email_domains=["vocal-star.com", "vocalstarmusic.com"],
require_email_domain=True,
sender_email="vocalstar@nomadkaraoke.com",
),
)
def test_required_fields(self):
"""Test that id, name, and subdomain are required."""
config = TenantConfig(
id="test",
name="Test Tenant",
subdomain="test.nomadkaraoke.com",
)
assert config.id == "test"
assert config.name == "Test Tenant"
assert config.subdomain == "test.nomadkaraoke.com"
def test_default_is_active(self, basic_config):
"""Test that tenants are active by default."""
assert basic_config.is_active is True
def test_nested_models_have_defaults(self, basic_config):
"""Test that nested models are created with defaults."""
assert basic_config.branding is not None
assert basic_config.features is not None
assert basic_config.defaults is not None
assert basic_config.auth is not None
# Tests for get_sender_email()
def test_get_sender_email_custom(self, full_config):
"""Test get_sender_email returns custom sender when configured."""
assert full_config.get_sender_email() == "vocalstar@nomadkaraoke.com"
def test_get_sender_email_default_pattern(self, basic_config):
"""Test get_sender_email returns default pattern when not configured."""
# basic_config has no custom sender_email
assert basic_config.get_sender_email() == "vocalstar@nomadkaraoke.com"
def test_get_sender_email_different_tenant(self):
"""Test sender email follows tenant ID pattern."""
config = TenantConfig(
id="customtenant",
name="Custom",
subdomain="custom.nomadkaraoke.com",
)
assert config.get_sender_email() == "customtenant@nomadkaraoke.com"
# Tests for is_email_allowed()
def test_is_email_allowed_matching_domain(self, full_config):
"""Test email is allowed when domain matches."""
assert full_config.is_email_allowed("user@vocal-star.com") is True
assert full_config.is_email_allowed("user@vocalstarmusic.com") is True
def test_is_email_allowed_non_matching_domain(self, full_config):
"""Test email is rejected when domain doesn't match and require_email_domain=True."""
assert full_config.is_email_allowed("user@gmail.com") is False
assert full_config.is_email_allowed("user@other.com") is False
def test_is_email_allowed_case_insensitive(self, full_config):
"""Test email domain matching is case insensitive."""
assert full_config.is_email_allowed("User@VOCAL-STAR.COM") is True
assert full_config.is_email_allowed("User@VocalStarMusic.com") is True
def test_is_email_allowed_no_domain_restrictions(self, basic_config):
"""Test any email allowed when no domain restrictions."""
# basic_config has empty allowed_email_domains
assert basic_config.is_email_allowed("anyone@gmail.com") is True
assert basic_config.is_email_allowed("user@anything.com") is True
def test_is_email_allowed_require_domain_false(self):
"""Test non-matching emails allowed when require_email_domain=False."""
config = TenantConfig(
id="flexible",
name="Flexible Tenant",
subdomain="flexible.nomadkaraoke.com",
auth=TenantAuth(
allowed_email_domains=["preferred.com"],
require_email_domain=False, # Don't require matching
),
)
# Matching domain still works
assert config.is_email_allowed("user@preferred.com") is True
# Non-matching also allowed since require_email_domain=False
assert config.is_email_allowed("user@other.com") is True
def test_is_email_allowed_partial_domain_no_match(self, full_config):
"""Test partial domain matches don't work (must be exact suffix)."""
# "star.com" should not match "vocal-star.com"
assert full_config.is_email_allowed("user@star.com") is False
# Subdomain of allowed domain should work
assert full_config.is_email_allowed("user@sub.vocal-star.com") is False
class TestTenantPublicConfig:
"""Tests for TenantPublicConfig model."""
@pytest.fixture
def full_config(self):
"""Create a fully configured tenant for conversion testing."""
return TenantConfig(
id="vocalstar",
name="Vocal Star",
subdomain="vocalstar.nomadkaraoke.com",
is_active=True,
branding=TenantBranding(
logo_url="https://example.com/logo.png",
primary_color="#ffff00",
),
features=TenantFeatures(
audio_search=False,
admin_access=True, # This should be included in public config
),
defaults=TenantDefaults(
theme_id="vocalstar",
locked_theme="vocalstar",
distribution_mode="download_only",
brand_prefix="VSTAR", # This should NOT be in public config
youtube_description_template="Custom template", # This should NOT be in public config
),
auth=TenantAuth(
allowed_email_domains=["vocal-star.com"],
require_email_domain=True,
fixed_token_ids=["secret-token-123"], # This should NOT be in public config
sender_email="vocalstar@nomadkaraoke.com", # This should NOT be in public config
),
)
def test_from_config_basic_fields(self, full_config):
"""Test that basic fields are copied correctly."""
public = TenantPublicConfig.from_config(full_config)
assert public.id == "vocalstar"
assert public.name == "Vocal Star"
assert public.subdomain == "vocalstar.nomadkaraoke.com"
assert public.is_active is True
def test_from_config_branding_included(self, full_config):
"""Test that branding is fully included."""
public = TenantPublicConfig.from_config(full_config)
assert public.branding.logo_url == "https://example.com/logo.png"
assert public.branding.primary_color == "#ffff00"
def test_from_config_features_included(self, full_config):
"""Test that features are fully included."""
public = TenantPublicConfig.from_config(full_config)
assert public.features.audio_search is False
assert public.features.admin_access is True
def test_from_config_allowed_email_domains_included(self, full_config):
"""Test that allowed_email_domains is included for frontend validation."""
public = TenantPublicConfig.from_config(full_config)
assert "vocal-star.com" in public.allowed_email_domains
def test_from_config_sensitive_auth_excluded(self, full_config):
"""Test that sensitive auth fields are not in public config."""
public = TenantPublicConfig.from_config(full_config)
# TenantPublicConfig only has allowed_email_domains from auth
# It should NOT have fixed_token_ids or sender_email
assert not hasattr(public, 'auth')
# allowed_email_domains is a top-level field
assert hasattr(public, 'allowed_email_domains')
def test_from_config_defaults_partially_included(self, full_config):
"""Test that only safe defaults are included."""
public = TenantPublicConfig.from_config(full_config)
# These should be included
assert public.defaults.theme_id == "vocalstar"
assert public.defaults.locked_theme == "vocalstar"
assert public.defaults.distribution_mode == "download_only"
# brand_prefix and youtube_description_template should NOT be included
# The from_config method creates a new TenantDefaults without these
assert public.defaults.brand_prefix is None
assert public.defaults.youtube_description_template is None
class TestTenantConfigResponse:
"""Tests for TenantConfigResponse model."""
def test_default_response(self):
"""Test default response indicates no tenant."""
response = TenantConfigResponse()
assert response.tenant is None
assert response.is_default is True
def test_tenant_response(self):
"""Test response with tenant config."""
public_config = TenantPublicConfig(
id="vocalstar",
name="Vocal Star",
subdomain="vocalstar.nomadkaraoke.com",
is_active=True,
branding=TenantBranding(),
features=TenantFeatures(),
defaults=TenantDefaults(),
)
response = TenantConfigResponse(tenant=public_config, is_default=False)
assert response.tenant is not None
assert response.tenant.id == "vocalstar"
assert response.is_default is False
+418
View File
@@ -0,0 +1,418 @@
"""
Unit tests for TenantService.
Tests config loading from GCS, caching behavior, subdomain resolution,
and email domain validation.
"""
import pytest
from datetime import datetime, timedelta
from unittest.mock import MagicMock, patch
from backend.services.tenant_service import TenantService, get_tenant_service
from backend.models.tenant import TenantConfig, TenantPublicConfig
# Sample tenant config data that would come from GCS
SAMPLE_VOCALSTAR_CONFIG = {
"id": "vocalstar",
"name": "Vocal Star",
"subdomain": "vocalstar.nomadkaraoke.com",
"is_active": True,
"branding": {
"logo_url": "https://example.com/logo.png",
"logo_height": 50,
"primary_color": "#ffff00",
"secondary_color": "#006CF9",
"site_title": "Vocal Star Karaoke Generator",
},
"features": {
"audio_search": False,
"file_upload": True,
"youtube_url": False,
"youtube_upload": False,
"dropbox_upload": False,
"gdrive_upload": False,
"theme_selection": False,
},
"defaults": {
"theme_id": "vocalstar",
"locked_theme": "vocalstar",
"distribution_mode": "download_only",
},
"auth": {
"allowed_email_domains": ["vocal-star.com", "vocalstarmusic.com"],
"require_email_domain": True,
"sender_email": "vocalstar@nomadkaraoke.com",
},
}
SAMPLE_INACTIVE_CONFIG = {
"id": "inactive",
"name": "Inactive Tenant",
"subdomain": "inactive.nomadkaraoke.com",
"is_active": False,
"branding": {},
"features": {},
"defaults": {},
"auth": {},
}
class TestTenantService:
"""Tests for TenantService class."""
@pytest.fixture
def mock_storage(self):
"""Create a mock StorageService."""
storage = MagicMock()
storage.file_exists.return_value = False
storage.download_json.return_value = {}
storage.generate_signed_url.return_value = "https://signed-url.example.com"
return storage
@pytest.fixture
def tenant_service(self, mock_storage):
"""Create a TenantService with mock storage."""
return TenantService(storage=mock_storage)
# Tests for get_tenant_config()
def test_get_tenant_config_success(self, tenant_service, mock_storage):
"""Test successful config loading from GCS."""
mock_storage.file_exists.return_value = True
mock_storage.download_json.return_value = SAMPLE_VOCALSTAR_CONFIG
config = tenant_service.get_tenant_config("vocalstar")
assert config is not None
assert config.id == "vocalstar"
assert config.name == "Vocal Star"
assert config.features.audio_search is False
mock_storage.download_json.assert_called_once_with("tenants/vocalstar/config.json")
def test_get_tenant_config_not_found(self, tenant_service, mock_storage):
"""Test returns None when tenant config doesn't exist."""
mock_storage.file_exists.return_value = False
config = tenant_service.get_tenant_config("nonexistent")
assert config is None
mock_storage.download_json.assert_not_called()
def test_get_tenant_config_gcs_error(self, tenant_service, mock_storage):
"""Test handles GCS errors gracefully."""
mock_storage.file_exists.return_value = True
mock_storage.download_json.side_effect = Exception("GCS error")
config = tenant_service.get_tenant_config("vocalstar")
assert config is None
# Tests for caching behavior
def test_config_is_cached(self, tenant_service, mock_storage):
"""Test that configs are cached after first load."""
mock_storage.file_exists.return_value = True
mock_storage.download_json.return_value = SAMPLE_VOCALSTAR_CONFIG
# First call loads from GCS
config1 = tenant_service.get_tenant_config("vocalstar")
# Second call should use cache
config2 = tenant_service.get_tenant_config("vocalstar")
assert config1 is config2
# download_json should only be called once
assert mock_storage.download_json.call_count == 1
def test_force_refresh_bypasses_cache(self, tenant_service, mock_storage):
"""Test that force_refresh reloads from GCS."""
mock_storage.file_exists.return_value = True
mock_storage.download_json.return_value = SAMPLE_VOCALSTAR_CONFIG
# First call
tenant_service.get_tenant_config("vocalstar")
# Force refresh
tenant_service.get_tenant_config("vocalstar", force_refresh=True)
# download_json should be called twice
assert mock_storage.download_json.call_count == 2
def test_cache_expires_after_ttl(self, tenant_service, mock_storage):
"""Test that cache expires after TTL."""
mock_storage.file_exists.return_value = True
mock_storage.download_json.return_value = SAMPLE_VOCALSTAR_CONFIG
# Load config
tenant_service.get_tenant_config("vocalstar")
# Simulate cache expiration by manipulating cache time
tenant_service._cache_times["vocalstar"] = datetime.now() - timedelta(seconds=400)
# Next call should reload
tenant_service.get_tenant_config("vocalstar")
assert mock_storage.download_json.call_count == 2
# Tests for get_tenant_by_subdomain()
def test_get_tenant_by_subdomain_cached(self, tenant_service, mock_storage):
"""Test subdomain lookup uses cache."""
mock_storage.file_exists.return_value = True
mock_storage.download_json.return_value = SAMPLE_VOCALSTAR_CONFIG
# First load by ID to populate cache
tenant_service.get_tenant_config("vocalstar")
# Now lookup by subdomain should use cached mapping
config = tenant_service.get_tenant_by_subdomain("vocalstar.nomadkaraoke.com")
assert config is not None
assert config.id == "vocalstar"
def test_get_tenant_by_subdomain_fallback_resolution(self, tenant_service, mock_storage):
"""Test subdomain resolution when not in cache."""
mock_storage.file_exists.return_value = True
mock_storage.download_json.return_value = SAMPLE_VOCALSTAR_CONFIG
# Lookup by subdomain without prior cache
config = tenant_service.get_tenant_by_subdomain("vocalstar.nomadkaraoke.com")
assert config is not None
assert config.id == "vocalstar"
def test_get_tenant_by_subdomain_not_found(self, tenant_service, mock_storage):
"""Test returns None for unknown subdomain."""
mock_storage.file_exists.return_value = False
config = tenant_service.get_tenant_by_subdomain("unknown.nomadkaraoke.com")
assert config is None
def test_get_tenant_by_subdomain_case_insensitive(self, tenant_service, mock_storage):
"""Test subdomain lookup is case insensitive."""
mock_storage.file_exists.return_value = True
mock_storage.download_json.return_value = SAMPLE_VOCALSTAR_CONFIG
config = tenant_service.get_tenant_by_subdomain("VOCALSTAR.NomadKaraoke.COM")
assert config is not None
assert config.id == "vocalstar"
# Tests for _resolve_subdomain_to_tenant_id()
def test_resolve_subdomain_3_parts(self, tenant_service, mock_storage):
"""Test resolving tenant.nomadkaraoke.com pattern."""
mock_storage.file_exists.return_value = True
tenant_id = tenant_service._resolve_subdomain_to_tenant_id("vocalstar.nomadkaraoke.com")
assert tenant_id == "vocalstar"
def test_resolve_subdomain_4_parts(self, tenant_service, mock_storage):
"""Test resolving tenant.gen.nomadkaraoke.com pattern."""
mock_storage.file_exists.return_value = True
tenant_id = tenant_service._resolve_subdomain_to_tenant_id("vocalstar.gen.nomadkaraoke.com")
assert tenant_id == "vocalstar"
def test_resolve_subdomain_too_short(self, tenant_service, mock_storage):
"""Test returns None for subdomains with fewer than 3 parts."""
tenant_id = tenant_service._resolve_subdomain_to_tenant_id("nomadkaraoke.com")
assert tenant_id is None
def test_resolve_subdomain_tenant_not_exists(self, tenant_service, mock_storage):
"""Test returns None when tenant config doesn't exist in GCS."""
mock_storage.file_exists.return_value = False
tenant_id = tenant_service._resolve_subdomain_to_tenant_id("nonexistent.nomadkaraoke.com")
assert tenant_id is None
# Tests for get_public_config()
def test_get_public_config_success(self, tenant_service, mock_storage):
"""Test getting public config."""
mock_storage.file_exists.return_value = True
mock_storage.download_json.return_value = SAMPLE_VOCALSTAR_CONFIG
public_config = tenant_service.get_public_config("vocalstar")
assert public_config is not None
assert isinstance(public_config, TenantPublicConfig)
assert public_config.id == "vocalstar"
def test_get_public_config_not_found(self, tenant_service, mock_storage):
"""Test returns None when tenant not found."""
mock_storage.file_exists.return_value = False
public_config = tenant_service.get_public_config("nonexistent")
assert public_config is None
def test_get_public_config_by_subdomain(self, tenant_service, mock_storage):
"""Test getting public config by subdomain."""
mock_storage.file_exists.return_value = True
mock_storage.download_json.return_value = SAMPLE_VOCALSTAR_CONFIG
public_config = tenant_service.get_public_config_by_subdomain("vocalstar.nomadkaraoke.com")
assert public_config is not None
assert public_config.id == "vocalstar"
# Tests for tenant_exists()
def test_tenant_exists_true(self, tenant_service, mock_storage):
"""Test returns True when config exists."""
mock_storage.file_exists.return_value = True
assert tenant_service.tenant_exists("vocalstar") is True
mock_storage.file_exists.assert_called_with("tenants/vocalstar/config.json")
def test_tenant_exists_false(self, tenant_service, mock_storage):
"""Test returns False when config doesn't exist."""
mock_storage.file_exists.return_value = False
assert tenant_service.tenant_exists("nonexistent") is False
# Tests for is_email_allowed_for_tenant()
def test_is_email_allowed_for_tenant_valid(self, tenant_service, mock_storage):
"""Test email allowed for valid domain."""
mock_storage.file_exists.return_value = True
mock_storage.download_json.return_value = SAMPLE_VOCALSTAR_CONFIG
assert tenant_service.is_email_allowed_for_tenant("vocalstar", "user@vocal-star.com") is True
def test_is_email_allowed_for_tenant_invalid(self, tenant_service, mock_storage):
"""Test email not allowed for invalid domain."""
mock_storage.file_exists.return_value = True
mock_storage.download_json.return_value = SAMPLE_VOCALSTAR_CONFIG
assert tenant_service.is_email_allowed_for_tenant("vocalstar", "user@gmail.com") is False
def test_is_email_allowed_for_tenant_not_found(self, tenant_service, mock_storage):
"""Test returns False when tenant not found."""
mock_storage.file_exists.return_value = False
assert tenant_service.is_email_allowed_for_tenant("nonexistent", "user@any.com") is False
# Tests for get_tenant_sender_email()
def test_get_tenant_sender_email_custom(self, tenant_service, mock_storage):
"""Test returns custom sender email when configured."""
mock_storage.file_exists.return_value = True
mock_storage.download_json.return_value = SAMPLE_VOCALSTAR_CONFIG
sender = tenant_service.get_tenant_sender_email("vocalstar")
assert sender == "vocalstar@nomadkaraoke.com"
def test_get_tenant_sender_email_default(self, tenant_service, mock_storage):
"""Test returns default sender when tenant not found."""
mock_storage.file_exists.return_value = False
sender = tenant_service.get_tenant_sender_email("nonexistent")
# Should match DEFAULT_SENDER_EMAIL constant (consistent with EmailService)
assert sender == "gen@nomadkaraoke.com"
# Tests for invalidate_cache()
def test_invalidate_cache_specific_tenant(self, tenant_service, mock_storage):
"""Test invalidating cache for specific tenant."""
mock_storage.file_exists.return_value = True
mock_storage.download_json.return_value = SAMPLE_VOCALSTAR_CONFIG
# Load into cache
tenant_service.get_tenant_config("vocalstar")
assert "vocalstar" in tenant_service._config_cache
# Invalidate
tenant_service.invalidate_cache("vocalstar")
assert "vocalstar" not in tenant_service._config_cache
assert "vocalstar" not in tenant_service._cache_times
def test_invalidate_cache_specific_tenant_clears_subdomain_map(self, tenant_service, mock_storage):
"""Test invalidating specific tenant also clears its subdomain map entry."""
mock_storage.file_exists.return_value = True
mock_storage.download_json.return_value = SAMPLE_VOCALSTAR_CONFIG
# Load into cache (this also populates subdomain map)
tenant_service.get_tenant_config("vocalstar")
assert "vocalstar.nomadkaraoke.com" in tenant_service._subdomain_map
assert tenant_service._subdomain_map["vocalstar.nomadkaraoke.com"] == "vocalstar"
# Invalidate specific tenant
tenant_service.invalidate_cache("vocalstar")
# Subdomain map entry should also be removed
assert "vocalstar.nomadkaraoke.com" not in tenant_service._subdomain_map
def test_invalidate_cache_all(self, tenant_service, mock_storage):
"""Test invalidating all caches."""
mock_storage.file_exists.return_value = True
mock_storage.download_json.return_value = SAMPLE_VOCALSTAR_CONFIG
# Load into cache
tenant_service.get_tenant_config("vocalstar")
# Invalidate all
tenant_service.invalidate_cache()
assert len(tenant_service._config_cache) == 0
assert len(tenant_service._cache_times) == 0
assert len(tenant_service._subdomain_map) == 0
# Tests for get_asset_url()
def test_get_asset_url_success(self, tenant_service, mock_storage):
"""Test getting signed URL for existing asset."""
mock_storage.file_exists.return_value = True
url = tenant_service.get_asset_url("vocalstar", "logo.png")
assert url == "https://signed-url.example.com"
mock_storage.file_exists.assert_called_with("tenants/vocalstar/logo.png")
mock_storage.generate_signed_url.assert_called_with("tenants/vocalstar/logo.png", expiration_minutes=60)
def test_get_asset_url_not_found(self, tenant_service, mock_storage):
"""Test returns None when asset doesn't exist."""
mock_storage.file_exists.return_value = False
url = tenant_service.get_asset_url("vocalstar", "missing.png")
assert url is None
mock_storage.generate_signed_url.assert_not_called()
class TestGetTenantServiceSingleton:
"""Tests for the get_tenant_service() singleton function."""
def test_returns_same_instance(self):
"""Test that get_tenant_service returns singleton."""
# Reset the singleton
import backend.services.tenant_service as module
module._tenant_service = None
with patch.object(TenantService, '__init__', return_value=None):
service1 = get_tenant_service()
service2 = get_tenant_service()
assert service1 is service2
def test_thread_safe_initialization(self):
"""Test that singleton initialization is thread-safe."""
import threading
import backend.services.tenant_service as module
# Reset the singleton
module._tenant_service = None
instances = []
def get_instance():
with patch.object(TenantService, '__init__', return_value=None):
instances.append(get_tenant_service())
threads = [threading.Thread(target=get_instance) for _ in range(10)]
for t in threads:
t.start()
for t in threads:
t.join()
# All instances should be the same
assert all(i is instances[0] for i in instances)
+8 -3
View File
@@ -831,9 +831,12 @@ async def _handle_native_distribution(
# Don't fail the job - distribution is optional
# Upload to Google Drive using native API
# Skip if orchestrator already uploaded (gdrive_files already populated)
# This prevents duplicate uploads when using the orchestrator path
gdrive_folder_id = getattr(job, 'gdrive_folder_id', None)
if gdrive_folder_id:
existing_gdrive_files = result.get('gdrive_files')
if gdrive_folder_id and not existing_gdrive_files:
try:
from backend.services.gdrive_service import get_gdrive_service
@@ -869,7 +872,9 @@ async def _handle_native_distribution(
except Exception as e:
job_log.error(f"Native Google Drive upload failed: {e}", exc_info=True)
# Don't fail the job - distribution is optional
elif existing_gdrive_files:
job_log.info(f"Skipping Google Drive upload - orchestrator already uploaded {len(existing_gdrive_files)} files")
# Update job state_data with brand code and links
if brand_code or result.get('dropbox_link') or result.get('gdrive_files'):
try:
@@ -479,10 +479,37 @@ class VideoWorkerOrchestrator:
if self.config.gdrive_folder_id:
await self._upload_to_gdrive()
# Clear outputs_deleted_at if set (job was re-processed after output deletion)
# Only clear if we actually uploaded something
uploads_happened = (
self.result.youtube_url or
self.result.dropbox_link or
self.result.gdrive_files
)
if uploads_happened and self.job_manager:
job = self.job_manager.get_job(self.config.job_id)
if job and job.outputs_deleted_at:
self.job_manager.update_job(self.config.job_id, {
"outputs_deleted_at": None,
"outputs_deleted_by": None,
})
self.job_log.info("Cleared outputs_deleted_at flag (job was re-processed)")
async def _upload_to_youtube(self):
"""Upload video to YouTube."""
self.job_log.info("Uploading to YouTube")
# Check YouTube upload rate limit (system-wide)
try:
from backend.services.rate_limit_service import get_rate_limit_service
rate_limit_service = get_rate_limit_service()
allowed, remaining, message = rate_limit_service.check_youtube_upload_limit()
if not allowed:
self.job_log.warning(f"YouTube upload skipped: {message}")
return
except Exception as e:
self.job_log.warning(f"Rate limit check failed, proceeding with upload: {e}")
# Find the best video file to upload (prefer MKV for FLAC audio, then lossless MP4)
video_to_upload = None
if self.result.final_video_mkv and os.path.isfile(self.result.final_video_mkv):
@@ -520,6 +547,21 @@ class VideoWorkerOrchestrator:
if video_url:
self.result.youtube_url = video_url
self.job_log.info(f"Uploaded to YouTube: {video_url}")
# Record the upload for rate limiting
try:
# Get user_email from job if available
user_email = "unknown"
if self.job_manager:
job = self.job_manager.get_job(self.config.job_id)
if job and job.user_email:
user_email = job.user_email
rate_limit_service.record_youtube_upload(
job_id=self.config.job_id,
user_email=user_email
)
except Exception as e:
self.job_log.warning(f"Failed to record YouTube upload for rate limiting: {e}")
else:
self.job_log.warning("YouTube upload did not return a URL")
+326 -4
View File
@@ -119,9 +119,16 @@ Saves corrections and triggers video rendering.
```http
POST /api/review/{job_id}/preview-video
Content-Type: application/json
{
"corrections": [...],
"corrected_segments": [...],
"use_background_image": false // optional, default: false
}
```
Generates preview video during review.
Generates preview video during review. The `use_background_image` option controls whether the preview renders with the theme's background image (slower, ~30-60s) or a solid black background (faster, ~10s). Defaults to black background for speed.
#### Stream Audio
@@ -199,6 +206,70 @@ GET /api/themes
No auth required. Returns available video themes.
### Tenant Config
```http
GET /api/tenant/config
GET /api/tenant/config?tenant=vocalstar
```
No auth required. Returns tenant configuration for white-label portals.
**Detection priority**:
1. `X-Tenant-ID` header (explicitly set by frontend)
2. `tenant` query parameter (development/testing only, disabled in production)
3. Host header subdomain detection (e.g., `vocalstar.nomadkaraoke.com`)
Response:
```json
{
"tenant": {
"id": "vocalstar",
"name": "Vocal Star",
"subdomain": "vocalstar.nomadkaraoke.com",
"is_active": true,
"branding": {
"logo_url": "https://storage.googleapis.com/...",
"logo_height": 60,
"primary_color": "#ffff00",
"secondary_color": "#006CF9",
"accent_color": "#ffffff",
"background_color": "#000000",
"favicon_url": null,
"site_title": "Vocal Star Karaoke Generator",
"tagline": "Whoever You Are, Be a Vocal Star!"
},
"features": {
"audio_search": false,
"file_upload": true,
"youtube_url": false,
"youtube_upload": false,
"dropbox_upload": false,
"gdrive_upload": false,
"theme_selection": false,
"color_overrides": false,
"enable_cdg": true,
"enable_4k": true,
"admin_access": false
},
"defaults": {
"theme_id": "vocalstar",
"locked_theme": "vocalstar",
"distribution_mode": "download_only"
}
},
"is_default": false
}
```
When no tenant is detected, returns `tenant: null` with `is_default: true` and the default Nomad Karaoke configuration is used.
```http
GET /api/tenant/config/{tenant_id}
```
Get specific tenant config by ID. Returns 404 if tenant not found or inactive.
### Internal (Admin Only)
These endpoints are used by workers and require admin tokens.
@@ -264,6 +335,8 @@ GET /api/users/auth/verify?token=TOKEN
Returns session token and user info.
**Admin Login Token**: The same endpoint supports admin login tokens embedded in notification emails. When a made-for-you order is received, the admin notification email includes a link with `?admin_token=TOKEN` that auto-logs the admin into the app. The frontend detects this parameter and calls the verify endpoint to authenticate. Admin tokens expire after 24 hours.
### Get Current User
```http
@@ -288,7 +361,7 @@ GET /api/users/credits/packages
No auth required. Returns available packages and prices.
### Create Checkout Session
### Create Checkout Session (Credits)
```http
POST /api/users/credits/checkout
@@ -297,7 +370,48 @@ Content-Type: application/json
{"package_id": "5_credits", "email": "user@example.com"}
```
Returns Stripe checkout URL.
Returns Stripe checkout URL. Supports Apple Pay, Google Pay, Link, and other payment methods based on customer device.
### Create Checkout Session (Made For You)
```http
POST /api/users/made-for-you/checkout
Content-Type: application/json
{
"email": "customer@example.com",
"artist": "Queen",
"title": "Bohemian Rhapsody",
"source_type": "search",
"youtube_url": null,
"notes": "Optional special requests"
}
```
Creates a $15 checkout for the full-service "Made For You" karaoke video. Supports all enabled payment methods.
**source_type**: `search` (find audio automatically), `youtube` (use provided URL)
#### Made-For-You Order Flow
After payment completes via Stripe webhook:
1. **Job Creation**: Job is created with `made_for_you=true`, owned by admin during processing
2. **Audio Search**: System searches for audio sources automatically
3. **Admin Notification**: Admin receives email with link to select audio source
4. **Customer Confirmation**: Customer receives order confirmation email
5. **Pause at Audio Selection**: Job enters `AWAITING_AUDIO_SELECTION` state
6. **Admin Selects Audio**: Admin reviews and selects audio source in admin UI
7. **Processing**: Job processes through normal pipeline (admin handles any intermediate steps)
8. **Completion**: On completion, ownership transfers to customer (`user_email` = `customer_email`)
9. **Delivery Email**: Customer receives completion email with download links
**Key fields on job document:**
- `made_for_you: bool` - Flag for made-for-you orders (default: false)
- `customer_email: str` - Customer's email for final delivery
- `customer_notes: str` - Optional notes from customer
**Email suppression**: Intermediate reminder emails (lyrics review, instrumental selection) are suppressed for made-for-you jobs since admin handles these directly. Only order confirmation and final delivery emails go to customer
### Stripe Webhook
@@ -434,6 +548,30 @@ Content-Type: application/json
}
```
### Impersonate User (Admin)
Allows admins to view the application as any user by creating a session token for that user.
```http
POST /api/admin/users/{email}/impersonate
Authorization: Bearer ADMIN_TOKEN
```
Response:
```json
{
"session_token": "impersonation-session-token",
"user_email": "user@example.com",
"message": "Now impersonating user@example.com"
}
```
Notes:
- Creates a real session for the target user (auditable in Firestore)
- Admin cannot impersonate themselves
- Returns 404 if user doesn't exist
- The frontend stores the original admin token in memory (not localStorage) for security
### Set User Role (Admin)
```http
@@ -444,6 +582,8 @@ Content-Type: application/json
{"role": "admin"}
```
Note: This endpoint exists but is not exposed in the admin UI. Use database operations for role changes.
### Enable/Disable User (Admin)
```http
@@ -636,6 +776,132 @@ Response:
}
```
### Job Files (Admin)
#### Get Job Files
```http
GET /api/admin/jobs/{job_id}/files
Authorization: Bearer ADMIN_TOKEN
```
Returns all files associated with a job with signed download URLs (2-hour expiry).
Response:
```json
{
"job_id": "abc123",
"artist": "Artist Name",
"title": "Song Title",
"files": [
{
"name": "input.flac",
"path": "jobs/abc123/input.flac",
"download_url": "https://storage.googleapis.com/signed-url...",
"category": "input",
"file_key": "input"
}
],
"total_files": 1
}
```
Categories: `input`, `stems`, `lyrics`, `screens`, `videos`, `finals`, `packages`
### Job Updates (Admin)
#### Update Job Fields
```http
PATCH /api/admin/jobs/{job_id}
Authorization: Bearer ADMIN_TOKEN
Content-Type: application/json
{
"artist": "New Artist",
"title": "New Title"
}
```
Updates editable job fields. Allowed fields: `artist`, `title`, `user_email`, `theme_id`, `brand_prefix`, `discord_webhook_url`, `youtube_description`, `youtube_description_template`, `customer_email`, `customer_notes`, `enable_cdg`, `enable_txt`, `enable_youtube_upload`, `non_interactive`, `prep_only`.
Response:
```json
{
"status": "success",
"job_id": "abc123",
"updated_fields": ["artist", "title"],
"message": "Successfully updated 2 field(s)"
}
```
Non-editable fields (job_id, status, created_at, file_urls, state_data) return 400.
#### Reset Job State
```http
POST /api/admin/jobs/{job_id}/reset
Authorization: Bearer ADMIN_TOKEN
Content-Type: application/json
{
"target_state": "awaiting_review"
}
```
Resets a job to a specific workflow checkpoint for re-processing.
Allowed target states:
- `pending` - Restart from beginning (clears all processing data)
- `awaiting_audio_selection` - Re-select audio source
- `awaiting_review` - Re-review lyrics (preserves audio stems)
- `awaiting_instrumental_selection` - Re-select instrumental (preserves review)
Response:
```json
{
"status": "success",
"job_id": "abc123",
"previous_status": "complete",
"new_status": "awaiting_review",
"message": "Job reset from complete to awaiting_review",
"cleared_data": ["review_complete", "corrected_lyrics", "instrumental_selection"]
}
```
#### Delete Job Outputs
```http
POST /api/admin/jobs/{job_id}/delete-outputs
Authorization: Bearer ADMIN_TOKEN
```
Deletes all distributed outputs (YouTube, Dropbox, Google Drive) for a job while preserving the job record. Use this to fix quality issues: delete outputs, reset to `awaiting_review`, correct lyrics, and re-process.
Requirements:
- Job must be in terminal state (`complete`, `prep_complete`, `failed`, or `cancelled`)
- Outputs must not already be deleted (checks `outputs_deleted_at`)
Response:
```json
{
"status": "success",
"job_id": "abc123",
"message": "Outputs deleted successfully",
"deleted_services": {
"youtube": {"status": "success", "video_id": "dQw4w9WgXcQ"},
"dropbox": {"status": "success", "path": "/Karaoke/NOMAD-1234 - Artist - Title"},
"gdrive": {"status": "success", "files": {"mp4": true, "mp4_720p": true}}
},
"cleared_state_data": ["youtube_url", "brand_code", "dropbox_link", "gdrive_files"],
"outputs_deleted_at": "2026-01-10T12:00:00Z"
}
```
Service statuses: `success`, `failed`, `skipped` (not configured or no data), `partial` (some files failed), `error` (exception).
The brand code is freed for reuse when the Dropbox folder is deleted. When the job is re-processed and outputs are re-uploaded, the `outputs_deleted_at` flag is automatically cleared.
### Internal Email Endpoints
These endpoints are used by Cloud Tasks for automated notifications.
@@ -651,7 +917,63 @@ Called by Cloud Tasks 5 minutes after a job enters a blocking state (awaiting_re
## Rate Limits
No rate limits currently implemented.
### User Limits
- **Jobs per day**: 5 (configurable via `RATE_LIMIT_JOBS_PER_DAY`)
- **YouTube uploads per day**: 10 system-wide (configurable via `RATE_LIMIT_YOUTUBE_UPLOADS_PER_DAY`)
- **Beta enrollment per IP**: 1 per 24 hours (configurable via `RATE_LIMIT_BETA_IP_PER_DAY`)
Rate limiting can be disabled via `ENABLE_RATE_LIMITING=false`.
### 429 Response
When rate limit is exceeded, the API returns:
```json
{
"detail": "Daily job limit exceeded (5/5). Resets in 14 hours.",
"error_type": "rate_limit_exceeded",
"limit_type": "jobs_per_day",
"current_count": 5,
"limit_value": 5,
"remaining_seconds": 50400,
"retry_after": "2026-01-10T00:00:00Z"
}
```
### Admin Override
Admins can grant users bypass permissions or custom limits via the admin UI at `/admin/rate-limits`.
### Admin Rate Limits API
```http
GET /api/admin/rate-limits/stats
```
Returns current rate limit statistics (usage, blocklist counts, override counts).
```http
GET /api/admin/rate-limits/users/{email}
```
Returns rate limit status for a specific user.
```http
GET /api/admin/rate-limits/blocklists
POST /api/admin/rate-limits/blocklists/disposable-domains
DELETE /api/admin/rate-limits/blocklists/disposable-domains/{domain}
POST /api/admin/rate-limits/blocklists/blocked-emails
DELETE /api/admin/rate-limits/blocklists/blocked-emails/{email}
POST /api/admin/rate-limits/blocklists/blocked-ips
DELETE /api/admin/rate-limits/blocklists/blocked-ips/{ip}
```
Manage blocklists for disposable email domains, blocked emails, and blocked IPs.
```http
GET /api/admin/rate-limits/overrides
PUT /api/admin/rate-limits/overrides/{email}
DELETE /api/admin/rate-limits/overrides/{email}
```
Manage user overrides (bypass or custom limits).
## Webhooks
+120
View File
@@ -217,6 +217,126 @@ The Video Worker uses an orchestrator pattern to ensure all features work regard
| `template_service.py` | GCS-backed email templates |
| `job_notification_service.py` | Email orchestration (completion, reminders) |
## Multitenancy
The platform supports white-label B2B portals where business customers get their own branded karaoke generation experience.
### Architecture
```text
┌─────────────────────────────────────────────────────────────────┐
│ Tenant Detection Flow │
│ │
│ Request arrives at vocalstar.nomadkaraoke.com │
│ │ │
│ ▼ │
│ Frontend: detectTenantFromUrl() │
│ - Extracts subdomain from hostname │
│ - Calls GET /api/tenant/config?tenant=vocalstar │
│ │ │
│ ▼ │
│ Backend: TenantMiddleware │
│ 1. X-Tenant-ID header (from frontend) │
│ 2. Query param (dev only, disabled in production) │
│ 3. Host header subdomain detection │
│ │ │
│ ▼ │
│ TenantService.get_tenant_config() │
│ - Loads from GCS: tenants/{tenant_id}/config.json │
│ - Caches in memory (5 min TTL) │
│ │ │
│ ▼ │
│ Request proceeds with tenant context │
│ - request.state.tenant_id │
│ - request.state.tenant_config │
└─────────────────────────────────────────────────────────────────┘
```
### GCS Storage Layout
```text
tenants/{tenant_id}/
├── config.json # TenantConfig with branding, features, defaults
└── logo.jpg # Tenant logo (optional)
themes/{theme_id}/
├── style_params.json # Full theme configuration
└── assets/
├── intro_background.png
├── karaoke_background.jpg
├── end_background.png
├── font.ttf
└── cdg_*.gif
```
### Tenant Config Schema
```python
TenantConfig:
id: str # e.g., "vocalstar"
name: str # Display name: "Vocal Star"
subdomain: str # e.g., "vocalstar.nomadkaraoke.com"
is_active: bool # Enable/disable tenant
branding:
logo_url: str | None # GCS path to logo
logo_height: int # Pixels
primary_color: str # Hex color
secondary_color: str
accent_color: str | None
background_color: str | None
favicon_url: str | None
site_title: str
tagline: str | None
features:
audio_search: bool # Enable audio search (vs file upload only)
file_upload: bool
youtube_url: bool
youtube_upload: bool # YouTube distribution
dropbox_upload: bool
gdrive_upload: bool
theme_selection: bool # Allow user to pick theme
color_overrides: bool
enable_cdg: bool
enable_4k: bool
admin_access: bool
defaults:
theme_id: str | None # Default theme if not locked
locked_theme: str | None # Force this theme (user cannot change)
distribution_mode: str # "all", "download_only", etc.
auth:
allowed_email_domains: list[str] # e.g., ["vocal-star.com"]
require_email_domain: bool
sender_email: str | None # Override email sender
```
### Feature Enforcement
**Frontend**: The `useTenant()` hook provides `features` object. UI components conditionally render based on enabled features:
```typescript
const { features } = useTenant()
if (!features.audio_search) {
// Hide audio search tab
}
```
**Backend**: Routes check tenant config from request state:
```python
tenant_config = get_tenant_config_from_request(request)
if tenant_config and not tenant_config.features.audio_search:
raise HTTPException(403, "Audio search not enabled for this tenant")
```
### First Tenant: Vocal Star
- Subdomain: `vocalstar.nomadkaraoke.com`
- Features: File upload only (no audio search, no YouTube URL)
- Distribution: Download only (no YouTube/Dropbox/GDrive)
- Theme: Locked to "vocalstar" theme (yellow/blue)
- Auth: Restricted to `@vocal-star.com` and `@vocalstarmusic.com` emails
- Setup: `python scripts/setup-vocalstar-tenant.py`
## Tech Stack
- **Backend**: FastAPI, Python 3.12, Cloud Run
+10 -38
View File
@@ -60,45 +60,21 @@ npm run dev
## Testing
### Backend Tests
**See [TESTING.md](TESTING.md) for complete testing guidance.**
Quick reference (run before committing):
```bash
# Run all tests (required before commit)
make test 2>&1 | tail -n 500
# This runs in order:
# 1. Unit tests with coverage
# 2. Backend unit tests
# 3. E2E integration tests with emulators
```
**Important**: Set 10 minute timeout. Tests can take a while with emulators.
This runs ALL tests (backend + frontend) and installs dependencies automatically.
### Frontend Tests
For faster iteration, run subsets:
- `make test-backend` - Backend only (~2 min)
- `make test-frontend` - Frontend only (~3 min)
```bash
cd frontend
npm run test:all 2>&1 | tail -n 200
# Individual commands:
npm run test:unit # Jest unit tests
npm run test:e2e # Playwright E2E tests
```
### Test Architecture
```
┌─────────────────────────────────┐
│ Unit Tests (Mocked) │ Fast, isolated
│ ~62 tests, <1s │
├─────────────────────────────────┤
│ Emulator Integration Tests │ Local Firestore/GCS
│ ~11 tests, ~2s │
├─────────────────────────────────┤
│ E2E Tests │ Full API + Frontend
│ Requires deployed backend │
└─────────────────────────────────┘
```
TESTING.md covers: test types, CI requirements, Playwright usage, mocking guidelines, and coverage enforcement.
## Deployment
@@ -231,10 +207,6 @@ lsof -i :4443 # GCS
./scripts/stop-emulators.sh
```
### Tests Fail with Auth Errors
Ensure `ADMIN_TOKENS` is set in environment or `.env` file.
### Docker Issues
```bash
@@ -245,6 +217,6 @@ docker info
docker pull fsouza/fake-gcs-server
```
### Coverage Below Target
### Test Failures
Run `./scripts/run-tests.sh --coverage` and check `htmlcov/index.html` to see uncovered lines.
See [TESTING.md](TESTING.md#debugging-failed-tests) for debugging test failures, coverage issues, and CI troubleshooting.
+146 -1984
View File
File diff suppressed because it is too large. Load diff
+18 -1
View File
@@ -27,8 +27,10 @@
| Payment flow (Stripe) | Working |
| Beta tester program | Working |
| Admin dashboard | Working |
| Rate limiting & abuse prevention | Working |
| CI/CD self-hosted runner | Working (GCP) |
| E2E happy path test | Working (~20-25 min full pipeline) |
| **White-label B2B portals** | Working (Vocal Star first tenant) |
## Known Issues
@@ -40,9 +42,21 @@
## Recent Changes
- **Admin Delete Outputs** (2026-01-10): Added admin button to delete all distributed outputs (YouTube, Dropbox, Google Drive) for a job while preserving the job record. Use case: fix quality issues by deleting outputs, resetting to `awaiting_review`, correcting lyrics, and re-generating. The brand code is freed for reuse when Dropbox folder is deleted. New endpoint: `POST /api/admin/jobs/{job_id}/delete-outputs`. UI: Delete Outputs button in admin job detail page, "Outputs Deleted" badge when flag is set. See [API.md](API.md#delete-job-outputs).
- **Rate Limiting & Abuse Prevention** (2026-01-09): Added per-user rate limiting (5 jobs/day default), system-wide YouTube upload limits (10/day), and beta enrollment abuse prevention. Features: email normalization (Gmail alias detection), disposable domain blocklist (130+ domains), blocked email/IP lists, IP-based enrollment rate limiting (1 per 24h), and admin UI for managing blocklists and user overrides at `/admin/rate-limits`. Admins can grant users bypass permissions or custom limits. All limits configurable via environment variables. See [API.md](API.md#rate-limits).
- **Fast Preview Video Option** (2026-01-10): Added toggle in lyrics review UI to render preview videos with black background (~10s) instead of theme background image (~30-60s). Default is now black background for faster iteration during review. Users can enable theme background via checkbox when they want to verify the final look. See [API.md](API.md#generate-preview).
- **Admin Login Token for Made-For-You Orders** (2026-01-10): Added one-click admin login via email. When a made-for-you order is placed, the admin notification email now includes a direct link with an embedded login token (`?admin_token=TOKEN`). Clicking this link auto-authenticates the admin and opens the job directly - no manual login required. Tokens expire after 24 hours. Also added: BCC to `done@nomadkaraoke.com` on all job completion emails, fixed timezone display (EST→ET for DST correctness). See [API.md](API.md#verify-magic-link).
- **Made-For-You Audio Selection Flow** (2026-01-08, **fixed 2026-01-09**): Refactored made-for-you order processing to pause at audio selection like regular search jobs. New flow: customer places order → admin receives notification email → admin selects audio source in UI → job processes under admin ownership → on completion, ownership transfers to customer → customer receives delivery email. Added model fields (`made_for_you`, `customer_email`, `customer_notes`), professional email templates for order confirmation and admin notification, intermediate email suppression (no lyrics/instrumental reminders to customer during processing), and ownership transfer on job completion. Distribution defaults (Dropbox, YouTube, GDrive, brand prefix) are now properly applied from server settings. **Bug fix (2026-01-09)**: Fixed webhook handler that was not setting `made_for_you=True`, not using admin ownership, not storing `customer_email`/`customer_notes`, and not pausing at audio selection. Added 17 comprehensive unit tests for the webhook handler. See [API.md](API.md#made-for-you-order-flow) and [LESSONS-LEARNED.md](LESSONS-LEARNED.md#test-webhook-handlers-with-unit-tests-not-just-integration-tests).
- **White-Label B2B Portal Infrastructure** (2026-01-08): Added multi-tenant support for white-label karaoke portals. Vocal Star is the first tenant at `vocalstar.nomadkaraoke.com`. Features: subdomain-based tenant detection (frontend and backend), GCS-backed tenant config storage, per-tenant feature flags (audio search, file upload, YouTube, theme selection, etc.), dynamic branding (logo, colors, site title via CSS variables), locked themes per tenant, email domain restrictions for auth, and tenant-scoped jobs/users in Firestore. Backend: `TenantMiddleware` extracts tenant from X-Tenant-ID header, query param (dev only), or Host subdomain; `TenantService` loads config from GCS with caching. Frontend: Zustand store for tenant state, `TenantProvider` for initialization, `TenantLogo` component. Setup script: `scripts/setup-vocalstar-tenant.py`. See [ARCHITECTURE.md](ARCHITECTURE.md#multitenancy) and [API.md](API.md#tenant-config).
- **Encoding Worker Infrastructure Upgrade** (2026-01-08): Upgraded GCE encoding worker from c4-standard-8 (Intel) to c4d-highcpu-32 (AMD EPYC 9B45 Turin). Benchmarking showed **4.92x faster encoding** (135s vs 666s total). Key improvements: With Vocals 4K rendering 6x faster (54s vs 324s), 720p downscale 4.6x faster (11s vs 50s). Reduces total encoding time from ~11 min to ~2.3 min per job. See [archive/2026-01-08-performance-investigation.md](archive/2026-01-08-performance-investigation.md) for full benchmark methodology and results.
- **Theme Enforcement & Encoding Resilience** (2026-01-08): Added defense-in-depth theme enforcement - jobs without theme_id are now rejected at creation (JobManager) with a safety net at processing time (screens_worker). Fixed done-for-you webhook to apply default theme. Added retry logic with exponential backoff (3 retries, 2s→4s→8s) to GCE encoding service for transient connection failures during worker restarts. See [LESSONS-LEARNED.md](LESSONS-LEARNED.md#defense-in-depth-enforce-critical-requirements-at-multiple-layers).
- **Theme Enforcement & Encoding Resilience** (2026-01-08): Added defense-in-depth theme enforcement - jobs without theme_id are now rejected at creation (JobManager) with a safety net at processing time (screens_worker). Fixed made-for-you webhook to apply default theme. Added retry logic with exponential backoff (3 retries, 2s→4s→8s) to GCE encoding service for transient connection failures during worker restarts. See [LESSONS-LEARNED.md](LESSONS-LEARNED.md#defense-in-depth-enforce-critical-requirements-at-multiple-layers).
- **Comprehensive Performance Optimization** (2026-01-08): Reduced lyrics processing from **16+ minutes to ~5 minutes** through multiple optimizations. Key changes: (1) NLTK cmudict preloading at startup saves 100-150s, (2) Langfuse callback handler preloading saves 200s, (3) Model warmup in `AgenticCorrector.from_model()` prevents parallel initialization race, (4) Parallel anchor sequence search (4 workers) reduces n-gram processing from 38s to ~10s. Added `/health/preload-status` endpoint for deployment verification. PR #236. See [archive/2026-01-08-performance-investigation.md](archive/2026-01-08-performance-investigation.md) and [LESSONS-LEARNED.md](LESSONS-LEARNED.md#preloading-heavy-resources-at-container-startup).
@@ -72,6 +86,8 @@
- **Worker Logs Subcollection** (2026-01-04): Moved `worker_logs` from embedded array in job documents to Firestore subcollection (`jobs/{job_id}/logs`). Fixes job failures when logs exceed 1MB (job 501258e1 had 1.26MB of logs). New logs stored with 30-day TTL via Firestore TTL policy. Feature flag `USE_LOG_SUBCOLLECTION=true` (default). See [LESSONS-LEARNED.md](LESSONS-LEARNED.md#firestore-document-1mb-limit-with-embedded-arrays).
- **Admin Job Detail Enhancements** (2026-01-09): Enhanced admin job detail page with comprehensive job management features. Added: file downloads with signed GCS URLs grouped by category (stems, lyrics, outputs), inline editing of job fields (artist, title, theme, etc.), job reset actions to re-process from specific workflow checkpoints (pending, audio selection, review, instrumental selection), visual timeline with color-coded stages. New endpoints: `GET /api/admin/jobs/{job_id}/files`, `PATCH /api/admin/jobs/{job_id}`, `POST /api/admin/jobs/{job_id}/reset`. See [API.md](API.md#job-files-admin).
- **GCE Encoding Response Fixes** (2026-01-04): Fixed multiple response format mismatches with GCE encoding worker. The worker returns `output_files` as a list of paths, not a dict with format keys - added conversion logic. Also added defensive type checking for status responses that could be lists. See [LESSONS-LEARNED.md](LESSONS-LEARNED.md#external-service-response-format-mismatches).
- **Video Worker Orchestrator** (2026-01-04): Major refactor to unify video generation pipeline. Created VideoWorkerOrchestrator that coordinates all stages (packaging, encoding, distribution, notifications) regardless of encoding backend (GCE or local). Fixes issue where GCE encoding path bypassed YouTube upload, Discord notifications, and CDG/TXT packaging. Feature flag `USE_NEW_ORCHESTRATOR` (default: true) enables rollback. 139 new tests across 6 new service modules. See [ARCHITECTURE.md](ARCHITECTURE.md#video-worker-orchestrator) and [archive/2026-01-04-video-worker-orchestrator-refactor.md](archive/2026-01-04-video-worker-orchestrator-refactor.md).
@@ -114,6 +130,7 @@
| [PRODUCT-VISION.md](PRODUCT-VISION.md) | Product goals, audience, business model |
| [ARCHITECTURE.md](ARCHITECTURE.md) | System design, data flow, integrations |
| [DEVELOPMENT.md](DEVELOPMENT.md) | Local setup, testing, deployment |
| [TESTING.md](TESTING.md) | Testing standards, CI requirements, Playwright |
| [API.md](API.md) | Backend endpoint reference |
| [BRAND-STYLE-GUIDE.md](BRAND-STYLE-GUIDE.md) | Brand colors, typography, UI patterns |
| [LESSONS-LEARNED.md](LESSONS-LEARNED.md) | Key insights for future agents |
+16
View File
@@ -61,8 +61,24 @@ STRIPE_WEBHOOK_SECRET=whsec_your_webhook_secret
# Optional (defaults shown)
FRONTEND_URL=https://gen.nomadkaraoke.com
# BUY_URL defaults to FRONTEND_URL after site consolidation
# Payment Method Configuration (enables Google Pay, Apple Pay, Link)
# Get this from: Dashboard > Settings > Payment methods > [Your Config] > Copy ID
STRIPE_PAYMENT_METHOD_CONFIG=pmc_your_config_id_here
```
### Payment Method Configuration
To enable Google Pay, Apple Pay, Link, and other wallet payment methods in your checkout:
1. Go to **Stripe Dashboard** > **Settings** > **Payment methods**
2. Create or select a configuration (e.g., "Default")
3. Enable the payment methods you want (Google Pay, Apple Pay, Link, etc.)
4. Copy the configuration ID (starts with `pmc_`)
5. Set it as `STRIPE_PAYMENT_METHOD_CONFIG`
Without this setting, checkout sessions will only show basic payment methods (cards, some regional methods). With it, customers will see Google Pay, Apple Pay, and Link options when available on their device.
### For Cloud Run deployment:
The CI workflow (`.github/workflows/ci.yml`) automatically injects these secrets during deployment. No manual `gcloud` commands needed - just add the secret values to Secret Manager (step 2) and the next backend deployment will pick them up.
+617
View File
@@ -0,0 +1,617 @@
# Testing & Code Quality Guide
This document defines testing standards, code quality principles, and CI requirements for Nomad Karaoke Gen.
## Critical: All Tests Must Pass
**All tests must pass before merging.** If tests fail:
1. **Fix them** - Don't assume failures are "pre-existing issues"
2. **Investigate** - Understand why the test is failing
3. **Don't dismiss** - If a test fails, either the code or test needs fixing
CI blocks merging if tests fail. If you encounter failures locally, fix them as part of your work.
### Running Tests
```bash
# Run ALL tests (backend + frontend) - installs deps automatically
make test
# Run subsets for faster iteration
make test-backend # Backend only (~2 min)
make test-frontend # Frontend only (~3 min)
```
Dependencies are installed automatically when needed.
## Critical: Automate Manual Testing Steps
**If your plan includes "Manual Testing" steps, convert them to automated Playwright E2E tests.**
When you write a plan with steps like "manually verify the dialog opens" or "test that the button appears for complete jobs", these are perfect candidates for automated E2E tests. Don't leave verification as a manual step that may never happen.
### Why Automate?
1. **Codifies expected behavior** - The test documents exactly what should happen
2. **Repeatable verification** - Can re-run after future changes to catch regressions
3. **Actually gets executed** - Manual steps are often skipped; automated tests run reliably
4. **Proves the feature works** - Passing test = working feature in production
### Production E2E Tests Are Valuable
It's acceptable (and preferred) to write E2E tests that only run against production:
```typescript
// frontend/e2e/production/admin-delete-outputs.spec.ts
test('Admin can delete job outputs', async ({ page }) => {
// This test runs against real production after deployment
// It verifies the feature actually works end-to-end
await page.goto(`${PROD_URL}/admin/jobs/${testJobId}`);
await page.click('[data-testid="delete-outputs-button"]');
await expect(page.getByText('Confirm deletion')).toBeVisible();
// ... complete the flow
});
```
**Even if the test is only run once** after deployment, it's still valuable because:
- It codifies the expected behavior completely
- It proves the deployed code works
- It can be re-run if issues are suspected
- It serves as documentation for the feature
### Workflow for Production-Only E2E Tests
1. **Implement the feature** with unit tests and regression E2E tests (mocked API)
2. **Write production E2E test** that exercises the real flow
3. **Merge and deploy** to production
4. **Run the production E2E test** to verify: `npm run test:e2e:prod -- admin-delete-outputs.spec.ts`
5. **Commit passed** - Feature is verified working in production
### Example: Converting Manual Steps to E2E
**Before (manual testing in plan):**
```
Manual testing:
- Create/complete a test job with YouTube/Dropbox upload
- Navigate to admin job detail
- Click "Delete All Outputs" button
- Verify dialog shows, confirm deletion
- Verify "Outputs Deleted" badge appears
```
**After (automated production E2E):**
```typescript
test('Delete outputs flow', async ({ page }) => {
// Use existing complete job or create one via API
const jobId = process.env.E2E_COMPLETE_JOB_ID;
await page.goto(`${PROD_URL}/admin/jobs/${jobId}`);
await page.click('[data-testid="delete-outputs-button"]');
await expect(page.getByRole('dialog')).toBeVisible();
await page.click('[data-testid="confirm-delete"]');
await expect(page.getByText('Outputs Deleted')).toBeVisible();
});
```
### When to Use Each Test Type
| Scenario | Test Type | Location |
|----------|-----------|----------|
| UI component behavior | Jest unit test | `components/__tests__/` |
| UI flow with mocked API | Playwright regression | `e2e/regression/` |
| Full flow against real backend | Playwright production | `e2e/production/` |
| API endpoint logic | pytest unit test | `backend/tests/` |
| Database operations | Emulator test | `backend/tests/emulator/` |
**Default to production E2E** for any feature that involves user-facing workflows. The goal is automated verification of deployed code, not checkbox completion of manual steps.
## Core Principles
### SOLID Principles
All code should follow SOLID principles:
1. **Single Responsibility** - Each class/function does one thing well
2. **Open/Closed** - Open for extension, closed for modification
3. **Liskov Substitution** - Subtypes must be substitutable for base types
4. **Interface Segregation** - Many specific interfaces over one general interface
5. **Dependency Inversion** - Depend on abstractions, not concretions
### Code Quality Standards
- **Maintainability** - Code should be easy to understand and modify
- **Testability** - Code should be designed for easy testing (dependency injection, pure functions)
- **No magic numbers** - Use named constants
- **Explicit over implicit** - Clear is better than clever
- **DRY but not prematurely** - Don't repeat yourself, but don't abstract too early
## Test Types
### Unit Tests
**Locations:**
- `tests/unit/` - CLI package (`karaoke_gen/`) unit tests
- `backend/tests/` - Backend API unit tests (excludes `emulator/`)
- `frontend/components/__tests__/` - React component unit tests
**Characteristics:**
- Fast (< 1ms per test typical)
- No external dependencies (mocked)
- No network, database, or filesystem access
- Run on every commit
**Coverage targets:**
- `karaoke_gen/` package: 69%+
- `backend/` package: No explicit threshold (but coverage collected)
- `frontend/` components: No explicit threshold (but coverage collected)
```python
# Good unit test example (backend/tests/test_job_manager.py)
def test_create_job_applies_default_theme(mock_firestore, mock_gcs):
job_manager = JobManager()
job = job_manager.create_job(
artist="Test Artist",
title="Test Song",
user_email="test@example.com"
)
assert job.theme_id == "nomad" # Default theme applied
```
### Integration Tests (`tests/integration/`)
**Purpose:** Test CLI workflows and component interactions.
**Characteristics:**
- May mock high-level components
- Tests full command pipelines
- Uses `@pytest.mark.integration` marker
- Often async (`@pytest.mark.asyncio`)
**Example scenarios:**
- CLI `--edit-lyrics` flow end-to-end
- Job creation → processing pipeline
- Audio separation → transcription coordination
### Emulator Tests (`backend/tests/emulator/`)
**Purpose:** Test real Firestore/GCS behavior without production access.
**Characteristics:**
- Requires GCP emulators running
- Tests actual database operations
- Verifies subcollections, TTL policies, etc.
- Auto-skips if emulators unavailable
**Setup:**
```bash
# Start emulators
make emulators-start
# Run emulator tests
poetry run pytest backend/tests/emulator/ -v
# Stop emulators
make emulators-stop
```
### E2E Tests (Frontend)
**Locations:**
- `frontend/e2e/regression/` - Mocked API tests (CI-safe, fast)
- `frontend/e2e/production/` - Real backend tests (comprehensive, slower)
- `frontend/e2e/manual/` - Tests requiring manual setup (not in CI)
**Tool:** Playwright
**Regression tests** run on every PR:
- Mock API responses via fixtures
- Test UI behavior in isolation
- Playwright auto-starts dev server via `webServer` config
- ~3 min total runtime
**Production tests** run on-demand or daily:
- Hit real `https://gen.nomadkaraoke.com` and `https://api.nomadkaraoke.com`
- Full user journeys (20-40 min for happy path)
- Require authentication tokens
**Manual tests** are NOT included in CI:
- Require separate dev servers (e.g., LyricsTranscriber frontend on port 5173)
- See `frontend/e2e/manual/README.md` for setup instructions
## Playwright Usage
### Installation
```bash
cd frontend
npm install -D @playwright/test
npx playwright install
```
### Running E2E Tests
```bash
# Regression tests (mocked API, default)
npm run test:e2e
# Production tests (real backend)
npm run test:e2e:prod
# With UI mode for debugging
npm run test:e2e:ui
# Specific test file
npx playwright test e2e/regression/smoke.spec.ts
# Production test with environment
E2E_TEST_TOKEN=xxx npm run test:e2e:prod
```
### Investigating Frontend Issues
When debugging frontend issues, use Playwright to:
1. **Reproduce the issue** - Write a test that fails
2. **Debug visually** - Use `--ui` mode or `--headed`
3. **Capture evidence** - Screenshots, traces, console logs
4. **Verify the fix** - Test passes after fix
```bash
# Debug mode with browser visible
npm run test:e2e:headed
# Generate trace for failed tests
npx playwright test --trace on
```
### Writing E2E Tests
**Regression test example (mocked API):**
```typescript
// frontend/e2e/regression/smoke.spec.ts
import { test, expect } from '@playwright/test';
import { setupApiFixtures, clearAuthToken } from '../fixtures/test-helper';
test.describe('Smoke Tests', () => {
test.beforeEach(async ({ page }) => {
await clearAuthToken(page);
});
test('landing page loads and shows hero', async ({ page }) => {
await setupApiFixtures(page, { mocks: [] });
await page.goto('/');
await expect(page.locator('h1')).toContainText('Karaoke');
});
});
```
**Production test example (real backend):**
```typescript
// frontend/e2e/production/lyrics-review-only.spec.ts
import { test, expect } from '@playwright/test';
const PROD_URL = 'https://gen.nomadkaraoke.com';
test.describe('Lyrics Review', () => {
test('Complete lyrics review via UI', async ({ page }) => {
test.setTimeout(900_000); // 15 min - preview generation can be slow
const jobId = process.env.E2E_JOB_ID;
await page.goto(`${PROD_URL}/review/${jobId}`);
// ... test implementation
});
});
```
## CI Pipeline
### Required Checks (Block PR Merge)
All PRs must pass these checks (path-filtered for efficiency):
| Check | Description | Threshold |
|-------|-------------|-----------|
| `backend-lint` | Ruff linter | No errors |
| `backend-unit-tests` | Backend tests (excludes emulator) | Must pass |
| `backend-emulator-tests` | GCP emulator integration | Must pass |
| `package-unit-tests` | CLI package tests | 69% coverage |
| `package-integration-tests` | CLI integration tests | Must pass |
| `frontend-lint` | ESLint (Rules of Hooks) | No errors |
| `frontend-unit-tests` | Jest component tests | Must pass |
| `frontend-e2e-smoke` | Playwright smoke tests | Must pass |
| `frontend-build` | Next.js build | Must pass |
### On-Demand Checks
| Check | Trigger | Description |
|-------|---------|-------------|
| `frontend-e2e-full` | `e2e` PR label | Full regression E2E suite |
| `e2e-happy-path` | Daily 6 AM UTC | Complete production happy path |
### Path Filtering
CI intelligently runs only relevant tests based on changed files:
| Changed Path | Tests Run |
|--------------|-----------|
| `frontend/` | Frontend lint, unit, E2E |
| `backend/` | Backend lint, unit, emulator |
| `karaoke_gen/` | Package unit, integration |
| `tests/` | Package tests |
| `infrastructure/` | Infrastructure validation |
### Known Testing Gaps
**Infrastructure dependencies** (Modal, AudioShake, Cloud Tasks, Firestore) are mocked in tests. This means IAM permission errors or API changes won't be caught until production. Mitigations:
1. **Emulator tests** - Use `backend/tests/emulator/` for Firestore/GCS integration
2. **Manual verification** after infrastructure changes (Pulumi updates)
3. **Health endpoints** - `/api/health` and `/api/health/detailed` validate connectivity
4. **Daily E2E** - `e2e-happy-path.yml` runs full production flow
## Production E2E Testing
For comprehensive production testing:
```bash
cd frontend
# Run full happy path (requires tokens)
E2E_TEST_TOKEN=<token> npx playwright test e2e/production/happy-path-real-user.spec.ts \
--config=playwright.production.config.ts
# Run focused tests (faster iteration)
E2E_JOB_ID=<id> E2E_REVIEW_TOKEN=<token> npx playwright test e2e/production/lyrics-review-only.spec.ts \
--config=playwright.production.config.ts
# Admin dashboard tests
KARAOKE_ADMIN_TOKEN=<admin-token> npx playwright test e2e/production/admin-dashboard.spec.ts \
--config=playwright.production.config.ts
```
### Environment Variables
| Variable | Purpose | Required For |
|----------|---------|--------------|
| `E2E_TEST_TOKEN` | User authentication | Most production tests |
| `KARAOKE_ADMIN_TOKEN` | Admin authentication | Admin dashboard tests |
| `E2E_JOB_ID` | Existing job to test | Focused tests |
| `E2E_REVIEW_TOKEN` | Review page access | Lyrics review tests |
| `TESTMAIL_API_KEY` | TestMail.app API | Magic link auth tests |
| `TESTMAIL_NAMESPACE` | TestMail.app namespace | Magic link auth tests |
### Getting Test Tokens
**Option 1: From browser**
1. Login to https://gen.nomadkaraoke.com
2. Open DevTools → Application → Local Storage
3. Copy the `karaoke_access_token` value
**Option 2: From backend logs**
When the daily E2E runs, tokens are logged for debugging.
The production tests cover:
- Magic link authentication flow
- Audio search and selection
- YouTube URL processing
- File upload workflow
- Lyrics review and correction
- Preview video generation
- Instrumental selection
- Final encoding and download
- Admin dashboard functionality
## Running Tests Locally
```bash
# All backend/package tests
make test
# Specific suites
make test-unit # Package unit tests (69% coverage)
make test-backend # Backend tests only
make test-e2e # E2E with emulators
# With coverage report
poetry run pytest tests/unit --cov=karaoke_gen --cov-report=html
open htmlcov/index.html
# Frontend tests
cd frontend
npm run test:unit # Jest watch mode
npm run test:ci # Jest with coverage
npm run test:e2e # Playwright regression
npm run test:all # Unit + E2E combined
```
## Test File Organization
```
karaoke-gen/
├── tests/
│ ├── unit/ # CLI package unit tests
│ │ ├── conftest.py # Shared fixtures
│ │ ├── test_audio.py # Audio separation tests
│ │ ├── test_karaoke_finalise/ # Finalize module tests
│ │ └── ...
│ ├── integration/ # CLI integration tests
│ │ ├── test_cli_edit_lyrics.py # Edit lyrics workflow
│ │ └── test_cli_backend_integration.py
│ └── conftest.py # Root fixtures
├── backend/
│ └── tests/
│ ├── conftest.py # FastAPI TestClient, mocks
│ ├── test_job_manager.py # Job management tests
│ ├── test_dependencies.py # DI tests
│ ├── test_made_for_you_webhook.py # Webhook tests
│ └── emulator/ # GCP emulator tests
│ ├── conftest.py # Emulator setup
│ ├── test_emulator_integration.py
│ └── test_worker_logs_direct.py
└── frontend/
├── components/__tests__/ # Jest component tests
│ ├── JobCard.test.tsx
│ ├── ThemeSelector.test.tsx
│ └── ...
├── e2e/
│ ├── fixtures/ # Shared test helpers
│ │ ├── test-helper.ts # API mocking utilities
│ │ └── mock-responses.ts # Canned API responses
│ ├── regression/ # Mocked API E2E (CI)
│ │ ├── smoke.spec.ts
│ │ ├── authentication.spec.ts
│ │ ├── karaoke-generation.spec.ts
│ │ └── ...
│ ├── production/ # Real backend E2E
│ │ ├── happy-path-real-user.spec.ts
│ │ ├── lyrics-review-only.spec.ts
│ │ └── admin-dashboard.spec.ts
│ └── manual/ # Manual setup required (NOT in CI)
│ ├── README.md # Setup instructions
│ └── lyrics-review-mobile.spec.ts # LyricsTranscriber frontend
├── jest.config.js
├── jest.setup.js
├── playwright.config.ts # Default (regression)
└── playwright.production.config.ts
```
## Writing Good Tests
### Do
- Test behavior, not implementation
- Use descriptive test names: `test_create_job_applies_default_theme_when_none_specified`
- One assertion per test (when practical)
- Use fixtures for common setup
- Test edge cases and error conditions
- Mock external services (Modal, AudioShake, Genius, etc.)
### Don't
- Test private methods directly
- Write tests that depend on execution order
- Use sleep/wait without timeouts
- Test framework code (FastAPI, React, Next.js)
- Skip tests without a reason
## Coverage Enforcement
Coverage is enforced in CI for the CLI package:
```bash
# Package unit tests require 69% coverage
poetry run pytest tests/unit/ --cov=karaoke_gen --cov-fail-under=69
```
To check coverage locally:
```bash
# CLI package
poetry run pytest tests/unit --cov=karaoke_gen --cov-report=term-missing
# Backend (no threshold, but useful to see)
poetry run pytest backend/tests --cov=backend --cov-report=term-missing
# Frontend (via Jest)
cd frontend && npm run test:ci # Includes coverage
```
## Mocking Guidelines
### When to Mock
- External APIs (Modal, AudioShake, Genius, Spotify lyrics, YouTube)
- GCS/Firestore in unit tests
- FFmpeg in unit tests
- Time-dependent operations
- Network requests
### When NOT to Mock
- Your own code (test the real thing)
- Simple data transformations
- In emulator tests (use real Firestore/GCS emulators)
- In production E2E tests (use real backend)
### Mock Example
```python
from unittest.mock import Mock, patch
def test_fetch_audio_handles_modal_timeout():
with patch('karaoke_gen.audio.modal_api.submit_job') as mock_submit:
mock_submit.side_effect = TimeoutError("Modal API timeout")
with pytest.raises(AudioSeparationError):
separate_audio("test.mp3")
```
### Frontend Mock Example
```typescript
// Using Playwright route interception
test('shows error on API failure', async ({ page }) => {
await page.route('**/api/jobs', route => {
route.fulfill({ status: 500, body: 'Server Error' });
});
await page.goto('/app');
await expect(page.getByText('Error loading jobs')).toBeVisible();
});
```
## Debugging Failed Tests
### Local Debugging
```bash
# Run single test with verbose output
poetry run pytest tests/unit/test_audio.py::test_separate_audio -vvs
# Drop into debugger on failure
poetry run pytest --pdb
# Show local variables on failure
poetry run pytest -l
# Frontend: Debug specific test
cd frontend && npx playwright test smoke.spec.ts --debug
```
### CI Debugging
1. Check the GitHub Actions logs
2. Look for the specific assertion that failed
3. Reproduce locally with the same command
4. If flaky, check for timing/ordering issues
5. Download test artifacts (screenshots, videos) from failed E2E runs
## Adding Tests for New Features
When adding a new feature:
1. **Write tests first** (TDD) or immediately after
2. **Unit tests** for business logic in `karaoke_gen/` or `backend/`
3. **Backend tests** for new API endpoints
4. **Frontend unit tests** for new components
5. **E2E regression tests** for UI flows with mocked API (add to `e2e/regression/`)
6. **Production E2E test** for full workflow verification (add to `e2e/production/`)
7. **Update this doc** if new patterns emerge
**Remember:** If your verification plan includes manual steps, write a production E2E test instead. See [Critical: Automate Manual Testing Steps](#critical-automate-manual-testing-steps).
## Quick Reference
| Task | Command |
|------|---------|
| **All tests (before commit)** | `make test` |
| Backend only | `make test-backend` |
| Frontend only | `make test-frontend` |
| Package unit | `make test-unit` |
| Emulator tests | `make test-e2e` |
| Frontend E2E (production) | `cd frontend && npm run test:e2e:prod` |
| Coverage HTML | `poetry run pytest tests/unit --cov=karaoke_gen --cov-report=html` |
| Install deps | `make install` |
| Start emulators | `make emulators-start` |
| Stop emulators | `make emulators-stop` |
@@ -1,7 +1,7 @@
# Performance Investigation: Karaoke Generation Pipeline
**Date**: 2026-01-08
**Status**: Phase 2 In Progress - Encoding Infrastructure Benchmarking
**Status**: Phase 2 Complete - Encoding Infrastructure Upgraded
**Goal**: Reduce total karaoke generation time from ~30 minutes to ~10 minutes
## Executive Summary
@@ -0,0 +1,271 @@
# White-Label B2B Portal Implementation
**Date**: 2026-01-08
**Status**: Complete
**First Tenant**: Vocal Star
## Overview
Implemented multi-tenant white-label portal infrastructure allowing B2B customers to have their own branded karaoke generation experience at custom subdomains.
## First Customer: Vocal Star
**Requirements**:
- Subdomain: `vocalstar.nomadkaraoke.com`
- File upload only (no audio search, no YouTube URL input)
- Download only distribution (no YouTube/Dropbox/GDrive upload)
- Theme locked to "vocalstar" (yellow/blue color scheme)
- Auth restricted to `@vocal-star.com` and `@vocalstarmusic.com` email domains
- Custom branding: logo, colors, site title, tagline
## Architecture
### Tenant Detection Flow
```
Request → Frontend detectTenantFromUrl() → Backend TenantMiddleware → TenantService → GCS Config
```
**Frontend** (`frontend/lib/tenant.ts`):
- Zustand store for tenant state
- `detectTenantFromUrl()` extracts subdomain from hostname
- Strict patterns: `{tenant}.nomadkaraoke.com` or `{tenant}.gen.nomadkaraoke.com`
- Query param `?tenant=X` for local development only
**Backend** (`backend/middleware/tenant.py`):
- `TenantMiddleware` extracts tenant from:
1. `X-Tenant-ID` header (from frontend)
2. Query param (dev only - disabled in production via `IS_PRODUCTION` check)
3. Host header subdomain
- Attaches `tenant_id` and `tenant_config` to `request.state`
**Config Storage** (`backend/services/tenant_service.py`):
- Loads from GCS: `tenants/{tenant_id}/config.json`
- In-memory cache with 5-minute TTL
- Signed URL generation for logos
### GCS Structure
```
tenants/{tenant_id}/
├── config.json # TenantConfig
└── logo.jpg # Tenant logo
themes/{theme_id}/
├── style_params.json # Theme configuration
└── assets/
├── intro_background.png
├── karaoke_background.jpg
├── end_background.png
├── Oswald-SemiBold.ttf
├── cdg_instrumental_background.gif
└── cdg_title_background.gif
```
### Config Schema
```python
TenantConfig:
id: str
name: str
subdomain: str
is_active: bool
branding: TenantBranding
logo_url: str | None
logo_height: int
primary_color: str
secondary_color: str
accent_color: str | None
background_color: str | None
favicon_url: str | None
site_title: str
tagline: str | None
features: TenantFeatures
audio_search: bool
file_upload: bool
youtube_url: bool
youtube_upload: bool
dropbox_upload: bool
gdrive_upload: bool
theme_selection: bool
color_overrides: bool
enable_cdg: bool
enable_4k: bool
admin_access: bool
defaults: TenantDefaults
theme_id: str | None
locked_theme: str | None
distribution_mode: str
auth: TenantAuth
allowed_email_domains: list[str]
require_email_domain: bool
sender_email: str | None
```
## Implementation Details
### Backend Changes
1. **Tenant Models** (`backend/models/tenant.py`):
- Pydantic models for config schema
- `locked_theme` field for forcing specific theme
2. **Tenant Service** (`backend/services/tenant_service.py`):
- GCS config loading with caching
- Logo signed URL generation
- `tenant_exists()` check for subdomain validation
3. **Tenant API** (`backend/api/routes/tenant.py`):
- `GET /api/tenant/config` - auto-detect or explicit tenant
- `GET /api/tenant/config/{tenant_id}` - specific tenant lookup
4. **Middleware** (`backend/middleware/tenant.py`):
- Priority-based tenant detection
- Production security: query param disabled
- `get_tenant_from_request()` helper
5. **Auth Updates** (`backend/services/auth_service.py`):
- Email domain validation for tenant-restricted auth
- Sender email override from tenant config
6. **Feature Enforcement**:
- Audio search endpoint checks `features.audio_search`
- Returns 403 if feature disabled for tenant
7. **Job/User Scoping**:
- `tenant_id` field added to `JobCreate`
- Jobs created with tenant context from request
### Frontend Changes
1. **Tenant Store** (`frontend/lib/tenant.ts`):
- Zustand store with tenant state
- `useTenant()` hook for components
- Default Nomad Karaoke branding fallback
- CSS variable application via `applyTenantBranding()`
2. **TenantProvider** (`frontend/components/tenant-provider.tsx`):
- Wraps app in layout
- Fetches config on mount
- Prevents hydration issues (no module-level init)
3. **TenantLogo** (`frontend/components/tenant-logo.tsx`):
- Dynamic logo based on tenant
- Falls back to Nomad Karaoke logo
- Supports GCS signed URLs for tenant logos
4. **Feature-Flagged UI** (`frontend/components/job/JobSubmission.tsx`):
- Tabs conditionally rendered based on `features`
- Active tab sync when features change
- `useMemo` for available tabs list
5. **Locked Themes**:
- `defaults.locked_theme` hides theme selector
- Uses locked theme for all jobs
6. **Output Links**:
- Filtered based on `features.youtube_upload`, `features.dropbox_upload`, etc.
### Security Measures
1. **Query param disabled in production**:
```python
IS_PRODUCTION = os.environ.get("ENV", "").lower() == "production"
if not IS_PRODUCTION:
query_tenant = request.query_params.get("tenant")
```
2. **Strict subdomain patterns**:
```typescript
const isValidPattern =
parts.length === 3 ||
(parts.length === 4 && parts[1] === "gen")
```
3. **PII protection in logs**:
```python
def _mask_email(email: str) -> str:
# "andrew@vocal-star.com" → "an***@vo***.com"
```
4. **is_active check**: Inactive tenants treated as default
## Setup Script
`scripts/setup-vocalstar-tenant.py`:
- Uploads theme assets to GCS
- Creates theme config (`style_params.json`)
- Uploads tenant logo
- Creates tenant config (`config.json`)
- Updates theme registry
**Usage**:
```bash
# Set resources path (or pass as argument)
export VOCALSTAR_RESOURCES=/path/to/VocalStar/Resources
python scripts/setup-vocalstar-tenant.py
# Or with argument
python scripts/setup-vocalstar-tenant.py /path/to/VocalStar/Resources
```
## Files Changed
### Backend
- `backend/models/tenant.py` - New
- `backend/services/tenant_service.py` - New
- `backend/api/routes/tenant.py` - New
- `backend/middleware/tenant.py` - New
- `backend/main.py` - Added middleware and routes
- `backend/models/job.py` - Added tenant_id field
- `backend/services/auth_service.py` - Email domain validation
- `backend/api/routes/users.py` - PII masking in logs
- `backend/api/routes/audio_search.py` - Feature check
### Frontend
- `frontend/lib/tenant.ts` - New
- `frontend/components/tenant-provider.tsx` - New
- `frontend/components/tenant-logo.tsx` - New
- `frontend/components/app-layout.tsx` - TenantProvider wrapper
- `frontend/components/job/JobSubmission.tsx` - Feature flags
- `frontend/components/job/OutputLinks.tsx` - Distribution filtering
### Scripts
- `scripts/setup-vocalstar-tenant.py` - New
## Testing
- Frontend build verified (TypeScript compilation)
- CodeRabbit review: 3 cycles, all issues fixed
- Manual testing with `?tenant=vocalstar` query param
### Unit Tests Added
**Backend tests (110 tests)**:
- `test_tenant_models.py` - 28 tests for Pydantic models (TenantConfig, branding, features, defaults, auth, public config, `is_email_allowed()`, `get_sender_email()`, `from_config()`)
- `test_tenant_service.py` - 30 tests for TenantService (config loading, caching, subdomain resolution)
- `test_tenant_middleware.py` - 35 tests for TenantMiddleware (header/query param/subdomain detection, NON_TENANT_SUBDOMAINS filtering)
- `test_tenant_api.py` - 17 tests for `/api/tenant/config` endpoints
**Frontend tests (22 tests)**:
- `tenant.test.ts` - Tests for Zustand store, `getTenantHeaders()`, `isFeatureEnabled()`
**Key testing patterns**:
- API route tests must patch `get_tenant_service` in BOTH routes AND middleware modules since middleware runs first
- Zustand tests use `useTenant.getState().setTenant()` instead of direct `setState()` to properly handle computed properties
- `test_job_creation_regression.py` fixed to mock `request.state.tenant_config = None`
## Next Steps
1. Configure DNS: CNAME for `vocalstar.nomadkaraoke.com`
2. Update Cloudflare Pages for subdomain
3. Run setup script to upload Vocal Star assets
4. Test at `https://vocalstar.nomadkaraoke.com`
## Lessons Learned
1. **Config-driven multitenancy** scales better than code branches
2. **Query params for dev, headers for prod** prevents spoofing
3. **Feature flags belong in config**, not environment variables
4. **Zustand + Next.js**: Don't auto-init at module level, use useEffect
5. **Tab state must react to feature changes** - sync active tab with available tabs
File diff suppressed because it is too large. Load diff
-428
View File
@@ -1,428 +0,0 @@
"use client"
import { useEffect, useState } from "react"
import { useSearchParams, useRouter } from "next/navigation"
import { api, adminApi, Job } from "@/lib/api"
import { Button } from "@/components/ui/button"
import { Badge } from "@/components/ui/badge"
import { Card, CardContent, CardHeader, CardTitle } from "@/components/ui/card"
import {
Accordion,
AccordionContent,
AccordionItem,
AccordionTrigger,
} from "@/components/ui/accordion"
import {
AlertDialog,
AlertDialogAction,
AlertDialogCancel,
AlertDialogContent,
AlertDialogDescription,
AlertDialogFooter,
AlertDialogHeader,
AlertDialogTitle,
} from "@/components/ui/alert-dialog"
import {
ArrowLeft,
RefreshCw,
Loader2,
Trash2,
User,
Clock,
FileText,
XCircle,
} from "lucide-react"
import { useToast } from "@/hooks/use-toast"
export default function AdminJobDetailPage() {
const searchParams = useSearchParams()
const router = useRouter()
const { toast } = useToast()
const jobId = searchParams.get("id") || ""
const [job, setJob] = useState<Job | null>(null)
const [logs, setLogs] = useState<any[]>([])
const [loading, setLoading] = useState(true)
const [logsLoading, setLogsLoading] = useState(false)
// Delete dialog
const [deleteDialogOpen, setDeleteDialogOpen] = useState(false)
const [deleting, setDeleting] = useState(false)
const loadJob = async () => {
if (!jobId) {
setLoading(false)
return
}
try {
setLoading(true)
const data = await api.getJob(jobId)
setJob(data)
} catch (err: any) {
console.error("Failed to load job:", err)
toast({
title: "Error",
description: err.message || "Failed to load job",
variant: "destructive",
})
} finally {
setLoading(false)
}
}
const loadLogs = async () => {
if (!jobId) return
try {
setLogsLoading(true)
const data = await api.getJobLogs(jobId, 200)
setLogs(data)
} catch (err: any) {
console.error("Failed to load logs:", err)
} finally {
setLogsLoading(false)
}
}
useEffect(() => {
loadJob()
loadLogs()
}, [jobId])
const handleDelete = async () => {
try {
setDeleting(true)
await adminApi.deleteJob(jobId)
toast({
title: "Job Deleted",
description: `Job ${jobId} has been deleted`,
})
router.push("/admin/jobs")
} catch (err: any) {
toast({
title: "Error",
description: err.message || "Failed to delete job",
variant: "destructive",
})
} finally {
setDeleting(false)
}
}
const getStatusVariant = (status: string) => {
if (status === "complete" || status === "prep_complete") return "default"
if (status === "failed") return "destructive"
if (status === "cancelled") return "outline"
if (status.includes("awaiting")) return "secondary"
return "secondary"
}
const getLogLevelColor = (level: string) => {
switch (level?.toUpperCase()) {
case "ERROR":
return "text-red-500"
case "WARNING":
return "text-yellow-500"
case "INFO":
return "text-blue-500"
case "DEBUG":
return "text-muted-foreground"
default:
return "text-foreground"
}
}
const formatDate = (dateStr?: string) => {
if (!dateStr) return "—"
return new Date(dateStr).toLocaleString()
}
if (!jobId) {
return (
<div className="text-center py-12">
<p className="text-muted-foreground">No job ID provided</p>
<Button variant="outline" className="mt-4" onClick={() => router.push("/admin/jobs")}>
<ArrowLeft className="w-4 h-4 mr-2" />
Back to Jobs
</Button>
</div>
)
}
if (loading) {
return (
<div className="flex items-center justify-center py-12">
<Loader2 className="w-8 h-8 animate-spin text-muted-foreground" />
</div>
)
}
if (!job) {
return (
<div className="text-center py-12">
<p className="text-muted-foreground">Job not found</p>
<Button variant="outline" className="mt-4" onClick={() => router.push("/admin/jobs")}>
<ArrowLeft className="w-4 h-4 mr-2" />
Back to Jobs
</Button>
</div>
)
}
return (
<div className="space-y-6">
{/* Header */}
<div className="flex items-center justify-between">
<div className="flex items-center gap-4">
<Button variant="ghost" size="icon" onClick={() => router.push("/admin/jobs")}>
<ArrowLeft className="w-4 h-4" />
</Button>
<div>
<h1 className="text-2xl font-bold tracking-tight flex items-center gap-2">
Job {job.job_id}
<Badge variant={getStatusVariant(job.status)}>
{job.status.replace(/_/g, " ")}
</Badge>
</h1>
{job.artist && job.title && (
<p className="text-muted-foreground">{job.artist} - {job.title}</p>
)}
</div>
</div>
<div className="flex gap-2">
<Button variant="outline" size="sm" onClick={() => { loadJob(); loadLogs(); }} disabled={loading}>
<RefreshCw className={`w-4 h-4 mr-2 ${loading ? "animate-spin" : ""}`} />
Refresh
</Button>
<Button
variant="destructive"
size="sm"
onClick={() => setDeleteDialogOpen(true)}
>
<Trash2 className="w-4 h-4 mr-2" />
Delete
</Button>
</div>
</div>
{/* Overview Cards */}
<div className="grid gap-4 md:grid-cols-4">
<Card>
<CardHeader className="pb-2">
<CardTitle className="text-sm font-medium flex items-center gap-2">
<User className="w-4 h-4" />
User
</CardTitle>
</CardHeader>
<CardContent>
<p className="text-sm truncate">
{job.user_email || "Unknown"}
</p>
</CardContent>
</Card>
<Card>
<CardHeader className="pb-2">
<CardTitle className="text-sm font-medium flex items-center gap-2">
<Clock className="w-4 h-4" />
Created
</CardTitle>
</CardHeader>
<CardContent>
<p className="text-sm">{formatDate(job.created_at)}</p>
</CardContent>
</Card>
<Card>
<CardHeader className="pb-2">
<CardTitle className="text-sm font-medium flex items-center gap-2">
<Clock className="w-4 h-4" />
Updated
</CardTitle>
</CardHeader>
<CardContent>
<p className="text-sm">{formatDate(job.updated_at)}</p>
</CardContent>
</Card>
<Card>
<CardHeader className="pb-2">
<CardTitle className="text-sm font-medium flex items-center gap-2">
Progress
</CardTitle>
</CardHeader>
<CardContent>
<div className="flex items-center gap-2">
<div className="flex-1 h-2 bg-muted rounded-full overflow-hidden">
<div
className="h-full bg-primary transition-all"
style={{ width: `${job.progress}%` }}
/>
</div>
<span className="text-sm font-medium">{job.progress}%</span>
</div>
</CardContent>
</Card>
</div>
{/* Error Message */}
{job.error_message && (
<Card className="border-destructive">
<CardHeader>
<CardTitle className="text-destructive flex items-center gap-2">
<XCircle className="w-5 h-5" />
Error
</CardTitle>
</CardHeader>
<CardContent>
<p className="text-sm">{job.error_message}</p>
</CardContent>
</Card>
)}
{/* Accordion Sections */}
<Accordion type="multiple" className="w-full" defaultValue={["timeline", "logs"]}>
{/* Timeline */}
<AccordionItem value="timeline">
<AccordionTrigger>
<div className="flex items-center gap-2">
<Clock className="w-4 h-4" />
Timeline ({job.timeline?.length || 0} events)
</div>
</AccordionTrigger>
<AccordionContent>
<div className="space-y-2 max-h-[400px] overflow-y-auto">
{job.timeline && job.timeline.length > 0 ? (
job.timeline.map((event, i) => (
<div
key={i}
className="flex items-start gap-3 text-sm border-l-2 border-muted pl-4 py-1"
>
<div className="flex-1">
<div className="flex items-center gap-2">
<Badge variant="outline" className="text-xs">
{event.status}
</Badge>
{event.progress !== undefined && (
<span className="text-muted-foreground">
{event.progress}%
</span>
)}
</div>
{event.message && (
<p className="text-muted-foreground mt-1">{event.message}</p>
)}
</div>
<span className="text-xs text-muted-foreground whitespace-nowrap">
{formatDate(event.timestamp)}
</span>
</div>
))
) : (
<p className="text-muted-foreground text-sm">No timeline events</p>
)}
</div>
</AccordionContent>
</AccordionItem>
{/* Worker Logs */}
<AccordionItem value="logs">
<AccordionTrigger>
<div className="flex items-center gap-2">
<FileText className="w-4 h-4" />
Worker Logs ({logs.length} entries)
{logsLoading && <Loader2 className="w-4 h-4 animate-spin ml-2" />}
</div>
</AccordionTrigger>
<AccordionContent>
<div className="space-y-1 max-h-[500px] overflow-y-auto font-mono text-xs">
{logs.length > 0 ? (
logs.map((log, i) => (
<div key={i} className="flex gap-2 py-0.5 border-b border-muted/50">
<span className="text-muted-foreground whitespace-nowrap">
{log.timestamp ? new Date(log.timestamp).toLocaleTimeString() : "—"}
</span>
<span className={`w-16 ${getLogLevelColor(log.level)}`}>
[{log.level}]
</span>
<span className="text-muted-foreground w-20">
{log.worker || "—"}
</span>
<span className="flex-1 break-all">{log.message}</span>
</div>
))
) : (
<p className="text-muted-foreground">No logs available</p>
)}
</div>
</AccordionContent>
</AccordionItem>
{/* State Data */}
<AccordionItem value="state">
<AccordionTrigger>
<div className="flex items-center gap-2">
<FileText className="w-4 h-4" />
State Data
</div>
</AccordionTrigger>
<AccordionContent>
<pre className="text-xs bg-muted p-4 rounded-md overflow-x-auto max-h-[400px]">
{JSON.stringify(job.state_data || {}, null, 2)}
</pre>
</AccordionContent>
</AccordionItem>
{/* File URLs */}
<AccordionItem value="files">
<AccordionTrigger>
<div className="flex items-center gap-2">
<FileText className="w-4 h-4" />
File URLs
</div>
</AccordionTrigger>
<AccordionContent>
<pre className="text-xs bg-muted p-4 rounded-md overflow-x-auto max-h-[400px]">
{JSON.stringify(job.file_urls || {}, null, 2)}
</pre>
</AccordionContent>
</AccordionItem>
{/* Raw Job Data */}
<AccordionItem value="raw">
<AccordionTrigger>
<div className="flex items-center gap-2">
<FileText className="w-4 h-4" />
Raw Job Data
</div>
</AccordionTrigger>
<AccordionContent>
<pre className="text-xs bg-muted p-4 rounded-md overflow-x-auto max-h-[500px]">
{JSON.stringify(job, null, 2)}
</pre>
</AccordionContent>
</AccordionItem>
</Accordion>
{/* Delete Confirmation Dialog */}
<AlertDialog open={deleteDialogOpen} onOpenChange={setDeleteDialogOpen}>
<AlertDialogContent>
<AlertDialogHeader>
<AlertDialogTitle>Delete Job</AlertDialogTitle>
<AlertDialogDescription>
Are you sure you want to delete job {jobId}? This action cannot be
undone and will also delete all associated files.
</AlertDialogDescription>
</AlertDialogHeader>
<AlertDialogFooter>
<AlertDialogCancel>Cancel</AlertDialogCancel>
<AlertDialogAction
onClick={handleDelete}
disabled={deleting}
className="bg-destructive text-destructive-foreground hover:bg-destructive/90"
>
{deleting && <Loader2 className="w-4 h-4 mr-2 animate-spin" />}
Delete
</AlertDialogAction>
</AlertDialogFooter>
</AlertDialogContent>
</AlertDialog>
</div>
)
}
File diff suppressed because it is too large. Load diff
+3 -2
View File
@@ -90,6 +90,9 @@ export default function AdminLayout({
const router = useRouter()
const { user } = useAuth()
const [isChecking, setIsChecking] = useState(true)
// IMPORTANT: All hooks must be called before any conditional returns
// to satisfy React's Rules of Hooks
const { showTestData, setShowTestData } = useAdminSettings()
useEffect(() => {
const token = getAccessToken()
@@ -127,8 +130,6 @@ export default function AdminLayout({
)
}
const { showTestData, setShowTestData } = useAdminSettings()
return (
<SidebarProvider>
<AdminSidebar />
@@ -0,0 +1,424 @@
/**
* Tests for Admin Rate Limits Page
*
* Tests the rate limits admin page functionality including:
* - Loading states and data fetching
* - Tab navigation (Overview, Blocklists, User Overrides)
* - Blocklist management (add, remove, search)
* - User override management (add, remove)
*/
import { render, screen, waitFor, fireEvent } from "@testing-library/react"
import userEvent from "@testing-library/user-event"
import AdminRateLimitsPage from "../page"
// Mock the API module
jest.mock("@/lib/api", () => ({
adminApi: {
getRateLimitStats: jest.fn(),
getBlocklists: jest.fn(),
getUserOverrides: jest.fn(),
addDisposableDomain: jest.fn(),
removeDisposableDomain: jest.fn(),
addBlockedEmail: jest.fn(),
removeBlockedEmail: jest.fn(),
addBlockedIP: jest.fn(),
removeBlockedIP: jest.fn(),
setUserOverride: jest.fn(),
removeUserOverride: jest.fn(),
},
}))
// Mock the toast hook
const mockToast = jest.fn()
jest.mock("@/hooks/use-toast", () => ({
useToast: () => ({
toast: mockToast,
}),
}))
// Import the mocked module
import { adminApi } from "@/lib/api"
const mockAdminApi = adminApi as jest.Mocked<typeof adminApi>
// Mock data
const mockStats = {
jobs_per_day_limit: 5,
youtube_uploads_per_day_limit: 10,
beta_ip_per_day_limit: 1,
rate_limiting_enabled: true,
youtube_uploads_today: 3,
youtube_uploads_remaining: 7,
disposable_domains_count: 130,
blocked_emails_count: 2,
blocked_ips_count: 1,
total_overrides: 1,
}
const mockBlocklists = {
disposable_domains: ["tempmail.com", "mailinator.com", "guerrillamail.com"],
blocked_emails: ["spammer@example.com", "abuse@test.com"],
blocked_ips: ["192.168.1.100"],
updated_at: "2025-01-09T10:00:00Z",
updated_by: "admin@nomadkaraoke.com",
}
const mockOverrides = {
overrides: [
{
email: "vip@example.com",
bypass_job_limit: true,
custom_daily_job_limit: null,
reason: "VIP user",
created_by: "admin@nomadkaraoke.com",
created_at: "2025-01-08T15:00:00Z",
},
],
total: 1,
}
describe("AdminRateLimitsPage", () => {
beforeEach(() => {
jest.clearAllMocks()
mockAdminApi.getRateLimitStats.mockResolvedValue(mockStats)
mockAdminApi.getBlocklists.mockResolvedValue(mockBlocklists)
mockAdminApi.getUserOverrides.mockResolvedValue(mockOverrides)
})
describe("Loading State", () => {
it("shows loading spinner initially", () => {
// Don't resolve the promises immediately
mockAdminApi.getRateLimitStats.mockImplementation(
() => new Promise(() => {})
)
mockAdminApi.getBlocklists.mockImplementation(
() => new Promise(() => {})
)
mockAdminApi.getUserOverrides.mockImplementation(
() => new Promise(() => {})
)
render(<AdminRateLimitsPage />)
// Should show loading spinner (check for the animate-spin class on the SVG)
const spinner = document.querySelector(".animate-spin")
expect(spinner).toBeInTheDocument()
})
it("loads and displays data", async () => {
render(<AdminRateLimitsPage />)
await waitFor(() => {
expect(screen.getByText("Rate Limits")).toBeInTheDocument()
})
// Verify API calls were made
expect(mockAdminApi.getRateLimitStats).toHaveBeenCalled()
expect(mockAdminApi.getBlocklists).toHaveBeenCalled()
expect(mockAdminApi.getUserOverrides).toHaveBeenCalled()
})
it("shows error toast on API failure", async () => {
mockAdminApi.getRateLimitStats.mockRejectedValue(
new Error("Network error")
)
render(<AdminRateLimitsPage />)
await waitFor(() => {
expect(mockToast).toHaveBeenCalledWith(
expect.objectContaining({
title: "Error",
variant: "destructive",
})
)
})
})
})
describe("Overview Tab", () => {
it("displays rate limit configuration stats", async () => {
render(<AdminRateLimitsPage />)
await waitFor(() => {
expect(screen.getByText("Rate Limit Configuration")).toBeInTheDocument()
})
// Check that stats are displayed
expect(screen.getByText("Jobs Per Day")).toBeInTheDocument()
expect(screen.getByText("5")).toBeInTheDocument()
expect(screen.getByText("YouTube Uploads")).toBeInTheDocument()
expect(screen.getByText("10")).toBeInTheDocument()
})
it("displays current usage statistics", async () => {
render(<AdminRateLimitsPage />)
await waitFor(() => {
expect(screen.getByText("Today's Usage")).toBeInTheDocument()
})
expect(screen.getByText("YouTube Uploads Today")).toBeInTheDocument()
expect(screen.getByText("3")).toBeInTheDocument()
})
it("displays rate limiting status badge", async () => {
render(<AdminRateLimitsPage />)
await waitFor(() => {
expect(screen.getByText("Enabled")).toBeInTheDocument()
})
})
})
describe("Tab Navigation", () => {
it("switches to Blocklists tab", async () => {
const user = userEvent.setup()
render(<AdminRateLimitsPage />)
await waitFor(() => {
expect(screen.getByText("Rate Limits")).toBeInTheDocument()
})
// Click Blocklists tab
await user.click(screen.getByRole("tab", { name: /blocklists/i }))
// Should show blocklist content
expect(screen.getByText("Disposable Email Domains")).toBeInTheDocument()
})
it("switches to User Overrides tab", async () => {
const user = userEvent.setup()
render(<AdminRateLimitsPage />)
await waitFor(() => {
expect(screen.getByText("Rate Limits")).toBeInTheDocument()
})
// Click User Overrides tab
await user.click(screen.getByRole("tab", { name: /user overrides/i }))
// Should show overrides content
expect(
screen.getByText("Users with custom rate limits or bypass permissions")
).toBeInTheDocument()
})
})
describe("Blocklists Tab", () => {
it("displays disposable domains list", async () => {
const user = userEvent.setup()
render(<AdminRateLimitsPage />)
await waitFor(() => {
expect(screen.getByText("Rate Limits")).toBeInTheDocument()
})
await user.click(screen.getByRole("tab", { name: /blocklists/i }))
// Should show domains
expect(screen.getByText("tempmail.com")).toBeInTheDocument()
expect(screen.getByText("mailinator.com")).toBeInTheDocument()
})
it("filters domains by search", async () => {
const user = userEvent.setup()
render(<AdminRateLimitsPage />)
await waitFor(() => {
expect(screen.getByText("Rate Limits")).toBeInTheDocument()
})
await user.click(screen.getByRole("tab", { name: /blocklists/i }))
// Type in search box
const searchInput = screen.getByPlaceholderText("Search domains...")
await user.type(searchInput, "temp")
// Should show filtered results
expect(screen.getByText("tempmail.com")).toBeInTheDocument()
// mailinator should not match "temp" filter
})
it("adds a disposable domain", async () => {
mockAdminApi.addDisposableDomain.mockResolvedValue({ success: true })
const user = userEvent.setup()
render(<AdminRateLimitsPage />)
await waitFor(() => {
expect(screen.getByText("Rate Limits")).toBeInTheDocument()
})
await user.click(screen.getByRole("tab", { name: /blocklists/i }))
// Type new domain
const input = screen.getByPlaceholderText(
"Add domain (e.g., tempmail.com)"
)
await user.type(input, "newspam.com")
// Click Add button
const addButton = screen
.getAllByRole("button", { name: /add/i })
.find((btn) => btn.textContent?.includes("Add"))!
await user.click(addButton)
await waitFor(() => {
expect(mockAdminApi.addDisposableDomain).toHaveBeenCalledWith(
"newspam.com"
)
})
})
it("displays blocked emails", async () => {
const user = userEvent.setup()
render(<AdminRateLimitsPage />)
await waitFor(() => {
expect(screen.getByText("Rate Limits")).toBeInTheDocument()
})
await user.click(screen.getByRole("tab", { name: /blocklists/i }))
expect(screen.getByText("spammer@example.com")).toBeInTheDocument()
})
it("displays blocked IPs", async () => {
const user = userEvent.setup()
render(<AdminRateLimitsPage />)
await waitFor(() => {
expect(screen.getByText("Rate Limits")).toBeInTheDocument()
})
await user.click(screen.getByRole("tab", { name: /blocklists/i }))
expect(screen.getByText("192.168.1.100")).toBeInTheDocument()
})
})
describe("User Overrides Tab", () => {
it("displays existing overrides", async () => {
const user = userEvent.setup()
render(<AdminRateLimitsPage />)
await waitFor(() => {
expect(screen.getByText("Rate Limits")).toBeInTheDocument()
})
await user.click(screen.getByRole("tab", { name: /user overrides/i }))
// Should show override in table
expect(screen.getByText("vip@example.com")).toBeInTheDocument()
expect(screen.getByText("VIP user")).toBeInTheDocument()
expect(screen.getByText("Bypass All")).toBeInTheDocument()
})
it("opens add override dialog", async () => {
const user = userEvent.setup()
render(<AdminRateLimitsPage />)
await waitFor(() => {
expect(screen.getByText("Rate Limits")).toBeInTheDocument()
})
await user.click(screen.getByRole("tab", { name: /user overrides/i }))
// Click Add Override button
await user.click(screen.getByRole("button", { name: /add override/i }))
// Should show dialog
expect(screen.getByText("Add User Override")).toBeInTheDocument()
expect(
screen.getByText(
"Grant a user custom rate limits or bypass permissions"
)
).toBeInTheDocument()
})
it("creates a new override", async () => {
mockAdminApi.setUserOverride.mockResolvedValue({ success: true })
const user = userEvent.setup()
render(<AdminRateLimitsPage />)
await waitFor(() => {
expect(screen.getByText("Rate Limits")).toBeInTheDocument()
})
await user.click(screen.getByRole("tab", { name: /user overrides/i }))
// Open dialog
await user.click(screen.getByRole("button", { name: /add override/i }))
// Fill form
const emailInput = screen.getByPlaceholderText("user@example.com")
await user.type(emailInput, "newuser@example.com")
const reasonInput = screen.getByPlaceholderText(
"Reason for this override..."
)
await user.type(reasonInput, "Test user needs extra access")
// Enable bypass
const bypassSwitch = screen.getByRole("switch")
await user.click(bypassSwitch)
// Submit
const submitButton = screen
.getAllByRole("button", { name: /add override/i })
.find((btn) => btn.closest("[role='dialog']"))!
await user.click(submitButton)
await waitFor(() => {
expect(mockAdminApi.setUserOverride).toHaveBeenCalledWith(
"newuser@example.com",
expect.objectContaining({
bypass_job_limit: true,
reason: "Test user needs extra access",
})
)
})
})
it("shows empty state when no overrides", async () => {
mockAdminApi.getUserOverrides.mockResolvedValue({ overrides: [], total: 0 })
const user = userEvent.setup()
render(<AdminRateLimitsPage />)
await waitFor(() => {
expect(screen.getByText("Rate Limits")).toBeInTheDocument()
})
await user.click(screen.getByRole("tab", { name: /user overrides/i }))
expect(screen.getByText("No user overrides configured")).toBeInTheDocument()
})
})
describe("Refresh Button", () => {
it("reloads data when clicked", async () => {
const user = userEvent.setup()
render(<AdminRateLimitsPage />)
await waitFor(() => {
expect(screen.getByText("Rate Limits")).toBeInTheDocument()
})
// Clear previous calls
jest.clearAllMocks()
// Click refresh
await user.click(screen.getByRole("button", { name: /refresh/i }))
await waitFor(() => {
expect(mockAdminApi.getRateLimitStats).toHaveBeenCalled()
expect(mockAdminApi.getBlocklists).toHaveBeenCalled()
expect(mockAdminApi.getUserOverrides).toHaveBeenCalled()
})
})
})
})
+709
View File
@@ -0,0 +1,709 @@
"use client"
import { useEffect, useState } from "react"
import {
adminApi,
RateLimitStatsResponse,
BlocklistsResponse,
UserOverridesListResponse,
UserOverride,
} from "@/lib/api"
import { StatsCard, StatsGrid } from "@/components/admin/stats-card"
import { Card, CardContent, CardDescription, CardHeader, CardTitle } from "@/components/ui/card"
import { Badge } from "@/components/ui/badge"
import { Input } from "@/components/ui/input"
import { Button } from "@/components/ui/button"
import { Label } from "@/components/ui/label"
import { Switch } from "@/components/ui/switch"
import { Textarea } from "@/components/ui/textarea"
import { Tabs, TabsContent, TabsList, TabsTrigger } from "@/components/ui/tabs"
import {
Table,
TableBody,
TableCell,
TableHead,
TableHeader,
TableRow,
} from "@/components/ui/table"
import {
Dialog,
DialogContent,
DialogDescription,
DialogFooter,
DialogHeader,
DialogTitle,
DialogTrigger,
} from "@/components/ui/dialog"
import {
AlertDialog,
AlertDialogAction,
AlertDialogCancel,
AlertDialogContent,
AlertDialogDescription,
AlertDialogFooter,
AlertDialogHeader,
AlertDialogTitle,
AlertDialogTrigger,
} from "@/components/ui/alert-dialog"
import {
ShieldAlert,
Youtube,
Briefcase,
Globe,
Mail,
Server,
UserCheck,
RefreshCw,
Loader2,
Plus,
Trash2,
Search,
} from "lucide-react"
import { useToast } from "@/hooks/use-toast"
export default function AdminRateLimitsPage() {
const { toast } = useToast()
const [stats, setStats] = useState<RateLimitStatsResponse | null>(null)
const [blocklists, setBlocklists] = useState<BlocklistsResponse | null>(null)
const [overrides, setOverrides] = useState<UserOverridesListResponse | null>(null)
const [loading, setLoading] = useState(true)
const [activeTab, setActiveTab] = useState("overview")
// Form states
const [newDomain, setNewDomain] = useState("")
const [newEmail, setNewEmail] = useState("")
const [newIP, setNewIP] = useState("")
const [searchDomain, setSearchDomain] = useState("")
const [searchEmail, setSearchEmail] = useState("")
const [searchIP, setSearchIP] = useState("")
// Override form
const [overrideEmail, setOverrideEmail] = useState("")
const [overrideBypass, setOverrideBypass] = useState(false)
const [overrideCustomLimit, setOverrideCustomLimit] = useState("")
const [overrideReason, setOverrideReason] = useState("")
const [overrideDialogOpen, setOverrideDialogOpen] = useState(false)
const loadData = async () => {
try {
setLoading(true)
const [statsData, blocklistsData, overridesData] = await Promise.all([
adminApi.getRateLimitStats(),
adminApi.getBlocklists(),
adminApi.getUserOverrides(),
])
setStats(statsData)
setBlocklists(blocklistsData)
setOverrides(overridesData)
} catch (err: any) {
console.error("Failed to load rate limits data:", err)
toast({
title: "Error",
description: err.message || "Failed to load rate limits data",
variant: "destructive",
})
} finally {
setLoading(false)
}
}
useEffect(() => {
loadData()
}, [])
// Blocklist actions
const handleAddDomain = async () => {
if (!newDomain.trim()) return
try {
await adminApi.addDisposableDomain(newDomain.trim())
toast({ title: "Success", description: `Domain "${newDomain}" added to blocklist` })
setNewDomain("")
loadData()
} catch (err: any) {
toast({ title: "Error", description: err.message, variant: "destructive" })
}
}
const handleRemoveDomain = async (domain: string) => {
try {
await adminApi.removeDisposableDomain(domain)
toast({ title: "Success", description: `Domain "${domain}" removed from blocklist` })
loadData()
} catch (err: any) {
toast({ title: "Error", description: err.message, variant: "destructive" })
}
}
const handleAddEmail = async () => {
if (!newEmail.trim()) return
try {
await adminApi.addBlockedEmail(newEmail.trim())
toast({ title: "Success", description: `Email "${newEmail}" added to blocklist` })
setNewEmail("")
loadData()
} catch (err: any) {
toast({ title: "Error", description: err.message, variant: "destructive" })
}
}
const handleRemoveEmail = async (email: string) => {
try {
await adminApi.removeBlockedEmail(email)
toast({ title: "Success", description: `Email "${email}" removed from blocklist` })
loadData()
} catch (err: any) {
toast({ title: "Error", description: err.message, variant: "destructive" })
}
}
const handleAddIP = async () => {
if (!newIP.trim()) return
try {
await adminApi.addBlockedIP(newIP.trim())
toast({ title: "Success", description: `IP "${newIP}" added to blocklist` })
setNewIP("")
loadData()
} catch (err: any) {
toast({ title: "Error", description: err.message, variant: "destructive" })
}
}
const handleRemoveIP = async (ip: string) => {
try {
await adminApi.removeBlockedIP(ip)
toast({ title: "Success", description: `IP "${ip}" removed from blocklist` })
loadData()
} catch (err: any) {
toast({ title: "Error", description: err.message, variant: "destructive" })
}
}
// Override actions
const handleAddOverride = async () => {
if (!overrideEmail.trim() || !overrideReason.trim()) {
toast({ title: "Error", description: "Email and reason are required", variant: "destructive" })
return
}
try {
await adminApi.setUserOverride(overrideEmail.trim(), {
bypass_job_limit: overrideBypass,
custom_daily_job_limit: overrideCustomLimit ? parseInt(overrideCustomLimit) : undefined,
reason: overrideReason.trim(),
})
toast({ title: "Success", description: `Override set for "${overrideEmail}"` })
setOverrideEmail("")
setOverrideBypass(false)
setOverrideCustomLimit("")
setOverrideReason("")
setOverrideDialogOpen(false)
loadData()
} catch (err: any) {
toast({ title: "Error", description: err.message, variant: "destructive" })
}
}
const handleRemoveOverride = async (email: string) => {
try {
await adminApi.removeUserOverride(email)
toast({ title: "Success", description: `Override removed for "${email}"` })
loadData()
} catch (err: any) {
toast({ title: "Error", description: err.message, variant: "destructive" })
}
}
const formatDate = (dateStr?: string) => {
if (!dateStr) return "—"
const date = new Date(dateStr)
if (isNaN(date.getTime())) return "—"
return date.toLocaleDateString("en-US", {
year: "numeric",
month: "short",
day: "numeric",
hour: "2-digit",
minute: "2-digit",
})
}
// Filter functions
const filteredDomains = blocklists?.disposable_domains.filter(d =>
d.toLowerCase().includes(searchDomain.toLowerCase())
) || []
const filteredEmails = blocklists?.blocked_emails.filter(e =>
e.toLowerCase().includes(searchEmail.toLowerCase())
) || []
const filteredIPs = blocklists?.blocked_ips.filter(ip =>
ip.includes(searchIP)
) || []
if (loading && !stats) {
return (
<div className="flex items-center justify-center h-64">
<Loader2 className="w-8 h-8 animate-spin text-muted-foreground" />
</div>
)
}
return (
<div className="space-y-6">
<div className="flex items-center justify-between">
<div>
<h1 className="text-3xl font-bold">Rate Limits</h1>
<p className="text-muted-foreground">
Manage rate limiting, blocklists, and user overrides
</p>
</div>
<Button onClick={loadData} variant="outline" disabled={loading}>
<RefreshCw className={`w-4 h-4 mr-2 ${loading ? "animate-spin" : ""}`} />
Refresh
</Button>
</div>
<Tabs value={activeTab} onValueChange={setActiveTab}>
<TabsList>
<TabsTrigger value="overview">Overview</TabsTrigger>
<TabsTrigger value="blocklists">Blocklists</TabsTrigger>
<TabsTrigger value="overrides">User Overrides</TabsTrigger>
</TabsList>
{/* Overview Tab */}
<TabsContent value="overview" className="space-y-6">
{/* Configuration Stats */}
<Card>
<CardHeader>
<CardTitle className="flex items-center gap-2">
<ShieldAlert className="w-5 h-5" />
Rate Limit Configuration
</CardTitle>
<CardDescription>Current rate limiting settings</CardDescription>
</CardHeader>
<CardContent>
<StatsGrid columns={4}>
<StatsCard
title="Jobs Per Day"
value={stats?.jobs_per_day_limit ?? 0}
description="Per user limit"
icon={Briefcase}
/>
<StatsCard
title="YouTube Uploads"
value={stats?.youtube_uploads_per_day_limit ?? 0}
description="System-wide limit"
icon={Youtube}
/>
<StatsCard
title="Beta IP Limit"
value={stats?.beta_ip_per_day_limit ?? 0}
description="Enrollments per IP/day"
icon={Globe}
/>
<StatsCard
title="Status"
value={stats?.rate_limiting_enabled ? "Enabled" : "Disabled"}
description="Rate limiting"
icon={ShieldAlert}
valueClassName={stats?.rate_limiting_enabled ? "text-green-600" : "text-red-600"}
/>
</StatsGrid>
</CardContent>
</Card>
{/* Current Usage Stats */}
<Card>
<CardHeader>
<CardTitle className="flex items-center gap-2">
<Youtube className="w-5 h-5" />
Today&apos;s Usage
</CardTitle>
<CardDescription>Current rate limit usage</CardDescription>
</CardHeader>
<CardContent>
<StatsGrid columns={3}>
<StatsCard
title="YouTube Uploads Today"
value={stats?.youtube_uploads_today ?? 0}
description={`${stats?.youtube_uploads_remaining ?? 0} remaining`}
icon={Youtube}
/>
<StatsCard
title="Blocked Domains"
value={stats?.disposable_domains_count ?? 0}
description="Disposable email domains"
icon={Globe}
/>
<StatsCard
title="User Overrides"
value={stats?.total_overrides ?? 0}
description="Active whitelist entries"
icon={UserCheck}
/>
</StatsGrid>
</CardContent>
</Card>
{/* Blocklist Summary */}
<Card>
<CardHeader>
<CardTitle className="flex items-center gap-2">
<Mail className="w-5 h-5" />
Blocklist Summary
</CardTitle>
</CardHeader>
<CardContent>
<StatsGrid columns={3}>
<StatsCard
title="Disposable Domains"
value={stats?.disposable_domains_count ?? 0}
icon={Globe}
/>
<StatsCard
title="Blocked Emails"
value={stats?.blocked_emails_count ?? 0}
icon={Mail}
/>
<StatsCard
title="Blocked IPs"
value={stats?.blocked_ips_count ?? 0}
icon={Server}
/>
</StatsGrid>
</CardContent>
</Card>
</TabsContent>
{/* Blocklists Tab */}
<TabsContent value="blocklists" className="space-y-6">
{/* Disposable Domains */}
<Card>
<CardHeader>
<CardTitle className="flex items-center gap-2">
<Globe className="w-5 h-5" />
Disposable Email Domains
</CardTitle>
<CardDescription>
Domains blocked from beta enrollment ({filteredDomains.length} of {blocklists?.disposable_domains.length || 0})
</CardDescription>
</CardHeader>
<CardContent className="space-y-4">
<div className="flex gap-2">
<div className="relative flex-1">
<Search className="absolute left-3 top-1/2 -translate-y-1/2 w-4 h-4 text-muted-foreground" />
<Input
placeholder="Search domains..."
value={searchDomain}
onChange={(e) => setSearchDomain(e.target.value)}
className="pl-9"
/>
</div>
<Input
placeholder="Add domain (e.g., tempmail.com)"
value={newDomain}
onChange={(e) => setNewDomain(e.target.value)}
className="w-64"
onKeyDown={(e) => e.key === "Enter" && handleAddDomain()}
/>
<Button onClick={handleAddDomain} disabled={!newDomain.trim()}>
<Plus className="w-4 h-4 mr-2" />
Add
</Button>
</div>
<div className="max-h-64 overflow-y-auto border rounded-md">
<div className="flex flex-wrap gap-2 p-3">
{filteredDomains.slice(0, 100).map((domain) => (
<Badge key={domain} variant="secondary" className="flex items-center gap-1">
{domain}
<button
onClick={() => handleRemoveDomain(domain)}
className="ml-1 hover:text-destructive"
>
<Trash2 className="w-3 h-3" />
</button>
</Badge>
))}
{filteredDomains.length > 100 && (
<span className="text-muted-foreground text-sm">
+{filteredDomains.length - 100} more
</span>
)}
</div>
</div>
</CardContent>
</Card>
{/* Blocked Emails */}
<Card>
<CardHeader>
<CardTitle className="flex items-center gap-2">
<Mail className="w-5 h-5" />
Blocked Emails
</CardTitle>
<CardDescription>
Specific email addresses blocked ({filteredEmails.length})
</CardDescription>
</CardHeader>
<CardContent className="space-y-4">
<div className="flex gap-2">
<div className="relative flex-1">
<Search className="absolute left-3 top-1/2 -translate-y-1/2 w-4 h-4 text-muted-foreground" />
<Input
placeholder="Search emails..."
value={searchEmail}
onChange={(e) => setSearchEmail(e.target.value)}
className="pl-9"
/>
</div>
<Input
placeholder="Add email address"
value={newEmail}
onChange={(e) => setNewEmail(e.target.value)}
className="w-64"
onKeyDown={(e) => e.key === "Enter" && handleAddEmail()}
/>
<Button onClick={handleAddEmail} disabled={!newEmail.trim()}>
<Plus className="w-4 h-4 mr-2" />
Add
</Button>
</div>
{filteredEmails.length === 0 ? (
<p className="text-muted-foreground text-sm py-4 text-center">
No blocked emails
</p>
) : (
<div className="max-h-48 overflow-y-auto border rounded-md">
<div className="flex flex-wrap gap-2 p-3">
{filteredEmails.map((email) => (
<Badge key={email} variant="destructive" className="flex items-center gap-1">
{email}
<button
onClick={() => handleRemoveEmail(email)}
className="ml-1 hover:text-white"
>
<Trash2 className="w-3 h-3" />
</button>
</Badge>
))}
</div>
</div>
)}
</CardContent>
</Card>
{/* Blocked IPs */}
<Card>
<CardHeader>
<CardTitle className="flex items-center gap-2">
<Server className="w-5 h-5" />
Blocked IP Addresses
</CardTitle>
<CardDescription>
IP addresses blocked from all operations ({filteredIPs.length})
</CardDescription>
</CardHeader>
<CardContent className="space-y-4">
<div className="flex gap-2">
<div className="relative flex-1">
<Search className="absolute left-3 top-1/2 -translate-y-1/2 w-4 h-4 text-muted-foreground" />
<Input
placeholder="Search IPs..."
value={searchIP}
onChange={(e) => setSearchIP(e.target.value)}
className="pl-9"
/>
</div>
<Input
placeholder="Add IP address"
value={newIP}
onChange={(e) => setNewIP(e.target.value)}
className="w-64"
onKeyDown={(e) => e.key === "Enter" && handleAddIP()}
/>
<Button onClick={handleAddIP} disabled={!newIP.trim()}>
<Plus className="w-4 h-4 mr-2" />
Add
</Button>
</div>
{filteredIPs.length === 0 ? (
<p className="text-muted-foreground text-sm py-4 text-center">
No blocked IPs
</p>
) : (
<div className="max-h-48 overflow-y-auto border rounded-md">
<div className="flex flex-wrap gap-2 p-3">
{filteredIPs.map((ip) => (
<Badge key={ip} variant="destructive" className="flex items-center gap-1">
{ip}
<button
onClick={() => handleRemoveIP(ip)}
className="ml-1 hover:text-white"
>
<Trash2 className="w-3 h-3" />
</button>
</Badge>
))}
</div>
</div>
)}
</CardContent>
</Card>
</TabsContent>
{/* User Overrides Tab */}
<TabsContent value="overrides" className="space-y-6">
<Card>
<CardHeader>
<div className="flex items-center justify-between">
<div>
<CardTitle className="flex items-center gap-2">
<UserCheck className="w-5 h-5" />
User Overrides
</CardTitle>
<CardDescription>
Users with custom rate limits or bypass permissions
</CardDescription>
</div>
<Dialog open={overrideDialogOpen} onOpenChange={setOverrideDialogOpen}>
<DialogTrigger asChild>
<Button>
<Plus className="w-4 h-4 mr-2" />
Add Override
</Button>
</DialogTrigger>
<DialogContent>
<DialogHeader>
<DialogTitle>Add User Override</DialogTitle>
<DialogDescription>
Grant a user custom rate limits or bypass permissions
</DialogDescription>
</DialogHeader>
<div className="space-y-4 py-4">
<div className="space-y-2">
<Label htmlFor="email">User Email</Label>
<Input
id="email"
placeholder="user@example.com"
value={overrideEmail}
onChange={(e) => setOverrideEmail(e.target.value)}
/>
</div>
<div className="flex items-center space-x-2">
<Switch
id="bypass"
checked={overrideBypass}
onCheckedChange={setOverrideBypass}
/>
<Label htmlFor="bypass">Bypass all job limits</Label>
</div>
{!overrideBypass && (
<div className="space-y-2">
<Label htmlFor="customLimit">Custom Daily Job Limit (optional)</Label>
<Input
id="customLimit"
type="number"
placeholder="Leave empty for default"
value={overrideCustomLimit}
onChange={(e) => setOverrideCustomLimit(e.target.value)}
/>
</div>
)}
<div className="space-y-2">
<Label htmlFor="reason">Reason</Label>
<Textarea
id="reason"
placeholder="Reason for this override..."
value={overrideReason}
onChange={(e) => setOverrideReason(e.target.value)}
/>
</div>
</div>
<DialogFooter>
<Button variant="outline" onClick={() => setOverrideDialogOpen(false)}>
Cancel
</Button>
<Button onClick={handleAddOverride}>Add Override</Button>
</DialogFooter>
</DialogContent>
</Dialog>
</div>
</CardHeader>
<CardContent>
{!overrides?.overrides.length ? (
<p className="text-muted-foreground text-sm py-8 text-center">
No user overrides configured
</p>
) : (
<Table>
<TableHeader>
<TableRow>
<TableHead>Email</TableHead>
<TableHead>Type</TableHead>
<TableHead>Reason</TableHead>
<TableHead>Created By</TableHead>
<TableHead>Created</TableHead>
<TableHead className="w-[100px]">Actions</TableHead>
</TableRow>
</TableHeader>
<TableBody>
{overrides.overrides.map((override) => (
<TableRow key={override.email}>
<TableCell className="font-mono text-sm">{override.email}</TableCell>
<TableCell>
{override.bypass_job_limit ? (
<Badge variant="default">Bypass All</Badge>
) : override.custom_daily_job_limit ? (
<Badge variant="secondary">
Custom: {override.custom_daily_job_limit}/day
</Badge>
) : (
<Badge variant="outline">Default</Badge>
)}
</TableCell>
<TableCell className="max-w-[200px] truncate" title={override.reason}>
{override.reason}
</TableCell>
<TableCell className="text-sm text-muted-foreground">
{override.created_by}
</TableCell>
<TableCell className="text-sm text-muted-foreground">
{formatDate(override.created_at)}
</TableCell>
<TableCell>
<AlertDialog>
<AlertDialogTrigger asChild>
<Button variant="ghost" size="sm" className="text-destructive">
<Trash2 className="w-4 h-4" />
</Button>
</AlertDialogTrigger>
<AlertDialogContent>
<AlertDialogHeader>
<AlertDialogTitle>Remove Override</AlertDialogTitle>
<AlertDialogDescription>
Remove rate limit override for {override.email}? They will be subject
to normal rate limits.
</AlertDialogDescription>
</AlertDialogHeader>
<AlertDialogFooter>
<AlertDialogCancel>Cancel</AlertDialogCancel>
<AlertDialogAction
onClick={() => handleRemoveOverride(override.email)}
className="bg-destructive text-destructive-foreground hover:bg-destructive/90"
>
Remove
</AlertDialogAction>
</AlertDialogFooter>
</AlertDialogContent>
</AlertDialog>
</TableCell>
</TableRow>
))}
</TableBody>
</Table>
)}
</CardContent>
</Card>
</TabsContent>
</Tabs>
</div>
)
}
-42
View File
@@ -29,8 +29,6 @@ import {
RefreshCw,
Loader2,
Plus,
Shield,
ShieldOff,
UserX,
UserCheck,
CreditCard,
@@ -114,29 +112,6 @@ export default function AdminUserDetailPage() {
}
}
const handleToggleRole = async () => {
if (!user) return
const newRole = user.role === "admin" ? "user" : "admin"
try {
setActionLoading(true)
await adminApi.setUserRole(email, newRole)
toast({
title: "Role Updated",
description: `User is now ${newRole}`,
})
loadUser()
} catch (err: any) {
toast({
title: "Error",
description: err.message || "Failed to update role",
variant: "destructive",
})
} finally {
setActionLoading(false)
}
}
const handleToggleStatus = async () => {
if (!user) return
@@ -237,23 +212,6 @@ export default function AdminUserDetailPage() {
<Plus className="w-4 h-4 mr-2" />
Add Credits
</Button>
<Button
variant="outline"
onClick={handleToggleRole}
disabled={actionLoading}
>
{user.role === "admin" ? (
<>
<ShieldOff className="w-4 h-4 mr-2" />
Remove Admin
</>
) : (
<>
<Shield className="w-4 h-4 mr-2" />
Make Admin
</>
)}
</Button>
<Button
variant={user.is_active ? "destructive" : "outline"}
onClick={handleToggleStatus}
+27 -17
View File
@@ -40,17 +40,18 @@ import {
Plus,
Loader2,
CreditCard,
Shield,
ShieldOff,
LogIn,
UserX,
UserCheck,
} from "lucide-react"
import { useToast } from "@/hooks/use-toast"
import { useAuth } from "@/lib/auth"
export default function AdminUsersPage() {
const router = useRouter()
const { toast } = useToast()
const { showTestData } = useAdminSettings()
const { startImpersonation, user: currentUser } = useAuth()
const [users, setUsers] = useState<AdminUser[]>([])
const [loading, setLoading] = useState(true)
const [total, setTotal] = useState(0)
@@ -146,19 +147,31 @@ export default function AdminUsersPage() {
}
}
const handleToggleRole = async (user: AdminUser) => {
const newRole = user.role === "admin" ? "user" : "admin"
try {
await adminApi.setUserRole(user.email, newRole)
const handleImpersonate = async (user: AdminUser) => {
// Don't allow impersonating yourself
if (user.email === currentUser?.email) {
toast({
title: "Role Updated",
description: `${user.email} is now ${newRole}`,
title: "Cannot Impersonate",
description: "You cannot impersonate yourself",
variant: "destructive",
})
loadUsers()
return
}
try {
const success = await startImpersonation(user.email)
if (success) {
toast({
title: "Impersonating User",
description: `Now viewing as ${user.email}`,
})
// Redirect to main app to see the user's view
router.push("/app")
}
} catch (err: any) {
toast({
title: "Error",
description: err.message || "Failed to update role",
description: err.message || "Failed to impersonate user",
variant: "destructive",
})
}
@@ -283,14 +296,11 @@ export default function AdminUsersPage() {
<Button
variant="ghost"
size="icon"
onClick={() => handleToggleRole(user)}
title={user.role === "admin" ? "Remove admin" : "Make admin"}
onClick={() => handleImpersonate(user)}
title="Impersonate user"
disabled={user.email === currentUser?.email}
>
{user.role === "admin" ? (
<ShieldOff className="w-4 h-4" />
) : (
<Shield className="w-4 h-4" />
)}
<LogIn className="w-4 h-4" />
</Button>
</div>
</TableCell>
+62 -10
View File
@@ -1,9 +1,10 @@
"use client"
import { useState, useEffect, useCallback } from "react"
import { useRouter } from "next/navigation"
import { useState, useEffect, useCallback, Suspense, useRef } from "react"
import { useRouter, useSearchParams } from "next/navigation"
import { api, Job, getAccessToken } from "@/lib/api"
import { useAuth } from "@/lib/auth"
import { useAdminSettings } from "@/lib/admin-settings"
import { useJobNotifications, useVisibilityRefresh } from "@/hooks/use-notifications"
import { Button } from "@/components/ui/button"
import { Card, CardContent, CardDescription, CardHeader, CardTitle } from "@/components/ui/card"
@@ -14,6 +15,7 @@ import { JobSubmission } from "@/components/job/JobSubmission"
import { AuthStatus } from "@/components/auth"
import { AutoProcessor } from "@/components/AutoProcessor"
import { VersionFooter } from "@/components/version-footer"
import { PushNotificationPrompt } from "@/components/push-notification-prompt"
import { useTheme } from "@/lib/theme"
import {
Tooltip,
@@ -22,14 +24,21 @@ import {
TooltipTrigger,
} from "@/components/ui/tooltip"
export default function AppPage() {
function AppPageContent() {
const router = useRouter()
const searchParams = useSearchParams()
const [jobs, setJobs] = useState<Job[]>([])
const [isLoadingJobs, setIsLoadingJobs] = useState(true)
const [isInitialLoad, setIsInitialLoad] = useState(true)
const [isAuthenticated, setIsAuthenticated] = useState<boolean | null>(null)
const [isVerifyingToken, setIsVerifyingToken] = useState(false)
const adminTokenHandled = useRef(false) // Track if admin_token was already processed
const { isDarkMode, toggleTheme, mounted } = useTheme()
const { user, fetchUser } = useAuth()
const { user, fetchUser, verifyMagicLink } = useAuth()
const { showTestData } = useAdminSettings()
// Check if user is admin (for exclude_test parameter)
const isAdmin = user?.role === "admin" || user?.email?.endsWith("@nomadkaraoke.com")
// Memoize loadJobs for use with visibility refresh
const loadJobs = useCallback(async () => {
@@ -39,7 +48,11 @@ export default function AppPage() {
return
}
try {
const data = await api.listJobs({ limit: 20 })
// Only admins can filter test jobs, and by default we hide them
const data = await api.listJobs({
limit: 20,
exclude_test: isAdmin ? !showTestData : undefined
})
setJobs(data)
} catch (err: any) {
// Don't log auth errors - user just needs to authenticate
@@ -50,7 +63,7 @@ export default function AppPage() {
setIsLoadingJobs(false)
setIsInitialLoad(false)
}
}, [])
}, [isAdmin, showTestData])
// Enable notifications for job status changes (sound + title animation)
useJobNotifications(jobs)
@@ -58,8 +71,31 @@ export default function AppPage() {
// Refresh jobs immediately when tab becomes visible (after returning from review UIs)
useVisibilityRefresh(loadJobs, isAuthenticated === true)
// Check auth status on mount and redirect if not authenticated
// Handle admin_token URL parameter for one-click login from email
useEffect(() => {
const adminToken = searchParams.get("admin_token")
// Only process admin_token once (use ref to prevent repeated calls)
if (adminToken && !adminTokenHandled.current) {
adminTokenHandled.current = true
setIsVerifyingToken(true)
verifyMagicLink(adminToken).then((success) => {
// Clean URL by removing the token
window.history.replaceState({}, '', '/app')
setIsVerifyingToken(false)
if (success) {
setIsAuthenticated(true)
} else {
router.replace('/')
}
})
return
}
// Normal auth check (skip if admin_token is being processed)
if (adminToken || isVerifyingToken) return
const token = getAccessToken()
if (!token) {
// Redirect to landing page if not authenticated
@@ -67,7 +103,7 @@ export default function AppPage() {
return
}
setIsAuthenticated(true)
}, [router])
}, [router, searchParams, verifyMagicLink, isVerifyingToken])
// Ensure user data is loaded after authentication
// This handles the case where user navigates via client-side navigation
@@ -91,8 +127,8 @@ export default function AppPage() {
return () => clearInterval(interval)
}, [isAuthenticated, loadJobs])
// Show nothing while checking auth (prevents flash)
if (isAuthenticated === null) {
// Show nothing while checking auth or verifying admin token (prevents flash)
if (isAuthenticated === null || isVerifyingToken) {
return (
<div className="min-h-screen flex items-center justify-center animated-gradient">
<Loader2 className="w-8 h-8 animate-spin" style={{ color: 'var(--text-muted)' }} />
@@ -165,6 +201,9 @@ export default function AppPage() {
</header>
<main className="px-4 pt-24 pb-8 space-y-6">
{/* Push notification prompt - shows once when appropriate */}
<PushNotificationPrompt />
<div className="grid lg:grid-cols-2 gap-8">
{/* Submit Job Card */}
<Card className="backdrop-blur" style={{ borderColor: 'var(--card-border)', backgroundColor: 'var(--card)' }}>
@@ -212,3 +251,16 @@ export default function AppPage() {
</div>
)
}
// Wrap with Suspense for useSearchParams
export default function AppPage() {
return (
<Suspense fallback={
<div className="min-h-screen flex items-center justify-center animated-gradient">
<Loader2 className="w-8 h-8 animate-spin" style={{ color: 'var(--text-muted)' }} />
</div>
}>
<AppPageContent />
</Suspense>
)
}
+12 -3
View File
@@ -19,6 +19,15 @@
--brand-blue: #3b82f6;
--brand-soft-pink: #ec4899;
/* ===========================================
Tenant Branding Colors (set dynamically by JS)
These are overridden by TenantProvider for white-label portals
=========================================== */
--tenant-primary: var(--brand-pink);
--tenant-secondary: var(--brand-purple);
--tenant-accent: var(--brand-gold);
--tenant-background: #0f0f0f;
/* Dark theme (default) */
--bg: #0f0f0f;
--card: #1a1a1a;
@@ -28,9 +37,9 @@
--text-muted: #888888;
--text-subtle: #666666;
/* Primary now uses brand pink */
--primary: var(--brand-pink);
--primary-hover: var(--brand-pink-hover);
/* Primary uses tenant color (defaults to brand pink) */
--primary: var(--tenant-primary);
--primary-hover: color-mix(in srgb, var(--tenant-primary) 80%, white 20%);
--secondary: #252525;
--secondary-hover: #333333;
+9 -1
View File
@@ -1,6 +1,9 @@
import type React from "react"
import type { Metadata } from "next"
import { ThemeProvider } from "@/components/theme-provider"
import { TenantProvider } from "@/components/tenant-provider"
import { ImpersonationBannerWrapper } from "@/components/impersonation-banner-wrapper"
import { ServiceWorkerRegistration } from "@/components/service-worker-registration"
import "./globals.css"
export const metadata: Metadata = {
@@ -14,6 +17,7 @@ export const metadata: Metadata = {
],
apple: "/apple-touch-icon.png",
},
manifest: "/manifest.webmanifest",
}
export default function RootLayout({
@@ -24,13 +28,17 @@ export default function RootLayout({
return (
<html lang="en" suppressHydrationWarning>
<body className="font-sans antialiased" style={{ background: 'var(--bg)', color: 'var(--text)' }}>
<ServiceWorkerRegistration />
<ThemeProvider
attribute="class"
defaultTheme="dark"
enableSystem
disableTransitionOnChange
>
{children}
<TenantProvider>
<ImpersonationBannerWrapper />
{children}
</TenantProvider>
</ThemeProvider>
</body>
</html>
+79
View File
@@ -0,0 +1,79 @@
"use client"
import { Suspense } from "react"
import { useSearchParams } from "next/navigation"
import { CheckCircle, Loader2, Mail, Clock } from "lucide-react"
import { Button } from "@/components/ui/button"
function OrderSuccessContent() {
const searchParams = useSearchParams()
const sessionId = searchParams.get("session_id")
return (
<div className="max-w-md w-full bg-card border border-border rounded-xl p-8 text-center">
<CheckCircle className="w-16 h-16 text-success mx-auto mb-4" />
<h1 className="text-2xl font-bold text-foreground mb-2">
Order Confirmed!
</h1>
<p className="text-muted-foreground mb-6">
Thank you for your order. We&apos;re creating your custom karaoke video now.
</p>
<div className="space-y-4 mb-6">
<div className="flex items-center gap-3 text-left p-3 bg-secondary rounded-lg">
<Clock className="w-5 h-5 text-primary flex-shrink-0" />
<div>
<p className="font-medium text-foreground">Delivery within 24 hours</p>
<p className="text-sm text-muted-foreground">
Most orders are completed in just a few hours
</p>
</div>
</div>
<div className="flex items-center gap-3 text-left p-3 bg-secondary rounded-lg">
<Mail className="w-5 h-5 text-primary flex-shrink-0" />
<div>
<p className="font-medium text-foreground">Check your email</p>
<p className="text-sm text-muted-foreground">
We&apos;ll send your video when it&apos;s ready
</p>
</div>
</div>
</div>
<div className="space-y-3">
<Button
asChild
className="w-full bg-primary hover:bg-primary/90"
>
<a href="https://nomadkaraoke.com">
Back to Nomad Karaoke
</a>
</Button>
<p className="text-xs text-muted-foreground">
Questions? Email us at help@nomadkaraoke.com
</p>
</div>
</div>
)
}
export default function OrderSuccessPage() {
return (
<div className="min-h-screen bg-background flex items-center justify-center p-4">
<Suspense
fallback={
<div className="max-w-md w-full bg-card border border-border rounded-xl p-8 text-center">
<Loader2 className="w-16 h-16 text-primary mx-auto mb-4 animate-spin" />
<p className="text-muted-foreground">Loading...</p>
</div>
}
>
<OrderSuccessContent />
</Suspense>
</div>
)
}
+359 -3
View File
@@ -14,6 +14,12 @@ import {
MessageSquare,
Mail,
Loader2,
Search,
Link as LinkIcon,
Upload,
Clock,
FileVideo,
CreditCard,
} from 'lucide-react';
import { api, setAccessToken, getAccessToken, CreditPackage, BetaEnrollResponse } from '@/lib/api';
import { AuthDialog } from '@/components/auth/AuthDialog';
@@ -70,6 +76,15 @@ export default function LandingPage() {
const [betaSuccess, setBetaSuccess] = useState(false);
const [betaWillRedirect, setBetaWillRedirect] = useState(false);
// Made For You form state
const [mfyArtist, setMfyArtist] = useState('');
const [mfyTitle, setMfyTitle] = useState('');
const [mfySourceType, setMfySourceType] = useState<'search' | 'youtube' | 'upload'>('search');
const [mfyYoutubeUrl, setMfyYoutubeUrl] = useState('');
const [mfyEmail, setMfyEmail] = useState('');
const [mfyNotes, setMfyNotes] = useState('');
const [mfyLoading, setMfyLoading] = useState(false);
const [mfyError, setMfyError] = useState<string | null>(null);
// Auth dialog state
const [showAuthDialog, setShowAuthDialog] = useState(false);
@@ -193,6 +208,49 @@ export default function LandingPage() {
}
};
// Handle Made For You checkout
const handleMadeForYouSubmit = async (e: React.FormEvent) => {
e.preventDefault();
setMfyError(null);
// Validation
if (!mfyArtist.trim()) {
setMfyError('Please enter the artist name');
return;
}
if (!mfyTitle.trim()) {
setMfyError('Please enter the song title');
return;
}
if (!mfyEmail.trim()) {
setMfyError('Please enter your email address');
return;
}
if (mfySourceType === 'youtube' && !mfyYoutubeUrl.trim()) {
setMfyError('Please enter a YouTube URL');
return;
}
setMfyLoading(true);
try {
const checkoutUrl = await api.createMadeForYouCheckout({
email: mfyEmail,
artist: mfyArtist,
title: mfyTitle,
source_type: mfySourceType,
youtube_url: mfySourceType === 'youtube' ? mfyYoutubeUrl : undefined,
notes: mfyNotes || undefined,
});
// Redirect to Stripe Checkout
window.location.href = checkoutUrl;
} catch (err) {
setMfyError(err instanceof Error ? err.message : 'Something went wrong. Please try again.');
setMfyLoading(false);
}
};
const formatPrice = (cents: number) => `$${(cents / 100).toFixed(0)}`;
const pricePerVideo = (pkg: CreditPackage) =>
`$${(pkg.price_cents / 100 / pkg.credits).toFixed(2)}`;
@@ -236,12 +294,39 @@ export default function LandingPage() {
Create professional karaoke videos in under 30 minutes. Real instrumentals
from the original song, precise lyrics sync, and 4K video output.
</p>
{/* Two pricing options */}
<div className="flex flex-col sm:flex-row items-center justify-center gap-6 mb-6">
<div className="flex flex-col items-center gap-2">
<a
href="#pricing"
className="inline-flex items-center gap-2 bg-primary-500 hover:bg-primary-600 text-white font-semibold px-8 py-4 rounded-xl transition-all btn-glow"
>
<Video className="w-5 h-5" />
Create It Yourself
<span className="ml-1 px-2 py-0.5 bg-white/20 rounded-full text-sm">$5</span>
</a>
<span className="text-dark-400 text-sm">Review lyrics yourself in ~10 min</span>
</div>
<div className="flex flex-col items-center gap-2">
<a
href="#made-for-you"
className="inline-flex items-center gap-2 bg-yellow-500/20 hover:bg-yellow-500/30 text-yellow-400 border border-yellow-500/40 font-semibold px-8 py-4 rounded-xl transition-all"
>
<Gift className="w-5 h-5" />
We&apos;ll Make It For You
<span className="ml-1 px-2 py-0.5 bg-yellow-500/20 rounded-full text-sm">$15</span>
</a>
<span className="text-yellow-400/70 text-sm">We handle everything, delivered in 24h</span>
</div>
</div>
<a
href="#beta"
className="inline-flex items-center gap-2 bg-primary-500 hover:bg-primary-600 text-white font-semibold px-8 py-4 rounded-xl transition-all btn-glow"
className="inline-flex items-center gap-1 text-primary-400 hover:text-primary-300 text-sm font-medium transition-colors"
>
Try It For Free
<ChevronDown className="w-5 h-5" />
Or try it free as a beta tester
<ChevronDown className="w-4 h-4" />
</a>
</div>
</section>
@@ -595,6 +680,277 @@ export default function LandingPage() {
</div>
</section>
{/* Made For You Section */}
<section id="made-for-you" className="py-20 px-4">
<div className="max-w-6xl mx-auto">
{/* Section Header */}
<div className="text-center mb-12">
<div className="inline-flex items-center gap-2 bg-yellow-500/20 text-yellow-400 px-4 py-2 rounded-full text-sm font-medium mb-4">
<Gift className="w-4 h-4" />
Full-Service Option
</div>
<h2 className="text-3xl font-bold mb-4">We&apos;ll Make It For You</h2>
<p className="text-dark-400 max-w-2xl mx-auto mb-4">
Don&apos;t want to use the Generator and review the lyrics yourself? No problem.
Tell us the song, pay $15, and we&apos;ll deliver your karaoke video within 24 hours.
</p>
<p className="text-dark-500 text-sm max-w-xl mx-auto">
Don&apos;t want to spend 10 minutes reviewing lyrics? For just $10 more than DIY, we handle everything.
</p>
</div>
<div className="grid lg:grid-cols-2 gap-12 items-start">
{/* Benefits */}
<div>
<h3 className="text-xl font-semibold mb-6">What You Get</h3>
<div className="space-y-4">
<div className="bg-dark-800 border border-dark-700 rounded-xl p-4 flex items-start gap-4">
<div className="w-10 h-10 bg-primary-500/20 rounded-lg flex items-center justify-center shrink-0">
<FileVideo className="w-5 h-5 text-primary-400" />
</div>
<div>
<h4 className="font-medium">Professional 4K Video</h4>
<p className="text-dark-400 text-sm mt-1">
High-quality karaoke video with perfectly synced lyrics
</p>
</div>
</div>
<div className="bg-dark-800 border border-dark-700 rounded-xl p-4 flex items-start gap-4">
<div className="w-10 h-10 bg-purple-500/20 rounded-lg flex items-center justify-center shrink-0">
<Clock className="w-5 h-5 text-purple-400" />
</div>
<div>
<h4 className="font-medium">24-Hour Delivery</h4>
<p className="text-dark-400 text-sm mt-1">
We handle everything — just wait for your video to arrive
</p>
</div>
</div>
<div className="bg-dark-800 border border-dark-700 rounded-xl p-4 flex items-start gap-4">
<div className="w-10 h-10 bg-yellow-500/20 rounded-lg flex items-center justify-center shrink-0">
<Gift className="w-5 h-5 text-yellow-400" />
</div>
<div>
<h4 className="font-medium">All Formats Included</h4>
<p className="text-dark-400 text-sm mt-1">
MP4 video, CDG+MP3 for karaoke machines, audio stems
</p>
</div>
</div>
<a
href="https://www.youtube.com/@nomadkaraoke"
target="_blank"
rel="noopener noreferrer"
className="bg-dark-800 border border-dark-700 rounded-xl p-4 flex items-start gap-4 hover:border-red-500/40 transition-colors group"
>
<div className="w-10 h-10 bg-red-500/20 rounded-lg flex items-center justify-center shrink-0">
<Youtube className="w-5 h-5 text-red-400" />
</div>
<div>
<h4 className="font-medium group-hover:text-red-400 transition-colors">1000+ Real Examples on YouTube</h4>
<p className="text-dark-400 text-sm mt-1">
Browse our YouTube channel to see exactly what you&apos;ll get
</p>
</div>
</a>
</div>
{/* Delivery includes */}
<div className="mt-8 p-4 bg-dark-800 border border-dark-700 rounded-xl">
<h4 className="font-medium mb-3">Your delivery includes:</h4>
<ul className="space-y-2 text-sm text-dark-400">
<li className="flex items-center gap-2">
<Check className="w-4 h-4 text-green-400" />
4K lossless MP4 video with title screen
</li>
<li className="flex items-center gap-2">
<Check className="w-4 h-4 text-green-400" />
720p web-optimized version
</li>
<li className="flex items-center gap-2">
<Check className="w-4 h-4 text-green-400" />
CDG+MP3 for karaoke machines
</li>
<li className="flex items-center gap-2">
<Check className="w-4 h-4 text-green-400" />
Instrumental audio (with or without backing vocals)
</li>
<li className="flex items-center gap-2">
<Check className="w-4 h-4 text-green-400" />
&quot;Sing along&quot; version with original vocals
</li>
</ul>
</div>
</div>
{/* Order Form */}
<div className="bg-dark-800 border border-dark-700 rounded-2xl p-6 sm:p-8">
<div className="flex items-center justify-between mb-6">
<h3 className="text-xl font-semibold">Order a Video</h3>
<div className="text-2xl font-bold text-primary-400">$15</div>
</div>
<form onSubmit={handleMadeForYouSubmit} className="space-y-5">
{/* Artist */}
<div>
<label htmlFor="mfy-artist" className="block text-sm font-medium text-dark-300 mb-2">
Artist <span className="text-red-400">*</span>
</label>
<input
type="text"
id="mfy-artist"
value={mfyArtist}
onChange={(e) => setMfyArtist(e.target.value)}
placeholder="e.g. Taylor Swift"
className="w-full px-4 py-3 bg-secondary border border-border rounded-lg focus:outline-none focus:ring-2 focus:ring-primary focus:border-transparent text-foreground placeholder:text-muted-foreground"
/>
</div>
{/* Title */}
<div>
<label htmlFor="mfy-title" className="block text-sm font-medium text-dark-300 mb-2">
Song Title <span className="text-red-400">*</span>
</label>
<input
type="text"
id="mfy-title"
value={mfyTitle}
onChange={(e) => setMfyTitle(e.target.value)}
placeholder="e.g. Anti-Hero"
className="w-full px-4 py-3 bg-secondary border border-border rounded-lg focus:outline-none focus:ring-2 focus:ring-primary focus:border-transparent text-foreground placeholder:text-muted-foreground"
/>
</div>
{/* Source Type */}
<div>
<label className="block text-sm font-medium text-dark-300 mb-2">
Audio Source
</label>
<div className="grid grid-cols-3 gap-2">
<button
type="button"
onClick={() => setMfySourceType('search')}
className={`flex flex-col items-center gap-1 p-3 rounded-lg border transition-all ${
mfySourceType === 'search'
? 'border-primary-500 bg-primary-500/10 text-primary-400'
: 'border-dark-700 text-dark-400 hover:border-dark-500'
}`}
>
<Search className="w-5 h-5" />
<span className="text-xs">Auto Search</span>
</button>
<button
type="button"
onClick={() => setMfySourceType('youtube')}
className={`flex flex-col items-center gap-1 p-3 rounded-lg border transition-all ${
mfySourceType === 'youtube'
? 'border-primary-500 bg-primary-500/10 text-primary-400'
: 'border-dark-700 text-dark-400 hover:border-dark-500'
}`}
>
<LinkIcon className="w-5 h-5" />
<span className="text-xs">YouTube URL</span>
</button>
<button
type="button"
onClick={() => setMfySourceType('upload')}
className={`flex flex-col items-center gap-1 p-3 rounded-lg border transition-all ${
mfySourceType === 'upload'
? 'border-primary-500 bg-primary-500/10 text-primary-400'
: 'border-dark-700 text-dark-400 hover:border-dark-500'
}`}
>
<Upload className="w-5 h-5" />
<span className="text-xs">File Upload</span>
</button>
</div>
<p className="mt-2 text-xs text-dark-500">
{mfySourceType === 'search' && "We'll automatically find the best quality audio for your song."}
{mfySourceType === 'youtube' && 'Provide a YouTube link to the song you want.'}
{mfySourceType === 'upload' && 'Upload your own audio file (contact us after ordering).'}
</p>
</div>
{/* YouTube URL (conditional) */}
{mfySourceType === 'youtube' && (
<div>
<label htmlFor="mfy-youtube" className="block text-sm font-medium text-dark-300 mb-2">
YouTube URL
</label>
<input
type="url"
id="mfy-youtube"
value={mfyYoutubeUrl}
onChange={(e) => setMfyYoutubeUrl(e.target.value)}
placeholder="https://youtube.com/watch?v=..."
className="w-full px-4 py-3 bg-secondary border border-border rounded-lg focus:outline-none focus:ring-2 focus:ring-primary focus:border-transparent text-foreground placeholder:text-muted-foreground"
/>
</div>
)}
{/* Email */}
<div>
<label htmlFor="mfy-email" className="block text-sm font-medium text-dark-300 mb-2">
Your Email <span className="text-red-400">*</span>
</label>
<input
type="email"
id="mfy-email"
value={mfyEmail}
onChange={(e) => setMfyEmail(e.target.value)}
placeholder="you@example.com"
className="w-full px-4 py-3 bg-secondary border border-border rounded-lg focus:outline-none focus:ring-2 focus:ring-primary focus:border-transparent text-foreground placeholder:text-muted-foreground"
/>
<p className="mt-1 text-xs text-dark-500">
We&apos;ll send your video files to this address
</p>
</div>
{/* Notes (optional) */}
<div>
<label htmlFor="mfy-notes" className="block text-sm font-medium text-dark-300 mb-2">
Special Requests <span className="text-dark-500">(optional)</span>
</label>
<textarea
id="mfy-notes"
value={mfyNotes}
onChange={(e) => setMfyNotes(e.target.value)}
rows={3}
placeholder="Any special requests or notes about the song..."
className="w-full px-4 py-3 bg-secondary border border-border rounded-lg focus:outline-none focus:ring-2 focus:ring-primary focus:border-transparent text-foreground placeholder:text-muted-foreground resize-none"
/>
</div>
{mfyError && <p className="text-red-400 text-sm">{mfyError}</p>}
{/* Submit */}
<button
type="submit"
disabled={mfyLoading}
className="w-full bg-primary-500 hover:bg-primary-600 disabled:bg-primary-500/50 text-white font-semibold py-4 rounded-xl transition-all btn-glow flex items-center justify-center gap-2"
>
{mfyLoading ? (
<>
<Loader2 className="w-5 h-5 animate-spin" />
Processing...
</>
) : (
<>
<CreditCard className="w-5 h-5" />
Pay $15 &amp; Order
</>
)}
</button>
<p className="text-xs text-center text-dark-500">
Secure payment via Stripe. 24-hour delivery guaranteed or your money back.
</p>
</form>
</div>
</div>
</div>
</section>
{/* FAQ */}
<section className="py-16 px-4 bg-dark-800/50">
<div className="max-w-2xl mx-auto">
@@ -11,13 +11,11 @@ jest.mock('@/lib/api', () => ({
api: {
retryJob: jest.fn(),
cancelJob: jest.fn(),
deleteJob: jest.fn(),
}
}))
describe('JobActions', () => {
const mockOnRefresh = jest.fn()
const mockOnToggleLogs = jest.fn()
const baseJob: Partial<Job> = {
job_id: '123',
@@ -38,8 +36,6 @@ describe('JobActions', () => {
<JobActions
job={failedJob}
onRefresh={mockOnRefresh}
showLogs={false}
onToggleLogs={mockOnToggleLogs}
/>
)
@@ -52,8 +48,6 @@ describe('JobActions', () => {
<JobActions
job={cancelledJob}
onRefresh={mockOnRefresh}
showLogs={false}
onToggleLogs={mockOnToggleLogs}
/>
)
@@ -66,8 +60,6 @@ describe('JobActions', () => {
<JobActions
job={pendingJob}
onRefresh={mockOnRefresh}
showLogs={false}
onToggleLogs={mockOnToggleLogs}
/>
)
@@ -80,8 +72,6 @@ describe('JobActions', () => {
<JobActions
job={processingJob}
onRefresh={mockOnRefresh}
showLogs={false}
onToggleLogs={mockOnToggleLogs}
/>
)
@@ -94,8 +84,6 @@ describe('JobActions', () => {
<JobActions
job={completeJob}
onRefresh={mockOnRefresh}
showLogs={false}
onToggleLogs={mockOnToggleLogs}
/>
)
@@ -110,8 +98,6 @@ describe('JobActions', () => {
<JobActions
job={pendingJob}
onRefresh={mockOnRefresh}
showLogs={false}
onToggleLogs={mockOnToggleLogs}
/>
)
@@ -124,8 +110,6 @@ describe('JobActions', () => {
<JobActions
job={failedJob}
onRefresh={mockOnRefresh}
showLogs={false}
onToggleLogs={mockOnToggleLogs}
/>
)
@@ -138,8 +122,6 @@ describe('JobActions', () => {
<JobActions
job={cancelledJob}
onRefresh={mockOnRefresh}
showLogs={false}
onToggleLogs={mockOnToggleLogs}
/>
)
@@ -147,91 +129,18 @@ describe('JobActions', () => {
})
})
describe('Delete button visibility', () => {
it('shows delete button for complete jobs', () => {
describe('Renders nothing when no actions available', () => {
it('returns null for complete jobs (no cancel, no retry)', () => {
const completeJob = { ...baseJob, status: 'complete' } as Job
render(
const { container } = render(
<JobActions
job={completeJob}
onRefresh={mockOnRefresh}
showLogs={false}
onToggleLogs={mockOnToggleLogs}
/>
)
expect(screen.getByText('Delete')).toBeInTheDocument()
})
it('shows delete button for failed jobs', () => {
const failedJob = { ...baseJob, status: 'failed' } as Job
render(
<JobActions
job={failedJob}
onRefresh={mockOnRefresh}
showLogs={false}
onToggleLogs={mockOnToggleLogs}
/>
)
expect(screen.getByText('Delete')).toBeInTheDocument()
})
it('shows delete button for cancelled jobs', () => {
const cancelledJob = { ...baseJob, status: 'cancelled' } as Job
render(
<JobActions
job={cancelledJob}
onRefresh={mockOnRefresh}
showLogs={false}
onToggleLogs={mockOnToggleLogs}
/>
)
expect(screen.getByText('Delete')).toBeInTheDocument()
})
it('does not show delete button for pending jobs', () => {
const pendingJob = { ...baseJob, status: 'pending' } as Job
render(
<JobActions
job={pendingJob}
onRefresh={mockOnRefresh}
showLogs={false}
onToggleLogs={mockOnToggleLogs}
/>
)
expect(screen.queryByText('Delete')).not.toBeInTheDocument()
})
})
describe('Show Logs button', () => {
it('always shows Show Logs button', () => {
const pendingJob = { ...baseJob, status: 'pending' } as Job
render(
<JobActions
job={pendingJob}
onRefresh={mockOnRefresh}
showLogs={false}
onToggleLogs={mockOnToggleLogs}
/>
)
expect(screen.getByText('Show Logs')).toBeInTheDocument()
})
it('shows Hide Logs when logs are visible', () => {
const pendingJob = { ...baseJob, status: 'pending' } as Job
render(
<JobActions
job={pendingJob}
onRefresh={mockOnRefresh}
showLogs={true}
onToggleLogs={mockOnToggleLogs}
/>
)
expect(screen.getByText('Hide Logs')).toBeInTheDocument()
// Component should render nothing when no actions are available
expect(container.firstChild).toBeNull()
})
})
})
@@ -0,0 +1,277 @@
/**
* Tests for PushNotificationPrompt component
*
* Tests the soft-ask banner for enabling push notifications,
* including iOS detection and permission handling.
*/
import { render, screen, fireEvent, waitFor } from '@testing-library/react'
import { PushNotificationPrompt, PushNotificationToggle } from '../push-notification-prompt'
import { usePushNotifications } from '@/hooks/use-push-notifications'
// Mock the hook
jest.mock('@/hooks/use-push-notifications')
const mockUsePushNotifications = usePushNotifications as jest.MockedFunction<typeof usePushNotifications>
// Default mock return value
const defaultHookReturn = {
isLoading: false,
isPushEnabled: true,
shouldShowPrompt: true,
needsIOSInstall: false,
isIOS: false,
isPWAInstalled: false,
isSubscribed: false,
permission: 'default' as const,
subscribe: jest.fn().mockResolvedValue(true),
unsubscribe: jest.fn().mockResolvedValue(true),
dismissPrompt: jest.fn(),
error: null,
isSupported: true,
}
describe('PushNotificationPrompt', () => {
beforeEach(() => {
jest.clearAllMocks()
mockUsePushNotifications.mockReturnValue(defaultHookReturn)
})
describe('visibility conditions', () => {
it('renders nothing when loading', () => {
mockUsePushNotifications.mockReturnValue({
...defaultHookReturn,
isLoading: true,
})
const { container } = render(<PushNotificationPrompt />)
expect(container.firstChild).toBeNull()
})
it('renders nothing when push not enabled on server', () => {
mockUsePushNotifications.mockReturnValue({
...defaultHookReturn,
isPushEnabled: false,
})
const { container } = render(<PushNotificationPrompt />)
expect(container.firstChild).toBeNull()
})
it('renders nothing when shouldShowPrompt is false', () => {
mockUsePushNotifications.mockReturnValue({
...defaultHookReturn,
shouldShowPrompt: false,
})
const { container } = render(<PushNotificationPrompt />)
expect(container.firstChild).toBeNull()
})
it('renders prompt when shouldShowPrompt is true', () => {
render(<PushNotificationPrompt />)
expect(screen.getByText(/Get notified when your video is ready/)).toBeInTheDocument()
expect(screen.getByText('Enable Notifications')).toBeInTheDocument()
})
})
describe('iOS Add to Home Screen instructions', () => {
it('shows iOS instructions when needsIOSInstall is true', () => {
mockUsePushNotifications.mockReturnValue({
...defaultHookReturn,
needsIOSInstall: true,
})
render(<PushNotificationPrompt />)
expect(screen.getByText(/Get notifications on your iPhone/)).toBeInTheDocument()
expect(screen.getByText(/Add to Home Screen/)).toBeInTheDocument()
expect(screen.getByText(/Share button in Safari/)).toBeInTheDocument()
})
it('iOS instructions have dismiss button', () => {
mockUsePushNotifications.mockReturnValue({
...defaultHookReturn,
needsIOSInstall: true,
})
render(<PushNotificationPrompt />)
const dismissButton = screen.getByLabelText('Dismiss')
expect(dismissButton).toBeInTheDocument()
})
})
describe('user interactions', () => {
it('calls subscribe when Enable Notifications clicked', async () => {
const mockSubscribe = jest.fn().mockResolvedValue(true)
mockUsePushNotifications.mockReturnValue({
...defaultHookReturn,
subscribe: mockSubscribe,
})
render(<PushNotificationPrompt />)
fireEvent.click(screen.getByText('Enable Notifications'))
await waitFor(() => {
expect(mockSubscribe).toHaveBeenCalledTimes(1)
})
})
it('shows loading state while subscribing', async () => {
const mockSubscribe = jest.fn().mockImplementation(() => new Promise(resolve => setTimeout(() => resolve(true), 100)))
mockUsePushNotifications.mockReturnValue({
...defaultHookReturn,
subscribe: mockSubscribe,
})
render(<PushNotificationPrompt />)
fireEvent.click(screen.getByText('Enable Notifications'))
expect(screen.getByText('Enabling...')).toBeInTheDocument()
})
it('calls dismissPrompt(false) when Not now clicked', () => {
const mockDismiss = jest.fn()
mockUsePushNotifications.mockReturnValue({
...defaultHookReturn,
dismissPrompt: mockDismiss,
})
render(<PushNotificationPrompt />)
fireEvent.click(screen.getByText('Not now'))
expect(mockDismiss).toHaveBeenCalledWith(false)
})
it('calls dismissPrompt(true) when Don\'t ask again clicked', () => {
const mockDismiss = jest.fn()
mockUsePushNotifications.mockReturnValue({
...defaultHookReturn,
dismissPrompt: mockDismiss,
})
render(<PushNotificationPrompt />)
fireEvent.click(screen.getByText("Don't ask again"))
expect(mockDismiss).toHaveBeenCalledWith(true)
})
})
describe('error display', () => {
it('displays error message when error is set', () => {
mockUsePushNotifications.mockReturnValue({
...defaultHookReturn,
error: 'Permission denied',
})
render(<PushNotificationPrompt />)
expect(screen.getByText('Permission denied')).toBeInTheDocument()
})
})
})
describe('PushNotificationToggle', () => {
beforeEach(() => {
jest.clearAllMocks()
mockUsePushNotifications.mockReturnValue(defaultHookReturn)
})
describe('visibility conditions', () => {
it('renders nothing when loading', () => {
mockUsePushNotifications.mockReturnValue({
...defaultHookReturn,
isLoading: true,
})
const { container } = render(<PushNotificationToggle />)
expect(container.firstChild).toBeNull()
})
it('renders nothing when push not enabled', () => {
mockUsePushNotifications.mockReturnValue({
...defaultHookReturn,
isPushEnabled: false,
})
const { container } = render(<PushNotificationToggle />)
expect(container.firstChild).toBeNull()
})
})
describe('permission denied state', () => {
it('shows "Blocked in browser" when permission denied', () => {
mockUsePushNotifications.mockReturnValue({
...defaultHookReturn,
permission: 'denied',
})
render(<PushNotificationToggle />)
expect(screen.getByText('Blocked in browser')).toBeInTheDocument()
})
})
describe('toggle functionality', () => {
it('shows Enable button when not subscribed', () => {
mockUsePushNotifications.mockReturnValue({
...defaultHookReturn,
isSubscribed: false,
})
render(<PushNotificationToggle />)
expect(screen.getByText('Enable')).toBeInTheDocument()
})
it('shows Disable button when subscribed', () => {
mockUsePushNotifications.mockReturnValue({
...defaultHookReturn,
isSubscribed: true,
})
render(<PushNotificationToggle />)
expect(screen.getByText('Disable')).toBeInTheDocument()
})
it('calls subscribe when Enable clicked', async () => {
const mockSubscribe = jest.fn().mockResolvedValue(true)
mockUsePushNotifications.mockReturnValue({
...defaultHookReturn,
isSubscribed: false,
subscribe: mockSubscribe,
})
render(<PushNotificationToggle />)
fireEvent.click(screen.getByText('Enable'))
await waitFor(() => {
expect(mockSubscribe).toHaveBeenCalledTimes(1)
})
})
it('calls unsubscribe when Disable clicked', async () => {
const mockUnsubscribe = jest.fn().mockResolvedValue(true)
mockUsePushNotifications.mockReturnValue({
...defaultHookReturn,
isSubscribed: true,
unsubscribe: mockUnsubscribe,
})
render(<PushNotificationToggle />)
fireEvent.click(screen.getByText('Disable'))
await waitFor(() => {
expect(mockUnsubscribe).toHaveBeenCalledTimes(1)
})
})
})
})
@@ -10,6 +10,7 @@ import {
ArrowLeft,
Settings,
Search,
ShieldAlert,
} from "lucide-react"
import {
@@ -52,6 +53,11 @@ const navItems = [
href: "/admin/beta",
icon: TestTube2,
},
{
title: "Rate Limits",
href: "/admin/rate-limits",
icon: ShieldAlert,
},
]
export function AdminSidebar() {
@@ -384,7 +384,7 @@ export function AudioSearchDialog({ jobId, open, onClose, onSelect }: AudioSearc
<span className="truncate">{formatMetadata(result)}</span>
)}
{result.target_file && (
<span className="font-mono truncate">"{result.target_file}"</span>
<span className="font-mono truncate">&quot;{result.target_file}&quot;</span>
)}
</div>
)}
+16 -1
View File
@@ -1,7 +1,7 @@
"use client"
import { useState, useEffect } from "react"
import { User, LogOut, CreditCard, Coins, KeyRound, Shield } from "lucide-react"
import { User, LogOut, CreditCard, Coins, KeyRound, Shield, FlaskConical } from "lucide-react"
import Link from "next/link"
import { Button } from "@/components/ui/button"
import {
@@ -12,7 +12,9 @@ import {
DropdownMenuSeparator,
DropdownMenuTrigger,
} from "@/components/ui/dropdown-menu"
import { Switch } from "@/components/ui/switch"
import { useAuth } from "@/lib/auth"
import { useAdminSettings } from "@/lib/admin-settings"
import { AuthDialog } from "./AuthDialog"
interface AuthStatusProps {
@@ -21,6 +23,7 @@ interface AuthStatusProps {
export function AuthStatus({ onAuthChange }: AuthStatusProps) {
const { user, logout } = useAuth()
const { showTestData, setShowTestData } = useAdminSettings()
const [showAuthDialog, setShowAuthDialog] = useState(false)
const [mounted, setMounted] = useState(false)
@@ -107,6 +110,18 @@ export function AuthStatus({ onAuthChange }: AuthStatusProps) {
<span>Admin Dashboard</span>
</Link>
</DropdownMenuItem>
<DropdownMenuItem
onSelect={(e) => e.preventDefault()}
className="text-muted-foreground focus:text-foreground focus:bg-secondary"
>
<FlaskConical className="w-4 h-4 mr-2" />
<span className="flex-1">Show Test Jobs</span>
<Switch
checked={showTestData}
onCheckedChange={setShowTestData}
className="ml-2"
/>
</DropdownMenuItem>
</>
)}
<DropdownMenuSeparator className="bg-border" />
@@ -0,0 +1,12 @@
"use client"
import { ImpersonationBanner } from "./impersonation-banner"
/**
* Client-side wrapper for the impersonation banner.
* This is needed because the root layout is a server component,
* but the banner needs access to client-side auth state.
*/
export function ImpersonationBannerWrapper() {
return <ImpersonationBanner />
}
@@ -0,0 +1,37 @@
"use client"
import { useAuth } from "@/lib/auth"
import { Button } from "@/components/ui/button"
import { X, Eye } from "lucide-react"
/**
* Banner shown when admin is impersonating another user.
* Displays prominently at the top of the page with option to stop impersonating.
*/
export function ImpersonationBanner() {
const { isImpersonating, impersonatedUserEmail, endImpersonation } = useAuth()
if (!isImpersonating) {
return null
}
return (
<div className="bg-amber-500 text-amber-950 px-4 py-2 flex items-center justify-between gap-4 text-sm font-medium">
<div className="flex items-center gap-2">
<Eye className="w-4 h-4" />
<span>
Viewing as <strong>{impersonatedUserEmail}</strong>
</span>
</div>
<Button
variant="outline"
size="sm"
onClick={endImpersonation}
className="bg-amber-100 hover:bg-amber-200 text-amber-950 border-amber-600 h-7 px-3"
>
<X className="w-3 h-3 mr-1" />
Stop Impersonating
</Button>
</div>
)
}
+8 -52
View File
@@ -3,25 +3,21 @@
import { useState } from "react"
import { Job, api } from "@/lib/api"
import { Button } from "@/components/ui/button"
import {
Loader2, RotateCcw, XCircle, Trash2, FileText
import {
Loader2, RotateCcw, XCircle
} from "lucide-react"
interface JobActionsProps {
job: Job
onRefresh: () => void
showLogs: boolean
onToggleLogs: () => void
}
export function JobActions({ job, onRefresh, showLogs, onToggleLogs }: JobActionsProps) {
export function JobActions({ job, onRefresh }: JobActionsProps) {
const [isRetrying, setIsRetrying] = useState(false)
const [isCancelling, setIsCancelling] = useState(false)
const [isDeleting, setIsDeleting] = useState(false)
const canRetry = job.status === "failed" || job.status === "cancelled"
const canCancel = !["complete", "failed", "cancelled"].includes(job.status)
const canDelete = ["complete", "failed", "cancelled"].includes(job.status)
async function handleRetry() {
setIsRetrying(true)
@@ -37,7 +33,7 @@ export function JobActions({ job, onRefresh, showLogs, onToggleLogs }: JobAction
async function handleCancel() {
if (!confirm("Are you sure you want to cancel this job?")) return
setIsCancelling(true)
try {
await api.cancelJob(job.job_id)
@@ -49,23 +45,14 @@ export function JobActions({ job, onRefresh, showLogs, onToggleLogs }: JobAction
}
}
async function handleDelete() {
if (!confirm("Are you sure you want to delete this job? This will remove all associated files.")) return
setIsDeleting(true)
try {
await api.deleteJob(job.job_id, true)
onRefresh()
} catch (error) {
console.error("Failed to delete job:", error)
} finally {
setIsDeleting(false)
}
// Don't render anything if no actions are available
if (!canCancel && !canRetry) {
return null
}
return (
<div className="flex flex-wrap gap-2" onClick={(e) => e.stopPropagation()}>
{/* Cancel button first (red) */}
{/* Cancel button (red) */}
{canCancel && (
<Button
size="sm"
@@ -83,24 +70,6 @@ export function JobActions({ job, onRefresh, showLogs, onToggleLogs }: JobAction
</Button>
)}
{/* Delete button (red) */}
{canDelete && (
<Button
size="sm"
variant="ghost"
onClick={handleDelete}
disabled={isDeleting}
className="text-xs text-red-400 hover:text-red-300"
>
{isDeleting ? (
<Loader2 className="w-3 h-3 mr-1 animate-spin" />
) : (
<Trash2 className="w-3 h-3 mr-1" />
)}
Delete
</Button>
)}
{/* Retry button */}
{canRetry && (
<Button
@@ -118,19 +87,6 @@ export function JobActions({ job, onRefresh, showLogs, onToggleLogs }: JobAction
Retry
</Button>
)}
{/* Show/Hide Logs */}
<Button
size="sm"
variant="ghost"
onClick={onToggleLogs}
className="text-xs"
style={{ color: 'var(--text-muted)' }}
>
<FileText className="w-3 h-3 mr-1" />
{showLogs ? "Hide" : "Show"} Logs
</Button>
</div>
)
}
+2 -17
View File
@@ -5,7 +5,6 @@ import { Job } from "@/lib/api"
import { Button } from "@/components/ui/button"
import { ExternalLink, Zap } from "lucide-react"
import { JobActions } from "./JobActions"
import { JobLogs } from "./JobLogs"
import { OutputLinks } from "./OutputLinks"
import { AudioSearchDialog } from "../audio-search/AudioSearchDialog"
import { getJobStep, formatStepIndicator, getJobProgressPercent } from "@/lib/job-status"
@@ -74,7 +73,6 @@ interface JobCardProps {
}
export function JobCard({ job, onRefresh }: JobCardProps) {
const [showLogs, setShowLogs] = useState(false)
const [showAudioSearch, setShowAudioSearch] = useState(false)
const createdAt = new Date(job.created_at).toLocaleString()
@@ -183,6 +181,7 @@ export function JobCard({ job, onRefresh }: JobCardProps) {
{/* Header row with title and non-interactive badge */}
<div className="flex items-start justify-between gap-2">
<p className="font-medium truncate" style={{ color: 'var(--text)' }}>
{job.state_data?.brand_code && `${job.state_data.brand_code}: `}
{job.artist || "Unknown"} - {job.title || "Unknown"}
</p>
{job.non_interactive && (
@@ -217,24 +216,10 @@ export function JobCard({ job, onRefresh }: JobCardProps) {
{/* Actions row: Cancel/secondary on left, primary action on right */}
<div className="mt-2 flex items-center justify-between">
<div className="flex items-center gap-2">
<JobActions
job={job}
onRefresh={onRefresh}
showLogs={showLogs}
onToggleLogs={() => setShowLogs(!showLogs)}
/>
</div>
<JobActions job={job} onRefresh={onRefresh} />
{renderPrimaryAction()}
</div>
{/* Expandable logs */}
{showLogs && (
<div className="mt-2">
<JobLogs jobId={job.job_id} />
</div>
)}
<AudioSearchDialog
jobId={job.job_id}
open={showAudioSearch}
+90 -48
View File
@@ -1,8 +1,9 @@
"use client"
import { useState } from "react"
import { useState, useEffect, useMemo } from "react"
import { api, ApiError } from "@/lib/api"
import { useAuth } from "@/lib/auth"
import { useTenant } from "@/lib/tenant"
import { Button } from "@/components/ui/button"
import { Input } from "@/components/ui/input"
import { Label } from "@/components/ui/label"
@@ -15,9 +16,30 @@ interface JobSubmissionProps {
export function JobSubmission({ onJobCreated }: JobSubmissionProps) {
const { user } = useAuth()
const { features, isDefault, tenant } = useTenant()
const isAdmin = user?.role === "admin"
const [activeTab, setActiveTab] = useState("search")
// Determine which tabs are available based on tenant features
const availableTabs = useMemo(() => {
const tabs: string[] = []
if (features.audio_search) tabs.push("search")
if (features.file_upload) tabs.push("upload")
if (features.youtube_url) tabs.push("url")
// Fallback: at least show upload if no tabs enabled
if (tabs.length === 0) tabs.push("upload")
return tabs
}, [features])
// Default to first available tab
const [activeTab, setActiveTab] = useState(availableTabs[0])
// Keep activeTab in sync with availableTabs when features change
useEffect(() => {
if (!availableTabs.includes(activeTab)) {
setActiveTab(availableTabs[0])
}
}, [availableTabs, activeTab])
const [error, setError] = useState("")
const [isSubmitting, setIsSubmitting] = useState(false)
@@ -156,37 +178,52 @@ export function JobSubmission({ onJobCreated }: JobSubmissionProps) {
return (
<Tabs value={activeTab} onValueChange={setActiveTab}>
<TabsList className="grid w-full grid-cols-3 h-auto rounded-lg p-1" style={{ backgroundColor: 'var(--secondary)' }}>
<TabsTrigger
value="search"
className="gap-1.5 sm:gap-2 py-3 min-h-[44px] text-xs sm:text-sm rounded-md data-[state=active]:!bg-[var(--brand-pink)] data-[state=active]:!text-white data-[state=active]:shadow-md data-[state=inactive]:hover:bg-[var(--brand-pink)]/10"
style={{ color: activeTab === 'search' ? 'white' : 'var(--text-muted)' }}
{/* Only show tabs bar when there are multiple options */}
{availableTabs.length > 1 && (
<TabsList
className={`grid w-full h-auto rounded-lg p-1 ${
availableTabs.length === 2 ? 'grid-cols-2' : 'grid-cols-3'
}`}
style={{ backgroundColor: 'var(--secondary)' }}
>
<Music className="w-4 h-4 shrink-0" />
<span className="truncate">Search</span>
</TabsTrigger>
<TabsTrigger
value="upload"
className="gap-1.5 sm:gap-2 py-3 min-h-[44px] text-xs sm:text-sm rounded-md data-[state=active]:!bg-[var(--brand-pink)] data-[state=active]:!text-white data-[state=active]:shadow-md data-[state=inactive]:hover:bg-[var(--brand-pink)]/10"
style={{ color: activeTab === 'upload' ? 'white' : 'var(--text-muted)' }}
>
<Upload className="w-4 h-4 shrink-0" />
<span className="truncate">Upload</span>
</TabsTrigger>
<TabsTrigger
value="url"
className="gap-1.5 sm:gap-2 py-3 min-h-[44px] text-xs sm:text-sm rounded-md data-[state=active]:!bg-[var(--brand-pink)] data-[state=active]:!text-white data-[state=active]:shadow-md data-[state=inactive]:hover:bg-[var(--brand-pink)]/10"
style={{ color: activeTab === 'url' ? 'white' : 'var(--text-muted)' }}
>
<Youtube className="w-4 h-4 shrink-0" />
<span className="truncate">URL</span>
</TabsTrigger>
</TabsList>
{availableTabs.includes("search") && (
<TabsTrigger
value="search"
className="gap-1.5 sm:gap-2 py-3 min-h-[44px] text-xs sm:text-sm rounded-md data-[state=active]:!bg-[var(--brand-pink)] data-[state=active]:!text-white data-[state=active]:shadow-md data-[state=inactive]:hover:bg-[var(--brand-pink)]/10"
style={{ color: activeTab === 'search' ? 'white' : 'var(--text-muted)' }}
>
<Music className="w-4 h-4 shrink-0" />
<span className="truncate">Search</span>
</TabsTrigger>
)}
{availableTabs.includes("upload") && (
<TabsTrigger
value="upload"
className="gap-1.5 sm:gap-2 py-3 min-h-[44px] text-xs sm:text-sm rounded-md data-[state=active]:!bg-[var(--brand-pink)] data-[state=active]:!text-white data-[state=active]:shadow-md data-[state=inactive]:hover:bg-[var(--brand-pink)]/10"
style={{ color: activeTab === 'upload' ? 'white' : 'var(--text-muted)' }}
>
<Upload className="w-4 h-4 shrink-0" />
<span className="truncate">Upload</span>
</TabsTrigger>
)}
{availableTabs.includes("url") && (
<TabsTrigger
value="url"
className="gap-1.5 sm:gap-2 py-3 min-h-[44px] text-xs sm:text-sm rounded-md data-[state=active]:!bg-[var(--brand-pink)] data-[state=active]:!text-white data-[state=active]:shadow-md data-[state=inactive]:hover:bg-[var(--brand-pink)]/10"
style={{ color: activeTab === 'url' ? 'white' : 'var(--text-muted)' }}
>
<Youtube className="w-4 h-4 shrink-0" />
<span className="truncate">URL</span>
</TabsTrigger>
)}
</TabsList>
)}
<TabsContent value="upload" className="mt-4">
<form onSubmit={handleUploadSubmit} className="space-y-4">
<div className="space-y-2">
<Label htmlFor="audio-file" style={{ color: 'var(--text)' }}>Audio File</Label>
{availableTabs.includes("upload") && (
<TabsContent value="upload" className={availableTabs.length === 1 ? "" : "mt-4"}>
<form onSubmit={handleUploadSubmit} className="space-y-4">
<div className="space-y-2">
<Label htmlFor="audio-file" style={{ color: 'var(--text)' }}>Audio File</Label>
<div
className="relative border-2 border-dashed rounded-lg p-6 text-center transition-colors cursor-pointer"
style={{
@@ -288,13 +325,15 @@ export function JobSubmission({ onJobCreated }: JobSubmissionProps) {
"Create Karaoke Video"
)}
</Button>
</form>
</TabsContent>
</form>
</TabsContent>
)}
<TabsContent value="url" className="mt-4">
<form onSubmit={handleUrlSubmit} className="space-y-4">
<div className="space-y-2">
<Label htmlFor="youtube-url" style={{ color: 'var(--text)' }}>YouTube URL</Label>
{availableTabs.includes("url") && (
<TabsContent value="url" className={availableTabs.length === 1 ? "" : "mt-4"}>
<form onSubmit={handleUrlSubmit} className="space-y-4">
<div className="space-y-2">
<Label htmlFor="youtube-url" style={{ color: 'var(--text)' }}>YouTube URL</Label>
<div className="relative">
<Youtube className="absolute left-3 top-1/2 -translate-y-1/2 w-4 h-4" style={{ color: 'var(--text-muted)' }} />
<Input
@@ -380,15 +419,17 @@ export function JobSubmission({ onJobCreated }: JobSubmissionProps) {
) : (
"Create Karaoke Video"
)}
</Button>
</form>
</TabsContent>
</Button>
</form>
</TabsContent>
)}
<TabsContent value="search" className="mt-4">
<form onSubmit={handleSearchSubmit} className="space-y-4">
{/* Search For section */}
<div className="space-y-2">
<Label style={{ color: 'var(--text)' }}>Search For Audio Online</Label>
{availableTabs.includes("search") && (
<TabsContent value="search" className={availableTabs.length === 1 ? "" : "mt-4"}>
<form onSubmit={handleSearchSubmit} className="space-y-4">
{/* Search For section */}
<div className="space-y-2">
<Label style={{ color: 'var(--text)' }}>Search For Audio Online</Label>
<div className="grid grid-cols-1 sm:grid-cols-2 gap-3 sm:gap-4">
<div className="space-y-2">
<Label htmlFor="search-artist" className="text-xs" style={{ color: 'var(--text-muted)' }}>Artist</Label>
@@ -511,9 +552,10 @@ export function JobSubmission({ onJobCreated }: JobSubmissionProps) {
) : (
"Search & Create Job"
)}
</Button>
</form>
</TabsContent>
</Button>
</form>
</TabsContent>
)}
</Tabs>
)
}
+161 -147
View File
@@ -2,8 +2,9 @@
import { useEffect, useState, useRef, useCallback } from "react"
import { api, adminApi } from "@/lib/api"
import { useTenant } from "@/lib/tenant"
import { Button } from "@/components/ui/button"
import { Download, Loader2, ExternalLink, FolderOpen, Copy, Mail, MessageSquare } from "lucide-react"
import { Download, Loader2, ExternalLink, FolderOpen, Copy, Mail, Settings } from "lucide-react"
import { useAuth } from "@/lib/auth"
import {
Dialog,
@@ -37,8 +38,13 @@ export function OutputLinks({ jobId }: OutputLinksProps) {
const emailTimeoutRef = useRef<NodeJS.Timeout | null>(null)
const { user } = useAuth()
const { features } = useTenant()
const isAdmin = user?.role === 'admin'
// Filter external links based on tenant features
const showYoutubeLink = features.youtube_upload && youtubeUrl
const showDropboxLink = features.dropbox_upload && dropboxUrl
useEffect(() => {
loadOutputLinks()
}, [jobId])
@@ -167,7 +173,7 @@ export function OutputLinks({ jobId }: OutputLinksProps) {
)
}
const hasOutputs = youtubeUrl || dropboxUrl || (downloadUrls && Object.keys(downloadUrls).length > 0)
const hasOutputs = showYoutubeLink || showDropboxLink || (downloadUrls && Object.keys(downloadUrls).length > 0)
// Check if we have any downloads
const hasDownloads = downloadUrls && (
@@ -178,154 +184,162 @@ export function OutputLinks({ jobId }: OutputLinksProps) {
downloadUrls?.packages?.txt_zip
)
// Check if we have any external links
const hasExternalLinks = youtubeUrl || dropboxUrl
// Check if we have any external links (filtered by tenant features)
const hasExternalLinks = showYoutubeLink || showDropboxLink
return (
<div className="space-y-3">
{/* Downloads Section */}
{hasDownloads && (
<div className="space-y-1.5">
<p className="text-xs font-medium" style={{ color: 'var(--text-muted)' }}>Downloads</p>
<div className="flex flex-wrap gap-1.5">
{downloadUrls?.finals?.lossy_4k_mp4 && (
<a
href={api.getDownloadUrl(jobId, "finals", "lossy_4k_mp4")}
className="inline-flex items-center gap-1 text-xs px-3 py-1.5 rounded bg-[var(--brand-pink)] hover:bg-[var(--brand-pink-hover)] text-white transition-colors"
onClick={(e) => e.stopPropagation()}
>
<Download className="w-3 h-3" />
4K Video
</a>
)}
{downloadUrls?.finals?.lossy_720p_mp4 && (
<a
href={api.getDownloadUrl(jobId, "finals", "lossy_720p_mp4")}
className="inline-flex items-center gap-1 text-xs px-3 py-1.5 rounded bg-[#252525] hover:bg-[#333333] text-[var(--text)] border border-[var(--card-border)] transition-colors"
onClick={(e) => e.stopPropagation()}
>
<Download className="w-3 h-3" />
720p Video
</a>
)}
{downloadUrls?.videos?.with_vocals && (
<a
href={api.getDownloadUrl(jobId, "videos", "with_vocals")}
className="inline-flex items-center gap-1 text-xs px-3 py-1.5 rounded bg-[#252525] hover:bg-[#333333] text-[var(--text)] border border-[var(--card-border)] transition-colors"
onClick={(e) => e.stopPropagation()}
>
<Download className="w-3 h-3" />
With Vocals
</a>
)}
{downloadUrls?.packages?.cdg_zip && (
<a
href={api.getDownloadUrl(jobId, "packages", "cdg_zip")}
className="inline-flex items-center gap-1 text-xs px-3 py-1.5 rounded bg-[#252525] hover:bg-[#333333] text-[var(--text)] border border-[var(--card-border)] transition-colors"
onClick={(e) => e.stopPropagation()}
>
<Download className="w-3 h-3" />
CDG+MP3
</a>
)}
{downloadUrls?.packages?.txt_zip && (
<a
href={api.getDownloadUrl(jobId, "packages", "txt_zip")}
className="inline-flex items-center gap-1 text-xs px-3 py-1.5 rounded bg-[#252525] hover:bg-[#333333] text-[var(--text)] border border-[var(--card-border)] transition-colors"
onClick={(e) => e.stopPropagation()}
>
<Download className="w-3 h-3" />
TXT+MP3
</a>
)}
</div>
</div>
)}
<div className="space-y-2">
{/* Links, Downloads, and Admin Tools - all in one row */}
{(hasDownloads || hasExternalLinks) && (
<div className="flex flex-wrap gap-1.5">
{/* Links first */}
{hasExternalLinks && (
<>
{showYoutubeLink && youtubeUrl && (
<div className="flex">
<a
href={youtubeUrl}
target="_blank"
rel="noopener noreferrer"
className="inline-flex items-center gap-1 text-xs px-3 py-1.5 rounded-l bg-red-600 hover:bg-red-500 text-white transition-colors"
onClick={(e) => e.stopPropagation()}
>
<ExternalLink className="w-3 h-3" />
YouTube
</a>
<button
type="button"
onClick={(e) => { e.stopPropagation(); copyToClipboard(youtubeUrl) }}
className="inline-flex items-center text-xs px-2 py-1.5 rounded-r bg-red-700 hover:bg-red-600 text-white transition-colors"
title="Copy YouTube URL"
aria-label={copiedUrl === youtubeUrl ? "YouTube URL copied" : "Copy YouTube URL"}
>
{copiedUrl === youtubeUrl ? <span className="text-[10px]">Copied!</span> : <Copy className="w-3 h-3" />}
</button>
</div>
)}
{showDropboxLink && dropboxUrl && (
<div className="flex">
<a
href={dropboxUrl}
target="_blank"
rel="noopener noreferrer"
className="inline-flex items-center gap-1 text-xs px-3 py-1.5 rounded-l bg-[#0061FE] hover:bg-[#0052d6] text-white transition-colors"
onClick={(e) => e.stopPropagation()}
>
<FolderOpen className="w-3 h-3" />
Dropbox
</a>
<button
type="button"
onClick={(e) => { e.stopPropagation(); copyToClipboard(dropboxUrl) }}
className="inline-flex items-center text-xs px-2 py-1.5 rounded-r bg-[#0052d6] hover:bg-[#0047ba] text-white transition-colors"
title="Copy Dropbox URL"
aria-label={copiedUrl === dropboxUrl ? "Dropbox URL copied" : "Copy Dropbox URL"}
>
{copiedUrl === dropboxUrl ? <span className="text-[10px]">Copied!</span> : <Copy className="w-3 h-3" />}
</button>
</div>
)}
</>
)}
{/* Actions Section */}
{hasExternalLinks && (
<div className="space-y-1.5">
<p className="text-xs font-medium" style={{ color: 'var(--text-muted)' }}>Links</p>
<div className="flex flex-wrap gap-1.5">
{youtubeUrl && (
<div className="flex">
<a
href={youtubeUrl}
target="_blank"
rel="noopener noreferrer"
className="inline-flex items-center gap-1 text-xs px-3 py-1.5 rounded-l bg-red-600 hover:bg-red-500 text-white transition-colors"
onClick={(e) => e.stopPropagation()}
>
<ExternalLink className="w-3 h-3" />
YouTube
</a>
<button
type="button"
onClick={(e) => { e.stopPropagation(); copyToClipboard(youtubeUrl) }}
className="inline-flex items-center text-xs px-2 py-1.5 rounded-r bg-red-700 hover:bg-red-600 text-white transition-colors"
title="Copy YouTube URL"
aria-label={copiedUrl === youtubeUrl ? "YouTube URL copied" : "Copy YouTube URL"}
>
{copiedUrl === youtubeUrl ? <span className="text-[10px]">Copied!</span> : <Copy className="w-3 h-3" />}
</button>
</div>
)}
{dropboxUrl && (
<div className="flex">
<a
href={dropboxUrl}
target="_blank"
rel="noopener noreferrer"
className="inline-flex items-center gap-1 text-xs px-3 py-1.5 rounded-l bg-[#0061FE] hover:bg-[#0052d6] text-white transition-colors"
onClick={(e) => e.stopPropagation()}
>
<FolderOpen className="w-3 h-3" />
Dropbox
</a>
<button
type="button"
onClick={(e) => { e.stopPropagation(); copyToClipboard(dropboxUrl) }}
className="inline-flex items-center text-xs px-2 py-1.5 rounded-r bg-[#0052d6] hover:bg-[#0047ba] text-white transition-colors"
title="Copy Dropbox URL"
aria-label={copiedUrl === dropboxUrl ? "Dropbox URL copied" : "Copy Dropbox URL"}
>
{copiedUrl === dropboxUrl ? <span className="text-[10px]">Copied!</span> : <Copy className="w-3 h-3" />}
</button>
</div>
)}
</div>
</div>
)}
{/* Downloads */}
{hasDownloads && (
<>
{downloadUrls?.finals?.lossy_4k_mp4 && (
<a
href={api.getDownloadUrl(jobId, "finals", "lossy_4k_mp4")}
className="inline-flex items-center gap-1 text-xs px-3 py-1.5 rounded bg-[var(--brand-pink)] hover:bg-[var(--brand-pink-hover)] text-white transition-colors"
onClick={(e) => e.stopPropagation()}
>
<Download className="w-3 h-3" />
4K Video
</a>
)}
{downloadUrls?.finals?.lossy_720p_mp4 && (
<a
href={api.getDownloadUrl(jobId, "finals", "lossy_720p_mp4")}
className="inline-flex items-center gap-1 text-xs px-3 py-1.5 rounded bg-[#252525] hover:bg-[#333333] text-[var(--text)] border border-[var(--card-border)] transition-colors"
onClick={(e) => e.stopPropagation()}
>
<Download className="w-3 h-3" />
720p Video
</a>
)}
{downloadUrls?.videos?.with_vocals && (
<a
href={api.getDownloadUrl(jobId, "videos", "with_vocals")}
className="inline-flex items-center gap-1 text-xs px-3 py-1.5 rounded bg-[#252525] hover:bg-[#333333] text-[var(--text)] border border-[var(--card-border)] transition-colors"
onClick={(e) => e.stopPropagation()}
>
<Download className="w-3 h-3" />
With Vocals
</a>
)}
{downloadUrls?.packages?.cdg_zip && (
<a
href={api.getDownloadUrl(jobId, "packages", "cdg_zip")}
className="inline-flex items-center gap-1 text-xs px-3 py-1.5 rounded bg-[#252525] hover:bg-[#333333] text-[var(--text)] border border-[var(--card-border)] transition-colors"
onClick={(e) => e.stopPropagation()}
>
<Download className="w-3 h-3" />
CDG
</a>
)}
{downloadUrls?.packages?.txt_zip && (
<a
href={api.getDownloadUrl(jobId, "packages", "txt_zip")}
className="inline-flex items-center gap-1 text-xs px-3 py-1.5 rounded bg-[#252525] hover:bg-[#333333] text-[var(--text)] border border-[var(--card-border)] transition-colors"
onClick={(e) => e.stopPropagation()}
>
<Download className="w-3 h-3" />
TXT
</a>
)}
</>
)}
{/* Admin-only tools */}
{isAdmin && hasOutputs && (
<div className="space-y-1.5 pt-2 border-t border-[var(--card-border)]">
<p className="text-xs font-medium" style={{ color: 'var(--text-muted)' }}>Admin Tools</p>
<div className="flex flex-wrap gap-1.5">
<button
type="button"
onClick={(e) => { e.stopPropagation(); copyCompletionMessage() }}
disabled={isLoadingMessage}
className="inline-flex items-center gap-1 text-xs px-3 py-1.5 rounded bg-[#252525] hover:bg-[#333333] text-[var(--text)] border border-[var(--card-border)] disabled:opacity-50 transition-colors"
title="Copy completion message to clipboard"
>
{isLoadingMessage ? (
<Loader2 className="w-3 h-3 animate-spin" />
) : (
<MessageSquare className="w-3 h-3" />
)}
{copiedMessage ? "Copied!" : "Copy Message"}
</button>
<button
type="button"
onClick={(e) => { e.stopPropagation(); setShowEmailDialog(true) }}
className="inline-flex items-center gap-1 text-xs px-3 py-1.5 rounded bg-[#252525] hover:bg-[#333333] text-[var(--text)] border border-[var(--card-border)] transition-colors"
title="Send completion email"
>
<Mail className="w-3 h-3" />
Send Email
</button>
</div>
{/* Admin Tools */}
{isAdmin && hasOutputs && (
<>
<div className="flex">
<button
type="button"
onClick={(e) => { e.stopPropagation(); setShowEmailDialog(true) }}
className="inline-flex items-center gap-1 text-xs px-3 py-1.5 rounded-l bg-[#252525] hover:bg-[#333333] text-[var(--text)] border border-[var(--card-border)] border-r-0 transition-colors"
title="Send completion email"
>
<Mail className="w-3 h-3" />
Email
</button>
<button
type="button"
onClick={(e) => { e.stopPropagation(); copyCompletionMessage() }}
disabled={isLoadingMessage}
className="inline-flex items-center text-xs px-2 py-1.5 rounded-r bg-[#1a1a1a] hover:bg-[#2a2a2a] text-[var(--text)] border border-[var(--card-border)] disabled:opacity-50 transition-colors"
title="Copy completion message to clipboard"
>
{isLoadingMessage ? (
<Loader2 className="w-3 h-3 animate-spin" />
) : copiedMessage ? (
<span className="text-[10px]">Copied!</span>
) : (
<Copy className="w-3 h-3" />
)}
</button>
</div>
<a
href={`/admin/jobs/?id=${jobId}`}
onClick={(e) => e.stopPropagation()}
className="inline-flex items-center gap-1 text-xs px-3 py-1.5 rounded bg-[#252525] hover:bg-[#333333] text-[var(--text)] border border-[var(--card-border)] transition-colors"
title="View job details in admin"
>
<Settings className="w-3 h-3" />
Admin
</a>
</>
)}
</div>
)}
@@ -339,7 +353,7 @@ export function OutputLinks({ jobId }: OutputLinksProps) {
<DialogHeader>
<DialogTitle>Send Completion Email</DialogTitle>
<DialogDescription>
Send the job completion message to an email address. The email will be CC'd to gen@nomadkaraoke.com.
Send the job completion message to an email address. The email will be CC&apos;d to gen@nomadkaraoke.com.
</DialogDescription>
</DialogHeader>
<div className="grid gap-4 py-4">
+43 -3
View File
@@ -2,12 +2,13 @@
import { useState, useEffect } from "react"
import { api } from "@/lib/api"
import { useTenant } from "@/lib/tenant"
import type { VideoThemeSummary } from "@/lib/video-themes"
import { Label } from "@/components/ui/label"
import { Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from "@/components/ui/select"
import { Skeleton } from "@/components/ui/skeleton"
import { Button } from "@/components/ui/button"
import { Palette, AlertCircle, Eye, EyeOff } from "lucide-react"
import { Palette, AlertCircle, Eye, EyeOff, Lock } from "lucide-react"
interface ThemeSelectorProps {
value?: string
@@ -16,11 +17,15 @@ interface ThemeSelectorProps {
}
export function ThemeSelector({ value, onChange, disabled }: ThemeSelectorProps) {
const { defaults, isDefault: isDefaultTenant } = useTenant()
const [themes, setThemes] = useState<VideoThemeSummary[]>([])
const [loading, setLoading] = useState(true)
const [error, setError] = useState<string | null>(null)
const [showPreview, setShowPreview] = useState(false)
// Check if theme is locked by tenant config
const lockedTheme = defaults.locked_theme
useEffect(() => {
async function loadThemes() {
try {
@@ -29,6 +34,12 @@ export function ThemeSelector({ value, onChange, disabled }: ThemeSelectorProps)
const themeList = await api.listThemes()
setThemes(themeList)
// If theme is locked by tenant, always use that
if (lockedTheme) {
onChange(lockedTheme)
return
}
// If no value is set and there's a default theme, select it
if (!value && themeList.length > 0) {
const defaultTheme = themeList.find(t => t.is_default)
@@ -47,7 +58,7 @@ export function ThemeSelector({ value, onChange, disabled }: ThemeSelectorProps)
}
loadThemes()
}, []) // Only run once on mount
}, [lockedTheme]) // Re-run if locked theme changes
const selectedTheme = themes.find(t => t.id === value)
@@ -78,6 +89,35 @@ export function ThemeSelector({ value, onChange, disabled }: ThemeSelectorProps)
)
}
// If theme is locked by tenant, show read-only display
if (lockedTheme && selectedTheme) {
return (
<div className="space-y-2">
<Label className="flex items-center gap-2" style={{ color: 'var(--text)' }}>
<Palette className="w-4 h-4" />
Video Theme
</Label>
<div
className="flex items-center gap-2 px-3 py-2 rounded-md border"
style={{ backgroundColor: 'var(--secondary)', borderColor: 'var(--card-border)', color: 'var(--text)' }}
>
<Lock className="w-4 h-4" style={{ color: 'var(--text-muted)' }} />
<span>{selectedTheme.name}</span>
</div>
{/* Optional: Show theme preview for locked themes */}
{selectedTheme.thumbnail_url && (
<div className="mt-2 relative w-full aspect-video max-w-xs rounded-lg overflow-hidden border" style={{ borderColor: 'var(--card-border)' }}>
<img
src={selectedTheme.thumbnail_url}
alt={`${selectedTheme.name} preview`}
className="w-full h-full object-cover"
/>
</div>
)}
</div>
)
}
return (
<div className="space-y-2">
<Label htmlFor="theme-select" className="flex items-center gap-2" style={{ color: 'var(--text)' }}>
@@ -88,7 +128,7 @@ export function ThemeSelector({ value, onChange, disabled }: ThemeSelectorProps)
<Select
value={value || ""}
onValueChange={(val) => onChange(val || undefined)}
disabled={disabled}
disabled={disabled || !!lockedTheme}
>
<SelectTrigger
id="theme-select"
@@ -0,0 +1,211 @@
'use client';
import { useState } from 'react';
import { Bell, X, Smartphone, Share } from 'lucide-react';
import { Button } from '@/components/ui/button';
import { usePushNotifications } from '@/hooks/use-push-notifications';
/**
* Soft-ask banner prompting users to enable push notifications.
* Shows different UI for iOS (Add to Home Screen instructions) vs other browsers.
*/
export function PushNotificationPrompt() {
const {
isLoading,
isPushEnabled,
shouldShowPrompt,
needsIOSInstall,
isIOS,
isPWAInstalled,
permission,
subscribe,
dismissPrompt,
error,
} = usePushNotifications();
const [isSubscribing, setIsSubscribing] = useState(false);
// Don't render if loading, not enabled, or shouldn't show
if (isLoading || !isPushEnabled) {
return null;
}
// Show iOS install instructions if on iOS but not installed as PWA
if (needsIOSInstall) {
return (
<div className="bg-blue-500/10 border border-blue-500/20 text-blue-400 px-4 py-3 rounded-lg">
<div className="flex items-start gap-3">
<Smartphone className="h-5 w-5 mt-0.5 flex-shrink-0" />
<div className="flex-1">
<p className="font-medium mb-1">Get notifications on your iPhone</p>
<p className="text-sm text-[var(--text-muted)] mb-3">
To receive push notifications on iOS, install this app to your home screen:
</p>
<ol className="text-sm text-[var(--text-muted)] space-y-2 mb-3">
<li className="flex items-center gap-2">
<span className="bg-blue-500/20 rounded-full w-5 h-5 flex items-center justify-center text-xs">1</span>
<span>Tap the <Share className="inline h-4 w-4" /> Share button in Safari</span>
</li>
<li className="flex items-center gap-2">
<span className="bg-blue-500/20 rounded-full w-5 h-5 flex items-center justify-center text-xs">2</span>
<span>Scroll down and tap &quot;Add to Home Screen&quot;</span>
</li>
<li className="flex items-center gap-2">
<span className="bg-blue-500/20 rounded-full w-5 h-5 flex items-center justify-center text-xs">3</span>
<span>Open the app from your home screen</span>
</li>
</ol>
<p className="text-xs text-[var(--text-muted)]">
iOS requires apps to be installed for push notifications to work.
</p>
</div>
<button
onClick={() => dismissPrompt(false)}
className="text-[var(--text-muted)] hover:text-[var(--text)]"
aria-label="Dismiss"
>
<X className="h-4 w-4" />
</button>
</div>
</div>
);
}
// Show regular prompt for other browsers (or iOS after install)
if (!shouldShowPrompt) {
// Don't show if already subscribed, permission denied, or dismissed
return null;
}
const handleEnable = async () => {
setIsSubscribing(true);
try {
await subscribe();
} finally {
setIsSubscribing(false);
}
};
const handleDismiss = () => {
dismissPrompt(false); // Temporary dismiss (will show again in 7 days)
};
const handleNeverAsk = () => {
dismissPrompt(true); // Permanent dismiss
};
return (
<div className="bg-purple-500/10 border border-purple-500/20 text-purple-300 px-4 py-3 rounded-lg">
<div className="flex items-start gap-3">
<Bell className="h-5 w-5 mt-0.5 flex-shrink-0" />
<div className="flex-1">
<p className="font-medium mb-1">Get notified when your video is ready</p>
<p className="text-sm text-[var(--text-muted)] mb-3">
We&apos;ll send you a notification when your karaoke video needs attention or is ready to download.
</p>
{error && (
<p className="text-sm text-red-400 mb-3">{error}</p>
)}
<div className="flex items-center gap-2 flex-wrap">
<Button
onClick={handleEnable}
size="sm"
disabled={isSubscribing}
className="bg-purple-600 hover:bg-purple-700 text-white"
>
{isSubscribing ? 'Enabling...' : 'Enable Notifications'}
</Button>
<Button
variant="ghost"
size="sm"
onClick={handleDismiss}
className="text-[var(--text-muted)] hover:text-[var(--text)]"
>
Not now
</Button>
<Button
variant="ghost"
size="sm"
onClick={handleNeverAsk}
className="text-[var(--text-muted)] hover:text-[var(--text)] text-xs"
>
Don&apos;t ask again
</Button>
</div>
</div>
<button
onClick={handleDismiss}
className="text-[var(--text-muted)] hover:text-[var(--text)]"
aria-label="Dismiss"
>
<X className="h-4 w-4" />
</button>
</div>
</div>
);
}
/**
* Compact version of the prompt for use in menus/settings.
*/
export function PushNotificationToggle() {
const {
isLoading,
isPushEnabled,
isSubscribed,
permission,
subscribe,
unsubscribe,
error,
} = usePushNotifications();
const [isProcessing, setIsProcessing] = useState(false);
if (isLoading || !isPushEnabled) {
return null;
}
const handleToggle = async () => {
setIsProcessing(true);
try {
if (isSubscribed) {
await unsubscribe();
} else {
await subscribe();
}
} finally {
setIsProcessing(false);
}
};
// Permission was denied - show disabled state
if (permission === 'denied') {
return (
<div className="flex items-center justify-between text-sm">
<div className="flex items-center gap-2 text-[var(--text-muted)]">
<Bell className="h-4 w-4" />
<span>Push Notifications</span>
</div>
<span className="text-xs text-[var(--text-muted)]">Blocked in browser</span>
</div>
);
}
return (
<div className="flex items-center justify-between">
<div className="flex items-center gap-2">
<Bell className="h-4 w-4 text-[var(--text-muted)]" />
<span className="text-sm">Push Notifications</span>
</div>
<Button
variant="outline"
size="sm"
onClick={handleToggle}
disabled={isProcessing}
className="h-7 text-xs"
>
{isProcessing ? '...' : isSubscribed ? 'Disable' : 'Enable'}
</Button>
</div>
);
}
+257
View File
@@ -0,0 +1,257 @@
'use client';
import { useState, useEffect } from 'react';
import { Bell, Smartphone, Monitor, Trash2, RefreshCw, Check, X } from 'lucide-react';
import { Button } from '@/components/ui/button';
import { usePushNotifications } from '@/hooks/use-push-notifications';
import { api, PushSubscriptionInfo } from '@/lib/api';
/**
* Full settings panel for managing push notification subscriptions.
* Shows list of subscribed devices and allows enabling/disabling.
*/
export function PushSettings() {
const {
isLoading: hookLoading,
isPushEnabled,
isSubscribed,
permission,
subscribe,
unsubscribe,
error: hookError,
} = usePushNotifications();
const [subscriptions, setSubscriptions] = useState<PushSubscriptionInfo[]>([]);
const [isLoadingList, setIsLoadingList] = useState(false);
const [isProcessing, setIsProcessing] = useState(false);
const [error, setError] = useState<string | null>(null);
// Load subscriptions list
const loadSubscriptions = async () => {
setIsLoadingList(true);
setError(null);
try {
const response = await api.listPushSubscriptions();
setSubscriptions(response.subscriptions);
} catch (err) {
console.error('Failed to load subscriptions:', err);
setError('Failed to load subscriptions');
} finally {
setIsLoadingList(false);
}
};
// Load subscriptions when component mounts (if authenticated)
useEffect(() => {
if (!hookLoading && isPushEnabled) {
loadSubscriptions();
}
}, [hookLoading, isPushEnabled]);
// Handle enabling notifications
const handleEnable = async () => {
setIsProcessing(true);
setError(null);
try {
const success = await subscribe();
if (success) {
// Reload list to show new subscription
await loadSubscriptions();
}
} finally {
setIsProcessing(false);
}
};
// Handle disabling notifications (unsubscribe current device)
const handleDisable = async () => {
setIsProcessing(true);
setError(null);
try {
const success = await unsubscribe();
if (success) {
// Reload list
await loadSubscriptions();
}
} finally {
setIsProcessing(false);
}
};
// Handle removing a specific subscription (admin feature - remove other devices)
const handleRemoveSubscription = async (endpoint: string) => {
setError(null);
try {
await api.unsubscribePush(endpoint);
// Reload list
await loadSubscriptions();
} catch (err) {
console.error('Failed to remove subscription:', err);
setError('Failed to remove subscription');
}
};
// Get icon for device type based on name
const getDeviceIcon = (deviceName: string | null) => {
if (!deviceName) return <Monitor className="h-4 w-4" />;
const name = deviceName.toLowerCase();
if (name.includes('phone') || name.includes('iphone') || name.includes('android')) {
return <Smartphone className="h-4 w-4" />;
}
return <Monitor className="h-4 w-4" />;
};
// Format date for display
const formatDate = (dateStr: string | null): string => {
if (!dateStr) return 'Unknown';
try {
return new Date(dateStr).toLocaleDateString(undefined, {
year: 'numeric',
month: 'short',
day: 'numeric',
});
} catch {
return 'Unknown';
}
};
if (hookLoading) {
return (
<div className="p-4 text-center text-[var(--text-muted)]">
Loading...
</div>
);
}
if (!isPushEnabled) {
return (
<div className="p-4 bg-[var(--card)] rounded-lg border border-[var(--card-border)]">
<div className="flex items-center gap-2 text-[var(--text-muted)]">
<Bell className="h-5 w-5" />
<span>Push notifications are not available on this server.</span>
</div>
</div>
);
}
return (
<div className="space-y-4">
{/* Status Section */}
<div className="p-4 bg-[var(--card)] rounded-lg border border-[var(--card-border)]">
<div className="flex items-center justify-between mb-4">
<div className="flex items-center gap-2">
<Bell className="h-5 w-5" />
<h3 className="font-medium">Push Notifications</h3>
</div>
<div className="flex items-center gap-2">
{isSubscribed ? (
<span className="flex items-center gap-1 text-sm text-green-400">
<Check className="h-4 w-4" />
Enabled
</span>
) : permission === 'denied' ? (
<span className="flex items-center gap-1 text-sm text-red-400">
<X className="h-4 w-4" />
Blocked
</span>
) : (
<span className="text-sm text-[var(--text-muted)]">Disabled</span>
)}
</div>
</div>
{permission === 'denied' ? (
<div className="text-sm text-[var(--text-muted)] mb-4">
Notifications are blocked in your browser. To enable them, you&apos;ll need to allow notifications in your browser settings.
</div>
) : (
<div className="flex gap-2">
{isSubscribed ? (
<Button
variant="outline"
size="sm"
onClick={handleDisable}
disabled={isProcessing}
>
{isProcessing ? 'Processing...' : 'Disable on this device'}
</Button>
) : (
<Button
size="sm"
onClick={handleEnable}
disabled={isProcessing}
>
{isProcessing ? 'Processing...' : 'Enable notifications'}
</Button>
)}
</div>
)}
{(hookError || error) && (
<p className="text-sm text-red-400 mt-2">{hookError || error}</p>
)}
</div>
{/* Subscriptions List */}
<div className="p-4 bg-[var(--card)] rounded-lg border border-[var(--card-border)]">
<div className="flex items-center justify-between mb-4">
<h3 className="font-medium">Subscribed Devices</h3>
<Button
variant="ghost"
size="sm"
onClick={loadSubscriptions}
disabled={isLoadingList}
className="h-8 w-8 p-0"
title="Refresh"
>
<RefreshCw className={`h-4 w-4 ${isLoadingList ? 'animate-spin' : ''}`} />
</Button>
</div>
{isLoadingList ? (
<div className="text-sm text-[var(--text-muted)]">Loading...</div>
) : subscriptions.length === 0 ? (
<div className="text-sm text-[var(--text-muted)]">
No devices are subscribed to push notifications.
</div>
) : (
<ul className="space-y-2">
{subscriptions.map((sub, index) => (
<li
key={sub.endpoint}
className="flex items-center justify-between p-2 bg-[var(--secondary)] rounded"
>
<div className="flex items-center gap-3">
{getDeviceIcon(sub.device_name)}
<div>
<div className="text-sm font-medium">
{sub.device_name || `Device ${index + 1}`}
</div>
<div className="text-xs text-[var(--text-muted)]">
Added {formatDate(sub.created_at)}
{sub.last_used_at && ` • Last used ${formatDate(sub.last_used_at)}`}
</div>
</div>
</div>
<Button
variant="ghost"
size="sm"
onClick={() => handleRemoveSubscription(sub.endpoint)}
className="h-8 w-8 p-0 text-[var(--text-muted)] hover:text-red-400"
title="Remove this device"
>
<Trash2 className="h-4 w-4" />
</Button>
</li>
))}
</ul>
)}
<p className="text-xs text-[var(--text-muted)] mt-4">
You can have up to 5 devices subscribed. Adding more will remove the oldest subscription.
</p>
</div>
</div>
);
}
@@ -0,0 +1,54 @@
'use client';
import { useEffect } from 'react';
/**
* Registers the service worker for push notifications.
* This component renders nothing - it just handles SW registration on mount.
*/
export function ServiceWorkerRegistration() {
useEffect(() => {
if (typeof window === 'undefined') return;
// Only register in production or when explicitly enabled
// Service workers require HTTPS (except localhost)
const isLocalhost = window.location.hostname === 'localhost';
const isSecure = window.location.protocol === 'https:';
if (!isSecure && !isLocalhost) {
console.log('[SW] Skipping service worker registration: requires HTTPS');
return;
}
if (!('serviceWorker' in navigator)) {
console.log('[SW] Service workers not supported');
return;
}
// Register the service worker
navigator.serviceWorker
.register('/sw.js', { scope: '/' })
.then((registration) => {
console.log('[SW] Service worker registered:', registration.scope);
// Check for updates periodically
registration.addEventListener('updatefound', () => {
const newWorker = registration.installing;
if (newWorker) {
console.log('[SW] New service worker installing...');
newWorker.addEventListener('statechange', () => {
if (newWorker.state === 'installed' && navigator.serviceWorker.controller) {
console.log('[SW] New service worker installed, refresh for updates');
}
});
}
});
})
.catch((error) => {
console.error('[SW] Service worker registration failed:', error);
});
}, []);
// This component renders nothing
return null;
}
+74
View File
@@ -0,0 +1,74 @@
"use client"
import Image from "next/image"
import { useTenant } from "@/lib/tenant"
// Default Nomad Karaoke logo URL
const DEFAULT_LOGO_URL =
"https://nomadkaraoke.com/wp-content/uploads/2024/07/Nomad-Karaoke-Logo-TextOnly-Cropped-FromSVG-HQ-2048x1088.png"
interface TenantLogoProps {
className?: string
size?: "sm" | "lg"
}
/**
* Logo component that displays either the tenant's logo or the default Nomad Karaoke logo.
* Automatically adapts based on the current tenant configuration.
*/
export function TenantLogo({ className = "", size = "sm" }: TenantLogoProps) {
const { tenant, branding, isDefault } = useTenant()
// Determine logo URL and dimensions
const logoUrl = branding.logo_url || DEFAULT_LOGO_URL
const logoHeight = branding.logo_height || 40
// Size classes based on size prop - use static Tailwind classes only
// Dynamic height is applied via inline style
const sizeClasses =
size === "lg"
? "max-w-[600px]"
: "max-w-[200px]"
// Compute max height for inline style
const maxHeight = size === "lg" ? 120 : logoHeight
// For tenant logos, use img tag since they come from GCS signed URLs
// For default logo, use Next.js Image for optimization
if (!isDefault && branding.logo_url) {
return (
<div className={`flex items-center ${className}`}>
{/* eslint-disable-next-line @next/next/no-img-element */}
<img
src={logoUrl}
alt={tenant?.name || "Logo"}
className={`w-auto h-auto ${sizeClasses} object-contain`}
style={{ maxHeight }}
/>
</div>
)
}
// Default Nomad Karaoke logo with Next.js Image optimization
return (
<div className={`flex items-center ${className}`}>
<Image
src={DEFAULT_LOGO_URL}
alt="Nomad Karaoke"
width={200}
height={106}
className={`w-auto h-auto ${sizeClasses} object-contain`}
style={{ maxHeight }}
priority
/>
</div>
)
}
/**
* Standalone Logo component for backward compatibility.
* Simply wraps TenantLogo.
*/
export function Logo({ className = "", size = "sm" }: TenantLogoProps) {
return <TenantLogo className={className} size={size} />
}
Loaded 100 of 131 files, more files were not shown because too many files have changed in this diff. Show more