chore: implement system module status API with request/response structures and support checker logic

Author: iwanghc

sqle/api/controller/v1/system_module.go

@@ -0,0 +1,64 @@
+package v1
+
+import (
+	"net/http"
+
+	"github.com/actiontech/sqle/sqle/api/controller"
+	"github.com/actiontech/sqle/sqle/server"
+
+	"github.com/labstack/echo/v4"
+)
+
+type GetModuleStatusReqV1 struct {
+	DbType     string `json:"db_type" query:"db_type"`
+	ModuleName string `json:"module_name" query:"module_name"`
+}
+
+type GetModuleStatusResV1 struct {
+	controller.BaseRes
+	Data ModuleStatusRes `json:"data"`
+}
+
+type ModuleStatusRes struct {
+	IsSupported bool `json:"is_supported"`
+}
+
+// @Summary 查询系统功能支持情况信息
+// @Description get module status for module in the system
+// @Id getSystemModuleStatus
+// @Tags system
+// @Security ApiKeyAuth
+// @Param db_type query string false "db type" Enums(MySQL,Oracle,TiDB,OceanBase For MySQL,PostgreSQL,DB2,SQL Server)
+// @Param module_name query string false "module name" Enums(execute_sql_file_mode,sql_optimization,backup,knowledge_base)
+// @Success 200 {object} v1.GetModuleStatusResV1
+// @router /v1/system/module_status [get]
+func GetSystemModuleStatus(c echo.Context) error {
+	req := new(GetModuleStatusReqV1)
+	if err := controller.BindAndValidateReq(c, req); err != nil {
+		return err
+	}
+
+	checker, err := server.NewModuleStatusChecker(req.DbType, req.ModuleName)
+	if err != nil {
+		return controller.JSONBaseErrorReq(c, err)
+	}
+
+	return c.JSON(http.StatusOK, &GetModuleStatusResV1{
+		BaseRes: controller.NewBaseReq(nil),
+		Data: ModuleStatusRes{
+			IsSupported: checker.CheckIsSupport(),
+		},
+	})
+}
+
+type GetSystemModuleRedDotsRes struct {
+	controller.BaseRes
+	Data ModuleRedDots `json:"data"`
+}
+
+type ModuleRedDots []ModuleRedDot
+
+type ModuleRedDot struct {
+	ModuleName string `json:"module_name" enums:"global_dashboard"`
+	HasRedDot  bool   `json:"has_red_dot"`
+}

sqle/cmd/sqled/sqled.go

@@ -2,7 +2,6 @@ package main
 
 import (
 	"fmt"
-	"io/ioutil"
 	"os"
 
 	dmsCommonConf "github.com/actiontech/dms/pkg/dms-common/conf"
@@ -11,7 +10,6 @@ import (
 	"github.com/actiontech/sqle/sqle/log"
 	"github.com/actiontech/sqle/sqle/utils"
 	"github.com/spf13/cobra"
-	yaml "gopkg.in/yaml.v2"
 )
 
 var version string
@@ -81,14 +79,8 @@ func run(cmd *cobra.Command, _ []string) error {
 
 	// read config from file first, then read from cmd args.
 	if configPath != "" {
-		b, err := ioutil.ReadFile(configPath)
-		if err != nil {
-			return fmt.Errorf("load config path: %s failed error :%v", configPath, err)
-		}
-		err = yaml.Unmarshal(b, cfg)
-		if err != nil {
-			return fmt.Errorf("unmarshal config file error %v", err)
-		}
+		config.ParseConfigFile(configPath)
+		cfg = config.GetOptions()
 	} else {
 		mysqlPass, err := utils.DecodeString(mysqlPass)
 		if err != nil {

sqle/config/config.go

@@ -1,14 +1,45 @@
 package config
 
-import dmsCommonConf "github.com/actiontech/dms/pkg/dms-common/conf"
+import (
+	"fmt"
+	"io/ioutil"
+	"sync"
+
+	dmsCommonConf "github.com/actiontech/dms/pkg/dms-common/conf"
+	"gopkg.in/yaml.v2"
+)
+
+var (
+	options *Options = &Options{}
+	once    sync.Once
+)
+
+// GetOptions 获取配置选项
+func GetOptions() *Options {
+	return options
+}
+
+func ParseConfigFile(configPath string) {
+	once.Do(func() {
+		b, err := ioutil.ReadFile(configPath)
+		if err != nil {
+			panic(fmt.Errorf("load config path: %s failed error :%v", configPath, err))
+		}
+		err = yaml.Unmarshal(b, options)
+		if err != nil {
+			panic(fmt.Errorf("unmarshal config file error %v", err))
+		}
+	})
+}
 
 type Options struct {
 	SqleOptions SqleOptions `yaml:"sqle"`
 }
 type SqleOptions struct {
 	dmsCommonConf.BaseOptions `yaml:",inline"`
-	DMSServerAddress          string     `yaml:"dms_server_address"`
-	Service                   SeviceOpts `yaml:"service"`
+	DMSServerAddress          string             `yaml:"dms_server_address"`
+	Service                   SeviceOpts         `yaml:"service"`
+	OptimizationConfig        OptimizationConfig `yaml:"optimization_config"`
 }
 
 type SeviceOpts struct {
@@ -36,3 +67,8 @@ type PluginConfig struct {
 	PluginName string `yaml:"plugin_name"`
 	CMD        string `yaml:"cmd"`
 }
+
+type OptimizationConfig struct {
+	OptimizationKey string `yaml:"optimization_key"`
+	OptimizationURL string `yaml:"optimization_url"`
+}

sqle/server/support_checker.go

@@ -0,0 +1,30 @@
+package server
+
+import (
+	"fmt"
+
+	"github.com/actiontech/sqle/sqle/config"
+)
+
+const (
+	sqlOptimization string = "sql_optimization"
+)
+
+type StatusChecker interface {
+	CheckIsSupport() bool
+}
+
+func NewModuleStatusChecker(driverType string, moduleName string) (StatusChecker, error) {
+	switch moduleName {
+	case sqlOptimization:
+		return sqlOptimizationChecker{}, nil
+	}
+	return nil, fmt.Errorf("no checker matched")
+}
+
+type sqlOptimizationChecker struct{}
+
+func (s sqlOptimizationChecker) CheckIsSupport() bool {
+	return config.GetOptions().SqleOptions.OptimizationConfig.OptimizationKey != "" &&
+		config.GetOptions().SqleOptions.OptimizationConfig.OptimizationURL != ""
+}