address feedback

Author: QxBytes

cni/network/network.go

@@ -437,7 +437,7 @@ func (plugin *NetPlugin) Add(args *cniSkel.CmdArgs) error {
 			zap.Any("IPs", cniResult.IPs),
 			zap.Error(log.NewErrorWithoutStackTrace(err)))
 
-		telemetryClient.SendEvent(fmt.Sprintf("ADD command completed with [ipamAddResult]: %s [epInfos]: %s [error]: %v ", ipamAddResult.PrettyString(), network.FormatStructPointers(epInfos), err))
+		telemetryClient.SendEvent(fmt.Sprintf("ADD command completed with [ipamAddResult]: %s [epInfos]: %s [error]: %v ", ipamAddResult.PrettyString(), network.FormatSliceOfPointersToString(epInfos), err))
 	}()
 
 	ipamAddResult = IPAMAddResult{interfaceInfo: make(map[string]network.InterfaceInfo)}

network/endpoint.go

@@ -150,7 +150,11 @@ type apipaClient interface {
 	CreateHostNCApipaEndpoint(ctx context.Context, networkContainerID string) (string, error)
 }
 
-func FormatStructPointers[T any](slice []*T) string {
+// FormatSliceOfPointersToString takes in a slice of pointers, and for each pointer, dereferences the pointer if not nil
+// and then formats it to its string representation, returning a string where each line is a separate item in the slice.
+// This is used for convenience to get a string representation of the actual structs and their fields
+// in slices of pointers since the default string representation of a slice of pointers is a list of memory addresses.
+func FormatSliceOfPointersToString[T any](slice []*T) string {
 	var builder strings.Builder
 	for _, ptr := range slice {
 		if ptr != nil {
@@ -174,7 +178,7 @@ func (ifInfo *InterfaceInfo) PrettyString() string {
 		ncresponse = fmt.Sprintf("%+v", *ifInfo.NCResponse)
 	}
 	return fmt.Sprintf("Name:%s NICType:%v MacAddr:%s IPConfigs:%s Routes:%+v DNSInfo:%+v NCResponse: %s",
-		ifInfo.Name, ifInfo.NICType, ifInfo.MacAddress.String(), FormatStructPointers(ifInfo.IPConfigs), ifInfo.Routes, ifInfo.DNS, ncresponse)
+		ifInfo.Name, ifInfo.NICType, ifInfo.MacAddress.String(), FormatSliceOfPointersToString(ifInfo.IPConfigs), ifInfo.Routes, ifInfo.DNS, ncresponse)
 }
 
 // NewEndpoint creates a new endpoint in the network.

network/endpoint_test.go

@@ -34,14 +34,14 @@ var _ = Describe("Test FormatStructPointers", func() {
 	Describe("Test FormatStructPointers", func() {
 		Context("When passing in a slice of pointers", func() {
 			It("Should create a pretty printed string of the contents", func() {
-				result := FormatStructPointers(ptrSlice)
+				result := FormatSliceOfPointersToString(ptrSlice)
 				Expect(result).To(Equal("{Address:{IP:<nil> Mask:<nil>} Gateway:10.10.0.1} \n{Address:{IP:<nil> Mask:<nil>} Gateway:10.10.0.2} \n"))
 			})
 		})
 		Context("When passing in nil", func() {
 			It("Should not error", func() {
 				var empty []*IPConfig
-				result := FormatStructPointers(empty)
+				result := FormatSliceOfPointersToString(empty)
 				Expect(result).To(Equal(""))
 			})
 		})

network/manager.go

@@ -423,7 +423,7 @@ func (nm *networkManager) UpdateEndpointState(eps []*endpoint) error {
 
 	ifnameToIPInfoMap := generateCNSIPInfoMap(eps) // key : interface name, value : IPInfo
 	for key, ipinfo := range ifnameToIPInfoMap {
-		logger.Info("Update endpoint state", zap.String("key", key), zap.String("hnsEndpointID", ipinfo.HnsEndpointID), zap.String("hnsNetworkID", ipinfo.HnsNetworkID),
+		logger.Info("Update endpoint state", zap.String("ifname", key), zap.String("hnsEndpointID", ipinfo.HnsEndpointID), zap.String("hnsNetworkID", ipinfo.HnsNetworkID),
 			zap.String("hostVethName", ipinfo.HostVethName), zap.String("macAddress", ipinfo.MacAddress), zap.String("nicType", string(ipinfo.NICType)))
 	}
 	// we assume all endpoints have the same container id