govuk_app_config 2.5.0 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbd89ce53c62443a1bf91f7c782fc121a493323b8f55f77db131e9fab17bc78b
-  data.tar.gz: cc5435d8e5a2769c688afa0f37869ec96bc58311b2c7e5051e0dbe226496f50c
+  metadata.gz: 508f0dbee6a74e50e9e6d12922e13f4c956b62078382e2a2cc7d0a0496a94321
+  data.tar.gz: 2d61642e4bf9df8aea02eb71e51a99e07e201a9577fe7360346b3f5c2c31e74d
 SHA512:
-  metadata.gz: 8c9a936938fdb3795e3edd0fdf9f43a368a5130f034d30150bdd4201c5490a47b015b492a1275d8dba4668ec9e44b32b4a8692fa4cddf7bb59eee9242f468e23
-  data.tar.gz: ad4e17d9b55e828c4542517a427ba6f35152583fe536f87801a7d2567cff00a0bc6d036103cc29186fab381b61b904b1a7eaa63c0a088a0b55c2735371ea39e1
+  metadata.gz: 4a1a785b09f73f42b6e98362005e3341d744612127d477896a0ff2fc5d5aebe0052562f6c05d058c466528ac40acdd81e659ff27d9b95a3b4e952a3c6ceb60bf
+  data.tar.gz: 7a676c3ec6619c2f5020b56634e16803bfd6dc5f20e813fe91e3abbc83176570ee0ef09e0d08a1f9afcc639e158edd3f912f83ff5a7b202f2fa8455c5ce0e85f

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+# 2.7.1
+
+* Fix broken data sync error handling for non-Rails apps
+
+# 2.7.0
+
+* Ignore intermittent template retrieval errors from Slimmer
+
+# 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)

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:

data/govuk_app_config.gemspec

@@ -27,11 +27,11 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "climate_control"
-  spec.add_development_dependency "rack-test", "~> 1.1.0"
+  spec.add_development_dependency "rack-test", "~> 1.1"
   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 "rspec", "~> 3.10"
+  spec.add_development_dependency "rspec-its", "~> 1.3"
   spec.add_development_dependency "rubocop-govuk"
   spec.add_development_dependency "webmock"
 end

data/lib/govuk_app_config/govuk_error/configuration.rb

@@ -1,20 +1,23 @@
+require "delegate"
 require "govuk_app_config/govuk_error/govuk_data_sync"
 
 module GovukError
   class Configuration < SimpleDelegator
-    attr_reader :data_sync
-    attr_accessor :data_sync_excluded_exceptions
+    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_excluded_exceptions_in_data_sync
+      self.should_capture = ignore_exceptions_based_on_env_and_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))
+        (ignore_exceptions_based_on_env_and_data_sync.call(error_or_event) && closure.call(error_or_event))
       end
 
       super(combined)
@@ -22,11 +25,27 @@ module GovukError
 
   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.class.to_s == exception_to_ignore }
+          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)

data/lib/govuk_app_config/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",
@@ -36,6 +46,7 @@ GovukError.configure do |config|
     "GdsApi::TimedOutException",
     "Mongoid::Errors::DocumentNotFound",
     "Sinatra::NotFound",
+    "Slimmer::IntermittentRetrievalError",
   ]
 
   # This will exclude exceptions that are triggered by one of the ignored

data/lib/govuk_app_config/govuk_error/govuk_data_sync.rb

@@ -28,7 +28,7 @@ module GovukError
     end
 
     def in_progress?
-      from.present? && to.present? && in_time_range?(from, to)
+      !from.nil? && !to.nil? && in_time_range?(from, to)
     end
 
   private

data/lib/govuk_app_config/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.7.1
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-20 00:00:00.000000000 Z
+date: 2020-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstasher
@@ -112,14 +112,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -154,28 +154,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rubocop-govuk
   requirement: !ruby/object:Gem::Requirement