govuk_app_config 4.5.0 → 4.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9adf3a7bee21ade140141a007885695bba39c0f968216960f0b7736cdc995ab4
-  data.tar.gz: 9d32f18cdd2517bd50456b2d5824ecfb01f1ba5de9752c5d7b43f42b3341f2df
+  metadata.gz: 0f3849d5bf53877e6244bcda92162ec86e9a37c5788a491e1f436af79da3433e
+  data.tar.gz: 8d198f89774cf5962ae877e5437bff4025123c102645ac7d4a2b81b2525ef0c3
 SHA512:
-  metadata.gz: 8a4d51406523a7c93a59c49cf6ebb65af9e1659c3188ac2772f8a664a332be9c5608af669a48b23fb33d5e780d4a548a8e5b75fd3b82a8a79ff69661c76f485e
-  data.tar.gz: 1e70b03b2026eba3e77ea20d570edbc9728140d88b6e0448f9290c762c2cb8fbf7b28bbcc1efce39e168244ac6e703aed843652aa4ca47acb85265205b09a785
+  metadata.gz: e5c4e6173b2c7b41ff37430b603bb1d04dcc108fd24c4b374f2d4731512ce780fb1dd43d7bdd13a0bdc4e0948be48f4a6a6913cabb337ff1afe5a3110213d650
+  data.tar.gz: 3a810d79466ce2780c3e19b77da1edaf3a98546cc0ddbb28f6e10deb20558bc8a2eac44e1777af90be739138059176401535d75ff1bb918362e855fccb7ce1ca

data/.ruby-version

@@ -1 +1 @@
-2.7.5
+2.7.6

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# 4.6.2
+
+- Adds a new domain to the security policy for GA ([#248](https://https://github.com/alphagov/govuk_app_config/pull/248))
+
+# 4.6.1
+
+- Fixes warning message to refer to correct Sidekiq gem dependency name ([#243](https://github.com/alphagov/govuk_app_config/pull/243)).
+
+# 4.6.0
+
+- Add a warning for apps using GovukError with Sidekiq that don't have sentry-sidekiq installed ([#241](https://github.com/alphagov/govuk_app_config/pull/241)).
+- Add internal Sidekiq exception "Sidekiq::JobRetry::Skip" to excluded exceptions ([#241](https://github.com/alphagov/govuk_app_config/pull/241)).
+
 # 4.5.0
 
 - Add lux.speedcurve.com to connect_src for GOV.UK Content Security Policy ([#232](https://github.com/alphagov/govuk_app_config/pull/232))

data/docs/healthchecks.md

@@ -1,47 +1,6 @@
 # Health Checks
 
-## Check interface
-
-A check is expected to be a class with the following methods:
-
-```ruby
-class CustomCheck
-  def name
-    :the_name_of_the_check
-  end
-
-  def status
-    if critical_condition?
-      :critical
-    elsif warning_condition?
-      :warning
-    else
-      :ok
-    end
-  end
-
-  # Optional
-  def message
-    "This is an optional custom message that will show up in the alert in Icinga"
-  end
-
-  # Optional
-  def details
-    {
-      extra: "This is an optional details hash",
-    }
-  end
-
-  # Optional
-  def enabled?
-    true # false if the check is not relevant at this time
-  end
-end
-```
-
-It is expected that these methods may cache their results for performance
-reasons, if a user wants to ensure they have the latest value they should
-create a new instance of the check first.
+GOV.UK apps often have special `/healthcheck` routes, which give an indication of whether the app is running and able to respond to requests. [Read about how health checks are used](https://docs.publishing.service.gov.uk/manual/alerts/app-healthcheck-not-ok.html).
 
 ## Including checks in your app
 
@@ -51,7 +10,7 @@ or custom checks you wish to perform.
 For Rails apps:
 
 ```ruby
-get "/healthcheck", to: GovukHealthcheck.rack_response(
+get "/healthcheck/ready", to: GovukHealthcheck.rack_response(
   GovukHealthcheck::SidekiqRedis,
   GovukHealthcheck::ActiveRecord,
   CustomCheck,
@@ -61,95 +20,64 @@ get "/healthcheck", to: GovukHealthcheck.rack_response(
 It also accepts objects, so classes can be initialized:
 
 ```ruby
-get "/healthcheck", to: GovukHealthcheck.rack_response(
+get "/healthcheck/ready", to: GovukHealthcheck.rack_response(
   InitializedCheck.new(:param),
 )
 ```
 
-## Built-in Checks
-
-A convention used when naming these classes is that it should end with `Check`
-if it must be subclassed to work, but a concrete class which works on its own
-doesn't need that suffix. You should aim to follow this convention in your own
-apps, ideally putting custom health checks into a `Healthcheck` module.
-
-### `RailsCache`
+Built-in checks you can use include:
 
-This checks that the Rails cache store, such as Memcached, is acessible by
-writing and reading back a cache entry called "healthcheck-cache".
+- `GovukHealthcheck::RailsCache` - checks that the Rails cache store, such as Memcached, is acessible by writing and reading back a cache entry called "healthcheck-cache".
 
-### `Mongoid`
+- `GovukHealthcheck::Redis` - checks that the app can connect to Redis by writing and reading back a cache entry called "healthcheck-cache".
 
-This checks that the app has a connection to its Mongo database via Mongoid.
+- `GovukHealthcheck::Mongoid` - checks that the app has a connection to its Mongo database via Mongoid.
 
-### `SidekiqRedis`
+- `GovukHealthcheck::SidekiqRedis` - checks that the app has a connection to Redis via Sidekiq.
 
-This checks that the app has a connection to Redis via Sidekiq.
+- `GovukHealthcheck::ActiveRecord` - checks that the app has a connection to the database via ActiveRecord.
 
-### `ActiveRecord`
+## Writing a custom healthcheck
 
-This checks that the app has a connection to the database via ActiveRecord.
-
-### `ThresholdCheck`
-
-This class is the basis for a check which compares a value with a warning or a
-critical threshold.
+A check is expected to be a class with the following methods:
 
 ```ruby
-class MyThresholdCheck < GovukHealthcheck::ThresholdCheck
+class CustomCheck
   def name
-    :my_threshold_check
-  end
-
-  def value
-    # get the value to be checked
-  end
-
-  def total
-    # (optional) get the total value to be included in the details as extra
-    # information
+    :the_name_of_the_check
   end
 
-  def warning_threshold
-    # if the value is above this threshold, its status is warning
+  def status
+    if critical_condition?
+      :critical
+    elsif warning_condition?
+      :warning
+    else
+      :ok
+    end
   end
 
-  def critical_threshold
-    # if the value is above this threshold, its status is critical
+  # Optional
+  def message
+    "This is an optional custom message that will show up in the alert in Icinga"
   end
-end
-```
 
-### `SidekiqQueueLatencyCheck`
-
-This class is the basis for a check which compares the Sidekiq queue latencies
-with warning or critical thresholds.
-
-```ruby
-class MySidekiqQueueLatencyCheck < GovukHealthcheck::SidekiqQueueLatencyCheck
-  def warning_threshold(queue:)
-    # the warning threshold for a particular queue
+  # Optional
+  def details
+    {
+      extra: "This is an optional details hash",
+    }
   end
 
-  def critical_threshold(queue:)
-    # the critical threshold for a particular queue
+  # Optional
+  def enabled?
+    true # false if the check is not relevant at this time
   end
 end
 ```
 
-### `SidekiqRetrySizeCheck`
-
-Similar to `SidekiqQueueSizeCheck`, this class is the basis for a check which
-compares the Sidekiq retry set size with a warning and critical threshold.
-
-```ruby
-class MySidekiqRetrySizeCheck < GovukHealthcheck::SidekiqRetrySizeCheck
-  def warning_threshold
-    # the warning threshold for the retry set
-  end
+It is expected that these methods may cache their results for performance
+reasons, if a user wants to ensure they have the latest value they should
+create a new instance of the check first.
 
-  def critical_threshold
-    # the critical threshold for the retry set
-  end
-end
-```
+Put custom health checks for your app into a `Healtcheck` module. Each custom check class should end with `Check`.

data/govuk_app_config.gemspec

@@ -23,8 +23,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "logstasher", "~> 2.1"
   spec.add_dependency "prometheus_exporter", "~> 2.0"
   spec.add_dependency "puma", "~> 5.6"
-  spec.add_dependency "sentry-rails", "~> 5.2"
-  spec.add_dependency "sentry-ruby", "~> 5.2"
+  spec.add_dependency "sentry-rails", "~> 5.3"
+  spec.add_dependency "sentry-ruby", "~> 5.3"
   spec.add_dependency "statsd-ruby", "~> 1.5"
   spec.add_dependency "unicorn", "~> 6.1"
 
@@ -35,6 +35,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.10"
   spec.add_development_dependency "rspec-its", "~> 1.3"
-  spec.add_development_dependency "rubocop-govuk", "4.3.0"
+  spec.add_development_dependency "rubocop-govuk", "4.4.0"
   spec.add_development_dependency "webmock"
 end

data/lib/govuk_app_config/govuk_content_security_policy.rb

@@ -18,7 +18,8 @@ module GovukContentSecurityPolicy
   GOOGLE_ANALYTICS_DOMAINS = %w[www.google-analytics.com
                                 ssl.google-analytics.com
                                 stats.g.doubleclick.net
-                                www.googletagmanager.com].freeze
+                                www.googletagmanager.com
+                                www.region1.google-analytics.com].freeze
 
   GOOGLE_STATIC_DOMAINS = %w[www.gstatic.com].freeze
 

data/lib/govuk_app_config/govuk_error/configuration.rb

@@ -53,6 +53,7 @@ module GovukError
         "Mongoid::Errors::DocumentNotFound",
         "Sinatra::NotFound",
         "Slimmer::IntermittentRetrievalError",
+        "Sidekiq::JobRetry::Skip",
       ]
 
       # This will exclude exceptions that are triggered by one of the ignored

data/lib/govuk_app_config/govuk_error.rb

@@ -34,6 +34,10 @@ module GovukError
   def self.configure
     raise GovukError::AlreadyInitialised if is_configured?
 
+    if defined?(Sidekiq) && !defined?(Sentry::Sidekiq)
+      warn "Warning: GovukError is not configured to track Sidekiq errors, install the sentry-sidekiq gem to track them."
+    end
+
     Sentry.init do |sentry_config|
       config = Configuration.new(sentry_config)
       yield config if block_given?

data/lib/govuk_app_config/version.rb

@@ -1,3 +1,3 @@
 module GovukAppConfig
-  VERSION = "4.5.0".freeze
+  VERSION = "4.6.2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 4.5.0
+  version: 4.6.2
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-08 00:00:00.000000000 Z
+date: 2022-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstasher
@@ -58,28 +58,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.3'
 - !ruby/object:Gem::Dependency
   name: sentry-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.3'
 - !ruby/object:Gem::Dependency
   name: statsd-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -212,14 +212,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.3.0
+        version: 4.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.3.0
+        version: 4.4.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -296,7 +296,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.11
+rubygems_version: 3.3.16
 signing_key: 
 specification_version: 4
 summary: Base configuration for GOV.UK applications