graphql-ruby 2.3 compatibility (#282)

Bajena · Bajena · web-flow · commit fb14b42d0f11 · 2025-04-01T17:03:49.000-07:00
Co-authored-by: Bajena &lt;jan.bajena@productboard.com&gt;
diff --git a/.ruby-version b/.ruby-version
@@ -1 +1 @@
-2.7.5
+3.2.0
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -138,6 +138,7 @@ PLATFORMS
   arm64-darwin-21
   arm64-darwin-22
   arm64-darwin-23
+  arm64-darwin-24
   x86_64-darwin-20
   x86_64-darwin-21
   x86_64-darwin-22
@@ -151,7 +152,7 @@ DEPENDENCIES
   mutex_m
   ostruct
   pry-byebug
-  rack
+  rack (~> 2.0)
   rackup
   rake
   rspec
diff --git a/README.md b/README.md
@@ -362,7 +362,7 @@ end
 
 To support [federated tracing](https://www.apollographql.com/docs/apollo-server/federation/metrics/):
 
-1. Add `use ApolloFederation::Tracing` to your schema class.
+1. Add `trace_with ApolloFederation::Tracing::Tracer` to your schema class.
 2. Change your controller to add `tracing_enabled: true` to the execution context based on the presence of the "include trace" header:
    ```ruby
    def execute
diff --git a/apollo-federation.gemspec b/apollo-federation.gemspec
@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'actionpack'
   spec.add_development_dependency 'debug'
   spec.add_development_dependency 'pry-byebug'
-  spec.add_development_dependency 'rack'
+  spec.add_development_dependency 'rack', '~> 2.0'
   spec.add_development_dependency 'rackup'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
diff --git a/example/accounts.rb b/example/accounts.rb
@@ -52,7 +52,12 @@ class AccountSchema < GraphQL::Schema
     use GraphQL::Execution::Interpreter
     use GraphQL::Analysis::AST
   end
-  use ApolloFederation::Tracing
+
+  if Gem::Version.new(GraphQL::VERSION) < Gem::Version.new('2.3.0')
+    use ApolloFederation::Tracing
+  else
+    trace_with ApolloFederation::Tracing::Tracer
+  end
 
   include ApolloFederation::Schema
 
diff --git a/example/inventory.rb b/example/inventory.rb
@@ -46,7 +46,12 @@ class InventorySchema < GraphQL::Schema
     use GraphQL::Execution::Interpreter
     use GraphQL::Analysis::AST
   end
-  use ApolloFederation::Tracing
+
+  if Gem::Version.new(GraphQL::VERSION) < Gem::Version.new('2.3.0')
+    use ApolloFederation::Tracing
+  else
+    trace_with ApolloFederation::Tracing::Tracer
+  end
 
   include ApolloFederation::Schema
 
diff --git a/example/products.rb b/example/products.rb
@@ -62,7 +62,12 @@ class ProductSchema < GraphQL::Schema
     use GraphQL::Execution::Interpreter
     use GraphQL::Analysis::AST
   end
-  use ApolloFederation::Tracing
+
+  if Gem::Version.new(GraphQL::VERSION) < Gem::Version.new('2.3.0')
+    use ApolloFederation::Tracing
+  else
+    trace_with ApolloFederation::Tracing::Tracer
+  end
 
   include ApolloFederation::Schema
 
diff --git a/example/reviews.rb b/example/reviews.rb
@@ -100,7 +100,12 @@ class ReviewSchema < GraphQL::Schema
     use GraphQL::Execution::Interpreter
     use GraphQL::Analysis::AST
   end
-  use ApolloFederation::Tracing
+
+  if Gem::Version.new(GraphQL::VERSION) < Gem::Version.new('2.3.0')
+    use ApolloFederation::Tracing
+  else
+    trace_with ApolloFederation::Tracing::Tracer
+  end
 
   include ApolloFederation::Schema
 
diff --git a/lib/apollo-federation/federated_document_from_schema_definition.rb b/lib/apollo-federation/federated_document_from_schema_definition.rb
@@ -69,7 +69,7 @@ def build_field_node(field_type)
     def build_type_definition_nodes(types)
       non_federation_types = types.select do |type|
         if query_type?(type)
-          !warden.fields(type).all? { |field| FEDERATION_QUERY_FIELDS.include?(field.graphql_name) }
+          !fields_for_type(type).all? { |field| FEDERATION_QUERY_FIELDS.include?(field.graphql_name) }
         else
           !FEDERATION_TYPES.include?(type.graphql_name)
         end
@@ -79,8 +79,23 @@ def build_type_definition_nodes(types)
 
     private
 
+    def fields_for_type(type)
+      return warden.fields(type) if use_warden?
+
+      @types.fields(type)
+    end
+
     def query_type?(type)
-      type == warden.root_type_for_operation('query')
+      return type == warden.root_type_for_operation('query') if use_warden?
+
+      type == @types.query_root
+    end
+
+    # graphql-ruby 2.3.8 removed the warden definition from a number of places:
+    # https://github.com/rmosolgo/graphql-ruby/compare/v2.3.7...v2.3.8#diff-e9dd0d295a58b66fabd1cf717040de5a78ade0feac6aeabae5247b5785c029ab
+    # The internal usage of `warden` was replaced with `types` in many cases.
+    def use_warden?
+      Gem::Version.new(GraphQL::VERSION) < Gem::Version.new('2.3.8')
     end
 
     def merge_directives(node, type)
diff --git a/lib/apollo-federation/tracing/tracer.rb b/lib/apollo-federation/tracing/tracer.rb
@@ -40,6 +40,40 @@ module Tracer
       EXECUTE_FIELD = 'execute_field'
       EXECUTE_FIELD_LAZY = 'execute_field_lazy'
 
+      def execute_multiplex(multiplex:)
+        ApolloFederation::Tracing::Tracer.execute_multiplex(multiplex: multiplex) { yield }
+      end
+
+      def execute_query_lazy(query:, multiplex:)
+        ApolloFederation::Tracing::Tracer.execute_query_lazy(query: query, multiplex: multiplex) { yield }
+      end
+
+      def execute_field(field:, query:, ast_node:, arguments:, object:)
+        ApolloFederation::Tracing::Tracer.execute_field(
+          field: field,
+          query: query,
+          ast_node: ast_node,
+          arguments: arguments,
+          object: object,
+          owner: field.owner,
+          path: query.context[:current_path],
+        ) { yield }
+      end
+
+      def execute_field_lazy(field:, query:, ast_node:, arguments:, object:)
+        ApolloFederation::Tracing::Tracer.execute_field_lazy(
+          field: field,
+          query: query,
+          ast_node: ast_node,
+          arguments: arguments,
+          object: object,
+          owner: field.owner,
+          path: query.context[:current_path],
+        ) { yield }
+      end
+
+      # The method below was used by older versions of graphql-ruby.
+      # After graphq-ruby 2.3.0 the trace modules should respond to specific methods such as `execute_field` above.
       def self.trace(key, data, &block)
         case key
         when EXECUTE_MULTIPLEX
diff --git a/spec/apollo-federation/entities_field_spec.rb b/spec/apollo-federation/entities_field_spec.rb
@@ -283,6 +283,7 @@ def self.resolve_references(_references, _context)
                     { 'id' => id_2.to_s, 'otherField' => 'data2!' },
                   ]
                 }
+
                 it { expect(errors).to be_nil }
 
                 context 'when resolve_references returns a lazy object' do
@@ -316,6 +317,7 @@ def self.resolve_references(_references, _context)
                       { 'id' => id_2.to_s, 'otherField' => 'data2!' },
                     ]
                   }
+
                   it { expect(errors).to be_nil }
                 end
 
diff --git a/spec/apollo-federation/service_field_v1_spec.rb b/spec/apollo-federation/service_field_v1_spec.rb
@@ -54,6 +54,37 @@ def execute_sdl(schema)
           GRAPHQL
         )
       end
+
+      it 'returns valid SDL for @key directives' do
+        product = Class.new(base_object) do
+          graphql_name 'Product'
+          key fields: :upc
+
+          field :upc, String, null: false
+        end
+
+        query_obj = Class.new(base_object) do
+          graphql_name 'Query'
+
+          field :product, product, null: true
+        end
+
+        schema = Class.new(base_schema) do
+          query query_obj
+        end
+
+        expect(execute_sdl(schema)).to match_sdl(
+          <<~GRAPHQL,
+            type Product @key(fields: "upc") {
+              upc: String!
+            }
+
+            type Query {
+              product: Product
+            }
+          GRAPHQL
+        )
+      end
     end
 
     context 'when a Query object is not provided' do
@@ -77,6 +108,27 @@ def execute_sdl(schema)
           GRAPHQL
         )
       end
+
+      it 'returns valid SDL for @key directives' do
+        product = Class.new(base_object) do
+          graphql_name 'Product'
+          key fields: :upc
+
+          field :upc, String, null: false
+        end
+
+        schema = Class.new(base_schema) do
+          orphan_types product
+        end
+
+        expect(execute_sdl(schema)).to match_sdl(
+          <<~GRAPHQL,
+            type Product @key(fields: "upc") {
+              upc: String!
+            }
+          GRAPHQL
+        )
+      end
     end
 
     it 'sets the Query as the owner to the _service field' do
@@ -211,62 +263,6 @@ def execute_sdl(schema)
       )
     end
 
-    context 'when a Query object is provided' do
-      it 'returns valid SDL for @key directives' do
-        product = Class.new(base_object) do
-          graphql_name 'Product'
-          key fields: :upc
-
-          field :upc, String, null: false
-        end
-
-        query_obj = Class.new(base_object) do
-          graphql_name 'Query'
-
-          field :product, product, null: true
-        end
-
-        schema = Class.new(base_schema) do
-          query query_obj
-        end
-
-        expect(execute_sdl(schema)).to match_sdl(
-          <<~GRAPHQL,
-            type Product @key(fields: "upc") {
-              upc: String!
-            }
-
-            type Query {
-              product: Product
-            }
-          GRAPHQL
-        )
-      end
-    end
-
-    context 'when a Query object is not provided' do
-      it 'returns valid SDL for @key directives' do
-        product = Class.new(base_object) do
-          graphql_name 'Product'
-          key fields: :upc
-
-          field :upc, String, null: false
-        end
-
-        schema = Class.new(base_schema) do
-          orphan_types product
-        end
-
-        expect(execute_sdl(schema)).to match_sdl(
-          <<~GRAPHQL,
-            type Product @key(fields: "upc") {
-              upc: String!
-            }
-          GRAPHQL
-        )
-      end
-    end
-
     it 'returns valid SDL for multiple @key directives' do
       product = Class.new(base_object) do
         graphql_name 'Product'
diff --git a/spec/apollo-federation/service_field_v2_spec.rb b/spec/apollo-federation/service_field_v2_spec.rb
diff --git a/spec/apollo-federation/tracing_spec.rb b/spec/apollo-federation/tracing_spec.rb
