findbug 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b51dae70712a19753e3c702d669ad052997bdbd92fdbb5a1906dfe7a4739eb3d
-  data.tar.gz: ece16e26f2e64f87262172768cb577a7d9344c85039992acc7809f372c146173
+  metadata.gz: ca9a3e20d87733caff1807d5b89935d349a316cddf15ee2e7565f3b861cafc10
+  data.tar.gz: d135aae0a004b454448d2688e04cf22f6121ed3d64b743baf7663466ef5894b0
 SHA512:
-  metadata.gz: 8637ab43bfd03606bceee3fc7eb955af65f2db8300b39b07848beed6106677efc82fb8bc3931c12368c525d502d7c708a5e006b31fdcc4f2816ba644a546f8df
-  data.tar.gz: 8a24d784569793cdbabe425af6ca3c7b1740e7b64a30ec2f59f059adfce927faccc52bdc40e3f9f6c5037136987c1ff9d7f9bba9b585f506da63ede93fa7b63a
+  metadata.gz: 00d61fb0d96254b5195951d9c55a0c459f896ad61b3f813ed1fbeb817856b186ee8ceac24d5d659934e3909cfaa9bb901f38cd3fc3bc68e8aa5df4d7e04c3627
+  data.tar.gz: 01c241d176885ea96d700623048bf1f7d8af8832057b722b6d23c8a079dedc61410322abb897313a4e7a3d937a0ce6197c248b6438197725ab6656333f1dc311

data/README.md

@@ -142,34 +142,11 @@ Findbug.configure do |config|
   # ===================
   # Alerts (Optional)
   # ===================
+  # Alert channels (Email, Slack, Discord, Webhook) are configured via the
+  # dashboard UI at /findbug/alerts — no code changes needed.
+
   config.alerts do |alerts|
     alerts.throttle_period = 5.minutes
-
-    # Slack
-    # alerts.slack(
-    #   enabled: true,
-    #   webhook_url: ENV["SLACK_WEBHOOK_URL"],
-    #   channel: "#errors"
-    # )
-
-    # Email
-    # alerts.email(
-    #   enabled: true,
-    #   recipients: ["team@example.com"]
-    # )
-
-    # Discord
-    # alerts.discord(
-    #   enabled: true,
-    #   webhook_url: ENV["DISCORD_WEBHOOK_URL"]
-    # )
-
-    # Custom Webhook
-    # alerts.webhook(
-    #   enabled: true,
-    #   url: "https://your-service.com/webhook",
-    #   headers: { "Authorization" => "Bearer token" }
-    # )
   end
 end
 ```
@@ -311,6 +288,7 @@ Apartment.configure do |config|
     # Your existing excluded models...
     Findbug::ErrorEvent
     Findbug::PerformanceEvent
+    Findbug::AlertChannel
   ]
 end
 ```

data/app/controllers/findbug/alerts_controller.rb

