tustvold commented on code in PR #3380: URL: https://github.com/apache/arrow-rs/pull/3380#discussion_r1054851937
########## object_store/src/http/mod.rs: ########## @@ -0,0 +1,281 @@ +// 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. + +//! An object store implementation for generic HTTP servers +//! +//! This follows [rfc2518] commonly known called [WebDAV] +//! +//! Basic get support will work out of the box with most HTTP servers, +//! even those that don't explicitly support [rfc2518] +//! +//! Other operations such as list, delete, copy, etc... will likely +//! require server-side configuration. A list of HTTP servers with support +//! can be found [here](https://wiki.archlinux.org/title/WebDAV#Server) +//! +//! Multipart uploads are not currently supported +//! +//! [rfc2518]: https://datatracker.ietf.org/doc/html/rfc2518 +//! [WebDAV]: https://en.wikipedia.org/wiki/WebDAV + +use std::ops::Range; + +use async_trait::async_trait; +use bytes::Bytes; +use futures::stream::BoxStream; +use futures::{StreamExt, TryStreamExt}; +use snafu::{OptionExt, ResultExt, Snafu}; +use tokio::io::AsyncWrite; +use url::Url; + +use crate::http::client::Client; +use crate::path::Path; +use crate::{ + ClientOptions, GetResult, ListResult, MultipartId, ObjectMeta, ObjectStore, Result, + RetryConfig, +}; + +mod client; + +#[derive(Debug, Snafu)] +enum Error { + #[snafu(display("Must specify a URL"))] + MissingUrl, + + #[snafu(display("Invalid URL: {}", source))] + InvalidUrl { source: reqwest::Error }, + + #[snafu(display("Object is a directory"))] + IsDirectory, + + #[snafu(display("PROPFIND response contained no valid objects"))] + NoObjects, + + #[snafu(display("PROPFIND response contained more than one object"))] + MultipleObjects, + + #[snafu(display("Request error: {}", source))] + Reqwest { source: reqwest::Error }, +} + +impl From<Error> for crate::Error { + fn from(err: Error) -> Self { + Self::Generic { + store: "HTTP", + source: Box::new(err), + } + } +} + +/// An [`ObjectStore`] implementation for generic HTTP servers +/// +/// See [`crate::http`] for more information +#[derive(Debug)] +pub struct HttpStore { + client: Client, +} + +impl std::fmt::Display for HttpStore { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "HttpStore") + } +} + +#[async_trait] +impl ObjectStore for HttpStore { + async fn put(&self, location: &Path, bytes: Bytes) -> Result<()> { + self.client.put(location, bytes).await + } + + async fn put_multipart( + &self, + _location: &Path, + ) -> Result<(MultipartId, Box<dyn AsyncWrite + Unpin + Send>)> { + Err(super::Error::NotImplemented) + } + + async fn abort_multipart( + &self, + _location: &Path, + _multipart_id: &MultipartId, + ) -> Result<()> { + Err(super::Error::NotImplemented) + } + + async fn get(&self, location: &Path) -> Result<GetResult> { + let response = self.client.get(location, None).await?; + let stream = response + .bytes_stream() + .map_err(|source| Error::Reqwest { source }.into()) + .boxed(); + + Ok(GetResult::Stream(stream)) + } + + async fn get_range(&self, location: &Path, range: Range<usize>) -> Result<Bytes> { + let bytes = self + .client + .get(location, Some(range)) + .await? + .bytes() + .await + .context(ReqwestSnafu)?; + Ok(bytes) + } + + async fn head(&self, location: &Path) -> Result<ObjectMeta> { + let status = self.client.list(Some(location), "0").await?; + match status.response.len() { + 1 => { + let response = status.response.into_iter().next().unwrap(); + response.check_ok()?; + match response.is_dir() { + true => Err(Error::IsDirectory.into()), + false => response.object_meta(self.client.base_url()), + } + } + 0 => Err(Error::NoObjects.into()), + _ => Err(Error::MultipleObjects.into()), + } + } + + async fn delete(&self, location: &Path) -> Result<()> { + self.client.delete(location).await + } + + async fn list( + &self, + prefix: Option<&Path>, + ) -> Result<BoxStream<'_, Result<ObjectMeta>>> { + let status = self.client.list(prefix, "infinity").await?; + Ok(futures::stream::iter( + status + .response + .into_iter() + .filter(|r| !r.is_dir()) + .map(|response| { + response.check_ok()?; + response.object_meta(self.client.base_url()) + }), + ) + .boxed()) + } + + async fn list_with_delimiter(&self, prefix: Option<&Path>) -> Result<ListResult> { + let status = self.client.list(prefix, "1").await?; + let prefix_len = prefix.map(|p| p.as_ref().len()).unwrap_or(0); + + let mut objects: Vec<ObjectMeta> = Vec::with_capacity(status.response.len()); + let mut common_prefixes = Vec::with_capacity(status.response.len()); + for response in status.response { + response.check_ok()?; + match response.is_dir() { + false => objects.push(response.object_meta(self.client.base_url())?), + true => { + let path = response.path(self.client.base_url())?; + // Exclude the current object + if path.as_ref().len() > prefix_len { + common_prefixes.push(path); + } + } + } + } + + Ok(ListResult { + common_prefixes, + objects, + }) + } + + async fn copy(&self, from: &Path, to: &Path) -> Result<()> { + self.client.copy(from, to, true).await + } + + async fn copy_if_not_exists(&self, from: &Path, to: &Path) -> Result<()> { + self.client.copy(from, to, false).await + } +} + +/// Configure a connection to a generic HTTP server +#[derive(Debug, Default)] +pub struct HttpBuilder { + url: Option<Result<Url>>, + client_options: ClientOptions, + retry_config: RetryConfig, +} + +impl HttpBuilder { Review Comment: I think unlike S3 or GCP there aren't standard environment variables to use for this purpose, mirroring those used by an SDK, so I think best to leave it for now -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: github-unsubscr...@arrow.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
