[feat aga] addressing feedback for refactoring

Author: shraddhabang

controllers/aga/globalaccelerator_controller.go

@@ -269,11 +269,11 @@ func (r *globalAcceleratorReconciler) buildModel(ctx context.Context, ga *agaapi
 func (r *globalAcceleratorReconciler) reconcileGlobalAcceleratorResources(ctx context.Context, ga *agaapi.GlobalAccelerator) error {
 	r.logger.Info("Reconciling GlobalAccelerator resources", "globalAccelerator", k8s.NamespacedName(ga))
 
-	// Get all endpoints from GA
-	endpoints := aga.GetAllEndpointsFromGA(ga)
+	// Get all desired endpoints from GA
+	endpoints := aga.GetAllDesiredEndpointsFromGA(ga)
 
 	// Track referenced endpoints
-	r.referenceTracker.UpdateReferencesForGA(ga, endpoints)
+	r.referenceTracker.UpdateDesiredEndpointReferencesForGA(ga, endpoints)
 
 	// Update resource watches with the endpointResourcesManager
 	r.endpointResourcesManager.MonitorEndpointResources(ga, endpoints)

pkg/aga/endpoint_utils.go

@@ -28,8 +28,8 @@ type EndpointReference struct {
 	Endpoint   *agaapi.GlobalAcceleratorEndpoint
 }
 
-// GetAllEndpointsFromGA extracts all endpoint references from a GlobalAccelerator resource
-func GetAllEndpointsFromGA(ga *agaapi.GlobalAccelerator) []EndpointReference {
+// GetAllDesiredEndpointsFromGA extracts all endpoint references from a GlobalAccelerator resource
+func GetAllDesiredEndpointsFromGA(ga *agaapi.GlobalAccelerator) []EndpointReference {
 	if ga == nil || ga.Spec.Listeners == nil {
 		return nil
 	}

pkg/aga/endpoint_utils_test.go

@@ -180,7 +180,7 @@ func TestGetAllEndpointsFromGA(t *testing.T) {
 				}
 			}
 
-			result := GetAllEndpointsFromGA(tt.ga)
+			result := GetAllDesiredEndpointsFromGA(tt.ga)
 
 			// Compare lengths
 			assert.Equal(t, len(tt.expected), len(result))

pkg/aga/reference_tracker.go

@@ -34,8 +34,8 @@ func NewReferenceTracker(logger logr.Logger) *ReferenceTracker {
 	}
 }
 
-// UpdateReferencesForGA updates the tracking information for a GlobalAccelerator
-func (t *ReferenceTracker) UpdateReferencesForGA(ga *agaapi.GlobalAccelerator, endpoints []EndpointReference) {
+// UpdateDesiredEndpointReferencesForGA updates the tracking information for a GlobalAccelerator
+func (t *ReferenceTracker) UpdateDesiredEndpointReferencesForGA(ga *agaapi.GlobalAccelerator, desiredEndpoints []EndpointReference) {
 	t.mutex.Lock()
 	defer t.mutex.Unlock()
 
@@ -45,7 +45,7 @@ func (t *ReferenceTracker) UpdateReferencesForGA(ga *agaapi.GlobalAccelerator, e
 	currentResources := sets.New[ResourceKey]()
 
 	// Process each endpoint
-	for _, endpoint := range endpoints {
+	for _, endpoint := range desiredEndpoints {
 		resourceKey := endpoint.ToResourceKey()
 
 		currentResources.Insert(resourceKey)

pkg/aga/reference_tracker_test.go

@@ -147,9 +147,9 @@ func TestReferenceTracker_UpdateReferencesForGA(t *testing.T) {
 			// Create tracker
 			tracker := NewReferenceTracker(logr.Discard())
 
-			endpoints := GetAllEndpointsFromGA(tt.ga)
+			endpoints := GetAllDesiredEndpointsFromGA(tt.ga)
 			// Update references
-			tracker.UpdateReferencesForGA(tt.ga, endpoints)
+			tracker.UpdateDesiredEndpointReferencesForGA(tt.ga, endpoints)
 
 			// Check number of tracked resources
 			gaKey := types.NamespacedName{Namespace: tt.ga.Namespace, Name: tt.ga.Name}
@@ -212,8 +212,8 @@ func TestReferenceTracker_UpdateReferencesForGA_RemoveStaleReferences(t *testing
 	// Create tracker and add initial references
 	tracker := NewReferenceTracker(logr.Discard())
 
-	endpoints := GetAllEndpointsFromGA(ga)
-	tracker.UpdateReferencesForGA(ga, endpoints)
+	endpoints := GetAllDesiredEndpointsFromGA(ga)
+	tracker.UpdateDesiredEndpointReferencesForGA(ga, endpoints)
 
 	// Verify initial state
 	service1Key := ResourceKey{
@@ -256,8 +256,8 @@ func TestReferenceTracker_UpdateReferencesForGA_RemoveStaleReferences(t *testing
 	}
 
 	// Update references with modified GA
-	endpoints = GetAllEndpointsFromGA(ga)
-	tracker.UpdateReferencesForGA(ga, endpoints)
+	endpoints = GetAllDesiredEndpointsFromGA(ga)
+	tracker.UpdateDesiredEndpointReferencesForGA(ga, endpoints)
 
 	// Verify that service1 is still referenced, service2 is no longer referenced, and service3 is now referenced
 	assert.True(t, tracker.IsResourceReferenced(service1Key))
@@ -328,10 +328,10 @@ func TestReferenceTracker_RemoveGA(t *testing.T) {
 
 	// Create tracker and add references from both GAs
 	tracker := NewReferenceTracker(logr.Discard())
-	endpoints1 := GetAllEndpointsFromGA(ga1)
-	endpoints2 := GetAllEndpointsFromGA(ga2)
-	tracker.UpdateReferencesForGA(ga1, endpoints1)
-	tracker.UpdateReferencesForGA(ga2, endpoints2)
+	endpoints1 := GetAllDesiredEndpointsFromGA(ga1)
+	endpoints2 := GetAllDesiredEndpointsFromGA(ga2)
+	tracker.UpdateDesiredEndpointReferencesForGA(ga1, endpoints1)
+	tracker.UpdateDesiredEndpointReferencesForGA(ga2, endpoints2)
 
 	// Resource keys
 	service1Key := ResourceKey{
@@ -406,8 +406,8 @@ func TestReferenceTracker_IsResourceReferenced(t *testing.T) {
 
 	// Create tracker and add references
 	tracker := NewReferenceTracker(logr.Discard())
-	endpoints := GetAllEndpointsFromGA(ga)
-	tracker.UpdateReferencesForGA(ga, endpoints)
+	endpoints := GetAllDesiredEndpointsFromGA(ga)
+	tracker.UpdateDesiredEndpointReferencesForGA(ga, endpoints)
 
 	// Resource keys - one that exists and one that doesn't
 	existingResourceKey := ResourceKey{
@@ -479,10 +479,10 @@ func TestReferenceTracker_GetGAsForResource(t *testing.T) {
 
 	// Create tracker and add references
 	tracker := NewReferenceTracker(logr.Discard())
-	endpoints1 := GetAllEndpointsFromGA(ga1)
-	endpoints2 := GetAllEndpointsFromGA(ga2)
-	tracker.UpdateReferencesForGA(ga1, endpoints1)
-	tracker.UpdateReferencesForGA(ga2, endpoints2)
+	endpoints1 := GetAllDesiredEndpointsFromGA(ga1)
+	endpoints2 := GetAllDesiredEndpointsFromGA(ga2)
+	tracker.UpdateDesiredEndpointReferencesForGA(ga1, endpoints1)
+	tracker.UpdateDesiredEndpointReferencesForGA(ga2, endpoints2)
 
 	// Resource key for the shared service
 	sharedServiceKey := ResourceKey{

pkg/deploy/aga/listener_synthesizer.go

@@ -220,9 +220,9 @@ type resAndSDKListenerPair struct {
 // matchResAndSDKListeners matches resource listeners with SDK listeners using a multi-phase approach.
 //
 // The algorithm implements a two-phase matching process:
-// 1. First phase (Exact Matching): Matches listeners with identical protocol and port ranges
-// 2. Second phase (Similarity Matching): For remaining unmatched listeners, uses a similarity-based
-//    algorithm to find the best matches based on protocol and port range overlap
+//  1. First phase (Exact Matching): Matches listeners with identical protocol and port ranges
+//  2. Second phase (Similarity Matching): For remaining unmatched listeners, uses a similarity-based
+//     algorithm to find the best matches based on protocol and port range overlap
 //
 // Returns three groups:
 // - matchedResAndSDKListeners: pairs of resource and SDK listeners that will be updated
@@ -499,17 +499,17 @@ func (s *listenerSynthesizer) findConflictingAndNonConflictingListeners(
 // The scoring system uses these components:
 //
 // 1. Base Protocol Score:
-//    - If protocols match: +40 points (significant bonus)
-//    - If protocols don't match: 0 points (no bonus)
+//   - If protocols match: +40 points (significant bonus)
+//   - If protocols don't match: 0 points (no bonus)
 //
 // 2. Port Overlap Score:
-//    - Uses Jaccard similarity: (intersection / union) * 100
-//    - Calculates the percentage of common ports between the two listeners
-//    - Converts port ranges into individual port sets for precise comparison
+//   - Uses Jaccard similarity: (intersection / union) * 100
+//   - Calculates the percentage of common ports between the two listeners
+//   - Converts port ranges into individual port sets for precise comparison
 //
 // 3. Client Affinity Score:
-//    - If both listeners have client affinity specified and they match: +10 points
-//    - Otherwise: 0 points (no bonus)
+//   - If both listeners have client affinity specified and they match: +10 points
+//   - Otherwise: 0 points (no bonus)
 //
 // Note: In the future, we might need to add endpoint matching as well as one of the
 // score components so that we match the listeners with the most endpoint matches