core/services/memcached/src/backend.rs

// 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::borrow::Cow;
use std::sync::Arc;
use url::Url;

use opendal_core::raw::*;
use opendal_core::*;

use super::MEMCACHED_SCHEME;
use super::config::MemcachedConfig;
use super::core::*;
use super::deleter::MemcachedDeleter;
use super::writer::MemcachedWriter;

/// [Memcached](https://memcached.org/) service support.
#[doc = include_str!("docs.md")]
#[derive(Debug, Default)]
pub struct MemcachedBuilder {
    pub(super) config: MemcachedConfig,
}

impl MemcachedBuilder {
    /// set the network address of memcached service.
    ///
    /// For example: "tcp://localhost:11211"
    pub fn endpoint(mut self, endpoint: &str) -> Self {
        if !endpoint.is_empty() {
            self.config.endpoint = Some(endpoint.to_owned());
        }
        self
    }

    /// set the working directory, all operations will be performed under it.
    ///
    /// default: "/"
    pub fn root(mut self, root: &str) -> Self {
        self.config.root = if root.is_empty() {
            None
        } else {
            Some(root.to_string())
        };

        self
    }

    /// set the username.
    pub fn username(mut self, username: &str) -> Self {
        self.config.username = Some(username.to_string());
        self
    }

    /// set the password.
    pub fn password(mut self, password: &str) -> Self {
        self.config.password = Some(password.to_string());
        self
    }

    /// Set the default ttl for memcached services.
    pub fn default_ttl(mut self, ttl: Duration) -> Self {
        self.config.default_ttl = Some(ttl);
        self
    }

    /// Sets the maximum number of connections managed by the pool.
    ///
    /// Defaults to 10.
    ///
    /// # Panics
    ///
    /// Will panic if `max_size` is 0.
    #[must_use]
    pub fn connection_pool_max_size(mut self, max_size: usize) -> Self {
        assert!(max_size > 0, "max_size must be greater than zero!");
        self.config.connection_pool_max_size = Some(max_size);
        self
    }
}

impl Builder for MemcachedBuilder {
    type Config = MemcachedConfig;

    fn build(self) -> Result<impl Access> {
        let endpoint_raw = self.config.endpoint.clone().ok_or_else(|| {
            Error::new(ErrorKind::ConfigInvalid, "endpoint is empty")
                .with_context("service", MEMCACHED_SCHEME)
        })?;

        let url_str = if !endpoint_raw.contains("://") {
            Cow::Owned(format!("tcp://{}", endpoint_raw))
        } else {
            Cow::Borrowed(endpoint_raw.as_str())
        };

        let parsed = Url::parse(&url_str).map_err(|err| {
            Error::new(ErrorKind::ConfigInvalid, "endpoint is invalid")
                .with_context("service", MEMCACHED_SCHEME)
                .with_context("endpoint", &endpoint_raw)
                .set_source(err)
        })?;

        let endpoint = match parsed.scheme() {
            "tcp" => {
                let host = parsed.host_str().ok_or_else(|| {
                    Error::new(ErrorKind::ConfigInvalid, "tcp endpoint doesn't have host")
                        .with_context("service", MEMCACHED_SCHEME)
                        .with_context("endpoint", &endpoint_raw)
                })?;
                let port = parsed.port().ok_or_else(|| {
                    Error::new(ErrorKind::ConfigInvalid, "tcp endpoint doesn't have port")
                        .with_context("service", MEMCACHED_SCHEME)
                        .with_context("endpoint", &endpoint_raw)
                })?;
                Endpoint::Tcp(format!("{host}:{port}"))
            }

            #[cfg(unix)]
            "unix" => {
                let path = parsed.path();
                if path.is_empty() {
                    return Err(Error::new(
                        ErrorKind::ConfigInvalid,
                        "unix endpoint doesn't have path",
                    )
                    .with_context("service", MEMCACHED_SCHEME)
                    .with_context("endpoint", &endpoint_raw));
                }
                Endpoint::Unix(path.to_string())
            }

            #[cfg(not(unix))]
            "unix" => {
                return Err(Error::new(
                    ErrorKind::ConfigInvalid,
                    "unix socket is not supported on this platform",
                )
                .with_context("service", MEMCACHED_SCHEME)
                .with_context("endpoint", &endpoint_raw));
            }

            scheme => {
                return Err(Error::new(
                    ErrorKind::ConfigInvalid,
                    "endpoint is using invalid scheme, only tcp and unix are supported",
                )
                .with_context("service", MEMCACHED_SCHEME)
                .with_context("endpoint", &endpoint_raw)
                .with_context("scheme", scheme));
            }
        };

        let root = normalize_root(self.config.root.unwrap_or_else(|| "/".to_string()).as_str());

        Ok(MemcachedBackend::new(MemcachedCore::new(
            endpoint,
            self.config.username,
            self.config.password,
            self.config.default_ttl,
            self.config.connection_pool_max_size,
        ))
        .with_normalized_root(root))
    }
}

/// Backend for memcached services.
#[derive(Clone, Debug)]
pub struct MemcachedBackend {
    core: Arc<MemcachedCore>,
    root: String,
    info: Arc<AccessorInfo>,
}

impl MemcachedBackend {
    pub fn new(core: MemcachedCore) -> Self {
        let info = AccessorInfo::default();
        info.set_scheme(MEMCACHED_SCHEME);
        info.set_name("memcached");
        info.set_root("/");
        info.set_native_capability(Capability {
            read: true,
            stat: true,
            write: true,
            write_can_empty: true,
            delete: true,
            shared: true,
            ..Default::default()
        });

        Self {
            core: Arc::new(core),
            root: "/".to_string(),
            info: Arc::new(info),
        }
    }

    fn with_normalized_root(mut self, root: String) -> Self {
        self.info.set_root(&root);
        self.root = root;
        self
    }
}

impl Access for MemcachedBackend {
    type Reader = Buffer;
    type Writer = MemcachedWriter;
    type Lister = ();
    type Deleter = oio::OneShotDeleter<MemcachedDeleter>;

    fn info(&self) -> Arc<AccessorInfo> {
        self.info.clone()
    }

    async fn stat(&self, path: &str, _: OpStat) -> Result<RpStat> {
        let p = build_abs_path(&self.root, path);

        if p == build_abs_path(&self.root, "") {
            Ok(RpStat::new(Metadata::new(EntryMode::DIR)))
        } else {
            let bs = self.core.get(&p).await?;
            match bs {
                Some(bs) => Ok(RpStat::new(
                    Metadata::new(EntryMode::FILE).with_content_length(bs.len() as u64),
                )),
                None => Err(Error::new(ErrorKind::NotFound, "kv not found in memcached")),
            }
        }
    }

    async fn read(&self, path: &str, args: OpRead) -> Result<(RpRead, Self::Reader)> {
        let p = build_abs_path(&self.root, path);
        let bs = match self.core.get(&p).await? {
            Some(bs) => bs,
            None => return Err(Error::new(ErrorKind::NotFound, "kv not found in memcached")),
        };
        Ok((RpRead::new(), bs.slice(args.range().to_range_as_usize())))
    }

    async fn write(&self, path: &str, _: OpWrite) -> Result<(RpWrite, Self::Writer)> {
        let p = build_abs_path(&self.root, path);
        Ok((RpWrite::new(), MemcachedWriter::new(self.core.clone(), p)))
    }

    async fn delete(&self) -> Result<(RpDelete, Self::Deleter)> {
        Ok((
            RpDelete::default(),
            oio::OneShotDeleter::new(MemcachedDeleter::new(self.core.clone(), self.root.clone())),
        ))
    }
}