chore: simplify the internal API, add instrumentation

This drops a bunch of "async" functions and Result returns, which aren't
being used anyway.

It also adds a bit more instrumentation, and some test tooling, allowing
one to enable flamechart traces for tests.

Author: ctron

.gitignore

@@ -7,8 +7,9 @@
 .envrc
 
 *.cdx.json
+*.folded
 
-/flamegraph*.svg
+/flame*.svg
 /perf.data*
 /dump.sql
 .ai_history.txt

Cargo.lock

@@ -86,7 +86,6 @@ test-log = { workspace = true, features = ["log", "trace"] }
 tokio-util = { workspace = true }
 tracing = { workspace = true, features = ["std"]}
 tracing-core =  { workspace = true }
-tracing-flame =  { workspace = true }
 tracing-opentelemetry = { workspace = true }
 tracing-subscriber = { workspace = true }
 trustify-cvss = { workspace = true }

modules/fundamental/Cargo.toml

@@ -9,6 +9,7 @@ use crate::{Error, organization::model::OrganizationSummary};
 use sea_orm::{ConnectionTrait, LoaderTrait, ModelTrait, prelude::Uuid};
 use serde::{Deserialize, Serialize};
 use time::OffsetDateTime;
+use tracing::instrument;
 use trustify_common::memo::Memo;
 use trustify_entity::{advisory, labels::Labels, organization};
 use utoipa::ToSchema;
