feat: add schema_version table for future migrations

Author: bclswl0827

cmd/observer/app.go

@@ -31,6 +31,7 @@ import (
 
 	cleaner_close_database "github.com/anyshake/observer/internal/hook/cleaner/close_database"
 	cleaner_close_explorer "github.com/anyshake/observer/internal/hook/cleaner/close_explorer"
+	startup_migrate_database "github.com/anyshake/observer/internal/hook/startup/migrate_database"
 	startup_setup_admin "github.com/anyshake/observer/internal/hook/startup/setup_admin"
 	startup_setup_station "github.com/anyshake/observer/internal/hook/startup/setup_station"
 
@@ -68,7 +69,7 @@ func appStart(ver *semver.Version, build *unibuild.UniBuild, args arguments) {
 	if err := conf.Parse(args.configPath, "json"); err != nil {
 		logger.GetLogger(main).Fatalln(err)
 	}
-	if err := migrateConfig(conf); err != nil {
+	if err := conf.Migrate(logger.GetLogger(main)); err != nil {
 		logger.GetLogger(main).Fatalln(err)
 	}
 	logger.GetLogger(main).Info("global configuration has been loaded")
@@ -114,15 +115,16 @@ func appStart(ver *semver.Version, build *unibuild.UniBuild, args arguments) {
 	}
 	logger.GetLogger(main).Info("database connection has been established")
 
-	if err = daoObj.Migrate(
+	if err = daoObj.AutoMigrate(
+		&model.SchemaVersion{},
 		&model.SeisRecord{},
 		&model.SysUser{},
 		&model.UserSettings{},
 	); err != nil {
 		logger.GetLogger(main).Fatalln(err)
 	}
 	logger.GetLogger(main).Info("database schema has been configured")
-	actionHandler := action.New(daoObj)
+	actionHandler := action.NewHandler(daoObj)
 
 	var hardwareDevice hardware.IHardware
 
@@ -142,6 +144,9 @@ func appStart(ver *semver.Version, build *unibuild.UniBuild, args arguments) {
 
 	stationConfigConstraints := config.NewStationConstraints()
 	startupTasks := []hook.IHook{
+		&startup_migrate_database.MigrateDatabaseStartupImpl{
+			ActionHandler: actionHandler,
+		},
 		&startup_setup_station.SetupStationStartupImpl{
 			ActionHandler:            actionHandler,
 			StationConfigConstraints: stationConfigConstraints,

cmd/observer/migrate.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 
 	"github.com/go-playground/validator/v10"
+	"github.com/sirupsen/logrus"
 	"github.com/spf13/viper"
 )
 
@@ -21,7 +22,7 @@ type hardware struct {
 }
 
 type ntpClient struct {
-	// Endpoint is a deprecated field since v4.2.0, use Pool instead
+	// Deprecated: Endpoint is a deprecated field since v4.2.0, use Pool instead
 	Endpoint string   `mapstructure:"endpoint"`
 	Timeout  int      `mapstructure:"timeout" validate:"gte=0"`
 	Retry    int      `mapstructure:"retry" validate:"gte=0"`
@@ -79,3 +80,14 @@ func (c *BaseConfig) Parse(configPath, configType string) error {
 
 	return nil
 }
+
+func (cfg *BaseConfig) Migrate(logger *logrus.Entry) error {
+	// 2025-08-22: starting from v4.2.0, NTP Client configuration has deprecated the `endpoint` field.
+	if cfg.NtpClient.Endpoint != "" && len(cfg.NtpClient.Pool) == 0 {
+		cfg.NtpClient.Pool = []string{cfg.NtpClient.Endpoint}
+		cfg.NtpClient.Endpoint = ""
+		logger.Warnln("configuration field `ntpclient.endpoint` has been deprecated, please use the `ntpclient.pool` field instead")
+	}
+
+	return nil
+}

config/base.go

@@ -5,3 +5,7 @@ import "github.com/anyshake/observer/internal/dao"
 type Handler struct {
 	daoObj *dao.DAO
 }
+
+func NewHandler(daoObj *dao.DAO) *Handler {
+	return &Handler{daoObj}
+}

internal/dao/action/types.go internal/dao/action/handler.gointernal/dao/action/types.go renamed to internal/dao/action/handler.go

@@ -0,0 +1,69 @@
+package action
+
+import (
+	"time"
+
+	"github.com/anyshake/observer/internal/dao/model"
+	"gorm.io/gorm"
+)
+
+func (h *Handler) SchemaVersionInit() error {
+	var schemaVersion model.SchemaVersion
+
+	var count int64
+	if err := h.daoObj.Database.
+		Table(schemaVersion.GetName(h.daoObj.GetPrefix())).
+		Model(&schemaVersion).
+		Count(&count).
+		Error; err != nil {
+		return err
+	}
+
+	if count == 0 {
+		return h.daoObj.Database.
+			Table(schemaVersion.GetName(h.daoObj.GetPrefix())).
+			Create(&model.SchemaVersion{
+				Version:     1,
+				AppliedAt:   0,
+				Description: "Initial schema since v4.3.4",
+			}).
+			Error
+	}
+
+	return nil
+}
+
+func (h *Handler) SchemaVersionGetCurrent() (int, error) {
+	var sv model.SchemaVersion
+	if err := h.daoObj.Database.
+		Table(sv.GetName(h.daoObj.GetPrefix())).
+		First(&sv).
+		Error; err != nil {
+		return 0, err
+	}
+
+	return sv.Version, nil
+}
+
+func (h *Handler) SchemaVersionUpdate(oldVer, newVer int, description string) error {
+	var sv model.SchemaVersion
+
+	result := h.daoObj.Database.
+		Table(sv.GetName(h.daoObj.GetPrefix())).
+		Model(&sv).
+		Where("id = ? AND version = ?", 1, oldVer).
+		Updates(map[string]any{
+			"version":     newVer,
+			"description": description,
+			"applied_at":  time.Now().UnixMilli(),
+		})
+	if result.Error != nil {
+		return result.Error
+	}
+
+	if result.RowsAffected == 0 {
+		return gorm.ErrInvalidData
+	}
+
+	return nil
+}

internal/dao/action/new.go

@@ -129,7 +129,7 @@ func (h *Handler) SysUserLogin(username, password, userAgent, userIp string) (us
 		user.LastLogin = time.Now().UnixMilli()
 		user.UserAgent = userAgent
 		user.UserIp = userIp
-		err = h.SysUserUpdte(user.UserId, user)
+		err = h.SysUserUpdate(user.UserId, user)
 		if err != nil {
 			return "", fmt.Errorf("failed to update login status: %w", err)
 		}
@@ -138,7 +138,7 @@ func (h *Handler) SysUserLogin(username, password, userAgent, userIp string) (us
 	return user.UserId, nil
 }
 
-func (h *Handler) SysUserUpdte(userId string, user model.SysUser) error {
+func (h *Handler) SysUserUpdate(userId string, user model.SysUser) error {
 	if h.daoObj == nil {
 		return errors.New("database is not opened")
 	}

internal/dao/action/schema_version.go

@@ -4,7 +4,7 @@ import (
 	"fmt"
 )
 
-func (d *DAO) Migrate(tables ...ITable) error {
+func (d *DAO) AutoMigrate(tables ...ITable) error {
 	if d.Database == nil {
 		return fmt.Errorf("database is not opened")
 	}

internal/dao/action/sys_users.go

@@ -0,0 +1,32 @@
+package model
+
+import (
+	"fmt"
+
+	"github.com/anyshake/observer/internal/dao"
+	"gorm.io/gorm"
+)
+
+type SchemaVersion struct {
+	dao.BaseTable
+
+	Version     int    `gorm:"column:version;not null"`
+	Description string `gorm:"column:description;not null"`
+	AppliedAt   int64  `gorm:"column:applied_at;not null"`
+}
+
+func (t *SchemaVersion) GetModel() any {
+	return &SchemaVersion{}
+}
+
+func (t *SchemaVersion) GetName(tablePrefix string) string {
+	return fmt.Sprintf("%s%s", tablePrefix, "schema_version")
+}
+
+func (t *SchemaVersion) UseAutoMigrate() bool {
+	return true
+}
+
+func (t *SchemaVersion) AddPlugins(dbObj *gorm.DB, tablePrefix string) ([]gorm.Plugin, error) {
+	return nil, nil
+}

internal/dao/migrate.go

@@ -0,0 +1,12 @@
+package migrate_database
+
+func (t *MigrateDatabaseStartupImpl) Execute() error {
+	if err := t.ActionHandler.SchemaVersionInit(); err != nil {
+		return err
+	}
+
+	// Manual database schema migrations goes here.
+	// ... will be implemented in the future
+
+	return nil
+}