Skip to content

lookup macro could be simpler #1547

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 1 commit into from
Aug 5, 2022
Merged

lookup macro could be simpler #1547

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
48 changes: 14 additions & 34 deletions nexus/db-macros/src/lookup.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,6 @@ pub struct Config {
/// This resource is nested under the Silo hierarchy
siloed: bool,

/// Name of the enum describing how we're looking up this resource
lookup_enum: syn::Ident,

// The path to the resource
/// list of type names for this resource and its parents
/// (e.g., [`Organization`, `Project`])
Expand Down Expand Up @@ -102,7 +99,6 @@ pub struct Config {
impl Config {
fn for_input(input: Input) -> Config {
let resource = Resource::for_name(&input.name);
let lookup_enum = format_ident!("{}Key", resource.name);

let mut path_types: Vec<_> =
input.ancestors.iter().map(|a| format_ident!("{}", a)).collect();
Expand All @@ -124,7 +120,6 @@ impl Config {
Config {
resource,
siloed,
lookup_enum,
path_types,
path_authz_names,
parent,
Expand Down Expand Up @@ -203,7 +198,6 @@ fn generate_struct(config: &Config) -> TokenStream {
config.primary_key_columns.iter().map(|c| c.rust_type.deref());

/* configure the lookup enum */
let lookup_enum = &config.lookup_enum;
let name_variant = if config.lookup_by_name {
let root_sym = format_ident!("Root");
let parent_resource_name = config
Expand All @@ -222,12 +216,7 @@ fn generate_struct(config: &Config) -> TokenStream {

quote! {
#[doc = #doc_struct]
pub struct #resource_name<'a> {
key: #lookup_enum<'a>
}

/// Describes how we're looking up this resource
enum #lookup_enum<'a>{
pub enum #resource_name<'a>{
/// An error occurred while selecting the resource
///
/// This error will be returned by any lookup/fetch attempts.
Expand All @@ -251,11 +240,6 @@ fn generate_struct(config: &Config) -> TokenStream {
fn generate_child_selectors(config: &Config) -> TokenStream {
let child_resource_types: Vec<_> =
config.child_resources.iter().map(|c| format_ident!("{}", c)).collect();
let child_resource_key_types: Vec<_> = config
.child_resources
.iter()
.map(|c| format_ident!("{}Key", c))
.collect();
let child_selector_fn_names: Vec<_> = config
.child_resources
.iter()
Expand Down Expand Up @@ -284,9 +268,7 @@ fn generate_child_selectors(config: &Config) -> TokenStream {
'a: 'c,
'b: 'c,
{
#child_resource_types {
key: #child_resource_key_types::Name(self, name),
}
#child_resource_types::Name(self, name)
}
)*
}
Expand All @@ -299,10 +281,9 @@ fn generate_misc_helpers(config: &Config) -> TokenStream {
let resource_name_str = resource_name.to_string();
let parent_resource_name =
config.parent.as_ref().map(|p| &p.name).unwrap_or(&fleet_name);
let lookup_enum = &config.lookup_enum;

let name_variant = if config.lookup_by_name {
quote! { #lookup_enum::Name(parent, _) => parent.lookup_root(), }
quote! { #resource_name::Name(parent, _) => parent.lookup_root(), }
} else {
quote! {}
};
Expand Down Expand Up @@ -405,12 +386,12 @@ fn generate_misc_helpers(config: &Config) -> TokenStream {
/// point, we need the `OpContext` and `DataStore` that are being
/// used for this lookup.
fn lookup_root(&self) -> &LookupPath<'a> {
match &self.key {
#lookup_enum::Error(root, ..) => root.lookup_root(),
match &self {
#resource_name::Error(root, ..) => root.lookup_root(),

#name_variant

#lookup_enum::PrimaryKey(root, ..) => root.lookup_root(),
#resource_name::PrimaryKey(root, ..) => root.lookup_root(),
}
}

Expand All @@ -425,7 +406,6 @@ fn generate_lookup_methods(config: &Config) -> TokenStream {
let path_authz_names = &config.path_authz_names;
let resource_name = &config.resource.name;
let resource_authz_name = &config.resource.authz_name;
let lookup_enum = &config.lookup_enum;
let pkey_names: Vec<_> = config
.primary_key_columns
.iter()
Expand All @@ -450,7 +430,7 @@ fn generate_lookup_methods(config: &Config) -> TokenStream {
// Generate the by-name branch of the match arm in "fetch_for()"
let fetch_for_name_variant = if config.lookup_by_name {
quote! {
#lookup_enum::Name(parent, name) => {
#resource_name::Name(parent, name) => {
#ancestors_authz_names_assign
let (#resource_authz_name, db_row) = Self::fetch_by_name_for(
opctx,
Expand All @@ -469,7 +449,7 @@ fn generate_lookup_methods(config: &Config) -> TokenStream {
// Generate the by-name branch of the match arm in "lookup()"
let lookup_name_variant = if config.lookup_by_name {
quote! {
#lookup_enum::Name(parent, name) => {
#resource_name::Name(parent, name) => {
// When doing a by-name lookup, we have to look up the
// parent first. Since this is recursive, we wind up
// hitting the database once for each item in the path,
Expand Down Expand Up @@ -561,12 +541,12 @@ fn generate_lookup_methods(config: &Config) -> TokenStream {
let opctx = &lookup.opctx;
let datastore = &lookup.datastore;

match &self.key {
#lookup_enum::Error(_, error) => Err(error.clone()),
match &self {
#resource_name::Error(_, error) => Err(error.clone()),

#fetch_for_name_variant

#lookup_enum::PrimaryKey(_, #(#pkey_names,)*) => {
#resource_name::PrimaryKey(_, #(#pkey_names,)*) => {
Self::fetch_by_id_for(
opctx,
datastore,
Expand Down Expand Up @@ -652,12 +632,12 @@ fn generate_lookup_methods(config: &Config) -> TokenStream {
let opctx = &lookup.opctx;
let datastore = &lookup.datastore;

match &self.key {
#lookup_enum::Error(_, error) => Err(error.clone()),
match &self {
#resource_name::Error(_, error) => Err(error.clone()),

#lookup_name_variant

#lookup_enum::PrimaryKey(_, #(#pkey_names,)*) => {
#resource_name::PrimaryKey(_, #(#pkey_names,)*) => {
// When doing a by-id lookup, we start directly with the
// resource we're looking up. But we still want to
// return a full path of authz objects. So we look up
Expand Down
Loading