Compare commits

..
Author SHA1 Message Date
Andrew Beveridge 1245e20fe4 Continued refactor of finalise 2025-04-22 22:16:49 -04:00
843 changed files with 9654 additions and 361680 deletions

No files matched your search

-101
View File
@@ -1,101 +0,0 @@
---
description: Perform a non-destructive cross-artifact consistency and quality analysis across spec.md, plan.md, and tasks.md after task generation.
---
The user input to you can be provided directly by the agent or as a command argument - you **MUST** consider it before proceeding with the prompt (if not empty).
User input:
$ARGUMENTS
Goal: Identify inconsistencies, duplications, ambiguities, and underspecified items across the three core artifacts (`spec.md`, `plan.md`, `tasks.md`) before implementation. This command MUST run only after `/tasks` has successfully produced a complete `tasks.md`.
STRICTLY READ-ONLY: Do **not** modify any files. Output a structured analysis report. Offer an optional remediation plan (user must explicitly approve before any follow-up editing commands would be invoked manually).
Constitution Authority: The project constitution (`.specify/memory/constitution.md`) is **non-negotiable** within this analysis scope. Constitution conflicts are automatically CRITICAL and require adjustment of the spec, plan, or tasks—not dilution, reinterpretation, or silent ignoring of the principle. If a principle itself needs to change, that must occur in a separate, explicit constitution update outside `/analyze`.
Execution steps:
1. Run `.specify/scripts/bash/check-prerequisites.sh --json --require-tasks --include-tasks` once from repo root and parse JSON for FEATURE_DIR and AVAILABLE_DOCS. Derive absolute paths:
- SPEC = FEATURE_DIR/spec.md
- PLAN = FEATURE_DIR/plan.md
- TASKS = FEATURE_DIR/tasks.md
Abort with an error message if any required file is missing (instruct the user to run missing prerequisite command).
2. Load artifacts:
- Parse spec.md sections: Overview/Context, Functional Requirements, Non-Functional Requirements, User Stories, Edge Cases (if present).
- Parse plan.md: Architecture/stack choices, Data Model references, Phases, Technical constraints.
- Parse tasks.md: Task IDs, descriptions, phase grouping, parallel markers [P], referenced file paths.
- Load constitution `.specify/memory/constitution.md` for principle validation.
3. Build internal semantic models:
- Requirements inventory: Each functional + non-functional requirement with a stable key (derive slug based on imperative phrase; e.g., "User can upload file" -> `user-can-upload-file`).
- User story/action inventory.
- Task coverage mapping: Map each task to one or more requirements or stories (inference by keyword / explicit reference patterns like IDs or key phrases).
- Constitution rule set: Extract principle names and any MUST/SHOULD normative statements.
4. Detection passes:
A. Duplication detection:
- Identify near-duplicate requirements. Mark lower-quality phrasing for consolidation.
B. Ambiguity detection:
- Flag vague adjectives (fast, scalable, secure, intuitive, robust) lacking measurable criteria.
- Flag unresolved placeholders (TODO, TKTK, ???, <placeholder>, etc.).
C. Underspecification:
- Requirements with verbs but missing object or measurable outcome.
- User stories missing acceptance criteria alignment.
- Tasks referencing files or components not defined in spec/plan.
D. Constitution alignment:
- Any requirement or plan element conflicting with a MUST principle.
- Missing mandated sections or quality gates from constitution.
E. Coverage gaps:
- Requirements with zero associated tasks.
- Tasks with no mapped requirement/story.
- Non-functional requirements not reflected in tasks (e.g., performance, security).
F. Inconsistency:
- Terminology drift (same concept named differently across files).
- Data entities referenced in plan but absent in spec (or vice versa).
- Task ordering contradictions (e.g., integration tasks before foundational setup tasks without dependency note).
- Conflicting requirements (e.g., one requires to use Next.js while other says to use Vue as the framework).
5. Severity assignment heuristic:
- CRITICAL: Violates constitution MUST, missing core spec artifact, or requirement with zero coverage that blocks baseline functionality.
- HIGH: Duplicate or conflicting requirement, ambiguous security/performance attribute, untestable acceptance criterion.
- MEDIUM: Terminology drift, missing non-functional task coverage, underspecified edge case.
- LOW: Style/wording improvements, minor redundancy not affecting execution order.
6. Produce a Markdown report (no file writes) with sections:
### Specification Analysis Report
| ID | Category | Severity | Location(s) | Summary | Recommendation |
|----|----------|----------|-------------|---------|----------------|
| A1 | Duplication | HIGH | spec.md:L120-134 | Two similar requirements ... | Merge phrasing; keep clearer version |
(Add one row per finding; generate stable IDs prefixed by category initial.)
Additional subsections:
- Coverage Summary Table:
| Requirement Key | Has Task? | Task IDs | Notes |
- Constitution Alignment Issues (if any)
- Unmapped Tasks (if any)
- Metrics:
* Total Requirements
* Total Tasks
* Coverage % (requirements with >=1 task)
* Ambiguity Count
* Duplication Count
* Critical Issues Count
7. At end of report, output a concise Next Actions block:
- If CRITICAL issues exist: Recommend resolving before `/implement`.
- If only LOW/MEDIUM: User may proceed, but provide improvement suggestions.
- Provide explicit command suggestions: e.g., "Run /specify with refinement", "Run /plan to adjust architecture", "Manually edit tasks.md to add coverage for 'performance-metrics'".
8. Ask the user: "Would you like me to suggest concrete remediation edits for the top N issues?" (Do NOT apply them automatically.)
Behavior rules:
- NEVER modify files.
- NEVER hallucinate missing sections—if absent, report them.
- KEEP findings deterministic: if rerun without changes, produce consistent IDs and counts.
- LIMIT total findings in the main table to 50; aggregate remainder in a summarized overflow note.
- If zero issues found, emit a success report with coverage statistics and proceed recommendation.
Context: $ARGUMENTS
-158
View File
@@ -1,158 +0,0 @@
---
description: Identify underspecified areas in the current feature spec by asking up to 5 highly targeted clarification questions and encoding answers back into the spec.
---
The user input to you can be provided directly by the agent or as a command argument - you **MUST** consider it before proceeding with the prompt (if not empty).
User input:
$ARGUMENTS
Goal: Detect and reduce ambiguity or missing decision points in the active feature specification and record the clarifications directly in the spec file.
Note: This clarification workflow is expected to run (and be completed) BEFORE invoking `/plan`. If the user explicitly states they are skipping clarification (e.g., exploratory spike), you may proceed, but must warn that downstream rework risk increases.
Execution steps:
1. Run `.specify/scripts/bash/check-prerequisites.sh --json --paths-only` from repo root **once** (combined `--json --paths-only` mode / `-Json -PathsOnly`). Parse minimal JSON payload fields:
- `FEATURE_DIR`
- `FEATURE_SPEC`
- (Optionally capture `IMPL_PLAN`, `TASKS` for future chained flows.)
- If JSON parsing fails, abort and instruct user to re-run `/specify` or verify feature branch environment.
2. Load the current spec file. Perform a structured ambiguity & coverage scan using this taxonomy. For each category, mark status: Clear / Partial / Missing. Produce an internal coverage map used for prioritization (do not output raw map unless no questions will be asked).
Functional Scope & Behavior:
- Core user goals & success criteria
- Explicit out-of-scope declarations
- User roles / personas differentiation
Domain & Data Model:
- Entities, attributes, relationships
- Identity & uniqueness rules
- Lifecycle/state transitions
- Data volume / scale assumptions
Interaction & UX Flow:
- Critical user journeys / sequences
- Error/empty/loading states
- Accessibility or localization notes
Non-Functional Quality Attributes:
- Performance (latency, throughput targets)
- Scalability (horizontal/vertical, limits)
- Reliability & availability (uptime, recovery expectations)
- Observability (logging, metrics, tracing signals)
- Security & privacy (authN/Z, data protection, threat assumptions)
- Compliance / regulatory constraints (if any)
Integration & External Dependencies:
- External services/APIs and failure modes
- Data import/export formats
- Protocol/versioning assumptions
Edge Cases & Failure Handling:
- Negative scenarios
- Rate limiting / throttling
- Conflict resolution (e.g., concurrent edits)
Constraints & Tradeoffs:
- Technical constraints (language, storage, hosting)
- Explicit tradeoffs or rejected alternatives
Terminology & Consistency:
- Canonical glossary terms
- Avoided synonyms / deprecated terms
Completion Signals:
- Acceptance criteria testability
- Measurable Definition of Done style indicators
Misc / Placeholders:
- TODO markers / unresolved decisions
- Ambiguous adjectives ("robust", "intuitive") lacking quantification
For each category with Partial or Missing status, add a candidate question opportunity unless:
- Clarification would not materially change implementation or validation strategy
- Information is better deferred to planning phase (note internally)
3. Generate (internally) a prioritized queue of candidate clarification questions (maximum 5). Do NOT output them all at once. Apply these constraints:
- Maximum of 5 total questions across the whole session.
- Each question must be answerable with EITHER:
* A short multiple‑choice selection (2–5 distinct, mutually exclusive options), OR
* A one-word / short‑phrase answer (explicitly constrain: "Answer in <=5 words").
- Only include questions whose answers materially impact architecture, data modeling, task decomposition, test design, UX behavior, operational readiness, or compliance validation.
- Ensure category coverage balance: attempt to cover the highest impact unresolved categories first; avoid asking two low-impact questions when a single high-impact area (e.g., security posture) is unresolved.
- Exclude questions already answered, trivial stylistic preferences, or plan-level execution details (unless blocking correctness).
- Favor clarifications that reduce downstream rework risk or prevent misaligned acceptance tests.
- If more than 5 categories remain unresolved, select the top 5 by (Impact * Uncertainty) heuristic.
4. Sequential questioning loop (interactive):
- Present EXACTLY ONE question at a time.
- For multiple‑choice questions render options as a Markdown table:
| Option | Description |
|--------|-------------|
| A | <Option A description> |
| B | <Option B description> |
| C | <Option C description> | (add D/E as needed up to 5)
| Short | Provide a different short answer (<=5 words) | (Include only if free-form alternative is appropriate)
- For short‑answer style (no meaningful discrete options), output a single line after the question: `Format: Short answer (<=5 words)`.
- After the user answers:
* Validate the answer maps to one option or fits the <=5 word constraint.
* If ambiguous, ask for a quick disambiguation (count still belongs to same question; do not advance).
* Once satisfactory, record it in working memory (do not yet write to disk) and move to the next queued question.
- Stop asking further questions when:
* All critical ambiguities resolved early (remaining queued items become unnecessary), OR
* User signals completion ("done", "good", "no more"), OR
* You reach 5 asked questions.
- Never reveal future queued questions in advance.
- If no valid questions exist at start, immediately report no critical ambiguities.
5. Integration after EACH accepted answer (incremental update approach):
- Maintain in-memory representation of the spec (loaded once at start) plus the raw file contents.
- For the first integrated answer in this session:
* Ensure a `## Clarifications` section exists (create it just after the highest-level contextual/overview section per the spec template if missing).
* Under it, create (if not present) a `### Session YYYY-MM-DD` subheading for today.
- Append a bullet line immediately after acceptance: `- Q: <question> → A: <final answer>`.
- Then immediately apply the clarification to the most appropriate section(s):
* Functional ambiguity → Update or add a bullet in Functional Requirements.
* User interaction / actor distinction → Update User Stories or Actors subsection (if present) with clarified role, constraint, or scenario.
* Data shape / entities → Update Data Model (add fields, types, relationships) preserving ordering; note added constraints succinctly.
* Non-functional constraint → Add/modify measurable criteria in Non-Functional / Quality Attributes section (convert vague adjective to metric or explicit target).
* Edge case / negative flow → Add a new bullet under Edge Cases / Error Handling (or create such subsection if template provides placeholder for it).
* Terminology conflict → Normalize term across spec; retain original only if necessary by adding `(formerly referred to as "X")` once.
- If the clarification invalidates an earlier ambiguous statement, replace that statement instead of duplicating; leave no obsolete contradictory text.
- Save the spec file AFTER each integration to minimize risk of context loss (atomic overwrite).
- Preserve formatting: do not reorder unrelated sections; keep heading hierarchy intact.
- Keep each inserted clarification minimal and testable (avoid narrative drift).
6. Validation (performed after EACH write plus final pass):
- Clarifications session contains exactly one bullet per accepted answer (no duplicates).
- Total asked (accepted) questions ≤ 5.
- Updated sections contain no lingering vague placeholders the new answer was meant to resolve.
- No contradictory earlier statement remains (scan for now-invalid alternative choices removed).
- Markdown structure valid; only allowed new headings: `## Clarifications`, `### Session YYYY-MM-DD`.
- Terminology consistency: same canonical term used across all updated sections.
7. Write the updated spec back to `FEATURE_SPEC`.
8. Report completion (after questioning loop ends or early termination):
- Number of questions asked & answered.
- Path to updated spec.
- Sections touched (list names).
- Coverage summary table listing each taxonomy category with Status: Resolved (was Partial/Missing and addressed), Deferred (exceeds question quota or better suited for planning), Clear (already sufficient), Outstanding (still Partial/Missing but low impact).
- If any Outstanding or Deferred remain, recommend whether to proceed to `/plan` or run `/clarify` again later post-plan.
- Suggested next command.
Behavior rules:
- If no meaningful ambiguities found (or all potential questions would be low-impact), respond: "No critical ambiguities detected worth formal clarification." and suggest proceeding.
- If spec file missing, instruct user to run `/specify` first (do not create a new spec here).
- Never exceed 5 total asked questions (clarification retries for a single question do not count as new questions).
- Avoid speculative tech stack questions unless the absence blocks functional clarity.
- Respect user early termination signals ("stop", "done", "proceed").
- If no questions asked due to full coverage, output a compact coverage summary (all categories Clear) then suggest advancing.
- If quota reached with unresolved high-impact categories remaining, explicitly flag them under Deferred with rationale.
Context for prioritization: $ARGUMENTS
-73
View File
@@ -1,73 +0,0 @@
---
description: Create or update the project constitution from interactive or provided principle inputs, ensuring all dependent templates stay in sync.
---
The user input to you can be provided directly by the agent or as a command argument - you **MUST** consider it before proceeding with the prompt (if not empty).
User input:
$ARGUMENTS
You are updating the project constitution at `.specify/memory/constitution.md`. This file is a TEMPLATE containing placeholder tokens in square brackets (e.g. `[PROJECT_NAME]`, `[PRINCIPLE_1_NAME]`). Your job is to (a) collect/derive concrete values, (b) fill the template precisely, and (c) propagate any amendments across dependent artifacts.
Follow this execution flow:
1. Load the existing constitution template at `.specify/memory/constitution.md`.
- Identify every placeholder token of the form `[ALL_CAPS_IDENTIFIER]`.
**IMPORTANT**: The user might require less or more principles than the ones used in the template. If a number is specified, respect that - follow the general template. You will update the doc accordingly.
2. Collect/derive values for placeholders:
- If user input (conversation) supplies a value, use it.
- Otherwise infer from existing repo context (README, docs, prior constitution versions if embedded).
- For governance dates: `RATIFICATION_DATE` is the original adoption date (if unknown ask or mark TODO), `LAST_AMENDED_DATE` is today if changes are made, otherwise keep previous.
- `CONSTITUTION_VERSION` must increment according to semantic versioning rules:
* MAJOR: Backward incompatible governance/principle removals or redefinitions.
* MINOR: New principle/section added or materially expanded guidance.
* PATCH: Clarifications, wording, typo fixes, non-semantic refinements.
- If version bump type ambiguous, propose reasoning before finalizing.
3. Draft the updated constitution content:
- Replace every placeholder with concrete text (no bracketed tokens left except intentionally retained template slots that the project has chosen not to define yet—explicitly justify any left).
- Preserve heading hierarchy and comments can be removed once replaced unless they still add clarifying guidance.
- Ensure each Principle section: succinct name line, paragraph (or bullet list) capturing non‑negotiable rules, explicit rationale if not obvious.
- Ensure Governance section lists amendment procedure, versioning policy, and compliance review expectations.
4. Consistency propagation checklist (convert prior checklist into active validations):
- Read `.specify/templates/plan-template.md` and ensure any "Constitution Check" or rules align with updated principles.
- Read `.specify/templates/spec-template.md` for scope/requirements alignment—update if constitution adds/removes mandatory sections or constraints.
- Read `.specify/templates/tasks-template.md` and ensure task categorization reflects new or removed principle-driven task types (e.g., observability, versioning, testing discipline).
- Read each command file in `.specify/templates/commands/*.md` (including this one) to verify no outdated references (agent-specific names like CLAUDE only) remain when generic guidance is required.
- Read any runtime guidance docs (e.g., `README.md`, `docs/quickstart.md`, or agent-specific guidance files if present). Update references to principles changed.
5. Produce a Sync Impact Report (prepend as an HTML comment at top of the constitution file after update):
- Version change: old → new
- List of modified principles (old title → new title if renamed)
- Added sections
- Removed sections
- Templates requiring updates (✅ updated / ⚠ pending) with file paths
- Follow-up TODOs if any placeholders intentionally deferred.
6. Validation before final output:
- No remaining unexplained bracket tokens.
- Version line matches report.
- Dates ISO format YYYY-MM-DD.
- Principles are declarative, testable, and free of vague language ("should" → replace with MUST/SHOULD rationale where appropriate).
7. Write the completed constitution back to `.specify/memory/constitution.md` (overwrite).
8. Output a final summary to the user with:
- New version and bump rationale.
- Any files flagged for manual follow-up.
- Suggested commit message (e.g., `docs: amend constitution to vX.Y.Z (principle additions + governance update)`).
Formatting & Style Requirements:
- Use Markdown headings exactly as in the template (do not demote/promote levels).
- Wrap long rationale lines to keep readability (<100 chars ideally) but do not hard enforce with awkward breaks.
- Keep a single blank line between sections.
- Avoid trailing whitespace.
If the user supplies partial updates (e.g., only one principle revision), still perform validation and version decision steps.
If critical info missing (e.g., ratification date truly unknown), insert `TODO(<FIELD_NAME>): explanation` and include in the Sync Impact Report under deferred items.
Do not create a new template; always operate on the existing `.specify/memory/constitution.md` file.
-56
View File
@@ -1,56 +0,0 @@
---
description: Execute the implementation plan by processing and executing all tasks defined in tasks.md
---
The user input can be provided directly by the agent or as a command argument - you **MUST** consider it before proceeding with the prompt (if not empty).
User input:
$ARGUMENTS
1. Run `.specify/scripts/bash/check-prerequisites.sh --json --require-tasks --include-tasks` from repo root and parse FEATURE_DIR and AVAILABLE_DOCS list. All paths must be absolute.
2. Load and analyze the implementation context:
- **REQUIRED**: Read tasks.md for the complete task list and execution plan
- **REQUIRED**: Read plan.md for tech stack, architecture, and file structure
- **IF EXISTS**: Read data-model.md for entities and relationships
- **IF EXISTS**: Read contracts/ for API specifications and test requirements
- **IF EXISTS**: Read research.md for technical decisions and constraints
- **IF EXISTS**: Read quickstart.md for integration scenarios
3. Parse tasks.md structure and extract:
- **Task phases**: Setup, Tests, Core, Integration, Polish
- **Task dependencies**: Sequential vs parallel execution rules
- **Task details**: ID, description, file paths, parallel markers [P]
- **Execution flow**: Order and dependency requirements
4. Execute implementation following the task plan:
- **Phase-by-phase execution**: Complete each phase before moving to the next
- **Respect dependencies**: Run sequential tasks in order, parallel tasks [P] can run together
- **Follow TDD approach**: Execute test tasks before their corresponding implementation tasks
- **File-based coordination**: Tasks affecting the same files must run sequentially
- **Validation checkpoints**: Verify each phase completion before proceeding
5. Implementation execution rules:
- **Setup first**: Initialize project structure, dependencies, configuration
- **Tests before code**: If you need to write tests for contracts, entities, and integration scenarios
- **Core development**: Implement models, services, CLI commands, endpoints
- **Integration work**: Database connections, middleware, logging, external services
- **Polish and validation**: Unit tests, performance optimization, documentation
6. Progress tracking and error handling:
- Report progress after each completed task
- Halt execution if any non-parallel task fails
- For parallel tasks [P], continue with successful tasks, report failed ones
- Provide clear error messages with context for debugging
- Suggest next steps if implementation cannot proceed
- **IMPORTANT** For completed tasks, make sure to mark the task off as [X] in the tasks file.
7. Completion validation:
- Verify all required tasks are completed
- Check that implemented features match the original specification
- Validate that tests pass and coverage meets requirements
- Confirm the implementation follows the technical plan
- Report final status with summary of completed work
Note: This command assumes a complete task breakdown exists in tasks.md. If tasks are incomplete or missing, suggest running `/tasks` first to regenerate the task list.
-43
View File
@@ -1,43 +0,0 @@
---
description: Execute the implementation planning workflow using the plan template to generate design artifacts.
---
The user input to you can be provided directly by the agent or as a command argument - you **MUST** consider it before proceeding with the prompt (if not empty).
User input:
$ARGUMENTS
Given the implementation details provided as an argument, do this:
1. Run `.specify/scripts/bash/setup-plan.sh --json` from the repo root and parse JSON for FEATURE_SPEC, IMPL_PLAN, SPECS_DIR, BRANCH. All future file paths must be absolute.
- BEFORE proceeding, inspect FEATURE_SPEC for a `## Clarifications` section with at least one `Session` subheading. If missing or clearly ambiguous areas remain (vague adjectives, unresolved critical choices), PAUSE and instruct the user to run `/clarify` first to reduce rework. Only continue if: (a) Clarifications exist OR (b) an explicit user override is provided (e.g., "proceed without clarification"). Do not attempt to fabricate clarifications yourself.
2. Read and analyze the feature specification to understand:
- The feature requirements and user stories
- Functional and non-functional requirements
- Success criteria and acceptance criteria
- Any technical constraints or dependencies mentioned
3. Read the constitution at `.specify/memory/constitution.md` to understand constitutional requirements.
4. Execute the implementation plan template:
- Load `.specify/templates/plan-template.md` (already copied to IMPL_PLAN path)
- Set Input path to FEATURE_SPEC
- Run the Execution Flow (main) function steps 1-9
- The template is self-contained and executable
- Follow error handling and gate checks as specified
- Let the template guide artifact generation in $SPECS_DIR:
* Phase 0 generates research.md
* Phase 1 generates data-model.md, contracts/, quickstart.md
* Phase 2 generates tasks.md
- Incorporate user-provided details from arguments into Technical Context: $ARGUMENTS
- Update Progress Tracking as you complete each phase
5. Verify execution completed:
- Check Progress Tracking shows all phases complete
- Ensure all required artifacts were generated
- Confirm no ERROR states in execution
6. Report results with branch name, file paths, and generated artifacts.
Use absolute paths with the repository root for all file operations to avoid path issues.
-21
View File
@@ -1,21 +0,0 @@
---
description: Create or update the feature specification from a natural language feature description.
---
The user input to you can be provided directly by the agent or as a command argument - you **MUST** consider it before proceeding with the prompt (if not empty).
User input:
$ARGUMENTS
The text the user typed after `/specify` in the triggering message **is** the feature description. Assume you always have it available in this conversation even if `$ARGUMENTS` appears literally below. Do not ask the user to repeat it unless they provided an empty command.
Given that feature description, do this:
1. Run the script `.specify/scripts/bash/create-new-feature.sh --json "$ARGUMENTS"` from repo root and parse its JSON output for BRANCH_NAME and SPEC_FILE. All file paths must be absolute.
**IMPORTANT** You must only ever run this script once. The JSON is provided in the terminal as output - always refer to it to get the actual content you're looking for.
2. Load `.specify/templates/spec-template.md` to understand required sections.
3. Write the specification to SPEC_FILE using the template structure, replacing placeholders with concrete details derived from the feature description (arguments) while preserving section order and headings.
4. Report completion with branch name, spec file path, and readiness for the next phase.
Note: The script creates and checks out the new branch and initializes the spec file before writing.
-62
View File
@@ -1,62 +0,0 @@
---
description: Generate an actionable, dependency-ordered tasks.md for the feature based on available design artifacts.
---
The user input to you can be provided directly by the agent or as a command argument - you **MUST** consider it before proceeding with the prompt (if not empty).
User input:
$ARGUMENTS
1. Run `.specify/scripts/bash/check-prerequisites.sh --json` from repo root and parse FEATURE_DIR and AVAILABLE_DOCS list. All paths must be absolute.
2. Load and analyze available design documents:
- Always read plan.md for tech stack and libraries
- IF EXISTS: Read data-model.md for entities
- IF EXISTS: Read contracts/ for API endpoints
- IF EXISTS: Read research.md for technical decisions
- IF EXISTS: Read quickstart.md for test scenarios
Note: Not all projects have all documents. For example:
- CLI tools might not have contracts/
- Simple libraries might not need data-model.md
- Generate tasks based on what's available
3. Generate tasks following the template:
- Use `.specify/templates/tasks-template.md` as the base
- Replace example tasks with actual tasks based on:
* **Setup tasks**: Project init, dependencies, linting
* **Test tasks [P]**: One per contract, one per integration scenario
* **Core tasks**: One per entity, service, CLI command, endpoint
* **Integration tasks**: DB connections, middleware, logging
* **Polish tasks [P]**: Unit tests, performance, docs
4. Task generation rules:
- Each contract file → contract test task marked [P]
- Each entity in data-model → model creation task marked [P]
- Each endpoint → implementation task (not parallel if shared files)
- Each user story → integration test marked [P]
- Different files = can be parallel [P]
- Same file = sequential (no [P])
5. Order tasks by dependencies:
- Setup before everything
- Tests before implementation (TDD)
- Models before services
- Services before endpoints
- Core before integration
- Everything before polish
6. Include parallel execution examples:
- Group [P] tasks that can run together
- Show actual Task agent commands
7. Create FEATURE_DIR/tasks.md with:
- Correct feature name from implementation plan
- Numbered tasks (T001, T002, etc.)
- Clear file paths for each task
- Dependency notes
- Parallel execution guidance
Context for task generation: $ARGUMENTS
The tasks.md should be immediately executable - each task must be specific enough that an LLM can complete it without additional context.
@@ -1,368 +0,0 @@
---
name: Anchor Sequence Optimization
overview: Replace the current multiprocessing-based anchor sequence algorithm with an efficient single-threaded implementation using hash-based n-gram indexing, greedy longest-first matching, and simplified scoring to achieve sub-30-second performance in both local and cloud environments.
todos:
- id: create-golden-fixtures
content: Create script to generate 10 golden test fixtures from representative song data (varying lengths/complexity), run current algorithm to capture expected anchor outputs
status: completed
- id: create-golden-test
content: Create test_anchor_sequence_golden.py with regression tests that verify anchor finder output matches fixtures, ensure tests pass with current implementation before any changes
status: completed
- id: remove-multiprocessing
content: Remove multiprocessing.Pool from find_anchors() and _remove_overlapping_sequences(), replace with single-threaded loops
status: completed
- id: build-ngram-index
content: Add _build_ngram_index() method to create hash-based lookup table for O(1) n-gram matching
status: completed
- id: greedy-skip
content: Add covered_positions set tracking and skip logic to avoid processing overlapping n-grams
status: completed
- id: simple-scoring
content: Add _simple_score_anchor() with rule-based heuristics, make spaCy scoring optional via use_nlp_scoring flag
status: completed
- id: optimize-overlap
content: Replace O(n^2) overlap removal with O(n log n) sorted single-pass algorithm
status: completed
- id: add-perf-tests
content: Add performance benchmark test asserting <30 second completion for all fixture sizes
status: pending
---
# Anchor Sequence Algorithm Optimization
## Problem Analysis
The current `AnchorSequenceFinder` has critical performance issues:
### Root Causes of Hanging
1. **Multiprocessing Pool with fork()**: Python's `Pool()` uses `fork()` on Linux, which causes deadlocks in Cloud Run containers
2. **spaCy model loading in forked processes**: The `PhraseAnalyzer` loads spaCy's `en_core_web_sm` model, which can hang when forked
3. **Pool creation blocking**: The hang occurs before job submission, so timeout checks never trigger
### Algorithmic Inefficiencies
1. **O(n^2) n-gram matching**: Linear search through references for each n-gram
2. **Redundant work**: Processes all n-gram lengths (3 to ~30) even though longer matches are preferred
3. **O(n^2) overlap removal**: Each anchor checked against all previous anchors
4. **Expensive phrase scoring**: spaCy NLP called twice per anchor (phrase + context)
## Proposed Solution: Hash-Based Greedy Algorithm
### Core Algorithm Changes
**1. Hash-Based N-gram Index (O(1) lookup instead of O(n))**
- Pre-build a dictionary mapping n-grams to their positions in each reference
- Use tuple of cleaned words as key for O(1) lookup
- Build index once during preprocessing
**2. Greedy Longest-First Matching**
- Process n-gram lengths from longest to shortest (current behavior)
- BUT: Skip positions already covered by longer anchors immediately
- Use a "covered positions" set to avoid redundant work
**3. Single-Threaded Processing**
- Remove all `multiprocessing.Pool` usage
- Use efficient algorithms instead of parallelism
- Works identically in local and cloud environments
**4. Simplified Phrase Scoring (Optional)**
- Make spaCy-based scoring optional via configuration flag
- Default to rule-based heuristic scoring:
- Prefer sequences starting/ending at word boundaries
- Prefer sequences matching more reference sources
- Prefer longer sequences
- Option to enable full NLP scoring for higher-quality results offline
**5. O(n log n) Overlap Removal**
- Sort anchors by position
- Single pass with interval tracking using sorted list
- Skip anchors that overlap with any already-selected anchor
### New Data Structures
```python
# N-gram index: maps (word1, word2, ...) -> {source: [positions]}
ngram_index: Dict[Tuple[str, ...], Dict[str, List[int]]]
# Covered positions in transcription (for greedy skip)
covered_trans_positions: Set[int]
```
### Performance Targets
- **Target**: Complete in under 30 seconds for any song
- **Typical song**: 200-400 words, 3 reference sources
- **Expected performance**: 1-5 seconds for typical inputs
## Implementation Plan
### Execution Order (Critical)
1. **Phase 0**: Create golden test fixtures and verify tests pass with current code
2. **Phase 1-5**: Implement optimizations incrementally, running golden tests after each phase
3. **Final**: Add performance benchmarks
### Files to Create/Modify
- `lyrics_transcriber_temp/scripts/generate_anchor_fixtures.py` (new)
- `lyrics_transcriber_temp/tests/fixtures/anchor_golden/*.json` (new)
- `lyrics_transcriber_temp/tests/unit/correction/test_anchor_sequence_golden.py` (new)
- `lyrics_transcriber_temp/lyrics_transcriber/correction/anchor_sequence.py` (modify)
### Key Changes
**Phase 0: Golden Test Setup** (MUST complete and pass before any algorithm changes)
- Create fixture generation script with 10 representative test cases
- Run script to generate fixtures using current implementation
- Create golden test file that loads fixtures and verifies outputs
- Verify all golden tests pass with current code
**Phase 1: Remove Multiprocessing**
- Replace `Pool().apply_async()` with direct function calls
- Remove all pool creation, cleanup, and timeout handling
- Single-threaded loop through n-gram lengths
**Phase 2: Add Hash-Based Index**
- New method `_build_ngram_index()` that builds lookup table during preprocessing
- Modify `_find_matching_sources()` to use O(1) index lookup
- Index built once, shared across all n-gram length iterations
**Phase 3: Greedy Position Skipping**
- Track covered transcription positions in a set
- Skip n-grams that start in already-covered positions
- Reduces redundant work significantly for songs with good matches
**Phase 4: Simplify Scoring**
- Add `use_nlp_scoring: bool = False` parameter to constructor
- New method `_simple_score_anchor()` using rule-based heuristics
- Keep spaCy scoring available for offline/high-quality mode
**Phase 5: Optimize Overlap Removal**
- Sort anchors by (start_position, -length)
- Single pass: keep anchor if no overlap with last kept anchor
- O(n log n) total instead of O(n^2)
## API Compatibility
The public interface remains unchanged:
- `find_anchors(transcribed, references, transcription_result) -> List[ScoredAnchor]`
- `find_gaps(transcribed, anchors, references, transcription_result) -> List[GapSequence]`
New optional constructor parameters:
- `use_nlp_scoring: bool = False` - Enable spaCy-based phrase scoring (slower but higher quality)
- Timeout parameter retained but less critical with efficient algorithm
## Fallback Strategy
If performance is still insufficient for edge cases:
1. **Early termination**: Stop after finding sufficient coverage (e.g., 80% of words anchored)
2. **Adaptive n-gram range**: Start with medium lengths (8-15), expand only if needed
3. **Sampling**: For very long songs, sample n-gram positions instead of exhaustive search
## Phase 0: Golden Test Setup (BEFORE any algorithm changes)
### Goal
Create regression tests using REAL song data from local cache to verify the optimized algorithm produces equivalent results.
### Cache File Structure (Understanding)
The local cache at `~/lyrics-transcriber-cache/` contains:
- **Reference lyrics**: `{provider}_{hash}_converted.json` where provider is spotify/genius/lrclib/musixmatch
- Hash is based on (artist, title) lookup - same song shares same hash across providers
- `_raw.json` contains metadata (track name, artist)
- `_converted.json` contains LyricsData structure with segments/words
- **Transcriptions**: `audioshake_{hash}_converted.json`
- Hash is based on audio file content (different from reference hash)
- Contains TranscriptionData structure
- **Anchor results**: `anchors_{hash}.json`
- Hash is computed from combined inputs (transcription + all references)
### Manual Song Selection
Identify 10 songs from cache with good coverage. Search raw files for track names:
### Finding Song Mappings
To link audioshake transcriptions to reference lyrics, search cache files:
```bash
# Find songs by searching raw files for track names
grep -h "trackName" ~/lyrics-transcriber-cache/spotify_*_raw.json | head -20
# Find audioshake files for a known song (e.g., search for filename patterns)
ls ~/lyrics-transcriber-cache/audioshake_*_raw.json | head -20
# Search converted files for specific lyrics text
grep -l "Napoleon did surrender" ~/lyrics-transcriber-cache/*_converted.json
```
**Target song list** (reference_hash to be paired with audioshake_hash):
1. ABBA - Waterloo (refs: 3365f6a1e42388d84bcbfc0ac6f8aa6c) - short, repetitive chorus
2. The Format - Time Bomb (refs: 3a3802ec28c4ab6689909b7ef784bb6f) - medium length
3. Rancid - Time Bomb (refs: d02d20b854cbc6b890f274bd6c278752) - fast punk lyrics
4. Minutemen - Storm in My House (refs: bc625704b26b307d8680ae5235b74994) - short
5. + 6 more songs to be identified during fixture generation by exploring cache
### Fixture Generation Script
Create `lyrics_transcriber_temp/scripts/generate_anchor_fixtures.py`:
```python
# Input: List of (name, audioshake_hash, reference_hash) tuples
# For each:
# 1. Load audioshake_{hash}_converted.json as transcription
# 2. Load {spotify,genius,lrclib}_{hash}_converted.json as references
# 3. Run current AnchorSequenceFinder
# 4. Save complete fixture with inputs + outputs
```
The script will:
1. Accept a config file listing the 10 song mappings
2. Load real LyricsData from cache files
3. Run the CURRENT AnchorSequenceFinder implementation
4. Save fixtures that capture the real behavior
### Fixture Format
```
lyrics_transcriber_temp/tests/fixtures/anchor_golden/
- waterloo_abba.json
- time_bomb_format.json
- time_bomb_rancid.json
- ...
```
Each fixture contains REAL data:
```json
{
"name": "waterloo_abba",
"description": "ABBA - Waterloo, short song with repetitive chorus",
"source_hashes": {
"audioshake": "1654b7c0755fad7f23bc888308f274de",
"references": "3365f6a1e42388d84bcbfc0ac6f8aa6c"
},
"transcription": {
"segments": [...], // Full LyricsData from audioshake cache
"word_count": 150
},
"references": {
"spotify": { "segments": [...] },
"genius": { "segments": [...] },
"lrclib": { "segments": [...] }
},
"expected_anchors": [
{
"text": "My my at Waterloo Napoleon did surrender",
"transcription_position": 0,
"length": 7,
"reference_positions": {"spotify": 0, "genius": 0, "lrclib": 0},
"confidence": 1.0
},
// ... all anchors from current implementation
],
"expected_anchor_count": 25,
"expected_word_coverage": 142,
"expected_coverage_percent": 94.6
}
```
### Golden Test
Create `lyrics_transcriber_temp/tests/unit/correction/test_anchor_sequence_golden.py`:
```python
import pytest
import json
from pathlib import Path
FIXTURES_DIR = Path(__file__).parent.parent.parent / "fixtures" / "anchor_golden"
@pytest.fixture(params=list(FIXTURES_DIR.glob("*.json")))
def golden_fixture(request):
with open(request.param) as f:
return json.load(f)
def test_anchor_count_matches(golden_fixture, anchor_finder):
"""Anchor count should be within 10% of expected."""
anchors = run_anchor_finder(golden_fixture)
expected = golden_fixture["expected_anchor_count"]
assert abs(len(anchors) - expected) <= expected * 0.1
def test_key_anchors_match(golden_fixture, anchor_finder):
"""First, last, and longest anchors should match exactly."""
anchors = run_anchor_finder(golden_fixture)
expected = golden_fixture["expected_anchors"]
# Compare first anchor
assert anchors[0].text == expected[0]["text"]
# Compare positions match
...
def test_word_coverage(golden_fixture, anchor_finder):
"""Total word coverage should be within 5% of expected."""
anchors = run_anchor_finder(golden_fixture)
coverage = calculate_coverage(anchors, golden_fixture)
expected = golden_fixture["expected_coverage_percent"]
assert abs(coverage - expected) <= 5.0
def test_no_invalid_positions(golden_fixture, anchor_finder):
"""All anchor positions should be valid."""
anchors = run_anchor_finder(golden_fixture)
word_count = golden_fixture["transcription"]["word_count"]
for anchor in anchors:
assert 0 <= anchor.transcription_position < word_count
```
### Validation Steps
1. **Generate fixtures from current implementation**:
```bash
cd lyrics_transcriber_temp
python scripts/generate_anchor_fixtures.py
```
2. **Verify fixtures were created**:
```bash
ls tests/fixtures/anchor_golden/
# Should show 10 .json files
```
3. **Run golden tests with CURRENT implementation**:
```bash
pytest tests/unit/correction/test_anchor_sequence_golden.py -v
```
4. **All tests MUST pass before any algorithm changes**
5. **After each optimization phase, re-run golden tests**:
```bash
pytest tests/unit/correction/test_anchor_sequence_golden.py -v
# Must still pass!
```
## Testing (Post-Optimization)
- Golden tests verify correctness (same outputs as before)
- Existing unit tests verify API compatibility
- Performance benchmark test with 30-second timeout assertion
- Test with various song lengths via golden fixtures
@@ -1,717 +0,0 @@
---
name: Instrumental Review UI
overview: Add an intelligent instrumental selection workflow with audio analysis, waveform visualization, playback controls, and the ability to mute sections of backing vocals to create custom instrumentals. This replaces the current text-only CLI prompt with a web UI that works for both local and remote workflows, with shared core logic for DRY/maintainable code.
todos:
- id: shared-core-module
content: Create karaoke_gen/instrumental_review/ shared module with AudioAnalyzer and AudioEditor classes (used by both local and remote)
status: completed
- id: shared-core-tests
content: Add comprehensive unit tests for shared module with >80% coverage (tests/unit/test_instrumental_review.py)
status: completed
- id: backend-services
content: Create backend service wrappers that use shared core module (audio_analysis_service.py, audio_editing_service.py)
status: completed
- id: backend-services-tests
content: Add unit tests for backend services with mocked GCS interactions (backend/tests/test_audio_services.py)
status: completed
- id: api-endpoints
content: Add new API endpoints for analysis, audio streaming, and custom instrumental creation
status: completed
- id: api-endpoints-tests
content: Add API endpoint tests with >80% coverage (backend/tests/test_instrumental_api.py)
status: completed
- id: render-worker-integration
content: Integrate audio analysis into render_video_worker before transitioning to awaiting_instrumental_selection
status: completed
- id: render-worker-tests
content: Add/update render_video_worker tests to cover new analysis integration
status: completed
- id: frontend-components
content: Create React components (WaveformDisplay, AudioPlayer, RegionSelector, InstrumentalReviewPage)
status: completed
- id: local-cli-integration
content: Update local gen_cli.py to use shared core module with local file paths (feature parity with remote)
status: completed
- id: local-cli-review-server
content: Add lightweight review server to local CLI for browser-based review (similar to lyrics review pattern)
status: completed
- id: remote-cli-update
content: Update remote_cli.py to use new analysis API and open browser for review
status: completed
- id: cli-tests
content: Add CLI tests verifying feature parity between local and remote modes
status: completed
- id: integration-tests
content: Add end-to-end integration tests for the full instrumental review workflow
status: completed
---
# Intelligent Instrumental Selection Plan
## Current State
The instrumental selection workflow currently:
- Presents a simple 1/2 choice in the CLI (clean vs. with_backing)
- Requires manual inspection in Audacity to evaluate backing vocals quality
- Cannot handle the common "Scenario 3" where backing vocals need partial muting
- Has no audio preview capability in remote mode
## Target Architecture
```
┌────────────────────────────────────────────────────────────────────────────┐
│ INSTRUMENTAL REVIEW WORKFLOW │
├────────────────────────────────────────────────────────────────────────────┤
│ │
│ 1. AUDIO ANALYSIS (automatic after render_video completes) │
│ │ │
│ ├── Analyze backing vocals stem for amplitude │
│ ├── Detect audible segments (> -40dB threshold) │
│ ├── Generate waveform visualization image │
│ └── Store analysis results in job state_data │
│ │
│ 2. AUTO-DECISION CHECK │
│ │ │
│ └── IF no audible segments detected: │
│ ├── Set recommended_selection = "clean" │
│ └── Skip to step 4 (or show minimal UI with suggestion) │
│ │
│ 3. HUMAN REVIEW (Web UI) │
│ │ │
│ ├── Display waveform with time axis │
│ ├── Show audible segment markers │
│ ├── Audio playback with waveform-click seeking │
│ ├── Toggle between: clean / with_backing / preview-custom │
│ ├── Select regions to mute (click/drag on waveform) │
│ └── Create custom instrumental if regions selected │
│ │
│ 4. SELECTION SUBMISSION │
│ │ │
│ └── POST /api/jobs/{job_id}/select-instrumental │
│ with selection = "clean" | "with_backing" | "custom" │
│ │
└────────────────────────────────────────────────────────────────────────────┘
```
## Architecture: Shared Core for DRY/SOLID
To ensure feature parity between local and remote CLIs while keeping code maintainable, we use a **shared core module** pattern:
```
┌─────────────────────────────────────────────────────────────────────────────┐
│ SHARED CORE ARCHITECTURE │
├─────────────────────────────────────────────────────────────────────────────┤
│ │
│ karaoke_gen/instrumental_review/ <── SHARED CORE MODULE │
│ ├── __init__.py │
│ ├── analyzer.py # AudioAnalyzer class (pure Python, no GCS) │
│ ├── editor.py # AudioEditor class (pure Python, no GCS) │
│ ├── waveform.py # WaveformGenerator class (matplotlib) │
│ └── models.py # Pydantic models: AnalysisResult, MuteRegion │
│ │
│ ┌─────────────────────┐ ┌──────────────────────┐ │
│ │ LOCAL CLI │ │ REMOTE BACKEND │ │
│ │ (karaoke-gen) │ │ (Cloud Run) │ │
│ ├─────────────────────┤ ├──────────────────────┤ │
│ │ │ │ │ │
│ │ gen_cli.py │ │ audio_analysis_ │ │
│ │ └── uses shared ───┼──────────────┼──► service.py │ │
│ │ core directly │ │ └── wraps shared│ │
│ │ with local │ │ core with │ │
│ │ file paths │ │ GCS I/O │ │
│ │ │ │ │ │
│ │ local_review_ │ │ audio_editing_ │ │
│ │ server.py │ │ service.py │ │
│ │ └── serves same ───┼──────────────┼──► (same pattern) │ │
│ │ React UI │ │ │ │
│ │ │ │ │ │
│ └─────────────────────┘ └──────────────────────┘ │
│ │
│ BENEFITS: │
│ ✓ Single source of truth for analysis logic │
│ ✓ Bug fixes apply to both local and remote │
│ ✓ Easy to test core logic without GCS mocks │
│ ✓ Backend services are thin wrappers (Single Responsibility) │
│ ✓ Same React UI served by both local server and Cloud Run │
│ │
└─────────────────────────────────────────────────────────────────────────────┘
```
### Shared Core Module Design
```python
# karaoke_gen/instrumental_review/analyzer.py
class AudioAnalyzer:
"""
Analyzes audio files for backing vocals content.
Pure Python - no cloud dependencies. Works with local file paths.
"""
def __init__(self, silence_threshold_db: float = -40.0,
min_segment_duration_ms: int = 100):
self.silence_threshold_db = silence_threshold_db
self.min_segment_duration_ms = min_segment_duration_ms
def analyze(self, audio_path: str) -> AnalysisResult:
"""Analyze audio file and return structured result."""
...
def get_amplitude_envelope(self, audio_path: str,
window_ms: int = 100) -> List[float]:
"""Get amplitude envelope for waveform rendering."""
...
# karaoke_gen/instrumental_review/editor.py
class AudioEditor:
"""
Creates custom instrumentals by muting regions of backing vocals.
Pure Python - no cloud dependencies.
"""
def create_custom_instrumental(
self,
clean_instrumental_path: str,
backing_vocals_path: str,
mute_regions: List[MuteRegion],
output_path: str
) -> str:
"""Create custom instrumental with muted regions."""
...
# karaoke_gen/instrumental_review/waveform.py
class WaveformGenerator:
"""Generates waveform visualization images."""
def generate(self, audio_path: str, output_path: str,
segments: List[AudibleSegment] = None,
width: int = 1200, height: int = 200) -> str:
"""Generate waveform PNG with optional segment highlighting."""
...
```
## Implementation Components
### 1. Shared Core Module (karaoke_gen/instrumental_review/)
Create the shared module first - this is the foundation:
```python
# karaoke_gen/instrumental_review/models.py
from pydantic import BaseModel
from typing import List, Optional
from enum import Enum
class RecommendedSelection(str, Enum):
CLEAN = "clean"
WITH_BACKING = "with_backing"
REVIEW_NEEDED = "review_needed"
class AudibleSegment(BaseModel):
start_seconds: float
end_seconds: float
duration_seconds: float
avg_amplitude_db: float
class MuteRegion(BaseModel):
start_seconds: float
end_seconds: float
class AnalysisResult(BaseModel):
has_audible_content: bool
total_duration_seconds: float
audible_segments: List[AudibleSegment]
recommended_selection: RecommendedSelection
waveform_data: Optional[List[float]] = None # For JSON API response
```
### 2. Backend Service Wrappers
Create `backend/services/audio_analysis_service.py`:
```python
# Key functionality:
- analyze_backing_vocals(audio_path) -> AnalysisResult
- Uses pydub for audio loading
- Calculates RMS amplitude in dB across time windows
- Detects audible segments (contiguous regions > threshold)
- Returns: {
"has_audible_content": bool,
"total_duration_seconds": float,
"audible_segments": [
{"start_seconds": float, "end_seconds": float,
"duration_seconds": float, "avg_amplitude_db": float}
],
"recommended_selection": "clean" | "with_backing" | "review_needed"
}
- generate_waveform_image(audio_path, output_path, segments=None) -> str
- Uses matplotlib to render amplitude envelope over time
- Highlights audible segments with different colors
- Returns path to generated PNG image
```
### 2. Audio Editing Service
Create `backend/services/audio_editing_service.py`:
```python
# Key functionality:
- create_custom_instrumental(
clean_instrumental_path: str,
backing_vocals_path: str,
mute_regions: List[Tuple[float, float]], # [(start_s, end_s), ...]
output_path: str
) -> str
- Loads backing vocals
- Applies silence to mute_regions
- Mixes with clean instrumental
- Saves as new FLAC file
```
### 3. Backend API Endpoints
Add to `backend/api/routes/jobs.py`:
```python
GET /api/jobs/{job_id}/instrumental-analysis
# Returns analysis data + waveform URL
GET /api/jobs/{job_id}/audio-stream/{stem_type}
# Stream audio for playback (clean, backing_vocals, combined)
POST /api/jobs/{job_id}/create-custom-instrumental
# Body: {"mute_regions": [[0.5, 2.3], [45.0, 48.5]]}
# Creates custom instrumental, updates job state
POST /api/jobs/{job_id}/select-instrumental
# Extended to accept: "clean" | "with_backing" | "custom"
```
### 4. Frontend Web UI
Create `frontend/app/jobs/[id]/instrumental-review/page.tsx`:
```
Components needed:
- WaveformDisplay: SVG/Canvas waveform with time axis
- AudioPlayer: HTML5 audio with controls + waveform sync
- RegionSelector: Click/drag to select mute regions
- InstrumentalOptions: Radio buttons for clean/backing/custom
- SegmentList: Table showing detected audible segments
```
Key interactions:
- Click on waveform to seek playback position
- Drag on waveform to select mute region
- Toggle audio source (clean/backing/preview)
- Submit selection
### 5. Backend Worker Updates
Modify `backend/workers/render_video_worker.py`:
```python
# After video render completes, before transitioning to AWAITING_INSTRUMENTAL_SELECTION:
1. Download backing_vocals stem
2. Run audio analysis
3. Generate waveform image
4. Upload waveform to GCS
5. Store analysis results in job.state_data
6. If no audible content: set recommended_selection = "clean"
7. Transition to AWAITING_INSTRUMENTAL_SELECTION
```
### 6. CLI Updates
Modify `karaoke_gen/utils/remote_cli.py`:
```python
def handle_instrumental_selection(self, job_id: str):
# Get analysis data
analysis = self.client.get_instrumental_analysis(job_id)
# If no backing vocals detected, suggest auto-select
if analysis['recommended_selection'] == 'clean':
if self.config.non_interactive:
# Auto-select clean
self.client.select_instrumental(job_id, 'clean')
return
else:
# Show suggestion, offer to open browser for verification
self.logger.info("No backing vocals detected - recommending clean instrumental")
# Open browser anyway so user can verify if desired
# Open browser to instrumental review UI
self.open_instrumental_review_ui(job_id)
# Poll until selection made
while job.status == 'awaiting_instrumental_selection':
time.sleep(self.config.poll_interval)
```
### 7. Local CLI Integration (Feature Parity)
The local CLI (`karaoke-gen`) uses the **same shared core module** as the backend:
```python
# karaoke_gen/utils/gen_cli.py - Updated instrumental selection flow
def handle_instrumental_selection(self, output_dir: str, base_name: str):
"""Handle instrumental selection using shared core module."""
from karaoke_gen.instrumental_review import AudioAnalyzer, WaveformGenerator
# Paths to local files (already exist from audio separation)
backing_vocals_path = os.path.join(output_dir, "stems",
f"{base_name} (Backing Vocals ...).flac")
clean_instrumental_path = os.path.join(output_dir, "stems",
f"{base_name} (Instrumental ...).flac")
# Use SAME analyzer as backend
analyzer = AudioAnalyzer(silence_threshold_db=-40.0)
analysis = analyzer.analyze(backing_vocals_path)
# Generate waveform locally
waveform_path = os.path.join(output_dir, "backing_vocals_waveform.png")
WaveformGenerator().generate(backing_vocals_path, waveform_path,
analysis.audible_segments)
if not analysis.has_audible_content:
self.logger.info("No backing vocals detected - using clean instrumental")
if not self.non_interactive:
# Offer to open browser for verification
...
return "clean"
# Start local review server (serves same React UI)
from karaoke_gen.instrumental_review.server import InstrumentalReviewServer
server = InstrumentalReviewServer(
output_dir=output_dir,
base_name=base_name,
analysis=analysis,
waveform_path=waveform_path,
)
server.start_and_open_browser() # Blocking until user submits selection
return server.get_selection()
```
### 8. Local Review Server
Create `karaoke_gen/instrumental_review/server.py`:
```python
"""
Lightweight local server for instrumental review.
Serves the same React frontend used by the cloud backend.
Similar pattern to LyricsTranscriber's ReviewServer.
"""
from http.server import HTTPServer, SimpleHTTPRequestHandler
import json
import threading
class InstrumentalReviewServer:
"""
Local HTTP server for instrumental review UI.
Endpoints:
- GET /api/analysis - Returns analysis data
- GET /api/audio/{type} - Streams audio files
- GET /api/waveform - Returns waveform image
- POST /api/create-custom - Creates custom instrumental
- POST /api/select - Submits selection
- GET /* - Serves React frontend static files
"""
def __init__(self, output_dir: str, base_name: str,
analysis: AnalysisResult, waveform_path: str):
...
def start_and_open_browser(self, port: int = 8765):
"""Start server, open browser, block until selection submitted."""
...
def get_selection(self) -> str:
"""Get the user's selection after browser submission."""
...
```
## Testing Strategy
### Test Coverage Requirements
All new code must meet the project's **70% minimum coverage** requirement, with critical paths targeting **>80%**:
| Module | Target Coverage | Test File |
|--------|----------------|-----------|
| `karaoke_gen/instrumental_review/analyzer.py` | >90% | `tests/unit/test_instrumental_analyzer.py` |
| `karaoke_gen/instrumental_review/editor.py` | >90% | `tests/unit/test_instrumental_editor.py` |
| `karaoke_gen/instrumental_review/waveform.py` | >80% | `tests/unit/test_instrumental_waveform.py` |
| `karaoke_gen/instrumental_review/server.py` | >70% | `tests/unit/test_instrumental_server.py` |
| `backend/services/audio_analysis_service.py` | >80% | `backend/tests/test_audio_analysis_service.py` |
| `backend/services/audio_editing_service.py` | >80% | `backend/tests/test_audio_editing_service.py` |
| `backend/api/routes/jobs.py` (new endpoints) | >80% | `backend/tests/test_instrumental_api.py` |
### Test Categories
**1. Unit Tests (Shared Core) - tests/unit/test_instrumental_*.py**
```python
# tests/unit/test_instrumental_analyzer.py
class TestAudioAnalyzer:
def test_analyze_silent_audio_returns_no_audible_content(self):
"""Silent audio should return has_audible_content=False."""
def test_analyze_audio_with_content_detects_segments(self):
"""Audio with content should detect audible segments."""
def test_segment_detection_respects_threshold(self):
"""Segments below threshold should not be detected."""
def test_segment_merging_for_close_segments(self):
"""Close segments should be merged into one."""
def test_recommended_selection_clean_for_silent(self):
"""Silent audio should recommend 'clean'."""
def test_recommended_selection_review_for_content(self):
"""Audio with content should recommend 'review_needed'."""
# tests/unit/test_instrumental_editor.py
class TestAudioEditor:
def test_mute_single_region(self):
"""Single mute region should be applied correctly."""
def test_mute_multiple_regions(self):
"""Multiple mute regions should all be applied."""
def test_mute_region_boundaries(self):
"""Mute region at start/end of audio should work."""
def test_output_format_is_flac(self):
"""Output should be FLAC format."""
def test_combines_with_clean_instrumental(self):
"""Result should be backing vocals mixed with clean instrumental."""
```
**2. Unit Tests (Backend Services) - backend/tests/test_audio_*_service.py**
```python
# backend/tests/test_audio_analysis_service.py
class TestAudioAnalysisService:
@pytest.fixture
def mock_storage(self):
"""Mock GCS storage service."""
def test_analyze_downloads_from_gcs(self, mock_storage):
"""Service should download audio from GCS before analysis."""
def test_analyze_uploads_waveform_to_gcs(self, mock_storage):
"""Service should upload waveform image to GCS."""
def test_analyze_updates_job_state_data(self, mock_storage):
"""Service should store analysis in job.state_data."""
```
**3. API Endpoint Tests - backend/tests/test_instrumental_api.py**
```python
# backend/tests/test_instrumental_api.py
class TestInstrumentalAnalysisEndpoint:
def test_get_analysis_returns_data(self, client, mock_job):
"""GET /instrumental-analysis should return analysis data."""
def test_get_analysis_requires_correct_status(self, client, mock_job):
"""Should return 400 if job not in correct status."""
class TestAudioStreamEndpoint:
def test_stream_backing_vocals(self, client, mock_job):
"""Should stream backing vocals audio."""
def test_stream_clean_instrumental(self, client, mock_job):
"""Should stream clean instrumental audio."""
class TestCreateCustomInstrumental:
def test_create_with_mute_regions(self, client, mock_job):
"""Should create custom instrumental with mute regions."""
def test_validates_mute_regions(self, client, mock_job):
"""Should validate mute region boundaries."""
```
**4. Integration Tests - tests/integration/test_instrumental_review.py**
```python
# tests/integration/test_instrumental_review_flow.py
class TestInstrumentalReviewFlow:
"""End-to-end tests for instrumental review workflow."""
def test_full_flow_clean_selection(self):
"""Test complete flow: analysis -> review -> select clean."""
def test_full_flow_with_backing_selection(self):
"""Test complete flow: analysis -> review -> select with_backing."""
def test_full_flow_custom_creation(self):
"""Test complete flow: analysis -> mute regions -> custom."""
def test_auto_recommend_clean_for_silent_backing(self):
"""When no backing vocals, should recommend clean."""
```
**5. CLI Feature Parity Tests - tests/unit/test_cli_feature_parity.py**
```python
# tests/unit/test_cli_feature_parity.py
class TestCLIFeatureParity:
"""Verify local and remote CLIs have equivalent functionality."""
def test_both_clis_use_same_analyzer(self):
"""Both CLIs should use AudioAnalyzer from shared module."""
def test_both_clis_support_custom_instrumental(self):
"""Both CLIs should support creating custom instrumentals."""
def test_analysis_results_identical(self):
"""Same audio should produce identical analysis from both CLIs."""
```
### Test Data
Create test fixtures in `tests/data/instrumental_review/`:
- `silent_backing_vocals.flac` - Silent/near-silent audio (~10s)
- `backing_vocals_with_content.flac` - Audio with clear backing vocals (~30s)
- `backing_vocals_mixed_quality.flac` - Audio with some good/some bad sections (~30s)
Use pydub to programmatically generate these in `tests/conftest.py` fixtures.
## File Changes Summary
| Category | Files to Create/Modify |
|----------|------------------------|
| **Shared Core** | `karaoke_gen/instrumental_review/__init__.py` (new) |
| Shared Core | `karaoke_gen/instrumental_review/models.py` (new) |
| Shared Core | `karaoke_gen/instrumental_review/analyzer.py` (new) |
| Shared Core | `karaoke_gen/instrumental_review/editor.py` (new) |
| Shared Core | `karaoke_gen/instrumental_review/waveform.py` (new) |
| Shared Core | `karaoke_gen/instrumental_review/server.py` (new) |
| **Backend Services** | `backend/services/audio_analysis_service.py` (new) |
| Backend Services | `backend/services/audio_editing_service.py` (new) |
| **API** | `backend/api/routes/jobs.py` (modify - add endpoints) |
| API | `backend/api/routes/instrumental.py` (new - if endpoints get large) |
| **Workers** | `backend/workers/render_video_worker.py` (modify) |
| **Models** | `backend/models/job.py` (add analysis fields to state_data) |
| **Frontend** | `frontend/app/jobs/[id]/instrumental-review/page.tsx` (new) |
| Frontend | `frontend/components/waveform-display.tsx` (new) |
| Frontend | `frontend/components/audio-player-with-waveform.tsx` (new) |
| Frontend | `frontend/components/region-selector.tsx` (new) |
| **Local CLI** | `karaoke_gen/utils/gen_cli.py` (modify) |
| **Remote CLI** | `karaoke_gen/utils/remote_cli.py` (modify) |
| **Tests - Shared** | `tests/unit/test_instrumental_analyzer.py` (new) |
| Tests - Shared | `tests/unit/test_instrumental_editor.py` (new) |
| Tests - Shared | `tests/unit/test_instrumental_waveform.py` (new) |
| Tests - Shared | `tests/unit/test_instrumental_server.py` (new) |
| **Tests - Backend** | `backend/tests/test_audio_analysis_service.py` (new) |
| Tests - Backend | `backend/tests/test_audio_editing_service.py` (new) |
| Tests - Backend | `backend/tests/test_instrumental_api.py` (new) |
| **Tests - Parity** | `tests/unit/test_cli_feature_parity.py` (new) |
| **Tests - Integration** | `tests/integration/test_instrumental_review.py` (new) |
| **Test Data** | `tests/conftest.py` (modify - add fixtures) |
## Dependencies
Already available in `pyproject.toml`:
- `pydub>=0.25.1` - Audio loading and manipulation
- `matplotlib>=3` - Waveform visualization
- `numpy>=2` - Audio array processing
Frontend:
- React/Next.js (existing)
- HTML5 Audio API (native)
- Canvas or SVG for waveform (native)
## Implementation Order
Execute in this order to enable incremental testing:
### Phase 1: Shared Core Module (Foundation)
1. Create `karaoke_gen/instrumental_review/` package with models, analyzer, editor, waveform
2. Add comprehensive unit tests for shared core (>90% coverage)
3. Create test audio fixtures in `tests/conftest.py`
### Phase 2: Backend Integration
4. Create backend service wrappers with GCS integration
5. Add backend service unit tests with mocked GCS
6. Add new API endpoints to `backend/api/routes/jobs.py`
7. Add API endpoint tests
8. Integrate analysis into `render_video_worker.py`
9. Update render worker tests
### Phase 3: Frontend
10. Create React components (WaveformDisplay, AudioPlayer, RegionSelector)
11. Create instrumental review page
12. Test frontend manually with backend
### Phase 4: CLI Integration
13. Update `remote_cli.py` to use new analysis API and open browser
14. Create local review server `karaoke_gen/instrumental_review/server.py`
15. Update `gen_cli.py` to use shared core and local server
16. Add CLI feature parity tests
### Phase 5: Integration Testing
17. Add end-to-end integration tests
18. Manual testing of full workflow (local and remote)
### Verification Checklist
- [ ] All unit tests pass: `pytest tests/unit/ -v`
- [ ] All backend tests pass: `pytest backend/tests/ -v`
- [ ] Coverage meets 70% minimum: `pytest --cov=karaoke_gen --cov-fail-under=70`
- [ ] Local CLI works: `karaoke-gen "Artist" "Title"` (reaches instrumental selection)
- [ ] Remote CLI works: `karaoke-gen-remote ./audio.flac "Artist" "Title"`
- [ ] Both CLIs produce identical analysis for same audio
- [ ] Custom instrumental creation works in both modes
- [ ] Version bumped in `pyproject.toml`
@@ -1,217 +0,0 @@
---
name: MidiCo-Style Synchronizer
overview: Build a new MidiCo-style Synchronizer component for efficient re-syncing of lyrics timing, particularly for fixing progressive drift in the second half of songs. This involves refactoring the "Edit All" entry point and creating a high-performance timeline-based sync interface.
todos:
- id: mode-selection-modal
content: Create ModeSelectionModal for 'Replace All' vs 'Re-sync Existing' choice
status: completed
- id: timeline-canvas
content: Build canvas-based TimelineCanvas component for high-performance word block rendering
status: completed
- id: upcoming-words-bar
content: Create UpcomingWordsBar component showing next unsynced words in fixed position
status: completed
- id: sync-controls
content: Build SyncControls with Start Sync, Clear Sync, Unsync from Cursor, Delete Selected buttons
status: completed
- id: lyrics-synchronizer
content: Create main LyricsSynchronizer component integrating all sub-components
status: completed
- id: unsync-from-cursor
content: Add 'unsync from cursor' functionality to useManualSync hook
status: completed
- id: integrate-modal
content: Integrate new synchronizer into ReplaceAllLyricsModal with mode selection
status: completed
- id: word-selection
content: Implement single-click and drag-select for word blocks
status: completed
- id: zoom-slider
content: Add smooth zoom slider with 4.5s-24s range
status: completed
- id: performance-test
content: Test performance with long songs and optimize as needed
status: completed
---
# MidiCo-Style Synchronizer Implementation
## Current State Analysis
The existing implementation in [`ReplaceAllLyricsModal.tsx`](lyrics_transcriber_temp/lyrics_transcriber/frontend/src/components/ReplaceAllLyricsModal.tsx) has two phases:
1. **Paste Phase** - User pastes new lyrics text
2. **Sync Phase** - Manual sync using spacebar with timeline view
Key existing components:
- [`useManualSync.ts`](lyrics_transcriber_temp/lyrics_transcriber/frontend/src/hooks/useManualSync.ts) - Spacebar handling, tap/hold detection
- [`EditTimelineSection.tsx`](lyrics_transcriber_temp/lyrics_transcriber/frontend/src/components/EditTimelineSection.tsx) - Timeline controls with zoom/scroll
- [`TimelineEditor.tsx`](lyrics_transcriber_temp/lyrics_transcriber/frontend/src/components/TimelineEditor.tsx) - Timeline rendering
**Problems with current implementation:**
1. Forces full lyrics replacement - no option to keep existing sync data
2. Performance issues (laggy, slow rendering)
3. Poor UX for seeing upcoming words while syncing
4. No "unsync from cursor" feature for fixing drift
5. No two-level word block layout for overlapping segments
## Architecture Overview
```mermaid
flowchart TB
subgraph Entry [Entry Point]
EditAll[Edit All Button]
EditAll --> ChoiceModal[Mode Selection Modal]
ChoiceModal -->|Replace All| PastePhase[Paste New Lyrics]
ChoiceModal -->|Re-sync Existing| SyncView[Synchronizer View]
PastePhase --> SyncView
end
subgraph Sync [Synchronizer Component]
SyncView --> Timeline[Timeline Canvas]
SyncView --> Controls[Control Buttons]
SyncView --> UpcomingWords[Upcoming Words Display]
Timeline --> WordBlocks[Word Blocks Renderer]
Timeline --> Playhead[Playhead Marker]
Timeline --> TimeBar[Time Bar]
end
subgraph Audio [Audio Integration]
AudioPlayer[Audio Player]
AudioPlayer <--> SyncView
end
```
## Implementation Plan
### Phase 1: Entry Point Refactor
Modify the "Edit All" button flow to show a choice modal:
```typescript
// New ModeSelectionModal component
interface ModeSelectionModalProps {
open: boolean
onClose: () => void
onSelectReplace: () => void // Goes to paste phase
onSelectResync: () => void // Goes directly to sync view
}
```
- **Replace All Lyrics**: Current flow (paste box -> sync)
- **Re-sync Existing Lyrics**: Load current segments directly into sync view
### Phase 2: New Synchronizer Component
Create a new high-performance `LyricsSynchronizer.tsx` component inspired by MidiCo:
#### Core Features
1. **Timeline Canvas** (HTML5 Canvas for performance)
- Time bar at top (MM:SS format with decisecond ticks)
- Playhead with arrow indicator + vertical line
- Red word blocks with text labels
- Two-level word layout for overlapping segments
- Zoom slider (4.5s to 24s visible range)
- Horizontal scroll with smooth panning
2. **Upcoming Words Display** (dual location)
- Fixed position above timeline: next words as red/white blocks
- On timeline: words appear to right of playhead during sync
3. **Control Buttons**
- **Start Sync** - Begin sync mode from first unsynced word
- **Clear Sync** - Reset all word timings to null
- **Edit Lyrics** - Modal to edit lyrics text (warns about timing loss)
- **Unsync from Cursor** - Critical: reset all words after playhead position
- **Split/Edit Word** - Edit single selected word
- **Delete Selected** - Remove selected word blocks
4. **Word Selection**
- Single click: select one word (white border)
- Click-drag on background: selection rectangle for multi-select
- Click on time bar: set playhead position
5. **Spacebar Sync Logic** (reuse/enhance `useManualSync`)
- Tap: set start time, default 500ms duration
- Hold: set both start and end times
- Handle previous word end time calculation
### Phase 3: Performance Optimization
The current `TimelineEditor` uses DOM elements which causes lag. New approach:
1. **Canvas-based rendering** for word blocks and timeline
- Single canvas element, no DOM nodes per word
- RequestAnimationFrame for smooth playhead updates
- Only re-render changed regions
2. **Virtual scrolling** for very long songs
- Only render visible word blocks
- Cache off-screen block positions
3. **Debounced state updates**
- Batch word timing updates
- Throttle zoom/scroll handlers
### Phase 4: Apply/Cancel Flow
Changes are held in local state until user clicks Apply:
```typescript
interface SynchronizerState {
words: Word[] // Working copy of words
segments: LyricsSegment[] // Working copy of segments
isDirty: boolean // Has unsaved changes
}
```
- **Apply**: Commit changes to parent component
- **Cancel**: Discard changes, close modal
## File Changes
### New Files
- `src/components/LyricsSynchronizer.tsx` - Main synchronizer component
- `src/components/LyricsSynchronizer/TimelineCanvas.tsx` - Canvas-based timeline
- `src/components/LyricsSynchronizer/UpcomingWordsBar.tsx` - Fixed upcoming words display
- `src/components/LyricsSynchronizer/SyncControls.tsx` - Control buttons
- `src/components/ModeSelectionModal.tsx` - Entry point choice modal
### Modified Files
- [`ReplaceAllLyricsModal.tsx`](lyrics_transcriber_temp/lyrics_transcriber/frontend/src/components/ReplaceAllLyricsModal.tsx) - Add mode selection, integrate new synchronizer
- [`useManualSync.ts`](lyrics_transcriber_temp/lyrics_transcriber/frontend/src/hooks/useManualSync.ts) - Add "unsync from cursor" functionality
## Key UX Details from MidiCo Reference
Per the documentation at [`MIDICO_SYNCHRONIZER_REFERENCE.md`](lyrics_transcriber_temp/docs/MIDICO_SYNCHRONIZER_REFERENCE.md):
1. **Zoom range**: 4.5s (max zoom) to 24s (min zoom) visible
2. **Timeline click behavior**:
- Time bar click = set playhead (no playback change)
- Background click = nothing (prevent accidental deselection)
- Word block click = select
3. **Two-level word blocks**: Adjacent/overlapping words display on alternating vertical levels
4. **Playhead**: Small arrow in time bar + white vertical line spanning timeline height
5. **Selection rectangle**: Click-drag on background creates selection box
## Testing Strategy
1. Manual testing with the provided URL: `http://localhost:8000/?baseApiUrl=...`
2. Test sync accuracy with songs that have known drift issues
3. Performance testing with 400+ word songs
4. Test "unsync from cursor" workflow for fixing drift
-21
View File
@@ -1,21 +0,0 @@
---
description: Git branching and PR workflow
alwaysApply: true
---
# Branching Workflow
**Never commit directly to `main`.** Always work on a feature branch.
Create descriptive branch names like `feature/add-discord-notifications`, `fix/audio-sync-issue`, or `refactor/cleanup-api-routes`.
# Creating a Pull Request
Once all changes are complete, tests pass, and commits are pushed, create a PR with:
1. **Summary** - Brief overview of the changes
2. **Changes Made** - List of specific modifications
3. **Testing** - How changes were tested (unit tests, manual testing)
4. **Related Issues** - Reference any GitHub issues (e.g., "Fixes #123")
Only merge after review and CI checks pass.
-14
View File
@@ -1,14 +0,0 @@
# Infrastructure Changes
All Google Cloud infrastructure (IAM, Cloud Storage, Cloud Run, Secret Manager, Artifact Registry, etc.) must be managed via Pulumi in the `infrastructure/` folder.
## Rules
- **Reading/querying** with `gcloud` CLI is fine
- **Creating or modifying** resources must go through IaC — never use `gcloud` or the Console to make changes
## Workflow
1. Make changes in `infrastructure/`
2. Run `pulumi preview` and verify the output
3. Run `pulumi up` to apply
-27
View File
@@ -1,27 +0,0 @@
---
description: Version bumping rule for commits
alwaysApply: true
---
# Version Management
When committing and pushing changes, always bump the patch version in `pyproject.toml`.
The version is located at `tool.poetry.version` in `pyproject.toml`. For example, if the current version is `0.70.3`, bump it to `0.70.4`.
This ensures every commit pushed to the repository has a unique version number for tracking and deployment purposes.
# Testing Requirements
Before committing and pushing changes, ensure all tests pass:
```bash
python -m pytest tests/ backend/tests/ -v -x --ignore=tests/integration
```
Ensure all code touched is thoroughly covered by unit tests, we have a 70% coverage minimum in CI:
```bash
poetry run pytest tests/unit/ -v --cov=karaoke_gen --cov-report=xml --cov-report=term-missing --cov-fail-under=70
```
Do not commit or push code that fails tests. Fix any test failures before proceeding.
-73
View File
@@ -1,73 +0,0 @@
# .gcloudignore - Exclude files from Cloud Build uploads
# This dramatically reduces upload time (from 218MB to ~5-10MB)
# Git
.git/
.gitignore
.gitmodules
# Node.js / Frontend
node_modules/
frontend-react/node_modules/
frontend-react/dist/
frontend-react/.vite/
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
# Python
__pycache__/
*.py[cod]
*$py.class
*.so
.Python
.venv/
venv/
ENV/
env/
*.egg-info/
.eggs/
dist/
build/
*.egg
# IDE
.idea/
.vscode/
*.swp
*.swo
*~
.DS_Store
# Testing
.pytest_cache/
.coverage
htmlcov/
.tox/
.nox/
coverage.xml
*.cover
# Documentation (not needed for Docker build)
docs/
# Local development files
lyrics_transcriber_local/
*.local
.env
.env.*
# Large test files
tests/data/*.mp3
tests/data/*.wav
tests/data/*.mp4
tests/data/*.mkv
# Infrastructure (not needed for Docker build)
infrastructure/
# Misc
*.bak
*.tmp
Thumbs.db
-128
View File
@@ -1,128 +0,0 @@
# GitHub Actions CI/CD
This directory contains GitHub Actions workflows for automated testing and deployment.
## Workflows
### `test.yml` - Automated Testing & Deployment (CI/CD)
**Triggers:**
- Push to `main` or `replace-modal-with-google-cloud` branches
- Pull requests to `main`
**Jobs:**
#### Testing Phase (runs in parallel)
1. **Unit Tests** (~30s)
- Runs 62 unit tests with mocked dependencies
- Fast validation of business logic
- Uses Python 3.12 with pip caching
2. **Emulator Integration Tests** (~2min)
- Runs 11 integration tests against local GCP emulators
- Tests real Firestore and GCS interactions
- Requires:
- Java 21 (for Firestore emulator)
- Google Cloud SDK (for Firestore emulator)
- Docker (for GCS emulator via fake-gcs-server)
- Uses the same `scripts/run-emulator-tests.sh` as local development
3. **Code Quality** (~20s)
- Basic Python syntax validation
- Import checks
- Optional: flake8, black, isort
#### Deployment Phase (runs after all tests pass)
4. **Deploy to Cloud Run** (~3-4min)
- **Only runs on push to `replace-modal-with-google-cloud` branch** (not on PRs)
- Builds Docker image and pushes to Artifact Registry
- Deploys to Cloud Run with proper configuration
- Verifies deployment health
- **Requires GitHub secrets:**
- `GCP_SA_KEY` - Service account key JSON
- `ADMIN_TOKENS` - Admin authentication tokens
**Total Runtime:**
- **Testing only** (PRs): ~3 minutes
- **Testing + Deployment** (push to branch): ~7 minutes
## Local vs CI
The CI runs the exact same tests as local development:
```bash
# Local development
./scripts/run-tests.sh # Unit tests (same as CI job 1)
./scripts/run-emulator-tests.sh # Emulator tests (same as CI job 2)
python backend/validate.py # Validation (same as CI job 3)
# CI automatically runs all three on every push
```
## Viewing Results
1. Go to the [Actions tab](../../actions) in GitHub
2. Click on the latest workflow run
3. View job logs and test results
4. Download test artifacts (coverage reports) if needed
## Adding New Tests
Tests are automatically discovered by pytest. To add new tests:
1. **Unit tests:** Add to `backend/tests/test_*.py`
2. **Emulator tests:** Add to `backend/tests/emulator/test_*.py`
3. **Cloud tests:** Add to `backend/tests/test_api_integration.py` (runs manually)
The CI will automatically pick them up!
## Troubleshooting
### Emulator Tests Fail in CI
**Common issues:**
- Emulator startup timeout → Increase wait time in `scripts/start-emulators.sh`
- Docker not available → Check GitHub Actions runner compatibility
- Port conflicts → Emulators use ports 8080 (Firestore) and 4443 (GCS)
### CI is Slow
**Optimizations:**
- ✅ Python pip caching enabled
- ✅ Jobs run in parallel
- ✅ Docker image pre-pulled
- Future: Cache gcloud SDK installation
### Tests Pass Locally But Fail in CI
**Debug steps:**
1. Check Python version matches (3.12)
2. Check environment variables are set correctly
3. Review CI logs for missing dependencies
4. Run tests in a clean venv locally
## Setting Up Continuous Deployment
The CD pipeline is configured but requires GitHub secrets to be set. See the [CD Setup Guide](../docs/03-deployment/CD-SETUP.md) for detailed instructions.
**Quick setup:**
1. Create GCP service account with deployment permissions
2. Download service account key JSON
3. Add GitHub secrets:
- `GCP_SA_KEY` - Full service account key JSON content
- `ADMIN_TOKENS` - Comma-separated admin tokens
Once configured, every push to `replace-modal-with-google-cloud` will automatically deploy to Cloud Run after all tests pass.
## Future Enhancements
- [ ] Add test coverage reporting (coveralls, codecov)
- [x] ✅ Add deployment workflow (deploy to Cloud Run after tests pass)
- [ ] Add frontend tests (when frontend is built)
- [ ] Add performance benchmarking
- [ ] Add security scanning (dependabot, snyk)
- [ ] Migrate to Workload Identity Federation (more secure than service account keys)
-539
View File
@@ -1,539 +0,0 @@
name: CI
on:
push:
pull_request:
branches: [main]
workflow_dispatch:
permissions:
contents: write
pages: write
id-token: write
concurrency:
group: "ci-${{ github.ref }}"
cancel-in-progress: true
jobs:
# ============================================
# PACKAGE TESTS (karaoke-gen Python CLI)
# ============================================
package-unit-tests:
name: "Package - Unit Tests (70% coverage)"
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python 3.13
uses: actions/setup-python@v5
with:
python-version: "3.13"
- name: Install Poetry
uses: snok/install-poetry@v1
with:
virtualenvs-create: true
virtualenvs-in-project: true
- name: Install dependencies
run: poetry install --with dev
- name: Install system dependencies
run: |
sudo apt-get update
sudo apt-get install -y ffmpeg
- name: Install spaCy language models
run: poetry run python -m spacy download en_core_web_sm
- name: Run unit tests
run: |
poetry run pytest tests/unit/ -v --cov=karaoke_gen --cov-report=xml --cov-report=term-missing --cov-fail-under=70
- name: Upload coverage reports
uses: codecov/codecov-action@v5
with:
token: ${{ secrets.CODECOV_TOKEN }}
files: ./coverage.xml
flags: unittests
name: codecov-umbrella
package-integration-tests:
name: "Package - Integration Tests"
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python 3.13
uses: actions/setup-python@v5
with:
python-version: "3.13"
- name: Install Poetry
uses: snok/install-poetry@v1
with:
virtualenvs-create: true
virtualenvs-in-project: true
- name: Install dependencies
run: poetry install --with dev
- name: Install system dependencies
run: |
sudo apt-get update
sudo apt-get install -y ffmpeg
- name: Install spaCy language models
run: poetry run python -m spacy download en_core_web_sm
- name: Run integration tests
run: poetry run pytest tests/integration/ -v
package-build:
name: "Package - Build & Install"
runs-on: ubuntu-latest
needs: [package-unit-tests, package-integration-tests]
steps:
- uses: actions/checkout@v4
- name: Set up Python 3.13
uses: actions/setup-python@v5
with:
python-version: "3.13"
- name: Install Poetry
uses: snok/install-poetry@v1
with:
virtualenvs-create: true
virtualenvs-in-project: true
- 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
python -m karaoke_gen.utils.gen_cli --help
- name: Upload build artifacts
uses: actions/upload-artifact@v4
with:
name: package-dist
path: dist/
retention-days: 1
# ============================================
# BACKEND TESTS (Cloud Run API service)
# ============================================
backend-unit-tests:
name: "Backend - Unit Tests"
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
with:
submodules: false
- name: Set up Python 3.13
uses: actions/setup-python@v5
with:
python-version: "3.13"
- name: Install Poetry
uses: snok/install-poetry@v1
with:
virtualenvs-create: true
virtualenvs-in-project: true
- name: Install dependencies
run: poetry install
- name: Run unit tests
env:
GOOGLE_CLOUD_PROJECT: test-project
GCS_BUCKET_NAME: test-bucket
FIRESTORE_COLLECTION: jobs
ENVIRONMENT: test
run: |
poetry run pytest \
backend/tests/test_models.py \
backend/tests/test_job_manager.py \
backend/tests/test_file_upload.py \
backend/tests/test_services.py \
-v --tb=short
backend-emulator-tests:
name: "Backend - Emulator Integration Tests"
runs-on: ubuntu-latest
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:
submodules: false
- name: Set up Python 3.13
uses: actions/setup-python@v5
with:
python-version: "3.13"
- name: Install Poetry
uses: snok/install-poetry@v1
with:
virtualenvs-create: true
virtualenvs-in-project: true
- 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
- name: Start Docker for GCS emulator
run: docker pull fsouza/fake-gcs-server:latest
- name: Run emulator integration tests
run: |
chmod +x scripts/*.sh
./scripts/run-emulator-tests.sh
- name: Upload test results
if: always()
uses: actions/upload-artifact@v4
with:
name: backend-test-results
path: backend/htmlcov/
retention-days: 7
backend-lint:
name: "Backend - Code Quality"
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
with:
submodules: false
- name: Set up Python 3.13
uses: actions/setup-python@v5
with:
python-version: "3.13"
- name: Install Poetry
uses: snok/install-poetry@v1
with:
virtualenvs-create: true
virtualenvs-in-project: true
- name: Install dependencies
run: poetry install
- name: Run validation (syntax check only)
run: |
poetry run python -m py_compile backend/main.py backend/config.py
echo "✅ Basic syntax validation passed"
# ============================================
# DEPLOYMENTS (main branch only)
# ============================================
package-publish:
name: "Deploy - Publish to PyPI"
runs-on: ubuntu-latest
needs: [package-build]
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
steps:
- uses: actions/checkout@v4
- name: Set up Python 3.13
uses: actions/setup-python@v5
with:
python-version: "3.13"
- name: Install Poetry
uses: snok/install-poetry@v1
- name: Download build artifacts
uses: actions/download-artifact@v4
with:
name: package-dist
path: dist/
- name: Extract version
id: extract_version
run: |
VERSION=$(poetry version --short)
echo "version=$VERSION" >> $GITHUB_OUTPUT
echo "📋 Extracted version: $VERSION"
- name: Check if tag exists
id: check_tag
run: |
VERSION="${{ steps.extract_version.outputs.version }}"
if git ls-remote --tags origin | grep -q "refs/tags/v$VERSION$"; then
echo "tag_exists=true" >> $GITHUB_OUTPUT
echo "🏷️ Tag v$VERSION already exists, skipping release"
else
echo "tag_exists=false" >> $GITHUB_OUTPUT
echo "✨ Tag v$VERSION does not exist, proceeding with release"
fi
- name: Publish to PyPI
if: steps.check_tag.outputs.tag_exists == 'false'
run: |
echo "📦 Publishing the following files to PyPI:"
ls -la dist/
echo "🚀 Publishing to PyPI..."
poetry config pypi-token.pypi ${{ secrets.PYPI_API_TOKEN }}
poetry publish
- name: Create Git Tag
if: steps.check_tag.outputs.tag_exists == 'false'
run: |
git config user.name github-actions
git config user.email github-actions@github.com
git tag -a "v${{ steps.extract_version.outputs.version }}" -m "Release v${{ steps.extract_version.outputs.version }}"
git push https://${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }} "v${{ steps.extract_version.outputs.version }}"
- name: Create GitHub Release
if: steps.check_tag.outputs.tag_exists == 'false'
uses: softprops/action-gh-release@v1
with:
tag_name: "v${{ steps.extract_version.outputs.version }}"
name: "v${{ steps.extract_version.outputs.version }}"
body: |
## Changes in v${{ steps.extract_version.outputs.version }}
This release was automatically created from the main branch.
### Installation
```bash
pip install karaoke-gen==${{ steps.extract_version.outputs.version }}
```
### Assets
- Python package published to PyPI
- Frontend deployed to GitHub Pages at gen.nomadkaraoke.com
For detailed changes, see the commit history.
draft: false
prerelease: false
files: |
dist/*.whl
dist/*.tar.gz
deploy-frontend:
name: "Deploy - Frontend (GitHub Pages)"
runs-on: ubuntu-latest
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Prepare frontend files
run: |
echo "📁 Preparing frontend files for deployment..."
mkdir -p _site
cp -r frontend/* _site/
echo "✅ Frontend files copied to _site/"
ls -la _site/
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: "_site"
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
deploy-backend:
name: "Deploy - Backend (Cloud Run)"
runs-on: ubuntu-latest
needs: [backend-unit-tests, backend-emulator-tests, backend-lint]
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
permissions:
contents: read
id-token: write
steps:
- name: Checkout code
uses: actions/checkout@v4
with:
submodules: false
- name: Authenticate to Google Cloud (Workload Identity)
id: auth
uses: google-github-actions/auth@v2
with:
workload_identity_provider: ${{ secrets.GCP_WORKLOAD_IDENTITY_PROVIDER }}
service_account: ${{ secrets.GCP_SERVICE_ACCOUNT }}
- name: Set up Cloud SDK
uses: google-github-actions/setup-gcloud@v2
with:
version: "latest"
- name: Check if base image needs rebuild
id: check-base
run: |
echo "🔍 Checking if base image needs rebuild..."
CURRENT_HASH=$(sha256sum poetry.lock | cut -d' ' -f1)
echo "Current poetry.lock hash: $CURRENT_HASH"
gcloud auth configure-docker us-central1-docker.pkg.dev --quiet
BASE_IMAGE="us-central1-docker.pkg.dev/nomadkaraoke/karaoke-repo/karaoke-backend-base:latest"
EXISTING_HASH=""
if docker pull $BASE_IMAGE 2>/dev/null; then
EXISTING_HASH=$(docker inspect $BASE_IMAGE --format='{{index .Config.Labels "poetry.lock.hash"}}' 2>/dev/null || echo "")
echo "Existing base image hash: $EXISTING_HASH"
else
echo "⚠️ No existing base image found"
fi
if [ "$CURRENT_HASH" != "$EXISTING_HASH" ]; then
echo "🔄 Base image needs rebuild (poetry.lock changed)"
echo "needs_rebuild=true" >> $GITHUB_OUTPUT
else
echo "✅ Base image is up to date"
echo "needs_rebuild=false" >> $GITHUB_OUTPUT
fi
- name: Rebuild base image (if needed)
if: steps.check-base.outputs.needs_rebuild == 'true'
run: |
echo "🏗️ Rebuilding base image with updated dependencies..."
BASE_BUILD_ID=$(gcloud builds submit \
--config=cloudbuild-base.yaml \
--project=nomadkaraoke \
--format='value(id)' \
--async \
.)
echo "Base Build ID: $BASE_BUILD_ID"
echo "Build URL: https://console.cloud.google.com/cloud-build/builds/$BASE_BUILD_ID?project=nomadkaraoke"
echo "Waiting for base image build to complete..."
while true; do
BUILD_STATUS=$(gcloud builds describe $BASE_BUILD_ID --project=nomadkaraoke --format='value(status)')
echo "Base build status: $BUILD_STATUS"
if [ "$BUILD_STATUS" = "SUCCESS" ]; then
echo "✅ Base image build completed successfully"
break
elif [ "$BUILD_STATUS" = "FAILURE" ] || [ "$BUILD_STATUS" = "CANCELLED" ] || [ "$BUILD_STATUS" = "TIMEOUT" ]; then
echo "❌ Base image build failed with status: $BUILD_STATUS"
echo ""
echo "==================== BUILD LOGS ===================="
gcloud logging read "resource.type=build AND resource.labels.build_id=$BASE_BUILD_ID" \
--project=nomadkaraoke \
--format="value(textPayload)" \
--limit=200 \
--order=asc || echo "Failed to retrieve logs from Cloud Logging"
echo "===================================================="
gcloud builds log $BASE_BUILD_ID --project=nomadkaraoke 2>&1 || true
exit 1
fi
sleep 30
done
- name: Trigger Cloud Build
run: |
echo "🚀 Triggering Cloud Build for deployment..."
echo "Commit: ${{ github.sha }}"
BUILD_ID=$(gcloud builds submit \
--config=cloudbuild.yaml \
--project=nomadkaraoke \
--format='value(id)' \
--async \
.)
echo "Build ID: $BUILD_ID"
echo "Build URL: https://console.cloud.google.com/cloud-build/builds/$BUILD_ID?project=nomadkaraoke"
echo "Waiting for build to complete..."
while true; do
BUILD_STATUS=$(gcloud builds describe $BUILD_ID --project=nomadkaraoke --format='value(status)')
echo "Build status: $BUILD_STATUS"
if [ "$BUILD_STATUS" = "SUCCESS" ]; then
echo "✅ Build completed successfully"
break
elif [ "$BUILD_STATUS" = "FAILURE" ] || [ "$BUILD_STATUS" = "CANCELLED" ] || [ "$BUILD_STATUS" = "TIMEOUT" ]; then
echo "❌ Build failed with status: $BUILD_STATUS"
echo ""
echo "==================== BUILD LOGS ===================="
gcloud logging read "resource.type=build AND resource.labels.build_id=$BUILD_ID" \
--project=nomadkaraoke \
--format="value(textPayload)" \
--limit=200 \
--order=asc || echo "Failed to retrieve logs from Cloud Logging"
echo "===================================================="
echo ""
gcloud builds log $BUILD_ID --project=nomadkaraoke 2>&1 || true
exit 1
fi
sleep 30
done
- name: Verify deployment
run: |
SERVICE_URL=$(gcloud run services describe karaoke-backend \
--region us-central1 \
--format 'value(status.url)')
echo "Service URL: $SERVICE_URL"
sleep 10
curl -f "$SERVICE_URL/api/health" || exit 1
echo "✅ Deployment verified - service is healthy"
- name: Summary
if: success()
run: |
echo "🎉 Deployment successful!"
echo "Commit: ${{ github.sha }}"
echo "Branch: ${{ github.ref_name }}"
echo "Run: ${{ github.run_number }}"
+51
View File
@@ -0,0 +1,51 @@
name: Auto-publish
on: [push, workflow_dispatch]
jobs:
# Auto-publish when version is increased
publish-pypi:
# Only publish on `main` branch
if: github.ref == 'refs/heads/main'
runs-on: ubuntu-latest
permissions: # Don't forget permissions
contents: write
steps:
- uses: etils-actions/pypi-auto-publish@v1
with:
pypi-token: ${{ secrets.PYPI_API_TOKEN }}
gh-token: ${{ secrets.GITHUB_TOKEN }}
parse-changelog: false
# build-windows:
# runs-on: windows-latest
# steps:
# - uses: actions/checkout@v2
# - name: Set up Python
# uses: actions/setup-python@v2
# with:
# python-version: '3.9'
# - name: Install dependencies with Poetry
# run: |
# pip install poetry
# poetry install
# - name: Download ffmpeg binary
# run: python platform/download_ffmpeg.py
# - name: Build EXE with PyInstaller
# run: poetry run pyinstaller karaoke-gen.spec
# - name: Upload EXE as Artifact
# uses: actions/upload-artifact@v2
# with:
# name: karaoke-gen-windows
# path: |
# build/
# *.exe
# */*.exe
+3 -49
View File
@@ -5,56 +5,10 @@
*.mp3
# Andrew functional adds
/audio/
/lyrics/
/karaoke/
audio/
lyrics/
karaoke/
tests/outputs
/input
/output/
# Next.js / React Frontend (./frontend)
node_modules/
frontend/node_modules/
frontend/.next/
frontend/out/
frontend/.swc/
frontend/.turbo/
frontend/build/
frontend/dist/
# Next.js specific
frontend/*.tsbuildinfo
frontend/next-env.d.ts
# Environment files (local overrides)
frontend/.env*.local
# Vercel
frontend/.vercel/
# Package manager logs
frontend/npm-debug.log*
frontend/yarn-debug.log*
frontend/yarn-error.log*
frontend/pnpm-debug.log*
frontend/.pnpm-debug.log*
# Testing
frontend/coverage/
# TypeScript
frontend/*.tsbuildinfo
# ESLint
frontend/.eslintcache
# Storybook
frontend/storybook-static/
# PWA files
frontend/**/public/sw.js
frontend/**/public/workbox-*.js
frontend/**/public/swe-worker-*.js
# Byte-compiled / optimized / DLL files
-50
View File
@@ -1,50 +0,0 @@
# [PROJECT_NAME] Constitution
<!-- Example: Spec Constitution, TaskFlow Constitution, etc. -->
## Core Principles
### [PRINCIPLE_1_NAME]
<!-- Example: I. Library-First -->
[PRINCIPLE_1_DESCRIPTION]
<!-- Example: Every feature starts as a standalone library; Libraries must be self-contained, independently testable, documented; Clear purpose required - no organizational-only libraries -->
### [PRINCIPLE_2_NAME]
<!-- Example: II. CLI Interface -->
[PRINCIPLE_2_DESCRIPTION]
<!-- Example: Every library exposes functionality via CLI; Text in/out protocol: stdin/args → stdout, errors → stderr; Support JSON + human-readable formats -->
### [PRINCIPLE_3_NAME]
<!-- Example: III. Test-First (NON-NEGOTIABLE) -->
[PRINCIPLE_3_DESCRIPTION]
<!-- Example: TDD mandatory: Tests written → User approved → Tests fail → Then implement; Red-Green-Refactor cycle strictly enforced -->
### [PRINCIPLE_4_NAME]
<!-- Example: IV. Integration Testing -->
[PRINCIPLE_4_DESCRIPTION]
<!-- Example: Focus areas requiring integration tests: New library contract tests, Contract changes, Inter-service communication, Shared schemas -->
### [PRINCIPLE_5_NAME]
<!-- Example: V. Observability, VI. Versioning & Breaking Changes, VII. Simplicity -->
[PRINCIPLE_5_DESCRIPTION]
<!-- Example: Text I/O ensures debuggability; Structured logging required; Or: MAJOR.MINOR.BUILD format; Or: Start simple, YAGNI principles -->
## [SECTION_2_NAME]
<!-- Example: Additional Constraints, Security Requirements, Performance Standards, etc. -->
[SECTION_2_CONTENT]
<!-- Example: Technology stack requirements, compliance standards, deployment policies, etc. -->
## [SECTION_3_NAME]
<!-- Example: Development Workflow, Review Process, Quality Gates, etc. -->
[SECTION_3_CONTENT]
<!-- Example: Code review requirements, testing gates, deployment approval process, etc. -->
## Governance
<!-- Example: Constitution supersedes all other practices; Amendments require documentation, approval, migration plan -->
[GOVERNANCE_RULES]
<!-- Example: All PRs/reviews must verify compliance; Complexity must be justified; Use [GUIDANCE_FILE] for runtime development guidance -->
**Version**: [CONSTITUTION_VERSION] | **Ratified**: [RATIFICATION_DATE] | **Last Amended**: [LAST_AMENDED_DATE]
<!-- Example: Version: 2.1.1 | Ratified: 2025-06-13 | Last Amended: 2025-07-16 -->
@@ -1,166 +0,0 @@
#!/usr/bin/env bash
# Consolidated prerequisite checking script
#
# This script provides unified prerequisite checking for Spec-Driven Development workflow.
# It replaces the functionality previously spread across multiple scripts.
#
# Usage: ./check-prerequisites.sh [OPTIONS]
#
# OPTIONS:
# --json Output in JSON format
# --require-tasks Require tasks.md to exist (for implementation phase)
# --include-tasks Include tasks.md in AVAILABLE_DOCS list
# --paths-only Only output path variables (no validation)
# --help, -h Show help message
#
# OUTPUTS:
# JSON mode: {"FEATURE_DIR":"...", "AVAILABLE_DOCS":["..."]}
# Text mode: FEATURE_DIR:... \n AVAILABLE_DOCS: \n ✓/✗ file.md
# Paths only: REPO_ROOT: ... \n BRANCH: ... \n FEATURE_DIR: ... etc.
set -e
# Parse command line arguments
JSON_MODE=false
REQUIRE_TASKS=false
INCLUDE_TASKS=false
PATHS_ONLY=false
for arg in "$@"; do
case "$arg" in
--json)
JSON_MODE=true
;;
--require-tasks)
REQUIRE_TASKS=true
;;
--include-tasks)
INCLUDE_TASKS=true
;;
--paths-only)
PATHS_ONLY=true
;;
--help|-h)
cat << 'EOF'
Usage: check-prerequisites.sh [OPTIONS]
Consolidated prerequisite checking for Spec-Driven Development workflow.
OPTIONS:
--json Output in JSON format
--require-tasks Require tasks.md to exist (for implementation phase)
--include-tasks Include tasks.md in AVAILABLE_DOCS list
--paths-only Only output path variables (no prerequisite validation)
--help, -h Show this help message
EXAMPLES:
# Check task prerequisites (plan.md required)
./check-prerequisites.sh --json
# Check implementation prerequisites (plan.md + tasks.md required)
./check-prerequisites.sh --json --require-tasks --include-tasks
# Get feature paths only (no validation)
./check-prerequisites.sh --paths-only
EOF
exit 0
;;
*)
echo "ERROR: Unknown option '$arg'. Use --help for usage information." >&2
exit 1
;;
esac
done
# Source common functions
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
source "$SCRIPT_DIR/common.sh"
# Get feature paths and validate branch
eval $(get_feature_paths)
check_feature_branch "$CURRENT_BRANCH" "$HAS_GIT" || exit 1
# If paths-only mode, output paths and exit (support JSON + paths-only combined)
if $PATHS_ONLY; then
if $JSON_MODE; then
# Minimal JSON paths payload (no validation performed)
printf '{"REPO_ROOT":"%s","BRANCH":"%s","FEATURE_DIR":"%s","FEATURE_SPEC":"%s","IMPL_PLAN":"%s","TASKS":"%s"}\n' \
"$REPO_ROOT" "$CURRENT_BRANCH" "$FEATURE_DIR" "$FEATURE_SPEC" "$IMPL_PLAN" "$TASKS"
else
echo "REPO_ROOT: $REPO_ROOT"
echo "BRANCH: $CURRENT_BRANCH"
echo "FEATURE_DIR: $FEATURE_DIR"
echo "FEATURE_SPEC: $FEATURE_SPEC"
echo "IMPL_PLAN: $IMPL_PLAN"
echo "TASKS: $TASKS"
fi
exit 0
fi
# Validate required directories and files
if [[ ! -d "$FEATURE_DIR" ]]; then
echo "ERROR: Feature directory not found: $FEATURE_DIR" >&2
echo "Run /specify first to create the feature structure." >&2
exit 1
fi
if [[ ! -f "$IMPL_PLAN" ]]; then
echo "ERROR: plan.md not found in $FEATURE_DIR" >&2
echo "Run /plan first to create the implementation plan." >&2
exit 1
fi
# Check for tasks.md if required
if $REQUIRE_TASKS && [[ ! -f "$TASKS" ]]; then
echo "ERROR: tasks.md not found in $FEATURE_DIR" >&2
echo "Run /tasks first to create the task list." >&2
exit 1
fi
# Build list of available documents
docs=()
# Always check these optional docs
[[ -f "$RESEARCH" ]] && docs+=("research.md")
[[ -f "$DATA_MODEL" ]] && docs+=("data-model.md")
# Check contracts directory (only if it exists and has files)
if [[ -d "$CONTRACTS_DIR" ]] && [[ -n "$(ls -A "$CONTRACTS_DIR" 2>/dev/null)" ]]; then
docs+=("contracts/")
fi
[[ -f "$QUICKSTART" ]] && docs+=("quickstart.md")
# Include tasks.md if requested and it exists
if $INCLUDE_TASKS && [[ -f "$TASKS" ]]; then
docs+=("tasks.md")
fi
# Output results
if $JSON_MODE; then
# Build JSON array of documents
if [[ ${#docs[@]} -eq 0 ]]; then
json_docs="[]"
else
json_docs=$(printf '"%s",' "${docs[@]}")
json_docs="[${json_docs%,}]"
fi
printf '{"FEATURE_DIR":"%s","AVAILABLE_DOCS":%s}\n' "$FEATURE_DIR" "$json_docs"
else
# Text output
echo "FEATURE_DIR:$FEATURE_DIR"
echo "AVAILABLE_DOCS:"
# Show status of each potential document
check_file "$RESEARCH" "research.md"
check_file "$DATA_MODEL" "data-model.md"
check_dir "$CONTRACTS_DIR" "contracts/"
check_file "$QUICKSTART" "quickstart.md"
if $INCLUDE_TASKS; then
check_file "$TASKS" "tasks.md"
fi
fi
-113
View File
@@ -1,113 +0,0 @@
#!/usr/bin/env bash
# Common functions and variables for all scripts
# Get repository root, with fallback for non-git repositories
get_repo_root() {
if git rev-parse --show-toplevel >/dev/null 2>&1; then
git rev-parse --show-toplevel
else
# Fall back to script location for non-git repos
local script_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
(cd "$script_dir/../../.." && pwd)
fi
}
# Get current branch, with fallback for non-git repositories
get_current_branch() {
# First check if SPECIFY_FEATURE environment variable is set
if [[ -n "${SPECIFY_FEATURE:-}" ]]; then
echo "$SPECIFY_FEATURE"
return
fi
# Then check git if available
if git rev-parse --abbrev-ref HEAD >/dev/null 2>&1; then
git rev-parse --abbrev-ref HEAD
return
fi
# For non-git repos, try to find the latest feature directory
local repo_root=$(get_repo_root)
local specs_dir="$repo_root/specs"
if [[ -d "$specs_dir" ]]; then
local latest_feature=""
local highest=0
for dir in "$specs_dir"/*; do
if [[ -d "$dir" ]]; then
local dirname=$(basename "$dir")
if [[ "$dirname" =~ ^([0-9]{3})- ]]; then
local number=${BASH_REMATCH[1]}
number=$((10#$number))
if [[ "$number" -gt "$highest" ]]; then
highest=$number
latest_feature=$dirname
fi
fi
fi
done
if [[ -n "$latest_feature" ]]; then
echo "$latest_feature"
return
fi
fi
echo "main" # Final fallback
}
# Check if we have git available
has_git() {
git rev-parse --show-toplevel >/dev/null 2>&1
}
check_feature_branch() {
local branch="$1"
local has_git_repo="$2"
# For non-git repos, we can't enforce branch naming but still provide output
if [[ "$has_git_repo" != "true" ]]; then
echo "[specify] Warning: Git repository not detected; skipped branch validation" >&2
return 0
fi
if [[ ! "$branch" =~ ^[0-9]{3}- ]]; then
echo "ERROR: Not on a feature branch. Current branch: $branch" >&2
echo "Feature branches should be named like: 001-feature-name" >&2
return 1
fi
return 0
}
get_feature_dir() { echo "$1/specs/$2"; }
get_feature_paths() {
local repo_root=$(get_repo_root)
local current_branch=$(get_current_branch)
local has_git_repo="false"
if has_git; then
has_git_repo="true"
fi
local feature_dir=$(get_feature_dir "$repo_root" "$current_branch")
cat <<EOF
REPO_ROOT='$repo_root'
CURRENT_BRANCH='$current_branch'
HAS_GIT='$has_git_repo'
FEATURE_DIR='$feature_dir'
FEATURE_SPEC='$feature_dir/spec.md'
IMPL_PLAN='$feature_dir/plan.md'
TASKS='$feature_dir/tasks.md'
RESEARCH='$feature_dir/research.md'
DATA_MODEL='$feature_dir/data-model.md'
QUICKSTART='$feature_dir/quickstart.md'
CONTRACTS_DIR='$feature_dir/contracts'
EOF
}
check_file() { [[ -f "$1" ]] && echo " ✓ $2" || echo " ✗ $2"; }
check_dir() { [[ -d "$1" && -n $(ls -A "$1" 2>/dev/null) ]] && echo " ✓ $2" || echo " ✗ $2"; }
@@ -1,97 +0,0 @@
#!/usr/bin/env bash
set -e
JSON_MODE=false
ARGS=()
for arg in "$@"; do
case "$arg" in
--json) JSON_MODE=true ;;
--help|-h) echo "Usage: $0 [--json] <feature_description>"; exit 0 ;;
*) ARGS+=("$arg") ;;
esac
done
FEATURE_DESCRIPTION="${ARGS[*]}"
if [ -z "$FEATURE_DESCRIPTION" ]; then
echo "Usage: $0 [--json] <feature_description>" >&2
exit 1
fi
# Function to find the repository root by searching for existing project markers
find_repo_root() {
local dir="$1"
while [ "$dir" != "/" ]; do
if [ -d "$dir/.git" ] || [ -d "$dir/.specify" ]; then
echo "$dir"
return 0
fi
dir="$(dirname "$dir")"
done
return 1
}
# Resolve repository root. Prefer git information when available, but fall back
# to searching for repository markers so the workflow still functions in repositories that
# were initialised with --no-git.
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
if git rev-parse --show-toplevel >/dev/null 2>&1; then
REPO_ROOT=$(git rev-parse --show-toplevel)
HAS_GIT=true
else
REPO_ROOT="$(find_repo_root "$SCRIPT_DIR")"
if [ -z "$REPO_ROOT" ]; then
echo "Error: Could not determine repository root. Please run this script from within the repository." >&2
exit 1
fi
HAS_GIT=false
fi
cd "$REPO_ROOT"
SPECS_DIR="$REPO_ROOT/specs"
mkdir -p "$SPECS_DIR"
HIGHEST=0
if [ -d "$SPECS_DIR" ]; then
for dir in "$SPECS_DIR"/*; do
[ -d "$dir" ] || continue
dirname=$(basename "$dir")
number=$(echo "$dirname" | grep -o '^[0-9]\+' || echo "0")
number=$((10#$number))
if [ "$number" -gt "$HIGHEST" ]; then HIGHEST=$number; fi
done
fi
NEXT=$((HIGHEST + 1))
FEATURE_NUM=$(printf "%03d" "$NEXT")
BRANCH_NAME=$(echo "$FEATURE_DESCRIPTION" | tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9]/-/g' | sed 's/-\+/-/g' | sed 's/^-//' | sed 's/-$//')
WORDS=$(echo "$BRANCH_NAME" | tr '-' '\n' | grep -v '^$' | head -3 | tr '\n' '-' | sed 's/-$//')
BRANCH_NAME="${FEATURE_NUM}-${WORDS}"
if [ "$HAS_GIT" = true ]; then
git checkout -b "$BRANCH_NAME"
else
>&2 echo "[specify] Warning: Git repository not detected; skipped branch creation for $BRANCH_NAME"
fi
FEATURE_DIR="$SPECS_DIR/$BRANCH_NAME"
mkdir -p "$FEATURE_DIR"
TEMPLATE="$REPO_ROOT/.specify/templates/spec-template.md"
SPEC_FILE="$FEATURE_DIR/spec.md"
if [ -f "$TEMPLATE" ]; then cp "$TEMPLATE" "$SPEC_FILE"; else touch "$SPEC_FILE"; fi
# Set the SPECIFY_FEATURE environment variable for the current session
export SPECIFY_FEATURE="$BRANCH_NAME"
if $JSON_MODE; then
printf '{"BRANCH_NAME":"%s","SPEC_FILE":"%s","FEATURE_NUM":"%s"}\n' "$BRANCH_NAME" "$SPEC_FILE" "$FEATURE_NUM"
else
echo "BRANCH_NAME: $BRANCH_NAME"
echo "SPEC_FILE: $SPEC_FILE"
echo "FEATURE_NUM: $FEATURE_NUM"
echo "SPECIFY_FEATURE environment variable set to: $BRANCH_NAME"
fi
-60
View File
@@ -1,60 +0,0 @@
#!/usr/bin/env bash
set -e
# Parse command line arguments
JSON_MODE=false
ARGS=()
for arg in "$@"; do
case "$arg" in
--json)
JSON_MODE=true
;;
--help|-h)
echo "Usage: $0 [--json]"
echo " --json Output results in JSON format"
echo " --help Show this help message"
exit 0
;;
*)
ARGS+=("$arg")
;;
esac
done
# Get script directory and load common functions
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
source "$SCRIPT_DIR/common.sh"
# Get all paths and variables from common functions
eval $(get_feature_paths)
# Check if we're on a proper feature branch (only for git repos)
check_feature_branch "$CURRENT_BRANCH" "$HAS_GIT" || exit 1
# Ensure the feature directory exists
mkdir -p "$FEATURE_DIR"
# Copy plan template if it exists
TEMPLATE="$REPO_ROOT/.specify/templates/plan-template.md"
if [[ -f "$TEMPLATE" ]]; then
cp "$TEMPLATE" "$IMPL_PLAN"
echo "Copied plan template to $IMPL_PLAN"
else
echo "Warning: Plan template not found at $TEMPLATE"
# Create a basic plan file if template doesn't exist
touch "$IMPL_PLAN"
fi
# Output results
if $JSON_MODE; then
printf '{"FEATURE_SPEC":"%s","IMPL_PLAN":"%s","SPECS_DIR":"%s","BRANCH":"%s","HAS_GIT":"%s"}\n' \
"$FEATURE_SPEC" "$IMPL_PLAN" "$FEATURE_DIR" "$CURRENT_BRANCH" "$HAS_GIT"
else
echo "FEATURE_SPEC: $FEATURE_SPEC"
echo "IMPL_PLAN: $IMPL_PLAN"
echo "SPECS_DIR: $FEATURE_DIR"
echo "BRANCH: $CURRENT_BRANCH"
echo "HAS_GIT: $HAS_GIT"
fi
@@ -1,719 +0,0 @@
#!/usr/bin/env bash
# Update agent context files with information from plan.md
#
# This script maintains AI agent context files by parsing feature specifications
# and updating agent-specific configuration files with project information.
#
# MAIN FUNCTIONS:
# 1. Environment Validation
# - Verifies git repository structure and branch information
# - Checks for required plan.md files and templates
# - Validates file permissions and accessibility
#
# 2. Plan Data Extraction
# - Parses plan.md files to extract project metadata
# - Identifies language/version, frameworks, databases, and project types
# - Handles missing or incomplete specification data gracefully
#
# 3. Agent File Management
# - Creates new agent context files from templates when needed
# - Updates existing agent files with new project information
# - Preserves manual additions and custom configurations
# - Supports multiple AI agent formats and directory structures
#
# 4. Content Generation
# - Generates language-specific build/test commands
# - Creates appropriate project directory structures
# - Updates technology stacks and recent changes sections
# - Maintains consistent formatting and timestamps
#
# 5. Multi-Agent Support
# - Handles agent-specific file paths and naming conventions
# - Supports: Claude, Gemini, Copilot, Cursor, Qwen, opencode, Codex, Windsurf
# - Can update single agents or all existing agent files
# - Creates default Claude file if no agent files exist
#
# Usage: ./update-agent-context.sh [agent_type]
# Agent types: claude|gemini|copilot|cursor|qwen|opencode|codex|windsurf
# Leave empty to update all existing agent files
set -e
# Enable strict error handling
set -u
set -o pipefail
#==============================================================================
# Configuration and Global Variables
#==============================================================================
# Get script directory and load common functions
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
source "$SCRIPT_DIR/common.sh"
# Get all paths and variables from common functions
eval $(get_feature_paths)
NEW_PLAN="$IMPL_PLAN" # Alias for compatibility with existing code
AGENT_TYPE="${1:-}"
# Agent-specific file paths
CLAUDE_FILE="$REPO_ROOT/CLAUDE.md"
GEMINI_FILE="$REPO_ROOT/GEMINI.md"
COPILOT_FILE="$REPO_ROOT/.github/copilot-instructions.md"
CURSOR_FILE="$REPO_ROOT/.cursor/rules/specify-rules.mdc"
QWEN_FILE="$REPO_ROOT/QWEN.md"
AGENTS_FILE="$REPO_ROOT/AGENTS.md"
WINDSURF_FILE="$REPO_ROOT/.windsurf/rules/specify-rules.md"
KILOCODE_FILE="$REPO_ROOT/.kilocode/rules/specify-rules.md"
AUGGIE_FILE="$REPO_ROOT/.augment/rules/specify-rules.md"
ROO_FILE="$REPO_ROOT/.roo/rules/specify-rules.md"
# Template file
TEMPLATE_FILE="$REPO_ROOT/.specify/templates/agent-file-template.md"
# Global variables for parsed plan data
NEW_LANG=""
NEW_FRAMEWORK=""
NEW_DB=""
NEW_PROJECT_TYPE=""
#==============================================================================
# Utility Functions
#==============================================================================
log_info() {
echo "INFO: $1"
}
log_success() {
echo "✓ $1"
}
log_error() {
echo "ERROR: $1" >&2
}
log_warning() {
echo "WARNING: $1" >&2
}
# Cleanup function for temporary files
cleanup() {
local exit_code=$?
rm -f /tmp/agent_update_*_$$
rm -f /tmp/manual_additions_$$
exit $exit_code
}
# Set up cleanup trap
trap cleanup EXIT INT TERM
#==============================================================================
# Validation Functions
#==============================================================================
validate_environment() {
# Check if we have a current branch/feature (git or non-git)
if [[ -z "$CURRENT_BRANCH" ]]; then
log_error "Unable to determine current feature"
if [[ "$HAS_GIT" == "true" ]]; then
log_info "Make sure you're on a feature branch"
else
log_info "Set SPECIFY_FEATURE environment variable or create a feature first"
fi
exit 1
fi
# Check if plan.md exists
if [[ ! -f "$NEW_PLAN" ]]; then
log_error "No plan.md found at $NEW_PLAN"
log_info "Make sure you're working on a feature with a corresponding spec directory"
if [[ "$HAS_GIT" != "true" ]]; then
log_info "Use: export SPECIFY_FEATURE=your-feature-name or create a new feature first"
fi
exit 1
fi
# Check if template exists (needed for new files)
if [[ ! -f "$TEMPLATE_FILE" ]]; then
log_warning "Template file not found at $TEMPLATE_FILE"
log_warning "Creating new agent files will fail"
fi
}
#==============================================================================
# Plan Parsing Functions
#==============================================================================
extract_plan_field() {
local field_pattern="$1"
local plan_file="$2"
grep "^\*\*${field_pattern}\*\*: " "$plan_file" 2>/dev/null | \
head -1 | \
sed "s|^\*\*${field_pattern}\*\*: ||" | \
sed 's/^[ \t]*//;s/[ \t]*$//' | \
grep -v "NEEDS CLARIFICATION" | \
grep -v "^N/A$" || echo ""
}
parse_plan_data() {
local plan_file="$1"
if [[ ! -f "$plan_file" ]]; then
log_error "Plan file not found: $plan_file"
return 1
fi
if [[ ! -r "$plan_file" ]]; then
log_error "Plan file is not readable: $plan_file"
return 1
fi
log_info "Parsing plan data from $plan_file"
NEW_LANG=$(extract_plan_field "Language/Version" "$plan_file")
NEW_FRAMEWORK=$(extract_plan_field "Primary Dependencies" "$plan_file")
NEW_DB=$(extract_plan_field "Storage" "$plan_file")
NEW_PROJECT_TYPE=$(extract_plan_field "Project Type" "$plan_file")
# Log what we found
if [[ -n "$NEW_LANG" ]]; then
log_info "Found language: $NEW_LANG"
else
log_warning "No language information found in plan"
fi
if [[ -n "$NEW_FRAMEWORK" ]]; then
log_info "Found framework: $NEW_FRAMEWORK"
fi
if [[ -n "$NEW_DB" ]] && [[ "$NEW_DB" != "N/A" ]]; then
log_info "Found database: $NEW_DB"
fi
if [[ -n "$NEW_PROJECT_TYPE" ]]; then
log_info "Found project type: $NEW_PROJECT_TYPE"
fi
}
format_technology_stack() {
local lang="$1"
local framework="$2"
local parts=()
# Add non-empty parts
[[ -n "$lang" && "$lang" != "NEEDS CLARIFICATION" ]] && parts+=("$lang")
[[ -n "$framework" && "$framework" != "NEEDS CLARIFICATION" && "$framework" != "N/A" ]] && parts+=("$framework")
# Join with proper formatting
if [[ ${#parts[@]} -eq 0 ]]; then
echo ""
elif [[ ${#parts[@]} -eq 1 ]]; then
echo "${parts[0]}"
else
# Join multiple parts with " + "
local result="${parts[0]}"
for ((i=1; i<${#parts[@]}; i++)); do
result="$result + ${parts[i]}"
done
echo "$result"
fi
}
#==============================================================================
# Template and Content Generation Functions
#==============================================================================
get_project_structure() {
local project_type="$1"
if [[ "$project_type" == *"web"* ]]; then
echo "backend/\\nfrontend/\\ntests/"
else
echo "src/\\ntests/"
fi
}
get_commands_for_language() {
local lang="$1"
case "$lang" in
*"Python"*)
echo "cd src && pytest && ruff check ."
;;
*"Rust"*)
echo "cargo test && cargo clippy"
;;
*"JavaScript"*|*"TypeScript"*)
echo "npm test && npm run lint"
;;
*)
echo "# Add commands for $lang"
;;
esac
}
get_language_conventions() {
local lang="$1"
echo "$lang: Follow standard conventions"
}
create_new_agent_file() {
local target_file="$1"
local temp_file="$2"
local project_name="$3"
local current_date="$4"
if [[ ! -f "$TEMPLATE_FILE" ]]; then
log_error "Template not found at $TEMPLATE_FILE"
return 1
fi
if [[ ! -r "$TEMPLATE_FILE" ]]; then
log_error "Template file is not readable: $TEMPLATE_FILE"
return 1
fi
log_info "Creating new agent context file from template..."
if ! cp "$TEMPLATE_FILE" "$temp_file"; then
log_error "Failed to copy template file"
return 1
fi
# Replace template placeholders
local project_structure
project_structure=$(get_project_structure "$NEW_PROJECT_TYPE")
local commands
commands=$(get_commands_for_language "$NEW_LANG")
local language_conventions
language_conventions=$(get_language_conventions "$NEW_LANG")
# Perform substitutions with error checking using safer approach
# Escape special characters for sed by using a different delimiter or escaping
local escaped_lang=$(printf '%s\n' "$NEW_LANG" | sed 's/[\[\.*^$()+{}|]/\\&/g')
local escaped_framework=$(printf '%s\n' "$NEW_FRAMEWORK" | sed 's/[\[\.*^$()+{}|]/\\&/g')
local escaped_branch=$(printf '%s\n' "$CURRENT_BRANCH" | sed 's/[\[\.*^$()+{}|]/\\&/g')
# Build technology stack and recent change strings conditionally
local tech_stack
if [[ -n "$escaped_lang" && -n "$escaped_framework" ]]; then
tech_stack="- $escaped_lang + $escaped_framework ($escaped_branch)"
elif [[ -n "$escaped_lang" ]]; then
tech_stack="- $escaped_lang ($escaped_branch)"
elif [[ -n "$escaped_framework" ]]; then
tech_stack="- $escaped_framework ($escaped_branch)"
else
tech_stack="- ($escaped_branch)"
fi
local recent_change
if [[ -n "$escaped_lang" && -n "$escaped_framework" ]]; then
recent_change="- $escaped_branch: Added $escaped_lang + $escaped_framework"
elif [[ -n "$escaped_lang" ]]; then
recent_change="- $escaped_branch: Added $escaped_lang"
elif [[ -n "$escaped_framework" ]]; then
recent_change="- $escaped_branch: Added $escaped_framework"
else
recent_change="- $escaped_branch: Added"
fi
local substitutions=(
"s|\[PROJECT NAME\]|$project_name|"
"s|\[DATE\]|$current_date|"
"s|\[EXTRACTED FROM ALL PLAN.MD FILES\]|$tech_stack|"
"s|\[ACTUAL STRUCTURE FROM PLANS\]|$project_structure|g"
"s|\[ONLY COMMANDS FOR ACTIVE TECHNOLOGIES\]|$commands|"
"s|\[LANGUAGE-SPECIFIC, ONLY FOR LANGUAGES IN USE\]|$language_conventions|"
"s|\[LAST 3 FEATURES AND WHAT THEY ADDED\]|$recent_change|"
)
for substitution in "${substitutions[@]}"; do
if ! sed -i.bak -e "$substitution" "$temp_file"; then
log_error "Failed to perform substitution: $substitution"
rm -f "$temp_file" "$temp_file.bak"
return 1
fi
done
# Convert \n sequences to actual newlines
newline=$(printf '\n')
sed -i.bak2 "s/\\\\n/${newline}/g" "$temp_file"
# Clean up backup files
rm -f "$temp_file.bak" "$temp_file.bak2"
return 0
}
update_existing_agent_file() {
local target_file="$1"
local current_date="$2"
log_info "Updating existing agent context file..."
# Use a single temporary file for atomic update
local temp_file
temp_file=$(mktemp) || {
log_error "Failed to create temporary file"
return 1
}
# Process the file in one pass
local tech_stack=$(format_technology_stack "$NEW_LANG" "$NEW_FRAMEWORK")
local new_tech_entries=()
local new_change_entry=""
# Prepare new technology entries
if [[ -n "$tech_stack" ]] && ! grep -q "$tech_stack" "$target_file"; then
new_tech_entries+=("- $tech_stack ($CURRENT_BRANCH)")
fi
if [[ -n "$NEW_DB" ]] && [[ "$NEW_DB" != "N/A" ]] && [[ "$NEW_DB" != "NEEDS CLARIFICATION" ]] && ! grep -q "$NEW_DB" "$target_file"; then
new_tech_entries+=("- $NEW_DB ($CURRENT_BRANCH)")
fi
# Prepare new change entry
if [[ -n "$tech_stack" ]]; then
new_change_entry="- $CURRENT_BRANCH: Added $tech_stack"
elif [[ -n "$NEW_DB" ]] && [[ "$NEW_DB" != "N/A" ]] && [[ "$NEW_DB" != "NEEDS CLARIFICATION" ]]; then
new_change_entry="- $CURRENT_BRANCH: Added $NEW_DB"
fi
# Process file line by line
local in_tech_section=false
local in_changes_section=false
local tech_entries_added=false
local changes_entries_added=false
local existing_changes_count=0
while IFS= read -r line || [[ -n "$line" ]]; do
# Handle Active Technologies section
if [[ "$line" == "## Active Technologies" ]]; then
echo "$line" >> "$temp_file"
in_tech_section=true
continue
elif [[ $in_tech_section == true ]] && [[ "$line" =~ ^##[[:space:]] ]]; then
# Add new tech entries before closing the section
if [[ $tech_entries_added == false ]] && [[ ${#new_tech_entries[@]} -gt 0 ]]; then
printf '%s\n' "${new_tech_entries[@]}" >> "$temp_file"
tech_entries_added=true
fi
echo "$line" >> "$temp_file"
in_tech_section=false
continue
elif [[ $in_tech_section == true ]] && [[ -z "$line" ]]; then
# Add new tech entries before empty line in tech section
if [[ $tech_entries_added == false ]] && [[ ${#new_tech_entries[@]} -gt 0 ]]; then
printf '%s\n' "${new_tech_entries[@]}" >> "$temp_file"
tech_entries_added=true
fi
echo "$line" >> "$temp_file"
continue
fi
# Handle Recent Changes section
if [[ "$line" == "## Recent Changes" ]]; then
echo "$line" >> "$temp_file"
# Add new change entry right after the heading
if [[ -n "$new_change_entry" ]]; then
echo "$new_change_entry" >> "$temp_file"
fi
in_changes_section=true
changes_entries_added=true
continue
elif [[ $in_changes_section == true ]] && [[ "$line" =~ ^##[[:space:]] ]]; then
echo "$line" >> "$temp_file"
in_changes_section=false
continue
elif [[ $in_changes_section == true ]] && [[ "$line" == "- "* ]]; then
# Keep only first 2 existing changes
if [[ $existing_changes_count -lt 2 ]]; then
echo "$line" >> "$temp_file"
((existing_changes_count++))
fi
continue
fi
# Update timestamp
if [[ "$line" =~ \*\*Last\ updated\*\*:.*[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9] ]]; then
echo "$line" | sed "s/[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]/$current_date/" >> "$temp_file"
else
echo "$line" >> "$temp_file"
fi
done < "$target_file"
# Post-loop check: if we're still in the Active Technologies section and haven't added new entries
if [[ $in_tech_section == true ]] && [[ $tech_entries_added == false ]] && [[ ${#new_tech_entries[@]} -gt 0 ]]; then
printf '%s\n' "${new_tech_entries[@]}" >> "$temp_file"
fi
# Move temp file to target atomically
if ! mv "$temp_file" "$target_file"; then
log_error "Failed to update target file"
rm -f "$temp_file"
return 1
fi
return 0
}
#==============================================================================
# Main Agent File Update Function
#==============================================================================
update_agent_file() {
local target_file="$1"
local agent_name="$2"
if [[ -z "$target_file" ]] || [[ -z "$agent_name" ]]; then
log_error "update_agent_file requires target_file and agent_name parameters"
return 1
fi
log_info "Updating $agent_name context file: $target_file"
local project_name
project_name=$(basename "$REPO_ROOT")
local current_date
current_date=$(date +%Y-%m-%d)
# Create directory if it doesn't exist
local target_dir
target_dir=$(dirname "$target_file")
if [[ ! -d "$target_dir" ]]; then
if ! mkdir -p "$target_dir"; then
log_error "Failed to create directory: $target_dir"
return 1
fi
fi
if [[ ! -f "$target_file" ]]; then
# Create new file from template
local temp_file
temp_file=$(mktemp) || {
log_error "Failed to create temporary file"
return 1
}
if create_new_agent_file "$target_file" "$temp_file" "$project_name" "$current_date"; then
if mv "$temp_file" "$target_file"; then
log_success "Created new $agent_name context file"
else
log_error "Failed to move temporary file to $target_file"
rm -f "$temp_file"
return 1
fi
else
log_error "Failed to create new agent file"
rm -f "$temp_file"
return 1
fi
else
# Update existing file
if [[ ! -r "$target_file" ]]; then
log_error "Cannot read existing file: $target_file"
return 1
fi
if [[ ! -w "$target_file" ]]; then
log_error "Cannot write to existing file: $target_file"
return 1
fi
if update_existing_agent_file "$target_file" "$current_date"; then
log_success "Updated existing $agent_name context file"
else
log_error "Failed to update existing agent file"
return 1
fi
fi
return 0
}
#==============================================================================
# Agent Selection and Processing
#==============================================================================
update_specific_agent() {
local agent_type="$1"
case "$agent_type" in
claude)
update_agent_file "$CLAUDE_FILE" "Claude Code"
;;
gemini)
update_agent_file "$GEMINI_FILE" "Gemini CLI"
;;
copilot)
update_agent_file "$COPILOT_FILE" "GitHub Copilot"
;;
cursor)
update_agent_file "$CURSOR_FILE" "Cursor IDE"
;;
qwen)
update_agent_file "$QWEN_FILE" "Qwen Code"
;;
opencode)
update_agent_file "$AGENTS_FILE" "opencode"
;;
codex)
update_agent_file "$AGENTS_FILE" "Codex CLI"
;;
windsurf)
update_agent_file "$WINDSURF_FILE" "Windsurf"
;;
kilocode)
update_agent_file "$KILOCODE_FILE" "Kilo Code"
;;
auggie)
update_agent_file "$AUGGIE_FILE" "Auggie CLI"
;;
roo)
update_agent_file "$ROO_FILE" "Roo Code"
;;
*)
log_error "Unknown agent type '$agent_type'"
log_error "Expected: claude|gemini|copilot|cursor|qwen|opencode|codex|windsurf|kilocode|auggie|roo"
exit 1
;;
esac
}
update_all_existing_agents() {
local found_agent=false
# Check each possible agent file and update if it exists
if [[ -f "$CLAUDE_FILE" ]]; then
update_agent_file "$CLAUDE_FILE" "Claude Code"
found_agent=true
fi
if [[ -f "$GEMINI_FILE" ]]; then
update_agent_file "$GEMINI_FILE" "Gemini CLI"
found_agent=true
fi
if [[ -f "$COPILOT_FILE" ]]; then
update_agent_file "$COPILOT_FILE" "GitHub Copilot"
found_agent=true
fi
if [[ -f "$CURSOR_FILE" ]]; then
update_agent_file "$CURSOR_FILE" "Cursor IDE"
found_agent=true
fi
if [[ -f "$QWEN_FILE" ]]; then
update_agent_file "$QWEN_FILE" "Qwen Code"
found_agent=true
fi
if [[ -f "$AGENTS_FILE" ]]; then
update_agent_file "$AGENTS_FILE" "Codex/opencode"
found_agent=true
fi
if [[ -f "$WINDSURF_FILE" ]]; then
update_agent_file "$WINDSURF_FILE" "Windsurf"
found_agent=true
fi
if [[ -f "$KILOCODE_FILE" ]]; then
update_agent_file "$KILOCODE_FILE" "Kilo Code"
found_agent=true
fi
if [[ -f "$AUGGIE_FILE" ]]; then
update_agent_file "$AUGGIE_FILE" "Auggie CLI"
found_agent=true
fi
if [[ -f "$ROO_FILE" ]]; then
update_agent_file "$ROO_FILE" "Roo Code"
found_agent=true
fi
# If no agent files exist, create a default Claude file
if [[ "$found_agent" == false ]]; then
log_info "No existing agent files found, creating default Claude file..."
update_agent_file "$CLAUDE_FILE" "Claude Code"
fi
}
print_summary() {
echo
log_info "Summary of changes:"
if [[ -n "$NEW_LANG" ]]; then
echo " - Added language: $NEW_LANG"
fi
if [[ -n "$NEW_FRAMEWORK" ]]; then
echo " - Added framework: $NEW_FRAMEWORK"
fi
if [[ -n "$NEW_DB" ]] && [[ "$NEW_DB" != "N/A" ]]; then
echo " - Added database: $NEW_DB"
fi
echo
log_info "Usage: $0 [claude|gemini|copilot|cursor|qwen|opencode|codex|windsurf|kilocode|auggie|roo]"
}
#==============================================================================
# Main Execution
#==============================================================================
main() {
# Validate environment before proceeding
validate_environment
log_info "=== Updating agent context files for feature $CURRENT_BRANCH ==="
# Parse the plan file to extract project information
if ! parse_plan_data "$NEW_PLAN"; then
log_error "Failed to parse plan data"
exit 1
fi
# Process based on agent type argument
local success=true
if [[ -z "$AGENT_TYPE" ]]; then
# No specific agent provided - update all existing agent files
log_info "No agent specified, updating all existing agent files..."
if ! update_all_existing_agents; then
success=false
fi
else
# Specific agent provided - update only that agent
log_info "Updating specific agent: $AGENT_TYPE"
if ! update_specific_agent "$AGENT_TYPE"; then
success=false
fi
fi
# Print summary
print_summary
if [[ "$success" == true ]]; then
log_success "Agent context update completed successfully"
exit 0
else
log_error "Agent context update completed with errors"
exit 1
fi
}
# Execute main function if script is run directly
if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
main "$@"
fi
-23
View File
@@ -1,23 +0,0 @@
# [PROJECT NAME] Development Guidelines
Auto-generated from all feature plans. Last updated: [DATE]
## Active Technologies
[EXTRACTED FROM ALL PLAN.MD FILES]
## Project Structure
```
[ACTUAL STRUCTURE FROM PLANS]
```
## Commands
[ONLY COMMANDS FOR ACTIVE TECHNOLOGIES]
## Code Style
[LANGUAGE-SPECIFIC, ONLY FOR LANGUAGES IN USE]
## Recent Changes
[LAST 3 FEATURES AND WHAT THEY ADDED]
<!-- MANUAL ADDITIONS START -->
<!-- MANUAL ADDITIONS END -->
-219
View File
@@ -1,219 +0,0 @@
# Implementation Plan: [FEATURE]
**Branch**: `[###-feature-name]` | **Date**: [DATE] | **Spec**: [link]
**Input**: Feature specification from `/specs/[###-feature-name]/spec.md`
## Execution Flow (/plan command scope)
```
1. Load feature spec from Input path
→ If not found: ERROR "No feature spec at {path}"
2. Fill Technical Context (scan for NEEDS CLARIFICATION)
→ Detect Project Type from file system structure or context (web=frontend+backend, mobile=app+api)
→ Set Structure Decision based on project type
3. Fill the Constitution Check section based on the content of the constitution document.
4. Evaluate Constitution Check section below
→ If violations exist: Document in Complexity Tracking
→ If no justification possible: ERROR "Simplify approach first"
→ Update Progress Tracking: Initial Constitution Check
5. Execute Phase 0 → research.md
→ If NEEDS CLARIFICATION remain: ERROR "Resolve unknowns"
6. Execute Phase 1 → contracts, data-model.md, quickstart.md, agent-specific template file (e.g., `CLAUDE.md` for Claude Code, `.github/copilot-instructions.md` for GitHub Copilot, `GEMINI.md` for Gemini CLI, `QWEN.md` for Qwen Code or `AGENTS.md` for opencode).
7. Re-evaluate Constitution Check section
→ If new violations: Refactor design, return to Phase 1
→ Update Progress Tracking: Post-Design Constitution Check
8. Plan Phase 2 → Describe task generation approach (DO NOT create tasks.md)
9. STOP - Ready for /tasks command
```
**IMPORTANT**: The /plan command STOPS at step 7. Phases 2-4 are executed by other commands:
- Phase 2: /tasks command creates tasks.md
- Phase 3-4: Implementation execution (manual or via tools)
## Summary
[Extract from feature spec: primary requirement + technical approach from research]
## Technical Context
**Language/Version**: [e.g., Python 3.11, Swift 5.9, Rust 1.75 or NEEDS CLARIFICATION]
**Primary Dependencies**: [e.g., FastAPI, UIKit, LLVM or NEEDS CLARIFICATION]
**Storage**: [if applicable, e.g., PostgreSQL, CoreData, files or N/A]
**Testing**: [e.g., pytest, XCTest, cargo test or NEEDS CLARIFICATION]
**Target Platform**: [e.g., Linux server, iOS 15+, WASM or NEEDS CLARIFICATION]
**Project Type**: [single/web/mobile - determines source structure]
**Performance Goals**: [domain-specific, e.g., 1000 req/s, 10k lines/sec, 60 fps or NEEDS CLARIFICATION]
**Constraints**: [domain-specific, e.g., <200ms p95, <100MB memory, offline-capable or NEEDS CLARIFICATION]
**Scale/Scope**: [domain-specific, e.g., 10k users, 1M LOC, 50 screens or NEEDS CLARIFICATION]
## Constitution Check
*GATE: Must pass before Phase 0 research. Re-check after Phase 1 design.*
[Gates determined based on constitution file]
## Project Structure
### Documentation (this feature)
```
specs/[###-feature]/
├── plan.md # This file (/plan command output)
├── research.md # Phase 0 output (/plan command)
├── data-model.md # Phase 1 output (/plan command)
├── quickstart.md # Phase 1 output (/plan command)
├── contracts/ # Phase 1 output (/plan command)
└── tasks.md # Phase 2 output (/tasks command - NOT created by /plan)
```
### Source Code (repository root)
<!--
ACTION REQUIRED: Replace the placeholder tree below with the concrete layout
for this feature. Delete unused options and expand the chosen structure with
real paths (e.g., apps/admin, packages/something). The delivered plan must
not include Option labels.
-->
```
# [REMOVE IF UNUSED] Option 1: Single project (DEFAULT)
src/
├── models/
├── services/
├── cli/
└── lib/
tests/
├── contract/
├── integration/
└── unit/
# [REMOVE IF UNUSED] Option 2: Web application (when "frontend" + "backend" detected)
backend/
├── src/
│ ├── models/
│ ├── services/
│ └── api/
└── tests/
frontend/
├── src/
│ ├── components/
│ ├── pages/
│ └── services/
└── tests/
# [REMOVE IF UNUSED] Option 3: Mobile + API (when "iOS/Android" detected)
api/
└── [same as backend above]
ios/ or android/
└── [platform-specific structure: feature modules, UI flows, platform tests]
```
**Structure Decision**: [Document the selected structure and reference the real
directories captured above]
## Phase 0: Outline & Research
1. **Extract unknowns from Technical Context** above:
- For each NEEDS CLARIFICATION → research task
- For each dependency → best practices task
- For each integration → patterns task
2. **Generate and dispatch research agents**:
```
For each unknown in Technical Context:
Task: "Research {unknown} for {feature context}"
For each technology choice:
Task: "Find best practices for {tech} in {domain}"
```
3. **Consolidate findings** in `research.md` using format:
- Decision: [what was chosen]
- Rationale: [why chosen]
- Alternatives considered: [what else evaluated]
**Output**: research.md with all NEEDS CLARIFICATION resolved
## Phase 1: Design & Contracts
*Prerequisites: research.md complete*
1. **Extract entities from feature spec** → `data-model.md`:
- Entity name, fields, relationships
- Validation rules from requirements
- State transitions if applicable
2. **Generate API contracts** from functional requirements:
- For each user action → endpoint
- Use standard REST/GraphQL patterns
- Output OpenAPI/GraphQL schema to `/contracts/`
3. **Generate contract tests** from contracts:
- One test file per endpoint
- Assert request/response schemas
- Tests must fail (no implementation yet)
4. **Extract test scenarios** from user stories:
- Each story → integration test scenario
- Quickstart test = story validation steps
5. **Update agent file incrementally** (O(1) operation):
- Run `.specify/scripts/bash/update-agent-context.sh cursor`
**IMPORTANT**: Execute it exactly as specified above. Do not add or remove any arguments.
- If exists: Add only NEW tech from current plan
- Preserve manual additions between markers
- Update recent changes (keep last 3)
- Keep under 150 lines for token efficiency
- Output to repository root
**Output**: data-model.md, /contracts/*, failing tests, quickstart.md, agent-specific file
## Phase 2: Task Planning Approach
*This section describes what the /tasks command will do - DO NOT execute during /plan*
**Task Generation Strategy**:
- Load `.specify/templates/tasks-template.md` as base
- Generate tasks from Phase 1 design docs (contracts, data model, quickstart)
- Each contract → contract test task [P]
- Each entity → model creation task [P]
- Each user story → integration test task
- Implementation tasks to make tests pass
**Ordering Strategy**:
- TDD order: Tests before implementation
- Dependency order: Models before services before UI
- Mark [P] for parallel execution (independent files)
**Estimated Output**: 25-30 numbered, ordered tasks in tasks.md
**IMPORTANT**: This phase is executed by the /tasks command, NOT by /plan
## Phase 3+: Future Implementation
*These phases are beyond the scope of the /plan command*
**Phase 3**: Task execution (/tasks command creates tasks.md)
**Phase 4**: Implementation (execute tasks.md following constitutional principles)
**Phase 5**: Validation (run tests, execute quickstart.md, performance validation)
## Complexity Tracking
*Fill ONLY if Constitution Check has violations that must be justified*
| Violation | Why Needed | Simpler Alternative Rejected Because |
|-----------|------------|-------------------------------------|
| [e.g., 4th project] | [current need] | [why 3 projects insufficient] |
| [e.g., Repository pattern] | [specific problem] | [why direct DB access insufficient] |
## Progress Tracking
*This checklist is updated during execution flow*
**Phase Status**:
- [ ] Phase 0: Research complete (/plan command)
- [ ] Phase 1: Design complete (/plan command)
- [ ] Phase 2: Task planning complete (/plan command - describe approach only)
- [ ] Phase 3: Tasks generated (/tasks command)
- [ ] Phase 4: Implementation complete
- [ ] Phase 5: Validation passed
**Gate Status**:
- [ ] Initial Constitution Check: PASS
- [ ] Post-Design Constitution Check: PASS
- [ ] All NEEDS CLARIFICATION resolved
- [ ] Complexity deviations documented
---
*Based on Constitution v2.1.1 - See `/memory/constitution.md`*
-116
View File
@@ -1,116 +0,0 @@
# Feature Specification: [FEATURE NAME]
**Feature Branch**: `[###-feature-name]`
**Created**: [DATE]
**Status**: Draft
**Input**: User description: "$ARGUMENTS"
## Execution Flow (main)
```
1. Parse user description from Input
→ If empty: ERROR "No feature description provided"
2. Extract key concepts from description
→ Identify: actors, actions, data, constraints
3. For each unclear aspect:
→ Mark with [NEEDS CLARIFICATION: specific question]
4. Fill User Scenarios & Testing section
→ If no clear user flow: ERROR "Cannot determine user scenarios"
5. Generate Functional Requirements
→ Each requirement must be testable
→ Mark ambiguous requirements
6. Identify Key Entities (if data involved)
7. Run Review Checklist
→ If any [NEEDS CLARIFICATION]: WARN "Spec has uncertainties"
→ If implementation details found: ERROR "Remove tech details"
8. Return: SUCCESS (spec ready for planning)
```
---
## ⚡ Quick Guidelines
- ✅ Focus on WHAT users need and WHY
- ❌ Avoid HOW to implement (no tech stack, APIs, code structure)
- 👥 Written for business stakeholders, not developers
### Section Requirements
- **Mandatory sections**: Must be completed for every feature
- **Optional sections**: Include only when relevant to the feature
- When a section doesn't apply, remove it entirely (don't leave as "N/A")
### For AI Generation
When creating this spec from a user prompt:
1. **Mark all ambiguities**: Use [NEEDS CLARIFICATION: specific question] for any assumption you'd need to make
2. **Don't guess**: If the prompt doesn't specify something (e.g., "login system" without auth method), mark it
3. **Think like a tester**: Every vague requirement should fail the "testable and unambiguous" checklist item
4. **Common underspecified areas**:
- User types and permissions
- Data retention/deletion policies
- Performance targets and scale
- Error handling behaviors
- Integration requirements
- Security/compliance needs
---
## User Scenarios & Testing *(mandatory)*
### Primary User Story
[Describe the main user journey in plain language]
### Acceptance Scenarios
1. **Given** [initial state], **When** [action], **Then** [expected outcome]
2. **Given** [initial state], **When** [action], **Then** [expected outcome]
### Edge Cases
- What happens when [boundary condition]?
- How does system handle [error scenario]?
## Requirements *(mandatory)*
### Functional Requirements
- **FR-001**: System MUST [specific capability, e.g., "allow users to create accounts"]
- **FR-002**: System MUST [specific capability, e.g., "validate email addresses"]
- **FR-003**: Users MUST be able to [key interaction, e.g., "reset their password"]
- **FR-004**: System MUST [data requirement, e.g., "persist user preferences"]
- **FR-005**: System MUST [behavior, e.g., "log all security events"]
*Example of marking unclear requirements:*
- **FR-006**: System MUST authenticate users via [NEEDS CLARIFICATION: auth method not specified - email/password, SSO, OAuth?]
- **FR-007**: System MUST retain user data for [NEEDS CLARIFICATION: retention period not specified]
### Key Entities *(include if feature involves data)*
- **[Entity 1]**: [What it represents, key attributes without implementation]
- **[Entity 2]**: [What it represents, relationships to other entities]
---
## Review & Acceptance Checklist
*GATE: Automated checks run during main() execution*
### Content Quality
- [ ] No implementation details (languages, frameworks, APIs)
- [ ] Focused on user value and business needs
- [ ] Written for non-technical stakeholders
- [ ] All mandatory sections completed
### Requirement Completeness
- [ ] No [NEEDS CLARIFICATION] markers remain
- [ ] Requirements are testable and unambiguous
- [ ] Success criteria are measurable
- [ ] Scope is clearly bounded
- [ ] Dependencies and assumptions identified
---
## Execution Status
*Updated by main() during processing*
- [ ] User description parsed
- [ ] Key concepts extracted
- [ ] Ambiguities marked
- [ ] User scenarios defined
- [ ] Requirements generated
- [ ] Entities identified
- [ ] Review checklist passed
---
-127
View File
@@ -1,127 +0,0 @@
# Tasks: [FEATURE NAME]
**Input**: Design documents from `/specs/[###-feature-name]/`
**Prerequisites**: plan.md (required), research.md, data-model.md, contracts/
## Execution Flow (main)
```
1. Load plan.md from feature directory
→ If not found: ERROR "No implementation plan found"
→ Extract: tech stack, libraries, structure
2. Load optional design documents:
→ data-model.md: Extract entities → model tasks
→ contracts/: Each file → contract test task
→ research.md: Extract decisions → setup tasks
3. Generate tasks by category:
→ Setup: project init, dependencies, linting
→ Tests: contract tests, integration tests
→ Core: models, services, CLI commands
→ Integration: DB, middleware, logging
→ Polish: unit tests, performance, docs
4. Apply task rules:
→ Different files = mark [P] for parallel
→ Same file = sequential (no [P])
→ Tests before implementation (TDD)
5. Number tasks sequentially (T001, T002...)
6. Generate dependency graph
7. Create parallel execution examples
8. Validate task completeness:
→ All contracts have tests?
→ All entities have models?
→ All endpoints implemented?
9. Return: SUCCESS (tasks ready for execution)
```
## Format: `[ID] [P?] Description`
- **[P]**: Can run in parallel (different files, no dependencies)
- Include exact file paths in descriptions
## Path Conventions
- **Single project**: `src/`, `tests/` at repository root
- **Web app**: `backend/src/`, `frontend/src/`
- **Mobile**: `api/src/`, `ios/src/` or `android/src/`
- Paths shown below assume single project - adjust based on plan.md structure
## Phase 3.1: Setup
- [ ] T001 Create project structure per implementation plan
- [ ] T002 Initialize [language] project with [framework] dependencies
- [ ] T003 [P] Configure linting and formatting tools
## Phase 3.2: Tests First (TDD) ⚠️ MUST COMPLETE BEFORE 3.3
**CRITICAL: These tests MUST be written and MUST FAIL before ANY implementation**
- [ ] T004 [P] Contract test POST /api/users in tests/contract/test_users_post.py
- [ ] T005 [P] Contract test GET /api/users/{id} in tests/contract/test_users_get.py
- [ ] T006 [P] Integration test user registration in tests/integration/test_registration.py
- [ ] T007 [P] Integration test auth flow in tests/integration/test_auth.py
## Phase 3.3: Core Implementation (ONLY after tests are failing)
- [ ] T008 [P] User model in src/models/user.py
- [ ] T009 [P] UserService CRUD in src/services/user_service.py
- [ ] T010 [P] CLI --create-user in src/cli/user_commands.py
- [ ] T011 POST /api/users endpoint
- [ ] T012 GET /api/users/{id} endpoint
- [ ] T013 Input validation
- [ ] T014 Error handling and logging
## Phase 3.4: Integration
- [ ] T015 Connect UserService to DB
- [ ] T016 Auth middleware
- [ ] T017 Request/response logging
- [ ] T018 CORS and security headers
## Phase 3.5: Polish
- [ ] T019 [P] Unit tests for validation in tests/unit/test_validation.py
- [ ] T020 Performance tests (<200ms)
- [ ] T021 [P] Update docs/api.md
- [ ] T022 Remove duplication
- [ ] T023 Run manual-testing.md
## Dependencies
- Tests (T004-T007) before implementation (T008-T014)
- T008 blocks T009, T015
- T016 blocks T018
- Implementation before polish (T019-T023)
## Parallel Example
```
# Launch T004-T007 together:
Task: "Contract test POST /api/users in tests/contract/test_users_post.py"
Task: "Contract test GET /api/users/{id} in tests/contract/test_users_get.py"
Task: "Integration test registration in tests/integration/test_registration.py"
Task: "Integration test auth in tests/integration/test_auth.py"
```
## Notes
- [P] tasks = different files, no dependencies
- Verify tests fail before implementing
- Commit after each task
- Avoid: vague tasks, same file conflicts
## Task Generation Rules
*Applied during main() execution*
1. **From Contracts**:
- Each contract file → contract test task [P]
- Each endpoint → implementation task
2. **From Data Model**:
- Each entity → model creation task [P]
- Relationships → service layer tasks
3. **From User Stories**:
- Each story → integration test [P]
- Quickstart scenarios → validation tasks
4. **Ordering**:
- Setup → Tests → Models → Services → Endpoints → Polish
- Dependencies block parallel execution
## Validation Checklist
*GATE: Checked by main() before returning*
- [ ] All contracts have corresponding tests
- [ ] All entities have model tasks
- [ ] All tests come before implementation
- [ ] Parallel tasks truly independent
- [ ] Each task specifies exact file path
- [ ] No task modifies same file as another [P] task
+64 -489
View File
@@ -1,520 +1,95 @@
# Karaoke Generator 🎶 🎥 🚀
# Karaoke Gen
![PyPI - Version](https://img.shields.io/pypi/v/karaoke-gen)
![Python Version](https://img.shields.io/badge/python-3.10+-blue)
![Tests](https://github.com/nomadkaraoke/karaoke-gen/workflows/Test%20and%20Publish/badge.svg)
![Test Coverage](https://codecov.io/gh/nomadkaraoke/karaoke-gen/branch/main/graph/badge.svg)
Generate karaoke videos with synchronized lyrics. Handles the entire process from downloading audio and lyrics to creating the final video with title screens.
Generate professional karaoke videos with instrumental audio and synchronized lyrics. Available as a **local CLI** (`karaoke-gen`) or **cloud-based CLI** (`karaoke-gen-remote`) that offloads processing to Google Cloud.
## Overview
## ✨ Two Ways to Generate Karaoke
Karaoke Gen is a comprehensive tool for creating high-quality karaoke videos. It automates the entire workflow:
### 1. Local CLI (`karaoke-gen`)
Run all processing locally on your machine. Requires GPU for optimal audio separation performance.
1. **Download** audio and lyrics for a specified song
2. **Separate** audio stems (vocals, instrumental)
3. **Synchronize** lyrics with the audio
4. **Generate** title and end screens
5. **Combine** everything into a polished final video
6. **Organize** and **share** the output files
```bash
karaoke-gen "ABBA" "Waterloo"
```
### 2. Remote CLI (`karaoke-gen-remote`)
Offload all processing to a cloud backend. No GPU required - just authenticate and submit jobs.
```bash
karaoke-gen-remote ./song.flac "ABBA" "Waterloo"
```
Both CLIs produce identical outputs: 4K karaoke videos, CDG+MP3 packages, audio stems, and more.
---
## 🎯 Features
### Core Pipeline
- **Audio Separation**: AI-powered vocal/instrumental separation using MDX and Demucs models
- **Lyrics Transcription**: Word-level timestamps via AudioShake API
- **Lyrics Correction**: Match transcription against online lyrics (Genius, Spotify, Musixmatch)
- **Human Review**: Interactive UI for correcting lyrics before final render
- **Video Rendering**: High-quality 4K karaoke videos with customizable styles
- **Multiple Outputs**: MP4 (4K lossless/lossy, 720p), MKV, CDG+MP3, TXT+MP3
### Distribution Features
- **YouTube Upload**: Automatic upload to your YouTube channel
- **Dropbox Integration**: Organize output in brand-coded folders
- **Google Drive**: Upload to public share folders
- **Discord Notifications**: Webhook notifications on completion
---
## 📦 Installation
## Installation
```bash
pip install karaoke-gen
```
This installs both `karaoke-gen` (local) and `karaoke-gen-remote` (cloud) CLIs.
### Requirements
- Python 3.10+
- FFmpeg
- For local processing: CUDA-capable GPU or Apple Silicon CPU recommended
---
## 🖥️ Local CLI (`karaoke-gen`)
### Basic Usage
## Quick Start
```bash
# Generate from local audio file
karaoke-gen ./song.mp3 "Artist Name" "Song Title"
# Search and download audio automatically
karaoke-gen "Rick Astley" "Never Gonna Give You Up"
# Process from YouTube URL
# Generate a karaoke video from a YouTube URL
karaoke-gen "https://www.youtube.com/watch?v=dQw4w9WgXcQ" "Rick Astley" "Never Gonna Give You Up"
# Or let it search YouTube for you
karaoke-gen "Rick Astley" "Never Gonna Give You Up"
```
### Remote Audio Separation (Optional)
## Workflow Options
Offload just the GPU-intensive audio separation to Modal.com while keeping other processing local:
Karaoke Gen supports different workflow options to fit your needs:
```bash
export AUDIO_SEPARATOR_API_URL="https://USERNAME--audio-separator-api.modal.run"
karaoke-gen "Artist" "Title"
# Run only the preparation phase (download, separate stems, create title screens)
karaoke-gen --prep-only "Rick Astley" "Never Gonna Give You Up"
# Run only the finalisation phase (must be run in a directory prepared by the prep phase)
karaoke-gen --finalise-only
# Skip automatic lyrics transcription/synchronization (for manual syncing)
karaoke-gen --skip-transcription "Rick Astley" "Never Gonna Give You Up"
# Skip audio separation (if you already have instrumental)
karaoke-gen --skip-separation --existing-instrumental="path/to/instrumental.mp3" "Rick Astley" "Never Gonna Give You Up"
```
### Key Options
## Advanced Features
### Audio Processing
```bash
# Custom styling
karaoke-gen --style_params_json="./styles.json" "Artist" "Title"
# Generate CDG and TXT packages
karaoke-gen --enable_cdg --enable_txt "Artist" "Title"
# YouTube upload
karaoke-gen --enable_youtube_upload --youtube_description_file="./desc.txt" "Artist" "Title"
# Full production run
karaoke-gen \
--style_params_json="./branding.json" \
--enable_cdg \
--enable_txt \
--brand_prefix="BRAND" \
--enable_youtube_upload \
--youtube_description_file="./description.txt" \
"Artist" "Title"
# Specify custom audio separation models
karaoke-gen --clean_instrumental_model="model_name.ckpt" "Rick Astley" "Never Gonna Give You Up"
```
### Full Options Reference
### Lyrics Handling
```bash
# Use a local lyrics file instead of fetching from online
karaoke-gen --lyrics_file="path/to/lyrics.txt" "Rick Astley" "Never Gonna Give You Up"
# Adjust subtitle timing
karaoke-gen --subtitle_offset_ms=500 "Rick Astley" "Never Gonna Give You Up"
```
### Finalisation Options
```bash
# Enable CDG ZIP generation
karaoke-gen --enable_cdg --style_params_json="path/to/style.json" "Rick Astley" "Never Gonna Give You Up"
# Enable TXT ZIP generation
karaoke-gen --enable_txt "Rick Astley" "Never Gonna Give You Up"
# Upload to YouTube
karaoke-gen --youtube_client_secrets_file="path/to/client_secret.json" --youtube_description_file="path/to/description.txt" "Rick Astley" "Never Gonna Give You Up"
# Organize files with brand code
karaoke-gen --brand_prefix="BRAND" --organised_dir="path/to/Tracks-Organized" "Rick Astley" "Never Gonna Give You Up"
```
## Full Command Reference
For a complete list of options:
```bash
karaoke-gen --help
```
---
## ☁️ Remote CLI (`karaoke-gen-remote`)
The remote CLI submits jobs to a Google Cloud backend that handles all processing. You don't need a GPU or any audio processing libraries installed locally.
### Setup
1. **Set the backend URL:**
```bash
export KARAOKE_GEN_URL="https://api.nomadkaraoke.com" # Or your own backend
```
2. **Authenticate with Google Cloud:**
```bash
gcloud auth login
```
### Basic Usage
```bash
# Submit a job
karaoke-gen-remote ./song.flac "ABBA" "Waterloo"
# The CLI will:
# 1. Upload your audio file
# 2. Monitor processing progress
# 3. Open lyrics review UI when ready
# 4. Prompt for instrumental selection
# 5. Download all outputs when complete
```
### Job Management
```bash
# List all jobs
karaoke-gen-remote --list
# Resume monitoring an existing job
karaoke-gen-remote --resume abc12345
# Cancel a running job
karaoke-gen-remote --cancel abc12345
# Delete a job and its files
karaoke-gen-remote --delete abc12345
```
### Full Production Run
```bash
karaoke-gen-remote \
--style_params_json="./karaoke-styles.json" \
--enable_cdg \
--enable_txt \
--brand_prefix=NOMAD \
--enable_youtube_upload \
--youtube_description_file="./youtube-description.txt" \
./song.flac "Artist" "Title"
```
### Environment Variables
| Variable | Description | Default |
|----------|-------------|---------|
| `KARAOKE_GEN_URL` | Backend service URL | Required |
| `KARAOKE_GEN_AUTH_TOKEN` | Admin auth token (for protected endpoints) | Optional |
| `REVIEW_UI_URL` | Lyrics review UI URL | `https://lyrics.nomadkaraoke.com` |
| `POLL_INTERVAL` | Seconds between status polls | `5` |
### Authentication
The backend uses token-based authentication for admin operations (bulk delete, internal worker triggers). For basic job submission and monitoring, authentication is optional.
**For admin access:**
```bash
export KARAOKE_GEN_AUTH_TOKEN="your-admin-token"
```
The token must match one of the tokens configured in the backend's `ADMIN_TOKENS` environment variable.
### Non-Interactive Mode
For automated/CI usage:
```bash
karaoke-gen-remote -y ./song.flac "Artist" "Title"
```
The `-y` flag auto-accepts default corrections and selects clean instrumental.
---
## 🎨 Style Configuration
Create a `styles.json` file to customize the karaoke video appearance:
```json
{
"intro": {
"video_duration": 5,
"background_image": "/path/to/title-background.png",
"font": "/path/to/Font.ttf",
"artist_color": "#ffdf6b",
"title_color": "#ffffff"
},
"karaoke": {
"background_image": "/path/to/karaoke-background.png",
"font_path": "/path/to/Font.ttf"
},
"end": {
"background_image": "/path/to/end-background.png"
},
"cdg": {
"font_path": "/path/to/Font.ttf",
"instrumental_background": "/path/to/cdg-background.png"
}
}
```
When using `karaoke-gen-remote`, all referenced files are automatically uploaded with your job.
---
## 📤 Output Files
A completed job produces:
```
BRAND-1234 - Artist - Title/
├── Artist - Title (Final Karaoke Lossless 4k).mp4 # ProRes 4K
├── Artist - Title (Final Karaoke Lossless 4k).mkv # FLAC audio 4K
├── Artist - Title (Final Karaoke Lossy 4k).mp4 # H.264 4K
├── Artist - Title (Final Karaoke Lossy 720p).mp4 # H.264 720p
├── Artist - Title (Final Karaoke CDG).zip # CDG+MP3 package
├── Artist - Title (Final Karaoke TXT).zip # TXT+MP3 package
├── Artist - Title (Karaoke).cdg # Individual CDG
├── Artist - Title (Karaoke).mp3 # Karaoke audio
├── Artist - Title (Karaoke).lrc # LRC lyrics
├── Artist - Title (Karaoke).ass # ASS subtitles
├── Artist - Title (Title).mov # Title screen video
├── Artist - Title (End).mov # End screen video
├── Artist - Title (Instrumental...).flac # Clean instrumental
├── Artist - Title (Instrumental +BV...).flac # With backing vocals
└── stems/ # All audio stems
├── ...Vocals....flac
├── ...Bass....flac
├── ...Drums....flac
└── ...
```
---
## 🏗️ Deploy Your Own Backend
The cloud backend runs on Google Cloud Platform using:
- **Cloud Run**: Serverless API hosting
- **Firestore**: Job state management
- **Cloud Storage**: File uploads and outputs
- **Modal.com**: GPU-accelerated audio separation
- **AudioShake**: Lyrics transcription API
### Prerequisites
- Google Cloud account with billing enabled
- [Pulumi CLI](https://www.pulumi.com/docs/install/)
- Modal.com account (for audio separation)
- AudioShake API key
### Infrastructure Setup
```bash
cd infrastructure
# Install dependencies
pip install -r requirements.txt
# Login to Pulumi
pulumi login
# Create a stack
pulumi stack init prod
# Configure GCP project
pulumi config set gcp:project your-project-id
pulumi config set gcp:region us-central1
# Deploy infrastructure
pulumi up
```
This creates:
- Firestore database
- Cloud Storage bucket
- Artifact Registry
- Service account with IAM roles
- Secret Manager secrets (you add values)
### Add Secret Values
```bash
# AudioShake API key
echo -n "your-audioshake-key" | gcloud secrets versions add audioshake-api-key --data-file=-
# Genius API key
echo -n "your-genius-key" | gcloud secrets versions add genius-api-key --data-file=-
# Modal API URL
echo -n "https://your-modal-url" | gcloud secrets versions add audio-separator-api-url --data-file=-
# YouTube OAuth credentials (JSON)
gcloud secrets versions add youtube-oauth-credentials --data-file=./youtube-creds.json
# Dropbox OAuth credentials (JSON)
gcloud secrets versions add dropbox-oauth-credentials --data-file=./dropbox-creds.json
# Google Drive service account (JSON)
gcloud secrets versions add gdrive-service-account --data-file=./gdrive-sa.json
```
### Deploy Cloud Run
```bash
# Build and deploy
gcloud builds submit --config=cloudbuild.yaml
# Get outputs from Pulumi
SA_EMAIL=$(pulumi stack output service_account_email)
BUCKET_NAME=$(pulumi stack output bucket_name)
# Deploy Cloud Run service
gcloud run deploy karaoke-backend \
--image us-central1-docker.pkg.dev/YOUR-PROJECT/karaoke-repo/karaoke-backend:latest \
--platform managed \
--region us-central1 \
--allow-unauthenticated \
--service-account $SA_EMAIL \
--memory 2Gi \
--cpu 2 \
--timeout 600 \
--set-env-vars="GOOGLE_CLOUD_PROJECT=YOUR-PROJECT,GCS_BUCKET_NAME=$BUCKET_NAME"
```
### Point CLI to Your Backend
```bash
export KARAOKE_GEN_URL="https://your-backend.run.app"
karaoke-gen-remote ./song.flac "Artist" "Title"
```
---
## 🔌 Backend API Reference
The backend exposes a REST API for job management.
### Job Submission
**POST** `/api/jobs/upload`
Submit a new karaoke generation job with audio file and options.
```bash
curl -X POST "https://api.example.com/api/jobs/upload" \
-F "file=@song.flac" \
-F "artist=ABBA" \
-F "title=Waterloo" \
-F "enable_cdg=true" \
-F "enable_txt=true" \
-F "brand_prefix=NOMAD" \
-F "style_params=@styles.json" \
-F "style_karaoke_background=@background.png"
```
### Job Status
**GET** `/api/jobs/{job_id}`
Get job status and details.
```bash
curl "https://api.example.com/api/jobs/abc12345"
```
### List Jobs
**GET** `/api/jobs`
List all jobs with optional status filter.
```bash
curl "https://api.example.com/api/jobs?status=complete&limit=10"
```
### Cancel Job
**POST** `/api/jobs/{job_id}/cancel`
Cancel a running job.
```bash
curl -X POST "https://api.example.com/api/jobs/abc12345/cancel" \
-H "Content-Type: application/json" \
-d '{"reason": "User cancelled"}'
```
### Delete Job
**DELETE** `/api/jobs/{job_id}`
Delete a job and its files.
```bash
curl -X DELETE "https://api.example.com/api/jobs/abc12345?delete_files=true"
```
### Lyrics Review
**GET** `/api/review/{job_id}/correction-data`
Get correction data for lyrics review.
**POST** `/api/review/{job_id}/complete`
Submit corrected lyrics and trigger video rendering.
### Instrumental Selection
**GET** `/api/jobs/{job_id}/instrumental-options`
Get available instrumental options.
**POST** `/api/jobs/{job_id}/select-instrumental`
Submit instrumental selection (clean or with_backing).
```bash
curl -X POST "https://api.example.com/api/jobs/abc12345/select-instrumental" \
-H "Content-Type: application/json" \
-d '{"selection": "clean"}'
```
### Download Files
**GET** `/api/jobs/{job_id}/download-urls`
Get download URLs for all output files.
**GET** `/api/jobs/{job_id}/download/{category}/{file_key}`
Stream download a specific file.
### Health Check
**GET** `/api/health`
Check backend health status.
---
## 🧪 Development
### Running Tests
```bash
# Run all tests
pytest tests/ backend/tests/ -v
# Run only unit tests
pytest tests/unit/ -v
# Run with coverage
pytest tests/unit/ -v --cov=karaoke_gen --cov-report=term-missing
```
### Project Structure
```
karaoke-gen/
├── karaoke_gen/ # Core CLI package
│ ├── utils/
│ │ ├── gen_cli.py # Local CLI (karaoke-gen)
│ │ └── remote_cli.py # Remote CLI (karaoke-gen-remote)
│ ├── karaoke_finalise/ # Video encoding, packaging, distribution
│ └── style_loader.py # Unified style configuration
├── backend/ # Cloud backend (FastAPI)
│ ├── api/routes/ # API endpoints
│ ├── workers/ # Background processing workers
│ └── services/ # Business logic services
├── infrastructure/ # Pulumi IaC for GCP
├── docs/ # Documentation
└── tests/ # Test suite
```
---
## 📄 License
## License
MIT
---
## 🤝 Contributing
Contributions are welcome! Please see our contributing guidelines.
-20
View File
@@ -1,20 +0,0 @@
[run]
source = backend
omit =
backend/tests/*
backend/validate.py
backend/tests/emulator/*
# Workers that require external APIs are tested via integration tests
backend/workers/screens_worker.py
backend/workers/video_worker.py
[report]
exclude_lines =
pragma: no cover
def __repr__
raise NotImplementedError
if __name__ == .__main__.:
pass
show_missing = True
-37
View File
@@ -1,37 +0,0 @@
# Ignore Python cache and virtual environments
__pycache__/
*.py[cod]
*$py.class
*.so
.Python
env/
venv/
ENV/
env.bak/
venv.bak/
# Environment files
.env
.env.local
# IDE
.vscode/
.idea/
*.swp
*.swo
*~
# Temporary files
*.log
temp/
tmp/
# Google Cloud
.gcloud/
*.json
# Testing
.pytest_cache/
.coverage
htmlcov/
-38
View File
@@ -1,38 +0,0 @@
# Fast application image - uses pre-built base with all dependencies
#
# The base image (karaoke-backend-base) contains:
# - Python 3.11, ffmpeg, sox, system deps
# - All pip dependencies from requirements-frozen.txt (NO code)
#
# This Dockerfile adds the actual application code on top.
# Build time: ~1-2 minutes (deps already cached in base)
#
# If the base image doesn't exist yet, build it first:
# gcloud builds submit --config=cloudbuild-base.yaml --project=nomadkaraoke
# Use pre-built base image with all dependencies
FROM us-central1-docker.pkg.dev/nomadkaraoke/karaoke-repo/karaoke-backend-base:latest
# Set working directory (should already exist from base)
WORKDIR /app
# Copy backend code (this is the only thing that changes frequently)
COPY backend /app/backend
# Copy and reinstall karaoke_gen from local source
# This ensures new modules (like style_loader.py) are included without rebuilding base image
# Note: lyrics_transcriber is vendored in lyrics_transcriber_temp/ and bundled via pyproject.toml
COPY karaoke_gen /app/karaoke_gen
COPY lyrics_transcriber_temp /app/lyrics_transcriber_temp
COPY pyproject.toml README.md LICENSE /app/
RUN pip install --no-cache-dir -e .
# Set environment variables
ENV PYTHONUNBUFFERED=1
ENV PORT=8080
# Expose port
EXPOSE 8080
# Run the application
CMD ["uvicorn", "backend.main:app", "--host", "0.0.0.0", "--port", "8080"]
-42
View File
@@ -1,42 +0,0 @@
# Base image with all Python dependencies pre-installed
# This image is rebuilt only when poetry.lock changes
#
# Build with: gcloud builds submit --config=cloudbuild-base.yaml
# Or manually: docker build -f backend/Dockerfile.base -t karaoke-backend-base .
FROM python:3.11-slim
# Install system dependencies required by karaoke-gen
RUN apt-get update && apt-get install -y \
ffmpeg \
libsndfile1 \
libsox-dev \
sox \
build-essential \
&& rm -rf /var/lib/apt/lists/*
# Set working directory
WORKDIR /app
# Copy dependency files and source code needed for pip install
COPY pyproject.toml README.md LICENSE /app/
COPY karaoke_gen /app/karaoke_gen
COPY lyrics_transcriber_temp /app/lyrics_transcriber_temp
# Install all Python dependencies (the slow part - cached in base image)
RUN pip install --no-cache-dir --upgrade pip && \
pip install --no-cache-dir -e .
# Download spaCy language model for lyrics transcription
# This must be done at build time, not runtime (Cloud Run network restrictions)
RUN python -m spacy download en_core_web_sm
# Label with build info
ARG BUILD_DATE
ARG BUILD_ID
ARG POETRY_LOCK_HASH
LABEL org.opencontainers.image.created="${BUILD_DATE}"
LABEL org.opencontainers.image.revision="${BUILD_ID}"
LABEL org.opencontainers.image.title="karaoke-backend-base"
LABEL org.opencontainers.image.description="Base image with Python dependencies for karaoke-backend"
LABEL poetry.lock.hash="${POETRY_LOCK_HASH}"
-242
View File
@@ -1,242 +0,0 @@
# Backend Development Setup
## One-Time Setup
### 1. Create Virtual Environment
```bash
cd /Users/andrew/Projects/karaoke-gen
python3 -m venv backend/venv
```
### 2. Activate Virtual Environment
```bash
source backend/venv/bin/activate
```
### 3. Install Dependencies
**IMPORTANT:** Use Python 3.12 (not 3.13/3.14 - pydantic has compatibility issues)
```bash
# Backend dependencies
pip install -r backend/requirements.txt
# Install karaoke_gen in development mode
pip install -e .
# Install lyrics_transcriber submodule
pip install -e lyrics_transcriber_local/
# Install Google API client (for YouTube upload)
pip install google-api-python-client google-auth-httplib2 google-auth-oauthlib
```
### 4. Add Shell Alias (Optional)
Add to `~/.zshrc`:
```bash
alias backend='cd /Users/andrew/Projects/karaoke-gen && source backend/venv/bin/activate'
```
Then you can just run:
```bash
backend
# Now you're in the project directory with venv activated!
```
---
## Daily Workflow
### Before Making Changes
```bash
# Activate venv
source backend/venv/bin/activate
# Or if you set up the alias:
backend
```
### After Making Changes
```bash
# 1. Run full validation (catches import errors!)
python3 backend/validate.py
# 2. If validation passes, deploy
./scripts/deploy.sh
```
---
## Validation Options
### Full Validation (Recommended - Requires venv)
```bash
source backend/venv/bin/activate
python3 backend/validate.py
```
**Catches:**
- ✅ Syntax errors
- ✅ **Import errors** (like the processing_service issue!)
- ✅ Configuration issues
- ✅ FastAPI app creation problems
- ✅ Missing dependencies
**This would have caught the ModuleNotFoundError!**
### Quick Check (No venv needed)
```bash
./backend/quick-check.sh
```
**Catches:**
- ✅ Syntax errors
- ✅ Missing files
- ✅ Some obvious import issues
**Good for quick checks, but won't catch all import errors**
---
## Example: Complete Development Session
```bash
# 1. Activate environment
backend # or: source backend/venv/bin/activate
# 2. Make your changes
vim backend/api/routes/jobs.py
# 3. Validate (catches import errors!)
python3 backend/validate.py
# ✅ All validations passed!
# 4. Deploy
./scripts/deploy.sh
# 5. Test
export BACKEND_URL="https://karaoke-backend-ipzqd2k4yq-uc.a.run.app"
export AUTH_TOKEN=$(gcloud auth print-identity-token)
curl -H "Authorization: Bearer $AUTH_TOKEN" $BACKEND_URL/api/health
```
---
## What About karaoke_gen Imports?
The backend imports from `karaoke_gen` (the CLI package):
```python
from karaoke_gen.karaoke_gen import KaraokePrep
from karaoke_gen.audio_processor import AudioProcessor
```
**Options:**
### Option 1: Install in development mode (Recommended)
```bash
source backend/venv/bin/activate
pip install -e .
```
This makes `karaoke_gen` available in the venv without copying files.
### Option 2: Use system Python
Your system Python already has `karaoke_gen` installed, so validation will work even if the venv doesn't have it (Python will fall back to system packages).
---
## Running the Backend Locally
```bash
# Activate venv
source backend/venv/bin/activate
# Set required environment variables
export GOOGLE_CLOUD_PROJECT="nomadkaraoke"
export GCS_BUCKET_NAME="karaoke-gen-storage-nomadkaraoke"
# Optional: Point to local credentials
export GOOGLE_APPLICATION_CREDENTIALS="/path/to/service-account-key.json"
# Run the server
cd backend
uvicorn main:app --reload --port 8080
```
Visit: http://localhost:8080/api/health
---
## Troubleshooting
### "No module named 'fastapi'"
**Fix:**
```bash
source backend/venv/bin/activate
pip install -r backend/requirements.txt
```
### "No module named 'karaoke_gen'"
**Fix:**
```bash
source backend/venv/bin/activate
cd /Users/andrew/Projects/karaoke-gen
pip install -e .
```
### Validation passes locally but fails in Cloud Run
**Check:**
1. Is `requirements.txt` up to date?
2. Did you add a new dependency without adding it to `requirements.txt`?
3. Run: `pip freeze | grep <package-name>`
---
## Updating Dependencies
When you add new packages:
```bash
# 1. Install in venv
source backend/venv/bin/activate
pip install new-package
# 2. Update requirements.txt
pip freeze > backend/requirements.txt
# 3. Or manually add just the new package:
echo "new-package==1.2.3" >> backend/requirements.txt
# 4. Validate
python3 backend/validate.py
# 5. Deploy
./scripts/deploy.sh
```
---
## Summary
**Best practice workflow:**
1. **One-time setup:** Create venv and install dependencies
2. **Daily:** Activate venv when working on backend
3. **Before deploy:** Run `python3 backend/validate.py` (catches import errors!)
4. **Deploy:** Use `./scripts/deploy.sh`
**The import error would have been caught if you ran validation in a venv!** ✅
View File
Whitespace-only changes.
View File
Whitespace-only changes.
-138
View File
@@ -1,138 +0,0 @@
"""
FastAPI dependencies for authentication and authorization.
"""
import logging
from typing import Optional, Tuple
from fastapi import Depends, HTTPException, Header, Query, Request
from fastapi.security import HTTPBearer, HTTPAuthorizationCredentials
from backend.services.auth_service import get_auth_service, UserType, AuthService
logger = logging.getLogger(__name__)
# HTTP Bearer security scheme (Authorization: Bearer <token>)
security = HTTPBearer(auto_error=False)
async def get_token_from_request(
request: Request,
credentials: Optional[HTTPAuthorizationCredentials] = Depends(security),
token: Optional[str] = Query(None, description="Access token (alternative to Bearer header)")
) -> Optional[str]:
"""
Extract access token from request.
Supports two methods:
1. Authorization header: Authorization: Bearer <token>
2. Query parameter: ?token=<token> (for download links)
Returns:
Token string or None
"""
# Try Authorization header first
if credentials:
return credentials.credentials
# Try query parameter
if token:
return token
return None
async def require_auth(
request: Request,
auth_service: AuthService = Depends(get_auth_service),
credentials: Optional[HTTPAuthorizationCredentials] = Depends(security),
token: Optional[str] = Query(None)
) -> Tuple[str, UserType, int]:
"""
Require authentication for an endpoint.
Returns:
(token, user_type, remaining_uses)
Raises:
HTTPException: 401 if authentication fails
"""
# Get token from request
token_str = await get_token_from_request(request, credentials, token)
if not token_str:
raise HTTPException(
status_code=401,
detail="Authentication required. Provide token via Authorization header or ?token= parameter"
)
# Validate token
is_valid, user_type, remaining_uses, message = auth_service.validate_token(token_str)
if not is_valid:
logger.warning(f"Authentication failed: {message}")
raise HTTPException(
status_code=401,
detail=f"Authentication failed: {message}"
)
logger.info(f"Authenticated as {user_type} (remaining: {remaining_uses})")
return token_str, user_type, remaining_uses
async def require_admin(
auth_data: Tuple[str, UserType, int] = Depends(require_auth)
) -> Tuple[str, UserType, int]:
"""
Require admin access for an endpoint.
Returns:
(token, user_type, remaining_uses)
Raises:
HTTPException: 403 if user is not admin
"""
token, user_type, remaining_uses = auth_data
if user_type != UserType.ADMIN:
logger.warning(f"Admin access denied for {user_type} user")
raise HTTPException(
status_code=403,
detail="Admin access required"
)
return token, user_type, remaining_uses
def optional_auth(
auth_service: AuthService = Depends(get_auth_service),
credentials: Optional[HTTPAuthorizationCredentials] = Depends(security),
token: Optional[str] = Query(None)
) -> Optional[Tuple[str, UserType, int]]:
"""
Optional authentication - doesn't fail if no token provided.
Useful for endpoints that have different behavior for authenticated users.
Returns:
(token, user_type, remaining_uses) if authenticated, None otherwise
"""
# Get token
token_str = None
if credentials:
token_str = credentials.credentials
elif token:
token_str = token
if not token_str:
return None
# Validate token
is_valid, user_type, remaining_uses, message = auth_service.validate_token(token_str)
if not is_valid:
logger.debug(f"Optional auth failed: {message}")
return None
return token_str, user_type, remaining_uses
View File
Whitespace-only changes.
-543
View File
@@ -1,543 +0,0 @@
"""
Audio search API routes for artist+title search mode.
This module provides endpoints for:
1. Creating a job with audio search (artist+title without file)
2. Getting search results for a job
3. Selecting an audio source to download
The flow is:
1. POST /api/audio-search/search - Create job and search for audio
2. GET /api/audio-search/{job_id}/results - Get search results
3. POST /api/audio-search/{job_id}/select - Select audio source
"""
import asyncio
import logging
import os
import tempfile
from typing import Optional, List, Dict, Any
from fastapi import APIRouter, HTTPException, BackgroundTasks, Request
from pydantic import BaseModel, Field
from backend.models.job import JobCreate, JobStatus
from backend.services.job_manager import JobManager
from backend.services.storage_service import StorageService
from backend.services.worker_service import get_worker_service
from backend.services.credential_manager import get_credential_manager, CredentialStatus
from backend.services.audio_search_service import (
get_audio_search_service,
AudioSearchResult,
AudioSearchError,
NoResultsError,
DownloadError,
)
from backend.config import get_settings
from backend.version import VERSION
logger = logging.getLogger(__name__)
router = APIRouter(tags=["audio-search"])
# Initialize services
job_manager = JobManager()
storage_service = StorageService()
worker_service = get_worker_service()
# ============================================================================
# Pydantic models
# ============================================================================
class AudioSearchRequest(BaseModel):
"""Request to search for audio by artist and title."""
artist: str = Field(..., description="Artist name to search for")
title: str = Field(..., description="Song title to search for")
# Auto-download mode
auto_download: bool = Field(False, description="Automatically select best result and download")
# Processing options
enable_cdg: bool = Field(True, description="Generate CDG+MP3 package")
enable_txt: bool = Field(True, description="Generate TXT+MP3 package")
# Finalisation options
brand_prefix: Optional[str] = Field(None, description="Brand code prefix (e.g., NOMAD)")
enable_youtube_upload: bool = Field(False, description="Upload to YouTube")
youtube_description: Optional[str] = Field(None, description="YouTube video description text")
discord_webhook_url: Optional[str] = Field(None, description="Discord webhook URL for notifications")
# Distribution options
dropbox_path: Optional[str] = Field(None, description="Dropbox folder path for organized output")
gdrive_folder_id: Optional[str] = Field(None, description="Google Drive folder ID for public share uploads")
# Lyrics configuration
lyrics_artist: Optional[str] = Field(None, description="Override artist name for lyrics search")
lyrics_title: Optional[str] = Field(None, description="Override title for lyrics search")
subtitle_offset_ms: int = Field(0, description="Subtitle timing offset in milliseconds")
# Audio separation model configuration
clean_instrumental_model: Optional[str] = Field(None, description="Model for clean instrumental separation")
backing_vocals_models: Optional[List[str]] = Field(None, description="Models for backing vocals separation")
other_stems_models: Optional[List[str]] = Field(None, description="Models for other stems")
class AudioSearchResultResponse(BaseModel):
"""A single audio search result."""
index: int
title: str
artist: str
provider: str
url: str
duration: Optional[int] = None
quality: Optional[str] = None
source_id: Optional[str] = None
class AudioSearchResponse(BaseModel):
"""Response from audio search."""
status: str
job_id: str
message: str
results: Optional[List[AudioSearchResultResponse]] = None
results_count: int = 0
auto_download: bool = False
server_version: str
class AudioSelectRequest(BaseModel):
"""Request to select an audio source."""
selection_index: int = Field(..., description="Index of the selected audio source from search results")
class AudioSelectResponse(BaseModel):
"""Response from audio source selection."""
status: str
job_id: str
message: str
selected_index: int
selected_title: str
selected_artist: str
selected_provider: str
def extract_request_metadata(request: Request, created_from: str = "audio_search") -> Dict[str, Any]:
"""Extract metadata from request for job tracking."""
headers = dict(request.headers)
client_ip = headers.get('x-forwarded-for', '').split(',')[0].strip()
if not client_ip and request.client:
client_ip = request.client.host
user_agent = headers.get('user-agent', '')
environment = headers.get('x-environment', '')
client_id = headers.get('x-client-id', '')
custom_headers = {}
for key, value in headers.items():
if key.lower().startswith('x-') and key.lower() not in ('x-forwarded-for', 'x-forwarded-proto', 'x-forwarded-host'):
custom_headers[key] = value
return {
'client_ip': client_ip,
'user_agent': user_agent,
'environment': environment,
'client_id': client_id,
'server_version': VERSION,
'created_from': created_from,
'custom_headers': custom_headers,
}
async def _trigger_workers_parallel(job_id: str) -> None:
"""Trigger both audio and lyrics workers in parallel."""
await asyncio.gather(
worker_service.trigger_audio_worker(job_id),
worker_service.trigger_lyrics_worker(job_id)
)
async def _download_and_start_processing(
job_id: str,
selection_index: int,
audio_search_service,
background_tasks: BackgroundTasks,
) -> Dict[str, Any]:
"""
Download selected audio and start job processing.
This is called either:
- Immediately after search if auto_download=True
- When user calls the select endpoint
"""
job = job_manager.get_job(job_id)
if not job:
raise HTTPException(status_code=404, detail=f"Job {job_id} not found")
# Get search results from state_data
search_results = job.state_data.get('audio_search_results', [])
if not search_results:
raise HTTPException(status_code=400, detail="No search results available")
if selection_index < 0 or selection_index >= len(search_results):
raise HTTPException(
status_code=400,
detail=f"Invalid selection index {selection_index}. Valid range: 0-{len(search_results)-1}"
)
selected = search_results[selection_index]
# Transition to downloading state
job_manager.transition_to_state(
job_id=job_id,
new_status=JobStatus.DOWNLOADING_AUDIO,
progress=10,
message=f"Downloading from {selected['provider']}: {selected['artist']} - {selected['title']}",
state_data_updates={
'selected_audio_index': selection_index,
'selected_audio_provider': selected['provider'],
}
)
try:
# Download to temp directory
temp_dir = tempfile.mkdtemp(prefix=f"audio_download_{job_id}_")
result = audio_search_service.download(
result_index=selection_index,
output_dir=temp_dir,
)
# Upload to GCS
filename = os.path.basename(result.filepath)
audio_gcs_path = f"uploads/{job_id}/audio/{filename}"
with open(result.filepath, 'rb') as f:
storage_service.upload_fileobj(
f,
audio_gcs_path,
content_type='audio/flac' # flacfetch typically returns FLAC
)
logger.info(f"Uploaded audio to GCS: {audio_gcs_path}")
# Clean up temp file
try:
os.remove(result.filepath)
os.rmdir(temp_dir)
except Exception as e:
logger.warning(f"Failed to clean up temp files: {e}")
# Update job with GCS path and transition to DOWNLOADING
job_manager.update_job(job_id, {
'input_media_gcs_path': audio_gcs_path,
'filename': filename,
})
job_manager.transition_to_state(
job_id=job_id,
new_status=JobStatus.DOWNLOADING,
progress=15,
message="Audio downloaded, starting processing"
)
# Trigger workers
background_tasks.add_task(_trigger_workers_parallel, job_id)
return {
'selected_index': selection_index,
'selected_title': selected['title'],
'selected_artist': selected['artist'],
'selected_provider': selected['provider'],
}
except DownloadError as e:
job_manager.fail_job(job_id, f"Audio download failed: {e}")
raise HTTPException(status_code=500, detail=f"Download failed: {e}")
except Exception as e:
job_manager.fail_job(job_id, f"Audio download failed: {e}")
raise HTTPException(status_code=500, detail=f"Download failed: {e}")
@router.post("/audio-search/search", response_model=AudioSearchResponse)
async def search_audio(
request: Request,
background_tasks: BackgroundTasks,
body: AudioSearchRequest,
):
"""
Search for audio by artist and title, creating a new job.
This endpoint:
1. Creates a job in PENDING state
2. Searches for audio using flacfetch
3. Either returns search results for user selection, or
4. If auto_download=True, automatically selects best and starts processing
Use cases:
- Interactive mode (default): Returns results, user calls /select endpoint
- Auto mode (auto_download=True): Automatically selects and downloads best
"""
try:
# 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
# Validate credentials if distribution 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:
result = credential_manager.check_dropbox_credentials()
if result.status != CredentialStatus.VALID:
invalid_services.append(f"dropbox ({result.message})")
if effective_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,
detail={
"error": "credentials_invalid",
"message": f"Distribution services need re-authorization: {', '.join(invalid_services)}",
"invalid_services": invalid_services,
}
)
# Extract request metadata
request_metadata = extract_request_metadata(request, created_from="audio_search")
# Create job
job_create = JobCreate(
artist=body.artist,
title=body.title,
enable_cdg=body.enable_cdg,
enable_txt=body.enable_txt,
brand_prefix=body.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,
lyrics_artist=body.lyrics_artist,
lyrics_title=body.lyrics_title,
subtitle_offset_ms=body.subtitle_offset_ms,
clean_instrumental_model=body.clean_instrumental_model,
backing_vocals_models=body.backing_vocals_models,
other_stems_models=body.other_stems_models,
audio_search_artist=body.artist,
audio_search_title=body.title,
auto_download=body.auto_download,
request_metadata=request_metadata,
)
job = job_manager.create_job(job_create)
job_id = job.job_id
logger.info(f"Created job {job_id} for audio search: {body.artist} - {body.title}")
# Update job with audio search fields
job_manager.update_job(job_id, {
'audio_search_artist': body.artist,
'audio_search_title': body.title,
'auto_download': body.auto_download,
})
# Transition to searching state
job_manager.transition_to_state(
job_id=job_id,
new_status=JobStatus.SEARCHING_AUDIO,
progress=5,
message=f"Searching for: {body.artist} - {body.title}"
)
# Perform search
audio_search_service = get_audio_search_service()
try:
search_results = audio_search_service.search(body.artist, body.title)
except NoResultsError as e:
job_manager.fail_job(job_id, f"No audio sources found for: {body.artist} - {body.title}")
raise HTTPException(
status_code=404,
detail={
"error": "no_results",
"message": str(e),
"job_id": job_id,
}
)
except AudioSearchError as e:
job_manager.fail_job(job_id, f"Audio search failed: {e}")
raise HTTPException(status_code=500, detail=f"Search failed: {e}")
# Store results in job state_data
results_dicts = [r.to_dict() for r in search_results]
job_manager.update_job(job_id, {
'state_data': {
'audio_search_results': results_dicts,
'audio_search_count': len(results_dicts),
}
})
# If auto_download, select best and start processing
if body.auto_download:
best_index = audio_search_service.select_best(search_results)
logger.info(f"Auto-download enabled, selecting result {best_index}")
selection_info = await _download_and_start_processing(
job_id=job_id,
selection_index=best_index,
audio_search_service=audio_search_service,
background_tasks=background_tasks,
)
return AudioSearchResponse(
status="success",
job_id=job_id,
message=f"Audio found and download started: {selection_info['selected_artist']} - {selection_info['selected_title']} ({selection_info['selected_provider']})",
results=None, # Don't return results in auto mode
results_count=len(search_results),
auto_download=True,
server_version=VERSION,
)
# Interactive mode: return results for user selection
job_manager.transition_to_state(
job_id=job_id,
new_status=JobStatus.AWAITING_AUDIO_SELECTION,
progress=10,
message=f"Found {len(search_results)} audio sources. Waiting for selection."
)
# Convert to response format
result_responses = [
AudioSearchResultResponse(
index=r.index,
title=r.title,
artist=r.artist,
provider=r.provider,
url=r.url,
duration=r.duration,
quality=r.quality,
source_id=r.source_id,
)
for r in search_results
]
return AudioSearchResponse(
status="awaiting_selection",
job_id=job_id,
message=f"Found {len(search_results)} audio sources. Call /api/audio-search/{job_id}/select to choose one.",
results=result_responses,
results_count=len(search_results),
auto_download=False,
server_version=VERSION,
)
except HTTPException:
raise
except Exception as e:
logger.error(f"Error in audio search: {e}", exc_info=True)
raise HTTPException(status_code=500, detail=str(e))
@router.get("/audio-search/{job_id}/results")
async def get_audio_search_results(job_id: str):
"""
Get audio search results for a job.
Returns the cached search results so user can select one.
"""
job = job_manager.get_job(job_id)
if not job:
raise HTTPException(status_code=404, detail=f"Job {job_id} not found")
search_results = job.state_data.get('audio_search_results', [])
if not search_results:
raise HTTPException(
status_code=400,
detail="No search results available for this job"
)
return {
"status": "success",
"job_id": job_id,
"job_status": job.status,
"results": search_results,
"results_count": len(search_results),
}
@router.post("/audio-search/{job_id}/select", response_model=AudioSelectResponse)
async def select_audio_source(
job_id: str,
background_tasks: BackgroundTasks,
body: AudioSelectRequest,
):
"""
Select an audio source and start job processing.
This endpoint:
1. Validates the job is awaiting selection
2. Downloads the selected audio
3. Uploads to GCS
4. Triggers audio and lyrics workers
"""
job = job_manager.get_job(job_id)
if not job:
raise HTTPException(status_code=404, detail=f"Job {job_id} not found")
# Verify job is awaiting selection
if job.status != JobStatus.AWAITING_AUDIO_SELECTION:
raise HTTPException(
status_code=400,
detail=f"Job is not awaiting audio selection (status: {job.status})"
)
# Re-instantiate the audio search service (it caches raw results from search)
# For production, we'd need to re-search or store raw results differently
audio_search_service = get_audio_search_service()
# Re-run search to populate the cache
# This is necessary because the service caches raw results in memory
search_results = job.state_data.get('audio_search_results', [])
if not search_results:
raise HTTPException(status_code=400, detail="No search results cached for this job")
artist = job.audio_search_artist or job.artist
title = job.audio_search_title or job.title
try:
# Re-search to populate cache
audio_search_service.search(artist, title)
except Exception as e:
logger.warning(f"Re-search failed, trying direct download: {e}")
selection_info = await _download_and_start_processing(
job_id=job_id,
selection_index=body.selection_index,
audio_search_service=audio_search_service,
background_tasks=background_tasks,
)
return AudioSelectResponse(
status="success",
job_id=job_id,
message="Audio selected and download started",
selected_index=selection_info['selected_index'],
selected_title=selection_info['selected_title'],
selected_artist=selection_info['selected_artist'],
selected_provider=selection_info['selected_provider'],
)
-348
View File
@@ -1,348 +0,0 @@
"""
OAuth credential management API routes.
Provides endpoints for:
1. Checking credential status
2. Device authorization flow for re-authentication
3. Credential validation before job submission
"""
import logging
from typing import Optional
from datetime import datetime
from fastapi import APIRouter, HTTPException, BackgroundTasks
from pydantic import BaseModel
from backend.services.credential_manager import (
get_credential_manager,
CredentialStatus,
CredentialCheckResult,
)
from backend.config import get_settings
logger = logging.getLogger(__name__)
router = APIRouter(prefix="/auth", tags=["auth"])
# ===========================================================================
# Request/Response Models
# ===========================================================================
class CredentialStatusResponse(BaseModel):
"""Response model for credential status."""
service: str
status: str
message: str
last_checked: datetime
expires_at: Optional[datetime] = None
class Config:
from_attributes = True
class AllCredentialsStatusResponse(BaseModel):
"""Response model for all credentials status."""
youtube: CredentialStatusResponse
gdrive: CredentialStatusResponse
dropbox: CredentialStatusResponse
all_valid: bool
services_needing_auth: list[str]
class DeviceAuthStartRequest(BaseModel):
"""Request to start device authorization flow."""
client_id: Optional[str] = None # Optional - reads from Secret Manager if not provided
client_secret: Optional[str] = None # Optional - reads from Secret Manager if not provided
class DeviceAuthStartResponse(BaseModel):
"""Response with device authorization info."""
device_code: str
user_code: str
verification_url: str
expires_in: int
interval: int
instructions: str
class DeviceAuthPollResponse(BaseModel):
"""Response from polling device authorization."""
status: str # "pending", "complete", "expired", "error"
message: Optional[str] = None
credentials_saved: bool = False
class CredentialValidationRequest(BaseModel):
"""Request to validate credentials for specific services."""
youtube: bool = False
gdrive: bool = False
dropbox: bool = False
class CredentialValidationResponse(BaseModel):
"""Response from credential validation."""
valid: bool
invalid_services: list[str]
message: str
# ===========================================================================
# Endpoints
# ===========================================================================
@router.get("/status", response_model=AllCredentialsStatusResponse)
async def get_credentials_status():
"""
Get the status of all OAuth credentials.
Returns the validation status for YouTube, Google Drive, and Dropbox
credentials, including whether they are valid, expired, or need
re-authorization.
"""
manager = get_credential_manager()
results = manager.check_all_credentials()
def to_response(result: CredentialCheckResult) -> CredentialStatusResponse:
return CredentialStatusResponse(
service=result.service,
status=result.status.value,
message=result.message,
last_checked=result.last_checked,
expires_at=result.expires_at
)
services_needing_auth = [
name for name, result in results.items()
if result.status in (CredentialStatus.INVALID, CredentialStatus.EXPIRED, CredentialStatus.NOT_CONFIGURED)
]
return AllCredentialsStatusResponse(
youtube=to_response(results["youtube"]),
gdrive=to_response(results["gdrive"]),
dropbox=to_response(results["dropbox"]),
all_valid=len(services_needing_auth) == 0,
services_needing_auth=services_needing_auth
)
@router.get("/status/{service}", response_model=CredentialStatusResponse)
async def get_service_credential_status(service: str):
"""
Get the status of a specific service's OAuth credentials.
Args:
service: One of "youtube", "gdrive", "dropbox"
"""
manager = get_credential_manager()
if service == "youtube":
result = manager.check_youtube_credentials()
elif service == "gdrive":
result = manager.check_gdrive_credentials()
elif service == "dropbox":
result = manager.check_dropbox_credentials()
else:
raise HTTPException(status_code=400, detail=f"Unknown service: {service}")
return CredentialStatusResponse(
service=result.service,
status=result.status.value,
message=result.message,
last_checked=result.last_checked,
expires_at=result.expires_at
)
@router.post("/validate", response_model=CredentialValidationResponse)
async def validate_credentials(request: CredentialValidationRequest):
"""
Validate that credentials are available for requested services.
Use this before submitting a job to ensure all required
credentials are valid.
"""
manager = get_credential_manager()
invalid_services = []
if request.youtube:
result = manager.check_youtube_credentials()
if result.status != CredentialStatus.VALID:
invalid_services.append("youtube")
if request.gdrive:
result = manager.check_gdrive_credentials()
if result.status != CredentialStatus.VALID:
invalid_services.append("gdrive")
if request.dropbox:
result = manager.check_dropbox_credentials()
if result.status != CredentialStatus.VALID:
invalid_services.append("dropbox")
if invalid_services:
return CredentialValidationResponse(
valid=False,
invalid_services=invalid_services,
message=f"The following services need re-authorization: {', '.join(invalid_services)}"
)
return CredentialValidationResponse(
valid=True,
invalid_services=[],
message="All requested credentials are valid"
)
# ===========================================================================
# Device Authorization Flow Endpoints
# ===========================================================================
@router.post("/youtube/device", response_model=DeviceAuthStartResponse)
async def start_youtube_device_auth(request: Optional[DeviceAuthStartRequest] = None):
"""
Start YouTube device authorization flow.
This initiates a device auth flow that allows authorization
from any device. The user must visit the verification URL
and enter the user code.
Client credentials are loaded from Secret Manager ('youtube-client-credentials')
unless explicitly provided in the request body.
After starting, poll /auth/youtube/device/{device_code} to
check for completion.
"""
manager = get_credential_manager()
try:
device_info = manager.start_youtube_device_auth(
client_id=request.client_id if request else None,
client_secret=request.client_secret if request else None
)
return DeviceAuthStartResponse(
device_code=device_info.device_code,
user_code=device_info.user_code,
verification_url=device_info.verification_url,
expires_in=device_info.expires_in,
interval=device_info.interval,
instructions=f"Visit {device_info.verification_url} and enter code: {device_info.user_code}"
)
except Exception as e:
logger.error(f"Failed to start YouTube device auth: {e}")
raise HTTPException(status_code=500, detail=str(e))
@router.get("/youtube/device/{device_code}", response_model=DeviceAuthPollResponse)
async def poll_youtube_device_auth(device_code: str):
"""
Poll for YouTube device authorization completion.
Call this endpoint at the interval specified in the device auth
start response. Keep polling while status is "pending".
Status values:
- pending: User has not yet authorized
- complete: Authorization successful, credentials saved
- expired: Device code expired, start new flow
- error: An error occurred
"""
manager = get_credential_manager()
status, data = manager.poll_device_auth("youtube", device_code)
return DeviceAuthPollResponse(
status=status,
message=data.get("message") if data else None,
credentials_saved=(status == "complete")
)
@router.post("/gdrive/device", response_model=DeviceAuthStartResponse)
async def start_gdrive_device_auth(request: Optional[DeviceAuthStartRequest] = None):
"""
Start Google Drive device authorization flow.
Client credentials are loaded from Secret Manager ('gdrive-client-credentials')
unless explicitly provided in the request body.
After starting, poll /auth/gdrive/device/{device_code} to check for completion.
"""
manager = get_credential_manager()
try:
device_info = manager.start_gdrive_device_auth(
client_id=request.client_id if request else None,
client_secret=request.client_secret if request else None
)
return DeviceAuthStartResponse(
device_code=device_info.device_code,
user_code=device_info.user_code,
verification_url=device_info.verification_url,
expires_in=device_info.expires_in,
interval=device_info.interval,
instructions=f"Visit {device_info.verification_url} and enter code: {device_info.user_code}"
)
except Exception as e:
logger.error(f"Failed to start Google Drive device auth: {e}")
raise HTTPException(status_code=500, detail=str(e))
@router.get("/gdrive/device/{device_code}", response_model=DeviceAuthPollResponse)
async def poll_gdrive_device_auth(device_code: str):
"""
Poll for Google Drive device authorization completion.
"""
manager = get_credential_manager()
status, data = manager.poll_device_auth("gdrive", device_code)
return DeviceAuthPollResponse(
status=status,
message=data.get("message") if data else None,
credentials_saved=(status == "complete")
)
# ===========================================================================
# Alert Testing
# ===========================================================================
@router.post("/test-alert")
async def test_credential_alert(background_tasks: BackgroundTasks):
"""
Test the credential alert mechanism.
Sends a test alert to Discord if configured.
"""
settings = get_settings()
discord_url = settings.get_secret("discord-alert-webhook")
if not discord_url:
raise HTTPException(
status_code=400,
detail="Discord alert webhook not configured"
)
manager = get_credential_manager()
# Create a fake invalid result for testing
from backend.services.credential_manager import CredentialCheckResult
test_results = [
CredentialCheckResult(
service="test",
status=CredentialStatus.INVALID,
message="This is a test alert",
last_checked=datetime.utcnow()
)
]
background_tasks.add_task(
manager.send_credential_alert,
test_results,
discord_url
)
return {"message": "Test alert queued"}
File diff suppressed because it is too large. Load diff
-26
View File
@@ -1,26 +0,0 @@
"""
Health check routes.
"""
from fastapi import APIRouter
from typing import Dict
router = APIRouter()
@router.get("/health")
async def health_check() -> Dict[str, str]:
"""Health check endpoint."""
return {
"status": "healthy",
"service": "karaoke-gen-backend"
}
@router.get("/readiness")
async def readiness_check() -> Dict[str, str]:
"""Readiness check endpoint for Cloud Run."""
return {
"status": "ready",
"service": "karaoke-gen-backend"
}
-273
View File
@@ -1,273 +0,0 @@
"""
Internal API routes for worker coordination.
These endpoints are for internal use only (backend → workers).
They are protected by admin authentication.
With Cloud Tasks integration, these endpoints may be called multiple times
(retry on failure). Idempotency checks prevent duplicate processing.
"""
import logging
import asyncio
from typing import Tuple, Optional
from fastapi import APIRouter, HTTPException, BackgroundTasks, Depends
from pydantic import BaseModel
from backend.workers.audio_worker import process_audio_separation
from backend.workers.lyrics_worker import process_lyrics_transcription
from backend.workers.screens_worker import generate_screens
from backend.workers.video_worker import generate_video
from backend.workers.render_video_worker import process_render_video
from backend.api.dependencies import require_admin
from backend.services.auth_service import UserType
from backend.services.job_manager import JobManager
logger = logging.getLogger(__name__)
router = APIRouter(prefix="/internal", tags=["internal"])
class WorkerRequest(BaseModel):
"""Request to trigger a worker."""
job_id: str
class WorkerResponse(BaseModel):
"""Response from worker trigger."""
status: str
job_id: str
message: str
def _check_worker_idempotency(job_id: str, worker_name: str) -> Optional[WorkerResponse]:
"""
Check if a worker is already running or completed for this job.
This provides idempotency for Cloud Tasks retries - if a task is retried
but the worker is already running or has completed, we skip processing.
Args:
job_id: Job ID to check
worker_name: Worker name (audio, lyrics, screens, render, video)
Returns:
WorkerResponse if should skip (already running/complete), None to proceed
"""
job_manager = JobManager()
job = job_manager.get_job(job_id)
if not job:
logger.warning(f"Job {job_id} not found for {worker_name} worker")
return WorkerResponse(
status="not_found",
job_id=job_id,
message=f"Job {job_id} not found"
)
# Check worker-specific progress in state_data
progress_key = f"{worker_name}_progress"
worker_progress = job.state_data.get(progress_key, {})
stage = worker_progress.get('stage')
if stage == 'running':
logger.info(f"{worker_name.capitalize()} worker already running for job {job_id}, skipping")
return WorkerResponse(
status="already_running",
job_id=job_id,
message=f"{worker_name.capitalize()} worker already in progress"
)
if stage == 'complete':
logger.info(f"{worker_name.capitalize()} worker already complete for job {job_id}, skipping")
return WorkerResponse(
status="already_complete",
job_id=job_id,
message=f"{worker_name.capitalize()} worker already completed"
)
# Mark as running before starting (for idempotency on next retry)
job_manager.update_state_data(job_id, progress_key, {'stage': 'running'})
return None
@router.post("/workers/audio", response_model=WorkerResponse)
async def trigger_audio_worker(
request: WorkerRequest,
background_tasks: BackgroundTasks,
auth_data: Tuple[str, UserType, int] = Depends(require_admin)
):
"""
Trigger audio separation worker for a job.
This endpoint is called internally after job creation to start
the audio processing track (parallel with lyrics processing).
Idempotency: If worker is already running or complete, returns early.
The worker runs in the background and updates job state as it progresses.
"""
job_id = request.job_id
logger.info(f"Triggering audio worker for job {job_id}")
# Idempotency check
skip_response = _check_worker_idempotency(job_id, "audio")
if skip_response:
return skip_response
# Add task to background tasks
# This allows the HTTP response to return immediately
# while the worker continues processing
background_tasks.add_task(process_audio_separation, job_id)
return WorkerResponse(
status="started",
job_id=job_id,
message="Audio separation worker started"
)
@router.post("/workers/lyrics", response_model=WorkerResponse)
async def trigger_lyrics_worker(
request: WorkerRequest,
background_tasks: BackgroundTasks,
auth_data: Tuple[str, UserType, int] = Depends(require_admin)
):
"""
Trigger lyrics transcription worker for a job.
This endpoint is called internally after job creation to start
the lyrics processing track (parallel with audio processing).
Idempotency: If worker is already running or complete, returns early.
The worker runs in the background and updates job state as it progresses.
"""
job_id = request.job_id
logger.info(f"Triggering lyrics worker for job {job_id}")
# Idempotency check
skip_response = _check_worker_idempotency(job_id, "lyrics")
if skip_response:
return skip_response
# Add task to background tasks
background_tasks.add_task(process_lyrics_transcription, job_id)
return WorkerResponse(
status="started",
job_id=job_id,
message="Lyrics transcription worker started"
)
@router.post("/workers/screens", response_model=WorkerResponse)
async def trigger_screens_worker(
request: WorkerRequest,
background_tasks: BackgroundTasks,
auth_data: Tuple[str, UserType, int] = Depends(require_admin)
):
"""
Trigger title/end screen generation worker.
This is called automatically when both audio and lyrics are complete.
Idempotency: If worker is already running or complete, returns early.
"""
job_id = request.job_id
logger.info(f"Triggering screens worker for job {job_id}")
# Idempotency check
skip_response = _check_worker_idempotency(job_id, "screens")
if skip_response:
return skip_response
# Add task to background tasks
background_tasks.add_task(generate_screens, job_id)
return WorkerResponse(
status="started",
job_id=job_id,
message="Screens generation worker started"
)
@router.post("/workers/video", response_model=WorkerResponse)
async def trigger_video_worker(
request: WorkerRequest,
background_tasks: BackgroundTasks,
auth_data: Tuple[str, UserType, int] = Depends(require_admin)
):
"""
Trigger final video generation and encoding worker.
This is called after user selects their preferred instrumental.
This is the longest-running stage (15-20 minutes).
Idempotency: If worker is already running or complete, returns early.
"""
job_id = request.job_id
logger.info(f"Triggering video worker for job {job_id}")
# Idempotency check
skip_response = _check_worker_idempotency(job_id, "video")
if skip_response:
return skip_response
# Add task to background tasks
background_tasks.add_task(generate_video, job_id)
return WorkerResponse(
status="started",
job_id=job_id,
message="Video generation worker started"
)
@router.post("/workers/render-video", response_model=WorkerResponse)
async def trigger_render_video_worker(
request: WorkerRequest,
background_tasks: BackgroundTasks,
auth_data: Tuple[str, UserType, int] = Depends(require_admin)
):
"""
Trigger render video worker (post-review).
This is called after human review is complete.
Uses OutputGenerator from LyricsTranscriber to generate the karaoke video
with the corrected lyrics.
Idempotency: If worker is already running or complete, returns early.
Output: with_vocals.mkv in GCS
Next state: AWAITING_INSTRUMENTAL_SELECTION
"""
job_id = request.job_id
logger.info(f"Triggering render-video worker for job {job_id}")
# Idempotency check
skip_response = _check_worker_idempotency(job_id, "render")
if skip_response:
return skip_response
# Add task to background tasks
background_tasks.add_task(process_render_video, job_id)
return WorkerResponse(
status="started",
job_id=job_id,
message="Render video worker started (post-review)"
)
@router.get("/health")
async def internal_health(
auth_data: Tuple[str, UserType, int] = Depends(require_admin)
):
"""
Internal health check endpoint.
Used to verify the internal API is responsive.
Requires admin authentication.
"""
return {"status": "healthy", "service": "karaoke-backend-internal"}
File diff suppressed because it is too large. Load diff
-531
View File
@@ -1,531 +0,0 @@
"""
Review API routes - Compatible with LyricsTranscriber frontend.
These endpoints match the API that the LyricsTranscriber review frontend expects,
allowing us to use the existing React review UI with our cloud backend.
Usage:
Frontend URL: http://localhost:5173/?baseApiUrl=http://localhost:8000/api/review/{job_id}
The baseApiUrl includes the job_id, and all endpoints are relative to that.
"""
import asyncio
import logging
import hashlib
import json
import os
import tempfile
from pathlib import Path
from typing import Dict, Any, Set
from fastapi import APIRouter, HTTPException, Request
from fastapi.responses import FileResponse, StreamingResponse
from starlette.background import BackgroundTask
from backend.models.job import JobStatus
from backend.services.job_manager import JobManager
from backend.services.storage_service import StorageService
from backend.services.job_logging import job_log_context, JobLogger
from backend.services.tracing import create_span, add_span_attribute, add_span_event
# LyricsTranscriber imports for preview generation
from lyrics_transcriber.types import CorrectionResult
from lyrics_transcriber.core.config import OutputConfig
from lyrics_transcriber.correction.operations import CorrectionOperations
# Import from the unified style loader
from karaoke_gen.style_loader import load_styles_from_gcs
logger = logging.getLogger(__name__)
router = APIRouter(prefix="/review", tags=["review"])
# Store job context for the session
# In production, this would be handled differently (e.g., session tokens)
_job_contexts: Dict[str, Dict[str, Any]] = {}
# Store preview video paths for serving
_preview_videos: Dict[str, Dict[str, str]] = {}
# Keep references to background tasks to prevent garbage collection
_background_tasks: Set[asyncio.Task] = set()
def _get_audio_hash(job_id: str) -> str:
"""Generate a consistent audio hash for a job."""
return hashlib.md5(job_id.encode()).hexdigest()
@router.get("/{job_id}/ping")
async def ping(job_id: str):
"""Health check endpoint expected by frontend."""
return {"status": "ok"}
@router.get("/{job_id}/correction-data")
async def get_correction_data(job_id: str):
"""
Get correction data for the review interface.
Returns the CorrectionResult data that the frontend needs to render
the lyrics review UI.
"""
job_manager = JobManager()
storage = StorageService()
job = job_manager.get_job(job_id)
if not job:
raise HTTPException(status_code=404, detail="Job not found")
if job.status not in [JobStatus.AWAITING_REVIEW, JobStatus.IN_REVIEW]:
raise HTTPException(
status_code=400,
detail=f"Job not ready for review (current status: {job.status})"
)
# Get corrections URL from file_urls
corrections_gcs = job.file_urls.get('lyrics', {}).get('corrections')
if not corrections_gcs:
# Try direct path
corrections_gcs = f"jobs/{job_id}/lyrics/corrections.json"
if not storage.file_exists(corrections_gcs):
raise HTTPException(
status_code=404,
detail="Corrections data not found. Lyrics processing may not be complete."
)
# Download and return corrections data
try:
corrections_data = storage.download_json(corrections_gcs)
# Add audio hash for the frontend
audio_hash = _get_audio_hash(job_id)
if 'metadata' not in corrections_data:
corrections_data['metadata'] = {}
corrections_data['metadata']['audio_hash'] = audio_hash
corrections_data['metadata']['artist'] = job.artist
corrections_data['metadata']['title'] = job.title
# Store context for audio serving
_job_contexts[job_id] = {
'audio_hash': audio_hash,
'audio_gcs_path': job.input_media_gcs_path
}
# Transition to IN_REVIEW if not already
if job.status == JobStatus.AWAITING_REVIEW:
job_manager.transition_to_state(
job_id=job_id,
new_status=JobStatus.IN_REVIEW,
message="User opened review interface"
)
logger.info(f"Job {job_id}: Serving correction data for review")
return corrections_data
except Exception as e:
logger.error(f"Job {job_id}: Error loading corrections: {e}", exc_info=True)
raise HTTPException(status_code=500, detail=f"Error loading corrections: {str(e)}")
@router.get("/{job_id}/audio/{audio_hash}")
async def get_audio_with_hash(job_id: str, audio_hash: str):
"""Stream the audio file for playback (with hash parameter)."""
return await _stream_audio(job_id)
@router.get("/{job_id}/audio/")
@router.get("/{job_id}/audio")
async def get_audio_no_hash(job_id: str):
"""Stream the audio file for playback (without hash parameter)."""
return await _stream_audio(job_id)
async def _stream_audio(job_id: str):
"""
Stream the audio file for playback in the review interface.
"""
job_manager = JobManager()
storage = StorageService()
job = job_manager.get_job(job_id)
if not job:
raise HTTPException(status_code=404, detail="Job not found")
audio_gcs_path = job.input_media_gcs_path
if not audio_gcs_path:
raise HTTPException(status_code=404, detail="Audio file not found")
# Download to temp file and stream
try:
# Create temp file
with tempfile.NamedTemporaryFile(delete=False, suffix=".flac") as tmp:
tmp_path = tmp.name
storage.download_file(audio_gcs_path, tmp_path)
# Determine content type
if audio_gcs_path.endswith('.flac'):
media_type = "audio/flac"
elif audio_gcs_path.endswith('.wav'):
media_type = "audio/wav"
elif audio_gcs_path.endswith('.mp3'):
media_type = "audio/mpeg"
else:
media_type = "audio/mpeg"
logger.info(f"Job {job_id}: Streaming audio for review")
return FileResponse(
tmp_path,
media_type=media_type,
filename=os.path.basename(audio_gcs_path),
background=BackgroundTask(os.unlink, tmp_path),
)
except Exception as e:
logger.error(f"Job {job_id}: Error streaming audio: {e}", exc_info=True)
raise HTTPException(status_code=500, detail=f"Error streaming audio: {str(e)}")
@router.post("/{job_id}/complete")
async def complete_review(job_id: str, updated_data: Dict[str, Any]):
"""
Complete the review and save corrected lyrics.
This endpoint receives the updated correction data from the frontend
and saves it, then triggers the render video worker.
"""
job_manager = JobManager()
storage = StorageService()
job = job_manager.get_job(job_id)
if not job:
raise HTTPException(status_code=404, detail="Job not found")
if job.status not in [JobStatus.AWAITING_REVIEW, JobStatus.IN_REVIEW]:
raise HTTPException(
status_code=400,
detail=f"Job not in review state (current status: {job.status})"
)
try:
# Save updated corrections to GCS
corrections_gcs_path = f"jobs/{job_id}/lyrics/corrections_updated.json"
storage.upload_json(corrections_gcs_path, updated_data)
job_manager.update_file_url(job_id, 'lyrics', 'corrections_updated', corrections_gcs_path)
logger.info(f"Job {job_id}: Saved updated corrections")
# Transition to REVIEW_COMPLETE
job_manager.transition_to_state(
job_id=job_id,
new_status=JobStatus.REVIEW_COMPLETE,
progress=70,
message="Review complete, rendering video with corrected lyrics"
)
# Trigger render video worker
from backend.services.worker_service import get_worker_service
worker_service = get_worker_service()
# Run in background, keep reference to prevent garbage collection
task = asyncio.create_task(worker_service.trigger_render_video_worker(job_id))
_background_tasks.add(task)
task.add_done_callback(_background_tasks.discard)
logger.info(f"Job {job_id}: Review complete, triggered render video worker")
return {"status": "success"}
except Exception as e:
logger.error(f"Job {job_id}: Error completing review: {e}", exc_info=True)
raise HTTPException(status_code=500, detail=f"Error completing review: {str(e)}")
@router.post("/{job_id}/handlers")
async def update_handlers(job_id: str, enabled_handlers: list):
"""
Update enabled correction handlers (optional feature).
For now, just acknowledge the request - full handler support
would require re-running correction.
"""
logger.info(f"Job {job_id}: Handler update requested (not implemented)")
return {"status": "success", "message": "Handler updates not yet implemented"}
@router.post("/{job_id}/add-lyrics")
async def add_lyrics(job_id: str, data: Dict[str, str]):
"""
Add custom lyrics source and rerun correction.
Uses the LyricsTranscriber's CorrectionOperations to add a new lyrics source
and regenerate corrections with the new source included.
"""
job_manager = JobManager()
storage = StorageService()
job = job_manager.get_job(job_id)
if not job:
raise HTTPException(status_code=404, detail="Job not found")
# Job must be in review state to add lyrics
if job.status not in [JobStatus.AWAITING_REVIEW, JobStatus.IN_REVIEW]:
raise HTTPException(
status_code=400,
detail=f"Job not in review state (current status: {job.status})"
)
source = data.get("source", "").strip()
lyrics_text = data.get("lyrics", "").strip()
logger.info(f"Job {job_id}: Adding lyrics source '{source}' with {len(lyrics_text)} characters")
# Use tracing and job_log_context for full observability
with create_span("add-lyrics", {"job_id": job_id, "source": source, "lyrics_length": len(lyrics_text)}) as span:
with job_log_context(job_id, worker="add-lyrics"):
try:
# Create temp directory for this operation
with tempfile.TemporaryDirectory() as temp_dir:
# Download current corrections.json
with create_span("download-corrections") as download_span:
corrections_gcs = f"jobs/{job_id}/lyrics/corrections.json"
corrections_path = os.path.join(temp_dir, "corrections.json")
storage.download_file(corrections_gcs, corrections_path)
download_span.set_attribute("gcs_path", corrections_gcs)
with open(corrections_path, 'r', encoding='utf-8') as f:
original_data = json.load(f)
# Load as CorrectionResult
correction_result = CorrectionResult.from_dict(original_data)
add_span_event("corrections_loaded", {
"segments": len(correction_result.corrected_segments) if correction_result.corrected_segments else 0,
"reference_sources": len(correction_result.reference_lyrics) if correction_result.reference_lyrics else 0,
})
# Set up cache directory
cache_dir = os.path.join(temp_dir, "cache")
os.makedirs(cache_dir, exist_ok=True)
# Add lyrics source using CorrectionOperations (this is the heavy operation)
with create_span("correction-operations-add-lyrics") as correction_span:
correction_span.set_attribute("source_name", source)
updated_result = CorrectionOperations.add_lyrics_source(
correction_result=correction_result,
source=source,
lyrics_text=lyrics_text,
cache_dir=cache_dir,
logger=logger
)
add_span_event("correction_complete", {
"new_segments": len(updated_result.corrected_segments) if updated_result.corrected_segments else 0,
})
# Add audio hash for the frontend
audio_hash = _get_audio_hash(job_id)
if not updated_result.metadata:
updated_result.metadata = {}
updated_result.metadata['audio_hash'] = audio_hash
updated_result.metadata['artist'] = job.artist
updated_result.metadata['title'] = job.title
# Upload updated corrections back to GCS
with create_span("upload-corrections") as upload_span:
updated_data = updated_result.to_dict()
storage.upload_json(corrections_gcs, updated_data)
upload_span.set_attribute("gcs_path", corrections_gcs)
logger.info(f"Job {job_id}: Successfully added lyrics source '{source}'")
span.set_attribute("success", True)
return {"status": "success", "data": updated_data}
except ValueError as e:
# ValueError from CorrectionOperations (e.g., duplicate source name)
logger.warning(f"Job {job_id}: Invalid add lyrics request: {e}")
span.set_attribute("error", str(e))
raise HTTPException(status_code=400, detail=str(e))
except Exception as e:
logger.error(f"Job {job_id}: Failed to add lyrics: {e}", exc_info=True)
span.set_attribute("error", str(e))
raise HTTPException(status_code=500, detail=f"Failed to add lyrics: {str(e)}")
@router.post("/{job_id}/preview-video")
async def generate_preview_video(job_id: str, updated_data: Dict[str, Any]):
"""
Generate a preview video with the current corrections.
Uses the LyricsTranscriber's CorrectionOperations to generate a 360p preview
video with the user's current corrections applied.
"""
job_manager = JobManager()
storage = StorageService()
job = job_manager.get_job(job_id)
if not job:
raise HTTPException(status_code=404, detail="Job not found")
# Job must be in review state to generate preview
if job.status not in [JobStatus.AWAITING_REVIEW, JobStatus.IN_REVIEW]:
raise HTTPException(
status_code=400,
detail=f"Job not in review state (current status: {job.status})"
)
logger.info(f"Job {job_id}: Generating preview video")
# Use tracing and job_log_context for full observability
with create_span("generate-preview-video", {"job_id": job_id}) as span:
with job_log_context(job_id, worker="preview"):
try:
# Create temp directory for this preview operation
with tempfile.TemporaryDirectory() as temp_dir:
# 1. Download original corrections.json (has full structure)
with create_span("download-corrections-and-audio") as download_span:
corrections_gcs = f"jobs/{job_id}/lyrics/corrections.json"
corrections_path = os.path.join(temp_dir, "corrections.json")
storage.download_file(corrections_gcs, corrections_path)
with open(corrections_path, 'r', encoding='utf-8') as f:
original_data = json.load(f)
# 2. Download input audio
audio_path = os.path.join(temp_dir, "audio.flac")
storage.download_file(job.input_media_gcs_path, audio_path)
download_span.set_attribute("audio_gcs_path", job.input_media_gcs_path)
# 3. Load original as CorrectionResult
correction_result = CorrectionResult.from_dict(original_data)
add_span_event("corrections_loaded")
# 4. Get or create styles file for preview using unified style loader
with create_span("load-styles") as styles_span:
styles_path, _ = load_styles_from_gcs(
style_params_gcs_path=job.style_params_gcs_path,
style_assets=job.style_assets,
temp_dir=temp_dir,
download_func=storage.download_file,
logger=logger,
)
styles_span.set_attribute("styles_path", styles_path)
# 5. Set up output config for preview
output_dir = os.path.join(temp_dir, "output")
cache_dir = os.path.join(temp_dir, "cache")
os.makedirs(output_dir, exist_ok=True)
os.makedirs(cache_dir, exist_ok=True)
output_config = OutputConfig(
output_styles_json=styles_path,
output_dir=output_dir,
cache_dir=cache_dir,
video_resolution="360p",
)
# 6. Generate preview video using CorrectionOperations (heavy operation)
with create_span("render-preview-video") as render_span:
render_span.set_attribute("resolution", "360p")
result = CorrectionOperations.generate_preview_video(
correction_result=correction_result,
updated_data=updated_data,
output_config=output_config,
audio_filepath=audio_path,
artist=job.artist,
title=job.title,
logger=logger
)
add_span_event("render_complete")
# 7. Upload preview video to GCS for serving
preview_hash = result["preview_hash"]
video_path = result["video_path"]
with create_span("upload-preview-video") as upload_span:
preview_gcs_path = f"jobs/{job_id}/previews/{preview_hash}.mp4"
storage.upload_file(video_path, preview_gcs_path)
upload_span.set_attribute("gcs_path", preview_gcs_path)
# Store the GCS path for serving
if job_id not in _preview_videos:
_preview_videos[job_id] = {}
_preview_videos[job_id][preview_hash] = preview_gcs_path
logger.info(f"Job {job_id}: Preview video generated: {preview_hash}")
span.set_attribute("preview_hash", preview_hash)
span.set_attribute("success", True)
return {"status": "success", "preview_hash": preview_hash}
except Exception as e:
logger.error(f"Job {job_id}: Failed to generate preview video: {e}", exc_info=True)
span.set_attribute("error", str(e))
raise HTTPException(
status_code=500,
detail=f"Failed to generate preview video: {e}"
) from e
@router.get("/{job_id}/preview-video/{preview_hash}")
async def get_preview_video(job_id: str, preview_hash: str):
"""Stream the generated preview video."""
storage = StorageService()
# Check in-memory cache first
preview_gcs_path = None
if job_id in _preview_videos and preview_hash in _preview_videos[job_id]:
preview_gcs_path = _preview_videos[job_id][preview_hash]
else:
# Try standard path
preview_gcs_path = f"jobs/{job_id}/previews/{preview_hash}.mp4"
if not storage.file_exists(preview_gcs_path):
raise HTTPException(status_code=404, detail="Preview video not found")
try:
# Download to temp file and stream
with tempfile.NamedTemporaryFile(delete=False, suffix=".mp4") as tmp:
tmp_path = tmp.name
storage.download_file(preview_gcs_path, tmp_path)
logger.info(f"Job {job_id}: Streaming preview video {preview_hash}")
return FileResponse(
tmp_path,
media_type="video/mp4",
filename=f"preview_{preview_hash}.mp4",
headers={
"Accept-Ranges": "bytes",
"Content-Disposition": "inline",
"Cache-Control": "no-cache",
},
background=BackgroundTask(os.unlink, tmp_path),
)
except Exception as e:
logger.error(f"Job {job_id}: Error streaming preview video: {e}", exc_info=True)
raise HTTPException(status_code=500, detail=f"Error streaming preview video: {str(e)}")
@router.post("/{job_id}/v1/annotations")
async def submit_annotation(job_id: str, annotation: Dict[str, Any]):
"""
Submit a correction annotation for ML training data.
For now, just log and acknowledge - full annotation support
would require a database.
"""
logger.info(f"Job {job_id}: Annotation submitted (logged but not stored)")
return {"status": "success", "annotation_id": "stub"}
@router.get("/{job_id}/v1/annotations/stats")
async def get_annotation_stats(job_id: str):
"""Get annotation statistics."""
return {
"total_annotations": 0,
"by_type": {},
"message": "Annotation stats not yet implemented"
}
-128
View File
@@ -1,128 +0,0 @@
"""
Configuration management for the karaoke generation backend.
"""
import os
import logging
from typing import Optional, Dict
from pydantic_settings import BaseSettings
from google.cloud import secretmanager
logger = logging.getLogger(__name__)
class Settings(BaseSettings):
"""Application settings."""
# Google Cloud
google_cloud_project: str = os.getenv("GOOGLE_CLOUD_PROJECT", "")
gcs_bucket_name: str = os.getenv("GCS_BUCKET_NAME", "karaoke-gen-storage")
gcs_temp_bucket: str = os.getenv("GCS_TEMP_BUCKET", "karaoke-gen-temp")
gcs_output_bucket: str = os.getenv("GCS_OUTPUT_BUCKET", "karaoke-gen-outputs")
firestore_collection: str = os.getenv("FIRESTORE_COLLECTION", "jobs")
# Audio Separator API (for GPU processing)
audio_separator_api_url: Optional[str] = os.getenv("AUDIO_SEPARATOR_API_URL")
# External APIs (can be set via env or Secret Manager)
audioshake_api_key: Optional[str] = os.getenv("AUDIOSHAKE_API_KEY")
genius_api_key: Optional[str] = os.getenv("GENIUS_API_KEY")
spotify_cookie: Optional[str] = os.getenv("SPOTIFY_COOKIE_SP_DC")
rapidapi_key: Optional[str] = os.getenv("RAPIDAPI_KEY")
# Authentication
admin_tokens: Optional[str] = os.getenv("ADMIN_TOKENS") # Comma-separated list
# Application
environment: str = os.getenv("ENVIRONMENT", "development")
log_level: str = os.getenv("LOG_LEVEL", "INFO")
# Processing
max_concurrent_jobs: int = int(os.getenv("MAX_CONCURRENT_JOBS", "5"))
job_timeout_seconds: int = int(os.getenv("JOB_TIMEOUT_SECONDS", "3600"))
# Cloud Tasks (for scalable worker coordination)
# When enabled, workers are triggered via Cloud Tasks for guaranteed delivery
# When disabled (default), workers are triggered via direct HTTP (for development)
enable_cloud_tasks: bool = os.getenv("ENABLE_CLOUD_TASKS", "false").lower() in ("true", "1", "yes")
gcp_region: str = os.getenv("GCP_REGION", "us-central1")
# Cloud Run Jobs (for long-running video encoding)
# When enabled AND enable_cloud_tasks is true, video worker uses Cloud Run Jobs
# instead of Cloud Tasks. This supports encoding times >30 minutes (up to 24 hours).
# Default is false - Cloud Tasks is sufficient for most videos (15-20 min).
use_cloud_run_jobs_for_video: bool = os.getenv("USE_CLOUD_RUN_JOBS_FOR_VIDEO", "false").lower() in ("true", "1", "yes")
# Storage paths
temp_dir: str = os.getenv("TEMP_DIR", "/tmp/karaoke-gen")
# Default distribution settings (can be overridden per-request)
default_dropbox_path: Optional[str] = os.getenv("DEFAULT_DROPBOX_PATH")
default_gdrive_folder_id: Optional[str] = os.getenv("DEFAULT_GDRIVE_FOLDER_ID")
# Strip whitespace/newlines from webhook URL - common issue when env vars are set with trailing newlines
default_discord_webhook_url: Optional[str] = (
os.getenv("DEFAULT_DISCORD_WEBHOOK_URL", "").strip() or None
)
# Secret Manager cache
_secret_cache: Dict[str, str] = {}
class Config:
env_file = ".env"
case_sensitive = False
def get_secret(self, secret_id: str) -> Optional[str]:
"""
Get a secret from Google Secret Manager.
Caches secrets in memory to avoid repeated API calls.
Falls back to environment variables if Secret Manager unavailable.
Args:
secret_id: Secret name (e.g., "audioshake-api-key")
Returns:
Secret value or None if not found
"""
# Check cache first
if secret_id in self._secret_cache:
return self._secret_cache[secret_id]
# Check environment variable (development mode)
env_var = secret_id.upper().replace('-', '_')
env_value = os.getenv(env_var)
if env_value:
logger.debug(f"Using {secret_id} from environment variable")
self._secret_cache[secret_id] = env_value
return env_value
# Try Secret Manager (production mode)
if not self.google_cloud_project:
logger.warning(f"Cannot fetch secret {secret_id}: No GCP project configured")
return None
try:
client = secretmanager.SecretManagerServiceClient()
name = f"projects/{self.google_cloud_project}/secrets/{secret_id}/versions/latest"
response = client.access_secret_version(request={"name": name})
# Strip whitespace/newlines - common issue when secrets are created with trailing newlines
secret_value = response.payload.data.decode('UTF-8').strip()
# Cache it
self._secret_cache[secret_id] = secret_value
logger.info(f"Loaded secret {secret_id} from Secret Manager")
return secret_value
except Exception as e:
logger.error(f"Failed to load secret {secret_id} from Secret Manager: {e}")
return None
# Global settings instance
settings = Settings()
def get_settings() -> Settings:
"""Get the global settings instance."""
return settings
-127
View File
@@ -1,127 +0,0 @@
"""
FastAPI application entry point for karaoke generation backend.
"""
import logging
from contextlib import asynccontextmanager
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
from backend.services.tracing import setup_tracing, instrument_app, get_current_trace_id
from backend.version import VERSION
# Configure logging with trace ID support
logging.basicConfig(
level=getattr(logging, settings.log_level.upper()),
format='%(asctime)s - %(name)s - %(levelname)s - %(message)s'
)
logger = logging.getLogger(__name__)
# Initialize OpenTelemetry tracing (must happen before app creation)
tracing_enabled = setup_tracing(
service_name="karaoke-backend",
service_version=VERSION,
enable_in_dev=False, # Set to True to enable tracing locally
)
async def validate_credentials_on_startup():
"""Validate OAuth credentials on startup and send alerts if needed."""
try:
from backend.services.credential_manager import get_credential_manager, CredentialStatus
manager = get_credential_manager()
results = manager.check_all_credentials()
invalid_services = [
result for result in results.values()
if result.status in (CredentialStatus.INVALID, CredentialStatus.EXPIRED)
]
if invalid_services:
logger.warning(f"Some OAuth credentials need attention:")
for result in invalid_services:
logger.warning(f" - {result.service}: {result.message}")
# Try to send Discord alert
discord_url = settings.get_secret("discord-alert-webhook") if hasattr(settings, 'get_secret') else None
if discord_url:
manager.send_credential_alert(invalid_services, discord_url)
logger.info("Sent credential alert to Discord")
else:
logger.info("All OAuth credentials validated successfully")
except Exception as e:
logger.error(f"Failed to validate credentials on startup: {e}")
@asynccontextmanager
async def lifespan(app: FastAPI):
"""Lifespan event handler for startup and shutdown."""
# Startup
logger.info("Starting karaoke generation backend")
logger.info(f"Environment: {settings.environment}")
logger.info(f"GCS Bucket: {settings.gcs_bucket_name}")
logger.info(f"Tracing enabled: {tracing_enabled}")
# Validate OAuth credentials (non-blocking)
try:
await validate_credentials_on_startup()
except Exception as e:
logger.error(f"Credential validation failed: {e}")
yield
# Shutdown
logger.info("Shutting down karaoke generation backend")
# Create FastAPI app
app = FastAPI(
title="Karaoke Generator API",
description="Backend API for web-based karaoke video generation",
version=VERSION,
lifespan=lifespan
)
# Instrument FastAPI with OpenTelemetry (adds automatic spans for all requests)
if tracing_enabled:
instrument_app(app)
# Configure CORS
app.add_middleware(
CORSMiddleware,
allow_origins=["*"], # Configure this properly for production
allow_credentials=True,
allow_methods=["*"],
allow_headers=["*"],
)
# Include routers
app.include_router(health.router, prefix="/api")
app.include_router(jobs.router, prefix="/api")
app.include_router(file_upload.router, prefix="/api") # File upload endpoint
app.include_router(internal.router, prefix="/api") # Internal worker endpoints
app.include_router(review.router, prefix="/api") # Review UI compatibility endpoints
app.include_router(auth.router, prefix="/api") # OAuth credential management
app.include_router(audio_search.router, prefix="/api") # Audio search (artist+title mode)
@app.get("/")
async def root():
"""Root endpoint."""
return {
"service": "karaoke-gen-backend",
"version": VERSION,
"status": "running"
}
if __name__ == "__main__":
import uvicorn
uvicorn.run(app, host="0.0.0.0", port=8080)
View File
Whitespace-only changes.
-465
View File
@@ -1,465 +0,0 @@
"""
Job data models for karaoke generation.
This module defines the complete state machine for karaoke generation jobs,
mirroring the 8-stage CLI workflow with human-in-the-loop interaction points.
"""
from typing import Optional, Dict, Any, List
from datetime import datetime
from enum import Enum
from pydantic import BaseModel, Field, validator
class JobStatus(str, Enum):
"""
Job status enumeration - Complete state machine.
The workflow has 8 main stages with 3 human interaction points:
1. Input & Setup (may include audio source selection)
2. Parallel Processing (audio + lyrics)
3. Title/End Screen Generation
4. Countdown Padding Synchronization
5. Human Review (BLOCKING)
6. Instrumental Selection (BLOCKING)
7. Video Finalization
8. Distribution
"""
# Initial states
PENDING = "pending" # Job created, queued for processing
# Audio search states (for artist+title search mode)
SEARCHING_AUDIO = "searching_audio" # Searching for audio sources via flacfetch
AWAITING_AUDIO_SELECTION = "awaiting_audio_selection" # ⚠️ WAITING FOR USER - select audio source
DOWNLOADING_AUDIO = "downloading_audio" # Downloading selected audio from source
DOWNLOADING = "downloading" # Downloading from URL or processing upload
# Stage 2a: Audio separation (parallel track 1)
SEPARATING_STAGE1 = "separating_stage1" # Clean instrumental separation (Modal API)
SEPARATING_STAGE2 = "separating_stage2" # Backing vocals separation (Modal API)
AUDIO_COMPLETE = "audio_complete" # All audio stems ready
# Stage 2b: Lyrics processing (parallel track 2)
TRANSCRIBING = "transcribing" # AudioShake API transcription
CORRECTING = "correcting" # Automatic lyrics correction
LYRICS_COMPLETE = "lyrics_complete" # Corrections JSON ready
# Stage 3: Title/End screens
GENERATING_SCREENS = "generating_screens" # Creating title and end screen videos
# Stage 4: Countdown padding (automatic)
APPLYING_PADDING = "applying_padding" # Synchronizing countdown padding
# Stage 5: Human review (BLOCKING)
AWAITING_REVIEW = "awaiting_review" # ⚠️ WAITING FOR USER - lyrics review needed
IN_REVIEW = "in_review" # User is actively reviewing lyrics
REVIEW_COMPLETE = "review_complete" # User submitted corrected lyrics
# Stage 5.5: Render video with corrected lyrics (post-review)
RENDERING_VIDEO = "rendering_video" # Using OutputGenerator to create with_vocals.mkv
# Stage 6: Instrumental selection (BLOCKING)
AWAITING_INSTRUMENTAL_SELECTION = "awaiting_instrumental_selection" # ⚠️ WAITING FOR USER
INSTRUMENTAL_SELECTED = "instrumental_selected" # User made selection
# Stage 7: Video generation and finalization
GENERATING_VIDEO = "generating_video" # Creating initial karaoke video
ENCODING = "encoding" # Multi-format video encoding (Cloud Build)
PACKAGING = "packaging" # CDG/TXT ZIP generation
# Stage 8: Distribution (optional)
UPLOADING = "uploading" # YouTube/Dropbox upload
NOTIFYING = "notifying" # Discord/Email notifications
# Terminal states
COMPLETE = "complete" # All processing finished successfully
PREP_COMPLETE = "prep_complete" # Prep-only job completed (stops after review)
FAILED = "failed" # Unrecoverable error occurred
CANCELLED = "cancelled" # User cancelled the job
# Legacy compatibility (will be removed)
QUEUED = "queued" # Deprecated: use PENDING
PROCESSING = "processing" # Deprecated: use specific states
READY_FOR_FINALIZATION = "ready_for_finalization" # Deprecated
FINALIZING = "finalizing" # Deprecated: use ENCODING/PACKAGING
ERROR = "error" # Deprecated: use FAILED
# Valid state transitions
STATE_TRANSITIONS = {
# PENDING can go to DOWNLOADING (file upload), SEARCHING_AUDIO (artist+title search), or AWAITING_INSTRUMENTAL_SELECTION (finalise-only)
JobStatus.PENDING: [JobStatus.DOWNLOADING, JobStatus.SEARCHING_AUDIO, JobStatus.AWAITING_INSTRUMENTAL_SELECTION, JobStatus.FAILED, JobStatus.CANCELLED],
# Audio search flow (for artist+title search mode)
JobStatus.SEARCHING_AUDIO: [JobStatus.AWAITING_AUDIO_SELECTION, JobStatus.DOWNLOADING_AUDIO, JobStatus.FAILED],
JobStatus.AWAITING_AUDIO_SELECTION: [JobStatus.DOWNLOADING_AUDIO, JobStatus.FAILED, JobStatus.CANCELLED],
JobStatus.DOWNLOADING_AUDIO: [JobStatus.DOWNLOADING, JobStatus.FAILED],
# DOWNLOADING allows parallel processing (audio + lyrics) and then screens when both complete
JobStatus.DOWNLOADING: [JobStatus.SEPARATING_STAGE1, JobStatus.TRANSCRIBING, JobStatus.GENERATING_SCREENS, JobStatus.FAILED],
# Audio separation flow
JobStatus.SEPARATING_STAGE1: [JobStatus.SEPARATING_STAGE2, JobStatus.FAILED],
JobStatus.SEPARATING_STAGE2: [JobStatus.AUDIO_COMPLETE, JobStatus.FAILED],
JobStatus.AUDIO_COMPLETE: [JobStatus.GENERATING_SCREENS, JobStatus.FAILED],
# Lyrics flow
JobStatus.TRANSCRIBING: [JobStatus.CORRECTING, JobStatus.FAILED],
JobStatus.CORRECTING: [JobStatus.LYRICS_COMPLETE, JobStatus.FAILED],
JobStatus.LYRICS_COMPLETE: [JobStatus.GENERATING_SCREENS, JobStatus.FAILED],
# Post-parallel processing
JobStatus.GENERATING_SCREENS: [JobStatus.APPLYING_PADDING, JobStatus.AWAITING_REVIEW, JobStatus.AWAITING_INSTRUMENTAL_SELECTION, JobStatus.FAILED],
JobStatus.APPLYING_PADDING: [JobStatus.AWAITING_REVIEW, JobStatus.FAILED],
# Human review flow
# AWAITING_REVIEW can go directly to REVIEW_COMPLETE (quick review) or to IN_REVIEW (editing)
JobStatus.AWAITING_REVIEW: [JobStatus.IN_REVIEW, JobStatus.REVIEW_COMPLETE, JobStatus.FAILED, JobStatus.CANCELLED],
JobStatus.IN_REVIEW: [JobStatus.REVIEW_COMPLETE, JobStatus.AWAITING_REVIEW, JobStatus.FAILED],
JobStatus.REVIEW_COMPLETE: [JobStatus.RENDERING_VIDEO, JobStatus.PREP_COMPLETE, JobStatus.FAILED], # PREP_COMPLETE for prep-only jobs
# Video rendering (post-review)
JobStatus.RENDERING_VIDEO: [JobStatus.AWAITING_INSTRUMENTAL_SELECTION, JobStatus.PREP_COMPLETE, JobStatus.FAILED],
# Instrumental selection flow
JobStatus.AWAITING_INSTRUMENTAL_SELECTION: [JobStatus.INSTRUMENTAL_SELECTED, JobStatus.FAILED, JobStatus.CANCELLED],
JobStatus.INSTRUMENTAL_SELECTED: [JobStatus.GENERATING_VIDEO, JobStatus.FAILED],
# Video generation flow
JobStatus.GENERATING_VIDEO: [JobStatus.ENCODING, JobStatus.FAILED],
JobStatus.ENCODING: [JobStatus.PACKAGING, JobStatus.COMPLETE, JobStatus.FAILED],
JobStatus.PACKAGING: [JobStatus.UPLOADING, JobStatus.COMPLETE, JobStatus.FAILED],
# Distribution flow
JobStatus.UPLOADING: [JobStatus.NOTIFYING, JobStatus.COMPLETE, JobStatus.FAILED],
JobStatus.NOTIFYING: [JobStatus.COMPLETE, JobStatus.FAILED],
# Terminal states - COMPLETE, PREP_COMPLETE, and CANCELLED have no transitions
# FAILED allows retry transitions to resume from checkpoints
# PREP_COMPLETE allows finalise-only continuation
JobStatus.COMPLETE: [],
JobStatus.PREP_COMPLETE: [JobStatus.AWAITING_INSTRUMENTAL_SELECTION, JobStatus.FAILED], # Finalise-only continues from here
JobStatus.FAILED: [
JobStatus.INSTRUMENTAL_SELECTED, # Retry from video generation
JobStatus.REVIEW_COMPLETE, # Retry from render stage
JobStatus.LYRICS_COMPLETE, # Retry from screens generation
],
JobStatus.CANCELLED: [],
# Legacy states (for backward compatibility)
JobStatus.QUEUED: [JobStatus.PENDING],
JobStatus.PROCESSING: [JobStatus.SEPARATING_STAGE1, JobStatus.TRANSCRIBING],
JobStatus.READY_FOR_FINALIZATION: [JobStatus.GENERATING_VIDEO],
JobStatus.FINALIZING: [JobStatus.ENCODING],
JobStatus.ERROR: [JobStatus.FAILED],
}
class TimelineEvent(BaseModel):
"""Timeline event for job progress tracking."""
status: str
timestamp: str
progress: Optional[int] = None
message: Optional[str] = None
class LogEntry(BaseModel):
"""Worker log entry for debugging and monitoring."""
timestamp: str
level: str # DEBUG, INFO, WARNING, ERROR
worker: str # audio, lyrics, screens, video, render
message: str
class Job(BaseModel):
"""
Complete job data model.
Tracks the full lifecycle of a karaoke generation job from submission
through all 8 stages to completion or failure.
"""
job_id: str
status: JobStatus
progress: int = 0 # 0-100 percentage for UI display
created_at: datetime
updated_at: datetime
# Input data
url: Optional[str] = None # YouTube URL (if provided)
artist: Optional[str] = None
title: Optional[str] = None
filename: Optional[str] = None # Original uploaded filename
input_media_gcs_path: Optional[str] = None # GCS path to uploaded file
# User preferences
enable_cdg: bool = True # Generate CDG+MP3 package
enable_txt: bool = True # Generate TXT+MP3 package
enable_youtube_upload: bool = False # Upload to YouTube
youtube_description: Optional[str] = None # YouTube video description
webhook_url: Optional[str] = None # Webhook for notifications
user_email: Optional[str] = None # Email for notifications
# Style configuration (uploaded files)
style_params_gcs_path: Optional[str] = None # GCS path to style_params.json
style_assets: Dict[str, str] = Field(default_factory=dict)
"""
GCS paths to style asset files:
{
"intro_background": "gs://bucket/jobs/{job_id}/style/intro_bg.png",
"karaoke_background": "gs://bucket/jobs/{job_id}/style/karaoke_bg.png",
"end_background": "gs://bucket/jobs/{job_id}/style/end_bg.png",
"font": "gs://bucket/jobs/{job_id}/style/font.ttf",
"cdg_instrumental_background": "gs://bucket/jobs/{job_id}/style/cdg_instr.png",
"cdg_title_background": "gs://bucket/jobs/{job_id}/style/cdg_title.png",
"cdg_outro_background": "gs://bucket/jobs/{job_id}/style/cdg_outro.png"
}
"""
# Finalisation configuration
brand_prefix: Optional[str] = None # Brand code prefix (e.g., "NOMAD")
discord_webhook_url: Optional[str] = None # Discord notification webhook
youtube_description_template: Optional[str] = None # YouTube description template text
# Distribution configuration (native API - for remote CLI)
dropbox_path: Optional[str] = None # Dropbox folder path for organized output (e.g., "/Karaoke/Tracks-Organized")
gdrive_folder_id: Optional[str] = None # Google Drive folder ID for public share uploads
# Legacy distribution configuration (rclone - for local CLI backward compat)
organised_dir_rclone_root: Optional[str] = None # Deprecated: use dropbox_path instead
# Lyrics configuration (overrides for search/transcription)
lyrics_artist: Optional[str] = None # Override artist name for lyrics search
lyrics_title: Optional[str] = None # Override title for lyrics search
lyrics_file_gcs_path: Optional[str] = None # GCS path to user-provided lyrics file
subtitle_offset_ms: int = 0 # Offset for subtitle timing (positive = delay)
# Audio separation model configuration
clean_instrumental_model: Optional[str] = None # Model for clean instrumental separation
backing_vocals_models: Optional[List[str]] = None # Models for backing vocals separation
other_stems_models: Optional[List[str]] = None # Models for other stems (bass, drums, etc.)
# Existing instrumental configuration (Batch 3)
existing_instrumental_gcs_path: Optional[str] = None # GCS path to user-provided instrumental file
# Audio search configuration (Batch 5 - artist+title search mode)
audio_search_artist: Optional[str] = None # Artist name used for audio search
audio_search_title: Optional[str] = None # Title used for audio search
auto_download: bool = False # Auto-select best audio source (skip selection)
# Two-phase workflow configuration (Batch 6)
prep_only: bool = False # Stop after review, don't run finalisation
finalise_only: bool = False # Skip prep, run only finalisation (requires uploaded prep outputs)
keep_brand_code: Optional[str] = None # Preserve existing brand code instead of generating new one
# Processing state
track_output_dir: Optional[str] = None # Local output directory (temp)
audio_hash: Optional[str] = None # Hash for deduplication
# State-specific data (JSON field for stage-specific metadata)
state_data: Dict[str, Any] = Field(default_factory=dict)
"""
Stage-specific metadata. Examples:
- audio_complete: {"stems": {"clean": "gs://...", "backing": "gs://..."}}
- lyrics_complete: {"corrections_url": "gs://...", "audio_url": "gs://..."}
- review_complete: {"corrected_lyrics": {...}}
- instrumental_selected: {"selection": "clean" | "with_backing"}
- encoding: {"build_id": "...", "progress": 45}
"""
# Timeline tracking
timeline: List[TimelineEvent] = Field(default_factory=list)
# Worker logs for debugging (limited to last N entries to avoid document size issues)
worker_logs: List[LogEntry] = Field(default_factory=list)
# File URLs (GCS storage)
file_urls: Dict[str, Any] = Field(default_factory=dict)
"""
File storage URLs. Structure:
{
"input": "gs://bucket/jobs/{job_id}/input.flac",
"stems": {
"instrumental_clean": "gs://...",
"instrumental_with_backing": "gs://...",
"vocals": "gs://...",
"backing_vocals": "gs://...",
"lead_vocals": "gs://...",
"bass": "gs://...",
"drums": "gs://...",
"guitar": "gs://...",
"piano": "gs://...",
"other": "gs://..."
},
"lyrics": {
"corrections": "gs://bucket/jobs/{job_id}/lyrics/corrections.json",
"audio": "gs://bucket/jobs/{job_id}/lyrics/audio.flac",
"lrc": "gs://...",
"ass": "gs://..."
},
"screens": {
"title": "gs://bucket/jobs/{job_id}/screens/title.mov",
"end": "gs://bucket/jobs/{job_id}/screens/end.mov"
},
"videos": {
"with_vocals": "gs://bucket/jobs/{job_id}/videos/with_vocals.mkv"
},
"finals": {
"lossless_4k_mp4": "gs://...",
"lossless_4k_mkv": "gs://...",
"lossy_4k_mp4": "gs://...",
"lossy_720p_mp4": "gs://..."
},
"packages": {
"cdg_zip": "gs://...",
"txt_zip": "gs://..."
},
"youtube": {
"url": "https://youtube.com/watch?v=...",
"video_id": "..."
}
}
"""
# Results (for backward compatibility, will be deprecated)
output_files: Dict[str, str] = Field(default_factory=dict)
download_urls: Dict[str, str] = Field(default_factory=dict)
# Error handling
error_message: Optional[str] = None
error_details: Optional[Dict[str, Any]] = None # Structured error information
retry_count: int = 0 # Number of retry attempts
# Worker tracking
worker_ids: Dict[str, str] = Field(default_factory=dict)
"""
IDs of background workers/jobs:
{
"audio_worker": "cloud-run-request-id",
"lyrics_worker": "cloud-run-request-id",
"video_encoder": "cloud-build-id",
"distribution": "cloud-run-request-id"
}
"""
# Request metadata (captured at job creation for tracking and filtering)
request_metadata: Dict[str, Any] = Field(default_factory=dict)
"""
Metadata captured from the original API request.
Used for tracking, filtering, and operational management.
Standard fields:
{
"client_ip": "192.168.1.1", # IP address of the client
"user_agent": "karaoke-gen-remote/0.71.0", # User-Agent header
"environment": "test", # From X-Environment header (test/production/development)
"client_id": "cli-user-123", # From X-Client-ID header (customer/user identifier)
"server_version": "0.71.0", # Server version at job creation
"created_from": "upload", # "upload" (file) or "url" (YouTube URL)
"custom_headers": { # All X-* headers for extensibility
"X-Environment": "test",
"X-Client-ID": "cli-user-123",
"X-Request-ID": "abc-123"
}
}
Use cases:
- Filter test vs production jobs
- Track jobs by customer/client
- Debug issues with specific clients
- Bulk cleanup of test jobs
"""
# Note: Status transition validation is handled by JobManager.validate_state_transition()
# which is called before status updates. The Job model does not validate transitions
# because Firestore updates happen directly without reconstructing the model.
class Config:
use_enum_values = True
class JobCreate(BaseModel):
"""
Job creation request.
Either `url` OR file upload is required (file upload handled separately).
Artist and title are optional - will be auto-detected from YouTube if not provided.
"""
url: Optional[str] = None
artist: Optional[str] = None
title: Optional[str] = None
filename: Optional[str] = None # Original uploaded filename
# Optional preferences
enable_cdg: bool = True
enable_txt: bool = True
enable_youtube_upload: bool = False
youtube_description: Optional[str] = None
webhook_url: Optional[str] = None
user_email: Optional[str] = None
# Style configuration (will be populated after file upload)
style_params_gcs_path: Optional[str] = None
style_assets: Dict[str, str] = Field(default_factory=dict)
# Finalisation configuration
brand_prefix: Optional[str] = None
discord_webhook_url: Optional[str] = None
youtube_description_template: Optional[str] = None
# Distribution configuration (native API - for remote CLI)
dropbox_path: Optional[str] = None # Dropbox folder path for organized output
gdrive_folder_id: Optional[str] = None # Google Drive folder ID for public share uploads
# Legacy (rclone - deprecated, use dropbox_path instead)
organised_dir_rclone_root: Optional[str] = None
# Lyrics configuration (overrides for search/transcription)
lyrics_artist: Optional[str] = None # Override artist name for lyrics search
lyrics_title: Optional[str] = None # Override title for lyrics search
lyrics_file_gcs_path: Optional[str] = None # GCS path to user-provided lyrics file
subtitle_offset_ms: int = 0 # Offset for subtitle timing (positive = delay)
# Audio separation model configuration
clean_instrumental_model: Optional[str] = None # Model for clean instrumental separation
backing_vocals_models: Optional[List[str]] = None # Models for backing vocals separation
other_stems_models: Optional[List[str]] = None # Models for other stems (bass, drums, etc.)
# Existing instrumental configuration (Batch 3)
existing_instrumental_gcs_path: Optional[str] = None # GCS path to user-provided instrumental file
# Audio search configuration (Batch 5 - artist+title search mode)
audio_search_artist: Optional[str] = None # Artist name used for audio search
audio_search_title: Optional[str] = None # Title used for audio search
auto_download: bool = False # Auto-select best audio source (skip selection)
# Two-phase workflow configuration (Batch 6)
prep_only: bool = False # Stop after review, don't run finalisation
finalise_only: bool = False # Skip prep, run only finalisation
keep_brand_code: Optional[str] = None # Preserve existing brand code instead of generating new one
# Request metadata (set by API endpoint from request headers)
request_metadata: Dict[str, Any] = Field(default_factory=dict)
"""
Populated by the API endpoint with request context:
- client_ip: Client IP address
- user_agent: User-Agent header
- environment: From X-Environment header (test/production/development)
- client_id: From X-Client-ID header
- server_version: Current server version
- custom_headers: All X-* headers
"""
@validator('url', 'artist', 'title')
def validate_inputs(cls, v):
"""Validate string inputs are not empty."""
if v is not None and isinstance(v, str) and not v.strip():
raise ValueError("Field cannot be empty string")
return v.strip() if isinstance(v, str) else v
class JobResponse(BaseModel):
"""Job response model."""
status: str
job_id: str
message: str
-123
View File
@@ -1,123 +0,0 @@
"""
API request models for karaoke generation endpoints.
"""
from typing import Optional, Dict, Any, List
from pydantic import BaseModel, HttpUrl, validator
class URLSubmissionRequest(BaseModel):
"""Request to submit a job from a URL (YouTube, etc.)."""
url: HttpUrl
artist: Optional[str] = None # Auto-detected if not provided
title: Optional[str] = None # Auto-detected if not provided
# Optional preferences
enable_cdg: bool = True
enable_txt: bool = True
enable_youtube_upload: bool = False
youtube_description: Optional[str] = None
webhook_url: Optional[str] = None
user_email: Optional[str] = None
class UploadSubmissionRequest(BaseModel):
"""Request to submit a job from an uploaded file."""
artist: str
title: str
# Optional preferences
enable_cdg: bool = True
enable_txt: bool = True
enable_youtube_upload: bool = False
youtube_description: Optional[str] = None
webhook_url: Optional[str] = None
user_email: Optional[str] = None
class CorrectionsSubmission(BaseModel):
"""
Request to submit corrected lyrics after human review.
This is the critical human-in-the-loop interaction point.
The corrections data comes from the lyrics-transcriber review interface.
"""
corrections: Dict[str, Any] # Full corrections JSON from frontend
user_notes: Optional[str] = None # Optional notes from reviewer
@validator('corrections')
def validate_corrections_format(cls, v):
"""Validate corrections has required fields."""
required_fields = ['lines', 'metadata']
for field in required_fields:
if field not in v:
raise ValueError(f"Corrections must include '{field}' field")
return v
class InstrumentalSelection(BaseModel):
"""
Request to select instrumental audio option.
This is the second critical human-in-the-loop interaction point.
User chooses between clean instrumental, instrumental with backing vocals,
or a custom instrumental (created via create-custom-instrumental endpoint).
"""
selection: str # "clean", "with_backing", or "custom"
@validator('selection')
def validate_selection(cls, v):
"""Validate selection is a valid option."""
valid_options = ['clean', 'with_backing', 'custom']
if v not in valid_options:
raise ValueError(f"Selection must be one of: {valid_options}")
return v
class MuteRegionRequest(BaseModel):
"""A region to mute in the backing vocals."""
start_seconds: float
end_seconds: float
@validator('start_seconds')
def validate_start(cls, v):
if v < 0:
raise ValueError("start_seconds must be non-negative")
return v
@validator('end_seconds')
def validate_end(cls, v, values):
if 'start_seconds' in values and v <= values['start_seconds']:
raise ValueError("end_seconds must be greater than start_seconds")
return v
class CreateCustomInstrumentalRequest(BaseModel):
"""
Request to create a custom instrumental with muted backing vocal regions.
The mute_regions specify time ranges in the backing vocals track that
should be silenced before mixing with the clean instrumental.
"""
mute_regions: List[MuteRegionRequest]
@validator('mute_regions')
def validate_regions(cls, v):
if not v:
raise ValueError("At least one mute region is required")
return v
class StartReviewRequest(BaseModel):
"""Request to mark job as in-review (user opened interface)."""
pass # No body needed, just triggers state transition
class CancelJobRequest(BaseModel):
"""Request to cancel a job."""
reason: Optional[str] = None
class RetryJobRequest(BaseModel):
"""Request to retry a failed job."""
from_stage: Optional[str] = None # Optional: restart from specific stage
-29
View File
@@ -1,29 +0,0 @@
[tool.pytest.ini_options]
testpaths = ["tests"]
python_files = ["test_*.py"]
python_classes = ["Test*"]
python_functions = ["test_*"]
addopts = [
"-v",
"--tb=short",
"--strict-markers",
"-ra",
]
markers = [
"slow: marks tests as slow (deselect with '-m \"not slow\"')",
"integration: marks tests as integration tests requiring live service",
]
# Timeout for slow tests (in seconds)
timeout = 300
[tool.coverage.run]
source = ["backend"]
omit = ["*/tests/*", "*/test_*"]
[tool.coverage.report]
precision = 2
show_missing = true
skip_covered = false
-93
View File
@@ -1,93 +0,0 @@
#!/bin/bash
# Quick syntax and structure check (no dependencies required)
# Run this before every deployment!
set -e
echo "🔍 Quick Backend Check (no dependencies required)"
echo "=================================================="
echo ""
# Change to backend directory
cd "$(dirname "$0")"
# Colors
RED='\033[0;31m'
GREEN='\033[0;32m'
NC='\033[0m'
ERRORS=0
# Check 1: Python syntax
echo "1. Checking Python syntax..."
for file in $(find . -name "*.py" -not -path "./__pycache__/*" -not -path "./venv/*"); do
if ! python3 -m py_compile "$file" 2>/dev/null; then
echo -e " ${RED}❌ Syntax error in $file${NC}"
python3 -m py_compile "$file"
ERRORS=$((ERRORS+1))
fi
done
if [ $ERRORS -eq 0 ]; then
echo -e " ${GREEN}✅ All Python files have valid syntax${NC}"
fi
# Check 2: No missing imports (basic check)
echo ""
echo "2. Checking for obvious import issues..."
# Check that we don't import deleted modules
if grep -r "from backend.services.processing_service import" --include="*.py" . 2>/dev/null; then
echo -e " ${RED}❌ Found import of deleted processing_service${NC}"
ERRORS=$((ERRORS+1))
else
echo -e " ${GREEN}✅ No imports of deleted modules${NC}"
fi
# Check 3: Required files exist
echo ""
echo "3. Checking required files exist..."
REQUIRED_FILES=(
"main.py"
"config.py"
"requirements.txt"
"Dockerfile"
"api/routes/health.py"
"api/routes/jobs.py"
"api/routes/internal.py"
"api/routes/file_upload.py"
"services/job_manager.py"
"services/firestore_service.py"
"services/storage_service.py"
"services/worker_service.py"
"services/auth_service.py"
"workers/audio_worker.py"
"workers/lyrics_worker.py"
"workers/screens_worker.py"
"workers/video_worker.py"
"models/job.py"
"models/requests.py"
)
for file in "${REQUIRED_FILES[@]}"; do
if [ ! -f "$file" ]; then
echo -e " ${RED}❌ Missing required file: $file${NC}"
ERRORS=$((ERRORS+1))
fi
done
if [ $ERRORS -eq 0 ]; then
echo -e " ${GREEN}✅ All required files exist${NC}"
fi
# Summary
echo ""
echo "=================================================="
if [ $ERRORS -eq 0 ]; then
echo -e "${GREEN}✅ All checks passed! Safe to deploy.${NC}"
exit 0
else
echo -e "${RED}❌ $ERRORS error(s) found. Fix before deploying!${NC}"
exit 1
fi
-29
View File
@@ -1,29 +0,0 @@
# DEPRECATED: This file is no longer used for Docker builds or CI.
# Docker and CI both use poetry/pyproject.toml directly.
# This file is kept for reference only.
fastapi>=0.104.0,<1.0.0
uvicorn[standard]>=0.24.0,<1.0.0
pydantic>=2.5.0,<3.0.0
pydantic-settings>=2.1.0,<3.0.0
python-multipart>=0.0.6,<1.0.0
httpx>=0.25.0,<1.0.0
google-cloud-firestore>=2.14.0,<3.0.0
google-cloud-storage>=2.14.0,<3.0.0
google-cloud-secret-manager>=2.18.0,<3.0.0
google-cloud-tasks>=2.14.0,<3.0.0
google-cloud-run>=0.10.0,<1.0.0
python-dotenv>=1.0.0,<2.0.0
# Audio processing (reuses karaoke_gen library)
audio-separator[remote]>=0.18.0 # Remote Modal API client
pydub>=0.25.1 # Audio manipulation (used by karaoke_gen)
yt-dlp>=2024.0.0 # YouTube downloads (future use)
# Cloud storage native APIs
dropbox>=11.0.0 # Dropbox Python SDK for native API access
# google-api-python-client already installed via karaoke_gen for YouTube
# karaoke-gen dependencies (will be installed from parent dir in Dockerfile)
# Using explicit dependencies instead of -e ../
-60
View File
@@ -1,60 +0,0 @@
#!/bin/bash
# Backend Test Runner
# Runs integration tests against the deployed Cloud Run service
set -e
echo "🧪 Backend Integration Test Suite"
echo "=================================="
echo ""
# Check prerequisites
echo "Checking prerequisites..."
if ! command -v gcloud &> /dev/null; then
echo "❌ gcloud CLI not found. Please install Google Cloud SDK."
exit 1
fi
if ! command -v pytest &> /dev/null; then
echo "❌ pytest not found. Installing test dependencies..."
pip install -r tests/requirements.txt
fi
# Verify authentication
echo "Verifying authentication..."
if ! gcloud auth print-identity-token &> /dev/null; then
echo "❌ Not authenticated with gcloud. Run: gcloud auth login"
exit 1
fi
echo "✅ Prerequisites met"
echo ""
# Run tests
echo "Running integration tests..."
echo ""
# Run fast tests (no slow marker)
echo "📝 Running fast tests..."
pytest tests/test_api_integration.py -v -m "not slow" --tb=short
echo ""
echo "✅ Fast tests complete!"
echo ""
# Ask if user wants to run slow tests
read -p "Run slow/integration tests? These test actual job processing (5-10 min). [y/N] " -n 1 -r
echo
if [[ $REPLY =~ ^[Yy]$ ]]; then
echo "🐌 Running slow integration tests..."
pytest tests/test_api_integration.py -v -m "slow" --tb=short
echo ""
echo "✅ All tests complete!"
else
echo "⏭️ Skipping slow tests"
fi
echo ""
echo "=================================="
echo "Test run complete! 🎉"
View File
Whitespace-only changes.
-243
View File
@@ -1,243 +0,0 @@
"""
Audio analysis service for analyzing backing vocals.
This service wraps the shared karaoke_gen.instrumental_review module
to provide GCS-integrated audio analysis capabilities.
"""
import logging
import os
import tempfile
from typing import Optional
from backend.services.storage_service import StorageService
from karaoke_gen.instrumental_review import (
AudioAnalyzer,
AnalysisResult,
WaveformGenerator,
)
logger = logging.getLogger(__name__)
class AudioAnalysisService:
"""
Service for analyzing backing vocals audio files stored in GCS.
This service acts as a thin wrapper around the shared AudioAnalyzer
and WaveformGenerator classes, handling GCS download/upload operations.
The actual analysis logic is in the shared karaoke_gen.instrumental_review
module, ensuring feature parity between local and remote workflows.
"""
def __init__(
self,
storage_service: Optional[StorageService] = None,
silence_threshold_db: float = -40.0,
min_segment_duration_ms: int = 100,
):
"""
Initialize the audio analysis service.
Args:
storage_service: GCS storage service. If not provided, a new
instance will be created.
silence_threshold_db: Threshold for considering audio as silent.
Default is -40.0 dB.
min_segment_duration_ms: Minimum duration for audible segments.
Default is 100ms.
"""
self.storage_service = storage_service or StorageService()
self.analyzer = AudioAnalyzer(
silence_threshold_db=silence_threshold_db,
min_segment_duration_ms=min_segment_duration_ms,
)
self.waveform_generator = WaveformGenerator()
def analyze_backing_vocals(
self,
gcs_audio_path: str,
job_id: str,
) -> AnalysisResult:
"""
Analyze a backing vocals audio file from GCS.
This method:
1. Downloads the audio file from GCS to a temp file
2. Runs the analysis using the shared AudioAnalyzer
3. Returns the analysis result
Args:
gcs_audio_path: Path to the audio file in GCS
job_id: Job ID for logging
Returns:
AnalysisResult containing analysis data
"""
logger.info(f"[{job_id}] Analyzing backing vocals: {gcs_audio_path}")
with tempfile.TemporaryDirectory() as temp_dir:
# Download audio file
local_audio_path = os.path.join(temp_dir, "backing_vocals.flac")
self.storage_service.download_file(gcs_audio_path, local_audio_path)
# Run analysis
result = self.analyzer.analyze(local_audio_path)
logger.info(
f"[{job_id}] Analysis complete: "
f"has_audible={result.has_audible_content}, "
f"segments={result.segment_count}, "
f"recommendation={result.recommended_selection.value}"
)
return result
def analyze_and_generate_waveform(
self,
gcs_audio_path: str,
job_id: str,
gcs_waveform_destination: str,
) -> tuple[AnalysisResult, str]:
"""
Analyze backing vocals and generate a waveform image.
This method:
1. Downloads the audio file from GCS
2. Runs analysis using AudioAnalyzer
3. Generates waveform image using WaveformGenerator
4. Uploads the waveform image to GCS
5. Returns analysis result and waveform GCS path
Args:
gcs_audio_path: Path to the audio file in GCS
job_id: Job ID for logging
gcs_waveform_destination: Where to upload the waveform image in GCS
Returns:
Tuple of (AnalysisResult, waveform_gcs_path)
"""
logger.info(f"[{job_id}] Analyzing and generating waveform: {gcs_audio_path}")
with tempfile.TemporaryDirectory() as temp_dir:
# Download audio file
local_audio_path = os.path.join(temp_dir, "backing_vocals.flac")
self.storage_service.download_file(gcs_audio_path, local_audio_path)
# Run analysis
result = self.analyzer.analyze(local_audio_path)
# Generate waveform
local_waveform_path = os.path.join(temp_dir, "waveform.png")
self.waveform_generator.generate(
audio_path=local_audio_path,
output_path=local_waveform_path,
segments=result.audible_segments,
show_time_axis=True,
silence_threshold_db=self.analyzer.silence_threshold_db,
)
# Upload waveform to GCS
self.storage_service.upload_file(
local_waveform_path,
gcs_waveform_destination
)
logger.info(
f"[{job_id}] Analysis and waveform generation complete. "
f"Waveform uploaded to: {gcs_waveform_destination}"
)
return result, gcs_waveform_destination
def get_waveform_data(
self,
gcs_audio_path: str,
job_id: str,
num_points: int = 500,
) -> tuple[list[float], float]:
"""
Get waveform data (amplitude envelope) for client-side rendering.
This is useful when the frontend wants to render the waveform
itself using Canvas or SVG, rather than displaying a pre-generated
image.
Args:
gcs_audio_path: Path to the audio file in GCS
job_id: Job ID for logging
num_points: Number of data points to return
Returns:
Tuple of (amplitude_values, duration_seconds)
"""
logger.info(f"[{job_id}] Getting waveform data: {gcs_audio_path}")
with tempfile.TemporaryDirectory() as temp_dir:
# Download audio file
local_audio_path = os.path.join(temp_dir, "backing_vocals.flac")
self.storage_service.download_file(gcs_audio_path, local_audio_path)
# Generate waveform data
amplitudes, duration = self.waveform_generator.generate_data_only(
audio_path=local_audio_path,
num_points=num_points,
)
return amplitudes, duration
def generate_waveform_with_mutes(
self,
gcs_audio_path: str,
job_id: str,
gcs_waveform_destination: str,
mute_regions: list,
) -> str:
"""
Generate a waveform image with mute regions highlighted.
This is useful for showing the user which regions will be muted
in the custom instrumental.
Args:
gcs_audio_path: Path to the audio file in GCS
job_id: Job ID for logging
gcs_waveform_destination: Where to upload the waveform image
mute_regions: List of MuteRegion objects to highlight
Returns:
GCS path to the uploaded waveform image
"""
from karaoke_gen.instrumental_review import MuteRegion
logger.info(
f"[{job_id}] Generating waveform with {len(mute_regions)} mute regions"
)
with tempfile.TemporaryDirectory() as temp_dir:
# Download audio file
local_audio_path = os.path.join(temp_dir, "backing_vocals.flac")
self.storage_service.download_file(gcs_audio_path, local_audio_path)
# First run analysis to get segments
result = self.analyzer.analyze(local_audio_path)
# Generate waveform with mute regions
local_waveform_path = os.path.join(temp_dir, "waveform_with_mutes.png")
self.waveform_generator.generate(
audio_path=local_audio_path,
output_path=local_waveform_path,
segments=result.audible_segments,
mute_regions=mute_regions,
show_time_axis=True,
)
# Upload to GCS
self.storage_service.upload_file(
local_waveform_path,
gcs_waveform_destination
)
return gcs_waveform_destination
-278
View File
@@ -1,278 +0,0 @@
"""
Audio editing service for creating custom instrumentals.
This service wraps the shared karaoke_gen.instrumental_review module
to provide GCS-integrated audio editing capabilities.
"""
import logging
import os
import tempfile
from typing import List, Optional
from backend.services.storage_service import StorageService
from karaoke_gen.instrumental_review import (
AudioEditor,
MuteRegion,
)
from karaoke_gen.instrumental_review.models import CustomInstrumentalResult
logger = logging.getLogger(__name__)
class AudioEditingService:
"""
Service for creating custom instrumental tracks with GCS integration.
This service acts as a thin wrapper around the shared AudioEditor
class, handling GCS download/upload operations.
The actual editing logic is in the shared karaoke_gen.instrumental_review
module, ensuring feature parity between local and remote workflows.
"""
def __init__(
self,
storage_service: Optional[StorageService] = None,
output_format: str = "flac",
):
"""
Initialize the audio editing service.
Args:
storage_service: GCS storage service. If not provided, a new
instance will be created.
output_format: Output audio format. Default is "flac".
"""
self.storage_service = storage_service or StorageService()
self.editor = AudioEditor(output_format=output_format)
def create_custom_instrumental(
self,
gcs_clean_instrumental_path: str,
gcs_backing_vocals_path: str,
mute_regions: List[MuteRegion],
gcs_output_path: str,
job_id: str,
) -> CustomInstrumentalResult:
"""
Create a custom instrumental by muting regions of backing vocals.
This method:
1. Downloads clean instrumental and backing vocals from GCS
2. Applies mute regions to backing vocals
3. Combines with clean instrumental
4. Uploads result to GCS
Args:
gcs_clean_instrumental_path: Path to clean instrumental in GCS
gcs_backing_vocals_path: Path to backing vocals in GCS
mute_regions: List of regions to mute in backing vocals
gcs_output_path: Where to upload the custom instrumental in GCS
job_id: Job ID for logging
Returns:
CustomInstrumentalResult with details about the created file
"""
logger.info(
f"[{job_id}] Creating custom instrumental with "
f"{len(mute_regions)} mute regions"
)
with tempfile.TemporaryDirectory() as temp_dir:
# Download input files
local_clean_path = os.path.join(temp_dir, "clean_instrumental.flac")
local_backing_path = os.path.join(temp_dir, "backing_vocals.flac")
local_output_path = os.path.join(temp_dir, "custom_instrumental.flac")
logger.debug(f"[{job_id}] Downloading clean instrumental")
self.storage_service.download_file(
gcs_clean_instrumental_path,
local_clean_path
)
logger.debug(f"[{job_id}] Downloading backing vocals")
self.storage_service.download_file(
gcs_backing_vocals_path,
local_backing_path
)
# Create custom instrumental using shared editor
result = self.editor.create_custom_instrumental(
clean_instrumental_path=local_clean_path,
backing_vocals_path=local_backing_path,
mute_regions=mute_regions,
output_path=local_output_path,
)
# Upload result to GCS
logger.debug(f"[{job_id}] Uploading custom instrumental to GCS")
self.storage_service.upload_file(local_output_path, gcs_output_path)
# Update result with GCS path
result.output_path = gcs_output_path
logger.info(
f"[{job_id}] Custom instrumental created: {gcs_output_path}, "
f"muted {result.total_muted_duration_seconds:.1f}s across "
f"{len(result.mute_regions_applied)} regions"
)
return result
def create_preview(
self,
gcs_clean_instrumental_path: str,
gcs_backing_vocals_path: str,
mute_regions: List[MuteRegion],
gcs_preview_path: str,
job_id: str,
preview_duration_seconds: Optional[float] = None,
) -> str:
"""
Create a preview of the custom instrumental.
This is similar to create_custom_instrumental but optimized for
quick preview generation (optionally truncated duration).
Args:
gcs_clean_instrumental_path: Path to clean instrumental in GCS
gcs_backing_vocals_path: Path to backing vocals in GCS
mute_regions: List of regions to mute
gcs_preview_path: Where to upload the preview in GCS
job_id: Job ID for logging
preview_duration_seconds: Optional max duration for preview
Returns:
GCS path to the uploaded preview
"""
logger.info(f"[{job_id}] Creating preview with {len(mute_regions)} mute regions")
with tempfile.TemporaryDirectory() as temp_dir:
# Download input files
local_clean_path = os.path.join(temp_dir, "clean_instrumental.flac")
local_backing_path = os.path.join(temp_dir, "backing_vocals.flac")
local_preview_path = os.path.join(temp_dir, "preview.flac")
self.storage_service.download_file(
gcs_clean_instrumental_path,
local_clean_path
)
self.storage_service.download_file(
gcs_backing_vocals_path,
local_backing_path
)
# Generate preview
from pydub import AudioSegment
preview = self.editor.preview_with_mutes(
clean_instrumental_path=local_clean_path,
backing_vocals_path=local_backing_path,
mute_regions=mute_regions,
)
# Optionally truncate
if preview_duration_seconds:
max_ms = int(preview_duration_seconds * 1000)
preview = preview[:max_ms]
# Export and upload
preview.export(local_preview_path, format="flac")
self.storage_service.upload_file(local_preview_path, gcs_preview_path)
logger.info(f"[{job_id}] Preview created: {gcs_preview_path}")
return gcs_preview_path
def mute_backing_vocals_only(
self,
gcs_backing_vocals_path: str,
mute_regions: List[MuteRegion],
gcs_output_path: str,
job_id: str,
) -> str:
"""
Apply mute regions to backing vocals without combining with instrumental.
This is useful for creating an edited backing vocals track that
can be combined with the instrumental later.
Args:
gcs_backing_vocals_path: Path to backing vocals in GCS
mute_regions: List of regions to mute
gcs_output_path: Where to upload the edited backing vocals
job_id: Job ID for logging
Returns:
GCS path to the uploaded edited backing vocals
"""
logger.info(
f"[{job_id}] Muting backing vocals with {len(mute_regions)} regions"
)
with tempfile.TemporaryDirectory() as temp_dir:
local_backing_path = os.path.join(temp_dir, "backing_vocals.flac")
local_output_path = os.path.join(temp_dir, "muted_backing.flac")
self.storage_service.download_file(
gcs_backing_vocals_path,
local_backing_path
)
self.editor.apply_mute_to_single_track(
audio_path=local_backing_path,
mute_regions=mute_regions,
output_path=local_output_path,
)
self.storage_service.upload_file(local_output_path, gcs_output_path)
logger.info(f"[{job_id}] Muted backing vocals: {gcs_output_path}")
return gcs_output_path
def validate_mute_regions(
self,
mute_regions: List[MuteRegion],
total_duration_seconds: float,
) -> List[str]:
"""
Validate mute regions for consistency.
Args:
mute_regions: List of mute regions to validate
total_duration_seconds: Total duration of the audio
Returns:
List of validation error messages (empty if valid)
"""
errors = []
for i, region in enumerate(mute_regions):
if region.start_seconds < 0:
errors.append(
f"Region {i}: start_seconds ({region.start_seconds}) cannot be negative"
)
if region.end_seconds <= region.start_seconds:
errors.append(
f"Region {i}: end_seconds ({region.end_seconds}) must be after "
f"start_seconds ({region.start_seconds})"
)
if region.start_seconds > total_duration_seconds:
errors.append(
f"Region {i}: start_seconds ({region.start_seconds}) exceeds "
f"audio duration ({total_duration_seconds})"
)
if region.end_seconds > total_duration_seconds:
# Not an error, but log a warning - the region will be clamped
logger.warning(
f"Region {i}: end_seconds ({region.end_seconds}) exceeds "
f"audio duration ({total_duration_seconds}), will be clamped"
)
return errors
-348
View File
@@ -1,348 +0,0 @@
"""
Audio search service for finding and downloading audio files.
This service integrates with flacfetch to search for audio from various sources
(YouTube, music trackers, etc.) and download the selected audio file.
"""
import logging
import os
import tempfile
from dataclasses import dataclass, asdict
from typing import List, Optional, Dict, Any
logger = logging.getLogger(__name__)
@dataclass
class AudioSearchResult:
"""
Represents a single search result for audio.
This is a serializable representation of a search result that can be
stored in Firestore and sent to clients.
"""
title: str
artist: str
provider: str
url: str
duration: Optional[int] = None # Duration in seconds
quality: Optional[str] = None # e.g., "FLAC", "320kbps", etc.
source_id: Optional[str] = None # Unique ID from the source
index: int = 0 # Index in the results list (for selection)
def to_dict(self) -> Dict[str, Any]:
"""Convert to dict for JSON serialization."""
return asdict(self)
@classmethod
def from_dict(cls, data: Dict[str, Any]) -> "AudioSearchResult":
"""Create from dict."""
return cls(**data)
@dataclass
class AudioDownloadResult:
"""Result of downloading an audio file."""
filepath: str
artist: str
title: str
provider: str
duration: Optional[int] = None
quality: Optional[str] = None
class AudioSearchError(Exception):
"""Base exception for audio search errors."""
pass
class NoResultsError(AudioSearchError):
"""Raised when no search results are found."""
pass
class DownloadError(AudioSearchError):
"""Raised when download fails."""
pass
class AudioSearchService:
"""
Service for searching and downloading audio files using flacfetch.
This service is used by the backend to:
1. Search for audio by artist/title
2. Return results for user selection
3. Download the selected audio to a local file
"""
# Sentinel value to indicate "use environment variable"
_USE_ENV = object()
def __init__(
self,
redacted_api_key: Optional[str] = _USE_ENV,
ops_api_key: Optional[str] = _USE_ENV,
):
"""
Initialize the audio search service.
Args:
redacted_api_key: API key for Redacted tracker (optional, uses env if not provided)
ops_api_key: API key for OPS tracker (optional, uses env if not provided)
"""
# Use environment variables if not explicitly provided
if redacted_api_key is self._USE_ENV:
self._redacted_api_key = os.environ.get("REDACTED_API_KEY")
else:
self._redacted_api_key = redacted_api_key
if ops_api_key is self._USE_ENV:
self._ops_api_key = os.environ.get("OPS_API_KEY")
else:
self._ops_api_key = ops_api_key
self._manager = None
self._raw_results = {} # Cache raw results for download
def _get_manager(self):
"""Lazily initialize and return the FetchManager."""
if self._manager is None:
try:
from flacfetch.core.manager import FetchManager
from flacfetch.providers.youtube import YouTubeProvider
except ImportError as e:
logger.error(f"flacfetch not installed: {e}")
raise AudioSearchError(
"flacfetch library is not installed. "
"Install with: pip install flacfetch"
) from e
self._manager = FetchManager()
# Add providers based on available API keys
if self._redacted_api_key:
try:
from flacfetch.providers.redacted import RedactedProvider
self._manager.add_provider(RedactedProvider(api_key=self._redacted_api_key))
logger.debug("Added Redacted provider")
except ImportError:
logger.warning("Redacted provider not available")
if self._ops_api_key:
try:
from flacfetch.providers.ops import OPSProvider
self._manager.add_provider(OPSProvider(api_key=self._ops_api_key))
logger.debug("Added OPS provider")
except ImportError:
logger.warning("OPS provider not available")
# Always add YouTube as a fallback provider
self._manager.add_provider(YouTubeProvider())
logger.debug("Added YouTube provider")
return self._manager
def search(self, artist: str, title: str) -> List[AudioSearchResult]:
"""
Search for audio matching the given artist and title.
Args:
artist: The artist name to search for
title: The track title to search for
Returns:
List of AudioSearchResult objects
Raises:
NoResultsError: If no results are found
AudioSearchError: For other errors
"""
try:
from flacfetch.core.models import TrackQuery
except ImportError as e:
raise AudioSearchError("flacfetch not installed") from e
manager = self._get_manager()
query = TrackQuery(artist=artist, title=title)
logger.info(f"Searching for audio: {artist} - {title}")
try:
results = manager.search(query)
except Exception as e:
logger.error(f"Search failed: {e}")
raise AudioSearchError(f"Search failed: {e}") from e
if not results:
raise NoResultsError(f"No results found for: {artist} - {title}")
# Convert to our AudioSearchResult format and cache raw results
search_results = []
self._raw_results.clear()
for i, result in enumerate(results):
search_result = AudioSearchResult(
title=getattr(result, "title", title),
artist=getattr(result, "artist", artist),
provider=getattr(result, "provider", "Unknown"),
url=getattr(result, "url", ""),
duration=getattr(result, "duration", None),
quality=getattr(result, "quality", None),
source_id=getattr(result, "id", str(i)),
index=i,
)
search_results.append(search_result)
# Cache raw result for later download
self._raw_results[i] = result
logger.info(f"Found {len(search_results)} results for: {artist} - {title}")
return search_results
def select_best(self, results: List[AudioSearchResult]) -> int:
"""
Select the best result from a list of search results.
Uses flacfetch's built-in quality ranking to select the best source.
Args:
results: List of search results
Returns:
Index of the best result
"""
if not results:
return 0
manager = self._get_manager()
# Get raw results for the indices we have
raw_results = [self._raw_results.get(r.index) for r in results if r.index in self._raw_results]
if raw_results:
try:
best = manager.select_best(raw_results)
# Find index of best result
for i, raw in enumerate(raw_results):
if raw == best:
return results[i].index
except Exception as e:
logger.warning(f"select_best failed, using first result: {e}")
# Fallback: return first result
return results[0].index if results else 0
def download(
self,
result_index: int,
output_dir: str,
output_filename: Optional[str] = None,
) -> AudioDownloadResult:
"""
Download audio from a search result.
Args:
result_index: Index of the result to download (from search results)
output_dir: Directory to save the downloaded file
output_filename: Optional filename (without extension)
Returns:
AudioDownloadResult with the downloaded file path
Raises:
DownloadError: If download fails
"""
if result_index not in self._raw_results:
raise DownloadError(f"No cached result for index {result_index}. Run search() first.")
raw_result = self._raw_results[result_index]
manager = self._get_manager()
# Ensure output directory exists
os.makedirs(output_dir, exist_ok=True)
# Get metadata from raw result
artist = getattr(raw_result, "artist", "Unknown")
title = getattr(raw_result, "title", "Unknown")
provider = getattr(raw_result, "provider", "Unknown")
# Generate filename if not provided
if output_filename is None:
output_filename = f"{artist} - {title}"
logger.info(f"Downloading: {artist} - {title} from {provider}")
try:
filepath = manager.download(
raw_result,
output_path=output_dir,
output_filename=output_filename,
)
if filepath is None:
raise DownloadError(f"Download returned no file path for: {artist} - {title}")
logger.info(f"Downloaded to: {filepath}")
return AudioDownloadResult(
filepath=filepath,
artist=artist,
title=title,
provider=provider,
duration=getattr(raw_result, "duration", None),
quality=getattr(raw_result, "quality", None),
)
except Exception as e:
raise DownloadError(f"Failed to download {artist} - {title}: {e}") from e
def search_and_download_auto(
self,
artist: str,
title: str,
output_dir: str,
output_filename: Optional[str] = None,
) -> AudioDownloadResult:
"""
Search for audio and automatically download the best result.
This is a convenience method that combines search(), select_best(),
and download() for automated/non-interactive usage.
Args:
artist: The artist name to search for
title: The track title to search for
output_dir: Directory to save the downloaded file
output_filename: Optional filename (without extension)
Returns:
AudioDownloadResult with the downloaded file path
Raises:
NoResultsError: If no results are found
DownloadError: If download fails
"""
# Search
results = self.search(artist, title)
# Select best
best_index = self.select_best(results)
logger.info(f"Auto-selected result {best_index}: {results[best_index].artist} - {results[best_index].title} ({results[best_index].provider})")
# Download
return self.download(best_index, output_dir, output_filename)
# Singleton instance
_audio_search_service: Optional[AudioSearchService] = None
def get_audio_search_service() -> AudioSearchService:
"""Get the singleton AudioSearchService instance."""
global _audio_search_service
if _audio_search_service is None:
_audio_search_service = AudioSearchService()
return _audio_search_service
-285
View File
@@ -1,285 +0,0 @@
"""
Authentication service for karaoke backend.
Provides token-based authentication with support for:
- Admin tokens (hardcoded in environment)
- User tokens (stored in Firestore)
- Usage tracking and limits
- Token management API
This is designed to be extensible for future Stripe integration
and admin dashboard functionality.
"""
import logging
import hashlib
import time
from enum import Enum
from typing import Optional, Tuple, Dict, Any
from datetime import datetime
from backend.services.firestore_service import FirestoreService
from backend.config import get_settings
logger = logging.getLogger(__name__)
class UserType(str, Enum):
"""User access levels."""
ADMIN = "admin" # Unlimited access, can manage tokens
UNLIMITED = "unlimited" # Unlimited karaoke generation
LIMITED = "limited" # Limited number of uses
STRIPE = "stripe" # Paid access via Stripe (future)
class AuthService:
"""Service for authentication and token management."""
def __init__(self):
"""Initialize auth service."""
self.firestore = FirestoreService()
self.settings = get_settings()
self._init_admin_tokens()
def _init_admin_tokens(self):
"""Load admin tokens from environment variables."""
# Get admin tokens from secret manager or env vars
admin_tokens_str = self.settings.admin_tokens or ""
self.admin_tokens = [t.strip() for t in admin_tokens_str.split(",") if t.strip()]
if self.admin_tokens:
logger.info(f"Loaded {len(self.admin_tokens)} admin token(s)")
else:
logger.warning("No admin tokens configured! Set ADMIN_TOKENS environment variable.")
def validate_token(self, token: str) -> Tuple[bool, UserType, int, str]:
"""
Validate an access token.
Returns:
(is_valid, user_type, remaining_uses, message)
remaining_uses: -1 = unlimited, 0 = exhausted, >0 = remaining count
"""
if not token:
return False, UserType.LIMITED, 0, "No token provided"
# Check for admin tokens (highest priority)
if token in self.admin_tokens:
logger.info("Admin token validated")
return True, UserType.ADMIN, -1, "Admin access granted"
# Check stored tokens in Firestore
token_data = self.firestore.get_token(token)
if not token_data:
return False, UserType.LIMITED, 0, "Invalid token"
# Check if token is active
if not token_data.get("active", True):
return False, UserType(token_data["type"]), 0, "Token has been revoked"
token_type = UserType(token_data["type"])
max_uses = token_data.get("max_uses", -1)
# UNLIMITED tokens: no usage limits
if token_type == UserType.UNLIMITED:
return True, token_type, -1, "Unlimited access granted"
# LIMITED tokens: check usage count
if token_type == UserType.LIMITED:
if max_uses <= 0: # -1 means unlimited
return True, token_type, -1, "Limited token with unlimited uses"
current_uses = token_data.get("usage_count", 0)
remaining = max_uses - current_uses
if remaining <= 0:
return False, token_type, 0, "Token usage limit exceeded"
return True, token_type, remaining, f"Limited token: {remaining} uses remaining"
# STRIPE tokens: check expiration and usage
if token_type == UserType.STRIPE:
expires_at = token_data.get("expires_at")
if expires_at:
# expires_at is stored as timestamp
if time.time() > expires_at:
return False, token_type, 0, "Token has expired"
if max_uses > 0:
current_uses = token_data.get("usage_count", 0)
remaining = max_uses - current_uses
if remaining <= 0:
return False, token_type, 0, "Token usage limit exceeded"
return True, token_type, remaining, f"Stripe token: {remaining} uses remaining"
return True, token_type, -1, "Stripe access granted"
return False, UserType.LIMITED, 0, "Unknown token type"
def increment_token_usage(self, token: str, job_id: str) -> bool:
"""
Increment usage count for a token and track the job.
Args:
token: The access token
job_id: The job ID being created
Returns:
True if usage was tracked, False otherwise
"""
# Validate token first
is_valid, user_type, remaining_uses, message = self.validate_token(token)
if not is_valid:
logger.warning(f"Cannot increment usage for invalid token: {message}")
return False
# Don't track usage for admin or unlimited tokens
if user_type in [UserType.ADMIN, UserType.UNLIMITED]:
logger.debug(f"Skipping usage tracking for {user_type} token")
return True
# For admin tokens (not in Firestore), no tracking needed
if token in self.admin_tokens:
return True
# Increment usage in Firestore
try:
self.firestore.increment_token_usage(token, job_id)
logger.info(f"Incremented usage for token (remaining: {remaining_uses - 1})")
return True
except Exception as e:
logger.error(f"Failed to increment token usage: {e}")
return False
def create_token(
self,
token_value: str,
token_type: UserType,
max_uses: int = -1,
expires_at: Optional[float] = None,
created_by: Optional[str] = None
) -> Dict[str, Any]:
"""
Create a new access token.
Args:
token_value: The actual token string (should be secure random string)
token_type: Type of access (admin, unlimited, limited, stripe)
max_uses: Maximum number of uses (-1 = unlimited)
expires_at: Expiration timestamp (None = no expiration)
created_by: Admin token that created this token
Returns:
Token data dictionary
"""
token_data = {
"token": token_value,
"type": token_type.value,
"max_uses": max_uses,
"usage_count": 0,
"active": True,
"created_at": time.time(),
"created_by": created_by,
"expires_at": expires_at,
"jobs": []
}
self.firestore.create_token(token_value, token_data)
logger.info(f"Created new {token_type} token with max_uses={max_uses}")
return token_data
def revoke_token(self, token: str, revoked_by: Optional[str] = None) -> bool:
"""
Revoke an access token.
Args:
token: The token to revoke
revoked_by: Admin token that revoked this token
Returns:
True if revoked, False if token not found
"""
try:
self.firestore.update_token(token, {
"active": False,
"revoked_at": time.time(),
"revoked_by": revoked_by
})
logger.info(f"Revoked token")
return True
except Exception as e:
logger.error(f"Failed to revoke token: {e}")
return False
def list_tokens(self, include_inactive: bool = False) -> list:
"""
List all tokens (admin only).
Args:
include_inactive: Whether to include revoked tokens
Returns:
List of token data dictionaries (with sensitive data masked)
"""
try:
tokens = self.firestore.list_tokens()
# Filter inactive if requested
if not include_inactive:
tokens = [t for t in tokens if t.get("active", True)]
# Mask token values for security (show only first 8 chars)
for token in tokens:
if "token" in token and len(token["token"]) > 8:
token["token"] = token["token"][:8] + "..."
return tokens
except Exception as e:
logger.error(f"Failed to list tokens: {e}")
return []
def get_token_info(self, token: str) -> Optional[Dict[str, Any]]:
"""
Get information about a token (for admin dashboard).
Returns:
Token data or None if not found
"""
# Check if it's an admin token (not stored in Firestore)
if token in self.admin_tokens:
return {
"token": token[:8] + "...",
"type": UserType.ADMIN.value,
"max_uses": -1,
"usage_count": 0,
"active": True,
"source": "environment"
}
# Get from Firestore
token_data = self.firestore.get_token(token)
if token_data and "token" in token_data:
# Mask the full token value
token_data["token"] = token_data["token"][:8] + "..."
return token_data
# Global instance
_auth_service = None
def get_auth_service() -> AuthService:
"""Get the global auth service instance."""
global _auth_service
if _auth_service is None:
_auth_service = AuthService()
return _auth_service
-792
View File
@@ -1,792 +0,0 @@
"""
OAuth Credential Manager for validating and refreshing credentials.
This service provides:
1. Credential validation for YouTube, Dropbox, and Google Drive
2. Device Authorization Flow for re-authentication
3. Proactive monitoring with alerts when credentials expire
"""
import json
import logging
import time
from typing import Optional, Dict, Any, Tuple
from dataclasses import dataclass
from enum import Enum
from datetime import datetime
from google.oauth2.credentials import Credentials as GoogleCredentials
from google.auth.transport.requests import Request as GoogleAuthRequest
from backend.config import get_settings
logger = logging.getLogger(__name__)
class CredentialStatus(str, Enum):
"""Status of OAuth credentials."""
VALID = "valid"
EXPIRED = "expired" # Token expired but refresh may work
INVALID = "invalid" # Refresh failed, re-auth needed
NOT_CONFIGURED = "not_configured" # No credentials stored
ERROR = "error" # Unknown error during validation
@dataclass
class CredentialCheckResult:
"""Result of a credential validation check."""
service: str
status: CredentialStatus
message: str
last_checked: datetime
expires_at: Optional[datetime] = None
@dataclass
class DeviceAuthInfo:
"""Information for device authorization flow."""
device_code: str
user_code: str
verification_url: str
expires_in: int
interval: int
started_at: datetime
class CredentialManager:
"""
Manages OAuth credentials for all external services.
Provides validation, refresh, and device authorization flow for:
- YouTube (Google OAuth)
- Google Drive (Google OAuth)
- Dropbox
"""
# Secret names in Secret Manager
YOUTUBE_SECRET = "youtube-oauth-credentials"
GDRIVE_SECRET = "gdrive-oauth-credentials"
DROPBOX_SECRET = "dropbox-oauth-credentials"
# OAuth client credentials (for device auth flow)
YOUTUBE_CLIENT_SECRET = "youtube-client-credentials"
GDRIVE_CLIENT_SECRET = "gdrive-client-credentials"
# Google OAuth endpoints
GOOGLE_TOKEN_URI = "https://oauth2.googleapis.com/token"
GOOGLE_DEVICE_AUTH_URI = "https://oauth2.googleapis.com/device/code"
# Dropbox OAuth endpoints
DROPBOX_TOKEN_URI = "https://api.dropboxapi.com/oauth2/token"
# Scopes for each service
YOUTUBE_SCOPES = ["https://www.googleapis.com/auth/youtube"]
GDRIVE_SCOPES = ["https://www.googleapis.com/auth/drive.file"]
def __init__(self):
self.settings = get_settings()
self._pending_device_auths: Dict[str, DeviceAuthInfo] = {}
def _get_client_credentials(self, secret_name: str) -> Optional[Dict[str, str]]:
"""
Load OAuth client credentials from Secret Manager.
The secret should contain:
{
"client_id": "...",
"client_secret": "..."
}
"""
try:
creds_json = self.settings.get_secret(secret_name)
if not creds_json:
return None
creds = json.loads(creds_json)
if creds.get("client_id") and creds.get("client_secret"):
return creds
logger.warning(f"{secret_name} missing client_id or client_secret")
return None
except Exception as e:
logger.error(f"Failed to load {secret_name}: {e}")
return None
def get_youtube_client_credentials(self) -> Optional[Dict[str, str]]:
"""Get YouTube OAuth client credentials from Secret Manager."""
return self._get_client_credentials(self.YOUTUBE_CLIENT_SECRET)
def get_gdrive_client_credentials(self) -> Optional[Dict[str, str]]:
"""Get Google Drive OAuth client credentials from Secret Manager."""
return self._get_client_credentials(self.GDRIVE_CLIENT_SECRET)
# =========================================================================
# Credential Validation
# =========================================================================
def check_all_credentials(self) -> Dict[str, CredentialCheckResult]:
"""
Check validity of all OAuth credentials.
Returns:
Dictionary mapping service name to check result
"""
results = {}
results["youtube"] = self.check_youtube_credentials()
results["gdrive"] = self.check_gdrive_credentials()
results["dropbox"] = self.check_dropbox_credentials()
return results
def check_youtube_credentials(self) -> CredentialCheckResult:
"""Check if YouTube credentials are valid and can be refreshed."""
return self._check_google_credentials(
secret_name=self.YOUTUBE_SECRET,
service_name="youtube",
scopes=self.YOUTUBE_SCOPES,
test_api_call=self._test_youtube_api
)
def check_gdrive_credentials(self) -> CredentialCheckResult:
"""Check if Google Drive credentials are valid and can be refreshed."""
return self._check_google_credentials(
secret_name=self.GDRIVE_SECRET,
service_name="gdrive",
scopes=self.GDRIVE_SCOPES,
test_api_call=self._test_gdrive_api
)
def check_dropbox_credentials(self) -> CredentialCheckResult:
"""Check if Dropbox credentials are valid."""
try:
creds_json = self.settings.get_secret(self.DROPBOX_SECRET)
if not creds_json:
return CredentialCheckResult(
service="dropbox",
status=CredentialStatus.NOT_CONFIGURED,
message="Dropbox credentials not configured",
last_checked=datetime.utcnow()
)
creds = json.loads(creds_json)
if not creds.get("access_token"):
return CredentialCheckResult(
service="dropbox",
status=CredentialStatus.INVALID,
message="Dropbox credentials missing access_token",
last_checked=datetime.utcnow()
)
# Test the credentials with a simple API call
if self._test_dropbox_api(creds):
return CredentialCheckResult(
service="dropbox",
status=CredentialStatus.VALID,
message="Dropbox credentials are valid",
last_checked=datetime.utcnow()
)
else:
# Try to refresh if we have refresh token
if creds.get("refresh_token") and creds.get("app_key") and creds.get("app_secret"):
if self._refresh_dropbox_token(creds):
return CredentialCheckResult(
service="dropbox",
status=CredentialStatus.VALID,
message="Dropbox credentials refreshed successfully",
last_checked=datetime.utcnow()
)
return CredentialCheckResult(
service="dropbox",
status=CredentialStatus.INVALID,
message="Dropbox credentials invalid and refresh failed",
last_checked=datetime.utcnow()
)
except Exception as e:
logger.error(f"Error checking Dropbox credentials: {e}")
return CredentialCheckResult(
service="dropbox",
status=CredentialStatus.ERROR,
message=f"Error checking credentials: {str(e)}",
last_checked=datetime.utcnow()
)
def _check_google_credentials(
self,
secret_name: str,
service_name: str,
scopes: list,
test_api_call: callable
) -> CredentialCheckResult:
"""Generic Google OAuth credential check."""
try:
creds_json = self.settings.get_secret(secret_name)
if not creds_json:
return CredentialCheckResult(
service=service_name,
status=CredentialStatus.NOT_CONFIGURED,
message=f"{service_name} credentials not configured",
last_checked=datetime.utcnow()
)
creds_data = json.loads(creds_json)
# Check for required fields
required = ["refresh_token", "client_id", "client_secret"]
missing = [f for f in required if not creds_data.get(f)]
if missing:
return CredentialCheckResult(
service=service_name,
status=CredentialStatus.INVALID,
message=f"Missing required fields: {missing}",
last_checked=datetime.utcnow()
)
# Create credentials object
credentials = GoogleCredentials(
token=creds_data.get("token"),
refresh_token=creds_data.get("refresh_token"),
token_uri=creds_data.get("token_uri", self.GOOGLE_TOKEN_URI),
client_id=creds_data.get("client_id"),
client_secret=creds_data.get("client_secret"),
scopes=creds_data.get("scopes", scopes)
)
# Try to refresh if expired
if credentials.expired or not credentials.token:
try:
credentials.refresh(GoogleAuthRequest())
# Update stored credentials with new token
self._update_google_credentials(secret_name, creds_data, credentials)
except Exception as e:
logger.error(f"Failed to refresh {service_name} credentials: {e}")
return CredentialCheckResult(
service=service_name,
status=CredentialStatus.INVALID,
message=f"Token refresh failed: {str(e)}",
last_checked=datetime.utcnow()
)
# Test with API call
if test_api_call(credentials):
return CredentialCheckResult(
service=service_name,
status=CredentialStatus.VALID,
message=f"{service_name} credentials are valid",
last_checked=datetime.utcnow(),
expires_at=credentials.expiry
)
else:
return CredentialCheckResult(
service=service_name,
status=CredentialStatus.INVALID,
message=f"{service_name} API test failed",
last_checked=datetime.utcnow()
)
except json.JSONDecodeError as e:
return CredentialCheckResult(
service=service_name,
status=CredentialStatus.INVALID,
message=f"Invalid JSON in credentials: {str(e)}",
last_checked=datetime.utcnow()
)
except Exception as e:
logger.error(f"Error checking {service_name} credentials: {e}")
return CredentialCheckResult(
service=service_name,
status=CredentialStatus.ERROR,
message=f"Error: {str(e)}",
last_checked=datetime.utcnow()
)
def _update_google_credentials(
self,
secret_name: str,
original_data: dict,
credentials: GoogleCredentials
) -> bool:
"""Update stored Google credentials with refreshed token."""
try:
from google.cloud import secretmanager
updated_data = original_data.copy()
updated_data["token"] = credentials.token
if credentials.expiry:
updated_data["expiry"] = credentials.expiry.isoformat()
# Add new secret version
client = secretmanager.SecretManagerServiceClient()
project_id = self.settings.google_cloud_project
secret_path = f"projects/{project_id}/secrets/{secret_name}"
client.add_secret_version(
parent=secret_path,
payload={"data": json.dumps(updated_data).encode("utf-8")}
)
logger.info(f"Updated {secret_name} with refreshed token")
return True
except Exception as e:
logger.error(f"Failed to update {secret_name}: {e}")
return False
# =========================================================================
# API Test Methods
# =========================================================================
def _test_youtube_api(self, credentials: GoogleCredentials) -> bool:
"""Test YouTube credentials with a simple API call."""
try:
from googleapiclient.discovery import build
youtube = build("youtube", "v3", credentials=credentials)
# Just get channel info - minimal API call
request = youtube.channels().list(part="id", mine=True)
response = request.execute()
return "items" in response
except Exception as e:
logger.error(f"YouTube API test failed: {e}")
return False
def _test_gdrive_api(self, credentials: GoogleCredentials) -> bool:
"""Test Google Drive credentials with a simple API call."""
try:
from googleapiclient.discovery import build
drive = build("drive", "v3", credentials=credentials)
# Just get about info - minimal API call
request = drive.about().get(fields="user")
response = request.execute()
return "user" in response
except Exception as e:
logger.error(f"Google Drive API test failed: {e}")
return False
def _test_dropbox_api(self, creds: dict) -> bool:
"""Test Dropbox credentials with a simple API call."""
try:
import dropbox
dbx = dropbox.Dropbox(creds["access_token"])
# Just get account info - minimal API call
dbx.users_get_current_account()
return True
except Exception as e:
logger.error(f"Dropbox API test failed: {e}")
return False
def _refresh_dropbox_token(self, creds: dict) -> bool:
"""Try to refresh Dropbox token."""
try:
import requests
response = requests.post(
self.DROPBOX_TOKEN_URI,
data={
"grant_type": "refresh_token",
"refresh_token": creds["refresh_token"],
"client_id": creds["app_key"],
"client_secret": creds["app_secret"],
},
timeout=30
)
if response.status_code == 200:
token_data = response.json()
creds["access_token"] = token_data["access_token"]
# Update in Secret Manager
self._update_dropbox_credentials(creds)
return True
return False
except Exception as e:
logger.error(f"Dropbox token refresh failed: {e}")
return False
def _update_dropbox_credentials(self, creds: dict) -> bool:
"""Update stored Dropbox credentials."""
try:
from google.cloud import secretmanager
client = secretmanager.SecretManagerServiceClient()
project_id = self.settings.google_cloud_project
secret_path = f"projects/{project_id}/secrets/{self.DROPBOX_SECRET}"
client.add_secret_version(
parent=secret_path,
payload={"data": json.dumps(creds).encode("utf-8")}
)
logger.info("Updated Dropbox credentials with refreshed token")
return True
except Exception as e:
logger.error(f"Failed to update Dropbox credentials: {e}")
return False
# =========================================================================
# Device Authorization Flow
# =========================================================================
def start_youtube_device_auth(
self,
client_id: Optional[str] = None,
client_secret: Optional[str] = None
) -> DeviceAuthInfo:
"""
Start YouTube device authorization flow.
Args:
client_id: Google OAuth client ID (optional, reads from Secret Manager if not provided)
client_secret: Google OAuth client secret (optional, reads from Secret Manager if not provided)
Returns:
DeviceAuthInfo with user code and verification URL
"""
# Load from Secret Manager if not provided
if not client_id or not client_secret:
stored_creds = self.get_youtube_client_credentials()
if not stored_creds:
raise Exception(
"YouTube client credentials not found. Either pass client_id/client_secret "
"or create the 'youtube-client-credentials' secret in Secret Manager."
)
client_id = stored_creds["client_id"]
client_secret = stored_creds["client_secret"]
return self._start_google_device_auth(
client_id=client_id,
client_secret=client_secret,
scopes=self.YOUTUBE_SCOPES,
service_name="youtube"
)
def start_gdrive_device_auth(
self,
client_id: Optional[str] = None,
client_secret: Optional[str] = None
) -> DeviceAuthInfo:
"""
Start Google Drive device authorization flow.
Args:
client_id: Google OAuth client ID (optional, reads from Secret Manager if not provided)
client_secret: Google OAuth client secret (optional, reads from Secret Manager if not provided)
Returns:
DeviceAuthInfo with user code and verification URL
"""
# Load from Secret Manager if not provided
if not client_id or not client_secret:
stored_creds = self.get_gdrive_client_credentials()
if not stored_creds:
raise Exception(
"Google Drive client credentials not found. Either pass client_id/client_secret "
"or create the 'gdrive-client-credentials' secret in Secret Manager."
)
client_id = stored_creds["client_id"]
client_secret = stored_creds["client_secret"]
return self._start_google_device_auth(
client_id=client_id,
client_secret=client_secret,
scopes=self.GDRIVE_SCOPES,
service_name="gdrive"
)
def _start_google_device_auth(
self,
client_id: str,
client_secret: str,
scopes: list,
service_name: str
) -> DeviceAuthInfo:
"""Start Google device authorization flow."""
import requests
logger.info(f"[{service_name}] Starting device auth flow with scopes: {scopes}")
response = requests.post(
self.GOOGLE_DEVICE_AUTH_URI,
data={
"client_id": client_id,
"scope": " ".join(scopes),
},
timeout=30
)
if response.status_code != 200:
logger.error(f"[{service_name}] Device auth request failed: {response.status_code} - {response.text}")
raise Exception(f"Device auth request failed: {response.text}")
logger.info(f"[{service_name}] Device auth initiated successfully")
data = response.json()
# Google uses 'verification_uri' but some docs show 'verification_url'
verification_url = data.get("verification_uri") or data.get("verification_url")
device_info = DeviceAuthInfo(
device_code=data["device_code"],
user_code=data["user_code"],
verification_url=verification_url,
expires_in=data["expires_in"],
interval=data.get("interval", 5),
started_at=datetime.utcnow()
)
# Store for polling, include client secret for token exchange
self._pending_device_auths[f"{service_name}:{data['device_code']}"] = {
"info": device_info,
"client_id": client_id,
"client_secret": client_secret,
"scopes": scopes,
"service_name": service_name
}
return device_info
def poll_device_auth(self, service_name: str, device_code: str) -> Tuple[str, Optional[dict]]:
"""
Poll for device authorization completion.
This method is STATELESS - it fetches client credentials from Secret Manager
and polls Google directly. This works correctly in serverless environments
like Cloud Run where in-memory state is not preserved between requests.
Args:
service_name: "youtube" or "gdrive"
device_code: The device code from start_*_device_auth
Returns:
Tuple of (status, token_data)
status: "pending", "complete", "expired", "error"
token_data: Token data if complete, None otherwise
"""
import requests
logger.info(f"[{service_name}] Polling device auth for code: {device_code[:20]}...")
# Get client credentials from Secret Manager (stateless approach)
if service_name == "youtube":
client_creds = self.get_youtube_client_credentials()
scopes = self.YOUTUBE_SCOPES
secret_name = self.YOUTUBE_SECRET
elif service_name == "gdrive":
client_creds = self.get_gdrive_client_credentials()
scopes = self.GDRIVE_SCOPES
secret_name = self.GDRIVE_SECRET
else:
logger.error(f"[{service_name}] Unknown service")
return ("error", {"message": f"Unknown service: {service_name}"})
if not client_creds:
logger.error(f"[{service_name}] Client credentials not found in Secret Manager")
return ("error", {"message": f"Client credentials not found in Secret Manager for {service_name}"})
client_id = client_creds.get("client_id")
client_secret = client_creds.get("client_secret")
if not client_id or not client_secret:
logger.error(f"[{service_name}] Invalid client credentials (missing client_id or client_secret)")
return ("error", {"message": f"Invalid client credentials for {service_name}"})
logger.info(f"[{service_name}] Got client credentials, polling Google token endpoint...")
# Poll Google token endpoint
response = requests.post(
self.GOOGLE_TOKEN_URI,
data={
"client_id": client_id,
"client_secret": client_secret,
"device_code": device_code,
"grant_type": "urn:ietf:params:oauth:grant-type:device_code",
},
timeout=30
)
data = response.json()
logger.info(f"[{service_name}] Token endpoint response: status={response.status_code}")
if response.status_code == 200:
logger.info(f"[{service_name}] Token exchange successful! Got access token and refresh_token={bool(data.get('refresh_token'))}")
# Success! Store the credentials
token_data = {
"token": data["access_token"],
"refresh_token": data.get("refresh_token"),
"token_uri": self.GOOGLE_TOKEN_URI,
"client_id": client_id,
"client_secret": client_secret,
"scopes": scopes,
}
# Save to Secret Manager
logger.info(f"[{service_name}] Saving credentials to secret: {secret_name}")
saved = self._save_credentials_to_secret(secret_name, token_data)
if not saved:
logger.error(f"[{service_name}] Failed to save credentials to Secret Manager!")
return ("error", {"message": "Token exchange succeeded but failed to save credentials to Secret Manager"})
logger.info(f"[{service_name}] Device auth flow COMPLETE - credentials saved successfully")
return ("complete", token_data)
elif "error" in data:
error = data["error"]
logger.info(f"[{service_name}] Token endpoint returned error: {error}")
if error == "authorization_pending":
return ("pending", {"message": "Waiting for user to authorize. Please visit the verification URL and enter the code."})
elif error == "slow_down":
return ("pending", {"message": "Please wait a few more seconds before polling again."})
elif error == "expired_token":
logger.warning(f"[{service_name}] Device code expired")
return ("expired", {"message": "Device code expired. Please start a new device auth flow."})
elif error == "access_denied":
logger.warning(f"[{service_name}] User denied access")
return ("error", {"message": "User denied access"})
else:
logger.error(f"[{service_name}] Unexpected error: {data}")
return ("error", {"message": data.get("error_description", error)})
logger.error(f"[{service_name}] Unknown response from token endpoint: {data}")
return ("error", {"message": "Unknown response from token endpoint"})
def _save_credentials_to_secret(self, secret_name: str, token_data: dict) -> bool:
"""Save credentials to Secret Manager, creating the secret if needed."""
logger.info(f"[SecretManager] Attempting to save credentials to: {secret_name}")
try:
from google.cloud import secretmanager
from google.api_core import exceptions as gcp_exceptions
client = secretmanager.SecretManagerServiceClient()
project_id = self.settings.google_cloud_project
if not project_id:
logger.error(f"[SecretManager] No GCP project configured!")
return False
parent = f"projects/{project_id}"
secret_path = f"{parent}/secrets/{secret_name}"
logger.info(f"[SecretManager] Using project: {project_id}, secret path: {secret_path}")
# Try to add a version to existing secret
try:
client.add_secret_version(
parent=secret_path,
payload={"data": json.dumps(token_data).encode("utf-8")}
)
logger.info(f"[SecretManager] SUCCESS - Added new version to existing secret: {secret_name}")
return True
except gcp_exceptions.NotFound:
# Secret doesn't exist, create it first
logger.info(f"[SecretManager] Secret {secret_name} not found, creating new secret...")
client.create_secret(
parent=parent,
secret_id=secret_name,
secret={"replication": {"automatic": {}}}
)
logger.info(f"[SecretManager] Created secret: {secret_name}")
# Now add the version
client.add_secret_version(
parent=secret_path,
payload={"data": json.dumps(token_data).encode("utf-8")}
)
logger.info(f"[SecretManager] SUCCESS - Created secret and saved credentials to: {secret_name}")
return True
except Exception as e:
logger.error(f"[SecretManager] FAILED to save credentials to {secret_name}: {type(e).__name__}: {e}")
import traceback
logger.error(f"[SecretManager] Traceback: {traceback.format_exc()}")
return False
# =========================================================================
# Alerts
# =========================================================================
def send_credential_alert(
self,
invalid_services: list[CredentialCheckResult],
discord_webhook_url: Optional[str] = None
) -> bool:
"""
Send alert about invalid credentials.
Args:
invalid_services: List of services with invalid credentials
discord_webhook_url: Discord webhook URL for notifications
Returns:
True if alert was sent successfully
"""
if not discord_webhook_url:
logger.warning("No Discord webhook URL configured for alerts")
return False
try:
import requests
services_list = "\n".join([
f"• **{r.service}**: {r.message}"
for r in invalid_services
])
# Get the API base URL for re-auth links
api_url = self.settings.api_base_url if hasattr(self.settings, 'api_base_url') else "https://your-api-url"
message = {
"embeds": [{
"title": "⚠️ OAuth Credentials Need Attention",
"description": f"The following service credentials need re-authorization:\n\n{services_list}",
"color": 16744256, # Orange
"fields": [
{
"name": "Re-authorize",
"value": f"Visit `{api_url}/api/auth/status` to start re-authorization flow",
"inline": False
}
],
"footer": {
"text": "karaoke-gen backend"
},
"timestamp": datetime.utcnow().isoformat()
}]
}
response = requests.post(discord_webhook_url, json=message, timeout=30)
return response.status_code in (200, 204)
except Exception as e:
logger.error(f"Failed to send credential alert: {e}")
return False
# Singleton instance
_credential_manager: Optional[CredentialManager] = None
def get_credential_manager() -> CredentialManager:
"""Get the singleton credential manager instance."""
global _credential_manager
if _credential_manager is None:
_credential_manager = CredentialManager()
return _credential_manager
-262
View File
@@ -1,262 +0,0 @@
"""Native Dropbox API service for cloud backend.
This service provides Dropbox operations using the native Python SDK,
replacing rclone for server-side operations. It handles:
- Folder listing for brand code calculation
- File and folder uploads
- Shared link generation
Credentials are loaded from Google Cloud Secret Manager.
"""
import json
import logging
import os
import re
from typing import Optional
from google.cloud import secretmanager
logger = logging.getLogger(__name__)
class DropboxService:
"""Dropbox operations using native Python SDK."""
def __init__(self):
self._client = None
self._is_configured = False
def _load_credentials(self) -> Optional[dict]:
"""Load OAuth credentials from Secret Manager."""
try:
client = secretmanager.SecretManagerServiceClient()
# Try to get the project ID from environment or use default
project_id = os.environ.get("GOOGLE_CLOUD_PROJECT", "karaoke-gen")
name = f"projects/{project_id}/secrets/dropbox-oauth-credentials/versions/latest"
response = client.access_secret_version(request={"name": name})
return json.loads(response.payload.data.decode("UTF-8"))
except Exception as e:
logger.warning(f"Failed to load Dropbox credentials from Secret Manager: {e}")
return None
@property
def is_configured(self) -> bool:
"""Check if Dropbox credentials are available."""
if self._is_configured:
return True
creds = self._load_credentials()
self._is_configured = creds is not None and "access_token" in creds
return self._is_configured
@property
def client(self):
"""Get or create Dropbox client."""
if self._client is None:
# Import here to avoid import errors if dropbox is not installed
try:
from dropbox import Dropbox
except ImportError:
raise ImportError(
"dropbox package is not installed. "
"Install it with: pip install dropbox"
)
creds = self._load_credentials()
if not creds:
raise RuntimeError("Dropbox credentials not configured in Secret Manager")
self._client = Dropbox(
oauth2_access_token=creds["access_token"],
oauth2_refresh_token=creds.get("refresh_token"),
app_key=creds.get("app_key"),
app_secret=creds.get("app_secret"),
)
return self._client
def list_folders(self, path: str) -> list[str]:
"""
List folder names at path for brand code calculation.
Args:
path: Dropbox path to list (e.g., "/Karaoke/Tracks-Organized")
Returns:
List of folder names in the path
"""
from dropbox.files import FolderMetadata
# Ensure path starts with /
if not path.startswith("/"):
path = f"/{path}"
logger.info(f"Listing folders at Dropbox path: {path}")
result = self.client.files_list_folder(path)
folders = []
# Get all entries (handling pagination)
while True:
for entry in result.entries:
if isinstance(entry, FolderMetadata):
folders.append(entry.name)
if not result.has_more:
break
result = self.client.files_list_folder_continue(result.cursor)
logger.info(f"Found {len(folders)} folders in {path}")
return folders
def get_next_brand_code(self, path: str, brand_prefix: str) -> str:
"""
Calculate next brand code from existing folders.
Scans the folder for existing brand codes like "NOMAD-0001" and
returns the next sequential code.
Args:
path: Dropbox path containing organized folders
brand_prefix: Brand prefix (e.g., "NOMAD")
Returns:
Next brand code (e.g., "NOMAD-1164")
"""
folders = self.list_folders(path)
pattern = re.compile(rf"^{re.escape(brand_prefix)}-(\d{{4}})")
max_num = 0
for folder in folders:
match = pattern.match(folder)
if match:
num = int(match.group(1))
max_num = max(max_num, num)
next_code = f"{brand_prefix}-{max_num + 1:04d}"
logger.info(f"Next brand code for {brand_prefix}: {next_code} (max existing: {max_num})")
return next_code
def upload_file(self, local_path: str, remote_path: str) -> None:
"""
Upload a single file to Dropbox.
Args:
local_path: Local file path
remote_path: Dropbox destination path (must start with /)
"""
from dropbox.files import WriteMode
# Ensure remote path starts with /
if not remote_path.startswith("/"):
remote_path = f"/{remote_path}"
file_size = os.path.getsize(local_path)
logger.info(f"Uploading {local_path} ({file_size / 1024 / 1024:.1f} MB) to {remote_path}")
# For large files (>150MB), use upload sessions
CHUNK_SIZE = 150 * 1024 * 1024 # 150 MB
with open(local_path, "rb") as f:
if file_size <= CHUNK_SIZE:
# Simple upload for smaller files
self.client.files_upload(f.read(), remote_path, mode=WriteMode.overwrite)
else:
# Chunked upload for large files
self._upload_large_file(f, remote_path, file_size)
logger.info(f"Successfully uploaded to {remote_path}")
def _upload_large_file(self, file_obj, remote_path: str, file_size: int) -> None:
"""Upload a large file using upload sessions."""
from dropbox.files import CommitInfo, UploadSessionCursor, WriteMode
CHUNK_SIZE = 150 * 1024 * 1024 # 150 MB
# Start upload session
session_start = self.client.files_upload_session_start(file_obj.read(CHUNK_SIZE))
cursor = UploadSessionCursor(
session_id=session_start.session_id,
offset=file_obj.tell(),
)
commit = CommitInfo(path=remote_path, mode=WriteMode.overwrite)
# Upload remaining chunks
while file_obj.tell() < file_size:
remaining = file_size - file_obj.tell()
if remaining <= CHUNK_SIZE:
# Final chunk
self.client.files_upload_session_finish(
file_obj.read(CHUNK_SIZE),
cursor,
commit,
)
else:
# Intermediate chunk
self.client.files_upload_session_append_v2(
file_obj.read(CHUNK_SIZE),
cursor,
)
cursor.offset = file_obj.tell()
def upload_folder(self, local_dir: str, remote_path: str) -> None:
"""
Upload all files in a directory to Dropbox folder.
Args:
local_dir: Local directory to upload
remote_path: Dropbox destination folder path
"""
# Ensure remote path starts with /
if not remote_path.startswith("/"):
remote_path = f"/{remote_path}"
logger.info(f"Uploading folder {local_dir} to {remote_path}")
uploaded_count = 0
for filename in os.listdir(local_dir):
local_file = os.path.join(local_dir, filename)
if os.path.isfile(local_file):
remote_file = f"{remote_path}/{filename}"
self.upload_file(local_file, remote_file)
uploaded_count += 1
logger.info(f"Uploaded {uploaded_count} files to {remote_path}")
def create_shared_link(self, path: str) -> str:
"""
Create and return a shared link for the path.
Args:
path: Dropbox path to share
Returns:
Shared link URL
"""
from dropbox.exceptions import ApiError
from dropbox.sharing import SharedLinkSettings
# Ensure path starts with /
if not path.startswith("/"):
path = f"/{path}"
logger.info(f"Creating shared link for: {path}")
try:
# Try to create a new shared link
settings = SharedLinkSettings(requested_visibility=None)
link = self.client.sharing_create_shared_link_with_settings(path, settings)
logger.info(f"Created new shared link: {link.url}")
return link.url
except ApiError as e:
# Link may already exist - try to get existing link
if e.error.is_shared_link_already_exists():
logger.info("Shared link already exists, retrieving existing link")
links = self.client.sharing_list_shared_links(path=path, direct_only=True)
if links.links:
logger.info(f"Found existing shared link: {links.links[0].url}")
return links.links[0].url
raise
def get_dropbox_service() -> DropboxService:
"""Factory function to get a DropboxService instance."""
return DropboxService()
-343
View File
@@ -1,343 +0,0 @@
"""
Firestore database operations for job management.
"""
import logging
from typing import Optional, Dict, Any, List
from datetime import datetime
from google.cloud import firestore
from google.cloud.firestore_v1 import FieldFilter
from backend.config import settings
from backend.models.job import Job, JobStatus, TimelineEvent
logger = logging.getLogger(__name__)
class FirestoreService:
"""Service for Firestore database operations."""
def __init__(self):
"""Initialize Firestore client."""
self.db = firestore.Client(project=settings.google_cloud_project)
self.collection = settings.firestore_collection
self.tokens_collection = "auth_tokens" # Collection for access tokens
def create_job(self, job: Job) -> None:
"""Create a new job in Firestore."""
try:
doc_ref = self.db.collection(self.collection).document(job.job_id)
doc_ref.set(job.model_dump(mode='json'))
logger.info(f"Created job {job.job_id} in Firestore")
except Exception as e:
logger.error(f"Error creating job {job.job_id}: {e}")
raise
def get_job(self, job_id: str) -> Optional[Job]:
"""Get a job by ID."""
try:
doc_ref = self.db.collection(self.collection).document(job_id)
doc = doc_ref.get()
logger.debug(f"Fetching job {job_id} from collection {self.collection}")
logger.debug(f"Document exists: {doc.exists}")
if not doc.exists:
return None
data = doc.to_dict()
logger.debug(f"Document data keys: {list(data.keys()) if data else 'None'}")
logger.debug(f"Document data: {data}")
return Job(**data)
except Exception as e:
logger.error(f"Error getting job {job_id}: {e}")
raise
def update_job(self, job_id: str, updates: Dict[str, Any]) -> None:
"""Update a job with partial data."""
try:
doc_ref = self.db.collection(self.collection).document(job_id)
# Add updated_at timestamp
updates['updated_at'] = datetime.utcnow()
doc_ref.update(updates)
logger.info(f"Updated job {job_id} in Firestore")
except Exception as e:
logger.error(f"Error updating job {job_id}: {e}")
raise
def update_job_status(
self,
job_id: str,
status: JobStatus,
progress: Optional[int] = None,
message: Optional[str] = None,
**additional_fields
) -> None:
"""Update job status and add timeline event."""
try:
doc_ref = self.db.collection(self.collection).document(job_id)
# Create timeline event
timeline_event = TimelineEvent(
status=status.value,
timestamp=datetime.utcnow().isoformat(),
progress=progress,
message=message
)
# Prepare updates
updates = {
'status': status.value,
'updated_at': datetime.utcnow(),
'timeline': firestore.ArrayUnion([timeline_event.model_dump(mode='json')])
}
if progress is not None:
updates['progress'] = progress
# Add any additional fields
updates.update(additional_fields)
doc_ref.update(updates)
logger.info(f"Updated job {job_id} status to {status.value}")
except Exception as e:
logger.error(f"Error updating job status {job_id}: {e}")
raise
def list_jobs(
self,
status: Optional[JobStatus] = None,
environment: Optional[str] = None,
client_id: Optional[str] = None,
created_after: Optional[datetime] = None,
created_before: Optional[datetime] = None,
limit: int = 100
) -> List[Job]:
"""
List jobs with optional filters.
Args:
status: Filter by job status
environment: Filter by request_metadata.environment (test/production/development)
client_id: Filter by request_metadata.client_id
created_after: Filter jobs created after this datetime
created_before: Filter jobs created before this datetime
limit: Maximum number of jobs to return
Returns:
List of Job objects matching filters, ordered by created_at descending
"""
try:
query = self.db.collection(self.collection)
if status:
query = query.where(filter=FieldFilter('status', '==', status.value))
# Filter by request_metadata fields using dot notation
if environment:
query = query.where(filter=FieldFilter('request_metadata.environment', '==', environment))
if client_id:
query = query.where(filter=FieldFilter('request_metadata.client_id', '==', client_id))
# Date range filters
if created_after:
query = query.where(filter=FieldFilter('created_at', '>=', created_after))
if created_before:
query = query.where(filter=FieldFilter('created_at', '<=', created_before))
query = query.order_by('created_at', direction=firestore.Query.DESCENDING).limit(limit)
docs = query.stream()
jobs = [Job(**doc.to_dict()) for doc in docs]
return jobs
except Exception as e:
logger.error(f"Error listing jobs: {e}")
raise
def delete_jobs_by_filter(
self,
environment: Optional[str] = None,
client_id: Optional[str] = None,
status: Optional[JobStatus] = None,
created_before: Optional[datetime] = None,
) -> int:
"""
Delete multiple jobs matching filter criteria.
CAUTION: This is a destructive operation. Use carefully.
Args:
environment: Delete jobs with this environment (e.g., "test")
client_id: Delete jobs from this client
status: Delete jobs with this status
created_before: Delete jobs created before this datetime
Returns:
Number of jobs deleted
"""
try:
query = self.db.collection(self.collection)
if environment:
query = query.where(filter=FieldFilter('request_metadata.environment', '==', environment))
if client_id:
query = query.where(filter=FieldFilter('request_metadata.client_id', '==', client_id))
if status:
query = query.where(filter=FieldFilter('status', '==', status.value))
if created_before:
query = query.where(filter=FieldFilter('created_at', '<=', created_before))
# Get matching documents
docs = list(query.stream())
deleted_count = 0
# Delete in batches
batch = self.db.batch()
batch_count = 0
for doc in docs:
batch.delete(doc.reference)
batch_count += 1
deleted_count += 1
# Firestore batch limit is 500
if batch_count >= 500:
batch.commit()
batch = self.db.batch()
batch_count = 0
# Commit any remaining deletes
if batch_count > 0:
batch.commit()
logger.info(f"Deleted {deleted_count} jobs matching filter criteria")
return deleted_count
except Exception as e:
logger.error(f"Error deleting jobs by filter: {e}")
raise
def delete_job(self, job_id: str) -> None:
"""Delete a job from Firestore."""
try:
doc_ref = self.db.collection(self.collection).document(job_id)
doc_ref.delete()
logger.info(f"Deleted job {job_id} from Firestore")
except Exception as e:
logger.error(f"Error deleting job {job_id}: {e}")
raise
def append_worker_log(self, job_id: str, log_entry: Dict[str, Any]) -> None:
"""
Atomically append a log entry to worker_logs using ArrayUnion.
This avoids the race condition of read-modify-write when multiple
workers are logging concurrently.
Args:
job_id: Job ID
log_entry: Log entry dict with timestamp, level, worker, message
"""
try:
doc_ref = self.db.collection(self.collection).document(job_id)
doc_ref.update({
'worker_logs': firestore.ArrayUnion([log_entry]),
'updated_at': datetime.utcnow()
})
# Don't log every append - too spammy
except Exception as e:
# Log but don't raise - logging shouldn't break workers
logger.debug(f"Error appending worker log for job {job_id}: {e}")
# ============================================
# Token Management Methods
# ============================================
def create_token(self, token: str, token_data: Dict[str, Any]) -> None:
"""Create a new access token in Firestore."""
try:
doc_ref = self.db.collection(self.tokens_collection).document(token)
doc_ref.set(token_data)
logger.info(f"Created token in Firestore")
except Exception as e:
logger.error(f"Error creating token: {e}")
raise
def get_token(self, token: str) -> Optional[Dict[str, Any]]:
"""Get token data by token string."""
try:
doc_ref = self.db.collection(self.tokens_collection).document(token)
doc = doc_ref.get()
if not doc.exists:
return None
return doc.to_dict()
except Exception as e:
logger.error(f"Error getting token: {e}")
return None
def update_token(self, token: str, updates: Dict[str, Any]) -> None:
"""Update token data."""
try:
doc_ref = self.db.collection(self.tokens_collection).document(token)
doc_ref.update(updates)
logger.info(f"Updated token in Firestore")
except Exception as e:
logger.error(f"Error updating token: {e}")
raise
def increment_token_usage(self, token: str, job_id: str) -> None:
"""Increment token usage count and add job to history."""
try:
doc_ref = self.db.collection(self.tokens_collection).document(token)
# Use Firestore transaction to ensure atomic increment
@firestore.transactional
def update_in_transaction(transaction, doc_ref):
snapshot = doc_ref.get(transaction=transaction)
if not snapshot.exists:
raise ValueError("Token not found")
data = snapshot.to_dict()
current_usage = data.get("usage_count", 0)
jobs = data.get("jobs", [])
# Increment usage
transaction.update(doc_ref, {
"usage_count": current_usage + 1,
"last_used": datetime.utcnow(),
"jobs": firestore.ArrayUnion([{
"job_id": job_id,
"created_at": datetime.utcnow()
}])
})
transaction = self.db.transaction()
update_in_transaction(transaction, doc_ref)
logger.info(f"Incremented token usage for job {job_id}")
except Exception as e:
logger.error(f"Error incrementing token usage: {e}")
raise
def list_tokens(self) -> List[Dict[str, Any]]:
"""List all tokens (admin only)."""
try:
docs = self.db.collection(self.tokens_collection).stream()
tokens = [doc.to_dict() for doc in docs]
logger.info(f"Retrieved {len(tokens)} tokens from Firestore")
return tokens
except Exception as e:
logger.error(f"Error listing tokens: {e}")
return []
-309
View File
@@ -1,309 +0,0 @@
"""Native Google Drive API service for cloud backend.
This service provides Google Drive operations using the native API,
for uploading files to public share folders. It handles:
- Folder creation and lookup
- File uploads with resumable upload support
- Uploading to organized folder structure (MP4/, MP4-720p/, CDG/)
Credentials are loaded from Google Cloud Secret Manager and can be
shared with YouTube credentials if scopes include drive.file.
"""
import json
import logging
import os
from typing import Any, Dict, Optional
from backend.config import get_settings
logger = logging.getLogger(__name__)
class GoogleDriveService:
"""Google Drive operations using native API."""
# Secret Manager secret name for Google Drive credentials
# Can be same as YouTube if scopes include drive.file
GDRIVE_CREDENTIALS_SECRET = "gdrive-oauth-credentials"
def __init__(self):
self.settings = get_settings()
self._service = None
self._credentials_data: Optional[Dict[str, Any]] = None
self._loaded = False
def _load_credentials(self) -> Optional[Dict[str, Any]]:
"""Load OAuth credentials from Secret Manager."""
if self._loaded:
return self._credentials_data
try:
creds_json = self.settings.get_secret(self.GDRIVE_CREDENTIALS_SECRET)
if not creds_json:
# Try falling back to YouTube credentials (may have drive scope)
logger.info(
"Google Drive credentials not found, trying YouTube credentials"
)
creds_json = self.settings.get_secret("youtube-oauth-credentials")
if not creds_json:
logger.warning("Google Drive credentials not found in Secret Manager")
self._loaded = True
return None
self._credentials_data = json.loads(creds_json)
# Validate required fields
required_fields = ["refresh_token", "client_id", "client_secret"]
missing = [f for f in required_fields if not self._credentials_data.get(f)]
if missing:
logger.error(f"Google Drive credentials missing required fields: {missing}")
self._credentials_data = None
self._loaded = True
return None
logger.info("Google Drive credentials loaded successfully from Secret Manager")
self._loaded = True
return self._credentials_data
except json.JSONDecodeError as e:
logger.error(f"Failed to parse Google Drive credentials JSON: {e}")
self._loaded = True
return None
except Exception as e:
logger.error(f"Failed to load Google Drive credentials: {e}")
self._loaded = True
return None
@property
def is_configured(self) -> bool:
"""Check if Google Drive credentials are available."""
creds = self._load_credentials()
return creds is not None
@property
def service(self):
"""Get or create Google Drive service."""
if self._service is None:
# Import here to avoid import errors if google packages not installed
try:
from google.oauth2.credentials import Credentials
from googleapiclient.discovery import build
except ImportError:
raise ImportError(
"google-api-python-client and google-auth packages are required. "
"Install them with: pip install google-api-python-client google-auth"
)
creds_data = self._load_credentials()
if not creds_data:
raise RuntimeError(
"Google Drive credentials not configured in Secret Manager"
)
# Create credentials object
credentials = Credentials(
token=creds_data.get("token"),
refresh_token=creds_data.get("refresh_token"),
token_uri=creds_data.get(
"token_uri", "https://oauth2.googleapis.com/token"
),
client_id=creds_data.get("client_id"),
client_secret=creds_data.get("client_secret"),
scopes=creds_data.get(
"scopes", ["https://www.googleapis.com/auth/drive.file"]
),
)
self._service = build("drive", "v3", credentials=credentials)
logger.info("Google Drive service initialized successfully")
return self._service
def get_or_create_folder(self, parent_id: str, folder_name: str) -> str:
"""
Get existing folder or create new one, return folder ID.
Args:
parent_id: Parent folder ID
folder_name: Name of folder to find or create
Returns:
Folder ID
"""
logger.info(f"Looking for folder '{folder_name}' in parent {parent_id}")
# Search for existing folder
query = (
f"name='{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()
if results.get("files"):
folder_id = results["files"][0]["id"]
logger.info(f"Found existing folder '{folder_name}': {folder_id}")
return folder_id
# Create folder
logger.info(f"Creating new folder '{folder_name}'")
metadata = {
"name": folder_name,
"mimeType": "application/vnd.google-apps.folder",
"parents": [parent_id],
}
folder = self.service.files().create(body=metadata, fields="id").execute()
folder_id = folder["id"]
logger.info(f"Created folder '{folder_name}': {folder_id}")
return folder_id
def upload_file(
self,
local_path: str,
parent_id: str,
filename: str,
replace_existing: bool = True,
) -> str:
"""
Upload a file to a specific Drive folder.
Args:
local_path: Local file path
parent_id: Parent folder ID in Google Drive
filename: Name for the file in Drive
replace_existing: If True, delete existing file with same name first
Returns:
File ID of uploaded file
"""
from googleapiclient.http import MediaFileUpload
file_size = os.path.getsize(local_path)
logger.info(
f"Uploading {local_path} ({file_size / 1024 / 1024:.1f} MB) "
f"as '{filename}' to folder {parent_id}"
)
# Determine MIME type
ext = os.path.splitext(local_path)[1].lower()
mime_types = {
".mp4": "video/mp4",
".mkv": "video/x-matroska",
".zip": "application/zip",
".flac": "audio/flac",
".mp3": "audio/mpeg",
".wav": "audio/wav",
".png": "image/png",
".jpg": "image/jpeg",
".jpeg": "image/jpeg",
}
mime_type = mime_types.get(ext, "application/octet-stream")
# Check for existing file with same name
if replace_existing:
query = (
f"name='{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", []):
logger.info(f"Deleting existing file: {existing_file['id']}")
self.service.files().delete(fileId=existing_file["id"]).execute()
# Upload file
metadata = {"name": filename, "parents": [parent_id]}
media = MediaFileUpload(local_path, mimetype=mime_type, resumable=True)
file_result = (
self.service.files().create(body=metadata, media_body=media, fields="id").execute()
)
file_id = file_result["id"]
logger.info(f"Successfully uploaded '{filename}': {file_id}")
return file_id
def upload_to_public_share(
self,
root_folder_id: str,
brand_code: str,
base_name: str,
output_files: dict,
) -> Dict[str, str]:
"""
Upload final files to public share folder structure.
Creates/uses subfolders:
- MP4/{brand_code} - {base_name}.mp4 (lossy 4k)
- MP4-720p/{brand_code} - {base_name}.mp4
- CDG/{brand_code} - {base_name}.zip
Args:
root_folder_id: Google Drive folder ID for public share root
brand_code: Brand code (e.g., "NOMAD-1163")
base_name: Base filename (e.g., "Artist - Title")
output_files: Dictionary with output file paths:
- final_karaoke_lossy_mp4: 4K lossy MP4
- final_karaoke_lossy_720p_mp4: 720p lossy MP4
- final_karaoke_cdg_zip: CDG package ZIP
Returns:
Dictionary mapping category to uploaded file ID
"""
filename_base = f"{brand_code} - {base_name}"
uploaded_files = {}
logger.info(
f"Uploading public share files to Google Drive folder {root_folder_id}"
)
logger.info(f"Filename base: {filename_base}")
# Upload lossy 4k to MP4/
lossy_mp4_path = output_files.get("final_karaoke_lossy_mp4")
if lossy_mp4_path and os.path.exists(lossy_mp4_path):
mp4_folder_id = self.get_or_create_folder(root_folder_id, "MP4")
file_id = self.upload_file(
lossy_mp4_path,
mp4_folder_id,
f"{filename_base}.mp4",
)
uploaded_files["mp4"] = file_id
logger.info(f"Uploaded 4K MP4 to MP4/ folder")
# Upload 720p to MP4-720p/
mp4_720p_path = output_files.get("final_karaoke_lossy_720p_mp4")
if mp4_720p_path and os.path.exists(mp4_720p_path):
mp4_720_folder_id = self.get_or_create_folder(root_folder_id, "MP4-720p")
file_id = self.upload_file(
mp4_720p_path,
mp4_720_folder_id,
f"{filename_base}.mp4",
)
uploaded_files["mp4_720p"] = file_id
logger.info(f"Uploaded 720p MP4 to MP4-720p/ folder")
# Upload CDG ZIP to CDG/
cdg_zip_path = output_files.get("final_karaoke_cdg_zip")
if cdg_zip_path and os.path.exists(cdg_zip_path):
cdg_folder_id = self.get_or_create_folder(root_folder_id, "CDG")
file_id = self.upload_file(
cdg_zip_path,
cdg_folder_id,
f"{filename_base}.zip",
)
uploaded_files["cdg"] = file_id
logger.info(f"Uploaded CDG ZIP to CDG/ folder")
logger.info(f"Public share upload complete: {len(uploaded_files)} files uploaded")
return uploaded_files
# Singleton instance
_gdrive_service: Optional[GoogleDriveService] = None
def get_gdrive_service() -> GoogleDriveService:
"""Get the singleton Google Drive service instance."""
global _gdrive_service
if _gdrive_service is None:
_gdrive_service = GoogleDriveService()
return _gdrive_service
-258
View File
@@ -1,258 +0,0 @@
"""
Job-aware logging utilities.
This module provides a context manager and logging handler that captures
Python logging output and forwards it to Firestore for real-time streaming
to the CLI.
Usage:
with JobLogContext(job_id, worker="review") as log_context:
# Any logging within this block will be captured and sent to Firestore
logger.info("Processing...") # This will be stored and streamed to CLI
"""
import logging
import threading
from typing import Optional
from contextlib import contextmanager
from datetime import datetime
from backend.services.firestore_service import FirestoreService
class JobLogHandler(logging.Handler):
"""
A logging handler that forwards log records to Firestore for job tracking.
This enables real-time log streaming to the CLI during long-running operations
like lyrics correction, preview generation, etc.
"""
def __init__(
self,
job_id: str,
worker: str = "review",
firestore: Optional[FirestoreService] = None,
min_level: int = logging.INFO,
batch_size: int = 1, # Send immediately for real-time experience
):
"""
Initialize the job log handler.
Args:
job_id: The job ID to associate logs with
worker: Worker name (e.g., "review", "add-lyrics", "preview")
firestore: FirestoreService instance (creates one if not provided)
min_level: Minimum log level to capture (default INFO)
batch_size: Number of logs to batch before sending (1 = immediate)
"""
super().__init__()
self.job_id = job_id
self.worker = worker
self.firestore = firestore or FirestoreService()
self.min_level = min_level
self.batch_size = batch_size
self._log_buffer = []
self._lock = threading.Lock()
# Set the handler's level
self.setLevel(min_level)
# Create a formatter that extracts the useful parts
self.setFormatter(logging.Formatter('%(message)s'))
def emit(self, record: logging.LogRecord) -> None:
"""
Process a log record and send it to Firestore.
This method is called by the logging framework for each log message.
"""
try:
# Skip if below minimum level
if record.levelno < self.min_level:
return
# Format the message
message = self.format(record)
# Truncate very long messages
if len(message) > 1000:
message = message[:997] + "..."
# Create log entry
log_entry = {
'timestamp': datetime.utcnow().isoformat() + 'Z',
'level': record.levelname,
'worker': self.worker,
'message': message,
}
# Add to buffer
with self._lock:
self._log_buffer.append(log_entry)
# Flush if batch size reached
if len(self._log_buffer) >= self.batch_size:
self._flush_buffer()
except Exception:
# Never let logging errors propagate
self.handleError(record)
def _flush_buffer(self) -> None:
"""Flush buffered logs to Firestore."""
if not self._log_buffer:
return
try:
for log_entry in self._log_buffer:
self.firestore.append_worker_log(self.job_id, log_entry)
self._log_buffer = []
except Exception:
# If Firestore fails, just clear buffer and continue
self._log_buffer = []
def flush(self) -> None:
"""Flush any remaining buffered logs."""
with self._lock:
self._flush_buffer()
def close(self) -> None:
"""Clean up the handler."""
self.flush()
super().close()
@contextmanager
def job_log_context(
job_id: str,
worker: str = "review",
logger_names: Optional[list] = None,
min_level: int = logging.INFO,
):
"""
Context manager that captures logs and forwards them to Firestore.
This allows the CLI to see real-time logs from operations like
add-lyrics, preview generation, etc.
Args:
job_id: Job ID to associate logs with
worker: Worker name for log categorization
logger_names: List of logger names to capture (None = capture common loggers)
min_level: Minimum log level to capture
Usage:
with job_log_context(job_id, worker="add-lyrics"):
# All logging in this block will be captured
correction_operations.add_lyrics_source(...)
"""
# Default loggers to capture - these cover most of our processing
# Note: We intentionally DON'T include the root logger ('') to avoid
# duplicate log entries since logs propagate up the logger hierarchy.
# Only capture at the top-level package loggers.
if logger_names is None:
logger_names = [
'backend.api.routes.review',
'lyrics_transcriber',
'karaoke_gen',
]
# Create the handler
handler = JobLogHandler(
job_id=job_id,
worker=worker,
min_level=min_level,
)
# Add handler to all specified loggers
loggers = []
for name in logger_names:
log = logging.getLogger(name) if name else logging.getLogger()
log.addHandler(handler)
loggers.append(log)
try:
# Log start
handler.emit(logging.LogRecord(
name='job_log_context',
level=logging.INFO,
pathname='',
lineno=0,
msg=f"🚀 Starting {worker} operation for job {job_id}",
args=(),
exc_info=None,
))
yield handler
finally:
# Log completion
handler.emit(logging.LogRecord(
name='job_log_context',
level=logging.INFO,
pathname='',
lineno=0,
msg=f"✅ Completed {worker} operation for job {job_id}",
args=(),
exc_info=None,
))
# Flush remaining logs
handler.flush()
# Remove handler from all loggers
for log in loggers:
log.removeHandler(handler)
# Close handler
handler.close()
class JobLogger:
"""
A convenience class for direct logging to a job's log stream.
Use this when you want to log specific messages without capturing
all logging output.
"""
def __init__(self, job_id: str, worker: str = "review"):
"""
Initialize job logger.
Args:
job_id: Job ID to log to
worker: Worker name for log categorization
"""
self.job_id = job_id
self.worker = worker
self.firestore = FirestoreService()
def _log(self, level: str, message: str) -> None:
"""Internal logging method."""
log_entry = {
'timestamp': datetime.utcnow().isoformat() + 'Z',
'level': level,
'worker': self.worker,
'message': message[:1000],
}
try:
self.firestore.append_worker_log(self.job_id, log_entry)
except Exception:
pass # Don't let logging errors propagate
def info(self, message: str) -> None:
"""Log an INFO message."""
self._log('INFO', message)
def warning(self, message: str) -> None:
"""Log a WARNING message."""
self._log('WARNING', message)
def error(self, message: str) -> None:
"""Log an ERROR message."""
self._log('ERROR', message)
def debug(self, message: str) -> None:
"""Log a DEBUG message."""
self._log('DEBUG', message)
-596
View File
@@ -1,596 +0,0 @@
"""
Job management and queue operations.
This module handles the complete job lifecycle including:
- Job creation and initialization
- State transitions and validation
- Worker coordination (parallel audio + lyrics processing)
- Progress tracking and timeline events
- Error handling and retries
"""
import logging
import uuid
from datetime import datetime
from typing import Optional, Dict, Any, List
from backend.models.job import Job, JobStatus, JobCreate, STATE_TRANSITIONS
from backend.services.firestore_service import FirestoreService
from backend.services.storage_service import StorageService
logger = logging.getLogger(__name__)
class JobManager:
"""Manager for job lifecycle and state."""
def __init__(self):
"""Initialize job manager with required services."""
self.firestore = FirestoreService()
self.storage = StorageService()
def create_job(self, job_create: JobCreate) -> Job:
"""
Create a new job with initial state PENDING.
Jobs start in PENDING state and transition to DOWNLOADING
when a worker picks them up.
"""
job_id = str(uuid.uuid4())[:8]
now = datetime.utcnow()
job = Job(
job_id=job_id,
status=JobStatus.PENDING, # New state machine starts with PENDING
progress=0,
created_at=now,
updated_at=now,
url=str(job_create.url) if job_create.url else None,
artist=job_create.artist,
title=job_create.title,
# User preferences
enable_cdg=job_create.enable_cdg,
enable_txt=job_create.enable_txt,
enable_youtube_upload=job_create.enable_youtube_upload,
youtube_description=job_create.youtube_description,
webhook_url=job_create.webhook_url,
user_email=job_create.user_email,
# Two-phase workflow (Batch 6)
prep_only=job_create.prep_only,
finalise_only=job_create.finalise_only,
keep_brand_code=job_create.keep_brand_code,
# Request metadata (for tracking and filtering)
request_metadata=job_create.request_metadata,
)
self.firestore.create_job(job)
logger.info(f"Created new job {job_id} with status PENDING")
return job
def get_job(self, job_id: str) -> Optional[Job]:
"""Get a job by ID."""
return self.firestore.get_job(job_id)
def update_job_status(
self,
job_id: str,
status: JobStatus,
progress: Optional[int] = None,
message: Optional[str] = None,
**kwargs
) -> None:
"""Update job status with timeline tracking."""
self.firestore.update_job_status(
job_id=job_id,
status=status,
progress=progress,
message=message,
**kwargs
)
def update_job(self, job_id: str, updates: Dict[str, Any]) -> None:
"""Update job with arbitrary fields."""
self.firestore.update_job(job_id, updates)
def list_jobs(
self,
status: Optional[JobStatus] = None,
environment: Optional[str] = None,
client_id: Optional[str] = None,
created_after: Optional[datetime] = None,
created_before: Optional[datetime] = None,
limit: int = 100
) -> List[Job]:
"""
List jobs with optional filtering.
Args:
status: Filter by job status
environment: Filter by request_metadata.environment (test/production/development)
client_id: Filter by request_metadata.client_id (customer identifier)
created_after: Filter jobs created after this datetime
created_before: Filter jobs created before this datetime
limit: Maximum number of jobs to return
Returns:
List of Job objects matching filters
"""
return self.firestore.list_jobs(
status=status,
environment=environment,
client_id=client_id,
created_after=created_after,
created_before=created_before,
limit=limit
)
def delete_jobs_by_filter(
self,
environment: Optional[str] = None,
client_id: Optional[str] = None,
status: Optional[JobStatus] = None,
created_before: Optional[datetime] = None,
delete_files: bool = True
) -> Dict[str, Any]:
"""
Delete multiple jobs matching filter criteria.
CAUTION: This is a destructive operation. Use carefully.
Args:
environment: Delete jobs with this environment (e.g., "test")
client_id: Delete jobs from this client
status: Delete jobs with this status
created_before: Delete jobs created before this datetime
delete_files: Also delete GCS files (default True)
Returns:
Dict with deletion statistics
"""
# First get matching jobs to delete their files
if delete_files:
jobs = self.firestore.list_jobs(
status=status,
environment=environment,
client_id=client_id,
created_before=created_before,
limit=10000 # High limit for deletion
)
files_deleted = 0
for job in jobs:
# Delete files from various locations
try:
# Delete uploads folder
self.storage.delete_folder(f"uploads/{job.job_id}/")
# Delete jobs folder
self.storage.delete_folder(f"jobs/{job.job_id}/")
files_deleted += 1
except Exception as e:
logger.warning(f"Error deleting files for job {job.job_id}: {e}")
# Delete the jobs from Firestore
deleted_count = self.firestore.delete_jobs_by_filter(
environment=environment,
client_id=client_id,
status=status,
created_before=created_before
)
return {
'jobs_deleted': deleted_count,
'files_deleted': files_deleted if delete_files else 0
}
def mark_job_error(self, job_id: str, error_message: str) -> None:
"""Mark a job as errored."""
self.firestore.update_job_status(
job_id=job_id,
status=JobStatus.ERROR,
progress=0,
message=error_message,
error_message=error_message
)
logger.error(f"Job {job_id} marked as error: {error_message}")
def get_output_urls(self, job_id: str) -> Dict[str, str]:
"""Generate signed URLs for job output files."""
job = self.get_job(job_id)
if not job or not job.output_files:
return {}
urls = {}
for file_type, gcs_path in job.output_files.items():
try:
urls[file_type] = self.storage.generate_signed_url(gcs_path, expiration_minutes=120)
except Exception as e:
logger.error(f"Error generating URL for {file_type}: {e}")
return urls
def delete_job(self, job_id: str, delete_files: bool = True) -> None:
"""Delete a job and optionally its files."""
if delete_files:
job = self.get_job(job_id)
if job and job.output_files:
for gcs_path in job.output_files.values():
try:
self.storage.delete_file(gcs_path)
except Exception as e:
logger.error(f"Error deleting file {gcs_path}: {e}")
self.firestore.delete_job(job_id)
logger.info(f"Deleted job {job_id}")
def validate_state_transition(self, job_id: str, new_status: JobStatus) -> bool:
"""
Validate that a state transition is legal.
Returns:
True if transition is valid, False otherwise
"""
job = self.get_job(job_id)
if not job:
logger.error(f"Job {job_id} not found")
return False
current_status = job.status
valid_transitions = STATE_TRANSITIONS.get(current_status, [])
if new_status not in valid_transitions:
logger.error(
f"Invalid state transition for job {job_id}: "
f"{current_status} -> {new_status}. "
f"Valid transitions: {valid_transitions}"
)
return False
return True
def transition_to_state(
self,
job_id: str,
new_status: JobStatus,
progress: Optional[int] = None,
message: Optional[str] = None,
state_data_updates: Optional[Dict[str, Any]] = None
) -> bool:
"""
Transition job to new state with validation.
Args:
job_id: Job ID
new_status: Target state
progress: Progress percentage (0-100)
message: Timeline message
state_data_updates: Updates to state_data field
Returns:
True if transition succeeded, False otherwise
"""
if not self.validate_state_transition(job_id, new_status):
return False
updates = {
'status': new_status,
'updated_at': datetime.utcnow()
}
if progress is not None:
updates['progress'] = progress
# If we have state_data_updates, merge them with existing state_data
merged_state_data = None
if state_data_updates:
job = self.get_job(job_id)
if job:
merged_state_data = {**job.state_data, **state_data_updates}
# Update job status (includes timeline event), passing state_data if present
if merged_state_data is not None:
self.update_job_status(
job_id=job_id,
status=new_status,
progress=progress,
message=message,
state_data=merged_state_data
)
else:
self.update_job_status(
job_id=job_id,
status=new_status,
progress=progress,
message=message
)
logger.info(f"Job {job_id} transitioned to {new_status}")
return True
def update_state_data(self, job_id: str, key: str, value: Any) -> None:
"""
Update a specific key in the job's state_data field.
This is used by workers to store stage-specific metadata.
"""
job = self.get_job(job_id)
if not job:
logger.error(f"Job {job_id} not found")
return
state_data = job.state_data.copy()
state_data[key] = value
self.update_job(job_id, {'state_data': state_data})
logger.debug(f"Job {job_id} state_data updated: {key} = {value}")
def fail_job(self, job_id: str, error_message: str, error_details: Optional[Dict[str, Any]] = None) -> bool:
"""
Mark a job as failed with error information.
Args:
job_id: Job ID
error_message: Human-readable error message
error_details: Optional structured error details
Returns:
True if successful
"""
try:
# Update error fields
self.update_job(job_id, {
'error_message': error_message,
'error_details': error_details or {}
})
# Use update_job_status which handles timeline
self.update_job_status(
job_id=job_id,
status=JobStatus.FAILED,
message=error_message
)
logger.error(f"Job {job_id} failed: {error_message}")
return True
except Exception as e:
logger.error(f"Error marking job {job_id} as failed: {e}")
return False
def update_file_url(self, job_id: str, category: str, file_type: str, url: str) -> None:
"""
Update a file URL in the job's file_urls structure.
Args:
job_id: Job ID
category: Category (e.g., "stems", "lyrics", "finals")
file_type: File type within category (e.g., "clean", "lrc", "lossless_4k_mp4")
url: GCS URL
"""
job = self.get_job(job_id)
if not job:
logger.error(f"Job {job_id} not found")
return
file_urls = job.file_urls.copy()
if category not in file_urls:
file_urls[category] = {}
file_urls[category][file_type] = url
self.update_job(job_id, {'file_urls': file_urls})
logger.debug(f"Job {job_id} file URL updated: {category}.{file_type}")
def check_parallel_processing_complete(self, job_id: str) -> bool:
"""
Check if both parallel tracks (audio + lyrics) are complete.
This is called after audio_complete or lyrics_complete to determine
if we can proceed to screen generation.
Returns:
True if both tracks complete, False otherwise
"""
job = self.get_job(job_id)
if not job:
return False
audio_complete = job.state_data.get('audio_complete', False)
lyrics_complete = job.state_data.get('lyrics_complete', False)
return audio_complete and lyrics_complete
def mark_audio_complete(self, job_id: str) -> None:
"""
Mark audio processing as complete and check if can proceed.
If lyrics are also complete, automatically triggers screens worker.
"""
self.update_state_data(job_id, 'audio_complete', True)
if self.check_parallel_processing_complete(job_id):
logger.info(f"Job {job_id}: Both audio and lyrics complete, triggering screens worker")
# Transition happens in screens worker
# We just trigger it here
self._trigger_screens_worker(job_id)
def mark_lyrics_complete(self, job_id: str) -> None:
"""
Mark lyrics processing as complete and check if can proceed.
If audio is also complete, automatically triggers screens worker.
"""
self.update_state_data(job_id, 'lyrics_complete', True)
if self.check_parallel_processing_complete(job_id):
logger.info(f"Job {job_id}: Both audio and lyrics complete, triggering screens worker")
# Transition happens in screens worker
# We just trigger it here
self._trigger_screens_worker(job_id)
def _trigger_screens_worker(self, job_id: str) -> None:
"""
Trigger screens generation worker.
Uses WorkerService to make HTTP call to internal API.
This must be async, so we use asyncio to create a task.
"""
import asyncio
from backend.services.worker_service import get_worker_service
logger.info(f"Job {job_id}: Triggering screens worker")
# Create async task to trigger worker
# This allows us to call async code from sync context
async def _trigger():
worker_service = get_worker_service()
await worker_service.trigger_screens_worker(job_id)
# Create task in event loop
try:
loop = asyncio.get_event_loop()
if loop.is_running():
# If loop is already running, create task
asyncio.create_task(_trigger())
else:
# If no loop, run directly
asyncio.run(_trigger())
except RuntimeError:
# Fallback: just log
logger.warning(f"Job {job_id}: Could not trigger screens worker (no event loop)")
# TODO: In production, use message queue instead
def cancel_job(self, job_id: str, reason: Optional[str] = None) -> bool:
"""
Cancel a job.
Only jobs in non-terminal states can be cancelled.
"""
job = self.get_job(job_id)
if not job:
return False
terminal_states = [JobStatus.COMPLETE, JobStatus.FAILED, JobStatus.CANCELLED]
if job.status in terminal_states:
logger.warning(f"Cannot cancel job {job_id} in terminal state {job.status}")
return False
message = f"Job cancelled{f': {reason}' if reason else ''}"
self.update_job_status(
job_id=job_id,
status=JobStatus.CANCELLED,
message=message
)
logger.info(f"Job {job_id} cancelled")
return True
def mark_job_failed(
self,
job_id: str,
error_message: str,
error_details: Optional[Dict[str, Any]] = None
) -> None:
"""
Mark a job as failed with error details.
This replaces mark_job_error() with better error tracking.
"""
updates = {
'error_message': error_message
}
if error_details:
updates['error_details'] = error_details
self.firestore.update_job_status(
job_id=job_id,
status=JobStatus.FAILED,
progress=0,
message=f"Failed: {error_message}",
**updates
)
logger.error(f"Job {job_id} failed: {error_message}")
def increment_retry_count(self, job_id: str) -> int:
"""
Increment retry count for a job.
Returns:
New retry count
"""
job = self.get_job(job_id)
if not job:
return 0
new_count = job.retry_count + 1
self.update_job(job_id, {'retry_count': new_count})
return new_count
def append_worker_log(
self,
job_id: str,
worker: str,
level: str,
message: str,
max_logs: int = 500
) -> None:
"""
Append a log entry to the job's worker_logs atomically.
Uses Firestore ArrayUnion for atomic append to avoid race conditions
when multiple workers (audio + lyrics) are logging concurrently.
Note: max_logs is not enforced per-append (would require transactions).
Logs may grow beyond max_logs; trim periodically if needed.
Args:
job_id: Job ID
worker: Worker name (audio, lyrics, screens, video, render)
level: Log level (DEBUG, INFO, WARNING, ERROR)
message: Log message
max_logs: Not used (kept for API compatibility)
"""
log_entry = {
'timestamp': datetime.utcnow().isoformat() + 'Z',
'level': level,
'worker': worker,
'message': message[:1000] # Truncate long messages
}
# Use atomic ArrayUnion to avoid race conditions
self.firestore.append_worker_log(job_id, log_entry)
def get_worker_logs(
self,
job_id: str,
since_index: int = 0,
worker: Optional[str] = None
) -> List[Dict[str, Any]]:
"""
Get worker logs for a job, optionally filtered by worker and index.
Args:
job_id: Job ID
since_index: Return only logs after this index (for pagination)
worker: Filter by worker name (optional)
Returns:
List of log entries as dicts
"""
job = self.get_job(job_id)
if not job or not job.worker_logs:
return []
logs = [log.dict() if hasattr(log, 'dict') else log for log in job.worker_logs]
# Filter by index
if since_index > 0:
logs = logs[since_index:]
# Filter by worker
if worker:
logs = [log for log in logs if log.get('worker') == worker]
return logs
-106
View File
@@ -1,106 +0,0 @@
"""
Rclone configuration service for cloud storage integration.
This service manages the rclone configuration needed for Dropbox
and other cloud storage uploads from the backend workers.
"""
import logging
import os
import tempfile
from typing import Optional
from backend.config import get_settings
logger = logging.getLogger(__name__)
class RcloneService:
"""Service for managing rclone configuration."""
# Secret Manager secret name for rclone config
RCLONE_CONFIG_SECRET = "rclone-config"
def __init__(self):
self.settings = get_settings()
self._config_file: Optional[str] = None
self._config_loaded = False
def setup_rclone_config(self) -> bool:
"""
Load rclone config from Secret Manager and set up environment.
Writes the config to a temp file and sets RCLONE_CONFIG env var.
Returns:
True if successful, False otherwise
"""
if self._config_loaded:
logger.debug("Rclone config already loaded")
return True
try:
# Get rclone config from Secret Manager
config_content = self.settings.get_secret(self.RCLONE_CONFIG_SECRET)
if not config_content:
logger.warning("Rclone config not found in Secret Manager")
return False
# Write to a temp file
fd, config_path = tempfile.mkstemp(prefix="rclone_", suffix=".conf")
try:
with os.fdopen(fd, 'w') as f:
f.write(config_content)
self._config_file = config_path
# Set environment variable for rclone to find the config
os.environ["RCLONE_CONFIG"] = config_path
logger.info(f"Rclone config loaded and written to {config_path}")
self._config_loaded = True
return True
except Exception:
# Clean up the temp file on error
# Note: os.fdopen() takes ownership of fd, so it's already closed
# We only need to remove the temp file if it exists
if os.path.exists(config_path):
os.unlink(config_path)
raise
except Exception as e:
logger.error(f"Failed to setup rclone config: {e}")
return False
def cleanup(self) -> None:
"""Remove the temporary config file."""
if self._config_file and os.path.exists(self._config_file):
try:
os.unlink(self._config_file)
logger.debug(f"Cleaned up rclone config file: {self._config_file}")
except Exception as e:
logger.warning(f"Failed to cleanup rclone config: {e}")
# Always reset internal state and environment, even if the file was missing
if self._config_file is not None:
os.environ.pop("RCLONE_CONFIG", None)
self._config_file = None
self._config_loaded = False
@property
def is_configured(self) -> bool:
"""Check if rclone is configured and ready to use."""
return self._config_loaded and self._config_file is not None
# Singleton instance
_rclone_service: Optional[RcloneService] = None
def get_rclone_service() -> RcloneService:
"""Get the singleton rclone service instance."""
global _rclone_service
if _rclone_service is None:
_rclone_service = RcloneService()
return _rclone_service
-209
View File
@@ -1,209 +0,0 @@
"""
Google Cloud Storage operations for file management.
"""
import logging
import os
import json
from typing import Optional, BinaryIO, Any, Dict
from pathlib import Path
from google.cloud import storage
from datetime import timedelta
from backend.config import settings
logger = logging.getLogger(__name__)
class StorageService:
"""Service for Google Cloud Storage operations."""
def __init__(self):
"""Initialize GCS client."""
self.client = storage.Client(project=settings.google_cloud_project)
self.bucket = self.client.bucket(settings.gcs_bucket_name)
def upload_file(self, local_path: str, destination_path: str) -> str:
"""Upload a file to GCS."""
try:
blob = self.bucket.blob(destination_path)
blob.upload_from_filename(local_path)
logger.info(f"Uploaded {local_path} to gs://{settings.gcs_bucket_name}/{destination_path}")
return destination_path
except Exception as e:
logger.error(f"Error uploading file {local_path}: {e}")
raise
def upload_fileobj(self, file_obj: BinaryIO, destination_path: str, content_type: Optional[str] = None) -> str:
"""Upload a file object to GCS."""
try:
blob = self.bucket.blob(destination_path)
if content_type:
blob.content_type = content_type
blob.upload_from_file(file_obj, rewind=True)
logger.info(f"Uploaded file object to gs://{settings.gcs_bucket_name}/{destination_path}")
return destination_path
except Exception as e:
logger.error(f"Error uploading file object: {e}")
raise
def download_file(self, source_path: str, destination_path: str) -> str:
"""Download a file from GCS."""
try:
blob = self.bucket.blob(source_path)
blob.download_to_filename(destination_path)
logger.info(f"Downloaded gs://{settings.gcs_bucket_name}/{source_path} to {destination_path}")
return destination_path
except Exception as e:
logger.error(f"Error downloading file {source_path}: {e}")
raise
def generate_signed_url(self, blob_path: str, expiration_minutes: int = 60) -> str:
"""Generate a signed URL for downloading a file.
In Cloud Run, this uses the IAM signBlob API since we don't have
a private key available. Requires the service account to have
roles/iam.serviceAccountTokenCreator on itself.
"""
return self._generate_signed_url_internal(blob_path, "GET", expiration_minutes)
def generate_signed_upload_url(self, blob_path: str, content_type: str = "application/octet-stream", expiration_minutes: int = 60) -> str:
"""Generate a signed URL for uploading a file directly to GCS.
This allows clients to upload files directly to GCS without going through
the backend, bypassing any request body size limits.
Args:
blob_path: The destination path in GCS
content_type: The expected content type of the upload
expiration_minutes: How long the URL is valid for
Returns:
A signed URL that accepts PUT requests with the file content
"""
return self._generate_signed_url_internal(blob_path, "PUT", expiration_minutes, content_type)
def _generate_signed_url_internal(self, blob_path: str, method: str, expiration_minutes: int = 60, content_type: Optional[str] = None) -> str:
"""Internal method to generate signed URLs for GET or PUT operations."""
import google.auth
from google.auth.transport import requests
try:
blob = self.bucket.blob(blob_path)
# Get default credentials and refresh to ensure we have a valid token
credentials, project = google.auth.default()
# Common kwargs for signed URL generation
kwargs = {
"version": "v4",
"expiration": timedelta(minutes=expiration_minutes),
"method": method,
}
# For PUT requests, we need to specify the content type in headers
if method == "PUT" and content_type:
kwargs["headers"] = {"Content-Type": content_type}
# Check if we're using compute credentials (Cloud Run/GCE)
# These need to use IAM signBlob via service_account_email + access_token
if hasattr(credentials, 'service_account_email'):
# Refresh credentials to get a valid access token
auth_request = requests.Request()
credentials.refresh(auth_request)
kwargs["service_account_email"] = credentials.service_account_email
kwargs["access_token"] = credentials.token
url = blob.generate_signed_url(**kwargs)
logger.info(f"Generated signed {method} URL for {blob_path}")
return url
except Exception as e:
logger.error(f"Error generating signed {method} URL for {blob_path}: {e}")
raise
def delete_file(self, blob_path: str) -> None:
"""Delete a file from GCS."""
try:
blob = self.bucket.blob(blob_path)
blob.delete()
logger.info(f"Deleted gs://{settings.gcs_bucket_name}/{blob_path}")
except Exception as e:
logger.error(f"Error deleting file {blob_path}: {e}")
raise
def delete_folder(self, prefix: str) -> int:
"""
Delete all files in GCS with a given prefix (folder).
Args:
prefix: The folder prefix to delete (e.g., "uploads/abc123/")
Returns:
Number of files deleted
"""
try:
blobs = list(self.bucket.list_blobs(prefix=prefix))
deleted_count = 0
for blob in blobs:
try:
blob.delete()
deleted_count += 1
except Exception as e:
logger.warning(f"Error deleting blob {blob.name}: {e}")
if deleted_count > 0:
logger.info(f"Deleted {deleted_count} files from gs://{settings.gcs_bucket_name}/{prefix}")
return deleted_count
except Exception as e:
logger.error(f"Error deleting folder {prefix}: {e}")
return 0 # Don't raise - folder deletion shouldn't break operations
def list_files(self, prefix: str) -> list:
"""List files in GCS with a given prefix."""
try:
blobs = self.bucket.list_blobs(prefix=prefix)
return [blob.name for blob in blobs]
except Exception as e:
logger.error(f"Error listing files with prefix {prefix}: {e}")
raise
def file_exists(self, blob_path: str) -> bool:
"""Check if a file exists in GCS."""
try:
blob = self.bucket.blob(blob_path)
return blob.exists()
except Exception as e:
logger.error(f"Error checking file existence {blob_path}: {e}")
raise
def upload_json(self, destination_path: str, data: Dict[str, Any]) -> str:
"""Upload a JSON object to GCS."""
try:
blob = self.bucket.blob(destination_path)
blob.content_type = "application/json"
blob.upload_from_string(
json.dumps(data, indent=2, ensure_ascii=False),
content_type="application/json"
)
logger.info(f"Uploaded JSON to gs://{settings.gcs_bucket_name}/{destination_path}")
return destination_path
except Exception as e:
logger.error(f"Error uploading JSON to {destination_path}: {e}")
raise
def download_json(self, source_path: str) -> Dict[str, Any]:
"""Download and parse a JSON file from GCS."""
try:
blob = self.bucket.blob(source_path)
content = blob.download_as_text()
data = json.loads(content)
logger.info(f"Downloaded JSON from gs://{settings.gcs_bucket_name}/{source_path}")
return data
except Exception as e:
logger.error(f"Error downloading JSON from {source_path}: {e}")
raise
-382
View File
@@ -1,382 +0,0 @@
"""
OpenTelemetry tracing configuration for Google Cloud Trace.
This module sets up distributed tracing that exports to Google Cloud Trace,
providing visibility into request flows, latency, and errors across the
entire backend.
Usage:
# In main.py or app initialization
from backend.services.tracing import setup_tracing, instrument_app
setup_tracing(service_name="karaoke-backend")
app = FastAPI()
instrument_app(app)
# For custom spans in your code
from backend.services.tracing import tracer, create_span
with tracer.start_as_current_span("my-operation") as span:
span.set_attribute("job_id", job_id)
# ... do work ...
"""
import os
import logging
from typing import Optional, Any, Dict
from contextlib import contextmanager
from functools import wraps
# OpenTelemetry imports
from opentelemetry import trace
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.trace.export import BatchSpanProcessor, SimpleSpanProcessor
from opentelemetry.sdk.resources import Resource, SERVICE_NAME, SERVICE_VERSION
from opentelemetry.trace import Status, StatusCode, Span
from opentelemetry.trace.propagation.tracecontext import TraceContextTextMapPropagator
# Google Cloud Trace exporter
try:
from opentelemetry.exporter.cloud_trace import CloudTraceSpanExporter
from opentelemetry.resourcedetector.gcp_resource_detector import GoogleCloudResourceDetector
GCP_AVAILABLE = True
except ImportError:
GCP_AVAILABLE = False
CloudTraceSpanExporter = None
GoogleCloudResourceDetector = None
# FastAPI instrumentation
try:
from opentelemetry.instrumentation.fastapi import FastAPIInstrumentor
FASTAPI_INSTRUMENTATION_AVAILABLE = True
except ImportError:
FASTAPI_INSTRUMENTATION_AVAILABLE = False
FastAPIInstrumentor = None
# HTTPX instrumentation (for outgoing HTTP calls)
try:
from opentelemetry.instrumentation.httpx import HTTPXClientInstrumentation
HTTPX_INSTRUMENTATION_AVAILABLE = True
except ImportError:
HTTPX_INSTRUMENTATION_AVAILABLE = False
HTTPXClientInstrumentation = None
# Logging instrumentation
try:
from opentelemetry.instrumentation.logging import LoggingInstrumentor
LOGGING_INSTRUMENTATION_AVAILABLE = True
except ImportError:
LOGGING_INSTRUMENTATION_AVAILABLE = False
LoggingInstrumentor = None
logger = logging.getLogger(__name__)
# Global tracer instance
_tracer: Optional[trace.Tracer] = None
_initialized = False
def setup_tracing(
service_name: str = "karaoke-backend",
service_version: str = "0.71.7",
enable_in_dev: bool = False,
) -> bool:
"""
Initialize OpenTelemetry tracing with Google Cloud Trace exporter.
Args:
service_name: Name of the service (appears in Cloud Trace)
service_version: Version of the service
enable_in_dev: Whether to enable tracing in development (default False)
Returns:
True if tracing was initialized, False if skipped
"""
global _tracer, _initialized
if _initialized:
logger.debug("Tracing already initialized")
return True
# Check if we should enable tracing
# In Cloud Run, GOOGLE_CLOUD_PROJECT is always set
is_cloud_run = os.environ.get("K_SERVICE") is not None
gcp_project = os.environ.get("GOOGLE_CLOUD_PROJECT") or os.environ.get("GCP_PROJECT")
if not is_cloud_run and not enable_in_dev:
logger.info("Tracing disabled in development (set enable_in_dev=True to enable)")
_tracer = trace.get_tracer(service_name)
return False
if not GCP_AVAILABLE:
logger.warning("Google Cloud Trace exporter not available, tracing disabled")
_tracer = trace.get_tracer(service_name)
return False
logger.info(f"Initializing OpenTelemetry tracing for {service_name} v{service_version}")
try:
# Create resource with service info and GCP resource detection
resource_attributes = {
SERVICE_NAME: service_name,
SERVICE_VERSION: service_version,
}
# Detect GCP resources (project, region, instance, etc.)
if GoogleCloudResourceDetector and is_cloud_run:
try:
gcp_resource = GoogleCloudResourceDetector().detect()
resource = Resource.create(resource_attributes).merge(gcp_resource)
logger.info("Detected GCP resources for tracing")
except Exception as e:
logger.warning(f"Could not detect GCP resources: {e}")
resource = Resource.create(resource_attributes)
else:
resource = Resource.create(resource_attributes)
# Create tracer provider
provider = TracerProvider(resource=resource)
# Add Cloud Trace exporter
if CloudTraceSpanExporter and gcp_project:
try:
exporter = CloudTraceSpanExporter(project_id=gcp_project)
# Use BatchSpanProcessor for production (better performance)
processor = BatchSpanProcessor(exporter)
provider.add_span_processor(processor)
logger.info(f"Cloud Trace exporter configured for project: {gcp_project}")
except Exception as e:
logger.warning(f"Could not configure Cloud Trace exporter: {e}")
# Set the global tracer provider
trace.set_tracer_provider(provider)
# Get tracer instance
_tracer = trace.get_tracer(service_name, service_version)
# Instrument logging to include trace context
if LOGGING_INSTRUMENTATION_AVAILABLE and LoggingInstrumentor:
try:
LoggingInstrumentor().instrument(set_logging_format=True)
logger.info("Logging instrumentation enabled")
except Exception as e:
logger.warning(f"Could not instrument logging: {e}")
# Instrument HTTPX for outgoing requests
if HTTPX_INSTRUMENTATION_AVAILABLE and HTTPXClientInstrumentation:
try:
HTTPXClientInstrumentation().instrument()
logger.info("HTTPX instrumentation enabled")
except Exception as e:
logger.warning(f"Could not instrument HTTPX: {e}")
_initialized = True
logger.info("OpenTelemetry tracing initialized successfully")
return True
except Exception as e:
logger.error(f"Failed to initialize tracing: {e}")
_tracer = trace.get_tracer(service_name)
return False
def instrument_app(app) -> None:
"""
Instrument a FastAPI application with automatic tracing.
This adds spans for all incoming requests, including:
- Request method and path
- Response status code
- Request duration
- Error information
Args:
app: FastAPI application instance
"""
if not FASTAPI_INSTRUMENTATION_AVAILABLE or not FastAPIInstrumentor:
logger.warning("FastAPI instrumentation not available")
return
try:
FastAPIInstrumentor.instrument_app(
app,
excluded_urls="health,healthz,ready,readiness,ping",
)
logger.info("FastAPI instrumentation enabled")
except Exception as e:
logger.warning(f"Could not instrument FastAPI: {e}")
def get_tracer() -> trace.Tracer:
"""
Get the global tracer instance.
Returns:
Tracer instance (creates a no-op tracer if not initialized)
"""
global _tracer
if _tracer is None:
_tracer = trace.get_tracer("karaoke-backend")
return _tracer
# Convenience alias - lazily forwards attribute access to get_tracer()
class _TracerProxy:
"""Proxy that lazily returns the global tracer."""
def __getattr__(self, name):
return getattr(get_tracer(), name)
tracer = _TracerProxy()
@contextmanager
def create_span(
name: str,
attributes: Optional[Dict[str, Any]] = None,
kind: trace.SpanKind = trace.SpanKind.INTERNAL,
):
"""
Create a traced span as a context manager.
Usage:
with create_span("process-lyrics", {"job_id": job_id}) as span:
# ... do work ...
span.set_attribute("words_processed", 500)
Args:
name: Span name (appears in Cloud Trace)
attributes: Initial span attributes
kind: Span kind (INTERNAL, SERVER, CLIENT, PRODUCER, CONSUMER)
Yields:
The active span
"""
tracer = get_tracer()
with tracer.start_as_current_span(name, kind=kind) as span:
if attributes:
for key, value in attributes.items():
span.set_attribute(key, value)
try:
yield span
except Exception as e:
span.set_status(Status(StatusCode.ERROR, str(e)))
span.record_exception(e)
raise
def traced(
name: Optional[str] = None,
attributes: Optional[Dict[str, Any]] = None,
):
"""
Decorator to trace a function.
Usage:
@traced("process-correction")
def process_correction(job_id: str):
...
@traced(attributes={"operation": "add-lyrics"})
async def add_lyrics(job_id: str, source: str):
...
Args:
name: Span name (defaults to function name)
attributes: Static attributes to add to span
"""
def decorator(func):
span_name = name or func.__name__
@wraps(func)
async def async_wrapper(*args, **kwargs):
with create_span(span_name, attributes) as span:
# Add function arguments as attributes
span.set_attribute("function", func.__name__)
return await func(*args, **kwargs)
@wraps(func)
def sync_wrapper(*args, **kwargs):
with create_span(span_name, attributes) as span:
span.set_attribute("function", func.__name__)
return func(*args, **kwargs)
# Return appropriate wrapper based on function type
import asyncio
if asyncio.iscoroutinefunction(func):
return async_wrapper
return sync_wrapper
return decorator
def add_span_attribute(key: str, value: Any) -> None:
"""
Add an attribute to the current span.
Args:
key: Attribute name
value: Attribute value (must be string, int, float, bool, or list thereof)
"""
span = trace.get_current_span()
if span and span.is_recording():
span.set_attribute(key, value)
def add_span_event(name: str, attributes: Optional[Dict[str, Any]] = None) -> None:
"""
Add an event to the current span.
Events are timestamped annotations that appear in the trace timeline.
Args:
name: Event name
attributes: Event attributes
"""
span = trace.get_current_span()
if span and span.is_recording():
span.add_event(name, attributes=attributes or {})
def set_span_error(error: Exception) -> None:
"""
Mark the current span as errored.
Args:
error: The exception that occurred
"""
span = trace.get_current_span()
if span and span.is_recording():
span.set_status(Status(StatusCode.ERROR, str(error)))
span.record_exception(error)
def get_current_trace_id() -> Optional[str]:
"""
Get the current trace ID for correlation.
This can be used to link logs to traces.
Returns:
Trace ID as hex string, or None if no active trace
"""
span = trace.get_current_span()
if span:
ctx = span.get_span_context()
if ctx.is_valid:
return format(ctx.trace_id, '032x')
return None
def get_current_span_id() -> Optional[str]:
"""
Get the current span ID.
Returns:
Span ID as hex string, or None if no active span
"""
span = trace.get_current_span()
if span:
ctx = span.get_span_context()
if ctx.is_valid:
return format(ctx.span_id, '016x')
return None
-411
View File
@@ -1,411 +0,0 @@
"""
Worker coordination service.
Handles triggering and coordinating background workers.
Supports two modes:
- Cloud Tasks (production): Guaranteed delivery, automatic retries, horizontal scaling
- Direct HTTP (development): Faster iteration, simpler debugging
SOLID Principles:
- Single Responsibility: Only handles worker coordination
- Dependency Inversion: Depends on HTTP abstraction, not implementation
- Open/Closed: Can add new workers without modifying existing code
"""
import logging
import os
import json
from typing import Optional
import httpx
from backend.config import get_settings
logger = logging.getLogger(__name__)
# Mapping of worker types to their Cloud Tasks queue names
# These queues are created by Pulumi in infrastructure/__main__.py
WORKER_QUEUES = {
"audio": "audio-worker-queue",
"lyrics": "lyrics-worker-queue",
"screens": "screens-worker-queue",
"render-video": "render-worker-queue",
"video": "video-worker-queue",
}
class WorkerService:
"""
Service for coordinating background workers.
Supports two execution modes controlled by ENABLE_CLOUD_TASKS env var:
1. Cloud Tasks mode (production, ENABLE_CLOUD_TASKS=true):
- Tasks enqueued to Cloud Tasks for guaranteed delivery
- Automatic retries on failure
- Each task runs in dedicated Cloud Run instance
- Rate limiting to protect external APIs (Modal, AudioShake)
2. Direct HTTP mode (development, ENABLE_CLOUD_TASKS=false):
- Direct HTTP POST to internal worker endpoints
- Worker runs as FastAPI BackgroundTask
- Faster iteration for local development
- No retry guarantees
"""
def __init__(self):
"""Initialize worker service."""
self.settings = get_settings()
self._base_url = self._get_base_url()
self._admin_token = self._get_admin_token()
self._use_cloud_tasks = self._should_use_cloud_tasks()
self._tasks_client = None
if self._use_cloud_tasks:
logger.info("WorkerService initialized with Cloud Tasks mode")
else:
logger.info("WorkerService initialized with direct HTTP mode")
def _should_use_cloud_tasks(self) -> bool:
"""
Check if Cloud Tasks should be used for worker coordination.
Controlled by ENABLE_CLOUD_TASKS setting (from environment variable).
Default is false (direct HTTP mode) for backward compatibility.
Returns:
True if Cloud Tasks should be used, False for direct HTTP
"""
return self.settings.enable_cloud_tasks
@property
def tasks_client(self):
"""
Lazy-initialize Cloud Tasks client.
Only created when needed to avoid import overhead in development mode.
"""
if self._tasks_client is None and self._use_cloud_tasks:
try:
from google.cloud import tasks_v2
self._tasks_client = tasks_v2.CloudTasksClient()
except ImportError:
logger.error(
"google-cloud-tasks not installed. "
"Install with: pip install google-cloud-tasks"
)
raise
return self._tasks_client
def _get_admin_token(self) -> Optional[str]:
"""
Get admin token for internal API authentication.
Returns the first admin token from ADMIN_TOKENS env var.
"""
admin_tokens_str = self.settings.admin_tokens or ""
tokens = [t.strip() for t in admin_tokens_str.split(",") if t.strip()]
if tokens:
return tokens[0]
return None
def _get_base_url(self) -> str:
"""
Get base URL for internal API calls.
Priority:
1. TEST_SERVER_URL env var (for tests)
2. CLOUD_RUN_SERVICE_URL env var (for Cloud Tasks to call back)
3. localhost with PORT env var (for development)
Returns:
Base URL for API calls
"""
# Check for test environment override
test_url = os.getenv("TEST_SERVER_URL")
if test_url:
return test_url
# Production: Cloud Run service URL
# This must be the publicly accessible URL for Cloud Tasks to call
service_url = os.getenv("CLOUD_RUN_SERVICE_URL")
if service_url:
return service_url
# Development mode: use localhost with PORT env var
port = os.getenv("PORT", "8000")
return f"http://localhost:{port}"
async def trigger_worker(
self,
worker_type: str,
job_id: str,
timeout_seconds: int = 30
) -> bool:
"""
Trigger a background worker for a job.
In production (ENABLE_CLOUD_TASKS=true):
- Enqueues task to Cloud Tasks queue
- Cloud Tasks delivers HTTP request to internal endpoint
- Automatic retries on failure with exponential backoff
- Rate limiting protects external APIs
In development (ENABLE_CLOUD_TASKS=false):
- Direct HTTP POST to internal endpoint
- Faster iteration, but no retry guarantees
- Worker runs in same container as API
Args:
worker_type: Worker type ("audio", "lyrics", "screens", "render-video", "video")
job_id: Job ID to process
timeout_seconds: Request timeout (for direct HTTP mode)
Returns:
True if trigger successful (or task enqueued), False otherwise
"""
if self._use_cloud_tasks:
return await self._enqueue_cloud_task(worker_type, job_id)
else:
return await self._trigger_http(worker_type, job_id, timeout_seconds)
async def _enqueue_cloud_task(self, worker_type: str, job_id: str) -> bool:
"""
Enqueue task to Cloud Tasks for guaranteed delivery.
The task will be delivered as an HTTP POST to the internal worker endpoint.
Cloud Tasks handles:
- Retry on failure (with exponential backoff)
- Rate limiting (max dispatches per second)
- Deduplication (via task name if needed)
- OIDC authentication for Cloud Run
Args:
worker_type: Worker type
job_id: Job ID to process
Returns:
True if task enqueued successfully, False otherwise
"""
try:
from google.cloud import tasks_v2
queue_name = WORKER_QUEUES.get(worker_type)
if not queue_name:
logger.error(f"Unknown worker type: {worker_type}")
return False
project = self.settings.google_cloud_project
if not project:
logger.error("GOOGLE_CLOUD_PROJECT not set, cannot enqueue Cloud Task")
return False
location = self.settings.gcp_region # Must match queue location
# Build queue path
parent = self.tasks_client.queue_path(project, location, queue_name)
# Build task payload
task = {
"http_request": {
"http_method": tasks_v2.HttpMethod.POST,
"url": f"{self._base_url}/api/internal/workers/{worker_type}",
"headers": {
"Content-Type": "application/json",
},
"body": json.dumps({"job_id": job_id}).encode(),
# Use OIDC token for Cloud Run authentication
# This allows Cloud Tasks to invoke the Cloud Run service
"oidc_token": {
"service_account_email": f"karaoke-backend@{project}.iam.gserviceaccount.com",
},
},
}
# Add admin auth header if available
# This is needed for the internal endpoint's require_admin dependency
if self._admin_token:
task["http_request"]["headers"]["Authorization"] = f"Bearer {self._admin_token}"
# Create task
# Note: We don't set a task name, allowing Cloud Tasks to generate one
# This prevents duplicate task errors on retries
response = self.tasks_client.create_task(parent=parent, task=task)
logger.info(
f"Created Cloud Task for {worker_type} worker, job {job_id}: {response.name}"
)
return True
except Exception as e:
logger.error(
f"Failed to enqueue Cloud Task for {worker_type}/{job_id}: {e}",
exc_info=True
)
return False
async def _trigger_http(
self,
worker_type: str,
job_id: str,
timeout_seconds: int = 30
) -> bool:
"""
Trigger worker via direct HTTP call (development mode).
This is the original implementation - direct HTTP POST to internal endpoint.
The endpoint adds the worker function to FastAPI BackgroundTasks.
Args:
worker_type: Worker type
job_id: Job ID to process
timeout_seconds: Request timeout
Returns:
True if trigger successful, False otherwise
"""
try:
# Build headers with admin auth token
headers = {}
if self._admin_token:
headers["Authorization"] = f"Bearer {self._admin_token}"
async with httpx.AsyncClient(timeout=timeout_seconds) as client:
url = f"{self._base_url}/api/internal/workers/{worker_type}"
response = await client.post(
url,
json={"job_id": job_id},
headers=headers
)
if response.status_code == 200:
logger.info(f"Successfully triggered {worker_type} worker for job {job_id}")
return True
else:
logger.error(
f"Failed to trigger {worker_type} worker for job {job_id}: "
f"HTTP {response.status_code} - {response.text}"
)
return False
except httpx.TimeoutException:
logger.error(f"Timeout triggering {worker_type} worker for job {job_id}")
return False
except Exception as e:
logger.error(
f"Error triggering {worker_type} worker for job {job_id}: {e}",
exc_info=True
)
return False
# Convenience methods for specific workers
# These provide a cleaner API and better IDE autocomplete
async def trigger_audio_worker(self, job_id: str) -> bool:
"""Trigger audio separation worker."""
return await self.trigger_worker("audio", job_id)
async def trigger_lyrics_worker(self, job_id: str) -> bool:
"""Trigger lyrics transcription worker."""
return await self.trigger_worker("lyrics", job_id)
async def trigger_screens_worker(self, job_id: str) -> bool:
"""Trigger screen generation worker."""
return await self.trigger_worker("screens", job_id)
async def trigger_video_worker(self, job_id: str) -> bool:
"""
Trigger video generation worker.
When USE_CLOUD_RUN_JOBS_FOR_VIDEO=true and ENABLE_CLOUD_TASKS=true,
uses Cloud Run Jobs for execution (supports >30 min encoding).
Otherwise, uses Cloud Tasks or direct HTTP.
"""
if self._use_cloud_tasks and self.settings.use_cloud_run_jobs_for_video:
return await self._trigger_cloud_run_job(job_id)
return await self.trigger_worker("video", job_id)
async def _trigger_cloud_run_job(self, job_id: str) -> bool:
"""
Trigger video encoding as a Cloud Run Job.
Cloud Run Jobs support up to 24 hours of execution time,
making them suitable for very long video encoding tasks.
Args:
job_id: Job ID to process
Returns:
True if job was triggered successfully, False otherwise
"""
try:
from google.cloud import run_v2
project = self.settings.google_cloud_project
if not project:
logger.error("GOOGLE_CLOUD_PROJECT not set, cannot trigger Cloud Run Job")
return False
location = self.settings.gcp_region
job_name = f"projects/{project}/locations/{location}/jobs/video-encoding-job"
# Create Cloud Run Jobs client
client = run_v2.JobsClient()
# Run the job with overrides for the specific job_id
request = run_v2.RunJobRequest(
name=job_name,
overrides=run_v2.RunJobRequest.Overrides(
container_overrides=[
run_v2.RunJobRequest.Overrides.ContainerOverride(
args=["python", "-m", "backend.workers.video_worker", "--job-id", job_id],
)
]
)
)
# Run the job (async operation)
operation = client.run_job(request=request)
logger.info(f"Started Cloud Run Job for video encoding, job {job_id}: {operation.metadata}")
return True
except Exception as e:
logger.error(
f"Failed to trigger Cloud Run Job for video/{job_id}: {e}",
exc_info=True
)
return False
async def trigger_render_video_worker(self, job_id: str) -> bool:
"""Trigger render video worker (post-review)."""
return await self.trigger_worker("render-video", job_id)
# Global worker service instance
_worker_service: Optional[WorkerService] = None
def get_worker_service() -> WorkerService:
"""
Get global worker service instance.
Singleton pattern to reuse HTTP client pool.
Returns:
WorkerService instance
"""
global _worker_service
if _worker_service is None:
_worker_service = WorkerService()
return _worker_service
def reset_worker_service() -> None:
"""
Reset the global worker service instance.
Used in tests to ensure clean state between test cases.
"""
global _worker_service
_worker_service = None
-112
View File
@@ -1,112 +0,0 @@
"""
YouTube credential service for server-side video uploads.
This service manages YouTube OAuth credentials stored in Secret Manager
for non-interactive uploads from backend workers.
"""
import json
import logging
from typing import Optional, Dict, Any
from backend.config import get_settings
logger = logging.getLogger(__name__)
class YouTubeService:
"""Service for managing YouTube OAuth credentials."""
# Secret Manager secret name for YouTube credentials
YOUTUBE_CREDENTIALS_SECRET = "youtube-oauth-credentials"
def __init__(self):
self.settings = get_settings()
self._credentials: Optional[Dict[str, Any]] = None
self._loaded = False
def load_credentials(self) -> bool:
"""
Load YouTube OAuth credentials from Secret Manager.
The secret should contain a JSON object with:
- token: Current access token (may be expired)
- refresh_token: Refresh token for getting new access tokens
- token_uri: Token endpoint URL
- client_id: OAuth client ID
- client_secret: OAuth client secret
- scopes: List of OAuth scopes
Returns:
True if credentials were loaded successfully, False otherwise
"""
if self._loaded:
return self._credentials is not None
try:
# Get credentials from Secret Manager
creds_json = self.settings.get_secret(self.YOUTUBE_CREDENTIALS_SECRET)
if not creds_json:
logger.warning("YouTube credentials not found in Secret Manager")
self._loaded = True
return False
# Parse the credentials JSON
self._credentials = json.loads(creds_json)
# Validate required fields
required_fields = ['refresh_token', 'token_uri', 'client_id', 'client_secret']
missing = [f for f in required_fields if not self._credentials.get(f)]
if missing:
logger.error(f"YouTube credentials missing required fields: {missing}")
self._credentials = None
self._loaded = True
return False
logger.info("YouTube credentials loaded successfully from Secret Manager")
self._loaded = True
return True
except json.JSONDecodeError as e:
logger.error(f"Failed to parse YouTube credentials JSON: {e}")
self._loaded = True
return False
except Exception as e:
logger.error(f"Failed to load YouTube credentials: {e}")
self._loaded = True
return False
def get_credentials_dict(self) -> Optional[Dict[str, Any]]:
"""
Get the YouTube credentials as a dictionary.
This format is compatible with KaraokeFinalise's user_youtube_credentials
parameter, which creates a google.oauth2.credentials.Credentials object.
Returns:
Dictionary with credential data, or None if not available
"""
if not self._loaded:
self.load_credentials()
return self._credentials
@property
def is_configured(self) -> bool:
"""Check if YouTube credentials are configured and ready to use."""
if not self._loaded:
self.load_credentials()
return self._credentials is not None
# Singleton instance
_youtube_service: Optional[YouTubeService] = None
def get_youtube_service() -> YouTubeService:
"""Get the singleton YouTube service instance."""
global _youtube_service
if _youtube_service is None:
_youtube_service = YouTubeService()
return _youtube_service
-4
View File
@@ -1,4 +0,0 @@
"""
Backend integration tests package.
"""
-118
View File
@@ -1,118 +0,0 @@
"""
Shared pytest fixtures for backend tests.
Provides common mocks and test utilities across all test modules.
NOTE: Module-level mocks are NOT applied here to allow emulator tests to work.
Individual tests must mock dependencies as needed.
"""
import os
import pytest
from unittest.mock import Mock, MagicMock, AsyncMock, patch
from datetime import datetime, UTC
from fastapi.testclient import TestClient
# Mock google.auth.default for unit tests if not using emulator
# This prevents DefaultCredentialsError during imports
if 'FIRESTORE_EMULATOR_HOST' not in os.environ:
from unittest.mock import MagicMock
# Only mock the default() function, not the entire module
# This allows other google.auth imports to work normally
try:
import google.auth
mock_credentials = MagicMock()
mock_credentials.token = 'fake-token'
mock_credentials.valid = True
mock_credentials.universe_domain = 'googleapis.com' # Required by google-cloud-storage
mock_credentials.project_id = 'test-project'
google.auth.default = MagicMock(return_value=(mock_credentials, 'test-project'))
except ImportError:
# If google.auth not installed, that's ok for some tests
pass
from backend.models.job import Job, JobStatus, JobCreate
@pytest.fixture
def mock_firestore():
"""Mock Firestore client for unit tests."""
# Mock at module level for unit tests
with patch('google.cloud.firestore.Client') as mock_cls:
client = MagicMock()
mock_cls.return_value = client
yield client
@pytest.fixture
def mock_storage_client():
"""Mock GCS Storage client for unit tests."""
# Mock at module level for unit tests
with patch('google.cloud.storage.Client') as mock_cls:
client = MagicMock()
mock_cls.return_value = client
yield client
@pytest.fixture
def mock_httpx_client():
"""Mock httpx AsyncClient for worker service."""
with patch('backend.services.worker_service.httpx.AsyncClient') as mock:
client = AsyncMock()
mock.return_value.__aenter__.return_value = client
yield client
@pytest.fixture
def sample_job():
"""Create a sample Job instance for testing."""
return Job(
job_id="test123",
status=JobStatus.PENDING,
progress=0,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
artist="Test Artist",
title="Test Song",
url="https://youtube.com/watch?v=test"
)
@pytest.fixture
def sample_job_create():
"""Create a sample JobCreate instance for testing."""
return JobCreate(
url="https://youtube.com/watch?v=test",
artist="Test Artist",
title="Test Song"
)
@pytest.fixture
def test_client():
"""Create a FastAPI TestClient."""
# Import here to avoid circular dependency
from backend.main import app
return TestClient(app)
def create_mock_job(**kwargs):
"""
Factory function to create mock Job instances with custom fields.
Args:
**kwargs: Job fields to override defaults
Returns:
Job instance with specified fields
"""
defaults = {
"job_id": "test123",
"status": JobStatus.PENDING,
"progress": 0,
"created_at": datetime.now(UTC),
"updated_at": datetime.now(UTC)
}
defaults.update(kwargs)
return Job(**defaults)
-7
View File
@@ -1,7 +0,0 @@
"""
Emulator integration tests.
These tests run against local GCP emulators (Firestore, GCS)
to provide true integration testing without cloud costs.
"""
-88
View File
@@ -1,88 +0,0 @@
"""
Fixtures for emulator integration tests.
These tests use REAL Firestore and GCS emulators, so we DON'T mock google.cloud modules.
Run with: scripts/run-emulator-tests.sh
"""
import pytest
import os
import requests
from unittest.mock import AsyncMock, patch
def emulators_running() -> bool:
"""Check if GCP emulators are running."""
try:
# Check Firestore emulator
requests.get("http://127.0.0.1:8080", timeout=1)
# Check GCS emulator
requests.get("http://127.0.0.1:4443", timeout=1)
return True
except (requests.exceptions.ConnectionError, requests.exceptions.Timeout):
return False
# Skip all tests in this module if emulators aren't running
pytestmark = pytest.mark.skipif(
not emulators_running(),
reason="GCP emulators not running. Start with: scripts/start-emulators.sh"
)
# Set emulator environment variables (use 127.0.0.1 to force IPv4)
os.environ["FIRESTORE_EMULATOR_HOST"] = "127.0.0.1:8080"
os.environ["STORAGE_EMULATOR_HOST"] = "http://127.0.0.1:4443"
os.environ["GOOGLE_CLOUD_PROJECT"] = "test-project"
os.environ["GCS_BUCKET_NAME"] = "test-bucket"
os.environ["FIRESTORE_COLLECTION"] = "test-jobs"
os.environ["ENVIRONMENT"] = "test"
os.environ["ADMIN_TOKENS"] = "test-admin-token"
# Only import app if emulators are running
if emulators_running():
from fastapi.testclient import TestClient
from backend.main import app
else:
TestClient = None
app = None
@pytest.fixture(scope="session", autouse=True)
def setup_gcs_bucket():
"""Create GCS bucket in emulator before all tests."""
try:
response = requests.post(
"http://127.0.0.1:4443/storage/v1/b",
json={"name": "test-bucket"},
params={"project": "test-project"},
timeout=5
)
if response.status_code in [200, 409]:
print("✅ GCS bucket 'test-bucket' ready in emulator")
except Exception as e:
print(f"⚠️ GCS bucket setup failed: {e}")
yield
@pytest.fixture(scope="session")
def mock_worker_service():
"""Mock worker service to prevent background tasks."""
with patch("backend.api.routes.jobs.worker_service") as mock:
mock.trigger_audio_worker = AsyncMock(return_value=True)
mock.trigger_lyrics_worker = AsyncMock(return_value=True)
mock.trigger_screens_worker = AsyncMock(return_value=True)
mock.trigger_video_worker = AsyncMock(return_value=True)
yield mock
@pytest.fixture(scope="session")
def client(mock_worker_service):
"""Create FastAPI test client with mocked workers."""
with patch("backend.api.routes.file_upload.worker_service", mock_worker_service):
return TestClient(app)
@pytest.fixture
def auth_headers():
"""Auth headers for testing."""
return {"Authorization": "Bearer test-admin-token"}
@@ -1,354 +0,0 @@
"""
Integration tests using local GCP emulators.
These tests use real Firestore and GCS emulators running locally,
providing true integration testing without cloud resources or costs.
Run with: ./scripts/run-emulator-tests.sh
NOTE: These tests mock background workers to avoid race conditions.
The fixtures are defined in conftest.py in this directory.
"""
import pytest
import time
from .conftest import emulators_running
# Skip all tests in this module if emulators aren't running
pytestmark = pytest.mark.skipif(
not emulators_running(),
reason="GCP emulators not running. Start with: scripts/start-emulators.sh"
)
# Fixtures are loaded from conftest.py in this directory
class TestEmulatorBasics:
"""Basic emulator connectivity tests."""
def test_health_endpoint(self, client):
"""Test health endpoint works."""
response = client.get("/api/health")
assert response.status_code == 200
assert response.json()["status"] == "healthy"
def test_root_endpoint(self, client):
"""Test root endpoint works."""
response = client.get("/")
assert response.status_code == 200
assert response.json()["service"] == "karaoke-gen-backend"
class TestJobCreation:
"""Test job creation with Firestore emulator."""
def test_create_job_simple(self, client, auth_headers):
"""Test creating a simple job."""
response = client.post(
"/api/jobs",
headers=auth_headers,
json={"url": "https://youtube.com/watch?v=test123"}
)
assert response.status_code == 200
data = response.json()
assert data["status"] == "success"
assert "job_id" in data
def test_create_job_with_metadata(self, client, auth_headers):
"""Test creating a job with artist/title."""
response = client.post(
"/api/jobs",
headers=auth_headers,
json={
"url": "https://youtube.com/watch?v=test",
"artist": "Test Artist",
"title": "Test Song"
}
)
assert response.status_code == 200
data = response.json()
assert "job_id" in data
class TestJobRetrieval:
"""Test job retrieval from Firestore emulator."""
def test_create_and_get_job(self, client, auth_headers):
"""Test creating and then retrieving a job."""
# Create
create_resp = client.post(
"/api/jobs",
headers=auth_headers,
json={
"url": "https://youtube.com/watch?v=abc123",
"artist": "Test Artist",
"title": "Test Song"
}
)
assert create_resp.status_code == 200
job_id = create_resp.json()["job_id"]
# Small delay for emulator consistency
time.sleep(0.2)
# Retrieve
get_resp = client.get(f"/api/jobs/{job_id}", headers=auth_headers)
if get_resp.status_code != 200:
print(f"GET failed: {get_resp.status_code} - {get_resp.text}")
assert get_resp.status_code == 200
job = get_resp.json()
assert job["job_id"] == job_id
assert job["status"] == "pending"
assert job["artist"] == "Test Artist"
assert job["title"] == "Test Song"
def test_get_nonexistent_job(self, client, auth_headers):
"""Test fetching a job that doesn't exist."""
response = client.get("/api/jobs/nonexistent-id", headers=auth_headers)
assert response.status_code == 404
class TestJobList:
"""Test listing jobs from Firestore."""
def test_list_jobs(self, client, auth_headers):
"""Test listing jobs."""
# Create a few jobs
for i in range(3):
client.post(
"/api/jobs",
headers=auth_headers,
json={"url": f"https://youtube.com/watch?v=list{i}"}
)
time.sleep(0.2)
# List
response = client.get("/api/jobs", headers=auth_headers)
assert response.status_code == 200
jobs = response.json()
assert isinstance(jobs, list)
# We should have at least the 3 we just created
assert len(jobs) >= 3
class TestJobDeletion:
"""Test job deletion."""
def test_delete_job(self, client, auth_headers):
"""Test deleting a job."""
# Create
create_resp = client.post(
"/api/jobs",
headers=auth_headers,
json={"url": "https://youtube.com/watch?v=delete-me"}
)
job_id = create_resp.json()["job_id"]
time.sleep(0.2)
# Delete
del_resp = client.delete(f"/api/jobs/{job_id}", headers=auth_headers)
assert del_resp.status_code == 200
# Verify deleted
get_resp = client.get(f"/api/jobs/{job_id}", headers=auth_headers)
assert get_resp.status_code == 404
class TestJobUpdates:
"""Test job status updates."""
def test_cancel_job(self, client, auth_headers):
"""Test cancelling a job."""
# Create
create_resp = client.post(
"/api/jobs",
headers=auth_headers,
json={"url": "https://youtube.com/watch?v=cancel-me"}
)
job_id = create_resp.json()["job_id"]
time.sleep(0.2)
# Cancel
cancel_resp = client.post(
f"/api/jobs/{job_id}/cancel",
headers=auth_headers,
json={"reason": "test cancellation"}
)
assert cancel_resp.status_code == 200
# Verify cancelled
get_resp = client.get(f"/api/jobs/{job_id}", headers=auth_headers)
assert get_resp.status_code == 200
job = get_resp.json()
assert job["status"] == "cancelled"
class TestFileUpload:
"""Test file upload with GCS emulator."""
def test_upload_file(self, client, auth_headers):
"""Test uploading a file."""
test_file_content = b"fake audio data for testing"
response = client.post(
"/api/jobs/upload",
headers={"Authorization": auth_headers["Authorization"]},
files={"file": ("test.flac", test_file_content, "audio/flac")},
data={"artist": "Upload Artist", "title": "Upload Song"}
)
assert response.status_code == 200
data = response.json()
assert data["status"] == "success"
assert "job_id" in data
job_id = data["job_id"]
time.sleep(0.2)
# Verify job created with upload data
get_resp = client.get(f"/api/jobs/{job_id}", headers=auth_headers)
assert get_resp.status_code == 200
job = get_resp.json()
assert job["artist"] == "Upload Artist"
assert job["title"] == "Upload Song"
assert "input_media_gcs_path" in job
class TestInternalEndpoints:
"""Test internal worker endpoints."""
def test_internal_workers_exist(self, client, auth_headers):
"""Test that internal worker endpoints exist and respond."""
# Create a job first
create_resp = client.post(
"/api/jobs",
headers=auth_headers,
json={"url": "https://youtube.com/watch?v=worker-test"}
)
job_id = create_resp.json()["job_id"]
time.sleep(0.2)
# Test audio worker endpoint exists
response = client.post(
"/api/internal/workers/audio",
headers=auth_headers,
json={"job_id": job_id}
)
assert response.status_code == 200
assert response.json()["status"] == "started"
class TestReviewEndpoints:
"""Test lyrics review API endpoints."""
def test_review_ping(self, client, auth_headers):
"""Test review ping endpoint."""
# Create a job first
create_resp = client.post(
"/api/jobs",
headers=auth_headers,
json={"url": "https://youtube.com/watch?v=review-test"}
)
job_id = create_resp.json()["job_id"]
# Ping should work for any job
response = client.get(f"/api/review/{job_id}/ping")
assert response.status_code == 200
assert response.json()["status"] == "ok"
def test_review_correction_data_wrong_status(self, client, auth_headers):
"""Test that correction-data returns error for non-review jobs."""
# Create a job (starts in pending status)
create_resp = client.post(
"/api/jobs",
headers=auth_headers,
json={"url": "https://youtube.com/watch?v=review-status-test"}
)
job_id = create_resp.json()["job_id"]
time.sleep(0.2)
# Should fail - job not in AWAITING_REVIEW status
response = client.get(f"/api/review/{job_id}/correction-data")
assert response.status_code == 400
assert "not ready for review" in response.json()["detail"].lower()
def test_review_audio_no_job(self, client):
"""Test audio endpoint returns 404 for nonexistent job."""
response = client.get("/api/review/nonexistent-job/audio/")
assert response.status_code == 404
def test_review_preview_video_stub(self, client, auth_headers):
"""Test preview video endpoint exists."""
# Create a job
create_resp = client.post(
"/api/jobs",
headers=auth_headers,
json={"url": "https://youtube.com/watch?v=preview-test"}
)
job_id = create_resp.json()["job_id"]
# Preview video should return error since job not ready
response = client.post(
f"/api/review/{job_id}/preview-video",
json={"corrections": [], "corrected_segments": []}
)
# Should return 400 (job not in AWAITING_REVIEW state)
assert response.status_code == 400
def test_review_annotations_stub(self, client, auth_headers):
"""Test annotations endpoint (stub)."""
create_resp = client.post(
"/api/jobs",
headers=auth_headers,
json={"url": "https://youtube.com/watch?v=annotation-test"}
)
job_id = create_resp.json()["job_id"]
# Annotations endpoint should accept data (even if it just logs it)
response = client.post(
f"/api/review/{job_id}/v1/annotations",
json={"type": "test", "data": "test annotation"}
)
assert response.status_code == 200
assert response.json()["status"] == "success"
class TestRenderVideoWorker:
"""Test render video worker endpoint."""
def test_render_video_worker_endpoint_exists(self, client, auth_headers):
"""Test that render-video worker endpoint exists."""
# Create a job
create_resp = client.post(
"/api/jobs",
headers=auth_headers,
json={"url": "https://youtube.com/watch?v=render-test"}
)
job_id = create_resp.json()["job_id"]
time.sleep(0.2)
# Test render-video worker endpoint exists
response = client.post(
"/api/internal/workers/render-video",
headers=auth_headers,
json={"job_id": job_id}
)
# Should return 200 (endpoint exists and starts)
assert response.status_code == 200
print("✅ Emulator integration tests ready to run")
@@ -1,436 +0,0 @@
"""
Direct tests for render_video_worker style loading.
Tests the fix for styles being loaded from job.style_params_gcs_path
instead of the incorrect job.state_data['styles_gcs_path'].
Run with:
./scripts/start-emulators.sh
pytest backend/tests/emulator/test_style_loading_direct.py -v
"""
import pytest
import json
import os
import tempfile
import requests
from dataclasses import dataclass
from typing import Dict, Optional
def emulators_running() -> bool:
"""Check if GCP emulators are running."""
try:
requests.get("http://127.0.0.1:8080", timeout=1)
requests.get("http://127.0.0.1:4443", timeout=1)
return True
except (requests.exceptions.ConnectionError, requests.exceptions.Timeout):
return False
# Skip all tests in this module if emulators aren't running
pytestmark = pytest.mark.skipif(
not emulators_running(),
reason="GCP emulators not running. Start with: scripts/start-emulators.sh"
)
# Set up environment for emulators
os.environ["FIRESTORE_EMULATOR_HOST"] = "127.0.0.1:8080"
os.environ["STORAGE_EMULATOR_HOST"] = "http://127.0.0.1:4443"
os.environ["GOOGLE_CLOUD_PROJECT"] = "test-project"
os.environ["GCS_BUCKET_NAME"] = "test-bucket"
@dataclass
class MockJob:
"""Mock job object for testing style loading."""
job_id: str
style_params_gcs_path: Optional[str] = None
style_assets: Dict[str, str] = None
state_data: Dict = None
def __post_init__(self):
if self.style_assets is None:
self.style_assets = {}
if self.state_data is None:
self.state_data = {}
class MockStorageService:
"""Mock storage service that uses GCS emulator."""
def __init__(self):
from google.cloud import storage
self.client = storage.Client()
self.bucket_name = "test-bucket"
self._ensure_bucket_exists()
def _ensure_bucket_exists(self):
"""Create bucket in emulator if it doesn't exist."""
try:
self.client.create_bucket(self.bucket_name)
except Exception:
pass # Bucket already exists
def upload_string(self, content: str, gcs_path: str, content_type: str = "application/json"):
"""Upload string content to GCS."""
bucket = self.client.bucket(self.bucket_name)
blob = bucket.blob(gcs_path)
blob.upload_from_string(content, content_type=content_type)
def upload_bytes(self, content: bytes, gcs_path: str, content_type: str = "application/octet-stream"):
"""Upload bytes to GCS."""
bucket = self.client.bucket(self.bucket_name)
blob = bucket.blob(gcs_path)
blob.upload_from_string(content, content_type=content_type)
def download_file(self, gcs_path: str, local_path: str):
"""Download file from GCS to local path."""
bucket = self.client.bucket(self.bucket_name)
blob = bucket.blob(gcs_path)
blob.download_to_filename(local_path)
def file_exists(self, gcs_path: str) -> bool:
"""Check if file exists in GCS."""
bucket = self.client.bucket(self.bucket_name)
blob = bucket.blob(gcs_path)
return blob.exists()
class TestStyleLoadingFix:
"""
Tests for the render_video_worker style loading fix.
The bug was: render_video_worker looked for styles at
job.state_data.get('styles_gcs_path') but styles are actually stored at
job.style_params_gcs_path and job.style_assets.
"""
@pytest.fixture(autouse=True)
def setup(self):
"""Set up storage service and temp directory for each test."""
self.storage = MockStorageService()
self.temp_dir = tempfile.mkdtemp()
yield
# Cleanup
import shutil
shutil.rmtree(self.temp_dir, ignore_errors=True)
def _import_get_or_create_styles(self):
"""
Import _get_or_create_styles without importing the full worker module.
We copy the function here to avoid import issues with lyrics_transcriber.
"""
# We'll test using a copy of the function logic
# This avoids importing the full worker which has lyrics_transcriber dependency
pass
def test_style_loading_from_correct_location(self):
"""
Test that styles are loaded from job.style_params_gcs_path,
NOT from job.state_data['styles_gcs_path'].
"""
import time
job_id = f"test-style-{int(time.time() * 1000)}"
# Create style JSON with placeholder paths
style_json = {
"intro": {
"background_image": "/original/path/intro_bg.png",
"font": "/original/path/font.ttf"
},
"karaoke": {
"background_image": "/original/path/karaoke_bg.png",
"font_path": "/original/path/font.ttf",
"font_size": 100
},
"end": {
"background_image": "/original/path/end_bg.png",
"font": "/original/path/font.ttf"
}
}
# Upload style JSON to GCS (the CORRECT location)
style_gcs_path = f"uploads/{job_id}/style/style_params.json"
self.storage.upload_string(json.dumps(style_json), style_gcs_path)
# Upload mock assets
assets = {
"intro_background": f"uploads/{job_id}/style/intro_background.png",
"karaoke_background": f"uploads/{job_id}/style/karaoke_background.png",
"end_background": f"uploads/{job_id}/style/end_background.png",
"font": f"uploads/{job_id}/style/font.ttf",
}
for asset_key, gcs_path in assets.items():
# Upload fake file content
self.storage.upload_bytes(b"fake image/font data", gcs_path)
# Create mock job with styles in the CORRECT location
job = MockJob(
job_id=job_id,
style_params_gcs_path=style_gcs_path, # CORRECT
style_assets=assets, # CORRECT
state_data={} # state_data is EMPTY (no styles_gcs_path)
)
# Verify files exist in GCS
assert self.storage.file_exists(style_gcs_path), "Style JSON should exist in GCS"
for gcs_path in assets.values():
assert self.storage.file_exists(gcs_path), f"Asset {gcs_path} should exist in GCS"
# Now test the style loading logic (inline version of _get_or_create_styles)
style_dir = os.path.join(self.temp_dir, "style")
os.makedirs(style_dir, exist_ok=True)
styles_path = os.path.join(style_dir, "styles.json")
# This is the FIX: check job.style_params_gcs_path, not state_data
if job.style_params_gcs_path:
# Download style JSON
self.storage.download_file(job.style_params_gcs_path, styles_path)
# Load and update paths
with open(styles_path, 'r') as f:
style_data = json.load(f)
# Download assets and update paths
local_assets = {}
for asset_key, gcs_path in job.style_assets.items():
ext = os.path.splitext(gcs_path)[1] or '.png'
local_path = os.path.join(style_dir, f"{asset_key}{ext}")
self.storage.download_file(gcs_path, local_path)
local_assets[asset_key] = local_path
# Update style_data with local paths
asset_mapping = {
'intro_background': ('intro', 'background_image'),
'karaoke_background': ('karaoke', 'background_image'),
'end_background': ('end', 'background_image'),
'font': [('intro', 'font'), ('karaoke', 'font_path'), ('end', 'font')],
}
for asset_key, local_path in local_assets.items():
if asset_key in asset_mapping:
mappings = asset_mapping[asset_key]
if isinstance(mappings[0], str):
mappings = [mappings]
for section, field in mappings:
if section in style_data:
style_data[section][field] = local_path
# Save updated styles
with open(styles_path, 'w') as f:
json.dump(style_data, f, indent=2)
# Verify the result
with open(styles_path, 'r') as f:
result = json.load(f)
# Check that paths were updated to local paths
assert style_dir in result['karaoke']['background_image'], \
f"karaoke.background_image should be local path, got: {result['karaoke']['background_image']}"
assert style_dir in result['karaoke']['font_path'], \
f"karaoke.font_path should be local path, got: {result['karaoke']['font_path']}"
assert style_dir in result['intro']['background_image'], \
f"intro.background_image should be local path"
# Verify files actually exist locally
assert os.path.exists(result['karaoke']['background_image']), \
"Downloaded karaoke background should exist"
assert os.path.exists(result['karaoke']['font_path']), \
"Downloaded font should exist"
print(f"\n✅ Style loading from job.style_params_gcs_path works!")
print(f" karaoke.background_image: {result['karaoke']['background_image']}")
print(f" karaoke.font_path: {result['karaoke']['font_path']}")
def test_old_bug_state_data_lookup_fails(self):
"""
Demonstrate that the OLD bug would fail to find styles.
If we look at job.state_data['styles_gcs_path'] (the bug),
we won't find anything because styles are stored at
job.style_params_gcs_path.
"""
import time
job_id = f"test-bug-{int(time.time() * 1000)}"
# Upload style to CORRECT location
style_gcs_path = f"uploads/{job_id}/style/style_params.json"
self.storage.upload_string('{"karaoke": {"font_size": 100}}', style_gcs_path)
# Create job with styles in CORRECT location
job = MockJob(
job_id=job_id,
style_params_gcs_path=style_gcs_path, # CORRECT location
style_assets={},
state_data={} # No styles_gcs_path here!
)
# THE BUG: looking in state_data instead of style_params_gcs_path
wrong_path = job.state_data.get('styles_gcs_path')
correct_path = job.style_params_gcs_path
assert wrong_path is None, "state_data['styles_gcs_path'] should be None (the bug location)"
assert correct_path is not None, "style_params_gcs_path should have the correct path"
assert self.storage.file_exists(correct_path), "Style should exist at correct path"
print(f"\n✅ Demonstrated the bug: state_data lookup returns None")
print(f" state_data['styles_gcs_path'] = {wrong_path}")
print(f" job.style_params_gcs_path = {correct_path}")
def test_default_styles_when_no_custom_styles(self):
"""Test that default styles are used when no custom styles provided."""
import time
job_id = f"test-default-{int(time.time() * 1000)}"
# Job with NO custom styles
job = MockJob(
job_id=job_id,
style_params_gcs_path=None,
style_assets={},
state_data={}
)
# Simulate the logic
style_dir = os.path.join(self.temp_dir, "style")
os.makedirs(style_dir, exist_ok=True)
styles_path = os.path.join(style_dir, "styles.json")
if job.style_params_gcs_path:
# Would load custom styles
pass
else:
# Use default styles
default_styles = {
"karaoke": {
"background_color": "#000000",
"font": "Arial",
"font_path": "",
"font_size": 100
}
}
with open(styles_path, 'w') as f:
json.dump(default_styles, f, indent=2)
# Verify defaults were used
with open(styles_path, 'r') as f:
result = json.load(f)
assert result['karaoke']['background_color'] == "#000000"
assert result['karaoke']['font'] == "Arial"
print(f"\n✅ Default styles used when no custom styles provided")
class TestParallelWorkerExecution:
"""
Tests for the parallel worker execution fix.
The bug was: FastAPI's BackgroundTasks runs async tasks sequentially,
causing audio worker to complete before lyrics worker starts.
The fix uses asyncio.gather() to run both workers in parallel.
"""
def test_asyncio_gather_runs_parallel(self):
"""Test that asyncio.gather actually runs tasks in parallel."""
import asyncio
import time
start_times = {}
end_times = {}
async def task1():
start_times['task1'] = time.time()
await asyncio.sleep(0.1)
end_times['task1'] = time.time()
return "task1 done"
async def task2():
start_times['task2'] = time.time()
await asyncio.sleep(0.1)
end_times['task2'] = time.time()
return "task2 done"
async def run_parallel():
return await asyncio.gather(task1(), task2())
overall_start = time.time()
results = asyncio.run(run_parallel())
overall_duration = time.time() - overall_start
# Both tasks should have started at nearly the same time
start_diff = abs(start_times['task1'] - start_times['task2'])
# If running in parallel:
# - Both start at ~same time (diff < 0.05s)
# - Total duration is ~0.1s (not 0.2s for sequential)
assert start_diff < 0.05, \
f"Tasks should start together, diff was {start_diff:.3f}s"
assert overall_duration < 0.15, \
f"Parallel execution should take ~0.1s, took {overall_duration:.3f}s"
print(f"\n✅ asyncio.gather runs tasks in parallel!")
print(f" Task start time difference: {start_diff:.3f}s")
print(f" Total duration: {overall_duration:.3f}s (sequential would be ~0.2s)")
def test_sequential_background_tasks_is_slow(self):
"""
Demonstrate that sequential execution (the bug) is slower.
"""
import asyncio
import time
execution_order = []
async def task1():
execution_order.append(('task1', 'start'))
await asyncio.sleep(0.05)
execution_order.append(('task1', 'end'))
async def task2():
execution_order.append(('task2', 'start'))
await asyncio.sleep(0.05)
execution_order.append(('task2', 'end'))
# Sequential (the bug)
async def run_sequential():
await task1()
await task2()
execution_order.clear()
start = time.time()
asyncio.run(run_sequential())
sequential_duration = time.time() - start
sequential_order = execution_order.copy()
# Parallel (the fix)
async def run_parallel():
await asyncio.gather(task1(), task2())
execution_order.clear()
start = time.time()
asyncio.run(run_parallel())
parallel_duration = time.time() - start
parallel_order = execution_order.copy()
# Sequential: task1 starts, task1 ends, task2 starts, task2 ends
assert sequential_order[0] == ('task1', 'start')
assert sequential_order[1] == ('task1', 'end')
assert sequential_order[2] == ('task2', 'start')
# Parallel: task1 starts, task2 starts (interleaved)
assert parallel_order[0][1] == 'start'
assert parallel_order[1][1] == 'start'
# Parallel should be ~2x faster
assert parallel_duration < sequential_duration * 0.8, \
f"Parallel ({parallel_duration:.3f}s) should be faster than sequential ({sequential_duration:.3f}s)"
print(f"\n✅ Demonstrated sequential vs parallel execution")
print(f" Sequential: {sequential_duration:.3f}s - {sequential_order}")
print(f" Parallel: {parallel_duration:.3f}s - {parallel_order}")
print("✅ Style loading and parallel execution tests ready")
@@ -1,229 +0,0 @@
"""
Direct tests for worker logging Firestore operations.
These tests bypass the full app/worker imports and test the Firestore
operations directly, avoiding dependency issues.
Run with: ./scripts/run-emulator-tests.sh
"""
import pytest
import time
import requests
import os
import threading
from concurrent.futures import ThreadPoolExecutor, as_completed
from datetime import datetime
def emulators_running() -> bool:
"""Check if GCP emulators are running."""
try:
requests.get("http://127.0.0.1:8080", timeout=1)
return True
except (requests.exceptions.ConnectionError, requests.exceptions.Timeout):
return False
# Skip all tests in this module if emulators aren't running
pytestmark = pytest.mark.skipif(
not emulators_running(),
reason="GCP emulators not running. Start with: scripts/start-emulators.sh"
)
# Set up environment for emulator
os.environ["FIRESTORE_EMULATOR_HOST"] = "127.0.0.1:8080"
os.environ["GOOGLE_CLOUD_PROJECT"] = "test-project"
class TestWorkerLogsFirestoreDirect:
"""Direct Firestore tests for worker logs - no app imports needed."""
@pytest.fixture(autouse=True)
def setup_firestore(self):
"""Set up Firestore client for each test."""
from google.cloud import firestore
self.db = firestore.Client(project="test-project")
self.collection = "test-worker-logs"
yield
def _create_test_job(self):
"""Create a test job document."""
job_id = f"test-{int(time.time() * 1000)}"
doc_ref = self.db.collection(self.collection).document(job_id)
doc_ref.set({
"job_id": job_id,
"status": "pending",
"created_at": datetime.utcnow(),
"worker_logs": []
})
return job_id
def _append_log_read_modify_write(self, job_id: str, worker: str, message: str):
"""
OLD METHOD: Read-modify-write (has race condition).
This is what we were doing before.
"""
doc_ref = self.db.collection(self.collection).document(job_id)
doc = doc_ref.get()
if not doc.exists:
return
data = doc.to_dict()
logs = data.get("worker_logs", [])
logs.append({
"timestamp": datetime.utcnow().isoformat() + "Z",
"level": "INFO",
"worker": worker,
"message": message
})
doc_ref.update({"worker_logs": logs})
def _append_log_array_union(self, job_id: str, worker: str, message: str):
"""
NEW METHOD: ArrayUnion (atomic, no race condition).
This is what we're doing now.
"""
from google.cloud import firestore
doc_ref = self.db.collection(self.collection).document(job_id)
doc_ref.update({
"worker_logs": firestore.ArrayUnion([{
"timestamp": datetime.utcnow().isoformat() + "Z",
"level": "INFO",
"worker": worker,
"message": message
}])
})
def _get_logs(self, job_id: str):
"""Get logs from job document."""
doc_ref = self.db.collection(self.collection).document(job_id)
doc = doc_ref.get()
if not doc.exists:
return []
return doc.to_dict().get("worker_logs", [])
def test_array_union_single_write(self):
"""Test ArrayUnion works for single write."""
job_id = self._create_test_job()
self._append_log_array_union(job_id, "test", "Single log message")
time.sleep(0.1)
logs = self._get_logs(job_id)
assert len(logs) == 1
assert logs[0]["message"] == "Single log message"
assert logs[0]["worker"] == "test"
def test_array_union_sequential_writes(self):
"""Test ArrayUnion preserves all sequential writes."""
job_id = self._create_test_job()
for i in range(10):
self._append_log_array_union(job_id, "test", f"Log {i}")
time.sleep(0.2)
logs = self._get_logs(job_id)
assert len(logs) == 10, f"Expected 10 logs, got {len(logs)}"
def test_read_modify_write_race_condition(self):
"""
Demonstrate the race condition with read-modify-write.
This test shows WHY we needed ArrayUnion.
"""
job_id = self._create_test_job()
num_writes = 20
def write_log(index):
self._append_log_read_modify_write(job_id, "worker", f"RMW Log {index}")
# Write concurrently - should lose some logs due to race condition
with ThreadPoolExecutor(max_workers=5) as executor:
futures = [executor.submit(write_log, i) for i in range(num_writes)]
for future in as_completed(futures):
try:
future.result()
except Exception:
pass # Ignore errors for this test
time.sleep(0.5)
logs = self._get_logs(job_id)
# With read-modify-write, we likely lose some logs
# This is expected - the test documents the problem
rmw_count = len([l for l in logs if "RMW Log" in l.get("message", "")])
print(f"\nRead-modify-write: {rmw_count}/{num_writes} logs preserved")
# We expect to lose some logs (this is the bug we're fixing)
# If all 20 are there, the race condition didn't trigger (which is fine)
# The important thing is that ArrayUnion test below ALWAYS preserves all
def test_array_union_no_race_condition(self):
"""
Verify ArrayUnion preserves ALL concurrent writes.
This is the critical test.
"""
job_id = self._create_test_job()
num_writes = 20
def write_log(index):
self._append_log_array_union(job_id, "worker", f"ArrayUnion Log {index}")
# Write concurrently
with ThreadPoolExecutor(max_workers=5) as executor:
futures = [executor.submit(write_log, i) for i in range(num_writes)]
for future in as_completed(futures):
future.result() # Raise any exceptions
time.sleep(0.5)
logs = self._get_logs(job_id)
# With ArrayUnion, ALL logs should be preserved
au_count = len([l for l in logs if "ArrayUnion Log" in l.get("message", "")])
print(f"\nArrayUnion: {au_count}/{num_writes} logs preserved")
assert au_count == num_writes, \
f"ArrayUnion should preserve all {num_writes} logs, got {au_count}"
def test_concurrent_workers_array_union(self):
"""
Test simulating audio and lyrics workers writing concurrently.
"""
job_id = self._create_test_job()
def audio_worker():
for i in range(10):
self._append_log_array_union(job_id, "audio", f"Audio log {i}")
time.sleep(0.01)
def lyrics_worker():
for i in range(10):
self._append_log_array_union(job_id, "lyrics", f"Lyrics log {i}")
time.sleep(0.01)
# Start both workers
audio_thread = threading.Thread(target=audio_worker)
lyrics_thread = threading.Thread(target=lyrics_worker)
audio_thread.start()
lyrics_thread.start()
audio_thread.join()
lyrics_thread.join()
time.sleep(0.5)
logs = self._get_logs(job_id)
audio_logs = [l for l in logs if l.get("worker") == "audio"]
lyrics_logs = [l for l in logs if l.get("worker") == "lyrics"]
print(f"\nConcurrent workers: {len(audio_logs)} audio + {len(lyrics_logs)} lyrics")
assert len(audio_logs) == 10, f"Expected 10 audio logs, got {len(audio_logs)}"
assert len(lyrics_logs) == 10, f"Expected 10 lyrics logs, got {len(lyrics_logs)}"
print("✅ All logs from both workers preserved!")
print("✅ Direct Firestore worker logs tests ready")
-10
View File
@@ -1,10 +0,0 @@
# Testing dependencies
pytest>=7.4.0
pytest-asyncio>=0.21.0
pytest-cov>=4.1.0
pytest-mock>=3.11.1
httpx>=0.25.0 # For async testing
# Parent requirements (for import)
-r ../requirements.txt
-6
View File
@@ -1,6 +0,0 @@
pytest>=8.0.0
pytest-asyncio>=0.23.0
pytest-timeout>=2.2.0
pytest-cov>=4.1.0
requests>=2.31.0
-460
View File
@@ -1,460 +0,0 @@
"""
Integration tests for the karaoke generation backend API.
These tests verify the backend works end-to-end with real Cloud Run deployment.
These tests require a deployed backend and are marked to skip unless explicitly enabled.
Run with: pytest backend/tests/test_api_integration.py -m integration
"""
import pytest
import requests
import subprocess
import time
import json
from pathlib import Path
from typing import Optional, Dict, Any
import os
# Skip all tests unless explicitly running integration tests
pytestmark = pytest.mark.skipif(
os.environ.get("RUN_INTEGRATION_TESTS") != "true",
reason="Integration tests require deployed backend. Set RUN_INTEGRATION_TESTS=true to run."
)
# Configuration
SERVICE_URL = "https://karaoke-backend-718638054799.us-central1.run.app"
TEST_YOUTUBE_URL = "https://www.youtube.com/watch?v=dQw4w9WgXcQ" # Rick Astley - Never Gonna Give You Up
DEFAULT_TIMEOUT = 30 # seconds
def api_get(url: str, headers: Optional[Dict[str, str]] = None, **kwargs) -> requests.Response:
"""Make a GET request with default timeout."""
return requests.get(url, headers=headers, timeout=DEFAULT_TIMEOUT, **kwargs)
def api_post(url: str, headers: Optional[Dict[str, str]] = None, **kwargs) -> requests.Response:
"""Make a POST request with default timeout."""
return requests.post(url, headers=headers, timeout=DEFAULT_TIMEOUT, **kwargs)
def api_delete(url: str, headers: Optional[Dict[str, str]] = None, **kwargs) -> requests.Response:
"""Make a DELETE request with default timeout."""
return requests.delete(url, headers=headers, timeout=DEFAULT_TIMEOUT, **kwargs)
def get_auth_token() -> str:
"""Get authentication token for Cloud Run."""
result = subprocess.run(
["gcloud", "auth", "print-identity-token"],
capture_output=True,
text=True,
check=True
)
return result.stdout.strip()
@pytest.fixture
def auth_headers():
"""Get authentication headers for requests."""
token = get_auth_token()
return {
"Authorization": f"Bearer {token}",
"Content-Type": "application/json"
}
class TestHealthEndpoint:
"""Test health check endpoint."""
def test_health_check(self, auth_headers):
"""Test that health endpoint returns 200 OK."""
response = api_get(f"{SERVICE_URL}/api/health", headers=auth_headers)
assert response.status_code == 200
data = response.json()
assert data["status"] == "healthy"
assert data["service"] == "karaoke-gen-backend"
def test_health_check_without_auth(self):
"""Test that health endpoint requires authentication."""
response = api_get(f"{SERVICE_URL}/api/health")
assert response.status_code == 403
class TestRootEndpoint:
"""Test root endpoint."""
def test_root_endpoint(self, auth_headers):
"""Test root endpoint returns service info."""
response = api_get(SERVICE_URL, headers=auth_headers)
assert response.status_code == 200
data = response.json()
assert data["service"] == "karaoke-gen-backend"
assert data["status"] == "running"
assert "version" in data
class TestJobSubmission:
"""Test job submission workflows."""
def test_submit_job_with_youtube_url(self, auth_headers):
"""Test submitting a job with a YouTube URL."""
payload = {"url": TEST_YOUTUBE_URL}
response = api_post(
f"{SERVICE_URL}/api/jobs",
headers=auth_headers,
json=payload
)
assert response.status_code == 200
data = response.json()
assert data["status"] == "success"
assert "job_id" in data
assert len(data["job_id"]) > 0
assert "message" in data
# Store job_id for cleanup
return data["job_id"]
def test_submit_job_with_invalid_url(self, auth_headers):
"""Test that invalid URLs are rejected."""
payload = {"url": "not-a-url"}
response = api_post(
f"{SERVICE_URL}/api/jobs",
headers=auth_headers,
json=payload
)
assert response.status_code == 422 # Validation error
def test_submit_job_without_url(self, auth_headers):
"""Test that missing URL is rejected."""
payload = {}
response = api_post(
f"{SERVICE_URL}/api/jobs",
headers=auth_headers,
json=payload
)
assert response.status_code == 422 # Validation error
class TestJobRetrieval:
"""Test job retrieval and status checking."""
@pytest.fixture
def test_job_id(self, auth_headers):
"""Create a test job for retrieval tests."""
payload = {"url": TEST_YOUTUBE_URL}
response = api_post(
f"{SERVICE_URL}/api/jobs",
headers=auth_headers,
json=payload
)
assert response.status_code == 200
job_id = response.json()["job_id"]
yield job_id
# Cleanup
api_delete(
f"{SERVICE_URL}/api/jobs/{job_id}",
headers=auth_headers
)
def test_get_job_status(self, auth_headers, test_job_id):
"""Test retrieving job status."""
response = api_get(
f"{SERVICE_URL}/api/jobs/{test_job_id}",
headers=auth_headers
)
assert response.status_code == 200
data = response.json()
assert data["job_id"] == test_job_id
assert "status" in data
# Updated to use current JobStatus enum values
assert data["status"] in ["pending", "downloading", "separating_stage1",
"separating_stage2", "audio_complete",
"transcribing", "correcting", "lyrics_complete",
"generating_screens", "applying_padding",
"awaiting_review", "in_review", "review_complete",
"rendering_video", "awaiting_instrumental_selection",
"instrumental_selected", "generating_video",
"encoding", "packaging", "uploading", "notifying",
"complete", "failed", "cancelled"]
assert "progress" in data
assert "created_at" in data
assert "updated_at" in data
assert "timeline" in data
def test_get_nonexistent_job(self, auth_headers):
"""Test that requesting nonexistent job returns 404."""
fake_job_id = "nonexistent-job-id"
response = api_get(
f"{SERVICE_URL}/api/jobs/{fake_job_id}",
headers=auth_headers
)
assert response.status_code == 404
def test_list_jobs(self, auth_headers, test_job_id):
"""Test listing all jobs."""
response = api_get(
f"{SERVICE_URL}/api/jobs",
headers=auth_headers
)
assert response.status_code == 200
data = response.json()
assert isinstance(data, list)
# Our test job should be in the list
job_ids = [job["job_id"] for job in data]
assert test_job_id in job_ids
def test_list_jobs_with_status_filter(self, auth_headers):
"""Test filtering jobs by status."""
response = api_get(
f"{SERVICE_URL}/api/jobs?status=pending",
headers=auth_headers
)
assert response.status_code == 200
data = response.json()
assert isinstance(data, list)
# All returned jobs should be pending
for job in data:
assert job["status"] == "pending"
def test_list_jobs_with_limit(self, auth_headers):
"""Test limiting number of returned jobs."""
response = api_get(
f"{SERVICE_URL}/api/jobs?limit=5",
headers=auth_headers
)
assert response.status_code == 200
data = response.json()
assert isinstance(data, list)
assert len(data) <= 5
class TestJobDeletion:
"""Test job deletion."""
def test_delete_job(self, auth_headers):
"""Test deleting a job."""
# Create a job
payload = {"url": TEST_YOUTUBE_URL}
response = api_post(
f"{SERVICE_URL}/api/jobs",
headers=auth_headers,
json=payload
)
assert response.status_code == 200
job_id = response.json()["job_id"]
# Delete the job
response = api_delete(
f"{SERVICE_URL}/api/jobs/{job_id}",
headers=auth_headers
)
assert response.status_code == 200
data = response.json()
assert data["status"] == "success"
# Verify job is deleted
response = api_get(
f"{SERVICE_URL}/api/jobs/{job_id}",
headers=auth_headers
)
assert response.status_code == 404
def test_delete_job_without_files(self, auth_headers):
"""Test deleting a job without deleting files."""
# Create a job
payload = {"url": TEST_YOUTUBE_URL}
response = api_post(
f"{SERVICE_URL}/api/jobs",
headers=auth_headers,
json=payload
)
assert response.status_code == 200
job_id = response.json()["job_id"]
# Delete job but keep files
response = api_delete(
f"{SERVICE_URL}/api/jobs/{job_id}?delete_files=false",
headers=auth_headers
)
assert response.status_code == 200
data = response.json()
assert data["status"] == "success"
def test_delete_nonexistent_job(self, auth_headers):
"""Test deleting nonexistent job returns 404."""
fake_job_id = "nonexistent-job-id"
response = api_delete(
f"{SERVICE_URL}/api/jobs/{fake_job_id}",
headers=auth_headers
)
assert response.status_code == 404
class TestFileUpload:
"""Test file upload endpoint."""
def test_upload_audio_file(self, auth_headers, tmp_path):
"""Test uploading an audio file."""
# Create a small test file
test_file = tmp_path / "test_audio.mp3"
test_file.write_bytes(b"fake audio content for testing")
# Upload file
with open(test_file, "rb") as f:
files = {"file": ("test_audio.mp3", f, "audio/mpeg")}
data = {
"artist": "Test Artist",
"title": "Test Song"
}
# Remove Content-Type header for multipart/form-data
headers = {
"Authorization": auth_headers["Authorization"]
}
response = api_post(
f"{SERVICE_URL}/api/jobs/upload",
headers=headers,
files=files,
data=data
)
assert response.status_code == 200
result = response.json()
assert result["status"] == "success"
assert "job_id" in result
# Cleanup
api_delete(
f"{SERVICE_URL}/api/jobs/{result['job_id']}",
headers=auth_headers
)
def test_upload_invalid_file_type(self, auth_headers, tmp_path):
"""Test that invalid file types are rejected."""
# Create a test file with invalid extension
test_file = tmp_path / "test.txt"
test_file.write_bytes(b"not an audio file")
with open(test_file, "rb") as f:
files = {"file": ("test.txt", f, "text/plain")}
data = {
"artist": "Test Artist",
"title": "Test Song"
}
headers = {
"Authorization": auth_headers["Authorization"]
}
response = api_post(
f"{SERVICE_URL}/api/jobs/upload",
headers=headers,
files=files,
data=data
)
assert response.status_code == 400
def test_upload_without_metadata(self, auth_headers, tmp_path):
"""Test that uploads without artist/title are rejected."""
test_file = tmp_path / "test_audio.mp3"
test_file.write_bytes(b"fake audio content")
with open(test_file, "rb") as f:
files = {"file": ("test_audio.mp3", f, "audio/mpeg")}
headers = {
"Authorization": auth_headers["Authorization"]
}
response = api_post(
f"{SERVICE_URL}/api/jobs/upload",
headers=headers,
files=files
)
assert response.status_code == 422 # Validation error
class TestJobProcessing:
"""Test end-to-end job processing (long-running)."""
@pytest.mark.slow
@pytest.mark.integration
def test_complete_job_workflow(self, auth_headers):
"""
Test complete job workflow from submission to completion.
This test is slow and requires actual processing.
Run with: pytest -m slow
"""
# Submit job
payload = {"url": TEST_YOUTUBE_URL}
response = api_post(
f"{SERVICE_URL}/api/jobs",
headers=auth_headers,
json=payload
)
assert response.status_code == 200
job_id = response.json()["job_id"]
# Poll for completion (with timeout)
timeout = 600 # 10 minutes
start_time = time.time()
while time.time() - start_time < timeout:
response = api_get(
f"{SERVICE_URL}/api/jobs/{job_id}",
headers=auth_headers
)
assert response.status_code == 200
job = response.json()
status = job["status"]
if status == "complete":
# Verify outputs exist
assert "download_urls" in job
assert len(job["download_urls"]) > 0
break
elif status == "failed":
pytest.fail(f"Job failed: {job.get('error_message')}")
# Wait before next poll
time.sleep(10)
else:
pytest.fail(f"Job did not complete within {timeout} seconds")
# Cleanup
api_delete(
f"{SERVICE_URL}/api/jobs/{job_id}",
headers=auth_headers
)
if __name__ == "__main__":
pytest.main([__file__, "-v", "--tb=short"])
-93
View File
@@ -1,93 +0,0 @@
"""
Unit tests for API routes.
These tests use FastAPI TestClient with mocked services to test
route logic without hitting real cloud services.
"""
import pytest
import json
from datetime import datetime, UTC
from unittest.mock import MagicMock, AsyncMock, patch
from fastapi.testclient import TestClient
from io import BytesIO
from backend.models.job import Job, JobStatus
class TestHealthRoutes:
"""Tests for health.py routes."""
@pytest.fixture
def client(self):
"""Create test client with mocked dependencies."""
mock_creds = MagicMock()
mock_creds.universe_domain = 'googleapis.com'
with patch('backend.services.firestore_service.firestore'), \
patch('backend.services.storage_service.storage'), \
patch('google.auth.default', return_value=(mock_creds, 'test-project')):
from backend.main import app
return TestClient(app)
def test_health_endpoint_returns_200(self, client):
"""Test /api/health returns 200 OK."""
response = client.get("/api/health")
assert response.status_code == 200
def test_health_endpoint_returns_healthy_status(self, client):
"""Test health endpoint returns healthy status."""
response = client.get("/api/health")
data = response.json()
assert data["status"] == "healthy"
def test_root_endpoint_returns_200(self, client):
"""Test root endpoint returns 200."""
response = client.get("/")
assert response.status_code == 200
class TestJobRoutes:
"""Tests for jobs.py routes.
Note: These tests verify the route module structure.
Full integration tests are in test_api_integration.py.
"""
def test_jobs_router_exists(self):
"""Test jobs router can be imported."""
from backend.api.routes import jobs
assert hasattr(jobs, 'router')
def test_jobs_router_has_expected_endpoints(self):
"""Test jobs router defines expected endpoints."""
from backend.api.routes.jobs import router
routes = [route.path for route in router.routes]
assert '/jobs' in routes or any('/jobs' in r for r in routes)
class TestInternalRoutes:
"""Tests for internal.py routes.
Note: These tests are minimal because the internal routes
trigger actual worker processing which requires complex mocking.
The actual worker logic is tested in test_workers.py.
"""
def test_internal_endpoint_structure(self):
"""Test internal route module has expected endpoints."""
from backend.api.routes import internal
# Just verify the module can be imported
assert hasattr(internal, 'router')
class TestFileUploadRoutes:
"""Tests for file_upload.py routes.
Note: These tests verify the route module structure.
Full integration tests are in test_api_integration.py.
"""
def test_file_upload_router_exists(self):
"""Test file upload router can be imported."""
from backend.api.routes import file_upload
assert hasattr(file_upload, 'router')
-386
View File
@@ -1,386 +0,0 @@
"""
Tests for audio search functionality (Batch 5).
Tests the audio search service, API routes, and job model fields.
"""
import pytest
import os
from unittest.mock import Mock, patch, MagicMock
from datetime import datetime
from backend.models.job import Job, JobCreate, JobStatus, STATE_TRANSITIONS
from backend.services.audio_search_service import (
AudioSearchService,
AudioSearchResult,
AudioDownloadResult,
AudioSearchError,
NoResultsError,
DownloadError,
get_audio_search_service,
)
class TestJobModelAudioSearchFields:
"""Test Job model has audio search fields."""
def test_job_has_audio_search_fields(self):
"""Test Job model has audio search configuration fields."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.utcnow(),
updated_at=datetime.utcnow(),
artist="ABBA",
title="Waterloo",
audio_search_artist="ABBA",
audio_search_title="Waterloo",
auto_download=True,
)
assert job.audio_search_artist == "ABBA"
assert job.audio_search_title == "Waterloo"
assert job.auto_download is True
def test_job_audio_search_fields_default_values(self):
"""Test default values for audio search fields."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.utcnow(),
updated_at=datetime.utcnow(),
)
assert job.audio_search_artist is None
assert job.audio_search_title is None
assert job.auto_download is False
def test_job_create_has_audio_search_fields(self):
"""Test JobCreate model has audio search fields."""
job_create = JobCreate(
artist="ABBA",
title="Waterloo",
audio_search_artist="ABBA",
audio_search_title="Waterloo",
auto_download=True,
)
assert job_create.audio_search_artist == "ABBA"
assert job_create.audio_search_title == "Waterloo"
assert job_create.auto_download is True
class TestJobStatusAudioSearchStates:
"""Test Job status includes audio search states."""
def test_audio_search_statuses_exist(self):
"""Test audio search status values exist."""
assert hasattr(JobStatus, 'SEARCHING_AUDIO')
assert hasattr(JobStatus, 'AWAITING_AUDIO_SELECTION')
assert hasattr(JobStatus, 'DOWNLOADING_AUDIO')
assert JobStatus.SEARCHING_AUDIO == "searching_audio"
assert JobStatus.AWAITING_AUDIO_SELECTION == "awaiting_audio_selection"
assert JobStatus.DOWNLOADING_AUDIO == "downloading_audio"
def test_state_transitions_include_audio_search_flow(self):
"""Test state transitions include audio search flow."""
# PENDING can go to SEARCHING_AUDIO
assert JobStatus.SEARCHING_AUDIO in STATE_TRANSITIONS[JobStatus.PENDING]
# SEARCHING_AUDIO can go to AWAITING_AUDIO_SELECTION or DOWNLOADING_AUDIO
assert JobStatus.AWAITING_AUDIO_SELECTION in STATE_TRANSITIONS[JobStatus.SEARCHING_AUDIO]
assert JobStatus.DOWNLOADING_AUDIO in STATE_TRANSITIONS[JobStatus.SEARCHING_AUDIO]
# AWAITING_AUDIO_SELECTION can go to DOWNLOADING_AUDIO
assert JobStatus.DOWNLOADING_AUDIO in STATE_TRANSITIONS[JobStatus.AWAITING_AUDIO_SELECTION]
# DOWNLOADING_AUDIO can go to DOWNLOADING
assert JobStatus.DOWNLOADING in STATE_TRANSITIONS[JobStatus.DOWNLOADING_AUDIO]
class TestAudioSearchResult:
"""Test AudioSearchResult dataclass."""
def test_create_audio_search_result(self):
"""Test creating an AudioSearchResult."""
result = AudioSearchResult(
title="Waterloo",
artist="ABBA",
provider="YouTube",
url="https://youtube.com/watch?v=abc123",
duration=180,
quality="FLAC",
source_id="abc123",
index=0,
)
assert result.title == "Waterloo"
assert result.artist == "ABBA"
assert result.provider == "YouTube"
assert result.url == "https://youtube.com/watch?v=abc123"
assert result.duration == 180
assert result.quality == "FLAC"
assert result.source_id == "abc123"
assert result.index == 0
def test_to_dict(self):
"""Test converting to dict for serialization."""
result = AudioSearchResult(
title="Waterloo",
artist="ABBA",
provider="YouTube",
url="https://youtube.com/watch?v=abc123",
index=0,
)
data = result.to_dict()
assert data['title'] == "Waterloo"
assert data['artist'] == "ABBA"
assert data['provider'] == "YouTube"
assert data['url'] == "https://youtube.com/watch?v=abc123"
assert data['index'] == 0
def test_from_dict(self):
"""Test creating from dict."""
data = {
'title': "Waterloo",
'artist': "ABBA",
'provider': "YouTube",
'url': "https://youtube.com/watch?v=abc123",
'duration': 180,
'quality': "FLAC",
'source_id': "abc123",
'index': 0,
}
result = AudioSearchResult.from_dict(data)
assert result.title == "Waterloo"
assert result.artist == "ABBA"
assert result.provider == "YouTube"
assert result.index == 0
class TestAudioSearchServiceInit:
"""Test AudioSearchService initialization."""
@patch.dict('os.environ', {'REDACTED_API_KEY': '', 'OPS_API_KEY': ''}, clear=False)
def test_init_with_no_keys(self):
"""Test initialization without API keys."""
# Pass explicit None to override environment
service = AudioSearchService(redacted_api_key=None, ops_api_key=None)
# When explicitly passed None, it should be None (not from env)
assert service._redacted_api_key is None
assert service._ops_api_key is None
assert service._manager is None
def test_init_with_keys(self):
"""Test initialization with API keys."""
service = AudioSearchService(
redacted_api_key="test_redacted_key",
ops_api_key="test_ops_key",
)
assert service._redacted_api_key == "test_redacted_key"
assert service._ops_api_key == "test_ops_key"
def test_init_reads_from_environment(self):
"""Test initialization reads keys from environment variables."""
import os
# Just test that the service can be initialized
service = AudioSearchService()
# The service should have API keys from env or None
assert service._manager is None # Not yet initialized
class TestAudioSearchServiceSearch:
"""Test AudioSearchService.search() method."""
@patch('backend.services.audio_search_service.AudioSearchService._get_manager')
def test_search_returns_results(self, mock_get_manager):
"""Test search returns AudioSearchResult list."""
# Mock the flacfetch result
mock_result = Mock()
mock_result.title = "Waterloo"
mock_result.artist = "ABBA"
mock_result.provider = "YouTube"
mock_result.url = "https://youtube.com/watch?v=abc123"
mock_result.duration = 180
mock_result.quality = "FLAC"
mock_result.id = "abc123"
mock_manager = Mock()
mock_manager.search.return_value = [mock_result]
mock_get_manager.return_value = mock_manager
service = AudioSearchService()
results = service.search("ABBA", "Waterloo")
assert len(results) == 1
assert results[0].title == "Waterloo"
assert results[0].artist == "ABBA"
assert results[0].provider == "YouTube"
assert results[0].index == 0
@patch('backend.services.audio_search_service.AudioSearchService._get_manager')
def test_search_no_results_raises_error(self, mock_get_manager):
"""Test search raises NoResultsError when no results."""
mock_manager = Mock()
mock_manager.search.return_value = []
mock_get_manager.return_value = mock_manager
service = AudioSearchService()
with pytest.raises(NoResultsError) as exc_info:
service.search("Unknown Artist", "Unknown Song")
assert "No results found" in str(exc_info.value)
@patch('backend.services.audio_search_service.AudioSearchService._get_manager')
def test_search_multiple_results(self, mock_get_manager):
"""Test search returns multiple results with correct indices."""
mock_results = []
for i in range(3):
mock_result = Mock()
mock_result.title = f"Song {i}"
mock_result.artist = "Artist"
mock_result.provider = ["YouTube", "Redacted", "OPS"][i]
mock_result.url = f"https://example.com/{i}"
mock_result.duration = 180 + i * 10
mock_result.quality = ["320kbps", "FLAC", "FLAC"][i]
mock_result.id = str(i)
mock_results.append(mock_result)
mock_manager = Mock()
mock_manager.search.return_value = mock_results
mock_get_manager.return_value = mock_manager
service = AudioSearchService()
results = service.search("Artist", "Song")
assert len(results) == 3
assert results[0].index == 0
assert results[1].index == 1
assert results[2].index == 2
class TestAudioSearchServiceSelectBest:
"""Test AudioSearchService.select_best() method."""
@patch('backend.services.audio_search_service.AudioSearchService._get_manager')
def test_select_best_uses_manager(self, mock_get_manager):
"""Test select_best uses flacfetch's select_best."""
# First need to do a search to populate cache
mock_result = Mock()
mock_result.title = "Waterloo"
mock_result.artist = "ABBA"
mock_result.provider = "YouTube"
mock_result.url = "https://youtube.com/watch?v=abc123"
mock_result.duration = 180
mock_result.quality = "FLAC"
mock_result.id = "abc123"
mock_manager = Mock()
mock_manager.search.return_value = [mock_result]
mock_manager.select_best.return_value = mock_result
mock_get_manager.return_value = mock_manager
service = AudioSearchService()
results = service.search("ABBA", "Waterloo")
best_index = service.select_best(results)
assert best_index == 0
def test_select_best_empty_list_returns_zero(self):
"""Test select_best returns 0 for empty list."""
service = AudioSearchService()
best_index = service.select_best([])
assert best_index == 0
class TestAudioSearchServiceDownload:
"""Test AudioSearchService.download() method."""
@patch('backend.services.audio_search_service.AudioSearchService._get_manager')
def test_download_without_search_raises_error(self, mock_get_manager):
"""Test download without prior search raises error."""
mock_manager = Mock()
mock_get_manager.return_value = mock_manager
service = AudioSearchService()
with pytest.raises(DownloadError) as exc_info:
service.download(0, "/tmp")
assert "No cached result" in str(exc_info.value)
@patch('backend.services.audio_search_service.AudioSearchService._get_manager')
def test_download_after_search(self, mock_get_manager):
"""Test download after search works."""
import tempfile
import os
# Create a temp file to simulate downloaded file
temp_dir = tempfile.mkdtemp()
temp_file = os.path.join(temp_dir, "test.flac")
with open(temp_file, 'w') as f:
f.write("test")
mock_result = Mock()
mock_result.title = "Waterloo"
mock_result.artist = "ABBA"
mock_result.provider = "YouTube"
mock_result.url = "https://youtube.com/watch?v=abc123"
mock_result.duration = 180
mock_result.quality = "FLAC"
mock_result.id = "abc123"
mock_manager = Mock()
mock_manager.search.return_value = [mock_result]
mock_manager.download.return_value = temp_file
mock_get_manager.return_value = mock_manager
service = AudioSearchService()
service.search("ABBA", "Waterloo")
result = service.download(0, temp_dir)
assert result.filepath == temp_file
assert result.artist == "ABBA"
assert result.title == "Waterloo"
assert result.provider == "YouTube"
# Cleanup
os.remove(temp_file)
os.rmdir(temp_dir)
class TestGetAudioSearchService:
"""Test get_audio_search_service singleton."""
def test_get_audio_search_service_returns_instance(self):
"""Test get_audio_search_service returns an instance."""
# Reset singleton
import backend.services.audio_search_service as module
module._audio_search_service = None
service = get_audio_search_service()
assert service is not None
assert isinstance(service, AudioSearchService)
def test_get_audio_search_service_singleton(self):
"""Test get_audio_search_service returns same instance."""
service1 = get_audio_search_service()
service2 = get_audio_search_service()
assert service1 is service2
-363
View File
@@ -1,363 +0,0 @@
"""
Unit tests for audio analysis and editing services.
These tests verify the backend service wrappers that use the shared
karaoke_gen.instrumental_review module with GCS integration.
"""
import os
import tempfile
import pytest
from unittest.mock import MagicMock, patch, ANY
from pydub import AudioSegment
from pydub.generators import Sine
from karaoke_gen.instrumental_review import MuteRegion
class TestAudioAnalysisService:
"""Tests for AudioAnalysisService."""
@pytest.fixture
def mock_storage_service(self):
"""Create a mock storage service."""
mock = MagicMock()
return mock
@pytest.fixture
def temp_audio_file(self, tmp_path):
"""Create a temporary audio file for testing."""
audio_path = tmp_path / "test_audio.flac"
# Create a simple sine wave audio
tone = Sine(440).to_audio_segment(duration=5000) - 15
tone.export(str(audio_path), format="flac")
return str(audio_path)
@pytest.fixture
def silent_audio_file(self, tmp_path):
"""Create a silent audio file for testing."""
audio_path = tmp_path / "silent_audio.flac"
audio = AudioSegment.silent(duration=5000, frame_rate=44100)
audio.export(str(audio_path), format="flac")
return str(audio_path)
def test_service_initialization(self, mock_storage_service):
"""Test service initializes with default parameters."""
from backend.services.audio_analysis_service import AudioAnalysisService
service = AudioAnalysisService(storage_service=mock_storage_service)
assert service.storage_service == mock_storage_service
assert service.analyzer.silence_threshold_db == -40.0
def test_service_custom_threshold(self, mock_storage_service):
"""Test service accepts custom silence threshold."""
from backend.services.audio_analysis_service import AudioAnalysisService
service = AudioAnalysisService(
storage_service=mock_storage_service,
silence_threshold_db=-35.0,
)
assert service.analyzer.silence_threshold_db == -35.0
def test_analyze_backing_vocals_downloads_file(
self, mock_storage_service, temp_audio_file
):
"""Test that analyze_backing_vocals downloads file from GCS."""
from backend.services.audio_analysis_service import AudioAnalysisService
# Set up mock to copy the temp file to the download location
def mock_download(gcs_path, local_path):
import shutil
shutil.copy(temp_audio_file, local_path)
return local_path
mock_storage_service.download_file.side_effect = mock_download
service = AudioAnalysisService(storage_service=mock_storage_service)
result = service.analyze_backing_vocals(
gcs_audio_path="jobs/test/stems/backing_vocals.flac",
job_id="test-job",
)
# Verify download was called
mock_storage_service.download_file.assert_called_once()
# Verify result is valid
assert result is not None
assert hasattr(result, 'has_audible_content')
def test_analyze_silent_audio_returns_no_audible(
self, mock_storage_service, silent_audio_file
):
"""Test that silent audio returns has_audible_content=False."""
from backend.services.audio_analysis_service import AudioAnalysisService
def mock_download(gcs_path, local_path):
import shutil
shutil.copy(silent_audio_file, local_path)
return local_path
mock_storage_service.download_file.side_effect = mock_download
service = AudioAnalysisService(storage_service=mock_storage_service)
result = service.analyze_backing_vocals(
gcs_audio_path="jobs/test/stems/backing_vocals.flac",
job_id="test-job",
)
assert result.has_audible_content is False
assert len(result.audible_segments) == 0
def test_analyze_and_generate_waveform_uploads_image(
self, mock_storage_service, temp_audio_file
):
"""Test that analyze_and_generate_waveform uploads waveform to GCS."""
from backend.services.audio_analysis_service import AudioAnalysisService
def mock_download(gcs_path, local_path):
import shutil
shutil.copy(temp_audio_file, local_path)
return local_path
mock_storage_service.download_file.side_effect = mock_download
mock_storage_service.upload_file.return_value = "jobs/test/analysis/waveform.png"
service = AudioAnalysisService(storage_service=mock_storage_service)
result, waveform_path = service.analyze_and_generate_waveform(
gcs_audio_path="jobs/test/stems/backing_vocals.flac",
job_id="test-job",
gcs_waveform_destination="jobs/test/analysis/waveform.png",
)
# Verify upload was called
mock_storage_service.upload_file.assert_called_once()
# Verify waveform path is returned
assert waveform_path == "jobs/test/analysis/waveform.png"
def test_get_waveform_data_returns_amplitudes(
self, mock_storage_service, temp_audio_file
):
"""Test that get_waveform_data returns amplitude data."""
from backend.services.audio_analysis_service import AudioAnalysisService
def mock_download(gcs_path, local_path):
import shutil
shutil.copy(temp_audio_file, local_path)
return local_path
mock_storage_service.download_file.side_effect = mock_download
service = AudioAnalysisService(storage_service=mock_storage_service)
amplitudes, duration = service.get_waveform_data(
gcs_audio_path="jobs/test/stems/backing_vocals.flac",
job_id="test-job",
num_points=100,
)
# Verify we get amplitude data
assert isinstance(amplitudes, list)
assert len(amplitudes) > 0
assert all(isinstance(a, float) for a in amplitudes)
# Verify duration is reasonable
assert duration > 0
assert duration <= 10 # Our test file is 5 seconds
class TestAudioEditingService:
"""Tests for AudioEditingService."""
@pytest.fixture
def mock_storage_service(self):
"""Create a mock storage service."""
mock = MagicMock()
return mock
@pytest.fixture
def temp_audio_files(self, tmp_path):
"""Create temporary audio files for testing."""
clean_path = tmp_path / "clean_instrumental.flac"
backing_path = tmp_path / "backing_vocals.flac"
# Create clean instrumental (chord)
tone1 = Sine(220).to_audio_segment(duration=5000) - 15
tone2 = Sine(330).to_audio_segment(duration=5000) - 15
clean = tone1.overlay(tone2)
clean.export(str(clean_path), format="flac")
# Create backing vocals
backing = Sine(440).to_audio_segment(duration=5000) - 20
backing.export(str(backing_path), format="flac")
return str(clean_path), str(backing_path)
def test_service_initialization(self, mock_storage_service):
"""Test service initializes correctly."""
from backend.services.audio_editing_service import AudioEditingService
service = AudioEditingService(storage_service=mock_storage_service)
assert service.storage_service == mock_storage_service
assert service.editor.output_format == "flac"
def test_create_custom_instrumental_downloads_files(
self, mock_storage_service, temp_audio_files
):
"""Test that create_custom_instrumental downloads input files."""
from backend.services.audio_editing_service import AudioEditingService
clean_path, backing_path = temp_audio_files
# Track which files were downloaded
downloaded_files = []
def mock_download(gcs_path, local_path):
downloaded_files.append(gcs_path)
# Copy the appropriate test file
import shutil
if 'clean' in gcs_path:
shutil.copy(clean_path, local_path)
else:
shutil.copy(backing_path, local_path)
return local_path
mock_storage_service.download_file.side_effect = mock_download
mock_storage_service.upload_file.return_value = "jobs/test/stems/custom.flac"
service = AudioEditingService(storage_service=mock_storage_service)
mute_regions = [MuteRegion(start_seconds=1.0, end_seconds=2.0)]
result = service.create_custom_instrumental(
gcs_clean_instrumental_path="jobs/test/stems/clean.flac",
gcs_backing_vocals_path="jobs/test/stems/backing.flac",
mute_regions=mute_regions,
gcs_output_path="jobs/test/stems/custom.flac",
job_id="test-job",
)
# Verify both files were downloaded
assert len(downloaded_files) == 2
assert mock_storage_service.upload_file.called
def test_create_custom_instrumental_uploads_result(
self, mock_storage_service, temp_audio_files
):
"""Test that create_custom_instrumental uploads the result."""
from backend.services.audio_editing_service import AudioEditingService
clean_path, backing_path = temp_audio_files
def mock_download(gcs_path, local_path):
import shutil
if 'clean' in gcs_path:
shutil.copy(clean_path, local_path)
else:
shutil.copy(backing_path, local_path)
return local_path
mock_storage_service.download_file.side_effect = mock_download
mock_storage_service.upload_file.return_value = "jobs/test/stems/custom.flac"
service = AudioEditingService(storage_service=mock_storage_service)
mute_regions = [MuteRegion(start_seconds=1.0, end_seconds=2.0)]
result = service.create_custom_instrumental(
gcs_clean_instrumental_path="jobs/test/stems/clean.flac",
gcs_backing_vocals_path="jobs/test/stems/backing.flac",
mute_regions=mute_regions,
gcs_output_path="jobs/test/stems/custom.flac",
job_id="test-job",
)
# Verify upload was called with correct destination
mock_storage_service.upload_file.assert_called_once()
call_args = mock_storage_service.upload_file.call_args
assert call_args[0][1] == "jobs/test/stems/custom.flac"
# Verify result has correct path
assert result.output_path == "jobs/test/stems/custom.flac"
def test_create_custom_instrumental_returns_statistics(
self, mock_storage_service, temp_audio_files
):
"""Test that create_custom_instrumental returns correct statistics."""
from backend.services.audio_editing_service import AudioEditingService
clean_path, backing_path = temp_audio_files
def mock_download(gcs_path, local_path):
import shutil
if 'clean' in gcs_path:
shutil.copy(clean_path, local_path)
else:
shutil.copy(backing_path, local_path)
return local_path
mock_storage_service.download_file.side_effect = mock_download
mock_storage_service.upload_file.return_value = "jobs/test/stems/custom.flac"
service = AudioEditingService(storage_service=mock_storage_service)
mute_regions = [
MuteRegion(start_seconds=1.0, end_seconds=2.0),
MuteRegion(start_seconds=3.0, end_seconds=4.0),
]
result = service.create_custom_instrumental(
gcs_clean_instrumental_path="jobs/test/stems/clean.flac",
gcs_backing_vocals_path="jobs/test/stems/backing.flac",
mute_regions=mute_regions,
gcs_output_path="jobs/test/stems/custom.flac",
job_id="test-job",
)
# Verify statistics
assert len(result.mute_regions_applied) == 2
assert result.total_muted_duration_seconds == 2.0 # 1s + 1s
assert result.output_duration_seconds > 0
def test_validate_mute_regions_returns_errors_for_invalid(
self, mock_storage_service
):
"""Test that validate_mute_regions catches invalid regions."""
from backend.services.audio_editing_service import AudioEditingService
service = AudioEditingService(storage_service=mock_storage_service)
mute_regions = [
MuteRegion(start_seconds=0.0, end_seconds=1.0), # Valid
MuteRegion(start_seconds=100.0, end_seconds=110.0), # Beyond duration
]
errors = service.validate_mute_regions(mute_regions, total_duration_seconds=60.0)
# Should have error for region exceeding duration
assert len(errors) == 1
assert "exceeds" in errors[0].lower()
def test_validate_mute_regions_returns_empty_for_valid(
self, mock_storage_service
):
"""Test that validate_mute_regions returns empty for valid regions."""
from backend.services.audio_editing_service import AudioEditingService
service = AudioEditingService(storage_service=mock_storage_service)
mute_regions = [
MuteRegion(start_seconds=0.0, end_seconds=1.0),
MuteRegion(start_seconds=10.0, end_seconds=15.0),
]
errors = service.validate_mute_regions(mute_regions, total_duration_seconds=60.0)
assert len(errors) == 0
-143
View File
@@ -1,143 +0,0 @@
"""
Tests for AuthService and FirestoreService.
These tests focus on the service initialization and basic operations.
"""
import pytest
from datetime import datetime, UTC
from unittest.mock import MagicMock, patch
class TestAuthServiceBasics:
"""Basic tests for AuthService."""
def test_auth_service_can_import(self):
"""Test AuthService can be imported."""
from backend.services.auth_service import AuthService
assert AuthService is not None
def test_auth_service_initialization(self):
"""Test AuthService initializes with mocked dependencies."""
mock_firestore = MagicMock()
with patch('backend.services.auth_service.FirestoreService', return_value=mock_firestore), \
patch.dict('os.environ', {'ADMIN_TOKENS': 'test-token'}):
from backend.services.auth_service import AuthService
service = AuthService()
assert service is not None
def test_auth_service_has_validate_method(self):
"""Test AuthService has token validation method."""
from backend.services.auth_service import AuthService
assert hasattr(AuthService, 'validate_token') or hasattr(AuthService, 'verify_token')
class TestFirestoreServiceBasics:
"""Basic tests for FirestoreService."""
def test_firestore_service_can_import(self):
"""Test FirestoreService can be imported."""
from backend.services.firestore_service import FirestoreService
assert FirestoreService is not None
def test_firestore_service_initialization(self):
"""Test FirestoreService initializes with mocked client."""
mock_client = MagicMock()
with patch('backend.services.firestore_service.firestore.Client', return_value=mock_client):
from backend.services.firestore_service import FirestoreService
service = FirestoreService()
assert service is not None
def test_firestore_service_has_crud_methods(self):
"""Test FirestoreService has CRUD methods."""
from backend.services.firestore_service import FirestoreService
assert hasattr(FirestoreService, 'create_job')
assert hasattr(FirestoreService, 'get_job')
assert hasattr(FirestoreService, 'update_job')
assert hasattr(FirestoreService, 'delete_job')
class TestStorageServiceBasics:
"""Basic tests for StorageService."""
def test_storage_service_can_import(self):
"""Test StorageService can be imported."""
from backend.services.storage_service import StorageService
assert StorageService is not None
def test_storage_service_initialization(self):
"""Test StorageService initializes with mocked client."""
mock_client = MagicMock()
mock_bucket = MagicMock()
mock_client.bucket.return_value = mock_bucket
with patch('backend.services.storage_service.storage.Client', return_value=mock_client):
from backend.services.storage_service import StorageService
service = StorageService()
assert service is not None
def test_storage_service_has_file_methods(self):
"""Test StorageService has file operation methods."""
from backend.services.storage_service import StorageService
assert hasattr(StorageService, 'upload_file')
assert hasattr(StorageService, 'download_file')
class TestWorkerServiceBasics:
"""Basic tests for WorkerService."""
def test_worker_service_can_import(self):
"""Test WorkerService can be imported."""
from backend.services.worker_service import WorkerService
assert WorkerService is not None
def test_worker_service_initialization(self):
"""Test WorkerService initializes correctly."""
from backend.services.worker_service import WorkerService
service = WorkerService()
assert service is not None
def test_worker_service_has_trigger_methods(self):
"""Test WorkerService has trigger methods."""
from backend.services.worker_service import WorkerService
assert hasattr(WorkerService, 'trigger_audio_worker')
assert hasattr(WorkerService, 'trigger_lyrics_worker')
assert hasattr(WorkerService, 'trigger_screens_worker')
assert hasattr(WorkerService, 'trigger_video_worker')
def test_worker_service_get_base_url(self):
"""Test WorkerService constructs base URL."""
from backend.services.worker_service import WorkerService
service = WorkerService()
url = service._get_base_url()
assert 'http' in url
class TestJobManagerBasics:
"""Basic tests for JobManager."""
def test_job_manager_can_import(self):
"""Test JobManager can be imported."""
from backend.services.job_manager import JobManager
assert JobManager is not None
def test_job_manager_initialization(self):
"""Test JobManager initializes with mocked services."""
mock_firestore = MagicMock()
mock_storage = MagicMock()
with patch('backend.services.job_manager.FirestoreService', return_value=mock_firestore), \
patch('backend.services.job_manager.StorageService', return_value=mock_storage):
from backend.services.job_manager import JobManager
manager = JobManager()
assert manager is not None
def test_job_manager_has_crud_methods(self):
"""Test JobManager has CRUD methods."""
from backend.services.job_manager import JobManager
assert hasattr(JobManager, 'create_job')
assert hasattr(JobManager, 'get_job')
assert hasattr(JobManager, 'delete_job')
assert hasattr(JobManager, 'list_jobs')
-68
View File
@@ -1,68 +0,0 @@
"""
Extended tests for config.py to improve coverage.
"""
import pytest
import os
from unittest.mock import patch
class TestSettingsConfiguration:
"""Tests for Settings configuration."""
def test_settings_class_exists(self):
"""Test Settings class exists."""
from backend.config import Settings
assert Settings is not None
def test_settings_loads_defaults(self):
"""Test Settings loads default values."""
from backend.config import Settings
settings = Settings()
assert settings is not None
def test_gcs_bucket_name_from_env(self):
"""Test GCS bucket name from environment."""
with patch.dict(os.environ, {'GCS_BUCKET_NAME': 'test-bucket'}):
from backend.config import Settings
settings = Settings()
assert settings.gcs_bucket_name == 'test-bucket'
def test_firestore_collection_from_env(self):
"""Test Firestore collection from environment."""
with patch.dict(os.environ, {'FIRESTORE_COLLECTION': 'test-jobs'}):
from backend.config import Settings
settings = Settings()
assert settings.firestore_collection == 'test-jobs'
def test_environment_setting(self):
"""Test environment setting."""
from backend.config import Settings
settings = Settings()
# Accept 'test' as well since pytest may set ENVIRONMENT=test
assert settings.environment in ['development', 'production', 'testing', 'test']
def test_google_cloud_project(self):
"""Test Google Cloud project setting."""
with patch.dict(os.environ, {'GOOGLE_CLOUD_PROJECT': 'test-project'}):
from backend.config import Settings
settings = Settings()
# Should either use the env var or have a default
class TestGetSettings:
"""Tests for get_settings function."""
def test_get_settings_returns_settings(self):
"""Test get_settings returns Settings instance."""
from backend.config import get_settings
settings = get_settings()
assert settings is not None
def test_get_settings_returns_same_instance(self):
"""Test get_settings returns cached instance."""
from backend.config import get_settings
settings1 = get_settings()
settings2 = get_settings()
# Should be same cached instance
assert settings1 is settings2
-377
View File
@@ -1,377 +0,0 @@
"""
Tests for credential manager and auth endpoints.
"""
import pytest
import json
from unittest.mock import MagicMock, patch
from datetime import datetime
from backend.services.credential_manager import (
CredentialManager,
CredentialStatus,
CredentialCheckResult,
DeviceAuthInfo,
get_credential_manager,
)
class TestCredentialStatus:
"""Tests for CredentialStatus enum."""
def test_status_values(self):
"""Test all status values exist."""
assert CredentialStatus.VALID == "valid"
assert CredentialStatus.EXPIRED == "expired"
assert CredentialStatus.INVALID == "invalid"
assert CredentialStatus.NOT_CONFIGURED == "not_configured"
assert CredentialStatus.ERROR == "error"
class TestCredentialCheckResult:
"""Tests for CredentialCheckResult dataclass."""
def test_create_result(self):
"""Test creating a check result."""
result = CredentialCheckResult(
service="youtube",
status=CredentialStatus.VALID,
message="Credentials are valid",
last_checked=datetime.utcnow()
)
assert result.service == "youtube"
assert result.status == CredentialStatus.VALID
assert result.message == "Credentials are valid"
assert result.expires_at is None
def test_create_result_with_expiry(self):
"""Test creating a check result with expiry."""
expiry = datetime.utcnow()
result = CredentialCheckResult(
service="gdrive",
status=CredentialStatus.VALID,
message="Valid",
last_checked=datetime.utcnow(),
expires_at=expiry
)
assert result.expires_at == expiry
class TestCredentialManager:
"""Tests for CredentialManager class."""
def test_init(self):
"""Test manager initialization."""
manager = CredentialManager()
assert manager._pending_device_auths == {}
def test_check_youtube_not_configured(self):
"""Test YouTube check when not configured."""
with patch('backend.services.credential_manager.get_settings') as mock_get_settings:
mock_settings = MagicMock()
mock_settings.get_secret.return_value = None
mock_get_settings.return_value = mock_settings
manager = CredentialManager()
result = manager.check_youtube_credentials()
assert result.status == CredentialStatus.NOT_CONFIGURED
assert "not configured" in result.message.lower()
def test_check_youtube_invalid_json(self):
"""Test YouTube check with invalid JSON."""
with patch('backend.services.credential_manager.get_settings') as mock_get_settings:
mock_settings = MagicMock()
mock_settings.get_secret.return_value = "not valid json"
mock_get_settings.return_value = mock_settings
manager = CredentialManager()
result = manager.check_youtube_credentials()
assert result.status == CredentialStatus.INVALID
assert "json" in result.message.lower()
def test_check_youtube_missing_fields(self):
"""Test YouTube check with missing required fields."""
# Missing refresh_token and client_secret
creds = json.dumps({"token": "test", "client_id": "test"})
with patch('backend.services.credential_manager.get_settings') as mock_get_settings:
mock_settings = MagicMock()
mock_settings.get_secret.return_value = creds
mock_get_settings.return_value = mock_settings
manager = CredentialManager()
result = manager.check_youtube_credentials()
assert result.status == CredentialStatus.INVALID
assert "missing" in result.message.lower()
def test_check_gdrive_not_configured(self):
"""Test Google Drive check when not configured."""
with patch('backend.services.credential_manager.get_settings') as mock_get_settings:
mock_settings = MagicMock()
mock_settings.get_secret.return_value = None
mock_get_settings.return_value = mock_settings
manager = CredentialManager()
result = manager.check_gdrive_credentials()
assert result.status == CredentialStatus.NOT_CONFIGURED
def test_check_dropbox_not_configured(self):
"""Test Dropbox check when not configured."""
with patch('backend.services.credential_manager.get_settings') as mock_get_settings:
mock_settings = MagicMock()
mock_settings.get_secret.return_value = None
mock_get_settings.return_value = mock_settings
manager = CredentialManager()
result = manager.check_dropbox_credentials()
assert result.status == CredentialStatus.NOT_CONFIGURED
def test_check_dropbox_missing_access_token(self):
"""Test Dropbox check with missing access token."""
creds = json.dumps({"refresh_token": "test"}) # No access_token
with patch('backend.services.credential_manager.get_settings') as mock_get_settings:
mock_settings = MagicMock()
mock_settings.get_secret.return_value = creds
mock_get_settings.return_value = mock_settings
manager = CredentialManager()
result = manager.check_dropbox_credentials()
assert result.status == CredentialStatus.INVALID
assert "access_token" in result.message.lower()
def test_check_all_credentials(self):
"""Test checking all credentials."""
with patch('backend.services.credential_manager.get_settings') as mock_get_settings:
mock_settings = MagicMock()
mock_settings.get_secret.return_value = None
mock_get_settings.return_value = mock_settings
manager = CredentialManager()
results = manager.check_all_credentials()
assert "youtube" in results
assert "gdrive" in results
assert "dropbox" in results
assert all(r.status == CredentialStatus.NOT_CONFIGURED for r in results.values())
def test_test_youtube_api_failure(self):
"""Test YouTube API test failure."""
manager = CredentialManager()
mock_creds = MagicMock()
with patch('googleapiclient.discovery.build', side_effect=Exception("API Error")):
result = manager._test_youtube_api(mock_creds)
assert result is False
def test_test_gdrive_api_failure(self):
"""Test Google Drive API test failure."""
manager = CredentialManager()
mock_creds = MagicMock()
with patch('googleapiclient.discovery.build', side_effect=Exception("API Error")):
result = manager._test_gdrive_api(mock_creds)
assert result is False
def test_test_dropbox_api_failure(self):
"""Test Dropbox API test failure."""
manager = CredentialManager()
with patch('dropbox.Dropbox', side_effect=Exception("API Error")):
result = manager._test_dropbox_api({"access_token": "test"})
assert result is False
def test_send_credential_alert_no_webhook(self):
"""Test alert without webhook URL."""
manager = CredentialManager()
result = manager.send_credential_alert([], discord_webhook_url=None)
assert result is False
def test_send_credential_alert_success(self):
"""Test successful alert sending."""
manager = CredentialManager()
mock_response = MagicMock()
mock_response.status_code = 200
invalid_services = [
CredentialCheckResult(
service="youtube",
status=CredentialStatus.INVALID,
message="Test message",
last_checked=datetime.utcnow()
)
]
with patch('requests.post', return_value=mock_response) as mock_post:
result = manager.send_credential_alert(
invalid_services,
discord_webhook_url="https://discord.com/webhook/test"
)
assert result is True
mock_post.assert_called_once()
def test_start_youtube_device_auth(self):
"""Test starting YouTube device auth flow."""
manager = CredentialManager()
mock_response = MagicMock()
mock_response.status_code = 200
mock_response.json.return_value = {
"device_code": "test_device_code",
"user_code": "TEST-CODE",
"verification_uri": "https://google.com/device",
"expires_in": 1800,
"interval": 5
}
with patch('requests.post', return_value=mock_response):
device_info = manager.start_youtube_device_auth(
client_id="test_client",
client_secret="test_secret"
)
assert device_info.device_code == "test_device_code"
assert device_info.user_code == "TEST-CODE"
assert device_info.verification_url == "https://google.com/device"
# Should be stored for polling
key = f"youtube:{device_info.device_code}"
assert key in manager._pending_device_auths
def test_poll_device_auth_no_client_creds(self):
"""Test polling when client credentials are not in Secret Manager."""
manager = CredentialManager()
# Mock get_youtube_client_credentials to return None (no creds)
with patch.object(manager, 'get_youtube_client_credentials', return_value=None):
status, data = manager.poll_device_auth("youtube", "some_code")
assert status == "error"
assert "client credentials not found" in data["message"].lower()
def test_poll_device_auth_expired(self):
"""Test polling with expired device code."""
manager = CredentialManager()
mock_response = MagicMock()
mock_response.status_code = 400
mock_response.json.return_value = {"error": "expired_token"}
with patch.object(manager, 'get_youtube_client_credentials',
return_value={"client_id": "test", "client_secret": "test"}):
with patch('requests.post', return_value=mock_response):
status, data = manager.poll_device_auth("youtube", "expired_code")
assert status == "expired"
assert "expired" in data["message"].lower()
def test_poll_device_auth_pending(self):
"""Test polling when authorization is pending."""
manager = CredentialManager()
mock_response = MagicMock()
mock_response.status_code = 400
mock_response.json.return_value = {"error": "authorization_pending"}
with patch.object(manager, 'get_youtube_client_credentials',
return_value={"client_id": "test", "client_secret": "test"}):
with patch('requests.post', return_value=mock_response):
status, data = manager.poll_device_auth("youtube", "pending_code")
assert status == "pending"
assert "waiting" in data["message"].lower()
def test_poll_device_auth_success(self):
"""Test polling when authorization completes successfully."""
manager = CredentialManager()
mock_response = MagicMock()
mock_response.status_code = 200
mock_response.json.return_value = {
"access_token": "new_access_token",
"refresh_token": "new_refresh_token"
}
with patch.object(manager, 'get_youtube_client_credentials',
return_value={"client_id": "test_id", "client_secret": "test_secret"}):
with patch('requests.post', return_value=mock_response):
with patch.object(manager, '_save_credentials_to_secret', return_value=True):
status, data = manager.poll_device_auth("youtube", "completed_code")
assert status == "complete"
assert data["token"] == "new_access_token"
assert data["refresh_token"] == "new_refresh_token"
assert data["client_id"] == "test_id"
class TestGetCredentialManager:
"""Tests for singleton factory function."""
def test_returns_singleton(self):
"""Test that factory returns same instance."""
# Reset singleton
import backend.services.credential_manager as module
module._credential_manager = None
manager1 = get_credential_manager()
manager2 = get_credential_manager()
assert manager1 is manager2
class TestAuthRoutes:
"""Tests for auth API routes."""
def test_routes_import(self):
"""Test that routes can be imported."""
from backend.api.routes.auth import router
assert router is not None
def test_status_endpoint_exists(self):
"""Test that status endpoint is defined."""
from backend.api.routes.auth import get_credentials_status
assert get_credentials_status is not None
def test_validate_endpoint_exists(self):
"""Test that validate endpoint is defined."""
from backend.api.routes.auth import validate_credentials
assert validate_credentials is not None
def test_device_auth_endpoint_exists(self):
"""Test that device auth endpoints are defined."""
from backend.api.routes.auth import (
start_youtube_device_auth,
poll_youtube_device_auth,
start_gdrive_device_auth,
poll_gdrive_device_auth,
)
assert start_youtube_device_auth is not None
assert poll_youtube_device_auth is not None
assert start_gdrive_device_auth is not None
assert poll_gdrive_device_auth is not None
class TestFileUploadCredentialValidation:
"""Tests for credential validation in file upload."""
def test_credential_manager_imported(self):
"""Test that credential manager is imported in file upload."""
from backend.api.routes.file_upload import get_credential_manager, CredentialStatus
assert get_credential_manager is not None
assert CredentialStatus is not None
-54
View File
@@ -1,54 +0,0 @@
"""
Tests for API dependencies (authentication, authorization).
"""
import pytest
from unittest.mock import MagicMock, patch
class TestAuthDependencies:
"""Tests for authentication dependencies module structure."""
def test_get_token_from_request_function_exists(self):
"""Test get_token_from_request function exists."""
from backend.api.dependencies import get_token_from_request
assert get_token_from_request is not None
def test_require_auth_function_exists(self):
"""Test require_auth function exists."""
from backend.api.dependencies import require_auth
assert require_auth is not None
def test_require_admin_function_exists(self):
"""Test require_admin function exists."""
from backend.api.dependencies import require_admin
assert require_admin is not None
def test_optional_auth_function_exists(self):
"""Test optional_auth function exists."""
from backend.api.dependencies import optional_auth
assert optional_auth is not None
def test_security_scheme_defined(self):
"""Test HTTP Bearer security scheme is defined."""
from backend.api.dependencies import security
assert security is not None
def test_logger_configured(self):
"""Test logger is configured."""
from backend.api.dependencies import logger
assert logger is not None
class TestAuthServiceAccess:
"""Tests for auth service access."""
def test_get_auth_service_function_exists(self):
"""Test get_auth_service function exists."""
from backend.services.auth_service import get_auth_service
assert get_auth_service is not None
def test_user_type_enum_defined(self):
"""Test UserType enum is defined."""
from backend.services.auth_service import UserType
assert UserType is not None
-820
View File
@@ -1,820 +0,0 @@
"""
Tests for native distribution services (Dropbox and Google Drive).
These tests verify the service interfaces without requiring actual
cloud credentials, using mocks to simulate API responses.
"""
import json
import os
import pytest
from unittest.mock import MagicMock, patch, mock_open
class TestDropboxService:
"""Tests for the DropboxService class."""
def test_module_imports(self):
"""Test that the module imports correctly."""
from backend.services.dropbox_service import DropboxService, get_dropbox_service
assert DropboxService is not None
assert get_dropbox_service is not None
def test_init_creates_instance(self):
"""Test that we can create a DropboxService instance."""
from backend.services.dropbox_service import DropboxService
service = DropboxService()
assert service is not None
assert service._client is None # Client not initialized until first use
assert service._is_configured is False
def test_is_configured_returns_false_without_credentials(self):
"""Test that is_configured returns False when credentials are missing."""
from backend.services.dropbox_service import DropboxService
with patch.object(DropboxService, '_load_credentials', return_value=None):
service = DropboxService()
assert service.is_configured is False
def test_is_configured_returns_true_with_credentials(self):
"""Test that is_configured returns True when credentials are present."""
from backend.services.dropbox_service import DropboxService
mock_creds = {"access_token": "test_token"}
with patch.object(DropboxService, '_load_credentials', return_value=mock_creds):
service = DropboxService()
assert service.is_configured is True
def test_is_configured_caches_result(self):
"""Test that is_configured caches the result."""
from backend.services.dropbox_service import DropboxService
service = DropboxService()
service._is_configured = True
# Should return True without calling _load_credentials
assert service.is_configured is True
def test_is_configured_returns_false_without_access_token(self):
"""Test that is_configured returns False when access_token is missing."""
from backend.services.dropbox_service import DropboxService
mock_creds = {"refresh_token": "test"} # No access_token
with patch.object(DropboxService, '_load_credentials', return_value=mock_creds):
service = DropboxService()
assert service.is_configured is False
def test_get_next_brand_code_first_track(self):
"""Test brand code calculation when no existing tracks."""
from backend.services.dropbox_service import DropboxService
service = DropboxService()
with patch.object(service, 'list_folders', return_value=[]):
brand_code = service.get_next_brand_code("/test/path", "NOMAD")
assert brand_code == "NOMAD-0001"
def test_get_next_brand_code_sequential(self):
"""Test brand code calculation with existing tracks."""
from backend.services.dropbox_service import DropboxService
service = DropboxService()
existing_folders = [
"NOMAD-0001 - Artist1 - Song1",
"NOMAD-0002 - Artist2 - Song2",
"NOMAD-0005 - Artist3 - Song3", # Gap in sequence
"OTHER-0001 - Different Brand", # Different brand
]
with patch.object(service, 'list_folders', return_value=existing_folders):
brand_code = service.get_next_brand_code("/test/path", "NOMAD")
assert brand_code == "NOMAD-0006"
def test_get_next_brand_code_different_prefix(self):
"""Test brand code calculation with different brand prefix."""
from backend.services.dropbox_service import DropboxService
service = DropboxService()
existing_folders = [
"NOMAD-0001 - Artist1 - Song1",
"TEST-0010 - Artist2 - Song2",
]
with patch.object(service, 'list_folders', return_value=existing_folders):
brand_code = service.get_next_brand_code("/test/path", "TEST")
assert brand_code == "TEST-0011"
def test_factory_function_returns_instance(self):
"""Test that get_dropbox_service returns a service instance."""
from backend.services.dropbox_service import get_dropbox_service
service = get_dropbox_service()
assert service is not None
def test_load_credentials_handles_exception(self):
"""Test that _load_credentials handles exceptions gracefully."""
from backend.services.dropbox_service import DropboxService
with patch('backend.services.dropbox_service.secretmanager.SecretManagerServiceClient') as mock_client:
mock_client.return_value.access_secret_version.side_effect = Exception("API Error")
service = DropboxService()
result = service._load_credentials()
assert result is None
def test_load_credentials_parses_json(self):
"""Test that _load_credentials correctly parses JSON credentials."""
from backend.services.dropbox_service import DropboxService
mock_creds = {"access_token": "test_token", "refresh_token": "test_refresh"}
mock_response = MagicMock()
mock_response.payload.data.decode.return_value = json.dumps(mock_creds)
with patch('backend.services.dropbox_service.secretmanager.SecretManagerServiceClient') as mock_client:
mock_client.return_value.access_secret_version.return_value = mock_response
service = DropboxService()
result = service._load_credentials()
assert result == mock_creds
def test_client_property_raises_without_credentials(self):
"""Test that client property raises error without credentials."""
from backend.services.dropbox_service import DropboxService
with patch.object(DropboxService, '_load_credentials', return_value=None):
service = DropboxService()
with pytest.raises(RuntimeError, match="credentials not configured"):
_ = service.client
def test_client_property_raises_import_error(self):
"""Test that client property raises helpful error if dropbox not installed."""
from backend.services.dropbox_service import DropboxService
import sys
mock_creds = {"access_token": "test_token"}
with patch.object(DropboxService, '_load_credentials', return_value=mock_creds):
with patch.dict(sys.modules, {'dropbox': None}):
service = DropboxService()
# Force reimport to fail
with patch('builtins.__import__', side_effect=ImportError("No module named 'dropbox'")):
with pytest.raises(ImportError, match="dropbox package"):
_ = service.client
def test_list_folders_adds_leading_slash(self):
"""Test that list_folders adds leading slash if missing."""
from backend.services.dropbox_service import DropboxService
service = DropboxService()
mock_client = MagicMock()
mock_result = MagicMock()
mock_result.entries = []
mock_result.has_more = False
mock_client.files_list_folder.return_value = mock_result
service._client = mock_client
service.list_folders("test/path") # No leading slash
# Verify it was called with leading slash
mock_client.files_list_folder.assert_called_with("/test/path")
def test_upload_file_adds_leading_slash(self):
"""Test that upload_file adds leading slash to remote path."""
from backend.services.dropbox_service import DropboxService
import tempfile
service = DropboxService()
mock_client = MagicMock()
service._client = mock_client
# Create a small temp file
with tempfile.NamedTemporaryFile(delete=False, mode='wb') as f:
f.write(b"test content")
temp_path = f.name
try:
service.upload_file(temp_path, "remote/path.txt") # No leading slash
# Verify upload was called with leading slash
mock_client.files_upload.assert_called_once()
call_args = mock_client.files_upload.call_args
assert call_args[0][1] == "/remote/path.txt"
finally:
os.unlink(temp_path)
def test_upload_folder_uploads_all_files(self):
"""Test that upload_folder uploads all files in directory."""
from backend.services.dropbox_service import DropboxService
import tempfile
service = DropboxService()
with tempfile.TemporaryDirectory() as tmpdir:
# Create some test files
(open(os.path.join(tmpdir, "file1.txt"), "w")).write("content1")
(open(os.path.join(tmpdir, "file2.txt"), "w")).write("content2")
with patch.object(service, 'upload_file') as mock_upload:
service.upload_folder(tmpdir, "/remote/folder")
assert mock_upload.call_count == 2
def test_create_shared_link_success(self):
"""Test successful shared link creation."""
from backend.services.dropbox_service import DropboxService
service = DropboxService()
mock_client = MagicMock()
mock_link = MagicMock()
mock_link.url = "https://dropbox.com/shared/test"
mock_client.sharing_create_shared_link_with_settings.return_value = mock_link
service._client = mock_client
result = service.create_shared_link("/test/path")
assert result == "https://dropbox.com/shared/test"
def test_sharing_list_shared_links_mock_setup(self):
"""Test that mock setup for sharing_list_shared_links works correctly.
Note: Properly mocking Dropbox's ApiError is complex because it
requires specific exception class structure. This test verifies
the mock configuration is correct for the success path, which is
a prerequisite for more complex error-handling tests.
"""
from backend.services.dropbox_service import DropboxService
service = DropboxService()
mock_client = MagicMock()
# Mock the existing link retrieval (success case)
mock_existing_link = MagicMock()
mock_existing_link.url = "https://dropbox.com/existing/link"
mock_links_result = MagicMock()
mock_links_result.links = [mock_existing_link]
mock_client.sharing_list_shared_links.return_value = mock_links_result
# Assign the mock client to the service
service._client = mock_client
# Verify the mock returns the expected link structure
result = mock_client.sharing_list_shared_links(path="/test/path")
assert result.links[0].url == "https://dropbox.com/existing/link"
mock_client.sharing_list_shared_links.assert_called_once_with(path="/test/path")
class TestGoogleDriveService:
"""Tests for the GoogleDriveService class."""
def test_module_imports(self):
"""Test that the module imports correctly."""
from backend.services.gdrive_service import GoogleDriveService, get_gdrive_service
assert GoogleDriveService is not None
assert get_gdrive_service is not None
def test_init_creates_instance(self):
"""Test that we can create a GoogleDriveService instance."""
from backend.services.gdrive_service import GoogleDriveService
service = GoogleDriveService()
assert service is not None
assert service._service is None # Service not initialized until first use
assert service._loaded is False
def test_is_configured_returns_false_without_credentials(self):
"""Test that is_configured returns False when credentials are missing."""
from backend.services.gdrive_service import GoogleDriveService
with patch.object(GoogleDriveService, '_load_credentials', return_value=None):
service = GoogleDriveService()
assert service.is_configured is False
def test_is_configured_returns_true_with_credentials(self):
"""Test that is_configured returns True when credentials are present."""
from backend.services.gdrive_service import GoogleDriveService
mock_creds = {
"token": "test_token",
"refresh_token": "test_refresh",
"client_id": "test_client_id",
"client_secret": "test_client_secret",
}
with patch.object(GoogleDriveService, '_load_credentials', return_value=mock_creds):
service = GoogleDriveService()
assert service.is_configured is True
def test_factory_function_returns_singleton(self):
"""Test that get_gdrive_service returns a singleton."""
from backend.services.gdrive_service import get_gdrive_service, _gdrive_service
# Reset singleton
import backend.services.gdrive_service as gdrive_module
gdrive_module._gdrive_service = None
service1 = get_gdrive_service()
service2 = get_gdrive_service()
assert service1 is service2
def test_load_credentials_caches_result(self):
"""Test that _load_credentials caches the result."""
from backend.services.gdrive_service import GoogleDriveService
service = GoogleDriveService()
service._loaded = True
service._credentials_data = {"cached": "data"}
# Should return cached data without calling settings
result = service._load_credentials()
assert result == {"cached": "data"}
def test_load_credentials_falls_back_to_youtube(self):
"""Test that _load_credentials falls back to YouTube credentials."""
from backend.services.gdrive_service import GoogleDriveService
mock_settings = MagicMock()
mock_settings.get_secret.side_effect = [
None, # gdrive-oauth-credentials not found
'{"refresh_token": "yt_refresh", "client_id": "yt_client", "client_secret": "yt_secret"}', # youtube-oauth-credentials
]
service = GoogleDriveService()
service.settings = mock_settings
result = service._load_credentials()
assert result is not None
assert result["refresh_token"] == "yt_refresh"
def test_load_credentials_returns_none_when_both_fail(self):
"""Test that _load_credentials returns None when no credentials available."""
from backend.services.gdrive_service import GoogleDriveService
mock_settings = MagicMock()
mock_settings.get_secret.return_value = None
service = GoogleDriveService()
service.settings = mock_settings
result = service._load_credentials()
assert result is None
assert service._loaded is True
def test_load_credentials_validates_required_fields(self):
"""Test that _load_credentials validates required fields."""
from backend.services.gdrive_service import GoogleDriveService
mock_settings = MagicMock()
# Missing client_secret
mock_settings.get_secret.return_value = '{"refresh_token": "test", "client_id": "test"}'
service = GoogleDriveService()
service.settings = mock_settings
result = service._load_credentials()
assert result is None # Should fail validation
def test_load_credentials_handles_json_error(self):
"""Test that _load_credentials handles JSON parse errors."""
from backend.services.gdrive_service import GoogleDriveService
mock_settings = MagicMock()
mock_settings.get_secret.return_value = "not valid json"
service = GoogleDriveService()
service.settings = mock_settings
result = service._load_credentials()
assert result is None
def test_service_property_raises_without_credentials(self):
"""Test that service property raises error without credentials."""
from backend.services.gdrive_service import GoogleDriveService
with patch.object(GoogleDriveService, '_load_credentials', return_value=None):
service = GoogleDriveService()
with pytest.raises(RuntimeError, match="credentials not configured"):
_ = service.service
def test_get_or_create_folder_finds_existing(self):
"""Test that get_or_create_folder finds existing folders."""
from backend.services.gdrive_service import GoogleDriveService
service = GoogleDriveService()
mock_service = MagicMock()
mock_files = MagicMock()
mock_list = MagicMock()
mock_list.execute.return_value = {"files": [{"id": "existing_folder_id", "name": "TestFolder"}]}
mock_files.list.return_value = mock_list
mock_service.files.return_value = mock_files
service._service = mock_service
result = service.get_or_create_folder("parent_id", "TestFolder")
assert result == "existing_folder_id"
def test_get_or_create_folder_creates_new(self):
"""Test that get_or_create_folder creates new folders when not found."""
from backend.services.gdrive_service import GoogleDriveService
service = GoogleDriveService()
mock_service = MagicMock()
mock_files = MagicMock()
# First call - folder doesn't exist
mock_list = MagicMock()
mock_list.execute.return_value = {"files": []}
mock_files.list.return_value = mock_list
# Second call - create folder
mock_create = MagicMock()
mock_create.execute.return_value = {"id": "new_folder_id"}
mock_files.create.return_value = mock_create
mock_service.files.return_value = mock_files
service._service = mock_service
result = service.get_or_create_folder("parent_id", "NewFolder")
assert result == "new_folder_id"
def test_upload_file_determines_mime_type(self):
"""Test that upload_file determines correct MIME type."""
from backend.services.gdrive_service import GoogleDriveService
import tempfile
service = GoogleDriveService()
mock_service = MagicMock()
mock_files = MagicMock()
# Mock list (for replace_existing check)
mock_list = MagicMock()
mock_list.execute.return_value = {"files": []}
mock_files.list.return_value = mock_list
# Mock create
mock_create = MagicMock()
mock_create.execute.return_value = {"id": "uploaded_file_id"}
mock_files.create.return_value = mock_create
mock_service.files.return_value = mock_files
service._service = mock_service
# Create a temp file with .mp4 extension
with tempfile.NamedTemporaryFile(suffix='.mp4', delete=False) as f:
f.write(b"fake video content")
temp_path = f.name
try:
result = service.upload_file(temp_path, "parent_id", "test.mp4")
assert result == "uploaded_file_id"
finally:
os.unlink(temp_path)
def test_upload_file_replaces_existing(self):
"""Test that upload_file can replace existing files."""
from backend.services.gdrive_service import GoogleDriveService
import tempfile
service = GoogleDriveService()
mock_service = MagicMock()
mock_files = MagicMock()
# Mock list - file exists
mock_list = MagicMock()
mock_list.execute.return_value = {"files": [{"id": "existing_id"}]}
mock_files.list.return_value = mock_list
# Mock delete
mock_delete = MagicMock()
mock_files.delete.return_value = mock_delete
# Mock create
mock_create = MagicMock()
mock_create.execute.return_value = {"id": "new_file_id"}
mock_files.create.return_value = mock_create
mock_service.files.return_value = mock_files
service._service = mock_service
with tempfile.NamedTemporaryFile(suffix='.txt', delete=False) as f:
f.write(b"content")
temp_path = f.name
try:
result = service.upload_file(temp_path, "parent_id", "test.txt", replace_existing=True)
assert result == "new_file_id"
mock_files.delete.assert_called_once()
finally:
os.unlink(temp_path)
def test_upload_to_public_share_creates_structure(self):
"""Test that upload_to_public_share creates folder structure."""
from backend.services.gdrive_service import GoogleDriveService
import tempfile
service = GoogleDriveService()
with tempfile.TemporaryDirectory() as tmpdir:
# Create test files
mp4_path = os.path.join(tmpdir, "test.mp4")
mp4_720_path = os.path.join(tmpdir, "test_720p.mp4")
cdg_path = os.path.join(tmpdir, "test.zip")
open(mp4_path, 'wb').write(b"mp4 content")
open(mp4_720_path, 'wb').write(b"720p content")
open(cdg_path, 'wb').write(b"cdg content")
with patch.object(service, 'get_or_create_folder', return_value="folder_id"):
with patch.object(service, 'upload_file', return_value="file_id"):
result = service.upload_to_public_share(
root_folder_id="root_id",
brand_code="TEST-0001",
base_name="Artist - Title",
output_files={
"final_karaoke_lossy_mp4": mp4_path,
"final_karaoke_lossy_720p_mp4": mp4_720_path,
"final_karaoke_cdg_zip": cdg_path,
}
)
assert "mp4" in result
assert "mp4_720p" in result
assert "cdg" in result
def test_upload_to_public_share_handles_missing_files(self):
"""Test that upload_to_public_share handles missing files gracefully."""
from backend.services.gdrive_service import GoogleDriveService
service = GoogleDriveService()
with patch.object(service, 'get_or_create_folder', return_value="folder_id"):
with patch.object(service, 'upload_file', return_value="file_id"):
result = service.upload_to_public_share(
root_folder_id="root_id",
brand_code="TEST-0001",
base_name="Artist - Title",
output_files={
"final_karaoke_lossy_mp4": "/nonexistent/path.mp4",
}
)
# Should return empty since file doesn't exist
assert result == {}
class TestJobModelDistributionFields:
"""Tests for distribution fields in Job model."""
def test_job_model_has_dropbox_path_field(self):
"""Test that Job model has dropbox_path field."""
from backend.models.job import Job, JobStatus
from datetime import datetime
job = Job(
job_id="test-123",
status=JobStatus.PENDING,
created_at=datetime.now(),
updated_at=datetime.now(),
dropbox_path="/Karaoke/Tracks-Organized",
)
assert job.dropbox_path == "/Karaoke/Tracks-Organized"
def test_job_model_has_gdrive_folder_id_field(self):
"""Test that Job model has gdrive_folder_id field."""
from backend.models.job import Job, JobStatus
from datetime import datetime
job = Job(
job_id="test-123",
status=JobStatus.PENDING,
created_at=datetime.now(),
updated_at=datetime.now(),
gdrive_folder_id="1abc123xyz",
)
assert job.gdrive_folder_id == "1abc123xyz"
def test_job_model_distribution_fields_optional(self):
"""Test that distribution fields are optional."""
from backend.models.job import Job, JobStatus
from datetime import datetime
job = Job(
job_id="test-123",
status=JobStatus.PENDING,
created_at=datetime.now(),
updated_at=datetime.now(),
)
assert job.dropbox_path is None
assert job.gdrive_folder_id is None
class TestJobCreateDistributionFields:
"""Tests for distribution fields in JobCreate model."""
def test_job_create_has_dropbox_path_field(self):
"""Test that JobCreate model has dropbox_path field."""
from backend.models.job import JobCreate
job_create = JobCreate(
artist="Test Artist",
title="Test Title",
dropbox_path="/Karaoke/Tracks-Organized",
)
assert job_create.dropbox_path == "/Karaoke/Tracks-Organized"
def test_job_create_has_gdrive_folder_id_field(self):
"""Test that JobCreate model has gdrive_folder_id field."""
from backend.models.job import JobCreate
job_create = JobCreate(
artist="Test Artist",
title="Test Title",
gdrive_folder_id="1abc123xyz",
)
assert job_create.gdrive_folder_id == "1abc123xyz"
def test_job_create_distribution_fields_optional(self):
"""Test that distribution fields are optional in JobCreate."""
from backend.models.job import JobCreate
job_create = JobCreate(
artist="Test Artist",
title="Test Title",
)
assert job_create.dropbox_path is None
assert job_create.gdrive_folder_id is None
class TestFileUploadDistributionParams:
"""Tests for distribution parameters in file upload endpoint."""
def test_endpoint_has_dropbox_path_parameter(self):
"""Test that upload endpoint signature includes dropbox_path parameter."""
import inspect
from backend.api.routes.file_upload import upload_and_create_job
sig = inspect.signature(upload_and_create_job)
param_names = list(sig.parameters.keys())
assert "dropbox_path" in param_names
def test_endpoint_has_gdrive_folder_id_parameter(self):
"""Test that upload endpoint signature includes gdrive_folder_id parameter."""
import inspect
from backend.api.routes.file_upload import upload_and_create_job
sig = inspect.signature(upload_and_create_job)
param_names = list(sig.parameters.keys())
assert "gdrive_folder_id" in param_names
def test_endpoint_dropbox_path_is_optional(self):
"""Test that dropbox_path parameter has a default value (Form(None))."""
import inspect
from backend.api.routes.file_upload import upload_and_create_job
sig = inspect.signature(upload_and_create_job)
param = sig.parameters.get("dropbox_path")
assert param is not None
# Default is Form(None), so check that it's not required
assert param.default is not inspect.Parameter.empty
def test_endpoint_gdrive_folder_id_is_optional(self):
"""Test that gdrive_folder_id parameter has a default value (Form(None))."""
import inspect
from backend.api.routes.file_upload import upload_and_create_job
sig = inspect.signature(upload_and_create_job)
param = sig.parameters.get("gdrive_folder_id")
assert param is not None
# Default is Form(None), so check that it's not required
assert param.default is not inspect.Parameter.empty
class TestVideoWorkerDistribution:
"""Tests for distribution handling in video worker."""
def test_handle_native_distribution_function_exists(self):
"""Test that _handle_native_distribution function exists."""
from backend.workers import video_worker
assert hasattr(video_worker, '_handle_native_distribution')
def test_video_worker_imports_distribution_services(self):
"""Test that video worker can import distribution services."""
# The services should be importable (even if credentials aren't available)
try:
from backend.services.dropbox_service import DropboxService
from backend.services.gdrive_service import GoogleDriveService
assert True
except ImportError as e:
pytest.fail(f"Failed to import distribution services: {e}")
@pytest.mark.asyncio
async def test_handle_native_distribution_skips_without_config(self):
"""Test that _handle_native_distribution skips when not configured."""
from backend.workers.video_worker import _handle_native_distribution
mock_job = MagicMock()
mock_job.dropbox_path = None
mock_job.gdrive_folder_id = None
mock_job.brand_prefix = None
mock_job.artist = "Test"
mock_job.title = "Song"
mock_job_log = MagicMock()
mock_job_manager = MagicMock()
# Should complete without error
await _handle_native_distribution(
job_id="test-123",
job=mock_job,
job_log=mock_job_log,
job_manager=mock_job_manager,
temp_dir="/tmp/test",
result={},
)
# No errors should have been logged
mock_job_log.error.assert_not_called()
@pytest.mark.asyncio
async def test_handle_native_distribution_dropbox_not_configured(self):
"""Test Dropbox upload skipped when service not configured."""
from backend.workers.video_worker import _handle_native_distribution
mock_job = MagicMock()
mock_job.dropbox_path = "/test/path"
mock_job.brand_prefix = "TEST"
mock_job.gdrive_folder_id = None
mock_job.artist = "Test"
mock_job.title = "Song"
mock_job.state_data = {}
mock_job_log = MagicMock()
mock_job_manager = MagicMock()
mock_dropbox = MagicMock()
mock_dropbox.is_configured = False
with patch('backend.services.dropbox_service.get_dropbox_service', return_value=mock_dropbox):
await _handle_native_distribution(
job_id="test-123",
job=mock_job,
job_log=mock_job_log,
job_manager=mock_job_manager,
temp_dir="/tmp/test",
result={},
)
# Should log warning about not configured
mock_job_log.warning.assert_called()
@pytest.mark.asyncio
async def test_handle_native_distribution_gdrive_not_configured(self):
"""Test Google Drive upload skipped when service not configured."""
from backend.workers.video_worker import _handle_native_distribution
mock_job = MagicMock()
mock_job.dropbox_path = None
mock_job.brand_prefix = None
mock_job.gdrive_folder_id = "test_folder_id"
mock_job.artist = "Test"
mock_job.title = "Song"
mock_job.state_data = {}
mock_job_log = MagicMock()
mock_job_manager = MagicMock()
mock_gdrive = MagicMock()
mock_gdrive.is_configured = False
with patch('backend.services.gdrive_service.get_gdrive_service', return_value=mock_gdrive):
await _handle_native_distribution(
job_id="test-123",
job=mock_job,
job_log=mock_job_log,
job_manager=mock_job_manager,
temp_dir="/tmp/test",
result={},
)
# Should log warning about not configured
mock_job_log.warning.assert_called()
@pytest.mark.asyncio
async def test_handle_native_distribution_handles_import_error(self):
"""Test that import errors for services are handled gracefully."""
from backend.workers.video_worker import _handle_native_distribution
mock_job = MagicMock()
mock_job.dropbox_path = "/test/path"
mock_job.brand_prefix = "TEST"
mock_job.gdrive_folder_id = None
mock_job.artist = "Test"
mock_job.title = "Song"
mock_job.state_data = {}
mock_job_log = MagicMock()
mock_job_manager = MagicMock()
# Simulate import error
with patch('backend.services.dropbox_service.get_dropbox_service', side_effect=ImportError("No module")):
await _handle_native_distribution(
job_id="test-123",
job=mock_job,
job_log=mock_job_log,
job_manager=mock_job_manager,
temp_dir="/tmp/test",
result={},
)
# Should log warning about import error
mock_job_log.warning.assert_called()
-322
View File
@@ -1,322 +0,0 @@
"""
Integration tests using local GCP emulators.
These tests use real Firestore and GCS emulators running locally,
providing true integration testing without cloud resources or costs.
Run with: ./scripts/run-emulator-tests.sh
NOTE: These are simplified integration tests that focus on the most critical
paths. They mock background workers to avoid race conditions and network issues.
"""
import pytest
import os
import time
from unittest.mock import AsyncMock, patch
from datetime import datetime, UTC
import requests
def emulators_running() -> bool:
"""Check if GCP emulators are running."""
try:
requests.get("http://127.0.0.1:8080", timeout=1)
requests.get("http://127.0.0.1:4443", timeout=1)
return True
except (requests.exceptions.ConnectionError, requests.exceptions.Timeout):
return False
# Skip all tests in this module if emulators aren't running
pytestmark = pytest.mark.skipif(
not emulators_running(),
reason="GCP emulators not running. Start with: scripts/start-emulators.sh"
)
# Set emulator environment variables before any imports (use 127.0.0.1 for IPv4)
os.environ["FIRESTORE_EMULATOR_HOST"] = "127.0.0.1:8080"
os.environ["STORAGE_EMULATOR_HOST"] = "http://127.0.0.1:4443"
os.environ["GOOGLE_CLOUD_PROJECT"] = "test-project"
os.environ["GCS_BUCKET_NAME"] = "test-bucket"
os.environ["FIRESTORE_COLLECTION"] = "test-jobs" # Use separate collection for tests
os.environ["ENVIRONMENT"] = "test"
os.environ["ADMIN_TOKENS"] = "test-admin-token"
# Only import if emulators are running
if emulators_running():
from fastapi.testclient import TestClient
from backend.main import app
from backend.models.job import JobStatus
else:
TestClient = None
app = None
JobStatus = None
@pytest.fixture(scope="module", autouse=True)
def setup_gcs_bucket():
"""Create GCS bucket in emulator before tests."""
try:
response = requests.post(
"http://localhost:4443/storage/v1/b",
json={"name": "test-bucket"},
params={"project": "test-project"}
)
if response.status_code in [200, 409]:
print(f"✅ GCS bucket 'test-bucket' ready")
except Exception as e:
print(f"⚠️ GCS bucket setup failed: {e}")
yield
@pytest.fixture(scope="module")
def mock_worker_service():
"""Mock the worker service to prevent background tasks."""
with patch("backend.api.routes.jobs.worker_service") as mock:
mock.trigger_audio_worker = AsyncMock(return_value=True)
mock.trigger_lyrics_worker = AsyncMock(return_value=True)
mock.trigger_screens_worker = AsyncMock(return_value=True)
mock.trigger_video_worker = AsyncMock(return_value=True)
yield mock
@pytest.fixture(scope="module")
def client(mock_worker_service):
"""Create FastAPI test client with mocked workers."""
with patch("backend.api.routes.file_upload.worker_service", mock_worker_service):
return TestClient(app)
@pytest.fixture
def auth_headers():
"""Auth headers for testing."""
return {"Authorization": "Bearer test-admin-token"}
class TestEmulatorBasics:
"""Basic emulator connectivity tests."""
def test_health_endpoint(self, client):
"""Test health endpoint works."""
response = client.get("/api/health")
assert response.status_code == 200
assert response.json()["status"] == "healthy"
def test_root_endpoint(self, client):
"""Test root endpoint works."""
response = client.get("/")
assert response.status_code == 200
assert response.json()["service"] == "karaoke-gen-backend"
class TestJobCreation:
"""Test job creation with Firestore emulator."""
def test_create_job_simple(self, client, auth_headers):
"""Test creating a simple job."""
response = client.post(
"/api/jobs",
headers=auth_headers,
json={"url": "https://youtube.com/watch?v=test123"}
)
assert response.status_code == 200
data = response.json()
assert data["status"] == "success"
assert "job_id" in data
def test_create_job_with_metadata(self, client, auth_headers):
"""Test creating a job with artist/title."""
response = client.post(
"/api/jobs",
headers=auth_headers,
json={
"url": "https://youtube.com/watch?v=test",
"artist": "Test Artist",
"title": "Test Song"
}
)
assert response.status_code == 200
data = response.json()
assert "job_id" in data
class TestJobRetrieval:
"""Test job retrieval from Firestore emulator."""
def test_create_and_get_job(self, client, auth_headers):
"""Test creating and then retrieving a job."""
# Create
create_resp = client.post(
"/api/jobs",
headers=auth_headers,
json={
"url": "https://youtube.com/watch?v=abc123",
"artist": "Test Artist",
"title": "Test Song"
}
)
assert create_resp.status_code == 200
job_id = create_resp.json()["job_id"]
# Small delay for emulator consistency
time.sleep(0.2)
# Retrieve
get_resp = client.get(f"/api/jobs/{job_id}", headers=auth_headers)
if get_resp.status_code != 200:
print(f"GET failed: {get_resp.status_code} - {get_resp.text}")
assert get_resp.status_code == 200
job = get_resp.json()
assert job["job_id"] == job_id
assert job["status"] == "pending"
assert job["artist"] == "Test Artist"
assert job["title"] == "Test Song"
def test_get_nonexistent_job(self, client, auth_headers):
"""Test fetching a job that doesn't exist."""
response = client.get("/api/jobs/nonexistent-id", headers=auth_headers)
assert response.status_code == 404
class TestJobList:
"""Test listing jobs from Firestore."""
def test_list_jobs(self, client, auth_headers):
"""Test listing jobs."""
# Create a few jobs
for i in range(3):
client.post(
"/api/jobs",
headers=auth_headers,
json={"url": f"https://youtube.com/watch?v=list{i}"}
)
time.sleep(0.2)
# List
response = client.get("/api/jobs", headers=auth_headers)
assert response.status_code == 200
jobs = response.json()
assert isinstance(jobs, list)
# We should have at least the 3 we just created
assert len(jobs) >= 3
class TestJobDeletion:
"""Test job deletion."""
def test_delete_job(self, client, auth_headers):
"""Test deleting a job."""
# Create
create_resp = client.post(
"/api/jobs",
headers=auth_headers,
json={"url": "https://youtube.com/watch?v=delete-me"}
)
job_id = create_resp.json()["job_id"]
time.sleep(0.2)
# Delete
del_resp = client.delete(f"/api/jobs/{job_id}", headers=auth_headers)
assert del_resp.status_code == 200
# Verify deleted
get_resp = client.get(f"/api/jobs/{job_id}", headers=auth_headers)
assert get_resp.status_code == 404
class TestJobUpdates:
"""Test job status updates."""
def test_cancel_job(self, client, auth_headers):
"""Test cancelling a job."""
# Create
create_resp = client.post(
"/api/jobs",
headers=auth_headers,
json={"url": "https://youtube.com/watch?v=cancel-me"}
)
job_id = create_resp.json()["job_id"]
time.sleep(0.2)
# Cancel
cancel_resp = client.post(
f"/api/jobs/{job_id}/cancel",
headers=auth_headers,
json={"reason": "test cancellation"}
)
assert cancel_resp.status_code == 200
# Verify cancelled
get_resp = client.get(f"/api/jobs/{job_id}", headers=auth_headers)
assert get_resp.status_code == 200
job = get_resp.json()
assert job["status"] == "cancelled"
class TestFileUpload:
"""Test file upload with GCS emulator."""
def test_upload_file(self, client, auth_headers):
"""Test uploading a file."""
test_file_content = b"fake audio data for testing"
response = client.post(
"/api/jobs/upload",
headers={"Authorization": auth_headers["Authorization"]},
files={"file": ("test.flac", test_file_content, "audio/flac")},
data={"artist": "Upload Artist", "title": "Upload Song"}
)
assert response.status_code == 200
data = response.json()
assert data["status"] == "success"
assert "job_id" in data
job_id = data["job_id"]
time.sleep(0.2)
# Verify job created with upload data
get_resp = client.get(f"/api/jobs/{job_id}", headers=auth_headers)
assert get_resp.status_code == 200
job = get_resp.json()
assert job["artist"] == "Upload Artist"
assert job["title"] == "Upload Song"
assert "input_media_gcs_path" in job
class TestInternalEndpoints:
"""Test internal worker endpoints."""
def test_internal_workers_exist(self, client, auth_headers):
"""Test that internal worker endpoints exist and respond."""
# Create a job first
create_resp = client.post(
"/api/jobs",
headers=auth_headers,
json={"url": "https://youtube.com/watch?v=worker-test"}
)
job_id = create_resp.json()["job_id"]
time.sleep(0.2)
# Test audio worker endpoint exists
response = client.post(
"/api/internal/workers/audio",
headers=auth_headers,
json={"job_id": job_id}
)
assert response.status_code == 200
assert response.json()["status"] == "started"
print("✅ Emulator integration tests ready to run")
File diff suppressed because it is too large. Load diff
-457
View File
@@ -1,457 +0,0 @@
"""
API endpoint tests for instrumental review functionality.
Tests for:
- GET /api/jobs/{job_id}/instrumental-analysis
- GET /api/jobs/{job_id}/audio-stream/{stem_type}
- POST /api/jobs/{job_id}/create-custom-instrumental
- GET /api/jobs/{job_id}/waveform-data
"""
import pytest
from datetime import datetime
from unittest.mock import MagicMock, patch, AsyncMock
from fastapi.testclient import TestClient
from backend.models.job import Job, JobStatus
@pytest.fixture
def mock_job_manager():
"""Create a mock job manager."""
with patch('backend.api.routes.jobs.job_manager') as mock:
yield mock
@pytest.fixture
def mock_storage_service():
"""Create a mock storage service."""
with patch('backend.api.routes.jobs.StorageService') as mock:
mock_instance = MagicMock()
mock_instance.generate_signed_url.return_value = "https://storage.googleapis.com/signed-url"
mock.return_value = mock_instance
yield mock_instance
@pytest.fixture
def sample_job():
"""Create a sample job for testing."""
return Job(
job_id="test-job-123",
artist="Test Artist",
title="Test Song",
status=JobStatus.AWAITING_INSTRUMENTAL_SELECTION,
created_at=datetime.now(),
updated_at=datetime.now(),
file_urls={
"stems": {
"instrumental_clean": "jobs/test/stems/instrumental_clean.flac",
"backing_vocals": "jobs/test/stems/backing_vocals.flac",
"instrumental_with_backing": "jobs/test/stems/instrumental_with_backing.flac",
},
"analysis": {
"backing_vocals_waveform": "jobs/test/analysis/waveform.png",
},
},
state_data={
"backing_vocals_analysis": {
"has_audible_content": True,
"total_duration_seconds": 180.0,
"audible_segments": [
{
"start_seconds": 10.0,
"end_seconds": 20.0,
"duration_seconds": 10.0,
"avg_amplitude_db": -25.0,
},
{
"start_seconds": 60.0,
"end_seconds": 80.0,
"duration_seconds": 20.0,
"avg_amplitude_db": -30.0,
},
],
"recommended_selection": "review_needed",
"total_audible_duration_seconds": 30.0,
"audible_percentage": 16.67,
"silence_threshold_db": -40.0,
}
},
)
@pytest.fixture
def silent_job():
"""Create a job with silent backing vocals."""
return Job(
job_id="test-job-silent",
artist="Test Artist",
title="Test Song",
status=JobStatus.AWAITING_INSTRUMENTAL_SELECTION,
created_at=datetime.now(),
updated_at=datetime.now(),
file_urls={
"stems": {
"instrumental_clean": "jobs/test/stems/instrumental_clean.flac",
"backing_vocals": "jobs/test/stems/backing_vocals.flac",
"instrumental_with_backing": "jobs/test/stems/instrumental_with_backing.flac",
},
"analysis": {
"backing_vocals_waveform": "jobs/test/analysis/waveform.png",
},
},
state_data={
"backing_vocals_analysis": {
"has_audible_content": False,
"total_duration_seconds": 180.0,
"audible_segments": [],
"recommended_selection": "clean",
"total_audible_duration_seconds": 0.0,
"audible_percentage": 0.0,
"silence_threshold_db": -40.0,
}
},
)
class TestGetInstrumentalAnalysis:
"""Tests for GET /api/jobs/{job_id}/instrumental-analysis."""
def test_get_analysis_returns_data(self, mock_job_manager, mock_storage_service, sample_job):
"""GET /instrumental-analysis should return analysis data."""
mock_job_manager.get_job.return_value = sample_job
from backend.api.routes.jobs import get_instrumental_analysis
import asyncio
result = asyncio.get_event_loop().run_until_complete(
get_instrumental_analysis("test-job-123")
)
assert result["job_id"] == "test-job-123"
assert result["artist"] == "Test Artist"
assert result["title"] == "Test Song"
assert result["analysis"]["has_audible_content"] is True
assert len(result["analysis"]["audible_segments"]) == 2
def test_get_analysis_includes_audio_urls(self, mock_job_manager, mock_storage_service, sample_job):
"""GET /instrumental-analysis should include audio URLs."""
mock_job_manager.get_job.return_value = sample_job
from backend.api.routes.jobs import get_instrumental_analysis
import asyncio
result = asyncio.get_event_loop().run_until_complete(
get_instrumental_analysis("test-job-123")
)
assert "audio_urls" in result
assert "clean_instrumental" in result["audio_urls"]
assert "backing_vocals" in result["audio_urls"]
assert "with_backing" in result["audio_urls"]
def test_get_analysis_includes_waveform_url(self, mock_job_manager, sample_job):
"""GET /instrumental-analysis should include waveform URL."""
mock_job_manager.get_job.return_value = sample_job
# Need to mock StorageService at module level for the signed URL
with patch('backend.api.routes.jobs.StorageService') as mock_storage_cls:
mock_storage = MagicMock()
mock_storage.generate_signed_url.return_value = "https://storage.googleapis.com/signed-url"
mock_storage_cls.return_value = mock_storage
from backend.api.routes.jobs import get_instrumental_analysis
import asyncio
result = asyncio.get_event_loop().run_until_complete(
get_instrumental_analysis("test-job-123")
)
assert "waveform_url" in result
# Waveform URL should be generated from the file_urls
assert result["waveform_url"] == "https://storage.googleapis.com/signed-url"
def test_get_analysis_silent_audio(self, mock_job_manager, mock_storage_service, silent_job):
"""GET /instrumental-analysis should correctly report silent audio."""
mock_job_manager.get_job.return_value = silent_job
from backend.api.routes.jobs import get_instrumental_analysis
import asyncio
result = asyncio.get_event_loop().run_until_complete(
get_instrumental_analysis("test-job-silent")
)
assert result["analysis"]["has_audible_content"] is False
assert result["analysis"]["recommended_selection"] == "clean"
assert len(result["analysis"]["audible_segments"]) == 0
def test_get_analysis_job_not_found(self, mock_job_manager):
"""GET /instrumental-analysis should return 404 for non-existent job."""
mock_job_manager.get_job.return_value = None
from backend.api.routes.jobs import get_instrumental_analysis
from fastapi import HTTPException
import asyncio
with pytest.raises(HTTPException) as exc_info:
asyncio.get_event_loop().run_until_complete(
get_instrumental_analysis("non-existent")
)
assert exc_info.value.status_code == 404
def test_get_analysis_wrong_status(self, mock_job_manager, sample_job):
"""GET /instrumental-analysis should return 400 for wrong job status."""
sample_job.status = JobStatus.PENDING
mock_job_manager.get_job.return_value = sample_job
from backend.api.routes.jobs import get_instrumental_analysis
from fastapi import HTTPException
import asyncio
with pytest.raises(HTTPException) as exc_info:
asyncio.get_event_loop().run_until_complete(
get_instrumental_analysis("test-job-123")
)
assert exc_info.value.status_code == 400
class TestAudioStream:
"""Tests for GET /api/jobs/{job_id}/audio-stream/{stem_type}."""
def test_stream_backing_vocals_valid(self, mock_job_manager, sample_job):
"""Should return redirect for backing vocals stream."""
mock_job_manager.get_job.return_value = sample_job
from backend.api.routes.jobs import stream_audio
import asyncio
# This will try to stream from GCS which we can't test easily
# Instead, verify the function exists and has correct signature
assert callable(stream_audio)
def test_stream_invalid_stem_type(self, mock_job_manager, sample_job):
"""Should return 400 for invalid stem type."""
mock_job_manager.get_job.return_value = sample_job
from backend.api.routes.jobs import stream_audio
from fastapi import HTTPException
import asyncio
with pytest.raises(HTTPException) as exc_info:
asyncio.get_event_loop().run_until_complete(
stream_audio("test-job-123", "invalid_stem")
)
assert exc_info.value.status_code == 400
def test_stream_job_not_found(self, mock_job_manager):
"""Should return 404 for non-existent job."""
mock_job_manager.get_job.return_value = None
from backend.api.routes.jobs import stream_audio
from fastapi import HTTPException
import asyncio
with pytest.raises(HTTPException) as exc_info:
asyncio.get_event_loop().run_until_complete(
stream_audio("non-existent", "backing_vocals")
)
assert exc_info.value.status_code == 404
class TestCreateCustomInstrumental:
"""Tests for POST /api/jobs/{job_id}/create-custom-instrumental."""
@pytest.fixture
def mock_audio_editing_service(self):
"""Mock the audio editing service."""
with patch('backend.api.routes.jobs.AudioEditingService') as mock:
mock_instance = MagicMock()
mock_instance.create_custom_instrumental.return_value = MagicMock(
output_path="jobs/test/stems/custom_instrumental.flac",
mute_regions_applied=[
MagicMock(start_seconds=10.0, end_seconds=20.0),
],
total_muted_duration_seconds=10.0,
output_duration_seconds=180.0,
)
mock.return_value = mock_instance
yield mock_instance
def test_create_custom_validates_mute_regions(self):
"""Should validate mute regions at model level."""
from backend.models.requests import CreateCustomInstrumentalRequest, MuteRegionRequest
from pydantic import ValidationError
# Empty mute regions should fail at model validation
with pytest.raises(ValidationError) as exc_info:
CreateCustomInstrumentalRequest(mute_regions=[])
assert "At least one mute region is required" in str(exc_info.value)
def test_create_custom_job_not_found(self, mock_job_manager):
"""Should return 404 for non-existent job."""
mock_job_manager.get_job.return_value = None
from backend.api.routes.jobs import create_custom_instrumental
from backend.models.requests import CreateCustomInstrumentalRequest, MuteRegionRequest
from fastapi import HTTPException
import asyncio
request = CreateCustomInstrumentalRequest(
mute_regions=[MuteRegionRequest(start_seconds=10.0, end_seconds=20.0)]
)
with pytest.raises(HTTPException) as exc_info:
asyncio.get_event_loop().run_until_complete(
create_custom_instrumental("non-existent", request)
)
assert exc_info.value.status_code == 404
def test_create_custom_wrong_status(self, mock_job_manager, sample_job):
"""Should return 400 for wrong job status."""
sample_job.status = JobStatus.PENDING
mock_job_manager.get_job.return_value = sample_job
from backend.api.routes.jobs import create_custom_instrumental
from backend.models.requests import CreateCustomInstrumentalRequest, MuteRegionRequest
from fastapi import HTTPException
import asyncio
request = CreateCustomInstrumentalRequest(
mute_regions=[MuteRegionRequest(start_seconds=10.0, end_seconds=20.0)]
)
with pytest.raises(HTTPException) as exc_info:
asyncio.get_event_loop().run_until_complete(
create_custom_instrumental("test-job-123", request)
)
assert exc_info.value.status_code == 400
class TestGetWaveformData:
"""Tests for GET /api/jobs/{job_id}/waveform-data."""
def test_get_waveform_data_job_not_found(self, mock_job_manager):
"""Should return 404 for non-existent job."""
mock_job_manager.get_job.return_value = None
from backend.api.routes.jobs import get_waveform_data
from fastapi import HTTPException
import asyncio
with pytest.raises(HTTPException) as exc_info:
asyncio.get_event_loop().run_until_complete(
get_waveform_data("non-existent")
)
assert exc_info.value.status_code == 404
def test_get_waveform_data_wrong_status(self, mock_job_manager, sample_job):
"""Should return 400 for wrong job status."""
sample_job.status = JobStatus.PENDING
mock_job_manager.get_job.return_value = sample_job
from backend.api.routes.jobs import get_waveform_data
from fastapi import HTTPException
import asyncio
with pytest.raises(HTTPException) as exc_info:
asyncio.get_event_loop().run_until_complete(
get_waveform_data("test-job-123")
)
assert exc_info.value.status_code == 400
def test_waveform_data_endpoint_exists(self):
"""Verify the endpoint function exists and is callable."""
from backend.api.routes.jobs import get_waveform_data
assert callable(get_waveform_data)
# Verify it's an async function
import inspect
assert inspect.iscoroutinefunction(get_waveform_data)
class TestRequestModels:
"""Tests for API request models."""
def test_mute_region_request_valid(self):
"""MuteRegionRequest should accept valid values."""
from backend.models.requests import MuteRegionRequest
region = MuteRegionRequest(start_seconds=10.0, end_seconds=20.0)
assert region.start_seconds == 10.0
assert region.end_seconds == 20.0
def test_mute_region_request_invalid_start(self):
"""MuteRegionRequest should reject negative start."""
from backend.models.requests import MuteRegionRequest
from pydantic import ValidationError
with pytest.raises(ValidationError):
MuteRegionRequest(start_seconds=-1.0, end_seconds=20.0)
def test_mute_region_request_invalid_order(self):
"""MuteRegionRequest should reject end before start."""
from backend.models.requests import MuteRegionRequest
from pydantic import ValidationError
with pytest.raises(ValidationError):
MuteRegionRequest(start_seconds=20.0, end_seconds=10.0)
def test_create_custom_instrumental_request_valid(self):
"""CreateCustomInstrumentalRequest should accept valid mute regions."""
from backend.models.requests import (
CreateCustomInstrumentalRequest,
MuteRegionRequest,
)
request = CreateCustomInstrumentalRequest(
mute_regions=[
MuteRegionRequest(start_seconds=10.0, end_seconds=20.0),
MuteRegionRequest(start_seconds=60.0, end_seconds=80.0),
]
)
assert len(request.mute_regions) == 2
class TestInstrumentalSelectionExtension:
"""Tests for extended instrumental selection (including 'custom')."""
def test_instrumental_selection_accepts_custom(self):
"""InstrumentalSelection should accept 'custom' as valid selection."""
from backend.models.requests import InstrumentalSelection
selection = InstrumentalSelection(selection="custom")
assert selection.selection == "custom"
def test_instrumental_selection_accepts_clean(self):
"""InstrumentalSelection should accept 'clean' as valid selection."""
from backend.models.requests import InstrumentalSelection
selection = InstrumentalSelection(selection="clean")
assert selection.selection == "clean"
def test_instrumental_selection_accepts_with_backing(self):
"""InstrumentalSelection should accept 'with_backing' as valid selection."""
from backend.models.requests import InstrumentalSelection
selection = InstrumentalSelection(selection="with_backing")
assert selection.selection == "with_backing"
def test_instrumental_selection_rejects_invalid(self):
"""InstrumentalSelection should reject invalid values."""
from backend.models.requests import InstrumentalSelection
from pydantic import ValidationError
with pytest.raises(ValidationError):
InstrumentalSelection(selection="invalid_option")
-343
View File
@@ -1,343 +0,0 @@
"""
Unit tests for internal.py API routes using FastAPI TestClient.
Internal routes are used for worker communication within Cloud Run.
These endpoints require admin authentication.
With Cloud Tasks integration, these endpoints include idempotency checks
to prevent duplicate processing on retries.
"""
import os
import pytest
from datetime import datetime, UTC
from unittest.mock import MagicMock, AsyncMock, patch
from fastapi.testclient import TestClient
from backend.models.job import Job, JobStatus
# Set test admin token for auth
os.environ.setdefault('ADMIN_TOKENS', 'test-admin-token')
def _create_mock_job(job_id: str = "test123") -> Job:
"""Create a mock Job object for testing."""
return Job(
job_id=job_id,
status=JobStatus.PROCESSING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
state_data={}, # Empty state_data - no worker progress yet
)
@pytest.fixture
def client():
"""Create TestClient with mocked workers and job manager."""
mock_creds = MagicMock()
mock_creds.universe_domain = 'googleapis.com'
# Mock the worker functions at the internal routes module level
mock_audio = AsyncMock()
mock_lyrics = AsyncMock()
mock_screens = AsyncMock()
mock_video = AsyncMock()
mock_render = AsyncMock()
# Mock JobManager for idempotency checks
mock_job_manager = MagicMock()
mock_job_manager.get_job.return_value = _create_mock_job()
mock_job_manager.update_state_data.return_value = None
with patch('backend.api.routes.internal.process_audio_separation', mock_audio), \
patch('backend.api.routes.internal.process_lyrics_transcription', mock_lyrics), \
patch('backend.api.routes.internal.generate_screens', mock_screens), \
patch('backend.api.routes.internal.generate_video', mock_video), \
patch('backend.api.routes.internal.process_render_video', mock_render), \
patch('backend.api.routes.internal.JobManager', return_value=mock_job_manager), \
patch('backend.services.firestore_service.firestore'), \
patch('backend.services.storage_service.storage'), \
patch('google.auth.default', return_value=(mock_creds, 'test-project')):
from backend.main import app
yield TestClient(app)
@pytest.fixture
def auth_headers():
"""Auth headers for internal API testing."""
return {"Authorization": "Bearer test-admin-token"}
class TestAudioWorkerEndpoint:
"""Tests for POST /api/internal/workers/audio."""
def test_audio_worker_returns_200(self, client, auth_headers):
"""Test audio worker endpoint returns 200 with auth."""
response = client.post(
"/api/internal/workers/audio",
headers=auth_headers,
json={"job_id": "test123"}
)
assert response.status_code == 200
def test_audio_worker_accepts_job_id(self, client, auth_headers):
"""Test audio worker accepts job_id in body."""
response = client.post(
"/api/internal/workers/audio",
headers=auth_headers,
json={"job_id": "any-job-id"}
)
assert response.status_code == 200
def test_audio_worker_requires_job_id(self, client, auth_headers):
"""Test audio worker requires job_id."""
response = client.post(
"/api/internal/workers/audio",
headers=auth_headers,
json={}
)
assert response.status_code == 422
def test_audio_worker_requires_auth(self, client):
"""Test audio worker requires authentication."""
response = client.post(
"/api/internal/workers/audio",
json={"job_id": "test123"}
)
assert response.status_code == 401
class TestLyricsWorkerEndpoint:
"""Tests for POST /api/internal/workers/lyrics."""
def test_lyrics_worker_returns_200(self, client, auth_headers):
"""Test lyrics worker endpoint returns 200 with auth."""
response = client.post(
"/api/internal/workers/lyrics",
headers=auth_headers,
json={"job_id": "test123"}
)
assert response.status_code == 200
def test_lyrics_worker_requires_job_id(self, client, auth_headers):
"""Test lyrics worker requires job_id."""
response = client.post(
"/api/internal/workers/lyrics",
headers=auth_headers,
json={}
)
assert response.status_code == 422
def test_lyrics_worker_requires_auth(self, client):
"""Test lyrics worker requires authentication."""
response = client.post(
"/api/internal/workers/lyrics",
json={"job_id": "test123"}
)
assert response.status_code == 401
class TestScreensWorkerEndpoint:
"""Tests for POST /api/internal/workers/screens."""
def test_screens_worker_returns_200(self, client, auth_headers):
"""Test screens worker endpoint returns 200 with auth."""
response = client.post(
"/api/internal/workers/screens",
headers=auth_headers,
json={"job_id": "test123"}
)
assert response.status_code == 200
def test_screens_worker_requires_job_id(self, client, auth_headers):
"""Test screens worker requires job_id."""
response = client.post(
"/api/internal/workers/screens",
headers=auth_headers,
json={}
)
assert response.status_code == 422
def test_screens_worker_requires_auth(self, client):
"""Test screens worker requires authentication."""
response = client.post(
"/api/internal/workers/screens",
json={"job_id": "test123"}
)
assert response.status_code == 401
class TestVideoWorkerEndpoint:
"""Tests for POST /api/internal/workers/video."""
def test_video_worker_returns_200(self, client, auth_headers):
"""Test video worker endpoint returns 200 with auth."""
response = client.post(
"/api/internal/workers/video",
headers=auth_headers,
json={"job_id": "test123"}
)
assert response.status_code == 200
def test_video_worker_requires_job_id(self, client, auth_headers):
"""Test video worker requires job_id."""
response = client.post(
"/api/internal/workers/video",
headers=auth_headers,
json={}
)
assert response.status_code == 422
def test_video_worker_requires_auth(self, client):
"""Test video worker requires authentication."""
response = client.post(
"/api/internal/workers/video",
json={"job_id": "test123"}
)
assert response.status_code == 401
class TestRenderVideoWorkerEndpoint:
"""Tests for POST /api/internal/workers/render-video."""
def test_render_video_worker_returns_200(self, client, auth_headers):
"""Test render-video worker endpoint returns 200 with auth."""
response = client.post(
"/api/internal/workers/render-video",
headers=auth_headers,
json={"job_id": "test123"}
)
assert response.status_code == 200
def test_render_video_worker_requires_job_id(self, client, auth_headers):
"""Test render-video worker requires job_id."""
response = client.post(
"/api/internal/workers/render-video",
headers=auth_headers,
json={}
)
assert response.status_code == 422
def test_render_video_worker_requires_auth(self, client):
"""Test render-video worker requires authentication."""
response = client.post(
"/api/internal/workers/render-video",
json={"job_id": "test123"}
)
assert response.status_code == 401
class TestWorkerResponseFormat:
"""Tests for worker response format."""
def test_audio_worker_response_contains_status(self, client, auth_headers):
"""Test audio worker response contains status."""
response = client.post(
"/api/internal/workers/audio",
headers=auth_headers,
json={"job_id": "test123"}
)
data = response.json()
assert "status" in data or "message" in data
def test_lyrics_worker_response_contains_status(self, client, auth_headers):
"""Test lyrics worker response contains status."""
response = client.post(
"/api/internal/workers/lyrics",
headers=auth_headers,
json={"job_id": "test123"}
)
data = response.json()
assert "status" in data or "message" in data
class TestWorkerIdempotency:
"""Tests for worker idempotency checks (Cloud Tasks retry support)."""
def test_audio_worker_returns_already_running_when_in_progress(self, auth_headers):
"""Test audio worker returns already_running if worker is already running."""
mock_creds = MagicMock()
mock_creds.universe_domain = 'googleapis.com'
# Create job with audio already running
mock_job = _create_mock_job()
mock_job.state_data = {'audio_progress': {'stage': 'running'}}
mock_job_manager = MagicMock()
mock_job_manager.get_job.return_value = mock_job
with patch('backend.api.routes.internal.process_audio_separation', AsyncMock()), \
patch('backend.api.routes.internal.JobManager', return_value=mock_job_manager), \
patch('backend.services.firestore_service.firestore'), \
patch('backend.services.storage_service.storage'), \
patch('google.auth.default', return_value=(mock_creds, 'test-project')):
from backend.main import app
client = TestClient(app)
response = client.post(
"/api/internal/workers/audio",
headers=auth_headers,
json={"job_id": "test123"}
)
assert response.status_code == 200
data = response.json()
assert data["status"] == "already_running"
def test_audio_worker_returns_already_complete_when_finished(self, auth_headers):
"""Test audio worker returns already_complete if worker already finished."""
mock_creds = MagicMock()
mock_creds.universe_domain = 'googleapis.com'
# Create job with audio already complete
mock_job = _create_mock_job()
mock_job.state_data = {'audio_progress': {'stage': 'complete'}}
mock_job_manager = MagicMock()
mock_job_manager.get_job.return_value = mock_job
with patch('backend.api.routes.internal.process_audio_separation', AsyncMock()), \
patch('backend.api.routes.internal.JobManager', return_value=mock_job_manager), \
patch('backend.services.firestore_service.firestore'), \
patch('backend.services.storage_service.storage'), \
patch('google.auth.default', return_value=(mock_creds, 'test-project')):
from backend.main import app
client = TestClient(app)
response = client.post(
"/api/internal/workers/audio",
headers=auth_headers,
json={"job_id": "test123"}
)
assert response.status_code == 200
data = response.json()
assert data["status"] == "already_complete"
def test_audio_worker_returns_not_found_when_job_missing(self, auth_headers):
"""Test audio worker returns not_found if job doesn't exist."""
mock_creds = MagicMock()
mock_creds.universe_domain = 'googleapis.com'
# Return None for job not found
mock_job_manager = MagicMock()
mock_job_manager.get_job.return_value = None
with patch('backend.api.routes.internal.process_audio_separation', AsyncMock()), \
patch('backend.api.routes.internal.JobManager', return_value=mock_job_manager), \
patch('backend.services.firestore_service.firestore'), \
patch('backend.services.storage_service.storage'), \
patch('google.auth.default', return_value=(mock_creds, 'test-project')):
from backend.main import app
client = TestClient(app)
response = client.post(
"/api/internal/workers/audio",
headers=auth_headers,
json={"job_id": "nonexistent"}
)
assert response.status_code == 200
data = response.json()
assert data["status"] == "not_found"
-308
View File
@@ -1,308 +0,0 @@
"""
Unit tests for Job Manager service.
Tests the job lifecycle management without requiring actual Firestore connection.
Uses mocking to isolate the business logic.
"""
import pytest
from unittest.mock import Mock, MagicMock, patch
from datetime import datetime, UTC
# Mock Firestore before importing JobManager
import sys
sys.modules['google.cloud.firestore'] = MagicMock()
from backend.services.job_manager import JobManager
from backend.models.job import Job, JobCreate, JobStatus
@pytest.fixture
def mock_firestore_service():
"""Mock FirestoreService."""
with patch('backend.services.job_manager.FirestoreService') as mock:
service = Mock()
mock.return_value = service
yield service
@pytest.fixture
def job_manager(mock_firestore_service):
"""Create JobManager with mocked dependencies."""
return JobManager()
class TestJobCreation:
"""Test job creation logic."""
def test_create_job_with_url(self, job_manager, mock_firestore_service):
"""Test creating a job with YouTube URL."""
job_create = JobCreate(
url="https://youtube.com/watch?v=test",
artist="Test Artist",
title="Test Song"
)
# The actual create_job method creates the job and returns it
job = job_manager.create_job(job_create)
assert job.job_id is not None
assert job.status == JobStatus.PENDING
assert job.url == "https://youtube.com/watch?v=test"
assert job.artist == "Test Artist"
assert job.title == "Test Song"
assert job.progress == 0
# Verify Firestore was called
mock_firestore_service.create_job.assert_called_once()
def test_create_job_without_url(self, job_manager, mock_firestore_service):
"""Test creating a job without URL (for file upload)."""
job_create = JobCreate(
artist="Test Artist",
title="Test Song"
)
job = job_manager.create_job(job_create)
assert job.artist == "Test Artist"
assert job.title == "Test Song"
assert job.url is None
def test_create_job_generates_unique_id(self, job_manager, mock_firestore_service):
"""Test that each job gets a unique ID."""
job_create = JobCreate()
# Create multiple jobs
ids = []
for i in range(5):
mock_firestore_service.create_job.return_value = Job(
job_id=f"test{i}",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC)
)
job = job_manager.create_job(job_create)
ids.append(job.job_id)
# All IDs should be unique
assert len(ids) == len(set(ids))
def test_create_job_sets_initial_status(self, job_manager, mock_firestore_service):
"""Test that new jobs start with PENDING status."""
job_create = JobCreate()
mock_firestore_service.create_job.return_value = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC)
)
job = job_manager.create_job(job_create)
assert job.status == JobStatus.PENDING
assert job.progress == 0
class TestJobRetrieval:
"""Test job retrieval logic."""
def test_get_existing_job(self, job_manager, mock_firestore_service):
"""Test retrieving an existing job."""
expected_job = Job(
job_id="test123",
status=JobStatus.SEPARATING_STAGE1,
progress=25,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC)
)
mock_firestore_service.get_job.return_value = expected_job
job = job_manager.get_job("test123")
assert job.job_id == "test123"
assert job.status == JobStatus.SEPARATING_STAGE1
assert job.progress == 25
mock_firestore_service.get_job.assert_called_once_with("test123")
def test_get_nonexistent_job(self, job_manager, mock_firestore_service):
"""Test retrieving a nonexistent job returns None."""
mock_firestore_service.get_job.return_value = None
job = job_manager.get_job("nonexistent")
assert job is None
class TestJobUpdate:
"""Test job update logic."""
def test_update_job_status(self, job_manager, mock_firestore_service):
"""Test updating job status."""
# Setup: job exists
existing_job = Job(
job_id="test123",
status=JobStatus.PENDING,
progress=0,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC)
)
mock_firestore_service.get_job.return_value = existing_job
# Update status
updates = {"status": JobStatus.SEPARATING_STAGE1, "progress": 25}
job_manager.update_job("test123", updates)
# Verify update was called
mock_firestore_service.update_job.assert_called_once()
call_args = mock_firestore_service.update_job.call_args
assert call_args[0][0] == "test123" # job_id
assert "status" in call_args[0][1] # updates dict
def test_update_job_multiple_fields(self, job_manager, mock_firestore_service):
"""Test updating multiple fields at once."""
existing_job = Job(
job_id="test123",
status=JobStatus.PENDING,
progress=0,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
timeline=[]
)
mock_firestore_service.get_job.return_value = existing_job
updates = {"status": JobStatus.SEPARATING_STAGE1, "progress": 25}
job_manager.update_job("test123", updates)
# Verify update was called
call_args = mock_firestore_service.update_job.call_args
updates_dict = call_args[0][1]
assert "status" in updates_dict
assert "progress" in updates_dict
def test_update_input_media_gcs_path(self, job_manager, mock_firestore_service):
"""Test updating input_media_gcs_path field."""
existing_job = Job(
job_id="test123",
status=JobStatus.PENDING,
progress=0,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC)
)
mock_firestore_service.get_job.return_value = existing_job
updates = {"input_media_gcs_path": "uploads/test123/file.flac"}
job_manager.update_job("test123", updates)
# Verify update was called with input_media_gcs_path
call_args = mock_firestore_service.update_job.call_args
updates_dict = call_args[0][1]
assert "input_media_gcs_path" in updates_dict
assert updates_dict["input_media_gcs_path"] == "uploads/test123/file.flac"
class TestJobStatusTransitions:
"""Test valid job status transitions."""
def test_pending_to_downloading(self, job_manager, mock_firestore_service):
"""Test transition from PENDING to DOWNLOADING."""
existing_job = Job(
job_id="test123",
status=JobStatus.PENDING,
progress=0,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC)
)
mock_firestore_service.get_job.return_value = existing_job
job_manager.update_job("test123", {"status": JobStatus.DOWNLOADING})
# Should succeed (valid transition)
mock_firestore_service.update_job.assert_called_once()
def test_downloading_to_separating(self, job_manager, mock_firestore_service):
"""Test transition from DOWNLOADING to SEPARATING_STAGE1."""
existing_job = Job(
job_id="test123",
status=JobStatus.DOWNLOADING,
progress=0,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC)
)
mock_firestore_service.get_job.return_value = existing_job
job_manager.update_job("test123", {"status": JobStatus.SEPARATING_STAGE1})
mock_firestore_service.update_job.assert_called_once()
class TestJobFailure:
"""Test job failure handling."""
def test_mark_job_as_failed(self, job_manager, mock_firestore_service):
"""Test marking a job as failed."""
error_message = "Audio separation failed"
job_manager.mark_job_failed("test123", error_message)
# mark_job_failed calls firestore.update_job_status
mock_firestore_service.update_job_status.assert_called_once()
call_args = mock_firestore_service.update_job_status.call_args
assert call_args[1]['job_id'] == "test123"
assert call_args[1]['status'] == JobStatus.FAILED
assert 'error_message' in call_args[1]
def test_mark_job_error(self, job_manager, mock_firestore_service):
"""Test marking a job with an error."""
error_message = "Test error"
job_manager.mark_job_error("test123", error_message)
# mark_job_error calls firestore.update_job_status
mock_firestore_service.update_job_status.assert_called_once()
call_args = mock_firestore_service.update_job_status.call_args
assert call_args[1]['job_id'] == "test123"
assert call_args[1]['error_message'] == error_message
class TestJobDeletion:
"""Test job deletion logic."""
def test_delete_job(self, job_manager, mock_firestore_service):
"""Test deleting a job."""
existing_job = Job(
job_id="test123",
status=JobStatus.COMPLETE,
progress=100,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
output_files={} # Empty dict so iteration works
)
mock_firestore_service.get_job.return_value = existing_job
job_manager.delete_job("test123")
# Verify delete was called
mock_firestore_service.delete_job.assert_called_once_with("test123")
def test_delete_job_with_files(self, job_manager, mock_firestore_service):
"""Test deleting a job and its files."""
existing_job = Job(
job_id="test123",
status=JobStatus.COMPLETE,
progress=100,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
output_files={} # Empty dict so iteration works
)
mock_firestore_service.get_job.return_value = existing_job
job_manager.delete_job("test123", delete_files=True)
# Verify delete was called
mock_firestore_service.delete_job.assert_called_once_with("test123")
if __name__ == "__main__":
pytest.main([__file__, "-v"])
-252
View File
@@ -1,252 +0,0 @@
"""
Unit tests for jobs.py API routes using FastAPI TestClient.
These tests mock the underlying services and test the route logic directly.
"""
import pytest
from datetime import datetime, UTC
from unittest.mock import MagicMock, AsyncMock, patch
from fastapi.testclient import TestClient
from backend.models.job import Job, JobStatus
@pytest.fixture
def mock_job():
"""Create a standard mock job for testing."""
return Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
artist="Test Artist",
title="Test Song"
)
@pytest.fixture
def mock_job_manager(mock_job):
"""Create a mock JobManager with common methods."""
manager = MagicMock()
manager.get_job.return_value = mock_job
manager.list_jobs.return_value = [mock_job]
manager.create_job.return_value = mock_job
manager.delete_job.return_value = True
manager.cancel_job.return_value = mock_job
manager.update_job_status.return_value = None
manager.update_state_data.return_value = None
return manager
@pytest.fixture
def mock_worker_service():
"""Create a mock WorkerService."""
service = MagicMock()
service.trigger_audio_worker = AsyncMock(return_value=True)
service.trigger_lyrics_worker = AsyncMock(return_value=True)
service.trigger_screens_worker = AsyncMock(return_value=True)
service.trigger_video_worker = AsyncMock(return_value=True)
return service
@pytest.fixture
def client(mock_job_manager, mock_worker_service):
"""Create TestClient with mocked dependencies."""
mock_creds = MagicMock()
mock_creds.universe_domain = 'googleapis.com'
# Patch at the module level where jobs.py imports them
with patch('backend.api.routes.jobs.job_manager', mock_job_manager), \
patch('backend.api.routes.jobs.worker_service', mock_worker_service), \
patch('backend.services.firestore_service.firestore'), \
patch('backend.services.storage_service.storage'), \
patch('google.auth.default', return_value=(mock_creds, 'test-project')):
from backend.main import app
yield TestClient(app)
class TestGetJob:
"""Tests for GET /api/jobs/{job_id}."""
def test_get_job_returns_200(self, client, mock_job_manager, mock_job):
"""Test getting an existing job returns 200."""
response = client.get("/api/jobs/test123")
assert response.status_code == 200
def test_get_job_returns_job_data(self, client, mock_job_manager, mock_job):
"""Test response contains job data."""
response = client.get("/api/jobs/test123")
data = response.json()
assert data["job_id"] == "test123"
assert data["status"] == "pending"
assert data["artist"] == "Test Artist"
def test_get_nonexistent_job_returns_404(self, mock_worker_service):
"""Test getting non-existent job returns 404."""
mock_job_manager = MagicMock()
mock_job_manager.get_job.return_value = None
mock_creds = MagicMock()
mock_creds.universe_domain = 'googleapis.com'
with patch('backend.api.routes.jobs.job_manager', mock_job_manager), \
patch('backend.api.routes.jobs.worker_service', mock_worker_service), \
patch('backend.services.firestore_service.firestore'), \
patch('backend.services.storage_service.storage'), \
patch('google.auth.default', return_value=(mock_creds, 'test-project')):
from backend.main import app
client = TestClient(app)
response = client.get("/api/jobs/nonexistent")
assert response.status_code == 404
class TestListJobs:
"""Tests for GET /api/jobs."""
def test_list_jobs_returns_200(self, client):
"""Test listing jobs returns 200."""
response = client.get("/api/jobs")
assert response.status_code == 200
def test_list_jobs_returns_array(self, client, mock_job_manager):
"""Test response is an array of jobs."""
response = client.get("/api/jobs")
data = response.json()
assert isinstance(data, list)
assert len(data) == 1
assert data[0]["job_id"] == "test123"
def test_list_jobs_with_status_filter(self, client, mock_job_manager):
"""Test listing jobs with status filter."""
response = client.get("/api/jobs?status=pending")
assert response.status_code == 200
def test_list_jobs_with_limit(self, client, mock_job_manager):
"""Test listing jobs with limit."""
response = client.get("/api/jobs?limit=10")
assert response.status_code == 200
class TestCreateJob:
"""Tests for POST /api/jobs."""
def test_create_job_with_url_returns_200(self, client, mock_job_manager):
"""Test creating job with URL returns 200."""
response = client.post(
"/api/jobs",
json={"url": "https://youtube.com/watch?v=test123"}
)
assert response.status_code == 200
def test_create_job_returns_job_id(self, client, mock_job_manager):
"""Test create response contains job_id."""
response = client.post(
"/api/jobs",
json={"url": "https://youtube.com/watch?v=test"}
)
data = response.json()
assert "job_id" in data
def test_create_job_with_artist_title(self, client, mock_job_manager):
"""Test creating job with artist and title."""
response = client.post(
"/api/jobs",
json={
"url": "https://youtube.com/watch?v=test",
"artist": "Test Artist",
"title": "Test Song"
}
)
assert response.status_code == 200
class TestDeleteJob:
"""Tests for DELETE /api/jobs/{job_id}."""
def test_delete_job_returns_200(self, client, mock_job_manager):
"""Test deleting job returns 200."""
response = client.delete("/api/jobs/test123")
assert response.status_code == 200
def test_delete_nonexistent_job(self, mock_worker_service):
"""Test deleting non-existent job."""
mock_job_manager = MagicMock()
mock_job_manager.delete_job.return_value = False
mock_creds = MagicMock()
mock_creds.universe_domain = 'googleapis.com'
with patch('backend.api.routes.jobs.job_manager', mock_job_manager), \
patch('backend.api.routes.jobs.worker_service', mock_worker_service), \
patch('backend.services.firestore_service.firestore'), \
patch('backend.services.storage_service.storage'), \
patch('google.auth.default', return_value=(mock_creds, 'test-project')):
from backend.main import app
client = TestClient(app)
response = client.delete("/api/jobs/nonexistent")
# Either 200 or 404 depending on implementation
assert response.status_code in [200, 404]
class TestCancelJob:
"""Tests for POST /api/jobs/{job_id}/cancel."""
def test_cancel_job_returns_200(self, client, mock_job_manager, mock_job):
"""Test cancelling job returns 200."""
mock_job_manager.cancel_job.return_value = mock_job
response = client.post(
"/api/jobs/test123/cancel",
json={}
)
assert response.status_code == 200
class TestSubmitCorrections:
"""Tests for POST /api/jobs/{job_id}/corrections."""
def test_submit_corrections_returns_200(self, client, mock_job_manager, mock_job):
"""Test submitting corrections returns 200."""
# Job needs to be in AWAITING_REVIEW or IN_REVIEW status
review_job = Job(
job_id="test123",
status=JobStatus.IN_REVIEW,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
artist="Test",
title="Test"
)
mock_job_manager.get_job.return_value = review_job
response = client.post(
"/api/jobs/test123/corrections",
json={
"corrections": {
"lines": [],
"metadata": {"source": "test"}
}
}
)
# Should be 200 or validation error
assert response.status_code in [200, 400, 422]
class TestSelectInstrumental:
"""Tests for POST /api/jobs/{job_id}/select-instrumental."""
def test_select_instrumental_requires_selection_field(self, client, mock_job_manager, mock_job):
"""Test instrumental selection requires selection field."""
response = client.post(
"/api/jobs/test123/select-instrumental",
json={} # Missing selection field
)
# Missing field should cause validation error
assert response.status_code == 422
class TestStartReview:
"""Tests for POST /api/jobs/{job_id}/start-review."""
def test_start_review_endpoint_exists(self, client, mock_job_manager, mock_job):
"""Test start review endpoint exists."""
response = client.post("/api/jobs/test123/start-review")
# Should not be 404 or 405
assert response.status_code not in [404, 405]
-87
View File
@@ -1,87 +0,0 @@
"""
Unit tests for backend main.py and config.py.
These tests cover the FastAPI app initialization and configuration.
"""
import pytest
import os
from unittest.mock import MagicMock, patch
class TestConfig:
"""Tests for config.py."""
def test_settings_from_environment(self):
"""Test settings can be loaded from environment variables."""
with patch.dict(os.environ, {
'GCS_BUCKET_NAME': 'test-bucket',
'FIRESTORE_COLLECTION': 'test-jobs',
'ADMIN_TOKENS': 'token1,token2',
'ENVIRONMENT': 'testing'
}):
from backend.config import Settings
settings = Settings()
assert settings.gcs_bucket_name == 'test-bucket'
assert settings.firestore_collection == 'test-jobs'
# admin_tokens is a string, comma-separated
assert 'token1' in settings.admin_tokens
assert 'token2' in settings.admin_tokens
def test_admin_tokens_is_comma_separated_string(self):
"""Test admin tokens stored as comma-separated string."""
with patch.dict(os.environ, {
'ADMIN_TOKENS': 'token1,token2,token3'
}):
from backend.config import Settings
settings = Settings()
# admin_tokens is stored as a string
assert settings.admin_tokens == 'token1,token2,token3'
def test_default_environment(self):
"""Test default environment is development."""
with patch.dict(os.environ, {}, clear=True):
from backend.config import Settings
settings = Settings()
# Accept 'test' as well since pytest may set ENVIRONMENT=test
assert settings.environment in ['development', 'production', 'testing', 'test']
class TestMain:
"""Tests for main.py FastAPI app."""
@pytest.fixture
def app(self):
"""Create FastAPI app with mocked services."""
mock_creds = MagicMock()
mock_creds.universe_domain = 'googleapis.com'
with patch('backend.services.firestore_service.firestore'), \
patch('backend.services.storage_service.storage'), \
patch('google.auth.default', return_value=(mock_creds, 'test-project')):
from backend.main import app
return app
def test_app_has_api_routes(self, app):
"""Test app includes API routes."""
routes = [route.path for route in app.routes]
assert any('/api' in route or '/jobs' in route for route in routes)
def test_app_has_cors_middleware(self, app):
"""Test app has CORS middleware configured."""
# Check that middleware is configured (not necessarily CORS specific)
assert len(app.user_middleware) >= 0 # App initializes middleware
def test_app_title(self, app):
"""Test app has expected title."""
assert 'karaoke' in app.title.lower() or app.title
class TestDependencies:
"""Tests for dependencies.py."""
def test_dependencies_module_imports(self):
"""Test dependencies module can be imported and has auth functions."""
from backend.api import dependencies
assert hasattr(dependencies, 'require_auth')
assert hasattr(dependencies, 'require_admin')
assert hasattr(dependencies, 'optional_auth')
-918
View File
@@ -1,918 +0,0 @@
"""
Unit tests for Pydantic models.
Tests validate that our data models work correctly, including:
- Basic field validation
- Nested dictionary structures (file_urls, state_data)
- Serialization/deserialization round-trips (simulating Firestore)
- Real-world data structures from workers
These tests catch type mismatches that would cause runtime errors when
reading data back from Firestore.
"""
import pytest
import json
from datetime import datetime, UTC
from pydantic import ValidationError
from backend.models.job import (
Job, JobCreate, JobStatus, TimelineEvent
)
class TestJobModel:
"""Test Job Pydantic model - the bug we just fixed!"""
def test_input_media_gcs_path_field_exists(self):
"""
Test that Job model has input_media_gcs_path field.
This test would have caught the bug where we tried to use
job.input_media_gcs_path but it wasn't defined in the model!
"""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
input_media_gcs_path="uploads/test123/file.flac"
)
# This should NOT raise AttributeError
assert hasattr(job, 'input_media_gcs_path')
assert job.input_media_gcs_path == "uploads/test123/file.flac"
def test_input_media_gcs_path_optional(self):
"""Test that input_media_gcs_path is optional."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC)
)
assert job.input_media_gcs_path is None
def test_pydantic_includes_input_media_gcs_path_in_dict(self):
"""
Test that Pydantic includes input_media_gcs_path in serialization.
This ensures Pydantic doesn't silently ignore the field.
"""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
input_media_gcs_path="uploads/test123/file.flac"
)
job_dict = job.model_dump()
# Pydantic should include it
assert "input_media_gcs_path" in job_dict
assert job_dict["input_media_gcs_path"] == "uploads/test123/file.flac"
def test_create_minimal_job(self):
"""Test creating a job with minimal required fields."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC)
)
assert job.job_id == "test123"
assert job.status == JobStatus.PENDING
assert job.progress == 0
assert job.url is None
assert job.input_media_gcs_path is None
def test_create_job_with_url(self):
"""Test creating a job with YouTube URL."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
url="https://youtube.com/watch?v=test",
artist="Test Artist",
title="Test Song"
)
assert job.url == "https://youtube.com/watch?v=test"
assert job.artist == "Test Artist"
assert job.title == "Test Song"
def test_create_job_with_uploaded_file(self):
"""Test creating a job with uploaded file."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
input_media_gcs_path="uploads/test123/file.flac",
artist="Test Artist",
title="Test Song"
)
assert job.input_media_gcs_path == "uploads/test123/file.flac"
assert job.url is None
class TestJobCreate:
"""Test JobCreate validation model."""
def test_create_with_url(self):
"""Test creating job with YouTube URL."""
job_create = JobCreate(
url="https://youtube.com/watch?v=test",
artist="Test Artist",
title="Test Song"
)
assert job_create.url == "https://youtube.com/watch?v=test"
assert job_create.artist == "Test Artist"
assert job_create.title == "Test Song"
def test_create_minimal(self):
"""Test creating job with minimal fields."""
job_create = JobCreate()
assert job_create.url is None
assert job_create.artist is None
assert job_create.title is None
class TestJobStatus:
"""Test JobStatus enum."""
def test_critical_statuses_defined(self):
"""Test that critical statuses exist."""
critical_statuses = [
"pending", "downloading",
"separating_stage1", "separating_stage2", "audio_complete",
"transcribing", "correcting", "lyrics_complete",
"generating_screens", "applying_padding",
"awaiting_review", "in_review", "review_complete",
"awaiting_instrumental_selection", "instrumental_selected",
"generating_video", "encoding", "packaging",
"complete", "failed"
]
actual_statuses = [status.value for status in JobStatus]
for status in critical_statuses:
assert status in actual_statuses, f"Missing critical status: {status}"
class TestTimelineEvent:
"""Test TimelineEvent model."""
def test_create_timeline_event(self):
"""Test creating a timeline event."""
event = TimelineEvent(
status="pending",
timestamp="2025-12-01T08:00:00Z",
progress=0,
message="Job created"
)
assert event.status == "pending"
assert event.timestamp == "2025-12-01T08:00:00Z"
assert event.progress == 0
assert event.message == "Job created"
def test_timeline_event_optional_fields(self):
"""Test that progress and message are optional."""
event = TimelineEvent(
status="pending",
timestamp="2025-12-01T08:00:00Z"
)
assert event.progress is None
assert event.message is None
class TestModelValidation:
"""Test model validation rules."""
def test_invalid_job_status(self):
"""Test that invalid status is rejected."""
with pytest.raises((ValidationError, ValueError)):
Job(
job_id="test123",
status="invalid_status", # Not a valid JobStatus
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC)
)
def test_missing_required_fields(self):
"""Test that missing required fields are rejected."""
with pytest.raises(ValidationError):
Job(
job_id="test123"
# Missing required fields: status, created_at, updated_at
)
class TestFileUrlsNestedStructure:
"""
Test that file_urls field correctly handles nested dictionaries.
THIS IS THE TEST THAT WOULD HAVE CAUGHT THE Dict[str, str] vs Dict[str, Any] BUG!
Workers store nested structures like:
{
"stems": {"instrumental_clean": "gs://...", "vocals": "gs://..."},
"lyrics": {"corrections": "gs://...", "lrc": "gs://..."},
...
}
If file_urls is typed as Dict[str, str], this will fail on deserialization.
"""
def test_file_urls_with_nested_stems(self):
"""Test that file_urls accepts nested stems dictionary."""
job = Job(
job_id="test123",
status=JobStatus.AUDIO_COMPLETE,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
file_urls={
"stems": {
"instrumental_clean": "gs://bucket/jobs/test123/stems/instrumental_clean.flac",
"instrumental_with_backing": "gs://bucket/jobs/test123/stems/instrumental_with_backing.flac",
"vocals_clean": "gs://bucket/jobs/test123/stems/vocals_clean.flac",
"lead_vocals": "gs://bucket/jobs/test123/stems/lead_vocals.flac",
"backing_vocals": "gs://bucket/jobs/test123/stems/backing_vocals.flac",
"bass": "gs://bucket/jobs/test123/stems/bass.flac",
"drums": "gs://bucket/jobs/test123/stems/drums.flac",
}
}
)
assert job.file_urls["stems"]["instrumental_clean"] == "gs://bucket/jobs/test123/stems/instrumental_clean.flac"
assert len(job.file_urls["stems"]) == 7
def test_file_urls_with_nested_lyrics(self):
"""Test that file_urls accepts nested lyrics dictionary."""
job = Job(
job_id="test123",
status=JobStatus.LYRICS_COMPLETE,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
file_urls={
"lyrics": {
"corrections": "gs://bucket/jobs/test123/lyrics/corrections.json",
"audio": "gs://bucket/jobs/test123/lyrics/audio.flac",
"lrc": "gs://bucket/jobs/test123/lyrics/karaoke.lrc",
"uncorrected": "gs://bucket/jobs/test123/lyrics/uncorrected.txt",
}
}
)
assert job.file_urls["lyrics"]["corrections"] == "gs://bucket/jobs/test123/lyrics/corrections.json"
def test_file_urls_full_worker_structure(self):
"""
Test with the full structure that workers actually create.
This simulates what actually gets stored in Firestore after
all workers have run.
"""
full_file_urls = {
"input": {
"audio": "gs://bucket/jobs/test123/input/waterloo.flac"
},
"stems": {
"instrumental_clean": "gs://bucket/jobs/test123/stems/instrumental_clean.flac",
"instrumental_with_backing": "gs://bucket/jobs/test123/stems/instrumental_with_backing.flac",
"vocals_clean": "gs://bucket/jobs/test123/stems/vocals_clean.flac",
"lead_vocals": "gs://bucket/jobs/test123/stems/lead_vocals.flac",
"backing_vocals": "gs://bucket/jobs/test123/stems/backing_vocals.flac",
},
"lyrics": {
"corrections": "gs://bucket/jobs/test123/lyrics/corrections.json",
"lrc": "gs://bucket/jobs/test123/lyrics/karaoke.lrc",
},
"screens": {
"title": "gs://bucket/jobs/test123/screens/title.mov",
"end": "gs://bucket/jobs/test123/screens/end.mov",
},
"videos": {
"with_vocals": "gs://bucket/jobs/test123/videos/with_vocals.mkv",
},
"finals": {
"lossless_4k_mp4": "gs://bucket/jobs/test123/finals/lossless_4k.mp4",
"lossy_720p_mp4": "gs://bucket/jobs/test123/finals/lossy_720p.mp4",
}
}
job = Job(
job_id="test123",
status=JobStatus.COMPLETE,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
file_urls=full_file_urls
)
# Verify nested access works
assert job.file_urls["stems"]["instrumental_clean"].endswith("instrumental_clean.flac")
assert job.file_urls["lyrics"]["corrections"].endswith("corrections.json")
assert job.file_urls["finals"]["lossy_720p_mp4"].endswith("lossy_720p.mp4")
def test_file_urls_roundtrip_serialization(self):
"""
Test that file_urls survives serialization/deserialization.
This simulates what happens when we:
1. Create a Job with nested file_urls
2. Serialize to dict (for Firestore)
3. Deserialize back to Job (reading from Firestore)
THIS IS THE KEY TEST - it would catch the Dict[str, str] bug!
"""
original_file_urls = {
"stems": {
"instrumental_clean": "gs://bucket/stems/clean.flac",
"vocals": "gs://bucket/stems/vocals.flac",
},
"lyrics": {
"corrections": "gs://bucket/lyrics/corrections.json",
}
}
# Create job
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
file_urls=original_file_urls
)
# Serialize to dict (simulates writing to Firestore)
job_dict = job.model_dump()
# Convert to JSON and back (simulates Firestore storage)
json_str = json.dumps(job_dict, default=str)
restored_dict = json.loads(json_str)
# Deserialize back to Job (simulates reading from Firestore)
restored_job = Job(**restored_dict)
# Verify nested structure survived
assert restored_job.file_urls["stems"]["instrumental_clean"] == "gs://bucket/stems/clean.flac"
assert restored_job.file_urls["stems"]["vocals"] == "gs://bucket/stems/vocals.flac"
assert restored_job.file_urls["lyrics"]["corrections"] == "gs://bucket/lyrics/corrections.json"
class TestStateDataNestedStructure:
"""Test that state_data field correctly handles nested dictionaries."""
def test_state_data_with_instrumental_options(self):
"""Test state_data with instrumental options structure."""
job = Job(
job_id="test123",
status=JobStatus.AWAITING_INSTRUMENTAL_SELECTION,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
state_data={
"instrumental_options": {
"clean": "gs://bucket/jobs/test123/stems/instrumental_clean.flac",
"with_backing": "gs://bucket/jobs/test123/stems/instrumental_with_backing.flac",
},
"audio_complete": True,
"lyrics_complete": True,
}
)
assert job.state_data["instrumental_options"]["clean"].endswith("clean.flac")
assert job.state_data["audio_complete"] is True
def test_state_data_with_lyrics_metadata(self):
"""Test state_data with lyrics metadata structure."""
job = Job(
job_id="test123",
status=JobStatus.LYRICS_COMPLETE,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
state_data={
"lyrics_metadata": {
"line_count": 42,
"has_corrections": True,
"ready_for_review": True,
},
"corrected_lyrics": {
"lines": [
{"text": "Hello world", "start_time": 1.0, "end_time": 2.0}
],
"metadata": {"song": "Test Song"}
}
}
)
assert job.state_data["lyrics_metadata"]["line_count"] == 42
assert len(job.state_data["corrected_lyrics"]["lines"]) == 1
def test_state_data_roundtrip_serialization(self):
"""Test that state_data survives serialization/deserialization."""
original_state_data = {
"instrumental_selection": "clean",
"review_notes": "Looks good!",
"complex_nested": {
"level1": {
"level2": {
"value": 123
}
}
}
}
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
state_data=original_state_data
)
# Serialize and deserialize
job_dict = job.model_dump()
json_str = json.dumps(job_dict, default=str)
restored_dict = json.loads(json_str)
restored_job = Job(**restored_dict)
# Verify nested structure survived
assert restored_job.state_data["complex_nested"]["level1"]["level2"]["value"] == 123
class TestWorkerIdsNestedStructure:
"""Test that worker_ids field correctly handles nested dictionaries."""
def test_worker_ids_with_all_workers(self):
"""Test worker_ids with all worker types."""
job = Job(
job_id="test123",
status=JobStatus.GENERATING_VIDEO,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
worker_ids={
"audio_worker": "cloud-run-request-12345",
"lyrics_worker": "cloud-run-request-67890",
"screens_worker": "cloud-run-request-11111",
"video_worker": "cloud-run-request-22222",
}
)
assert job.worker_ids["audio_worker"] == "cloud-run-request-12345"
assert len(job.worker_ids) == 4
class TestJobModelIntegration:
"""
Integration tests that simulate real Firestore interactions.
These tests verify that the Job model works correctly when used
the same way as our actual services.
"""
def test_simulate_job_manager_update_file_url(self):
"""
Simulate what JobManager.update_file_url does.
This is the pattern that caused the bug - updating nested file_urls.
"""
# Start with a fresh job
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
file_urls={}
)
# Simulate update_file_url('test123', 'stems', 'instrumental_clean', 'gs://...')
# This creates nested structure: {"stems": {"instrumental_clean": "gs://..."}}
if "stems" not in job.file_urls:
job.file_urls["stems"] = {}
job.file_urls["stems"]["instrumental_clean"] = "gs://bucket/stems/clean.flac"
# Simulate Firestore roundtrip
job_dict = job.model_dump()
restored_job = Job(**job_dict)
# This is what was failing with Dict[str, str]!
assert restored_job.file_urls["stems"]["instrumental_clean"] == "gs://bucket/stems/clean.flac"
def test_simulate_audio_worker_completion(self):
"""Simulate the data structure created when audio worker completes."""
# This is the actual structure created by audio_worker.py
file_urls = {
"stems": {
"instrumental_clean": "gs://bucket/jobs/abc123/stems/instrumental_clean.flac",
"vocals_clean": "gs://bucket/jobs/abc123/stems/vocals_clean.flac",
"lead_vocals": "gs://bucket/jobs/abc123/stems/lead_vocals.flac",
"backing_vocals": "gs://bucket/jobs/abc123/stems/backing_vocals.flac",
"instrumental_with_backing": "gs://bucket/jobs/abc123/stems/instrumental_with_backing.flac",
}
}
state_data = {
"instrumental_options": {
"clean": "jobs/abc123/stems/instrumental_clean.flac",
"with_backing": "jobs/abc123/stems/instrumental_with_backing.flac",
}
}
job = Job(
job_id="abc123",
status=JobStatus.AUDIO_COMPLETE,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
artist="ABBA",
title="Waterloo",
file_urls=file_urls,
state_data=state_data
)
# Roundtrip
restored_job = Job(**job.model_dump())
assert len(restored_job.file_urls["stems"]) == 5
assert "instrumental_options" in restored_job.state_data
def test_simulate_lyrics_worker_completion(self):
"""Simulate the data structure created when lyrics worker completes."""
file_urls = {
"lyrics": {
"corrections": "gs://bucket/jobs/abc123/lyrics/corrections.json",
"lrc": "gs://bucket/jobs/abc123/lyrics/karaoke.lrc",
"uncorrected": "gs://bucket/jobs/abc123/lyrics/uncorrected.txt",
}
}
state_data = {
"lyrics_metadata": {
"line_count": 50,
"has_corrections": True,
"ready_for_review": True,
}
}
job = Job(
job_id="abc123",
status=JobStatus.LYRICS_COMPLETE,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
file_urls=file_urls,
state_data=state_data
)
# Roundtrip
restored_job = Job(**job.model_dump())
assert restored_job.file_urls["lyrics"]["corrections"].endswith("corrections.json")
assert restored_job.state_data["lyrics_metadata"]["line_count"] == 50
class TestExistingInstrumentalModelFields:
"""Test existing instrumental field in Job and JobCreate models (Batch 3)."""
def test_job_has_existing_instrumental_gcs_path(self):
"""Test that Job model has existing_instrumental_gcs_path field."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
existing_instrumental_gcs_path="uploads/test123/audio/existing_instrumental.flac"
)
assert hasattr(job, 'existing_instrumental_gcs_path')
assert job.existing_instrumental_gcs_path == "uploads/test123/audio/existing_instrumental.flac"
def test_job_existing_instrumental_defaults_to_none(self):
"""Test that existing_instrumental_gcs_path defaults to None."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC)
)
assert job.existing_instrumental_gcs_path is None
def test_job_create_has_existing_instrumental_gcs_path(self):
"""Test that JobCreate model has existing_instrumental_gcs_path field."""
from backend.models.job import JobCreate
job_create = JobCreate(
artist="Artist",
title="Title",
existing_instrumental_gcs_path="uploads/test/audio/existing_instrumental.mp3"
)
assert job_create.existing_instrumental_gcs_path == "uploads/test/audio/existing_instrumental.mp3"
def test_job_create_existing_instrumental_optional(self):
"""Test that existing_instrumental_gcs_path is optional in JobCreate."""
from backend.models.job import JobCreate
job_create = JobCreate(
artist="Artist",
title="Title"
)
assert job_create.existing_instrumental_gcs_path is None
def test_existing_instrumental_roundtrip_serialization(self):
"""Test that existing_instrumental_gcs_path survives serialization/deserialization."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
existing_instrumental_gcs_path="uploads/test123/audio/existing_instrumental.wav"
)
# Serialize to dict (simulates writing to Firestore)
job_dict = job.model_dump()
# Convert to JSON and back (simulates Firestore storage)
json_str = json.dumps(job_dict, default=str)
restored_dict = json.loads(json_str)
# Deserialize back to Job (simulates reading from Firestore)
restored_job = Job(**restored_dict)
assert restored_job.existing_instrumental_gcs_path == "uploads/test123/audio/existing_instrumental.wav"
def test_job_with_full_audio_config(self):
"""Test Job with complete audio configuration including existing instrumental."""
job = Job(
job_id="test123",
status=JobStatus.AUDIO_COMPLETE,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
artist="Test Artist",
title="Test Song",
# Audio model configuration
clean_instrumental_model="model_bs_roformer_ep_317_sdr_12.9755.ckpt",
backing_vocals_models=["mel_band_roformer_karaoke.ckpt"],
other_stems_models=["htdemucs_6s.yaml"],
# Existing instrumental
existing_instrumental_gcs_path="uploads/test123/audio/my_instrumental.flac",
)
assert job.clean_instrumental_model == "model_bs_roformer_ep_317_sdr_12.9755.ckpt"
assert job.existing_instrumental_gcs_path == "uploads/test123/audio/my_instrumental.flac"
class TestTwoPhaseWorkflowFields:
"""Test two-phase workflow fields in Job and JobCreate models (Batch 6)."""
def test_job_has_prep_only_field(self):
"""Test that Job model has prep_only field."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
prep_only=True
)
assert hasattr(job, 'prep_only')
assert job.prep_only is True
def test_job_prep_only_defaults_to_false(self):
"""Test that prep_only defaults to False."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC)
)
assert job.prep_only is False
def test_job_has_finalise_only_field(self):
"""Test that Job model has finalise_only field."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
finalise_only=True
)
assert hasattr(job, 'finalise_only')
assert job.finalise_only is True
def test_job_finalise_only_defaults_to_false(self):
"""Test that finalise_only defaults to False."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC)
)
assert job.finalise_only is False
def test_job_has_keep_brand_code_field(self):
"""Test that Job model has keep_brand_code field."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
keep_brand_code="NOMAD-1234"
)
assert hasattr(job, 'keep_brand_code')
assert job.keep_brand_code == "NOMAD-1234"
def test_job_keep_brand_code_defaults_to_none(self):
"""Test that keep_brand_code defaults to None."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC)
)
assert job.keep_brand_code is None
def test_job_create_has_two_phase_workflow_fields(self):
"""Test that JobCreate model has two-phase workflow fields."""
job_create = JobCreate(
artist="Artist",
title="Title",
prep_only=True,
finalise_only=False,
keep_brand_code="BRAND-0001"
)
assert job_create.prep_only is True
assert job_create.finalise_only is False
assert job_create.keep_brand_code == "BRAND-0001"
def test_two_phase_workflow_roundtrip_serialization(self):
"""Test that two-phase workflow fields survive serialization/deserialization."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
prep_only=True,
finalise_only=False,
keep_brand_code="NOMAD-5678"
)
# Serialize to dict (simulates writing to Firestore)
job_dict = job.model_dump()
# Convert to JSON and back (simulates Firestore storage)
json_str = json.dumps(job_dict, default=str)
restored_dict = json.loads(json_str)
# Deserialize back to Job (simulates reading from Firestore)
restored_job = Job(**restored_dict)
assert restored_job.prep_only is True
assert restored_job.finalise_only is False
assert restored_job.keep_brand_code == "NOMAD-5678"
class TestPrepCompleteStatus:
"""Test PREP_COMPLETE status and state transitions (Batch 6)."""
def test_prep_complete_status_exists(self):
"""Test that PREP_COMPLETE status exists in JobStatus enum."""
assert hasattr(JobStatus, 'PREP_COMPLETE')
assert JobStatus.PREP_COMPLETE.value == "prep_complete"
def test_job_can_have_prep_complete_status(self):
"""Test that Job can be created with PREP_COMPLETE status."""
job = Job(
job_id="test123",
status=JobStatus.PREP_COMPLETE,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC)
)
assert job.status == JobStatus.PREP_COMPLETE
def test_state_transitions_review_complete_to_prep_complete(self):
"""Test that REVIEW_COMPLETE can transition to PREP_COMPLETE."""
from backend.models.job import STATE_TRANSITIONS
valid_transitions = STATE_TRANSITIONS.get(JobStatus.REVIEW_COMPLETE, [])
assert JobStatus.PREP_COMPLETE in valid_transitions
def test_state_transitions_prep_complete_to_awaiting_instrumental(self):
"""Test that PREP_COMPLETE can transition to AWAITING_INSTRUMENTAL_SELECTION."""
from backend.models.job import STATE_TRANSITIONS
valid_transitions = STATE_TRANSITIONS.get(JobStatus.PREP_COMPLETE, [])
assert JobStatus.AWAITING_INSTRUMENTAL_SELECTION in valid_transitions
def test_state_transitions_pending_to_awaiting_instrumental(self):
"""Test that PENDING can transition to AWAITING_INSTRUMENTAL_SELECTION (for finalise-only)."""
from backend.models.job import STATE_TRANSITIONS
valid_transitions = STATE_TRANSITIONS.get(JobStatus.PENDING, [])
assert JobStatus.AWAITING_INSTRUMENTAL_SELECTION in valid_transitions
def test_critical_statuses_include_prep_complete(self):
"""Test that PREP_COMPLETE is in the list of job statuses."""
all_statuses = [status.value for status in JobStatus]
assert "prep_complete" in all_statuses
class TestJobWithFullTwoPhaseConfig:
"""Integration tests for two-phase workflow job configuration."""
def test_prep_only_job_full_config(self):
"""Test creating a prep-only job with full configuration."""
job = Job(
job_id="prep123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
artist="Test Artist",
title="Test Song",
prep_only=True,
enable_cdg=True,
enable_txt=True,
brand_prefix="NOMAD",
)
assert job.prep_only is True
assert job.finalise_only is False
assert job.brand_prefix == "NOMAD"
def test_finalise_only_job_full_config(self):
"""Test creating a finalise-only job with full configuration."""
job = Job(
job_id="final123",
status=JobStatus.AWAITING_INSTRUMENTAL_SELECTION,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
artist="Test Artist",
title="Test Song",
finalise_only=True,
keep_brand_code="NOMAD-1234",
enable_youtube_upload=True,
dropbox_path="/Karaoke/Tracks",
state_data={
"audio_complete": True,
"lyrics_complete": True,
"finalise_only": True,
}
)
assert job.finalise_only is True
assert job.keep_brand_code == "NOMAD-1234"
assert job.state_data["finalise_only"] is True
def test_prep_complete_job_with_file_urls(self):
"""Test a job that has reached PREP_COMPLETE status with all prep outputs."""
job = Job(
job_id="prepcomp123",
status=JobStatus.PREP_COMPLETE,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
artist="ABBA",
title="Waterloo",
prep_only=True,
file_urls={
"stems": {
"instrumental_clean": "gs://bucket/jobs/prepcomp123/stems/instrumental_clean.flac",
"instrumental_with_backing": "gs://bucket/jobs/prepcomp123/stems/instrumental_with_backing.flac",
},
"videos": {
"with_vocals": "gs://bucket/jobs/prepcomp123/videos/with_vocals.mkv",
},
"screens": {
"title": "gs://bucket/jobs/prepcomp123/screens/title.mov",
"end": "gs://bucket/jobs/prepcomp123/screens/end.mov",
},
"lyrics": {
"lrc": "gs://bucket/jobs/prepcomp123/lyrics/karaoke.lrc",
"ass": "gs://bucket/jobs/prepcomp123/lyrics/karaoke.ass",
},
}
)
assert job.status == JobStatus.PREP_COMPLETE
assert job.prep_only is True
assert "with_vocals" in job.file_urls["videos"]
assert "title" in job.file_urls["screens"]
if __name__ == "__main__":
pytest.main([__file__, "-v"])
-199
View File
@@ -1,199 +0,0 @@
"""
Unit tests for request models.
These tests validate Pydantic request model validation and serialization.
"""
import pytest
from pydantic import ValidationError
from backend.models.requests import (
URLSubmissionRequest,
UploadSubmissionRequest,
CorrectionsSubmission,
InstrumentalSelection,
StartReviewRequest,
CancelJobRequest,
RetryJobRequest
)
class TestURLSubmissionRequest:
"""Tests for URLSubmissionRequest model."""
def test_valid_youtube_url(self):
"""Test valid YouTube URL is accepted."""
request = URLSubmissionRequest(url="https://youtube.com/watch?v=test123")
assert str(request.url) == "https://youtube.com/watch?v=test123"
def test_valid_youtube_short_url(self):
"""Test valid YouTube short URL is accepted."""
request = URLSubmissionRequest(url="https://youtu.be/test123")
assert str(request.url) == "https://youtu.be/test123"
def test_optional_artist_title(self):
"""Test artist and title are optional."""
request = URLSubmissionRequest(url="https://youtube.com/watch?v=test")
assert request.artist is None
assert request.title is None
def test_with_artist_title(self):
"""Test request with artist and title."""
request = URLSubmissionRequest(
url="https://youtube.com/watch?v=test",
artist="Test Artist",
title="Test Song"
)
assert request.artist == "Test Artist"
assert request.title == "Test Song"
def test_url_required(self):
"""Test URL is required."""
with pytest.raises(ValidationError):
URLSubmissionRequest()
def test_empty_url_rejected(self):
"""Test empty URL is rejected."""
with pytest.raises(ValidationError):
URLSubmissionRequest(url="")
class TestCorrectionsSubmission:
"""Tests for CorrectionsSubmission model."""
def test_valid_corrections(self):
"""Test valid corrections submission."""
corrections = CorrectionsSubmission(
corrections={
"lines": [
{"text": "Hello world", "start": 0.0, "end": 1.0}
],
"metadata": {"source": "test"}
}
)
assert "lines" in corrections.corrections
assert "metadata" in corrections.corrections
def test_missing_lines_rejected(self):
"""Test corrections without 'lines' field is rejected."""
with pytest.raises(ValidationError):
CorrectionsSubmission(corrections={"metadata": {}})
def test_missing_metadata_rejected(self):
"""Test corrections without 'metadata' field is rejected."""
with pytest.raises(ValidationError):
CorrectionsSubmission(corrections={"lines": []})
def test_corrections_required(self):
"""Test corrections field is required."""
with pytest.raises(ValidationError):
CorrectionsSubmission()
def test_with_user_notes(self):
"""Test corrections with user notes."""
corrections = CorrectionsSubmission(
corrections={"lines": [], "metadata": {}},
user_notes="Fixed typo in line 3"
)
assert corrections.user_notes == "Fixed typo in line 3"
class TestInstrumentalSelection:
"""Tests for InstrumentalSelection model."""
def test_valid_clean_selection(self):
"""Test selecting clean instrumental."""
selection = InstrumentalSelection(selection="clean")
assert selection.selection == "clean"
def test_valid_with_backing_selection(self):
"""Test selecting instrumental with backing vocals."""
selection = InstrumentalSelection(selection="with_backing")
assert selection.selection == "with_backing"
def test_selection_required(self):
"""Test selection is required."""
with pytest.raises(ValidationError):
InstrumentalSelection()
def test_invalid_selection_rejected(self):
"""Test invalid selection values are rejected."""
with pytest.raises(ValidationError):
InstrumentalSelection(selection="invalid_option")
class TestUploadSubmissionRequest:
"""Tests for UploadSubmissionRequest model."""
def test_valid_upload_request(self):
"""Test valid upload submission."""
request = UploadSubmissionRequest(
artist="Test Artist",
title="Test Song"
)
assert request.artist == "Test Artist"
assert request.title == "Test Song"
def test_artist_required(self):
"""Test artist is required."""
with pytest.raises(ValidationError):
UploadSubmissionRequest(title="Test Song")
def test_title_required(self):
"""Test title is required."""
with pytest.raises(ValidationError):
UploadSubmissionRequest(artist="Test Artist")
def test_default_options(self):
"""Test default option values."""
request = UploadSubmissionRequest(artist="Test", title="Test")
assert request.enable_cdg is True
assert request.enable_txt is True
assert request.enable_youtube_upload is False
class TestStartReviewRequest:
"""Tests for StartReviewRequest model."""
def test_valid_request(self):
"""Test valid start review request."""
request = StartReviewRequest()
assert request is not None
class TestCancelJobRequest:
"""Tests for CancelJobRequest model."""
def test_valid_request(self):
"""Test valid cancel request."""
request = CancelJobRequest()
assert request is not None
def test_with_reason(self):
"""Test cancel with reason."""
request = CancelJobRequest(reason="User requested")
assert request.reason == "User requested"
def test_reason_optional(self):
"""Test reason is optional."""
request = CancelJobRequest()
assert request.reason is None
class TestRetryJobRequest:
"""Tests for RetryJobRequest model."""
def test_valid_request(self):
"""Test valid retry request."""
request = RetryJobRequest()
assert request is not None
def test_with_from_stage(self):
"""Test retry from specific stage."""
request = RetryJobRequest(from_stage="transcription")
assert request.from_stage == "transcription"
def test_from_stage_optional(self):
"""Test from_stage is optional."""
request = RetryJobRequest()
assert request.from_stage is None
-121
View File
@@ -1,121 +0,0 @@
"""
Unit tests for jobs.py routes.
These tests exercise the route logic with mocked services.
"""
import pytest
from datetime import datetime, UTC
from unittest.mock import MagicMock, AsyncMock, patch
from backend.models.job import Job, JobStatus
class TestJobsRouteHelpers:
"""Tests for helper functions in jobs.py routes."""
def test_jobs_router_structure(self):
"""Test jobs router has expected structure."""
from backend.api.routes.jobs import router
assert router is not None
# Check that common route patterns exist
route_paths = [route.path for route in router.routes]
assert any('/jobs' in p or 'jobs' in str(p) for p in route_paths)
class TestJobStatusTransitions:
"""Tests for job status transition validation.
These test the Job model's state machine which is critical for
preventing invalid operations.
"""
def test_valid_pending_to_downloading(self):
"""Test PENDING -> DOWNLOADING is valid."""
from backend.models.job import STATE_TRANSITIONS
valid_transitions = STATE_TRANSITIONS.get(JobStatus.PENDING, [])
assert JobStatus.DOWNLOADING in valid_transitions
def test_valid_downloading_to_separating(self):
"""Test DOWNLOADING -> SEPARATING_STAGE1 is valid."""
from backend.models.job import STATE_TRANSITIONS
valid_transitions = STATE_TRANSITIONS.get(JobStatus.DOWNLOADING, [])
assert JobStatus.SEPARATING_STAGE1 in valid_transitions
def test_invalid_pending_to_complete(self):
"""Test PENDING -> COMPLETE is invalid."""
from backend.models.job import STATE_TRANSITIONS
valid_transitions = STATE_TRANSITIONS.get(JobStatus.PENDING, [])
assert JobStatus.COMPLETE not in valid_transitions
def test_any_active_status_can_fail(self):
"""Test any active (non-terminal, non-legacy) status can transition to FAILED."""
from backend.models.job import STATE_TRANSITIONS
# Terminal states and legacy states are excluded
excluded = [
JobStatus.COMPLETE, JobStatus.FAILED, JobStatus.CANCELLED,
# Legacy states that don't include FAILED
JobStatus.QUEUED, JobStatus.PROCESSING,
JobStatus.READY_FOR_FINALIZATION, JobStatus.FINALIZING, JobStatus.ERROR
]
for status in JobStatus:
if status not in excluded:
valid_transitions = STATE_TRANSITIONS.get(status, [])
assert JobStatus.FAILED in valid_transitions, f"{status} should be able to fail"
def test_failed_can_transition_for_retry(self):
"""Test FAILED status can transition to retry checkpoint states."""
from backend.models.job import STATE_TRANSITIONS
valid_transitions = STATE_TRANSITIONS.get(JobStatus.FAILED, [])
# FAILED should allow retry transitions
assert JobStatus.INSTRUMENTAL_SELECTED in valid_transitions, "FAILED should allow retry to INSTRUMENTAL_SELECTED"
assert JobStatus.REVIEW_COMPLETE in valid_transitions, "FAILED should allow retry to REVIEW_COMPLETE"
assert JobStatus.LYRICS_COMPLETE in valid_transitions, "FAILED should allow retry to LYRICS_COMPLETE"
class TestJobModelSerialization:
"""Tests for Job model serialization to/from API."""
def test_job_to_dict(self):
"""Test Job converts to dict correctly."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
artist="Test Artist",
title="Test Song"
)
data = job.model_dump()
assert data["job_id"] == "test123"
assert data["status"] == "pending"
assert data["artist"] == "Test Artist"
def test_job_from_dict(self):
"""Test Job can be created from dict."""
data = {
"job_id": "test123",
"status": "pending",
"created_at": datetime.now(UTC).isoformat(),
"updated_at": datetime.now(UTC).isoformat(),
"artist": "Test",
"title": "Song"
}
job = Job.model_validate(data)
assert job.job_id == "test123"
assert job.status == JobStatus.PENDING
def test_job_handles_null_optional_fields(self):
"""Test Job handles null optional fields."""
job = Job(
job_id="test",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC)
)
assert job.artist is None
assert job.title is None
assert job.url is None
assert job.file_urls == {}
-337
View File
@@ -1,337 +0,0 @@
"""
Unit tests for review.py routes and related components.
These tests verify the review-related state transitions and data structures.
Tests that require full backend imports are in the emulator integration tests.
"""
import pytest
import json
class TestJobStatusTransitionsForReview:
"""Tests for review-related state transitions.
These tests verify the Job model's state machine handles review flow correctly.
"""
def test_awaiting_review_can_transition_to_in_review(self):
"""Test AWAITING_REVIEW -> IN_REVIEW is valid."""
from backend.models.job import STATE_TRANSITIONS, JobStatus
valid_transitions = STATE_TRANSITIONS.get(JobStatus.AWAITING_REVIEW, [])
assert JobStatus.IN_REVIEW in valid_transitions
def test_awaiting_review_can_transition_to_review_complete(self):
"""Test AWAITING_REVIEW -> REVIEW_COMPLETE is valid (skip in_review)."""
from backend.models.job import STATE_TRANSITIONS, JobStatus
valid_transitions = STATE_TRANSITIONS.get(JobStatus.AWAITING_REVIEW, [])
assert JobStatus.REVIEW_COMPLETE in valid_transitions
def test_in_review_can_transition_to_review_complete(self):
"""Test IN_REVIEW -> REVIEW_COMPLETE is valid."""
from backend.models.job import STATE_TRANSITIONS, JobStatus
valid_transitions = STATE_TRANSITIONS.get(JobStatus.IN_REVIEW, [])
assert JobStatus.REVIEW_COMPLETE in valid_transitions
def test_review_complete_transitions_to_rendering_video(self):
"""Test REVIEW_COMPLETE -> RENDERING_VIDEO is valid."""
from backend.models.job import STATE_TRANSITIONS, JobStatus
valid_transitions = STATE_TRANSITIONS.get(JobStatus.REVIEW_COMPLETE, [])
assert JobStatus.RENDERING_VIDEO in valid_transitions
def test_rendering_video_status_exists(self):
"""Test RENDERING_VIDEO status exists in JobStatus enum."""
from backend.models.job import JobStatus
assert hasattr(JobStatus, 'RENDERING_VIDEO')
assert JobStatus.RENDERING_VIDEO.value == "rendering_video"
def test_rendering_video_transitions_to_instrumental(self):
"""Test RENDERING_VIDEO -> AWAITING_INSTRUMENTAL_SELECTION is valid."""
from backend.models.job import STATE_TRANSITIONS, JobStatus
valid_transitions = STATE_TRANSITIONS.get(JobStatus.RENDERING_VIDEO, [])
assert JobStatus.AWAITING_INSTRUMENTAL_SELECTION in valid_transitions
class TestStylesConfigRequirements:
"""Tests documenting the required fields for ASS subtitle generation.
These tests verify that the styles config format is documented correctly.
The actual styles creation is tested in integration tests.
"""
def test_required_karaoke_fields_documented(self):
"""Document required karaoke style fields for ASS generation."""
# These fields are required by the ASS subtitle generator
# Missing any of them will cause video generation to fail
required_fields = [
"font", # Font name for ASS
"font_path", # Path to font file (can be empty string, NOT None)
"ass_name", # Style name in ASS file
"primary_color", # Format: "R, G, B, A"
"secondary_color", # Format: "R, G, B, A"
"outline_color", # Format: "R, G, B, A"
"back_color", # Format: "R, G, B, A"
"bold", # Boolean
"italic", # Boolean
"underline", # Boolean
"strike_out", # Boolean
"scale_x", # Integer
"scale_y", # Integer
"spacing", # Integer
"angle", # Float
"border_style", # Integer
"outline", # Integer
"shadow", # Integer
"margin_l", # Integer
"margin_r", # Integer
"margin_v", # Integer
"encoding", # Integer
]
# This test documents the required fields
# Actual validation happens in integration tests
assert len(required_fields) == 22
assert "ass_name" in required_fields # This was missing initially
assert "font_path" in required_fields # Must be string, not None
def test_minimal_styles_structure(self):
"""Document the minimal styles JSON structure."""
minimal_styles = {
"karaoke": {
"background_color": "#000000",
"font_path": "", # MUST be string, NOT None
"font": "Arial",
"ass_name": "Default", # REQUIRED
"primary_color": "112, 112, 247, 255",
"secondary_color": "255, 255, 255, 255",
"outline_color": "26, 58, 235, 255",
"back_color": "0, 0, 0, 0",
"bold": False,
"italic": False,
"underline": False,
"strike_out": False,
"scale_x": 100,
"scale_y": 100,
"spacing": 0,
"angle": 0.0,
"border_style": 1,
"outline": 1,
"shadow": 0,
"margin_l": 0,
"margin_r": 0,
"margin_v": 0,
"encoding": 0
}
}
# Verify structure is valid JSON
json_str = json.dumps(minimal_styles)
parsed = json.loads(json_str)
assert "karaoke" in parsed
assert parsed["karaoke"]["font_path"] == "" # Not None
assert parsed["karaoke"]["ass_name"] == "Default"
class TestCorrectionDataMerging:
"""Tests documenting correction data merging requirements.
The LyricsTranscriber React UI sends only partial correction data:
- corrections
- corrected_segments
The backend must merge this with the original corrections.json to
reconstruct a full CorrectionResult.
"""
def test_frontend_sends_partial_data(self):
"""Document what the frontend sends."""
# The frontend sends only these fields
frontend_payload = {
"corrections": [], # List of corrections made
"corrected_segments": [] # Updated segment data
}
# This is NOT a full CorrectionResult
assert "original_segments" not in frontend_payload
assert "metadata" not in frontend_payload
def test_merging_strategy(self):
"""Document the merging strategy for corrections."""
# Original data has full structure
original_data = {
"original_segments": [{"id": 1, "text": "test"}],
"corrected_segments": [{"id": 1, "text": "test"}],
"corrections": [],
"metadata": {"artist": "Test"}
}
# Frontend sends partial update
frontend_update = {
"corrections": [{"id": 1, "type": "edit"}],
"corrected_segments": [{"id": 1, "text": "updated"}]
}
# Merging strategy: update only the fields sent by frontend
if 'corrections' in frontend_update:
original_data['corrections'] = frontend_update['corrections']
if 'corrected_segments' in frontend_update:
original_data['corrected_segments'] = frontend_update['corrected_segments']
# Result preserves original_segments and metadata
assert original_data['original_segments'] == [{"id": 1, "text": "test"}]
assert original_data['metadata'] == {"artist": "Test"}
# But has updated corrections and corrected_segments
assert original_data['corrections'] == [{"id": 1, "type": "edit"}]
assert original_data['corrected_segments'] == [{"id": 1, "text": "updated"}]
class TestAddLyricsEndpoint:
"""Tests for the add-lyrics endpoint."""
def test_add_lyrics_requires_source_and_lyrics(self):
"""Document that add_lyrics expects source and lyrics fields."""
# The frontend sends this payload
valid_payload = {
"source": "custom",
"lyrics": "Line 1\nLine 2\nLine 3"
}
# Both fields are required
assert "source" in valid_payload
assert "lyrics" in valid_payload
assert len(valid_payload["source"].strip()) > 0
assert len(valid_payload["lyrics"].strip()) > 0
def test_add_lyrics_uses_correction_operations(self):
"""Verify CorrectionOperations.add_lyrics_source is available."""
from lyrics_transcriber.correction.operations import CorrectionOperations
# The method should exist
assert hasattr(CorrectionOperations, 'add_lyrics_source')
# It should be a static method
import inspect
# Get the method and check it's callable
method = getattr(CorrectionOperations, 'add_lyrics_source')
assert callable(method)
class TestPreviewStyleLoading:
"""Tests for the unified style loader used in preview video generation.
When a job has custom styles (uploaded via --style_params_json), these
must be loaded and applied to preview videos, not just the final render.
This was a bug: preview videos were using minimal styles (black background)
even when the job had custom backgrounds and fonts configured.
The style loading logic is now consolidated in karaoke_gen.style_loader
to avoid duplication between workers and API routes.
"""
def test_load_styles_from_gcs_with_custom_styles(self, tmp_path):
"""Test that custom styles are downloaded and applied for preview."""
import os
from karaoke_gen.style_loader import load_styles_from_gcs
# Create source style params file
source_style_params = tmp_path / "source_styles.json"
style_data = {
"karaoke": {
"background_image": "/original/path/background.png",
"font_path": "/original/path/font.ttf",
"background_color": "#000000",
"font": "Arial",
"ass_name": "Default",
}
}
source_style_params.write_text(json.dumps(style_data))
# Create source asset files
source_background = tmp_path / "background.png"
source_background.write_bytes(b"PNG image data")
source_font = tmp_path / "font.ttf"
source_font.write_bytes(b"TTF font data")
# Create mock download function that simulates GCS download
def mock_download(gcs_path, local_path):
if "style_params.json" in gcs_path:
with open(local_path, 'w') as f:
f.write(source_style_params.read_text())
elif "karaoke_background" in gcs_path:
with open(local_path, 'wb') as f:
f.write(source_background.read_bytes())
elif "font.ttf" in gcs_path:
with open(local_path, 'wb') as f:
f.write(source_font.read_bytes())
# Call the unified style loader function
style_assets = {
"style_params": "uploads/test123/style/style_params.json",
"karaoke_background": "uploads/test123/style/karaoke_background.png",
"font": "uploads/test123/style/font.ttf",
}
styles_path, result_styles = load_styles_from_gcs(
style_params_gcs_path="uploads/test123/style/style_params.json",
style_assets=style_assets,
temp_dir=str(tmp_path / "workdir"),
download_func=mock_download,
)
# Verify styles file was created
assert os.path.exists(styles_path)
# The paths should now point to the local downloaded files, not the original paths
assert "karaoke" in result_styles
assert result_styles["karaoke"]["background_image"] != "/original/path/background.png"
assert "karaoke_background.png" in result_styles["karaoke"]["background_image"]
assert result_styles["karaoke"]["font_path"] != "/original/path/font.ttf"
assert "font.ttf" in result_styles["karaoke"]["font_path"]
def test_load_styles_from_gcs_falls_back_to_minimal(self, tmp_path):
"""Test that minimal styles are used when job has no custom styles."""
import os
from karaoke_gen.style_loader import load_styles_from_gcs
# Call with no custom styles
styles_path, result_styles = load_styles_from_gcs(
style_params_gcs_path=None, # No custom styles
style_assets={},
temp_dir=str(tmp_path),
download_func=lambda gcs_path, local_path: None, # Won't be called
)
# Verify styles file was created
assert os.path.exists(styles_path)
# Should have karaoke section with minimal/default values
assert "karaoke" in result_styles
assert result_styles["karaoke"]["background_color"] == "#000000"
assert result_styles["karaoke"]["font"] == "Arial"
# Minimal styles have background_image as None (default)
assert result_styles["karaoke"].get("background_image") is None
def test_asset_mapping_is_complete(self):
"""Verify all required asset mappings are defined in the unified style loader."""
from karaoke_gen.style_loader import ASSET_KEY_MAPPINGS
# These mappings must be present for styles to work correctly
required_keys = [
"karaoke_background",
"intro_background",
"end_background",
"font",
]
for key in required_keys:
assert key in ASSET_KEY_MAPPINGS, f"Asset mapping '{key}' not found in ASSET_KEY_MAPPINGS"
# Verify karaoke_background maps to the correct path
karaoke_mapping = ASSET_KEY_MAPPINGS["karaoke_background"]
assert karaoke_mapping == ("karaoke", "background_image")
# Verify font maps to multiple sections
font_mappings = ASSET_KEY_MAPPINGS["font"]
assert isinstance(font_mappings, list)
assert ("karaoke", "font_path") in font_mappings
-556
View File
@@ -1,556 +0,0 @@
"""
Unit tests for service layer.
Tests AuthService, StorageService, WorkerService, and FirestoreService
without requiring actual cloud resources.
"""
import pytest
from unittest.mock import Mock, MagicMock, AsyncMock, patch, call
from datetime import datetime, UTC
# Mock Google Cloud before imports
import sys
sys.modules['google.cloud.firestore'] = MagicMock()
sys.modules['google.cloud.storage'] = MagicMock()
sys.modules['google.cloud.tasks_v2'] = MagicMock()
from backend.services.auth_service import AuthService, UserType
from backend.services.storage_service import StorageService
from backend.services.worker_service import WorkerService, get_worker_service
from backend.services.firestore_service import FirestoreService
from backend.models.job import Job, JobStatus
class TestAuthService:
"""Test AuthService token validation and management."""
def test_validate_admin_token(self):
"""Test validating hardcoded admin tokens."""
with patch('backend.services.auth_service.get_settings') as mock_settings:
mock_settings.return_value.admin_tokens = "admin123,secret456"
auth_service = AuthService()
# Valid admin token - returns (is_valid, user_type, usage_count, token)
is_valid, user_type, usage_count, token = auth_service.validate_token('admin123')
assert is_valid is True
assert user_type == UserType.ADMIN
# Another valid admin token
is_valid, user_type, _, _ = auth_service.validate_token('secret456')
assert is_valid is True
assert user_type == UserType.ADMIN
def test_validate_invalid_token(self):
"""Test rejecting invalid tokens."""
with patch('backend.services.auth_service.FirestoreService') as mock_fs:
mock_fs_instance = Mock()
mock_fs.return_value = mock_fs_instance
mock_fs_instance.get_token.return_value = None # Token not in DB
with patch('backend.services.auth_service.get_settings') as mock_settings:
mock_settings.return_value.admin_tokens = "admin123"
auth_service = AuthService()
is_valid, _, _, _ = auth_service.validate_token('invalid_token')
assert is_valid is False
def test_validate_token_from_firestore(self):
"""Test validating tokens stored in Firestore."""
with patch('backend.services.auth_service.FirestoreService') as mock_fs:
mock_fs_instance = Mock()
mock_fs.return_value = mock_fs_instance
# Mock Firestore returning a token
mock_fs_instance.get_token.return_value = {
'token': 'db_token123',
'type': 'unlimited',
'valid': True,
'usage_count': 5,
'created_at': datetime.now(UTC).isoformat()
}
with patch('backend.services.auth_service.get_settings') as mock_settings:
mock_settings.return_value.admin_tokens = ""
auth_service = AuthService()
is_valid, user_type, usage_count, token = auth_service.validate_token('db_token123')
assert is_valid is True
assert user_type == UserType.UNLIMITED
# usage_count can be -1 for unlimited tokens
assert isinstance(usage_count, int)
class TestStorageService:
"""Test StorageService GCS operations."""
def test_upload_file(self):
"""Test uploading a file to GCS."""
with patch('backend.services.storage_service.storage') as mock_storage:
mock_client = MagicMock()
mock_storage.Client.return_value = mock_client
mock_bucket = MagicMock()
mock_client.bucket.return_value = mock_bucket
mock_blob = MagicMock()
mock_bucket.blob.return_value = mock_blob
storage_service = StorageService()
# Upload file - correct parameter names
result = storage_service.upload_file(
local_path="/tmp/test.flac",
destination_path="uploads/test123/test.flac"
)
# Verify blob was created and uploaded
mock_bucket.blob.assert_called_once_with("uploads/test123/test.flac")
mock_blob.upload_from_filename.assert_called_once_with("/tmp/test.flac")
# Result should be the destination path
assert result == "uploads/test123/test.flac"
def test_download_file(self):
"""Test downloading a file from GCS."""
with patch('backend.services.storage_service.storage') as mock_storage:
mock_client = MagicMock()
mock_storage.Client.return_value = mock_client
mock_bucket = MagicMock()
mock_client.bucket.return_value = mock_bucket
mock_blob = MagicMock()
mock_bucket.blob.return_value = mock_blob
storage_service = StorageService()
# Download file - correct parameter names
storage_service.download_file(
source_path="uploads/test123/test.flac",
destination_path="/tmp/downloaded.flac"
)
# Verify download was called
mock_blob.download_to_filename.assert_called_once_with("/tmp/downloaded.flac")
def test_delete_file(self):
"""Test deleting a file from GCS."""
with patch('backend.services.storage_service.storage') as mock_storage:
mock_client = MagicMock()
mock_storage.Client.return_value = mock_client
mock_bucket = MagicMock()
mock_client.bucket.return_value = mock_bucket
mock_blob = MagicMock()
mock_bucket.blob.return_value = mock_blob
storage_service = StorageService()
# Delete file
storage_service.delete_file("uploads/test123/test.flac")
# Verify delete was called
mock_blob.delete.assert_called_once()
class TestWorkerService:
"""Test WorkerService internal HTTP calls."""
@pytest.mark.asyncio
async def test_trigger_audio_worker(self):
"""Test triggering audio worker via internal HTTP."""
with patch('backend.services.worker_service.httpx.AsyncClient') as mock_client_cls:
mock_client = AsyncMock()
mock_client_cls.return_value.__aenter__.return_value = mock_client
mock_response = Mock()
mock_response.status_code = 200
mock_client.post.return_value = mock_response
worker_service = get_worker_service()
await worker_service.trigger_audio_worker("test123")
# Verify HTTP POST was made
mock_client.post.assert_called_once()
call_args = mock_client.post.call_args
assert "/api/internal/workers/audio" in str(call_args)
@pytest.mark.asyncio
async def test_trigger_lyrics_worker(self):
"""Test triggering lyrics worker via internal HTTP."""
with patch('backend.services.worker_service.httpx.AsyncClient') as mock_client_cls:
mock_client = AsyncMock()
mock_client_cls.return_value.__aenter__.return_value = mock_client
mock_response = Mock()
mock_response.status_code = 200
mock_client.post.return_value = mock_response
worker_service = get_worker_service()
await worker_service.trigger_lyrics_worker("test123")
# Verify HTTP POST was made
mock_client.post.assert_called_once()
call_args = mock_client.post.call_args
assert "/api/internal/workers/lyrics" in str(call_args)
@pytest.mark.asyncio
async def test_trigger_screens_worker(self):
"""Test triggering screens worker via internal HTTP."""
with patch('backend.services.worker_service.httpx.AsyncClient') as mock_client_cls:
mock_client = AsyncMock()
mock_client_cls.return_value.__aenter__.return_value = mock_client
mock_response = Mock()
mock_response.status_code = 200
mock_client.post.return_value = mock_response
worker_service = get_worker_service()
await worker_service.trigger_screens_worker("test123")
# Verify HTTP POST was made
mock_client.post.assert_called_once()
call_args = mock_client.post.call_args
assert "/api/internal/workers/screens" in str(call_args)
@pytest.mark.asyncio
async def test_trigger_video_worker(self):
"""Test triggering video worker via internal HTTP."""
with patch('backend.services.worker_service.httpx.AsyncClient') as mock_client_cls:
mock_client = AsyncMock()
mock_client_cls.return_value.__aenter__.return_value = mock_client
mock_response = Mock()
mock_response.status_code = 200
mock_client.post.return_value = mock_response
worker_service = get_worker_service()
await worker_service.trigger_video_worker("test123")
# Verify HTTP POST was made
mock_client.post.assert_called_once()
call_args = mock_client.post.call_args
assert "/api/internal/workers/video" in str(call_args)
class TestWorkerServiceCloudTasks:
"""Test WorkerService Cloud Tasks integration."""
def test_should_use_cloud_tasks_default_false(self):
"""Test that Cloud Tasks is disabled by default."""
from backend.services.worker_service import WorkerService, reset_worker_service
reset_worker_service()
with patch('backend.services.worker_service.os.getenv') as mock_getenv:
mock_getenv.side_effect = lambda k, d=None: {
'PORT': '8000',
}.get(k, d)
with patch('backend.services.worker_service.get_settings') as mock_settings:
mock_settings.return_value.admin_tokens = None
mock_settings.return_value.google_cloud_project = "test-project"
mock_settings.return_value.enable_cloud_tasks = False
mock_settings.return_value.gcp_region = "us-central1"
mock_settings.return_value.use_cloud_run_jobs_for_video = False
service = WorkerService()
assert service._use_cloud_tasks is False
def test_should_use_cloud_tasks_enabled(self):
"""Test that Cloud Tasks can be enabled via settings."""
from backend.services.worker_service import WorkerService, reset_worker_service
reset_worker_service()
with patch('backend.services.worker_service.os.getenv') as mock_getenv:
mock_getenv.side_effect = lambda k, d=None: {
'PORT': '8000',
}.get(k, d)
with patch('backend.services.worker_service.get_settings') as mock_settings:
mock_settings.return_value.admin_tokens = None
mock_settings.return_value.google_cloud_project = "test-project"
mock_settings.return_value.enable_cloud_tasks = True
mock_settings.return_value.gcp_region = "us-central1"
mock_settings.return_value.use_cloud_run_jobs_for_video = False
service = WorkerService()
assert service._use_cloud_tasks is True
def test_worker_queues_mapping(self):
"""Test that all worker types have queue mappings."""
from backend.services.worker_service import WORKER_QUEUES
# Verify all expected workers have queues
assert "audio" in WORKER_QUEUES
assert "lyrics" in WORKER_QUEUES
assert "screens" in WORKER_QUEUES
assert "render-video" in WORKER_QUEUES
assert "video" in WORKER_QUEUES
# Verify queue names are correct
assert WORKER_QUEUES["audio"] == "audio-worker-queue"
assert WORKER_QUEUES["lyrics"] == "lyrics-worker-queue"
assert WORKER_QUEUES["screens"] == "screens-worker-queue"
assert WORKER_QUEUES["render-video"] == "render-worker-queue"
assert WORKER_QUEUES["video"] == "video-worker-queue"
@pytest.mark.asyncio
async def test_trigger_worker_uses_http_when_cloud_tasks_disabled(self):
"""Test that trigger_worker uses HTTP when Cloud Tasks is disabled."""
from backend.services.worker_service import WorkerService, reset_worker_service
reset_worker_service()
with patch('backend.services.worker_service.os.getenv') as mock_getenv:
mock_getenv.side_effect = lambda k, d=None: {
'PORT': '8000',
}.get(k, d)
with patch('backend.services.worker_service.get_settings') as mock_settings:
mock_settings.return_value.admin_tokens = "test-token"
mock_settings.return_value.google_cloud_project = "test-project"
mock_settings.return_value.enable_cloud_tasks = False
mock_settings.return_value.gcp_region = "us-central1"
mock_settings.return_value.use_cloud_run_jobs_for_video = False
with patch('backend.services.worker_service.httpx.AsyncClient') as mock_client_cls:
mock_client = AsyncMock()
mock_client_cls.return_value.__aenter__.return_value = mock_client
mock_response = Mock()
mock_response.status_code = 200
mock_client.post.return_value = mock_response
service = WorkerService()
assert service._use_cloud_tasks is False
result = await service.trigger_worker("audio", "test-job-123")
# Verify HTTP was used
assert result is True
mock_client.post.assert_called_once()
@pytest.mark.asyncio
async def test_trigger_worker_uses_cloud_tasks_when_enabled(self):
"""Test that trigger_worker uses Cloud Tasks when enabled."""
from backend.services.worker_service import WorkerService, reset_worker_service
reset_worker_service()
with patch('backend.services.worker_service.os.getenv') as mock_getenv:
mock_getenv.side_effect = lambda k, d=None: {
'CLOUD_RUN_SERVICE_URL': 'https://api.example.com',
}.get(k, d)
with patch('backend.services.worker_service.get_settings') as mock_settings:
mock_settings.return_value.admin_tokens = "test-token"
mock_settings.return_value.google_cloud_project = "test-project"
mock_settings.return_value.enable_cloud_tasks = True
mock_settings.return_value.gcp_region = "us-central1"
mock_settings.return_value.use_cloud_run_jobs_for_video = False
# Mock Cloud Tasks client
mock_tasks_client = MagicMock()
mock_tasks_client.queue_path.return_value = "projects/test-project/locations/us-central1/queues/audio-worker-queue"
mock_task_response = MagicMock()
mock_task_response.name = "projects/test-project/locations/us-central1/queues/audio-worker-queue/tasks/abc123"
mock_tasks_client.create_task.return_value = mock_task_response
# Mock the google.cloud.tasks_v2 module which is imported inside the method
mock_tasks_module = MagicMock()
mock_tasks_module.CloudTasksClient.return_value = mock_tasks_client
mock_tasks_module.HttpMethod.POST = "POST"
with patch.dict('sys.modules', {'google.cloud.tasks_v2': mock_tasks_module}):
with patch.dict(sys.modules, {'google.cloud': MagicMock()}):
service = WorkerService()
service._tasks_client = mock_tasks_client # Inject mocked client
result = await service.trigger_worker("audio", "test-job-123")
# Verify Cloud Tasks was used
assert result is True
mock_tasks_client.create_task.assert_called_once()
# Verify task payload
call_args = mock_tasks_client.create_task.call_args
assert call_args is not None
@pytest.mark.asyncio
async def test_trigger_worker_returns_false_for_unknown_worker_type(self):
"""Test that trigger_worker returns False for unknown worker types."""
from backend.services.worker_service import WorkerService, reset_worker_service
reset_worker_service()
with patch('backend.services.worker_service.os.getenv') as mock_getenv:
mock_getenv.side_effect = lambda k, d=None: {
'CLOUD_RUN_SERVICE_URL': 'https://api.example.com',
}.get(k, d)
with patch('backend.services.worker_service.get_settings') as mock_settings:
mock_settings.return_value.admin_tokens = "test-token"
mock_settings.return_value.google_cloud_project = "test-project"
mock_settings.return_value.enable_cloud_tasks = True
mock_settings.return_value.gcp_region = "us-central1"
mock_settings.return_value.use_cloud_run_jobs_for_video = False
service = WorkerService()
result = await service.trigger_worker("unknown-worker", "test-job-123")
assert result is False
def test_reset_worker_service(self):
"""Test that reset_worker_service resets the singleton."""
from backend.services.worker_service import get_worker_service, reset_worker_service
with patch('backend.services.worker_service.get_settings') as mock_settings:
mock_settings.return_value.admin_tokens = None
mock_settings.return_value.google_cloud_project = "test-project"
mock_settings.return_value.enable_cloud_tasks = False
mock_settings.return_value.gcp_region = "us-central1"
mock_settings.return_value.use_cloud_run_jobs_for_video = False
service1 = get_worker_service()
reset_worker_service()
service2 = get_worker_service()
# After reset, should be different instances
assert service1 is not service2
class TestFirestoreService:
"""Test FirestoreService database operations."""
def test_create_job(self):
"""Test creating a job document in Firestore."""
with patch('backend.services.firestore_service.firestore') as mock_firestore:
mock_client = MagicMock()
mock_firestore.Client.return_value = mock_client
mock_collection = MagicMock()
mock_client.collection.return_value = mock_collection
mock_doc_ref = MagicMock()
mock_collection.document.return_value = mock_doc_ref
firestore_service = FirestoreService()
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC)
)
firestore_service.create_job(job) # Returns None
# Verify document was set
mock_doc_ref.set.assert_called_once()
def test_get_job(self):
"""Test fetching a job from Firestore."""
with patch('backend.services.firestore_service.firestore') as mock_firestore:
mock_client = MagicMock()
mock_firestore.Client.return_value = mock_client
mock_collection = MagicMock()
mock_client.collection.return_value = mock_collection
mock_doc_ref = MagicMock()
mock_collection.document.return_value = mock_doc_ref
mock_doc = MagicMock()
mock_doc.exists = True
mock_doc.to_dict.return_value = {
'job_id': 'test123',
'status': 'pending',
'progress': 0,
'created_at': datetime.now(UTC).isoformat(),
'updated_at': datetime.now(UTC).isoformat()
}
mock_doc_ref.get.return_value = mock_doc
firestore_service = FirestoreService()
job = firestore_service.get_job("test123")
# Verify document was fetched
mock_doc_ref.get.assert_called_once()
assert job is not None
assert job.job_id == "test123"
def test_get_nonexistent_job(self):
"""Test fetching a job that doesn't exist."""
with patch('backend.services.firestore_service.firestore') as mock_firestore:
mock_client = MagicMock()
mock_firestore.Client.return_value = mock_client
mock_collection = MagicMock()
mock_client.collection.return_value = mock_collection
mock_doc_ref = MagicMock()
mock_collection.document.return_value = mock_doc_ref
mock_doc = MagicMock()
mock_doc.exists = False
mock_doc_ref.get.return_value = mock_doc
firestore_service = FirestoreService()
job = firestore_service.get_job("nonexistent")
assert job is None
def test_update_job(self):
"""Test updating a job in Firestore."""
with patch('backend.services.firestore_service.firestore') as mock_firestore:
mock_client = MagicMock()
mock_firestore.Client.return_value = mock_client
mock_collection = MagicMock()
mock_client.collection.return_value = mock_collection
mock_doc_ref = MagicMock()
mock_collection.document.return_value = mock_doc_ref
firestore_service = FirestoreService()
updates = {
'status': JobStatus.SEPARATING_STAGE1,
'progress': 25
}
firestore_service.update_job("test123", updates)
# Verify update was called
mock_doc_ref.update.assert_called_once()
def test_delete_job(self):
"""Test deleting a job from Firestore."""
with patch('backend.services.firestore_service.firestore') as mock_firestore:
mock_client = MagicMock()
mock_firestore.Client.return_value = mock_client
mock_collection = MagicMock()
mock_client.collection.return_value = mock_collection
mock_doc_ref = MagicMock()
mock_collection.document.return_value = mock_doc_ref
firestore_service = FirestoreService()
firestore_service.delete_job("test123")
# Verify delete was called
mock_doc_ref.delete.assert_called_once()
if __name__ == "__main__":
pytest.main([__file__, "-v"])
Loaded 100 of 843 files, more files were not shown because too many files have changed in this diff. Show more