mirror of
https://github.com/navidrome/navidrome.git
synced 2026-03-04 06:35:52 +00:00
668869b6c7
* feat(plugins): define TaskQueue host service interface Add the TaskQueueService interface with CreateQueue, Enqueue, GetTaskStatus, and CancelTask methods plus QueueConfig struct. * feat(plugins): define TaskWorker capability for task execution callbacks * feat(plugins): add taskqueue permission to manifest schema Add TaskQueuePermission with maxConcurrency option. * feat(plugins): implement TaskQueue service with SQLite persistence and workers Per-plugin SQLite database with queues and tasks tables. Worker goroutines dequeue tasks and invoke nd_task_execute callback. Exponential backoff retries, rate limiting via delayMs, automatic cleanup of terminal tasks. * feat(plugins): require TaskWorker capability for taskqueue permission * feat(plugins): register TaskQueue host service in manager * feat(plugins): add test-taskqueue plugin for integration testing * feat(plugins): add integration tests for TaskQueue host service * docs: document TaskQueue module for persistent task queues Signed-off-by: Deluan <deluan@navidrome.org> * fix(plugins): harden TaskQueue host service with validation and safety improvements Add input validation (queue name length, payload size limits), extract status string constants to eliminate raw SQL literals, make CreateQueue idempotent via upsert for crash recovery, fix RetentionMs default check for negative values, cap exponential backoff at 1 hour to prevent overflow, and replace manual mutex-based delay enforcement with rate.Limiter from golang.org/x/time/rate for correct concurrent worker serialization. * refactor(plugins): remove capability check for TaskWorker in TaskQueue host service Signed-off-by: Deluan <deluan@navidrome.org> * fix(plugins): use context-aware database execution in TaskQueue host service Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): streamline task queue configuration and error handling Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): increase maxConcurrency for task queue and handle budget exhaustion Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): simplify goroutine management in task queue service Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): update TaskWorker interface to return status messages and refactor task queue service Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): add ClearQueue function to remove pending tasks from a specified queue Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): use migrateDB for task queue schema and fix constant name collision Replaced the raw db.Exec call in createTaskQueueSchema with migrateDB, matching the pattern used by createKVStoreSchema. This enables version-tracked schema migrations via SQLite's PRAGMA user_version, allowing future schema changes to be appended incrementally. Also renamed cleanupInterval to taskCleanupInterval to resolve a redeclaration conflict with host_kvstore.go. * regenerate PDKs Signed-off-by: Deluan <deluan@navidrome.org> --------- Signed-off-by: Deluan <deluan@navidrome.org>
80 lines
2.3 KiB
Go
80 lines
2.3 KiB
Go
// Code generated by ndpgen. DO NOT EDIT.
|
|
//
|
|
// This file contains export wrappers for the TaskWorker capability.
|
|
// It is intended for use in Navidrome plugins built with TinyGo.
|
|
//
|
|
//go:build wasip1
|
|
|
|
package taskworker
|
|
|
|
import (
|
|
"github.com/navidrome/navidrome/plugins/pdk/go/pdk"
|
|
)
|
|
|
|
// TaskExecuteRequest is the request provided when a task is ready to execute.
|
|
type TaskExecuteRequest struct {
|
|
// QueueName is the name of the queue this task belongs to.
|
|
QueueName string `json:"queueName"`
|
|
// TaskID is the unique identifier for this task.
|
|
TaskID string `json:"taskId"`
|
|
// Payload is the opaque data provided when the task was enqueued.
|
|
Payload []byte `json:"payload"`
|
|
// Attempt is the current attempt number (1-based: first attempt = 1).
|
|
Attempt int32 `json:"attempt"`
|
|
}
|
|
|
|
// TaskWorker is the marker interface for taskworker plugins.
|
|
// Implement one or more of the provider interfaces below.
|
|
// TaskWorker provides task execution handling.
|
|
// This capability allows plugins to receive callbacks when their queued tasks
|
|
// are ready to execute. Plugins that use the taskqueue host service must
|
|
// implement this capability.
|
|
type TaskWorker interface{}
|
|
|
|
// TaskExecuteProvider provides the OnTaskExecute function.
|
|
type TaskExecuteProvider interface {
|
|
OnTaskExecute(TaskExecuteRequest) (string, error)
|
|
} // Internal implementation holders
|
|
var (
|
|
taskExecuteImpl func(TaskExecuteRequest) (string, error)
|
|
)
|
|
|
|
// Register registers a taskworker implementation.
|
|
// The implementation is checked for optional provider interfaces.
|
|
func Register(impl TaskWorker) {
|
|
if p, ok := impl.(TaskExecuteProvider); ok {
|
|
taskExecuteImpl = p.OnTaskExecute
|
|
}
|
|
}
|
|
|
|
// NotImplementedCode is the standard return code for unimplemented functions.
|
|
// The host recognizes this and skips the plugin gracefully.
|
|
const NotImplementedCode int32 = -2
|
|
|
|
//go:wasmexport nd_task_execute
|
|
func _NdTaskExecute() int32 {
|
|
if taskExecuteImpl == nil {
|
|
// Return standard code - host will skip this plugin gracefully
|
|
return NotImplementedCode
|
|
}
|
|
|
|
var input TaskExecuteRequest
|
|
if err := pdk.InputJSON(&input); err != nil {
|
|
pdk.SetError(err)
|
|
return -1
|
|
}
|
|
|
|
output, err := taskExecuteImpl(input)
|
|
if err != nil {
|
|
pdk.SetError(err)
|
|
return -1
|
|
}
|
|
|
|
if err := pdk.OutputJSON(output); err != nil {
|
|
pdk.SetError(err)
|
|
return -1
|
|
}
|
|
|
|
return 0
|
|
}
|