apollo-federation 1.1.0 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c06244e9136f28d4a4c15906ab176c9d4d83ea685c1b2a73bcac91d6f1ac8e65
-  data.tar.gz: f9f9eec152182226fe35fc07f97f7e4a787a7ba2cd45442f2725f8c7a593a28e
+  metadata.gz: 21cd789f15e0947e99f00d58223c517a58dc1358760c4372f24e55235d84a270
+  data.tar.gz: 0bf2d29c1ff4036be133922f7a9bfe1bea0bc925eed1d27e321de191af2403a8
 SHA512:
-  metadata.gz: 451f1e7582fcbe3a85061755ef537678c819532879994584243c9ce9424883496d4ae9db79926dd25a7b5baab374395438d670e0c1967735ca31cf07519c5058
-  data.tar.gz: b118eda2b44fb44499745b4161cb75fc75dc59b59e29158d434b8152e23ce772b1b51c47820a8e4c9fb5c0275262b0a02d826dc1bfeda56ad3d4fac697fb3ab7
+  metadata.gz: b139f2366cbc0a90051869c086350d2c7af63beef66376cbc4ce8190aaef422574489a0dd2d5599cfc223dcf7a92bf8191e2f424af31ce9c5a594e70a87d1372
+  data.tar.gz: 0d6f9257c11937ba747d54c6f903928ffef52a36875d87b67d8e877562fc34ba771545b5e8f81bf6c5a7c9de388bd0a56820a6e7acd34056c1a1699420f6378c

data/CHANGELOG.md

@@ -1,3 +1,38 @@
+## [1.1.4](https://github.com/Gusto/apollo-federation-ruby/compare/v1.1.3...v1.1.4) (2020-09-25)
+
+
+### Bug Fixes
+
+* **tracing:** properly handle parsing and validation errors ([#102](https://github.com/Gusto/apollo-federation-ruby/issues/102)) ([a1c2a41](https://github.com/Gusto/apollo-federation-ruby/commit/a1c2a41d3d01f06364d439cdcc273f4678fed7bd)), closes [#101](https://github.com/Gusto/apollo-federation-ruby/issues/101) [#101](https://github.com/Gusto/apollo-federation-ruby/issues/101)
+
+## [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)
+
+
+### Bug Fixes
+
+* **tracing:** Properly handle tracing fields that resolve an array of lazy values ([#87](https://github.com/Gusto/apollo-federation-ruby/issues/87)) ([a9eed77](https://github.com/Gusto/apollo-federation-ruby/commit/a9eed77bbe5859456f93be00fbcafa02142ad5ed))
+
+## [1.1.2](https://github.com/Gusto/apollo-federation-ruby/compare/v1.1.1...v1.1.2) (2020-06-09)
+
+
+### Bug Fixes
+
+* Fix _service field type owner ([#70](https://github.com/Gusto/apollo-federation-ruby/issues/70)) ([364e54f](https://github.com/Gusto/apollo-federation-ruby/commit/364e54fbb333b7cd4fe30f04bf72733b0e18d3f4))
+
+## [1.1.1](https://github.com/Gusto/apollo-federation-ruby/compare/v1.1.0...v1.1.1) (2020-05-29)
+
+
+### Bug Fixes
+
+* **lazy resolve:** Handle problem with sync resolve ([#58](https://github.com/Gusto/apollo-federation-ruby/issues/58)) ([e66c22b](https://github.com/Gusto/apollo-federation-ruby/commit/e66c22ba6fe51a7c282190ee77bd02dbfa514a66))
+
 # [1.1.0](https://github.com/Gusto/apollo-federation-ruby/compare/v1.0.4...v1.1.0) (2020-05-27)
 
 

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/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath,)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/lib/apollo-federation/entities_field.rb

@@ -2,7 +2,6 @@
 
 require 'graphql'
 require 'apollo-federation/any'
-require 'apollo-federation/entity_type_resolution_extension'
 
 module ApolloFederation
   module EntitiesField
@@ -23,7 +22,6 @@ module ApolloFederation
 
         field(:_entities, [entity_type, null: true], null: false) do
           argument :representations, [Any], required: true
-          extension(EntityTypeResolutionExtension)
         end
       end
     end
@@ -47,7 +45,14 @@ module ApolloFederation
           result = reference
         end
 
-        [type, result]
+        context.schema.after_lazy(result) do |resolved_value|
+          # TODO: This isn't 100% correct: if (for some reason) 2 different resolve_reference calls
+          # return the same object, it might not have the right type
+          # Right now, apollo-federation just adds a __typename property to the result,
+          # but I don't really like the idea of modifying the resolved object
+          context[resolved_value] = type
+          resolved_value
+        end
       end
     end
   end

data/lib/apollo-federation/schema.rb

@@ -33,7 +33,7 @@ module ApolloFederation
           base = query_obj.metadata[:type_class]
         end
 
-        Class.new(base) do
+        klass = Class.new(base) do
           # TODO: Maybe the name should inherit from the original Query name
           # Or MAYBE we should just modify the original class?
           graphql_name 'Query'
@@ -41,6 +41,9 @@ module ApolloFederation
           include EntitiesField
           include ServiceField
         end
+
+        klass.define_service_field
+        klass
       end
     end
 

data/lib/apollo-federation/service_field.rb

@@ -5,9 +5,17 @@ require 'apollo-federation/service'
 
 module ApolloFederation
   module ServiceField
-    extend GraphQL::Schema::Member::HasFields
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      extend GraphQL::Schema::Member::HasFields
 
-    field(:_service, Service, null: false)
+      def define_service_field
+        field(:_service, Service, null: false)
+      end
+    end
 
     def _service
       schema_class = context.schema.is_a?(GraphQL::Schema) ? context.schema.class : context.schema

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,35 +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)
-      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:
@@ -159,17 +166,27 @@ module ApolloFederation
 
         end_time_nanos = Process.clock_gettime(Process::CLOCK_MONOTONIC, :nanosecond)
 
-        # interpreter runtime
+        # legacy runtime
         if data.include?(:context)
-          context = data.fetch(:context)
           path = context.path
-        else # legacy runtime
-          context = data.fetch(:query).context
+          field = context.field
+        else # interpreter runtime
           path = data.fetch(:path)
+          field = data.fetch(:field)
         end
 
         trace = context.namespace(ApolloFederation::Tracing::KEY)
 
+        # When a field is resolved with an array of lazy values, the interpreter fires an
+        # `execute_field` for the resolution of the field and then a `execute_field_lazy` event for
+        # each lazy value in the array. Since the path here will contain an index (indicating which
+        # lazy value we're executing: e.g. ['arrayOfLazies', 0]), we won't have a node for the path.
+        # We only care about the end of the parent field (e.g. ['arrayOfLazies']), so we get the
+        # node for that path. What ends up happening is we update the end_time for the parent node
+        # for each of the lazy values. The last one that's executed becomes the final end time.
+        if field.type.list? && path.last.is_a?(Integer)
+          path = path[0...-1]
+        end
         node = trace[:node_map].node_for_path(path)
         node.end_time = end_time_nanos - trace[:start_time_nanos]
 
@@ -178,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.0'
+  VERSION = '1.1.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apollo-federation
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.4
 platform: ruby
 authors:
 - Noa Elad
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-27 00:00:00.000000000 Z
+date: 2020-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -53,6 +53,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -137,6 +165,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-debug-ide
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Ruby implementation of Apollo Federation
 email:
 - noa.elad@gusto.com
@@ -149,13 +191,11 @@ 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
 - lib/apollo-federation/entities_field.rb
 - lib/apollo-federation/entity.rb
-- lib/apollo-federation/entity_type_resolution_extension.rb
 - lib/apollo-federation/federated_document_from_schema_definition.rb
 - lib/apollo-federation/field.rb
 - lib/apollo-federation/has_directives.rb

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 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)

data/lib/apollo-federation/entity_type_resolution_extension.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-class EntityTypeResolutionExtension < GraphQL::Schema::FieldExtension
-  def after_resolve(value:, context:, **_rest)
-    synced_value =
-      value.map do |type, result|
-        [type, context.query.schema.sync_lazy(result)]
-      end
-
-    # TODO: This isn't 100% correct: if (for some reason) 2 different resolve_reference calls
-    # return the same object, it might not have the right type
-    # Right now, apollo-federation just adds a __typename property to the result,
-    # but I don't really like the idea of modifying the resolved object
-    synced_value.each { |type, result| context[result] = type }
-
-    synced_value.map { |_, result| result }
-  end
-end