feat(plugins): New Plugin System with multi-language PDK support (#4833)
* chore(plugins): remove the old plugins system implementation Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): implement new plugin system with using Extism Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): add capability detection for plugins based on exported functions Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): add auto-reload functionality for plugins with file watcher support Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): add auto-reload functionality for plugins with file watcher support Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): standardize variable names and remove superfluous wrapper functions Signed-off-by: Deluan <deluan@navidrome.org> * fix(plugins): improve error handling and logging in plugin manager Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): implement plugin function call helper and refactor MetadataAgent methods Signed-off-by: Deluan <deluan@navidrome.org> * fix(plugins): race condition in plugin manager * tests(plugins): change BeforeEach to BeforeAll in MetadataAgent tests Signed-off-by: Deluan <deluan@navidrome.org> * tests(plugins): optimize tests Signed-off-by: Deluan <deluan@navidrome.org> * tests(plugins): more optimizations Signed-off-by: Deluan <deluan@navidrome.org> * test(plugins): ignore goroutine leaks from notify library in tests Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): add Wikimedia plugin for Navidrome to fetch artist metadata Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): enhance plugin logging and set User-Agent header Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): implement scrobbler plugin with authorization and scrobbling capabilities Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): integrate logs Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): clean up manifest struct and improve plugin loading logic Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): add metadata agent and scrobbler schemas for bootstrapping plugins Signed-off-by: Deluan <deluan@navidrome.org> * feat(hostgen): add hostgen tool for generating Extism host function wrappers - Implemented hostgen tool to generate wrappers from annotated Go interfaces. - Added command-line flags for input/output directories and package name. - Introduced parsing and code generation logic for host services. - Created test data for various service interfaces and expected generated code. - Added documentation for host services and annotations for code generation. - Implemented SubsonicAPI service with corresponding generated code. * feat(subsonicapi): update Call method to return JSON string response Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): implement SubsonicAPI host function integration with permissions Signed-off-by: Deluan <deluan@navidrome.org> * fix(generator): error-only methods in response handling Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): generate client wrappers for host functions Signed-off-by: Deluan <deluan@navidrome.org> * refactor(generator): remove error handling for response.Error in client templates Signed-off-by: Deluan <deluan@navidrome.org> * feat(scheduler): add Scheduler service interface with host function wrappers for scheduling tasks * feat(plugins): add WASI build constraints to client wrapper templates, to avoid lint errors Signed-off-by: Deluan <deluan@navidrome.org> * feat(scheduler): implement Scheduler service with one-time and recurring scheduling capabilities Signed-off-by: Deluan <deluan@navidrome.org> * refactor(manifest): remove unused ConfigPermission from permissions schema Signed-off-by: Deluan <deluan@navidrome.org> * feat(scheduler): add scheduler callback schema and implementation for plugins Signed-off-by: Deluan <deluan@navidrome.org> * refactor(scheduler): streamline scheduling logic and remove unused callback tracking Signed-off-by: Deluan <deluan@navidrome.org> * refactor(scheduler): add Close method for resource cleanup on plugin unload Signed-off-by: Deluan <deluan@navidrome.org> * docs(scheduler): clarify SchedulerCallback requirement for scheduling functions Signed-off-by: Deluan <deluan@navidrome.org> * fix: update wasm build rule to include all Go files in the directory Signed-off-by: Deluan <deluan@navidrome.org> * feat: rewrite the wikimedia plugin using the XTP CLI Signed-off-by: Deluan <deluan@navidrome.org> * refactor(scheduler): replace uuid with id.NewRandom for schedule ID generation Signed-off-by: Deluan <deluan@navidrome.org> * refactor: capabilities registration Signed-off-by: Deluan <deluan@navidrome.org> * test: add scheduler service isolation test for plugin instances Signed-off-by: Deluan <deluan@navidrome.org> * refactor: update plugin manager initialization and encapsulate logic Signed-off-by: Deluan <deluan@navidrome.org> * feat: add WebSocket service definitions for plugin communication Signed-off-by: Deluan <deluan@navidrome.org> * feat: implement WebSocket service for plugin integration and connection management Signed-off-by: Deluan <deluan@navidrome.org> * feat: add Crypto Ticker example plugin for real-time cryptocurrency price updates via Coinbase WebSocket API Also add the lifecycle capability Signed-off-by: Deluan <deluan@navidrome.org> * fix: use context.Background() in invokeCallback for scheduled tasks Signed-off-by: Deluan <deluan@navidrome.org> * refactor: rename plugin.create() to plugin.instance() Signed-off-by: Deluan <deluan@navidrome.org> * refactor: rename pluginInstance to plugin for consistency across the codebase Signed-off-by: Deluan <deluan@navidrome.org> * refactor: simplify schedule cloning in Close method and enhance plugin cleanup error handling Signed-off-by: Deluan <deluan@navidrome.org> * feat: implement Artwork service for generating artwork URLs in Navidrome plugins - WIP Signed-off-by: Deluan <deluan@navidrome.org> * refactor: moved public URL builders to avoid import cycles Signed-off-by: Deluan <deluan@navidrome.org> * feat: add Cache service for in-memory TTL-based caching in plugins Signed-off-by: Deluan <deluan@navidrome.org> * feat: add Discord Rich Presence example plugin for Navidrome integration Signed-off-by: Deluan <deluan@navidrome.org> * refactor: host function wrappers to use structured request and response types - Updated the host function signatures in `nd_host_artwork.go`, `nd_host_scheduler.go`, `nd_host_subsonicapi.go`, and `nd_host_websocket.go` to accept a single parameter for JSON requests. - Introduced structured request and response types for various cache operations in `nd_host_cache.go`. - Modified cache functions to marshal requests to JSON and unmarshal responses, improving error handling and code clarity. - Removed redundant memory allocation for string parameters in favor of JSON marshaling. - Enhanced error handling in WebSocket and cache operations to return structured error responses. * refactor: error handling in various plugins to convert response.Error to Go errors - Updated error handling in `nd_host_scheduler.go`, `nd_host_websocket.go`, `nd_host_artwork.go`, `nd_host_cache.go`, and `nd_host_subsonicapi.go` to convert string errors from responses into Go errors. - Removed redundant error checks in test data plugins for cleaner code. - Ensured consistent error handling across all plugins to improve reliability and maintainability. * refactor: rename fake plugins to test plugins for clarity in integration tests Signed-off-by: Deluan <deluan@navidrome.org> * feat: add help target to Makefile for plugin usage instructions Signed-off-by: Deluan <deluan@navidrome.org> * feat: add Cover Art Archive plugin as an example of Python plugin Signed-off-by: Deluan <deluan@navidrome.org> * feat: update Makefile and README to clarify Go plugin usage Signed-off-by: Deluan <deluan@navidrome.org> * feat: include plugin capabilities in loading log message Signed-off-by: Deluan <deluan@navidrome.org> * feat: add trace logging for plugin availability and error handling in agents Signed-off-by: Deluan <deluan@navidrome.org> * feat: add Now Playing Logger plugin to showcase calling host functions from Python plugins Signed-off-by: Deluan <deluan@navidrome.org> * feat: generate Python client wrappers for various host services Signed-off-by: Deluan <deluan@navidrome.org> * feat: add generated host function wrappers for Scheduler and SubsonicAPI services Signed-off-by: Deluan <deluan@navidrome.org> * feat: update Python plugin documentation and usage instructions for host function wrappers Signed-off-by: Deluan <deluan@navidrome.org> * feat: add Webhook Scrobbler plugin in Rust to send HTTP notifications on scrobble events Signed-off-by: Deluan <deluan@navidrome.org> * feat: enable parallel loading of plugins during startup Signed-off-by: Deluan <deluan@navidrome.org> * docs: update README to include WebSocket callback schema in plugin documentation Signed-off-by: Deluan <deluan@navidrome.org> * feat: extend plugin watcher with improved logging and debounce duration adjustment Signed-off-by: Deluan <deluan@navidrome.org> * add trace message for plugin recompiles Signed-off-by: Deluan <deluan@navidrome.org> * feat: implement plugin cache purging functionality Signed-off-by: Deluan <deluan@navidrome.org> * test: move purgeCacheBySize unit tests Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins UI): add plugin repository and database support Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins UI): add plugin management routes and middleware Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins UI): implement plugin synchronization with database for add, update, and remove actions Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins UI): add PluginList and PluginShow components with plugin management functionality Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): optimize plugin change detection Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins UI): improve PluginList structure Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins UI): enhance PluginShow with author, website, and permissions display Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins UI): refactor to use MUI and RA components Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins UI): add error handling for plugin enable/disable actions Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): inject PluginManager into native API Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): update GetManager to accept DataStore parameter Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): add subsonicRouter to Manager and refactor host service registration Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): enhance debug logging for plugin actions and recompile logic Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): break manager.go into smaller, focused files Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): streamline error handling and improve plugin retrieval logic Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): update newWebSocketService to use WebSocketPermission for allowed hosts Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): introduce ToggleEnabledSwitch for managing plugin enable/disable state Signed-off-by: Deluan <deluan@navidrome.org> * docs: update READMEs Signed-off-by: Deluan <deluan@navidrome.org> * feat(library): add Library service for metadata access and filesystem integration Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): add Library Inspector plugin for periodic library inspection and file size logging Signed-off-by: Deluan <deluan@navidrome.org> * docs: update README to reflect JSON configuration format for plugins Signed-off-by: Deluan <deluan@navidrome.org> * fix(build): update target to wasm32-wasip1 for improved WASI support Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): implement configuration management UI with key-value pairs support Signed-off-by: Deluan <deluan@navidrome.org> * feat(ui): adjust grid layout in InfoRow component for improved responsiveness Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): rename ErrorIndicator to EnabledOrErrorField and enhance error handling logic Signed-off-by: Deluan <deluan@navidrome.org> * feat(i18n): add Portuguese translations for plugin management and notifications Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): add support for .ndp plugin packages and update build process Signed-off-by: Deluan <deluan@navidrome.org> * docs: update README for .ndp plugin packaging and installation instructions Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): implement KVStore service for persistent key-value storage Signed-off-by: Deluan <deluan@navidrome.org> * docs: enhance README with Extism plugin development resources and recommendations Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): integrate event broker into plugin manager Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): update config handling in PluginShow to track last record state Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): add Rust host function library and example implementation of Discord Rich Presence plugin in Rust Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): generate Rust lib.rs file to expose host function wrappers Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): update JSON field names to camelCase for consistency Signed-off-by: Deluan <deluan@navidrome.org> * refactor: reduce cyclomatic complexity by refactoring main function Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): enhance Rust code generation with typed struct support and improved type handling Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): add Go client library with host function wrappers and documentation Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): generate Go client stubs for non-WASM platforms Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): update client template file names for consistency Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): add initial implementation of the Navidrome Plugin Development Kit code generator - Pahse 1 Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): implementation of the Navidrome Plugin Development Kit with generated client wrappers and service interfaces - Phase 2 Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): implementation of the Navidrome Plugin Development Kit with generated client wrappers and service interfaces - Phase 2 (2) Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): implementation of the Navidrome Plugin Development Kit with generated client wrappers and service interfaces - Phase 3 Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): implementation of the Navidrome Plugin Development Kit with generated client wrappers and service interfaces - Phase 4 Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): implementation of the Navidrome Plugin Development Kit with generated client wrappers and service interfaces - Phase 5 Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): consistent naming/types across PDK Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): streamline plugin function signatures and error handling Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): update scrobbler interface to return errors directly instead of response structs Signed-off-by: Deluan <deluan@navidrome.org> * test: make all test plugins use the PDK Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): reorganize and sort type definitions for consistency Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): update error handling for methods to return errors directly Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): update function signatures to return values directly instead of response structs Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): update request/response types to use private naming conventions Signed-off-by: Deluan <deluan@navidrome.org> * build: mark .wasm files as intermediate for cleanup after building .ndp Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): consolidate PDK module path and update Go version to 1.25 Signed-off-by: Deluan <deluan@navidrome.org> * feat: implement Rust PDK Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): reorganize Rust output structure to follow standard conventions Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): update Discord Rich Presence and Library Inspector plugins to use nd-pdk for service calls and implement lifecycle management Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): update macro names for websocket and metadata registration to improve clarity and consistency Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): rename scheduler callback methods for consistency and clarity Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): update export wrappers to use `//go:wasmexport` for WebAssembly compatibility Signed-off-by: Deluan <deluan@navidrome.org> * docs: update plugin registration docs Signed-off-by: Deluan <deluan@navidrome.org> * fix(plugins): generate host wrappers Signed-off-by: Deluan <deluan@navidrome.org> * test(plugins): conditionally run goleak checks based on CI environment Signed-off-by: Deluan <deluan@navidrome.org> * docs: update README to reflect changes in plugin import paths Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): update plugin instance creation to accept context for cancellation support Signed-off-by: Deluan <deluan@navidrome.org> * fix(plugins): update return types in metadata interfaces to use pointers Signed-off-by: Deluan <deluan@navidrome.org> * fix(plugins): enhance type handling for Rust and XTP output in capability generation Signed-off-by: Deluan <deluan@navidrome.org> * fix(plugins): update IsAuthorized method to return boolean instead of response object Signed-off-by: Deluan <deluan@navidrome.org> * test(plugins): add unit tests for rustOutputType and isPrimitiveRustType functions Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): implement XTP JSONSchema validation for generated schemas Signed-off-by: Deluan <deluan@navidrome.org> * fix(plugins): update response types in testMetadataAgent methods to use pointers Signed-off-by: Deluan <deluan@navidrome.org> * docs: update Go and Rust plugin developer sections for clarity Signed-off-by: Deluan <deluan@navidrome.org> * docs: correct example link for library inspector in README Signed-off-by: Deluan <deluan@navidrome.org> * docs: clarify artwork URL generation capabilities in service descriptions Signed-off-by: Deluan <deluan@navidrome.org> * docs: update README to include Rust PDK crate information for plugin developers Signed-off-by: Deluan <deluan@navidrome.org> * fix: handle URL parsing errors and use atomic upsert in plugin repository Added proper error handling for url.Parse calls in PublicURL and AbsoluteURL functions. When parsing fails, PublicURL now falls back to AbsoluteURL, and AbsoluteURL logs the error and returns an empty string, preventing malformed URLs from being generated. Replaced the non-atomic UPDATE-then-INSERT pattern in plugin repository Put method with a single atomic INSERT ... ON CONFLICT statement. This eliminates potential race conditions and improves consistency with the upsert pattern already used in host_kvstore.go. * feat: implement mock service instances for non-WASM builds using testify/mock Signed-off-by: Deluan <deluan@navidrome.org> * refactor: Discord RPC struct to encapsulate WebSocket logic Signed-off-by: Deluan <deluan@navidrome.org> * feat: add support for experimental WebAssembly threads Signed-off-by: Deluan <deluan@navidrome.org> * feat: add PDK abstraction layer with mock support for non-WASM builds Signed-off-by: Deluan <deluan@navidrome.org> * feat: add unit tests for Discord plugin and RPC functionality Signed-off-by: Deluan <deluan@navidrome.org> * fix: update return types in minimalPlugin and wikimediaPlugin methods to use pointers Signed-off-by: Deluan <deluan@navidrome.org> * fix: context cancellation and implement WebSocket callback timeout for improved error handling Signed-off-by: Deluan <deluan@navidrome.org> * feat: conditionally include error handling in generated client code templates Signed-off-by: Deluan <deluan@navidrome.org> * feat: implement ConfigService for plugin configuration management Signed-off-by: Deluan <deluan@navidrome.org> * feat: enhance plugin manager to support metrics recording Signed-off-by: Deluan <deluan@navidrome.org> * refactor: make MockPDK private Signed-off-by: Deluan <deluan@navidrome.org> * refactor: update interface types to use 'any' in plugin repository methods Signed-off-by: Deluan <deluan@navidrome.org> * refactor: rename List method to Keys for clarity in configuration management Signed-off-by: Deluan <deluan@navidrome.org> * test: add ndpgen plugin tests in the pipeline and update Makefile Signed-off-by: Deluan <deluan@navidrome.org> * feat: add users permission management to plugin system Signed-off-by: Deluan <deluan@navidrome.org> * refactor: streamline users integration tests and enhance plugin user management Signed-off-by: Deluan <deluan@navidrome.org> * refactor: remove UserID from scrobbler request structure Signed-off-by: Deluan <deluan@navidrome.org> * test: add integration tests for UsersService enable gate behavior Signed-off-by: Deluan <deluan@navidrome.org> * feat: implement user permissions for SubsonicAPI and scrobbler plugins Signed-off-by: Deluan <deluan@navidrome.org> * fix: show proper error in the UI when enabling a plugin fails Signed-off-by: Deluan <deluan@navidrome.org> * feat: add library permission management to plugin system Signed-off-by: Deluan <deluan@navidrome.org> * feat: add user permission for processing scrobbles in Discord Rich Presence plugin Signed-off-by: Deluan <deluan@navidrome.org> * fix: implement dynamic loading for buffered scrobbler plugins Signed-off-by: Deluan <deluan@navidrome.org> * feat: add GetAdmins method to retrieve admin users from the plugin Signed-off-by: Deluan <deluan@navidrome.org> * feat: update Portuguese translations for user and library permissions Signed-off-by: Deluan <deluan@navidrome.org> * reorder migrations Signed-off-by: Deluan <deluan@navidrome.org> * fix: remove unnecessary bulkActionButtons prop from PluginList component * feat: add manual plugin rescan functionality and corresponding UI action Signed-off-by: Deluan <deluan@navidrome.org> * feat: implement user/library and plugin management integration with cleanup on deletion Signed-off-by: Deluan <deluan@navidrome.org> * feat: replace core mock services with test-specific implementations to avoid import cycles * feat: add ID fields to Artist and Song structs and enhance track loading logic by prioritizing ID matches Signed-off-by: Deluan <deluan@navidrome.org> * feat: update plugin permissions from allowedHosts to requiredHosts for better clarity and consistency * feat: refactor plugin host permissions to use RequiredHosts directly for improved clarity * fix: don't record metrics for plugin calls that aren't implemented at all Signed-off-by: Deluan <deluan@navidrome.org> * fix: enhance connection management with improved error handling and cleanup logic Signed-off-by: Deluan <deluan@navidrome.org> * feat: introduce ArtistRef struct for better artist representation and update track metadata handling Signed-off-by: Deluan <deluan@navidrome.org> * feat: update user configuration handling to use user key prefix for improved clarity Signed-off-by: Deluan <deluan@navidrome.org> * feat: enhance ConfigCard input fields with multiline support and vertical resizing Signed-off-by: Deluan <deluan@navidrome.org> * fix: rust plugin compilation error Signed-off-by: Deluan <deluan@navidrome.org> * feat: implement IsOptionPattern method for better return type handling in Rust PDK generation Signed-off-by: Deluan <deluan@navidrome.org> --------- Signed-off-by: Deluan <deluan@navidrome.org>
This commit is contained in:
Deluan Quintão
+164
-287
@@ -3,336 +3,213 @@ package plugins
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"maps"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
gonanoid "github.com/matoous/go-nanoid/v2"
|
||||
"github.com/navidrome/navidrome/log"
|
||||
"github.com/navidrome/navidrome/plugins/host/scheduler"
|
||||
navidsched "github.com/navidrome/navidrome/scheduler"
|
||||
"github.com/navidrome/navidrome/model/id"
|
||||
"github.com/navidrome/navidrome/plugins/capabilities"
|
||||
"github.com/navidrome/navidrome/plugins/host"
|
||||
"github.com/navidrome/navidrome/scheduler"
|
||||
)
|
||||
|
||||
const (
|
||||
ScheduleTypeOneTime = "one-time"
|
||||
ScheduleTypeRecurring = "recurring"
|
||||
)
|
||||
// CapabilityScheduler indicates the plugin can receive scheduled event callbacks.
|
||||
// Detected when the plugin exports the scheduler callback function.
|
||||
const CapabilityScheduler Capability = "Scheduler"
|
||||
|
||||
// ScheduledCallback represents a registered schedule callback
|
||||
type ScheduledCallback struct {
|
||||
ID string
|
||||
PluginID string
|
||||
Type string // "one-time" or "recurring"
|
||||
Payload []byte
|
||||
EntryID int // Used for recurring schedules via the scheduler
|
||||
Cancel context.CancelFunc // Used for one-time schedules
|
||||
const FuncSchedulerCallback = "nd_scheduler_callback"
|
||||
|
||||
func init() {
|
||||
registerCapability(
|
||||
CapabilityScheduler,
|
||||
FuncSchedulerCallback,
|
||||
)
|
||||
}
|
||||
|
||||
// SchedulerHostFunctions implements the scheduler.SchedulerService interface
|
||||
type SchedulerHostFunctions struct {
|
||||
ss *schedulerService
|
||||
pluginID string
|
||||
// timeAfterFunc is a variable for time.AfterFunc, allowing tests to override it.
|
||||
var timeAfterFunc = time.AfterFunc
|
||||
|
||||
// scheduleEntry stores metadata about a scheduled task.
|
||||
type scheduleEntry struct {
|
||||
pluginName string
|
||||
payload string
|
||||
isRecurring bool
|
||||
entryID int // Internal scheduler entry ID (for recurring tasks)
|
||||
timer *time.Timer // Timer for one-time tasks (nil for recurring)
|
||||
}
|
||||
|
||||
func (s SchedulerHostFunctions) ScheduleOneTime(ctx context.Context, req *scheduler.ScheduleOneTimeRequest) (*scheduler.ScheduleResponse, error) {
|
||||
return s.ss.scheduleOneTime(ctx, s.pluginID, req)
|
||||
// schedulerServiceImpl implements host.SchedulerService.
|
||||
// It provides plugins with scheduling capabilities and invokes callbacks when schedules fire.
|
||||
type schedulerServiceImpl struct {
|
||||
pluginName string
|
||||
manager *Manager
|
||||
scheduler scheduler.Scheduler
|
||||
|
||||
mu sync.Mutex
|
||||
schedules map[string]*scheduleEntry
|
||||
}
|
||||
|
||||
func (s SchedulerHostFunctions) ScheduleRecurring(ctx context.Context, req *scheduler.ScheduleRecurringRequest) (*scheduler.ScheduleResponse, error) {
|
||||
return s.ss.scheduleRecurring(ctx, s.pluginID, req)
|
||||
}
|
||||
|
||||
func (s SchedulerHostFunctions) CancelSchedule(ctx context.Context, req *scheduler.CancelRequest) (*scheduler.CancelResponse, error) {
|
||||
return s.ss.cancelSchedule(ctx, s.pluginID, req)
|
||||
}
|
||||
|
||||
func (s SchedulerHostFunctions) TimeNow(ctx context.Context, req *scheduler.TimeNowRequest) (*scheduler.TimeNowResponse, error) {
|
||||
return s.ss.timeNow(ctx, req)
|
||||
}
|
||||
|
||||
type schedulerService struct {
|
||||
// Map of schedule IDs to their callback info
|
||||
schedules map[string]*ScheduledCallback
|
||||
manager *managerImpl
|
||||
navidSched navidsched.Scheduler // Navidrome scheduler for recurring jobs
|
||||
mu sync.Mutex
|
||||
}
|
||||
|
||||
// newSchedulerService creates a new schedulerService instance
|
||||
func newSchedulerService(manager *managerImpl) *schedulerService {
|
||||
return &schedulerService{
|
||||
schedules: make(map[string]*ScheduledCallback),
|
||||
// newSchedulerService creates a new SchedulerService for a plugin.
|
||||
func newSchedulerService(pluginName string, manager *Manager, sched scheduler.Scheduler) *schedulerServiceImpl {
|
||||
return &schedulerServiceImpl{
|
||||
pluginName: pluginName,
|
||||
manager: manager,
|
||||
navidSched: navidsched.GetInstance(),
|
||||
scheduler: sched,
|
||||
schedules: make(map[string]*scheduleEntry),
|
||||
}
|
||||
}
|
||||
|
||||
func (s *schedulerService) HostFunctions(pluginID string) SchedulerHostFunctions {
|
||||
return SchedulerHostFunctions{
|
||||
ss: s,
|
||||
pluginID: pluginID,
|
||||
}
|
||||
}
|
||||
|
||||
// Safe accessor methods for tests
|
||||
|
||||
// hasSchedule safely checks if a schedule exists
|
||||
func (s *schedulerService) hasSchedule(id string) bool {
|
||||
s.mu.Lock()
|
||||
defer s.mu.Unlock()
|
||||
_, exists := s.schedules[id]
|
||||
return exists
|
||||
}
|
||||
|
||||
// scheduleCount safely returns the number of schedules
|
||||
func (s *schedulerService) scheduleCount() int {
|
||||
s.mu.Lock()
|
||||
defer s.mu.Unlock()
|
||||
return len(s.schedules)
|
||||
}
|
||||
|
||||
// getScheduleType safely returns the type of a schedule
|
||||
func (s *schedulerService) getScheduleType(id string) string {
|
||||
s.mu.Lock()
|
||||
defer s.mu.Unlock()
|
||||
if cb, exists := s.schedules[id]; exists {
|
||||
return cb.Type
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
// scheduleJob is a helper function that handles the common logic for scheduling jobs
|
||||
func (s *schedulerService) scheduleJob(pluginID string, scheduleId string, jobType string, payload []byte) (string, *ScheduledCallback, context.CancelFunc, error) {
|
||||
if s.manager == nil {
|
||||
return "", nil, nil, fmt.Errorf("scheduler service not properly initialized")
|
||||
func (s *schedulerServiceImpl) ScheduleOneTime(ctx context.Context, delaySeconds int32, payload string, scheduleID string) (string, error) {
|
||||
if scheduleID == "" {
|
||||
scheduleID = id.NewRandom()
|
||||
}
|
||||
|
||||
// Original scheduleId (what the plugin will see)
|
||||
originalScheduleId := scheduleId
|
||||
if originalScheduleId == "" {
|
||||
// Generate a random ID if one wasn't provided
|
||||
originalScheduleId, _ = gonanoid.New(10)
|
||||
}
|
||||
|
||||
// Internal scheduleId (prefixed with plugin name to avoid conflicts)
|
||||
internalScheduleId := pluginID + ":" + originalScheduleId
|
||||
|
||||
// Store any existing cancellation function to call after we've updated the map
|
||||
var cancelExisting context.CancelFunc
|
||||
|
||||
// Check if there's an existing schedule with the same ID, we'll cancel it after updating the map
|
||||
if existingSchedule, ok := s.schedules[internalScheduleId]; ok {
|
||||
log.Debug("Replacing existing schedule with same ID", "plugin", pluginID, "scheduleID", originalScheduleId)
|
||||
|
||||
// Store cancel information but don't call it yet
|
||||
if existingSchedule.Type == ScheduleTypeOneTime && existingSchedule.Cancel != nil {
|
||||
// We'll set the Cancel to nil to prevent the old job from removing the new one
|
||||
cancelExisting = existingSchedule.Cancel
|
||||
existingSchedule.Cancel = nil
|
||||
} else if existingSchedule.Type == ScheduleTypeRecurring {
|
||||
existingRecurringEntryID := existingSchedule.EntryID
|
||||
if existingRecurringEntryID != 0 {
|
||||
s.navidSched.Remove(existingRecurringEntryID)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Create the callback object
|
||||
callback := &ScheduledCallback{
|
||||
ID: originalScheduleId,
|
||||
PluginID: pluginID,
|
||||
Type: jobType,
|
||||
Payload: payload,
|
||||
}
|
||||
|
||||
return internalScheduleId, callback, cancelExisting, nil
|
||||
}
|
||||
|
||||
// scheduleOneTime registers a new one-time scheduled job
|
||||
func (s *schedulerService) scheduleOneTime(_ context.Context, pluginID string, req *scheduler.ScheduleOneTimeRequest) (*scheduler.ScheduleResponse, error) {
|
||||
s.mu.Lock()
|
||||
defer s.mu.Unlock()
|
||||
|
||||
internalScheduleId, callback, cancelExisting, err := s.scheduleJob(pluginID, req.ScheduleId, ScheduleTypeOneTime, req.Payload)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
if _, exists := s.schedules[scheduleID]; exists {
|
||||
return "", fmt.Errorf("schedule ID %q already exists", scheduleID)
|
||||
}
|
||||
|
||||
// Create a context with cancel for this one-time schedule
|
||||
scheduleCtx, cancel := context.WithCancel(context.Background())
|
||||
callback.Cancel = cancel
|
||||
|
||||
// Store the callback info
|
||||
s.schedules[internalScheduleId] = callback
|
||||
|
||||
// Now that the new job is in the map, we can safely cancel the old one
|
||||
if cancelExisting != nil {
|
||||
// Cancel in a goroutine to avoid deadlock since we're already holding the lock
|
||||
go cancelExisting()
|
||||
}
|
||||
|
||||
log.Debug("One-time schedule registered", "plugin", pluginID, "scheduleID", callback.ID, "internalID", internalScheduleId)
|
||||
|
||||
// Start the timer goroutine with the internal ID
|
||||
go s.runOneTimeSchedule(scheduleCtx, internalScheduleId, time.Duration(req.DelaySeconds)*time.Second)
|
||||
|
||||
// Return the original ID to the plugin
|
||||
return &scheduler.ScheduleResponse{
|
||||
ScheduleId: callback.ID,
|
||||
}, nil
|
||||
}
|
||||
|
||||
// scheduleRecurring registers a new recurring scheduled job
|
||||
func (s *schedulerService) scheduleRecurring(_ context.Context, pluginID string, req *scheduler.ScheduleRecurringRequest) (*scheduler.ScheduleResponse, error) {
|
||||
s.mu.Lock()
|
||||
defer s.mu.Unlock()
|
||||
|
||||
internalScheduleId, callback, cancelExisting, err := s.scheduleJob(pluginID, req.ScheduleId, ScheduleTypeRecurring, req.Payload)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// Schedule the job with the Navidrome scheduler
|
||||
entryID, err := s.navidSched.Add(req.CronExpression, func() {
|
||||
s.executeCallback(context.Background(), internalScheduleId, true)
|
||||
capturedID := scheduleID
|
||||
timer := timeAfterFunc(time.Duration(delaySeconds)*time.Second, func() {
|
||||
s.invokeCallback(context.Background(), capturedID)
|
||||
// Clean up the entry after firing
|
||||
s.mu.Lock()
|
||||
delete(s.schedules, capturedID)
|
||||
s.mu.Unlock()
|
||||
})
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to schedule recurring job: %w", err)
|
||||
|
||||
s.schedules[scheduleID] = &scheduleEntry{
|
||||
pluginName: s.pluginName,
|
||||
payload: payload,
|
||||
isRecurring: false,
|
||||
timer: timer,
|
||||
}
|
||||
|
||||
// Store the entry ID so we can cancel it later
|
||||
callback.EntryID = entryID
|
||||
|
||||
// Store the callback info
|
||||
s.schedules[internalScheduleId] = callback
|
||||
|
||||
// Now that the new job is in the map, we can safely cancel the old one
|
||||
if cancelExisting != nil {
|
||||
// Cancel in a goroutine to avoid deadlock since we're already holding the lock
|
||||
go cancelExisting()
|
||||
}
|
||||
|
||||
log.Debug("Recurring schedule registered", "plugin", pluginID, "scheduleID", callback.ID, "internalID", internalScheduleId, "cron", req.CronExpression)
|
||||
|
||||
// Return the original ID to the plugin
|
||||
return &scheduler.ScheduleResponse{
|
||||
ScheduleId: callback.ID,
|
||||
}, nil
|
||||
log.Debug(ctx, "Scheduled one-time task", "plugin", s.pluginName, "scheduleID", scheduleID, "delaySeconds", delaySeconds)
|
||||
return scheduleID, nil
|
||||
}
|
||||
|
||||
// cancelSchedule cancels a scheduled job (either one-time or recurring)
|
||||
func (s *schedulerService) cancelSchedule(_ context.Context, pluginID string, req *scheduler.CancelRequest) (*scheduler.CancelResponse, error) {
|
||||
func (s *schedulerServiceImpl) ScheduleRecurring(ctx context.Context, cronExpression string, payload string, scheduleID string) (string, error) {
|
||||
if scheduleID == "" {
|
||||
scheduleID = id.NewRandom()
|
||||
}
|
||||
|
||||
capturedID := scheduleID
|
||||
callback := func() {
|
||||
s.invokeCallback(context.Background(), capturedID)
|
||||
}
|
||||
|
||||
s.mu.Lock()
|
||||
defer s.mu.Unlock()
|
||||
|
||||
internalScheduleId := pluginID + ":" + req.ScheduleId
|
||||
callback, exists := s.schedules[internalScheduleId]
|
||||
if !exists {
|
||||
return &scheduler.CancelResponse{
|
||||
Success: false,
|
||||
Error: "schedule not found",
|
||||
}, nil
|
||||
if _, exists := s.schedules[scheduleID]; exists {
|
||||
return "", fmt.Errorf("schedule ID %q already exists", scheduleID)
|
||||
}
|
||||
|
||||
// Store the cancel functions to call after we've updated the schedule map
|
||||
var cancelFunc context.CancelFunc
|
||||
var recurringEntryID int
|
||||
|
||||
// Store cancel information but don't call it yet
|
||||
if callback.Type == ScheduleTypeOneTime && callback.Cancel != nil {
|
||||
cancelFunc = callback.Cancel
|
||||
callback.Cancel = nil // Set to nil to prevent the cancel handler from removing the job
|
||||
} else if callback.Type == ScheduleTypeRecurring {
|
||||
recurringEntryID = callback.EntryID
|
||||
entryID, err := s.scheduler.Add(cronExpression, callback)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to schedule task: %w", err)
|
||||
}
|
||||
|
||||
// First remove from the map
|
||||
delete(s.schedules, internalScheduleId)
|
||||
|
||||
// Now perform the cancellation safely
|
||||
if cancelFunc != nil {
|
||||
// Execute in a goroutine to avoid deadlock since we're already holding the lock
|
||||
go cancelFunc()
|
||||
}
|
||||
if recurringEntryID != 0 {
|
||||
s.navidSched.Remove(recurringEntryID)
|
||||
s.schedules[scheduleID] = &scheduleEntry{
|
||||
pluginName: s.pluginName,
|
||||
payload: payload,
|
||||
isRecurring: true,
|
||||
entryID: entryID,
|
||||
}
|
||||
|
||||
log.Debug("Schedule canceled", "plugin", pluginID, "scheduleID", req.ScheduleId, "internalID", internalScheduleId, "type", callback.Type)
|
||||
|
||||
return &scheduler.CancelResponse{
|
||||
Success: true,
|
||||
}, nil
|
||||
log.Debug(ctx, "Scheduled recurring task", "plugin", s.pluginName, "scheduleID", scheduleID, "cron", cronExpression)
|
||||
return scheduleID, nil
|
||||
}
|
||||
|
||||
// timeNow returns the current time in multiple formats
|
||||
func (s *schedulerService) timeNow(_ context.Context, req *scheduler.TimeNowRequest) (*scheduler.TimeNowResponse, error) {
|
||||
now := time.Now()
|
||||
|
||||
return &scheduler.TimeNowResponse{
|
||||
Rfc3339Nano: now.Format(time.RFC3339Nano),
|
||||
UnixMilli: now.UnixMilli(),
|
||||
LocalTimeZone: now.Location().String(),
|
||||
}, nil
|
||||
}
|
||||
|
||||
// runOneTimeSchedule handles the one-time schedule execution and callback
|
||||
func (s *schedulerService) runOneTimeSchedule(ctx context.Context, internalScheduleId string, delay time.Duration) {
|
||||
tmr := time.NewTimer(delay)
|
||||
defer tmr.Stop()
|
||||
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
// Schedule was cancelled via its context
|
||||
// We're no longer removing the schedule here because that's handled by the code that
|
||||
// cancelled the context
|
||||
log.Debug("One-time schedule context canceled", "internalID", internalScheduleId)
|
||||
return
|
||||
|
||||
case <-tmr.C:
|
||||
// Timer fired, execute the callback
|
||||
s.executeCallback(ctx, internalScheduleId, false)
|
||||
}
|
||||
}
|
||||
|
||||
// executeCallback calls the plugin's OnSchedulerCallback method
|
||||
func (s *schedulerService) executeCallback(ctx context.Context, internalScheduleId string, isRecurring bool) {
|
||||
func (s *schedulerServiceImpl) CancelSchedule(ctx context.Context, scheduleID string) error {
|
||||
s.mu.Lock()
|
||||
callback := s.schedules[internalScheduleId]
|
||||
// Only remove one-time schedules from the map after execution
|
||||
if callback != nil && callback.Type == ScheduleTypeOneTime {
|
||||
delete(s.schedules, internalScheduleId)
|
||||
entry, exists := s.schedules[scheduleID]
|
||||
if !exists {
|
||||
s.mu.Unlock()
|
||||
return fmt.Errorf("schedule ID %q not found", scheduleID)
|
||||
}
|
||||
delete(s.schedules, scheduleID)
|
||||
s.mu.Unlock()
|
||||
|
||||
if callback == nil {
|
||||
log.Error("Schedule not found for callback", "internalID", internalScheduleId)
|
||||
return
|
||||
if entry.timer != nil {
|
||||
entry.timer.Stop()
|
||||
} else {
|
||||
s.scheduler.Remove(entry.entryID)
|
||||
}
|
||||
|
||||
ctx = log.NewContext(ctx, "plugin", callback.PluginID, "scheduleID", callback.ID, "type", callback.Type)
|
||||
log.Debug("Executing schedule callback")
|
||||
start := time.Now()
|
||||
|
||||
// Get the plugin
|
||||
p := s.manager.LoadPlugin(callback.PluginID, CapabilitySchedulerCallback)
|
||||
if p == nil {
|
||||
log.Error("Plugin not found for callback", "plugin", callback.PluginID)
|
||||
return
|
||||
}
|
||||
|
||||
// Type-check the plugin
|
||||
plugin, ok := p.(*wasmSchedulerCallback)
|
||||
if !ok {
|
||||
log.Error("Plugin does not implement SchedulerCallback", "plugin", callback.PluginID)
|
||||
return
|
||||
}
|
||||
|
||||
// Call the plugin's OnSchedulerCallback method
|
||||
log.Trace(ctx, "Executing schedule callback")
|
||||
err := plugin.OnSchedulerCallback(ctx, callback.ID, callback.Payload, isRecurring)
|
||||
if err != nil {
|
||||
log.Error("Error executing schedule callback", "elapsed", time.Since(start), err)
|
||||
return
|
||||
}
|
||||
log.Debug("Schedule callback executed", "elapsed", time.Since(start))
|
||||
log.Debug(ctx, "Cancelled schedule", "plugin", s.pluginName, "scheduleID", scheduleID)
|
||||
return nil
|
||||
}
|
||||
|
||||
// Close cancels all schedules for this plugin.
|
||||
// This is called when the plugin is unloaded.
|
||||
func (s *schedulerServiceImpl) Close() error {
|
||||
s.mu.Lock()
|
||||
schedules := maps.Clone(s.schedules)
|
||||
s.schedules = make(map[string]*scheduleEntry)
|
||||
s.mu.Unlock()
|
||||
|
||||
for scheduleID, entry := range schedules {
|
||||
if entry.timer != nil {
|
||||
entry.timer.Stop()
|
||||
} else {
|
||||
s.scheduler.Remove(entry.entryID)
|
||||
}
|
||||
log.Debug("Cancelled schedule on plugin unload", "plugin", s.pluginName, "scheduleID", scheduleID)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// invokeCallback calls the plugin's nd_scheduler_callback function.
|
||||
func (s *schedulerServiceImpl) invokeCallback(ctx context.Context, scheduleID string) {
|
||||
log.Debug(ctx, "Scheduler callback invoked", "plugin", s.pluginName, "scheduleID", scheduleID)
|
||||
|
||||
s.mu.Lock()
|
||||
entry, exists := s.schedules[scheduleID]
|
||||
if !exists {
|
||||
s.mu.Unlock()
|
||||
log.Warn(ctx, "Schedule entry not found during callback", "plugin", s.pluginName, "scheduleID", scheduleID)
|
||||
return
|
||||
}
|
||||
payload := entry.payload
|
||||
isRecurring := entry.isRecurring
|
||||
s.mu.Unlock()
|
||||
|
||||
// Get the plugin instance from the manager
|
||||
s.manager.mu.RLock()
|
||||
instance, ok := s.manager.plugins[s.pluginName]
|
||||
s.manager.mu.RUnlock()
|
||||
|
||||
if !ok {
|
||||
log.Warn(ctx, "Plugin not loaded when scheduler callback fired", "plugin", s.pluginName, "scheduleID", scheduleID)
|
||||
return
|
||||
}
|
||||
|
||||
// Check if plugin has the scheduler capability
|
||||
if !hasCapability(instance.capabilities, CapabilityScheduler) {
|
||||
log.Warn(ctx, "Plugin does not have scheduler capability", "plugin", s.pluginName, "scheduleID", scheduleID)
|
||||
return
|
||||
}
|
||||
|
||||
// Prepare callback input
|
||||
input := capabilities.SchedulerCallbackRequest{
|
||||
ScheduleID: scheduleID,
|
||||
Payload: payload,
|
||||
IsRecurring: isRecurring,
|
||||
}
|
||||
|
||||
start := time.Now()
|
||||
err := callPluginFunctionNoOutput(ctx, instance, FuncSchedulerCallback, input)
|
||||
if err != nil {
|
||||
log.Error(ctx, "Scheduler callback failed", "plugin", s.pluginName, "scheduleID", scheduleID, "duration", time.Since(start), err)
|
||||
return
|
||||
}
|
||||
|
||||
log.Debug(ctx, "Scheduler callback completed", "plugin", s.pluginName, "scheduleID", scheduleID, "duration", time.Since(start))
|
||||
}
|
||||
|
||||
// Verify interface implementation
|
||||
var _ host.SchedulerService = (*schedulerServiceImpl)(nil)
|
||||
|
||||
Reference in New Issue
Block a user