Axum integration

.github/workflows/ci.yml

@@ -115,6 +115,8 @@ jobs:
           - { feature: graphql-ws, crate: juniper_graphql_ws }
           - { feature: <none>, crate: juniper_actix }
           - { feature: subscriptions, crate: juniper_actix }
+          - { feature: <none>, crate: juniper_axum }
+          - { feature: subscriptions, crate: juniper_axum }
           - { feature: <none>, crate: juniper_warp }
           - { feature: subscriptions, crate: juniper_warp }
     runs-on: ubuntu-latest
@@ -148,6 +150,7 @@ jobs:
           - juniper_subscriptions
           - juniper_graphql_ws
           - juniper_actix
+          - juniper_axum
           - juniper_hyper
           #- juniper_iron
           - juniper_rocket
@@ -200,6 +203,7 @@ jobs:
           - juniper_integration_tests
           - juniper_codegen_tests
           - juniper_actix
+          - juniper_axum
           - juniper_hyper
           - juniper_iron
           - juniper_rocket
@@ -326,6 +330,7 @@ jobs:
           - juniper_subscriptions
           - juniper_graphql_ws
           - juniper_actix
+          - juniper_axum
           - juniper_hyper
           - juniper_iron
           - juniper_rocket

Cargo.toml

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

README.md

@@ -79,6 +79,7 @@ your Schemas automatically.
 ### Web Frameworks
 
 - [actix][actix]
+- [axum][axum]
 - [hyper][hyper]
 - [rocket][rocket]
 - [iron][iron]
@@ -93,6 +94,7 @@ your Schemas automatically.
 Juniper has not reached 1.0 yet, thus some API instability should be expected.
 
 [actix]: https://actix.rs/
+[axum]: https://docs.rs/axum
 [graphql]: http://graphql.org
 [graphiql]: https://github.com/graphql/graphiql
 [playground]: https://github.com/prisma/graphql-playground

juniper/README.md

@@ -58,6 +58,7 @@ As an exception to other [GraphQL] libraries for other languages, [Juniper] buil
 ### Web servers
 
 - [`actix-web`] ([`juniper_actix`] crate)
+- [`axum`] ([`juniper_axum`] crate)
 - [`hyper`] ([`juniper_hyper`] crate)
 - [`iron`] ([`juniper_iron`] crate)
 - [`rocket`] ([`juniper_rocket`] crate)
@@ -81,11 +82,13 @@ This project is licensed under [BSD 2-Clause License](https://github.com/graphql
 
 
 [`actix-web`]: https://docs.rs/actix-web
+[`axum`]: https://docs.rs/axum
 [`bigdecimal`]: https://docs.rs/bigdecimal
 [`bson`]: https://docs.rs/bson
 [`chrono`]: https://docs.rs/chrono
 [`chrono-tz`]: https://docs.rs/chrono-tz
 [`juniper_actix`]: https://docs.rs/juniper_actix
+[`juniper_axum`]: https://docs.rs/juniper_axum
 [`juniper_hyper`]: https://docs.rs/juniper_hyper
 [`juniper_iron`]: https://docs.rs/juniper_iron
 [`juniper_rocket`]: https://docs.rs/juniper_rocket

juniper/release.toml

@@ -40,6 +40,12 @@ exactly = 2
 search = "juniper = \\{ version = \"[^\"]+\""
 replace = "juniper = { version = \"{{version}}\""
 
+[[pre-release-replacements]]
+file = "../juniper_axum/Cargo.toml"
+exactly = 2
+search = "juniper = \\{ version = \"[^\"]+\""
+replace = "juniper = { version = \"{{version}}\""
+
 [[pre-release-replacements]]
 file = "../juniper_graphql_ws/Cargo.toml"
 exactly = 1

juniper/src/http/mod.rs

@@ -37,6 +37,7 @@ where
     pub operation_name: Option<String>,
 
     /// Optional variables to execute the GraphQL operation with.
+    // TODO: Use `Variables` instead of `InputValue`?
     #[serde(bound(
         deserialize = "InputValue<S>: Deserialize<'de>",
         serialize = "InputValue<S>: Serialize",
@@ -238,11 +239,11 @@ where
     /// A batch operation request.
     ///
     /// Empty batch is considered as invalid value, so cannot be deserialized.
-    #[serde(deserialize_with = "deserialize_non_empty_vec")]
+    #[serde(deserialize_with = "deserialize_non_empty_batch")]
     Batch(Vec<GraphQLRequest<S>>),
 }
 
-fn deserialize_non_empty_vec<'de, D, T>(deserializer: D) -> Result<Vec<T>, D::Error>
+fn deserialize_non_empty_batch<'de, D, T>(deserializer: D) -> Result<Vec<T>, D::Error>
 where
     D: de::Deserializer<'de>,
     T: Deserialize<'de>,
@@ -251,7 +252,10 @@ where
 
     let v = Vec::<T>::deserialize(deserializer)?;
     if v.is_empty() {
-        Err(D::Error::invalid_length(0, &"a positive integer"))
+        Err(D::Error::invalid_length(
+            0,
+            &"non-empty batch of GraphQL requests",
+        ))
     } else {
         Ok(v)
     }
@@ -403,6 +407,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);
 
@@ -501,13 +508,48 @@ pub mod tests {
                                 "NEW_HOPE",
                                 "EMPIRE",
                                 "JEDI"
-                                ],
-                                "homePlanet": "Tatooine",
-                                "name": "Luke Skywalker",
-                                "id": "1000"
-                            }
+                            ],
+                            "homePlanet": "Tatooine",
+                            "name": "Luke Skywalker",
+                            "id": "1000"
                         }
-                    }"#
+                    }
+                }"#
+            )
+            .expect("Invalid JSON constant in test")
+        );
+    }
+
+    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")
         );
@@ -752,7 +794,7 @@ pub mod tests {
 
         #[allow(missing_docs)]
         pub async fn run_test_suite<T: WsIntegration>(integration: &T) {
-            println!("Running `graphql-ws` test suite for integration");
+            println!("Running `graphql-transport-ws` test suite for integration");
 
             println!("  - graphql_ws::test_simple_subscription");
             test_simple_subscription(integration).await;

juniper/src/tests/fixtures/starwars/schema.rs

@@ -4,6 +4,7 @@ use std::{collections::HashMap, pin::Pin};
 
 use crate::{graphql_interface, graphql_object, graphql_subscription, Context, GraphQLEnum};
 
+#[derive(Clone, Copy, Debug)]
 pub struct Query;
 
 #[graphql_object(context = Database)]
@@ -33,6 +34,7 @@ impl Query {
     }
 }
 
+#[derive(Clone, Copy, Debug)]
 pub struct Subscription;
 
 type HumanStream = Pin<Box<dyn futures::Stream<Item = Human> + Send>>;

juniper_actix/Cargo.toml

@@ -2,7 +2,7 @@
 name = "juniper_actix"
 version = "0.5.0-dev"
 edition = "2021"
-rust-version = "1.68"
+rust-version = "1.73"
 description = "`juniper` GraphQL integration with `actix-web`."
 license = "BSD-2-Clause"
 authors = ["Jordao Rosario <[email protected]>"]
@@ -12,7 +12,7 @@ repository = "https://github.com/graphql-rust/juniper"
 readme = "README.md"
 categories = ["asynchronous", "web-programming", "web-programming::http-server"]
 keywords = ["actix-web", "apollo", "graphql", "juniper", "websocket"]
-exclude = ["/examples/", "/release.toml"]
+exclude = ["/release.toml"]
 
 [package.metadata.docs.rs]
 all-features = true

juniper_actix/README.md

@@ -4,7 +4,7 @@
 [![Crates.io](https://img.shields.io/crates/v/juniper_actix.svg?maxAge=2592000)](https://crates.io/crates/juniper_actix)
 [![Documentation](https://docs.rs/juniper_actix/badge.svg)](https://docs.rs/juniper_actix)
 [![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)
-[![Rust 1.68+](https://img.shields.io/badge/rustc-1.68+-lightgray.svg "Rust 1.68+")](https://blog.rust-lang.org/2023/03/09/Rust-1.68.0.html)
+[![Rust 1.73+](https://img.shields.io/badge/rustc-1.73+-lightgray.svg "Rust 1.73+")](https://blog.rust-lang.org/2023/10/05/Rust-1.73.0.html)
 
 - [Changelog](https://github.com/graphql-rust/juniper/blob/master/juniper_actix/CHANGELOG.md)
 
@@ -26,7 +26,7 @@ A basic usage example can also be found in the [API docs][`juniper_actix`].
 
 ## Examples
 
-Check [`examples/actix_server.rs`][1] for example code of a working [`actix-web`] server with [GraphQL] handlers.
+Check [`examples/subscription.rs`][1] for example code of a working [`actix-web`] server with [GraphQL] handlers.
 
 
 
@@ -46,5 +46,5 @@ This project is licensed under [BSD 2-Clause License](https://github.com/graphql
 [Juniper Book]: https://graphql-rust.github.io
 [Rust]: https://www.rust-lang.org
 
-[1]: https://github.com/graphql-rust/juniper/blob/master/juniper_actix/examples/actix_server.rs
+[1]: https://github.com/graphql-rust/juniper/blob/master/juniper_actix/examples/subscription.rs
 

juniper_actix/src/lib.rs

@@ -143,7 +143,6 @@ where
 /// let app = App::new()
 ///          .route("/", web::get().to(|| graphiql_handler("/graphql", Some("/graphql/subscriptions"))));
 /// ```
-#[allow(dead_code)]
 pub async fn graphiql_handler(
     graphql_endpoint_url: &str,
     subscriptions_endpoint_url: Option<&'static str>,
@@ -419,7 +418,7 @@ pub mod subscriptions {
     /// Possible errors of serving an [`actix_ws`] connection.
     #[derive(Debug)]
     enum Error {
-        /// Deserializing of a client or server message failed.
+        /// Deserializing of a client [`actix_ws::Message`] failed.
         Serde(serde_json::Error),
 
         /// Unexpected client [`actix_ws::Message`].

juniper_axum/CHANGELOG.md

@@ -0,0 +1,43 @@
+`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
+
+### Initialized
+
+- Dependent on 0.6 version of [`axum` crate]. ([#1088])
+- Dependent on 0.16 version of [`juniper` crate]. ([#1088])
+- Dependent on 0.4 version of [`juniper_graphql_ws` crate]. ([#1088])
+
+### Added
+
+- `extract::JuniperRequest` and `response::JuniperResponse` for using in custom [`axum` crate] handlers. ([#1088])
+- `graphql` handler processing [GraphQL] requests for the specified schema. ([#1088], [#1184])
+- `subscriptions::graphql_transport_ws()` handler and `subscriptions::serve_graphql_transport_ws()` function allowing to process the [new `graphql-transport-ws` GraphQL over WebSocket Protocol][graphql-transport-ws]. ([#1088], [#986])
+- `subscriptions::graphql_ws()` handler and `subscriptions::serve_graphql_ws()` function allowing to process the [legacy `graphql-ws` GraphQL over WebSocket Protocol][graphql-ws]. ([#1088], [#986])
+- `subscriptions::ws()` handler and `subscriptions::serve_ws()` function allowing to auto-select between the [legacy `graphql-ws` GraphQL over WebSocket Protocol][graphql-ws] and the [new `graphql-transport-ws` GraphQL over WebSocket Protocol][graphql-transport-ws], based on the `Sec-Websocket-Protocol` HTTP header value. ([#1088], [#986])
+- `graphiql` handler serving [GraphiQL]. ([#1088])
+- `playground` handler serving [GraphQL Playground]. ([#1088])
+- `simple.rs` and `custom.rs` integration examples. ([#1088], [#986], [#1184])
+
+[#986]: /../../issues/986
+[#1088]: /../../pull/1088
+[#1184]: /../../issues/1184
+
+
+
+
+[`axum` crate]: https://docs.rs/axum
+[`juniper` crate]: https://docs.rs/juniper
+[`juniper_graphql_ws` crate]: https://docs.rs/juniper_graphql_ws
+[GraphiQL]: https://github.com/graphql/graphiql
+[GraphQL]: http://graphql.org
+[GraphQL Playground]: https://github.com/prisma/graphql-playground
+[Semantic Versioning 2.0.0]: https://semver.org
+[graphql-transport-ws]: https://github.com/enisdenjo/graphql-ws/blob/v5.14.0/PROTOCOL.md
+[graphql-ws]: https://github.com/apollographql/subscriptions-transport-ws/blob/v0.11.0/PROTOCOL.md

juniper_axum/Cargo.toml

@@ -0,0 +1,61 @@
+[package]
+name = "juniper_axum"
+version = "0.1.0"
+edition = "2021"
+rust-version = "1.73"
+description = "`juniper` GraphQL integration with `axum`."
+license = "BSD-2-Clause"
+authors = [
+    "Benno Tielen <[email protected]>",
+    "Kai Ren <[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 = ["apollo", "axum", "graphql", "juniper", "websocket"]
+exclude = ["/release.toml"]
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+
+[features]
+subscriptions = ["axum/ws", "juniper_graphql_ws/graphql-ws", "dep:futures"]
+
+[dependencies]
+axum = "0.6.20"
+futures = { version = "0.3.22", optional = true }
+juniper = { version = "0.16.0-dev", path = "../juniper", default-features = false }
+juniper_graphql_ws = { version = "0.4.0-dev", path = "../juniper_graphql_ws", features = ["graphql-transport-ws"] }
+serde = { version = "1.0.122", features = ["derive"] }
+serde_json = "1.0.18"
+
+# Fixes for `minimal-versions` check.
+# TODO: Try remove on upgrade of `axum` crate.
+bytes = "1.2"
+
+[dev-dependencies]
+anyhow = "1.0"
+axum = { version = "0.6", features = ["macros"] }
+hyper = "0.14"
+juniper = { version = "0.16.0-dev", path = "../juniper", features = ["expose-test-schema"] }
+tokio = { version = "1.20", features = ["macros", "rt-multi-thread", "time"] }
+tokio-stream = "0.1"
+tokio-tungstenite = "0.20"
+tracing = "0.1"
+tracing-subscriber = "0.3"
+urlencoding = "2.1"
+
+[[example]]
+name = "custom"
+required-features = ["subscriptions"]
+
+[[example]]
+name = "simple"
+required-features = ["subscriptions"]
+
+[[test]]
+name = "ws_test_suite"
+required-features = ["subscriptions"]