@@ -0,0 +1,224 @@
+# frozen_string_literal: true
+
+require "ostruct"
+
+module Findbug
+  # AlertsController manages alert channel configuration via the dashboard.
+  #
+  # Users can create, edit, enable/disable, delete, and test alert channels
+  # directly from the UI instead of editing the Rails initializer.
+  #
+  class AlertsController < ApplicationController
+    before_action :set_alert_channel, only: [:edit, :update, :destroy, :toggle, :test]
+
+    # GET /findbug/alerts
+    #
+    # List all configured alert channels.
+    #
+    def index
+      @channels = Findbug::AlertChannel.order(created_at: :asc)
+      @enabled_count = @channels.count(&:enabled?)
+
+      render template: "findbug/alerts/index", layout: "findbug/application"
+    end
+
+    # GET /findbug/alerts/new
+    #
+    # Form to create a new alert channel.
+    #
+    def new
+      @channel = Findbug::AlertChannel.new
+      render template: "findbug/alerts/new", layout: "findbug/application"
+    end
+
+    # POST /findbug/alerts
+    #
+    # Save a new alert channel.
+    #
+    def create
+      @channel = Findbug::AlertChannel.new(channel_params)
+      @channel.config = build_config_from_params
+
+      if @channel.save
+        flash_success "#{@channel.display_type} alert channel created"
+        redirect_to findbug.alerts_path
+      else
+        flash_error @channel.errors.full_messages.join(", ")
+        render template: "findbug/alerts/new", layout: "findbug/application", status: :unprocessable_entity
+      end
+    end
+
+    # GET /findbug/alerts/:id/edit
+    #
+    # Form to edit an existing alert channel.
+    #
+    def edit
+      render template: "findbug/alerts/edit", layout: "findbug/application"
+    end
+
+    # PATCH /findbug/alerts/:id
+    #
+    # Update an existing alert channel.
+    #
+    def update
+      @channel.assign_attributes(channel_params)
+      @channel.config = build_config_from_params
+
+      if @channel.save
+        flash_success "#{@channel.display_type} alert channel updated"
+        redirect_to findbug.alerts_path
+      else
+        flash_error @channel.errors.full_messages.join(", ")
+        render template: "findbug/alerts/edit", layout: "findbug/application", status: :unprocessable_entity
+      end
+    end
+
+    # DELETE /findbug/alerts/:id
+    #
+    # Delete an alert channel.
+    #
+    def destroy
+      name = @channel.name
+      @channel.destroy
+      flash_success "Alert channel \"#{name}\" deleted"
+      redirect_to findbug.alerts_path
+    end
+
+    # POST /findbug/alerts/:id/toggle
+    #
+    # Toggle enable/disable for an alert channel.
+    #
+    def toggle
+      @channel.enabled = !@channel.enabled?
+
+      if @channel.save
+        status = @channel.enabled? ? "enabled" : "disabled"
+        flash_success "#{@channel.name} #{status}"
+      else
+        flash_error @channel.errors.full_messages.join(", ")
+      end
+
+      redirect_to findbug.alerts_path
+    end
+
+    # POST /findbug/alerts/:id/test
+    #
+    # Send a test alert to this channel.
+    #
+    # Creates a synthetic error event (not persisted to DB) and sends it
+    # directly to the channel, bypassing throttling.
+    #
+    def test
+      unless @channel.enabled?
+        flash_error "Cannot test a disabled channel. Enable it first."
+        redirect_to findbug.alerts_path and return
+      end
+
+      error_event = build_test_error_event
+      channel_instance = @channel.channel_class.new(@channel.config.symbolize_keys)
+
+      begin
+        channel_instance.send_alert(error_event)
+        flash_success "Test alert sent to #{@channel.name} successfully!"
+      rescue StandardError => e
+        flash_error "Failed to send test alert: #{e.message}"
+      end
+
+      redirect_to findbug.alerts_path
+    end
+
+    private
+
+    def set_alert_channel
+      @channel = Findbug::AlertChannel.find(params[:id])
+    end
+
+    def channel_params
+      params.require(:alert_channel).permit(:name, :channel_type, :enabled)
+    end
+
+    # Build the config hash from channel-type-specific form params
+    #
+    # Each channel type has different fields. We extract them from
+    # params[:config] and build a clean hash.
+    #
+    def build_config_from_params
+      config_params = params[:config] || {}
+      channel_type = params.dig(:alert_channel, :channel_type) || @channel&.channel_type
+
+      case channel_type
+      when "email"
+        recipients = (config_params[:recipients] || "").split(/[\n,]/).map(&:strip).compact_blank
+        {
+          "recipients" => recipients,
+          "from" => config_params[:from].presence
+        }.compact
+      when "slack"
+        {
+          "webhook_url" => config_params[:webhook_url],
+          "channel" => config_params[:channel].presence,
+          "username" => config_params[:username].presence,
+          "icon_emoji" => config_params[:icon_emoji].presence
+        }.compact
+      when "discord"
+        {
+          "webhook_url" => config_params[:webhook_url],
+          "username" => config_params[:username].presence,
+          "avatar_url" => config_params[:avatar_url].presence
+        }.compact
+      when "webhook"
+        headers = parse_headers(config_params[:headers])
+        {
+          "url" => config_params[:url],
+          "method" => config_params[:method].presence || "POST",
+          "headers" => headers.presence
+        }.compact
+      else
+        {}
+      end
+    end
+
+    # Parse headers from textarea format ("Key: Value" per line) into a hash
+    def parse_headers(raw)
+      return {} if raw.blank?
+
+      raw.split("\n").each_with_object({}) do |line, hash|
+        key, value = line.split(":", 2).map(&:strip)
+        hash[key] = value if key.present? && value.present?
+      end
+    end
+
+    # Build a synthetic error event for testing alerts
+    #
+    # Uses OpenStruct to duck-type ErrorEvent without touching the database.
+    # Includes all attributes that channel implementations access.
+    #
+    def build_test_error_event
+      now = Time.current
+
+      OpenStruct.new(
+        id: 0,
+        fingerprint: "findbug-test-alert-#{now.to_i}",
+        exception_class: "Findbug::TestAlert",
+        message: "This is a test alert from the Findbug dashboard. If you see this, your alert channel is working correctly!",
+        severity: "error",
+        status: "unresolved",
+        handled: false,
+        occurrence_count: 1,
+        first_seen_at: now,
+        last_seen_at: now,
+        environment: Findbug.config.environment || "production",
+        release_version: Findbug::VERSION,
+        backtrace_lines: [
+          "app/controllers/findbug/alerts_controller.rb:42:in `test'",
+          "lib/findbug/alerts/dispatcher.rb:57:in `send_alerts'",
+          "lib/findbug/alerts/channels/base.rb:34:in `send_alert'"
+        ],
+        context: {},
+        user: nil,
+        request: { "method" => "POST", "path" => "/findbug/alerts/test" },
+        tags: { "source" => "test_alert" }
+      )
+    end
+  end
+end

