graphql 0.18.11 → 0.18.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1878fc3aef9f2315438da1dc338f7a6254ed83ca
-  data.tar.gz: 1f894a00b663c83b7b1bb33f2fda113dd8851f1e
+  metadata.gz: fbb584f225769c48d6c7d9878ff6d237068f0c5b
+  data.tar.gz: cf2c4052c0b5facfcf788524bf6a9b3b1b89b167
 SHA512:
-  metadata.gz: d14b02503088c21f6795c91a8b7eccfa7ed9d7cac10f06b388368ec3a1730e32e504166da603de22c2303a952af0778d1bb8190f0620df1bbb24dd9bb23a2c88
-  data.tar.gz: 790684129a750601ce3fb2cd71455ba1c6afece4f4be047f260161436e2cfca3f01c3d2cc9dd147f3f03eeb2bdac5d3c1bcb44acd420b40c99158e23eca650e7
+  metadata.gz: 4d09502f2198d2e0cc265db03d49bc80061c999e23471615622793b8d7ef25cea10e7a9fbd4ff48302f01453ae36652cb8c9b6fcca1ceac8c8c17578d3f2beb7
+  data.tar.gz: 81eb4cd1c6d3f00f9770a6929da390caac133266b89bd3c1ad8737ce8fd53a4cd750942db35332c34ba856559c1bfa53f33e82777a8b88b08eec74fda9921e2e

data/lib/graphql/analysis.rb

@@ -3,3 +3,4 @@ require "graphql/analysis/max_query_depth"
 require "graphql/analysis/query_complexity"
 require "graphql/analysis/query_depth"
 require "graphql/analysis/analyze_query"
+require "graphql/analysis/field_usage"

data/lib/graphql/analysis/field_usage.rb

@@ -0,0 +1,44 @@
+module GraphQL
+  module Analysis
+    # A query reducer for tracking both field usage and deprecated field usage.
+    #
+    # @example Logging field usage and deprecated field usage
+    #   Schema.query_analyzers << GraphQL::Analysis::FieldUsage.new { |query, used_fields, used_deprecated_fields|
+    #     puts "Used GraphQL fields: #{used_fields.join(', ')}"
+    #     puts "Used deprecated GraphQL fields: #{used_deprecated_fields.join(', ')}"
+    #   }
+    #   Schema.execute(query_str)
+    #   # Used GraphQL fields: Cheese.id, Cheese.fatContent, Query.cheese
+    #   # Used deprecated GraphQL fields: Cheese.fatContent
+    #
+    class FieldUsage
+      def initialize(&block)
+        @field_usage_handler = block
+      end
+
+      def initial_value(query)
+        {
+          query: query,
+          used_fields: Set.new,
+          used_deprecated_fields: Set.new
+        }
+      end
+
+      def call(memo, visit_type, irep_node)
+        if irep_node.ast_node.is_a?(GraphQL::Language::Nodes::Field) && visit_type == :leave
+          irep_node.definitions.each do |type_defn, field_defn|
+            field = "#{type_defn.name}.#{field_defn.name}"
+            memo[:used_fields] << field
+            memo[:used_deprecated_fields] << field if field_defn.deprecation_reason
+          end
+        end
+
+        memo
+      end
+
+      def final_value(memo)
+        @field_usage_handler.call(memo[:query], memo[:used_fields].to_a, memo[:used_deprecated_fields].to_a)
+      end
+    end
+  end
+end

data/lib/graphql/internal_representation/rewrite.rb

