async-graphql 7.2.1

A GraphQL server library implemented in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

#![allow(clippy::diverging_sub_expression)]

use async_graphql::*;

#[tokio::test]
pub async fn test_use_type_description() {
    /// Haha
    #[doc = "next line"]
    #[derive(Description, Default)]
    struct MyObj;

    #[Object(use_type_description)]
    impl MyObj {
        async fn value(&self) -> i32 {
            100
        }
    }

    #[derive(SimpleObject, Default)]
    struct Query {
        obj: MyObj,
    }

    let schema = Schema::new(Query::default(), EmptyMutation, EmptySubscription);
    assert_eq!(
        schema
            .execute(r#"{ __type(name: "MyObj") { description } }"#)
            .await
            .data,
        value!({
            "__type": { "description": "Haha\nnext line" }
        })
    );
}

#[tokio::test]
pub async fn test_use_type_external() {
    /// Wow
    #[doc = include_str!("external_descriptions/desc1.md")]
    /// More
    #[derive(Description, Default)]
    struct MyObj<'a>(&'a str);

    #[Object(use_type_description)]
    impl MyObj<'_> {
        async fn value(&self) -> &str {
            self.0
        }
    }

    struct Query;

    #[Object]
    #[allow(unreachable_code)]
    impl Query {
        async fn obj(&self) -> MyObj<'_> {
            todo!()
        }
    }

    let schema = Schema::new(Query, EmptyMutation, EmptySubscription);
    assert_eq!(
        schema
            .execute(r#"{ __type(name: "MyObj") { description } }"#)
            .await
            .data,
        value!({
            "__type": { "description": "Wow\nextern 1\n\nextern 2\nMore" }
        })
    );
}

#[tokio::test]
pub async fn test_use_type_external_macro() {
    macro_rules! external_doc {
        ($ident:ident) => {
            include_str!(concat!("external_descriptions/", stringify!($ident), ".md"))
        };
    }

    /// Wow
    // Simple declarative macros also work
    #[doc = external_doc!(desc1)]
    /// More
    #[derive(Description, Default)]
    struct MyObj<'a>(&'a str);

    #[Object(use_type_description)]
    impl MyObj<'_> {
        async fn value(&self) -> &str {
            self.0
        }
    }

    struct Query;

    #[Object]
    #[allow(unreachable_code)]
    impl Query {
        async fn obj(&self) -> MyObj<'_> {
            todo!()
        }
    }

    let schema = Schema::new(Query, EmptyMutation, EmptySubscription);
    assert_eq!(
        schema
            .execute(r#"{ __type(name: "MyObj") { description } }"#)
            .await
            .data,
        value!({
            "__type": { "description": "Wow\nextern 1\n\nextern 2\nMore" }
        })
    );
}

#[tokio::test]
pub async fn test_fields() {
    #[derive(SimpleObject, Default)]
    #[graphql(complex)]
    struct Obj {
        #[doc = include_str!("external_descriptions/desc1.md")]
        obj: String,
    }

    #[ComplexObject]
    impl Obj {
        #[doc = "line 1"]
        #[doc = ""]
        ///
        #[doc = "line 2"]
        ///
        #[doc = include_str!("external_descriptions/desc2.md")]
        // Make sure trailing whitespace is removed
        ///
        #[doc = ""]
        async fn obj2(&self) -> i32 {
            0
        }
    }

    let schema = Schema::new(Obj::default(), EmptyMutation, EmptySubscription);
    assert_eq!(
        schema
            .execute(r#"{ __type(name: "Obj") { fields { name, description } } }"#)
            .await
            .data,
        value!({
            "__type": {
                "fields": [
                    {"name": "obj", "description": "extern 1\n\nextern 2"},
                    {"name": "obj2", "description": "line 1\n\n\nline 2\n\nexternal"}
                ]
            }
        })
    );
}