Skip to content

🎧 Your Personal Streaming Service

fix(nativeapi): stop partial PUTs from clearing untouched columns (#6058)

Deluan Quintão96b051ffa774
diff --git a/core/library.go b/core/library.go
index 365dcbd4c..d905e00cb 100644
--- a/core/library.go
+++ b/core/library.go
@@ -191,7 +191,7 @@ func (r *libraryRepositoryWrapper) Save(entity any) (string, error) {
return strconv.Itoa(lib.ID), nil
}
-func (r *libraryRepositoryWrapper) Update(id string, entity any, _ ...string) error {
+func (r *libraryRepositoryWrapper) Update(id string, entity any, cols ...string) error {
lib := entity.(*model.Library)
libID, err := strconv.Atoi(id)
if err != nil {
@@ -211,7 +211,7 @@ func (r *libraryRepositoryWrapper) Update(id string, entity any, _ ...string) er
pathChanged := originalLib.Path != lib.Path
- err = r.LibraryRepository.Put(lib)
+ err = r.LibraryRepository.Put(lib, cols...)
if err != nil {
return r.mapError(err)
}
diff --git a/core/library_test.go b/core/library_test.go
index 175d9c37d..43097414d 100644
--- a/core/library_test.go
+++ b/core/library_test.go
@@ -188,6 +188,15 @@ var _ = Describe("Library Service", func() {
Expect(libraryRepo.Data[1].Path).To(Equal(newTempDir))
})
+ It("forwards the columns sent by the client to the repository", func() {
+ library := &model.Library{ID: 1, Name: "Updated Library", Path: tempDir}
+
+ err := repo.Update("1", library, "name", "path")
+
+ Expect(err).NotTo(HaveOccurred())
+ Expect(libraryRepo.PutCols).To(Equal([]string{"name", "path"}))
+ })
+
It("fails when library doesn't exist", func() {
// Create a unique temporary directory to avoid path conflicts
uniqueTempDir, err := os.MkdirTemp("", "navidrome-nonexistent-")
diff --git a/model/library.go b/model/library.go
index bcb2864c8..aceab533a 100644
--- a/model/library.go
+++ b/model/library.go
@@ -45,7 +45,7 @@ type LibraryRepository interface {
GetPath(id int) (string, error)
GetAll(...QueryOptions) (Libraries, error)
CountAll(...QueryOptions) (int64, error)
- Put(*Library) error
+ Put(l *Library, colsToUpdate ...string) error
Delete(id int) error
StoreMusicFolder() error
AddArtist(id int, artistID string) error
diff --git a/persistence/library_repository.go b/persistence/library_repository.go
index 5a0142423..df5c9a066 100644
--- a/persistence/library_repository.go
+++ b/persistence/library_repository.go
@@ -70,7 +70,7 @@ func (r *libraryRepository) GetPath(id int) (string, error) {
}
}
-func (r *libraryRepository) Put(l *model.Library) error {
+func (r *libraryRepository) Put(l *model.Library, colsToUpdate ...string) error {
if l.ID == model.DefaultLibraryID {
currentLib, err := r.Get(1)
// if we are creating it, it's ok.
@@ -89,13 +89,13 @@ func (r *libraryRepository) Put(l *model.Library) error {
err = r.db.Model(l).Insert()
} else {
// Try to update first
- cols := map[string]any{
+ cols := selectUpdateColumns(map[string]any{
"name": l.Name,
"path": l.Path,
"remote_path": l.RemotePath,
"default_new_users": l.DefaultNewUsers,
- "updated_at": l.UpdatedAt,
- }
+ }, colsToUpdate...)
+ cols["updated_at"] = l.UpdatedAt
sq := Update(r.tableName).SetMap(cols).Where(Eq{"id": l.ID})
rowsAffected, updateErr := r.executeSQL(sq)
if updateErr != nil {
@@ -340,7 +340,7 @@ func (r *libraryRepository) Update(id string, entity any, cols ...string) error
}
lib.ID = idInt
- return r.Put(lib)
+ return r.Put(lib, cols...)
}
var _ model.LibraryRepository = (*libraryRepository)(nil)
diff --git a/persistence/library_repository_test.go b/persistence/library_repository_test.go
index 1743df209..949dd93c5 100644
--- a/persistence/library_repository_test.go
+++ b/persistence/library_repository_test.go
@@ -52,6 +52,26 @@ var _ = Describe("LibraryRepository", func() {
})
})
+ Context("when colsToUpdate is specified", func() {
+ It("only writes the requested columns", func() {
+ lib := &model.Library{
+ Name: "Original Library",
+ Path: "/music/original",
+ RemotePath: "/remote/original",
+ DefaultNewUsers: true,
+ }
+ Expect(repo.Put(lib)).To(Succeed())
+
+ Expect(repo.Put(&model.Library{ID: lib.ID, Name: "Renamed", Path: lib.Path}, "name", "path")).To(Succeed())
+
+ saved, err := repo.Get(lib.ID)
+ Expect(err).ToNot(HaveOccurred())
+ Expect(saved.Name).To(Equal("Renamed"))
+ Expect(saved.RemotePath).To(Equal("/remote/original"))
+ Expect(saved.DefaultNewUsers).To(BeTrue())
+ })
+ })
+
Context("when ID is non-zero and record exists", func() {
It("updates the existing record", func() {
// First create a library
diff --git a/persistence/plugin_repository.go b/persistence/plugin_repository.go
index 35c32de91..c1e36f0b1 100644
--- a/persistence/plugin_repository.go
+++ b/persistence/plugin_repository.go
@@ -141,31 +141,5 @@ func (r *pluginRepository) ReadAll(options ...rest.QueryOptions) (any, error) {
return r.GetAll(r.parseRestOptions(r.ctx, options...))
}
-func (r *pluginRepository) Save(entity any) (string, error) {
- p := entity.(*model.Plugin)
- if !r.isPermitted() {
- return "", rest.ErrPermissionDenied
- }
- err := r.Put(p)
- if errors.Is(err, model.ErrNotFound) {
- return "", rest.ErrNotFound
- }
- return p.ID, err
-}
-
-func (r *pluginRepository) Update(id string, entity any, cols ...string) error {
- p := entity.(*model.Plugin)
- p.ID = id
- if !r.isPermitted() {
- return rest.ErrPermissionDenied
- }
- err := r.Put(p)
- if errors.Is(err, model.ErrNotFound) {
- return rest.ErrNotFound
- }
- return err
-}
-
var _ model.PluginRepository = (*pluginRepository)(nil)
var _ rest.Repository = (*pluginRepository)(nil)
-var _ rest.Persistable = (*pluginRepository)(nil)
diff --git a/persistence/radio_repository.go b/persistence/radio_repository.go
index b73487e40..915859559 100644
--- a/persistence/radio_repository.go
+++ b/persistence/radio_repository.go
@@ -152,7 +152,7 @@ func (r *radioRepository) Update(id string, entity any, cols ...string) error {
if !r.isPermitted() {
return rest.ErrPermissionDenied
}
- err := r.Put(t)
+ err := r.Put(t, cols...)
if errors.Is(err, model.ErrNotFound) {
return rest.ErrNotFound
}
diff --git a/persistence/radio_repository_test.go b/persistence/radio_repository_test.go
index e2564455d..c35c85ad7 100644
--- a/persistence/radio_repository_test.go
+++ b/persistence/radio_repository_test.go
@@ -141,6 +141,24 @@ var _ = Describe("RadioRepository", func() {
)))
})
})
+
+ Describe("Update", func() {
+ It("only writes the columns sent by the client", func() {
+ radio := radioWithHomePage
+ radio.UploadedImage = "cover.png"
+ Expect(repo.Put(&radio)).To(Succeed())
+
+ persistable := repo.(rest.Persistable)
+ Expect(persistable.Update(radio.ID, &model.Radio{Name: "Renamed"}, "name")).To(Succeed())
+
+ item, err := repo.Get(radio.ID)
+ Expect(err).To(BeNil())
+ Expect(item.Name).To(Equal("Renamed"))
+ Expect(item.UploadedImage).To(Equal("cover.png"))
+ Expect(item.StreamUrl).To(Equal(radio.StreamUrl))
+ Expect(item.HomePageUrl).To(Equal(radio.HomePageUrl))
+ })
+ })
})
Describe("Regular User", func() {
diff --git a/persistence/sql_base_repository.go b/persistence/sql_base_repository.go
index f49e1bc4f..5530d2568 100644
--- a/persistence/sql_base_repository.go
+++ b/persistence/sql_base_repository.go
@@ -560,13 +560,11 @@ func (r sqlRepository) putByMatch(filter Sqlizer, id string, m any, colsToUpdate
return r.put(res.ID, m, colsToUpdate...)
}
-// filterUpdateValues selects, from a marshaled column map, the values to write in an UPDATE on the
-// row identified by id: only the requested colsToUpdate (or all columns when none are specified),
-// dropping columns that must never be overwritten on update (created_at, birth_time).
-func filterUpdateValues(values map[string]any, id string, colsToUpdate ...string) map[string]any {
+// selectUpdateColumns keeps only the requested colsToUpdate (or all columns when none are
+// specified), dropping columns that must never be overwritten on update (created_at, birth_time).
+func selectUpdateColumns(values map[string]any, colsToUpdate ...string) map[string]any {
updateValues := map[string]any{}
- // This is a map of the columns that need to be updated, if specified
c2upd := slice.ToMap(colsToUpdate, func(s string) (string, struct{}) {
return toSnakeCase(s), struct{}{}
})
@@ -576,7 +574,6 @@ func filterUpdateValues(values map[string]any, id string, colsToUpdate ...string
}
}
- updateValues["id"] = id
delete(updateValues, "created_at")
// To avoid updating the media_file birth_time on each scan. Not the best solution, but it works for now
// TODO move to mediafile_repository when each repo has its own upsert method
@@ -584,6 +581,12 @@ func filterUpdateValues(values map[string]any, id string, colsToUpdate ...string
return updateValues
}
+func filterUpdateValues(values map[string]any, id string, colsToUpdate ...string) map[string]any {
+ updateValues := selectUpdateColumns(values, colsToUpdate...)
+ updateValues["id"] = id
+ return updateValues
+}
+
func (r sqlRepository) put(id string, m any, colsToUpdate ...string) (newId string, err error) {
values, err := toSQLArgs(m)
if err != nil {
diff --git a/tests/mock_library_repo.go b/tests/mock_library_repo.go
index 3f0e576e9..1a16a7e0b 100644
--- a/tests/mock_library_repo.go
+++ b/tests/mock_library_repo.go
@@ -14,9 +14,10 @@ import (
type MockLibraryRepo struct {
model.LibraryRepository
- Data map[int]model.Library
- Err error
- PutFn func(*model.Library) error // Allow custom Put behavior for testing
+ Data map[int]model.Library
+ Err error
+ PutFn func(*model.Library) error // Allow custom Put behavior for testing
+ PutCols []string
}
func (m *MockLibraryRepo) SetData(data model.Libraries) {
@@ -90,7 +91,8 @@ func (m *MockLibraryRepo) GetPath(id int) (string, error) {
return "", model.ErrNotFound
}
-func (m *MockLibraryRepo) Put(library *model.Library) error {
+func (m *MockLibraryRepo) Put(library *model.Library, colsToUpdate ...string) error {
+ m.PutCols = colsToUpdate
if m.PutFn != nil {
return m.PutFn(library)
}