graphql 2.0.32 → 2.1.0

data/lib/graphql/schema/warden.rb

@@ -4,37 +4,12 @@ require 'set'
 
 module GraphQL
   class Schema
-    # Restrict access to a {GraphQL::Schema} with a user-defined filter.
+    # Restrict access to a {GraphQL::Schema} with a user-defined `visible?` implementations.
     #
     # When validating and executing a query, all access to schema members
     # should go through a warden. If you access the schema directly,
     # you may show a client something that it shouldn't be allowed to see.
     #
-    # @example Hiding private fields
-    #   private_members = -> (member, ctx) { member.metadata[:private] }
-    #   result = Schema.execute(query_string, except: private_members)
-    #
-    # @example Custom filter implementation
-    #   # It must respond to `#call(member)`.
-    #   class MissingRequiredFlags
-    #     def initialize(user)
-    #       @user = user
-    #     end
-    #
-    #     # Return `false` if any required flags are missing
-    #     def call(member, ctx)
-    #       member.metadata[:required_flags].any? do |flag|
-    #         !@user.has_flag?(flag)
-    #       end
-    #     end
-    #   end
-    #
-    #   # Then, use the custom filter in query:
-    #   missing_required_flags = MissingRequiredFlags.new(current_user)
-    #
-    #   # This query can only access members which match the user's flags
-    #   result = Schema.execute(query_string, except: missing_required_flags)
-    #
     # @api private
     class Warden
       def self.from_context(context)
@@ -114,22 +89,16 @@ module GraphQL
         def interfaces(obj_type); obj_type.interfaces; end
       end
 
-      # @param filter [<#call(member)>] Objects are hidden when `.call(member, ctx)` returns true
       # @param context [GraphQL::Query::Context]
       # @param schema [GraphQL::Schema]
-      def initialize(filter = nil, context:, schema:)
+      def initialize(context:, schema:)
         @schema = schema
         # Cache these to avoid repeated hits to the inheritance chain when one isn't present
         @query = @schema.query
         @mutation = @schema.mutation
         @subscription = @schema.subscription
         @context = context
-        @visibility_cache = if filter
-          read_through { |m| filter.call(m, context) }
-        else
-          read_through { |m| schema.visible?(m, context) }
-        end
-
+        @visibility_cache = read_through { |m| schema.visible?(m, context) }
         @visibility_cache.compare_by_identity
         # Initialize all ivars to improve object shape consistency:
         @types = @visible_types = @reachable_types = @visible_parent_fields =

data/lib/graphql/schema.rb

@@ -222,7 +222,7 @@ module GraphQL
       # @param include_specified_by_url [Boolean] If true, scalar types' `specifiedByUrl:` will be included in the response
       # @param include_is_one_of [Boolean] If true, `isOneOf: true|false` will be included with input objects
       # @return [Hash] GraphQL result
-      def as_json(only: nil, except: nil, context: {}, include_deprecated_args: true, include_schema_description: false, include_is_repeatable: false, include_specified_by_url: false, include_is_one_of: false)
+      def as_json(context: {}, include_deprecated_args: true, include_schema_description: false, include_is_repeatable: false, include_specified_by_url: false, include_is_one_of: false)
         introspection_query = Introspection.query(
           include_deprecated_args: include_deprecated_args,
           include_schema_description: include_schema_description,
@@ -231,16 +231,14 @@ module GraphQL
           include_specified_by_url: include_specified_by_url,
         )
 
-        execute(introspection_query, only: only, except: except, context: context).to_h
+        execute(introspection_query, context: context).to_h
       end
 
       # Return the GraphQL IDL for the schema
       # @param context [Hash]
-      # @param only [<#call(member, ctx)>]
-      # @param except [<#call(member, ctx)>]
       # @return [String]
-      def to_definition(only: nil, except: nil, context: {})
-        GraphQL::Schema::Printer.print_schema(self, only: only, except: except, context: context)
+      def to_definition(context: {})
+        GraphQL::Schema::Printer.print_schema(self, context: context)
       end
 
       # Return the GraphQL::Language::Document IDL AST for the schema
@@ -268,20 +266,6 @@ module GraphQL
         @find_cache[path] ||= @finder.find(path)
       end
 
-      def default_filter
-        GraphQL::Filter.new(except: default_mask)
-      end
-
-      def default_mask(new_mask = nil)
-        if new_mask
-          line = caller(2, 10).find { |l| !l.include?("lib/graphql") }
-          GraphQL::Deprecation.warn("GraphQL::Filter and Schema.mask are deprecated and will be removed in v2.1.0. Implement `visible?` on your schema members instead (https://graphql-ruby.org/authorization/visibility.html).\n  #{line}")
-          @own_default_mask = new_mask
-        else
-          @own_default_mask || find_inherited_value(:default_mask, Schema::NullMask)
-        end
-      end
-
       def static_validator
         GraphQL::StaticValidation::Validator.new(schema: self)
       end

data/lib/graphql/static_validation/validation_context.rb

@@ -8,9 +8,6 @@ module GraphQL
     # It provides access to the schema & fragments which validators may read from.
     #
     # It holds a list of errors which each validator may add to.
-    #
-    # It also provides limited access to the {TypeStack} instance,
-    # which tracks state as you climb in and out of different fields.
     class ValidationContext
       extend Forwardable
 

data/lib/graphql/static_validation.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 require "graphql/static_validation/error"
 require "graphql/static_validation/definition_dependencies"
-require "graphql/static_validation/type_stack"
 require "graphql/static_validation/validator"
 require "graphql/static_validation/validation_context"
 require "graphql/static_validation/validation_timeout_error"

data/lib/graphql/subscriptions/action_cable_subscriptions.rb

@@ -124,7 +124,8 @@ module GraphQL
       # This subscription was re-evaluated.
       # Send it to the specific stream where this client was waiting.
       def deliver(subscription_id, result)
-        payload = { result: result.to_h, more: true }
+        has_more = !result.context.namespace(:subscriptions)[:final_update]
+        payload = { result: result.to_h, more: has_more }
         @action_cable.server.broadcast(stream_subscription_name(subscription_id), payload)
       end
 

data/lib/graphql/subscriptions.rb

@@ -125,10 +125,10 @@ module GraphQL
         variables: variables,
         root_value: object,
       }
-      
+
        # merge event's and query's context together
       context.merge!(event.context) unless event.context.nil? || context.nil?
-      
+
       execute_options[:validate] = validate_update?(**execute_options)
       result = @schema.execute(**execute_options)
       subscriptions_context = result.context.namespace(:subscriptions)
@@ -136,11 +136,9 @@ module GraphQL
         result = nil
       end
 
-      unsubscribed = subscriptions_context[:unsubscribed]
-
-      if unsubscribed
+      if subscriptions_context[:unsubscribed] && !subscriptions_context[:final_update]
         # `unsubscribe` was called, clean up on our side
-        # TODO also send `{more: false}` to client?
+        # The transport should also send `{more: false}` to client
         delete_subscription(subscription_id)
         result = nil
       end
@@ -164,7 +162,14 @@ module GraphQL
       res = execute_update(subscription_id, event, object)
       if !res.nil?
         deliver(subscription_id, res)
+
+        if res.context.namespace(:subscriptions)[:unsubscribed]
+          # `unsubscribe` was called, clean up on our side
+          # The transport should also send `{more: false}` to client
+          delete_subscription(subscription_id)
+        end
       end
+
     end
 
     # Event `event` occurred on `object`,

data/lib/graphql/tracing/appoptics_trace.rb

@@ -28,8 +28,6 @@ module GraphQL
         Gem::Version.new('1.0.0')
       end
 
