graphql-metrics 4.1.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c32ac33ad3d4dcce935518115cb51e8b619b4f06e5eaacf6eded57b0393e8d1
-  data.tar.gz: 466c20309ac8e7ca599580f9145c936bbcb76cb29c9f019fa28c3be3c9c46ba7
+  metadata.gz: 8e2e02bf92da34c67af89cf112efe2525ca4a785f4f9169dd35320c687f5f9f4
+  data.tar.gz: 4ec1a5b37180e5e7be02934992347053d3d4a4d2f03866975600577704e141a1
 SHA512:
-  metadata.gz: fc8fa91436e89b75faa0573007bb20ce3a381019231dcb6131f41a73395b4c62c990be07efadbf437c9f1c67f9a9a03ef328c3d379e57132dcee00332489bf7f
-  data.tar.gz: d465979e9f3b3ea7b7f17c0275a48bd629ab45f80eeb89e69dc7d8040dd8f615e7a23bfefdab0befb04402d192e11dfb818417c65f930dd8fdcdd3eae030715b
+  metadata.gz: 213906efdd58b32a7cab558028fc96de33c9624f9e85ffbb572954486bb31bebc7e718f0aee4e6df4f7324d5c99c6cc1849d13a54e43bef1963a3b55517796e1
+  data.tar.gz: 4f6309cc4cdbe2244be1d744173f795df04e955af9cef6d52111f1181c074cece01dcf226ebe20a545f3f2d41306b5eb5226e4d90ec1a7ece70656707982934a

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+5.0.0
+-----
+- [50](https://github.com/Shopify/graphql-metrics/pull/50) Capture metrics for directives and their arguments.
 4.1.0
 -----
 - [42](https://github.com/Shopify/graphql-metrics/pull/42) Capture timing of the `lex` phase.

data/README.md

@@ -141,13 +141,22 @@ even if you opt to collect them by using `GraphQL::Metrics::Analyzer` and `Graph
       store_metrics(:fields, metrics)
     end
 
+    # @param metrics [Hash] Directive metrics
+    # {
+    #   directive_name: "customDirective",
+    # }
+    def directive_extracted(metrics)
+      store_metrics(:directives, metrics)
+    end
+
     # @param metrics [Hash] Argument usage metrics, including a few details about the query document itself, as well
     # as resolver timings metrics, also ahering to the Apollo Tracing spec referred to above.
     # {
-    #   argument_name: "id",
+    #   argument_name: "ids",
     #   argument_type_name: "ID",
-    #   parent_field_name: "post",
-    #   parent_field_type_name: "QueryRoot",
+    #   parent_name: "comments",
+    #   grandparent_type_name: "Post",
+    #   grandparent_node_name: "post",
     #   default_used: false,
     #   value_is_null: false,
     #   value: <GraphQL::Query::Arguments::ArgumentValue>,
@@ -171,6 +180,65 @@ even if you opt to collect them by using `GraphQL::Metrics::Analyzer` and `Graph
 
 Once defined, you can opt into capturing all metrics seen above by simply including GraphQL::Metrics as a plugin on your
 schema.
+#### Metrics that are captured for arguments for fields and directives
+
+Let's have a query example
+
+```graphql
+query PostDetails($postId: ID!, $commentsTags: [String!] = null, $val: Int!) @customDirective(val: $val) {
+  post(id: $postId) {
+    title @skip(if: true)
+    comments(ids: [1, 2], tags: $commentsTags) {
+      id
+      body
+    }
+  }
+}
+```
+These are some of the arguments that are extracted
+
+```ruby
+{
+  argument_name: "if",                    # argument name
+  argument_type_name: "Boolean",          # argument type
+  parent_name: "skip",                    # argument belongs to `skip` directive
+  grandparent_type_name: "__Directive",   # argument was applied to directive
+  grandparent_node_name: "title",         # directive was applied to field title
+  default_used: false,                    # check if default value was used
+  value_is_null: false,                   # check if value was null
+  value: <GraphQL::Execution::Interpreter::ArgumentValue>
+}, {
+  argument_name: "id",
+  argument_name: "ids",
+  argument_type_name: "ID",
+  parent_name: "comments",                # name of the node that argument was applied to
+  grandparent_type_name: "Post",          # grandparent node to uniquely identify which node the argument was applied to
+  grandparent_node_name: "post",          # name of grandparend node
+  default_used: false,
+  value_is_null: false,
+  value: <GraphQL::Execution::Interpreter::ArgumentValue>
+}, {
+  argument_name: "id",
+  argument_type_name: "ID",
+  parent_name: "post",                   # argument applied to post field
+  grandparent_type_name: "QueryRoot",    # post is a QueryRoot
+  grandparent_node_name: "query",        # post field is already in the query root
+  parent_input_object_type: nil,
+  default_used: false,
+  value_is_null: false,
+  value: <GraphQL::Execution::Interpreter::ArgumentValue>
+}, {
+  argument_name: "val",
+  argument_type_name: "Int",
+  parent_name: "customDirective",        # argument belongs to `customDirective` directive
+  grandparent_type_name: "__Directive",  # argument was applied to directive
+  grandparent_node_name: "query",        # directive was applied to query
+  parent_input_object_type: nil,
+  default_used: false,
+  value_is_null: false,
+  value: <GraphQL::Execution::Interpreter::ArgumentValue>
+}
+```
 
 ### Make use of your analyzer
 
@@ -219,11 +287,11 @@ order in which methods defined on `GraphQL::Metrics::Instrumentation`, `GraphQL:
 Although you ideally will not need to care about these details if you are simply using this gem to gather metrics in
 your application as intended, here's a breakdown of the order of execution of the methods involved:
 
- When used as instrumentation, an analyzer and tracing, the order of execution is:
+ When used as instrumentation, an analyzer and tracing, the order of execution is usually:
 
+* Tracer.capture_multiplex_start_time
 * Tracer.capture_lexing_time
 * Tracer.capture_parsing_time
-* Tracer.capture_multiplex_start_time
 * Instrumentation.before_query (context setup)
 * Tracer.capture_validation_time
 * Tracer.capture_analysis_time

data/graphql_metrics.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "graphql", ">= 1.10.8"
+  spec.add_runtime_dependency "graphql", ">= 1.12.10"
   spec.add_runtime_dependency "concurrent-ruby", "~> 1.1.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"

data/lib/graphql/metrics/analyzer.rb

@@ -4,6 +4,7 @@ module GraphQL
   module Metrics
     class Analyzer < GraphQL::Analysis::AST::Analyzer
       attr_reader :query
+      DIRECTIVE_TYPE = "__Directive"
 
       def initialize(query_or_multiplex)
         super
@@ -31,20 +32,16 @@ module GraphQL
         }
       end
 
-      def on_leave_field(node, _parent, visitor)
+      def on_leave_field(node, parent, visitor)
         return if visitor.field_definition.introspection?
         return if query.context[SKIP_FIELD_AND_ARGUMENT_METRICS]
 
-        # Arguments can raise execution errors within their `prepare` methods
-        # which aren't properly handled during analysis so we have to handle
-        # them ourselves safely and return `nil`.
-        argument_values = begin
-          query.arguments_for(node, visitor.field_definition)
-        rescue ::GraphQL::ExecutionError
-          nil
-        end
-
-        extract_arguments(argument_values, visitor.field_definition) if argument_values
+        argument_values = arguments_for(node, visitor.field_definition)
+        extract_arguments(
+          argument: argument_values,
+          definition: visitor.field_definition,
+          parent: parent
+        ) if argument_values
 
         static_metrics = {
           field_name: node.name,
@@ -80,6 +77,17 @@ module GraphQL
         end
       end
 
+      def on_enter_directive(node, parent, visitor)
+        argument_values = arguments_for(node, visitor.directive_definition)
+        extract_arguments(
+          argument: argument_values,
+          definition: visitor.directive_definition,
+          parent: parent
+        ) if argument_values
+
+        directive_extracted({ directive_name: node.name })
+      end
+
       def result
         return if GraphQL::Metrics.timings_capture_enabled?(query.context)
         return if query.context[GraphQL::Metrics::SKIP_GRAPHQL_METRICS_ANALYSIS]
@@ -93,37 +101,91 @@ module GraphQL
 
       private
 
-      def extract_arguments(argument, field_defn, parent_input_object = nil)
+      def arguments_for(node, definition)
+        # Arguments can raise execution errors within their `prepare` methods
+        # which aren't properly handled during analysis so we have to handle
+        # them ourselves safely and return `nil`.
+        query.arguments_for(node, definition)
+      rescue ::GraphQL::ExecutionError
+        nil
+      end
+
+      def extract_arguments(argument:, definition:, parent:, parent_input_object: nil)
         case argument
         when Array
           argument.each do |a|
-            extract_arguments(a, field_defn, parent_input_object)
+            extract_arguments(
+              argument: a,
+              definition: definition,
+              parent_input_object: parent_input_object,
+              parent: parent
+            )
           end
         when Hash
           argument.each_value do |a|
-            extract_arguments(a, field_defn, parent_input_object)
+            extract_arguments(
+              argument: a,
+              definition: definition,
+              parent_input_object: parent_input_object,
+              parent: parent)
           end
         when ::GraphQL::Execution::Interpreter::Arguments
           argument.each_value do |arg_val|
-            extract_arguments(arg_val, field_defn, parent_input_object)
+            extract_arguments(
+              argument: arg_val,
+              definition: definition,
+              parent_input_object: parent_input_object,
+              parent: parent
+          )
           end
         when ::GraphQL::Execution::Interpreter::ArgumentValue
-          extract_argument(argument, field_defn, parent_input_object)
-          extract_arguments(argument.value, field_defn, parent_input_object)
+          extract_argument(
+            value: argument,
+            definition: definition,
+            parent_input_object: parent_input_object,
+            parent: parent
+          )
+          extract_arguments(
+            argument:argument.value,
+            definition: definition,
+            parent_input_object: parent_input_object,
+            parent: parent
+          )
         when ::GraphQL::Schema::InputObject
           input_object_argument_values = argument.arguments.argument_values.values
           parent_input_object = input_object_argument_values.first&.definition&.owner
 
-          extract_arguments(input_object_argument_values, field_defn, parent_input_object)
+          extract_arguments(
+            argument: input_object_argument_values,
+            definition: definition,
+            parent_input_object: parent_input_object,
+            parent: parent
+          )
         end
       end
 
-      def extract_argument(value, field_defn, parent_input_object = nil)
+      def extract_argument(value:, definition:, parent_input_object:, parent:)
+        parent_type_name = if definition.is_a?(GraphQL::Schema::Field)
+          definition.owner.graphql_name
+        else
+          DIRECTIVE_TYPE
+        end
+
+        grand_parent_name = case parent
+        when GraphQL::Language::Nodes::OperationDefinition
+          parent.operation_type
+        when GraphQL::Language::Nodes::InlineFragment
+          parent.type.name
+        else
+          parent.name
+        end
+
         static_metrics = {
           argument_name: value.definition.graphql_name,
           argument_type_name: value.definition.type.unwrap.graphql_name,
-          parent_field_name: field_defn.graphql_name,
-          parent_field_type_name: field_defn.owner.graphql_name,
+          parent_name: definition.graphql_name,
+          grandparent_type_name: parent_type_name,
+          grandparent_node_name: grand_parent_name,
           parent_input_object_type: parent_input_object&.graphql_name,
           default_used: value.default_used?,
           value_is_null: value.value.nil?,

data/lib/graphql/metrics/tracer.rb

@@ -4,10 +4,12 @@ module GraphQL
   module Metrics
     class Tracer
       # NOTE: These constants come from the graphql ruby gem and are in "chronological" order based on the phases
-      # of execution of the graphql-ruby gem. Most of them can be run multiple times when multiplexing multiple queries.
+      # of execution of the graphql-ruby gem, though old versions of the gem aren't always consistent about this (see
+      # https://github.com/rmosolgo/graphql-ruby/issues/3393). Most of them can be run multiple times when
+      # multiplexing multiple queries.
+      GRAPHQL_GEM_EXECUTE_MULTIPLEX_KEY = 'execute_multiplex' # wraps everything below this line; only run once
       GRAPHQL_GEM_LEXING_KEY = 'lex' # may not trigger if the query is passed in pre-parsed
       GRAPHQL_GEM_PARSING_KEY = 'parse' # may not trigger if the query is passed in pre-parsed
-      GRAPHQL_GEM_EXECUTE_MULTIPLEX_KEY = 'execute_multiplex' # wraps everything below this line; only run once
       GRAPHQL_GEM_VALIDATION_KEY = 'validate'
       GRAPHQL_GEM_ANALYZE_MULTIPLEX_KEY = 'analyze_multiplex' # wraps all `analyze_query`s; only run once
       GRAPHQL_GEM_ANALYZE_QUERY_KEY = 'analyze_query'
@@ -24,12 +26,12 @@ module GraphQL
         return yield if skip_tracing
 
         case key
+        when GRAPHQL_GEM_EXECUTE_MULTIPLEX_KEY
+          return capture_multiplex_start_time(&block)
         when GRAPHQL_GEM_LEXING_KEY
           return capture_lexing_time(&block)
         when GRAPHQL_GEM_PARSING_KEY
           return capture_parsing_time(&block)
-        when GRAPHQL_GEM_EXECUTE_MULTIPLEX_KEY
-          return capture_multiplex_start_time(&block)
         when GRAPHQL_GEM_VALIDATION_KEY
           return capture_validation_time(context, &block)
         when GRAPHQL_GEM_ANALYZE_MULTIPLEX_KEY

data/lib/graphql/metrics/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module Metrics
-    VERSION = "4.1.0"
+    VERSION = "5.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-metrics
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Christopher Butcher
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-16 00:00:00.000000000 Z
+date: 2021-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.10.8
+        version: 1.12.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.10.8
+        version: 1.12.10
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -241,7 +241,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: GraphQL Metrics Extractor