@@ -54,21 +55,20 @@ pub struct AdvisoryHead {
 }
 
 impl AdvisoryHead {
+    #[instrument(skip_all, fields(advisory.id = ?advisory.id), err(level=tracing::Level::INFO))]
     pub async fn from_advisory<C: ConnectionTrait>(
         advisory: &advisory::Model,
         issuer: Memo<organization::Model>,
         tx: &C,
     ) -> Result<Self, Error> {
         let issuer = match &issuer {
-            Memo::Provided(Some(issuer)) => Some(OrganizationSummary::from_entity(issuer).await?),
+            Memo::Provided(Some(issuer)) => Some(OrganizationSummary::from_entity(issuer)),
             Memo::Provided(None) => None,
-            Memo::NotProvided => {
-                if let Some(issuer) = advisory.find_related(organization::Entity).one(tx).await? {
-                    Some(OrganizationSummary::from_entity(&issuer).await?)
-                } else {
-                    None
-                }
-            }
+            Memo::NotProvided => advisory
+                .find_related(organization::Entity)
+                .one(tx)
+                .await?
+                .map(|issuer| OrganizationSummary::from_entity(&issuer)),
         };
 
         Ok(Self {
@@ -93,11 +93,7 @@ impl AdvisoryHead {
         let issuers = entities.load_one(organization::Entity, tx).await?;
 
         for (advisory, issuer) in entities.iter().zip(issuers) {
-            let issuer = if let Some(issuer) = issuer {
-                Some(OrganizationSummary::from_entity(&issuer).await?)
-            } else {
-                None
-            };
+            let issuer = issuer.map(|issuer| OrganizationSummary::from_entity(&issuer));
 
             heads.push(Self {
                 uuid: advisory.id,

modules/fundamental/src/advisory/model/mod.rs

@@ -1,12 +1,8 @@
+use crate::{Error, advisory::model::AdvisoryHead, organization::model::OrganizationHead};
 use sea_orm::{ConnectionTrait, ModelTrait};
 use serde::{Deserialize, Serialize};
-use utoipa::ToSchema;
-
-use crate::advisory::model::AdvisoryHead;
 use trustify_entity::{advisory, organization};
-
-use crate::Error;
-use crate::organization::model::OrganizationHead;
+use utoipa::ToSchema;
 
 #[derive(Serialize, Deserialize, Clone, Debug, ToSchema)]
 pub struct OrganizationDetails {
@@ -24,7 +20,7 @@ impl OrganizationDetails {
     ) -> Result<Self, Error> {
         let advisories = org.find_related(advisory::Entity).all(tx).await?;
         Ok(OrganizationDetails {
-            head: OrganizationHead::from_entity(org).await?,
+            head: OrganizationHead::from_entity(org),
             advisories: AdvisoryHead::from_entities(&advisories, tx).await?,
         })
     }

modules/fundamental/src/organization/model/details/mod.rs

@@ -1,14 +1,13 @@
 use serde::{Deserialize, Serialize};
+use trustify_entity::organization;
 use utoipa::ToSchema;
 use uuid::Uuid;
 
 mod details;
 mod summary;
 
-use crate::Error;
 pub use details::*;
 pub use summary::*;
-use trustify_entity::organization;
 
 /// An organization who may issue advisories, product SBOMs, or
 /// otherwise be involved in supply-chain evidence.
@@ -30,12 +29,12 @@ pub struct OrganizationHead {
 }
 
 impl OrganizationHead {
-    pub async fn from_entity(organization: &organization::Model) -> Result<Self, Error> {
-        Ok(OrganizationHead {
+    pub fn from_entity(organization: &organization::Model) -> Self {
+        OrganizationHead {
             id: organization.id,
             name: organization.name.clone(),
             cpe_key: organization.cpe_key.clone(),
             website: organization.website.clone(),
-        })
+        }
     }
 }

modules/fundamental/src/organization/model/mod.rs

@@ -1,4 +1,3 @@
-use crate::Error;
 use crate::organization::model::OrganizationHead;
 use serde::{Deserialize, Serialize};
 use trustify_entity::organization;
@@ -11,21 +10,16 @@ pub struct OrganizationSummary {
 }
 
 impl OrganizationSummary {
-    pub async fn from_entity(organization: &organization::Model) -> Result<Self, Error> {
-        Ok(OrganizationSummary {
-            head: OrganizationHead::from_entity(organization).await?,
-        })
-    }
-
-    pub async fn from_entities(organizations: &[organization::Model]) -> Result<Vec<Self>, Error> {
-        let mut summaries = Vec::new();
-
-        for org in organizations {
-            summaries.push(OrganizationSummary {
-                head: OrganizationHead::from_entity(org).await?,
-            });
+    pub fn from_entity(organization: &organization::Model) -> Self {
+        Self {
+            head: OrganizationHead::from_entity(organization),
         }
+    }
 
-        Ok(summaries)
+    pub fn from_entities(organizations: &[organization::Model]) -> Vec<Self> {
+        organizations
+            .iter()
+            .map(OrganizationSummary::from_entity)
+            .collect()
     }
 }

modules/fundamental/src/organization/model/summary.rs

@@ -37,7 +37,7 @@ impl OrganizationService {
 
         Ok(PaginatedResults {
             total,
-            items: OrganizationSummary::from_entities(&limiter.fetch().await?).await?,
+            items: OrganizationSummary::from_entities(&limiter.fetch().await?),
         })
     }
     pub async fn fetch_organization<C: ConnectionTrait>(

modules/fundamental/src/organization/service/mod.rs

@@ -29,11 +29,7 @@ impl ProductDetails {
             .find_related(product_version::Entity)
             .all(tx)
             .await?;
-        let vendor = if let Some(org) = org {
-            Some(OrganizationSummary::from_entity(&org).await?)
-        } else {
-            None
-        };
+        let vendor = org.map(|org| OrganizationSummary::from_entity(&org));
         Ok(ProductDetails {
             head: ProductHead::from_entity(product).await?,
             versions: ProductVersionDetails::from_entities(&product_versions, tx).await?,

modules/fundamental/src/product/model/details.rs

@@ -22,11 +22,7 @@ impl ProductSummary {
         org: Option<organization::Model>,
         versions: &[product_version::Model],
     ) -> Result<Self, Error> {
-        let vendor = if let Some(org) = org {
-            Some(OrganizationSummary::from_entity(&org).await?)
-        } else {
-            None
-        };
+        let vendor = org.map(|org| OrganizationSummary::from_entity(&org));
         Ok(ProductSummary {
             head: ProductHead::from_entity(product).await?,
             versions: ProductVersionHead::from_entities(versions).await?,

modules/fundamental/src/product/model/summary.rs

@@ -2,22 +2,22 @@
 
 use std::str::FromStr;
 use test_context::test_context;
-use test_log::test;
-use tracing::instrument;
 use trustify_common::id::Id;
 use trustify_module_fundamental::sbom::service::SbomService;
-use trustify_test_context::TrustifyContext;
+use trustify_test_context::{TrustifyContext, flame::setup_global_subscriber};
 
 #[test_context(TrustifyContext, skip_teardown)]
-#[test(tokio::test)]
-#[instrument]
+#[tokio::test]
 #[ignore = "Only works with a pre-existing database and a specific dump"]
 async fn fetch(ctx: TrustifyContext) -> anyhow::Result<()> {
+    let _guard = setup_global_subscriber();
+
     // this requires an imported dataset
 
     let service = SbomService::new(ctx.db.clone());
+    // update this digest to point to a "large SBOM"
     let id =
-        Id::from_str("sha256:e2fba0cf6d3c79cf6994b31e172b5f11ee5e3f9dd7629ac0f1a5ae5cae2d6135")?;
+        Id::from_str("sha256:f293eb898192085804419f9dd40a738f20d67dd81846e88c6720f692ec5f3081")?;
     let statuses: Vec<String> = vec!["affected".to_string()];
 
     let result = service.fetch_sbom_details(id, statuses, &ctx.db).await?;

modules/fundamental/tests/issues/oom.rs

@@ -28,6 +28,8 @@ test-context = { workspace = true }
 tokio = { workspace = true }
 tokio-util = { workspace = true }
 tracing = { workspace = true }
+tracing-flame =  { workspace = true }
+tracing-subscriber = { workspace = true }
 utoipa-actix-web = { workspace = true }
 
 [dev-dependencies]

test-context/Cargo.toml

@@ -0,0 +1,35 @@
+use tracing_flame::FlameLayer;
+use tracing_subscriber::{fmt, prelude::*, registry::Registry};
+
+/// set up a global tracing subscriber, generating a trace file for flamecharts.
+///
+/// ## Usage
+///
+/// Add this to a test, using the following pattern:
+///
+/// ```rust
+/// use trustify_test_context::flame::setup_global_subscriber;
+///
+/// #[test]
+/// fn test() {
+///   let _guard = setup_global_subscriber();
+///
+///   // test code
+/// }
+/// ```
+///
+/// If the test ran successfully, this will create a file named `tracing.folded` containing the
+/// result.
+///
+#[allow(clippy::test_attr_in_doctest)]
+#[allow(clippy::unwrap_used)]
+pub fn setup_global_subscriber() -> impl Drop {
+    let fmt_layer = fmt::Layer::default();
+
+    let (flame_layer, _guard) = FlameLayer::with_file("./tracing.folded").unwrap();
+
+    let subscriber = Registry::default().with(fmt_layer).with(flame_layer);
+
+    tracing::subscriber::set_global_default(subscriber).expect("Could not set global default");
+    _guard
+}

test-context/src/flame.rs

@@ -3,6 +3,7 @@
 pub mod app;
 pub mod auth;
 pub mod call;
+pub mod flame;
 pub mod spdx;
 pub mod subset;