[PM-21691] - Added tree and test with implementation for CollectionView (#279)

## 🎟️ Tracking
[PM-21691](https://bitwarden.atlassian.net/browse/PM-21691)

## 📔 Objective
This splits the collections code out of the vault crate and adds a Tree
implementation for representing the parent child relationship between
nested collections.

This ideally will then be used as a unified representation for the
nested collection structure across all clients, instead of each one
having to implement their own.

Author: jrmccannon

Cargo.lock

@@ -23,6 +23,7 @@ bitwarden-api-api = { path = "crates/bitwarden-api-api", version = "=1.0.0" }
 bitwarden-api-identity = { path = "crates/bitwarden-api-identity", version = "=1.0.0" }
 bitwarden-auth = { path = "crates/bitwarden-auth", version = "=1.0.0" }
 bitwarden-cli = { path = "crates/bitwarden-cli", version = "=1.0.0" }
+bitwarden-collections = { path = "crates/bitwarden-collections", version = "=1.0.0" }
 bitwarden-core = { path = "crates/bitwarden-core", version = "=1.0.0" }
 bitwarden-crypto = { path = "crates/bitwarden-crypto", version = "=1.0.0" }
 bitwarden-error = { path = "crates/bitwarden-error", version = "=1.0.0" }

Cargo.toml

@@ -52,22 +52,20 @@ You can also browse the latest published documentation:
 The project is structured as a monorepo using cargo workspaces. Some of the more noteworthy crates
 are:
 
-- [`bitwarden-api-api`](./crates/bitwarden-api-api/): Auto-generated API bindings for the API
-  server.
-- [`bitwarden-api-identity`](./crates/bitwarden-api-identity/): Auto-generated API bindings for the
+- [`bitwarden-api-api`](./crates/bitwarden-api-api): Auto-generated API bindings for the API server.
+- [`bitwarden-api-identity`](./crates/bitwarden-api-identity): Auto-generated API bindings for the
   Identity server.
-- [`bitwarden-core`](./crates/bitwarden-core/): The core functionality consumed by the other crates.
-- [`bitwarden-crypto`](./crates/bitwarden-crypto/): Crypto library.
-- [`bitwarden-wasm-internal`](./crates/bitwarden-wasm-internal/): WASM bindings for the internal
-  SDK.
-- [`bitwarden-uniffi`](./crates/bitwarden-uniffi/): Mobile bindings for swift and kotlin using
+- [`bitwarden-core`](./crates/bitwarden-core): The core functionality consumed by the other crates.
+- [`bitwarden-crypto`](./crates/bitwarden-crypto): Crypto library.
+- [`bitwarden-wasm-internal`](./crates/bitwarden-wasm-internal): WASM bindings for the internal SDK.
+- [`bitwarden-uniffi`](./crates/bitwarden-uniffi): Mobile bindings for swift and kotlin using
   [UniFFI](https://github.com/mozilla/uniffi-rs/).
 
 ## API Bindings
 
-We autogenerate the server bindings using
-[openapi-generator](https://github.com/OpenAPITools/openapi-generator). To do this we first need to
-build the internal swagger documentation.
+We autogenerate the server bindings
+using[openapi-generator](https://github.com/OpenAPITools/openapi-generator). To do this, we first
+need to build the internal swagger documentation.
 
 ### Swagger generation
 
@@ -83,15 +81,16 @@ ASPNETCORE_ENVIRONMENT=development dotnet swagger tofile --output ../../identity
 
 ### OpenApi Generator
 
-To generate a new version of the bindings run the following script from the root of the SDK project.
+To generate a new version of the bindings, run the following script from the root of the SDK
+project.
 
 ```bash
 ./support/build-api.sh
 ```
 
-This project uses customized templates which lives in the `support/openapi-templates` directory.
-These templates resolves some outstanding issues we've experienced with the rust generator. But we
-strive towards modifying the templates as little as possible to ease future upgrades.
+This project uses customized templates that live in the `support/openapi-templates` directory. These
+templates resolve some outstanding issues we've experienced with the rust generator. But we strive
+towards modifying the templates as little as possible to ease future upgrades.
 
 ### Note
 
@@ -102,9 +101,9 @@ strive towards modifying the templates as little as possible to ease future upgr
 
 ## Developer tools
 
-This project recommends the use of certain developer tools, and also includes configurations for
-them to make developers lives easier. The use of these tools is optional and they might require a
-separate installation step.
+This project recommends the use of certain developer tools and includes configurations for them to
+make developers' lives easier. The use of these tools is optional, and they might require a separate
+installation step.
 
 The list of developer tools is:
 
@@ -122,11 +121,11 @@ The list of developer tools is:
 ## Formatting & Linting
 
 This repository uses various tools to check formatting and linting before it's merged. It's
-recommended to run the checks prior to submitting a PR.
+recommended to run the checks before submitting a PR.
 
 ### Installation
 
-Please see the [lint.yml](./.github/workflows/lint.yml) file for example installation commands &
+Please see the [lint.yml](./.github/workflows/lint.yml) file, for example, installation commands and
 versions. Here are the cli tools we use:
 
 - Nightly [cargo fmt](https://github.com/rust-lang/rustfmt) and

README.md

@@ -0,0 +1,38 @@
+[package]
+name = "bitwarden-collections"
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+homepage.workspace = true
+repository.workspace = true
+license-file.workspace = true
+readme.workspace = true
+keywords.workspace = true
+
+[features]
+uniffi = [
+    "bitwarden-core/uniffi",
+    "bitwarden-crypto/uniffi",
+    "dep:uniffi"
+] # Uniffi bindings
+wasm = [
+    "bitwarden-core/wasm",
+    "dep:tsify",
+    "dep:wasm-bindgen"
+] # WASM support
+
+[dependencies]
+bitwarden-api-api = { workspace = true }
+bitwarden-core = { workspace = true, features = ["internal"] }
+bitwarden-crypto = { workspace = true }
+bitwarden-error = { workspace = true }
+serde = { workspace = true }
+thiserror = { workspace = true }
+tsify = { workspace = true, optional = true }
+uniffi = { workspace = true, optional = true }
+uuid = { workspace = true }
+wasm-bindgen = { workspace = true, optional = true }
+
+[lints]
+workspace = true

crates/bitwarden-collections/Cargo.toml

@@ -0,0 +1,6 @@
+# Bitwarden Collections
+
+Defines the data model for collections both encrypted and decrypted. It also handles conversions
+between those two states by implementing `Encryptable`. It also provides `Tree` struct which allows
+all structs implementing `TreeItem` to be represented in a tree structure along with functions to
+access each node.

crates/bitwarden-collections/README.md

@@ -6,52 +6,42 @@ use bitwarden_core::{
 use bitwarden_crypto::{CryptoError, Decryptable, EncString, IdentifyKey, KeyStoreContext};
 use serde::{Deserialize, Serialize};
 use uuid::Uuid;
+#[cfg(feature = "wasm")]
+use {tsify::Tsify, wasm_bindgen::prelude::*};
 
-use crate::VaultParseError;
+use crate::{error::CollectionsParseError, tree::TreeItem};
 
 #[allow(missing_docs)]
 #[derive(Serialize, Deserialize, Debug)]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
 #[cfg_attr(feature = "uniffi", derive(uniffi::Record))]
-#[cfg_attr(
-    feature = "wasm",
-    derive(tsify::Tsify),
-    tsify(into_wasm_abi, from_wasm_abi)
-)]
+#[cfg_attr(feature = "wasm", derive(Tsify), tsify(into_wasm_abi, from_wasm_abi))]
 pub struct Collection {
     pub id: Option<Uuid>,
     pub organization_id: Uuid,
-
     pub name: EncString,
-
     pub external_id: Option<String>,
     pub hide_passwords: bool,
     pub read_only: bool,
     pub manage: bool,
 }
 
 #[allow(missing_docs)]
-#[derive(Serialize, Deserialize, Debug)]
+#[derive(Serialize, Deserialize, Debug, Clone)]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
 #[cfg_attr(feature = "uniffi", derive(uniffi::Record))]
+#[cfg_attr(feature = "wasm", derive(Tsify), tsify(into_wasm_abi, from_wasm_abi))]
 pub struct CollectionView {
     pub id: Option<Uuid>,
     pub organization_id: Uuid,
-
     pub name: String,
-
     pub external_id: Option<String>,
     pub hide_passwords: bool,
     pub read_only: bool,
     pub manage: bool,
 }
 
-impl IdentifyKey<SymmetricKeyId> for Collection {
-    fn key_identifier(&self) -> SymmetricKeyId {
-        SymmetricKeyId::Organization(self.organization_id)
-    }
-}
-
+#[allow(missing_docs)]
 impl Decryptable<KeyIds, SymmetricKeyId, CollectionView> for Collection {
     fn decrypt(
         &self,
@@ -61,9 +51,7 @@ impl Decryptable<KeyIds, SymmetricKeyId, CollectionView> for Collection {
         Ok(CollectionView {
             id: self.id,
             organization_id: self.organization_id,
-
             name: self.name.decrypt(ctx, key).ok().unwrap_or_default(),
-
             external_id: self.external_id.clone(),
             hide_passwords: self.hide_passwords,
             read_only: self.read_only,
@@ -72,8 +60,9 @@ impl Decryptable<KeyIds, SymmetricKeyId, CollectionView> for Collection {
     }
 }
 
+#[allow(missing_docs)]
 impl TryFrom<CollectionDetailsResponseModel> for Collection {
-    type Error = VaultParseError;
+    type Error = CollectionsParseError;
 
     fn try_from(collection: CollectionDetailsResponseModel) -> Result<Self, Self::Error> {
         Ok(Collection {
@@ -87,3 +76,30 @@ impl TryFrom<CollectionDetailsResponseModel> for Collection {
         })
     }
 }
+
+#[allow(missing_docs)]
+impl IdentifyKey<SymmetricKeyId> for Collection {
+    fn key_identifier(&self) -> SymmetricKeyId {
+        SymmetricKeyId::Organization(self.organization_id)
+    }
+}
+
+#[allow(missing_docs)]
+impl TreeItem for CollectionView {
+    fn id(&self) -> Uuid {
+        self.id.unwrap_or_default()
+    }
+
+    fn short_name(&self) -> &str {
+        self.path().last().unwrap_or(&"")
+    }
+
+    fn path(&self) -> Vec<&str> {
+        self.name
+            .split(Self::DELIMITER)
+            .filter(|s| !s.is_empty())
+            .collect::<Vec<&str>>()
+    }
+
+    const DELIMITER: char = '/';
+}

crates/bitwarden-vault/src/collection.rs renamed to crates/bitwarden-collections/src/collection.rs

@@ -0,0 +1,19 @@
+use bitwarden_error::bitwarden_error;
+use thiserror::Error;
+
+#[allow(missing_docs)]
+#[bitwarden_error(flat)]
+#[derive(Debug, Error)]
+pub enum CollectionDecryptError {
+    #[error(transparent)]
+    Crypto(#[from] bitwarden_crypto::CryptoError),
+}
+
+#[allow(missing_docs)]
+#[derive(Debug, Error)]
+pub enum CollectionsParseError {
+    #[error(transparent)]
+    Crypto(#[from] bitwarden_crypto::CryptoError),
+    #[error(transparent)]
+    MissingFieldError(#[from] bitwarden_core::MissingFieldError),
+}

crates/bitwarden-collections/src/error.rs

@@ -0,0 +1,19 @@
+#![doc = include_str!("../README.md")]
+
+#[cfg(feature = "uniffi")]
+uniffi::setup_scaffolding!();
+#[cfg(feature = "uniffi")]
+mod uniffi_support;
+
+///
+/// Module containing the collection data models. It also contains the implementations for
+/// Encryptable, TryFrom, and TreeItem
+pub mod collection;
+///
+/// Module containing the error types.
+pub mod error;
+///
+/// Module containing Tree struct that is a tree representation of all structs implementing TreeItem
+/// trait. It is made using an index vector to hold the data and another vector to hold the
+/// parent child relationships between those nodes.
+pub mod tree;