update HTTPRequestRedirectPolicy StatusCode to use RedirectResponseCo…

…de (#6789) Use RedirectResponseCode instead of just 301/302 for HTTPRequestRedirectPolicy StatusCode Fixes #6788 Signed-off-by: Billy Schulze <[email protected]>
projectcontour · Feb 6, 2025 · 23c1779 · 23c1779
1 parent 535a0e7
commit 23c1779
Show file tree

Hide file tree

Showing 17 changed files with 47 additions and 18 deletions.
diff --git a/apis/projectcontour/v1/httpproxy.go b/apis/projectcontour/v1/httpproxy.go
@@ -714,8 +714,7 @@ type HTTPRequestRedirectPolicy struct {
 	// StatusCode is the HTTP status code to be used in response.
 	// +optional
 	// +kubebuilder:default=302
-	// +kubebuilder:validation:Enum=301;302
-	StatusCode *int `json:"statusCode,omitempty"`
+	StatusCode *RedirectResponseCode `json:"statusCode,omitempty"`
 
 	// Path allows for redirection to a different path from the
 	// original on the request. The path must start with a

diff --git a/apis/projectcontour/v1/zz_generated.deepcopy.go b/apis/projectcontour/v1/zz_generated.deepcopy.go
diff --git a/changelogs/unreleased/6789-billyjs-small.md b/changelogs/unreleased/6789-billyjs-small.md
@@ -0,0 +1 @@
+`HTTPProxy.spec.routes.requestRedirectPolicy.statusCode` now supports 303, 307 and 308 redirect status codes in addition to 301 and 302.
diff --git a/examples/contour/01-crds.yaml b/examples/contour/01-crds.yaml
@@ -6638,6 +6638,10 @@ spec:
                           enum:
                           - 301
                           - 302
+                          - 303
+                          - 307
+                          - 308
+                          format: int32
                           type: integer
                       type: object
                     responseHeadersPolicy:

diff --git a/examples/render/contour-deployment.yaml b/examples/render/contour-deployment.yaml
@@ -6853,6 +6853,10 @@ spec:
                           enum:
                           - 301
                           - 302
+                          - 303
+                          - 307
+                          - 308
+                          format: int32
                           type: integer
                       type: object
                     responseHeadersPolicy:

diff --git a/examples/render/contour-gateway-provisioner.yaml b/examples/render/contour-gateway-provisioner.yaml
@@ -6649,6 +6649,10 @@ spec:
                           enum:
                           - 301
                           - 302
+                          - 303
+                          - 307
+                          - 308
+                          format: int32
                           type: integer
                       type: object
                     responseHeadersPolicy:

diff --git a/examples/render/contour-gateway.yaml b/examples/render/contour-gateway.yaml
@@ -6674,6 +6674,10 @@ spec:
                           enum:
                           - 301
                           - 302
+                          - 303
+                          - 307
+                          - 308
+                          format: int32
                           type: integer
                       type: object
                     responseHeadersPolicy:

diff --git a/examples/render/contour.yaml b/examples/render/contour.yaml
@@ -6853,6 +6853,10 @@ spec:
                           enum:
                           - 301
                           - 302
+                          - 303
+                          - 307
+                          - 308
+                          format: int32
                           type: integer
                       type: object
                     responseHeadersPolicy:

diff --git a/internal/dag/builder_test.go b/internal/dag/builder_test.go
@@ -12395,7 +12395,7 @@ func TestDAGInsert(t *testing.T) {
 								Scheme:     ptr.To("https"),
 								Hostname:   ptr.To("envoyproxy.io"),
 								Port:       ptr.To(int32(443)),
-								StatusCode: ptr.To(301),
+								StatusCode: ptr.To(contour_v1.RedirectResponseCode(301)),
 							},
 						}},
 					},
@@ -12438,7 +12438,7 @@ func TestDAGInsert(t *testing.T) {
 								Scheme:     ptr.To("https"),
 								Hostname:   ptr.To("envoyproxy.io"),
 								Port:       ptr.To(int32(443)),
-								StatusCode: ptr.To(301),
+								StatusCode: ptr.To(contour_v1.RedirectResponseCode(301)),
 							},
 						}},
 					},
