Fix compile fail message for mixed #[diesel(embed, serialize_as = _)]

weiznich · pksunkara · commit 45cf4e509383 · 2021-12-10T17:24:03.000Z
diff --git a/diesel_compile_tests/tests/fail/derive/embed_and_serialize_as_cannot_be_mixed.stderr b/diesel_compile_tests/tests/fail/derive/embed_and_serialize_as_cannot_be_mixed.stderr
@@ -1,5 +1,5 @@
 error: `#[diesel(embed)]` cannot be combined with `#[diesel(serialize_as)]`
-  --> $DIR/embed_and_serialize_as_cannot_be_mixed.rs:22:36
+  --> $DIR/embed_and_serialize_as_cannot_be_mixed.rs:22:13
    |
 22 |     #[diesel(embed, serialize_as = SomeType)]
-   |                                    ^^^^^^^^
+   |             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/diesel_derives/src/attrs.rs b/diesel_derives/src/attrs.rs
@@ -2,6 +2,7 @@ use std::fmt::{Display, Formatter};
 
 use proc_macro2::{Span, TokenStream};
 use proc_macro_error::ResultExt;
+use quote::spanned::Spanned;
 use quote::ToTokens;
 use syn::parse::discouraged::Speculative;
 use syn::parse::{Parse, ParseStream, Parser, Result};
@@ -17,6 +18,12 @@ use util::{
     SQL_TYPE_NOTE, TABLE_NAME_NOTE, TREAT_NONE_AS_DEFAULT_VALUE_NOTE, TREAT_NONE_AS_NULL_NOTE,
 };
 
+pub struct AttributeSpanWrapper<T> {
+    pub item: T,
+    pub attribute_span: Span,
+    pub ident_span: Span,
+}
+
 pub enum FieldAttr {
     Embed(Ident),
 
@@ -118,6 +125,18 @@ impl Parse for FieldAttr {
     }
 }
 
+impl Spanned for FieldAttr {
+    fn __span(&self) -> Span {
+        match self {
+            FieldAttr::Embed(ident)
+            | FieldAttr::ColumnName(ident, _)
+            | FieldAttr::SqlType(ident, _)
+            | FieldAttr::SerializeAs(ident, _)
+            | FieldAttr::DeserializeAs(ident, _) => ident.span(),
+        }
+    }
+}
+
 #[allow(clippy::large_enum_variant)]
 pub enum StructAttr {
     Aggregate(Ident),
@@ -203,15 +222,46 @@ impl Parse for StructAttr {
     }
 }
 
