call server_error_callbacks on handle_exceptions in controller

Author: senid231

lib/jsonapi/acts_as_resource_controller.rb

@@ -266,13 +266,27 @@ def handle_exceptions(e)
         if JSONAPI.configuration.exception_class_whitelisted?(e)
           fail e
         else
+          (self.class.server_error_callbacks || []).each { |callback|
+            safe_run_callback(callback, e)
+          }
+
           internal_server_error = JSONAPI::Exceptions::InternalServerError.new(e)
           Rails.logger.error { "Internal Server Error: #{e.message} #{e.backtrace.join("\n")}" }
           render_errors(internal_server_error.errors)
         end
       end
     end
 
+    def safe_run_callback(callback, error)
+      begin
+        callback.call(error)
+      rescue => e
+        Rails.logger.error { "Error in error handling callback: #{e.message} #{e.backtrace.join("\n")}" }
+        internal_server_error = JSONAPI::Exceptions::InternalServerError.new(e)
+        render_errors(internal_server_error.errors)
+      end
+    end
+
     # Pass in a methods or a block to be run when an exception is
     # caught that is not a JSONAPI::Exceptions::Error
     # Useful for additional logging or notification configuration that

test/controllers/controller_test.rb

@@ -123,6 +123,26 @@ def test_on_server_error_method_callback_with_exception
     JSONAPI.configuration = original_config
   end
 
+  def test_on_server_error_method_callback_with_exception_on_serialize
+    original_config = JSONAPI.configuration.dup
+    JSONAPI.configuration.exception_class_whitelist = []
+    $PostSerializerRaisesErrors = true
+
+    #ignores methods that don't exist
+    @controller.class.on_server_error :set_callback_message, :a_bogus_method
+    @controller.class.instance_variable_set(:@callback_message, "none")
+
+    assert_cacheable_get :index
+    assert_equal "Sent from method", @controller.class.instance_variable_get(:@callback_message)
+
+    # test that it renders the default server error response
+    assert_equal "Internal Server Error", json_response['errors'][0]['title']
+  ensure
+    $PostSerializerRaisesErrors = false
+    JSONAPI.configuration = original_config
+    JSONAPI.configuration.exception_class_whitelist = []
+  end
+
   def test_on_server_error_callback_without_exception
 
     callback = Proc.new { @controller.class.instance_variable_set(:@callback_message, "Sent from block") }

test/fixtures/active_record.rb

@@ -580,6 +580,7 @@ class PostsController < BaseController
 
   class SpecialError < StandardError; end
   class SubSpecialError < PostsController::SpecialError; end
+  class SerializeError < StandardError; end
 
   # This is used to test that classes that are whitelisted are reraised by
   # the operations dispatcher.
@@ -600,6 +601,20 @@ def handle_exceptions(e)
   def self.set_callback_message(error)
     @callback_message = "Sent from method"
   end
+
+  def resource_serializer_klass
+    PostSerializer
+  end
+end
+
+class PostSerializer < JSONAPI::ResourceSerializer
+  def initialize(*)
+    if $PostSerializerRaisesErrors
+      raise PostsController::SerializeError
+    else
+      super
+    end
+  end
 end
 
 class CommentsController < JSONAPI::ResourceController
@@ -980,12 +995,12 @@ def title=(title)
          }
 
   filter :search,
-    verify: ->(values, context) {
+         verify: ->(values, context) {
       values.all?{|v| (v.is_a?(Hash) || v.is_a?(ActionController::Parameters)) } && values
-    },
-    apply: -> (records, values, _options) {
-      records.where(title: values.first['title'])
-    }
+         },
+         apply: -> (records, values, _options) {
+           records.where(title: values.first['title'])
+         }
 
   def self.updatable_fields(context)
     super(context) - [:author, :subject]
@@ -1252,7 +1267,7 @@ def subject
 
   def custom_links(options)
     {
-      link_to_external_api: "http://external-api.com/posts/#{ created_at.year }/#{ created_at.month }/#{ created_at.day }-#{ subject.gsub(' ', '-') }"
+        link_to_external_api: "http://external-api.com/posts/#{ created_at.year }/#{ created_at.month }/#{ created_at.day }-#{ subject.gsub(' ', '-') }"
     }
   end
 end
@@ -1513,28 +1528,28 @@ class PurchaseOrderResource < JSONAPI::Resource
 
       has_one :customer
       has_many :line_items, relation_name: -> (options = {}) {
-                            context = options[:context]
-                            current_user = context ? context[:current_user] : nil
-
-                            unless current_user && current_user.book_admin
-                              :line_items
-                            else
-                              :admin_line_items
-                            end
-                          },
+        context = options[:context]
+        current_user = context ? context[:current_user] : nil
+
+        unless current_user && current_user.book_admin
+          :line_items
+        else
+          :admin_line_items
+        end
+      },
                reflect: false
 
       has_many :order_flags, acts_as_set: true,
                relation_name: -> (options = {}) {
-                             context = options[:context]
-                             current_user = context ? context[:current_user] : nil
-
-                             unless current_user && current_user.book_admin
-                               :order_flags
-                             else
-                               :admin_order_flags
-                             end
-                           }
+                 context = options[:context]
+                 current_user = context ? context[:current_user] : nil
+
+                 unless current_user && current_user.book_admin
+                   :order_flags
+                 else
+                   :admin_order_flags
+                 end
+               }
     end
 
     class OrderFlagResource < JSONAPI::Resource