Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
72bf8a5553 | ||
|
|
dece5dec44 | ||
|
|
893886a60a | ||
|
|
e44485df16 | ||
|
|
8b7ef07ba3 | ||
|
|
1cf58768ed | ||
|
|
f45ba35e25 | ||
|
|
943554a96c | ||
|
|
40a614c8d4 | ||
|
|
ce2fc62ef8 | ||
|
|
0ceacc8230 | ||
|
|
1e81965519 | ||
|
|
f50c072d65 | ||
|
|
e6f508824b | ||
|
|
689500c85e | ||
|
|
4678d473b8 | ||
|
|
c63b2de66d | ||
|
|
27aa319f1d | ||
|
|
61d4d5bc4a | ||
|
|
483730cd03 | ||
|
|
477701fea2 | ||
|
|
17fad140a6 | ||
|
|
eb24a24b9c | ||
|
|
21e6ddd61e | ||
|
|
152aab7a4a | ||
|
|
1018dc0df9 | ||
|
|
74f4fd7f2a | ||
|
|
0cc441d6ce | ||
|
|
8415a97d15 | ||
|
|
fb425cbf9a | ||
|
|
e77edf58ef | ||
|
|
f15f57f9ed | ||
|
|
d208110002 | ||
|
|
3a27bf1126 | ||
|
|
8ca374e657 | ||
|
|
0fdf2f7218 | ||
|
|
d83943c86a | ||
|
|
6b817f11b9 | ||
|
|
672a0c8580 | ||
|
|
a4aeb5efcd | ||
|
|
8c6c7ca947 | ||
|
|
25215cbcbd | ||
|
|
404f74c55c |
@@ -46,3 +46,13 @@ TAPIR_SECRETS_FILE=
|
||||
# --- run loop -------------------------------------------------------------
|
||||
# Empty/0 = single pass. Set (e.g. 15m) to poll on that cadence.
|
||||
TAPIR_POLL_INTERVAL=
|
||||
# How long to wait before re-fetching a transcript that returned HTTP 429
|
||||
# (rate_limited). Inside the window the video is skipped without hitting the
|
||||
# caption endpoint; after it expires the video is retried. 0 = always retry.
|
||||
# Go duration; default 1h.
|
||||
TAPIR_FETCH_BACKOFF=
|
||||
|
||||
# --- invitations (tapir invite) -------------------------------------------
|
||||
# Public base URL used to build the invite link `tapir invite <email>` prints.
|
||||
# Default https://tapir.d-ma.be; no trailing slash needed.
|
||||
TAPIR_PUBLIC_URL=
|
||||
|
||||
+1
-21
@@ -90,24 +90,4 @@ jobs:
|
||||
&& echo "Smoke test passed" \
|
||||
|| echo "Smoke test inconclusive: $OUTPUT"
|
||||
|
||||
# ── 3. Mirror to GitHub (deploy intentionally omitted until manifests exist) ─
|
||||
mirror:
|
||||
name: Mirror to GitHub
|
||||
needs: build
|
||||
runs-on: self-hosted
|
||||
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Push to GitHub
|
||||
run: |
|
||||
mkdir -p ~/.ssh
|
||||
echo '${{ secrets.GH_DEPLOY_KEY }}' > ~/.ssh/id_rsa_gh_mirror
|
||||
chmod 600 ~/.ssh/id_rsa_gh_mirror
|
||||
ssh-keyscan github.com >> ~/.ssh/known_hosts 2>/dev/null
|
||||
GIT_SSH_COMMAND="ssh -i ~/.ssh/id_rsa_gh_mirror -o IdentitiesOnly=yes" \
|
||||
git push git@github.com:mathiasb/tapir.git HEAD:main
|
||||
rm ~/.ssh/id_rsa_gh_mirror
|
||||
echo "Mirrored to GitHub"
|
||||
# ── 3. Mirror to GitHub — skipped for now (SSH key rotation pending) ─
|
||||
|
||||
@@ -79,23 +79,33 @@ Skills live in the canonical library `mathias/skills` and are wired into this re
|
||||
|
||||
## Current build state (start here for the first task)
|
||||
|
||||
The repo is **scaffolded and intentionally RED**:
|
||||
The repo is **green and shipping** — last tag `v0.4.0`. `task check` passes (fmt, vet, lint,
|
||||
`go test -p 1 ./...`). Go is `1.26.1` (see `go.mod`).
|
||||
|
||||
- Clean Architecture skeleton exists: `internal/domain` (entities), `internal/ports`
|
||||
(interfaces), `internal/usecase` (engine), `cmd/tapir` (entrypoint stub),
|
||||
`internal/adapters` (empty — concrete adapters go here).
|
||||
- `usecase.Engine.ProcessNewVideo` returns `ErrNotImplemented`.
|
||||
- `test/acceptance/summarize_new_video_test.go` translates the first two Gherkin scenarios and
|
||||
**fails** against the stub. `task check` is therefore red on `test`.
|
||||
- **First build task:** implement `ProcessNewVideo` (resolve transcript -> summarize -> deliver to
|
||||
sinks | skip on no-transcript) to make the acceptance tests green, following the `.feature`
|
||||
files. Then add the AI-router `Summarizer` (copy `llm` per ADR-004), the YouTube `VideoSource`
|
||||
adapter (captions-first), and the store + brain sinks.
|
||||
- Clean Architecture core is implemented: `internal/domain` (entities), `internal/ports`
|
||||
(interfaces), `internal/usecase.Engine.ProcessNewVideo` (resolve transcript → summarize →
|
||||
deliver to sinks | skip on no-transcript). The acceptance tests in `test/acceptance/` are
|
||||
green against it.
|
||||
- Adapters present under `internal/adapters/`: `youtube` (captions-first `VideoSource`,
|
||||
timedtext/InnerTube acquisition per ADR-010), `summarizer` + `llm` (the copied AI router,
|
||||
Primary→Fallback per ADR-004), `store` (Postgres, golang-migrate migrations 001–006),
|
||||
`secrets` (file-backed `SecretStore`). The brain HTTP sink (ADR-005) is the remaining
|
||||
optional sink.
|
||||
- Stage 1 is open (ADR-012): multi-user with **DB-enforced** isolation — Postgres RLS `FORCE`d
|
||||
on all user-owned tables (migration 003), two-user isolation test in
|
||||
`internal/adapters/store/rls_test.go`. Registration gate, per-user YouTube web connect, and
|
||||
account management (disconnect / delete, ADR-013) all shipped.
|
||||
- `cmd/tapir` subcommands: `list`, `show`, `auth` (interactive host-side OAuth), `run` (batch
|
||||
watch→summarize), `serve` (the HTMX+Templ web reader/writer under `internal/web`, a new
|
||||
transport over the unchanged engine/ports — ADR-003). `tapir env` prints config.
|
||||
- **Build/run:** `task check` is the gate; `task build` produces the binary. Local dev uses
|
||||
`StubAuth` (allow-all) and a `TAPIR_DB_DSN` Postgres; the deployed service uses Dex OIDC.
|
||||
|
||||
**Unverified setup items** (see `docs/homelab-integration.md`, marked `confirm`): the Go version
|
||||
in `go.mod` (1.23 — match the koala runner; estate elsewhere uses 1.26.1), the brain-mcp URL, the
|
||||
exact ESO secret-ref naming, and the summarization model alias. Resolve against the live cluster
|
||||
before depending on them, and pin answers back into `docs/homelab-integration.md`.
|
||||
**Setup facts** (resolved — see `docs/homelab-integration.md` for the live values): LiteLLM is
|
||||
off-cluster at `koala:30401/v1/` with `LITELLM_MASTER_KEY` from 1Password; the summarization
|
||||
model is config (`TAPIR_SUMMARIZER_MODEL`, default `koala/phi4-mini`), never hardcoded. The
|
||||
brain-mcp base URL and ESO ref scheme are pinned in that doc; check it before wiring rather than
|
||||
re-deriving.
|
||||
|
||||
## Provenance (where this design came from)
|
||||
|
||||
|
||||
+218
-16
@@ -154,6 +154,22 @@ governs advancement. Reversible: if demand appears, a new ADR opens the Future C
|
||||
|
||||
---
|
||||
|
||||
## ADR-009 — Trunk-Based Development
|
||||
|
||||
**Status:** Accepted (2026-06-02)
|
||||
|
||||
**Context.** Platform-wide convention (homelab architecture review invariant; gitea-mcp #27):
|
||||
commit directly to `main`, one logical change per commit, every commit deployable.
|
||||
|
||||
**Decision.** Tapir follows TBD. Commit directly to `main`. No feature branches or PRs for
|
||||
solo/agent work; short-lived `agent/<desc>` branches only when parallel agents are active on
|
||||
the repo simultaneously. CI is the quality gate, not branch protection.
|
||||
|
||||
**Consequences.** Consistent with the rest of the estate. Depends on the direct-to-main write
|
||||
path tracked in gitea-mcp #35 (item #1).
|
||||
|
||||
---
|
||||
|
||||
## ADR-010 — Third-party caption acquisition via the timedtext/player baseUrl
|
||||
|
||||
**Status:** Accepted (2026-06-02)
|
||||
@@ -203,22 +219,6 @@ player/timedtext baseUrl) only. ADR-007's captions-first stance and the STT defe
|
||||
|
||||
---
|
||||
|
||||
## ADR-009 — Trunk-Based Development
|
||||
|
||||
**Status:** Accepted (2026-06-02)
|
||||
|
||||
**Context.** Platform-wide convention (homelab architecture review invariant; gitea-mcp #27):
|
||||
commit directly to `main`, one logical change per commit, every commit deployable.
|
||||
|
||||
**Decision.** Tapir follows TBD. Commit directly to `main`. No feature branches or PRs for
|
||||
solo/agent work; short-lived `agent/<desc>` branches only when parallel agents are active on
|
||||
the repo simultaneously. CI is the quality gate, not branch protection.
|
||||
|
||||
**Consequences.** Consistent with the rest of the estate. Depends on the direct-to-main write
|
||||
path tracked in gitea-mcp #35 (item #1).
|
||||
|
||||
---
|
||||
|
||||
## ADR-011 — Web read-surface at Stage 0: Dex authn (single-user authz), action signal, public ingress + GitOps
|
||||
|
||||
**Status:** Accepted (2026-06-02)
|
||||
@@ -290,6 +290,205 @@ explicit call, with isolation as the guardrail that keeps it safe.
|
||||
|
||||
---
|
||||
|
||||
## ADR-013 — Account deletion is Tapir-side only; the Dex identity is left intact
|
||||
|
||||
**Status:** Accepted (2026-06-03)
|
||||
|
||||
**Context.** Stage 1 (ADR-012) added account deletion. A registered user is two things: a
|
||||
`users` row (plus all their data, cascade-linked) in Tapir's Postgres, and a subject identity
|
||||
in **Dex** (the homelab OIDC provider, shared across the estate — Tapir does not own it).
|
||||
"Delete my account" could mean (a) erase all Tapir-side data and secrets, or (b) that plus
|
||||
deprovision the Dex identity. The maintainer chose (a).
|
||||
|
||||
**Decision.** Deleting a Tapir account removes **only Tapir-side state**:
|
||||
- The `users` row, cascading to all user-owned tables (`videos`, `transcripts`, `summaries`,
|
||||
`sink_deliveries`, `video_connections`, and — via an **explicit delete**, because it has no
|
||||
FK — `summary_actions`). The delete test asserts the cascade reaches every table and leaves
|
||||
other users' rows untouched.
|
||||
- All of that user's secrets in the SecretStore (the per-user YouTube refresh-token refs).
|
||||
|
||||
The **Dex identity is deliberately left intact.** Tapir does not deprovision, disable, or
|
||||
modify the shared Dex directory.
|
||||
|
||||
**Consequences.**
|
||||
- **Clean re-registration:** a deleted user who logs in again arrives as a Dex-authenticated
|
||||
subject with no `users` row, so they hit the registration gate as a "new" user — no special
|
||||
resurrection path needed. This is a feature of the choice, not an accident.
|
||||
- **Right-to-erasure is partial.** The user's *identity* still exists in Dex after deletion.
|
||||
For Future B (trusted friends) this is acceptable: Dex is the maintainer's own directory and
|
||||
the identity carries no Tapir content. **But if Tapir ever moves toward Future C (real
|
||||
external/public users), this is a GDPR-shaped gap** — a true "delete my account" there must
|
||||
also deprovision or anonymise the Dex identity, which is a new ADR and likely a Dex-admin
|
||||
integration Tapir does not currently have.
|
||||
- **Blast radius stays small:** Tapir never holds write access to the shared identity provider,
|
||||
consistent with the estate's blast-radius-minimisation posture (ADR-002, architecture review).
|
||||
|
||||
**Reversibility.** Adding Dex deprovisioning later is a superseding ADR; nothing about the
|
||||
current choice blocks it. Recorded now because "deletion is partial by design" is a deliberate
|
||||
semantic that future-Tapir (and any compliance review) must know was chosen, not overlooked.
|
||||
|
||||
---
|
||||
|
||||
## ADR-014 — Timedtext 429 handling: per-host backoff + honest in-flight UX, before any Whisper reconsideration
|
||||
|
||||
**Status:** Accepted (2026-06-03)
|
||||
|
||||
**Context.** ADR-010 acquires captions from the unauthenticated `timedtext` baseUrl. Live runs
|
||||
show that endpoint **rate-limits per source IP (HTTP 429) under volume** — many videos fetched
|
||||
in one pass from one egress IP. Stage 1 (ADR-012) made this sharper in two ways: multiple users
|
||||
now drive fetches from the *same cluster egress IP*, and the v0.4.0 "Summarize" button fires an
|
||||
**immediate, synchronous-feeling** fetch on click (HTMX polls `/v/{videoId}/status`), so a 429
|
||||
now surfaces as a *user-facing stall* rather than a background batch hiccup. A throttle
|
||||
(`TAPIR_FETCH_DELAY`) exists but is a fixed inter-fetch delay, not 429-aware, and does not
|
||||
coordinate across the concurrent click-path and the `tapir run` batch path.
|
||||
|
||||
This ADR is **not** a decision to build Whisper. ADR-007/010 keep STT deferred *pending
|
||||
measurement of the sustainable caption rate* — and that rate cannot be measured while the
|
||||
client reacts badly to the 429s it already provokes. Fix the backoff and the UX first; the
|
||||
clean data then tells you whether Whisper is warranted.
|
||||
|
||||
**Decision.**
|
||||
|
||||
1. **429-aware backoff at the fetch layer.** On a 429 from the timedtext/InnerTube fetch,
|
||||
respect `Retry-After` when present; otherwise exponential backoff with jitter. This replaces
|
||||
reliance on a fixed `TAPIR_FETCH_DELAY` alone (which stays as a floor/politeness delay).
|
||||
2. **A single per-egress-IP rate gate** shared by *both* the `tapir run` batch path and the
|
||||
web click path, so they cannot collectively exceed the sustainable rate. Concurrency into
|
||||
the timedtext endpoint is serialised/limited at this gate regardless of how many users or
|
||||
goroutines are upstream. (The 429 is per *IP*, not per user — so the gate is process-/
|
||||
cluster-egress-wide, not per-`withUser`.)
|
||||
3. **Honest in-flight UX (the product-shaping part).** The status poll distinguishes states
|
||||
the user can understand instead of a spinner that silently stalls:
|
||||
- *summarizing* — actively processing (the existing tapir spinner).
|
||||
- *queued / waiting for rate limit* — fetch deferred behind the rate gate; show a calm
|
||||
"queued, this can take a few minutes when busy" state, not a stuck spinner.
|
||||
- *no transcript* — terminal, per ADR-010's degrade-never-error (a 429 that exhausts retries
|
||||
resolves to `SourceNone`, same as any unavailable caption — it must not present as a hard
|
||||
error to the user).
|
||||
The spinner promising imminence is the wrong signal under rate-limiting; the UX must be able
|
||||
to say "waiting" truthfully.
|
||||
4. **Measurement before Whisper.** Only once (1)-(3) are in and a real sustainable
|
||||
per-IP rate is observed do we revisit whether caption coverage is good enough or whether the
|
||||
deferred Whisper fallback (ADR-007) is finally warranted. That reconsideration is a future
|
||||
ADR, gated on this data.
|
||||
|
||||
**Consequences.**
|
||||
- Caption fetching becomes well-behaved under multi-user load instead of self-inflicting 429s;
|
||||
the endpoint is treated as the shared, rate-limited resource it is.
|
||||
- The click-path UX stays honest: "waiting" reads as waiting, failure degrades to "no
|
||||
transcript", never a stuck spinner or error spew.
|
||||
- A future per-IP cooldown / second egress IP / proxy becomes an option the rate gate can sit
|
||||
in front of without UX changes.
|
||||
- **Still no Whisper** — and now there's a clean path to the *data* that decides whether it's
|
||||
ever needed (`docs/homelab-integration.md` and a future ADR own that measurement).
|
||||
|
||||
**Open (tracked, not in this ADR's scope):** the actual sustainable rate number; whether a
|
||||
dedicated egress IP / outbound proxy is worth it; CronJob-driven `tapir run` interaction with
|
||||
the rate gate (the batch path moves into k3s per the deferred CronJob item).
|
||||
|
||||
---
|
||||
|
||||
## ADR-015 — Per-user credentials: envelope-encrypted in PG18, not vault-stored
|
||||
|
||||
**Status:** Accepted (2026-06-03)
|
||||
|
||||
**Context.** The Stage-0/1 SecretStore (`internal/adapters/secrets/file.go`) holds per-user
|
||||
YouTube OAuth refresh tokens as a flat key-value JSON map on a PVC — explicitly a stand-in for
|
||||
"op/ESO later" (ADR-002, ADR-006). infra#86 proposed migrating it to an ESO-backed store. The
|
||||
decision spike (infra#88) found that framing subtly wrong: **ESO syncs vault→cluster at
|
||||
deploy/refresh time; it is not a runtime write API.** Per-user tokens are written *at runtime,
|
||||
per end-user* (every YouTube connect; on token rotation) — they are application state, not
|
||||
configuration. The homelab 1Password SA is also read-only, so a vault-write path would require
|
||||
a new write-capable SA, widening Tapir's blast radius to shared estate infra to store what is
|
||||
fundamentally Tapir's own row-data. Reading the actual SecretStore confirmed the shape: a
|
||||
3-method port (`Get`/`Put`/`Delete`) over opaque refs, written interactively per user.
|
||||
|
||||
**Decision.** Per-user credentials are stored **envelope-encrypted in PG18**, not in the vault:
|
||||
|
||||
1. Tokens are encrypted with a **single app-level envelope key** and stored as ciphertext in
|
||||
PG18, under the Row-Level Security already enforced and tested (ADR-012). Reads/writes go
|
||||
through the existing `withUser` RLS-scoped seam.
|
||||
2. The **envelope key** is the only secret in 1Password — fetched via the **existing read-only
|
||||
SA** (confirmed working). No new write-capable SA; no per-user vault items.
|
||||
3. The `ports.SecretStore` port is unchanged (`Get`/`Put`/`Delete`). The implementation swaps
|
||||
`FileStore` (PVC JSON) for a `PGStore` (encrypted rows). Every consumer — connect,
|
||||
disconnect, delete-account — is untouched (the port abstraction holds, ADR-003 spirit).
|
||||
4. **Infra/operator credentials** (Dex client secret, MCP-auth tokens, service tokens) stay an
|
||||
**ESO/1Password** concern. This ADR governs *per-user runtime* credentials only. The two
|
||||
classes use two mechanisms deliberately — because they are two different things (runtime
|
||||
app-state vs deploy-time config), not as a compromise. The "one mechanism" question
|
||||
(maintainer's initial preference) was answered in #88 by correctly *classifying* the
|
||||
secrets rather than unifying their storage.
|
||||
|
||||
**Consequences.**
|
||||
- Runtime credential writes are normal RLS'd DB writes — no ESO sync latency, no indirection,
|
||||
no write-SA blast radius. The interactive connect→store→use flow works without a vault
|
||||
round-trip.
|
||||
- Keeps PG18 and keeps ADR-002 intact (Supabase was considered and rejected again in #88 —
|
||||
adding a datastore to hold a few encrypted strings PG18 already holds).
|
||||
- Adds an encrypt/decrypt seam and an **envelope-key rotation** responsibility (re-encrypt the
|
||||
per-user rows under a new key). infra#89 (build) must implement and test rotation, not assume
|
||||
it — this is the real engineering cost of the choice.
|
||||
- The vault's involvement shrinks to one static key via the SA already trusted for reads.
|
||||
- **Supersedes** the "PVC stand-in for op/ESO" intent recorded in `secrets/file.go` and
|
||||
`docs/homelab-integration.md` for the *per-user* secret path (the ESO/1Password reference in
|
||||
ADR-006 stands for the *infra-cred* path).
|
||||
|
||||
**Reversibility / falsification (from infra#88).** Revisit if: per-user tokens need
|
||||
high-frequency rotation writes (weak — PG18 handles it); an estate compliance policy requires
|
||||
all credentials in 1P for a single audit surface (maintainer-knowable, not currently believed
|
||||
to hold — would favour the vault-write path on policy grounds); or envelope-key rotation proves
|
||||
operationally worse than per-secret vault rotation (the real cost #89 must prove). If none hold,
|
||||
this stands. Full reasoning + rejected candidates (write-capable SA; Supabase): the infra#88
|
||||
decision doc (`infra/docs/superpowers/handoffs/`). Build + reboot-validation: infra#89.
|
||||
|
||||
---
|
||||
|
||||
## ADR-016 — Stage 0 gate revised: "useful to me OR a friend", behavioural not feedback
|
||||
|
||||
**Status:** Accepted (2026-06-03). Revises the Stage 0 definition in VISION.md (supersedes the
|
||||
original "useful to me, specifically" gate and folds in the old Stage 1 "a trusted user returns"
|
||||
test).
|
||||
|
||||
**Context.** The original Stage 0 gate was "the maintainer reads summaries weekly for four weeks
|
||||
and acts on one." The maintainer chose to change it to include friendly users, reasoning that
|
||||
early signal from friendly users is valuable. Two sub-decisions shaped the final form:
|
||||
- *Me OR a friend* (not AND): either the maintainer or an onboarded friend showing use clears it.
|
||||
- *Behavioural, not feedback*: the test is **return usage**, not stated approval.
|
||||
|
||||
**Decision.** Stage 0 passes when, over a 3–4 week window, **either the maintainer or at least
|
||||
one onboarded friend returns to Tapir unprompted and reads/acts on summaries in ≥2 separate
|
||||
weeks.** Friend feedback is gathered and valued but is **not** the gate.
|
||||
|
||||
**Why behavioural, not feedback (the load-bearing part).** Asked-for feedback from friendly
|
||||
users is the least reliable signal in product development — politeness bias means a friend you
|
||||
onboarded will tend to say encouraging things regardless of real value. The thing actually worth
|
||||
knowing is whether they *come back on their own*. So the gate measures returns, not nice words.
|
||||
This deliberately resists the most common way a principled gate dies: being declared "passed" on
|
||||
the strength of a polite reaction.
|
||||
|
||||
**Honest note on what this change does.** This is a *guardrail edit made while the original gate
|
||||
was unmet* (Stage 0 had barely started; build had run well ahead of use-evidence). That is
|
||||
precisely the pattern that warrants scrutiny — redrawing a gate around work already done. It was
|
||||
examined on that basis and proceeds because: (a) the new gate is **not softer in kind** — it
|
||||
stays behavioural and sustained, merely broadening *who* can supply the signal; (b) friendly-user
|
||||
signal is genuinely valuable; (c) the politeness-bias guard keeps it from collapsing into
|
||||
"someone said it's nice." It is *not* a licence to treat the already-shipped Stage-1 machinery as
|
||||
evidence the gate passed — use-evidence remains open.
|
||||
|
||||
**Consequences.**
|
||||
- VISION.md Stage 0 rewritten; old Stage 1 ("a trusted user returns") folded in (it was
|
||||
near-identical to the new test); hardening renumbered to Stage 1.
|
||||
- New drift signal added: declaring the gate passed on polite feedback rather than return-usage.
|
||||
- The 2026-07-01 check-in now asks "is anyone (me or a friend) coming back unprompted?", not
|
||||
"am I using it weekly?".
|
||||
|
||||
**Reversibility.** A superseding ADR could tighten it back to maintainer-only or raise it to
|
||||
require multiple returning users. Recorded with the full rationale (including the self-scrutiny
|
||||
about editing a gate while it's unmet) so the reasoning survives, not just the new wording.
|
||||
|
||||
---
|
||||
|
||||
## Rejected alternatives
|
||||
|
||||
Approaches considered during the 2026-06-02 planning + grill session and **deliberately not
|
||||
@@ -308,6 +507,9 @@ maps to the ADR that settles it.
|
||||
| Audio-download + Whisper STT in the core path | ToS-grey, breakage-prone (yt-dlp), contends for koala GPU with the JEPA PoC; captions alone test the core hypothesis | ADR-007 |
|
||||
| Building multi-tenant SaaS / Google OAuth verification now | "Real users soon" was lowered to Future B; SaaS machinery before the Stage 0 self-use gate is the primary documented anti-goal | ADR-008, VISION |
|
||||
| Delegating the S5 reuse spike to an agent swarm | A 1-hour sequential read-and-judge with a single coupled conclusion; orchestration overhead exceeds the work, and it's Diamond-1 judgment the maintainer wanted to own | (process note) |
|
||||
| Vault-write SA for per-user OAuth tokens (ESO as runtime write path) | ESO syncs vault→cluster at deploy time, not a runtime write API; a write-SA widens blast radius to shared infra to store app row-data | ADR-015, infra#88 |
|
||||
| Supabase for per-user credential storage | Adds a second datastore for a few encrypted strings PG18 already holds; reopens ADR-002 | ADR-015, infra#88 |
|
||||
| Feedback-based Stage 0 gate (friends saying it's useful) | Politeness bias makes asked-for feedback the least reliable signal; return-usage is the real test | ADR-016 |
|
||||
|
||||
If a future case genuinely reopens one of these, that's a new ADR superseding the relevant one —
|
||||
not a silent reversal.
|
||||
|
||||
@@ -44,50 +44,69 @@ fallback — their key, their choice.
|
||||
|
||||
## Who it is for
|
||||
|
||||
- **Now (the first customer):** the maintainer — one person, their own subscriptions,
|
||||
summaries delivered to their own store and brain.
|
||||
- **Soon (Future B):** a small number of known, trusted users (friends / beta) — each with
|
||||
their own account, isolated data, optional BYO-AI.
|
||||
- **Now (the first customers):** the maintainer and a small number of known, trusted
|
||||
friends — each with their own account, isolated data, optional BYO-AI. The maintainer is
|
||||
the first customer; friendly users provide the earliest real-world signal.
|
||||
- **Maybe (Future C, explicitly not built yet):** a public multi-tenant service. Deferred
|
||||
until there is evidence of sustained personal use **and** real demand. Building for C
|
||||
before that evidence is a known anti-goal.
|
||||
until there is evidence of sustained use **and** real demand. Building for C before that
|
||||
evidence is a known anti-goal.
|
||||
|
||||
## Definition of Success
|
||||
|
||||
Success is staged. Each stage has a single, falsifiable headline test. We do not advance
|
||||
to the next stage's ambition until the current stage's test passes.
|
||||
|
||||
### Stage 0 — Useful to me (the gate)
|
||||
### Stage 0 — Useful to me or a friend (the gate)
|
||||
|
||||
> **Headline test:** For four consecutive weeks, the maintainer reads Tapir-produced
|
||||
> summaries for their own subscriptions at least weekly, and at least once acts on a
|
||||
> summary (watches / skips / saves a video *because of* the summary).
|
||||
> **Headline test:** Over a 3–4 week window, *either* the maintainer *or* at least one
|
||||
> onboarded friend returns to Tapir and reads/acts on summaries in **≥2 separate weeks**.
|
||||
> The test is *return usage* (behavioural), not stated approval. The ideal signal is an
|
||||
> **unprompted** return (organic, not because the maintainer nudged them) — but see the
|
||||
> measurement note below: we currently cannot distinguish prompted from organic returns, so
|
||||
> in practice we count all returns and read the result with that caveat.
|
||||
|
||||
- Captions-first summarization works end-to-end for the maintainer's real subscriptions.
|
||||
- Summaries land in the maintainer's store and (optionally) brain.
|
||||
- Captions-first summarization works end-to-end for real subscriptions (the maintainer's
|
||||
and onboarded friends').
|
||||
- Summaries land in each user's own store and (optionally) brain.
|
||||
- Local-first AI produces summaries of acceptable quality without manual intervention
|
||||
most of the time.
|
||||
- **This is the gate.** Multi-user, BYO-AI-for-others, and any SaaS ambition stay deferred
|
||||
until Stage 0 holds. (Ties to the 2026-07-01 self-use check-in.)
|
||||
- **Why behavioural, not feedback.** Friend *feedback* is gathered and genuinely valuable —
|
||||
but it is **not** the gate. Asked-for feedback from friendly users is the least reliable
|
||||
signal in product development (politeness bias); whether they *come back* is the thing we
|
||||
actually care about. So the gate measures returns, not nice words.
|
||||
- **Measurement note — "unprompted" is an ideal we can't yet measure.** Whether a return was
|
||||
organic or prompted by a nudge is not captured by any data Tapir holds (it's context only
|
||||
the maintainer has). Rather than waive the standard, we name the gap: *unprompted* return
|
||||
is the signal we genuinely want; *returns* (prompted or not) is what the data can show. A
|
||||
return that needed a nudge is a weaker signal than one that didn't, and the result is read
|
||||
with that in mind. If distinguishing them ever matters enough, the maintainer tracks nudges
|
||||
manually or a future build records prompt events — neither is in scope now.
|
||||
- **Why "me OR a friend".** This replaces the original "useful to *me*, specifically" gate
|
||||
(2026-06-03 decision, recorded in DECISIONS.md ADR-016). Getting signal from friendly
|
||||
users is valuable enough to count — but the bar stays behavioural so it can't be cleared
|
||||
by a polite reaction. (Ties to the 2026-07-01 check-in.)
|
||||
- **How it's measured.** Return usage is read from two sources: `summary_actions` (timestamped
|
||||
watch/skip/save per user) answers "acted in ≥2 distinct weeks"; an append-only login-events
|
||||
table (see infra/Tapir build) answers "returned/read in ≥2 distinct weeks" even without an
|
||||
action click — the honest signal for a *reading* product. Login events accrue only from their
|
||||
deploy date onward, so the gate window's data begins then.
|
||||
- **This is the gate.** Hardening (Stage 1) and any SaaS ambition stay deferred until this
|
||||
behavioural signal exists. Note: multi-user machinery was deliberately built *ahead* of
|
||||
this gate (ADR-012) with isolation enforced — that was an explicit, recorded call, not a
|
||||
sign the gate had passed. The gate is about *evidence of use*, which is still open.
|
||||
|
||||
### Stage 1 — Useful to a few (Future B)
|
||||
|
||||
> **Headline test:** At least one trusted user other than the maintainer connects their
|
||||
> own account and, within their first month, keeps using it (returns to read summaries in
|
||||
> ≥2 separate weeks) without the maintainer hand-holding each summary.
|
||||
|
||||
- Multiple users, each with isolated accounts, credentials, and summaries.
|
||||
- A new user can self-connect a YouTube/Vimeo account and get summaries with no code change.
|
||||
- Optional BYO-AI works per-user.
|
||||
- No cross-user data leakage — demonstrable, not assumed.
|
||||
|
||||
### Stage 2 — Trustworthy at rest (hardening, still Future B)
|
||||
### Stage 1 — Trustworthy at rest (hardening, Future B)
|
||||
|
||||
> **Headline test:** Credentials (OAuth tokens, BYO-AI keys) are encrypted at rest via the
|
||||
> homelab's existing secrets convention; a documented, rehearsed recovery path exists; and
|
||||
> a deliberate isolation test (user A cannot read user B's data) passes in CI or a
|
||||
> documented manual drill.
|
||||
|
||||
- Per-user data isolation is enforced and tested (delivered early via ADR-012 RLS).
|
||||
- Per-user credentials are encrypted at rest (ADR-015 envelope encryption; build in infra#89).
|
||||
- A new user can self-connect a YouTube/Vimeo account and get summaries with no code change.
|
||||
- Optional BYO-AI works per-user.
|
||||
|
||||
### Non-goals (current)
|
||||
|
||||
- Public sign-up / billing / a marketing surface.
|
||||
@@ -98,7 +117,11 @@ to the next stage's ambition until the current stage's test passes.
|
||||
|
||||
## How we will know we are drifting
|
||||
|
||||
- We are building Stage 1+ machinery before the Stage 0 gate has passed.
|
||||
- We declare the Stage 0 gate "passed" on the strength of polite feedback rather than
|
||||
behavioural return-usage (the politeness-bias trap the gate is designed to resist).
|
||||
- We build Stage 1 hardening or Future C machinery while the Stage 0 use-evidence is still
|
||||
absent. (Multi-user machinery already shipped ahead of the gate via ADR-012 — a recorded,
|
||||
deliberate exception, not a precedent for more.)
|
||||
- A user's content reaches a third-party model without that user's explicit, per-user opt-in.
|
||||
- "Brain ingestion" starts dictating the architecture instead of being one sink behind an
|
||||
interface.
|
||||
|
||||
@@ -0,0 +1,61 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"gitea.d-ma.be/mathias/tapir/internal/adapters/store"
|
||||
"gitea.d-ma.be/mathias/tapir/internal/config"
|
||||
)
|
||||
|
||||
// inviteTTL is how long a minted invite stays claimable. A week is generous for a
|
||||
// human to act on an emailed link without leaving a stale capability around.
|
||||
const inviteTTL = 7 * 24 * time.Hour
|
||||
|
||||
// inviter is the narrow store capability cmdInvite needs — minting an invitation.
|
||||
// Defined here (not store) so runInvite is testable with a fake, no Postgres.
|
||||
type inviter interface {
|
||||
CreateInvitation(ctx context.Context, email string, ttl time.Duration) (string, error)
|
||||
}
|
||||
|
||||
// cmdInvite mints an invitation for an email and prints the claim URL. Host-side
|
||||
// only (no Dex session): the operator runs it, copies the link, and sends it.
|
||||
// Usage: tapir invite <email>.
|
||||
func cmdInvite(ctx context.Context, args []string) error {
|
||||
if len(args) < 1 || strings.TrimSpace(args[0]) == "" {
|
||||
return fmt.Errorf("usage: tapir invite <email>")
|
||||
}
|
||||
email := strings.TrimSpace(args[0])
|
||||
|
||||
cfg, err := config.Load()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if strings.TrimSpace(cfg.DBDSN) == "" {
|
||||
return fmt.Errorf("missing required config: TAPIR_DB_DSN")
|
||||
}
|
||||
|
||||
st, err := store.New(ctx, cfg.DBDSN)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer st.Close()
|
||||
|
||||
return runInvite(ctx, st, os.Stdout, cfg.PublicURL, email)
|
||||
}
|
||||
|
||||
// runInvite is the testable core: mint the token and print the absolute claim URL
|
||||
// to w. Pure of config/store construction so a fake inviter exercises it.
|
||||
func runInvite(ctx context.Context, inv inviter, w io.Writer, publicURL, email string) error {
|
||||
token, err := inv.CreateInvitation(ctx, email, inviteTTL)
|
||||
if err != nil {
|
||||
return fmt.Errorf("create invitation: %w", err)
|
||||
}
|
||||
base := strings.TrimRight(strings.TrimSpace(publicURL), "/")
|
||||
_, err = fmt.Fprintf(w, "Invite URL (valid 7 days):\n%s/invite/%s\n", base, token)
|
||||
return err
|
||||
}
|
||||
@@ -0,0 +1,59 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
// fakeInviter records the mint call and returns a canned token.
|
||||
type fakeInviter struct {
|
||||
token string
|
||||
err error
|
||||
gotEmail string
|
||||
gotTTL time.Duration
|
||||
callCount int
|
||||
}
|
||||
|
||||
func (f *fakeInviter) CreateInvitation(_ context.Context, email string, ttl time.Duration) (string, error) {
|
||||
f.callCount++
|
||||
f.gotEmail, f.gotTTL = email, ttl
|
||||
return f.token, f.err
|
||||
}
|
||||
|
||||
func TestRunInvitePrintsURL(t *testing.T) {
|
||||
inv := &fakeInviter{token: "deadbeefcafe"}
|
||||
var out strings.Builder
|
||||
|
||||
err := runInvite(context.Background(), inv, &out, "https://tapir.d-ma.be", "new@example.com")
|
||||
require.NoError(t, err)
|
||||
|
||||
require.Equal(t, "new@example.com", inv.gotEmail)
|
||||
require.Equal(t, inviteTTL, inv.gotTTL)
|
||||
got := out.String()
|
||||
require.Contains(t, got, "https://tapir.d-ma.be/invite/deadbeefcafe")
|
||||
require.Contains(t, got, "valid 7 days")
|
||||
}
|
||||
|
||||
func TestRunInviteTrimsTrailingSlash(t *testing.T) {
|
||||
inv := &fakeInviter{token: "tok"}
|
||||
var out strings.Builder
|
||||
|
||||
err := runInvite(context.Background(), inv, &out, "https://tapir.d-ma.be/", "x@example.com")
|
||||
require.NoError(t, err)
|
||||
require.Contains(t, out.String(), "https://tapir.d-ma.be/invite/tok")
|
||||
require.NotContains(t, out.String(), "//invite")
|
||||
}
|
||||
|
||||
func TestRunInvitePropagatesError(t *testing.T) {
|
||||
inv := &fakeInviter{err: errors.New("db down")}
|
||||
var out strings.Builder
|
||||
|
||||
err := runInvite(context.Background(), inv, &out, "https://tapir.d-ma.be", "x@example.com")
|
||||
require.Error(t, err)
|
||||
require.Empty(t, out.String())
|
||||
}
|
||||
+43
-22
@@ -22,15 +22,12 @@ import (
|
||||
"os/signal"
|
||||
"time"
|
||||
|
||||
"gitea.d-ma.be/mathias/tapir/internal/adapters/llm"
|
||||
"gitea.d-ma.be/mathias/tapir/internal/adapters/dex"
|
||||
"gitea.d-ma.be/mathias/tapir/internal/adapters/secrets"
|
||||
"gitea.d-ma.be/mathias/tapir/internal/adapters/store"
|
||||
"gitea.d-ma.be/mathias/tapir/internal/adapters/summarizer"
|
||||
"gitea.d-ma.be/mathias/tapir/internal/adapters/youtube"
|
||||
"gitea.d-ma.be/mathias/tapir/internal/auth"
|
||||
"gitea.d-ma.be/mathias/tapir/internal/config"
|
||||
"gitea.d-ma.be/mathias/tapir/internal/runner"
|
||||
"gitea.d-ma.be/mathias/tapir/internal/usecase"
|
||||
"gitea.d-ma.be/mathias/tapir/internal/web"
|
||||
"gitea.d-ma.be/mathias/tapir/internal/web/oidc"
|
||||
)
|
||||
@@ -57,6 +54,8 @@ func main() {
|
||||
err = cmdRun(ctx, log)
|
||||
case "serve":
|
||||
err = cmdServe(ctx, log)
|
||||
case "invite":
|
||||
err = cmdInvite(ctx, os.Args[2:])
|
||||
default:
|
||||
usage()
|
||||
os.Exit(2)
|
||||
@@ -75,6 +74,7 @@ usage:
|
||||
tapir auth one-time: authorize YouTube and store a refresh token
|
||||
tapir run detect new videos, summarize, deliver to your store
|
||||
tapir serve run the web UI (read summaries, record watch/skip/save)
|
||||
tapir invite <email> mint an invitation link for a new user (host-side)
|
||||
tapir list [-limit N] list stored summaries, recent first
|
||||
tapir show <video-id> show one summary in full
|
||||
|
||||
@@ -120,27 +120,19 @@ func cmdRun(ctx context.Context, log *slog.Logger) error {
|
||||
}
|
||||
defer st.Close()
|
||||
|
||||
secretStore := secrets.NewFileStore(cfg.SecretsFile)
|
||||
src := youtube.New(youtube.Config{
|
||||
ClientID: cfg.YTClientID,
|
||||
ClientSecret: cfg.YTClientSecret,
|
||||
TokenSecretRef: cfg.YTTokenRef,
|
||||
PreferredLanguages: []string{"en"},
|
||||
}, secretStore)
|
||||
|
||||
// Local Primary only; no BYO fallback for the demo (fallback nil).
|
||||
primary := summarizer.Endpoint{
|
||||
Client: llm.New(cfg.GatewayURL, cfg.GatewayKey, cfg.SummarizerModel, cfg.SummarizerTimeout),
|
||||
Provider: "local",
|
||||
Model: cfg.SummarizerModel,
|
||||
// Same wiring the web serve path uses (buildProcessor). ValidateForRun above
|
||||
// already required the engine's inputs, so a nil here is a genuine config gap.
|
||||
engine, err := buildProcessor(cfg, st)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
sum := summarizer.New(primary, nil)
|
||||
|
||||
engine := usecase.NewEngine(src, sum, st)
|
||||
r := runner.New(src, st, engine, cfg.UserID, log)
|
||||
if engine == nil {
|
||||
return fmt.Errorf("run: incomplete summarization config (gateway, youtube credentials, secrets file)")
|
||||
}
|
||||
r := runner.New(engine.Source, st, engine, cfg.UserID, log, runner.WithBackoff(cfg.FetchBackoff))
|
||||
|
||||
log.Info("starting run", "user", cfg.UserID, "model", cfg.SummarizerModel,
|
||||
"gateway", cfg.GatewayURL, "poll_interval", cfg.PollInterval)
|
||||
"gateway", cfg.GatewayURL, "poll_interval", cfg.PollInterval, "fetch_backoff", cfg.FetchBackoff)
|
||||
return r.Loop(ctx, cfg.PollInterval)
|
||||
}
|
||||
|
||||
@@ -191,6 +183,20 @@ func cmdServe(ctx context.Context, log *slog.Logger) error {
|
||||
secretStore := secrets.NewFileStore(cfg.SecretsFile)
|
||||
app := &web.App{Store: st, Identity: st, Auth: authn, Secrets: secretStore, Log: log}
|
||||
|
||||
// Email-invite onboarding (public /invite/{token}). The store validates and
|
||||
// consumes tokens; the Dex client creates the local-password account. In-cluster
|
||||
// the SA token mount is present and account creation works; off-cluster (dev) it
|
||||
// is nil and the submit handler degrades to a clear "deployed-only" message.
|
||||
app.Invitations = st
|
||||
if dexClient, err := dex.NewPasswordClient(); err == nil {
|
||||
app.Dex = dexClient
|
||||
log.Info("invite account creation enabled (in-cluster dex password client)")
|
||||
} else if errors.Is(err, dex.ErrNotInCluster) {
|
||||
log.Warn("invite account creation disabled: not in-cluster — /invite is deployed-only")
|
||||
} else {
|
||||
return fmt.Errorf("dex password client: %w", err)
|
||||
}
|
||||
|
||||
// Web-initiated YouTube connect (ADR-006). Mounted only when the OAuth client
|
||||
// credentials are present; the refresh token persists through the SecretStore
|
||||
// under a per-user ref (web.YouTubeTokenRef). Live connect also needs the
|
||||
@@ -204,6 +210,21 @@ func cmdServe(ctx context.Context, log *slog.Logger) error {
|
||||
log.Info("web youtube connect enabled", "redirect", cfg.YTConnectRedirectURL)
|
||||
}
|
||||
|
||||
// Immediate summarization for the web "Summarize" button. When the engine can
|
||||
// be built (gateway + YouTube credentials + secrets present), a click runs the
|
||||
// summary now in the background; otherwise the button stays queue-only and the
|
||||
// next `tapir run` does the work (buildProcessor returns nil — never an error).
|
||||
engine, err := buildProcessor(cfg, st)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if engine != nil {
|
||||
app.Processor = &engineProcessor{engine: engine, store: st}
|
||||
log.Info("web immediate summarization enabled", "model", cfg.SummarizerModel)
|
||||
} else {
|
||||
log.Info("web summarization is queue-only (incomplete engine config)")
|
||||
}
|
||||
|
||||
srv := &http.Server{
|
||||
Addr: cfg.HTTPAddr,
|
||||
Handler: app.Router(),
|
||||
|
||||
@@ -0,0 +1,86 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
|
||||
"gitea.d-ma.be/mathias/tapir/internal/adapters/llm"
|
||||
"gitea.d-ma.be/mathias/tapir/internal/adapters/secrets"
|
||||
"gitea.d-ma.be/mathias/tapir/internal/adapters/store"
|
||||
"gitea.d-ma.be/mathias/tapir/internal/adapters/summarizer"
|
||||
"gitea.d-ma.be/mathias/tapir/internal/adapters/youtube"
|
||||
"gitea.d-ma.be/mathias/tapir/internal/config"
|
||||
"gitea.d-ma.be/mathias/tapir/internal/domain"
|
||||
"gitea.d-ma.be/mathias/tapir/internal/usecase"
|
||||
)
|
||||
|
||||
// buildProcessor wires the summarization engine — YouTube source (captions-first),
|
||||
// AI-router summarizer, store sink — shared by `tapir run` and the web
|
||||
// "Summarize now" path so the wiring lives in one place. It returns (nil, nil) —
|
||||
// not an error — when the config cannot support live summarization (no gateway
|
||||
// URL, no YouTube client credentials, or no secrets file). That nil is the
|
||||
// queue-only fallback: the web UI keeps working (the button just queues) and
|
||||
// `tapir run` reports the gap via its own ValidateForRun. Missing engine config
|
||||
// is never an error here.
|
||||
func buildProcessor(cfg config.Config, st *store.Store) (*usecase.Engine, error) {
|
||||
if cfg.GatewayURL == "" || cfg.YTClientID == "" || cfg.YTClientSecret == "" || cfg.SecretsFile == "" {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
secretStore := secrets.NewFileStore(cfg.SecretsFile)
|
||||
src := youtube.New(youtube.Config{
|
||||
ClientID: cfg.YTClientID,
|
||||
ClientSecret: cfg.YTClientSecret,
|
||||
TokenSecretRef: cfg.YTTokenRef,
|
||||
PreferredLanguages: []string{"en"},
|
||||
}, secretStore)
|
||||
|
||||
// Local Primary only; no BYO fallback for the demo (fallback nil).
|
||||
primary := summarizer.Endpoint{
|
||||
Client: llm.New(cfg.GatewayURL, cfg.GatewayKey, cfg.SummarizerModel, cfg.SummarizerTimeout),
|
||||
Provider: "local",
|
||||
Model: cfg.SummarizerModel,
|
||||
}
|
||||
sum := summarizer.New(primary, nil)
|
||||
|
||||
return usecase.NewEngine(src, sum, st), nil
|
||||
}
|
||||
|
||||
// engineProcessor adapts the engine (which works in terms of a domain.Video) to
|
||||
// the web.Processor port (which works in terms of a stored video id): it loads the
|
||||
// video row, runs the engine, and — on a produced summary — clears the manual
|
||||
// queue flag, mirroring the runner so the video is not re-summarized on the next
|
||||
// `tapir run` and the UI drops the "Queued" chip. A skip (no transcript) leaves
|
||||
// the flag set so a later run can retry.
|
||||
type engineProcessor struct {
|
||||
engine *usecase.Engine
|
||||
store *store.Store
|
||||
}
|
||||
|
||||
func (p *engineProcessor) ProcessVideo(ctx context.Context, userID, videoID string) error {
|
||||
row, err := p.store.GetVideoRow(ctx, userID, videoID)
|
||||
if err != nil {
|
||||
return fmt.Errorf("load video %q: %w", videoID, err)
|
||||
}
|
||||
|
||||
v := domain.Video{
|
||||
ID: row.VideoID,
|
||||
UserID: userID,
|
||||
Provider: domain.Provider(row.Channel),
|
||||
ProviderVideoID: row.ProviderVideoID,
|
||||
Title: row.Title,
|
||||
URL: row.URL,
|
||||
PublishedAt: row.PublishedAt,
|
||||
}
|
||||
|
||||
res, err := p.engine.ProcessNewVideo(ctx, v)
|
||||
if err != nil {
|
||||
return fmt.Errorf("process video %q: %w", videoID, err)
|
||||
}
|
||||
if res.Summary != nil {
|
||||
if err := p.store.ClearSummarizeRequested(ctx, userID, videoID); err != nil {
|
||||
return fmt.Errorf("clear summarize flag %q: %w", videoID, err)
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
@@ -0,0 +1,47 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"gitea.d-ma.be/mathias/tapir/internal/config"
|
||||
)
|
||||
|
||||
// TestBuildProcessorNilOnIncompleteConfig asserts the queue-only fallback: when a
|
||||
// required input is missing, buildProcessor returns (nil, nil) — never an error —
|
||||
// so the web UI degrades to queue-only instead of failing to start.
|
||||
func TestBuildProcessorNilOnIncompleteConfig(t *testing.T) {
|
||||
// A complete config (the fields buildProcessor gates on). The store is nil:
|
||||
// buildProcessor must not touch it on the incomplete paths, and the complete
|
||||
// path only stores the pointer (no connection), so nil is fine for this test.
|
||||
complete := config.Config{
|
||||
GatewayURL: "http://gw/v1",
|
||||
YTClientID: "id",
|
||||
YTClientSecret: "secret",
|
||||
SecretsFile: "/tmp/secrets.json",
|
||||
}
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
mutate func(config.Config) config.Config
|
||||
wantNil bool
|
||||
}{
|
||||
{"complete", func(c config.Config) config.Config { return c }, false},
|
||||
{"no gateway url", func(c config.Config) config.Config { c.GatewayURL = ""; return c }, true},
|
||||
{"no yt client id", func(c config.Config) config.Config { c.YTClientID = ""; return c }, true},
|
||||
{"no yt client secret", func(c config.Config) config.Config { c.YTClientSecret = ""; return c }, true},
|
||||
{"no secrets file", func(c config.Config) config.Config { c.SecretsFile = ""; return c }, true},
|
||||
{"empty config", func(config.Config) config.Config { return config.Config{} }, true},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
engine, err := buildProcessor(tt.mutate(complete), nil)
|
||||
if err != nil {
|
||||
t.Fatalf("buildProcessor returned an error, want nil: %v", err)
|
||||
}
|
||||
if (engine == nil) != tt.wantNil {
|
||||
t.Fatalf("engine == nil is %v, want %v", engine == nil, tt.wantNil)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
@@ -45,7 +45,7 @@ adapter behind an interface (Clean Architecture ports & adapters).
|
||||
```mermaid
|
||||
graph TB
|
||||
subgraph tapir["Tapir (Go)"]
|
||||
http["HTTP server<br/>OAuth callbacks +<br/>user-facing API"]
|
||||
http["tapir serve<br/>(HTMX+Templ web surface:<br/>read summaries, connect,<br/>account, summarize)"]
|
||||
watcher["Watcher<br/>detects new videos<br/>(WebSub + poll)"]
|
||||
engine["Summarization engine<br/>(use-case core)"]
|
||||
resolver["Transcript resolver<br/>(captions-first)"]
|
||||
@@ -95,6 +95,66 @@ two codebases (ADR-003).
|
||||
|
||||
---
|
||||
|
||||
## Web surface — `tapir serve` (Stage 1, ADR-011 → ADR-012)
|
||||
|
||||
A later transport added over the **unchanged** engine/ports/sinks core (ADR-003): `tapir serve`
|
||||
is an HTMX+Templ reader/writer (`internal/web`) over the existing `store`. It added no business
|
||||
logic to the engine — it reads the store and, for one action, kicks the existing engine. ADR-011
|
||||
shipped it single-user; ADR-012 opened multi-user with DB-enforced (RLS) isolation.
|
||||
|
||||
```mermaid
|
||||
graph TB
|
||||
browser["Browser<br/>(Dex-authenticated user)"]
|
||||
subgraph web["internal/web (tapir serve)"]
|
||||
oidc["oidc<br/>Dex OIDC session<br/>(authenticate-only)"]
|
||||
gate["registration gate<br/>new subject -> /register"]
|
||||
pages["summary list + detail<br/>(read) + actions"]
|
||||
connect["/oauth/youtube/callback<br/>per-user token connect"]
|
||||
account["account<br/>(disconnect, delete)"]
|
||||
summarize["Summarize button<br/>-> background goroutine"]
|
||||
end
|
||||
store[("store<br/>(Postgres, RLS per user)")]
|
||||
engine["Summarization engine<br/>(unchanged core)"]
|
||||
secrets["SecretStore<br/>(per-user token refs)"]
|
||||
|
||||
browser --> oidc
|
||||
oidc --> gate
|
||||
gate --> pages
|
||||
pages --> store
|
||||
connect --> secrets
|
||||
connect --> store
|
||||
account --> store
|
||||
account --> secrets
|
||||
summarize -->|background| engine
|
||||
summarize -->|HTMX status poll| store
|
||||
engine --> store
|
||||
```
|
||||
|
||||
- **Dex OIDC session layer** (`internal/web/oidc`) — **authenticate-only** (ADR-012). It proves
|
||||
*who*; authorization/isolation is the DB's job (RLS), not the session's.
|
||||
- **Registration gate** — a Dex subject with no `users` row is routed to `/register`, which
|
||||
creates the `users` row + the `user_identities` mapping (migration 004). Returning subjects
|
||||
pass straight through.
|
||||
- **Web-initiated YouTube connect** — `/oauth/youtube/connect` → `/oauth/youtube/callback`
|
||||
persists a **per-user** refresh-token ref (`youtube/<userID>/refresh_token`) via `SecretStore`
|
||||
and a `video_connections` row (ADR-006, migration 005). Distinct from the CLI `tapir auth`.
|
||||
- **Account management** — `/account` offers disconnect and **delete account**. Delete removes
|
||||
only Tapir-side state (cascade across the user's tables + secret refs); the shared Dex identity
|
||||
is left intact (ADR-013).
|
||||
- **Immediate summarization** — the web "Summarize" button (`POST /v/{id}/summarize`) fires the
|
||||
engine in a **background goroutine** inside `serve`; the page HTMX-polls `/v/{id}/status`,
|
||||
showing a Charmbracelet spinner while in-flight (and an honest "queued/waiting" state under
|
||||
rate-limiting — ADR-014).
|
||||
- **Summarization mode** — `users.auto_summarize` (migration 006). Auto: every new video is
|
||||
summarized. Manual (default): new videos appear unsummarized; the button sets
|
||||
`videos.summarize_requested`, which the next `tapir run` processes and clears. Both the click
|
||||
path and the batch `tapir run` drive the same unchanged engine.
|
||||
|
||||
The engine, ports, and sink adapters are **untouched** by all of the above — the web surface only
|
||||
reads the store and triggers the existing engine. Adding it changed wiring, not the core (ADR-003).
|
||||
|
||||
---
|
||||
|
||||
## Sequence — core use case: new video summarized
|
||||
|
||||
```mermaid
|
||||
@@ -191,6 +251,8 @@ Gherkin features in `docs/use-cases/`).
|
||||
|
||||
- Audio-download + speech-to-text resolver (ADR-007) — would be an additional `VideoSource`
|
||||
fallback path, drawn when built.
|
||||
- Multi-tenant isolation primitives (per-tenant Postgres role, NetworkPolicy, tenant label)
|
||||
— activate at Stage 1 (ADR-002); single-user Stage 0 doesn't exercise them.
|
||||
- Per-user isolation is **live, not deferred**: Postgres RLS `FORCE`d on every user-owned table
|
||||
(ADR-012, migration 003), realising ADR-002's per-tenant intent at the DB layer. The coarser
|
||||
multi-tenant primitives (per-namespace NetworkPolicy, Kyverno, tenant label) remain a
|
||||
Stage-2 hardening item, not exercised yet.
|
||||
- Public SaaS surface (sign-up, billing) — Future C, not built (ADR-008).
|
||||
|
||||
+87
-23
@@ -23,11 +23,16 @@ only opaque references to them; the secret material lives in ESO/1Password (ADR-
|
||||
|
||||
## Entities
|
||||
|
||||
Solid entities below are **persisted today** (migrations 001–006). `AI_CREDENTIAL` and
|
||||
`SUBSCRIPTION` are **planned, not yet a table** — kept in the model for intent; see the notes.
|
||||
|
||||
```mermaid
|
||||
erDiagram
|
||||
USER ||--|| USER_IDENTITY : "logs in via (Dex subject)"
|
||||
USER ||--o{ VIDEO_CONNECTION : has
|
||||
USER ||--o{ AI_CREDENTIAL : has
|
||||
VIDEO_CONNECTION ||--o{ SUBSCRIPTION : exposes
|
||||
USER ||--o{ SUMMARY_ACTION : records
|
||||
USER ||--o{ AI_CREDENTIAL : "has (planned)"
|
||||
VIDEO_CONNECTION ||--o{ SUBSCRIPTION : "exposes (planned)"
|
||||
SUBSCRIPTION ||--o{ VIDEO : "produces (per user)"
|
||||
VIDEO ||--o| TRANSCRIPT : "has at most one"
|
||||
VIDEO ||--o| SUMMARY : "has at most one"
|
||||
@@ -36,14 +41,20 @@ erDiagram
|
||||
USER {
|
||||
uuid id PK
|
||||
text display_name
|
||||
bool auto_summarize "default false -> manual mode out of the box (migration 006)"
|
||||
timestamptz created_at
|
||||
}
|
||||
USER_IDENTITY {
|
||||
text dex_subject PK
|
||||
uuid user_id FK "UNIQUE -> USER, ON DELETE CASCADE; NOT RLS-enabled"
|
||||
timestamptz created_at
|
||||
}
|
||||
VIDEO_CONNECTION {
|
||||
uuid id PK
|
||||
uuid user_id FK
|
||||
uuid user_id FK "-> USER, ON DELETE CASCADE"
|
||||
text provider "youtube | vimeo"
|
||||
text provider_account
|
||||
text token_secret_ref "-> SecretStore, never the token"
|
||||
text provider_account "nullable"
|
||||
text token_ref "-> SecretStore, never the token"
|
||||
text status "active | revoked | error"
|
||||
timestamptz connected_at
|
||||
}
|
||||
@@ -66,14 +77,15 @@ erDiagram
|
||||
}
|
||||
VIDEO {
|
||||
uuid id PK
|
||||
uuid user_id FK
|
||||
uuid subscription_id FK
|
||||
uuid user_id FK "-> USER, ON DELETE CASCADE"
|
||||
uuid subscription_id "nullable; no FK at Stage 0"
|
||||
text provider
|
||||
text provider_video_id
|
||||
text title
|
||||
int duration_s
|
||||
timestamptz published_at
|
||||
text url
|
||||
bool summarize_requested "default false -> manual-mode queue flag (migration 006)"
|
||||
timestamptz seen_at
|
||||
}
|
||||
TRANSCRIPT {
|
||||
@@ -87,7 +99,7 @@ erDiagram
|
||||
SUMMARY {
|
||||
uuid id PK
|
||||
uuid user_id FK
|
||||
uuid video_id FK
|
||||
uuid video_id "no FK to videos; (user_id, video_id) UNIQUE is the dedup key"
|
||||
text summary
|
||||
jsonb highlights
|
||||
jsonb takeaways
|
||||
@@ -98,26 +110,53 @@ erDiagram
|
||||
}
|
||||
SINK_DELIVERY {
|
||||
uuid id PK
|
||||
uuid summary_id FK
|
||||
uuid summary_id FK "-> SUMMARY, ON DELETE CASCADE; ownership derived via this FK"
|
||||
text sink "store | brain"
|
||||
text status "pending | delivered | error"
|
||||
text detail "nullable; error message etc"
|
||||
timestamptz updated_at
|
||||
}
|
||||
SUMMARY_ACTION {
|
||||
uuid id PK
|
||||
uuid user_id FK "-> USER"
|
||||
text video_id "TEXT, not FK (mirrors summaries' standalone key)"
|
||||
text action "watched | skipped | saved"
|
||||
timestamptz acted_at
|
||||
}
|
||||
```
|
||||
|
||||
`SUMMARY_ACTION` has `UNIQUE (user_id, video_id, action)`; `VIDEO_CONNECTION` has
|
||||
`UNIQUE (user_id, provider)` (one connection per provider — reconnect upserts in place).
|
||||
RLS (`ENABLE` + `FORCE`) is on **every solid user-owned table above** — `users`, `videos`,
|
||||
`transcripts`, `summaries`, `summary_actions`, `video_connections`. `sink_deliveries` is
|
||||
RLS'd via an `EXISTS` on its parent summary; `user_identities` is intentionally **not** RLS'd
|
||||
(auth plumbing). See the *Isolation invariant* section for the mechanism.
|
||||
|
||||
## Notes per entity
|
||||
|
||||
- **USER** — at Stage 0 there is exactly one row. At Stage 1, identity comes via Dex; this
|
||||
table holds the Tapir-side profile keyed to the Dex subject.
|
||||
- **VIDEO_CONNECTION** — a connected YouTube/Vimeo account. `token_secret_ref` resolves to
|
||||
the OAuth refresh token via `SecretStore`. Revocation flips `status`, doesn't delete history.
|
||||
- **AI_CREDENTIAL** — optional, per provider, per user (ADR-004's Fallback). Absent for users
|
||||
who only use the local stack. One row per provider max.
|
||||
- **SUBSCRIPTION** — a watched channel. `websub_expires` tracks the YouTube push lease so the
|
||||
watcher knows when to re-subscribe; null for poll-based (Vimeo).
|
||||
- **USER** — one row per registered user (Stage 1, ADR-012; no longer single-row). The Tapir-side
|
||||
profile; the Dex identity is held separately in `USER_IDENTITY`, not on this row. `auto_summarize`
|
||||
(migration 006) is the per-user mode flag: `FALSE` (default) = manual, `TRUE` = auto-summarize
|
||||
every new video.
|
||||
- **USER_IDENTITY** (migration 004) — the `dex_subject → user_id` map. `dex_subject` is the PK,
|
||||
`user_id` a `UNIQUE` FK to `users` with `ON DELETE CASCADE`. This is the bridge resolved at login
|
||||
*before* a `user_id` is known, so it is **deliberately not RLS-enabled** (it holds no user data;
|
||||
RLS here would deadlock the lookup that yields the id used for scoping). Account deletion cascades
|
||||
the mapping away (ADR-013).
|
||||
- **VIDEO_CONNECTION** (migration 005) — a connected YouTube/Vimeo account. `token_ref` resolves to
|
||||
the OAuth refresh token via `SecretStore` (per-user scheme `youtube/<userID>/refresh_token`).
|
||||
`UNIQUE (user_id, provider)`: one connection per provider, reconnect upserts. Revocation/disconnect
|
||||
flips `status`, doesn't delete history. FORCE RLS'd.
|
||||
- **AI_CREDENTIAL** — *planned, no table yet.* Optional, per provider, per user (ADR-004's Fallback).
|
||||
BYO keys are currently resolved via `SecretStore` refs without a dedicated table; this entity is
|
||||
modelled for when per-credential metadata is needed.
|
||||
- **SUBSCRIPTION** — *planned, no table yet.* A watched channel; `websub_expires` would track the
|
||||
YouTube push lease. At Stage 0/1 `videos.subscription_id` is a nullable column with **no FK** (the
|
||||
subscriptions table is not part of the shipped store-sink slice — migration 001).
|
||||
- **VIDEO** — one row per (user, video) — note `user_id`, reflecting the per-user-isolation
|
||||
decision. The same video seen by two users is two rows. `seen_at` is when Tapir detected it.
|
||||
`summarize_requested` (migration 006) is the manual-mode queue flag: the web "Summarize" button
|
||||
sets it `TRUE`; the next `tapir run` picks it up, summarizes, and clears it back to `FALSE`.
|
||||
- **TRANSCRIPT** — at most one per video. `source = none` records "checked, no usable
|
||||
transcript" so the watcher doesn't reprocess (ADR-007). `content` null in that case.
|
||||
- **SUMMARY** — at most one per video. `fallback_used` + `ai_provider`/`ai_model` make the
|
||||
@@ -125,14 +164,39 @@ erDiagram
|
||||
`takeaways` as jsonb to stay schema-flexible while the output format settles.
|
||||
- **SINK_DELIVERY** — one row per (summary, sink) attempt. This is where "also sent to brain"
|
||||
lives — no brain tables, just a delivery row with `sink = brain`. Sinks fail independently;
|
||||
a failed brain delivery doesn't fail the store delivery.
|
||||
a failed brain delivery doesn't fail the store delivery. No own `user_id`; RLS ownership is
|
||||
derived from the parent summary via `EXISTS` (migration 003).
|
||||
- **SUMMARY_ACTION** (migration 002) — records the maintainer's act on a summary (watch / skip /
|
||||
save) — the column that makes the Stage-0 headline metric ("acts on ≥1 summary") queryable
|
||||
(ui-spec.md §5, ADR-011). `video_id` is `TEXT` and **not** FK-constrained, mirroring summaries'
|
||||
standalone `(user_id, video_id)` key. `UNIQUE (user_id, video_id, action)`. FORCE RLS'd.
|
||||
|
||||
## Isolation invariant (Stage 1+)
|
||||
## Isolation invariant (Stage 1+) — LIVE
|
||||
|
||||
Every user-owned table carries `user_id`. At Stage 1, this is enforced at the DB layer via a
|
||||
per-tenant Postgres role + row grants (architecture review SC7), not only in application code.
|
||||
At Stage 0 (single user) the column exists but the enforcement is dormant. The isolation test
|
||||
in VISION Stage 2 asserts user A cannot read user B's rows.
|
||||
Every user-owned table carries `user_id`, and isolation is **enforced at the DB layer**, not
|
||||
only in application code. ADR-011 shipped this surface single-user (one allowlisted subject,
|
||||
enforcement dormant); **ADR-012 opened Stage 1 and turned enforcement on in the same slice.**
|
||||
|
||||
Enforcement is **Postgres Row-Level Security** (migration `003_rls.up.sql`):
|
||||
|
||||
- RLS is `ENABLE`d **and** `FORCE`d on every user-owned table — `users`, `videos`,
|
||||
`transcripts`, `summaries`, `summary_actions`, `video_connections`. `FORCE` is load-bearing:
|
||||
the app connects as the table **owner** (`tapir` role), and owners bypass RLS unless forced.
|
||||
- Each policy keys off the per-request GUC `tapir.current_user_id`, set transaction-locally by
|
||||
the store's `withUser` helper via `set_config('tapir.current_user_id', $1, true)` — it
|
||||
auto-resets on commit/rollback, so it never leaks across a pooled connection.
|
||||
- `current_setting('tapir.current_user_id', true)` uses `missing_ok = true`: an **unset** GUC
|
||||
yields `NULL`, the predicate matches no rows, and access **denies by default**.
|
||||
- `sink_deliveries` has no `user_id`; its policy derives ownership from the parent summary via
|
||||
`EXISTS (SELECT 1 FROM summaries …)`.
|
||||
- `user_identities` (the Dex-subject → user_id map) is **deliberately not RLS-enabled** — it is
|
||||
auth plumbing read *before* a user_id is known; putting RLS there would deadlock. It holds no
|
||||
user data.
|
||||
|
||||
The Stage-2 isolation bar is **pulled forward, not deferred**: `internal/adapters/store/rls_test.go`
|
||||
runs two users against a non-superuser, non-`BYPASSRLS` role and asserts user A reads/writes zero
|
||||
of user B's rows across every table. It ships green with the multi-user features (ADR-012); no
|
||||
multi-user feature merges ahead of it passing.
|
||||
|
||||
## Job / processing state
|
||||
|
||||
|
||||
@@ -0,0 +1,153 @@
|
||||
# Spec — Landing page + documentation reconciliation
|
||||
|
||||
**Date:** 2026-06-03
|
||||
**Status:** Ready to build
|
||||
**Scope:** Two parallel workstreams — (A) a public landing page; (B) reconciling the
|
||||
requirements / use-case / architecture / data-model docs against the deployed reality
|
||||
(v0.4.0). These are separate concerns; do not let one worker do both, or the audit gets
|
||||
done cursorily.
|
||||
|
||||
All work: read `CLAUDE.md` + `DECISIONS.md` first. TBD — commit directly to `main`, one
|
||||
logical change per commit, conventional commits, `task check` green before every commit.
|
||||
After editing any `.templ`, run `templ generate` (the repo commits both `views.templ` and the
|
||||
generated `views_templ.go`).
|
||||
|
||||
---
|
||||
|
||||
## Workstream A — Public landing page
|
||||
|
||||
### Goal
|
||||
A public landing page at `/welcome`, in the established bubbletea aesthetic, that lets a
|
||||
visitor sign in (one Dex flow) and, if already logged in, jump to their Tapir page or log out.
|
||||
New public transport surface only — no engine/core change (ADR-003).
|
||||
|
||||
### Verified facts (read from `internal/web/oidc/oidc.go` @ main — do not re-guess)
|
||||
- Auth endpoints are exactly `/auth/login`, `/auth/callback`, `/auth/logout`.
|
||||
- `isPublicPath(p)` = `p == "/healthz" || strings.HasPrefix(p, "/auth/")` — the single
|
||||
public-route chokepoint inside `DexAuth.Middleware`.
|
||||
- `DexAuth.CurrentUser(r) (web.User, bool)` reads the session cookie and does NOT redirect —
|
||||
this is the "peek" the landing page uses to branch logged-in vs logged-out.
|
||||
- `handleCallback` redirects to `/` on success (correct — leave as-is).
|
||||
- `handleLogout` currently redirects to `loginPath` (`/auth/login`) — this is wrong for this
|
||||
feature (see A3).
|
||||
- There is NO separate "sign up" against Dex/OIDC: one authorization flow. Registration is
|
||||
Tapir's own `/register` step (ADR-012), reached after first login for an unknown subject.
|
||||
|
||||
### Tasks
|
||||
**A1 — make `/welcome` public.** In `oidc.go`, extend `isPublicPath`:
|
||||
```go
|
||||
func isPublicPath(p string) bool {
|
||||
return p == "/healthz" || p == "/welcome" || strings.HasPrefix(p, "/auth/")
|
||||
}
|
||||
```
|
||||
|
||||
**A2 — unauthenticated bare-`/` → `/welcome`; deep links unchanged.** In `DexAuth.Middleware`,
|
||||
the unauthenticated branch currently always calls `redirectToLogin`. Change it so that when
|
||||
`r.URL.Path == "/"` an unauthenticated visitor is redirected to `/welcome`; for any other
|
||||
guarded path keep `redirectToLogin` (so a shared `/v/{id}` deep link still bounces through Dex
|
||||
and returns to the destination). Keep the `isPublicPath` check first (redirect-loop guard).
|
||||
|
||||
**A3 — logout lands on `/welcome`, not login.** In `handleLogout`, change the final redirect
|
||||
from `loginPath` to `/welcome`. As written it sends the user to `/auth/login`, which
|
||||
immediately starts a fresh Dex login — visibly failing to log out. This intentionally breaks
|
||||
the existing logout test (oidc_test.go) which asserts redirect to `/auth/login`; update that
|
||||
test to expect `/welcome`. That break is expected, not a regression.
|
||||
|
||||
**A4 — mount the landing handler** in `internal/web/handlers.go` `Router()`, on `root`,
|
||||
OUTSIDE `Auth.Middleware`, alongside `/healthz`:
|
||||
```go
|
||||
root.HandleFunc("GET /welcome", a.handleWelcome)
|
||||
```
|
||||
`handleWelcome` peeks `a.Auth.CurrentUser(r)` and renders `WelcomePage(user, ok)`. Not behind
|
||||
`Auth.Middleware` or `registrationGate`.
|
||||
|
||||
**A5 — `WelcomePage` templ component** in `views.templ`. Reuse the existing shared
|
||||
layout/header partial and the established aesthetic (#7653FC purple rounded ╭─╮╰─╯ box, pink
|
||||
tapir mascot, #0EF9B6 mint accents) — match the existing pages, do not reinvent styling.
|
||||
- Logged out (`ok == false`): tapir mascot + tagline; one primary CTA **"Get Started"** →
|
||||
`/auth/login`; honest sub-text: "New here? You'll set up your account right after signing in
|
||||
— returning users go straight through." One button only (see verified facts: no separate
|
||||
Dex sign-up; two buttons to the same URL would mislead).
|
||||
- Logged in (`ok == true`): "Go to my Tapir" → `/`; "Log Out" → `/auth/logout`. May greet via
|
||||
`user.Email`.
|
||||
|
||||
**A6 — tests** (extend `handlers_test.go` patterns). Note `StubAuth.CurrentUser` always returns
|
||||
true; for the logged-out case use a fake Auth returning `(web.User{}, false)`.
|
||||
- `GET /welcome`, no session → "Get Started" → `/auth/login`.
|
||||
- `GET /welcome`, with session → "Go to my Tapir" + "Log Out".
|
||||
- Unauthenticated `GET /` → 302 `/welcome`.
|
||||
- Unauthenticated `GET /v/{id}` → still 302 `/auth/login` (deep link preserved).
|
||||
- Authenticated `GET /` → still serves the list, unchanged.
|
||||
- oidc: `handleLogout` → 302 `/welcome` (update the existing test).
|
||||
|
||||
**A out of scope:** no Dex config change, no new auth/session logic, no sign-up backend.
|
||||
|
||||
---
|
||||
|
||||
## Workstream B — Documentation reconciliation
|
||||
|
||||
### Why
|
||||
The guardrail docs were written before Stage 1 and the web surface. Several now describe the
|
||||
opposite of the deployed reality (v0.4.0). Stale guardrail docs are worse than none — a future
|
||||
cold session (human or agent) trusts them. This workstream brings requirements, use cases,
|
||||
architecture, and data-model back in sync with `main`. Each fix is one commit; cite the ADR or
|
||||
migration that is the source of truth.
|
||||
|
||||
### Known drift to fix (verified this session — not exhaustive; the worker confirms against code)
|
||||
**B1 — `internal/web/auth.go` comments.** The `User.Subject` doc and package doc still say
|
||||
"single-user allowlist (ADR-011)" / "Stage-0". Code is multi-user (ADR-012). Update the
|
||||
comments to describe the current multi-user reality; reference ADR-012.
|
||||
|
||||
**B2 — `docs/data-model.md` isolation status.** It says isolation enforcement is "dormant at
|
||||
Stage 0". It is now LIVE: Postgres RLS, `FORCE`d on all user-owned tables, with a passing
|
||||
two-user isolation test (ADR-012, migration 003). Rewrite that section to describe enforced
|
||||
RLS as the current state; keep the history honest (was dormant at Stage 0, enforced from
|
||||
Stage 1).
|
||||
|
||||
**B3 — `docs/data-model.md` schema completeness.** The doc predates migrations 002–006. Add
|
||||
the entities/columns that now exist: `summary_actions` (002), RLS (003), `user_identities`
|
||||
(004, dex_subject→user_id), `video_connections` (005), `users.auto_summarize` +
|
||||
`videos.summarize_requested` (006). The ER section should match the live schema. Cross-check
|
||||
against `internal/adapters/store/migrations/*.up.sql` — those are ground truth.
|
||||
|
||||
**B4 — `docs/architecture/architecture.md`.** Predates the entire web surface. Update the C4
|
||||
container diagram and text to include: `tapir serve` (HTMX+Templ web reader/writer), the Dex
|
||||
OIDC session layer (`internal/web/oidc`), registration gate, web-initiated YouTube connect,
|
||||
account management, and the immediate-processing path (web "Summarize" button → background
|
||||
goroutine → status poll). The engine/ports/sinks core is unchanged (ADR-003) — show the web
|
||||
surface as a new transport over the same core, not a core change.
|
||||
|
||||
**B5 — `docs/use-cases/*.feature`.** Add scenarios for the behaviours now live and unspecced:
|
||||
register (new subject → registration → user row; returning user straight through), connect
|
||||
YouTube (web OAuth), disconnect, delete-account (cascade + secret purge, Dex untouched —
|
||||
ADR-013), manual-vs-auto summarize mode + the Summarize button, and the landing page
|
||||
(logged-out CTA; logged-in shortcuts). Keep them as executable-style Gherkin consistent with
|
||||
the existing files.
|
||||
|
||||
**B6 — `DECISIONS.md` ADR ordering (cosmetic).** ADR-010 sits before ADR-009/011 (append
|
||||
order). Reorder to numeric while you're in the file. Pure tidy, no content change.
|
||||
|
||||
**B7 — requirements check.** If a requirements doc exists (e.g. `docs/ui-spec.md`, referenced
|
||||
by ADR-011), reconcile it with what shipped: note where the build deviated (e.g. the spinner /
|
||||
immediate processing / summarize mode were beyond the original spec) so the spec reflects
|
||||
reality or explicitly records the deviation. Do not silently rewrite history — record
|
||||
deviations as deviations.
|
||||
|
||||
### B working method
|
||||
- Source of truth order: migrations + code > ADRs > prose docs. When a prose doc disagrees
|
||||
with code, the code wins and the doc is corrected (unless the code is the bug — then flag it,
|
||||
don't quietly doc around it).
|
||||
- One logical doc per commit. Cite the ADR/migration that justifies each change in the commit
|
||||
body.
|
||||
- This is an audit, not a rewrite: preserve the docs' structure and the "rejected alternatives
|
||||
/ history" honesty. The goal is *current and trustworthy*, not *pretty*.
|
||||
|
||||
---
|
||||
|
||||
## Coordination
|
||||
A and B touch mostly different files (A: oidc.go, handlers.go, views.templ, tests; B: docs/* +
|
||||
auth.go comments). The one overlap is `auth.go` (B1 edits comments) vs A (reads it) — no
|
||||
conflict. Run A and B in parallel; commit independently to `main`.
|
||||
|
||||
If anything in B reveals that code, not docs, is wrong (e.g. an isolation gap, a migration that
|
||||
doesn't match the data-model intent), STOP and surface it — that's a finding, not a doc edit.
|
||||
@@ -0,0 +1,77 @@
|
||||
# Spec — Stage 0 usage measurement (login events)
|
||||
|
||||
**Date:** 2026-06-03
|
||||
**Status:** Ready to build · **Repo:** tapir · **Size:** small (one migration + middleware + query)
|
||||
**Why:** The Stage 0 gate (VISION, ADR-016) is *return usage in ≥2 separate weeks*. `summary_actions`
|
||||
captures *acts* (watch/skip/save) but not *reads* — a friend who logs in weekly and reads summaries
|
||||
without clicking anything is invisible. For a **reading** product that is the most important signal.
|
||||
This adds the missing data so the gate is measurable as written. Solo session, not a swarm.
|
||||
|
||||
Read `CLAUDE.md` + ADR-016 first. TBD, conventional commits, `task check` green before each commit.
|
||||
|
||||
## Scope (resist sprawl — this is NOT analytics)
|
||||
|
||||
A lightweight, append-only record of *when each user was active*, enough to answer
|
||||
"returned/read in ≥N distinct weeks". Not page-level events, not click tracking, not a funnel.
|
||||
|
||||
### 1. Migration — `login_events` (append-only)
|
||||
```
|
||||
login_events (
|
||||
id UUID PK default gen_random_uuid(),
|
||||
user_id UUID NOT NULL, -- per-user; RLS like every user-owned table
|
||||
seen_at TIMESTAMPTZ NOT NULL default NOW()
|
||||
)
|
||||
INDEX (user_id, seen_at)
|
||||
```
|
||||
- **RLS:** `FORCE ROW LEVEL SECURITY`, same policy/pattern as the other user-owned tables (the
|
||||
`tapir.current_user_id` GUC via the `withUser` seam — match migration 003). A reporting query that
|
||||
needs cross-user counts runs as the owner/maintainer outside the per-user scope, or via a dedicated
|
||||
read — decide consistently with how existing admin-ish reads are done.
|
||||
- Append-only: no updates, no deletes except the user-delete cascade. **Add to the delete-account
|
||||
cascade** (ADR-013) — `login_events` has no FK (mirrors `summary_actions`), so `DeleteUser` needs an
|
||||
explicit delete for it, and the delete test must assert it's covered. *Do not forget this* — it's the
|
||||
exact footgun the last delete work caught.
|
||||
|
||||
### 2. Middleware — throttled stamp
|
||||
- In the authenticated request path (after `CurrentUserID` resolves, inside the registration-gated
|
||||
app — NOT on `/welcome`/`/healthz`/`/auth`), record one `login_events` row **per user per day**
|
||||
(throttle: skip if a row exists for this user with `seen_at` ≥ start-of-today). One insert per active
|
||||
day, not per request — keeps the table small and the signal clean.
|
||||
- Throttle check must itself be RLS-scoped (`withUser`). Keep it cheap (indexed lookup).
|
||||
|
||||
### 3. Query — the gate report
|
||||
Provide a query (and optionally a tiny `tapir report` CLI subcommand or an admin page — your call,
|
||||
CLI is fine) answering, per user:
|
||||
```sql
|
||||
-- distinct active weeks from reads (login_events) AND acts (summary_actions), unioned
|
||||
WITH weeks AS (
|
||||
SELECT user_id, date_trunc('week', seen_at) AS wk FROM login_events
|
||||
UNION
|
||||
SELECT user_id, date_trunc('week', acted_at) FROM summary_actions
|
||||
)
|
||||
SELECT user_id, COUNT(DISTINCT wk) AS active_weeks
|
||||
FROM weeks GROUP BY user_id
|
||||
ORDER BY active_weeks DESC;
|
||||
```
|
||||
Gate passes when any user_id (maintainer or friend) reaches `active_weeks >= 2` within the window.
|
||||
|
||||
## Honesty caveats to carry (from VISION/ADR-016)
|
||||
- **"Unprompted" is not measurable here.** login_events records *that* a user returned, not *why*. A
|
||||
nudged return looks identical to an organic one. This build does not close that gap and must not
|
||||
claim to — the VISION measurement note stands: count returns, read a nudged return as weaker signal.
|
||||
(If prompt-tracking is ever wanted, that's a separate decision, not this build.)
|
||||
- **Data accrues from deploy onward.** The gate window's read-data starts when this ships — so ship
|
||||
soon (maintainer's call) rather than batching with the infra tooling session.
|
||||
- **`date_trunc('week')` is ISO/timezone-sensitive** and noisy at low volume (N=3). Two visits days
|
||||
apart can fall in the same or different weeks. Acceptable, but don't over-read a single-week-margin
|
||||
pass/fail.
|
||||
|
||||
## Out of scope
|
||||
Page/event analytics; prompt-vs-organic tracking; dashboards beyond the one gate query; anything
|
||||
touching the engine or sinks (this is web/store only — ADR-003 holds).
|
||||
|
||||
## Tests
|
||||
- Migration up/down; RLS on `login_events` (extend the two-user isolation test to cover it).
|
||||
- Throttle: N requests same day → 1 row; next day → 2nd row.
|
||||
- `DeleteUser` removes the user's `login_events` and leaves others' intact (extend the delete test).
|
||||
- The gate query returns correct distinct-week counts across a seeded reads+acts fixture.
|
||||
@@ -147,3 +147,28 @@ Gate (lane A) commits first; B/C/D follow.
|
||||
|
||||
`task check` green per lane; B/C/D rebase on A. Deploy (D) lands last, after the binary serves
|
||||
locally.
|
||||
|
||||
---
|
||||
|
||||
## Deviations and additions (as-built)
|
||||
|
||||
This spec describes the **Stage-0 single-user reader** (ADR-011). What actually shipped through
|
||||
v0.4.0 went further — Stage 1 (ADR-012) opened multi-user, and several UX features were added on
|
||||
top. Recorded here (append-only; the spec above is left intact) so intent and reality stay
|
||||
distinguishable.
|
||||
|
||||
| As-built feature | What it is | Why | Covered by |
|
||||
|------------------|-----------|-----|------------|
|
||||
| **Multi-user + RLS isolation** | Several Dex users per deployment; isolation enforced by Postgres RLS, not the single-subject allowlist of §6. | Maintainer opened Stage 1 ahead of the formal Stage-0 gate, with DB-enforced isolation as the guardrail that keeps it safe. | ADR-012; migration 003 (`6775e5f`, `f28fdc0`, `2ae66da`) |
|
||||
| **Registration gate** | A Dex subject with no `users` row is routed to `/register`, which creates the `users` row + a `user_identities` mapping. (§2 listed "sign-up / user CRUD" as a non-goal.) | Explicit registration is how a multi-user surface stays honest — no just-in-time row creation. | ADR-012; `f396e01` |
|
||||
| **Per-user YouTube web connect** | `/oauth/youtube/connect` → `/oauth/youtube/callback` stores a per-user refresh-token ref + a `video_connections` row. (The spec assumed a host-side `tapir auth` only.) | Multi-user means each user connects their own account from the browser. | ADR-006, ADR-012; migration 005 (`0c9531a`, `2aad79b`) |
|
||||
| **Account management** | `/account` page with **disconnect** and **delete account**; delete removes only Tapir-side state and leaves the Dex identity intact. (§2 listed isolation/CRUD as non-goals.) | A real account needs a way out; deletion semantics are deliberately Tapir-side only. | ADR-013; `22eafcf`, `c7624d9`, `17d5e8c` |
|
||||
| **Immediate web summarization** | A "Summarize" button (`POST /v/{id}/summarize`) runs the engine in a background goroutine inside `serve`; the page HTMX-polls `GET /v/{id}/status`. (§2 said "triggering runs from the browser … do NOT build".) | Reading a list you can't act on is half a product; on-demand summarize closes the loop without waiting for a batch `tapir run`. | ADR-012, ADR-014; `25215cb`, `8c6c7ca` |
|
||||
| **Charmbracelet tapir spinner** | An animated in-flight indicator (charm palette) shown while a summarize is processing; an honest "queued/waiting" state under rate-limiting rather than a stuck spinner. | The spinner must tell the truth when the timedtext endpoint rate-limits (429), not imply imminence. | ADR-014; `25215cb`, `a4aeb5e` |
|
||||
| **Auto/manual summarization mode** | Per-user `auto_summarize`; manual (default) lists new videos unsummarized and queues via `summarize_requested`; a mode toggle at `/account/summarize-mode`. | Control over compute/noise — only summarize what the user cares about. | migration 006 (`748d5eb`, `bdbdce7`, `3014ee0`, `a269d4a`) |
|
||||
| **Public landing page** | `/welcome` mounted **outside** the auth guard; unauthenticated `/` redirects there; logout returns there (not `/auth/login`). (The spec guarded everything except `/healthz` and `/auth/*`.) | A first-time visitor needs a public "what is this / get started" page before the login wall. | `d83943c`, `0fdf2f7`, `3a27bf1`, `d208110`, `8ca374e`, `f15f57f` |
|
||||
|
||||
The original Stage-0 goals (read summaries, record watch/skip/save actions, Dex login, GitOps
|
||||
deploy) still hold — these are additions over that base, not replacements. The architecture
|
||||
stance is unchanged: every item above is web-surface or store work; the engine/ports/sinks core
|
||||
was not modified (ADR-003).
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
Feature: Public landing page
|
||||
As a first-time visitor
|
||||
I want a public welcome page before I log in
|
||||
So that I understand what Tapir is and how to get started without hitting a login wall
|
||||
|
||||
Scenario: An unauthenticated visit to the root is sent to the welcome page
|
||||
Given I am not logged in
|
||||
When I open the root path "/"
|
||||
Then I am redirected to "/welcome"
|
||||
|
||||
Scenario: The welcome page invites an unauthenticated visitor to start
|
||||
Given I am not logged in
|
||||
When I open "/welcome"
|
||||
Then I see a "Get Started" call to action
|
||||
|
||||
Scenario: An authenticated user on the welcome page sees their way in and out
|
||||
Given I am logged in
|
||||
When I open "/welcome"
|
||||
Then I see a link to my summaries
|
||||
And I see a way to log out
|
||||
|
||||
Scenario: Logging out returns to the welcome page
|
||||
Given I am logged in
|
||||
When I log out
|
||||
Then I am returned to "/welcome"
|
||||
|
||||
# /welcome is mounted outside the auth guard so it is reachable without a session;
|
||||
# the root and all data routes stay behind it (commits around the WelcomePage work).
|
||||
@@ -0,0 +1,45 @@
|
||||
Feature: Register and manage a multi-user account
|
||||
As one of a handful of trusted users
|
||||
I want my own account, isolated from everyone else's
|
||||
So that Tapir can serve several people from one deployment without leaking data
|
||||
|
||||
# Stage 1 (ADR-012): Dex authenticates, Tapir authorizes per user. A Dex subject
|
||||
# with no users row is a new user and must register before reaching any data.
|
||||
|
||||
Scenario: A new Dex subject is routed to registration
|
||||
Given I am authenticated by Dex with a subject that has no Tapir account
|
||||
When I open any page that requires an account
|
||||
Then I am routed to the registration page
|
||||
And no summaries are shown until I register
|
||||
|
||||
Scenario: Registering creates the account and its identity mapping
|
||||
Given I am authenticated by Dex with a subject that has no Tapir account
|
||||
When I complete registration
|
||||
Then a user row is created for me
|
||||
And a user_identities row maps my Dex subject to that user
|
||||
And I am taken into the app as a registered user
|
||||
|
||||
Scenario: A returning subject passes straight through
|
||||
Given I am authenticated by Dex with a subject that already has a Tapir account
|
||||
When I open the app
|
||||
Then I am not asked to register again
|
||||
And I see my own summaries
|
||||
|
||||
Scenario: Deleting an account removes only my data and leaves other users untouched
|
||||
Given I am a registered user with summaries, a connected account, and recorded actions
|
||||
And another user exists with their own summaries
|
||||
When I delete my account
|
||||
Then all of my rows are removed across every user-owned table
|
||||
And my stored secret references are removed
|
||||
And the other user's data remains intact
|
||||
And my Dex identity is left intact
|
||||
|
||||
Scenario: A deleted user can register again as a fresh account
|
||||
Given I deleted my Tapir account but my Dex identity still exists
|
||||
When I sign in again
|
||||
Then I am routed to the registration page as a new user
|
||||
And registering creates a fresh user row with none of my old data
|
||||
|
||||
# Isolation is DB-enforced (Postgres RLS, ADR-012, migration 003): a user can never
|
||||
# read or write another user's rows even if an application WHERE clause is wrong.
|
||||
# Deletion is Tapir-side only — the shared Dex directory is never modified (ADR-013).
|
||||
@@ -0,0 +1,32 @@
|
||||
Feature: Choose how new videos get summarized
|
||||
As a user who wants control over compute and noise
|
||||
I want to pick whether new videos are summarized automatically or on demand
|
||||
So that I only spend summarization on the videos I actually care about
|
||||
|
||||
Background:
|
||||
Given I am a registered user with a connected video account
|
||||
|
||||
Scenario: Auto mode summarizes every new video
|
||||
Given my summarization mode is "auto"
|
||||
When a subscribed channel posts a new video with captions
|
||||
Then Tapir summarizes it without my asking
|
||||
And the summary appears in my list
|
||||
|
||||
Scenario: Manual mode is the default and leaves new videos unsummarized
|
||||
Given I have not changed my summarization mode
|
||||
Then my mode is "manual"
|
||||
When a subscribed channel posts a new video with captions
|
||||
Then the video appears in my list with no summary
|
||||
And nothing is summarized until I request it
|
||||
|
||||
Scenario: Requesting a summary in manual mode queues it for the next run
|
||||
Given my summarization mode is "manual"
|
||||
And a new video is in my list with no summary
|
||||
When I click "Summarize" on that video
|
||||
Then the video is marked as requested
|
||||
And the next run summarizes it
|
||||
And the request flag is cleared after it is processed
|
||||
|
||||
# auto_summarize is a per-user setting and summarize_requested is a per-video queue
|
||||
# flag (migration 006). The web button sets the flag; `tapir run` processes both the
|
||||
# auto videos and the manually queued ones, then clears the flag.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 116 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 73 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 58 KiB |
@@ -10,6 +10,7 @@ require (
|
||||
github.com/golang-migrate/migrate/v4 v4.19.1
|
||||
github.com/jackc/pgx/v5 v5.9.2
|
||||
github.com/stretchr/testify v1.11.1
|
||||
golang.org/x/crypto v0.45.0
|
||||
golang.org/x/oauth2 v0.36.0
|
||||
)
|
||||
|
||||
|
||||
@@ -91,6 +91,8 @@ go.opentelemetry.io/otel/trace v1.37.0 h1:HLdcFNbRQBE2imdSEgm/kwqmQj1Or1l/7bW6mx
|
||||
go.opentelemetry.io/otel/trace v1.37.0/go.mod h1:TlgrlQ+PtQO5XFerSPUYG0JSgGyryXewPGyayAWSBS0=
|
||||
go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=
|
||||
go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE=
|
||||
golang.org/x/crypto v0.45.0 h1:jMBrvKuj23MTlT0bQEOBcAE0mjg8mK9RXFhRH6nyF3Q=
|
||||
golang.org/x/crypto v0.45.0/go.mod h1:XTGrrkGJve7CYK7J8PEww4aY7gM3qMCElcJQ8n8JdX4=
|
||||
golang.org/x/oauth2 v0.36.0 h1:peZ/1z27fi9hUOFCAZaHyrpWG5lwe0RJEEEeH0ThlIs=
|
||||
golang.org/x/oauth2 v0.36.0/go.mod h1:YDBUJMTkDnJS+A4BP4eZBjCqtokkg1hODuPjwiGPO7Q=
|
||||
golang.org/x/sync v0.18.0 h1:kr88TuHDroi+UVf+0hZnirlk8o8T+4MrK6mr60WkH/I=
|
||||
|
||||
@@ -0,0 +1,180 @@
|
||||
// Package dex creates Dex local-password accounts by writing
|
||||
// passwords.dex.coreos.com custom resources directly against the in-cluster
|
||||
// Kubernetes API. This is the write side of the invite flow: a recipient sets a
|
||||
// password on /invite/{token}, Tapir bcrypt-hashes it and POSTs a Password CR into
|
||||
// the auth namespace, and Dex (configured with kubernetes storage) then serves
|
||||
// local-password login for that email.
|
||||
//
|
||||
// Why the raw API and not kubectl/client-go: the deployed pod already carries a
|
||||
// service-account token and the cluster CA at the well-known mount paths, so a
|
||||
// single net/http POST needs no extra dependency and no shelling out. Standalone /
|
||||
// dev has no such mount — NewPasswordClient returns ErrNotInCluster and the web
|
||||
// handler degrades gracefully (account creation only works in the deployed env).
|
||||
package dex
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"crypto/tls"
|
||||
"crypto/x509"
|
||||
"encoding/base64"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"os"
|
||||
"regexp"
|
||||
"strings"
|
||||
"time"
|
||||
)
|
||||
|
||||
// Sentinel errors let the web handler turn API outcomes into clear user messages.
|
||||
var (
|
||||
// ErrNotInCluster means the service-account token mount is absent, so there is
|
||||
// no in-cluster API to talk to (local dev / tests). Construction-time only.
|
||||
ErrNotInCluster = errors.New("dex: not running in-cluster (no service-account token)")
|
||||
// ErrPasswordExists maps the API's 409 Conflict — a Password CR for this email
|
||||
// already exists. The handler treats it as a benign "log in instead".
|
||||
ErrPasswordExists = errors.New("dex: password already exists")
|
||||
// ErrForbidden maps 401/403 — the tapir ServiceAccount lacks create/get on
|
||||
// passwords.dex.coreos.com in the auth namespace (RBAC not applied).
|
||||
ErrForbidden = errors.New("dex: forbidden — missing RBAC for passwords.dex.coreos.com")
|
||||
)
|
||||
|
||||
// Well-known in-cluster service-account mount paths (projected by kubelet).
|
||||
const (
|
||||
saTokenPath = "/var/run/secrets/kubernetes.io/serviceaccount/token" //nolint:gosec // path, not a secret
|
||||
saCAPath = "/var/run/secrets/kubernetes.io/serviceaccount/ca.crt"
|
||||
// apiServer is the in-cluster API endpoint; its TLS is validated against the
|
||||
// mounted cluster CA.
|
||||
apiServer = "https://kubernetes.default.svc"
|
||||
// passwordsPath is the Dex Password collection in the auth namespace.
|
||||
passwordsPath = "/apis/dex.coreos.com/v1/namespaces/auth/passwords"
|
||||
)
|
||||
|
||||
// PasswordClient writes Dex Password CRs against the in-cluster API. Construct it
|
||||
// with NewPasswordClient; the zero value is not usable.
|
||||
type PasswordClient struct {
|
||||
server string
|
||||
token string
|
||||
http *http.Client
|
||||
}
|
||||
|
||||
// NewPasswordClient reads the service-account token and cluster CA from the
|
||||
// well-known mount paths and returns a client that authenticates as the pod's
|
||||
// ServiceAccount. It returns ErrNotInCluster when the token mount is absent (dev /
|
||||
// tests / standalone), so callers can detect "no Dex available" and degrade.
|
||||
func NewPasswordClient() (*PasswordClient, error) {
|
||||
token, err := os.ReadFile(saTokenPath)
|
||||
if errors.Is(err, os.ErrNotExist) {
|
||||
return nil, ErrNotInCluster
|
||||
}
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("dex: read service-account token: %w", err)
|
||||
}
|
||||
|
||||
caPEM, err := os.ReadFile(saCAPath)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("dex: read cluster CA: %w", err)
|
||||
}
|
||||
pool := x509.NewCertPool()
|
||||
if !pool.AppendCertsFromPEM(caPEM) {
|
||||
return nil, errors.New("dex: cluster CA is not valid PEM")
|
||||
}
|
||||
|
||||
hc := &http.Client{
|
||||
Timeout: 10 * time.Second,
|
||||
Transport: &http.Transport{
|
||||
TLSClientConfig: &tls.Config{RootCAs: pool, MinVersion: tls.VersionTLS12},
|
||||
},
|
||||
}
|
||||
return newClient(apiServer, strings.TrimSpace(string(token)), hc), nil
|
||||
}
|
||||
|
||||
// newClient is the injectable constructor shared by NewPasswordClient and tests
|
||||
// (which point server at an httptest.Server and pass its TLS client).
|
||||
func newClient(server, token string, hc *http.Client) *PasswordClient {
|
||||
return &PasswordClient{server: server, token: token, http: hc}
|
||||
}
|
||||
|
||||
// password is the wire form of a Dex Password CR. NOTE: Dex's kubernetes storage
|
||||
// types the hash as []byte, which Kubernetes JSON-marshals as base64. So the
|
||||
// `hash` field must carry the base64 encoding of the bcrypt string, NOT the raw
|
||||
// bcrypt string — store the raw string and Dex's base64-decode on login yields
|
||||
// garbage and every login fails. CreatePassword does that encoding.
|
||||
type password struct {
|
||||
APIVersion string `json:"apiVersion"`
|
||||
Kind string `json:"kind"`
|
||||
Metadata map[string]string `json:"metadata"`
|
||||
Email string `json:"email"`
|
||||
Hash string `json:"hash"`
|
||||
Username string `json:"username"`
|
||||
UserID string `json:"userID"`
|
||||
}
|
||||
|
||||
// CreatePassword creates a Dex local-password account for email with the given
|
||||
// bcrypt hash and Dex user id. The CR name is derived from the email so it is a
|
||||
// valid, stable, idempotent Kubernetes object name. Returns ErrPasswordExists on
|
||||
// 409 (the account already exists) and ErrForbidden on 401/403 (RBAC missing).
|
||||
func (c *PasswordClient) CreatePassword(ctx context.Context, email, bcryptHash, userID string) error {
|
||||
body, err := json.Marshal(password{
|
||||
APIVersion: "dex.coreos.com/v1",
|
||||
Kind: "Password",
|
||||
Metadata: map[string]string{"name": passwordName(email), "namespace": "auth"},
|
||||
Email: email,
|
||||
// base64 of the bcrypt string — see the password type's NOTE.
|
||||
Hash: base64.StdEncoding.EncodeToString([]byte(bcryptHash)),
|
||||
Username: email,
|
||||
UserID: userID,
|
||||
})
|
||||
if err != nil {
|
||||
return fmt.Errorf("dex: marshal password: %w", err)
|
||||
}
|
||||
|
||||
req, err := http.NewRequestWithContext(ctx, http.MethodPost, c.server+passwordsPath, bytes.NewReader(body))
|
||||
if err != nil {
|
||||
return fmt.Errorf("dex: build request: %w", err)
|
||||
}
|
||||
req.Header.Set("Authorization", "Bearer "+c.token)
|
||||
req.Header.Set("Content-Type", "application/json")
|
||||
req.Header.Set("Accept", "application/json")
|
||||
|
||||
resp, err := c.http.Do(req)
|
||||
if err != nil {
|
||||
return fmt.Errorf("dex: create password: %w", err)
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
|
||||
switch resp.StatusCode {
|
||||
case http.StatusCreated, http.StatusOK:
|
||||
return nil
|
||||
case http.StatusConflict:
|
||||
return ErrPasswordExists
|
||||
case http.StatusUnauthorized, http.StatusForbidden:
|
||||
return ErrForbidden
|
||||
default:
|
||||
snippet, _ := io.ReadAll(io.LimitReader(resp.Body, 512))
|
||||
return fmt.Errorf("dex: create password: unexpected status %d: %s", resp.StatusCode, strings.TrimSpace(string(snippet)))
|
||||
}
|
||||
}
|
||||
|
||||
// invalidNameChars matches anything not allowed in an RFC-1123 subdomain segment
|
||||
// after the explicit @/. substitutions, so any stray character becomes '-'.
|
||||
var invalidNameChars = regexp.MustCompile(`[^a-z0-9-]`)
|
||||
|
||||
// passwordName maps an email to a valid, deterministic Kubernetes object name:
|
||||
// lowercase, '@' -> '-at-', '.' -> '-dot-', any remaining invalid char -> '-',
|
||||
// with leading/trailing '-' trimmed. Deterministic so a re-invite targets the
|
||||
// same CR (and so Dex's 409 is meaningful).
|
||||
func passwordName(email string) string {
|
||||
n := strings.ToLower(strings.TrimSpace(email))
|
||||
n = strings.ReplaceAll(n, "@", "-at-")
|
||||
n = strings.ReplaceAll(n, ".", "-dot-")
|
||||
n = invalidNameChars.ReplaceAllString(n, "-")
|
||||
n = strings.Trim(n, "-")
|
||||
if n == "" {
|
||||
n = "user"
|
||||
}
|
||||
return n
|
||||
}
|
||||
@@ -0,0 +1,104 @@
|
||||
package dex
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/base64"
|
||||
"encoding/json"
|
||||
"io"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
// newTestClient points a PasswordClient at an httptest server, using that
|
||||
// server's TLS client so the in-cluster TLS path is exercised without a real CA.
|
||||
func newTestClient(srv *httptest.Server) *PasswordClient {
|
||||
return newClient(srv.URL, "test-token", srv.Client())
|
||||
}
|
||||
|
||||
func TestCreatePasswordSuccess(t *testing.T) {
|
||||
var gotAuth, gotPath, gotMethod string
|
||||
var gotBody password
|
||||
|
||||
srv := httptest.NewTLSServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
gotAuth, gotPath, gotMethod = r.Header.Get("Authorization"), r.URL.Path, r.Method
|
||||
b, _ := io.ReadAll(r.Body)
|
||||
_ = json.Unmarshal(b, &gotBody)
|
||||
w.WriteHeader(http.StatusCreated)
|
||||
_, _ = w.Write([]byte(`{"kind":"Password"}`))
|
||||
}))
|
||||
defer srv.Close()
|
||||
|
||||
err := newTestClient(srv).CreatePassword(context.Background(),
|
||||
"New.User@Example.com", "$2a$12$abcdefghijklmnopqrstuv", "user-uuid-1")
|
||||
require.NoError(t, err)
|
||||
|
||||
require.Equal(t, http.MethodPost, gotMethod)
|
||||
require.Equal(t, passwordsPath, gotPath)
|
||||
require.Equal(t, "Bearer test-token", gotAuth)
|
||||
|
||||
// Email/username carry the raw address; the CR name is sanitised + lowercased.
|
||||
require.Equal(t, "New.User@Example.com", gotBody.Email)
|
||||
require.Equal(t, "New.User@Example.com", gotBody.Username)
|
||||
require.Equal(t, "user-uuid-1", gotBody.UserID)
|
||||
require.Equal(t, "new-dot-user-at-example-dot-com", gotBody.Metadata["name"])
|
||||
require.Equal(t, "auth", gotBody.Metadata["namespace"])
|
||||
|
||||
// The hash is the BASE64 of the bcrypt string (Dex stores hash as []byte).
|
||||
decoded, err := base64.StdEncoding.DecodeString(gotBody.Hash)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, "$2a$12$abcdefghijklmnopqrstuv", string(decoded))
|
||||
}
|
||||
|
||||
func TestCreatePasswordConflict(t *testing.T) {
|
||||
srv := httptest.NewTLSServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||
w.WriteHeader(http.StatusConflict)
|
||||
}))
|
||||
defer srv.Close()
|
||||
|
||||
err := newTestClient(srv).CreatePassword(context.Background(), "dup@example.com", "$2a$12$x", "u")
|
||||
require.ErrorIs(t, err, ErrPasswordExists)
|
||||
}
|
||||
|
||||
func TestCreatePasswordForbidden(t *testing.T) {
|
||||
srv := httptest.NewTLSServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||
w.WriteHeader(http.StatusForbidden)
|
||||
}))
|
||||
defer srv.Close()
|
||||
|
||||
err := newTestClient(srv).CreatePassword(context.Background(), "x@example.com", "$2a$12$x", "u")
|
||||
require.ErrorIs(t, err, ErrForbidden)
|
||||
}
|
||||
|
||||
func TestCreatePasswordUnexpectedStatus(t *testing.T) {
|
||||
srv := httptest.NewTLSServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||
w.WriteHeader(http.StatusInternalServerError)
|
||||
_, _ = w.Write([]byte("boom"))
|
||||
}))
|
||||
defer srv.Close()
|
||||
|
||||
err := newTestClient(srv).CreatePassword(context.Background(), "x@example.com", "$2a$12$x", "u")
|
||||
require.Error(t, err)
|
||||
require.NotErrorIs(t, err, ErrPasswordExists)
|
||||
require.NotErrorIs(t, err, ErrForbidden)
|
||||
require.Contains(t, err.Error(), "500")
|
||||
}
|
||||
|
||||
func TestNewPasswordClientNotInCluster(t *testing.T) {
|
||||
// In the test environment the SA token mount does not exist.
|
||||
_, err := NewPasswordClient()
|
||||
require.ErrorIs(t, err, ErrNotInCluster)
|
||||
}
|
||||
|
||||
func TestPasswordName(t *testing.T) {
|
||||
cases := map[string]string{
|
||||
"Alice@Example.com": "alice-at-example-dot-com",
|
||||
"a.b+c@gmail.com": "a-dot-b-c-at-gmail-dot-com",
|
||||
"UPPER@DOMAIN.IO": "upper-at-domain-dot-io",
|
||||
}
|
||||
for in, want := range cases {
|
||||
require.Equal(t, want, passwordName(in), in)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,86 @@
|
||||
package store
|
||||
|
||||
import (
|
||||
"context"
|
||||
"crypto/rand"
|
||||
"encoding/hex"
|
||||
"errors"
|
||||
"fmt"
|
||||
"time"
|
||||
|
||||
"github.com/jackc/pgx/v5"
|
||||
)
|
||||
|
||||
// Invitations are NOT routed through withUser: an invitation exists before its
|
||||
// user does, so there is no user_id to scope by and no authenticated context when
|
||||
// one is minted (host CLI) or claimed (the public /invite handler). The token is
|
||||
// the capability — single-use, time-boxed, crypto-random. The invitations table
|
||||
// is deliberately outside RLS for the same reason (see migration 009).
|
||||
|
||||
// CreateInvitation mints a single-use invite for email, valid for ttl, and
|
||||
// returns its token. The token is 32 bytes of crypto-random entropy, hex-encoded;
|
||||
// it is the only secret a recipient needs to claim the invite.
|
||||
func (s *Store) CreateInvitation(ctx context.Context, email string, ttl time.Duration) (string, error) {
|
||||
token, err := newInviteToken()
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
if _, err := s.pool.Exec(ctx,
|
||||
`INSERT INTO invitations (email, token, expires_at)
|
||||
VALUES ($1, $2, NOW() + $3::interval)`,
|
||||
email, token, ttl.String()); err != nil {
|
||||
return "", fmt.Errorf("store: create invitation: %w", err)
|
||||
}
|
||||
return token, nil
|
||||
}
|
||||
|
||||
// PeekInvitation returns the invited email for a token that is real, unexpired,
|
||||
// and unused WITHOUT consuming it — the read the /invite form does to validate the
|
||||
// link before showing the password fields. Returns ErrNotFound when the token is
|
||||
// missing, expired, or already used. Use ClaimInvitation to consume.
|
||||
func (s *Store) PeekInvitation(ctx context.Context, token string) (string, error) {
|
||||
var email string
|
||||
err := s.pool.QueryRow(ctx,
|
||||
`SELECT email FROM invitations
|
||||
WHERE token = $1 AND used_at IS NULL AND expires_at > NOW()`,
|
||||
token).Scan(&email)
|
||||
if errors.Is(err, pgx.ErrNoRows) {
|
||||
return "", ErrNotFound
|
||||
}
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("store: peek invitation: %w", err)
|
||||
}
|
||||
return email, nil
|
||||
}
|
||||
|
||||
// ClaimInvitation atomically consumes a valid invite and returns its email. The
|
||||
// UPDATE ... WHERE used_at IS NULL AND expires_at > NOW() guarded by RETURNING
|
||||
// makes the claim a single round-trip race-free check-and-set: two concurrent
|
||||
// claims of the same token, only one updates a row, the other gets no rows and so
|
||||
// ErrNotFound. Same ErrNotFound for missing/expired/already-used tokens.
|
||||
func (s *Store) ClaimInvitation(ctx context.Context, token string) (string, error) {
|
||||
var email string
|
||||
err := s.pool.QueryRow(ctx,
|
||||
`UPDATE invitations
|
||||
SET used_at = NOW()
|
||||
WHERE token = $1 AND used_at IS NULL AND expires_at > NOW()
|
||||
RETURNING email`,
|
||||
token).Scan(&email)
|
||||
if errors.Is(err, pgx.ErrNoRows) {
|
||||
return "", ErrNotFound
|
||||
}
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("store: claim invitation: %w", err)
|
||||
}
|
||||
return email, nil
|
||||
}
|
||||
|
||||
// newInviteToken returns 32 bytes of crypto-random entropy, hex-encoded (64
|
||||
// chars). Hex keeps the token URL-safe with no escaping in /invite/{token}.
|
||||
func newInviteToken() (string, error) {
|
||||
var b [32]byte
|
||||
if _, err := rand.Read(b[:]); err != nil {
|
||||
return "", fmt.Errorf("store: invite token: %w", err)
|
||||
}
|
||||
return hex.EncodeToString(b[:]), nil
|
||||
}
|
||||
@@ -0,0 +1,110 @@
|
||||
package store_test
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/jackc/pgx/v5/pgxpool"
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
"gitea.d-ma.be/mathias/tapir/internal/adapters/store"
|
||||
)
|
||||
|
||||
// resetInvitations clears the invitations table between cases. It is not in the
|
||||
// shared resetDB TRUNCATE list (invitations is not user-owned and has no FK to
|
||||
// users), so the invite tests wipe it themselves.
|
||||
func resetInvitations(t *testing.T, p *pgxpool.Pool) {
|
||||
t.Helper()
|
||||
_, err := p.Exec(context.Background(), `TRUNCATE invitations`)
|
||||
require.NoError(t, err)
|
||||
}
|
||||
|
||||
func TestCreateInvitationReturnsUsableToken(t *testing.T) {
|
||||
s, p := newStore(t), rawPool(t)
|
||||
resetInvitations(t, p)
|
||||
ctx := context.Background()
|
||||
|
||||
token, err := s.CreateInvitation(ctx, "new@example.com", time.Hour)
|
||||
require.NoError(t, err)
|
||||
require.Len(t, token, 64, "32 random bytes hex-encoded")
|
||||
|
||||
// Peek does not consume: the same token previews twice.
|
||||
email, err := s.PeekInvitation(ctx, token)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, "new@example.com", email)
|
||||
email, err = s.PeekInvitation(ctx, token)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, "new@example.com", email)
|
||||
}
|
||||
|
||||
func TestCreateInvitationTokensAreUnique(t *testing.T) {
|
||||
s, p := newStore(t), rawPool(t)
|
||||
resetInvitations(t, p)
|
||||
ctx := context.Background()
|
||||
|
||||
t1, err := s.CreateInvitation(ctx, "a@example.com", time.Hour)
|
||||
require.NoError(t, err)
|
||||
t2, err := s.CreateInvitation(ctx, "b@example.com", time.Hour)
|
||||
require.NoError(t, err)
|
||||
require.NotEqual(t, t1, t2)
|
||||
}
|
||||
|
||||
func TestClaimInvitationHappyPath(t *testing.T) {
|
||||
s, p := newStore(t), rawPool(t)
|
||||
resetInvitations(t, p)
|
||||
ctx := context.Background()
|
||||
|
||||
token, err := s.CreateInvitation(ctx, "claim@example.com", time.Hour)
|
||||
require.NoError(t, err)
|
||||
|
||||
email, err := s.ClaimInvitation(ctx, token)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, "claim@example.com", email)
|
||||
}
|
||||
|
||||
func TestClaimInvitationIsSingleUse(t *testing.T) {
|
||||
s, p := newStore(t), rawPool(t)
|
||||
resetInvitations(t, p)
|
||||
ctx := context.Background()
|
||||
|
||||
token, err := s.CreateInvitation(ctx, "once@example.com", time.Hour)
|
||||
require.NoError(t, err)
|
||||
|
||||
_, err = s.ClaimInvitation(ctx, token)
|
||||
require.NoError(t, err)
|
||||
|
||||
// Second claim fails — already used.
|
||||
_, err = s.ClaimInvitation(ctx, token)
|
||||
require.ErrorIs(t, err, store.ErrNotFound)
|
||||
|
||||
// And a used token no longer previews.
|
||||
_, err = s.PeekInvitation(ctx, token)
|
||||
require.ErrorIs(t, err, store.ErrNotFound)
|
||||
}
|
||||
|
||||
func TestClaimInvitationExpired(t *testing.T) {
|
||||
s, p := newStore(t), rawPool(t)
|
||||
resetInvitations(t, p)
|
||||
ctx := context.Background()
|
||||
|
||||
// Negative ttl => already expired.
|
||||
token, err := s.CreateInvitation(ctx, "old@example.com", -time.Minute)
|
||||
require.NoError(t, err)
|
||||
|
||||
_, err = s.PeekInvitation(ctx, token)
|
||||
require.ErrorIs(t, err, store.ErrNotFound)
|
||||
_, err = s.ClaimInvitation(ctx, token)
|
||||
require.ErrorIs(t, err, store.ErrNotFound)
|
||||
}
|
||||
|
||||
func TestClaimInvitationNotFound(t *testing.T) {
|
||||
s, p := newStore(t), rawPool(t)
|
||||
resetInvitations(t, p)
|
||||
ctx := context.Background()
|
||||
|
||||
_, err := s.ClaimInvitation(ctx, "does-not-exist")
|
||||
require.ErrorIs(t, err, store.ErrNotFound)
|
||||
_, err = s.PeekInvitation(ctx, "does-not-exist")
|
||||
require.ErrorIs(t, err, store.ErrNotFound)
|
||||
}
|
||||
@@ -0,0 +1,2 @@
|
||||
ALTER TABLE videos DROP COLUMN IF EXISTS rate_limited_at;
|
||||
ALTER TABLE videos DROP COLUMN IF EXISTS transcript_status;
|
||||
@@ -0,0 +1,17 @@
|
||||
-- Migration 007: per-video transcript fetch status, for rate-limit backoff.
|
||||
--
|
||||
-- transcript_status records the outcome of the last transcript attempt:
|
||||
-- NULL = not yet attempted
|
||||
-- 'none' = checked, no usable transcript (permanent — SourceNone)
|
||||
-- 'fetched' = transcript resolved and summarized (summary_id not null)
|
||||
-- 'rate_limited'= the caption endpoint returned 429; retry after a backoff window
|
||||
--
|
||||
-- rate_limited_at stamps WHEN the 429 was seen, so the runner can skip re-fetching
|
||||
-- a still-throttled video until NOW() - rate_limited_at exceeds TAPIR_FETCH_BACKOFF.
|
||||
-- It is cleared (set NULL) whenever the status moves off 'rate_limited'.
|
||||
--
|
||||
-- No RLS policy changes needed: videos already has ENABLE + FORCE ROW LEVEL
|
||||
-- SECURITY (migration 003) with the videos_isolation policy. New columns inherit
|
||||
-- that protection automatically.
|
||||
ALTER TABLE videos ADD COLUMN transcript_status TEXT;
|
||||
ALTER TABLE videos ADD COLUMN rate_limited_at TIMESTAMPTZ;
|
||||
@@ -0,0 +1 @@
|
||||
DROP TABLE IF EXISTS invitations;
|
||||
@@ -0,0 +1,22 @@
|
||||
-- Migration 009: invitations — an email-based invite to join Tapir (Stage-1
|
||||
-- onboarding gate). Mathias mints one with `tapir invite <email>`; the recipient
|
||||
-- visits /invite/{token}, sets a password, and Tapir creates their Dex account.
|
||||
--
|
||||
-- Deliberately NOT user-owned and NOT under RLS: an invitation exists BEFORE the
|
||||
-- user does, so there is no user_id to scope by and no authenticated user context
|
||||
-- when the invite is created (host CLI) or consumed (public /invite handler, no
|
||||
-- Dex session). The token itself is the capability — a 32-byte crypto-random,
|
||||
-- single-use, time-boxed secret. Hence no `user_id` FK and no ENABLE/FORCE ROW
|
||||
-- LEVEL SECURITY here (unlike every user-owned table in migrations 003/005).
|
||||
CREATE TABLE invitations (
|
||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||
email TEXT NOT NULL,
|
||||
token TEXT NOT NULL UNIQUE,
|
||||
created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
|
||||
expires_at TIMESTAMPTZ NOT NULL,
|
||||
used_at TIMESTAMPTZ
|
||||
);
|
||||
|
||||
-- Lookups are by token (both the claim and the form preview); the UNIQUE
|
||||
-- constraint already creates an index, this names one explicitly for clarity.
|
||||
CREATE INDEX idx_invitations_token ON invitations(token);
|
||||
@@ -49,6 +49,10 @@ type SummaryRow struct {
|
||||
// set by the web "Summarize" button and cleared by the next `tapir run`. Only
|
||||
// populated by ListVideos/GetVideoRow (summary-only reads leave it false).
|
||||
SummarizeRequested bool
|
||||
// TranscriptStatus mirrors videos.transcript_status (migration 007): "" (unset),
|
||||
// "none", "rate_limited", or "fetched". Drives the "Retrying later" list badge.
|
||||
// Only populated by ListVideos/GetVideoRow ("" on summary-only reads).
|
||||
TranscriptStatus string
|
||||
}
|
||||
|
||||
// selectSummary is the shared projection for both reads. videos is LEFT JOINed
|
||||
@@ -132,7 +136,8 @@ const selectVideo = `
|
||||
COALESCE(s.fallback_used, FALSE),
|
||||
COALESCE(s.created_at, v.seen_at),
|
||||
(s.id IS NOT NULL) AS summarized,
|
||||
v.summarize_requested
|
||||
v.summarize_requested,
|
||||
COALESCE(v.transcript_status, '')
|
||||
FROM videos v
|
||||
LEFT JOIN summaries s ON s.video_id = v.id AND s.user_id = v.user_id`
|
||||
|
||||
@@ -245,6 +250,7 @@ func scanVideoRow(rows pgx.Row) (SummaryRow, error) {
|
||||
&row.CreatedAt,
|
||||
&row.Summarized,
|
||||
&row.SummarizeRequested,
|
||||
&row.TranscriptStatus,
|
||||
); err != nil {
|
||||
return SummaryRow{}, fmt.Errorf("store: scan video: %w", err)
|
||||
}
|
||||
|
||||
@@ -0,0 +1,102 @@
|
||||
package store
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
"time"
|
||||
|
||||
"github.com/jackc/pgx/v5"
|
||||
)
|
||||
|
||||
// validTranscriptStatuses bounds SetTranscriptStatus input. "" clears the status
|
||||
// (column NULL); the three named states mirror migration 007's documented values.
|
||||
var validTranscriptStatuses = map[string]bool{
|
||||
"": true,
|
||||
"none": true,
|
||||
"rate_limited": true,
|
||||
"fetched": true,
|
||||
}
|
||||
|
||||
// SetTranscriptStatus records the outcome of the last transcript attempt for a
|
||||
// video (migration 007). When status is "rate_limited" it also stamps
|
||||
// rate_limited_at = NOW() so the runner can back off; every other status clears
|
||||
// that timestamp. "" unsets the status (column NULL). An unknown status is
|
||||
// rejected. Scoped via withUser, so RLS confines the UPDATE to the caller's own
|
||||
// video; ErrNotFound when the user has no such video.
|
||||
func (s *Store) SetTranscriptStatus(ctx context.Context, userID, videoID, status string) error {
|
||||
if !validTranscriptStatuses[status] {
|
||||
return fmt.Errorf("store: invalid transcript status %q", status)
|
||||
}
|
||||
return s.withUser(ctx, userID, func(tx pgx.Tx) error {
|
||||
ct, err := tx.Exec(ctx,
|
||||
`UPDATE videos
|
||||
SET transcript_status = NULLIF($1, ''),
|
||||
rate_limited_at = CASE WHEN $1 = 'rate_limited' THEN NOW() ELSE NULL END
|
||||
WHERE id = $2`,
|
||||
status, videoID)
|
||||
if err != nil {
|
||||
return fmt.Errorf("store: set transcript status: %w", err)
|
||||
}
|
||||
if ct.RowsAffected() == 0 {
|
||||
return ErrNotFound
|
||||
}
|
||||
return nil
|
||||
})
|
||||
}
|
||||
|
||||
// GetTranscriptStatus returns a video's transcript_status ("" when unset/NULL).
|
||||
// Returns ErrNotFound when the user has no such video. Scoped via withUser.
|
||||
func (s *Store) GetTranscriptStatus(ctx context.Context, userID, videoID string) (string, error) {
|
||||
var status string
|
||||
if err := s.withUser(ctx, userID, func(tx pgx.Tx) error {
|
||||
err := tx.QueryRow(ctx,
|
||||
`SELECT COALESCE(transcript_status, '') FROM videos WHERE id = $1`, videoID).Scan(&status)
|
||||
if errors.Is(err, pgx.ErrNoRows) {
|
||||
return ErrNotFound
|
||||
}
|
||||
return err
|
||||
}); err != nil {
|
||||
if errors.Is(err, ErrNotFound) {
|
||||
return "", ErrNotFound
|
||||
}
|
||||
return "", fmt.Errorf("store: get transcript status: %w", err)
|
||||
}
|
||||
return status, nil
|
||||
}
|
||||
|
||||
// RateLimitedVideoIDs returns the user's videos currently in the "rate_limited"
|
||||
// state, mapped to when the 429 was stamped (rate_limited_at). The run loop loads
|
||||
// it once per pass (mirroring SeenVideoIDs) to skip re-fetching a video still
|
||||
// inside the backoff window, saving caption requests. Scoped by user_id.
|
||||
func (s *Store) RateLimitedVideoIDs(ctx context.Context, userID string) (map[string]time.Time, error) {
|
||||
out := make(map[string]time.Time)
|
||||
if err := s.withUser(ctx, userID, func(tx pgx.Tx) error {
|
||||
rows, err := tx.Query(ctx,
|
||||
`SELECT id, rate_limited_at FROM videos
|
||||
WHERE user_id = $1 AND transcript_status = 'rate_limited' AND rate_limited_at IS NOT NULL`,
|
||||
userID)
|
||||
if err != nil {
|
||||
return fmt.Errorf("store: rate limited video ids: %w", err)
|
||||
}
|
||||
defer rows.Close()
|
||||
|
||||
for rows.Next() {
|
||||
var (
|
||||
id string
|
||||
at time.Time
|
||||
)
|
||||
if err := rows.Scan(&id, &at); err != nil {
|
||||
return fmt.Errorf("store: scan rate limited id: %w", err)
|
||||
}
|
||||
out[id] = at
|
||||
}
|
||||
if err := rows.Err(); err != nil {
|
||||
return fmt.Errorf("store: iterate rate limited ids: %w", err)
|
||||
}
|
||||
return nil
|
||||
}); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return out, nil
|
||||
}
|
||||
@@ -0,0 +1,80 @@
|
||||
package store_test
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
"gitea.d-ma.be/mathias/tapir/internal/adapters/store"
|
||||
)
|
||||
|
||||
func TestSetTranscriptStatus_RoundTrip(t *testing.T) {
|
||||
ctx := context.Background()
|
||||
s := newStore(t)
|
||||
resetDB(t, rawPool(t))
|
||||
|
||||
id, err := s.UpsertVideo(ctx, ytVideo(userA, "rt12345", "round trip"))
|
||||
require.NoError(t, err)
|
||||
|
||||
// Unset by default.
|
||||
got, err := s.GetTranscriptStatus(ctx, userA, id)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, "", got)
|
||||
|
||||
for _, status := range []string{"none", "fetched", "rate_limited", ""} {
|
||||
require.NoError(t, s.SetTranscriptStatus(ctx, userA, id, status))
|
||||
got, err := s.GetTranscriptStatus(ctx, userA, id)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, status, got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestSetTranscriptStatus_RejectsInvalid(t *testing.T) {
|
||||
ctx := context.Background()
|
||||
s := newStore(t)
|
||||
resetDB(t, rawPool(t))
|
||||
|
||||
id, err := s.UpsertVideo(ctx, ytVideo(userA, "bad12345", "bad status"))
|
||||
require.NoError(t, err)
|
||||
|
||||
require.Error(t, s.SetTranscriptStatus(ctx, userA, id, "bogus"))
|
||||
|
||||
// The rejected write left the status untouched.
|
||||
got, err := s.GetTranscriptStatus(ctx, userA, id)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, "", got)
|
||||
}
|
||||
|
||||
func TestSetTranscriptStatus_NotFound(t *testing.T) {
|
||||
ctx := context.Background()
|
||||
s := newStore(t)
|
||||
resetDB(t, rawPool(t))
|
||||
|
||||
require.ErrorIs(t, s.SetTranscriptStatus(ctx, userA, videoX, "fetched"), store.ErrNotFound)
|
||||
|
||||
_, err := s.GetTranscriptStatus(ctx, userA, videoX)
|
||||
require.ErrorIs(t, err, store.ErrNotFound)
|
||||
}
|
||||
|
||||
func TestRateLimitedVideoIDs_StampsAndClears(t *testing.T) {
|
||||
ctx := context.Background()
|
||||
s := newStore(t)
|
||||
resetDB(t, rawPool(t))
|
||||
|
||||
id, err := s.UpsertVideo(ctx, ytVideo(userA, "rl12345", "rate limited"))
|
||||
require.NoError(t, err)
|
||||
|
||||
// Marking rate_limited stamps rate_limited_at, so the video appears.
|
||||
require.NoError(t, s.SetTranscriptStatus(ctx, userA, id, "rate_limited"))
|
||||
rl, err := s.RateLimitedVideoIDs(ctx, userA)
|
||||
require.NoError(t, err)
|
||||
require.Contains(t, rl, id)
|
||||
require.False(t, rl[id].IsZero(), "rate_limited_at must be stamped")
|
||||
|
||||
// Moving off rate_limited clears the timestamp, so it drops out.
|
||||
require.NoError(t, s.SetTranscriptStatus(ctx, userA, id, "fetched"))
|
||||
rl, err = s.RateLimitedVideoIDs(ctx, userA)
|
||||
require.NoError(t, err)
|
||||
require.NotContains(t, rl, id)
|
||||
}
|
||||
@@ -60,6 +60,12 @@ func (a *Adapter) FetchTranscript(ctx context.Context, v domain.Video) (domain.T
|
||||
if err != nil {
|
||||
return domain.Transcript{}, fmt.Errorf("download caption track for %q: %w", v.ProviderVideoID, err)
|
||||
}
|
||||
if status == http.StatusTooManyRequests {
|
||||
// 429 means the IP is rate-limited; record for retry, not a permanent
|
||||
// absence. Degrade gracefully (no error, no text) like SourceNone, but
|
||||
// flag it distinctly so the runner backs off and retries (ADR-007/010).
|
||||
return domain.Transcript{VideoID: v.ID, UserID: v.UserID, Source: domain.SourceRateLimited}, nil
|
||||
}
|
||||
if status != http.StatusOK {
|
||||
// Owner-only 403, region/age gate, or transient unavailability: not an error.
|
||||
return noTranscript(v), nil
|
||||
|
||||
@@ -388,6 +388,37 @@ func TestFetchTranscriptBaseURLForbiddenDegrades(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
// A 429 on the baseUrl fetch is the IP being rate-limited, NOT a permanent
|
||||
// absence of captions: it returns SourceRateLimited (no error, no text) so the
|
||||
// runner can record it and retry after a backoff window rather than recording a
|
||||
// false "no transcript".
|
||||
func TestFetchTranscriptRateLimitedReturnsSourceRateLimited(t *testing.T) {
|
||||
a, _ := newTestAdapter(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
switch r.URL.Path {
|
||||
case "/youtubei/v1/player":
|
||||
base := "http://" + r.Host
|
||||
_, _ = w.Write([]byte(`{"captions":{"playerCaptionsTracklistRenderer":{"captionTracks":[` +
|
||||
`{"baseUrl":"` + base + `/api/timedtext?lang=en","languageCode":"en"}]}}}`))
|
||||
case "/api/timedtext":
|
||||
w.WriteHeader(http.StatusTooManyRequests)
|
||||
}
|
||||
})
|
||||
|
||||
tr, err := a.FetchTranscript(context.Background(), domain.Video{ID: "v1", UserID: "u1", ProviderVideoID: "vid1"})
|
||||
if err != nil {
|
||||
t.Fatalf("429 on baseUrl must degrade, not error: %v", err)
|
||||
}
|
||||
if tr.Source != domain.SourceRateLimited {
|
||||
t.Fatalf("expected SourceRateLimited on 429, got %q", tr.Source)
|
||||
}
|
||||
if tr.HasText() {
|
||||
t.Error("expected HasText() false for SourceRateLimited")
|
||||
}
|
||||
if tr.Content != "" {
|
||||
t.Errorf("expected empty content on 429, got %q", tr.Content)
|
||||
}
|
||||
}
|
||||
|
||||
// An empty baseUrl on the selected track degrades to SourceNone, never an error.
|
||||
func TestFetchTranscriptEmptyBaseURLDegrades(t *testing.T) {
|
||||
a, _ := newTestAdapter(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
|
||||
@@ -59,9 +59,20 @@ type Config struct {
|
||||
// PollInterval, when > 0, makes `run` loop on that cadence; 0 means run once.
|
||||
PollInterval time.Duration
|
||||
|
||||
// FetchBackoff is how long the run loop waits before re-fetching a transcript
|
||||
// that previously returned HTTP 429 (rate_limited). Inside the window the video
|
||||
// is skipped without hitting the caption endpoint, saving requests; after it
|
||||
// expires the video is retried. Zero means "always retry" (no backoff).
|
||||
FetchBackoff time.Duration
|
||||
|
||||
// HTTPAddr is the listen address for `tapir serve` (the Stage-0 web UI).
|
||||
HTTPAddr string
|
||||
|
||||
// PublicURL is the externally-reachable base URL of the deployed service,
|
||||
// e.g. "https://tapir.d-ma.be". Used to build absolute links handed to humans
|
||||
// (the `tapir invite` URL). No trailing slash is assumed — callers trim it.
|
||||
PublicURL string
|
||||
|
||||
// Dex OIDC (web login, ADR-011/012). When OIDCIssuer is empty, `serve` falls
|
||||
// back to the allow-all StubAuth (local dev). When set, serve uses Dex: any
|
||||
// Dex-authenticated subject may sign in, then registers a tapir user (ADR-012).
|
||||
@@ -85,6 +96,8 @@ const (
|
||||
defaultYTConnectRedirectURL = "https://tapir.d-ma.be/oauth/youtube/callback"
|
||||
defaultOAuthRedirectAddr = "localhost:8080"
|
||||
defaultHTTPAddr = ":8080"
|
||||
defaultFetchBackoff = time.Hour
|
||||
defaultPublicURL = "https://tapir.d-ma.be"
|
||||
)
|
||||
|
||||
// Load reads the environment into a Config, applying defaults. It does not
|
||||
@@ -105,6 +118,7 @@ func Load() (Config, error) {
|
||||
SecretsFile: envOr("TAPIR_SECRETS_FILE", defaultSecretsFile()),
|
||||
OAuthRedirectAddr: envOr("TAPIR_OAUTH_REDIRECT_ADDR", defaultOAuthRedirectAddr),
|
||||
HTTPAddr: envOr("TAPIR_HTTP_ADDR", defaultHTTPAddr),
|
||||
PublicURL: envOr("TAPIR_PUBLIC_URL", defaultPublicURL),
|
||||
OIDCIssuer: os.Getenv("TAPIR_OIDC_ISSUER"),
|
||||
DexClientID: os.Getenv("TAPIR_DEX_CLIENT_ID"),
|
||||
DexClientSecret: os.Getenv("TAPIR_DEX_CLIENT_SECRET"),
|
||||
@@ -124,6 +138,12 @@ func Load() (Config, error) {
|
||||
}
|
||||
c.PollInterval = interval
|
||||
|
||||
backoff, err := durationOr("TAPIR_FETCH_BACKOFF", defaultFetchBackoff)
|
||||
if err != nil {
|
||||
return Config{}, err
|
||||
}
|
||||
c.FetchBackoff = backoff
|
||||
|
||||
return c, nil
|
||||
}
|
||||
|
||||
|
||||
@@ -45,6 +45,9 @@ func TestLoad_AppliesDefaults(t *testing.T) {
|
||||
if c.PollInterval != 0 {
|
||||
t.Errorf("PollInterval = %v, want 0 (run once)", c.PollInterval)
|
||||
}
|
||||
if c.FetchBackoff != defaultFetchBackoff {
|
||||
t.Errorf("FetchBackoff = %v, want default %v", c.FetchBackoff, defaultFetchBackoff)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoad_ParsesValues(t *testing.T) {
|
||||
@@ -56,6 +59,7 @@ func TestLoad_ParsesValues(t *testing.T) {
|
||||
"TAPIR_SUMMARIZER_TIMEOUT": "90s",
|
||||
"TAPIR_DB_DSN": "postgres://x",
|
||||
"TAPIR_POLL_INTERVAL": "10m",
|
||||
"TAPIR_FETCH_BACKOFF": "30m",
|
||||
})
|
||||
|
||||
c, err := Load()
|
||||
@@ -77,6 +81,9 @@ func TestLoad_ParsesValues(t *testing.T) {
|
||||
if c.PollInterval != 10*time.Minute {
|
||||
t.Errorf("PollInterval = %v, want 10m", c.PollInterval)
|
||||
}
|
||||
if c.FetchBackoff != 30*time.Minute {
|
||||
t.Errorf("FetchBackoff = %v, want 30m", c.FetchBackoff)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoad_RejectsBadDuration(t *testing.T) {
|
||||
|
||||
@@ -18,6 +18,12 @@ type TranscriptSource string
|
||||
const (
|
||||
SourceCaptions TranscriptSource = "captions"
|
||||
SourceNone TranscriptSource = "none"
|
||||
// SourceRateLimited records that the caption endpoint returned HTTP 429.
|
||||
// Unlike SourceNone (a permanent absence), this is a transient "retry later":
|
||||
// the IP is rate-limited, not the video caption-less. It carries no text
|
||||
// (HasText is false), so the engine degrades the same as SourceNone, but the
|
||||
// runner persists it distinctly to retry after a backoff window.
|
||||
SourceRateLimited TranscriptSource = "rate_limited"
|
||||
)
|
||||
|
||||
// User is the Tapir-side profile. At Stage 0 there is exactly one.
|
||||
|
||||
@@ -32,6 +32,12 @@ type VideoStore interface {
|
||||
GetAutoSummarize(ctx context.Context, userID string) (bool, error)
|
||||
RequestedVideoIDs(ctx context.Context, userID string) (map[string]bool, error)
|
||||
ClearSummarizeRequested(ctx context.Context, userID, videoID string) error
|
||||
// RateLimitedVideoIDs maps the user's still-throttled videos to when they were
|
||||
// rate-limited, so the loop can back off without re-hitting the caption endpoint.
|
||||
RateLimitedVideoIDs(ctx context.Context, userID string) (map[string]time.Time, error)
|
||||
// SetTranscriptStatus records the outcome of a transcript attempt: "none",
|
||||
// "rate_limited" (stamps the backoff clock), or "fetched".
|
||||
SetTranscriptStatus(ctx context.Context, userID, videoID, status string) error
|
||||
}
|
||||
|
||||
// Processor runs the core use case for a single video. *usecase.Engine
|
||||
@@ -48,14 +54,35 @@ type Runner struct {
|
||||
engine Processor
|
||||
userID string
|
||||
log *slog.Logger
|
||||
backoff time.Duration // rate-limit retry window; 0 = always retry
|
||||
now func() time.Time // injectable clock (tests); defaults to time.Now
|
||||
}
|
||||
|
||||
// Option configures a Runner at construction. Variadic so existing call sites
|
||||
// stay valid as new knobs (backoff, clock) are added.
|
||||
type Option func(*Runner)
|
||||
|
||||
// WithBackoff sets the rate-limit retry window. A video that returned HTTP 429 is
|
||||
// skipped (no caption fetch) until this much time has passed; 0 = always retry.
|
||||
func WithBackoff(d time.Duration) Option { return func(r *Runner) { r.backoff = d } }
|
||||
|
||||
// WithClock overrides the clock used for backoff comparisons. Tests inject a
|
||||
// fixed time; production leaves the time.Now default.
|
||||
func WithClock(now func() time.Time) Option { return func(r *Runner) { r.now = now } }
|
||||
|
||||
// New builds a Runner. A nil logger falls back to slog.Default.
|
||||
func New(src ports.VideoSource, store VideoStore, engine Processor, userID string, log *slog.Logger) *Runner {
|
||||
func New(src ports.VideoSource, store VideoStore, engine Processor, userID string, log *slog.Logger, opts ...Option) *Runner {
|
||||
if log == nil {
|
||||
log = slog.Default()
|
||||
}
|
||||
return &Runner{src: src, store: store, engine: engine, userID: userID, log: log}
|
||||
r := &Runner{src: src, store: store, engine: engine, userID: userID, log: log, now: time.Now}
|
||||
for _, opt := range opts {
|
||||
opt(r)
|
||||
}
|
||||
if r.now == nil {
|
||||
r.now = time.Now
|
||||
}
|
||||
return r
|
||||
}
|
||||
|
||||
// Stats summarizes one RunOnce pass.
|
||||
@@ -65,6 +92,7 @@ type Stats struct {
|
||||
SkippedSeen int
|
||||
SkippedNoText int
|
||||
SkippedManual int // discovered but not queued, in manual mode
|
||||
SkippedRateLimited int // 429'd previously and still inside the backoff window
|
||||
Errors int
|
||||
}
|
||||
|
||||
@@ -104,6 +132,18 @@ func (r *Runner) RunOnce(ctx context.Context) (Stats, error) {
|
||||
}
|
||||
}
|
||||
|
||||
// Rate-limit backoff: videos that 429'd on a prior pass, mapped to when. Inside
|
||||
// the backoff window they are skipped before any caption fetch, so a throttled
|
||||
// IP is not hammered. Loaded once per pass (like seen/requested). Disabled when
|
||||
// backoff <= 0 ("always retry").
|
||||
var rateLimited map[string]time.Time
|
||||
if r.backoff > 0 {
|
||||
rateLimited, err = r.store.RateLimitedVideoIDs(ctx, r.userID)
|
||||
if err != nil {
|
||||
return stats, fmt.Errorf("runner: load rate-limited videos: %w", err)
|
||||
}
|
||||
}
|
||||
|
||||
subs, err := r.src.ListSubscriptions(ctx, r.userID)
|
||||
if err != nil {
|
||||
return stats, fmt.Errorf("runner: list subscriptions: %w", err)
|
||||
@@ -142,6 +182,15 @@ func (r *Runner) RunOnce(ctx context.Context) (Stats, error) {
|
||||
continue
|
||||
}
|
||||
|
||||
// Still inside the rate-limit backoff window: skip without fetching, so
|
||||
// we don't re-hit a caption endpoint that just 429'd us. After the window
|
||||
// expires the video falls through and is retried normally.
|
||||
if at, ok := rateLimited[id]; ok && r.now().Sub(at) < r.backoff {
|
||||
stats.SkippedRateLimited++
|
||||
r.log.Info("skipped video (rate-limited, backing off)", "video", v.ProviderVideoID, "title", v.Title)
|
||||
continue
|
||||
}
|
||||
|
||||
if fetchDelay > 0 {
|
||||
time.Sleep(fetchDelay)
|
||||
}
|
||||
@@ -152,11 +201,28 @@ func (r *Runner) RunOnce(ctx context.Context) (Stats, error) {
|
||||
continue
|
||||
}
|
||||
switch {
|
||||
case res.Skipped && res.TranscriptSource == string(domain.SourceRateLimited):
|
||||
// Fresh 429 this pass: persist rate_limited (stamps the backoff clock)
|
||||
// so the next pass skips it until the window expires.
|
||||
stats.SkippedRateLimited++
|
||||
if err := r.store.SetTranscriptStatus(ctx, r.userID, id, "rate_limited"); err != nil {
|
||||
errs = append(errs, fmt.Errorf("set rate_limited status %q: %w", v.ProviderVideoID, err))
|
||||
stats.Errors++
|
||||
}
|
||||
r.log.Info("skipped video (rate-limited)", "video", v.ProviderVideoID, "title", v.Title)
|
||||
case res.Skipped:
|
||||
stats.SkippedNoText++
|
||||
if err := r.store.SetTranscriptStatus(ctx, r.userID, id, "none"); err != nil {
|
||||
errs = append(errs, fmt.Errorf("set none status %q: %w", v.ProviderVideoID, err))
|
||||
stats.Errors++
|
||||
}
|
||||
r.log.Info("skipped video (no transcript)", "video", v.ProviderVideoID, "title", v.Title)
|
||||
case res.Summary != nil:
|
||||
stats.Summarized++
|
||||
if err := r.store.SetTranscriptStatus(ctx, r.userID, id, "fetched"); err != nil {
|
||||
errs = append(errs, fmt.Errorf("set fetched status %q: %w", v.ProviderVideoID, err))
|
||||
stats.Errors++
|
||||
}
|
||||
// In manual mode the video was processed because it was queued;
|
||||
// clear the flag so it is not re-summarized and the UI drops the
|
||||
// "Queued" chip. (Auto mode never sets the flag.)
|
||||
@@ -184,7 +250,8 @@ func (r *Runner) Loop(ctx context.Context, interval time.Duration) error {
|
||||
r.log.Info("run pass complete",
|
||||
"candidates", stats.Candidates, "summarized", stats.Summarized,
|
||||
"skipped_seen", stats.SkippedSeen, "skipped_no_text", stats.SkippedNoText,
|
||||
"skipped_manual", stats.SkippedManual, "errors", stats.Errors)
|
||||
"skipped_manual", stats.SkippedManual, "skipped_rate_limited", stats.SkippedRateLimited,
|
||||
"errors", stats.Errors)
|
||||
if err != nil {
|
||||
r.log.Warn("run pass had errors", "err", err)
|
||||
}
|
||||
|
||||
@@ -5,6 +5,7 @@ import (
|
||||
"io"
|
||||
"log/slog"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
@@ -48,6 +49,8 @@ type fakeStore struct {
|
||||
auto bool
|
||||
requested map[string]bool
|
||||
cleared []string
|
||||
rateLimited map[string]time.Time // id -> when 429'd (seeds the backoff window)
|
||||
statuses map[string]string // id -> last SetTranscriptStatus value
|
||||
}
|
||||
|
||||
func (f *fakeStore) UpsertVideo(_ context.Context, v domain.Video) (string, error) {
|
||||
@@ -80,6 +83,22 @@ func (f *fakeStore) ClearSummarizeRequested(_ context.Context, _, videoID string
|
||||
return nil
|
||||
}
|
||||
|
||||
func (f *fakeStore) RateLimitedVideoIDs(_ context.Context, _ string) (map[string]time.Time, error) {
|
||||
cp := make(map[string]time.Time, len(f.rateLimited))
|
||||
for k, v := range f.rateLimited {
|
||||
cp[k] = v
|
||||
}
|
||||
return cp, nil
|
||||
}
|
||||
|
||||
func (f *fakeStore) SetTranscriptStatus(_ context.Context, _, videoID, status string) error {
|
||||
if f.statuses == nil {
|
||||
f.statuses = map[string]string{}
|
||||
}
|
||||
f.statuses[videoID] = status
|
||||
return nil
|
||||
}
|
||||
|
||||
type fakeSummarizer struct{}
|
||||
|
||||
func (fakeSummarizer) Summarize(_ context.Context, v domain.Video, _ domain.Transcript) (domain.Summary, error) {
|
||||
@@ -207,6 +226,62 @@ func TestRunOnce_ManualMode_ProcessesRequested(t *testing.T) {
|
||||
require.Equal(t, []string{"id-v1"}, st.cleared, "the queue flag is cleared after summarizing")
|
||||
}
|
||||
|
||||
// noFetchSource fails the test if a transcript fetch happens — used to prove the
|
||||
// runner skips a rate-limited video before touching the caption endpoint.
|
||||
type noFetchSource struct{ *fakeSource }
|
||||
|
||||
func (noFetchSource) FetchTranscript(context.Context, domain.Video) (domain.Transcript, error) {
|
||||
panic("FetchTranscript must not be called for a rate-limited video within the backoff window")
|
||||
}
|
||||
|
||||
func TestRunOnce_SkipsRateLimitedWithinBackoff(t *testing.T) {
|
||||
base := time.Date(2026, 6, 3, 12, 0, 0, 0, time.UTC)
|
||||
src := &fakeSource{
|
||||
subs: []domain.Subscription{sub("chan1", "Channel One")},
|
||||
videos: map[string][]domain.Video{"chan1": {vid("v1", "Video 1")}},
|
||||
}
|
||||
// v1 was rate-limited 5m ago; backoff is 1h, so it is still inside the window.
|
||||
st := &fakeStore{
|
||||
seen: map[string]bool{},
|
||||
auto: true,
|
||||
rateLimited: map[string]time.Time{"id-v1": base.Add(-5 * time.Minute)},
|
||||
}
|
||||
eng := usecase.NewEngine(noFetchSource{src}, fakeSummarizer{}, &recordingSink{})
|
||||
r := runner.New(noFetchSource{src}, st, eng, testUser, quietLogger(),
|
||||
runner.WithBackoff(time.Hour), runner.WithClock(func() time.Time { return base }))
|
||||
|
||||
stats, err := r.RunOnce(context.Background())
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, 1, stats.SkippedRateLimited, "still throttled -> skipped")
|
||||
require.Equal(t, 0, stats.Summarized)
|
||||
require.Empty(t, st.statuses, "no status write: the engine was never invoked")
|
||||
}
|
||||
|
||||
func TestRunOnce_RetriesRateLimitedAfterBackoff(t *testing.T) {
|
||||
base := time.Date(2026, 6, 3, 12, 0, 0, 0, time.UTC)
|
||||
src := &fakeSource{
|
||||
subs: []domain.Subscription{sub("chan1", "Channel One")},
|
||||
videos: map[string][]domain.Video{"chan1": {vid("v1", "Video 1")}},
|
||||
}
|
||||
// v1 was rate-limited 2h ago; backoff is 1h, so the window has expired.
|
||||
st := &fakeStore{
|
||||
seen: map[string]bool{},
|
||||
auto: true,
|
||||
rateLimited: map[string]time.Time{"id-v1": base.Add(-2 * time.Hour)},
|
||||
}
|
||||
sink := &recordingSink{}
|
||||
eng := usecase.NewEngine(src, fakeSummarizer{}, sink)
|
||||
r := runner.New(src, st, eng, testUser, quietLogger(),
|
||||
runner.WithBackoff(time.Hour), runner.WithClock(func() time.Time { return base }))
|
||||
|
||||
stats, err := r.RunOnce(context.Background())
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, 0, stats.SkippedRateLimited, "window expired -> not skipped")
|
||||
require.Equal(t, 1, stats.Summarized, "the video is retried and summarized")
|
||||
require.Len(t, sink.delivered, 1)
|
||||
require.Equal(t, "fetched", st.statuses["id-v1"], "status advances to fetched on success")
|
||||
}
|
||||
|
||||
func TestRunOnce_UpsertsEveryCandidate(t *testing.T) {
|
||||
src := &fakeSource{
|
||||
subs: []domain.Subscription{sub("chan1", "Channel One")},
|
||||
|
||||
@@ -45,6 +45,11 @@ type ProcessResult struct {
|
||||
Video domain.Video
|
||||
Skipped bool
|
||||
Reason string // set when Skipped (e.g. "no transcript")
|
||||
// TranscriptSource is how the transcript resolved (or that there was none):
|
||||
// the domain.TranscriptSource value as a string. The runner reads it to tell a
|
||||
// permanent absence (SourceNone) from a transient 429 (SourceRateLimited) and
|
||||
// persist the right transcript_status. Empty when a fetch error short-circuits.
|
||||
TranscriptSource string
|
||||
Summary *domain.Summary // nil when Skipped
|
||||
}
|
||||
|
||||
@@ -59,7 +64,9 @@ func (e *Engine) ProcessNewVideo(ctx context.Context, v domain.Video) (ProcessRe
|
||||
if !t.HasText() {
|
||||
// No usable transcript: record the skip, produce no summary, deliver nothing
|
||||
// (captions-first, ADR-007; the watcher uses this to avoid reprocessing).
|
||||
return ProcessResult{Video: v, Skipped: true, Reason: "no transcript"}, nil
|
||||
// Surface the source so the runner separates SourceNone (permanent) from
|
||||
// SourceRateLimited (retry after a backoff window).
|
||||
return ProcessResult{Video: v, Skipped: true, Reason: "no transcript", TranscriptSource: string(t.Source)}, nil
|
||||
}
|
||||
|
||||
sum, err := e.AI.Summarize(ctx, v, t)
|
||||
@@ -76,7 +83,7 @@ func (e *Engine) ProcessNewVideo(ctx context.Context, v domain.Video) (ProcessRe
|
||||
}
|
||||
}
|
||||
|
||||
return ProcessResult{Video: v, Summary: &sum}, errors.Join(errs...)
|
||||
return ProcessResult{Video: v, Summary: &sum, TranscriptSource: string(t.Source)}, errors.Join(errs...)
|
||||
}
|
||||
|
||||
// ProcessNewVideos walks a user's subscriptions and processes each newly seen
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
// Package web is the Stage-0 HTTP read/write surface (ADR-011, docs/ui-spec.md).
|
||||
// Package web is the multi-user HTTP read/write surface (ADR-012, docs/ui-spec.md).
|
||||
// It serves the summary reader over the existing store; the engine and ports are
|
||||
// untouched (ADR-003).
|
||||
// untouched (ADR-003). ADR-011 shipped this as a single-user Stage-0 reader; ADR-012
|
||||
// opened Stage 1 — multiple Dex-authenticated users with DB-enforced (RLS) isolation.
|
||||
//
|
||||
// This file defines the auth SEAM so the Dex session layer (internal/web/oidc)
|
||||
// and the page/handler layer can be built independently: handlers depend only on
|
||||
@@ -10,9 +11,10 @@ package web
|
||||
|
||||
import "net/http"
|
||||
|
||||
// User is the authenticated principal. Subject is the Dex subject used for the
|
||||
// single-user allowlist (ADR-011); store operations key off the configured
|
||||
// tapir user_id (UUID), not this subject.
|
||||
// User is the authenticated principal. Subject is the Dex subject — the key for the
|
||||
// user_identities lookup (ADR-012) that resolves to a tapir user_id (UUID); store
|
||||
// operations scope every row by that id, not by this subject. A subject with no
|
||||
// users row is routed through the registration gate (see registration.go).
|
||||
type User struct {
|
||||
Subject string
|
||||
Email string
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
package web
|
||||
|
||||
import "net/http"
|
||||
|
||||
// Test-only handles to the unexported invite handlers so the external web_test
|
||||
// package can mount them on an httptest mux (and get PathValue routing) without
|
||||
// standing up the full Router + auth stack. export_test.go compiles only under
|
||||
// `go test`, so these never widen the package's real API.
|
||||
func (a *App) HandleInviteFormForTest(w http.ResponseWriter, r *http.Request) {
|
||||
a.handleInviteForm(w, r)
|
||||
}
|
||||
func (a *App) HandleInviteSubmitForTest(w http.ResponseWriter, r *http.Request) {
|
||||
a.handleInviteSubmit(w, r)
|
||||
}
|
||||
@@ -16,6 +16,7 @@ const (
|
||||
flashDisconnected = "disconnected"
|
||||
flashDeleted = "deleted"
|
||||
flashRegistered = "registered"
|
||||
flashAccountCreated = "account_created"
|
||||
)
|
||||
|
||||
// flashMaxAge bounds how long an unread flash lingers (seconds). Long enough to
|
||||
|
||||
+104
-7
@@ -61,6 +61,21 @@ type App struct {
|
||||
// Secrets removes a user's OAuth tokens on disconnect / delete-account. The
|
||||
// account routes require it; cmd/tapir wires the file-backed store.
|
||||
Secrets SecretRemover
|
||||
// Processor, when non-nil, summarizes a queued video immediately in a
|
||||
// background goroutine (the "Summarize" button kicks it off). Nil = queue-only:
|
||||
// the button flips the DB flag and the next `tapir run` does the work.
|
||||
Processor Processor
|
||||
// Processing tracks in-flight immediate summarizations so the status endpoint
|
||||
// shows the animation until the summary lands. The zero value is ready to use.
|
||||
Processing ProcessingSet
|
||||
// Invitations validates and consumes email-invite tokens for the public
|
||||
// /invite/{token} flow. Nil = the invite routes report "invalid" (the flow is
|
||||
// effectively off). *store.Store satisfies it.
|
||||
Invitations InvitationStore
|
||||
// Dex creates the Dex local-password account when an invite is claimed. Nil =
|
||||
// not in-cluster (dev): the submit handler degrades to a clear "deployed-only"
|
||||
// message instead of creating an account. *dex.PasswordClient satisfies it.
|
||||
Dex DexPasswordCreator
|
||||
}
|
||||
|
||||
func (a *App) logger() *slog.Logger {
|
||||
@@ -76,14 +91,21 @@ func (a *App) logger() *slog.Logger {
|
||||
func (a *App) Router() http.Handler {
|
||||
root := http.NewServeMux()
|
||||
root.HandleFunc("GET /healthz", a.handleHealthz)
|
||||
root.HandleFunc("GET /welcome", a.handleWelcome)
|
||||
root.Handle("GET /static/", staticHandler())
|
||||
root.Handle("/auth/", a.Auth.Routes())
|
||||
|
||||
// Email invitation claim (public — the visitor has no Dex session yet, so this
|
||||
// sits OUTSIDE Auth.Middleware). The token in the path is the capability.
|
||||
root.HandleFunc("GET /invite/{token}", a.handleInviteForm)
|
||||
root.HandleFunc("POST /invite/{token}", a.handleInviteSubmit)
|
||||
|
||||
app := http.NewServeMux()
|
||||
app.HandleFunc("GET /{$}", a.handleList)
|
||||
app.HandleFunc("GET /v/{videoId}", a.handleDetail)
|
||||
app.HandleFunc("POST /v/{videoId}/action", a.handleAction)
|
||||
app.HandleFunc("POST /v/{videoId}/summarize", a.handleRequestSummarize)
|
||||
app.HandleFunc("GET /v/{videoId}/status", a.handleStatus)
|
||||
app.HandleFunc("GET /register", a.handleRegisterForm)
|
||||
app.HandleFunc("POST /register", a.handleRegister)
|
||||
|
||||
@@ -109,6 +131,15 @@ func (a *App) Router() http.Handler {
|
||||
return root
|
||||
}
|
||||
|
||||
// handleWelcome renders the public landing page (/welcome). It is mounted outside
|
||||
// Auth.Middleware, so it must not assume a session: CurrentUser peeks the cookie
|
||||
// without redirecting and the page renders the logged-out or logged-in variant
|
||||
// accordingly.
|
||||
func (a *App) handleWelcome(w http.ResponseWriter, r *http.Request) {
|
||||
user, ok := a.Auth.CurrentUser(r)
|
||||
a.render(w, r, WelcomePage(user, ok))
|
||||
}
|
||||
|
||||
// handleHealthz is the unauthenticated liveness/readiness probe.
|
||||
func (a *App) handleHealthz(w http.ResponseWriter, _ *http.Request) {
|
||||
w.Header().Set("Content-Type", "text/plain; charset=utf-8")
|
||||
@@ -137,11 +168,24 @@ func (a *App) handleList(w http.ResponseWriter, r *http.Request) {
|
||||
}
|
||||
rows = f.apply(rows)
|
||||
|
||||
if isHTMX(r) {
|
||||
a.render(w, r, summaryList(rows))
|
||||
// hasConnected drives the empty state: a fresh account with a connection but
|
||||
// no `tapir run` yet has zero rows, and we want it to read "connected, run
|
||||
// tapir" rather than "nothing here". Only needed when the list is empty.
|
||||
hasConnected := false
|
||||
if len(rows) == 0 {
|
||||
conns, err := a.Store.ConnectionsForUser(r.Context(), userID)
|
||||
if err != nil {
|
||||
a.serverError(w, r, "connections for user", err)
|
||||
return
|
||||
}
|
||||
a.render(w, r, ListPage(rows, f, takeFlash(w, r)))
|
||||
hasConnected = len(conns) > 0
|
||||
}
|
||||
|
||||
if isHTMX(r) {
|
||||
a.render(w, r, summaryList(rows, hasConnected))
|
||||
return
|
||||
}
|
||||
a.render(w, r, ListPage(rows, f, takeFlash(w, r), hasConnected))
|
||||
}
|
||||
|
||||
// handleDetail renders one summary in full (highlights, takeaways, action group).
|
||||
@@ -208,10 +252,12 @@ func (a *App) handleAction(w http.ResponseWriter, r *http.Request) {
|
||||
http.Redirect(w, r, "/v/"+videoID, http.StatusSeeOther)
|
||||
}
|
||||
|
||||
// handleRequestSummarize queues a video for manual summarization. It does NOT run
|
||||
// the engine inline — it only flips summarize_requested; the next `tapir run`
|
||||
// picks it up (the single summarization driver). For HTMX it returns the refreshed
|
||||
// card (now showing "Queued"); without JS it redirects back to the list.
|
||||
// handleRequestSummarize handles the "Summarize" button. It always flips the DB
|
||||
// flag (summarize_requested) so the work is durable. With a Processor wired it
|
||||
// then summarizes immediately in the background and answers with the animated
|
||||
// processing card that polls /status until done; without one (queue-only) it
|
||||
// answers with the "Queued" card — the next `tapir run` does the work. Without
|
||||
// JS it redirects back to the list (POST→redirect→GET).
|
||||
func (a *App) handleRequestSummarize(w http.ResponseWriter, r *http.Request) {
|
||||
userID, ok := a.currentUserID(w, r)
|
||||
if !ok {
|
||||
@@ -238,9 +284,60 @@ func (a *App) handleRequestSummarize(w http.ResponseWriter, r *http.Request) {
|
||||
a.serverError(w, r, "get video", err)
|
||||
return
|
||||
}
|
||||
|
||||
if a.Processor != nil {
|
||||
a.startProcessing(userID, videoID)
|
||||
a.render(w, r, processingCard(*row))
|
||||
return
|
||||
}
|
||||
a.render(w, r, VideoCard(*row))
|
||||
}
|
||||
|
||||
// startProcessing marks a video in-flight and summarizes it in the background.
|
||||
// The goroutine uses a detached context — not the request's, which is cancelled
|
||||
// when the handler returns — and clears the in-flight mark on completion. On
|
||||
// error the DB flag stays set, so the video remains queued for the next
|
||||
// `tapir run`; a successful Processor.ProcessVideo clears it itself.
|
||||
func (a *App) startProcessing(userID, videoID string) {
|
||||
key := processingKey(userID, videoID)
|
||||
a.Processing.Add(key)
|
||||
go func() {
|
||||
defer a.Processing.Remove(key)
|
||||
if err := a.Processor.ProcessVideo(context.Background(), userID, videoID); err != nil {
|
||||
a.logger().Error("background summarize", "user", userID, "video", videoID, "err", err)
|
||||
}
|
||||
}()
|
||||
}
|
||||
|
||||
// handleStatus is the HTMX poll target for an in-flight summarization. It returns
|
||||
// the card in its current state: the full summary card once the summary exists,
|
||||
// otherwise the animated processing card while still in-flight (which keeps
|
||||
// polling), or the queued/button card when neither holds. VideoCard carries no
|
||||
// polling attributes, so HTMX stops polling once it swaps in.
|
||||
func (a *App) handleStatus(w http.ResponseWriter, r *http.Request) {
|
||||
userID, ok := a.currentUserID(w, r)
|
||||
if !ok {
|
||||
return
|
||||
}
|
||||
videoID := r.PathValue("videoId")
|
||||
|
||||
row, err := a.Store.GetVideoRow(r.Context(), userID, videoID)
|
||||
if errors.Is(err, store.ErrNotFound) {
|
||||
http.NotFound(w, r)
|
||||
return
|
||||
}
|
||||
if err != nil {
|
||||
a.serverError(w, r, "get video", err)
|
||||
return
|
||||
}
|
||||
|
||||
if row.Summarized || !a.Processing.Has(processingKey(userID, videoID)) {
|
||||
a.render(w, r, VideoCard(*row))
|
||||
return
|
||||
}
|
||||
a.render(w, r, processingCard(*row))
|
||||
}
|
||||
|
||||
// handleSummarizeMode toggles the user's auto/manual summarization mode. The form
|
||||
// submits the desired new value (enabled=true|false). For HTMX it returns the
|
||||
// refreshed mode control; without JS it redirects back to the account page.
|
||||
|
||||
@@ -0,0 +1,164 @@
|
||||
package web
|
||||
|
||||
import (
|
||||
"context"
|
||||
"crypto/rand"
|
||||
"errors"
|
||||
"fmt"
|
||||
"net/http"
|
||||
|
||||
"golang.org/x/crypto/bcrypt"
|
||||
|
||||
"gitea.d-ma.be/mathias/tapir/internal/adapters/dex"
|
||||
"gitea.d-ma.be/mathias/tapir/internal/adapters/store"
|
||||
)
|
||||
|
||||
// InvitationStore is the narrow store surface the public invite flow needs:
|
||||
// PeekInvitation validates a token without consuming it (the GET form preview);
|
||||
// ClaimInvitation consumes it atomically (the POST). *store.Store satisfies it.
|
||||
// Deliberately separate from Store (the user-scoped surface) — invites run with no
|
||||
// authenticated user (the user does not exist yet).
|
||||
type InvitationStore interface {
|
||||
PeekInvitation(ctx context.Context, token string) (email string, err error)
|
||||
ClaimInvitation(ctx context.Context, token string) (email string, err error)
|
||||
}
|
||||
|
||||
// DexPasswordCreator creates a Dex local-password account from a bcrypt hash.
|
||||
// *dex.PasswordClient satisfies it; tests substitute a fake. A nil App.Dex means
|
||||
// the process is not in-cluster (dev) and account creation is unavailable.
|
||||
type DexPasswordCreator interface {
|
||||
CreatePassword(ctx context.Context, email, bcryptHash, userID string) error
|
||||
}
|
||||
|
||||
// bcryptCost is the work factor for hashing invite passwords. 12 is a sensible
|
||||
// 2020s default — noticeably slow to brute-force, fast enough for a single login.
|
||||
const bcryptCost = 12
|
||||
|
||||
// minPasswordLen is the floor for an invite password. Length beats composition
|
||||
// rules; 8 is the practical minimum we accept.
|
||||
const minPasswordLen = 8
|
||||
|
||||
// handleInviteForm renders the set-password form for a valid invite token, or a
|
||||
// clear "expired / already used" page otherwise. It only previews the token
|
||||
// (PeekInvitation) — the token is consumed on submit, not on view, so a refresh
|
||||
// or a link-preview fetch never burns the invite.
|
||||
func (a *App) handleInviteForm(w http.ResponseWriter, r *http.Request) {
|
||||
token := r.PathValue("token")
|
||||
if a.Invitations == nil {
|
||||
a.renderStatus(w, r, http.StatusOK, InviteInvalidPage())
|
||||
return
|
||||
}
|
||||
email, err := a.Invitations.PeekInvitation(r.Context(), token)
|
||||
if errors.Is(err, store.ErrNotFound) {
|
||||
a.renderStatus(w, r, http.StatusOK, InviteInvalidPage())
|
||||
return
|
||||
}
|
||||
if err != nil {
|
||||
a.serverError(w, r, "peek invitation", err)
|
||||
return
|
||||
}
|
||||
a.render(w, r, InvitePage(email, token, ""))
|
||||
}
|
||||
|
||||
// handleInviteSubmit validates the chosen password, consumes the invite, and
|
||||
// creates the Dex local-password account. Order matters (see inline): password is
|
||||
// validated first (no token burned on a typo), then the invite is claimed exactly
|
||||
// once, then the Dex account is created. On success the visitor is sent to the Dex
|
||||
// login to sign in with the email + new password.
|
||||
func (a *App) handleInviteSubmit(w http.ResponseWriter, r *http.Request) {
|
||||
token := r.PathValue("token")
|
||||
if a.Invitations == nil {
|
||||
a.renderStatus(w, r, http.StatusOK, InviteInvalidPage())
|
||||
return
|
||||
}
|
||||
if err := r.ParseForm(); err != nil {
|
||||
http.Error(w, "bad form", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
password := r.FormValue("password")
|
||||
confirm := r.FormValue("password_confirm")
|
||||
|
||||
// 1. Validate before consuming the token, so a mismatch/typo is retryable.
|
||||
if len(password) < minPasswordLen {
|
||||
a.reshowInvite(w, r, token, "Password must be at least 8 characters.")
|
||||
return
|
||||
}
|
||||
if password != confirm {
|
||||
a.reshowInvite(w, r, token, "Passwords do not match.")
|
||||
return
|
||||
}
|
||||
|
||||
// Off-cluster (dev): we cannot create a Dex account. Degrade clearly WITHOUT
|
||||
// consuming the invite, so it still works once deployed.
|
||||
if a.Dex == nil {
|
||||
a.render(w, r, InviteNoticePage("Account creation only works in the deployed environment.", false))
|
||||
return
|
||||
}
|
||||
|
||||
// 2. Consume the invite exactly once. If the token vanished between GET and
|
||||
// POST (expired, replay, concurrent claim) this is where it surfaces.
|
||||
email, err := a.Invitations.ClaimInvitation(r.Context(), token)
|
||||
if errors.Is(err, store.ErrNotFound) {
|
||||
a.renderStatus(w, r, http.StatusOK, InviteInvalidPage())
|
||||
return
|
||||
}
|
||||
if err != nil {
|
||||
a.serverError(w, r, "claim invitation", err)
|
||||
return
|
||||
}
|
||||
|
||||
// 3. Hash the password (cost 12). The Dex client base64-encodes it for the CR.
|
||||
hash, err := bcrypt.GenerateFromPassword([]byte(password), bcryptCost)
|
||||
if err != nil {
|
||||
a.serverError(w, r, "hash password", err)
|
||||
return
|
||||
}
|
||||
|
||||
// 4. Create the Dex local-password account.
|
||||
userID, err := newID()
|
||||
if err != nil {
|
||||
a.serverError(w, r, "new user id", err)
|
||||
return
|
||||
}
|
||||
switch err := a.Dex.CreatePassword(r.Context(), email, string(hash), userID); {
|
||||
case err == nil:
|
||||
// 5. Off to the Dex login — a flash surfaces on the first page after login.
|
||||
setFlash(w, flashAccountCreated)
|
||||
http.Redirect(w, r, loginPath, http.StatusSeeOther)
|
||||
case errors.Is(err, dex.ErrPasswordExists):
|
||||
a.render(w, r, InviteNoticePage("An account with this email already exists. Try logging in.", true))
|
||||
case errors.Is(err, dex.ErrForbidden):
|
||||
a.render(w, r, InviteNoticePage("Unable to create your Dex account — please contact the administrator.", false))
|
||||
default:
|
||||
a.serverError(w, r, "create dex password", err)
|
||||
}
|
||||
}
|
||||
|
||||
// reshowInvite re-renders the password form with a validation message, re-fetching
|
||||
// the email from the (still-unconsumed) token. A token that became invalid in the
|
||||
// meantime falls back to the expired/used page.
|
||||
func (a *App) reshowInvite(w http.ResponseWriter, r *http.Request, token, errMsg string) {
|
||||
email, err := a.Invitations.PeekInvitation(r.Context(), token)
|
||||
if errors.Is(err, store.ErrNotFound) {
|
||||
a.renderStatus(w, r, http.StatusOK, InviteInvalidPage())
|
||||
return
|
||||
}
|
||||
if err != nil {
|
||||
a.serverError(w, r, "peek invitation", err)
|
||||
return
|
||||
}
|
||||
a.renderStatus(w, r, http.StatusBadRequest, InvitePage(email, token, errMsg))
|
||||
}
|
||||
|
||||
// newID returns a fresh random RFC-4122 v4 UUID for the Dex userID field
|
||||
// (crypto/rand, no new dependency). Kept local rather than coupling web to the
|
||||
// store package's unexported generator.
|
||||
func newID() (string, error) {
|
||||
var b [16]byte
|
||||
if _, err := rand.Read(b[:]); err != nil {
|
||||
return "", fmt.Errorf("web: new id: %w", err)
|
||||
}
|
||||
b[6] = (b[6] & 0x0f) | 0x40 // version 4
|
||||
b[8] = (b[8] & 0x3f) | 0x80 // variant 10
|
||||
return fmt.Sprintf("%x-%x-%x-%x-%x", b[0:4], b[4:6], b[6:8], b[8:10], b[10:16]), nil
|
||||
}
|
||||
@@ -0,0 +1,185 @@
|
||||
package web_test
|
||||
|
||||
import (
|
||||
"context"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"net/url"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/jackc/pgx/v5/pgxpool"
|
||||
"github.com/stretchr/testify/require"
|
||||
"golang.org/x/crypto/bcrypt"
|
||||
|
||||
"gitea.d-ma.be/mathias/tapir/internal/adapters/dex"
|
||||
"gitea.d-ma.be/mathias/tapir/internal/adapters/store"
|
||||
"gitea.d-ma.be/mathias/tapir/internal/web"
|
||||
)
|
||||
|
||||
// fakeDex captures the CreatePassword call and returns a canned error.
|
||||
type fakeDex struct {
|
||||
called bool
|
||||
email, hash, userID string
|
||||
err error
|
||||
}
|
||||
|
||||
func (f *fakeDex) CreatePassword(_ context.Context, email, hash, userID string) error {
|
||||
f.called = true
|
||||
f.email, f.hash, f.userID = email, hash, userID
|
||||
return f.err
|
||||
}
|
||||
|
||||
func resetInvites(t *testing.T, p *pgxpool.Pool) {
|
||||
t.Helper()
|
||||
_, err := p.Exec(context.Background(), `TRUNCATE invitations`)
|
||||
require.NoError(t, err)
|
||||
}
|
||||
|
||||
// inviteMux mounts only the two public invite routes against app, so PathValue
|
||||
// ("token") is populated exactly as in production without the full Router/auth.
|
||||
func inviteMux(app *web.App) http.Handler {
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("GET /invite/{token}", app.HandleInviteFormForTest)
|
||||
mux.HandleFunc("POST /invite/{token}", app.HandleInviteSubmitForTest)
|
||||
return mux
|
||||
}
|
||||
|
||||
func newInvite(t *testing.T, st *store.Store, email string, ttl time.Duration) string {
|
||||
t.Helper()
|
||||
token, err := st.CreateInvitation(context.Background(), email, ttl)
|
||||
require.NoError(t, err)
|
||||
return token
|
||||
}
|
||||
|
||||
func TestInviteFormValidToken(t *testing.T) {
|
||||
st, p := newStore(t), rawPool(t)
|
||||
resetInvites(t, p)
|
||||
token := newInvite(t, st, "invitee@example.com", time.Hour)
|
||||
|
||||
app := &web.App{Invitations: st, Dex: &fakeDex{}}
|
||||
rr := httptest.NewRecorder()
|
||||
inviteMux(app).ServeHTTP(rr, httptest.NewRequest(http.MethodGet, "/invite/"+token, nil))
|
||||
|
||||
require.Equal(t, http.StatusOK, rr.Code)
|
||||
body := rr.Body.String()
|
||||
require.Contains(t, body, "invitee@example.com")
|
||||
require.Contains(t, body, "Create my account")
|
||||
}
|
||||
|
||||
func TestInviteFormInvalidToken(t *testing.T) {
|
||||
st, p := newStore(t), rawPool(t)
|
||||
resetInvites(t, p)
|
||||
|
||||
app := &web.App{Invitations: st, Dex: &fakeDex{}}
|
||||
rr := httptest.NewRecorder()
|
||||
inviteMux(app).ServeHTTP(rr, httptest.NewRequest(http.MethodGet, "/invite/nope", nil))
|
||||
|
||||
require.Equal(t, http.StatusOK, rr.Code)
|
||||
require.Contains(t, rr.Body.String(), "no longer valid")
|
||||
}
|
||||
|
||||
func postInvite(app *web.App, token string, form url.Values) *httptest.ResponseRecorder {
|
||||
rr := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodPost, "/invite/"+token, strings.NewReader(form.Encode()))
|
||||
req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
|
||||
inviteMux(app).ServeHTTP(rr, req)
|
||||
return rr
|
||||
}
|
||||
|
||||
func TestInviteSubmitPasswordMismatch(t *testing.T) {
|
||||
st, p := newStore(t), rawPool(t)
|
||||
resetInvites(t, p)
|
||||
token := newInvite(t, st, "a@example.com", time.Hour)
|
||||
fd := &fakeDex{}
|
||||
app := &web.App{Invitations: st, Dex: fd}
|
||||
|
||||
rr := postInvite(app, token, url.Values{"password": {"longenough1"}, "password_confirm": {"different1"}})
|
||||
|
||||
require.Equal(t, http.StatusBadRequest, rr.Code)
|
||||
require.Contains(t, rr.Body.String(), "do not match")
|
||||
require.False(t, fd.called)
|
||||
// Token not consumed — still claimable.
|
||||
_, err := st.PeekInvitation(context.Background(), token)
|
||||
require.NoError(t, err)
|
||||
}
|
||||
|
||||
func TestInviteSubmitShortPassword(t *testing.T) {
|
||||
st, p := newStore(t), rawPool(t)
|
||||
resetInvites(t, p)
|
||||
token := newInvite(t, st, "a@example.com", time.Hour)
|
||||
fd := &fakeDex{}
|
||||
app := &web.App{Invitations: st, Dex: fd}
|
||||
|
||||
rr := postInvite(app, token, url.Values{"password": {"short"}, "password_confirm": {"short"}})
|
||||
|
||||
require.Equal(t, http.StatusBadRequest, rr.Code)
|
||||
require.Contains(t, rr.Body.String(), "at least 8")
|
||||
require.False(t, fd.called)
|
||||
}
|
||||
|
||||
func TestInviteSubmitValidCreatesAccount(t *testing.T) {
|
||||
st, p := newStore(t), rawPool(t)
|
||||
resetInvites(t, p)
|
||||
token := newInvite(t, st, "new@example.com", time.Hour)
|
||||
fd := &fakeDex{}
|
||||
app := &web.App{Invitations: st, Dex: fd}
|
||||
|
||||
rr := postInvite(app, token, url.Values{"password": {"correcthorse"}, "password_confirm": {"correcthorse"}})
|
||||
|
||||
require.Equal(t, http.StatusSeeOther, rr.Code)
|
||||
require.Equal(t, "/auth/login", rr.Header().Get("Location"))
|
||||
|
||||
require.True(t, fd.called)
|
||||
require.Equal(t, "new@example.com", fd.email)
|
||||
require.NotEmpty(t, fd.userID)
|
||||
// The handler hands Dex a real bcrypt hash of the chosen password.
|
||||
require.NoError(t, bcrypt.CompareHashAndPassword([]byte(fd.hash), []byte("correcthorse")))
|
||||
|
||||
// Flash queued for the post-login page.
|
||||
require.Contains(t, rr.Header().Get("Set-Cookie"), "tapir_flash=account_created")
|
||||
|
||||
// Token consumed — a second claim fails.
|
||||
_, err := st.ClaimInvitation(context.Background(), token)
|
||||
require.ErrorIs(t, err, store.ErrNotFound)
|
||||
}
|
||||
|
||||
func TestInviteSubmitDevModeNoDex(t *testing.T) {
|
||||
st, p := newStore(t), rawPool(t)
|
||||
resetInvites(t, p)
|
||||
token := newInvite(t, st, "dev@example.com", time.Hour)
|
||||
app := &web.App{Invitations: st, Dex: nil} // not in-cluster
|
||||
|
||||
rr := postInvite(app, token, url.Values{"password": {"correcthorse"}, "password_confirm": {"correcthorse"}})
|
||||
|
||||
require.Equal(t, http.StatusOK, rr.Code)
|
||||
require.Contains(t, rr.Body.String(), "deployed environment")
|
||||
// Token preserved so it still works once deployed.
|
||||
_, err := st.PeekInvitation(context.Background(), token)
|
||||
require.NoError(t, err)
|
||||
}
|
||||
|
||||
func TestInviteSubmitPasswordExists(t *testing.T) {
|
||||
st, p := newStore(t), rawPool(t)
|
||||
resetInvites(t, p)
|
||||
token := newInvite(t, st, "dup@example.com", time.Hour)
|
||||
app := &web.App{Invitations: st, Dex: &fakeDex{err: dex.ErrPasswordExists}}
|
||||
|
||||
rr := postInvite(app, token, url.Values{"password": {"correcthorse"}, "password_confirm": {"correcthorse"}})
|
||||
|
||||
require.Equal(t, http.StatusOK, rr.Code)
|
||||
require.Contains(t, rr.Body.String(), "already exists")
|
||||
}
|
||||
|
||||
func TestInviteSubmitForbidden(t *testing.T) {
|
||||
st, p := newStore(t), rawPool(t)
|
||||
resetInvites(t, p)
|
||||
token := newInvite(t, st, "x@example.com", time.Hour)
|
||||
app := &web.App{Invitations: st, Dex: &fakeDex{err: dex.ErrForbidden}}
|
||||
|
||||
rr := postInvite(app, token, url.Values{"password": {"correcthorse"}, "password_confirm": {"correcthorse"}})
|
||||
|
||||
require.Equal(t, http.StatusOK, rr.Code)
|
||||
require.Contains(t, rr.Body.String(), "administrator")
|
||||
}
|
||||
@@ -161,11 +161,11 @@ func (d *DexAuth) Middleware(h http.Handler) http.Handler {
|
||||
}
|
||||
sid, ok := d.sessionID(r)
|
||||
if !ok {
|
||||
d.redirectToLogin(w, r)
|
||||
d.redirectUnauthenticated(w, r)
|
||||
return
|
||||
}
|
||||
if _, ok := d.sessions.get(sid, d.now()); !ok {
|
||||
d.redirectToLogin(w, r)
|
||||
d.redirectUnauthenticated(w, r)
|
||||
return
|
||||
}
|
||||
d.sessions.refresh(sid, d.now().Add(d.sessionTTL)) // sliding refresh
|
||||
@@ -266,7 +266,21 @@ func (d *DexAuth) handleLogout(w http.ResponseWriter, r *http.Request) {
|
||||
d.sessions.delete(sid)
|
||||
}
|
||||
d.clearSessionCookie(w)
|
||||
http.Redirect(w, r, loginPath, http.StatusFound)
|
||||
// Land on the public landing page, not the login endpoint: a just-logged-out
|
||||
// visitor should see /welcome, not be bounced straight back into a Dex login.
|
||||
http.Redirect(w, r, "/welcome", http.StatusFound)
|
||||
}
|
||||
|
||||
// redirectUnauthenticated sends an unauthenticated visitor somewhere useful: the
|
||||
// bare root goes to the public landing page (/welcome), any deeper guarded path
|
||||
// goes to login so the post-login round-trip can return them to it. isPublicPath
|
||||
// has already let /welcome and /auth/* through, so this never loops.
|
||||
func (d *DexAuth) redirectUnauthenticated(w http.ResponseWriter, r *http.Request) {
|
||||
if r.URL.Path == "/" {
|
||||
http.Redirect(w, r, "/welcome", http.StatusFound)
|
||||
return
|
||||
}
|
||||
d.redirectToLogin(w, r)
|
||||
}
|
||||
|
||||
func (d *DexAuth) redirectToLogin(w http.ResponseWriter, r *http.Request) {
|
||||
@@ -305,5 +319,5 @@ func (d *DexAuth) clearSessionCookie(w http.ResponseWriter) {
|
||||
}
|
||||
|
||||
func isPublicPath(p string) bool {
|
||||
return p == "/healthz" || strings.HasPrefix(p, "/auth/")
|
||||
return p == "/healthz" || p == "/welcome" || strings.HasPrefix(p, "/auth/")
|
||||
}
|
||||
|
||||
@@ -248,9 +248,15 @@ func TestMiddlewareRedirectsUnauthenticated(t *testing.T) {
|
||||
w.WriteHeader(http.StatusOK)
|
||||
}))
|
||||
|
||||
// The bare root sends an unauthenticated visitor to the public landing page.
|
||||
rec := httptest.NewRecorder()
|
||||
guarded.ServeHTTP(rec, httptest.NewRequest(http.MethodGet, "/", nil))
|
||||
require.Equal(t, http.StatusFound, rec.Code)
|
||||
require.Equal(t, "/welcome", rec.Header().Get("Location"))
|
||||
|
||||
// A deeper guarded path goes to login so the post-login round-trip returns there.
|
||||
rec = httptest.NewRecorder()
|
||||
guarded.ServeHTTP(rec, httptest.NewRequest(http.MethodGet, "/v/some-id", nil))
|
||||
require.Equal(t, http.StatusFound, rec.Code)
|
||||
require.Equal(t, "/auth/login", rec.Header().Get("Location"))
|
||||
}
|
||||
@@ -280,7 +286,7 @@ func TestMiddlewarePublicPathsBypassAuth(t *testing.T) {
|
||||
w.WriteHeader(http.StatusOK)
|
||||
}))
|
||||
|
||||
for _, path := range []string{"/healthz", "/auth/login"} {
|
||||
for _, path := range []string{"/healthz", "/welcome", "/auth/login"} {
|
||||
rec := httptest.NewRecorder()
|
||||
guarded.ServeHTTP(rec, httptest.NewRequest(http.MethodGet, path, nil))
|
||||
require.Equal(t, http.StatusOK, rec.Code, "expected %s to bypass auth", path)
|
||||
@@ -298,6 +304,7 @@ func TestLogoutClearsSession(t *testing.T) {
|
||||
auth.Routes().ServeHTTP(rec, req)
|
||||
|
||||
require.Equal(t, http.StatusFound, rec.Code)
|
||||
require.Equal(t, "/welcome", rec.Header().Get("Location"), "logout lands on the public page")
|
||||
cleared := sessionCookie(t, rec.Result())
|
||||
require.Less(t, cleared.MaxAge, 0, "logout expires the cookie")
|
||||
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
package web
|
||||
|
||||
import (
|
||||
"context"
|
||||
"sync"
|
||||
)
|
||||
|
||||
// Processor runs the core summarization use case for a single already-discovered
|
||||
// video — resolve its transcript, summarize, deliver to the store. *usecase.Engine
|
||||
// wrapped with the store satisfies it (wired in cmd/tapir). Optional on App: a nil
|
||||
// Processor means queue-only — the "Summarize" button only flips the DB flag and
|
||||
// the next `tapir run` does the work.
|
||||
type Processor interface {
|
||||
ProcessVideo(ctx context.Context, userID, videoID string) error
|
||||
}
|
||||
|
||||
// ProcessingSet tracks the (user, video) ids currently being summarized in-process
|
||||
// so the status endpoint can show the animation until the summary lands. It is
|
||||
// ephemeral (single-instance Stage-1): a restart drops it, and the DB holds the
|
||||
// durable state — the summary is present, or summarize_requested is still set so
|
||||
// `tapir run` retries. The zero value is ready to use; methods are concurrency-safe.
|
||||
type ProcessingSet struct {
|
||||
m sync.Map
|
||||
}
|
||||
|
||||
// Add marks a key in-flight.
|
||||
func (p *ProcessingSet) Add(key string) { p.m.Store(key, struct{}{}) }
|
||||
|
||||
// Remove clears a key once its summarization finishes (success or failure).
|
||||
func (p *ProcessingSet) Remove(key string) { p.m.Delete(key) }
|
||||
|
||||
// Has reports whether a key is currently in-flight.
|
||||
func (p *ProcessingSet) Has(key string) bool {
|
||||
_, ok := p.m.Load(key)
|
||||
return ok
|
||||
}
|
||||
|
||||
// processingKey scopes the in-flight key by user so one user's summarization is
|
||||
// never confused with another's for the same video id.
|
||||
func processingKey(userID, videoID string) string {
|
||||
return userID + "|" + videoID
|
||||
}
|
||||
@@ -0,0 +1,131 @@
|
||||
package web_test
|
||||
|
||||
import (
|
||||
"context"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
"gitea.d-ma.be/mathias/tapir/internal/web"
|
||||
)
|
||||
|
||||
// fakeProcessor records ProcessVideo calls. With block set it parks until the
|
||||
// channel is closed, so a test can observe the handler return before the
|
||||
// background work finishes (proving it ran in a goroutine).
|
||||
type fakeProcessor struct {
|
||||
block chan struct{}
|
||||
done chan struct{}
|
||||
calls []string
|
||||
}
|
||||
|
||||
func (f *fakeProcessor) ProcessVideo(_ context.Context, _, videoID string) error {
|
||||
if f.block != nil {
|
||||
<-f.block
|
||||
}
|
||||
f.calls = append(f.calls, videoID)
|
||||
if f.done != nil {
|
||||
close(f.done)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func TestRequestSummarizeImmediateProcessing(t *testing.T) {
|
||||
app := newApp(t)
|
||||
p := rawPool(t)
|
||||
resetDB(t, p)
|
||||
seedVideo(t, p, videoX, "Pending Title", "https://x", time.Time{})
|
||||
|
||||
fp := &fakeProcessor{block: make(chan struct{}), done: make(chan struct{})}
|
||||
app.Processor = fp
|
||||
|
||||
rec := postSummarize(t, app, videoX, true)
|
||||
require.Equal(t, http.StatusOK, rec.Code)
|
||||
html := body(t, rec)
|
||||
|
||||
// The processing card came back while ProcessVideo is still parked on block:
|
||||
// the work runs in a goroutine, the handler did not wait for it.
|
||||
require.Contains(t, html, "Summarizing", "processing card returned")
|
||||
require.Contains(t, html, "╭", "charm box rendered")
|
||||
require.Contains(t, html, "▓", "tapir body block chars rendered")
|
||||
require.Contains(t, html, "∩", "wiggling snout frame rendered")
|
||||
require.Contains(t, html, web.CharmPurple, "charm palette applied to the border")
|
||||
require.Contains(t, html, "/v/"+videoX+"/status", "card polls the status endpoint")
|
||||
require.Contains(t, html, `hx-trigger="every 2s"`, "card auto-polls every 2s")
|
||||
require.NotContains(t, html, "Queued", "not the queue-only card")
|
||||
|
||||
close(fp.block)
|
||||
select {
|
||||
case <-fp.done:
|
||||
case <-time.After(2 * time.Second):
|
||||
t.Fatal("ProcessVideo was not called in the background")
|
||||
}
|
||||
require.Equal(t, []string{videoX}, fp.calls)
|
||||
}
|
||||
|
||||
func TestStatusProcessingThenDone(t *testing.T) {
|
||||
ctx := context.Background()
|
||||
app := newApp(t)
|
||||
p := rawPool(t)
|
||||
resetDB(t, p)
|
||||
seedVideo(t, p, videoX, "Pending Title", "https://x", time.Time{})
|
||||
|
||||
// Park ProcessVideo so the video stays in-flight while we poll status.
|
||||
fp := &fakeProcessor{block: make(chan struct{})}
|
||||
app.Processor = fp
|
||||
require.Equal(t, http.StatusOK, postSummarize(t, app, videoX, true).Code)
|
||||
|
||||
// Processing: status returns the animation card, still polling.
|
||||
rec := getStatus(t, app, videoX)
|
||||
require.Equal(t, http.StatusOK, rec.Code)
|
||||
html := body(t, rec)
|
||||
require.Contains(t, html, "Summarizing", "in-flight → animation card")
|
||||
require.Contains(t, html, `hx-trigger="every 2s"`, "still polling")
|
||||
|
||||
close(fp.block)
|
||||
|
||||
// Done: once a summary exists, status returns the summary card with no poll.
|
||||
require.NoError(t, deliver(ctx, app, videoX, "the summary body"))
|
||||
rec = getStatus(t, app, videoX)
|
||||
require.Equal(t, http.StatusOK, rec.Code)
|
||||
html = body(t, rec)
|
||||
require.NotContains(t, html, "Summarizing", "done → no animation")
|
||||
require.NotContains(t, html, "every 2s", "done card does not poll (polling stops)")
|
||||
require.Contains(t, html, "/v/"+videoX+"\"", "links to the detail page")
|
||||
}
|
||||
|
||||
func TestStatusQueuedWhenNotInFlight(t *testing.T) {
|
||||
ctx := context.Background()
|
||||
app := newApp(t)
|
||||
p := rawPool(t)
|
||||
resetDB(t, p)
|
||||
seedVideo(t, p, videoX, "Pending Title", "https://x", time.Time{})
|
||||
|
||||
// Flag set but nothing in-flight (e.g. queue-only, or after a restart).
|
||||
require.NoError(t, app.Store.RequestSummarize(ctx, userID, videoX))
|
||||
|
||||
rec := getStatus(t, app, videoX)
|
||||
require.Equal(t, http.StatusOK, rec.Code)
|
||||
html := body(t, rec)
|
||||
require.Contains(t, html, "Queued", "queued chip card")
|
||||
require.NotContains(t, html, "Summarizing", "not processing")
|
||||
require.NotContains(t, html, "every 2s", "queued card does not poll")
|
||||
}
|
||||
|
||||
func TestStatusNotFound(t *testing.T) {
|
||||
app := newApp(t)
|
||||
resetDB(t, rawPool(t))
|
||||
rec := getStatus(t, app, videoX)
|
||||
require.Equal(t, http.StatusNotFound, rec.Code)
|
||||
}
|
||||
|
||||
func getStatus(t *testing.T, app *web.App, videoID string) *httptest.ResponseRecorder {
|
||||
t.Helper()
|
||||
req := httptest.NewRequest(http.MethodGet, "/v/"+videoID+"/status", nil)
|
||||
req.Header.Set("HX-Request", "true")
|
||||
rec := httptest.NewRecorder()
|
||||
app.Router().ServeHTTP(rec, req)
|
||||
return rec
|
||||
}
|
||||
@@ -0,0 +1,27 @@
|
||||
package web
|
||||
|
||||
import "testing"
|
||||
|
||||
func TestProcessingSetAddHasRemove(t *testing.T) {
|
||||
var s ProcessingSet // zero value is usable
|
||||
|
||||
key := processingKey("user-1", "video-1")
|
||||
if s.Has(key) {
|
||||
t.Fatal("fresh set must not report a key as in-flight")
|
||||
}
|
||||
|
||||
s.Add(key)
|
||||
if !s.Has(key) {
|
||||
t.Fatal("Add must mark the key in-flight")
|
||||
}
|
||||
|
||||
// A different user with the same video id is a distinct key.
|
||||
if s.Has(processingKey("user-2", "video-1")) {
|
||||
t.Fatal("keys must be scoped by user")
|
||||
}
|
||||
|
||||
s.Remove(key)
|
||||
if s.Has(key) {
|
||||
t.Fatal("Remove must clear the key")
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,55 @@
|
||||
package web
|
||||
|
||||
import (
|
||||
"context"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"gitea.d-ma.be/mathias/tapir/internal/adapters/store"
|
||||
)
|
||||
|
||||
func renderVideoCard(t *testing.T, r store.SummaryRow) string {
|
||||
t.Helper()
|
||||
var sb strings.Builder
|
||||
if err := VideoCard(r).Render(context.Background(), &sb); err != nil {
|
||||
t.Fatalf("render VideoCard: %v", err)
|
||||
}
|
||||
return sb.String()
|
||||
}
|
||||
|
||||
// A rate-limited, unsummarized video shows the passive "Retrying later" badge and
|
||||
// hides the Summarize button — the user can't fix it, retry is automatic.
|
||||
func TestVideoCard_RateLimitedShowsRetryingBadge(t *testing.T) {
|
||||
html := renderVideoCard(t, store.SummaryRow{
|
||||
VideoID: "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
|
||||
Title: "Throttled Video",
|
||||
Summarized: false,
|
||||
TranscriptStatus: "rate_limited",
|
||||
})
|
||||
|
||||
if !strings.Contains(html, "Retrying later") {
|
||||
t.Errorf("expected a 'Retrying later' badge, got:\n%s", html)
|
||||
}
|
||||
if !strings.Contains(html, "chip-retry") {
|
||||
t.Errorf("expected the passive chip-retry styling, got:\n%s", html)
|
||||
}
|
||||
if strings.Contains(html, ">Summarize<") {
|
||||
t.Errorf("the Summarize button must be hidden for a rate-limited video, got:\n%s", html)
|
||||
}
|
||||
}
|
||||
|
||||
// An ordinary unsummarized video still offers the Summarize button.
|
||||
func TestVideoCard_UnsummarizedShowsSummarize(t *testing.T) {
|
||||
html := renderVideoCard(t, store.SummaryRow{
|
||||
VideoID: "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
|
||||
Title: "Fresh Video",
|
||||
Summarized: false,
|
||||
})
|
||||
|
||||
if !strings.Contains(html, ">Summarize<") {
|
||||
t.Errorf("expected a Summarize button, got:\n%s", html)
|
||||
}
|
||||
if strings.Contains(html, "Retrying later") {
|
||||
t.Errorf("no retry badge for a non-rate-limited video, got:\n%s", html)
|
||||
}
|
||||
}
|
||||
@@ -4,6 +4,7 @@ import (
|
||||
"regexp"
|
||||
"strings"
|
||||
"time"
|
||||
"unicode/utf8"
|
||||
|
||||
"github.com/a-h/templ"
|
||||
|
||||
@@ -176,6 +177,126 @@ func summarizeURL(videoID string) templ.SafeURL {
|
||||
return templ.SafeURL("/v/" + videoID + "/summarize")
|
||||
}
|
||||
|
||||
// statusURL builds the processing-status poll path (GET) for a video id — the
|
||||
// HTMX poll target while an immediate summarization is in flight.
|
||||
func statusURL(videoID string) templ.SafeURL {
|
||||
return templ.SafeURL("/v/" + videoID + "/status")
|
||||
}
|
||||
|
||||
// inviteURL builds the claim path (POST) for an invite token.
|
||||
func inviteURL(token string) templ.SafeURL {
|
||||
return templ.SafeURL("/invite/" + token)
|
||||
}
|
||||
|
||||
// Charmbracelet-inspired palette for the summarizing animation (TapirSpinner) —
|
||||
// a charm purple box, pink tapir, mint snout/eyes/progress. Kept as named consts
|
||||
// so the inline span colours and the CSS track/fill share one source of truth.
|
||||
const (
|
||||
CharmPurple = "#7653FC" // box border
|
||||
CharmPink = "#FF6E9C" // tapir body
|
||||
CharmMint = "#0EF9B6" // snout, eyes, progress fill
|
||||
CharmCream = "#FFFDF5" // bright text
|
||||
CharmDim = "#6C6C6C" // dim text
|
||||
charmTrack = "#2D2D2D" // empty progress track (internal: dark char colour)
|
||||
)
|
||||
|
||||
// tapirInteriorW is the fixed inner width of the Charm box, in monospace cells.
|
||||
const tapirInteriorW = 34
|
||||
|
||||
// tapirBarFill is the mint progress fill (27 cells), revealed left→right by the
|
||||
// CSS width/clip animation over the dim track drawn in each frame.
|
||||
const tapirBarFill = "███████████████████████████"
|
||||
|
||||
// tapirRun is one coloured (or uncoloured) text segment of a box row.
|
||||
type tapirRun struct {
|
||||
s string
|
||||
color string // "" = no span (plain text)
|
||||
}
|
||||
|
||||
func tapirSpan(color, s string) string {
|
||||
if color == "" {
|
||||
return s
|
||||
}
|
||||
return `<span style="color:` + color + `">` + s + `</span>`
|
||||
}
|
||||
|
||||
// tapirLine renders one interior box row: concatenate the coloured runs, pad with
|
||||
// spaces to the fixed interior width, then flank with the purple side borders.
|
||||
// Padding is computed from the runs' rune counts, so every row's right border
|
||||
// lines up no matter how many runs it has (assuming 1-cell monospace glyphs).
|
||||
func tapirLine(runs ...tapirRun) string {
|
||||
var b strings.Builder
|
||||
width := 0
|
||||
for _, r := range runs {
|
||||
b.WriteString(tapirSpan(r.color, r.s))
|
||||
width += utf8.RuneCountInString(r.s)
|
||||
}
|
||||
if width < tapirInteriorW {
|
||||
b.WriteString(strings.Repeat(" ", tapirInteriorW-width))
|
||||
}
|
||||
bar := tapirSpan(CharmPurple, "│")
|
||||
return bar + b.String() + bar
|
||||
}
|
||||
|
||||
// tapirFrameHTML builds one animation frame: a rounded Charm box around a colored
|
||||
// ASCII tapir, a dim progress track, and labels. snout is the wiggling nose glyph
|
||||
// that differs between the three frames. Returned as raw HTML (coloured spans),
|
||||
// emitted verbatim by the template via templ.Raw.
|
||||
func tapirFrameHTML(snout string) string {
|
||||
top := tapirSpan(CharmPurple, "╭"+strings.Repeat("─", tapirInteriorW)+"╮")
|
||||
bottom := tapirSpan(CharmPurple, "╰"+strings.Repeat("─", tapirInteriorW)+"╯")
|
||||
lines := []string{
|
||||
top,
|
||||
tapirLine(tapirRun{s: " "}, tapirRun{s: "◆", color: CharmMint}, tapirRun{s: " "}, tapirRun{s: "tapir", color: CharmCream}),
|
||||
tapirLine(),
|
||||
tapirLine(tapirRun{s: " "}, tapirRun{s: "▄▄▄▄▄", color: CharmPink}),
|
||||
tapirLine(tapirRun{s: " "}, tapirRun{s: "▄█▓▓▓▓█▄", color: CharmPink}, tapirRun{s: " "}, tapirRun{s: snout, color: CharmMint}),
|
||||
tapirLine(tapirRun{s: " "}, tapirRun{s: "█▓(", color: CharmPink}, tapirRun{s: " "}, tapirRun{s: "◕ ◕", color: CharmMint}, tapirRun{s: ")▓█", color: CharmPink}, tapirRun{s: "──┘", color: CharmMint}, tapirRun{s: " "}, tapirRun{s: "< thinking...", color: CharmDim}),
|
||||
tapirLine(tapirRun{s: " "}, tapirRun{s: "▀█▓▓▓▓█▀", color: CharmPink}),
|
||||
tapirLine(tapirRun{s: " "}, tapirRun{s: "██▄▄██", color: CharmPink}),
|
||||
tapirLine(tapirRun{s: " "}, tapirRun{s: "▀▀", color: CharmPink}, tapirRun{s: " "}, tapirRun{s: "▀▀", color: CharmPink}),
|
||||
tapirLine(),
|
||||
tapirLine(tapirRun{s: " "}, tapirRun{s: "[", color: CharmDim}, tapirRun{s: strings.Repeat("░", 27), color: charmTrack}, tapirRun{s: "]", color: CharmDim}),
|
||||
tapirLine(tapirRun{s: " "}, tapirRun{s: "summarizing", color: CharmDim}),
|
||||
bottom,
|
||||
}
|
||||
return strings.Join(lines, "\n")
|
||||
}
|
||||
|
||||
// The three frames differ only in the snout glyph (∩ → ∪ → ~), cross-faded by CSS
|
||||
// to read as a tapir wiggling its nose while it thinks.
|
||||
var (
|
||||
tapirFrameHTML1 = tapirFrameHTML("∩")
|
||||
tapirFrameHTML2 = tapirFrameHTML("∪")
|
||||
tapirFrameHTML3 = tapirFrameHTML("~")
|
||||
)
|
||||
|
||||
// welcomeHeroHTML is the static Charm-box tapir mascot on the public landing
|
||||
// page — the same rounded purple box / pink tapir / mint accents as the spinner,
|
||||
// but a single still frame with a friendly tagline instead of the animation.
|
||||
// Built from the shared tapirLine helpers so the aesthetic stays in one place.
|
||||
func welcomeHeroHTML() string {
|
||||
top := tapirSpan(CharmPurple, "╭"+strings.Repeat("─", tapirInteriorW)+"╮")
|
||||
bottom := tapirSpan(CharmPurple, "╰"+strings.Repeat("─", tapirInteriorW)+"╯")
|
||||
lines := []string{
|
||||
top,
|
||||
tapirLine(tapirRun{s: " "}, tapirRun{s: "◆", color: CharmMint}, tapirRun{s: " "}, tapirRun{s: "tapir", color: CharmCream}),
|
||||
tapirLine(),
|
||||
tapirLine(tapirRun{s: " "}, tapirRun{s: "▄▄▄▄▄", color: CharmPink}),
|
||||
tapirLine(tapirRun{s: " "}, tapirRun{s: "▄█▓▓▓▓█▄", color: CharmPink}, tapirRun{s: " "}, tapirRun{s: "∩", color: CharmMint}),
|
||||
tapirLine(tapirRun{s: " "}, tapirRun{s: "█▓(", color: CharmPink}, tapirRun{s: " "}, tapirRun{s: "◕ ◕", color: CharmMint}, tapirRun{s: ")▓█", color: CharmPink}, tapirRun{s: "──┘", color: CharmMint}),
|
||||
tapirLine(tapirRun{s: " "}, tapirRun{s: "▀█▓▓▓▓█▀", color: CharmPink}),
|
||||
tapirLine(tapirRun{s: " "}, tapirRun{s: "██▄▄██", color: CharmPink}),
|
||||
tapirLine(tapirRun{s: " "}, tapirRun{s: "▀▀", color: CharmPink}, tapirRun{s: " "}, tapirRun{s: "▀▀", color: CharmPink}),
|
||||
tapirLine(),
|
||||
tapirLine(tapirRun{s: " "}, tapirRun{s: "watch less, know more", color: CharmMint}),
|
||||
bottom,
|
||||
}
|
||||
return strings.Join(lines, "\n")
|
||||
}
|
||||
|
||||
var welcomeHero = welcomeHeroHTML()
|
||||
|
||||
// summarizeModeLabel names the current mode for display.
|
||||
func summarizeModeLabel(auto bool) string {
|
||||
if auto {
|
||||
@@ -222,6 +343,7 @@ var flashMessages = map[string]flashView{
|
||||
flashDisconnected: {"success", "Account disconnected."},
|
||||
flashDeleted: {"success", "Your account and all its data were deleted."},
|
||||
flashRegistered: {"success", "Welcome to Tapir — your account is ready."},
|
||||
flashAccountCreated: {"success", "Account created — log in with your email and password."},
|
||||
}
|
||||
|
||||
func flashFor(code string) (flashView, bool) {
|
||||
@@ -363,6 +485,10 @@ main { max-width: 60rem; margin: 0 auto; padding: var(--s4) var(--s3); }
|
||||
.filters input { font: inherit; padding: .4rem .55rem; border: 1px solid var(--line); border-radius: var(--radius); background: var(--card); color: var(--fg); min-width: 9rem; }
|
||||
.filters input:focus-visible { outline: 2px solid var(--accent); outline-offset: 1px; border-color: var(--accent); }
|
||||
.btn { font: inherit; font-weight: 600; padding: .45rem 1rem; border: 1px solid var(--accent); border-radius: var(--radius); background: var(--accent); color: var(--accent-fg); cursor: pointer; }
|
||||
/* anchors styled as buttons: the generic a{} / a:visited{} colour rules outrank
|
||||
.btn on <a>, painting the label accent-on-accent (invisible). Restore the
|
||||
button foreground for anchor buttons, visited included. */
|
||||
a.btn, a.btn:visited { color: var(--accent-fg); }
|
||||
.btn:hover { filter: brightness(1.05); }
|
||||
.btn:active { transform: translateY(1px); }
|
||||
|
||||
@@ -374,6 +500,9 @@ main { max-width: 60rem; margin: 0 auto; padding: var(--s4) var(--s3); }
|
||||
.card-preview { color: var(--muted); font-size: .9rem; line-height: 1.5; display: -webkit-box; -webkit-line-clamp: 1; line-clamp: 1; -webkit-box-orient: vertical; overflow: hidden; }
|
||||
.card-foot { display: flex; gap: var(--s2); align-items: center; flex-wrap: wrap; margin-top: var(--s1); }
|
||||
.chip { display: inline-block; padding: .15rem .55rem; border-radius: 999px; background: var(--accent-weak); color: var(--accent); font-size: .72rem; font-weight: 600; }
|
||||
/* passive "retrying later" chip: dim/grey (CharmDim), not the accent — it is a
|
||||
status, not an action the user can take. */
|
||||
.chip-retry { background: rgba(108, 108, 108, .16); color: #6c6c6c; }
|
||||
.card-state { color: var(--muted); font-size: .8rem; }
|
||||
.badge { display: inline-block; padding: .15rem .55rem; border-radius: 999px; background: var(--badge-bg); color: var(--badge-fg); font-size: .72rem; font-weight: 600; }
|
||||
|
||||
@@ -381,6 +510,31 @@ main { max-width: 60rem; margin: 0 auto; padding: var(--s4) var(--s3); }
|
||||
.card-pending { border-style: dashed; }
|
||||
.card-pending .card-title { color: var(--muted); font-weight: 600; }
|
||||
|
||||
/* summarizing animation — a Charmbracelet-style TUI panel rendered in the
|
||||
browser: a dark terminal card, a rounded purple box around a pink ASCII tapir,
|
||||
and a lipgloss-style progress bar. Three frames are stacked and cross-faded by
|
||||
a stepped keyframe (staggered delays) so the snout appears to wiggle; the
|
||||
progress fill grows independently via a clip animation over the dim track. */
|
||||
.card-processing { border-style: dashed; }
|
||||
.tapir-charm { position: relative; display: inline-block; background: #0d0d12; border-radius: 10px; padding: .8em 1em; margin: var(--s2) 0; font: .82rem/1.15 ui-monospace, SFMono-Regular, Menlo, "Cascadia Code", monospace; box-shadow: 0 2px 14px rgba(118, 83, 252, .25); }
|
||||
.tapir-charm pre { margin: 0; white-space: pre; opacity: 0; animation: tapir-cycle 1.2s steps(1, end) infinite; }
|
||||
.tapir-charm .tapir-f1 { position: relative; animation-delay: 0s; }
|
||||
.tapir-charm .tapir-f2 { position: absolute; top: .8em; left: 1em; animation-delay: .4s; }
|
||||
.tapir-charm .tapir-f3 { position: absolute; top: .8em; left: 1em; animation-delay: .8s; }
|
||||
@keyframes tapir-cycle { 0%, 33.32% { opacity: 1; } 33.33%, 100% { opacity: 0; } }
|
||||
/* progress fill: 27 mint cells overlaying the dim track at box row 10, col 3,
|
||||
revealed left→right over 8s, looping. */
|
||||
.tapir-bar { position: absolute; top: calc(.8em + 11.5em); left: calc(1em + 3ch); height: 1.15em; line-height: 1.15; overflow: hidden; }
|
||||
.tapir-bar-fill { animation: tapir-fill 8s linear infinite; text-shadow: 0 0 6px rgba(14, 249, 182, .7); }
|
||||
@keyframes tapir-fill { 0% { clip-path: inset(0 100% 0 0); } 100% { clip-path: inset(0 0 0 0); } }
|
||||
.tapir-label { color: var(--muted); font-size: .9rem; margin: 0; }
|
||||
@media (prefers-reduced-motion: reduce) {
|
||||
.tapir-charm pre { animation: none; }
|
||||
.tapir-charm .tapir-f2, .tapir-charm .tapir-f3 { display: none; }
|
||||
.tapir-charm .tapir-f1 { opacity: 1; }
|
||||
.tapir-bar-fill { animation: none; clip-path: inset(0 35% 0 0); }
|
||||
}
|
||||
|
||||
/* summarization mode toggle on the account page */
|
||||
.summarize-mode { display: flex; gap: var(--s3); align-items: center; flex-wrap: wrap; }
|
||||
.summarize-mode p { margin: 0; }
|
||||
@@ -390,6 +544,11 @@ main { max-width: 60rem; margin: 0 auto; padding: var(--s4) var(--s3); }
|
||||
.empty { text-align: center; color: var(--muted); padding: var(--s5) var(--s4); border: 1px dashed var(--line); border-radius: var(--radius); background: var(--card); }
|
||||
.empty strong { display: block; color: var(--fg); font-size: 1.05rem; margin-bottom: var(--s2); }
|
||||
.empty code { background: var(--accent-weak); color: var(--accent); padding: .1rem .35rem; border-radius: .3rem; }
|
||||
.empty p { margin: var(--s3) 0 0; }
|
||||
/* connected-but-empty: a distinct accent callout, not a muted blank state, so a
|
||||
fresh account knows the next step is to run tapir, not "something is broken". */
|
||||
.empty-connected { border-style: solid; border-color: var(--accent); background: var(--accent-weak); color: var(--fg); }
|
||||
.empty-connected strong { color: var(--accent); }
|
||||
|
||||
/* flash / notification banner */
|
||||
.flash { padding: var(--s2) var(--s3); border-radius: var(--radius); margin-bottom: var(--s4); font-size: .92rem; border: 1px solid var(--line); }
|
||||
@@ -458,6 +617,16 @@ main { max-width: 60rem; margin: 0 auto; padding: var(--s4) var(--s3); }
|
||||
.confirm-delete > summary:hover { background: #3a1714; }
|
||||
}
|
||||
|
||||
/* public landing page (/welcome) — the Charm-box mascot hero plus the sign-in CTA */
|
||||
.welcome { text-align: center; padding: var(--s5) var(--s3); display: flex; flex-direction: column; align-items: center; gap: var(--s4); }
|
||||
.welcome-hero { background: #0d0d12; border-radius: 10px; padding: .9em 1.1em; display: inline-block; box-shadow: 0 2px 14px rgba(118, 83, 252, .25); }
|
||||
.welcome-hero pre { margin: 0; white-space: pre; font: .82rem/1.15 ui-monospace, SFMono-Regular, Menlo, "Cascadia Code", monospace; }
|
||||
.welcome-title { font-size: 1.9rem; line-height: 1.2; margin: 0; }
|
||||
.welcome-tagline { color: var(--muted); font-size: 1.05rem; line-height: 1.5; margin: 0; max-width: 32rem; }
|
||||
.welcome-cta { display: flex; gap: var(--s3); flex-wrap: wrap; justify-content: center; align-items: center; }
|
||||
.welcome-sub { color: var(--muted); font-size: .9rem; margin: 0; }
|
||||
.btn-lg { padding: .6rem 1.6rem; font-size: 1.05rem; }
|
||||
|
||||
@media (max-width: 640px) {
|
||||
main { padding: var(--s3) var(--s2); }
|
||||
.filters { gap: var(--s2); }
|
||||
|
||||
@@ -1,6 +1,11 @@
|
||||
package web
|
||||
|
||||
import "testing"
|
||||
import (
|
||||
"regexp"
|
||||
"strings"
|
||||
"testing"
|
||||
"unicode/utf8"
|
||||
)
|
||||
|
||||
func TestEmbedURL(t *testing.T) {
|
||||
tests := []struct {
|
||||
@@ -27,3 +32,19 @@ func TestEmbedURL(t *testing.T) {
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestTapirFrameRowsAligned asserts every box row has the same cell width once
|
||||
// the inline-colour spans are stripped, so the rounded border lines up on every
|
||||
// line (the panel only looks right if the right │ is flush across all rows).
|
||||
func TestTapirFrameRowsAligned(t *testing.T) {
|
||||
stripSpan := regexp.MustCompile(`</?span[^>]*>`)
|
||||
for name, frame := range map[string]string{"f1": tapirFrameHTML1, "f2": tapirFrameHTML2, "f3": tapirFrameHTML3} {
|
||||
plain := stripSpan.ReplaceAllString(frame, "")
|
||||
want := tapirInteriorW + 2 // both purple side borders
|
||||
for i, line := range strings.Split(plain, "\n") {
|
||||
if got := utf8.RuneCountInString(line); got != want {
|
||||
t.Errorf("%s line %d width = %d, want %d: %q", name, i, got, want, line)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
+147
-5
@@ -22,7 +22,7 @@ templ Layout(title string) {
|
||||
<body>
|
||||
<header>
|
||||
<a href="/" class="brand">Tapir</a>
|
||||
<nav class="nav"><a href="/account">Account</a></nav>
|
||||
<nav class="nav"><a href="/account">Account</a><a href="/auth/logout">Log out</a></nav>
|
||||
</header>
|
||||
<main>
|
||||
{ children... }
|
||||
@@ -31,6 +31,40 @@ templ Layout(title string) {
|
||||
</html>
|
||||
}
|
||||
|
||||
// WelcomePage is the public landing page (served at /welcome, outside the auth
|
||||
// guard — ADR-012). Logged out: the tapir mascot, a one-line tagline, and a
|
||||
// single "Get Started" CTA into the shared Dex flow (sign-in and sign-up are the
|
||||
// same URL). Logged in: a greeting plus links back into the app and to log out.
|
||||
templ WelcomePage(user User, loggedIn bool) {
|
||||
@Layout("Tapir — Watch less, know more") {
|
||||
<section class="welcome">
|
||||
<div class="welcome-hero">
|
||||
<pre aria-hidden="true">@templ.Raw(welcomeHero)</pre>
|
||||
</div>
|
||||
if loggedIn {
|
||||
<h1 class="welcome-title">Welcome back</h1>
|
||||
if user.Email != "" {
|
||||
<p class="welcome-tagline">Signed in as { user.Email }.</p>
|
||||
}
|
||||
<div class="welcome-cta">
|
||||
<a class="btn btn-lg" href="/">Go to my Tapir</a>
|
||||
<a class="btn-secondary" href="/auth/logout">Log Out</a>
|
||||
</div>
|
||||
} else {
|
||||
<h1 class="welcome-title">Watch less, know more</h1>
|
||||
<p class="welcome-tagline">
|
||||
Tapir summarizes the videos your subscriptions publish, so you can
|
||||
skim the gist and decide what is worth your time.
|
||||
</p>
|
||||
<div class="welcome-cta">
|
||||
<a class="btn btn-lg" href="/auth/login">Get Started</a>
|
||||
</div>
|
||||
<p class="welcome-sub">Access is by invitation. If you have an invite link, it will set up your account automatically. Returning users with credentials can log in above.</p>
|
||||
}
|
||||
</section>
|
||||
}
|
||||
}
|
||||
|
||||
// flashBanner renders a one-shot notification for a flash code (connect success/
|
||||
// failure, disconnect, delete, registration). An empty or unknown code renders
|
||||
// nothing, so it is safe to drop into any page unconditionally. Reused across the
|
||||
@@ -45,12 +79,12 @@ templ flashBanner(code string) {
|
||||
// #summary-list region; a non-HTMX request renders the whole page. flash carries
|
||||
// a one-shot notification (e.g. "connected", "registered") surfaced on arrival
|
||||
// after a POST→redirect.
|
||||
templ ListPage(rows []store.SummaryRow, f Filter, flash string) {
|
||||
templ ListPage(rows []store.SummaryRow, f Filter, flash string, hasConnected bool) {
|
||||
@Layout("Tapir — Summaries") {
|
||||
@flashBanner(flash)
|
||||
@filterForm(f)
|
||||
<div id="summary-list">
|
||||
@summaryList(rows)
|
||||
@summaryList(rows, hasConnected)
|
||||
</div>
|
||||
}
|
||||
}
|
||||
@@ -76,12 +110,20 @@ templ filterForm(f Filter) {
|
||||
// summaryList is the swappable list fragment: one card per video (summarized or
|
||||
// not). Cards reflow to a single column on mobile; an empty list shows a friendly
|
||||
// first-run state instead of a blank table.
|
||||
templ summaryList(rows []store.SummaryRow) {
|
||||
templ summaryList(rows []store.SummaryRow, hasConnected bool) {
|
||||
if len(rows) == 0 {
|
||||
if hasConnected {
|
||||
<div class="empty empty-connected">
|
||||
<strong>Your YouTube account is connected!</strong>
|
||||
<span>Run <code>tapir run</code> to discover your subscriptions. Videos will appear here once discovered. In manual mode, each new video gets a Summarize button.</span>
|
||||
</div>
|
||||
} else {
|
||||
<div class="empty">
|
||||
<strong>No videos yet</strong>
|
||||
<span>Videos appear here as your subscriptions are processed — run <code>tapir run</code> to fetch them. In manual mode, use the Summarize button to queue one.</span>
|
||||
<span>Connect your YouTube account to get started.</span>
|
||||
<p><a class="btn" href="/oauth/youtube/connect">Connect YouTube</a></p>
|
||||
</div>
|
||||
}
|
||||
} else {
|
||||
<ul class="cards">
|
||||
for _, r := range rows {
|
||||
@@ -122,6 +164,8 @@ templ VideoCard(r store.SummaryRow) {
|
||||
if len(r.Actions) > 0 {
|
||||
<span class="card-state">{ strings.Join(r.Actions, ", ") }</span>
|
||||
}
|
||||
} else if r.TranscriptStatus == "rate_limited" {
|
||||
<span class="chip chip-retry" title="Caption fetch was rate-limited; tapir will retry automatically.">⏳ Retrying later</span>
|
||||
} else if r.SummarizeRequested {
|
||||
<span class="chip">Queued</span>
|
||||
<span class="card-state muted">waiting for the next run</span>
|
||||
@@ -140,6 +184,42 @@ templ VideoCard(r store.SummaryRow) {
|
||||
</li>
|
||||
}
|
||||
|
||||
// TapirSpinner is the summarizing animation: a Charmbracelet-style TUI panel —
|
||||
// three richly coloured ASCII tapir frames (inline span colours, snout wiggling
|
||||
// ∩→∪→~) cross-faded by CSS, plus a lipgloss-style progress bar whose mint fill
|
||||
// grows over the dim track. The panel is aria-hidden (decorative); the
|
||||
// "Summarizing…" label below carries the meaning for assistive tech.
|
||||
templ TapirSpinner() {
|
||||
<div class="tapir-charm" aria-hidden="true">
|
||||
<pre class="tapir-f1">@templ.Raw(tapirFrameHTML1)</pre>
|
||||
<pre class="tapir-f2">@templ.Raw(tapirFrameHTML2)</pre>
|
||||
<pre class="tapir-f3">@templ.Raw(tapirFrameHTML3)</pre>
|
||||
<div class="tapir-bar"><span class="tapir-bar-fill" style={ "color:" + CharmMint }>{ tapirBarFill }</span></div>
|
||||
</div>
|
||||
<p class="tapir-label" role="status" aria-live="polite"><em>Summarizing…</em></p>
|
||||
}
|
||||
|
||||
// processingCard is the in-flight summarization card. It replaces the Summarize
|
||||
// button card and polls /v/{id}/status every 2s, swapping itself (outerHTML, same
|
||||
// id as VideoCard) for whatever state comes back: it keeps polling while still
|
||||
// processing, and the summary/queued card it is eventually replaced by carries no
|
||||
// poll, so polling stops on its own when the fragment changes.
|
||||
templ processingCard(r store.SummaryRow) {
|
||||
<li
|
||||
class="card card-processing"
|
||||
id={ "video-" + r.VideoID }
|
||||
hx-get={ string(statusURL(r.VideoID)) }
|
||||
hx-trigger="every 2s"
|
||||
hx-swap="outerHTML"
|
||||
>
|
||||
<div class="card-title">{ displayTitle(r) }</div>
|
||||
if cardMeta(r) != "" {
|
||||
<div class="card-meta">{ cardMeta(r) }</div>
|
||||
}
|
||||
@TapirSpinner()
|
||||
</li>
|
||||
}
|
||||
|
||||
// DetailPage is the full summary view: text, highlights, takeaways, metadata,
|
||||
// and the action button group.
|
||||
templ DetailPage(r store.SummaryRow) {
|
||||
@@ -227,6 +307,68 @@ templ RegisterPage(email, errMsg string) {
|
||||
}
|
||||
}
|
||||
|
||||
// InvitePage is the public set-password form an invited user reaches via their
|
||||
// emailed /invite/{token} link. The email is shown read-only (it is fixed by the
|
||||
// invite, not chosen here); the visitor sets a password to create their account.
|
||||
// errMsg, when set, reports a validation problem on the prior submit. No auth
|
||||
// chrome (header nav) is appropriate — the visitor has no session yet — but the
|
||||
// shared Layout keeps the look consistent.
|
||||
templ InvitePage(email, token, errMsg string) {
|
||||
@Layout("Tapir — Set your password") {
|
||||
<article class="register">
|
||||
<h1>Set up your Tapir account</h1>
|
||||
<p class="meta">Invitation for { email }.</p>
|
||||
<p>Choose a password to finish creating your account. You'll then log in with this email and password.</p>
|
||||
if errMsg != "" {
|
||||
<p class="error" role="alert">{ errMsg }</p>
|
||||
}
|
||||
<form method="post" action={ inviteURL(token) } class="register-form">
|
||||
<label>
|
||||
Email
|
||||
<input type="email" name="email" value={ email } readonly/>
|
||||
</label>
|
||||
<label>
|
||||
Password
|
||||
<input type="password" name="password" minlength="8" required autofocus autocomplete="new-password"/>
|
||||
</label>
|
||||
<label>
|
||||
Confirm password
|
||||
<input type="password" name="password_confirm" minlength="8" required autocomplete="new-password"/>
|
||||
</label>
|
||||
<button type="submit" class="btn">Create my account</button>
|
||||
</form>
|
||||
</article>
|
||||
}
|
||||
}
|
||||
|
||||
// InviteInvalidPage is shown when an invite token is missing, expired, or already
|
||||
// used — a dead-end with no form, so a stale or replayed link reads clearly.
|
||||
templ InviteInvalidPage() {
|
||||
@Layout("Tapir — Invitation") {
|
||||
<article class="register">
|
||||
<h1>This invite link is no longer valid</h1>
|
||||
<p>This invitation has expired or has already been used. Ask for a fresh invite link, or log in if you already have an account.</p>
|
||||
<p><a class="btn" href="/auth/login">Log in</a></p>
|
||||
</article>
|
||||
}
|
||||
}
|
||||
|
||||
// InviteNoticePage is a terminal message after a submit that neither succeeded nor
|
||||
// is a retryable validation error (account already exists, RBAC missing, or the
|
||||
// dev "deployed-only" degrade). showLogin adds a log-in CTA where that is the
|
||||
// natural next step.
|
||||
templ InviteNoticePage(message string, showLogin bool) {
|
||||
@Layout("Tapir — Invitation") {
|
||||
<article class="register">
|
||||
<h1>Invitation</h1>
|
||||
<p>{ message }</p>
|
||||
if showLogin {
|
||||
<p><a class="btn" href="/auth/login">Log in</a></p>
|
||||
}
|
||||
</article>
|
||||
}
|
||||
}
|
||||
|
||||
// AccountPage is the account-management view: the registered display name and
|
||||
// signed-in email, the user's connected video accounts (each with a Disconnect
|
||||
// control), a Connect-YouTube link when none is connected, and the delete-account
|
||||
|
||||
+940
-409
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,92 @@
|
||||
package web_test
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
"gitea.d-ma.be/mathias/tapir/internal/web"
|
||||
)
|
||||
|
||||
// fakeAuth is a configurable web.Auth for the landing-page tests: it reports a
|
||||
// fixed (user, ok) from CurrentUser and, when logged out, replicates DexAuth's
|
||||
// redirect split in Middleware — bare root → /welcome, deeper paths → login.
|
||||
// StubAuth can't express the logged-out case (it allows everything), so the
|
||||
// welcome routing needs this.
|
||||
type fakeAuth struct {
|
||||
user web.User
|
||||
ok bool
|
||||
}
|
||||
|
||||
func (f fakeAuth) CurrentUser(*http.Request) (web.User, bool) { return f.user, f.ok }
|
||||
func (f fakeAuth) Routes() http.Handler { return http.NewServeMux() }
|
||||
|
||||
func (f fakeAuth) Middleware(h http.Handler) http.Handler {
|
||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
if f.ok {
|
||||
h.ServeHTTP(w, r)
|
||||
return
|
||||
}
|
||||
if r.URL.Path == "/" {
|
||||
http.Redirect(w, r, "/welcome", http.StatusFound)
|
||||
return
|
||||
}
|
||||
http.Redirect(w, r, "/auth/login", http.StatusFound)
|
||||
})
|
||||
}
|
||||
|
||||
// appWithAuth builds an App with a given Auth but no store wiring — enough for
|
||||
// the /welcome page (which never touches the store) and the unauthenticated
|
||||
// redirect paths (which never reach a handler).
|
||||
func appWithAuth(auth web.Auth) *web.App {
|
||||
return &web.App{Auth: auth}
|
||||
}
|
||||
|
||||
func TestWelcomeLoggedOut(t *testing.T) {
|
||||
app := appWithAuth(fakeAuth{ok: false})
|
||||
rec := do(t, app, httptest.NewRequest(http.MethodGet, "/welcome", nil))
|
||||
|
||||
require.Equal(t, http.StatusOK, rec.Code)
|
||||
html := body(t, rec)
|
||||
require.Contains(t, html, "Get Started", "logged-out CTA present")
|
||||
require.Contains(t, html, `href="/auth/login"`, "CTA links into the Dex flow")
|
||||
require.NotContains(t, html, "Go to my Tapir", "no logged-in controls")
|
||||
}
|
||||
|
||||
func TestWelcomeLoggedIn(t *testing.T) {
|
||||
app := appWithAuth(fakeAuth{user: web.User{Subject: "s", Email: "me@d-ma.be"}, ok: true})
|
||||
rec := do(t, app, httptest.NewRequest(http.MethodGet, "/welcome", nil))
|
||||
|
||||
require.Equal(t, http.StatusOK, rec.Code)
|
||||
html := body(t, rec)
|
||||
require.Contains(t, html, "Go to my Tapir", "logged-in CTA present")
|
||||
require.Contains(t, html, `href="/"`, "links back into the app")
|
||||
require.Contains(t, html, "me@d-ma.be", "greets by email")
|
||||
require.NotContains(t, html, "Get Started", "no logged-out CTA")
|
||||
}
|
||||
|
||||
func TestUnauthenticatedRootRedirectsToWelcome(t *testing.T) {
|
||||
app := appWithAuth(fakeAuth{ok: false})
|
||||
rec := do(t, app, httptest.NewRequest(http.MethodGet, "/", nil))
|
||||
|
||||
require.Equal(t, http.StatusFound, rec.Code)
|
||||
require.Equal(t, "/welcome", rec.Header().Get("Location"))
|
||||
}
|
||||
|
||||
func TestUnauthenticatedDeepLinkRedirectsToLogin(t *testing.T) {
|
||||
app := appWithAuth(fakeAuth{ok: false})
|
||||
rec := do(t, app, httptest.NewRequest(http.MethodGet, "/v/some-id", nil))
|
||||
|
||||
require.Equal(t, http.StatusFound, rec.Code)
|
||||
require.Equal(t, "/auth/login", rec.Header().Get("Location"))
|
||||
}
|
||||
|
||||
func TestAuthenticatedRootRendersList(t *testing.T) {
|
||||
app := newApp(t)
|
||||
resetDB(t, rawPool(t))
|
||||
rec := do(t, app, httptest.NewRequest(http.MethodGet, "/", nil))
|
||||
require.Equal(t, http.StatusOK, rec.Code)
|
||||
require.Contains(t, body(t, rec), "<html", "authenticated root still renders the list page")
|
||||
}
|
||||
Reference in New Issue
Block a user