added a new validation phase

Author: dotansimha

Cargo.lock

@@ -21,6 +21,7 @@ http = "0.2.3"
 fail = { version = "0.5", features = ["failpoints"] }
 futures = "0.1.21"
 graphql-parser = "0.4.0"
+graphql-tools = "0.0.4"
 lazy_static = "1.4.0"
 mockall = "0.8.3"
 num-bigint = { version = "^0.2.6", features = ["serde"] }

graph/Cargo.toml

@@ -41,6 +41,7 @@ pub enum QueryExecutionError {
     AbstractTypeError(String),
     InvalidArgumentError(Pos, String, q::Value),
     MissingArgumentError(Pos, String),
+    ValidationError(Option<Pos>, String),
     InvalidVariableTypeError(Pos, String),
     MissingVariableError(Pos, String),
     ResolveEntitiesError(String),
@@ -135,6 +136,7 @@ impl QueryExecutionError {
             | DeploymentReverted
             | SubgraphManifestResolveError(_)
             | InvalidSubgraphManifest
+            | ValidationError(_, _)
             | ResultTooBig(_, _) => false,
         }
     }
@@ -159,6 +161,9 @@ impl fmt::Display for QueryExecutionError {
             OperationNotFound(s) => {
                 write!(f, "Operation name not found `{}`", s)
             }
+            ValidationError(_pos, message) => {
+                write!(f, "{}", message)
+            }
             NotSupported(s) => write!(f, "Not supported: {}", s),
             NoRootSubscriptionObjectType => {
                 write!(f, "No root Subscription type defined in the schema")

graph/src/data/query/error.rs

@@ -9,6 +9,7 @@ use serde::Serialize;
 use std::collections::BTreeMap;
 use std::convert::TryFrom;
 use std::sync::Arc;
+use graphql_tools::validation::utils::{ValidationError};
 
 fn serialize_data<S>(data: &Option<Data>, serializer: S) -> Result<S::Ok, S::Error>
 where
@@ -172,7 +173,7 @@ impl QueryResults {
     }
 }
 
-/// The result of running a query, if successful.
+/// The result of running a GraphQL query.
 #[derive(Debug, Serialize)]
 pub struct QueryResult {
     #[serde(
@@ -182,6 +183,7 @@ pub struct QueryResult {
     data: Option<Data>,
     #[serde(skip_serializing_if = "Vec::is_empty")]
     errors: Vec<QueryError>,
+    /// This is a non-standard GraphQL response field.
     #[serde(skip_serializing)]
     pub deployment: Option<DeploymentHash>,
 }
@@ -250,6 +252,20 @@ impl From<QueryExecutionError> for QueryResult {
     }
 }
 
+impl From<Vec<ValidationError>> for QueryResult {
+  fn from(errors: Vec<ValidationError>) -> Self {
+    let execution_errors = errors.iter().map(|e| {
+      QueryError::ExecutionError(QueryExecutionError::ValidationError(e.locations.clone().into_iter().nth(0), e.message.clone()))
+    }).collect::<Vec<QueryError>>();
+
+      QueryResult {
+          data: None,
+          errors: execution_errors,
+          deployment: None,
+      }
+  }
+}
+
 impl From<QueryError> for QueryResult {
     fn from(e: QueryError) -> Self {
         QueryResult {

graph/src/data/query/result.rs

@@ -8,6 +8,7 @@ crossbeam = "0.8"
 futures01 = { package="futures", version="0.1.29" }
 graph = { path = "../graph" }
 graphql-parser = "0.4.0"
+graphql-tools = "0.0.4"
 indexmap = "1.7"
 Inflector = "0.11.3"
 lazy_static = "1.2.0"
@@ -20,4 +21,4 @@ anyhow = "1.0"
 [dev-dependencies]
 pretty_assertions = "1.0.0"
 test-store = { path = "../store/test-store" }
-graph-chain-ethereum = { path = "../chain/ethereum" }
+graph-chain-ethereum = { path = "../chain/ethereum" }

graphql/Cargo.toml

@@ -7,7 +7,7 @@ use std::time::{Duration, Instant};
 use crate::prelude::{QueryExecutionOptions, StoreResolver, SubscriptionExecutionOptions};
 use crate::query::execute_query;
 use crate::subscription::execute_prepared_subscription;
-use graph::prelude::MetricsRegistry;
+use graph::prelude::{MetricsRegistry, QueryResult};
 use graph::prometheus::{Gauge, Histogram};
 use graph::{
     components::store::SubscriptionManager,
@@ -21,6 +21,8 @@ use graph::{
     data::query::{QueryResults, QueryTarget},
     prelude::QueryStore,
 };
+use graphql_tools::validation::validate::{validate, ValidationPlan};
+use graphql_tools::validation::rules::{OverlappingFieldsCanBeMerged};
 
 use lazy_static::lazy_static;
 
@@ -77,6 +79,7 @@ pub struct GraphQlRunner<S, SM> {
     subscription_manager: Arc<SM>,
     load_manager: Arc<LoadManager>,
     result_size: Arc<ResultSizeMetrics>,
+    graphql_validation_plan: ValidationPlan,
 }
 
 lazy_static! {
@@ -135,12 +138,16 @@ where
     ) -> Self {
         let logger = logger.new(o!("component" => "GraphQlRunner"));
         let result_size = Arc::new(ResultSizeMetrics::new(registry));
+        let mut graphql_validation_plan = ValidationPlan { rules: Vec::new() };
+        graphql_validation_plan.add_rule(Box::new(OverlappingFieldsCanBeMerged {}));
+
         GraphQlRunner {
             logger,
             store,
             subscription_manager,
             load_manager,
             result_size,
+            graphql_validation_plan
         }
     }
 
@@ -197,6 +204,11 @@ where
         let state = store.deployment_state().await?;
         let network = Some(store.network_name().to_string());
         let schema = store.api_schema()?;
+        let validation_errors = validate(&schema.document(), &query.document, &self.graphql_validation_plan);
+
+        if validation_errors.len() > 0 {
+            return Ok(QueryResults::from(QueryResult::from(validation_errors)));
+        }
 
         // Test only, see c435c25decbc4ad7bbbadf8e0ced0ff2
         #[cfg(debug_assertions)]

graphql/src/runner.rs

@@ -31,6 +31,10 @@ pub async fn run(
     };
 
     let document = graphql_parser::parse_query(&query)?.into_static();
+
+    // Ideally, `validate` phase should happen here, but we don't have teh schema at this point,
+    // so we cann it in `graphql/runner.rs` instead, where we have the api schema loaded.
+    
     let vars: Vec<(String, r::Value)> = vars
         .into_iter()
         .map(|v| {