✨ Add setting (#211)

pkg/cmds/server/server.go

@@ -53,7 +53,6 @@ func Serve(serverConfig ServerConfig) error {
 	e := echo.New()
 	e.HideBanner = true
 	e.HidePort = true
-	// e.Use(middleware.GzipWithConfig(middleware.GzipConfig{Level: 5}))
 	e.Use(echo.MiddlewareFunc(func(next echo.HandlerFunc) echo.HandlerFunc {
 		return func(c echo.Context) error {
 			log.Debug().

pkg/consts/setting.go

@@ -0,0 +1,8 @@
+package consts
+
+const (
+	// SettingSignPrivateKey is the private key for signing
+	SettingSignPrivateKey = "signing.private_key"
+	// SettingSignPublicKey is the public key for signing
+	SettingSignPublicKey = "signing.public_key"
+)

pkg/dal/cmd/gen.go

@@ -53,6 +53,7 @@ func main() {
 		models.WorkQueue{},
 		models.Locker{},
 		models.Cache{},
+		models.Setting{},
 	)
 
 	g.ApplyInterface(func(models.CacheQuery) {}, models.Cache{})

pkg/dal/dao/cache.go

@@ -62,7 +62,7 @@ func (f *cacheServiceFactory) New(txs ...*query.Query) CacheService {
 	}
 }
 
-// Create creates a new work queue record in the database
+// Create creates a new cache record in the database
 func (s cacheService) Save(ctx context.Context, key string, val []byte, size int64, threshold float64) error {
 	total, err := s.tx.Cache.WithContext(ctx).Count()
 	if err != nil {

pkg/dal/dao/setting.go

@@ -0,0 +1,73 @@
+package dao
+
+import (
+	"context"
+
+	"gorm.io/gorm"
+	"gorm.io/gorm/clause"
+
+	"github.com/go-sigma/sigma/pkg/dal/models"
+	"github.com/go-sigma/sigma/pkg/dal/query"
+)
+
+//go:generate mockgen -destination=mocks/setting.go -package=mocks github.com/go-sigma/sigma/pkg/dal/dao SettingService
+//go:generate mockgen -destination=mocks/setting_factory.go -package=mocks github.com/go-sigma/sigma/pkg/dal/dao SettingServiceFactory
+
+// SettingService is the interface that provides methods to operate on setting model
+type SettingService interface {
+	// Save save a new cache record in the database
+	Save(ctx context.Context, key string, val []byte) error
+	// Delete get a cache record
+	Delete(ctx context.Context, key string) error
+	// Get get a cache record
+	Get(ctx context.Context, key string) (*models.Setting, error)
+}
+
+type settingService struct {
+	tx *query.Query
+}
+
+// SettingServiceFactory is the interface that provides the setting service factory methods.
+type SettingServiceFactory interface {
+	New(txs ...*query.Query) SettingService
+}
+
+type settingServiceFactory struct{}
+
+// NewSettingServiceFactory creates a new setting service factory.
+func NewSettingServiceFactory() SettingServiceFactory {
+	return &settingServiceFactory{}
+}
+
+func (f *settingServiceFactory) New(txs ...*query.Query) SettingService {
+	tx := query.Q
+	if len(txs) > 0 {
+		tx = txs[0]
+	}
+	return &settingService{
+		tx: tx,
+	}
+}
+
+// Create creates a new setting record in the database
+func (s settingService) Save(ctx context.Context, key string, val []byte) error {
+	var setting = models.Setting{Key: key, Val: val}
+	return s.tx.Setting.WithContext(ctx).Clauses(clause.OnConflict{UpdateAll: true}).Create(&setting)
+}
+
+// Delete get a cache record
+func (s settingService) Delete(ctx context.Context, key string) error {
+	matched, err := s.tx.Setting.WithContext(ctx).Unscoped().Where(s.tx.Setting.Key.Eq(key)).Delete()
+	if err != nil {
+		return err
+	}
+	if matched.RowsAffected == 0 {
+		return gorm.ErrRecordNotFound
+	}
+	return nil
+}
+
+// Get get a cache record
+func (s settingService) Get(ctx context.Context, key string) (*models.Setting, error) {
+	return s.tx.Setting.WithContext(ctx).Where(s.tx.Setting.Key.Eq(key)).First()
+}

pkg/dal/migrations/mysql/0001_initialize.down.sql

@@ -46,3 +46,9 @@ DROP TABLE IF EXISTS `code_repositories`;
 
 DROP TABLE IF EXISTS `user_recover_codes`;
 
+DROP TABLE IF EXISTS `work_queues`;
+
+DROP TABLE IF EXISTS `caches`;
+
+DROP TABLE IF EXISTS `settings`;
+

pkg/dal/migrations/mysql/0001_initialize.up.sql

@@ -202,7 +202,7 @@ CREATE TABLE IF NOT EXISTS `tags` (
   `id` bigint AUTO_INCREMENT PRIMARY KEY,
   `repository_id` bigint NOT NULL,
   `artifact_id` bigint NOT NULL,
-  `name` varchar(64) NOT NULL,
+  `name` varchar(128) NOT NULL,
   `pushed_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
   `last_pull` timestamp,
   `pull_times` bigint NOT NULL DEFAULT 0,
@@ -423,9 +423,17 @@ CREATE TABLE IF NOT EXISTS `caches` (
   `val` BLOB NOT NULL,
   `created_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
   `updated_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
-  `deleted_at` bigint NOT NULL DEFAULT 0,
-  CONSTRAINT `caches_unique_with_key` UNIQUE (`key`, `deleted_at`)
+  `deleted_at` bigint NOT NULL DEFAULT 0
 );
 
 CREATE INDEX `idx_created_at` ON `caches` (`created_at`);
 
+CREATE TABLE IF NOT EXISTS `settings` (
+  `id` bigint AUTO_INCREMENT PRIMARY KEY,
+  `key` varchar(256) NOT NULL UNIQUE,
+  `val` BLOB,
+  `created_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
+  `updated_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
+  `deleted_at` bigint NOT NULL DEFAULT 0
+);
+

pkg/dal/migrations/postgresql/0001_initialize.down.sql

@@ -48,3 +48,9 @@ DROP TABLE IF EXISTS "code_repositories";
 
 DROP TABLE IF EXISTS "user_recover_codes";
 
+DROP TABLE IF EXISTS "work_queues";
+
+DROP TABLE IF EXISTS "caches";
+
+DROP TABLE IF EXISTS "settings";
+

pkg/dal/migrations/postgresql/0001_initialize.up.sql

@@ -252,7 +252,7 @@ CREATE TABLE IF NOT EXISTS "tags" (
   "id" bigserial PRIMARY KEY,
   "repository_id" bigint NOT NULL,
   "artifact_id" bigint NOT NULL,
-  "name" varchar(64) NOT NULL,
+  "name" varchar(128) NOT NULL,
   "pushed_at" timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
   "last_pull" timestamp,
   "pull_times" bigint NOT NULL DEFAULT 0,
@@ -494,9 +494,17 @@ CREATE TABLE IF NOT EXISTS "caches" (
   "val" bytea NOT NULL,
   "created_at" timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
   "updated_at" timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
-  "deleted_at" integer NOT NULL DEFAULT 0,
-  CONSTRAINT "caches_unique_with_key" UNIQUE ("key", "deleted_at")
+  "deleted_at" integer NOT NULL DEFAULT 0
 );
 
 CREATE INDEX "idx_created_at" ON "caches" ("created_at");
 
+CREATE TABLE IF NOT EXISTS "settings" (
+  "id" bigserial PRIMARY KEY,
+  "key" varchar(256) NOT NULL UNIQUE,
+  "val" bytea,
+  "created_at" timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
+  "updated_at" timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
+  "deleted_at" bigint NOT NULL DEFAULT 0
+);
+

pkg/dal/migrations/sqlite3/0001_initialize.down.sql

@@ -48,3 +48,9 @@ DROP TABLE IF EXISTS `code_repositories`;
 
 DROP TABLE IF EXISTS `user_recover_codes`;
 
+DROP TABLE IF EXISTS `work_queues`;
+
+DROP TABLE IF EXISTS `caches`;
+
+DROP TABLE IF EXISTS `settings`;
+

pkg/dal/migrations/sqlite3/0001_initialize.up.sql

@@ -202,7 +202,7 @@ CREATE TABLE IF NOT EXISTS `tags` (
   `id` integer PRIMARY KEY AUTOINCREMENT,
   `repository_id` integer NOT NULL,
   `artifact_id` integer NOT NULL,
-  `name` varchar(64) NOT NULL,
+  `name` varchar(128) NOT NULL,
   `pushed_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
   `last_pull` timestamp,
   `pull_times` integer NOT NULL DEFAULT 0,
@@ -421,9 +421,17 @@ CREATE TABLE IF NOT EXISTS `caches` (
   `val` BLOB NOT NULL,
   `created_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
   `updated_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
-  `deleted_at` integer NOT NULL DEFAULT 0,
-  CONSTRAINT `caches_unique_with_key` UNIQUE (`key`, `deleted_at`)
+  `deleted_at` integer NOT NULL DEFAULT 0
 );
 
 CREATE INDEX `idx_created_at` ON `caches` (`created_at`);
 
+CREATE TABLE IF NOT EXISTS `settings` (
+  `id` integer PRIMARY KEY AUTOINCREMENT,
+  `key` varchar(256) NOT NULL UNIQUE,
+  `val` BLOB,
+  `created_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
+  `updated_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
+  `deleted_at` integer NOT NULL DEFAULT 0
+);
+

pkg/dal/models/setting.go

@@ -0,0 +1,18 @@
+package models
+
+import (
+	"time"
+
+	"gorm.io/plugin/soft_delete"
+)
+
+// Setting setting
+type Setting struct {
+	CreatedAt time.Time
+	UpdatedAt time.Time
+	DeletedAt soft_delete.DeletedAt `gorm:"softDelete:milli"`
+	ID        int64                 `gorm:"primaryKey"`
+
+	Key string `gorm:"uniqueIndex,size:256"`
+	Val []byte
+}