graphql 1.8.5 → 1.8.6

data/lib/graphql/language/parser.y

@@ -157,7 +157,7 @@ rule
     | schema_keyword
 
   enum_value_definition:
-    enum_name directives_list_opt { return make_node(:EnumValueDefinition, name: val[0], directives: val[1], description: get_description(val[0]), position_source: val[0]) }
+    description_opt enum_name directives_list_opt { return make_node(:EnumValueDefinition, name: val[1], directives: val[2], description: val[0] || get_description(val[1]), position_source: val[0] || val[1]) }
 
   enum_value_definitions:
       enum_value_definition                        { return [val[0]] }
@@ -338,11 +338,20 @@ rule
       EXTEND INPUT name directives_list_opt LCURLY input_value_definition_list RCURLY { return make_node(:InputObjectTypeExtension, name: val[2], directives: val[3], fields: val[5], position_source: val[0]) }
     | EXTEND INPUT name directives_list { return make_node(:InputObjectTypeExtension, name: val[2], directives: val[3], fields: [], position_source: val[0]) }
 
-  scalar_type_definition: SCALAR name directives_list_opt { return make_node(:ScalarTypeDefinition, name: val[1], directives: val[2], description: get_description(val[0]), position_source: val[0]) }
+  description: STRING
+
+  description_opt:
+      /* none */
+    | description
+
+  scalar_type_definition:
+      description_opt SCALAR name directives_list_opt {
+        return make_node(:ScalarTypeDefinition, name: val[2], directives: val[3], description: val[0] || get_description(val[1]), position_source: val[0] || val[1])
+      }
 
   object_type_definition:
