Extract more into engine, and simplify downstream app

lewispb · lewispb · commit bcd262bfcbf5 · 2026-01-19T11:14:58.000Z
diff --git a/README.md b/README.md
@@ -42,11 +42,13 @@ The `upright:install` generator creates:
 - `config/initializers/0_url_options.rb` - Subdomain routing configuration
 - `config/initializers/upright.rb` - Engine configuration
 - `config/sites.yml` - Site/location definitions
-- `config/probes/http_probes.yml` - HTTP probe definitions
-- `config/probes/smtp_probes.yml` - SMTP probe definitions
 - `config/prometheus/prometheus.yml` - Prometheus configuration
 - `config/alertmanager/alertmanager.yml` - AlertManager configuration
 - `config/otel_collector.yml` - OpenTelemetry Collector configuration
+- `probes/` - Directory for all probe files
+- `probes/authenticators/` - Directory for authenticator classes
+- `probes/http_probes.yml` - HTTP probe definitions
+- `probes/smtp_probes.yml` - SMTP probe definitions
 
 It also mounts the engine at `/` in your routes.
 
@@ -181,7 +183,7 @@ end
 
 ### HTTP Probes
 
-Add probes to `config/probes/http_probes.yml`:
+Add probes to `probes/http_probes.yml`:
 
 ```yaml
 - name: Main Website
@@ -199,7 +201,7 @@ Add probes to `config/probes/http_probes.yml`:
 
 ### SMTP Probes
 
-Add probes to `config/probes/smtp_probes.yml`:
+Add probes to `probes/smtp_probes.yml`:
 
 ```yaml
 - name: Primary Mail Server
@@ -220,7 +222,7 @@ bin/rails generate upright:playwright_probe MyServiceAuth
 This creates a probe class:
 
 ```ruby
-# app/models/probes/playwright/my_service_auth_probe.rb
+# probes/my_service_auth_probe.rb
 class Probes::Playwright::MyServiceAuthProbe < Upright::Probes::Playwright::Base
   # Optionally authenticate before running
   # authenticate_with_form :my_service
@@ -239,20 +241,17 @@ end
 For probes that require authentication, create an authenticator:
 
 ```ruby
-# app/models/playwright/authenticator/my_service.rb
+# probes/authenticators/my_service.rb
 class Playwright::Authenticator::MyService < Upright::Playwright::Authenticator::Base
+  def signin_redirect_url = "https://app.example.com/dashboard"
+  def signin_path = "/login"
+  def service_name = :my_service
+
   def authenticate
     page.goto("https://app.example.com/login")
