mirror of
https://github.com/navidrome/navidrome.git
synced 2025-04-03 04:27:37 +03:00
feat(server): provide native backup/restore mechanism (#3194)
* [enhancement]: Provide native backup/restore mechanism - db.go: add Backup/Restore functions that utilize Sqlite's built-in online backup mechanism - support automatic backup with schedule, limit number of files - provide commands to manually backup/restore Navidrome Notes: `Step(-1)` results in a read-only lock being held for the entire duration of the backup. This will block out any other write operation (and may hold additional locks. An alternate implementation that doesn't block but instead retries is available at https://www.sqlite.org/backup.html#:~:text=of%20a%20Running-,database,-%2F*%0A**%20Perform%20an%20online (easily adaptable to go), but has the potential problem of continually getting restarted by background writes. Additionally, the restore should still only be called when Navidrome is offline, as the restore process does not run migrations that are missing. * remove empty line * add more granular backup schedule * do not remove files when bypass is set * move prune * refactor: small nitpicks * change commands and flags * tests, return path from backup * refactor: small nitpicks --------- Co-authored-by: Deluan <deluan@navidrome.org>
This commit is contained in:
Kendall Garner
GitHub
parent
768160b05e
commit
55730514ea
6 changed files with 602 additions and 5 deletions
151
db/backup.go
Normal file
151
db/backup.go
Normal file
|
|
@ -0,0 +1,151 @@
|
|||
package db
|
||||
|
||||
import (
|
||||
"context"
|
||||
"database/sql"
|
||||
"errors"
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"regexp"
|
||||
"slices"
|
||||
"time"
|
||||
|
||||
"github.com/mattn/go-sqlite3"
|
||||
"github.com/navidrome/navidrome/conf"
|
||||
"github.com/navidrome/navidrome/log"
|
||||
)
|
||||
|
||||
const (
|
||||
backupPrefix = "navidrome_backup"
|
||||
backupRegexString = backupPrefix + "_(.+)\\.db"
|
||||
)
|
||||
|
||||
var backupRegex = regexp.MustCompile(backupRegexString)
|
||||
|
||||
const backupSuffixLayout = "2006.01.02_15.04.05"
|
||||
|
||||
func backupPath(t time.Time) string {
|
||||
return filepath.Join(
|
||||
conf.Server.Backup.Path,
|
||||
fmt.Sprintf("%s_%s.db", backupPrefix, t.Format(backupSuffixLayout)),
|
||||
)
|
||||
}
|
||||
|
||||
func (d *db) backupOrRestore(ctx context.Context, isBackup bool, path string) error {
|
||||
// heavily inspired by https://codingrabbits.dev/posts/go_and_sqlite_backup_and_maybe_restore/
|
||||
backupDb, err := sql.Open(Driver, path)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer backupDb.Close()
|
||||
|
||||
existingConn, err := d.writeDB.Conn(ctx)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer existingConn.Close()
|
||||
|
||||
backupConn, err := backupDb.Conn(ctx)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer backupConn.Close()
|
||||
|
||||
err = existingConn.Raw(func(existing any) error {
|
||||
return backupConn.Raw(func(backup any) error {
|
||||
var sourceOk, destOk bool
|
||||
var sourceConn, destConn *sqlite3.SQLiteConn
|
||||
|
||||
if isBackup {
|
||||
sourceConn, sourceOk = existing.(*sqlite3.SQLiteConn)
|
||||
destConn, destOk = backup.(*sqlite3.SQLiteConn)
|
||||
} else {
|
||||
sourceConn, sourceOk = backup.(*sqlite3.SQLiteConn)
|
||||
destConn, destOk = existing.(*sqlite3.SQLiteConn)
|
||||
}
|
||||
|
||||
if !sourceOk {
|
||||
return fmt.Errorf("error trying to convert source to sqlite connection")
|
||||
}
|
||||
if !destOk {
|
||||
return fmt.Errorf("error trying to convert destination to sqlite connection")
|
||||
}
|
||||
|
||||
backupOp, err := destConn.Backup("main", sourceConn, "main")
|
||||
if err != nil {
|
||||
return fmt.Errorf("error starting sqlite backup: %w", err)
|
||||
}
|
||||
defer backupOp.Close()
|
||||
|
||||
// Caution: -1 means that sqlite will hold a read lock until the operation finishes
|
||||
// This will lock out other writes that could happen at the same time
|
||||
done, err := backupOp.Step(-1)
|
||||
if !done {
|
||||
return fmt.Errorf("backup not done with step -1")
|
||||
}
|
||||
if err != nil {
|
||||
return fmt.Errorf("error during backup step: %w", err)
|
||||
}
|
||||
|
||||
err = backupOp.Finish()
|
||||
if err != nil {
|
||||
return fmt.Errorf("error finishing backup: %w", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
})
|
||||
})
|
||||
|
||||
return err
|
||||
}
|
||||
|
||||
func prune(ctx context.Context) (int, error) {
|
||||
files, err := os.ReadDir(conf.Server.Backup.Path)
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("unable to read database backup entries: %w", err)
|
||||
}
|
||||
|
||||
var backupTimes []time.Time
|
||||
|
||||
for _, file := range files {
|
||||
if !file.IsDir() {
|
||||
submatch := backupRegex.FindStringSubmatch(file.Name())
|
||||
if len(submatch) == 2 {
|
||||
timestamp, err := time.Parse(backupSuffixLayout, submatch[1])
|
||||
if err == nil {
|
||||
backupTimes = append(backupTimes, timestamp)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if len(backupTimes) <= conf.Server.Backup.Count {
|
||||
return 0, nil
|
||||
}
|
||||
|
||||
slices.SortFunc(backupTimes, func(a, b time.Time) int {
|
||||
return b.Compare(a)
|
||||
})
|
||||
|
||||
pruneCount := 0
|
||||
var errs []error
|
||||
|
||||
for _, timeToPrune := range backupTimes[conf.Server.Backup.Count:] {
|
||||
log.Debug(ctx, "Pruning backup", "time", timeToPrune)
|
||||
path := backupPath(timeToPrune)
|
||||
err = os.Remove(path)
|
||||
if err != nil {
|
||||
errs = append(errs, err)
|
||||
} else {
|
||||
pruneCount++
|
||||
}
|
||||
}
|
||||
|
||||
if len(errs) > 0 {
|
||||
err = errors.Join(errs...)
|
||||
log.Error(ctx, "Failed to delete one or more files", "errors", err)
|
||||
}
|
||||
|
||||
return pruneCount, err
|
||||
}
|
||||
153
db/backup_test.go
Normal file
153
db/backup_test.go
Normal file
|
|
@ -0,0 +1,153 @@
|
|||
package db
|
||||
|
||||
import (
|
||||
"context"
|
||||
"database/sql"
|
||||
"math/rand"
|
||||
"os"
|
||||
"time"
|
||||
|
||||
"github.com/navidrome/navidrome/conf"
|
||||
"github.com/navidrome/navidrome/conf/configtest"
|
||||
. "github.com/onsi/ginkgo/v2"
|
||||
. "github.com/onsi/gomega"
|
||||
)
|
||||
|
||||
func shortTime(year int, month time.Month, day, hour, minute int) time.Time {
|
||||
return time.Date(year, month, day, hour, minute, 0, 0, time.UTC)
|
||||
}
|
||||
|
||||
var _ = Describe("database backups", func() {
|
||||
When("there are a few backup files", func() {
|
||||
var ctx context.Context
|
||||
var timesShuffled []time.Time
|
||||
|
||||
timesDecreasingChronologically := []time.Time{
|
||||
shortTime(2024, 11, 6, 5, 11),
|
||||
shortTime(2024, 11, 6, 5, 8),
|
||||
shortTime(2024, 11, 6, 4, 32),
|
||||
shortTime(2024, 11, 6, 2, 4),
|
||||
shortTime(2024, 11, 6, 1, 52),
|
||||
|
||||
shortTime(2024, 11, 5, 23, 0),
|
||||
shortTime(2024, 11, 5, 6, 4),
|
||||
shortTime(2024, 11, 4, 2, 4),
|
||||
shortTime(2024, 11, 3, 8, 5),
|
||||
shortTime(2024, 11, 2, 5, 24),
|
||||
shortTime(2024, 11, 1, 5, 24),
|
||||
|
||||
shortTime(2024, 10, 31, 5, 9),
|
||||
shortTime(2024, 10, 30, 5, 9),
|
||||
shortTime(2024, 10, 23, 14, 3),
|
||||
shortTime(2024, 10, 22, 3, 6),
|
||||
shortTime(2024, 10, 11, 14, 3),
|
||||
|
||||
shortTime(2024, 9, 21, 19, 5),
|
||||
shortTime(2024, 9, 3, 8, 5),
|
||||
|
||||
shortTime(2024, 7, 5, 1, 1),
|
||||
|
||||
shortTime(2023, 8, 2, 19, 5),
|
||||
|
||||
shortTime(2021, 8, 2, 19, 5),
|
||||
shortTime(2020, 8, 2, 19, 5),
|
||||
}
|
||||
|
||||
BeforeEach(func() {
|
||||
DeferCleanup(configtest.SetupConfig())
|
||||
|
||||
tempFolder, err := os.MkdirTemp("", "navidrome_backup")
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
conf.Server.Backup.Path = tempFolder
|
||||
|
||||
DeferCleanup(func() {
|
||||
_ = os.RemoveAll(tempFolder)
|
||||
})
|
||||
|
||||
timesShuffled = make([]time.Time, len(timesDecreasingChronologically))
|
||||
copy(timesShuffled, timesDecreasingChronologically)
|
||||
rand.Shuffle(len(timesShuffled), func(i, j int) {
|
||||
timesShuffled[i], timesShuffled[j] = timesShuffled[j], timesShuffled[i]
|
||||
})
|
||||
|
||||
for _, time := range timesShuffled {
|
||||
path := backupPath(time)
|
||||
file, err := os.Create(path)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
_ = file.Close()
|
||||
}
|
||||
|
||||
ctx = context.Background()
|
||||
})
|
||||
|
||||
DescribeTable("prune", func(count, expected int) {
|
||||
conf.Server.Backup.Count = count
|
||||
pruneCount, err := prune(ctx)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
for idx, time := range timesDecreasingChronologically {
|
||||
_, err := os.Stat(backupPath(time))
|
||||
shouldExist := idx < conf.Server.Backup.Count
|
||||
if shouldExist {
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
} else {
|
||||
Expect(err).To(MatchError(os.ErrNotExist))
|
||||
}
|
||||
}
|
||||
|
||||
Expect(len(timesDecreasingChronologically) - pruneCount).To(Equal(expected))
|
||||
},
|
||||
Entry("preserve latest 5 backups", 5, 5),
|
||||
Entry("delete all files", 0, 0),
|
||||
Entry("preserve all files when at length", len(timesDecreasingChronologically), len(timesDecreasingChronologically)),
|
||||
Entry("preserve all files when less than count", 10000, len(timesDecreasingChronologically)))
|
||||
})
|
||||
|
||||
Describe("backup and restore", Ordered, func() {
|
||||
var ctx context.Context
|
||||
|
||||
BeforeAll(func() {
|
||||
ctx = context.Background()
|
||||
DeferCleanup(configtest.SetupConfig())
|
||||
|
||||
conf.Server.DbPath = "file::memory:?cache=shared&_foreign_keys=on"
|
||||
DeferCleanup(Init())
|
||||
})
|
||||
|
||||
BeforeEach(func() {
|
||||
tempFolder, err := os.MkdirTemp("", "navidrome_backup")
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
conf.Server.Backup.Path = tempFolder
|
||||
|
||||
DeferCleanup(func() {
|
||||
_ = os.RemoveAll(tempFolder)
|
||||
})
|
||||
})
|
||||
|
||||
It("successfully backups the database", func() {
|
||||
path, err := Db().Backup(ctx)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
|
||||
backup, err := sql.Open(Driver, path)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(isSchemaEmpty(backup)).To(BeFalse())
|
||||
})
|
||||
|
||||
It("successfully restores the database", func() {
|
||||
path, err := Db().Backup(ctx)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
|
||||
// https://stackoverflow.com/questions/525512/drop-all-tables-command
|
||||
_, err = Db().WriteDB().ExecContext(ctx, `
|
||||
PRAGMA writable_schema = 1;
|
||||
DELETE FROM sqlite_master WHERE type in ('table', 'index', 'trigger');
|
||||
PRAGMA writable_schema = 0;
|
||||
`)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(isSchemaEmpty(Db().WriteDB())).To(BeTrue())
|
||||
|
||||
err = Db().Restore(ctx, path)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(isSchemaEmpty(Db().WriteDB())).To(BeFalse())
|
||||
})
|
||||
})
|
||||
})
|
||||
24
db/db.go
24
db/db.go
|
|
@ -1,10 +1,12 @@
|
|||
package db
|
||||
|
||||
import (
|
||||
"context"
|
||||
"database/sql"
|
||||
"embed"
|
||||
"fmt"
|
||||
"runtime"
|
||||
"time"
|
||||
|
||||
"github.com/mattn/go-sqlite3"
|
||||
"github.com/navidrome/navidrome/conf"
|
||||
|
|
@ -29,6 +31,10 @@ type DB interface {
|
|||
ReadDB() *sql.DB
|
||||
WriteDB() *sql.DB
|
||||
Close()
|
||||
|
||||
Backup(ctx context.Context) (string, error)
|
||||
Prune(ctx context.Context) (int, error)
|
||||
Restore(ctx context.Context, path string) error
|
||||
}
|
||||
|
||||
type db struct {
|
||||
|
|
@ -53,6 +59,24 @@ func (d *db) Close() {
|
|||
}
|
||||
}
|
||||
|
||||
func (d *db) Backup(ctx context.Context) (string, error) {
|
||||
destPath := backupPath(time.Now())
|
||||
err := d.backupOrRestore(ctx, true, destPath)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
return destPath, nil
|
||||
}
|
||||
|
||||
func (d *db) Prune(ctx context.Context) (int, error) {
|
||||
return prune(ctx)
|
||||
}
|
||||
|
||||
func (d *db) Restore(ctx context.Context, path string) error {
|
||||
return d.backupOrRestore(ctx, false, path)
|
||||
}
|
||||
|
||||
func Db() DB {
|
||||
return singleton.GetInstance(func() *db {
|
||||
sql.Register(Driver+"_custom", &sqlite3.SQLiteDriver{
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue