graphql-metrics 4.0.5 → 4.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e35ba7c6756d4d431a32911e2bf8452f8f825ed1ff6d90c17ad0a0cb13f4d5f9
-  data.tar.gz: 1bb21be1384170bca7151a05ae36299c70193ca570bece6a7cdeb59f67e9ed57
+  metadata.gz: 794d916d7f0b35ed8c50814c7cee54af5881a9fa5102eb361d1486fde665b413
+  data.tar.gz: 831cd8c26e771fc5e97e483f5cda86bce63311c0a31a9d12a020cdf5be808241
 SHA512:
-  metadata.gz: ba5a5d9fe0b038410260a9fc7d05472a2a7b3012194bc727226429920225f93f617ce353f8121e07b0a27b6f13899c8895ef26bf37e9856df05482c692042603
-  data.tar.gz: baec02caa8599a575912c7e3e6696d11ac9bc0e88ebc5ed270eeaf7c0d8cf800bb5d1d48276f513a69c8921c43ef821a9f1239290a86027b9c104495e79c1ca3
+  metadata.gz: aed42769f9dcbcb445e0e9b8ec9858d05c917542fa0c588bcc587d19c2fbc8bafd2d1fcf65f4d7742cd498a2ac1d39b66c6955827efa4da3582a44980f2346e1
+  data.tar.gz: 908bc4cf5d126d71e715379cd2346308b5e7ed17230ad4733eff2614827625768d0ec1186da282628c91c6ab3fe7dd3a92adc6b6e9e548b202eb3b9507f6a8fd

data/CHANGELOG.md

@@ -1,6 +1,10 @@
+4.0.6
+-----
+- [35](https://github.com/Shopify/graphql-metrics/pull/35) Fix query start time, start time offset bugs.
+
 4.0.5
 -----
-- [34] Fix default of pre-parsed query `parsing_duration` to be Float (`0.0`) rather than Integer (`0`).
+- [34](https://github.com/Shopify/graphql-metrics/pull/34) Fix default of pre-parsed query `parsing_duration` to be Float (`0.0`) rather than Integer (`0`).
 
 4.0.4
 -----

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    graphql-metrics (4.0.5)
+    graphql-metrics (4.0.6)
       concurrent-ruby (~> 1.1.0)
       graphql (>= 1.10.8)
 

data/README.md

@@ -80,6 +80,7 @@ parsing and validation runtime metrics will not be added to the `metrics` hash.
     #   validation_duration: 0.01704599999357015,
     #   analysis_start_time_offset: 0.0010339999571442604,
     #   analysis_duration: 0.0008190000080503523,
+    #   multiplex_start_time: 0.0008190000080503523,
     # }
     #
     # You can use these metrics to track high-level query performance, along with any other details you wish to

data/lib/graphql/metrics.rb

@@ -22,6 +22,8 @@ module GraphQL
     ANALYZER_INSTANCE_KEY = :analyzer_instance
 
     # Context keys to store timings for query phases of execution, field resolver timings.
+    MULTIPLEX_START_TIME = :multiplex_start_time
+    MULTIPLEX_START_TIME_MONOTONIC = :multiplex_start_time_monotonic
     QUERY_START_TIME = :query_start_time
     QUERY_START_TIME_MONOTONIC = :query_start_time_monotonic
     PARSING_START_TIME_OFFSET = :parsing_start_time_offset

data/lib/graphql/metrics/instrumentation.rb

@@ -47,6 +47,7 @@ module GraphQL
             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],
+            multiplex_start_time: ns[GraphQL::Metrics::MULTIPLEX_START_TIME],
           }
 
           analyzer.extract_fields

data/lib/graphql/metrics/tracer.rb

@@ -4,11 +4,12 @@ module GraphQL
   module Metrics
     class Tracer
       # NOTE: These constants come from the graphql ruby gem.
-      GRAPHQL_GEM_LEX_KEY = 'lex'
       GRAPHQL_GEM_EXECUTE_MULTIPLEX_KEY = 'execute_multiplex'
       GRAPHQL_GEM_PARSING_KEY = 'parse'
       GRAPHQL_GEM_VALIDATION_KEY = 'validate'
