usps-support 0.2.44 → 0.2.46

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b04ede6eeee252cd53b27f9d9938019e9f2a81d467ca077bab1b17087fce0bc6
-  data.tar.gz: aef62058741366eee1794b4ebdee5031f91ec78ee46ef60df3e277ab7ddb04aa
+  metadata.gz: a1508e9abf6ef884c05e7201b52f3c328a81be47388319938e5a4b3ef8aa5e5a
+  data.tar.gz: '08de17c41c0489f4f0a6994a73ca193a25c8b1917ebc652c6788d6d6c69c72d2'
 SHA512:
-  metadata.gz: 191a90199bdcf0509844d3e12f158e1cad908b1c8c8ad97167bc1d6c464e3ae9bc8984a094306274bcbf806bc815a8385ce849524d1bb372557d592e00f57e07
-  data.tar.gz: 5660fd1df623ce3988efdc5c607743095100d7a18e3815ca233bf57bf0313f2a39b728d8b308dac69c8838457f626449f631cafcb6dc4369bdf64f95d49025b8
+  metadata.gz: 54e24451d92bed2cfb93bda006c78d2d311f9e3e5a1a283cebc7f66e3908c4c5977b81a87ce265a1389e16ef6b8759759ca0e7ac5f304ff35a682bb29e2d9a12
+  data.tar.gz: cd741d2ff564082916e9782408762d8117b17d45afae4e8d90e3ddb442c0d1e79e84b3e5beb492387d7f971b5ee15f7db679a9c8e2d2c6753eecfc5adc87ea55

data/app/controllers/usps/support/health_controller.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require 'net/http'
+
+module Usps::Support
+  # Base controller for external synthetic health probes (see the infrastructure repo's
+  # doc/application_health_probes.md). Unlike Rails' /up (boot-only) and nginx's static
+  # /instance-health-check, this exercises an app's *critical dependencies* and returns the sentinel
+  # "HEALTHCHECK_OK <app>" only when every check passes — a Route 53 HTTPS_STR_MATCH probe asserts
+  # the "HEALTHCHECK_OK" prefix, so a quiet app-level failure flips the Statuspage component even
+  # with no organic traffic.
+  #
+  # Host apps subclass this and override #checks to pick which dependencies to probe, e.g.
+  #
+  #   class HealthController < Usps::Support::HealthController
+  #     private
+  #     def checks = { database: check_database, redis: check_redis }
+  #   end
+  #
+  # and route to it (`get 'health' => 'health#show'`). The check_* primitives below each return a
+  # boolean and never raise, so the action always responds. Apps run only the checks for the
+  # dependencies they actually configure — admin-console has no HQ connection, so it omits
+  # check_hq_database; an iMIS-backed app adds check_imis; a custom downstream is check_http(url).
+  #
+  # Inherits ActionController::Base directly — NOT the host's ApplicationController — to bypass
+  # Devise auth, Pundit authorization, PaperTrail, and especially `allow_browser`, whose
+  # modern-browser gate would 406 Route 53's non-browser prober and fail the probe for the wrong
+  # reason.
+  class HealthController < ActionController::Base # rubocop:disable Rails/ApplicationController
+    SENTINEL_PREFIX = 'HEALTHCHECK_OK'
+
+    def show
+      results = checks
+      healthy = results.values.all?
+
+      body = "#{healthy ? "#{SENTINEL_PREFIX} #{app_name}" : "HEALTHCHECK_FAIL #{app_name}"}\n"
+      results.each { |name, ok| body << "#{name}=#{ok ? 'ok' : 'fail'}\n" }
+
+      response.set_header('Cache-Control', 'no-store')
+      response.set_header('Retry-After', '30') unless healthy
+      render(plain: body, content_type: 'text/plain', status: healthy ? :ok : :service_unavailable)
+    end
+
+  private
+
+    # Dependencies to probe, as { label => boolean }.
+    #
+    # Override per app.
+    #
+    # Default is the primary database only, which presumably every app needs.
+    def checks = { database: check_database }
+
+    # Derives "admin-console" from the host application's module (e.g. AdminConsole), so the sentinel
+    # identifies which app answered without per-app configuration.
+    def app_name = Rails.application.class.module_parent_name.underscore.dasherize
+
+    # --- Check primitives. Each returns true/false and swallows its own errors, so a dead
+    # dependency reads as a failed check rather than a 500. ---
+
+    # Primary application database (RDS).
+    def check_database = check_connection(::ActiveRecord::Base)
+
+    # HQ database (using VHQAB), reached over the HQ VPN — a *different* host than RDS.
+    def check_hq_database = check_connection(Models::Hq::Members::BaseRecord)
+
+    # Redis / Sidekiq's configured connection pool.
+    def check_redis
+      ::Sidekiq.redis { it.call('PING') }
+      true
+    rescue StandardError
+      false
+    end
+
+    # iMIS API liveness — authenticating proves network + credentials + the token endpoint, against
+    # the environment-appropriate iMIS.
+    def check_imis
+      ::Usps::Imis::Api.new.auth_token
+      true
+    rescue StandardError
+      false
+    end
+
+    # Generic downstream HTTP liveness for a custom dependency.
+    def check_http(url)
+      ::Net::HTTP.get_response(URI(url)).is_a?(::Net::HTTPSuccess)
+    rescue StandardError
+      false
+    end
+
+    # Checks out a connection from the given model's pool and runs a trivial query — proves the
+    # connection is live, which a boot-time check skips.
+    def check_connection(model)
+      model.connection.execute('SELECT 1')
+      true
+    rescue StandardError
+      false
+    end
+  end
+end

