* docs(audiobooks): design spec for plugin absorption Plan to absorb silo-plugin-audiobooks into silo-server as a first-party feature. Audiobooks land in silo's existing SPA; ABS clients connect directly. Hard constraints: reuse existing tables (media_items, media_files, user_watch_progress, user_playback_sessions, people, item_people, library_collections); only two new tables (abs_sessions, podcast_feeds) and at most one column add (media_libraries.kind); silo's main :8080 listener handles ABS Socket.io natively. Out of scope: audiobook requests flow, smart collections, share links, external recommender, custom metadata providers, separate audiobook SPA. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs(audiobooks): implementation plan sub-plan 1 (discovery + schema) First of six sub-plans for the absorption. Six tasks: a discovery audit that resolves the spec's Risk questions, four idempotent SQL migrations (abs_sessions, podcast_feeds, media_libraries.kind, audiobooks.enabled feature flag), and an empty-but-compiling internal/audiobooks package scaffolded into cmd/silo. Lands as a strict no-op for users (feature flag defaults to false). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs(audiobooks): discovery findings for absorption sub-plan 1 Locks schema/code decisions for migrations 139-142 and downstream sub-plans. Resolves open Risk questions from the absorption design spec. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(audiobooks): migration 139 add abs_sessions table Parallel of jellycompat_sessions for Audiobookshelf-compatible clients. Lets ABS mobile/desktop apps maintain a device-bound session that silo's audiobooks/abs handlers will validate. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * style(audiobooks): match codebase conventions in migration 139 Lowercases type keywords in the abs_sessions CREATE TABLE body to match neighboring migrations, fixes the client_version column alignment, and replaces the misleading "parallel to jellycompat_sessions" header comment with a more accurate description of the table's role. Cosmetic only — the running schema is unchanged. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(audiobooks): migration 140 add podcast_feeds table Side table on media_items for RSS-subscribed podcasts. Holds feed URL, ETag/Last-Modified for conditional fetches, last-refresh timestamp, and the per-feed refresh interval consumed by the upcoming podcastfeed.Refresher scheduled task. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * style(audiobooks): uppercase PRIMARY KEY in migration 140 Aligns with the codebase convention (type keywords lowercase, constraint keywords uppercase) established in migration 139's post-style-fix form. Cosmetic only — running schema is unchanged. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * chore(audiobooks): migration 141 no-op for media_folders.type Sub-plan 1 originally reserved migration 141 to add a 'kind' column to media_libraries discriminating audiobook/podcast libraries. Discovery audit (sub-plan 1 Task 1) found that the actual table is media_folders and it already has a type text NOT NULL column with no CHECK constraint or enum, so 'audiobooks' and 'podcasts' can be added as future values without DDL. Landing this migration as a documented no-op preserves the version numbering audit trail and pins the decision in git history. The matching down migration is also a no-op. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(audiobooks): migration 142 add audiobooks.enabled flag Server-settings row that gates the absorbed audiobooks feature. Defaults to 'false' so sub-plan 1 lands as a strict no-op; subsequent sub-plans branch on this flag and operators flip it to 'true' at cutover. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(audiobooks): scaffold internal/audiobooks package Empty-but-compiling Service that reads the audiobooks.enabled feature flag from server_settings. Wired into cmd/silo so the package is referenced from the binary; no routes mounted, no scheduled tasks registered, no DB writes. Subsequent sub-plans hang scanner branches, ABS handlers, Socket.io, podcast refresher, and SPA pages off this Service. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * style(audiobooks): cosmetic cleanups in scaffolded package Two pre-emptive cleanups flagged by code review before sub-plan 2 copies the patterns: 1. Sort the internal/audiobooks import after internal/adminjob in cmd/silo/main.go (alphabetical). 2. Drop the redundant "audiobooks: " prefix from the Enabled() error wrap; matches how every other top-level service package (watchstate, scanqueue, metadata, etc.) formats errors. No behavior change. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs(audiobooks): implementation plan sub-plan 2 (scanner) Second of six sub-plans. 10 tasks: PersonKind constants for Author and Narrator, audio-extension recognizer, library-type helpers, a walkLogicalTree refactor (movieLibrary bool -> typed walkMode), chapter extraction via ffprobe, single-file and multi-file audiobook parsers, scanner write path producing media_items.type='audiobook', and a filesystem podcast parser (RSS deferred to sub-plan 5). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(audiobooks): add Author and Narrator PersonKind constants Discovery audit confirmed item_people.kind is unconstrained smallint with values 1-6 in use. Reserve 7 = Author, 8 = Narrator for audiobook people-links written by the upcoming scanner branches. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(audiobooks): add audio-extension recognizer for scanner Mirrors the existing videoExtensions/SupportsVideoFile pair. Used by upcoming audiobook and podcast scanner branches to filter directory walks. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(audiobooks): library-type recognizers for scanner dispatch isAudiobookLibraryType and isPodcastLibraryType match singular and plural forms case-insensitively, mirroring isMovieLibraryType. Used by upcoming scanner walk branches (Task 4) that filter audio files into audiobook and podcast libraries. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * refactor(scanner): replace movieLibrary bool with typed walkMode Lets walkLogicalTree dispatch on multiple library shapes (video, movie, audiobook, podcast) without proliferating boolean flags. Behavior for existing video and movie libraries is unchanged; audiobook and podcast modes will be consumed by the upcoming audiobook.go and podcast.go parsers in later tasks of this sub-plan. walkModeFor() derives the mode from a media_folders.type string; unknown types default to walkModeVideo to preserve prior behavior for any caller still passing a raw type. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(audiobooks): expose ffprobe format tags on ProbeData The audiobook scanner needs format-level tags (title, artist, album, date) for media_items metadata; ffprobe already parses them in ffprobeFormat.Tags but ProbeData previously discarded them. Add FormatTags map[string]string to ProbeData, populate it in convertProbeData via a new normalizeFormatTags helper that lowercases keys and trims values. Adds a fixture audiobook .m4b with embedded chapters (Intro/Outro) and format tags, and a test that verifies ProbeFile() returns both correctly. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(audiobooks): parser for single-file audiobook folders parseAudiobookFolder reads tags + chapters via the existing ProbeFile (now that Task 5 exposes FormatTags on ProbeData) and produces a parsedAudiobook struct. Title falls back from "title" tag to "album"; author from "artist" -> "album_artist" -> "composer"; series from "album" -> "series" -> "mvnm" (Movement Name, used by some MP4 tools). Year parsed from "date" or "year" tags, tolerating ISO dates and parenthesized forms. Single-file case only; multi-file folders (one audio file per chapter) return a placeholder error and arrive in Task 7. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(audiobooks): multi-file audiobook folder support Folders containing N audio files (one per chapter/part) get one parsedAudiobookFile per file; each file's chapter list is synthesized as a single chapter with title = filename stem. Title/author/series/ year come from the first file's tags. Also drops the duplicate pickFirstNonEmpty helper added in Task 6 in favor of the existing firstNonEmpty already in probe.go. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(audiobooks): scanner write path produces audiobook media_items ScanAudiobookFolder walks an audiobooks-typed media folder and treats each immediate subdirectory as one audiobook. For each parsed audiobook it upserts: - one media_items row with type='audiobook' - one media_files row per audio file (with chapters JSONB) - author/narrator links in item_people (kind=7, kind=8) Adds itemRepo and personRepo to the Scanner struct, wired from fileRepo.Pool() in NewScanner — no constructor signature change needed. ScanFolder dispatches to this path when folder.Type='audiobooks', bypassing the per-file movie/TV pipeline because audiobooks are folder-scoped entities. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(audiobooks): filesystem podcast scanner ScanPodcastFolder walks a podcasts-typed media folder, treating each subdirectory as a podcast show and each audio file inside as an episode. Writes media_items.type='podcast' + episodes rows + media_files rows. RSS-subscribed feeds (podcast_feeds table) arrive in sub-plan 5; this task covers filesystem-only ingestion. ScanFolder dispatches to this path when folder.Type='podcasts'. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs(audiobooks): implementation plan sub-plan 5 (podcasts) Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(audiobooks): expose audiobooks/podcasts library types in admin UI Adds 'Audiobooks' and 'Podcasts' options to the library-type dropdown in the admin libraries page so operators can flag a folder as an audiobook or podcast library. Extends contentLevelsForType() so the admin UI's downstream filtering treats those types correctly (audiobook -> ['audiobook'], podcasts -> ['podcast', 'podcast_episode']). Backend scanner branches for these types were already wired in sub-plan 2. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * chore(migrations): renumber 139_abs_sessions to 147 for origin/main merge origin/main adds 139_media_requests at the same number our local audiobook branch had used for abs_sessions. Renumber ours to 147 to free up 139 for the upstream migration. The schema_versions row is updated in lockstep on the running database so the migrator sees the abs_sessions migration as already applied at its new version. Migrations 140-146 (podcast feeds, media_folders kind noop, audiobook feature flag, abs playback sessions, podcast episode guid, audiobook series, audiobook title cleanup) stay where they are — they don't collide with anything on origin/main. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * chore(migrations): renumber 140_podcast_feeds to 157 for origin/main merge origin/main added 140_user_permissions at the same version this branch had used for podcast_feeds. Renumber ours to 157 (next free above the collections-unify migration at 156) so 140 is free for the upstream migration. schema_versions on the running database is updated in lockstep so the migrator sees podcast_feeds as already applied at its new version. Same pattern asd59c1cb(renumber 139_abs_sessions to 147 for the prior main merge). Pending migrations after this rename: 132 (downloaded subtitles admin index, main), 140 (user_permissions, main), and 156 (unify_user_collections, this branch). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * chore(migrations): renumber 141_media_folders_kind_noop to 159 for origin/main merge Same shape aseb8f67d(the 140→157 renumber from the previous main merge). origin/main added 141_episode_title_sort_index at the same version this branch had used for media_folders_kind_noop. Renumber ours to 159 (next free above the audiobook_series truncate at 158) so 141 is open for the upstream migration. schema_versions on the running database is updated in lockstep so the migrator sees media_folders_kind_noop as already applied at its new version. Pending migrations on silo-prod after this rename: 141 (episode_title_sort_index, main) and any other newer ones from main that the branch hasn't picked up yet. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * chore(migrations): renumber 142_audiobooks_feature_flag to 160 for origin/main merge Companion to 3c6f062's 141 renumber — origin/main also added 142_episode_catalog_entries (alongside 141_episode_title_sort_index) at a version this branch had used for the audiobooks feature flag. Renumber ours to 160 so 142 is open for the upstream migration; schema_versions on silo-prod is updated in lockstep so the migrator sees audiobooks_feature_flag as already applied at its new version. This was the only remaining collision (verified by checking for duplicate version prefixes across migrations/). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * fix(audiobooks): address foundation review comments * fix(audiobooks): tighten scanner identity handling * fix(audiobooks): propagate scanner cancellation * chore(audiobooks): adopt goose migration layout * docs(audiobooks): implementation plan sub-plan 3 (API + frontend MVP) Third of six sub-plans. 9 tasks: three REST endpoints (list/detail/ progress), TanStack Query hooks + types, three React pages (Library/Detail/Player), and navigation integration. Scoped to MVP — author/series indices, smart collections, share links, and other nice-to-haves from the spec are deferred. Streaming reuses silo's existing /api/v1/stream/{session_id}; no new transcode code. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(audiobooks): list endpoint at GET /api/v1/audiobooks Paginated list of media_items with type='audiobook' scoped to the caller's accessible libraries via the existing access filter. Mirrors silo's existing list-style handlers for movies and series. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(audiobooks): detail endpoint at GET /api/v1/audiobooks/{id} Returns the media_items row, its media_files (with chapters JSONB), author/narrator extracted from item_people (kinds 7/8), and the caller's per-profile listening progress from user_watch_progress. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(audiobooks): progress endpoint at POST /api/v1/audiobooks/{id}/progress UPSERTs user_watch_progress for the caller's (user_id, profile_id, content_id). Body carries position_seconds; clients are expected to post every 5-10s during playback plus on pause/seek (matching silo's existing video progress cadence). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(audiobooks): frontend types and TanStack Query hooks TypeScript types match the JSON shapes from the new /api/v1/audiobooks endpoints (list, detail, progress). Three hooks: useAudiobookLibrary (list), useAudiobook (detail), and useReportAudiobookProgress (mutation that invalidates the detail query on success so progress updates reflect immediately). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(audiobooks): library grid page at /audiobooks Renders a paginated grid of audiobook cards using the useAudiobookLibrary hook. Each card links to /audiobooks/book/{id}. Cards show poster, title, and year; falls back to a "No cover" placeholder when the audiobook has no poster_url. Empty state hints to operators that they need to set a library's type to 'audiobooks'. Routes themselves are wired in Task 8 (navigation integration). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(audiobooks): detail page with chapter list Renders cover, title, author, narrator, year, and overview alongside a chapter list. Clicking a chapter opens an inline sticky AudiobookPlayer at that chapter's start. A "Resume" button restarts playback at the saved progress position if present. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(audiobooks): HTML5 audio player with chapter navigation Single-file audiobook playback for MVP. Multi-file queuing arrives in a follow-up. Streams via the existing /api/v1/direct-download GET endpoint. Position is reported to /api/v1/audiobooks/{id}/progress every 10s while playing plus on pause/seek/end. Skip-30s, playback rate select, chapter list panel. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(audiobooks): wire navigation and routes Adds an Audiobooks entry to the sidebar and registers the two new routes (/audiobooks for the library grid, /audiobooks/book/:id for detail). The player renders inline inside the detail page; no dedicated player route is required for MVP. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * fix(audiobooks): address native API review comments * feat(audiobooks): add ABS compatibility and polish * fix(audiobooks): stabilize ABS playback progress reporting * fix(audiobooks): clean up ABS branch review fixes * chore(audiobooks): adopt goose layout for ABS migrations * fix(audiobooks): align player seek bar props * feat(audiobooks): make libraries first-class catalog items * feat(admin): add server restart endpoint * fix(audiobooks): address review comment findings --------- Co-authored-by: RXWatcher <14085001+RXWatcher@users.noreply.github.com> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
512 lines
18 KiB
Go
512 lines
18 KiB
Go
package abs
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"sort"
|
|
"strings"
|
|
"sync"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/go-chi/chi/v5"
|
|
|
|
"github.com/Silo-Server/silo-server/internal/catalog"
|
|
"github.com/Silo-Server/silo-server/internal/models"
|
|
)
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// In-memory fakes
|
|
// ---------------------------------------------------------------------------
|
|
|
|
// memBookmarkStore is an in-memory BookmarkStore for handler tests.
|
|
// Keyed on (userID, profileID, itemID, time) to mirror the SQL unique
|
|
// index. Thread-safe so parallel sub-tests can share an instance.
|
|
type memBookmarkStore struct {
|
|
mu sync.Mutex
|
|
rows map[string]Bookmark // key = userID|profileID|itemID|time
|
|
seq int // monotonic counter for deterministic IDs in tests
|
|
}
|
|
|
|
func newMemBookmarkStore() *memBookmarkStore {
|
|
return &memBookmarkStore{rows: map[string]Bookmark{}}
|
|
}
|
|
|
|
func bkKey(userID, profileID, itemID string, t float64) string {
|
|
return userID + "|" + profileID + "|" + itemID + "|" + formatTime(t)
|
|
}
|
|
|
|
func formatTime(t float64) string {
|
|
// Round-trip-safe encoding for map keys. Postgres compares float8
|
|
// bit-for-bit too, so this matches production semantics.
|
|
b, _ := json.Marshal(t)
|
|
return string(b)
|
|
}
|
|
|
|
// List iterates the keyed map directly so a row only matches when ALL
|
|
// of (user, profile, item) line up. Iterating values and reconstructing
|
|
// the key would be ambiguous when two users have a bookmark at the
|
|
// same (item, time).
|
|
func (m *memBookmarkStore) List(_ context.Context, userID, profileID, itemID string) ([]Bookmark, error) {
|
|
m.mu.Lock()
|
|
defer m.mu.Unlock()
|
|
prefix := userID + "|" + profileID + "|" + itemID + "|"
|
|
out := make([]Bookmark, 0)
|
|
for k, b := range m.rows {
|
|
if strings.HasPrefix(k, prefix) {
|
|
out = append(out, b)
|
|
}
|
|
}
|
|
sort.Slice(out, func(i, j int) bool { return out[i].Time < out[j].Time })
|
|
return out, nil
|
|
}
|
|
|
|
func (m *memBookmarkStore) Upsert(_ context.Context, userID, profileID, itemID string, t float64, title string) (Bookmark, error) {
|
|
m.mu.Lock()
|
|
defer m.mu.Unlock()
|
|
key := bkKey(userID, profileID, itemID, t)
|
|
now := time.Now()
|
|
if existing, ok := m.rows[key]; ok {
|
|
existing.Title = title
|
|
existing.UpdatedAt = now
|
|
m.rows[key] = existing
|
|
return existing, nil
|
|
}
|
|
m.seq++
|
|
b := Bookmark{
|
|
ID: "01HTEST" + formatSeq(m.seq),
|
|
LibraryItemID: itemID,
|
|
Time: t,
|
|
Title: title,
|
|
CreatedAt: now,
|
|
UpdatedAt: now,
|
|
}
|
|
m.rows[key] = b
|
|
return b, nil
|
|
}
|
|
|
|
func (m *memBookmarkStore) Delete(_ context.Context, userID, profileID, itemID string, t float64) error {
|
|
m.mu.Lock()
|
|
defer m.mu.Unlock()
|
|
delete(m.rows, bkKey(userID, profileID, itemID, t))
|
|
return nil
|
|
}
|
|
|
|
func (m *memBookmarkStore) CountByUser(_ context.Context, userID, profileID string) (map[string]int, error) {
|
|
m.mu.Lock()
|
|
defer m.mu.Unlock()
|
|
out := map[string]int{}
|
|
prefix := userID + "|" + profileID + "|"
|
|
for k := range m.rows {
|
|
if strings.HasPrefix(k, prefix) {
|
|
rest := k[len(prefix):]
|
|
sep := -1
|
|
for i, c := range rest {
|
|
if c == '|' {
|
|
sep = i
|
|
break
|
|
}
|
|
}
|
|
if sep < 0 {
|
|
continue
|
|
}
|
|
itemID := rest[:sep]
|
|
out[itemID]++
|
|
}
|
|
}
|
|
return out, nil
|
|
}
|
|
|
|
func formatSeq(n int) string {
|
|
b, _ := json.Marshal(n)
|
|
return string(b)
|
|
}
|
|
|
|
// recordingPublisher captures publish() calls so tests can assert socket
|
|
// event semantics without wiring a real Socket.io server.
|
|
type recordingPublisher struct {
|
|
mu sync.Mutex
|
|
events []publishedEvent
|
|
}
|
|
|
|
type publishedEvent struct {
|
|
UserID string
|
|
Event string
|
|
Payload any
|
|
}
|
|
|
|
func (p *recordingPublisher) Publish(userID, event string, payload any) {
|
|
p.mu.Lock()
|
|
defer p.mu.Unlock()
|
|
p.events = append(p.events, publishedEvent{UserID: userID, Event: event, Payload: payload})
|
|
}
|
|
func (p *recordingPublisher) Broadcast(_ string, _ any) {}
|
|
|
|
func (p *recordingPublisher) snapshot() []publishedEvent {
|
|
p.mu.Lock()
|
|
defer p.mu.Unlock()
|
|
out := make([]publishedEvent, len(p.events))
|
|
copy(out, p.events)
|
|
return out
|
|
}
|
|
|
|
// stubMediaStore satisfies MediaStore with a configurable item lookup so
|
|
// handler tests can drive both the 200 and 404 branches.
|
|
type stubMediaStore struct {
|
|
noopMediaStore
|
|
known map[string]*models.MediaItem // itemID → row (nil means "exists but no row needed")
|
|
lookupErr error
|
|
}
|
|
|
|
func (s *stubMediaStore) GetAudiobookByID(_ context.Context, id string, _ catalog.AccessFilter) (*models.MediaItem, error) {
|
|
if s.lookupErr != nil {
|
|
return nil, s.lookupErr
|
|
}
|
|
if it, ok := s.known[id]; ok {
|
|
if it == nil {
|
|
return &models.MediaItem{ContentID: id}, nil
|
|
}
|
|
return it, nil
|
|
}
|
|
return nil, nil
|
|
}
|
|
func (s *stubMediaStore) GetAuthorByID(_ context.Context, id string, _ catalog.AccessFilter) (Author, error) {
|
|
return Author{}, ErrNotFound
|
|
}
|
|
func (s *stubMediaStore) GetSeriesByName(_ context.Context, name string, _ catalog.AccessFilter) (Series, error) {
|
|
return Series{}, ErrNotFound
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Test harness
|
|
// ---------------------------------------------------------------------------
|
|
|
|
type bookmarksHarness struct {
|
|
H *Handler
|
|
Pub *recordingPublisher
|
|
Book *memBookmarkStore
|
|
}
|
|
|
|
func newBookmarksHarness(t *testing.T, knownItems ...string) *bookmarksHarness {
|
|
t.Helper()
|
|
known := map[string]*models.MediaItem{}
|
|
for _, id := range knownItems {
|
|
known[id] = nil // exists, body content not used by handlers
|
|
}
|
|
pub := &recordingPublisher{}
|
|
store := newMemBookmarkStore()
|
|
h := New(Dependencies{
|
|
MediaStore: &stubMediaStore{known: known},
|
|
BookmarkStore: store,
|
|
Publisher: pub,
|
|
})
|
|
return &bookmarksHarness{H: h, Pub: pub, Book: store}
|
|
}
|
|
|
|
// dispatchBookmark drives a bookmarks handler directly. Injects ctxAuth
|
|
// (the bearerAuth middleware's product) and chi route params so the
|
|
// handler can read both via absAuthFrom() and chi.URLParam() without
|
|
// running the full middleware chain.
|
|
func dispatchBookmark(h *Handler, method, path, itemID, timeParam string, body []byte, userID, profileID string, fn http.HandlerFunc) *httptest.ResponseRecorder {
|
|
var rd *bytes.Reader
|
|
if body != nil {
|
|
rd = bytes.NewReader(body)
|
|
}
|
|
var req *http.Request
|
|
if rd != nil {
|
|
req = httptest.NewRequest(method, path, rd)
|
|
req.Header.Set("Content-Type", "application/json")
|
|
} else {
|
|
req = httptest.NewRequest(method, path, nil)
|
|
}
|
|
rctx := chi.NewRouteContext()
|
|
if itemID != "" {
|
|
rctx.URLParams.Add("itemId", itemID)
|
|
}
|
|
if timeParam != "" {
|
|
rctx.URLParams.Add("time", timeParam)
|
|
}
|
|
ctx := context.WithValue(req.Context(), chi.RouteCtxKey, rctx)
|
|
ctx = context.WithValue(ctx, ctxKey{}, ctxAuth{UserID: userID, ProfileID: profileID})
|
|
req = req.WithContext(ctx)
|
|
rec := httptest.NewRecorder()
|
|
fn(rec, req)
|
|
return rec
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Tests
|
|
// ---------------------------------------------------------------------------
|
|
|
|
func TestCreate_NewBookmark_ReturnsListContainingIt(t *testing.T) {
|
|
hb := newBookmarksHarness(t, "book-1")
|
|
body := []byte(`{"title":"Chapter cliffhanger","time":42.5}`)
|
|
rec := dispatchBookmark(hb.H, http.MethodPost, "/api/me/item/book-1/bookmark", "book-1", "", body, "1", "", hb.H.handleUpsertBookmark("bookmark_created"))
|
|
|
|
if rec.Code != http.StatusOK {
|
|
t.Fatalf("status = %d, want 200; body=%s", rec.Code, rec.Body.String())
|
|
}
|
|
var list []map[string]any
|
|
if err := json.Unmarshal(rec.Body.Bytes(), &list); err != nil {
|
|
t.Fatalf("decode: %v; body=%s", err, rec.Body.String())
|
|
}
|
|
if len(list) != 1 {
|
|
t.Fatalf("list len = %d, want 1; body=%s", len(list), rec.Body.String())
|
|
}
|
|
got := list[0]
|
|
if got["libraryItemId"] != "book-1" {
|
|
t.Errorf("libraryItemId = %v, want book-1", got["libraryItemId"])
|
|
}
|
|
if got["time"] != 42.5 {
|
|
t.Errorf("time = %v, want 42.5", got["time"])
|
|
}
|
|
if got["title"] != "Chapter cliffhanger" {
|
|
t.Errorf("title = %v, want Chapter cliffhanger", got["title"])
|
|
}
|
|
for _, k := range []string{"id", "createdAt", "updatedAt"} {
|
|
if _, ok := got[k]; !ok {
|
|
t.Errorf("response missing %q; body=%s", k, rec.Body.String())
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestUpsert_SameTime_UpdatesTitleNoDuplicate(t *testing.T) {
|
|
hb := newBookmarksHarness(t, "book-1")
|
|
|
|
// POST first.
|
|
postBody := []byte(`{"title":"first","time":10}`)
|
|
rec := dispatchBookmark(hb.H, http.MethodPost, "/api/me/item/book-1/bookmark", "book-1", "", postBody, "1", "", hb.H.handleUpsertBookmark("bookmark_created"))
|
|
if rec.Code != http.StatusOK {
|
|
t.Fatalf("POST status = %d, want 200; body=%s", rec.Code, rec.Body.String())
|
|
}
|
|
var postList []map[string]any
|
|
_ = json.Unmarshal(rec.Body.Bytes(), &postList)
|
|
if len(postList) != 1 {
|
|
t.Fatalf("after POST list len = %d, want 1", len(postList))
|
|
}
|
|
firstID := postList[0]["id"]
|
|
|
|
// PATCH at the same time with a new title.
|
|
patchBody := []byte(`{"title":"renamed","time":10}`)
|
|
rec2 := dispatchBookmark(hb.H, http.MethodPatch, "/api/me/item/book-1/bookmark", "book-1", "", patchBody, "1", "", hb.H.handleUpsertBookmark("bookmark_updated"))
|
|
if rec2.Code != http.StatusOK {
|
|
t.Fatalf("PATCH status = %d, want 200; body=%s", rec2.Code, rec2.Body.String())
|
|
}
|
|
var patchList []map[string]any
|
|
if err := json.Unmarshal(rec2.Body.Bytes(), &patchList); err != nil {
|
|
t.Fatalf("decode: %v; body=%s", err, rec2.Body.String())
|
|
}
|
|
if len(patchList) != 1 {
|
|
t.Fatalf("after PATCH list len = %d, want 1 (upsert, not insert)", len(patchList))
|
|
}
|
|
if patchList[0]["title"] != "renamed" {
|
|
t.Errorf("title = %v, want renamed", patchList[0]["title"])
|
|
}
|
|
if patchList[0]["id"] != firstID {
|
|
t.Errorf("id changed across upsert: was %v, now %v (id must be preserved)", firstID, patchList[0]["id"])
|
|
}
|
|
}
|
|
|
|
func TestDelete_ExistingBookmark_RemovedFromList(t *testing.T) {
|
|
hb := newBookmarksHarness(t, "book-1")
|
|
|
|
// Seed a bookmark via POST.
|
|
postBody := []byte(`{"title":"to delete","time":99}`)
|
|
_ = dispatchBookmark(hb.H, http.MethodPost, "/api/me/item/book-1/bookmark", "book-1", "", postBody, "1", "", hb.H.handleUpsertBookmark("bookmark_created"))
|
|
|
|
// DELETE it.
|
|
rec := dispatchBookmark(hb.H, http.MethodDelete, "/api/me/item/book-1/bookmark/99", "book-1", "99", nil, "1", "", hb.H.handleDeleteBookmark)
|
|
if rec.Code != http.StatusOK {
|
|
t.Fatalf("status = %d, want 200; body=%s", rec.Code, rec.Body.String())
|
|
}
|
|
var list []map[string]any
|
|
if err := json.Unmarshal(rec.Body.Bytes(), &list); err != nil {
|
|
t.Fatalf("decode: %v; body=%s", err, rec.Body.String())
|
|
}
|
|
if len(list) != 0 {
|
|
t.Errorf("list len = %d, want 0; body=%s", len(list), rec.Body.String())
|
|
}
|
|
}
|
|
|
|
func TestDelete_NonExistentTime_IdempotentReturnsEmptyList(t *testing.T) {
|
|
hb := newBookmarksHarness(t, "book-1")
|
|
rec := dispatchBookmark(hb.H, http.MethodDelete, "/api/me/item/book-1/bookmark/123", "book-1", "123", nil, "1", "", hb.H.handleDeleteBookmark)
|
|
if rec.Code != http.StatusOK {
|
|
t.Fatalf("status = %d, want 200 (idempotent); body=%s", rec.Code, rec.Body.String())
|
|
}
|
|
var list []map[string]any
|
|
_ = json.Unmarshal(rec.Body.Bytes(), &list)
|
|
if len(list) != 0 {
|
|
t.Errorf("list len = %d, want 0", len(list))
|
|
}
|
|
}
|
|
|
|
func TestCreate_TwoAtDifferentTimes_ListOrderedByTime(t *testing.T) {
|
|
hb := newBookmarksHarness(t, "book-1")
|
|
|
|
_ = dispatchBookmark(hb.H, http.MethodPost, "/api/me/item/book-1/bookmark", "book-1", "", []byte(`{"title":"later","time":100}`), "1", "", hb.H.handleUpsertBookmark("bookmark_created"))
|
|
rec := dispatchBookmark(hb.H, http.MethodPost, "/api/me/item/book-1/bookmark", "book-1", "", []byte(`{"title":"earlier","time":50}`), "1", "", hb.H.handleUpsertBookmark("bookmark_created"))
|
|
|
|
var list []map[string]any
|
|
_ = json.Unmarshal(rec.Body.Bytes(), &list)
|
|
if len(list) != 2 {
|
|
t.Fatalf("list len = %d, want 2", len(list))
|
|
}
|
|
if list[0]["time"] != float64(50) || list[1]["time"] != float64(100) {
|
|
t.Errorf("list times = [%v, %v], want [50, 100]", list[0]["time"], list[1]["time"])
|
|
}
|
|
}
|
|
|
|
func TestProfileIsolation_BookmarksScopedPerProfile(t *testing.T) {
|
|
hb := newBookmarksHarness(t, "book-1")
|
|
|
|
// Profile A inserts.
|
|
_ = dispatchBookmark(hb.H, http.MethodPost, "/api/me/item/book-1/bookmark", "book-1", "", []byte(`{"title":"a","time":1}`), "1", "00000000-0000-0000-0000-0000000000aa", hb.H.handleUpsertBookmark("bookmark_created"))
|
|
|
|
// Profile B (same user) reads via POST at a different time so we get the
|
|
// list back. Profile B's POST should return only profile B's bookmarks.
|
|
rec := dispatchBookmark(hb.H, http.MethodPost, "/api/me/item/book-1/bookmark", "book-1", "", []byte(`{"title":"b","time":2}`), "1", "00000000-0000-0000-0000-0000000000bb", hb.H.handleUpsertBookmark("bookmark_created"))
|
|
|
|
var list []map[string]any
|
|
_ = json.Unmarshal(rec.Body.Bytes(), &list)
|
|
if len(list) != 1 {
|
|
t.Fatalf("profile B list len = %d, want 1 (isolation broken)", len(list))
|
|
}
|
|
if list[0]["title"] != "b" {
|
|
t.Errorf("profile B saw profile A's bookmark: %v", list[0])
|
|
}
|
|
}
|
|
|
|
func TestDelete_OtherUserBookmark_NoOpAndNoExistenceLeak(t *testing.T) {
|
|
hb := newBookmarksHarness(t, "book-1")
|
|
|
|
// User B seeds a bookmark.
|
|
_ = dispatchBookmark(hb.H, http.MethodPost, "/api/me/item/book-1/bookmark", "book-1", "", []byte(`{"title":"B's bookmark","time":42.5}`), "2", "", hb.H.handleUpsertBookmark("bookmark_created"))
|
|
|
|
// User A tries to DELETE at the same item+time.
|
|
rec := dispatchBookmark(hb.H, http.MethodDelete, "/api/me/item/book-1/bookmark/42.5", "book-1", "42.5", nil, "1", "", hb.H.handleDeleteBookmark)
|
|
if rec.Code != http.StatusOK {
|
|
t.Fatalf("status = %d, want 200 (no leak); body=%s", rec.Code, rec.Body.String())
|
|
}
|
|
var aList []map[string]any
|
|
_ = json.Unmarshal(rec.Body.Bytes(), &aList)
|
|
if len(aList) != 0 {
|
|
t.Errorf("user A response list = %v, want empty", aList)
|
|
}
|
|
|
|
// User B's bookmark must still be there.
|
|
bList, err := hb.Book.List(context.Background(), "2", "", "book-1")
|
|
if err != nil {
|
|
t.Fatalf("List: %v", err)
|
|
}
|
|
if len(bList) != 1 {
|
|
t.Errorf("user B bookmarks = %d, want 1 (was wrongly deleted)", len(bList))
|
|
}
|
|
}
|
|
|
|
func TestMissingItem_404(t *testing.T) {
|
|
hb := newBookmarksHarness(t /* no known items */)
|
|
rec := dispatchBookmark(hb.H, http.MethodPost, "/api/me/item/unknown/bookmark", "unknown", "", []byte(`{"title":"x","time":1}`), "1", "", hb.H.handleUpsertBookmark("bookmark_created"))
|
|
if rec.Code != http.StatusNotFound {
|
|
t.Errorf("status = %d, want 404; body=%s", rec.Code, rec.Body.String())
|
|
}
|
|
}
|
|
|
|
func TestItemLookup_ErrorFromMediaStore_500(t *testing.T) {
|
|
hb := newBookmarksHarness(t, "book-1")
|
|
hb.H.deps.MediaStore = &stubMediaStore{
|
|
known: map[string]*models.MediaItem{"book-1": nil},
|
|
lookupErr: errors.New("media lookup failed"),
|
|
}
|
|
|
|
rec := dispatchBookmark(hb.H, http.MethodPost, "/api/me/item/book-1/bookmark", "book-1", "", []byte(`{"title":"x","time":1}`), "1", "", hb.H.handleUpsertBookmark("bookmark_created"))
|
|
if rec.Code != http.StatusInternalServerError {
|
|
t.Errorf("status = %d, want 500; body=%s", rec.Code, rec.Body.String())
|
|
}
|
|
}
|
|
|
|
func TestInvalidBody_400(t *testing.T) {
|
|
hb := newBookmarksHarness(t, "book-1")
|
|
rec := dispatchBookmark(hb.H, http.MethodPost, "/api/me/item/book-1/bookmark", "book-1", "", []byte(`{not json`), "1", "", hb.H.handleUpsertBookmark("bookmark_created"))
|
|
if rec.Code != http.StatusBadRequest {
|
|
t.Errorf("status = %d, want 400; body=%s", rec.Code, rec.Body.String())
|
|
}
|
|
}
|
|
|
|
func TestMissingTime_400(t *testing.T) {
|
|
hb := newBookmarksHarness(t, "book-1")
|
|
rec := dispatchBookmark(hb.H, http.MethodPost, "/api/me/item/book-1/bookmark", "book-1", "", []byte(`{"title":"no time"}`), "1", "", hb.H.handleUpsertBookmark("bookmark_created"))
|
|
if rec.Code != http.StatusBadRequest {
|
|
t.Errorf("status = %d, want 400; body=%s", rec.Code, rec.Body.String())
|
|
}
|
|
}
|
|
|
|
func assertOneEvent(t *testing.T, pub *recordingPublisher, wantUser, wantReason string) {
|
|
t.Helper()
|
|
evts := pub.snapshot()
|
|
if len(evts) != 1 {
|
|
t.Fatalf("publisher events = %d, want 1: %+v", len(evts), evts)
|
|
}
|
|
e := evts[0]
|
|
if e.UserID != wantUser {
|
|
t.Errorf("event userID = %q, want %q", e.UserID, wantUser)
|
|
}
|
|
if e.Event != "user_updated" {
|
|
t.Errorf("event name = %q, want user_updated", e.Event)
|
|
}
|
|
payload, ok := e.Payload.(map[string]any)
|
|
if !ok {
|
|
t.Fatalf("payload type = %T, want map[string]any", e.Payload)
|
|
}
|
|
if payload["reason"] != wantReason {
|
|
t.Errorf("reason = %v, want %q", payload["reason"], wantReason)
|
|
}
|
|
if _, ok := payload["bookmark"].(map[string]any); !ok {
|
|
t.Errorf("bookmark payload missing or wrong type: %T", payload["bookmark"])
|
|
}
|
|
}
|
|
|
|
func TestSocketEvent_FiredOnCreate(t *testing.T) {
|
|
hb := newBookmarksHarness(t, "book-1")
|
|
_ = dispatchBookmark(hb.H, http.MethodPost, "/api/me/item/book-1/bookmark", "book-1", "", []byte(`{"title":"x","time":1}`), "7", "", hb.H.handleUpsertBookmark("bookmark_created"))
|
|
assertOneEvent(t, hb.Pub, "7", "bookmark_created")
|
|
}
|
|
|
|
func TestSocketEvent_FiredOnUpdate(t *testing.T) {
|
|
hb := newBookmarksHarness(t, "book-1")
|
|
// Seed (publishes a create event); then PATCH and only assert the
|
|
// second event.
|
|
_ = dispatchBookmark(hb.H, http.MethodPost, "/api/me/item/book-1/bookmark", "book-1", "", []byte(`{"title":"x","time":1}`), "7", "", hb.H.handleUpsertBookmark("bookmark_created"))
|
|
_ = dispatchBookmark(hb.H, http.MethodPatch, "/api/me/item/book-1/bookmark", "book-1", "", []byte(`{"title":"y","time":1}`), "7", "", hb.H.handleUpsertBookmark("bookmark_updated"))
|
|
evts := hb.Pub.snapshot()
|
|
if len(evts) != 2 {
|
|
t.Fatalf("publisher events = %d, want 2", len(evts))
|
|
}
|
|
payload := evts[1].Payload.(map[string]any)
|
|
if payload["reason"] != "bookmark_updated" {
|
|
t.Errorf("second event reason = %v, want bookmark_updated", payload["reason"])
|
|
}
|
|
}
|
|
|
|
func TestSocketEvent_FiredOnDelete(t *testing.T) {
|
|
hb := newBookmarksHarness(t, "book-1")
|
|
_ = dispatchBookmark(hb.H, http.MethodPost, "/api/me/item/book-1/bookmark", "book-1", "", []byte(`{"title":"x","time":1}`), "7", "", hb.H.handleUpsertBookmark("bookmark_created"))
|
|
_ = dispatchBookmark(hb.H, http.MethodDelete, "/api/me/item/book-1/bookmark/1", "book-1", "1", nil, "7", "", hb.H.handleDeleteBookmark)
|
|
evts := hb.Pub.snapshot()
|
|
if len(evts) != 2 {
|
|
t.Fatalf("publisher events = %d, want 2 (create + delete)", len(evts))
|
|
}
|
|
payload := evts[1].Payload.(map[string]any)
|
|
if payload["reason"] != "bookmark_deleted" {
|
|
t.Errorf("delete event reason = %v, want bookmark_deleted", payload["reason"])
|
|
}
|
|
bm, _ := payload["bookmark"].(map[string]any)
|
|
if bm["title"] != "x" {
|
|
t.Errorf("delete payload title = %v, want 'x' (pre-delete snapshot)", bm["title"])
|
|
}
|
|
}
|