feat/add_createAndPublishConfig_api (#248)

* feat: add UpsertAndPublishConfigFile interface

* chore: add config UpsertAndPublishConfigFile example

Author: peerless1024

api.go

@@ -151,6 +151,8 @@ type ConfigAPI interface {
 	UpdateConfigFile(namespace, fileGroup, fileName, content string) error
 	// PublishConfigFile publish configuration file
 	PublishConfigFile(namespace, fileGroup, fileName string) error
+	// UpsertAndPublishConfigFile insert and publish configuration file
+	UpsertAndPublishConfigFile(namespace, fileGroup, fileName, content string) error
 }
 
 // ConfigGroupAPI .

api/config_file.go

@@ -41,6 +41,8 @@ type ConfigFileAPI interface {
 	UpdateConfigFile(namespace, fileGroup, fileName, content string) error
 	// PublishConfigFile 发布配置文件
 	PublishConfigFile(namespace, fileGroup, fileName string) error
+	// UpsertAndPublishConfigFile 创建配置文件并发布
+	UpsertAndPublishConfigFile(namespace, fileGroup, fileName, content string) error
 }
 
 type ConfigGroupAPI interface {

api/config_file_impl.go

@@ -82,6 +82,11 @@ func (c *configFileAPI) PublishConfigFile(namespace, fileGroup, fileName string)
 	return c.context.GetEngine().SyncPublishConfigFile(namespace, fileGroup, fileName)
 }
 
+// UpsertAndPublishConfigFile 创建配置文件并发布
+func (c *configFileAPI) UpsertAndPublishConfigFile(namespace, fileGroup, fileName, content string) error {
+	return c.context.GetEngine().SyncUpsertAndPublishConfigFile(namespace, fileGroup, fileName, content)
+}
+
 // SDKContext 获取SDK上下文
 func (c *configFileAPI) SDKContext() SDKContext {
 	return c.context

api_config.go

@@ -93,6 +93,11 @@ func (c *configAPI) PublishConfigFile(namespace, fileGroup, fileName string) err
 	return c.rawAPI.PublishConfigFile(namespace, fileGroup, fileName)
 }
 
+// UpsertAndPublishConfigFile 创建配置文件并发布
+func (c *configAPI) UpsertAndPublishConfigFile(namespace, fileGroup, fileName, content string) error {
+	return c.rawAPI.UpsertAndPublishConfigFile(namespace, fileGroup, fileName, content)
+}
+
 // SDKContext 获取SDK上下文
 func (c *configAPI) SDKContext() api.SDKContext {
 	return c.rawAPI.SDKContext()

examples/configuration/crud/main.go

@@ -103,6 +103,7 @@ func main() {
 	r.GET("/publish", publishHandler)
 	r.GET("/get", getHandler)
 	r.GET("/fetch", fetchHandler)
+	r.GET("/upsertAndPublish", upsertAndPublishHandler)
 	log.Printf("listening at %s\n", port)
 	err = r.Run(port)
 	if err != nil {
@@ -277,6 +278,31 @@ func fetchHandler(c *gin.Context) {
 	c.String(http.StatusOK, "got config file content:\n %s\n", configFileFromFetch.GetContent())
 }
 
+// 创建并发布配置文件
+func upsertAndPublishHandler(c *gin.Context) {
+	var req struct {
+		Namespace string `json:"namespace"`
+		FileGroup string `json:"config-group"`
+		FileName  string `json:"config-name"`
+		Content   string `json:"content"`
+	}
+	// 尝试绑定JSON，如果失败则使用默认参数
+	c.ShouldBindJSON(&req)
+	// 如果请求体中没有传入需要的参数，则从启动参数中取值
+	finalNamespace := getParamValue(req.Namespace, namespace)
+	finalFileGroup := getParamValue(req.FileGroup, fileGroup)
+	finalFileName := getParamValue(req.FileName, fileName)
+	finalContent := getParamValue(req.Content, content)
+
+	if err := configAPI.UpsertAndPublishConfigFile(finalNamespace, finalFileGroup, finalFileName, finalContent); err != nil {
+		log.Printf("failed to upsert and publish config file. err:%+v", err)
+		c.String(http.StatusInternalServerError, "upsert and publish failed: %v", err)
+		return
+	}
+	log.Println("upsert and publish config file success.")
+	c.String(http.StatusOK, "upsert and publish success")
+}
+
 func jsonString(v interface{}) string {
 	b, err := json.Marshal(v)
 	if err != nil {

examples/configuration/encrypt/main.go

@@ -49,7 +49,14 @@ func main() {
 	}
 
 	// 获取远程加密配置文件
-	configFile, err := configAPI.GetConfigFile(namespace, fileGroup, fileName)
+	configFile, err := configAPI.FetchConfigFile(&polaris.GetConfigFileRequest{
+		GetConfigFileRequest: &model.GetConfigFileRequest{
+			Namespace: namespace,
+			FileGroup: fileGroup,
+			FileName:  fileName,
+			Subscribe: true,
+		},
+	})
 	if err != nil {
 		log.Println("fail to get config.", err)
 		return

examples/configuration/fallback/main.go

@@ -38,7 +38,14 @@ func main() {
 	fileGroup := "polaris-config-example"
 	fileName := "example.yaml"
 
-	configFile, err := configAPI.GetConfigFile(namespace, fileGroup, fileName)
+	configFile, err := configAPI.FetchConfigFile(&polaris.GetConfigFileRequest{
+		GetConfigFileRequest: &model.GetConfigFileRequest{
+			Namespace: namespace,
+			FileGroup: fileGroup,
+			FileName:  fileName,
+			Subscribe: true,
+		},
+	})
 	if err != nil {
 		log.Println("fail to get config.", err)
 		return

examples/configuration/group/Makefile

@@ -0,0 +1,20 @@
+GOPATH ?= $(shell go env GOPATH)
+
+# Ensure GOPATH is set before running build process.
+ifeq "$(GOPATH)" ""
+  $(error Please set the environment variable GOPATH before running `make`)
+endif
+
+.PHONY: build
+build: clean
+	go build -o bin *.go
+
+.PHONY: run
+run: build
+	./bin
+
+.PHONY: clean
+clean:
+	rm -f bin
+	rm -rf polaris
+

examples/configuration/group/main.go

@@ -20,7 +20,6 @@ package main
 import (
 	"encoding/json"
 	"flag"
-	"fmt"
 	"log"
 	"sync"
 
@@ -35,30 +34,90 @@ var (
 
 func init() {
 	flag.StringVar(&namesapceVal, "namespace", "default", "namespace")
-	flag.StringVar(&groupVal, "group", "group", "group")
+	flag.StringVar(&groupVal, "group", "polaris-config-example", "group")
+}
+
+// isConfigGroupEqual 比较两个配置组是否相等（忽略数组顺序）
+func isConfigGroupEqual(before, after []*model.SimpleConfigFile) bool {
+	if len(before) != len(after) {
+		return false
+	}
+
+	// 创建 map 用于快速查找和比较
+	beforeMap := make(map[string]*model.SimpleConfigFile)
+	for _, file := range before {
+		key := file.Namespace + "/" + file.FileGroup + "/" + file.FileName
+		beforeMap[key] = file
+	}
+
+	// 检查 after 中的每个文件是否在 before 中存在且内容相同
+	for _, file := range after {
+		key := file.Namespace + "/" + file.FileGroup + "/" + file.FileName
+		beforeFile, exists := beforeMap[key]
+		if !exists {
+			return false
+		}
+		// 比较版本号和 MD5
+		if beforeFile.Version != file.Version || beforeFile.Md5 != file.Md5 {
+			return false
+		}
+	}
+
+	return true
 }
 
 func main() {
 	flag.Parse()
+	log.Printf("Starting config group example with namespace: %s, group: %s", namesapceVal, groupVal)
+
 	configAPI, err := polaris.NewConfigGroupAPI()
 
 	if err != nil {
-		fmt.Println("fail to start example.", err)
+		log.Printf("fail to create ConfigGroupAPI: %v", err)
 		return
 	}
+	log.Println("ConfigGroupAPI created successfully")
 
+	log.Printf("Fetching config group: namespace=%s, group=%s", namesapceVal, groupVal)
 	group, err := configAPI.GetConfigGroup(namesapceVal, groupVal)
 	if err != nil {
-		log.Panic(err)
+		log.Panicf("fail to get config group: %v", err)
 		return
 	}
+
+	// 获取配置组中的所有文件
+	files, revision, success := group.GetFiles()
+	if !success {
+		log.Println("Warning: Failed to get files from config group or group is empty")
+	} else {
+		log.Printf("Config group fetched successfully, revision: %s, file count: %d", revision, len(files))
+	}
+
+	// 打印配置组中的所有文件名
+	if len(files) > 0 {
+		log.Println("Config files in group:")
+		for _, file := range files {
+			log.Printf("  - %s (version: %d, md5: %s)", file.FileName, file.Version, file.Md5)
+		}
+	} else {
+		log.Println("No config files found in group")
+	}
+
+	log.Println("Adding change listener for config group...")
 	group.AddChangeListener(func(event *model.ConfigGroupChangeEvent) {
+		// 判断配置是否真的发生了变化（忽略数组顺序）
+		if isConfigGroupEqual(event.Before, event.After) {
+			//log.Println("Config group polled, but no changes detected (content unchanged)")
+			return
+		}
+
 		before, _ := json.Marshal(event.Before)
 		after, _ := json.Marshal(event.After)
-
 		log.Printf("receive config_group change event\nbefore: %s\nafter: %s", string(before), string(after))
 	})
+	log.Println("Change listener added successfully")
 
+	log.Println("Listening for config group changes... Press Ctrl+C to exit")
 	wait := sync.WaitGroup{}
 	wait.Add(1)
 	wait.Wait()

examples/configuration/group/polaris.yaml

@@ -1,8 +1,9 @@
 global:
   serverConnector:
     addresses:
-      - 127.0.0.1:8091
+      - ${POLARIS_SERVER}:8091
 config:
   configConnector:
     addresses:
-      - 127.0.0.1:8093
+      - ${POLARIS_SERVER}:8093
+    token: ${POLARIS_TOKEN}