[ntp-admin-types] reorganize per RFD 619 (#9528)

Author: sunshowers

Cargo.lock

@@ -109,6 +109,7 @@ members = [
     "ntp-admin",
     "ntp-admin/api",
     "ntp-admin/types",
+    "ntp-admin/types/versions",
     "oximeter/api",
     "oximeter/collector",
     "oximeter/db",
@@ -274,6 +275,7 @@ default-members = [
     "ntp-admin",
     "ntp-admin/api",
     "ntp-admin/types",
+    "ntp-admin/types/versions",
     "oximeter/api",
     "oximeter/collector",
     "oximeter/db",
@@ -546,6 +548,7 @@ newtype_derive = "0.1.6"
 ntp-admin-api = { path = "ntp-admin/api" }
 ntp-admin-client = { path = "clients/ntp-admin-client" }
 ntp-admin-types = { path = "ntp-admin/types" }
+ntp-admin-types-versions = { path = "ntp-admin/types/versions" }
 mg-admin-client = { git = "https://github.com/oxidecomputer/maghemite", rev = "0df320d42b356e689a3c7a7600eec9b16770237a" }
 ddm-admin-client = { git = "https://github.com/oxidecomputer/maghemite", rev = "0df320d42b356e689a3c7a7600eec9b16770237a" }
 multimap = "0.10.1"

Cargo.toml

@@ -11,7 +11,7 @@ workspace = true
 dropshot.workspace = true
 dropshot-api-manager-types.workspace = true
 http.workspace = true
-ntp-admin-types.workspace = true
+ntp-admin-types-versions.workspace = true
 omicron-common.workspace = true
 omicron-uuid-kinds.workspace = true
 omicron-workspace-hack.workspace = true

ntp-admin/api/Cargo.toml

@@ -4,6 +4,7 @@
 
 use dropshot::{HttpError, HttpResponseOk, RequestContext};
 use dropshot_api_manager_types::api_versions;
+use ntp_admin_types_versions::latest;
 
 api_versions!([
     // WHEN CHANGING THE API (part 1 of 2):
@@ -43,5 +44,5 @@ pub trait NtpAdminApi {
     }]
     async fn timesync(
         rqctx: RequestContext<Self::Context>,
-    ) -> Result<HttpResponseOk<ntp_admin_types::TimeSync>, HttpError>;
+    ) -> Result<HttpResponseOk<latest::timesync::TimeSync>, HttpError>;
 }

ntp-admin/api/src/lib.rs

@@ -7,7 +7,7 @@ use dropshot::HttpError;
 use dropshot::HttpResponseOk;
 use dropshot::RequestContext;
 use ntp_admin_api::*;
-use ntp_admin_types::TimeSync;
+use ntp_admin_types::timesync::TimeSync;
 use slog::info;
 use slog_error_chain::InlineErrorChain;
 use std::net::IpAddr;

ntp-admin/src/http_entrypoints.rs

@@ -8,13 +8,5 @@ license = "MPL-2.0"
 workspace = true
 
 [dependencies]
-chrono.workspace = true
-omicron-common.workspace = true
+ntp-admin-types-versions.workspace = true
 omicron-workspace-hack.workspace = true
-schemars.workspace = true
-serde.workspace = true
-thiserror.workspace = true
-
-[dev-dependencies]
-proptest.workspace = true
-test-strategy.workspace = true

ntp-admin/types/Cargo.toml

@@ -2,29 +2,13 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
-use std::net::IpAddr;
+//! Common types for the NTP Admin API.
+//!
+//! This crate re-exports the latest versions of all types from the
+//! `ntp-admin-types-versions` crate. These are floating identifiers that should
+//! be used by business logic that doesn't need to care about API versioning.
+//!
+//! The API crate (`ntp-admin-api`) uses fixed identifiers from the versions
+//! crate directly.
 
-use schemars::JsonSchema;
-use serde::{Deserialize, Serialize};
-
-#[derive(Clone, Debug, Deserialize, Serialize, JsonSchema, PartialEq)]
-pub struct TimeSync {
-    /// The synchronization state of the sled, true when the system clock
-    /// and the NTP clock are in sync (to within a small window).
-    pub sync: bool,
-    /// The NTP reference ID.
-    pub ref_id: u32,
-    /// The NTP reference IP address.
-    pub ip_addr: IpAddr,
-    /// The NTP stratum (our upstream's stratum plus one).
-    pub stratum: u8,
-    /// The NTP reference time (i.e. what chrony thinks the current time is, not
-    /// necessarily the current system time).
-    pub ref_time: f64,
-    // This could be f32, but there is a problem with progenitor/typify
-    // where, although the f32 correctly becomes "float" (and not "double") in
-    // the API spec, that "float" gets converted back to f64 when generating
-    // the client.
-    /// The current offset between the NTP clock and system clock.
-    pub correction: f64,
-}
+pub mod timesync;

ntp-admin/types/src/lib.rs

@@ -0,0 +1,5 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+pub use ntp_admin_types_versions::latest::timesync::*;

ntp-admin/types/src/timesync.rs

@@ -0,0 +1,13 @@
+[package]
+name = "ntp-admin-types-versions"
+version = "0.1.0"
+edition.workspace = true
+license = "MPL-2.0"
+
+[lints]
+workspace = true
+
+[dependencies]
+omicron-workspace-hack.workspace = true
+schemars.workspace = true
+serde.workspace = true

ntp-admin/types/versions/Cargo.toml

@@ -0,0 +1,7 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+//! Version `INITIAL` of the NTP Admin API.
+
+pub mod timesync;