Merge pull request #3447 from hschne/master

Update schema testing documentation

Author: Robert Mosolgo

guides/testing/schema_structure.md

@@ -25,4 +25,47 @@ You can read about this approach in ["Tracking Schema Changes with GraphQL-Ruby"
 
 ## Automatically check for breaking changes
 
-You can use [GraphQL::SchemaComparator](https://github.com/xuorig/graphql-schema_comparator) to check for breaking changes during development or CI.
+You can use [GraphQL::SchemaComparator](https://github.com/xuorig/graphql-schema_comparator) to check for breaking changes during development or CI. If you maintain a dump of queries that typically run against your server, you may also utilize `GraphQL::StaticValidation` to validate these queries directly. A Rake task such as the one below can be used to identify changes that are incompatible with existing queries.
+
+```ruby
+namespace :graphql do
+  namespace :queries do
+    desc 'Validates GraphQL queries against the current schema'
+    task validate: [:environment] do
+      queries_file = 'test/fixtures/files/queries.json'
+      queries = Oj.load(File.read(queries_file))
+
+      Validate.run_validate(queries, MySchema)
+    end
+
+    module Validate
+      def self.run_validate(queries, schema)
+        puts '⏳  Validating queries...'
+        puts "\n"
+
+        results = queries.map { |query| schema.validate(query) }
+        errors = results
+                   .select { |result| result[:errors].present? }
+                   .map { |result| result[:errors] }
+                   .flatten
+
+        if errors.empty?
+          puts '✅  All queries are valid'
+        else
+          print_errors(errors)
+        end
+      end
+
+      def self.print_errors(errors)
+        puts 'Detected the following errors:'
+        puts "\n"
+
+        errors.each do |error|
+          path = error.path.join(', ')
+          puts "❌  #{path}: #{error.message}"
+        end
+      end
+    end
+  end
+end
+```

lib/graphql/schema.rb

@@ -355,23 +355,6 @@ def using_ast_analysis?
     # For forwards-compatibility with Schema classes
     alias :graphql_definition :itself
 
-    # Validate a query string according to this schema.
-    # @param string_or_document [String, GraphQL::Language::Nodes::Document]
-    # @return [Array<GraphQL::StaticValidation::Error >]
-    def validate(string_or_document, rules: nil, context: nil)
-      doc = if string_or_document.is_a?(String)
-        GraphQL.parse(string_or_document)
-      else
-        string_or_document
-      end
-      query = GraphQL::Query.new(self, document: doc, context: context)
-      validator_opts = { schema: self }
-      rules && (validator_opts[:rules] = rules)
-      validator = GraphQL::StaticValidation::Validator.new(**validator_opts)
-      res = validator.validate(query, timeout: validate_timeout)
-      res[:errors]
-    end
-
     def deprecated_define(**kwargs, &block)
       super
       ensure_defined
@@ -712,6 +695,7 @@ def type_error=(new_proc)
     def_delegators :_schema_class, :unauthorized_object, :unauthorized_field, :inaccessible_fields
     def_delegators :_schema_class, :directive
     def_delegators :_schema_class, :error_handler
+    def_delegators :_schema_class, :validate
 
 
     # Given this schema member, find the class-based definition object
@@ -861,7 +845,6 @@ class << self
       def_delegators :graphql_definition,
         # Execution
         :execution_strategy_for_operation,
-        :validate,
         # Configuration
         :metadata, :redefine,
         :id_from_object_proc, :object_from_id_proc,
@@ -1293,6 +1276,23 @@ def validate_timeout(new_validate_timeout = nil)
         end
       end
 
+      # Validate a query string according to this schema.
+      # @param string_or_document [String, GraphQL::Language::Nodes::Document]
+      # @return [Array<GraphQL::StaticValidation::Error >]
+      def validate(string_or_document, rules: nil, context: nil)
+        doc = if string_or_document.is_a?(String)
+                GraphQL.parse(string_or_document)
+              else
+                string_or_document
+              end
+        query = GraphQL::Query.new(self, document: doc, context: context)
+        validator_opts = { schema: self }
+        rules && (validator_opts[:rules] = rules)
+        validator = GraphQL::StaticValidation::Validator.new(**validator_opts)
+        res = validator.validate(query, timeout: validate_timeout)
+        res[:errors]
+      end
+
       attr_writer :max_complexity
 
       def max_complexity(max_complexity = nil)

spec/graphql/schema_spec.rb

@@ -358,4 +358,26 @@ class Schema < GraphQL::Schema
       assert_equal expected_message, err.message
     end
   end
+
+  describe 'validate' do
+    let(:schema) { Dummy::Schema}
+
+    describe 'validate' do
+      it 'validates valid query ' do
+        query = "query sample { root }"
+
+        errors = schema.validate(query)
+
+        assert_empty errors
+      end
+
+      it 'validates invalid query ' do
+        query = "query sample { invalid }"
+
+        errors = schema.validate(query)
+
+        assert_equal(1, errors.size)
+      end
+    end
+  end
 end