govuk_app_config 2.10.0 → 4.0.0.pre.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f98f57ba0b9010154d3aefbc2540acd056d35ef42af9e3b22b00495255f46899
-  data.tar.gz: c5315e4ba1f476e7c0fcb99839ad9e8705a1546e4b48e3246a16e94f6552b383
+  metadata.gz: b1a08f51ba88f28b8694fd0f40f94a92ac053a424b25e860b5795e96da7431b7
+  data.tar.gz: 6dd0f7061f779450c5fdc029002dc5474070306daa5acf3de5f78a9867667c93
 SHA512:
-  metadata.gz: cea414c28b13d2b9cb359bade9dd6626eceb9dfd0f76ca79f77b2b8bff9f4807c01858951860e6888f795a32aa50cd2c79cc1ea63f72a01315a6cbd44b49d8cd
-  data.tar.gz: 3ef1e0ea53a489935775c9475cecb5f55585d2cfba0aed30b6a184430ab7fada8e24670150ebfa60043a59a6d750f76aeb913b89f826da2bbe3db68ca524cc7a
+  metadata.gz: 47c5d3a3da84267ef909d3de765bd60a0af8587bc6712523ee8ca44ccb9bc74f7fc76a0b21b413437f2ea7d35829acb77589b8f29c86904876dd88ad23a0845d
+  data.tar.gz: 7ebb2c404c7abde0e16c1b22c63d523491ff70465161e806c3a91a3911e6cddebb406b7b774add5668aaf793a2dab6659f1629eb2c9bc575ba0c782927544cc9

