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 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
/*! # GraphQL [GraphQL][1] is a data query language developed by Facebook intended to serve mobile and web application frontends. A server provides a schema, containing types and fields that applications can query. Queries are hierarchical, composable, and statically typed. Schemas are introspective, which lets clients statically verify their queries against a server without actually executing them. This library provides data types and traits to expose Rust types in a GraphQL schema, as well as an optional integration into the [Iron framework][2]. It tries to keep the number of dynamic operations to a minimum, and give you as the schema developer the control of the query execution path. Juniper only depends on `rustc-serialize` by default, making it lightweight and easy to drop into any project. Through the `iron-handlers` feature, it also depends on Iron. ## Exposing data types The `GraphQLType` trait is the primary interface towards application developers. By deriving this trait, you can expose your types as either objects, enums, interfaces, unions, or scalars. However, due to the dynamic nature of GraphQL's type system, deriving this trait manually is a bit tedious, especially in order to do it in a fully type safe manner. To help with this task, this library provides a couple of macros; the most common one being `graphql_object!`. Use this macro to expose your already existing object types as GraphQL objects: ```rust #[macro_use] extern crate juniper; # use std::collections::HashMap; use juniper::{Context, FieldResult}; struct User { id: String, name: String, friend_ids: Vec<String> } struct QueryRoot; struct Database { users: HashMap<String, User> } impl Context for Database {} // GraphQL objects can access a "context object" during execution. Use this // object to provide e.g. database access to the field accessors. This object // must implement the `Context` trait. If you don't need a context, use the // empty tuple `()` to indicate this. // // In this example, we use the Database struct as our context. graphql_object!(User: Database |&self| { // Expose a simple field as a GraphQL string. field id() -> &String { &self.id } field name() -> &String { &self.name } // FieldResult<T> is an alias for Result<T, String> - simply return // a string from this method and it will be correctly inserted into // the execution response. field secret() -> FieldResult<&String> { Err("Can't touch this".to_owned()) } // Field accessors can optionally take an "executor" as their first // argument. This object can help guide query execution and provides // access to the context instance. // // In this example, the context is used to convert the friend_ids array // into actual User objects. field friends(&executor) -> Vec<&User> { self.friend_ids.iter() .filter_map(|id| executor.context().users.get(id)) .collect() } }); // The context object is passed down to all referenced types - all your exposed // types need to have the same context type. graphql_object!(QueryRoot: Database |&self| { // Arguments work just like they do on functions. field user(&executor, id: String) -> Option<&User> { executor.context().users.get(&id) } }); # fn main() { } ``` Adding per type, field, and argument documentation is possible directly from this macro. For more in-depth information on how to expose fields and types, see the [`graphql_object!`][3] macro. ## Integrating with Iron The most obvious usecase is to expose the GraphQL schema over an HTTP endpoint. To support this, the library provides an optional and customizable Iron handler. For example, continuing from the schema created above: ```rust,no_run extern crate iron; # #[macro_use] extern crate juniper; # use std::collections::HashMap; use iron::prelude::*; use juniper::iron_handlers::GraphQLHandler; use juniper::{Context, EmptyMutation}; # use juniper::FieldResult; # # struct User { id: String, name: String, friend_ids: Vec<String> } # struct QueryRoot; # struct Database { users: HashMap<String, User> } # # graphql_object!(User: Database |&self| { # field id() -> FieldResult<&String> { # Ok(&self.id) # } # # field name() -> FieldResult<&String> { # Ok(&self.name) # } # # field friends(&executor) -> FieldResult<Vec<&User>> { # Ok(self.friend_ids.iter() # .filter_map(|id| executor.context().users.get(id)) # .collect()) # } # }); # # graphql_object!(QueryRoot: Database |&self| { # field user(&executor, id: String) -> FieldResult<Option<&User>> { # Ok(executor.context().users.get(&id)) # } # }); // This function is executed for every request. Here, we would realistically // provide a database connection or similar. For this example, we'll be // creating the database from scratch. fn context_factory(_: &mut Request) -> Database { Database { users: vec![ ( "1000".to_owned(), User { id: "1000".to_owned(), name: "Robin".to_owned(), friend_ids: vec!["1001".to_owned()] } ), ( "1001".to_owned(), User { id: "1001".to_owned(), name: "Max".to_owned(), friend_ids: vec!["1000".to_owned()] } ), ].into_iter().collect() } } impl Context for Database {} fn main() { // GraphQLHandler takes a context factory function, the root object, // and the mutation object. If we don't have any mutations to expose, we // can use the empty tuple () to indicate absence. let graphql_endpoint = GraphQLHandler::new( context_factory, QueryRoot, EmptyMutation::<Database>::new()); // Start serving the schema at the root on port 8080. Iron::new(graphql_endpoint).http("localhost:8080").unwrap(); } ``` See the [`iron_handlers`][4] module and the [`GraphQLHandler`][5] documentation for more information on what request methods are supported. There's also a built-in [GraphiQL][6] handler included. [1]: http://graphql.org [2]: http://ironframework.io [3]: macro.graphql_object!.html [4]: iron_handlers/index.html [5]: iron_handlers/struct.GraphQLHandler.html [6]: https://github.com/graphql/graphiql */ #![cfg_attr(feature="nightly", feature(test))] #![warn(missing_docs)] #[cfg(feature="rustc-serialize")] extern crate rustc_serialize; #[cfg(feature="serde")] extern crate serde; #[cfg(feature="nightly")] extern crate test; #[cfg(feature="iron-handlers")] #[macro_use(itry, iexpect)] extern crate iron; #[cfg(test)] extern crate iron_test; #[macro_use] mod macros; mod ast; pub mod parser; mod value; mod types; mod schema; mod validation; mod executor; mod integrations; #[macro_use] mod result_ext; #[cfg(all(test, not(feature="expose-test-schema")))] mod tests; #[cfg(feature="expose-test-schema")] pub mod tests; #[cfg(test)] mod executor_tests; use parser::{parse_document_source, ParseError, Spanning}; use validation::{ValidatorContext, visit_all_rules, validate_input_values}; use executor::execute_validated_query; pub use ast::{ToInputValue, FromInputValue, InputValue, Type, Selection}; pub use value::Value; pub use types::base::{Arguments, GraphQLType, TypeKind}; pub use executor::{ Executor, ExecutionError, Registry, Context, FromContext, IntoResolvable, FieldResult, ExecutionResult, Variables, }; pub use validation::RuleError; pub use types::scalars::{EmptyMutation, ID}; pub use schema::model::RootNode; pub use result_ext::ResultExt; pub use schema::meta; #[cfg(feature="iron-handlers")] pub use integrations::iron_handlers; /// An error that prevented query execution #[derive(Debug, PartialEq)] #[allow(missing_docs)] pub enum GraphQLError<'a> { ParseError(Spanning<ParseError<'a>>), ValidationError(Vec<RuleError>), NoOperationProvided, MultipleOperationsProvided, UnknownOperationName, } /// Execute a query in a provided schema pub fn execute<'a, CtxT, QueryT, MutationT>( document_source: &'a str, operation_name: Option<&str>, root_node: &RootNode<QueryT, MutationT>, variables: &Variables, context: &CtxT, ) -> Result<(Value, Vec<ExecutionError>), GraphQLError<'a>> where QueryT: GraphQLType<Context=CtxT>, MutationT: GraphQLType<Context=CtxT>, { let document = try!(parse_document_source(document_source)); { let errors = validate_input_values(variables, &document, &root_node.schema); if !errors.is_empty() { return Err(GraphQLError::ValidationError(errors)); } } { let mut ctx = ValidatorContext::new(&root_node.schema, &document); visit_all_rules(&mut ctx, &document); let errors = ctx.into_errors(); if !errors.is_empty() { return Err(GraphQLError::ValidationError(errors)); } } execute_validated_query(document, operation_name, root_node, variables, context) } impl<'a> From<Spanning<ParseError<'a>>> for GraphQLError<'a> { fn from(f: Spanning<ParseError<'a>>) -> GraphQLError<'a> { GraphQLError::ParseError(f) } } #[doc(hidden)] pub fn to_camel_case(s: &str) -> String { let mut dest = String::new(); for (i, part) in s.split('_').enumerate() { if i > 0 && part.len() == 1 { dest.push_str(&part.to_uppercase()); } else if i > 0 && part.len() > 1 { let first = part.chars().next().unwrap().to_uppercase().collect::<String>(); let second = &part[1..]; dest.push_str(&first); dest.push_str(second); } else if i == 0 { dest.push_str(part); } } dest } #[test] fn test_to_camel_case() { assert_eq!(&to_camel_case("test")[..], "test"); assert_eq!(&to_camel_case("_test")[..], "Test"); assert_eq!(&to_camel_case("first_second")[..], "firstSecond"); assert_eq!(&to_camel_case("first_")[..], "first"); assert_eq!(&to_camel_case("a_b_c")[..], "aBC"); assert_eq!(&to_camel_case("a_bc")[..], "aBc"); assert_eq!(&to_camel_case("a_b")[..], "aB"); assert_eq!(&to_camel_case("a")[..], "a"); assert_eq!(&to_camel_case("")[..], ""); }