graphql-metrics 3.0.1 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf09941ca4f9ed80c7d1080c6c121fa1cb1ac66ed55735dcb74cec0bbbe3a8a2
-  data.tar.gz: 18a8b3feafc4bb5be6c065cf05b91da34fee5c826e77d67ad14ea48a23630459
+  metadata.gz: 2af911e9031c446b604b9c296caef2c89f00cb968ecf15350a6a196d6cab08d7
+  data.tar.gz: 94e65ae882fd6222bf3b4ed9395f32dfc395ec00c85e061a458cb5fe54b9dc67
 SHA512:
-  metadata.gz: 4e11ef76ccd1d038fab97151f40418e5386b5d2d80b45ca1238f5c0ebf60b6a593980bde4efe4fc60c63b3c590bc7da803e8fcb04ce1c9906fa0cf6edecb0e74
-  data.tar.gz: 32684bc8c1e3fac2e73b4efad7969bb84c38fc34a89510e450e0b423b5ec66104a8cd0fea016b91a47e26299a01df0b09da82597a4fd5dd763d64de4677c04f7
+  metadata.gz: aa3ffe4208e67594c3e65786a0a0477cdcee71506dea37988db388433eb155175d87f92e30082931e5e8c493937876e9a5a4043327b74e9e17bc474d58bd4ed9
+  data.tar.gz: e876e9f5907cff0863a6ead3e319f34ab238b1904d0f72c8874420fdf50b5cb2941cb0f77fcfbefac35968c2bb86ec6364c5e338842dcee591eb165ee2ed14d6

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.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
+-----
+
+- [#22](https://github.com/Shopify/graphql-metrics/pull/22) Optimization: use hash assignment over merge
+
+3.0.2
+-----
+
+- [#21](https://github.com/Shopify/graphql-metrics/pull/21) Optimize empty document check
+
 3.0.1
 -----
 

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    graphql-metrics (3.0.1)
+    graphql-metrics (4.0.1)
       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,6 +44,13 @@ 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
@@ -172,9 +181,10 @@ class Schema < GraphQL::Schema
   use GraphQL::Execution::Interpreter # Required.
   use GraphQL::Analysis::AST # Required.
 
-  instrument :query, GraphQL::Metrics::Instrumentation.new
   query_analyzer SimpleAnalyzer
-  tracer GraphQL::Metrics::Tracer.new
+
+  instrument :query, GraphQL::Metrics::Instrumentation.new # Both of these are required if either is used.
+  tracer GraphQL::Metrics::Tracer.new                      # <-- Note!
 
   use GraphQL::Batch # Optional, but highly recommended. See https://github.com/Shopify/graphql-batch/.
 end

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/analyzer.rb

@@ -35,14 +35,21 @@ 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,
+          return_type_name: visitor.type_definition.graphql_name,
+          parent_type_name: visitor.parent_type_definition.graphql_name,
           deprecated: visitor.field_definition.deprecation_reason.present?,
           path: visitor.response_path,
         }
@@ -54,21 +61,22 @@ 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_field_timings = ns[GraphQL::Metrics::LAZY_FIELD_TIMINGS][static_metrics[:path]]
 
-          metrics = static_metrics.merge(
-            resolver_timings: resolver_timings || [],
-            lazy_resolver_timings: lazy_field_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]]
 
-          field_extracted(metrics)
+            static_metrics[:resolver_timings] = resolver_timings || []
+            static_metrics[:lazy_resolver_timings] = lazy_resolver_timings || []
+          end
+
+          field_extracted(static_metrics)
         end
       end
 
@@ -95,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
@@ -112,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,29 +25,45 @@ 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],
+          }
 
-        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
 
       def query_present_and_valid?(query)
-        query.valid? && query.document.to_query_string.present?
+        # Check for selected_operation as well for graphql 1.9 compatibility
+        # 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

data/lib/graphql/metrics/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module Metrics
-    VERSION = "3.0.1"
+    VERSION = "4.0.2"
   end
 end

metadata

@@ -1,49 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: graphql-metrics
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 4.0.2
 platform: ruby
 authors:
 - Christopher Butcher
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-16 00:00:00.000000000 Z
+date: 2020-06-11 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