ee31a1f0e2
* feat(playback): formalize resumable direct streams and stall observability Implements #443: strong stat-based ETag + If-Range on original-file direct play (via http.ServeContent), stream-end outcome classification in RollingDeadlineWriter (stalled_reap vs client_gone vs completed) with a structured log event and Prometheus counters, the direct_stream_resume_v1 protocol-v3 capability, and a contract doc. Progressive remux is explicitly excluded from the resume contract. Code written by OpenAI Codex CLI (gpt-5.6-sol) from a Claude-authored spec; reviewed and verified by Claude. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(playback): harden direct stream resume contract * test(playback): cover resume platform contracts --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
367 lines
12 KiB
Go
367 lines
12 KiB
Go
package handlers
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"os"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/go-chi/chi/v5"
|
|
|
|
"github.com/Silo-Server/silo-server/internal/models"
|
|
"github.com/Silo-Server/silo-server/internal/playback"
|
|
)
|
|
|
|
type hookedSessionManager struct {
|
|
*playback.SessionManager
|
|
beginTransportHook func()
|
|
}
|
|
|
|
type errStreamFileResolver struct {
|
|
err error
|
|
}
|
|
|
|
func (r errStreamFileResolver) GetByID(context.Context, int) (*models.MediaFile, error) {
|
|
return nil, r.err
|
|
}
|
|
|
|
func (m *hookedSessionManager) BeginTransport(sessionID string) error {
|
|
if m.beginTransportHook != nil {
|
|
m.beginTransportHook()
|
|
}
|
|
return m.SessionManager.BeginTransport(sessionID)
|
|
}
|
|
|
|
func TestHandleStream_PausedSessionResumesWithDelayedRangeRequest(t *testing.T) {
|
|
const (
|
|
contentID = "movie-1"
|
|
sessionRouteKey = "session_id"
|
|
)
|
|
filePath := writePlaybackTestMediaFile(t, "movie.mp4")
|
|
file := &models.MediaFile{
|
|
ID: 42,
|
|
ContentID: contentID,
|
|
FilePath: filePath,
|
|
Duration: 3600,
|
|
}
|
|
sessionMgr := playback.NewSessionManager(0, 0)
|
|
session, err := sessionMgr.StartSession(1, "profile-1", 42, playback.PlayDirect, false)
|
|
if err != nil {
|
|
t.Fatalf("StartSession: %v", err)
|
|
}
|
|
if err := sessionMgr.UpdateProgress(session.ID, 1, true); err != nil {
|
|
t.Fatalf("UpdateProgress(paused): %v", err)
|
|
}
|
|
|
|
handler := NewStreamHandler(sessionMgr, testPlaybackFileResolver{file: file})
|
|
request := func(rangeHeader, ifRange string) *httptest.ResponseRecorder {
|
|
t.Helper()
|
|
req := playbackTestRequest(
|
|
http.MethodGet,
|
|
"/api/v1/stream/"+session.ID,
|
|
nil,
|
|
map[string]string{sessionRouteKey: session.ID},
|
|
)
|
|
if rangeHeader != "" {
|
|
req.Header.Set("Range", rangeHeader)
|
|
}
|
|
if ifRange != "" {
|
|
req.Header.Set("If-Range", ifRange)
|
|
}
|
|
rr := httptest.NewRecorder()
|
|
handler.HandleStream(rr, req)
|
|
return rr
|
|
}
|
|
|
|
initial := request("", "")
|
|
if initial.Code != http.StatusOK {
|
|
t.Fatalf("initial status = %d, body = %s", initial.Code, initial.Body.String())
|
|
}
|
|
etag := initial.Header().Get("ETag")
|
|
if etag == "" {
|
|
t.Fatal("initial response omitted ETag")
|
|
}
|
|
|
|
const (
|
|
activeGrace = 5 * time.Millisecond
|
|
pausedGrace = 5 * time.Second
|
|
)
|
|
time.Sleep(20 * time.Millisecond)
|
|
sessionMgr.CleanInactive(activeGrace, pausedGrace)
|
|
if _, err := sessionMgr.GetSession(session.ID); err != nil {
|
|
t.Fatalf("paused session expired before ranged resume: %v", err)
|
|
}
|
|
|
|
resumed := request("bytes=2-", etag)
|
|
if resumed.Code != http.StatusPartialContent {
|
|
t.Fatalf("resume status = %d, body = %s", resumed.Code, resumed.Body.String())
|
|
}
|
|
if got := resumed.Body.String(); got != "deo" {
|
|
t.Fatalf("resume body = %q, want %q", got, "deo")
|
|
}
|
|
if live, err := sessionMgr.GetSession(session.ID); err != nil || live.ID != session.ID {
|
|
t.Fatalf("ranged request did not preserve session %q: session=%#v err=%v", session.ID, live, err)
|
|
}
|
|
}
|
|
|
|
func TestHandleStream_AbortsSessionWhenDirectPlayFileDisappearsAfterPreflight(t *testing.T) {
|
|
filePath := writePlaybackTestMediaFile(t, "movie.mkv")
|
|
file := &models.MediaFile{
|
|
ID: 42,
|
|
ContentID: "movie-1",
|
|
FilePath: filePath,
|
|
Duration: 3600,
|
|
}
|
|
baseMgr := playback.NewSessionManager(0, 0)
|
|
session, err := baseMgr.StartSession(1, "profile-1", 42, playback.PlayDirect, false)
|
|
if err != nil {
|
|
t.Fatalf("StartSession: %v", err)
|
|
}
|
|
|
|
adminStore := &recordingPlaybackAdminStore{}
|
|
syncer := &recordingSessionSyncer{}
|
|
marker := &recordingMissingMarker{}
|
|
sessionMgr := &hookedSessionManager{
|
|
SessionManager: baseMgr,
|
|
beginTransportHook: func() {
|
|
_ = os.Remove(filePath)
|
|
},
|
|
}
|
|
handler := NewStreamHandler(sessionMgr, testPlaybackFileResolver{file: file})
|
|
handler.AdminStore = adminStore
|
|
handler.SessionSyncer = syncer
|
|
handler.MissingMarker = marker
|
|
|
|
req := httptest.NewRequest(http.MethodGet, "/api/v1/stream/"+session.ID, nil)
|
|
req = req.WithContext(newAuthorizedPlaybackContext())
|
|
req = withPlaybackRouteParam(req, "session_id", session.ID)
|
|
|
|
rr := httptest.NewRecorder()
|
|
handler.HandleStream(rr, req)
|
|
|
|
if rr.Code != http.StatusNotFound {
|
|
t.Fatalf("status = %d, body = %s", rr.Code, rr.Body.String())
|
|
}
|
|
if _, err := baseMgr.GetSession(session.ID); !errors.Is(err, playback.ErrSessionNotFound) {
|
|
t.Fatalf("GetSession error = %v, want %v", err, playback.ErrSessionNotFound)
|
|
}
|
|
if len(marker.ids) != 1 || marker.ids[0] != 42 {
|
|
t.Fatalf("marked ids = %v, want [42]", marker.ids)
|
|
}
|
|
if len(adminStore.deleted) != 1 || adminStore.deleted[0] != session.ID {
|
|
t.Fatalf("deleted sessions = %v, want [%s]", adminStore.deleted, session.ID)
|
|
}
|
|
if len(adminStore.history) != 0 {
|
|
t.Fatalf("history entries = %d, want 0", len(adminStore.history))
|
|
}
|
|
if syncer.calls == 0 {
|
|
t.Fatal("expected session sync after abort")
|
|
}
|
|
}
|
|
|
|
func TestHandleStream_KeepsSessionWhenLookupFailsForNonMissingReason(t *testing.T) {
|
|
baseMgr := playback.NewSessionManager(0, 0)
|
|
session, err := baseMgr.StartSession(1, "profile-1", 42, playback.PlayDirect, false)
|
|
if err != nil {
|
|
t.Fatalf("StartSession: %v", err)
|
|
}
|
|
|
|
adminStore := &recordingPlaybackAdminStore{}
|
|
syncer := &recordingSessionSyncer{}
|
|
handler := NewStreamHandler(baseMgr, errStreamFileResolver{err: errors.New("db unavailable")})
|
|
handler.AdminStore = adminStore
|
|
handler.SessionSyncer = syncer
|
|
|
|
req := httptest.NewRequest(http.MethodGet, "/api/v1/stream/"+session.ID, nil)
|
|
req = req.WithContext(newAuthorizedPlaybackContext())
|
|
req = withPlaybackRouteParam(req, "session_id", session.ID)
|
|
|
|
rr := httptest.NewRecorder()
|
|
handler.HandleStream(rr, req)
|
|
|
|
if rr.Code != http.StatusInternalServerError {
|
|
t.Fatalf("status = %d, body = %s", rr.Code, rr.Body.String())
|
|
}
|
|
if _, err := baseMgr.GetSession(session.ID); err != nil {
|
|
t.Fatalf("GetSession error = %v, want live session", err)
|
|
}
|
|
if len(adminStore.deleted) != 0 {
|
|
t.Fatalf("deleted sessions = %v, want none", adminStore.deleted)
|
|
}
|
|
if syncer.calls != 0 {
|
|
t.Fatalf("sync calls = %d, want 0", syncer.calls)
|
|
}
|
|
}
|
|
|
|
// TestHandleSubtitle_ListDownloadedSubtitlesErrorReturns500 pins the fix for
|
|
// issue #248: a failure listing downloaded subtitles must surface as a 500 with
|
|
// an "internal_error" code, not be swallowed and reported to the client as a
|
|
// generic "Subtitle track not found" 404 (which made a real backing-store
|
|
// failure look like an intermittent client-side subtitle bug).
|
|
func TestHandleSubtitle_ListDownloadedSubtitlesErrorReturns500(t *testing.T) {
|
|
// No external or embedded tracks, so track index 0 falls through to the
|
|
// downloaded-subtitle branch that queries the repository.
|
|
file := &models.MediaFile{
|
|
ID: 42,
|
|
ContentID: "movie-1",
|
|
FilePath: "/tmp/movie.mkv",
|
|
Duration: 3600,
|
|
}
|
|
baseMgr := playback.NewSessionManager(0, 0)
|
|
session, err := baseMgr.StartSession(1, "profile-1", 42, playback.PlayDirect, false)
|
|
if err != nil {
|
|
t.Fatalf("StartSession: %v", err)
|
|
}
|
|
|
|
handler := NewStreamHandler(baseMgr, testPlaybackFileResolver{file: file})
|
|
handler.SubtitleRepo = &handlerMockSubtitleRepo{listErr: errors.New("db unavailable")}
|
|
handler.S3Client = newMockS3ClientForHandler()
|
|
handler.S3Bucket = "test-bucket"
|
|
|
|
req := httptest.NewRequest(http.MethodGet, "/api/v1/stream/"+session.ID+"/subtitles/0.vtt", nil)
|
|
req = req.WithContext(newAuthorizedPlaybackContext())
|
|
routeCtx := chi.NewRouteContext()
|
|
routeCtx.URLParams.Add("session_id", session.ID)
|
|
routeCtx.URLParams.Add("track", "0.vtt")
|
|
req = req.WithContext(context.WithValue(req.Context(), chi.RouteCtxKey, routeCtx))
|
|
|
|
rr := httptest.NewRecorder()
|
|
handler.HandleSubtitle(rr, req)
|
|
|
|
if rr.Code != http.StatusInternalServerError {
|
|
t.Fatalf("status = %d, body = %s", rr.Code, rr.Body.String())
|
|
}
|
|
var body struct {
|
|
Error string `json:"error"`
|
|
}
|
|
if err := json.Unmarshal(rr.Body.Bytes(), &body); err != nil {
|
|
t.Fatalf("decode error body: %v (body = %s)", err, rr.Body.String())
|
|
}
|
|
if body.Error != "internal_error" {
|
|
t.Fatalf("error code = %q, want %q (body = %s)", body.Error, "internal_error", rr.Body.String())
|
|
}
|
|
}
|
|
|
|
func TestHandleSubtitle_NilMediaFileReturns404(t *testing.T) {
|
|
baseMgr := playback.NewSessionManager(0, 0)
|
|
session, err := baseMgr.StartSession(1, "profile-1", 42, playback.PlayDirect, false)
|
|
if err != nil {
|
|
t.Fatalf("StartSession: %v", err)
|
|
}
|
|
|
|
handler := NewStreamHandler(baseMgr, errStreamFileResolver{})
|
|
req := httptest.NewRequest(http.MethodGet, "/api/v1/stream/"+session.ID+"/subtitles/0.vtt", nil)
|
|
req = req.WithContext(newAuthorizedPlaybackContext())
|
|
routeCtx := chi.NewRouteContext()
|
|
routeCtx.URLParams.Add("session_id", session.ID)
|
|
routeCtx.URLParams.Add("track", "0.vtt")
|
|
req = req.WithContext(context.WithValue(req.Context(), chi.RouteCtxKey, routeCtx))
|
|
|
|
rr := httptest.NewRecorder()
|
|
handler.HandleSubtitle(rr, req)
|
|
|
|
if rr.Code != http.StatusNotFound {
|
|
t.Fatalf("status = %d, body = %s; want 404", rr.Code, rr.Body.String())
|
|
}
|
|
}
|
|
|
|
// A .vtt request for a bitmap (PGS) embedded track must be rejected up front:
|
|
// PGS passes the burn-in guard because it is deliverable as .sup, but it has
|
|
// no text to convert, so forcing WebVTT would spawn an ffmpeg that always
|
|
// fails after the 200 and headers are committed.
|
|
func TestHandleSubtitle_BitmapTrackVTTRequestReturns415(t *testing.T) {
|
|
file := &models.MediaFile{
|
|
ID: 42,
|
|
ContentID: "movie-1",
|
|
FilePath: "/tmp/movie.mkv",
|
|
Duration: 3600,
|
|
SubtitleTracks: []models.SubtitleTrack{
|
|
{Index: 0, Language: "eng", Codec: "hdmv_pgs_subtitle"},
|
|
},
|
|
}
|
|
baseMgr := playback.NewSessionManager(0, 0)
|
|
session, err := baseMgr.StartSession(1, "profile-1", 42, playback.PlayDirect, false)
|
|
if err != nil {
|
|
t.Fatalf("StartSession: %v", err)
|
|
}
|
|
|
|
handler := NewStreamHandler(baseMgr, testPlaybackFileResolver{file: file})
|
|
req := httptest.NewRequest(http.MethodGet, "/api/v1/stream/"+session.ID+"/subtitles/0.vtt", nil)
|
|
req = req.WithContext(newAuthorizedPlaybackContext())
|
|
routeCtx := chi.NewRouteContext()
|
|
routeCtx.URLParams.Add("session_id", session.ID)
|
|
routeCtx.URLParams.Add("track", "0.vtt")
|
|
req = req.WithContext(context.WithValue(req.Context(), chi.RouteCtxKey, routeCtx))
|
|
|
|
rr := httptest.NewRecorder()
|
|
handler.HandleSubtitle(rr, req)
|
|
|
|
if rr.Code != http.StatusUnsupportedMediaType {
|
|
t.Fatalf("status = %d, body = %s; want 415", rr.Code, rr.Body.String())
|
|
}
|
|
var body struct {
|
|
Error string `json:"error"`
|
|
}
|
|
if err := json.Unmarshal(rr.Body.Bytes(), &body); err != nil {
|
|
t.Fatalf("decode error body: %v (body = %s)", err, rr.Body.String())
|
|
}
|
|
if body.Error != "unsupported_media_type" {
|
|
t.Fatalf("error code = %q, want %q", body.Error, "unsupported_media_type")
|
|
}
|
|
}
|
|
|
|
func TestSubtitleSourceFileIDPinsURLAcrossEffectiveFileSwitch(t *testing.T) {
|
|
session := &playback.Session{MediaFileID: 200, RequestedMediaFileID: 100}
|
|
|
|
request := httptest.NewRequest(http.MethodGet, "/subtitles/4.vtt?file_id=100", nil)
|
|
fileID, err := subtitleSourceFileID(request, session)
|
|
if err != nil {
|
|
t.Fatalf("subtitleSourceFileID: %v", err)
|
|
}
|
|
if fileID != 100 {
|
|
t.Fatalf("fileID = %d, want original subtitle source 100", fileID)
|
|
}
|
|
|
|
request = httptest.NewRequest(http.MethodGet, "/subtitles/4.vtt?file_id=300", nil)
|
|
if _, err := subtitleSourceFileID(request, session); err == nil {
|
|
t.Fatal("expected unrelated subtitle source file to be rejected")
|
|
}
|
|
}
|
|
|
|
func TestHandleTransportStartFailure_KeepsSessionForNonMissingError(t *testing.T) {
|
|
filePath := writePlaybackTestMediaFile(t, "movie.mkv")
|
|
file := &models.MediaFile{
|
|
ID: 42,
|
|
ContentID: "movie-1",
|
|
FilePath: filePath,
|
|
Duration: 3600,
|
|
}
|
|
baseMgr := playback.NewSessionManager(0, 0)
|
|
session, err := baseMgr.StartSession(1, "profile-1", 42, playback.PlayDirect, false)
|
|
if err != nil {
|
|
t.Fatalf("StartSession: %v", err)
|
|
}
|
|
|
|
adminStore := &recordingPlaybackAdminStore{}
|
|
syncer := &recordingSessionSyncer{}
|
|
handler := NewStreamHandler(baseMgr, testPlaybackFileResolver{file: file})
|
|
handler.AdminStore = adminStore
|
|
handler.SessionSyncer = syncer
|
|
|
|
handler.handleTransportStartFailure(context.Background(), session, file, errors.New("ffmpeg unavailable"))
|
|
|
|
if _, err := baseMgr.GetSession(session.ID); err != nil {
|
|
t.Fatalf("GetSession error = %v, want live session", err)
|
|
}
|
|
if len(adminStore.deleted) != 0 {
|
|
t.Fatalf("deleted sessions = %v, want none", adminStore.deleted)
|
|
}
|
|
if syncer.calls != 0 {
|
|
t.Fatalf("sync calls = %d, want 0", syncer.calls)
|
|
}
|
|
}
|