graphql 1.2.6 → 1.3.0

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GraphQL
   module StaticValidation
     class RequiredArgumentsArePresent

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GraphQL
   module StaticValidation
     class SubscriptionRootExists

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GraphQL
   module StaticValidation
     class UniqueDirectivesPerLocation

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GraphQL
   module StaticValidation
     class VariableDefaultValuesAreCorrectlyTyped

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GraphQL
   module StaticValidation
     class VariableUsagesAreAllowed

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GraphQL
   module StaticValidation
     class VariablesAreInputTypes

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GraphQL
   module StaticValidation
     # The problem is

data/lib/graphql/static_validation/type_stack.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GraphQL
   module StaticValidation
     # - Ride along with `GraphQL::Language::Visitor`

data/lib/graphql/static_validation/validation_context.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 module GraphQL
   module StaticValidation
     # The validation context gets passed to each validator.
     #
-    # It exposes a {GraphQL::Language::Visitor} where validators may add hooks. ({Visitor#visit} is called in {Validator#validate})
+    # It exposes a {GraphQL::Language::Visitor} where validators may add hooks. ({Language::Visitor#visit} is called in {Validator#validate})
     #
     # It provides access to the schema & fragments which validators may read from.
     #

data/lib/graphql/static_validation/validator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GraphQL
   module StaticValidation
     # Initialized with a {GraphQL::Schema}, then it can validate {GraphQL::Language::Nodes::Documents}s based on that schema.
@@ -11,7 +12,7 @@ module GraphQL
     #
     class Validator
       # @param schema [GraphQL::Schema]
-      # @param rule [Array<#validate(context)>] a list of rules to use when validating
+      # @param rules [Array<#validate(context)>] a list of rules to use when validating
       def initialize(schema:, rules: GraphQL::StaticValidation::ALL_RULES)
         @schema = schema
         @rules = rules

data/lib/graphql/string_type.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 GraphQL::STRING_TYPE = GraphQL::ScalarType.define do
   name "String"
   description "Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text."

data/lib/graphql/type_kinds.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GraphQL
   # Type kinds are the basic categories which a type may belong to (`Object`, `Scalar`, `Union`...)
   module TypeKinds

data/lib/graphql/union_type.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GraphQL
   # A Union is is a collection of object types which may appear in the same place.
   #
@@ -26,10 +27,17 @@ module GraphQL
     accepts_definitions :possible_types, :resolve_type
     ensure_defined :possible_types
 
+    def initialize_copy(other)
+      super
+      @clean_possible_types = nil
+      @dirty_possible_types = other.dirty_possible_types.dup
+    end
+
     def kind
       GraphQL::TypeKinds::UNION
     end
 
+    # @return [Boolean] True if `child_type_defn` is a member of this {UnionType}
     def include?(child_type_defn)
       possible_types.include?(child_type_defn)
     end
@@ -39,6 +47,7 @@ module GraphQL
       @dirty_possible_types = new_possible_types
     end
 
+    # @return [Array<GraphQL::ObjectType>] Types which may be found in this union
     def possible_types
       @clean_possible_types ||= begin
         if @dirty_possible_types.respond_to?(:map)
@@ -48,5 +57,9 @@ module GraphQL
         end
       end
     end
+
+    protected
+
+    attr_reader :dirty_possible_types
   end
 end

data/lib/graphql/unresolved_type_error.rb

@@ -1,9 +1,30 @@
+# frozen_string_literal: true
 module GraphQL
