feat: Add support for configuring compression levels #11805
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Use this changelog template to create an entry for release notes. | ||
|
|
||
| # One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' | ||
| change_type: 'breaking' | ||
|
|
||
| # The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver) | ||
| component: confighttp | ||
|
|
||
| # A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
| note: Added support for configuring compression levels. | ||
|
|
||
| # One or more tracking issues or pull requests related to the change | ||
| issues: [10467] | ||
|
|
||
| # (Optional) One or more lines of additional information to render under the primary note. | ||
| # These lines will be padded with 2 spaces and then inserted directly into the document. | ||
| # Use pipe (|) for multiline entries. | ||
| subtext: | ||
|
There was a problem hiding this comment. Please add more details here describing a new field |
||
|
|
||
| # Optional: The change log or logs in which this entry should be included. | ||
| # e.g. '[user]' or '[user, api]' | ||
| # Include 'user' if the change is relevant to end users. | ||
| # Include 'api' if there is a change to a library API. | ||
| # Default: '[user]' | ||
| change_logs: [api] | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,6 +9,7 @@ import ( | |
| "compress/zlib" | ||
| "context" | ||
| "errors" | ||
| "fmt" | ||
| "io" | ||
| "net/http" | ||
| "net/http/httptest" | ||
|
|
@@ -35,9 +36,12 @@ func TestHTTPClientCompression(t *testing.T) { | |
| compressedZstdBody := compressZstd(t, testBody) | ||
| compressedLz4Body := compressLz4(t, testBody) | ||
|
|
||
| const invalidGzipLevel configcompression.Level = 100 | ||
|
|
||
| tests := []struct { | ||
| name string | ||
| encoding configcompression.Type | ||
| enclevel configcompression.Level | ||
|
|
||
| reqBody []byte | ||
| shouldError bool | ||
| }{ | ||
|
|
@@ -56,18 +60,28 @@ func TestHTTPClientCompression(t *testing.T) { | |
| { | ||
| name: "ValidGzip", | ||
| encoding: configcompression.TypeGzip, | ||
| enclevel: gzip.BestSpeed, | ||
| reqBody: compressedGzipBody.Bytes(), | ||
| shouldError: false, | ||
| }, | ||
| { | ||
| name: "InvalidGzip", | ||
| encoding: configcompression.TypeGzip, | ||
| enclevel: invalidGzipLevel, | ||
| reqBody: compressedGzipBody.Bytes(), | ||
| shouldError: true, | ||
| }, | ||
| { | ||
| name: "ValidZlib", | ||
| encoding: configcompression.TypeZlib, | ||
| enclevel: gzip.BestSpeed, | ||
| reqBody: compressedZlibBody.Bytes(), | ||
| shouldError: false, | ||
| }, | ||
| { | ||
| name: "ValidDeflate", | ||
| encoding: configcompression.TypeDeflate, | ||
| enclevel: gzip.BestSpeed, | ||
| reqBody: compressedDeflateBody.Bytes(), | ||
| shouldError: false, | ||
| }, | ||
|
|
@@ -80,6 +94,7 @@ func TestHTTPClientCompression(t *testing.T) { | |
| { | ||
| name: "ValidZstd", | ||
| encoding: configcompression.TypeZstd, | ||
| enclevel: gzip.BestSpeed, | ||
| reqBody: compressedZstdBody.Bytes(), | ||
| shouldError: false, | ||
| }, | ||
|
|
@@ -104,16 +119,26 @@ func TestHTTPClientCompression(t *testing.T) { | |
|
|
||
| req, err := http.NewRequest(http.MethodGet, srv.URL, reqBody) | ||
| require.NoError(t, err, "failed to create request to test handler") | ||
| compressionType := tt.encoding | ||
| err = compressionType.UnmarshalText([]byte(tt.encoding)) | ||
|
|
||
| require.NoError(t, err) | ||
| clientSettings := ClientConfig{ | ||
| Endpoint: srv.URL, | ||
| Compression: tt.encoding, | ||
| CompressionParams: newCompressionParams(tt.enclevel), | ||
| } | ||
| err = clientSettings.Validate() | ||
| if tt.shouldError { | ||
| require.Error(t, err) | ||
| message := fmt.Sprintf("unsupported compression type and level %s - %d", tt.encoding, tt.enclevel) | ||
| assert.Equal(t, message, err.Error()) | ||
| return | ||
| } | ||
| client, err := clientSettings.ToClient(context.Background(), componenttest.NewNopHost(), componenttest.NewNopTelemetrySettings()) | ||
| require.NoError(t, err) | ||
| res, err := client.Do(req) | ||
| if tt.shouldError { | ||
| require.Error(t, err) | ||
|
|
||
| return | ||
| } | ||
| require.NoError(t, err) | ||
|
|
@@ -303,7 +328,8 @@ func TestHTTPContentCompressionRequestWithNilBody(t *testing.T) { | |
| require.NoError(t, err, "failed to create request to test handler") | ||
|
|
||
| client := srv.Client() | ||
| compressionParams := newCompressionParams(gzip.BestSpeed) | ||
| client.Transport, err = newCompressRoundTripper(http.DefaultTransport, configcompression.TypeGzip, compressionParams) | ||
| require.NoError(t, err) | ||
| res, err := client.Do(req) | ||
| require.NoError(t, err) | ||
|
|
@@ -323,7 +349,8 @@ func TestHTTPContentCompressionCopyError(t *testing.T) { | |
| require.NoError(t, err) | ||
|
|
||
| client := srv.Client() | ||
| compressionParams := newCompressionParams(gzip.BestSpeed) | ||
| client.Transport, err = newCompressRoundTripper(http.DefaultTransport, configcompression.TypeGzip, compressionParams) | ||
| require.NoError(t, err) | ||
| _, err = client.Do(req) | ||
| require.Error(t, err) | ||
|
|
@@ -347,7 +374,8 @@ func TestHTTPContentCompressionRequestBodyCloseError(t *testing.T) { | |
| require.NoError(t, err) | ||
|
|
||
| client := srv.Client() | ||
| compressionParams := newCompressionParams(gzip.BestSpeed) | ||
| client.Transport, err = newCompressRoundTripper(http.DefaultTransport, configcompression.TypeGzip, compressionParams) | ||
| require.NoError(t, err) | ||
| _, err = client.Do(req) | ||
| require.Error(t, err) | ||
|
|
@@ -448,7 +476,7 @@ func TestDecompressorAvoidDecompressionBomb(t *testing.T) { | |
|
|
||
| func compressGzip(t testing.TB, body []byte) *bytes.Buffer { | ||
| var buf bytes.Buffer | ||
| gw, _ := gzip.NewWriterLevel(&buf, gzip.BestSpeed) | ||
| _, err := gw.Write(body) | ||
| require.NoError(t, err) | ||
| require.NoError(t, gw.Close()) | ||
|
|
@@ -457,7 +485,7 @@ func compressGzip(t testing.TB, body []byte) *bytes.Buffer { | |
|
|
||
| func compressZlib(t testing.TB, body []byte) *bytes.Buffer { | ||
| var buf bytes.Buffer | ||
| zw, _ := zlib.NewWriterLevel(&buf, zlib.BestSpeed) | ||
| _, err := zw.Write(body) | ||
| require.NoError(t, err) | ||
| require.NoError(t, zw.Close()) | ||
|
|
@@ -475,7 +503,9 @@ func compressSnappy(t testing.TB, body []byte) *bytes.Buffer { | |
|
|
||
| func compressZstd(t testing.TB, body []byte) *bytes.Buffer { | ||
| var buf bytes.Buffer | ||
| compression := zstd.SpeedFastest | ||
| encoderLevel := zstd.WithEncoderLevel(compression) | ||
| zw, _ := zstd.NewWriter(&buf, encoderLevel) | ||
| _, err := zw.Write(body) | ||
| require.NoError(t, err) | ||
| require.NoError(t, zw.Close()) | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not breaking anymore