feat(router): add labels to asset structures

Author: LooFifteen

backend/server/src/routes/asset/mod.rs

@@ -14,7 +14,10 @@ use axum::{
     extract::{Path, State},
     http::StatusCode,
 };
-use chdrms_database::asset::{self as database, CreateAsset, UpdateAsset};
+use chdrms_database::{
+    asset::{self as database, CreateAsset, UpdateAsset},
+    label::LabelAndBlocking,
+};
 
 use utoipa_axum::{router::OpenApiRouter, routes};
 use uuid::Uuid;
@@ -24,7 +27,7 @@ use crate::{
     error::{AppError, ErrorResponse, Result},
     routes::{
         asset::model::{
-            AssetDto, AssetLocations, CreateAssetRequest, UpdateAssetLocationRequest,
+            AssetDto, AssetLocations, Block, CreateAssetRequest, UpdateAssetLocationRequest,
             UpdateAssetRequest,
         },
         location::LocationDto,
@@ -64,18 +67,7 @@ async fn get_by_id_or_tag(
     }?
     .ok_or_else(|| AppError::NotFound)?;
 
-    Ok(Json(AssetDto {
-        id: asset.id,
-        r#type: asset.r#type,
-        alias: asset.alias,
-        notes: asset.notes,
-        tag: asset.tag,
-        bundle: asset.bundle,
-        locations: AssetLocations {
-            current: asset.location,
-            home: asset.home_location,
-        },
-    }))
+    Ok(Json(populate_asset_dto(asset, &mut txn).await?))
 }
 
 /// Create a new asset.
@@ -120,7 +112,13 @@ async fn create(
         alias: asset.alias,
         notes: asset.notes,
         tag: asset.tag,
+        // we can assume there are no labels attach to this
+        // asset as it has just been created.
+        labels: Vec::new(),
         bundle: asset.bundle,
+        // we can assume there are no blocks on this asset
+        // as it has just been created.
+        blocks: Vec::new(),
         locations: AssetLocations {
             current: asset.location,
             home: asset.home_location,
@@ -170,18 +168,7 @@ async fn update(
         )
         .await?;
 
-    Ok(Json(AssetDto {
-        id: asset.id,
-        r#type: asset.r#type,
-        alias: asset.alias,
-        notes: asset.notes,
-        tag: asset.tag,
-        bundle: asset.bundle,
-        locations: AssetLocations {
-            current: asset.location,
-            home: asset.home_location,
-        },
-    }))
+    Ok(Json(populate_asset_dto(asset, &mut txn).await?))
 }
 
 /// List all assets.
@@ -199,23 +186,10 @@ async fn list(
     State(state): State<AppState>,
     _auth: RequirePermission<database::permission::View>,
 ) -> Result<Json<Vec<AssetDto>>> {
+    let mut txn = state.transaction().await?;
+
     Ok(Json(
-        database::Asset::list(&mut state.transaction().await?)
-            .await?
-            .into_iter()
-            .map(|asset| AssetDto {
-                id: asset.id,
-                r#type: asset.r#type,
-                alias: asset.alias,
-                notes: asset.notes,
-                tag: asset.tag,
-                bundle: asset.bundle,
-                locations: AssetLocations {
-                    current: asset.location,
-                    home: asset.home_location,
-                },
-            })
-            .collect(),
+        populate_asset_dtos(database::Asset::list(&mut txn).await?, &mut txn).await?,
     ))
 }
 
@@ -312,20 +286,67 @@ async fn put_location(
         .set_location(&mut txn, location)
         .await?;
 
+    let asset = populate_asset_dto(asset, &mut txn).await?;
+
     txn.commit().await?;
 
-    Ok(Json(AssetDto {
+    Ok(Json(asset))
+}
+
+async fn populate_asset_dto(
+    asset: database::Asset,
+    txn: &mut sqlx::PgTransaction<'_>,
+) -> sqlx::Result<AssetDto> {
+    let labels =
+        chdrms_database::label::Label::list_label_and_blocking_for_asset(txn, asset.id).await?;
+    Ok(populate_asset_dto_raw(asset, labels))
+}
+
+pub(super) async fn populate_asset_dtos(
+    assets: Vec<database::Asset>,
+    txn: &mut sqlx::PgTransaction<'_>,
+) -> sqlx::Result<Vec<AssetDto>> {
+    // find labels
+    let labels = chdrms_database::label::Label::list_label_and_blocking_for_assets(
+        txn,
+        assets.iter().map(|asset| asset.id).collect(),
+    )
+    .await?;
+
+    Ok(assets
+        .into_iter()
+        .map(|asset| {
+            let labels = labels.get(&asset.id).cloned().unwrap_or_default();
+            populate_asset_dto_raw(asset, labels)
+        })
+        .collect())
+}
+
+fn populate_asset_dto_raw(asset: database::Asset, labels: Vec<LabelAndBlocking>) -> AssetDto {
+    // construct blocks
+    let blocks = labels
+        .iter()
+        .filter(|label| label.blocking)
+        .map(|label| Block::Label { label: label.id })
+        .collect();
+
+    // construct labels
+    let labels = labels.iter().map(|label| label.id).collect();
+
+    AssetDto {
         id: asset.id,
         r#type: asset.r#type,
         alias: asset.alias,
         notes: asset.notes,
         tag: asset.tag,
+        labels,
         bundle: asset.bundle,
+        blocks,
         locations: AssetLocations {
             current: asset.location,
             home: asset.home_location,
         },
-    }))
+    }
 }
 
 pub(super) fn routes() -> OpenApiRouter<AppState> {

backend/server/src/routes/asset/model.rs

@@ -18,9 +18,17 @@ pub struct AssetDto {
     /// The asset tag attached to this asset.
     pub tag: String,
 
+    /// An array of labels attached to this asset. This field is only
+    /// mutable via its dedicated field endpoints.
+    pub labels: Vec<Uuid>,
+
     /// An optional bundle that this asset is within, as asset bundle
     /// identifier.
     pub bundle: Option<Uuid>,
+    /// An array of reasons why the asset could be blocked
+    /// by anything, like a label or maintenance job. This field is
+    /// immutable and only affected by external fields.
+    pub blocks: Vec<Block>,
 
     pub locations: AssetLocations,
 }
@@ -67,3 +75,14 @@ pub struct AssetLocations {
 pub struct UpdateAssetLocations {
     pub home: Uuid,
 }
+
+#[derive(Debug, Clone, Serialize, ToSchema)]
+#[serde(tag = "reason", rename_all = "snake_case")]
+pub enum Block {
+    Label { label: Uuid },
+    // Assigned {
+    //     project: Uuid,
+    //     until: DateTime<Utc>,
+    // },
+    // Maintenance { job: Uuid },
+}

backend/server/src/routes/asset_type.rs

@@ -16,7 +16,7 @@ use chdrms_database::{PatchField, asset_type as database, manufacturer::Manufact
 use crate::{
     auth::{AuthContext, permissions::RequirePermission},
     error::{AppError, ErrorResponse, Result},
-    routes::asset::model::{AssetDto, AssetLocations},
+    routes::asset::model::AssetDto,
     state::AppState,
 };
 
@@ -200,23 +200,11 @@ async fn list_assets_of_asset_type(
         .ok_or_else(|| AppError::NotFound)?
         .id;
 
+    let assets =
+        chdrms_database::asset::Asset::list_of_type(id, &mut state.transaction().await?).await?;
+
     Ok(Json(
-        chdrms_database::asset::Asset::list_of_type(id, &mut state.transaction().await?)
-            .await?
-            .into_iter()
-            .map(|asset| AssetDto {
-                id: asset.id,
-                r#type: asset.r#type,
-                alias: asset.alias,
-                notes: asset.notes,
-                tag: asset.tag,
-                bundle: asset.bundle,
-                locations: AssetLocations {
-                    current: asset.location,
-                    home: asset.home_location,
-                },
-            })
-            .collect(),
+        super::asset::populate_asset_dtos(assets, &mut txn).await?,
     ))
 }
 

backend/server/src/routes/bundle/mod.rs

@@ -13,10 +13,7 @@ use uuid::Uuid;
 use crate::{
     auth::{AuthContext, permissions::RequirePermission},
     error::{AppError, ErrorResponse, Result},
-    routes::{
-        asset::model::{AssetDto, AssetLocations},
-        bundle::model::AssetBundleDto,
-    },
+    routes::{asset::model::AssetDto, bundle::model::AssetBundleDto},
     state::AppState,
 };
 
@@ -74,26 +71,14 @@ async fn get_assets_by_id(
 ) -> Result<Json<Vec<AssetDto>>> {
     let mut txn = state.transaction().await?;
 
+    let assets = database::Bundle::get_by_id(&mut txn, id)
+        .await?
+        .ok_or_else(|| AppError::NotFound)?
+        .assets(&mut txn)
+        .await?;
+
     Ok(Json(
-        database::Bundle::get_by_id(&mut txn, id)
-            .await?
-            .ok_or_else(|| AppError::NotFound)?
-            .assets(&mut txn)
-            .await?
-            .into_iter()
-            .map(|asset| AssetDto {
-                id: asset.id,
-                r#type: asset.r#type,
-                alias: asset.alias,
-                notes: asset.notes,
-                tag: asset.tag,
-                bundle: asset.bundle,
-                locations: AssetLocations {
-                    current: asset.location,
-                    home: asset.home_location,
-                },
-            })
-            .collect(),
+        super::asset::populate_asset_dtos(assets, &mut txn).await?,
     ))
 }
 

openapi/schema.json

@@ -2276,6 +2276,8 @@
           "id",
           "type",
           "tag",
+          "labels",
+          "blocks",
           "locations"
         ],
         "properties": {
@@ -2286,6 +2288,13 @@
             ],
             "description": "An optional alias for this asset. This is purely for convenience\nin searching for and identifying multiple instances of similar\nassets."
           },
+          "blocks": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Block"
+            },
+            "description": "An array of reasons why the asset could be blocked\nby anything, like a label or maintenance job. This field is\nimmutable and only affected by external fields."
+          },
           "bundle": {
             "type": [
               "string",
@@ -2299,6 +2308,14 @@
             "format": "uuid",
             "description": "The unique identifier for this asset. This property is immutable."
           },
+          "labels": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "format": "uuid"
+            },
+            "description": "An array of labels attached to this asset. This field is only\nmutable via its dedicated field endpoints."
+          },
           "locations": {
             "$ref": "#/components/schemas/AssetLocations"
           },
@@ -2410,6 +2427,29 @@
           }
         }
       },
+      "Block": {
+        "oneOf": [
+          {
+            "type": "object",
+            "required": [
+              "label",
+              "reason"
+            ],
+            "properties": {
+              "label": {
+                "type": "string",
+                "format": "uuid"
+              },
+              "reason": {
+                "type": "string",
+                "enum": [
+                  "label"
+                ]
+              }
+            }
+          }
+        ]
+      },
       "ContactDetailsDto": {
         "type": "object",
         "required": [