Skip to content
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

compression: create a decompressor extensibility point and move gzip decompressor #10744

Merged
merged 26 commits into from
May 12, 2020
Merged

compression: create a decompressor extensibility point and move gzip decompressor #10744

merged 26 commits into from
May 12, 2020

Conversation

junr03
Copy link
Member

@junr03 junr03 commented Apr 11, 2020

Description: this PR creates decompressors as an extension point and moves the zlib based gzip decompressor.
Risk Level: low - moving files around. None of the decompressor files were used in a public API capacity so nothing has to be deprecated.
Testing: all existing unit, integration, fuzz tests work.
Docs Changes: pending
Release Notes: pending

Progress toward #4445. Next PR would use this in a generic decompression filter a la #10553.

Signed-off-by: Jose Nino jnino@lyft.com

Jose Nino added 12 commits April 10, 2020 11:44
Signed-off-by: Jose Nino <jnino@lyft.com>
Signed-off-by: Jose Nino <jnino@lyft.com>
Signed-off-by: Jose Nino <jnino@lyft.com>
Signed-off-by: Jose Nino <jnino@lyft.com>
Signed-off-by: Jose Nino <jnino@lyft.com>
Signed-off-by: Jose Nino <jnino@lyft.com>
…atted

Signed-off-by: Jose Nino <jnino@lyft.com>
Signed-off-by: Jose Nino <jnino@lyft.com>
Signed-off-by: Jose Nino <jnino@lyft.com>
Signed-off-by: Jose Nino <jnino@lyft.com>
Signed-off-by: Jose Nino <jnino@lyft.com>
fmt
Signed-off-by: Jose Nino <jnino@lyft.com>
@repokitteh-read-only
Copy link

CC @envoyproxy/api-shepherds: Your approval is needed for changes made to api/.

🐱

Caused by: #10744 was opened by junr03.

see: more, trace.

Jose Nino added 2 commits April 11, 2020 14:51
Signed-off-by: Jose Nino <jnino@lyft.com>
Signed-off-by: Jose Nino <jnino@lyft.com>
Copy link
Member

@htuch htuch left a comment

Choose a reason for hiding this comment

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

I think this is the decompression dual of #10553, which is currently under review (by you :) ). I'm good with making this an extension point, with the same proviso as in #10553, that we clearly state the deprecation considerations in the docs.

@junr03
Copy link
Member Author

junr03 commented Apr 13, 2020

@htuch yep, this is the decompression dual to #10533. I got the idea for this proposal while reviewing #10533, and I am suggesting @rojkov updates #10533 to the organization proposed here (while keeping the necessary stuff around for proper deprecation).

This proposal basically takes @rojkov's work a bit further and gives compression top-level extension status. My proposal a) allows us to move the current code in source/common out; and b) does not embed the compression libraries within the filters/http tree, as compression libraries might be used outside of the context of the compressor and decompressor http filters.

@htuch
Copy link
Member

htuch commented Apr 13, 2020

@junr03 ack, makes sense. I actually prefer the organization that has the typed_config wrapper not inside common; it seems to make sense to have the base filter as a first-class entity, this isn't shared code.

@mattklein123 mattklein123 self-assigned this Apr 18, 2020
Copy link
Contributor

@rebello95 rebello95 left a comment

Choose a reason for hiding this comment

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

LGTM overall! Some minor suggestions

CODEOWNERS Outdated Show resolved Hide resolved
source/extensions/compression/gzip/decompressor/config.h Outdated Show resolved Hide resolved
source/extensions/compression/gzip/decompressor/config.h Outdated Show resolved Hide resolved
source/extensions/compression/gzip/decompressor/config.h Outdated Show resolved Hide resolved
@stale
Copy link

stale bot commented Apr 28, 2020

This pull request has been automatically marked as stale because it has not had activity in the last 7 days. It will be closed in 7 days if no further activity occurs. Please feel free to give a status update now, ping for review, or re-open when it's ready. Thank you for your contributions!

@stale stale bot added the stale stalebot believes this issue/PR has not been touched recently label Apr 28, 2020
Signed-off-by: Jose Nino <jnino@lyft.com>
@stale stale bot removed the stale stalebot believes this issue/PR has not been touched recently label Apr 30, 2020
Signed-off-by: Jose Nino <jnino@lyft.com>
@junr03 junr03 marked this pull request as ready for review April 30, 2020 22:48
@junr03 junr03 requested a review from dio as a code owner April 30, 2020 22:48
@junr03 junr03 changed the title [DRAFT] compression: create a compression extensibility point and move gzip decompressor compression: create a decompressor extensibility point and move gzip decompressor Apr 30, 2020
@junr03
Copy link
Member Author

junr03 commented Apr 30, 2020

@rojkov, now that your PR is pretty much ready to merge, I have updated this PR for the decompressor side. Do you mind reviewing it?

Copy link
Member

@rojkov rojkov left a comment

Choose a reason for hiding this comment

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

Looks great! I've found an inconsistency in my own PR even while looking at this one.

include/envoy/compression/decompressor/config.h Outdated Show resolved Hide resolved
Signed-off-by: Jose Nino <jnino@lyft.com>
@repokitteh-read-only
Copy link

CC @envoyproxy/api-watchers: FYI only for changes made to api/.

🐱

Caused by: #10744 was synchronize by junr03.

see: more, trace.

Jose Nino added 6 commits May 8, 2020 14:01
Signed-off-by: Jose Nino <jnino@lyft.com>
fmt
Signed-off-by: Jose Nino <jnino@lyft.com>
Signed-off-by: Jose Nino <jnino@lyft.com>
fmt
Signed-off-by: Jose Nino <jnino@lyft.com>
fix
Signed-off-by: Jose Nino <jnino@lyft.com>
Signed-off-by: Jose Nino <jnino@lyft.com>
@junr03
Copy link
Member Author

junr03 commented May 11, 2020

@rojkov I updated this PR after merging yours on friday. PTAL when you can, thanks!

Copy link
Member

@rojkov rojkov left a comment

Choose a reason for hiding this comment

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

This looks great! Just one note about auto-docs.

docs/root/api-v3/config/config.rst Outdated Show resolved Hide resolved
Jose Nino added 2 commits May 11, 2020 08:04
Signed-off-by: Jose Nino <jnino@lyft.com>
Signed-off-by: Jose Nino <jnino@lyft.com>
@junr03
Copy link
Member Author

junr03 commented May 11, 2020

@rojkov updated!

rojkov
rojkov previously approved these changes May 11, 2020
Copy link
Member

@rojkov rojkov left a comment

Choose a reason for hiding this comment

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

Thank you for fixing the title of compressor’s gzip.proto.
Looks good to me.

Signed-off-by: Jose Nino <jnino@lyft.com>
@junr03
Copy link
Member Author

junr03 commented May 12, 2020

@mattklein123 this is ready for a pass from you

Copy link
Member

@mattklein123 mattklein123 left a comment

Choose a reason for hiding this comment

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

Nice!

@junr03 junr03 merged commit 520e0c7 into envoyproxy:master May 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants