apollo-federation 1.1.3 → 1.1.4.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8eef314d1457da9e7bd70ac5fe92c3d1168dfe340a3ba43a9d0e96475e44f027
-  data.tar.gz: 675b88c92096f8d73e240b8c8ab8dc2a5429b0c5d3249c50c74f98f50839a9bf
+  metadata.gz: daf6d773f974fc148d5b0b512a26c9f93e0ab439326531a02bfed864d7fa6cb2
+  data.tar.gz: 3b1ff037218ae14fe2aee7557166bc1ab0fe9b91ba52f256d53e17bc63abea0e
 SHA512:
-  metadata.gz: a5fb6b967baeeb09c89f60d52e7d25bff87966c20abb6f2577487316b3edd96afae6d400de968ecb92a3fd97ae0f06c057c1985e9f8d9a83fadc99392a0c8cc4
-  data.tar.gz: 6b4574b0c718229d0b7ae717bddffdc1347d1d678e63ac3afdae54f58c1d4d5973ac76641c22129cb2ec5d661ce902f56bc43f06baf433739ac364303c816876
+  metadata.gz: '083988b5151aed2b559b1f3eeb7760df2ada9fddacba4385c3fed34b5087a6daf1913b73e77eb2c600e1eccb6a4d29e593071f3ccf2a834f6abf88cb7fe100cf'
+  data.tar.gz: c6af4542c73ccf7fffcc06e58a0a8c73b71439dd2a78565611e582cabfe48ca60799df011ebcfde75ab6c811142636dcb30b5486a0bfb3eea3f642f191d2e728

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [1.1.4-beta.1](https://github.com/Gusto/apollo-federation-ruby/compare/v1.1.3...v1.1.4-beta.1) (2020-09-21)
+
+
+### Bug Fixes
+
+* **tracing:** properly handle parsing and validation errors ([#101](https://github.com/Gusto/apollo-federation-ruby/issues/101)) ([6cf8202](https://github.com/Gusto/apollo-federation-ruby/commit/6cf820281dd85bd358c6bf4c176b9a73a9280d54))
+
 ## [1.1.3](https://github.com/Gusto/apollo-federation-ruby/compare/v1.1.2...v1.1.3) (2020-07-16)
 
 

data/README.md

@@ -175,14 +175,6 @@ To support [federated tracing](https://www.apollographql.com/docs/apollo-server/
       # ...
     end
     ```
-3. Change your controller to attach the traces to the response:
-    ```ruby
-    def execute
-      # ...
-      result = YourSchema.execute(query, ...)
-      render json: ApolloFederation::Tracing.attach_trace_to_result(result)
-    end
-    ```
 
 ## Known Issues and Limitations
  - Only works with class-based schemas, the legacy `.define` API will not be supported

data/lib/apollo-federation/tracing.rb

@@ -4,14 +4,6 @@ module ApolloFederation
   module Tracing
     KEY = :ftv1
     DEBUG_KEY = "#{KEY}_debug".to_sym
-    class NotInstalledError < StandardError
-      MESSAGE = 'Apollo Federation Tracing not installed. \
-Add `use ApolloFederation::Tracing` to your schema.'
-
-      def message
-        MESSAGE
-      end
-    end
 
     module_function
 
@@ -23,37 +15,10 @@ Add `use ApolloFederation::Tracing` to your schema.'
       headers && headers['apollo-federation-include-trace'] == KEY.to_s
     end
 
-    def attach_trace_to_result(result)
-      return result unless result.context[:tracing_enabled]
-
-      trace = result.context.namespace(KEY)
-      # TODO: If there are errors during query validation, that could also cause a missing
-      # start_time
-      raise NotInstalledError unless trace[:start_time]
-
-      result['errors']&.each do |error|
-        trace[:node_map].add_error(error)
-      end
-
-      proto = ApolloFederation::Tracing::Trace.new(
-        start_time: to_proto_timestamp(trace[:start_time]),
-        end_time: to_proto_timestamp(trace[:end_time]),
-        duration_ns: trace[:end_time_nanos] - trace[:start_time_nanos],
-        root: trace[:node_map].root,
-      )
-
-      result[:extensions] ||= {}
-      result[:extensions][KEY] = Base64.encode64(proto.class.encode(proto))
-
-      if result.context[:debug_tracing]
-        result[:extensions][DEBUG_KEY] = proto.to_h
-      end
-
-      result.to_h
-    end
-
-    def to_proto_timestamp(time)
-      Google::Protobuf::Timestamp.new(seconds: time.to_i, nanos: time.nsec)
+    # @deprecated There is no need to call this method. Traces are added to the result automatically
+    def attach_trace_to_result(_result)
+      warn '[DEPRECATION] `attach_trace_to_result` is deprecated. There is no need to call it, as '\
+        'traces are added to the result automatically'
     end
   end
 end

data/lib/apollo-federation/tracing/tracer.rb

@@ -35,15 +35,15 @@ module ApolloFederation
   module Tracing
     module Tracer
       # store string constants to avoid creating new strings for each call to .trace
-      EXECUTE_QUERY = 'execute_query'
+      EXECUTE_MULTIPLEX = 'execute_multiplex'
       EXECUTE_QUERY_LAZY = 'execute_query_lazy'
       EXECUTE_FIELD = 'execute_field'
       EXECUTE_FIELD_LAZY = 'execute_field_lazy'
 
       def self.trace(key, data, &block)
         case key
-        when EXECUTE_QUERY
-          execute_query(data, &block)
+        when EXECUTE_MULTIPLEX
+          execute_multiplex(data, &block)
         when EXECUTE_QUERY_LAZY
           execute_query_lazy(data, &block)
         when EXECUTE_FIELD
@@ -55,19 +55,26 @@ module ApolloFederation
         end
       end
 
-      # Step 1:
-      # Create a trace hash on the query context and record start times.
-      def self.execute_query(data, &block)
-        query = data.fetch(:query)
-        return block.call unless query.context && query.context[:tracing_enabled]
+      def self.execute_multiplex(data, &block)
+        # Step 1:
+        # Create a trace hash on each query's context and record start times.
+        data.fetch(:multiplex).queries.each { |query| start_trace(query) }
+
+        results = block.call
+
+        # Step 5
+        # Attach the trace to the 'extensions' key of each result
+        results.map { |result| attach_trace_to_result(result) }
+      end
+
+      def self.start_trace(query)
+        return unless query.context && query.context[:tracing_enabled]
 
         query.context.namespace(ApolloFederation::Tracing::KEY).merge!(
           start_time: Time.now.utc,
           start_time_nanos: Process.clock_gettime(Process::CLOCK_MONOTONIC, :nanosecond),
           node_map: NodeMap.new,
         )
-
-        block.call
       end
 
       # Step 4:
@@ -188,6 +195,37 @@ module ApolloFederation
         result
       end
       # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+      def self.attach_trace_to_result(result)
+        return result unless result.context[:tracing_enabled]
+
+        trace = result.context.namespace(ApolloFederation::Tracing::KEY)
+
+        result['errors']&.each do |error|
+          trace[:node_map].add_error(error)
+        end
+
+        proto = ApolloFederation::Tracing::Trace.new(
+          start_time: to_proto_timestamp(trace[:start_time]),
+          end_time: to_proto_timestamp(trace[:end_time]),
+          duration_ns: trace[:end_time_nanos] - trace[:start_time_nanos],
+          root: trace[:node_map].root,
+        )
+
+        result[:extensions] ||= {}
+        result[:extensions][ApolloFederation::Tracing::KEY] =
+          Base64.encode64(proto.class.encode(proto))
+
+        if result.context[:debug_tracing]
+          result[:extensions][ApolloFederation::Tracing::DEBUG_KEY] = proto.to_h
+        end
+
+        result
+      end
+
+      def self.to_proto_timestamp(time)
+        Google::Protobuf::Timestamp.new(seconds: time.to_i, nanos: time.nsec)
+      end
     end
   end
 end

data/lib/apollo-federation/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ApolloFederation
-  VERSION = '1.1.3'
+  VERSION = '1.1.4.beta.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apollo-federation
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4.beta.1
 platform: ruby
 authors:
 - Noa Elad
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-16 00:00:00.000000000 Z
+date: 2020-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -191,8 +191,6 @@ files:
 - LICENSE
 - README.md
 - bin/generate-protos.sh
-- bin/prepare.rb
-- bin/publish.rb
 - bin/rspec
 - lib/apollo-federation.rb
 - lib/apollo-federation/any.rb
@@ -232,9 +230,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: 

data/bin/prepare.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-def set_version
-  new_version = ARGV[0]
-
-  contents = File.read('lib/apollo-federation/version.rb')
-
-  new_contents = contents.gsub(/VERSION = '[0-9.]*'/, "VERSION = '#{new_version}'")
-  File.write('lib/apollo-federation/version.rb', new_contents)
-end
-
-def bundle_install
-  system('bundle exec appraisal install')
-end
-
-def build_gem
-  system('gem build apollo-federation.gemspec')
-end
-
-set_version
-bundle_install
-build_gem

data/bin/publish.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-new_version = ARGV[0]
-gem_name = "apollo-federation-#{new_version}.gem"
-system("gem push #{gem_name}")
-File.delete(gem_name)