Remove ref attribute for SimpleObject fields, and add owned attribute.

Author: sunli829

async-graphql-derive/src/args.rs

@@ -202,7 +202,7 @@ pub struct Field {
     pub external: bool,
     pub provides: Option<String>,
     pub requires: Option<String>,
-    pub is_ref: bool,
+    pub owned: bool,
     pub guard: Option<TokenStream>,
     pub post_guard: Option<TokenStream>,
     pub features: Vec<String>,
@@ -218,7 +218,7 @@ impl Field {
         let mut provides = None;
         let mut requires = None;
         let mut features = Vec::new();
-        let mut is_ref = false;
+        let mut owned = false;
         let mut guard = None;
         let mut post_guard = None;
 
@@ -235,8 +235,14 @@ impl Field {
                             NestedMeta::Meta(Meta::Path(p)) if p.is_ident("external") => {
                                 external = true;
                             }
+                            NestedMeta::Meta(Meta::Path(p)) if p.is_ident("owned") => {
+                                owned = true;
+                            }
                             NestedMeta::Meta(Meta::Path(p)) if p.is_ident("ref") => {
-                                is_ref = true;
+                                return Err(Error::new_spanned(
+                                    &p,
+                                    "Attribute `ref` is no longer supported. By default, all fields resolver return borrowed value. If you want to return ownership value, use `owned` attribute.",
+                                ));
                             }
                             NestedMeta::Meta(Meta::NameValue(nv)) => {
                                 if nv.path.is_ident("name") {
@@ -325,7 +331,7 @@ impl Field {
             external,
             provides,
             requires,
-            is_ref,
+            owned,
             guard,
             post_guard,
             features,

async-graphql-derive/src/simple_object.rs

@@ -99,7 +99,7 @@ pub fn generate(object_args: &args::Object, input: &DeriveInput) -> Result<Token
                     .map(|guard| quote! { #guard.check(ctx, &res).await.map_err(|err| err.into_error_with_path(ctx.position(), ctx.path_node.as_ref().unwrap().to_json()))?; });
 
                 let features = &field.features;
-                getters.push(if field.is_ref {
+                getters.push(if !field.owned {
                     let block = feature_block(
                         &crate_name,
                         &features,

src/context.rs

@@ -609,7 +609,6 @@ impl<'a> ContextBase<'a, &'a Positioned<Field>> {
     /// struct MyObj {
     ///     a: i32,
     ///     b: i32,
-    ///     #[field(ref)]
     ///     detail: Detail,
     /// }
     ///

src/lib.rs

@@ -310,6 +310,7 @@ pub use async_graphql_derive::Object;
 /// | name          | Field name                | string   | Y        |
 /// | desc          | Field description         | string   | Y        |
 /// | deprecation   | Field deprecation reason  | string   | Y        |
+/// | owned         | Field resolver return a ownedship value  | bool   | Y        |
 /// | cache_control | Field cache control       | [`CacheControl`](struct.CacheControl.html) | Y        |
 /// | external      | Mark a field as owned by another service. This allows service A to use fields from service B while also knowing at runtime the types of that field. | bool | Y |
 /// | provides      | Annotate the expected returned fieldset from a field on a base type that is guaranteed to be selectable by the gateway. | string | Y |
@@ -398,7 +399,6 @@ pub use async_graphql_derive::GQLSimpleObject;
 /// | name        | Item name                 | string   | Y        |
 /// | desc        | Item description          | string   | Y        |
 /// | deprecation | Item deprecation reason   | string   | Y        |
-/// | ref         | The resolver function returns a borrowing value  | bool   | Y        |
 ///
 /// # Examples
 ///

src/look_ahead.rs

@@ -72,7 +72,6 @@ mod tests {
         struct MyObj {
             a: i32,
             b: i32,
-            #[field(ref)]
             detail: Detail,
         }
 

tests/interface.rs

@@ -8,7 +8,7 @@ pub async fn test_interface_simple_object() {
         title: String,
     }
 
-    #[async_graphql::Interface(field(name = "id", type = "i32"))]
+    #[async_graphql::Interface(field(name = "id", type = "&i32"))]
     enum Node {
         MyObj(MyObj),
     }
@@ -48,7 +48,6 @@ pub async fn test_interface_simple_object() {
 pub async fn test_interface_simple_object2() {
     #[async_graphql::SimpleObject]
     struct MyObj {
-        #[field(ref)]
         id: i32,
         title: String,
     }

tests/post_guard.rs

@@ -24,7 +24,7 @@ impl PostGuard<i32> for RoleGuard {
 
 #[SimpleObject]
 struct MyObj {
-    #[field(post_guard(UserGuard(username = r#""test""#, value = "88")))]
+    #[field(owned, post_guard(UserGuard(username = r#""test""#, value = "88")))]
     value: i32,
 }
 

tests/subscription.rs

@@ -324,7 +324,7 @@ pub async fn test_subscription_fragment() {
         b: i32,
     }
 
-    #[Interface(field(name = "a", type = "i32"))]
+    #[Interface(field(name = "a", type = "&i32"))]
     enum MyInterface {
         Event(Event),
     }
@@ -381,7 +381,7 @@ pub async fn test_subscription_fragment2() {
         b: i32,
     }
 
-    #[Interface(field(name = "a", type = "i32"))]
+    #[Interface(field(name = "a", type = "&i32"))]
     enum MyInterface {
         Event(Event),
     }

tests/union.rs

@@ -48,7 +48,6 @@ pub async fn test_union_simple_object() {
 pub async fn test_union_simple_object2() {
     #[async_graphql::SimpleObject]
     struct MyObj {
-        #[field(ref)]
         id: i32,
         title: String,
     }