-      # rubocop:disable Development/NoEvalCop This eval takes static inputs at load-time
-
       [
         'lex',
         'parse',
@@ -57,8 +55,6 @@ module GraphQL
         RUBY
       end
 
-      # rubocop:enable Development/NoEvalCop
-
       def execute_field(query:, field:, ast_node:, arguments:, object:)
         return_type = field.type.unwrap
         trace_field = if return_type.kind.scalar? || return_type.kind.enum?

data/lib/graphql/tracing/appsignal_trace.rb

@@ -13,8 +13,6 @@ module GraphQL
         super
       end
 
-      # rubocop:disable Development/NoEvalCop This eval takes static inputs at load-time
-
       {
         "lex" => "lex.graphql",
         "parse" => "parse.graphql",
@@ -45,8 +43,6 @@ module GraphQL
         RUBY
       end
 
-      # rubocop:enable Development/NoEvalCop
-
       def platform_execute_field(platform_key)
         Appsignal.instrument(platform_key) do
           yield

data/lib/graphql/tracing/data_dog_trace.rb

@@ -3,25 +3,25 @@
 module GraphQL
   module Tracing
     module DataDogTrace
-      # @param tracer [#trace] Deprecated
       # @param analytics_enabled [Boolean] Deprecated
       # @param analytics_sample_rate [Float] Deprecated
-      def initialize(tracer: nil, analytics_enabled: false, analytics_sample_rate: 1.0, service: nil, **rest)
+      def initialize(tracer: nil, analytics_enabled: false, analytics_sample_rate: 1.0, service: "ruby-graphql", **rest)
         if tracer.nil?
           tracer = defined?(Datadog::Tracing) ? Datadog::Tracing : Datadog.tracer
         end
         @tracer = tracer
 
-        @analytics_enabled = analytics_enabled
-        @analytics_sample_rate = analytics_sample_rate
+        analytics_available = defined?(Datadog::Contrib::Analytics) \
+            && Datadog::Contrib::Analytics.respond_to?(:enabled?) \
+            && Datadog::Contrib::Analytics.respond_to?(:set_sample_rate)
 
+        @analytics_enabled = analytics_available && Datadog::Contrib::Analytics.enabled?(analytics_enabled)
+        @analytics_sample_rate = analytics_sample_rate
         @service_name = service
         @has_prepare_span = respond_to?(:prepare_span)
         super
       end
 
-      # rubocop:disable Development/NoEvalCop This eval takes static inputs at load-time
-
       {
         'lex' => 'lex.graphql',
         'parse' => 'parse.graphql',
@@ -34,9 +34,12 @@ module GraphQL
       }.each do |trace_method, trace_key|
         module_eval <<-RUBY, __FILE__, __LINE__
           def #{trace_method}(**data)
-            @tracer.trace("#{trace_key}", service: @service_name, type: 'custom') do |span|
-                span.set_tag('component', 'graphql')
-                span.set_tag('operation', '#{trace_method}')
+            @tracer.trace("#{trace_key}", service: @service_name) do |span|
+              span.span_type = 'custom'
+              if defined?(Datadog::Tracing::Metadata::Ext) # Introduced in ddtrace 1.0
+                span.set_tag(Datadog::Tracing::Metadata::Ext::TAG_COMPONENT, 'graphql')
+                span.set_tag(Datadog::Tracing::Metadata::Ext::TAG_OPERATION, '#{trace_method}')
+              end
 
               #{
                 if trace_method == 'execute_multiplex'
@@ -51,8 +54,10 @@ module GraphQL
                   end
                   span.resource = resource if resource
 
-                  # [Deprecated] will be removed in the future
-                  span.set_metric('_dd1.sr.eausr', @analytics_sample_rate) if @analytics_enabled
+                  # For top span of query, set the analytics sample rate tag, if available.
+                  if @analytics_enabled
+                    Datadog::Contrib::Analytics.set_sample_rate(span, @analytics_sample_rate)
+                  end
                   RUBY
                 elsif trace_method == 'execute_query'
                   <<-RUBY
@@ -71,8 +76,6 @@ module GraphQL
         RUBY
       end
 
-      # rubocop:enable Development/NoEvalCop
-
       def execute_field_span(span_key, query, field, ast_node, arguments, object)
         return_type = field.type.unwrap
         trace_field = if return_type.kind.scalar? || return_type.kind.enum?
@@ -86,10 +89,12 @@ module GraphQL
           nil
         end
         if platform_key && trace_field
-          @tracer.trace(platform_key, service: @service_name, type: 'custom') do |span|
-            span.set_tag('component', 'graphql')
-            span.set_tag('operation', span_key)
-
+          @tracer.trace(platform_key, service: @service_name) do |span|
+            span.span_type = 'custom'
+            if defined?(Datadog::Tracing::Metadata::Ext) # Introduced in ddtrace 1.0
+              span.set_tag(Datadog::Tracing::Metadata::Ext::TAG_COMPONENT, 'graphql')
+              span.set_tag(Datadog::Tracing::Metadata::Ext::TAG_OPERATION, span_key)
+            end
             if @has_prepare_span
               prepare_span_data = { query: query, field: field, ast_node: ast_node, arguments: arguments, object: object }
               prepare_span(span_key, prepare_span_data, span)
@@ -120,10 +125,12 @@ module GraphQL
 
       def authorized_span(span_key, object, type, query)
         platform_key = @platform_key_cache[DataDogTrace].platform_authorized_key_cache[type]
-        @tracer.trace(platform_key, service: @service_name, type: 'custom') do |span|
-          span.set_tag('component', 'graphql')
-          span.set_tag('operation', span_key)
-
+        @tracer.trace(platform_key, service: @service_name) do |span|
+          span.span_type = 'custom'
+          if defined?(Datadog::Tracing::Metadata::Ext) # Introduced in ddtrace 1.0
+            span.set_tag(Datadog::Tracing::Metadata::Ext::TAG_COMPONENT, 'graphql')
+            span.set_tag(Datadog::Tracing::Metadata::Ext::TAG_OPERATION, span_key)
+          end
           if @has_prepare_span
             prepare_span(span_key, {object: object, type: type, query: query}, span)
           end
@@ -151,10 +158,12 @@ module GraphQL
 
       def resolve_type_span(span_key, object, type, query)
         platform_key = @platform_key_cache[DataDogTrace].platform_resolve_type_key_cache[type]
-        @tracer.trace(platform_key, service: @service_name, type: 'custom') do |span|
-          span.set_tag('component', 'graphql')
-          span.set_tag('operation', span_key)
-
+        @tracer.trace(platform_key, service: @service_name) do |span|
+          span.span_type = 'custom'
+          if defined?(Datadog::Tracing::Metadata::Ext) # Introduced in ddtrace 1.0
+            span.set_tag(Datadog::Tracing::Metadata::Ext::TAG_COMPONENT, 'graphql')
+            span.set_tag(Datadog::Tracing::Metadata::Ext::TAG_OPERATION, span_key)
+          end
           if @has_prepare_span
             prepare_span(span_key, {object: object, type: type, query: query}, span)
           end

data/lib/graphql/tracing/data_dog_tracing.rb

@@ -15,9 +15,12 @@ module GraphQL
       }
 
       def platform_trace(platform_key, key, data)
-        tracer.trace(platform_key, service: options[:service], type: 'custom') do |span|
-          span.set_tag('component', 'graphql')
-          span.set_tag('operation', key)
+        tracer.trace(platform_key, service: service_name) do |span|
+          span.span_type = 'custom'
+          if defined?(Datadog::Tracing::Metadata::Ext) # Introduced in ddtrace 1.0
+            span.set_tag(Datadog::Tracing::Metadata::Ext::TAG_COMPONENT, 'graphql')
+            span.set_tag(Datadog::Tracing::Metadata::Ext::TAG_OPERATION, key)
+          end
 
           if key == 'execute_multiplex'
             operations = data[:multiplex].queries.map(&:selected_operation_name).join(', ')
@@ -30,8 +33,10 @@ module GraphQL
             end
             span.resource = resource if resource
 
-            # [Deprecated] will be removed in the future
-            span.set_metric('_dd1.sr.eausr', analytics_sample_rate) if analytics_enabled?
+            # For top span of query, set the analytics sample rate tag, if available.
+            if analytics_enabled?
+              Datadog::Contrib::Analytics.set_sample_rate(span, analytics_sample_rate)
+            end
           end
 
           if key == 'execute_query'
@@ -46,6 +51,10 @@ module GraphQL
         end
       end
 
+      def service_name
+        options.fetch(:service, 'ruby-graphql')
+      end
+
       # Implement this method in a subclass to apply custom tags to datadog spans
       # @param key [String] The event being traced
       # @param data [Hash] The runtime data for this event (@see GraphQL::Tracing for keys for each event)
@@ -56,13 +65,18 @@ module GraphQL
       def tracer
         default_tracer = defined?(Datadog::Tracing) ? Datadog::Tracing : Datadog.tracer
 
-        # [Deprecated] options[:tracer] will be removed in the future
         options.fetch(:tracer, default_tracer)
       end
 
+      def analytics_available?
+        defined?(Datadog::Contrib::Analytics) \
+          && Datadog::Contrib::Analytics.respond_to?(:enabled?) \
+          && Datadog::Contrib::Analytics.respond_to?(:set_sample_rate)
+      end
+
       def analytics_enabled?
         # [Deprecated] options[:analytics_enabled] will be removed in the future
-        options.fetch(:analytics_enabled, false)
+        analytics_available? && Datadog::Contrib::Analytics.enabled?(options.fetch(:analytics_enabled, false))
       end
 
       def analytics_sample_rate

data/lib/graphql/tracing/notifications_trace.rb

@@ -16,8 +16,6 @@ module GraphQL
         super
       end
 
-      # rubocop:disable Development/NoEvalCop This eval takes static inputs at load-time
-
       {
         "lex" => "lex.graphql",
         "parse" => "parse.graphql",
@@ -41,8 +39,6 @@ module GraphQL
         RUBY
       end
 
-      # rubocop:enable Development/NoEvalCop
-
       include PlatformTrace
     end
   end

data/lib/graphql/tracing/platform_trace.rb

@@ -39,9 +39,6 @@ module GraphQL
           include(BaseKeyCache)
         }
         child_class.const_set(:KeyCache, key_methods_class)
-
-        # rubocop:disable Development/NoEvalCop This eval takes static inputs at load-time
-
         [:execute_field, :execute_field_lazy].each do |field_trace_method|
           if !child_class.method_defined?(field_trace_method)
             child_class.module_eval <<-RUBY, __FILE__, __LINE__
@@ -94,8 +91,6 @@ module GraphQL
               end
             RUBY
           end
-
-          # rubocop:enable Development/NoEvalCop
         end
       end
 

data/lib/graphql/tracing/prometheus_trace.rb

@@ -13,8 +13,6 @@ module GraphQL
         super(**rest)
       end
 
-      # rubocop:disable Development/NoEvalCop This eval takes static inputs at load-time
-
       {
         'lex' => "graphql.lex",
         'parse' => "graphql.parse",
@@ -32,8 +30,6 @@ module GraphQL
         RUBY
       end
 
-      # rubocop:enable Development/NoEvalCop
-
       def platform_execute_field(platform_key, &block)
         instrument_execution(platform_key, "execute_field", &block)
       end

data/lib/graphql/tracing/scout_trace.rb

@@ -16,8 +16,6 @@ module GraphQL
         super
       end
 
-      # rubocop:disable Development/NoEvalCop This eval takes static inputs at load-time
-
       {
         "lex" => "lex.graphql",
         "parse" => "parse.graphql",
@@ -47,7 +45,6 @@ module GraphQL
         end
         RUBY
       end
-      # rubocop:enable Development/NoEvalCop
 
       def platform_execute_field(platform_key, &block)
         self.class.instrument("GraphQL", platform_key, INSTRUMENT_OPTS, &block)

data/lib/graphql/tracing/statsd_trace.rb

@@ -11,8 +11,6 @@ module GraphQL
         super(**rest)
       end
 
-      # rubocop:disable Development/NoEvalCop This eval takes static inputs at load-time
-
       {
         'lex' => "graphql.lex",
         'parse' => "graphql.parse",
@@ -32,8 +30,6 @@ module GraphQL
         RUBY
       end
 
-      # rubocop:enable Development/NoEvalCop
-
       def platform_execute_field(platform_key, &block)
         @statsd.time(platform_key, &block)
       end

data/lib/graphql/types/relay/connection_behaviors.rb

@@ -13,7 +13,7 @@ module GraphQL
           child_class.node_nullable(true)
           child_class.edges_nullable(true)
           child_class.edge_nullable(true)
-          child_class.module_exec {
+          child_class.module_eval {
             self.edge_type = nil
             self.node_type = nil
             self.edge_class = nil
@@ -67,9 +67,8 @@ module GraphQL
               type: [edge_type_class, null: edge_nullable],
               null: edges_nullable,
               description: "A list of edges.",
+              scope: false, # Assume that the connection was already scoped.
               connection: false,
-              # Assume that the connection was scoped before this step:
-              scope: false,
             }
 
             if field_options
@@ -170,6 +169,24 @@ module GraphQL
             obj_type.field :page_info, GraphQL::Types::Relay::PageInfo, null: false, description: "Information to aid in pagination."
           end
         end
+
+        def edges
+          # Assume that whatever authorization needed to happen
+          # already happened at the connection level.
+          current_runtime_state = Thread.current[:__graphql_runtime_info]
+          query_runtime_state = current_runtime_state[context.query]
+          query_runtime_state.was_authorized_by_scope_items = @object.was_authorized_by_scope_items?
+          @object.edges
+        end
+
+        def nodes
+          # Assume that whatever authorization needed to happen
+          # already happened at the connection level.
+          current_runtime_state = Thread.current[:__graphql_runtime_info]
+          query_runtime_state = current_runtime_state[context.query]
+          query_runtime_state.was_authorized_by_scope_items = @object.was_authorized_by_scope_items?
+          @object.nodes
+        end
       end
     end
   end

data/lib/graphql/types/relay/edge_behaviors.rb

@@ -8,10 +8,17 @@ module GraphQL
           child_class.description("An edge in a connection.")
           child_class.field(:cursor, String, null: false, description: "A cursor for use in pagination.")
           child_class.extend(ClassMethods)
-          child_class.class_exec { self.node_type = nil }
+          child_class.class_eval { self.node_type = nil }
           child_class.node_nullable(true)
         end
 
+        def node
+          current_runtime_state = Thread.current[:__graphql_runtime_info]
+          query_runtime_state = current_runtime_state[context.query]
+          query_runtime_state.was_authorized_by_scope_items = @object.was_authorized_by_scope_items?
+          @object.node
+        end
+
         module ClassMethods
           def inherited(child_class)
             super

data/lib/graphql/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module GraphQL
-  VERSION = "2.0.32"
+  VERSION = "2.1.0"
 end

data/lib/graphql.rb

@@ -103,7 +103,6 @@ require "graphql/schema"
 require "graphql/query"
 require "graphql/types"
 require "graphql/dataloader"
-require "graphql/filter"
 require "graphql/static_validation"
 require "graphql/execution"
 require "graphql/schema/built_in_types"