mirror of
https://github.com/nomadkaraoke/karaoke-gen.git
synced 2026-11-20 13:07:57 +09:00
## Summary
Partner API so the kjbox singer UI (live karaoke nights) can turn
patrons into real karaoke-gen customers: the singer verifies their email
with a 6-digit code typed into the kjbox page, and kjbox then searches
audio / creates the job **as that user** (normal gen delivery emails).
All under `/api/kjbox`, gated by `X-Kjbox-Secret` (Secret Manager
`kjbox-partner-secret`, wired in ci.yml; 503 when unset):
- `POST /auth/send-code` — emails a 6-digit code (hashed at rest, 10-min
expiry, new code supersedes old). Exempt from the 2-signups-per-IP cap
(a venue shares one IP) — replaced by a partner-wide 100 new accounts /
24h cap + 5 codes / email / hour. New users tagged `signup_source=kjbox`
(+ venue).
- `POST /auth/verify-code` — 5 attempts then burned, single-use; shares
the post-login path with magic-link verify (refactored into
`complete_verified_login`: welcome credit w/ AI eval, locale, referral,
session, welcome email).
- `POST /credits/show-credit` (+ user Bearer) — +1 credit, no email
("free at Andrew's shows"), idempotent per key, 5 / user / 24h.
- Review-needed + 24h reminder emails for `X-Client-Id: kjbox*` jobs
carry a one-click sign-in link to the review page (singers never signed
in on gen's site).
Paired kjbox PR: nomadkaraoke/kjbox (singer make-it flow, v0.116.0).
Plan: kjbox `docs/archive/2026-09-24-singer-make-it-auto-flow-plan.md`.
## Testing
- New: `backend/tests/test_kjbox_partner_api.py`,
`backend/tests/emulator/test_kjbox_partner_service.py` (+ additions to
existing tests for the verify refactor, review-email links, X-Client-Id
on create-from-search)
- Backend unit suite: 4644 passed; emulator suite passed.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **New Features**
* Added partner sign-in with one-time email codes and show-credit
claiming, with limits on code requests and credit grants to prevent
repeated or duplicate claims.
* Added localized sign-in emails and single-use review links for
eligible reminders.
* Sign-in supports welcome-credit evaluation and referral attribution.
* **Improvements**
* Review reminders can use custom links, and new accounts can record
signup source and venue.
* Credential-like request headers are redacted from stored metadata.
* **Documentation**
* Added partner API usage and behavior details.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
55 lines
2.3 KiB
Python
55 lines
2.3 KiB
Python
"""request_metadata.custom_headers must never store credential headers raw —
|
|
GET /api/jobs/{id} returns request_metadata to the job owner."""
|
|
import pytest
|
|
from starlette.requests import Request
|
|
|
|
from backend.api.routes import audio_search, file_upload
|
|
from backend.utils.request_helpers import REDACTED, collect_custom_headers
|
|
|
|
SECRET_HEADERS = {
|
|
"X-Kjbox-Secret": "kj-secret-value",
|
|
"X-Admin-Token": "admin-token-value",
|
|
"X-KH-Forwarder-Secret": "kh-secret-value",
|
|
"X-E2E-Bypass-Key": "bypass-value",
|
|
"X-Api-Key": "api-key-value",
|
|
"X-Authorization": "Bearer abc",
|
|
"X-User-Password": "hunter2",
|
|
}
|
|
PLAIN_HEADERS = {"X-Client-Id": "kjbox", "X-Environment": "production", "X-Referral-Code": "abc"}
|
|
|
|
|
|
def _request(headers):
|
|
raw = [(k.lower().encode(), v.encode()) for k, v in headers.items()]
|
|
return Request({"type": "http", "method": "POST", "path": "/", "headers": raw,
|
|
"client": ("1.2.3.4", 1234)})
|
|
|
|
|
|
def test_collect_custom_headers_redacts_secrets_keeps_others():
|
|
out = collect_custom_headers({**{k.lower(): v for k, v in {**SECRET_HEADERS, **PLAIN_HEADERS}.items()},
|
|
"x-forwarded-for": "9.9.9.9", "user-agent": "ua"})
|
|
for name in SECRET_HEADERS:
|
|
assert out[name.lower()] == REDACTED
|
|
for name, value in PLAIN_HEADERS.items():
|
|
assert out[name.lower()] == value
|
|
assert "x-forwarded-for" not in out and "user-agent" not in out
|
|
|
|
|
|
@pytest.mark.parametrize("extract", [audio_search.extract_request_metadata,
|
|
file_upload.extract_request_metadata])
|
|
def test_extract_request_metadata_never_stores_secret_values(extract):
|
|
meta = extract(_request({**SECRET_HEADERS, **PLAIN_HEADERS}))
|
|
blob = repr(meta)
|
|
for value in SECRET_HEADERS.values():
|
|
assert value not in blob
|
|
assert meta["client_id"] == "kjbox"
|
|
assert meta["custom_headers"]["x-kjbox-secret"] == REDACTED
|
|
assert meta["custom_headers"]["x-client-id"] == "kjbox"
|
|
|
|
|
|
def test_session_and_jwt_headers_are_redacted():
|
|
from backend.utils.request_helpers import REDACTED, collect_custom_headers
|
|
out = collect_custom_headers({"X-JWT": "eyJ...", "X-Session-Id": "sess-abc", "X-Client-Id": "kjbox"})
|
|
assert out["X-JWT"] == REDACTED
|
|
assert out["X-Session-Id"] == REDACTED
|
|
assert out["X-Client-Id"] == "kjbox"
|