Merge pull request #1373 from aryan9600/gep-1323

Add `ResponseHeaderModifier` to `HTTPRouteFilter`
kubernetes-sigs · Sep 23, 2022 · 583e4e2 · 583e4e2
2 parents 522a3b3 + ffa0786
commit 583e4e2
Show file tree

Hide file tree

Showing 13 changed files with 825 additions and 59 deletions.
diff --git a/apis/v1alpha2/grpcroute_types.go b/apis/v1alpha2/grpcroute_types.go
@@ -427,7 +427,7 @@ type GRPCRouteFilter struct {
 	// Support: Core
 	//
 	// +optional
-	RequestHeaderModifier *HTTPRequestHeaderFilter `json:"requestHeaderModifier,omitempty"`
+	RequestHeaderModifier *HTTPHeaderFilter `json:"requestHeaderModifier,omitempty"`
 
 	// RequestMirror defines a schema for a filter that mirrors requests.
 	// Requests are sent to the specified destination, but responses from

diff --git a/apis/v1alpha2/httproute_types.go b/apis/v1alpha2/httproute_types.go
@@ -292,10 +292,10 @@ const (
 // +k8s:deepcopy-gen=false
 type HTTPHeader = v1beta1.HTTPHeader
 
-// HTTPRequestHeaderFilter defines configuration for the RequestHeaderModifier
-// filter.
+// HTTPHeaderFilter defines a filter that modifies the headers of an HTTP request
+// or response.
 // +k8s:deepcopy-gen=false
-type HTTPRequestHeaderFilter = v1beta1.HTTPRequestHeaderFilter
+type HTTPHeaderFilter = v1beta1.HTTPHeaderFilter
 
 // HTTPPathModifierType defines the type of path redirect or rewrite.
 // +k8s:deepcopy-gen=false

diff --git a/apis/v1alpha2/validation/httproute_test.go b/apis/v1alpha2/validation/httproute_test.go
@@ -140,7 +140,7 @@ func TestValidateHTTPRoute(t *testing.T) {
 				Filters: []gatewayv1a2.HTTPRouteFilter{
 					{
 						Type: gatewayv1a2.HTTPRouteFilterRequestHeaderModifier,
-						RequestHeaderModifier: &gatewayv1a2.HTTPRequestHeaderFilter{
+						RequestHeaderModifier: &gatewayv1a2.HTTPHeaderFilter{
 							Set: []gatewayv1a2.HTTPHeader{
 								{
 									Name:  "special-header",
@@ -160,7 +160,7 @@ func TestValidateHTTPRoute(t *testing.T) {
 					},
 					{
 						Type: gatewayv1a2.HTTPRouteFilterRequestHeaderModifier,
-						RequestHeaderModifier: &gatewayv1a2.HTTPRequestHeaderFilter{
+						RequestHeaderModifier: &gatewayv1a2.HTTPHeaderFilter{
 							Add: []gatewayv1a2.HTTPHeader{
 								{
 									Name:  "my-header",
@@ -197,7 +197,7 @@ func TestValidateHTTPRoute(t *testing.T) {
 					},
 					{
 						Type: gatewayv1a2.HTTPRouteFilterRequestHeaderModifier,
-						RequestHeaderModifier: &gatewayv1a2.HTTPRequestHeaderFilter{
+						RequestHeaderModifier: &gatewayv1a2.HTTPHeaderFilter{
 							Set: []gatewayv1a2.HTTPHeader{
 								{
 									Name:  "special-header",
@@ -217,7 +217,7 @@ func TestValidateHTTPRoute(t *testing.T) {
 					},
 					{
 						Type: gatewayv1a2.HTTPRouteFilterRequestHeaderModifier,
-						RequestHeaderModifier: &gatewayv1a2.HTTPRequestHeaderFilter{
+						RequestHeaderModifier: &gatewayv1a2.HTTPHeaderFilter{
 							Add: []gatewayv1a2.HTTPHeader{
 								{
 									Name:  "my-header",
@@ -254,7 +254,7 @@ func TestValidateHTTPRoute(t *testing.T) {
 				Filters: []gatewayv1a2.HTTPRouteFilter{
 					{
 						Type: gatewayv1a2.HTTPRouteFilterRequestHeaderModifier,
-						RequestHeaderModifier: &gatewayv1a2.HTTPRequestHeaderFilter{
+						RequestHeaderModifier: &gatewayv1a2.HTTPHeaderFilter{
 							Set: []gatewayv1a2.HTTPHeader{
 								{
 									Name:  "special-header",
@@ -811,7 +811,7 @@ func TestValidateHTTPRouteTypeMatchesField(t *testing.T) {
 		name: "valid HTTPRouteFilterRequestHeaderModifier route filter",
 		routeFilter: gatewayv1a2.HTTPRouteFilter{
 			Type: gatewayv1a2.HTTPRouteFilterRequestHeaderModifier,
-			RequestHeaderModifier: &gatewayv1a2.HTTPRequestHeaderFilter{
+			RequestHeaderModifier: &gatewayv1a2.HTTPHeaderFilter{
 				Set:    []gatewayv1a2.HTTPHeader{{Name: "name"}},
 				Add:    []gatewayv1a2.HTTPHeader{{Name: "add"}},
 				Remove: []string{"remove"},
@@ -848,7 +848,7 @@ func TestValidateHTTPRouteTypeMatchesField(t *testing.T) {
 		name: "invalid HTTPRouteFilterRequestMirror type filter with non-matching field",
 		routeFilter: gatewayv1a2.HTTPRouteFilter{
 			Type:                  gatewayv1a2.HTTPRouteFilterRequestMirror,
-			RequestHeaderModifier: &gatewayv1a2.HTTPRequestHeaderFilter{},
+			RequestHeaderModifier: &gatewayv1a2.HTTPHeaderFilter{},
 		},
 		errCount: 2,
 	}, {

diff --git a/apis/v1alpha2/zz_generated.deepcopy.go b/apis/v1alpha2/zz_generated.deepcopy.go
diff --git a/apis/v1beta1/httproute_types.go b/apis/v1beta1/httproute_types.go
@@ -580,7 +580,7 @@ type HTTPRouteFilter struct {
 	//
 	// +unionDiscriminator
 	// +kubebuilder:validation:Enum=RequestHeaderModifier;RequestMirror;RequestRedirect;ExtensionRef
-	// <gateway:experimental:validation:Enum=RequestHeaderModifier;RequestMirror;RequestRedirect;URLRewrite;ExtensionRef>
+	// <gateway:experimental:validation:Enum=RequestHeaderModifier;ResponseHeaderModifier;RequestMirror;RequestRedirect;URLRewrite;ExtensionRef>
 	Type HTTPRouteFilterType `json:"type"`
 
 	// RequestHeaderModifier defines a schema for a filter that modifies request
@@ -589,7 +589,16 @@ type HTTPRouteFilter struct {
 	// Support: Core
 	//
 	// +optional
-	RequestHeaderModifier *HTTPRequestHeaderFilter `json:"requestHeaderModifier,omitempty"`
+	RequestHeaderModifier *HTTPHeaderFilter `json:"requestHeaderModifier,omitempty"`
+
+	// ResponseHeaderModifier defines a schema for a filter that modifies response
+	// headers.
+	//
+	// Support: Extended
+	//
+	// +optional
+	// <gateway:experimental>
+	ResponseHeaderModifier *HTTPHeaderFilter `json:"responseHeaderModifier,omitempty"`
 
 	// RequestMirror defines a schema for a filter that mirrors requests.
 	// Requests are sent to the specified destination, but responses from
@@ -639,6 +648,15 @@ const (
 	// Support in HTTPBackendRef: Extended
 	HTTPRouteFilterRequestHeaderModifier HTTPRouteFilterType = "RequestHeaderModifier"
 
+	// HTTPRouteFilterResponseHeaderModifier can be used to add or remove an HTTP
+	// header from an HTTP response before it is sent to the client.
+	//
+	// Support in HTTPRouteRule: Extended
+	//
+	// Support in HTTPBackendRef: Extended
+	// <gateway:experimental>
+	HTTPRouteFilterResponseHeaderModifier HTTPRouteFilterType = "ResponseHeaderModifier"
+
 	// HTTPRouteFilterRequestRedirect can be used to redirect a request to
 	// another location. This filter can also be used for HTTP to HTTPS
 	// redirects. This may not be used on the same Route rule or BackendRef as a
@@ -698,9 +716,9 @@ type HTTPHeader struct {
 	Value string `json:"value"`
 }
 
-// HTTPRequestHeaderFilter defines configuration for the RequestHeaderModifier
-// filter.
-type HTTPRequestHeaderFilter struct {
+// HTTPHeaderFilter defines a filter that modifies the headers of an HTTP request
+// or response.
+type HTTPHeaderFilter struct {
 	// Set overwrites the request with the given header (name, value)
 	// before the action.
 	//

diff --git a/apis/v1beta1/validation/httproute.go b/apis/v1beta1/validation/httproute.go
@@ -224,6 +224,12 @@ func validateHTTPRouteFilterTypeMatchesValue(filter gatewayv1b1.HTTPRouteFilter,
 	if filter.RequestHeaderModifier == nil && filter.Type == gatewayv1b1.HTTPRouteFilterRequestHeaderModifier {
 		errs = append(errs, field.Required(path, "filter.RequestHeaderModifier must be specified for RequestHeaderModifier HTTPRouteFilter.Type"))
 	}
+	if filter.ResponseHeaderModifier != nil && filter.Type != gatewayv1b1.HTTPRouteFilterResponseHeaderModifier {
+		errs = append(errs, field.Invalid(path, filter.ResponseHeaderModifier, "must be nil if the HTTPRouteFilter.Type is not ResponseHeaderModifier"))
+	}
+	if filter.ResponseHeaderModifier == nil && filter.Type == gatewayv1b1.HTTPRouteFilterResponseHeaderModifier {
+		errs = append(errs, field.Required(path, "filter.ResponseHeaderModifier must be specified for ResponseHeaderModifier HTTPRouteFilter.Type"))
+	}
 	if filter.RequestMirror != nil && filter.Type != gatewayv1b1.HTTPRouteFilterRequestMirror {
 		errs = append(errs, field.Invalid(path, filter.RequestMirror, "must be nil if the HTTPRouteFilter.Type is not RequestMirror"))
 	}

diff --git a/apis/v1beta1/validation/httproute_test.go b/apis/v1beta1/validation/httproute_test.go
@@ -140,7 +140,7 @@ func TestValidateHTTPRoute(t *testing.T) {
 				Filters: []gatewayv1b1.HTTPRouteFilter{
 					{
 						Type: gatewayv1b1.HTTPRouteFilterRequestHeaderModifier,
-						RequestHeaderModifier: &gatewayv1b1.HTTPRequestHeaderFilter{
+						RequestHeaderModifier: &gatewayv1b1.HTTPHeaderFilter{
 							Set: []gatewayv1b1.HTTPHeader{
 								{
 									Name:  "special-header",
@@ -160,7 +160,7 @@ func TestValidateHTTPRoute(t *testing.T) {
 					},
 					{
 						Type: gatewayv1b1.HTTPRouteFilterRequestHeaderModifier,
-						RequestHeaderModifier: &gatewayv1b1.HTTPRequestHeaderFilter{
+						RequestHeaderModifier: &gatewayv1b1.HTTPHeaderFilter{
 							Add: []gatewayv1b1.HTTPHeader{
 								{
 									Name:  "my-header",
@@ -174,7 +174,7 @@ func TestValidateHTTPRoute(t *testing.T) {
 		},
 	}, {
 		name:     "invalid httpRoute with multiple duplicate filters",
-		errCount: 2,
+		errCount: 3,
 		rules: []gatewayv1b1.HTTPRouteRule{
 			{
 				Matches: []gatewayv1b1.HTTPRouteMatch{
@@ -197,7 +197,7 @@ func TestValidateHTTPRoute(t *testing.T) {
 					},
 					{
 						Type: gatewayv1b1.HTTPRouteFilterRequestHeaderModifier,
-						RequestHeaderModifier: &gatewayv1b1.HTTPRequestHeaderFilter{
+						RequestHeaderModifier: &gatewayv1b1.HTTPHeaderFilter{
 							Set: []gatewayv1b1.HTTPHeader{
 								{
 									Name:  "special-header",
@@ -217,7 +217,7 @@ func TestValidateHTTPRoute(t *testing.T) {
 					},
 					{
 						Type: gatewayv1b1.HTTPRouteFilterRequestHeaderModifier,
-						RequestHeaderModifier: &gatewayv1b1.HTTPRequestHeaderFilter{
+						RequestHeaderModifier: &gatewayv1b1.HTTPHeaderFilter{
 							Add: []gatewayv1b1.HTTPHeader{
 								{
 									Name:  "my-header",
@@ -226,6 +226,17 @@ func TestValidateHTTPRoute(t *testing.T) {
 							},
 						},
 					},
+					{
+						Type: gatewayv1b1.HTTPRouteFilterResponseHeaderModifier,
+						ResponseHeaderModifier: &gatewayv1b1.HTTPHeaderFilter{
+							Add: []gatewayv1b1.HTTPHeader{
+								{
+									Name:  "extra-header",
+									Value: "foo",
+								},
+							},
+						},
+					},
 					{
 						Type: gatewayv1b1.HTTPRouteFilterRequestMirror,
 						RequestMirror: &gatewayv1b1.HTTPRequestMirrorFilter{
@@ -235,6 +246,17 @@ func TestValidateHTTPRoute(t *testing.T) {
 							},
 						},
 					},
+					{
+						Type: gatewayv1b1.HTTPRouteFilterResponseHeaderModifier,
+						ResponseHeaderModifier: &gatewayv1b1.HTTPHeaderFilter{
+							Set: []gatewayv1b1.HTTPHeader{
+								{
+									Name:  "other-header",
+									Value: "bat",
+								},
+							},
+						},
+					},
 				},
 			},
 		},
@@ -254,7 +276,7 @@ func TestValidateHTTPRoute(t *testing.T) {
 				Filters: []gatewayv1b1.HTTPRouteFilter{
 					{
 						Type: gatewayv1b1.HTTPRouteFilterRequestHeaderModifier,
-						RequestHeaderModifier: &gatewayv1b1.HTTPRequestHeaderFilter{
+						RequestHeaderModifier: &gatewayv1b1.HTTPHeaderFilter{
 							Set: []gatewayv1b1.HTTPHeader{
 								{
 									Name:  "special-header",
@@ -811,7 +833,7 @@ func TestValidateHTTPRouteTypeMatchesField(t *testing.T) {
 		name: "valid HTTPRouteFilterRequestHeaderModifier route filter",
 		routeFilter: gatewayv1b1.HTTPRouteFilter{
 			Type: gatewayv1b1.HTTPRouteFilterRequestHeaderModifier,
-			RequestHeaderModifier: &gatewayv1b1.HTTPRequestHeaderFilter{
+			RequestHeaderModifier: &gatewayv1b1.HTTPHeaderFilter{
 				Set:    []gatewayv1b1.HTTPHeader{{Name: "name"}},
 				Add:    []gatewayv1b1.HTTPHeader{{Name: "add"}},
 				Remove: []string{"remove"},
@@ -848,7 +870,7 @@ func TestValidateHTTPRouteTypeMatchesField(t *testing.T) {
 		name: "invalid HTTPRouteFilterRequestMirror type filter with non-matching field",
 		routeFilter: gatewayv1b1.HTTPRouteFilter{
 			Type:                  gatewayv1b1.HTTPRouteFilterRequestMirror,
-			RequestHeaderModifier: &gatewayv1b1.HTTPRequestHeaderFilter{},
+			RequestHeaderModifier: &gatewayv1b1.HTTPHeaderFilter{},
 		},
 		errCount: 2,
 	}, {

diff --git a/apis/v1beta1/zz_generated.deepcopy.go b/apis/v1beta1/zz_generated.deepcopy.go