graphql_rails 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afbec95cbbadb5f167ecc59f8e21fd4e7ab4285f97a6d6bc847129c2de03fe43
-  data.tar.gz: dc1434040422eda6fe0dca6ba123e6ff51a37df658bcd314be834f67c97f9d66
+  metadata.gz: f8680cd313b14bca588ff49b88021fbe2b2473b982ed58bbc7630aa8c47631ff
+  data.tar.gz: c8cc53c1e9b2ad49b494a2760c98743ce156a7c83597e1ddb261fe170851db41
 SHA512:
-  metadata.gz: 57801abd718d1e5bac281e01a6dfa7e54bc3da9def20f479c6c028b5b8ab8e77dbc7cd2c7e6c6a1ff6ba48cfbc7e81e0b23bb6da81f40050fbc69d6ed460af3a
-  data.tar.gz: 23c740466516ec437da7d7a8d909958b63d3aaca75dc3c53d748f5c7c79097c8c86c801396f4ba9e95b8fd16ae5f8cbcb9f59dcf06e0f69050cfcdc1e0ddb0cc
+  metadata.gz: 59ea863201a837dca103a4dc3329e66ae2c7f6fb29e779bca46cebcc016e8c38f6daedc93ebfd10ac9cf344290f4932cb43e3ee94f0726513e7659ae48414fa2
+  data.tar.gz: 4239e644a647bc8e0af11d144804f684ec6cd7aa1312a467916cdb83e9ed799d53e468db4ca62f4a415c23b5dbbb570cb4a1ca3552e86ea133f66efb72838f13

data/CHANGELOG.md

@@ -9,6 +9,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 * Added/Changed/Deprecated/Removed/Fixed/Security: YOUR CHANGE HERE
 
+## [3.1.1](2026-10-20)
+
+* Changed: do not throw "Cannot return null for non-nullable" error when errors are manually rendered
+* Added: allow to specify type error hooks in router
+* Added: `response.context` in RSpec controller helpers
+* Added: `dig` on the RSpec controller helpers test context, as on `GraphQL::Query::Context`
+
 ## [3.1.0](2025-05-26)
 
 * Added: Allow passing custom decorator build strategy

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    graphql_rails (3.0.0)
+    graphql_rails (3.1.1)
       activesupport (>= 4)
       graphql (~> 2)
 
@@ -81,16 +81,16 @@ GEM
     diff-lcs (1.6.1)
     docile (1.4.1)
     erubi (1.13.1)
-    fiber-storage (1.0.0)
+    fiber-storage (1.0.1)
     globalid (1.2.1)
       activesupport (>= 6.1)
-    graphql (2.4.15)
+    graphql (2.5.11)
       base64
       fiber-storage
       logger
     i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    logger (1.6.6)
+    logger (1.7.0)
     loofah (2.24.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
@@ -102,7 +102,7 @@ GEM
     marcel (1.0.4)
     method_source (1.1.0)
     mini_mime (1.1.5)
-    mini_portile2 (2.8.8)
+    mini_portile2 (2.8.9)
     minitest (5.25.5)
     mongo (2.21.0)
       bson (>= 4.14.1, < 6.0.0)
@@ -110,7 +110,7 @@ GEM
       activemodel (>= 5.1, < 8.1, != 7.0.0)
       concurrent-ruby (>= 1.0.5, < 2.0)
       mongo (>= 2.18.0, < 3.0.0)
-    net-imap (0.5.6)
+    net-imap (0.5.7)
       date
       net-protocol
     net-pop (0.1.2)
@@ -120,7 +120,7 @@ GEM
     net-smtp (0.5.1)
       net-protocol
     nio4r (2.7.4)
-    nokogiri (1.18.6)
+    nokogiri (1.18.9)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     parallel (1.26.3)
@@ -135,7 +135,7 @@ GEM
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
     racc (1.8.1)
-    rack (2.2.13)
+    rack (2.2.20)
     rack-test (2.2.0)
       rack (>= 1.3)
     rails (6.1.7.10)
@@ -169,7 +169,7 @@ GEM
     rainbow (3.1.1)
     rake (13.2.1)
     regexp_parser (2.10.0)
-    rexml (3.4.1)
+    rexml (3.4.2)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)

