Merge pull request cerebris#880 from rabid/make-backtraces-configurable

Make exception backtraces configurable

Author: barelyknown

lib/jsonapi/configuration.rb

@@ -22,6 +22,7 @@ class Configuration
  :top_level_meta_include_page_count,
  :top_level_meta_page_count_key,
  :allow_transactions,
+ :include_backtraces_in_errors,
  :exception_class_whitelist,
  :always_include_to_one_linkage_data,
  :always_include_to_many_linkage_data,
@@ -68,6 +69,10 @@ def initialize
 
  self.use_text_errors = false
 
+ # Whether or not to include exception backtraces in JSONAPI error
+ # responses. Defaults to `false` in production, and `true` otherwise.
+ self.include_backtraces_in_errors = !Rails.env.production?
+
  # List of classes that should not be rescued by the operations processor.
  # For example, if you use Pundit for authorization, you might
  # raise a Pundit::NotAuthorizedError at some point during operations
@@ -212,6 +217,8 @@ def default_processor_klass=(default_processor_klass)
 
  attr_writer :allow_transactions
 
+ attr_writer :include_backtraces_in_errors
+
  attr_writer :exception_class_whitelist
 
  attr_writer :always_include_to_one_linkage_data

lib/jsonapi/exceptions.rb

@@ -16,7 +16,7 @@ def initialize(exception)
  end
 
  def errors
- unless Rails.env.production?
+ if JSONAPI.configuration.include_backtraces_in_errors
  meta = Hash.new
  meta[:exception] = exception.message
  meta[:backtrace] = exception.backtrace

test/controllers/controller_test.rb

@@ -90,6 +90,25 @@ def test_exception_class_whitelist
  JSONAPI.configuration.exception_class_whitelist = original_whitelist
  end
 
+ def test_exception_includes_backtrace_when_enabled
+ original_config = JSONAPI.configuration.include_backtraces_in_errors
+ $PostProcessorRaisesErrors = true
+
+ JSONAPI.configuration.include_backtraces_in_errors = true
+ assert_cacheable_get :index
+ assert_response 500
+ assert_includes @response.body, "backtrace", "expected backtrace in error body"
+
+ JSONAPI.configuration.include_backtraces_in_errors = false
+ assert_cacheable_get :index
+ assert_response 500
+ refute_includes @response.body, "backtrace", "expected backtrace in error body"
+
+ ensure
+ $PostProcessorRaisesErrors = false
+ JSONAPI.configuration.include_backtraces_in_errors = original_config
+ end
+
  def test_on_server_error_block_callback_with_exception
  original_config = JSONAPI.configuration.dup
  JSONAPI.configuration.exception_class_whitelist = []