graphql-metrics 3.0.3 → 4.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8eda0da73b10eb0afb49963c3192767df4a711eb4177b401086400167a803c3
-  data.tar.gz: 1eb7cd4c7a0af088a7686eba62c141dd2530d0efbefc2cc5e954e66d92842130
+  metadata.gz: c0f132a7bc5eabcd7d3d909b3342f5f3855df4526ca06ed17eb5c2096fb5c0a5
+  data.tar.gz: a36decb5cb868fc081a6053420b24d2934e71194f850e4589343160aa3ff8b59
 SHA512:
-  metadata.gz: 34ea411c44bec8dd2e0b6e2a613866f5bba29cb6be19984e45c11216b5a154fab7fe459632b483e7d45cc7d082b1fffeb4f744a4cdb91ef0cb0b30c9442c1293
-  data.tar.gz: 4b9616c41459bddec77ff660063358ee925c819e7c580f9aa068f906482445370900c787d47c3aafd4873322ca38ded57bbc3b8b17605aa695b9e335391e5433
+  metadata.gz: 3570b95636f5200b7d487e71354717ed0a69e0e04e30a6f2f0131f8739158f018a244b8e8a1ff76c5574f00038ff8a738b279f6925d518d97500f35fc2730a90
+  data.tar.gz: f666ab46f5195b6b3344b2c7bd657a441feae3878595f62a7a233705781723352371854c66e6a1ceb66ff120d5cb0b001e7c447761377babf930de887d0cf906

data/.rubocop-http---shopify-github-io-ruby-style-guide-rubocop-yml

@@ -76,13 +76,6 @@ Style/BlockDelimiters:
   - proc
   - it
 
-Style/BracesAroundHashParameters:
-  EnforcedStyle: no_braces
-  SupportedStyles:
-  - braces
-  - no_braces
-  - context_dependent
-
 Layout/CaseIndentation:
   EnforcedStyle: end
   SupportedStyles:
@@ -509,7 +502,7 @@ Style/WhileUntilModifier:
 Metrics/BlockNesting:
   Max: 3
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 120
   AllowHeredoc: true
   AllowURI: true

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+4.0.4
+-----
+- [33](https://github.com/Shopify/graphql-metrics/pull/33) Setup tracing using lex or execute_multiplex tracer events.
+
+4.0.3
+-----
+- [32](https://github.com/Shopify/graphql-metrics/pull/32) Split validate and analyze_query tracer events (encompasses #30).
+- [30](https://github.com/Shopify/graphql-metrics/pull/30) Handle queries that have already been parsed (thank you @jturkel).
+- [29](https://github.com/Shopify/graphql-metrics/pull/29) Remove runtime dependency on activesupport (thank you @jturkel).
+
+4.0.2
+-----
+- [25](https://github.com/Shopify/graphql-metrics/pull/25) Safely handle interrupted runtime metrics.
+
+4.0.1
+-----
+- [24](https://github.com/Shopify/graphql-metrics/pull/24) Safely call `arguments_for` to handle arguments which may
+raise `ExecutionError`s in their `prepare` methods.
+
+4.0.0
+-----
+- [23](https://github.com/Shopify/graphql-metrics/pull/23) graphql-ruby 1.10.8+ compatibility
+
 3.0.3
 -----
 

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    graphql-metrics (3.0.2)
+    graphql-metrics (4.0.4)
       concurrent-ruby (~> 1.1.0)
-      graphql (>= 1.9.5, < 1.10.0)
+      graphql (>= 1.10.8)
 
 GEM
   remote: https://rubygems.org/
@@ -19,8 +19,8 @@ GEM
     diffy (3.3.0)
     fakeredis (0.7.0)
       redis (>= 3.2, < 5.0)
-    graphql (1.9.19)
-    graphql-batch (0.4.1)
+    graphql (1.10.8)
+    graphql-batch (0.4.2)
       graphql (>= 1.3, < 2)
       promise.rb (~> 0.7.2)
     hashdiff (1.0.0)

data/README.md

@@ -5,6 +5,8 @@
 Extract as much much detail as you want from GraphQL queries, served up from your Ruby app and the [`graphql` gem](https://github.com/rmosolgo/graphql-ruby).
 Compatible with the [`graphql-batch` gem](https://github.com/Shopify/graphql-batch), to extract batch-loaded fields resolution timings.
 
+Be sure to read the [CHANGELOG](CHANGELOG.md) to stay updated on feature additions, breaking changes made to this gem.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -42,11 +44,18 @@ etc.
 
 What you do with these captured metrics is up to you!
 
+**NOTE**: Runtime metrics on for queries (like `query_duration`, `parsing_start_time_offset` etc.) as well as field
+resolver timings (like `resolver_timings`, `lazy_resolver_timings`) may not be present in the extracted `metrics` hash,
+even if you opt to collect them by using `GraphQL::Metrics::Analyzer` and `GraphQL::Metrics::Tracer`.
+
+More specifically, if any non-`graphql-ruby` gem-related exceptions occur in your application during query document
+parsing and validation runtime metrics will not be added to the `metrics` hash.
+
 ### Define your own analyzer subclass
 
 ```ruby
-  class CaptureAllMetricsAnalyzer < GraphQL::Metrics::Analyzer
-    ANALYZER_NAMESPACE = :capture_all_metrics_analyzer_namespace
+  class SimpleAnalyzer < GraphQL::Metrics::Analyzer
+    ANALYZER_NAMESPACE = :simple_analyzer_namespace
 
     def initialize(query_or_multiplex)
       super
@@ -69,6 +78,8 @@ What you do with these captured metrics is up to you!
     #   parsing_duration: 0.0008190000080503523,
     #   validation_start_time_offset: 0.0030819999519735575,
     #   validation_duration: 0.01704599999357015,
+    #   analysis_start_time_offset: 0.0010339999571442604,
+    #   analysis_duration: 0.0008190000080503523,
     # }
     #
     # You can use these metrics to track high-level query performance, along with any other details you wish to
@@ -173,7 +184,7 @@ class Schema < GraphQL::Schema
   use GraphQL::Analysis::AST # Required.
 
   query_analyzer SimpleAnalyzer
-  
+
   instrument :query, GraphQL::Metrics::Instrumentation.new # Both of these are required if either is used.
   tracer GraphQL::Metrics::Tracer.new                      # <-- Note!
 
@@ -212,10 +223,11 @@ your application as intended, here's a breakdown of the order of execution of th
 
  When used as instrumentation, an analyzer and tracing, the order of execution is:
 
-* Tracer.setup_tracing_before_lexing
+* Tracer.setup_tracing
 * Tracer.capture_parsing_time
 * Instrumentation.before_query (context setup)
-* Tracer.capture_validation_time (twice, once for `analyze_query`, then `analyze_multiplex`)
+* Tracer.capture_validation_time
+* Tracer.capture_analysis_time
 * Analyzer#initialize (bit more context setup, instance vars setup)
 * Analyzer#result
 * Tracer.trace_field (n times)

data/graphql_metrics.gemspec

@@ -30,9 +30,8 @@ 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 "concurrent-ruby", "~> 1.1.0"
-  spec.add_runtime_dependency "graphql", ">= 1.9.5", "< 1.10.0"
-
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency 'graphql-batch'

data/lib/graphql/metrics.rb

@@ -28,6 +28,8 @@ module GraphQL
     PARSING_DURATION = :parsing_duration
     VALIDATION_START_TIME_OFFSET = :validation_start_time_offset
     VALIDATION_DURATION = :validation_duration
+    ANALYSIS_START_TIME_OFFSET = :analysis_start_time_offset
+    ANALYSIS_DURATION = :analysis_duration
     INLINE_FIELD_TIMINGS = :inline_field_timings
     LAZY_FIELD_TIMINGS = :lazy_field_timings
 

data/lib/graphql/metrics/analyzer.rb

@@ -35,15 +35,22 @@ module GraphQL
         return if visitor.field_definition.introspection?
         return if query.context[SKIP_FIELD_AND_ARGUMENT_METRICS]
 
-        # NOTE: @rmosolgo "I think it could be reduced to `arguments = visitor.arguments_for(ast_node)`"
-        arguments = visitor.arguments_for(node, visitor.field_definition)
-        extract_arguments(arguments.argument_values.values, visitor.field_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`.
+        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
 
         static_metrics = {
           field_name: node.name,
-          return_type_name: visitor.type_definition.name,
-          parent_type_name: visitor.parent_type_definition.name,
-          deprecated: visitor.field_definition.deprecation_reason.present?,
+          return_type_name: visitor.type_definition.graphql_name,
+          parent_type_name: visitor.parent_type_definition.graphql_name,
+          deprecated: !visitor.field_definition.deprecation_reason.nil?,
           path: visitor.response_path,
         }
 
@@ -54,17 +61,20 @@ module GraphQL
         end
       end
 
-      def extract_fields_with_runtime_metrics
+      def extract_fields(with_runtime_metrics: true)
         return if query.context[SKIP_FIELD_AND_ARGUMENT_METRICS]
 
         ns = query.context.namespace(CONTEXT_NAMESPACE)
 
         @static_field_metrics.each do |static_metrics|
-          resolver_timings = ns[GraphQL::Metrics::INLINE_FIELD_TIMINGS][static_metrics[:path]]
-          lazy_resolver_timings = ns[GraphQL::Metrics::LAZY_FIELD_TIMINGS][static_metrics[:path]]
 
-          static_metrics[:resolver_timings] = resolver_timings || []
-          static_metrics[:lazy_resolver_timings] = lazy_resolver_timings || []
+          if with_runtime_metrics
+            resolver_timings = ns[GraphQL::Metrics::INLINE_FIELD_TIMINGS][static_metrics[:path]]
+            lazy_resolver_timings = ns[GraphQL::Metrics::LAZY_FIELD_TIMINGS][static_metrics[:path]]
+
+            static_metrics[:resolver_timings] = resolver_timings || []
+            static_metrics[:lazy_resolver_timings] = lazy_resolver_timings || []
+          end
 
           field_extracted(static_metrics)
         end
@@ -93,16 +103,16 @@ module GraphQL
           argument.each_value do |a|
             extract_arguments(a, field_defn, parent_input_object)
           end
-        when ::GraphQL::Query::Arguments
+        when ::GraphQL::Execution::Interpreter::Arguments
           argument.each_value do |arg_val|
             extract_arguments(arg_val, field_defn, parent_input_object)
           end
-        when ::GraphQL::Query::Arguments::ArgumentValue
+        when ::GraphQL::Execution::Interpreter::ArgumentValue
           extract_argument(argument, field_defn, parent_input_object)
           extract_arguments(argument.value, field_defn, parent_input_object)
         when ::GraphQL::Schema::InputObject
           input_object_argument_values = argument.arguments.argument_values.values
-          parent_input_object = input_object_argument_values.first&.definition&.metadata&.fetch(:type_class, nil)&.owner
+          parent_input_object = input_object_argument_values.first&.definition&.owner
 
           extract_arguments(input_object_argument_values, field_defn, parent_input_object)
         end
@@ -110,10 +120,10 @@ module GraphQL
 
       def extract_argument(value, field_defn, parent_input_object = nil)
         static_metrics = {
-          argument_name: value.definition.expose_as,
-          argument_type_name: value.definition.type.unwrap.to_s,
-          parent_field_name: field_defn.name,
-          parent_field_type_name: field_defn.metadata[:type_class].owner.graphql_name,
+          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_input_object_type: parent_input_object&.graphql_name,
           default_used: value.default_used?,
           value_is_null: value.value.nil?,

data/lib/graphql/metrics/instrumentation.rb

@@ -25,23 +25,33 @@ module GraphQL
         return if query.context[GraphQL::Metrics::SKIP_GRAPHQL_METRICS_ANALYSIS]
 
         ns = query.context.namespace(CONTEXT_NAMESPACE)
+        analyzer = ns[GraphQL::Metrics::ANALYZER_INSTANCE_KEY]
 
-        # NOTE: The start time stored at `ns[GraphQL::Metrics::QUERY_START_TIME_MONOTONIC]` is captured during query
-        # parsing, which occurs before `Instrumentation#before_query`.
-        query_duration = GraphQL::Metrics.current_time_monotonic - ns[GraphQL::Metrics::QUERY_START_TIME_MONOTONIC]
+        if runtime_metrics_interrupted?(ns)
+          # If runtime metrics were interrupted, then it's most likely that the application raised an exception and that
+          # query parsing (which is instrumented by GraphQL::Metrics::Tracer) was abruptly stopped.
+          #
+          # In this scenario, we still attempt to log whatever static query metrics we've collected, with runtime
+          # metrics (like query, field resolver timings) excluded.
+          analyzer.extract_fields(with_runtime_metrics: false)
+          analyzer.extract_query
+        else
+          query_duration = GraphQL::Metrics.current_time_monotonic - ns[GraphQL::Metrics::QUERY_START_TIME_MONOTONIC]
 
-        runtime_query_metrics = {
-          query_start_time: ns[GraphQL::Metrics::QUERY_START_TIME],
-          query_duration: query_duration,
-          parsing_start_time_offset: ns[GraphQL::Metrics::PARSING_START_TIME_OFFSET],
-          parsing_duration: ns[GraphQL::Metrics::PARSING_DURATION],
-          validation_start_time_offset: ns[GraphQL::Metrics::VALIDATION_START_TIME_OFFSET],
-          validation_duration: ns[GraphQL::Metrics::VALIDATION_DURATION],
-        }
+          runtime_query_metrics = {
+            query_start_time: ns[GraphQL::Metrics::QUERY_START_TIME],
+            query_duration: query_duration,
+            parsing_start_time_offset: ns[GraphQL::Metrics::PARSING_START_TIME_OFFSET],
+            parsing_duration: ns[GraphQL::Metrics::PARSING_DURATION],
+            validation_start_time_offset: ns[GraphQL::Metrics::VALIDATION_START_TIME_OFFSET],
+            validation_duration: ns[GraphQL::Metrics::VALIDATION_DURATION],
+            analysis_start_time_offset: ns[GraphQL::Metrics::ANALYSIS_START_TIME_OFFSET],
+            analysis_duration: ns[GraphQL::Metrics::ANALYSIS_DURATION],
+          }
 
-        analyzer = ns[GraphQL::Metrics::ANALYZER_INSTANCE_KEY]
-        analyzer.extract_fields_with_runtime_metrics
-        analyzer.extract_query(runtime_query_metrics: runtime_query_metrics)
+          analyzer.extract_fields
+          analyzer.extract_query(runtime_query_metrics: runtime_query_metrics)
+        end
       end
 
       private
@@ -51,6 +61,12 @@ module GraphQL
         # which did not reject "empty" documents in its parser.
         query.valid? && !query.selected_operation.nil?
       end
+
+      def runtime_metrics_interrupted?(context_namespace)
+        # NOTE: The start time stored at `ns[GraphQL::Metrics::QUERY_START_TIME_MONOTONIC]` is captured during query
+        # parsing, which occurs before `Instrumentation#before_query`.
+        context_namespace.key?(GraphQL::Metrics::QUERY_START_TIME_MONOTONIC) == false
+      end
     end
   end
 end

data/lib/graphql/metrics/tracer.rb

@@ -4,9 +4,11 @@ module GraphQL
   module Metrics
     class Tracer
       # NOTE: These constants come from the graphql ruby gem.
-      GRAPHQL_GEM_LEXING_KEY = 'lex'
+      GRAPHQL_GEM_LEX_KEY = 'lex'
+      GRAPHQL_GEM_EXECUTE_MULTIPLEX_KEY = 'execute_multiplex'
       GRAPHQL_GEM_PARSING_KEY = 'parse'
-      GRAPHQL_GEM_VALIDATION_KEYS = ['validate', 'analyze_query']
+      GRAPHQL_GEM_VALIDATION_KEY = 'validate'
+      GRAPHQL_GEM_ANALYZE_KEY = 'analyze_query'
       GRAPHQL_GEM_TRACING_FIELD_KEYS = [
         GRAPHQL_GEM_TRACING_FIELD_KEY = 'execute_field',
         GRAPHQL_GEM_TRACING_LAZY_FIELD_KEY = 'execute_field_lazy'
@@ -22,21 +24,23 @@ module GraphQL
         # NOTE: Not all tracing events are handled here, but those that are are handled in this case statement in
         # chronological order.
         case key
-        when GRAPHQL_GEM_LEXING_KEY
-          return setup_tracing_before_lexing(&block)
+        when GRAPHQL_GEM_LEX_KEY
+          return setup_tracing(&block)
+        when GRAPHQL_GEM_EXECUTE_MULTIPLEX_KEY
+          return setup_tracing(&block)
         when GRAPHQL_GEM_PARSING_KEY
           return capture_parsing_time(&block)
-        when *GRAPHQL_GEM_VALIDATION_KEYS
+        when GRAPHQL_GEM_VALIDATION_KEY
           context = possible_context
-
-          return yield unless context.query.valid?
           return capture_validation_time(context, &block)
+        when GRAPHQL_GEM_ANALYZE_KEY
+          context = possible_context
+          return capture_analysis_time(context, &block)
+
         when *GRAPHQL_GEM_TRACING_FIELD_KEYS
           return yield if data[:query].context[SKIP_FIELD_AND_ARGUMENT_METRICS]
           return yield unless GraphQL::Metrics.timings_capture_enabled?(data[:query].context)
 
-          pre_context = nil
-
           context_key = case key
           when GRAPHQL_GEM_TRACING_FIELD_KEY
             GraphQL::Metrics::INLINE_FIELD_TIMINGS
@@ -52,15 +56,30 @@ module GraphQL
 
       private
 
+      PreContext = Struct.new(
+        :query_start_time,
+        :query_start_time_monotonic,
+        :parsing_start_time_offset,
+        :parsing_duration
+      ) do
+        def reset_parsing_timings
+          self[:parsing_start_time_offset] = nil
+          self[:parsing_duration] = nil
+        end
+      end
+
       def pre_context
         # NOTE: This is used to store timings from lexing, parsing, validation, before we have a context to store
         # values in. Uses thread-safe Concurrent::ThreadLocalVar to store a set of values per thread.
-        @pre_context ||= Concurrent::ThreadLocalVar.new(OpenStruct.new)
+        @pre_context ||= Concurrent::ThreadLocalVar.new(PreContext.new)
+        @pre_context.value
       end
 
-      def setup_tracing_before_lexing
-        pre_context.value.query_start_time = GraphQL::Metrics.current_time
-        pre_context.value.query_start_time_monotonic = GraphQL::Metrics.current_time_monotonic
+      def setup_tracing
+        return yield if pre_context.query_start_time
+
+        pre_context.query_start_time = GraphQL::Metrics.current_time
+        pre_context.query_start_time_monotonic = GraphQL::Metrics.current_time_monotonic
 
         yield
       end
@@ -68,24 +87,41 @@ module GraphQL
       def capture_parsing_time
         timed_result = GraphQL::Metrics.time { yield }
 
-        pre_context.value.parsing_start_time_offset = timed_result.start_time
-        pre_context.value.parsing_duration = timed_result.duration
+        pre_context.parsing_start_time_offset = timed_result.start_time
+        pre_context.parsing_duration = timed_result.duration
 
         timed_result.result
       end
 
       def capture_validation_time(context)
-        timed_result = GraphQL::Metrics.time(pre_context.value.query_start_time_monotonic) { yield }
+        if pre_context.parsing_duration.nil?
+          pre_context.parsing_start_time_offset = 0
+          pre_context.parsing_duration = 0
+        end
+
+        timed_result = GraphQL::Metrics.time(pre_context.query_start_time_monotonic) { yield }
 
         ns = context.namespace(CONTEXT_NAMESPACE)
-        previous_validation_duration = ns[GraphQL::Metrics::VALIDATION_DURATION] || 0
 
-        ns[QUERY_START_TIME] = pre_context.value.query_start_time
-        ns[QUERY_START_TIME_MONOTONIC] = pre_context.value.query_start_time_monotonic
-        ns[PARSING_START_TIME_OFFSET] = pre_context.value.parsing_start_time_offset
-        ns[PARSING_DURATION] = pre_context.value.parsing_duration
+        ns[QUERY_START_TIME] = pre_context.query_start_time
+        ns[QUERY_START_TIME_MONOTONIC] = pre_context.query_start_time_monotonic
+        ns[PARSING_START_TIME_OFFSET] = pre_context.parsing_start_time_offset
+        ns[PARSING_DURATION] = pre_context.parsing_duration
         ns[VALIDATION_START_TIME_OFFSET] = timed_result.time_since_offset
-        ns[VALIDATION_DURATION] = timed_result.duration + previous_validation_duration
+        ns[VALIDATION_DURATION] = timed_result.duration
+
+        pre_context.reset_parsing_timings
+
+        timed_result.result
+      end
+
+      def capture_analysis_time(context)
+        ns = context.namespace(CONTEXT_NAMESPACE)
+
+        timed_result = GraphQL::Metrics.time(ns[QUERY_START_TIME_MONOTONIC]) { yield }
+
+        ns[ANALYSIS_START_TIME_OFFSET] = timed_result.time_since_offset
+        ns[ANALYSIS_DURATION] = timed_result.duration
 
         timed_result.result
       end

data/lib/graphql/metrics/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module Metrics
-    VERSION = "3.0.3"
+    VERSION = "4.0.4"
   end
 end

metadata

@@ -1,49 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: graphql-metrics
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 4.0.4
 platform: ruby
 authors:
 - Christopher Butcher
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-30 00:00:00.000000000 Z
+date: 2020-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: concurrent-ruby
+  name: graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.10.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.10.8
 - !ruby/object:Gem::Dependency
-  name: graphql
+  name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.9.5
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.9.5
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement