govuk_app_config 2.9.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 106a5c63b04c2882b7715da357f9c2e6d69dd87c20f7ceccefdb8b1b7a27e0b7
-  data.tar.gz: 0035b7c017727795f9dcc2f99c883be9b0f8c0f77992ffd14f9373a16f890e31
+  metadata.gz: 20aaa15a96de29af59424ad9889d8020af8964c557089dc11c429ef38d67513c
+  data.tar.gz: 6e20e3346f6bf65927b4a4835f1c45f9da92c3daf2f261c6f9fc433f9620b8be
 SHA512:
-  metadata.gz: 7e80717eb6c207a69f25019806a2085c93ea595126d665314a54acc3679a4053db88a7062efb3b711b4368b5937dadc784af50532e3c9be30ab2310878842a44
-  data.tar.gz: 568071152636585876ece594c91884ebbce3d5a284ed4df8d9e268af05836e95872f7cc84e9f6ed73b672f61a6e20284274c7fe4fb45114728efc05a15b1ebba
+  metadata.gz: 47386015166932a21469cb73fd7be967293a61b244b72f1f1bc5fc8065131a2ffd805441a2813d3bbc182754624b78ee866cb2f3baa6ebcc954b3041076c8477
+  data.tar.gz: 77833ef66a28baf07a35cdb033f2fb44a2d259392b53b61cc5cf8e4e6df82ca15bdeeab96aecc309506f6b0ed4187be4be3dde3b00aed717056d5230e3a69387

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,6 +1,25 @@
+# 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))
+
+# 2.9.1
+
+* Fixes bug in GovukI18n introduced in the last version ([#189](https://github.com/alphagov/govuk_app_config/pull/189))
+
 # 2.9.0
 
-* Add GovukI18n module with custom plural rules ([##187](https://github.com/alphagov/govuk_app_config/pull/187))
+* Add GovukI18n module with custom plural rules ([#187](https://github.com/alphagov/govuk_app_config/pull/187))
 
 # 2.8.4
 

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 |error_or_event|
+    error_or_event == "do capture" ? error_or_event : nil
   end
 end
 ```

data/lib/govuk_app_config/govuk_content_security_policy.rb

@@ -32,7 +32,10 @@ module GovukContentSecurityPolicy
                    *GOVUK_DOMAINS,
                    *GOOGLE_ANALYTICS_DOMAINS, # Tracking pixels
                    # Some content still links to an old domain we used to use
-                   "assets.digital.cabinet-office.gov.uk"
+                   "assets.digital.cabinet-office.gov.uk",
+                   # Allow images to be loaded for Speedcurve's LUX - used for
+                   # getting real user metrics on GOV.UK
+                   "lux.speedcurve.com"
 
     # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/script-src
     policy.script_src :self,

data/lib/govuk_app_config/govuk_error/configuration.rb

@@ -12,32 +12,26 @@ module GovukError
       @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) }
+      ->(error_or_event, _hint) { error_or_event if active_sentry_environments.include?(sentry_environment) }
     end
 
     def ignore_excluded_exceptions_in_data_sync
-      lambda { |error_or_event|
+      lambda { |error_or_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)
@@ -48,8 +42,27 @@ module GovukError
           false
         end
 
-        !(data_sync.in_progress? && data_sync_ignored_error)
+        error_or_event unless data_sync.in_progress? && data_sync_ignored_error
+      }
+    end
+
+    def increment_govuk_statsd_counters
+      lambda { |error_or_event, _hint|
+        GovukStatsd.increment("errors_occurred")
+        GovukStatsd.increment("error_types.#{error_or_event.class.name.demodulize.underscore}")
+        error_or_event
       }
     end
+
+    def run_before_send_callbacks
+      lambda do |error_or_event, hint|
+        result = error_or_event
+        @before_send_callbacks.each do |callback|
+          result = callback.call(error_or_event, hint)
+          break if result.nil?
+        end
+        result
+      end
+    end
   end
 end

data/lib/govuk_app_config/govuk_error/configure.rb

@@ -1,10 +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`
@@ -64,6 +58,10 @@ GovukError.configure do |config|
     "GdsApi::ContentStore::ItemNotFound",
   ]
 
+  config.before_send = lambda { |error_or_event, _hint|
+    error_or_event
+  }
+
   config.transport_failure_callback = proc {
     GovukStatsd.increment("error_reports_failed")
   }

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

@@ -1,5 +1,5 @@
 module GovukI18n
-  def plurals
+  def self.plurals
     {
       # Dari - this isn't an iso code. Probably should be 'prs' as per ISO 639-3.
       dr: { i18n: { plural: { keys: %i[one other], rule: ->(n) { n == 1 ? :one : :other } } } },

data/lib/govuk_app_config/version.rb

@@ -1,3 +1,3 @@
 module GovukAppConfig
-  VERSION = "2.9.0".freeze
+  VERSION = "3.1.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 2.9.0
+  version: 3.1.1
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-18 00:00:00.000000000 Z
+date: 2021-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstasher
@@ -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

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