mirror of
https://github.com/navidrome/navidrome.git
synced 2026-10-18 07:30:29 +00:00
* 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.
315 lines
10 KiB
Go
315 lines
10 KiB
Go
package persistence
|
|
|
|
import (
|
|
"context"
|
|
"slices"
|
|
"strings"
|
|
|
|
"github.com/Masterminds/squirrel"
|
|
"github.com/deluan/rest"
|
|
"github.com/navidrome/navidrome/model"
|
|
"github.com/navidrome/navidrome/model/id"
|
|
"github.com/navidrome/navidrome/model/request"
|
|
. "github.com/onsi/ginkgo/v2"
|
|
. "github.com/onsi/gomega"
|
|
)
|
|
|
|
var _ = Describe("GenreRepository", func() {
|
|
var repo model.GenreRepository
|
|
var restRepo rest.Repository[model.Genre]
|
|
var tagRepo model.TagRepository
|
|
var ctx context.Context
|
|
|
|
BeforeEach(func() {
|
|
ctx = request.WithUser(GinkgoT().Context(), model.User{ID: "userid", UserName: "johndoe", IsAdmin: true})
|
|
genreRepo := NewGenreRepository(GetDBXBuilder())
|
|
repo = genreRepo
|
|
restRepo = genreRepo
|
|
tagRepo = NewTagRepository(GetDBXBuilder())
|
|
|
|
// Clear any existing tags to ensure test isolation
|
|
db := GetDBXBuilder()
|
|
_, err := db.NewQuery("DELETE FROM tag").Execute()
|
|
Expect(err).ToNot(HaveOccurred())
|
|
|
|
// Ensure library 1 exists and user has access to it
|
|
_, err = db.NewQuery("INSERT OR IGNORE INTO library (id, name, path, default_new_users) VALUES (1, 'Test Library', '/test', true)").Execute()
|
|
Expect(err).ToNot(HaveOccurred())
|
|
_, err = db.NewQuery("INSERT OR IGNORE INTO user_library (user_id, library_id) VALUES ('userid', 1)").Execute()
|
|
Expect(err).ToNot(HaveOccurred())
|
|
|
|
// Add comprehensive test data that covers all test scenarios
|
|
newTag := func(name, value string) model.Tag {
|
|
return model.Tag{ID: id.NewTagID(name, value), TagName: model.TagName(name), TagValue: value}
|
|
}
|
|
|
|
err = tagRepo.Add(ctx, 1,
|
|
newTag("genre", "rock"),
|
|
newTag("genre", "pop"),
|
|
newTag("genre", "jazz"),
|
|
newTag("genre", "electronic"),
|
|
newTag("genre", "classical"),
|
|
newTag("genre", "ambient"),
|
|
newTag("genre", "techno"),
|
|
newTag("genre", "house"),
|
|
newTag("genre", "trance"),
|
|
newTag("genre", "Alternative Rock"),
|
|
newTag("genre", "Blues"),
|
|
newTag("genre", "Country"),
|
|
// These should not be counted as genres
|
|
newTag("mood", "happy"),
|
|
newTag("mood", "ambient"),
|
|
)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
})
|
|
|
|
Describe("GetAll", func() {
|
|
It("should return all genres", func() {
|
|
genres, err := repo.GetAll(ctx)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(genres).To(HaveLen(12))
|
|
|
|
// Verify that all returned items are genres (TagName = "genre")
|
|
genreNames := make([]string, len(genres))
|
|
for i, genre := range genres {
|
|
genreNames[i] = genre.Name
|
|
}
|
|
Expect(genreNames).To(ContainElement("rock"))
|
|
Expect(genreNames).To(ContainElement("pop"))
|
|
Expect(genreNames).To(ContainElement("jazz"))
|
|
// Should not contain mood tags
|
|
Expect(genreNames).ToNot(ContainElement("happy"))
|
|
})
|
|
|
|
It("should support query options", func() {
|
|
// Test with limiting results
|
|
genres, err := repo.GetAll(ctx, model.QueryOptions{Max: 1})
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(genres).To(HaveLen(1))
|
|
})
|
|
|
|
It("should handle empty results gracefully", func() {
|
|
// Clear all genre tags
|
|
_, err := GetDBXBuilder().NewQuery("DELETE FROM tag WHERE tag_name = 'genre'").Execute()
|
|
Expect(err).ToNot(HaveOccurred())
|
|
|
|
genres, err := repo.GetAll(ctx)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(genres).To(BeEmpty())
|
|
})
|
|
Describe("filtering and sorting", func() {
|
|
It("should filter by name using like match", func() {
|
|
// Test filtering by partial name match using the "name" filter which maps to containsFilter("tag_value")
|
|
options := model.QueryOptions{
|
|
Filters: squirrel.Like{"tag_value": "%rock%"}, // Direct field access
|
|
}
|
|
genres, err := repo.GetAll(ctx, options)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(genres).To(HaveLen(2)) // Should match "rock" and "Alternative Rock"
|
|
|
|
// Verify all returned genres contain "rock" in their name
|
|
for _, genre := range genres {
|
|
Expect(strings.ToLower(genre.Name)).To(ContainSubstring("rock"))
|
|
}
|
|
})
|
|
|
|
It("should sort by name in ascending order", func() {
|
|
// Test sorting by name with the fixed mapping
|
|
options := model.QueryOptions{
|
|
Filters: squirrel.Like{"tag_value": "%e%"}, // Should match genres containing "e"
|
|
Sort: "name",
|
|
}
|
|
genres, err := repo.GetAll(ctx, options)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(genres).To(HaveLen(7))
|
|
|
|
Expect(slices.IsSortedFunc(genres, func(a, b model.Genre) int {
|
|
return strings.Compare(b.Name, a.Name) // Inverted to check descending order
|
|
}))
|
|
})
|
|
|
|
It("should sort by name in descending order", func() {
|
|
// Test sorting by name in descending order
|
|
options := model.QueryOptions{
|
|
Filters: squirrel.Like{"tag_value": "%e%"}, // Should match genres containing "e"
|
|
Sort: "name",
|
|
Order: "desc",
|
|
}
|
|
genres, err := repo.GetAll(ctx, options)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(genres).To(HaveLen(7))
|
|
|
|
Expect(slices.IsSortedFunc(genres, func(a, b model.Genre) int {
|
|
return strings.Compare(a.Name, b.Name)
|
|
}))
|
|
})
|
|
})
|
|
})
|
|
|
|
Describe("Count", func() {
|
|
It("should return correct count of genres", func() {
|
|
count, err := restRepo.Count(ctx)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(count).To(Equal(int64(12))) // We have 12 genre tags
|
|
})
|
|
|
|
It("should handle zero count", func() {
|
|
// Clear all genre tags
|
|
_, err := GetDBXBuilder().NewQuery("DELETE FROM tag WHERE tag_name = 'genre'").Execute()
|
|
Expect(err).ToNot(HaveOccurred())
|
|
|
|
count, err := restRepo.Count(ctx)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(count).To(BeZero())
|
|
})
|
|
|
|
It("should only count genre tags", func() {
|
|
// Add a non-genre tag
|
|
nonGenreTag := model.Tag{
|
|
ID: id.NewTagID("mood", "energetic"),
|
|
TagName: "mood",
|
|
TagValue: "energetic",
|
|
}
|
|
err := tagRepo.Add(ctx, 1, nonGenreTag)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
|
|
count, err := restRepo.Count(ctx)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
// Count should not include the mood tag
|
|
Expect(count).To(Equal(int64(12))) // Should still be 12 genre tags
|
|
})
|
|
|
|
It("should filter by name using like match", func() {
|
|
// Test filtering by partial name match using the "name" filter which maps to containsFilter("tag_value")
|
|
options := rest.QueryOptions{
|
|
Filters: map[string]any{"name": "%rock%"},
|
|
}
|
|
count, err := restRepo.Count(ctx, options)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(count).To(BeNumerically("==", 2))
|
|
})
|
|
})
|
|
|
|
Describe("Read", func() {
|
|
It("should return existing genre", func() {
|
|
// Use one of the existing genres from our consolidated dataset
|
|
genreID := id.NewTagID("genre", "rock")
|
|
genre, err := restRepo.Read(ctx, genreID)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(genre.ID).To(Equal(genreID))
|
|
Expect(genre.Name).To(Equal("rock"))
|
|
})
|
|
|
|
It("should return error for non-existent genre", func() {
|
|
_, err := restRepo.Read(ctx, "non-existent-id")
|
|
Expect(err).To(HaveOccurred())
|
|
})
|
|
|
|
It("should not return non-genre tags", func() {
|
|
moodID := id.NewTagID("mood", "happy") // This exists as a mood tag, not genre
|
|
_, err := restRepo.Read(ctx, moodID)
|
|
Expect(err).To(HaveOccurred()) // Should not find it as a genre
|
|
})
|
|
})
|
|
|
|
Describe("ReadAll", func() {
|
|
It("should return all genres through ReadAll", func() {
|
|
genres, err := restRepo.ReadAll(ctx)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(genres).To(HaveLen(12)) // We have 12 genre tags
|
|
|
|
genreNames := make([]string, len(genres))
|
|
for i, genre := range genres {
|
|
genreNames[i] = genre.Name
|
|
}
|
|
// Check for some of our consolidated dataset genres
|
|
Expect(genreNames).To(ContainElement("rock"))
|
|
Expect(genreNames).To(ContainElement("pop"))
|
|
Expect(genreNames).To(ContainElement("jazz"))
|
|
})
|
|
|
|
It("should support rest query options", func() {
|
|
result, err := restRepo.ReadAll(ctx)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(result).ToNot(BeNil())
|
|
})
|
|
})
|
|
|
|
Describe("Library Filtering", func() {
|
|
Context("Headless Processes (No User Context)", func() {
|
|
var headlessRepo model.GenreRepository
|
|
var headlessRestRepo rest.Repository[model.Genre]
|
|
var headlessCtx context.Context
|
|
|
|
BeforeEach(func() {
|
|
headlessCtx = GinkgoT().Context()
|
|
// Create a repository with no user context (headless)
|
|
headlessGenreRepo := NewGenreRepository(GetDBXBuilder())
|
|
headlessRepo = headlessGenreRepo
|
|
headlessRestRepo = headlessGenreRepo
|
|
|
|
// Add genres to different libraries
|
|
db := GetDBXBuilder()
|
|
_, err := db.NewQuery("INSERT OR IGNORE INTO library (id, name, path) VALUES (2, 'Test Library 2', '/test2')").Execute()
|
|
Expect(err).ToNot(HaveOccurred())
|
|
|
|
// Add tags to different libraries
|
|
newTag := func(name, value string) model.Tag {
|
|
return model.Tag{ID: id.NewTagID(name, value), TagName: model.TagName(name), TagValue: value}
|
|
}
|
|
|
|
err = tagRepo.Add(ctx, 2, newTag("genre", "jazz"))
|
|
Expect(err).ToNot(HaveOccurred())
|
|
})
|
|
|
|
It("should see all genres from all libraries when no user is in context", func() {
|
|
// Headless processes should see all genres regardless of library
|
|
genres, err := headlessRepo.GetAll(headlessCtx)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
|
|
// Should see genres from all libraries
|
|
var genreNames []string
|
|
for _, genre := range genres {
|
|
genreNames = append(genreNames, genre.Name)
|
|
}
|
|
|
|
// Should include both rock (library 1) and jazz (library 2)
|
|
Expect(genreNames).To(ContainElement("rock"))
|
|
Expect(genreNames).To(ContainElement("jazz"))
|
|
})
|
|
|
|
It("should count all genres from all libraries when no user is in context", func() {
|
|
count, err := headlessRestRepo.Count(headlessCtx)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
|
|
// Should count all genres from all libraries
|
|
Expect(count).To(BeNumerically(">=", 2))
|
|
})
|
|
|
|
It("should allow headless processes to apply explicit library_id filters", func() {
|
|
// Filter by specific library
|
|
genreList, err := headlessRestRepo.ReadAll(headlessCtx, rest.QueryOptions{
|
|
Filters: map[string]any{"library_id": 2},
|
|
})
|
|
Expect(err).ToNot(HaveOccurred())
|
|
|
|
// Should see only genres from library 2
|
|
Expect(genreList).To(HaveLen(1))
|
|
Expect(genreList[0].Name).To(Equal("jazz"))
|
|
})
|
|
|
|
It("should get individual genres when no user is in context", func() {
|
|
// Get all genres first to find an ID
|
|
genres, err := headlessRepo.GetAll(headlessCtx)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(genres).ToNot(BeEmpty())
|
|
|
|
// Headless process should be able to get the genre
|
|
genre, err := headlessRestRepo.Read(headlessCtx, genres[0].ID)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(genre).ToNot(BeNil())
|
|
})
|
|
})
|
|
})
|
|
})
|