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

Always explicitly disable gzip automatic decompression on reqwest client used by object_store #6843

Merged
merged 5 commits into from
Dec 11, 2024
Merged
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: 2 additions & 0 deletions object_store/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ http-body-util = "0.1"
rand = "0.8"
tempfile = "3.1.0"
regex = "1.11.1"
# The "gzip" feature for reqwest is enabled for an integration test.
reqwest = { version = "0.12", features = ["gzip"] }
phillipleblanc marked this conversation as resolved.
Show resolved Hide resolved
http = "1.1.0"

[[test]]
Expand Down
4 changes: 4 additions & 0 deletions object_store/src/client/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -671,6 +671,10 @@ impl ClientOptions {
builder = builder.danger_accept_invalid_certs(true)
}

// Reqwest will remove the `Content-Length` header if it is configured to
// transparently decompress the body via the non-default `gzip` feature.
builder = builder.no_gzip();
Copy link
Contributor

Choose a reason for hiding this comment

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

does this mean that gzipped data content will be left gzipped?

So if I request a resource that the server gzip's in response, that the result I get from ObjectStore::get would also be gzipped 🤔

Copy link
Contributor Author

@phillipleblanc phillipleblanc Dec 7, 2024

Choose a reason for hiding this comment

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

Yes, that is correct - sorry I could have made this clearer.

All this affects is what happens when the response has the header Content-Encoding: gzip, which HTTP servers will usually only do when the request has the header Accept-Encoding: gzip. If that is the case, then reqwest will transparently decode the body as a gzip stream and remove the Content-Length header (if the gzip feature is enabled - this no_gzip function explicitly disables that behavior even if the feature is)

For object store APIs, it will just return the bytes of the object as they are (including objects that are gzipped).


builder
.https_only(!self.allow_http.get()?)
.build()
Expand Down
43 changes: 43 additions & 0 deletions object_store/tests/http.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

//! Tests the HTTP store implementation

#[cfg(feature = "http")]
use object_store::{http::HttpBuilder, path::Path, GetOptions, GetRange, ObjectStore};

/// Tests that even when reqwest has the `gzip` feature enabled, the HTTP store
/// does not error on a missing `Content-Length` header.
#[tokio::test]
#[cfg(feature = "http")]
async fn test_http_store_gzip() {
let http_store = HttpBuilder::new()
.with_url("https://raw.githubusercontent.com/apache/arrow-rs/refs/heads/main")
.build()
.unwrap();

let _ = http_store
.get_opts(
&Path::parse("LICENSE.txt").unwrap(),
GetOptions {
range: Some(GetRange::Bounded(0..100)),
..Default::default()
},
)
.await
.unwrap();
}
Loading