Add on_raise_callback specific to each field.

Author: amomchilov

lib/graphql/execution/interpreter/runtime.rb

@@ -60,9 +60,20 @@ def build_path(path_array)
           # A result can be skipped when it's an ancestor of an item in a List marked `skip_items_on_raise: true`.
           # @return [Boolean]
           def can_be_skipped?
-            return @can_be_skipped if defined?(@can_be_skipped)
+            !nearest_skippable_parent_result.nil?
+          end
+
+          # Crawls up the tree to find the first ancestor that can be skipped, that is, the first item that's a child
+          # of a List marked `skip_items_on_raise: true`.
+          # @return [GraphQLResult]
+          def nearest_skippable_parent_result
+            return @nearest_skippable_parent_result if defined?(@nearest_skippable_parent_result)
 
-            @can_be_skipped = graphql_skip_list_items_that_raise || !!(graphql_parent && graphql_parent.can_be_skipped?)
+            @nearest_skippable_parent_result = if graphql_parent && graphql_parent.graphql_skip_list_items_that_raise
+              self
+            else
+              graphql_parent && graphql_parent.nearest_skippable_parent_result
+            end
           end
 
           # @return [Hash] Plain-Ruby result data (`@graphql_metadata` contains Result wrapper objects)
@@ -567,14 +578,19 @@ def evaluate_selection_with_resolved_keyword_args(kwarg_arguments, resolved_argu
               err
             rescue StandardError => err
               begin
-                if selection_result.can_be_skipped?
-                  context.skip_from_parent_list # Skip silently without informing the user's `rescue_from` block.
-                else
+                nearest_skippable_parent_result = selection_result.nearest_skippable_parent_result
+
+                if nearest_skippable_parent_result && (on_raise_callback = nearest_skippable_parent_result.field.on_raise_callback)
                   begin
+                    nearest_skippable_list_item = nearest_skippable_parent_result.represented_value.object
+                    on_raise_callback.call(err, object, kwarg_arguments, context, nearest_skippable_parent_result.field, nearest_skippable_list_item)
+                  rescue GraphQL::ExecutionError => err  # TODO: DRY me
+                    err
+                  rescue StandardError => err
                     query.handle_or_reraise(err)
-                  rescue GraphQL::ExecutionError => ex_err
-                    ex_err
                   end
+                else
+                  query.handle_or_reraise(err)
                 end
               rescue GraphQL::ExecutionError => ex_err
                 ex_err

lib/graphql/schema/field.rb

@@ -83,6 +83,8 @@ def subscription_scope
       end
       attr_writer :subscription_scope
 
+      attr_reader :on_raise_callback
+
       # Create a field instance from a list of arguments, keyword arguments, and a block.
       #
       # This method implements prioritization between the `resolver` or `mutation` defaults
@@ -220,7 +222,8 @@ def method_conflict_warning?
       # @param validates [Array<Hash>] Configurations for validating this field
       # @param fallback_value [Object] A fallback value if the method is not defined
       # @param skip_nodes_on_raise [Boolean] true if this field's list items should be skipped, if resolving them led to an error being raised. Only applicable to List types.
-      def initialize(type: nil, name: nil, owner: nil, null: nil, description: NOT_CONFIGURED, deprecation_reason: nil, method: nil, hash_key: nil, dig: nil, resolver_method: nil, connection: nil, max_page_size: NOT_CONFIGURED, default_page_size: NOT_CONFIGURED, scope: nil, introspection: false, camelize: true, trace: nil, complexity: nil, ast_node: nil, extras: EMPTY_ARRAY, extensions: EMPTY_ARRAY, connection_extension: self.class.connection_extension, resolver_class: nil, subscription_scope: nil, relay_node_field: false, relay_nodes_field: false, method_conflict_warning: true, broadcastable: NOT_CONFIGURED, arguments: EMPTY_HASH, directives: EMPTY_HASH, validates: EMPTY_ARRAY, fallback_value: NOT_CONFIGURED, skip_nodes_on_raise: false, &definition_block)
+      # @param on_raise [Proc] A callback that's invoked when an error is raised while resolving this field's list items. Only applicable to List types.
+      def initialize(type: nil, name: nil, owner: nil, null: nil, description: NOT_CONFIGURED, deprecation_reason: nil, method: nil, hash_key: nil, dig: nil, resolver_method: nil, connection: nil, max_page_size: NOT_CONFIGURED, default_page_size: NOT_CONFIGURED, scope: nil, introspection: false, camelize: true, trace: nil, complexity: nil, ast_node: nil, extras: EMPTY_ARRAY, extensions: EMPTY_ARRAY, connection_extension: self.class.connection_extension, resolver_class: nil, subscription_scope: nil, relay_node_field: false, relay_nodes_field: false, method_conflict_warning: true, broadcastable: NOT_CONFIGURED, arguments: EMPTY_HASH, directives: EMPTY_HASH, validates: EMPTY_ARRAY, fallback_value: NOT_CONFIGURED, skip_nodes_on_raise: false, on_raise: nil, &definition_block)
         if name.nil?
           raise ArgumentError, "missing first `name` argument or keyword `name:`"
         end
@@ -277,6 +280,7 @@ def initialize(type: nil, name: nil, owner: nil, null: nil, description: NOT_CON
           true
         end
         @skip_nodes_on_raise = skip_nodes_on_raise
+        @on_raise_callback = on_raise
         @connection = connection
         @max_page_size = max_page_size
         @default_page_size = default_page_size
@@ -356,6 +360,12 @@ def initialize(type: nil, name: nil, owner: nil, null: nil, description: NOT_CON
         if skip_nodes_on_raise && !self.type.list?
           raise ArgumentError, "The `skip_nodes_on_raise` option is only applicable to lists."
         end
+
+        # TODO: Rename "on_raise".
+        # This callback is specific to list _items_, but the "on_raise" naming doesn't make that clear.
+        if on_raise && !self.type.list?
+          raise ArgumentError, "The `on_raise` option is only applicable to lists."
+        end
       end
 
       # If true, subscription updates with this field can be shared between viewers

spec/graphql/execution/interpreter/list_item_skipping_spec.rb

@@ -38,12 +38,16 @@
 
     describe "when the Connection's items aren't skippable" do
       it "raises the error if the connection's items are required and not skippable" do
+        skip "on_raise API not implemented for Connections yet"
+
         assert_raises(Boom) do
           query_connection(connection_field: "connectionOfRequiredItems")
         end
       end
 
       it "raises the error if the connection's items are nullable and not skippable" do
+        skip "on_raise API not implemented for Connections yet"
+
         assert_raises(Boom) do
           query_connection(connection_field: "connectionOfNullableItems")
         end
@@ -52,12 +56,14 @@
 
     describe "when the Connection's items are skippable" do
       it "skips errored items if the connection's items are required and skippable" do
+        skip "on_raise API not implemented for Connections yet"
         items = query_connection(connection_field: "connectionOfRequiredSkippableItems")
 
         assert_equal ["Item 1", "Item 3"], items.dig("data", "connectionOfRequiredSkippableItems", "nodes").map { |h| h["title"] }
       end
 
       it "skips errored items if the connection's items are nullable and skippable" do
+        skip "on_raise API not implemented for Connections yet"
         items = query_connection(connection_field: "connectionOfNullableSkippableItems")
 
         assert_equal ["Item 1", "Item 3"], items.dig("data", "connectionOfNullableSkippableItems", "nodes").map { |h| h["title"] }
@@ -189,13 +195,21 @@ class QueryType < GraphQL::Schema::Object
           [ItemType, null: false],
           method: :items_list,
           null: false,
-          skip_nodes_on_raise: true
+          skip_nodes_on_raise: true,
+          on_raise: -> (err, current_object, args, context, current_field, nearest_skippable_list_item) {
+            puts(:array_of_required_skippable_items)
+            context.skip_from_parent_list
+          }
 
     field :array_of_nullable_skippable_items,
           [ItemType, null: true],
           method: :items_list,
           null: false,
-          skip_nodes_on_raise: true
+          skip_nodes_on_raise: true,
+          on_raise: -> (err, current_object, args, context, current_field, nearest_skippable_list_item) {
+            puts(:array_of_required_skippable_items)
+            context.skip_from_parent_list
+          }
 
     field :connection_of_required_items,
           RequiredItemConnection,