mirror of
https://github.com/Psychotoxical/psysonic.git
synced 2026-07-21 23:05:46 +00:00
b950d4704b
* feat(cover): add artist_artwork_lookup table + accessors
Image-scraper P0 (design-review §12): additive library-SQLite migration 013
plus get/upsert/clear-per-server accessors for the external artist-artwork
lookup (fanart.tv). Render never reads it; the on-demand cover ensure path
and the mbid_ambiguous 24h negative cache use it. server_id = serverIndexKey.
* feat(cover): add fanart.tv + getArtistInfo2 provider layer
Image-scraper P0 (§7/§19/§23): new cover_cache/external.rs — Rust-side
getArtistInfo2 tag-MBID resolution plus fanart.tv v3/music URL + first
artistbackground fetch (BYOK client_key sent in addition to the project
api_key per fanart.tv ToS, §22). Extract a shared build_subsonic_url helper
in fetch.rs (cover URL behaviour unchanged). Add a dedicated low-concurrency
fanart_http_sem so external HTTP never starves Navidrome (§26). URL builders
unit-tested; wired into ensure_inner next.
* feat(cover): wire fanart.tv external branch into ensure_inner
Image-scraper P0 (§16): on-demand artist `fanart` ensures try fanart.tv
before the Navidrome fallback. MBID resolved Rust-side via getArtistInfo2
(§23, tag MBID); on a miss it falls through WITHOUT a .fetch-failed marker so
Navidrome stays the display fallback (§28). External tiers are written as
{tier}-fanart.webp in the same entity dir (same cacheKind, §16) — 2000 + 512
(matryoshka §17); peek prefers them for the fanart surface. Dedicated
low-concurrency fanart lane (§26); .miss-fanart ~30min negative marker.
Additive IPC args (externalArtworkEnabled, surfaceKind), off by default and
gated by PSYSONIC_FANART_KEY — inert until a render surface opts in (P1).
Quality gate (§11), name->MusicBrainz (§19), and lookup-table writes are P1.
* feat(cover): fanart-first peek for the fanart surface
Image-scraper P0: for an artist `fanart` ensure, the early peek serves only
the external {tier}-fanart.webp tiers; if none exist yet it returns None so
ensure runs the external branch (fetch fanart) instead of short-circuiting on
a cached Navidrome tier. Realises "fanart prioritised" (§18) for the opt-in
surface; Navidrome stays the fallback inside the branch's miss path.
* chore(cover): dev-only artist-fanart spike helper
DEV-only window.psyFanartSpike(name) — resolves an artist by name and fires
the real cover_cache_ensure with externalArtworkEnabled+surfaceKind=fanart to
verify the P0 pipeline against a live server (with PSYSONIC_FANART_KEY set).
Not wired in production.
* feat(cover): §11 quality gate for the fanart surface
Before an external fanart fetch, check whether a Navidrome tier already on
disk is an HQ ~16:9 image (width >= 1280, aspect 1.6-2.0) and skip the fetch
if so — square artist portraits never satisfy it, so the common case still
fetches. Reads tier dimensions only (no full decode). Rust consts per the
design review. Unit-tested predicate.
* feat(cover): persist fanart resolution in artist_artwork_lookup (§12)
Wire the lookup table as both the MBID resolution cache and the negative
cache: a cached MBID skips the getArtistInfo2 round-trip; no_mbid/mbid_ambiguous
back off 24h and miss 30min from updated_at before re-querying. Writes
hit/miss/no_mbid with mbid/mbid_source/provider; transient network errors are
not cached. All store reads/writes run off the async executor via
spawn_blocking and no-op before login. Store reached via app.try_state::<LibraryRuntime>().
* feat(cover): compile-time fanart key fallback + album/name IPC args
A runtime PSYSONIC_FANART_KEY still wins (dev), else the key baked in at build
time via option_env! (release). Add additive artistName/albumTitle ensure args
as context for the §19 name->MusicBrainz fallback (inert until the render
passes them). Library backfill passes None.
* feat(settings): add External Artwork Scraper toggle under Integrations
Master toggle (themeStore, off by default per §20) in a new Integrations
subsection, alongside the other opt-in third-party categories. Contacts
fanart.tv only when enabled. i18n across all 9 locales.
* feat(cover): wire fanart background into the fullscreen player (§28)
New useArtistFanart hook resolves a fanart.tv 16:9 background via a dedicated
cover_cache_ensure (surfaceKind=fanart) — it bypasses the shared peek/disk-src
cache (the {tier}-fanart.webp surface is keyed differently) and reuses
coverDiskUrl for the asset URL. Fullscreen background priority is now
fanart -> Navidrome artist image (cover pipeline) -> album cover; the live
useFsArtistPortrait probe is deleted (§28). Additive ensure opts
(surfaceKind/artistName/albumTitle); externalArtworkEnabled is derived in
ensureArgsFromRef from the master toggle and restricted to the artist fanart
surface, so plain cover ensures are unaffected.
* feat(cover): generalize external surface to fanart + banner (§13)
surfaceKind='banner' fetches the fanart.tv musicbanner array -> {tier}-banner.webp
in the same entity dir; fanart stays the 16:9 artistbackground. The ensure
branch, peek, lookup rows (per-surface surface_kind), miss marker
(.miss-<surface>) and tier suffix are all surface-parameterised. The §11
quality gate stays fanart-only (the banner strip has its own aspect). Unit
test for the surface->fanart JSON key map.
* feat(artist): fanart banner on the artist-detail header (§13, Option B)
The artist-detail header gets an album-detail-style background layer: fanart.tv
banner (musicbanner) -> the 16:9 fanart background cropped to the strip ->
empty. Both via a shared useArtistExternalImage hook (useArtistBanner /
useArtistFanart); each fetches on demand and shares the Rust cache, so the
header and the fullscreen player warm each other's images. The header is its
own stacking context (isolation) so a z-index:-1 banner clips behind the avatar
+ meta with no content wrapper; the album-style framing (padding/radius/clip)
is applied only when a banner is shown, so the off-by-default case stays
pixel-identical.
* refactor(artist): reuse album-detail header structure for the fanart banner
The artist-detail header now uses the same album-detail-* container classes as
AlbumHeader (header/bg/overlay/content/hero) with the fanart banner as the
background; the Back button moves inside the header. A surgical
`artist-detail-bleed` cancels the artist page's .content-body padding so the
banner is full-bleed to the container edges, matching the album header exactly
instead of the earlier inset card. Reverts the experimental artist-specific bg
CSS.
* feat(cover): drop artist_artwork_lookup rows on clear-cover-cache (§12/B.4)
cover_cache_clear_server already removed the server's whole cover dir (so the
{tier}-fanart.webp / -banner.webp tiers + .miss-* markers go with it); also
clear the artist_artwork_lookup rows for that server (off-thread) so no stale
resolution state lingers. Automatic toggle-off purge deferred — turning the
toggle off already hides external artwork (render is gated), and explicit
cache-clear now cleans external state too.
* feat(cover): name->MusicBrainz album-confirmed MBID resolution (§19)
When getArtistInfo2 has no tag MBID and the ensure carries the artist name +
an album in context (fullscreen), one MusicBrainz release-search query resolves
the artist MBID: the primary artist across score>=90 releases wins, conflicting
ids -> mbid_ambiguous (24h backoff), none -> no_mbid. Sends the required
User-Agent; a single-permit musicbrainz_sem + >=1s spacing holds us under MB's
rate limit. mbid_source=musicbrainz persisted. Banner surface (no album
context) correctly skips this. Pure classify/escape helpers unit-tested.
* fix(cover): enable banner surface in ensureArgsFromRef
externalEnsureFields only set externalArtworkEnabled for surfaceKind 'fanart',
so the 'banner' surface never fired — the artist-detail header always fell back
to the fanart image instead of the fanart.tv musicbanner. Both external artist
surfaces (fanart/banner) now enable the external branch.
* feat(settings): optional BYOK personal fanart key field
Add an optional personal fanart.tv API key field to the External Artwork
Scraper block (shown when the toggle is on): a masked input, a saved/in-use
status line, and the simple note that it is sent in addition to the app key.
Persisted in themeStore and plumbed through cover_cache_ensure
(externalArtworkByok); Rust prefers the settings key, falling back to the
PSYSONIC_FANART_CLIENT_KEY dev env. i18n x9.
* fix(cover): resolve artist-page fanart image collision on navigation
The artist-detail header keyed its fanart/banner hooks on the route `id`,
which flips immediately on navigation while `artist`/`albums` refetch a beat
later. The mismatched ensure wrote the previous artist's image under the new
artist's id (e.g. Sepultura's image under Lordi's id).
- key on the loaded `artist.id`, not the route `id`, so id/name/album always
describe the same artist
- pick the §19 album context from an album that actually belongs to this
artist (`albums.find(a => a.artistId === artist.id)`), so a stale album can't
run a mismatched name→MusicBrainz query or cache a wrong `no_mbid`
- reset `src` on every input change in `useArtistExternalImage` so a previous
artist's image never lingers while the new one resolves
* fix(cover): strip trailing album qualifier before MusicBrainz lookup
Library titles like "Show No Mercy (2004 Remastered)" or "Album [Deluxe
Edition]" failed the §19 MusicBrainz release query, blocking name-confirmed
MBID resolution. `normalize_album_for_mb` strips a single trailing
parenthetical/bracketed qualifier; leading qualifiers (e.g. "(What's the
Story) Morning Glory?") are left intact. Unit-tested.
* fix(cover): don't cache no_mbid when album context is unavailable
The banner ensure could fire before the artist's albums loaded, with no album
in context. The old code cached `no_mbid` there and the 24h backoff then
blocked the later ensure that arrived *with* album context. Could-not-attempt
is not tried-and-failed: the no-album branch now returns without persisting.
* fix(cover): don't emit tier-ready for external fanart/banner surfaces
`try_external_fanart` emitted `cover:tier-ready` with the `{tier}-{surface}.webp`
path. That event is keyed by the canonical cover key (cacheKind/cacheEntityId/
tier, no surface), so the frontend `useCoverArtBridge` listener seeded the
Navidrome artist cover's disk-src cache with the external image — leaking
fanart/banner into the plain artist cover (avatar, fullscreen "navidrome-artist"
fallback) even with the scraper toggled off.
Remove the emit: the fanart/banner hooks read the path from the
`cover_cache_ensure` return value, so no event is needed. (No disk-level
overwrite — the suffixed files are never matched by `tier_exists`; this was
frontend disk-src-cache cross-contamination.)
* fix(cover): wait for the final external background before showing it, with fade-in
The fullscreen player and artist-detail header flashed several backgrounds in
sequence while the fanart resolved (upscaled album cover → Navidrome artist
image → fanart), and the artist header could show the fanart first and then
swap to the banner.
- the album cover is no longer a background source — it only feeds the
foreground thumbnail
- the external-artwork hooks return `{ src, pending }` so callers can tell
"still resolving" (hold back) from "resolved, no image" (fall back now)
- fullscreen background: scraper on → fanart, empty while it resolves, Navidrome
artist image only on a confirmed miss; scraper off → Navidrome artist image
- artist header: the banner is preferred — nothing shows while it resolves
(no fanart flash), fanart is the fallback only once the banner misses
- both backgrounds preload the chosen image and fade it in (`onLoad` plus a
`ref` `complete` check so an already-cached image, whose load event can fire
before React attaches the handler, still appears). The header fade is a
scoped inline opacity so the shared `album-detail-bg` class is untouched.
* ci(release): pass PSYSONIC_FANART_KEY into the macOS + Linux builds
* refactor(cover): extract external-artwork ensure into its own module
Pure code move: the on-demand fanart/banner fetch, the quality gate, the
surface-aware peek and the lookup-table cache move from cover_cache/mod.rs
into cover_cache/external_ensure.rs. Behaviour unchanged; mod.rs 1877 -> 1488.
* chore(cover): remove dev-only fanart spike helper
The real render wiring now exercises the external ensure branch, so the
dev-only window.psyFanartSpike helper is redundant.
* feat(cover): purge external artwork on opt-out (B3)
New cover_cache_purge_external command: when the External Artwork toggle is
turned off, drop every fetched {tier}-{provider}.webp, .miss-{provider}
marker and artist_artwork_lookup row across all configured servers, leaving
the canonical Navidrome covers intact. Opting out now removes the
third-party-sourced data instead of just hiding it (design-review §9/§12/B.4).
* docs: changelog, credits and what's new for artist fanart (PR #1137)
165 lines
5.1 KiB
Rust
165 lines
5.1 KiB
Rust
use reqwest::Client;
|
||
use std::time::{Duration, SystemTime, UNIX_EPOCH};
|
||
use url::Url;
|
||
|
||
const SUBSONIC_CLIENT: &str = "Psysonic";
|
||
|
||
/// Total cover fetch attempts (1 initial + retries). A busy server can answer
|
||
/// covers with 5xx/429/timeouts under our own backfill load, so a couple of
|
||
/// backed-off retries recover those without a permanent `.fetch-failed` marker.
|
||
const COVER_FETCH_ATTEMPTS: usize = 3;
|
||
/// Base backoff between attempts (grows linearly: 1×, 2×, …).
|
||
const COVER_FETCH_BACKOFF_MS: u64 = 400;
|
||
|
||
fn random_salt() -> String {
|
||
let nanos = SystemTime::now()
|
||
.duration_since(UNIX_EPOCH)
|
||
.map(|d| d.as_nanos())
|
||
.unwrap_or(0);
|
||
format!("{nanos:x}")
|
||
}
|
||
|
||
/// Build a token-authed Subsonic REST URL `{rest_base}/rest/{endpoint}.view`
|
||
/// with the standard `u/t/s/v/c` auth params plus the given `extra` query
|
||
/// pairs. Shared by all Subsonic GETs (cover art, `getArtistInfo2`, …).
|
||
pub(crate) fn build_subsonic_url(
|
||
rest_base: &str,
|
||
endpoint: &str,
|
||
username: &str,
|
||
password: &str,
|
||
extra: &[(&str, &str)],
|
||
) -> String {
|
||
let base = rest_base.trim_end_matches('/');
|
||
let api_base = if base.ends_with("/rest") {
|
||
base.to_string()
|
||
} else {
|
||
format!("{base}/rest")
|
||
};
|
||
let salt = random_salt();
|
||
let token = format!("{:x}", md5::compute(format!("{password}{salt}")));
|
||
let endpoint_url = format!("{api_base}/{endpoint}.view");
|
||
let mut serializer = url::form_urlencoded::Serializer::new(String::new());
|
||
for (k, v) in extra {
|
||
serializer.append_pair(k, v);
|
||
}
|
||
serializer.append_pair("u", username);
|
||
serializer.append_pair("t", &token);
|
||
serializer.append_pair("s", &salt);
|
||
serializer.append_pair("v", "1.16.1");
|
||
serializer.append_pair("c", SUBSONIC_CLIENT);
|
||
let query = serializer.finish();
|
||
match Url::parse(&endpoint_url) {
|
||
Ok(mut url) => {
|
||
url.set_query(Some(&query));
|
||
url.to_string()
|
||
}
|
||
Err(_) => format!("{endpoint_url}?{query}"),
|
||
}
|
||
}
|
||
|
||
pub fn build_cover_art_url(
|
||
rest_base: &str,
|
||
username: &str,
|
||
password: &str,
|
||
cover_art_id: &str,
|
||
size: u32,
|
||
) -> String {
|
||
let size_s = size.to_string();
|
||
build_subsonic_url(
|
||
rest_base,
|
||
"getCoverArt",
|
||
username,
|
||
password,
|
||
&[("id", cover_art_id), ("size", &size_s)],
|
||
)
|
||
}
|
||
|
||
/// Outcome of a single fetch attempt: transient errors are worth retrying,
|
||
/// permanent ones (a real 4xx like 404 — the cover simply does not exist) are
|
||
/// not, so we never hammer the server for genuinely-missing art.
|
||
enum FetchAttempt {
|
||
Ok(Vec<u8>),
|
||
Transient(String),
|
||
Permanent(String),
|
||
}
|
||
|
||
async fn fetch_cover_once(client: &Client, url: &str) -> FetchAttempt {
|
||
let resp = match client.get(url).send().await {
|
||
Ok(r) => r,
|
||
// Connection reset / timeout / DNS — transient under server load.
|
||
Err(e) => return FetchAttempt::Transient(e.to_string()),
|
||
};
|
||
let status = resp.status();
|
||
if status.is_success() {
|
||
return match resp.bytes().await {
|
||
Ok(b) => FetchAttempt::Ok(b.to_vec()),
|
||
Err(e) => FetchAttempt::Transient(e.to_string()),
|
||
};
|
||
}
|
||
let msg = format!("cover HTTP {status}");
|
||
if status.is_server_error() || status == reqwest::StatusCode::TOO_MANY_REQUESTS {
|
||
FetchAttempt::Transient(msg)
|
||
} else {
|
||
FetchAttempt::Permanent(msg)
|
||
}
|
||
}
|
||
|
||
pub async fn fetch_cover_bytes(client: &Client, url: &str) -> Result<Vec<u8>, String> {
|
||
let mut last_err = String::from("cover fetch failed");
|
||
for attempt in 0..COVER_FETCH_ATTEMPTS {
|
||
match fetch_cover_once(client, url).await {
|
||
FetchAttempt::Ok(bytes) => return Ok(bytes),
|
||
FetchAttempt::Permanent(e) => return Err(e),
|
||
FetchAttempt::Transient(e) => {
|
||
last_err = e;
|
||
if attempt + 1 < COVER_FETCH_ATTEMPTS {
|
||
tokio::time::sleep(Duration::from_millis(
|
||
COVER_FETCH_BACKOFF_MS * (attempt as u64 + 1),
|
||
))
|
||
.await;
|
||
}
|
||
}
|
||
}
|
||
}
|
||
Err(last_err)
|
||
}
|
||
|
||
#[cfg(test)]
|
||
mod tests {
|
||
use super::build_cover_art_url;
|
||
|
||
#[test]
|
||
fn cover_url_from_host_root() {
|
||
let url = build_cover_art_url(
|
||
"http://navidrome.local:4533",
|
||
"u",
|
||
"p",
|
||
"al-1",
|
||
800,
|
||
);
|
||
assert!(url.starts_with("http://navidrome.local:4533/rest/getCoverArt.view?"));
|
||
assert!(url.contains("id=al-1"));
|
||
assert!(url.contains("size=800"));
|
||
}
|
||
|
||
#[test]
|
||
fn cover_url_when_rest_suffix_already_present() {
|
||
let url = build_cover_art_url(
|
||
"http://navidrome.local:4533/rest",
|
||
"u",
|
||
"p",
|
||
"al-1",
|
||
128,
|
||
);
|
||
assert!(url.starts_with("http://navidrome.local:4533/rest/getCoverArt.view?"));
|
||
assert!(!url.contains("/rest/rest/"));
|
||
}
|
||
|
||
#[test]
|
||
fn cover_url_does_not_panic_on_malformed_base() {
|
||
let url = build_cover_art_url("://bad-url", "u", "p", "al-1", 128);
|
||
assert!(url.contains("/rest/getCoverArt.view?"));
|
||
assert!(url.contains("id=al-1"));
|
||
}
|
||
}
|