* feat(downloads): offline sync for mobile (downloads v2) Replace internal/download with a unified internal/downloads package and add fully-offline download + watch-sync support for mobile clients, across five independently-shippable phases: - Phase 0: reshape the downloads table and the /downloads contract to be device- and format-aware; add GET /downloads/capability; extend DownloadConfig (default-off keys); update the web download hooks/components in lockstep. This is the one approved pre-lock exception to the additive-only /api/v1 rule (the web app is the only consumer and is updated together). - Phase 1: managed device-library entries (create/list/PATCH/delete/serve), keyed on the X-Silo-Device-Id header. - Phase 2: offline playback manifest plus artwork/subtitle proxy endpoints that strip every presigned URL (inline thumbhashes + authenticated proxies). - Phase 3: prepare-to-file (remux + transcode-to-single-file) as a durable, leased artifact queue with startup recovery, hosted on the task manager; playback.PrepareFile emits one +faststart MP4. Adds the admin transcode toggle and per-artifact LRU cleanup. - Phase 4: offline progress reconciliation -- a clamped event_at LWW key plus a server-assigned synced_seq cursor on watch_progress; an optional clamped updated_at on POST /sync/progress and an opaque ?since= cursor on GET /progress (additive; existing callers unaffected). Security & reliability invariants, each with an acceptance test: 1. Server-owned sync ordering: ?since= delta delivery is driven only by the server-assigned synced_seq; the client clock is bounded (event_at, clamped to now+skew) and used only for last-write-wins on the caller's own profile. 2. Full profile+device authorization on every managed endpoint, with a per-profile content/library access re-check before serving any bytes/assets. 3. Durable artifact recovery: a transactionally-claimed (FOR UPDATE SKIP LOCKED), lease-heartbeat, attempt-counted queue with a startup sweep, so no crash strands a download in preparing and concurrent workers never double-encode. Migrations are timestamped Goose files: reshape downloads (device/format); download_artifacts (durable queue); watch_progress event_at/synced_seq. DB-backed acceptance tests skip without SILO_TEST_DATABASE_URL and run in CI; the invariant-1 progress test also runs against the real SQLite backend locally. Client repos (silo-android, silo-apple) consume the reshaped /downloads/* contract and the updated_at/?since= progress fields and require coordinated follow-up. Implements the maintainer-approved v1 capability proposal for offline sync (downloads v2). AI-use disclosure: implemented by Claude (Claude Code) from the approved design doc under docs/superpowers/specs, with human review. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * feat(downloads): series & season downloads + client-pull monitoring Build season downloads and a "monitor a series" capability on top of the downloads v2 (offline sync for mobile) work. Season downloads: - POST /downloads accepts season_number (with series:true) to download one season. CreateSeries/CreateSeason share one body via a listEpisodes closure and register managed entries under a shared batch_id (original-only). Episode files are resolved in a single batched query. Series monitoring (auto-download), client-driven: - New device-scoped download_subscriptions table with a Sonarr-style mode (all | future | latest_season | specific_seasons), a client-enforced delete_watched flag, and a max_storage_bytes cap. The server never deletes on-device files; retention and the hard cap are the client's, the server only soft-gates registration. - The client calls POST /downloads/subscriptions/sync on open / background refresh; the server registers the in-scope, not-yet-downloaded episodes (idempotent via the managed-entry unique index) and the device pulls them on its own schedule. No background worker and no dependency on the notifications subsystem. latest_season follows new seasons (>= subscribe-time season); future excludes the back catalog via air date. - Subscription CRUD + sync are profile+device authorized (device id from the X-Silo-Device-Id header only) with a per-request content-access re-check. The capability endpoint advertises season_download / series_monitoring / monitoring_modes. Also lands the downloads-v2 work already present in the tree: durable artifact (remux/transcode) preparation and offline watch-progress reconciliation, plus the design-spec updates. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * WIP: epitaxy pre-switch from feat/downloads-v2-offline-sync * test(downloads): fix deterministic ID collision in reconcile test Artifact IDs are time-sortable, so two artifacts created in the same moment share their first 8 chars; combined with a captured timestamp the two preparing-download IDs collided on downloads_pkey. Use the full artifact ID, which is unique per row. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(downloads): support sqlite userdb backend for managed downloads With the sqlite userdb backend, profiles live only in per-user SQLite stores and public.user_profiles stays empty, so user_devices' profile FK made every managed create/subscription/offline-sync request fail with an FK violation. Drop the FK (shared Postgres tables must not FK profile tables — same rule as notifications) and replace the lost cascade with an app-level purge on profile deletion, wired through ProfileHandler for both backends. DB-backed regression tests cover the no-Postgres-profile-row path and the purge cascade. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(downloads): dispatch encode kick asynchronously triggerDrain invoked the kick inline, and the kick (taskmanager RunTask) executes the encode task on the caller's goroutine — so a POST /api/v1/downloads with a bitrate quality blocked the HTTP request on the entire queue drain, ffmpeg encodes included, delaying the 202 by minutes on an idle queue. Dispatch the kick on a goroutine; the task manager already serializes concurrent runs. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(downloads): enforce per-user quota on the encode pipeline Two gaps let a user bypass MaxConcurrentPerUser entirely for prepared downloads: artifact-backed rows are created in 'preparing' (never 'queued'/'downloading'), which CountActiveByUser didn't count, and createArtifactDownload enqueued the encode job before limiter.Check, so even a 429-rejected request left a job the worker would transcode. Count 'preparing' as active and check the limiter before Ensure; managed replacements stay quota-exempt since they don't add a row. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(downloads): protect ephemeral artifact links from LRU eviction HasActiveLink only counted managed (device_id IS NOT NULL) rows, so under a byte budget Cleanup could delete an artifact still referenced by a ready-but-unfetched ephemeral web download — permanently 404ing a row the API kept listing as ready (the artifact row is gone, so recovery can't re-queue it). Any non-terminal link now protects the artifact; only artifacts whose links are all cancelled/failed/revoked are evictable. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(downloads): batch manifests skip bad entries instead of failing whole batch One deleted or access-filtered episode made GET /downloads/batches/{id}/manifests 404 for the entire season, so a client could no longer fetch manifests for the still-valid entries. Report unbuildable entries in a skipped[] array (revoked | not_found | error) alongside the delivered manifests, mirroring the create path's skip idiom. Also cut the batch cost: the shared series detail is resolved once per batch instead of once per episode, and buildSubtitles reuses the already-loaded media file instead of re-querying it per manifest. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(migrations): wrap DO block in StatementBegin/End markers Under NO TRANSACTION goose splits statements on semicolons, so the dollar-quoted DO block failed every fresh install with 'unterminated dollar-quoted string' (SQLSTATE 42601). Already-applied databases are unaffected. Same fix is being applied to main; identical content merges cleanly. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(api): allow season 0 (Specials) in season downloads season_number was a plain int dispatched with '> 0', so requesting the Specials season was indistinguishable from omitting the field and silently broadened to a full-series download. Dispatch on pointer presence, treat 0 as the Specials season, and reject negatives with 400. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(downloads): capability quality_presets is never JSON null PresetsFor returned a nil slice when downloads are disabled or the user lacks the permission, and Capability's []string{} initialization was immediately overwritten by it — so GET /downloads/capability serialized "quality_presets": null where the contract documents an array. Normalize at the source so every caller inherits the guarantee. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(downloads): subscription sync correctness + batched registration Three subscription fixes: - A paused subscription no longer syncs: PATCHing scope (or pausing and changing scope in one request) registered episodes for a monitor the user had just stopped, inconsistently with SyncSubscriptions' guard. - SubModeFuture compares calendar days (UTC): air_date is date-only, so the strict instant comparison permanently excluded episodes airing the same day the user subscribed; episodes with no air date now fall back to their ingest time instead of never registering. - Registration is one batched fetch (GetManagedEntriesByKeys) plus one batched INSERT ... ON CONFLICT DO NOTHING RETURNING (CreateManagedEntriesBatch) instead of a SELECT+INSERT per episode — a 300-episode series cost ~600 sequential round trips per request and every no-op sync re-walked the full set. RETURNING yields exactly the new rows, so the sync response's 'registered' count now honestly reports 0 in the steady state instead of the full in-scope count on every app open. The now-unused InsertManagedEntryIfAbsent is removed. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(userstore): stamp triggers own the event_at LWW key MarkProgressBatch (jellycompat series mark-played) advanced updated_at but never event_at, and both stamp triggers only defaulted event_at when NULL — so a queued offline event with a client time between the row's old event_at and the mark could win SetProgressIfNewer and resurrect a stale resume position that then re-synced to every device. Make the triggers authoritative instead of adding a tenth hand-written SET clause: whenever an UPDATE changes updated_at without explicitly changing event_at, the trigger advances the LWW key; writes that do set event_at (offline sync's clamped client event time) keep their value. Postgres gets a CREATE OR REPLACE migration; SQLite gets a v12 userdb migration that drops and reinstalls the trigger bodies (CREATE TRIGGER IF NOT EXISTS never replaces). Conformance tests cover both batch paths, the preserved-client-time invariant, and the v11→v12 upgrade. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(downloads): lifecycle hygiene — squash migrations, dead status, stale-row sweeps Migrations: fold the 20260621 corrective migration back into the base Downloads V2 migrations (its columns/constraints already exist there) and fix the reshape Down, which re-added the narrow status CHECK without collapsing managed-lifecycle rows first — rollback aborted on any DB with preparing/ready/revoked rows; validated against a live row. Branch databases that applied the corrective migration need its version row removed: DELETE FROM goose_db_version WHERE version_id = 20260621020459. Code: drop the dead 'registered' status (nothing ever wrote it; the lifecycle is preparing -> ready; 'revoked' stays reserved for the planned admin revoke flow) along with unused KindDirect and ErrInvalidFormat. Sweeps: Cleanup now runs an age-based hygiene pass independent of the byte budget — cold terminally-failed artifacts (with .part leftovers), orphaned ready artifacts no download row references, and ephemeral web rows older than their convenience-record lifetime (also unpinning their artifacts and bounding GET /downloads growth). The byte budget remains the disk quota per the limits & restrictions design. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * docs(downloads): sync API doc with v2 fixes; HEAD on file route; Android handoff Document the contract changes from the review fixes: batch-manifest skipped[] shape, honest subscription 'registered' semantics, season 0 = Specials, always-array quality_presets, bytes_sent actual behavior, ephemeral 7-day retention, header-pairing requirement, progress-delta deletion caveat, and the ready/failed push event schema (new §9.4). Add an Android client handoff section (§11) mirroring the Apple one, register HEAD on /downloads/{id}/file for download stacks that probe before ranged GETs, and add season_number to the web create-request type. Flag the /direct-download session-token-in-URL tradeoff; a short-lived download-scoped URL is a follow-up. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * refactor: consolidate download/progress helpers, prune dead code, gate sweeps Behavior-preserving consolidation from the Downloads V2 review: - appendVideoFilterArgs: one home for the burn-in/hwaccel -vf selection, shared by the HLS builder and the single-file prepare builder (the drift pattern that already bit tone-mapping once). - userstore.ResolveProgressState: one home for the min-resume/watched threshold rule, replacing five identical copies across both store backends and the offline-sync ingest. - Download file selection ranks resolutions via access.CompareQuality (adds 4320p, agrees with playback) instead of a private switch. - writeSubtitle uses the shared subtitles.SubtitleContentType mapping. - config.DefaultTranscodeDir replaces three '/tmp/silo-transcode' literals. - Read-side quality/revision defaulting helpers removed: insertArgs plus the NOT NULL/CHECK schema already guarantee the invariant. - Dead code removed: Repository.ListByUser, SubscriptionRepository. ListActiveBySeries, and the stale auto-register-worker comments (the design is client-pull; no worker exists). - Redundant left-prefix indexes dropped from the base migrations (their unique indexes serve the same prefixes). - recover()'s disk-presence sweep and the stale-row hygiene sweep run on startup then hourly instead of every 30s tick (both are O(cache size)). - gofmt/prettier fixes for pre-existing drift in handlers/playback.go and pages/Profiles.tsx. Deferred (noted for follow-ups): quality-ladder preset table collides with the drafted download limits & restrictions design, which specifies its own ladder helper; Download-literal construction consolidation and the managed-identity value object remain open. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * docs(downloads): draft download limits & restrictions design Design input for the follow-up v1 capability proposal (quality ceiling, batch size cap, per-user quantity/bandwidth overrides). Committed with downloads v2 because the remediation work explicitly defers the quality ladder refactor and revocation wiring to this spec. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(progress): reject malformed updated_at; clamp negative progress inputs Review findings on #258: - A malformed (non-RFC3339) updated_at in POST /sync/progress previously parsed to the zero time, which clampEventAt treated as "now" — letting a stale offline event win LWW as a fresh server-time write. The item is now rejected with a per-item error instead. - ResolveProgressState now clamps negative position/duration before classification so no backend can persist negative progress through UpdateProgress/SetProgress. - The online-write event_at invariant test is table-driven over both SetProgress and UpdateProgress, which share the same contract. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(downloads): close review gaps — permission gates, file-access recheck, artifact-true manifests Review findings on #258: - UpdateSubscription now applies the same feature/DownloadAllowed gate as CreateSubscription and SyncSubscriptions; a PATCH could previously re-activate or widen a monitor and register managed rows after an admin disabled downloads or revoked the user. - Serving download bytes (managed and ephemeral) and /direct-download now mirror playback's per-file authorization via catalog.FileAllowedByAccess: library scope and the profile's max playback quality are re-checked at serve time, with artifact-backed rows checked against the artifact's resolution (a 720p transcode of a 4K source stays servable under a 1080p ceiling). - Offline manifests for remux/transcode entries now describe the prepared artifact (container, codecs, resolution, single selected audio track) instead of the catalog source file the client never receives. - ArtifactRepository.Requeue reports ErrNotFound when the row was concurrently swept; ArtifactManager.Ensure recreates the job in that case instead of linking downloads to a dead artifact id. - "No downloadable episodes" is a sentinel (mapped to 404 no_downloadable_episodes) rather than a bare error that surfaced as 500. - Subscription season_numbers are bounds-checked (0–9999) before the int32 narrowing in the repo could silently wrap them. - HandlePatchDownload reuses requireManaged instead of hand-rolling the same managed-identity checks. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
583 lines
19 KiB
Go
583 lines
19 KiB
Go
package downloads
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"log/slog"
|
|
"os"
|
|
"sync"
|
|
"time"
|
|
|
|
"github.com/Silo-Server/silo-server/internal/config"
|
|
"github.com/Silo-Server/silo-server/internal/idgen"
|
|
"github.com/Silo-Server/silo-server/internal/models"
|
|
"github.com/Silo-Server/silo-server/internal/playback"
|
|
)
|
|
|
|
const (
|
|
artifactLease = 2 * time.Minute
|
|
artifactHeartbeat = 40 * time.Second
|
|
artifactMaxAttempts = 3
|
|
)
|
|
|
|
// EncodePreparer produces a single finalized file for an artifact. The default
|
|
// implementation calls playback.PrepareFile; tests substitute a fake.
|
|
type EncodePreparer interface {
|
|
PrepareFile(ctx context.Context, opts playback.TranscodeOpts, outputPath string) error
|
|
}
|
|
|
|
type playbackPreparer struct{}
|
|
|
|
func (playbackPreparer) PrepareFile(ctx context.Context, opts playback.TranscodeOpts, outputPath string) error {
|
|
return playback.PrepareFile(ctx, opts, outputPath)
|
|
}
|
|
|
|
// NewPlaybackPreparer returns the production EncodePreparer (ffmpeg-backed).
|
|
func NewPlaybackPreparer() EncodePreparer { return playbackPreparer{} }
|
|
|
|
// ArtifactNotifier publishes an event when a linked download changes state.
|
|
type ArtifactNotifier func(ctx context.Context, d *Download)
|
|
|
|
// ArtifactManager owns the durable encode queue: it ensures/deduplicates encode
|
|
// jobs, drains them through a bounded worker pool with leased heartbeats, and
|
|
// recovers stranded jobs on startup.
|
|
type ArtifactManager struct {
|
|
repo *ArtifactRepository
|
|
downloads *Repository
|
|
fileRepo FileResolver
|
|
preparer EncodePreparer
|
|
owner string
|
|
liveCfg func() *config.Config
|
|
notify ArtifactNotifier
|
|
|
|
mu sync.Mutex
|
|
kick func()
|
|
lastDiskSweep time.Time
|
|
lastStaleSweep time.Time
|
|
}
|
|
|
|
// maintenanceInterval spaces the disk-presence and stale-row sweeps: both are
|
|
// O(cache size) (stats / extra queries) and their failure modes self-heal, so
|
|
// running them on every 30s task tick is steady-state waste that grows with
|
|
// the artifact cache. The first run after startup always executes.
|
|
const maintenanceInterval = time.Hour
|
|
|
|
// maintenanceDue reports whether the sweep guarded by last is due, advancing
|
|
// the stamp when it is.
|
|
func (m *ArtifactManager) maintenanceDue(last *time.Time) bool {
|
|
m.mu.Lock()
|
|
defer m.mu.Unlock()
|
|
if !last.IsZero() && time.Since(*last) < maintenanceInterval {
|
|
return false
|
|
}
|
|
*last = time.Now()
|
|
return true
|
|
}
|
|
|
|
// NewArtifactManager constructs an ArtifactManager. liveCfg reads the current
|
|
// config (artifact dir, worker-pool size, byte budget, ffmpeg/hwaccel); owner is
|
|
// this node's id for lease ownership; notify (optional) publishes ready/failed.
|
|
func NewArtifactManager(
|
|
repo *ArtifactRepository,
|
|
downloadRepo *Repository,
|
|
fileRepo FileResolver,
|
|
preparer EncodePreparer,
|
|
owner string,
|
|
liveCfg func() *config.Config,
|
|
notify ArtifactNotifier,
|
|
) *ArtifactManager {
|
|
if preparer == nil {
|
|
preparer = playbackPreparer{}
|
|
}
|
|
if owner == "" {
|
|
owner = "node"
|
|
}
|
|
return &ArtifactManager{
|
|
repo: repo, downloads: downloadRepo, fileRepo: fileRepo, preparer: preparer,
|
|
owner: owner, liveCfg: liveCfg, notify: notify,
|
|
}
|
|
}
|
|
|
|
// SetKick wires a low-latency drain trigger (e.g. taskmanager RunTask) invoked
|
|
// when a new job is enqueued.
|
|
func (m *ArtifactManager) SetKick(kick func()) {
|
|
m.mu.Lock()
|
|
m.kick = kick
|
|
m.mu.Unlock()
|
|
}
|
|
|
|
// Ready returns a ready artifact for serving and bumps its LRU timestamp.
|
|
// Returns ErrDownloadNotActive when the artifact is not yet ready.
|
|
func (m *ArtifactManager) Ready(ctx context.Context, id string) (*Artifact, error) {
|
|
a, err := m.repo.GetByID(ctx, id)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if a.Status != ArtifactReady {
|
|
return nil, fmt.Errorf("artifact is %s: %w", a.Status, ErrDownloadNotActive)
|
|
}
|
|
_ = m.repo.TouchLastUsed(ctx, id)
|
|
return a, nil
|
|
}
|
|
|
|
func (m *ArtifactManager) downloadConfig() config.DownloadConfig {
|
|
if m.liveCfg != nil {
|
|
if c := m.liveCfg(); c != nil {
|
|
return c.Download
|
|
}
|
|
}
|
|
return config.DownloadConfig{}
|
|
}
|
|
|
|
// artifactDir resolves the effective output directory for prepared artifacts,
|
|
// defaulting under the transcode dir when download.artifact_dir is unset so
|
|
// encodes never write relative to the process working directory.
|
|
func (m *ArtifactManager) artifactDir() string {
|
|
var artifactDir, transcodeDir string
|
|
if m.liveCfg != nil {
|
|
if c := m.liveCfg(); c != nil {
|
|
artifactDir = c.Download.ArtifactDir
|
|
transcodeDir = c.Playback.TranscodeDir
|
|
}
|
|
}
|
|
return effectiveArtifactDir(artifactDir, transcodeDir)
|
|
}
|
|
|
|
// Ensure deduplicates and (when new) enqueues an encode job for file in the
|
|
// given format, returning the current artifact row. The deterministic
|
|
// output_path keeps a reclaimed job idempotent.
|
|
func (m *ArtifactManager) Ensure(ctx context.Context, file *models.MediaFile, format string, target playback.PrepareTarget) (*Artifact, error) {
|
|
hash := paramsHash(format, target.Container, target.CodecVideo, target.CodecAudio, target.Resolution, target.AudioTrackIndex, target.TargetBitrateKbps, false)
|
|
id, err := idgen.NextID()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
a := &Artifact{
|
|
ID: id,
|
|
MediaFileID: file.ID,
|
|
Format: format,
|
|
ParamsHash: hash,
|
|
Container: target.Container,
|
|
CodecVideo: target.CodecVideo,
|
|
CodecAudio: target.CodecAudio,
|
|
Resolution: target.Resolution,
|
|
AudioTrackIndex: target.AudioTrackIndex,
|
|
TargetBitrateKbps: target.TargetBitrateKbps,
|
|
OutputPath: artifactOutputPath(m.artifactDir(), file.ID, format, hash),
|
|
MaxAttempts: artifactMaxAttempts,
|
|
}
|
|
row, created, err := m.repo.EnsureQueued(ctx, a)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if row.Status == ArtifactReady {
|
|
_ = m.repo.TouchLastUsed(ctx, row.ID)
|
|
return row, nil
|
|
}
|
|
// A terminally-failed dedup row would otherwise strand every new download
|
|
// linked to it in 'preparing' forever (no drain is triggered for an existing
|
|
// row). Requeue it for a fresh attempt so the new download can resolve — or
|
|
// fail cleanly via reconciliation once the encode is exhausted again.
|
|
if row.Status == ArtifactFailed {
|
|
switch err := m.repo.Requeue(ctx, row.ID); {
|
|
case errors.Is(err, ErrNotFound):
|
|
// The failed row was swept between EnsureQueued and Requeue:
|
|
// create a fresh job instead of linking to a dead artifact id.
|
|
if row, _, err = m.repo.EnsureQueued(ctx, a); err != nil {
|
|
return nil, err
|
|
}
|
|
case err != nil:
|
|
return nil, err
|
|
default:
|
|
row.Status = ArtifactQueued
|
|
}
|
|
m.triggerDrain()
|
|
return row, nil
|
|
}
|
|
if created {
|
|
m.triggerDrain()
|
|
}
|
|
return row, nil
|
|
}
|
|
|
|
func (m *ArtifactManager) triggerDrain() {
|
|
m.mu.Lock()
|
|
kick := m.kick
|
|
m.mu.Unlock()
|
|
if kick != nil {
|
|
// Ensure is called on request goroutines and the kick runs the encode
|
|
// task to completion (the task manager serializes concurrent runs), so
|
|
// it must never execute inline: a POST /downloads would otherwise block
|
|
// on the entire queue drain, ffmpeg encodes included.
|
|
go kick()
|
|
}
|
|
}
|
|
|
|
// RunOnce performs a startup-safe recovery sweep and then drains the queue
|
|
// until empty. It is safe to call concurrently across nodes; FOR UPDATE SKIP
|
|
// LOCKED prevents double-encoding.
|
|
func (m *ArtifactManager) RunOnce(ctx context.Context) error {
|
|
m.recover(ctx)
|
|
return m.drain(ctx)
|
|
}
|
|
|
|
// recover repairs state a crash or lost lease can leave behind: it reclaims
|
|
// expired-lease running rows (back to queued, or failed when attempts are
|
|
// exhausted), reconciles linked downloads against terminal artifact states, and
|
|
// re-queues ready artifacts whose output file is missing on disk. Safe to run
|
|
// repeatedly (each step is idempotent).
|
|
func (m *ArtifactManager) recover(ctx context.Context) {
|
|
if _, err := m.repo.ReclaimExpiredLeases(ctx); err != nil {
|
|
slog.Warn("download artifact lease reclaim failed", "error", err)
|
|
}
|
|
|
|
// Reconcile downloads stranded in 'preparing' against their artifact's
|
|
// terminal state: this closes the non-transactional window between an
|
|
// artifact's MarkReady and its MarkLinkedDownloadsReady, and fails the links
|
|
// of any artifact that reached 'failed' (including the rows just reclaimed to
|
|
// failed above) so a download can never sit 'preparing' forever.
|
|
readyFlipped, failedFlipped, err := m.downloads.ReconcileLinkedDownloads(ctx)
|
|
if err != nil {
|
|
slog.Warn("reconciling linked downloads failed", "error", err)
|
|
} else {
|
|
for _, d := range readyFlipped {
|
|
m.publish(ctx, d)
|
|
}
|
|
for _, d := range failedFlipped {
|
|
m.publish(ctx, d)
|
|
}
|
|
}
|
|
|
|
// Disk-presence sweep: stats every ready file, so it runs on the startup
|
|
// pass and then hourly rather than on every tick.
|
|
if !m.maintenanceDue(&m.lastDiskSweep) {
|
|
return
|
|
}
|
|
ready, err := m.repo.ListReady(ctx)
|
|
if err != nil {
|
|
slog.Warn("download artifact ready scan failed", "error", err)
|
|
return
|
|
}
|
|
for _, a := range ready {
|
|
if a.OutputPath == "" {
|
|
continue
|
|
}
|
|
if _, statErr := os.Stat(a.OutputPath); statErr != nil {
|
|
slog.Warn("download artifact output missing, re-queuing", "artifact_id", a.ID, "path", a.OutputPath)
|
|
if err := m.repo.Requeue(ctx, a.ID); err != nil {
|
|
slog.Warn("re-queue artifact failed", "artifact_id", a.ID, "error", err)
|
|
continue
|
|
}
|
|
m.triggerDrain()
|
|
}
|
|
}
|
|
}
|
|
|
|
// drain claims and encodes jobs through a bounded worker pool until the queue is
|
|
// empty or the context is canceled.
|
|
func (m *ArtifactManager) drain(ctx context.Context) error {
|
|
maxConcurrent := m.downloadConfig().MaxConcurrentPrepares
|
|
if maxConcurrent <= 0 {
|
|
maxConcurrent = 2
|
|
}
|
|
sem := make(chan struct{}, maxConcurrent)
|
|
var wg sync.WaitGroup
|
|
for {
|
|
// Acquire a worker slot BEFORE claiming. A claimed job is leased but only
|
|
// heartbeated once encodeOne runs; claiming first and then blocking for a
|
|
// slot would leave the job leased-but-unattended, so its lease could lapse
|
|
// while it waits — letting another node steal it and encode the same
|
|
// output path concurrently. Reserving the slot first closes that window.
|
|
select {
|
|
case sem <- struct{}{}:
|
|
case <-ctx.Done():
|
|
wg.Wait()
|
|
return ctx.Err()
|
|
}
|
|
job, err := m.repo.ClaimNext(ctx, m.owner, artifactLease)
|
|
if err != nil {
|
|
<-sem // release the slot we reserved but won't use
|
|
if errors.Is(err, ErrNoArtifactJob) {
|
|
break
|
|
}
|
|
wg.Wait()
|
|
return err // includes context cancellation (pgx honors ctx)
|
|
}
|
|
wg.Add(1)
|
|
go func(a *Artifact) {
|
|
defer wg.Done()
|
|
defer func() { <-sem }()
|
|
m.encodeOne(ctx, a)
|
|
}(job)
|
|
}
|
|
wg.Wait()
|
|
return nil
|
|
}
|
|
|
|
// encodeOne runs one claimed job to completion, extending its lease via a
|
|
// heartbeat, and links/notifies the dependent download rows on the outcome.
|
|
func (m *ArtifactManager) encodeOne(ctx context.Context, a *Artifact) {
|
|
hbCtx, cancelHB := context.WithCancel(ctx)
|
|
defer cancelHB()
|
|
// heartbeatLoop cancels hbCtx if the lease is lost; PrepareFile runs on hbCtx
|
|
// so that cancellation aborts ffmpeg, ensuring we never keep writing the
|
|
// output path after another worker has taken the job.
|
|
go m.heartbeatLoop(hbCtx, cancelHB, a.ID)
|
|
|
|
file, err := m.fileRepo.GetByID(ctx, a.MediaFileID)
|
|
if err != nil || file == nil {
|
|
m.failJob(ctx, a, "source media file unavailable")
|
|
return
|
|
}
|
|
|
|
opts := m.buildOpts(file, a)
|
|
if err := m.preparer.PrepareFile(hbCtx, opts, a.OutputPath); err != nil {
|
|
switch {
|
|
case ctx.Err() != nil:
|
|
// Parent shutting down: leave the job 'running'; its lease expires and
|
|
// recovery (here or on another node) reclaims it.
|
|
return
|
|
case hbCtx.Err() != nil:
|
|
// We lost the lease mid-encode; another worker now owns the job.
|
|
slog.Warn("download artifact encode aborted; lease lost", "artifact_id", a.ID)
|
|
return
|
|
default:
|
|
slog.Warn("download artifact encode failed", "artifact_id", a.ID, "error", err)
|
|
m.failJob(ctx, a, err.Error())
|
|
return
|
|
}
|
|
}
|
|
|
|
var size int64
|
|
if fi, statErr := os.Stat(a.OutputPath); statErr == nil {
|
|
size = fi.Size()
|
|
}
|
|
// Fenced on lease ownership: if we lost the lease between encode and commit,
|
|
// applied is false and the current owner is responsible for flipping links —
|
|
// do not flip them here or we would race/duplicate that owner's work.
|
|
applied, err := m.repo.MarkReady(ctx, a.ID, m.owner, a.OutputPath, size)
|
|
if err != nil {
|
|
slog.Error("marking artifact ready failed", "artifact_id", a.ID, "error", err)
|
|
return
|
|
}
|
|
if !applied {
|
|
slog.Warn("download artifact ready skipped; lease lost", "artifact_id", a.ID)
|
|
return
|
|
}
|
|
flipped, err := m.downloads.MarkLinkedDownloadsReady(ctx, a.ID, size)
|
|
if err != nil {
|
|
slog.Error("flipping linked downloads ready failed", "artifact_id", a.ID, "error", err)
|
|
return
|
|
}
|
|
for _, d := range flipped {
|
|
m.publish(ctx, d)
|
|
}
|
|
}
|
|
|
|
func (m *ArtifactManager) failJob(ctx context.Context, a *Artifact, msg string) {
|
|
terminal, applied, err := m.repo.MarkFailedOrRetry(ctx, a.ID, m.owner, msg, backoffFor(a.Attempts))
|
|
if err != nil {
|
|
slog.Error("marking artifact failed/retry errored", "artifact_id", a.ID, "error", err)
|
|
return
|
|
}
|
|
if !applied {
|
|
// Lease lost; the current owner is responsible for the job's outcome.
|
|
return
|
|
}
|
|
if terminal {
|
|
m.failLinkedDownloads(ctx, a.ID, msg)
|
|
} else {
|
|
m.triggerDrain()
|
|
}
|
|
}
|
|
|
|
func (m *ArtifactManager) failLinkedDownloads(ctx context.Context, artifactID, msg string) {
|
|
flipped, err := m.downloads.MarkLinkedDownloadsFailed(ctx, artifactID, msg)
|
|
if err != nil {
|
|
slog.Error("flipping linked downloads failed errored", "artifact_id", artifactID, "error", err)
|
|
return
|
|
}
|
|
for _, d := range flipped {
|
|
m.publish(ctx, d)
|
|
}
|
|
}
|
|
|
|
func (m *ArtifactManager) publish(ctx context.Context, d *Download) {
|
|
if m.notify != nil {
|
|
m.notify(ctx, d)
|
|
}
|
|
}
|
|
|
|
// heartbeatLoop extends the job's lease until ctx is done. If the lease is lost
|
|
// (another worker stole it, or the row is gone) it calls cancel to abort the
|
|
// encode so two workers never write the same output path. A transient DB error
|
|
// is retried on the next tick rather than aborting a healthy encode.
|
|
func (m *ArtifactManager) heartbeatLoop(ctx context.Context, cancel context.CancelFunc, id string) {
|
|
ticker := time.NewTicker(artifactHeartbeat)
|
|
defer ticker.Stop()
|
|
for {
|
|
select {
|
|
case <-ctx.Done():
|
|
return
|
|
case <-ticker.C:
|
|
ok, err := m.repo.Heartbeat(ctx, id, m.owner, artifactLease)
|
|
switch {
|
|
case err != nil && ctx.Err() != nil:
|
|
return // encode finished or shutting down
|
|
case err != nil:
|
|
slog.Warn("download artifact heartbeat errored", "artifact_id", id, "error", err)
|
|
case !ok:
|
|
slog.Warn("download artifact lease lost; aborting encode", "artifact_id", id)
|
|
cancel()
|
|
return
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
func (m *ArtifactManager) buildOpts(file *models.MediaFile, a *Artifact) playback.TranscodeOpts {
|
|
cfg := config.Config{}
|
|
if m.liveCfg != nil {
|
|
if c := m.liveCfg(); c != nil {
|
|
cfg = *c
|
|
}
|
|
}
|
|
return playback.TranscodeOpts{
|
|
InputPath: file.FilePath,
|
|
SourceVideoCodec: file.CodecVideo,
|
|
TargetCodecVideo: a.CodecVideo,
|
|
TargetCodecAudio: a.CodecAudio,
|
|
TargetResolution: a.Resolution,
|
|
TargetBitrateKbps: a.TargetBitrateKbps,
|
|
AudioTrackIndex: a.AudioTrackIndex,
|
|
SubtitleTrackIndex: -1,
|
|
FFmpegPath: cfg.Playback.FFmpegPath,
|
|
HWAccel: cfg.Playback.HWAccel,
|
|
HWDevice: cfg.Playback.HWDevice,
|
|
TotalDuration: float64(file.Duration),
|
|
}
|
|
}
|
|
|
|
// Hygiene retention windows. These remove only rows nothing can serve again —
|
|
// terminally-failed jobs (linked downloads already flipped to failed by
|
|
// reconciliation) and ready artifacts whose every referencing download row was
|
|
// deleted — plus ephemeral web rows past their convenience-record lifetime.
|
|
// The server-disk *quota* is download.artifact_max_bytes (see the download
|
|
// limits & restrictions design); this sweep is not a quota.
|
|
const (
|
|
failedArtifactRetention = 24 * time.Hour
|
|
unlinkedArtifactRetention = 30 * 24 * time.Hour
|
|
ephemeralDownloadRetention = 7 * 24 * time.Hour
|
|
)
|
|
|
|
// Cleanup runs the hygiene sweep, then evicts ready artifacts (LRU first) once
|
|
// the total exceeds the byte budget, never removing one still linked by any
|
|
// active download row (managed or ephemeral) — only artifacts whose links are
|
|
// all terminal are evictable.
|
|
func (m *ArtifactManager) Cleanup(ctx context.Context) error {
|
|
m.sweepStale(ctx)
|
|
budget := m.downloadConfig().ArtifactMaxBytes
|
|
if budget <= 0 {
|
|
return nil // unlimited
|
|
}
|
|
total, err := m.repo.TotalReadyBytes(ctx)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if total <= budget {
|
|
return nil
|
|
}
|
|
candidates, err := m.repo.ListReady(ctx) // least-recently-used first
|
|
if err != nil {
|
|
return err
|
|
}
|
|
for _, a := range candidates {
|
|
if total <= budget {
|
|
break
|
|
}
|
|
active, err := m.repo.HasActiveLink(ctx, a.ID)
|
|
if err != nil {
|
|
slog.Warn("artifact link check failed", "artifact_id", a.ID, "error", err)
|
|
continue
|
|
}
|
|
if active {
|
|
continue
|
|
}
|
|
if a.OutputPath != "" {
|
|
if err := os.Remove(a.OutputPath); err != nil && !os.IsNotExist(err) {
|
|
slog.Warn("removing evicted artifact file failed", "artifact_id", a.ID, "error", err)
|
|
}
|
|
}
|
|
if err := m.repo.DeleteArtifact(ctx, a.ID); err != nil {
|
|
slog.Warn("deleting evicted artifact row failed", "artifact_id", a.ID, "error", err)
|
|
continue
|
|
}
|
|
slog.Info("evicted download artifact (LRU)", "artifact_id", a.ID, "bytes", a.FileSize)
|
|
total -= a.FileSize
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// sweepStale is the age-based hygiene pass: cold terminally-failed artifacts
|
|
// (with their leftover .part files), orphaned ready artifacts no download row
|
|
// references, and expired ephemeral download rows. Best-effort; every step
|
|
// logs and continues.
|
|
func (m *ArtifactManager) sweepStale(ctx context.Context) {
|
|
if !m.maintenanceDue(&m.lastStaleSweep) {
|
|
return
|
|
}
|
|
now := time.Now()
|
|
if failed, err := m.repo.ListFailedBefore(ctx, now.Add(-failedArtifactRetention)); err != nil {
|
|
slog.Warn("failed-artifact sweep list failed", "error", err)
|
|
} else {
|
|
for _, a := range failed {
|
|
m.removeArtifact(ctx, a, "failed")
|
|
}
|
|
}
|
|
if orphans, err := m.repo.ListUnlinkedReadyBefore(ctx, now.Add(-unlinkedArtifactRetention)); err != nil {
|
|
slog.Warn("unlinked-artifact sweep list failed", "error", err)
|
|
} else {
|
|
for _, a := range orphans {
|
|
m.removeArtifact(ctx, a, "unlinked")
|
|
}
|
|
}
|
|
if m.downloads != nil {
|
|
if n, err := m.downloads.PruneEphemeralOlderThan(ctx, now.Add(-ephemeralDownloadRetention)); err != nil {
|
|
slog.Warn("ephemeral download prune failed", "error", err)
|
|
} else if n > 0 {
|
|
slog.Info("pruned expired ephemeral downloads", "rows", n)
|
|
}
|
|
}
|
|
}
|
|
|
|
// removeArtifact deletes an artifact's output file, its .part leftover, and
|
|
// its row. Used by the hygiene sweep for rows nothing can serve again.
|
|
func (m *ArtifactManager) removeArtifact(ctx context.Context, a *Artifact, reason string) {
|
|
if a.OutputPath != "" {
|
|
if err := os.Remove(a.OutputPath); err != nil && !os.IsNotExist(err) {
|
|
slog.Warn("removing swept artifact file failed", "artifact_id", a.ID, "error", err)
|
|
}
|
|
if err := os.Remove(a.OutputPath + ".part"); err != nil && !os.IsNotExist(err) {
|
|
slog.Warn("removing swept artifact partial failed", "artifact_id", a.ID, "error", err)
|
|
}
|
|
}
|
|
if err := m.repo.DeleteArtifact(ctx, a.ID); err != nil {
|
|
slog.Warn("deleting swept artifact row failed", "artifact_id", a.ID, "error", err)
|
|
return
|
|
}
|
|
slog.Info("swept stale download artifact", "artifact_id", a.ID, "reason", reason, "bytes", a.FileSize)
|
|
}
|
|
|
|
// backoffFor returns the retry delay for the next attempt after a failure.
|
|
func backoffFor(attempts int) time.Duration {
|
|
if attempts < 1 {
|
|
attempts = 1
|
|
}
|
|
d := time.Duration(attempts) * 30 * time.Second
|
|
if d > 5*time.Minute {
|
|
d = 5 * time.Minute
|
|
}
|
|
return d
|
|
}
|