Skip to content

feat(codec): Add lz4 support #2331

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion tests/compression/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ pin-project = "1.0"
prost = "0.14"
tokio = {version = "1.0", features = ["macros", "rt-multi-thread", "net"]}
tokio-stream = "0.1"
tonic = {path = "../../tonic", features = ["gzip", "deflate", "zstd"]}
tonic = {path = "../../tonic", features = ["gzip", "deflate", "zstd", "lz4"]}
tower = "0.5"
tower-http = {version = "0.6", features = ["map-response-body", "map-request-body"]}

Expand Down
3 changes: 3 additions & 0 deletions tests/compression/src/bidirectional_stream.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ util::parametrized_tests! {
zstd: CompressionEncoding::Zstd,
gzip: CompressionEncoding::Gzip,
deflate: CompressionEncoding::Deflate,
lz4: CompressionEncoding::Lz4,
}

#[allow(dead_code)]
Expand Down Expand Up @@ -36,6 +37,7 @@ async fn client_enabled_server_enabled(encoding: CompressionEncoding) {
CompressionEncoding::Gzip => "gzip",
CompressionEncoding::Zstd => "zstd",
CompressionEncoding::Deflate => "deflate",
CompressionEncoding::Lz4 => "lz4",
_ => panic!("unexpected encoding {:?}", self.encoding),
};
assert_eq!(req.headers().get("grpc-encoding").unwrap(), expected);
Expand Down Expand Up @@ -89,6 +91,7 @@ async fn client_enabled_server_enabled(encoding: CompressionEncoding) {
CompressionEncoding::Gzip => "gzip",
CompressionEncoding::Zstd => "zstd",
CompressionEncoding::Deflate => "deflate",
CompressionEncoding::Lz4 => "lz4",
_ => panic!("unexpected encoding {encoding:?}"),
};
assert_eq!(res.metadata().get("grpc-encoding").unwrap(), expected);
Expand Down
7 changes: 7 additions & 0 deletions tests/compression/src/client_stream.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ util::parametrized_tests! {
zstd: CompressionEncoding::Zstd,
gzip: CompressionEncoding::Gzip,
deflate: CompressionEncoding::Deflate,
lz4: CompressionEncoding::Lz4,
}

#[allow(dead_code)]
Expand All @@ -33,6 +34,7 @@ async fn client_enabled_server_enabled(encoding: CompressionEncoding) {
CompressionEncoding::Gzip => "gzip",
CompressionEncoding::Zstd => "zstd",
CompressionEncoding::Deflate => "deflate",
CompressionEncoding::Lz4 => "lz4",
_ => panic!("unexpected encoding {:?}", self.encoding),
};
assert_eq!(req.headers().get("grpc-encoding").unwrap(), expected);
Expand Down Expand Up @@ -80,6 +82,7 @@ util::parametrized_tests! {
zstd: CompressionEncoding::Zstd,
gzip: CompressionEncoding::Gzip,
deflate: CompressionEncoding::Deflate,
lz4: CompressionEncoding::Lz4,
}

#[allow(dead_code)]
Expand Down Expand Up @@ -131,6 +134,7 @@ util::parametrized_tests! {
zstd: CompressionEncoding::Zstd,
gzip: CompressionEncoding::Gzip,
deflate: CompressionEncoding::Deflate,
lz4: CompressionEncoding::Lz4,
}

