govuk_app_config 2.2.2 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5f678cf6bda651a47bdef20c6797c07dd441d65e32cab0f19f95ce4041aa3ea
-  data.tar.gz: bf3c17de28c3c7ca1499af447635f7a43047e05208d24be705796f7a4e5a92d6
+  metadata.gz: c21acad0f7309884269c7e2e1bcca15285f6ee8d43de0c9ac4cb2320438858d6
+  data.tar.gz: 4ecabaceee90ea13755cd262b825a9f5c54ad4bbb106e830b8f61a3bf923c11d
 SHA512:
-  metadata.gz: 1849ad797e75cea6e7524d56ae97330ac6803725b28324c32f398679d270bf7f8e2f2f1badd9defdc362be68869b5cb8187521a55bac21e53c71fb79d023e4db
-  data.tar.gz: 153f6f67e25d21d098bf86495a353c75189b895a1f8cfff2cc756f42269d6698cea6da7a40fcbb69d7a685e6d2157856c19487d00e4fb4fde3561e400dcc8089
+  metadata.gz: b09dbcb815fca0dd6e2f05e2eca147a2a9e7fd1580c343a9bb2c356312e0a43a9918f99f0d795a88ad989bc11552bfe6154944ba7a3189b24522e62767aa5262
+  data.tar.gz: bf3328f7ee32405b825d24386016b49d5cb80e87c0cf2465419120f6e73f1f5c67e68b239b52505a045cb6a11a9b95ddbec68704c0d0540b4531b5d1ab2b02ce

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+# 2.5.1
+
+* Increase scope of `data_sync_excluded_exceptions` so that it includes subclasses (https://github.com/alphagov/govuk_app_config/pull/165)
+
+# 2.5.0
+
+* Use delegator pattern for `GovukError.configure`, to allow custom `should_capture` (https://github.com/alphagov/govuk_app_config/pull/160)
+
+# 2.4.1
+
+* Bump 'sentry-raven' to 3.1.1 to improve grouping of errors (https://github.com/alphagov/govuk_app_config/pull/162)
+
+# 2.4.0
+
+* Add new GovukHealthcheck::Mongoid and GovukHealthcheck::RailsCache health checks (https://github.com/alphagov/govuk_app_config/pull/161)
+
+# 2.3.0
+
+* Remove unused SidekiqQueueSizeCheck healthcheck base class (https://github.com/alphagov/govuk_app_config/pull/156)
+
 # 2.2.2
 
 * Add www.googletagmanager.com and www.gstatic.com to Content Security Policy (https://github.com/alphagov/govuk_app_config/pull/153)
@@ -254,7 +274,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/README.md

@@ -89,6 +89,27 @@ GovukError.configure do |config|
 end
 ```
 
+And you can exclude errors from being reported if they occur during the nightly data sync (on integration and staging):
+
+```ruby
+GovukError.configure do |config|
+  config.data_sync_excluded_exceptions << "PG::Error"
+end
+```
+
+Finally, you can pass your own callback to evaluate whether or not to capture the exception.
+Note that if an exception is on the `excluded_exceptions` list, or on the `data_sync_excluded_exceptions`
+and occurs at the time of a data sync, then it will be excluded even if the custom
+`should_capture` callback returns `true`.
+
+```ruby
+GovukError.configure do |config|
+  config.should_capture = lambda do |error_or_event|
+    error_or_event == "do capture"
+  end
+end
+```
+
 `GovukError.configure` has the same options as the Sentry client, Raven. See [the Raven docs for all configuration options](https://docs.sentry.io/clients/ruby/config).
 
 ## Statsd

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

@@ -21,11 +21,11 @@ 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", "< 3.1.0"
+  spec.add_dependency "sentry-raven", "~> 3.1.1"
   spec.add_dependency "statsd-ruby", "~> 1.4.0"
-  spec.add_dependency "unicorn", ">= 5.4", "< 5.7"
+  spec.add_dependency "unicorn", ">= 5.4", "< 5.8"
 
-  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "byebug"
   spec.add_development_dependency "climate_control"
   spec.add_development_dependency "rack-test", "~> 1.1.0"
   spec.add_development_dependency "rails", "~> 6"

data/lib/govuk_app_config.rb

@@ -1,11 +1,11 @@
 require "govuk_app_config/version"
 require "govuk_app_config/govuk_statsd"
 require "govuk_app_config/govuk_error"
+require "govuk_app_config/govuk_error/configure"
 require "govuk_app_config/govuk_healthcheck"
 # This require is deprecated and should be removed on next major version bump
 # and should be required by applications directly.
 require "govuk_app_config/govuk_unicorn"
-require "govuk_app_config/configure"
 
 if defined?(Rails)
   require "govuk_app_config/govuk_logging"

data/lib/govuk_app_config/govuk_error.rb

@@ -1,5 +1,6 @@
 require "sentry-raven"
 require "govuk_app_config/govuk_statsd"
+require "govuk_app_config/govuk_error/configuration"
 
 module GovukError
   def self.notify(exception_or_message, args = {})
@@ -12,8 +13,7 @@ module GovukError
   end
 
   def self.configure
-    Raven.configure do |config|
-      yield(config)
-    end
+    @configuration ||= Configuration.new(Raven.configuration)
+    yield @configuration
   end
 end

data/lib/govuk_app_config/govuk_error/configuration.rb

@@ -0,0 +1,41 @@
+require "govuk_app_config/govuk_error/govuk_data_sync"
+
+module GovukError
+  class Configuration < SimpleDelegator
+    attr_reader :data_sync
+    attr_accessor :data_sync_excluded_exceptions
+
+    def initialize(_raven_configuration)
+      super
+      @data_sync = GovukDataSync.new(ENV["GOVUK_DATA_SYNC_PERIOD"])
+      self.data_sync_excluded_exceptions = []
+      self.should_capture = ignore_excluded_exceptions_in_data_sync
+    end
+
+    def should_capture=(closure)
+      combined = lambda do |error_or_event|
+        (ignore_excluded_exceptions_in_data_sync.call(error_or_event) && closure.call(error_or_event))
+      end
+
+      super(combined)
+    end
+
+  protected
+
+    def ignore_excluded_exceptions_in_data_sync
+      lambda { |error_or_event|
+        data_sync_ignored_error = data_sync_excluded_exceptions.any? do |exception_to_ignore|
+          exception_to_ignore = Object.const_get(exception_to_ignore) unless exception_to_ignore.is_a?(Module)
+          exception_chain = Raven::Utils::ExceptionCauseChain.exception_to_array(error_or_event)
+          exception_chain.any? { |exception| exception.is_a?(exception_to_ignore) }
+        rescue NameError
+          # the exception type represented by the exception_to_ignore string
+          # doesn't even exist in this environment, so won't be found in the chain
+          false
+        end
+
+        !(data_sync.in_progress? && data_sync_ignored_error)
+      }
+    end
+  end
+end

data/lib/govuk_app_config/{configure.rb → govuk_error/configure.rb}

@@ -43,6 +43,15 @@ GovukError.configure do |config|
   # Rails will raise a ActionView::Template::Error, instead of the original error.
   config.inspect_exception_causes_for_exclusion = true
 
+  # List of exceptions to ignore if they take place during the data sync.
+  # Some errors are transient in nature, e.g. PostgreSQL databases being
+  # unavailable, and add little value. In fact, their presence can greatly
+  # increase the number of errors being sent and risk genuine errors being
+  # rate-limited by Sentry.
+  config.data_sync_excluded_exceptions = [
+    "PG::Error",
+  ]
+
   config.transport_failure_callback = proc {
     GovukStatsd.increment("error_reports_failed")
   }

data/lib/govuk_app_config/govuk_error/govuk_data_sync.rb

@@ -0,0 +1,50 @@
+require "time"
+
+module GovukError
+  class GovukDataSync
+    class MalformedDataSyncPeriod < RuntimeError
+      attr_reader :invalid_value
+
+      def initialize(invalid_value)
+        @invalid_value = invalid_value
+      end
+
+      def message
+        "\"#{invalid_value}\" is not a valid value (should be of form '22:00-03:00')."
+      end
+    end
+
+    attr_reader :from, :to
+
+    def initialize(govuk_data_sync_period)
+      return if govuk_data_sync_period.nil?
+
+      parts = govuk_data_sync_period.split("-")
+      raise MalformedDataSyncPeriod, govuk_data_sync_period unless parts.count == 2
+
+      @from, @to = parts.map { |time| Time.parse(time) }
+    rescue ArgumentError
+      raise MalformedDataSyncPeriod, govuk_data_sync_period
+    end
+
+    def in_progress?
+      from.present? && to.present? && in_time_range?(from, to)
+    end
+
+  private
+
+    # `from`/`to` times are in relation to the local server time, which is expected to be in UTC as per:
+    # https://github.com/alphagov/govuk-puppet/blob/b588e4ade996e97b8975e69cb00800521fff4a48/modules/govuk_envsys/files/etc/environment#L3
+    def in_time_range?(from, to)
+      hour_is_in_range = Time.now.hour >= from.hour || Time.now.hour <= to.hour
+      minute_is_in_range = if Time.now.hour == from.hour
+                             Time.now.min >= from.min
+                           elsif Time.now.hour == to.hour
+                             Time.now.min <= to.min
+                           else
+                             true
+                           end
+      hour_is_in_range && minute_is_in_range
+    end
+  end
+end

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"
 

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/rails_ext/action_dispatch/debug_exceptions.rb

@@ -27,7 +27,7 @@ module GovukLogging
 
       def self.monkey_patch_log_error(clazz = ::ActionDispatch::DebugExceptions)
         clazz.class_eval do
-        private
+          private
 
           def log_error(request, wrapper)
             logger = logger(request)

data/lib/govuk_app_config/version.rb

@@ -1,3 +1,3 @@
 module GovukAppConfig
-  VERSION = "2.2.2".freeze
+  VERSION = "2.5.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.5.1
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-04 00:00:00.000000000 Z
+date: 2020-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstasher
@@ -34,22 +34,16 @@ dependencies:
   name: sentry-raven
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.7.1
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.7.1
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.1.1
 - !ruby/object:Gem::Dependency
   name: statsd-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -73,7 +67,7 @@ dependencies:
         version: '5.4'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.7'
+        version: '5.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -83,21 +77,21 @@ dependencies:
         version: '5.4'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.7'
+        version: '5.8'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: byebug
   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
   requirement: !ruby/object:Gem::Requirement
@@ -232,15 +226,18 @@ files:
 - docs/healthchecks.md
 - govuk_app_config.gemspec
 - lib/govuk_app_config.rb
-- lib/govuk_app_config/configure.rb
 - lib/govuk_app_config/govuk_content_security_policy.rb
 - lib/govuk_app_config/govuk_error.rb
+- lib/govuk_app_config/govuk_error/configuration.rb
+- lib/govuk_app_config/govuk_error/configure.rb
+- lib/govuk_app_config/govuk_error/govuk_data_sync.rb
 - 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
@@ -269,7 +266,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