Compare commits

...
Author SHA1 Message Date
Andrew Beveridge ☄️ f2a6761f43 Merge branch 'main' into feature/payment-flow 2025-12-28 16:22:38 -05:00
Andrew BeveridgeandClaude Opus 4.5 70a5af44f9 fix: Address CodeRabbit review - race conditions in Stripe idempotency and job counter
- Use atomic create() for Stripe session idempotency to prevent TOCTOU race
  where concurrent webhooks could both pass the check before marking processed
- Use Firestore Increment() for atomic job counter updates to prevent lost
  increments from concurrent calls

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 16:20:49 -05:00
Andrew BeveridgeandClaude Opus 4.5 4ddbe8b4e0 fix: ensure distribution settings defaults applied consistently across all upload endpoints
Jobs created via file upload and URL upload endpoints were missing default
brand_prefix from environment variables, causing Dropbox uploads to fail
(requires both dropbox_path and brand_prefix) and Google Drive uploads to
use fallback "TRACK-0000" prefix.

- Added _get_effective_distribution_settings() helper function to centralize
  default computation for dropbox_path, gdrive_folder_id, discord_webhook_url,
  and brand_prefix
- Refactored all 4 upload endpoints to use the helper:
  - Multipart upload (/api/jobs/upload)
  - Signed URL upload (/api/upload/complete/*)
  - URL upload (/api/jobs/from-url)
  - Finalise only (/api/jobs/finalise-only)
- Added EffectiveDistributionSettings dataclass for type safety
- Documented this pattern in LESSONS-LEARNED.md

Fixes job 264cf6f0 and similar cases where upload-created jobs had null
brand_prefix despite DEFAULT_BRAND_PREFIX being configured.

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 16:20:49 -05:00
Andrew Beveridge ☄️ 22e1e42602 Merge pull request #113 from nomadkaraoke/investigate/dropbox-gdrive-upload
fix: ensure distribution settings defaults applied consistently across all upload endpoints
2025-12-28 16:11:30 -05:00
Andrew Beveridge ☄️ 4bfb0c39cd Merge branch 'main' into feature/payment-flow 2025-12-28 16:06:09 -05:00
Andrew Beveridge ☄️ ecd1587fd5 Merge branch 'main' into investigate/dropbox-gdrive-upload 2025-12-28 16:04:47 -05:00
Andrew Beveridge ☄️ a708b119db Merge pull request #114 from nomadkaraoke/feature/self-hosted-runners
ci: use self-hosted runners for heavy CI jobs
2025-12-28 16:04:31 -05:00
Andrew Beveridge 341fc94e8c Merge remote-tracking branch 'origin/main' into investigate/dropbox-gdrive-upload 2025-12-28 16:02:37 -05:00
Andrew BeveridgeandClaude Opus 4.5 1a52481694 ci: use self-hosted runners for heavy CI jobs
Move disk-intensive jobs to self-hosted GCP runners to avoid
"No space left on device" errors on GitHub-hosted runners.

Jobs moved to self-hosted:
- package-unit-tests (Poetry + spaCy model downloads)
- package-integration-tests (Poetry + spaCy model downloads)
- backend-lint (Poetry install)
- package-build (Poetry build during deploy)

This leverages our 10 self-hosted runners with 200GB SSD.

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 16:02:29 -05:00
Andrew BeveridgeandClaude Opus 4.5 9d5efe1696 fix: ensure distribution settings defaults applied consistently across all upload endpoints
Jobs created via file upload and URL upload endpoints were missing default
brand_prefix from environment variables, causing Dropbox uploads to fail
(requires both dropbox_path and brand_prefix) and Google Drive uploads to
use fallback "TRACK-0000" prefix.

- Added _get_effective_distribution_settings() helper function to centralize
  default computation for dropbox_path, gdrive_folder_id, discord_webhook_url,
  and brand_prefix
- Refactored all 4 upload endpoints to use the helper:
  - Multipart upload (/api/jobs/upload)
  - Signed URL upload (/api/upload/complete/*)
  - URL upload (/api/jobs/from-url)
  - Finalise only (/api/jobs/finalise-only)
- Added EffectiveDistributionSettings dataclass for type safety
- Documented this pattern in LESSONS-LEARNED.md

Fixes job 264cf6f0 and similar cases where upload-created jobs had null
brand_prefix despite DEFAULT_BRAND_PREFIX being configured.

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 16:00:07 -05:00
Andrew Beveridge ☄️ 990f5152a0 Merge pull request #112 from nomadkaraoke/feature/frontend-notifications
feat(frontend): add notifications and instant refresh on tab focus
2025-12-28 15:58:22 -05:00
Andrew BeveridgeandClaude Opus 4.5 debdef1d86 chore: update docs-review command to use feature branch
Add reminder to make documentation changes on the current feature
branch (git worktree), not on main.

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 15:57:20 -05:00
Andrew BeveridgeandClaude Opus 4.5 3ceaa600dd docs: add lesson learned about frontend polling vs tab visibility
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 15:56:25 -05:00
Andrew BeveridgeandClaude Opus 4.5 2483d5783d fix(frontend): improve active tab visibility with shadow and color contrast
- Add shadow-md to active tabs for better visual depth
- Use muted text color for inactive tabs to increase contrast
- Add hover effect (amber tint) for inactive tabs
- Ensures active tab is clearly distinguishable in both light/dark modes

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 15:54:23 -05:00
Andrew Beveridge 6e8a32416e fix: Simplify AuthStatus tests to avoid Radix UI portal issues in jsdom 2025-12-28 15:51:43 -05:00
Andrew BeveridgeandClaude Opus 4.5 4762297836 feat(frontend): add notifications and instant refresh on tab focus
- Add useJobNotifications hook with sound alerts and title animation
  when jobs need attention, complete, or fail
- Add useVisibilityRefresh hook to immediately refresh jobs when
  returning from review/instrumental UIs
- Sound uses Web Audio API (no external files needed)
- Title flashes to attract attention when page is in background
- Fixes stale status display after completing review stages

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 15:45:13 -05:00
Andrew Beveridge 2786294718 fix: Update AuthStatus tests to handle Radix UI portal rendering 2025-12-28 15:44:59 -05:00
Andrew Beveridge b5657ea6c6 fix: Restore @testing-library/dom in package-lock.json 2025-12-28 15:37:52 -05:00
Andrew Beveridge a6ca766a87 Merge branch 'main' into feature/payment-flow 2025-12-28 15:30:44 -05:00
Andrew Beveridge ☄️ b74a0bb284 Merge pull request #111 from nomadkaraoke/feature/agentic-gemini-vertexai
feat: add Gemini 3 Flash via Vertex AI for agentic lyrics correction
2025-12-28 15:30:14 -05:00
Andrew Beveridge ☄️ b466ebf068 Merge pull request #109 from nomadkaraoke/fix/download-links-auth
fix: include auth token in frontend download URLs
2025-12-28 15:23:32 -05:00
Andrew Beveridge ☄️ d5da92847d Merge branch 'main' into fix/download-links-auth 2025-12-28 15:17:07 -05:00
Andrew BeveridgeandClaude Opus 4.5 c9d2ecfdcb docs: update documentation for agentic AI correction feature
- Add Agentic AI correction status to README
- Add Vertex AI to external services in ARCHITECTURE.md
- Add Vertex AI authentication lesson to LESSONS-LEARNED.md

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 15:16:19 -05:00
Andrew BeveridgeandClaude Opus 4.5 a897ac8cbd chore: add frontend/e2e/screenshots/ to .gitignore
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 15:11:31 -05:00
Andrew BeveridgeandClaude Opus 4.5 6b0f171609 feat: add Gemini 3 Flash via Vertex AI for agentic lyrics correction
Add support for Google's Gemini 3 Flash model through Vertex AI for
intelligent lyrics correction. This uses GCP's free credits and the
existing service account authentication.

Changes:
- Add langchain-google-vertexai dependency to lyrics_transcriber
- Implement Vertex AI provider in model_factory.py
- Add GCP project/location settings to provider config
- Update router to use Gemini 3 Flash as default model
- Add USE_AGENTIC_AI config to backend with env var passthrough
- Grant roles/aiplatform.user IAM permission to backend service account
- Update agentic correction guide with Vertex AI instructions

The agentic AI correction is enabled by default and uses:
- Model: vertexai/gemini-3-flash-preview
- Auth: Application Default Credentials (service account)

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 15:08:32 -05:00
Andrew BeveridgeandClaude Opus 4.5 c10dae3759 docs: add lessons learned for state_data and GDrive escaping bugs
Documents two gotchas discovered while fixing PR #109:
- Stale object references after async operations can overwrite DB changes
- Google Drive API queries need single quotes escaped in filenames

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 15:08:01 -05:00
Andrew BeveridgeandClaude Opus 4.5 ab8680cd19 docs: add lessons learned for state_data and GDrive escaping bugs
Documents two gotchas discovered while fixing PR #109:
- Stale object references after async operations can overwrite DB changes
- Google Drive API queries need single quotes escaped in filenames

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 15:07:52 -05:00
Andrew Beveridge ☄️ 42c3235513 Merge pull request #110 from nomadkaraoke/fix/tab-and-jobcard-styling
fix(frontend): improve tab visibility and job card styling for light mode
2025-12-28 15:03:29 -05:00
Andrew BeveridgeandClaude Opus 4.5 d2a917827c fix: escape single quotes in Google Drive API queries
Filenames containing apostrophes (e.g., "Nobody's Home") were causing
Google Drive API 400 errors because single quotes need to be escaped
in the query string syntax.

Added escaping for both filename and folder_name in queries.

Fixes job 47475700 where GDrive upload failed with:
"Invalid Value" in query: name='NOMAD-1187 - Avril Lavigne - Nobody's Home.mp4'

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 15:02:13 -05:00
Andrew BeveridgeandClaude Opus 4.5 973215357f fix(frontend): improve tab visibility and job card styling for light mode
- Add amber background to active tab for clear visibility in both modes
- Fix job card to use CSS variables instead of hardcoded slate colors
- Update OutputLinks, JobLogs, JobActions with proper theme variables
- Progress bar now uses CSS variables for background

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 14:58:04 -05:00
Andrew BeveridgeandClaude Opus 4.5 5bc521016e fix: preserve dropbox_link and gdrive_files in final state_data update
The video worker was overwriting state_data after distribution completed,
using the OLD job.state_data from before _handle_native_distribution ran.
This discarded the dropbox_link and gdrive_files that were just saved.

Now explicitly includes these values from the result dict in the final
state_data update, ensuring distribution links are preserved.

This fixes the issue where Dropbox folder link wasn't showing in the UI
even though the upload succeeded.

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 14:56:36 -05:00
Andrew BeveridgeandClaude Opus 4.5 05c2e84455 fix: include auth token in frontend download URLs
Download links were failing with "Authentication required" because the
frontend was generating bare URLs without authentication tokens. The
browser navigates directly to these URLs without the Authorization header.

Fixed by appending the user's token as a query parameter (?token=...) to
download URLs, which the backend accepts as an alternative to the Bearer
header.

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 14:45:45 -05:00
Andrew Beveridge ☄️ 7e2b4f1afc Merge pull request #108 from nomadkaraoke/feature/version-display-and-ui
feat(frontend): add version display and improve UI
2025-12-28 14:44:23 -05:00
Andrew BeveridgeandClaude Opus 4.5 4415ac8527 feat(frontend): add version display and improve UI
- Add version footer showing frontend and backend versions
- Make Search the default tab (reordered: Search, Upload, URL)
- Remove theme description text from selector
- Add "Show preview" button for theme thumbnails (lazy load)
- Fix light mode colors using CSS variables throughout
- Sync frontend package.json version with pyproject.toml

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 14:41:05 -05:00
Andrew Beveridge ☄️ 95659fe52b Merge pull request #107 from nomadkaraoke/feature/fix-local-whisper-env-vars
fix: make local-whisper respect WHISPER_MODEL_SIZE and WHISPER_DEVICE env vars
2025-12-28 14:30:07 -05:00
Andrew BeveridgeandClaude Opus 4.5 260550ddb9 fix: update test mock to support os.getenv with default argument
The os.getenv mock in test_transcribe_lyrics_new_transcription only
accepted one argument, but TranscriberConfig now calls os.getenv with
a default value (e.g., os.getenv("WHISPER_MODEL_SIZE", "medium")).

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 14:22:33 -05:00
Andrew BeveridgeandClaude Opus 4.5 e9e9aff78e fix: Update AuthStatus tests to match new auth implementation
- Mock useAuth hook instead of old API functions
- Test dropdown menu behavior for authenticated users
- Test magic link and token authentication flows in AuthDialog
- Update assertions to match refactored component structure

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 14:17:18 -05:00
Andrew BeveridgeandClaude Opus 4.5 fbc0a3ac5d fix: make local-whisper respect WHISPER_MODEL_SIZE and WHISPER_DEVICE env vars
TranscriberConfig was using hardcoded defaults for local whisper settings
instead of reading from environment variables. This caused the env vars
WHISPER_MODEL_SIZE and WHISPER_DEVICE to be ignored.

The fix uses field(default_factory=...) to read from environment variables
at instantiation time, matching the documented behavior in LocalWhisperTranscriber.

Closes #93

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 14:14:41 -05:00
Andrew Beveridge ☄️ dbe39c9ad5 Merge pull request #106 from nomadkaraoke/fix/always-deploy-backend
fix: deploy backend on every push to main
2025-12-28 14:10:34 -05:00
Andrew BeveridgeandClaude Opus 4.5 6e8997eae8 fix: deploy backend on every push to main
Previously, backend deployment would skip if the version tag already existed.
This caused issues when multiple PRs merged with the same version - only the
first one would deploy.

Changes:
- Remove version tag check from deploy-backend job
- Deploy on every push to main regardless of version
- Docker caching still works efficiently for unchanged layers

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 14:09:02 -05:00
Andrew Beveridge 378043fa03 Merge branch 'main' into feature/payment-flow 2025-12-28 14:06:45 -05:00
Andrew Beveridge ☄️ 3ba3dc2d02 Merge pull request #105 from nomadkaraoke/feature/frontend-outputs-ui
feat(frontend): combine output links and fix React 19 test compatibility
2025-12-28 14:02:07 -05:00
Andrew BeveridgeandClaude Opus 4.5 257f592ef7 feat(frontend): combine output links and fix React 19 test compatibility
- Combine Distribution and Downloads sections into single Outputs row
- Fix dropbox_folder_url -> dropbox_link key to match backend state_data
- Upgrade @testing-library/react to v16.3.1 for React 19 support
- Upgrade @testing-library/jest-dom to v6.9.1

Fixes #102

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 13:59:40 -05:00
Andrew Beveridge ☄️ 9a33b6a6e0 Merge pull request #104 from nomadkaraoke/feature/scale-runners-to-10
feat: scale GitHub Actions runners from 5 to 10
2025-12-28 13:53:49 -05:00
Andrew BeveridgeandClaude Opus 4.5 4508c27ade feat: scale GitHub Actions runners from 5 to 10
- Increase NUM_RUNNERS from 5 to 10 for more parallel CI capacity
- Add ignoreChanges for existing runners (1-5) to prevent replacement
- Update documentation to reflect 10 runners

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 13:53:06 -05:00
Andrew Beveridge ☄️ 8e3bd636c4 Merge pull request #59 from nomadkaraoke/feature/agentic-playwright-tests-docs
Add agentic correction Playwright E2E tests and update documentation
2025-12-28 13:48:43 -05:00
Andrew Beveridge ☄️ 80f140c53d Merge branch 'main' into feature/agentic-playwright-tests-docs 2025-12-28 13:41:48 -05:00
Andrew Beveridge ☄️ 76fab7d73e Merge pull request #103 from nomadkaraoke/fix/runner-work-permissions
fix: correct _work directory ownership in runner startup script
2025-12-28 13:38:27 -05:00
Andrew BeveridgeandClaude Opus 4.5 3916652871 fix: correct _work directory ownership in runner startup script
The _work directory was owned by root but runner service runs as 'runner' user,
causing "Access denied" errors when jobs tried to create _temp directory.

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 13:30:15 -05:00
Andrew Beveridge ☄️ 1bc6dbe1a2 Merge pull request #100 from nomadkaraoke/fix/upload-endpoint-theme-support
Fix: Add theme support to /api/jobs/upload endpoint
2025-12-28 13:27:23 -05:00
Andrew Beveridge ☄️ 71b33a6b93 Merge pull request #101 from nomadkaraoke/feature/multiple-runners
feat: scale to 5 self-hosted GitHub runners for parallel CI jobs
2025-12-28 13:26:04 -05:00
Andrew BeveridgeandClaude Opus 4.5 c3e1edfcb4 feat: scale to 5 self-hosted GitHub runners for parallel CI jobs
- Replace single github-runner VM with 5 instances (github-runner-1 through 5)
- Enables parallel job execution across multiple PRs
- Each runner: e2-standard-4, 200GB SSD, same tooling
- Update README with new runner count and troubleshooting commands

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 13:11:49 -05:00
Andrew BeveridgeandClaude Opus 4.5 4c48c5918c fix: Wrap payment success page in Suspense boundary
Next.js requires useSearchParams() to be wrapped in a Suspense
boundary for static export builds.

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 13:08:29 -05:00
Andrew Beveridge ☄️ f3120589b6 Merge branch 'main' into feature/payment-flow 2025-12-28 12:59:24 -05:00
Andrew BeveridgeandClaude Opus 4.5 57fa535057 chore: Remove unused discountPercent function
The function was exported but never used - page component uses
hardcoded discount labels instead.

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 12:56:03 -05:00
Andrew BeveridgeandClaude Opus 4.5 f44b8a278a fix: Address remaining CodeRabbit review feedback
- Fix useEffect dependency loop in verify page by using useRef guard
  to prevent duplicate verification attempts and getting fresh error
  state from Zustand store
- Fix is_stripe_session_processed O(n×m) performance issue by using
  dedicated processed_stripe_sessions collection for O(1) lookup
  instead of scanning all users and their transactions

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 12:55:20 -05:00
Andrew BeveridgeandClaude Opus 4.5 44c591a629 Fix: Add theme support to /api/jobs/upload endpoint
The /api/jobs/upload endpoint was missing theme_id and color_overrides
parameters, causing themes selected in the frontend to not be passed
through when creating jobs via file upload. This resulted in preview
videos having black backgrounds instead of themed backgrounds.

Changes:
- Add theme_id and color_overrides Form parameters to upload endpoint
- Change enable_cdg/enable_txt to Optional[bool] for smart defaults
- Add _resolve_cdg_txt_defaults() to enable CDG/TXT when theme is set
- Add _prepare_theme_for_job() call when theme_id is set (no custom style files)
- Pass theme_id and color_overrides to JobCreate
- Use theme's YouTube description template if no custom one provided

Root cause: The frontend was sending theme_id in the form data, but the
backend endpoint was not accepting this parameter, so it was silently
ignored. PR #72 fixed this for audio_search.py but this endpoint was missed.

Fixes issue where job c9516773 (file upload) had black background while
job 47475700 (song search) correctly showed themed background.

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 12:32:18 -05:00
Andrew BeveridgeandClaude Opus 4.5 fd63d0d948 docs: Add Playwright assertion best practices to lessons learned
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 12:25:48 -05:00
Andrew BeveridgeandClaude Opus 4.5 84f4e3b769 refactor: Replace waitForTimeout with proper assertions in Playwright tests
- Remove all waitForTimeout() calls in favor of expect().toBeVisible() assertions
- Use Playwright's built-in auto-retry mechanism for reliable tests
- Remove diagnostic code (console.log, screenshots)
- Address CodeRabbit nitpicks about arbitrary timeouts

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 12:21:51 -05:00
Andrew BeveridgeandClaude Opus 4.5 8588625448 fix: Address ruff linting issues in modified files
- Remove unused import require_auth
- Remove unused datetime import in submit_beta_feedback
- Fix f-strings without placeholders in console email provider

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 12:21:27 -05:00
Andrew BeveridgeandClaude Opus 4.5 597233b432 Merge main into feature/agentic-playwright-tests-docs
- Resolve version conflict: bump to 0.76.26
- Keep Header.tsx with Review Mode changes
- Take main's yarn.lock

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 12:20:05 -05:00
Andrew Beveridge ☄️ 2203595e51 Merge pull request #99 from nomadkaraoke/feature/coderabbit-review-command
feat: add /coderabbit-review slash command
2025-12-28 12:17:40 -05:00
Andrew BeveridgeandClaude Opus 4.5 635c4e7ee6 feat: add /coderabbit-review slash command
Adds a Claude Code slash command that reviews and addresses CodeRabbit
comments on the current PR:
- Fetches both review threads and nitpick comments
- Analyzes each comment and decides if action is needed
- Makes appropriate code fixes
- Commits/pushes changes and resolves threads

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 12:16:28 -05:00
Andrew BeveridgeandClaude Opus 4.5 e40a551720 fix: Address CodeRabbit review comments for payment flow
Critical fixes:
- Welcome email timing: Check first login BEFORE verify_magic_link updates last_login_at
- Stripe webhook idempotency: Add is_stripe_session_processed() check to prevent duplicate credit additions
- XSS vulnerability: HTML-escape job_title in feedback request email template

Code quality improvements:
- Replace inefficient len(list(stream())) with Firestore aggregation count queries
- Fix unused variables: msg -> _, success -> _ in webhook and beta enrollment
- Improve admin audit trails: Use admin token prefix for tracking instead of generic "admin" placeholder

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 12:14:03 -05:00
Andrew BeveridgeandClaude Opus 4.5 3a65a8ee13 feat: Add Review Mode for agentic corrections with inline actions
- Add Review Mode toggle in Header (shows when agentic mode is active)
- Add batch action buttons: Accept All, Accept High Confidence, Revert All
- Wire up CorrectedWordWithActions component for agentic corrections
- Show original word preview (strikethrough) on all agentic corrections
- Add showActions prop to conditionally show inline buttons
- Mobile: tap opens detail modal instead of inline buttons
- Fix CodeRabbit issues: format bare URLs as markdown links
- Fix fixture data: align original_word values with segment words
- Add new Playwright tests for Review Mode functionality

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 12:11:28 -05:00
Andrew BeveridgeandClaude Opus 4.5 3c9184897c Merge branch 'main' into feature/payment-flow
Combines payment flow features (PR #90) with CI/CD self-hosted runner from main.

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 12:09:58 -05:00
Andrew Beveridge ☄️ 1c5711cfa5 Merge pull request #98 from nomadkaraoke/docs/runner-setup
docs: add self-hosted runner documentation
2025-12-28 12:06:31 -05:00
Andrew Beveridge ☄️ 08d7db9943 Merge pull request #97 from nomadkaraoke/fix/runner-startup-script
fix: make runner startup script reproducible
2025-12-28 12:06:24 -05:00
Andrew BeveridgeandClaude Opus 4.5 7b5a150e81 docs: add self-hosted runner documentation
- Update README.md with CI/CD runner status
- Add lessons learned for self-hosted runner setup
- Create archive doc with full implementation details

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 12:05:27 -05:00
Andrew BeveridgeandClaude Opus 4.5 d2c8c24eee fix: make runner startup script reproducible
Fixes issues discovered during initial runner setup:

- Use `gpg --batch` for all GPG commands to avoid tty errors
- Install Python 3.13 via pyenv (not broken PPA/source build)
- Set up Python 3.13 in tool cache for setup-python action
- Use Temurin directly for Java 21 (skip broken Debian repos)

These changes ensure the runner VM can be recreated from scratch
and work correctly with GitHub Actions setup-python.

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 12:03:10 -05:00
Andrew Beveridge ☄️ 0b57b8f610 Merge pull request #95 from nomadkaraoke/feature/self-hosted-runner
feat: add self-hosted GitHub Actions runner on GCP
2025-12-28 11:51:59 -05:00
Andrew BeveridgeandClaude Opus 4.5 050ca6a441 fix: add setup-python and install-poetry to self-hosted runner jobs
Addresses CodeRabbit review feedback - the self-hosted runner jobs
need proper Python and Poetry setup via actions rather than relying
on pre-installed versions. This ensures Python 3.13 compatibility.

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 11:49:09 -05:00
Andrew BeveridgeandClaude Opus 4.5 2725352d89 feat: add self-hosted GitHub Actions runner on GCP
Adds a dedicated GCP VM (e2-standard-4, 200GB SSD) to run GitHub Actions
jobs that were hitting disk space limits on GitHub-hosted runners (14GB).

Infrastructure changes:
- New service account `github-runner` with minimal permissions
- Secret Manager secret for GitHub PAT (runner registration)
- Compute instance with startup script that installs Docker, Python 3.13,
  Node.js 20, Java 21, Poetry, FFmpeg, and registers as a GitHub runner

Workflow changes:
- `package-build-test` now uses self-hosted runner
- `backend-unit-tests` now uses self-hosted runner
- `backend-emulator-tests` now uses self-hosted runner
- `deploy-backend` now uses self-hosted runner
- Removed disk cleanup steps (no longer needed with 200GB)

Setup requires adding GitHub PAT to Secret Manager after `pulumi up`:
  echo -n "ghp_xxx" | gcloud secrets versions add github-runner-pat --data-file=-

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 11:18:50 -05:00
Andrew Beveridge ☄️ 762cdf03c9 Merge pull request #94 from nomadkaraoke/fix/pip-install-quotes-91
docs: Add quotes to pip install commands for cross-shell compatibility
2025-12-28 11:11:47 -05:00
Andrew BeveridgeandClaude Opus 4.5 7df3a21525 docs: Add quotes to pip install commands for cross-shell compatibility
Wrap package names with extras notation in double quotes to prevent
zsh and other shells from interpreting square brackets as glob patterns.

Fixes #91

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 11:10:09 -05:00
Andrew Beveridge 8d357eec5d fix: Wrap useSearchParams in Suspense boundary for Next.js static export
The /auth/verify page uses useSearchParams() which requires a Suspense
boundary for Next.js static export builds. Extracted the search params
logic into a separate component wrapped in Suspense.
2025-12-28 10:59:16 -05:00
Andrew Beveridge bef9c74bfc refactor: Address CodeRabbit nitpick comments
- Remove unused fetchUser/isLoading from AuthStatus destructuring
- Use NEXT_PUBLIC_BUY_URL env var for buy URL flexibility
- Change logger.error to logger.exception in all exception handlers
  for better stack trace diagnostics (user_service.py, email_service.py)
2025-12-28 10:58:15 -05:00
Andrew Beveridge 6a7006e034 fix: Use Firestore transaction in deduct_credit to prevent race condition
Addresses CodeRabbit review comment about TOCTOU vulnerability in credit
deduction. Now atomically reads, checks balance, and updates within a
single Firestore transaction.
2025-12-28 10:48:38 -05:00
Andrew Beveridge 28a61efa29 Merge origin/main into feature/payment-flow
Resolved conflicts:
- pyproject.toml: Keep v0.76.26
- AuthStatus.tsx: Keep payment dropdown UI with mobile UX improvements
2025-12-28 10:47:50 -05:00
Andrew BeveridgeandClaude Opus 4.5 b549ba70ed docs: Update documentation for PR #90 payment and beta features
- README: Update status table with payment flow and beta program
- API.md: Add user auth, credits, and beta tester endpoints
- LESSONS-LEARNED.md: Add gitignore and Firestore transaction insights
- archive: Add session summary for PR #90 work

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 04:06:05 -05:00
Andrew BeveridgeandClaude Opus 4.5 c51b0126a7 feat: Add beta tester program with free credit for feedback
Implements a low-friction beta tester promo that grants users free credits
in exchange for their promise to provide feedback after using the tool.

Backend:
- Add BetaTesterStatus enum and beta fields to User model
- Add BetaTesterFeedback model for collecting user feedback
- Add POST /users/beta/enroll endpoint for beta signup
- Add POST /users/beta/feedback endpoint for feedback submission
- Add GET /users/beta/feedback-form for checking feedback status
- Add admin endpoints: /admin/beta/feedback, /admin/beta/stats
- Add email templates: beta_welcome, feedback_request

Frontend (buy-site):
- Add beta tester signup section with purple gradient styling
- Require checkbox acceptance of correction work
- Require promise text (min 10 chars) for feedback commitment
- Auto-redirect to main app after successful enrollment
- Add enrollBetaTester API method

Features:
- 1 free credit granted on beta enrollment
- Bonus credit for detailed feedback (50+ chars)
- Feedback includes ratings (1-5) for ease, accuracy, correction UX
- Admin dashboard shows aggregate beta stats and ratings

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 04:03:55 -05:00
Andrew BeveridgeandClaude Opus 4.5 ebb9503bde fix: Address CodeRabbit review comments for PR #90
- Add try/except for invalid credits metadata in stripe_service.py
- Fix race condition in magic link verification with Firestore transaction
- Move @import before @tailwind directives in globals.css (CSS spec)
- Fix broken Open Graph image URL in layout.tsx
- Remove insecure fallback admin privileges in auth.ts
- Bump version to 0.76.26

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 03:58:07 -05:00
Andrew BeveridgeandClaude Opus 4.5 b204f28d50 feat: Add customer payment flow with magic link authentication
Implements complete payment system for karaoke video generation:

Backend:
- Magic link authentication with 15-minute expiry tokens
- Session management with 7-day inactivity timeout
- Credit system with transaction history
- Stripe checkout integration with webhook handling
- User management API endpoints
- SendGrid email service for transactional emails
- Admin endpoints for user management and credit grants

Frontend:
- Updated AuthDialog to support magic link login
- AuthStatus with user menu and credit display
- Auth verification page for magic link callbacks
- Payment success page for post-checkout flow
- Buy more credits link to buy.nomadkaraoke.com

Landing Page (buy-site/):
- Next.js static site for buy.nomadkaraoke.com
- Responsive dark theme matching existing design
- Credit package selection with volume discounts
- Stripe checkout integration

Documentation:
- STRIPE-SETUP.md with complete setup guide

Credit packages:
- 1 credit: $5.00
- 3 credits: $12.00 (20% off)
- 5 credits: $17.50 (30% off)
- 10 credits: $30.00 (40% off)

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 03:26:32 -05:00
Andrew Beveridge ☄️ f72f772f96 Merge pull request #88 from nomadkaraoke/feature/mobile-ux-improvements
feat: improve mobile responsiveness across all UIs
2025-12-28 03:13:58 -05:00
Andrew BeveridgeandClaude Opus 4.5 7a30407fdb fix: Address CodeRabbit review feedback
- Add language identifier to markdown code block in docs
- Increase Undo/Redo button touch targets from 32px to 44px

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 03:08:53 -05:00
Andrew BeveridgeandClaude Opus 4.5 e0e35f5335 feat: improve mobile responsiveness across all UIs
- Main Frontend:
  - Stack Artist/Title inputs vertically on mobile (< 640px)
  - Improve tab button touch targets with min-height 44px
  - Make header responsive with icon-only buttons on small screens
  - Hide button text labels on mobile, show icons only

- Lyrics Review UI (Material UI):
  - Make handler panel width responsive (100% on mobile)
  - Fix button toolbar to wrap on mobile
  - Adjust heights for mobile viewports

- Instrumental Selection UI (Static HTML):
  - Add comprehensive mobile media queries
  - Stack bottom section vertically on mobile
  - Make selection panel full-width on mobile
  - Increase touch targets to 44px minimum
  - Allow scrolling on mobile viewports

- Testing:
  - Add mobile device projects to Playwright config (Pixel 7, iPhone 14)
  - Create comprehensive mobile responsiveness test suite
  - Test no horizontal overflow, touch targets, form usability

- Documentation:
  - Add MOBILE-UX-BEST-PRACTICES.md with patterns and guidelines

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 03:08:05 -05:00
Andrew Beveridge ☄️ 79be51c95d Merge pull request #89 from nomadkaraoke/refactor/documentation-restructure
docs: Restructure documentation for LLM agent clarity
2025-12-28 03:00:33 -05:00
Andrew Beveridge e709e0ddaf Merge remote-tracking branch 'origin/main' into feature/agentic-playwright-tests-docs 2025-12-26 13:32:40 -05:00
Andrew BeveridgeandClaude Opus 4.5 b7324e5aa9 Add agentic correction Playwright E2E tests and update docs
- Add Playwright E2E tests for agentic correction workflow
  - Test UI component loading (read-only banner, load file button)
  - Test file upload flow with mock correction data
  - Test fixture with agentic correction categories
  - ESM module fix for __dirname in test files
- Create comprehensive AGENTIC_CORRECTION_GUIDE.md user documentation
- Update AGENTIC_IMPLEMENTATION_STATUS.md to reflect current state
- Remove outdated AGENTIC_NEXT_STEPS.md (steps completed)
- Add test-results/ to frontend .gitignore
- Add test scripts to frontend package.json

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-26 01:39:16 -05:00
84 changed files with 8959 additions and 2052 deletions

No files matched your search

+109
View File
@@ -0,0 +1,109 @@
---
description: Review and address CodeRabbit comments on current PR
allowed-tools: Read, Glob, Grep, Edit, Write, Bash, mcp__github__pull_request_read, mcp__github__get_me, mcp__github__list_pull_requests, mcp__github__add_issue_comment
---
# CodeRabbit Comment Review
You are reviewing the current PR to address all CodeRabbit automated review comments.
## Your Task
### 1. Identify the Current PR
First, determine the current branch and find the associated PR:
```bash
git branch --show-current
```
Then use GitHub tools to find the PR for this branch in the `nomadkaraoke/karaoke-gen` repository.
### 2. Fetch CodeRabbit Comments
Get all review comments and regular comments on the PR:
**Review Comments (Potential Issues)**
- Use `pull_request_read` with `method: "get_review_comments"` to get all review comment threads
- Look for comments from the `coderabbitai` bot user
- These are typically marked as "Potential issue" and MUST be resolved before merge
**PR Comments (Including Nitpicks)**
- Use `pull_request_read` with `method: "get_comments"` to get regular PR comments
- CodeRabbit posts a summary comment that includes "Nitpick comments" section
- These should also be reviewed and considered for action
### 3. Analyze Each Comment
For each CodeRabbit comment:
1. Read the comment carefully to understand the concern
2. Look at the referenced code location
3. Decide if a code change is warranted:
- **Make changes** for: valid bugs, security issues, clear improvements, style violations
- **Skip changes** for: subjective preferences, false positives, already addressed, not applicable
4. If skipping, note the reason
### 4. Make Code Changes
For each comment requiring action:
1. Navigate to the file and line mentioned
2. Understand the surrounding context
3. Make the minimal change needed to address the concern
4. Verify the change doesn't break anything obvious
### 5. Commit and Push
After making all changes:
```bash
# Stage all changes
git add -A
# Commit with descriptive message
git commit -m "fix: address CodeRabbit review comments
- [list each fix briefly]
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>"
# Push to the PR branch
git push
```
### 6. Resolve Threads
After pushing:
- Reply to each CodeRabbit review thread indicating what was done
- If a comment was addressed, reply with what was changed
- If a comment was intentionally skipped, explain why
- This helps mark threads as resolved so the PR can be merged
## Output Format
Provide a summary report:
```
## CodeRabbit Review Summary
### Comments Addressed
- [ ] File:line - Brief description of issue → What was changed
### Comments Skipped (with reason)
- [ ] File:line - Issue → Reason for skipping
### Actions Taken
- Committed: [commit hash]
- Pushed to: [branch name]
- Threads replied to: [count]
### Status
Ready for merge: Yes/No (if No, explain why)
```
## Guidelines
- Focus on code quality improvements, not just making CodeRabbit happy
- Don't blindly accept every suggestion - use judgment
- Group related fixes into logical commits if needed
- Keep changes minimal and focused on the specific issues raised
- If a suggestion would require significant refactoring, note it for future work instead
+1
View File
@@ -29,6 +29,7 @@ You are reviewing this chat session to identify documentation updates needed bef
## Guidelines
- **IMPORTANT**: Make all documentation changes on the current feature branch (git worktree), NOT on main. Check `git branch` or the worktree path to ensure you're editing files in the correct location.
- Keep updates concise and factual
- Focus on information useful for future AI agents
- Don't duplicate information that's in the code
+15 -124
View File
@@ -128,7 +128,7 @@ jobs:
package-unit-tests:
name: "Package - Unit Tests (70% coverage)"
runs-on: ubuntu-latest
runs-on: [self-hosted, linux, gcp]
needs: changes
if: github.ref != 'refs/heads/main' && (needs.changes.outputs.package == 'true' || needs.changes.outputs.deps == 'true')
steps:
@@ -186,7 +186,7 @@ jobs:
package-integration-tests:
name: "Package - Integration Tests"
runs-on: ubuntu-latest
runs-on: [self-hosted, linux, gcp]
needs: changes
if: github.ref != 'refs/heads/main' && (needs.changes.outputs.package == 'true' || needs.changes.outputs.deps == 'true')
steps:
@@ -235,7 +235,7 @@ jobs:
package-build-test:
name: "Package - Build & Install (Test)"
runs-on: ubuntu-latest
runs-on: [self-hosted, linux, gcp]
needs: [changes, package-unit-tests, package-integration-tests]
if: >-
github.ref != 'refs/heads/main' && always() &&
@@ -258,28 +258,9 @@ jobs:
virtualenvs-create: true
virtualenvs-in-project: true
- name: Cache Poetry dependencies
uses: actions/cache@v4
with:
path: .venv
key: venv-package-${{ runner.os }}-py3.13-${{ hashFiles('poetry.lock') }}
restore-keys: |
venv-package-${{ runner.os }}-py3.13-
- name: Build package
run: poetry build
- name: Free disk space
uses: jlumbroso/free-disk-space@main
with:
tool-cache: false
android: true
haskell: true
dotnet: false
large-packages: false
docker-images: false
swap-storage: false
- name: Test package installation
run: |
pip install dist/*.whl
@@ -291,17 +272,10 @@ jobs:
backend-unit-tests:
name: "Backend - Unit Tests"
runs-on: ubuntu-latest
runs-on: [self-hosted, linux, gcp]
needs: changes
if: github.ref != 'refs/heads/main' && (needs.changes.outputs.backend == 'true' || needs.changes.outputs.package == 'true' || needs.changes.outputs.deps == 'true')
steps:
- name: Free disk space
run: |
sudo rm -rf /usr/share/dotnet
sudo rm -rf /opt/ghc
sudo rm -rf /usr/local/share/boost
df -h
- name: Checkout code
uses: actions/checkout@v4
with:
@@ -318,14 +292,6 @@ jobs:
virtualenvs-create: true
virtualenvs-in-project: true
- name: Cache Poetry dependencies
uses: actions/cache@v4
with:
path: .venv
key: venv-backend-${{ runner.os }}-py3.13-${{ hashFiles('poetry.lock') }}
restore-keys: |
venv-backend-${{ runner.os }}-py3.13-
- name: Install dependencies
run: poetry install
@@ -343,21 +309,10 @@ jobs:
backend-emulator-tests:
name: "Backend - Emulator Integration Tests"
runs-on: ubuntu-latest
runs-on: [self-hosted, linux, gcp]
needs: changes
if: github.ref != 'refs/heads/main' && (needs.changes.outputs.backend == 'true' || needs.changes.outputs.package == 'true' || needs.changes.outputs.deps == 'true')
steps:
- name: Free disk space
uses: jlumbroso/free-disk-space@main
with:
tool-cache: false
android: true
haskell: true
dotnet: true
large-packages: false
docker-images: false
swap-storage: false
- name: Checkout code
uses: actions/checkout@v4
with:
@@ -374,28 +329,12 @@ jobs:
virtualenvs-create: true
virtualenvs-in-project: true
- name: Cache Poetry dependencies
uses: actions/cache@v4
with:
path: .venv
key: venv-backend-${{ runner.os }}-py3.13-${{ hashFiles('poetry.lock') }}
restore-keys: |
venv-backend-${{ runner.os }}-py3.13-
- name: Set up Java 21 (required by Firestore emulator)
uses: actions/setup-java@v4
with:
distribution: "temurin"
java-version: "21"
- name: Set up Cloud SDK
uses: google-github-actions/setup-gcloud@v2
with:
version: "latest"
- name: Install Firestore emulator
run: gcloud components install beta cloud-firestore-emulator --quiet
- name: Install dependencies
run: poetry install
@@ -417,7 +356,7 @@ jobs:
backend-lint:
name: "Backend - Code Quality"
runs-on: ubuntu-latest
runs-on: [self-hosted, linux, gcp]
needs: changes
if: github.ref != 'refs/heads/main' && (needs.changes.outputs.backend == 'true' || needs.changes.outputs.package == 'true')
steps:
@@ -490,7 +429,7 @@ jobs:
package-build:
name: "Package - Build"
runs-on: ubuntu-latest
runs-on: [self-hosted, linux, gcp]
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
steps:
- uses: actions/checkout@v4
@@ -687,7 +626,7 @@ jobs:
deploy-backend:
name: "Deploy - Backend (Cloud Run)"
runs-on: ubuntu-latest
runs-on: [self-hosted, linux, gcp]
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
permissions:
contents: read
@@ -699,17 +638,12 @@ jobs:
BASE_IMAGE_NAME: karaoke-backend-base
APP_IMAGE_NAME: karaoke-backend
steps:
# ============================================
# Check if deployment is needed FIRST
# This avoids wasting 3+ mins on disk cleanup when skipping
# ============================================
- name: Checkout code
uses: actions/checkout@v4
with:
submodules: false
fetch-depth: 0 # Need full history for tag check
- name: Set up Python (for version extraction)
- name: Set up Python 3.13
uses: actions/setup-python@v5
with:
python-version: "3.13"
@@ -717,40 +651,15 @@ jobs:
- name: Install Poetry
uses: snok/install-poetry@v1
- name: Extract version and check if deployment needed
- name: Extract version
id: version_check
run: |
VERSION=$(poetry version --short)
echo "version=$VERSION" >> $GITHUB_OUTPUT
echo "📋 Current version: $VERSION"
if git ls-remote --tags origin | grep -q "refs/tags/v$VERSION$"; then
echo "needs_deploy=false" >> $GITHUB_OUTPUT
echo "⏭️ Tag v$VERSION already exists - skipping backend deployment"
echo " (Bump version in pyproject.toml to trigger a new deployment)"
else
echo "needs_deploy=true" >> $GITHUB_OUTPUT
echo "✨ Tag v$VERSION does not exist - proceeding with deployment"
fi
# ============================================
# Free disk space only if deploying
# This prevents "No space left on device" errors during Docker build
# ============================================
- name: Free disk space (aggressive)
if: steps.version_check.outputs.needs_deploy == 'true'
uses: jlumbroso/free-disk-space@main
with:
tool-cache: true
android: true
haskell: true
dotnet: true
large-packages: true
docker-images: true
swap-storage: true
echo "🚀 Deploying on every push to main"
- name: Authenticate to Google Cloud (Workload Identity)
if: steps.version_check.outputs.needs_deploy == 'true'
id: auth
uses: google-github-actions/auth@v2
with:
@@ -758,13 +667,11 @@ jobs:
service_account: ${{ secrets.GCP_SERVICE_ACCOUNT }}
- name: Set up Cloud SDK
if: steps.version_check.outputs.needs_deploy == 'true'
uses: google-github-actions/setup-gcloud@v2
with:
version: "latest"
- name: Configure Docker for Artifact Registry
if: steps.version_check.outputs.needs_deploy == 'true'
run: gcloud auth configure-docker ${{ env.REGISTRY }} --quiet
# ============================================
@@ -774,11 +681,9 @@ jobs:
# ============================================
- name: Set up Docker Buildx
if: steps.version_check.outputs.needs_deploy == 'true'
uses: docker/setup-buildx-action@v3
- name: Calculate base image hash
if: steps.version_check.outputs.needs_deploy == 'true'
id: base-hash
run: |
# Hash both poetry.lock AND Dockerfile.base - rebuild if either changes
@@ -787,7 +692,6 @@ jobs:
echo "📋 Base content hash: $CURRENT_HASH"
- name: Check if base image exists and is current
if: steps.version_check.outputs.needs_deploy == 'true'
id: check-base
run: |
BASE_IMAGE="${{ env.REGISTRY }}/${{ env.PROJECT_ID }}/${{ env.REPOSITORY }}/${{ env.BASE_IMAGE_NAME }}:latest"
@@ -814,7 +718,7 @@ jobs:
fi
- name: Build and push base image (if needed)
if: steps.version_check.outputs.needs_deploy == 'true' && steps.check-base.outputs.needs_rebuild == 'true'
if: steps.check-base.outputs.needs_rebuild == 'true'
uses: docker/build-push-action@v6
with:
context: .
@@ -835,7 +739,6 @@ jobs:
provenance: false
- name: Build and push app image
if: steps.version_check.outputs.needs_deploy == 'true'
uses: docker/build-push-action@v6
with:
context: .
@@ -856,7 +759,6 @@ jobs:
# ============================================
- name: Deploy to Cloud Run
if: steps.version_check.outputs.needs_deploy == 'true'
run: |
VERSION="${{ steps.version_check.outputs.version }}"
IMAGE="${{ env.REGISTRY }}/${{ env.PROJECT_ID }}/${{ env.REPOSITORY }}/${{ env.APP_IMAGE_NAME }}:${{ github.sha }}"
@@ -882,7 +784,6 @@ jobs:
--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"
- name: Verify deployment and version
if: steps.version_check.outputs.needs_deploy == 'true'
run: |
EXPECTED_VERSION="${{ steps.version_check.outputs.version }}"
SERVICE_URL=$(gcloud run services describe karaoke-backend \
@@ -923,7 +824,7 @@ jobs:
done
- name: Summary
if: steps.version_check.outputs.needs_deploy == 'true' && success()
if: success()
run: |
echo "🎉 Deployment successful!"
echo "Version: ${{ steps.version_check.outputs.version }}"
@@ -931,15 +832,5 @@ jobs:
echo "Branch: ${{ github.ref_name }}"
echo "Run: ${{ github.run_number }}"
echo ""
echo "📊 Cost savings: This build used FREE GitHub Actions instead of Cloud Build"
echo " Previously: ~\$0.064/min with N1_HIGHCPU_32"
echo " Now: \$0 (public repo) with registry-cached builds"
- name: Skipped deployment summary
if: steps.version_check.outputs.needs_deploy == 'false'
run: |
echo "⏭️ Backend deployment skipped - version ${{ steps.version_check.outputs.version }} already deployed"
echo ""
echo "To deploy a new version:"
echo " 1. Update version in pyproject.toml"
echo " 2. Commit and push to main"
echo "📊 Built on self-hosted GCP runner (200GB SSD, no disk space issues)"
echo " Runner: gcp-runner with 4 vCPU, 16GB RAM"
+3 -1
View File
@@ -47,6 +47,7 @@ frontend/coverage/
frontend/test-results/
frontend/playwright-report/
frontend/playwright/.cache/
frontend/e2e/screenshots/
# TypeScript
frontend/*.tsbuildinfo
@@ -82,8 +83,9 @@ eggs/
# Python lib directories (not frontend)
lib/
lib64/
# But allow frontend lib
# But allow frontend lib directories
!frontend/lib/
!buy-site/lib/
parts/
sdist/
var/
+3 -3
View File
@@ -76,7 +76,7 @@ Run Whisper directly on your local machine using whisper-timestamped. Works on C
```bash
# Install with local Whisper support
pip install karaoke-gen[local-whisper]
pip install "karaoke-gen[local-whisper]"
# Optional: Configure model size (tiny, base, small, medium, large)
export WHISPER_MODEL_SIZE="medium"
@@ -98,7 +98,7 @@ export WHISPER_DEVICE="cpu"
```bash
# Pre-install CPU-only PyTorch first
pip install torch torchaudio --index-url https://download.pytorch.org/whl/cpu
pip install karaoke-gen[local-whisper]
pip install "karaoke-gen[local-whisper]"
```
Local Whisper runs automatically as a fallback when no cloud transcription services are configured.
@@ -633,7 +633,7 @@ Whisper models are downloaded on first use (~1-3GB depending on size). If downlo
#### whisper-timestamped Not Found
If you get "whisper-timestamped is not installed":
```bash
pip install karaoke-gen[local-whisper]
pip install "karaoke-gen[local-whisper]"
# Or install directly:
pip install whisper-timestamped
```
+212 -101
View File
@@ -15,6 +15,7 @@ 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
@@ -275,6 +276,46 @@ def _resolve_cdg_txt_defaults(
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,
@@ -341,9 +382,12 @@ async def upload_and_create_job(
style_cdg_instrumental_background: Optional[UploadFile] = File(None, description="CDG instrumental background"),
style_cdg_title_background: Optional[UploadFile] = File(None, description="CDG title screen background"),
style_cdg_outro_background: Optional[UploadFile] = File(None, description="CDG outro screen background"),
# Processing options (CDG/TXT require style config, disabled by default)
enable_cdg: bool = Form(False, description="Generate CDG+MP3 package (requires style config)"),
enable_txt: bool = Form(False, description="Generate TXT+MP3 package (requires style config)"),
# Theme configuration (use pre-made theme from GCS)
theme_id: Optional[str] = Form(None, description="Theme ID to use (e.g., 'nomad', 'default'). If set, CDG/TXT are enabled by default."),
color_overrides: Optional[str] = Form(None, description="JSON-encoded color overrides: artist_color, title_color, sung_lyrics_color, unsung_lyrics_color (hex #RRGGBB)"),
# Processing options (CDG/TXT require style config or theme, disabled by default unless theme is set)
enable_cdg: Optional[bool] = Form(None, description="Generate CDG+MP3 package. Default: True if theme_id set, False otherwise"),
enable_txt: Optional[bool] = Form(None, description="Generate TXT+MP3 package. Default: True if theme_id set, False otherwise"),
# Finalisation options
brand_prefix: Optional[str] = Form(None, description="Brand code prefix (e.g., NOMAD)"),
enable_youtube_upload: bool = Form(False, description="Upload to YouTube"),
@@ -432,38 +476,42 @@ async def upload_and_create_job(
)
# Apply default distribution settings from environment if not provided
settings = get_settings()
effective_dropbox_path = dropbox_path or settings.default_dropbox_path
effective_gdrive_folder_id = gdrive_folder_id or settings.default_gdrive_folder_id
effective_discord_webhook_url = discord_webhook_url or settings.default_discord_webhook_url
if effective_dropbox_path and not dropbox_path:
logger.info(f"Using default dropbox_path: {effective_dropbox_path}")
if effective_gdrive_folder_id and not gdrive_folder_id:
logger.info(f"Using default gdrive_folder_id: {effective_gdrive_folder_id}")
if effective_discord_webhook_url and not discord_webhook_url:
dist = _get_effective_distribution_settings(
dropbox_path=dropbox_path,
gdrive_folder_id=gdrive_folder_id,
discord_webhook_url=discord_webhook_url,
brand_prefix=brand_prefix,
)
if dist.dropbox_path and not dropbox_path:
logger.info(f"Using default dropbox_path: {dist.dropbox_path}")
if dist.gdrive_folder_id and not gdrive_folder_id:
logger.info(f"Using default gdrive_folder_id: {dist.gdrive_folder_id}")
if dist.discord_webhook_url and not discord_webhook_url:
logger.info("Using default discord_webhook_url (from env)")
if dist.brand_prefix and not brand_prefix:
logger.info(f"Using default brand_prefix: {dist.brand_prefix}")
# Validate credentials for requested distribution services (including defaults)
# This prevents accepting jobs that will fail later due to missing credentials
invalid_services = []
credential_manager = get_credential_manager()
if enable_youtube_upload:
result = credential_manager.check_youtube_credentials()
if result.status != CredentialStatus.VALID:
invalid_services.append(f"youtube ({result.message})")
if effective_dropbox_path:
if dist.dropbox_path:
result = credential_manager.check_dropbox_credentials()
if result.status != CredentialStatus.VALID:
invalid_services.append(f"dropbox ({result.message})")
if effective_gdrive_folder_id:
if dist.gdrive_folder_id:
result = credential_manager.check_gdrive_credentials()
if result.status != CredentialStatus.VALID:
invalid_services.append(f"gdrive ({result.message})")
if invalid_services:
raise HTTPException(
status_code=400,
@@ -477,7 +525,35 @@ async def upload_and_create_job(
# Extract request metadata for tracking and filtering
request_metadata = extract_request_metadata(request, created_from="upload")
# Parse color_overrides from JSON if provided
parsed_color_overrides: Dict[str, str] = {}
if color_overrides:
try:
parsed_color_overrides = json.loads(color_overrides)
except json.JSONDecodeError as e:
raise HTTPException(
status_code=400,
detail=f"Invalid color_overrides JSON: {e}"
)
# Resolve CDG/TXT defaults based on theme
resolved_cdg, resolved_txt = _resolve_cdg_txt_defaults(
theme_id, enable_cdg, enable_txt
)
# Check if any custom style files are being uploaded (overrides theme)
has_custom_style_files = any([
style_params,
style_intro_background,
style_karaoke_background,
style_end_background,
style_font,
style_cdg_instrumental_background,
style_cdg_title_background,
style_cdg_outro_background,
])
# Parse comma-separated model lists into arrays
parsed_backing_vocals_models = None
if backing_vocals_models:
@@ -492,17 +568,19 @@ async def upload_and_create_job(
artist=artist,
title=title,
filename=file.filename,
enable_cdg=enable_cdg,
enable_txt=enable_txt,
brand_prefix=brand_prefix,
theme_id=theme_id,
color_overrides=parsed_color_overrides,
enable_cdg=resolved_cdg,
enable_txt=resolved_txt,
brand_prefix=dist.brand_prefix,
enable_youtube_upload=enable_youtube_upload,
youtube_description=youtube_description,
discord_webhook_url=effective_discord_webhook_url,
discord_webhook_url=dist.discord_webhook_url,
webhook_url=webhook_url,
user_email=user_email,
# Native API distribution (preferred for remote CLI)
dropbox_path=effective_dropbox_path,
gdrive_folder_id=effective_gdrive_folder_id,
dropbox_path=dist.dropbox_path,
gdrive_folder_id=dist.gdrive_folder_id,
# Legacy rclone distribution (deprecated)
organised_dir_rclone_root=organised_dir_rclone_root,
# Lyrics configuration (overrides for search/transcription)
@@ -521,9 +599,27 @@ async def upload_and_create_job(
# Record job creation metric
metrics.record_job_created(job_id, source="upload")
logger.info(f"Created job {job_id} for {artist} - {title}")
# If theme is set and no custom style files are being uploaded, prepare theme style now
# This copies the theme's style_params.json to the job folder so LyricsTranscriber
# can access the style configuration for preview videos
theme_style_params_path = None
theme_style_assets = {}
theme_youtube_desc = None
if theme_id and not has_custom_style_files:
try:
theme_style_params_path, theme_style_assets, theme_youtube_desc = _prepare_theme_for_job(
job_id, theme_id, parsed_color_overrides or None
)
logger.info(f"Applied theme '{theme_id}' to job {job_id}")
except HTTPException:
raise # Re-raise validation errors (e.g., theme not found)
except Exception as e:
logger.warning(f"Failed to prepare theme '{theme_id}' for job {job_id}: {e}")
# Continue without theme - job can still be processed with defaults
# Upload main audio file to GCS
audio_gcs_path = f"uploads/{job_id}/audio/{file.filename}"
logger.info(f"Uploading audio to GCS: {audio_gcs_path}")
@@ -592,27 +688,36 @@ async def upload_and_create_job(
update_data = {
'input_media_gcs_path': audio_gcs_path,
'filename': file.filename,
'enable_cdg': enable_cdg,
'enable_txt': enable_txt,
'enable_cdg': resolved_cdg,
'enable_txt': resolved_txt,
}
# Handle style assets - either from custom uploads or from theme
if style_assets:
# Custom style files uploaded
update_data['style_assets'] = style_assets
if 'style_params' in style_assets:
update_data['style_params_gcs_path'] = style_assets['style_params']
if brand_prefix:
update_data['brand_prefix'] = brand_prefix
if effective_discord_webhook_url:
update_data['discord_webhook_url'] = effective_discord_webhook_url
if youtube_description:
update_data['youtube_description_template'] = youtube_description
elif theme_style_assets:
# Theme style assets (no custom uploads)
update_data['style_assets'] = theme_style_assets
if theme_style_params_path:
update_data['style_params_gcs_path'] = theme_style_params_path
if dist.brand_prefix:
update_data['brand_prefix'] = dist.brand_prefix
if dist.discord_webhook_url:
update_data['discord_webhook_url'] = dist.discord_webhook_url
# Use theme YouTube description if no custom one provided
effective_youtube_description = youtube_description or theme_youtube_desc
if effective_youtube_description:
update_data['youtube_description_template'] = effective_youtube_description
# Native API distribution (use effective values which include defaults)
if effective_dropbox_path:
update_data['dropbox_path'] = effective_dropbox_path
if effective_gdrive_folder_id:
update_data['gdrive_folder_id'] = effective_gdrive_folder_id
if dist.dropbox_path:
update_data['dropbox_path'] = dist.dropbox_path
if dist.gdrive_folder_id:
update_data['gdrive_folder_id'] = dist.gdrive_folder_id
# Legacy rclone distribution (deprecated)
if organised_dir_rclone_root:
@@ -668,21 +773,21 @@ async def upload_and_create_job(
# Build distribution services info for response
distribution_services: Dict[str, Any] = {}
if effective_dropbox_path:
if dist.dropbox_path:
dropbox_result = credential_manager.check_dropbox_credentials()
distribution_services["dropbox"] = {
"enabled": True,
"path": effective_dropbox_path,
"path": dist.dropbox_path,
"credentials_valid": dropbox_result.status == CredentialStatus.VALID,
"using_default": dropbox_path is None,
}
if effective_gdrive_folder_id:
if dist.gdrive_folder_id:
gdrive_result = credential_manager.check_gdrive_credentials()
distribution_services["gdrive"] = {
"enabled": True,
"folder_id": effective_gdrive_folder_id,
"folder_id": dist.gdrive_folder_id,
"credentials_valid": gdrive_result.status == CredentialStatus.VALID,
"using_default": gdrive_folder_id is None,
}
@@ -694,7 +799,7 @@ async def upload_and_create_job(
"credentials_valid": youtube_result.status == CredentialStatus.VALID,
}
if effective_discord_webhook_url:
if dist.discord_webhook_url:
distribution_services["discord"] = {
"enabled": True,
"using_default": discord_webhook_url is None,
@@ -911,32 +1016,34 @@ async def create_job_with_upload_urls(
status_code=400,
detail=f"Invalid file extension '{ext}' for file_type '{file_info.file_type}'. Allowed: {allowed_extensions}"
)
# Apply default distribution settings from environment if not provided
settings = get_settings()
effective_dropbox_path = body.dropbox_path or settings.default_dropbox_path
effective_gdrive_folder_id = body.gdrive_folder_id or settings.default_gdrive_folder_id
effective_discord_webhook_url = body.discord_webhook_url or settings.default_discord_webhook_url
dist = _get_effective_distribution_settings(
dropbox_path=body.dropbox_path,
gdrive_folder_id=body.gdrive_folder_id,
discord_webhook_url=body.discord_webhook_url,
brand_prefix=body.brand_prefix,
)
# Validate credentials for requested distribution services
invalid_services = []
credential_manager = get_credential_manager()
if body.enable_youtube_upload:
result = credential_manager.check_youtube_credentials()
if result.status != CredentialStatus.VALID:
invalid_services.append(f"youtube ({result.message})")
if effective_dropbox_path:
if dist.dropbox_path:
result = credential_manager.check_dropbox_credentials()
if result.status != CredentialStatus.VALID:
invalid_services.append(f"dropbox ({result.message})")
if effective_gdrive_folder_id:
if dist.gdrive_folder_id:
result = credential_manager.check_gdrive_credentials()
if result.status != CredentialStatus.VALID:
invalid_services.append(f"gdrive ({result.message})")
if invalid_services:
raise HTTPException(
status_code=400,
@@ -947,7 +1054,7 @@ async def create_job_with_upload_urls(
"auth_url": "/api/auth/status"
}
)
# Extract request metadata for tracking
request_metadata = extract_request_metadata(request, created_from="signed_url_upload")
@@ -971,14 +1078,14 @@ async def create_job_with_upload_urls(
color_overrides=body.color_overrides or {},
enable_cdg=resolved_cdg,
enable_txt=resolved_txt,
brand_prefix=body.brand_prefix,
brand_prefix=dist.brand_prefix,
enable_youtube_upload=body.enable_youtube_upload,
youtube_description=body.youtube_description,
discord_webhook_url=effective_discord_webhook_url,
discord_webhook_url=dist.discord_webhook_url,
webhook_url=body.webhook_url,
user_email=body.user_email,
dropbox_path=effective_dropbox_path,
gdrive_folder_id=effective_gdrive_folder_id,
dropbox_path=dist.dropbox_path,
gdrive_folder_id=dist.gdrive_folder_id,
organised_dir_rclone_root=body.organised_dir_rclone_root,
lyrics_artist=body.lyrics_artist,
lyrics_title=body.lyrics_title,
@@ -1322,32 +1429,34 @@ async def create_job_from_url(
status_code=400,
detail="Invalid URL. Please provide a valid YouTube, Vimeo, SoundCloud, or other supported video URL."
)
# Apply default distribution settings from environment if not provided
settings = get_settings()
effective_dropbox_path = body.dropbox_path or settings.default_dropbox_path
effective_gdrive_folder_id = body.gdrive_folder_id or settings.default_gdrive_folder_id
effective_discord_webhook_url = body.discord_webhook_url or settings.default_discord_webhook_url
dist = _get_effective_distribution_settings(
dropbox_path=body.dropbox_path,
gdrive_folder_id=body.gdrive_folder_id,
discord_webhook_url=body.discord_webhook_url,
brand_prefix=body.brand_prefix,
)
# Validate credentials for requested distribution services
invalid_services = []
credential_manager = get_credential_manager()
if body.enable_youtube_upload:
result = credential_manager.check_youtube_credentials()
if result.status != CredentialStatus.VALID:
invalid_services.append(f"youtube ({result.message})")
if effective_dropbox_path:
if dist.dropbox_path:
result = credential_manager.check_dropbox_credentials()
if result.status != CredentialStatus.VALID:
invalid_services.append(f"dropbox ({result.message})")
if effective_gdrive_folder_id:
if dist.gdrive_folder_id:
result = credential_manager.check_gdrive_credentials()
if result.status != CredentialStatus.VALID:
invalid_services.append(f"gdrive ({result.message})")
if invalid_services:
raise HTTPException(
status_code=400,
@@ -1358,7 +1467,7 @@ async def create_job_from_url(
"auth_url": "/api/auth/status"
}
)
# Extract request metadata for tracking
request_metadata = extract_request_metadata(request, created_from="url")
@@ -1381,14 +1490,14 @@ async def create_job_from_url(
color_overrides=body.color_overrides or {},
enable_cdg=resolved_cdg,
enable_txt=resolved_txt,
brand_prefix=body.brand_prefix,
brand_prefix=dist.brand_prefix,
enable_youtube_upload=body.enable_youtube_upload,
youtube_description=body.youtube_description,
discord_webhook_url=effective_discord_webhook_url,
discord_webhook_url=dist.discord_webhook_url,
webhook_url=body.webhook_url,
user_email=body.user_email,
dropbox_path=effective_dropbox_path,
gdrive_folder_id=effective_gdrive_folder_id,
dropbox_path=dist.dropbox_path,
gdrive_folder_id=dist.gdrive_folder_id,
organised_dir_rclone_root=body.organised_dir_rclone_root,
lyrics_artist=body.lyrics_artist,
lyrics_title=body.lyrics_title,
@@ -1563,30 +1672,32 @@ async def create_finalise_only_job(
)
# Apply default distribution settings
settings = get_settings()
effective_dropbox_path = body.dropbox_path or settings.default_dropbox_path
effective_gdrive_folder_id = body.gdrive_folder_id or settings.default_gdrive_folder_id
effective_discord_webhook_url = body.discord_webhook_url or settings.default_discord_webhook_url
dist = _get_effective_distribution_settings(
dropbox_path=body.dropbox_path,
gdrive_folder_id=body.gdrive_folder_id,
discord_webhook_url=body.discord_webhook_url,
brand_prefix=body.brand_prefix,
)
# Validate distribution credentials if services are requested
invalid_services = []
credential_manager = get_credential_manager()
if body.enable_youtube_upload:
result = credential_manager.check_youtube_credentials()
if result.status != CredentialStatus.VALID:
invalid_services.append(f"youtube ({result.message})")
if effective_dropbox_path:
if dist.dropbox_path:
result = credential_manager.check_dropbox_credentials()
if result.status != CredentialStatus.VALID:
invalid_services.append(f"dropbox ({result.message})")
if effective_gdrive_folder_id:
if dist.gdrive_folder_id:
result = credential_manager.check_gdrive_credentials()
if result.status != CredentialStatus.VALID:
invalid_services.append(f"gdrive ({result.message})")
if invalid_services:
raise HTTPException(
status_code=400,
@@ -1597,7 +1708,7 @@ async def create_finalise_only_job(
"auth_url": "/api/auth/status"
}
)
# Extract request metadata
request_metadata = extract_request_metadata(request, created_from="finalise_only_upload")
@@ -1618,12 +1729,12 @@ async def create_finalise_only_job(
color_overrides=body.color_overrides or {},
enable_cdg=resolved_cdg,
enable_txt=resolved_txt,
brand_prefix=body.brand_prefix,
brand_prefix=dist.brand_prefix,
enable_youtube_upload=body.enable_youtube_upload,
youtube_description=body.youtube_description,
discord_webhook_url=effective_discord_webhook_url,
dropbox_path=effective_dropbox_path,
gdrive_folder_id=effective_gdrive_folder_id,
discord_webhook_url=dist.discord_webhook_url,
dropbox_path=dist.dropbox_path,
gdrive_folder_id=dist.gdrive_folder_id,
finalise_only=True,
keep_brand_code=body.keep_brand_code,
request_metadata=request_metadata,
+819
View File
@@ -0,0 +1,819 @@
"""
User and authentication API routes.
Handles:
- Magic link authentication (send, verify)
- Session management (logout)
- User profile and credits
- Stripe checkout and webhooks
- Admin user management
"""
import logging
from typing import Optional, Tuple
from fastapi import APIRouter, HTTPException, Depends, Request, Header
from pydantic import BaseModel, EmailStr
from backend.models.user import (
UserRole,
UserPublic,
SendMagicLinkRequest,
SendMagicLinkResponse,
VerifyMagicLinkResponse,
AddCreditsRequest,
AddCreditsResponse,
UserListResponse,
BetaTesterStatus,
BetaTesterEnrollRequest,
BetaTesterEnrollResponse,
BetaFeedbackRequest,
BetaFeedbackResponse,
BetaTesterFeedback,
)
from backend.services.user_service import get_user_service, UserService
from backend.services.email_service import get_email_service, EmailService
from backend.services.stripe_service import get_stripe_service, StripeService, CREDIT_PACKAGES
from backend.api.dependencies import require_admin
from backend.services.auth_service import UserType
logger = logging.getLogger(__name__)
router = APIRouter(prefix="/users", tags=["users"])
# =============================================================================
# Request/Response Models
# =============================================================================
class CreateCheckoutRequest(BaseModel):
"""Request to create a Stripe checkout session."""
package_id: str
email: EmailStr
class CreateCheckoutResponse(BaseModel):
"""Response with checkout URL."""
status: str
checkout_url: str
message: str
class CreditPackage(BaseModel):
"""Credit package information."""
id: str
credits: int
price_cents: int
name: str
description: str
class CreditPackagesResponse(BaseModel):
"""Response listing available credit packages."""
packages: list[CreditPackage]
class UserProfileResponse(BaseModel):
"""Response with user profile."""
user: UserPublic
has_session: bool
class LogoutResponse(BaseModel):
"""Response after logout."""
status: str
message: str
# =============================================================================
# Magic Link Authentication
# =============================================================================
@router.post("/auth/magic-link", response_model=SendMagicLinkResponse)
async def send_magic_link(
request: SendMagicLinkRequest,
http_request: Request,
user_service: UserService = Depends(get_user_service),
email_service: EmailService = Depends(get_email_service),
):
"""
Send a magic link email for passwordless authentication.
The user will receive an email with a link that logs them in.
Links expire after 15 minutes and can only be used once.
"""
email = request.email.lower()
# 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
magic_link = user_service.create_magic_link(
email,
ip_address=ip_address,
user_agent=user_agent
)
# Send email
sent = email_service.send_magic_link(email, magic_link.token)
if not sent:
logger.error(f"Failed to send magic link email to {email}")
# Don't reveal failure to prevent email enumeration
# Still return success
return SendMagicLinkResponse(
status="success",
message="If this email is registered, you will receive a sign-in link shortly."
)
@router.get("/auth/verify", response_model=VerifyMagicLinkResponse)
async def verify_magic_link(
token: str,
http_request: Request,
user_service: UserService = Depends(get_user_service),
email_service: EmailService = Depends(get_email_service),
):
"""
Verify a magic link token and create a session.
Returns a session token that should be stored and used for subsequent requests.
"""
# 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
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
if magic_link_doc.exists:
magic_link_data = magic_link_doc.to_dict()
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
# Verify the magic link
success, user, message = user_service.verify_magic_link(token)
if not success or not user:
raise HTTPException(status_code=401, detail=message)
# Create session
session = user_service.create_session(
user.email,
ip_address=ip_address,
user_agent=user_agent
)
# Send welcome email to first-time users
if is_first_login:
email_service.send_welcome_email(user.email, user.credits)
# Return user info
user_public = UserPublic(
email=user.email,
role=user.role,
credits=user.credits,
display_name=user.display_name,
total_jobs_created=user.total_jobs_created,
total_jobs_completed=user.total_jobs_completed,
)
return VerifyMagicLinkResponse(
status="success",
session_token=session.token,
user=user_public,
message="Successfully signed in"
)
@router.post("/auth/logout", response_model=LogoutResponse)
async def logout(
authorization: Optional[str] = Header(None),
user_service: UserService = Depends(get_user_service),
):
"""
Logout and invalidate the current session.
"""
if not authorization:
return LogoutResponse(status="success", message="Already logged out")
# Extract token from "Bearer <token>"
token = authorization.replace("Bearer ", "") if authorization.startswith("Bearer ") else authorization
user_service.revoke_session(token)
return LogoutResponse(status="success", message="Successfully logged out")
# =============================================================================
# User Profile
# =============================================================================
@router.get("/me", response_model=UserProfileResponse)
async def get_current_user(
authorization: Optional[str] = Header(None),
user_service: UserService = Depends(get_user_service),
):
"""
Get the current user's profile.
Requires a valid session token.
"""
if not authorization:
raise HTTPException(status_code=401, detail="Not authenticated")
# Extract token
token = authorization.replace("Bearer ", "") if authorization.startswith("Bearer ") else authorization
# Validate session
valid, user, message = user_service.validate_session(token)
if not valid or not user:
raise HTTPException(status_code=401, detail=message)
user_public = UserPublic(
email=user.email,
role=user.role,
credits=user.credits,
display_name=user.display_name,
total_jobs_created=user.total_jobs_created,
total_jobs_completed=user.total_jobs_completed,
)
return UserProfileResponse(user=user_public, has_session=True)
# =============================================================================
# Credit Packages & Checkout
# =============================================================================
@router.get("/credits/packages", response_model=CreditPackagesResponse)
async def list_credit_packages():
"""
List available credit packages for purchase.
No authentication required - this is public information.
"""
packages = [
CreditPackage(
id=pkg_id,
credits=pkg["credits"],
price_cents=pkg["price_cents"],
name=pkg["name"],
description=pkg["description"],
)
for pkg_id, pkg in CREDIT_PACKAGES.items()
]
return CreditPackagesResponse(packages=packages)
@router.post("/credits/checkout", response_model=CreateCheckoutResponse)
async def create_checkout(
request: CreateCheckoutRequest,
stripe_service: StripeService = Depends(get_stripe_service),
):
"""
Create a Stripe checkout session for purchasing credits.
Returns a URL to redirect the user to Stripe's hosted checkout page.
No authentication required - email is provided in the request.
"""
if not stripe_service.is_configured():
raise HTTPException(status_code=503, detail="Payment processing is not available")
success, checkout_url, message = stripe_service.create_checkout_session(
package_id=request.package_id,
user_email=request.email,
)
if not success or not checkout_url:
raise HTTPException(status_code=400, detail=message)
return CreateCheckoutResponse(
status="success",
checkout_url=checkout_url,
message=message,
)
# =============================================================================
# Stripe Webhooks
# =============================================================================
@router.post("/webhooks/stripe")
async def stripe_webhook(
request: Request,
stripe_signature: str = Header(None, alias="stripe-signature"),
stripe_service: StripeService = Depends(get_stripe_service),
user_service: UserService = Depends(get_user_service),
email_service: EmailService = Depends(get_email_service),
):
"""
Handle Stripe webhook events.
This endpoint receives events from Stripe about payment status.
It verifies the webhook signature and processes the event.
"""
if not stripe_signature:
raise HTTPException(status_code=400, detail="Missing Stripe signature")
# Get raw body for signature verification
payload = await request.body()
# Verify signature
valid, event, message = stripe_service.verify_webhook_signature(payload, stripe_signature)
if not valid:
logger.warning(f"Invalid Stripe webhook signature: {message}")
raise HTTPException(status_code=400, detail=message)
# Handle the event
event_type = event.get("type")
logger.info(f"Received Stripe webhook: {event_type}")
if event_type == "checkout.session.completed":
session = event["data"]["object"]
session_id = session.get("id")
# Idempotency check: Skip if this session was already processed
if session_id and user_service.is_stripe_session_processed(session_id):
logger.info(f"Skipping already processed session: {session_id}")
return {"status": "received", "type": event_type, "note": "already_processed"}
# Process the completed checkout
success, user_email, credits, _ = stripe_service.handle_checkout_completed(session)
if success and user_email and credits > 0:
# Add credits to user account
ok, new_balance, credit_msg = user_service.add_credits(
email=user_email,
amount=credits,
reason="stripe_purchase",
stripe_session_id=session_id,
)
if ok:
# Send confirmation email
email_service.send_credits_added(user_email, credits, new_balance)
logger.info(f"Added {credits} credits to {user_email}, new balance: {new_balance}")
else:
logger.error(f"Failed to add credits: {credit_msg}")
elif event_type == "checkout.session.expired":
logger.info(f"Checkout session expired: {event['data']['object'].get('id')}")
elif event_type == "payment_intent.payment_failed":
logger.warning(f"Payment failed: {event['data']['object'].get('id')}")
# Return 200 to acknowledge receipt (Stripe will retry on non-2xx)
return {"status": "received", "type": event_type}
# =============================================================================
# Beta Tester Program
# =============================================================================
BETA_TESTER_FREE_CREDITS = 1 # Number of free credits for beta testers
@router.post("/beta/enroll", response_model=BetaTesterEnrollResponse)
async def enroll_beta_tester(
request: BetaTesterEnrollRequest,
http_request: Request,
user_service: UserService = Depends(get_user_service),
email_service: EmailService = Depends(get_email_service),
):
"""
Enroll as a beta tester to receive free karaoke credits.
Requirements:
- Accept that there may be work to review/correct lyrics
- Promise to provide feedback after using the tool
Returns free credits and optionally a session token for new users.
"""
email = request.email.lower()
# Validate acceptance
if not request.accept_corrections_work:
raise HTTPException(
status_code=400,
detail="You must accept that you may need to review/correct lyrics"
)
if len(request.promise_text.strip()) < 10:
raise HTTPException(
status_code=400,
detail="Please write a sentence confirming your promise to provide feedback"
)
# Get or create user
user = user_service.get_or_create_user(email)
# Check if already enrolled as beta tester
if user.is_beta_tester:
raise HTTPException(
status_code=400,
detail="You are already enrolled in the beta program"
)
# Get client info
ip_address = http_request.client.host if http_request.client else None
user_agent = http_request.headers.get("user-agent")
# Enroll as beta tester
from datetime import datetime
user_service.update_user(
email,
is_beta_tester=True,
beta_tester_status=BetaTesterStatus.ACTIVE.value,
beta_enrolled_at=datetime.utcnow(),
beta_promise_text=request.promise_text.strip(),
)
# Add free credits
_, new_balance, _ = user_service.add_credits(
email=email,
amount=BETA_TESTER_FREE_CREDITS,
reason="beta_tester_enrollment",
)
# 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)
# Send welcome email
email_service.send_beta_welcome_email(email, BETA_TESTER_FREE_CREDITS)
logger.info(f"Beta tester enrolled: {email}, granted {BETA_TESTER_FREE_CREDITS} credits")
return BetaTesterEnrollResponse(
status="success",
message=f"Welcome to the beta program! You have {new_balance} free credits.",
credits_granted=BETA_TESTER_FREE_CREDITS,
session_token=session.token,
)
@router.post("/beta/feedback", response_model=BetaFeedbackResponse)
async def submit_beta_feedback(
request: BetaFeedbackRequest,
authorization: Optional[str] = Header(None),
user_service: UserService = Depends(get_user_service),
):
"""
Submit feedback as a beta tester.
Requires authentication. Updates beta tester status to completed.
May grant bonus credits for detailed feedback.
"""
if not authorization:
raise HTTPException(status_code=401, detail="Authentication required")
# Extract token
token = authorization.replace("Bearer ", "") if authorization.startswith("Bearer ") else authorization
# Validate session
valid, user, message = user_service.validate_session(token)
if not valid or not user:
raise HTTPException(status_code=401, detail=message)
# Check if user is a beta tester
if not user.is_beta_tester:
raise HTTPException(
status_code=400,
detail="Only beta testers can submit feedback through this endpoint"
)
# Check if already completed feedback
if user.beta_tester_status == BetaTesterStatus.COMPLETED:
raise HTTPException(
status_code=400,
detail="You have already submitted feedback. Thank you!"
)
# Save feedback to Firestore
import uuid
feedback = BetaTesterFeedback(
id=str(uuid.uuid4()),
user_email=user.email,
job_id=request.job_id,
overall_rating=request.overall_rating,
ease_of_use_rating=request.ease_of_use_rating,
lyrics_accuracy_rating=request.lyrics_accuracy_rating,
correction_experience_rating=request.correction_experience_rating,
what_went_well=request.what_went_well,
what_could_improve=request.what_could_improve,
additional_comments=request.additional_comments,
would_recommend=request.would_recommend,
would_use_again=request.would_use_again,
submitted_via="web",
)
# Save to Firestore
user_service.db.collection("beta_feedback").document(feedback.id).set(
feedback.model_dump(mode='json')
)
# Update user status
user_service.update_user(
user.email,
beta_tester_status=BetaTesterStatus.COMPLETED.value,
)
# Calculate bonus credits for detailed feedback
bonus_credits = 0
has_detailed_feedback = (
(request.what_went_well and len(request.what_went_well) > 50) or
(request.what_could_improve and len(request.what_could_improve) > 50) or
(request.additional_comments and len(request.additional_comments) > 50)
)
if has_detailed_feedback:
# Grant bonus credit for detailed feedback
bonus_credits = 1
user_service.add_credits(
email=user.email,
amount=bonus_credits,
reason="beta_feedback_bonus",
)
logger.info(f"Beta feedback received from {user.email}, bonus: {bonus_credits}")
return BetaFeedbackResponse(
status="success",
message="Thank you for your feedback!" + (
f" You earned {bonus_credits} bonus credit for your detailed response!"
if bonus_credits > 0 else ""
),
bonus_credits=bonus_credits,
)
@router.get("/beta/feedback-form")
async def get_feedback_form_data(
authorization: Optional[str] = Header(None),
user_service: UserService = Depends(get_user_service),
):
"""
Get data needed to show the feedback form.
Returns whether the user needs to submit feedback and any job context.
"""
if not authorization:
raise HTTPException(status_code=401, detail="Authentication required")
token = authorization.replace("Bearer ", "") if authorization.startswith("Bearer ") else authorization
valid, user, message = user_service.validate_session(token)
if not valid or not user:
raise HTTPException(status_code=401, detail=message)
return {
"is_beta_tester": user.is_beta_tester,
"beta_status": user.beta_tester_status,
"needs_feedback": (
user.is_beta_tester and
user.beta_tester_status == BetaTesterStatus.PENDING_FEEDBACK.value
),
"can_submit_feedback": (
user.is_beta_tester and
user.beta_tester_status != BetaTesterStatus.COMPLETED.value
),
}
# =============================================================================
# Admin Endpoints
# =============================================================================
@router.get("/admin/users", response_model=UserListResponse)
async def list_users(
limit: int = 100,
include_inactive: bool = False,
auth_data: Tuple[str, UserType, int] = Depends(require_admin),
user_service: UserService = Depends(get_user_service),
):
"""
List all users (admin only).
"""
users = user_service.list_users(limit=limit, include_inactive=include_inactive)
users_public = [
UserPublic(
email=u.email,
role=u.role,
credits=u.credits,
display_name=u.display_name,
total_jobs_created=u.total_jobs_created,
total_jobs_completed=u.total_jobs_completed,
)
for u in users
]
return UserListResponse(users=users_public, total=len(users_public))
@router.post("/admin/credits", response_model=AddCreditsResponse)
async def add_credits_to_user(
request: AddCreditsRequest,
auth_data: Tuple[str, UserType, int] = Depends(require_admin),
user_service: UserService = Depends(get_user_service),
email_service: EmailService = Depends(get_email_service),
):
"""
Add credits to a user's account (admin only).
Use this to grant free credits to users, e.g., for beta testers or promotions.
"""
admin_token, _, _ = auth_data
# TODO: Enhance auth system to track admin email identity for better audit trails.
# Current token-based admin auth doesn't include email identity.
# For now, we log the token prefix for traceability.
admin_id = f"admin:{admin_token[:8]}..." if admin_token else "admin:unknown"
success, new_balance, message = user_service.add_credits(
email=request.email,
amount=request.amount,
reason=request.reason,
admin_email=admin_id,
)
if not success:
raise HTTPException(status_code=400, detail=message)
# Send notification email
if request.amount > 0:
email_service.send_credits_added(request.email, request.amount, new_balance)
return AddCreditsResponse(
status="success",
email=request.email,
credits_added=request.amount,
new_balance=new_balance,
message=message,
)
@router.post("/admin/users/{email}/disable")
async def disable_user(
email: str,
auth_data: Tuple[str, UserType, int] = Depends(require_admin),
user_service: UserService = Depends(get_user_service),
):
"""
Disable a user account (admin only).
"""
admin_token, _, _ = auth_data
admin_id = f"admin:{admin_token[:8]}..." if admin_token else "admin:unknown"
success = user_service.disable_user(email, admin_email=admin_id)
if not success:
raise HTTPException(status_code=404, detail="User not found")
return {"status": "success", "message": f"User {email} has been disabled"}
@router.post("/admin/users/{email}/enable")
async def enable_user(
email: str,
auth_data: Tuple[str, UserType, int] = Depends(require_admin),
user_service: UserService = Depends(get_user_service),
):
"""
Enable a user account (admin only).
"""
admin_token, _, _ = auth_data
admin_id = f"admin:{admin_token[:8]}..." if admin_token else "admin:unknown"
success = user_service.enable_user(email, admin_email=admin_id)
if not success:
raise HTTPException(status_code=404, detail="User not found")
return {"status": "success", "message": f"User {email} has been enabled"}
@router.post("/admin/users/{email}/role")
async def set_user_role(
email: str,
role: UserRole,
auth_data: Tuple[str, UserType, int] = Depends(require_admin),
user_service: UserService = Depends(get_user_service),
):
"""
Set a user's role (admin only).
"""
admin_token, _, _ = auth_data
admin_id = f"admin:{admin_token[:8]}..." if admin_token else "admin:unknown"
success = user_service.set_user_role(email, role, admin_email=admin_id)
if not success:
raise HTTPException(status_code=404, detail="User not found")
return {"status": "success", "message": f"User {email} role set to {role.value}"}
@router.get("/admin/beta/feedback")
async def list_beta_feedback(
limit: int = 50,
auth_data: Tuple[str, UserType, int] = Depends(require_admin),
user_service: UserService = Depends(get_user_service),
):
"""
List all beta tester feedback (admin only).
"""
from google.cloud import firestore
query = user_service.db.collection("beta_feedback")
query = query.order_by("created_at", direction=firestore.Query.DESCENDING)
query = query.limit(limit)
docs = query.stream()
feedback_list = [doc.to_dict() for doc in docs]
return {
"feedback": feedback_list,
"total": len(feedback_list),
}
@router.get("/admin/beta/stats")
async def get_beta_stats(
auth_data: Tuple[str, UserType, int] = Depends(require_admin),
user_service: UserService = Depends(get_user_service),
):
"""
Get beta tester program statistics (admin only).
"""
from google.cloud.firestore_v1 import FieldFilter
from google.cloud.firestore_v1 import aggregation
# Count beta testers by status using efficient aggregation queries
users_collection = user_service.db.collection("users")
# Helper function to get count using aggregation
def get_count(query) -> int:
agg_query = aggregation.AggregationQuery(query)
agg_query.count(alias="count")
results = agg_query.get()
return results[0][0].value if results else 0
total_beta_testers = get_count(
users_collection.where(filter=FieldFilter("is_beta_tester", "==", True))
)
active_testers = get_count(
users_collection.where(filter=FieldFilter("beta_tester_status", "==", "active"))
)
pending_feedback = get_count(
users_collection.where(filter=FieldFilter("beta_tester_status", "==", "pending_feedback"))
)
completed_feedback = get_count(
users_collection.where(filter=FieldFilter("beta_tester_status", "==", "completed"))
)
# Get average ratings from feedback
feedback_docs = list(user_service.db.collection("beta_feedback").stream())
avg_overall = 0
avg_ease = 0
avg_accuracy = 0
avg_correction = 0
if feedback_docs:
total = len(feedback_docs)
for doc in feedback_docs:
data = doc.to_dict()
avg_overall += data.get("overall_rating", 0)
avg_ease += data.get("ease_of_use_rating", 0)
avg_accuracy += data.get("lyrics_accuracy_rating", 0)
avg_correction += data.get("correction_experience_rating", 0)
avg_overall = round(avg_overall / total, 2)
avg_ease = round(avg_ease / total, 2)
avg_accuracy = round(avg_accuracy / total, 2)
avg_correction = round(avg_correction / total, 2)
return {
"total_beta_testers": total_beta_testers,
"active_testers": active_testers,
"pending_feedback": pending_feedback,
"completed_feedback": completed_feedback,
"total_feedback_submissions": len(feedback_docs),
"average_ratings": {
"overall": avg_overall,
"ease_of_use": avg_ease,
"lyrics_accuracy": avg_accuracy,
"correction_experience": avg_correction,
},
}
+5
View File
@@ -40,6 +40,11 @@ class Settings(BaseSettings):
# Processing
max_concurrent_jobs: int = int(os.getenv("MAX_CONCURRENT_JOBS", "5"))
job_timeout_seconds: int = int(os.getenv("JOB_TIMEOUT_SECONDS", "3600"))
# Agentic AI Correction (for lyrics correction via LLM)
# When enabled, uses Gemini via Vertex AI for intelligent lyrics correction
use_agentic_ai: bool = os.getenv("USE_AGENTIC_AI", "true").lower() in ("true", "1", "yes")
agentic_ai_model: str = os.getenv("AGENTIC_AI_MODEL", "vertexai/gemini-3-flash-preview")
# Cloud Tasks (for scalable worker coordination)
# When enabled, workers are triggered via Cloud Tasks for guaranteed delivery
+2 -1
View File
@@ -7,7 +7,7 @@ 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
from backend.api.routes import health, jobs, internal, file_upload, review, auth, audio_search, themes, users
from backend.services.tracing import setup_tracing, instrument_app, get_current_trace_id
from backend.services.structured_logging import setup_structured_logging
@@ -109,6 +109,7 @@ app.include_router(review.router, prefix="/api") # Review UI compatibility endp
app.include_router(auth.router, prefix="/api") # OAuth credential management
app.include_router(audio_search.router, prefix="/api") # Audio search (artist+title mode)
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.get("/")
+254
View File
@@ -0,0 +1,254 @@
"""
User model for authentication and credits.
Supports:
- Magic link authentication (email-based)
- Credit system for karaoke generation
- Role-based access control (user/admin)
- Stripe integration for payments
- Beta tester program with feedback collection
"""
from datetime import datetime
from enum import Enum
from typing import Optional, List
from pydantic import BaseModel, Field
class UserRole(str, Enum):
"""User roles for access control."""
USER = "user"
ADMIN = "admin"
class BetaTesterStatus(str, Enum):
"""Status of beta tester participation."""
ACTIVE = "active" # Enrolled, free credits available
PENDING_FEEDBACK = "pending_feedback" # Job completed, awaiting feedback
COMPLETED = "completed" # Feedback submitted
EXPIRED = "expired" # 24hr deadline passed without feedback
class CreditTransaction(BaseModel):
"""Record of a credit transaction."""
id: str
amount: int # Positive = add, negative = deduct
reason: str # e.g., "purchase", "refund", "admin_grant", "job_creation"
job_id: Optional[str] = None
stripe_session_id: Optional[str] = None
created_at: datetime = Field(default_factory=datetime.utcnow)
created_by: Optional[str] = None # Admin email if granted by admin
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.
"""
email: str # Primary identifier
role: UserRole = UserRole.USER
credits: int = 0
# Stripe integration
stripe_customer_id: Optional[str] = None
# Account state
is_active: bool = True
email_verified: bool = False
# Timestamps
created_at: datetime = Field(default_factory=datetime.utcnow)
updated_at: datetime = Field(default_factory=datetime.utcnow)
last_login_at: Optional[datetime] = None
# Credit history (last 100 transactions)
credit_transactions: List[CreditTransaction] = Field(default_factory=list)
# Job tracking
total_jobs_created: int = 0
total_jobs_completed: int = 0
# Optional profile fields for future use
display_name: Optional[str] = None
# Beta tester program
is_beta_tester: bool = False
beta_tester_status: Optional[BetaTesterStatus] = None
beta_enrolled_at: Optional[datetime] = None
beta_promise_text: Optional[str] = None # User's promise statement
beta_feedback_due_at: Optional[datetime] = None # 24hr after job completion
beta_feedback_email_sent: bool = False
class MagicLinkToken(BaseModel):
"""
Magic link token for passwordless authentication.
Tokens are short-lived (15 minutes) and single-use.
Stored in Firestore with automatic TTL.
"""
token: str # Secure random token
email: str
created_at: datetime = Field(default_factory=datetime.utcnow)
expires_at: datetime
used: bool = False
used_at: Optional[datetime] = None
ip_address: Optional[str] = None
user_agent: Optional[str] = None
class Session(BaseModel):
"""
User session for authenticated requests.
Sessions are created after successful magic link verification.
Sessions expire after 7 days of inactivity or 30 days absolute.
"""
token: str # Secure random session token
user_email: str
created_at: datetime = Field(default_factory=datetime.utcnow)
expires_at: datetime
last_activity_at: datetime = Field(default_factory=datetime.utcnow)
ip_address: Optional[str] = None
user_agent: Optional[str] = None
is_active: bool = True
# Pydantic models for API requests/responses
class SendMagicLinkRequest(BaseModel):
"""Request to send a magic link email."""
email: str
class SendMagicLinkResponse(BaseModel):
"""Response after sending magic link."""
status: str
message: str
class VerifyMagicLinkRequest(BaseModel):
"""Request to verify a magic link token."""
token: str
class VerifyMagicLinkResponse(BaseModel):
"""Response after verifying magic link."""
status: str
session_token: str
user: "UserPublic"
message: str
class UserPublic(BaseModel):
"""Public user information (safe to expose to frontend)."""
email: str
role: UserRole
credits: int
display_name: Optional[str] = None
total_jobs_created: int = 0
total_jobs_completed: int = 0
class AddCreditsRequest(BaseModel):
"""Admin request to add credits to a user."""
email: str
amount: int
reason: str = "admin_grant"
class AddCreditsResponse(BaseModel):
"""Response after adding credits."""
status: str
email: str
credits_added: int
new_balance: int
message: str
class UserListResponse(BaseModel):
"""Response for listing users (admin only)."""
users: List[UserPublic]
total: int
# ============================================================================
# Beta Tester Program Models
# ============================================================================
class BetaTesterFeedback(BaseModel):
"""
Feedback from a beta tester after using the service.
Stored in Firestore 'beta_feedback' collection.
"""
id: str # Unique feedback ID
user_email: str
job_id: Optional[str] = None # The job they're providing feedback on
# Ratings (1-5 scale)
overall_rating: int = Field(ge=1, le=5)
ease_of_use_rating: int = Field(ge=1, le=5)
lyrics_accuracy_rating: int = Field(ge=1, le=5)
correction_experience_rating: int = Field(ge=1, le=5)
# Open-ended feedback
what_went_well: Optional[str] = None
what_could_improve: Optional[str] = None
additional_comments: Optional[str] = None
# Would they recommend / use again?
would_recommend: bool = True
would_use_again: bool = True
# Metadata
created_at: datetime = Field(default_factory=datetime.utcnow)
submitted_via: str = "web" # 'web' or 'email'
class BetaTesterEnrollRequest(BaseModel):
"""Request to enroll as a beta tester."""
email: str
promise_text: str = Field(
min_length=10,
description="User's promise to provide feedback (min 10 chars)"
)
accept_corrections_work: bool = Field(
description="User accepts they may need to review/correct lyrics"
)
class BetaTesterEnrollResponse(BaseModel):
"""Response after enrolling as beta tester."""
status: str
message: str
credits_granted: int
session_token: Optional[str] = None # If new user, provide session
class BetaFeedbackRequest(BaseModel):
"""Request to submit beta tester feedback."""
job_id: Optional[str] = None
# Ratings (1-5 scale)
overall_rating: int = Field(ge=1, le=5)
ease_of_use_rating: int = Field(ge=1, le=5)
lyrics_accuracy_rating: int = Field(ge=1, le=5)
correction_experience_rating: int = Field(ge=1, le=5)
# Open-ended feedback
what_went_well: Optional[str] = None
what_could_improve: Optional[str] = None
additional_comments: Optional[str] = None
# Would they recommend / use again?
would_recommend: bool = True
would_use_again: bool = True
class BetaFeedbackResponse(BaseModel):
"""Response after submitting feedback."""
status: str
message: str
bonus_credits: int = 0 # Bonus credits for great feedback
+824
View File
@@ -0,0 +1,824 @@
"""
Email service for sending transactional emails.
Supports multiple providers:
- SendGrid (recommended for production)
- Console logging (for development/testing)
Future providers can be added:
- Mailgun
- AWS SES
- Postmark
"""
import html
import logging
import os
from abc import ABC, abstractmethod
from typing import Optional
from backend.config import get_settings
logger = logging.getLogger(__name__)
class EmailProvider(ABC):
"""Abstract base class for email providers."""
@abstractmethod
def send_email(
self,
to_email: str,
subject: str,
html_content: str,
text_content: Optional[str] = None
) -> bool:
"""Send an email. Returns True if successful."""
pass
class ConsoleEmailProvider(EmailProvider):
"""
Development email provider that logs to console.
Useful for local development and testing.
"""
def send_email(
self,
to_email: str,
subject: str,
html_content: str,
text_content: Optional[str] = None
) -> bool:
logger.info("=" * 60)
logger.info(f"EMAIL TO: {to_email}")
logger.info(f"SUBJECT: {subject}")
logger.info("-" * 60)
logger.info(text_content or html_content)
logger.info("=" * 60)
return True
class SendGridEmailProvider(EmailProvider):
"""
SendGrid email provider for production.
Requires SENDGRID_API_KEY environment variable.
"""
def __init__(self, api_key: str, from_email: str, from_name: str = "Nomad Karaoke"):
self.api_key = api_key
self.from_email = from_email
self.from_name = from_name
def send_email(
self,
to_email: str,
subject: str,
html_content: str,
text_content: 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
sg = SendGridAPIClient(api_key=self.api_key)
message = Mail(
from_email=Email(self.from_email, self.from_name),
to_emails=To(to_email),
subject=subject,
html_content=Content("text/html", html_content)
)
if text_content:
message.add_content(Content("text/plain", text_content))
response = sg.send(message)
if response.status_code >= 200 and response.status_code < 300:
logger.info(f"Email sent to {to_email} via SendGrid")
return True
else:
logger.error(f"SendGrid returned status {response.status_code}")
return False
except Exception:
logger.exception("Failed to send email via SendGrid")
return False
class EmailService:
"""
High-level email service for sending transactional emails.
Automatically selects the appropriate provider based on configuration.
"""
def __init__(self):
self.settings = get_settings()
self.provider = self._get_provider()
self.frontend_url = os.getenv("FRONTEND_URL", "https://gen.nomadkaraoke.com")
self.buy_url = os.getenv("BUY_URL", "https://buy.nomadkaraoke.com")
def _get_provider(self) -> EmailProvider:
"""Get the configured email provider."""
sendgrid_api_key = os.getenv("SENDGRID_API_KEY")
from_email = os.getenv("EMAIL_FROM", "noreply@nomadkaraoke.com")
from_name = os.getenv("EMAIL_FROM_NAME", "Nomad Karaoke")
if sendgrid_api_key:
logger.info("Using SendGrid email provider")
return SendGridEmailProvider(sendgrid_api_key, from_email, from_name)
else:
logger.warning("No email provider configured, using console logging")
return ConsoleEmailProvider()
def send_magic_link(self, email: str, token: str) -> bool:
"""
Send a magic link email for authentication.
Args:
email: User's email address
token: Magic link token
Returns:
True if email was sent successfully
"""
magic_link_url = f"{self.frontend_url}/auth/verify?token={token}"
subject = "Sign in to Nomad Karaoke"
html_content = f"""
<!DOCTYPE html>
<html>
<head>
<style>
body {{
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
line-height: 1.6;
color: #333;
max-width: 600px;
margin: 0 auto;
padding: 20px;
}}
.header {{
text-align: center;
padding: 20px 0;
}}
.logo {{
font-size: 24px;
font-weight: bold;
color: #3b82f6;
}}
.button {{
display: inline-block;
background-color: #3b82f6;
color: white;
padding: 14px 28px;
text-decoration: none;
border-radius: 8px;
font-weight: 600;
margin: 20px 0;
}}
.button:hover {{
background-color: #2563eb;
}}
.footer {{
margin-top: 30px;
padding-top: 20px;
border-top: 1px solid #eee;
font-size: 12px;
color: #666;
}}
.warning {{
background-color: #fef3c7;
border: 1px solid #fcd34d;
border-radius: 4px;
padding: 12px;
margin: 20px 0;
font-size: 14px;
}}
</style>
</head>
<body>
<div class="header">
<div class="logo">🎤 Nomad Karaoke</div>
</div>
<p>Hi there,</p>
<p>Click the button below to sign in to Nomad Karaoke:</p>
<p style="text-align: center;">
<a href="{magic_link_url}" class="button">Sign In</a>
</p>
<div class="warning">
⏰ This link expires in 15 minutes and can only be used once.
</div>
<p>If the button doesn't work, copy and paste this link into your browser:</p>
<p style="word-break: break-all; font-size: 14px; color: #666;">
{magic_link_url}
</p>
<p>If you didn't request this email, you can safely ignore it.</p>
<div class="footer">
<p>© {self._get_year()} Nomad Karaoke. All rights reserved.</p>
<p>This is an automated message, please do not reply.</p>
</div>
</body>
</html>
"""
text_content = f"""
Sign in to Nomad Karaoke
========================
Click this link to sign in:
{magic_link_url}
This link expires in 15 minutes and can only be used once.
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)
def send_credits_added(self, email: str, credits: int, total_credits: int) -> bool:
"""
Send notification when credits are added to account.
Args:
email: User's email address
credits: Number of credits added
total_credits: New total credit balance
Returns:
True if email was sent successfully
"""
subject = f"🎉 {credits} credits added to your Nomad Karaoke account"
html_content = f"""
<!DOCTYPE html>
<html>
<head>
<style>
body {{
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
line-height: 1.6;
color: #333;
max-width: 600px;
margin: 0 auto;
padding: 20px;
}}
.header {{
text-align: center;
padding: 20px 0;
}}
.logo {{
font-size: 24px;
font-weight: bold;
color: #3b82f6;
}}
.credits-box {{
background-color: #ecfdf5;
border: 2px solid #10b981;
border-radius: 12px;
padding: 24px;
text-align: center;
margin: 20px 0;
}}
.credits-number {{
font-size: 48px;
font-weight: bold;
color: #10b981;
}}
.button {{
display: inline-block;
background-color: #3b82f6;
color: white;
padding: 14px 28px;
text-decoration: none;
border-radius: 8px;
font-weight: 600;
margin: 20px 0;
}}
.footer {{
margin-top: 30px;
padding-top: 20px;
border-top: 1px solid #eee;
font-size: 12px;
color: #666;
}}
</style>
</head>
<body>
<div class="header">
<div class="logo">🎤 Nomad Karaoke</div>
</div>
<p>Great news! 🎉</p>
<p><strong>{credits} credits</strong> have been added to your account.</p>
<div class="credits-box">
<div>Your balance:</div>
<div class="credits-number">{total_credits}</div>
<div>credits</div>
</div>
<p>Each credit lets you create one professional karaoke video with:</p>
<ul>
<li>AI-powered vocal/instrumental separation</li>
<li>Synchronized lyrics with word-level timing</li>
<li>4K video output</li>
<li>YouTube upload</li>
</ul>
<p style="text-align: center;">
<a href="{self.frontend_url}" class="button">Create Karaoke Now</a>
</p>
<div class="footer">
<p>© {self._get_year()} Nomad Karaoke. All rights reserved.</p>
</div>
</body>
</html>
"""
text_content = f"""
{credits} credits added to your Nomad Karaoke account!
Your new balance: {total_credits} credits
Each credit lets you create one professional karaoke video.
Start creating: {self.frontend_url}
---
© {self._get_year()} Nomad Karaoke
"""
return self.provider.send_email(email, subject, html_content, text_content)
def send_welcome_email(self, email: str, credits: int = 0) -> bool:
"""
Send welcome email to new users.
Args:
email: User's email address
credits: Initial credit balance (if any)
Returns:
True if email was sent successfully
"""
subject = "Welcome to Nomad Karaoke! 🎤"
credits_text = f"You have <strong>{credits} credits</strong> to get started!" if credits > 0 else ""
html_content = f"""
<!DOCTYPE html>
<html>
<head>
<style>
body {{
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
line-height: 1.6;
color: #333;
max-width: 600px;
margin: 0 auto;
padding: 20px;
}}
.header {{
text-align: center;
padding: 20px 0;
}}
.logo {{
font-size: 24px;
font-weight: bold;
color: #3b82f6;
}}
.button {{
display: inline-block;
background-color: #3b82f6;
color: white;
padding: 14px 28px;
text-decoration: none;
border-radius: 8px;
font-weight: 600;
margin: 20px 0;
}}
.feature {{
display: flex;
align-items: flex-start;
margin: 16px 0;
}}
.feature-icon {{
font-size: 24px;
margin-right: 12px;
}}
.footer {{
margin-top: 30px;
padding-top: 20px;
border-top: 1px solid #eee;
font-size: 12px;
color: #666;
}}
</style>
</head>
<body>
<div class="header">
<div class="logo">🎤 Nomad Karaoke</div>
</div>
<p>Welcome to Nomad Karaoke!</p>
<p>Turn any song into a professional karaoke video in minutes. {credits_text}</p>
<p><strong>Here's how it works:</strong></p>
<div class="feature">
<span class="feature-icon">🎵</span>
<div>
<strong>1. Search for a song</strong><br>
Enter the artist and title, and we'll find high-quality audio.
</div>
</div>
<div class="feature">
<span class="feature-icon">✨</span>
<div>
<strong>2. AI does the magic</strong><br>
We separate vocals, transcribe lyrics, and sync everything perfectly.
</div>
</div>
<div class="feature">
<span class="feature-icon">✏️</span>
<div>
<strong>3. Review & customize</strong><br>
Fine-tune the lyrics if needed, choose your instrumental.
</div>
</div>
<div class="feature">
<span class="feature-icon">🎬</span>
<div>
<strong>4. Get your video</strong><br>
Download your 4K karaoke video or upload directly to YouTube.
</div>
</div>
<p style="text-align: center;">
<a href="{self.frontend_url}" class="button">Get Started</a>
</p>
<div class="footer">
<p>Questions? Reply to this email and we'll help you out.</p>
<p>© {self._get_year()} Nomad Karaoke. All rights reserved.</p>
</div>
</body>
</html>
"""
text_content = f"""
Welcome to Nomad Karaoke!
Turn any song into a professional karaoke video in minutes.
Here's how it works:
1. Search for a song
Enter the artist and title, and we'll find high-quality audio.
2. AI does the magic
We separate vocals, transcribe lyrics, and sync everything perfectly.
3. Review & customize
Fine-tune the lyrics if needed, choose your instrumental.
4. Get your video
Download your 4K karaoke video or upload directly to YouTube.
Get started: {self.frontend_url}
---
© {self._get_year()} Nomad Karaoke
"""
return self.provider.send_email(email, subject, html_content, text_content)
def send_beta_welcome_email(self, email: str, credits: int = 1) -> bool:
"""
Send welcome email to new beta testers.
Args:
email: User's email address
credits: Initial free credits granted
Returns:
True if email was sent successfully
"""
subject = "Welcome Beta Tester! Free Karaoke Credits Inside 🎤"
html_content = f"""
<!DOCTYPE html>
<html>
<head>
<style>
body {{
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
line-height: 1.6;
color: #333;
max-width: 600px;
margin: 0 auto;
padding: 20px;
}}
.header {{
text-align: center;
padding: 20px 0;
}}
.logo {{
font-size: 24px;
font-weight: bold;
color: #3b82f6;
}}
.beta-badge {{
display: inline-block;
background: linear-gradient(135deg, #8b5cf6, #ec4899);
color: white;
padding: 4px 12px;
border-radius: 20px;
font-size: 12px;
font-weight: bold;
margin-left: 8px;
}}
.credits-box {{
background-color: #ecfdf5;
border: 2px solid #10b981;
border-radius: 12px;
padding: 24px;
text-align: center;
margin: 20px 0;
}}
.credits-number {{
font-size: 48px;
font-weight: bold;
color: #10b981;
}}
.reminder {{
background-color: #fef3c7;
border: 1px solid #fcd34d;
border-radius: 8px;
padding: 16px;
margin: 20px 0;
}}
.button {{
display: inline-block;
background-color: #3b82f6;
color: white;
padding: 14px 28px;
text-decoration: none;
border-radius: 8px;
font-weight: 600;
margin: 20px 0;
}}
.footer {{
margin-top: 30px;
padding-top: 20px;
border-top: 1px solid #eee;
font-size: 12px;
color: #666;
}}
</style>
</head>
<body>
<div class="header">
<span class="logo">🎤 Nomad Karaoke</span>
<span class="beta-badge">BETA TESTER</span>
</div>
<p>Thank you for joining our beta program! 🎉</p>
<p>As promised, here's your free credit to create a karaoke video:</p>
<div class="credits-box">
<div>Your balance:</div>
<div class="credits-number">{credits}</div>
<div>free credit{'' if credits == 1 else 's'}</div>
</div>
<div class="reminder">
<strong>📝 Your Promise:</strong><br>
Remember, as a beta tester you agreed to:
<ul style="margin: 10px 0; padding-left: 20px;">
<li>Review and correct any lyrics timing issues</li>
<li>Share your honest feedback after trying the tool</li>
</ul>
We'll send you a quick feedback form after your job completes!
</div>
<p style="text-align: center;">
<a href="{self.frontend_url}" class="button">Create Your Karaoke Video</a>
</p>
<p>Thanks for helping us make Nomad Karaoke better!</p>
<div class="footer">
<p>© {self._get_year()} Nomad Karaoke. All rights reserved.</p>
</div>
</body>
</html>
"""
text_content = f"""
Welcome Beta Tester!
Thank you for joining our beta program!
You've been granted {credits} free credit{'' if credits == 1 else 's'} to create karaoke videos.
YOUR PROMISE:
As a beta tester, you agreed to:
- Review and correct any lyrics timing issues
- Share your honest feedback after trying the tool
We'll send you a quick feedback form after your job completes!
Create your karaoke video: {self.frontend_url}
Thanks for helping us make Nomad Karaoke better!
---
© {self._get_year()} Nomad Karaoke
"""
return self.provider.send_email(email, subject, html_content, text_content)
def send_feedback_request_email(self, email: str, feedback_url: str, job_title: Optional[str] = None) -> bool:
"""
Send feedback request email to beta testers.
Args:
email: User's email address
feedback_url: URL to the feedback form
job_title: Optional title of the completed job
Returns:
True if email was sent successfully
"""
subject = "Quick feedback on your karaoke experience? 🎤"
# Escape job_title to prevent XSS in email clients that render HTML
safe_job_title = html.escape(job_title) if job_title else ""
job_context = f" for <strong>{safe_job_title}</strong>" if job_title else ""
html_content = f"""
<!DOCTYPE html>
<html>
<head>
<style>
body {{
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
line-height: 1.6;
color: #333;
max-width: 600px;
margin: 0 auto;
padding: 20px;
}}
.header {{
text-align: center;
padding: 20px 0;
}}
.logo {{
font-size: 24px;
font-weight: bold;
color: #3b82f6;
}}
.feedback-box {{
background: linear-gradient(135deg, #f0f9ff, #e0f2fe);
border: 2px solid #3b82f6;
border-radius: 12px;
padding: 24px;
text-align: center;
margin: 20px 0;
}}
.stars {{
font-size: 36px;
margin: 10px 0;
}}
.button {{
display: inline-block;
background-color: #3b82f6;
color: white;
padding: 14px 28px;
text-decoration: none;
border-radius: 8px;
font-weight: 600;
margin: 20px 0;
}}
.time-note {{
background-color: #fef3c7;
border-radius: 8px;
padding: 12px;
margin: 20px 0;
font-size: 14px;
}}
.footer {{
margin-top: 30px;
padding-top: 20px;
border-top: 1px solid #eee;
font-size: 12px;
color: #666;
}}
</style>
</head>
<body>
<div class="header">
<div class="logo">🎤 Nomad Karaoke</div>
</div>
<p>Hi there!</p>
<p>Hope you enjoyed creating your karaoke video{job_context}! As a beta tester, your feedback is super valuable to us.</p>
<div class="feedback-box">
<div class="stars">⭐⭐⭐⭐⭐</div>
<p><strong>How was your experience?</strong></p>
<p>Quick 2-minute survey - we'd love to hear your thoughts!</p>
</div>
<p style="text-align: center;">
<a href="{feedback_url}" class="button">Share Your Feedback</a>
</p>
<div class="time-note">
⏱️ This takes less than 2 minutes and helps us improve the tool for everyone!
</div>
<p>Specifically, we'd love to know:</p>
<ul>
<li>How easy was it to use?</li>
<li>Were the lyrics accurate?</li>
<li>How was the correction experience?</li>
<li>What could we improve?</li>
</ul>
<p>Thanks for being part of making Nomad Karaoke better! 🙏</p>
<div class="footer">
<p>© {self._get_year()} Nomad Karaoke. All rights reserved.</p>
</div>
</body>
</html>
"""
text_content = f"""
Quick feedback on your karaoke experience?
Hi there!
Hope you enjoyed creating your karaoke video{' for ' + safe_job_title if safe_job_title else ''}!
As a beta tester, your feedback is super valuable to us.
Share your feedback (2-minute survey): {feedback_url}
We'd love to know:
- How easy was it to use?
- Were the lyrics accurate?
- How was the correction experience?
- What could we improve?
Thanks for being part of making Nomad Karaoke better!
---
© {self._get_year()} Nomad Karaoke
"""
return self.provider.send_email(email, subject, html_content, text_content)
def _get_year(self) -> int:
"""Get current year for copyright notices."""
from datetime import datetime
return datetime.now().year
# Global instance
_email_service = None
def get_email_service() -> EmailService:
"""Get the global email service instance."""
global _email_service
if _email_service is None:
_email_service = EmailService()
return _email_service
+6 -2
View File
@@ -136,8 +136,10 @@ class GoogleDriveService:
logger.info(f"Looking for folder '{folder_name}' in parent {parent_id}")
# Search for existing folder
# Escape single quotes in folder name for Google Drive API query syntax
escaped_folder_name = folder_name.replace("'", "\\'")
query = (
f"name='{folder_name}' and '{parent_id}' in parents "
f"name='{escaped_folder_name}' and '{parent_id}' in parents "
f"and mimeType='application/vnd.google-apps.folder' and trashed=false"
)
results = self.service.files().list(q=query, fields="files(id, name)").execute()
@@ -203,8 +205,10 @@ class GoogleDriveService:
# Check for existing file with same name
if replace_existing:
# Escape single quotes in filename for Google Drive API query syntax
escaped_filename = filename.replace("'", "\\'")
query = (
f"name='{filename}' and '{parent_id}' in parents and trashed=false"
f"name='{escaped_filename}' and '{parent_id}' in parents and trashed=false"
)
results = self.service.files().list(q=query, fields="files(id)").execute()
for existing_file in results.get("files", []):
+274
View File
@@ -0,0 +1,274 @@
"""
Stripe service for payment processing.
Handles:
- Creating checkout sessions for credit purchases
- Processing webhook events
- Managing customer records
"""
import logging
import os
from typing import Optional, Dict, Any, Tuple
import stripe
from backend.config import get_settings
logger = logging.getLogger(__name__)
# Credit packages available for purchase
CREDIT_PACKAGES = {
"1_credit": {
"credits": 1,
"price_cents": 500, # $5.00
"name": "1 Karaoke Credit",
"description": "Create 1 professional karaoke video",
},
"3_credits": {
"credits": 3,
"price_cents": 1200, # $12.00 (20% discount)
"name": "3 Karaoke Credits",
"description": "Create 3 professional karaoke videos (Save 20%)",
},
"5_credits": {
"credits": 5,
"price_cents": 1750, # $17.50 (30% discount)
"name": "5 Karaoke Credits",
"description": "Create 5 professional karaoke videos (Save 30%)",
},
"10_credits": {
"credits": 10,
"price_cents": 3000, # $30.00 (40% discount)
"name": "10 Karaoke Credits",
"description": "Create 10 professional karaoke videos (Save 40%)",
},
}
class StripeService:
"""Service for Stripe payment processing."""
def __init__(self):
"""Initialize Stripe with API key."""
self.settings = get_settings()
self.secret_key = os.getenv("STRIPE_SECRET_KEY")
self.webhook_secret = os.getenv("STRIPE_WEBHOOK_SECRET")
self.frontend_url = os.getenv("FRONTEND_URL", "https://gen.nomadkaraoke.com")
self.buy_url = os.getenv("BUY_URL", "https://buy.nomadkaraoke.com")
if self.secret_key:
stripe.api_key = self.secret_key
logger.info("Stripe initialized with API key")
else:
logger.warning("STRIPE_SECRET_KEY not set - payments disabled")
def is_configured(self) -> bool:
"""Check if Stripe is properly configured."""
return bool(self.secret_key)
def get_credit_packages(self) -> Dict[str, Dict[str, Any]]:
"""Get available credit packages."""
return CREDIT_PACKAGES
def create_checkout_session(
self,
package_id: str,
user_email: str,
success_url: Optional[str] = None,
cancel_url: Optional[str] = None,
) -> Tuple[bool, Optional[str], str]:
"""
Create a Stripe Checkout session for purchasing credits.
Args:
package_id: ID of the credit package to purchase
user_email: Email of the purchasing user
success_url: URL to redirect to on success (optional)
cancel_url: URL to redirect to on cancel (optional)
Returns:
(success, checkout_url, message)
"""
if not self.is_configured():
return False, None, "Payment processing is not configured"
package = CREDIT_PACKAGES.get(package_id)
if not package:
return False, None, f"Invalid package: {package_id}"
try:
# Default URLs
if not success_url:
success_url = f"{self.frontend_url}/payment/success?session_id={{CHECKOUT_SESSION_ID}}"
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=[{
'price_data': {
'currency': 'usd',
'product_data': {
'name': package['name'],
'description': package['description'],
},
'unit_amount': package['price_cents'],
},
'quantity': 1,
}],
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,
)
logger.info(f"Created checkout session {session.id} for {user_email}, package {package_id}")
return True, session.url, "Checkout session created"
except stripe.error.StripeError as e:
logger.error(f"Stripe error creating checkout session: {e}")
return False, None, f"Payment error: {str(e)}"
except Exception as e:
logger.error(f"Error creating 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]:
"""
Verify a Stripe webhook signature.
Args:
payload: Raw request body
signature: Stripe-Signature header value
Returns:
(valid, event_data, message)
"""
if not self.webhook_secret:
logger.error("STRIPE_WEBHOOK_SECRET not configured")
return False, None, "Webhook secret not configured"
try:
event = stripe.Webhook.construct_event(
payload, signature, self.webhook_secret
)
return True, event, "Webhook verified"
except stripe.error.SignatureVerificationError as e:
logger.error(f"Invalid webhook signature: {e}")
return False, None, "Invalid signature"
except Exception as e:
logger.error(f"Error verifying webhook: {e}")
return False, None, str(e)
def handle_checkout_completed(self, session: Dict) -> Tuple[bool, Optional[str], int, str]:
"""
Handle a completed checkout session.
Args:
session: Stripe checkout session object
Returns:
(success, user_email, credits_to_add, message)
"""
try:
metadata = session.get('metadata', {})
user_email = metadata.get('user_email') or session.get('customer_email')
try:
credits = int(metadata.get('credits', 0))
except (ValueError, TypeError):
logger.error(f"Invalid credits metadata in session {session.get('id')}: {metadata.get('credits')}")
return False, user_email, 0, "Invalid credit amount in session metadata"
package_id = metadata.get('package_id')
if not user_email:
logger.error(f"No user email in checkout session {session.get('id')}")
return False, None, 0, "No user email found"
if credits <= 0:
logger.error(f"Invalid credits in checkout session {session.get('id')}")
return False, user_email, 0, "Invalid credit amount"
logger.info(
f"Checkout completed: {user_email} purchased {credits} credits "
f"(package: {package_id}, session: {session.get('id')})"
)
return True, user_email, credits, f"Successfully purchased {credits} credits"
except Exception as e:
logger.error(f"Error handling checkout completed: {e}")
return False, None, 0, str(e)
def get_session(self, session_id: str) -> Optional[Dict]:
"""
Get a checkout session by ID.
Args:
session_id: Stripe checkout session ID
Returns:
Session data or None
"""
if not self.is_configured():
return None
try:
session = stripe.checkout.Session.retrieve(session_id)
return dict(session)
except Exception as e:
logger.error(f"Error retrieving session {session_id}: {e}")
return None
def create_customer(self, email: str, name: Optional[str] = None) -> Optional[str]:
"""
Create or get a Stripe customer for a user.
Args:
email: User's email
name: User's display name (optional)
Returns:
Stripe customer ID or None
"""
if not self.is_configured():
return None
try:
# Check if customer already exists
customers = stripe.Customer.list(email=email, limit=1)
if customers.data:
return customers.data[0].id
# Create new customer
customer = stripe.Customer.create(
email=email,
name=name,
metadata={'source': 'nomad_karaoke'},
)
logger.info(f"Created Stripe customer {customer.id} for {email}")
return customer.id
except Exception as e:
logger.error(f"Error creating Stripe customer: {e}")
return None
# Global instance
_stripe_service = None
def get_stripe_service() -> StripeService:
"""Get the global Stripe service instance."""
global _stripe_service
if _stripe_service is None:
_stripe_service = StripeService()
return _stripe_service
+624
View File
@@ -0,0 +1,624 @@
"""
User service for authentication, credits, and user management.
Handles:
- Magic link authentication (send, verify)
- Session management
- Credit operations (add, deduct, refund)
- User CRUD operations
"""
import logging
import secrets
import uuid
from datetime import datetime, timedelta
from typing import Optional, List, Tuple
from google.cloud import firestore
from google.cloud.firestore_v1 import FieldFilter
from google.cloud.firestore_v1 import Increment
from backend.config import get_settings
from backend.models.user import (
User,
UserRole,
UserPublic,
MagicLinkToken,
Session,
CreditTransaction,
)
logger = logging.getLogger(__name__)
# Collection names
USERS_COLLECTION = "users"
MAGIC_LINKS_COLLECTION = "magic_links"
SESSIONS_COLLECTION = "sessions"
PROCESSED_STRIPE_SESSIONS_COLLECTION = "processed_stripe_sessions"
# Token/session configuration
MAGIC_LINK_EXPIRY_MINUTES = 15
SESSION_EXPIRY_DAYS = 7
SESSION_ABSOLUTE_EXPIRY_DAYS = 30
MAX_CREDIT_TRANSACTIONS = 100 # Keep last N transactions
class UserService:
"""Service for user management and authentication."""
def __init__(self):
"""Initialize user service with Firestore client."""
self.settings = get_settings()
self.db = firestore.Client(project=self.settings.google_cloud_project)
# =========================================================================
# User CRUD Operations
# =========================================================================
def get_user(self, email: str) -> Optional[User]:
"""Get a user by email."""
try:
doc_ref = self.db.collection(USERS_COLLECTION).document(email.lower())
doc = doc_ref.get()
if not doc.exists:
return None
return User(**doc.to_dict())
except Exception:
logger.exception(f"Error getting user {email}")
return None
def get_or_create_user(self, email: str) -> User:
"""Get existing user or create a new one."""
email = email.lower()
user = self.get_user(email)
if user:
return user
# Create new user
user = User(email=email)
self._save_user(user)
logger.info(f"Created new user: {email}")
return user
def _save_user(self, user: User) -> None:
"""Save user to Firestore."""
try:
user.updated_at = datetime.utcnow()
doc_ref = self.db.collection(USERS_COLLECTION).document(user.email.lower())
doc_ref.set(user.model_dump(mode='json'))
except Exception:
logger.exception(f"Error saving user {user.email}")
raise
def update_user(self, email: str, **updates) -> Optional[User]:
"""Update user fields."""
try:
updates['updated_at'] = datetime.utcnow()
doc_ref = self.db.collection(USERS_COLLECTION).document(email.lower())
doc_ref.update(updates)
return self.get_user(email)
except Exception:
logger.exception(f"Error updating user {email}")
return None
def list_users(self, limit: int = 100, include_inactive: bool = False) -> List[User]:
"""List all users (admin only)."""
try:
query = self.db.collection(USERS_COLLECTION)
if not include_inactive:
query = query.where(filter=FieldFilter('is_active', '==', True))
query = query.order_by('created_at', direction=firestore.Query.DESCENDING)
query = query.limit(limit)
docs = query.stream()
return [User(**doc.to_dict()) for doc in docs]
except Exception:
logger.exception("Error listing users")
return []
def get_user_public(self, email: str) -> Optional[UserPublic]:
"""Get public user info."""
user = self.get_user(email)
if not user:
return None
return UserPublic(
email=user.email,
role=user.role,
credits=user.credits,
display_name=user.display_name,
total_jobs_created=user.total_jobs_created,
total_jobs_completed=user.total_jobs_completed,
)
# =========================================================================
# Magic Link Authentication
# =========================================================================
def create_magic_link(
self,
email: str,
ip_address: Optional[str] = None,
user_agent: 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).
"""
email = email.lower()
# Ensure user exists
self.get_or_create_user(email)
# Generate secure token
token = secrets.token_urlsafe(32)
magic_link = MagicLinkToken(
token=token,
email=email,
expires_at=datetime.utcnow() + timedelta(minutes=MAGIC_LINK_EXPIRY_MINUTES),
ip_address=ip_address,
user_agent=user_agent,
)
# Save to Firestore
doc_ref = self.db.collection(MAGIC_LINKS_COLLECTION).document(token)
doc_ref.set(magic_link.model_dump(mode='json'))
logger.info(f"Created magic link for {email}")
return magic_link
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.
Returns:
(success, user, message)
"""
try:
doc_ref = self.db.collection(MAGIC_LINKS_COLLECTION).document(token)
@firestore.transactional
def verify_in_transaction(transaction):
"""Atomically verify and mark magic link as used."""
doc = doc_ref.get(transaction=transaction)
if not doc.exists:
return False, None, "Invalid or expired link"
magic_link = MagicLinkToken(**doc.to_dict())
# Check if already used
if magic_link.used:
return False, None, "This link has already been used"
# Check expiry
if datetime.utcnow() > magic_link.expires_at:
return False, None, "This link has expired"
# Mark as used atomically within transaction
transaction.update(doc_ref, {
'used': True,
'used_at': datetime.utcnow()
})
return True, magic_link.email, "Success"
# Execute the transaction
transaction = self.db.transaction()
success, email_or_error, message = verify_in_transaction(transaction)
if not success:
return False, None, message
# Get user and mark email as verified (outside transaction)
user = self.get_user(email_or_error)
if user:
self.update_user(
email_or_error,
email_verified=True,
last_login_at=datetime.utcnow()
)
user = self.get_user(email_or_error) # Refresh
logger.info(f"Magic link verified for {email_or_error}")
return True, user, "Successfully authenticated"
except Exception:
logger.exception("Error verifying magic link")
return False, None, "An error occurred during verification"
# =========================================================================
# Session Management
# =========================================================================
def create_session(
self,
user_email: str,
ip_address: Optional[str] = None,
user_agent: Optional[str] = None
) -> Session:
"""Create a new session for an authenticated user."""
token = secrets.token_urlsafe(32)
session = Session(
token=token,
user_email=user_email.lower(),
expires_at=datetime.utcnow() + timedelta(days=SESSION_ABSOLUTE_EXPIRY_DAYS),
ip_address=ip_address,
user_agent=user_agent,
)
doc_ref = self.db.collection(SESSIONS_COLLECTION).document(token)
doc_ref.set(session.model_dump(mode='json'))
logger.info(f"Created session for {user_email}")
return session
def validate_session(self, token: str) -> Tuple[bool, Optional[User], str]:
"""
Validate a session token.
Returns:
(valid, user, message)
"""
try:
doc_ref = self.db.collection(SESSIONS_COLLECTION).document(token)
doc = doc_ref.get()
if not doc.exists:
return False, None, "Invalid session"
session = Session(**doc.to_dict())
# Check if active
if not session.is_active:
return False, None, "Session has been revoked"
# Check expiry
if datetime.utcnow() > session.expires_at:
return False, None, "Session has expired"
# Check inactivity (7 days)
inactivity_limit = datetime.utcnow() - timedelta(days=SESSION_EXPIRY_DAYS)
if session.last_activity_at < inactivity_limit:
return False, None, "Session expired due to inactivity"
# Update last activity
doc_ref.update({'last_activity_at': datetime.utcnow()})
# Get user
user = self.get_user(session.user_email)
if not user:
return False, None, "User not found"
if not user.is_active:
return False, None, "User account is disabled"
return True, user, "Valid session"
except Exception:
logger.exception("Error validating session")
return False, None, "An error occurred during validation"
def revoke_session(self, token: str) -> bool:
"""Revoke a session (logout)."""
try:
doc_ref = self.db.collection(SESSIONS_COLLECTION).document(token)
doc_ref.update({'is_active': False})
logger.info("Session revoked")
return True
except Exception:
logger.exception("Error revoking session")
return False
def revoke_all_sessions(self, user_email: str) -> int:
"""Revoke all sessions for a user."""
try:
query = self.db.collection(SESSIONS_COLLECTION).where(
filter=FieldFilter('user_email', '==', user_email.lower())
).where(
filter=FieldFilter('is_active', '==', True)
)
count = 0
for doc in query.stream():
doc.reference.update({'is_active': False})
count += 1
logger.info(f"Revoked {count} sessions for {user_email}")
return count
except Exception:
logger.exception("Error revoking sessions")
return 0
# =========================================================================
# Credit Operations
# =========================================================================
def add_credits(
self,
email: str,
amount: int,
reason: str,
job_id: Optional[str] = None,
stripe_session_id: Optional[str] = None,
admin_email: Optional[str] = None
) -> Tuple[bool, int, str]:
"""
Add credits to a user account.
Returns:
(success, new_balance, message)
"""
try:
# For Stripe sessions, atomically check and mark as processed
# Uses create() which fails if document exists - ensures idempotency
if stripe_session_id:
doc_ref = self.db.collection(PROCESSED_STRIPE_SESSIONS_COLLECTION).document(stripe_session_id)
try:
doc_ref.create({
'stripe_session_id': stripe_session_id,
'email': email.lower(),
'amount': amount,
'processed_at': datetime.utcnow()
})
except Exception:
# Document already exists - this session was already processed
logger.info(f"Stripe session {stripe_session_id} already processed (idempotent skip)")
return False, 0, "Session already processed"
email = email.lower()
user = self.get_or_create_user(email)
# Create transaction record
transaction = CreditTransaction(
id=str(uuid.uuid4()),
amount=amount,
reason=reason,
job_id=job_id,
stripe_session_id=stripe_session_id,
created_by=admin_email,
)
# Add to transaction history (keep last N)
transactions = user.credit_transactions[-MAX_CREDIT_TRANSACTIONS + 1:]
transactions.append(transaction)
# Update user
new_balance = user.credits + amount
self.update_user(
email,
credits=new_balance,
credit_transactions=[t.model_dump(mode='json') for t in transactions]
)
logger.info(f"Added {amount} credits to {email} ({reason}). New balance: {new_balance}")
return True, new_balance, f"Added {amount} credits"
except Exception as e:
logger.exception(f"Error adding credits to {email}")
return False, 0, f"Failed to add credits: {e}"
def deduct_credit(
self,
email: str,
job_id: str,
reason: str = "job_creation"
) -> Tuple[bool, int, str]:
"""
Deduct one credit from a user account.
Uses Firestore transaction to prevent race conditions.
Returns:
(success, remaining_credits, message)
"""
try:
email = email.lower()
doc_ref = self.db.collection(USERS_COLLECTION).document(email)
@firestore.transactional
def deduct_in_transaction(transaction):
"""Atomically check and deduct credit."""
doc = doc_ref.get(transaction=transaction)
if not doc.exists:
return False, 0, "User not found"
user_data = doc.to_dict()
current_credits = user_data.get('credits', 0)
if current_credits <= 0:
return False, 0, "Insufficient credits"
# Create transaction record
credit_txn = CreditTransaction(
id=str(uuid.uuid4()),
amount=-1,
reason=reason,
job_id=job_id,
)
# Get existing transactions and add new one
existing_transactions = user_data.get('credit_transactions', [])
# Keep last N-1 transactions to make room for new one
transactions = existing_transactions[-(MAX_CREDIT_TRANSACTIONS - 1):]
transactions.append(credit_txn.model_dump(mode='json'))
# Calculate new values
new_balance = current_credits - 1
total_jobs = user_data.get('total_jobs_created', 0) + 1
# Update atomically within transaction
transaction.update(doc_ref, {
'credits': new_balance,
'credit_transactions': transactions,
'total_jobs_created': total_jobs,
'updated_at': datetime.utcnow()
})
return True, new_balance, f"Credit deducted. {new_balance} remaining"
# Execute the transaction
fs_transaction = self.db.transaction()
success, new_balance, message = deduct_in_transaction(fs_transaction)
if success:
logger.info(f"Deducted 1 credit from {email} for job {job_id}. Remaining: {new_balance}")
return success, new_balance, message
except Exception as e:
logger.exception(f"Error deducting credit from {email}")
return False, 0, f"Failed to deduct credit: {e}"
def refund_credit(
self,
email: str,
job_id: str,
reason: str = "job_failed"
) -> Tuple[bool, int, str]:
"""
Refund one credit to a user account (e.g., after job failure).
Returns:
(success, new_balance, message)
"""
return self.add_credits(email, 1, reason, job_id=job_id)
def check_credits(self, email: str) -> int:
"""Check user's credit balance."""
user = self.get_user(email)
return user.credits if user else 0
def has_credits(self, email: str) -> bool:
"""Check if user has at least one credit."""
return self.check_credits(email) > 0
def is_stripe_session_processed(self, stripe_session_id: str) -> bool:
"""
Check if a Stripe session ID has already been processed.
Used to ensure idempotency of webhook processing - prevents
duplicate credit additions if Stripe sends the same webhook twice.
Uses a dedicated collection for O(1) lookup instead of scanning all users.
Args:
stripe_session_id: The Stripe checkout session ID
Returns:
True if this session was already processed
"""
try:
doc_ref = self.db.collection(PROCESSED_STRIPE_SESSIONS_COLLECTION).document(stripe_session_id)
doc = doc_ref.get()
if doc.exists:
logger.info(f"Stripe session {stripe_session_id} already processed")
return True
return False
except Exception:
logger.exception(f"Error checking if stripe session {stripe_session_id} was processed")
# On error, return False to allow processing (better to risk duplicate than block)
return False
def _mark_stripe_session_processed(self, stripe_session_id: str, email: str, amount: int) -> None:
"""
Mark a Stripe session as processed.
Called after successfully adding credits from a Stripe webhook.
Args:
stripe_session_id: The Stripe checkout session ID
email: User email who received the credits
amount: Number of credits added
"""
try:
doc_ref = self.db.collection(PROCESSED_STRIPE_SESSIONS_COLLECTION).document(stripe_session_id)
doc_ref.set({
'stripe_session_id': stripe_session_id,
'email': email,
'amount': amount,
'processed_at': datetime.utcnow()
})
except Exception:
# Log but don't fail - the credits were already added
logger.exception(f"Error marking stripe session {stripe_session_id} as processed")
# =========================================================================
# Admin Operations
# =========================================================================
def set_user_role(self, email: str, role: UserRole, admin_email: str) -> bool:
"""Set a user's role (admin only)."""
try:
user = self.get_user(email)
if not user:
return False
self.update_user(email, role=role.value)
logger.info(f"Admin {admin_email} set role for {email} to {role.value}")
return True
except Exception:
logger.exception("Error setting user role")
return False
def disable_user(self, email: str, admin_email: str) -> bool:
"""Disable a user account (admin only)."""
try:
self.update_user(email, is_active=False)
self.revoke_all_sessions(email)
logger.info(f"Admin {admin_email} disabled user {email}")
return True
except Exception:
logger.exception("Error disabling user")
return False
def enable_user(self, email: str, admin_email: str) -> bool:
"""Enable a user account (admin only)."""
try:
self.update_user(email, is_active=True)
logger.info(f"Admin {admin_email} enabled user {email}")
return True
except Exception:
logger.exception("Error enabling user")
return False
def increment_jobs_completed(self, email: str) -> bool:
"""Increment the completed jobs counter for a user using atomic increment."""
try:
# Check user exists first
if not self.get_user(email):
return False
# Use atomic increment to prevent race conditions
doc_ref = self.db.collection(USERS_COLLECTION).document(email.lower())
doc_ref.update({
'total_jobs_completed': Increment(1),
'updated_at': datetime.utcnow()
})
return True
except Exception:
logger.exception(f"Error incrementing jobs completed for {email}")
return False
# Global instance
_user_service = None
def get_user_service() -> UserService:
"""Get the global user service instance."""
global _user_service
if _user_service is None:
_user_service = UserService()
return _user_service
+128
View File
@@ -1606,5 +1606,133 @@ class TestIsUrlFunction:
assert is_url("") is False
class TestUploadEndpointThemeSupport:
"""Test that /jobs/upload endpoint supports theme configuration.
CRITICAL: These tests verify that the /api/jobs/upload endpoint correctly handles
theme_id and color_overrides parameters, ensuring preview videos have themed
backgrounds instead of black backgrounds.
This addresses a bug where:
- The frontend sends theme_id and color_overrides when uploading files
- But the backend /api/jobs/upload endpoint was ignoring these parameters
- Result: Jobs created via file upload had black backgrounds instead of themed ones
"""
def test_upload_endpoint_accepts_theme_id_parameter(self):
"""Verify the upload endpoint has theme_id as a form parameter.
CRITICAL: The frontend sends theme_id when uploading files with a theme.
If this parameter is missing from the endpoint, the theme is silently ignored
and preview videos will have black backgrounds instead of themed ones.
"""
from backend.api.routes import file_upload as file_upload_module
with open(file_upload_module.__file__, 'r') as f:
source_code = f.read()
has_theme_id_param = 'theme_id: Optional[str] = Form(' in source_code
assert has_theme_id_param, (
"file_upload.py /jobs/upload endpoint does not have theme_id as a Form parameter. "
"The frontend sends theme_id when uploading files with a theme, but the backend "
"ignores it. Add: theme_id: Optional[str] = Form(None, description='Theme ID...')"
)
def test_upload_endpoint_accepts_color_overrides_parameter(self):
"""Verify the upload endpoint has color_overrides as a form parameter."""
from backend.api.routes import file_upload as file_upload_module
with open(file_upload_module.__file__, 'r') as f:
source_code = f.read()
has_color_overrides_param = 'color_overrides: Optional[str] = Form(' in source_code
assert has_color_overrides_param, (
"file_upload.py /jobs/upload endpoint does not have color_overrides as a Form parameter. "
"The frontend sends color_overrides when customizing theme colors."
)
def test_upload_endpoint_calls_prepare_theme_for_job(self):
"""Verify the upload endpoint calls _prepare_theme_for_job when theme_id is set.
CRITICAL: When a job is created via the upload endpoint with a theme_id
(and no custom style files), the code must call _prepare_theme_for_job() to set:
1. style_params_gcs_path (pointing to the copied style_params.json)
2. style_assets (populated with asset mappings)
Without this, LyricsTranscriber won't have access to the theme's styles
and preview videos will have black backgrounds instead of themed ones.
"""
from backend.api.routes import file_upload as file_upload_module
with open(file_upload_module.__file__, 'r') as f:
source_code = f.read()
# The function should be called in upload_and_create_job
has_theme_prep_call = '_prepare_theme_for_job(' in source_code
assert has_theme_prep_call, (
"file_upload.py does not call _prepare_theme_for_job(). "
"When theme_id is provided to /jobs/upload without custom style files, "
"the endpoint MUST call _prepare_theme_for_job() to copy the theme's "
"style_params.json to the job folder."
)
def test_upload_endpoint_uses_resolve_cdg_txt_defaults(self):
"""Verify the upload endpoint uses _resolve_cdg_txt_defaults for theme-based defaults."""
from backend.api.routes import file_upload as file_upload_module
with open(file_upload_module.__file__, 'r') as f:
source_code = f.read()
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."
)
def test_upload_endpoint_has_optional_cdg_txt_params(self):
"""Verify enable_cdg and enable_txt are Optional[bool] to support theme defaults.
CRITICAL: If enable_cdg/enable_txt are bool instead of Optional[bool],
they will default to False and override the theme-based defaults.
"""
from backend.api.routes import file_upload as file_upload_module
with open(file_upload_module.__file__, 'r') as f:
source_code = f.read()
has_optional_cdg = 'enable_cdg: Optional[bool] = Form(' in source_code
has_optional_txt = 'enable_txt: Optional[bool] = Form(' in source_code
assert has_optional_cdg, (
"file_upload.py has enable_cdg as bool instead of Optional[bool]. "
"This prevents theme-based defaults from working."
)
assert has_optional_txt, (
"file_upload.py has enable_txt as bool instead of Optional[bool]. "
"This prevents theme-based defaults from working."
)
def test_job_create_includes_theme_id_and_color_overrides(self):
"""Verify JobCreate is called with theme_id and color_overrides."""
from backend.api.routes import file_upload as file_upload_module
with open(file_upload_module.__file__, 'r') as f:
source_code = f.read()
has_theme_id_in_job_create = 'theme_id=theme_id,' in source_code
has_color_overrides_in_job_create = 'color_overrides=parsed_color_overrides' in source_code
assert has_theme_id_in_job_create, (
"file_upload.py does not pass theme_id to JobCreate."
)
assert has_color_overrides_in_job_create, (
"file_upload.py does not pass color_overrides to JobCreate."
)
if __name__ == "__main__":
pytest.main([__file__, "-v"])
+23 -1
View File
@@ -39,11 +39,30 @@ from backend.services.metrics import metrics
# Import from karaoke_gen package
from karaoke_gen.lyrics_processor import LyricsProcessor
from backend.config import get_settings
logger = logging.getLogger(__name__)
def _configure_agentic_ai():
"""Configure environment variables for agentic AI correction.
The lyrics_transcriber library reads these directly from environment.
This ensures the settings from backend config are available.
"""
settings = get_settings()
# Enable agentic AI if configured
if settings.use_agentic_ai:
os.environ["USE_AGENTIC_AI"] = "1"
os.environ["AGENTIC_AI_MODEL"] = settings.agentic_ai_model
logger.info(f"Agentic AI enabled with model: {settings.agentic_ai_model}")
else:
os.environ["USE_AGENTIC_AI"] = "0"
logger.info("Agentic AI disabled")
# Loggers to capture for lyrics worker (top-level package loggers only)
# Note: We only capture at top-level package loggers to avoid duplicate log entries.
# Logs from sub-modules (e.g., lyrics_transcriber.correction.anchor_sequence) will
@@ -119,7 +138,10 @@ async def process_lyrics_transcription(job_id: str) -> bool:
start_time = time.time()
job_manager = JobManager()
storage = StorageService()
# Configure agentic AI before any lyrics processing
_configure_agentic_ai()
# Create job logger for remote debugging FIRST
job_log = create_job_logger(job_id, "lyrics")
+5
View File
@@ -291,11 +291,16 @@ async def generate_video(job_id: str) -> bool:
)
# Store result metadata in job
# NOTE: Must include dropbox_link and gdrive_files from result, since
# _handle_native_distribution already saved them but job.state_data
# is stale (fetched before distribution ran)
job_manager.update_job(job_id, {
'state_data': {
**job.state_data,
'brand_code': result.get('brand_code'),
'youtube_url': result.get('youtube_url'),
'dropbox_link': result.get('dropbox_link'),
'gdrive_files': result.get('gdrive_files'),
}
})
+2
View File
@@ -0,0 +1,2 @@
# API URL for the karaoke backend
NEXT_PUBLIC_API_URL=https://api.nomadkaraoke.com
+38
View File
@@ -0,0 +1,38 @@
# Dependencies
node_modules/
.pnp
.pnp.js
# Build output
.next/
out/
build/
# Debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*
# Local env files
.env
.env.local
.env.development.local
.env.test.local
.env.production.local
# Vercel
.vercel
# IDE
.idea/
.vscode/
*.swp
*.swo
# OS
.DS_Store
Thumbs.db
# TypeScript
*.tsbuildinfo
next-env.d.ts
+99
View File
@@ -0,0 +1,99 @@
@import url('https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700;800&display=swap');
@tailwind base;
@tailwind components;
@tailwind utilities;
:root {
--foreground: #f8fafc;
--background: #0f172a;
}
body {
color: var(--foreground);
background: var(--background);
font-family: 'Inter', system-ui, sans-serif;
}
/* Smooth scrolling */
html {
scroll-behavior: smooth;
}
/* Custom scrollbar for dark theme */
::-webkit-scrollbar {
width: 8px;
}
::-webkit-scrollbar-track {
background: #1e293b;
}
::-webkit-scrollbar-thumb {
background: #475569;
border-radius: 4px;
}
::-webkit-scrollbar-thumb:hover {
background: #64748b;
}
/* Glow effect for primary buttons */
.btn-glow {
box-shadow: 0 0 20px rgba(59, 130, 246, 0.5);
}
.btn-glow:hover {
box-shadow: 0 0 30px rgba(59, 130, 246, 0.7);
}
/* Gradient text */
.gradient-text {
background: linear-gradient(135deg, #3b82f6 0%, #8b5cf6 50%, #ec4899 100%);
-webkit-background-clip: text;
-webkit-text-fill-color: transparent;
background-clip: text;
}
/* Card hover effect */
.card-hover {
transition: transform 0.2s ease, box-shadow 0.2s ease;
}
.card-hover:hover {
transform: translateY(-4px);
box-shadow: 0 20px 40px rgba(0, 0, 0, 0.3);
}
/* Animated background gradient */
@keyframes gradient-shift {
0% {
background-position: 0% 50%;
}
50% {
background-position: 100% 50%;
}
100% {
background-position: 0% 50%;
}
}
.animated-gradient {
background: linear-gradient(-45deg, #0f172a, #1e293b, #1e3a8a, #312e81);
background-size: 400% 400%;
animation: gradient-shift 15s ease infinite;
}
/* Price highlight animation */
@keyframes pulse-subtle {
0%, 100% {
opacity: 1;
}
50% {
opacity: 0.8;
}
}
.pulse-subtle {
animation: pulse-subtle 2s ease-in-out infinite;
}
+45
View File
@@ -0,0 +1,45 @@
import type { Metadata } from 'next';
import './globals.css';
export const metadata: Metadata = {
title: 'Nomad Karaoke - Turn Any Song Into a Karaoke Video',
description: 'Create professional karaoke videos in minutes. AI-powered vocal separation, perfect lyrics sync, and 4K video output.',
keywords: ['karaoke', 'karaoke video', 'karaoke maker', 'vocal removal', 'lyrics sync'],
authors: [{ name: 'Nomad Karaoke' }],
openGraph: {
title: 'Nomad Karaoke - Turn Any Song Into a Karaoke Video',
description: 'Create professional karaoke videos in minutes with AI.',
type: 'website',
url: 'https://buy.nomadkaraoke.com',
images: [
{
url: 'https://gen.nomadkaraoke.com/nomad-logo.png',
width: 512,
height: 512,
alt: 'Nomad Karaoke',
},
],
},
twitter: {
card: 'summary_large_image',
title: 'Nomad Karaoke - Turn Any Song Into a Karaoke Video',
description: 'Create professional karaoke videos in minutes with AI.',
},
};
export default function RootLayout({
children,
}: {
children: React.ReactNode;
}) {
return (
<html lang="en">
<head>
<link rel="icon" href="https://nomadkaraoke.com/favicon.ico" />
</head>
<body className="min-h-screen animated-gradient">
{children}
</body>
</html>
);
}
+585
View File
@@ -0,0 +1,585 @@
'use client';
import { useState } from 'react';
import { Mic2, Music, Sparkles, Video, Youtube, Check, ChevronDown, Mail, Loader2, Gift, MessageSquare, CheckCircle2 } from 'lucide-react';
import { enrollBetaTester } from '../lib/api';
// Credit packages (matching backend)
const CREDIT_PACKAGES = [
{
id: '1_credit',
credits: 1,
price_cents: 500,
name: '1 Credit',
description: 'Create 1 karaoke video',
popular: false,
},
{
id: '3_credits',
credits: 3,
price_cents: 1200,
name: '3 Credits',
description: 'Save 20%',
popular: false,
},
{
id: '5_credits',
credits: 5,
price_cents: 1750,
name: '5 Credits',
description: 'Save 30%',
popular: true,
},
{
id: '10_credits',
credits: 10,
price_cents: 3000,
name: '10 Credits',
description: 'Save 40%',
popular: false,
},
];
const API_BASE_URL = process.env.NEXT_PUBLIC_API_URL || 'https://api.nomadkaraoke.com';
function formatPrice(cents: number): string {
return `$${(cents / 100).toFixed(0)}`;
}
function pricePerCredit(priceCents: number, credits: number): string {
return `$${(priceCents / 100 / credits).toFixed(2)}`;
}
export default function Home() {
const [selectedPackage, setSelectedPackage] = useState(CREDIT_PACKAGES[2]); // Default to 5 credits
const [email, setEmail] = useState('');
const [isLoading, setIsLoading] = useState(false);
const [error, setError] = useState('');
const [expandedFaq, setExpandedFaq] = useState<number | null>(null);
// Beta tester form state
const [showBetaForm, setShowBetaForm] = useState(false);
const [betaEmail, setBetaEmail] = useState('');
const [betaPromise, setBetaPromise] = useState('');
const [betaAcceptCorrections, setBetaAcceptCorrections] = useState(false);
const [betaLoading, setBetaLoading] = useState(false);
const [betaError, setBetaError] = useState('');
const [betaSuccess, setBetaSuccess] = useState(false);
const handleBetaEnroll = async (e: React.FormEvent) => {
e.preventDefault();
setBetaError('');
if (!betaEmail) {
setBetaError('Please enter your email');
return;
}
if (!betaAcceptCorrections) {
setBetaError('Please accept that you may need to review/correct lyrics');
return;
}
if (betaPromise.trim().length < 10) {
setBetaError('Please write a sentence confirming your promise to provide feedback');
return;
}
setBetaLoading(true);
try {
const response = await enrollBetaTester(betaEmail.toLowerCase(), betaPromise, betaAcceptCorrections);
// Store the session token
if (response.session_token) {
localStorage.setItem('nomad_karaoke_token', response.session_token);
}
setBetaSuccess(true);
// Redirect to the main app after a short delay
setTimeout(() => {
window.location.href = 'https://gen.nomadkaraoke.com';
}, 2000);
} catch (err) {
setBetaError(err instanceof Error ? err.message : 'Something went wrong');
setBetaLoading(false);
}
};
const handleCheckout = async (e: React.FormEvent) => {
e.preventDefault();
setError('');
if (!email) {
setError('Please enter your email');
return;
}
setIsLoading(true);
try {
const response = await fetch(`${API_BASE_URL}/api/users/credits/checkout`, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
package_id: selectedPackage.id,
email: email.toLowerCase(),
}),
});
if (!response.ok) {
const data = await response.json();
throw new Error(data.detail || 'Failed to create checkout');
}
const data = await response.json();
window.location.href = data.checkout_url;
} catch (err) {
setError(err instanceof Error ? err.message : 'Something went wrong');
setIsLoading(false);
}
};
const faqs = [
{
q: 'How does it work?',
a: 'Just enter a song (artist + title), and our AI finds the audio, removes the vocals, transcribes the lyrics, and creates a professional karaoke video with perfectly synced lyrics.',
},
{
q: 'What songs can I use?',
a: "Most popular songs are available. We search multiple high-quality audio sources to find the best version. If we can't find a song, you won't be charged.",
},
{
q: 'What format is the output?',
a: 'You get a high-quality MP4 video file (up to 4K) with the instrumental audio and synchronized lyrics. You can also upload directly to YouTube.',
},
{
q: 'What if something goes wrong?',
a: "We offer generous refunds. If the quality isn't what you expected or there's an issue with the output, contact us and we'll refund your credit.",
},
{
q: 'Do credits expire?',
a: 'No, your credits never expire. Use them whenever you want.',
},
];
return (
<div className="min-h-screen">
{/* Navigation */}
<nav className="fixed top-0 left-0 right-0 z-50 bg-dark-900/80 backdrop-blur-md border-b border-dark-700">
<div className="max-w-6xl mx-auto px-4 py-4 flex items-center justify-between">
<div className="flex items-center gap-2">
<Mic2 className="w-8 h-8 text-primary-500" />
<span className="text-xl font-bold">Nomad Karaoke</span>
</div>
<a
href="https://gen.nomadkaraoke.com"
className="text-sm text-dark-300 hover:text-white transition-colors"
>
Already have credits? Sign in
</a>
</div>
</nav>
{/* Hero Section */}
<section className="pt-32 pb-16 px-4">
<div className="max-w-4xl mx-auto text-center">
<h1 className="text-4xl sm:text-5xl md:text-6xl font-extrabold mb-6 leading-tight">
Turn Any Song Into a{' '}
<span className="gradient-text">Karaoke Video</span>
</h1>
<p className="text-xl text-dark-300 mb-8 max-w-2xl mx-auto">
Professional karaoke videos in minutes. AI-powered vocal removal,
perfect lyrics sync, and stunning video output.
</p>
<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"
>
Get Started
<ChevronDown className="w-5 h-5" />
</a>
</div>
</section>
{/* How It Works */}
<section className="py-16 px-4">
<div className="max-w-6xl mx-auto">
<h2 className="text-3xl font-bold text-center mb-12">How It Works</h2>
<div className="grid md:grid-cols-4 gap-8">
{[
{
icon: Music,
title: 'Search',
desc: 'Enter artist & song title',
},
{
icon: Sparkles,
title: 'AI Magic',
desc: 'We remove vocals & sync lyrics',
},
{
icon: Video,
title: 'Review',
desc: 'Preview and fine-tune',
},
{
icon: Youtube,
title: 'Export',
desc: 'Download or upload to YouTube',
},
].map((step, i) => (
<div key={i} className="text-center">
<div className="w-16 h-16 bg-primary-500/20 rounded-2xl flex items-center justify-center mx-auto mb-4">
<step.icon className="w-8 h-8 text-primary-400" />
</div>
<h3 className="font-semibold text-lg mb-2">{step.title}</h3>
<p className="text-dark-400 text-sm">{step.desc}</p>
</div>
))}
</div>
</div>
</section>
{/* Features */}
<section className="py-16 px-4 bg-dark-800/50">
<div className="max-w-6xl mx-auto">
<h2 className="text-3xl font-bold text-center mb-12">What You Get</h2>
<div className="grid md:grid-cols-3 gap-6">
{[
{
title: 'Studio-Quality Separation',
desc: 'State-of-the-art AI removes vocals cleanly, keeping the instrumental crisp.',
},
{
title: 'Perfect Lyrics Sync',
desc: 'Word-by-word timing that highlights exactly when to sing.',
},
{
title: 'Multiple Instrumental Options',
desc: 'Choose from different vocal removal levels to get the sound you want.',
},
{
title: '4K Video Output',
desc: 'Stunning video quality that looks great on any screen.',
},
{
title: 'YouTube Integration',
desc: 'Upload directly to your YouTube channel with one click.',
},
{
title: 'Edit Before Export',
desc: 'Fix any lyrics issues before generating your final video.',
},
].map((feature, i) => (
<div
key={i}
className="bg-dark-800 border border-dark-700 rounded-xl p-6 card-hover"
>
<h3 className="font-semibold text-lg mb-2">{feature.title}</h3>
<p className="text-dark-400 text-sm">{feature.desc}</p>
</div>
))}
</div>
</div>
</section>
{/* Beta Tester Promo */}
<section className="py-12 px-4">
<div className="max-w-2xl mx-auto">
{!showBetaForm && !betaSuccess ? (
<div className="bg-gradient-to-r from-purple-900/40 to-pink-900/40 border border-purple-500/30 rounded-2xl p-8 text-center">
<div className="inline-flex items-center gap-2 bg-purple-500/20 text-purple-300 px-4 py-2 rounded-full text-sm font-medium mb-4">
<Gift className="w-4 h-4" />
Beta Tester Program
</div>
<h3 className="text-2xl font-bold mb-3">Try It Free!</h3>
<p className="text-dark-300 mb-6">
Help us improve by testing the tool and sharing your feedback.
Get a <span className="text-green-400 font-semibold">free credit</span> to create your first karaoke video!
</p>
<button
onClick={() => setShowBetaForm(true)}
className="inline-flex items-center gap-2 bg-purple-500 hover:bg-purple-600 text-white font-semibold px-6 py-3 rounded-xl transition-all"
>
Join Beta Program
<MessageSquare className="w-5 h-5" />
</button>
</div>
) : betaSuccess ? (
<div className="bg-green-900/30 border border-green-500/30 rounded-2xl p-8 text-center">
<CheckCircle2 className="w-16 h-16 text-green-400 mx-auto mb-4" />
<h3 className="text-2xl font-bold mb-3 text-green-400">Welcome to the Beta!</h3>
<p className="text-dark-300 mb-4">
You&apos;ve got 1 free credit! Redirecting you to create your first karaoke video...
</p>
<Loader2 className="w-6 h-6 animate-spin mx-auto text-green-400" />
</div>
) : (
<div className="bg-dark-800 border border-purple-500/30 rounded-2xl p-8">
<div className="flex items-center justify-between mb-6">
<div className="inline-flex items-center gap-2 bg-purple-500/20 text-purple-300 px-4 py-2 rounded-full text-sm font-medium">
<Gift className="w-4 h-4" />
Beta Tester Signup
</div>
<button
onClick={() => setShowBetaForm(false)}
className="text-dark-400 hover:text-white transition-colors text-sm"
>
Cancel
</button>
</div>
<h3 className="text-xl font-bold mb-2">Get 1 Free Credit</h3>
<p className="text-dark-400 text-sm mb-6">
In exchange for your honest feedback after trying the tool.
</p>
<form onSubmit={handleBetaEnroll} className="space-y-4">
<div>
<label htmlFor="beta-email" className="block text-sm font-medium text-dark-300 mb-2">
Email address
</label>
<div className="relative">
<Mail className="absolute left-3 top-1/2 -translate-y-1/2 w-5 h-5 text-dark-500" />
<input
type="email"
id="beta-email"
value={betaEmail}
onChange={(e) => setBetaEmail(e.target.value)}
placeholder="you@example.com"
className="w-full pl-10 pr-4 py-3 bg-dark-900 border border-dark-600 rounded-lg focus:outline-none focus:ring-2 focus:ring-purple-500 focus:border-transparent text-white placeholder-dark-500"
required
/>
</div>
</div>
<div className="bg-dark-900/50 border border-dark-700 rounded-lg p-4">
<h4 className="font-medium mb-3 text-sm">Your Promise</h4>
<label className="flex items-start gap-3 cursor-pointer mb-4">
<input
type="checkbox"
checked={betaAcceptCorrections}
onChange={(e) => setBetaAcceptCorrections(e.target.checked)}
className="mt-1 w-4 h-4 rounded border-dark-600 bg-dark-800 text-purple-500 focus:ring-purple-500 focus:ring-offset-dark-900"
/>
<span className="text-sm text-dark-300">
I understand I may need to review and correct lyrics timing to get the best results
</span>
</label>
<div>
<label htmlFor="promise" className="block text-sm text-dark-400 mb-2">
Write a quick sentence promising to share feedback after you try it:
</label>
<textarea
id="promise"
value={betaPromise}
onChange={(e) => setBetaPromise(e.target.value)}
placeholder="I promise to share my honest feedback about my experience..."
rows={2}
className="w-full px-4 py-3 bg-dark-800 border border-dark-600 rounded-lg focus:outline-none focus:ring-2 focus:ring-purple-500 focus:border-transparent text-white placeholder-dark-500 text-sm resize-none"
/>
</div>
</div>
{betaError && (
<div className="text-red-400 text-sm bg-red-400/10 border border-red-400/20 rounded-lg p-3">
{betaError}
</div>
)}
<button
type="submit"
disabled={betaLoading}
className="w-full bg-purple-500 hover:bg-purple-600 disabled:bg-purple-500/50 text-white font-semibold py-4 rounded-xl transition-all flex items-center justify-center gap-2"
>
{betaLoading ? (
<>
<Loader2 className="w-5 h-5 animate-spin" />
Enrolling...
</>
) : (
<>
Get My Free Credit
<Gift className="w-5 h-5" />
</>
)}
</button>
<p className="text-xs text-dark-500 text-center">
We&apos;ll send you a feedback form after your video is created.
Your feedback helps us improve the tool for everyone!
</p>
</form>
</div>
)}
</div>
</section>
{/* Pricing */}
<section id="pricing" className="py-20 px-4">
<div className="max-w-4xl mx-auto">
<h2 className="text-3xl font-bold text-center mb-4">Simple Pricing</h2>
<p className="text-dark-400 text-center mb-12 max-w-xl mx-auto">
One credit = one karaoke video. Buy more to save more.
</p>
{/* Package Selection */}
<div className="grid grid-cols-2 md:grid-cols-4 gap-4 mb-8">
{CREDIT_PACKAGES.map((pkg) => (
<button
key={pkg.id}
onClick={() => setSelectedPackage(pkg)}
className={`relative p-4 rounded-xl border-2 transition-all ${
selectedPackage.id === pkg.id
? 'border-primary-500 bg-primary-500/10'
: 'border-dark-700 hover:border-dark-500 bg-dark-800/50'
}`}
>
{pkg.popular && (
<span className="absolute -top-3 left-1/2 -translate-x-1/2 bg-primary-500 text-white text-xs font-semibold px-3 py-1 rounded-full">
Best Value
</span>
)}
<div className="text-2xl font-bold mb-1">{pkg.credits}</div>
<div className="text-sm text-dark-400 mb-2">
{pkg.credits === 1 ? 'credit' : 'credits'}
</div>
<div className="text-xl font-semibold text-primary-400">
{formatPrice(pkg.price_cents)}
</div>
<div className="text-xs text-dark-500">
{pricePerCredit(pkg.price_cents, pkg.credits)}/video
</div>
{pkg.credits > 1 && (
<div className="text-xs text-green-400 mt-1">{pkg.description}</div>
)}
</button>
))}
</div>
{/* Checkout Form */}
<div className="bg-dark-800 border border-dark-700 rounded-2xl p-8 max-w-md mx-auto">
<div className="text-center mb-6">
<div className="text-sm text-dark-400 mb-1">Selected package</div>
<div className="text-2xl font-bold">
{selectedPackage.credits} {selectedPackage.credits === 1 ? 'Credit' : 'Credits'}
</div>
<div className="text-3xl font-bold text-primary-400">
{formatPrice(selectedPackage.price_cents)}
</div>
</div>
<form onSubmit={handleCheckout} className="space-y-4">
<div>
<label htmlFor="email" className="block text-sm font-medium text-dark-300 mb-2">
Email address
</label>
<div className="relative">
<Mail className="absolute left-3 top-1/2 -translate-y-1/2 w-5 h-5 text-dark-500" />
<input
type="email"
id="email"
value={email}
onChange={(e) => setEmail(e.target.value)}
placeholder="you@example.com"
className="w-full pl-10 pr-4 py-3 bg-dark-900 border border-dark-600 rounded-lg focus:outline-none focus:ring-2 focus:ring-primary-500 focus:border-transparent text-white placeholder-dark-500"
required
/>
</div>
<p className="text-xs text-dark-500 mt-2">
We&apos;ll send your login link to this email
</p>
</div>
{error && (
<div className="text-red-400 text-sm bg-red-400/10 border border-red-400/20 rounded-lg p-3">
{error}
</div>
)}
<button
type="submit"
disabled={isLoading}
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"
>
{isLoading ? (
<>
<Loader2 className="w-5 h-5 animate-spin" />
Redirecting to checkout...
</>
) : (
<>
Continue to Payment
<Check className="w-5 h-5" />
</>
)}
</button>
</form>
<div className="mt-4 flex items-center justify-center gap-4 text-xs text-dark-500">
<span>Secure checkout</span>
<span>powered by Stripe</span>
</div>
</div>
</div>
</section>
{/* FAQ */}
<section className="py-16 px-4 bg-dark-800/50">
<div className="max-w-2xl mx-auto">
<h2 className="text-3xl font-bold text-center mb-12">Questions?</h2>
<div className="space-y-4">
{faqs.map((faq, i) => (
<div
key={i}
className="bg-dark-800 border border-dark-700 rounded-xl overflow-hidden"
>
<button
onClick={() => setExpandedFaq(expandedFaq === i ? null : i)}
className="w-full px-6 py-4 text-left flex items-center justify-between hover:bg-dark-700/50 transition-colors"
>
<span className="font-medium">{faq.q}</span>
<ChevronDown
className={`w-5 h-5 text-dark-400 transition-transform ${
expandedFaq === i ? 'rotate-180' : ''
}`}
/>
</button>
{expandedFaq === i && (
<div className="px-6 pb-4 text-dark-400">{faq.a}</div>
)}
</div>
))}
</div>
</div>
</section>
{/* Footer */}
<footer className="py-12 px-4 border-t border-dark-700">
<div className="max-w-6xl mx-auto flex flex-col md:flex-row items-center justify-between gap-4">
<div className="flex items-center gap-2">
<Mic2 className="w-6 h-6 text-primary-500" />
<span className="font-semibold">Nomad Karaoke</span>
</div>
<div className="text-sm text-dark-500">
&copy; {new Date().getFullYear()} Nomad Karaoke. All rights reserved.
</div>
<div className="flex gap-6 text-sm text-dark-400">
<a href="mailto:support@nomadkaraoke.com" className="hover:text-white transition-colors">
Support
</a>
<a href="https://nomadkaraoke.com" className="hover:text-white transition-colors">
About
</a>
</div>
</div>
</footer>
</div>
);
}
+120
View File
@@ -0,0 +1,120 @@
/**
* API client for the Nomad Karaoke backend.
*/
const API_BASE_URL = process.env.NEXT_PUBLIC_API_URL || 'https://api.nomadkaraoke.com';
export interface CreditPackage {
id: string;
credits: number;
price_cents: number;
name: string;
description: string;
}
export interface CreditPackagesResponse {
packages: CreditPackage[];
}
export interface CheckoutResponse {
status: string;
checkout_url: string;
message: string;
}
/**
* Fetch available credit packages.
*/
export async function getCreditPackages(): Promise<CreditPackage[]> {
const response = await fetch(`${API_BASE_URL}/api/users/credits/packages`);
if (!response.ok) {
throw new Error('Failed to fetch credit packages');
}
const data: CreditPackagesResponse = await response.json();
return data.packages;
}
/**
* Create a Stripe checkout session.
*/
export async function createCheckout(packageId: string, email: string): Promise<string> {
const response = await fetch(`${API_BASE_URL}/api/users/credits/checkout`, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
package_id: packageId,
email: email,
}),
});
if (!response.ok) {
const error = await response.json();
throw new Error(error.detail || 'Failed to create checkout session');
}
const data: CheckoutResponse = await response.json();
return data.checkout_url;
}
/**
* Format price from cents to display string.
*/
export function formatPrice(cents: number): string {
return `$${(cents / 100).toFixed(2)}`;
}
/**
* Calculate per-credit price.
*/
export function pricePerCredit(pkg: CreditPackage): number {
return pkg.price_cents / pkg.credits;
}
// ============================================================================
// Beta Tester Program
// ============================================================================
export interface BetaEnrollRequest {
email: string;
promise_text: string;
accept_corrections_work: boolean;
}
export interface BetaEnrollResponse {
status: string;
message: string;
credits_granted: number;
session_token: string | null;
}
/**
* Enroll as a beta tester to receive free credits.
*/
export async function enrollBetaTester(
email: string,
promiseText: string,
acceptCorrectionsWork: boolean
): Promise<BetaEnrollResponse> {
const response = await fetch(`${API_BASE_URL}/api/users/beta/enroll`, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
email: email,
promise_text: promiseText,
accept_corrections_work: acceptCorrectionsWork,
}),
});
if (!response.ok) {
const error = await response.json();
throw new Error(error.detail || 'Failed to enroll in beta program');
}
return response.json();
}
+13
View File
@@ -0,0 +1,13 @@
/** @type {import('next').NextConfig} */
const nextConfig = {
output: 'export',
trailingSlash: true,
images: {
unoptimized: true,
},
// For GitHub Pages deployment
basePath: '',
assetPrefix: '',
};
export default nextConfig;
+27
View File
@@ -0,0 +1,27 @@
{
"name": "buy-nomadkaraoke",
"version": "1.0.0",
"private": true,
"description": "Landing page and payment flow for Nomad Karaoke",
"scripts": {
"dev": "next dev",
"build": "next build",
"start": "next start",
"lint": "next lint"
},
"dependencies": {
"next": "^15.0.0",
"react": "^19.0.0",
"react-dom": "^19.0.0",
"lucide-react": "^0.468.0"
},
"devDependencies": {
"@types/node": "^22.0.0",
"@types/react": "^19.0.0",
"@types/react-dom": "^19.0.0",
"typescript": "^5.0.0",
"tailwindcss": "^3.4.0",
"postcss": "^8.4.0",
"autoprefixer": "^10.4.0"
}
}
+9
View File
@@ -0,0 +1,9 @@
/** @type {import('postcss-load-config').Config} */
const config = {
plugins: {
tailwindcss: {},
autoprefixer: {},
},
};
export default config;
+43
View File
@@ -0,0 +1,43 @@
/** @type {import('tailwindcss').Config} */
module.exports = {
content: [
'./app/**/*.{js,ts,jsx,tsx,mdx}',
'./components/**/*.{js,ts,jsx,tsx,mdx}',
],
theme: {
extend: {
colors: {
// Match the existing karaoke-gen dark theme
primary: {
50: '#eff6ff',
100: '#dbeafe',
200: '#bfdbfe',
300: '#93c5fd',
400: '#60a5fa',
500: '#3b82f6',
600: '#2563eb',
700: '#1d4ed8',
800: '#1e40af',
900: '#1e3a8a',
},
dark: {
50: '#f8fafc',
100: '#f1f5f9',
200: '#e2e8f0',
300: '#cbd5e1',
400: '#94a3b8',
500: '#64748b',
600: '#475569',
700: '#334155',
800: '#1e293b',
900: '#0f172a',
950: '#020617',
},
},
fontFamily: {
sans: ['Inter', 'system-ui', 'sans-serif'],
},
},
},
plugins: [],
};
+26
View File
@@ -0,0 +1,26 @@
{
"compilerOptions": {
"lib": ["dom", "dom.iterable", "esnext"],
"allowJs": true,
"skipLibCheck": true,
"strict": true,
"noEmit": true,
"esModuleInterop": true,
"module": "esnext",
"moduleResolution": "bundler",
"resolveJsonModule": true,
"isolatedModules": true,
"jsx": "preserve",
"incremental": true,
"plugins": [
{
"name": "next"
}
],
"paths": {
"@/*": ["./*"]
}
},
"include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
"exclude": ["node_modules"]
}
+100 -1
View File
@@ -174,10 +174,109 @@ Common status codes:
- `404` - Job not found
- `500` - Server error
## User Authentication (PR #90)
### Send Magic Link
```http
POST /api/users/auth/magic-link
Content-Type: application/json
{"email": "user@example.com"}
```
### Verify Magic Link
```http
GET /api/users/auth/verify?token=TOKEN
```
Returns session token and user info.
### Get Current User
```http
GET /api/users/me
Authorization: Bearer SESSION_TOKEN
```
### Logout
```http
POST /api/users/auth/logout
Authorization: Bearer SESSION_TOKEN
```
## Credits & Payments (PR #90)
### List Credit Packages
```http
GET /api/users/credits/packages
```
No auth required. Returns available packages and prices.
### Create Checkout Session
```http
POST /api/users/credits/checkout
Content-Type: application/json
{"package_id": "5_credits", "email": "user@example.com"}
```
Returns Stripe checkout URL.
### Stripe Webhook
```http
POST /api/users/webhooks/stripe
```
Handles `checkout.session.completed` events.
## Beta Tester Program (PR #90)
### Enroll as Beta Tester
```http
POST /api/users/beta/enroll
Content-Type: application/json
{
"email": "user@example.com",
"promise_text": "I promise to provide feedback...",
"accept_corrections_work": true
}
```
Returns 1 free credit and session token.
### Submit Feedback
```http
POST /api/users/beta/feedback
Authorization: Bearer SESSION_TOKEN
Content-Type: application/json
{
"overall_rating": 4,
"ease_of_use_rating": 5,
"lyrics_accuracy_rating": 4,
"correction_experience_rating": 3,
"what_went_well": "...",
"what_could_improve": "..."
}
```
Bonus credit for detailed feedback (50+ chars).
## Rate Limits
No rate limits currently implemented.
## Webhooks
Not yet implemented. Jobs must be polled for status.
Stripe webhooks implemented at `/api/users/webhooks/stripe`.
Job status webhooks not yet implemented.
+1
View File
@@ -148,6 +148,7 @@ LyricsTranscriber LyricsTranscriber
|---------|---------|----------|
| Modal | GPU audio separation | Yes |
| AudioShake | Lyrics transcription | Yes |
| Vertex AI | Agentic AI correction (Gemini 3 Flash) | Default on |
| Genius | Reference lyrics | Yes |
| YouTube API | Video upload | Optional |
+159
View File
@@ -34,6 +34,26 @@ Audio separation and lyrics transcription run in parallel:
## Common Gotchas
### Frontend Polling vs Tab Visibility
**Problem**: After completing review in a new tab (lyrics or instrumental selection), returning to the main frontend showed stale status for up to 10 seconds due to polling interval.
**Solution**: Use `visibilitychange` event to trigger immediate refresh when tab becomes visible:
```typescript
useEffect(() => {
const handleVisibilityChange = () => {
if (document.visibilityState === 'visible') {
loadJobs() // Immediate refresh
}
}
document.addEventListener('visibilitychange', handleVisibilityChange)
return () => document.removeEventListener('visibilitychange', handleVisibilityChange)
}, [loadJobs])
```
**Key insight**: Backend status updates are fast (~1 second). If UI appears slow to update after user action in another tab, the issue is likely frontend polling, not backend.
### Pydantic Model Fields
**Problem**: Setting a field that doesn't exist in the Pydantic model silently does nothing.
@@ -94,6 +114,73 @@ if job.input_media_gcs_path:
await trigger_worker()
```
### Stale Object References After Async Operations
**Problem**: Fetching a job object, then calling async functions that update the job in the database, then using the original object's data to make another update - this overwrites the async function's changes.
```python
# BAD - loses distribution results
job = job_manager.get_job(job_id) # Fetch job
await _handle_native_distribution(...) # Updates job.state_data in DB
job_manager.update_job(job_id, {
'state_data': {**job.state_data, 'foo': 'bar'} # STALE! Overwrites dropbox_link!
})
```
**Solution**: Either re-fetch the job, or include async results explicitly:
```python
# GOOD - include results from async operation
job_manager.update_job(job_id, {
'state_data': {
**job.state_data,
'dropbox_link': result.get('dropbox_link'), # From distribution
'gdrive_files': result.get('gdrive_files'),
}
})
```
### Google Drive API Query Escaping
**Problem**: Single quotes in filenames break Google Drive API queries.
```python
# BAD - fails for "Nobody's Home"
query = f"name='{filename}' and '{parent_id}' in parents"
# Results in: name='NOMAD-1187 - Artist - Nobody's Home.mp4' → 400 Invalid Value
```
**Solution**: Escape single quotes with backslash:
```python
# GOOD
escaped = filename.replace("'", "\\'")
query = f"name='{escaped}' and '{parent_id}' in parents"
```
### Duplicate Code Leads to Inconsistent Behavior
**Problem**: Multiple endpoints computing the same defaults independently. `audio_search.py` had `effective_brand_prefix = body.brand_prefix or settings.default_brand_prefix` but `file_upload.py` was missing it for some endpoints.
**Result**: Jobs created via audio search had correct brand codes; jobs created via file upload had null brand_prefix, causing Dropbox uploads to fail and Google Drive uploads to use placeholder "TRACK-0000".
**Solution**: Added `_get_effective_distribution_settings()` helper function in `file_upload.py` to centralize default computation:
```python
@dataclass
class EffectiveDistributionSettings:
dropbox_path: Optional[str]
gdrive_folder_id: Optional[str]
discord_webhook_url: Optional[str]
brand_prefix: Optional[str]
def _get_effective_distribution_settings(...) -> EffectiveDistributionSettings:
settings = get_settings()
return EffectiveDistributionSettings(
dropbox_path=dropbox_path or settings.default_dropbox_path,
# ... etc
)
```
**Lesson**: When you see the same logic repeated in multiple places, refactor into a helper function immediately. Otherwise bugs will be fixed in one place but not others.
## Testing Insights
### Emulator Tests Catch Real Bugs
@@ -106,6 +193,25 @@ Unit tests with mocks didn't catch the `input_media_gcs_path` bug. Emulator inte
Emulator tests need their own `conftest.py` that does NOT mock `google.cloud.*`. Mocks from unit tests can leak into integration tests.
### Playwright: Use Assertions, Not Timeouts
**Problem**: `waitForTimeout()` is flaky and slow:
```typescript
// BAD - arbitrary wait, still flaky
await page.waitForTimeout(2000);
const hasContent = await page.locator('.content').count();
```
**Solution**: Use Playwright's auto-retry assertions:
```typescript
// GOOD - waits only until condition met, retries automatically
await expect(page.getByText('Hello,')).toBeVisible({ timeout: 5000 });
```
**Why it matters**: Playwright assertions have built-in retry logic and fail fast when conditions aren't met. Arbitrary timeouts either waste time (waiting when condition is already met) or cause flaky tests (not waiting long enough on slow CI).
## Deployment Notes
### Cloud Run Timeouts
@@ -119,6 +225,15 @@ Default 5-minute timeout may not be enough for video encoding. Consider:
Cloud Run service account needs `Secret Manager Secret Accessor` role. This is managed via Pulumi in `infrastructure/`.
### Vertex AI Authentication
For Gemini via Vertex AI, use Application Default Credentials (ADC) rather than API keys:
- **Cloud Run**: Service account automatically authenticated - just grant `roles/aiplatform.user`
- **Local dev**: Run `gcloud auth application-default login`
- **Config**: Set `GOOGLE_CLOUD_PROJECT` and optionally `GCP_LOCATION` (defaults to `us-central1`)
This approach uses GCP's free credits and existing IAM rather than separate API key management.
### CI/CD: GitHub Actions
Migrated from Cloud Build to GitHub Actions for:
@@ -126,6 +241,19 @@ Migrated from Cloud Build to GitHub Actions for:
- Better visibility
- Faster feedback
### Self-Hosted Runner on GCP
GitHub-hosted runners have ~14GB disk, which caused failures during Docker builds. Solution: self-hosted runner on GCP with 200GB SSD.
**Key learnings:**
1. **GPG in startup scripts**: Always use `gpg --batch` for non-interactive execution
2. **setup-python on self-hosted**: Needs Python in tool cache at `$RUNNER/_work/_tool/Python/<version>/x64/` with `x64.complete` marker
3. **Debian vs Ubuntu**: PPAs don't work on Debian; use upstream repos (Temurin, NodeSource)
4. **pyenv for Python**: More reliable than source builds or distro packages for specific versions
See `docs/archive/2025-12-28-self-hosted-github-runner.md` for full details.
## Performance Observations
| Operation | Duration |
@@ -140,6 +268,35 @@ Migrated from Cloud Build to GitHub Actions for:
Human review time varies (5-15 min typical).
### Gitignore Patterns for Monorepos
**Problem**: Root `.gitignore` had `lib/` to ignore Python lib directories, but this also ignored `buy-site/lib/` (frontend code).
**Solution**: Use negation patterns for frontend directories:
```gitignore
# Python lib directories
lib/
lib64/
# But allow frontend lib directories
!frontend/lib/
!buy-site/lib/
```
**Lesson**: When adding gitignore patterns, consider their effect on subdirectories, especially in monorepos with multiple languages.
### Firestore Transactions for Race Conditions
**Problem**: Magic link verification had a race condition - concurrent requests could both verify the same token before it was marked as used.
**Solution**: Use Firestore transactions for atomic read-check-update operations:
```python
@firestore.transactional
def verify_in_transaction(transaction):
doc = doc_ref.get(transaction=transaction)
# Check conditions...
transaction.update(doc_ref, {'used': True})
```
## What We'd Do Differently
1. **Add Pydantic model fields test first** - Would have caught the silent field issue immediately
@@ -149,3 +306,5 @@ Human review time varies (5-15 min typical).
3. **Design for async human review upfront** - Avoided rearchitecting after discovering ReviewServer blocks
4. **Keep docs minimal and current** - Less documentation, but always accurate
5. **Check gitignore early for new directories** - Especially when adding frontend `lib/` directories
+318
View File
@@ -0,0 +1,318 @@
# Mobile UX Best Practices
This document outlines the mobile-first UX principles and implementation patterns used in this project to ensure a great experience across all screen sizes.
## Core Principles
### 1. Mobile-First Responsive Design
Design for the smallest screen first, then progressively enhance for larger screens.
```css
/* Base styles for mobile */
.element {
width: 100%;
padding: 12px;
}
/* Enhance for larger screens */
@media (min-width: 640px) {
.element {
width: 280px;
padding: 16px;
}
}
```
### 2. No Horizontal Overflow
The most critical mobile UX issue is horizontal scrolling. Always ensure content fits within the viewport width.
**Testing for overflow:**
```typescript
async function hasNoHorizontalOverflow(page: Page): Promise<boolean> {
return await page.evaluate(() => {
const docWidth = document.documentElement.scrollWidth;
const viewportWidth = window.innerWidth;
return docWidth <= viewportWidth + 2; // Small tolerance for rounding
});
}
```
**Common causes of horizontal overflow:**
- Fixed widths (e.g., `width: 340px`)
- Horizontal flex layouts without wrapping
- Images without `max-width: 100%`
- Tables without horizontal scroll containers
### 3. Touch Target Sizing
Interactive elements must be easily tappable. Follow these minimum sizes:
| Platform | Minimum Size | Recommended |
|----------|--------------|-------------|
| Apple iOS | 44x44px | 48x48px |
| Material Design | 48x48px | 48x48px |
| Web (general) | 32x32px | 44x44px |
**Implementation:**
```tsx
<Button className="min-h-[44px] px-3">
<Icon className="w-4 h-4" />
<span className="hidden sm:inline">Label</span>
</Button>
```
### 4. Progressive Disclosure
Show less content on mobile, with clear paths to access more:
- **Icon-only buttons on mobile, labels on desktop:**
```tsx
<Icon className="w-4 h-4 sm:mr-2" />
<span className="hidden sm:inline">Action Label</span>
```
- **Collapsed navigation on mobile**
- **Truncated text with expansion options**
## Layout Patterns
### Responsive Grid
Use responsive grid columns that stack on mobile:
```tsx
// Bad - always 2 columns
<div className="grid grid-cols-2 gap-4">
// Good - stack on mobile, 2 columns on larger screens
<div className="grid grid-cols-1 sm:grid-cols-2 gap-3 sm:gap-4">
```
### Flexible Containers
Avoid fixed widths. Use percentage-based or responsive widths:
```css
/* Bad */
.sidebar {
width: 340px;
}
/* Good */
.sidebar {
width: 100%;
}
@media (min-width: 768px) {
.sidebar {
width: 340px;
}
}
```
### Flex Wrap for Toolbars
Allow toolbar items to wrap on smaller screens:
```tsx
<div className="flex flex-wrap gap-2 items-center">
{/* Items will wrap naturally */}
</div>
```
## Typography
### Readable Font Sizes
Minimum font sizes for readability without zooming:
| Element | Minimum Size | Recommended |
|---------|--------------|-------------|
| Body text | 14px | 16px |
| Labels | 12px | 14px |
| Small text/badges | 11px | 12px |
### Responsive Headings
```tsx
<h1 className="text-base sm:text-xl font-bold truncate">
Title Text
</h1>
```
## Form Design
### Input Fields on Mobile
- Stack form fields vertically on mobile
- Use full-width inputs for easier tapping
- Ensure proper input type for mobile keyboard optimization
```tsx
<input
type="email" // Shows email keyboard
inputMode="numeric" // Shows number pad
className="w-full min-h-[44px]"
/>
```
### Labels and Placeholders
- Labels should be visible (not just placeholders)
- Adequate spacing between label and input
- Clear validation feedback
## Testing Strategy
### Automated Testing with Playwright
Test across multiple viewport sizes representing real devices:
```typescript
const MOBILE_VIEWPORTS = {
'iPhone SE': { width: 375, height: 667 },
'iPhone 14': { width: 390, height: 844 },
'Pixel 7': { width: 412, height: 915 },
'iPad Mini': { width: 768, height: 1024 },
};
for (const [name, viewport] of Object.entries(MOBILE_VIEWPORTS)) {
test(`page works on ${name}`, async ({ page }) => {
await page.setViewportSize(viewport);
await page.goto('/');
// Test for horizontal overflow
const hasOverflow = await page.evaluate(() =>
document.documentElement.scrollWidth > window.innerWidth + 2
);
expect(hasOverflow).toBe(false);
});
}
```
### Visual Regression Testing
Capture screenshots at different viewports to catch visual regressions:
```typescript
await expect(page).toHaveScreenshot(`homepage-${deviceName}.png`, {
fullPage: true,
maxDiffPixelRatio: 0.1,
});
```
### Touch Target Validation
```typescript
const buttons = page.locator('button, a, [role="button"]');
for (const button of await buttons.all()) {
const box = await button.boundingBox();
if (box) {
expect(box.width).toBeGreaterThanOrEqual(32);
expect(box.height).toBeGreaterThanOrEqual(32);
}
}
```
## Framework-Specific Guidelines
### Tailwind CSS (Next.js Frontend)
Use responsive prefixes consistently:
```plaintext
sm: 640px - Small tablets and up
md: 768px - Tablets and up
lg: 1024px - Laptops and up
xl: 1280px - Desktops and up
```
**Common patterns:**
```tsx
// Stack on mobile, side-by-side on larger
className="flex flex-col sm:flex-row"
// Hide on mobile, show on larger
className="hidden sm:block"
// Reduce padding on mobile
className="p-3 sm:p-4"
// Smaller font on mobile
className="text-xs sm:text-sm"
```
### Material UI (Lyrics Review UI)
Use the `useMediaQuery` hook:
```tsx
const theme = useTheme();
const isMobile = useMediaQuery(theme.breakpoints.down('md'));
return (
<Box sx={{
flexDirection: isMobile ? 'column' : 'row',
width: isMobile ? '100%' : '280px',
}}>
```
### Vanilla CSS (Instrumental Review)
Use CSS media queries:
```css
.element {
width: 100%;
}
@media (min-width: 768px) {
.element {
width: 340px;
}
}
```
## Checklist for New Features
Before merging any UI changes, verify:
- [ ] No horizontal overflow on any mobile viewport (320px - 480px)
- [ ] All interactive elements are at least 44x44px
- [ ] Text is readable without zooming (minimum 11px)
- [ ] Form inputs stack vertically on mobile
- [ ] Navigation is accessible on mobile
- [ ] Images scale properly with `max-width: 100%`
- [ ] Modals/dialogs fit within mobile viewport
- [ ] Buttons show icons-only on very small screens
- [ ] Playwright mobile tests pass
## Common Fixes
### Fix: Horizontal Overflow
1. **Check for fixed widths** - Replace with responsive values
2. **Add flex-wrap** - Allow content to wrap
3. **Add overflow-x: hidden** - On containers (use sparingly)
4. **Check images** - Add `max-width: 100%`
### Fix: Touch Target Too Small
1. **Add minimum height** - `min-h-[44px]`
2. **Add padding** - `p-3` or `px-4 py-3`
3. **Use icon-only on mobile** - Hide text labels
### Fix: Text Too Small
1. **Use responsive font sizes** - `text-xs sm:text-sm`
2. **Set minimum body font size** - At least 14px
3. **Increase line height** - For better readability
## Resources
- [Apple Human Interface Guidelines - Touch Targets](https://developer.apple.com/design/human-interface-guidelines/accessibility)
- [Material Design - Touch Targets](https://m3.material.io/foundations/accessible-design/accessibility-basics)
- [Tailwind CSS Responsive Design](https://tailwindcss.com/docs/responsive-design)
- [Playwright Testing](https://playwright.dev/docs/test-mobile)
+5 -1
View File
@@ -14,12 +14,16 @@
|-----------|--------|
| Audio upload & separation | Working |
| Lyrics transcription | Working |
| Agentic AI correction | Working (Gemini 3 Flash via Vertex AI) |
| Human lyrics review | Working |
| Preview video generation | Working |
| Instrumental selection | Working |
| Multi-format encoding | Working |
| Token-based auth | Working |
| Payment flow | Not started |
| Magic link auth | In Progress (PR #90) |
| Payment flow (Stripe) | In Progress (PR #90) |
| Beta tester program | In Progress (PR #90) |
| CI/CD self-hosted runner | Working (GCP) |
## Known Issues
+195
View File
@@ -0,0 +1,195 @@
# Stripe Setup Guide
This guide walks you through setting up Stripe for the Nomad Karaoke payment system.
## Prerequisites
- A Stripe account (sign up at https://stripe.com)
- Access to Google Cloud Secret Manager (for secure credential storage)
- The Nomad Karaoke backend deployed and running
## 1. Get Your Stripe API Keys
1. Log in to your Stripe Dashboard: https://dashboard.stripe.com
2. Go to **Developers** > **API keys**
3. You'll need two keys:
- **Publishable key** (starts with `pk_live_` or `pk_test_`)
- **Secret key** (starts with `sk_live_` or `sk_test_`)
> **Important**: Never commit your secret key to version control. Always use environment variables or Secret Manager.
## 2. Store Keys in Google Cloud Secret Manager
Store your Stripe keys securely in Secret Manager:
```bash
# Store the secret key
echo -n "sk_live_your_key_here" | gcloud secrets create stripe-secret-key --data-file=-
# Store the webhook secret (after step 3)
echo -n "whsec_your_webhook_secret" | gcloud secrets create stripe-webhook-secret --data-file=-
```
## 3. Set Up Webhook Endpoint
Webhooks notify your backend when payments complete.
### In Stripe Dashboard:
1. Go to **Developers** > **Webhooks**
2. Click **Add endpoint**
3. Enter your endpoint URL: `https://api.nomadkaraoke.com/api/users/webhooks/stripe`
4. Select events to listen to:
- `checkout.session.completed` (required - adds credits)
- `checkout.session.expired` (optional - logging)
- `payment_intent.payment_failed` (optional - logging)
5. Click **Add endpoint**
6. Copy the **Signing secret** (starts with `whsec_`)
7. Store it in Secret Manager (see step 2)
## 4. Configure Environment Variables
Set these environment variables for your backend:
```bash
# Required
STRIPE_SECRET_KEY=sk_live_your_key_here
STRIPE_WEBHOOK_SECRET=whsec_your_webhook_secret
# Optional (defaults shown)
FRONTEND_URL=https://gen.nomadkaraoke.com
BUY_URL=https://buy.nomadkaraoke.com
```
### For Cloud Run deployment:
```bash
gcloud run services update karaoke-backend \
--set-secrets=STRIPE_SECRET_KEY=stripe-secret-key:latest \
--set-secrets=STRIPE_WEBHOOK_SECRET=stripe-webhook-secret:latest
```
## 5. Configure Email Service (SendGrid)
For sending magic link and purchase confirmation emails:
1. Sign up for SendGrid: https://sendgrid.com
2. Create an API key with "Mail Send" permissions
3. Store it in Secret Manager:
```bash
echo -n "SG.your_sendgrid_api_key" | gcloud secrets create sendgrid-api-key --data-file=-
```
4. Set environment variables:
```bash
SENDGRID_API_KEY=SG.your_sendgrid_api_key
EMAIL_FROM=noreply@nomadkaraoke.com
EMAIL_FROM_NAME=Nomad Karaoke
```
## 6. Test the Integration
### Test Mode
Use test keys (starting with `pk_test_` and `sk_test_`) for testing:
1. Use Stripe's test card: `4242 4242 4242 4242`
2. Any future expiration date
3. Any 3-digit CVC
### Verify Webhook Delivery
1. In Stripe Dashboard, go to **Developers** > **Webhooks**
2. Click on your endpoint
3. View recent webhook attempts and their status
4. Use the "Send test webhook" feature to verify connectivity
## Credit Packages
The system comes with these default packages:
| Package | Credits | Price | Per Credit |
|---------|---------|-------|------------|
| 1 Credit | 1 | $5.00 | $5.00 |
| 3 Credits | 3 | $12.00 | $4.00 (20% off) |
| 5 Credits | 5 | $17.50 | $3.50 (30% off) |
| 10 Credits | 10 | $30.00 | $3.00 (40% off) |
To modify packages, edit `backend/services/stripe_service.py`:
```python
CREDIT_PACKAGES = {
"1_credit": {
"credits": 1,
"price_cents": 500,
"name": "1 Karaoke Credit",
"description": "Create 1 professional karaoke video",
},
# Add more packages...
}
```
## Admin Features
### Issue Free Credits
Admins can issue free credits via the API:
```bash
curl -X POST https://api.nomadkaraoke.com/api/users/admin/credits \
-H "Authorization: Bearer YOUR_ADMIN_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"email": "user@example.com",
"amount": 5,
"reason": "Beta tester reward"
}'
```
### View Users
```bash
curl https://api.nomadkaraoke.com/api/users/admin/users \
-H "Authorization: Bearer YOUR_ADMIN_TOKEN"
```
## Troubleshooting
### Webhook Not Receiving Events
1. Verify the endpoint URL is correct and publicly accessible
2. Check the webhook signing secret matches
3. Ensure your server returns 2xx status codes
4. Check Cloud Run logs for errors
### Credits Not Adding
1. Verify `checkout.session.completed` event is being received
2. Check that `metadata` contains `user_email` and `credits`
3. Review backend logs for errors in `stripe_webhook` handler
### Email Not Sending
1. Verify SendGrid API key is valid
2. Check sender email is verified in SendGrid
3. Review SendGrid activity logs
## Security Considerations
1. **Never expose secret keys** - Use environment variables or Secret Manager
2. **Always verify webhook signatures** - The code does this automatically
3. **Use HTTPS** - All Stripe communication must be over HTTPS
4. **Monitor webhook logs** - Watch for failed deliveries or suspicious activity
5. **Set up alerts** - Configure Stripe to alert on unusual activity
## Going Live Checklist
- [ ] Switch from test to live API keys
- [ ] Update webhook endpoint to use live signing secret
- [ ] Verify email sending works with real addresses
- [ ] Test a real purchase with a small amount
- [ ] Set up Stripe Radar for fraud protection
- [ ] Configure Stripe tax settings if applicable
- [ ] Review and enable appropriate Stripe email receipts
@@ -0,0 +1,80 @@
# PR #90: Payment Flow and Beta Tester Program
**Date**: 2025-12-28
**Branch**: `feature/payment-flow`
**PR**: https://github.com/nomadkaraoke/karaoke-gen/pull/90
## Summary
Implemented customer payment system with Stripe and a beta tester program for low-friction user acquisition.
## What Was Built
### Payment System
- Magic link (passwordless) authentication
- Stripe Checkout integration with credit packages ($5-$30)
- Session management (7-day inactivity, 30-day absolute expiry)
- SendGrid email integration for transactional emails
### Beta Tester Program
- Free credit in exchange for feedback promise
- Users must accept they may need to correct lyrics
- Users must write promise text (min 10 chars)
- Feedback form with ratings (1-5 scale):
- Overall experience
- Ease of use
- Lyrics accuracy
- Correction experience
- Bonus credit for detailed feedback (50+ chars)
- Admin endpoints for viewing feedback and stats
### Buy Site (buy.nomadkaraoke.com)
- Landing page with credit packages
- Purple gradient beta tester signup section
- Auto-redirect to main app after enrollment
## Key Files Changed
```
backend/
├── models/user.py # User, Session, MagicLink, Feedback models
├── services/user_service.py # Auth, credits, beta enrollment
├── services/stripe_service.py # Stripe checkout & webhooks
├── services/email_service.py # SendGrid + email templates
└── api/routes/users.py # All user/auth/beta endpoints
buy-site/
├── app/page.tsx # Landing page with beta signup
└── lib/api.ts # API client for beta enrollment
frontend/
└── lib/auth.ts # Updated for magic link auth
```
## CodeRabbit Fixes Addressed
1. Added try/except for invalid credits metadata in Stripe webhook
2. Fixed magic link race condition with Firestore transaction
3. Moved CSS @import before @tailwind directives
4. Fixed broken Open Graph image URL
5. Removed insecure fallback admin privileges
6. Bumped version to 0.76.26
## Environment Variables Required
```
STRIPE_SECRET_KEY=sk_live_...
STRIPE_WEBHOOK_SECRET=whsec_...
SENDGRID_API_KEY=SG....
EMAIL_FROM=noreply@nomadkaraoke.com
FRONTEND_URL=https://gen.nomadkaraoke.com
BUY_URL=https://buy.nomadkaraoke.com
```
## Next Steps
- [ ] Deploy and test Stripe in live mode
- [ ] Configure SendGrid domain verification
- [ ] Deploy buy-site to GitHub Pages
- [ ] Add feedback request trigger after job completion
- [ ] Monitor beta tester metrics via admin dashboard
@@ -0,0 +1,80 @@
# Self-Hosted GitHub Actions Runner on GCP
**Date**: 2025-12-28
**Status**: Deployed and operational
## Problem
GitHub-hosted runners have ~14GB disk space. CI jobs were failing with "No space left on device" during:
- Docker builds (multi-stage, large dependencies)
- Emulator tests (Docker + Java + Firestore/GCS emulators)
- Package builds with poetry
Workarounds like `jlumbroso/free-disk-space` action helped but weren't reliable.
## Solution
Deployed a self-hosted runner on GCP with 200GB SSD via Pulumi IaC.
### Infrastructure Added
| Resource | Purpose |
|----------|---------|
| `github-runner` VM | e2-standard-4, 200GB SSD, Debian 12 |
| `github-runner` service account | Minimal permissions for runner |
| `github-runner-pat` secret | PAT for runner registration |
| IAM bindings | Artifact Registry reader, Secret Manager accessor, logging |
### Jobs Moved to Self-Hosted
- `package-build-test`
- `backend-unit-tests`
- `backend-emulator-tests`
- `deploy-backend`
These use `runs-on: [self-hosted, linux, gcp]` with labels.
## Issues Encountered
### 1. GPG tty errors in startup script
**Problem**: `gpg --dearmor` failed with "cannot open /dev/tty" in non-interactive startup.
**Fix**: Add `--batch` flag to all GPG commands.
### 2. setup-python can't find Python 3.13 on Debian 12
**Problem**: `actions/setup-python@v5` couldn't find pre-built Python 3.13 for Debian 12 on self-hosted runners.
**Fix**:
1. Install Python 3.13 via pyenv on the runner
2. Copy to tool cache: `_work/_tool/Python/3.13.0/x64/`
3. Create marker file: `x64.complete`
### 3. Java 21 not in Debian repos
**Problem**: `openjdk-21-jdk` not available in Debian 12 stable.
**Fix**: Use Temurin (Adoptium) repository directly.
## Key Files
- `infrastructure/__main__.py` - Runner VM and IAM setup
- `infrastructure/README.md` - Setup instructions
- `.github/workflows/ci.yml` - Jobs using self-hosted runner
## Lessons for Future
1. **Self-hosted runners need explicit tool setup** - Unlike GitHub-hosted, tools aren't pre-installed in expected locations
2. **setup-python tool cache location**: `$RUNNER_DIR/_work/_tool/Python/<version>/x64/`
3. **GPG in scripts**: Always use `--batch` for non-interactive execution
4. **Debian vs Ubuntu**: Many GitHub Actions assume Ubuntu; PPAs don't work on Debian
## Cost
~$50/month for e2-standard-4 running 24/7 (covered by GCP free credits).
## PRs
- #95: Initial self-hosted runner setup
- #97: Make startup script reproducible (pyenv, tool cache, GPG fixes)
+130
View File
@@ -0,0 +1,130 @@
"use client"
import { Suspense, useEffect, useState, useRef } from "react"
import { useRouter, useSearchParams } from "next/navigation"
import { Loader2, CheckCircle, XCircle } from "lucide-react"
import { Button } from "@/components/ui/button"
import { useAuth } from "@/lib/auth"
type VerifyState = "loading" | "success" | "error"
function VerifyMagicLinkContent() {
const router = useRouter()
const searchParams = useSearchParams()
const [state, setState] = useState<VerifyState>("loading")
const [errorMessage, setErrorMessage] = useState("")
const hasVerified = useRef(false)
const { verifyMagicLink, user, error } = useAuth()
useEffect(() => {
// Prevent duplicate verification attempts
if (hasVerified.current) return
hasVerified.current = true
const token = searchParams.get("token")
if (!token) {
setState("error")
setErrorMessage("No verification token provided")
return
}
// Verify the token
const verify = async () => {
const success = await verifyMagicLink(token)
if (success) {
setState("success")
// Redirect to main app after short delay
setTimeout(() => {
router.push("/")
}, 2000)
} else {
setState("error")
// Get error from auth store at this point
const authStore = useAuth.getState()
setErrorMessage(authStore.error || "Invalid or expired link")
}
}
verify()
}, [searchParams, verifyMagicLink, router])
return (
<div className="max-w-md w-full bg-slate-900 border border-slate-700 rounded-xl p-8 text-center">
{state === "loading" && (
<>
<Loader2 className="w-12 h-12 text-blue-400 animate-spin mx-auto mb-4" />
<h1 className="text-xl font-semibold text-white mb-2">
Verifying your sign-in link...
</h1>
<p className="text-slate-400">
Please wait while we sign you in.
</p>
</>
)}
{state === "success" && (
<>
<CheckCircle className="w-12 h-12 text-green-400 mx-auto mb-4" />
<h1 className="text-xl font-semibold text-white mb-2">
Successfully signed in!
</h1>
<p className="text-slate-400 mb-4">
Welcome back{user?.email ? `, ${user.email}` : ""}!
</p>
<p className="text-sm text-slate-500">
Redirecting you to the app...
</p>
</>
)}
{state === "error" && (
<>
<XCircle className="w-12 h-12 text-red-400 mx-auto mb-4" />
<h1 className="text-xl font-semibold text-white mb-2">
Sign-in failed
</h1>
<p className="text-slate-400 mb-6">
{errorMessage || "The link may have expired or already been used."}
</p>
<div className="space-y-2">
<Button
onClick={() => router.push("/")}
className="w-full bg-blue-600 hover:bg-blue-500"
>
Go to App
</Button>
<p className="text-xs text-slate-500">
You can request a new sign-in link from the app.
</p>
</div>
</>
)}
</div>
)
}
function VerifyLoadingFallback() {
return (
<div className="max-w-md w-full bg-slate-900 border border-slate-700 rounded-xl p-8 text-center">
<Loader2 className="w-12 h-12 text-blue-400 animate-spin mx-auto mb-4" />
<h1 className="text-xl font-semibold text-white mb-2">
Loading...
</h1>
<p className="text-slate-400">
Please wait.
</p>
</div>
)
}
export default function VerifyMagicLinkPage() {
return (
<div className="min-h-screen bg-slate-950 flex items-center justify-center p-4">
<Suspense fallback={<VerifyLoadingFallback />}>
<VerifyMagicLinkContent />
</Suspense>
</div>
)
}
+44 -43
View File
@@ -1,8 +1,9 @@
"use client"
import { useState, useEffect } from "react"
import { useState, useEffect, useCallback } from "react"
import { api, Job, getAccessToken } from "@/lib/api"
import { useAutoMode, getAutoModeFromUrl } from "@/lib/auto-mode"
import { useJobNotifications, useVisibilityRefresh } from "@/hooks/use-notifications"
import { Button } from "@/components/ui/button"
import { Card, CardContent, CardDescription, CardHeader, CardTitle } from "@/components/ui/card"
import { Music2, RefreshCw, Loader2, Zap, ZapOff, KeyRound, Moon, Sun } from "lucide-react"
@@ -10,6 +11,7 @@ import { JobCard } from "@/components/job"
import { JobSubmission } from "@/components/job/JobSubmission"
import { AuthStatus } from "@/components/auth"
import { AutoProcessor } from "@/components/AutoProcessor"
import { VersionFooter } from "@/components/version-footer"
import { useTheme } from "@/lib/theme"
import {
Tooltip,
@@ -25,6 +27,31 @@ export default function HomePage() {
const { enabled: autoModeEnabled, setEnabled: setAutoMode, toggle: toggleAutoMode } = useAutoMode()
const { isDarkMode, toggleTheme, mounted } = useTheme()
// Memoize loadJobs for use with visibility refresh
const loadJobs = useCallback(async () => {
if (!getAccessToken()) {
setIsLoadingJobs(false)
return
}
try {
const data = await api.listJobs({ limit: 20 })
setJobs(data)
} catch (err: any) {
// Don't log auth errors - user just needs to authenticate
if (err?.status !== 401) {
console.error("Failed to load jobs:", err)
}
} finally {
setIsLoadingJobs(false)
}
}, [])
// Enable notifications for job status changes (sound + title animation)
useJobNotifications(jobs)
// Refresh jobs immediately when tab becomes visible (after returning from review UIs)
useVisibilityRefresh(loadJobs, isAuthenticated)
// Check auth status on mount
useEffect(() => {
setIsAuthenticated(!!getAccessToken())
@@ -48,25 +75,7 @@ export default function HomePage() {
// Poll for updates every 10 seconds
const interval = setInterval(loadJobs, 10000)
return () => clearInterval(interval)
}, [isAuthenticated])
async function loadJobs() {
if (!getAccessToken()) {
setIsLoadingJobs(false)
return
}
try {
const data = await api.listJobs({ limit: 20 })
setJobs(data)
} catch (err: any) {
// Don't log auth errors - user just needs to authenticate
if (err?.status !== 401) {
console.error("Failed to load jobs:", err)
}
} finally {
setIsLoadingJobs(false)
}
}
}, [isAuthenticated, loadJobs])
return (
<div className="min-h-screen" style={{ background: 'var(--bg)' }}>
@@ -75,14 +84,14 @@ export default function HomePage() {
{/* Header */}
<header className="border-b backdrop-blur-sm sticky top-0 z-10" style={{ borderColor: 'var(--card-border)', backgroundColor: 'var(--card)' }}>
<div className="px-4 py-3 flex items-center justify-between">
<div className="flex items-center gap-3">
<img src="/nomad-karaoke-logo.svg" alt="Nomad Karaoke" className="h-10" />
<div>
<h1 className="text-xl font-bold" style={{ color: 'var(--text)' }}>Karaoke Generator</h1>
<div className="px-3 sm:px-4 py-2 sm:py-3 flex items-center justify-between gap-2">
<div className="flex items-center gap-2 sm:gap-3 min-w-0">
<img src="/nomad-karaoke-logo.svg" alt="Nomad Karaoke" className="h-8 sm:h-10 shrink-0" />
<div className="min-w-0">
<h1 className="text-base sm:text-xl font-bold truncate" style={{ color: 'var(--text)' }}>Karaoke Generator</h1>
</div>
</div>
<div className="flex items-center gap-2">
<div className="flex items-center gap-1 sm:gap-2 shrink-0">
<TooltipProvider>
<Tooltip>
<TooltipTrigger asChild>
@@ -90,15 +99,15 @@ export default function HomePage() {
variant="ghost"
size="sm"
onClick={toggleAutoMode}
className={autoModeEnabled ? "text-amber-400 hover:text-amber-300 bg-amber-500/10" : ""}
className={`min-h-[40px] px-2 sm:px-3 ${autoModeEnabled ? "text-amber-400 hover:text-amber-300 bg-amber-500/10" : ""}`}
style={!autoModeEnabled ? { color: 'var(--text-muted)' } : undefined}
>
{autoModeEnabled ? (
<Zap className="w-4 h-4 mr-2" />
<Zap className="w-4 h-4 sm:mr-2" />
) : (
<ZapOff className="w-4 h-4 mr-2" />
<ZapOff className="w-4 h-4 sm:mr-2" />
)}
Auto
<span className="hidden sm:inline">Auto</span>
</Button>
</TooltipTrigger>
<TooltipContent side="bottom" className="max-w-xs">
@@ -118,10 +127,11 @@ export default function HomePage() {
size="sm"
onClick={loadJobs}
disabled={isLoadingJobs || !isAuthenticated}
className="min-h-[40px] px-2 sm:px-3"
style={{ color: 'var(--text-muted)' }}
>
<RefreshCw className={`w-4 h-4 mr-2 ${isLoadingJobs ? 'animate-spin' : ''}`} />
Refresh
<RefreshCw className={`w-4 h-4 sm:mr-2 ${isLoadingJobs ? 'animate-spin' : ''}`} />
<span className="hidden sm:inline">Refresh</span>
</Button>
<AuthStatus />
{mounted && (
@@ -132,6 +142,7 @@ export default function HomePage() {
variant="ghost"
size="sm"
onClick={toggleTheme}
className="min-h-[40px] px-2 sm:px-3"
style={{ color: 'var(--text-muted)' }}
>
{isDarkMode ? (
@@ -227,17 +238,7 @@ export default function HomePage() {
</div>
</main>
{/* Footer */}
<footer className="border-t mt-12 py-6" style={{ borderColor: 'var(--card-border)' }}>
<div className="px-4 text-center text-sm" style={{ color: 'var(--text-muted)' }}>
<p>
Powered by{" "}
<a href="https://github.com/nomadkaraoke/karaoke-gen" className="text-amber-500 hover:underline">
karaoke-gen
</a>
</p>
</div>
</footer>
<VersionFooter />
</div>
)
}
+85
View File
@@ -0,0 +1,85 @@
"use client"
import { Suspense, useEffect, useState } from "react"
import { useRouter, useSearchParams } from "next/navigation"
import { CheckCircle, Loader2, Coins } from "lucide-react"
import { Button } from "@/components/ui/button"
import { useAuth } from "@/lib/auth"
function PaymentSuccessContent() {
const router = useRouter()
const searchParams = useSearchParams()
const [isLoading, setIsLoading] = useState(true)
const { user, fetchUser } = useAuth()
useEffect(() => {
// Refresh user data to get updated credits
const refreshUser = async () => {
await fetchUser()
setIsLoading(false)
}
refreshUser()
}, [fetchUser])
const sessionId = searchParams.get("session_id")
return (
<div className="max-w-md w-full bg-slate-900 border border-slate-700 rounded-xl p-8 text-center">
<CheckCircle className="w-16 h-16 text-green-400 mx-auto mb-4" />
<h1 className="text-2xl font-bold text-white mb-2">
Payment Successful!
</h1>
<p className="text-slate-400 mb-6">
Thank you for your purchase. Your credits have been added to your account.
</p>
{isLoading ? (
<div className="flex items-center justify-center gap-2 text-slate-400 mb-6">
<Loader2 className="w-4 h-4 animate-spin" />
Loading your balance...
</div>
) : user ? (
<div className="bg-slate-800 rounded-lg p-4 mb-6">
<div className="flex items-center justify-center gap-2 text-amber-400">
<Coins className="w-5 h-5" />
<span className="text-2xl font-bold">{user.credits}</span>
<span className="text-slate-400">credits available</span>
</div>
</div>
) : null}
<div className="space-y-3">
<Button
onClick={() => router.push("/")}
className="w-full bg-blue-600 hover:bg-blue-500"
>
Start Creating Karaoke
</Button>
<p className="text-xs text-slate-500">
A confirmation email has been sent to your email address.
</p>
</div>
</div>
)
}
export default function PaymentSuccessPage() {
return (
<div className="min-h-screen bg-slate-950 flex items-center justify-center p-4">
<Suspense
fallback={
<div className="max-w-md w-full bg-slate-900 border border-slate-700 rounded-xl p-8 text-center">
<Loader2 className="w-16 h-16 text-blue-400 mx-auto mb-4 animate-spin" />
<p className="text-slate-400">Loading...</p>
</div>
}
>
<PaymentSuccessContent />
</Suspense>
</div>
)
}
+144 -57
View File
@@ -5,18 +5,14 @@
import { render, screen, fireEvent, waitFor } from '@testing-library/react'
import { AuthStatus } from '../auth/AuthStatus'
import { AuthDialog } from '../auth/AuthDialog'
import { getAccessToken, setAccessToken, clearAccessToken } from '@/lib/api'
import { useAuth } from '@/lib/auth'
// Mock the api module
jest.mock('@/lib/api', () => ({
getAccessToken: jest.fn(),
setAccessToken: jest.fn(),
clearAccessToken: jest.fn(),
// Mock the auth module
jest.mock('@/lib/auth', () => ({
useAuth: jest.fn(),
}))
const mockGetAccessToken = getAccessToken as jest.Mock
const mockSetAccessToken = setAccessToken as jest.Mock
const mockClearAccessToken = clearAccessToken as jest.Mock
const mockUseAuth = useAuth as jest.Mock
// Mock window.location.reload
const mockReload = jest.fn()
@@ -31,49 +27,75 @@ describe('AuthStatus', () => {
})
it('shows Login button when not authenticated', () => {
mockGetAccessToken.mockReturnValue(null)
mockUseAuth.mockReturnValue({
user: null,
logout: jest.fn(),
})
render(<AuthStatus />)
expect(screen.getByRole('button', { name: /login/i })).toBeInTheDocument()
expect(screen.queryByRole('button', { name: /logout/i })).not.toBeInTheDocument()
})
it('shows Logout button when authenticated', () => {
mockGetAccessToken.mockReturnValue('test-token')
it('shows user menu when authenticated', () => {
mockUseAuth.mockReturnValue({
user: { email: 'test@example.com', credits: 5, display_name: null },
logout: jest.fn(),
})
render(<AuthStatus />)
expect(screen.getByRole('button', { name: /logout/i })).toBeInTheDocument()
expect(screen.queryByRole('button', { name: /login/i })).not.toBeInTheDocument()
// Should show user email and credits
expect(screen.getByText('test@example.com')).toBeInTheDocument()
expect(screen.getByText('5')).toBeInTheDocument()
})
it('opens auth dialog when Login is clicked', () => {
mockGetAccessToken.mockReturnValue(null)
mockUseAuth.mockReturnValue({
user: null,
logout: jest.fn(),
sendMagicLink: jest.fn(),
loginWithToken: jest.fn(),
isLoading: false,
error: null,
clearError: jest.fn(),
})
render(<AuthStatus />)
fireEvent.click(screen.getByRole('button', { name: /login/i }))
// Dialog should appear with "Authentication Required" title
expect(screen.getByText('Authentication Required')).toBeInTheDocument()
// Dialog should appear with "Sign In" title
expect(screen.getByText('Sign In')).toBeInTheDocument()
})
it('clears token and reloads when Logout is clicked', () => {
mockGetAccessToken.mockReturnValue('test-token')
it('renders dropdown trigger button when authenticated', async () => {
const mockLogout = jest.fn().mockResolvedValue(undefined)
mockUseAuth.mockReturnValue({
user: { email: 'test@example.com', credits: 5, display_name: null },
logout: mockLogout,
})
render(<AuthStatus />)
fireEvent.click(screen.getByRole('button', { name: /logout/i }))
// Wait for component to mount
const menuButton = await screen.findByRole('button')
expect(mockClearAccessToken).toHaveBeenCalled()
expect(mockReload).toHaveBeenCalled()
// Verify the dropdown trigger has correct attributes
expect(menuButton).toHaveAttribute('aria-haspopup', 'menu')
expect(menuButton).toHaveAttribute('data-slot', 'dropdown-menu-trigger')
})
it('calls onAuthChange callback when logging out', () => {
mockGetAccessToken.mockReturnValue('test-token')
it('passes onAuthChange prop correctly', async () => {
const mockLogout = jest.fn().mockResolvedValue(undefined)
const mockOnAuthChange = jest.fn()
mockUseAuth.mockReturnValue({
user: { email: 'test@example.com', credits: 5, display_name: null },
logout: mockLogout,
})
// Component should render without errors when onAuthChange is provided
render(<AuthStatus onAuthChange={mockOnAuthChange} />)
fireEvent.click(screen.getByRole('button', { name: /logout/i }))
expect(mockOnAuthChange).toHaveBeenCalled()
// Wait for component to mount and verify it renders the user menu
const menuButton = await screen.findByRole('button')
expect(menuButton).toBeInTheDocument()
})
})
@@ -83,80 +105,145 @@ describe('AuthDialog', () => {
beforeEach(() => {
jest.clearAllMocks()
mockUseAuth.mockReturnValue({
sendMagicLink: jest.fn(),
loginWithToken: jest.fn(),
isLoading: false,
error: null,
clearError: jest.fn(),
})
})
it('renders when open is true', () => {
it('renders email step when open', () => {
render(<AuthDialog open={true} onClose={mockOnClose} onSuccess={mockOnSuccess} />)
expect(screen.getByText('Authentication Required')).toBeInTheDocument()
expect(screen.getByPlaceholderText('Enter access token')).toBeInTheDocument()
expect(screen.getByText('Sign In')).toBeInTheDocument()
expect(screen.getByPlaceholderText('you@example.com')).toBeInTheDocument()
})
it('does not render when open is false', () => {
render(<AuthDialog open={false} onClose={mockOnClose} onSuccess={mockOnSuccess} />)
expect(screen.queryByText('Authentication Required')).not.toBeInTheDocument()
expect(screen.queryByText('Sign In')).not.toBeInTheDocument()
})
it('calls onClose when Cancel is clicked', () => {
it('disables Send button when email is empty', () => {
render(<AuthDialog open={true} onClose={mockOnClose} onSuccess={mockOnSuccess} />)
fireEvent.click(screen.getByRole('button', { name: /cancel/i }))
expect(mockOnClose).toHaveBeenCalled()
const sendButton = screen.getByRole('button', { name: /send sign-in link/i })
expect(sendButton).toBeDisabled()
})
it('disables Authenticate button when token is empty', () => {
it('enables Send button when email is entered', () => {
render(<AuthDialog open={true} onClose={mockOnClose} onSuccess={mockOnSuccess} />)
const authenticateBtn = screen.getByRole('button', { name: /authenticate/i })
expect(authenticateBtn).toBeDisabled()
const input = screen.getByPlaceholderText('you@example.com')
fireEvent.change(input, { target: { value: 'test@example.com' } })
const sendButton = screen.getByRole('button', { name: /send sign-in link/i })
expect(sendButton).not.toBeDisabled()
})
it('enables Authenticate button when token is entered', () => {
it('calls sendMagicLink when form is submitted', async () => {
const mockSendMagicLink = jest.fn().mockResolvedValue(true)
mockUseAuth.mockReturnValue({
sendMagicLink: mockSendMagicLink,
loginWithToken: jest.fn(),
isLoading: false,
error: null,
clearError: jest.fn(),
})
render(<AuthDialog open={true} onClose={mockOnClose} onSuccess={mockOnSuccess} />)
const input = screen.getByPlaceholderText('Enter access token')
fireEvent.change(input, { target: { value: 'my-token' } })
const input = screen.getByPlaceholderText('you@example.com')
fireEvent.change(input, { target: { value: 'test@example.com' } })
const authenticateBtn = screen.getByRole('button', { name: /authenticate/i })
expect(authenticateBtn).not.toBeDisabled()
const sendButton = screen.getByRole('button', { name: /send sign-in link/i })
fireEvent.click(sendButton)
await waitFor(() => {
expect(mockSendMagicLink).toHaveBeenCalledWith('test@example.com')
})
})
it('sets token and calls onSuccess when form is submitted', async () => {
it('shows token step when Use Access Token is clicked', () => {
render(<AuthDialog open={true} onClose={mockOnClose} onSuccess={mockOnSuccess} />)
fireEvent.click(screen.getByRole('button', { name: /use access token instead/i }))
expect(screen.getByText('Access Token')).toBeInTheDocument()
expect(screen.getByPlaceholderText('Enter access token')).toBeInTheDocument()
})
it('calls loginWithToken when token is submitted', async () => {
const mockLoginWithToken = jest.fn().mockResolvedValue(true)
mockUseAuth.mockReturnValue({
sendMagicLink: jest.fn(),
loginWithToken: mockLoginWithToken,
isLoading: false,
error: null,
clearError: jest.fn(),
})
render(<AuthDialog open={true} onClose={mockOnClose} onSuccess={mockOnSuccess} />)
// Switch to token step
fireEvent.click(screen.getByRole('button', { name: /use access token instead/i }))
const input = screen.getByPlaceholderText('Enter access token')
fireEvent.change(input, { target: { value: 'my-token' } })
const authenticateBtn = screen.getByRole('button', { name: /authenticate/i })
fireEvent.click(authenticateBtn)
expect(mockSetAccessToken).toHaveBeenCalledWith('my-token')
expect(mockOnSuccess).toHaveBeenCalled()
await waitFor(() => {
expect(mockLoginWithToken).toHaveBeenCalledWith('my-token')
})
})
it('trims whitespace from token', () => {
it('calls onSuccess after successful token login', async () => {
const mockLoginWithToken = jest.fn().mockResolvedValue(true)
mockUseAuth.mockReturnValue({
sendMagicLink: jest.fn(),
loginWithToken: mockLoginWithToken,
isLoading: false,
error: null,
clearError: jest.fn(),
})
render(<AuthDialog open={true} onClose={mockOnClose} onSuccess={mockOnSuccess} />)
// Switch to token step
fireEvent.click(screen.getByRole('button', { name: /use access token instead/i }))
const input = screen.getByPlaceholderText('Enter access token')
fireEvent.change(input, { target: { value: ' my-token ' } })
fireEvent.change(input, { target: { value: 'my-token' } })
const authenticateBtn = screen.getByRole('button', { name: /authenticate/i })
fireEvent.click(authenticateBtn)
expect(mockSetAccessToken).toHaveBeenCalledWith('my-token')
await waitFor(() => {
expect(mockOnSuccess).toHaveBeenCalled()
})
})
it('shows error for empty token submission', () => {
it('shows email sent step after successful magic link send', async () => {
const mockSendMagicLink = jest.fn().mockResolvedValue(true)
mockUseAuth.mockReturnValue({
sendMagicLink: mockSendMagicLink,
loginWithToken: jest.fn(),
isLoading: false,
error: null,
clearError: jest.fn(),
})
render(<AuthDialog open={true} onClose={mockOnClose} onSuccess={mockOnSuccess} />)
// Token with only whitespace
const input = screen.getByPlaceholderText('Enter access token')
fireEvent.change(input, { target: { value: ' ' } })
const input = screen.getByPlaceholderText('you@example.com')
fireEvent.change(input, { target: { value: 'test@example.com' } })
// Button should still be disabled for whitespace-only input
const authenticateBtn = screen.getByRole('button', { name: /authenticate/i })
expect(authenticateBtn).toBeDisabled()
const sendButton = screen.getByRole('button', { name: /send sign-in link/i })
fireEvent.click(sendButton)
await waitFor(() => {
expect(screen.getByText('Check Your Email')).toBeInTheDocument()
})
})
})
+218 -61
View File
@@ -1,7 +1,7 @@
"use client"
import { useState } from "react"
import { KeyRound } from "lucide-react"
import { Mail, KeyRound, ArrowLeft, Loader2, CheckCircle } from "lucide-react"
import { Button } from "@/components/ui/button"
import { Input } from "@/components/ui/input"
import {
@@ -11,7 +11,7 @@ import {
DialogHeader,
DialogTitle,
} from "@/components/ui/dialog"
import { setAccessToken } from "@/lib/api"
import { useAuth } from "@/lib/auth"
interface AuthDialogProps {
open: boolean
@@ -19,72 +19,229 @@ interface AuthDialogProps {
onSuccess: () => void
}
export function AuthDialog({ open, onClose, onSuccess }: AuthDialogProps) {
const [token, setToken] = useState("")
const [error, setError] = useState("")
type AuthStep = "email" | "sent" | "token"
const handleSubmit = (e: React.FormEvent) => {
export function AuthDialog({ open, onClose, onSuccess }: AuthDialogProps) {
const [step, setStep] = useState<AuthStep>("email")
const [email, setEmail] = useState("")
const [token, setToken] = useState("")
const [localError, setLocalError] = useState("")
const { sendMagicLink, loginWithToken, isLoading, error, clearError } = useAuth()
const handleSendMagicLink = async (e: React.FormEvent) => {
e.preventDefault()
if (token.trim()) {
setAccessToken(token.trim())
setError("")
setToken("") // Clear token from state for security
onSuccess()
} else {
setError("Please enter a valid token")
setLocalError("")
if (!email.trim()) {
setLocalError("Please enter your email")
return
}
// Simple email validation
if (!email.includes("@") || !email.includes(".")) {
setLocalError("Please enter a valid email")
return
}
const success = await sendMagicLink(email.trim().toLowerCase())
if (success) {
setStep("sent")
}
}
const handleTokenSubmit = async (e: React.FormEvent) => {
e.preventDefault()
setLocalError("")
if (!token.trim()) {
setLocalError("Please enter your access token")
return
}
const success = await loginWithToken(token.trim())
if (success) {
setToken("") // Clear for security
onSuccess()
}
}
const handleClose = () => {
setStep("email")
setEmail("")
setToken("")
setLocalError("")
clearError()
onClose()
}
const displayError = localError || error
return (
<Dialog open={open} onOpenChange={(open) => !open && onClose()}>
<Dialog open={open} onOpenChange={(open) => !open && handleClose()}>
<DialogContent className="sm:max-w-md bg-slate-900 border-slate-700">
<DialogHeader>
<DialogTitle className="text-white flex items-center gap-2">
<KeyRound className="w-5 h-5 text-amber-400" />
Authentication Required
</DialogTitle>
<DialogDescription className="text-slate-400">
Enter your access token to use the Karaoke Generator
</DialogDescription>
</DialogHeader>
<form onSubmit={handleSubmit} className="space-y-4">
<div>
<Input
type="password"
placeholder="Enter access token"
value={token}
onChange={(e) => {
setToken(e.target.value)
setError("")
}}
className="bg-slate-800 border-slate-600 text-white"
autoFocus
/>
{error && (
<p className="text-xs text-red-400 mt-1">{error}</p>
)}
</div>
<div className="flex justify-end gap-2">
<Button
type="button"
variant="ghost"
onClick={onClose}
className="text-slate-400"
>
Cancel
</Button>
<Button
type="submit"
disabled={!token.trim()}
className="bg-amber-600 hover:bg-amber-500"
>
Authenticate
</Button>
</div>
<p className="text-xs text-slate-500 text-center">
Contact an admin to get an access token
</p>
</form>
{step === "email" && (
<>
<DialogHeader>
<DialogTitle className="text-white flex items-center gap-2">
<Mail className="w-5 h-5 text-blue-400" />
Sign In
</DialogTitle>
<DialogDescription className="text-slate-400">
Enter your email to receive a sign-in link
</DialogDescription>
</DialogHeader>
<form onSubmit={handleSendMagicLink} className="space-y-4">
<div>
<Input
type="email"
placeholder="you@example.com"
value={email}
onChange={(e) => {
setEmail(e.target.value)
setLocalError("")
clearError()
}}
className="bg-slate-800 border-slate-600 text-white"
autoFocus
disabled={isLoading}
/>
{displayError && (
<p className="text-xs text-red-400 mt-1">{displayError}</p>
)}
</div>
<div className="flex flex-col gap-2">
<Button
type="submit"
disabled={!email.trim() || isLoading}
className="w-full bg-blue-600 hover:bg-blue-500"
>
{isLoading ? (
<>
<Loader2 className="w-4 h-4 mr-2 animate-spin" />
Sending...
</>
) : (
"Send Sign-In Link"
)}
</Button>
<Button
type="button"
variant="ghost"
onClick={() => setStep("token")}
className="text-slate-400 hover:text-white"
>
<KeyRound className="w-4 h-4 mr-2" />
Use Access Token Instead
</Button>
</div>
<p className="text-xs text-slate-500 text-center">
No account? Just enter your email to get started.
</p>
</form>
</>
)}
{step === "sent" && (
<>
<DialogHeader>
<DialogTitle className="text-white flex items-center gap-2">
<CheckCircle className="w-5 h-5 text-green-400" />
Check Your Email
</DialogTitle>
</DialogHeader>
<div className="space-y-4 py-4">
<p className="text-slate-300">
We sent a sign-in link to:
</p>
<p className="text-white font-medium bg-slate-800 px-4 py-2 rounded-md">
{email}
</p>
<p className="text-sm text-slate-400">
Click the link in the email to sign in. The link expires in 15 minutes.
</p>
<div className="pt-4 border-t border-slate-700 space-y-2">
<Button
variant="outline"
onClick={() => setStep("email")}
className="w-full border-slate-600 text-slate-300 hover:text-white"
>
<ArrowLeft className="w-4 h-4 mr-2" />
Try a Different Email
</Button>
<Button
variant="ghost"
onClick={handleClose}
className="w-full text-slate-400"
>
Close
</Button>
</div>
</div>
</>
)}
{step === "token" && (
<>
<DialogHeader>
<DialogTitle className="text-white flex items-center gap-2">
<KeyRound className="w-5 h-5 text-amber-400" />
Access Token
</DialogTitle>
<DialogDescription className="text-slate-400">
Enter your access token to authenticate
</DialogDescription>
</DialogHeader>
<form onSubmit={handleTokenSubmit} className="space-y-4">
<div>
<Input
type="password"
placeholder="Enter access token"
value={token}
onChange={(e) => {
setToken(e.target.value)
setLocalError("")
clearError()
}}
className="bg-slate-800 border-slate-600 text-white"
autoFocus
disabled={isLoading}
/>
{displayError && (
<p className="text-xs text-red-400 mt-1">{displayError}</p>
)}
</div>
<div className="flex flex-col gap-2">
<Button
type="submit"
disabled={!token.trim() || isLoading}
className="w-full bg-amber-600 hover:bg-amber-500"
>
{isLoading ? (
<>
<Loader2 className="w-4 h-4 mr-2 animate-spin" />
Authenticating...
</>
) : (
"Authenticate"
)}
</Button>
<Button
type="button"
variant="ghost"
onClick={() => setStep("email")}
className="text-slate-400 hover:text-white"
>
<ArrowLeft className="w-4 h-4 mr-2" />
Back to Email Sign-In
</Button>
</div>
<p className="text-xs text-slate-500 text-center">
Contact an admin to get an access token
</p>
</form>
</>
)}
</DialogContent>
</Dialog>
)
+86 -21
View File
@@ -1,9 +1,17 @@
"use client"
import { useState, useEffect } from "react"
import { KeyRound, LogOut } from "lucide-react"
import { User, LogOut, CreditCard, Coins, KeyRound } from "lucide-react"
import { Button } from "@/components/ui/button"
import { getAccessToken, clearAccessToken } from "@/lib/api"
import {
DropdownMenu,
DropdownMenuContent,
DropdownMenuItem,
DropdownMenuLabel,
DropdownMenuSeparator,
DropdownMenuTrigger,
} from "@/components/ui/dropdown-menu"
import { useAuth } from "@/lib/auth"
import { AuthDialog } from "./AuthDialog"
interface AuthStatusProps {
@@ -11,38 +19,95 @@ interface AuthStatusProps {
}
export function AuthStatus({ onAuthChange }: AuthStatusProps) {
const [isAuthenticated, setIsAuthenticated] = useState(false)
const { user, logout } = useAuth()
const [showAuthDialog, setShowAuthDialog] = useState(false)
const [mounted, setMounted] = useState(false)
// Avoid hydration mismatch
useEffect(() => {
setIsAuthenticated(!!getAccessToken())
setMounted(true)
}, [])
const handleLogout = () => {
clearAccessToken()
setIsAuthenticated(false)
const handleLogout = async () => {
await logout()
onAuthChange?.()
window.location.reload()
}
const handleAuthSuccess = () => {
setIsAuthenticated(true)
setShowAuthDialog(false)
onAuthChange?.()
window.location.reload()
}
if (isAuthenticated) {
const handleBuyCredits = () => {
// Navigate to buy site with email prefilled if available
const buyBaseUrl = process.env.NEXT_PUBLIC_BUY_URL || "https://buy.nomadkaraoke.com"
const buyUrl = new URL(buyBaseUrl)
if (user?.email) {
buyUrl.searchParams.set("email", user.email)
}
window.open(buyUrl.toString(), "_blank")
}
// Don't render until mounted (avoids hydration issues)
if (!mounted) {
return null
}
if (user) {
return (
<Button
variant="ghost"
size="sm"
onClick={handleLogout}
className="text-slate-400 hover:text-white"
>
<LogOut className="w-4 h-4 mr-2" />
Logout
</Button>
<DropdownMenu>
<DropdownMenuTrigger asChild>
<Button
variant="ghost"
size="sm"
className="text-slate-300 hover:text-white flex items-center gap-2 min-h-[40px] px-2 sm:px-3"
>
<User className="w-4 h-4" />
<span className="hidden sm:inline max-w-[150px] truncate">
{user.display_name || user.email}
</span>
<span className="flex items-center gap-1 text-amber-400 font-medium">
<Coins className="w-3 h-3" />
{user.credits}
</span>
</Button>
</DropdownMenuTrigger>
<DropdownMenuContent align="end" className="w-56 bg-slate-900 border-slate-700">
<DropdownMenuLabel className="text-slate-400 font-normal">
<div className="flex flex-col space-y-1">
<p className="text-sm font-medium text-white">
{user.display_name || "Karaoke Fan"}
</p>
<p className="text-xs text-slate-500 truncate">{user.email}</p>
</div>
</DropdownMenuLabel>
<DropdownMenuSeparator className="bg-slate-700" />
<DropdownMenuItem
className="text-slate-300 focus:text-white focus:bg-slate-800 cursor-default"
disabled
>
<Coins className="w-4 h-4 mr-2 text-amber-400" />
<span>{user.credits} credits available</span>
</DropdownMenuItem>
<DropdownMenuItem
onClick={handleBuyCredits}
className="text-slate-300 focus:text-white focus:bg-slate-800"
>
<CreditCard className="w-4 h-4 mr-2" />
<span>Buy More Credits</span>
</DropdownMenuItem>
<DropdownMenuSeparator className="bg-slate-700" />
<DropdownMenuItem
onClick={handleLogout}
className="text-red-400 focus:text-red-300 focus:bg-slate-800"
>
<LogOut className="w-4 h-4 mr-2" />
<span>Sign Out</span>
</DropdownMenuItem>
</DropdownMenuContent>
</DropdownMenu>
)
}
@@ -52,10 +117,10 @@ export function AuthStatus({ onAuthChange }: AuthStatusProps) {
variant="ghost"
size="sm"
onClick={() => setShowAuthDialog(true)}
className="text-amber-400 hover:text-amber-300"
className="text-amber-400 hover:text-amber-300 min-h-[40px] px-2 sm:px-3"
>
<KeyRound className="w-4 h-4 mr-2" />
Login
<KeyRound className="w-4 h-4 sm:mr-2" />
<span className="hidden sm:inline">Login</span>
</Button>
<AuthDialog
open={showAuthDialog}
+13 -10
View File
@@ -31,14 +31,15 @@ function ColorField({ id, label, description, value, onChange, disabled }: Color
return (
<div className="space-y-1">
<div className="flex items-center justify-between">
<Label htmlFor={id} className="text-sm text-slate-300">
<Label htmlFor={id} className="text-sm" style={{ color: 'var(--text)' }}>
{label}
</Label>
{value && (
<button
type="button"
onClick={() => onChange(undefined)}
className="text-xs text-slate-500 hover:text-slate-300"
className="text-xs"
style={{ color: 'var(--text-muted)' }}
disabled={disabled}
>
Reset
@@ -47,8 +48,8 @@ function ColorField({ id, label, description, value, onChange, disabled }: Color
</div>
<div className="flex items-center gap-2">
<div
className="w-8 h-8 rounded border border-slate-600 flex-shrink-0"
style={{ backgroundColor: value || "#333333" }}
className="w-8 h-8 rounded border flex-shrink-0"
style={{ backgroundColor: value || "#333333", borderColor: 'var(--card-border)' }}
/>
<Input
id={id}
@@ -64,7 +65,8 @@ function ColorField({ id, label, description, value, onChange, disabled }: Color
}
}}
disabled={disabled}
className="bg-slate-800 border-slate-700 text-white placeholder:text-slate-500 font-mono text-sm"
className="font-mono text-sm"
style={{ backgroundColor: 'var(--secondary)', borderColor: 'var(--card-border)', color: 'var(--text)' }}
/>
<Input
type="color"
@@ -74,7 +76,7 @@ function ColorField({ id, label, description, value, onChange, disabled }: Color
className="w-10 h-8 p-0 border-0 bg-transparent cursor-pointer"
/>
</div>
<p className="text-xs text-slate-500">{description}</p>
<p className="text-xs" style={{ color: 'var(--text-muted)' }}>{description}</p>
</div>
)
}
@@ -106,7 +108,8 @@ export function ColorOverridesPanel({ value, onChange, disabled }: ColorOverride
<Button
variant="ghost"
type="button"
className="w-full justify-between px-3 py-2 h-auto text-slate-300 hover:text-white hover:bg-slate-700/50"
className="w-full justify-between px-3 py-2 h-auto"
style={{ color: 'var(--text)' }}
>
<span className="flex items-center gap-2">
<Paintbrush className="w-4 h-4" />
@@ -126,9 +129,9 @@ export function ColorOverridesPanel({ value, onChange, disabled }: ColorOverride
</CollapsibleTrigger>
<CollapsibleContent className="mt-2">
<div className="space-y-4 p-4 rounded-lg border border-slate-700 bg-slate-800/50">
<div className="space-y-4 p-4 rounded-lg border" style={{ borderColor: 'var(--card-border)', backgroundColor: 'var(--secondary)' }}>
<div className="flex items-center justify-between">
<p className="text-sm text-slate-400">
<p className="text-sm" style={{ color: 'var(--text-muted)' }}>
Override theme colors (optional)
</p>
{hasAnyOverrides && (
@@ -138,7 +141,7 @@ export function ColorOverridesPanel({ value, onChange, disabled }: ColorOverride
size="sm"
onClick={handleResetAll}
disabled={disabled}
className="text-slate-400 hover:text-white"
style={{ color: 'var(--text-muted)' }}
>
<RotateCcw className="w-3 h-3 mr-1" />
Reset All
+2 -1
View File
@@ -124,7 +124,8 @@ export function JobActions({ job, onRefresh, showLogs, onToggleLogs }: JobAction
size="sm"
variant="ghost"
onClick={onToggleLogs}
className="text-xs text-slate-400 hover:text-white"
className="text-xs"
style={{ color: 'var(--text-muted)' }}
>
<FileText className="w-3 h-3 mr-1" />
{showLogs ? "Hide" : "Show"} Logs
+9 -5
View File
@@ -60,7 +60,7 @@ function ProgressBar({ job }: { job: Job }) {
const barColor = barColorMap[color] || "bg-blue-400"
return (
<div className="w-full h-1 bg-slate-700/50 rounded-full mt-2 overflow-hidden">
<div className="w-full h-1 rounded-full mt-2 overflow-hidden" style={{ backgroundColor: 'var(--secondary)' }}>
<div
className={`h-full ${barColor} rounded-full transition-all duration-500 ease-out`}
style={{ width: `${progressPercent}%` }}
@@ -190,18 +190,22 @@ export function JobCard({ job, onRefresh }: JobCardProps) {
return (
<div
className={`rounded-lg border p-3 transition-colors border-slate-700 bg-slate-800/30
className={`rounded-lg border p-3 transition-colors
${isComplete ? "border-green-500/30" : ""}
${isFailed ? "border-red-500/30" : ""}`}
style={{
borderColor: isComplete || isFailed ? undefined : 'var(--card-border)',
backgroundColor: 'var(--card)',
}}
>
{/* Header row with title */}
<p className="font-medium text-white truncate">
<p className="font-medium truncate" style={{ color: 'var(--text)' }}>
{job.artist || "Unknown"} - {job.title || "Unknown"}
</p>
{/* Meta row: ID, date, status */}
<p className="text-xs text-slate-500 mt-1">
<span className="text-slate-600">ID:</span> {job.job_id} <span className="text-slate-600">•</span> {createdAt} <span className="text-slate-600">•</span> <StatusIndicator job={job} />
<p className="text-xs mt-1" style={{ color: 'var(--text-muted)' }}>
<span style={{ opacity: 0.7 }}>ID:</span> {job.job_id} <span style={{ opacity: 0.7 }}>•</span> {createdAt} <span style={{ opacity: 0.7 }}>•</span> <StatusIndicator job={job} />
</p>
{/* Progress bar for active jobs */}
+6 -5
View File
@@ -34,7 +34,7 @@ export function JobLogs({ jobId, limit = 50 }: JobLogsProps) {
if (isLoading) {
return (
<div className="flex items-center justify-center py-4 text-slate-400">
<div className="flex items-center justify-center py-4" style={{ color: 'var(--text-muted)' }}>
<Loader2 className="w-4 h-4 animate-spin mr-2" />
Loading logs...
</div>
@@ -52,14 +52,14 @@ export function JobLogs({ jobId, limit = 50 }: JobLogsProps) {
if (logs.length === 0) {
return (
<div className="text-center py-4 text-slate-500 text-sm">
<div className="text-center py-4 text-sm" style={{ color: 'var(--text-muted)' }}>
No logs available
</div>
)
}
return (
<div className="bg-slate-900 rounded border border-slate-700 p-3 max-h-64 overflow-y-auto">
<div className="rounded border p-3 max-h-64 overflow-y-auto" style={{ backgroundColor: 'var(--bg)', borderColor: 'var(--card-border)' }}>
<div className="space-y-1 font-mono text-xs">
{logs.map((log, index) => (
<div
@@ -68,10 +68,11 @@ export function JobLogs({ jobId, limit = 50 }: JobLogsProps) {
log.level === "ERROR" ? "text-red-400" :
log.level === "WARNING" ? "text-yellow-400" :
log.level === "INFO" ? "text-blue-400" :
"text-slate-400"
""
}`}
style={log.level !== "ERROR" && log.level !== "WARNING" && log.level !== "INFO" ? { color: 'var(--text-muted)' } : undefined}
>
<span className="text-slate-600 shrink-0">
<span className="shrink-0" style={{ color: 'var(--text-muted)', opacity: 0.7 }}>
{new Date(log.timestamp).toLocaleTimeString()}
</span>
<span className="shrink-0 font-semibold w-12">
+56 -40
View File
@@ -17,7 +17,7 @@ interface JobSubmissionProps {
}
export function JobSubmission({ onJobCreated }: JobSubmissionProps) {
const [activeTab, setActiveTab] = useState("upload")
const [activeTab, setActiveTab] = useState("search")
const [error, setError] = useState("")
const [isSubmitting, setIsSubmitting] = useState(false)
@@ -147,28 +147,43 @@ export function JobSubmission({ onJobCreated }: JobSubmissionProps) {
return (
<Tabs value={activeTab} onValueChange={setActiveTab}>
<TabsList className="grid w-full grid-cols-3 bg-slate-800">
<TabsTrigger value="upload" className="gap-2 data-[state=active]:bg-slate-700">
<Upload className="w-4 h-4" />
Upload
<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-amber-500 data-[state=active]:text-white data-[state=active]:shadow-md data-[state=inactive]:hover:bg-amber-500/10"
style={{ color: activeTab === 'search' ? 'white' : 'var(--text-muted)' }}
>
<Music className="w-4 h-4 shrink-0" />
<span className="truncate">Search</span>
</TabsTrigger>
<TabsTrigger value="url" className="gap-2 data-[state=active]:bg-slate-700">
<Youtube className="w-4 h-4" />
URL
<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-amber-500 data-[state=active]:text-white data-[state=active]:shadow-md data-[state=inactive]:hover:bg-amber-500/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="search" className="gap-2 data-[state=active]:bg-slate-700">
<Music className="w-4 h-4" />
Search
<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-amber-500 data-[state=active]:text-white data-[state=active]:shadow-md data-[state=inactive]:hover:bg-amber-500/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" className="text-slate-200">Audio File</Label>
<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
${uploadFile ? "border-amber-500/50 bg-amber-500/5" : "border-slate-700 hover:border-slate-600 bg-slate-800/50"}`}
className="relative border-2 border-dashed rounded-lg p-6 text-center transition-colors cursor-pointer"
style={{
borderColor: uploadFile ? 'rgb(245 158 11 / 0.5)' : 'var(--card-border)',
backgroundColor: uploadFile ? 'rgb(245 158 11 / 0.05)' : 'var(--secondary)',
}}
>
<Input
id="audio-file"
@@ -178,48 +193,48 @@ export function JobSubmission({ onJobCreated }: JobSubmissionProps) {
className="absolute inset-0 w-full h-full opacity-0 cursor-pointer"
disabled={isSubmitting}
/>
<Upload className="w-8 h-8 mx-auto mb-2 text-slate-500" />
<Upload className="w-8 h-8 mx-auto mb-2" style={{ color: 'var(--text-muted)' }} />
{uploadFile ? (
<div>
<p className="font-medium text-white">{uploadFile.name}</p>
<p className="text-sm text-slate-400">{(uploadFile.size / 1024 / 1024).toFixed(2)} MB</p>
<p className="font-medium" style={{ color: 'var(--text)' }}>{uploadFile.name}</p>
<p className="text-sm" style={{ color: 'var(--text-muted)' }}>{(uploadFile.size / 1024 / 1024).toFixed(2)} MB</p>
</div>
) : (
<div>
<p className="font-medium text-slate-300 mb-1">Click to upload</p>
<p className="text-sm text-slate-500">MP3, WAV, FLAC, M4A, or OGG</p>
<p className="font-medium mb-1" style={{ color: 'var(--text)' }}>Click to upload</p>
<p className="text-sm" style={{ color: 'var(--text-muted)' }}>MP3, WAV, FLAC, M4A, or OGG</p>
</div>
)}
</div>
</div>
<div className="grid grid-cols-2 gap-4">
<div className="grid grid-cols-1 sm:grid-cols-2 gap-3 sm:gap-4">
<div className="space-y-2">
<Label htmlFor="upload-artist" className="text-slate-200">Artist</Label>
<Label htmlFor="upload-artist" style={{ color: 'var(--text)' }}>Artist</Label>
<Input
id="upload-artist"
placeholder="Artist name"
value={uploadArtist}
onChange={(e) => setUploadArtist(e.target.value)}
disabled={isSubmitting}
className="bg-slate-800 border-slate-700 text-white placeholder:text-slate-500"
style={{ backgroundColor: 'var(--secondary)', borderColor: 'var(--card-border)', color: 'var(--text)' }}
/>
</div>
<div className="space-y-2">
<Label htmlFor="upload-title" className="text-slate-200">Title</Label>
<Label htmlFor="upload-title" style={{ color: 'var(--text)' }}>Title</Label>
<Input
id="upload-title"
placeholder="Song title"
value={uploadTitle}
onChange={(e) => setUploadTitle(e.target.value)}
disabled={isSubmitting}
className="bg-slate-800 border-slate-700 text-white placeholder:text-slate-500"
style={{ backgroundColor: 'var(--secondary)', borderColor: 'var(--card-border)', color: 'var(--text)' }}
/>
</div>
</div>
{/* Theme Selection */}
<div className="space-y-4 pt-4 border-t border-slate-700">
<div className="space-y-4 pt-4 border-t" style={{ borderColor: 'var(--card-border)' }}>
<ThemeSelector
value={selectedTheme}
onChange={setSelectedTheme}
@@ -256,48 +271,49 @@ export function JobSubmission({ onJobCreated }: JobSubmissionProps) {
<TabsContent value="url" className="mt-4">
<form onSubmit={handleUrlSubmit} className="space-y-4">
<div className="space-y-2">
<Label htmlFor="youtube-url" className="text-slate-200">YouTube URL</Label>
<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 text-slate-500" />
<Youtube className="absolute left-3 top-1/2 -translate-y-1/2 w-4 h-4" style={{ color: 'var(--text-muted)' }} />
<Input
id="youtube-url"
type="url"
placeholder="https://youtube.com/watch?v=..."
value={youtubeUrl}
onChange={(e) => setYoutubeUrl(e.target.value)}
className="pl-10 bg-slate-800 border-slate-700 text-white placeholder:text-slate-500"
className="pl-10"
style={{ backgroundColor: 'var(--secondary)', borderColor: 'var(--card-border)', color: 'var(--text)' }}
disabled={isSubmitting}
/>
</div>
</div>
<div className="grid grid-cols-2 gap-4">
<div className="grid grid-cols-1 sm:grid-cols-2 gap-3 sm:gap-4">
<div className="space-y-2">
<Label htmlFor="youtube-artist" className="text-slate-200">Artist (optional)</Label>
<Label htmlFor="youtube-artist" style={{ color: 'var(--text)' }}>Artist (optional)</Label>
<Input
id="youtube-artist"
placeholder="Auto-detected"
value={youtubeArtist}
onChange={(e) => setYoutubeArtist(e.target.value)}
disabled={isSubmitting}
className="bg-slate-800 border-slate-700 text-white placeholder:text-slate-500"
style={{ backgroundColor: 'var(--secondary)', borderColor: 'var(--card-border)', color: 'var(--text)' }}
/>
</div>
<div className="space-y-2">
<Label htmlFor="youtube-title" className="text-slate-200">Title (optional)</Label>
<Label htmlFor="youtube-title" style={{ color: 'var(--text)' }}>Title (optional)</Label>
<Input
id="youtube-title"
placeholder="Auto-detected"
value={youtubeTitle}
onChange={(e) => setYoutubeTitle(e.target.value)}
disabled={isSubmitting}
className="bg-slate-800 border-slate-700 text-white placeholder:text-slate-500"
style={{ backgroundColor: 'var(--secondary)', borderColor: 'var(--card-border)', color: 'var(--text)' }}
/>
</div>
</div>
{/* Theme Selection */}
<div className="space-y-4 pt-4 border-t border-slate-700">
<div className="space-y-4 pt-4 border-t" style={{ borderColor: 'var(--card-border)' }}>
<ThemeSelector
value={selectedTheme}
onChange={setSelectedTheme}
@@ -333,33 +349,33 @@ export function JobSubmission({ onJobCreated }: JobSubmissionProps) {
<TabsContent value="search" className="mt-4">
<form onSubmit={handleSearchSubmit} className="space-y-4">
<div className="grid grid-cols-2 gap-4">
<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-slate-200">Artist</Label>
<Label htmlFor="search-artist" style={{ color: 'var(--text)' }}>Artist</Label>
<Input
id="search-artist"
placeholder="Artist name"
value={searchArtist}
onChange={(e) => setSearchArtist(e.target.value)}
disabled={isSubmitting}
className="bg-slate-800 border-slate-700 text-white placeholder:text-slate-500"
style={{ backgroundColor: 'var(--secondary)', borderColor: 'var(--card-border)', color: 'var(--text)' }}
/>
</div>
<div className="space-y-2">
<Label htmlFor="search-title" className="text-slate-200">Title</Label>
<Label htmlFor="search-title" style={{ color: 'var(--text)' }}>Title</Label>
<Input
id="search-title"
placeholder="Song title"
value={searchTitle}
onChange={(e) => setSearchTitle(e.target.value)}
disabled={isSubmitting}
className="bg-slate-800 border-slate-700 text-white placeholder:text-slate-500"
style={{ backgroundColor: 'var(--secondary)', borderColor: 'var(--card-border)', color: 'var(--text)' }}
/>
</div>
</div>
{/* Theme Selection */}
<div className="space-y-4 pt-4 border-t border-slate-700">
<div className="space-y-4 pt-4 border-t" style={{ borderColor: 'var(--card-border)' }}>
<ThemeSelector
value={selectedTheme}
onChange={setSelectedTheme}
+19 -24
View File
@@ -30,8 +30,8 @@ export function OutputLinks({ jobId }: OutputLinksProps) {
if (job.state_data?.youtube_url) {
setYoutubeUrl(job.state_data.youtube_url)
}
if (job.state_data?.dropbox_folder_url) {
setDropboxUrl(job.state_data.dropbox_folder_url)
if (job.state_data?.dropbox_link) {
setDropboxUrl(job.state_data.dropbox_link)
}
} catch (err) {
console.error("Failed to load output links:", err)
@@ -42,20 +42,23 @@ export function OutputLinks({ jobId }: OutputLinksProps) {
if (isLoading) {
return (
<div className="flex items-center gap-2 text-xs text-slate-400">
<div className="flex items-center gap-2 text-xs" style={{ color: 'var(--text-muted)' }}>
<Loader2 className="w-3 h-3 animate-spin" />
Loading downloads...
</div>
)
}
const hasOutputs = youtubeUrl || dropboxUrl || (downloadUrls && Object.keys(downloadUrls).length > 0)
return (
<div className="space-y-2">
{/* Distribution Links */}
{(youtubeUrl || dropboxUrl) && (
{/* Combined Output Links */}
{hasOutputs && (
<div className="space-y-2">
<p className="text-xs text-slate-400 font-medium">Distribution:</p>
<p className="text-xs font-medium" style={{ color: 'var(--text-muted)' }}>Outputs:</p>
<div className="flex flex-wrap gap-2">
{/* Distribution Links */}
{youtubeUrl && (
<a
href={youtubeUrl}
@@ -77,19 +80,11 @@ export function OutputLinks({ jobId }: OutputLinksProps) {
onClick={(e) => e.stopPropagation()}
>
<FolderOpen className="w-3 h-3" />
Open Dropbox Folder
Dropbox Folder
</a>
)}
</div>
</div>
)}
{/* Download Links */}
{downloadUrls && Object.keys(downloadUrls).length > 0 && (
<div className="space-y-2">
<p className="text-xs text-slate-400 font-medium">Downloads:</p>
<div className="flex flex-wrap gap-2">
{downloadUrls.finals?.lossy_720p && (
{/* Download Links */}
{downloadUrls?.finals?.lossy_720p && (
<a
href={api.getDownloadUrl(jobId, "finals", "lossy_720p")}
className="inline-flex items-center gap-1 text-xs px-3 py-1.5 rounded bg-green-600 hover:bg-green-500 text-white"
@@ -99,7 +94,7 @@ export function OutputLinks({ jobId }: OutputLinksProps) {
720p Video
</a>
)}
{downloadUrls.finals?.lossy_4k_mp4 && (
{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-green-600 hover:bg-green-500 text-white"
@@ -109,20 +104,20 @@ export function OutputLinks({ jobId }: OutputLinksProps) {
4K Video
</a>
)}
{downloadUrls.packages?.cdg_zip && (
{downloadUrls?.packages?.cdg_zip && (
<a
href={api.getDownloadUrl(jobId, "packages", "cdg_zip")}
className="inline-flex items-center gap-1 text-xs px-2 py-1.5 rounded bg-slate-600 hover:bg-slate-500 text-white"
className="inline-flex items-center gap-1 text-xs px-2 py-1.5 rounded bg-gray-700 hover:bg-gray-600 text-white"
onClick={(e) => e.stopPropagation()}
>
<Download className="w-3 h-3" />
CDG+MP3
</a>
)}
{downloadUrls.packages?.txt_zip && (
{downloadUrls?.packages?.txt_zip && (
<a
href={api.getDownloadUrl(jobId, "packages", "txt_zip")}
className="inline-flex items-center gap-1 text-xs px-2 py-1.5 rounded bg-slate-600 hover:bg-slate-500 text-white"
className="inline-flex items-center gap-1 text-xs px-2 py-1.5 rounded bg-gray-700 hover:bg-gray-600 text-white"
onClick={(e) => e.stopPropagation()}
>
<Download className="w-3 h-3" />
@@ -133,8 +128,8 @@ export function OutputLinks({ jobId }: OutputLinksProps) {
</div>
)}
{!downloadUrls && !youtubeUrl && !dropboxUrl && (
<p className="text-xs text-slate-500">No outputs available yet</p>
{!hasOutputs && (
<p className="text-xs" style={{ color: 'var(--text-muted)' }}>No outputs available yet</p>
)}
</div>
)
+28 -13
View File
@@ -6,7 +6,8 @@ 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 { Palette, AlertCircle } from "lucide-react"
import { Button } from "@/components/ui/button"
import { Palette, AlertCircle, Eye, EyeOff } from "lucide-react"
interface ThemeSelectorProps {
value?: string
@@ -18,6 +19,7 @@ export function ThemeSelector({ value, onChange, disabled }: ThemeSelectorProps)
const [themes, setThemes] = useState<VideoThemeSummary[]>([])
const [loading, setLoading] = useState(true)
const [error, setError] = useState<string | null>(null)
const [showPreview, setShowPreview] = useState(false)
useEffect(() => {
async function loadThemes() {
@@ -52,11 +54,11 @@ export function ThemeSelector({ value, onChange, disabled }: ThemeSelectorProps)
if (loading) {
return (
<div className="space-y-2">
<Label className="text-slate-200 flex items-center gap-2">
<Label className="flex items-center gap-2" style={{ color: 'var(--text)' }}>
<Palette className="w-4 h-4" />
Video Theme
</Label>
<Skeleton className="h-10 w-full bg-slate-700" />
<Skeleton className="h-10 w-full" style={{ backgroundColor: 'var(--secondary)' }} />
</div>
)
}
@@ -64,7 +66,7 @@ export function ThemeSelector({ value, onChange, disabled }: ThemeSelectorProps)
if (error || themes.length === 0) {
return (
<div className="space-y-2">
<Label className="text-slate-200 flex items-center gap-2">
<Label className="flex items-center gap-2" style={{ color: 'var(--text)' }}>
<Palette className="w-4 h-4" />
Video Theme
</Label>
@@ -78,7 +80,7 @@ export function ThemeSelector({ value, onChange, disabled }: ThemeSelectorProps)
return (
<div className="space-y-2">
<Label htmlFor="theme-select" className="text-slate-200 flex items-center gap-2">
<Label htmlFor="theme-select" className="flex items-center gap-2" style={{ color: 'var(--text)' }}>
<Palette className="w-4 h-4" />
Video Theme
</Label>
@@ -90,16 +92,16 @@ export function ThemeSelector({ value, onChange, disabled }: ThemeSelectorProps)
>
<SelectTrigger
id="theme-select"
className="bg-slate-800 border-slate-700 text-white"
style={{ backgroundColor: 'var(--secondary)', borderColor: 'var(--card-border)', color: 'var(--text)' }}
>
<SelectValue placeholder="Select a theme..." />
</SelectTrigger>
<SelectContent className="bg-slate-800 border-slate-700">
<SelectContent style={{ backgroundColor: 'var(--card)', borderColor: 'var(--card-border)' }}>
{themes.map((theme) => (
<SelectItem
key={theme.id}
value={theme.id}
className="text-white hover:bg-slate-700 focus:bg-slate-700"
style={{ color: 'var(--text)' }}
>
<div className="flex items-center gap-2">
<span>{theme.name}</span>
@@ -112,13 +114,26 @@ export function ThemeSelector({ value, onChange, disabled }: ThemeSelectorProps)
</SelectContent>
</Select>
{/* Theme description and preview */}
{selectedTheme && (
{/* Theme preview toggle */}
{selectedTheme?.thumbnail_url && (
<div className="mt-2 space-y-2">
<p className="text-sm text-slate-400">{selectedTheme.description}</p>
<Button
type="button"
variant="ghost"
size="sm"
onClick={() => setShowPreview(!showPreview)}
className="px-0"
style={{ color: 'var(--text-muted)' }}
>
{showPreview ? (
<><EyeOff className="w-4 h-4 mr-1.5" />Hide preview</>
) : (
<><Eye className="w-4 h-4 mr-1.5" />Show preview</>
)}
</Button>
{selectedTheme.thumbnail_url && (
<div className="relative w-full aspect-video max-w-xs rounded-lg overflow-hidden border border-slate-700">
{showPreview && (
<div className="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`}
+46
View File
@@ -0,0 +1,46 @@
"use client";
import { useEffect, useState } from "react";
import { api } from "@/lib/api";
export function VersionFooter() {
const [backendVersion, setBackendVersion] = useState<string | null>(null);
// Frontend version is injected at build time from pyproject.toml
const frontendVersion = process.env.NEXT_PUBLIC_APP_VERSION || "dev";
useEffect(() => {
const fetchBackendVersion = async () => {
try {
const info = await api.getBackendInfo();
setBackendVersion(info.version);
} catch (error) {
console.error("Failed to fetch backend version:", error);
setBackendVersion(null);
}
};
fetchBackendVersion();
}, []);
return (
<footer className="border-t mt-12 py-6" style={{ borderColor: 'var(--card-border)' }}>
<div className="px-4 text-center text-sm" style={{ color: 'var(--text-muted)' }}>
<p>
Powered by{" "}
<a href="https://github.com/nomadkaraoke/karaoke-gen" className="text-amber-500 hover:underline">
karaoke-gen
</a>
</p>
<p className="mt-1 text-xs opacity-75">
Frontend: v{frontendVersion}
{backendVersion && (
<>
{" | "}
Backend: v{backendVersion}
</>
)}
</p>
</div>
</footer>
);
}
+162
View File
@@ -0,0 +1,162 @@
import { test, expect, Page } from '@playwright/test';
/**
* Mobile Responsiveness E2E Tests
*
* Tests the entire user journey on mobile devices to ensure:
* 1. All content is visible and accessible
* 2. No horizontal scrolling occurs
* 3. Touch targets are appropriately sized
* 4. Text is readable without zooming
*/
// Common mobile viewport sizes
const MOBILE_VIEWPORTS = {
'iPhone SE': { width: 375, height: 667 },
'iPhone 14': { width: 390, height: 844 },
'Pixel 7': { width: 412, height: 915 },
};
// Helper to set auth token
async function setAuthToken(page: Page) {
const token = process.env.KARAOKE_ACCESS_TOKEN;
if (token) {
await page.evaluate((t) => {
localStorage.setItem('karaoke_access_token', t);
}, token);
}
}
// Helper to check no horizontal overflow
async function hasNoHorizontalOverflow(page: Page): Promise<boolean> {
return await page.evaluate(() => {
const docWidth = document.documentElement.scrollWidth;
const viewportWidth = window.innerWidth;
return docWidth <= viewportWidth + 2;
});
}
test.describe('Mobile Responsiveness', () => {
test.beforeEach(async ({ page }) => {
await setAuthToken(page);
});
for (const [deviceName, viewport] of Object.entries(MOBILE_VIEWPORTS)) {
test.describe(`${deviceName} (${viewport.width}x${viewport.height})`, () => {
test.beforeEach(async ({ page }) => {
await page.setViewportSize(viewport);
await page.goto('/');
await page.waitForLoadState('domcontentloaded');
await page.waitForTimeout(1000);
});
test('page loads without horizontal scroll', async ({ page }) => {
const noOverflow = await hasNoHorizontalOverflow(page);
expect(noOverflow).toBe(true);
});
test('header is visible and accessible', async ({ page }) => {
// Logo should be visible
const logo = page.locator('header img, .logo');
await expect(logo.first()).toBeVisible();
// Header title should be visible (may be truncated on mobile)
const title = page.locator('h1');
await expect(title.first()).toBeVisible();
});
test('form inputs are visible and usable', async ({ page }) => {
// Tab buttons should be visible
const tabs = page.locator('[role="tablist"] button, .tabs button');
if (await tabs.count() > 0) {
await expect(tabs.first()).toBeVisible();
}
// Check that Artist/Title inputs exist (after clicking upload tab if needed)
const uploadTab = page.locator('button:has-text("Upload")');
if (await uploadTab.count() > 0) {
await uploadTab.first().click();
await page.waitForTimeout(300);
}
// Artist input
const artistInput = page.locator('input').first();
if (await artistInput.count() > 0) {
const box = await artistInput.boundingBox();
if (box) {
expect(box.width).toBeGreaterThan(100);
}
}
});
test('buttons have adequate touch target size', async ({ page }) => {
const buttons = page.locator('button:visible');
const count = await buttons.count();
let smallButtonCount = 0;
for (let i = 0; i < Math.min(count, 10); i++) {
const button = buttons.nth(i);
const box = await button.boundingBox();
if (box && (box.width < 28 || box.height < 28)) {
smallButtonCount++;
}
}
// Allow some small buttons (icons) but not too many
expect(smallButtonCount).toBeLessThan(3);
});
});
}
});
test.describe('Mobile Interactions', () => {
test.beforeEach(async ({ page }) => {
await setAuthToken(page);
await page.setViewportSize({ width: 375, height: 667 });
await page.goto('/');
await page.waitForLoadState('domcontentloaded');
});
test('can switch between tabs', async ({ page }) => {
const urlTab = page.locator('button:has-text("URL")');
if (await urlTab.count() > 0) {
await urlTab.first().click();
await page.waitForTimeout(300);
// URL input should now be visible
const urlInput = page.locator('input[type="url"], input[placeholder*="youtube"], input[placeholder*="URL"]');
if (await urlInput.count() > 0) {
await expect(urlInput.first()).toBeVisible();
}
}
});
test('can type in input fields', async ({ page }) => {
// Find a text input (not file input)
const textInput = page.locator('input[type="text"], input[placeholder*="Artist"], input[placeholder*="title"]');
if (await textInput.count() > 0) {
await textInput.first().focus();
await textInput.first().fill('Test Input');
await expect(textInput.first()).toHaveValue('Test Input');
}
});
});
test.describe('Accessibility', () => {
test.beforeEach(async ({ page }) => {
await setAuthToken(page);
await page.setViewportSize({ width: 375, height: 667 });
await page.goto('/');
await page.waitForLoadState('domcontentloaded');
});
test('has proper viewport meta tag', async ({ page }) => {
const viewportMeta = await page.evaluate(() => {
const meta = document.querySelector('meta[name="viewport"]');
return meta?.getAttribute('content') || '';
});
expect(viewportMeta).toContain('width=device-width');
expect(viewportMeta).toContain('initial-scale=1');
});
});
+259
View File
@@ -0,0 +1,259 @@
"use client"
import { useEffect, useRef, useCallback } from 'react'
import type { Job } from '@/lib/api'
import { isBlockingStatus } from '@/lib/job-status'
const TITLE_FLASH_INTERVAL = 1000 // ms between title flashes
const DEFAULT_TITLE = 'Karaoke Generator'
type NotificationReason = 'action_needed' | 'complete' | 'failed'
interface NotificationState {
jobId: string
status: string
}
/**
* Creates a notification sound using Web Audio API.
* Returns a function that plays the sound when called.
*/
function createNotificationSound(): () => void {
let audioContext: AudioContext | null = null
return () => {
try {
// Create or reuse AudioContext (lazy init for browser compatibility)
if (!audioContext) {
audioContext = new (window.AudioContext || (window as any).webkitAudioContext)()
}
// Resume context if suspended (browsers require user interaction)
if (audioContext.state === 'suspended') {
audioContext.resume()
}
const now = audioContext.currentTime
// Create a pleasant two-tone notification sound
const oscillator1 = audioContext.createOscillator()
const oscillator2 = audioContext.createOscillator()
const gainNode = audioContext.createGain()
oscillator1.connect(gainNode)
oscillator2.connect(gainNode)
gainNode.connect(audioContext.destination)
// First tone - higher frequency
oscillator1.frequency.setValueAtTime(880, now) // A5
oscillator1.type = 'sine'
// Second tone - lower frequency (harmony)
oscillator2.frequency.setValueAtTime(659.25, now) // E5
oscillator2.type = 'sine'
// Envelope: quick attack, short sustain, fade out
gainNode.gain.setValueAtTime(0, now)
gainNode.gain.linearRampToValueAtTime(0.3, now + 0.02) // Quick attack
gainNode.gain.setValueAtTime(0.3, now + 0.1) // Sustain
gainNode.gain.linearRampToValueAtTime(0, now + 0.3) // Fade out
oscillator1.start(now)
oscillator2.start(now)
oscillator1.stop(now + 0.3)
oscillator2.stop(now + 0.3)
} catch (error) {
// Silently fail - notifications are non-critical
console.debug('Notification sound failed:', error)
}
}
}
/**
* Hook to manage browser notifications for job status changes.
* Handles sound alerts and title bar animations when user attention is needed.
*
* @param jobs - Current list of jobs from the API
*/
export function useJobNotifications(jobs: Job[]) {
const previousStatesRef = useRef<Map<string, NotificationState>>(new Map())
const titleIntervalRef = useRef<ReturnType<typeof setInterval> | null>(null)
const originalTitleRef = useRef<string>(DEFAULT_TITLE)
const playSoundRef = useRef<() => void>(createNotificationSound())
const isFlashingRef = useRef<boolean>(false)
const hasInteractedRef = useRef<boolean>(false)
// Track user interaction to enable sounds (browser requirement)
useEffect(() => {
const markInteracted = () => {
hasInteractedRef.current = true
}
// Listen for any user interaction
document.addEventListener('click', markInteracted, { once: true })
document.addEventListener('keydown', markInteracted, { once: true })
return () => {
document.removeEventListener('click', markInteracted)
document.removeEventListener('keydown', markInteracted)
}
}, [])
/**
* Start flashing the document title to attract attention.
*/
const startTitleFlash = useCallback((message: string) => {
// Don't start if already flashing
if (isFlashingRef.current) return
isFlashingRef.current = true
originalTitleRef.current = document.title
let showMessage = true
titleIntervalRef.current = setInterval(() => {
document.title = showMessage ? message : originalTitleRef.current
showMessage = !showMessage
}, TITLE_FLASH_INTERVAL)
}, [])
/**
* Stop the title flash animation.
*/
const stopTitleFlash = useCallback(() => {
if (titleIntervalRef.current) {
clearInterval(titleIntervalRef.current)
titleIntervalRef.current = null
}
isFlashingRef.current = false
document.title = originalTitleRef.current || DEFAULT_TITLE
}, [])
/**
* Trigger a notification with sound and optional title flash.
*/
const notify = useCallback((reason: NotificationReason, jobTitle?: string) => {
// Play sound if user has interacted with the page
if (hasInteractedRef.current) {
playSoundRef.current()
}
// Start title flash based on notification type
const displayTitle = jobTitle ? `${jobTitle} - ` : ''
switch (reason) {
case 'action_needed':
startTitleFlash(`${displayTitle}Action Needed`)
break
case 'complete':
startTitleFlash(`${displayTitle}Complete!`)
break
case 'failed':
startTitleFlash(`${displayTitle}Failed`)
break
}
}, [startTitleFlash])
// Stop title flash when page becomes visible (user returned)
useEffect(() => {
const handleVisibilityChange = () => {
if (document.visibilityState === 'visible' && isFlashingRef.current) {
stopTitleFlash()
}
}
document.addEventListener('visibilitychange', handleVisibilityChange)
return () => {
document.removeEventListener('visibilitychange', handleVisibilityChange)
}
}, [stopTitleFlash])
// Cleanup on unmount
useEffect(() => {
return () => {
stopTitleFlash()
}
}, [stopTitleFlash])
// Watch for job status changes that require notifications
useEffect(() => {
const currentStates = new Map<string, NotificationState>()
for (const job of jobs) {
const previousState = previousStatesRef.current.get(job.job_id)
const currentStatus = job.status
currentStates.set(job.job_id, {
jobId: job.job_id,
status: currentStatus,
})
// Skip if this is the first time we're seeing this job or status hasn't changed
if (!previousState || previousState.status === currentStatus) {
continue
}
const jobTitle = job.artist && job.title
? `${job.artist} - ${job.title}`
: undefined
// Check for status transitions that need notifications
const wasBlocking = isBlockingStatus(previousState.status)
const isNowBlocking = isBlockingStatus(currentStatus)
// Notify when entering a blocking state (from non-blocking)
if (!wasBlocking && isNowBlocking) {
notify('action_needed', jobTitle)
}
// Notify when job completes
if (currentStatus === 'complete' || currentStatus === 'prep_complete') {
notify('complete', jobTitle)
}
// Notify when job fails
if (currentStatus === 'failed') {
notify('failed', jobTitle)
}
}
// Update previous states reference
previousStatesRef.current = currentStates
}, [jobs, notify])
return {
stopTitleFlash,
}
}
/**
* Hook to refresh jobs when the page becomes visible.
* This ensures the UI updates immediately when returning from review/instrumental UIs.
*
* @param loadJobs - Function to refresh the jobs list
* @param isAuthenticated - Whether the user is authenticated
*/
export function useVisibilityRefresh(loadJobs: () => void, isAuthenticated: boolean) {
const lastVisibleTimeRef = useRef<number>(Date.now())
useEffect(() => {
if (!isAuthenticated) return
const handleVisibilityChange = () => {
if (document.visibilityState === 'visible') {
const timeSinceLastVisible = Date.now() - lastVisibleTimeRef.current
// Refresh if we were hidden for at least 1 second
// This catches returning from review UIs while avoiding unnecessary refreshes
if (timeSinceLastVisible > 1000) {
loadJobs()
}
} else {
lastVisibleTimeRef.current = Date.now()
}
}
document.addEventListener('visibilitychange', handleVisibilityChange)
return () => {
document.removeEventListener('visibilitychange', handleVisibilityChange)
}
}, [loadJobs, isAuthenticated])
}
+71 -2
View File
@@ -3,6 +3,7 @@
*/
import type { VideoThemeSummary, VideoThemeDetail, ThemesListResponse, ThemeDetailResponse, ColorOverrides } from './video-themes';
import type { MagicLinkResponse, VerifyMagicLinkResponse, UserProfileResponse } from './types';
// In development, use relative URLs to go through Next.js proxy (avoids CORS)
// In production (static export), use the full backend URL
@@ -384,10 +385,15 @@ export const api = {
},
/**
* Get the base download URL for a file
* Get the download URL for a file, including authentication token
*/
getDownloadUrl(jobId: string, category: string, fileKey: string): string {
return `${API_BASE_URL}/api/jobs/${jobId}/download/${category}/${fileKey}`;
const baseUrl = `${API_BASE_URL}/api/jobs/${jobId}/download/${category}/${fileKey}`;
const token = getAccessToken();
if (token) {
return `${baseUrl}?token=${encodeURIComponent(token)}`;
}
return baseUrl;
},
/**
@@ -517,6 +523,69 @@ export const api = {
const data = await handleResponse<{ description: string | null }>(response);
return data.description;
},
// ==========================================================================
// Auth API endpoints (Magic Link)
// ==========================================================================
/**
* Send a magic link email for passwordless login
*/
async sendMagicLink(email: string): Promise<MagicLinkResponse> {
const response = await fetch(`${API_BASE_URL}/api/users/auth/magic-link`, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({ email }),
});
return handleResponse(response);
},
/**
* Verify a magic link token and get a session
*/
async verifyMagicLink(token: string): Promise<VerifyMagicLinkResponse> {
const response = await fetch(`${API_BASE_URL}/api/users/auth/verify?token=${encodeURIComponent(token)}`, {
method: 'GET',
});
return handleResponse(response);
},
/**
* Get the current user's profile
*/
async getCurrentUser(): Promise<UserProfileResponse> {
const response = await fetch(`${API_BASE_URL}/api/users/me`, {
headers: getAuthHeaders()
});
return handleResponse(response);
},
/**
* Logout and invalidate the current session
*/
async logout(): Promise<{ status: string; message: string }> {
const response = await fetch(`${API_BASE_URL}/api/users/auth/logout`, {
method: 'POST',
headers: getAuthHeaders()
});
return handleResponse(response);
},
// ==========================================================================
// Version API endpoint
// ==========================================================================
/**
* Get backend service info including version
*/
async getBackendInfo(): Promise<{ service: string; version: string; status: string }> {
const response = await fetch(`${API_BASE_URL}/`, {
headers: getAuthHeaders()
});
return handleResponse(response);
},
};
export { ApiError };
+145 -16
View File
@@ -2,43 +2,172 @@
import { create } from "zustand"
import { persist } from "zustand/middleware"
import type { User } from "./types"
import type { User, UserPublic } from "./types"
import { api, setAccessToken, clearAccessToken, getAccessToken } from "./api"
interface AuthStore {
user: User | null
login: (token: string) => Promise<boolean>
logout: () => void
isLoading: boolean
error: string | null
// Actions
sendMagicLink: (email: string) => Promise<boolean>
verifyMagicLink: (token: string) => Promise<boolean>
fetchUser: () => Promise<boolean>
logout: () => Promise<void>
updateCredits: (credits: number) => void
clearError: () => void
// For legacy token-based auth (admin tokens)
loginWithToken: (token: string) => Promise<boolean>
}
export const useAuth = create<AuthStore>()(
persist(
(set) => ({
(set, get) => ({
user: null,
login: async (token: string) => {
// In a real app, validate token with backend
// For demo, parse token to determine role
isLoading: false,
error: null,
sendMagicLink: async (email: string) => {
set({ isLoading: true, error: null })
try {
const isAdmin = token.toLowerCase().includes("admin")
const user: User = {
token,
role: isAdmin ? "admin" : "user",
credits: isAdmin ? 999 : 3,
}
set({ user })
await api.sendMagicLink(email)
set({ isLoading: false })
return true
} catch {
} catch (err) {
set({
isLoading: false,
error: err instanceof Error ? err.message : 'Failed to send magic link'
})
return false
}
},
logout: () => set({ user: null }),
verifyMagicLink: async (token: string) => {
set({ isLoading: true, error: null })
try {
const response = await api.verifyMagicLink(token)
// Store the session token
setAccessToken(response.session_token)
// Create user from response
const user: User = {
token: response.session_token,
email: response.user.email,
role: response.user.role,
credits: response.user.credits,
display_name: response.user.display_name,
total_jobs_created: response.user.total_jobs_created,
total_jobs_completed: response.user.total_jobs_completed,
}
set({ user, isLoading: false })
return true
} catch (err) {
set({
isLoading: false,
error: err instanceof Error ? err.message : 'Invalid or expired link'
})
return false
}
},
fetchUser: async () => {
const token = getAccessToken()
if (!token) {
set({ user: null })
return false
}
set({ isLoading: true })
try {
const response = await api.getCurrentUser()
const user: User = {
token,
email: response.user.email,
role: response.user.role,
credits: response.user.credits,
display_name: response.user.display_name,
total_jobs_created: response.user.total_jobs_created,
total_jobs_completed: response.user.total_jobs_completed,
}
set({ user, isLoading: false })
return true
} catch {
// Session may have expired
clearAccessToken()
set({ user: null, isLoading: false })
return false
}
},
logout: async () => {
try {
await api.logout()
} catch {
// Ignore errors, just clear local state
}
clearAccessToken()
set({ user: null, error: null })
},
updateCredits: (credits: number) =>
set((state) => ({
user: state.user ? { ...state.user, credits } : null,
})),
clearError: () => set({ error: null }),
// Legacy token-based auth for admin tokens
loginWithToken: async (token: string) => {
set({ isLoading: true, error: null })
try {
// Store the token
setAccessToken(token)
// Try to fetch user profile
const response = await api.getCurrentUser()
const user: User = {
token,
email: response.user.email,
role: response.user.role,
credits: response.user.credits,
display_name: response.user.display_name,
total_jobs_created: response.user.total_jobs_created,
total_jobs_completed: response.user.total_jobs_completed,
}
set({ user, isLoading: false })
return true
} catch {
// Token validation failed - clear token and reject
clearAccessToken()
set({
user: null,
isLoading: false,
error: 'Invalid token or server unavailable'
})
return false
}
},
}),
{
name: "nomad-karaoke-auth",
partialize: (state) => ({ user: state.user }),
},
),
)
// Initialize auth state on page load
if (typeof window !== 'undefined') {
const token = getAccessToken()
if (token) {
// Fetch fresh user data on page load
useAuth.getState().fetchUser()
}
}
+30 -1
View File
@@ -4,7 +4,36 @@ export interface User {
token: string
role: UserRole
credits: number
email?: string
email: string
display_name?: string
total_jobs_created?: number
total_jobs_completed?: number
}
export interface UserPublic {
email: string
role: UserRole
credits: number
display_name?: string
total_jobs_created?: number
total_jobs_completed?: number
}
export interface MagicLinkResponse {
status: string
message: string
}
export interface VerifyMagicLinkResponse {
status: string
session_token: string
user: UserPublic
message: string
}
export interface UserProfileResponse {
user: UserPublic
has_session: boolean
}
export type JobStatus = "queued" | "processing" | "awaiting_review" | "awaiting_instrumental" | "completed" | "failed"
+61 -814
View File
File diff suppressed because it is too large. Load diff
+4 -4
View File
@@ -1,6 +1,6 @@
{
"name": "my-v0-project",
"version": "0.1.0",
"name": "karaoke-gen-frontend",
"version": "0.76.27",
"private": true,
"scripts": {
"build": "next build",
@@ -82,8 +82,8 @@
"devDependencies": {
"@playwright/test": "^1.57.0",
"@tailwindcss/postcss": "^4.1.9",
"@testing-library/jest-dom": "^6.1.5",
"@testing-library/react": "^14.1.2",
"@testing-library/jest-dom": "^6.9.1",
"@testing-library/react": "^16.3.1",
"@testing-library/user-event": "^14.5.1",
"@types/jest": "^29.5.11",
"@types/node": "^22",
+9
View File
@@ -82,6 +82,15 @@ export default defineConfig({
name: 'chromium',
use: { ...devices['Desktop Chrome'] },
},
// Mobile device testing
{
name: 'mobile-chrome',
use: { ...devices['Pixel 7'] },
},
{
name: 'mobile-safari',
use: { ...devices['iPhone 14'] },
},
],
// Run local dev server before starting tests
+78 -1
View File
@@ -254,10 +254,87 @@ The function uses environment variables:
Known gaps are configured in `main.py` and should match your local `validate_and_sync.py`.
## Self-Hosted GitHub Actions Runners
Multiple GCP VMs run self-hosted GitHub Actions runners to:
- Solve disk space issues on GitHub-hosted runners (14GB vs 200GB)
- Enable parallel job execution across multiple runners
### Specs
- **Instances**: 10x e2-standard-4 (4 vCPU, 16GB RAM each)
- **Disk**: 200GB SSD per runner
- **Pre-installed**: Docker, Python 3.13, Node.js 20, Java 21, Poetry, FFmpeg, gcloud CLI
- **Labels**: `self-hosted`, `linux`, `x64`, `gcp`, `large-disk`
### Setup
1. Create a GitHub Personal Access Token (PAT) with `repo` scope:
- Go to https://github.com/settings/tokens
- Generate new token (classic)
- Select `repo` scope (full control of private repositories)
- Copy the token
2. Add the PAT to Secret Manager:
```bash
echo -n "ghp_your_token_here" | \
gcloud secrets versions add github-runner-pat --data-file=-
```
3. Run `pulumi up` to create the runner VMs
4. Verify the runners registered:
- Go to https://github.com/nomadkaraoke/karaoke-gen/settings/actions/runners
- You should see `gcp-runner-github-runner-1` through `gcp-runner-github-runner-10`
### Usage in Workflows
Jobs that need more disk space use the self-hosted runners:
```yaml
jobs:
build:
runs-on: [self-hosted, linux, gcp]
steps:
- uses: actions/checkout@v4
# ... rest of job
```
GitHub automatically distributes jobs across available runners.
### Troubleshooting
**Runner not appearing in GitHub:**
```bash
# Check startup logs (replace N with runner number 1-10)
gcloud compute ssh github-runner-N --zone=us-central1-a -- \
"sudo cat /var/log/github-runner-startup.log"
```
**Re-register runner:**
```bash
# Restart the VM to re-run startup script
gcloud compute instances reset github-runner-N --zone=us-central1-a
```
**Check runner service status:**
```bash
gcloud compute ssh github-runner-N --zone=us-central1-a -- \
"sudo systemctl status actions.runner.*"
```
**List all runners:**
```bash
for i in {1..10}; do
echo "=== github-runner-$i ==="
gcloud compute instances describe github-runner-$i --zone=us-central1-a --format='get(status)'
done
```
## Next Steps
1. Run `pulumi up` to create infrastructure
2. Add secret values
2. Add secret values (including GitHub runner PAT)
3. Build and deploy Cloud Run service
4. Deploy GDrive validator function
5. Update documentation to reference Pulumi workflow
+285
View File
@@ -107,6 +107,14 @@ cloud_trace_iam = gcp.projects.IAMMember(
member=service_account.email.apply(lambda email: f"serviceAccount:{email}"),
)
# Grant Vertex AI User permissions (for Gemini agentic AI correction)
vertex_ai_iam = gcp.projects.IAMMember(
"karaoke-backend-vertexai-user",
project=project_id,
role="roles/aiplatform.user",
member=service_account.email.apply(lambda email: f"serviceAccount:{email}"),
)
# Grant Cloud Build service accounts access to Artifact Registry
# Cloud Build uses multiple service accounts depending on the context
cloudbuild_service_accounts = [
@@ -1182,3 +1190,280 @@ pulumi.export("gdrive_validator_function_name", gdrive_validator_function.name)
pulumi.export("gdrive_validator_scheduler_name", gdrive_validator_scheduler.name)
pulumi.export("gdrive_validator_service_account", gdrive_validator_sa.email)
# ==================== Self-Hosted GitHub Actions Runner ====================
# A dedicated VM running GitHub Actions runner for CI/CD jobs that need more
# disk space than GitHub-hosted runners provide (14GB vs 200GB here).
# This solves "No space left on device" errors during Docker builds.
# Service account for GitHub runner VM
github_runner_sa = serviceaccount.Account(
"github-runner-sa",
account_id="github-runner",
display_name="GitHub Actions Runner",
description="Service account for self-hosted GitHub Actions runner VM",
)
# Grant runner service account Artifact Registry reader (for pulling base images)
github_runner_artifact_reader = gcp.projects.IAMMember(
"github-runner-artifact-reader",
project=project_id,
role="roles/artifactregistry.reader",
member=github_runner_sa.email.apply(lambda email: f"serviceAccount:{email}"),
)
# Grant runner service account Secret Manager access (for PAT)
github_runner_secrets_iam = gcp.projects.IAMMember(
"github-runner-secrets-access",
project=project_id,
role="roles/secretmanager.secretAccessor",
member=github_runner_sa.email.apply(lambda email: f"serviceAccount:{email}"),
)
# Grant runner service account logging permissions
github_runner_logging_iam = gcp.projects.IAMMember(
"github-runner-logging-access",
project=project_id,
role="roles/logging.logWriter",
member=github_runner_sa.email.apply(lambda email: f"serviceAccount:{email}"),
)
# GitHub PAT secret for runner registration
# The PAT needs 'repo' scope to register a runner
github_runner_pat_secret = secretmanager.Secret(
"github-runner-pat",
secret_id="github-runner-pat",
replication=secretmanager.SecretReplicationArgs(
auto=secretmanager.SecretReplicationAutoArgs(),
),
)
# Startup script for the GitHub runner VM
GITHUB_RUNNER_STARTUP_SCRIPT = """#!/bin/bash
set -e
# Log to a file for debugging
exec > >(tee /var/log/github-runner-startup.log) 2>&1
echo "Starting GitHub Actions runner setup at $(date)"
# System updates and core dependencies
apt-get update
apt-get install -y \\
curl \\
git \\
jq \\
unzip \\
build-essential \\
libssl-dev \\
libffi-dev \\
software-properties-common \\
apt-transport-https \\
ca-certificates \\
gnupg \\
lsb-release
# ==================== Docker ====================
echo "Installing Docker..."
curl -fsSL https://download.docker.com/linux/debian/gpg | gpg --batch --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
echo "deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/debian $(lsb_release -cs) stable" > /etc/apt/sources.list.d/docker.list
apt-get update
apt-get install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
# Configure Docker for the runner user
systemctl enable docker
systemctl start docker
# ==================== Python 3.13 via pyenv ====================
# setup-python action on self-hosted runners needs Python in the tool cache
echo "Installing Python 3.13 via pyenv..."
# Install pyenv dependencies
apt-get install -y make build-essential libssl-dev zlib1g-dev \\
libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm \\
libncursesw5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev
# Install pyenv system-wide
export PYENV_ROOT=/opt/pyenv
curl https://pyenv.run | bash
# Add to system profile for future sessions
cat > /etc/profile.d/pyenv.sh << 'PYENV_PROFILE'
export PYENV_ROOT=/opt/pyenv
export PATH="$PYENV_ROOT/bin:$PATH"
eval "$(pyenv init -)"
PYENV_PROFILE
# Source pyenv for current session
export PATH="/opt/pyenv/bin:$PATH"
eval "$(/opt/pyenv/bin/pyenv init -)"
# Install Python 3.13
/opt/pyenv/bin/pyenv install 3.13.0
/opt/pyenv/bin/pyenv global 3.13.0
# Create symlinks for system-wide access
ln -sf /opt/pyenv/shims/python3.13 /usr/local/bin/python3.13
ln -sf /opt/pyenv/shims/python3 /usr/local/bin/python3
ln -sf /opt/pyenv/shims/pip3 /usr/local/bin/pip3
# ==================== Node.js 20 ====================
echo "Installing Node.js 20..."
curl -fsSL https://deb.nodesource.com/setup_20.x | bash -
apt-get install -y nodejs
# ==================== Java 21 (for Firestore emulator) ====================
echo "Installing Java 21 via Temurin..."
# Use Temurin (Adoptium) - more reliable than Debian repos
curl -fsSL https://packages.adoptium.net/artifactory/api/gpg/key/public | gpg --batch --dearmor -o /usr/share/keyrings/adoptium.gpg
echo "deb [signed-by=/usr/share/keyrings/adoptium.gpg] https://packages.adoptium.net/artifactory/deb $(lsb_release -cs) main" > /etc/apt/sources.list.d/adoptium.list
apt-get update
apt-get install -y temurin-21-jdk
# ==================== FFmpeg ====================
echo "Installing FFmpeg..."
apt-get install -y ffmpeg
# ==================== Poetry ====================
echo "Installing Poetry..."
curl -sSL https://install.python-poetry.org | python3 -
ln -sf /root/.local/bin/poetry /usr/local/bin/poetry
# ==================== Google Cloud SDK ====================
echo "Installing Google Cloud SDK..."
curl -fsSL https://packages.cloud.google.com/apt/doc/apt-key.gpg | gpg --batch --dearmor -o /usr/share/keyrings/cloud.google.gpg
echo "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] https://packages.cloud.google.com/apt cloud-sdk main" > /etc/apt/sources.list.d/google-cloud-sdk.list
apt-get update
apt-get install -y google-cloud-cli google-cloud-cli-firestore-emulator
# ==================== Create runner user ====================
echo "Creating runner user..."
useradd -m -s /bin/bash runner || true
usermod -aG docker runner
# ==================== GitHub Actions Runner ====================
echo "Setting up GitHub Actions Runner..."
RUNNER_VERSION="2.321.0"
RUNNER_DIR="/home/runner/actions-runner"
mkdir -p $RUNNER_DIR
cd $RUNNER_DIR
# Download runner
curl -o actions-runner-linux-x64-${RUNNER_VERSION}.tar.gz -L \\
https://github.com/actions/runner/releases/download/v${RUNNER_VERSION}/actions-runner-linux-x64-${RUNNER_VERSION}.tar.gz
tar xzf actions-runner-linux-x64-${RUNNER_VERSION}.tar.gz
rm actions-runner-linux-x64-${RUNNER_VERSION}.tar.gz
chown -R runner:runner $RUNNER_DIR
# Get GitHub PAT from Secret Manager
echo "Fetching GitHub PAT from Secret Manager..."
GITHUB_PAT=$(gcloud secrets versions access latest --secret=github-runner-pat)
if [ -z "$GITHUB_PAT" ]; then
echo "ERROR: GitHub PAT not found in Secret Manager"
exit 1
fi
# Get runner registration token using PAT
echo "Getting runner registration token..."
REGISTRATION_TOKEN=$(curl -s -X POST \\
-H "Authorization: token $GITHUB_PAT" \\
-H "Accept: application/vnd.github.v3+json" \\
https://api.github.com/repos/nomadkaraoke/karaoke-gen/actions/runners/registration-token | jq -r .token)
if [ -z "$REGISTRATION_TOKEN" ] || [ "$REGISTRATION_TOKEN" = "null" ]; then
echo "ERROR: Failed to get registration token"
exit 1
fi
# Configure runner (non-interactive)
echo "Configuring runner..."
cd $RUNNER_DIR
sudo -u runner ./config.sh \\
--url https://github.com/nomadkaraoke/karaoke-gen \\
--token "$REGISTRATION_TOKEN" \\
--name "gcp-runner-$(hostname)" \\
--labels "self-hosted,linux,x64,gcp,large-disk" \\
--work "_work" \\
--unattended \\
--replace
# Install and start runner as a service
echo "Installing runner service..."
./svc.sh install runner
./svc.sh start
echo "GitHub Actions runner setup complete at $(date)"
echo "Runner registered with labels: self-hosted,linux,x64,gcp,large-disk"
# ==================== Setup Python in tool cache ====================
# setup-python action looks for Python in RUNNER_TOOL_CACHE/_tool/Python
echo "Setting up Python 3.13 in tool cache for setup-python action..."
TOOL_CACHE="/home/runner/actions-runner/_work/_tool"
mkdir -p $TOOL_CACHE/Python/3.13.0/x64
# Copy pyenv Python to tool cache
cp -r /opt/pyenv/versions/3.13.0/* $TOOL_CACHE/Python/3.13.0/x64/
# Create marker file that setup-python looks for
touch $TOOL_CACHE/Python/3.13.0/x64.complete
# Fix permissions - must own entire _work directory, not just _tool
chown -R runner:runner /home/runner/actions-runner/_work
echo "Python 3.13 added to tool cache"
# ==================== Docker cleanup cron ====================
# Prevent disk from filling up with old Docker images
echo "Setting up Docker cleanup cron..."
cat > /etc/cron.daily/docker-cleanup << 'CRON'
#!/bin/bash
# Clean up Docker resources older than 7 days
docker system prune -af --filter "until=168h"
CRON
chmod +x /etc/cron.daily/docker-cleanup
echo "Setup complete!"
"""
# GitHub runner VM instances (multiple runners for parallel job execution)
NUM_RUNNERS = 10
github_runner_vms = []
for i in range(1, NUM_RUNNERS + 1):
vm = gcp.compute.Instance(
f"github-runner-{i}",
name=f"github-runner-{i}",
machine_type="e2-standard-4", # 4 vCPU, 16GB RAM - good for Docker builds
zone="us-central1-a",
boot_disk=gcp.compute.InstanceBootDiskArgs(
initialize_params=gcp.compute.InstanceBootDiskInitializeParamsArgs(
image="debian-cloud/debian-12",
size=200, # GB - plenty for Docker builds and caches
type="pd-ssd", # SSD for faster I/O
),
),
network_interfaces=[gcp.compute.InstanceNetworkInterfaceArgs(
network="default",
access_configs=[gcp.compute.InstanceNetworkInterfaceAccessConfigArgs()], # Ephemeral IP is fine
)],
service_account=gcp.compute.InstanceServiceAccountArgs(
email=github_runner_sa.email,
scopes=["cloud-platform"],
),
metadata_startup_script=GITHUB_RUNNER_STARTUP_SCRIPT,
tags=["github-runner"],
allow_stopping_for_update=True,
# Ensure the secret exists before creating the VM
# For existing runners (1-5), ignore startup script changes to avoid replacement
opts=pulumi.ResourceOptions(
depends_on=[github_runner_pat_secret],
ignore_changes=["metadataStartupScript"] if i <= 5 else None,
),
)
github_runner_vms.append(vm)
# Export GitHub runner resources
pulumi.export("github_runner_vm_names", [vm.name for vm in github_runner_vms])
pulumi.export("github_runner_service_account", github_runner_sa.email)
@@ -576,6 +576,143 @@
font-size: 1.5rem;
color: var(--success);
}
/* Mobile responsiveness */
@media (max-width: 768px) {
.app {
padding: 12px;
gap: 8px;
height: auto;
min-height: 100vh;
overflow-y: auto;
}
body {
overflow: auto;
}
.header {
flex-direction: column;
align-items: flex-start;
gap: 8px;
}
.header-left {
width: 100%;
}
.header-right {
width: 100%;
justify-content: flex-start;
flex-wrap: wrap;
}
.logo {
font-size: 1rem;
}
.logo-img {
height: 32px;
}
.waveform-player {
flex: none;
min-height: 200px;
}
.waveform-toolbar {
flex-wrap: wrap;
padding: 8px 12px;
gap: 8px;
}
.toolbar-left,
.toolbar-center,
.toolbar-right {
flex-wrap: wrap;
}
.audio-toggle-group {
order: 10;
width: 100%;
justify-content: center;
}
.bottom-section {
flex-direction: column;
}
.mute-panel {
max-height: none;
}
.selection-panel {
width: 100%;
}
.selection-option {
padding: 12px;
}
.btn {
min-height: 44px;
padding: 8px 12px;
}
.btn-icon {
width: 44px;
height: 44px;
}
.audio-toggle {
padding: 8px 12px;
min-height: 40px;
}
.zoom-btn {
width: 40px;
height: 40px;
}
.time-display {
font-size: 0.9rem;
}
}
@media (max-width: 480px) {
.app {
padding: 8px;
}
.header-left {
flex-wrap: wrap;
}
.track-info {
width: 100%;
margin-top: 4px;
}
.waveform-toolbar {
padding: 6px 8px;
}
.toolbar-center {
width: 100%;
justify-content: center;
order: -1;
}
.toolbar-left {
order: 1;
}
.toolbar-right {
order: 2;
width: 100%;
justify-content: space-between;
}
}
</style>
</head>
<body>
@@ -0,0 +1,314 @@
# Agentic AI Lyrics Correction - User Guide
**Last Updated:** 2025-12-26
This guide explains how to use the agentic AI correction system for lyrics transcription.
## Overview
The agentic correction system uses LLMs to classify and correct transcription errors in lyrics. Unlike the rule-based correction handlers, the agentic system:
1. **Classifies gaps first** - Determines the type of error before attempting correction
2. **Routes to specialized handlers** - Each error type has its own handler
3. **Provides detailed reasoning** - Every correction includes confidence and explanation
4. **Supports human review** - Uncertain corrections are flagged for human verification
## Enabling Agentic Correction
### Environment Variables
```bash
# Required: Enable agentic mode
export USE_AGENTIC_AI=1
# Required: Specify model (provider/model format)
export AGENTIC_AI_MODEL="openai/gpt-4" # or "anthropic/claude-3-sonnet-20240229" or "ollama/llama3.2:latest"
# Optional: LLM Provider API keys (only needed for cloud providers)
export OPENAI_API_KEY="your-key" # For OpenAI models
export ANTHROPIC_API_KEY="your-key" # For Anthropic models
# Optional: Observability with Langfuse
export LANGFUSE_PUBLIC_KEY="pk-lf-..."
export LANGFUSE_SECRET_KEY="sk-lf-..."
export LANGFUSE_HOST="https://cloud.langfuse.com"
# Optional: Tuning parameters
export AGENTIC_TIMEOUT_SECONDS=30 # Request timeout
export AGENTIC_MAX_RETRIES=2 # Max retry attempts
export AGENTIC_CIRCUIT_THRESHOLD=3 # Failures before circuit opens
export AGENTIC_CIRCUIT_OPEN_SECONDS=60 # Circuit open duration
export DISABLE_LLM_CACHE=1 # Disable response caching
```
### Supported LLM Providers
| Provider | Model Format | Authentication |
|----------|-------------|----------------|
| **Vertex AI** (GCP) | `vertexai/gemini-3-flash-preview` | GCP service account (ADC) |
| **OpenAI** | `openai/gpt-4`, `openai/gpt-4-turbo` | `OPENAI_API_KEY` |
| **Anthropic** | `anthropic/claude-3-sonnet-20240229` | `ANTHROPIC_API_KEY` |
| **Ollama** (local) | `ollama/llama3.2:latest`, `ollama/mistral:latest` | None |
### Using with Vertex AI (Recommended for Cloud Deployment)
Vertex AI uses Google Cloud's Application Default Credentials (ADC) for authentication. No API key is needed - it uses your GCP service account automatically.
**Cloud Run / GKE:**
```bash
# Set environment variables
export USE_AGENTIC_AI=1
export AGENTIC_AI_MODEL="vertexai/gemini-3-flash-preview"
export GOOGLE_CLOUD_PROJECT="your-project-id"
export GCP_LOCATION="us-central1" # Optional, defaults to us-central1
```
The service account must have the `roles/aiplatform.user` IAM role.
**Local Development:**
```bash
# Authenticate with GCP
gcloud auth application-default login
# Set environment
export USE_AGENTIC_AI=1
export AGENTIC_AI_MODEL="vertexai/gemini-3-flash-preview"
export GOOGLE_CLOUD_PROJECT="your-project-id"
```
### Using with Ollama (Local, Free)
1. Install Ollama: [https://ollama.ai](https://ollama.ai)
2. Pull a model: `ollama pull llama3.2:latest`
3. Set environment:
```bash
export USE_AGENTIC_AI=1
export AGENTIC_AI_MODEL="ollama/llama3.2:latest"
```
## Gap Classification Categories
The agentic system classifies gaps into 8 categories:
| Category | Description | Handler Action |
|----------|-------------|----------------|
| `PUNCTUATION_ONLY` | Style differences (quotes, punctuation) | No action |
| `SOUND_ALIKE` | Homophones ("out" → "now") | Replace word |
| `BACKGROUND_VOCALS` | Parenthesized backing vocals | Delete |
| `EXTRA_WORDS` | Filler words ("And", "But", "Well") | Delete |
| `REPEATED_SECTION` | Chorus/verse repetitions | Flag for human review |
| `COMPLEX_MULTI_ERROR` | Multiple error types | Flag for human review |
| `AMBIGUOUS` | Unclear without audio | Flag for human review |
| `NO_ERROR` | Matches reference lyrics | No action |
## Running with Agentic Correction
### CLI Usage
```bash
# Basic usage with agentic correction
USE_AGENTIC_AI=1 AGENTIC_AI_MODEL="openai/gpt-4" \
lyrics-transcriber /path/to/song.mp3 --artist "Artist" --title "Song"
# With Ollama (free, local)
USE_AGENTIC_AI=1 AGENTIC_AI_MODEL="ollama/llama3.2:latest" \
lyrics-transcriber /path/to/song.mp3 --artist "Artist" --title "Song"
# With debugging output
USE_AGENTIC_AI=1 AGENTIC_AI_MODEL="openai/gpt-4" \
lyrics-transcriber /path/to/song.mp3 --artist "Artist" --title "Song" --log_level debug
```
### As a Library
```python
from lyrics_transcriber import LyricsTranscriber
from lyrics_transcriber.core.controller import TranscriberConfig, LyricsConfig, OutputConfig
import os
# Enable agentic mode
os.environ["USE_AGENTIC_AI"] = "1"
os.environ["AGENTIC_AI_MODEL"] = "openai/gpt-4"
os.environ["OPENAI_API_KEY"] = "your-key"
transcriber = LyricsTranscriber(
audio_filepath="/path/to/song.mp3",
artist="Artist",
title="Title",
transcriber_config=TranscriberConfig(
audioshake_api_token="...",
),
lyrics_config=LyricsConfig(
genius_api_token="...",
),
output_config=OutputConfig(
output_dir="./out",
),
)
result = transcriber.process()
# Check agentic corrections
for correction in result.corrections:
if correction.handler == "AgenticCorrector":
print(f"Agentic correction: {correction.original_word} → {correction.corrected_word}")
print(f" Category: {correction.reason}") # Contains [CATEGORY] tag
print(f" Confidence: {correction.confidence}")
```
## Frontend Review UI
When agentic corrections are made, the review UI shows:
1. **Agentic Correction Metrics Panel** - Summary of corrections by category
2. **Category Icons** - Visual indicators for correction types
3. **Confidence Filters** - Filter by low (<60%) or high (≥80%) confidence
4. **Correction Detail Cards** - Click any corrected word to see:
- Original vs corrected text
- Category classification
- Confidence score
- AI reasoning
- Action buttons (Revert, Edit, Accept)
### Duration Timeline View
Toggle to duration view to see:
- Word timing bars proportional to duration
- Red warning indicators for abnormally long words (>2s)
- Color coding: Green (corrected), Orange (uncorrected gaps), Blue (anchors)
## Observability with Langfuse
When Langfuse is configured, you get:
- **Trace grouping** by session ID
- **Full prompts and responses**
- **Token counts and latency**
- **Cost estimates** for paid APIs
- **Model performance metrics**
Set up at [https://langfuse.com](https://langfuse.com)
## Human Feedback Collection
The system supports collecting feedback on corrections:
### API Endpoints
```bash
# Submit annotation
POST /api/v1/annotations
{
"audio_hash": "abc123",
"annotation_type": "SOUND_ALIKE",
"action_taken": "REPLACE",
"original_text": "out",
"corrected_text": "now",
"confidence": 5,
"reasoning": "Reference lyrics clearly show 'now'"
}
# Get annotations for song
GET /api/v1/annotations/{audio_hash}
# Get statistics
GET /api/v1/annotations/stats
```
### Annotation Storage
Annotations are stored in `{cache_dir}/correction_annotations.jsonl` in JSONL format for easy processing and training data export.
## Troubleshooting
### "Failed to import agentic modules"
Ensure required packages are installed:
```bash
pip install langchain langchain-openai langchain-anthropic langchain-ollama langfuse
```
### "Langfuse keys are set but initialization failed"
Check your Langfuse credentials:
```bash
echo $LANGFUSE_PUBLIC_KEY
echo $LANGFUSE_SECRET_KEY
```
### "Circuit breaker is open"
The system has detected too many failures. Wait 60 seconds or check:
- LLM API is accessible
- API keys are valid
- Model name is correct
### "Timeout waiting for LLM response"
Increase timeout:
```bash
export AGENTIC_TIMEOUT_SECONDS=60
```
## Architecture
```
┌─────────────────────────────────────────────────────────────┐
│ Agentic Correction Flow │
├─────────────────────────────────────────────────────────────┤
│ │
│ 1. Gap Found │
│ │ │
│ ▼ │
│ 2. Classification Prompt → LLM │
│ │ │
│ ▼ │
│ 3. GapClassification (category, confidence, reasoning) │
│ │ │
│ ▼ │
│ 4. Handler Registry → Specialized Handler │
│ │ │
│ ├── SOUND_ALIKE → SoundAlikeHandler → Replace │
│ ├── BACKGROUND_VOCALS → BackgroundVocalsHandler → Delete│
│ ├── EXTRA_WORDS → ExtraWordsHandler → Delete │
│ ├── PUNCTUATION_ONLY → PunctuationHandler → No Action │
│ ├── NO_ERROR → NoErrorHandler → No Action │
│ └── AMBIGUOUS/COMPLEX/REPEATED → Flag for Human Review │
│ │ │
│ ▼ │
│ 5. CorrectionProposal(s) returned │
│ │ │
│ ▼ │
│ 6. Adapter → WordCorrection(s) for frontend │
│ │
└─────────────────────────────────────────────────────────────┘
```
## Files Reference
| File | Purpose |
|------|---------|
| `correction/agentic/agent.py` | Main AgenticCorrector class |
| `correction/agentic/adapter.py` | Converts proposals to WordCorrection |
| `correction/agentic/router.py` | Model selection logic |
| `correction/agentic/handlers/` | Category-specific handlers |
| `correction/agentic/models/schemas.py` | Pydantic models |
| `correction/agentic/prompts/classifier.py` | Classification prompt |
| `correction/agentic/providers/` | LLM provider implementations |
| `correction/feedback/` | Human feedback collection |
## Contributing
When adding new gap categories or handlers:
1. Add category to `GapCategory` enum in `models/schemas.py`
2. Create handler in `handlers/` extending `BaseHandler`
3. Register handler in `handlers/registry.py`
4. Add few-shot examples to `prompts/classifier.py`
5. Add tests in `tests/unit/correction/agentic/`
## See Also
- [AGENTIC_IMPLEMENTATION_STATUS.md](./AGENTIC_IMPLEMENTATION_STATUS.md) - Implementation progress
- [AGENTIC_UI_IMPROVEMENTS_COMPLETE.md](./AGENTIC_UI_IMPROVEMENTS_COMPLETE.md) - Frontend features
- [LANGCHAIN_MIGRATION.md](./LANGCHAIN_MIGRATION.md) - LangChain architecture details
@@ -1,450 +1,187 @@
# Agentic Correction System - Implementation Status
**Last Updated:** 2025-10-27
**Status:** Phase 1 and Phase 2 (Backend) Complete
**Last Updated:** 2025-12-26
**Status:** Core Implementation Complete, Ready for User Testing
## Overview
This document tracks the implementation of the classification-first agentic correction system with human feedback loop as specified in the plan.
The agentic AI correction system for lyrics transcription is now feature-complete for the core workflow. This document tracks implementation status and what's available for testing.
## ✅ Completed
## ✅ Completed Features
### Phase 1: Classification-First Correction Workflow
#### 1.1 Gap Classification Schema ✅
**File:** `lyrics_transcriber/correction/agentic/models/schemas.py`
#### Gap Classification System
- **8 classification categories**: PUNCTUATION_ONLY, SOUND_ALIKE, BACKGROUND_VOCALS, EXTRA_WORDS, REPEATED_SECTION, COMPLEX_MULTI_ERROR, AMBIGUOUS, NO_ERROR
- **Category-specific handlers** for each type with appropriate actions
- **Classification prompt** with few-shot examples
- **Handler registry pattern** for extensibility
- Added `GapCategory` enum with 8 categories:
- `PUNCTUATION_ONLY`: Style differences only
- `SOUND_ALIKE`: Homophones and similar-sounding errors
- `BACKGROUND_VOCALS`: Transcribed backing vocals in parentheses
- `EXTRA_WORDS`: Filler words like "And", "But"
- `REPEATED_SECTION`: Chorus repetitions
- `COMPLEX_MULTI_ERROR`: Large gaps with multiple error types
- `AMBIGUOUS`: Unclear without audio
- `NO_ERROR`: Matches at least one reference source
#### LLM Provider Support
- **OpenAI** (GPT-4, GPT-4-turbo)
- **Anthropic** (Claude 3 Sonnet)
- **Ollama** (local, free - llama3.2, mistral)
- **LangChain integration** for unified API
- Added `GapClassification` model with fields:
- `gap_id`: Unique identifier
- `category`: Gap category
- `confidence`: 0-1 score
- `reasoning`: Explanation
- `suggested_handler`: Handler recommendation
#### Reliability Features
- **Circuit breaker** pattern for failure protection
- **Configurable retries** and timeouts
- **Graceful degradation** to FLAG for human review
- Updated `CorrectionProposal` with:
- `gap_category`: Classification category
- `requires_human_review`: Flag for manual review
- `artist`, `title`: Song metadata
- Added "NoAction" and "Flag" to action types
### Phase 2: Human Feedback Collection
#### 1.2 Classification Prompt ✅
**File:** `lyrics_transcriber/correction/agentic/prompts/classifier.py`
#### Backend API
- `POST /api/v1/annotations` - Save correction annotations
- `GET /api/v1/annotations/{audio_hash}` - Get annotations for song
- `GET /api/v1/annotations/stats` - Aggregated statistics
- Created `build_classification_prompt()` function that:
- Includes gap text, context, and reference lyrics from all sources
- Includes artist/title for proper noun context
- Provides few-shot examples from `gaps_review.yaml`
- Requests structured JSON output matching `GapClassification` schema
#### Storage
- JSONL format for easy parsing and export
- Automatic datetime serialization
- Training data export capability
- Implemented `load_few_shot_examples()` with:
- Dynamic loading from `examples.yaml` (if exists)
- Hardcoded fallback examples covering all categories
- Examples extracted directly from your manual gap annotations
### Phase 3: Frontend UI Enhancements
#### 1.3 Category-Specific Handlers ✅
**Files:** `lyrics_transcriber/correction/agentic/handlers/`
#### Agentic Correction Metrics Panel
- Shows correction counts by category
- Visual icons for each gap category
- Confidence distribution filtering
Implemented 8 handler classes:
#### Correction Detail Cards
- Click any corrected word to see details
- Shows original vs corrected text
- Displays AI reasoning and confidence
- Action buttons: Revert, Edit, Accept
1. **`PunctuationHandler`**: Returns NO_ACTION for style differences
2. **`NoErrorHandler`**: Returns NO_ACTION when reference matches
3. **`BackgroundVocalsHandler`**: Proposes DELETE for parenthesized content
4. **`ExtraWordsHandler`**: Detects and removes filler words
5. **`SoundAlikeHandler`**: Extracts replacement from reference context
6. **`RepeatedSectionHandler`**: Flags for human review
7. **`ComplexMultiErrorHandler`**: Flags complex gaps
8. **`AmbiguousHandler`**: Flags unclear cases
#### Duration Timeline View
- Toggle to see word timing proportions
- Warning indicators for abnormally long words (>2s)
- Color coding: Green (corrected), Orange (gaps), Blue (anchors)
- Created `HandlerRegistry` for mapping categories to handlers
- All handlers extend `BaseHandler` abstract class
- Handlers return `CorrectionProposal` objects with metadata
### Phase 4: Observability
#### 1.4 AgenticCorrector Workflow ✅
**File:** `lyrics_transcriber/correction/agentic/agent.py`
#### Langfuse Integration
- Automatic trace grouping by session
- Full prompt/response logging
- Token counts and latency metrics
- Cost estimation for paid APIs
- Added `classify_gap()` method:
- Builds classification prompt
- Calls AI provider for classification
- Returns `GapClassification` or None
### Phase 5: Testing Infrastructure
- Added `propose_for_gap()` method implementing two-step workflow:
1. Classify the gap using LLM
2. Route to appropriate handler based on category
3. Handler generates correction proposals
4. Add metadata (artist, title, category) to proposals
5. Handle errors gracefully with fallback to FLAG
#### Unit Tests
- 15 tests covering agentic handlers and feedback store
- All tests passing
- Kept legacy `propose()` method marked as deprecated
#### E2E Tests (Playwright)
- Test fixtures with mock agentic correction data
- UI component tests
- File upload flow tests
- 7 tests passing
#### 1.5 LyricsCorrector Integration ✅
**File:** `lyrics_transcriber/correction/corrector.py`
## 🚧 Future Enhancements (Not Blocking)
- Updated agentic correction section to:
- Prepare structured gap data (words with IDs, times)
- Extract context (10 preceding/following words)
- Build reference contexts from all sources
- Pass artist and title from metadata
- Call new `propose_for_gap()` method instead of old prompt-based approach
### Frontend Annotation Modal
- `CorrectionAnnotationModal.tsx` - UI for collecting human feedback on corrections
- Would trigger after user edits for training data collection
- Low priority - can use raw API for now
### Phase 2: Human Feedback Collection System (Backend)
### Analysis Scripts
- `scripts/analyze_annotations.py` - Generate reports from collected annotations
- `scripts/generate_few_shot_examples.py` - Auto-generate prompt examples from feedback
#### 2.1 Correction Annotation Schema ✅
**File:** `lyrics_transcriber/correction/feedback/schemas.py`
### A/B Testing Framework
- Compare different prompt versions
- Track model performance over time
- Created `CorrectionAnnotationType` enum (9 types including MANUAL_EDIT)
- Created `CorrectionAction` enum (7 actions: NO_ACTION, REPLACE, DELETE, INSERT, MERGE, SPLIT, FLAG)
## Quick Start
- Created `CorrectionAnnotation` model with:
- Unique `annotation_id` (UUID)
- Song identification (`audio_hash`, `artist`, `title`)
- Classification (`annotation_type`, `action_taken`)
- Content (`original_text`, `corrected_text`)
- Human metadata (`confidence` 1-5, `reasoning` min 10 chars)
- Agentic comparison (`agentic_proposal`, `agentic_category`, `agentic_agreed`)
- Reference tracking (`reference_sources_consulted`)
- Session tracking (`session_id`, `timestamp`)
### Enable Agentic Correction
- Created `AnnotationStatistics` for aggregated metrics
#### 2.2 Feedback Storage Backend ✅
**File:** `lyrics_transcriber/correction/feedback/store.py`
- Implemented `FeedbackStore` class with JSONL storage:
- File: `{cache_dir}/correction_annotations.jsonl`
- One annotation per line for easy appending
- Automatic datetime serialization/deserialization
- Methods implemented:
- `save_annotation()`: Save single annotation
- `save_annotations()`: Batch save
- `get_all_annotations()`: Load all with error recovery
- `get_annotations_by_song()`: Filter by audio hash
- `get_annotations_by_category()`: Filter by type
- `get_statistics()`: Aggregate metrics (counts, averages, patterns)
- `export_to_training_data()`: Export high-confidence annotations for fine-tuning
#### 2.3 Backend API Endpoints ✅
**File:** `lyrics_transcriber/review/server.py`
- Initialized `NewFeedbackStore` in `ReviewServer.__init__()`
- Added 3 new API endpoints:
- `POST /api/v1/annotations`: Save annotation with validation
- `GET /api/v1/annotations/{audio_hash}`: Get annotations for song
- `GET /api/v1/annotations/stats`: Get aggregated statistics
- All endpoints include proper error handling and HTTP status codes
## 🚧 In Progress / Not Started
### Phase 2: Human Feedback Collection (Frontend)
#### 2.4 UI Annotation Modal Component ⏳
**File:** `lyrics_transcriber/frontend/src/components/CorrectionAnnotationModal.tsx` (to create)
**Required:** React modal component with:
- Annotation type dropdown (9 categories)
- Confidence slider (1-5 scale)
- Reasoning textarea (required, min 10 chars)
- Display of agentic AI suggestion (if applicable)
- Display of reference lyrics context
- "Save & Continue" and "Skip" buttons
- Local state management until final submission
#### 2.5 Edit Workflow Integration ⏳
**Files:**
- `lyrics_transcriber/frontend/src/components/EditModal.tsx`
- `lyrics_transcriber/frontend/src/components/EditWordList.tsx`
**Required:** Wrap edit actions to trigger annotation modal:
- Show modal after user confirms word edit/delete/merge/split
- Collect annotation data in React state
- Submit all annotations on "Finish Review"
- Add settings toggle for "Enable correction annotations"
#### 2.6 Frontend Types and API Client ⏳
**Files:**
- `lyrics_transcriber/frontend/src/types.ts`
- `lyrics_transcriber/frontend/src/api.ts`
**Required:**
- Add `CorrectionAnnotation` TypeScript interface
- Add `submitAnnotations()` method to API client
- Add `getAnnotationStats()` method
### Phase 3: Continuous Improvement Infrastructure
#### 3.1 Analysis Scripts ⏳
**File:** `scripts/analyze_annotations.py` (to create)
**Required:** Python script that:
- Loads all annotations from JSONL
- Generates Markdown report with:
- Most common error categories
- Agentic AI accuracy by category
- Frequently mis-heard words/phrases
- Cases where reference lyrics were wrong
- Outputs to `CORRECTION_ANALYSIS.md`
#### 3.2 Few-Shot Example Generator ⏳
**File:** `scripts/generate_few_shot_examples.py` (to create)
**Required:** Python script that:
- Selects high-confidence annotations (confidence >= 4)
- Formats as YAML prompt examples
- Outputs to `lyrics_transcriber/correction/agentic/prompts/examples.yaml`
- Can be run periodically to update classifier
#### 3.3 Classifier Dynamic Examples ⏳
**File:** `lyrics_transcriber/correction/agentic/prompts/classifier.py` (update)
**Required:**
- Already has `load_few_shot_examples()` infrastructure
- Will automatically load from `examples.yaml` if file exists
- No changes needed - just need to generate the YAML file
#### 3.4 Feedback Loop Documentation ⏳
**File:** `HUMAN_FEEDBACK_LOOP.md` (to create)
**Required:** Document:
- How to use annotation collection in UI
- How to run analysis scripts
- How to regenerate few-shot examples
- How to evaluate improvement over time
- Path to fine-tuning custom model with RLHF
### Phase 4: Testing and Validation
#### 4.1 Unit Tests ⏳
**File:** `tests/unit/correction/test_classifier.py` (to create)
**Required:** Test cases for:
- Gap classifier with examples from `gaps_review.yaml`
- Each category handler
- Edge cases (ambiguous, no reference match)
#### 4.2 Integration Tests ⏳
**File:** `tests/integration/test_agentic_workflow.py` (update)
**Required:** End-to-end tests:
- Classification → correction flow
- Use Time Bomb song as fixture
- Verify correct handlers are invoked
- Verify FLAG actions for ambiguous cases
#### 4.3 Feedback System Tests ⏳
**File:** `tests/unit/correction/test_feedback_store.py` (to create)
**Required:** Test cases for:
- Save and retrieve annotations
- JSONL format correctness
- Statistics generation
- Training data export
## Testing the Implementation
### Backend Testing (Can be done now)
1. **Test Classification Workflow:**
```bash
USE_AGENTIC_AI=1 python -m lyrics_transcriber.cli.cli_main Time-Bomb.flac \
--artist "Rancid" --title "Time Bomb"
# Required
export USE_AGENTIC_AI=1
export AGENTIC_AI_MODEL="openai/gpt-4" # or "anthropic/claude-3-sonnet-20240229" or "ollama/llama3.2:latest"
# For cloud providers
export OPENAI_API_KEY="your-key" # For OpenAI
export ANTHROPIC_API_KEY="your-key" # For Anthropic
# Optional: Observability
export LANGFUSE_PUBLIC_KEY="pk-lf-..."
export LANGFUSE_SECRET_KEY="sk-lf-..."
```
Expected: Gaps will be classified into categories, handlers will propose corrections
### Run with Agentic Correction
2. **Test Annotation Storage:**
```python
from lyrics_transcriber.correction.feedback.store import FeedbackStore
from lyrics_transcriber.correction.feedback.schemas import CorrectionAnnotation, CorrectionAnnotationType, CorrectionAction
store = FeedbackStore("cache")
annotation = CorrectionAnnotation(
audio_hash="test123",
annotation_type=CorrectionAnnotationType.SOUND_ALIKE,
action_taken=CorrectionAction.REPLACE,
original_text="out",
corrected_text="now",
confidence=5.0,
reasoning="Reference lyrics confirm it should be 'now'",
artist="Rancid",
title="Time Bomb",
session_id="test_session"
)
store.save_annotation(annotation)
stats = store.get_statistics()
print(stats)
```
3. **Test API Endpoints:**
```bash
# Start review server and test endpoints
curl -X POST http://localhost:8000/api/v1/annotations \
-H "Content-Type: application/json" \
-d '{"audio_hash": "test", "annotation_type": "sound_alike", ...}'
# With OpenAI
USE_AGENTIC_AI=1 AGENTIC_AI_MODEL="openai/gpt-4" \
lyrics-transcriber /path/to/song.mp3 --artist "Artist" --title "Song"
curl http://localhost:8000/api/v1/annotations/stats
# With local Ollama (free)
USE_AGENTIC_AI=1 AGENTIC_AI_MODEL="ollama/llama3.2:latest" \
lyrics-transcriber /path/to/song.mp3 --artist "Artist" --title "Song"
```
### Frontend Testing (Once UI is implemented)
### Run Frontend Tests
1. Open review UI
2. Make a correction (edit/delete/merge word)
3. Annotation modal should appear
4. Fill in annotation details
5. Click "Save & Continue"
6. Make more corrections
7. Click "Finish Review"
8. Check `cache/correction_annotations.jsonl` for saved data
```bash
cd lyrics_transcriber_temp/lyrics_transcriber/frontend
yarn install
yarn playwright install --with-deps chromium
yarn test
```
## Architecture Decisions
## File Reference
### Classification-First Approach
- **Why:** Breaks complex problem into simpler steps
- **Benefit:** Each handler can focus on one error type
- **Trade-off:** Two LLM calls per gap (classification + handler logic), but handlers are deterministic
| Component | Files |
|-----------|-------|
| Core Agent | `correction/agentic/agent.py` |
| Handlers | `correction/agentic/handlers/*.py` |
| Classification Prompt | `correction/agentic/prompts/classifier.py` |
| LLM Providers | `correction/agentic/providers/*.py` |
| Feedback Storage | `correction/feedback/store.py` |
| API Endpoints | `review/server.py` |
| Frontend Metrics | `frontend/src/components/AgenticCorrectionMetrics.tsx` |
| Frontend Detail Card | `frontend/src/components/CorrectionDetailCard.tsx` |
| E2E Tests | `frontend/e2e/agentic-corrections.spec.ts` |
### JSONL Storage
- **Why:** Simple, append-only, no database required
- **Benefit:** Easy to parse, version control friendly, portable
- **Trade-off:** Not suitable for millions of annotations (but we expect hundreds/thousands)
## Architecture
### Fail-Fast on Errors
- **Why:** Better to flag for human review than make wrong correction
- **Benefit:** Maintains transcription quality
- **Trade-off:** More human review needed initially (improves over time with feedback)
```
┌─────────────────────────────────────────────────────────────┐
│ Agentic Correction Flow │
├─────────────────────────────────────────────────────────────┤
│ │
│ 1. Gap Found in Transcription │
│ │ │
│ ▼ │
│ 2. Classification Prompt → LLM │
│ │ │
│ ▼ │
│ 3. GapClassification (category, confidence, reasoning) │
│ │ │
│ ▼ │
│ 4. Handler Registry → Specialized Handler │
│ │ │
│ ├── SOUND_ALIKE → SoundAlikeHandler → Replace │
│ ├── BACKGROUND_VOCALS → BackgroundVocalsHandler → Delete│
│ ├── EXTRA_WORDS → ExtraWordsHandler → Delete │
│ ├── PUNCTUATION_ONLY → PunctuationHandler → No Action │
│ ├── NO_ERROR → NoErrorHandler → No Action │
│ └── AMBIGUOUS/COMPLEX/REPEATED → Flag for Human Review │
│ │ │
│ ▼ │
│ 5. CorrectionProposal(s) returned │
│ │ │
│ ▼ │
│ 6. Adapter → WordCorrection(s) for frontend │
│ │
└─────────────────────────────────────────────────────────────┘
```
### Handler Registry Pattern
- **Why:** Easy to add new category handlers
- **Benefit:** Extensible, testable, follows Open/Closed Principle
- **Trade-off:** Slightly more complex than if/else routing
## Next Steps
**Priority 1 (Required for feedback loop):**
1. Implement `CorrectionAnnotationModal.tsx`
2. Integrate modal into edit workflow
3. Update frontend types and API client
4. Test end-to-end annotation collection
**Priority 2 (Analysis and improvement):**
5. Create `analyze_annotations.py` script
6. Create `generate_few_shot_examples.py` script
7. Generate initial `examples.yaml` from collected data
8. Document feedback loop in `HUMAN_FEEDBACK_LOOP.md`
**Priority 3 (Validation):**
9. Write unit tests for classifiers and handlers
10. Write integration tests for full workflow
11. Write tests for feedback store
## Files Created
### Python Backend
- `lyrics_transcriber/correction/agentic/models/schemas.py` (updated)
- `lyrics_transcriber/correction/agentic/prompts/__init__.py` (new)
- `lyrics_transcriber/correction/agentic/prompts/classifier.py` (new)
- `lyrics_transcriber/correction/agentic/handlers/__init__.py` (new)
- `lyrics_transcriber/correction/agentic/handlers/base.py` (new)
- `lyrics_transcriber/correction/agentic/handlers/punctuation.py` (new)
- `lyrics_transcriber/correction/agentic/handlers/no_error.py` (new)
- `lyrics_transcriber/correction/agentic/handlers/background_vocals.py` (new)
- `lyrics_transcriber/correction/agentic/handlers/extra_words.py` (new)
- `lyrics_transcriber/correction/agentic/handlers/sound_alike.py` (new)
- `lyrics_transcriber/correction/agentic/handlers/repeated_section.py` (new)
- `lyrics_transcriber/correction/agentic/handlers/complex_multi_error.py` (new)
- `lyrics_transcriber/correction/agentic/handlers/ambiguous.py` (new)
- `lyrics_transcriber/correction/agentic/handlers/registry.py` (new)
- `lyrics_transcriber/correction/agentic/agent.py` (updated)
- `lyrics_transcriber/correction/corrector.py` (updated)
- `lyrics_transcriber/correction/feedback/__init__.py` (new)
- `lyrics_transcriber/correction/feedback/schemas.py` (new)
- `lyrics_transcriber/correction/feedback/store.py` (new)
- `lyrics_transcriber/review/server.py` (updated)
### Documentation
- `AGENTIC_IMPLEMENTATION_STATUS.md` (this file)
## Known Issues / Limitations
1. **Classification accuracy depends on LLM quality**
- Solution: Use better models (GPT-4, Claude Sonnet) for classification
- Solution: Collect human feedback to improve prompts
2. **SoundAlikeHandler may fail to extract replacement**
- Fallback: Flags for human review
- Future: Use fuzzy matching and phonetic algorithms
3. **No A/B testing framework yet**
- Can't compare different prompt versions easily
- Future enhancement: Track model performance over time
4. **Frontend not implemented**
- Can't collect human feedback yet
- Priority for next implementation phase
## Fixes Applied
### Enum Value Case Mismatch (2025-10-27)
**Issue:** LLM was returning category values in uppercase (e.g., `"SOUND_ALIKE"`) but Pydantic enum expected lowercase with underscores (e.g., `"sound_alike"`), causing validation errors.
**Fix:** Updated all enum values in `GapCategory` and `CorrectionAnnotationType` to use uppercase format that LLMs naturally return. Also updated the prompt to explicitly show the expected format.
**Files Changed:**
- `lyrics_transcriber/correction/agentic/models/schemas.py`
- `lyrics_transcriber/correction/feedback/schemas.py`
- `lyrics_transcriber/correction/agentic/prompts/classifier.py`
### JSON Parsing with Invalid Escapes (2025-10-27)
**Issue:** LLM responses contained invalid JSON escape sequences like `\'` (e.g., in `"out, I\'m"`), which caused JSON parsing to fail. Python's json.loads() only allows specific escape sequences (`\"`, `\\`, `\/`, `\b`, `\f`, `\n`, `\r`, `\t`).
**Fix:** Enhanced `ResponseParser` to automatically fix common JSON issues before parsing:
- Replace invalid `\'` with `'` (single quotes don't need escaping in JSON)
- Remove trailing commas before `}` or `]`
- Retry parsing after fixes before falling back to raw response
**Files Changed:**
- `lyrics_transcriber/correction/agentic/providers/response_parser.py`
**Result:** System now handles LLM responses with imperfect JSON formatting gracefully.
## Performance Considerations
- **Two LLM calls per gap:** Classification + handler logic (if handler needs LLM)
- Most handlers are deterministic (no LLM call)
- Only `SoundAlikeHandler` might need LLM for complex cases
- **JSONL file grows linearly:**
- ~1KB per annotation
- 1000 annotations = ~1MB
- Should be fine for years of use
- **Frontend modal after each edit:**
- Could be annoying for many edits
- Consider: Batch annotation at end instead
- Add "Skip" button and settings toggle
## Success Metrics
Once implemented, track:
1. **Annotation Collection Rate:** % of corrections that get annotated
2. **Agentic Agreement Rate:** % where human agrees with AI proposal
3. **Classification Accuracy:** % correctly classified by category (human-verified)
4. **Correction Quality Over Time:** Track accuracy improvements as more feedback collected
5. **Human Review Rate:** % of gaps flagged vs auto-corrected (should decrease over time)
## References
- Original plan: `.cursor/plans/agentic-correction-system-*.plan.md`
- Manual gap annotations: `gaps_review.yaml`
- Test song: `Time-Bomb.flac` by Rancid
## See Also
- [AGENTIC_CORRECTION_GUIDE.md](./AGENTIC_CORRECTION_GUIDE.md) - User guide for the agentic system
- [AGENTIC_UI_IMPROVEMENTS_COMPLETE.md](./AGENTIC_UI_IMPROVEMENTS_COMPLETE.md) - Frontend feature details
- [LANGCHAIN_MIGRATION.md](./LANGCHAIN_MIGRATION.md) - LangChain architecture details
@@ -1,165 +0,0 @@
# Agentic AI Corrector - Next Steps
## Current Status ✅
- ✅ Sessions working - All traces grouped in Langfuse
- ✅ LangChain + LangGraph integrated
- ✅ Circuit breaker and retry logic
- ✅ Observability with Langfuse
- ✅ Gap extraction code added to `corrector.py`
## Problems Identified 🔍
### 1. Adapter Always Returns 0 Corrections
**Root Cause**: LLM proposals don't include `word_id`, so the adapter can't map them to actual words.
**Why**: The prompt doesn't:
- Provide structured word data with IDs
- Request word IDs in the response
- Give enough context for unambiguous identification
### 2. LLM Proposals Are Too Aggressive
**Issue**: LLM suggests corrections for stylistic differences (quotes, spacing, etc.) that don't need fixing.
**Why**: No classification step - the LLM jumps straight to proposing actions without first determining if the gap needs correction.
### 3. Proposals Lack Actionable Detail
**Issue**: Responses like `"replacement_text": "I'm gonna"` don't specify:
- Which word to replace
- Where to insert it
- What to do with surrounding words
**Why**: The prompt is too vague and doesn't enforce structured, unambiguous actions.
## Next Steps 📋
### Step 1: Extract Gap Data (YOU)
Run this command:
```bash
DUMP_GAPS=1 USE_AGENTIC_AI=0 python -m lyrics_transcriber.cli.cli_main Time-Bomb.flac \
--artist "Rancid" --title "Time Bomb"
```
This creates `gaps_review.yaml` with all gap data.
### Step 2: Manual Annotation (YOU)
Open `gaps_review.yaml` and for each gap (recommend doing 10-20), fill in:
```yaml
annotations:
your_decision: "Replace 'out,' with 'now'"
action_type: "REPLACE"
target_word_ids: ["w7"]
replacement_text: "now"
notes: "Transcription error - reference says 'now'"
```
See `HOW_TO_EXTRACT_GAPS.md` for detailed examples.
### Step 3: Workflow Redesign (ME)
Based on your annotations, I'll:
#### A. Fix the Prompt
```python
prompt = f"""You are correcting transcription errors in song lyrics.
TRANSCRIBED WORDS (may contain errors):
{json.dumps([{"id": w.id, "text": w.text, "time": w.start_time} for w in gap_words], indent=2)}
REFERENCE LYRICS CONTEXT:
{ref_text}
TASK:
1. First, classify if this gap needs correction:
- Compare transcribed words to reference
- Ignore stylistic differences (quotes, punctuation, spacing)
- Only flag actual transcription errors
2. If correction is needed, propose actions with specific word IDs:
- Use the "id" field to identify which word(s) to operate on
- Be precise and unambiguous
OUTPUT FORMAT:
{{
"needs_correction": true/false,
"reason": "Brief explanation",
"proposals": [
{{
"target_word_ids": ["w7"], // Which words to operate on
"action": "REPLACE",
"replacement_text": "now",
"confidence": 0.95,
"reason": "Transcription error"
}}
]
}}
"""
```
#### B. Update the Schema
```python
class CorrectionDecision(BaseModel):
needs_correction: bool
reason: str
proposals: List[CorrectionProposal]
class CorrectionProposal(BaseModel):
target_word_ids: List[str] # Now required!
action: Literal["REPLACE", "DELETE", "INSERT", "MERGE", "SPLIT", "NO_ACTION"]
replacement_text: Optional[str]
insert_position: Optional[Literal["before", "after"]] # For INSERT
confidence: float
reason: str
```
#### C. Fix the Adapter
```python
def adapt_proposals_to_word_corrections(
decision: CorrectionDecision,
word_map: Dict[str, Word],
linear_position_map: Dict[str, int],
) -> List[WordCorrection]:
"""Convert proposals with proper word ID mapping."""
if not decision.needs_correction:
return [] # Early exit
results = []
for proposal in decision.proposals:
# Now we have target_word_ids!
for word_id in proposal.target_word_ids:
if word_id not in word_map:
logger.warning(f"Word ID {word_id} not found in word_map")
continue
word = word_map[word_id]
# ... create WordCorrection with proper mapping
```
### Step 4: Testing (ME)
- Update integration tests
- Verify proposals → corrections flow works
- Check Langfuse traces show proper structure
### Step 5: Iteration (BOTH)
- Run on Time-Bomb with new workflow
- Compare results to your annotations
- Refine prompt/schema based on accuracy
## Expected Outcome 🎯
After this iteration:
- ✅ LLM proposals include word IDs
- ✅ Adapter successfully creates corrections
- ✅ Classification step reduces false positives
- ✅ Actions are precise and unambiguous
- ✅ You see actual corrections being applied
## Timeline
- **Now**: Gap extraction code is ready
- **You**: Extract and annotate gaps (30-60 min?)
- **Me**: Redesign based on annotations (1-2 hours)
- **Together**: Test and iterate (30 min)
Ready to extract those gaps? 🚀
@@ -11,12 +11,13 @@ class TranscriberConfig:
runpod_api_key: Optional[str] = None
whisper_runpod_id: Optional[str] = None
# Local Whisper configuration
# Local Whisper configuration - reads from environment variables with sensible defaults
# Environment variables: WHISPER_MODEL_SIZE, WHISPER_DEVICE, WHISPER_CACHE_DIR, WHISPER_LANGUAGE
enable_local_whisper: bool = True # Enabled by default as fallback
local_whisper_model_size: str = "medium" # tiny, base, small, medium, large
local_whisper_device: Optional[str] = None # None for auto-detect, or cpu/cuda/mps
local_whisper_cache_dir: Optional[str] = None # Custom model download location
local_whisper_language: Optional[str] = None # None for auto-detect
local_whisper_model_size: str = field(default_factory=lambda: os.getenv("WHISPER_MODEL_SIZE", "medium"))
local_whisper_device: Optional[str] = field(default_factory=lambda: os.getenv("WHISPER_DEVICE"))
local_whisper_cache_dir: Optional[str] = field(default_factory=lambda: os.getenv("WHISPER_CACHE_DIR"))
local_whisper_language: Optional[str] = field(default_factory=lambda: os.getenv("WHISPER_LANGUAGE"))
@dataclass
@@ -18,6 +18,10 @@ class ProviderConfig:
privacy_mode: bool
cache_dir: str
# GCP/Vertex AI settings
gcp_project_id: Optional[str] = None
gcp_location: str = "us-central1"
request_timeout_seconds: float = 30.0
max_retries: int = 2
retry_backoff_base_seconds: float = 0.2
@@ -46,6 +50,8 @@ class ProviderConfig:
openrouter_api_key=os.getenv("OPENROUTER_API_KEY"),
privacy_mode=os.getenv("PRIVACY_MODE", "false").lower() in {"1", "true", "yes"},
cache_dir=cache_dir,
gcp_project_id=os.getenv("GOOGLE_CLOUD_PROJECT") or os.getenv("GCP_PROJECT_ID"),
gcp_location=os.getenv("GCP_LOCATION", "us-central1"),
request_timeout_seconds=float(os.getenv("AGENTIC_TIMEOUT_SECONDS", "30.0")),
max_retries=int(os.getenv("AGENTIC_MAX_RETRIES", "2")),
retry_backoff_base_seconds=float(os.getenv("AGENTIC_BACKOFF_BASE_SECONDS", "0.2")),
@@ -155,6 +155,8 @@ class ModelFactory:
return self._create_openai_model(model_name, callbacks, config)
elif provider == "anthropic":
return self._create_anthropic_model(model_name, callbacks, config)
elif provider in ("vertexai", "google"):
return self._create_vertexai_model(model_name, callbacks, config)
else:
raise ValueError(f"Unsupported provider: {provider}")
except ImportError as e:
@@ -197,7 +199,7 @@ class ModelFactory:
) -> Any:
"""Create ChatAnthropic model."""
from langchain_anthropic import ChatAnthropic
model = ChatAnthropic(
model=model_name,
timeout=config.request_timeout_seconds,
@@ -207,3 +209,24 @@ class ModelFactory:
logger.debug(f"🤖 Created Anthropic model: {model_name}")
return model
def _create_vertexai_model(
self, model_name: str, callbacks: List[Any], config: ProviderConfig
) -> Any:
"""Create ChatVertexAI model for Google Gemini via Vertex AI.
Uses Application Default Credentials (ADC) for authentication.
In Cloud Run, this uses the service account automatically.
Locally, run: gcloud auth application-default login
"""
from langchain_google_vertexai import ChatVertexAI
model = ChatVertexAI(
model=model_name,
project=config.gcp_project_id,
location=config.gcp_location,
max_retries=config.max_retries,
callbacks=callbacks,
)
logger.debug(f"🤖 Created Vertex AI model: {model_name} (project={config.gcp_project_id})")
return model
@@ -5,6 +5,9 @@ from typing import Dict, Any
from .providers.config import ProviderConfig
# Default model for cloud deployments - Gemini 3 Flash via Vertex AI
DEFAULT_CLOUD_MODEL = "vertexai/gemini-3-flash-preview"
class ModelRouter:
"""Rules-based routing by gap type/length/uncertainty (scaffold)."""
@@ -14,22 +17,23 @@ class ModelRouter:
def choose_model(self, gap_type: str, uncertainty: float) -> str:
"""Choose appropriate model based on gap characteristics.
Returns model identifier in format "provider/model" for LangChain:
- "ollama/gpt-oss:latest" for local Ollama models
- "openai/gpt-4" for OpenAI models
- "vertexai/gemini-3-flash-preview" for Gemini via Vertex AI (default)
- "ollama/llama3.2:latest" for local Ollama models
- "openai/gpt-4" for OpenAI models
- "anthropic/claude-3-sonnet-20240229" for Anthropic models
"""
# Simple baseline per technical guidance
# Check for explicit model override from environment
env_model = os.getenv("AGENTIC_AI_MODEL")
if env_model:
return env_model
# Privacy mode: use local Ollama
if self._config.privacy_mode:
# Use the actual model from env, or default to a common Ollama model
return os.getenv("AGENTIC_AI_MODEL", "ollama/gpt-oss:latest")
# For high-uncertainty gaps, use Claude (best reasoning)
if uncertainty > 0.5:
return "anthropic/claude-3-sonnet-20240229"
# Default to GPT-4 for general cases
return "openai/gpt-4"
return "ollama/llama3.2:latest"
# Default to Gemini 3 Flash for all cases (fast, cost-effective)
return DEFAULT_CLOUD_MODEL
@@ -21,3 +21,4 @@ dist-ssr
*.njsproj
*.sln
*.sw?
test-results/
@@ -0,0 +1,207 @@
import { test, expect } from '@playwright/test';
import * as path from 'path';
import { fileURLToPath } from 'url';
// Get __dirname equivalent in ESM
const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);
/**
* E2E tests for the agentic correction workflow in the lyrics transcriber frontend.
*
* These tests verify:
* 1. The UI loads correctly with agentic correction data
* 2. The AgenticCorrectionMetrics panel displays correctly
* 3. Corrected words are highlighted and clickable
* 4. The CorrectionDetailCard shows proper information
*/
// Helper function to load fixture data
async function loadFixtureData(page: import('@playwright/test').Page) {
const fixturePath = path.join(__dirname, 'fixtures', 'agentic-correction-data.json');
// Create a file chooser promise before clicking
const fileChooserPromise = page.waitForEvent('filechooser');
// Click the Load File button
await page.getByRole('button', { name: /load file/i }).click();
// Handle the file chooser
const fileChooser = await fileChooserPromise;
await fileChooser.setFiles(fixturePath);
// Wait for data to load by asserting expected content appears
await expect(page.getByText('Hello,')).toBeVisible({ timeout: 5000 });
}
test.describe('Agentic Correction Workflow', () => {
test.beforeEach(async ({ page }) => {
// Navigate to the app
await page.goto('/');
// Wait for the initial load
await expect(page.getByText('Lyrics Correction Review')).toBeVisible();
});
test('should load the app in read-only mode', async ({ page }) => {
// Verify read-only mode alert is shown
await expect(page.getByText('Running in read-only mode')).toBeVisible();
// Verify Load File button is present
await expect(page.getByRole('button', { name: /load file/i })).toBeVisible();
});
test('should load correction data from JSON file', async ({ page }) => {
await loadFixtureData(page);
// Verify we're no longer in loading state
await expect(page.getByText('Loading Lyrics Correction Review...')).not.toBeVisible();
// Verify expected content from fixture is visible
await expect(page.getByText('Hello,')).toBeVisible();
});
test('should render transcription view after loading data', async ({ page }) => {
await loadFixtureData(page);
// Wait for transcription content to render
await expect(page.getByText('Hello,')).toBeVisible();
// Verify the Corrected Transcription header is visible
await expect(page.getByText('Corrected Transcription')).toBeVisible();
});
});
test.describe('UI Components', () => {
test('should show Load File button on initial load', async ({ page }) => {
await page.goto('/');
// The Load File button should be visible
const loadButton = page.getByRole('button', { name: /load file/i });
await expect(loadButton).toBeVisible();
// Should have upload icon
const uploadIcon = page.locator('svg[data-testid="UploadFileIcon"]');
await expect(uploadIcon).toBeVisible();
});
test('should show read-only mode banner', async ({ page }) => {
await page.goto('/');
// The read-only alert should be visible
await expect(page.getByRole('alert')).toBeVisible();
await expect(page.getByText(/read-only mode/i)).toBeVisible();
});
test('should have correction metrics component', async ({ page }) => {
await page.goto('/');
// The page structure should be there with Paper components
const metricsSection = page.locator('.MuiPaper-root');
await expect(metricsSection.first()).toBeVisible();
});
});
test.describe('File Upload Flow', () => {
test('should open file dialog when clicking Load File', async ({ page }) => {
await page.goto('/');
// Set up listener for file chooser
let fileChooserOpened = false;
page.on('filechooser', () => {
fileChooserOpened = true;
});
// Click the button
const loadButton = page.getByRole('button', { name: /load file/i });
await loadButton.click();
// Wait for the file chooser event to be processed
await page.waitForEvent('filechooser', { timeout: 5000 }).catch(() => {
// Event already fired
});
// Verify file chooser was triggered
expect(fileChooserOpened).toBe(true);
});
});
test.describe('Review Mode', () => {
test.beforeEach(async ({ page }) => {
await page.goto('/');
await expect(page.getByText('Lyrics Correction Review')).toBeVisible();
});
test('should show Review Mode toggle when agentic data is loaded', async ({ page }) => {
await loadFixtureData(page);
// Wait for content to load
await expect(page.getByText('Hello,')).toBeVisible();
// The Review Mode toggle should be visible when agentic corrections are present
// It will appear as "Review Off" chip initially (only in non-read-only mode with agentic data)
// Note: In read-only mode, the toggle won't appear
const reviewChip = page.getByText(/Review Off|Review Mode/i);
const chipCount = await reviewChip.count();
// Log for debugging purposes (will show in test output)
if (chipCount === 0) {
// Review toggle only shows in edit mode, not read-only mode
// This is expected behavior when loading files in read-only mode
}
});
test('should show batch actions panel when Review Mode is enabled', async ({ page }) => {
await loadFixtureData(page);
// Wait for content to load
await expect(page.getByText('Hello,')).toBeVisible();
// Find the Review Mode toggle (only visible in non-read-only mode)
const reviewToggle = page.getByText(/Review Off/i);
if (await reviewToggle.isVisible({ timeout: 2000 }).catch(() => false)) {
await reviewToggle.click();
// Wait for the batch actions panel to appear
await expect(page.getByRole('button', { name: /Accept High Confidence/i })).toBeVisible({ timeout: 5000 });
await expect(page.getByRole('button', { name: /Accept All/i })).toBeVisible();
await expect(page.getByRole('button', { name: /Revert All/i })).toBeVisible();
}
});
test('should render corrected words with original text preview', async ({ page }) => {
await loadFixtureData(page);
// Wait for transcription content to load
await expect(page.getByText('Hello,')).toBeVisible();
// Verify correction-related content is rendered
// The corrected word "now" should be visible (from fixture: "you're" -> "now")
await expect(page.getByText('now')).toBeVisible();
});
test('should toggle Review Mode on and off', async ({ page }) => {
await loadFixtureData(page);
// Wait for content to load
await expect(page.getByText('Hello,')).toBeVisible();
// Find the Review toggle (only visible in non-read-only mode)
const reviewOff = page.getByText(/Review Off/i);
if (await reviewOff.isVisible({ timeout: 2000 }).catch(() => false)) {
// Click to enable Review Mode
await reviewOff.click();
// Should now show "Review Mode" label (in filled state)
await expect(page.getByText(/Review Mode/i).first()).toBeVisible();
// Click to disable Review Mode
await page.getByText(/Review Mode/i).first().click();
// Should show "Review Off" again
await expect(page.getByText(/Review Off/i)).toBeVisible();
}
});
});
@@ -0,0 +1,226 @@
{
"original_segments": [
{
"id": "seg-1",
"text": "Hello, is it me you're looking for?",
"words": [
{"id": "w1", "text": "Hello,", "start_time": 0.0, "end_time": 0.5},
{"id": "w2", "text": "is", "start_time": 0.5, "end_time": 0.7},
{"id": "w3", "text": "it", "start_time": 0.7, "end_time": 0.9},
{"id": "w4", "text": "me", "start_time": 0.9, "end_time": 1.1},
{"id": "w5", "text": "you're", "start_time": 1.1, "end_time": 1.3},
{"id": "w6", "text": "looking", "start_time": 1.3, "end_time": 1.6},
{"id": "w7", "text": "for?", "start_time": 1.6, "end_time": 1.9}
],
"start_time": 0.0,
"end_time": 1.9
},
{
"id": "seg-2",
"text": "I can see it in your eyes",
"words": [
{"id": "w8", "text": "I", "start_time": 2.0, "end_time": 2.2},
{"id": "w9", "text": "can", "start_time": 2.2, "end_time": 2.4},
{"id": "w10", "text": "see", "start_time": 2.4, "end_time": 2.6},
{"id": "w11", "text": "it", "start_time": 2.6, "end_time": 2.8},
{"id": "w12", "text": "in", "start_time": 2.8, "end_time": 3.0},
{"id": "w13", "text": "your", "start_time": 3.0, "end_time": 3.2},
{"id": "w14", "text": "eyes", "start_time": 3.2, "end_time": 3.5}
],
"start_time": 2.0,
"end_time": 3.5
},
{
"id": "seg-3",
"text": "I can see it in your smile",
"words": [
{"id": "w15", "text": "I", "start_time": 4.0, "end_time": 4.2},
{"id": "w16", "text": "can", "start_time": 4.2, "end_time": 4.4},
{"id": "w17", "text": "see", "start_time": 4.4, "end_time": 4.6},
{"id": "w18", "text": "it", "start_time": 4.6, "end_time": 4.8},
{"id": "w19", "text": "in", "start_time": 4.8, "end_time": 5.0},
{"id": "w20", "text": "your", "start_time": 5.0, "end_time": 5.2},
{"id": "w21", "text": "smile", "start_time": 5.2, "end_time": 5.5}
],
"start_time": 4.0,
"end_time": 5.5
}
],
"reference_lyrics": {
"genius": {
"segments": [
{
"id": "ref-seg-1",
"text": "Hello, is it me you're looking for?",
"words": [
{"id": "rw1", "text": "Hello,", "start_time": null, "end_time": null},
{"id": "rw2", "text": "is", "start_time": null, "end_time": null},
{"id": "rw3", "text": "it", "start_time": null, "end_time": null},
{"id": "rw4", "text": "me", "start_time": null, "end_time": null},
{"id": "rw5", "text": "you're", "start_time": null, "end_time": null},
{"id": "rw6", "text": "looking", "start_time": null, "end_time": null},
{"id": "rw7", "text": "for?", "start_time": null, "end_time": null}
],
"start_time": null,
"end_time": null
}
],
"metadata": {
"source": "genius",
"track_name": "Hello",
"artist_names": "Lionel Richie",
"album_name": "Can't Slow Down",
"duration_ms": 280000,
"explicit": false,
"language": "en",
"is_synced": false,
"lyrics_provider": "Genius",
"lyrics_provider_id": "12345",
"provider_metadata": {}
},
"source": "genius"
}
},
"anchor_sequences": [
{
"id": "anchor-1",
"transcribed_word_ids": ["w1", "w2", "w3", "w4"],
"transcription_position": 0,
"reference_positions": {"genius": 0},
"reference_word_ids": {"genius": ["rw1", "rw2", "rw3", "rw4"]},
"confidence": 0.95
}
],
"gap_sequences": [
{
"id": "gap-1",
"transcribed_word_ids": ["w5", "w6", "w7"],
"transcription_position": 4,
"preceding_anchor_id": "anchor-1",
"following_anchor_id": null,
"reference_word_ids": {"genius": ["rw5", "rw6", "rw7"]}
}
],
"resized_segments": [],
"corrections_made": 3,
"confidence": 0.85,
"corrections": [
{
"id": "corr-1",
"handler": "AgenticCorrector",
"original_word": "you're",
"corrected_word": "now",
"segment_id": "seg-1",
"word_id": "w5",
"corrected_word_id": "cw5",
"source": "genius",
"confidence": 0.92,
"reason": "Transcription error - misheard word, reference lyrics confirm it should be 'now' [SOUND_ALIKE] (confidence: 92%)",
"alternatives": {"your": 0.65},
"is_deletion": false,
"split_index": null,
"split_total": null,
"reference_positions": {"genius": 4},
"length": 1
},
{
"id": "corr-2",
"handler": "AgenticCorrector",
"original_word": "it",
"corrected_word": "",
"segment_id": "seg-2",
"word_id": "w11",
"corrected_word_id": null,
"source": "genius",
"confidence": 0.88,
"reason": "Extra filler word detected, not in reference lyrics [EXTRA_WORDS] (confidence: 88%)",
"alternatives": {},
"is_deletion": true,
"split_index": null,
"split_total": null,
"reference_positions": {},
"length": 1
},
{
"id": "corr-3",
"handler": "AgenticCorrector",
"original_word": "I",
"corrected_word": "",
"segment_id": "seg-3",
"word_id": "w15",
"corrected_word_id": null,
"source": "genius",
"confidence": 0.75,
"reason": "Extra word at start of line, not in reference [EXTRA_WORDS] (confidence: 75%)",
"alternatives": {},
"is_deletion": true,
"split_index": null,
"split_total": null,
"reference_positions": {},
"length": 1
}
],
"corrected_segments": [
{
"id": "seg-1",
"text": "Hello, is it me you're looking for?",
"words": [
{"id": "w1", "text": "Hello,", "start_time": 0.0, "end_time": 0.5},
{"id": "w2", "text": "is", "start_time": 0.5, "end_time": 0.7},
{"id": "w3", "text": "it", "start_time": 0.7, "end_time": 0.9},
{"id": "w4", "text": "me", "start_time": 0.9, "end_time": 1.1},
{"id": "cw5", "text": "now", "start_time": 1.1, "end_time": 1.3, "created_during_correction": true},
{"id": "w6", "text": "looking", "start_time": 1.3, "end_time": 1.6},
{"id": "w7", "text": "for?", "start_time": 1.6, "end_time": 1.9}
],
"start_time": 0.0,
"end_time": 1.9
},
{
"id": "seg-2",
"text": "I can see in your eyes",
"words": [
{"id": "w8", "text": "I", "start_time": 2.0, "end_time": 2.2},
{"id": "w9", "text": "can", "start_time": 2.2, "end_time": 2.4},
{"id": "w10", "text": "see", "start_time": 2.4, "end_time": 2.6},
{"id": "w12", "text": "in", "start_time": 2.8, "end_time": 3.0},
{"id": "w13", "text": "your", "start_time": 3.0, "end_time": 3.2},
{"id": "w14", "text": "eyes", "start_time": 3.2, "end_time": 3.5}
],
"start_time": 2.0,
"end_time": 3.5
},
{
"id": "seg-3",
"text": "can see it in your smile",
"words": [
{"id": "w16", "text": "can", "start_time": 4.2, "end_time": 4.4},
{"id": "w17", "text": "see", "start_time": 4.4, "end_time": 4.6},
{"id": "w18", "text": "it", "start_time": 4.6, "end_time": 4.8},
{"id": "w19", "text": "in", "start_time": 4.8, "end_time": 5.0},
{"id": "w20", "text": "your", "start_time": 5.0, "end_time": 5.2},
{"id": "w21", "text": "smile", "start_time": 5.2, "end_time": 5.5}
],
"start_time": 4.0,
"end_time": 5.5
}
],
"metadata": {
"anchor_sequences_count": 1,
"gap_sequences_count": 1,
"total_words": 21,
"correction_ratio": 0.143,
"audio_filepath": "/path/to/test-audio.mp3",
"audio_hash": "test-audio-hash-123",
"available_handlers": [
{"id": "agentic", "name": "AgenticCorrector", "description": "AI-powered agentic correction", "enabled": true},
{"id": "sound_alike", "name": "SoundAlikeHandler", "description": "Fixes sound-alike errors", "enabled": true}
],
"enabled_handlers": ["AgenticCorrector", "SoundAlikeHandler"]
},
"correction_steps": [],
"word_id_map": {
"w5": "cw5"
},
"segment_id_map": {}
}
@@ -11,7 +11,10 @@
"lint": "eslint .",
"preview": "vite preview",
"predeploy": "npm run build-prod",
"deploy": "gh-pages -d dist"
"deploy": "gh-pages -d dist",
"test": "playwright test",
"test:ui": "playwright test --ui",
"test:headed": "playwright test --headed"
},
"dependencies": {
"@emotion/react": "^11.14.0",
@@ -61,7 +61,7 @@ export default defineConfig({
// Run local dev server before starting tests
webServer: {
command: 'yarn dev',
command: 'npm run dev',
url: 'http://localhost:5173',
reuseExistingServer: !process.env.CI,
timeout: 120000,
@@ -23,6 +23,7 @@ interface CorrectedWordWithActionsProps {
onClick?: () => void
backgroundColor?: string
shouldFlash?: boolean
showActions?: boolean // Controls whether inline action buttons are visible
}
const WordContainer = styled(Box, {
@@ -98,7 +99,8 @@ export default function CorrectedWordWithActions({
onAccept,
onClick,
backgroundColor,
shouldFlash
shouldFlash,
showActions = true
}: CorrectedWordWithActionsProps) {
const theme = useTheme()
const isMobile = useMediaQuery(theme.breakpoints.down('sm'))
@@ -115,7 +117,7 @@ export default function CorrectedWordWithActions({
onClick={onClick}
>
<OriginalWordLabel>{originalWord}</OriginalWordLabel>
<Box
component="span"
sx={{
@@ -127,40 +129,42 @@ export default function CorrectedWordWithActions({
{word}
</Box>
<ActionsContainer>
<Tooltip title="Revert to original" placement="top" arrow>
<ActionButton
size="small"
onClick={(e) => handleAction(e, onRevert)}
aria-label="revert correction"
>
<UndoIcon />
</ActionButton>
</Tooltip>
<Tooltip title="Edit correction" placement="top" arrow>
<ActionButton
size="small"
onClick={(e) => handleAction(e, onEdit)}
aria-label="edit correction"
>
<EditIcon />
</ActionButton>
</Tooltip>
{!isMobile && (
<Tooltip title="Accept correction" placement="top" arrow>
{showActions && (
<ActionsContainer>
<Tooltip title="Revert to original" placement="top" arrow>
<ActionButton
size="small"
onClick={(e) => handleAction(e, onAccept)}
aria-label="accept correction"
sx={{ color: 'success.main' }}
onClick={(e) => handleAction(e, onRevert)}
aria-label="revert correction"
>
<CheckCircleOutlineIcon />
<UndoIcon />
</ActionButton>
</Tooltip>
)}
</ActionsContainer>
<Tooltip title="Edit correction" placement="top" arrow>
<ActionButton
size="small"
onClick={(e) => handleAction(e, onEdit)}
aria-label="edit correction"
>
<EditIcon />
</ActionButton>
</Tooltip>
{!isMobile && (
<Tooltip title="Accept correction" placement="top" arrow>
<ActionButton
size="small"
onClick={(e) => handleAction(e, onAccept)}
aria-label="accept correction"
sx={{ color: 'success.main' }}
>
<CheckCircleOutlineIcon />
</ActionButton>
</Tooltip>
)}
</ActionsContainer>
)}
</WordContainer>
)
}
@@ -1,4 +1,4 @@
import { Box, Button, Typography, useMediaQuery, useTheme, Switch, FormControlLabel, Tooltip, Paper, IconButton } from '@mui/material'
import { Box, Button, Typography, useMediaQuery, useTheme, Switch, FormControlLabel, Tooltip, Paper, IconButton, Chip } from '@mui/material'
import LockIcon from '@mui/icons-material/Lock'
import UploadFileIcon from '@mui/icons-material/UploadFile'
import FindReplaceIcon from '@mui/icons-material/FindReplace'
@@ -8,6 +8,9 @@ import RedoIcon from '@mui/icons-material/Redo'
import TimerIcon from '@mui/icons-material/Timer'
import RestoreIcon from '@mui/icons-material/Restore'
import RateReviewIcon from '@mui/icons-material/RateReview'
import VisibilityIcon from '@mui/icons-material/Visibility'
import CheckCircleIcon from '@mui/icons-material/CheckCircle'
import HighlightOffIcon from '@mui/icons-material/HighlightOff'
import { CorrectionData, InteractionMode } from '../types'
import CorrectionMetrics from './CorrectionMetrics'
import AgenticCorrectionMetrics from './AgenticCorrectionMetrics'
@@ -44,6 +47,13 @@ interface HeaderProps {
canRedo: boolean
annotationsEnabled?: boolean
onAnnotationsToggle?: (enabled: boolean) => void
// Review mode props
reviewMode?: boolean
onReviewModeToggle?: (enabled: boolean) => void
// Batch action props
onAcceptAllCorrections?: () => void
onAcceptHighConfidenceCorrections?: () => void
onRevertAllCorrections?: () => void
}
export default function Header({
@@ -70,6 +80,11 @@ export default function Header({
canRedo,
annotationsEnabled = true,
onAnnotationsToggle,
reviewMode = false,
onReviewModeToggle,
onAcceptAllCorrections,
onAcceptHighConfidenceCorrections,
onRevertAllCorrections,
}: HeaderProps) {
const theme = useTheme()
const isMobile = useMediaQuery(theme.breakpoints.down('md'))
@@ -129,19 +144,69 @@ export default function Header({
</Box>
)}
{isReadOnly && (
<Box sx={{ display: 'flex', justifyContent: 'flex-end', mb: 1 }}>
<Button
variant="outlined"
size="small"
startIcon={<UploadFileIcon />}
onClick={onFileLoad}
fullWidth={isMobile}
>
Load File
</Button>
<Box sx={{
display: 'flex',
flexDirection: isMobile ? 'column' : 'row',
gap: 1,
justifyContent: 'space-between',
alignItems: isMobile ? 'stretch' : 'center',
mb: 1
}}>
<Typography variant="h4" sx={{ fontSize: isMobile ? '1.3rem' : '1.5rem' }}>
Nomad Karaoke: Lyrics Transcription Review
</Typography>
<Box sx={{ display: 'flex', alignItems: 'center', gap: 1 }}>
{!isReadOnly && isAgenticMode && onReviewModeToggle && (
<Tooltip title={reviewMode
? "Hide inline correction actions"
: "Show inline actions on all corrections for quick review"
}>
<Chip
icon={<VisibilityIcon />}
label={reviewMode ? "Review Mode" : "Review Off"}
onClick={() => onReviewModeToggle(!reviewMode)}
color={reviewMode ? "secondary" : "default"}
variant={reviewMode ? "filled" : "outlined"}
size="small"
sx={{
cursor: 'pointer',
'& .MuiChip-icon': { fontSize: '1rem' }
}}
/>
</Tooltip>
)}
{!isReadOnly && onAnnotationsToggle && (
<Tooltip title={annotationsEnabled
? "Click to disable annotation prompts when editing"
: "Click to enable annotation prompts when editing"
}>
<Chip
icon={<RateReviewIcon />}
label={annotationsEnabled ? "Feedback On" : "Feedback Off"}
onClick={() => onAnnotationsToggle(!annotationsEnabled)}
color={annotationsEnabled ? "primary" : "default"}
variant={annotationsEnabled ? "filled" : "outlined"}
size="small"
sx={{
cursor: 'pointer',
'& .MuiChip-icon': { fontSize: '1rem' }
}}
/>
</Tooltip>
)}
{isReadOnly && (
<Button
variant="outlined"
size="small"
startIcon={<UploadFileIcon />}
onClick={onFileLoad}
fullWidth={isMobile}
>
Load File
</Button>
)}
</Box>
)}
</Box>
<Box sx={{
display: 'flex',
@@ -250,6 +315,65 @@ export default function Header({
</Box>
</Box>
{/* Batch Actions Panel - shown when review mode is enabled */}
{!isReadOnly && reviewMode && isAgenticMode && data.corrections?.length > 0 && (
<Paper sx={{ p: 0.8, mb: 1, backgroundColor: 'action.hover' }}>
<Box sx={{
display: 'flex',
flexDirection: isMobile ? 'column' : 'row',
gap: 1,
alignItems: isMobile ? 'stretch' : 'center',
justifyContent: 'space-between'
}}>
<Typography variant="subtitle2" sx={{ fontSize: '0.75rem', color: 'text.secondary' }}>
Batch Actions ({data.corrections.length} corrections)
</Typography>
<Box sx={{
display: 'flex',
gap: 1,
flexWrap: 'wrap'
}}>
{onAcceptHighConfidenceCorrections && (
<Button
variant="contained"
size="small"
color="success"
startIcon={<CheckCircleIcon />}
onClick={onAcceptHighConfidenceCorrections}
sx={{ fontSize: '0.75rem', py: 0.5 }}
>
Accept High Confidence ({data.corrections.filter(c => c.confidence >= 0.8).length})
</Button>
)}
{onAcceptAllCorrections && (
<Button
variant="outlined"
size="small"
color="success"
startIcon={<CheckCircleIcon />}
onClick={onAcceptAllCorrections}
sx={{ fontSize: '0.75rem', py: 0.5 }}
>
Accept All
</Button>
)}
{onRevertAllCorrections && (
<Button
variant="outlined"
size="small"
color="error"
startIcon={<HighlightOffIcon />}
onClick={onRevertAllCorrections}
sx={{ fontSize: '0.75rem', py: 0.5 }}
>
Revert All
</Button>
)}
</Box>
</Box>
</Paper>
)}
<Paper sx={{ p: 0.8, mb: 1 }}>
<Box sx={{
display: 'flex',
@@ -356,10 +480,10 @@ export default function Header({
Timing Offset
</Button>
{timingOffsetMs !== 0 && (
<Typography
variant="body2"
sx={{
ml: 1,
<Typography
variant="body2"
sx={{
ml: 1,
fontWeight: 'bold',
color: theme.palette.secondary.main
}}
@@ -369,23 +493,6 @@ export default function Header({
)}
</Box>
)}
{!isReadOnly && onAnnotationsToggle && (
<Tooltip title={annotationsEnabled
? "Click to disable annotation prompts when editing"
: "Click to enable annotation prompts when editing"
}>
<Button
variant="outlined"
size="small"
onClick={() => onAnnotationsToggle(!annotationsEnabled)}
startIcon={<RateReviewIcon />}
color={annotationsEnabled ? "primary" : "inherit"}
sx={{ minWidth: 'fit-content', height: '32px' }}
>
{annotationsEnabled ? "Feedback On" : "Feedback Off"}
</Button>
</Tooltip>
)}
<AudioPlayer
apiClient={apiClient}
onTimeUpdate={onTimeUpdate}
@@ -88,6 +88,12 @@ interface MemoizedTranscriptionViewProps {
anchors: AnchorSequence[]
disableHighlighting: boolean
onDataChange?: (updatedData: CorrectionData) => void
// Review mode props
reviewMode: boolean
onRevertCorrection: (wordId: string) => void
onEditCorrection: (wordId: string) => void
onAcceptCorrection: (wordId: string) => void
onShowCorrectionDetail: (wordId: string) => void
}
// Create a memoized TranscriptionView component
@@ -103,7 +109,12 @@ const MemoizedTranscriptionView = memo(function MemoizedTranscriptionView({
currentTime,
anchors,
disableHighlighting,
onDataChange
onDataChange,
reviewMode,
onRevertCorrection,
onEditCorrection,
onAcceptCorrection,
onShowCorrectionDetail
}: MemoizedTranscriptionViewProps) {
return (
<TranscriptionView
@@ -118,6 +129,11 @@ const MemoizedTranscriptionView = memo(function MemoizedTranscriptionView({
currentTime={disableHighlighting ? undefined : currentTime}
anchors={anchors}
onDataChange={onDataChange}
reviewMode={reviewMode}
onRevertCorrection={onRevertCorrection}
onEditCorrection={onEditCorrection}
onAcceptCorrection={onAcceptCorrection}
onShowCorrectionDetail={onShowCorrectionDetail}
/>
);
});
@@ -202,6 +218,13 @@ interface MemoizedHeaderProps {
onUnCorrectAll: () => void
annotationsEnabled: boolean
onAnnotationsToggle: (enabled: boolean) => void
// Review mode props
reviewMode: boolean
onReviewModeToggle: (enabled: boolean) => void
// Batch action props
onAcceptAllCorrections: () => void
onAcceptHighConfidenceCorrections: () => void
onRevertAllCorrections: () => void
}
// Create a memoized Header component
@@ -228,7 +251,12 @@ const MemoizedHeader = memo(function MemoizedHeader({
canRedo,
onUnCorrectAll,
annotationsEnabled,
onAnnotationsToggle
onAnnotationsToggle,
reviewMode,
onReviewModeToggle,
onAcceptAllCorrections,
onAcceptHighConfidenceCorrections,
onRevertAllCorrections
}: MemoizedHeaderProps) {
return (
<Header
@@ -255,6 +283,11 @@ const MemoizedHeader = memo(function MemoizedHeader({
onUnCorrectAll={onUnCorrectAll}
annotationsEnabled={annotationsEnabled}
onAnnotationsToggle={onAnnotationsToggle}
reviewMode={reviewMode}
onReviewModeToggle={onReviewModeToggle}
onAcceptAllCorrections={onAcceptAllCorrections}
onAcceptHighConfidenceCorrections={onAcceptHighConfidenceCorrections}
onRevertAllCorrections={onRevertAllCorrections}
/>
);
});
@@ -291,6 +324,9 @@ export default function LyricsAnalyzer({ data: initialData, onFileLoad, apiClien
const [isFindReplaceModalOpen, setIsFindReplaceModalOpen] = useState(false)
const [isTimingOffsetModalOpen, setIsTimingOffsetModalOpen] = useState(false)
const [timingOffsetMs, setTimingOffsetMs] = useState(0)
// Review mode state for agentic corrections
const [reviewMode, setReviewMode] = useState(false)
// Annotation collection state
const [annotations, setAnnotations] = useState<Omit<CorrectionAnnotation, 'annotation_id' | 'timestamp'>[]>([])
@@ -793,11 +829,82 @@ export default function LyricsAnalyzer({ data: initialData, onFileLoad, apiClien
// For now, just log acceptance
// In the future, this could be tracked in the annotation system
console.log('Accepted correction for word:', wordId)
// TODO: Track acceptance in annotation system
// This could be used to build confidence in the AI's corrections over time
}, [])
// Batch action handlers for review mode
const handleAcceptAllCorrections = useCallback(() => {
// Accept all corrections - for now just log, could track in annotation system
data.corrections?.forEach(c => {
console.log('Batch accepted correction:', c.corrected_word_id || c.word_id)
})
console.log(`Accepted all ${data.corrections?.length || 0} corrections`)
}, [data.corrections])
const handleAcceptHighConfidenceCorrections = useCallback(() => {
// Accept corrections with confidence >= 80%
const highConfidence = data.corrections?.filter(c => c.confidence >= 0.8) || []
highConfidence.forEach(c => {
console.log('Batch accepted high-confidence correction:', c.corrected_word_id || c.word_id)
})
console.log(`Accepted ${highConfidence.length} high-confidence corrections`)
}, [data.corrections])
const handleRevertAllCorrections = useCallback(() => {
if (!window.confirm(`Are you sure you want to revert all ${data.corrections?.length || 0} corrections? This cannot be undone.`)) {
return
}
// Revert all corrections by reverting each one
// Process in reverse order to avoid ID conflicts
const corrections = [...(data.corrections || [])].reverse()
let newData = data
for (const correction of corrections) {
const wordId = correction.corrected_word_id || correction.word_id
// Find the segment containing the corrected word
const segmentIndex = newData.corrected_segments.findIndex(segment =>
segment.words.some(w => w.id === wordId)
)
if (segmentIndex === -1) continue
const segment = newData.corrected_segments[segmentIndex]
// Replace the corrected word with the original
const newWords = segment.words.map(word => {
if (word.id === wordId) {
return {
...word,
text: correction.original_word,
id: correction.word_id
}
}
return word
})
const newText = newWords.map(w => w.text).join(' ')
const newSegment = { ...segment, words: newWords, text: newText }
const newSegments = newData.corrected_segments.map((seg, idx) =>
idx === segmentIndex ? newSegment : seg
)
newData = {
...newData,
corrected_segments: newSegments,
corrections: newData.corrections?.filter(c =>
c.corrected_word_id !== wordId && c.word_id !== wordId
) || []
}
}
updateDataWithHistory(newData, 'revert all corrections')
console.log(`Reverted all ${corrections.length} corrections`)
}, [data, updateDataWithHistory])
const handleShowCorrectionDetail = useCallback((wordId: string) => {
// Find the correction for this word
const correction = data.corrections?.find(c =>
@@ -1177,6 +1284,11 @@ export default function LyricsAnalyzer({ data: initialData, onFileLoad, apiClien
onUnCorrectAll={handleUnCorrectAll}
annotationsEnabled={annotationsEnabled}
onAnnotationsToggle={handleAnnotationsToggle}
reviewMode={reviewMode}
onReviewModeToggle={setReviewMode}
onAcceptAllCorrections={handleAcceptAllCorrections}
onAcceptHighConfidenceCorrections={handleAcceptHighConfidenceCorrections}
onRevertAllCorrections={handleRevertAllCorrections}
/>
<Grid container direction={isMobile ? 'column' : 'row'}>
@@ -1198,6 +1310,11 @@ export default function LyricsAnalyzer({ data: initialData, onFileLoad, apiClien
// needs to update history
updateDataWithHistory(updatedData, 'direct data change');
}}
reviewMode={reviewMode}
onRevertCorrection={handleRevertCorrection}
onEditCorrection={handleEditCorrection}
onAcceptCorrection={handleAcceptCorrection}
onShowCorrectionDetail={handleShowCorrectionDetail}
/>
{!isReadOnly && apiClient && (
<Box sx={{
@@ -54,7 +54,12 @@ export default function TranscriptionView({
onPlaySegment,
currentTime = 0,
anchors = [],
onDataChange
onDataChange,
reviewMode = false,
onRevertCorrection,
onEditCorrection,
onAcceptCorrection,
onShowCorrectionDetail
}: TranscriptionViewProps) {
const [selectedSegmentIndex, setSelectedSegmentIndex] = useState<number | null>(null)
const [viewMode, setViewMode] = useState<'text' | 'duration'>('text')
@@ -237,6 +242,11 @@ export default function TranscriptionView({
currentTime={currentTime}
gaps={data.gap_sequences}
corrections={data.corrections}
reviewMode={reviewMode}
onRevertCorrection={onRevertCorrection}
onEditCorrection={onEditCorrection}
onAcceptCorrection={onAcceptCorrection}
onShowCorrectionDetail={onShowCorrectionDetail}
/>
</TextContainer>
</Box>
@@ -1,4 +1,4 @@
import { Typography, Box } from '@mui/material'
import { Typography, Box, useMediaQuery, useTheme } from '@mui/material'
import { WordComponent } from './Word'
import { useWordClick } from '../hooks/useWordClick'
import {
@@ -16,6 +16,7 @@ import React from 'react'
import ContentCopyIcon from '@mui/icons-material/ContentCopy'
import IconButton from '@mui/material/IconButton'
import { getWordsFromIds } from '../utils/wordUtils'
import CorrectedWordWithActions from '../../CorrectedWordWithActions'
export interface HighlightedTextProps {
text?: string
@@ -36,6 +37,12 @@ export interface HighlightedTextProps {
gaps?: GapSequence[]
flashingHandler?: string | null
corrections?: WordCorrection[]
// Review mode props for agentic corrections
reviewMode?: boolean
onRevertCorrection?: (wordId: string) => void
onEditCorrection?: (wordId: string) => void
onAcceptCorrection?: (wordId: string) => void
onShowCorrectionDetail?: (wordId: string) => void
}
export function HighlightedText({
@@ -57,7 +64,15 @@ export function HighlightedText({
gaps = [],
flashingHandler,
corrections = [],
reviewMode = false,
onRevertCorrection,
onEditCorrection,
onAcceptCorrection,
onShowCorrectionDetail,
}: HighlightedTextProps) {
const theme = useTheme()
const isMobile = useMediaQuery(theme.breakpoints.down('sm'))
const { handleWordClick } = useWordClick({
mode,
onElementClick,
@@ -157,43 +172,83 @@ export function HighlightedText({
const renderContent = () => {
if (wordPositions && !segments) {
return wordPositions.map((wordPos, index) => (
<React.Fragment key={wordPos.word.id}>
<WordComponent
key={`${wordPos.word.id}-${index}`}
word={wordPos.word.text}
shouldFlash={shouldWordFlash(wordPos)}
isAnchor={wordPos.type === 'anchor'}
isCorrectedGap={wordPos.isCorrected}
isUncorrectedGap={wordPos.type === 'gap' && !wordPos.isCorrected}
isCurrentlyPlaying={shouldHighlightWord(wordPos)}
onClick={() => handleWordClick(
wordPos.word.text,
wordPos.word.id,
wordPos.type === 'anchor' ? wordPos.sequence as AnchorSequence : undefined,
wordPos.type === 'gap' ? wordPos.sequence as GapSequence : undefined
)}
correction={(() => {
const correction = corrections?.find(c =>
c.corrected_word_id === wordPos.word.id ||
c.word_id === wordPos.word.id
);
return correction ? {
return wordPositions.map((wordPos, index) => {
// Find correction for this word
const correction = corrections?.find(c =>
c.corrected_word_id === wordPos.word.id ||
c.word_id === wordPos.word.id
);
// Use CorrectedWordWithActions for agentic corrections
if (correction && correction.handler === 'AgenticCorrector') {
return (
<React.Fragment key={wordPos.word.id}>
<CorrectedWordWithActions
word={wordPos.word.text}
originalWord={correction.original_word}
correction={{
originalWord: correction.original_word,
handler: correction.handler,
confidence: correction.confidence,
source: correction.source,
reason: correction.reason
}}
shouldFlash={shouldWordFlash(wordPos)}
showActions={reviewMode && !isMobile}
onRevert={() => onRevertCorrection?.(wordPos.word.id)}
onEdit={() => onEditCorrection?.(wordPos.word.id)}
onAccept={() => onAcceptCorrection?.(wordPos.word.id)}
onClick={() => {
if (isMobile) {
onShowCorrectionDetail?.(wordPos.word.id)
} else {
handleWordClick(
wordPos.word.text,
wordPos.word.id,
wordPos.type === 'anchor' ? wordPos.sequence as AnchorSequence : undefined,
wordPos.type === 'gap' ? wordPos.sequence as GapSequence : undefined
)
}
}}
/>
{index < wordPositions.length - 1 && ' '}
</React.Fragment>
);
}
// Default rendering with WordComponent
return (
<React.Fragment key={wordPos.word.id}>
<WordComponent
key={`${wordPos.word.id}-${index}`}
word={wordPos.word.text}
shouldFlash={shouldWordFlash(wordPos)}
isAnchor={wordPos.type === 'anchor'}
isCorrectedGap={wordPos.isCorrected}
isUncorrectedGap={wordPos.type === 'gap' && !wordPos.isCorrected}
isCurrentlyPlaying={shouldHighlightWord(wordPos)}
onClick={() => handleWordClick(
wordPos.word.text,
wordPos.word.id,
wordPos.type === 'anchor' ? wordPos.sequence as AnchorSequence : undefined,
wordPos.type === 'gap' ? wordPos.sequence as GapSequence : undefined
)}
correction={correction ? {
originalWord: correction.original_word,
handler: correction.handler,
confidence: correction.confidence,
source: correction.source,
reason: correction.reason
} : null;
})()}
/>
{index < wordPositions.length - 1 && ' '}
</React.Fragment>
))
} : null}
/>
{index < wordPositions.length - 1 && ' '}
</React.Fragment>
);
})
} else if (segments) {
return segments.map((segment) => (
<Box key={segment.id} sx={{
display: 'flex',
<Box key={segment.id} sx={{
display: 'flex',
alignItems: 'flex-start',
mb: 0
}}>
@@ -212,12 +267,44 @@ export function HighlightedText({
const sequence = wordPos?.type === 'gap' ? wordPos.sequence as GapSequence : undefined;
// Find correction information for the tooltip
const correction = corrections?.find(c =>
c.corrected_word_id === word.id ||
// Find correction information
const correction = corrections?.find(c =>
c.corrected_word_id === word.id ||
c.word_id === word.id
);
// Use CorrectedWordWithActions for agentic corrections
if (correction && correction.handler === 'AgenticCorrector') {
return (
<React.Fragment key={word.id}>
<CorrectedWordWithActions
word={word.text}
originalWord={correction.original_word}
correction={{
originalWord: correction.original_word,
handler: correction.handler,
confidence: correction.confidence,
source: correction.source,
reason: correction.reason
}}
shouldFlash={shouldWordFlash(wordPos || { word: word.text, id: word.id })}
showActions={reviewMode && !isMobile}
onRevert={() => onRevertCorrection?.(word.id)}
onEdit={() => onEditCorrection?.(word.id)}
onAccept={() => onAcceptCorrection?.(word.id)}
onClick={() => {
if (isMobile) {
onShowCorrectionDetail?.(word.id)
} else {
handleWordClick(word.text, word.id, anchor, sequence)
}
}}
/>
{wordIndex < segment.words.length - 1 && ' '}
</React.Fragment>
);
}
const correctionInfo = correction ? {
originalWord: correction.original_word,
handler: correction.handler,
@@ -85,6 +85,12 @@ export interface TranscriptionViewProps {
anchors?: AnchorSequence[]
flashingHandler?: string | null
onDataChange?: (updatedData: CorrectionData) => void
// Review mode props for agentic corrections
reviewMode?: boolean
onRevertCorrection?: (wordId: string) => void
onEditCorrection?: (wordId: string) => void
onAcceptCorrection?: (wordId: string) => void
onShowCorrectionDetail?: (wordId: string) => void
}
// Add LinePosition type here since it's used in multiple places
+1
View File
@@ -55,6 +55,7 @@ langchain-core = ">=0.3.0"
langchain-openai = ">=0.2.0"
langchain-anthropic = ">=0.2.0"
langchain-ollama = ">=0.2.0"
langchain-google-vertexai = ">=2.0.0"
langfuse = ">=3.0.0"
pydantic = ">=2.7.0"
jiwer = ">=3.0.0"
@@ -0,0 +1,81 @@
"""Tests for core configuration classes."""
import os
import pytest
from unittest.mock import patch
from lyrics_transcriber.core.config import TranscriberConfig
class TestTranscriberConfig:
"""Tests for TranscriberConfig dataclass."""
def test_default_values(self):
"""Test that default values are set correctly when no env vars are present."""
with patch.dict(os.environ, {}, clear=True):
# Remove any existing WHISPER_* env vars
for key in list(os.environ.keys()):
if key.startswith("WHISPER_"):
del os.environ[key]
config = TranscriberConfig()
assert config.enable_local_whisper is True
assert config.local_whisper_model_size == "medium"
assert config.local_whisper_device is None
assert config.local_whisper_cache_dir is None
assert config.local_whisper_language is None
def test_reads_whisper_model_size_from_env(self):
"""Test that WHISPER_MODEL_SIZE env var is respected."""
with patch.dict(os.environ, {"WHISPER_MODEL_SIZE": "large"}, clear=False):
config = TranscriberConfig()
assert config.local_whisper_model_size == "large"
def test_reads_whisper_device_from_env(self):
"""Test that WHISPER_DEVICE env var is respected."""
with patch.dict(os.environ, {"WHISPER_DEVICE": "mps"}, clear=False):
config = TranscriberConfig()
assert config.local_whisper_device == "mps"
def test_reads_whisper_cache_dir_from_env(self):
"""Test that WHISPER_CACHE_DIR env var is respected."""
with patch.dict(os.environ, {"WHISPER_CACHE_DIR": "/custom/cache"}, clear=False):
config = TranscriberConfig()
assert config.local_whisper_cache_dir == "/custom/cache"
def test_reads_whisper_language_from_env(self):
"""Test that WHISPER_LANGUAGE env var is respected."""
with patch.dict(os.environ, {"WHISPER_LANGUAGE": "en"}, clear=False):
config = TranscriberConfig()
assert config.local_whisper_language == "en"
def test_reads_all_whisper_env_vars(self):
"""Test that all WHISPER_* env vars are respected together."""
env_vars = {
"WHISPER_MODEL_SIZE": "large-v3",
"WHISPER_DEVICE": "cuda",
"WHISPER_CACHE_DIR": "/models/whisper",
"WHISPER_LANGUAGE": "es",
}
with patch.dict(os.environ, env_vars, clear=False):
config = TranscriberConfig()
assert config.local_whisper_model_size == "large-v3"
assert config.local_whisper_device == "cuda"
assert config.local_whisper_cache_dir == "/models/whisper"
assert config.local_whisper_language == "es"
def test_explicit_values_override_env_vars(self):
"""Test that explicitly passed values override env vars."""
with patch.dict(os.environ, {"WHISPER_MODEL_SIZE": "large"}, clear=False):
config = TranscriberConfig(local_whisper_model_size="small")
assert config.local_whisper_model_size == "small"
def test_cloud_provider_config(self):
"""Test that cloud provider config fields work correctly."""
config = TranscriberConfig(
audioshake_api_token="test_token",
runpod_api_key="test_key",
whisper_runpod_id="test_id",
)
assert config.audioshake_api_token == "test_token"
assert config.runpod_api_key == "test_key"
assert config.whisper_runpod_id == "test_id"
Generated
+109 -2
View File
@@ -1585,6 +1585,27 @@ files = [
{file = "distro-1.9.0.tar.gz", hash = "sha256:2fa77c6fd8940f116ee1d6b94a2f90b13b5ea8d019b98bc8bafdcabcdd9bdbed"},
]
[[package]]
name = "dnspython"
version = "2.8.0"
description = "DNS toolkit"
optional = false
python-versions = ">=3.10"
groups = ["main"]
files = [
{file = "dnspython-2.8.0-py3-none-any.whl", hash = "sha256:01d9bbc4a2d76bf0db7c1f729812ded6d912bd318d3b1cf81d30c0f845dbf3af"},
{file = "dnspython-2.8.0.tar.gz", hash = "sha256:181d3c6996452cb1189c4046c61599b84a5a86e099562ffde77d26984ff26d0f"},
]
[package.extras]
dev = ["black (>=25.1.0)", "coverage (>=7.0)", "flake8 (>=7)", "hypercorn (>=0.17.0)", "mypy (>=1.17)", "pylint (>=3)", "pytest (>=8.4)", "pytest-cov (>=6.2.0)", "quart-trio (>=0.12.0)", "sphinx (>=8.2.0)", "sphinx-rtd-theme (>=3.0.0)", "twine (>=6.1.0)", "wheel (>=0.45.0)"]
dnssec = ["cryptography (>=45)"]
doh = ["h2 (>=4.2.0)", "httpcore (>=1.0.0)", "httpx (>=0.28.0)"]
doq = ["aioquic (>=1.2.0)"]
idna = ["idna (>=3.10)"]
trio = ["trio (>=0.30)"]
wmi = ["wmi (>=1.5.1) ; platform_system == \"Windows\""]
[[package]]
name = "docstring-parser"
version = "0.17.0"
@@ -1770,6 +1791,22 @@ files = [
{file = "einops-0.8.1.tar.gz", hash = "sha256:de5d960a7a761225532e0f1959e5315ebeafc0cd43394732f103ca44b9837e84"},
]
[[package]]
name = "email-validator"
version = "2.3.0"
description = "A robust email address syntax and deliverability validation library."
optional = false
python-versions = ">=3.8"
groups = ["main"]
files = [
{file = "email_validator-2.3.0-py3-none-any.whl", hash = "sha256:80f13f623413e6b197ae73bb10bf4eb0908faf509ad8362c5edeb0be7fd450b4"},
{file = "email_validator-2.3.0.tar.gz", hash = "sha256:9fc05c37f2f6cf439ff414f8fc46d917929974a82244c20eb10231ba60c54426"},
]
[package.dependencies]
dnspython = ">=2.0.0"
idna = ">=2.0.0"
[[package]]
name = "exceptiongroup"
version = "1.3.1"
@@ -4219,7 +4256,7 @@ files = [
numpy = [
{version = ">=2.1.0", markers = "python_version >= \"3.13\""},
{version = ">=1.26.0", markers = "python_version >= \"3.12\""},
{version = ">=1.23.3", markers = "python_version == \"3.11\""},
{version = ">=1.23.3", markers = "python_version >= \"3.11\""},
{version = ">=1.21.2", markers = "python_version >= \"3.10\""},
]
@@ -6555,6 +6592,18 @@ files = [
[package.extras]
cli = ["click (>=5.0)"]
[[package]]
name = "python-http-client"
version = "3.3.7"
description = "HTTP REST client, simplified for Python"
optional = false
python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*"
groups = ["main"]
files = [
{file = "python_http_client-3.3.7-py3-none-any.whl", hash = "sha256:ad371d2bbedc6ea15c26179c6222a78bc9308d272435ddf1d5c84f068f249a36"},
{file = "python_http_client-3.3.7.tar.gz", hash = "sha256:bf841ee45262747e00dec7ee9971dfb8c7d83083f5713596488d67739170cea0"},
]
[[package]]
name = "python-levenshtein"
version = "0.27.3"
@@ -7448,6 +7497,27 @@ files = [
cryptography = ">=2.0"
jeepney = ">=0.6"
[[package]]
name = "sendgrid"
version = "6.12.5"
description = "Twilio SendGrid library for Python"
optional = false
python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,>=2.7"
groups = ["main"]
files = [
{file = "sendgrid-6.12.5-py3-none-any.whl", hash = "sha256:96f92cc91634bf552fdb766b904bbb53968018da7ae41fdac4d1090dc0311ca8"},
{file = "sendgrid-6.12.5.tar.gz", hash = "sha256:ea9aae30cd55c332e266bccd11185159482edfc07c149b6cd15cf08869fabdb7"},
]
[package.dependencies]
cryptography = ">=45.0.6"
python-http-client = ">=3.2.1"
werkzeug = [
{version = ">=2.3.5", markers = "python_version >= \"3.12\""},
{version = ">=2.2.0", markers = "python_version == \"3.11\""},
{version = ">=1.0.0", markers = "python_version >= \"3.9\""},
]
[[package]]
name = "setuptools"
version = "80.9.0"
@@ -7955,6 +8025,25 @@ files = [
ply = ">=3.4"
six = ">=1.12.0"
[[package]]
name = "stripe"
version = "14.1.0"
description = "Python bindings for the Stripe API"
optional = false
python-versions = ">=3.7"
groups = ["main"]
files = [
{file = "stripe-14.1.0-py3-none-any.whl", hash = "sha256:0e687a2eed4d9a66e7602093f7ad02e6c30a0d0c993101848a8c97d7f7607748"},
{file = "stripe-14.1.0.tar.gz", hash = "sha256:d002ecd2966a984a52a43e865bc9346c389f20e768e13fdbbe9cb9474f917c23"},
]
[package.dependencies]
requests = {version = ">=2.20", markers = "python_version >= \"3.0\""}
typing_extensions = {version = ">=4.5.0", markers = "python_version >= \"3.7\""}
[package.extras]
async = ["httpx"]
[[package]]
name = "striprtf"
version = "0.0.29"
@@ -9159,6 +9248,24 @@ files = [
{file = "websockets-15.0.1.tar.gz", hash = "sha256:82544de02076bafba038ce055ee6412d68da13ab47f0c60cab827346de828dee"},
]
[[package]]
name = "werkzeug"
version = "3.1.4"
description = "The comprehensive WSGI web application library."
optional = false
python-versions = ">=3.9"
groups = ["main"]
files = [
{file = "werkzeug-3.1.4-py3-none-any.whl", hash = "sha256:2ad50fb9ed09cc3af22c54698351027ace879a0b60a3b5edf5730b2f7d876905"},
{file = "werkzeug-3.1.4.tar.gz", hash = "sha256:cd3cd98b1b92dc3b7b3995038826c68097dcb16f9baa63abe35f20eafeb9fe5e"},
]
[package.dependencies]
markupsafe = ">=2.1.1"
[package.extras]
watchdog = ["watchdog (>=2.3)"]
[[package]]
name = "whisper-timestamped"
version = "1.15.9"
@@ -9688,4 +9795,4 @@ local-whisper = ["whisper-timestamped"]
[metadata]
lock-version = "2.1"
python-versions = ">=3.10,<3.14"
content-hash = "c14214372c6d52a86d32afc8638b2f1486aac7b4d06a444e8be7d14379bd4e25"
content-hash = "d4d1260ae1bf54e937add9ee24c696e85f6dab3692e78e5d270ef87bb3df6a76"
+5 -1
View File
@@ -1,6 +1,6 @@
[tool.poetry]
name = "karaoke-gen"
version = "0.76.24"
version = "0.76.29"
description = "Generate karaoke videos with synchronized lyrics. Handles the entire process from downloading audio and lyrics to creating the final video with title screens."
authors = ["Andrew Beveridge <andrew@beveridge.uk>"]
license = "MIT"
@@ -93,6 +93,10 @@ google-cloud-tasks = ">=2.16.0" # Cloud Tasks for worker coordination (Phase 1
google-cloud-run = ">=0.10.0" # Cloud Run Jobs for long-running video encoding (Phase 2 scalability)
python-dotenv = ">=1.0.0"
pydub = ">=0.25.1"
# Payment and email services
stripe = ">=7.0.0"
sendgrid = ">=6.10.0"
email-validator = ">=2.0.0" # For Pydantic EmailStr validation
# OpenTelemetry for distributed tracing
opentelemetry-api = ">=1.20.0"
opentelemetry-sdk = ">=1.20.0"
+1 -1
View File
@@ -203,7 +203,7 @@ class TestLyrics:
with patch('karaoke_gen.lyrics_processor.LyricsTranscriber', mock_transcriber), \
patch('os.path.exists', return_value=False), \
patch('shutil.copy2') as mock_copy2, \
patch('os.getenv', side_effect=lambda key: mock_env.get(key)), \
patch('os.getenv', side_effect=lambda key, default=None: mock_env.get(key, default)), \
patch('karaoke_gen.lyrics_processor.load_dotenv'):
# Call the method on the lyrics_processor