fix: add an ai feature so that ai features are not compiled by default.

Fixes #1219

Signed-off-by: Hiram Chirino <[email protected]>

Author: chirino

.cargo/config.toml

@@ -1,5 +1,6 @@
 [alias]
 xtask = "run --package xtask --"
+xtask-ai = "run --features ai --package xtask --"
 
 [env]
 CARGO_WORKSPACE_ROOT = { value = "", relative = true }

.github/workflows/ci.yaml

@@ -53,7 +53,7 @@ jobs:
           key: ${{ runner.os }}-theseus-postgresql-${{ hashFiles('**/Cargo.lock') }}
 
       - name: Test
-        run: cargo test -- --nocapture
+        run: cargo test --all-features -- --nocapture
         env:
           RUST_LOG: warn,sqlx=error,sea_orm=error
       - name: Export and Validate Generated Openapi Spec

common/Cargo.toml

@@ -5,6 +5,9 @@ edition.workspace = true
 publish.workspace = true
 license.workspace = true
 
+[features]
+ai = [ "trustify-migration/ai" ]
+
 [dependencies]
 trustify-migration = { workspace = true }
 

common/src/db/mod.rs

@@ -47,6 +47,8 @@ impl Database {
     pub async fn migrate(&self) -> Result<(), anyhow::Error> {
         log::debug!("applying migrations");
         Migrator::up(&self.db, None).await?;
+        #[cfg(feature = "ai")]
+        migration::ai::Migrator::up(&self.db, None).await?;
         log::debug!("applied migrations");
 
         Ok(())
@@ -56,6 +58,8 @@ impl Database {
     pub async fn refresh(&self) -> Result<(), anyhow::Error> {
         log::warn!("refreshing database schema...");
         Migrator::refresh(&self.db).await?;
+        #[cfg(feature = "ai")]
+        migration::ai::Migrator::refresh(&self.db).await?;
         log::warn!("refreshing database schema... done!");
 
         Ok(())

migration/Cargo.toml

@@ -9,6 +9,9 @@ license.workspace = true
 name = "migration"
 path = "src/lib.rs"
 
+[features]
+ai = ["trustify-common/ai"]
+
 [dependencies]
 sea-orm-migration = { workspace = true, features = ["runtime-tokio-rustls", "sqlx-postgres", "with-uuid"] }
 serde_json = { workspace = true }

migration/src/ai.rs

@@ -0,0 +1,19 @@
+pub use sea_orm_migration::prelude::*;
+
+pub struct Migrator;
+
+#[async_trait::async_trait]
+impl MigratorTrait for Migrator {
+    fn migration_table_name() -> DynIden {
+        #[derive(DeriveIden)]
+        enum AiTables {
+            AiMigrations,
+        }
+
+        AiTables::AiMigrations.into_iden()
+    }
+
+    fn migrations() -> Vec<Box<dyn MigrationTrait>> {
+        vec![Box::new(crate::m0000820_create_conversation::Migration)]
+    }
+}

migration/src/lib.rs

@@ -103,6 +103,9 @@ mod m0000830_perf_indexes;
 mod m0000840_add_relationship_14_15;
 mod m0000850_python_version;
 
+#[cfg(feature = "ai")]
+pub mod ai;
+
 pub struct Migrator;
 
 #[async_trait::async_trait]
@@ -207,7 +210,6 @@ impl MigratorTrait for Migrator {
             Box::new(m0000790_alter_sbom_alter_document_id::Migration),
             Box::new(m0000800_alter_product_version_range_scheme::Migration),
             Box::new(m0000810_fix_get_purl::Migration),
-            Box::new(m0000820_create_conversation::Migration),
             Box::new(m0000830_perf_indexes::Migration),
             Box::new(m0000840_add_relationship_14_15::Migration),
             Box::new(m0000850_python_version::Migration),

migration/tests/tests.rs

@@ -21,6 +21,26 @@ async fn test_migrations(ctx: TrustifyContext) -> Result<(), anyhow::Error> {
     Ok(())
 }
 
+#[cfg(feature = "ai")]
+#[test_context(TrustifyContext, skip_teardown)]
+#[test(tokio::test)]
+async fn test_ai_migrations(ctx: TrustifyContext) -> Result<(), anyhow::Error> {
+    let db = ctx.db;
+
+    let migrations = migration::ai::Migrator::get_applied_migrations(&db).await?;
+    // 'Migrator.up' was called in bootstrap function when using TrustifyContext.
+    // At this point we already have migrations.
+    assert!(!migrations.is_empty());
+
+    db.refresh().await?;
+
+    let rolled_back_and_reapplied_migrations =
+        migration::ai::Migrator::get_applied_migrations(&db).await?;
+    assert!(!rolled_back_and_reapplied_migrations.is_empty());
+
+    Ok(())
+}
+
 #[test_context(TrustifyContext, skip_teardown)]
 #[test(tokio::test)]
 async fn only_up_migration(_ctx: TrustifyContext) -> Result<(), anyhow::Error> {

modules/fundamental/Cargo.toml

@@ -5,9 +5,13 @@ edition.workspace = true
 publish.workspace = true
 license.workspace = true
 
+[features]
+default = []
+ai = [ "trustify-common/ai" ]
+
 [dependencies]
 trustify-auth = { workspace = true }
-trustify-common = { workspace = true }
+trustify-common = { workspace = true}
 trustify-cvss = { workspace = true }
 trustify-entity = { workspace = true }
 trustify-module-analysis = { workspace = true }

modules/fundamental/src/ai/endpoints/mod.rs

@@ -1,3 +1,4 @@
+#[cfg(feature = "ai")]
 #[cfg(test)]
 mod test;
 

modules/fundamental/src/ai/endpoints/test.rs

@@ -173,20 +173,25 @@ async fn conversation_crud(ctx: &TrustifyContext) -> anyhow::Result<()> {
 
     // Verify that there are no conversations
     let request = TestRequest::get()
-        .uri("/api/v1/ai/conversations")
+        .uri("/api/v2/ai/conversations")
         .to_request()
         .test_auth("user-a");
 
     let response = app.call_service(request).await;
-    assert_eq!(response.status(), StatusCode::OK);
+    assert_eq!(
+        response.status(),
+        StatusCode::OK,
+        "response: {:?}",
+        read_text(response).await
+    );
 
     let result: PaginatedResults<ConversationSummary> = read_body_json(response).await;
     assert_eq!(result.total, 0);
     assert_eq!(result.items.len(), 0);
 
     // Create a conversation
     let request = TestRequest::post()
-        .uri("/api/v1/ai/conversations")
+        .uri("/api/v2/ai/conversations")
         .to_request()
         .test_auth("user-a");
 
@@ -208,7 +213,7 @@ async fn conversation_crud(ctx: &TrustifyContext) -> anyhow::Result<()> {
     ));
 
     let request = TestRequest::put()
-        .uri(format!("/api/v1/ai/conversations/{}", conversation_v1.id).as_str())
+        .uri(format!("/api/v2/ai/conversations/{}", conversation_v1.id).as_str())
         .set_json(update1.clone())
         .to_request()
         .test_auth("user-a");
@@ -225,7 +230,7 @@ async fn conversation_crud(ctx: &TrustifyContext) -> anyhow::Result<()> {
 
     // Verify that the conversation can be listed
     let request = TestRequest::get()
-        .uri("/api/v1/ai/conversations")
+        .uri("/api/v2/ai/conversations")
         .to_request()
         .test_auth("user-a");
 
@@ -239,7 +244,7 @@ async fn conversation_crud(ctx: &TrustifyContext) -> anyhow::Result<()> {
 
     // Verify that we can retrieve the conversation by ID
     let request = TestRequest::get()
-        .uri(format!("/api/v1/ai/conversations/{}", conversation_v1.id).as_str())
+        .uri(format!("/api/v2/ai/conversations/{}", conversation_v1.id).as_str())
         .to_request()
         .test_auth("user-a");
 
@@ -256,7 +261,7 @@ async fn conversation_crud(ctx: &TrustifyContext) -> anyhow::Result<()> {
     ));
 
     let request = TestRequest::put()
-        .uri(format!("/api/v1/ai/conversations/{}", conversation_v1.id).as_str())
+        .uri(format!("/api/v2/ai/conversations/{}", conversation_v1.id).as_str())
         .append_header(("if-match", format!("\"{}\"", conversation_v2.seq).as_str()))
         .set_json(update2.clone())
         .to_request()
@@ -274,7 +279,7 @@ async fn conversation_crud(ctx: &TrustifyContext) -> anyhow::Result<()> {
 
     // Verify that we can retrieve the updated conversation by ID
     let request = TestRequest::get()
-        .uri(format!("/api/v1/ai/conversations/{}", conversation_v1.id).as_str())
+        .uri(format!("/api/v2/ai/conversations/{}", conversation_v1.id).as_str())
         .to_request()
         .test_auth("user-a");
 
@@ -286,7 +291,7 @@ async fn conversation_crud(ctx: &TrustifyContext) -> anyhow::Result<()> {
 
     // Verify that we can delete the conversation
     let request = TestRequest::delete()
-        .uri(format!("/api/v1/ai/conversations/{}", conversation_v1.id).as_str())
+        .uri(format!("/api/v2/ai/conversations/{}", conversation_v1.id).as_str())
         .to_request()
         .test_auth("user-a");
 
@@ -295,7 +300,7 @@ async fn conversation_crud(ctx: &TrustifyContext) -> anyhow::Result<()> {
 
     // Verify that the conversation is deleted
     let request = TestRequest::get()
-        .uri("/api/v1/ai/conversations")
+        .uri("/api/v2/ai/conversations")
         .to_request()
         .test_auth("user-a");
 

modules/fundamental/src/endpoints.rs

@@ -24,6 +24,7 @@ pub fn configure(
 
     crate::advisory::endpoints::configure(svc, db.clone(), config.advisory_upload_limit);
     crate::license::endpoints::configure(svc, db.clone());
+    #[cfg(feature = "ai")]
     crate::ai::endpoints::configure(svc, db.clone());
     crate::organization::endpoints::configure(svc, db.clone());
     crate::purl::endpoints::configure(svc, db.clone());

modules/fundamental/src/lib.rs

@@ -1,4 +1,5 @@
 pub mod advisory;
+#[cfg(feature = "ai")]
 pub mod ai;
 pub mod endpoints;
 pub mod error;