data/lib/usps/all.rb

@@ -5,8 +5,5 @@ require 'usps/jwt_auth'
 require_relative 'support'
 
 # :nocov:
-if defined?(Rails)
-  require 'usps/support/railtie'
-  require 'usps/support/engine'
-end
+require 'usps/support/engine' if defined?(Rails)
 # :nocov:

data/lib/usps/support/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Support
-    VERSION = '0.2.44'
+    VERSION = '0.2.46'
   end
 end

data/lib/usps/support.rb

@@ -18,7 +18,7 @@ require_relative 'support/helpers'
 require_relative 'support/models'
 require_relative 'support/lib'
 
-# The Railtie and Engine requires live in `usps/all`, not here. This file can
+# The Engine require lives in `usps/all`, not here. This file can
 # legitimately be required before Rails is loaded (e.g. from .simplecov to pull
 # in Usps::Support::Lib helpers), and because Ruby caches loaded files, a
 # conditional `if defined?(Rails)` block here would be evaluated once with

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-support
 version: !ruby/object:Gem::Version
-  version: 0.2.44
+  version: 0.2.46
 platform: ruby
 authors:
 - Julian Fiander
@@ -73,14 +73,13 @@ files:
 - Readme.md
 - app/controllers/concerns/usps/support/admin_menu.rb
 - app/controllers/usps/support/admins_controller.rb
+- app/controllers/usps/support/health_controller.rb
 - app/models/usps/support/policy/admin_context.rb
 - config/routes.rb
 - db/hq/members_schema.rb
 - db/hq/websites_schema.rb
-- lib/tasks/db.rake
 - lib/usps/all.rb
 - lib/usps/support.rb
-- lib/usps/support/db/auxiliary_stamper.rb
 - lib/usps/support/db/members_schema.rb
 - lib/usps/support/db/websites_schema.rb
 - lib/usps/support/engine.rb
@@ -120,7 +119,6 @@ files:
 - lib/usps/support/models/hq/squadrons/squadron.rb
 - lib/usps/support/models/hq/squadrons/website.rb
 - lib/usps/support/models/toast.rb
-- lib/usps/support/railtie.rb
 - lib/usps/support/sidekiq_auth.rb
 - lib/usps/support/version.rb
 homepage: https://github.com/unitedstatespowersquadrons/usps-support

data/lib/tasks/db.rake

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require 'usps/support/db/auxiliary_stamper'
-
-namespace :db do
-  desc "Stamp auxiliary test databases with the primary database's schema_migrations rows"
-  task stamp_auxiliary_test_schemas: :environment do
-    Usps::Support::Db::AuxiliaryStamper.call
-  end
-end
-
-%w[db:schema:load db:migrate db:test:prepare].each do |task|
-  Rake::Task[task].enhance do
-    Rake::Task['db:stamp_auxiliary_test_schemas'].invoke if Rails.env.test?
-  end
-end

data/lib/usps/support/db/auxiliary_stamper.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module Usps
-  module Support
-    module Db
-      # Copies the primary test database's schema_migrations rows into each
-      # auxiliary test database, so Rails' pending-migration check doesn't see
-      # the primary's migrations as pending against schemas that don't run them.
-      #
-      module AuxiliaryStamper
-        class << self
-          def call(io: $stdout)
-            primary, auxiliary = test_configs
-            return if auxiliary.empty?
-
-            ActiveRecord::Base.connection_pool.with_connection do |connection|
-              primary_versions = fetch_versions(connection, primary.database)
-
-              auxiliary.each do |config|
-                existing = fetch_versions(connection, config.database)
-                (primary_versions - existing).each do |version|
-                  io.puts "Stamping #{version} for #{config.database}"
-                  connection.execute(
-                    "INSERT INTO #{config.database}.schema_migrations (version) VALUES (#{version.to_i})"
-                  )
-                end
-              end
-            end
-          end
-
-        private
-
-          def test_configs
-            configs = ActiveRecord::Base.configurations.configs_for(env_name: 'test')
-            primary = configs.find(&:primary?) || configs.first
-            [primary, configs - [primary]]
-          end
-
-          def fetch_versions(connection, database)
-            connection.execute("SELECT version FROM #{database}.schema_migrations").to_a.flatten
-          end
-        end
-      end
-    end
-  end
-end

data/lib/usps/support/railtie.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails'
-
-module Usps
-  module Support
-    # Expose rake tasks to Rails and ensure auxiliary test schemas stay in
-    # sync with the primary's schema_migrations before Rails runs its
-    # pending-migration check.
-    #
-    class Railtie < Rails::Railtie
-      railtie_name :usps_support
-
-      rake_tasks do
-        path = File.expand_path(__dir__)
-        Dir.glob("#{path}/../../tasks/**/*.rake").each { |f| load f }
-      end
-
-      initializer 'usps_support.stamp_auxiliary_test_schemas' do
-        next unless Rails.env.test?
-
-        require 'usps/support/db/auxiliary_stamper'
-
-        ActiveSupport.on_load(:active_record) do
-          ActiveRecord::Migration.singleton_class.prepend(
-            Module.new do
-              def maintain_test_schema!
-                Usps::Support::Db::AuxiliaryStamper.call(io: File.open(File::NULL, 'w'))
-                super
-              end
-            end
-          )
-        end
-      end
-    end
-  end
-end