Files
silo-server/internal/imagecache/imagecache.go
T
14ffc91dfb [codex] Expand provider image cache queue (#176)
* feat(metadata): expand provider image cache queue

* fix(metadata): harden provider image cache queue

Addresses bug-review feedback from Codex/CodeRabbit on the metadata image
cache pipeline. All findings validated against the code before fixing;
false positives (rows/connection deadlock, PhotoSourcePath merge coupling)
were confirmed non-issues and left unchanged.

- Honor metadata.cache_images for the background processor. The
  cache_metadata_images task was registered whenever S3 was configured,
  so merely enabling object storage downloaded the entire provider-artwork
  catalog even with caching disabled. Add ImageCacheProcessor.SetEnabled,
  gate RunOnce/RunUntilIdle on it, and wire it (with hot reload) from
  cfg.Metadata.CacheImages in main.go.
- Guard terminal job updates with lease ownership. EnqueueBatch can
  repurpose a running row with a new source; MarkSucceeded/MarkFailed
  keyed on id alone let a stale worker finalize the replacement job and
  drop the new artwork. Thread locked_by through and add
  status='running' AND locked_by=$n guards.
- Avoid uploading stale jobs onto the live artwork key. Verify the
  target still references the job's source (CurrentTargetSourcePath)
  before CacheImage, so a job whose source an admin/refresh already
  replaced cannot overwrite the deterministic storage object.
- COALESCE nullable external IDs in EnqueueExistingProviderArtwork. A
  NULL tmdb_id/tvdb_id/imdb_id on any candidate failed the scan and
  aborted the whole cache run; matches the existing item_repo pattern.
- Stop re-downloading the catalog every 30 days. Discovery now skips
  targets whose *_path is already a cached relative path, making the
  cached row the durable dedup marker instead of the prunable job row.
- Decouple catalog sweeps from queue draining. RunOnce no longer runs
  discovery per batch; RunUntilIdle sweeps only when the queue drains and
  throttles full sweeps to every 15m, so idle installs stop full-scanning
  every entity table each minute.
- Requeue claimed-but-unstarted jobs on cancellation. Acquire the
  semaphore before spawning workers and RequeueClaimed any jobs not yet
  started, instead of leaving them locked until the 15m lease expires.
- Skip the backoff sleep after the final upload attempt in
  putObjectWithRetry (saves ~1.5s on permanent failures).
- Add the s3/file/local/upload/generated exclusion to the seasons and
  episodes backfill in migration 20260617184537 for consistency with the
  later migration (the bad backfill was inert downstream, but the
  asymmetry is removed).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-18 10:07:58 -04:00

493 lines
15 KiB
Go

// Package imagecache downloads images from URLs, generates sized variants,
// computes thumbhashes, and uploads all variants to S3.
package imagecache
import (
"context"
"fmt"
"io"
"net"
"net/http"
"net/netip"
"net/url"
"strings"
"sync"
"time"
"github.com/Silo-Server/silo-server/internal/imageutil"
"github.com/Silo-Server/silo-server/internal/metadata"
)
const (
maxDownloadBytes = 10 * 1024 * 1024 // 10 MB
downloadTimeout = 30 * time.Second
)
// ObjectPutter is the S3 interface required by Cacher.
type ObjectPutter interface {
PutObject(ctx context.Context, bucket, key string, data []byte) error
Bucket() string
}
// ImageURLResolver resolves plugin:// paths to HTTP URLs.
type ImageURLResolver interface {
ResolveImageURL(ctx context.Context, path string, variant string) string
}
// CacheRequest describes a single image to cache. For season posters and
// episode stills, ContentID is the parent series's provider ID and the
// SeasonNumber / EpisodeNumber fields scope the S3 key so siblings do not
// collide. Both pointers are nil for item-level images.
type CacheRequest struct {
SourceURL string
ProviderID string
ContentType string // "movies" or "series"
ContentID string
ImageType metadata.ImageType
SeasonNumber *int
EpisodeNumber *int
Language string
ImageResolver ImageURLResolver // optional; used when SourceURL is a plugin:// path
}
// CacheResult is returned by Cache on success.
type CacheResult struct {
BasePath string // S3 key prefix, e.g. "tmdb/movies/550/poster"
Thumbhash string // base64-encoded
Ext string // file extension including dot (e.g. ".jpg", ".png")
}
// Cacher downloads and stores image variants to S3.
type Cacher struct {
s3 ObjectPutter
httpClient *http.Client
enforcePublicURLs bool
}
// New creates a new Cacher backed by the given ObjectPutter.
func New(s3 ObjectPutter) *Cacher {
return &Cacher{s3: s3, httpClient: newSecureHTTPClient(), enforcePublicURLs: true}
}
func newWithHTTPClient(s3 ObjectPutter, client *http.Client) *Cacher {
if client == nil {
client = http.DefaultClient
}
return &Cacher{s3: s3, httpClient: client}
}
// CacheImage implements metadata.ImageCacher using the internal Cache method.
func (c *Cacher) CacheImage(ctx context.Context, req metadata.CacheImageRequest) (*metadata.CacheImageResult, error) {
result, err := c.Cache(ctx, CacheRequest{
SourceURL: req.SourceURL,
ProviderID: req.ProviderID,
ContentType: req.ContentType,
ContentID: req.ContentID,
ImageType: req.ImageType,
SeasonNumber: req.SeasonNumber,
EpisodeNumber: req.EpisodeNumber,
Language: req.Language,
})
if err != nil {
return nil, err
}
return &metadata.CacheImageResult{
BasePath: result.BasePath,
Thumbhash: result.Thumbhash,
Ext: result.Ext,
}, nil
}
// CacheAudiobookCover is a thin convenience over CacheBytes specifically
// for the audiobook scanner. Avoids exporting the imagecache request
// struct to the scanner package (which would create an import cycle
// scanner -> imagecache -> metadata -> scanner). Stores under
// "local/audiobooks/{contentID}/poster/...".
func (c *Cacher) CacheAudiobookCover(ctx context.Context, data []byte, contentID string) (basePath string, ext string, thumbhash string, err error) {
res, err := c.CacheBytes(ctx, data, CacheRequest{
ProviderID: "local",
ContentType: "audiobooks",
ContentID: contentID,
ImageType: metadata.ImagePoster,
})
if err != nil {
return "", "", "", err
}
return res.BasePath, res.Ext, res.Thumbhash, nil
}
// CacheEbookCover stores an embedded ebook cover under
// "local/ebooks/{contentID}/poster/..." using the same poster variants as
// provider-hosted book artwork.
func (c *Cacher) CacheEbookCover(ctx context.Context, data []byte, contentID string) (basePath string, ext string, thumbhash string, err error) {
res, err := c.CacheBytes(ctx, data, CacheRequest{
ProviderID: "local",
ContentType: "ebooks",
ContentID: contentID,
ImageType: metadata.ImagePoster,
})
if err != nil {
return "", "", "", err
}
return res.BasePath, res.Ext, res.Thumbhash, nil
}
// CacheBytes performs the same variant generation, thumbhash, and S3 upload as
// Cache but starts from raw image bytes already in hand. Used by the
// audiobook scanner to push embedded M4B cover art into S3 without round-
// tripping through HTTP.
func (c *Cacher) CacheBytes(ctx context.Context, data []byte, req CacheRequest) (*CacheResult, error) {
if strings.TrimSpace(req.ProviderID) == "" {
return nil, fmt.Errorf("imagecache: provider ID is required")
}
if strings.TrimSpace(req.ContentType) == "" {
return nil, fmt.Errorf("imagecache: content type is required")
}
if strings.TrimSpace(req.ContentID) == "" {
return nil, fmt.Errorf("imagecache: content ID is required")
}
if len(data) == 0 {
return nil, fmt.Errorf("imagecache: image data is empty")
}
thumbhash, err := imageutil.Thumbhash(data)
if err != nil {
return nil, fmt.Errorf("imagecache: thumbhash: %w", err)
}
widths := variantWidths(req.ImageType)
result, err := imageutil.GenerateVariants(data, widths)
if err != nil {
return nil, fmt.Errorf("imagecache: generate variants: %w", err)
}
basePath := buildBasePath(req.ProviderID, req.ContentType, req.ContentID, req.ImageType, req.Language, req.SeasonNumber, req.EpisodeNumber)
bucket := c.s3.Bucket()
var wg sync.WaitGroup
uploadErrs := make([]error, len(result.Variants))
for i, v := range result.Variants {
wg.Add(1)
go func(idx int, variant imageutil.Variant) {
defer wg.Done()
key := basePath + "/" + variant.Key + result.Ext
if err := putObjectWithRetry(ctx, c.s3, bucket, key, variant.Data); err != nil {
uploadErrs[idx] = fmt.Errorf("imagecache: upload %s: %w", key, err)
}
}(i, v)
}
wg.Wait()
for _, err := range uploadErrs {
if err != nil {
return nil, err
}
}
return &CacheResult{BasePath: basePath, Thumbhash: thumbhash, Ext: result.Ext}, nil
}
// Cache downloads the image at req.SourceURL, generates variants, computes a
// thumbhash, uploads all variants to S3, and returns the base path and thumbhash.
func (c *Cacher) Cache(ctx context.Context, req CacheRequest) (*CacheResult, error) {
if strings.TrimSpace(req.ProviderID) == "" {
return nil, fmt.Errorf("imagecache: provider ID is required")
}
if strings.TrimSpace(req.ContentType) == "" {
return nil, fmt.Errorf("imagecache: content type is required")
}
if strings.TrimSpace(req.ContentID) == "" {
return nil, fmt.Errorf("imagecache: content ID is required")
}
if req.EpisodeNumber != nil && req.SeasonNumber == nil {
return nil, fmt.Errorf("imagecache: episode number requires a season number")
}
url := req.SourceURL
// Resolve non-HTTP paths (e.g. plugin_id://path) via the resolver.
if !strings.HasPrefix(url, "http://") && !strings.HasPrefix(url, "https://") {
if req.ImageResolver == nil {
return nil, fmt.Errorf("imagecache: non-HTTP URL %q requires ImageResolver", url)
}
url = req.ImageResolver.ResolveImageURL(ctx, url, "original")
if url == "" {
return nil, fmt.Errorf("imagecache: resolver returned empty URL for %q", req.SourceURL)
}
}
data, err := c.downloadImage(ctx, url)
if err != nil {
return nil, fmt.Errorf("imagecache: download %s: %w", url, err)
}
// Compute thumbhash from the original downloaded data (JPEG/PNG) before
// converting to WebP, since Go's image.Decode doesn't support WebP.
thumbhash, err := imageutil.Thumbhash(data)
if err != nil {
return nil, fmt.Errorf("imagecache: thumbhash: %w", err)
}
widths := variantWidths(req.ImageType)
result, err := imageutil.GenerateVariants(data, widths)
if err != nil {
return nil, fmt.Errorf("imagecache: generate variants: %w", err)
}
basePath := buildBasePath(req.ProviderID, req.ContentType, req.ContentID, req.ImageType, req.Language, req.SeasonNumber, req.EpisodeNumber)
bucket := c.s3.Bucket()
// Upload all variants concurrently.
var wg sync.WaitGroup
uploadErrs := make([]error, len(result.Variants))
for i, v := range result.Variants {
wg.Add(1)
go func(idx int, variant imageutil.Variant) {
defer wg.Done()
key := basePath + "/" + variant.Key + result.Ext
if err := putObjectWithRetry(ctx, c.s3, bucket, key, variant.Data); err != nil {
uploadErrs[idx] = fmt.Errorf("imagecache: upload %s: %w", key, err)
}
}(i, v)
}
wg.Wait()
for _, err := range uploadErrs {
if err != nil {
return nil, err
}
}
return &CacheResult{
BasePath: basePath,
Thumbhash: thumbhash,
Ext: result.Ext,
}, nil
}
// variantWidths returns the resize widths for the given image type.
func variantWidths(t metadata.ImageType) []int {
switch t {
case metadata.ImagePoster:
return []int{500, 300}
case metadata.ImageBackdrop:
return []int{1920, 1280, 300}
case metadata.ImageLogo:
return []int{500}
case metadata.ImageStill:
return []int{500, 300}
case metadata.ImageProfile:
return []int{500, 300}
default:
return []int{500, 300}
}
}
func putObjectWithRetry(ctx context.Context, putter ObjectPutter, bucket, key string, data []byte) error {
const maxAttempts = 3
var lastErr error
for attempt := 0; attempt < maxAttempts; attempt++ {
if err := putter.PutObject(ctx, bucket, key, data); err != nil {
lastErr = err
if attempt == maxAttempts-1 {
// Final attempt failed; return immediately without a pointless backoff.
break
}
timer := time.NewTimer(time.Duration(attempt+1) * 500 * time.Millisecond)
select {
case <-timer.C:
continue
case <-ctx.Done():
timer.Stop()
return ctx.Err()
}
}
return nil
}
return lastErr
}
// buildBasePath constructs the S3 key prefix for a given image. Season
// posters and episode stills nest under their parent series so a single
// DeletePrefix on the series prefix cascades to all child images.
//
// item-level: {provider}/{type}/{id}/{imageType}
// localized item: {provider}/{type}/{id}/localizations/{lang}/{imageType}
// season: {provider}/{type}/{id}/seasons/{n}/{imageType}
// localized season: {provider}/{type}/{id}/localizations/{lang}/seasons/{n}/{imageType}
// episode: {provider}/{type}/{id}/seasons/{n}/episodes/{m}/{imageType}
func buildBasePath(providerID, contentType, contentID string, t metadata.ImageType, language string, seasonNumber, episodeNumber *int) string {
imageTypeName := imageTypeName(t)
base := fmt.Sprintf("%s/%s/%s", providerID, contentType, contentID)
if lang := normalizeImageLanguage(language); lang != "" {
base = fmt.Sprintf("%s/localizations/%s", base, lang)
}
if seasonNumber != nil {
base = fmt.Sprintf("%s/seasons/%d", base, *seasonNumber)
if episodeNumber != nil {
base = fmt.Sprintf("%s/episodes/%d", base, *episodeNumber)
}
}
return base + "/" + imageTypeName
}
// imageTypeName returns the lowercase string name for an ImageType.
func imageTypeName(t metadata.ImageType) string {
switch t {
case metadata.ImagePoster:
return "poster"
case metadata.ImageBackdrop:
return "backdrop"
case metadata.ImageLogo:
return "logo"
case metadata.ImageStill:
return "still"
case metadata.ImageProfile:
return "profile"
default:
return "unknown"
}
}
func normalizeImageLanguage(language string) string {
language = strings.ToLower(strings.TrimSpace(language))
if language == "" {
return ""
}
var b strings.Builder
for _, r := range language {
switch {
case r >= 'a' && r <= 'z':
b.WriteRune(r)
case r >= '0' && r <= '9':
b.WriteRune(r)
case r == '-' || r == '_':
b.WriteRune(r)
default:
b.WriteByte('_')
}
}
return strings.Trim(b.String(), "_")
}
// downloadImage fetches the image at the given URL, enforcing size, timeout,
// and public-network limits.
func (c *Cacher) downloadImage(ctx context.Context, rawURL string) ([]byte, error) {
parsed, err := url.Parse(rawURL)
if err != nil {
return nil, fmt.Errorf("parse URL: %w", err)
}
if c.enforcePublicURLs {
if err := validatePublicImageURL(parsed); err != nil {
return nil, err
}
}
ctx, cancel := context.WithTimeout(ctx, downloadTimeout)
defer cancel()
req, err := http.NewRequestWithContext(ctx, http.MethodGet, rawURL, nil)
if err != nil {
return nil, fmt.Errorf("build request: %w", err)
}
client := c.httpClient
if client == nil {
client = newSecureHTTPClient()
}
resp, err := client.Do(req)
if err != nil {
return nil, fmt.Errorf("http get: %w", err)
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
return nil, fmt.Errorf("unexpected status %d", resp.StatusCode)
}
limited := io.LimitReader(resp.Body, maxDownloadBytes+1)
data, err := io.ReadAll(limited)
if err != nil {
return nil, fmt.Errorf("read body: %w", err)
}
if int64(len(data)) > maxDownloadBytes {
return nil, fmt.Errorf("image exceeds %d byte limit", maxDownloadBytes)
}
return data, nil
}
func newSecureHTTPClient() *http.Client {
transport := &http.Transport{
Proxy: nil,
DialContext: secureImageDialContext,
TLSHandshakeTimeout: 10 * time.Second,
}
return &http.Client{
Transport: transport,
CheckRedirect: func(req *http.Request, via []*http.Request) error {
if len(via) >= 10 {
return http.ErrUseLastResponse
}
return validatePublicImageURL(req.URL)
},
}
}
func validatePublicImageURL(u *url.URL) error {
if u == nil {
return fmt.Errorf("empty URL")
}
if u.Scheme != "http" && u.Scheme != "https" {
return fmt.Errorf("unsupported URL scheme %q", u.Scheme)
}
host := u.Hostname()
if host == "" {
return fmt.Errorf("URL host is required")
}
if addr, err := netip.ParseAddr(host); err == nil && !isPublicAddr(addr) {
return fmt.Errorf("private image host %q is not allowed", host)
}
return nil
}
func secureImageDialContext(ctx context.Context, network, address string) (net.Conn, error) {
host, port, err := net.SplitHostPort(address)
if err != nil {
return nil, err
}
addr, err := resolvePublicAddr(ctx, host)
if err != nil {
return nil, err
}
dialer := &net.Dialer{Timeout: downloadTimeout}
return dialer.DialContext(ctx, network, net.JoinHostPort(addr.String(), port))
}
func resolvePublicAddr(ctx context.Context, host string) (netip.Addr, error) {
if addr, err := netip.ParseAddr(host); err == nil {
if isPublicAddr(addr) {
return addr, nil
}
return netip.Addr{}, fmt.Errorf("private image host %q is not allowed", host)
}
ips, err := net.DefaultResolver.LookupIPAddr(ctx, host)
if err != nil {
return netip.Addr{}, fmt.Errorf("resolve image host %q: %w", host, err)
}
for _, ip := range ips {
addr, ok := netip.AddrFromSlice(ip.IP)
if ok && isPublicAddr(addr) {
return addr, nil
}
}
return netip.Addr{}, fmt.Errorf("image host %q did not resolve to a public address", host)
}
func isPublicAddr(addr netip.Addr) bool {
if addr.Is4In6() {
addr = addr.Unmap()
}
return addr.IsGlobalUnicast() &&
!addr.IsPrivate() &&
!addr.IsLoopback() &&
!addr.IsLinkLocalUnicast() &&
!addr.IsLinkLocalMulticast() &&
!addr.IsMulticast() &&
!addr.IsUnspecified()
}