@@ -33,7 +33,7 @@ module GraphQL
 
         visitor[Nodes::OperationDefinition].enter << -> (ast_node, prev_ast_node) {
           node = Node.new(
-            return_type: context.type_definition.unwrap,
+            return_type: context.type_definition && context.type_definition.unwrap,
             ast_node: ast_node,
             name: ast_node.name,
             parent: nil,

data/lib/graphql/query/arguments.rb

@@ -20,6 +20,12 @@ module GraphQL
         @argument_values[key.to_s]
       end
 
+      # @param key [String, Symbol] name of value to access
+      # @return [Boolean] true if the argument was present in this field
+      def key?(key)
+        @argument_values.key?(key.to_s)
+      end
+
       # Get the original Ruby hash
       # @return [Hash] the original values hash
       def to_h

data/lib/graphql/query/literal_input.rb

@@ -16,14 +16,25 @@ module GraphQL
         values_hash = {}
         argument_defns.each do |arg_name, arg_defn|
           ast_arg = ast_arguments.find { |ast_arg| ast_arg.name == arg_name }
-          arg_value = nil
-          if ast_arg
-            arg_value = coerce(arg_defn.type, ast_arg.value, variables)
-          end
-          if arg_value.nil?
-            arg_value = arg_defn.type.coerce_input(arg_defn.default_value)
+          arg_default_value = arg_defn.type.coerce_input(arg_defn.default_value)
+          if ast_arg.nil? && arg_default_value.nil?
+            # If it wasn't in the document,
+            # and there's no provided default,
+            # then don't pass it to the resolve function
+            next
+          else
+            arg_value = nil
+
+            if ast_arg
+              arg_value = coerce(arg_defn.type, ast_arg.value, variables)
+            end
+
+            if arg_value.nil?
+              arg_value = arg_default_value
+            end
+
+            values_hash[arg_name] = arg_value
           end
-          values_hash[arg_name] = arg_value
         end
         GraphQL::Query::Arguments.new(values_hash)
       end

data/lib/graphql/static_validation/all_rules.rb

@@ -24,6 +24,8 @@ module GraphQL
       GraphQL::StaticValidation::VariableDefaultValuesAreCorrectlyTyped,
       GraphQL::StaticValidation::VariablesAreUsedAndDefined,
       GraphQL::StaticValidation::VariableUsagesAreAllowed,
+      GraphQL::StaticValidation::MutationRootExists,
+      GraphQL::StaticValidation::SubscriptionRootExists,
     ]
   end
 end

data/lib/graphql/static_validation/rules/mutation_root_exists.rb

@@ -0,0 +1,20 @@
+module GraphQL
+  module StaticValidation
+    class MutationRootExists
+      include GraphQL::StaticValidation::Message::MessageHelper
+
+      def validate(context)
+        return if context.schema.mutation
+
+        visitor = context.visitor
+
+        visitor[GraphQL::Language::Nodes::OperationDefinition].enter << -> (ast_node, prev_ast_node) {
+          if ast_node.operation_type == 'mutation'
+            context.errors << message('Schema is not configured for mutations', ast_node, context: context)
+            return GraphQL::Language::Visitor::SKIP
+          end
+        }
+      end
+    end
+  end
+end

data/lib/graphql/static_validation/rules/subscription_root_exists.rb

@@ -0,0 +1,20 @@
+module GraphQL
+  module StaticValidation
+    class SubscriptionRootExists
+      include GraphQL::StaticValidation::Message::MessageHelper
+
+      def validate(context)
+        return if context.schema.subscription
+
+        visitor = context.visitor
+
+        visitor[GraphQL::Language::Nodes::OperationDefinition].enter << -> (ast_node, prev_ast_node) {
+          if ast_node.operation_type == 'subscription'
+            context.errors << message('Schema is not configured for subscriptions', ast_node, context: context)
+            return GraphQL::Language::Visitor::SKIP
+          end
+        }
+      end
+    end
+  end
+end

data/lib/graphql/version.rb

@@ -1,3 +1,3 @@
 module GraphQL
-  VERSION = "0.18.11"
+  VERSION = "0.18.12"
 end

data/readme.md

@@ -137,3 +137,16 @@ If you're building a backend for [Relay](http://facebook.github.io/relay/), you'
   - If the new edge isn't a member of the connection's objects, raise a nice error
 - Missing Enum value should raise a descriptive error, not "key not found"
 - `args` should whitelist keys -- if you request a key that isn't defined for the field, it should 💥
+- Fix middleware
+  - Handle out-of-bounds lookup, eg `graphql-batch`
+  - Handle non-serial execution, eg `@defer`
+- Support non-instance-eval `.define`, eg `.define { |defn| ... }`
+- First-class promise support
+  - like `graphql-batch` but more local
+  - support promises in connection resolves
+- Add immutable transformation API to AST
+  - Support working with AST as data
+  - Adding fields to selections (`__typename` can go anywhere, others are type-specific)
+  - Renaming fragments from local names to unique names
+- Support AST subclasses? This would be hard, I think classes are used as hash keys in many places.
+- Support object deep-copy (schema, type, field, argument)? To support multiple schemas based on the same types.

data/spec/graphql/analysis/field_usage_spec.rb

@@ -0,0 +1,61 @@
+require "spec_helper"
+
+describe GraphQL::Analysis::FieldUsage do
+  let(:result) { [] }
+  let(:field_usage_analyzer) { GraphQL::Analysis::FieldUsage.new { |query, used_fields, used_deprecated_fields| result << query << used_fields << used_deprecated_fields } }
+  let(:reduce_result) { GraphQL::Analysis.analyze_query(query, [field_usage_analyzer]) }
+  let(:query) { GraphQL::Query.new(DummySchema, query_string, variables: variables) }
+  let(:variables) { {} }
+
+  describe "query with deprecated fields" do
+    let(:query_string) {%|
+      query {
+        cheese(id: 1) {
+          id
+          fatContent
+        }
+      }
+    |}
+
+    it "returns query in reduced result" do
+      reduce_result
+      assert_equal query, result[0]
+    end
+
+    it "keeps track of used fields" do
+      reduce_result
+      assert_equal ['Cheese.id', 'Cheese.fatContent', 'Query.cheese'], result[1]
+    end
+
+    it "keeps track of deprecated fields" do
+      reduce_result
+      assert_equal ['Cheese.fatContent'], result[2]
+    end
+  end
+
+  describe "query with deprecated fields used more than once" do
+    let(:query_string) {%|
+      query {
+        cheese1: cheese(id: 1) {
+          id
+          fatContent
+        }
+
+        cheese2: cheese(id: 2) {
+          id
+          fatContent
+        }
+      }
+    |}
+
+    it "omits duplicate usage of a field" do
+      reduce_result
+      assert_equal ['Cheese.id', 'Cheese.fatContent', 'Query.cheese'], result[1]
+    end
+
+    it "omits duplicate usage of a deprecated field" do
+      reduce_result
+      assert_equal ['Cheese.fatContent'], result[2]
+    end
+  end
+end

data/spec/graphql/query/arguments_spec.rb

@@ -22,4 +22,86 @@ describe GraphQL::Query::Arguments do
   it "returns original Ruby hash values with to_h" do
     assert_equal({ a: 1, b: 2, c: { d: 3, e: 4 } }, arguments.to_h)
   end
+
+  describe "#key?" do
+    let(:arg_values) { [] }
+    let(:schema) {
+      arg_values_array = arg_values
+
+      test_input_type = GraphQL::InputObjectType.define do
+        name "TestInput"
+        argument :a, types.Int
+        argument :b, types.Int, default_value: 2
+        argument :c, types.Int
+        argument :d, types.Int
+      end
+
+      query = GraphQL::ObjectType.define do
+        name "Query"
+        field :argTest, types.Int do
+          argument :a, types.Int
+          argument :b, types.Int, default_value: 2
+          argument :c, types.Int
+          argument :d, test_input_type
+          resolve -> (obj, args, ctx) {
+            arg_values_array << args
+            1
+          }
+        end
+      end
+
+      GraphQL::Schema.define(query: query)
+    }
+
+    it "detects missing keys by string or symbol" do
+      assert_equal true, arguments.key?(:a)
+      assert_equal true, arguments.key?("a")
+      assert_equal false, arguments.key?(:f)
+      assert_equal false, arguments.key?("f")
+    end
+
+    it "works from query literals" do
+      schema.execute("{ argTest(a: 1) }")
+
+      last_args = arg_values.last
+
+      assert_equal true, last_args.key?(:a)
+      # This is present from default value:
+      assert_equal true, last_args.key?(:b)
+      assert_equal false, last_args.key?(:c)
+      assert_equal({"a" => 1, "b" => 2}, last_args.to_h)
+    end
+
+    it "works from variables" do
+      variables = { "arg" => { "a" => 1, "d" => nil } }
+      schema.execute("query ArgTest($arg: TestInput){ argTest(d: $arg) }", variables: variables)
+
+      test_inputs = arg_values.last["d"]
+
+      assert_equal true, test_inputs.key?(:a)
+      # This is present from default value:
+      assert_equal true, test_inputs.key?(:b)
+
+      assert_equal false, test_inputs.key?(:c)
+      # This _was_ present in the variables,
+      # but it was nil, which is not allowed in GraphQL
+      assert_equal false, test_inputs.key?(:d)
+
+      assert_equal({"a" => 1, "b" => 2}, test_inputs.to_h)
+    end
+
+    it "works with variable default values" do
+      schema.execute("query ArgTest($arg: TestInput = {a: 1}){ argTest(d: $arg) }")
+
+      test_defaults = arg_values.last["d"]
+
+      assert_equal true, test_defaults.key?(:a)
+      # This is present from default val
+      assert_equal true, test_defaults.key?(:b)
+
+      assert_equal false, test_defaults.key?(:c)
+      assert_equal false, test_defaults.key?(:d)
+      assert_equal({"a" => 1, "b" => 2}, test_defaults.to_h)
+    end
+  end
 end

data/spec/graphql/static_validation/rules/mutation_root_exists_spec.rb

@@ -0,0 +1,39 @@
+require "spec_helper"
+
+describe GraphQL::StaticValidation::MutationRootExists do
+  let(:query_string) {%|
+    mutation addBagel {
+      introduceShip(input: {shipName: "Bagel"}) {
+        clientMutationId
+        shipEdge {
+          node { name, id }
+        }
+      }
+    }
+  |}
+
+  let(:schema) {
+    query_root = GraphQL::Field.define do
+      name "Query"
+      description "Query root of the system"
+    end
+
+    GraphQL::Schema.define do
+      query query_root
+    end
+  }
+
+  let(:validator) { GraphQL::StaticValidation::Validator.new(schema: schema, rules: [GraphQL::StaticValidation::MutationRootExists]) }
+  let(:query) { GraphQL::Query.new(schema, query_string) }
+  let(:errors) { validator.validate(query)[:errors] }
+
+  it "errors when a mutation is performed on a schema without a mutation root" do
+    assert_equal(1, errors.length)
+    missing_mutation_root_error = {
+      "message"=>"Schema is not configured for mutations",
+      "locations"=>[{"line"=>2, "column"=>5}],
+      "path"=>["mutation addBagel"],
+    }
+    assert_includes(errors, missing_mutation_root_error)
+  end
+end

data/spec/graphql/static_validation/rules/subscription_root_exists_spec.rb

@@ -0,0 +1,34 @@
+require "spec_helper"
+
+describe GraphQL::StaticValidation::SubscriptionRootExists do
+  let(:query_string) {%|
+    subscription {
+      test
+    }
+  |}
+
+  let(:schema) {
+    query_root = GraphQL::Field.define do
+      name "Query"
+      description "Query root of the system"
+    end
+
+    GraphQL::Schema.define do
+      query query_root
+    end
+  }
+
+  let(:validator) { GraphQL::StaticValidation::Validator.new(schema: schema, rules: [GraphQL::StaticValidation::SubscriptionRootExists]) }
+  let(:query) { GraphQL::Query.new(schema, query_string) }
+  let(:errors) { validator.validate(query)[:errors] }
+
+  it "errors when a subscription is performed on a schema without a subscription root" do
+    assert_equal(1, errors.length)
+    missing_subscription_root_error = {
+      "message"=>"Schema is not configured for subscriptions",
+      "locations"=>[{"line"=>2, "column"=>5}],
+      "path"=>["subscription"],
+    }
+    assert_includes(errors, missing_subscription_root_error)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql
 version: !ruby/object:Gem::Version
-  version: 0.18.11
+  version: 0.18.12
 platform: ruby
 authors:
 - Robert Mosolgo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-11 00:00:00.000000000 Z
+date: 2016-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
@@ -246,6 +246,7 @@ files:
 - lib/graphql.rb
 - lib/graphql/analysis.rb
 - lib/graphql/analysis/analyze_query.rb
+- lib/graphql/analysis/field_usage.rb
 - lib/graphql/analysis/max_query_complexity.rb
 - lib/graphql/analysis/max_query_depth.rb
 - lib/graphql/analysis/query_complexity.rb
@@ -376,7 +377,9 @@ files:
 - lib/graphql/static_validation/rules/fragments_are_named.rb
 - lib/graphql/static_validation/rules/fragments_are_on_composite_types.rb
 - lib/graphql/static_validation/rules/fragments_are_used.rb
+- lib/graphql/static_validation/rules/mutation_root_exists.rb
 - lib/graphql/static_validation/rules/required_arguments_are_present.rb
+- lib/graphql/static_validation/rules/subscription_root_exists.rb
 - lib/graphql/static_validation/rules/variable_default_values_are_correctly_typed.rb
 - lib/graphql/static_validation/rules/variable_usages_are_allowed.rb
 - lib/graphql/static_validation/rules/variables_are_input_types.rb
@@ -390,6 +393,7 @@ files:
 - lib/graphql/version.rb
 - readme.md
 - spec/graphql/analysis/analyze_query_spec.rb
+- spec/graphql/analysis/field_usage_spec.rb
 - spec/graphql/analysis/max_query_complexity_spec.rb
 - spec/graphql/analysis/max_query_depth_spec.rb
 - spec/graphql/analysis/query_complexity_spec.rb
@@ -461,7 +465,9 @@ files:
 - spec/graphql/static_validation/rules/fragments_are_named_spec.rb
 - spec/graphql/static_validation/rules/fragments_are_on_composite_types_spec.rb
 - spec/graphql/static_validation/rules/fragments_are_used_spec.rb
+- spec/graphql/static_validation/rules/mutation_root_exists_spec.rb
 - spec/graphql/static_validation/rules/required_arguments_are_present_spec.rb
+- spec/graphql/static_validation/rules/subscription_root_exists_spec.rb
 - spec/graphql/static_validation/rules/variable_default_values_are_correctly_typed_spec.rb
 - spec/graphql/static_validation/rules/variable_usages_are_allowed_spec.rb
 - spec/graphql/static_validation/rules/variables_are_input_types_spec.rb
@@ -502,6 +508,7 @@ specification_version: 4
 summary: A GraphQL server implementation for Ruby
 test_files:
 - spec/graphql/analysis/analyze_query_spec.rb
+- spec/graphql/analysis/field_usage_spec.rb
 - spec/graphql/analysis/max_query_complexity_spec.rb
 - spec/graphql/analysis/max_query_depth_spec.rb
 - spec/graphql/analysis/query_complexity_spec.rb
@@ -573,7 +580,9 @@ test_files:
 - spec/graphql/static_validation/rules/fragments_are_named_spec.rb
 - spec/graphql/static_validation/rules/fragments_are_on_composite_types_spec.rb
 - spec/graphql/static_validation/rules/fragments_are_used_spec.rb
+- spec/graphql/static_validation/rules/mutation_root_exists_spec.rb
 - spec/graphql/static_validation/rules/required_arguments_are_present_spec.rb
+- spec/graphql/static_validation/rules/subscription_root_exists_spec.rb
 - spec/graphql/static_validation/rules/variable_default_values_are_correctly_typed_spec.rb
 - spec/graphql/static_validation/rules/variable_usages_are_allowed_spec.rb
 - spec/graphql/static_validation/rules/variables_are_input_types_spec.rb