//go:build !windows package plugins import ( "context" "crypto/sha256" "encoding/hex" "encoding/json" "errors" "net/http" "os" "path/filepath" "strings" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/tests" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) var _ = Describe("KVStoreService", func() { var tmpDir string var service *kvstoreServiceImpl var ctx context.Context BeforeEach(func() { ctx = GinkgoT().Context() var err error tmpDir, err = os.MkdirTemp("", "kvstore-test-*") Expect(err).ToNot(HaveOccurred()) DeferCleanup(configtest.SetupConfig()) conf.Server.DataFolder = tmpDir // Create service with 1KB limit for testing maxSize := "1KB" service, err = newKVStoreService("test_plugin", &KVStorePermission{MaxSize: &maxSize}) Expect(err).ToNot(HaveOccurred()) }) AfterEach(func() { if service != nil { service.Close() } os.RemoveAll(tmpDir) }) Describe("Basic Operations", func() { It("sets and gets a value", func() { err := service.Set(ctx, "key1", []byte("value1")) Expect(err).ToNot(HaveOccurred()) value, exists, err := service.Get(ctx, "key1") Expect(err).ToNot(HaveOccurred()) Expect(exists).To(BeTrue()) Expect(value).To(Equal([]byte("value1"))) }) It("returns not exists for missing key", func() { value, exists, err := service.Get(ctx, "missing_key") Expect(err).ToNot(HaveOccurred()) Expect(exists).To(BeFalse()) Expect(value).To(BeNil()) }) It("overwrites existing key", func() { err := service.Set(ctx, "key1", []byte("value1")) Expect(err).ToNot(HaveOccurred()) err = service.Set(ctx, "key1", []byte("value2")) Expect(err).ToNot(HaveOccurred()) value, exists, err := service.Get(ctx, "key1") Expect(err).ToNot(HaveOccurred()) Expect(exists).To(BeTrue()) Expect(value).To(Equal([]byte("value2"))) }) It("handles binary data", func() { binaryData := []byte{0x00, 0x01, 0x02, 0xFF, 0xFE, 0xFD} err := service.Set(ctx, "binary", binaryData) Expect(err).ToNot(HaveOccurred()) value, exists, err := service.Get(ctx, "binary") Expect(err).ToNot(HaveOccurred()) Expect(exists).To(BeTrue()) Expect(value).To(Equal(binaryData)) }) }) Describe("Delete Operation", func() { It("deletes a value", func() { err := service.Set(ctx, "delete_me", []byte("value")) Expect(err).ToNot(HaveOccurred()) err = service.Delete(ctx, "delete_me") Expect(err).ToNot(HaveOccurred()) _, exists, err := service.Get(ctx, "delete_me") Expect(err).ToNot(HaveOccurred()) Expect(exists).To(BeFalse()) }) It("does not error when deleting non-existing key", func() { err := service.Delete(ctx, "never_existed") Expect(err).ToNot(HaveOccurred()) }) }) Describe("Has Operation", func() { It("returns true for existing key", func() { err := service.Set(ctx, "exists_key", []byte("value")) Expect(err).ToNot(HaveOccurred()) exists, err := service.Has(ctx, "exists_key") Expect(err).ToNot(HaveOccurred()) Expect(exists).To(BeTrue()) }) It("returns false for non-existing key", func() { exists, err := service.Has(ctx, "non_existing_key") Expect(err).ToNot(HaveOccurred()) Expect(exists).To(BeFalse()) }) }) Describe("List Operation", func() { BeforeEach(func() { Expect(service.Set(ctx, "user:1:name", []byte("Alice"))).To(Succeed()) Expect(service.Set(ctx, "user:1:email", []byte("alice@test.com"))).To(Succeed()) Expect(service.Set(ctx, "user:2:name", []byte("Bob"))).To(Succeed()) Expect(service.Set(ctx, "config:theme", []byte("dark"))).To(Succeed()) }) It("lists all keys with empty prefix", func() { keys, err := service.List(ctx, "") Expect(err).ToNot(HaveOccurred()) Expect(keys).To(HaveLen(4)) Expect(keys).To(ContainElements("config:theme", "user:1:email", "user:1:name", "user:2:name")) }) It("lists keys matching prefix", func() { keys, err := service.List(ctx, "user:1:") Expect(err).ToNot(HaveOccurred()) Expect(keys).To(HaveLen(2)) Expect(keys).To(ContainElements("user:1:name", "user:1:email")) }) It("lists keys matching partial prefix", func() { keys, err := service.List(ctx, "user:") Expect(err).ToNot(HaveOccurred()) Expect(keys).To(HaveLen(3)) }) It("returns empty list for non-matching prefix", func() { keys, err := service.List(ctx, "notfound:") Expect(err).ToNot(HaveOccurred()) Expect(keys).To(BeEmpty()) }) It("handles special LIKE characters in prefix", func() { // Add keys with special characters Expect(service.Set(ctx, "test%key", []byte("value1"))).To(Succeed()) Expect(service.Set(ctx, "test_key", []byte("value2"))).To(Succeed()) Expect(service.Set(ctx, "testXkey", []byte("value3"))).To(Succeed()) // Search for "test%" keys, err := service.List(ctx, "test%") Expect(err).ToNot(HaveOccurred()) Expect(keys).To(HaveLen(1)) Expect(keys).To(ContainElement("test%key")) }) }) Describe("Storage Usage", func() { It("reports correct storage used", func() { used, err := service.GetStorageUsed(ctx) Expect(err).ToNot(HaveOccurred()) Expect(used).To(Equal(int64(0))) err = service.Set(ctx, "key1", []byte("12345")) Expect(err).ToNot(HaveOccurred()) used, err = service.GetStorageUsed(ctx) Expect(err).ToNot(HaveOccurred()) Expect(used).To(Equal(int64(5))) err = service.Set(ctx, "key2", []byte("67890")) Expect(err).ToNot(HaveOccurred()) used, err = service.GetStorageUsed(ctx) Expect(err).ToNot(HaveOccurred()) Expect(used).To(Equal(int64(10))) }) It("updates storage when value is overwritten", func() { err := service.Set(ctx, "key1", []byte("12345")) Expect(err).ToNot(HaveOccurred()) used, _ := service.GetStorageUsed(ctx) Expect(used).To(Equal(int64(5))) // Overwrite with smaller value err = service.Set(ctx, "key1", []byte("ab")) Expect(err).ToNot(HaveOccurred()) used, _ = service.GetStorageUsed(ctx) Expect(used).To(Equal(int64(2))) }) It("decreases storage when key is deleted", func() { Expect(service.Set(ctx, "key1", []byte("12345"))).To(Succeed()) Expect(service.Set(ctx, "key2", []byte("67890"))).To(Succeed()) used, err := service.GetStorageUsed(ctx) Expect(err).ToNot(HaveOccurred()) Expect(used).To(Equal(int64(10))) Expect(service.Delete(ctx, "key1")).To(Succeed()) used, err = service.GetStorageUsed(ctx) Expect(err).ToNot(HaveOccurred()) Expect(used).To(Equal(int64(5))) }) It("updates storage when value is overwritten with larger value", func() { err := service.Set(ctx, "key1", []byte("ab")) Expect(err).ToNot(HaveOccurred()) used, _ := service.GetStorageUsed(ctx) Expect(used).To(Equal(int64(2))) // Overwrite with larger value err = service.Set(ctx, "key1", []byte("12345")) Expect(err).ToNot(HaveOccurred()) used, _ = service.GetStorageUsed(ctx) Expect(used).To(Equal(int64(5))) }) It("restores correct size after service restart", func() { // Add some data Expect(service.Set(ctx, "key1", []byte("12345"))).To(Succeed()) Expect(service.Set(ctx, "key2", []byte("67890"))).To(Succeed()) used, _ := service.GetStorageUsed(ctx) Expect(used).To(Equal(int64(10))) // Close and reopen the service (simulating restart) Expect(service.Close()).To(Succeed()) maxSize := "1KB" service2, err := newKVStoreService("test_plugin", &KVStorePermission{MaxSize: &maxSize}) Expect(err).ToNot(HaveOccurred()) defer service2.Close() // Size should be restored from database used, err = service2.GetStorageUsed(ctx) Expect(err).ToNot(HaveOccurred()) Expect(used).To(Equal(int64(10))) }) }) Describe("Size Limits", func() { It("rejects value when storage limit would be exceeded", func() { // Service has 1KB limit bigValue := make([]byte, 2048) err := service.Set(ctx, "big", bigValue) Expect(err).To(HaveOccurred()) Expect(err.Error()).To(ContainSubstring("storage limit exceeded")) }) It("allows updating existing key even if total would exceed limit", func() { // Fill up most of the storage almostFull := make([]byte, 900) err := service.Set(ctx, "big", almostFull) Expect(err).ToNot(HaveOccurred()) // Overwrite with same size should work err = service.Set(ctx, "big", almostFull) Expect(err).ToNot(HaveOccurred()) }) }) Describe("Key Validation", func() { It("rejects empty key", func() { err := service.Set(ctx, "", []byte("value")) Expect(err).To(HaveOccurred()) Expect(err.Error()).To(ContainSubstring("key cannot be empty")) }) It("rejects key exceeding max length", func() { longKey := strings.Repeat("a", 300) err := service.Set(ctx, longKey, []byte("value")) Expect(err).To(HaveOccurred()) Expect(err.Error()).To(ContainSubstring("key exceeds maximum length")) }) }) Describe("Plugin Isolation", func() { It("isolates data between plugins", func() { service2, err := newKVStoreService("other_plugin", &KVStorePermission{}) Expect(err).ToNot(HaveOccurred()) defer service2.Close() // Set same key in both plugins err = service.Set(ctx, "shared", []byte("value1")) Expect(err).ToNot(HaveOccurred()) err = service2.Set(ctx, "shared", []byte("value2")) Expect(err).ToNot(HaveOccurred()) // Each plugin should get their own value val1, _, _ := service.Get(ctx, "shared") Expect(val1).To(Equal([]byte("value1"))) val2, _, _ := service2.Get(ctx, "shared") Expect(val2).To(Equal([]byte("value2"))) }) It("creates separate database files per plugin", func() { service2, err := newKVStoreService("other_plugin", &KVStorePermission{}) Expect(err).ToNot(HaveOccurred()) defer service2.Close() // Check that separate directories exist _, err = os.Stat(filepath.Join(tmpDir, "plugins", "test_plugin", "kvstore.db")) Expect(err).ToNot(HaveOccurred()) _, err = os.Stat(filepath.Join(tmpDir, "plugins", "other_plugin", "kvstore.db")) Expect(err).ToNot(HaveOccurred()) }) }) Describe("Close", func() { It("closes database connection", func() { err := service.Close() Expect(err).ToNot(HaveOccurred()) // After close, operations should fail _, _, err = service.Get(ctx, "any") Expect(err).To(HaveOccurred()) }) }) }) var _ = Describe("KVStoreService Integration", Ordered, func() { var ( manager *Manager tmpDir string ) BeforeAll(func() { var err error tmpDir, err = os.MkdirTemp("", "kvstore-integration-test-*") Expect(err).ToNot(HaveOccurred()) // Copy the test-kvstore plugin srcPath := filepath.Join(testdataDir, "test-kvstore"+PackageExtension) destPath := filepath.Join(tmpDir, "test-kvstore"+PackageExtension) data, err := os.ReadFile(srcPath) Expect(err).ToNot(HaveOccurred()) err = os.WriteFile(destPath, data, 0600) Expect(err).ToNot(HaveOccurred()) // Compute SHA256 for the plugin hash := sha256.Sum256(data) hashHex := hex.EncodeToString(hash[:]) // Setup config DeferCleanup(configtest.SetupConfig()) conf.Server.Plugins.Enabled = true conf.Server.Plugins.Folder = tmpDir conf.Server.Plugins.AutoReload = false conf.Server.CacheFolder = filepath.Join(tmpDir, "cache") conf.Server.DataFolder = tmpDir // Setup mock DataStore with pre-enabled plugin mockPluginRepo := tests.CreateMockPluginRepo() mockPluginRepo.Permitted = true mockPluginRepo.SetData(model.Plugins{{ ID: "test-kvstore", Path: destPath, SHA256: hashHex, Enabled: true, }}) dataStore := &tests.MockDataStore{MockedPlugin: mockPluginRepo} // Create and start manager manager = &Manager{ plugins: make(map[string]*plugin), ds: dataStore, subsonicRouter: http.NotFoundHandler(), } err = manager.Start(GinkgoT().Context()) Expect(err).ToNot(HaveOccurred()) DeferCleanup(func() { _ = manager.Stop() _ = os.RemoveAll(tmpDir) }) }) Describe("Plugin Loading", func() { It("should load plugin with kvstore permission", func() { manager.mu.RLock() p, ok := manager.plugins["test-kvstore"] manager.mu.RUnlock() Expect(ok).To(BeTrue()) Expect(p.manifest.Permissions).ToNot(BeNil()) Expect(p.manifest.Permissions.Kvstore).ToNot(BeNil()) Expect(*p.manifest.Permissions.Kvstore.MaxSize).To(Equal("10KB")) }) }) Describe("KVStore Operations via Plugin", func() { type testKVStoreInput struct { Operation string `json:"operation"` Key string `json:"key"` Value []byte `json:"value,omitempty"` Prefix string `json:"prefix,omitempty"` } type testKVStoreOutput struct { Value []byte `json:"value,omitempty"` Exists bool `json:"exists,omitempty"` Keys []string `json:"keys,omitempty"` StorageUsed int64 `json:"storage_used,omitempty"` Error *string `json:"error,omitempty"` } callTestKVStore := func(ctx context.Context, input testKVStoreInput) (*testKVStoreOutput, error) { manager.mu.RLock() p := manager.plugins["test-kvstore"] manager.mu.RUnlock() instance, err := p.instance(ctx) if err != nil { return nil, err } defer instance.Close(ctx) inputBytes, _ := json.Marshal(input) _, outputBytes, err := instance.Call("nd_test_kvstore", inputBytes) if err != nil { return nil, err } var output testKVStoreOutput if err := json.Unmarshal(outputBytes, &output); err != nil { return nil, err } if output.Error != nil { return nil, errors.New(*output.Error) } return &output, nil } It("should set and get value", func() { ctx := GinkgoT().Context() // Set value _, err := callTestKVStore(ctx, testKVStoreInput{ Operation: "set", Key: "test_key", Value: []byte("hello kvstore"), }) Expect(err).ToNot(HaveOccurred()) // Get value output, err := callTestKVStore(ctx, testKVStoreInput{ Operation: "get", Key: "test_key", }) Expect(err).ToNot(HaveOccurred()) Expect(output.Exists).To(BeTrue()) Expect(output.Value).To(Equal([]byte("hello kvstore"))) }) It("should check key existence with has", func() { ctx := GinkgoT().Context() // Check existing key output, err := callTestKVStore(ctx, testKVStoreInput{ Operation: "has", Key: "test_key", }) Expect(err).ToNot(HaveOccurred()) Expect(output.Exists).To(BeTrue()) // Check non-existing key output, err = callTestKVStore(ctx, testKVStoreInput{ Operation: "has", Key: "non_existing", }) Expect(err).ToNot(HaveOccurred()) Expect(output.Exists).To(BeFalse()) }) It("should delete value", func() { ctx := GinkgoT().Context() // Set another key _, err := callTestKVStore(ctx, testKVStoreInput{ Operation: "set", Key: "to_delete", Value: []byte("delete me"), }) Expect(err).ToNot(HaveOccurred()) // Delete it _, err = callTestKVStore(ctx, testKVStoreInput{ Operation: "delete", Key: "to_delete", }) Expect(err).ToNot(HaveOccurred()) // Verify it's gone output, err := callTestKVStore(ctx, testKVStoreInput{ Operation: "has", Key: "to_delete", }) Expect(err).ToNot(HaveOccurred()) Expect(output.Exists).To(BeFalse()) }) It("should list keys with prefix", func() { ctx := GinkgoT().Context() // Set some keys for _, key := range []string{"prefix:1", "prefix:2", "other:1"} { _, err := callTestKVStore(ctx, testKVStoreInput{ Operation: "set", Key: key, Value: []byte("value"), }) Expect(err).ToNot(HaveOccurred()) } // List with prefix output, err := callTestKVStore(ctx, testKVStoreInput{ Operation: "list", Prefix: "prefix:", }) Expect(err).ToNot(HaveOccurred()) Expect(output.Keys).To(HaveLen(2)) Expect(output.Keys).To(ContainElements("prefix:1", "prefix:2")) }) It("should report storage used", func() { ctx := GinkgoT().Context() output, err := callTestKVStore(ctx, testKVStoreInput{ Operation: "get_storage_used", }) Expect(err).ToNot(HaveOccurred()) Expect(output.StorageUsed).To(BeNumerically(">", 0)) }) It("should enforce size limits", func() { ctx := GinkgoT().Context() // Plugin has 10KB limit, try to exceed it bigValue := make([]byte, 15*1024) _, err := callTestKVStore(ctx, testKVStoreInput{ Operation: "set", Key: "too_big", Value: bigValue, }) Expect(err).To(HaveOccurred()) Expect(err.Error()).To(ContainSubstring("storage limit exceeded")) }) It("should handle binary data with null bytes through WASM", func() { ctx := GinkgoT().Context() // Binary data with null bytes, high bytes, and other edge cases binaryData := []byte{0x00, 0x01, 0x02, 0xFF, 0xFE, 0x00, 0x80, 0x7F} // Set binary value _, err := callTestKVStore(ctx, testKVStoreInput{ Operation: "set", Key: "binary_test", Value: binaryData, }) Expect(err).ToNot(HaveOccurred()) // Get binary value and verify exact match output, err := callTestKVStore(ctx, testKVStoreInput{ Operation: "get", Key: "binary_test", }) Expect(err).ToNot(HaveOccurred()) Expect(output.Exists).To(BeTrue()) Expect(output.Value).To(Equal(binaryData)) }) }) Describe("Database Isolation", func() { It("should create separate database file for plugin", func() { dbPath := filepath.Join(tmpDir, "plugins", "test-kvstore", "kvstore.db") _, err := os.Stat(dbPath) Expect(err).ToNot(HaveOccurred()) }) }) })