govuk_app_config 2.0.3 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 832d6ea72e7f391510a2fab49870ffd35a1178fba7f2647fee90532e8b157001
-  data.tar.gz: 85f60eda57af5b21ba06961defd6b563041cd932fe319a55d8d915862e1aa2ae
+  metadata.gz: 11f06b82c25ddd23f985b025b26abdcce2a1c4ab772cdbf129907962d8297da8
+  data.tar.gz: aa6e55ea958fd54cf9eb833762cbf3dfc24d310af1e3bf6dd8a010f3ad4d9bc9
 SHA512:
-  metadata.gz: e409aeb8a6a21b56c0945d25f40678d5115f13b049296e32f876a1073242f17a2d2db3a484140eeeb2c71a6ae3f25350fef3badbea28daabc58ea93cbf7d215e
-  data.tar.gz: 3745c70fe767196d1f90cfec77af282927ffbc6c7b38001e433ed60a485637b27d1175be217cdd16286b1dfd86fe3d68ad9b5ca6a6120aef359873e56d4cc18e
+  metadata.gz: c5f01c3eb3f450616bc04577f788a36a4907d690d5694f9e813c89c985b370ad2b94abc53653a3a98885fed96799d7f34085e2e478d545ee15ac9421e846800d
+  data.tar.gz: cbe282314f027a01ed6fd1aae0e490b67b0fcb8425dc802dc7311bab8d97dea60f531b30302879fbe4a11d01f95bd61edda203dda1539c01831ec089d71db278

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_gem:
+  rubocop-govuk:
+    - config/default.yml

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+# 2.2.1
+
+* Fix linting issues (https://github.com/alphagov/govuk_app_config/pull/149)
+
+# 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)
+
+# 2.1.1
+
+* Revert using sentry option of rails_report_rescued_exceptions (https://github.com/alphagov/govuk_app_config/pull/140)
+
+# 2.1.0
+
+* Stop exceptions rescued by rails from appearing in Sentry (https://github.com/alphagov/govuk_app_config/pull/138)
+
 # 2.0.3
 
 * Add hmrc-uk.digital.nuance.com (Nuance/HMRC Webchat provider) and gov.klick2contact.com (HMPO web chat provider) to connect-src CSP list (https://github.com/alphagov/govuk_app_config/pull/133)

data/Rakefile

@@ -3,4 +3,9 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+desc "Lint Ruby"
+task :lint do
+  sh "bundle exec rubocop --format clang"
+end
+
+task default: %i[spec lint]

data/docs/healthchecks.md

@@ -22,7 +22,7 @@ class CustomCheck
 
   # Optional
   def message
-    "This is an optional custom message"
+    "This is an optional custom message that will show up in the alert in Icinga"
   end
 
   # Optional

data/govuk_app_config.gemspec

@@ -1,5 +1,3 @@
-# coding: utf-8
-
 lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "govuk_app_config/version"
@@ -23,15 +21,17 @@ Gem::Specification.new do |spec|
   spec.require_paths = %w[lib]
 
   spec.add_dependency "logstasher", ">= 1.2.2", "< 1.4.0"
-  spec.add_dependency "sentry-raven", ">= 2.7.1", "< 2.14.0"
+  spec.add_dependency "sentry-raven", ">= 2.7.1", "< 3.1.0"
   spec.add_dependency "statsd-ruby", "~> 1.4.0"
   spec.add_dependency "unicorn", ">= 5.4", "< 5.6"
 
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "climate_control"
+  spec.add_development_dependency "rack-test", "~> 1.1.0"
   spec.add_development_dependency "rails", "~> 6"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.9.0"
   spec.add_development_dependency "rspec-its", "~> 1.3.0"
+  spec.add_development_dependency "rubocop-govuk"
   spec.add_development_dependency "webmock"
 end

data/lib/govuk_app_config/configure.rb

@@ -1,5 +1,5 @@
 GovukError.configure do |config|
-  config.before_send = Proc.new { |e|
+  config.before_send = proc { |e|
     GovukStatsd.increment("errors_occurred")
     GovukStatsd.increment("error_types.#{e.class.name.demodulize.underscore}")
     e
@@ -8,21 +8,34 @@ GovukError.configure do |config|
   config.silence_ready = !Rails.env.production? if defined?(Rails)
 
   config.excluded_exceptions = [
-    'AbstractController::ActionNotFound',
-    'ActionController::BadRequest',
-    'ActionController::InvalidAuthenticityToken',
-    'ActionController::ParameterMissing',
-    'ActionController::RoutingError',
-    'ActionController::UnknownAction',
-    'ActionController::UnknownHttpMethod',
-    'ActionDispatch::RemoteIp::IpSpoofAttackError',
-    'ActiveJob::DeserializationError',
-    'ActiveRecord::RecordNotFound',
-    'CGI::Session::CookieStore::TamperedWithCookie',
-    'GdsApi::HTTPIntermittentServerError',
-    'GdsApi::TimedOutException',
-    'Mongoid::Errors::DocumentNotFound',
-    'Sinatra::NotFound',
+    # Default ActionDispatch rescue responses
+    "ActionController::RoutingError",
+    "AbstractController::ActionNotFound",
+    "ActionController::MethodNotAllowed",
+    "ActionController::UnknownHttpMethod",
+    "ActionController::NotImplemented",
+    "ActionController::UnknownFormat",
+    "Mime::Type::InvalidMimeType",
+    "ActionController::MissingExactTemplate",
+    "ActionController::InvalidAuthenticityToken",
+    "ActionController::InvalidCrossOriginRequest",
+    "ActionDispatch::Http::Parameters::ParseError",
+    "ActionController::BadRequest",
+    "ActionController::ParameterMissing",
+    "Rack::QueryParser::ParameterTypeError",
+    "Rack::QueryParser::InvalidParameterError",
+    # Default ActiveRecord rescue responses
+    "ActiveRecord::RecordNotFound",
+    "ActiveRecord::StaleObjectError",
+    "ActiveRecord::RecordInvalid",
+    "ActiveRecord::RecordNotSaved",
+    # Additional items
+    "ActiveJob::DeserializationError",
+    "CGI::Session::CookieStore::TamperedWithCookie",
+    "GdsApi::HTTPIntermittentServerError",
+    "GdsApi::TimedOutException",
+    "Mongoid::Errors::DocumentNotFound",
+    "Sinatra::NotFound",
   ]
 
   # This will exclude exceptions that are triggered by one of the ignored
@@ -30,7 +43,7 @@ GovukError.configure do |config|
   # Rails will raise a ActionView::Template::Error, instead of the original error.
   config.inspect_exception_causes_for_exclusion = true
 
-  config.transport_failure_callback = Proc.new {
+  config.transport_failure_callback = proc {
     GovukStatsd.increment("error_reports_failed")
   }
 end

data/lib/govuk_app_config/govuk_content_security_policy.rb

@@ -9,15 +9,15 @@ module GovukContentSecurityPolicy
   # - https://cspvalidator.org
 
   GOVUK_DOMAINS = [
-    '*.publishing.service.gov.uk',
+    "*.publishing.service.gov.uk",
     "*.#{ENV['GOVUK_APP_DOMAIN_EXTERNAL'] || ENV['GOVUK_APP_DOMAIN'] || 'dev.gov.uk'}",
     "www.gov.uk",
-    "*.dev.gov.uk"
+    "*.dev.gov.uk",
   ].uniq.freeze
 
-  GOOGLE_ANALYTICS_DOMAINS = %w(www.google-analytics.com
+  GOOGLE_ANALYTICS_DOMAINS = %w[www.google-analytics.com
                                 ssl.google-analytics.com
-                                stats.g.doubleclick.net).freeze
+                                stats.g.doubleclick.net].freeze
 
   def self.build_policy(policy)
     # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/default-src

data/lib/govuk_app_config/govuk_healthcheck.rb

@@ -13,8 +13,8 @@ module GovukHealthcheck
     proc do
       [
         200,
-        {"Content-Type" => "application/json"},
-        [JSON.dump(healthcheck(checks))]
+        { "Content-Type" => "application/json" },
+        [JSON.dump(healthcheck(checks))],
       ]
     end
   end

data/lib/govuk_app_config/govuk_healthcheck/active_record.rb

@@ -7,7 +7,7 @@ module GovukHealthcheck
     def status
       ::ActiveRecord::Base.connection
       OK
-    rescue StandardError => e
+    rescue StandardError
       CRITICAL
     end
   end

data/lib/govuk_app_config/govuk_healthcheck/checkup.rb

@@ -43,7 +43,7 @@ module GovukHealthcheck
     end
 
     def status?(status)
-      component_statuses.values.any? {|s| s[:status] == status }
+      component_statuses.values.any? { |s| s[:status] == status }
     end
 
     def build_component_status(check)

data/lib/govuk_app_config/govuk_healthcheck/sidekiq_queue_check.rb

@@ -41,7 +41,7 @@ module GovukHealthcheck
             thresholds: {
               critical: critical_threshold(queue: name),
               warning: warning_threshold(queue: name),
-            }.select { |_, val| !(val.to_f.infinite? || val.to_f.nan?) },
+            }.reject { |_, val| val.to_f.infinite? || val.to_f.nan? },
           }
         end,
       }
@@ -51,11 +51,11 @@ module GovukHealthcheck
       raise "This method must be overriden to be a hash of queue names and data."
     end
 
-    def critical_threshold(queue:)
+    def critical_threshold(queue:) # rubocop:disable Lint/UnusedMethodArgument
       raise "This method must be overriden to be the critical threshold."
     end
 
-    def warning_threshold(queue:)
+    def warning_threshold(queue:) # rubocop:disable Lint/UnusedMethodArgument
       raise "This method must be overriden to be the warning threshold."
     end
   end

data/lib/govuk_app_config/govuk_healthcheck/sidekiq_redis.rb

@@ -6,7 +6,6 @@ module GovukHealthcheck
 
     def status
       Sidekiq.redis_info ? OK : CRITICAL
-
     rescue StandardError
       # One would expect a Redis::BaseConnectionError, but this should be
       # critical if any exception is raised when making a call to redis.

data/lib/govuk_app_config/govuk_logging.rb

@@ -1,5 +1,6 @@
-require 'logstasher'
-require 'action_controller'
+require "logstasher"
+require "action_controller"
+require_relative "rails_ext/action_dispatch/debug_exceptions"
 
 module GovukLogging
   def self.configure
@@ -13,8 +14,11 @@ module GovukLogging
     #
     # To resolve this we've directed stdout to stderr, to cover any Rails
     # writing. This frees up the normal stdout for the logstasher logs.
+
+    # rubocop:disable Style/GlobalVars
     $real_stdout = $stdout.clone
     $stdout.reopen($stderr)
+    # rubocop:enable Style/GlobalVars
 
     # Send Rails' logs to STDERR because they're not JSON formatted.
     Rails.logger = ActiveSupport::TaggedLogging.new(Logger.new($stderr, level: Rails.logger.level))
@@ -22,7 +26,7 @@ module GovukLogging
     # Custom that will be added to the Rails request logs
     LogStasher.add_custom_fields do |fields|
       # Mirrors Nginx request logging, e.g GET /path/here HTTP/1.1
-      fields[:request] = "#{request.request_method} #{request.fullpath} #{request.headers["SERVER_PROTOCOL"]}"
+      fields[:request] = "#{request.request_method} #{request.fullpath} #{request.headers['SERVER_PROTOCOL']}"
 
       # Pass request Id to logging
       fields[:govuk_request_id] = request.headers["GOVUK-Request-Id"]
@@ -44,13 +48,13 @@ module GovukLogging
     Rails.application.config.logstasher.job_enabled = false
 
     Rails.application.config.logstasher.logger = Logger.new(
-      $real_stdout,
+      $real_stdout, # rubocop:disable Style/GlobalVars
       level: Rails.logger.level,
       formatter: proc { |_severity, _datetime, _progname, msg|
-        "#{String === msg ? msg : msg.inspect}\n"
-      }
+        "#{msg.is_a?(String) ? 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 +65,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/govuk_statsd.rb

@@ -4,10 +4,10 @@ require "forwardable"
 module GovukStatsd
   extend SingleForwardable
   def_delegators :client, :increment, :decrement, :count, :time, :timing,
-    :gauge, :set, :batch
+                 :gauge, :set, :batch
 
   def self.client
-    @statsd_client ||= begin
+    @client ||= begin
       statsd_client = ::Statsd.new("localhost")
       statsd_client.namespace = ENV["GOVUK_STATSD_PREFIX"].to_s
       statsd_client

data/lib/govuk_app_config/govuk_unicorn.rb

@@ -9,8 +9,9 @@ module GovukUnicorn
       config.stderr_path "#{ENV['GOVUK_APP_LOGROOT']}/app.err.log"
     end
 
-    config.before_exec do |server|
+    config.before_exec do |_server|
       next unless ENV["GOVUK_APP_ROOT"]
+
       ENV["BUNDLE_GEMFILE"] = "#{ENV['GOVUK_APP_ROOT']}/Gemfile"
     end
 

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

@@ -0,0 +1,52 @@
+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 => e
+        Rails.logger.warn "Failed to detect whether to monkey patch " \
+          "::ActionDispatch::DebugExceptions#log_error - #{e.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.0.3"
+  VERSION = "2.2.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.2.1
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-06 00:00:00.000000000 Z
+date: 2020-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstasher
@@ -39,7 +39,7 @@ dependencies:
         version: 2.7.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.14.0
+        version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +49,7 @@ dependencies:
         version: 2.7.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.14.0
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: statsd-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -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: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -168,6 +182,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-govuk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -191,6 +219,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - CHANGELOG.md
 - Gemfile
@@ -218,6 +247,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