feat(codec): add compression API, standard algorithms, and global reg…#2648
feat(codec): add compression API, standard algorithms, and global reg…#2648sauravzg wants to merge 1 commit into
Conversation
gRPC-Go only implements gzip. Do any other languages offer these other ones out of the box? |
dfawley
left a comment
dfawley
left a comment
There was a problem hiding this comment.
Please make sure all files include the copyright header.
| use crate::codec::compression::Decompressor; | ||
|
|
||
| /// A read-only interface to query supported compression algorithms. | ||
| pub trait CompressionResolver: Send + Sync + 'static { |
There was a problem hiding this comment.
What problem is solved by putting traits around the registry?
There was a problem hiding this comment.
The traits serve two main purposes:
Testing: Global singletons are painful to test with Rust's parallel test runner. An interface allows for easy mocks or fakes in unit tests.
Interface Segregation/data hiding: Interceptors only need 'get' APIs, so I needed a trait for read-only things. I could've probably achieved this via making the write methods &mut self , but it seems like for global registries interior mutability was more common (tracing lib).
Although, I must admit it's mostly the former, global singletons are painful during testing.
sauravzg
force-pushed
the
sauravz/compression-api
branch
from
db718f9 to
2e65c81
Compare
…istry This change introduces the foundational compression abstractions and implementations for the grpc server component. - **Compression API (`grpc/src/codec/compression.rs`)**: Defines the `Compressor` and `Decompressor` traits for handling the compression and decompression of gRPC payloads via byte buffers. - **Simplified Design Philosophy**: The API is intentionally kept simple. It deliberately avoids handling concerns like limiting input and output buffer sizes, instead delegating these safety boundaries to the higher-level gRPC business logic. - **Performance Improvements**: By relying on direct buffer manipulation, this implementation avoids the hidden memory copying overhead present in the `tonic` crate (which utilizes 8KB intermediate buffers for I/O). - **Standard Algorithms**: Implements `gzip`, `deflate`, and `zstd` compression logic in their respective modules. These are conditionally compiled based on feature flags. - **Global Registry (`registry.rs`)**: Introduces a thread-safe `GlobalCompressionRegistry` (backed by `RwLock` and `Arc`) to manage registered compressors and decompressors. It handles safe concurrent access and automatically updates the broadcasted `grpc-accept-encoding` headers. - **Module Integration**: Exposes the new `codec` and `compression` modules to the library's root structure.
sauravzg
force-pushed
the
sauravz/compression-api
branch
from
2e65c81 to
c4d2db5
Compare
2 participants
…istry
This change introduces the foundational compression abstractions and implementations for the grpc server component.
grpc/src/codec/compression.rs): Defines theCompressorandDecompressortraits for handling the compression and decompression of gRPC payloads via byte buffers.toniccrate (which utilizes 8KB intermediate buffers for I/O).gzip,deflate, andzstdcompression logic in their respective modules. These are conditionally compiled based on feature flags.registry.rs): Introduces a thread-safeGlobalCompressionRegistry(backed byRwLockandArc) to manage registered compressors and decompressors. It handles safe concurrent access and automatically updates the broadcastedgrpc-accept-encodingheaders.codecandcompressionmodules to the library's root structure.