feat: unified scheduling model (#282)

Author: garethgeorge

backrest.go

@@ -19,6 +19,7 @@ import (
 	"github.com/garethgeorge/backrest/internal/api"
 	"github.com/garethgeorge/backrest/internal/auth"
 	"github.com/garethgeorge/backrest/internal/config"
+	"github.com/garethgeorge/backrest/internal/env"
 	"github.com/garethgeorge/backrest/internal/oplog"
 	"github.com/garethgeorge/backrest/internal/orchestrator"
 	"github.com/garethgeorge/backrest/internal/resticinstaller"
@@ -64,7 +65,7 @@ func main() {
 	var wg sync.WaitGroup
 
 	// Create / load the operation log
-	oplogFile := path.Join(config.DataDir(), "oplog.boltdb")
+	oplogFile := path.Join(env.DataDir(), "oplog.boltdb")
 	oplog, err := oplog.NewOpLog(oplogFile)
 	if err != nil {
 		if !errors.Is(err, bbolt.ErrTimeout) {
@@ -76,7 +77,7 @@ func main() {
 	defer oplog.Close()
 
 	// Create rotating log storage
-	logStore := rotatinglog.NewRotatingLog(path.Join(config.DataDir(), "rotatinglogs"), 14) // 14 days of logs
+	logStore := rotatinglog.NewRotatingLog(path.Join(env.DataDir(), "rotatinglogs"), 14) // 14 days of logs
 	if err != nil {
 		zap.S().Fatalf("error creating rotating log storage: %v", err)
 	}
@@ -112,7 +113,7 @@ func main() {
 
 	// Serve the HTTP gateway
 	server := &http.Server{
-		Addr:    config.BindAddress(),
+		Addr:    env.BindAddress(),
 		Handler: h2c.NewHandler(mux, &http2.Server{}), // h2c is HTTP/2 without TLS for grpc-connect support.
 	}
 
@@ -146,7 +147,7 @@ func init() {
 
 func createConfigProvider() config.ConfigStore {
 	return &config.CachingValidatingStore{
-		ConfigStore: &config.JsonFileStore{Path: config.ConfigFilePath()},
+		ConfigStore: &config.JsonFileStore{Path: env.ConfigFilePath()},
 	}
 }
 
@@ -160,7 +161,7 @@ func onterm(s os.Signal, callback func()) {
 }
 
 func getSecret() []byte {
-	secretFile := path.Join(config.DataDir(), "jwt-secret")
+	secretFile := path.Join(env.DataDir(), "jwt-secret")
 	data, err := os.ReadFile(secretFile)
 	if err == nil {
 		zap.L().Debug("loading auth secret from file")
@@ -172,7 +173,7 @@ func getSecret() []byte {
 	if n, err := rand.Read(secret); err != nil || n != 64 {
 		zap.S().Fatalf("error generating secret: %v", err)
 	}
-	if err := os.MkdirAll(config.DataDir(), 0700); err != nil {
+	if err := os.MkdirAll(env.DataDir(), 0700); err != nil {
 		zap.S().Fatalf("error creating data directory: %v", err)
 	}
 	if err := os.WriteFile(secretFile, secret, 0600); err != nil {

docs/content/2.docs/2.hooks.md

@@ -35,12 +35,14 @@ Variables
 - `SnapshotId:string` - the snapshot ID associated with the operation or empty string if none is associated.
 - `SnapshotStats:restic.BackupProgressEntry` - summary of the current backup operation. This is a struct. See examples below for details.
 - `CurTime:time.Time` - the current time. This is a struct. Format as `{{ .FormatTime .CurTime }}`.
+- `Duration:time.Duration` - the duration of the triggering operation. Format as `{{ .FormatDuration .Duration }}`.
 - `Error:string` - the error message if an error occurred, or empty string if successful.
 
 Functions
 
 - `.Summary` - prints a default summary of the current event.
-- `.FormatTime <time>` - formats a time.Time object e.g. as `2024-02-08T03:00:37Z`
+- `.FormatTime <time>` - formats a time.Time object e.g. as `2024-02-08T03:00:37Z`.
+- `.FormatDuration <duration>` - formats a time.Duration object e.g. as `1h2m3s`.
 - `.FormatSizeBytes <int>` - formats a number as a size in bytes (e.g. 5MB, 10GB, 30TB, etc...)
 - `.ShellEscape <string>` - escapes a string to safely be used in most shell environments. Should not be relied upon as secure for arbitrary input.
 - `.JsonMarshal <any>` - attempts to marshall any value as JSON. Can also be used with literals e.g. to quote a string with escapes i.e. `hello"world` -becomes `"hello\"world"`.