apollo-federation 3.7.0 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a3acf99a330df8e02ac0217773a9443b400d97a1ad47ed518a2f5631499711f
-  data.tar.gz: f9482d80b73b9ba0396fc51676a1ab28a12910c6a7fc3b7666421efff705a1ef
+  metadata.gz: ea55be797646c3f816a4f83e134bed0fd3cf3ee1cd7ce30cda45e88513385a75
+  data.tar.gz: 271cb2c2d084ae1499e1974de9d06035701a4d356781a0a7cfc49bf4c0eb88d4
 SHA512:
-  metadata.gz: 10f57a06a03f32dec83f3fbbd293c695a8019914b577b5ae25e6fedd86fa0d0e27be640ccc9261a5fed2f22154535e39d9d9408bfd16cce016ff2bd9cea7beda
-  data.tar.gz: c7bc892658495ae8576159aa0c14be88837744bfde4dbcd30acb15b443eb817b17400e49f8cd46c59e161ac5975374e84f5405bb30eb8f0280fd80dc2a646f51
+  metadata.gz: 58f93ab4cb85ddac1f2e537dd83d25e9fe88e174c43c4c7d864ee6e2b16858d510dd79f36b246ac6bfda27bef7a940ea2840c414f613ca92e5bb7d63f1cec9b1
+  data.tar.gz: 36f9fd3a2259508d896d8bb42f0e187bacfe628bcfdf8d88ac1effc10f62bf465da5c4a6ff38dd5c682527cf1c710becd6f8c5c2d27c6883801b396b04d55725

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+# [3.8.0](https://github.com/Gusto/apollo-federation-ruby/compare/v3.7.1...v3.8.0) (2023-06-02)
+
+
+### Features
+
+* optionally underscore _Any keys ([#248](https://github.com/Gusto/apollo-federation-ruby/issues/248)) ([f1688e7](https://github.com/Gusto/apollo-federation-ruby/commit/f1688e793ba08195a06ddad74d84f2858dcdfcdf))
+
+## [3.7.1](https://github.com/Gusto/apollo-federation-ruby/compare/v3.7.0...v3.7.1) (2023-06-01)
+
+
+### Bug Fixes
+
+* handle lazy `resolve_references` return values ([#250](https://github.com/Gusto/apollo-federation-ruby/issues/250)) ([e29b155](https://github.com/Gusto/apollo-federation-ruby/commit/e29b15550d48093c6ed5b73dabb8206a3e9463b0))
+* handle lazy `resolve_references` return values ([#250](https://github.com/Gusto/apollo-federation-ruby/issues/250)) ([1614440](https://github.com/Gusto/apollo-federation-ruby/commit/16144402d32de3d5016023b87fc2b949364761f5))
+* handle lazy resolve_references return values ([#250](https://github.com/Gusto/apollo-federation-ruby/issues/250)) ([fa72465](https://github.com/Gusto/apollo-federation-ruby/commit/fa72465bd5f1d38f3556b748b905f16f932829ac))
+
 # [3.7.0](https://github.com/Gusto/apollo-federation-ruby/compare/v3.6.9...v3.7.0) (2023-05-26)
 
 

data/README.md

@@ -325,12 +325,39 @@ Define a `resolve_reference` class method on your object. The method will be pas
 
 ```ruby
 class User < BaseObject
+  key fields: :user_id
+  field :user_id, ID, null: false
+  
   def self.resolve_reference(reference, context)
-    USERS.find { |user| user[:id] == reference[:id] }
+    USERS.find { |user| user[:userId] == reference[:userId] }
   end
 end
 ```
 
+To maintain backwards compatibility, by default, reference hash keys are camelcase. They can be underscored by setting `underscore_reference_keys` on your entity class. In order to maintain consistency with GraphQL Ruby, we may change the keys to be underscored by default in a future major release.
+
+```ruby
+class User < BaseObject
+  key fields: :user_id
+  field :user_id, ID, null: false
+  underscore_reference_keys true
+  
+  def self.resolve_reference(reference, context)
+    USERS.find { |user| user[:user_id] == reference[:user_id] }
+  end
+end
+```
+Alternatively you can change the default for your project by setting `underscore_reference_keys` on `BaseObject`:
+
+```ruby
+class BaseObject < GraphQL::Schema::Object
+  include ApolloFederation::Object
+
+  field_class BaseField
+  underscore_reference_keys true
+end
+```
+
 ### Tracing
 
 To support [federated tracing](https://www.apollographql.com/docs/apollo-server/federation/metrics/):

data/lib/apollo-federation/entities_field.rb

@@ -34,7 +34,7 @@ module ApolloFederation
         .with_index { |r, i| [r, i] }
         .group_by { |(r, _i)| r[:__typename] }
 
-      grouped_references_with_indices.each do |typename, references_with_indices|
+      maybe_lazies = grouped_references_with_indices.map do |typename, references_with_indices|
         references = references_with_indices.map(&:first)
         indices = references_with_indices.map(&:last)
 
@@ -49,6 +49,14 @@ module ApolloFederation
         # TODO: What if the type is an interface?
         type_class = class_of_type(type)
 
+        if type_class.underscore_reference_keys
+          references.map! do |reference|
+            reference.transform_keys do |key|
+              GraphQL::Schema::Member::BuildType.underscore(key.to_s).to_sym
+            end
+          end
+        end
+
         if type_class.respond_to?(:resolve_references)
           results = type_class.resolve_references(references, context)
         elsif type_class.respond_to?(:resolve_reference)
@@ -57,21 +65,25 @@ module ApolloFederation
           results = references
         end
 
-        results_with_indices = results.zip(indices)
-
-        results_with_indices.each do |result, i|
-          final_result[i] = 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
+        context.schema.after_lazy(results) do |resolved_results|
+          resolved_results.zip(indices).each do |result, i|
+            final_result[i] = 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
 
-      final_result
+      # Make sure we've resolved the outer level of lazies so we can return an array with a possibly lazy
+      # entry for each requested entity
+      GraphQL::Execution::Lazy.all(maybe_lazies).then do
+        final_result
+      end
     end
 
     private

data/lib/apollo-federation/object.rb

@@ -43,6 +43,18 @@ module ApolloFederation
           arguments: arguments,
         )
       end
+
+      def underscore_reference_keys(value = nil)
+        if value.nil?
+          if @underscore_reference_keys.nil?
+            find_inherited_value(:underscore_reference_keys, false)
+          else
+            @underscore_reference_keys
+          end
+        else
+          @underscore_reference_keys = value
+        end
+      end
     end
   end
 end

data/lib/apollo-federation/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apollo-federation
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.8.0
 platform: ruby
 authors:
 - Noa Elad
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-26 00:00:00.000000000 Z
+date: 2023-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql