apollo-federation 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c9617a66dc6c2f6494bffedd691cc4058c9f3caddb3ebb597eb2379baeb0849
-  data.tar.gz: 53e28fe56d42405030a674d7d4f27bc0360fd7768e2f635d57eb27923cc1f94a
+  metadata.gz: c06244e9136f28d4a4c15906ab176c9d4d83ea685c1b2a73bcac91d6f1ac8e65
+  data.tar.gz: f9f9eec152182226fe35fc07f97f7e4a787a7ba2cd45442f2725f8c7a593a28e
 SHA512:
-  metadata.gz: 7163ef5206d0d86cbf97830b965561bb6d9d5e3b35a1370053fda2d4285a95c45d5fd9eb820c258a2f0f7caabcd4ad63e4884ecf346e68a94f971a3c034741a9
-  data.tar.gz: 782dcece3899ee1edce74aa137cd1ccddd0778acc6a548a3b090d89deba1ca67f7a6adaba7344c100fd83d7f36250ef303457db2fc7f797c62eba51e3667b372
+  metadata.gz: 451f1e7582fcbe3a85061755ef537678c819532879994584243c9ce9424883496d4ae9db79926dd25a7b5baab374395438d670e0c1967735ca31cf07519c5058
+  data.tar.gz: b118eda2b44fb44499745b4161cb75fc75dc59b59e29158d434b8152e23ce772b1b51c47820a8e4c9fb5c0275262b0a02d826dc1bfeda56ad3d4fac697fb3ab7

data/CHANGELOG.md

