mirror of
https://github.com/navidrome/navidrome.git
synced 2026-08-31 07:30:32 +00:00
59a4ed8e79
* fix(plugins): stop reporting plugin call failures as not-found MetadataAgent joined agents.ErrNotFound onto every failed plugin call, so a transport fault was indistinguishable from a definitive miss. The artwork circuit breaker treats a not-found as a successful, definitive answer and resets its failure counter, so it never opened for a failing plugin and kept calling it on every request. Observed with the apple-music plugin against prod: ~900 iTunes 429s in 27 minutes with the breaker never tripping. Return the underlying error instead. The genuine empty-result branches still return agents.ErrNotFound, and agent fallback is unaffected because callAgentMethod/callAgentSliceMethod continue on any error, not only on ErrNotFound. * test(plugins): fold duplicate metadata agent error specs into one table The error-handling container drove all 11 MetadataAgent methods twice: once to assert the message, once to assert the failure is not an ErrNotFound. The argument lists were identical, so each method cost two WASM instantiations for one method's worth of coverage, and a new capability had to be registered in two places to stay guarded. Fold both assertions into a single DescribeTable, document the ErrNotFound contract at the sentinel where agent implementers will read it, and collapse breaker.record's hand-inlined predicate onto isTransientExternal, which it already duplicated by hand with a keep-in-sync comment. * fix(plugins): keep an unimplemented plugin method a definitive miss Returning the raw plugin error made errNotImplemented and errFunctionNotFound look like provider faults. Every MetadataAgent satisfies ArtistImageRetriever and AlbumImageRetriever regardless of what the plugin actually exports, so artwork resolution calls those stubs on a partially-implemented plugin: each call counted toward the artwork circuit breaker and kept the item in the retry queue instead of settling it absent. Map both sentinels back onto agents.ErrNotFound, joined so the underlying reason survives for diagnostics, and leave real call failures untouched. This matches what ScrobblerPlugin already does for the same two sentinels. The partial-implementation specs asserted only MatchError(errNotImplemented), which the previous errors.Join satisfied incidentally, so nothing caught the lost not-found semantics. They now assert both and are folded into one table. * test(plugins): cover the missing-export arm of agentErr The partial-metadata-agent fixture registers through the Go PDK, which exports every method and answers with the not-implemented code, so no fixture reaches the errFunctionNotFound branch. Building one would mean hand-writing Extism exports to deliberately omit a function, which tests the manager's function lookup rather than the mapping this PR added. Cover agentErr directly instead: both sentinels classify as a definitive miss, a call failure and a non-zero exit stay faults, and the underlying reason survives in every case. * fix(artwork): stop counting a cancelled run against the circuit breaker callPluginFunction returns ctx.Err() when a plugin call is cancelled, and that reached breaker.record as an ordinary error, so cancellations counted toward the five consecutive failures that open a gate. A cancellation says nothing about the provider, so it now neither counts nor clears the failure run. Deliberately scoped to breaker.record rather than isTransientExternal: the latter also drives whether the queue item is rescheduled, and a cancelled item must still be retried rather than settling absent. context.DeadlineExceeded is left counting as a fault, since a provider that blows the budget is one worth backing off from. Reachable today only at shutdown, where the in-memory breaker state is discarded anyway. It becomes live the moment Worker.gate is used on a request-scoped context, which is why it is worth closing now.
138 lines
3.9 KiB
Go
138 lines
3.9 KiB
Go
package agents
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
|
|
"github.com/gohugoio/hashstructure"
|
|
"github.com/navidrome/navidrome/model"
|
|
)
|
|
|
|
type Constructor func(ds model.DataStore) Interface
|
|
|
|
type Interface interface {
|
|
AgentName() string
|
|
}
|
|
|
|
// AlbumInfo contains album metadata (no images)
|
|
type AlbumInfo struct {
|
|
Name string
|
|
MBID string
|
|
Description string
|
|
URL string
|
|
}
|
|
|
|
type Artist struct {
|
|
ID string
|
|
Name string
|
|
MBID string
|
|
}
|
|
|
|
type ExternalImage struct {
|
|
URL string
|
|
Size int
|
|
}
|
|
|
|
type Song struct {
|
|
ID string
|
|
Name string
|
|
MBID string
|
|
ISRC string
|
|
Artists []Artist
|
|
Album string
|
|
AlbumMBID string
|
|
Duration uint32 // Duration in milliseconds, 0 means unknown
|
|
}
|
|
|
|
// Equals reports strict whole-value equality, used to dedup identical input songs. It hashes
|
|
// rather than comparing with ==, which the Artists slice makes illegal.
|
|
func (s Song) Equals(other Song) bool {
|
|
h1, _ := hashstructure.Hash(s, nil)
|
|
h2, _ := hashstructure.Hash(other, nil)
|
|
return h1 == h2
|
|
}
|
|
|
|
var (
|
|
// ErrNotFound means the provider answered and had nothing. Return the underlying error
|
|
// for a fault instead, or callers that back off on faults will treat it as definitive.
|
|
ErrNotFound = errors.New("not found")
|
|
)
|
|
|
|
// AlbumInfoRetriever provides album info (no images)
|
|
type AlbumInfoRetriever interface {
|
|
GetAlbumInfo(ctx context.Context, name, artist, mbid string) (*AlbumInfo, error)
|
|
}
|
|
|
|
// AlbumImageRetriever provides album images
|
|
type AlbumImageRetriever interface {
|
|
GetAlbumImages(ctx context.Context, name, artist, mbid string) ([]ExternalImage, error)
|
|
}
|
|
|
|
type ArtistMBIDRetriever interface {
|
|
GetArtistMBID(ctx context.Context, id string, name string) (string, error)
|
|
}
|
|
|
|
type ArtistURLRetriever interface {
|
|
GetArtistURL(ctx context.Context, id, name, mbid string) (string, error)
|
|
}
|
|
|
|
type ArtistBiographyRetriever interface {
|
|
GetArtistBiography(ctx context.Context, id, name, mbid string) (string, error)
|
|
}
|
|
|
|
type ArtistSimilarRetriever interface {
|
|
GetSimilarArtists(ctx context.Context, id, name, mbid string, limit int) ([]Artist, error)
|
|
}
|
|
|
|
type ArtistImageRetriever interface {
|
|
GetArtistImages(ctx context.Context, id, name, mbid string) ([]ExternalImage, error)
|
|
}
|
|
|
|
type ArtistTopSongsRetriever interface {
|
|
GetArtistTopSongs(ctx context.Context, id, artistName, mbid string, count int) ([]Song, error)
|
|
}
|
|
|
|
// SimilarSongsByTrackRetriever provides similar songs based on a specific track
|
|
type SimilarSongsByTrackRetriever interface {
|
|
// GetSimilarSongsByTrack returns songs similar to the given track.
|
|
// Parameters:
|
|
// - id: local mediafile ID
|
|
// - name: track title
|
|
// - artist: artist name
|
|
// - mbid: MusicBrainz recording ID (may be empty)
|
|
// - count: maximum number of results
|
|
GetSimilarSongsByTrack(ctx context.Context, id, name, artist, mbid string, count int) ([]Song, error)
|
|
}
|
|
|
|
// SimilarSongsByAlbumRetriever provides similar songs based on an album
|
|
type SimilarSongsByAlbumRetriever interface {
|
|
// GetSimilarSongsByAlbum returns songs similar to tracks on the given album.
|
|
// Parameters:
|
|
// - id: local album ID
|
|
// - name: album name
|
|
// - artist: album artist name
|
|
// - mbid: MusicBrainz release ID (may be empty)
|
|
// - count: maximum number of results
|
|
GetSimilarSongsByAlbum(ctx context.Context, id, name, artist, mbid string, count int) ([]Song, error)
|
|
}
|
|
|
|
// SimilarSongsByArtistRetriever provides similar songs based on an artist
|
|
type SimilarSongsByArtistRetriever interface {
|
|
// GetSimilarSongsByArtist returns songs similar to the artist's catalog.
|
|
// Parameters:
|
|
// - id: local artist ID
|
|
// - name: artist name
|
|
// - mbid: MusicBrainz artist ID (may be empty)
|
|
// - count: maximum number of results
|
|
GetSimilarSongsByArtist(ctx context.Context, id, name, mbid string, count int) ([]Song, error)
|
|
}
|
|
|
|
var Map map[string]Constructor
|
|
|
|
func Register(name string, init Constructor) {
|
|
if Map == nil {
|
|
Map = make(map[string]Constructor)
|
|
}
|
|
Map[name] = init
|
|
}
|