Implementation of integration between actix-web and juniper

Author: engylemure

Cargo.toml

@@ -9,13 +9,13 @@ members = [
   "juniper_hyper",
   "juniper_iron",
   "juniper_rocket",
+  "juniper_rocket_async",
   "juniper_subscriptions",
   "juniper_warp",
+  "juniper_actix",
 ]
 exclude = [
   "docs/book/tests",
   "examples/warp_async",
   "examples/warp_subscriptions",
-  # TODO enable async tests
-  "juniper_rocket_async",
 ]

juniper/CHANGELOG.md

@@ -18,10 +18,15 @@ See [#419](https://github.com/graphql-rust/juniper/pull/419).
 - `SchemaType` is now public
   - This is helpful when using `context.getSchema()` inside of your field resolvers
 
+- Support subscriptions in GraphiQL
+
 See [#569](https://github.com/graphql-rust/juniper/pull/569).
 
 ## Breaking Changes
 
+- `juniper::graphiql` has moved to `juniper::http::graphiql`
+  - `juniper::http::graphiql::graphiql_source` now requies a second parameter for subscriptions
+
 - remove old `graphql_object!` macro, rename `object` proc macro to `graphql_object`
 
 - Remove deprecated `ScalarValue` custom derive (renamed to GraphQLScalarValue)

juniper/release.toml

@@ -22,9 +22,15 @@ pre-release-replacements = [
   # Rocket
   {file="../juniper_rocket/Cargo.toml", search="juniper = \\{ version = \"[^\"]+\"", replace="juniper = { version = \"{{version}}\""},
   {file="../juniper_rocket/Cargo.toml", search="\\[dev-dependencies\\.juniper\\]\nversion = \"[^\"]+\"", replace="[dev-dependencies.juniper]\nversion = \"{{version}}\""},
+  # Rocket Async
+  {file="../juniper_rocket_async/Cargo.toml", search="juniper = \\{ version = \"[^\"]+\"", replace="juniper = { version = \"{{version}}\""},
+  {file="../juniper_rocket_async/Cargo.toml", search="\\[dev-dependencies\\.juniper\\]\nversion = \"[^\"]+\"", replace="[dev-dependencies.juniper]\nversion = \"{{version}}\""},
   # Warp
   {file="../juniper_warp/Cargo.toml", search="juniper = \\{ version = \"[^\"]+\"", replace="juniper = { version = \"{{version}}\""},
   {file="../juniper_warp/Cargo.toml", search="\\[dev-dependencies\\.juniper\\]\nversion = \"[^\"]+\"", replace="[dev-dependencies.juniper]\nversion = \"{{version}}\""},
   # Subscriptions
   {file="../juniper_subscriptions/Cargo.toml", search="juniper = \\{ version = \"[^\"]+\"", replace="juniper = { version = \"{{version}}\""},
+  # Actix-Web
+  {file="../juniper_actix/Cargo.toml", search="juniper = \\{ version = \"[^\"]+\"", replace="juniper = { version = \"{{version}}\""},
+  {file="../juniper_actix/Cargo.toml", search="\\[dev-dependencies\\.juniper\\]\nversion = \"[^\"]+\"", replace="[dev-dependencies.juniper]\nversion = \"{{version}}\""},
 ]

juniper/src/http/graphiql.rs

@@ -1,7 +1,23 @@
 //! Utility module to generate a GraphiQL interface
 
 /// Generate the HTML source to show a GraphiQL interface
-pub fn graphiql_source(graphql_endpoint_url: &str) -> String {
+///
+/// The subscriptions endpoint URL can optionally be provided. For example:
+///
+/// ```
+/// # use juniper::http::graphiql::graphiql_source;
+/// let graphiql = graphiql_source("/graphql", Some("ws://localhost:8080/subscriptions"));
+/// ```
+pub fn graphiql_source(
+    graphql_endpoint_url: &str,
+    subscriptions_endpoint_url: Option<&str>,
+) -> String {
+    let subscriptions_endpoint = if let Some(sub_url) = subscriptions_endpoint_url {
+        sub_url
+    } else {
+        ""
+    };
+
     let stylesheet_source = r#"
     <style>
         html, body, #app {
@@ -14,6 +30,10 @@ pub fn graphiql_source(graphql_endpoint_url: &str) -> String {
     "#;
     let fetcher_source = r#"
     <script>
+        if (usingSubscriptions) {
+            var subscriptionsClient = new window.SubscriptionsTransportWs.SubscriptionClient(GRAPHQL_SUBSCRIPTIONS_URL, { reconnect: true });
+        }
+
         function graphQLFetcher(params) {
             return fetch(GRAPHQL_URL, {
                 method: 'post',
@@ -33,9 +53,12 @@ pub fn graphiql_source(graphql_endpoint_url: &str) -> String {
                 }
             });
         }
+
+        var fetcher = usingSubscriptions ? window.GraphiQLSubscriptionsFetcher.graphQLFetcher(subscriptionsClient, graphQLFetcher) : graphQLFetcher;
+
         ReactDOM.render(
             React.createElement(GraphiQL, {
-                fetcher: graphQLFetcher,
+                fetcher,
             }),
             document.querySelector('#app'));
     </script>
@@ -53,16 +76,22 @@ pub fn graphiql_source(graphql_endpoint_url: &str) -> String {
 <body>
     <div id="app"></div>
     <script src="//cdnjs.cloudflare.com/ajax/libs/fetch/2.0.3/fetch.js"></script>
+    <script src="//unpkg.com/[email protected]/browser/client.js"></script>
+    <script src="//unpkg.com/[email protected]/browser/client.js"></script>
     <script src="//cdnjs.cloudflare.com/ajax/libs/react/16.10.2/umd/react.production.min.js"></script>
     <script src="//cdnjs.cloudflare.com/ajax/libs/react-dom/16.10.2/umd/react-dom.production.min.js"></script>
     <script src="//cdn.jsdelivr.net/npm/[email protected]/graphiql.min.js"></script>
     <script>var GRAPHQL_URL = '{graphql_url}';</script>
+    <script>var usingSubscriptions = {using_subscriptions};</script>
+    <script>var GRAPHQL_SUBSCRIPTIONS_URL = '{graphql_subscriptions_url}';</script>
     {fetcher_source}
 </body>
 </html>
 "#,
         graphql_url = graphql_endpoint_url,
         stylesheet_source = stylesheet_source,
-        fetcher_source = fetcher_source
+        fetcher_source = fetcher_source,
+        graphql_subscriptions_url = subscriptions_endpoint,
+        using_subscriptions = subscriptions_endpoint_url.is_some(),
     )
 }

juniper/src/http/mod.rs

@@ -217,6 +217,128 @@ where
     }
 }
 
+/// Simple wrapper around GraphQLRequest to allow the handling of Batch requests
+#[derive(Debug, serde_derive::Deserialize, PartialEq)]
+#[serde(untagged)]
+#[serde(bound = "InputValue<S>: Deserialize<'de>")]
+pub enum GraphQLBatchRequest<S = DefaultScalarValue>
+where
+    S: ScalarValue,
+{
+    /// A single operation request.
+    Single(GraphQLRequest<S>),
+    /// A batch operation request.
+    Batch(Vec<GraphQLRequest<S>>),
+}
+
+impl<S> GraphQLBatchRequest<S>
+where
+    S: ScalarValue,
+{
+    /// Execute a GraphQL batch request synchronously using the specified schema and context
+    ///
+    /// This is a simple wrapper around the `execute_sync` function exposed in GraphQLRequest.
+    pub fn execute_sync<'a, CtxT, QueryT, MutationT, SubscriptionT>(
+        &'a self,
+        root_node: &'a crate::RootNode<QueryT, MutationT, SubscriptionT, S>,
+        context: &CtxT,
+    ) -> GraphQLBatchResponse<'a, S>
+    where
+        QueryT: crate::GraphQLType<S, Context = CtxT>,
+        MutationT: crate::GraphQLType<S, Context = CtxT>,
+        SubscriptionT: crate::GraphQLType<S, Context = CtxT>,
+    {
+        match *self {
+            GraphQLBatchRequest::Single(ref request) => {
+                GraphQLBatchResponse::Single(request.execute_sync(root_node, context))
+            }
+            GraphQLBatchRequest::Batch(ref requests) => GraphQLBatchResponse::Batch(
+                requests
+                    .iter()
+                    .map(|request| request.execute_sync(root_node, context))
+                    .collect(),
+            ),
+        }
+    }
+
+    /// Executes a GraphQL request using the specified schema and context
+    ///
+    /// This is a simple wrapper around the `execute` function exposed in
+    /// GraphQLRequest
+    pub async fn execute<'a, CtxT, QueryT, MutationT, SubscriptionT>(
+        &'a self,
+        root_node: &'a crate::RootNode<'a, QueryT, MutationT, SubscriptionT, S>,
+        context: &'a CtxT,
+    ) -> GraphQLBatchResponse<'a, S>
+    where
+        QueryT: crate::GraphQLTypeAsync<S, Context = CtxT> + Send + Sync,
+        QueryT::TypeInfo: Send + Sync,
+        MutationT: crate::GraphQLTypeAsync<S, Context = CtxT> + Send + Sync,
+        MutationT::TypeInfo: Send + Sync,
+        SubscriptionT: crate::GraphQLSubscriptionType<S, Context = CtxT> + Send + Sync,
+        SubscriptionT::TypeInfo: Send + Sync,
+        CtxT: Send + Sync,
+        S: Send + Sync,
+    {
+        match *self {
+            GraphQLBatchRequest::Single(ref request) => {
+                let res = request.execute(root_node, context).await;
+                GraphQLBatchResponse::Single(res)
+            }
+            GraphQLBatchRequest::Batch(ref requests) => {
+                let futures = requests
+                    .iter()
+                    .map(|request| request.execute(root_node, context))
+                    .collect::<Vec<_>>();
+                let responses = futures::future::join_all(futures).await;
+
+                GraphQLBatchResponse::Batch(responses)
+            }
+        }
+    }
+
+    /// The operation names of the request.
+    pub fn operation_names(&self) -> Vec<Option<&str>> {
+        match self {
+            GraphQLBatchRequest::Single(req) => vec![req.operation_name()],
+            GraphQLBatchRequest::Batch(reqs) => {
+                reqs.iter().map(|req| req.operation_name()).collect()
+            }
+        }
+    }
+}
+
+/// Simple wrapper around the result (GraphQLResponse) from executing a GraphQLBatchRequest
+///
+/// This struct implements Serialize, so you can simply serialize this
+/// to JSON and send it over the wire. use the `is_ok` to determine
+/// wheter to send a 200 or 400 HTTP status code.
+#[derive(serde_derive::Serialize)]
+#[serde(untagged)]
+pub enum GraphQLBatchResponse<'a, S = DefaultScalarValue>
+where
+    S: ScalarValue,
+{
+    /// Result of a single operation in a GraphQL request.
+    Single(GraphQLResponse<'a, S>),
+    /// Result of a batch operation in a GraphQL request.
+    Batch(Vec<GraphQLResponse<'a, S>>),
+}
+
+impl<'a, S> GraphQLBatchResponse<'a, S>
+where
+    S: ScalarValue,
+{
+    /// Returns if all the GraphQLResponse in this operation are ok,
+    /// you can use it to determine wheter to send a 200 or 400 HTTP status code.
+    pub fn is_ok(&self) -> bool {
+        match self {
+            GraphQLBatchResponse::Single(res) => res.is_ok(),
+            GraphQLBatchResponse::Batch(reses) => reses.iter().all(|res| res.is_ok()),
+        }
+    }
+}
+
 #[cfg(any(test, feature = "expose-test-schema"))]
 #[allow(missing_docs)]
 pub mod tests {

juniper/src/lib.rs

@@ -142,8 +142,6 @@ mod validation;
 // https://github.com/rust-lang/cargo/issues/1520
 pub mod http;
 pub mod integrations;
-// TODO: remove this alias export in 0.10. (breaking change)
-pub use crate::http::graphiql;
 
 #[cfg(all(test, not(feature = "expose-test-schema")))]
 mod tests;

juniper_actix/.gitignore

@@ -0,0 +1,4 @@
+/target
+/examples/**/target/**/*
+**/*.rs.bk
+Cargo.lock

juniper_actix/CHANGELOG.md

@@ -0,0 +1,3 @@
+# master
+
+- Initial Release

juniper_actix/Cargo.toml

@@ -0,0 +1,33 @@
+[package]
+name = "juniper_actix"
+version = "0.1.0"
+authors = ["Jordao Rosario <[email protected]>"]
+description = "Juniper GraphQL integration with Actix"
+license = "BSD-2-Clause"
+documentation = "https://docs.rs/juniper_actix"
+repository = "https://github.com/graphql-rust/juniper"
+edition = "2018"
+
+
+[dependencies]
+actix = "0.9.0"
+actix-rt = "1.0.0"
+actix-web = { version = "2.0.0", features = ["rustls"] }
+actix-web-actors = "2.0.0"
+futures = { version = "0.3.1", features = ["compat"] }
+juniper = { version = "0.14.2", path = "../juniper", default-features = false  }
+tokio = { version = "0.2", features = ["time"] }
+serde_json = "1.0.24"
+serde_derive = "1.0.75"
+failure = "0.1.7"
+serde = "1.0.75"
+
+[dev-dependencies]
+juniper = { version = "0.14.2", path = "../juniper", features = ["expose-test-schema", "serde_json"] }
+env_logger = "0.5.11"
+log = "0.4.3"
+percent-encoding = "1.0"
+tokio = { version = "0.2", features = ["rt-core", "macros", "blocking"] }
+actix-cors = "0.2.0"
+actix-identity = "0.2.0"
+bytes = "0.5.4"

juniper_actix/LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2018, Jordao Rosario
+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.