govuk_app_config 2.5.1 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c21acad0f7309884269c7e2e1bcca15285f6ee8d43de0c9ac4cb2320438858d6
-  data.tar.gz: 4ecabaceee90ea13755cd262b825a9f5c54ad4bbb106e830b8f61a3bf923c11d
+  metadata.gz: 50c4b50f5a22588851e04eca092e805837d2261d7d20983c9c26c07bc2ac434f
+  data.tar.gz: 43b503c4451da57a7b414881c11b30699f8c128574ad0fde493991e8564c7215
 SHA512:
-  metadata.gz: b09dbcb815fca0dd6e2f05e2eca147a2a9e7fd1580c343a9bb2c356312e0a43a9918f99f0d795a88ad989bc11552bfe6154944ba7a3189b24522e62767aa5262
-  data.tar.gz: bf3328f7ee32405b825d24386016b49d5cb80e87c0cf2465419120f6e73f1f5c67e68b239b52505a045cb6a11a9b95ddbec68704c0d0540b4531b5d1ab2b02ce
+  metadata.gz: c3d757ff6c8783fa3760919a50a74a17f63a050e54e02b6c92ad22b98acb77fd2548c6f0932079fc8ac2e7306a71c0e7a8ada9971f20572c22a222cb66da81e2
+  data.tar.gz: 602885c83d0382ea1109ce3d514d783c9aa248bc3355d54364cbd81b4c81976f43e8fd9d60d210016800296591c4f1ff3909493f2dba5d38823baf927896f783

data/CHANGELOG.md

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

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.rb

@@ -1,6 +1,7 @@
 require "sentry-raven"
 require "govuk_app_config/govuk_statsd"
 require "govuk_app_config/govuk_error/configuration"
+require "govuk_app_config/version"
 
 module GovukError
   def self.notify(exception_or_message, args = {})
@@ -9,6 +10,9 @@ module GovukError
     args[:extra] ||= {}
     args[:extra].merge!(parameters: args.delete(:parameters))
 
+    args[:tags] ||= {}
+    args[:tags][:govuk_app_config_version] = GovukAppConfig::VERSION
+
     Raven.capture_exception(exception_or_message, args)
   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,6 +25,17 @@ 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|

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.1".freeze
+  VERSION = "2.8.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.8.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-21 00:00:00.000000000 Z
+date: 2020-12-04 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