Compare commits
9
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f81a950916 | ||
|
|
7fbfd9c105 | ||
|
|
0a33b9d653 | ||
|
|
fc0121228e | ||
|
|
a5c3990d12 | ||
|
|
8dbdb7ad75 | ||
|
|
a205224a26 | ||
|
|
cf90030463 | ||
|
|
88f5524aa2 |
@@ -499,6 +499,10 @@ func (yj *YellowJacketApp) OnStartup(ctx context.Context) {
|
|||||||
PostRemove: yj.explore.InvalidateLibrarySync,
|
PostRemove: yj.explore.InvalidateLibrarySync,
|
||||||
})
|
})
|
||||||
|
|
||||||
|
// A deleted playlist must not leave the queue's "Playing from"
|
||||||
|
// label pointing at it.
|
||||||
|
yj.playlist.SetOnPlaylistDeleted(yj.queue.DropSourceForPlaylist)
|
||||||
|
|
||||||
// Register playback finished handler to drive queue auto-advance.
|
// Register playback finished handler to drive queue auto-advance.
|
||||||
yj.player.SetPlaybackFinishedHandler(yj.queue.OnPlaybackFinished)
|
yj.player.SetPlaybackFinishedHandler(yj.queue.OnPlaybackFinished)
|
||||||
|
|
||||||
@@ -776,6 +780,7 @@ func (yj *YellowJacketApp) startJanitor() {
|
|||||||
|
|
||||||
yj.janitor.Register(maintenance.ExpiredHTTPCacheJob(yj.database))
|
yj.janitor.Register(maintenance.ExpiredHTTPCacheJob(yj.database))
|
||||||
yj.janitor.Register(maintenance.StaleArtistMetadataJob(yj.database))
|
yj.janitor.Register(maintenance.StaleArtistMetadataJob(yj.database))
|
||||||
|
yj.janitor.Register(maintenance.StaleSearchClicksJob(yj.database))
|
||||||
yj.janitor.Register(maintenance.OrphanedCoverFilesJob(
|
yj.janitor.Register(maintenance.OrphanedCoverFilesJob(
|
||||||
yj.database, coversDir, library.CoverArtFileSet,
|
yj.database, coversDir, library.CoverArtFileSet,
|
||||||
))
|
))
|
||||||
|
|||||||
@@ -151,16 +151,28 @@ func (d *DB) SetLyrics(audioFileID int64, lyrics, source, recordingMBID string)
|
|||||||
return d.upsertLyricsIndex(audioFileID, lyrics)
|
return d.upsertLyricsIndex(audioFileID, lyrics)
|
||||||
}
|
}
|
||||||
|
|
||||||
// upsertLyricsIndex refreshes a single file's entry in the contentless
|
// DeleteLyricsIndex removes one file's entry from the contentless
|
||||||
// lyrics_index. contentless_delete=1 makes the DELETE valid; an empty
|
// lyrics_index. It is called wherever a file row is deleted — the
|
||||||
// lyrics string leaves the row deleted.
|
// `lyrics` table cascades with its file, but the FTS entry does not and
|
||||||
func (d *DB) upsertLyricsIndex(audioFileID int64, lyrics string) error {
|
// would otherwise accumulate for the life of the install (#249).
|
||||||
|
func (d *DB) DeleteLyricsIndex(audioFileID int64) error {
|
||||||
if _, err := d.db.ExecContext(d.Ctx,
|
if _, err := d.db.ExecContext(d.Ctx,
|
||||||
"DELETE FROM lyrics_index WHERE rowid = ?", audioFileID,
|
"DELETE FROM lyrics_index WHERE rowid = ?", audioFileID,
|
||||||
); err != nil {
|
); err != nil {
|
||||||
return fmt.Errorf("could not delete lyrics_index row: %w", err)
|
return fmt.Errorf("could not delete lyrics_index row: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// upsertLyricsIndex refreshes a single file's entry in the contentless
|
||||||
|
// lyrics_index. contentless_delete=1 makes the DELETE valid; an empty
|
||||||
|
// lyrics string leaves the row deleted.
|
||||||
|
func (d *DB) upsertLyricsIndex(audioFileID int64, lyrics string) error {
|
||||||
|
if err := d.DeleteLyricsIndex(audioFileID); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
if strings.TrimSpace(lyrics) == "" {
|
if strings.TrimSpace(lyrics) == "" {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,248 @@
|
|||||||
|
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)
|
f.manager.grab(ctx, dl, candidate, nil, false)
|
||||||
}()
|
}()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,261 @@
|
|||||||
|
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)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
+206
-59
@@ -577,12 +577,12 @@ func (m *Manager) Start(
|
|||||||
))
|
))
|
||||||
}
|
}
|
||||||
|
|
||||||
if m.AutoPickable(dl, ranked) {
|
if pick, ok := autoPick(dl, ranked, m.preferences()); ok {
|
||||||
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, ranked[0], job)
|
go m.grab(context.WithoutCancel(ctx), dl, pick, job, true)
|
||||||
|
|
||||||
return ranked, nil
|
return ranked, nil
|
||||||
}
|
}
|
||||||
@@ -622,6 +622,13 @@ 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
|
||||||
}
|
}
|
||||||
@@ -643,7 +650,7 @@ func (m *Manager) Attempt(
|
|||||||
))
|
))
|
||||||
}
|
}
|
||||||
|
|
||||||
go m.grab(context.WithoutCancel(ctx), dl, ranked[0], job)
|
go m.grab(context.WithoutCancel(ctx), dl, pick, job, true)
|
||||||
|
|
||||||
return true, "", nil
|
return true, "", nil
|
||||||
}
|
}
|
||||||
@@ -678,7 +685,7 @@ func (m *Manager) Pick(
|
|||||||
|
|
||||||
job := m.startJob(dl)
|
job := m.startJob(dl)
|
||||||
|
|
||||||
go m.grab(context.WithoutCancel(ctx), dl, *chosen, job)
|
go m.grab(context.WithoutCancel(ctx), dl, *chosen, job, false)
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -702,13 +709,20 @@ func (m *Manager) Cancel(ctx context.Context, downloadID string) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// grab drives one candidate all the way to the library. It runs on its
|
// grab drives one request 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()
|
||||||
@@ -723,6 +737,82 @@ 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
|
||||||
@@ -731,9 +821,7 @@ func (m *Manager) grab(
|
|||||||
// 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 {
|
||||||
m.failDownload(ctx, job, dl.ID, err)
|
return grabOutcome{err: err}
|
||||||
|
|
||||||
return
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if !plan.delegated() {
|
if !plan.delegated() {
|
||||||
@@ -743,9 +831,7 @@ func (m *Manager) grab(
|
|||||||
case provSem <- struct{}{}:
|
case provSem <- struct{}{}:
|
||||||
defer func() { <-provSem }()
|
defer func() { <-provSem }()
|
||||||
case <-ctx.Done():
|
case <-ctx.Done():
|
||||||
m.failDownload(ctx, job, dl.ID, ctx.Err())
|
return grabOutcome{err: ctx.Err()}
|
||||||
|
|
||||||
return
|
|
||||||
}
|
}
|
||||||
|
|
||||||
globalSem := m.globalSem()
|
globalSem := m.globalSem()
|
||||||
@@ -754,9 +840,7 @@ func (m *Manager) grab(
|
|||||||
case globalSem <- struct{}{}:
|
case globalSem <- struct{}{}:
|
||||||
defer func() { <-globalSem }()
|
defer func() { <-globalSem }()
|
||||||
case <-ctx.Done():
|
case <-ctx.Done():
|
||||||
m.failDownload(ctx, job, dl.ID, ctx.Err())
|
return grabOutcome{err: ctx.Err()}
|
||||||
|
|
||||||
return
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -771,24 +855,30 @@ func (m *Manager) grab(
|
|||||||
|
|
||||||
dir, err := m.staging.Reserve(item.ID)
|
dir, err := m.staging.Reserve(item.ID)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
m.failDownload(ctx, job, dl.ID, err)
|
return grabOutcome{err: 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 {
|
||||||
m.failDownload(ctx, job, dl.ID, err)
|
return grabOutcome{item: item, err: err}
|
||||||
|
}
|
||||||
|
|
||||||
return
|
fail := func(err error, retryable bool) grabOutcome {
|
||||||
|
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 {
|
||||||
m.failItem(ctx, job, item, dl.ID, err)
|
// A delegate's failure is the external manager's verdict on the
|
||||||
|
// whole request, not on one copy of it.
|
||||||
return
|
return fail(err, !plan.delegated())
|
||||||
}
|
}
|
||||||
|
|
||||||
m.setStates(ctx, dl.ID, item.ID, StateImporting)
|
m.setStates(ctx, dl.ID, item.ID, StateImporting)
|
||||||
@@ -798,42 +888,116 @@ func (m *Manager) grab(
|
|||||||
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
|
|
||||||
|
|
||||||
opts.LibraryRoot, err = m.library.LibraryPath(dl.LibraryID)
|
return grabOutcome{
|
||||||
if err != nil {
|
item: item,
|
||||||
m.failItem(ctx, job, item, dl.ID,
|
imported: ImportResult{Paths: result.Files},
|
||||||
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 {
|
||||||
@@ -1177,23 +1341,6 @@ 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,6 +66,14 @@ 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,
|
||||||
@@ -94,16 +102,63 @@ 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))
|
||||||
|
|
||||||
hint := TrackHint{Folder: cleanAlbumName(folder)}
|
// The album's name is the album directory's, not a disc folder's,
|
||||||
|
// 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] != "" {
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ import (
|
|||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
|
"net/url"
|
||||||
"os"
|
"os"
|
||||||
"path"
|
"path"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
@@ -69,12 +70,31 @@ 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. Soulseek returns a lot of one-file
|
// is offered as a candidate for an album. Soulseek returns a lot of
|
||||||
// noise for common queries.
|
// one-file noise for common queries. A single-track request takes
|
||||||
|
// 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
|
||||||
|
|
||||||
|
// 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() {
|
||||||
@@ -134,6 +154,8 @@ 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.
|
||||||
@@ -188,6 +210,8 @@ func newSlskd(
|
|||||||
searchPoll: slskdSearchPoll,
|
searchPoll: slskdSearchPoll,
|
||||||
searchWait: slskdSearchWait,
|
searchWait: slskdSearchWait,
|
||||||
transferPoll: slskdTransferPoll,
|
transferPoll: slskdTransferPoll,
|
||||||
|
stallAfter: slskdStallAfter,
|
||||||
|
absentGrace: slskdAbsentGrace,
|
||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -307,7 +331,24 @@ func (s *slskd) Search(ctx context.Context, dl Download) ([]Candidate, error) {
|
|||||||
)
|
)
|
||||||
}()
|
}()
|
||||||
|
|
||||||
return s.candidatesFrom(search), nil
|
return s.candidatesFrom(search, minFilesFor(dl)), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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.
|
||||||
@@ -348,8 +389,9 @@ func (s *slskd) awaitSearch(
|
|||||||
return last, nil
|
return last, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// candidatesFrom groups a search's responses into candidates.
|
// candidatesFrom groups a search's responses into candidates, dropping
|
||||||
func (s *slskd) candidatesFrom(search slskdSearch) []Candidate {
|
// folders with fewer than minFiles audio files.
|
||||||
|
func (s *slskd) candidatesFrom(search slskdSearch, minFiles int) []Candidate {
|
||||||
out := make([]Candidate, 0, len(search.Responses))
|
out := make([]Candidate, 0, len(search.Responses))
|
||||||
|
|
||||||
for _, resp := range search.Responses {
|
for _, resp := range search.Responses {
|
||||||
@@ -377,7 +419,7 @@ func (s *slskd) candidatesFrom(search slskdSearch) []Candidate {
|
|||||||
total += f.Size
|
total += f.Size
|
||||||
}
|
}
|
||||||
|
|
||||||
if audio < slskdMinFiles {
|
if audio < minFiles {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -398,13 +440,15 @@ func (s *slskd) candidatesFrom(search slskdSearch) []Candidate {
|
|||||||
return out
|
return out
|
||||||
}
|
}
|
||||||
|
|
||||||
// groupByFolder buckets a peer's files by their containing directory.
|
// groupByFolder buckets a peer's files by the album directory they sit
|
||||||
|
// 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 {
|
||||||
norm := strings.ReplaceAll(f.Filename, `\`, "/")
|
dir := AlbumDir(f.Filename)
|
||||||
out[path.Dir(norm)] = append(out[path.Dir(norm)], f)
|
out[dir] = append(out[dir], f)
|
||||||
}
|
}
|
||||||
|
|
||||||
return out
|
return out
|
||||||
@@ -467,6 +511,15 @@ 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{
|
||||||
@@ -476,24 +529,69 @@ func (s *slskd) Grab(
|
|||||||
}
|
}
|
||||||
|
|
||||||
if err := s.client.post(
|
if err := s.client.post(
|
||||||
ctx, "/api/v0/transfers/downloads/"+username, wanted, nil,
|
ctx, slskdDownloadsPath(username), wanted, nil,
|
||||||
); err != nil {
|
); err != nil {
|
||||||
return Result{}, err
|
return Result{}, err
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := s.awaitTransfers(ctx, username, c, onProgress); err != nil {
|
if err := s.awaitTransfers(
|
||||||
|
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. Soulseek queues are measured in hours, so the only deadline
|
// state, the transfer stalls, or the caller gives up.
|
||||||
// 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 {
|
||||||
@@ -502,9 +600,18 @@ 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):
|
||||||
}
|
}
|
||||||
@@ -512,60 +619,177 @@ 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.
|
// transfer that may be hours in — but a daemon that stays
|
||||||
|
// 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
|
||||||
}
|
}
|
||||||
|
|
||||||
var (
|
tally := tallyTransfers(
|
||||||
done, failed int
|
transfers, wanted, stale,
|
||||||
current int64
|
time.Since(started) >= s.absentGrace,
|
||||||
)
|
)
|
||||||
|
live = tally.live
|
||||||
|
|
||||||
for _, t := range transfers {
|
if tally.bytes > lastBytes {
|
||||||
if !wanted[t.Filename] {
|
lastBytes = tally.bytes
|
||||||
continue
|
lastProgress = time.Now()
|
||||||
}
|
|
||||||
|
|
||||||
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: current,
|
Current: tally.bytes,
|
||||||
Total: c.TotalSize,
|
Total: c.TotalSize,
|
||||||
Phase: fmt.Sprintf(
|
Phase: fmt.Sprintf(
|
||||||
"Transferring from %s (%d/%d)", username, done, len(wanted),
|
"Transferring from %s (%d/%d)",
|
||||||
|
username, tally.done, len(wanted),
|
||||||
),
|
),
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
if done+failed < len(wanted) {
|
if tally.done+tally.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
|
||||||
}
|
}
|
||||||
|
|
||||||
// Some files failing is normal — a peer goes offline mid-folder.
|
s.cancelTransfers(username, live)
|
||||||
// Let the importer's completeness check decide whether what
|
|
||||||
// arrived is enough, rather than discarding it here.
|
// A folder that stalls on its last track is the same shape as
|
||||||
if done == 0 {
|
// one whose last track failed, and goes forward the same way.
|
||||||
return fmt.Errorf(
|
if tally.done > 0 {
|
||||||
"%w: all %d files failed", ErrSlskdTransferFailed, failed,
|
s.logger.Info(
|
||||||
|
"slskd transfer stalled; keeping what arrived",
|
||||||
|
"peer", username,
|
||||||
|
"done", tally.done,
|
||||||
|
"wanted", len(wanted),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
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,
|
||||||
|
)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -581,9 +805,7 @@ func (s *slskd) transfersFor(
|
|||||||
} `json:"directories"`
|
} `json:"directories"`
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := s.client.get(
|
if err := s.client.get(ctx, slskdDownloadsPath(username), &raw); err != nil {
|
||||||
ctx, "/api/v0/transfers/downloads/"+username, &raw,
|
|
||||||
); err != nil {
|
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -616,7 +838,13 @@ 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,8 +31,18 @@ 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
|
||||||
@@ -87,7 +97,12 @@ func newSlskdStub(t *testing.T) *slskdStub {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
if r.Method == http.MethodPost {
|
s.mu.Lock()
|
||||||
|
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 {
|
||||||
@@ -96,15 +111,35 @@ 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
|
||||||
@@ -191,6 +226,11 @@ 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
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -565,3 +605,293 @@ 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)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
+75
-10
@@ -347,7 +347,9 @@ func scoreMatch(
|
|||||||
TitleFit: titleFit,
|
TitleFit: titleFit,
|
||||||
}
|
}
|
||||||
|
|
||||||
m.Completeness = completeness(len(audio), len(dl.Expected))
|
m.Completeness = completeness(
|
||||||
|
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:
|
||||||
@@ -415,30 +417,54 @@ func artistFit(want string, c Candidate) float64 {
|
|||||||
return best
|
return best
|
||||||
}
|
}
|
||||||
|
|
||||||
// completeness scores audio file count against the expected track
|
// completeness scores how much of the expected tracklist a candidate
|
||||||
// count. Extra files are penalized far more gently than missing ones:
|
// covers. 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 got > 0 {
|
if audio > 0 {
|
||||||
return 0.5
|
return 0.5
|
||||||
}
|
}
|
||||||
|
|
||||||
return 0
|
return 0
|
||||||
}
|
}
|
||||||
|
|
||||||
if got == 0 {
|
if aligned == 0 {
|
||||||
return 0
|
return 0
|
||||||
}
|
}
|
||||||
|
|
||||||
if got >= want {
|
cover := float64(min(aligned, want)) / float64(want)
|
||||||
extra := float64(got-want) / float64(want)
|
|
||||||
|
|
||||||
return math.Max(0.75, 1.0-0.25*extra)
|
if audio > want {
|
||||||
|
extra := float64(audio-want) / float64(want)
|
||||||
|
cover *= math.Max(0.75, 1.0-0.25*extra)
|
||||||
}
|
}
|
||||||
|
|
||||||
return float64(got) / float64(want)
|
return cover
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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.
|
||||||
@@ -735,6 +761,45 @@ 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,28 +282,32 @@ func TestCompleteness(t *testing.T) {
|
|||||||
|
|
||||||
tests := []struct {
|
tests := []struct {
|
||||||
name string
|
name string
|
||||||
got int
|
aligned int
|
||||||
|
audio int
|
||||||
want int
|
want int
|
||||||
minScore float64
|
minScore float64
|
||||||
maxScore float64
|
maxScore float64
|
||||||
}{
|
}{
|
||||||
{"exact", 10, 10, 1.0, 1.0},
|
{"exact", 10, 10, 10, 1.0, 1.0},
|
||||||
{"half missing", 5, 10, 0.49, 0.51},
|
{"half missing", 5, 5, 10, 0.49, 0.51},
|
||||||
{"one bonus track", 11, 10, 0.95, 1.0},
|
{"one bonus track", 10, 11, 10, 0.95, 1.0},
|
||||||
{"double", 20, 10, 0.74, 0.76},
|
{"double", 10, 20, 10, 0.74, 0.76},
|
||||||
{"nothing", 0, 10, 0, 0},
|
{"nothing", 0, 0, 10, 0, 0},
|
||||||
{"no expectation", 5, 0, 0.5, 0.5},
|
{"no expectation", 0, 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.got, tt.want)
|
got := completeness(tt.aligned, tt.audio, tt.want)
|
||||||
if got < tt.minScore || got > tt.maxScore {
|
if got < tt.minScore || got > tt.maxScore {
|
||||||
t.Errorf(
|
t.Errorf(
|
||||||
"completeness(%d, %d) = %f, want in [%f, %f]",
|
"completeness(%d, %d, %d) = %f, want in [%f, %f]",
|
||||||
tt.got, tt.want, got, tt.minScore, tt.maxScore,
|
tt.aligned, tt.audio, tt.want, got, tt.minScore, tt.maxScore,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -8,6 +8,7 @@ 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
|
||||||
@@ -26,10 +27,9 @@ func TestScan_StoresOnlyCoverTiers(t *testing.T) {
|
|||||||
|
|
||||||
lib, db := setupTestLibrary(t)
|
lib, db := setupTestLibrary(t)
|
||||||
|
|
||||||
root, err := filepath.Abs("../../test_data/music_library_test")
|
// Load skips when the fixture library has not been generated, as
|
||||||
if err != nil {
|
// every other fixture test does.
|
||||||
t.Fatalf("resolve fixture path: %v", err)
|
root := testfixtures.Load(t).Root()
|
||||||
}
|
|
||||||
|
|
||||||
library, err := db.Queries.CreateLibrary(lib.ctx, sqlcgen.CreateLibraryParams{
|
library, err := db.Queries.CreateLibrary(lib.ctx, sqlcgen.CreateLibraryParams{
|
||||||
Name: "Fixtures",
|
Name: "Fixtures",
|
||||||
|
|||||||
@@ -1034,7 +1034,7 @@ func (l *Library) scanInternal(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Remove from FTS5 search index.
|
// Remove from FTS5 search index and the lyrics index.
|
||||||
if err := l.db.DeleteSearchIndex(f.ID); err != nil {
|
if err := l.db.DeleteSearchIndex(f.ID); err != nil {
|
||||||
l.logger.Warn(
|
l.logger.Warn(
|
||||||
"failed to delete FTS entry for orphan",
|
"failed to delete FTS entry for orphan",
|
||||||
@@ -1045,6 +1045,16 @@ func (l *Library) scanInternal(
|
|||||||
metrics.addWarning(path, "orphan", err)
|
metrics.addWarning(path, "orphan", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if err := l.db.DeleteLyricsIndex(f.ID); err != nil {
|
||||||
|
l.logger.Warn(
|
||||||
|
"failed to delete lyrics index entry for orphan",
|
||||||
|
"id", f.ID,
|
||||||
|
"err", err,
|
||||||
|
)
|
||||||
|
|
||||||
|
metrics.addWarning(path, "orphan", err)
|
||||||
|
}
|
||||||
|
|
||||||
removed.Add(1)
|
removed.Add(1)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -147,6 +147,11 @@ func (l *Library) RemoveFromLibrary(filePaths []string) (*RemovalResult, error)
|
|||||||
l.logger.Warn("could not delete FTS entry for removed track",
|
l.logger.Warn("could not delete FTS entry for removed track",
|
||||||
"path", row.FilePath, "id", row.ID, "err", err)
|
"path", row.FilePath, "id", row.ID, "err", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if err := l.db.DeleteLyricsIndex(row.ID); err != nil {
|
||||||
|
l.logger.Warn("could not delete lyrics index entry for removed track",
|
||||||
|
"path", row.FilePath, "id", row.ID, "err", err)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Deleting an audio_files row cascades to queue_tracks, so the
|
// Deleting an audio_files row cascades to queue_tracks, so the
|
||||||
|
|||||||
@@ -734,3 +734,52 @@ func TestStaleArtistMetadataJob(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TestStaleSearchClicksJob deletes only the clicks old enough to have
|
||||||
|
// left the retention window (#249).
|
||||||
|
func TestStaleSearchClicksJob(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
db := database.NewTestDB(t)
|
||||||
|
|
||||||
|
count := func(mbid string) int {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var n int
|
||||||
|
if err := db.QueryRowWriter(
|
||||||
|
"SELECT COUNT(*) FROM search_clicks WHERE entity_mbid = ?", mbid,
|
||||||
|
).Scan(&n); err != nil {
|
||||||
|
t.Fatalf("count %s: %v", mbid, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return n
|
||||||
|
}
|
||||||
|
|
||||||
|
seed := func(query, mbid, lastClicked string) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
if _, err := db.ExecContext(
|
||||||
|
`INSERT INTO search_clicks
|
||||||
|
(query, entity_mbid, entity_type, click_count, last_clicked)
|
||||||
|
VALUES (?, ?, 'recording', 1, ?)`,
|
||||||
|
query, mbid, lastClicked,
|
||||||
|
); err != nil {
|
||||||
|
t.Fatalf("seed search_clicks: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
seed("tide", "aaaa", "2024-01-01 00:00:00") // stale
|
||||||
|
seed("tide", "bbbb", "2999-01-01 00:00:00") // recent
|
||||||
|
|
||||||
|
if _, err := StaleSearchClicksJob(db).Run(context.Background()); err != nil {
|
||||||
|
t.Fatalf("run job: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if n := count("bbbb"); n != 1 {
|
||||||
|
t.Errorf("recent click was deleted: %d rows, want 1", n)
|
||||||
|
}
|
||||||
|
|
||||||
|
if n := count("aaaa"); n != 0 {
|
||||||
|
t.Errorf("stale click survived: %d rows, want 0", n)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -662,3 +662,35 @@ func StaleArtistMetadataJob(db *database.DB) Job {
|
|||||||
},
|
},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// searchClicksRetention is how long a search-click ranking signal stays
|
||||||
|
// useful. search_clicks is authored behavioural data — nothing that
|
||||||
|
// owns a row ever drops it — so age is the ceiling that keeps the table
|
||||||
|
// from growing without bound for the life of the install (#249).
|
||||||
|
const searchClicksRetention = "-180 days"
|
||||||
|
|
||||||
|
// StaleSearchClicksJob deletes search-click ranking rows older than the
|
||||||
|
// retention window. Rows are small and the table grows slowly, so this
|
||||||
|
// runs daily and does almost nothing most runs.
|
||||||
|
func StaleSearchClicksJob(db *database.DB) Job {
|
||||||
|
return Job{
|
||||||
|
Name: "search-clicks-sweep",
|
||||||
|
MinInterval: dailyInterval,
|
||||||
|
Run: func(_ context.Context) (Result, error) {
|
||||||
|
res, err := db.ExecContext(
|
||||||
|
`DELETE FROM search_clicks
|
||||||
|
WHERE last_clicked < datetime('now', ?)`,
|
||||||
|
searchClicksRetention,
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return Result{}, fmt.Errorf(
|
||||||
|
"delete stale search_clicks rows: %w", err,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
rows, _ := res.RowsAffected()
|
||||||
|
|
||||||
|
return Result{RowsDeleted: rows}, nil
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -134,6 +134,12 @@ type Service struct {
|
|||||||
libraryDir LibraryDirProvider
|
libraryDir LibraryDirProvider
|
||||||
favoritesConf FavoritesConfigProvider
|
favoritesConf FavoritesConfigProvider
|
||||||
|
|
||||||
|
// onDeleted, when set, is called after a playlist is deleted so
|
||||||
|
// cross-cutting state that points at it (the queue's "Playing
|
||||||
|
// from" label) can stop pointing at a playlist that no longer
|
||||||
|
// exists. Wired from app.go, like Library.SetRemovalHooks.
|
||||||
|
onDeleted func(playlistID int64)
|
||||||
|
|
||||||
// dataDirOverride, when non-empty, replaces the OS user data
|
// dataDirOverride, when non-empty, replaces the OS user data
|
||||||
// directory as the base for the playlists folder. Set by tests to
|
// directory as the base for the playlists folder. Set by tests to
|
||||||
// keep M3U writes out of the real user data directory.
|
// keep M3U writes out of the real user data directory.
|
||||||
@@ -166,6 +172,17 @@ func (s *Service) SetFavoritesConfig(
|
|||||||
s.favoritesConf = provider
|
s.favoritesConf = provider
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SetOnPlaylistDeleted registers a callback invoked after a playlist is
|
||||||
|
// deleted, for cross-cutting invalidation.
|
||||||
|
//
|
||||||
|
//wails:ignore // internal wiring, not part of the app's IPC surface.
|
||||||
|
func (s *Service) SetOnPlaylistDeleted(onDeleted func(playlistID int64)) {
|
||||||
|
s.mu.Lock()
|
||||||
|
defer s.mu.Unlock()
|
||||||
|
|
||||||
|
s.onDeleted = onDeleted
|
||||||
|
}
|
||||||
|
|
||||||
// ServiceStartup is v3's service lifecycle hook: it runs once the
|
// ServiceStartup is v3's service lifecycle hook: it runs once the
|
||||||
// runtime exists, and ctx is cancelled when the app shuts down. It
|
// runtime exists, and ctx is cancelled when the app shuts down. It
|
||||||
// replaces v2's SetContext, which had to be called by hand from
|
// replaces v2's SetContext, which had to be called by hand from
|
||||||
@@ -766,6 +783,17 @@ func (s *Service) DeletePlaylist(playlistID int64) error {
|
|||||||
|
|
||||||
s.emitEvent(events.PlaylistDeleted, playlistID)
|
s.emitEvent(events.PlaylistDeleted, playlistID)
|
||||||
|
|
||||||
|
// Cross-cutting invalidation: the queue's "Playing from" label may
|
||||||
|
// point at this playlist, and a link to a playlist that no longer
|
||||||
|
// exists is worse than none.
|
||||||
|
s.mu.Lock()
|
||||||
|
onDeleted := s.onDeleted
|
||||||
|
s.mu.Unlock()
|
||||||
|
|
||||||
|
if onDeleted != nil {
|
||||||
|
onDeleted(playlistID)
|
||||||
|
}
|
||||||
|
|
||||||
// Recreate the default playlist if we just deleted it.
|
// Recreate the default playlist if we just deleted it.
|
||||||
if s.defaultPlaylistID() == playlistID {
|
if s.defaultPlaylistID() == playlistID {
|
||||||
s.EnsureDefaultPlaylist()
|
s.EnsureDefaultPlaylist()
|
||||||
|
|||||||
@@ -1581,6 +1581,21 @@ func (q *Queue) dropSource() {
|
|||||||
q.source = Source{}
|
q.source = Source{}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// DropSourceForPlaylist clears the queue's "Playing from" label when
|
||||||
|
// its source playlist is deleted. A link back to a playlist that no
|
||||||
|
// longer exists is worse than none, and the label otherwise survives
|
||||||
|
// the deletion until the next SetQueue (#249).
|
||||||
|
func (q *Queue) DropSourceForPlaylist(playlistID int64) {
|
||||||
|
q.mu.Lock()
|
||||||
|
defer q.mu.Unlock()
|
||||||
|
|
||||||
|
if (q.source.Type == "playlist" || q.source.Type == "smartPlaylist") &&
|
||||||
|
q.source.ID == playlistID {
|
||||||
|
q.dropSource()
|
||||||
|
q.persistState()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// commitMutation persists the current queue state after a mutation.
|
// commitMutation persists the current queue state after a mutation.
|
||||||
// When reindex is true, track positions are renumbered first.
|
// When reindex is true, track positions are renumbered first.
|
||||||
// The caller must hold q.mu.
|
// The caller must hold q.mu.
|
||||||
|
|||||||
@@ -535,3 +535,35 @@ func TestCycleRepeat_CyclesThroughModes(t *testing.T) {
|
|||||||
t.Errorf("after third cycle: got %q, want %q", state.RepeatMode, RepeatOff)
|
t.Errorf("after third cycle: got %q, want %q", state.RepeatMode, RepeatOff)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TestDropSourceForPlaylist clears the "Playing from" label when the
|
||||||
|
// queue's source playlist is deleted, and leaves it alone otherwise
|
||||||
|
// (#249).
|
||||||
|
func TestDropSourceForPlaylist(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
q, db := setupTestQueue(t)
|
||||||
|
paths := seedAudioFiles(t, db, 2)
|
||||||
|
|
||||||
|
q.SetQueue(paths, 0, false, Source{Type: "playlist", ID: 42, Label: "Road Trip"})
|
||||||
|
q.DropSourceForPlaylist(42)
|
||||||
|
|
||||||
|
if got := q.GetState().Source; got != (Source{}) {
|
||||||
|
t.Errorf("source = %+v, want empty after playlist 42 deleted", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDropSourceForPlaylistIgnoresOtherPlaylists(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
q, db := setupTestQueue(t)
|
||||||
|
paths := seedAudioFiles(t, db, 2)
|
||||||
|
|
||||||
|
source := Source{Type: "smartPlaylist", ID: 42, Label: "Road Trip"}
|
||||||
|
q.SetQueue(paths, 0, false, source)
|
||||||
|
q.DropSourceForPlaylist(7)
|
||||||
|
|
||||||
|
if got := q.GetState().Source; got != source {
|
||||||
|
t.Errorf("source = %+v, want %+v unchanged for a different playlist", got, source)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -56,6 +56,16 @@ export function CycleRepeat(): $CancellablePromise<void> {
|
|||||||
return $Call.ByID(3510519482);
|
return $Call.ByID(3510519482);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* DropSourceForPlaylist clears the queue's "Playing from" label when
|
||||||
|
* its source playlist is deleted. A link back to a playlist that no
|
||||||
|
* longer exists is worse than none, and the label otherwise survives
|
||||||
|
* the deletion until the next SetQueue (#249).
|
||||||
|
*/
|
||||||
|
export function DropSourceForPlaylist(playlistID: number): $CancellablePromise<void> {
|
||||||
|
return $Call.ByID(1435106374, playlistID);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* EmitCurrentState emits the current queue state to the frontend.
|
* EmitCurrentState emits the current queue state to the frontend.
|
||||||
* This is called after the frontend DOM is ready.
|
* This is called after the frontend DOM is ready.
|
||||||
|
|||||||
Reference in New Issue
Block a user