-pub fn parse_attributes<T: Parse + ParseDeprecated>(attrs: &[Attribute]) -> Vec<T> {
+impl Spanned for StructAttr {
+    fn __span(&self) -> Span {
+        match self {
+            StructAttr::Aggregate(ident)
+            | StructAttr::NotSized(ident)
+            | StructAttr::ForeignDerive(ident)
+            | StructAttr::TableName(ident, _)
+            | StructAttr::SqlType(ident, _)
+            | StructAttr::TreatNoneAsDefaultValue(ident, _)
+            | StructAttr::TreatNoneAsNull(ident, _)
+            | StructAttr::BelongsTo(ident, _)
+            | StructAttr::MysqlType(ident, _)
+            | StructAttr::SqliteType(ident, _)
+            | StructAttr::PostgresType(ident, _)
+            | StructAttr::PrimaryKey(ident, _) => ident.span(),
+        }
+    }
+}
+
+pub fn parse_attributes<T>(attrs: &[Attribute]) -> Vec<AttributeSpanWrapper<T>>
+where
+    T: Parse + ParseDeprecated + Spanned,
+{
+    use syn::spanned::Spanned;
+
     attrs
         .iter()
         .flat_map(|attr| {
             if attr.path.is_ident("diesel") {
                 attr.parse_args_with(Punctuated::<T, Comma>::parse_terminated)
                     .unwrap_or_abort()
+                    .into_iter()
+                    .map(|a| AttributeSpanWrapper {
+                        ident_span: a.span(),
+                        item: a,
+                        attribute_span: attr.tokens.span(),
+                    })
+                    .collect::<Vec<_>>()
             } else {
-                let mut p = Punctuated::new();
+                let mut p = Vec::new();
                 let Attribute { path, tokens, .. } = attr;
                 let ident = path.get_ident().map(|f| f.to_string());
 
@@ -223,10 +273,13 @@ pub fn parse_attributes<T: Parse + ParseDeprecated>(attrs: &[Attribute]) -> Vec<
                     let value = Parser::parse(T::parse_deprecated, ts).unwrap_or_abort();
 
                     if let Some(value) = value {
-                        p.push_value(value);
+                        p.push(AttributeSpanWrapper {
+                            ident_span: value.span(),
+                            item: value,
+                            attribute_span: attr.tokens.span(),
+                        });
                     }
                 }
-
                 p
             }
         })
diff --git a/diesel_derives/src/field.rs b/diesel_derives/src/field.rs
@@ -3,17 +3,17 @@ use quote::ToTokens;
 use syn::spanned::Spanned;
 use syn::{Field as SynField, Ident, Index, Type};
 
-use attrs::{parse_attributes, FieldAttr, SqlIdentifier};
+use attrs::{parse_attributes, AttributeSpanWrapper, FieldAttr, SqlIdentifier};
 
 pub struct Field {
     pub ty: Type,
     pub span: Span,
     pub name: FieldName,
-    column_name: Option<SqlIdentifier>,
-    pub sql_type: Option<Type>,
-    pub serialize_as: Option<Type>,
-    pub deserialize_as: Option<Type>,
-    pub embed: bool,
+    column_name: Option<AttributeSpanWrapper<SqlIdentifier>>,
+    pub sql_type: Option<AttributeSpanWrapper<Type>>,
+    pub serialize_as: Option<AttributeSpanWrapper<Type>>,
+    pub deserialize_as: Option<AttributeSpanWrapper<Type>>,
+    pub embed: Option<AttributeSpanWrapper<bool>>,
 }
 
 impl Field {
@@ -26,15 +26,47 @@ impl Field {
         let mut sql_type = None;
         let mut serialize_as = None;
         let mut deserialize_as = None;
-        let mut embed = false;
+        let mut embed = None;
 
         for attr in parse_attributes(attrs) {
-            match attr {
-                FieldAttr::ColumnName(_, value) => column_name = Some(value),
-                FieldAttr::SqlType(_, value) => sql_type = Some(Type::Path(value)),
-                FieldAttr::SerializeAs(_, value) => serialize_as = Some(Type::Path(value)),
-                FieldAttr::DeserializeAs(_, value) => deserialize_as = Some(Type::Path(value)),
-                FieldAttr::Embed(_) => embed = true,
+            let attribute_span = attr.attribute_span;
+            let ident_span = attr.ident_span;
+            match attr.item {
+                FieldAttr::ColumnName(_, value) => {
+                    column_name = Some(AttributeSpanWrapper {
+                        item: value,
+                        attribute_span,
+                        ident_span,
+                    })
+                }
+                FieldAttr::SqlType(_, value) => {
+                    sql_type = Some(AttributeSpanWrapper {
+                        item: Type::Path(value),
+                        attribute_span,
+                        ident_span,
+                    })
+                }
+                FieldAttr::SerializeAs(_, value) => {
+                    serialize_as = Some(AttributeSpanWrapper {
+                        item: Type::Path(value),
+                        attribute_span,
+                        ident_span,
+                    })
+                }
+                FieldAttr::DeserializeAs(_, value) => {
+                    deserialize_as = Some(AttributeSpanWrapper {
+                        item: Type::Path(value),
+                        attribute_span,
+                        ident_span,
+                    })
+                }
+                FieldAttr::Embed(_) => {
+                    embed = Some(AttributeSpanWrapper {
+                        item: true,
+                        attribute_span,
+                        ident_span,
+                    })
+                }
             }
         }
 
@@ -61,24 +93,31 @@ impl Field {
     }
 
     pub fn column_name(&self) -> SqlIdentifier {
-        self.column_name.clone().unwrap_or_else(|| match self.name {
-            FieldName::Named(ref x) => x.into(),
-            FieldName::Unnamed(ref x) => {
-                abort!(
+        self.column_name
+            .as_ref()
+            .map(|a| a.item.clone())
+            .unwrap_or_else(|| match self.name {
+                FieldName::Named(ref x) => x.into(),
+                FieldName::Unnamed(ref x) => {
+                    abort!(
                     x,
                     "All fields of tuple structs must be annotated with `#[diesel(column_name)]`"
                 );
-            }
-        })
+                }
+            })
     }
 
     pub fn ty_for_deserialize(&self) -> &Type {
-        if let Some(value) = &self.deserialize_as {
+        if let Some(AttributeSpanWrapper { item: value, .. }) = &self.deserialize_as {
             value
         } else {
             &self.ty
         }
     }
+
+    pub(crate) fn embed(&self) -> bool {
+        self.embed.as_ref().map(|a| a.item).unwrap_or(false)
+    }
 }
 
 pub enum FieldName {
diff --git a/diesel_derives/src/insertable.rs b/diesel_derives/src/insertable.rs
@@ -1,6 +1,7 @@
 use proc_macro2::TokenStream;
 use syn::{DeriveInput, Expr, Path, Type};
 
+use attrs::AttributeSpanWrapper;
 use field::Field;
 use model::Model;
 use util::{inner_of_option_ty, is_option_ty, wrap_in_dummy_mod};
@@ -25,7 +26,7 @@ pub fn derive(item: DeriveInput) -> TokenStream {
     let mut ref_field_assign = Vec::with_capacity(model.fields().len());
 
     for field in model.fields() {
-        match (field.serialize_as.as_ref(), field.embed) {
+        match (field.serialize_as.as_ref(), field.embed()) {
             (None, true) => {
                 direct_field_ty.push(field_ty_embed(field, None));
                 direct_field_assign.push(field_expr_embed(field, None));
@@ -58,7 +59,7 @@ pub fn derive(item: DeriveInput) -> TokenStream {
                     treat_none_as_default_value,
                 ));
             }
-            (Some(ty), false) => {
+            (Some(AttributeSpanWrapper { item: ty, .. }), false) => {
                 direct_field_ty.push(field_ty_serialize_as(
                     field,
                     table_name,
@@ -74,9 +75,9 @@ pub fn derive(item: DeriveInput) -> TokenStream {
 
                 generate_borrowed_insert = false; // as soon as we hit one field with #[diesel(serialize_as)] there is no point in generating the impl of Insertable for borrowed structs
             }
-            (Some(ty), true) => {
+            (Some(AttributeSpanWrapper { attribute_span, .. }), true) => {
                 abort!(
-                    ty,
+                    attribute_span,
                     "`#[diesel(embed)]` cannot be combined with `#[diesel(serialize_as)]`"
                 )
             }
diff --git a/diesel_derives/src/model.rs b/diesel_derives/src/model.rs
@@ -63,7 +63,7 @@ impl Model {
         let mut postgres_type = None;
 
         for attr in parse_attributes(attrs) {
-            match attr {
+            match attr.item {
                 StructAttr::SqlType(_, value) => sql_types.push(Type::Path(value)),
                 StructAttr::TableName(_, value) => table_name = Some(value),
                 StructAttr::PrimaryKey(_, keys) => {
diff --git a/diesel_derives/src/queryable_by_name.rs b/diesel_derives/src/queryable_by_name.rs
@@ -1,6 +1,7 @@
 use proc_macro2::{Span, TokenStream};
 use syn::{DeriveInput, Ident, LitStr, Type};
 
+use attrs::AttributeSpanWrapper;
 use field::{Field, FieldName};
 use model::Model;
 use util::wrap_in_dummy_mod;
@@ -15,7 +16,7 @@ pub fn derive(item: DeriveInput) -> TokenStream {
     let initial_field_expr = model.fields().iter().map(|f| {
         let field_ty = &f.ty;
 
-        if f.embed {
+        if f.embed() {
             quote!(<#field_ty as QueryableByName<__DB>>::build(row)?)
         } else {
             let deserialize_ty = f.ty_for_deserialize();
@@ -39,7 +40,7 @@ pub fn derive(item: DeriveInput) -> TokenStream {
     for field in model.fields() {
         let where_clause = generics.where_clause.get_or_insert(parse_quote!(where));
         let field_ty = field.ty_for_deserialize();
-        if field.embed {
+        if field.embed() {
             where_clause
                 .predicates
                 .push(parse_quote!(#field_ty: QueryableByName<__DB>));
@@ -88,7 +89,7 @@ fn sql_type(field: &Field, model: &Model) -> Type {
     let table_name = model.table_name();
 
     match field.sql_type {
-        Some(ref st) => st.clone(),
+        Some(AttributeSpanWrapper { item: ref st, .. }) => st.clone(),
         None => {
             if model.has_table_name_attribute() {
                 let column_name = field.column_name();
diff --git a/diesel_derives/src/selectable.rs b/diesel_derives/src/selectable.rs
@@ -15,7 +15,7 @@ pub fn derive(item: DeriveInput) -> TokenStream {
         .params
         .push(parse_quote!(__DB: diesel::backend::Backend));
 
-    for embed_field in model.fields().iter().filter(|f| f.embed) {
+    for embed_field in model.fields().iter().filter(|f| f.embed()) {
         let embed_ty = &embed_field.ty;
         generics
             .where_clause
@@ -48,7 +48,7 @@ pub fn derive(item: DeriveInput) -> TokenStream {
 }
 
 fn field_column_ty(field: &Field, model: &Model) -> TokenStream {
-    if field.embed {
+    if field.embed() {
         let embed_ty = &field.ty;
         quote!(<#embed_ty as Selectable<__DB>>::SelectExpression)
     } else {
@@ -59,7 +59,7 @@ fn field_column_ty(field: &Field, model: &Model) -> TokenStream {
 }
 
 fn field_column_inst(field: &Field, model: &Model) -> TokenStream {
-    if field.embed {
+    if field.embed() {
         let embed_ty = &field.ty;
         quote!(<#embed_ty as Selectable<__DB>>::construct_selection())
     } else {

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	error: `#[diesel(embed)]` cannot be combined with `#[diesel(serialize_as)]`
`2`		`- --> $DIR/embed_and_serialize_as_cannot_be_mixed.rs:22:36`
	`2`	`+ --> $DIR/embed_and_serialize_as_cannot_be_mixed.rs:22:13`
`3`	`3`	`\|`
`4`	`4`	`22 \| #[diesel(embed, serialize_as = SomeType)]`
`5`		`- \| ^^^^^^^^`
	`5`	`+ \| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`