Rails 8 + Fixes and Features (#42)

crashtech · web-flow · commit 15cc23b8e0ff · 2025-07-30T18:37:50.000-03:00
* Add Rails 8.0 support, drop tests for Rails 6, fix problem with default arguments and validation, and add better way to define type methods on sources

* Fix broken specs

* Add sqlite3 gem to Rails 8

* Skip test where stub does not work anymore
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -42,12 +42,20 @@ jobs:
       fail-fast: false
       matrix:
         ruby: ['2.7', '3.0', '3.1', '3.2', '3.3']
-        rails: ['6.0', '6.1', '7.0', '7.1', '7.2']
+        rails: ['7.0', '7.1', '7.2', '8.0']
         exclude:
+          # Rails 7.2 requires Ruby 3.1 or higher
           - ruby: '2.7'
             rails: '7.2'
           - ruby: '3.0'
             rails: '7.2'
+          # Rails 8.0 requires Ruby 3.2 or higher
+          - ruby: '2.7'
+            rails: '8.0'
+          - ruby: '3.0'
+            rails: '8.0'
+          - ruby: '3.1'
+            rails: '8.0'
 
     steps:
       - uses: actions/checkout@v3
diff --git a/Gemfile.lock b/Gemfile.lock
diff --git a/gemfiles/Gemfile.rails-6.1 b/gemfiles/Gemfile.rails-6.1
diff --git a/gemfiles/Gemfile.rails-7.0 b/gemfiles/Gemfile.rails-7.0
@@ -3,7 +3,7 @@ source 'https://rubygems.org'
 
 gemspec path: "../"
 
-gem 'rails', '~> 7.0'
+gem 'rails', '~> 7.0.0'
 gem 'bootsnap' # required by the Rails apps generated in tests
 gem 'ruby-prof', platform: :ruby
 gem 'pry-byebug'
diff --git a/gemfiles/Gemfile.rails-7.1 b/gemfiles/Gemfile.rails-7.1
@@ -3,7 +3,7 @@ source 'https://rubygems.org'
 
 gemspec path: "../"
 
-gem 'rails', '~> 7.1'
+gem 'rails', '~> 7.1.0'
 gem 'bootsnap' # required by the Rails apps generated in tests
 gem 'ruby-prof', platform: :ruby
 gem 'pry-byebug'
diff --git a/gemfiles/Gemfile.rails-7.2 b/gemfiles/Gemfile.rails-7.2
@@ -3,7 +3,7 @@ source 'https://rubygems.org'
 
 gemspec path: "../"
 
-gem 'rails', '~> 7.2'
+gem 'rails', '~> 7.2.0'
 gem 'bootsnap' # required by the Rails apps generated in tests
 gem 'ruby-prof', platform: :ruby
 gem 'pry-byebug'
diff --git a/gemfiles/Gemfile.rails-8.0 b/gemfiles/Gemfile.rails-8.0
@@ -3,10 +3,11 @@ source 'https://rubygems.org'
 
 gemspec path: "../"
 
-gem 'rails', '~> 6.0'
+gem 'rails', '~> 8.0.0'
 gem 'bootsnap' # required by the Rails apps generated in tests
 gem 'ruby-prof', platform: :ruby
 gem 'pry-byebug'
+gem 'sqlite3'
 
 gem 'flamegraph'
 gem 'stackprof'
diff --git a/lib/rails/graphql.rb b/lib/rails/graphql.rb
@@ -2,6 +2,7 @@
 
 require 'i18n'
 require 'zlib'
+require 'ostruct'
 require 'active_model'
 require 'active_support'
 
diff --git a/lib/rails/graphql/field/output_field.rb b/lib/rails/graphql/field/output_field.rb
@@ -41,6 +41,10 @@ def has_argument?(name)
           super || field.has_argument?(name)
         end
 
+        def has_arguments?
+          super || field.has_arguments?
+        end
+
         def arguments?
           super || field.arguments?
         end
diff --git a/lib/rails/graphql/helpers/attribute_delegator.rb b/lib/rails/graphql/helpers/attribute_delegator.rb
@@ -5,13 +5,20 @@ module GraphQL
     module Helpers
       # This is an extra magic on top of the delegator class from the standard
       # lib that allows fetching a specific property of the delegated object
-      class AttributeDelegator < ActiveSupport::ProxyObject
+      class AttributeDelegator < ::BasicObject
+        undef_method :==
+        undef_method :equal?
+
         def initialize(obj = nil, attribute = nil, cache: true, &block)
           @delegate_sd_attr = attribute
           @delegate_sd_obj = block.presence || obj
           @delegate_cache = cache
         end
 
+        def raise(*args)
+          ::Object.send(:raise, *args)
+        end
+
         private
 
           def respond_to_missing?(method_name, include_private = false)
diff --git a/lib/rails/graphql/helpers/with_arguments.rb b/lib/rails/graphql/helpers/with_arguments.rb
@@ -100,6 +100,11 @@ def has_argument?(name)
           defined?(@arguments) && @arguments.key?(name)
         end
 
+        # Check if any argument has been defined at all
+        def has_arguments?
+          defined?(@arguments) && !@arguments.empty?
+        end
+
         # Validate all the arguments to make sure the definition is valid
         def validate!(*)
           super if defined? super
diff --git a/lib/rails/graphql/request/backtrace.rb b/lib/rails/graphql/request/backtrace.rb
@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'active_support/parameter_filter'
+
 module Rails
   module GraphQL
     class Request
@@ -130,7 +132,8 @@ def clean_arguments(arguments, request)
             return '{}' if value.blank?
 
             request.cache(:backtrace_arguments_filter) do
-              ActiveSupport::ParameterFilter.new(GraphQL.config.filter_parameters)
+              filters = GraphQL.config.filter_parameters || EMPTY_ARRAY
+              ActiveSupport::ParameterFilter.new(filters)
             end.filter(value)
           end
 
diff --git a/lib/rails/graphql/request/component/field.rb b/lib/rails/graphql/request/component/field.rb
@@ -16,7 +16,7 @@ class Component::Field < Component
         delegate :decorate, to: :type_klass
         delegate :operation, :variables, :request, to: :parent
         delegate :method_name, :resolver, :performer, :type_klass, :leaf_type?,
-          :dynamic_resolver?, :mutation?, to: :field
+          :dynamic_resolver?, :has_arguments?, :mutation?, to: :field
 
         attr_reader :name, :alias_name, :parent, :field, :arguments, :current_object
 
diff --git a/lib/rails/graphql/request/steps/organizable.rb b/lib/rails/graphql/request/steps/organizable.rb
@@ -118,9 +118,9 @@ def parse_variables(nodes)
           # Helper parser for arguments that also collect necessary variables
           # Default values forces this method to run even without nodes
           def parse_arguments(nodes)
-            return @arguments = EMPTY_HASH if nodes.blank?
+            return @arguments = EMPTY_HASH if nodes.blank? && !self.has_arguments?
 
-            args = nodes.each.with_object({}) do |(name, value, var_name), hash|
+            args = nodes&.each_with_object({}) do |(name, value, var_name), hash|
               hash[name.to_s] = var_name.nil? ? value : var_name
             end
 
diff --git a/lib/rails/graphql/source/base.rb b/lib/rails/graphql/source/base.rb
@@ -41,15 +41,19 @@ def unregister!
           # to the +::GraphQL+ namespace with the addition of any namespace of
           # the current class
           def object
-            @object ||= create_type(superclass: object_class, gql_name: object_name)
+            @object ||= create_type(superclass: object_class, gql_name: object_name).tap do |t|
+              t.include(const_get(:ObjectMethods)) if const_defined?(:ObjectMethods, false)
+            end
           end
 
           # Return the GraphQL input type associated with the source. It will
           # create one if it's not defined yet. The created class will be added
           # to the +::GraphQL+ namespace with the addition of any namespace of
           # the current class
           def input
-            @input ||= create_type(superclass: input_class, gql_name: input_name)
+            @input ||= create_type(superclass: input_class, gql_name: input_name).tap do |t|
+              t.include(const_get(:InputMethods)) if const_defined?(:InputMethods, false)
+            end
           end
 
           protected
@@ -77,6 +81,30 @@ def create_type(type = nil, name = nil, **xargs, &block)
               GraphQL::Type.create!(self, name, superclass, **xargs, &block)
             end
 
+            # Allow setting methods on the source object via a proper module
+            def object_methods(&block)
+              type_extend_with_module(:object, &block)
+            end
+
+            # Allow setting methods on the source input via a proper module
+            def input_methods(&block)
+              type_extend_with_module(:input, &block)
+            end
+
+          private
+
+            # Allows adding methods to a type by properly providing a module
+            # and adding it to the type
+            def type_extend_with_module(type, &block)
+              mod_name = :"#{type.to_s.classify}Methods"
+              mod = const_get(mod_name) if const_defined?(mod_name, false)
+              mod ||= const_set(mod_name, Module.new).tap do |m|
+                instance_variable_get("@#{type}")&.include(m)
+              end
+
+              mod.module_eval(&block)
+            end
+
         end
       end
     end
diff --git a/lib/rails/graphql/version.rb b/lib/rails/graphql/version.rb
@@ -14,7 +14,7 @@ def self.version
     module VERSION
       MAJOR = 1
       MINOR = 0
-      TINY  = 4
+      TINY  = 5
       PRE   = nil
 
       STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
diff --git a/test/assets/sqlite.gql b/test/assets/sqlite.gql
@@ -171,6 +171,8 @@ input LiteFactionInput {
   
   basesAttributes: [LiteBaseInput!]
   
+  greeting: String
+  
   name: String
   
   shipsAttributes: [LiteShipInput!]
@@ -206,6 +208,8 @@ type LiteFaction {
   
   bases: [LiteBase!]!
   
+  greeting: String
+  
   name: String
   
   ships: [LiteShip!]!
diff --git a/test/config.rb b/test/config.rb
@@ -13,6 +13,7 @@
   add_group 'Source', ['/graphql/adapters', '/graphql/source']
 end
 
+require 'logger'
 require 'minitest/autorun'
 require 'minitest/reporters'
 require 'active_record'
diff --git a/test/graphql/source_test.rb b/test/graphql/source_test.rb
@@ -129,6 +129,9 @@ def test_override
   end
 
   def test_disable
+    # class_attribute changed and the stub does not work as expected
+    return skip if rails8?
+
     described_class.stub(:hook_names, Set[:start]) do
       assert_includes(described_class.hook_names, :start)
       described_class.send(:disable, 'starts')
@@ -137,6 +140,9 @@ def test_disable
   end
 
   def test_enable
+    # class_attribute changed and the stub does not work as expected
+    return skip if rails8?
+
     described_class.stub(:hook_names, Set[]) do
       refute_includes(described_class.hook_names, :start)
       described_class.send(:enable, 'starts')
@@ -157,4 +163,8 @@ def assert_pending(*items)
     def source_const
       Rails::GraphQL::Source
     end
+
+    def rails8?
+      ActiveSupport.gem_version >= Gem::Version.new('8')
+    end
 end
diff --git a/test/integration/memory/star_wars_query_test.rb b/test/integration/memory/star_wars_query_test.rb
@@ -132,6 +132,20 @@ def test_query_with_field_argument
     GQL
   end
 
+  def test_query_with_field_argument_and_default_value
+    argument = SCHEMA.find_type('Human')[:greeting].arguments[:name]
+    argument.stub_ivar(:@default, 'You') do
+      assert(argument.inspect, "name: String! = 'You'")
+
+      vader = { name: 'Han Solo', greeting: 'Hello You!' }
+      assert_result({ data: { human: vader } }, <<~GQL)
+        query WithFieldArgument {
+          human(id: "1002") { name greeting }
+        }
+      GQL
+    end
+  end
+
   def test_query_with_fragment
     luke = { name: 'Luke Skywalker', homePlanet: 'Tatooine' }
     leia = { name: 'Leia Organa', homePlanet: 'Alderaan' }
diff --git a/test/integration/memory/star_wars_validation_test.rb b/test/integration/memory/star_wars_validation_test.rb
@@ -27,8 +27,21 @@ def test_invalid_query
       locations: [{ line: 2, column: 1 }],
     }]
 
-    assert_result(errors, <<~GQL, dig: 'errors')
+    assert_result(errors, <<~QUERY, dig: 'errors')
       query DroidFieldInFragment { hero { name ... on Droid { primaryFunction
+    QUERY
+  end
+
+  def test_fields_with_required_arguments
+    errors = [{
+      message: 'Invalid arguments for human field: the "id" argument can not be null.',
+      locations: [{ line: 1, column: 19 }, { line: 1, column: 33 }],
+      path: %w[HumanName human],
+      extensions: { stage: 'organize', exception: 'Rails::GraphQL::ArgumentsError' },
+    }]
+
+    assert_result(errors, <<~GQL, dig: 'errors')
+      query HumanName { human { name } }
     GQL
   end
 
diff --git a/test/integration/schemas/sqlite.rb b/test/integration/schemas/sqlite.rb
@@ -14,6 +14,7 @@ class SQLiteRecord < ActiveRecord::Base
 SQLiteRecord.connection.instance_eval do
   create_table 'lite_factions', force: :cascade do |t|
     t.string 'name'
+    t.string 'greeting'
   end
 
   create_table 'lite_bases', force: :cascade do |t|
@@ -35,8 +36,8 @@ class LiteFaction < SQLiteRecord
   accepts_nested_attributes_for :bases
   accepts_nested_attributes_for :ships
 
-  REBELS = create!(name: 'Alliance to Restore the Republic')
-  EMPIRE = create!(name: 'Galactic Empire')
+  REBELS = create!(name: 'Alliance to Restore the Republic', greeting: 'Hello %s!')
+  EMPIRE = create!(name: 'Galactic Empire', greeting: 'Hi %s!')
 end
 
 class LiteBase < SQLiteRecord
@@ -79,6 +80,12 @@ class StartWarsSqliteSchema < GraphQL::Schema
     with_options on: 'liteFactions' do
       scoped_argument(:order) { |o| order(name: o) }
     end
+
+    object_methods do
+      def greeting
+        format(current.greeting, 'you')
+      end
+    end
   end
 
   source LiteBase do
diff --git a/test/integration/sqlite/star_wars_query_test.rb b/test/integration/sqlite/star_wars_query_test.rb
@@ -81,4 +81,11 @@ def test_bases_scoped_argument_with_default
       query AllBases($order: String!) { liteBases(order: $order) { name } }
     GQL
   end
+
+  def test_query_methods_precedence
+    faction = { greeting: 'Hi you!' }
+    assert_result({ data: { liteFaction: faction } }, <<~GQL)
+      query EmpireFleet { liteFaction(id: "2") { greeting } }
+    GQL
+  end
 end
