bitwarden_vault/folder/
edit.rs

1use bitwarden_core::{ApiError, MissingFieldError, key_management::KeyIds};
2use bitwarden_crypto::{CryptoError, KeyStore};
3use bitwarden_error::bitwarden_error;
4use bitwarden_state::repository::{Repository, RepositoryError};
5use thiserror::Error;
6#[cfg(feature = "wasm")]
7use wasm_bindgen::prelude::*;
8
9use crate::{
10    Folder, FolderAddEditRequest, FolderId, FolderView, ItemNotFoundError, VaultParseError,
11};
12
13#[allow(missing_docs)]
14#[bitwarden_error(flat)]
15#[derive(Debug, Error)]
16pub enum EditFolderError {
17    #[error(transparent)]
18    ItemNotFound(#[from] ItemNotFoundError),
19    #[error(transparent)]
20    Crypto(#[from] CryptoError),
21    #[error(transparent)]
22    Api(#[from] ApiError),
23    #[error(transparent)]
24    VaultParse(#[from] VaultParseError),
25    #[error(transparent)]
26    MissingField(#[from] MissingFieldError),
27    #[error(transparent)]
28    Repository(#[from] RepositoryError),
29    #[error(transparent)]
30    Uuid(#[from] uuid::Error),
31}
32
33pub(super) async fn edit_folder<R: Repository<Folder> + ?Sized>(
34    key_store: &KeyStore<KeyIds>,
35    api_client: &bitwarden_api_api::apis::ApiClient,
36    repository: &R,
37    folder_id: FolderId,
38    request: FolderAddEditRequest,
39) -> Result<FolderView, EditFolderError> {
40    let id = folder_id.to_string();
41
42    // Verify the folder we're updating exists
43    repository.get(id.clone()).await?.ok_or(ItemNotFoundError)?;
44
45    let folder_request = key_store.encrypt(request)?;
46
47    let resp = api_client
48        .folders_api()
49        .put(&id, Some(folder_request))
50        .await
51        .map_err(ApiError::from)?;
52
53    let folder: Folder = resp.try_into()?;
54
55    debug_assert!(folder.id.unwrap_or_default() == folder_id);
56
57    repository.set(id, folder.clone()).await?;
58
59    Ok(key_store.decrypt(&folder)?)
60}
61
62#[cfg(test)]
63mod tests {
64    use bitwarden_api_api::{apis::ApiClient, models::FolderResponseModel};
65    use bitwarden_core::key_management::SymmetricKeyId;
66    use bitwarden_crypto::{PrimitiveEncryptable, SymmetricCryptoKey};
67    use bitwarden_test::MemoryRepository;
68    use uuid::uuid;
69
70    use super::*;
71    use crate::FolderId;
72
73    async fn repository_add_folder(
74        repository: &MemoryRepository<Folder>,
75        store: &KeyStore<KeyIds>,
76        folder_id: FolderId,
77        name: &str,
78    ) {
79        let folder = Folder {
80            id: Some(folder_id),
81            name: name
82                .encrypt(&mut store.context(), SymmetricKeyId::User)
83                .unwrap(),
84            revision_date: "2024-01-01T00:00:00Z".parse().unwrap(),
85        };
86        repository.set(folder_id.to_string(), folder).await.unwrap();
87    }
88
89    #[tokio::test]
90    async fn test_edit_folder() {
91        let store: KeyStore<KeyIds> = KeyStore::default();
92        #[allow(deprecated)]
93        let _ = store.context_mut().set_symmetric_key(
94            SymmetricKeyId::User,
95            SymmetricCryptoKey::make_aes256_cbc_hmac_key(),
96        );
97
98        let folder_id: FolderId = "25afb11c-9c95-4db5-8bac-c21cb204a3f1".parse().unwrap();
99
100        let api_client = ApiClient::new_mocked(move |mock| {
101            mock.folders_api
102                .expect_put()
103                .returning(move |id, model| {
104                    assert_eq!(id, folder_id.to_string());
105                    Ok(FolderResponseModel {
106                        object: Some("folder".to_string()),
107                        id: Some(folder_id.into()),
108                        name: Some(model.unwrap().name),
109                        revision_date: Some("2025-01-01T00:00:00Z".to_string()),
110                    })
111                })
112                .once();
113        });
114
115        let repository = MemoryRepository::<Folder>::default();
116        repository_add_folder(&repository, &store, folder_id, "old_name").await;
117
118        let result = edit_folder(
119            &store,
120            &api_client,
121            &repository,
122            folder_id,
123            FolderAddEditRequest {
124                name: "test".to_string(),
125            },
126        )
127        .await
128        .unwrap();
129
130        assert_eq!(
131            result,
132            FolderView {
133                id: Some(folder_id),
134                name: "test".to_string(),
135                revision_date: "2025-01-01T00:00:00Z".parse().unwrap(),
136            }
137        );
138    }
139
140    #[tokio::test]
141    async fn test_edit_folder_does_not_exist() {
142        let store: KeyStore<KeyIds> = KeyStore::default();
143
144        let repository = MemoryRepository::<Folder>::default();
145        let folder_id = FolderId::new(uuid!("25afb11c-9c95-4db5-8bac-c21cb204a3f1"));
146
147        let api_client = ApiClient::new_mocked(|_| {});
148
149        let result = edit_folder(
150            &store,
151            &api_client,
152            &repository,
153            folder_id,
154            FolderAddEditRequest {
155                name: "test".to_string(),
156            },
157        )
158        .await;
159
160        assert!(result.is_err());
161        assert!(matches!(
162            result.unwrap_err(),
163            EditFolderError::ItemNotFound(_)
164        ));
165    }
166
167    #[tokio::test]
168    async fn test_edit_folder_http_error() {
169        let store: KeyStore<KeyIds> = KeyStore::default();
170        #[allow(deprecated)]
171        let _ = store.context_mut().set_symmetric_key(
172            SymmetricKeyId::User,
173            SymmetricCryptoKey::make_aes256_cbc_hmac_key(),
174        );
175
176        let folder_id: FolderId = "25afb11c-9c95-4db5-8bac-c21cb204a3f1".parse().unwrap();
177
178        let api_client = ApiClient::new_mocked(move |mock| {
179            mock.folders_api.expect_put().returning(move |_id, _model| {
180                Err(bitwarden_api_api::apis::Error::Io(std::io::Error::other(
181                    "Simulated error",
182                )))
183            });
184        });
185
186        let repository = MemoryRepository::<Folder>::default();
187        repository_add_folder(&repository, &store, folder_id, "old_name").await;
188
189        let result = edit_folder(
190            &store,
191            &api_client,
192            &repository,
193            folder_id,
194            FolderAddEditRequest {
195                name: "test".to_string(),
196            },
197        )
198        .await;
199
200        assert!(result.is_err());
201        assert!(matches!(result.unwrap_err(), EditFolderError::Api(_)));
202    }
203}