-    page.fill('[name="email"]', credentials[:email])
-    page.fill('[name="password"]', credentials[:password])
-    page.click('button[type="submit"]')
-    page.wait_for_url("**/dashboard**")
-  end
-
-  private
-
-  def credentials
-    Rails.application.credentials.my_service
+    page.get_by_label("Email").fill(credentials.my_service.email)
+    page.get_by_label("Password").fill(credentials.my_service.password)
+    page.get_by_role("button", name: "Sign in").click
   end
 end
 ```
diff --git a/app/models/concerns/upright/probe_yaml_source.rb b/app/models/concerns/upright/probe_yaml_source.rb
@@ -0,0 +1,10 @@
+module Upright::ProbeYamlSource
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def file_path
+      filename = name.demodulize.underscore.pluralize
+      Upright.configuration.probes_path.join("#{filename}.yml").to_s
+    end
+  end
+end
diff --git a/app/models/upright/probes/http_probe.rb b/app/models/upright/probes/http_probe.rb
@@ -1,12 +1,11 @@
 class Upright::Probes::HTTPProbe < FrozenRecord::Base
   include Upright::Probeable
+  include Upright::ProbeYamlSource
 
   stagger_by_site 3.seconds
 
   DEFAULT_EXPECTED_STATUS = 200..399
 
-  self.backend = FrozenRecord::Backends::Yaml
-
   attr_accessor :last_response
 
   def check
diff --git a/app/models/upright/probes/smtp_probe.rb b/app/models/upright/probes/smtp_probe.rb
@@ -2,11 +2,10 @@
 
 class Upright::Probes::SMTPProbe < FrozenRecord::Base
   include Upright::Probeable
+  include Upright::ProbeYamlSource
 
   stagger_by_site 3.seconds
 
-  self.backend = FrozenRecord::Backends::Yaml
-
   attr_accessor :smtp_log
 
   def check
diff --git a/app/models/upright/probes/traceroute_probe.rb b/app/models/upright/probes/traceroute_probe.rb
@@ -1,11 +1,10 @@
 class Upright::Probes::TracerouteProbe < FrozenRecord::Base
   include Upright::Probeable
+  include Upright::ProbeYamlSource
   include Upright::Traceroute::OtelTracing
 
   stagger_by_site 3.seconds
 
-  # Probes are loaded from config/upright/probes/traceroute_probes.yml
-
   TIMEOUT = 60.seconds
   MAX_HOPS = Upright::Traceroute::Result::MAX_HOPS
   PROBE_COUNT = Upright::Traceroute::Result::PROBE_COUNT
diff --git a/lib/generators/upright/install/install_generator.rb b/lib/generators/upright/install/install_generator.rb
@@ -18,9 +18,10 @@ def copy_sites_config
       end
 
       def create_probe_directories
-        empty_directory "config/probes"
-        template "http_probes.yml", "config/probes/http_probes.yml"
-        template "smtp_probes.yml", "config/probes/smtp_probes.yml"
+        empty_directory "probes"
+        empty_directory "probes/authenticators"
+        template "http_probes.yml", "probes/http_probes.yml"
+        template "smtp_probes.yml", "probes/smtp_probes.yml"
       end
 
       def copy_observability_configs
diff --git a/lib/generators/upright/install/templates/upright.rb b/lib/generators/upright/install/templates/upright.rb
@@ -16,9 +16,6 @@
   # Site configuration file path
   config.sites_config_path = Rails.root.join("config/sites.yml")
 
-  # Probe definitions path (for FrozenRecord)
-  config.frozen_record_path = Rails.root.join("config/probes")
-
   # Playwright browser server URL (production only)
   # config.playwright_server_url = ENV["PLAYWRIGHT_SERVER_URL"]
 
diff --git a/lib/generators/upright/playwright_probe/playwright_probe_generator.rb b/lib/generators/upright/playwright_probe/playwright_probe_generator.rb
@@ -7,12 +7,12 @@ class PlaywrightProbeGenerator < Rails::Generators::NamedBase
         desc: "Generate an authenticator class for this probe"
 
       def create_probe_file
-        template "probe.rb.tt", File.join("app/models/probes/playwright", "#{file_name}_probe.rb")
+        template "probe.rb.tt", File.join("probes", "#{file_name}_probe.rb")
       end
 
       def create_authenticator_file
         if options[:with_authenticator]
-          template "authenticator.rb.tt", File.join("app/models/playwright/authenticator", "#{file_name}.rb")
+          template "authenticator.rb.tt", File.join("probes/authenticators", "#{file_name}.rb")
         end
       end
 
diff --git a/lib/generators/upright/playwright_probe/templates/authenticator.rb.tt b/lib/generators/upright/playwright_probe/templates/authenticator.rb.tt
@@ -1,17 +1,14 @@
 class Playwright::Authenticator::<%= class_name %> < Upright::Playwright::Authenticator::Base
+  def signin_redirect_url = "https://example.com/dashboard"
+  def signin_path = "/login"
+  def service_name = :<%= file_name %>
+
   def authenticate
     # Your authentication logic here
     # page.goto("https://example.com/login")
-    # page.fill('[name="email"]', credentials[:email])
-    # page.fill('[name="password"]', credentials[:password])
-    # page.click('button[type="submit"]')
-    # page.wait_for_url("**/dashboard**")
+    # page.get_by_label("Email").fill(credentials.<%= file_name %>.email)
+    # page.get_by_label("Password").fill(credentials.<%= file_name %>.password)
+    # page.get_by_role("button", name: "Sign in").click
     raise NotImplementedError, "Implement the authenticate method for <%= class_name %>"
   end
-
-  private
-
-  def credentials
-    Rails.application.credentials.<%= file_name %>
-  end
 end
diff --git a/lib/upright/configuration.rb b/lib/upright/configuration.rb
@@ -16,6 +16,10 @@ class Upright::Configuration
   attr_accessor :storage_state_dir
   attr_accessor :frozen_record_path
 
+  # Probe and authenticator paths (for auto-loading app-specific code)
+  attr_writer :probes_path
+  attr_writer :authenticators_path
+
   # Playwright
   attr_accessor :playwright_server_url
 
@@ -42,6 +46,8 @@ def initialize
     @storage_state_dir = nil
     @frozen_record_path = nil
     @sites_config_path = nil
+    @probes_path = nil
+    @authenticators_path = nil
 
     @playwright_server_url = ENV["PLAYWRIGHT_SERVER_URL"]
     @otel_endpoint = ENV["OTEL_EXPORTER_OTLP_ENDPOINT"]
@@ -113,6 +119,14 @@ def sites_config_path
     @sites_config_path || Rails.root.join("config/sites.yml")
   end
 
+  def probes_path
+    @probes_path || Rails.root.join("probes")
+  end
+
+  def authenticators_path
+    @authenticators_path || Rails.root.join("probes/authenticators")
+  end
+
   private
     def default_storage_path(subdir)
       if defined?(Rails) && Rails.root
diff --git a/lib/upright/engine.rb b/lib/upright/engine.rb
@@ -4,6 +4,22 @@ class Upright::Engine < ::Rails::Engine
   # Add concerns to autoload paths
   config.autoload_paths << root.join("app/models/concerns")
 
+  # Session store configuration
+  initializer "upright.session_store", before: :load_config_initializers do |app|
+    app.config.session_store :cookie_store,
+      key: "_upright_session",
+      domain: :all,
+      same_site: :lax,
+      secure: Rails.env.production?
+  end
+
+  # Filter sensitive parameters from logs
+  initializer "upright.filter_parameters", before: :load_config_initializers do |app|
+    app.config.filter_parameters += [
+      :passw, :email, :secret, :token, :_key, :crypt, :salt, :certificate, :otp, :ssn
+    ]
+  end
+
   # Configure Solid Queue as the job backend
   initializer "upright.solid_queue", before: :set_configs_for_current_railties do |app|
     app.config.active_job.queue_adapter = :solid_queue
@@ -56,11 +72,63 @@ class Upright::Engine < ::Rails::Engine
     Upright::Tracing.configure
   end
 
+  # Start metrics server when Solid Queue runs standalone (not embedded in Puma)
+  initializer "upright.solid_queue_metrics" do
+    SolidQueue.on_start do
+      unless ENV["SOLID_QUEUE_IN_PUMA"]
+        ENV["PROMETHEUS_EXPORTER_PORT"] ||= "9394"
+        ENV["PROMETHEUS_EXPORTER_LOG_REQUESTS"] = "false"
+        Yabeda::Prometheus::Exporter.start_metrics_server!
+      end
+    end
+  end
+
+  # Add Duration#in_ms helper for Playwright timeouts
+  initializer "upright.duration_extension" do
+    ActiveSupport::Duration.class_eval do
+      def in_ms
+        (to_f * 1000).to_i
+      end
+    end
+  end
+
+  # Silence Ethon's verbose debug output to stdout
+  # By default, Ethon's debug callback prints curl verbose messages which pollutes logs
+  initializer "upright.ethon" do
+    Ethon::Easy::Callbacks.module_eval do
+      def debug_callback
+        @debug_callback ||= proc { |handle, type, data, size, udata|
+          message = data.read_string(size)
+          @debug_info.add(type, message)
+          0
+        }
+      end
+    end
+  end
+
   # Allow host app to override views
   config.to_prepare do
     Upright::ApplicationController.helper Rails.application.helpers if defined?(Rails.application)
   end
 
+  # Auto-load Playwright probes and authenticators from configured paths
+  # This runs after eager loading so engine classes are available
+  config.after_initialize do
+    # Define namespaces for app-specific probes and authenticators
+    Object.const_set(:Probes, Module.new { const_set(:Playwright, Module.new) }) unless defined?(::Probes)
+    Object.const_set(:Playwright, Module.new { const_set(:Authenticator, Module.new) }) unless defined?(::Playwright)
+
+    probes_path = Upright.configuration.probes_path
+    if probes_path && Dir.exist?(probes_path)
+      Dir[probes_path.join("*_probe.rb")].sort.each { |file| require file }
+    end
+
+    authenticators_path = Upright.configuration.authenticators_path
+    if authenticators_path && Dir.exist?(authenticators_path)
+      Dir[authenticators_path.join("*.rb")].sort.each { |file| require file }
+    end
+  end
+
   # Add engine migrations to host app
   initializer "upright.migrations" do |app|
     unless app.root.to_s == root.join("test/dummy").to_s
