feat: new "Subsonic Minimal Clients" configuration option (#4850)

* Add `.editorconfig` file Hints to users how to properly indent Go files (my setup was defaulting to 2 spaces). * Add Subsonic API minimal config option This will allow users to specify clients which can operate with or need the minimum required fields as per the [SubSonic API spec](https://subsonic.org/pages/api.jsp). * Return only required fields for Child Objects For a minimal client, only return the required fields for Child Objects. * Return only required fields for Playlist objects * refactor: simplify client list checks and improve playlist response handling Signed-off-by: Deluan <deluan@navidrome.org> * test: add unit tests for client list checks and playlist building logic Signed-off-by: Deluan <deluan@navidrome.org> * fix: revert Child.IsVideo and Playlist.Public fields from pointer to boolean, and add omitempty to XML tag Signed-off-by: Deluan <deluan@navidrome.org> --------- Signed-off-by: Deluan <deluan@navidrome.org> Co-authored-by: Deluan Quintão <deluan@navidrome.org>
2026-01-16 10:55:21 +00:00
parent 032cfa2a4d
commit 9ab0c2dc67
36 changed files with 360 additions and 60 deletions
@@ -2,9 +2,12 @@ package subsonic

 import (
 	"context"
+	"time"

+	"github.com/navidrome/navidrome/conf"
 	"github.com/navidrome/navidrome/core"
 	"github.com/navidrome/navidrome/model"
+	"github.com/navidrome/navidrome/model/request"
 	"github.com/navidrome/navidrome/tests"
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
@@ -12,6 +15,108 @@ import (

 var _ core.Playlists = (*fakePlaylists)(nil)

+var _ = Describe("buildPlaylist", func() {
+	var router *Router
+	var ds model.DataStore
+	var ctx context.Context
+	var playlist model.Playlist
+
+	BeforeEach(func() {
+		ds = &tests.MockDataStore{}
+		router = New(ds, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil)
+		ctx = context.Background()
+
+		createdAt := time.Date(2023, 1, 15, 10, 30, 0, 0, time.UTC)
+		updatedAt := time.Date(2023, 2, 20, 14, 45, 0, 0, time.UTC)
+
+		playlist = model.Playlist{
+			ID:        "pls-1",
+			Name:      "My Playlist",
+			Comment:   "Test comment",
+			OwnerName: "admin",
+			Public:    true,
+			SongCount: 10,
+			Duration:  600,
+			CreatedAt: createdAt,
+			UpdatedAt: updatedAt,
+		}
+	})
+
+	Context("with minimal client", func() {
+		BeforeEach(func() {
+			conf.Server.Subsonic.MinimalClients = "minimal-client"
+			player := model.Player{Client: "minimal-client"}
+			ctx = request.WithPlayer(ctx, player)
+		})
+
+		It("returns only basic fields", func() {
+			result := router.buildPlaylist(ctx, playlist)
+
+			Expect(result.Id).To(Equal("pls-1"))
+			Expect(result.Name).To(Equal("My Playlist"))
+			Expect(result.SongCount).To(Equal(int32(10)))
+			Expect(result.Duration).To(Equal(int32(600)))
+			Expect(result.Created).To(Equal(playlist.CreatedAt))
+			Expect(result.Changed).To(Equal(playlist.UpdatedAt))
+
+			// These should not be set
+			Expect(result.Comment).To(BeEmpty())
+			Expect(result.Owner).To(BeEmpty())
+			Expect(result.Public).To(BeFalse())
+			Expect(result.CoverArt).To(BeEmpty())
+		})
+	})
+
+	Context("with non-minimal client", func() {
+		BeforeEach(func() {
+			conf.Server.Subsonic.MinimalClients = "minimal-client"
+			player := model.Player{Client: "regular-client"}
+			ctx = request.WithPlayer(ctx, player)
+		})
+
+		It("returns all fields", func() {
+			result := router.buildPlaylist(ctx, playlist)
+
+			Expect(result.Id).To(Equal("pls-1"))
+			Expect(result.Name).To(Equal("My Playlist"))
+			Expect(result.SongCount).To(Equal(int32(10)))
+			Expect(result.Duration).To(Equal(int32(600)))
+			Expect(result.Created).To(Equal(playlist.CreatedAt))
+			Expect(result.Changed).To(Equal(playlist.UpdatedAt))
+			Expect(result.Comment).To(Equal("Test comment"))
+			Expect(result.Owner).To(Equal("admin"))
+			Expect(result.Public).To(BeTrue())
+		})
+	})
+
+	Context("when minimal clients list is empty", func() {
+		BeforeEach(func() {
+			conf.Server.Subsonic.MinimalClients = ""
+			player := model.Player{Client: "any-client"}
+			ctx = request.WithPlayer(ctx, player)
+		})
+
+		It("returns all fields", func() {
+			result := router.buildPlaylist(ctx, playlist)
+
+			Expect(result.Comment).To(Equal("Test comment"))
+			Expect(result.Owner).To(Equal("admin"))
+			Expect(result.Public).To(BeTrue())
+		})
+	})
+
+	Context("when no player in context", func() {
+		It("returns all fields", func() {
+			result := router.buildPlaylist(ctx, playlist)
+
+			Expect(result.Comment).To(Equal("Test comment"))
+			Expect(result.Owner).To(Equal("admin"))
+			Expect(result.Public).To(BeTrue())
+		})
+	})
+
+})
+
 var _ = Describe("UpdatePlaylist", func() {
 	var router *Router
 	var ds model.DataStore