Merge pull request #5083 from systeminit/nick/9dc7644

Split `audit-logs` crate into two crates

Cargo.toml

@@ -13,7 +13,8 @@ members = [
     "bin/sdf",
     "bin/veritech",
     "lib/asset-sprayer",
-    "lib/audit-logs",
+    "lib/audit-database",
+    "lib/audit-logs-stream",
     "lib/auth-api-client",
     "lib/billing-events",
     "lib/buck2-resources",

lib/audit-logs/BUCK → lib/audit-database/BUCK

@@ -1,19 +1,16 @@
 load("@prelude-si//:macros.bzl", "rust_library")
 
 rust_library(
-    name = "audit-logs",
+    name = "audit-database",
     deps = [
-        "//lib/si-data-nats:si-data-nats",
         "//lib/si-data-pg:si-data-pg",
         "//lib/si-events-rs:si-events",
-        "//lib/telemetry-nats-rs:telemetry-nats",
         "//lib/telemetry-rs:telemetry",
         "//third-party/rust:chrono",
         "//third-party/rust:refinery",
         "//third-party/rust:remain",
         "//third-party/rust:serde",
         "//third-party/rust:serde_json",
-        "//third-party/rust:strum",
         "//third-party/rust:thiserror",
     ],
     srcs = glob([

lib/audit-logs/Cargo.toml → lib/audit-database/Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "audit-logs"
+name = "audit-database"
 edition = "2021"
 version.workspace = true
 authors.workspace = true
@@ -9,16 +9,13 @@ rust-version.workspace = true
 publish.workspace = true
 
 [dependencies]
-si-data-nats = { path = "../../lib/si-data-nats" }
 si-data-pg = { path = "../../lib/si-data-pg" }
 si-events = { path = "../../lib/si-events-rs" }
 telemetry = { path = "../../lib/telemetry-rs" }
-telemetry-nats = { path = "../../lib/telemetry-nats-rs" }
 
 chrono = { workspace = true }
 refinery = { workspace = true }
 remain = { workspace = true }
 serde = { workspace = true }
 serde_json = { workspace = true }
-strum = { workspace = true }
 thiserror = { workspace = true }

lib/audit-logs/src/database/context.rs → lib/audit-database/src/context.rs

@@ -5,6 +5,7 @@ use thiserror::Error;
 use super::AuditDatabaseConfig;
 
 #[allow(missing_docs)]
+#[remain::sorted]
 #[derive(Error, Debug)]
 pub enum AuditDatabaseContextError {
     #[error("pg pool error: {0}")]

lib/audit-logs/src/database.rs → lib/audit-database/src/lib.rs

@@ -1,4 +1,29 @@
-//! Contains functionality for setting up and communicating with the audit database.
+//! This crate contains functionality for setting up and communicating with the audit database.
+
+#![warn(
+    bad_style,
+    clippy::missing_panics_doc,
+    clippy::panic,
+    clippy::panic_in_result_fn,
+    clippy::unwrap_in_result,
+    clippy::unwrap_used,
+    dead_code,
+    improper_ctypes,
+    missing_debug_implementations,
+    missing_docs,
+    no_mangle_generic_items,
+    non_shorthand_field_patterns,
+    overflowing_literals,
+    path_statements,
+    patterns_in_fns_without_body,
+    unconditional_recursion,
+    unreachable_pub,
+    unused,
+    unused_allocation,
+    unused_comparisons,
+    unused_parens,
+    while_true
+)]
 
 use std::str::FromStr;
 
@@ -31,6 +56,7 @@ pub use context::AuditDatabaseContextError;
 pub use migrate::{migrate, AuditDatabaseMigrationError};
 
 #[allow(missing_docs)]
+#[remain::sorted]
 #[derive(Error, Debug)]
 pub enum AuditDatabaseError {
     #[error("chrono parse error: {0}")]

lib/audit-logs/src/database/migrate.rs → lib/audit-database/src/migrate.rs

@@ -7,6 +7,7 @@ use thiserror::Error;
 use super::AuditDatabaseContext;
 
 #[allow(missing_docs)]
+#[remain::sorted]
 #[derive(Error, Debug)]
 pub enum AuditDatabaseMigrationError {
     #[error("pg pool error: {0}")]

lib/audit-logs-stream/BUCK

@@ -0,0 +1,14 @@
+load("@prelude-si//:macros.bzl", "rust_library")
+
+rust_library(
+    name = "audit-logs-stream",
+    deps = [
+        "//lib/si-data-nats:si-data-nats",
+        "//lib/si-events-rs:si-events",
+        "//lib/telemetry-rs:telemetry",
+        "//third-party/rust:remain",
+        "//third-party/rust:serde_json",
+        "//third-party/rust:thiserror",
+    ],
+    srcs = glob(["src/**/*.rs"]),
+)

lib/audit-logs-stream/Cargo.toml

@@ -0,0 +1,18 @@
+[package]
+name = "audit-logs-stream"
+edition = "2021"
+version.workspace = true
+authors.workspace = true
+license.workspace = true
+repository.workspace = true
+rust-version.workspace = true
+publish.workspace = true
+
+[dependencies]
+si-data-nats = { path = "../../lib/si-data-nats" }
+si-events = { path = "../../lib/si-events-rs" }
+telemetry = { path = "../../lib/telemetry-rs" }
+
+remain = { workspace = true }
+serde_json = { workspace = true }
+thiserror = { workspace = true }

lib/audit-logs/src/stream.rs → lib/audit-logs-stream/src/lib.rs

@@ -1,4 +1,29 @@
-//! This module provides the ability to work with the audit logs stream.
+//! This crate provides the ability to work with the audit logs stream.
+
+#![warn(
+    bad_style,
+    clippy::missing_panics_doc,
+    clippy::panic,
+    clippy::panic_in_result_fn,
+    clippy::unwrap_in_result,
+    clippy::unwrap_used,
+    dead_code,
+    improper_ctypes,
+    missing_debug_implementations,
+    missing_docs,
+    no_mangle_generic_items,
+    non_shorthand_field_patterns,
+    overflowing_literals,
+    path_statements,
+    patterns_in_fns_without_body,
+    unconditional_recursion,
+    unreachable_pub,
+    unused,
+    unused_allocation,
+    unused_comparisons,
+    unused_parens,
+    while_true
+)]
 
 use std::time::Duration;
 

lib/dal-test/BUCK

@@ -3,7 +3,7 @@ load("@prelude-si//:macros.bzl", "rust_library")
 rust_library(
     name = "dal-test",
     deps = [
-        "//lib/audit-logs:audit-logs",
+        "//lib/audit-database:audit-database",
         "//lib/buck2-resources:buck2-resources",
         "//lib/dal:dal",
         "//lib/forklift-server:forklift-server",

lib/dal-test/Cargo.toml

@@ -9,26 +9,13 @@ rust-version.workspace = true
 publish.workspace = true
 
 [dependencies]
-async-recursion = { workspace = true }
-audit-logs = { path = "../../lib/audit-logs" }
-base64 = { workspace = true }
+audit-database = { path = "../../lib/audit-database" }
 buck2-resources = { path = "../../lib/buck2-resources" }
-color-eyre = { workspace = true }
 dal = { path = "../../lib/dal" }
-derive_builder = { workspace = true }
-derive_more = { workspace = true }
 forklift-server = { path = "../../lib/forklift-server" }
-jwt-simple = { workspace = true }
-lazy_static = { workspace = true }
-names = { workspace = true }
-opentelemetry-otlp = { workspace = true }
-opentelemetry_sdk = { workspace = true }
 pinga-server = { path = "../../lib/pinga-server" }
 rebaser-client = { path = "../../lib/rebaser-client" }
 rebaser-server = { path = "../../lib/rebaser-server" }
-remain = { workspace = true }
-serde = { workspace = true }
-serde_json = { workspace = true }
 si-crypto = { path = "../../lib/si-crypto" }
 si-data-nats = { path = "../../lib/si-data-nats" }
 si-data-pg = { path = "../../lib/si-data-pg" }
@@ -38,8 +25,25 @@ si-pkg = { path = "../../lib/si-pkg" }
 si-runtime = { path = "../../lib/si-runtime-rs" }
 si-std = { path = "../../lib/si-std" }
 si-test-macros = { path = "../../lib/si-test-macros" }
-sodiumoxide = { workspace = true }
 telemetry = { path = "../../lib/telemetry-rs" }
+veritech-client = { path = "../../lib/veritech-client" }
+veritech-server = { path = "../../lib/veritech-server" }
+
+async-recursion = { workspace = true }
+base64 = { workspace = true }
+color-eyre = { workspace = true }
+derive_builder = { workspace = true }
+derive_more = { workspace = true }
+itertools = { workspace = true }
+jwt-simple = { workspace = true }
+lazy_static = { workspace = true }
+names = { workspace = true }
+opentelemetry-otlp = { workspace = true }
+opentelemetry_sdk = { workspace = true }
+remain = { workspace = true }
+serde = { workspace = true }
+serde_json = { workspace = true }
+sodiumoxide = { workspace = true }
 tempfile = { workspace = true }
 thiserror = { workspace = true }
 tokio = { workspace = true }
@@ -48,6 +52,3 @@ tracing-opentelemetry = { workspace = true }
 tracing-subscriber = { workspace = true }
 ulid =  { workspace = true }
 uuid = { workspace = true }
-veritech-client = { path = "../../lib/veritech-client" }
-veritech-server = { path = "../../lib/veritech-server" }
-itertools = { workspace = true }

lib/dal-test/src/helpers.rs

@@ -2,7 +2,7 @@
 
 use std::time::Duration;
 
-use audit_logs::database::{AuditDatabaseContext, AuditLogRow};
+use audit_database::{AuditDatabaseContext, AuditLogRow};
 use color_eyre::eyre::eyre;
 use color_eyre::Result;
 use dal::component::socket::{ComponentInputSocket, ComponentOutputSocket};

lib/dal-test/src/lib.rs

@@ -33,7 +33,7 @@ use std::{
     sync::{Arc, Once},
 };
 
-use audit_logs::database::AuditDatabaseContext;
+use audit_database::AuditDatabaseContext;
 use buck2_resources::Buck2Resources;
 use dal::{
     builtins::func,
@@ -177,7 +177,7 @@ pub struct Config {
     symmetric_crypto_service_config: SymmetricCryptoServiceConfig,
     #[builder(default = "si_layer_cache::default_pg_pool_config()")]
     layer_cache_pg_pool: PgPoolConfig,
-    #[builder(default = "audit_logs::database::default_pg_pool_config()")]
+    #[builder(default = "audit_database::default_pg_pool_config()")]
     audit_pg_pool: PgPoolConfig,
 }
 
@@ -837,7 +837,7 @@ async fn global_setup(test_context_builer: TestContextBuilder) -> Result<()> {
             .pg_migrate()
             .await
             .wrap_err("failed to migrate layerdb")?;
-        audit_logs::database::migrate(&test_context.audit_database_context)
+        audit_database::migrate(&test_context.audit_database_context)
             .await
             .wrap_err("failed to migrate audit database")?;
     }