-      GRAPHQL_GEM_ANALYZE_KEY = 'analyze_query'
+      GRAPHQL_GEM_ANALYZE_MULTIPLEX_KEY = 'analyze_multiplex'
+      GRAPHQL_GEM_ANALYZE_QUERY_KEY = 'analyze_query'
+      GRAPHQL_GEM_EXECUTE_QUERY_KEY = 'execute_query'
       GRAPHQL_GEM_TRACING_FIELD_KEYS = [
         GRAPHQL_GEM_TRACING_FIELD_KEY = 'execute_field',
         GRAPHQL_GEM_TRACING_LAZY_FIELD_KEY = 'execute_field_lazy'
@@ -24,19 +25,24 @@ 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_LEX_KEY
-          return setup_tracing(&block)
         when GRAPHQL_GEM_EXECUTE_MULTIPLEX_KEY
-          return setup_tracing(&block)
+          return capture_multiplex_start_time(&block)
         when GRAPHQL_GEM_PARSING_KEY
           return capture_parsing_time(&block)
         when GRAPHQL_GEM_VALIDATION_KEY
           context = possible_context
           return capture_validation_time(context, &block)
-        when GRAPHQL_GEM_ANALYZE_KEY
+        when GRAPHQL_GEM_ANALYZE_MULTIPLEX_KEY
+          # Ensures that we reset potentially long-lived PreContext objects between multiplexs. We reset at this point
+          # since all parsing and validation will be done by this point, and a GraphQL::Query::Context will exist.
+          pre_context.reset
+          return yield
+        when GRAPHQL_GEM_ANALYZE_QUERY_KEY
           context = possible_context
           return capture_analysis_time(context, &block)
-
+        when GRAPHQL_GEM_EXECUTE_QUERY_KEY
+          context = possible_context
+          capture_query_start_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)
@@ -57,12 +63,14 @@ module GraphQL
       private
 
       PreContext = Struct.new(
-        :query_start_time,
-        :query_start_time_monotonic,
+        :multiplex_start_time,
+        :multiplex_start_time_monotonic,
         :parsing_start_time_offset,
         :parsing_duration
       ) do
-        def reset_parsing_timings
+        def reset
+          self[:multiplex_start_time] = nil
+          self[:multiplex_start_time_monotonic] = nil
           self[:parsing_start_time_offset] = nil
           self[:parsing_duration] = nil
         end
@@ -75,17 +83,18 @@ module GraphQL
         @pre_context.value
       end
 
-      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
+      def capture_multiplex_start_time
+        pre_context.multiplex_start_time = GraphQL::Metrics.current_time
+        pre_context.multiplex_start_time_monotonic = GraphQL::Metrics.current_time_monotonic
 
         yield
       end
 
       def capture_parsing_time
-        timed_result = GraphQL::Metrics.time { yield }
+        # GraphQL::Query#result fires `parse` before the `execute_multiplex` event, so sometimes
+        # `pre_context.multiplex_start_time_monotonic` isn't set.
+        parsing_offset_time = pre_context.multiplex_start_time_monotonic || GraphQL::Metrics.current_time_monotonic
+        timed_result = GraphQL::Metrics.time(parsing_offset_time) { yield }
 
         pre_context.parsing_start_time_offset = timed_result.start_time
         pre_context.parsing_duration = timed_result.duration
@@ -93,32 +102,35 @@ module GraphQL
         timed_result.result
       end
 
+      # Also consolidates parsing timings (if any) from the `pre_context`
       def capture_validation_time(context)
         if pre_context.parsing_duration.nil?
-          pre_context.parsing_start_time_offset = 0.0
+          # Queries may already be parsed before execution (whether a single query or multiplex).
+          # If we don't have a parsing start time, use the multiplex start time.
+          pre_context.parsing_start_time_offset = pre_context.multiplex_start_time
+
+          # If we don't have a duration, consider parsing to have been instantaneous.
           pre_context.parsing_duration = 0.0
         end
 
-        timed_result = GraphQL::Metrics.time(pre_context.query_start_time_monotonic) { yield }
+        timed_result = GraphQL::Metrics.time(pre_context.multiplex_start_time_monotonic) { yield }
 
         ns = context.namespace(CONTEXT_NAMESPACE)
 
-        ns[QUERY_START_TIME] = pre_context.query_start_time
-        ns[QUERY_START_TIME_MONOTONIC] = pre_context.query_start_time_monotonic
+        ns[MULTIPLEX_START_TIME] = pre_context.multiplex_start_time
+        ns[MULTIPLEX_START_TIME_MONOTONIC] = pre_context.multiplex_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
 
-        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 }
+        timed_result = GraphQL::Metrics.time(ns[MULTIPLEX_START_TIME_MONOTONIC]) { yield }
 
         ns[ANALYSIS_START_TIME_OFFSET] = timed_result.time_since_offset
         ns[ANALYSIS_DURATION] = timed_result.duration
@@ -126,6 +138,14 @@ module GraphQL
         timed_result.result
       end
 
+      def capture_query_start_time(context)
+        ns = context.namespace(CONTEXT_NAMESPACE)
+        ns[QUERY_START_TIME] = GraphQL::Metrics.current_time
+        ns[QUERY_START_TIME_MONOTONIC] = GraphQL::Metrics.current_time_monotonic
+
+        yield
+      end
+
       def trace_field(context_key, data)
         ns = data[:query].context.namespace(CONTEXT_NAMESPACE)
         query_start_time_monotonic = ns[GraphQL::Metrics::QUERY_START_TIME_MONOTONIC]

data/lib/graphql/metrics/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module Metrics
-    VERSION = "4.0.5"
+    VERSION = "4.0.6"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-metrics
 version: !ruby/object:Gem::Version
-  version: 4.0.5
+  version: 4.0.6
 platform: ruby
 authors:
 - Christopher Butcher
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-10 00:00:00.000000000 Z
+date: 2020-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql