views and params concept in nexus with Project as demo

Author: david-crespo

Cargo.lock

@@ -514,44 +514,6 @@ pub struct IdentityMetadataUpdateParams {
  * Specific API resources
  */
 
-/*
- * 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,
-}
-
-/**
- * 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
  */

omicron-common/src/api/external/mod.rs

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

omicron-nexus/Cargo.toml

@@ -62,6 +62,7 @@ use super::sql_operations::sql_insert_unique;
 use super::sql_operations::sql_insert_unique_idempotent_and_fetch;
 use super::sql_operations::sql_update_precond;
 use crate::db;
+use crate::params;
 
 pub struct DataStore {
     pool: Arc<Pool>,
@@ -171,7 +172,7 @@ impl DataStore {
     pub async fn project_update(
         &self,
         project_name: &Name,
-        update_params: &api::external::ProjectUpdateParams,
+        update_params: &params::ProjectUpdate,
     ) -> UpdateResult<db::model::Project> {
         let client = self.pool.acquire().await?;
         let now = Utc::now();

omicron-nexus/src/db/datastore.rs

@@ -1,5 +1,7 @@
 //! Structures stored to the database.
 
+use crate::params;
+use crate::views;
 use chrono::{DateTime, Utc};
 use omicron_common::api::external::{
     self, ByteCount, Error, Generation, InstanceCpuCount,
@@ -143,7 +145,7 @@ pub struct Project {
 
 impl Project {
     /// Creates a new database Project object.
-    pub fn new(params: &external::ProjectCreateParams) -> Self {
+    pub fn new(params: &params::ProjectCreate) -> Self {
         let id = Uuid::new_v4();
         Self { identity: IdentityMetadata::new(id, params.identity.clone()) }
     }
@@ -158,15 +160,15 @@ impl Project {
 }
 
 /// Conversion to the internal API type.
-impl Into<external::Project> for Project {
-    fn into(self) -> external::Project {
-        external::Project { identity: self.identity.into() }
+impl Into<views::Project> for Project {
+    fn into(self) -> views::Project {
+        views::Project { identity: self.identity.into() }
     }
 }
 
 /// Conversion from the internal API type.
-impl From<external::Project> for Project {
-    fn from(project: external::Project) -> Self {
+impl From<views::Project> for Project {
+    fn from(project: views::Project) -> Self {
         Self { identity: project.identity.into() }
     }
 }

omicron-nexus/src/db/model.rs

@@ -5,6 +5,8 @@
 use super::ServerContext;
 use crate::db;
 
+use crate::params;
+use crate::views;
 use dropshot::endpoint;
 use dropshot::ApiDescription;
 use dropshot::HttpError;
@@ -38,9 +40,6 @@ use omicron_common::api::external::Instance;
 use omicron_common::api::external::InstanceCreateParams;
 use omicron_common::api::external::Name;
 use omicron_common::api::external::PaginationOrder;
-use omicron_common::api::external::Project;
-use omicron_common::api::external::ProjectCreateParams;
-use omicron_common::api::external::ProjectUpdateParams;
 use omicron_common::api::external::Rack;
 use omicron_common::api::external::Saga;
 use omicron_common::api::external::Sled;
@@ -156,7 +155,7 @@ pub fn external_api() -> NexusApiDescription {
 async fn projects_get(
     rqctx: Arc<RequestContext<Arc<ServerContext>>>,
     query_params: Query<PaginatedByNameOrId>,
-) -> Result<HttpResponseOk<ResultsPage<Project>>, HttpError> {
+) -> Result<HttpResponseOk<ResultsPage<views::Project>>, HttpError> {
     let apictx = rqctx.context();
     let nexus = &apictx.nexus;
     let query = query_params.into_inner();
@@ -176,7 +175,7 @@ async fn projects_get(
     };
 
     let view_list =
-        to_list::<db::model::Project, Project>(project_stream).await;
+        to_list::<db::model::Project, views::Project>(project_stream).await;
     Ok(HttpResponseOk(ScanByNameOrId::results_page(&query, view_list)?))
 }
 
@@ -189,8 +188,8 @@ async fn projects_get(
 }]
 async fn projects_post(
     rqctx: Arc<RequestContext<Arc<ServerContext>>>,
-    new_project: TypedBody<ProjectCreateParams>,
-) -> Result<HttpResponseCreated<Project>, HttpError> {
+    new_project: TypedBody<params::ProjectCreate>,
+) -> Result<HttpResponseCreated<views::Project>, HttpError> {
     let apictx = rqctx.context();
     let nexus = &apictx.nexus;
     let project = nexus.project_create(&new_project.into_inner()).await?;
@@ -216,7 +215,7 @@ struct ProjectPathParam {
 async fn projects_get_project(
     rqctx: Arc<RequestContext<Arc<ServerContext>>>,
     path_params: Path<ProjectPathParam>,
-) -> Result<HttpResponseOk<Project>, HttpError> {
+) -> Result<HttpResponseOk<views::Project>, HttpError> {
     let apictx = rqctx.context();
     let nexus = &apictx.nexus;
     let path = path_params.into_inner();
@@ -260,8 +259,8 @@ async fn projects_delete_project(
 async fn projects_put_project(
     rqctx: Arc<RequestContext<Arc<ServerContext>>>,
     path_params: Path<ProjectPathParam>,
-    updated_project: TypedBody<ProjectUpdateParams>,
-) -> Result<HttpResponseOk<Project>, HttpError> {
+    updated_project: TypedBody<params::ProjectUpdate>,
+) -> Result<HttpResponseOk<views::Project>, HttpError> {
     let apictx = rqctx.context();
     let nexus = &apictx.nexus;
     let path = path_params.into_inner();

omicron-nexus/src/http_entrypoints_external.rs

@@ -18,8 +18,10 @@ pub mod db; // Public only for some documentation examples
 mod http_entrypoints_external;
 mod http_entrypoints_internal;
 mod nexus;
+mod params;
 mod saga_interface;
 mod sagas;
+mod views;
 
 pub use config::Config;
 pub use context::ServerContext;

omicron-nexus/src/lib.rs

@@ -3,6 +3,7 @@
  */
 
 use crate::db;
+use crate::params;
 use crate::saga_interface::SagaContext;
 use crate::sagas;
 use anyhow::Context;
@@ -27,8 +28,6 @@ use omicron_common::api::external::InstanceState;
 use omicron_common::api::external::ListResult;
 use omicron_common::api::external::LookupResult;
 use omicron_common::api::external::Name;
-use omicron_common::api::external::ProjectCreateParams;
-use omicron_common::api::external::ProjectUpdateParams;
 use omicron_common::api::external::ResourceType;
 use omicron_common::api::external::UpdateResult;
 use omicron_common::api::external::Vpc;
@@ -295,7 +294,7 @@ impl Nexus {
 
     pub async fn project_create(
         &self,
-        new_project: &ProjectCreateParams,
+        new_project: &params::ProjectCreate,
     ) -> CreateResult<db::model::Project> {
         // Create a project.
         let db_project = db::model::Project::new(new_project);
@@ -356,7 +355,7 @@ impl Nexus {
     pub async fn project_update(
         &self,
         name: &Name,
-        new_params: &ProjectUpdateParams,
+        new_params: &params::ProjectUpdate,
     ) -> UpdateResult<db::model::Project> {
         self.db_datastore.project_update(name, new_params).await
     }

omicron-nexus/src/nexus.rs

@@ -0,0 +1,25 @@
+use omicron_common::api::external::IdentityMetadataCreateParams;
+use omicron_common::api::external::IdentityMetadataUpdateParams;
+use schemars::JsonSchema;
+use serde::Deserialize;
+use serde::Serialize;
+
+/**
+ * Create-time parameters for an [`Project`]
+ */
+#[derive(Clone, Debug, Deserialize, Serialize, JsonSchema)]
+#[serde(rename_all = "camelCase")]
+pub struct ProjectCreate {
+    #[serde(flatten)]
+    pub identity: IdentityMetadataCreateParams,
+}
+
+/**
+ * Updateable properties of an [`Project`]
+ */
+#[derive(Clone, Debug, Deserialize, Serialize, JsonSchema)]
+#[serde(rename_all = "camelCase")]
+pub struct ProjectUpdate {
+    #[serde(flatten)]
+    pub identity: IdentityMetadataUpdateParams,
+}

omicron-nexus/src/params.rs

@@ -0,0 +1,22 @@
+use api_identity::ObjectIdentity;
+use omicron_common::api::external::IdentityMetadata;
+use omicron_common::api::external::ObjectIdentity;
+use schemars::JsonSchema;
+use serde::Deserialize;
+use serde::Serialize;
+
+/**
+ * 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,
+}
+
+// these aren't actually views, so maybe they don't belong here