Allow preservation of trailing slashes on TLS redirects via annotation. #7144

mmiller1 · 2021-05-18T15:44:02Z

What this PR does / why we need it:

this allows setting an optional "reserve-trailing-slash" annotation to "true" in order to keep trailing slashes in the Location header returned by a TLS redirect.

The default behavior is retained, removing the slashes.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Which issue/s this PR fixes

fixes #6931

How Has This Been Tested?

additional e2e tests for the annotation.

Checklist:

My change requires a change to the documentation.
I have updated the documentation accordingly.
I've read the CONTRIBUTION guide
I have added tests to cover my changes.
All new and existing tests passed.

k8s-ci-robot · 2021-05-18T15:44:15Z

Welcome @mmiller1!

It looks like this is your first PR to kubernetes/ingress-nginx 🎉. 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/ingress-nginx 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 · 2021-05-18T15:44:15Z

Hi @mmiller1. Thanks for your PR.

I'm waiting for a kubernetes 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/test-infra repository.

Signed-off-by: mamiller <mamiller@rosettastone.com>

tokers · 2021-05-19T02:08:06Z

internal/ingress/annotations/rewrite/main.go

@@ -85,6 +87,7 @@ func (a rewrite) Parse(ing *networking.Ingress) (interface{}, error) {

 	config.Target, _ = parser.GetStringAnnotation("rewrite-target", ing)
 	config.SSLRedirect, err = parser.GetBoolAnnotation("ssl-redirect", ing)
+	config.PreserveTrailingSlash, err = parser.GetBoolAnnotation("preserve-trailing-slash", ing)


Should check the err from the ssl-redirect annotation parsing firstly, considering the following case:

ssl-redirect annotation is invalid

preserve-trailing-slash is valid

so err will be reset to nil and the error process was dismissed.

fixed, thanks.

tokers · 2021-05-19T02:09:25Z

rootfs/etc/nginx/lua/lua_ingress.lua

-      request_uri = string.sub(request_uri, 1, -2)
+    -- do not append a trailing slash on redirects unless enabled by annotations
+    if location_config.preserve_trailing_slash == false then
+      if string.sub(request_uri, -1) == "/" then


Suggested change

if string.sub(request_uri, -1) == "/" then

if string.byte(request_uri, -1, -1) == string.byte('/') then

Use string.byte is more efficient, as string.sub will generate a new string, which allocates some small memory chunk and makes the LuaJIT GC collector busy.

updated, thaanks.

Missed this comment! :D

tao12345666333

/ok-to-test

tao12345666333 · 2021-05-20T06:37:54Z

test/e2e/annotations/preservetrailingslash.go

@@ -0,0 +1,53 @@
+/*
+Copyright 2018 The Kubernetes Authors.


2018 -> 2021

tao12345666333

Thanks!

/lgtm

mmiller1 · 2021-05-20T16:48:08Z

/assign @rikatz

rikatz · 2021-05-23T15:37:59Z

rootfs/etc/nginx/lua/lua_ingress.lua

-      request_uri = string.sub(request_uri, 1, -2)
+    -- do not append a trailing slash on redirects unless enabled by annotations
+    if location_config.preserve_trailing_slash == false then
+      if string.byte(request_uri, -1, -1) == string.byte('/') then


I'm not a Lua expert, but why are we replacing string.sub here for string.byte? :)

OK, did some experiments here, looks good, just getting strictly the last character.

rikatz · 2021-05-23T15:46:13Z

/label tide/merge-method-squash
/approve

Thank you!

k8s-ci-robot · 2021-05-23T15:46:25Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mmiller1, rikatz, tao12345666333, tokers

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

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [rikatz]

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

…n. (kubernetes#7144) * allow retaining a trailing slash in a TLS redirect via annotation. Signed-off-by: mamiller <mamiller@rosettastone.com> * requested changes * gofmt

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label May 18, 2021

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label May 18, 2021

k8s-ci-robot requested review from cmluciano and ElvinEfendi May 18, 2021 15:44

k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 18, 2021

mmiller1 mentioned this pull request May 18, 2021

Remove the force stripping of trailing slashes #7044

Closed

allow retaining a trailing slash in a TLS redirect via annotation.

6d4efc4

Signed-off-by: mamiller <mamiller@rosettastone.com>

mmiller1 force-pushed the master branch from cb5c10c to 6d4efc4 Compare May 18, 2021 15:59

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 18, 2021

tokers reviewed May 19, 2021

View reviewed changes

requested changes

07beff6

tokers approved these changes May 20, 2021

View reviewed changes

tao12345666333 reviewed May 20, 2021

View reviewed changes

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 20, 2021

tao12345666333 reviewed May 20, 2021

View reviewed changes

gofmt

c66bd4b

tao12345666333 reviewed May 20, 2021

View reviewed changes

k8s-ci-robot assigned tao12345666333 May 20, 2021

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 20, 2021

k8s-ci-robot assigned rikatz May 20, 2021

rikatz reviewed May 23, 2021

View reviewed changes

k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label May 23, 2021

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 23, 2021

k8s-ci-robot merged commit b3dfee6 into kubernetes:master May 23, 2021

fredthomsen mentioned this pull request Aug 27, 2021

Missing documentation reference for preserve-trailing-slash annotation #7555

Closed

tarrow mentioned this pull request Nov 28, 2022

Missing documentation for preserve_trailing_slash in controller configmap #9314

Open

5imun mentioned this pull request Jul 12, 2023

Annotation preserve-trailing-slash doesn't always work #10085

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow preservation of trailing slashes on TLS redirects via annotation. #7144

Allow preservation of trailing slashes on TLS redirects via annotation. #7144

mmiller1 commented May 18, 2021

k8s-ci-robot commented May 18, 2021

k8s-ci-robot commented May 18, 2021

tokers May 19, 2021

mmiller1 May 19, 2021

tokers May 19, 2021

mmiller1 May 19, 2021

rikatz May 23, 2021

tao12345666333 left a comment

tao12345666333 May 20, 2021

mmiller1 May 20, 2021

tao12345666333 left a comment

mmiller1 commented May 20, 2021

rikatz May 23, 2021

rikatz May 23, 2021

rikatz commented May 23, 2021

k8s-ci-robot commented May 23, 2021

	if string.sub(request_uri, -1) == "/" then
	if string.byte(request_uri, -1, -1) == string.byte('/') then

Allow preservation of trailing slashes on TLS redirects via annotation. #7144

Allow preservation of trailing slashes on TLS redirects via annotation. #7144

Conversation

mmiller1 commented May 18, 2021

What this PR does / why we need it:

Types of changes

Which issue/s this PR fixes

How Has This Been Tested?

Checklist:

k8s-ci-robot commented May 18, 2021

k8s-ci-robot commented May 18, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tao12345666333 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tao12345666333 left a comment

Choose a reason for hiding this comment

mmiller1 commented May 20, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rikatz commented May 23, 2021

k8s-ci-robot commented May 23, 2021