add `brotli-min-length` configuration option #7854

rahil-p · 2021-10-27T08:16:12Z

What this PR does / why we need it:

Adds the brotli-min-length configuration option for setting the ngx_brotli brotli_min_length directive (with updated documentation).

#7853

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)
Documentation only

Which issue/s this PR fixes

fixes #7853

How Has This Been Tested?

The following tests have passed locally:

Unit tests: make test
Unit tests for Lua: make lua-test
End-to-end tests: make kind-e2e-test (including a new test for Brotli)

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-10-27T08:16:15Z

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: [email protected]

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. I understand the commands that are listed here.

k8s-ci-robot · 2021-10-27T08:16:20Z

@rahil-p: This issue is currently awaiting triage.

If Ingress contributors determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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.

k8s-ci-robot · 2021-10-27T08:16:20Z

Welcome @rahil-p!

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-10-27T08:16:21Z

Hi @rahil-p. 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.

longwuyuan · 2021-10-27T08:55:06Z

Hi @rahil-p, Kindly write tests for this change. Hopefully, we can get get some assurance that no other impact is possible when this feature is used. Thanks, ; Long

…

On Wed, 27 Oct, 2021, 1:50 PM Rahil Patel, ***@***.***> wrote: I signed it — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#7854 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABGZVWWHLQGKEYLWANERSATUI6Y3BANCNFSM5GZWJHVA> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.

rahil-p · 2021-10-27T09:33:35Z

internal/ingress/controller/config/config.go

@@ -778,6 +781,7 @@ func NewDefault() Configuration {
 		BlockUserAgents:                  defBlockEntity,
 		BlockReferers:                    defBlockEntity,
 		BrotliLevel:                      4,
+		BrotliMinLength:                  20,


Uses the brotli_min_length's default value from the ngx_brotli module.

rahil-p · 2021-10-27T20:40:36Z

test/e2e/settings/brotli.go

@@ -59,6 +59,7 @@ var _ = framework.IngressNginxDescribe("brotli", func() {
 			WithHeader("Accept-Encoding", "br").
 			Expect().
 			Status(http.StatusOK).
+			ContentType(contentEncoding).


The httpbin server responds with the content type application/octet-stream for the /bytes/{n} endpoint. This test enables compression for this type by setting brotli-types to application/octet-stream. This extra check should help indicate if Brotli compression was skipped in this test because of a content type mismatch (in the off-chance changes are made to the httpbin server image).

rikatz · 2021-11-02T00:12:37Z

test/e2e/settings/brotli.go

@@ -0,0 +1,75 @@
+/*
+Copyright 2020 The Kubernetes Authors.


rikatz · 2021-11-02T00:15:01Z

/ok-to-test
Just fix the header on the test please.

Then lgtm

rikatz · 2021-11-02T00:17:55Z

Please also fix the go formatting error :)

longwuyuan · 2021-11-02T02:36:57Z

/lgtm Thanks, ; Long

…

On Tue, 2 Nov, 2021, 7:35 AM Rahil Patel, ***@***.***> wrote: lgtm — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#7854 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABGZVWXTMWRBZXNP7E5H7S3UJ5BOHANCNFSM5GZWJHVA> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.

rikatz · 2021-11-02T11:51:10Z

/approve
Thanks

k8s-ci-robot · 2021-11-02T11:51:30Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: longwuyuan, rahil-p, rikatz

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

* add `brotli-min-length` configuration option * add e2e tests for brotli * include check for expected content type * fix header and format

add brotli-min-length configuration option

f25db16

k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Oct 27, 2021

k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-kind Indicates a PR lacks a `kind/foo` label and requires one. labels Oct 27, 2021

k8s-ci-robot added needs-priority size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Oct 27, 2021

k8s-ci-robot requested review from strongjz and tao12345666333 October 27, 2021 08:16

k8s-ci-robot added area/docs cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Oct 27, 2021

rahil-p commented Oct 27, 2021

View reviewed changes

add e2e tests for brotli

7057129

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Oct 27, 2021

include check for expected content type

f7b9bee

rahil-p commented Oct 27, 2021

View reviewed changes

rikatz reviewed Nov 2, 2021

View reviewed changes

test/e2e/settings/brotli.go Outdated

@@ -0,0 +1,75 @@

/*

Copyright 2020 The Kubernetes Authors.

Copy link

Contributor

rikatz Nov 2, 2021

Choose a reason for hiding this comment

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

2021 here

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 Nov 2, 2021

fix header and format

6ea97be

k8s-ci-robot assigned longwuyuan Nov 2, 2021

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

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

k8s-ci-robot merged commit c8ab4dc into kubernetes:main Nov 2, 2021

rikatz added this to the v1.0.5 milestone Nov 12, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add `brotli-min-length` configuration option #7854

add `brotli-min-length` configuration option #7854

rahil-p commented Oct 27, 2021 •

edited

Loading

k8s-ci-robot commented Oct 27, 2021

k8s-ci-robot commented Oct 27, 2021

k8s-ci-robot commented Oct 27, 2021

k8s-ci-robot commented Oct 27, 2021

longwuyuan commented Oct 27, 2021 via email

rahil-p Oct 27, 2021

rahil-p Oct 27, 2021 •

edited

Loading

rikatz Nov 2, 2021

rikatz commented Nov 2, 2021

rikatz commented Nov 2, 2021

longwuyuan commented Nov 2, 2021 via email

rikatz commented Nov 2, 2021

k8s-ci-robot commented Nov 2, 2021

add brotli-min-length configuration option #7854

add brotli-min-length configuration option #7854

Conversation

rahil-p commented Oct 27, 2021 • edited Loading

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 Oct 27, 2021

k8s-ci-robot commented Oct 27, 2021

k8s-ci-robot commented Oct 27, 2021

k8s-ci-robot commented Oct 27, 2021

longwuyuan commented Oct 27, 2021 via email

rahil-p Oct 27, 2021

Choose a reason for hiding this comment

rahil-p Oct 27, 2021 • edited Loading

Choose a reason for hiding this comment

rikatz Nov 2, 2021

Choose a reason for hiding this comment

rikatz commented Nov 2, 2021

rikatz commented Nov 2, 2021

longwuyuan commented Nov 2, 2021 via email

rikatz commented Nov 2, 2021

k8s-ci-robot commented Nov 2, 2021

add `brotli-min-length` configuration option #7854

add `brotli-min-length` configuration option #7854

rahil-p commented Oct 27, 2021 •

edited

Loading

rahil-p Oct 27, 2021 •

edited

Loading