chore: Move compression utilities into separate package #14167
Merged
Conversation
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
chaudum
force-pushed
the
chaudum/compression-package
branch
4 times, most recently
from
01ef96d to
2f061c9
Compare
chaudum
changed the title
Compression tooling has been part of the chunkenc (chunk encoding) package in the past for legacy reasons. Since more components use this now, it's easier to keep it in a separate package. This also eliminates the confusion around "encoding", since this has been incorrectly used synonymously with "compression" in the past. Signed-off-by: Christian Haudum <[email protected]>
chaudum
force-pushed
the
chaudum/compression-package
branch
from
2f061c9 to
f224d78
Compare
chaudum
commented
Sep 18, 2024
rfratto
approved these changes
Sep 18, 2024
pkg/compression/pool.go
Outdated
Comment on lines
49
to
70
| switch enc { | ||
| case EncGZIP: | ||
| return &Gzip | ||
| case EncLZ4_64k: | ||
| return &Lz4_64k | ||
| case EncLZ4_256k: | ||
| return &Lz4_256k | ||
| case EncLZ4_1M: | ||
| return &Lz4_1M | ||
| case EncLZ4_4M: | ||
| return &Lz4_4M | ||
| case EncSnappy: | ||
| return &Snappy | ||
| case EncNone: | ||
| return &Noop | ||
| case EncFlate: | ||
| return &Flate | ||
| case EncZstd: | ||
| return &Zstd | ||
| default: | ||
| panic("unknown encoding") | ||
| } |
There was a problem hiding this comment.
nit: None* of the pools are referenced directly outside of this package, so it's safe to unexport all of them and just leave GetReaderPool/GetWriterPool as the public API for pools.
Personally I'm normally a fan of unexporting as much as possible as it reduces the surface where good API documentation is necessary. I don't feel too strongly about this at the moment, so I don't mind if this doesn't get changed.
*: compression.Gzip is referenced a few times, but all references can be replaced with compression.GetReaderPool(compression.EncGZIP) or compression.GetWriterPool(compression.EncGZIP).
pkg/compression/pool.go
Outdated
| } | ||
| } | ||
|
|
||
| // GzipPool is a gun zip compression pool |
Signed-off-by: Christian Haudum <[email protected]>
Signed-off-by: Christian Haudum <[email protected]>
Co-authored-by: Robert Fratto <[email protected]>
Signed-off-by: Christian Haudum <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What this PR does / why we need it:
Compression tooling has been part of the
chunkenc(chunk encoding)package in the past for legacy reasons.
Since more components use this now, it's easier to keep it in a separate
package. This also eliminates the confusion around "encoding", since
this has been incorrectly used synonymously with "compression" in the past.
Checklist
CONTRIBUTING.mdguide (required)featPRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.docs/sources/setup/upgrade/_index.mdproduction/helm/loki/Chart.yamland updateproduction/helm/loki/CHANGELOG.mdandproduction/helm/loki/README.md. Example PRdeprecated-config.yamlanddeleted-config.yamlfiles respectively in thetools/deprecated-config-checkerdirectory. Example PRSigned-off-by: Christian Haudum [email protected]