mirror of
https://github.com/navidrome/navidrome.git
synced 2026-10-10 11:27:11 +02:00
b293b96256* refactor(persistence): adopt generic deluan/rest repository API Pin deluan/rest to the refactor branch. REST-facing repository methods take a context and return typed values. Drop DataStore.Resource and ResourceRepository; the native API names typed repositories directly through a per-request adapter that later commits remove. * refactor(persistence): base repository helpers take a context * refactor(persistence): LibraryRepository takes a context per call * refactor(persistence): PropertyRepository takes a context per call * refactor(persistence): UserPropsRepository takes a context per call * refactor(persistence): TranscodingRepository takes a context per call * refactor(persistence): ShareRepository takes a context per call * refactor(persistence): PlayerRepository takes a context per call * refactor(persistence): RadioRepository takes a context per call * refactor(persistence): PlayQueueRepository takes a context per call * refactor(persistence): Tag and Genre repositories take a context per call * refactor(persistence): PluginRepository takes a context per call * refactor(persistence): Scrobble repositories take a context per call * refactor(persistence): FolderRepository takes a context per call * refactor(persistence): Artwork repositories take a context per call * refactor(persistence): UserRepository takes a context per call * refactor(persistence): ArtistRepository takes a context per call ReadAll no longer rewrites the shared sort mappings for the role filter; it works on a per-call copy. * test(persistence): assert artist role sort sanitization in ReadAll * refactor(persistence): AlbumRepository takes a context per call * test(persistence): pass the test context to album repository helpers * refactor(persistence): MediaFileRepository takes a context per call * refactor(persistence): Playlist repositories take a context per call * refactor(persistence): build all repositories once per store * refactor(core): REST repository wrappers are built once * refactor(persistence): repositories are stateless Remove the context field from the base repository and the per-request REST adapter. Enable the containedctx linter so no repository can hold a request context again. * chore(lint): skip containedctx in test files * refactor: share simplifications from the stateless repositories sweep Add deleteOwnedAll on sqlRepository and use it in player/share Delete to remove the duplicated bulk-delete loop; have Share.Repository() return model.ShareRepository so subsonic sharing.go drops its repeated type assertions. * chore(core): assert REST wrappers implement Persistable * chore: reformat imports * perf(persistence): build repositories on first use Each transaction store used to construct all 21 repositories up front, paying for filter and sort mapping setup the block never touched. Fields are now sync.OnceValue thunks, so a store only builds what it uses. * fix(persistence): clean plugin references per deleted user A bulk user delete that fails on a later id had already removed the earlier rows but skipped their plugin cleanup. Cleanup now runs right after each successful delete. * fix(core): unload disabled plugins even when a user delete fails A bulk delete can fail on a later id after earlier users were removed and their plugins auto-disabled. The wrapper returned before unloading, leaving those plugins running until the next successful delete or a restart. * chore(deps): pin deluan/rest to v1.0.1 Replaces the pseudo-version of the refactor branch with the tagged release. REST error messages now name the bare type (Artist, not model.Artist). * test: use the spec context instead of context.Background() Replace the context.Background()/context.TODO() calls this branch added to tests with the spec's ctx, GinkgoT().Context(), or t/b.Context(), so repository calls are bound to the running spec's lifetime. * test: declare the spec context once per Describe Set ctx from GinkgoT().Context() first in each top-level BeforeEach and reuse it, building user contexts on top of it instead of repeating inline calls.
331 lines
10 KiB
Go
331 lines
10 KiB
Go
package external_test
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
|
|
"github.com/navidrome/navidrome/core/agents"
|
|
"github.com/navidrome/navidrome/model"
|
|
"github.com/navidrome/navidrome/utils/slice"
|
|
"github.com/stretchr/testify/mock"
|
|
)
|
|
|
|
// --- Shared Mock Implementations ---
|
|
|
|
// mockArtistRepo mocks model.ArtistRepository
|
|
type mockArtistRepo struct {
|
|
mock.Mock
|
|
model.ArtistRepository
|
|
}
|
|
|
|
func newMockArtistRepo() *mockArtistRepo {
|
|
return &mockArtistRepo{}
|
|
}
|
|
|
|
// SetData sets up basic Get expectations.
|
|
func (m *mockArtistRepo) SetData(artists model.Artists) {
|
|
for _, a := range artists {
|
|
artistCopy := a
|
|
m.On("Get", artistCopy.ID).Return(&artistCopy, nil)
|
|
}
|
|
}
|
|
|
|
// Get implements model.ArtistRepository.
|
|
func (m *mockArtistRepo) Get(_ context.Context, id string) (*model.Artist, error) {
|
|
args := m.Called(id)
|
|
if args.Get(0) == nil {
|
|
return nil, args.Error(1)
|
|
}
|
|
return args.Get(0).(*model.Artist), args.Error(1)
|
|
}
|
|
|
|
// GetAll implements model.ArtistRepository.
|
|
func (m *mockArtistRepo) GetAll(_ context.Context, options ...model.QueryOptions) (model.Artists, error) {
|
|
argsSlice := make([]any, len(options))
|
|
for i, v := range options {
|
|
argsSlice[i] = v
|
|
}
|
|
args := m.Called(argsSlice...)
|
|
if args.Get(0) == nil {
|
|
return nil, args.Error(1)
|
|
}
|
|
return args.Get(0).(model.Artists), args.Error(1)
|
|
}
|
|
|
|
// SetError is a helper to set up a generic error for GetAll.
|
|
func (m *mockArtistRepo) SetError(hasError bool) {
|
|
if hasError {
|
|
m.On("GetAll", mock.Anything).Return(nil, errors.New("mock repo error"))
|
|
}
|
|
}
|
|
|
|
// FindByName is a helper to set up a GetAll expectation for finding by name.
|
|
func (m *mockArtistRepo) FindByName(name string, artist model.Artist) {
|
|
m.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool {
|
|
return opt.Filters != nil
|
|
})).Return(model.Artists{artist}, nil).Once()
|
|
}
|
|
|
|
// mockMediaFileRepo mocks model.MediaFileRepository
|
|
type mockMediaFileRepo struct {
|
|
mock.Mock
|
|
model.MediaFileRepository
|
|
}
|
|
|
|
func newMockMediaFileRepo() *mockMediaFileRepo {
|
|
return &mockMediaFileRepo{}
|
|
}
|
|
|
|
// SetData sets up basic Get expectations.
|
|
func (m *mockMediaFileRepo) SetData(mediaFiles model.MediaFiles) {
|
|
for _, mf := range mediaFiles {
|
|
mfCopy := mf
|
|
m.On("Get", mfCopy.ID).Return(&mfCopy, nil)
|
|
}
|
|
}
|
|
|
|
// Get implements model.MediaFileRepository.
|
|
func (m *mockMediaFileRepo) Get(ctx context.Context, id string) (*model.MediaFile, error) {
|
|
args := m.Called(id)
|
|
if args.Get(0) == nil {
|
|
return nil, args.Error(1)
|
|
}
|
|
return args.Get(0).(*model.MediaFile), args.Error(1)
|
|
}
|
|
|
|
// GetAllByTags implements model.MediaFileRepository.
|
|
func (m *mockMediaFileRepo) GetAllByTags(ctx context.Context, _ model.TagName, _ []string, options ...model.QueryOptions) (model.MediaFiles, error) {
|
|
return m.GetAll(ctx, options...)
|
|
}
|
|
|
|
// GetAll implements model.MediaFileRepository.
|
|
func (m *mockMediaFileRepo) GetAll(ctx context.Context, options ...model.QueryOptions) (model.MediaFiles, error) {
|
|
argsSlice := make([]any, len(options))
|
|
for i, v := range options {
|
|
argsSlice[i] = v
|
|
}
|
|
args := m.Called(argsSlice...)
|
|
if args.Get(0) == nil {
|
|
return nil, args.Error(1)
|
|
}
|
|
return args.Get(0).(model.MediaFiles), args.Error(1)
|
|
}
|
|
|
|
// GetRandom implements model.MediaFileRepository.
|
|
func (m *mockMediaFileRepo) GetRandom(ctx context.Context, options ...model.QueryOptions) (model.MediaFiles, error) {
|
|
argsSlice := make([]any, len(options))
|
|
for i, v := range options {
|
|
argsSlice[i] = v
|
|
}
|
|
args := m.Called(argsSlice...)
|
|
if args.Get(0) == nil {
|
|
return nil, args.Error(1)
|
|
}
|
|
return args.Get(0).(model.MediaFiles), args.Error(1)
|
|
}
|
|
|
|
// SetError is a helper to set up a generic error for GetAll.
|
|
func (m *mockMediaFileRepo) SetError(hasError bool) {
|
|
if hasError {
|
|
m.On("GetAll", mock.Anything).Return(nil, errors.New("mock repo error"))
|
|
}
|
|
}
|
|
|
|
// FindByMBID is a helper to set up a GetAll expectation for finding by MBID.
|
|
func (m *mockMediaFileRepo) FindByMBID(mbid string, mediaFile model.MediaFile) {
|
|
m.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool {
|
|
return opt.Filters != nil
|
|
})).Return(model.MediaFiles{mediaFile}, nil).Once()
|
|
}
|
|
|
|
// FindByArtistAndTitle is a helper to set up a GetAll expectation for finding by artist/title.
|
|
func (m *mockMediaFileRepo) FindByArtistAndTitle(artistID string, title string, mediaFile model.MediaFile) {
|
|
m.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool {
|
|
return opt.Filters != nil
|
|
})).Return(model.MediaFiles{mediaFile}, nil).Once()
|
|
}
|
|
|
|
// mockAlbumRepo mocks model.AlbumRepository
|
|
type mockAlbumRepo struct {
|
|
mock.Mock
|
|
model.AlbumRepository
|
|
}
|
|
|
|
func newMockAlbumRepo() *mockAlbumRepo {
|
|
return &mockAlbumRepo{}
|
|
}
|
|
|
|
// Get implements model.AlbumRepository.
|
|
func (m *mockAlbumRepo) Get(_ context.Context, id string) (*model.Album, error) {
|
|
args := m.Called(id)
|
|
if args.Get(0) == nil {
|
|
return nil, args.Error(1)
|
|
}
|
|
return args.Get(0).(*model.Album), args.Error(1)
|
|
}
|
|
|
|
// GetAll implements model.AlbumRepository.
|
|
func (m *mockAlbumRepo) GetAll(_ context.Context, options ...model.QueryOptions) (model.Albums, error) {
|
|
argsSlice := make([]any, len(options))
|
|
for i, v := range options {
|
|
argsSlice[i] = v
|
|
}
|
|
args := m.Called(argsSlice...)
|
|
if args.Get(0) == nil {
|
|
return nil, args.Error(1)
|
|
}
|
|
return args.Get(0).(model.Albums), args.Error(1)
|
|
}
|
|
|
|
// mockSimilarArtistAgent mocks agents implementing ArtistTopSongsRetriever and ArtistSimilarRetriever
|
|
type mockSimilarArtistAgent struct {
|
|
mock.Mock
|
|
agents.Interface // Embed to satisfy methods not explicitly mocked
|
|
}
|
|
|
|
func (m *mockSimilarArtistAgent) AgentName() string {
|
|
return "mockSimilar"
|
|
}
|
|
|
|
func (m *mockSimilarArtistAgent) GetArtistTopSongs(ctx context.Context, id, artistName, mbid string, count int) ([]agents.Song, error) {
|
|
args := m.Called(ctx, id, artistName, mbid, count)
|
|
if args.Get(0) != nil {
|
|
return args.Get(0).([]agents.Song), args.Error(1)
|
|
}
|
|
return nil, args.Error(1)
|
|
}
|
|
|
|
func (m *mockSimilarArtistAgent) GetSimilarArtists(ctx context.Context, id, name, mbid string, limit int) ([]agents.Artist, error) {
|
|
args := m.Called(ctx, id, name, mbid, limit)
|
|
if args.Get(0) != nil {
|
|
return args.Get(0).([]agents.Artist), args.Error(1)
|
|
}
|
|
return nil, args.Error(1)
|
|
}
|
|
|
|
// mockAgents mocks the main Agents interface used by Provider
|
|
type mockAgents struct {
|
|
mock.Mock // Embed testify mock
|
|
topSongsAgent agents.ArtistTopSongsRetriever
|
|
similarAgent agents.ArtistSimilarRetriever
|
|
imageAgent agents.ArtistImageRetriever
|
|
albumInfoAgent interface {
|
|
agents.AlbumInfoRetriever
|
|
agents.AlbumImageRetriever
|
|
}
|
|
bioAgent agents.ArtistBiographyRetriever
|
|
mbidAgent agents.ArtistMBIDRetriever
|
|
urlAgent agents.ArtistURLRetriever
|
|
agents.Interface
|
|
}
|
|
|
|
func (m *mockAgents) AgentName() string {
|
|
return "mockCombined"
|
|
}
|
|
|
|
func (m *mockAgents) GetSimilarArtists(ctx context.Context, id, name, mbid string, limit int) ([]agents.Artist, error) {
|
|
if m.similarAgent != nil {
|
|
return m.similarAgent.GetSimilarArtists(ctx, id, name, mbid, limit)
|
|
}
|
|
args := m.Called(ctx, id, name, mbid, limit)
|
|
if args.Get(0) != nil {
|
|
return args.Get(0).([]agents.Artist), args.Error(1)
|
|
}
|
|
return nil, args.Error(1)
|
|
}
|
|
|
|
func (m *mockAgents) GetArtistTopSongs(ctx context.Context, id, artistName, mbid string, count int) ([]agents.Song, error) {
|
|
if m.topSongsAgent != nil {
|
|
return m.topSongsAgent.GetArtistTopSongs(ctx, id, artistName, mbid, count)
|
|
}
|
|
args := m.Called(ctx, id, artistName, mbid, count)
|
|
if args.Get(0) != nil {
|
|
return args.Get(0).([]agents.Song), args.Error(1)
|
|
}
|
|
return nil, args.Error(1)
|
|
}
|
|
|
|
func (m *mockAgents) GetAlbumInfo(ctx context.Context, name, artist, mbid string) (*agents.AlbumInfo, error) {
|
|
if m.albumInfoAgent != nil {
|
|
return m.albumInfoAgent.GetAlbumInfo(ctx, name, artist, mbid)
|
|
}
|
|
args := m.Called(ctx, name, artist, mbid)
|
|
if args.Get(0) != nil {
|
|
return args.Get(0).(*agents.AlbumInfo), args.Error(1)
|
|
}
|
|
return nil, args.Error(1)
|
|
}
|
|
|
|
func (m *mockAgents) GetArtistMBID(ctx context.Context, id string, name string) (string, error) {
|
|
if m.mbidAgent != nil {
|
|
return m.mbidAgent.GetArtistMBID(ctx, id, name)
|
|
}
|
|
args := m.Called(ctx, id, name)
|
|
return args.String(0), args.Error(1)
|
|
}
|
|
|
|
func (m *mockAgents) GetArtistURL(ctx context.Context, id, name, mbid string) (string, error) {
|
|
if m.urlAgent != nil {
|
|
return m.urlAgent.GetArtistURL(ctx, id, name, mbid)
|
|
}
|
|
args := m.Called(ctx, id, name, mbid)
|
|
return args.String(0), args.Error(1)
|
|
}
|
|
|
|
func (m *mockAgents) GetArtistBiography(ctx context.Context, id, name, mbid string) (string, error) {
|
|
if m.bioAgent != nil {
|
|
return m.bioAgent.GetArtistBiography(ctx, id, name, mbid)
|
|
}
|
|
args := m.Called(ctx, id, name, mbid)
|
|
return args.String(0), args.Error(1)
|
|
}
|
|
|
|
func (m *mockAgents) GetArtistImages(ctx context.Context, id, name, mbid string) ([]agents.ExternalImage, error) {
|
|
if m.imageAgent != nil {
|
|
return m.imageAgent.GetArtistImages(ctx, id, name, mbid)
|
|
}
|
|
args := m.Called(ctx, id, name, mbid)
|
|
if args.Get(0) != nil {
|
|
return args.Get(0).([]agents.ExternalImage), args.Error(1)
|
|
}
|
|
return nil, args.Error(1)
|
|
}
|
|
|
|
func (m *mockAgents) GetAlbumImages(ctx context.Context, name, artist, mbid string) ([]agents.ExternalImage, error) {
|
|
if m.albumInfoAgent != nil {
|
|
return m.albumInfoAgent.GetAlbumImages(ctx, name, artist, mbid)
|
|
}
|
|
args := m.Called(ctx, name, artist, mbid)
|
|
if args.Get(0) != nil {
|
|
return args.Get(0).([]agents.ExternalImage), args.Error(1)
|
|
}
|
|
return nil, args.Error(1)
|
|
}
|
|
|
|
func (m *mockAgents) GetSimilarSongsByTrack(ctx context.Context, id, name, artist, mbid string, count int) ([]agents.Song, error) {
|
|
args := m.Called(ctx, id, name, artist, mbid, count)
|
|
if args.Get(0) != nil {
|
|
return args.Get(0).([]agents.Song), args.Error(1)
|
|
}
|
|
return nil, args.Error(1)
|
|
}
|
|
|
|
func (m *mockAgents) GetSimilarSongsByAlbum(ctx context.Context, id, name, artist, mbid string, count int) ([]agents.Song, error) {
|
|
args := m.Called(ctx, id, name, artist, mbid, count)
|
|
if args.Get(0) != nil {
|
|
return args.Get(0).([]agents.Song), args.Error(1)
|
|
}
|
|
return nil, args.Error(1)
|
|
}
|
|
|
|
func (m *mockAgents) GetSimilarSongsByArtist(ctx context.Context, id, name, mbid string, count int) ([]agents.Song, error) {
|
|
args := m.Called(ctx, id, name, mbid, count)
|
|
if args.Get(0) != nil {
|
|
return args.Get(0).([]agents.Song), args.Error(1)
|
|
}
|
|
return nil, args.Error(1)
|
|
}
|
|
|
|
func ids(mfs model.MediaFiles) []string {
|
|
return slice.Map(mfs, func(mf model.MediaFile) string { return mf.ID })
|
|
}
|