#[allow(dead_code)]
Expand Down Expand Up @@ -161,6 +165,7 @@ async fn client_enabled_server_disabled(encoding: CompressionEncoding) {
CompressionEncoding::Gzip => "gzip",
CompressionEncoding::Zstd => "zstd",
CompressionEncoding::Deflate => "deflate",
CompressionEncoding::Lz4 => "lz4",
_ => panic!("unexpected encoding {encoding:?}"),
};
assert_eq!(
Expand All @@ -174,6 +179,7 @@ util::parametrized_tests! {
zstd: CompressionEncoding::Zstd,
gzip: CompressionEncoding::Gzip,
deflate: CompressionEncoding::Deflate,
lz4: CompressionEncoding::Lz4,
}

#[allow(dead_code)]
Expand Down Expand Up @@ -215,6 +221,7 @@ async fn compressing_response_from_client_stream(encoding: CompressionEncoding)
CompressionEncoding::Gzip => "gzip",
CompressionEncoding::Zstd => "zstd",
CompressionEncoding::Deflate => "deflate",
CompressionEncoding::Lz4 => "lz4",
_ => panic!("unexpected encoding {encoding:?}"),
};
assert_eq!(res.metadata().get("grpc-encoding").unwrap(), expected);
Expand Down
11 changes: 9 additions & 2 deletions tests/compression/src/compressing_request.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ util::parametrized_tests! {
zstd: CompressionEncoding::Zstd,
gzip: CompressionEncoding::Gzip,
deflate: CompressionEncoding::Deflate,
lz4: CompressionEncoding::Lz4,
}

#[allow(dead_code)]
Expand All @@ -33,6 +34,7 @@ async fn client_enabled_server_enabled(encoding: CompressionEncoding) {
CompressionEncoding::Gzip => "gzip",
CompressionEncoding::Zstd => "zstd",
CompressionEncoding::Deflate => "deflate",
CompressionEncoding::Lz4 => "lz4",
_ => panic!("unexpected encoding {:?}", self.encoding),
};
assert_eq!(req.headers().get("grpc-encoding").unwrap(), expected);
Expand Down Expand Up @@ -84,6 +86,7 @@ util::parametrized_tests! {
zstd: CompressionEncoding::Zstd,
gzip: CompressionEncoding::Gzip,
deflate: CompressionEncoding::Deflate,
lz4: CompressionEncoding::Lz4,
}

