Axum integration

Cargo.toml

@@ -14,6 +14,7 @@ members = [
     "juniper_graphql_ws",
     "juniper_warp",
     "juniper_actix",
+    "juniper_axum",
     "tests/codegen",
     "tests/integration",
 ]

juniper/src/http/mod.rs

@@ -400,6 +400,9 @@ pub mod tests {
         println!("  - test_get_with_variables");
         test_get_with_variables(integration);
 
+        println!("  - test_post_with_variables");
+        test_post_with_variables(integration);
+
         println!("  - test_simple_post");
         test_simple_post(integration);
 
@@ -510,6 +513,40 @@ pub mod tests {
         );
     }
 
+    fn test_post_with_variables<T: HttpIntegration>(integration: &T) {
+        let response = integration.post_json(
+            "/",
+            r#"{
+            "query": "query($id: String!) { human(id: $id) { id, name, appearsIn, homePlanet } }",
+            "variables": { "id": "1000" }
+        }"#,
+        );
+
+        assert_eq!(response.status_code, 200);
+        assert_eq!(response.content_type, "application/json");
+
+        assert_eq!(
+            unwrap_json_response(&response),
+            serde_json::from_str::<Json>(
+                r#"{
+                    "data": {
+                        "human": {
+                            "appearsIn": [
+                                "NEW_HOPE",
+                                "EMPIRE",
+                                "JEDI"
+                                ],
+                                "homePlanet": "Tatooine",
+                                "name": "Luke Skywalker",
+                                "id": "1000"
+                            }
+                        }
+                    }"#
+            )
+            .expect("Invalid JSON constant in test")
+        );
+    }
+
     fn test_simple_post<T: HttpIntegration>(integration: &T) {
         let response = integration.post_json("/", r#"{"query": "{hero{name}}"}"#);
 
@@ -690,7 +727,7 @@ pub mod tests {
                 r#"{
                     "type":"connection_error",
                     "payload":{
-                        "message":"serde error: expected value at line 1 column 1"
+                        "message":"expected value at line 1 column 1"
                     }
                 }"#
                 .into(),

juniper_actix/src/lib.rs

@@ -416,7 +416,7 @@ pub mod subscriptions {
     impl fmt::Display for Error {
         fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
             match self {
-                Self::Serde(e) => write!(f, "serde error: {e}"),
+                Self::Serde(e) => write!(f, "{e}"),
                 Self::UnexpectedClientMessage => {
                     write!(f, "unexpected message received from client")
                 }

juniper_axum/CHANGELOG.md

@@ -0,0 +1,26 @@
+`juniper_axum` changelog
+========================
+
+All user visible changes to `juniper_axum` crate will be documented in this file. This project uses [Semantic Versioning 2.0.0].
+
+
+
+
+## master
+
+### BC Breaks
+
+- Switched to 0.16 version of [`juniper` crate].
+
+
+
+
+## Previous releases
+
+See [old CHANGELOG](/../../blob/juniper_warp-v0.0.0/juniper_axum/CHANGELOG.md).
+
+
+
+
+[`juniper` crate]: https://docs.rs/juniper
+[Semantic Versioning 2.0.0]: https://semver.org

juniper_axum/Cargo.toml

@@ -0,0 +1,32 @@
+[package]
+name = "juniper_axum"
+version = "0.1.0"
+edition = "2021"
+rust-version = "1.62"
+description = "`juniper` GraphQL integration with `axum`."
+license = "BSD-2-Clause"
+authors = ["Benno Tielen <[email protected]>"]
+documentation = "https://docs.rs/juniper_axum"
+homepage = "https://github.com/graphql-rust/juniper/tree/master/juniper_axum"
+repository = "https://github.com/graphql-rust/juniper"
+readme = "README.md"
+categories = ["asynchronous", "web-programming", "web-programming::http-server"]
+keywords = ["graphql", "juniper", "axum", "websocket"]
+exclude = ["/release.toml"]
+
+[dependencies]
+axum = { version = "0.5.11", features = ["ws"]}
+juniper = { path = "../juniper" }
+serde = "1.0"
+serde_json = "1.0"
+juniper_graphql_ws = { path="../juniper_graphql_ws" }
+futures = "0.3"
+
+[dev-dependencies]
+tokio = { version = "1.20", features = ["full"] }
+tokio-tungstenite = "0.17.2"
+tokio-stream = "0.1.9"
+tower = "0.4.13"
+hyper = "0.14.20"
+juniper = { path = "../juniper", features = ["expose-test-schema"]}
+anyhow = "1.0"

juniper_axum/LICENCE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2022, Benno Tielen
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

juniper_axum/README.md

@@ -0,0 +1,93 @@
+`juniper_axum` crate
+====================
+
+[![Crates.io](https://img.shields.io/crates/v/juniper_axum.svg?maxAge=2592000)](https://crates.io/crates/juniper_warp)
+[![Documentation](https://docs.rs/juniper_warp/badge.svg)](https://docs.rs/juniper_warp)
+[![CI](https://github.com/graphql-rust/juniper/workflows/CI/badge.svg?branch=master "CI")](https://github.com/graphql-rust/juniper/actions?query=workflow%3ACI+branch%3Amaster)
+
+- [Changelog](https://github.com/graphql-rust/juniper/blob/master/juniper_axum/CHANGELOG.md)
+
+[`axum`] web server integration for [`juniper`] ([GraphQL] implementation for [Rust]).
+
+## Getting started
+
+The best way to get started is to examine the `simple` example in the `examples` directory. To execute
+this example run
+
+`cargo run --example simple`
+
+Open your browser and navigate to `127.0.0.1:3000`. A GraphQL Playground opens. The 
+following commands are available in the playground.
+
+```graphql
+{
+    add(a: 2, b: 40)
+}
+```
+
+```graphql
+subscription {
+    count
+}
+```
+
+## Queries and mutations
+This crate provides an extractor and response for axum to work with juniper.
+
+```rust,ignore
+use juniper_axum::response::JuniperResponse;
+
+let app: Router<Body> = Router::new()
+    .route("/graphql", post(graphql))
+    .layer(Extension(schema))
+    .layer(Extension(context));
+
+async fn graphql(
+    JuniperRequest(request): JuniperRequest,
+    Extension(schema): Extension<Arc<Schema>>,
+    Extension(context): Extension<Arc<Context>>
+) -> JuniperResponse {
+    JuniperResponse(request.execute(&schema, &context).await)
+}
+```
+
+## Subscriptions
+This crate provides a helper function to easily work with graphql subscriptions over a websocket.
+```rust,ignore
+use juniper_axum::subscription::handle_graphql_socket;
+
+let app: Router = Router::new()
+    .route("/subscriptions", get(juniper_subscriptions))
+    .layer(Extension(schema))
+    .layer(Extension(context));
+
+pub async fn juniper_subscriptions(
+    Extension(schema): Extension<Arc<Schema>>,
+    Extension(context): Extension<Context>,
+    ws: WebSocketUpgrade,
+) -> Response {
+    ws.protocols(["graphql-ws", "graphql-transport-ws"])
+        .max_frame_size(1024)
+        .max_message_size(1024)
+        .max_send_queue(100)
+        .on_upgrade(|socket| handle_graphql_socket(socket, schema, context))
+}
+```
+
+
+
+## License
+
+This project is licensed under [BSD 2-Clause License](https://github.com/graphql-rust/juniper/blob/master/juniper_axum/LICENSE).
+
+
+
+
+[`juniper`]: https://docs.rs/juniper
+[`juniper_axum`]: https://docs.rs/juniper_axum
+[`axum`]: https://docs.rs/axum
+[GraphQL]: http://graphql.org
+[Juniper Book]: https://graphql-rust.github.io
+[Rust]: https://www.rust-lang.org
+
+[1]: https://github.com/graphql-rust/juniper/blob/master/juniper_warp/examples/warp_server.rs

juniper_axum/examples/simple.rs

@@ -0,0 +1,92 @@
+use std::{net::SocketAddr, pin::Pin, sync::Arc, time::Duration};
+
+use axum::{
+    extract::WebSocketUpgrade,
+    response::Response,
+    routing::{get, post},
+    Extension, Router,
+};
+use futures::{Stream, StreamExt};
+
+use juniper::{graphql_object, graphql_subscription, EmptyMutation, FieldError, RootNode};
+use juniper_axum::{
+    extract::JuniperRequest, playground, response::JuniperResponse,
+    subscriptions::handle_graphql_socket,
+};
+
+#[derive(Clone)]
+pub struct Context;
+impl juniper::Context for Context {}
+
+#[derive(Clone, Copy, Debug)]
+pub struct Query;
+
+#[graphql_object(context = Context)]
+impl Query {
+    /// Add two numbers a and b
+    fn add(a: i32, b: i32) -> i32 {
+        a + b
+    }
+}
+
+pub struct Subscription;
+type NumberStream = Pin<Box<dyn Stream<Item = Result<i32, FieldError>> + Send>>;
+type AppSchema = RootNode<'static, Query, EmptyMutation<Context>, Subscription>;
+
+#[graphql_subscription(context = Context)]
+impl Subscription {
+    /// Count seconds
+    async fn count() -> NumberStream {
+        let mut value = 0;
+        let stream = tokio_stream::wrappers::IntervalStream::new(tokio::time::interval(
+            Duration::from_secs(1),
+        ))
+        .map(move |_| {
+            value += 1;
+            Ok(value)
+        });
+        Box::pin(stream)
+    }
+}
+
+#[tokio::main]
+async fn main() {
+    let schema = Arc::new(AppSchema::new(Query, EmptyMutation::new(), Subscription));
+
+    let context = Context;
+
+    let app = Router::new()
+        .route("/", get(|| playground("/graphql", Some("/subscriptions"))))
+        .route("/graphql", post(graphql))
+        .route("/subscriptions", get(juniper_subscriptions))
+        .layer(Extension(schema))
+        .layer(Extension(context));
+
+    // run it
+    let addr = SocketAddr::from(([127, 0, 0, 1], 3000));
+    println!("listening on {}", addr);
+    axum::Server::bind(&addr)
+        .serve(app.into_make_service())
+        .await
+        .unwrap();
+}
+
+pub async fn juniper_subscriptions(
+    Extension(schema): Extension<Arc<AppSchema>>,
+    Extension(context): Extension<Context>,
+    ws: WebSocketUpgrade,
+) -> Response {
+    ws.protocols(["graphql-ws"])
+        .max_frame_size(1024)
+        .max_message_size(1024)
+        .max_send_queue(100)
+        .on_upgrade(|socket| handle_graphql_socket(socket, schema, context))
+}
+
+async fn graphql(
+    JuniperRequest(request): JuniperRequest,
+    Extension(schema): Extension<Arc<AppSchema>>,
+    Extension(context): Extension<Context>,
+) -> JuniperResponse {
+    JuniperResponse(request.execute(&schema, &context).await)
+}