@@ -1,3 +1,38 @@
+# [1.1.0](https://github.com/Gusto/apollo-federation-ruby/compare/v1.0.4...v1.1.0) (2020-05-27)
+
+
+### Features
+
+* Add support for interpreter runtime ([#65](https://github.com/Gusto/apollo-federation-ruby/issues/65)) ([1957da0](https://github.com/Gusto/apollo-federation-ruby/commit/1957da0))
+
+## [1.0.4](https://github.com/Gusto/apollo-federation-ruby/compare/v1.0.3...v1.0.4) (2020-04-06)
+
+
+### Bug Fixes
+
+* Fix spec to account for breaking change to graphql-ruby 1.10.0 ([#62](https://github.com/Gusto/apollo-federation-ruby/issues/62)) ([a631441](https://github.com/Gusto/apollo-federation-ruby/commit/a631441))
+
+## [1.0.3](https://github.com/Gusto/apollo-federation-ruby/compare/v1.0.2...v1.0.3) (2020-03-25)
+
+
+### Bug Fixes
+
+* Make the tracer work with the new interpreter runtime ([#59](https://github.com/Gusto/apollo-federation-ruby/issues/59)) ([de4caf0](https://github.com/Gusto/apollo-federation-ruby/commit/de4caf0))
+
+## [1.0.2](https://github.com/Gusto/apollo-federation-ruby/compare/v1.0.1...v1.0.2) (2020-02-19)
+
+
+### Bug Fixes
+
+* service field context ([#50](https://github.com/Gusto/apollo-federation-ruby/issues/50)) ([6dd1fe7](https://github.com/Gusto/apollo-federation-ruby/commit/6dd1fe7))
+
+## [1.0.1](https://github.com/Gusto/apollo-federation-ruby/compare/v1.0.0...v1.0.1) (2020-01-29)
+
+
+### Bug Fixes
+
+* Send context to SDL generation / don't cache ([#45](https://github.com/Gusto/apollo-federation-ruby/issues/45)) ([9a29be1](https://github.com/Gusto/apollo-federation-ruby/commit/9a29be1))
+
 # [1.0.0](https://github.com/Gusto/apollo-federation-ruby/compare/v0.5.1...v1.0.0) (2019-12-09)
 
 

data/README.md

@@ -1,5 +1,7 @@
 # apollo-federation
 
+[![CircleCI](https://circleci.com/gh/Gusto/apollo-federation-ruby/tree/master.svg?style=svg)](https://circleci.com/gh/Gusto/apollo-federation-ruby/tree/master)
+
 This gem extends the [GraphQL Ruby](http://graphql-ruby.org/) gem to add support for creating an [Apollo Federation](https://www.apollographql.com/docs/apollo-server/federation/introduction/) schema.
 
 ## DISCLAIMER

data/lib/apollo-federation/entities_field.rb

@@ -13,7 +13,14 @@ module ApolloFederation
     module ClassMethods
       extend GraphQL::Schema::Member::HasFields
 
-      def define_entities_field(entity_type)
+      def define_entities_field(possible_entities)
+        # If there are any "entities", define the Entity union and and the Query._entities field
+        return if possible_entities.empty?
+
+        entity_type = Class.new(Entity) do
+          possible_types(*possible_entities)
+        end
+
         field(:_entities, [entity_type, null: true], null: false) do
           argument :representations, [Any], required: true
           extension(EntityTypeResolutionExtension)
@@ -32,8 +39,8 @@ module ApolloFederation
                 ' but no object type of that name was found in the schema'
         end
 
-        # TODO: Handle non-class types?
-        type_class = type.metadata[:type_class]
+        # TODO: What if the type is an interface?
+        type_class = type.is_a?(GraphQL::ObjectType) ? type.metadata[:type_class] : type
         if type_class.respond_to?(:resolve_reference)
           result = type_class.resolve_reference(reference, context)
         else

data/lib/apollo-federation/federated_document_from_schema_definition.rb

@@ -23,17 +23,17 @@ module ApolloFederation
         end
         federation_fields.each { |field| object_node = object_node.delete_child(field) }
       end
-      merge_directives(object_node, object_type.metadata[:federation_directives])
+      merge_directives(object_node, object_type)
     end
 
     def build_interface_type_node(interface_type)
       field_node = super
-      merge_directives(field_node, interface_type.metadata[:federation_directives])
+      merge_directives(field_node, interface_type)
     end
 
     def build_field_node(field_type)
       field_node = super
-      merge_directives(field_node, field_type.metadata[:federation_directives])
+      merge_directives(field_node, field_type)
     end
 
     def build_type_definition_nodes(types)
@@ -53,7 +53,15 @@ module ApolloFederation
       type == warden.root_type_for_operation('query')
     end
 
-    def merge_directives(node, directives)
+    def merge_directives(node, type)
+      if type.is_a?(ApolloFederation::HasDirectives)
+        directives = type.federation_directives
+      elsif type.is_a?(GraphQL::Define::InstanceDefinable)
+        directives = type.metadata[:federation_directives]
+      else
+        directives = []
+      end
+
       (directives || []).each do |directive|
         node = node.merge_directive(
           name: directive[:name],

data/lib/apollo-federation/has_directives.rb

@@ -2,6 +2,8 @@
 
 module ApolloFederation
   module HasDirectives
+    attr_reader :federation_directives
+
     def add_directive(name:, arguments: nil)
       @federation_directives ||= []
       @federation_directives << { name: name, arguments: arguments }

data/lib/apollo-federation/schema.rb

@@ -8,49 +8,93 @@ require 'apollo-federation/federated_document_from_schema_definition.rb'
 module ApolloFederation
   module Schema
     def self.included(klass)
-      klass.extend(ClassMethods)
+      if Gem::Version.new(GraphQL::VERSION) >= Gem::Version.new('1.10.0')
+        klass.extend(OneTenMethods)
+      else
+        klass.extend(OneNineMethods)
+      end
     end
 
-    module ClassMethods
-      def to_graphql
-        orig_defn = super
+    module CommonMethods
+      def federation_sdl(context: nil)
+        document_from_schema = FederatedDocumentFromSchemaDefinition.new(self, context: context)
+        GraphQL::Language::Printer.new.print(document_from_schema.document)
+      end
+
+      private
 
-        if query.nil?
+      def federation_query(query_obj)
+        # Build the new query object with the '_service' field
+        if query_obj.nil?
           base = GraphQL::Schema::Object
+        elsif Gem::Version.new(GraphQL::VERSION) >= Gem::Version.new('1.10.0')
+          base = query_obj
         else
-          base = query.metadata[:type_class]
+          base = query_obj.metadata[:type_class]
         end
 
-        federation_query = Class.new(base) do
+        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'
 
           include EntitiesField
           include ServiceField
         end
+      end
+    end
+
+    # TODO: Remove these once we drop support for graphql 1.9
+    module OneNineMethods
+      include CommonMethods
+
+      def to_graphql
+        orig_defn = super
+        @query_object = federation_query(query)
 
         possible_entities = orig_defn.types.values.select do |type|
           !type.introspection? && !type.default_scalar? && type.is_a?(GraphQL::ObjectType) &&
             type.metadata[:federation_directives]&.any? { |directive| directive[:name] == 'key' }
         end
+        @query_object.define_entities_field(possible_entities)
 
-        if !possible_entities.empty?
-          entity_type = Class.new(Entity) do
-            possible_types(*possible_entities)
+        super
+      end
+    end
+
+    module OneTenMethods
+      include CommonMethods
+
+      def query(new_query_object = nil)
+        if new_query_object
+          @orig_query_object = new_query_object
+        else
+          if !@federation_query_object
+            @federation_query_object = federation_query(@orig_query_object)
+            @federation_query_object.define_entities_field(schema_entities)
+
+            super(@federation_query_object)
           end
-          # TODO: Should/can we encapsulate all of this inside the module? What's the best/most Ruby
-          # way to split this out?
-          federation_query.define_entities_field(entity_type)
+
+          super
         end
+      end
 
-        query(federation_query)
+      private
 
-        super
-      end
+      def schema_entities
+        # Create a temporary schema that inherits from this one to extract the types
+        types_schema = Class.new(self)
+        # Add the original query objects to the types. We have to use orphan_types here to avoid
+        # infinite recursion
+        types_schema.orphan_types(@orig_query_object)
 
-      def federation_sdl
-        @federation_sdl ||= begin
-          document_from_schema = FederatedDocumentFromSchemaDefinition.new(self)
-          GraphQL::Language::Printer.new.print(document_from_schema.document)
+        # Walk through all of the types and determine which ones are entities (any type with a
+        # "key" directive)
+        types_schema.types.values.select do |type|
+          # TODO: Interfaces can have a key...
+          !type.introspection? && type.include?(ApolloFederation::Object) &&
+            type.federation_directives&.any? { |directive| directive[:name] == 'key' }
         end
       end
     end

data/lib/apollo-federation/service_field.rb

@@ -10,7 +10,8 @@ module ApolloFederation
     field(:_service, Service, null: false)
 
     def _service
-      { sdl: context.schema.class.federation_sdl }
+      schema_class = context.schema.is_a?(GraphQL::Schema) ? context.schema.class : context.schema
+      { sdl: schema_class.federation_sdl(context: context) }
     end
   end
 end

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

@@ -103,7 +103,7 @@ module ApolloFederation
       # because we don't have the error `location` here.
       # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       def self.execute_field(data, &block)
-        context = data.fetch(:context) || data.fetch(:query).context
+        context = data.fetch(:context, nil) || data.fetch(:query).context
         return block.call unless context && context[:tracing_enabled]
 
         start_time_nanos = Process.clock_gettime(Process::CLOCK_MONOTONIC, :nanosecond)
@@ -116,16 +116,17 @@ module ApolloFederation
 
         end_time_nanos = Process.clock_gettime(Process::CLOCK_MONOTONIC, :nanosecond)
 
-        # interpreter runtime
+        # legacy runtime
         if data.include?(:context)
           path = context.path
           field_name = context.field.graphql_name
           field_type = context.field.type.to_s
           parent_type = context.parent_type.graphql_name
-        else # legacy runtime
+        else # interpreter runtime
           path = data.fetch(:path)
-          field_name = data.fetch(:field).graphql_name
-          field_type = data.fetch(:field).type.unwrap.graphql_name
+          field = data.fetch(:field)
+          field_name = field.graphql_name
+          field_type = field.type.to_type_signature
           parent_type = data.fetch(:owner).graphql_name
         end
 
@@ -147,7 +148,7 @@ module ApolloFederation
       # Optional Step 3:
       # Overwrite the end times on the trace node if the resolver was lazy.
       def self.execute_field_lazy(data, &block)
-        context = data.fetch(:context) || data.fetch(:query).context
+        context = data.fetch(:context, nil) || data.fetch(:query).context
         return block.call unless context && context[:tracing_enabled]
 
         begin

data/lib/apollo-federation/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ApolloFederation
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apollo-federation
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Noa Elad
@@ -9,20 +9,20 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-09 00:00:00.000000000 Z
+date: 2020-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.9.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.9.8
 - !ruby/object:Gem::Dependency