@robsun/create-keystone-app 0.2.15 → 0.4.0

package/template/apps/server/cmd/server/main.go

@@ -1,34 +1,20 @@
 package main
 
 import (
-	"context"
-	"errors"
-	"fmt"
 	"log"
-	"net/http"
-	"os"
-	"os/signal"
-	"strings"
-	"syscall"
-	"time"
 
 	"github.com/gin-gonic/gin"
-	"gorm.io/gorm"
+	swaggerFiles "github.com/swaggo/files"
+	ginSwagger "github.com/swaggo/gin-swagger"
 
 	"github.com/robsuncn/keystone/bootstrap/config"
-	approvalSvc "github.com/robsuncn/keystone/domain/approval/service"
-	"github.com/robsuncn/keystone/domain/service"
-	coreexporter "github.com/robsuncn/keystone/infra/exporter"
-	"github.com/robsuncn/keystone/infra/importer"
-	"github.com/robsuncn/keystone/infra/jobs"
-	"github.com/robsuncn/keystone/infra/jobs/processors"
-	"github.com/robsuncn/keystone/infra/queue"
-	"github.com/robsuncn/keystone/infra/repository"
-	"github.com/robsuncn/keystone/infra/storage"
+	"github.com/robsuncn/keystone/infra/frontend"
+	"github.com/robsuncn/keystone/server"
+	"github.com/robsuncn/keystone/server/modules"
 
-	"__APP_NAME__/apps/server/internal/app/routes"
-	"__APP_NAME__/apps/server/internal/app/startup"
-	"__APP_NAME__/apps/server/internal/modules"
+	"__APP_NAME__/apps/server/docs"
+	appfrontend "__APP_NAME__/apps/server/internal/frontend"
+	appmodules "__APP_NAME__/apps/server/internal/modules"
 )
 
 func main() {
@@ -36,178 +22,34 @@ func main() {
 	if err != nil {
 		log.Fatalf("failed to load config: %v", err)
 	}
-	applyLocalDefaults(cfg)
 
-	if err := approvalSvc.RegisterDefaultSchemas(); err != nil {
-		log.Fatalf("failed to register approval schemas: %v", err)
-	}
-
-	cfg.Modules.Enabled = ensureModuleEnabled(cfg.Modules.Enabled, "keystone")
-
-	modules.RegisterAll()
-
-	db, err := startup.InitializeDatabase(cfg)
-	if err != nil {
-		log.Fatalf("database initialization failed: %v", err)
-	}
+	registry := modules.NewRegistry()
+	appmodules.Register(registry)
 
-	setGinMode(cfg)
+	builder := server.NewBuilder(cfg).
+		WithModuleRegistry(registry).
+		WithRouterHook(registerSwagger)
 
-	jobQueue := initQueue(cfg)
-	router := routes.SetupRouter(cfg, db, jobQueue)
-
-	blacklistRepo := repository.NewTokenBlacklistRepository(db)
-	loginLogRepo := repository.NewLoginLogRepository(db)
-	auditLogRepo := repository.NewAuditLogRepository(db)
-	stopCleanup := jobs.StartCleanupJobs(blacklistRepo, loginLogRepo, auditLogRepo)
-
-	stopWorker := startJobWorker(cfg, db, jobQueue)
-
-	port := ""
-	if cfg != nil {
-		port = strings.TrimSpace(cfg.Server.Port)
-	}
-	if envPort := strings.TrimSpace(os.Getenv("PORT")); envPort != "" {
-		port = envPort
-	}
-	if port == "" {
-		port = "8080"
+	if fsys, err := appfrontend.GetFileSystem(); err == nil {
+		builder.WithEmbeddedFrontend(fsys, frontend.Options{
+			APIPrefixes:         []string{"/api"},
+			EnablePrecompressed: true,
+		})
 	}
 
-	server := &http.Server{
-		Addr:    fmt.Sprintf(":%s", port),
-		Handler: router,
-	}
-
-	go func() {
-		log.Printf("Starting server on port %s in %s mode", port, cfg.Server.Mode)
-		if err := server.ListenAndServe(); err != nil && err != http.ErrServerClosed {
-			log.Fatalf("failed to start server: %v", err)
-		}
-	}()
-
-	quit := make(chan os.Signal, 1)
-	signal.Notify(quit, os.Interrupt, syscall.SIGTERM)
-	<-quit
-
-	if stopCleanup != nil {
-		stopCleanup()
-	}
-	if stopWorker != nil {
-		stopWorker()
+	app, err := builder.Build()
+	if err != nil {
+		log.Fatalf("failed to initialize server: %v", err)
 	}
-
-	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
-	defer cancel()
-	if err := server.Shutdown(ctx); err != nil {
-		log.Printf("shutdown error: %v", err)
+	if err := app.Run(); err != nil {
+		log.Fatalf("server stopped: %v", err)
 	}
 }
 
-func applyLocalDefaults(cfg *config.Config) {
-	if cfg == nil {
+func registerSwagger(router *gin.Engine, cfg *config.Config) {
+	if cfg == nil || !cfg.Server.SwaggerEnabled {
 		return
 	}
-	cfg.Database.Driver = strings.TrimSpace(cfg.Database.Driver)
-	if cfg.Database.Driver == "" {
-		cfg.Database.Driver = "sqlite"
-	}
-	if cfg.Database.Path == "" || cfg.Database.Path == "./data/keystone.db" {
-		cfg.Database.Path = "./data/keystone-local.db"
-	}
-	if strings.TrimSpace(cfg.Server.Mode) == "" {
-		cfg.Server.Mode = "debug"
-	}
-}
-
-func ensureModuleEnabled(enabled []string, name string) []string {
-	if name == "" {
-		return enabled
-	}
-	for _, existing := range enabled {
-		if existing == name {
-			return enabled
-		}
-	}
-	return append(enabled, name)
-}
-
-func setGinMode(cfg *config.Config) {
-	mode := "debug"
-	if cfg != nil {
-		mode = strings.ToLower(strings.TrimSpace(cfg.Server.Mode))
-	}
-	switch mode {
-	case "release":
-		gin.SetMode(gin.ReleaseMode)
-	case "test":
-		gin.SetMode(gin.TestMode)
-	default:
-		gin.SetMode(gin.DebugMode)
-	}
-}
-
-func initQueue(cfg *config.Config) queue.Queue {
-	if cfg == nil {
-		return nil
-	}
-	queueBackend, err := queue.New(cfg.Queue)
-	if err != nil {
-		log.Printf("queue init failed: %v", err)
-		return nil
-	}
-	return queueBackend
-}
-
-func startJobWorker(cfg *config.Config, db *gorm.DB, jobQueue queue.Queue) func() {
-	if cfg == nil || db == nil || jobQueue == nil {
-		return nil
-	}
-
-	jobRepo := repository.NewJobRepository(db)
-	jobSvc := service.NewJobService(db, jobRepo)
-	notificationRepo := repository.NewNotificationRepository(db)
-	notificationSvc := service.NewNotificationService(db, notificationRepo)
-
-	jobRegistry := jobs.NewRegistry()
-
-	storageSvc, storageErr := storage.New(cfg.Storage)
-	if storageErr != nil {
-		log.Printf("storage init failed for jobs: %v", storageErr)
-	}
-	if storageSvc != nil {
-		importSvc := importer.NewService(storageSvc).
-			WithProgressTracker(func(job queue.Job) importer.ProgressTracker {
-				return importer.JobProgressTracker{JobID: job.ID, TenantID: job.TenantID, Jobs: jobSvc}
-			})
-		exportSvc := coreexporter.NewService(storageSvc).
-			WithProgressTracker(func(job queue.Job) coreexporter.ProgressTracker {
-				return coreexporter.JobProgressTracker{JobID: job.ID, TenantID: job.TenantID, Jobs: jobSvc}
-			})
-		importProcessor := processors.NewImportJobProcessor(importSvc, notificationSvc)
-		if err := jobs.RegisterImportJob(jobRegistry, importProcessor); err != nil {
-			log.Printf("import job registration failed: %v", err)
-		}
-		exportProcessor := processors.NewExportJobProcessor(exportSvc, notificationSvc)
-		if err := jobs.RegisterExportJob(jobRegistry, exportProcessor); err != nil {
-			log.Printf("export job registration failed: %v", err)
-		}
-	}
-
-	if err := jobs.RegisterNotificationJob(jobRegistry, notificationSvc); err != nil {
-		log.Printf("notification job registration failed: %v", err)
-	}
-	if err := modules.RegisterJobs(cfg.Modules.Enabled, jobRegistry); err != nil {
-		log.Printf("module job registration failed: %v", err)
-	}
-
-	executor := jobs.NewExecutor(jobRegistry, jobSvc)
-	worker := queue.Worker{Queue: jobQueue, Handler: executor}
-	workerCtx, cancelWorker := context.WithCancel(context.Background())
-	go func() {
-		if err := worker.Run(workerCtx); err != nil && !errors.Is(err, context.Canceled) {
-			log.Printf("worker stopped: %v", err)
-		}
-	}()
-	return cancelWorker
+	docs.SwaggerInfo.BasePath = "/api/v1"
+	router.GET("/api/docs/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
 }

package/template/apps/server/config.example.yaml

@@ -6,7 +6,6 @@ server:
 modules:
   enabled:
     - "keystone"
-    - "example"
 
 database:
   driver: "sqlite"
@@ -26,6 +25,12 @@ jwt:
 approval:
   callback_secret: ""
 
+export:
+  max_rows: 50000
+  max_duration_seconds: 300
+  retry_max: 2
+  retry_backoff_seconds: 2
+
 pdf:
   font_path: ""
 
@@ -49,3 +54,28 @@ storage:
     access_key: ""
     secret_key: ""
     use_ssl: true
+
+telemetry:
+  enabled: false
+  service_name: "keystone"
+  environment: "local"
+  trace_enabled: true
+  metrics_enabled: true
+  metrics_path: "/metrics"
+  otlp_endpoint: ""
+  otlp_insecure: true
+  log_format: "text"
+  log_level: ""
+  trace_sample_ratio: 0.1
+
+cache:
+  driver: "memory"
+  prefix: "keystone"
+  redis:
+    addr: "localhost:6379"
+    password: ""
+    db: 0
+  ttl:
+    permissions_seconds: 300
+    settings_seconds: 1800
+    approval_seconds: 900

package/template/apps/server/config.yaml

@@ -6,7 +6,6 @@ server:
 modules:
   enabled:
     - "keystone"
-    - "example"
 
 database:
   driver: "sqlite"
@@ -26,6 +25,12 @@ jwt:
 approval:
   callback_secret: ""
 
+export:
+  max_rows: 50000
+  max_duration_seconds: 300
+  retry_max: 2
+  retry_backoff_seconds: 2
+
 pdf:
   font_path: ""
 
@@ -49,3 +54,28 @@ storage:
     access_key: ""
     secret_key: ""
     use_ssl: true
+
+telemetry:
+  enabled: false
+  service_name: "keystone"
+  environment: "local"
+  trace_enabled: true
+  metrics_enabled: true
+  metrics_path: "/metrics"
+  otlp_endpoint: ""
+  otlp_insecure: true
+  log_format: "text"
+  log_level: ""
+  trace_sample_ratio: 0.1
+
+cache:
+  driver: "memory"
+  prefix: "keystone"
+  redis:
+    addr: "localhost:6379"
+    password: ""
+    db: 0
+  ttl:
+    permissions_seconds: 300
+    settings_seconds: 1800
+    approval_seconds: 900

package/template/apps/server/go.mod

@@ -4,42 +4,56 @@ go 1.24.3
 
 require (
 	github.com/gin-gonic/gin v1.11.0
+	github.com/google/uuid v1.6.0
 	github.com/robsuncn/keystone v0.2.1
 	github.com/swaggo/files v1.0.1
 	github.com/swaggo/gin-swagger v1.6.0
 	github.com/swaggo/swag v1.16.2
+	github.com/xuri/excelize/v2 v2.10.0
+	gorm.io/datatypes v1.2.7
 	gorm.io/gorm v1.31.1
 )
 
 require (
 	filippo.io/edwards25519 v1.1.0 // indirect
+	github.com/ClickHouse/ch-go v0.61.5 // indirect
+	github.com/ClickHouse/clickhouse-go/v2 v2.30.0 // indirect
 	github.com/KyleBanks/depth v1.2.1 // indirect
 	github.com/PuerkitoBio/purell v1.1.1 // indirect
 	github.com/PuerkitoBio/urlesc v0.0.0-20170810143723-de5bf2ad4578 // indirect
-	github.com/bytedance/sonic v1.14.0 // indirect
-	github.com/bytedance/sonic/loader v0.3.0 // indirect
+	github.com/andybalholm/brotli v1.1.1 // indirect
+	github.com/beorn7/perks v1.0.1 // indirect
+	github.com/bytedance/gopkg v0.1.3 // indirect
+	github.com/bytedance/sonic v1.14.2 // indirect
+	github.com/bytedance/sonic/loader v0.4.0 // indirect
+	github.com/cenkalti/backoff/v5 v5.0.3 // indirect
 	github.com/cespare/xxhash/v2 v2.3.0 // indirect
 	github.com/cloudwego/base64x v0.1.6 // indirect
 	github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f // indirect
 	github.com/dustin/go-humanize v1.0.1 // indirect
 	github.com/fsnotify/fsnotify v1.9.0 // indirect
-	github.com/gabriel-vasile/mimetype v1.4.8 // indirect
+	github.com/gabriel-vasile/mimetype v1.4.11 // indirect
 	github.com/gin-contrib/sse v1.1.0 // indirect
 	github.com/glebarez/go-sqlite v1.21.2 // indirect
 	github.com/glebarez/sqlite v1.11.0 // indirect
+	github.com/go-faster/city v1.0.1 // indirect
+	github.com/go-faster/errors v0.7.1 // indirect
+	github.com/go-logr/logr v1.4.3 // indirect
+	github.com/go-logr/stdr v1.2.2 // indirect
 	github.com/go-openapi/jsonpointer v0.19.5 // indirect
 	github.com/go-openapi/jsonreference v0.19.6 // indirect
 	github.com/go-openapi/spec v0.20.4 // indirect
 	github.com/go-openapi/swag v0.19.15 // indirect
 	github.com/go-playground/locales v0.14.1 // indirect
 	github.com/go-playground/universal-translator v0.18.1 // indirect
-	github.com/go-playground/validator/v10 v10.27.0 // indirect
+	github.com/go-playground/validator/v10 v10.28.0 // indirect
 	github.com/go-sql-driver/mysql v1.8.1 // indirect
 	github.com/go-viper/mapstructure/v2 v2.4.0 // indirect
-	github.com/goccy/go-json v0.10.2 // indirect
-	github.com/goccy/go-yaml v1.18.0 // indirect
+	github.com/goccy/go-json v0.10.5 // indirect
+	github.com/goccy/go-yaml v1.19.0 // indirect
 	github.com/golang-jwt/jwt/v5 v5.3.0 // indirect
-	github.com/google/uuid v1.6.0 // indirect
+	github.com/grpc-ecosystem/grpc-gateway/v2 v2.27.3 // indirect
+	github.com/hashicorp/go-version v1.6.0 // indirect
 	github.com/jackc/pgpassfile v1.0.0 // indirect
 	github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 // indirect
 	github.com/jackc/pgx/v5 v5.6.0 // indirect
@@ -48,21 +62,35 @@ require (
 	github.com/jinzhu/now v1.1.5 // indirect
 	github.com/josharian/intern v1.0.0 // indirect
 	github.com/json-iterator/go v1.1.12 // indirect
+	github.com/klauspost/compress v1.18.0 // indirect
 	github.com/klauspost/cpuid/v2 v2.3.0 // indirect
 	github.com/leodido/go-urn v1.4.0 // indirect
 	github.com/mailru/easyjson v0.7.6 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect
-	github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421 // indirect
+	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
+	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
 	github.com/nicksnyder/go-i18n/v2 v2.6.1 // indirect
+	github.com/paulmach/orb v0.11.1 // indirect
 	github.com/pelletier/go-toml/v2 v2.2.4 // indirect
-	github.com/quic-go/qpack v0.5.1 // indirect
-	github.com/quic-go/quic-go v0.54.0 // indirect
+	github.com/phpdave11/gofpdf v1.4.3 // indirect
+	github.com/pierrec/lz4/v4 v4.1.21 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
+	github.com/prometheus/client_golang v1.23.2 // indirect
+	github.com/prometheus/client_model v0.6.2 // indirect
+	github.com/prometheus/common v0.67.4 // indirect
+	github.com/prometheus/otlptranslator v1.0.0 // indirect
+	github.com/prometheus/procfs v0.19.2 // indirect
+	github.com/quic-go/qpack v0.6.0 // indirect
+	github.com/quic-go/quic-go v0.57.1 // indirect
 	github.com/redis/go-redis/v9 v9.17.2 // indirect
 	github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec // indirect
 	github.com/richardlehane/mscfb v1.0.4 // indirect
 	github.com/richardlehane/msoleps v1.0.4 // indirect
+	github.com/robfig/cron/v3 v3.0.1 // indirect
 	github.com/sagikazarmark/locafero v0.11.0 // indirect
+	github.com/segmentio/asm v1.2.0 // indirect
+	github.com/shopspring/decimal v1.4.0 // indirect
 	github.com/sourcegraph/conc v0.3.1-0.20240121214520-5f936abd7ae8 // indirect
 	github.com/spf13/afero v1.15.0 // indirect
 	github.com/spf13/cast v1.10.0 // indirect
@@ -71,25 +99,39 @@ require (
 	github.com/subosito/gotenv v1.6.0 // indirect
 	github.com/tiendc/go-deepcopy v1.7.1 // indirect
 	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
-	github.com/ugorji/go/codec v1.3.0 // indirect
+	github.com/ugorji/go/codec v1.3.1 // indirect
 	github.com/xuri/efp v0.0.1 // indirect
-	github.com/xuri/excelize/v2 v2.10.0 // indirect
 	github.com/xuri/nfp v0.0.2-0.20250530014748-2ddeb826f9a9 // indirect
-	go.uber.org/mock v0.5.0 // indirect
+	go.opentelemetry.io/auto/sdk v1.2.1 // indirect
+	go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin v0.64.0 // indirect
+	go.opentelemetry.io/otel v1.39.0 // indirect
+	go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.39.0 // indirect
+	go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.39.0 // indirect
+	go.opentelemetry.io/otel/exporters/prometheus v0.61.0 // indirect
+	go.opentelemetry.io/otel/metric v1.39.0 // indirect
+	go.opentelemetry.io/otel/sdk v1.39.0 // indirect
+	go.opentelemetry.io/otel/sdk/metric v1.39.0 // indirect
+	go.opentelemetry.io/otel/trace v1.39.0 // indirect
+	go.opentelemetry.io/proto/otlp v1.9.0 // indirect
+	go.yaml.in/yaml/v2 v2.4.3 // indirect
 	go.yaml.in/yaml/v3 v3.0.4 // indirect
-	golang.org/x/arch v0.20.0 // indirect
+	golang.org/x/arch v0.23.0 // indirect
 	golang.org/x/crypto v0.46.0 // indirect
-	golang.org/x/mod v0.30.0 // indirect
 	golang.org/x/net v0.47.0 // indirect
 	golang.org/x/sync v0.19.0 // indirect
 	golang.org/x/sys v0.39.0 // indirect
 	golang.org/x/text v0.32.0 // indirect
 	golang.org/x/tools v0.39.0 // indirect
-	google.golang.org/protobuf v1.36.9 // indirect
+	google.golang.org/genproto/googleapis/api v0.0.0-20251202230838-ff82c1b0f217 // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20251202230838-ff82c1b0f217 // indirect
+	google.golang.org/grpc v1.77.0 // indirect
+	google.golang.org/protobuf v1.36.10 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
-	gorm.io/datatypes v1.2.7 // indirect
-	gorm.io/driver/mysql v1.5.6 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+	gorm.io/driver/clickhouse v0.7.0 // indirect
+	gorm.io/driver/mysql v1.5.7 // indirect
 	gorm.io/driver/postgres v1.6.0 // indirect
+	gorm.io/plugin/opentelemetry v0.1.16 // indirect
 	modernc.org/libc v1.22.5 // indirect
 	modernc.org/mathutil v1.5.0 // indirect
 	modernc.org/memory v1.5.0 // indirect