[update] rename UpdateArtifact to UpdateArtifactId, add derives (#2292)

In #2192 and elsewhere,
we treat the (name, version, kind) triple as a unique identifier for
artifacts. Rename `UpdateArtifact` to `UpdateArtifactId`, and add some
derives to allow it to be used as keys to unordered and ordered maps.

Author: sunshowers

common/src/api/internal/nexus.rs

@@ -77,11 +77,27 @@ impl ProducerEndpoint {
     }
 }
 
-/// Description of a single update artifact.
-#[derive(Clone, Debug, Deserialize, Serialize, JsonSchema)]
-pub struct UpdateArtifact {
+/// An identifier for a single update artifact.
+#[derive(
+    Clone,
+    Debug,
+    Eq,
+    PartialEq,
+    Hash,
+    Ord,
+    PartialOrd,
+    Deserialize,
+    Serialize,
+    JsonSchema,
+)]
+pub struct UpdateArtifactId {
+    /// The artifact's name.
     pub name: String,
+
+    /// The artifact's version.
     pub version: String,
+
+    /// The kind of update artifact this is.
     pub kind: UpdateArtifactKind,
 }
 
@@ -93,6 +109,9 @@ pub struct UpdateArtifact {
     Debug,
     PartialEq,
     Eq,
+    Hash,
+    Ord,
+    PartialOrd,
     Display,
     Deserialize,
     Serialize,

common/src/update.rs

@@ -14,7 +14,7 @@ pub struct ArtifactsDocument {
 
 /// Describes an artifact available in the repository.
 ///
-/// See also [`crate::api::internal::nexus::UpdateArtifact`], which is used
+/// See also [`crate::api::internal::nexus::UpdateArtifactId`], which is used
 /// internally between Nexus and Sled Agent.
 #[derive(Debug, Clone, PartialEq, Eq, Deserialize, Serialize)]
 pub struct Artifact {

nexus/src/app/update.rs

@@ -17,7 +17,7 @@ use omicron_common::api::external::{
     self, CreateResult, DataPageParams, Error, ListResultVec, LookupResult,
     PaginationOrder, UpdateResult,
 };
-use omicron_common::api::internal::nexus::UpdateArtifact;
+use omicron_common::api::internal::nexus::UpdateArtifactId;
 use rand::Rng;
 use ring::digest;
 use std::convert::TryFrom;
@@ -119,7 +119,7 @@ impl super::Nexus {
                 );
                 client
                     .update_artifact(
-                        &sled_agent_client::types::UpdateArtifact {
+                        &sled_agent_client::types::UpdateArtifactId {
                             name: artifact.name.clone(),
                             version: artifact.version.clone(),
                             kind: artifact.kind.0.into(),
@@ -136,7 +136,7 @@ impl super::Nexus {
     pub async fn download_artifact(
         &self,
         opctx: &OpContext,
-        artifact: UpdateArtifact,
+        artifact: UpdateArtifactId,
     ) -> Result<Vec<u8>, Error> {
         let mut base_url =
             self.tuf_base_url(opctx).await?.ok_or_else(|| {

nexus/src/internal_api/http_entrypoints.rs

@@ -25,7 +25,7 @@ use hyper::Body;
 use omicron_common::api::internal::nexus::DiskRuntimeState;
 use omicron_common::api::internal::nexus::InstanceRuntimeState;
 use omicron_common::api::internal::nexus::ProducerEndpoint;
-use omicron_common::api::internal::nexus::UpdateArtifact;
+use omicron_common::api::internal::nexus::UpdateArtifactId;
 use oximeter::types::ProducerResults;
 use oximeter_producer::{collect, ProducerIdPathParams};
 use schemars::JsonSchema;
@@ -368,7 +368,7 @@ async fn cpapi_metrics_collect(
 }]
 async fn cpapi_artifact_download(
     request_context: RequestContext<Arc<ServerContext>>,
-    path_params: Path<UpdateArtifact>,
+    path_params: Path<UpdateArtifactId>,
 ) -> Result<HttpResponseOk<FreeformBody>, HttpError> {
     let context = request_context.context();
     let nexus = &context.nexus;

openapi/nexus-internal.json

@@ -18,6 +18,7 @@
           {
             "in": "path",
             "name": "kind",
+            "description": "The kind of update artifact this is.",
             "required": true,
             "schema": {
               "$ref": "#/components/schemas/UpdateArtifactKind"
@@ -26,6 +27,7 @@
           {
             "in": "path",
             "name": "name",
+            "description": "The artifact's name.",
             "required": true,
             "schema": {
               "type": "string"
@@ -34,6 +36,7 @@
           {
             "in": "path",
             "name": "version",
+            "description": "The artifact's version.",
             "required": true,
             "schema": {
               "type": "string"

openapi/sled-agent.json

@@ -325,7 +325,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/UpdateArtifact"
+                "$ref": "#/components/schemas/UpdateArtifactId"
               }
             }
           },
@@ -1595,17 +1595,24 @@
           "last_port"
         ]
       },
-      "UpdateArtifact": {
-        "description": "Description of a single update artifact.",
+      "UpdateArtifactId": {
+        "description": "An identifier for a single update artifact.",
         "type": "object",
         "properties": {
           "kind": {
-            "$ref": "#/components/schemas/UpdateArtifactKind"
+            "description": "The kind of update artifact this is.",
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/UpdateArtifactKind"
+              }
+            ]
           },
           "name": {
+            "description": "The artifact's name.",
             "type": "string"
           },
           "version": {
+            "description": "The artifact's version.",
             "type": "string"
           }
         },

sled-agent-client/src/lib.rs

@@ -287,11 +287,11 @@ impl From<omicron_common::api::external::L4PortRange> for types::L4PortRange {
     }
 }
 
-impl From<omicron_common::api::internal::nexus::UpdateArtifact>
-    for types::UpdateArtifact
+impl From<omicron_common::api::internal::nexus::UpdateArtifactId>
+    for types::UpdateArtifactId
 {
-    fn from(s: omicron_common::api::internal::nexus::UpdateArtifact) -> Self {
-        types::UpdateArtifact {
+    fn from(s: omicron_common::api::internal::nexus::UpdateArtifactId) -> Self {
+        types::UpdateArtifactId {
             name: s.name,
             version: s.version,
             kind: s.kind.into(),

sled-agent/src/http_entrypoints.rs

@@ -17,7 +17,7 @@ use dropshot::{
 use omicron_common::api::external::Error;
 use omicron_common::api::internal::nexus::DiskRuntimeState;
 use omicron_common::api::internal::nexus::InstanceRuntimeState;
-use omicron_common::api::internal::nexus::UpdateArtifact;
+use omicron_common::api::internal::nexus::UpdateArtifactId;
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 use uuid::Uuid;
@@ -162,7 +162,7 @@ async fn disk_put(
 }]
 async fn update_artifact(
     rqctx: RequestContext<SledAgent>,
-    artifact: TypedBody<UpdateArtifact>,
+    artifact: TypedBody<UpdateArtifactId>,
 ) -> Result<HttpResponseUpdatedNoContent, HttpError> {
     let sa = rqctx.context();
     sa.update_artifact(artifact.into_inner()).await.map_err(Error::from)?;

sled-agent/src/sim/http_entrypoints.rs

@@ -20,7 +20,7 @@ use dropshot::RequestContext;
 use dropshot::TypedBody;
 use omicron_common::api::internal::nexus::DiskRuntimeState;
 use omicron_common::api::internal::nexus::InstanceRuntimeState;
-use omicron_common::api::internal::nexus::UpdateArtifact;
+use omicron_common::api::internal::nexus::UpdateArtifactId;
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 use std::sync::Arc;
@@ -141,7 +141,7 @@ async fn disk_poke_post(
 }]
 async fn update_artifact(
     rqctx: RequestContext<Arc<SledAgent>>,
-    artifact: TypedBody<UpdateArtifact>,
+    artifact: TypedBody<UpdateArtifactId>,
 ) -> Result<HttpResponseUpdatedNoContent, HttpError> {
     crate::updates::download_artifact(
         artifact.into_inner(),

sled-agent/src/sled_agent.rs

@@ -29,7 +29,7 @@ use omicron_common::address::{
 };
 use omicron_common::api::{
     internal::nexus::DiskRuntimeState, internal::nexus::InstanceRuntimeState,
-    internal::nexus::UpdateArtifact,
+    internal::nexus::UpdateArtifactId,
 };
 use omicron_common::backoff::{
     retry_notify, retry_policy_internal_service_aggressive, BackoffError,
@@ -601,7 +601,7 @@ impl SledAgent {
     /// Downloads and applies an artifact.
     pub async fn update_artifact(
         &self,
-        artifact: UpdateArtifact,
+        artifact: UpdateArtifactId,
     ) -> Result<(), Error> {
         let nexus_client = self.inner.lazy_nexus_client.get().await?;
         crate::updates::download_artifact(artifact, &nexus_client).await?;