feat(release-v3.4): Enhanced Build, Deployment, and Configuration Management for Optimized Performance and Automation (#1255)

* docs: add openim docs Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com> * docs: add openim images test Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com> * feat: fix openim ci and deployment Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com> * feat: fix openim ci and deployment Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com> * feat: add openim flag api configpath env set Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com> * fix: fix openim push logger Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com> * fix: fix openim config path Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com> * fix: fix openim config path Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com> * fix: fix openim config path Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com> --------- Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com>
2026-05-03 16:45:59 +08:00 · 2023-10-21 15:23:33 +08:00
parent c69d4da8b8
commit 363deff6f8
71 changed files with 508 additions and 1185 deletions
@@ -28,6 +28,7 @@ type ApiCmd struct {
 func NewApiCmd() *ApiCmd {
 	ret := &ApiCmd{NewRootCmd("api")}
 	ret.SetRootCmdPt(ret)
+
 	return ret
 }

@@ -36,11 +37,13 @@ func (a *ApiCmd) AddApi(f func(port int) error) {
 		return f(a.getPortFlag(cmd))
 	}
 }
+
 func (a *ApiCmd) GetPortFromConfig(portType string) int {
 	fmt.Println("GetPortFromConfig:", portType)
 	if portType == constant.FlagPort {
 		return config2.Config.Api.OpenImApiPort[0]
 	} else {
+
 		return 0
 	}
 }
@@ -53,38 +53,76 @@ func WithLogName(logName string) func(*CmdOpts) {
 	}
 }

-func NewRootCmd(name string, opts ...func(*CmdOpts)) (rootCmd *RootCmd) {
-	rootCmd = &RootCmd{Name: name}
-	c := cobra.Command{
-		Use:   "start openIM application",
+func NewRootCmd(name string, opts ...func(*CmdOpts)) *RootCmd {
+	rootCmd := &RootCmd{Name: name}
+	cmd := cobra.Command{
+		Use:   "Start openIM application",
 		Short: fmt.Sprintf(`Start %s `, name),
 		Long:  fmt.Sprintf(`Start %s `, name),
 		PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
-			if err := rootCmd.getConfFromCmdAndInit(cmd); err != nil {
-				panic(err)
-			}
-			cmdOpts := &CmdOpts{}
-			for _, opt := range opts {
-				opt(cmdOpts)
-			}
-			if cmdOpts.loggerPrefixName == "" {
-				cmdOpts.loggerPrefixName = "OpenIM.log.all"
-			}
-			if err := log.InitFromConfig(cmdOpts.loggerPrefixName, name, config.Config.Log.RemainLogLevel, config.Config.Log.IsStdout, config.Config.Log.IsJson, config.Config.Log.StorageLocation, config.Config.Log.RemainRotationCount, config.Config.Log.RotationTime); err != nil {
-				panic(err)
-			}
-			return nil
+			return rootCmd.persistentPreRun(cmd, opts...)
 		},
 	}
-	rootCmd.Command = c
+	rootCmd.Command = cmd
 	rootCmd.addConfFlag()
 	return rootCmd
 }
+
+func (rc *RootCmd) persistentPreRun(cmd *cobra.Command, opts ...func(*CmdOpts)) error {
+	if err := rc.initializeConfiguration(cmd); err != nil {
+		return fmt.Errorf("failed to get configuration from command: %w", err)
+	}
+
+	cmdOpts := rc.applyOptions(opts...)
+
+	if err := rc.initializeLogger(cmdOpts); err != nil {
+		return fmt.Errorf("failed to initialize from config: %w", err)
+	}
+
+	return nil
+}
+
+func (rc *RootCmd) initializeConfiguration(cmd *cobra.Command) error {
+	return rc.getConfFromCmdAndInit(cmd)
+}
+
+func (rc *RootCmd) applyOptions(opts ...func(*CmdOpts)) *CmdOpts {
+	cmdOpts := defaultCmdOpts()
+	for _, opt := range opts {
+		opt(cmdOpts)
+	}
+
+	return cmdOpts
+}
+
+func (rc *RootCmd) initializeLogger(cmdOpts *CmdOpts) error {
+	logConfig := config.Config.Log
+	
+	return log.InitFromConfig(
+		
+		cmdOpts.loggerPrefixName,
+		rc.Name,
+		logConfig.RemainLogLevel,
+		logConfig.IsStdout,
+		logConfig.IsJson,
+		logConfig.StorageLocation,
+		logConfig.RemainRotationCount,
+		logConfig.RotationTime,
+	)
+}
+
+func defaultCmdOpts() *CmdOpts {
+	return &CmdOpts{
+		loggerPrefixName: "OpenIM.log.all",
+	}
+}
+
 func (r *RootCmd) SetRootCmdPt(cmdItf RootCmdPt) {
 	r.cmdItf = cmdItf
 }
+
 func (r *RootCmd) addConfFlag() {
-	r.Command.Flags().StringP(constant.FlagConf, "c", "", "Path to config file folder")
+	r.Command.Flags().StringP(constant.FlagConf, "c", "", "path to config file folder")
 }

 func (r *RootCmd) AddPortFlag() {
@@ -19,32 +19,31 @@ import (
 	"fmt"
 	"os"
 	"path/filepath"
-	"runtime"
-
-	"github.com/openimsdk/open-im-server/v3/pkg/msgprocessor"
-
-	"gopkg.in/yaml.v3"

 	"github.com/OpenIMSDK/protocol/constant"
+	"github.com/openimsdk/open-im-server/v3/pkg/msgprocessor"
+	"gopkg.in/yaml.v3"
 )

 //go:embed version
 var Version string

-var (
-	_, b, _, _ = runtime.Caller(0)
-	// Root folder of this project.
-	Root = filepath.Join(filepath.Dir(b), "../../..")
-)
-
 const (
 	FileName             = "config.yaml"
 	NotificationFileName = "notification.yaml"
 	DefaultFolderPath    = "../config/"
 )

+// getProjectRoot returns the absolute path of the project root directory
+func GetProjectRoot() string {
+	b, _ := filepath.Abs(os.Args[0])
+
+	return filepath.Join(filepath.Dir(b), "../../..")
+}
+
 func GetOptionsByNotification(cfg NotificationConf) msgprocessor.Options {
 	opts := msgprocessor.NewOptions()
+
 	if cfg.UnreadCount {
 		opts = msgprocessor.WithOptions(opts, msgprocessor.WithUnreadCount(true))
 	}
@@ -61,40 +60,38 @@ func GetOptionsByNotification(cfg NotificationConf) msgprocessor.Options {
 }

 func initConfig(config interface{}, configName, configFolderPath string) error {
-	if configFolderPath == "" {
-		configFolderPath = DefaultFolderPath
-	}
-	configPath := filepath.Join(configFolderPath, configName)
-	defer func() {
-		fmt.Println("use config", configPath)
-	}()
-	_, err := os.Stat(configPath)
+	configFolderPath = filepath.Join(configFolderPath, configName)
+	_, err := os.Stat(configFolderPath)
 	if err != nil {
 		if !os.IsNotExist(err) {
-			return err
+			return fmt.Errorf("stat config path error: %w", err)
 		}
-		configPath = filepath.Join(Root, "config", configName)
-	} else {
-		Root = filepath.Dir(configPath)
+		configFolderPath = filepath.Join(GetProjectRoot(), "config", configName)
 	}
-	data, err := os.ReadFile(configPath)
+	data, err := os.ReadFile(configFolderPath)
 	if err != nil {
-		return err
+		return fmt.Errorf("read file error: %w", err)
 	}
 	if err = yaml.Unmarshal(data, config); err != nil {
-		return err
+		return fmt.Errorf("unmarshal yaml error: %w", err)
 	}
+	fmt.Println("use config", configFolderPath)
 	return nil
 }

 func InitConfig(configFolderPath string) error {
-	err := initConfig(&Config, FileName, configFolderPath)
-	if err != nil {
+	if configFolderPath == "" {
+		envConfigPath := os.Getenv("OPENIMCONFIG")
+		if envConfigPath != "" {
+			configFolderPath = envConfigPath
+		} else {
+			configFolderPath = DefaultFolderPath
+		}
+	}
+
+	if err := initConfig(&Config, FileName, configFolderPath); err != nil {
 		return err
 	}
-	err = initConfig(&Config.Notification, NotificationFileName, configFolderPath)
-	if err != nil {
-		return err
-	}
-	return nil
+	
+	return initConfig(&Config.Notification, NotificationFileName, configFolderPath)
 }
@@ -1 +1 @@
-v3.2.0
+v3.3.0