Files
Deluan QuintãoandGitHub 03a45753e9 feat(plugins): New Plugin System with multi-language PDK support (#4833)
* chore(plugins): remove the old plugins system implementation

Signed-off-by: Deluan <[email protected]>

* feat(plugins): implement new plugin system with using Extism

Signed-off-by: Deluan <[email protected]>

* feat(plugins): add capability detection for plugins based on exported functions

Signed-off-by: Deluan <[email protected]>

* feat(plugins): add auto-reload functionality for plugins with file watcher support

Signed-off-by: Deluan <[email protected]>

* feat(plugins): add auto-reload functionality for plugins with file watcher support

Signed-off-by: Deluan <[email protected]>

* refactor(plugins): standardize variable names and remove superfluous wrapper functions

Signed-off-by: Deluan <[email protected]>

* fix(plugins): improve error handling and logging in plugin manager

Signed-off-by: Deluan <[email protected]>

* refactor(plugins): implement plugin function call helper and refactor MetadataAgent methods

Signed-off-by: Deluan <[email protected]>

* fix(plugins): race condition in plugin manager

* tests(plugins): change BeforeEach to BeforeAll in MetadataAgent tests

Signed-off-by: Deluan <[email protected]>

* tests(plugins): optimize tests

Signed-off-by: Deluan <[email protected]>

* tests(plugins): more optimizations

Signed-off-by: Deluan <[email protected]>

* test(plugins): ignore goroutine leaks from notify library in tests

Signed-off-by: Deluan <[email protected]>

* feat(plugins): add Wikimedia plugin for Navidrome to fetch artist metadata

Signed-off-by: Deluan <[email protected]>

* feat(plugins): enhance plugin logging and set User-Agent header

Signed-off-by: Deluan <[email protected]>

* feat(plugins): implement scrobbler plugin with authorization and scrobbling capabilities

Signed-off-by: Deluan <[email protected]>

* feat(plugins): integrate logs

Signed-off-by: Deluan <[email protected]>

* refactor(plugins): clean up manifest struct and improve plugin loading logic

Signed-off-by: Deluan <[email protected]>

* feat(plugins): add metadata agent and scrobbler schemas for bootstrapping plugins

Signed-off-by: Deluan <[email protected]>

* 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 <[email protected]>

* feat(plugins): implement SubsonicAPI host function integration with permissions

Signed-off-by: Deluan <[email protected]>

* fix(generator): error-only methods in response handling

Signed-off-by: Deluan <[email protected]>

* feat(plugins): generate client wrappers for host functions

Signed-off-by: Deluan <[email protected]>

* refactor(generator): remove error handling for response.Error in client templates

Signed-off-by: Deluan <[email protected]>

* 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 <[email protected]>

* feat(scheduler): implement Scheduler service with one-time and recurring scheduling capabilities

Signed-off-by: Deluan <[email protected]>

* refactor(manifest): remove unused ConfigPermission from permissions schema

Signed-off-by: Deluan <[email protected]>

* feat(scheduler): add scheduler callback schema and implementation for plugins

Signed-off-by: Deluan <[email protected]>

* refactor(scheduler): streamline scheduling logic and remove unused callback tracking

Signed-off-by: Deluan <[email protected]>

* refactor(scheduler): add Close method for resource cleanup on plugin unload

Signed-off-by: Deluan <[email protected]>

* docs(scheduler): clarify SchedulerCallback requirement for scheduling functions

Signed-off-by: Deluan <[email protected]>

* fix: update wasm build rule to include all Go files in the directory

Signed-off-by: Deluan <[email protected]>

* feat: rewrite the wikimedia plugin using the XTP CLI

Signed-off-by: Deluan <[email protected]>

* refactor(scheduler): replace uuid with id.NewRandom for schedule ID generation

Signed-off-by: Deluan <[email protected]>

* refactor: capabilities registration

Signed-off-by: Deluan <[email protected]>

* test: add scheduler service isolation test for plugin instances

Signed-off-by: Deluan <[email protected]>

* refactor: update plugin manager initialization and encapsulate logic

Signed-off-by: Deluan <[email protected]>

* feat: add WebSocket service definitions for plugin communication

Signed-off-by: Deluan <[email protected]>

* feat: implement WebSocket service for plugin integration and connection management

Signed-off-by: Deluan <[email protected]>

* 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 <[email protected]>

* fix: use context.Background() in invokeCallback for scheduled tasks

Signed-off-by: Deluan <[email protected]>

* refactor: rename plugin.create() to plugin.instance()

Signed-off-by: Deluan <[email protected]>

* refactor: rename pluginInstance to plugin for consistency across the codebase

Signed-off-by: Deluan <[email protected]>

* refactor: simplify schedule cloning in Close method and enhance plugin cleanup error handling

Signed-off-by: Deluan <[email protected]>

* feat: implement Artwork service for generating artwork URLs in Navidrome plugins - WIP

Signed-off-by: Deluan <[email protected]>

* refactor: moved public URL builders to avoid import cycles

Signed-off-by: Deluan <[email protected]>

* feat: add Cache service for in-memory TTL-based caching in plugins

Signed-off-by: Deluan <[email protected]>

* feat: add Discord Rich Presence example plugin for Navidrome integration

Signed-off-by: Deluan <[email protected]>

* 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 <[email protected]>

* feat: add help target to Makefile for plugin usage instructions

Signed-off-by: Deluan <[email protected]>

* feat: add Cover Art Archive plugin as an example of Python plugin

Signed-off-by: Deluan <[email protected]>

* feat: update Makefile and README to clarify Go plugin usage

Signed-off-by: Deluan <[email protected]>

* feat: include plugin capabilities in loading log message

Signed-off-by: Deluan <[email protected]>

* feat: add trace logging for plugin availability and error handling in agents

Signed-off-by: Deluan <[email protected]>

* feat: add Now Playing Logger plugin to showcase calling host functions from Python plugins

Signed-off-by: Deluan <[email protected]>

* feat: generate Python client wrappers for various host services

Signed-off-by: Deluan <[email protected]>

* feat: add generated host function wrappers for Scheduler and SubsonicAPI services

Signed-off-by: Deluan <[email protected]>

* feat: update Python plugin documentation and usage instructions for host function wrappers

Signed-off-by: Deluan <[email protected]>

* feat: add Webhook Scrobbler plugin in Rust to send HTTP notifications on scrobble events

Signed-off-by: Deluan <[email protected]>

* feat: enable parallel loading of plugins during startup

Signed-off-by: Deluan <[email protected]>

* docs: update README to include WebSocket callback schema in plugin documentation

Signed-off-by: Deluan <[email protected]>

* feat: extend plugin watcher with improved logging and debounce duration adjustment

Signed-off-by: Deluan <[email protected]>

* add trace message for plugin recompiles

Signed-off-by: Deluan <[email protected]>

* feat: implement plugin cache purging functionality

Signed-off-by: Deluan <[email protected]>

* test: move purgeCacheBySize unit tests

Signed-off-by: Deluan <[email protected]>

* feat(plugins UI): add plugin repository and database support

Signed-off-by: Deluan <[email protected]>

* feat(plugins UI): add plugin management routes and middleware

Signed-off-by: Deluan <[email protected]>

* feat(plugins UI): implement plugin synchronization with database for add, update, and remove actions

Signed-off-by: Deluan <[email protected]>

* feat(plugins UI): add PluginList and PluginShow components with plugin management functionality

Signed-off-by: Deluan <[email protected]>

* feat(plugins): optimize plugin change detection

Signed-off-by: Deluan <[email protected]>

* refactor(plugins UI): improve PluginList structure

Signed-off-by: Deluan <[email protected]>

* feat(plugins UI): enhance PluginShow with author, website, and permissions display

Signed-off-by: Deluan <[email protected]>

* feat(plugins UI): refactor to use MUI and RA components

Signed-off-by: Deluan <[email protected]>

* feat(plugins UI): add error handling for plugin enable/disable actions

Signed-off-by: Deluan <[email protected]>

* refactor(plugins): inject PluginManager into native API

Signed-off-by: Deluan <[email protected]>

* refactor(plugins): update GetManager to accept DataStore parameter

Signed-off-by: Deluan <[email protected]>

* feat(plugins): add subsonicRouter to Manager and refactor host service registration

Signed-off-by: Deluan <[email protected]>

* refactor(plugins): enhance debug logging for plugin actions and recompile logic

Signed-off-by: Deluan <[email protected]>

* refactor(plugins): break manager.go into smaller, focused files

Signed-off-by: Deluan <[email protected]>

* refactor(plugins): streamline error handling and improve plugin retrieval logic

Signed-off-by: Deluan <[email protected]>

* refactor(plugins): update newWebSocketService to use WebSocketPermission for allowed hosts

Signed-off-by: Deluan <[email protected]>

* refactor(plugins): introduce ToggleEnabledSwitch for managing plugin enable/disable state

Signed-off-by: Deluan <[email protected]>

* docs: update READMEs

Signed-off-by: Deluan <[email protected]>

* feat(library): add Library service for metadata access and filesystem integration

Signed-off-by: Deluan <[email protected]>

* feat(plugins): add Library Inspector plugin for periodic library inspection and file size logging

Signed-off-by: Deluan <[email protected]>

* docs: update README to reflect JSON configuration format for plugins

Signed-off-by: Deluan <[email protected]>

* fix(build): update target to wasm32-wasip1 for improved WASI support

Signed-off-by: Deluan <[email protected]>

* feat(plugins): implement configuration management UI with key-value pairs support

Signed-off-by: Deluan <[email protected]>

* feat(ui): adjust grid layout in InfoRow component for improved responsiveness

Signed-off-by: Deluan <[email protected]>

* feat(plugins): rename ErrorIndicator to EnabledOrErrorField and enhance error handling logic

Signed-off-by: Deluan <[email protected]>

* feat(i18n): add Portuguese translations for plugin management and notifications

Signed-off-by: Deluan <[email protected]>

* feat(plugins): add support for .ndp plugin packages and update build process

Signed-off-by: Deluan <[email protected]>

* docs: update README for .ndp plugin packaging and installation instructions

Signed-off-by: Deluan <[email protected]>

* feat(plugins): implement KVStore service for persistent key-value storage

Signed-off-by: Deluan <[email protected]>

* docs: enhance README with Extism plugin development resources and recommendations

Signed-off-by: Deluan <[email protected]>

* feat(plugins): integrate event broker into plugin manager

Signed-off-by: Deluan <[email protected]>

* feat(plugins): update config handling in PluginShow to track last record state

Signed-off-by: Deluan <[email protected]>

* feat(plugins): add Rust host function library and example implementation of Discord Rich Presence plugin in Rust

Signed-off-by: Deluan <[email protected]>

* feat(plugins): generate Rust lib.rs file to expose host function wrappers

Signed-off-by: Deluan <[email protected]>

* refactor(plugins): update JSON field names to camelCase for consistency

Signed-off-by: Deluan <[email protected]>

* refactor: reduce cyclomatic complexity by refactoring main function

Signed-off-by: Deluan <[email protected]>

* feat(plugins): enhance Rust code generation with typed struct support and improved type handling

Signed-off-by: Deluan <[email protected]>

* feat(plugins): add Go client library with host function wrappers and documentation

Signed-off-by: Deluan <[email protected]>

* feat(plugins): generate Go client stubs for non-WASM platforms

Signed-off-by: Deluan <[email protected]>

* feat(plugins): update client template file names for consistency

Signed-off-by: Deluan <[email protected]>

* feat(plugins): add initial implementation of the Navidrome Plugin Development Kit code generator - Pahse 1

Signed-off-by: Deluan <[email protected]>

* feat(plugins): implementation of the Navidrome Plugin Development Kit with generated client wrappers and service interfaces - Phase 2

Signed-off-by: Deluan <[email protected]>

* feat(plugins): implementation of the Navidrome Plugin Development Kit with generated client wrappers and service interfaces - Phase 2 (2)

Signed-off-by: Deluan <[email protected]>

* feat(plugins): implementation of the Navidrome Plugin Development Kit with generated client wrappers and service interfaces - Phase 3

Signed-off-by: Deluan <[email protected]>

* feat(plugins): implementation of the Navidrome Plugin Development Kit with generated client wrappers and service interfaces - Phase 4

Signed-off-by: Deluan <[email protected]>

* feat(plugins): implementation of the Navidrome Plugin Development Kit with generated client wrappers and service interfaces - Phase 5

Signed-off-by: Deluan <[email protected]>

* refactor(plugins): consistent naming/types across PDK

Signed-off-by: Deluan <[email protected]>

* refactor(plugins): streamline plugin function signatures and error handling

Signed-off-by: Deluan <[email protected]>

* refactor(plugins): update scrobbler interface to return errors directly instead of response structs

Signed-off-by: Deluan <[email protected]>

* test: make all test plugins use the PDK

Signed-off-by: Deluan <[email protected]>

* refactor(plugins): reorganize and sort type definitions for consistency

Signed-off-by: Deluan <[email protected]>

* refactor(plugins): update error handling for methods to return errors directly

Signed-off-by: Deluan <[email protected]>

* refactor(plugins): update function signatures to return values directly instead of response structs

Signed-off-by: Deluan <[email protected]>

* refactor(plugins): update request/response types to use private naming conventions

Signed-off-by: Deluan <[email protected]>

* build: mark .wasm files as intermediate for cleanup after building .ndp

Signed-off-by: Deluan <[email protected]>

* refactor(plugins): consolidate PDK module path and update Go version to 1.25

Signed-off-by: Deluan <[email protected]>

* feat: implement Rust PDK

Signed-off-by: Deluan <[email protected]>

* refactor(plugins): reorganize Rust output structure to follow standard conventions

Signed-off-by: Deluan <[email protected]>

* 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 <[email protected]>

* refactor(plugins): update macro names for websocket and metadata registration to improve clarity and consistency

Signed-off-by: Deluan <[email protected]>

* refactor(plugins): rename scheduler callback methods for consistency and clarity

Signed-off-by: Deluan <[email protected]>

* refactor(plugins): update export wrappers to use `//go:wasmexport` for WebAssembly compatibility

Signed-off-by: Deluan <[email protected]>

* docs: update plugin registration docs

Signed-off-by: Deluan <[email protected]>

* fix(plugins): generate host wrappers

Signed-off-by: Deluan <[email protected]>

* test(plugins): conditionally run goleak checks based on CI environment

Signed-off-by: Deluan <[email protected]>

* docs: update README to reflect changes in plugin import paths

Signed-off-by: Deluan <[email protected]>

* refactor(plugins): update plugin instance creation to accept context for cancellation support

Signed-off-by: Deluan <[email protected]>

* fix(plugins): update return types in metadata interfaces to use pointers

Signed-off-by: Deluan <[email protected]>

* fix(plugins): enhance type handling for Rust and XTP output in capability generation

Signed-off-by: Deluan <[email protected]>

* fix(plugins): update IsAuthorized method to return boolean instead of response object

Signed-off-by: Deluan <[email protected]>

* test(plugins): add unit tests for rustOutputType and isPrimitiveRustType functions

Signed-off-by: Deluan <[email protected]>

* feat(plugins): implement XTP JSONSchema validation for generated schemas

Signed-off-by: Deluan <[email protected]>

* fix(plugins): update response types in testMetadataAgent methods to use pointers

Signed-off-by: Deluan <[email protected]>

* docs: update Go and Rust plugin developer sections for clarity

Signed-off-by: Deluan <[email protected]>

* docs: correct example link for library inspector in README

Signed-off-by: Deluan <[email protected]>

* docs: clarify artwork URL generation capabilities in service descriptions

Signed-off-by: Deluan <[email protected]>

* docs: update README to include Rust PDK crate information for plugin developers

Signed-off-by: Deluan <[email protected]>

* 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 <[email protected]>

* refactor: Discord RPC struct to encapsulate WebSocket logic

Signed-off-by: Deluan <[email protected]>

* feat: add support for experimental WebAssembly threads

Signed-off-by: Deluan <[email protected]>

* feat: add PDK abstraction layer with mock support for non-WASM builds

Signed-off-by: Deluan <[email protected]>

* feat: add unit tests for Discord plugin and RPC functionality

Signed-off-by: Deluan <[email protected]>

* fix: update return types in minimalPlugin and wikimediaPlugin methods to use pointers

Signed-off-by: Deluan <[email protected]>

* fix: context cancellation and implement WebSocket callback timeout for improved error handling

Signed-off-by: Deluan <[email protected]>

* feat: conditionally include error handling in generated client code templates

Signed-off-by: Deluan <[email protected]>

* feat: implement ConfigService for plugin configuration management

Signed-off-by: Deluan <[email protected]>

* feat: enhance plugin manager to support metrics recording

Signed-off-by: Deluan <[email protected]>

* refactor: make MockPDK private

Signed-off-by: Deluan <[email protected]>

* refactor: update interface types to use 'any' in plugin repository methods

Signed-off-by: Deluan <[email protected]>

* refactor: rename List method to Keys for clarity in configuration management

Signed-off-by: Deluan <[email protected]>

* test: add ndpgen plugin tests in the pipeline and update Makefile

Signed-off-by: Deluan <[email protected]>

* feat: add users permission management to plugin system

Signed-off-by: Deluan <[email protected]>

* refactor: streamline users integration tests and enhance plugin user management

Signed-off-by: Deluan <[email protected]>

* refactor: remove UserID from scrobbler request structure

Signed-off-by: Deluan <[email protected]>

* test: add integration tests for UsersService enable gate behavior

Signed-off-by: Deluan <[email protected]>

* feat: implement user permissions for SubsonicAPI and scrobbler plugins

Signed-off-by: Deluan <[email protected]>

* fix: show proper error in the UI when enabling a plugin fails

Signed-off-by: Deluan <[email protected]>

* feat: add library permission management to plugin system

Signed-off-by: Deluan <[email protected]>

* feat: add user permission for processing scrobbles in Discord Rich Presence plugin

Signed-off-by: Deluan <[email protected]>

* fix: implement dynamic loading for buffered scrobbler plugins

Signed-off-by: Deluan <[email protected]>

* feat: add GetAdmins method to retrieve admin users from the plugin

Signed-off-by: Deluan <[email protected]>

* feat: update Portuguese translations for user and library permissions

Signed-off-by: Deluan <[email protected]>

* reorder migrations

Signed-off-by: Deluan <[email protected]>

* fix: remove unnecessary bulkActionButtons prop from PluginList component

* feat: add manual plugin rescan functionality and corresponding UI action

Signed-off-by: Deluan <[email protected]>

* feat: implement user/library and plugin management integration with cleanup on deletion

Signed-off-by: Deluan <[email protected]>

* 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 <[email protected]>

* 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 <[email protected]>

* fix: enhance connection management with improved error handling and cleanup logic

Signed-off-by: Deluan <[email protected]>

* feat: introduce ArtistRef struct for better artist representation and update track metadata handling

Signed-off-by: Deluan <[email protected]>

* feat: update user configuration handling to use user key prefix for improved clarity

Signed-off-by: Deluan <[email protected]>

* feat: enhance ConfigCard input fields with multiline support and vertical resizing

Signed-off-by: Deluan <[email protected]>

* fix: rust plugin compilation error

Signed-off-by: Deluan <[email protected]>

* feat: implement IsOptionPattern method for better return type handling in Rust PDK generation

Signed-off-by: Deluan <[email protected]>

---------

Signed-off-by: Deluan <[email protected]>
2026-01-14 19:22:48 -05:00
..