opendal/services/alluxio/
backend.rs

1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements.  See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership.  The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License.  You may obtain a copy of the License at
8//
9//   http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied.  See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18use std::fmt::Debug;
19use std::fmt::Formatter;
20use std::sync::Arc;
21
22use http::Response;
23use log::debug;
24
25use super::core::AlluxioCore;
26use super::delete::AlluxioDeleter;
27use super::error::parse_error;
28use super::lister::AlluxioLister;
29use super::writer::AlluxioWriter;
30use super::writer::AlluxioWriters;
31use crate::raw::*;
32use crate::services::AlluxioConfig;
33use crate::*;
34
35impl Configurator for AlluxioConfig {
36    type Builder = AlluxioBuilder;
37
38    #[allow(deprecated)]
39    fn into_builder(self) -> Self::Builder {
40        AlluxioBuilder {
41            config: self,
42            http_client: None,
43        }
44    }
45}
46
47/// [Alluxio](https://www.alluxio.io/) services support.
48#[doc = include_str!("docs.md")]
49#[derive(Default)]
50pub struct AlluxioBuilder {
51    config: AlluxioConfig,
52
53    #[deprecated(since = "0.53.0", note = "Use `Operator::update_http_client` instead")]
54    http_client: Option<HttpClient>,
55}
56
57impl Debug for AlluxioBuilder {
58    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
59        let mut d = f.debug_struct("AlluxioBuilder");
60
61        d.field("config", &self.config);
62        d.finish_non_exhaustive()
63    }
64}
65
66impl AlluxioBuilder {
67    /// Set root of this backend.
68    ///
69    /// All operations will happen under this root.
70    pub fn root(mut self, root: &str) -> Self {
71        self.config.root = if root.is_empty() {
72            None
73        } else {
74            Some(root.to_string())
75        };
76
77        self
78    }
79
80    /// endpoint of this backend.
81    ///
82    /// Endpoint must be full uri, mostly like `http://127.0.0.1:39999`.
83    pub fn endpoint(mut self, endpoint: &str) -> Self {
84        if !endpoint.is_empty() {
85            // Trim trailing `/` so that we can accept `http://127.0.0.1:39999/`
86            self.config.endpoint = Some(endpoint.trim_end_matches('/').to_string())
87        }
88
89        self
90    }
91
92    /// Specify the http client that used by this service.
93    ///
94    /// # Notes
95    ///
96    /// This API is part of OpenDAL's Raw API. `HttpClient` could be changed
97    /// during minor updates.
98    #[deprecated(since = "0.53.0", note = "Use `Operator::update_http_client` instead")]
99    #[allow(deprecated)]
100    pub fn http_client(mut self, client: HttpClient) -> Self {
101        self.http_client = Some(client);
102        self
103    }
104}
105
106impl Builder for AlluxioBuilder {
107    const SCHEME: Scheme = Scheme::Alluxio;
108    type Config = AlluxioConfig;
109
110    /// Builds the backend and returns the result of AlluxioBackend.
111    fn build(self) -> Result<impl Access> {
112        debug!("backend build started: {:?}", &self);
113
114        let root = normalize_root(&self.config.root.clone().unwrap_or_default());
115        debug!("backend use root {}", &root);
116
117        let endpoint = match &self.config.endpoint {
118            Some(endpoint) => Ok(endpoint.clone()),
119            None => Err(Error::new(ErrorKind::ConfigInvalid, "endpoint is empty")
120                .with_operation("Builder::build")
121                .with_context("service", Scheme::Alluxio)),
122        }?;
123        debug!("backend use endpoint {}", &endpoint);
124
125        Ok(AlluxioBackend {
126            core: Arc::new(AlluxioCore {
127                info: {
128                    let am = AccessorInfo::default();
129                    am.set_scheme(Scheme::Alluxio)
130                        .set_root(&root)
131                        .set_native_capability(Capability {
132                            stat: true,
133
134                            // FIXME:
135                            //
136                            // alluxio's read support is not implemented correctly
137                            // We need to refactor by use [page_read](https://github.com/Alluxio/alluxio-py/blob/main/alluxio/const.py#L18)
138                            read: false,
139
140                            write: true,
141                            write_can_multi: true,
142
143                            create_dir: true,
144                            delete: true,
145
146                            list: true,
147
148                            shared: true,
149                            stat_has_content_length: true,
150                            stat_has_last_modified: true,
151                            list_has_content_length: true,
152                            list_has_last_modified: true,
153
154                            ..Default::default()
155                        });
156
157                    // allow deprecated api here for compatibility
158                    #[allow(deprecated)]
159                    if let Some(client) = self.http_client {
160                        am.update_http_client(|_| client);
161                    }
162
163                    am.into()
164                },
165                root,
166                endpoint,
167            }),
168        })
169    }
170}
171
172#[derive(Debug, Clone)]
173pub struct AlluxioBackend {
174    core: Arc<AlluxioCore>,
175}
176
177impl Access for AlluxioBackend {
178    type Reader = HttpBody;
179    type Writer = AlluxioWriters;
180    type Lister = oio::PageLister<AlluxioLister>;
181    type Deleter = oio::OneShotDeleter<AlluxioDeleter>;
182    type BlockingReader = ();
183    type BlockingWriter = ();
184    type BlockingLister = ();
185    type BlockingDeleter = ();
186
187    fn info(&self) -> Arc<AccessorInfo> {
188        self.core.info.clone()
189    }
190
191    async fn create_dir(&self, path: &str, _: OpCreateDir) -> Result<RpCreateDir> {
192        self.core.create_dir(path).await?;
193        Ok(RpCreateDir::default())
194    }
195
196    async fn stat(&self, path: &str, _: OpStat) -> Result<RpStat> {
197        let file_info = self.core.get_status(path).await?;
198
199        Ok(RpStat::new(file_info.try_into()?))
200    }
201
202    async fn read(&self, path: &str, args: OpRead) -> Result<(RpRead, Self::Reader)> {
203        let stream_id = self.core.open_file(path).await?;
204
205        let resp = self.core.read(stream_id, args.range()).await?;
206        if !resp.status().is_success() {
207            let (part, mut body) = resp.into_parts();
208            let buf = body.to_buffer().await?;
209            return Err(parse_error(Response::from_parts(part, buf)));
210        }
211        Ok((RpRead::new(), resp.into_body()))
212    }
213
214    async fn write(&self, path: &str, args: OpWrite) -> Result<(RpWrite, Self::Writer)> {
215        let w = AlluxioWriter::new(self.core.clone(), args.clone(), path.to_string());
216
217        Ok((RpWrite::default(), w))
218    }
219
220    async fn delete(&self) -> Result<(RpDelete, Self::Deleter)> {
221        Ok((
222            RpDelete::default(),
223            oio::OneShotDeleter::new(AlluxioDeleter::new(self.core.clone())),
224        ))
225    }
226
227    async fn list(&self, path: &str, _args: OpList) -> Result<(RpList, Self::Lister)> {
228        let l = AlluxioLister::new(self.core.clone(), path);
229        Ok((RpList::default(), oio::PageLister::new(l)))
230    }
231
232    async fn rename(&self, from: &str, to: &str, _: OpRename) -> Result<RpRename> {
233        self.core.rename(from, to).await?;
234
235        Ok(RpRename::default())
236    }
237}
238
239#[cfg(test)]
240mod test {
241    use std::collections::HashMap;
242
243    use super::*;
244
245    #[test]
246    fn test_builder_from_map() {
247        let mut map = HashMap::new();
248        map.insert("root".to_string(), "/".to_string());
249        map.insert("endpoint".to_string(), "http://127.0.0.1:39999".to_string());
250
251        let builder = AlluxioConfig::from_iter(map).unwrap();
252
253        assert_eq!(builder.root, Some("/".to_string()));
254        assert_eq!(builder.endpoint, Some("http://127.0.0.1:39999".to_string()));
255    }
256
257    #[test]
258    fn test_builder_build() {
259        let builder = AlluxioBuilder::default()
260            .root("/root")
261            .endpoint("http://127.0.0.1:39999")
262            .build();
263
264        assert!(builder.is_ok());
265    }
266}
opendal/services/alluxio/backend.rs

opendal/services/alluxio/
backend.rs
