govuk_app_config 2.1.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00db6acb8d6b3c6f2682914794f02ff946e3ced2dccde8ae5c999d06814327c6
-  data.tar.gz: 897ae29ceea331b4f66fe2d247e7e61f1d87c518d994e9515f81e3f229b9be2a
+  metadata.gz: 35f743a622acf54ffad6414762bb3af0ebfc230c40b19b8f57286671f3fe6211
+  data.tar.gz: 4f39093e5358964cae3e587a4841c414b6f2eaf14381b25e6fa909f4a163bcc6
 SHA512:
-  metadata.gz: 963bd2ee9b438f29988b85d9ae1a8c4e5fdbe198fe6221b963b66782011acd270654640280eaefcc133626dde8a85750a407cb016a511b749a09530863dd366e
-  data.tar.gz: 40658b4718d1f74d864d5d6ac26753b6a18906fcb72669d04787e5ff56ccc805d2c348d14282108cc92cc99bcc941a88333446e1a475579c365240bda3fc38f5
+  metadata.gz: 7fedf54ca7d82cca175148e41fb0a72ca448675a8ccf3346bc5d29c47c7905786e3b0bfc2d0b3f4ffa0abaea786ff98e79b539df789207b1877a076182e7f913
+  data.tar.gz: 6243b62c1b2e679c033525843d527c8fc7c2c6cd2b8ab7df3aa2d6a070dd4c527af32fbfdeeabc0e53e35be2383d21f002b1816e4a8e1ce372b84279029c11b0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 2.2.0
+
+* Monkey patch `ActionDispatch::DebugExceptions#log_error` so it logs errors on a single line (https://github.com/alphagov/govuk_app_config/pull/147)
+
 # 2.1.2
 
 * Add missing ActiveRecord rescue_responses (https://github.com/alphagov/govuk_app_config/pull/142)

data/govuk_app_config.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "climate_control"
+  spec.add_development_dependency "rack-test", "~> 0.6.3"
   spec.add_development_dependency "rails", "~> 6"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.9.0"

data/lib/govuk_app_config/govuk_logging.rb

@@ -1,5 +1,6 @@
 require 'logstasher'
 require 'action_controller'
+require_relative 'rails_ext/action_dispatch/debug_exceptions'
 
 module GovukLogging
   def self.configure
@@ -50,7 +51,7 @@ module GovukLogging
         "#{String === msg ? msg : msg.inspect}\n"
       }
     )
-    Rails.application.config.logstasher.supress_app_log = true
+    Rails.application.config.logstasher.suppress_app_log = true
 
     if defined?(GdsApi::Base)
       GdsApi::Base.default_options ||= {}
@@ -61,5 +62,7 @@ module GovukLogging
       GdsApi::Base.default_options[:logger] =
         Rails.application.config.logstasher.logger
     end
+
+    RailsExt::ActionDispatch.monkey_patch_log_error if RailsExt::ActionDispatch.should_monkey_patch_log_error?
   end
 end

data/lib/govuk_app_config/rails_ext/action_dispatch/debug_exceptions.rb

@@ -0,0 +1,53 @@
+require "action_dispatch/middleware/debug_exceptions"
+
+module GovukLogging
+  module RailsExt
+    module ActionDispatch
+      def self.should_monkey_patch_log_error?(clazz = ::ActionDispatch::DebugExceptions)
+        empty_instance = clazz.new nil
+        target_method = empty_instance.method :log_error
+
+        expected_parameters = [%i[req request], %i[req wrapper]]
+        actual_parameters = target_method.parameters
+
+        should_monkey_patch = actual_parameters == expected_parameters
+
+        unless should_monkey_patch
+          Rails.logger.warn "Refused to monkey patch ::ActionDispatch::DebugExceptions#log_error - " +
+            "signatures do not match. " +
+            "Expected #{expected_parameters}, but got #{actual_parameters}"
+        end
+
+        should_monkey_patch
+
+      rescue StandardError => ex
+        Rails.logger.warn "Failed to detect whether to monkey patch " +
+          "::ActionDispatch::DebugExceptions#log_error - #{ex.inspect}"
+        false
+      end
+
+      def self.monkey_patch_log_error(clazz = ::ActionDispatch::DebugExceptions)
+        clazz.class_eval do
+          private
+
+          def log_error(request, wrapper)
+            logger = logger(request)
+
+            return unless logger
+
+            exception = wrapper.exception
+
+            trace = wrapper.application_trace
+            trace = wrapper.framework_trace if trace.empty?
+
+            logger.fatal({
+              exception_class: exception.class.to_s,
+              exception_message: exception.message,
+              stacktrace: trace,
+            }.to_json)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/govuk_app_config/version.rb

@@ -1,3 +1,3 @@
 module GovukAppConfig
-  VERSION = "2.1.2"
+  VERSION = "2.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.2.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-19 00:00:00.000000000 Z
+date: 2020-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstasher
@@ -112,6 +112,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -218,6 +232,7 @@ files:
 - lib/govuk_app_config/govuk_logging.rb
 - lib/govuk_app_config/govuk_statsd.rb
 - lib/govuk_app_config/govuk_unicorn.rb
+- lib/govuk_app_config/rails_ext/action_dispatch/debug_exceptions.rb
 - lib/govuk_app_config/railtie.rb
 - lib/govuk_app_config/version.rb
 homepage: https://github.com/alphagov/govuk_app_config