mirror of
https://github.com/navidrome/navidrome.git
synced 2025-07-13 23:21:21 +03:00
* refactor: implement OnSchedulerCallback method in wasmSchedulerCallback Added the OnSchedulerCallback method to the wasmSchedulerCallback struct, enabling it to handle scheduler callback events. This method constructs a SchedulerCallbackRequest and invokes the corresponding plugin method, facilitating better integration with the scheduling system. The changes improve the plugin's ability to respond to scheduled events, enhancing overall functionality. Signed-off-by: Deluan <deluan@navidrome.org> * fix(plugins): update executeCallback method to use callMethod Modified the executeCallback method to accept an additional parameter, methodName, which specifies the callback method to be executed. This change ensures that the correct method is called for each WebSocket event, improving the accuracy of callback execution for plugins. Signed-off-by: Deluan <deluan@navidrome.org> * fix(plugins): capture OnInit metrics Signed-off-by: Deluan <deluan@navidrome.org> * fix(plugins): improve logging for metrics in callMethod Updated the logging statement in the callMethod function to include the elapsed time as a separate key in the log output. This change enhances the clarity of the logged metrics, making it easier to analyze the performance of plugin requests and troubleshoot any issues that may arise. Signed-off-by: Deluan <deluan@navidrome.org> * fix(plugins): enhance logging for schedule callback execution Signed-off-by: Deluan <deluan@navidrome.org> * refactor(server): streamline scrobbler stopping logic Refactored the logic for stopping scrobbler instances when they are removed. The new implementation introduces a `stoppableScrobbler` interface to simplify the type assertion process, allowing for a more concise and readable code structure. This change ensures that any scrobbler implementing the `Stop` method is properly stopped before removal, improving the overall reliability of the plugin management system. Signed-off-by: Deluan <deluan@navidrome.org> * fix(plugins): improve plugin lifecycle management and error handling Enhanced the plugin lifecycle management by implementing error handling in the OnInit method. The changes include the addition of specific error conditions that can be returned during plugin initialization, allowing for better management of plugin states. Additionally, the unregisterPlugin method was updated to ensure proper cleanup of plugins that fail to initialize, improving overall stability and reliability of the plugin system. Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): remove unused LoadAllPlugins and related methods Eliminated the LoadAllPlugins, LoadAllMediaAgents, and LoadAllScrobblers methods from the manager implementation as they were not utilized in the codebase. This cleanup reduces complexity and improves maintainability by removing redundant code, allowing for a more streamlined plugin management process. Signed-off-by: Deluan <deluan@navidrome.org> * fix(plugins): update logging configuration for plugins Configured logging for multiple plugins to remove timestamps and source file/line information, while adding specific prefixes for better identification. Signed-off-by: Deluan <deluan@navidrome.org> * fix(plugins): clear initialization state when unregistering a plugin Added functionality to clear the initialization state of a plugin in the lifecycle manager when it is unregistered. This change ensures that the lifecycle state is accurately maintained, preventing potential issues with plugins that may be re-registered after being unregistered. The new method `clearInitialized` was implemented to handle this state management. Signed-off-by: Deluan <deluan@navidrome.org> * test: add unit tests for convertError function, rename to checkErr Added comprehensive unit tests for the convertError function to ensure correct behavior across various scenarios, including handling nil responses, typed nils, and responses implementing errorResponse. These tests validate that the function returns the expected results without panicking and correctly wraps original errors when necessary. Signed-off-by: Deluan <deluan@navidrome.org> * fix(plugins): update plugin base implementation and method calls Refactored the plugin base implementation by renaming `wasmBasePlugin` to `baseCapability` across multiple files. Updated method calls in the `wasmMediaAgent`, `wasmSchedulerCallback`, and `wasmScrobblerPlugin` to align with the new base structure. These changes improve code clarity and maintainability by standardizing the plugin architecture, ensuring consistent usage of the base capabilities across different plugin types. Signed-off-by: Deluan <deluan@navidrome.org> * fix(discord): handle failed connections and improve heartbeat checks Added a new method to clean up failed connections, which cancels the heartbeat schedule, closes the WebSocket connection, and removes cache entries. Enhanced the heartbeat check to log failures and trigger the cleanup process on the first failure. These changes ensure better management of user connections and improve the overall reliability of the RPC system. Signed-off-by: Deluan <deluan@navidrome.org> --------- Signed-off-by: Deluan <deluan@navidrome.org>
222 lines
6.4 KiB
Go
222 lines
6.4 KiB
Go
package plugins
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
|
|
"github.com/navidrome/navidrome/conf"
|
|
"github.com/navidrome/navidrome/conf/configtest"
|
|
"github.com/navidrome/navidrome/core/agents"
|
|
"github.com/navidrome/navidrome/core/metrics"
|
|
"github.com/navidrome/navidrome/plugins/api"
|
|
. "github.com/onsi/ginkgo/v2"
|
|
. "github.com/onsi/gomega"
|
|
)
|
|
|
|
var _ = Describe("Adapter Media Agent", func() {
|
|
var ctx context.Context
|
|
var mgr *managerImpl
|
|
|
|
BeforeEach(func() {
|
|
ctx = GinkgoT().Context()
|
|
|
|
// Ensure plugins folder is set to testdata
|
|
DeferCleanup(configtest.SetupConfig())
|
|
conf.Server.Plugins.Folder = testDataDir
|
|
|
|
mgr = createManager(nil, metrics.NewNoopInstance())
|
|
mgr.ScanPlugins()
|
|
})
|
|
|
|
Describe("AgentName and PluginName", func() {
|
|
It("should return the plugin name", func() {
|
|
agent := mgr.LoadPlugin("multi_plugin", "MetadataAgent")
|
|
Expect(agent).NotTo(BeNil(), "multi_plugin should be loaded")
|
|
Expect(agent.PluginID()).To(Equal("multi_plugin"))
|
|
})
|
|
It("should return the agent name", func() {
|
|
agent, ok := mgr.LoadMediaAgent("multi_plugin")
|
|
Expect(ok).To(BeTrue(), "multi_plugin should be loaded as media agent")
|
|
Expect(agent.AgentName()).To(Equal("multi_plugin"))
|
|
})
|
|
})
|
|
|
|
Describe("Album methods", func() {
|
|
var agent *wasmMediaAgent
|
|
|
|
BeforeEach(func() {
|
|
a, ok := mgr.LoadMediaAgent("fake_album_agent")
|
|
Expect(ok).To(BeTrue(), "fake_album_agent should be loaded")
|
|
agent = a.(*wasmMediaAgent)
|
|
})
|
|
|
|
Context("GetAlbumInfo", func() {
|
|
It("should return album information", func() {
|
|
info, err := agent.GetAlbumInfo(ctx, "Test Album", "Test Artist", "mbid")
|
|
|
|
Expect(err).NotTo(HaveOccurred())
|
|
Expect(info).NotTo(BeNil())
|
|
Expect(info.Name).To(Equal("Test Album"))
|
|
Expect(info.MBID).To(Equal("album-mbid-123"))
|
|
Expect(info.Description).To(Equal("This is a test album description"))
|
|
Expect(info.URL).To(Equal("https://example.com/album"))
|
|
})
|
|
|
|
It("should return ErrNotFound when plugin returns not found", func() {
|
|
_, err := agent.GetAlbumInfo(ctx, "Test Album", "", "mbid")
|
|
|
|
Expect(err).To(Equal(agents.ErrNotFound))
|
|
})
|
|
|
|
It("should return ErrNotFound when plugin returns nil response", func() {
|
|
_, err := agent.GetAlbumInfo(ctx, "", "", "")
|
|
|
|
Expect(err).To(Equal(agents.ErrNotFound))
|
|
})
|
|
})
|
|
|
|
Context("GetAlbumImages", func() {
|
|
It("should return album images", func() {
|
|
images, err := agent.GetAlbumImages(ctx, "Test Album", "Test Artist", "mbid")
|
|
|
|
Expect(err).NotTo(HaveOccurred())
|
|
Expect(images).To(Equal([]agents.ExternalImage{
|
|
{URL: "https://example.com/album1.jpg", Size: 300},
|
|
{URL: "https://example.com/album2.jpg", Size: 400},
|
|
}))
|
|
})
|
|
})
|
|
})
|
|
|
|
Describe("Artist methods", func() {
|
|
var agent *wasmMediaAgent
|
|
|
|
BeforeEach(func() {
|
|
a, ok := mgr.LoadMediaAgent("fake_artist_agent")
|
|
Expect(ok).To(BeTrue(), "fake_artist_agent should be loaded")
|
|
agent = a.(*wasmMediaAgent)
|
|
})
|
|
|
|
Context("GetArtistMBID", func() {
|
|
It("should return artist MBID", func() {
|
|
mbid, err := agent.GetArtistMBID(ctx, "artist-id", "Test Artist")
|
|
|
|
Expect(err).NotTo(HaveOccurred())
|
|
Expect(mbid).To(Equal("1234567890"))
|
|
})
|
|
|
|
It("should return ErrNotFound when plugin returns not found", func() {
|
|
_, err := agent.GetArtistMBID(ctx, "artist-id", "")
|
|
|
|
Expect(err).To(Equal(agents.ErrNotFound))
|
|
})
|
|
})
|
|
|
|
Context("GetArtistURL", func() {
|
|
It("should return artist URL", func() {
|
|
url, err := agent.GetArtistURL(ctx, "artist-id", "Test Artist", "mbid")
|
|
|
|
Expect(err).NotTo(HaveOccurred())
|
|
Expect(url).To(Equal("https://example.com"))
|
|
})
|
|
})
|
|
|
|
Context("GetArtistBiography", func() {
|
|
It("should return artist biography", func() {
|
|
bio, err := agent.GetArtistBiography(ctx, "artist-id", "Test Artist", "mbid")
|
|
|
|
Expect(err).NotTo(HaveOccurred())
|
|
Expect(bio).To(Equal("This is a test biography"))
|
|
})
|
|
})
|
|
|
|
Context("GetSimilarArtists", func() {
|
|
It("should return similar artists", func() {
|
|
artists, err := agent.GetSimilarArtists(ctx, "artist-id", "Test Artist", "mbid", 10)
|
|
|
|
Expect(err).NotTo(HaveOccurred())
|
|
Expect(artists).To(Equal([]agents.Artist{
|
|
{Name: "Similar Artist 1", MBID: "mbid1"},
|
|
{Name: "Similar Artist 2", MBID: "mbid2"},
|
|
}))
|
|
})
|
|
})
|
|
|
|
Context("GetArtistImages", func() {
|
|
It("should return artist images", func() {
|
|
images, err := agent.GetArtistImages(ctx, "artist-id", "Test Artist", "mbid")
|
|
|
|
Expect(err).NotTo(HaveOccurred())
|
|
Expect(images).To(Equal([]agents.ExternalImage{
|
|
{URL: "https://example.com/image1.jpg", Size: 100},
|
|
{URL: "https://example.com/image2.jpg", Size: 200},
|
|
}))
|
|
})
|
|
})
|
|
|
|
Context("GetArtistTopSongs", func() {
|
|
It("should return artist top songs", func() {
|
|
songs, err := agent.GetArtistTopSongs(ctx, "artist-id", "Test Artist", "mbid", 10)
|
|
|
|
Expect(err).NotTo(HaveOccurred())
|
|
Expect(songs).To(Equal([]agents.Song{
|
|
{Name: "Song 1", MBID: "mbid1"},
|
|
{Name: "Song 2", MBID: "mbid2"},
|
|
}))
|
|
})
|
|
})
|
|
})
|
|
|
|
Describe("Helper functions", func() {
|
|
It("convertExternalImages should convert API image objects to agent image objects", func() {
|
|
apiImages := []*api.ExternalImage{
|
|
{Url: "https://example.com/image1.jpg", Size: 100},
|
|
{Url: "https://example.com/image2.jpg", Size: 200},
|
|
}
|
|
|
|
agentImages := convertExternalImages(apiImages)
|
|
Expect(agentImages).To(HaveLen(2))
|
|
|
|
for i, img := range agentImages {
|
|
Expect(img.URL).To(Equal(apiImages[i].Url))
|
|
Expect(img.Size).To(Equal(int(apiImages[i].Size)))
|
|
}
|
|
})
|
|
|
|
It("convertExternalImages should handle empty slice", func() {
|
|
agentImages := convertExternalImages([]*api.ExternalImage{})
|
|
Expect(agentImages).To(BeEmpty())
|
|
})
|
|
|
|
It("convertExternalImages should handle nil", func() {
|
|
agentImages := convertExternalImages(nil)
|
|
Expect(agentImages).To(BeEmpty())
|
|
})
|
|
})
|
|
|
|
Describe("Error mapping", func() {
|
|
var agent wasmMediaAgent
|
|
|
|
It("should map API ErrNotFound to agents.ErrNotFound", func() {
|
|
err := agent.mapError(api.ErrNotFound)
|
|
Expect(err).To(Equal(agents.ErrNotFound))
|
|
})
|
|
|
|
It("should map API ErrNotImplemented to agents.ErrNotFound", func() {
|
|
err := agent.mapError(api.ErrNotImplemented)
|
|
Expect(err).To(Equal(agents.ErrNotFound))
|
|
})
|
|
|
|
It("should pass through other errors", func() {
|
|
testErr := errors.New("test error")
|
|
err := agent.mapError(testErr)
|
|
Expect(err).To(Equal(testErr))
|
|
})
|
|
|
|
It("should handle nil error", func() {
|
|
err := agent.mapError(nil)
|
|
Expect(err).To(BeNil())
|
|
})
|
|
})
|
|
})
|