[#3066] added the application name as part of the autogenerated backup name for easier identification

core/base_backup.go

@@ -17,6 +17,7 @@ import (
 	"github.com/pocketbase/pocketbase/tools/archive"
 	"github.com/pocketbase/pocketbase/tools/cron"
 	"github.com/pocketbase/pocketbase/tools/filesystem"
+	"github.com/pocketbase/pocketbase/tools/inflector"
 	"github.com/pocketbase/pocketbase/tools/osutils"
 	"github.com/pocketbase/pocketbase/tools/security"
 )
@@ -46,12 +47,8 @@ func (app *BaseApp) CreateBackup(ctx context.Context, name string) error {
 		return errors.New("try again later - another backup/restore operation has already been started")
 	}
 
-	// auto generate backup name
 	if name == "" {
-		name = fmt.Sprintf(
-			"pb_backup_%s.zip",
-			time.Now().UTC().Format("20060102150405"),
-		)
+		name = app.generateBackupName("pb_backup_")
 	}
 
 	app.Cache().Set(CacheKeyActiveBackup, name)
@@ -234,7 +231,6 @@ func (app *BaseApp) RestoreBackup(ctx context.Context, name string) error {
 }
 
 // initAutobackupHooks registers the autobackup app serve hooks.
-// @todo add tests
 func (app *BaseApp) initAutobackupHooks() error {
 	c := cron.New()
 	isServe := false
@@ -248,13 +244,9 @@ func (app *BaseApp) initAutobackupHooks() error {
 		}
 
 		c.Add("@autobackup", rawSchedule, func() {
-			autoPrefix := "@auto_pb_backup_"
+			const autoPrefix = "@auto_pb_backup_"
 
-			name := fmt.Sprintf(
-				"%s%s.zip",
-				autoPrefix,
-				time.Now().UTC().Format("20060102150405"),
-			)
+			name := app.generateBackupName(autoPrefix)
 
 			if err := app.CreateBackup(context.Background(), name); err != nil && app.IsDebug() {
 				// @todo replace after logs generalization
@@ -333,3 +325,17 @@ func (app *BaseApp) initAutobackupHooks() error {
 
 	return nil
 }
+
+func (app *BaseApp) generateBackupName(prefix string) string {
+	appName := inflector.Snakecase(app.Settings().Meta.AppName)
+	if len(appName) > 50 {
+		appName = appName[:50]
+	}
+
+	return fmt.Sprintf(
+		"%s%s_%s.zip",
+		prefix,
+		appName,
+		time.Now().UTC().Format("20060102150405"),
+	)
+}

core/base_backup_test.go

@@ -19,6 +19,11 @@ func TestCreateBackup(t *testing.T) {
 	app, _ := tests.NewTestApp()
 	defer app.Cleanup()
 
+	// set some long app name with spaces and special characters
+	app.Settings().Meta.AppName = "test @! " + strings.Repeat("a", 100)
+
+	expectedAppNamePrefix := "test_" + strings.Repeat("a", 45)
+
 	// test pending error
 	app.Cache().Set(core.CacheKeyActiveBackup, "")
 	if err := app.CreateBackup(context.Background(), "test.zip"); err == nil {
@@ -49,8 +54,8 @@ func TestCreateBackup(t *testing.T) {
 	}
 
 	expectedFiles := []string{
-		`^pb_backup_\w+\.zip$`,
-		`^pb_backup_\w+\.zip.attrs$`,
+		`^pb_backup_` + expectedAppNamePrefix + `_\w+\.zip$`,
+		`^pb_backup_` + expectedAppNamePrefix + `_\w+\.zip.attrs$`,
 		"custom",
 		"custom.attrs",
 	}