data/docs/components/routes.md

@@ -174,3 +174,29 @@ end
 ```
 
 If you want to access raw graphql schema, you can call `GraphqlRouter.graphql_schema(:mobile)`
+
+## _before_type_error_
+
+Sometimes it's handy to log or perform other actions when a GraphQL type error occurs. To do so, specify the Router.before_type_error hook:
+
+```ruby
+GraphqlRails::Router.draw do
+  before_type_error do |type_error, context|
+    MyCustomExceptionLogger.call(type_error)
+  end
+end
+```
+
+Note: This might log `GraphQL::InvalidNullError` errors that are not visible to the end user. If you do not want that, use Router.after_type_error.
+
+## _after_type_error_
+
+Sometimes it's handy to perform logging or other actions after a GraphQL type error occurs. To do so, specify the Router.after_type_error hook:
+
+```ruby
+GraphqlRails::Router.draw do
+  after_type_error do |type_error, context|
+    MyCustomExceptionLogger.call(type_error)
+  end
+end
+```

data/docs/testing/testing.md

@@ -22,7 +22,7 @@ There are 3 helper methods:
 
 * `mutation(:your_controller_action_name, params: {}, context: {})`. `params` and `context` are optional
 * `query(:your_controller_action_name, params: {}, context: {})`. `params` and `context` are optional
-* `response`. Response is set only after you call `mutation` or `query`
+* `response`. Response is set only after you call `mutation` or `query`. It exposes, among others, `result`, `errors`, `success?`, `controller`, `action_name` and `context`: the hash-like test context the action ran with (it supports `[]`, `fetch`, `key?`, `dig` and `to_h`), not a `GraphQL::Query::Context`
 
 ### Test examples
 

data/lib/graphql_rails/controller/handle_controller_error.rb

@@ -4,6 +4,10 @@ module GraphqlRails
   class Controller
     # runs {before/around/after}_action controller hooks
     class HandleControllerError
+      def self.call(error:, controller:)
+        new(error: error, controller: controller).call
+      end
+
       def initialize(error:, controller:)
         @error = error
         @controller = controller
@@ -20,11 +24,15 @@ module GraphqlRails
       attr_reader :error, :controller
 
       def render_unhandled_error(error)
-        return render(error: error) if error.is_a?(GraphQL::ExecutionError)
+        return handle_graphql_execution_error(error) if error.is_a?(GraphQL::ExecutionError)
 
         render(error: SystemError.new(error))
       end
 
+      def handle_graphql_execution_error(error)
+        raise error
+      end
+
       def custom_handle_error
         return unless custom_handler
 

data/lib/graphql_rails/controller.rb

@@ -13,6 +13,8 @@ module GraphqlRails
   # base class for all graphql_rails controllers
   class Controller
     class << self
+      attr_accessor :error_handler
+
       def inherited(subclass)
         super
         new_config = controller_configuration.dup_with(controller: subclass)
@@ -79,6 +81,7 @@ module GraphqlRails
       object = errors.empty? ? object_or_errors : nil
 
       graphql_request.errors = errors
+      graphql_request.context[:rendered_errors] = true unless errors.empty?
       graphql_request.object_to_return = object
     end
 
@@ -94,7 +97,8 @@ module GraphqlRails
 
       render response if graphql_request.no_object_to_return?
     rescue StandardError => e
-      HandleControllerError.new(error: e, controller: self).call
+      error_handler = self.class.error_handler || HandleControllerError
+      error_handler.call(error: e, controller: self)
     end
 
     def graphql_errors_from_render_params(rendering_params)

data/lib/graphql_rails/router/schema.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'graphql/pagination/active_record_relation_connection'
+require 'graphql_rails/decorator/relation_decorator'
+require 'graphql_rails/router/plain_cursor_encoder'
+
+module GraphqlRails
+  class Router
+    # Builds GraphQL::Schema based on previously defined GraphQL data.
+    # Also handles type error hooks (before_type_error, after_type_error)
+    # and implements logic for skipping null errors.
+    class Schema < ::GraphQL::Schema
+      use GraphQL::Schema::Visibility
+
+      connections.add(
+        GraphqlRails::Decorator::RelationDecorator,
+        GraphQL::Pagination::ActiveRecordRelationConnection
+      )
+
+      cursor_encoder(Router::PlainCursorEncoder)
+
+      def self.before_type_error(&block)
+        @before_type_error = block if block_given?
+        @before_type_error
+      end
+
+      def self.after_type_error(&block)
+        @after_type_error = block if block_given?
+        @after_type_error
+      end
+
+      def self.type_error(type_error, context)
+        before_type_error&.call(type_error, context)
+
+        return nil if type_error.is_a?(GraphQL::InvalidNullError) && context[:rendered_errors]
+
+        super.tap do
+          after_type_error&.call(type_error, context)
+        end
+      end
+    end
+  end
+end

data/lib/graphql_rails/router/schema_builder.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'graphql_rails/router/schema'
+
 module GraphqlRails
   class Router
     # builds GraphQL::Schema based on previously defined grahiti data
@@ -31,14 +33,7 @@ module GraphqlRails
 
       # rubocop:disable Metrics/MethodLength
       def define_schema_class(query_type, mutation_type, subscription_type, raw)
-        Class.new(GraphQL::Schema) do
-          use GraphQL::Schema::Visibility
-
-          connections.add(
-            GraphqlRails::Decorator::RelationDecorator,
-            GraphQL::Pagination::ActiveRecordRelationConnection
-          )
-          cursor_encoder(Router::PlainCursorEncoder)
+        Class.new(GraphqlRails::Router::Schema) do
           raw.each { |action| send(action[:name], *action[:args], **action[:kwargs], &action[:block]) }
 
           query(query_type) if query_type

data/lib/graphql_rails/router.rb

@@ -13,6 +13,7 @@ module GraphqlRails
   class Router
     RAW_ACTION_NAMES = %i[
       use rescue_from query_analyzer instrument cursor_encoder default_max_page_size tracer trace_with
+      before_type_error after_type_error
     ].freeze
 
     def self.draw(&block)

data/lib/graphql_rails/rspec_controller_helpers.rb

@@ -54,6 +54,10 @@ module GraphqlRails
         request.action_name
       end
 
+      def context
+        request.context
+      end
+
       private
 
       attr_reader :request
@@ -65,7 +69,7 @@ module GraphqlRails
 
       attr_reader :schema
 
-      def_delegators :@provided_values, :[], :[]=, :to_h, :key?, :fetch
+      def_delegators :@provided_values, :[], :[]=, :to_h, :key?, :fetch, :dig
 
       def initialize(values:, schema:)
         @errors = []
@@ -78,6 +82,15 @@ module GraphqlRails
       end
     end
 
+    # Custom error handler to avoid raising errors in controller tests
+    class TestControllerErrorHandler < GraphqlRails::Controller::HandleControllerError
+      private
+
+      def handle_graphql_execution_error(error)
+        render(error: error)
+      end
+    end
+
     class SingleControllerSchemaBuilder
       attr_reader :controller
 
@@ -117,7 +130,11 @@ module GraphqlRails
       schema_builder = SingleControllerSchemaBuilder.new(described_class)
       context_object = FakeContext.new(values: context, schema: schema_builder.call)
       request = Request.new(params, context_object, controller: described_class, action_name: query_name)
+      original_error_handler = described_class.error_handler
+
+      described_class.error_handler = TestControllerErrorHandler
       described_class.new(request).call(query_name)
+      described_class.error_handler = original_error_handler
 
       @response = Response.new(request)
       @response

data/lib/graphql_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GraphqlRails
-  VERSION = '3.1.0'
+  VERSION = '3.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql_rails
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Povilas Jurčys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-05-26 00:00:00.000000000 Z
+date: 2026-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -222,6 +222,7 @@ files:
 - lib/graphql_rails/router/query_route.rb
 - lib/graphql_rails/router/resource_routes_builder.rb
 - lib/graphql_rails/router/route.rb
+- lib/graphql_rails/router/schema.rb
 - lib/graphql_rails/router/schema_builder.rb
 - lib/graphql_rails/rspec_controller_helpers.rb
 - lib/graphql_rails/tasks/dump_graphql_schema.rb