move ereports into nexus-types

Author: hawkw

dev-tools/omdb/src/bin/omdb/db/ereport.rs

@@ -21,15 +21,17 @@ use clap::Args;
 use clap::Subcommand;
 use diesel::dsl::{count_distinct, min};
 use diesel::prelude::*;
-use ereport_types::Ena;
-use ereport_types::EreporterRestartUuid;
 use nexus_db_lookup::DbConnection;
 use nexus_db_model::SpType;
 use nexus_db_queries::db;
 use nexus_db_queries::db::DataStore;
 use nexus_db_queries::db::queries::ALLOW_FULL_TABLE_SCAN_SQL;
 use nexus_db_schema::schema::host_ereport::dsl as host_dsl;
 use nexus_db_schema::schema::sp_ereport::dsl as sp_dsl;
+use nexus_types::fm::ereport::{
+    Ena, Ereport, EreportId, EreportMetadata, Reporter,
+};
+use omicron_uuid_kinds::EreporterRestartUuid;
 use omicron_uuid_kinds::GenericUuid;
 use omicron_uuid_kinds::SledUuid;
 use tabled::Tabled;
@@ -130,7 +132,7 @@ async fn cmd_db_ereport_list(
         ena: Ena,
         #[tabled(display_with = "display_option_blank")]
         class: Option<String>,
-        source: db::model::Reporter,
+        source: Reporter,
         #[tabled(display_with = "display_option_blank", rename = "S/N")]
         serial: Option<&'report str>,
         #[tabled(display_with = "display_option_blank", rename = "P/N")]
@@ -155,7 +157,7 @@ async fn cmd_db_ereport_list(
                 restart_id: restart_id.into_untyped_uuid(),
                 ena: ena.into(),
                 class: class.clone(),
-                source: db::model::Reporter::Sp {
+                source: Reporter::Sp {
                     sp_type: sp_type.into(),
                     slot: sp_slot.0,
                 },
@@ -181,7 +183,7 @@ async fn cmd_db_ereport_list(
                 restart_id: restart_id.into_untyped_uuid(),
                 ena: ena.into(),
                 class: class.clone(),
-                source: db::model::Reporter::HostOs { sled: sled_id.into() },
+                source: Reporter::HostOs { sled: sled_id.into() },
                 serial: Some(&sled_serial),
                 part_number: None, // TODO(eliza): go get this from inventory?
             }
@@ -306,17 +308,18 @@ async fn cmd_db_ereport_info(
     let &InfoArgs { restart_id, ena } = args;
     let ereport_id = ereport_types::EreportId { restart_id, ena };
     let conn = datastore.pool_connection_for_tests().await?;
-    let db::model::Ereport { id, metadata, reporter, report } =
-        ereport_fetch(&conn, fetch_opts, ereport_id).await?;
-
-    let db::model::EreportMetadata {
-        time_collected,
-        time_deleted,
-        collector_id,
+    let Ereport {
+        id,
         part_number,
         serial_number,
         class,
-    } = metadata;
+        metadata,
+        reporter,
+        report,
+    } = ereport_fetch(&conn, fetch_opts, ereport_id).await?;
+
+    let EreportMetadata { time_collected, time_deleted, collector_id } =
+        metadata;
     const ENA: &str = "ENA";
     const TIME_COLLECTED: &str = "collected at";
     const TIME_DELETED: &str = "deleted at";
@@ -347,12 +350,12 @@ async fn cmd_db_ereport_info(
     println!("    {TIME_COLLECTED:>WIDTH$}: {time_collected}");
     println!("    {COLLECTOR_ID:>WIDTH$}: {collector_id}");
     match reporter {
-        db::model::Reporter::Sp { sp_type, slot } => {
+        Reporter::Sp { sp_type, slot } => {
             println!(
                 "    {REPORTER:>WIDTH$}: {sp_type:?} {slot} (service processor)"
             )
         }
-        db::model::Reporter::HostOs { sled } => {
+        Reporter::HostOs { sled } => {
             println!("    {REPORTER:>WIDTH$}: sled {sled:?} (host OS)");
         }
     }
@@ -377,8 +380,8 @@ async fn cmd_db_ereport_info(
 async fn ereport_fetch(
     conn: &async_bb8_diesel::Connection<DbConnection>,
     fetch_opts: &DbFetchOptions,
-    id: ereport_types::EreportId,
-) -> anyhow::Result<db::model::Ereport> {
+    id: EreportId,
+) -> anyhow::Result<Ereport> {
     let restart_id = id.restart_id.into_untyped_uuid();
     let ena = db::model::DbEna::from(id.ena);
 
@@ -530,7 +533,7 @@ async fn cmd_db_ereporters(
         #[tabled(display_with = "datetime_opt_rfc3339_concise")]
         first_seen: Option<DateTime<Utc>>,
         id: Uuid,
-        identity: db::model::Reporter,
+        identity: Reporter,
         #[tabled(display_with = "display_option_blank", rename = "S/N")]
         serial: Option<String>,
         #[tabled(display_with = "display_option_blank", rename = "P/N")]
@@ -551,7 +554,7 @@ async fn cmd_db_ereporters(
             )| {
                 ReporterRow {
                     first_seen,
-                    identity: db::model::Reporter::Sp {
+                    identity: Reporter::Sp {
                         slot: slot.0,
                         sp_type: sp_type.into(),
                     },
@@ -565,7 +568,7 @@ async fn cmd_db_ereporters(
         let host_rows = host_ereporters.into_iter().map(
             |(restart_id, sled_id, serial, first_seen, ereports)| ReporterRow {
                 first_seen,
-                identity: db::model::Reporter::HostOs {
+                identity: Reporter::HostOs {
                     sled: SledUuid::from_untyped_uuid(sled_id),
                 },
                 serial: Some(serial),

nexus/db-model/src/ereport.rs

@@ -12,14 +12,13 @@ use diesel::pg::Pg;
 use diesel::prelude::*;
 use diesel::serialize::{self, ToSql};
 use diesel::sql_types;
-use ereport_types::{Ena, EreportId};
 use nexus_db_schema::schema::{host_ereport, sp_ereport};
-use omicron_uuid_kinds::{
-    EreporterRestartKind, OmicronZoneKind, OmicronZoneUuid, SledKind, SledUuid,
+use nexus_types::fm::ereport::{
+    Ena, Ereport, EreportId, EreportMetadata, Reporter,
 };
+use omicron_uuid_kinds::{EreporterRestartKind, OmicronZoneKind, SledKind};
 use serde::{Deserialize, Serialize};
 use std::convert::TryFrom;
-use std::fmt;
 
 #[derive(
     Copy,
@@ -63,131 +62,6 @@ where
     }
 }
 
-#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
-pub struct Ereport {
-    #[serde(flatten)]
-    pub id: EreportId,
-    #[serde(flatten)]
-    pub metadata: EreportMetadata,
-    pub reporter: Reporter,
-    #[serde(flatten)]
-    pub report: serde_json::Value,
-}
-
-impl From<SpEreport> for Ereport {
-    fn from(sp_report: SpEreport) -> Self {
-        let SpEreport {
-            restart_id,
-            ena,
-            time_collected,
-            time_deleted,
-            collector_id,
-            part_number,
-            serial_number,
-            sp_type,
-            sp_slot,
-            class,
-            report,
-        } = sp_report;
-        Ereport {
-            id: EreportId { restart_id: restart_id.into(), ena: ena.into() },
-            metadata: EreportMetadata {
-                time_collected,
-                time_deleted,
-                collector_id: collector_id.into(),
-                part_number,
-                serial_number,
-                class,
-            },
-            reporter: Reporter::Sp { sp_type: sp_type.into(), slot: sp_slot.0 },
-            report,
-        }
-    }
-}
-
-impl From<HostEreport> for Ereport {
-    fn from(host_report: HostEreport) -> Self {
-        let HostEreport {
-            restart_id,
-            ena,
-            time_collected,
-            time_deleted,
-            collector_id,
-            sled_serial,
-            sled_id,
-            class,
-            report,
-            part_number,
-        } = host_report;
-        Ereport {
-            id: EreportId { restart_id: restart_id.into(), ena: ena.into() },
-            metadata: EreportMetadata {
-                time_collected,
-                time_deleted,
-                collector_id: collector_id.into(),
-                part_number,
-                serial_number: Some(sled_serial),
-                class,
-            },
-            reporter: Reporter::HostOs { sled: sled_id.into() },
-            report,
-        }
-    }
-}
-
-#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
-pub struct EreportMetadata {
-    pub time_collected: DateTime<Utc>,
-    pub time_deleted: Option<DateTime<Utc>>,
-    pub collector_id: OmicronZoneUuid,
-    pub part_number: Option<String>,
-    pub serial_number: Option<String>,
-    pub class: Option<String>,
-}
-
-#[derive(
-    Clone,
-    Debug,
-    Eq,
-    PartialEq,
-    Ord,
-    PartialOrd,
-    serde::Serialize,
-    serde::Deserialize,
-)]
-pub enum Reporter {
-    Sp { sp_type: nexus_types::inventory::SpType, slot: u16 },
-    HostOs { sled: SledUuid },
-}
-
-impl std::fmt::Display for Reporter {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        match self {
-            Self::Sp {
-                sp_type: nexus_types::inventory::SpType::Sled,
-                slot,
-            } => {
-                write!(f, "Sled (SP) {slot:02}")
-            }
-            Self::Sp {
-                sp_type: nexus_types::inventory::SpType::Switch,
-                slot,
-            } => {
-                write!(f, "Switch {slot}")
-            }
-            Self::Sp {
-                sp_type: nexus_types::inventory::SpType::Power,
-                slot,
-            } => {
-                write!(f, "PSC {slot}")
-            }
-            Self::HostOs { sled } => {
-                write!(f, "Sled (OS) {sled:?}")
-            }
-        }
-    }
-}
-
 #[derive(Clone, Debug, Insertable, Queryable, Selectable)]
 #[diesel(table_name = sp_ereport)]
 pub struct SpEreport {
@@ -235,6 +109,37 @@ pub struct SpEreport {
     pub report: serde_json::Value,
 }
 
+impl From<SpEreport> for Ereport {
+    fn from(sp_report: SpEreport) -> Self {
+        let SpEreport {
+            restart_id,
+            ena,
+            time_collected,
+            time_deleted,
+            collector_id,
+            part_number,
+            serial_number,
+            sp_type,
+            sp_slot,
+            class,
+            report,
+        } = sp_report;
+        Ereport {
+            id: EreportId { restart_id: restart_id.into(), ena: ena.into() },
+            part_number,
+            serial_number,
+            class,
+            metadata: EreportMetadata {
+                time_collected,
+                time_deleted,
+                collector_id: collector_id.into(),
+            },
+            reporter: Reporter::Sp { sp_type: sp_type.into(), slot: sp_slot.0 },
+            report,
+        }
+    }
+}
+
 #[derive(Clone, Debug, Insertable, Queryable, Selectable)]
 #[diesel(table_name = host_ereport)]
 pub struct HostEreport {
@@ -261,3 +166,33 @@ pub struct HostEreport {
     // table's part_number column. Sad.
     pub part_number: Option<String>,
 }
+
+impl From<HostEreport> for Ereport {
+    fn from(host_report: HostEreport) -> Self {
+        let HostEreport {
+            restart_id,
+            ena,
+            time_collected,
+            time_deleted,
+            collector_id,
+            sled_serial,
+            sled_id,
+            class,
+            report,
+            part_number,
+        } = host_report;
+        Ereport {
+            id: EreportId { restart_id: restart_id.into(), ena: ena.into() },
+            part_number,
+            serial_number: Some(sled_serial),
+            class,
+            metadata: EreportMetadata {
+                time_collected,
+                time_deleted,
+                collector_id: collector_id.into(),
+            },
+            reporter: Reporter::HostOs { sled: sled_id.into() },
+            report,
+        }
+    }
+}

nexus/db-queries/src/db/datastore/ereport.rs

@@ -9,9 +9,7 @@ use crate::authz;
 use crate::context::OpContext;
 use crate::db::datastore::RunnableQuery;
 use crate::db::model::DbEna;
-use crate::db::model::Ereport;
 use crate::db::model::HostEreport;
-use crate::db::model::Reporter;
 use crate::db::model::SpEreport;
 use crate::db::model::SpMgsSlot;
 use crate::db::model::SpType;
@@ -28,6 +26,7 @@ use nexus_db_errors::public_error_from_diesel;
 use nexus_db_lookup::DbConnection;
 use nexus_db_schema::schema::host_ereport::dsl as host_dsl;
 use nexus_db_schema::schema::sp_ereport::dsl as sp_dsl;
+use nexus_types::fm::ereport::{Ereport, Reporter};
 use omicron_common::api::external::CreateResult;
 use omicron_common::api::external::DataPageParams;
 use omicron_common::api::external::Error;

nexus/src/app/background/tasks/support_bundle_collector.rs

@@ -23,7 +23,6 @@ use gateway_client::types::SpIgnition;
 use gateway_types::component::SpType;
 use internal_dns_resolver::Resolver;
 use internal_dns_types::names::ServiceName;
-use nexus_db_model::Ereport;
 use nexus_db_model::Sled;
 use nexus_db_model::SupportBundle;
 use nexus_db_model::SupportBundleState;
@@ -35,6 +34,7 @@ use nexus_db_queries::db::datastore::EreportFilters;
 use nexus_db_queries::db::pagination::Paginator;
 use nexus_reconfigurator_preparation::reconfigurator_state_load;
 use nexus_types::deployment::SledFilter;
+use nexus_types::fm::Ereport;
 use nexus_types::identity::Asset;
 use nexus_types::internal_api::background::SupportBundleCleanupReport;
 use nexus_types::internal_api::background::SupportBundleCollectionReport;
@@ -1248,7 +1248,6 @@ async fn write_ereport(ereport: Ereport, dir: &Utf8Path) -> anyhow::Result<()> {
     // metadata --- we must check that it doesn't contain any characters
     // unsuitable for use in a filesystem path.
     let pn = ereport
-        .metadata
         .part_number
         .as_deref()
         // If the part or serial numbers contain any unsavoury characters, it
@@ -1259,7 +1258,6 @@ async fn write_ereport(ereport: Ereport, dir: &Utf8Path) -> anyhow::Result<()> {
         .filter(|&s| is_fs_safe_single_path_component(s))
         .unwrap_or("unknown_part");
     let sn = ereport
-        .metadata
         .serial_number
         .as_deref()
         .filter(|&s| is_fs_safe_single_path_component(s))