apollo-federation 3.0.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97e0cffbe36d7e21115386a2c0cffa379b62eeff24922d1203a2abf1dbdf7059
-  data.tar.gz: 2220d5e08b981826d4494d98d9728a2bc4c1ef1a6aae9381f7f467204051c2c4
+  metadata.gz: 3133ca250d8e6ed9689a172c2fdaf373ae0ee0fcb371848cffeb75938f97be62
+  data.tar.gz: 5467c27805efb85724124ede7c1014abfffbd679aba915e188ec74edfc8a8051
 SHA512:
-  metadata.gz: e30f475dfa19d57e26b9374b7e6b59b33ff7125fdd57e22014448e0f7aaa741c188b7f72bde98b20953d4519fbd4fb76585a0336757123d34a95dee87e2b6044
-  data.tar.gz: df9e6125583486cdba492c97376d6fea8a9ff31b7fb72f2940375f53b426ec8cc3109178e9a3ca9d23f261df4dc5acc94244cbf76f1be26281ad264e4e94a075
+  metadata.gz: 446e436bbc11437122d01ba8c49097919b0c1d281ab40427ea330d3494d05dc21d10e3795394ef41bea9b24d5d33eb9c7ba854116f96cb32cc88318c51cde0ac
+  data.tar.gz: b22c3f55c0fb6114f68aefcedd08ed5f8acaebda5699f26be21e4cc9ad61c3d225aa6beb1f1253e64533dae56da6d869c8962a4b6aa75d548a9e032e01d3a8dc

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+# [3.3.0](https://github.com/Gusto/apollo-federation-ruby/compare/v3.2.0...v3.3.0) (2022-08-24)
+
+
+### Features
+
+* introduce optional `resolve_references` method ([#206](https://github.com/Gusto/apollo-federation-ruby/issues/206)) ([1e3b631](https://github.com/Gusto/apollo-federation-ruby/commit/1e3b631609e1dfec8c3f126cd9dc8e0a2b3a0a57))
+
+# [3.2.0](https://github.com/Gusto/apollo-federation-ruby/compare/v3.1.0...v3.2.0) (2022-08-15)
+
+
+### Features
+
+* allow custom namespace for linked directives ([03fdfea](https://github.com/Gusto/apollo-federation-ruby/commit/03fdfeafaaea3c98ca4b7a734ce760ea08410530))
+
+# [3.1.0](https://github.com/Gusto/apollo-federation-ruby/compare/v3.0.0...v3.1.0) (2022-06-21)
+
+
+### Features
+
+* Support Federation v2 ([#196](https://github.com/Gusto/apollo-federation-ruby/issues/196)) ([238736c](https://github.com/Gusto/apollo-federation-ruby/commit/238736cdb6f12121ce2a295c7a28fba3990012b9)), closes [/www.apollographql.com/docs/federation/federation-2/moving-to-federation-2/#opt-in-to-federation-2](https://github.com//www.apollographql.com/docs/federation/federation-2/moving-to-federation-2//issues/opt-in-to-federation-2)
+
 # [3.0.0](https://github.com/Gusto/apollo-federation-ruby/compare/v2.2.4...v3.0.0) (2022-04-05)
 
 

data/README.md

@@ -61,6 +61,15 @@ class MySchema < GraphQL::Schema
 end
 ```
 
+**Optional:** To opt in to Federation v2, specify the version in your schema:
+
+```ruby
+class MySchema < GraphQL::Schema
+  include ApolloFederation::Schema
+  federation version: '2.0'
+end
+```
+
 ## Example
 
 The [`example`](./example/) folder contains a Ruby implementation of Apollo's [`federation-demo`](https://github.com/apollographql/federation-demo). To run it locally, install the Ruby dependencies:
@@ -160,6 +169,59 @@ end
 ```
 See [field set syntax](#field-set-syntax) for more details on the format of the `fields` option.
 
+### The `@shareable` directive (Apollo Federation v2)
+
+[Apollo documentation](https://www.apollographql.com/docs/federation/federated-types/federated-directives/#shareable)
+
+Call `shareable` within your class definition:
+
+```ruby
+class User < BaseObject
+  shareable
+end
+```
+
+Pass the `shareable: true` option to your field definition:
+
+```ruby
+class User < BaseObject
+  field :id, ID, null: false, shareable: true
+end
+```
+
+### The `@inaccessible` directive (Apollo Federation v2)
+
+[Apollo documentation](https://www.apollographql.com/docs/federation/federated-types/federated-directives/#inaccessible)
+
+Call `inaccessible` within your class definition:
+
+```ruby
+class User < BaseObject
+  inaccessible
+end
+```
+
+Pass the `inaccessible: true` option to your field definition:
+
+```ruby
+class User < BaseObject
+  field :id, ID, null: false, inaccessible: true
+end
+```
+
+### The `@override` directive (Apollo Federation v2)
+
+[Apollo documentation](https://www.apollographql.com/docs/federation/federated-types/federated-directives/#override)
+
+Pass the `override:` option to your field definition:
+
+```ruby
+class Product < BaseObject
+  field :id, ID, null: false
+  field :inStock, Boolean, null: false, override: { from: 'Products' }
+end
+```
+
 ### Field set syntax
 
 Field sets can be either strings encoded with the Apollo Field Set [syntax]((https://www.apollographql.com/docs/apollo-server/federation/federation-spec/#scalar-_fieldset)) or arrays, hashes and snake case symbols that follow the graphql-ruby conventions:

data/lib/apollo-federation/entities_field.rb

@@ -27,8 +27,10 @@ module ApolloFederation
     end
 
     def _entities(representations:)
-      representations.map do |reference|
-        typename = reference[:__typename]
+      grouped_references = representations.group_by { |r| r[:__typename] }
+
+      final_results = []
+      grouped_references.each do |typename, references|
         # TODO: Use warden or schema?
         type = context.warden.get_type(typename)
         if type.nil? || type.kind != GraphQL::TypeKinds::OBJECT
@@ -40,21 +42,27 @@ module ApolloFederation
         # TODO: What if the type is an interface?
         type_class = class_of_type(type)
 
-        if type_class.respond_to?(:resolve_reference)
-          result = type_class.resolve_reference(reference, context)
+        if type_class.respond_to?(:resolve_references)
+          results = type_class.resolve_references(references, context)
+        elsif type_class.respond_to?(:resolve_reference)
+          results = references.map { |reference| type_class.resolve_reference(reference, context) }
         else
-          result = reference
+          results = references
         end
 
-        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
+        results = results.map do |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
+        final_results = final_results.concat(results)
       end
+      final_results
     end
 
     private

data/lib/apollo-federation/federated_document_from_schema_definition.rb

@@ -55,20 +55,28 @@ module ApolloFederation
 
     def merge_directives(node, type)
       if type.is_a?(ApolloFederation::HasDirectives)
-        directives = type.federation_directives
+        directives = type.federation_directives || []
       else
         directives = []
       end
 
-      (directives || []).each do |directive|
+      directives.each do |directive|
         node = node.merge_directive(
-          name: directive[:name],
+          name: directive_name(directive),
           arguments: build_arguments_node(directive[:arguments]),
         )
       end
       node
     end
 
+    def directive_name(directive)
+      if schema.federation_2?
+        "#{schema.link_namespace}__#{directive[:name]}"
+      else
+        directive[:name]
+      end
+    end
+
     def build_arguments_node(arguments)
       (arguments || []).map do |arg|
         GraphQL::Language::Nodes::Argument.new(name: arg[:name], value: arg[:values])

data/lib/apollo-federation/field.rb

@@ -7,10 +7,29 @@ module ApolloFederation
   module Field
     include HasDirectives
 
-    def initialize(*args, external: false, requires: nil, provides: nil, **kwargs, &block)
+    VERSION_1_DIRECTIVES = %i[external requires provides].freeze
+    VERSION_2_DIRECTIVES = %i[shareable inaccessible override].freeze
+
+    def initialize(*args, **kwargs, &block)
+      add_v1_directives(**kwargs)
+      add_v2_directives(**kwargs)
+
+      # Remove the custom kwargs
+      kwargs = kwargs.delete_if do |k, _|
+        VERSION_1_DIRECTIVES.include?(k) || VERSION_2_DIRECTIVES.include?(k)
+      end
+
+      # Pass on the default args:
+      super(*args, **kwargs, &block)
+    end
+
+    private
+
+    def add_v1_directives(external: nil, requires: nil, provides: nil, **_kwargs)
       if external
         add_directive(name: 'external')
       end
+
       if requires
         add_directive(
           name: 'requires',
@@ -23,6 +42,7 @@ module ApolloFederation
           ],
         )
       end
+
       if provides
         add_directive(
           name: 'provides',
@@ -36,8 +56,29 @@ module ApolloFederation
         )
       end
 
-      # Pass on the default args:
-      super(*args, **kwargs, &block)
+      nil
+    end
+
+    def add_v2_directives(shareable: nil, inaccessible: nil, override: nil, **_kwargs)
+      if shareable
+        add_directive(name: 'shareable')
+      end
+
+      if inaccessible
+        add_directive(name: 'inaccessible')
+      end
+
+      if override
+        add_directive(
+          name: 'override',
+          arguments: [
+            name: 'from',
+            values: override[:from],
+          ],
+        )
+      end
+
+      nil
     end
   end
 end

data/lib/apollo-federation/interface.rb

@@ -18,6 +18,10 @@ module ApolloFederation
         add_directive(name: 'extends')
       end
 
+      def inaccessible
+        add_directive(name: 'inaccessible')
+      end
+
       def key(fields:, camelize: true)
         add_directive(
           name: 'key',

data/lib/apollo-federation/object.rb

@@ -16,6 +16,14 @@ module ApolloFederation
         add_directive(name: 'extends')
       end
 
+      def shareable
+        add_directive(name: 'shareable')
+      end
+
+      def inaccessible
+        add_directive(name: 'inaccessible')
+      end
+
       def key(fields:, camelize: true)
         add_directive(
           name: 'key',

data/lib/apollo-federation/schema.rb

@@ -12,9 +12,35 @@ module ApolloFederation
     end
 
     module CommonMethods
+      FEDERATION_2_PREFIX = <<~SCHEMA
+        extend schema
+          @link(url: "https://specs.apollo.dev/federation/v2.0")
+
+      SCHEMA
+
+      def federation(version: '1.0', link: {})
+        @federation_version = version
+        @link = { as: 'federation' }.merge(link)
+      end
+
+      def federation_version
+        @federation_version || '1.0'
+      end
+
+      def federation_2?
+        Gem::Version.new(federation_version.to_s) >= Gem::Version.new('2.0.0')
+      end
+
       def federation_sdl(context: nil)
         document_from_schema = FederatedDocumentFromSchemaDefinition.new(self, context: context)
-        GraphQL::Language::Printer.new.print(document_from_schema.document)
+
+        output = GraphQL::Language::Printer.new.print(document_from_schema.document)
+        output.prepend(FEDERATION_2_PREFIX) if federation_2?
+        output
+      end
+
+      def link_namespace
+        @link[:as]
       end
 
       def query(new_query_object = nil)
@@ -34,6 +60,14 @@ module ApolloFederation
 
       private
 
+      def federation_2_prefix
+        <<~SCHEMA
+          extend schema
+            @link(url: "https://specs.apollo.dev/federation/v2.0", as: "#{link_namespace}")
+
+        SCHEMA
+      end
+
       def schema_entities
         # Create a temporary schema that inherits from this one to extract the types
         types_schema = Class.new(self)

data/lib/apollo-federation/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apollo-federation
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Noa Elad
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-05 00:00:00.000000000 Z
+date: 2022-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql