govuk_app_config 2.4.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09d834575f5a08c3fbac882d165d1dbe413693f963d7e8e82b4a17b180fea526'
-  data.tar.gz: e762adcec651712f0b4172773f7c2128388245ddaba645409ce1ccd37c6326ee
+  metadata.gz: dbd89ce53c62443a1bf91f7c782fc121a493323b8f55f77db131e9fab17bc78b
+  data.tar.gz: cc5435d8e5a2769c688afa0f37869ec96bc58311b2c7e5051e0dbe226496f50c
 SHA512:
-  metadata.gz: 7f75e55060e8204fea9eb2e202ffb2a392f74c4e5d4dbf2ec6acff1cfe0c502bffef302aa870a8cae0b1b114409514976f55d77f7f381d06fd237f98e0d9745e
-  data.tar.gz: a133f95a954b855b52b22b4aea77bf092a27c23fba96d4ac1171cc60839dda6731eeabc8c6106b8144121c3912fe590df63e6e08ee870c65962c24cafc8346c8
+  metadata.gz: 8c9a936938fdb3795e3edd0fdf9f43a368a5130f034d30150bdd4201c5490a47b015b492a1275d8dba4668ec9e44b32b4a8692fa4cddf7bb59eee9242f468e23
+  data.tar.gz: ad4e17d9b55e828c4542517a427ba6f35152583fe536f87801a7d2567cff00a0bc6d036103cc29186fab381b61b904b1a7eaa63c0a088a0b55c2735371ea39e1

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 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)

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/govuk_app_config.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   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,36 @@
+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_chain = Raven::Utils::ExceptionCauseChain.exception_to_array(error_or_event)
+          exception_chain.any? { |exception| exception.class.to_s == exception_to_ignore }
+        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/version.rb

@@ -1,3 +1,3 @@
 module GovukAppConfig
-  VERSION = "2.4.1".freeze
+  VERSION = "2.5.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.5.0
 platform: ruby
 authors:
 - GOV.UK Dev
@@ -78,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
@@ -212,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