opendal/services/redis/
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 bb8::RunError;
19use bytes::Bytes;
20use http::Uri;
21use redis::cluster::ClusterClient;
22use redis::cluster::ClusterClientBuilder;
23use redis::ConnectionAddr;
24use redis::ConnectionInfo;
25use redis::ProtocolVersion;
26use redis::RedisConnectionInfo;
27use redis::{AsyncCommands, Client};
28use std::fmt::Debug;
29use std::fmt::Formatter;
30use std::path::PathBuf;
31use std::time::Duration;
32use tokio::sync::OnceCell;
33
34use super::core::*;
35use crate::raw::adapters::kv;
36use crate::raw::*;
37use crate::services::RedisConfig;
38use crate::*;
39
40const DEFAULT_REDIS_ENDPOINT: &str = "tcp://127.0.0.1:6379";
41const DEFAULT_REDIS_PORT: u16 = 6379;
42
43impl Configurator for RedisConfig {
44    type Builder = RedisBuilder;
45    fn into_builder(self) -> Self::Builder {
46        RedisBuilder { config: self }
47    }
48}
49
50/// [Redis](https://redis.io/) services support.
51#[doc = include_str!("docs.md")]
52#[derive(Clone, Default)]
53pub struct RedisBuilder {
54    config: RedisConfig,
55}
56
57impl Debug for RedisBuilder {
58    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
59        let mut d = f.debug_struct("RedisBuilder");
60
61        d.field("config", &self.config);
62        d.finish_non_exhaustive()
63    }
64}
65
66impl RedisBuilder {
67    /// set the network address of redis service.
68    ///
69    /// currently supported schemes:
70    /// - no scheme: will be seen as "tcp"
71    /// - "tcp" or "redis": unsecured redis connections
72    /// - "rediss": secured redis connections
73    /// - "unix" or "redis+unix": unix socket connection
74    pub fn endpoint(mut self, endpoint: &str) -> Self {
75        if !endpoint.is_empty() {
76            self.config.endpoint = Some(endpoint.to_owned());
77        }
78        self
79    }
80
81    /// set the network address of redis cluster service.
82    /// This parameter is mutually exclusive with the endpoint parameter.
83    ///
84    /// currently supported schemes:
85    /// - no scheme: will be seen as "tcp"
86    /// - "tcp" or "redis": unsecured redis connections
87    /// - "rediss": secured redis connections
88    /// - "unix" or "redis+unix": unix socket connection
89    pub fn cluster_endpoints(mut self, cluster_endpoints: &str) -> Self {
90        if !cluster_endpoints.is_empty() {
91            self.config.cluster_endpoints = Some(cluster_endpoints.to_owned());
92        }
93        self
94    }
95
96    /// set the username for redis
97    ///
98    /// default: no username
99    pub fn username(mut self, username: &str) -> Self {
100        if !username.is_empty() {
101            self.config.username = Some(username.to_owned());
102        }
103        self
104    }
105
106    /// set the password for redis
107    ///
108    /// default: no password
109    pub fn password(mut self, password: &str) -> Self {
110        if !password.is_empty() {
111            self.config.password = Some(password.to_owned());
112        }
113        self
114    }
115
116    /// set the db used in redis
117    ///
118    /// default: 0
119    pub fn db(mut self, db: i64) -> Self {
120        self.config.db = db;
121        self
122    }
123
124    /// Set the default ttl for redis services.
125    ///
126    /// If set, we will specify `EX` for write operations.
127    pub fn default_ttl(mut self, ttl: Duration) -> Self {
128        self.config.default_ttl = Some(ttl);
129        self
130    }
131
132    /// set the working directory, all operations will be performed under it.
133    ///
134    /// default: "/"
135    pub fn root(mut self, root: &str) -> Self {
136        self.config.root = if root.is_empty() {
137            None
138        } else {
139            Some(root.to_string())
140        };
141
142        self
143    }
144}
145
146impl Builder for RedisBuilder {
147    const SCHEME: Scheme = Scheme::Redis;
148    type Config = RedisConfig;
149
150    fn build(self) -> Result<impl Access> {
151        let root = normalize_root(
152            self.config
153                .root
154                .clone()
155                .unwrap_or_else(|| "/".to_string())
156                .as_str(),
157        );
158
159        if let Some(endpoints) = self.config.cluster_endpoints.clone() {
160            let mut cluster_endpoints: Vec<ConnectionInfo> = Vec::default();
161            for endpoint in endpoints.split(',') {
162                cluster_endpoints.push(self.get_connection_info(endpoint.to_string())?);
163            }
164            let mut client_builder = ClusterClientBuilder::new(cluster_endpoints);
165            if let Some(username) = &self.config.username {
166                client_builder = client_builder.username(username.clone());
167            }
168            if let Some(password) = &self.config.password {
169                client_builder = client_builder.password(password.clone());
170            }
171            let client = client_builder.build().map_err(format_redis_error)?;
172
173            let conn = OnceCell::new();
174
175            Ok(RedisBackend::new(Adapter {
176                addr: endpoints,
177                client: None,
178                cluster_client: Some(client),
179                conn,
180                default_ttl: self.config.default_ttl,
181            })
182            .with_normalized_root(root))
183        } else {
184            let endpoint = self
185                .config
186                .endpoint
187                .clone()
188                .unwrap_or_else(|| DEFAULT_REDIS_ENDPOINT.to_string());
189
190            let client =
191                Client::open(self.get_connection_info(endpoint.clone())?).map_err(|e| {
192                    Error::new(ErrorKind::ConfigInvalid, "invalid or unsupported scheme")
193                        .with_context("service", Scheme::Redis)
194                        .with_context("endpoint", self.config.endpoint.as_ref().unwrap())
195                        .with_context("db", self.config.db.to_string())
196                        .set_source(e)
197                })?;
198
199            let conn = OnceCell::new();
200            Ok(RedisBackend::new(Adapter {
201                addr: endpoint,
202                client: Some(client),
203                cluster_client: None,
204                conn,
205                default_ttl: self.config.default_ttl,
206            })
207            .with_normalized_root(root))
208        }
209    }
210}
211
212impl RedisBuilder {
213    fn get_connection_info(&self, endpoint: String) -> Result<ConnectionInfo> {
214        let ep_url = endpoint.parse::<Uri>().map_err(|e| {
215            Error::new(ErrorKind::ConfigInvalid, "endpoint is invalid")
216                .with_context("service", Scheme::Redis)
217                .with_context("endpoint", endpoint)
218                .set_source(e)
219        })?;
220
221        let con_addr = match ep_url.scheme_str() {
222            Some("tcp") | Some("redis") | None => {
223                let host = ep_url
224                    .host()
225                    .map(|h| h.to_string())
226                    .unwrap_or_else(|| "127.0.0.1".to_string());
227                let port = ep_url.port_u16().unwrap_or(DEFAULT_REDIS_PORT);
228                ConnectionAddr::Tcp(host, port)
229            }
230            Some("rediss") => {
231                let host = ep_url
232                    .host()
233                    .map(|h| h.to_string())
234                    .unwrap_or_else(|| "127.0.0.1".to_string());
235                let port = ep_url.port_u16().unwrap_or(DEFAULT_REDIS_PORT);
236                ConnectionAddr::TcpTls {
237                    host,
238                    port,
239                    insecure: false,
240                    tls_params: None,
241                }
242            }
243            Some("unix") | Some("redis+unix") => {
244                let path = PathBuf::from(ep_url.path());
245                ConnectionAddr::Unix(path)
246            }
247            Some(s) => {
248                return Err(
249                    Error::new(ErrorKind::ConfigInvalid, "invalid or unsupported scheme")
250                        .with_context("service", Scheme::Redis)
251                        .with_context("scheme", s),
252                )
253            }
254        };
255
256        let redis_info = RedisConnectionInfo {
257            db: self.config.db,
258            username: self.config.username.clone(),
259            password: self.config.password.clone(),
260            protocol: ProtocolVersion::RESP2,
261        };
262
263        Ok(ConnectionInfo {
264            addr: con_addr,
265            redis: redis_info,
266        })
267    }
268}
269
270/// Backend for redis services.
271pub type RedisBackend = kv::Backend<Adapter>;
272
273#[derive(Clone)]
274pub struct Adapter {
275    addr: String,
276    client: Option<Client>,
277    cluster_client: Option<ClusterClient>,
278    conn: OnceCell<bb8::Pool<RedisConnectionManager>>,
279
280    default_ttl: Option<Duration>,
281}
282
283// implement `Debug` manually, or password may be leaked.
284impl Debug for Adapter {
285    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
286        let mut ds = f.debug_struct("Adapter");
287
288        ds.field("addr", &self.addr);
289        ds.finish()
290    }
291}
292
293impl Adapter {
294    async fn conn(&self) -> Result<bb8::PooledConnection<'_, RedisConnectionManager>> {
295        let pool = self
296            .conn
297            .get_or_try_init(|| async {
298                bb8::Pool::builder()
299                    .build(self.get_redis_connection_manager())
300                    .await
301                    .map_err(|err| {
302                        Error::new(ErrorKind::ConfigInvalid, "connect to redis failed")
303                            .set_source(err)
304                    })
305            })
306            .await?;
307        pool.get().await.map_err(|err| match err {
308            RunError::TimedOut => {
309                Error::new(ErrorKind::Unexpected, "get connection from pool failed").set_temporary()
310            }
311            RunError::User(err) => err,
312        })
313    }
314
315    fn get_redis_connection_manager(&self) -> RedisConnectionManager {
316        if let Some(_client) = self.client.clone() {
317            RedisConnectionManager {
318                client: self.client.clone(),
319                cluster_client: None,
320            }
321        } else {
322            RedisConnectionManager {
323                client: None,
324                cluster_client: self.cluster_client.clone(),
325            }
326        }
327    }
328}
329
330impl kv::Adapter for Adapter {
331    type Scanner = ();
332
333    fn info(&self) -> kv::Info {
334        kv::Info::new(
335            Scheme::Redis,
336            self.addr.as_str(),
337            Capability {
338                read: true,
339                write: true,
340                shared: true,
341
342                ..Default::default()
343            },
344        )
345    }
346
347    async fn get(&self, key: &str) -> Result<Option<Buffer>> {
348        let mut conn = self.conn().await?;
349        let result: Option<Bytes> = conn.get(key).await.map_err(format_redis_error)?;
350        Ok(result.map(Buffer::from))
351    }
352
353    async fn set(&self, key: &str, value: Buffer) -> Result<()> {
354        let mut conn = self.conn().await?;
355        let value = value.to_vec();
356        if let Some(dur) = self.default_ttl {
357            let _: () = conn
358                .set_ex(key, value, dur.as_secs())
359                .await
360                .map_err(format_redis_error)?;
361        } else {
362            let _: () = conn.set(key, value).await.map_err(format_redis_error)?;
363        }
364        Ok(())
365    }
366
367    async fn delete(&self, key: &str) -> Result<()> {
368        let mut conn = self.conn().await?;
369        let _: () = conn.del(key).await.map_err(format_redis_error)?;
370        Ok(())
371    }
372
373    async fn append(&self, key: &str, value: &[u8]) -> Result<()> {
374        let mut conn = self.conn().await?;
375        let _: () = conn.append(key, value).await.map_err(format_redis_error)?;
376        Ok(())
377    }
378}
opendal/services/redis/backend.rs

opendal/services/redis/
backend.rs