data/app/models/findbug/alert_channel.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+require_relative "../../../lib/findbug/alerts/channels/base"
+require_relative "../../../lib/findbug/alerts/channels/email"
+require_relative "../../../lib/findbug/alerts/channels/slack"
+require_relative "../../../lib/findbug/alerts/channels/discord"
+require_relative "../../../lib/findbug/alerts/channels/webhook"
+
+module Findbug
+  # AlertChannel stores alert channel configurations in the database.
+  #
+  # DATABASE SCHEMA
+  # ===============
+  #
+  # This model expects a table created by the install generator:
+  #
+  #   create_table :findbug_alert_channels do |t|
+  #     t.string :channel_type, null: false
+  #     t.string :name, null: false
+  #     t.boolean :enabled, default: false
+  #     t.text :config_data
+  #     t.timestamps
+  #   end
+  #
+  # WHY DB INSTEAD OF INITIALIZER?
+  # ==============================
+  #
+  # Storing alert config in the database lets users create, edit, and
+  # manage alert channels from the dashboard UI without code changes
+  # or redeployment.
+  #
+  # WHY TEXT + SERIALIZE INSTEAD OF JSONB?
+  # ======================================
+  #
+  # ActiveRecord::Encryption works on text columns. We serialize the
+  # config hash as JSON and encrypt the entire blob at rest, so webhook
+  # URLs and tokens are never stored in plain text.
+  #
+  class AlertChannel < ActiveRecord::Base
+    self.table_name = "findbug_alert_channels"
+
+    # Channel types
+    CHANNEL_TYPES = %w[email slack discord webhook].freeze
+
+    # Check if Rails encryption is configured
+    def self.encryption_available?
+      return false unless defined?(ActiveRecord::Encryption)
+
+      ActiveRecord::Encryption.config.primary_key.present?
+    rescue StandardError
+      false
+    end
+
+    # Serialize config as JSON
+    serialize :config_data, coder: JSON
+
+    # Encrypt config at rest if Rails encryption is configured
+    encrypts :config_data if encryption_available?
+
+    # Validations
+    validates :name, presence: true
+    validates :channel_type, presence: true, inclusion: { in: CHANNEL_TYPES }
+    validate :validate_required_config
+
+    # Scopes
+    scope :enabled, -> { where(enabled: true) }
+    scope :by_type, ->(type) { where(channel_type: type) }
+
+    # Convenience accessor for config
+    def config
+      config_data || {}
+    end
+
+    def config=(value)
+      self.config_data = value
+    end
+
+    # Returns the channel class for sending alerts
+    #
+    # Maps channel_type to the corresponding Alerts::Channels class.
+    #
+    def channel_class
+      case channel_type
+      when "email"   then Findbug::Alerts::Channels::Email
+      when "slack"   then Findbug::Alerts::Channels::Slack
+      when "discord" then Findbug::Alerts::Channels::Discord
+      when "webhook" then Findbug::Alerts::Channels::Webhook
+      end
+    end
+
+    # Human-readable channel type
+    def display_type
+      channel_type&.titleize
+    end
+
+    # Returns config with sensitive values masked for display
+    #
+    # Shows scheme + host for URLs, masks everything else.
+    # Email recipients are shown in full (not sensitive).
+    #
+    def masked_config
+      masked = {}
+
+      case channel_type
+      when "email"
+        masked["Recipients"] = Array(config["recipients"]).join(", ").presence || "None"
+        masked["From"] = config["from"] || "findbug@localhost"
+      when "slack"
+        masked["Webhook URL"] = mask_url(config["webhook_url"])
+        masked["Channel"] = config["channel"] || "Default"
+        masked["Username"] = config["username"] || "Findbug"
+      when "discord"
+        masked["Webhook URL"] = mask_url(config["webhook_url"])
+        masked["Username"] = config["username"] || "Findbug"
+      when "webhook"
+        masked["URL"] = mask_url(config["url"])
+        masked["Method"] = (config["method"] || "POST").upcase
+        headers_count = (config["headers"] || {}).size
+        masked["Custom Headers"] = "#{headers_count} configured" if headers_count > 0
+      end
+
+      masked
+    end
+
+    private
+
+    # Mask a URL for safe display
+    #
+    # Shows scheme + host but masks the path (which typically contains
+    # secret tokens in webhook URLs).
+    #
+    def mask_url(url)
+      return "Not configured" if url.blank?
+
+      uri = URI.parse(url)
+      path = uri.path.to_s
+      masked_path = path.length > 8 ? "#{path[0..7]}********" : "********"
+      "#{uri.scheme}://#{uri.host}#{masked_path}"
+    rescue URI::InvalidURIError
+      "#{url[0..15]}********"
+    end
+
+    # Validate that required config fields are present for each channel type
+    def validate_required_config
+      return if config.blank? && !enabled?
+
+      case channel_type
+      when "email"
+        if enabled? && Array(config["recipients"]).compact_blank.empty?
+          errors.add(:base, "Email channel requires at least one recipient")
+        end
+      when "slack"
+        if enabled? && config["webhook_url"].blank?
+          errors.add(:base, "Slack channel requires a webhook URL")
+        end
+      when "discord"
+        if enabled? && config["webhook_url"].blank?
+          errors.add(:base, "Discord channel requires a webhook URL")
+        end
+      when "webhook"
+        if enabled? && config["url"].blank?
+          errors.add(:base, "Webhook channel requires a URL")
+        end
+      end
+    end
+  end
+end

