1

core/src/services/lakefs/backend.rs

@@ -0,0 +1,336 @@
+// 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 std::fmt::Debug;
+use std::fmt::Formatter;
+use std::sync::Arc;
+
+use bytes::Buf;
+use http::Response;
+use http::StatusCode;
+use log::debug;
+use serde::Deserialize;
+use serde::Serialize;
+
+use super::core::LakefsCore;
+use super::core::LakefsStatus;
+use super::error::parse_error;
+use crate::raw::*;
+use crate::*;
+
+/// Configuration for Lakefs service support.
+#[derive(Default, Serialize, Deserialize, Clone, PartialEq, Eq)]
+#[serde(default)]
+#[non_exhaustive]
+pub struct LakefsConfig {
+    /// Base url.
+    ///
+    /// This is required.
+    pub endpoint: Option<String>,
+    /// Username for HTTP basic authentication.
+    ///
+    /// This is required.
+    pub username: Option<String>,
+    /// Password for HTTP basic authentication.
+    ///
+    /// This is required.
+    pub password: Option<String>,
+    /// Root of this backend. Can be "/path/to/dir".
+    ///
+    /// Default is "/".
+    pub root: Option<String>,
+
+    /// The repository name
+    ///
+    /// This is required.
+    pub repository_id: Option<String>,
+    /// Name of the branch or a commit ID. Default is main.
+    ///
+    /// This is optional.
+    pub branch: Option<String>,
+}
+
+impl Debug for LakefsConfig {
+    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
+        let mut ds = f.debug_struct("LakefsConfig");
+
+        if let Some(endpoint) = &self.endpoint {
+            ds.field("endpoint", &endpoint);
+        }
+        if let Some(username) = &self.username {
+            ds.field("username", &"<redacted>");
+        }
+        if let Some(password) = &self.password {
+            ds.field("password", &"<redacted>");
+        }
+        if let Some(root) = &self.root {
+            ds.field("root", &root);
+        }
+        if let Some(repository_id) = &self.repository_id {
+            ds.field("repository_id", &repository_id);
+        }
+        if let Some(branch) = &self.branch {
+            ds.field("branch", &branch);
+        }
+
+        ds.finish()
+    }
+}
+
+impl Configurator for LakefsConfig {
+    type Builder = LakefsBuilder;
+    fn into_builder(self) -> Self::Builder {
+        LakefsBuilder { config: self }
+    }
+}
+
+/// [Lakefs](https://docs.lakefs.io/reference/api.html#/)'s API support.
+#[doc = include_str!("docs.md")]
+#[derive(Default, Clone)]
+pub struct LakefsBuilder {
+    config: LakefsConfig,
+}
+
+impl Debug for LakefsBuilder {
+    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
+        let mut ds = f.debug_struct("Builder");
+
+        ds.field("config", &self.config);
+        ds.finish()
+    }
+}
+
+impl LakefsBuilder {
+   /// Set the endpoint of this backend.
+   ///
+   /// endpoint must be full uri.
+   ///
+   /// This is required.
+   /// - `http://127.0.0.1:8000` (lakefs daemon in local)
+   /// - `https://my-lakefs.example.com` (lakefs server)
+    pub fn endpoint(mut self, endpoint: &str) -> Self {
+        if !endpoint.is_empty() {
+            self.config.endpoint = Some(endpoint.to_string());
+        }
+        self
+    }
+
+    /// Set username of this backend. This is required.
+    pub fn username(mut self, username: &str) -> Self {
+        if !username.is_empty() {
+            self.config.username = Some(username.to_string());
+        }
+        self
+    }
+
+    /// Set password of this backend. This is required.
+    pub fn password(mut self, password: &str) -> Self {
+        if !password.is_empty() {
+            self.config.password = Some(password.to_string());
+        }
+        self
+    }
+
+    /// Set branch of this backend or a commit ID. Default is main.
+    ///
+    /// Branch can be a branch name.
+    ///
+    /// For example, branch can be:
+    /// - main
+    /// - 1d0c4eb
+    pub fn branch(mut self, branch: &str) -> Self {
+        if !branch.is_empty() {
+            self.config.branch = Some(branch.to_string());
+        }
+        self
+    }
+
+    /// Set root of this backend.
+    ///
+    /// All operations will happen under this root.
+    pub fn root(mut self, root: &str) -> Self {
+        if !root.is_empty() {
+            self.config.root = Some(root.to_string());
+        }
+        self
+    }
+
+    /// Set the repository_id of this backend.
+    ///
+    /// This is required.
+    pub fn repository_id(mut self, repository_id: &str) -> Self {
+        if !repository_id.is_empty() {
+            self.config.repository_id = Some(repository_id.to_string());
+        }
+        self
+    }
+}
+
+impl Builder for LakefsBuilder {
+    const SCHEME: Scheme = Scheme::Lakefs;
+    type Config = LakefsConfig;
+
+    /// Build a LakefsBackend.
+    fn build(self) -> Result<impl Access> {
+        debug!("backend build started: {:?}", &self);
+
+        let endpoint = match self.config.endpoint {
+            Some(endpoint) => Ok(endpoint.clone()),
+            None => Err(Error::new(ErrorKind::ConfigInvalid, "endpoint is empty")
+                .with_operation("Builder::build")
+                .with_context("service", Scheme::Lakefs)),
+        }?;
+        debug!("backend use endpoint: {:?}", &endpoint);
+
+        let repository_id = match &self.config.repository_id {
+            Some(repository_id) => Ok(repository_id.clone()),
+            None => Err(Error::new(ErrorKind::ConfigInvalid, "repository_id is empty")
+                .with_operation("Builder::build")
+                .with_context("service", Scheme::Lakefs)),
+        }?;
+        debug!("backend use repository_id: {}", &repository_id);
+
+        let branch = match &self.config.branch {
+            Some(branch) => branch.clone(),
+            None => "main".to_string(),
+        };
+        debug!("backend use branch: {}", &branch);
+
+        let root = normalize_root(&self.config.root.unwrap_or_default());
+        debug!("backend use root: {}", &root);
+
+        let username = match &self.config.username {
+            Some(username) => Ok(username.clone()),
+            None => Err(Error::new(ErrorKind::ConfigInvalid, "username is empty")
+                .with_operation("Builder::build")
+                .with_context("service", Scheme::Lakefs)),
+        }?;
+
+        let password = match &self.config.password {
+            Some(password) => Ok(password.clone()),
+            None => Err(Error::new(ErrorKind::ConfigInvalid, "password is empty")
+                .with_operation("Builder::build")
+                .with_context("service", Scheme::Lakefs)),
+        }?;
+
+        let client = HttpClient::new()?;
+
+        Ok(LakefsBackend {
+            core: Arc::new(LakefsCore {
+                endpoint,
+                repository_id,
+                branch,
+                root,
+                username,
+                password,
+                client,
+            }),
+        })
+    }
+}
+
+/// Backend for Lakefs service
+#[derive(Debug, Clone)]
+pub struct LakefsBackend {
+    core: Arc<LakefsCore>,
+}
+
+impl Access for LakefsBackend {
+    type Reader = HttpBody;
+    type Writer = ();
+    type Lister = ();
+    type BlockingReader = ();
+    type BlockingWriter = ();
+    type BlockingLister = ();
+
+    fn info(&self) -> Arc<AccessorInfo> {
+        let mut am = AccessorInfo::default();
+        am.set_scheme(Scheme::Lakefs)
+            .set_native_capability(Capability {
+                stat: true,
+
+                read: true,
+
+                list: true,
+                list_with_recursive: true,
+
+                ..Default::default()
+            });
+        am.into()
+    }
+
+    async fn stat(&self, path: &str, _: OpStat) -> Result<RpStat> {
+        // Stat root always returns a DIR.
+        if path == "/" {
+            return Ok(RpStat::new(Metadata::new(EntryMode::DIR)));
+        }
+
+        let resp = self.core.get_file_meta(path).await?;
+
+        let status = resp.status();
+
+        match status {
+            StatusCode::OK => {
+                let mut meta = parse_into_metadata(path, resp.headers())?;
+                let bs = resp.into_body();
+
+                let decoded_response: Vec<LakefsStatus> =
+                    serde_json::from_reader(bs.reader()).map_err(new_json_deserialize_error)?;
+
+                // NOTE: if the file is not found, the server will return 200 with an empty array
+                if let Some(status) = decoded_response.first() {
+                    if let Some(commit_info) = status.last_commit.as_ref() {
+                        meta.set_last_modified(parse_datetime_from_rfc3339(
+                            commit_info.date.as_str(),
+                        )?);
+                    }
+
+                    meta.set_content_length(status.size);
+
+                    match status.type_.as_str() {
+                        "directory" => meta.set_mode(EntryMode::DIR),
+                        "file" => meta.set_mode(EntryMode::FILE),
+                        _ => return Err(Error::new(ErrorKind::Unexpected, "unknown status type")),
+                    };
+                } else {
+                    return Err(Error::new(ErrorKind::NotFound, "path not found"));
+                }
+
+                Ok(RpStat::new(meta))
+            }
+            _ => Err(parse_error(resp).await?),
+        }
+    }
+
+    async fn read(&self, path: &str, args: OpRead) -> Result<(RpRead, Self::Reader)> {
+        let resp = self.core.get_file(path, args.range(), &args).await?;
+
+        let status = resp.status();
+
+        match status {
+            StatusCode::OK | StatusCode::PARTIAL_CONTENT => {
+                Ok((RpRead::default(), resp.into_body()))
+            }
+            _ => {
+                let (part, mut body) = resp.into_parts();
+                let buf = body.to_buffer().await?;
+                Err(parse_error(Response::from_parts(part, buf)).await?)
+            }
+        }
+    }
+
+}