govuk_app_config 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ac8e47ae56fb42b44e9c976322ddad4e8684412320fc6938e82a4e076a253c2
-  data.tar.gz: 9cb6a01336c4d409c80af123fcdf4ef42086288b79ced7ae94ecad5b8a10cb86
+  metadata.gz: 209a3832e7995ecd4fae908416ca9656849489c3b2dd9f287c175029d3c2a683
+  data.tar.gz: 5c12231bddd44f7fff7dd32c6b21484bc1ff7fef9bb3b7d54bf3abcf266bb46b
 SHA512:
-  metadata.gz: edd4237e5e0b9f07f710d4cc32dfe3ffea1166fecb99b396d3f43cb4eaca8d71c50530414c1753f2369c089fd9e1f52a15dbc9159c9ffe45f4992f7bd035a9b3
-  data.tar.gz: f9693d072813e00999277e175cd90773278ac3625efa87de011e537fe0604d2642eeb3cf0044ef3b92a8dc25eebd15f0a697a1042f760483adc96f5fe72521da
+  metadata.gz: 820ef2c5342d0fc44d64d756bef5732789e65fefb0053b45ca961af214b523401348c2887cf46c93b43734a414b2a276eeb8916c79e85e1143e54dafd2710a61
+  data.tar.gz: 6fc2796951741d81cbe57712cd4de98d77976e046cecfbd68096b5f7726dbcadf1a6817f5afd557c6d80bee9f8cdaa6e4ad93aa7a628cb17b58a4414065b3877

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 1.6.0
+
+* Make health checks classes rather than instances, allowing internal data to
+  be cached and improve performance.
+
 # 1.5.1
 
 * Set the `Content-Type` of healthchecks to `application/json`.

data/README.md

@@ -110,25 +110,26 @@ GovukStatsd.time("account.activate") { @account.activate! }
 Set up a route in your rack-compatible Ruby application, and pick the built-in
 or custom checks you wish to perform.
 
-Custom checks must be any class or instance which implements
+Custom checks must be a class which implements
 [this interface](spec/lib/govuk_healthcheck/shared_interface.rb):
+
 ```ruby
-module CustomCheck
-  def self.name
+class CustomCheck
+  def name
     :custom_check
   end
 
-  def self.status
+  def status
     ThingChecker.everything_okay? ? OK : CRITICAL
   end
 
   # Optional
-  def self.message
+  def message
     "This is an optional custom message"
   end
 
   # Optional
-  def self.details
+  def details
     {
       extra: "This is an optional details hash",
     }
@@ -150,6 +151,9 @@ This will check:
 - Database connectivity (via ActiveRecord)
 - Your custom healthcheck
 
+Each check class gets instanced each time the health check end point is called.
+This allows you to cache any complex queries speeding up performance.
+
 ## Rails logging
 
 In Rails applications, the application will be configured to send JSON-formatted

data/govuk_app_config.gemspec

@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.6.0"
   spec.add_development_dependency "climate_control"
   spec.add_development_dependency "webmock"
+  spec.add_development_dependency "pry"
 end

data/lib/govuk_app_config/govuk_healthcheck/active_record.rb

@@ -1,10 +1,10 @@
 module GovukHealthcheck
-  module ActiveRecord
-    def self.name
+  class ActiveRecord
+    def name
       :database_connectivity
     end
 
-    def self.status
+    def status
       ::ActiveRecord::Base.connected? ? OK : CRITICAL
     end
   end

data/lib/govuk_app_config/govuk_healthcheck/checkup.rb

@@ -20,8 +20,10 @@ module GovukHealthcheck
 
   private
 
+    attr_reader :checks
+
     def component_statuses
-      @component_statuses ||= @checks.each_with_object({}) do |check, hash|
+      @component_statuses ||= checks.map(&:new).each_with_object({}) do |check, hash|
         hash[check.name] = build_component_status(check)
       end
     end

data/lib/govuk_app_config/govuk_healthcheck/sidekiq_redis.rb

@@ -1,10 +1,10 @@
 module GovukHealthcheck
-  module SidekiqRedis
-    def self.name
+  class SidekiqRedis
+    def name
       :redis_connectivity
     end
 
-    def self.status
+    def status
       Sidekiq.redis_info ? OK : CRITICAL
     end
   end

data/lib/govuk_app_config/version.rb

@@ -1,3 +1,3 @@
 module GovukAppConfig
-  VERSION = "1.5.1"
+  VERSION = "1.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-20 00:00:00.000000000 Z
+date: 2018-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: statsd-ruby
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Base configuration for GOV.UK applications
 email:
 - govuk-dev@digital.cabinet-office.gov.uk