move ordering gateway-api resources to provider (#6695)

Author: arkodg

internal/cmd/egctl/translate_test.go

@@ -22,7 +22,6 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"sigs.k8s.io/yaml"
 
-	"github.com/envoyproxy/gateway/internal/gatewayapi/resource"
 	"github.com/envoyproxy/gateway/internal/utils/field"
 	"github.com/envoyproxy/gateway/internal/utils/file"
 	"github.com/envoyproxy/gateway/internal/utils/test"
@@ -377,7 +376,6 @@ func TestTranslate(t *testing.T) {
 
 			opts := []cmp.Option{
 				cmpopts.IgnoreFields(metav1.Condition{}, "LastTransitionTime"),
-				cmpopts.IgnoreFields(resource.Resources{}, "serviceMap"),
 			}
 
 			require.Empty(t, cmp.Diff(want, got, opts...))

internal/gatewayapi/backendtrafficpolicy.go

@@ -42,19 +42,7 @@ func (t *Translator) ProcessBackendTrafficPolicies(resources *resource.Resources
 	res := make([]*egv1a1.BackendTrafficPolicy, 0, len(resources.BackendTrafficPolicies))
 
 	backendTrafficPolicies := resources.BackendTrafficPolicies
-
-	// Initially, backendTrafficPolicies sort by creation timestamp
-	// or sort alphabetically by “{namespace}/{name}” if multiple policies share same timestamp.
-	sort.Slice(backendTrafficPolicies, func(i, j int) bool {
-		if backendTrafficPolicies[i].CreationTimestamp.Equal(&(backendTrafficPolicies[j].CreationTimestamp)) {
-			policyKeyI := fmt.Sprintf("%s/%s", backendTrafficPolicies[i].Namespace, backendTrafficPolicies[i].Name)
-			policyKeyJ := fmt.Sprintf("%s/%s", backendTrafficPolicies[j].Namespace, backendTrafficPolicies[j].Name)
-			return policyKeyI < policyKeyJ
-		}
-		// Not identical CreationTimestamps
-
-		return backendTrafficPolicies[i].CreationTimestamp.Before(&(backendTrafficPolicies[j].CreationTimestamp))
-	})
+	// BackendTrafficPolicies are already sorted by the provider layer
 
 	// First build a map out of the routes and gateways for faster lookup since users might have thousands of routes or more.
 	routeMap := map[policyTargetRouteKey]*policyRouteTargetContext{}

internal/gatewayapi/clienttrafficpolicy.go

@@ -45,19 +45,7 @@ func (t *Translator) ProcessClientTrafficPolicies(
 	var res []*egv1a1.ClientTrafficPolicy
 
 	clientTrafficPolicies := resources.ClientTrafficPolicies
-
-	// Initially, clientTrafficPolicies sort by creation timestamp
-	// or sort alphabetically by “{namespace}/{name}” if multiple policies share same timestamp.
-	sort.Slice(clientTrafficPolicies, func(i, j int) bool {
-		if clientTrafficPolicies[i].CreationTimestamp.Equal(&(clientTrafficPolicies[j].CreationTimestamp)) {
-			policyKeyI := fmt.Sprintf("%s/%s", clientTrafficPolicies[i].Namespace, clientTrafficPolicies[i].Name)
-			policyKeyJ := fmt.Sprintf("%s/%s", clientTrafficPolicies[j].Namespace, clientTrafficPolicies[j].Name)
-			return policyKeyI < policyKeyJ
-		}
-		// Not identical CreationTimestamps
-
-		return clientTrafficPolicies[i].CreationTimestamp.Before(&(clientTrafficPolicies[j].CreationTimestamp))
-	})
+	// ClientTrafficPolicies are already sorted by the provider layer
 
 	policyMap := make(map[types.NamespacedName]sets.Set[string])
 

internal/gatewayapi/envoyextensionpolicy.go

@@ -42,19 +42,7 @@ func (t *Translator) ProcessEnvoyExtensionPolicies(envoyExtensionPolicies []*egv
 	xdsIR resource.XdsIRMap,
 ) []*egv1a1.EnvoyExtensionPolicy {
 	var res []*egv1a1.EnvoyExtensionPolicy
-
-	// Initially, policies sort by creation timestamp
-	// or sort alphabetically by “{namespace}/{name}” if multiple gateways share same timestamp.
-	sort.Slice(envoyExtensionPolicies, func(i, j int) bool {
-		if envoyExtensionPolicies[i].CreationTimestamp.Equal(&(envoyExtensionPolicies[j].CreationTimestamp)) {
-			policyKeyI := fmt.Sprintf("%s/%s", envoyExtensionPolicies[i].Namespace, envoyExtensionPolicies[i].Name)
-			policyKeyJ := fmt.Sprintf("%s/%s", envoyExtensionPolicies[j].Namespace, envoyExtensionPolicies[j].Name)
-			return policyKeyI < policyKeyJ
-		}
-		// Not identical CreationTimestamps
-
-		return envoyExtensionPolicies[i].CreationTimestamp.Before(&(envoyExtensionPolicies[j].CreationTimestamp))
-	})
+	// EnvoyExtensionPolicies are already sorted by the provider layer
 
 	// First build a map out of the routes and gateways for faster lookup since users might have thousands of routes or more.
 	routeMap := map[policyTargetRouteKey]*policyRouteTargetContext{}

internal/gatewayapi/envoypatchpolicy.go

@@ -7,7 +7,6 @@ package gatewayapi
 
 import (
 	"fmt"
-	"sort"
 
 	"k8s.io/apimachinery/pkg/types"
 	gwapiv1 "sigs.k8s.io/gateway-api/apis/v1"
@@ -20,22 +19,7 @@ import (
 )
 
 func (t *Translator) ProcessEnvoyPatchPolicies(envoyPatchPolicies []*egv1a1.EnvoyPatchPolicy, xdsIR resource.XdsIRMap) {
-	// Initially, envoyPatchPolicies sort by priority
-	// if the priority is equal, they sort based on creation timestamp
-	// or sort alphabetically by “{namespace}/{name}” if multiple policies share same timestamp.
-	sort.Slice(envoyPatchPolicies, func(i, j int) bool {
-		if envoyPatchPolicies[i].Spec.Priority == envoyPatchPolicies[j].Spec.Priority {
-			if envoyPatchPolicies[i].CreationTimestamp.Equal(&(envoyPatchPolicies[j].CreationTimestamp)) {
-				policyKeyI := fmt.Sprintf("%s/%s", envoyPatchPolicies[i].Namespace, envoyPatchPolicies[i].Name)
-				policyKeyJ := fmt.Sprintf("%s/%s", envoyPatchPolicies[j].Namespace, envoyPatchPolicies[j].Name)
-				return policyKeyI < policyKeyJ
-			}
-			// Not identical CreationTimestamps
-			return envoyPatchPolicies[i].CreationTimestamp.Before(&(envoyPatchPolicies[j].CreationTimestamp))
-		}
-		// Not identical Priorities
-		return envoyPatchPolicies[i].Spec.Priority < envoyPatchPolicies[j].Spec.Priority
-	})
+	// EnvoyPatchPolicies are already sorted by the provider layer (priority, then timestamp, then name)
 
 	for _, policy := range envoyPatchPolicies {
 		var (

internal/gatewayapi/extensionserverpolicy.go

@@ -9,7 +9,6 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
-	"sort"
 	"strings"
 
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
@@ -28,21 +27,7 @@ func (t *Translator) ProcessExtensionServerPolicies(policies []unstructured.Unst
 	xdsIR resource.XdsIRMap,
 ) ([]unstructured.Unstructured, error) {
 	res := []unstructured.Unstructured{}
-
-	// Initially, policies sort by creation timestamp
-	// or sort alphabetically by “{namespace}/{name}” if multiple gateways share same timestamp.
-	sort.Slice(policies, func(i, j int) bool {
-		tsI := policies[i].GetCreationTimestamp()
-		tsJ := policies[j].GetCreationTimestamp()
-		if tsI.Equal(&tsJ) {
-			policyKeyI := fmt.Sprintf("%s/%s", policies[i].GetNamespace(), policies[i].GetName())
-			policyKeyJ := fmt.Sprintf("%s/%s", policies[j].GetNamespace(), policies[j].GetName())
-			return policyKeyI < policyKeyJ
-		}
-		// Not identical CreationTimestamps
-
-		return tsI.Before(&tsJ)
-	})
+	// ExtensionServerPolicies are already sorted by the provider layer
 
 	// First build a map out of the gateways for faster lookup
 	gatewayMap := map[types.NamespacedName]*policyGatewayTargetContext{}

internal/gatewayapi/resource/load.go

@@ -42,6 +42,13 @@ func LoadResourcesFromYAMLBytes(yamlBytes []byte, addMissingResources bool) (*Re
 		return nil, err
 	}
 
+	// Sort to:
+	// 1. ensure identical resources are not retranslated
+	//    and updates are avoided by the watchable layer
+	// 2. ensure gateway-api layer receives resources in order
+	//    which impacts translation output
+	r.Sort()
+
 	return r, nil
 }
 

internal/gatewayapi/resource/load_test.go

@@ -62,7 +62,6 @@ func TestLoadAllSupportedResourcesFromYAMLBytes(t *testing.T) {
 	mustUnmarshal(t, outFile, want)
 
 	opts := []cmp.Option{
-		cmpopts.IgnoreFields(Resources{}, "serviceMap"),
 		cmpopts.EquateEmpty(),
 	}
 	require.Empty(t, cmp.Diff(want, got, opts...))