@@ -12490,7 +12490,7 @@ func TestDAGInsert(t *testing.T) {
 								Scheme:     ptr.To("https"),
 								Hostname:   ptr.To("envoyproxy.io"),
 								Port:       ptr.To(int32(443)),
-								StatusCode: ptr.To(301),
+								StatusCode: ptr.To(contour_v1.RedirectResponseCode(301)),
 							},
 						}},
 					},
@@ -12643,7 +12643,7 @@ func TestDAGInsert(t *testing.T) {
 									Scheme:     ptr.To("https"),
 									Hostname:   ptr.To("envoyproxy.io"),
 									Port:       ptr.To(int32(443)),
-									StatusCode: ptr.To(301),
+									StatusCode: ptr.To(contour_v1.RedirectResponseCode(301)),
 								},
 							},
 						},

diff --git a/internal/dag/dag.go b/internal/dag/dag.go
@@ -215,7 +215,7 @@ type DirectResponse struct {
 	Body string
 }
 
-// Redirect allows for a 301/302 redirect to be the response
+// Redirect allows for a redirect to be the response
 // to a route request vs. routing to an envoy cluster.
 type Redirect struct {
 	// Hostname is the host name to redirect to.
@@ -230,7 +230,7 @@ type Redirect struct {
 	PortNumber uint32
 
 	// StatusCode is the HTTP response code to
-	// use. Valid options are 301 or 302.
+	// use. Valid options are 301, 302, 303, 307, or 308.
 	StatusCode int
 
 	// PathRewritePolicy is the policy for rewriting

diff --git a/internal/dag/httpproxy_processor.go b/internal/dag/httpproxy_processor.go
@@ -1951,7 +1951,7 @@ func redirectRoutePolicy(redirect *contour_v1.HTTPRequestRedirectPolicy) (*Redir
 
 	var statusCode int
 	if redirect.StatusCode != nil {
-		statusCode = *redirect.StatusCode
+		statusCode = int(*redirect.StatusCode)
 	}
 
 	if redirect.Path != nil && redirect.Prefix != nil {

diff --git a/internal/envoy/v3/route.go b/internal/envoy/v3/route.go
@@ -392,6 +392,12 @@ func routeRedirect(redirect *dag.Redirect) *envoy_config_route_v3.Route_Redirect
 		r.Redirect.ResponseCode = envoy_config_route_v3.RedirectAction_MOVED_PERMANENTLY
 	case http.StatusFound:
 		r.Redirect.ResponseCode = envoy_config_route_v3.RedirectAction_FOUND
+	case http.StatusSeeOther:
+		r.Redirect.ResponseCode = envoy_config_route_v3.RedirectAction_SEE_OTHER
+	case http.StatusTemporaryRedirect:
+		r.Redirect.ResponseCode = envoy_config_route_v3.RedirectAction_TEMPORARY_REDIRECT
+	case http.StatusPermanentRedirect:
+		r.Redirect.ResponseCode = envoy_config_route_v3.RedirectAction_PERMANENT_REDIRECT
 	}
 
 	return r

diff --git a/internal/envoy/v3/route_test.go b/internal/envoy/v3/route_test.go
@@ -2762,7 +2762,7 @@ func TestRouteRedirect(t *testing.T) {
 		},
 		"unsupported status code specified": {
 			redirect: &dag.Redirect{
-				StatusCode: 303,
+				StatusCode: 306,
 			},
 			want: &envoy_config_route_v3.Route_Redirect{
 				Redirect: &envoy_config_route_v3.RedirectAction{},

diff --git a/internal/featuretests/v3/redirectroutepolicy_test.go b/internal/featuretests/v3/redirectroutepolicy_test.go
@@ -43,7 +43,7 @@ func TestRedirectResponsePolicy_HTTProxy(t *testing.T) {
 					Scheme:     ptr.To("https"),
 					Hostname:   ptr.To("envoyproxy.io"),
 					Port:       ptr.To(int32(443)),
-					StatusCode: ptr.To(301),
+					StatusCode: ptr.To(contour_v1.RedirectResponseCode(301)),
 					Path:       ptr.To("/blog"),
 				},
 			}},
@@ -87,7 +87,7 @@ func TestRedirectResponsePolicy_HTTProxy(t *testing.T) {
 					Scheme:     ptr.To("https"),
 					Hostname:   ptr.To("envoyproxy.io"),
 					Port:       ptr.To(int32(443)),
-					StatusCode: ptr.To(301),
+					StatusCode: ptr.To(contour_v1.RedirectResponseCode(301)),
 					Prefix:     ptr.To("/blogprefix"),
 				},
 			}},
@@ -135,7 +135,7 @@ func TestRedirectResponsePolicy_HTTProxy(t *testing.T) {
 					Scheme:     ptr.To("https"),
 					Hostname:   ptr.To("envoyproxy.io"),
 					Port:       ptr.To(int32(443)),
-					StatusCode: ptr.To(301),
+					StatusCode: ptr.To(contour_v1.RedirectResponseCode(301)),
 					Prefix:     ptr.To("/blogprefix"),
 					Path:       ptr.To("/blogprefix"),
 				},

diff --git a/site/content/docs/main/config/api-reference.html b/site/content/docs/main/config/api-reference.html
@@ -1767,7 +1767,9 @@ <h3 id="projectcontour.io/v1.HTTPRequestRedirectPolicy">HTTPRequestRedirectPolic
 <code>statusCode</code>
 <br>
 <em>
-int
+<a href="#projectcontour.io/v1.RedirectResponseCode">
+RedirectResponseCode
+</a>
 </em>
 </td>
 <td>
@@ -3085,7 +3087,8 @@ <h3 id="projectcontour.io/v1.RedirectResponseCode">RedirectResponseCode
 (<code>uint32</code> alias)</p></h3>
 <p>
 (<em>Appears on:</em>
-<a href="#projectcontour.io/v1.HTTPInternalRedirectPolicy">HTTPInternalRedirectPolicy</a>)
+<a href="#projectcontour.io/v1.HTTPInternalRedirectPolicy">HTTPInternalRedirectPolicy</a>, 
+<a href="#projectcontour.io/v1.HTTPRequestRedirectPolicy">HTTPRequestRedirectPolicy</a>)
 </p>
 <p>
 <p>RedirectResponseCode is a uint32 type alias with validation to ensure that the value is valid.</p>

diff --git a/test/e2e/httpproxy/internal_redirect_test.go b/test/e2e/httpproxy/internal_redirect_test.go
@@ -190,7 +190,7 @@ func getInternalRedirectHTTPProxy(namespace string) *contour_v1.HTTPProxy {
 					Services: []contour_v1.Service{},
 					RequestRedirectPolicy: &contour_v1.HTTPRequestRedirectPolicy{
 						Hostname:   ptr.To(fqdn),
-						StatusCode: ptr.To(302),
+						StatusCode: ptr.To(contour_v1.RedirectResponseCode(302)),
 						Path:       ptr.To("/echo"),
 					},
 				},

diff --git a/test/e2e/httpproxy/request_redirect_test.go b/test/e2e/httpproxy/request_redirect_test.go
@@ -124,7 +124,7 @@ func getRedirectHTTPProxy(namespace string, removeServices bool) *contour_v1.HTT
 					Scheme:     ptr.To("https"),
 					Hostname:   ptr.To("envoyproxy.io"),
 					Port:       ptr.To(int32(8080)),
-					StatusCode: ptr.To(301),
+					StatusCode: ptr.To(contour_v1.RedirectResponseCode(301)),
 				},
 			}, {
 				Conditions: []contour_v1.MatchCondition{{
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		`HTTPProxy.spec.routes.requestRedirectPolicy.statusCode` now supports 303, 307 and 308 redirect status codes in addition to 301 and 302.