govuk_app_config 2.4.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c0b9c8e27eb3dca58e8a3f69f8d450d40e8dd414955ed5813da2da0f354f065
-  data.tar.gz: 9b31177222e5d6379c0fef90c8877315bd4d287050de76c73bbd1f5850735e71
+  metadata.gz: 42c7ced77e0c6592acdcbd98f489a2ed0ac60e7651aad238f4a4cdaa5f840952
+  data.tar.gz: 577864e98f093d456e3c3f911a8b67bd09dd7f25d9484da63fad8fb1473d19a9
 SHA512:
-  metadata.gz: ecd1be01ef33495bf0c7475aa41c79961ce6cff6b8fe450fbb8705843da4b4ed713cf6dc67d04e16f0a950ead32d8705cd20ae7aabaab33de76a2d626f8d80e0
-  data.tar.gz: e7af13588d6de9cd2ae2ba2e284001e1c6ff6f5cdf9f0fc07cc459905224aae076a5d4c25f1f208f6926f59717bf51328a27b3077f6d9c3bd358b61cb2659fdc
+  metadata.gz: 1b19a36fda15dd6a28ca60ab34bfd2b7f1c5ff0c078912f79b8a7936afe69723f5ce8812b3dc1d61afd3eb194eb6de56ecc8e2ac1de5ed7d0d81a507eb457393
+  data.tar.gz: 0ada829997c9a0f659b08dd5095c57420d37d1f0c47e6ddfc82ecbf4ab28e32ccd5a512d9907512020431b5ad6a80374bf9be622d4455ffa5f4e603888869d3e

data/CHANGELOG.md

@@ -1,11 +1,30 @@
+# 2.6.0
+
+* Ignore errors that occur in temporary environments (adds `active_sentry_environments` config) (https://github.com/alphagov/govuk_app_config/pull/168)
+
+# 2.5.2
+
+* Fix govuk_app_config in Ruby 2.7 environments by explicitly requiring the 'delegate' library (https://github.com/alphagov/govuk_app_config/pull/167)
+
+# 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 check
-* Add new GovukHealthcheck::RailsCache check
+* 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
+* Remove unused SidekiqQueueSizeCheck healthcheck base class (https://github.com/alphagov/govuk_app_config/pull/156)
 
 # 2.2.2
 

data/README.md

@@ -51,7 +51,7 @@ If you include `govuk_app_config` in your `Gemfile`, Rails' autoloading mechanis
 Your app will have to have the following environment variables set:
 
 - `SENTRY_DSN` - the [Data Source Name (DSN)][dsn] for Sentry
-- `SENTRY_CURRENT_ENV` - production, staging or integration
+- `SENTRY_CURRENT_ENV` - e.g. "production". Make sure it is [configured to be active](#active-sentry-environments).
 - `GOVUK_STATSD_PREFIX` - a Statsd prefix like `govuk.apps.application-name.hostname`
 
 [dsn]: https://docs.sentry.io/quickstart/#about-the-dsn
@@ -79,6 +79,18 @@ GovukError.notify(
 )
 ```
 
+### Active Sentry environments
+
+GovukError will only send errors to Sentry if your `SENTRY_CURRENT_ENV` matches one of the 'active environments' in the [default configuration](https://github.com/alphagov/govuk_app_config/blob/master/lib/govuk_app_config/govuk_error/configure.rb). This is to prevent temporary test environments from flooding our Sentry account with errors.
+
+You can add your environment to the list of active Sentry environments like so:
+
+```ruby
+GovukError.configure do |config|
+  config.active_sentry_environments << "my-test-environment"
+end
+```
+
 ### Error configuration
 
 You can exclude certain errors from being reported using this:
@@ -89,6 +101,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/govuk_app_config.gemspec

@@ -21,10 +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.8"
 
+  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,55 @@
+require "delegate"
+require "govuk_app_config/govuk_error/govuk_data_sync"
+
+module GovukError
+  class Configuration < SimpleDelegator
+    attr_reader :data_sync, :sentry_environment
+    attr_accessor :active_sentry_environments, :data_sync_excluded_exceptions
+
+    def initialize(_raven_configuration)
+      super
+      @sentry_environment = ENV["SENTRY_CURRENT_ENV"]
+      @data_sync = GovukDataSync.new(ENV["GOVUK_DATA_SYNC_PERIOD"])
+      self.active_sentry_environments = []
+      self.data_sync_excluded_exceptions = []
+      self.should_capture = ignore_exceptions_based_on_env_and_data_sync
+    end
+
+    def should_capture=(closure)
+      combined = lambda do |error_or_event|
+        (ignore_exceptions_based_on_env_and_data_sync.call(error_or_event) && closure.call(error_or_event))
+      end
+
+      super(combined)
+    end
+
+  protected
+
+    def ignore_exceptions_based_on_env_and_data_sync
+      lambda do |error_or_event|
+        ignore_exceptions_if_not_in_active_sentry_env.call(error_or_event) &&
+          ignore_excluded_exceptions_in_data_sync.call(error_or_event)
+      end
+    end
+
+    def ignore_exceptions_if_not_in_active_sentry_env
+      ->(_error_or_event) { active_sentry_environments.include?(sentry_environment) }
+    end
+
+    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}

@@ -7,6 +7,16 @@ GovukError.configure do |config|
 
   config.silence_ready = !Rails.env.production? if defined?(Rails)
 
+  # These are the environments (described by the `SENTRY_CURRENT_ENV`
+  # ENV variable) where we want to capture Sentry errors. If
+  # `SENTRY_CURRENT_ENV` isn't in this list, or isn't defined, then
+  # don't capture the error.
+  config.active_sentry_environments = %w[
+    integration-blue-aws
+    staging
+    production
+  ]
+
   config.excluded_exceptions = [
     # Default ActionDispatch rescue responses
     "ActionController::RoutingError",
@@ -43,6 +53,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/version.rb

@@ -1,3 +1,3 @@
 module GovukAppConfig
-  VERSION = "2.4.0".freeze
+  VERSION = "2.6.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.6.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-14 00:00:00.000000000 Z
+date: 2020-10-27 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
@@ -84,6 +78,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: climate_control
   requirement: !ruby/object:Gem::Requirement
@@ -218,9 +226,11 @@ 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