s2_lite/backend/
basins.rs

1use s2_common::{
2    bash::Bash,
3    types::{
4        basin::{BasinInfo, BasinName, BasinState, ListBasinsRequest},
5        config::{BasinConfig, BasinReconfiguration},
6        resources::{CreateMode, ListItemsRequestParts, Page, RequestToken},
7        stream::StreamNameStartAfter,
8    },
9};
10use slatedb::{
11    IsolationLevel,
12    config::{DurabilityLevel, ScanOptions, WriteOptions},
13};
14use time::OffsetDateTime;
15
16use super::{Backend, CreatedOrReconfigured, store::db_txn_get};
17use crate::backend::{
18    error::{
19        BasinAlreadyExistsError, BasinDeletionPendingError, BasinNotFoundError, CreateBasinError,
20        DeleteBasinError, GetBasinConfigError, ListBasinsError, ReconfigureBasinError,
21    },
22    kv,
23};
24
25impl Backend {
26    pub async fn list_basins(
27        &self,
28        request: ListBasinsRequest,
29    ) -> Result<Page<BasinInfo>, ListBasinsError> {
30        let ListItemsRequestParts {
31            prefix,
32            start_after,
33            limit,
34        } = request.into();
35
36        let key_range = kv::basin_meta::ser_key_range(&prefix, &start_after);
37        if key_range.is_empty() {
38            return Ok(Page::new_empty());
39        }
40
41        const SCAN_OPTS: ScanOptions = ScanOptions {
42            durability_filter: DurabilityLevel::Remote,
43            dirty: false,
44            read_ahead_bytes: 1,
45            cache_blocks: false,
46            max_fetch_tasks: 1,
47        };
48        let mut it = self.db.scan_with_options(key_range, &SCAN_OPTS).await?;
49
50        let mut basins = Vec::with_capacity(limit.as_usize());
51        let mut has_more = false;
52        while let Some(kv) = it.next().await? {
53            let basin = kv::basin_meta::deser_key(kv.key)?;
54            assert!(basin.as_ref() > start_after.as_ref());
55            assert!(basin.as_ref() >= prefix.as_ref());
56            if basins.len() == limit.as_usize() {
57                has_more = true;
58                break;
59            }
60            let meta = kv::basin_meta::deser_value(kv.value)?;
61            let state = if meta.deleted_at.is_some() {
62                BasinState::Deleting
63            } else {
64                BasinState::Active
65            };
66            basins.push(BasinInfo {
67                name: basin,
68                scope: None,
69                state,
70            });
71        }
72        Ok(Page::new(basins, has_more))
73    }
74
75    pub async fn create_basin(
76        &self,
77        basin: BasinName,
78        config: BasinConfig,
79        mode: CreateMode,
80    ) -> Result<CreatedOrReconfigured<BasinInfo>, CreateBasinError> {
81        let meta_key = kv::basin_meta::ser_key(&basin);
82
83        let txn = self.db.begin(IsolationLevel::SerializableSnapshot).await?;
84
85        let new_creation_idempotency_key = match &mode {
86            CreateMode::CreateOnly(Some(req_token)) => {
87                Some(creation_idempotency_key(req_token, &config))
88            }
89            _ => None,
90        };
91
92        let mut existing_created_at = None;
93        let mut existing_creation_idempotency_key = None;
94        if let Some(existing_meta) =
95            db_txn_get(&txn, &meta_key, kv::basin_meta::deser_value).await?
96        {
97            if existing_meta.deleted_at.is_some() {
98                return Err(BasinDeletionPendingError { basin }.into());
99            }
100            match mode {
101                CreateMode::CreateOnly(_) => {
102                    return if new_creation_idempotency_key.is_some()
103                        && existing_meta.creation_idempotency_key == new_creation_idempotency_key
104                    {
105                        Ok(CreatedOrReconfigured::Created(BasinInfo {
106                            name: basin,
107                            scope: None,
108                            state: BasinState::Active,
109                        }))
110                    } else {
111                        Err(BasinAlreadyExistsError { basin }.into())
112                    };
113                }
114                CreateMode::CreateOrReconfigure => {
115                    existing_created_at = Some(existing_meta.created_at);
116                    existing_creation_idempotency_key = existing_meta.creation_idempotency_key;
117                }
118            }
119        }
120
121        let created_at = existing_created_at.unwrap_or_else(OffsetDateTime::now_utc);
122        let creation_idempotency_key =
123            existing_creation_idempotency_key.or(new_creation_idempotency_key);
124
125        let meta = kv::basin_meta::BasinMeta {
126            config,
127            created_at,
128            deleted_at: None,
129            creation_idempotency_key,
130        };
131
132        txn.put(&meta_key, kv::basin_meta::ser_value(&meta))?;
133
134        static WRITE_OPTS: WriteOptions = WriteOptions {
135            await_durable: true,
136        };
137        txn.commit_with_options(&WRITE_OPTS).await?;
138
139        let info = BasinInfo {
140            name: basin,
141            scope: None,
142            state: BasinState::Active,
143        };
144
145        Ok(if existing_created_at.is_some() {
146            CreatedOrReconfigured::Reconfigured(info)
147        } else {
148            CreatedOrReconfigured::Created(info)
149        })
150    }
151
152    pub async fn get_basin_config(
153        &self,
154        basin: BasinName,
155    ) -> Result<BasinConfig, GetBasinConfigError> {
156        let Some(meta) = self
157            .db_get(kv::basin_meta::ser_key(&basin), kv::basin_meta::deser_value)
158            .await?
159        else {
160            return Err(BasinNotFoundError { basin }.into());
161        };
162        Ok(meta.config)
163    }
164
165    pub async fn reconfigure_basin(
166        &self,
167        basin: BasinName,
168        reconfig: BasinReconfiguration,
169    ) -> Result<BasinConfig, ReconfigureBasinError> {
170        let meta_key = kv::basin_meta::ser_key(&basin);
171
172        let txn = self.db.begin(IsolationLevel::SerializableSnapshot).await?;
173
174        let Some(mut meta) = db_txn_get(&txn, &meta_key, kv::basin_meta::deser_value).await? else {
175            return Err(BasinNotFoundError { basin }.into());
176        };
177
178        if meta.deleted_at.is_some() {
179            return Err(BasinDeletionPendingError { basin }.into());
180        }
181
182        meta.config = meta.config.reconfigure(reconfig);
183
184        txn.put(&meta_key, kv::basin_meta::ser_value(&meta))?;
185
186        static WRITE_OPTS: WriteOptions = WriteOptions {
187            await_durable: true,
188        };
189        txn.commit_with_options(&WRITE_OPTS).await?;
190
191        Ok(meta.config)
192    }
193
194    pub async fn delete_basin(&self, basin: BasinName) -> Result<(), DeleteBasinError> {
195        let txn = self.db.begin(IsolationLevel::SerializableSnapshot).await?;
196        let meta_key = kv::basin_meta::ser_key(&basin);
197        let Some(mut meta) = db_txn_get(&txn, &meta_key, kv::basin_meta::deser_value).await? else {
198            return Err(BasinNotFoundError { basin }.into());
199        };
200        if meta.deleted_at.is_none() {
201            meta.deleted_at = Some(OffsetDateTime::now_utc());
202            txn.put(&meta_key, kv::basin_meta::ser_value(&meta))?;
203            txn.put(
204                kv::basin_deletion_pending::ser_key(&basin),
205                kv::basin_deletion_pending::ser_value(&StreamNameStartAfter::default()),
206            )?;
207            static WRITE_OPTS: WriteOptions = WriteOptions {
208                await_durable: true,
209            };
210            txn.commit_with_options(&WRITE_OPTS).await?;
211        }
212        Ok(())
213    }
214}
215
216fn creation_idempotency_key(req_token: &RequestToken, config: &BasinConfig) -> Bash {
217    Bash::new(&[
218        req_token.as_bytes(),
219        &serde_json::to_vec(&s2_api::v1::config::BasinConfig::from(config.clone()))
220            .expect("serializable"),
221    ])
222}