graphql 1.6.8 → 1.7.0

data/spec/graphql/tracing/active_support_notifications_tracing_spec.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+require "spec_helper"
+
+describe GraphQL::Tracing::ActiveSupportNotificationsTracing do
+  before do
+    GraphQL::Tracing.install(GraphQL::Tracing::ActiveSupportNotificationsTracing)
+  end
+
+  after do
+    GraphQL::Tracing.uninstall(GraphQL::Tracing::ActiveSupportNotificationsTracing)
+  end
+
+  it "pushes through AS::N" do
+    traces = []
+
+    callback = ->(name, started, finished, id, data) {
+      traces << name
+    }
+
+    query_string = <<-GRAPHQL
+    query Bases($id1: ID!, $id2: ID!){
+      b1: batchedBase(id: $id1) { name }
+      b2: batchedBase(id: $id2) { name }
+    }
+    GRAPHQL
+    first_id = StarWars::Base.first.id
+    last_id = StarWars::Base.last.id
+
+    ActiveSupport::Notifications.subscribed(callback, /^graphql/) do
+      star_wars_query(query_string, {
+        "id1" => first_id,
+        "id2" => last_id,
+      })
+    end
+
+    expected_traces = [
+      "graphql.lex",
+      "graphql.parse",
+      "graphql.validate",
+      "graphql.analyze_query",
+      "graphql.analyze_multiplex",
+      "graphql.execute_field",
+      "graphql.execute_field",
+      "graphql.execute_query",
+      "graphql.lazy_loader",
+      "graphql.execute_field",
+      "graphql.execute_field_lazy",
+      "graphql.execute_field",
+      "graphql.execute_field_lazy",
+      "graphql.execute_field_lazy",
+      "graphql.execute_field_lazy",
+      "graphql.execute_query_lazy",
+      "graphql.execute_multiplex",
+    ]
+    assert_equal expected_traces, traces
+  end
+end

data/spec/graphql/tracing_spec.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+require "spec_helper"
+
+describe GraphQL::Tracing do
+  describe ".trace" do
+    it "delivers the metadata to send_trace, with result and key" do
+      returned_value = nil
+      traces = TestTracing.with_trace  do
+        returned_value = GraphQL::Tracing.trace("something", { some_stuff: true }) do
+          "do stuff"
+        end
+      end
+
+      assert_equal 1, traces.length
+      trace = traces.first
+      assert_equal "something", trace[:key]
+      assert_equal true, trace[:some_stuff]
+      # Any override of .trace must return the block's return value
+      assert_equal "do stuff", returned_value
+    end
+
+    module OtherRandomTracer
+      CALLS = []
+
+      def self.trace(key, metadata)
+        CALLS << key.upcase
+        yield
+      end
+    end
+
+    it "calls multiple tracers" do
+      OtherRandomTracer::CALLS.clear
+      GraphQL::Tracing.install(OtherRandomTracer)
+      # Duplicate install is a no-op
+      GraphQL::Tracing.install(OtherRandomTracer)
+
+      traces = TestTracing.with_trace do
+        GraphQL::Tracing.trace("stuff", { }) { :stuff }
+      end
+
+      assert_equal ["stuff"], traces.map { |t| t[:key] }
+      assert_equal ["STUFF"], OtherRandomTracer::CALLS
+
+      GraphQL::Tracing.uninstall(OtherRandomTracer)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -67,3 +67,35 @@ end
 def star_wars_query(string, variables={}, context: {})
   GraphQL::Query.new(StarWars::Schema, string, variables: variables, context: context).result
 end
+
+module TestTracing
+  class << self
+    def clear
+      traces.clear
+    end
+
+    def traces
+      @traces ||= []
+    end
+
+    def with_trace
+      GraphQL::Tracing.install(self)
+      clear
+      yield
+      GraphQL::Tracing.uninstall(self)
+      traces
+    end
+
+    def trace(key, data)
+      data[:key] = key
+      result = yield
+      data[:result] = result
+      traces << data
+      result
+    end
+  end
+end
+
+if rails_should_be_installed?
+  GraphQL::Tracing.uninstall(GraphQL::Tracing::ActiveSupportNotificationsTracing)
+end

data/spec/support/star_wars/schema.rb

@@ -265,6 +265,37 @@ module StarWars
     function IntroduceShipFunction.new
   end
 
+  # GraphQL-Batch knockoff
+  class LazyLoader
+    def self.defer(ctx, model, id)
+      ids = ctx.namespace(:loading)[model] ||= []
+      ids << id
+      self.new(model: model, id: id, context: ctx)
+    end
+
+    def initialize(model:, id:, context:)
+      @model = model
+      @id = id
+      @context = context
+    end
+
+    def value
+      loaded = @context.namespace(:loaded)[@model] ||= {}
+      if loaded.empty?
+        ids = @context.namespace(:loading)[@model]
+        # Example custom tracing
+        GraphQL::Tracing.trace("lazy_loader", { ids: ids, model: @model}) do
+          records = @model.where(id: ids)
+          records.each do |record|
+            loaded[record.id.to_s] = record
+          end
+        end
+      end
+
+      loaded[@id]
+    end
+  end
+
   class LazyWrapper
     def initialize(value = nil, &block)
       if block_given?
@@ -332,6 +363,13 @@ module StarWars
     field :nodesWithCustomResolver, GraphQL::Relay::Node.plural_field(
       resolve: ->(_, _, _) { [StarWars::DATA["Faction"]["1"], StarWars::DATA["Faction"]["2"]] }
     )
+
+    field :batchedBase, BaseType do
+      argument :id, !types.ID
+      resolve ->(o, a, c) {
+        LazyLoader.defer(c, Base, a["id"])
+      }
+    end
   end
 
   MutationType = GraphQL::ObjectType.define do
@@ -390,6 +428,7 @@ module StarWars
     end
 
     lazy_resolve(LazyWrapper, :value)
+    lazy_resolve(LazyLoader, :value)
 
     instrument(:field, ClassNameRecorder.new(:before_built_ins))
     instrument(:field, ClassNameRecorder.new(:after_built_ins), after_built_ins: true)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql
 version: !ruby/object:Gem::Version
-  version: 1.6.8
+  version: 1.7.0
 platform: ruby
 authors:
 - Robert Mosolgo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-08 00:00:00.000000000 Z
+date: 2017-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -317,6 +317,11 @@ files:
 - lib/graphql/analysis/reducer_state.rb
 - lib/graphql/analysis_error.rb
 - lib/graphql/argument.rb
+- lib/graphql/backtrace.rb
+- lib/graphql/backtrace/inspect_result.rb
+- lib/graphql/backtrace/table.rb
+- lib/graphql/backtrace/traced_error.rb
+- lib/graphql/backtrace/tracer.rb
 - lib/graphql/backwards_compatibility.rb
 - lib/graphql/base_type.rb
 - lib/graphql/boolean_type.rb
@@ -350,12 +355,11 @@ files:
 - lib/graphql/execution.rb
 - lib/graphql/execution/directive_checks.rb
 - lib/graphql/execution/execute.rb
-- lib/graphql/execution/field_result.rb
+- lib/graphql/execution/flatten.rb
 - lib/graphql/execution/lazy.rb
 - lib/graphql/execution/lazy/lazy_method_map.rb
 - lib/graphql/execution/lazy/resolve.rb
 - lib/graphql/execution/multiplex.rb
-- lib/graphql/execution/selection_result.rb
 - lib/graphql/execution/typecast.rb
 - lib/graphql/execution_error.rb
 - lib/graphql/field.rb
@@ -394,6 +398,7 @@ files:
 - lib/graphql/introspection/type_kind_enum.rb
 - lib/graphql/introspection/type_type.rb
 - lib/graphql/introspection/typename_field.rb
+- lib/graphql/invalid_name_error.rb
 - lib/graphql/invalid_null_error.rb
 - lib/graphql/language.rb
 - lib/graphql/language/comments.rb
@@ -407,6 +412,7 @@ files:
 - lib/graphql/language/token.rb
 - lib/graphql/language/visitor.rb
 - lib/graphql/list_type.rb
+- lib/graphql/name_validator.rb
 - lib/graphql/non_null_type.rb
 - lib/graphql/object_type.rb
 - lib/graphql/parse_error.rb
@@ -418,6 +424,7 @@ files:
 - lib/graphql/query/input_validation_result.rb
 - lib/graphql/query/literal_input.rb
 - lib/graphql/query/null_context.rb
+- lib/graphql/query/result.rb
 - lib/graphql/query/serial_execution.rb
 - lib/graphql/query/serial_execution/field_resolution.rb
 - lib/graphql/query/serial_execution/operation_resolution.rb
@@ -504,6 +511,12 @@ files:
 - lib/graphql/static_validation/validator.rb
 - lib/graphql/string_encoding_error.rb
 - lib/graphql/string_type.rb
+- lib/graphql/subscriptions.rb
+- lib/graphql/subscriptions/action_cable_subscriptions.rb
+- lib/graphql/subscriptions/event.rb
+- lib/graphql/subscriptions/instrumentation.rb
+- lib/graphql/tracing.rb
+- lib/graphql/tracing/active_support_notifications_tracing.rb
 - lib/graphql/type_kinds.rb
 - lib/graphql/union_type.rb
 - lib/graphql/unresolved_type_error.rb
@@ -524,6 +537,7 @@ files:
 - spec/graphql/analysis/query_complexity_spec.rb
 - spec/graphql/analysis/query_depth_spec.rb
 - spec/graphql/argument_spec.rb
+- spec/graphql/backtrace_spec.rb
 - spec/graphql/base_type_spec.rb
 - spec/graphql/boolean_type_spec.rb
 - spec/graphql/compatibility/execution_specification_spec.rb
@@ -569,6 +583,7 @@ files:
 - spec/graphql/query/context_spec.rb
 - spec/graphql/query/executor_spec.rb
 - spec/graphql/query/literal_input_spec.rb
+- spec/graphql/query/result_spec.rb
 - spec/graphql/query/serial_execution/value_resolution_spec.rb
 - spec/graphql/query/variables_spec.rb
 - spec/graphql/query_spec.rb
@@ -624,6 +639,9 @@ files:
 - spec/graphql/static_validation/type_stack_spec.rb
 - spec/graphql/static_validation/validator_spec.rb
 - spec/graphql/string_type_spec.rb
+- spec/graphql/subscriptions_spec.rb
+- spec/graphql/tracing/active_support_notifications_tracing_spec.rb
+- spec/graphql/tracing_spec.rb
 - spec/graphql/union_type_spec.rb
 - spec/rails_dependency_sanity_spec.rb
 - spec/spec_helper.rb
@@ -679,6 +697,7 @@ test_files:
 - spec/graphql/analysis/query_complexity_spec.rb
 - spec/graphql/analysis/query_depth_spec.rb
 - spec/graphql/argument_spec.rb
+- spec/graphql/backtrace_spec.rb
 - spec/graphql/base_type_spec.rb
 - spec/graphql/boolean_type_spec.rb
 - spec/graphql/compatibility/execution_specification_spec.rb
@@ -724,6 +743,7 @@ test_files:
 - spec/graphql/query/context_spec.rb
 - spec/graphql/query/executor_spec.rb
 - spec/graphql/query/literal_input_spec.rb
+- spec/graphql/query/result_spec.rb
 - spec/graphql/query/serial_execution/value_resolution_spec.rb
 - spec/graphql/query/variables_spec.rb
 - spec/graphql/query_spec.rb
@@ -779,6 +799,9 @@ test_files:
 - spec/graphql/static_validation/type_stack_spec.rb
 - spec/graphql/static_validation/validator_spec.rb
 - spec/graphql/string_type_spec.rb
+- spec/graphql/subscriptions_spec.rb
+- spec/graphql/tracing/active_support_notifications_tracing_spec.rb
+- spec/graphql/tracing_spec.rb
 - spec/graphql/union_type_spec.rb
 - spec/rails_dependency_sanity_spec.rb
 - spec/spec_helper.rb

data/lib/graphql/execution/field_result.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-module GraphQL
-  module Execution
-    # This is one key-value pair in a GraphQL response.
-    # @api private
-    class FieldResult
-      # @return [Any, Lazy] the GraphQL-ready response value, or a {Lazy} instance
-      attr_reader :value
-
-      # @return [SelectionResult] The result object that this field belongs to
-      attr_reader :owner
-
-      def initialize(type:, value:, owner:)
-        @type = type
-        @owner = owner
-        self.value = value
-      end
-
-      # Set a new value for this field in the response.
-      # It may be updated after resolving a {Lazy}.
-      # If it is {Execute::PROPAGATE_NULL}, tell the owner to propagate null.
-      # If the value is a {SelectionResult}, make a link with it, and if it's already null,
-      # propagate the null as needed.
-      # If it's {Execute::Execution::SKIP}, remove this field result from its parent
-      # @param new_value [Any] The GraphQL-ready value
-      def value=(new_value)
-        if new_value.is_a?(SelectionResult)
-          if new_value.invalid_null?
-            new_value = GraphQL::Execution::Execute::PROPAGATE_NULL
-          else
-            new_value.owner = self
-          end
-        end
-
-        case new_value
-        when GraphQL::Execution::Execute::PROPAGATE_NULL
-          if @type.kind.non_null?
-            @owner.propagate_null
-          else
-            @value = nil
-          end
-        when GraphQL::Execution::Execute::SKIP
-          @owner.delete(self)
-        else
-          @value = new_value
-        end
-      end
-
-      def inspect
-        "#<FieldResult #{value.inspect} (#{@type})>"
-      end
-    end
-  end
-end

data/lib/graphql/execution/selection_result.rb

@@ -1,90 +0,0 @@
-# frozen_string_literal: true
-module GraphQL
-  module Execution
-    # A set of key-value pairs suitable for a GraphQL response.
-    # @api private
-    class SelectionResult
-      def initialize
-        @storage = {}
-        @owner = nil
-        @invalid_null = false
-      end
-
-      # @param key [String] The name for this value in the result
-      # @param field_result [FieldResult] The result for this field
-      def set(key, field_result)
-        @storage[key] = field_result
-      end
-
-      # @param key [String] The name of an already-defined result
-      # @return [FieldResult] The result for this field
-      def fetch(key)
-        @storage.fetch(key)
-      end
-
-      # Visit each key-result pair in this result
-      def each
-        @storage.each do |key, field_res|
-          yield(key, field_res)
-        end
-      end
-
-      # @return [Hash] A plain Hash representation of this result
-      def to_h
-        if @invalid_null
-          nil
-        else
-          flatten(self)
-        end
-      end
-
-      # TODO this should delete by key, ya dummy
-      def delete(field_result)
-        @storage.delete_if { |k, v| v == field_result }
-      end
-
-      # A field has been unexpectedly nullified.
-      # Tell the owner {FieldResult} if it is present.
-      # Record {#invalid_null} in case an owner is added later.
-      def propagate_null
-        if @owner
-          @owner.value = GraphQL::Execution::Execute::PROPAGATE_NULL
-        end
-        @invalid_null = true
-      end
-
-      # @return [Boolean] True if this selection has been nullified by a null child
-      def invalid_null?
-        @invalid_null
-      end
-
-      # @param field_result [FieldResult] The field that this selection belongs to (used for propagating nulls)
-      def owner=(field_result)
-        if @owner
-          raise("Can't change owners of SelectionResult")
-        else
-          @owner = field_result
-        end
-      end
-
-      private
-
-      def flatten(obj)
-        case obj
-        when SelectionResult
-          flattened = {}
-          obj.each do |key, val|
-            flattened[key] = flatten(val)
-          end
-          flattened
-        when Array
-          obj.map { |v| flatten(v) }
-        when FieldResult
-          flatten(obj.value)
-        else
-          obj
-        end
-      end
-    end
-  end
-end