Structure for moving views and params structs out of common (#374)

* Revert "Relocate 'api_identity' derive macro - it's a helper for omicron-common (#288)"

This reverts commit ec737d3.

* create external_api and internal_api modules, put entrypoints inside

* pull project and org views and params out of common

* do an example of internal params

* update openapi spec fixture

* comment symmetry on params files

* update comment

* address comments

Author: david-crespo

Cargo.lock

@@ -43,8 +43,8 @@ fn do_object_identity(item: TokenStream) -> Result<TokenStream, syn::Error> {
     };
 
     let stream = quote! {
-        impl crate::api::external::ObjectIdentity for #name {
-            fn identity(&self) -> &crate::api::external::IdentityMetadata {
+        impl ObjectIdentity for #name {
+            fn identity(&self) -> &IdentityMetadata {
                 &self.identity
             }
         }
@@ -68,8 +68,8 @@ mod test {
         );
 
         let expected = quote! {
-            impl crate::api::external::ObjectIdentity for Foo {
-                fn identity(&self) -> &crate::api::external::IdentityMetadata {
+            impl ObjectIdentity for Foo {
+                fn identity(&self) -> &IdentityMetadata {
                     &self.identity
                 }
             }

common/src/api/external/api_identity/.gitignore renamed to api_identity/.gitignore

@@ -28,7 +28,7 @@ progenitor = { git = "https://github.com/oxidecomputer/progenitor" }
 percent-encoding = "2.1.0"
 
 [dependencies.api_identity]
-path = "src/api/external/api_identity"
+path = "../api_identity"
 
 [dependencies.backoff]
 version = "0.3.0"

common/src/api/external/api_identity/Cargo.toml renamed to api_identity/Cargo.toml

@@ -558,79 +558,6 @@ pub struct IdentityMetadataUpdateParams {
  * Specific API resources
  */
 
-/*
- * ORGANIZATIONS
- */
-
-/**
- * Client view of an [`Organization`]
- */
-#[derive(ObjectIdentity, Clone, Debug, Deserialize, Serialize, JsonSchema)]
-#[serde(rename_all = "camelCase")]
-pub struct Organization {
-    #[serde(flatten)]
-    pub identity: IdentityMetadata,
-}
-
-/**
- * Create-time parameters for an [`Organization`]
- */
-#[derive(Clone, Debug, Deserialize, Serialize, JsonSchema)]
-#[serde(rename_all = "camelCase")]
-pub struct OrganizationCreateParams {
-    #[serde(flatten)]
-    pub identity: IdentityMetadataCreateParams,
-}
-
-/**
- * Updateable properties of an [`Organization`]
- */
-#[derive(Clone, Debug, Deserialize, Serialize, JsonSchema)]
-#[serde(rename_all = "camelCase")]
-pub struct OrganizationUpdateParams {
-    #[serde(flatten)]
-    pub identity: IdentityMetadataUpdateParams,
-}
-
-/*
- * PROJECTS
- */
-
-/**
- * Client view of an [`Project`]
- */
-#[derive(ObjectIdentity, Clone, Debug, Deserialize, Serialize, JsonSchema)]
-#[serde(rename_all = "camelCase")]
-pub struct Project {
-    /*
-     * TODO-correctness is flattening here (and in all the other types) the
-     * intent in RFD 4?
-     */
-    #[serde(flatten)]
-    pub identity: IdentityMetadata,
-    pub organization_id: Uuid,
-}
-
-/**
- * Create-time parameters for an [`Project`]
- */
-#[derive(Clone, Debug, Deserialize, Serialize, JsonSchema)]
-#[serde(rename_all = "camelCase")]
-pub struct ProjectCreateParams {
-    #[serde(flatten)]
-    pub identity: IdentityMetadataCreateParams,
-}
-
-/**
- * Updateable properties of an [`Project`]
- */
-#[derive(Clone, Debug, Deserialize, Serialize, JsonSchema)]
-#[serde(rename_all = "camelCase")]
-pub struct ProjectUpdateParams {
-    #[serde(flatten)]
-    pub identity: IdentityMetadataUpdateParams,
-}
-
 /*
  * INSTANCES
  */

common/src/api/external/api_identity/src/lib.rs renamed to api_identity/src/lib.rs

@@ -45,13 +45,6 @@ pub struct InstanceRuntimeState {
     pub time_updated: DateTime<Utc>,
 }
 
-/// Sent by a sled agent on startup to Nexus to request further instruction
-#[derive(Serialize, Deserialize, JsonSchema)]
-pub struct SledAgentStartupInfo {
-    /// the address of the sled agent's API endpoint
-    pub sa_address: SocketAddr,
-}
-
 // Oximeter producer/collector objects.
 
 /// Information announced by a metric server, used so that clients can contact it and collect
@@ -72,13 +65,3 @@ impl ProducerEndpoint {
         format!("{}/{}", &self.base_route, &self.id)
     }
 }
-
-/// Message used to notify Nexus that this oximeter instance is up and running.
-#[derive(Debug, Clone, Copy, JsonSchema, Serialize, Deserialize)]
-pub struct OximeterInfo {
-    /// The ID for this oximeter instance.
-    pub collector_id: Uuid,
-
-    /// The address on which this oximeter instance listens for requests
-    pub address: SocketAddr,
-}

common/Cargo.toml

@@ -37,6 +37,9 @@ structopt = "0.3"
 thiserror = "1.0"
 toml = "0.5.6"
 
+[dependencies.api_identity]
+path = "../api_identity"
+
 [dependencies.chrono]
 version = "0.4"
 features = [ "serde" ]

common/src/api/external/mod.rs

@@ -1737,11 +1737,9 @@ mod test {
     use crate::db::identity::Resource;
     use crate::db::model::{ConsoleSession, Organization, Project};
     use crate::db::DataStore;
+    use crate::external_api::params;
     use chrono::{Duration, Utc};
-    use omicron_common::api::external::{
-        Error, IdentityMetadataCreateParams, OrganizationCreateParams,
-        ProjectCreateParams,
-    };
+    use omicron_common::api::external::{Error, IdentityMetadataCreateParams};
     use omicron_test_utils::dev;
     use std::sync::Arc;
     use uuid::Uuid;
@@ -1755,7 +1753,7 @@ mod test {
         let pool = db::Pool::new(&cfg);
         let datastore = DataStore::new(Arc::new(pool));
 
-        let organization = Organization::new(OrganizationCreateParams {
+        let organization = Organization::new(params::OrganizationCreate {
             identity: IdentityMetadataCreateParams {
                 name: "org".parse().unwrap(),
                 description: "desc".to_string(),
@@ -1766,7 +1764,7 @@ mod test {
 
         let project = Project::new(
             organization.id(),
-            ProjectCreateParams {
+            params::ProjectCreate {
                 identity: IdentityMetadataCreateParams {
                     name: "project".parse().unwrap(),
                     description: "desc".to_string(),

common/src/api/internal/nexus.rs

@@ -7,6 +7,8 @@ use crate::db::schema::{
     organization, oximeter, project, rack, router_route, sled, vpc, vpc_router,
     vpc_subnet,
 };
+use crate::external_api::params;
+use crate::internal_api;
 use chrono::{DateTime, Utc};
 use db_macros::{Asset, Resource};
 use diesel::backend::{Backend, BinaryRawValue, RawValue};
@@ -343,7 +345,7 @@ pub struct Organization {
 
 impl Organization {
     /// Creates a new database Organization object.
-    pub fn new(params: external::OrganizationCreateParams) -> Self {
+    pub fn new(params: params::OrganizationCreate) -> Self {
         let id = Uuid::new_v4();
         Self {
             identity: OrganizationIdentity::new(id, params.identity),
@@ -359,12 +361,6 @@ impl DatastoreCollection<Project> for Organization {
     type CollectionIdColumn = project::dsl::organization_id;
 }
 
-impl Into<external::Organization> for Organization {
-    fn into(self) -> external::Organization {
-        external::Organization { identity: self.identity() }
-    }
-}
-
 /// Describes a set of updates for the [`Organization`] model.
 #[derive(AsChangeset)]
 #[table_name = "organization"]
@@ -374,8 +370,8 @@ pub struct OrganizationUpdate {
     pub time_modified: DateTime<Utc>,
 }
 
-impl From<external::OrganizationUpdateParams> for OrganizationUpdate {
-    fn from(params: external::OrganizationUpdateParams) -> Self {
+impl From<params::OrganizationUpdate> for OrganizationUpdate {
+    fn from(params: params::OrganizationUpdate) -> Self {
         Self {
             name: params.identity.name.map(|n| n.into()),
             description: params.identity.description,
@@ -396,26 +392,14 @@ pub struct Project {
 
 impl Project {
     /// Creates a new database Project object.
-    pub fn new(
-        organization_id: Uuid,
-        params: external::ProjectCreateParams,
-    ) -> Self {
+    pub fn new(organization_id: Uuid, params: params::ProjectCreate) -> Self {
         Self {
             identity: ProjectIdentity::new(Uuid::new_v4(), params.identity),
             organization_id: organization_id,
         }
     }
 }
 
-impl Into<external::Project> for Project {
-    fn into(self) -> external::Project {
-        external::Project {
-            identity: self.identity(),
-            organization_id: self.organization_id,
-        }
-    }
-}
-
 /// Describes a set of updates for the [`Project`] model.
 #[derive(AsChangeset)]
 #[table_name = "project"]
@@ -425,8 +409,8 @@ pub struct ProjectUpdate {
     pub time_modified: DateTime<Utc>,
 }
 
-impl From<external::ProjectUpdateParams> for ProjectUpdate {
-    fn from(params: external::ProjectUpdateParams) -> Self {
+impl From<params::ProjectUpdate> for ProjectUpdate {
+    fn from(params: params::ProjectUpdate) -> Self {
         Self {
             name: params.identity.name.map(Name),
             description: params.identity.description,
@@ -852,7 +836,7 @@ pub struct OximeterInfo {
 }
 
 impl OximeterInfo {
-    pub fn new(info: &internal::nexus::OximeterInfo) -> Self {
+    pub fn new(info: &internal_api::params::OximeterInfo) -> Self {
         let now = Utc::now();
         Self {
             id: info.collector_id,