MEDIUM: servers: add support for comments via Metadata field

Author: mjuraga

cmd/struct_equal_generator/generate.tmpl

@@ -103,7 +103,11 @@ func (s {{.Data.Name}}) {{.Name}}(t {{.Data.Name}}, opts ...Options) {{- if eq $
 				}
 
 				for k,v := range s.{{.Name}} {
+				{{- if eq .Name "Metadata" }}
+					if !reflect.DeepEqual(t.{{.Name}}[k], v) {
+				{{- else }}
 					if !t.{{.Name}}[k].Equal(v, opt) {
+				{{- end }}
 						{{- if eq $topLevel.Name "Equal" }}
 							return false
 						{{- else if eq $topLevel.Name "Diff" }}

configuration/misc.go

@@ -1,6 +1,8 @@
 package configuration
 
 import (
+	"encoding/json"
+
 	"github.com/haproxytech/client-native/v6/config-parser/parsers/http/actions"
 
 	"github.com/haproxytech/client-native/v6/misc"
@@ -36,3 +38,27 @@ func modelHdr2ActionHdr(hdrs []*models.ReturnHeader) []*actions.Hdr {
 	}
 	return headers
 }
+
+func parseMetadata(comment string) map[string]interface{} {
+	if comment == "" {
+		return nil
+	}
+	metadata := make(map[string]interface{})
+	err := json.Unmarshal([]byte(comment), &metadata)
+	if err != nil {
+		metadata["comment"] = comment
+		return metadata
+	}
+	return metadata
+}
+
+func serializeMetadata(metadata map[string]interface{}) (string, error) {
+	if metadata == nil {
+		return "", nil
+	}
+	b, err := json.Marshal(metadata)
+	if err != nil {
+		return "", err
+	}
+	return string(b), nil
+}

configuration/server.go

@@ -511,6 +511,7 @@ func ParseServer(ondiskServer types.Server) *models.Server {
 	}
 	s.Address = address
 	s.Port = port
+	s.Metadata = parseMetadata(ondiskServer.Comment)
 	for _, p := range ondiskServer.Params {
 		if v, ok := p.(*params.ServerOptionValue); ok {
 			if v.Name == "id" {
@@ -861,6 +862,8 @@ func SerializeServer(s models.Server, opt *options.ConfigurationOptions) types.S
 	} else {
 		server.Address = misc.SanitizeIPv6Address(s.Address)
 	}
+	comment, _ := serializeMetadata(s.Metadata)
+	server.Comment = comment
 	server.Params = serializeServerParams(s.ServerParams, opt)
 	if s.ID != nil {
 		server.Params = append(server.Params, &params.ServerOptionValue{Name: "id", Value: strconv.FormatInt(*s.ID, 10)})

models/server.go

@@ -4193,6 +4193,9 @@ definitions:
           id:
             type: integer
             x-nullable: true
+          metadata:
+            additionalProperties:
+              type: object
           name:
             pattern: ^[^\s]+$
             type: string

models/server_compare.go

@@ -25,6 +25,9 @@ server:
         id:
           type: integer
           x-nullable: true
+        metadata:
+          additionalProperties:
+            type: object
   additionalProperties: false
   example:
     name: www

models/server_compare_test.go

@@ -726,8 +726,8 @@ backend test
   external-check command /bin/false
   use-server webserv if TRUE
   use-server webserv2 unless TRUE
-  server webserv 192.168.1.1:9200 maxconn 1000 ssl weight 10 inter 2s cookie BLAH slowstart 6000 proxy-v2-options authority,crc32c ws h1 pool-low-conn 128 id 1234 pool-purge-delay 10s tcp-ut 2s curves secp384r1 client-sigalgs ECDSA+SHA256:RSA+SHA256 sigalgs ECDSA+SHA256 log-bufsize 10 set-proxy-v2-tlv-fmt(0x20) %[fc_pp_tlv(0x20)]
-  server webserv2 192.168.1.1:9300 maxconn 1000 ssl weight 10 inter 2s cookie BLAH slowstart 6000 proxy-v2-options authority,crc32c ws h1 pool-low-conn 128 hash-key akey pool-conn-name apoolconnname
+  server webserv 192.168.1.1:9200 maxconn 1000 ssl weight 10 inter 2s cookie BLAH slowstart 6000 proxy-v2-options authority,crc32c ws h1 pool-low-conn 128 id 1234 pool-purge-delay 10s tcp-ut 2s curves secp384r1 client-sigalgs ECDSA+SHA256:RSA+SHA256 sigalgs ECDSA+SHA256 log-bufsize 10 set-proxy-v2-tlv-fmt(0x20) %[fc_pp_tlv(0x20)] # my comment
+  server webserv2 192.168.1.1:9300 maxconn 1000 ssl weight 10 inter 2s cookie BLAH slowstart 6000 proxy-v2-options authority,crc32c ws h1 pool-low-conn 128 hash-key akey pool-conn-name apoolconnname # {"comment": "my structured comment", "id": "my_random_id_for_server"}
   http-request set-dst hdr(x-dst)
   http-request set-dst-port int(4000)
   http-check connect

specification/build/haproxy_spec.yaml

@@ -977,7 +977,10 @@
                     "address": "192.168.1.1",
                     "id": 1234,
                     "name": "webserv",
-                    "port": 9200
+                    "port": 9200,
+                    "metadata": {
+                        "comment": "my comment"
+                    }
                 },
                 "webserv2": {
                     "cookie": "BLAH",
@@ -996,7 +999,11 @@
                     "name": "webserv2",
                     "port": 9300,
                     "pool_conn_name": "apoolconnname",
-                    "hash_key": "akey"
+                    "hash_key": "akey",
+                    "metadata": {
+                        "comment": "my structured comment",
+                        "id": "my_random_id_for_server"
+                    }
                 }
             }
         },