Compare commits
2
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
bb26d5f289 | ||
|
|
7b42b9ce56 |
@@ -1,248 +0,0 @@
|
|||||||
package download
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"testing"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Multi-disc rips, single-track results and coverage counted in tracks
|
|
||||||
// rather than files (#270).
|
|
||||||
|
|
||||||
func TestParsePathReadsTheDiscFromItsFolder(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
cases := []struct {
|
|
||||||
path string
|
|
||||||
disc int
|
|
||||||
track int
|
|
||||||
folder string
|
|
||||||
}{
|
|
||||||
{`\share\Pink Floyd - The Wall (1979)\CD2\03 Hey You.flac`, 2, 3, "The Wall"},
|
|
||||||
{`\share\The Wall\Disc 1\01 In The Flesh.flac`, 1, 1, "The Wall"},
|
|
||||||
{`\share\The Wall\[Disk-2]\01 Hey You.flac`, 2, 1, "The Wall"},
|
|
||||||
{`\share\The Wall\CD1 - Live\04 Mother.flac`, 1, 4, "The Wall"},
|
|
||||||
// The filename's own disc number is more specific than the folder.
|
|
||||||
{`\share\The Wall\CD1\2-05 Comfortably Numb.flac`, 2, 5, "The Wall"},
|
|
||||||
// Not a disc folder: a number is required.
|
|
||||||
{`\share\CDs\The Wall\01 In The Flesh.flac`, 0, 1, "The Wall"},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range cases {
|
|
||||||
t.Run(tc.path, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
got := ParsePath(tc.path)
|
|
||||||
if got.Disc != tc.disc || got.Track != tc.track || got.Folder != tc.folder {
|
|
||||||
t.Errorf(
|
|
||||||
"ParsePath = disc %d track %d folder %q, want %d %d %q",
|
|
||||||
got.Disc, got.Track, got.Folder, tc.disc, tc.track, tc.folder,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestAlbumDir(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
cases := map[string]string{
|
|
||||||
`\share\Album\CD1\01 A.flac`: "/share/Album",
|
|
||||||
`\share\Album\01 A.flac`: "/share/Album",
|
|
||||||
`CD1\01 A.flac`: "CD1",
|
|
||||||
`\share\CD Collection\01.mp3`: "/share/CD Collection",
|
|
||||||
}
|
|
||||||
|
|
||||||
for in, want := range cases {
|
|
||||||
if got := AlbumDir(in); got != want {
|
|
||||||
t.Errorf("AlbumDir(%q) = %q, want %q", in, got, want)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// One album shared as CD1/CD2 is one candidate, named after the album.
|
|
||||||
func TestSlskdGroupsDiscFoldersIntoOneCandidate(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
stub := newSlskdStub(t)
|
|
||||||
stub.responses = []slskdResponse{{
|
|
||||||
Username: "peer",
|
|
||||||
Files: []slskdFile{
|
|
||||||
{Filename: `\m\The Wall\CD1\01 In The Flesh.flac`, Size: 1},
|
|
||||||
{Filename: `\m\The Wall\CD1\02 The Thin Ice.flac`, Size: 1},
|
|
||||||
{Filename: `\m\The Wall\CD2\01 Hey You.flac`, Size: 1},
|
|
||||||
{Filename: `\m\The Wall\CD2\02 Is There Anybody Out There.flac`, Size: 1},
|
|
||||||
},
|
|
||||||
}}
|
|
||||||
|
|
||||||
s, _ := newStubSlskd(t, stub)
|
|
||||||
|
|
||||||
got, err := s.Search(context.Background(), Download{Query: "the wall"})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Search: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(got) != 1 {
|
|
||||||
t.Fatalf("got %d candidates, want the two discs as one", len(got))
|
|
||||||
}
|
|
||||||
|
|
||||||
if got[0].Title != "The Wall" || len(got[0].Files) != 4 {
|
|
||||||
t.Errorf(
|
|
||||||
"candidate = %q with %d files, want \"The Wall\" with 4",
|
|
||||||
got[0].Title, len(got[0].Files),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// A track search matches one file per folder, so a single-track request
|
|
||||||
// must accept a one-file folder that an album request rightly drops.
|
|
||||||
func TestSlskdKeepsASingleFileForATrackRequest(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
stub := newSlskdStub(t)
|
|
||||||
stub.responses = []slskdResponse{{
|
|
||||||
Username: "peer",
|
|
||||||
Files: []slskdFile{
|
|
||||||
{Filename: `\m\OK Computer\02 Paranoid Android.flac`, Size: 1},
|
|
||||||
},
|
|
||||||
}}
|
|
||||||
|
|
||||||
s, _ := newStubSlskd(t, stub)
|
|
||||||
|
|
||||||
track, err := s.Search(context.Background(), Download{
|
|
||||||
RecordingMBID: "rec-1", Artist: "Radiohead", Album: "Paranoid Android",
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Search: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(track) != 1 {
|
|
||||||
t.Errorf("track request: got %d candidates, want 1", len(track))
|
|
||||||
}
|
|
||||||
|
|
||||||
album, err := s.Search(context.Background(), Download{
|
|
||||||
ReleaseMBID: "rel-1", Artist: "Radiohead", Album: "OK Computer",
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Search: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(album) != 0 {
|
|
||||||
t.Errorf("album request: got %d candidates, want the one-file folder dropped", len(album))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Two discs with a file of the same name both reach staging, each under
|
|
||||||
// its disc folder, where the importer reads the disc number from.
|
|
||||||
func TestSlskdCollectKeepsDiscFolders(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
stub := newSlskdStub(t)
|
|
||||||
s, downloads := newStubSlskd(t, stub)
|
|
||||||
|
|
||||||
for _, disc := range []string{"CD1", "CD2"} {
|
|
||||||
dir := filepath.Join(downloads, disc)
|
|
||||||
if err := os.MkdirAll(dir, 0o750); err != nil {
|
|
||||||
t.Fatalf("mkdir: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := os.WriteFile(
|
|
||||||
filepath.Join(dir, "01 Intro.flac"), []byte(disc), 0o600,
|
|
||||||
); err != nil {
|
|
||||||
t.Fatalf("write: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
dst := t.TempDir()
|
|
||||||
|
|
||||||
got, err := s.collect(Candidate{Files: []CandidateFile{
|
|
||||||
{Path: `\m\Album\CD1\01 Intro.flac`, IsAudio: true},
|
|
||||||
{Path: `\m\Album\CD2\01 Intro.flac`, IsAudio: true},
|
|
||||||
}}, dst)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("collect: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(got.Files) != 2 {
|
|
||||||
t.Fatalf("collected %d files, want 2", len(got.Files))
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, disc := range []string{"CD1", "CD2"} {
|
|
||||||
data, err := os.ReadFile(filepath.Join(dst, disc, "01 Intro.flac"))
|
|
||||||
if err != nil || string(data) != disc {
|
|
||||||
t.Errorf("%s's file missing or overwritten: %q, %v", disc, data, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if hint := ParsePath(filepath.Join(dst, disc, "01 Intro.flac")); hint.Disc == 0 {
|
|
||||||
t.Errorf("staged %s file lost its disc number", disc)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// A two-disc release whose discs both number from 01 aligns completely
|
|
||||||
// once the disc comes from the folder; before, disc 2's 01 collided with
|
|
||||||
// disc 1's.
|
|
||||||
func TestMultiDiscCandidateAlignsEveryTrack(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
dl := Download{
|
|
||||||
ReleaseMBID: "the-wall",
|
|
||||||
Artist: "Pink Floyd",
|
|
||||||
Album: "The Wall",
|
|
||||||
Expected: []ExpectedTrack{
|
|
||||||
{DiscNumber: 1, Position: 1, Title: "In the Flesh?"},
|
|
||||||
{DiscNumber: 1, Position: 2, Title: "The Thin Ice"},
|
|
||||||
{DiscNumber: 2, Position: 1, Title: "Hey You"},
|
|
||||||
{DiscNumber: 2, Position: 2, Title: "Is There Anybody Out There?"},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
c := Candidate{
|
|
||||||
Title: "The Wall",
|
|
||||||
Files: []CandidateFile{
|
|
||||||
{Path: `\m\Pink Floyd - The Wall\CD1\01 In the Flesh.flac`, Size: 1},
|
|
||||||
{Path: `\m\Pink Floyd - The Wall\CD1\02 The Thin Ice.flac`, Size: 1},
|
|
||||||
{Path: `\m\Pink Floyd - The Wall\CD2\01 Hey You.flac`, Size: 1},
|
|
||||||
{Path: `\m\Pink Floyd - The Wall\CD2\02 Is There Anybody Out There.flac`, Size: 1},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
got := Score(dl, c, 50, AutoDownloadPrefs{})
|
|
||||||
|
|
||||||
if got.Match.Completeness != 1 {
|
|
||||||
t.Errorf("completeness = %f, want 1", got.Match.Completeness)
|
|
||||||
}
|
|
||||||
|
|
||||||
if got.Match.AlbumFit < 0.99 {
|
|
||||||
t.Errorf("album fit = %f, want the album's own name to match", got.Match.AlbumFit)
|
|
||||||
}
|
|
||||||
|
|
||||||
if got.Match.Overall < minMatch {
|
|
||||||
t.Errorf("match = %f, want it to clear the auto-pick bar %f", got.Match.Overall, minMatch)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Ten files against a ten-track album is not a complete album when only
|
|
||||||
// three of them are its tracks.
|
|
||||||
func TestCompletenessCountsTracksNotFiles(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
dl := okComputer()
|
|
||||||
|
|
||||||
c := Candidate{Title: "OK Computer", Files: []CandidateFile{
|
|
||||||
{Path: `\m\Radiohead - OK Computer\Airbag.flac`, Size: 1},
|
|
||||||
{Path: `\m\Radiohead - OK Computer\Paranoid Android.flac`, Size: 1},
|
|
||||||
{Path: `\m\Radiohead - OK Computer\Exit Music (For a Film).flac`, Size: 1},
|
|
||||||
{Path: `\m\Radiohead - OK Computer\Creep.flac`, Size: 1},
|
|
||||||
}}
|
|
||||||
|
|
||||||
got := Score(dl, c, 50, AutoDownloadPrefs{})
|
|
||||||
|
|
||||||
if got.Match.Completeness > 0.76 {
|
|
||||||
t.Errorf(
|
|
||||||
"completeness = %f with 3 of 4 tracks present, want at most 0.75",
|
|
||||||
got.Match.Completeness,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -47,7 +47,7 @@ func grabAll(
|
|||||||
go func() {
|
go func() {
|
||||||
defer wg.Done()
|
defer wg.Done()
|
||||||
|
|
||||||
f.manager.grab(ctx, dl, candidate, nil, false)
|
f.manager.grab(ctx, dl, candidate, nil)
|
||||||
}()
|
}()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,261 +0,0 @@
|
|||||||
package download
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"os"
|
|
||||||
"testing"
|
|
||||||
)
|
|
||||||
|
|
||||||
// A transfer that fails on one copy of an album is not a failed
|
|
||||||
// download while another acceptable copy exists. On Soulseek the usual
|
|
||||||
// failure is one peer being offline, with several others offering the
|
|
||||||
// same folder.
|
|
||||||
|
|
||||||
var errPeerOffline = errors.New("peer went offline")
|
|
||||||
|
|
||||||
func TestManagerFallsBackToTheNextCandidate(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
f := newManagerFixture(t)
|
|
||||||
|
|
||||||
// The failing source ranks first on priority, so the fallback is
|
|
||||||
// what reaches the one that works.
|
|
||||||
bad := fakeWithAlbum(1, "offline-peer", ".flac")
|
|
||||||
bad.GrabErr = errPeerOffline
|
|
||||||
good := fakeWithAlbum(2, "online-peer", ".flac")
|
|
||||||
|
|
||||||
f.manager.installProvider(Config{ID: 1, Priority: 90}, bad)
|
|
||||||
f.manager.installProvider(Config{ID: 2, Priority: 10}, good)
|
|
||||||
|
|
||||||
dl := fourTrackDownload()
|
|
||||||
|
|
||||||
if _, err := f.manager.Start(context.Background(), dl); err != nil {
|
|
||||||
t.Fatalf("Start: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
waitForDownloadState(t, f.store, dl.ID, StateComplete)
|
|
||||||
|
|
||||||
if bad.GrabCalls != 1 || good.GrabCalls != 1 {
|
|
||||||
t.Errorf(
|
|
||||||
"grabs: failing=%d working=%d, want 1 and 1",
|
|
||||||
bad.GrabCalls, good.GrabCalls,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
// The abandoned attempt's staging goes with it; only a request that
|
|
||||||
// fails outright keeps its staging for inspection.
|
|
||||||
waitFor(t, func() bool {
|
|
||||||
entries, err := os.ReadDir(f.staging.Root())
|
|
||||||
|
|
||||||
return err == nil && len(entries) == 0
|
|
||||||
}, "the failed attempt's staging was never released")
|
|
||||||
}
|
|
||||||
|
|
||||||
// Falling back must not lower the bar. A second choice outside the
|
|
||||||
// user's guardrails is not a choice auto-pick may make, first or second.
|
|
||||||
func TestManagerFallbackRespectsTheGuardrails(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
f := newManagerFixture(t)
|
|
||||||
f.manager.SetPreferences(AutoDownloadPrefs{MaxSizeMB: 50})
|
|
||||||
|
|
||||||
bad := fakeWithAlbum(1, "offline-peer", ".flac")
|
|
||||||
bad.GrabErr = errPeerOffline
|
|
||||||
bad.Candidates[0].TotalSize = 40 << 20
|
|
||||||
|
|
||||||
huge := fakeWithAlbum(2, "oversized", ".flac")
|
|
||||||
huge.Candidates[0].TotalSize = 900 << 20
|
|
||||||
|
|
||||||
f.manager.installProvider(Config{ID: 1, Priority: 90}, bad)
|
|
||||||
f.manager.installProvider(Config{ID: 2, Priority: 10}, huge)
|
|
||||||
|
|
||||||
dl := fourTrackDownload()
|
|
||||||
|
|
||||||
if _, err := f.manager.Start(context.Background(), dl); err != nil {
|
|
||||||
t.Fatalf("Start: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
waitForDownloadState(t, f.store, dl.ID, StateFailed)
|
|
||||||
|
|
||||||
if huge.GrabCalls != 0 {
|
|
||||||
t.Errorf("fell back to a candidate over the size ceiling")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// A copy the user picked by hand is the copy they asked for. Quietly
|
|
||||||
// substituting another is a decision they did not make.
|
|
||||||
func TestManagerPickDoesNotFallBack(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
f := newManagerFixture(t)
|
|
||||||
|
|
||||||
bad := fakeWithAlbum(1, "offline-peer", ".flac")
|
|
||||||
bad.GrabErr = errPeerOffline
|
|
||||||
good := fakeWithAlbum(2, "online-peer", ".flac")
|
|
||||||
|
|
||||||
f.manager.installProvider(Config{ID: 1, Priority: 90}, bad)
|
|
||||||
f.manager.installProvider(Config{ID: 2, Priority: 10}, good)
|
|
||||||
|
|
||||||
// A ceiling below both copies parks the result set for the user.
|
|
||||||
f.manager.SetPreferences(AutoDownloadPrefs{MaxSizeMB: 1})
|
|
||||||
|
|
||||||
bad.Candidates[0].TotalSize = 30 << 20
|
|
||||||
good.Candidates[0].TotalSize = 30 << 20
|
|
||||||
|
|
||||||
dl := fourTrackDownload()
|
|
||||||
|
|
||||||
if _, err := f.manager.Start(context.Background(), dl); err != nil {
|
|
||||||
t.Fatalf("Start: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := f.manager.Pick(
|
|
||||||
context.Background(), dl.ID, "offline-peer-cand",
|
|
||||||
); err != nil {
|
|
||||||
t.Fatalf("Pick: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
waitForDownloadState(t, f.store, dl.ID, StateFailed)
|
|
||||||
|
|
||||||
if good.GrabCalls != 0 {
|
|
||||||
t.Errorf("a hand-picked grab fell back to another candidate")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Fallback is for surviving an offline peer or two, not for walking a
|
|
||||||
// forty-peer list for six hours.
|
|
||||||
func TestManagerFallbackIsBounded(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
f := newManagerFixture(t)
|
|
||||||
|
|
||||||
var providers []*FakeProvider
|
|
||||||
|
|
||||||
for i := int64(1); i <= maxGrabAttempts+2; i++ {
|
|
||||||
p := fakeWithAlbum(i, "peer-"+itoa(int(i)), ".flac")
|
|
||||||
p.GrabErr = errPeerOffline
|
|
||||||
|
|
||||||
f.manager.installProvider(Config{ID: i, Priority: 50}, p)
|
|
||||||
providers = append(providers, p)
|
|
||||||
}
|
|
||||||
|
|
||||||
dl := fourTrackDownload()
|
|
||||||
|
|
||||||
if _, err := f.manager.Start(context.Background(), dl); err != nil {
|
|
||||||
t.Fatalf("Start: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
waitForDownloadState(t, f.store, dl.ID, StateFailed)
|
|
||||||
|
|
||||||
grabs := 0
|
|
||||||
for _, p := range providers {
|
|
||||||
grabs += p.GrabCalls
|
|
||||||
}
|
|
||||||
|
|
||||||
if grabs != maxGrabAttempts {
|
|
||||||
t.Errorf("grabs = %d, want %d", grabs, maxGrabAttempts)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// The veto judges the best candidate *inside* the guardrails, so the
|
|
||||||
// grab has to take that one — not the overall best, which may be the
|
|
||||||
// very copy the user said not to take unattended.
|
|
||||||
func TestManagerAutoPickTakesTheBestEligibleCandidate(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
f := newManagerFixture(t)
|
|
||||||
f.manager.SetPreferences(AutoDownloadPrefs{MaxSizeMB: 50})
|
|
||||||
|
|
||||||
huge := fakeWithAlbum(1, "oversized", ".flac")
|
|
||||||
huge.Candidates[0].TotalSize = 900 << 20
|
|
||||||
|
|
||||||
fits := fakeWithAlbum(2, "fits", ".flac")
|
|
||||||
fits.Candidates[0].TotalSize = 40 << 20
|
|
||||||
|
|
||||||
f.manager.installProvider(Config{ID: 1, Priority: 90}, huge)
|
|
||||||
f.manager.installProvider(Config{ID: 2, Priority: 10}, fits)
|
|
||||||
|
|
||||||
dl := fourTrackDownload()
|
|
||||||
|
|
||||||
ranked, err := f.manager.Start(context.Background(), dl)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Start: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if ranked[0].ID != "oversized-cand" {
|
|
||||||
t.Fatalf("fixture: best overall is %s, want the oversized copy", ranked[0].ID)
|
|
||||||
}
|
|
||||||
|
|
||||||
waitForDownloadState(t, f.store, dl.ID, StateComplete)
|
|
||||||
|
|
||||||
if huge.GrabCalls != 0 || fits.GrabCalls != 1 {
|
|
||||||
t.Errorf(
|
|
||||||
"grabs: oversized=%d fits=%d, want 0 and 1",
|
|
||||||
huge.GrabCalls, fits.GrabCalls,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// On Soulseek a failure is the peer's, so every folder that peer offered
|
|
||||||
// goes with it. Elsewhere a failure is the release's, and one indexer's
|
|
||||||
// other releases are still worth trying.
|
|
||||||
func TestRuledOutBy(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
failed := []Candidate{
|
|
||||||
{ID: "slskd:alice:Album", Kind: KindSlskd, ProviderID: 1, Origin: "alice"},
|
|
||||||
{ID: "tracker-1", Kind: KindProwlarr, ProviderID: 2, Origin: "indexer"},
|
|
||||||
}
|
|
||||||
|
|
||||||
cases := []struct {
|
|
||||||
name string
|
|
||||||
c Candidate
|
|
||||||
want bool
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
name: "the same candidate",
|
|
||||||
c: Candidate{ID: "tracker-1", Kind: KindProwlarr, ProviderID: 2, Origin: "indexer"},
|
|
||||||
want: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "another folder from a failed peer",
|
|
||||||
c: Candidate{
|
|
||||||
ID: "slskd:alice:Album (2)",
|
|
||||||
Kind: KindSlskd,
|
|
||||||
ProviderID: 1,
|
|
||||||
Origin: "alice",
|
|
||||||
},
|
|
||||||
want: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "another peer",
|
|
||||||
c: Candidate{ID: "slskd:bob:Album", Kind: KindSlskd, ProviderID: 1, Origin: "bob"},
|
|
||||||
want: false,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "another release from the same indexer",
|
|
||||||
c: Candidate{ID: "tracker-2", Kind: KindProwlarr, ProviderID: 2, Origin: "indexer"},
|
|
||||||
want: false,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "a peer of the same name on a different daemon",
|
|
||||||
c: Candidate{
|
|
||||||
ID: "slskd:alice:Album",
|
|
||||||
Kind: KindSlskd,
|
|
||||||
ProviderID: 3,
|
|
||||||
Origin: "alice",
|
|
||||||
},
|
|
||||||
want: false,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range cases {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
if got := ruledOutBy(tc.c, failed); got != tc.want {
|
|
||||||
t.Errorf("ruledOutBy = %v, want %v", got, tc.want)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
+59
-206
@@ -577,12 +577,12 @@ func (m *Manager) Start(
|
|||||||
))
|
))
|
||||||
}
|
}
|
||||||
|
|
||||||
if pick, ok := autoPick(dl, ranked, m.preferences()); ok {
|
if m.AutoPickable(dl, ranked) {
|
||||||
if job != nil {
|
if job != nil {
|
||||||
job.Logf(jobs.LevelInfo, "Auto-selected best candidate")
|
job.Logf(jobs.LevelInfo, "Auto-selected best candidate")
|
||||||
}
|
}
|
||||||
|
|
||||||
go m.grab(context.WithoutCancel(ctx), dl, pick, job, true)
|
go m.grab(context.WithoutCancel(ctx), dl, ranked[0], job)
|
||||||
|
|
||||||
return ranked, nil
|
return ranked, nil
|
||||||
}
|
}
|
||||||
@@ -622,13 +622,6 @@ func (m *Manager) Attempt(
|
|||||||
return false, veto, nil
|
return false, veto, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
pick, ok := autoPick(dl, ranked, m.preferences())
|
|
||||||
if !ok {
|
|
||||||
// Unreachable while autoPick and AutoPickVeto agree; kept so a
|
|
||||||
// future divergence refuses rather than grabbing blind.
|
|
||||||
return false, "no candidate clears the auto-download bar", nil
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := m.store.CreateDownload(ctx, dl); err != nil {
|
if err := m.store.CreateDownload(ctx, dl); err != nil {
|
||||||
return false, "", err
|
return false, "", err
|
||||||
}
|
}
|
||||||
@@ -650,7 +643,7 @@ func (m *Manager) Attempt(
|
|||||||
))
|
))
|
||||||
}
|
}
|
||||||
|
|
||||||
go m.grab(context.WithoutCancel(ctx), dl, pick, job, true)
|
go m.grab(context.WithoutCancel(ctx), dl, ranked[0], job)
|
||||||
|
|
||||||
return true, "", nil
|
return true, "", nil
|
||||||
}
|
}
|
||||||
@@ -685,7 +678,7 @@ func (m *Manager) Pick(
|
|||||||
|
|
||||||
job := m.startJob(dl)
|
job := m.startJob(dl)
|
||||||
|
|
||||||
go m.grab(context.WithoutCancel(ctx), dl, *chosen, job, false)
|
go m.grab(context.WithoutCancel(ctx), dl, *chosen, job)
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -709,20 +702,13 @@ func (m *Manager) Cancel(ctx context.Context, downloadID string) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// grab drives one request all the way to the library. It runs on its
|
// grab drives one candidate all the way to the library. It runs on its
|
||||||
// own goroutine and owns the job from here on.
|
// own goroutine and owns the job from here on.
|
||||||
//
|
|
||||||
// When fallback is set and a candidate's transfer fails, the next
|
|
||||||
// candidate that auto-pick would itself have accepted is tried in its
|
|
||||||
// place (see nextCandidate). It is set for the two unattended routes
|
|
||||||
// and not for a candidate the user picked by hand: they chose that copy,
|
|
||||||
// and quietly substituting another is a decision they did not make.
|
|
||||||
func (m *Manager) grab(
|
func (m *Manager) grab(
|
||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
dl Download,
|
dl Download,
|
||||||
c Candidate,
|
c Candidate,
|
||||||
job *jobs.Handle,
|
job *jobs.Handle,
|
||||||
fallback bool,
|
|
||||||
) {
|
) {
|
||||||
ctx, cancel := context.WithTimeout(ctx, grabTimeout)
|
ctx, cancel := context.WithTimeout(ctx, grabTimeout)
|
||||||
defer cancel()
|
defer cancel()
|
||||||
@@ -737,82 +723,6 @@ func (m *Manager) grab(
|
|||||||
m.actMu.Unlock()
|
m.actMu.Unlock()
|
||||||
}()
|
}()
|
||||||
|
|
||||||
var failed []Candidate
|
|
||||||
|
|
||||||
for {
|
|
||||||
out := m.attemptGrab(ctx, dl, c, job)
|
|
||||||
if out.err == nil {
|
|
||||||
m.finishGrab(ctx, dl, out.item, out.imported, job)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
failed = append(failed, c)
|
|
||||||
|
|
||||||
next, ok := m.nextCandidate(ctx, dl, failed, out, fallback)
|
|
||||||
if !ok {
|
|
||||||
m.failDownload(ctx, job, dl.ID, out.err)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
m.logger.Info(
|
|
||||||
"download candidate failed; trying the next",
|
|
||||||
"download", dl.ID,
|
|
||||||
"failed", c.ID,
|
|
||||||
"next", next.ID,
|
|
||||||
"error", out.err,
|
|
||||||
)
|
|
||||||
|
|
||||||
if job != nil {
|
|
||||||
job.Logf(jobs.LevelWarn, fmt.Sprintf(
|
|
||||||
"%s failed (%v); trying %s instead",
|
|
||||||
describeCandidate(c), out.err, describeCandidate(next),
|
|
||||||
))
|
|
||||||
}
|
|
||||||
|
|
||||||
// The failed attempt's staging holds at most a partial folder
|
|
||||||
// nobody is going to import, and the next attempt reserves its
|
|
||||||
// own. Only the final failure keeps its staging for inspection.
|
|
||||||
if out.item.StagingDir != "" {
|
|
||||||
if err := m.staging.Release(out.item.StagingDir); err != nil {
|
|
||||||
m.logger.Warn("could not release staging dir", "error", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
c = next
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// maxGrabAttempts bounds how many candidates one request will try. A
|
|
||||||
// popular album can have dozens of peers; the point of falling back is
|
|
||||||
// to survive the ordinary one or two that are offline, not to walk the
|
|
||||||
// whole list for six hours.
|
|
||||||
const maxGrabAttempts = 3
|
|
||||||
|
|
||||||
// grabOutcome is how one candidate's attempt ended.
|
|
||||||
type grabOutcome struct {
|
|
||||||
item DownloadItem
|
|
||||||
imported ImportResult
|
|
||||||
err error
|
|
||||||
|
|
||||||
// retryable reports whether another candidate might succeed where
|
|
||||||
// this one failed: the transfer failed, or delivered too little of
|
|
||||||
// the album. Anything else — no staging space, no library root, a
|
|
||||||
// tag write failing — would fail the next candidate identically.
|
|
||||||
retryable bool
|
|
||||||
}
|
|
||||||
|
|
||||||
// attemptGrab takes one candidate through transfer and import. It
|
|
||||||
// records the item's own failure, but not the download's: whether the
|
|
||||||
// download has failed is the caller's decision, since another candidate
|
|
||||||
// may yet succeed.
|
|
||||||
func (m *Manager) attemptGrab(
|
|
||||||
ctx context.Context,
|
|
||||||
dl Download,
|
|
||||||
c Candidate,
|
|
||||||
job *jobs.Handle,
|
|
||||||
) grabOutcome {
|
|
||||||
// Who will move the bytes is decided before any slot is taken, so
|
// Who will move the bytes is decided before any slot is taken, so
|
||||||
// the transfer waits in its own provider's queue rather than in a
|
// the transfer waits in its own provider's queue rather than in a
|
||||||
// global one. A delegate takes no slot at all: the transfer is
|
// global one. A delegate takes no slot at all: the transfer is
|
||||||
@@ -821,7 +731,9 @@ func (m *Manager) attemptGrab(
|
|||||||
// work against our budget.
|
// work against our budget.
|
||||||
plan, err := m.planTransfer(dl, c)
|
plan, err := m.planTransfer(dl, c)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return grabOutcome{err: err}
|
m.failDownload(ctx, job, dl.ID, err)
|
||||||
|
|
||||||
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
if !plan.delegated() {
|
if !plan.delegated() {
|
||||||
@@ -831,7 +743,9 @@ func (m *Manager) attemptGrab(
|
|||||||
case provSem <- struct{}{}:
|
case provSem <- struct{}{}:
|
||||||
defer func() { <-provSem }()
|
defer func() { <-provSem }()
|
||||||
case <-ctx.Done():
|
case <-ctx.Done():
|
||||||
return grabOutcome{err: ctx.Err()}
|
m.failDownload(ctx, job, dl.ID, ctx.Err())
|
||||||
|
|
||||||
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
globalSem := m.globalSem()
|
globalSem := m.globalSem()
|
||||||
@@ -840,7 +754,9 @@ func (m *Manager) attemptGrab(
|
|||||||
case globalSem <- struct{}{}:
|
case globalSem <- struct{}{}:
|
||||||
defer func() { <-globalSem }()
|
defer func() { <-globalSem }()
|
||||||
case <-ctx.Done():
|
case <-ctx.Done():
|
||||||
return grabOutcome{err: ctx.Err()}
|
m.failDownload(ctx, job, dl.ID, ctx.Err())
|
||||||
|
|
||||||
|
return
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -855,30 +771,24 @@ func (m *Manager) attemptGrab(
|
|||||||
|
|
||||||
dir, err := m.staging.Reserve(item.ID)
|
dir, err := m.staging.Reserve(item.ID)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return grabOutcome{err: err}
|
m.failDownload(ctx, job, dl.ID, err)
|
||||||
|
|
||||||
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
item.StagingDir = dir
|
item.StagingDir = dir
|
||||||
|
|
||||||
if err := m.store.CreateItem(ctx, item); err != nil {
|
if err := m.store.CreateItem(ctx, item); err != nil {
|
||||||
return grabOutcome{item: item, err: err}
|
m.failDownload(ctx, job, dl.ID, err)
|
||||||
}
|
|
||||||
|
|
||||||
fail := func(err error, retryable bool) grabOutcome {
|
return
|
||||||
if serr := m.store.SetItemState(
|
|
||||||
ctx, item.ID, StateFailed, err.Error(),
|
|
||||||
); serr != nil {
|
|
||||||
m.logger.Warn("could not record item failure", "error", serr)
|
|
||||||
}
|
|
||||||
|
|
||||||
return grabOutcome{item: item, err: err, retryable: retryable}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
result, err := m.transfer(ctx, dl, item, plan, job)
|
result, err := m.transfer(ctx, dl, item, plan, job)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
// A delegate's failure is the external manager's verdict on the
|
m.failItem(ctx, job, item, dl.ID, err)
|
||||||
// whole request, not on one copy of it.
|
|
||||||
return fail(err, !plan.delegated())
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
m.setStates(ctx, dl.ID, item.ID, StateImporting)
|
m.setStates(ctx, dl.ID, item.ID, StateImporting)
|
||||||
@@ -888,116 +798,42 @@ func (m *Manager) attemptGrab(
|
|||||||
job.SetStages(importStages(2))
|
job.SetStages(importStages(2))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
var imported ImportResult
|
||||||
|
|
||||||
if result.Delegated {
|
if result.Delegated {
|
||||||
// The external manager already placed and tagged these files in
|
// The external manager already placed and tagged these files in
|
||||||
// its own library. Moving them out from under a system that is
|
// its own library. Moving them out from under a system that is
|
||||||
// still managing them would be worse than useless, so the files
|
// still managing them would be worse than useless, so the files
|
||||||
// are recorded where they are and the library scan picks them
|
// are recorded where they are and the library scan picks them
|
||||||
// up in place.
|
// up in place.
|
||||||
|
imported = ImportResult{Paths: result.Files}
|
||||||
|
|
||||||
if job != nil {
|
if job != nil {
|
||||||
job.Logf(jobs.LevelInfo, fmt.Sprintf(
|
job.Logf(jobs.LevelInfo, fmt.Sprintf(
|
||||||
"External manager imported %d files; recording them in place",
|
"External manager imported %d files; recording them in place",
|
||||||
len(result.Files),
|
len(result.Files),
|
||||||
))
|
))
|
||||||
}
|
}
|
||||||
|
} else {
|
||||||
|
opts := m.importOptions()
|
||||||
|
opts.WriteTags = true
|
||||||
|
|
||||||
return grabOutcome{
|
opts.LibraryRoot, err = m.library.LibraryPath(dl.LibraryID)
|
||||||
item: item,
|
if err != nil {
|
||||||
imported: ImportResult{Paths: result.Files},
|
m.failItem(ctx, job, item, dl.ID,
|
||||||
|
fmt.Errorf("resolve library root: %w", err))
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
imported, err = m.importer.Import(ctx, dl, result, opts)
|
||||||
|
if err != nil {
|
||||||
|
m.failItem(ctx, job, item, dl.ID, err)
|
||||||
|
|
||||||
|
return
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
opts := m.importOptions()
|
|
||||||
opts.WriteTags = true
|
|
||||||
|
|
||||||
opts.LibraryRoot, err = m.library.LibraryPath(dl.LibraryID)
|
|
||||||
if err != nil {
|
|
||||||
return fail(fmt.Errorf("resolve library root: %w", err), false)
|
|
||||||
}
|
|
||||||
|
|
||||||
imported, err := m.importer.Import(ctx, dl, result, opts)
|
|
||||||
if err != nil {
|
|
||||||
return fail(err, errors.Is(err, ErrTooIncomplete))
|
|
||||||
}
|
|
||||||
|
|
||||||
return grabOutcome{item: item, imported: imported}
|
|
||||||
}
|
|
||||||
|
|
||||||
// nextCandidate picks the candidate to try after the ones in failed.
|
|
||||||
//
|
|
||||||
// It only ever offers a candidate auto-pick would have taken on its own
|
|
||||||
// (autoAcceptable), so falling back cannot lower the bar an unattended
|
|
||||||
// download is held to: the second choice has to clear the same gates
|
|
||||||
// the first did.
|
|
||||||
//
|
|
||||||
// On Soulseek a failure belongs to the *peer* — offline, refusing, or
|
|
||||||
// holding us in a queue — so every folder that peer offered is skipped
|
|
||||||
// with it. Elsewhere a failure belongs to the release, and only that
|
|
||||||
// candidate is.
|
|
||||||
func (m *Manager) nextCandidate(
|
|
||||||
ctx context.Context,
|
|
||||||
dl Download,
|
|
||||||
failed []Candidate,
|
|
||||||
out grabOutcome,
|
|
||||||
fallback bool,
|
|
||||||
) (Candidate, bool) {
|
|
||||||
if !fallback || !out.retryable || ctx.Err() != nil ||
|
|
||||||
len(failed) >= maxGrabAttempts {
|
|
||||||
return Candidate{}, false
|
|
||||||
}
|
|
||||||
|
|
||||||
m.resMu.RLock()
|
|
||||||
ranked := m.results[dl.ID]
|
|
||||||
m.resMu.RUnlock()
|
|
||||||
|
|
||||||
prefs := m.preferences()
|
|
||||||
|
|
||||||
for _, c := range ranked {
|
|
||||||
if ruledOutBy(c, failed) || !autoAcceptable(dl, c, prefs) {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
return c, true
|
|
||||||
}
|
|
||||||
|
|
||||||
return Candidate{}, false
|
|
||||||
}
|
|
||||||
|
|
||||||
// ruledOutBy reports whether a failure among failed also rules out c.
|
|
||||||
func ruledOutBy(c Candidate, failed []Candidate) bool {
|
|
||||||
for _, f := range failed {
|
|
||||||
if c.ID == f.ID && c.ProviderID == f.ProviderID {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
if c.Kind == KindSlskd && f.Kind == KindSlskd &&
|
|
||||||
c.ProviderID == f.ProviderID && c.Origin != "" &&
|
|
||||||
c.Origin == f.Origin {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
// describeCandidate names a candidate for the job log.
|
|
||||||
func describeCandidate(c Candidate) string {
|
|
||||||
if c.Origin != "" {
|
|
||||||
return fmt.Sprintf("%q from %s", c.Title, c.Origin)
|
|
||||||
}
|
|
||||||
|
|
||||||
return fmt.Sprintf("%q", c.Title)
|
|
||||||
}
|
|
||||||
|
|
||||||
// finishGrab records a successful import and retires what the request
|
|
||||||
// was holding.
|
|
||||||
func (m *Manager) finishGrab(
|
|
||||||
ctx context.Context,
|
|
||||||
dl Download,
|
|
||||||
item DownloadItem,
|
|
||||||
imported ImportResult,
|
|
||||||
job *jobs.Handle,
|
|
||||||
) {
|
|
||||||
if err := m.store.SetItemImported(
|
if err := m.store.SetItemImported(
|
||||||
ctx, item.ID, imported.Paths,
|
ctx, item.ID, imported.Paths,
|
||||||
); err != nil {
|
); err != nil {
|
||||||
@@ -1341,6 +1177,23 @@ func (m *Manager) failDownload(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// failItem records an item-level failure and fails its download.
|
||||||
|
func (m *Manager) failItem(
|
||||||
|
ctx context.Context,
|
||||||
|
job *jobs.Handle,
|
||||||
|
item DownloadItem,
|
||||||
|
downloadID string,
|
||||||
|
err error,
|
||||||
|
) {
|
||||||
|
if serr := m.store.SetItemState(
|
||||||
|
ctx, item.ID, StateFailed, err.Error(),
|
||||||
|
); serr != nil {
|
||||||
|
m.logger.Warn("could not record item failure", "error", serr)
|
||||||
|
}
|
||||||
|
|
||||||
|
m.failDownload(ctx, job, downloadID, err)
|
||||||
|
}
|
||||||
|
|
||||||
// startJob registers the request in the background jobs panel.
|
// startJob registers the request in the background jobs panel.
|
||||||
func (m *Manager) startJob(dl Download) *jobs.Handle {
|
func (m *Manager) startJob(dl Download) *jobs.Handle {
|
||||||
if m.jobsReg == nil {
|
if m.jobsReg == nil {
|
||||||
|
|||||||
@@ -66,14 +66,6 @@ var (
|
|||||||
|
|
||||||
// separatorPattern splits "Artist - Album" style folder names.
|
// separatorPattern splits "Artist - Album" style folder names.
|
||||||
separatorPattern = regexp.MustCompile(`\s+[-–—]\s+`)
|
separatorPattern = regexp.MustCompile(`\s+[-–—]\s+`)
|
||||||
|
|
||||||
// discFolderPattern matches a directory that holds one disc of an
|
|
||||||
// album rather than the album: "CD1", "CD 2", "Disc 3", "Disk-1",
|
|
||||||
// "[Disc 2]", "CD1 - The Early Years". A number is required, so a
|
|
||||||
// folder merely called "CDs" is not one.
|
|
||||||
discFolderPattern = regexp.MustCompile(
|
|
||||||
`(?i)^\s*[\[(]?\s*(?:cd|disc|disk)\s*[-_.#]?\s*(\d{1,2})\b`,
|
|
||||||
)
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// FormatForPath returns the audio format implied by a path's extension,
|
// FormatForPath returns the audio format implied by a path's extension,
|
||||||
@@ -102,63 +94,16 @@ type TrackHint struct {
|
|||||||
Folder string
|
Folder string
|
||||||
}
|
}
|
||||||
|
|
||||||
// discFolder reports whether a directory name is one disc of an album,
|
|
||||||
// and which.
|
|
||||||
func discFolder(name string) (int, bool) {
|
|
||||||
m := discFolderPattern.FindStringSubmatch(name)
|
|
||||||
if m == nil {
|
|
||||||
return 0, false
|
|
||||||
}
|
|
||||||
|
|
||||||
n, err := strconv.Atoi(m[1])
|
|
||||||
if err != nil || n == 0 {
|
|
||||||
return 0, false
|
|
||||||
}
|
|
||||||
|
|
||||||
return n, true
|
|
||||||
}
|
|
||||||
|
|
||||||
// AlbumDir is the directory that holds a file's *album*: its parent,
|
|
||||||
// or its grandparent when the parent is a disc folder.
|
|
||||||
//
|
|
||||||
// Multi-disc rips are shared as `Album/CD1/…` and `Album/CD2/…`, and
|
|
||||||
// grouping candidates by the immediate parent split one album into two
|
|
||||||
// half-albums, each titled "CD1". Neither could clear the completeness
|
|
||||||
// or album-title bars, so a multi-disc release could not be auto-picked
|
|
||||||
// at all. A disc folder at the root has no album above it and is
|
|
||||||
// returned as it is.
|
|
||||||
func AlbumDir(p string) string {
|
|
||||||
dir := path.Dir(strings.ReplaceAll(p, `\`, "/"))
|
|
||||||
|
|
||||||
if _, ok := discFolder(path.Base(dir)); !ok {
|
|
||||||
return dir
|
|
||||||
}
|
|
||||||
|
|
||||||
parent := path.Dir(dir)
|
|
||||||
if parent == "." || parent == "/" || parent == "" {
|
|
||||||
return dir
|
|
||||||
}
|
|
||||||
|
|
||||||
return parent
|
|
||||||
}
|
|
||||||
|
|
||||||
// ParsePath extracts what it can from one candidate file path.
|
// ParsePath extracts what it can from one candidate file path.
|
||||||
func ParsePath(p string) TrackHint {
|
func ParsePath(p string) TrackHint {
|
||||||
// Soulseek paths are Windows-style; normalize before splitting.
|
// Soulseek paths are Windows-style; normalize before splitting.
|
||||||
norm := strings.ReplaceAll(p, `\`, "/")
|
norm := strings.ReplaceAll(p, `\`, "/")
|
||||||
base := path.Base(norm)
|
base := path.Base(norm)
|
||||||
|
folder := path.Base(path.Dir(norm))
|
||||||
|
|
||||||
name := strings.TrimSuffix(base, path.Ext(base))
|
name := strings.TrimSuffix(base, path.Ext(base))
|
||||||
|
|
||||||
// The album's name is the album directory's, not a disc folder's,
|
hint := TrackHint{Folder: cleanAlbumName(folder)}
|
||||||
// and the disc folder is where a multi-disc rip says which disc a
|
|
||||||
// file is on. A disc number in the filename ("2-01 …") is more
|
|
||||||
// specific and overrides it below.
|
|
||||||
hint := TrackHint{Folder: cleanAlbumName(path.Base(AlbumDir(norm)))}
|
|
||||||
|
|
||||||
if disc, ok := discFolder(path.Base(path.Dir(norm))); ok {
|
|
||||||
hint.Disc = disc
|
|
||||||
}
|
|
||||||
|
|
||||||
if m := trackNumPattern.FindStringSubmatch(name); m != nil {
|
if m := trackNumPattern.FindStringSubmatch(name); m != nil {
|
||||||
if m[1] != "" {
|
if m[1] != "" {
|
||||||
@@ -258,72 +203,21 @@ func AnnotateFiles(files []CandidateFile) []CandidateFile {
|
|||||||
|
|
||||||
// matchFiles aligns a candidate's audio files to the expected tracklist
|
// matchFiles aligns a candidate's audio files to the expected tracklist
|
||||||
// and returns the per-file assignment plus the mean title similarity of
|
// and returns the per-file assignment plus the mean title similarity of
|
||||||
// the aligned pairs. alignFiles is the same alignment with the
|
// the aligned pairs.
|
||||||
// duration evidence as well.
|
|
||||||
func matchFiles(
|
|
||||||
files []CandidateFile,
|
|
||||||
expected []ExpectedTrack,
|
|
||||||
) ([]CandidateFile, float64) {
|
|
||||||
a := alignFiles(files, expected)
|
|
||||||
|
|
||||||
return a.files, a.titleFit
|
|
||||||
}
|
|
||||||
|
|
||||||
// alignment is what aligning a candidate to a tracklist found.
|
|
||||||
type alignment struct {
|
|
||||||
files []CandidateFile
|
|
||||||
|
|
||||||
// titleFit is the mean title similarity over aligned pairs.
|
|
||||||
titleFit float64
|
|
||||||
|
|
||||||
// durationFit is the mean duration agreement over aligned pairs
|
|
||||||
// where both sides state a length, and timedPairs is how many such
|
|
||||||
// pairs there were.
|
|
||||||
durationFit float64
|
|
||||||
timedPairs int
|
|
||||||
aligned int
|
|
||||||
}
|
|
||||||
|
|
||||||
// durationAgreement scores how well a file's length matches the
|
|
||||||
// expected track's, in 0..1. Rips of the same master differ by a
|
|
||||||
// second or two of silence; a different edit, a live take or a
|
|
||||||
// truncated file differs by tens of seconds.
|
|
||||||
func durationAgreement(got, want int64) float64 {
|
|
||||||
const (
|
|
||||||
exactMillis = 3_000
|
|
||||||
wrongMillis = 30_000
|
|
||||||
)
|
|
||||||
|
|
||||||
d := got - want
|
|
||||||
if d < 0 {
|
|
||||||
d = -d
|
|
||||||
}
|
|
||||||
|
|
||||||
switch {
|
|
||||||
case d <= exactMillis:
|
|
||||||
return 1
|
|
||||||
case d >= wrongMillis:
|
|
||||||
return 0
|
|
||||||
default:
|
|
||||||
return 1 - float64(d-exactMillis)/float64(wrongMillis-exactMillis)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// alignFiles aligns a candidate's audio files to the expected tracklist.
|
|
||||||
//
|
//
|
||||||
// Alignment is greedy by score rather than optimal: candidate folders
|
// Alignment is greedy by score rather than optimal: candidate folders
|
||||||
// are small (a few dozen files at most) and the common cases — correct
|
// are small (a few dozen files at most) and the common cases — correct
|
||||||
// track numbers, or clean "NN Title" names — are unambiguous, so the
|
// track numbers, or clean "NN Title" names — are unambiguous, so the
|
||||||
// extra machinery of Hungarian assignment buys nothing here.
|
// extra machinery of Hungarian assignment buys nothing here.
|
||||||
func alignFiles(
|
func matchFiles(
|
||||||
files []CandidateFile,
|
files []CandidateFile,
|
||||||
expected []ExpectedTrack,
|
expected []ExpectedTrack,
|
||||||
) alignment {
|
) ([]CandidateFile, float64) {
|
||||||
annotated := make([]CandidateFile, len(files))
|
annotated := make([]CandidateFile, len(files))
|
||||||
copy(annotated, files)
|
copy(annotated, files)
|
||||||
|
|
||||||
if len(expected) == 0 {
|
if len(expected) == 0 {
|
||||||
return alignment{files: annotated}
|
return annotated, 0
|
||||||
}
|
}
|
||||||
|
|
||||||
hints := make([]TrackHint, len(annotated))
|
hints := make([]TrackHint, len(annotated))
|
||||||
@@ -336,19 +230,8 @@ func alignFiles(
|
|||||||
var (
|
var (
|
||||||
total float64
|
total float64
|
||||||
matched int
|
matched int
|
||||||
|
|
||||||
durTotal float64
|
|
||||||
timed int
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// timing adds a pair's duration evidence when both sides state one.
|
|
||||||
timing := func(f CandidateFile, e ExpectedTrack) {
|
|
||||||
if f.LengthMillis > 0 && e.LengthMillis > 0 {
|
|
||||||
durTotal += durationAgreement(f.LengthMillis, e.LengthMillis)
|
|
||||||
timed++
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Pass 1: trust explicit track numbers when they are unique and in
|
// Pass 1: trust explicit track numbers when they are unique and in
|
||||||
// range. A folder that numbers its files correctly is the strong
|
// range. A folder that numbers its files correctly is the strong
|
||||||
// case, and title comparison only adds noise there.
|
// case, and title comparison only adds noise there.
|
||||||
@@ -367,8 +250,6 @@ func alignFiles(
|
|||||||
|
|
||||||
total += autotag.TitleSimilarity(hints[i].Title, expected[idx].Title)
|
total += autotag.TitleSimilarity(hints[i].Title, expected[idx].Title)
|
||||||
matched++
|
matched++
|
||||||
|
|
||||||
timing(annotated[i], expected[idx])
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Pass 2: title similarity for whatever is left.
|
// Pass 2: title similarity for whatever is left.
|
||||||
@@ -403,26 +284,13 @@ func alignFiles(
|
|||||||
|
|
||||||
total += bestSim
|
total += bestSim
|
||||||
matched++
|
matched++
|
||||||
|
|
||||||
timing(annotated[i], expected[bestIdx])
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if matched == 0 {
|
if matched == 0 {
|
||||||
return alignment{files: annotated}
|
return annotated, 0
|
||||||
}
|
}
|
||||||
|
|
||||||
a := alignment{
|
return annotated, total / float64(matched)
|
||||||
files: annotated,
|
|
||||||
titleFit: total / float64(matched),
|
|
||||||
timedPairs: timed,
|
|
||||||
aligned: matched,
|
|
||||||
}
|
|
||||||
|
|
||||||
if timed > 0 {
|
|
||||||
a.durationFit = durTotal / float64(timed)
|
|
||||||
}
|
|
||||||
|
|
||||||
return a
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// indexForPosition finds the expected track at a disc/track position.
|
// indexForPosition finds the expected track at a disc/track position.
|
||||||
|
|||||||
@@ -5,11 +5,9 @@ import (
|
|||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"net/url"
|
|
||||||
"os"
|
"os"
|
||||||
"path"
|
"path"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"regexp"
|
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
@@ -71,34 +69,12 @@ const (
|
|||||||
slskdTransferPoll = 3 * time.Second
|
slskdTransferPoll = 3 * time.Second
|
||||||
|
|
||||||
// slskdMinFiles is the fewest audio files a folder needs before it
|
// slskdMinFiles is the fewest audio files a folder needs before it
|
||||||
// is offered as a candidate for an album. Soulseek returns a lot of
|
// is offered as a candidate. Soulseek returns a lot of one-file
|
||||||
// one-file noise for common queries. A single-track request takes
|
// noise for common queries.
|
||||||
// one (see minFilesFor).
|
|
||||||
slskdMinFiles = 2
|
slskdMinFiles = 2
|
||||||
|
|
||||||
// slskdHTTPTimeout bounds one API call.
|
// slskdHTTPTimeout bounds one API call.
|
||||||
slskdHTTPTimeout = 20 * time.Second
|
slskdHTTPTimeout = 20 * time.Second
|
||||||
|
|
||||||
// millisPerSecond converts slskd's whole-second file lengths.
|
|
||||||
millisPerSecond = 1000
|
|
||||||
|
|
||||||
// slskdStallAfter is how long a grab may go without a byte arriving
|
|
||||||
// before the peer is given up on. It is measured from enqueue, so
|
|
||||||
// it covers a peer that queues us and never starts as well as one
|
|
||||||
// that starts and stops. Ten minutes is long enough for a short
|
|
||||||
// queue ahead of us to clear and short enough that one unresponsive
|
|
||||||
// peer does not hold slskd's single transfer slot for an evening.
|
|
||||||
slskdStallAfter = 10 * time.Minute
|
|
||||||
|
|
||||||
// slskdAbsentGrace is how long a requested file may be missing from
|
|
||||||
// slskd's transfer list before it is counted as failed. slskd lists
|
|
||||||
// a transfer as soon as it accepts it, so a file still absent after
|
|
||||||
// a few polls was refused.
|
|
||||||
slskdAbsentGrace = 30 * time.Second
|
|
||||||
|
|
||||||
// slskdCancelTimeout bounds the cleanup that cancels abandoned
|
|
||||||
// transfers.
|
|
||||||
slskdCancelTimeout = 15 * time.Second
|
|
||||||
)
|
)
|
||||||
|
|
||||||
func init() {
|
func init() {
|
||||||
@@ -158,8 +134,6 @@ type slskd struct {
|
|||||||
searchPoll time.Duration
|
searchPoll time.Duration
|
||||||
searchWait time.Duration
|
searchWait time.Duration
|
||||||
transferPoll time.Duration
|
transferPoll time.Duration
|
||||||
stallAfter time.Duration
|
|
||||||
absentGrace time.Duration
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// newSlskd builds the provider from config.
|
// newSlskd builds the provider from config.
|
||||||
@@ -214,8 +188,6 @@ func newSlskd(
|
|||||||
searchPoll: slskdSearchPoll,
|
searchPoll: slskdSearchPoll,
|
||||||
searchWait: slskdSearchWait,
|
searchWait: slskdSearchWait,
|
||||||
transferPoll: slskdTransferPoll,
|
transferPoll: slskdTransferPoll,
|
||||||
stallAfter: slskdStallAfter,
|
|
||||||
absentGrace: slskdAbsentGrace,
|
|
||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -259,13 +231,14 @@ type slskdSearch struct {
|
|||||||
|
|
||||||
// slskdResponse is one peer's answer to a search.
|
// slskdResponse is one peer's answer to a search.
|
||||||
type slskdResponse struct {
|
type slskdResponse struct {
|
||||||
Username string `json:"username"`
|
Username string `json:"username"`
|
||||||
HasFreeUploadSlot bool `json:"hasFreeUploadSlot"`
|
HasFreeUploadSlot bool `json:"hasFreeUploadSlot"`
|
||||||
QueueLength int `json:"queueLength"`
|
QueueLength int `json:"queueLength"`
|
||||||
UploadSpeed int64 `json:"uploadSpeed"`
|
UploadSpeed int64 `json:"uploadSpeed"`
|
||||||
Files []slskdFile `json:"files"`
|
Files []slskdFile `json:"files"`
|
||||||
LockedFileCount int `json:"lockedFileCount"`
|
LockedFileCount int `json:"lockedFileCount"`
|
||||||
FileCount int `json:"fileCount"`
|
FileCount int `json:"fileCount"`
|
||||||
|
FreeUploadSlotFlag bool `json:"freeUploadSlots"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// slskdFile is one file a peer is offering.
|
// slskdFile is one file a peer is offering.
|
||||||
@@ -273,9 +246,7 @@ type slskdFile struct {
|
|||||||
Filename string `json:"filename"`
|
Filename string `json:"filename"`
|
||||||
Size int64 `json:"size"`
|
Size int64 `json:"size"`
|
||||||
BitRate int `json:"bitRate"`
|
BitRate int `json:"bitRate"`
|
||||||
|
Length int `json:"length"`
|
||||||
// Length is the duration in whole seconds.
|
|
||||||
Length int `json:"length"`
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// slskdTransfer is one download's state.
|
// slskdTransfer is one download's state.
|
||||||
@@ -307,89 +278,24 @@ func (t slskdTransfer) done() (finished, ok bool) {
|
|||||||
// per-folder candidates. A folder from one peer is the unit a user
|
// per-folder candidates. A folder from one peer is the unit a user
|
||||||
// actually wants: Soulseek has no album concept, but people organise
|
// actually wants: Soulseek has no album concept, but people organise
|
||||||
// their shares by album directory.
|
// their shares by album directory.
|
||||||
//
|
|
||||||
// Up to two queries run at once — the request as written and a
|
|
||||||
// normalised form of it (see slskdQueries) — and their candidates are
|
|
||||||
// merged. They run concurrently rather than as a fallback because the
|
|
||||||
// manager gives a provider one search budget, and a Soulseek search
|
|
||||||
// spends most of it waiting for peers to answer; a second query after
|
|
||||||
// the first would not fit.
|
|
||||||
func (s *slskd) Search(ctx context.Context, dl Download) ([]Candidate, error) {
|
func (s *slskd) Search(ctx context.Context, dl Download) ([]Candidate, error) {
|
||||||
queries := slskdQueries(dl)
|
|
||||||
if len(queries) == 0 {
|
|
||||||
return nil, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
type found struct {
|
|
||||||
candidates []Candidate
|
|
||||||
err error
|
|
||||||
}
|
|
||||||
|
|
||||||
results := make(chan found, len(queries))
|
|
||||||
|
|
||||||
for _, q := range queries {
|
|
||||||
go func(q string) {
|
|
||||||
c, err := s.searchOnce(ctx, q, minFilesFor(dl))
|
|
||||||
results <- found{candidates: c, err: err}
|
|
||||||
}(q)
|
|
||||||
}
|
|
||||||
|
|
||||||
var (
|
|
||||||
out []Candidate
|
|
||||||
seen = map[string]bool{}
|
|
||||||
firstErr error
|
|
||||||
answered int
|
|
||||||
)
|
|
||||||
|
|
||||||
for range queries {
|
|
||||||
r := <-results
|
|
||||||
if r.err != nil {
|
|
||||||
s.logger.Debug("slskd search failed", "error", r.err)
|
|
||||||
|
|
||||||
if firstErr == nil {
|
|
||||||
firstErr = r.err
|
|
||||||
}
|
|
||||||
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
answered++
|
|
||||||
|
|
||||||
// The same peer's folder turns up under both queries; the ID is
|
|
||||||
// peer and folder, so it is the same candidate.
|
|
||||||
for _, c := range r.candidates {
|
|
||||||
if seen[c.ID] {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
seen[c.ID] = true
|
|
||||||
|
|
||||||
out = append(out, c)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if answered == 0 {
|
|
||||||
return nil, firstErr
|
|
||||||
}
|
|
||||||
|
|
||||||
return out, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// searchOnce runs one query to completion and returns its candidates.
|
|
||||||
func (s *slskd) searchOnce(
|
|
||||||
ctx context.Context,
|
|
||||||
text string,
|
|
||||||
minFiles int,
|
|
||||||
) ([]Candidate, error) {
|
|
||||||
// slskd's search endpoint deserializes id as a .NET Guid server-side,
|
// slskd's search endpoint deserializes id as a .NET Guid server-side,
|
||||||
// so it must be a dashed UUID — the app's own newID() (a plain hex
|
// so it must be a dashed UUID — the app's own newID() (a plain hex
|
||||||
// string, used for request/item IDs elsewhere) is rejected with an
|
// string, used for request/item IDs elsewhere) is rejected with an
|
||||||
// HTTP 400 before any search happens.
|
// HTTP 400 before any search happens.
|
||||||
searchID := uuid.NewString()
|
searchID := uuid.NewString()
|
||||||
|
|
||||||
if err := s.client.post(
|
body := map[string]any{
|
||||||
ctx, "/api/v0/searches", s.searchRequest(searchID, text, minFiles), nil,
|
"id": searchID,
|
||||||
); err != nil {
|
"searchText": dl.SearchText(),
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := s.client.post(ctx, "/api/v0/searches", body, nil); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
search, err := s.awaitSearch(ctx, searchID)
|
||||||
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -401,222 +307,52 @@ func (s *slskd) searchOnce(
|
|||||||
)
|
)
|
||||||
}()
|
}()
|
||||||
|
|
||||||
if err := s.awaitSearch(ctx, searchID); err != nil {
|
return s.candidatesFrom(search), nil
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
responses, err := s.searchResponses(ctx, searchID)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
return s.candidatesFrom(responses, minFiles), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// searchRequest is the body that starts a search.
|
|
||||||
//
|
|
||||||
// Every option is stated rather than left to the daemon, because
|
|
||||||
// slskd's defaults are its own and not ours. Its search timeout in
|
|
||||||
// particular has to finish inside our wait: a search that slskd is still
|
|
||||||
// running when we stop polling is results we asked for and discarded.
|
|
||||||
// The response and file limits are raised well above what a popular
|
|
||||||
// album produces, and the peer filters let slskd drop answers this
|
|
||||||
// provider would only score down to nothing — a folder too small to be
|
|
||||||
// a candidate, a peer with a queue it will not reach today.
|
|
||||||
func (s *slskd) searchRequest(id, text string, minFiles int) map[string]any {
|
|
||||||
const (
|
|
||||||
responseLimit = 500
|
|
||||||
fileLimit = 20_000
|
|
||||||
maximumPeerQueueLength = 100
|
|
||||||
)
|
|
||||||
|
|
||||||
// A tenth of the wait is left for the last poll and the responses
|
|
||||||
// fetch.
|
|
||||||
timeout := s.searchWait - s.searchWait/10
|
|
||||||
|
|
||||||
return map[string]any{
|
|
||||||
"id": id,
|
|
||||||
"searchText": text,
|
|
||||||
"searchTimeout": timeout.Milliseconds(),
|
|
||||||
"responseLimit": responseLimit,
|
|
||||||
"fileLimit": fileLimit,
|
|
||||||
"filterResponses": true,
|
|
||||||
"minimumResponseFileCount": minFiles,
|
|
||||||
"maximumPeerQueueLength": maximumPeerQueueLength,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// slskdQueries is what is searched for a request: the request's own
|
|
||||||
// search text, and a normalised form of it when that differs.
|
|
||||||
//
|
|
||||||
// Soulseek matches every term against the file's full path, so each
|
|
||||||
// extra word is a filter, and some words filter wrongly:
|
|
||||||
//
|
|
||||||
// - edition qualifiers — "(Deluxe Edition)", "[2011 Remaster]" — are
|
|
||||||
// in the catalog's title and rarely in anyone's folder name;
|
|
||||||
// - punctuation splits a term oddly, and a term that starts with "-"
|
|
||||||
// is an *exclusion*, so an album called "-ism" searches for
|
|
||||||
// everything without it;
|
|
||||||
// - "Various Artists" is in no one's path for a compilation.
|
|
||||||
//
|
|
||||||
// A query the user typed is theirs and is searched exactly as written.
|
|
||||||
func slskdQueries(dl Download) []string {
|
|
||||||
primary := strings.TrimSpace(dl.SearchText())
|
|
||||||
if primary == "" {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
out := []string{primary}
|
|
||||||
|
|
||||||
if dl.Query != "" {
|
|
||||||
return out
|
|
||||||
}
|
|
||||||
|
|
||||||
artist := dl.Artist
|
|
||||||
if isVariousArtists(artist) {
|
|
||||||
artist = ""
|
|
||||||
}
|
|
||||||
|
|
||||||
normal := Download{
|
|
||||||
Artist: normalizeSearchTerms(artist),
|
|
||||||
Album: normalizeSearchTerms(editionPattern.ReplaceAllString(dl.Album, " ")),
|
|
||||||
}
|
|
||||||
|
|
||||||
if alt := strings.TrimSpace(normal.SearchText()); alt != "" &&
|
|
||||||
!strings.EqualFold(alt, primary) {
|
|
||||||
out = append(out, alt)
|
|
||||||
}
|
|
||||||
|
|
||||||
return out
|
|
||||||
}
|
|
||||||
|
|
||||||
var (
|
|
||||||
// editionPattern finds an edition qualifier: a bracketed group that
|
|
||||||
// names an edition, or a trailing " - 2011 Remaster".
|
|
||||||
editionPattern = regexp.MustCompile(
|
|
||||||
`(?i)\s*[(\[][^)\]]*\b(?:deluxe|edition|remaster(?:ed)?|expanded|` +
|
|
||||||
`anniversary|bonus|explicit|reissue|special|collector'?s?|` +
|
|
||||||
`version|mono|stereo)\b[^)\]]*[)\]]` +
|
|
||||||
`|\s+-\s+(?:\d{4}\s+)?remaster(?:ed)?\b.*$`,
|
|
||||||
)
|
|
||||||
|
|
||||||
// nonWordPattern is everything that is not a letter or a digit.
|
|
||||||
nonWordPattern = regexp.MustCompile(`[^\p{L}\p{N}]+`)
|
|
||||||
)
|
|
||||||
|
|
||||||
// normalizeSearchTerms reduces text to plain words.
|
|
||||||
func normalizeSearchTerms(s string) string {
|
|
||||||
return strings.Join(strings.Fields(nonWordPattern.ReplaceAllString(s, " ")), " ")
|
|
||||||
}
|
|
||||||
|
|
||||||
// isVariousArtists reports whether an artist credit is a compilation's
|
|
||||||
// placeholder rather than an artist.
|
|
||||||
func isVariousArtists(artist string) bool {
|
|
||||||
switch strings.ToLower(strings.TrimSpace(artist)) {
|
|
||||||
case "various artists", "various", "va":
|
|
||||||
return true
|
|
||||||
default:
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// minFilesFor is the fewest audio files a folder must offer to be a
|
|
||||||
// candidate for this request.
|
|
||||||
//
|
|
||||||
// Soulseek answers a search with the files that match it, not with the
|
|
||||||
// folders they sit in. An album query matches every file in the album's
|
|
||||||
// folder, because the folder name carries the terms; a *track* query
|
|
||||||
// usually matches one file per folder. The two-file floor that filters
|
|
||||||
// out one-file noise for an album therefore filtered out every result
|
|
||||||
// for a track, and a single-track request could never be served here.
|
|
||||||
func minFilesFor(dl Download) int {
|
|
||||||
if dl.RecordingMBID != "" {
|
|
||||||
return 1
|
|
||||||
}
|
|
||||||
|
|
||||||
return slskdMinFiles
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// awaitSearch polls until the search completes or the budget runs out.
|
// awaitSearch polls until the search completes or the budget runs out.
|
||||||
// A timeout is not an error: partial Soulseek results are normal and
|
// A timeout is not an error: partial Soulseek results are normal and
|
||||||
// often good enough.
|
// often good enough.
|
||||||
//
|
func (s *slskd) awaitSearch(
|
||||||
// The poll asks for the search's state only. It used to ask for every
|
ctx context.Context,
|
||||||
// response on every one-second tick, which for a popular album is the
|
searchID string,
|
||||||
// same few thousand file entries serialised twenty times to be read
|
) (slskdSearch, error) {
|
||||||
// once; searchResponses fetches them once at the end.
|
|
||||||
func (s *slskd) awaitSearch(ctx context.Context, searchID string) error {
|
|
||||||
deadline := time.Now().Add(s.searchWait)
|
deadline := time.Now().Add(s.searchWait)
|
||||||
|
|
||||||
|
var last slskdSearch
|
||||||
|
|
||||||
for time.Now().Before(deadline) {
|
for time.Now().Before(deadline) {
|
||||||
select {
|
select {
|
||||||
case <-ctx.Done():
|
case <-ctx.Done():
|
||||||
return fmt.Errorf("%w: search cancelled", ErrSlskdTimeout)
|
return last, fmt.Errorf("%w: search cancelled", ErrSlskdTimeout)
|
||||||
case <-time.After(s.searchPoll):
|
case <-time.After(s.searchPoll):
|
||||||
}
|
}
|
||||||
|
|
||||||
var search slskdSearch
|
var search slskdSearch
|
||||||
|
|
||||||
if err := s.client.get(
|
if err := s.client.get(
|
||||||
ctx, "/api/v0/searches/"+searchID, &search,
|
ctx,
|
||||||
|
"/api/v0/searches/"+searchID+"?includeResponses=true",
|
||||||
|
&search,
|
||||||
); err != nil {
|
); err != nil {
|
||||||
return err
|
return last, err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
last = search
|
||||||
|
|
||||||
if search.IsComplete {
|
if search.IsComplete {
|
||||||
return nil
|
return search, nil
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
return last, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// searchResponses fetches a search's responses once.
|
// candidatesFrom groups a search's responses into candidates.
|
||||||
//
|
func (s *slskd) candidatesFrom(search slskdSearch) []Candidate {
|
||||||
// `/searches/{id}/responses` is the endpoint for that; a daemon that
|
out := make([]Candidate, 0, len(search.Responses))
|
||||||
// does not answer it is asked the older way, with the search itself
|
|
||||||
// carrying its responses, so an older slskd degrades to the previous
|
|
||||||
// behaviour rather than to no results at all.
|
|
||||||
func (s *slskd) searchResponses(
|
|
||||||
ctx context.Context,
|
|
||||||
searchID string,
|
|
||||||
) ([]slskdResponse, error) {
|
|
||||||
var responses []slskdResponse
|
|
||||||
|
|
||||||
err := s.client.get(
|
for _, resp := range search.Responses {
|
||||||
ctx, "/api/v0/searches/"+searchID+"/responses", &responses,
|
|
||||||
)
|
|
||||||
if err == nil {
|
|
||||||
return responses, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
s.logger.Debug(
|
|
||||||
"slskd responses endpoint failed; asking with the search",
|
|
||||||
"error", err,
|
|
||||||
)
|
|
||||||
|
|
||||||
var search slskdSearch
|
|
||||||
|
|
||||||
if err := s.client.get(
|
|
||||||
ctx,
|
|
||||||
"/api/v0/searches/"+searchID+"?includeResponses=true",
|
|
||||||
&search,
|
|
||||||
); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
return search.Responses, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// candidatesFrom groups a search's responses into candidates, dropping
|
|
||||||
// folders with fewer than minFiles audio files.
|
|
||||||
func (s *slskd) candidatesFrom(
|
|
||||||
responses []slskdResponse,
|
|
||||||
minFiles int,
|
|
||||||
) []Candidate {
|
|
||||||
out := make([]Candidate, 0, len(responses))
|
|
||||||
|
|
||||||
for _, resp := range responses {
|
|
||||||
for folder, files := range groupByFolder(resp.Files) {
|
for folder, files := range groupByFolder(resp.Files) {
|
||||||
audio := 0
|
audio := 0
|
||||||
|
|
||||||
@@ -636,14 +372,12 @@ func (s *slskd) candidatesFrom(
|
|||||||
Format: format,
|
Format: format,
|
||||||
Bitrate: f.BitRate,
|
Bitrate: f.BitRate,
|
||||||
IsAudio: isAudio,
|
IsAudio: isAudio,
|
||||||
|
|
||||||
LengthMillis: int64(f.Length) * millisPerSecond,
|
|
||||||
})
|
})
|
||||||
|
|
||||||
total += f.Size
|
total += f.Size
|
||||||
}
|
}
|
||||||
|
|
||||||
if audio < minFiles {
|
if audio < slskdMinFiles {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -664,15 +398,13 @@ func (s *slskd) candidatesFrom(
|
|||||||
return out
|
return out
|
||||||
}
|
}
|
||||||
|
|
||||||
// groupByFolder buckets a peer's files by the album directory they sit
|
// groupByFolder buckets a peer's files by their containing directory.
|
||||||
// in — the containing directory, or the one above it for a disc folder
|
|
||||||
// (see AlbumDir), so a multi-disc rip is one candidate and not two.
|
|
||||||
func groupByFolder(files []slskdFile) map[string][]slskdFile {
|
func groupByFolder(files []slskdFile) map[string][]slskdFile {
|
||||||
out := map[string][]slskdFile{}
|
out := map[string][]slskdFile{}
|
||||||
|
|
||||||
for _, f := range files {
|
for _, f := range files {
|
||||||
dir := AlbumDir(f.Filename)
|
norm := strings.ReplaceAll(f.Filename, `\`, "/")
|
||||||
out[dir] = append(out[dir], f)
|
out[path.Dir(norm)] = append(out[path.Dir(norm)], f)
|
||||||
}
|
}
|
||||||
|
|
||||||
return out
|
return out
|
||||||
@@ -686,7 +418,7 @@ func groupByFolder(files []slskdFile) map[string][]slskdFile {
|
|||||||
func peerHealth(r slskdResponse) float64 {
|
func peerHealth(r slskdResponse) float64 {
|
||||||
score := 0.35
|
score := 0.35
|
||||||
|
|
||||||
if r.HasFreeUploadSlot {
|
if r.HasFreeUploadSlot || r.FreeUploadSlotFlag {
|
||||||
score += 0.4
|
score += 0.4
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -735,15 +467,6 @@ func (s *slskd) Grab(
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
// slskd keeps finished transfers listed until someone removes them,
|
|
||||||
// and a transfer is matched to the request by filename. A record
|
|
||||||
// left by an earlier attempt at the same file from the same peer
|
|
||||||
// would otherwise be read as this attempt's answer the moment the
|
|
||||||
// first poll came back — an old failure failing a transfer that has
|
|
||||||
// not started. So what is already terminal is noted before enqueueing
|
|
||||||
// and ignored after.
|
|
||||||
stale := s.terminalTransferIDs(ctx, username)
|
|
||||||
|
|
||||||
wanted := make([]map[string]any, 0, len(c.Files))
|
wanted := make([]map[string]any, 0, len(c.Files))
|
||||||
for _, f := range c.Files {
|
for _, f := range c.Files {
|
||||||
wanted = append(wanted, map[string]any{
|
wanted = append(wanted, map[string]any{
|
||||||
@@ -753,69 +476,24 @@ func (s *slskd) Grab(
|
|||||||
}
|
}
|
||||||
|
|
||||||
if err := s.client.post(
|
if err := s.client.post(
|
||||||
ctx, slskdDownloadsPath(username), wanted, nil,
|
ctx, "/api/v0/transfers/downloads/"+username, wanted, nil,
|
||||||
); err != nil {
|
); err != nil {
|
||||||
return Result{}, err
|
return Result{}, err
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := s.awaitTransfers(
|
if err := s.awaitTransfers(ctx, username, c, onProgress); err != nil {
|
||||||
ctx, username, stale, c, onProgress,
|
|
||||||
); err != nil {
|
|
||||||
return Result{}, err
|
return Result{}, err
|
||||||
}
|
}
|
||||||
|
|
||||||
return s.collect(c, dst)
|
return s.collect(c, dst)
|
||||||
}
|
}
|
||||||
|
|
||||||
// slskdDownloadsPath is the transfers endpoint for one peer. Soulseek
|
|
||||||
// usernames may contain spaces and punctuation, so the name is escaped
|
|
||||||
// rather than spliced into the path.
|
|
||||||
func slskdDownloadsPath(username string) string {
|
|
||||||
return "/api/v0/transfers/downloads/" + url.PathEscape(username)
|
|
||||||
}
|
|
||||||
|
|
||||||
// terminalTransferIDs returns the ids of this peer's transfers that are
|
|
||||||
// already finished. Best effort: slskd answers 404 for a peer it has no
|
|
||||||
// transfers with, and any failure here means only that there is nothing
|
|
||||||
// to ignore.
|
|
||||||
func (s *slskd) terminalTransferIDs(
|
|
||||||
ctx context.Context,
|
|
||||||
username string,
|
|
||||||
) map[string]bool {
|
|
||||||
transfers, err := s.transfersFor(ctx, username)
|
|
||||||
if err != nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
out := make(map[string]bool, len(transfers))
|
|
||||||
|
|
||||||
for _, t := range transfers {
|
|
||||||
if finished, _ := t.done(); finished && t.ID != "" {
|
|
||||||
out[t.ID] = true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return out
|
|
||||||
}
|
|
||||||
|
|
||||||
// awaitTransfers polls until every requested file reaches a terminal
|
// awaitTransfers polls until every requested file reaches a terminal
|
||||||
// state, the transfer stalls, or the caller gives up.
|
// state. Soulseek queues are measured in hours, so the only deadline
|
||||||
//
|
// is the caller's context.
|
||||||
// Soulseek queues are measured in hours, so there is no deadline on the
|
|
||||||
// transfer as a whole — but there is one on *progress*. slskd's
|
|
||||||
// transfer limit is one, so a peer that holds us in its queue without
|
|
||||||
// sending a byte is not only failing this download, it is holding every
|
|
||||||
// other Soulseek download behind it. After stallAfter with nothing
|
|
||||||
// moving the peer is given up on, and the manager tries another.
|
|
||||||
//
|
|
||||||
// Whatever way this ends short of every file finishing, the transfers
|
|
||||||
// still live in slskd are cancelled there. Returning without doing so
|
|
||||||
// leaves the daemon downloading into its own folder for a request
|
|
||||||
// nobody is waiting on any more.
|
|
||||||
func (s *slskd) awaitTransfers(
|
func (s *slskd) awaitTransfers(
|
||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
username string,
|
username string,
|
||||||
stale map[string]bool,
|
|
||||||
c Candidate,
|
c Candidate,
|
||||||
onProgress ProgressFunc,
|
onProgress ProgressFunc,
|
||||||
) error {
|
) error {
|
||||||
@@ -824,18 +502,9 @@ func (s *slskd) awaitTransfers(
|
|||||||
wanted[f.Path] = true
|
wanted[f.Path] = true
|
||||||
}
|
}
|
||||||
|
|
||||||
var (
|
|
||||||
started = time.Now()
|
|
||||||
lastProgress = started
|
|
||||||
lastBytes int64
|
|
||||||
live []slskdTransfer
|
|
||||||
)
|
|
||||||
|
|
||||||
for {
|
for {
|
||||||
select {
|
select {
|
||||||
case <-ctx.Done():
|
case <-ctx.Done():
|
||||||
s.cancelTransfers(username, live)
|
|
||||||
|
|
||||||
return fmt.Errorf("%w: transfer cancelled", ErrSlskdTimeout)
|
return fmt.Errorf("%w: transfer cancelled", ErrSlskdTimeout)
|
||||||
case <-time.After(s.transferPoll):
|
case <-time.After(s.transferPoll):
|
||||||
}
|
}
|
||||||
@@ -843,177 +512,60 @@ func (s *slskd) awaitTransfers(
|
|||||||
transfers, err := s.transfersFor(ctx, username)
|
transfers, err := s.transfersFor(ctx, username)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
// A blip talking to the daemon should not abandon a
|
// A blip talking to the daemon should not abandon a
|
||||||
// transfer that may be hours in — but a daemon that stays
|
// transfer that may be hours in.
|
||||||
// away is a stall like any other.
|
|
||||||
s.logger.Debug("slskd transfer poll failed", "error", err)
|
s.logger.Debug("slskd transfer poll failed", "error", err)
|
||||||
|
|
||||||
if time.Since(lastProgress) >= s.stallAfter {
|
|
||||||
s.cancelTransfers(username, live)
|
|
||||||
|
|
||||||
return fmt.Errorf(
|
|
||||||
"%w: slskd has not answered for %s: %w",
|
|
||||||
ErrSlskdTimeout, s.stallAfter, err,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
tally := tallyTransfers(
|
var (
|
||||||
transfers, wanted, stale,
|
done, failed int
|
||||||
time.Since(started) >= s.absentGrace,
|
current int64
|
||||||
)
|
)
|
||||||
live = tally.live
|
|
||||||
|
|
||||||
if tally.bytes > lastBytes {
|
for _, t := range transfers {
|
||||||
lastBytes = tally.bytes
|
if !wanted[t.Filename] {
|
||||||
lastProgress = time.Now()
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
current += t.BytesTransferred
|
||||||
|
|
||||||
|
finished, ok := t.done()
|
||||||
|
if !finished {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if ok {
|
||||||
|
done++
|
||||||
|
} else {
|
||||||
|
failed++
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if onProgress != nil {
|
if onProgress != nil {
|
||||||
onProgress(Progress{
|
onProgress(Progress{
|
||||||
Current: tally.bytes,
|
Current: current,
|
||||||
Total: c.TotalSize,
|
Total: c.TotalSize,
|
||||||
Phase: fmt.Sprintf(
|
Phase: fmt.Sprintf(
|
||||||
"Transferring from %s (%d/%d)",
|
"Transferring from %s (%d/%d)", username, done, len(wanted),
|
||||||
username, tally.done, len(wanted),
|
|
||||||
),
|
),
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
if tally.done+tally.failed >= len(wanted) {
|
if done+failed < len(wanted) {
|
||||||
// Some files failing is normal — a peer goes offline
|
|
||||||
// mid-folder. Let the importer's completeness check decide
|
|
||||||
// whether what arrived is enough, rather than discarding it
|
|
||||||
// here.
|
|
||||||
if tally.done == 0 {
|
|
||||||
return fmt.Errorf(
|
|
||||||
"%w: all %d files failed",
|
|
||||||
ErrSlskdTransferFailed, tally.failed,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
if time.Since(lastProgress) < s.stallAfter {
|
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
s.cancelTransfers(username, live)
|
// Some files failing is normal — a peer goes offline mid-folder.
|
||||||
|
// Let the importer's completeness check decide whether what
|
||||||
// A folder that stalls on its last track is the same shape as
|
// arrived is enough, rather than discarding it here.
|
||||||
// one whose last track failed, and goes forward the same way.
|
if done == 0 {
|
||||||
if tally.done > 0 {
|
return fmt.Errorf(
|
||||||
s.logger.Info(
|
"%w: all %d files failed", ErrSlskdTransferFailed, failed,
|
||||||
"slskd transfer stalled; keeping what arrived",
|
|
||||||
"peer", username,
|
|
||||||
"done", tally.done,
|
|
||||||
"wanted", len(wanted),
|
|
||||||
)
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
return fmt.Errorf(
|
|
||||||
"%w: %s sent nothing in %s",
|
|
||||||
ErrSlskdTimeout, username, s.stallAfter,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// transferTally is one poll's reading of the files a grab asked for.
|
|
||||||
type transferTally struct {
|
|
||||||
done, failed int
|
|
||||||
bytes int64
|
|
||||||
|
|
||||||
// live are the requested transfers slskd is still working on,
|
|
||||||
// which are what has to be cancelled if the grab is abandoned.
|
|
||||||
live []slskdTransfer
|
|
||||||
}
|
|
||||||
|
|
||||||
// tallyTransfers reads a peer's transfer list against the files a grab
|
|
||||||
// asked for.
|
|
||||||
//
|
|
||||||
// A requested file slskd does not list at all is one it never accepted
|
|
||||||
// — refused at enqueue, or dropped — and it will never reach a terminal
|
|
||||||
// state to be counted by. Once absentExpired, such a file counts as
|
|
||||||
// failed, or the grab would wait on it until the six-hour ceiling.
|
|
||||||
func tallyTransfers(
|
|
||||||
transfers []slskdTransfer,
|
|
||||||
wanted map[string]bool,
|
|
||||||
stale map[string]bool,
|
|
||||||
absentExpired bool,
|
|
||||||
) transferTally {
|
|
||||||
seen := make(map[string]slskdTransfer, len(wanted))
|
|
||||||
|
|
||||||
for _, t := range transfers {
|
|
||||||
if !wanted[t.Filename] || stale[t.ID] {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
seen[t.Filename] = t
|
|
||||||
}
|
|
||||||
|
|
||||||
var out transferTally
|
|
||||||
|
|
||||||
for name := range wanted {
|
|
||||||
t, ok := seen[name]
|
|
||||||
if !ok {
|
|
||||||
if absentExpired {
|
|
||||||
out.failed++
|
|
||||||
}
|
|
||||||
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
out.bytes += t.BytesTransferred
|
|
||||||
|
|
||||||
finished, succeeded := t.done()
|
|
||||||
|
|
||||||
switch {
|
|
||||||
case !finished:
|
|
||||||
out.live = append(out.live, t)
|
|
||||||
case succeeded:
|
|
||||||
out.done++
|
|
||||||
default:
|
|
||||||
out.failed++
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return out
|
|
||||||
}
|
|
||||||
|
|
||||||
// cancelTransfers asks slskd to cancel and forget transfers this grab
|
|
||||||
// is abandoning. It runs on a context of its own: the usual reason to
|
|
||||||
// be here is that the caller's context has just been cancelled, and a
|
|
||||||
// cleanup that inherited it would never be sent.
|
|
||||||
func (s *slskd) cancelTransfers(username string, live []slskdTransfer) {
|
|
||||||
if len(live) == 0 {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
ctx, cancel := context.WithTimeout(
|
|
||||||
context.Background(), slskdCancelTimeout,
|
|
||||||
)
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
for _, t := range live {
|
|
||||||
if t.ID == "" {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
endpoint := slskdDownloadsPath(username) + "/" +
|
|
||||||
url.PathEscape(t.ID) + "?remove=true"
|
|
||||||
|
|
||||||
if err := s.client.delete(ctx, endpoint); err != nil {
|
|
||||||
s.logger.Warn(
|
|
||||||
"could not cancel slskd transfer",
|
|
||||||
"peer", username,
|
|
||||||
"file", t.Filename,
|
|
||||||
"error", err,
|
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1029,7 +581,9 @@ func (s *slskd) transfersFor(
|
|||||||
} `json:"directories"`
|
} `json:"directories"`
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := s.client.get(ctx, slskdDownloadsPath(username), &raw); err != nil {
|
if err := s.client.get(
|
||||||
|
ctx, "/api/v0/transfers/downloads/"+username, &raw,
|
||||||
|
); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1062,13 +616,7 @@ func (s *slskd) collect(c Candidate, dst string) (Result, error) {
|
|||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
// A multi-disc candidate keeps its disc folders in staging.
|
|
||||||
// Flattened, disc 2's "01 Intro.flac" overwrites disc 1's, and
|
|
||||||
// the importer loses the folder it reads the disc number from.
|
|
||||||
target := filepath.Join(dst, base)
|
target := filepath.Join(dst, base)
|
||||||
if _, ok := discFolder(folder); ok {
|
|
||||||
target = filepath.Join(dst, folder, base)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := movePath(src, target); err != nil {
|
if err := movePath(src, target); err != nil {
|
||||||
return Result{}, fmt.Errorf("collect %s: %w", base, err)
|
return Result{}, fmt.Errorf("collect %s: %w", base, err)
|
||||||
|
|||||||
@@ -31,30 +31,11 @@ type slskdStub struct {
|
|||||||
transfers [][]slskdTransfer
|
transfers [][]slskdTransfer
|
||||||
pollCount int
|
pollCount int
|
||||||
|
|
||||||
// before is what the downloads endpoint reports until something is
|
|
||||||
// enqueued: records slskd already held from earlier attempts.
|
|
||||||
before []slskdTransfer
|
|
||||||
|
|
||||||
// enqueued records what was requested for download.
|
// enqueued records what was requested for download.
|
||||||
enqueued []map[string]any
|
enqueued []map[string]any
|
||||||
posted bool
|
|
||||||
|
|
||||||
// paths records the escaped path of every transfers call, and
|
|
||||||
// cancelled the escaped request URI of every DELETE.
|
|
||||||
paths []string
|
|
||||||
cancelled []string
|
|
||||||
|
|
||||||
// unauthorized makes every call return 401.
|
// unauthorized makes every call return 401.
|
||||||
unauthorized bool
|
unauthorized bool
|
||||||
|
|
||||||
// searches records every search request body, and searchGets the
|
|
||||||
// request URI of every search GET.
|
|
||||||
searches []map[string]any
|
|
||||||
searchGets []string
|
|
||||||
|
|
||||||
// noResponsesEndpoint makes /searches/{id}/responses 404, as an
|
|
||||||
// older daemon would.
|
|
||||||
noResponsesEndpoint bool
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func newSlskdStub(t *testing.T) *slskdStub {
|
func newSlskdStub(t *testing.T) *slskdStub {
|
||||||
@@ -76,16 +57,6 @@ func newSlskdStub(t *testing.T) *slskdStub {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
var body map[string]any
|
|
||||||
|
|
||||||
if err := json.NewDecoder(r.Body).Decode(&body); err != nil {
|
|
||||||
t.Errorf("decode search body: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
s.mu.Lock()
|
|
||||||
s.searches = append(s.searches, body)
|
|
||||||
s.mu.Unlock()
|
|
||||||
|
|
||||||
w.WriteHeader(http.StatusCreated)
|
w.WriteHeader(http.StatusCreated)
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -102,26 +73,8 @@ func newSlskdStub(t *testing.T) *slskdStub {
|
|||||||
|
|
||||||
s.mu.Lock()
|
s.mu.Lock()
|
||||||
responses := s.responses
|
responses := s.responses
|
||||||
noEndpoint := s.noResponsesEndpoint
|
|
||||||
s.searchGets = append(s.searchGets, r.URL.RequestURI())
|
|
||||||
s.mu.Unlock()
|
s.mu.Unlock()
|
||||||
|
|
||||||
if strings.HasSuffix(r.URL.Path, "/responses") {
|
|
||||||
if noEndpoint {
|
|
||||||
w.WriteHeader(http.StatusNotFound)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
writeJSON(t, w, responses)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if r.URL.Query().Get("includeResponses") != "true" {
|
|
||||||
responses = nil
|
|
||||||
}
|
|
||||||
|
|
||||||
writeJSON(t, w, slskdSearch{
|
writeJSON(t, w, slskdSearch{
|
||||||
ID: "search-1",
|
ID: "search-1",
|
||||||
IsComplete: true,
|
IsComplete: true,
|
||||||
@@ -134,12 +87,7 @@ func newSlskdStub(t *testing.T) *slskdStub {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
s.mu.Lock()
|
if r.Method == http.MethodPost {
|
||||||
s.paths = append(s.paths, r.URL.EscapedPath())
|
|
||||||
s.mu.Unlock()
|
|
||||||
|
|
||||||
switch r.Method {
|
|
||||||
case http.MethodPost:
|
|
||||||
var body []map[string]any
|
var body []map[string]any
|
||||||
|
|
||||||
if err := json.NewDecoder(r.Body).Decode(&body); err != nil {
|
if err := json.NewDecoder(r.Body).Decode(&body); err != nil {
|
||||||
@@ -148,35 +96,15 @@ func newSlskdStub(t *testing.T) *slskdStub {
|
|||||||
|
|
||||||
s.mu.Lock()
|
s.mu.Lock()
|
||||||
s.enqueued = body
|
s.enqueued = body
|
||||||
s.posted = true
|
|
||||||
s.mu.Unlock()
|
s.mu.Unlock()
|
||||||
|
|
||||||
w.WriteHeader(http.StatusCreated)
|
w.WriteHeader(http.StatusCreated)
|
||||||
|
|
||||||
return
|
|
||||||
case http.MethodDelete:
|
|
||||||
s.mu.Lock()
|
|
||||||
s.cancelled = append(s.cancelled, r.URL.RequestURI())
|
|
||||||
s.mu.Unlock()
|
|
||||||
|
|
||||||
w.WriteHeader(http.StatusNoContent)
|
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
s.mu.Lock()
|
s.mu.Lock()
|
||||||
|
|
||||||
if !s.posted {
|
|
||||||
before := s.before
|
|
||||||
s.mu.Unlock()
|
|
||||||
|
|
||||||
writeJSON(t, w, map[string]any{
|
|
||||||
"directories": []map[string]any{{"files": before}},
|
|
||||||
})
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
idx := s.pollCount
|
idx := s.pollCount
|
||||||
if idx >= len(s.transfers) {
|
if idx >= len(s.transfers) {
|
||||||
idx = len(s.transfers) - 1
|
idx = len(s.transfers) - 1
|
||||||
@@ -263,11 +191,6 @@ func newStubSlskd(t *testing.T, stub *slskdStub) (*slskd, string) {
|
|||||||
s.searchWait = 200 * time.Millisecond
|
s.searchWait = 200 * time.Millisecond
|
||||||
s.transferPoll = time.Millisecond
|
s.transferPoll = time.Millisecond
|
||||||
|
|
||||||
// Long enough that no existing test trips them by accident; the
|
|
||||||
// tests about stalls and absences set their own.
|
|
||||||
s.stallAfter = time.Minute
|
|
||||||
s.absentGrace = time.Minute
|
|
||||||
|
|
||||||
return s, downloads
|
return s, downloads
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -642,293 +565,3 @@ func TestSlskdRequiresConfiguration(t *testing.T) {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// slskdAlbum is a two-file candidate from peer, with the files slskd
|
|
||||||
// would have written already in place under downloads.
|
|
||||||
func slskdAlbum(t *testing.T, downloads, peer string, arrived ...string) Candidate {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
folder := filepath.Join(downloads, "Album")
|
|
||||||
if err := os.MkdirAll(folder, 0o750); err != nil {
|
|
||||||
t.Fatalf("mkdir: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, name := range arrived {
|
|
||||||
if err := os.WriteFile(
|
|
||||||
filepath.Join(folder, name), []byte("audio"), 0o600,
|
|
||||||
); err != nil {
|
|
||||||
t.Fatalf("write: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return Candidate{
|
|
||||||
Files: []CandidateFile{
|
|
||||||
{Path: `\s\Album\01 A.flac`, Size: 500, IsAudio: true},
|
|
||||||
{Path: `\s\Album\02 B.flac`, Size: 500, IsAudio: true},
|
|
||||||
},
|
|
||||||
TotalSize: 1000,
|
|
||||||
Payload: map[string]string{"username": peer},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// cancelledURIs returns what the stub was asked to cancel.
|
|
||||||
func (s *slskdStub) cancelledURIs() []string {
|
|
||||||
s.mu.Lock()
|
|
||||||
defer s.mu.Unlock()
|
|
||||||
|
|
||||||
return append([]string(nil), s.cancelled...)
|
|
||||||
}
|
|
||||||
|
|
||||||
// A peer that queues us and never sends a byte is given up on, and the
|
|
||||||
// queued transfers are cancelled in slskd rather than left to start
|
|
||||||
// hours later for a request nobody is waiting on.
|
|
||||||
func TestSlskdGrabGivesUpOnAStalledPeer(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
stub := newSlskdStub(t)
|
|
||||||
stub.transfers = [][]slskdTransfer{{
|
|
||||||
{ID: "t1", Filename: `\s\Album\01 A.flac`, State: "Queued, Remotely"},
|
|
||||||
{ID: "t2", Filename: `\s\Album\02 B.flac`, State: "Queued, Remotely"},
|
|
||||||
}}
|
|
||||||
|
|
||||||
s, downloads := newStubSlskd(t, stub)
|
|
||||||
s.stallAfter = 30 * time.Millisecond
|
|
||||||
|
|
||||||
_, err := s.Grab(
|
|
||||||
context.Background(), slskdAlbum(t, downloads, "peer"), t.TempDir(), nil,
|
|
||||||
)
|
|
||||||
if !errors.Is(err, ErrSlskdTimeout) {
|
|
||||||
t.Fatalf("error = %v, want ErrSlskdTimeout", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
got := stub.cancelledURIs()
|
|
||||||
if len(got) != 2 {
|
|
||||||
t.Fatalf("cancelled %v, want both queued transfers", got)
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, uri := range got {
|
|
||||||
if !strings.HasSuffix(uri, "?remove=true") {
|
|
||||||
t.Errorf("cancel %s does not remove the record", uri)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// A folder that stalls on its last track goes forward with what
|
|
||||||
// arrived, the same as one whose last track failed; the importer's
|
|
||||||
// completeness check decides whether that is enough.
|
|
||||||
func TestSlskdGrabKeepsWhatArrivedBeforeAStall(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
stub := newSlskdStub(t)
|
|
||||||
stub.transfers = [][]slskdTransfer{{
|
|
||||||
{
|
|
||||||
ID: "t1", Filename: `\s\Album\01 A.flac`,
|
|
||||||
State: "Completed, Succeeded", BytesTransferred: 500,
|
|
||||||
},
|
|
||||||
{ID: "t2", Filename: `\s\Album\02 B.flac`, State: "Queued, Remotely"},
|
|
||||||
}}
|
|
||||||
|
|
||||||
s, downloads := newStubSlskd(t, stub)
|
|
||||||
s.stallAfter = 30 * time.Millisecond
|
|
||||||
|
|
||||||
got, err := s.Grab(
|
|
||||||
context.Background(),
|
|
||||||
slskdAlbum(t, downloads, "peer", "01 A.flac"),
|
|
||||||
t.TempDir(), nil,
|
|
||||||
)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Grab: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(got.Files) != 1 {
|
|
||||||
t.Errorf("collected %d files, want the 1 that arrived", len(got.Files))
|
|
||||||
}
|
|
||||||
|
|
||||||
if cancelled := stub.cancelledURIs(); len(cancelled) != 1 ||
|
|
||||||
!strings.Contains(cancelled[0], "/t2") {
|
|
||||||
t.Errorf("cancelled %v, want only the stalled t2", cancelled)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Progress is what holds the stall timer off. A transfer that keeps
|
|
||||||
// moving bytes is never abandoned, however long it takes.
|
|
||||||
func TestSlskdGrabWaitsOnATransferThatIsMoving(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
stub := newSlskdStub(t)
|
|
||||||
|
|
||||||
for b := int64(1); b <= 100; b++ {
|
|
||||||
stub.transfers = append(stub.transfers, []slskdTransfer{
|
|
||||||
{ID: "t1", Filename: `\s\Album\01 A.flac`, State: "InProgress", BytesTransferred: b},
|
|
||||||
{ID: "t2", Filename: `\s\Album\02 B.flac`, State: "Queued, Remotely"},
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
stub.transfers = append(stub.transfers, []slskdTransfer{
|
|
||||||
{
|
|
||||||
ID: "t1",
|
|
||||||
Filename: `\s\Album\01 A.flac`,
|
|
||||||
State: "Completed, Succeeded",
|
|
||||||
BytesTransferred: 500,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
ID: "t2",
|
|
||||||
Filename: `\s\Album\02 B.flac`,
|
|
||||||
State: "Completed, Succeeded",
|
|
||||||
BytesTransferred: 500,
|
|
||||||
},
|
|
||||||
})
|
|
||||||
|
|
||||||
s, downloads := newStubSlskd(t, stub)
|
|
||||||
// A hundred polls take several times the stall window; each one
|
|
||||||
// moves a byte. The window is kept well above one poll so a
|
|
||||||
// descheduled test runner does not read as a stall.
|
|
||||||
s.transferPoll = 5 * time.Millisecond
|
|
||||||
s.stallAfter = 150 * time.Millisecond
|
|
||||||
|
|
||||||
got, err := s.Grab(
|
|
||||||
context.Background(),
|
|
||||||
slskdAlbum(t, downloads, "peer", "01 A.flac", "02 B.flac"),
|
|
||||||
t.TempDir(), nil,
|
|
||||||
)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Grab: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(got.Files) != 2 {
|
|
||||||
t.Errorf("collected %d files, want 2", len(got.Files))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// A file slskd never lists was refused at enqueue and will never reach
|
|
||||||
// a terminal state. It counts as failed once the grace period is up,
|
|
||||||
// rather than being waited on until the six-hour ceiling.
|
|
||||||
func TestSlskdGrabCountsAnUnlistedFileAsFailed(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
stub := newSlskdStub(t)
|
|
||||||
stub.transfers = [][]slskdTransfer{{
|
|
||||||
{
|
|
||||||
ID: "t1", Filename: `\s\Album\01 A.flac`,
|
|
||||||
State: "Completed, Succeeded", BytesTransferred: 500,
|
|
||||||
},
|
|
||||||
}}
|
|
||||||
|
|
||||||
s, downloads := newStubSlskd(t, stub)
|
|
||||||
s.absentGrace = 20 * time.Millisecond
|
|
||||||
|
|
||||||
got, err := s.Grab(
|
|
||||||
context.Background(),
|
|
||||||
slskdAlbum(t, downloads, "peer", "01 A.flac"),
|
|
||||||
t.TempDir(), nil,
|
|
||||||
)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Grab: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(got.Files) != 1 {
|
|
||||||
t.Errorf("collected %d files, want 1", len(got.Files))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// A finished record left by an earlier attempt at the same file is not
|
|
||||||
// this attempt's answer. Without the snapshot it would fail the grab on
|
|
||||||
// the first poll, before the new transfer had started.
|
|
||||||
func TestSlskdGrabIgnoresAnEarlierAttemptsRecord(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
stale := slskdTransfer{
|
|
||||||
ID: "old", Filename: `\s\Album\01 A.flac`, State: "Completed, Errored",
|
|
||||||
}
|
|
||||||
|
|
||||||
stub := newSlskdStub(t)
|
|
||||||
stub.before = []slskdTransfer{stale}
|
|
||||||
stub.transfers = [][]slskdTransfer{
|
|
||||||
{stale},
|
|
||||||
{
|
|
||||||
stale,
|
|
||||||
{
|
|
||||||
ID: "new", Filename: `\s\Album\01 A.flac`,
|
|
||||||
State: "Completed, Succeeded", BytesTransferred: 500,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
s, downloads := newStubSlskd(t, stub)
|
|
||||||
|
|
||||||
c := slskdAlbum(t, downloads, "peer", "01 A.flac")
|
|
||||||
c.Files = c.Files[:1]
|
|
||||||
|
|
||||||
got, err := s.Grab(context.Background(), c, t.TempDir(), nil)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Grab: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(got.Files) != 1 {
|
|
||||||
t.Errorf("collected %d files, want 1", len(got.Files))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Cancelling the download cancels the transfer in slskd too. The
|
|
||||||
// cleanup must not inherit the cancelled context, or it is never sent.
|
|
||||||
func TestSlskdGrabCancelsTransfersWhenTheCallerGivesUp(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
stub := newSlskdStub(t)
|
|
||||||
stub.transfers = [][]slskdTransfer{{
|
|
||||||
{ID: "t1", Filename: `\s\Album\01 A.flac`, State: "InProgress", BytesTransferred: 10},
|
|
||||||
{ID: "t2", Filename: `\s\Album\02 B.flac`, State: "Queued, Remotely"},
|
|
||||||
}}
|
|
||||||
|
|
||||||
s, downloads := newStubSlskd(t, stub)
|
|
||||||
|
|
||||||
ctx, cancel := context.WithTimeout(context.Background(), 50*time.Millisecond)
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
_, err := s.Grab(ctx, slskdAlbum(t, downloads, "peer"), t.TempDir(), nil)
|
|
||||||
if !errors.Is(err, ErrSlskdTimeout) {
|
|
||||||
t.Fatalf("error = %v, want ErrSlskdTimeout", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if got := stub.cancelledURIs(); len(got) != 2 {
|
|
||||||
t.Errorf("cancelled %v, want both live transfers", got)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Soulseek usernames carry spaces and punctuation; spliced raw into the
|
|
||||||
// path, a name with a slash addresses a different endpoint entirely.
|
|
||||||
func TestSlskdEscapesTheUsername(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
stub := newSlskdStub(t)
|
|
||||||
stub.transfers = [][]slskdTransfer{{
|
|
||||||
{
|
|
||||||
ID: "t1", Filename: `\s\Album\01 A.flac`,
|
|
||||||
State: "Completed, Succeeded", BytesTransferred: 500,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
ID: "t2", Filename: `\s\Album\02 B.flac`,
|
|
||||||
State: "Completed, Succeeded", BytesTransferred: 500,
|
|
||||||
},
|
|
||||||
}}
|
|
||||||
|
|
||||||
s, downloads := newStubSlskd(t, stub)
|
|
||||||
|
|
||||||
if _, err := s.Grab(
|
|
||||||
context.Background(),
|
|
||||||
slskdAlbum(t, downloads, "dj a/b", "01 A.flac", "02 B.flac"),
|
|
||||||
t.TempDir(), nil,
|
|
||||||
); err != nil {
|
|
||||||
t.Fatalf("Grab: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
stub.mu.Lock()
|
|
||||||
paths := append([]string(nil), stub.paths...)
|
|
||||||
stub.mu.Unlock()
|
|
||||||
|
|
||||||
for _, p := range paths {
|
|
||||||
if p != "/api/v0/transfers/downloads/dj%20a%2Fb" {
|
|
||||||
t.Errorf("transfers call went to %s", p)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
+18
-104
@@ -35,15 +35,6 @@ const (
|
|||||||
weightArtistFit = 0.12
|
weightArtistFit = 0.12
|
||||||
)
|
)
|
||||||
|
|
||||||
// Match sub-weights when the candidate's durations are known. Duration
|
|
||||||
// takes its weight from title fit, the signal it corroborates: a title
|
|
||||||
// says which song a file claims to be, a length says whether it is that
|
|
||||||
// recording — the right edit, the whole file, not the live take.
|
|
||||||
const (
|
|
||||||
timedWeightTitleFit = 0.25
|
|
||||||
timedWeightDurationFit = 0.15
|
|
||||||
)
|
|
||||||
|
|
||||||
// Quality sub-weights. Each set sums to 1.0.
|
// Quality sub-weights. Each set sums to 1.0.
|
||||||
//
|
//
|
||||||
// There are two of them because a stated preference changes what the
|
// There are two of them because a stated preference changes what the
|
||||||
@@ -328,13 +319,13 @@ func Score(dl Download, c Candidate, priority int, prefs AutoDownloadPrefs) Cand
|
|||||||
|
|
||||||
audio := c.AudioFiles()
|
audio := c.AudioFiles()
|
||||||
|
|
||||||
a := alignFiles(audio, dl.Expected)
|
matched, titleFit := matchFiles(audio, dl.Expected)
|
||||||
|
|
||||||
// Write the alignment back so the picker can show which file maps
|
// Write the alignment back so the picker can show which file maps
|
||||||
// to which track.
|
// to which track.
|
||||||
c.Files = mergeMatched(c.Files, a.files)
|
c.Files = mergeMatched(c.Files, matched)
|
||||||
|
|
||||||
c.Match = scoreMatch(dl, c, audio, a)
|
c.Match = scoreMatch(dl, c, audio, titleFit)
|
||||||
c.Quality = scoreQuality(
|
c.Quality = scoreQuality(
|
||||||
c, audio, priority, prefs, dl.runtimeMillis(),
|
c, audio, priority, prefs, dl.runtimeMillis(),
|
||||||
)
|
)
|
||||||
@@ -349,21 +340,14 @@ func scoreMatch(
|
|||||||
dl Download,
|
dl Download,
|
||||||
c Candidate,
|
c Candidate,
|
||||||
audio []CandidateFile,
|
audio []CandidateFile,
|
||||||
a alignment,
|
titleFit float64,
|
||||||
) MatchScore {
|
) MatchScore {
|
||||||
m := MatchScore{
|
m := MatchScore{
|
||||||
Anchored: dl.Anchored(),
|
Anchored: dl.Anchored(),
|
||||||
TitleFit: a.titleFit,
|
TitleFit: titleFit,
|
||||||
DurationFit: a.durationFit,
|
|
||||||
|
|
||||||
// Durations count once at least half the aligned pairs state
|
|
||||||
// one; a single timed pair would be a coin toss carrying 15%.
|
|
||||||
DurationKnown: a.timedPairs > 0 && a.timedPairs*2 >= a.aligned,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
m.Completeness = completeness(
|
m.Completeness = completeness(len(audio), len(dl.Expected))
|
||||||
alignedCount(c.Files), len(audio), len(dl.Expected),
|
|
||||||
)
|
|
||||||
|
|
||||||
// The candidate's own title, and the folder its files sit in, are
|
// The candidate's own title, and the folder its files sit in, are
|
||||||
// two independent guesses at the album name. Take the better one:
|
// two independent guesses at the album name. Take the better one:
|
||||||
@@ -383,16 +367,9 @@ func scoreMatch(
|
|||||||
// With no expected tracklist there is no title signal at all, so
|
// With no expected tracklist there is no title signal at all, so
|
||||||
// redistribute its weight onto the album/artist evidence rather
|
// redistribute its weight onto the album/artist evidence rather
|
||||||
// than scoring every free-text result as half-wrong.
|
// than scoring every free-text result as half-wrong.
|
||||||
switch {
|
if len(dl.Expected) == 0 {
|
||||||
case len(dl.Expected) == 0:
|
|
||||||
m.Overall = 0.55*m.AlbumFit + 0.45*m.ArtistFit
|
m.Overall = 0.55*m.AlbumFit + 0.45*m.ArtistFit
|
||||||
case m.DurationKnown:
|
} else {
|
||||||
m.Overall = timedWeightTitleFit*m.TitleFit +
|
|
||||||
timedWeightDurationFit*m.DurationFit +
|
|
||||||
weightCompleteness*m.Completeness +
|
|
||||||
weightAlbumFit*m.AlbumFit +
|
|
||||||
weightArtistFit*m.ArtistFit
|
|
||||||
default:
|
|
||||||
m.Overall = weightTitleFit*m.TitleFit +
|
m.Overall = weightTitleFit*m.TitleFit +
|
||||||
weightCompleteness*m.Completeness +
|
weightCompleteness*m.Completeness +
|
||||||
weightAlbumFit*m.AlbumFit +
|
weightAlbumFit*m.AlbumFit +
|
||||||
@@ -438,54 +415,30 @@ func artistFit(want string, c Candidate) float64 {
|
|||||||
return best
|
return best
|
||||||
}
|
}
|
||||||
|
|
||||||
// completeness scores how much of the expected tracklist a candidate
|
// completeness scores audio file count against the expected track
|
||||||
// covers. Extra files are penalized far more gently than missing ones:
|
// count. Extra files are penalized far more gently than missing ones:
|
||||||
// a folder with bonus tracks or a stray intro is still the album, while
|
// a folder with bonus tracks or a stray intro is still the album, while
|
||||||
// a folder missing half the tracks is not.
|
// a folder missing half the tracks is not.
|
||||||
//
|
func completeness(got, want int) float64 {
|
||||||
// **Coverage is counted in aligned tracks, not in files.** It used to
|
|
||||||
// be the audio file count, so any ten files scored full marks against
|
|
||||||
// a ten-track album whether or not they were its tracks — and since
|
|
||||||
// title fit is the mean over the files that *did* align, a folder where
|
|
||||||
// three titles matched read as a near-perfect candidate on both counts.
|
|
||||||
// `aligned` is how many files matchFiles assigned to an expected track;
|
|
||||||
// `audio` still sets the penalty for extras, because a folder of thirty
|
|
||||||
// files holding the ten wanted is a worse copy than one holding ten.
|
|
||||||
func completeness(aligned, audio, want int) float64 {
|
|
||||||
if want == 0 {
|
if want == 0 {
|
||||||
if audio > 0 {
|
if got > 0 {
|
||||||
return 0.5
|
return 0.5
|
||||||
}
|
}
|
||||||
|
|
||||||
return 0
|
return 0
|
||||||
}
|
}
|
||||||
|
|
||||||
if aligned == 0 {
|
if got == 0 {
|
||||||
return 0
|
return 0
|
||||||
}
|
}
|
||||||
|
|
||||||
cover := float64(min(aligned, want)) / float64(want)
|
if got >= want {
|
||||||
|
extra := float64(got-want) / float64(want)
|
||||||
|
|
||||||
if audio > want {
|
return math.Max(0.75, 1.0-0.25*extra)
|
||||||
extra := float64(audio-want) / float64(want)
|
|
||||||
cover *= math.Max(0.75, 1.0-0.25*extra)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return cover
|
return float64(got) / float64(want)
|
||||||
}
|
|
||||||
|
|
||||||
// alignedCount is how many audio files were assigned to an expected
|
|
||||||
// track.
|
|
||||||
func alignedCount(files []CandidateFile) int {
|
|
||||||
n := 0
|
|
||||||
|
|
||||||
for _, f := range files {
|
|
||||||
if f.IsAudio && f.MatchedTo != 0 {
|
|
||||||
n++
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return n
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// scoreQuality answers whether this is a good copy.
|
// scoreQuality answers whether this is a good copy.
|
||||||
@@ -782,45 +735,6 @@ func AutoPickVeto(
|
|||||||
return ""
|
return ""
|
||||||
}
|
}
|
||||||
|
|
||||||
// autoAcceptable reports whether auto-pick may take this one candidate
|
|
||||||
// without asking: the request is anchored to a tracklist, and the
|
|
||||||
// candidate is inside the user's guardrails and clears the match and
|
|
||||||
// quality bars. It is AutoPickVeto's test applied to a single
|
|
||||||
// candidate, which is what falling back to a second choice needs.
|
|
||||||
func autoAcceptable(dl Download, c Candidate, prefs AutoDownloadPrefs) bool {
|
|
||||||
return dl.Anchored() &&
|
|
||||||
len(dl.Expected) > 0 &&
|
|
||||||
prefs.eligible(c, dl.runtimeMillis()) &&
|
|
||||||
c.Match.Overall >= minMatch &&
|
|
||||||
c.Quality.Overall >= minQuality
|
|
||||||
}
|
|
||||||
|
|
||||||
// autoPick returns the candidate auto-pick takes: the best-ranked one
|
|
||||||
// it may take at all.
|
|
||||||
//
|
|
||||||
// That is not `ranked[0]`. AutoPickVeto judges the best candidate
|
|
||||||
// *inside* the guardrails, so when the overall best is outside them —
|
|
||||||
// over the size ceiling, say — the veto passes on the strength of the
|
|
||||||
// second, and grabbing the first would download exactly the copy the
|
|
||||||
// user said not to take unattended.
|
|
||||||
func autoPick(
|
|
||||||
dl Download,
|
|
||||||
ranked []Candidate,
|
|
||||||
prefs AutoDownloadPrefs,
|
|
||||||
) (Candidate, bool) {
|
|
||||||
if AutoPickVeto(dl, ranked, prefs) != "" {
|
|
||||||
return Candidate{}, false
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, c := range ranked {
|
|
||||||
if autoAcceptable(dl, c, prefs) {
|
|
||||||
return c, true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return Candidate{}, false
|
|
||||||
}
|
|
||||||
|
|
||||||
// mergeMatched copies MatchedTo assignments from the audio-only slice
|
// mergeMatched copies MatchedTo assignments from the audio-only slice
|
||||||
// back onto the full file list.
|
// back onto the full file list.
|
||||||
func mergeMatched(all, matched []CandidateFile) []CandidateFile {
|
func mergeMatched(all, matched []CandidateFile) []CandidateFile {
|
||||||
|
|||||||
@@ -282,32 +282,28 @@ func TestCompleteness(t *testing.T) {
|
|||||||
|
|
||||||
tests := []struct {
|
tests := []struct {
|
||||||
name string
|
name string
|
||||||
aligned int
|
got int
|
||||||
audio int
|
|
||||||
want int
|
want int
|
||||||
minScore float64
|
minScore float64
|
||||||
maxScore float64
|
maxScore float64
|
||||||
}{
|
}{
|
||||||
{"exact", 10, 10, 10, 1.0, 1.0},
|
{"exact", 10, 10, 1.0, 1.0},
|
||||||
{"half missing", 5, 5, 10, 0.49, 0.51},
|
{"half missing", 5, 10, 0.49, 0.51},
|
||||||
{"one bonus track", 10, 11, 10, 0.95, 1.0},
|
{"one bonus track", 11, 10, 0.95, 1.0},
|
||||||
{"double", 10, 20, 10, 0.74, 0.76},
|
{"double", 20, 10, 0.74, 0.76},
|
||||||
{"nothing", 0, 0, 10, 0, 0},
|
{"nothing", 0, 10, 0, 0},
|
||||||
{"no expectation", 0, 5, 0, 0.5, 0.5},
|
{"no expectation", 5, 0, 0.5, 0.5},
|
||||||
// Ten files are not ten tracks: three that align are three.
|
|
||||||
{"right count, wrong tracks", 3, 10, 10, 0.29, 0.31},
|
|
||||||
{"files that align to nothing", 0, 10, 10, 0, 0},
|
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, tt := range tests {
|
for _, tt := range tests {
|
||||||
t.Run(tt.name, func(t *testing.T) {
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
got := completeness(tt.aligned, tt.audio, tt.want)
|
got := completeness(tt.got, tt.want)
|
||||||
if got < tt.minScore || got > tt.maxScore {
|
if got < tt.minScore || got > tt.maxScore {
|
||||||
t.Errorf(
|
t.Errorf(
|
||||||
"completeness(%d, %d, %d) = %f, want in [%f, %f]",
|
"completeness(%d, %d) = %f, want in [%f, %f]",
|
||||||
tt.aligned, tt.audio, tt.want, got, tt.minScore, tt.maxScore,
|
tt.got, tt.want, got, tt.minScore, tt.maxScore,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -1,238 +0,0 @@
|
|||||||
package download
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
)
|
|
||||||
|
|
||||||
// What Soulseek is asked, how, and what is kept from the answer (#271).
|
|
||||||
|
|
||||||
func TestSlskdQueries(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
cases := []struct {
|
|
||||||
name string
|
|
||||||
dl Download
|
|
||||||
want []string
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
name: "a plain request is searched once",
|
|
||||||
dl: Download{Artist: "Radiohead", Album: "OK Computer"},
|
|
||||||
want: []string{"Radiohead OK Computer"},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "an edition qualifier gets a second query without it",
|
|
||||||
dl: Download{Artist: "Radiohead", Album: "OK Computer (Collector's Edition)"},
|
|
||||||
want: []string{
|
|
||||||
"Radiohead OK Computer (Collector's Edition)",
|
|
||||||
"Radiohead OK Computer",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "a trailing remaster note",
|
|
||||||
dl: Download{Artist: "Pink Floyd", Album: "Animals - 2018 Remaster"},
|
|
||||||
want: []string{
|
|
||||||
"Pink Floyd Animals - 2018 Remaster",
|
|
||||||
"Pink Floyd Animals",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "a leading dash would be an exclusion",
|
|
||||||
dl: Download{Artist: "Mocky", Album: "-ism"},
|
|
||||||
want: []string{"Mocky -ism", "Mocky ism"},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "a compilation is not searched by its placeholder artist",
|
|
||||||
dl: Download{Artist: "Various Artists", Album: "Pulp Fiction"},
|
|
||||||
want: []string{"Various Artists Pulp Fiction", "Pulp Fiction"},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "what the user typed is searched as written",
|
|
||||||
dl: Download{Query: "ok computer (deluxe)", Album: "OK Computer (Deluxe)"},
|
|
||||||
want: []string{"ok computer (deluxe)"},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range cases {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
got := slskdQueries(tc.dl)
|
|
||||||
if strings.Join(got, "|") != strings.Join(tc.want, "|") {
|
|
||||||
t.Errorf("slskdQueries = %q, want %q", got, tc.want)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Both queries run, the options are stated rather than left to the
|
|
||||||
// daemon's defaults, and a folder both queries found is one candidate.
|
|
||||||
func TestSlskdSearchRunsBothQueriesAndMerges(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
stub := newSlskdStub(t)
|
|
||||||
stub.responses = []slskdResponse{{
|
|
||||||
Username: "peer",
|
|
||||||
Files: []slskdFile{
|
|
||||||
{Filename: `\m\Radiohead - OK Computer\01 Airbag.flac`, Size: 1, Length: 284},
|
|
||||||
{Filename: `\m\Radiohead - OK Computer\02 Paranoid Android.flac`, Size: 1, Length: 383},
|
|
||||||
},
|
|
||||||
}}
|
|
||||||
|
|
||||||
s, _ := newStubSlskd(t, stub)
|
|
||||||
|
|
||||||
got, err := s.Search(context.Background(), Download{
|
|
||||||
ReleaseMBID: "rel", Artist: "Radiohead", Album: "OK Computer (Deluxe Edition)",
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Search: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(got) != 1 {
|
|
||||||
t.Fatalf("got %d candidates, want the one folder once", len(got))
|
|
||||||
}
|
|
||||||
|
|
||||||
if got[0].Files[0].LengthMillis != 284_000 {
|
|
||||||
t.Errorf("length = %d ms, want 284000 from slskd's seconds", got[0].Files[0].LengthMillis)
|
|
||||||
}
|
|
||||||
|
|
||||||
stub.mu.Lock()
|
|
||||||
searches := append([]map[string]any(nil), stub.searches...)
|
|
||||||
gets := append([]string(nil), stub.searchGets...)
|
|
||||||
stub.mu.Unlock()
|
|
||||||
|
|
||||||
if len(searches) != 2 {
|
|
||||||
t.Fatalf("ran %d searches, want 2", len(searches))
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, body := range searches {
|
|
||||||
for _, key := range []string{
|
|
||||||
"searchTimeout", "responseLimit", "fileLimit",
|
|
||||||
"minimumResponseFileCount", "maximumPeerQueueLength",
|
|
||||||
} {
|
|
||||||
if _, ok := body[key]; !ok {
|
|
||||||
t.Errorf("search %q does not state %s", body["searchText"], key)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// The responses are fetched once at the end, not with every poll.
|
|
||||||
for _, uri := range gets {
|
|
||||||
if strings.Contains(uri, "includeResponses") {
|
|
||||||
t.Errorf("poll %s asked for every response", uri)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// A daemon without the responses endpoint still returns results.
|
|
||||||
func TestSlskdSearchFallsBackForAnOlderDaemon(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
stub := newSlskdStub(t)
|
|
||||||
stub.noResponsesEndpoint = true
|
|
||||||
stub.responses = []slskdResponse{{
|
|
||||||
Username: "peer",
|
|
||||||
Files: []slskdFile{
|
|
||||||
{Filename: `\m\Album\01 A.flac`, Size: 1},
|
|
||||||
{Filename: `\m\Album\02 B.flac`, Size: 1},
|
|
||||||
},
|
|
||||||
}}
|
|
||||||
|
|
||||||
s, _ := newStubSlskd(t, stub)
|
|
||||||
|
|
||||||
got, err := s.Search(context.Background(), Download{Query: "album"})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Search: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(got) != 1 {
|
|
||||||
t.Errorf("got %d candidates, want 1 through the fallback", len(got))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDurationAgreement(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
cases := []struct {
|
|
||||||
got, want int64
|
|
||||||
score float64
|
|
||||||
}{
|
|
||||||
{300_000, 300_000, 1},
|
|
||||||
{301_500, 300_000, 1}, // a second of silence
|
|
||||||
{300_000, 316_500, 0.5},
|
|
||||||
{300_000, 345_000, 0}, // a different edit
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range cases {
|
|
||||||
if got := durationAgreement(tc.got, tc.want); got < tc.score-0.01 || got > tc.score+0.01 {
|
|
||||||
t.Errorf("durationAgreement(%d, %d) = %f, want %f", tc.got, tc.want, got, tc.score)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Two folders with the same track names are told apart by their
|
|
||||||
// lengths: one is the album, the other a live record of the same songs.
|
|
||||||
func TestDurationsSeparateTheRightRecording(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
dl := okComputer()
|
|
||||||
|
|
||||||
timed := func(id string, lengths ...int64) Candidate {
|
|
||||||
c := candidateFor(id, allTitles(), ".flac", 30_000_000)
|
|
||||||
for i := range c.Files {
|
|
||||||
c.Files[i].LengthMillis = lengths[i]
|
|
||||||
}
|
|
||||||
|
|
||||||
return c
|
|
||||||
}
|
|
||||||
|
|
||||||
studio := timed("studio", trackMillis, trackMillis+1_000, trackMillis, trackMillis-500)
|
|
||||||
live := timed(
|
|
||||||
"live",
|
|
||||||
trackMillis+60_000,
|
|
||||||
trackMillis+75_000,
|
|
||||||
trackMillis+50_000,
|
|
||||||
trackMillis+90_000,
|
|
||||||
)
|
|
||||||
|
|
||||||
ranked := Rank(dl, []Candidate{live, studio}, nil, AutoDownloadPrefs{})
|
|
||||||
|
|
||||||
if ranked[0].ID != "studio" {
|
|
||||||
t.Fatalf("winner = %s, want the recording whose lengths match", ranked[0].ID)
|
|
||||||
}
|
|
||||||
|
|
||||||
if !ranked[0].Match.DurationKnown || ranked[0].Match.DurationFit < 0.99 {
|
|
||||||
t.Errorf(
|
|
||||||
"studio duration fit = %f known=%v",
|
|
||||||
ranked[0].Match.DurationFit,
|
|
||||||
ranked[0].Match.DurationKnown,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
if ranked[1].Match.DurationFit != 0 {
|
|
||||||
t.Errorf("live duration fit = %f, want 0", ranked[1].Match.DurationFit)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Without lengths the score is exactly what it was before durations
|
|
||||||
// were read, so a provider that reports none is not penalised.
|
|
||||||
func TestUnknownDurationsLeaveTheScoreAlone(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
dl := okComputer()
|
|
||||||
c := Score(dl, candidateFor("c", allTitles(), ".flac", 30_000_000), 50, AutoDownloadPrefs{})
|
|
||||||
|
|
||||||
if c.Match.DurationKnown {
|
|
||||||
t.Fatal("no file states a length, yet durations are known")
|
|
||||||
}
|
|
||||||
|
|
||||||
want := weightTitleFit*c.Match.TitleFit +
|
|
||||||
weightCompleteness*c.Match.Completeness +
|
|
||||||
weightAlbumFit*c.Match.AlbumFit +
|
|
||||||
weightArtistFit*c.Match.ArtistFit
|
|
||||||
|
|
||||||
if c.Match.Overall != want {
|
|
||||||
t.Errorf("match = %f, want the untimed formula's %f", c.Match.Overall, want)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -232,17 +232,12 @@ type Candidate struct {
|
|||||||
// results give paths and sizes but no tags, so Format and duration are
|
// results give paths and sizes but no tags, so Format and duration are
|
||||||
// inferred from the path and size where possible.
|
// inferred from the path and size where possible.
|
||||||
type CandidateFile struct {
|
type CandidateFile struct {
|
||||||
Path string `json:"path"`
|
Path string `json:"path"`
|
||||||
Size int64 `json:"size"`
|
Size int64 `json:"size"`
|
||||||
Format Format `json:"format"`
|
Format Format `json:"format"`
|
||||||
Bitrate int `json:"bitrate,omitempty"` // kbps, 0 when unknown
|
Bitrate int `json:"bitrate,omitempty"` // kbps, 0 when unknown
|
||||||
IsAudio bool `json:"isAudio"`
|
IsAudio bool `json:"isAudio"`
|
||||||
|
MatchedTo int `json:"matchedTo,omitempty"` // expected track position
|
||||||
// LengthMillis is the file's duration as the source reports it, or
|
|
||||||
// 0 when it does not. Soulseek reports it for most audio files.
|
|
||||||
LengthMillis int64 `json:"lengthMillis,omitempty"`
|
|
||||||
|
|
||||||
MatchedTo int `json:"matchedTo,omitempty"` // expected track position
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Format is a normalized audio container/codec name.
|
// Format is a normalized audio container/codec name.
|
||||||
@@ -291,14 +286,7 @@ type MatchScore struct {
|
|||||||
TitleFit float64 `json:"titleFit"` // filenames vs expected titles
|
TitleFit float64 `json:"titleFit"` // filenames vs expected titles
|
||||||
ArtistFit float64 `json:"artistFit"` // path/origin vs expected artist
|
ArtistFit float64 `json:"artistFit"` // path/origin vs expected artist
|
||||||
AlbumFit float64 `json:"albumFit"` // folder name vs album title
|
AlbumFit float64 `json:"albumFit"` // folder name vs album title
|
||||||
Completeness float64 `json:"completeness"` // aligned tracks vs expected count
|
Completeness float64 `json:"completeness"` // audio files vs expected count
|
||||||
|
|
||||||
// DurationFit is how well the aligned files' lengths agree with the
|
|
||||||
// expected tracks', and DurationKnown whether enough of them stated
|
|
||||||
// a length for that to count. When it does not, the score is the
|
|
||||||
// four text signals alone, exactly as before durations were read.
|
|
||||||
DurationFit float64 `json:"durationFit"`
|
|
||||||
DurationKnown bool `json:"durationKnown"`
|
|
||||||
|
|
||||||
// Anchored records whether an MBID drove this score. Unanchored
|
// Anchored records whether an MBID drove this score. Unanchored
|
||||||
// matches are capped, because there is nothing to be right about.
|
// matches are capped, because there is nothing to be right about.
|
||||||
|
|||||||
+17
-11
@@ -383,9 +383,13 @@ func (si *SearchIndex) topByPopularity(
|
|||||||
// MusicBrainz IDs, so this never touches the library tables and asks
|
// MusicBrainz IDs, so this never touches the library tables and asks
|
||||||
// one query rather than one per artist.
|
// one query rather than one per artist.
|
||||||
//
|
//
|
||||||
// The artists are drawn most-popular-owned-album first, so a large
|
// **The row is drawn at random, and that is the whole point of it.**
|
||||||
// library's pool is the part of it the user is likeliest to recognise
|
// Ordered by popularity it was a second leaderboard: the same handful of
|
||||||
// rather than whichever artists sort first.
|
// big names appeared every time the page opened, which is not what "you
|
||||||
|
// own one album by these artists" is saying. The pool is still bounded
|
||||||
|
// to `pool` artists — a 4 000-artist library does not need all of them
|
||||||
|
// ranked — but which of them, and which of their albums, is `RANDOM()`,
|
||||||
|
// so the shelf is a different sample each visit.
|
||||||
func (si *SearchIndex) unownedAlbumsBySinglyOwnedArtists(
|
func (si *SearchIndex) unownedAlbumsBySinglyOwnedArtists(
|
||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
pool, limit int,
|
pool, limit int,
|
||||||
@@ -396,15 +400,17 @@ func (si *SearchIndex) unownedAlbumsBySinglyOwnedArtists(
|
|||||||
WHERE entity_type = 2 /* release_group */
|
WHERE entity_type = 2 /* release_group */
|
||||||
AND in_library = 0
|
AND in_library = 0
|
||||||
AND artist_mbid IN (
|
AND artist_mbid IN (
|
||||||
SELECT artist_mbid FROM explore_index
|
SELECT artist_mbid FROM (
|
||||||
WHERE entity_type = 2 /* release_group */
|
SELECT artist_mbid FROM explore_index
|
||||||
AND in_library = 1
|
WHERE entity_type = 2 /* release_group */
|
||||||
AND artist_mbid != x''
|
AND in_library = 1
|
||||||
GROUP BY artist_mbid
|
AND artist_mbid != x''
|
||||||
HAVING COUNT(*) = 1
|
GROUP BY artist_mbid
|
||||||
ORDER BY MAX(popularity) DESC
|
HAVING COUNT(*) = 1
|
||||||
|
)
|
||||||
|
ORDER BY RANDOM()
|
||||||
LIMIT ?)
|
LIMIT ?)
|
||||||
ORDER BY popularity DESC
|
ORDER BY RANDOM()
|
||||||
LIMIT ?`,
|
LIMIT ?`,
|
||||||
pool, limit,
|
pool, limit,
|
||||||
))
|
))
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ package explore
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
|
"sort"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"yellowjacket/backend/database"
|
"yellowjacket/backend/database"
|
||||||
@@ -202,6 +203,11 @@ func TestShelves_MoreFromOwnedNeedsExactlyOneOwnedAlbum(t *testing.T) {
|
|||||||
titles = append(titles, album.Title)
|
titles = append(titles, album.Title)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The row is a random sample, so the *set* is what is asserted and
|
||||||
|
// not the order — see `unownedAlbumsBySinglyOwnedArtists` for why
|
||||||
|
// the ordering was given up.
|
||||||
|
sort.Strings(titles)
|
||||||
|
|
||||||
if len(titles) != 2 || titles[0] != "Second" || titles[1] != "Third" {
|
if len(titles) != 2 || titles[0] != "Second" || titles[1] != "Third" {
|
||||||
t.Fatalf("albums = %v, want [Second Third]", titles)
|
t.Fatalf("albums = %v, want [Second Third]", titles)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -8,7 +8,6 @@ import (
|
|||||||
|
|
||||||
"yellowjacket/backend/coverart"
|
"yellowjacket/backend/coverart"
|
||||||
"yellowjacket/backend/database/sql/sqlcgen"
|
"yellowjacket/backend/database/sql/sqlcgen"
|
||||||
"yellowjacket/internal/testfixtures"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// TestScan_StoresOnlyCoverTiers pins the size decision: a scan writes
|
// TestScan_StoresOnlyCoverTiers pins the size decision: a scan writes
|
||||||
@@ -27,9 +26,10 @@ func TestScan_StoresOnlyCoverTiers(t *testing.T) {
|
|||||||
|
|
||||||
lib, db := setupTestLibrary(t)
|
lib, db := setupTestLibrary(t)
|
||||||
|
|
||||||
// Load skips when the fixture library has not been generated, as
|
root, err := filepath.Abs("../../test_data/music_library_test")
|
||||||
// every other fixture test does.
|
if err != nil {
|
||||||
root := testfixtures.Load(t).Root()
|
t.Fatalf("resolve fixture path: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
library, err := db.Queries.CreateLibrary(lib.ctx, sqlcgen.CreateLibraryParams{
|
library, err := db.Queries.CreateLibrary(lib.ctx, sqlcgen.CreateLibraryParams{
|
||||||
Name: "Fixtures",
|
Name: "Fixtures",
|
||||||
|
|||||||
@@ -121,12 +121,6 @@ export interface CandidateFile {
|
|||||||
"bitrate"?: number;
|
"bitrate"?: number;
|
||||||
"isAudio": boolean;
|
"isAudio": boolean;
|
||||||
|
|
||||||
/**
|
|
||||||
* LengthMillis is the file's duration as the source reports it, or
|
|
||||||
* 0 when it does not. Soulseek reports it for most audio files.
|
|
||||||
*/
|
|
||||||
"lengthMillis"?: number;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* expected track position
|
* expected track position
|
||||||
*/
|
*/
|
||||||
@@ -459,19 +453,10 @@ export interface MatchScore {
|
|||||||
"albumFit": number;
|
"albumFit": number;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* aligned tracks vs expected count
|
* audio files vs expected count
|
||||||
*/
|
*/
|
||||||
"completeness": number;
|
"completeness": number;
|
||||||
|
|
||||||
/**
|
|
||||||
* DurationFit is how well the aligned files' lengths agree with the
|
|
||||||
* expected tracks', and DurationKnown whether enough of them stated
|
|
||||||
* a length for that to count. When it does not, the score is the
|
|
||||||
* four text signals alone, exactly as before durations were read.
|
|
||||||
*/
|
|
||||||
"durationFit": number;
|
|
||||||
"durationKnown": boolean;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Anchored records whether an MBID drove this score. Unanchored
|
* Anchored records whether an MBID drove this score. Unanchored
|
||||||
* matches are capped, because there is nothing to be right about.
|
* matches are capped, because there is nothing to be right about.
|
||||||
|
|||||||
@@ -0,0 +1 @@
|
|||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 7.3.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2026 Fonticons, Inc. --><path fill="currentColor" d="M9.4 233.4c-12.5 12.5-12.5 32.8 0 45.3l192 192c12.5 12.5 32.8 12.5 45.3 0s12.5-32.8 0-45.3L77.3 256 246.6 86.6c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0l-192 192z"/></svg>
|
||||||
|
After Width: | Height: | Size: 476 B |
@@ -60,6 +60,7 @@ import '@awesome.me/webawesome/dist/components/dropdown-item/dropdown-item.js';
|
|||||||
import { dictByName } from '@utils/binding';
|
import { dictByName } from '@utils/binding';
|
||||||
import type { TrackDetails } from '@components/track-details/track-details.js';
|
import type { TrackDetails } from '@components/track-details/track-details.js';
|
||||||
import { showTrackDetailsForPath } from '@utils/track-details-opener.js';
|
import { showTrackDetailsForPath } from '@utils/track-details-opener.js';
|
||||||
|
import { openMusicBrainz } from '@utils/external-link';
|
||||||
import '@components/playlist-picker/playlist-picker.js';
|
import '@components/playlist-picker/playlist-picker.js';
|
||||||
import {
|
import {
|
||||||
ICON_CAN_REQUEST,
|
ICON_CAN_REQUEST,
|
||||||
@@ -2942,7 +2943,7 @@ export class ExploreAlbumDetails extends LitElement implements ContextMenuHost {
|
|||||||
|
|
||||||
if (!track?.mbid) return;
|
if (!track?.mbid) return;
|
||||||
|
|
||||||
window.open(`https://musicbrainz.org/recording/${track.mbid}`, '_blank', 'noopener');
|
openMusicBrainz(`/recording/${track.mbid}`);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -4,6 +4,8 @@ import { customElement, property, state, query } from 'lit/decorators.js';
|
|||||||
import { classMap } from 'lit/directives/class-map.js';
|
import { classMap } from 'lit/directives/class-map.js';
|
||||||
import { designTokens } from '../../styles/tokens.css';
|
import { designTokens } from '../../styles/tokens.css';
|
||||||
import { backButton } from '../../styles/back-button.css';
|
import { backButton } from '../../styles/back-button.css';
|
||||||
|
import { albumCardStyles } from '../../styles/album-card.css';
|
||||||
|
import '../scroll-row/scroll-row.js';
|
||||||
import {
|
import {
|
||||||
LookupArtist,
|
LookupArtist,
|
||||||
BrowseReleaseGroups,
|
BrowseReleaseGroups,
|
||||||
@@ -46,11 +48,8 @@ import {
|
|||||||
libraryStatusFor,
|
libraryStatusFor,
|
||||||
toggleRequest,
|
toggleRequest,
|
||||||
} from '@utils/library-status';
|
} from '@utils/library-status';
|
||||||
import {
|
import { isOwned, ownershipLabel } from '@utils/ownership';
|
||||||
isOwned,
|
import { openMusicBrainz } from '@utils/external-link';
|
||||||
ownershipLabel,
|
|
||||||
unownedStyles,
|
|
||||||
} from '@utils/ownership';
|
|
||||||
import { completenessStore } from '@store/completeness-store';
|
import { completenessStore } from '@store/completeness-store';
|
||||||
import '../catalog-scope-notice/catalog-scope-notice.js';
|
import '../catalog-scope-notice/catalog-scope-notice.js';
|
||||||
import type { CatalogScope } from '../catalog-scope-notice/catalog-scope-notice.js';
|
import type { CatalogScope } from '../catalog-scope-notice/catalog-scope-notice.js';
|
||||||
@@ -62,6 +61,7 @@ import {
|
|||||||
ContextMenuController,
|
ContextMenuController,
|
||||||
contextMenuStyles,
|
contextMenuStyles,
|
||||||
isContextMenuKey,
|
isContextMenuKey,
|
||||||
|
MenuKeyboard,
|
||||||
} from '@utils/context-menu-controller.js';
|
} from '@utils/context-menu-controller.js';
|
||||||
import type { ContextMenuHost, MenuTarget } from '@utils/context-menu-controller.js';
|
import type { ContextMenuHost, MenuTarget } from '@utils/context-menu-controller.js';
|
||||||
import '@awesome.me/webawesome/dist/components/popup/popup.js';
|
import '@awesome.me/webawesome/dist/components/popup/popup.js';
|
||||||
@@ -187,11 +187,11 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
@state() private topReleasesExpanded = false;
|
@state() private topReleasesExpanded = false;
|
||||||
private topSectionStacked = false;
|
private topSectionStacked = false;
|
||||||
private topSectionObserver?: ResizeObserver;
|
private topSectionObserver?: ResizeObserver;
|
||||||
@state() private expandedDiscoGroups = new Set<string>();
|
|
||||||
/** Number of album cards that fit in one row of the discography grid. */
|
/** Whether the Play button's Shuffle dropdown is up. */
|
||||||
@state() private discoRowSize = 5;
|
@state() private playMenuOpen = false;
|
||||||
private discoObserver?: ResizeObserver;
|
private playMenuKeyboard = new MenuKeyboard(() => this.closePlayMenu());
|
||||||
@state() private similarExpanded = false;
|
private playOutsideAttached = false;
|
||||||
|
|
||||||
/* ── Release prefetch ── */
|
/* ── Release prefetch ── */
|
||||||
|
|
||||||
@@ -221,6 +221,12 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
@query('#context-menu')
|
@query('#context-menu')
|
||||||
private contextMenuPopup!: MenuSurface;
|
private contextMenuPopup!: MenuSurface;
|
||||||
|
|
||||||
|
@query('.play-menu-button')
|
||||||
|
private playMenuButton?: HTMLButtonElement;
|
||||||
|
|
||||||
|
@query('#artist-play-menu')
|
||||||
|
private playMenuPanel?: HTMLElement;
|
||||||
|
|
||||||
@query('#playlist-submenu')
|
@query('#playlist-submenu')
|
||||||
private playlistSubmenuPopup?: WaPopup;
|
private playlistSubmenuPopup?: WaPopup;
|
||||||
|
|
||||||
@@ -271,7 +277,7 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
backButton,
|
backButton,
|
||||||
exploreLinkStyles,
|
exploreLinkStyles,
|
||||||
contextMenuStyles,
|
contextMenuStyles,
|
||||||
unownedStyles,
|
albumCardStyles,
|
||||||
css`
|
css`
|
||||||
:host {
|
:host {
|
||||||
display: flex;
|
display: flex;
|
||||||
@@ -319,10 +325,45 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
object-fit: cover;
|
object-fit: cover;
|
||||||
}
|
}
|
||||||
|
|
||||||
.artist-follow {
|
.artist-actions {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 8px;
|
||||||
|
flex-wrap: wrap;
|
||||||
margin-top: 10px;
|
margin-top: 10px;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* The Play button and its caret are one control, so they
|
||||||
|
are one box: no gap between them, and the caret carries
|
||||||
|
the same filled appearance as the button it extends. */
|
||||||
|
.play-split {
|
||||||
|
display: inline-flex;
|
||||||
|
align-items: stretch;
|
||||||
|
}
|
||||||
|
|
||||||
|
.play-menu-button {
|
||||||
|
display: inline-flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
width: 28px;
|
||||||
|
padding: 0;
|
||||||
|
border: none;
|
||||||
|
border-left: 1px solid rgba(0, 0, 0, 0.25);
|
||||||
|
border-radius: 0 6px 6px 0;
|
||||||
|
background: var(--yj-accent, #ffd43b);
|
||||||
|
color: var(--yj-accent-fg, #000);
|
||||||
|
cursor: pointer;
|
||||||
|
}
|
||||||
|
|
||||||
|
.play-menu-button:hover {
|
||||||
|
filter: brightness(1.1);
|
||||||
|
}
|
||||||
|
|
||||||
|
.play-menu-button:focus-visible {
|
||||||
|
outline: 2px solid var(--yj-accent-text, #ffd43b);
|
||||||
|
outline-offset: 2px;
|
||||||
|
}
|
||||||
|
|
||||||
.artist-info {
|
.artist-info {
|
||||||
display: flex;
|
display: flex;
|
||||||
flex-direction: column;
|
flex-direction: column;
|
||||||
@@ -331,7 +372,7 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
}
|
}
|
||||||
|
|
||||||
.artist-title {
|
.artist-title {
|
||||||
font-size: 24px;
|
font-size: 28px;
|
||||||
font-weight: 700;
|
font-weight: 700;
|
||||||
color: var(--yj-text-primary, #fff);
|
color: var(--yj-text-primary, #fff);
|
||||||
white-space: nowrap;
|
white-space: nowrap;
|
||||||
@@ -359,6 +400,13 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
flex-wrap: wrap;
|
flex-wrap: wrap;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* The listen count is a headline number, not metadata, so
|
||||||
|
it sits a size above the type/country line. */
|
||||||
|
.artist-listens {
|
||||||
|
font-size: var(--yj-text-lg);
|
||||||
|
color: var(--yj-text-secondary, #b3b3b3);
|
||||||
|
}
|
||||||
|
|
||||||
.meta-separator {
|
.meta-separator {
|
||||||
opacity: 0.4;
|
opacity: 0.4;
|
||||||
}
|
}
|
||||||
@@ -446,23 +494,6 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
outline-offset: -2px;
|
outline-offset: -2px;
|
||||||
}
|
}
|
||||||
|
|
||||||
.artist-play-actions {
|
|
||||||
margin-top: 10px;
|
|
||||||
display: flex;
|
|
||||||
gap: 8px;
|
|
||||||
align-items: center;
|
|
||||||
flex-wrap: wrap;
|
|
||||||
}
|
|
||||||
|
|
||||||
.track-rank {
|
|
||||||
width: 24px;
|
|
||||||
text-align: right;
|
|
||||||
color: var(--yj-text-tertiary, #888);
|
|
||||||
font-size: var(--yj-text-md);
|
|
||||||
font-variant-numeric: tabular-nums;
|
|
||||||
flex-shrink: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.track-art {
|
.track-art {
|
||||||
width: 32px;
|
width: 32px;
|
||||||
height: 32px;
|
height: 32px;
|
||||||
@@ -489,6 +520,52 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
opacity: 0.5;
|
opacity: 0.5;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* Play where you own the track, the request badge where you
|
||||||
|
do not — over the artwork rather than at the end of the
|
||||||
|
row, where it was a badge beside a row you can already
|
||||||
|
double-click. */
|
||||||
|
.track-art-overlay {
|
||||||
|
position: absolute;
|
||||||
|
inset: 0;
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
border-radius: 4px;
|
||||||
|
background: rgba(0, 0, 0, 0.55);
|
||||||
|
visibility: hidden;
|
||||||
|
opacity: 0;
|
||||||
|
transition: opacity 0.15s ease, visibility 0.15s ease;
|
||||||
|
}
|
||||||
|
|
||||||
|
.track-art-play {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
padding: 0;
|
||||||
|
border: none;
|
||||||
|
background: none;
|
||||||
|
color: #fff;
|
||||||
|
font-size: 14px;
|
||||||
|
cursor: pointer;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (hover: hover) and (pointer: fine) {
|
||||||
|
.track-item:hover .track-art-overlay,
|
||||||
|
.track-item:focus-within .track-art-overlay {
|
||||||
|
visibility: visible;
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/* No hover means no double-click either, so the overlay is
|
||||||
|
the only route to playing a top track and must be there. */
|
||||||
|
@media not all and (hover: hover) {
|
||||||
|
.track-art-overlay {
|
||||||
|
visibility: visible;
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
.track-info {
|
.track-info {
|
||||||
flex: 1;
|
flex: 1;
|
||||||
min-width: 0;
|
min-width: 0;
|
||||||
@@ -522,7 +599,6 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
.track-item library-status-indicator {
|
.track-item library-status-indicator {
|
||||||
flex-shrink: 0;
|
flex-shrink: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* ── Top section (tracks + releases side-by-side) ── */
|
/* ── Top section (tracks + releases side-by-side) ── */
|
||||||
.top-section-wrapper {
|
.top-section-wrapper {
|
||||||
container-type: inline-size;
|
container-type: inline-size;
|
||||||
@@ -754,8 +830,30 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
white-space: nowrap;
|
white-space: nowrap;
|
||||||
}
|
}
|
||||||
|
|
||||||
.top-release-meta library-status-indicator {
|
.top-release-art .album-card-badge {
|
||||||
flex-shrink: 0;
|
position: absolute;
|
||||||
|
top: 4px;
|
||||||
|
left: 4px;
|
||||||
|
z-index: 1;
|
||||||
|
display: flex;
|
||||||
|
visibility: hidden;
|
||||||
|
opacity: 0;
|
||||||
|
transition: opacity 0.15s ease, visibility 0.15s ease;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (hover: hover) and (pointer: fine) {
|
||||||
|
.top-release-card:hover .album-card-badge,
|
||||||
|
.top-release-card:focus-within .album-card-badge {
|
||||||
|
visibility: visible;
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@media not all and (hover: hover) {
|
||||||
|
.top-release-art .album-card-badge {
|
||||||
|
visibility: visible;
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
@@ -773,150 +871,7 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
margin: 0;
|
margin: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
.album-grid {
|
|
||||||
display: grid;
|
|
||||||
grid-template-columns: repeat(auto-fill, 140px);
|
|
||||||
gap: 16px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.album-grid.collapsed {
|
|
||||||
grid-template-rows: 1fr;
|
|
||||||
overflow: hidden;
|
|
||||||
}
|
|
||||||
|
|
||||||
.disco-toggle {
|
|
||||||
display: flex;
|
|
||||||
align-items: center;
|
|
||||||
justify-content: center;
|
|
||||||
gap: 6px;
|
|
||||||
padding: 4px 10px;
|
|
||||||
margin-top: 4px;
|
|
||||||
border: none;
|
|
||||||
border-radius: 6px;
|
|
||||||
background: var(--yj-bg-overlay, rgba(255, 255, 255, 0.06));
|
|
||||||
color: var(--yj-text-secondary, #b3b3b3);
|
|
||||||
font-size: var(--yj-text-xs);
|
|
||||||
cursor: pointer;
|
|
||||||
transition: background 0.15s ease, color 0.15s ease;
|
|
||||||
width: 100%;
|
|
||||||
}
|
|
||||||
|
|
||||||
.disco-toggle:hover {
|
|
||||||
background: var(--yj-bg-hover, rgba(255, 255, 255, 0.1));
|
|
||||||
color: var(--yj-text-primary, #fff);
|
|
||||||
}
|
|
||||||
|
|
||||||
.disco-toggle wa-icon {
|
|
||||||
font-size: 11px;
|
|
||||||
transition: transform 0.2s ease;
|
|
||||||
}
|
|
||||||
|
|
||||||
.disco-toggle[aria-expanded='true'] wa-icon {
|
|
||||||
transform: rotate(180deg);
|
|
||||||
}
|
|
||||||
|
|
||||||
.album-card {
|
|
||||||
display: flex;
|
|
||||||
flex-direction: column;
|
|
||||||
gap: 6px;
|
|
||||||
padding: 8px;
|
|
||||||
border-radius: 8px;
|
|
||||||
cursor: pointer;
|
|
||||||
transition: background 0.15s ease;
|
|
||||||
}
|
|
||||||
|
|
||||||
.album-card:hover {
|
|
||||||
background: var(
|
|
||||||
--yj-bg-overlay,
|
|
||||||
rgba(255, 255, 255, 0.06)
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
.album-card:active {
|
|
||||||
transform: scale(0.97);
|
|
||||||
}
|
|
||||||
|
|
||||||
.album-art-container {
|
|
||||||
width: 100%;
|
|
||||||
aspect-ratio: 1;
|
|
||||||
border-radius: 4px;
|
|
||||||
overflow: hidden;
|
|
||||||
flex-shrink: 0;
|
|
||||||
position: relative;
|
|
||||||
background: var(--yj-bg-overlay, rgba(255, 255, 255, 0.06));
|
|
||||||
}
|
|
||||||
|
|
||||||
.album-art-container img {
|
|
||||||
width: 100%;
|
|
||||||
height: 100%;
|
|
||||||
object-fit: cover;
|
|
||||||
display: block;
|
|
||||||
border-radius: 4px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.album-art-fallback {
|
|
||||||
display: flex;
|
|
||||||
align-items: center;
|
|
||||||
justify-content: center;
|
|
||||||
width: 100%;
|
|
||||||
height: 100%;
|
|
||||||
position: absolute;
|
|
||||||
inset: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.album-art-fallback wa-icon {
|
|
||||||
color: var(--yj-text-tertiary, #888);
|
|
||||||
font-size: 24px;
|
|
||||||
opacity: 0.5;
|
|
||||||
}
|
|
||||||
|
|
||||||
.album-title {
|
|
||||||
font-weight: 500;
|
|
||||||
color: var(--yj-text-primary, #fff);
|
|
||||||
font-size: var(--yj-text-sm);
|
|
||||||
white-space: nowrap;
|
|
||||||
overflow: hidden;
|
|
||||||
text-overflow: ellipsis;
|
|
||||||
}
|
|
||||||
|
|
||||||
.album-meta {
|
|
||||||
display: flex;
|
|
||||||
align-items: center;
|
|
||||||
justify-content: space-between;
|
|
||||||
gap: 6px;
|
|
||||||
color: var(--yj-text-tertiary, #888);
|
|
||||||
font-size: var(--yj-text-xs);
|
|
||||||
min-height: 20px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.album-meta-text {
|
|
||||||
display: flex;
|
|
||||||
align-items: center;
|
|
||||||
gap: 6px;
|
|
||||||
min-width: 0;
|
|
||||||
overflow: hidden;
|
|
||||||
text-overflow: ellipsis;
|
|
||||||
white-space: nowrap;
|
|
||||||
}
|
|
||||||
|
|
||||||
.album-meta library-status-indicator {
|
|
||||||
flex-shrink: 0;
|
|
||||||
margin-left: auto;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* ── Similar artists ── */
|
/* ── Similar artists ── */
|
||||||
.similar-row {
|
|
||||||
display: grid;
|
|
||||||
grid-template-columns: repeat(auto-fill, 140px);
|
|
||||||
gap: 16px;
|
|
||||||
overflow: hidden;
|
|
||||||
}
|
|
||||||
|
|
||||||
.similar-row.collapsed {
|
|
||||||
grid-template-rows: 1fr;
|
|
||||||
overflow: hidden;
|
|
||||||
}
|
|
||||||
|
|
||||||
.similar-artist-card {
|
.similar-artist-card {
|
||||||
display: flex;
|
display: flex;
|
||||||
flex-direction: column;
|
flex-direction: column;
|
||||||
@@ -926,6 +881,9 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
border-radius: 8px;
|
border-radius: 8px;
|
||||||
cursor: pointer;
|
cursor: pointer;
|
||||||
text-align: center;
|
text-align: center;
|
||||||
|
width: 120px;
|
||||||
|
box-sizing: border-box;
|
||||||
|
flex-shrink: 0;
|
||||||
transition: background 0.15s ease;
|
transition: background 0.15s ease;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1056,7 +1014,7 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
this.unsubSimilarReady?.();
|
this.unsubSimilarReady?.();
|
||||||
if (this.discogFallbackTimer) clearTimeout(this.discogFallbackTimer);
|
if (this.discogFallbackTimer) clearTimeout(this.discogFallbackTimer);
|
||||||
this.topSectionObserver?.disconnect();
|
this.topSectionObserver?.disconnect();
|
||||||
this.discoObserver?.disconnect();
|
this.detachPlayOutsideClose();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -1083,17 +1041,14 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
|
|
||||||
protected override firstUpdated() {
|
protected override firstUpdated() {
|
||||||
this.observeTopSectionWidth();
|
this.observeTopSectionWidth();
|
||||||
this.observeDiscoWidth();
|
|
||||||
}
|
}
|
||||||
|
|
||||||
protected override updated() {
|
protected override updated() {
|
||||||
// Re-attach observers if elements appeared after initial render.
|
// Re-attach the observer if the section appeared after initial
|
||||||
|
// render.
|
||||||
if (!this.topSectionObserver) {
|
if (!this.topSectionObserver) {
|
||||||
this.observeTopSectionWidth();
|
this.observeTopSectionWidth();
|
||||||
}
|
}
|
||||||
if (!this.discoObserver) {
|
|
||||||
this.observeDiscoWidth();
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -1126,32 +1081,6 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
this.topSectionObserver.observe(wrapper);
|
this.topSectionObserver.observe(wrapper);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Watch the .content width and compute how many album cards
|
|
||||||
* fit in one row of the discography grid.
|
|
||||||
* Grid uses: repeat(auto-fill, minmax(140px, 1fr)) with 16px gap
|
|
||||||
* and album-card has 8px padding on each side.
|
|
||||||
*/
|
|
||||||
private observeDiscoWidth() {
|
|
||||||
const content = this.renderRoot.querySelector('.content');
|
|
||||||
if (!content) return;
|
|
||||||
|
|
||||||
const CARD_MIN = 140;
|
|
||||||
const GAP = 16;
|
|
||||||
|
|
||||||
this.discoObserver = new ResizeObserver((entries) => {
|
|
||||||
for (const entry of entries) {
|
|
||||||
const width = entry.contentBoxSize?.[0]?.inlineSize ?? entry.contentRect.width;
|
|
||||||
const cols = Math.max(1, Math.floor((width + GAP) / (CARD_MIN + GAP)));
|
|
||||||
if (cols !== this.discoRowSize) {
|
|
||||||
this.discoRowSize = cols;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
this.discoObserver.observe(content);
|
|
||||||
}
|
|
||||||
|
|
||||||
/* ── Data Loading ── */
|
/* ── Data Loading ── */
|
||||||
|
|
||||||
private async loadAllData() {
|
private async loadAllData() {
|
||||||
@@ -1862,6 +1791,8 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
} catch {
|
} catch {
|
||||||
// No image — letter avatar stays.
|
// No image — letter avatar stays.
|
||||||
}
|
}
|
||||||
|
|
||||||
|
return undefined;
|
||||||
}),
|
}),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
@@ -1999,6 +1930,65 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* ── Play / Shuffle split button ── */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Open the Play button's Shuffle dropdown.
|
||||||
|
*
|
||||||
|
* `page-header`'s overflow menu one control over: the same
|
||||||
|
* `MenuKeyboard`, the same document-level outside-close, and the
|
||||||
|
* same `menu-surface`, so the phone gets the bottom sheet rather
|
||||||
|
* than a popup that Chrome 113 clips.
|
||||||
|
*/
|
||||||
|
private togglePlayMenu = (): void => {
|
||||||
|
if (this.playMenuOpen) {
|
||||||
|
this.closePlayMenu();
|
||||||
|
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
this.playMenuOpen = true;
|
||||||
|
|
||||||
|
void this.updateComplete.then(() => {
|
||||||
|
if (!this.playMenuOpen) return;
|
||||||
|
|
||||||
|
this.playMenuKeyboard.open(
|
||||||
|
this.playMenuPanel ?? null,
|
||||||
|
this.playMenuButton ?? null,
|
||||||
|
);
|
||||||
|
this.attachPlayOutsideClose();
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
private closePlayMenu = (): void => {
|
||||||
|
if (!this.playMenuOpen) return;
|
||||||
|
|
||||||
|
this.detachPlayOutsideClose();
|
||||||
|
this.playMenuKeyboard.close();
|
||||||
|
this.playMenuOpen = false;
|
||||||
|
};
|
||||||
|
|
||||||
|
private onPlayOutsideDown = (e: Event): void => {
|
||||||
|
if (e.composedPath().includes(this.playMenuPanel as EventTarget)) return;
|
||||||
|
if (e.composedPath().includes(this.playMenuButton as EventTarget)) return;
|
||||||
|
|
||||||
|
this.closePlayMenu();
|
||||||
|
};
|
||||||
|
|
||||||
|
private attachPlayOutsideClose(): void {
|
||||||
|
if (this.playOutsideAttached) return;
|
||||||
|
|
||||||
|
this.playOutsideAttached = true;
|
||||||
|
document.addEventListener('mousedown', this.onPlayOutsideDown, true);
|
||||||
|
}
|
||||||
|
|
||||||
|
private detachPlayOutsideClose(): void {
|
||||||
|
if (!this.playOutsideAttached) return;
|
||||||
|
|
||||||
|
this.playOutsideAttached = false;
|
||||||
|
document.removeEventListener('mousedown', this.onPlayOutsideDown, true);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* File path for one top track, resolved by recording MBID — the
|
* File path for one top track, resolved by recording MBID — the
|
||||||
* same key `localId` was set from. Works whether or not the
|
* same key `localId` was set from. Works whether or not the
|
||||||
@@ -2240,11 +2230,7 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
|
|
||||||
if (!release?.mbid) return;
|
if (!release?.mbid) return;
|
||||||
|
|
||||||
window.open(
|
openMusicBrainz(`/release-group/${release.mbid}`);
|
||||||
`https://musicbrainz.org/release-group/${release.mbid}`,
|
|
||||||
'_blank',
|
|
||||||
'noopener',
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
private onContextMenuAction(
|
private onContextMenuAction(
|
||||||
@@ -2358,7 +2344,7 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
|
|
||||||
if (!track?.recordingMbid) return;
|
if (!track?.recordingMbid) return;
|
||||||
|
|
||||||
window.open(`https://musicbrainz.org/recording/${track.recordingMbid}`, '_blank', 'noopener');
|
openMusicBrainz(`/recording/${track.recordingMbid}`);
|
||||||
}
|
}
|
||||||
|
|
||||||
/* ── Navigation ── */
|
/* ── Navigation ── */
|
||||||
@@ -2538,10 +2524,12 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
: nothing}
|
: nothing}
|
||||||
${this.renderArtistMeta()}
|
${this.renderArtistMeta()}
|
||||||
${this.artist?.popularity && this.artist.popularity > 0
|
${this.artist?.popularity && this.artist.popularity > 0
|
||||||
? html`<span class="artist-meta">${formatListenCount(this.artist.popularity)} plays on ListenBrainz</span>`
|
? html`<span class="artist-listens">${formatListenCount(this.artist.popularity)} plays on ListenBrainz</span>`
|
||||||
: nothing}
|
: nothing}
|
||||||
${this.renderPlayLibraryAction()}
|
<div class="artist-actions">
|
||||||
${this.renderFollowAction()}
|
${this.renderPlayLibraryAction()}
|
||||||
|
${this.renderFollowAction()}
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div class="content">
|
<div class="content">
|
||||||
@@ -2572,25 +2560,53 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
if (this.ownedLocalAlbumIds().length === 0) return nothing;
|
if (this.ownedLocalAlbumIds().length === 0) return nothing;
|
||||||
|
|
||||||
return html`
|
return html`
|
||||||
<div class="artist-play-actions">
|
<div class="play-split">
|
||||||
<wa-button
|
<wa-button
|
||||||
size="small"
|
size="small"
|
||||||
appearance="filled"
|
appearance="filled"
|
||||||
data-testid="artist-play-library"
|
data-testid="artist-play-library"
|
||||||
|
title="Play library tracks"
|
||||||
@click=${() => void this.playLibraryTracks(false)}
|
@click=${() => void this.playLibraryTracks(false)}
|
||||||
>
|
>
|
||||||
<wa-icon slot="start" name="play"></wa-icon>
|
<wa-icon slot="start" name="play"></wa-icon>
|
||||||
Play library tracks
|
Play
|
||||||
</wa-button>
|
</wa-button>
|
||||||
<wa-button
|
<menu-surface
|
||||||
size="small"
|
placement="bottom-start"
|
||||||
appearance="outlined"
|
.active=${this.playMenuOpen}
|
||||||
data-testid="artist-shuffle-library"
|
@menu-dismiss=${this.closePlayMenu}
|
||||||
@click=${() => void this.playLibraryTracks(true)}
|
|
||||||
>
|
>
|
||||||
<wa-icon slot="start" name="shuffle"></wa-icon>
|
<button
|
||||||
Shuffle
|
slot="anchor"
|
||||||
</wa-button>
|
class="play-menu-button"
|
||||||
|
type="button"
|
||||||
|
data-testid="artist-play-menu"
|
||||||
|
aria-label="More play options"
|
||||||
|
aria-haspopup="menu"
|
||||||
|
aria-expanded=${this.playMenuOpen ? 'true' : 'false'}
|
||||||
|
aria-controls="artist-play-menu"
|
||||||
|
@click=${this.togglePlayMenu}
|
||||||
|
>
|
||||||
|
<wa-icon name="chevron-down"></wa-icon>
|
||||||
|
</button>
|
||||||
|
<div
|
||||||
|
id="artist-play-menu"
|
||||||
|
class="context-menu-panel"
|
||||||
|
role="menu"
|
||||||
|
aria-label="Play options"
|
||||||
|
>
|
||||||
|
<wa-dropdown-item
|
||||||
|
data-testid="artist-shuffle-library"
|
||||||
|
@click=${() => {
|
||||||
|
this.closePlayMenu();
|
||||||
|
void this.playLibraryTracks(true);
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<wa-icon slot="icon" name="shuffle"></wa-icon>
|
||||||
|
Shuffle
|
||||||
|
</wa-dropdown-item>
|
||||||
|
</div>
|
||||||
|
</menu-surface>
|
||||||
</div>
|
</div>
|
||||||
`;
|
`;
|
||||||
}
|
}
|
||||||
@@ -2786,25 +2802,27 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
const request = downloadStore.requestFor(this.artistMBID);
|
const request = downloadStore.requestFor(this.artistMBID);
|
||||||
|
|
||||||
return html`
|
return html`
|
||||||
<div class="artist-follow">
|
<wa-button
|
||||||
<wa-button
|
size="small"
|
||||||
size="small"
|
appearance=${request ? 'filled' : 'outlined'}
|
||||||
appearance=${request ? 'filled' : 'outlined'}
|
data-testid="artist-follow"
|
||||||
@click=${() => void this.toggleFollow(request?.id)}
|
title=${request
|
||||||
>
|
? 'Following this artist'
|
||||||
<!-- This was bookmark-check, which is not in
|
: 'Follow this artist for new releases'}
|
||||||
names.txt and so has rendered the missing-icon
|
@click=${() => void this.toggleFollow(request?.id)}
|
||||||
fallback — a circled question mark — on every
|
>
|
||||||
followed artist since it was written. A
|
<!-- This was bookmark-check, which is not in
|
||||||
backtick around that name would end this
|
names.txt and so has rendered the missing-icon
|
||||||
template literal, which is why there is none. -->
|
fallback — a circled question mark — on every
|
||||||
<wa-icon
|
followed artist since it was written. A
|
||||||
slot="start"
|
backtick around that name would end this
|
||||||
name=${request ? ICON_REQUESTED : ICON_CAN_REQUEST}
|
template literal, which is why there is none. -->
|
||||||
></wa-icon>
|
<wa-icon
|
||||||
${request ? 'Following' : 'Follow for new releases'}
|
slot="start"
|
||||||
</wa-button>
|
name=${request ? ICON_REQUESTED : ICON_CAN_REQUEST}
|
||||||
</div>
|
></wa-icon>
|
||||||
|
${request ? 'Following' : 'Follow'}
|
||||||
|
</wa-button>
|
||||||
`;
|
`;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -2888,16 +2906,6 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
this.topReleasesExpanded = !this.topReleasesExpanded;
|
this.topReleasesExpanded = !this.topReleasesExpanded;
|
||||||
}
|
}
|
||||||
|
|
||||||
private toggleDiscoGroup(type: string) {
|
|
||||||
const next = new Set(this.expandedDiscoGroups);
|
|
||||||
if (next.has(type)) {
|
|
||||||
next.delete(type);
|
|
||||||
} else {
|
|
||||||
next.add(type);
|
|
||||||
}
|
|
||||||
this.expandedDiscoGroups = next;
|
|
||||||
}
|
|
||||||
|
|
||||||
private renderTopSection() {
|
private renderTopSection() {
|
||||||
const hasTracks = !this.loadingTracks && this.topTracks.length > 0;
|
const hasTracks = !this.loadingTracks && this.topTracks.length > 0;
|
||||||
const hasReleases = !this.loadingTopReleases && this.topReleaseGroups.length > 0;
|
const hasReleases = !this.loadingTopReleases && this.topReleaseGroups.length > 0;
|
||||||
@@ -2971,6 +2979,31 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
}} />`
|
}} />`
|
||||||
: html`<wa-icon name="compact-disc"></wa-icon>`;
|
: html`<wa-icon name="compact-disc"></wa-icon>`;
|
||||||
})()}
|
})()}
|
||||||
|
<!-- Over the artwork, not beside the
|
||||||
|
row: play where you own it, the
|
||||||
|
request badge where you do not. -->
|
||||||
|
<div class="track-art-overlay">
|
||||||
|
${owned
|
||||||
|
? html`<button
|
||||||
|
class="track-art-play"
|
||||||
|
type="button"
|
||||||
|
aria-label=${`Play ${t.trackName}`}
|
||||||
|
@click=${(e: Event) => {
|
||||||
|
e.stopPropagation();
|
||||||
|
void this.playTrack(t);
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<wa-icon name="play"></wa-icon>
|
||||||
|
</button>`
|
||||||
|
: html`<library-status-indicator
|
||||||
|
status=${libraryStatusFor(false, t.recordingMbid)}
|
||||||
|
entity-type="track"
|
||||||
|
label=${t.trackName}
|
||||||
|
request-mbid=${t.recordingMbid}
|
||||||
|
request-artist=${t.artistName ?? ''}
|
||||||
|
size="18"
|
||||||
|
></library-status-indicator>`}
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div class="track-info">
|
<div class="track-info">
|
||||||
<div class="track-title">${trackLink(t.trackName, t.releaseName, t.releaseGroupMbid ?? '', t.recordingMbid)}</div>
|
<div class="track-title">${trackLink(t.trackName, t.releaseName, t.releaseGroupMbid ?? '', t.recordingMbid)}</div>
|
||||||
@@ -2979,15 +3012,6 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
<span class="track-listens">
|
<span class="track-listens">
|
||||||
${formatListenCount(t.totalListenCount)} plays
|
${formatListenCount(t.totalListenCount)} plays
|
||||||
</span>
|
</span>
|
||||||
${owned
|
|
||||||
? nothing
|
|
||||||
: html`<library-status-indicator
|
|
||||||
status=${libraryStatusFor(false, t.recordingMbid)}
|
|
||||||
entity-type="track"
|
|
||||||
label=${t.trackName}
|
|
||||||
request-mbid=${t.recordingMbid}
|
|
||||||
request-artist=${t.artistName ?? ''}
|
|
||||||
></library-status-indicator>`}
|
|
||||||
</div>
|
</div>
|
||||||
`;
|
`;
|
||||||
})}
|
})}
|
||||||
@@ -3093,6 +3117,18 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
<div class="album-art-fallback" style="${artURL ? 'display: none' : ''}">
|
<div class="album-art-fallback" style="${artURL ? 'display: none' : ''}">
|
||||||
<wa-icon name="compact-disc"></wa-icon>
|
<wa-icon name="compact-disc"></wa-icon>
|
||||||
</div>
|
</div>
|
||||||
|
<div class="album-card-badge">
|
||||||
|
<library-status-indicator
|
||||||
|
status=${badge.status}
|
||||||
|
owned=${badge.owned}
|
||||||
|
expected=${badge.expected}
|
||||||
|
entity-type="album"
|
||||||
|
label=${rg.title}
|
||||||
|
request-mbid=${rg.releaseGroupMbid}
|
||||||
|
request-artist=${this.artist?.name ?? ''}
|
||||||
|
size="21"
|
||||||
|
></library-status-indicator>
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div class="top-release-text">
|
<div class="top-release-text">
|
||||||
<div class="top-release-title" title="${rg.title}">
|
<div class="top-release-title" title="${rg.title}">
|
||||||
@@ -3102,18 +3138,6 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
<div class="top-release-meta-text">
|
<div class="top-release-meta-text">
|
||||||
${rg.date ? html`<span>${extractYear(rg.date)}</span>` : nothing}
|
${rg.date ? html`<span>${extractYear(rg.date)}</span>` : nothing}
|
||||||
</div>
|
</div>
|
||||||
${badge.status === 'in-library'
|
|
||||||
? nothing
|
|
||||||
: html`<library-status-indicator
|
|
||||||
status=${badge.status}
|
|
||||||
owned=${badge.owned}
|
|
||||||
expected=${badge.expected}
|
|
||||||
entity-type="album"
|
|
||||||
label=${rg.title}
|
|
||||||
request-mbid=${rg.releaseGroupMbid}
|
|
||||||
request-artist=${this.artist?.name ?? ''}
|
|
||||||
size="18"
|
|
||||||
></library-status-indicator>`}
|
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
@@ -3164,37 +3188,16 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
<section>
|
<section>
|
||||||
<h3 class="section-header">Discography</h3>
|
<h3 class="section-header">Discography</h3>
|
||||||
${groups.map(
|
${groups.map(
|
||||||
(g) => {
|
(g) => html`
|
||||||
const isExpanded = this.expandedDiscoGroups.has(g.type);
|
<div class="disco-group">
|
||||||
const rowSize = this.discoRowSize;
|
<h4 class="disco-type-header">
|
||||||
const showToggle = g.items.length > rowSize;
|
${g.type === 'Other' ? 'Other Releases' : g.type.endsWith('s') ? g.type : `${g.type}s`}
|
||||||
const visibleItems = isExpanded ? g.items : g.items.slice(0, rowSize);
|
</h4>
|
||||||
|
<scroll-row>
|
||||||
return html`
|
${g.items.map((rg) => this.renderAlbumCard(rg))}
|
||||||
<div class="disco-group">
|
</scroll-row>
|
||||||
<h4 class="disco-type-header">
|
</div>
|
||||||
${g.type === 'Other' ? 'Other Releases' : g.type.endsWith('s') ? g.type : `${g.type}s`}
|
`,
|
||||||
</h4>
|
|
||||||
<div class="album-grid">
|
|
||||||
${visibleItems.map((rg) => this.renderAlbumCard(rg))}
|
|
||||||
</div>
|
|
||||||
${showToggle
|
|
||||||
? html`
|
|
||||||
<button
|
|
||||||
class="disco-toggle"
|
|
||||||
aria-expanded="${isExpanded}"
|
|
||||||
@click=${() => this.toggleDiscoGroup(g.type)}
|
|
||||||
>
|
|
||||||
${isExpanded
|
|
||||||
? 'Show less'
|
|
||||||
: `Show all ${g.items.length}`}
|
|
||||||
<wa-icon name="chevron-down"></wa-icon>
|
|
||||||
</button>
|
|
||||||
`
|
|
||||||
: nothing}
|
|
||||||
</div>
|
|
||||||
`;
|
|
||||||
},
|
|
||||||
)}
|
)}
|
||||||
</section>
|
</section>
|
||||||
`;
|
`;
|
||||||
@@ -3234,23 +3237,25 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
<div class="album-art-fallback" style="${artURL ? 'display: none' : ''}">
|
<div class="album-art-fallback" style="${artURL ? 'display: none' : ''}">
|
||||||
<wa-icon name="compact-disc"></wa-icon>
|
<wa-icon name="compact-disc"></wa-icon>
|
||||||
</div>
|
</div>
|
||||||
|
<div class="album-card-badge">
|
||||||
|
<library-status-indicator
|
||||||
|
status=${badge.status}
|
||||||
|
owned=${badge.owned}
|
||||||
|
expected=${badge.expected}
|
||||||
|
entity-type="album"
|
||||||
|
label=${rg.title}
|
||||||
|
request-mbid=${rg.mbid}
|
||||||
|
request-artist=${this.artist?.name ?? ''}
|
||||||
|
size="23"
|
||||||
|
></library-status-indicator>
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div class="album-title" title="${rg.title}">${rg.title}</div>
|
<div class="album-title" title="${rg.title}">${rg.title}</div>
|
||||||
|
<div class="album-artist">${rg.artistCredit ?? ''}</div>
|
||||||
<div class="album-meta">
|
<div class="album-meta">
|
||||||
<div class="album-meta-text">
|
<div class="album-meta-text">
|
||||||
${year ? html`<span>${year}</span>` : nothing}
|
${year ? html`<span>${year}</span>` : nothing}
|
||||||
</div>
|
</div>
|
||||||
${badge.status === 'in-library'
|
|
||||||
? nothing
|
|
||||||
: html`<library-status-indicator
|
|
||||||
status=${badge.status}
|
|
||||||
owned=${badge.owned}
|
|
||||||
expected=${badge.expected}
|
|
||||||
entity-type="album"
|
|
||||||
label=${rg.title}
|
|
||||||
request-mbid=${rg.mbid}
|
|
||||||
request-artist=${this.artist?.name ?? ''}
|
|
||||||
></library-status-indicator>`}
|
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
`;
|
`;
|
||||||
@@ -3266,15 +3271,12 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
// Cap the similar-artists list at 10 to avoid a very long list.
|
// Cap the similar-artists list at 10 to avoid a very long list.
|
||||||
const maxSimilar = 10;
|
const maxSimilar = 10;
|
||||||
const artists = this.similarArtists.slice(0, maxSimilar);
|
const artists = this.similarArtists.slice(0, maxSimilar);
|
||||||
const showToggle = artists.length > this.discoRowSize;
|
|
||||||
const collapsed = !this.similarExpanded && showToggle;
|
|
||||||
const visible = collapsed ? artists.slice(0, this.discoRowSize) : artists;
|
|
||||||
|
|
||||||
return html`
|
return html`
|
||||||
<section>
|
<section>
|
||||||
<h3 class="section-header">Similar Artists</h3>
|
<h3 class="section-header">Similar Artists</h3>
|
||||||
<div class="similar-row ${collapsed ? 'collapsed' : ''}">
|
<scroll-row>
|
||||||
${visible.map((a) => {
|
${artists.map((a) => {
|
||||||
const imgURL = this.similarImageURLs.get(a.artistMbid);
|
const imgURL = this.similarImageURLs.get(a.artistMbid);
|
||||||
return html`
|
return html`
|
||||||
<div
|
<div
|
||||||
@@ -3313,21 +3315,7 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
</div>
|
</div>
|
||||||
`;
|
`;
|
||||||
})}
|
})}
|
||||||
</div>
|
</scroll-row>
|
||||||
${showToggle
|
|
||||||
? html`
|
|
||||||
<button
|
|
||||||
class="disco-toggle"
|
|
||||||
aria-expanded="${this.similarExpanded}"
|
|
||||||
@click=${() => { this.similarExpanded = !this.similarExpanded; }}
|
|
||||||
>
|
|
||||||
${this.similarExpanded
|
|
||||||
? 'Show less'
|
|
||||||
: `Show all ${artists.length}`}
|
|
||||||
<wa-icon name="chevron-down"></wa-icon>
|
|
||||||
</button>
|
|
||||||
`
|
|
||||||
: nothing}
|
|
||||||
</section>
|
</section>
|
||||||
`;
|
`;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,10 +1,7 @@
|
|||||||
import { avatarBackground } from '@utils/avatar-color';
|
import { avatarBackground } from '@utils/avatar-color';
|
||||||
import { albumBadgeFor, libraryStatusFor } from '@utils/library-status';
|
import { albumBadgeFor, libraryStatusFor } from '@utils/library-status';
|
||||||
import {
|
import { isOwned, ownershipLabel } from '@utils/ownership';
|
||||||
isOwned,
|
import { openMusicBrainz } from '@utils/external-link';
|
||||||
ownershipLabel,
|
|
||||||
unownedStyles,
|
|
||||||
} from '@utils/ownership';
|
|
||||||
import { completenessStore } from '@store/completeness-store';
|
import { completenessStore } from '@store/completeness-store';
|
||||||
import { downloadStore } from '@store/download-store';
|
import { downloadStore } from '@store/download-store';
|
||||||
import { LitElement, html, css, nothing } from 'lit';
|
import { LitElement, html, css, nothing } from 'lit';
|
||||||
@@ -13,6 +10,8 @@ import { classMap } from 'lit/directives/class-map.js';
|
|||||||
import '@components/page-header/page-header';
|
import '@components/page-header/page-header';
|
||||||
import { designTokens } from '../../styles/tokens.css';
|
import { designTokens } from '../../styles/tokens.css';
|
||||||
import { srOnly } from '../../styles/sr-only.css';
|
import { srOnly } from '../../styles/sr-only.css';
|
||||||
|
import { albumCardStyles } from '../../styles/album-card.css';
|
||||||
|
import '../scroll-row/scroll-row.js';
|
||||||
import { SearchLocal, SearchLyrics, GetThumbnail, GetThumbnails, GetArtistImageURL, GetArtistImagesCachedPaths, GetExploreShelves, RecordSearchClick } from '@go/explore/service.js';
|
import { SearchLocal, SearchLyrics, GetThumbnail, GetThumbnails, GetArtistImageURL, GetArtistImagesCachedPaths, GetExploreShelves, RecordSearchClick } from '@go/explore/service.js';
|
||||||
import { GetFilePathsByAlbums, GetFilePathsByRecordingMBIDs } from '@go/library/library.js';
|
import { GetFilePathsByAlbums, GetFilePathsByRecordingMBIDs } from '@go/library/library.js';
|
||||||
import { EventsOn } from '@runtime/runtime';
|
import { EventsOn } from '@runtime/runtime';
|
||||||
@@ -253,7 +252,7 @@ export class ExploreView extends ViewLifecycleMixin(LitElement) implements Conte
|
|||||||
srOnly,
|
srOnly,
|
||||||
exploreLinkStyles,
|
exploreLinkStyles,
|
||||||
contextMenuStyles,
|
contextMenuStyles,
|
||||||
unownedStyles,
|
albumCardStyles,
|
||||||
css`
|
css`
|
||||||
:host {
|
:host {
|
||||||
display: block;
|
display: block;
|
||||||
@@ -529,21 +528,9 @@ export class ExploreView extends ViewLifecycleMixin(LitElement) implements Conte
|
|||||||
line-height: 1.5;
|
line-height: 1.5;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* ── Horizontal scroll rows ── */
|
|
||||||
.horizontal-row {
|
|
||||||
display: flex;
|
|
||||||
gap: 12px;
|
|
||||||
overflow-x: auto;
|
|
||||||
padding-bottom: 4px;
|
|
||||||
scrollbar-width: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
.horizontal-row::-webkit-scrollbar {
|
|
||||||
display: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* ── Top result cards ── */
|
|
||||||
/* ── Artist cards ── */
|
/* ── Artist cards ── */
|
||||||
|
/* Fixed width, for the reason the album card is: a range
|
||||||
|
means two cards in one row are different sizes. */
|
||||||
.artist-card {
|
.artist-card {
|
||||||
display: flex;
|
display: flex;
|
||||||
flex-direction: column;
|
flex-direction: column;
|
||||||
@@ -552,8 +539,8 @@ export class ExploreView extends ViewLifecycleMixin(LitElement) implements Conte
|
|||||||
padding: 10px;
|
padding: 10px;
|
||||||
border-radius: 8px;
|
border-radius: 8px;
|
||||||
cursor: pointer;
|
cursor: pointer;
|
||||||
min-width: 100px;
|
width: 120px;
|
||||||
max-width: 120px;
|
box-sizing: border-box;
|
||||||
flex-shrink: 0;
|
flex-shrink: 0;
|
||||||
text-align: center;
|
text-align: center;
|
||||||
transition: background 0.15s ease;
|
transition: background 0.15s ease;
|
||||||
@@ -624,115 +611,6 @@ export class ExploreView extends ViewLifecycleMixin(LitElement) implements Conte
|
|||||||
font-size: var(--yj-text-xs);
|
font-size: var(--yj-text-xs);
|
||||||
}
|
}
|
||||||
|
|
||||||
/* ── Album cards ── */
|
|
||||||
.album-card {
|
|
||||||
display: flex;
|
|
||||||
flex-direction: column;
|
|
||||||
gap: 6px;
|
|
||||||
padding: 8px;
|
|
||||||
border-radius: 8px;
|
|
||||||
cursor: pointer;
|
|
||||||
min-width: 130px;
|
|
||||||
max-width: 150px;
|
|
||||||
flex-shrink: 0;
|
|
||||||
transition: background 0.15s ease;
|
|
||||||
}
|
|
||||||
|
|
||||||
.album-card:hover {
|
|
||||||
background: var(--yj-bg-overlay, rgba(255, 255, 255, 0.06));
|
|
||||||
}
|
|
||||||
|
|
||||||
.album-card:active {
|
|
||||||
transform: scale(0.97);
|
|
||||||
}
|
|
||||||
|
|
||||||
.album-art-container {
|
|
||||||
width: 100%;
|
|
||||||
aspect-ratio: 1;
|
|
||||||
border-radius: 4px;
|
|
||||||
overflow: hidden;
|
|
||||||
background: linear-gradient(
|
|
||||||
135deg,
|
|
||||||
var(--yj-bg-overlay, #404040) 0%,
|
|
||||||
var(--yj-bg-surface, #282828) 100%
|
|
||||||
);
|
|
||||||
display: flex;
|
|
||||||
align-items: center;
|
|
||||||
justify-content: center;
|
|
||||||
position: relative;
|
|
||||||
}
|
|
||||||
|
|
||||||
.album-art-container img {
|
|
||||||
width: 100%;
|
|
||||||
height: 100%;
|
|
||||||
object-fit: cover;
|
|
||||||
display: block;
|
|
||||||
}
|
|
||||||
|
|
||||||
.album-art-fallback {
|
|
||||||
display: flex;
|
|
||||||
align-items: center;
|
|
||||||
justify-content: center;
|
|
||||||
width: 100%;
|
|
||||||
height: 100%;
|
|
||||||
position: absolute;
|
|
||||||
inset: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.album-art-fallback wa-icon {
|
|
||||||
color: var(--yj-text-tertiary, #888);
|
|
||||||
font-size: 24px;
|
|
||||||
opacity: 0.5;
|
|
||||||
}
|
|
||||||
|
|
||||||
.album-title {
|
|
||||||
font-weight: 500;
|
|
||||||
color: var(--yj-text-primary, #fff);
|
|
||||||
font-size: var(--yj-text-sm);
|
|
||||||
white-space: nowrap;
|
|
||||||
overflow: hidden;
|
|
||||||
text-overflow: ellipsis;
|
|
||||||
}
|
|
||||||
|
|
||||||
.album-artist {
|
|
||||||
color: var(--yj-text-tertiary, #888);
|
|
||||||
font-size: var(--yj-text-xs);
|
|
||||||
white-space: nowrap;
|
|
||||||
overflow: hidden;
|
|
||||||
text-overflow: ellipsis;
|
|
||||||
}
|
|
||||||
|
|
||||||
.album-meta {
|
|
||||||
display: flex;
|
|
||||||
align-items: center;
|
|
||||||
justify-content: space-between;
|
|
||||||
gap: 6px;
|
|
||||||
color: var(--yj-text-tertiary, #888);
|
|
||||||
font-size: var(--yj-text-xs);
|
|
||||||
min-height: 20px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.album-meta-text {
|
|
||||||
display: flex;
|
|
||||||
align-items: center;
|
|
||||||
gap: 6px;
|
|
||||||
min-width: 0;
|
|
||||||
overflow: hidden;
|
|
||||||
}
|
|
||||||
|
|
||||||
.album-meta library-status-indicator {
|
|
||||||
flex-shrink: 0;
|
|
||||||
margin-left: auto;
|
|
||||||
}
|
|
||||||
|
|
||||||
.type-badge {
|
|
||||||
background: var(--yj-bg-overlay, rgba(255, 255, 255, 0.08));
|
|
||||||
padding: 1px 6px;
|
|
||||||
border-radius: 3px;
|
|
||||||
font-size: 10px;
|
|
||||||
white-space: nowrap;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* ── Track list ── */
|
/* ── Track list ── */
|
||||||
.track-list {
|
.track-list {
|
||||||
display: flex;
|
display: flex;
|
||||||
@@ -753,7 +631,6 @@ export class ExploreView extends ViewLifecycleMixin(LitElement) implements Conte
|
|||||||
cursor: pointer;
|
cursor: pointer;
|
||||||
}
|
}
|
||||||
|
|
||||||
.album-card:focus-visible,
|
|
||||||
.track-item:focus-visible {
|
.track-item:focus-visible {
|
||||||
outline: 2px solid var(--yj-accent-text, #ffd43b);
|
outline: 2px solid var(--yj-accent-text, #ffd43b);
|
||||||
outline-offset: -2px;
|
outline-offset: -2px;
|
||||||
@@ -1371,7 +1248,7 @@ export class ExploreView extends ViewLifecycleMixin(LitElement) implements Conte
|
|||||||
|
|
||||||
const entity = target.kind === 'album' ? 'release-group' : 'recording';
|
const entity = target.kind === 'album' ? 'release-group' : 'recording';
|
||||||
|
|
||||||
window.open(`https://musicbrainz.org/${entity}/${target.mbid}`, '_blank', 'noopener');
|
openMusicBrainz(`/${entity}/${target.mbid}`);
|
||||||
}
|
}
|
||||||
|
|
||||||
private renderExploreContextMenu() {
|
private renderExploreContextMenu() {
|
||||||
@@ -1662,6 +1539,8 @@ export class ExploreView extends ViewLifecycleMixin(LitElement) implements Conte
|
|||||||
} catch {
|
} catch {
|
||||||
// No image — leave empty string.
|
// No image — leave empty string.
|
||||||
}
|
}
|
||||||
|
|
||||||
|
return undefined;
|
||||||
}),
|
}),
|
||||||
);
|
);
|
||||||
|
|
||||||
@@ -2122,7 +2001,7 @@ export class ExploreView extends ViewLifecycleMixin(LitElement) implements Conte
|
|||||||
${subtitle
|
${subtitle
|
||||||
? html`<p class="section-reason">${subtitle}</p>`
|
? html`<p class="section-reason">${subtitle}</p>`
|
||||||
: nothing}
|
: nothing}
|
||||||
<div class="horizontal-row">
|
<scroll-row>
|
||||||
${artists.map((a) => {
|
${artists.map((a) => {
|
||||||
const owned = isOwned(a);
|
const owned = isOwned(a);
|
||||||
const name = a.englishName || a.name;
|
const name = a.englishName || a.name;
|
||||||
@@ -2171,7 +2050,7 @@ export class ExploreView extends ViewLifecycleMixin(LitElement) implements Conte
|
|||||||
</div>
|
</div>
|
||||||
`;
|
`;
|
||||||
})}
|
})}
|
||||||
</div>
|
</scroll-row>
|
||||||
</section>
|
</section>
|
||||||
`;
|
`;
|
||||||
}
|
}
|
||||||
@@ -2187,7 +2066,7 @@ export class ExploreView extends ViewLifecycleMixin(LitElement) implements Conte
|
|||||||
${subtitle
|
${subtitle
|
||||||
? html`<p class="section-reason">${subtitle}</p>`
|
? html`<p class="section-reason">${subtitle}</p>`
|
||||||
: nothing}
|
: nothing}
|
||||||
<div class="horizontal-row">
|
<scroll-row>
|
||||||
${releaseGroups.map((rg) => {
|
${releaseGroups.map((rg) => {
|
||||||
const artURL = this.thumbnailCache.get(rg.mbid) || '';
|
const artURL = this.thumbnailCache.get(rg.mbid) || '';
|
||||||
const year = extractYear(rg.firstReleaseDate);
|
const year = extractYear(rg.firstReleaseDate);
|
||||||
@@ -2249,6 +2128,18 @@ export class ExploreView extends ViewLifecycleMixin(LitElement) implements Conte
|
|||||||
>
|
>
|
||||||
<wa-icon name="compact-disc"></wa-icon>
|
<wa-icon name="compact-disc"></wa-icon>
|
||||||
</div>
|
</div>
|
||||||
|
<div class="album-card-badge">
|
||||||
|
<library-status-indicator
|
||||||
|
status=${badge.status}
|
||||||
|
owned=${badge.owned}
|
||||||
|
expected=${badge.expected}
|
||||||
|
entity-type="album"
|
||||||
|
label=${rg.title}
|
||||||
|
request-mbid=${rg.mbid}
|
||||||
|
request-artist=${rg.artistCredit ?? ''}
|
||||||
|
size="23"
|
||||||
|
></library-status-indicator>
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div class="album-title" title="${rg.title}">
|
<div class="album-title" title="${rg.title}">
|
||||||
${rg.title}
|
${rg.title}
|
||||||
@@ -2256,29 +2147,18 @@ export class ExploreView extends ViewLifecycleMixin(LitElement) implements Conte
|
|||||||
<div class="album-artist">${creditLink(creditStore.credits(rg.mbid), rg.artistCredit, rg.artistMbid ?? '')}</div>
|
<div class="album-artist">${creditLink(creditStore.credits(rg.mbid), rg.artistCredit, rg.artistMbid ?? '')}</div>
|
||||||
<div class="album-meta">
|
<div class="album-meta">
|
||||||
<div class="album-meta-text">
|
<div class="album-meta-text">
|
||||||
|
${year ? html`<span>${year}</span>` : nothing}
|
||||||
${rg.primaryType
|
${rg.primaryType
|
||||||
? html`<span class="type-badge"
|
? html`<span class="type-badge"
|
||||||
>${rg.primaryType}</span
|
>${rg.primaryType}</span
|
||||||
>`
|
>`
|
||||||
: nothing}
|
: nothing}
|
||||||
${year ? html`<span>${year}</span>` : nothing}
|
|
||||||
</div>
|
</div>
|
||||||
${badge.status === 'in-library'
|
|
||||||
? nothing
|
|
||||||
: html`<library-status-indicator
|
|
||||||
status=${badge.status}
|
|
||||||
owned=${badge.owned}
|
|
||||||
expected=${badge.expected}
|
|
||||||
entity-type="album"
|
|
||||||
label=${rg.title}
|
|
||||||
request-mbid=${rg.mbid}
|
|
||||||
request-artist=${rg.artistCredit ?? ''}
|
|
||||||
></library-status-indicator>`}
|
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
`;
|
`;
|
||||||
})}
|
})}
|
||||||
</div>
|
</scroll-row>
|
||||||
</section>
|
</section>
|
||||||
`;
|
`;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -12,6 +12,7 @@ import { libraryStore } from '@store/library-store';
|
|||||||
import { EventsOn } from '@runtime/runtime';
|
import { EventsOn } from '@runtime/runtime';
|
||||||
import { Events } from '../../events';
|
import { Events } from '../../events';
|
||||||
import '@components/page-header/page-header';
|
import '@components/page-header/page-header';
|
||||||
|
import '../scroll-row/scroll-row.js';
|
||||||
import { designTokens } from '../../styles/tokens.css';
|
import { designTokens } from '../../styles/tokens.css';
|
||||||
import { ViewLifecycleMixin } from '../../utils/view-lifecycle';
|
import { ViewLifecycleMixin } from '../../utils/view-lifecycle';
|
||||||
|
|
||||||
@@ -99,16 +100,6 @@ export class HomeView extends ViewLifecycleMixin(LitElement) {
|
|||||||
color: var(--yj-text-tertiary, #888);
|
color: var(--yj-text-tertiary, #888);
|
||||||
}
|
}
|
||||||
|
|
||||||
.row {
|
|
||||||
display: grid;
|
|
||||||
grid-auto-flow: column;
|
|
||||||
grid-auto-columns: 160px;
|
|
||||||
gap: 14px;
|
|
||||||
overflow-x: auto;
|
|
||||||
padding-bottom: 6px;
|
|
||||||
scrollbar-width: thin;
|
|
||||||
}
|
|
||||||
|
|
||||||
.card {
|
.card {
|
||||||
background: none;
|
background: none;
|
||||||
border: none;
|
border: none;
|
||||||
@@ -117,6 +108,8 @@ export class HomeView extends ViewLifecycleMixin(LitElement) {
|
|||||||
cursor: pointer;
|
cursor: pointer;
|
||||||
color: inherit;
|
color: inherit;
|
||||||
display: block;
|
display: block;
|
||||||
|
width: 160px;
|
||||||
|
flex-shrink: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
.art {
|
.art {
|
||||||
@@ -336,9 +329,9 @@ export class HomeView extends ViewLifecycleMixin(LitElement) {
|
|||||||
<span class="shelf-title">${shelf.title}</span>
|
<span class="shelf-title">${shelf.title}</span>
|
||||||
</div>
|
</div>
|
||||||
<p class="shelf-sub">${shelf.subtitle}</p>
|
<p class="shelf-sub">${shelf.subtitle}</p>
|
||||||
<div class="row">
|
<scroll-row>
|
||||||
${(shelf.albums ?? []).map((album) => this.renderCard(album))}
|
${(shelf.albums ?? []).map((album) => this.renderCard(album))}
|
||||||
</div>
|
</scroll-row>
|
||||||
</section>
|
</section>
|
||||||
`;
|
`;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,213 @@
|
|||||||
|
import { LitElement, css, html } from 'lit';
|
||||||
|
import { customElement, query, state } from 'lit/decorators.js';
|
||||||
|
import '@awesome.me/webawesome/dist/components/icon/icon.js';
|
||||||
|
|
||||||
|
/** How far one press moves the row — most of a screenful, not all of
|
||||||
|
* it, so the card that was at the edge stays as an anchor. */
|
||||||
|
const SCROLL_FRACTION = 0.8;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A horizontally scrolling row with arrow buttons.
|
||||||
|
*
|
||||||
|
* The shelves, the search results and (now) the artist page's
|
||||||
|
* discography and similar-artists rows are all "more than fits, scroll
|
||||||
|
* sideways". Until this existed the only way to see the rest was a
|
||||||
|
* mousewheel or a trackpad gesture, which is not an affordance — a
|
||||||
|
* mouse with no horizontal wheel simply could not reach the cards past
|
||||||
|
* the fold.
|
||||||
|
*
|
||||||
|
* It is a component rather than a rule on `.horizontal-row` for two
|
||||||
|
* reasons. The arrows are *state* — which way the row can still move —
|
||||||
|
* and that state has to be recomputed when the viewport resizes or a
|
||||||
|
* card arrives with its cover art; a stylesheet cannot do that. And
|
||||||
|
* every caller then gets the same arrows, the same reveal and the same
|
||||||
|
* keyboard labels without writing them again.
|
||||||
|
*
|
||||||
|
* **The arrows are `hidden`, not merely transparent, at the end they
|
||||||
|
* cannot move from** — a control that cannot act is worse than none,
|
||||||
|
* and an invisible one still holds a hit area and a tab stop. On a
|
||||||
|
* pointer device the pair fades in with the row's hover; where there is
|
||||||
|
* no hover they are always visible, because there is no other route to
|
||||||
|
* them there (a swipe is not an affordance a mouse-less keyboard user
|
||||||
|
* has either).
|
||||||
|
*
|
||||||
|
* The cards are light DOM children and stay in the *host's* shadow
|
||||||
|
* root, so the host's own `.album-card` / `.artist-card` styles apply
|
||||||
|
* unchanged — this component only owns the box they scroll inside.
|
||||||
|
*/
|
||||||
|
@customElement('scroll-row')
|
||||||
|
export class ScrollRow extends LitElement {
|
||||||
|
@query('.viewport') private viewport?: HTMLElement;
|
||||||
|
|
||||||
|
@state() private atStart = true;
|
||||||
|
|
||||||
|
@state() private atEnd = true;
|
||||||
|
|
||||||
|
@state() private overflowing = false;
|
||||||
|
|
||||||
|
private observer?: ResizeObserver;
|
||||||
|
|
||||||
|
static override styles = css`
|
||||||
|
:host {
|
||||||
|
display: block;
|
||||||
|
position: relative;
|
||||||
|
}
|
||||||
|
|
||||||
|
.viewport {
|
||||||
|
overflow-x: auto;
|
||||||
|
overflow-y: hidden;
|
||||||
|
scrollbar-width: none;
|
||||||
|
/* A swipe that reaches the row's end should not drag the
|
||||||
|
whole page sideways with it. */
|
||||||
|
overscroll-behavior-x: contain;
|
||||||
|
}
|
||||||
|
|
||||||
|
.viewport::-webkit-scrollbar {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.track {
|
||||||
|
display: flex;
|
||||||
|
gap: 12px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.arrow {
|
||||||
|
position: absolute;
|
||||||
|
top: 50%;
|
||||||
|
transform: translateY(-50%);
|
||||||
|
z-index: 2;
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
width: 36px;
|
||||||
|
height: 36px;
|
||||||
|
padding: 0;
|
||||||
|
border-radius: 50%;
|
||||||
|
border: 1px solid var(--yj-border-subtle, rgba(255, 255, 255, 0.1));
|
||||||
|
background: var(--yj-bg-elevated, #343a40);
|
||||||
|
color: var(--yj-text-primary, #fff);
|
||||||
|
cursor: pointer;
|
||||||
|
opacity: 0;
|
||||||
|
transition: opacity 0.15s ease;
|
||||||
|
}
|
||||||
|
|
||||||
|
.arrow[hidden] {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.arrow.prev {
|
||||||
|
left: 4px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.arrow.next {
|
||||||
|
right: 4px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.arrow:hover {
|
||||||
|
background: var(--yj-bg-overlay, rgba(255, 255, 255, 0.12));
|
||||||
|
}
|
||||||
|
|
||||||
|
.arrow:focus-visible {
|
||||||
|
outline: 2px solid var(--yj-accent, #ffd43b);
|
||||||
|
outline-offset: 2px;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (hover: hover) and (pointer: fine) {
|
||||||
|
:host(:hover) .arrow,
|
||||||
|
.arrow:focus-visible {
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@media not all and (hover: hover) {
|
||||||
|
.arrow {
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
`;
|
||||||
|
|
||||||
|
override firstUpdated(): void {
|
||||||
|
const viewport = this.viewport;
|
||||||
|
|
||||||
|
if (!viewport) return;
|
||||||
|
|
||||||
|
this.observer = new ResizeObserver(() => this.measure());
|
||||||
|
|
||||||
|
this.observer.observe(viewport);
|
||||||
|
|
||||||
|
// The track's own size is what changes when a card arrives with
|
||||||
|
// its cover art, and a ResizeObserver on the viewport alone
|
||||||
|
// never fires for that.
|
||||||
|
const track = viewport.firstElementChild;
|
||||||
|
|
||||||
|
if (track) this.observer.observe(track);
|
||||||
|
|
||||||
|
this.measure();
|
||||||
|
}
|
||||||
|
|
||||||
|
override disconnectedCallback(): void {
|
||||||
|
super.disconnectedCallback();
|
||||||
|
this.observer?.disconnect();
|
||||||
|
this.observer = undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
private measure(): void {
|
||||||
|
const viewport = this.viewport;
|
||||||
|
|
||||||
|
if (!viewport) return;
|
||||||
|
|
||||||
|
this.overflowing = viewport.scrollWidth > viewport.clientWidth + 1;
|
||||||
|
this.atStart = viewport.scrollLeft <= 1;
|
||||||
|
this.atEnd =
|
||||||
|
viewport.scrollLeft + viewport.clientWidth >=
|
||||||
|
viewport.scrollWidth - 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
private onScroll = (): void => this.measure();
|
||||||
|
|
||||||
|
private scrollStep(direction: -1 | 1): void {
|
||||||
|
const viewport = this.viewport;
|
||||||
|
|
||||||
|
if (!viewport) return;
|
||||||
|
|
||||||
|
viewport.scrollBy({
|
||||||
|
left: direction * viewport.clientWidth * SCROLL_FRACTION,
|
||||||
|
behavior: 'smooth',
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
override render() {
|
||||||
|
const showPrev = this.overflowing && !this.atStart;
|
||||||
|
const showNext = this.overflowing && !this.atEnd;
|
||||||
|
|
||||||
|
return html`
|
||||||
|
<button
|
||||||
|
class="arrow prev"
|
||||||
|
type="button"
|
||||||
|
aria-label="Scroll left"
|
||||||
|
?hidden=${!showPrev}
|
||||||
|
@click=${() => this.scrollStep(-1)}
|
||||||
|
>
|
||||||
|
<wa-icon name="chevron-left"></wa-icon>
|
||||||
|
</button>
|
||||||
|
<div class="viewport" @scroll=${this.onScroll}>
|
||||||
|
<div class="track"><slot></slot></div>
|
||||||
|
</div>
|
||||||
|
<button
|
||||||
|
class="arrow next"
|
||||||
|
type="button"
|
||||||
|
aria-label="Scroll right"
|
||||||
|
?hidden=${!showNext}
|
||||||
|
@click=${() => this.scrollStep(1)}
|
||||||
|
>
|
||||||
|
<wa-icon name="chevron-right"></wa-icon>
|
||||||
|
</button>
|
||||||
|
`;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
declare global {
|
||||||
|
interface HTMLElementTagNameMap {
|
||||||
|
'scroll-row': ScrollRow;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,6 +1,7 @@
|
|||||||
import { LitElement, html, css, nothing } from 'lit';
|
import { LitElement, html, css, nothing } from 'lit';
|
||||||
import { customElement, property } from 'lit/decorators.js';
|
import { customElement, property } from 'lit/decorators.js';
|
||||||
import { designTokens } from '../../styles/tokens.css';
|
import { designTokens } from '../../styles/tokens.css';
|
||||||
|
import '../scroll-row/scroll-row.js';
|
||||||
import type * as explore from '@go/explore/models.js';
|
import type * as explore from '@go/explore/models.js';
|
||||||
import {
|
import {
|
||||||
GetArtistImageURL,
|
GetArtistImageURL,
|
||||||
@@ -15,7 +16,6 @@ import { albumBadgeFor, libraryStatusFor } from '../../utils/library-status';
|
|||||||
import {
|
import {
|
||||||
isOwned,
|
isOwned,
|
||||||
ownershipLabel,
|
ownershipLabel,
|
||||||
unownedStyles,
|
|
||||||
type OwnableKind,
|
type OwnableKind,
|
||||||
} from '../../utils/ownership';
|
} from '../../utils/ownership';
|
||||||
import { completenessStore } from '../../store/completeness-store';
|
import { completenessStore } from '../../store/completeness-store';
|
||||||
@@ -103,20 +103,12 @@ export class TopResultsRow extends LitElement {
|
|||||||
static override styles = [
|
static override styles = [
|
||||||
designTokens,
|
designTokens,
|
||||||
exploreLinkStyles,
|
exploreLinkStyles,
|
||||||
unownedStyles,
|
|
||||||
css`
|
css`
|
||||||
:host {
|
:host {
|
||||||
display: block;
|
display: block;
|
||||||
margin-bottom: 16px;
|
margin-bottom: 16px;
|
||||||
}
|
}
|
||||||
|
|
||||||
.row {
|
|
||||||
display: flex;
|
|
||||||
gap: 12px;
|
|
||||||
overflow-x: auto;
|
|
||||||
padding-bottom: 4px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.card {
|
.card {
|
||||||
flex: 0 0 auto;
|
flex: 0 0 auto;
|
||||||
width: 200px;
|
width: 200px;
|
||||||
@@ -285,9 +277,9 @@ export class TopResultsRow extends LitElement {
|
|||||||
|
|
||||||
return html`
|
return html`
|
||||||
<div class="section-label">Top Results</div>
|
<div class="section-label">Top Results</div>
|
||||||
<div class="row">
|
<scroll-row>
|
||||||
${this.results.map((r) => this.renderCard(r))}
|
${this.results.map((r) => this.renderCard(r))}
|
||||||
</div>
|
</scroll-row>
|
||||||
`;
|
`;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -31,6 +31,7 @@ solid/bookmark
|
|||||||
solid/box-open
|
solid/box-open
|
||||||
solid/check
|
solid/check
|
||||||
solid/chevron-down
|
solid/chevron-down
|
||||||
|
solid/chevron-left
|
||||||
solid/chevron-right
|
solid/chevron-right
|
||||||
solid/circle-check
|
solid/circle-check
|
||||||
solid/circle-exclamation
|
solid/circle-exclamation
|
||||||
|
|||||||
@@ -0,0 +1,184 @@
|
|||||||
|
import { css } from 'lit';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The Explore album card, once.
|
||||||
|
*
|
||||||
|
* Two components draw one — `explore-view`'s shelves and search
|
||||||
|
* results, and `explore-artist-details`'s discography — and they had
|
||||||
|
* grown two copies of the same rules. That is how the size came apart:
|
||||||
|
* `explore-view` clamped its cards to a 130–150px range so two cards in
|
||||||
|
* one row could be different widths, and since the artwork is square
|
||||||
|
* that made them different *heights* as well. A row of covers with
|
||||||
|
* ragged bottoms is the whole complaint.
|
||||||
|
*
|
||||||
|
* So the width is a fixed `--yj-album-card-width` and the lines below
|
||||||
|
* the art each reserve their own space, which is what makes every card
|
||||||
|
* the same size no matter what a given album happens to carry —
|
||||||
|
* `album-card-size.test.ts` measures that rather than trusting it.
|
||||||
|
*
|
||||||
|
* Three rules here are the parts that changed rather than moved.
|
||||||
|
*
|
||||||
|
* **The artwork is inset in the square, not cropped to it.** The
|
||||||
|
* container was already `aspect-ratio: 1` but the image was
|
||||||
|
* `object-fit: cover`, so a non-square cover lost its edges. It is
|
||||||
|
* `contain` now and the container's own background is transparent, so
|
||||||
|
* a tall or wide cover sits in the middle of the square with the page
|
||||||
|
* showing through beside it.
|
||||||
|
*
|
||||||
|
* **The badge lives on the artwork, top-left, and only under the
|
||||||
|
* pointer.** It used to sit in the metadata line and only for the
|
||||||
|
* unowned case. It draws for every card now — an owned album's tick is
|
||||||
|
* the answer to the same question — and it is revealed by hover on a
|
||||||
|
* pointer device. Where there is no hover it is *always* visible rather
|
||||||
|
* than never, because on those devices it is the only route to its
|
||||||
|
* action: `explore-view`'s card menu carries no request item, so a
|
||||||
|
* phone with the badge hidden could not ask for an album at all.
|
||||||
|
*
|
||||||
|
* **Nothing dims an unowned card.** `unownedStyles` was removed from
|
||||||
|
* the catalog surfaces on the rule that the badge is the mark; the
|
||||||
|
* album page's *tracklist* still dims unowned rows, which is a
|
||||||
|
* different statement about a different thing.
|
||||||
|
*/
|
||||||
|
export const albumCardStyles = css`
|
||||||
|
.album-card {
|
||||||
|
width: var(--yj-album-card-width, 150px);
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
gap: 6px;
|
||||||
|
padding: 8px;
|
||||||
|
border-radius: 8px;
|
||||||
|
box-sizing: border-box;
|
||||||
|
flex-shrink: 0;
|
||||||
|
cursor: pointer;
|
||||||
|
transition: background 0.15s ease;
|
||||||
|
}
|
||||||
|
|
||||||
|
.album-card:hover {
|
||||||
|
background: var(--yj-bg-overlay, rgba(255, 255, 255, 0.06));
|
||||||
|
}
|
||||||
|
|
||||||
|
.album-card:active {
|
||||||
|
transform: scale(0.97);
|
||||||
|
}
|
||||||
|
|
||||||
|
.album-card:focus-visible {
|
||||||
|
outline: 2px solid var(--yj-accent-text, #ffd43b);
|
||||||
|
outline-offset: -2px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.album-art-container {
|
||||||
|
position: relative;
|
||||||
|
width: 100%;
|
||||||
|
aspect-ratio: 1;
|
||||||
|
border-radius: 4px;
|
||||||
|
overflow: hidden;
|
||||||
|
background: transparent;
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
.album-art-container img {
|
||||||
|
width: 100%;
|
||||||
|
height: 100%;
|
||||||
|
object-fit: contain;
|
||||||
|
display: block;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* The placeholder is the one case that *is* a full square, so it
|
||||||
|
carries the background the container gave up. */
|
||||||
|
.album-art-fallback {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
width: 100%;
|
||||||
|
height: 100%;
|
||||||
|
position: absolute;
|
||||||
|
inset: 0;
|
||||||
|
background: linear-gradient(
|
||||||
|
135deg,
|
||||||
|
var(--yj-bg-overlay, #404040) 0%,
|
||||||
|
var(--yj-bg-surface, #282828) 100%
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
.album-art-fallback wa-icon {
|
||||||
|
color: var(--yj-text-tertiary, #888);
|
||||||
|
font-size: 24px;
|
||||||
|
opacity: 0.5;
|
||||||
|
}
|
||||||
|
|
||||||
|
.album-card-badge {
|
||||||
|
position: absolute;
|
||||||
|
top: 6px;
|
||||||
|
left: 6px;
|
||||||
|
z-index: 1;
|
||||||
|
display: flex;
|
||||||
|
visibility: hidden;
|
||||||
|
opacity: 0;
|
||||||
|
transition: opacity 0.15s ease, visibility 0.15s ease;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (hover: hover) and (pointer: fine) {
|
||||||
|
.album-card:hover .album-card-badge,
|
||||||
|
.album-card:focus-within .album-card-badge {
|
||||||
|
visibility: visible;
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@media not all and (hover: hover) {
|
||||||
|
.album-card-badge {
|
||||||
|
visibility: visible;
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.album-title {
|
||||||
|
font-weight: 500;
|
||||||
|
color: var(--yj-text-primary, #fff);
|
||||||
|
font-size: var(--yj-text-sm);
|
||||||
|
line-height: 1.3;
|
||||||
|
white-space: nowrap;
|
||||||
|
overflow: hidden;
|
||||||
|
text-overflow: ellipsis;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Reserved even where a surface has no artist to draw, so a card
|
||||||
|
in a row is never shorter than its neighbour. */
|
||||||
|
.album-artist {
|
||||||
|
color: var(--yj-text-tertiary, #888);
|
||||||
|
font-size: var(--yj-text-xs);
|
||||||
|
line-height: 1.3;
|
||||||
|
min-height: 1.3em;
|
||||||
|
white-space: nowrap;
|
||||||
|
overflow: hidden;
|
||||||
|
text-overflow: ellipsis;
|
||||||
|
}
|
||||||
|
|
||||||
|
.album-meta {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: space-between;
|
||||||
|
gap: 6px;
|
||||||
|
color: var(--yj-text-tertiary, #888);
|
||||||
|
font-size: var(--yj-text-xs);
|
||||||
|
height: 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.album-meta-text {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 6px;
|
||||||
|
min-width: 0;
|
||||||
|
overflow: hidden;
|
||||||
|
}
|
||||||
|
|
||||||
|
.type-badge {
|
||||||
|
background: var(--yj-bg-overlay, rgba(255, 255, 255, 0.08));
|
||||||
|
padding: 1px 6px;
|
||||||
|
border-radius: 3px;
|
||||||
|
font-size: 10px;
|
||||||
|
white-space: nowrap;
|
||||||
|
}
|
||||||
|
`;
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
/**
|
||||||
|
* Opening an external page, with the destination pinned.
|
||||||
|
*
|
||||||
|
* Every external link this app opens is a MusicBrainz entity page built
|
||||||
|
* from an MBID that came from the catalog. Constructing the URL by
|
||||||
|
* string concatenation leaves the destination to whatever is in that
|
||||||
|
* string, so this parses it against the one origin the app means and
|
||||||
|
* refuses anything else — an MBID cannot change the host, and if it
|
||||||
|
* somehow did, nothing would open.
|
||||||
|
*
|
||||||
|
* It navigates through a real anchor rather than `window.open`: the
|
||||||
|
* same top-level `_blank` navigation with `noopener`, and it keeps the
|
||||||
|
* destination an ordinary link rather than an argument to a function
|
||||||
|
* whose first parameter is a URL.
|
||||||
|
*/
|
||||||
|
const MUSICBRAINZ_ORIGIN = 'https://musicbrainz.org';
|
||||||
|
|
||||||
|
export function openMusicBrainz(path: string): void {
|
||||||
|
const url = new URL(path, MUSICBRAINZ_ORIGIN);
|
||||||
|
|
||||||
|
if (url.origin !== MUSICBRAINZ_ORIGIN) return;
|
||||||
|
|
||||||
|
const link = document.createElement('a');
|
||||||
|
|
||||||
|
link.href = url.toString();
|
||||||
|
link.target = '_blank';
|
||||||
|
link.rel = 'noopener noreferrer';
|
||||||
|
link.click();
|
||||||
|
}
|
||||||
@@ -10,6 +10,16 @@
|
|||||||
* badge as the only difference. This is that rule, written once, so
|
* badge as the only difference. This is that rule, written once, so
|
||||||
* eight surfaces cannot each keep their own version of it.
|
* eight surfaces cannot each keep their own version of it.
|
||||||
*
|
*
|
||||||
|
* **The catalog's *cards* no longer dim.** A grid of dimmed covers read
|
||||||
|
* as a page that had failed to load rather than as a page of things you
|
||||||
|
* could ask for, so on Explore the mark is the badge alone — over the
|
||||||
|
* artwork, on hover, drawn for owned and unowned alike. The album
|
||||||
|
* page's *tracklist* still dims unowned rows: that is a different
|
||||||
|
* statement ("this one is not here") about a different thing, and the
|
||||||
|
* `aria-disabled` row that cannot be played is what it is for. So
|
||||||
|
* `unownedStyles` survives for that one surface and the cards simply do
|
||||||
|
* not include it.
|
||||||
|
*
|
||||||
* ## Ownership is a file, and `localId` is the flag that says so
|
* ## Ownership is a file, and `localId` is the flag that says so
|
||||||
*
|
*
|
||||||
* The album page answers "do I own this row" with `filePaths`, a map
|
* The album page answers "do I own this row" with `filePaths`, a map
|
||||||
@@ -96,7 +106,8 @@ export function ownershipLabel(
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The dimming, shared so it cannot drift across surfaces.
|
* The dimming, shared so it cannot drift across surfaces — and now
|
||||||
|
* used by exactly one of them.
|
||||||
*
|
*
|
||||||
* Two things about it are load-bearing.
|
* Two things about it are load-bearing.
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -0,0 +1,174 @@
|
|||||||
|
/**
|
||||||
|
* Every album card is the same size, and its artwork is a square.
|
||||||
|
*
|
||||||
|
* The size came apart because `explore-view` clamped its cards to a
|
||||||
|
* 130–150px range, so two cards in one row could be different widths —
|
||||||
|
* and since the artwork is square, different *heights* as well. A row
|
||||||
|
* of covers with ragged bottoms is what that looks like.
|
||||||
|
*
|
||||||
|
* What makes the fix hold is that the lines below the art each reserve
|
||||||
|
* their own space (`album-card.css.ts`), so an album with no year, no
|
||||||
|
* release type or a one-character title is not shorter than its
|
||||||
|
* neighbour. This measures that rather than trusting it, because the
|
||||||
|
* next component to format a card is the way it comes back.
|
||||||
|
*
|
||||||
|
* The artwork half is the other change: the container was already
|
||||||
|
* square but the image was `object-fit: cover`, so a non-square cover
|
||||||
|
* was cropped to it. It is `contain` now, and the container has no
|
||||||
|
* background of its own, so a tall cover is inset with the page
|
||||||
|
* showing through beside it.
|
||||||
|
*/
|
||||||
|
import { beforeEach, describe, expect, it } from 'vitest';
|
||||||
|
import type { LitElement } from 'lit';
|
||||||
|
|
||||||
|
import '@components/explore-view/explore-view';
|
||||||
|
import { flush, stub, resetHarness } from '@test/support/harness';
|
||||||
|
import { fixture, shadow, shadowAll, update } from '@test/support/render';
|
||||||
|
import { completenessStore } from '@store/completeness-store';
|
||||||
|
|
||||||
|
const SEARCH = 'explore.Service.SearchLocal';
|
||||||
|
const SHELVES = 'explore.Service.GetExploreShelves';
|
||||||
|
|
||||||
|
/** A 1x1 transparent gif, so the `<img>` branch renders. */
|
||||||
|
const TINY_IMAGE =
|
||||||
|
'data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7';
|
||||||
|
|
||||||
|
/** Release groups chosen so every optional line is present on one and
|
||||||
|
* absent on another — that is what a size regression hides behind. */
|
||||||
|
const ALBUMS = [
|
||||||
|
{
|
||||||
|
mbid: 'rg-1',
|
||||||
|
title: 'A',
|
||||||
|
artistCredit: '',
|
||||||
|
artistMbid: 'ar-1',
|
||||||
|
primaryType: '',
|
||||||
|
firstReleaseDate: '',
|
||||||
|
popularity: 1,
|
||||||
|
listenerCount: 1,
|
||||||
|
secondaryTypes: [],
|
||||||
|
inLibrary: false,
|
||||||
|
localId: 0,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
mbid: 'rg-2',
|
||||||
|
title: 'A Very Long Album Name That Will Certainly Be Truncated By The Card',
|
||||||
|
artistCredit: 'An Artist With A Long Name',
|
||||||
|
artistMbid: 'ar-2',
|
||||||
|
primaryType: 'Album',
|
||||||
|
firstReleaseDate: '1994-05-01',
|
||||||
|
popularity: 1,
|
||||||
|
listenerCount: 1,
|
||||||
|
secondaryTypes: [],
|
||||||
|
inLibrary: false,
|
||||||
|
localId: 0,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
mbid: 'rg-3',
|
||||||
|
title: 'Three',
|
||||||
|
artistCredit: 'Another',
|
||||||
|
artistMbid: 'ar-3',
|
||||||
|
primaryType: 'EP',
|
||||||
|
firstReleaseDate: '2001-01-01',
|
||||||
|
popularity: 1,
|
||||||
|
listenerCount: 1,
|
||||||
|
secondaryTypes: [],
|
||||||
|
inLibrary: false,
|
||||||
|
localId: 0,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
async function exploreWithAlbums(): Promise<LitElement> {
|
||||||
|
stub(SHELVES, { shelves: [], state: 'ready' });
|
||||||
|
stub(SEARCH, {
|
||||||
|
artists: [],
|
||||||
|
releaseGroups: ALBUMS,
|
||||||
|
recordings: [],
|
||||||
|
});
|
||||||
|
stub('explore.Service.GetThumbnails', Object.fromEntries(
|
||||||
|
ALBUMS.map((a) => [a.mbid, TINY_IMAGE]),
|
||||||
|
));
|
||||||
|
stub('explore.Service.GetThumbnail', TINY_IMAGE);
|
||||||
|
|
||||||
|
const el = await fixture<LitElement>('explore-view');
|
||||||
|
|
||||||
|
(el as unknown as { onViewActivate: () => void }).onViewActivate?.();
|
||||||
|
await update(el, {
|
||||||
|
results: { artists: [], releaseGroups: ALBUMS, recordings: [] },
|
||||||
|
});
|
||||||
|
await flush();
|
||||||
|
await el.updateComplete;
|
||||||
|
|
||||||
|
return el;
|
||||||
|
}
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
resetHarness();
|
||||||
|
stub('library.Library.GetAlbumsCompleteness', {});
|
||||||
|
completenessStore.invalidate();
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('the album card size', () => {
|
||||||
|
it('is the same width and height for every card in a row', async () => {
|
||||||
|
const el = await exploreWithAlbums();
|
||||||
|
const cards = shadowAll(el, '.album-card');
|
||||||
|
|
||||||
|
expect(cards.length).toBe(ALBUMS.length);
|
||||||
|
|
||||||
|
const boxes = cards.map((c) => c.getBoundingClientRect());
|
||||||
|
|
||||||
|
// The first card is the reference; every other one must match it.
|
||||||
|
for (const box of boxes) {
|
||||||
|
expect(box.width).toBe(boxes[0]!.width);
|
||||||
|
expect(box.height).toBe(boxes[0]!.height);
|
||||||
|
}
|
||||||
|
|
||||||
|
// …and the reference is a real box, or the loop above is vacuous.
|
||||||
|
expect(boxes[0]!.width).toBeGreaterThan(0);
|
||||||
|
expect(boxes[0]!.height).toBeGreaterThan(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('keeps the artwork square', async () => {
|
||||||
|
const el = await exploreWithAlbums();
|
||||||
|
|
||||||
|
for (const art of shadowAll(el, '.album-art-container')) {
|
||||||
|
const box = art.getBoundingClientRect();
|
||||||
|
|
||||||
|
expect(Math.round(box.width)).toBe(Math.round(box.height));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
it('insets a non-square cover rather than cropping it', async () => {
|
||||||
|
const el = await exploreWithAlbums();
|
||||||
|
|
||||||
|
// Read from the parsed stylesheet rather than from a rendered
|
||||||
|
// `<img>`: the search path is what calls `loadThumbnails`, and
|
||||||
|
// setting `results` directly skips it, so there is no image to
|
||||||
|
// measure. The regression worth catching is the rule going back to
|
||||||
|
// `cover`, which is a stylesheet fact.
|
||||||
|
const rules = (el.shadowRoot?.adoptedStyleSheets ?? []).flatMap((sheet) =>
|
||||||
|
Array.from(sheet.cssRules).map((rule) => rule.cssText),
|
||||||
|
);
|
||||||
|
const art = rules.find(
|
||||||
|
(text) =>
|
||||||
|
text.startsWith('.album-art-container img') &&
|
||||||
|
text.includes('object-fit'),
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(art, 'no object-fit rule for the cover image').toBeDefined();
|
||||||
|
expect(art).toContain('object-fit: contain');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('draws the badge over the artwork, and not in the metadata line', async () => {
|
||||||
|
const el = await exploreWithAlbums();
|
||||||
|
const card = shadow(el, '.album-card')!;
|
||||||
|
|
||||||
|
const badge = card.querySelector('.album-art-container .album-card-badge');
|
||||||
|
|
||||||
|
expect(badge).not.toBeNull();
|
||||||
|
// The badge is positioned inside the art box, so its parent is the
|
||||||
|
// square rather than the row underneath it.
|
||||||
|
expect(badge?.parentElement?.classList.contains('album-art-container')).toBe(
|
||||||
|
true,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,168 @@
|
|||||||
|
/**
|
||||||
|
* The artist page's header and its top tracks.
|
||||||
|
*
|
||||||
|
* Two cleanups, asserted together because they are one screen:
|
||||||
|
*
|
||||||
|
* - the Play/Shuffle pair became one split button ("Play" with the
|
||||||
|
* words on its title, Shuffle behind the caret), the Follow button
|
||||||
|
* moved onto the same line, and the name and listen count went up a
|
||||||
|
* size;
|
||||||
|
* - a top track's play/request affordance moved onto its artwork,
|
||||||
|
* where a hover reveals it, instead of a badge at the end of the
|
||||||
|
* row beside a row that already plays on a double-click.
|
||||||
|
*/
|
||||||
|
import { describe, expect, it, beforeEach } from 'vitest';
|
||||||
|
import type { LitElement } from 'lit';
|
||||||
|
|
||||||
|
import '@components/explore-artist-details/explore-artist-details';
|
||||||
|
import { stub, flush, emit, resetHarness } from '@test/support/harness';
|
||||||
|
import { Events } from '../../src/events';
|
||||||
|
import { fixture, shadow, shadowAll } from '@test/support/render';
|
||||||
|
|
||||||
|
const ARTIST = 'artist-0001';
|
||||||
|
|
||||||
|
const track = (name: string, localId = 0) => ({
|
||||||
|
recordingMbid: `rec-${name}`,
|
||||||
|
artistName: 'Tideline',
|
||||||
|
trackName: name,
|
||||||
|
totalListenCount: 100,
|
||||||
|
caaReleaseMbid: '',
|
||||||
|
releaseName: 'Foreshore',
|
||||||
|
releaseGroupMbid: 'rg-owned',
|
||||||
|
length: 200000,
|
||||||
|
inLibrary: localId > 0,
|
||||||
|
localId,
|
||||||
|
});
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
resetHarness();
|
||||||
|
|
||||||
|
stub('explore.Service.LookupArtist', {
|
||||||
|
mbid: ARTIST,
|
||||||
|
name: 'Tideline',
|
||||||
|
popularity: 1200,
|
||||||
|
type: 'Group',
|
||||||
|
country: 'GB',
|
||||||
|
});
|
||||||
|
stub('explore.Service.TopReleaseGroupsForArtist', []);
|
||||||
|
stub('explore.Service.TopRecordingsForArtist', [
|
||||||
|
track('Owned Song', 7),
|
||||||
|
track('Absent Song'),
|
||||||
|
]);
|
||||||
|
stub('explore.Service.SimilarArtists', []);
|
||||||
|
stub('explore.Service.PrefetchReleases', undefined);
|
||||||
|
stub('explore.Service.BrowseReleaseGroups', [
|
||||||
|
{
|
||||||
|
mbid: 'rg-owned',
|
||||||
|
title: 'Foreshore',
|
||||||
|
artistCredit: 'Tideline',
|
||||||
|
primaryType: 'Album',
|
||||||
|
inLibrary: true,
|
||||||
|
localId: 7,
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
stub('library.Library.GetAlbumsCompleteness', {});
|
||||||
|
stub('download.Service.ListRequests', []);
|
||||||
|
});
|
||||||
|
|
||||||
|
async function mount(): Promise<LitElement> {
|
||||||
|
const el = await fixture<LitElement>('explore-artist-details', {
|
||||||
|
artistMBID: ARTIST,
|
||||||
|
artistName: 'Tideline',
|
||||||
|
});
|
||||||
|
|
||||||
|
await flush();
|
||||||
|
|
||||||
|
return el;
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('the artist header', () => {
|
||||||
|
it('offers Play, with Shuffle behind its caret', async () => {
|
||||||
|
const el = await mount();
|
||||||
|
const play = shadow<HTMLElement>(el, '[data-testid="artist-play-library"]')!;
|
||||||
|
|
||||||
|
// The words moved to the title, which is where "Play library
|
||||||
|
// tracks" can still be read without taking the width of a button.
|
||||||
|
expect(play.textContent?.trim()).toBe('Play');
|
||||||
|
expect(play.getAttribute('title')).toBe('Play library tracks');
|
||||||
|
|
||||||
|
const menuButton = shadow(el, '[data-testid="artist-play-menu"]');
|
||||||
|
|
||||||
|
expect(menuButton).not.toBeNull();
|
||||||
|
|
||||||
|
const menu = shadow(el, '#artist-play-menu');
|
||||||
|
|
||||||
|
expect(menu?.textContent).toContain('Shuffle');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('puts Follow on the same line as Play', async () => {
|
||||||
|
const el = await mount();
|
||||||
|
const actions = shadow(el, '.artist-actions')!;
|
||||||
|
|
||||||
|
expect(actions.querySelector('[data-testid="artist-play-library"]')).not.toBeNull();
|
||||||
|
|
||||||
|
const follow = actions.querySelector('[data-testid="artist-follow"]') as HTMLElement;
|
||||||
|
|
||||||
|
expect(follow).not.toBeNull();
|
||||||
|
expect(follow.textContent?.trim()).toBe('Follow');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('says Following once the artist is on the request list', async () => {
|
||||||
|
const el = await mount();
|
||||||
|
|
||||||
|
// The store is a singleton and caches its list, so the change is
|
||||||
|
// announced the way the backend announces one.
|
||||||
|
stub('download.Service.ListRequests', [
|
||||||
|
{ id: 3, mbid: ARTIST, state: 'queued' },
|
||||||
|
]);
|
||||||
|
emit(Events.RequestsChanged);
|
||||||
|
await flush();
|
||||||
|
await el.updateComplete;
|
||||||
|
|
||||||
|
const follow = shadow<HTMLElement>(el, '[data-testid="artist-follow"]')!;
|
||||||
|
|
||||||
|
expect(follow.textContent?.trim()).toBe('Following');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('sizes the name and the listen count above the metadata line', async () => {
|
||||||
|
const el = await mount();
|
||||||
|
|
||||||
|
const title = shadow<HTMLElement>(el, '.artist-title')!;
|
||||||
|
const listens = shadow<HTMLElement>(el, '.artist-listens')!;
|
||||||
|
const meta = shadow<HTMLElement>(el, '.artist-meta')!;
|
||||||
|
|
||||||
|
expect(listens.textContent).toContain('plays on ListenBrainz');
|
||||||
|
|
||||||
|
const titleSize = parseFloat(getComputedStyle(title).fontSize);
|
||||||
|
const listensSize = parseFloat(getComputedStyle(listens).fontSize);
|
||||||
|
const metaSize = parseFloat(getComputedStyle(meta).fontSize);
|
||||||
|
|
||||||
|
expect(titleSize).toBeGreaterThan(24);
|
||||||
|
expect(listensSize).toBeGreaterThan(metaSize);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('a top track’s affordance', () => {
|
||||||
|
it('plays from the artwork when it is owned', async () => {
|
||||||
|
const el = await mount();
|
||||||
|
const rows = shadowAll<HTMLElement>(el, '.track-item');
|
||||||
|
|
||||||
|
const owned = rows.find((r) => r.textContent?.includes('Owned Song'))!;
|
||||||
|
|
||||||
|
expect(owned.querySelector('.track-art-overlay .track-art-play')).not.toBeNull();
|
||||||
|
// Nothing beside the row any more.
|
||||||
|
expect(owned.querySelector(':scope > library-status-indicator')).toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('requests from the artwork when it is not', async () => {
|
||||||
|
const el = await mount();
|
||||||
|
const rows = shadowAll<HTMLElement>(el, '.track-item');
|
||||||
|
|
||||||
|
const absent = rows.find((r) => r.textContent?.includes('Absent Song'))!;
|
||||||
|
|
||||||
|
expect(
|
||||||
|
absent.querySelector('.track-art-overlay library-status-indicator'),
|
||||||
|
).not.toBeNull();
|
||||||
|
expect(absent.querySelector('.track-art-overlay .track-art-play')).toBeNull();
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -25,7 +25,9 @@ const ARTIST = 'artist-0001';
|
|||||||
|
|
||||||
/** The labels of the open menu's items, trimmed. */
|
/** The labels of the open menu's items, trimmed. */
|
||||||
function menuItems(el: LitElement): string[] {
|
function menuItems(el: LitElement): string[] {
|
||||||
const panel = shadow(el, '.context-menu-panel');
|
// Scoped to the context menu: the artist page also has a Play/Shuffle
|
||||||
|
// dropdown, and its panel carries the same class.
|
||||||
|
const panel = shadow(el, '#context-menu .context-menu-panel');
|
||||||
|
|
||||||
if (!panel) return [];
|
if (!panel) return [];
|
||||||
|
|
||||||
@@ -100,7 +102,7 @@ describe('the context menu on an artist page release', () => {
|
|||||||
|
|
||||||
await openMenuOnAlbum(el, 0);
|
await openMenuOnAlbum(el, 0);
|
||||||
|
|
||||||
const panel = shadow(el, '.context-menu-panel');
|
const panel = shadow(el, '#context-menu .context-menu-panel');
|
||||||
|
|
||||||
expect(panel).toBeTruthy();
|
expect(panel).toBeTruthy();
|
||||||
// The panel is shared with the track menu, so a label that does not
|
// The panel is shared with the track menu, so a label that does not
|
||||||
|
|||||||
@@ -0,0 +1,131 @@
|
|||||||
|
/**
|
||||||
|
* A horizontally scrolling row can be moved without a wheel.
|
||||||
|
*
|
||||||
|
* Until this existed the only way to see the cards past the fold on the
|
||||||
|
* shelves, the search results and the artist page's discography was a
|
||||||
|
* mousewheel or a trackpad gesture — which is not an affordance. A
|
||||||
|
* mouse with no horizontal wheel simply could not reach them.
|
||||||
|
*
|
||||||
|
* What is asserted here is the state that makes the arrows honest: an
|
||||||
|
* arrow is `hidden` at the end it cannot move from, because a control
|
||||||
|
* that cannot act is worse than none, and an invisible one still holds
|
||||||
|
* a hit area and a tab stop.
|
||||||
|
*/
|
||||||
|
import { beforeEach, describe, expect, it } from 'vitest';
|
||||||
|
import type { LitElement } from 'lit';
|
||||||
|
|
||||||
|
import '@components/scroll-row/scroll-row';
|
||||||
|
import { fixture } from '@test/support/render';
|
||||||
|
|
||||||
|
/** Six 100px cards in a 320px row — comfortably overflowing. */
|
||||||
|
function content(el: Element): void {
|
||||||
|
for (let i = 0; i < 6; i += 1) {
|
||||||
|
const card = document.createElement('div');
|
||||||
|
|
||||||
|
card.style.cssText = 'flex: 0 0 100px; height: 40px';
|
||||||
|
card.textContent = String(i);
|
||||||
|
el.append(card);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function arrows(el: LitElement): { prev: HTMLButtonElement; next: HTMLButtonElement } {
|
||||||
|
const root = el.shadowRoot!;
|
||||||
|
|
||||||
|
return {
|
||||||
|
prev: root.querySelector('.arrow.prev') as HTMLButtonElement,
|
||||||
|
next: root.querySelector('.arrow.next') as HTMLButtonElement,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function viewport(el: LitElement): HTMLElement {
|
||||||
|
return el.shadowRoot!.querySelector('.viewport') as HTMLElement;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function row(): Promise<LitElement> {
|
||||||
|
const el = await fixture<LitElement>('scroll-row');
|
||||||
|
|
||||||
|
el.style.display = 'block';
|
||||||
|
el.style.width = '320px';
|
||||||
|
content(el);
|
||||||
|
await el.updateComplete;
|
||||||
|
// The observer reports on a later frame than a microtask drain.
|
||||||
|
await new Promise((r) => setTimeout(r, 60));
|
||||||
|
await el.updateComplete;
|
||||||
|
|
||||||
|
return el;
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('<scroll-row>', () => {
|
||||||
|
beforeEach(() => {
|
||||||
|
document.body.style.margin = '0';
|
||||||
|
});
|
||||||
|
|
||||||
|
it('draws an arrow for each direction it can still move', async () => {
|
||||||
|
const el = await row();
|
||||||
|
const { prev, next } = arrows(el);
|
||||||
|
|
||||||
|
expect(prev).not.toBeNull();
|
||||||
|
expect(next).not.toBeNull();
|
||||||
|
|
||||||
|
// At the start there is nothing behind, so only the forward arrow is
|
||||||
|
// offered.
|
||||||
|
expect(prev.hasAttribute('hidden')).toBe(true);
|
||||||
|
expect(next.hasAttribute('hidden')).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('offers the way back once the row has moved', async () => {
|
||||||
|
const el = await row();
|
||||||
|
const vp = viewport(el);
|
||||||
|
|
||||||
|
vp.scrollLeft = 120;
|
||||||
|
vp.dispatchEvent(new Event('scroll'));
|
||||||
|
await el.updateComplete;
|
||||||
|
|
||||||
|
expect(arrows(el).prev.hasAttribute('hidden')).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('stands the forward arrow down at the end', async () => {
|
||||||
|
const el = await row();
|
||||||
|
const vp = viewport(el);
|
||||||
|
|
||||||
|
vp.scrollLeft = vp.scrollWidth;
|
||||||
|
vp.dispatchEvent(new Event('scroll'));
|
||||||
|
await el.updateComplete;
|
||||||
|
|
||||||
|
expect(arrows(el).next.hasAttribute('hidden')).toBe(true);
|
||||||
|
expect(arrows(el).prev.hasAttribute('hidden')).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('moves the row when the arrow is pressed', async () => {
|
||||||
|
const el = await row();
|
||||||
|
const vp = viewport(el);
|
||||||
|
|
||||||
|
expect(vp.scrollLeft).toBe(0);
|
||||||
|
|
||||||
|
arrows(el).next.click();
|
||||||
|
|
||||||
|
await expect.poll(() => vp.scrollLeft).toBeGreaterThan(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('shows nothing to scroll when the content fits', async () => {
|
||||||
|
const el = await fixture<LitElement>('scroll-row');
|
||||||
|
|
||||||
|
el.style.cssText = 'display: block; width: 320px';
|
||||||
|
|
||||||
|
const only = document.createElement('div');
|
||||||
|
|
||||||
|
only.style.cssText = 'flex: 0 0 100px; height: 40px';
|
||||||
|
only.textContent = 'one';
|
||||||
|
el.append(only);
|
||||||
|
await el.updateComplete;
|
||||||
|
await new Promise((r) => setTimeout(r, 60));
|
||||||
|
await el.updateComplete;
|
||||||
|
await new Promise((r) => requestAnimationFrame(() => r(null)));
|
||||||
|
await el.updateComplete;
|
||||||
|
|
||||||
|
const { prev, next } = arrows(el);
|
||||||
|
|
||||||
|
expect(prev.hasAttribute('hidden')).toBe(true);
|
||||||
|
expect(next.hasAttribute('hidden')).toBe(true);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -1,24 +1,28 @@
|
|||||||
/**
|
/**
|
||||||
* Owned is plain; unowned is what gets marked.
|
* The catalog's cards are not dimmed; the badge is the mark.
|
||||||
*
|
*
|
||||||
* `explore-album-details` had this right for one tracklist and nothing
|
* The rule this replaced had every unowned card dimmed *and* badged,
|
||||||
* else did: Explore's cards, the top-results row and the artist page's
|
* which on a shelf of mostly-unowned covers read as a page that had
|
||||||
* three card shapes all mixed owned and unowned with a small badge as
|
* failed to load rather than a page of things you could ask for. So the
|
||||||
* the only difference — and drew a green tick on the *common* case,
|
* dimming is gone from the catalog surfaces and the badge carries the
|
||||||
* which is the treatment the album page's own green ticks were removed
|
* whole statement — over the artwork, on hover, drawn for owned and
|
||||||
* for.
|
* unowned alike.
|
||||||
*
|
*
|
||||||
* What is pinned here is the rule rather than any one surface, because
|
* What is still pinned here is the half that was never about dimming:
|
||||||
* the fault this replaced was eight call sites each holding their own
|
|
||||||
* version of it:
|
|
||||||
*
|
*
|
||||||
* - an owned thing draws **no badge at all**;
|
|
||||||
* - an unowned one is dimmed *and* says so in its accessible name,
|
|
||||||
* because dimming is a colour and cannot be the only signal;
|
|
||||||
* - ownership is a **file** (`localId`), never the catalog's
|
* - ownership is a **file** (`localId`), never the catalog's
|
||||||
* `inLibrary` ratchet, which is a flag that happens to agree;
|
* `inLibrary` ratchet, which is a flag that happens to agree;
|
||||||
* - and a partly-held album says *how* partly, which is the one thing
|
* - a row that cannot be played is `aria-disabled`, while a card that
|
||||||
* a tick cannot.
|
* still navigates is not;
|
||||||
|
* - a partly-held album says *how* partly, which is the one thing a
|
||||||
|
* tick cannot;
|
||||||
|
* - and an unowned thing still says so in its accessible name, because
|
||||||
|
* with the dimming gone that name is the whole signal for anyone not
|
||||||
|
* seeing the badge.
|
||||||
|
*
|
||||||
|
* The album page's *tracklist* still dims unowned rows — a different
|
||||||
|
* statement about a different thing — and is covered by
|
||||||
|
* `album-request-badge-visibility.test.ts`.
|
||||||
*/
|
*/
|
||||||
import { beforeEach, describe, expect, it } from 'vitest';
|
import { beforeEach, describe, expect, it } from 'vitest';
|
||||||
import { page } from 'vitest/browser';
|
import { page } from 'vitest/browser';
|
||||||
@@ -26,7 +30,7 @@ import { page } from 'vitest/browser';
|
|||||||
import '@components/explore-view/explore-view';
|
import '@components/explore-view/explore-view';
|
||||||
import '@components/top-results-row/top-results-row';
|
import '@components/top-results-row/top-results-row';
|
||||||
import { flush, stub, resetHarness } from '@test/support/harness';
|
import { flush, stub, resetHarness } from '@test/support/harness';
|
||||||
import { fixture, shadow, shadowAll, update } from '@test/support/render';
|
import { fixture, shadow, update } from '@test/support/render';
|
||||||
import { completenessStore } from '@store/completeness-store';
|
import { completenessStore } from '@store/completeness-store';
|
||||||
|
|
||||||
const SEARCH = 'explore.Service.SearchLocal';
|
const SEARCH = 'explore.Service.SearchLocal';
|
||||||
@@ -105,27 +109,44 @@ beforeEach(() => {
|
|||||||
// absent one — which is the point, or 87% of a grid re-asks forever.
|
// absent one — which is the point, or 87% of a grid re-asks forever.
|
||||||
// Two tests in one file are two sessions as far as it is concerned,
|
// Two tests in one file are two sessions as far as it is concerned,
|
||||||
// so a stale entry from the test above would otherwise decide the
|
// so a stale entry from the test above would otherwise decide the
|
||||||
// one below. Found by writing the assertion the wrong way round.
|
// one below.
|
||||||
completenessStore.invalidate();
|
completenessStore.invalidate();
|
||||||
});
|
});
|
||||||
|
|
||||||
describe('an owned thing is plain', () => {
|
describe('an unowned card is marked by its badge alone', () => {
|
||||||
it('draws no badge on an album card it has files for', async () => {
|
it('does not dim the artwork', async () => {
|
||||||
|
const el = await exploreShowing({
|
||||||
|
releaseGroups: [album('Absent', {})],
|
||||||
|
});
|
||||||
|
|
||||||
|
const art = shadow(el, '.album-card .album-art-container')!;
|
||||||
|
|
||||||
|
// The dimming was an opacity on this box. With it gone the cover is
|
||||||
|
// at full strength, and the badge is what says the card is not
|
||||||
|
// yours.
|
||||||
|
expect(getComputedStyle(art).opacity).toBe('1');
|
||||||
|
expect(shadow(el, '.album-card library-status-indicator')).not.toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('still says so in the name the browser computes', async () => {
|
||||||
|
await exploreShowing({ releaseGroups: [album('Absent', {})] });
|
||||||
|
|
||||||
|
await expect
|
||||||
|
.element(page.getByRole('button', { name: /Absent — not in your library/ }))
|
||||||
|
.toBeInTheDocument();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('an owned card is plain except for its badge', () => {
|
||||||
|
it('draws the in-library badge rather than nothing', async () => {
|
||||||
const el = await exploreShowing({
|
const el = await exploreShowing({
|
||||||
releaseGroups: [album('Held', { localId: 7 })],
|
releaseGroups: [album('Held', { localId: 7 })],
|
||||||
});
|
});
|
||||||
|
|
||||||
expect(shadowAll(el, '.album-card')).toHaveLength(1);
|
const badge = shadow(el, '.album-card library-status-indicator');
|
||||||
expect(shadow(el, '.album-card library-status-indicator')).toBeNull();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('draws no badge on a track row it has a file for', async () => {
|
expect(badge).not.toBeNull();
|
||||||
const el = await exploreShowing({
|
expect(badge?.getAttribute('status')).toBe('in-library');
|
||||||
recordings: [recording('Held', { localId: 9 })],
|
|
||||||
});
|
|
||||||
|
|
||||||
expect(shadowAll(el, '.track-item')).toHaveLength(1);
|
|
||||||
expect(shadow(el, '.track-item library-status-indicator')).toBeNull();
|
|
||||||
});
|
});
|
||||||
|
|
||||||
it('does not dim it', async () => {
|
it('does not dim it', async () => {
|
||||||
@@ -139,56 +160,6 @@ describe('an owned thing is plain', () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe('an unowned thing is marked', () => {
|
|
||||||
it('dims the card and keeps its request badge', async () => {
|
|
||||||
const el = await exploreShowing({
|
|
||||||
releaseGroups: [album('Absent', {})],
|
|
||||||
});
|
|
||||||
|
|
||||||
expect(shadow(el, '.album-card')?.classList.contains('unowned')).toBe(true);
|
|
||||||
expect(shadow(el, '.album-card library-status-indicator')).not.toBeNull();
|
|
||||||
});
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The name is the half of this that reaches anyone not seeing the
|
|
||||||
* dimming, so it has to be the browser's own answer — a shadow-root
|
|
||||||
* query cannot compute a name, and this repo has shipped a nameless
|
|
||||||
* control three times.
|
|
||||||
*/
|
|
||||||
it('says so in the name the browser computes', async () => {
|
|
||||||
await exploreShowing({ releaseGroups: [album('Absent', {})] });
|
|
||||||
|
|
||||||
await expect
|
|
||||||
.element(page.getByRole('button', { name: /Absent — not in your library/ }))
|
|
||||||
.toBeInTheDocument();
|
|
||||||
});
|
|
||||||
|
|
||||||
/**
|
|
||||||
* A track row is `aria-disabled` and a card is not, and the
|
|
||||||
* difference is not cosmetic: activating an unowned row does nothing
|
|
||||||
* (`onRecordingRowDblClick` returns early), while a card navigates to
|
|
||||||
* the catalog page for it, which is a perfectly good thing to do with
|
|
||||||
* something you do not own.
|
|
||||||
*/
|
|
||||||
it('marks a row that cannot be played as disabled', async () => {
|
|
||||||
const el = await exploreShowing({
|
|
||||||
recordings: [recording('Absent', {})],
|
|
||||||
});
|
|
||||||
|
|
||||||
expect(shadow(el, '.track-item')?.getAttribute('aria-disabled')).toBe(
|
|
||||||
'true',
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('leaves a card that still navigates enabled', async () => {
|
|
||||||
const el = await exploreShowing({
|
|
||||||
releaseGroups: [album('Absent', {})],
|
|
||||||
});
|
|
||||||
|
|
||||||
expect(shadow(el, '.album-card')?.getAttribute('aria-disabled')).toBeNull();
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The decision this issue turned on.
|
* The decision this issue turned on.
|
||||||
*
|
*
|
||||||
@@ -206,7 +177,9 @@ describe('ownership is a file, not a flag', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
expect(shadow(el, '.album-card')?.classList.contains('unowned')).toBe(true);
|
expect(shadow(el, '.album-card')?.classList.contains('unowned')).toBe(true);
|
||||||
expect(shadow(el, '.album-card library-status-indicator')).not.toBeNull();
|
expect(
|
||||||
|
shadow(el, '.album-card library-status-indicator')?.getAttribute('status'),
|
||||||
|
).not.toBe('in-library');
|
||||||
});
|
});
|
||||||
|
|
||||||
it('does the same for a track row', async () => {
|
it('does the same for a track row', async () => {
|
||||||
@@ -220,6 +193,26 @@ describe('ownership is a file, not a flag', () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe('a track row that cannot be played is disabled', () => {
|
||||||
|
it('marks an unowned row', async () => {
|
||||||
|
const el = await exploreShowing({
|
||||||
|
recordings: [recording('Absent', {})],
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(shadow(el, '.track-item')?.getAttribute('aria-disabled')).toBe(
|
||||||
|
'true',
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('leaves a card that still navigates enabled', async () => {
|
||||||
|
const el = await exploreShowing({
|
||||||
|
releaseGroups: [album('Absent', {})],
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(shadow(el, '.album-card')?.getAttribute('aria-disabled')).toBeNull();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The count, which is what `#16`'s deferred third step asked for: an
|
* The count, which is what `#16`'s deferred third step asked for: an
|
||||||
* album held 2 tracks of 10 wore the same green tick as one held whole,
|
* album held 2 tracks of 10 wore the same green tick as one held whole,
|
||||||
@@ -248,9 +241,13 @@ describe('a partly-held album says how partly', () => {
|
|||||||
|
|
||||||
// A partly-held album is *actionable* — it has three tracks left to
|
// A partly-held album is *actionable* — it has three tracks left to
|
||||||
// ask for — so the badge is a button, and the name has to carry the
|
// ask for — so the badge is a button, and the name has to carry the
|
||||||
// action and the count. Naming it after the action alone left the
|
// action and the count. The badge is revealed by the card's focus
|
||||||
// one state the ring exists for as the one state whose name did not
|
// (`:focus-within`), and `visibility: hidden` is what takes it out
|
||||||
// mention it.
|
// of the accessibility tree until then, so the card is focused
|
||||||
|
// first — which is exactly the route a keyboard user takes.
|
||||||
|
shadow<HTMLElement>(el, '.album-card')?.focus();
|
||||||
|
await el.updateComplete;
|
||||||
|
|
||||||
await expect
|
await expect
|
||||||
.element(
|
.element(
|
||||||
page.getByRole('button', {
|
page.getByRole('button', {
|
||||||
@@ -266,7 +263,7 @@ describe('a partly-held album says how partly', () => {
|
|||||||
* state, and a ring drawn from its absence would mark all of it
|
* state, and a ring drawn from its absence would mark all of it
|
||||||
* incomplete on no evidence. That is the rule `Known` exists for.
|
* incomplete on no evidence. That is the rule `Known` exists for.
|
||||||
*/
|
*/
|
||||||
it('says nothing when the total was never declared', async () => {
|
it('falls back to the plain in-library badge when the total was never declared', async () => {
|
||||||
stub(COMPLETENESS, {
|
stub(COMPLETENESS, {
|
||||||
'7': { owned: 3, expected: 0, known: false, complete: false },
|
'7': { owned: 3, expected: 0, known: false, complete: false },
|
||||||
});
|
});
|
||||||
@@ -279,7 +276,9 @@ describe('a partly-held album says how partly', () => {
|
|||||||
await flush();
|
await flush();
|
||||||
await el.updateComplete;
|
await el.updateComplete;
|
||||||
|
|
||||||
expect(shadow(el, '.album-card library-status-indicator')).toBeNull();
|
expect(
|
||||||
|
shadow(el, '.album-card library-status-indicator')?.getAttribute('status'),
|
||||||
|
).toBe('in-library');
|
||||||
});
|
});
|
||||||
|
|
||||||
it('asks about the owned albums only, in one call', async () => {
|
it('asks about the owned albums only, in one call', async () => {
|
||||||
@@ -329,11 +328,13 @@ describe('the top-results row follows the same rule', () => {
|
|||||||
query: 'held',
|
query: 'held',
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// A top-result card is a mixed bag — artist, album or track — and
|
||||||
|
// its badge is a corner mark rather than the cover overlay the
|
||||||
|
// album cards grew, so an owned one stays plain.
|
||||||
expect(shadow(el, '.card library-status-indicator')).toBeNull();
|
expect(shadow(el, '.card library-status-indicator')).toBeNull();
|
||||||
expect(shadow(el, '.card')?.classList.contains('unowned')).toBe(false);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
it('dims and names something it does not', async () => {
|
it('names something it does not own', async () => {
|
||||||
const el = await fixture('top-results-row', {
|
const el = await fixture('top-results-row', {
|
||||||
results: [result('Absent', 'release_group')],
|
results: [result('Absent', 'release_group')],
|
||||||
query: 'absent',
|
query: 'absent',
|
||||||
@@ -349,7 +350,7 @@ describe('the top-results row follows the same rule', () => {
|
|||||||
/**
|
/**
|
||||||
* An artist card has never had a badge — a discography subscription
|
* An artist card has never had a badge — a discography subscription
|
||||||
* is the artist page's Follow button, which can say what it commits
|
* is the artist page's Follow button, which can say what it commits
|
||||||
* to — so the dimming and the name are the whole signal there.
|
* to — so the name is the whole signal there.
|
||||||
*/
|
*/
|
||||||
it('marks an unowned artist without offering a request', async () => {
|
it('marks an unowned artist without offering a request', async () => {
|
||||||
const el = await fixture('top-results-row', {
|
const el = await fixture('top-results-row', {
|
||||||
|
|||||||
Reference in New Issue
Block a user