Skip to content

RFD-322 PoC Revision 2 #1995

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 30, 2022
Merged

RFD-322 PoC Revision 2 #1995

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
021b4df
Revise 322 PoC to have fewer query params
just-be-dev Nov 30, 2022
613275e
Ensure list requires project
just-be-dev Nov 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion common/src/api/external/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ impl Name {
}
}

#[derive(Serialize, Deserialize, Display)]
#[derive(Serialize, Deserialize, Display, Clone)]
#[display("{0}")]
#[serde(untagged)]
pub enum NameOrId {
Expand Down
11 changes: 0 additions & 11 deletions nexus/db-model/src/name.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,14 +63,3 @@ where
String::from_sql(bytes)?.parse().map(Name).map_err(|e| e.into())
}
}

/// Newtype wrapper around [external::NameOrId]. This type isn't actually
/// stored in the database, but exists as a convenience for the API.
#[derive(JsonSchema, Serialize, Deserialize, RefCast, Display)]
#[serde(transparent)]
#[repr(transparent)]
#[display("{0}")]
pub struct NameOrId(pub external::NameOrId);

NewtypeFrom! { () pub struct NameOrId(external::NameOrId); }
NewtypeDeref! { () pub struct NameOrId(external::NameOrId); }
45 changes: 25 additions & 20 deletions nexus/src/app/instance.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ use omicron_common::api::external::InstanceState;
use omicron_common::api::external::InternalContext;
use omicron_common::api::external::ListResultVec;
use omicron_common::api::external::LookupResult;
use omicron_common::api::external::NameOrId;
use omicron_common::api::external::UpdateResult;
use omicron_common::api::external::Vni;
use omicron_common::api::internal::nexus;
Expand Down Expand Up @@ -59,13 +60,16 @@ impl super::Nexus {
instance_selector: params::InstanceSelector,
) -> LookupResult<Uuid> {
match instance_selector {
params::InstanceSelector::InstanceId { instance_id } => {
Ok(instance_id)
params::InstanceSelector { instance: NameOrId::Id(id), .. } => {
// TODO: 400 if project or organization are present
Ok(id)
}
params::InstanceSelector::InstanceAndProjectId {
instance_name,
project_id,
params::InstanceSelector {
instance: NameOrId::Name(instance_name),
project: Some(NameOrId::Id(project_id)),
..
} => {
// TODO: 400 if organization is present
let (.., authz_instance) =
LookupPath::new(opctx, &self.db_datastore)
.project_id(project_id)
Expand All @@ -74,10 +78,10 @@ impl super::Nexus {
.await?;
Ok(authz_instance.id())
}
params::InstanceSelector::InstanceProjectAndOrgId {
instance_name,
project_name,
organization_id,
params::InstanceSelector {
instance: NameOrId::Name(instance_name),
project: Some(NameOrId::Name(project_name)),
organization: Some(NameOrId::Id(organization_id)),
Copy link
Contributor

@david-crespo david-crespo Nov 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see, tbe optional parent identifiers aren’t a problem because you were already doing this whole pattern match on the valid combinations anyway. So encoding them into the type was redundant and way harder for spec generation.

} => {
let (.., authz_instance) =
LookupPath::new(opctx, &self.db_datastore)
Expand All @@ -88,10 +92,10 @@ impl super::Nexus {
.await?;
Ok(authz_instance.id())
}
params::InstanceSelector::InstanceProjectAndOrg {
instance_name,
project_name,
organization_name,
params::InstanceSelector {
instance: NameOrId::Name(instance_name),
project: Some(NameOrId::Name(project_name)),
organization: Some(NameOrId::Name(organization_name)),
} => {
let (.., authz_instance) =
LookupPath::new(opctx, &self.db_datastore)
Expand All @@ -102,14 +106,15 @@ impl super::Nexus {
.await?;
Ok(authz_instance.id())
}
params::InstanceSelector::None {} => Err(Error::InvalidRequest {
// TODO: Add a better error message
_ => Err(Error::InvalidRequest {
message: "
Unable to resolve instance. Expected one of
- instance_id
- instance_name, project_id
- instance_name, project_name, organization_id
- instance_name, project_name, organization_name
"
Unable to resolve instance. Expected one of
- instance: Uuid
- instance: Name, project: Uuid
- instance: Name, project: Name, organization: Uuid
- instance: Name, project: Name, organization: Name
"
.to_string(),
}),
}
Expand Down
26 changes: 15 additions & 11 deletions nexus/src/app/project.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ use omicron_common::api::external::Error;
use omicron_common::api::external::IdentityMetadataCreateParams;
use omicron_common::api::external::ListResultVec;
use omicron_common::api::external::LookupResult;
use omicron_common::api::external::NameOrId;
use omicron_common::api::external::UpdateResult;
use uuid::Uuid;

Expand All @@ -30,10 +31,13 @@ impl super::Nexus {
project_selector: params::ProjectSelector,
) -> LookupResult<Uuid> {
match project_selector {
params::ProjectSelector::ProjectId { project_id } => Ok(project_id),
params::ProjectSelector::ProjectAndOrgId {
project_name,
organization_id,
params::ProjectSelector { project: NameOrId::Id(id), .. } => {
// TODO: 400 if organization is present
Ok(id)
}
params::ProjectSelector {
project: NameOrId::Name(project_name),
organization: Some(NameOrId::Id(organization_id)),
} => {
let (.., authz_project) =
LookupPath::new(opctx, &self.db_datastore)
Expand All @@ -43,9 +47,9 @@ impl super::Nexus {
.await?;
Ok(authz_project.id())
}
params::ProjectSelector::ProjectAndOrg {
project_name,
organization_name,
params::ProjectSelector {
project: NameOrId::Name(project_name),
organization: Some(NameOrId::Name(organization_name)),
} => {
let (.., authz_project) =
LookupPath::new(opctx, &self.db_datastore)
Expand All @@ -55,12 +59,12 @@ impl super::Nexus {
.await?;
Ok(authz_project.id())
}
params::ProjectSelector::None {} => Err(Error::InvalidRequest {
_ => Err(Error::InvalidRequest {
message: "
Unable to resolve project. Expected one of
- project_id
- project_name, organization_id
- project_name, organization_name
- project: Uuid
- project: Name, organization: Uuid
- project: Name, organization: Name
"
.to_string(),
}),
Expand Down
Loading