Breaking change: Add ScanSchedule, allows interval and cron based configurations.

See https://pkg.go.dev/github.com/robfig/cron#hdr-CRON_Expression_Format for expression syntax.

`ScanInterval` will still work for the time being. The only situation it does not work is when you want to disable periodic scanning by setting `ScanInterval=0`. If you want to disable it, please set `ScanSchedule=""`

Closes #1085
This commit is contained in:
Deluan
2021-05-06 17:56:10 -04:00
parent 1d6aa70033
commit f8dbc41b6d
9 changed files with 164 additions and 30 deletions
+29 -10
View File
@@ -56,12 +56,13 @@ func runNavidrome() {
g.Add(startServer())
g.Add(startSignaler())
g.Add(startScheduler())
interval := conf.Server.ScanInterval
if interval != 0 {
g.Add(startPeriodicScan(interval))
schedule := conf.Server.ScanSchedule
if schedule != "" {
go schedulePeriodicScan(schedule)
} else {
log.Warn("Periodic scan is DISABLED", "interval", interval)
log.Warn("Periodic scan is DISABLED", "schedule", schedule)
}
if err := g.Run(); err != nil {
@@ -115,22 +116,40 @@ func startSignaler() (func() error, func(err error)) {
}
}
func startPeriodicScan(interval time.Duration) (func() error, func(err error)) {
log.Info("Starting scanner", "interval", interval.String())
func schedulePeriodicScan(schedule string) {
time.Sleep(2 * time.Second) // Wait 2 seconds before the first scan
scanner := GetScanner()
scheduler := GetScheduler()
log.Info("Executing initial scan")
if err := scanner.RescanAll(context.Background(), false); err != nil {
log.Error("Error executing initial scan", err)
}
log.Info("Scheduling periodic scan", "schedule", schedule)
err := scheduler.Add(schedule, func() {
_ = scanner.RescanAll(context.Background(), false)
})
if err != nil {
log.Error("Error scheduling periodic scan", err)
}
}
func startScheduler() (func() error, func(err error)) {
log.Info("Starting scheduler")
scheduler := GetScheduler()
ctx, cancel := context.WithCancel(context.Background())
return func() error {
time.Sleep(2 * time.Second) // Wait 2 seconds before the first scan
scanner.Run(ctx, interval)
scheduler.Run(ctx)
return nil
}, func(err error) {
cancel()
if err != nil {
log.Error("Shutting down Scanner due to error", err)
log.Error("Shutting down Scheduler due to error", err)
} else {
log.Info("Shutting down Scanner")
log.Info("Shutting down Scheduler")
}
}
}
+21 -1
View File
@@ -6,16 +6,18 @@
package cmd
import (
"sync"
"github.com/google/wire"
"github.com/navidrome/navidrome/core"
"github.com/navidrome/navidrome/core/transcoder"
"github.com/navidrome/navidrome/persistence"
"github.com/navidrome/navidrome/scanner"
"github.com/navidrome/navidrome/scheduler"
"github.com/navidrome/navidrome/server"
"github.com/navidrome/navidrome/server/app"
"github.com/navidrome/navidrome/server/events"
"github.com/navidrome/navidrome/server/subsonic"
"sync"
)
// Injectors from wire_injectors.go:
@@ -63,6 +65,11 @@ func createBroker() events.Broker {
return broker
}
func createScheduler() scheduler.Scheduler {
schedulerScheduler := scheduler.New()
return schedulerScheduler
}
// wire_injectors.go:
var allProviders = wire.NewSet(core.Set, subsonic.New, app.New, persistence.New)
@@ -92,3 +99,16 @@ func GetBroker() events.Broker {
})
return brokerInstance
}
// Scheduler must be a Singleton
var (
onceScheduler sync.Once
schedulerInstance scheduler.Scheduler
)
func GetScheduler() scheduler.Scheduler {
onceScheduler.Do(func() {
schedulerInstance = createScheduler()
})
return schedulerInstance
}
+20
View File
@@ -9,6 +9,7 @@ import (
"github.com/navidrome/navidrome/core"
"github.com/navidrome/navidrome/persistence"
"github.com/navidrome/navidrome/scanner"
"github.com/navidrome/navidrome/scheduler"
"github.com/navidrome/navidrome/server"
"github.com/navidrome/navidrome/server/app"
"github.com/navidrome/navidrome/server/events"
@@ -82,3 +83,22 @@ func createBroker() events.Broker {
events.NewBroker,
))
}
// Scheduler must be a Singleton
var (
onceScheduler sync.Once
schedulerInstance scheduler.Scheduler
)
func GetScheduler() scheduler.Scheduler {
onceScheduler.Do(func() {
schedulerInstance = createScheduler()
})
return schedulerInstance
}
func createScheduler() scheduler.Scheduler {
panic(wire.Build(
scheduler.New,
))
}