mirror of
https://github.com/navidrome/navidrome.git
synced 2026-03-04 06:35:52 +00:00
2471bb9cf6
* feat(plugins): add expires_at column to kvstore schema
* feat(plugins): filter expired keys in kvstore Get, Has, List
* feat(plugins): add periodic cleanup of expired kvstore keys
* feat(plugins): add SetWithTTL, DeleteByPrefix, and GetMany to kvstore
Add three new methods to the KVStore host service:
- SetWithTTL: store key-value pairs with automatic expiration
- DeleteByPrefix: remove all keys matching a prefix in one operation
- GetMany: retrieve multiple values in a single call
All methods include comprehensive unit tests covering edge cases,
expiration behavior, size tracking, and LIKE-special characters.
* feat(plugins): regenerate code and update test plugin for new kvstore methods
Regenerate host function wrappers and PDK bindings for Go, Python,
and Rust. Update the test-kvstore plugin to exercise SetWithTTL,
DeleteByPrefix, and GetMany.
* feat(plugins): add integration tests for new kvstore methods
Add WASM integration tests for SetWithTTL, DeleteByPrefix, and GetMany
operations through the plugin boundary, verifying end-to-end behavior
including TTL expiration, prefix deletion, and batch retrieval.
* fix(plugins): address lint issues in kvstore implementation
Handle tx.Rollback error return and suppress gosec false positive
for parameterized SQL query construction in GetMany.
* fix(plugins): Set clears expires_at when overwriting a TTL'd key
Previously, calling Set() on a key that was stored with SetWithTTL()
would leave the expires_at value intact, causing the key to silently
expire even though Set implies permanent storage.
Also excludes expired keys from currentSize calculation at startup.
* refactor(plugins): simplify kvstore by removing in-memory size cache
Replaced the in-memory currentSize cache (atomic.Int64), periodic cleanup
timer, and mutex with direct database queries for storage accounting.
This eliminates race conditions and cache drift issues at negligible
performance cost for plugin-sized datasets. Also unified Set and
SetWithTTL into a shared setValue method, simplified DeleteByPrefix to
use RowsAffected instead of a transaction, and added an index on
expires_at for efficient expiration filtering.
* feat(plugins): add generic SQLite migration helper and refactor kvstore schema
Add a reusable migrateDB helper that tracks schema versions via SQLite's
PRAGMA user_version and applies pending migrations transactionally. Replace
the ad-hoc createKVStoreSchema function in kvstore with a declarative
migrations slice, making it easy to add future schema changes. Remove the
now-redundant schema migration test since migrateDB has its own test suite
and every kvstore test exercises the migrations implicitly.
Signed-off-by: Deluan <deluan@navidrome.org>
* fix(plugins): harden kvstore with explicit NULL handling, prefix validation, and cleanup timeout
- Use sql.NullString for expires_at to explicitly send NULL instead of
relying on datetime('now', '') returning NULL by accident
- Reject empty prefix in DeleteByPrefix to prevent accidental data wipe
- Add 5s timeout context to cleanupExpired on Close
- Replace time.Sleep in unit tests with pre-expired timestamps
Signed-off-by: Deluan <deluan@navidrome.org>
* refactor(plugins): use batch processing in GetMany
Process keys in chunks of 200 using slice.CollectChunks to avoid
hitting SQLite's SQLITE_MAX_VARIABLE_NUMBER limit with large key sets.
* feat(plugins): add periodic cleanup goroutine for expired kvstore keys
Use the manager's context to control a background goroutine that purges
expired keys every hour, stopping naturally on shutdown when the context
is cancelled.
---------
Signed-off-by: Deluan <deluan@navidrome.org>
99 lines
3.1 KiB
Go
99 lines
3.1 KiB
Go
package host
|
|
|
|
import "context"
|
|
|
|
// KVStoreService provides persistent key-value storage for plugins.
|
|
//
|
|
// Unlike CacheService which is in-memory only, KVStoreService persists data
|
|
// to disk and survives server restarts. Each plugin has its own isolated
|
|
// storage with configurable size limits.
|
|
//
|
|
// Values are stored as raw bytes, giving plugins full control over
|
|
// serialization (JSON, protobuf, etc.).
|
|
//
|
|
//nd:hostservice name=KVStore permission=kvstore
|
|
type KVStoreService interface {
|
|
// Set stores a byte value with the given key.
|
|
//
|
|
// Parameters:
|
|
// - key: The storage key (max 256 bytes, UTF-8)
|
|
// - value: The byte slice to store
|
|
//
|
|
// Returns an error if the storage limit would be exceeded or the operation fails.
|
|
//nd:hostfunc
|
|
Set(ctx context.Context, key string, value []byte) error
|
|
|
|
// SetWithTTL stores a byte value with the given key and a time-to-live.
|
|
//
|
|
// After ttlSeconds, the key is treated as non-existent and will be
|
|
// cleaned up lazily. ttlSeconds must be greater than 0.
|
|
//
|
|
// Parameters:
|
|
// - key: The storage key (max 256 bytes, UTF-8)
|
|
// - value: The byte slice to store
|
|
// - ttlSeconds: Time-to-live in seconds (must be > 0)
|
|
//
|
|
// Returns an error if the storage limit would be exceeded or the operation fails.
|
|
//nd:hostfunc
|
|
SetWithTTL(ctx context.Context, key string, value []byte, ttlSeconds int64) error
|
|
|
|
// Get retrieves a byte value from storage.
|
|
//
|
|
// Parameters:
|
|
// - key: The storage key
|
|
//
|
|
// Returns the value and whether the key exists.
|
|
//nd:hostfunc
|
|
Get(ctx context.Context, key string) (value []byte, exists bool, err error)
|
|
|
|
// GetMany retrieves multiple values in a single call.
|
|
//
|
|
// Parameters:
|
|
// - keys: The storage keys to retrieve
|
|
//
|
|
// Returns a map of key to value for keys that exist and have not expired.
|
|
// Missing or expired keys are omitted from the result.
|
|
//nd:hostfunc
|
|
GetMany(ctx context.Context, keys []string) (values map[string][]byte, err error)
|
|
|
|
// Has checks if a key exists in storage.
|
|
//
|
|
// Parameters:
|
|
// - key: The storage key
|
|
//
|
|
// Returns true if the key exists.
|
|
//nd:hostfunc
|
|
Has(ctx context.Context, key string) (exists bool, err error)
|
|
|
|
// List returns all keys matching the given prefix.
|
|
//
|
|
// Parameters:
|
|
// - prefix: Key prefix to filter by (empty string returns all keys)
|
|
//
|
|
// Returns a slice of matching keys.
|
|
//nd:hostfunc
|
|
List(ctx context.Context, prefix string) (keys []string, err error)
|
|
|
|
// Delete removes a value from storage.
|
|
//
|
|
// Parameters:
|
|
// - key: The storage key
|
|
//
|
|
// Returns an error if the operation fails. Does not return an error if the key doesn't exist.
|
|
//nd:hostfunc
|
|
Delete(ctx context.Context, key string) error
|
|
|
|
// DeleteByPrefix removes all keys matching the given prefix.
|
|
//
|
|
// Parameters:
|
|
// - prefix: Key prefix to match (must not be empty)
|
|
//
|
|
// Returns the number of keys deleted. Includes expired keys.
|
|
//nd:hostfunc
|
|
DeleteByPrefix(ctx context.Context, prefix string) (deletedCount int64, err error)
|
|
|
|
// GetStorageUsed returns the total storage used by this plugin in bytes.
|
|
//nd:hostfunc
|
|
GetStorageUsed(ctx context.Context) (bytes int64, err error)
|
|
}
|