findbug 0.3.4 → 0.4.0

data/lib/findbug/alerts/dispatcher.rb

@@ -12,6 +12,12 @@ module Findbug
     # 3. Dispatcher checks throttling (avoid spam)
     # 4. Dispatcher sends to enabled channels (async via AlertJob)
     #
+    # CHANNEL SOURCE
+    # ==============
+    #
+    # Alert channels are stored in the database (findbug_alert_channels table)
+    # and managed via the dashboard UI at /findbug/alerts.
+    #
     # THROTTLING
     # ==========
     #
@@ -36,7 +42,7 @@ module Findbug
         #
         def notify(error_event, async: true)
           return unless Findbug.enabled?
-          return unless Findbug.config.alerts.any_enabled?
+          return unless any_enabled?
           return unless should_alert?(error_event)
           return if throttled?(error_event)
 
@@ -54,17 +60,23 @@ module Findbug
         # @param error_event [ErrorEvent] the error to alert about
         #
         def send_alerts(error_event)
-          alert_config = Findbug.config.alerts
-
-          alert_config.enabled_channels.each do |channel_name, config|
-            send_to_channel(channel_name, error_event, config)
+          Findbug::AlertChannel.enabled.find_each do |channel_record|
+            channel_instance = channel_record.channel_class.new(channel_record.config.symbolize_keys)
+            channel_instance.send_alert(error_event)
           rescue StandardError => e
             Findbug.logger.error(
-              "[Findbug] Failed to send alert to #{channel_name}: #{e.message}"
+              "[Findbug] Failed to send alert to #{channel_record.name}: #{e.message}"
             )
           end
         end
 
+        # Check if any alert channels are enabled in the database
+        def any_enabled?
+          Findbug::AlertChannel.enabled.exists?
+        rescue StandardError
+          false
+        end
+
         private
 
         # Check if we should alert for this error
@@ -94,32 +106,6 @@ module Findbug
         def record_alert(error_event)
           Throttler.record(error_event.fingerprint)
         end
-
-        # Send to a specific channel
-        def send_to_channel(channel_name, error_event, config)
-          channel_class = channel_for(channel_name)
-          return unless channel_class
-
-          channel = channel_class.new(config)
-          channel.send_alert(error_event)
-        end
-
-        # Get the channel class for a channel name
-        def channel_for(channel_name)
-          case channel_name.to_sym
-          when :email
-            Channels::Email
-          when :slack
-            Channels::Slack
-          when :discord
-            Channels::Discord
-          when :webhook
-            Channels::Webhook
-          else
-            Findbug.logger.warn("[Findbug] Unknown alert channel: #{channel_name}")
-            nil
-          end
-        end
       end
     end
   end

data/lib/findbug/configuration.rb

@@ -310,70 +310,31 @@ module Findbug
 
   # Nested class for alert configuration
   #
-  # WHY A SEPARATE CLASS?
-  # Alerts have their own sub-configuration (multiple channels, each with settings).
-  # Nesting keeps the main Configuration cleaner.
+  # ALERT CHANNELS ARE DB-DRIVEN
+  # ============================
+  #
+  # Alert channels (email, Slack, Discord, webhook) are stored in the database
+  # and managed via the dashboard UI at /findbug/alerts.
+  #
+  # This class only holds global alert settings like throttle_period.
   #
   class AlertConfiguration
     attr_accessor :throttle_period
 
     def initialize
-      @channels = {}
       @throttle_period = 300 # 5 minutes default
     end
 
-    # Configure email alerts
-    def email(enabled:, recipients: [], **options)
-      @channels[:email] = {
-        enabled: enabled,
-        recipients: Array(recipients),
-        **options
-      }
-    end
-
-    # Configure Slack alerts
-    def slack(enabled:, webhook_url: nil, channel: nil, **options)
-      @channels[:slack] = {
-        enabled: enabled,
-        webhook_url: webhook_url,
-        channel: channel,
-        **options
-      }
-    end
-
-    # Configure Discord alerts
-    def discord(enabled:, webhook_url: nil, **options)
-      @channels[:discord] = {
-        enabled: enabled,
-        webhook_url: webhook_url,
-        **options
-      }
-    end
-
-    # Configure generic webhook alerts
-    def webhook(enabled:, url: nil, headers: {}, **options)
-      @channels[:webhook] = {
-        enabled: enabled,
-        url: url,
-        headers: headers,
-        **options
-      }
-    end
-
-    # Get configuration for a specific channel
-    def channel(name)
-      @channels[name.to_sym]
-    end
-
-    # Get all enabled channels
-    def enabled_channels
-      @channels.select { |_, config| config[:enabled] }
-    end
-
-    # Check if any alerts are configured
-    def any_enabled?
-      enabled_channels.any?
-    end
+    # Deprecated DSL methods — kept for backward compatibility so existing
+    # initializers don't raise NoMethodError on upgrade. These are no-ops;
+    # alert channels are now configured via the dashboard UI.
+    def email(**) = nil
+    def slack(**) = nil
+    def discord(**) = nil
+    def webhook(**) = nil
+    def channel(_name) = nil
+    def enabled_channels = {}
+    def any_enabled? = false
   end
 
   # Custom error for configuration issues

