Bug fix for UpstreamServer Fields Logs Displayed as Memory Addresses (#6635)

Author: AlexFenlon

internal/nginx/manager.go

@@ -409,11 +409,39 @@ func (lm *LocalManager) UpdateServersInPlus(upstream string, servers []string, c
 		return fmt.Errorf("error updating servers of %v upstream: %w", upstream, err)
 	}
 
-	nl.Debugf(lm.logger, "Updated servers of %v; Added: %v, Removed: %v, Updated: %v", upstream, added, removed, updated)
+	logAdded := formatUpdateServersInPlusLog(added)
+	logRemoved := formatUpdateServersInPlusLog(removed)
+	logUpdated := formatUpdateServersInPlusLog(updated)
+
+	nl.Debugf(lm.logger, "Updated servers of %v; Added: %+v, Removed: %+v, Updated: %+v", upstream, logAdded, logRemoved, logUpdated)
 
 	return nil
 }
 
+func formatUpdateServersInPlusLog(us []client.UpstreamServer) string {
+	var logEntries []string
+	for _, server := range us {
+		logEntry := fmt.Sprintf("{MaxConns:%v MaxFails:%v Backup:%v Down:%v Weight:%v Server:%v FailTimeout:%v SlowStart:%v Route:%v Service:%v ID:%v Drain:%v}",
+			derefInt(server.MaxConns), derefInt(server.MaxFails), derefBool(server.Backup), derefBool(server.Down), derefInt(server.Weight), server.Server, server.FailTimeout, server.SlowStart, server.Route, server.Service, server.ID, server.Drain)
+		logEntries = append(logEntries, logEntry)
+	}
+	return fmt.Sprintf("[%s]", strings.Join(logEntries, " "))
+}
+
+func derefBool(p *bool) bool {
+	if p != nil {
+		return *p
+	}
+	return false
+}
+
+func derefInt(p *int) int {
+	if p != nil {
+		return *p
+	}
+	return 0
+}
+
 // UpdateStreamServersInPlus updates NGINX Plus stream servers of the given upstream.
 func (lm *LocalManager) UpdateStreamServersInPlus(upstream string, servers []string) error {
 	err := verifyConfigVersion(lm.plusConfigVersionCheckClient, lm.configVersion, lm.verifyClient.timeout)

internal/nginx/manager_test.go

@@ -0,0 +1,108 @@
+package nginx
+
+import (
+	"testing"
+
+	"github.com/nginxinc/nginx-plus-go-client/client"
+)
+
+// Helper functions to create pointers
+func ptrInt(i int) *int    { return &i }
+func ptrBool(b bool) *bool { return &b }
+
+func TestFormatUpdateServersInPlusLog(t *testing.T) {
+	tests := []struct {
+		name     string
+		input    []client.UpstreamServer
+		expected string
+	}{
+		{
+			name:     "Empty input",
+			input:    []client.UpstreamServer{},
+			expected: "[]",
+		},
+		{
+			name: "Single server with all fields set",
+			input: []client.UpstreamServer{
+				{
+					MaxConns:    ptrInt(100),
+					MaxFails:    ptrInt(3),
+					Backup:      ptrBool(true),
+					Down:        ptrBool(false),
+					Weight:      ptrInt(10),
+					Server:      "192.168.1.1:8080",
+					FailTimeout: "30s",
+					SlowStart:   "10s",
+					Route:       "route1",
+					Service:     "serviceA",
+					ID:          0,
+					Drain:       true,
+				},
+			},
+			expected: "[{MaxConns:100 MaxFails:3 Backup:true Down:false Weight:10 Server:192.168.1.1:8080 FailTimeout:30s SlowStart:10s Route:route1 Service:serviceA ID:0 Drain:true}]",
+		},
+		{
+			name: "Multiple servers",
+			input: []client.UpstreamServer{
+				{
+					MaxConns:    ptrInt(50),
+					MaxFails:    ptrInt(2),
+					Backup:      ptrBool(false),
+					Down:        ptrBool(true),
+					Weight:      ptrInt(5),
+					Server:      "192.168.1.2:8080",
+					FailTimeout: "20s",
+					SlowStart:   "5s",
+					Route:       "route2",
+					Service:     "serviceB",
+					ID:          1,
+					Drain:       false,
+				},
+				{
+					MaxConns:    ptrInt(150),
+					MaxFails:    ptrInt(5),
+					Backup:      ptrBool(true),
+					Down:        ptrBool(false),
+					Weight:      ptrInt(15),
+					Server:      "192.168.1.3:8080",
+					FailTimeout: "40s",
+					SlowStart:   "20s",
+					Route:       "route3",
+					Service:     "serviceC",
+					ID:          2,
+					Drain:       true,
+				},
+			},
+			expected: "[{MaxConns:50 MaxFails:2 Backup:false Down:true Weight:5 Server:192.168.1.2:8080 FailTimeout:20s SlowStart:5s Route:route2 Service:serviceB ID:1 Drain:false} {MaxConns:150 MaxFails:5 Backup:true Down:false Weight:15 Server:192.168.1.3:8080 FailTimeout:40s SlowStart:20s Route:route3 Service:serviceC ID:2 Drain:true}]",
+		},
+		{
+			name: "Servers with nil pointer fields",
+			input: []client.UpstreamServer{
+				{
+					MaxConns:    nil, // Should default to 0
+					MaxFails:    ptrInt(4),
+					Backup:      nil, // Should default to false
+					Down:        ptrBool(true),
+					Weight:      nil, // Should default to 0
+					Server:      "192.168.1.4:8080",
+					FailTimeout: "",
+					SlowStart:   "",
+					Route:       "",
+					Service:     "",
+					ID:          0,
+					Drain:       false,
+				},
+			},
+			expected: "[{MaxConns:0 MaxFails:4 Backup:false Down:true Weight:0 Server:192.168.1.4:8080 FailTimeout: SlowStart: Route: Service: ID:0 Drain:false}]",
+		},
+	}
+
+	for _, tc := range tests {
+		t.Run(tc.name, func(t *testing.T) {
+			actual := formatUpdateServersInPlusLog(tc.input)
+			if actual != tc.expected {
+				t.Errorf("FormatUpdateServersInPlusLog() = %v, want %v", actual, tc.expected)
+			}
+		})
+	}
+}