-      TYPE name implements_opt directives_list_opt LCURLY field_definition_list RCURLY {
-        return make_node(:ObjectTypeDefinition, name: val[1], interfaces: val[2], directives: val[3], fields: val[5], description: get_description(val[0]), position_source: val[0])
+      description_opt TYPE name implements_opt directives_list_opt LCURLY field_definition_list RCURLY {
+        return make_node(:ObjectTypeDefinition, name: val[2], interfaces: val[3], directives: val[4], fields: val[6], description: val[0] || get_description(val[1]), position_source: val[0] || val[1])
       }
 
   implements_opt:
@@ -363,8 +372,8 @@ rule
     | legacy_interfaces_list name { val[0] << make_node(:TypeName, name: val[1], position_source: val[1]) }
 
   input_value_definition:
-      name COLON type default_value_opt directives_list_opt {
-        return make_node(:InputValueDefinition, name: val[0], type: val[2], default_value: val[3], directives: val[4], description: get_description(val[0]), position_source: val[0])
+      description_opt name COLON type default_value_opt directives_list_opt {
+        return make_node(:InputValueDefinition, name: val[1], type: val[3], default_value: val[4], directives: val[5], description: val[0] || get_description(val[1]), position_source: val[0] || val[1])
       }
 
   input_value_definition_list:
@@ -376,8 +385,8 @@ rule
     | LPAREN input_value_definition_list RPAREN { return val[1] }
 
   field_definition:
-      name arguments_definitions_opt COLON type directives_list_opt {
-        return make_node(:FieldDefinition, name: val[0], arguments: val[1], type: val[3], directives: val[4], description: get_description(val[0]), position_source: val[0])
+      description_opt name arguments_definitions_opt COLON type directives_list_opt {
+        return make_node(:FieldDefinition, name: val[1], arguments: val[2], type: val[4], directives: val[5], description: val[0] || get_description(val[1]), position_source: val[0] || val[1])
       }
 
   field_definition_list:
@@ -386,8 +395,8 @@ rule
     | field_definition_list field_definition { val[0] << val[1] }
 
   interface_type_definition:
-      INTERFACE name directives_list_opt LCURLY field_definition_list RCURLY {
-        return make_node(:InterfaceTypeDefinition, name: val[1], directives: val[2], fields: val[4], description: get_description(val[0]), position_source: val[0])
+      description_opt INTERFACE name directives_list_opt LCURLY field_definition_list RCURLY {
+        return make_node(:InterfaceTypeDefinition, name: val[2], directives: val[3], fields: val[5], description: val[0] || get_description(val[1]), position_source: val[0] || val[1])
       }
 
   union_members:
@@ -395,23 +404,23 @@ rule
     | union_members PIPE name { val[0] << make_node(:TypeName, name: val[2], position_source: val[2]) }
 
   union_type_definition:
-      UNION name directives_list_opt EQUALS union_members {
-        return make_node(:UnionTypeDefinition, name: val[1], directives: val[2], types: val[4], description: get_description(val[0]), position_source: val[0])
+      description_opt UNION name directives_list_opt EQUALS union_members {
+        return make_node(:UnionTypeDefinition, name: val[2], directives: val[3], types: val[5], description: val[0] || get_description(val[1]), position_source: val[0] || val[1])
       }
 
   enum_type_definition:
-      ENUM name directives_list_opt LCURLY enum_value_definitions RCURLY {
-         return make_node(:EnumTypeDefinition, name: val[1], directives: val[2], values: val[4], description: get_description(val[0]), position_source: val[0])
+      description_opt ENUM name directives_list_opt LCURLY enum_value_definitions RCURLY {
+         return make_node(:EnumTypeDefinition, name: val[2], directives: val[3], values: val[5], description: val[0] || get_description(val[1]), position_source: val[0] || val[1])
       }
 
   input_object_type_definition:
-      INPUT name directives_list_opt LCURLY input_value_definition_list RCURLY {
-        return make_node(:InputObjectTypeDefinition, name: val[1], directives: val[2], fields: val[4], description: get_description(val[0]), position_source: val[0])
+      description_opt INPUT name directives_list_opt LCURLY input_value_definition_list RCURLY {
+        return make_node(:InputObjectTypeDefinition, name: val[2], directives: val[3], fields: val[5], description: val[0] || get_description(val[1]), position_source: val[0] || val[1])
       }
 
   directive_definition:
-      DIRECTIVE DIR_SIGN name arguments_definitions_opt ON directive_locations {
-        return make_node(:DirectiveDefinition, name: val[2], arguments: val[3], locations: val[5], description: get_description(val[0]), position_source: val[0])
+      description_opt DIRECTIVE DIR_SIGN name arguments_definitions_opt ON directive_locations {
+        return make_node(:DirectiveDefinition, name: val[3], arguments: val[4], locations: val[6], description: val[0] || get_description(val[1]), position_source: val[0] || val[1])
       }
 
   directive_locations:

data/lib/graphql/query/context.rb

@@ -221,7 +221,7 @@ module GraphQL
 
         def_delegators :@context,
           :[], :[]=, :key?, :fetch, :to_h, :namespace,
-          :spawn, :schema, :warden, :errors,
+          :spawn, :warden, :errors,
           :execution_strategy, :strategy
 
         # @return [GraphQL::Language::Nodes::Field] The AST node for the currently-executing field

data/lib/graphql/query/validation_pipeline.rb

@@ -16,7 +16,6 @@ module GraphQL
     class ValidationPipeline
       def initialize(query:, validate:, parse_error:, operation_name_error:, max_depth:, max_complexity:)
         @validation_errors = []
-        @analysis_errors = []
         @internal_representation = nil
         @validate = validate
         @parse_error = parse_error
@@ -35,12 +34,6 @@ module GraphQL
         @valid
       end
 
-      # @return [Array<GraphQL::AnalysisError>] Errors for this particular query run (eg, exceeds max complexity)
-      def analysis_errors
-        ensure_has_validated
-        @analysis_errors
-      end
-
       # @return [Array<GraphQL::StaticValidation::Message>] Static validation errors for the query string
       def validation_errors
         ensure_has_validated
@@ -86,17 +79,15 @@ module GraphQL
           end
 
           if @validation_errors.none?
-            @query_analyzers = build_analyzers(@schema, @max_depth, @max_complexity)
-            # if query_analyzers.any?
-            #   analysis_results = GraphQL::Analysis.analyze_query(@query, query_analyzers)
-            #   @analysis_errors = analysis_results
-            #     .flatten # accept n-dimensional array
-            #     .select { |r| r.is_a?(GraphQL::AnalysisError) }
-            # end
+            @query_analyzers = build_analyzers(
+              @schema,
+              @max_depth,
+              @max_complexity
+            )
           end
         end
 
-        @valid = @validation_errors.none? && @analysis_errors.none?
+        @valid = @validation_errors.none?
       end
 
       # If there are max_* values, add them,
@@ -104,6 +95,7 @@ module GraphQL
       def build_analyzers(schema, max_depth, max_complexity)
         if max_depth || max_complexity
           qa = schema.query_analyzers.dup
+
           if max_depth
             qa << GraphQL::Analysis::MaxQueryDepth.new(max_depth)
           end

data/lib/graphql/schema/argument.rb

@@ -42,10 +42,17 @@ module GraphQL
         @prepare = prepare
 
         if definition_block
-          instance_eval(&definition_block)
+          if definition_block.arity == 1
+            instance_exec(self, &definition_block)
+          else
+            instance_eval(&definition_block)
+          end
         end
       end
 
+      attr_writer :description
+
+      # @return [String] Documentation for this argument
       def description(text = nil)
         if text
           @description = text

data/lib/graphql/schema/enum_value.rb

@@ -33,6 +33,9 @@ module GraphQL
       # @return [Class] The enum type that owns this value
       attr_reader :owner
 
+      # @return [String] Explains why this value was deprecated (if present, this will be marked deprecated in introspection)
+      attr_accessor :deprecation_reason
+
       def initialize(graphql_name, desc = nil, owner:, description: nil, value: nil, deprecation_reason: nil, &block)
         @graphql_name = graphql_name.to_s
         @description = desc || description

data/lib/graphql/schema/field.rb

@@ -14,6 +14,9 @@ module GraphQL
       # @return [String]
       attr_accessor :description
 
+      # @return [String, nil] If present, the field is marked as deprecated with this documentation
+      attr_accessor :deprecation_reason
+
       # @return [Symbol] Method or hash key to look up
       attr_reader :method_sym
 
@@ -152,7 +155,11 @@ module GraphQL
         @subscription_scope = subscription_scope
 
         if definition_block
-          instance_eval(&definition_block)
+          if definition_block.arity == 1
+            instance_exec(self, &definition_block)
+          else
+            instance_eval(&definition_block)
+          end
         end
       end
 

data/lib/graphql/schema/input_object.rb

@@ -27,7 +27,7 @@ module GraphQL
       attr_reader :arguments
 
       # Ruby-like hash behaviors, read-only
-      def_delegators :@ruby_style_hash, :keys, :values, :each, :any?, :empty?
+      def_delegators :@ruby_style_hash, :keys, :values, :each, :map, :any?, :empty?
 
       def to_h
         @ruby_style_hash.inject({}) do |h, (key, value)|

data/lib/graphql/schema/interface.rb

@@ -43,6 +43,14 @@ module GraphQL
             # In this case, it's been included into another interface.
             # This is how interface inheritance is implemented
 
+            # We need this before we can call `own_interfaces`
+            child_class.extend(Schema::Interface::DefinitionMethods)
+
+            child_class.own_interfaces << self
+            child_class.interfaces.reverse_each do |interface_defn|
+              child_class.extend(interface_defn::DefinitionMethods)
+            end
+
             # Use an instance variable to tell whether it's been included previously or not;
             # You can't use constant detection because constants are brought into scope
             # by `include`, which has already happened at this point.
@@ -52,21 +60,7 @@ module GraphQL
               child_class.const_set(:DefinitionMethods, defn_methods_module)
               child_class.extend(child_class::DefinitionMethods)
             end
-
-            # We need this before we can call `own_interfaces`
-            child_class.extend(Schema::Interface::DefinitionMethods)
-
-            child_class.own_interfaces << self
-            child_class.interfaces.each do |interface_defn|
-              child_class.extend(interface_defn::DefinitionMethods)
-            end
           elsif child_class < GraphQL::Schema::Object
-            # Add all definition methods of this interface and the interfaces it
-            # includes onto the child class.
-            (interfaces + [self] - [GraphQL::Schema::Interface]).each do |interface_defn|
-              child_class.extend(interface_defn::DefinitionMethods)
-            end
-
             # This is being included into an object type, make sure it's using `implements(...)`
             backtrace_line = caller(0, 10).find { |line| line.include?("schema/object.rb") && line.include?("in `implements'")}
             if !backtrace_line

data/lib/graphql/schema/mutation.rb

@@ -86,16 +86,6 @@ module GraphQL
         alias :type :payload_type
         alias :type_expr :payload_type
 
-        # An object class to use for deriving payload types
-        # @param new_class [Class, nil] Defaults to {GraphQL::Schema::Object}
-        # @return [Class]
-        def object_class(new_class = nil)
-          if new_class
-            @object_class = new_class
-          end
-          @object_class || (superclass.respond_to?(:object_class) ? superclass.object_class : GraphQL::Schema::Object)
-        end
-
         def field_class(new_class = nil)
           if new_class
             @field_class = new_class

data/lib/graphql/schema/object.rb

@@ -60,6 +60,10 @@ module GraphQL
         def implements(*new_interfaces)
           new_interfaces.each do |int|
             if int.is_a?(Module)
+              unless int.include?(GraphQL::Schema::Interface)
+                raise "#{int} cannot be implemented since it's not a GraphQL Interface. Use `include` for plain Ruby modules."
+              end
+
               # Include the methods here,
               # `.fields` will use the inheritance chain
               # to find inherited fields

data/lib/graphql/static_validation/validator.rb

@@ -37,8 +37,9 @@ module GraphQL
           end
 
           context.visitor.visit
-          # Post-validation: allow validators to register handlers on rewritten query nodes
           rewrite_result = rewrite.document
+
+          # Post-validation: allow validators to register handlers on rewritten query nodes
           GraphQL::InternalRepresentation::Visit.visit_each_node(rewrite_result.operation_definitions, context.each_irep_node_handlers)
 
           {

data/lib/graphql/subscriptions/action_cable_subscriptions.rb

@@ -92,7 +92,7 @@ module GraphQL
       # It will receive notifications when events come in
       # and re-evaluate the query locally.
       def write_subscription(query, events)
-        channel = query.context[:channel]
+        channel = query.context.fetch(:channel)
         subscription_id = query.context[:subscription_id] ||= build_id
         stream = query.context[:action_cable_stream] ||= SUBSCRIPTION_PREFIX + subscription_id
         channel.stream_from(stream)

data/lib/graphql/tracing.rb

@@ -6,6 +6,11 @@ require "graphql/tracing/data_dog_tracing"
 require "graphql/tracing/new_relic_tracing"
 require "graphql/tracing/scout_tracing"
 require "graphql/tracing/skylight_tracing"
+require "graphql/tracing/prometheus_tracing"
+
+if defined?(PrometheusExporter::Server)
+  require "graphql/tracing/prometheus_tracing/graphql_collector"
+end
 
 module GraphQL
   # Library entry point for performance metric reporting.

data/lib/graphql/tracing/prometheus_tracing.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Tracing
+    class PrometheusTracing < PlatformTracing
+      DEFAULT_WHITELIST = ['execute_field', 'execute_field_lazy'].freeze
+      DEFAULT_COLLECTOR_TYPE = 'graphql'.freeze
+
+      self.platform_keys = {
+        'lex' => "graphql.lex",
+        'parse' => "graphql.parse",
+        'validate' => "graphql.validate",
+        'analyze_query' => "graphql.analyze",
+        'analyze_multiplex' => "graphql.analyze",
+        'execute_multiplex' => "graphql.execute",
+        'execute_query' => "graphql.execute",
+        'execute_query_lazy' => "graphql.execute",
+        'execute_field' => "graphql.execute",
+        'execute_field_lazy' => "graphql.execute"
+      }
+
+      def initialize(opts = {})
+        @client = opts[:client] || PrometheusExporter::Client.default
+        @keys_whitelist = opts[:keys_whitelist] || DEFAULT_WHITELIST
+        @collector_type = opts[:collector_type] || DEFAULT_COLLECTOR_TYPE
+
+        super opts
+      end
+
+      def platform_trace(platform_key, key, data, &block)
+        return yield unless @keys_whitelist.include?(key)
+        instrument_execution(platform_key, key, data, &block)
+      end
+
+      def platform_field_key(type, field)
+        "#{type.name}.#{field.name}"
+      end
+
+      private
+
+      def instrument_execution(platform_key, key, data, &block)
+        start = ::Process.clock_gettime ::Process::CLOCK_MONOTONIC
+        result = block.call
+        duration = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC) - start
+        observe platform_key, key, duration
+        result
+      end
+
+      def observe(platform_key, key, duration)
+        @client.send_json(
+          type: @collector_type,
+          duration: duration,
+          platform_key: platform_key,
+          key: key
+        )
+      end
+    end
+  end
+end

data/lib/graphql/tracing/prometheus_tracing/graphql_collector.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Tracing
+    class PrometheusTracing < PlatformTracing
+      class GraphQLCollector < ::PrometheusExporter::Server::TypeCollector
+        def initialize
+          @graphql_gauge = PrometheusExporter::Metric::Summary.new(
+            'graphql_duration_seconds',
+            'Time spent in GraphQL operations, in seconds'
+          )
+        end
+
+        def type
+          'graphql'
+        end
+
+        def collect(object)
+          labels = { key: object['key'], platform_key: object['platform_key'] }
+          @graphql_gauge.observe object['duration'], labels
+        end
+
+        def metrics
+          [@graphql_gauge]
+        end
+      end
+    end
+  end
+end

data/lib/graphql/tracing/skylight_tracing.rb

@@ -14,10 +14,32 @@ module GraphQL
         "execute_query_lazy" => "graphql.execute",
       }
 
+      # @param set_endpoint_name [Boolean] If true, the GraphQL operation name will be used as the endpoint name.
+      #   This is not advised if you run more than one query per HTTP request, for example, with `graphql-client` or multiplexing.
+      #   It can also be specified per-query with `context[:set_skylight_endpoint_name]`.
+      def initialize(set_endpoint_name: false)
+        @set_endpoint_name = set_endpoint_name
+        super
+      end
+
       def platform_trace(platform_key, key, data)
-        if (query = data[:query])
+        if key == "execute_query"
+          query = data[:query]
           title = query.selected_operation_name || "<anonymous>"
           category = platform_key
+          set_endpoint_name_override = query.context[:set_skylight_endpoint_name]
+          if set_endpoint_name_override == true || (set_endpoint_name_override.nil? && @set_endpoint_name)
+            # Assign the endpoint so that queries will be grouped
+            instrumenter = Skylight.instrumenter
+            if instrumenter
+              current_trace = instrumenter.current_trace
+              if current_trace
+                op_type = query.selected_operation ? query.selected_operation.operation_type : "query"
+                endpoint = "GraphQL/#{op_type}.#{title}"
+                current_trace.endpoint = endpoint
+              end
+            end
+          end
         elsif key.start_with?("execute_field")
           title = platform_key
           category = key