data/lib/findbug/engine.rb

@@ -11,6 +11,7 @@ require_relative "../../app/controllers/findbug/application_controller"
 require_relative "../../app/controllers/findbug/dashboard_controller"
 require_relative "../../app/controllers/findbug/errors_controller"
 require_relative "../../app/controllers/findbug/performance_controller"
+require_relative "../../app/controllers/findbug/alerts_controller"
 
 module Findbug
   # Engine is the main Rails integration point for Findbug.
@@ -97,6 +98,14 @@ Findbug::Engine.routes.draw do
   # Performance
   resources :performance, only: [:index, :show]
 
+  # Alerts
+  resources :alerts, only: [:index, :new, :create, :edit, :update, :destroy] do
+    member do
+      post :toggle
+      post :test
+    end
+  end
+
   # Health check (useful for monitoring)
   get "health", to: "dashboard#health"
 

data/lib/findbug/railtie.rb

@@ -60,6 +60,7 @@ module Findbug
       models_path = File.expand_path("../../app/models/findbug", __dir__)
       require "#{models_path}/error_event"
       require "#{models_path}/performance_event"
+      require "#{models_path}/alert_channel"
     end
 
     # Register our middleware to catch exceptions
@@ -84,6 +85,13 @@ module Findbug
       require_relative "capture/middleware"
 
       Rails.application.config.middleware.use(Findbug::Capture::Middleware)
+
+      # Ensure Rack::MethodOverride is available so the dashboard's HTML
+      # forms can use PATCH/DELETE via the _method hidden field.
+      # API-only Rails apps don't include this middleware by default.
+      if Rails.application.config.api_only
+        Rails.application.config.middleware.insert_before 0, Rack::MethodOverride
+      end
     end
 
     # Set up Rails error reporting integration (Rails 7+)

data/lib/findbug/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Findbug
-  VERSION = "0.3.4"
+  VERSION = "0.4.0"
 end

data/lib/generators/findbug/install_generator.rb

@@ -49,8 +49,14 @@ module Findbug
           "db/migrate/create_findbug_performance_events.rb"
         )
 
+        migration_template(
+          "create_findbug_alert_channels.rb",
+          "db/migrate/create_findbug_alert_channels.rb"
+        )
+
         say_status :create, "db/migrate/create_findbug_error_events.rb", :green
         say_status :create, "db/migrate/create_findbug_performance_events.rb", :green
+        say_status :create, "db/migrate/create_findbug_alert_channels.rb", :green
       end
 
       def display_post_install

data/lib/generators/findbug/templates/POST_INSTALL

@@ -29,18 +29,15 @@ Next steps:
      FINDBUG_USERNAME=your-username
      FINDBUG_PASSWORD=your-secure-password
 
-4. (Optional) Configure alerts in config/initializers/findbug.rb:
+4. (Optional) Configure alerts via the dashboard:
 
-     config.alerts do |alerts|
-       alerts.slack(
-         enabled: true,
-         webhook_url: ENV["SLACK_WEBHOOK_URL"]
-       )
-     end
+     http://localhost:3000/findbug/alerts
+
+   Add Email, Slack, Discord, or Webhook channels directly from the UI.
 
 5. (Multi-tenant apps) If using Apartment/ros-apartment, add to apartment.rb:
 
-     config.excluded_models = %w[Findbug::ErrorEvent Findbug::PerformanceEvent]
+     config.excluded_models = %w[Findbug::ErrorEvent Findbug::PerformanceEvent Findbug::AlertChannel]
 
    And exclude /findbug from your tenant switching middleware.
 

data/lib/generators/findbug/templates/create_findbug_alert_channels.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class CreateFindbugAlertChannels < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :findbug_alert_channels do |t|
+      # Channel identification
+      t.string :channel_type, null: false  # email, slack, discord, webhook
+      t.string :name, null: false          # user-friendly label
+
+      # Status
+      t.boolean :enabled, default: false
+
+      # Configuration (JSON-serialized, encrypted at rest)
+      # Using text instead of jsonb so Rails encryption can work on it
+      t.text :config_data
+
+      t.timestamps
+    end
+
+    # Indexes for common queries
+    add_index :findbug_alert_channels, :channel_type
+    add_index :findbug_alert_channels, :enabled
+  end
+end

data/lib/generators/findbug/templates/initializer.rb

@@ -113,35 +113,12 @@ Findbug.configure do |config|
   # ALERTS
   # ============================================================================
 
+  # Alert channels (Email, Slack, Discord, Webhook) are configured via the
+  # dashboard UI at /findbug/alerts — no code changes needed.
+
   config.alerts do |alerts|
     # Throttle period - don't alert for same error more than once in this period
     alerts.throttle_period = 5.minutes
-
-    # Email alerts
-    # alerts.email(
-    #   enabled: true,
-    #   recipients: ["dev-team@example.com"]
-    # )
-
-    # Slack alerts
-    # alerts.slack(
-    #   enabled: true,
-    #   webhook_url: ENV["SLACK_WEBHOOK_URL"],
-    #   channel: "#errors"  # optional
-    # )
-
-    # Discord alerts
-    # alerts.discord(
-    #   enabled: true,
-    #   webhook_url: ENV["DISCORD_WEBHOOK_URL"]
-    # )
-
-    # Generic webhook
-    # alerts.webhook(
-    #   enabled: true,
-    #   url: "https://your-service.com/findbug-webhook",
-    #   headers: { "Authorization" => "Bearer #{ENV['WEBHOOK_TOKEN']}" }
-    # )
   end
 
   # ============================================================================

data/lib/generators/findbug/upgrade_generator.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/active_record"
+
+module Findbug
+  module Generators
+    # UpgradeGenerator creates any missing migrations for existing Findbug installations.
+    #
+    # Usage:
+    #   rails generate findbug:upgrade
+    #
+    # This is safe to run multiple times — it only creates migrations that don't
+    # already exist. Use this when upgrading Findbug to a new version that adds
+    # new database tables.
+    #
+    class UpgradeGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Upgrade Findbug: creates any missing migrations"
+
+      def self.next_migration_number(dirname)
+        ActiveRecord::Generators::Base.next_migration_number(dirname)
+      end
+
+      def create_missing_migrations
+        create_migration_if_missing(
+          "create_findbug_alert_channels.rb",
+          "db/migrate/create_findbug_alert_channels.rb"
+        )
+      end
+
+      def display_next_steps
+        return unless behavior == :invoke
+
+        say ""
+        say "=================================================================", :green
+        say "  Findbug upgrade complete!", :green
+        say "=================================================================", :green
+        say ""
+        say "Next steps:"
+        say ""
+        say "  1. Run migrations:  rails db:migrate"
+        say ""
+        say "  2. Configure alerts via the dashboard:"
+        say "     http://localhost:3000/findbug/alerts"
+        say ""
+        say "  3. (Multi-tenant apps) Add to apartment.rb excluded_models:"
+        say "     Findbug::AlertChannel"
+        say ""
+      end
+
+      private
+
+      def migration_version
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+      end
+
+      # Only create a migration if no migration with the same class name exists
+      def create_migration_if_missing(template_name, destination)
+        migration_name = template_name.sub(/\.rb$/, "")
+
+        if migration_exists?(migration_name)
+          say_status :skip, destination, :yellow
+        else
+          migration_template(template_name, destination)
+          say_status :create, destination, :green
+        end
+      end
+
+      # Check if a migration file already exists in db/migrate/
+      def migration_exists?(migration_name)
+        Dir.glob("db/migrate/[0-9]*_#{migration_name}.rb").any?
+      end
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: findbug
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Soumit Das
 bindir: exe
 cert_chain: []
-date: 2026-01-04 00:00:00.000000000 Z
+date: 2026-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -177,6 +177,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/controllers/findbug/alerts_controller.rb
 - app/controllers/findbug/application_controller.rb
 - app/controllers/findbug/dashboard_controller.rb
 - app/controllers/findbug/errors_controller.rb
@@ -184,14 +185,19 @@ files:
 - app/jobs/findbug/alert_job.rb
 - app/jobs/findbug/cleanup_job.rb
 - app/jobs/findbug/persist_job.rb
+- app/models/findbug/alert_channel.rb
 - app/models/findbug/error_event.rb
 - app/models/findbug/performance_event.rb
+- app/views/findbug/alerts/edit.html.erb
+- app/views/findbug/alerts/index.html.erb
+- app/views/findbug/alerts/new.html.erb
 - app/views/findbug/dashboard/index.html.erb
 - app/views/findbug/errors/index.html.erb
 - app/views/findbug/errors/show.html.erb
 - app/views/findbug/performance/index.html.erb
 - app/views/findbug/performance/show.html.erb
 - app/views/layouts/findbug/application.html.erb
+- docs/index.html
 - lib/findbug.rb
 - lib/findbug/alerts/channels/base.rb
 - lib/findbug/alerts/channels/discord.rb
@@ -220,15 +226,17 @@ files:
 - lib/findbug/version.rb
 - lib/generators/findbug/install_generator.rb
 - lib/generators/findbug/templates/POST_INSTALL
+- lib/generators/findbug/templates/create_findbug_alert_channels.rb
 - lib/generators/findbug/templates/create_findbug_error_events.rb
 - lib/generators/findbug/templates/create_findbug_performance_events.rb
 - lib/generators/findbug/templates/initializer.rb
+- lib/generators/findbug/upgrade_generator.rb
 - sig/findbug.rbs
-homepage: https://github.com/ITSSOUMIT/findbug
+homepage: https://findbug.dev
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/ITSSOUMIT/findbug
+  homepage_uri: https://findbug.dev
   source_code_uri: https://github.com/ITSSOUMIT/findbug
   changelog_uri: https://github.com/ITSSOUMIT/findbug/blob/main/CHANGELOG.md
 rdoc_options: []