govuk_app_config 2.1.2 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00db6acb8d6b3c6f2682914794f02ff946e3ced2dccde8ae5c999d06814327c6
-  data.tar.gz: 897ae29ceea331b4f66fe2d247e7e61f1d87c518d994e9515f81e3f229b9be2a
+  metadata.gz: 8c0b9c8e27eb3dca58e8a3f69f8d450d40e8dd414955ed5813da2da0f354f065
+  data.tar.gz: 9b31177222e5d6379c0fef90c8877315bd4d287050de76c73bbd1f5850735e71
 SHA512:
-  metadata.gz: 963bd2ee9b438f29988b85d9ae1a8c4e5fdbe198fe6221b963b66782011acd270654640280eaefcc133626dde8a85750a407cb016a511b749a09530863dd366e
-  data.tar.gz: 40658b4718d1f74d864d5d6ac26753b6a18906fcb72669d04787e5ff56ccc805d2c348d14282108cc92cc99bcc941a88333446e1a475579c365240bda3fc38f5
+  metadata.gz: ecd1be01ef33495bf0c7475aa41c79961ce6cff6b8fe450fbb8705843da4b4ed713cf6dc67d04e16f0a950ead32d8705cd20ae7aabaab33de76a2d626f8d80e0
+  data.tar.gz: e7af13588d6de9cd2ae2ba2e284001e1c6ff6f5cdf9f0fc07cc459905224aae076a5d4c25f1f208f6926f59717bf51328a27b3077f6d9c3bd358b61cb2659fdc

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+# 2.4.0
+
+* Add new GovukHealthcheck::Mongoid check
+* Add new GovukHealthcheck::RailsCache check
+
+# 2.3.0
+
+* Remove unused SidekiqQueueSizeCheck healthcheck base class
+
+# 2.2.2
+
+* Add www.googletagmanager.com and www.gstatic.com to Content Security Policy (https://github.com/alphagov/govuk_app_config/pull/153)
+
+# 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)
@@ -242,7 +263,7 @@
 * Add Unicorn (our web server) as a dependency
 * Use version [2.7.0 of the Sentry client][sentry-270].
 * Set up logging configuration for Rails applications.
-* Don't send `ActionController::BadRequest`
 to Sentry
+* Don't send `ActionController::BadRequest`
  to Sentry
 
 [sentry-270]: https://github.com/getsentry/raven-ruby/commit/ef623824cb0a8a2f60be5fb7e12f80454da54fd7
 

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

@@ -73,6 +73,15 @@ if it must be subclassed to work, but a concrete class which works on its own
 doesn't need that suffix. You should aim to follow this convention in your own
 apps, ideally putting custom health checks into a `Healthcheck` module.
 
+### `RailsCache`
+
+This checks that the Rails cache store, such as Memcached, is acessible by
+writing and reading back a cache entry called "healthcheck-cache".
+
+### `Mongoid`
+
+This checks that the app has a connection to its Mongo database via Mongoid.
+
 ### `SidekiqRedis`
 
 This checks that the app has a connection to Redis via Sidekiq.
@@ -128,24 +137,6 @@ class MySidekiqQueueLatencyCheck < GovukHealthcheck::SidekiqQueueLatencyCheck
 end
 ```
 
-### `SidekiqQueueSizeCheck`
-
-This class is the basis for a check which compares the Sidekiq queue sizes
-with warning or critical thresholds.
-
-```ruby
-class MySidekiqQueueSizeCheck < GovukHealthcheck::SidekiqQueueSizeCheck
-  def warning_threshold(queue:)
-    # the warning threshold for a particular queue
-  end
-
-  def critical_threshold(queue:)
-    # the critical threshold for a particular queue
-  end
-end
-```
-
-
 ### `SidekiqRetrySizeCheck`
 
 Similar to `SidekiqQueueSizeCheck`, this class is the basis for a check which

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"
@@ -25,13 +23,14 @@ Gem::Specification.new do |spec|
   spec.add_dependency "logstasher", ">= 1.2.2", "< 1.4.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_dependency "unicorn", ">= 5.4", "< 5.8"
 
-  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
@@ -43,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,18 @@ 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
+                                www.googletagmanager.com].freeze
+
+  GOOGLE_STATIC_DOMAINS = %w[www.gstatic.com].freeze
 
   def self.build_policy(policy)
     # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/default-src
@@ -35,6 +38,7 @@ module GovukContentSecurityPolicy
     policy.script_src :self,
                       *GOVUK_DOMAINS,
                       *GOOGLE_ANALYTICS_DOMAINS,
+                      *GOOGLE_STATIC_DOMAINS,
                       # Allow JSONP call to Verify to check whether the user is logged in
                       "www.signin.service.gov.uk",
                       # Allow YouTube Embeds (Govspeak turns YouTube links into embeds)
@@ -51,6 +55,7 @@ module GovukContentSecurityPolicy
     # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/style-src
     policy.style_src :self,
                      *GOVUK_DOMAINS,
+                     *GOOGLE_STATIC_DOMAINS,
                      # We use the `style=""` attribute on some HTML elements
                      :unsafe_inline
 

data/lib/govuk_app_config/govuk_healthcheck.rb

@@ -1,10 +1,11 @@
 require "govuk_app_config/govuk_healthcheck/checkup"
 require "govuk_app_config/govuk_healthcheck/active_record"
+require "govuk_app_config/govuk_healthcheck/mongoid"
+require "govuk_app_config/govuk_healthcheck/rails_cache"
 require "govuk_app_config/govuk_healthcheck/sidekiq_redis"
 require "govuk_app_config/govuk_healthcheck/threshold_check"
 require "govuk_app_config/govuk_healthcheck/sidekiq_queue_check"
 require "govuk_app_config/govuk_healthcheck/sidekiq_queue_latency_check"
-require "govuk_app_config/govuk_healthcheck/sidekiq_queue_size_check"
 require "govuk_app_config/govuk_healthcheck/sidekiq_retry_size_check"
 require "json"
 
@@ -13,8 +14,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/mongoid.rb

@@ -0,0 +1,14 @@
+module GovukHealthcheck
+  class Mongoid
+    def name
+      :database_connectivity
+    end
+
+    def status
+      ::Mongoid.default_client.database_names.any?
+      GovukHealthcheck::OK
+    rescue StandardError
+      GovukHealthcheck::CRITICAL
+    end
+  end
+end

data/lib/govuk_app_config/govuk_healthcheck/rails_cache.rb

@@ -0,0 +1,16 @@
+module GovukHealthcheck
+  class RailsCache
+    def name
+      :rails_cache
+    end
+
+    def status
+      ::Rails.cache.write("healthcheck-cache", true)
+      raise unless ::Rails.cache.read("healthcheck-cache")
+
+      GovukHealthcheck::OK
+    rescue StandardError
+      GovukHealthcheck::CRITICAL
+    end
+  end
+end

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.1.2"
+  VERSION = "2.4.0".freeze
 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.4.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-19 00:00:00.000000000 Z
+date: 2020-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstasher
@@ -73,7 +73,7 @@ dependencies:
         version: '5.4'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.6'
+        version: '5.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -83,35 +83,35 @@ dependencies:
         version: '5.4'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.6'
+        version: '5.8'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: climate_control
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: climate_control
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -168,6 +168,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 +205,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - CHANGELOG.md
 - Gemfile
@@ -209,15 +224,17 @@ files:
 - lib/govuk_app_config/govuk_healthcheck.rb
 - lib/govuk_app_config/govuk_healthcheck/active_record.rb
 - lib/govuk_app_config/govuk_healthcheck/checkup.rb
+- lib/govuk_app_config/govuk_healthcheck/mongoid.rb
+- lib/govuk_app_config/govuk_healthcheck/rails_cache.rb
 - lib/govuk_app_config/govuk_healthcheck/sidekiq_queue_check.rb
 - lib/govuk_app_config/govuk_healthcheck/sidekiq_queue_latency_check.rb
-- lib/govuk_app_config/govuk_healthcheck/sidekiq_queue_size_check.rb
 - lib/govuk_app_config/govuk_healthcheck/sidekiq_redis.rb
 - lib/govuk_app_config/govuk_healthcheck/sidekiq_retry_size_check.rb
 - lib/govuk_app_config/govuk_healthcheck/threshold_check.rb
 - 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
@@ -239,7 +256,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Base configuration for GOV.UK applications

data/lib/govuk_app_config/govuk_healthcheck/sidekiq_queue_size_check.rb

@@ -1,11 +0,0 @@
-module GovukHealthcheck
-  class SidekiqQueueSizeCheck < SidekiqQueueCheck
-    def name
-      :sidekiq_queue_size
-    end
-
-    def queues
-      @queues ||= Sidekiq::Stats.new.queues
-    end
-  end
-end