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>
2026-01-14 15:22:48 -09:00
|
|
|
package internal
|
|
|
|
|
|
|
|
|
|
import (
|
|
|
|
|
"bytes"
|
|
|
|
|
"embed"
|
|
|
|
|
"fmt"
|
|
|
|
|
"strings"
|
|
|
|
|
"text/template"
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
//go:embed templates/*.tmpl
|
|
|
|
|
var templatesFS embed.FS
|
|
|
|
|
|
|
|
|
|
// hostFuncMap returns the template functions for host code generation.
|
|
|
|
|
func hostFuncMap(svc Service) template.FuncMap {
|
|
|
|
|
return template.FuncMap{
|
|
|
|
|
"lower": strings.ToLower,
|
|
|
|
|
"title": strings.Title,
|
|
|
|
|
"exportName": func(m Method) string { return m.FunctionName(svc.ExportPrefix()) },
|
|
|
|
|
"requestType": func(m Method) string { return m.RequestTypeName(svc.Name) },
|
|
|
|
|
"responseType": func(m Method) string { return m.ResponseTypeName(svc.Name) },
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// clientFuncMap returns the template functions for client code generation.
|
|
|
|
|
// Uses private (lowercase) type names for request/response structs.
|
|
|
|
|
func clientFuncMap(svc Service) template.FuncMap {
|
|
|
|
|
return template.FuncMap{
|
|
|
|
|
"lower": strings.ToLower,
|
|
|
|
|
"title": strings.Title,
|
|
|
|
|
"exportName": func(m Method) string { return m.FunctionName(svc.ExportPrefix()) },
|
|
|
|
|
"requestType": func(m Method) string { return m.ClientRequestTypeName(svc.Name) },
|
|
|
|
|
"responseType": func(m Method) string { return m.ClientResponseTypeName(svc.Name) },
|
|
|
|
|
"formatDoc": formatDoc,
|
|
|
|
|
"mockReturnValues": mockReturnValues,
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// mockReturnValues generates the testify mock return value accessors for a method.
|
|
|
|
|
// For example: args.String(0), args.Bool(1), args.Error(2)
|
|
|
|
|
func mockReturnValues(m Method) string {
|
|
|
|
|
var parts []string
|
|
|
|
|
idx := 0
|
|
|
|
|
|
|
|
|
|
for _, r := range m.Returns {
|
|
|
|
|
parts = append(parts, mockAccessor(r.Type, idx))
|
|
|
|
|
idx++
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if m.HasError {
|
|
|
|
|
parts = append(parts, fmt.Sprintf("args.Error(%d)", idx))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return strings.Join(parts, ", ")
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// mockAccessor returns the testify mock accessor call for a given type and index.
|
|
|
|
|
func mockAccessor(typ string, idx int) string {
|
|
|
|
|
switch {
|
|
|
|
|
case typ == "string":
|
|
|
|
|
return fmt.Sprintf("args.String(%d)", idx)
|
|
|
|
|
case typ == "bool":
|
|
|
|
|
return fmt.Sprintf("args.Bool(%d)", idx)
|
|
|
|
|
case typ == "int":
|
|
|
|
|
return fmt.Sprintf("args.Int(%d)", idx)
|
|
|
|
|
case typ == "int64":
|
|
|
|
|
return fmt.Sprintf("args.Get(%d).(int64)", idx)
|
|
|
|
|
case typ == "int32":
|
|
|
|
|
return fmt.Sprintf("args.Get(%d).(int32)", idx)
|
|
|
|
|
case typ == "float64":
|
|
|
|
|
return fmt.Sprintf("args.Get(%d).(float64)", idx)
|
|
|
|
|
case typ == "float32":
|
|
|
|
|
return fmt.Sprintf("args.Get(%d).(float32)", idx)
|
|
|
|
|
case typ == "[]byte":
|
|
|
|
|
return fmt.Sprintf("args.Get(%d).([]byte)", idx)
|
|
|
|
|
default:
|
|
|
|
|
// For slices, maps, pointers, and custom types, use Get with type assertion
|
|
|
|
|
return fmt.Sprintf("args.Get(%d).(%s)", idx, typ)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// pythonFuncMap returns the template functions for Python client code generation.
|
|
|
|
|
func pythonFuncMap(svc Service) template.FuncMap {
|
|
|
|
|
return template.FuncMap{
|
|
|
|
|
"lower": strings.ToLower,
|
|
|
|
|
"exportName": func(m Method) string { return m.FunctionName(svc.ExportPrefix()) },
|
|
|
|
|
"pythonFunc": func(m Method) string { return m.PythonFunctionName(svc.ExportPrefix()) },
|
|
|
|
|
"pythonResultType": func(m Method) string { return m.PythonResultTypeName(svc.Name) },
|
|
|
|
|
"pythonDefault": pythonDefaultValue,
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// GenerateHost generates the host function wrapper code for a service.
|
|
|
|
|
func GenerateHost(svc Service, pkgName string) ([]byte, error) {
|
|
|
|
|
tmplContent, err := templatesFS.ReadFile("templates/host.go.tmpl")
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("reading host template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
tmpl, err := template.New("host").Funcs(hostFuncMap(svc)).Parse(string(tmplContent))
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("parsing template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
data := templateData{
|
|
|
|
|
Package: pkgName,
|
|
|
|
|
Service: svc,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
var buf bytes.Buffer
|
|
|
|
|
if err := tmpl.Execute(&buf, data); err != nil {
|
|
|
|
|
return nil, fmt.Errorf("executing template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return buf.Bytes(), nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// GenerateClientGo generates client wrapper code for plugins to call host functions.
|
|
|
|
|
func GenerateClientGo(svc Service, pkgName string) ([]byte, error) {
|
|
|
|
|
tmplContent, err := templatesFS.ReadFile("templates/client.go.tmpl")
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("reading client template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
tmpl, err := template.New("client").Funcs(clientFuncMap(svc)).Parse(string(tmplContent))
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("parsing template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
data := templateData{
|
|
|
|
|
Package: pkgName,
|
|
|
|
|
Service: svc,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
var buf bytes.Buffer
|
|
|
|
|
if err := tmpl.Execute(&buf, data); err != nil {
|
|
|
|
|
return nil, fmt.Errorf("executing template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return buf.Bytes(), nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// GenerateClientGoStub generates stub code for non-WASM platforms.
|
|
|
|
|
// These stubs provide type definitions and function signatures for IDE support,
|
|
|
|
|
// but panic at runtime since host functions are only available in WASM plugins.
|
|
|
|
|
func GenerateClientGoStub(svc Service, pkgName string) ([]byte, error) {
|
|
|
|
|
tmplContent, err := templatesFS.ReadFile("templates/client_stub.go.tmpl")
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("reading client stub template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
tmpl, err := template.New("client_stub").Funcs(clientFuncMap(svc)).Parse(string(tmplContent))
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("parsing template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
data := templateData{
|
|
|
|
|
Package: pkgName,
|
|
|
|
|
Service: svc,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
var buf bytes.Buffer
|
|
|
|
|
if err := tmpl.Execute(&buf, data); err != nil {
|
|
|
|
|
return nil, fmt.Errorf("executing template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return buf.Bytes(), nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
type templateData struct {
|
|
|
|
|
Package string
|
|
|
|
|
Service Service
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// formatDoc formats a documentation string for Go comments.
|
|
|
|
|
// It prefixes each line with "// " and trims trailing whitespace.
|
|
|
|
|
func formatDoc(doc string) string {
|
|
|
|
|
if doc == "" {
|
|
|
|
|
return ""
|
|
|
|
|
}
|
|
|
|
|
lines := strings.Split(strings.TrimSpace(doc), "\n")
|
|
|
|
|
var result []string
|
|
|
|
|
for _, line := range lines {
|
|
|
|
|
result = append(result, "// "+strings.TrimRight(line, " \t"))
|
|
|
|
|
}
|
|
|
|
|
return strings.Join(result, "\n")
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// GenerateClientPython generates Python client wrapper code for plugins.
|
|
|
|
|
func GenerateClientPython(svc Service) ([]byte, error) {
|
|
|
|
|
tmplContent, err := templatesFS.ReadFile("templates/client.py.tmpl")
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("reading Python client template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
tmpl, err := template.New("client_py").Funcs(pythonFuncMap(svc)).Parse(string(tmplContent))
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("parsing template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
data := templateData{
|
|
|
|
|
Service: svc,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
var buf bytes.Buffer
|
|
|
|
|
if err := tmpl.Execute(&buf, data); err != nil {
|
|
|
|
|
return nil, fmt.Errorf("executing template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return buf.Bytes(), nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// pythonDefaultValue returns a Python default value for response.get() calls.
|
|
|
|
|
func pythonDefaultValue(p Param) string {
|
|
|
|
|
switch p.Type {
|
|
|
|
|
case "string":
|
|
|
|
|
return `, ""`
|
|
|
|
|
case "int", "int32", "int64":
|
|
|
|
|
return ", 0"
|
|
|
|
|
case "float32", "float64":
|
|
|
|
|
return ", 0.0"
|
|
|
|
|
case "bool":
|
|
|
|
|
return ", False"
|
|
|
|
|
case "[]byte":
|
|
|
|
|
return ", b\"\""
|
|
|
|
|
default:
|
|
|
|
|
return ", None"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// rustFuncMap returns the template functions for Rust client code generation.
|
|
|
|
|
func rustFuncMap(svc Service) template.FuncMap {
|
|
|
|
|
knownStructs := svc.KnownStructs()
|
|
|
|
|
return template.FuncMap{
|
|
|
|
|
"lower": strings.ToLower,
|
|
|
|
|
"exportName": func(m Method) string { return m.FunctionName(svc.ExportPrefix()) },
|
|
|
|
|
"requestType": func(m Method) string { return m.RequestTypeName(svc.Name) },
|
|
|
|
|
"responseType": func(m Method) string { return m.ResponseTypeName(svc.Name) },
|
|
|
|
|
"rustFunc": func(m Method) string { return m.RustFunctionName(svc.ExportPrefix()) },
|
|
|
|
|
"rustDocComment": RustDocComment,
|
|
|
|
|
"rustType": func(p Param) string { return p.RustTypeWithStructs(knownStructs) },
|
|
|
|
|
"rustParamType": func(p Param) string { return p.RustParamTypeWithStructs(knownStructs) },
|
|
|
|
|
"fieldRustType": func(f FieldDef) string { return f.RustType(knownStructs) },
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// GenerateClientRust generates Rust client wrapper code for plugins.
|
|
|
|
|
func GenerateClientRust(svc Service) ([]byte, error) {
|
|
|
|
|
tmplContent, err := templatesFS.ReadFile("templates/client.rs.tmpl")
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("reading Rust client template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
tmpl, err := template.New("client_rs").Funcs(rustFuncMap(svc)).Parse(string(tmplContent))
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("parsing template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
data := templateData{
|
|
|
|
|
Service: svc,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
var buf bytes.Buffer
|
|
|
|
|
if err := tmpl.Execute(&buf, data); err != nil {
|
|
|
|
|
return nil, fmt.Errorf("executing template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return buf.Bytes(), nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// firstLine returns the first line of a multi-line string, with the first word removed.
|
|
|
|
|
func firstLine(s string) string {
|
|
|
|
|
line := s
|
|
|
|
|
if idx := strings.Index(s, "\n"); idx >= 0 {
|
|
|
|
|
line = s[:idx]
|
|
|
|
|
}
|
|
|
|
|
// Remove the first word (service name like "ArtworkService")
|
|
|
|
|
if idx := strings.Index(line, " "); idx >= 0 {
|
|
|
|
|
line = line[idx+1:]
|
|
|
|
|
}
|
|
|
|
|
return line
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// GenerateRustLib generates the lib.rs file that exposes all service modules.
|
|
|
|
|
func GenerateRustLib(services []Service) ([]byte, error) {
|
|
|
|
|
tmplContent, err := templatesFS.ReadFile("templates/lib.rs.tmpl")
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("reading Rust lib template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
tmpl, err := template.New("lib_rs").Funcs(template.FuncMap{
|
|
|
|
|
"lower": strings.ToLower,
|
|
|
|
|
"firstLine": firstLine,
|
|
|
|
|
}).Parse(string(tmplContent))
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("parsing template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
data := struct {
|
|
|
|
|
Services []Service
|
|
|
|
|
}{
|
|
|
|
|
Services: services,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
var buf bytes.Buffer
|
|
|
|
|
if err := tmpl.Execute(&buf, data); err != nil {
|
|
|
|
|
return nil, fmt.Errorf("executing template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return buf.Bytes(), nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// GenerateGoDoc generates the doc.go file that provides package documentation.
|
|
|
|
|
func GenerateGoDoc(services []Service, pkgName string) ([]byte, error) {
|
|
|
|
|
tmplContent, err := templatesFS.ReadFile("templates/doc.go.tmpl")
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("reading Go doc template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
tmpl, err := template.New("doc_go").Funcs(template.FuncMap{
|
|
|
|
|
"firstLine": firstLine,
|
|
|
|
|
}).Parse(string(tmplContent))
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("parsing template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
data := struct {
|
|
|
|
|
Package string
|
|
|
|
|
Services []Service
|
|
|
|
|
}{
|
|
|
|
|
Package: pkgName,
|
|
|
|
|
Services: services,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
var buf bytes.Buffer
|
|
|
|
|
if err := tmpl.Execute(&buf, data); err != nil {
|
|
|
|
|
return nil, fmt.Errorf("executing template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return buf.Bytes(), nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// GenerateGoMod generates the go.mod file for the Go client library.
|
|
|
|
|
func GenerateGoMod() ([]byte, error) {
|
|
|
|
|
tmplContent, err := templatesFS.ReadFile("templates/go.mod.tmpl")
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("reading go.mod template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
return tmplContent, nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// capabilityTemplateData holds data for capability template execution.
|
|
|
|
|
type capabilityTemplateData struct {
|
|
|
|
|
Package string
|
|
|
|
|
Capability Capability
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// capabilityFuncMap returns template functions for capability code generation.
|
|
|
|
|
func capabilityFuncMap(cap Capability) template.FuncMap {
|
|
|
|
|
return template.FuncMap{
|
|
|
|
|
"formatDoc": formatDoc,
|
|
|
|
|
"indent": indentText,
|
|
|
|
|
"agentName": capabilityAgentName,
|
|
|
|
|
"providerInterface": func(e Export) string { return e.ProviderInterfaceName() },
|
|
|
|
|
"implVar": func(e Export) string { return e.ImplVarName() },
|
|
|
|
|
"exportFunc": func(e Export) string { return e.ExportFuncName() },
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// indentText adds n tabs to each line of text.
|
|
|
|
|
func indentText(n int, s string) string {
|
|
|
|
|
indent := strings.Repeat("\t", n)
|
|
|
|
|
lines := strings.Split(s, "\n")
|
|
|
|
|
for i, line := range lines {
|
|
|
|
|
if line != "" {
|
|
|
|
|
lines[i] = indent + line
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return strings.Join(lines, "\n")
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// capabilityAgentName returns the interface name for a capability.
|
|
|
|
|
// Uses the Go interface name stripped of common suffixes.
|
|
|
|
|
func capabilityAgentName(cap Capability) string {
|
|
|
|
|
name := cap.Interface
|
|
|
|
|
// Remove common suffixes to get a clean name
|
|
|
|
|
for _, suffix := range []string{"Agent", "Callback", "Service"} {
|
|
|
|
|
if strings.HasSuffix(name, suffix) {
|
|
|
|
|
name = name[:len(name)-len(suffix)]
|
|
|
|
|
break
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
// Use the shortened name or the original if no suffix found
|
|
|
|
|
if name == "" {
|
|
|
|
|
name = cap.Interface
|
|
|
|
|
}
|
|
|
|
|
return name
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// GenerateCapabilityGo generates Go export wrapper code for a capability.
|
|
|
|
|
func GenerateCapabilityGo(cap Capability, pkgName string) ([]byte, error) {
|
|
|
|
|
tmplContent, err := templatesFS.ReadFile("templates/capability.go.tmpl")
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("reading capability template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
tmpl, err := template.New("capability").Funcs(capabilityFuncMap(cap)).Parse(string(tmplContent))
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("parsing template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
data := capabilityTemplateData{
|
|
|
|
|
Package: pkgName,
|
|
|
|
|
Capability: cap,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
var buf bytes.Buffer
|
|
|
|
|
if err := tmpl.Execute(&buf, data); err != nil {
|
|
|
|
|
return nil, fmt.Errorf("executing template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return buf.Bytes(), nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// GenerateCapabilityGoStub generates stub code for non-WASM platforms.
|
|
|
|
|
func GenerateCapabilityGoStub(cap Capability, pkgName string) ([]byte, error) {
|
|
|
|
|
tmplContent, err := templatesFS.ReadFile("templates/capability_stub.go.tmpl")
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("reading capability stub template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
tmpl, err := template.New("capability_stub").Funcs(capabilityFuncMap(cap)).Parse(string(tmplContent))
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("parsing template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
data := capabilityTemplateData{
|
|
|
|
|
Package: pkgName,
|
|
|
|
|
Capability: cap,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
var buf bytes.Buffer
|
|
|
|
|
if err := tmpl.Execute(&buf, data); err != nil {
|
|
|
|
|
return nil, fmt.Errorf("executing template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return buf.Bytes(), nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// rustCapabilityFuncMap returns template functions for Rust capability code generation.
|
|
|
|
|
func rustCapabilityFuncMap(cap Capability) template.FuncMap {
|
|
|
|
|
knownStructs := cap.KnownStructs()
|
|
|
|
|
return template.FuncMap{
|
|
|
|
|
"rustDocComment": RustDocComment,
|
|
|
|
|
"rustTypeAlias": rustTypeAlias,
|
|
|
|
|
"rustConstType": rustConstType,
|
|
|
|
|
"rustConstName": rustConstName,
|
|
|
|
|
"rustFieldName": func(name string) string { return ToSnakeCase(name) },
|
|
|
|
|
"rustMethodName": func(name string) string { return ToSnakeCase(name) },
|
|
|
|
|
"fieldRustType": func(f FieldDef) string { return f.RustType(knownStructs) },
|
|
|
|
|
"rustOutputType": rustOutputType,
|
|
|
|
|
"isPrimitiveRust": isPrimitiveRustType,
|
|
|
|
|
"skipSerializingFunc": skipSerializingFunc,
|
|
|
|
|
"hasHashMap": hasHashMap,
|
|
|
|
|
"agentName": capabilityAgentName,
|
|
|
|
|
"providerInterface": func(e Export) string { return e.ProviderInterfaceName() },
|
|
|
|
|
"registerMacroName": func(name string) string { return registerMacroName(cap.Name, name) },
|
|
|
|
|
"snakeCase": ToSnakeCase,
|
|
|
|
|
"indent": func(spaces int, s string) string {
|
|
|
|
|
indent := strings.Repeat(" ", spaces)
|
|
|
|
|
lines := strings.Split(s, "\n")
|
|
|
|
|
for i, line := range lines {
|
|
|
|
|
if line != "" {
|
|
|
|
|
lines[i] = indent + line
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return strings.Join(lines, "\n")
|
|
|
|
|
},
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// rustTypeAlias converts a Go type to its Rust equivalent for type aliases.
|
|
|
|
|
// For string types used as error sentinels/constants, we use &'static str
|
|
|
|
|
// since Rust consts can't be heap-allocated String values.
|
|
|
|
|
func rustTypeAlias(goType string) string {
|
|
|
|
|
switch goType {
|
|
|
|
|
case "string":
|
|
|
|
|
return "&'static str"
|
|
|
|
|
case "int", "int32":
|
|
|
|
|
return "i32"
|
|
|
|
|
case "int64":
|
|
|
|
|
return "i64"
|
|
|
|
|
default:
|
|
|
|
|
return goType
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// rustConstType converts a Go type to its Rust equivalent for const declarations.
|
|
|
|
|
// For String types, it returns &'static str since Rust consts can't be heap-allocated.
|
|
|
|
|
func rustConstType(goType string) string {
|
|
|
|
|
switch goType {
|
|
|
|
|
case "string", "String":
|
|
|
|
|
return "&'static str"
|
|
|
|
|
case "int", "int32":
|
|
|
|
|
return "i32"
|
|
|
|
|
case "int64":
|
|
|
|
|
return "i64"
|
|
|
|
|
default:
|
|
|
|
|
return goType
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// rustOutputType converts a Go type to Rust for capability method signatures.
|
|
|
|
|
// It handles pointer types specially - for capability outputs, pointers become the base type
|
|
|
|
|
// (not Option<T>) because Rust's Result<T, Error> already provides optional semantics.
|
|
|
|
|
//
|
|
|
|
|
// TODO: Pointer to primitive types (e.g., *string, *int32) are not handled correctly.
|
|
|
|
|
// Currently "*string" returns "string" instead of "String". This would generate invalid
|
|
|
|
|
// Rust code. No current capability uses this pattern, but it should be fixed if needed.
|
|
|
|
|
func rustOutputType(goType string) string {
|
|
|
|
|
// Strip pointer prefix - capability outputs use Result<T, Error> for optionality
|
|
|
|
|
if strings.HasPrefix(goType, "*") {
|
|
|
|
|
return goType[1:]
|
|
|
|
|
}
|
|
|
|
|
// Convert Go primitives to Rust primitives
|
|
|
|
|
switch goType {
|
|
|
|
|
case "bool":
|
|
|
|
|
return "bool"
|
|
|
|
|
case "string":
|
|
|
|
|
return "String"
|
|
|
|
|
case "int", "int32":
|
|
|
|
|
return "i32"
|
|
|
|
|
case "int64":
|
|
|
|
|
return "i64"
|
|
|
|
|
case "float32":
|
|
|
|
|
return "f32"
|
|
|
|
|
case "float64":
|
|
|
|
|
return "f64"
|
|
|
|
|
}
|
|
|
|
|
return goType
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// isPrimitiveRustType returns true if the Go type maps to a Rust primitive type.
|
|
|
|
|
func isPrimitiveRustType(goType string) bool {
|
|
|
|
|
// Strip pointer prefix first
|
|
|
|
|
if strings.HasPrefix(goType, "*") {
|
|
|
|
|
goType = goType[1:]
|
|
|
|
|
}
|
|
|
|
|
switch goType {
|
|
|
|
|
case "bool", "string", "int", "int32", "int64", "float32", "float64":
|
|
|
|
|
return true
|
|
|
|
|
}
|
|
|
|
|
return false
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// rustConstName converts a Go const name to Rust convention (SCREAMING_SNAKE_CASE).
|
|
|
|
|
func rustConstName(name string) string {
|
|
|
|
|
return strings.ToUpper(ToSnakeCase(name))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// skipSerializingFunc returns the appropriate skip_serializing_if function name.
|
|
|
|
|
func skipSerializingFunc(goType string) string {
|
|
|
|
|
if strings.HasPrefix(goType, "*") || strings.HasPrefix(goType, "[]") || strings.HasPrefix(goType, "map[") {
|
|
|
|
|
return "Option::is_none"
|
|
|
|
|
}
|
|
|
|
|
switch goType {
|
|
|
|
|
case "string":
|
|
|
|
|
return "String::is_empty"
|
|
|
|
|
case "bool":
|
|
|
|
|
return "std::ops::Not::not"
|
2026-01-26 14:28:41 -09:00
|
|
|
case "int32":
|
|
|
|
|
return "is_zero_i32"
|
|
|
|
|
case "uint32":
|
|
|
|
|
return "is_zero_u32"
|
|
|
|
|
case "int64":
|
|
|
|
|
return "is_zero_i64"
|
|
|
|
|
case "uint64":
|
|
|
|
|
return "is_zero_u64"
|
|
|
|
|
case "float32":
|
|
|
|
|
return "is_zero_f32"
|
|
|
|
|
case "float64":
|
|
|
|
|
return "is_zero_f64"
|
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>
2026-01-14 15:22:48 -09:00
|
|
|
default:
|
|
|
|
|
return "Option::is_none"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// hasHashMap returns true if any struct in the capability uses HashMap.
|
|
|
|
|
func hasHashMap(cap Capability) bool {
|
|
|
|
|
for _, st := range cap.Structs {
|
|
|
|
|
for _, f := range st.Fields {
|
|
|
|
|
if strings.HasPrefix(f.Type, "map[") {
|
|
|
|
|
return true
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return false
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// registerMacroName returns the macro name for registering an optional method.
|
|
|
|
|
// For package "websocket" and method "OnClose", returns "register_websocket_close".
|
|
|
|
|
func registerMacroName(pkg, name string) string {
|
|
|
|
|
// Remove common prefixes from method name
|
|
|
|
|
for _, prefix := range []string{"Get", "On"} {
|
|
|
|
|
if strings.HasPrefix(name, prefix) {
|
|
|
|
|
name = name[len(prefix):]
|
|
|
|
|
break
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return "register_" + ToSnakeCase(pkg) + "_" + ToSnakeCase(name)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// GenerateCapabilityRust generates Rust export wrapper code for a capability.
|
|
|
|
|
func GenerateCapabilityRust(cap Capability) ([]byte, error) {
|
|
|
|
|
tmplContent, err := templatesFS.ReadFile("templates/capability.rs.tmpl")
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("reading Rust capability template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
tmpl, err := template.New("capability_rust").Funcs(rustCapabilityFuncMap(cap)).Parse(string(tmplContent))
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("parsing template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
data := capabilityTemplateData{
|
|
|
|
|
Package: cap.Name,
|
|
|
|
|
Capability: cap,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
var buf bytes.Buffer
|
|
|
|
|
if err := tmpl.Execute(&buf, data); err != nil {
|
|
|
|
|
return nil, fmt.Errorf("executing template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return buf.Bytes(), nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// GenerateCapabilityRustLib generates the lib.rs file for the Rust capabilities crate.
|
|
|
|
|
func GenerateCapabilityRustLib(capabilities []Capability) ([]byte, error) {
|
|
|
|
|
var buf bytes.Buffer
|
|
|
|
|
buf.WriteString("// Code generated by ndpgen. DO NOT EDIT.\n\n")
|
|
|
|
|
buf.WriteString("//! Navidrome Plugin Development Kit - Capability Wrappers\n")
|
|
|
|
|
buf.WriteString("//!\n")
|
|
|
|
|
buf.WriteString("//! This crate provides type definitions, traits, and registration macros\n")
|
|
|
|
|
buf.WriteString("//! for implementing Navidrome plugin capabilities in Rust.\n\n")
|
|
|
|
|
|
|
|
|
|
// Module declarations
|
|
|
|
|
for _, cap := range capabilities {
|
|
|
|
|
moduleName := ToSnakeCase(cap.Name)
|
|
|
|
|
buf.WriteString(fmt.Sprintf("pub mod %s;\n", moduleName))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return buf.Bytes(), nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// pdkFuncMap returns the template functions for PDK code generation.
|
|
|
|
|
func pdkFuncMap() template.FuncMap {
|
|
|
|
|
return template.FuncMap{
|
|
|
|
|
"firstSentence": firstSentence,
|
|
|
|
|
"paramList": pdkParamList,
|
|
|
|
|
"returnList": pdkReturnList,
|
|
|
|
|
"argList": pdkArgList,
|
|
|
|
|
"argListWithReceiver": pdkArgListWithReceiver,
|
|
|
|
|
"mockReturns": pdkMockReturns,
|
|
|
|
|
"constValue": pdkConstValue,
|
|
|
|
|
"stubTypeUnderlying": stubTypeUnderlying,
|
|
|
|
|
"methodReceiver": pdkMethodReceiver,
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// stubTypeUnderlying returns the appropriate stub type for non-WASM builds.
|
|
|
|
|
// For types that reference internal packages (like memory.Memory), returns "struct{}".
|
|
|
|
|
func stubTypeUnderlying(t PDKType) string {
|
|
|
|
|
underlying := t.Underlying
|
|
|
|
|
// If the underlying type references a package (contains a dot), use a stub struct
|
|
|
|
|
if strings.Contains(underlying, ".") {
|
|
|
|
|
return "struct{}"
|
|
|
|
|
}
|
|
|
|
|
// For simple types like int, int32, return as-is
|
|
|
|
|
return underlying
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// firstSentence returns the first sentence of a doc string, normalized to a single line.
|
|
|
|
|
func firstSentence(doc string) string {
|
|
|
|
|
if doc == "" {
|
|
|
|
|
return ""
|
|
|
|
|
}
|
|
|
|
|
// Normalize whitespace (replace newlines with spaces, collapse multiple spaces)
|
|
|
|
|
doc = strings.Join(strings.Fields(doc), " ")
|
|
|
|
|
|
|
|
|
|
// Find first period followed by space or end
|
|
|
|
|
for i, r := range doc {
|
|
|
|
|
if r == '.' && (i+1 >= len(doc) || doc[i+1] == ' ') {
|
|
|
|
|
return doc[:i+1]
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return doc
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// pdkParamList generates a parameter list string for function signature.
|
|
|
|
|
func pdkParamList(params []PDKParam) string {
|
|
|
|
|
var parts []string
|
|
|
|
|
for _, p := range params {
|
|
|
|
|
if p.Name != "" {
|
|
|
|
|
parts = append(parts, p.Name+" "+p.Type)
|
|
|
|
|
} else {
|
|
|
|
|
parts = append(parts, p.Type)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return strings.Join(parts, ", ")
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// pdkReturnList generates a return list string for function signature.
|
|
|
|
|
func pdkReturnList(returns []PDKReturn) string {
|
|
|
|
|
if len(returns) == 0 {
|
|
|
|
|
return ""
|
|
|
|
|
}
|
|
|
|
|
if len(returns) == 1 && returns[0].Name == "" {
|
|
|
|
|
return " " + returns[0].Type
|
|
|
|
|
}
|
|
|
|
|
var parts []string
|
|
|
|
|
for _, r := range returns {
|
|
|
|
|
if r.Name != "" {
|
|
|
|
|
parts = append(parts, r.Name+" "+r.Type)
|
|
|
|
|
} else {
|
|
|
|
|
parts = append(parts, r.Type)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return " (" + strings.Join(parts, ", ") + ")"
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// pdkArgList generates an argument list string for function call.
|
|
|
|
|
func pdkArgList(params []PDKParam) string {
|
|
|
|
|
var parts []string
|
|
|
|
|
for _, p := range params {
|
|
|
|
|
if p.Name != "" {
|
|
|
|
|
parts = append(parts, p.Name)
|
|
|
|
|
} else {
|
|
|
|
|
parts = append(parts, "_")
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return strings.Join(parts, ", ")
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// pdkArgListWithReceiver generates an argument list that includes the receiver variable
|
|
|
|
|
// as the first argument to PDKMock.Called(). This allows tests to verify which instance
|
|
|
|
|
// a method was called on.
|
|
|
|
|
func pdkArgListWithReceiver(params []PDKParam, typeName string) string {
|
|
|
|
|
// Use lowercase first letter of type name as receiver variable
|
|
|
|
|
receiverVar := strings.ToLower(typeName[:1])
|
|
|
|
|
parts := []string{receiverVar}
|
|
|
|
|
for _, p := range params {
|
|
|
|
|
if p.Name != "" {
|
|
|
|
|
parts = append(parts, p.Name)
|
|
|
|
|
} else {
|
|
|
|
|
parts = append(parts, "_")
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return strings.Join(parts, ", ")
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// pdkMethodReceiver generates the receiver declaration for a method.
|
|
|
|
|
// Example: "r *HTTPRequest" or "m Memory"
|
|
|
|
|
func pdkMethodReceiver(receiver, typeName string) string {
|
|
|
|
|
receiverVar := strings.ToLower(typeName[:1])
|
|
|
|
|
if strings.HasPrefix(receiver, "*") {
|
|
|
|
|
return receiverVar + " *" + typeName
|
|
|
|
|
}
|
|
|
|
|
return receiverVar + " " + typeName
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// pdkMockReturns generates the mock return accessors for a function.
|
|
|
|
|
func pdkMockReturns(returns []PDKReturn) string {
|
|
|
|
|
var parts []string
|
|
|
|
|
for i, r := range returns {
|
|
|
|
|
parts = append(parts, mockAccessorForType(r.Type, i))
|
|
|
|
|
}
|
|
|
|
|
return strings.Join(parts, ", ")
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// mockAccessorForType returns the testify mock accessor for a type.
|
|
|
|
|
func mockAccessorForType(typ string, idx int) string {
|
|
|
|
|
switch typ {
|
|
|
|
|
case "string":
|
|
|
|
|
return fmt.Sprintf("args.String(%d)", idx)
|
|
|
|
|
case "bool":
|
|
|
|
|
return fmt.Sprintf("args.Bool(%d)", idx)
|
|
|
|
|
case "int":
|
|
|
|
|
return fmt.Sprintf("args.Int(%d)", idx)
|
|
|
|
|
case "error":
|
|
|
|
|
return fmt.Sprintf("args.Error(%d)", idx)
|
|
|
|
|
case "[]byte":
|
|
|
|
|
return fmt.Sprintf("args.Get(%d).([]byte)", idx)
|
|
|
|
|
case "uint64":
|
|
|
|
|
return fmt.Sprintf("args.Get(%d).(uint64)", idx)
|
|
|
|
|
case "uint32":
|
|
|
|
|
return fmt.Sprintf("args.Get(%d).(uint32)", idx)
|
|
|
|
|
case "uint16":
|
|
|
|
|
return fmt.Sprintf("args.Get(%d).(uint16)", idx)
|
|
|
|
|
default:
|
|
|
|
|
return fmt.Sprintf("args.Get(%d).(%s)", idx, typ)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// pdkConstValue returns the value expression for a constant.
|
|
|
|
|
func pdkConstValue(c PDKConst) string {
|
|
|
|
|
if c.Value == "" || c.Value == "iota" {
|
|
|
|
|
return "iota"
|
|
|
|
|
}
|
|
|
|
|
return c.Value
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// GeneratePDKGo generates the WASM implementation of the PDK wrapper package.
|
|
|
|
|
func GeneratePDKGo(symbols *PDKSymbols) ([]byte, error) {
|
|
|
|
|
tmplContent, err := templatesFS.ReadFile("templates/pdk.go.tmpl")
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("reading pdk template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
tmpl, err := template.New("pdk").Funcs(pdkFuncMap()).Parse(string(tmplContent))
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("parsing template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
var buf bytes.Buffer
|
|
|
|
|
if err := tmpl.Execute(&buf, symbols); err != nil {
|
|
|
|
|
return nil, fmt.Errorf("executing template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return buf.Bytes(), nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// GeneratePDKGoStub generates the native stub implementation of the PDK wrapper package.
|
|
|
|
|
func GeneratePDKGoStub(symbols *PDKSymbols) ([]byte, error) {
|
|
|
|
|
tmplContent, err := templatesFS.ReadFile("templates/pdk_stub.go.tmpl")
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("reading pdk stub template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
tmpl, err := template.New("pdk_stub").Funcs(pdkFuncMap()).Parse(string(tmplContent))
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("parsing template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
var buf bytes.Buffer
|
|
|
|
|
if err := tmpl.Execute(&buf, symbols); err != nil {
|
|
|
|
|
return nil, fmt.Errorf("executing template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return buf.Bytes(), nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// GeneratePDKTypesStub generates the native type definitions for the PDK wrapper package.
|
|
|
|
|
func GeneratePDKTypesStub(symbols *PDKSymbols) ([]byte, error) {
|
|
|
|
|
tmplContent, err := templatesFS.ReadFile("templates/types_stub.go.tmpl")
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("reading types stub template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
tmpl, err := template.New("types_stub").Funcs(pdkFuncMap()).Parse(string(tmplContent))
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("parsing template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
var buf bytes.Buffer
|
|
|
|
|
if err := tmpl.Execute(&buf, symbols); err != nil {
|
|
|
|
|
return nil, fmt.Errorf("executing template: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return buf.Bytes(), nil
|
|
|
|
|
}
|