data/.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "03:00"
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: aws-xray-sdk
+    versions:
+    - "> 0.10.0"

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+# 4.0.0.pre-2
+
+- Fix default Sentry configuration ([#202](https://github.com/alphagov/govuk_app_config/pull/202)).
+- BREAKING: this means no more `silence_ready` or `transport_failure_callback` options.
+
+# 4.0.0.pre-1
+
+- BREAKING: upgrades Sentry gem from `sentry-raven` to `sentry-ruby` ([#199](https://github.com/alphagov/govuk_app_config/pull/199)). There is a **[migration guide](https://docs.sentry.io/platforms/ruby/migration/)** you should follow before upgrading to this version of govuk_app_config.
+- This release also fixes the `data_sync_excluded_exceptions` behaviour that has been broken since v3.1.0.
+- Released as a pre-release to identify and fix any problems before a wider rollout.
+
+# 3.1.1
+
+- Fix the new before_send behaviour & tests, and add documentation ([#197](https://github.com/alphagov/govuk_app_config/pull/197))
+
+# 3.1.0
+
+- Remove support for `should_capture` callbacks in favour of `before_send` ([#196](https://github.com/alphagov/govuk_app_config/pull/196))
+
+# 3.0.0
+
+* BREAKING: Implement RFC 141 - remove unsuitable healthchecks and return a 500 on healthcheck failure ([#193](https://github.com/alphagov/govuk_app_config/pull/193))
+
 # 2.10.0
 * Allow LUX domain on img-src policy ([#191](https://github.com/alphagov/govuk_app_config/pull/191))
 

data/README.md

@@ -112,12 +112,12 @@ 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`.
+`before_send` callback doesn't return `nil`.
 
 ```ruby
 GovukError.configure do |config|
-  config.should_capture = lambda do |error_or_event|
-    error_or_event == "do capture"
+  config.before_send = lambda do |event, hint|
+    hint[:exception].is_a?(ErrorWeWantToIgnore) ? nil : event
   end
 end
 ```

data/govuk_app_config.gemspec

@@ -13,15 +13,15 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/alphagov/govuk_app_config"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
+  spec.required_ruby_version = ">= 2.6"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = %w[lib]
 
   spec.add_dependency "logstasher", ">= 1.2.2", "< 2.2.0"
-  spec.add_dependency "sentry-raven", "~> 3.1.1"
+  spec.add_dependency "sentry-ruby", "~> 4.5.0"
   spec.add_dependency "statsd-ruby", "~> 1.5.0"
   spec.add_dependency "unicorn", ">= 5.4", "< 5.9"
 

data/lib/govuk_app_config/govuk_error.rb

@@ -1,4 +1,4 @@
-require "sentry-raven"
+require "sentry-ruby"
 require "govuk_app_config/govuk_statsd"
 require "govuk_app_config/govuk_error/configuration"
 require "govuk_app_config/version"
@@ -13,11 +13,11 @@ module GovukError
     args[:tags] ||= {}
     args[:tags][:govuk_app_config_version] = GovukAppConfig::VERSION
 
-    Raven.capture_exception(exception_or_message, args)
+    Sentry.capture_exception(exception_or_message, args)
   end
 
   def self.configure
-    @configuration ||= Configuration.new(Raven.configuration)
+    @configuration ||= Configuration.new(Sentry::Configuration.new)
     yield @configuration
   end
 end

data/lib/govuk_app_config/govuk_error/configuration.rb

@@ -6,41 +6,35 @@ module GovukError
     attr_reader :data_sync, :sentry_environment
     attr_accessor :active_sentry_environments, :data_sync_excluded_exceptions
 
-    def initialize(_raven_configuration)
+    def initialize(_sentry_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
+      @before_send_callbacks = [
+        ignore_exceptions_if_not_in_active_sentry_env,
+        ignore_excluded_exceptions_in_data_sync,
+        increment_govuk_statsd_counters,
+      ]
     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)
+    def before_send=(closure)
+      @before_send_callbacks.insert(-2, closure)
+      super(run_before_send_callbacks)
     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) }
+      ->(event, _hint) { event if active_sentry_environments.include?(sentry_environment) }
     end
 
     def ignore_excluded_exceptions_in_data_sync
-      lambda { |error_or_event|
+      lambda { |event, hint|
         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 = Sentry::Utils::ExceptionCauseChain.exception_to_array(hint[:exception])
           exception_chain.any? { |exception| exception.is_a?(exception_to_ignore) }
         rescue NameError
           # the exception type represented by the exception_to_ignore string
@@ -48,8 +42,29 @@ module GovukError
           false
         end
 
-        !(data_sync.in_progress? && data_sync_ignored_error)
+        event unless data_sync.in_progress? && data_sync_ignored_error
       }
     end
+
+    def increment_govuk_statsd_counters
+      lambda { |event, hint|
+        if hint[:exception]
+          GovukStatsd.increment("errors_occurred")
+          GovukStatsd.increment("error_types.#{hint[:exception].class.name.split('::').last.underscore}")
+        end
+        event
+      }
+    end
+
+    def run_before_send_callbacks
+      lambda do |event, hint|
+        result = event
+        @before_send_callbacks.each do |callback|
+          result = callback.call(event, hint)
+          break if result.nil?
+        end
+        result
+      end
+    end
   end
 end

data/lib/govuk_app_config/govuk_error/configure.rb

@@ -1,12 +1,4 @@
 GovukError.configure do |config|
-  config.before_send = proc { |e|
-    GovukStatsd.increment("errors_occurred")
-    GovukStatsd.increment("error_types.#{e.class.name.demodulize.underscore}")
-    e
-  }
-
-  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
@@ -64,7 +56,7 @@ GovukError.configure do |config|
     "GdsApi::ContentStore::ItemNotFound",
   ]
 
-  config.transport_failure_callback = proc {
-    GovukStatsd.increment("error_reports_failed")
+  config.before_send = lambda { |error_or_event, _hint|
+    error_or_event
   }
 end

data/lib/govuk_app_config/govuk_error/govuk_data_sync.rb

@@ -3,14 +3,8 @@ 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')."
+        super("\"#{invalid_value}\" is not a valid value (should be of form '22:00-03:00').")
       end
     end
 

data/lib/govuk_app_config/govuk_healthcheck.rb

@@ -4,19 +4,16 @@ require "govuk_app_config/govuk_healthcheck/mongoid"
 require "govuk_app_config/govuk_healthcheck/rails_cache"
 require "govuk_app_config/govuk_healthcheck/redis"
 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_retry_size_check"
 require "json"
 
 module GovukHealthcheck
   def self.rack_response(*checks)
     proc do
+      checkup = healthcheck(checks)
       [
-        200,
+        checkup[:status] == :ok ? 200 : 500,
         { "Content-Type" => "application/json" },
-        [JSON.dump(healthcheck(checks))],
+        [JSON.dump(checkup)],
       ]
     end
   end

data/lib/govuk_app_config/version.rb

@@ -1,3 +1,3 @@
 module GovukAppConfig
-  VERSION = "2.10.0".freeze
+  VERSION = "4.0.0.pre.2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 2.10.0
+  version: 4.0.0.pre.2
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-25 00:00:00.000000000 Z
+date: 2021-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstasher
@@ -31,19 +31,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.2.0
 - !ruby/object:Gem::Dependency
-  name: sentry-raven
+  name: sentry-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.1
+        version: 4.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.1
+        version: 4.5.0
 - !ruby/object:Gem::Dependency
   name: statsd-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -211,6 +211,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -237,11 +238,7 @@ files:
 - lib/govuk_app_config/govuk_healthcheck/mongoid.rb
 - lib/govuk_app_config/govuk_healthcheck/rails_cache.rb
 - lib/govuk_app_config/govuk_healthcheck/redis.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_redis.rb
-- lib/govuk_app_config/govuk_healthcheck/sidekiq_retry_size_check.rb
-- lib/govuk_app_config/govuk_healthcheck/threshold_check.rb
 - lib/govuk_app_config/govuk_i18n.rb
 - lib/govuk_app_config/govuk_logging.rb
 - lib/govuk_app_config/govuk_statsd.rb
@@ -261,14 +258,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Base configuration for GOV.UK applications

data/lib/govuk_app_config/govuk_healthcheck/sidekiq_queue_check.rb

@@ -1,62 +0,0 @@
-module GovukHealthcheck
-  class SidekiqQueueCheck
-    def status
-      queues.each do |name, value|
-        if value >= critical_threshold(queue: name)
-          return :critical
-        elsif value >= warning_threshold(queue: name)
-          return :warning
-        end
-      end
-
-      :ok
-    end
-
-    def message
-      messages = queues.map do |name, value|
-        critical = critical_threshold(queue: name)
-        warning = warning_threshold(queue: name)
-
-        if value >= critical
-          "#{name} (#{value}) is above the critical threshold (#{critical})"
-        elsif value >= warning
-          "#{name} (#{value}) is above the warning threshold (#{warning})"
-        end
-      end
-
-      messages = messages.compact
-
-      if messages.empty?
-        "all queues are below the critical and warning thresholds"
-      else
-        messages.join("\n")
-      end
-    end
-
-    def details
-      {
-        queues: queues.each_with_object({}) do |(name, value), hash|
-          hash[name] = {
-            value: value,
-            thresholds: {
-              critical: critical_threshold(queue: name),
-              warning: warning_threshold(queue: name),
-            }.reject { |_, val| val.to_f.infinite? || val.to_f.nan? },
-          }
-        end,
-      }
-    end
-
-    def queues
-      raise "This method must be overriden to be a hash of queue names and data."
-    end
-
-    def critical_threshold(queue:) # rubocop:disable Lint/UnusedMethodArgument
-      raise "This method must be overriden to be the critical threshold."
-    end
-
-    def warning_threshold(queue:) # rubocop:disable Lint/UnusedMethodArgument
-      raise "This method must be overriden to be the warning threshold."
-    end
-  end
-end

data/lib/govuk_app_config/govuk_healthcheck/sidekiq_queue_latency_check.rb

@@ -1,13 +0,0 @@
-module GovukHealthcheck
-  class SidekiqQueueLatencyCheck < SidekiqQueueCheck
-    def name
-      :sidekiq_queue_latency
-    end
-
-    def queues
-      @queues ||= Sidekiq::Stats.new.queues.keys.each_with_object({}) do |name, hash|
-        hash[name] = Sidekiq::Queue.new(name).latency
-      end
-    end
-  end
-end

data/lib/govuk_app_config/govuk_healthcheck/sidekiq_retry_size_check.rb

@@ -1,11 +0,0 @@
-module GovukHealthcheck
-  class SidekiqRetrySizeCheck < ThresholdCheck
-    def name
-      :sidekiq_retry_size
-    end
-
-    def value
-      Sidekiq::Stats.new.retry_size
-    end
-  end
-end

data/lib/govuk_app_config/govuk_healthcheck/threshold_check.rb

@@ -1,50 +0,0 @@
-module GovukHealthcheck
-  class ThresholdCheck
-    def status
-      if value >= critical_threshold
-        :critical
-      elsif value >= warning_threshold
-        :warning
-      else
-        :ok
-      end
-    end
-
-    def message
-      if value >= critical_threshold
-        "#{value} is above the critical threshold (#{critical_threshold})"
-      elsif value >= warning_threshold
-        "#{value} is above the warning threshold (#{warning_threshold})"
-      else
-        "#{value} is below the critical and warning thresholds"
-      end
-    end
-
-    def details
-      {
-        value: value,
-        total: total,
-        thresholds: {
-          critical: critical_threshold,
-          warning: warning_threshold,
-        },
-      }
-    end
-
-    def value
-      raise "This method must be overridden to be the check value."
-    end
-
-    def total
-      nil # This method can be overriden to provide the total for the check.
-    end
-
-    def critical_threshold
-      raise "This method must be overriden to be the critical threshold."
-    end
-
-    def warning_threshold
-      raise "This method must be overriden to be the warning threshold."
-    end
-  end
-end