graphql-metrics 3.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 951dcb602534826881c09e30d3bbc37aa672aafb35aed258f9038d32b60db761
-  data.tar.gz: 72893df9e0602d8e2ccea431bf8f9f93ebad5d770fe0c3efef82a386e6d8ae7d
+  metadata.gz: 45de407a0b5642ad74d27cdb4ab00635590a38d8b719fc448a3e94d6244d7daf
+  data.tar.gz: cae841292ce06f25031974127696594b426b41f469e4f7f74f37f1f3a8c8f521
 SHA512:
-  metadata.gz: 0c882fcd0212576bef1cf956df63a71e8406b080f84db8ce349063707d684ec2c9c809a1a790f8c5b8065c5a92441a35dec63c2c9c1634b37483523f4cf366f8
-  data.tar.gz: 598a1b7085197fac8ed3be9c57b701bef6518bd47d36ed001fe1f1520773a2ff8f2de8314ec35db15801cf6b64699b60f8286166539af35861f74751e35ae0d0
+  metadata.gz: 861b2728422d3f8c314024084497ef761c4ca83491f3967ccffa2d540ced0de524d318a380f7966b6555a539fd30ffdfaec83cafee42f020813875148434f734
+  data.tar.gz: 83bde1129c7492cd92ffc097e3072275f179262530a5fccbe6e61b5c485a08bb231a3af8e29ddf88a6f0f3cdfdf5bd7101f0266e042afe37d19232a07195d922

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,27 @@
+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
+-----
+
+Expand the range of graphql-ruby versions this gem is compatible with.
+
 3.0.0
 -----
 

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    graphql-metrics (3.0.0)
+    graphql-metrics (4.0.1)
       concurrent-ruby (~> 1.1.0)
-      graphql (~> 1.9.15)
+      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.16)
-    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)
@@ -51,7 +51,6 @@ PLATFORMS
 
 DEPENDENCIES
   activesupport (~> 5.1.5)
-  bundler (~> 2.0.2)
   diffy
   fakeredis
   graphql-batch
@@ -65,4 +64,4 @@ DEPENDENCIES
   rake
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/README.md

@@ -172,9 +172,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,10 +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.15"
-
-  spec.add_development_dependency "bundler", "~> 2.0.2"
   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,
         }
@@ -61,14 +68,12 @@ module GraphQL
 
         @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]]
+          lazy_resolver_timings = ns[GraphQL::Metrics::LAZY_FIELD_TIMINGS][static_metrics[:path]]
 
-          metrics = static_metrics.merge(
-            resolver_timings: resolver_timings || [],
-            lazy_resolver_timings: lazy_field_timings || [],
-          )
+          static_metrics[:resolver_timings] = resolver_timings || []
+          static_metrics[:lazy_resolver_timings] = lazy_resolver_timings || []
 
-          field_extracted(metrics)
+          field_extracted(static_metrics)
         end
       end
 
@@ -95,16 +100,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 +117,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

@@ -47,7 +47,9 @@ module GraphQL
       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
     end
   end

data/lib/graphql/metrics/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module Metrics
-    VERSION = "3.0.0"
+    VERSION = "4.0.1"
   end
 end

metadata

@@ -1,57 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: graphql-metrics
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Christopher Butcher
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-11 00:00:00.000000000 Z
+date: 2020-06-05 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: concurrent-ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.1.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.15
+        version: 1.10.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.15
+        version: 1.10.8
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
-  type: :development
+        version: 1.1.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement