Skip to content

Add 307 / 308 Redirect Status Code Support #3823

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

davidwin93
Copy link

What type of PR is this?
/kind bug
/area conformance-test

What this PR does / why we need it:

This PR allows users to select either a 307 or 308 status code along with the existing options of 301 and 302. This matches RFC 9110 and by letting users select 308 it will match the existing nginx ingress behaviour of using a 308 for HTTP -> HTTPS redirects.

Which issue(s) this PR fixes:

Fixes #2748

Does this PR introduce a user-facing change?:
This will allow users to select 307 or 308 as redirect status codes along with 301 and 302.

Adds support to select 307 or 308 status codes along with the current options of 301 and 302

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. kind/bug Categorizes issue or PR as related to a bug. area/conformance-test Issues or PRs related to Conformance tests. labels May 29, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: davidwin93
Once this PR has been reviewed and has the lgtm label, please assign mlavacca for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label May 29, 2025
@k8s-ci-robot k8s-ci-robot requested review from mlavacca and Xunzhuo May 29, 2025 01:47
@k8s-ci-robot
Copy link
Contributor

Welcome @davidwin93!

It looks like this is your first PR to kubernetes-sigs/gateway-api 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/gateway-api has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels May 29, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @davidwin93. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Signed-off-by: Dave Winiarski <dave.winiarski@zapier.com>
@robscott
Copy link
Member

Thanks @davidwin93, this will be a great improvement!

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels May 30, 2025
@davidwin93 davidwin93 force-pushed the Add-3xx-Support branch 2 times, most recently from d3b8bad to 22fe26d Compare May 31, 2025 04:35
Signed-off-by: Dave Winiarski <dave.winiarski@zapier.com>
@davidwin93 davidwin93 changed the title [WIP] Add 307 / 308 Redirect Status Code Support Add 307 / 308 Redirect Status Code Support May 31, 2025
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 31, 2025
@LiorLieberman
Copy link
Member

/cc

@mikemorris
Copy link
Contributor

mikemorris commented Jun 3, 2025

Note: For historical reasons, a user agent MAY change the request method from POST to GET for the subsequent request. If this behavior is undesired, the 307 (Temporary Redirect) or 308 (Permanent Redirect) status code can be used instead.

Is there any suggestion that we would want to include in docs for this behavior for 301 and 302 responses?

@kflynn
Copy link
Contributor

kflynn commented Jun 3, 2025

I'd like to see the user-facing docs updated as part of this PR -- thanks!!

Copy link
Member

@LiorLieberman LiorLieberman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

echoing feedback from today's community meeting.

this may benefit from a SupportedFeature for gradual enablement, because if this gets in, if there is any implementation that does not support 307 and 308 they go out of conformance

@davidwin93
Copy link
Author

@LiorLieberman in regards to SupportedFeature do I need to wait for this to get in first?
Do you happen to have any examples of any in flight work that is currently using this functionality, or would this be the first change to leverage supported features?

@candita
Copy link
Contributor

candita commented Jun 3, 2025

this may benefit from a SupportedFeature for gradual enablement, because if this gets in, if there is any implementation that does not support 307 and 308 they go out of conformance

Can we add this as Extended (optional)?

@LiorLieberman
Copy link
Member

@LiorLieberman in regards to SupportedFeature do I need to wait for this to get in first? Do you happen to have any examples of any in flight work that is currently using this functionality, or would this be the first change to leverage supported features?

no, these are two different things. when I said supported features I really meant a FeatureName - like https://github.com/kubernetes-sigs/gateway-api/blob/main/conformance/tests/httproute-response-header-modifier.go#L40 for example.

And @candita, to your point, adding a featureName would mean it is initially extended, but as said during the meeting, we should communicate clearly we are only doing it for gradual enablement, with intentions to move it to core (and remove the featureName) once we communicated it enough

@youngnick youngnick added kind/feature Categorizes issue or PR as related to a new feature. and removed kind/bug Categorizes issue or PR as related to a bug. labels Jun 4, 2025
@LiorLieberman
Copy link
Member

@davidwin93 let me know if you need any assistance with this.

See recent commit that did the same thing almost - e77c612

@k8s-ci-robot k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jun 5, 2025
@davidwin93
Copy link
Author

@LiorLieberman thanks for that example. I've added some new tests with a new feature. I assume I should revert my changes to the existing conformance tests?

Ill also work on updating the docs shortly.

Copy link
Member

@LiorLieberman LiorLieberman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @davidwin93. Yes please revert the changes to existing conformance tests and their manifests.

features.SupportGateway,
features.SupportHTTPRoute,
features.SupportHTTPRouteSchemeRedirect,
features.SupportHTTPRouteAdditionalRedirectStatusCodes,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are we anticipating any more codes in the future? haha.
should we specifically mention 307 and 308 in the feature name or no need?

Features: []features.FeatureName{
features.SupportMesh,
features.SupportHTTPRoute,
features.SupportHTTPRouteAdditionalRedirectStatusCodes,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
features.SupportHTTPRouteAdditionalRedirectStatusCodes,
features.SupportMeshHTTPRouteAdditionalRedirectStatusCodes,

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add add a feature for this in https://github.com/kubernetes-sigs/gateway-api/blob/main/pkg/features/mesh.go like you added in httproute.go

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/conformance-test Issues or PRs related to Conformance tests. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/feature Categorizes issue or PR as related to a new feature. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Gateway API validations too strict for redirect status codes
8 participants