#[allow(dead_code)]
Expand All @@ -93,12 +96,13 @@ async fn client_enabled_server_enabled_multi_encoding(encoding: CompressionEncod
let svc = test_server::TestServer::new(Svc::default())
.accept_compressed(CompressionEncoding::Gzip)
.accept_compressed(CompressionEncoding::Zstd)
.accept_compressed(CompressionEncoding::Deflate);
.accept_compressed(CompressionEncoding::Deflate)
.accept_compressed(CompressionEncoding::Lz4);

let request_bytes_counter = Arc::new(AtomicUsize::new(0));

fn assert_right_encoding<B>(req: http::Request<B>) -> http::Request<B> {
let supported_encodings = ["gzip", "zstd", "deflate"];
let supported_encodings = ["gzip", "zstd", "deflate", "lz4"];
let req_encoding = req.headers().get("grpc-encoding").unwrap();
assert!(supported_encodings.iter().any(|e| e == req_encoding));

Expand Down Expand Up @@ -146,6 +150,7 @@ parametrized_tests! {
zstd: CompressionEncoding::Zstd,
gzip: CompressionEncoding::Gzip,
deflate: CompressionEncoding::Deflate,
lz4: CompressionEncoding::Lz4,
}

#[allow(dead_code)]
Expand Down Expand Up @@ -177,6 +182,7 @@ async fn client_enabled_server_disabled(encoding: CompressionEncoding) {
CompressionEncoding::Gzip => "gzip",
CompressionEncoding::Zstd => "zstd",
CompressionEncoding::Deflate => "deflate",
CompressionEncoding::Lz4 => "lz4",
_ => panic!("unexpected encoding {encoding:?}"),
};
assert_eq!(
Expand All @@ -194,6 +200,7 @@ parametrized_tests! {
zstd: CompressionEncoding::Zstd,
gzip: CompressionEncoding::Gzip,
deflate: CompressionEncoding::Deflate,
lz4: CompressionEncoding::Lz4,
}

#[allow(dead_code)]
Expand Down
15 changes: 14 additions & 1 deletion tests/compression/src/compressing_response.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ util::parametrized_tests! {
zstd: CompressionEncoding::Zstd,
gzip: CompressionEncoding::Gzip,
deflate: CompressionEncoding::Deflate,
lz4: CompressionEncoding::Lz4,
}

#[allow(dead_code)]
Expand Down Expand Up @@ -38,6 +39,7 @@ async fn client_enabled_server_enabled(encoding: CompressionEncoding) {
CompressionEncoding::Gzip => "gzip",
CompressionEncoding::Zstd => "zstd",
CompressionEncoding::Deflate => "deflate",
CompressionEncoding::Lz4 => "lz4",
_ => panic!("unexpected encoding {:?}", self.encoding),
};
assert_eq!(
Expand Down Expand Up @@ -88,6 +90,7 @@ async fn client_enabled_server_enabled(encoding: CompressionEncoding) {
CompressionEncoding::Gzip => "gzip",
CompressionEncoding::Zstd => "zstd",
CompressionEncoding::Deflate => "deflate",
CompressionEncoding::Lz4 => "lz4",
_ => panic!("unexpected encoding {encoding:?}"),
};

Expand All @@ -104,6 +107,7 @@ util::parametrized_tests! {
zstd: CompressionEncoding::Zstd,
gzip: CompressionEncoding::Gzip,
deflate: CompressionEncoding::Deflate,
lz4: CompressionEncoding::Lz4,
}

#[allow(dead_code)]
Expand Down Expand Up @@ -180,7 +184,8 @@ async fn client_enabled_server_disabled_multi_encoding() {
let mut client = test_client::TestClient::new(mock_io_channel(client).await)
.accept_compressed(CompressionEncoding::Gzip)
.accept_compressed(CompressionEncoding::Zstd)
.accept_compressed(CompressionEncoding::Deflate);
.accept_compressed(CompressionEncoding::Deflate)
.accept_compressed(CompressionEncoding::Lz4);

let res = client.compress_output_unary(()).await.unwrap();

Expand All @@ -195,6 +200,7 @@ util::parametrized_tests! {
zstd: CompressionEncoding::Zstd,
gzip: CompressionEncoding::Gzip,
deflate: CompressionEncoding::Deflate,
lz4: CompressionEncoding::Lz4,
}

#[allow(dead_code)]
Expand Down Expand Up @@ -266,6 +272,7 @@ util::parametrized_tests! {
zstd: CompressionEncoding::Zstd,
gzip: CompressionEncoding::Gzip,
deflate: CompressionEncoding::Deflate,
lz4: CompressionEncoding::Lz4,
}

#[allow(dead_code)]
Expand Down Expand Up @@ -310,6 +317,7 @@ util::parametrized_tests! {
zstd: CompressionEncoding::Zstd,
gzip: CompressionEncoding::Gzip,
deflate: CompressionEncoding::Deflate,
lz4: CompressionEncoding::Lz4,
}

#[allow(dead_code)]
Expand Down Expand Up @@ -353,6 +361,7 @@ async fn disabling_compression_on_single_response(encoding: CompressionEncoding)
CompressionEncoding::Gzip => "gzip",
CompressionEncoding::Zstd => "zstd",
CompressionEncoding::Deflate => "deflate",
CompressionEncoding::Lz4 => "lz4",
_ => panic!("unexpected encoding {encoding:?}"),
};
assert_eq!(res.metadata().get("grpc-encoding").unwrap(), expected);
Expand All @@ -366,6 +375,7 @@ util::parametrized_tests! {
zstd: CompressionEncoding::Zstd,
gzip: CompressionEncoding::Gzip,
deflate: CompressionEncoding::Deflate,
lz4: CompressionEncoding::Lz4,
}

#[allow(dead_code)]
Expand Down Expand Up @@ -411,6 +421,7 @@ async fn disabling_compression_on_response_but_keeping_compression_on_stream(
CompressionEncoding::Gzip => "gzip",
CompressionEncoding::Zstd => "zstd",
CompressionEncoding::Deflate => "deflate",
CompressionEncoding::Lz4 => "lz4",
_ => panic!("unexpected encoding {encoding:?}"),
};
assert_eq!(res.metadata().get("grpc-encoding").unwrap(), expected);
Expand All @@ -437,6 +448,7 @@ util::parametrized_tests! {
zstd: CompressionEncoding::Zstd,
gzip: CompressionEncoding::Gzip,
deflate: CompressionEncoding::Deflate,
lz4: CompressionEncoding::Lz4,
}

#[allow(dead_code)]
Expand Down Expand Up @@ -482,6 +494,7 @@ async fn disabling_compression_on_response_from_client_stream(encoding: Compress
CompressionEncoding::Gzip => "gzip",
CompressionEncoding::Zstd => "zstd",
CompressionEncoding::Deflate => "deflate",
CompressionEncoding::Lz4 => "lz4",
_ => panic!("unexpected encoding {encoding:?}"),
};
assert_eq!(res.metadata().get("grpc-encoding").unwrap(), expected);
Expand Down
4 changes: 4 additions & 0 deletions tests/compression/src/server_stream.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ util::parametrized_tests! {
zstd: CompressionEncoding::Zstd,
gzip: CompressionEncoding::Gzip,
deflate: CompressionEncoding::Deflate,
lz4: CompressionEncoding::Lz4,
}

#[allow(dead_code)]
Expand Down Expand Up @@ -47,6 +48,7 @@ async fn client_enabled_server_enabled(encoding: CompressionEncoding) {
CompressionEncoding::Gzip => "gzip",
CompressionEncoding::Zstd => "zstd",
CompressionEncoding::Deflate => "deflate",
CompressionEncoding::Lz4 => "lz4",
_ => panic!("unexpected encoding {encoding:?}"),
};
assert_eq!(res.metadata().get("grpc-encoding").unwrap(), expected);
Expand All @@ -72,6 +74,7 @@ util::parametrized_tests! {
client_disabled_server_enabled,
zstd: CompressionEncoding::Zstd,
gzip: CompressionEncoding::Gzip,
lz4: CompressionEncoding::Lz4,
}

#[allow(dead_code)]
Expand Down Expand Up @@ -124,6 +127,7 @@ util::parametrized_tests! {
zstd: CompressionEncoding::Zstd,
gzip: CompressionEncoding::Gzip,
deflate: CompressionEncoding::Deflate,
lz4: CompressionEncoding::Lz4,
}

#[allow(dead_code)]
Expand Down
1 change: 1 addition & 0 deletions tests/compression/src/util.rs
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,7 @@ impl AssertRightEncoding {
CompressionEncoding::Gzip => "gzip",
CompressionEncoding::Zstd => "zstd",
CompressionEncoding::Deflate => "deflate",
CompressionEncoding::Lz4 => "lz4",
_ => panic!("unexpected encoding {:?}", self.encoding),
};
assert_eq!(req.headers().get("grpc-encoding").unwrap(), expected);
Expand Down
2 changes: 2 additions & 0 deletions tonic/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ codegen = ["dep:async-trait"]
gzip = ["dep:flate2"]
deflate = ["dep:flate2"]
zstd = ["dep:zstd"]
lz4 = ["dep:lz4_flex"]
default = ["router", "transport", "codegen", "prost"]
prost = ["dep:prost"]
_tls-any = ["dep:tokio-rustls", "dep:tokio", "tokio?/rt", "tokio?/macros"] # Internal. Please choose one of `tls-ring` or `tls-aws-lc`
Expand Down Expand Up @@ -91,6 +92,7 @@ webpki-roots = { version = "1", optional = true }
# compression
flate2 = {version = "1.0", optional = true}
zstd = { version = "0.13.0", optional = true }
lz4_flex = { version = "0.11.3", default-features = false, features = ["std", "frame"], optional = true }

# channel
hyper-timeout = {version = "0.5", optional = true}
Expand Down
Loading
Loading