alamb commented on code in PR #2352: URL: https://github.com/apache/arrow-rs/pull/2352#discussion_r943385887
########## object_store/src/aws/client.rs: ########## @@ -0,0 +1,486 @@ +// 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. + +use crate::aws::credential::{AwsCredential, CredentialExt, CredentialProvider}; +use crate::client::pagination::paginated; +use crate::client::retry::RetryExt; +use crate::multipart::UploadPart; +use crate::path::DELIMITER; +use crate::util::{format_http_range, format_prefix}; +use crate::{ + BoxStream, ListResult, MultipartId, ObjectMeta, Path, Result, RetryConfig, StreamExt, +}; +use bytes::{Buf, Bytes}; +use chrono::{DateTime, Utc}; +use percent_encoding::{utf8_percent_encode, AsciiSet, PercentEncode, NON_ALPHANUMERIC}; +use reqwest::{Client, Method, Response, StatusCode}; +use serde::{Deserialize, Serialize}; +use snafu::{ResultExt, Snafu}; +use std::ops::Range; +use std::sync::Arc; + +// http://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html +// +// Do not URI-encode any of the unreserved characters that RFC 3986 defines: +// A-Z, a-z, 0-9, hyphen ( - ), underscore ( _ ), period ( . ), and tilde ( ~ ). +const STRICT_ENCODE_SET: AsciiSet = NON_ALPHANUMERIC + .remove(b'-') + .remove(b'.') + .remove(b'_') + .remove(b'~'); + +/// This struct is used to maintain the URI path encoding +const STRICT_PATH_ENCODE_SET: AsciiSet = STRICT_ENCODE_SET.remove(b'/'); + +/// A specialized `Error` for object store-related errors +#[derive(Debug, Snafu)] +#[allow(missing_docs)] +pub(crate) enum Error { + #[snafu(display("Error performing get request {}: {}", path, source))] + GetRequest { + source: reqwest::Error, + path: String, + }, + + #[snafu(display("Error performing put request {}: {}", path, source))] + PutRequest { + source: reqwest::Error, + path: String, + }, + + #[snafu(display("Error performing delete request {}: {}", path, source))] + DeleteRequest { + source: reqwest::Error, + path: String, + }, + + #[snafu(display("Error performing copy request {}: {}", path, source))] + CopyRequest { + source: reqwest::Error, + path: String, + }, + + #[snafu(display("Error performing list request: {}", source))] + ListRequest { source: reqwest::Error }, + + #[snafu(display("Error performing create multipart request: {}", source))] + CreateMultipartRequest { source: reqwest::Error }, + + #[snafu(display("Error performing complete multipart request: {}", source))] + CompleteMultipartRequest { source: reqwest::Error }, + + #[snafu(display("Got invalid list response: {}", source))] + InvalidListResponse { source: quick_xml::de::DeError }, + + #[snafu(display("Got invalid multipart response: {}", source))] + InvalidMultipartResponse { source: quick_xml::de::DeError }, +} + +impl From<Error> for crate::Error { + fn from(err: Error) -> Self { + match err { + Error::GetRequest { source, path } + | Error::DeleteRequest { source, path } + | Error::CopyRequest { source, path } + | Error::PutRequest { source, path } + if matches!(source.status(), Some(StatusCode::NOT_FOUND)) => + { + Self::NotFound { + path, + source: Box::new(source), + } + } + _ => Self::Generic { + store: "S3", + source: Box::new(err), + }, + } + } +} + +#[derive(Debug, Deserialize)] +#[serde(rename_all = "PascalCase")] +pub struct ListResponse { + #[serde(default)] + pub contents: Vec<ListContents>, + #[serde(default)] + pub common_prefixes: Vec<ListPrefix>, + #[serde(default)] + pub next_continuation_token: Option<String>, +} + +impl TryFrom<ListResponse> for ListResult { + type Error = crate::Error; + + fn try_from(value: ListResponse) -> Result<Self> { + let common_prefixes = value + .common_prefixes + .into_iter() + .map(|x| Ok(Path::parse(&x.prefix)?)) + .collect::<Result<_>>()?; + + let objects = value + .contents + .into_iter() + .map(TryFrom::try_from) + .collect::<Result<_>>()?; + + Ok(Self { + common_prefixes, + objects, + }) + } +} + +#[derive(Debug, Deserialize)] +#[serde(rename_all = "PascalCase")] +pub struct ListPrefix { + pub prefix: String, +} + +#[derive(Debug, Deserialize)] +#[serde(rename_all = "PascalCase")] +pub struct ListContents { + pub key: String, + pub size: usize, + pub last_modified: DateTime<Utc>, +} + +impl TryFrom<ListContents> for ObjectMeta { + type Error = crate::Error; + + fn try_from(value: ListContents) -> Result<Self> { + Ok(Self { + location: Path::parse(value.key)?, + last_modified: value.last_modified, + size: value.size, + }) + } +} + +#[derive(Debug, Deserialize)] +#[serde(rename_all = "PascalCase")] +struct InitiateMultipart { + upload_id: String, +} + +#[derive(Debug, Serialize)] +#[serde(rename_all = "PascalCase", rename = "CompleteMultipartUpload")] +struct CompleteMultipart { + part: Vec<MultipartPart>, +} + +#[derive(Debug, Serialize)] +struct MultipartPart { + #[serde(rename = "$unflatten=ETag")] + e_tag: String, + #[serde(rename = "$unflatten=PartNumber")] + part_number: usize, +} + +#[derive(Debug)] +pub struct S3Config { + pub region: String, + pub endpoint: String, + pub bucket: String, + pub credentials: CredentialProvider, + pub retry_config: RetryConfig, + pub allow_http: bool, +} + +impl S3Config { + fn path_url(&self, path: &Path) -> String { + format!("{}/{}/{}", self.endpoint, self.bucket, encode_path(path)) + } +} + +#[derive(Debug)] +pub(crate) struct S3Client { + config: S3Config, + client: Client, Review Comment:  -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