-  # Error raised when the value provided for a field can't be resolved to one of the possible types
-  # for the field.
-  class UnresolvedTypeError < GraphQL::Error
-    def initialize(field_name, field_type, parent_type, received_type, possible_types)
-      message = %|The value from "#{field_name}" on "#{parent_type}" could not be resolved to "#{field_type}". (Received: #{received_type.inspect}, Expected: [#{possible_types.map(&:inspect).join(", ")}])|
+  # Error raised when the value provided for a field
+  # can't be resolved to one of the possible types for the field.
+  class UnresolvedTypeError < GraphQL::RuntimeTypeError
+    # @return [Object] The runtime value which couldn't be successfully resolved with `resolve_type`
+    attr_reader :value
+
+    # @return [GraphQL::Field] The field whose value couldn't be resolved (`field.type` is type which couldn't be resolved)
+    attr_reader :field
+
+    # @return [GraphQL::BaseType] The owner of `field`
+    attr_reader :parent_type
+
+    # @return [Object] The return of {Schema#resolve_type} for `value`
+    attr_reader :resolved_type
+
+    # @return [Array<GraphQL::BaseType>] The allowed options for resolving `value` to `field.type`
+    attr_reader :possible_types
+
+    def initialize(value, field, parent_type, resolved_type, possible_types)
+      @value = value
+      @field = field
+      @parent_type = parent_type
+      @resolved_type = resolved_type
+      @possible_types = possible_types
+      message = %|The value from "#{field.name}" on "#{parent_type}" could not be resolved to "#{field.type}". (Received: #{resolved_type.inspect}, Expected: [#{possible_types.map(&:inspect).join(", ")}])|
       super(message)
     end
   end

data/lib/graphql/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GraphQL
-  VERSION = "1.2.6"
+  VERSION = "1.3.0"
 end

data/readme.md

@@ -44,7 +44,7 @@ See "Getting Started" on the [website](https://rmosolgo.github.io/graphql-ruby/)
 
 ## To Do
 
-- StaticValidation improvements ([in progress](https://github.com/rmosolgo/graphql-ruby/pull/268))
+- StaticValidation improvements ([in progress ??](https://github.com/rmosolgo/graphql-ruby/pull/268))
   - Use catch-all type/field/argument definitions instead of terminating traversal
   - Reduce ad-hoc traversals?
   - Validators are order-dependent, is this a smell?
@@ -56,11 +56,7 @@ See "Getting Started" on the [website](https://rmosolgo.github.io/graphql-ruby/)
   - If the new edge isn't a member of the connection's objects, raise a nice error
 - `args` should whitelist keys -- if you request a key that isn't defined for the field, it should 💥
 - Support non-instance-eval `.define`, eg `.define { |defn| ... }`
-- First-class promise support ([discussion](https://github.com/rmosolgo/graphql-ruby/issues/274))
-  - 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
-- Document encrypted & versioned cursors

data/spec/graphql/analysis/analyze_query_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe GraphQL::Analysis do

data/spec/graphql/analysis/field_usage_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe GraphQL::Analysis::FieldUsage do

data/spec/graphql/analysis/max_query_complexity_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe GraphQL::Analysis::MaxQueryComplexity do

data/spec/graphql/analysis/max_query_depth_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe GraphQL::Analysis::MaxQueryDepth do

data/spec/graphql/analysis/query_complexity_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe GraphQL::Analysis::QueryComplexity do

data/spec/graphql/analysis/query_depth_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe GraphQL::Analysis::QueryDepth do

data/spec/graphql/argument_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe GraphQL::Argument do

data/spec/graphql/base_type_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe GraphQL::BaseType do
@@ -25,4 +26,16 @@ describe GraphQL::BaseType do
   it "Accepts arbitrary metadata" do
     assert_equal ["Cheese"], CheeseType.metadata[:class_names]
   end
+
+  describe "#dup" do
+    it "resets connection types" do
+      # Make sure the defaults have been calculated
+      cheese_edge = CheeseType.edge_type
+      cheese_conn = CheeseType.connection_type
+      cheese_2 = CheeseType.dup
+      cheese_2.name = "Cheese2"
+      refute_equal cheese_edge, cheese_2.edge_type
+      refute_equal cheese_conn, cheese_2.connection_type
+    end
+  end
 end

data/spec/graphql/boolean_type_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe GraphQL::BOOLEAN_TYPE do

data/spec/graphql/compatibility/execution_specification_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 SerialExecutionSuite = GraphQL::Compatibility::ExecutionSpecification.build_suite(GraphQL::Query::SerialExecution)

data/spec/graphql/compatibility/lazy_execution_specification_spec.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+require "spec_helper"
+
+LazySpecSuite = GraphQL::Compatibility::LazyExecutionSpecification.build_suite(GraphQL::Execution::Execute)

data/spec/graphql/compatibility/query_parser_specification_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 BuiltInQueryParserSuite = GraphQL::Compatibility::QueryParserSpecification.build_suite do |query_string|

data/spec/graphql/compatibility/schema_parser_specification_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 BuiltInSchemaParserSuite = GraphQL::Compatibility::SchemaParserSpecification.build_suite do |query_string|

data/spec/graphql/define/assign_argument_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe GraphQL::Define::AssignArgument do

data/spec/graphql/define/instance_definable_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "date"
 require "spec_helper"
 

data/spec/graphql/directive_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe GraphQL::Directive do

data/spec/graphql/enum_type_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe GraphQL::EnumType do
@@ -88,4 +89,13 @@ describe GraphQL::EnumType do
     enum = GraphQL::EnumType.define(name: "DairyAnimal", values: [cow, goat])
     assert_equal({ "COW" => cow, "GOAT" => goat }, enum.values)
   end
+
+  describe "#dup" do
+    it "copies the values map without altering the original" do
+      enum_2 = enum.dup
+      enum_2.add_value(GraphQL::EnumType::EnumValue.define(name: "MUSKRAT"))
+      assert_equal(6, enum.values.size)
+      assert_equal(7, enum_2.values.size)
+    end
+  end
 end

data/spec/graphql/execution/execute_spec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+require "spec_helper"
+
+ExecuteSuite = GraphQL::Compatibility::ExecutionSpecification.build_suite(GraphQL::Execution::Execute)
+LazyExecuteSuite = GraphQL::Compatibility::LazyExecutionSpecification.build_suite(GraphQL::Execution::Execute)

data/spec/graphql/execution/lazy_spec.rb

@@ -0,0 +1,252 @@
+# frozen_string_literal: true
+require "spec_helper"
+
+describe GraphQL::Execution::Lazy do
+  class Wrapper
+    def initialize(item = nil, &block)
+      if block
+        @block = block
+      else
+        @item = item
+      end
+    end
+
+    def item
+      if @block
+        @item = @block.call()
+        @block = nil
+      end
+      @item
+    end
+  end
+
+  class SumAll
+    attr_reader :own_value
+    attr_accessor :value
+
+    def initialize(ctx, own_value)
+      @own_value = own_value
+      @all = ctx[:__sum_all__] ||= []
+      @all << self
+    end
+
+    def value
+      @value ||= begin
+        total_value = @all.map(&:own_value).reduce(&:+)
+        @all.each { |v| v.value = total_value}
+        @all.clear
+        total_value
+      end
+      @value
+    end
+  end
+
+  LazySum = GraphQL::ObjectType.define do
+    name "LazySum"
+    field :value, types.Int do
+      resolve ->(o, a, c) { o == 13 ? nil : o }
+    end
+    field :nestedSum, !LazySum do
+      argument :value, !types.Int
+      resolve ->(o, args, c) {
+        if args[:value] == 13
+          Wrapper.new(nil)
+        else
+          SumAll.new(c, o + args[:value])
+        end
+      }
+    end
+
+    field :nullableNestedSum, LazySum do
+      argument :value, types.Int
+      resolve ->(o, args, c) {
+        if args[:value] == 13
+          Wrapper.new(nil)
+        else
+          SumAll.new(c, o + args[:value])
+        end
+      }
+    end
+  end
+
+  LazyQuery = GraphQL::ObjectType.define do
+    name "Query"
+    field :int, !types.Int do
+      argument :value, !types.Int
+      argument :plus, types.Int, default_value: 0
+      resolve ->(o, a, c) { Wrapper.new(a[:value] + a[:plus])}
+    end
+
+    field :nestedSum, !LazySum do
+      argument :value, !types.Int
+      resolve ->(o, args, c) { SumAll.new(c, args[:value]) }
+    end
+
+    field :nullableNestedSum, LazySum do
+      argument :value, types.Int
+      resolve ->(o, args, c) {
+        if args[:value] == 13
+          Wrapper.new { raise GraphQL::ExecutionError.new("13 is unlucky") }
+        else
+          SumAll.new(c, args[:value])
+        end
+      }
+    end
+
+    field :listSum, types[LazySum] do
+      argument :values, types[types.Int]
+      resolve ->(o, args, c) { args[:values] }
+    end
+  end
+
+  LazySchema = GraphQL::Schema.define do
+    query(LazyQuery)
+    mutation(LazyQuery)
+    lazy_resolve(Wrapper, :item)
+    lazy_resolve(SumAll, :value)
+  end
+
+  def run_query(query_str)
+    LazySchema.execute(query_str)
+  end
+
+  describe "resolving" do
+    it "calls value handlers" do
+      res = run_query('{  int(value: 2, plus: 1)}')
+      assert_equal 3, res["data"]["int"]
+    end
+
+    it "can do nested lazy values" do
+      res = run_query %|
+      {
+        a: nestedSum(value: 3) {
+          value
+          nestedSum(value: 7) {
+            value
+          }
+        }
+        b: nestedSum(value: 2) {
+          value
+          nestedSum(value: 11) {
+            value
+          }
+        }
+
+        c: listSum(values: [1,2]) {
+          nestedSum(value: 3) {
+            value
+          }
+        }
+      }
+      |
+
+      expected_data = {
+        "a"=>{"value"=>14, "nestedSum"=>{"value"=>46}},
+        "b"=>{"value"=>14, "nestedSum"=>{"value"=>46}},
+        "c"=>[{"nestedSum"=>{"value"=>14}}, {"nestedSum"=>{"value"=>14}}],
+      }
+
+      assert_equal expected_data, res["data"]
+    end
+
+    it "propagates nulls" do
+      res = run_query %|
+      {
+        nestedSum(value: 1) {
+          value
+          nestedSum(value: 2) {
+            nestedSum(value: 13) {
+              value
+            }
+          }
+        }
+      }|
+
+      assert_equal(nil, res["data"])
+      assert_equal 1, res["errors"].length
+
+
+      res = run_query %|
+      {
+        nullableNestedSum(value: 1) {
+          value
+          nullableNestedSum(value: 2) {
+            nestedSum(value: 13) {
+              value
+            }
+          }
+        }
+      }|
+
+      expected_data = {
+        "nullableNestedSum" => {
+          "value" => 1,
+          "nullableNestedSum" => nil,
+        }
+      }
+      assert_equal(expected_data, res["data"])
+      assert_equal 1, res["errors"].length
+    end
+
+    it "handles raised errors" do
+      res = run_query %|
+      {
+        a: nullableNestedSum(value: 1) { value }
+        b: nullableNestedSum(value: 13) { value }
+        c: nullableNestedSum(value: 2) { value }
+      }|
+
+      expected_data = {
+        "a" => { "value" => 3 },
+        "b" => nil,
+        "c" => { "value" => 3 },
+      }
+      assert_equal expected_data, res["data"]
+
+      expected_errors = [{
+        "message"=>"13 is unlucky",
+        "locations"=>[{"line"=>4, "column"=>9}],
+        "path"=>["b"],
+      }]
+      assert_equal expected_errors, res["errors"]
+    end
+
+    it "resolves mutation fields right away" do
+      res = run_query %|
+      {
+        a: nestedSum(value: 2) { value }
+        b: nestedSum(value: 4) { value }
+        c: nestedSum(value: 6) { value }
+      }|
+
+      assert_equal [12, 12, 12], res["data"].values.map { |d| d["value"] }
+
+      res = run_query %|
+      mutation {
+        a: nestedSum(value: 2) { value }
+        b: nestedSum(value: 4) { value }
+        c: nestedSum(value: 6) { value }
+      }
+      |
+
+      assert_equal [2, 4, 6], res["data"].values.map { |d| d["value"] }
+    end
+  end
+
+  describe "LazyMethodMap" do
+    class SubWrapper < Wrapper; end
+
+    let(:map) { GraphQL::Execution::Lazy::LazyMethodMap.new }
+
+    it "finds methods for classes and subclasses" do
+      map.set(Wrapper, :item)
+      map.set(SumAll, :value)
+      b = Wrapper.new(1)
+      sub_b = Wrapper.new(2)
+      s = SumAll.new({}, 3)
+      assert_equal(:item, map.get(b))
+      assert_equal(:item, map.get(sub_b))
+      assert_equal(:value, map.get(s))
+    end
+  end
+end