bitwarden_vault/folder/
create.rs

1use bitwarden_api_api::models::FolderRequestModel;
2use bitwarden_core::{
3    ApiError, MissingFieldError,
4    key_management::{KeySlotIds, SymmetricKeySlotId},
5    require,
6};
7use bitwarden_crypto::{
8    CompositeEncryptable, CryptoError, IdentifyKey, KeyStoreContext, PrimitiveEncryptable,
9};
10use bitwarden_error::bitwarden_error;
11use bitwarden_state::repository::{RepositoryError, RepositoryOption};
12use serde::{Deserialize, Serialize};
13use thiserror::Error;
14#[cfg(feature = "wasm")]
15use tsify::Tsify;
16#[cfg(feature = "wasm")]
17use wasm_bindgen::prelude::*;
18
19use crate::{Folder, FolderView, FoldersClient, VaultParseError};
20
21/// Request to add or edit a folder.
22#[derive(Serialize, Deserialize, Debug)]
23#[serde(rename_all = "camelCase")]
24#[cfg_attr(feature = "uniffi", derive(uniffi::Record))]
25#[cfg_attr(feature = "wasm", derive(Tsify), tsify(into_wasm_abi, from_wasm_abi))]
26pub struct FolderAddEditRequest {
27    /// The new name of the folder.
28    pub name: String,
29}
30
31impl CompositeEncryptable<KeySlotIds, SymmetricKeySlotId, FolderRequestModel>
32    for FolderAddEditRequest
33{
34    fn encrypt_composite(
35        &self,
36        ctx: &mut KeyStoreContext<KeySlotIds>,
37        key: SymmetricKeySlotId,
38    ) -> Result<FolderRequestModel, CryptoError> {
39        Ok(FolderRequestModel {
40            name: self.name.encrypt(ctx, key)?.to_string(),
41        })
42    }
43}
44
45impl IdentifyKey<SymmetricKeySlotId> for FolderAddEditRequest {
46    fn key_identifier(&self) -> SymmetricKeySlotId {
47        SymmetricKeySlotId::User
48    }
49}
50
51#[allow(missing_docs)]
52#[bitwarden_error(flat)]
53#[derive(Debug, Error)]
54pub enum CreateFolderError {
55    #[error(transparent)]
56    Crypto(#[from] CryptoError),
57    #[error(transparent)]
58    Api(#[from] ApiError),
59    #[error(transparent)]
60    VaultParse(#[from] VaultParseError),
61    #[error(transparent)]
62    MissingField(#[from] MissingFieldError),
63    #[error(transparent)]
64    Repository(#[from] RepositoryError),
65}
66
67#[cfg_attr(feature = "wasm", wasm_bindgen)]
68impl FoldersClient {
69    /// Create a new [Folder] and save it to the server.
70    pub async fn create(
71        &self,
72        request: FolderAddEditRequest,
73    ) -> Result<FolderView, CreateFolderError> {
74        let folder_request = self.key_store.encrypt(request)?;
75
76        let resp = self
77            .api_configurations
78            .api_client
79            .folders_api()
80            .post(Some(folder_request))
81            .await
82            .map_err(ApiError::from)?;
83
84        let folder: Folder = resp.try_into()?;
85
86        self.repository
87            .require()?
88            .set(require!(folder.id), folder.clone())
89            .await?;
90
91        Ok(self.key_store.decrypt(&folder)?)
92    }
93}
94
95#[cfg(test)]
96mod tests {
97    use std::sync::Arc;
98
99    use bitwarden_api_api::{apis::ApiClient, models::FolderResponseModel};
100    use bitwarden_core::{
101        client::ApiConfigurations, key_management::create_test_crypto_with_user_key,
102    };
103    use bitwarden_crypto::SymmetricCryptoKey;
104    use bitwarden_test::MemoryRepository;
105    use uuid::uuid;
106
107    use super::*;
108    use crate::FolderId;
109
110    fn create_client(api_client: ApiClient) -> FoldersClient {
111        FoldersClient {
112            key_store: create_test_crypto_with_user_key(
113                SymmetricCryptoKey::make_aes256_cbc_hmac_key(),
114            ),
115            api_configurations: Arc::new(ApiConfigurations::from_api_client(api_client)),
116            repository: Some(Arc::new(MemoryRepository::<Folder>::default())),
117        }
118    }
119
120    #[tokio::test]
121    async fn test_create_folder() {
122        let folder_id = FolderId::new(uuid!("25afb11c-9c95-4db5-8bac-c21cb204a3f1"));
123
124        let client = create_client(ApiClient::new_mocked(move |mock| {
125            mock.folders_api
126                .expect_post()
127                .returning(move |model| {
128                    Ok(FolderResponseModel {
129                        id: Some(folder_id.into()),
130                        name: Some(model.unwrap().name),
131                        revision_date: Some("2025-01-01T00:00:00Z".to_string()),
132                        object: Some("folder".to_string()),
133                    })
134                })
135                .once();
136        }));
137
138        let result = client
139            .create(FolderAddEditRequest {
140                name: "test".to_string(),
141            })
142            .await
143            .unwrap();
144
145        assert_eq!(
146            result,
147            FolderView {
148                id: Some(folder_id),
149                name: "test".to_string(),
150                revision_date: "2025-01-01T00:00:00Z".parse().unwrap(),
151            }
152        );
153
154        // Confirm the folder was stored in the repository
155        assert_eq!(
156            client
157                .key_store
158                .decrypt(
159                    &client
160                        .repository
161                        .as_ref()
162                        .unwrap()
163                        .get(folder_id)
164                        .await
165                        .unwrap()
166                        .unwrap()
167                )
168                .unwrap(),
169            result
170        );
171    }
172
173    #[tokio::test]
174    async fn test_create_folder_http_error() {
175        let client = create_client(ApiClient::new_mocked(move |mock| {
176            mock.folders_api
177                .expect_post()
178                .returning(move |_model| Err(std::io::Error::other("Simulated error").into()));
179        }));
180
181        let result = client
182            .create(FolderAddEditRequest {
183                name: "test".to_string(),
184            })
185            .await;
186
187        assert!(result.is_err());
188        assert!(matches!(result.unwrap_err(), CreateFolderError::Api(_)));
189    }
190}
bitwarden_vault/folder/create.rs

bitwarden_vault/folder/
create.rs
