TableOutput -> OxqlTable, move to views.rs

into -> from

Author: david-crespo

nexus/tests/integration_tests/metrics.rs

@@ -22,7 +22,7 @@ use nexus_test_utils::resource_helpers::{
 use nexus_test_utils::wait_for_producer;
 use nexus_test_utils_macros::nexus_test;
 use nexus_types::external_api::shared::ProjectRole;
-use nexus_types::external_api::views::OxqlQueryResult;
+use nexus_types::external_api::views;
 use nexus_types::silo::DEFAULT_SILO_ID;
 use omicron_uuid_kinds::{GenericUuid, InstanceUuid};
 use oximeter::TimeseriesSchema;
@@ -270,7 +270,7 @@ async fn test_instance_watcher_metrics(
 
     #[track_caller]
     fn count_state(
-        table: &oxql_types::TableOutput,
+        table: &views::OxqlTable,
         instance_id: InstanceUuid,
         state: &'static str,
     ) -> Result<i64, MetricsNotYet> {
@@ -639,7 +639,7 @@ async fn test_project_timeseries_query(
         .expect_status(Some(StatusCode::OK));
     let result = NexusRequest::new(request)
         .authn_as(AuthnMode::UnprivilegedUser)
-        .execute_and_parse_unwrap::<OxqlQueryResult>()
+        .execute_and_parse_unwrap::<views::OxqlQueryResult>()
         .await;
     assert_eq!(result.tables.len(), 1);
     assert_eq!(result.tables[0].timeseries().len(), 2); // two instances

nexus/tests/integration_tests/metrics_querier.rs

@@ -13,7 +13,7 @@ use nexus_test_utils::http_testing::NexusRequest;
 use nexus_test_utils::http_testing::RequestBuilder;
 use nexus_test_utils::resource_helpers::objects_list_page_authz;
 use nexus_types::external_api::params;
-use nexus_types::external_api::views::OxqlQueryResult;
+use nexus_types::external_api::views;
 use omicron_test_utils::dev::poll;
 use omicron_test_utils::dev::poll::CondCheckError;
 use omicron_test_utils::dev::poll::wait_for_condition;
@@ -93,7 +93,7 @@ impl<'a, N> MetricsQuerier<'a, N> {
         cond: F,
     ) -> T
     where
-        F: Fn(Vec<oxql_types::TableOutput>) -> Result<T, MetricsNotYet>,
+        F: Fn(Vec<views::OxqlTable>) -> Result<T, MetricsNotYet>,
     {
         self.timeseries_query_until("/v1/system/timeseries/query", query, cond)
             .await
@@ -108,7 +108,7 @@ impl<'a, N> MetricsQuerier<'a, N> {
         cond: F,
     ) -> T
     where
-        F: Fn(Vec<oxql_types::TableOutput>) -> Result<T, MetricsNotYet>,
+        F: Fn(Vec<views::OxqlTable>) -> Result<T, MetricsNotYet>,
     {
         self.timeseries_query_until(
             &format!("/v1/timeseries/query?project={project}"),
@@ -128,7 +128,7 @@ impl<'a, N> MetricsQuerier<'a, N> {
         &self,
         project: &str,
         query: &str,
-    ) -> Vec<oxql_types::TableOutput> {
+    ) -> Vec<views::OxqlTable> {
         self.project_timeseries_query_until(project, query, |tables| Ok(tables))
             .await
     }
@@ -270,7 +270,7 @@ impl<'a, N> MetricsQuerier<'a, N> {
         cond: F,
     ) -> T
     where
-        F: Fn(Vec<oxql_types::TableOutput>) -> Result<T, MetricsNotYet>,
+        F: Fn(Vec<views::OxqlTable>) -> Result<T, MetricsNotYet>,
     {
         let result = wait_for_condition(
             || async {
@@ -375,7 +375,7 @@ impl<'a, N> MetricsQuerier<'a, N> {
         // Try to parse the query as usual, which will fail on other kinds of
         // errors.
         TimeseriesQueryResult::Ok(
-            rsp.parsed_body::<OxqlQueryResult>()
+            rsp.parsed_body::<views::OxqlQueryResult>()
                 .unwrap_or_else(|e| {
                     panic!(
                         "could not parse timeseries query response: {e:?}\n\
@@ -389,5 +389,5 @@ impl<'a, N> MetricsQuerier<'a, N> {
 
 enum TimeseriesQueryResult {
     TimeseriesNotFound,
-    Ok(Vec<oxql_types::TableOutput>),
+    Ok(Vec<views::OxqlTable>),
 }

nexus/types/src/external_api/views.rs

@@ -1113,11 +1113,74 @@ pub struct AllowList {
 
 // OxQL QUERIES
 
+/// A table represents one or more timeseries with the same schema.
+///
+/// A table is the result of an OxQL query. It contains a name, usually the name
+/// of the timeseries schema from which the data is derived, and any number of
+/// timeseries, which contain the actual data.
+//
+// # Motivation
+//
+// This struct is derived from [`oxql_types::Table`] but presents timeseries data as a `Vec`
+// rather than a map keyed by [`TimeseriesKey`]. This provides a cleaner JSON
+// representation for external consumers, as these numeric keys are ephemeral
+// identifiers that have no meaning to API consumers. Key ordering is retained
+// as this is contructed from the already sorted values present in [`Table`].
+//
+// When serializing a [`Table`] to JSON, the `BTreeMap<TimeseriesKey, Timeseries>`
+// structure produces output with numeric keys like:
+// ```json
+// {
+//   "timeseries": {
+//     "2352746367989923131": { ... },
+//     "3940108470521992408": { ... }
+//   }
+// }
+// ```
+//
+// The `Table` view instead serializes timeseries as an array:
+// ```json
+// {
+//   "timeseries": [ { ... }, { ... } ]
+// }
+// ```
+#[derive(Clone, Debug, Deserialize, JsonSchema, PartialEq, Serialize)]
+pub struct OxqlTable {
+    /// The name of the table.
+    pub name: String,
+    /// The set of timeseries in the table, ordered by key.
+    pub timeseries: Vec<oxql_types::Timeseries>,
+}
+
+impl From<oxql_types::Table> for OxqlTable {
+    fn from(table: oxql_types::Table) -> Self {
+        OxqlTable {
+            name: table.name.clone(),
+            timeseries: table.into_iter().collect(),
+        }
+    }
+}
+
+// these methods are only used in tests
+impl OxqlTable {
+    /// Return the name of the table.
+    pub fn name(&self) -> &str {
+        self.name.as_str()
+    }
+
+    /// Return the list of timeseries in this table, ordered by key.
+    pub fn timeseries(
+        &self,
+    ) -> impl ExactSizeIterator<Item = &oxql_types::Timeseries> {
+        self.timeseries.iter()
+    }
+}
+
 /// The result of a successful OxQL query.
 #[derive(Clone, Debug, Deserialize, JsonSchema, Serialize)]
 pub struct OxqlQueryResult {
     /// Tables resulting from the query, each containing timeseries.
-    pub tables: Vec<oxql_types::TableOutput>,
+    pub tables: Vec<OxqlTable>,
 }
 
 // ALERTS

openapi/nexus.json

@@ -22275,14 +22275,35 @@
             "description": "Tables resulting from the query, each containing timeseries.",
             "type": "array",
             "items": {
-              "$ref": "#/components/schemas/TableOutput"
+              "$ref": "#/components/schemas/OxqlTable"
             }
           }
         },
         "required": [
           "tables"
         ]
       },
+      "OxqlTable": {
+        "description": "A table represents one or more timeseries with the same schema.\n\nA table is the result of an OxQL query. It contains a name, usually the name of the timeseries schema from which the data is derived, and any number of timeseries, which contain the actual data.",
+        "type": "object",
+        "properties": {
+          "name": {
+            "description": "The name of the table.",
+            "type": "string"
+          },
+          "timeseries": {
+            "description": "The set of timeseries in the table, ordered by key.",
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Timeseries"
+            }
+          }
+        },
+        "required": [
+          "name",
+          "timeseries"
+        ]
+      },
       "Password": {
         "title": "A password used to authenticate a user",
         "description": "Passwords may be subject to additional constraints.",
@@ -25523,25 +25544,6 @@
           "vlan_id"
         ]
       },
-      "TableOutput": {
-        "description": "A table represents one or more timeseries with the same schema.\n\nA table is the result of an OxQL query. It contains a name, usually the name of the timeseries schema from which the data is derived, and any number of timeseries, which contain the actual data.",
-        "type": "object",
-        "properties": {
-          "name": {
-            "type": "string"
-          },
-          "timeseries": {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/Timeseries"
-            }
-          }
-        },
-        "required": [
-          "name",
-          "timeseries"
-        ]
-      },
       "TargetRelease": {
         "description": "View of a system software target release.",
         "type": "object",

oximeter/oxql-types/src/lib.rs

@@ -11,7 +11,6 @@ pub mod point;
 pub mod table;
 
 pub use self::table::Table;
-pub use self::table::TableOutput;
 pub use self::table::Timeseries;
 
 /// Describes the time alignment for an OxQL query.

oximeter/oxql-types/src/table.rs

@@ -360,61 +360,3 @@ impl Table {
         }
     }
 }
-
-/// A table represents one or more timeseries with the same schema.
-///
-/// A table is the result of an OxQL query. It contains a name, usually the name
-/// of the timeseries schema from which the data is derived, and any number of
-/// timeseries, which contain the actual data.
-//
-// # Motivation
-//
-// This struct is derived from [`Table`] but presents timeseries data as a `Vec`
-// rather than a map keyed by [`TimeseriesKey`]. This provides a cleaner JSON
-// representation for external consumers, as these numeric keys are ephemeral
-// identifiers that have no meaning to API consumers. Key ordering is retained
-// as this is contructed from the already sorted values present in [`Table`].
-//
-// When serializing a [`Table`] to JSON, the `BTreeMap<TimeseriesKey, Timeseries>`
-// structure produces output with numeric keys like:
-// ```json
-// {
-//   "timeseries": {
-//     "2352746367989923131": { ... },
-//     "3940108470521992408": { ... }
-//   }
-// }
-// ```
-//
-// `TableOutput` instead serializes timeseries as an array:
-// ```json
-// {
-//   "timeseries": [ { ... }, { ... } ]
-// }
-// ```
-#[derive(Clone, Debug, Deserialize, JsonSchema, PartialEq, Serialize)]
-pub struct TableOutput {
-    // The name of the table.
-    pub name: String,
-    // The set of timeseries in the table, ordered by key.
-    timeseries: Vec<Timeseries>,
-}
-
-impl From<Table> for TableOutput {
-    fn from(table: Table) -> Self {
-        let timeseries: Vec<_> = table.timeseries.into_values().collect();
-        TableOutput { name: table.name, timeseries }
-    }
-}
-
-impl TableOutput {
-    /// Return the name of the table.
-    pub fn name(&self) -> &str {
-        self.name.as_str()
-    }
-
-    /// Return the list of timeseries in this table, ordered by key.
-    pub fn timeseries(&self) -> impl ExactSizeIterator<Item = &Timeseries> {
-        self.timeseries.iter()
-    }
-}