feat: address Evan's comment to require Equal method on cached results

Author: santhoshmprabhu

nmagent/equality.go

@@ -0,0 +1,51 @@
+package nmagent
+
+// Equal compares two Interfaces objects for equality.
+func (i Interfaces) Equal(other Interfaces) bool {
+	if len(i.Entries) != len(other.Entries) {
+		return false
+	}
+	for idx, entry := range i.Entries {
+		if !entry.Equal(other.Entries[idx]) {
+			return false
+		}
+	}
+	return true
+}
+
+// Equal compares two Interface objects for equality.
+func (i Interface) Equal(other Interface) bool {
+	if len(i.InterfaceSubnets) != len(other.InterfaceSubnets) {
+		return false
+	}
+	for idx, subnet := range i.InterfaceSubnets {
+		if !subnet.Equal(other.InterfaceSubnets[idx]) {
+			return false
+		}
+	}
+	if i.IsPrimary != other.IsPrimary || !i.MacAddress.Equal(other.MacAddress) {
+		return false
+	}
+	return true
+}
+
+// Equal compares two InterfaceSubnet objects for equality.
+func (s InterfaceSubnet) Equal(other InterfaceSubnet) bool {
+	if len(s.IPAddress) != len(other.IPAddress) {
+		return false
+	}
+	if s.Prefix != other.Prefix {
+		return false
+	}
+	for idx, ip := range s.IPAddress {
+		if !ip.Equal(other.IPAddress[idx]) {
+			return false
+		}
+	}
+	return true
+}
+
+// Equal compares two NodeIP objects for equality.
+func (ip NodeIP) Equal(other NodeIP) bool {
+	return ip.IsPrimary == other.IsPrimary && ip.Address.Equal(other.Address)
+}

nmagent/macaddress.go

@@ -14,6 +14,18 @@ const (
 
 type MACAddress net.HardwareAddr
 
+func (h MACAddress) Equal(other MACAddress) bool {
+	if len(h) != len(other) {
+		return false
+	}
+	for i := range h {
+		if h[i] != other[i] {
+			return false
+		}
+	}
+	return true
+}
+
 func (h *MACAddress) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error {
 	var macStr string
 	if err := d.DecodeElement(&macStr, &start); err != nil {

refresh/fetcher.go

@@ -3,8 +3,6 @@ package refresh
 import (
 	"context"
 	"time"
-
-	"github.com/google/go-cmp/cmp"
 )
 
 const (
@@ -17,7 +15,7 @@ const (
 // When a diff is observed, the interval resets to the minimum. The interval can be made unchanging by setting
 // minInterval and maxInterval to the same desired value.
 
-type Fetcher[T any] struct {
+type Fetcher[T Equaler[T]] struct {
 	fetchFunc       func(context.Context) (T, error)
 	cache           T
 	minInterval     time.Duration
@@ -29,7 +27,7 @@ type Fetcher[T any] struct {
 }
 
 // NewFetcher creates a new Fetcher. If minInterval is 0, it will default to 4 seconds.
-func NewFetcher[T any](
+func NewFetcher[T Equaler[T]](
 	fetchFunc func(context.Context) (T, error),
 	minInterval time.Duration,
 	maxInterval time.Duration,
@@ -87,7 +85,7 @@ func (f *Fetcher[T]) Start(ctx context.Context) {
 				if err != nil {
 					f.logger.Errorf("Error fetching data: %v", err)
 				} else {
-					if cmp.Equal(result, f.cache) {
+					if result.Equal(f.cache) {
 						f.updateFetchIntervalForNoObservedDiff()
 						f.logger.Printf("No diff observed in fetch, not invoking the consumer")
 					} else {