data/app/views/findbug/alerts/edit.html.erb

@@ -0,0 +1,133 @@
+<h1>Edit Alert Channel</h1>
+<p class="page-description">Update configuration for <strong><%= @channel.name %></strong>.</p>
+
+<div class="card" style="max-width: 560px;">
+  <div class="card-content">
+    <%= form_tag findbug.alert_path(@channel), method: :patch do %>
+      <div style="display: flex; flex-direction: column; gap: 1.5rem;">
+
+        <%# Channel Type (locked on edit) %>
+        <div class="form-group">
+          <label>Channel Type</label>
+          <div style="display: flex; align-items: center; gap: 0.5rem; height: 2rem;">
+            <span class="badge badge-info"><%= @channel.display_type %></span>
+            <span class="form-hint">Cannot be changed after creation</span>
+          </div>
+          <input type="hidden" name="alert_channel[channel_type]" value="<%= @channel.channel_type %>">
+        </div>
+
+        <%# Name %>
+        <div class="form-group">
+          <label>Name</label>
+          <input type="text" name="alert_channel[name]" value="<%= @channel.name %>"
+                 placeholder="e.g., Production Slack, Dev Team Email">
+        </div>
+
+        <%# Enabled %>
+        <label style="display: flex; align-items: center; gap: 0.75rem; cursor: pointer;">
+          <input type="hidden" name="alert_channel[enabled]" value="0">
+          <span class="toggle">
+            <input type="checkbox" name="alert_channel[enabled]" value="1" <%= "checked" if @channel.enabled? %>>
+            <span class="toggle-slider"></span>
+          </span>
+          <span>Enable this channel</span>
+        </label>
+
+        <div class="separator"></div>
+
+        <%# Email config fields %>
+        <% if @channel.channel_type == "email" %>
+          <h3 style="font-size: 0.875rem; font-weight: 600; margin-bottom: 1.25rem; color: hsl(var(--muted-foreground));">Email Configuration</h3>
+          <div style="display: flex; flex-direction: column; gap: 1.25rem;">
+            <div class="form-group">
+              <label>Recipients</label>
+              <textarea name="config[recipients]" rows="3" placeholder="One email per line" class="font-mono"><%= Array(@channel.config["recipients"]).join("\n") %></textarea>
+              <span class="form-hint">One email address per line</span>
+            </div>
+            <div class="form-group">
+              <label>From Address</label>
+              <input type="text" name="config[from]" value="<%= @channel.config["from"] %>" placeholder="findbug@example.com">
+              <span class="form-hint">Optional. Defaults to findbug@localhost</span>
+            </div>
+          </div>
+        <% end %>
+
+        <%# Slack config fields %>
+        <% if @channel.channel_type == "slack" %>
+          <h3 style="font-size: 0.875rem; font-weight: 600; margin-bottom: 1.25rem; color: hsl(var(--muted-foreground));">Slack Configuration</h3>
+          <div style="display: flex; flex-direction: column; gap: 1.25rem;">
+            <div class="form-group">
+              <label>Webhook URL</label>
+              <input type="text" name="config[webhook_url]" value="<%= @channel.config["webhook_url"] %>" placeholder="https://hooks.slack.com/services/..." class="font-mono">
+            </div>
+            <div class="form-group">
+              <label>Channel</label>
+              <input type="text" name="config[channel]" value="<%= @channel.config["channel"] %>" placeholder="#errors">
+              <span class="form-hint">Optional. Overrides the webhook's default channel</span>
+            </div>
+            <div class="form-group">
+              <label>Username</label>
+              <input type="text" name="config[username]" value="<%= @channel.config["username"] %>" placeholder="Findbug">
+              <span class="form-hint">Optional. Defaults to Findbug</span>
+            </div>
+            <div class="form-group">
+              <label>Icon Emoji</label>
+              <input type="text" name="config[icon_emoji]" value="<%= @channel.config["icon_emoji"] %>" placeholder=":bug:">
+              <span class="form-hint">Optional. Defaults to :bug:</span>
+            </div>
+          </div>
+        <% end %>
+
+        <%# Discord config fields %>
+        <% if @channel.channel_type == "discord" %>
+          <h3 style="font-size: 0.875rem; font-weight: 600; margin-bottom: 1.25rem; color: hsl(var(--muted-foreground));">Discord Configuration</h3>
+          <div style="display: flex; flex-direction: column; gap: 1.25rem;">
+            <div class="form-group">
+              <label>Webhook URL</label>
+              <input type="text" name="config[webhook_url]" value="<%= @channel.config["webhook_url"] %>" placeholder="https://discord.com/api/webhooks/..." class="font-mono">
+            </div>
+            <div class="form-group">
+              <label>Username</label>
+              <input type="text" name="config[username]" value="<%= @channel.config["username"] %>" placeholder="Findbug">
+              <span class="form-hint">Optional. Defaults to Findbug</span>
+            </div>
+            <div class="form-group">
+              <label>Avatar URL</label>
+              <input type="text" name="config[avatar_url]" value="<%= @channel.config["avatar_url"] %>" placeholder="https://example.com/avatar.png">
+              <span class="form-hint">Optional. URL to a custom avatar image</span>
+            </div>
+          </div>
+        <% end %>
+
+        <%# Webhook config fields %>
+        <% if @channel.channel_type == "webhook" %>
+          <h3 style="font-size: 0.875rem; font-weight: 600; margin-bottom: 1.25rem; color: hsl(var(--muted-foreground));">Webhook Configuration</h3>
+          <div style="display: flex; flex-direction: column; gap: 1.25rem;">
+            <div class="form-group">
+              <label>URL</label>
+              <input type="text" name="config[url]" value="<%= @channel.config["url"] %>" placeholder="https://your-service.com/findbug-webhook" class="font-mono">
+            </div>
+            <div class="form-group">
+              <label>HTTP Method</label>
+              <%= select_tag "config[method]",
+                  options_for_select([["POST", "POST"], ["PUT", "PUT"]], @channel.config["method"] || "POST") %>
+            </div>
+            <div class="form-group">
+              <label>Custom Headers</label>
+              <textarea name="config[headers]" rows="3" placeholder="Authorization: Bearer your-token&#10;X-Custom-Header: value" class="font-mono"><%= (@channel.config["headers"] || {}).map { |k, v| "#{k}: #{v}" }.join("\n") %></textarea>
+              <span class="form-hint">One header per line in "Key: Value" format</span>
+            </div>
+          </div>
+        <% end %>
+
+        <div class="separator"></div>
+
+        <%# Actions %>
+        <div style="display: flex; gap: 0.75rem;">
+          <button type="submit" class="btn btn-primary">Update Channel</button>
+          <a href="<%= findbug.alerts_path %>" class="btn btn-ghost">Cancel</a>
+        </div>
+      </div>
+    <% end %>
+  </div>
+</div>