snitch-rails 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c4a5dc4773dd228a4f9478cd08a0b1f3b6a4160500340dd692beca1395f0f49
-  data.tar.gz: 95b3c04d9b95d0e15c426c12746bf0fcefaefd47e35aeba898cd21fc26ba47b9
+  metadata.gz: a33dc497c1b82d6d45ebc526e83f27eb51cb683fcf7eb3634d0b94aa020be386
+  data.tar.gz: 1302300c77ed110f702cb2f6b5817ce71e87ad1cfe35845a1935776a2f6d830c
 SHA512:
-  metadata.gz: f1592e5587346cac3b8bd92b6f9536a6f890c7922df77ad3e47423b3139a0692a4367f69b80eee1702abc5eff63cd5bc99ebdce3c59db5e8a54ee91d282e8ed4
-  data.tar.gz: d0b95a4e8fa41d368af44a6b0efdfd1c70c1e9dfdf9c072faeb5316a62e19ef2a8c081a317a6e32a2be0fe70da969e8647e720c30a2e46dce88219a7ac35874b
+  metadata.gz: d7bbd6b45dc3f1ed501940526360912793e60b7b18eae32c10b32b48f5e90ebb0497cb450e8581fa99e6d14144eabce3c5a03d61069ab37fc3968c5024e573a2
+  data.tar.gz: e7996ecc883c3a112211c31a174a3281f1a03898bb8af2c994aef9df21648619dac8e442099becc6223398dcae402fd1e69a07c83552b506cb61562c106f5b7a

data/README.md

@@ -12,7 +12,6 @@ Snitch catches unhandled exceptions in your Rails application, persists them to
 - **Dashboard** at `/snitches` with tabbed views: Open, Closed, and Ignored
 - Ignore exceptions via config or directly from the dashboard
 - Manual exception reporting for rescued exceptions
-- Upgrade generator for existing installations
 
 ## Installation
 
@@ -28,26 +27,19 @@ Run bundle install:
 bundle install
 ```
 
-Run the install generator to create the migration, initializer, and mount the engine routes:
+Run the install generator:
 
 ```bash
 rails generate snitch:install
-```
-
-Run the migration:
-
-```bash
 rails db:migrate
 ```
 
-The installer automatically adds the following route to your application:
+The installer mounts the dashboard to `config/routes.rb`:
 
 ```ruby
 mount Snitch::Engine, at: "/snitches"
 ```
 
-If you need to mount it manually or at a different path, add the above line to your `config/routes.rb`.
-
 ### Upgrading from a previous version
 
 If you're upgrading from a version prior to 0.3.0, run the update generator to add the `status` column to the `snitch_errors` table:
@@ -83,6 +75,9 @@ Snitch.configure do |config|
 
   # Exceptions to ignore (default: ActiveRecord::RecordNotFound, ActionController::RoutingError)
   config.ignored_exceptions += [YourCustomError]
+
+  # GitHub webhook secret for auto-closing events when issues are closed (optional)
+  config.github_webhook_secret = ENV["SNITCH_GITHUB_WEBHOOK_SECRET"]
 end
 ```
 
@@ -92,7 +87,11 @@ Create a [personal access token](https://github.com/settings/tokens) with the `r
 
 ## Dashboard
 
-Visit `/snitches` in your browser to view the Snitch dashboard. The dashboard provides three tabs:
+Visit `/snitches` in your browser to view the Snitch dashboard.
+
+![Snitch Dashboard](dashboard.png)
+
+The dashboard provides three tabs:
 
 - **Open** — Exceptions that need attention. Shows the most recently occurred first.
 - **Closed** — Exceptions that have been resolved. You can reopen them if they recur.
@@ -104,10 +103,12 @@ From the dashboard you can change the status of any exception:
 
 ### Ignoring Exceptions
 
-There are two ways to ignore exceptions:
+There are two ways to ignore exceptions, and Snitch honors both:
+
+1. **Via the initializer** — Add exception classes to `config.ignored_exceptions`. These are filtered at the middleware level and never captured or persisted.
+2. **Via the dashboard** — Mark individual exceptions as "Ignored" from the Open tab. Future occurrences of that exception class will be silently skipped — no new records, no GitHub issues.
 
-1. **Via configuration** — Add exception classes to `config.ignored_exceptions` in the initializer. These are never captured.
-2. **Via the dashboard** — Mark individual exceptions as "Ignored" from the Open tab. These exceptions are already captured but future occurrences won't create new GitHub issues.
+Both sources are checked every time an exception is caught. If an exception class appears in either the initializer config or has a record with status "ignored" in the database, it will be ignored.
 
 ## Manual Reporting
 
@@ -126,6 +127,42 @@ This is useful for exceptions you want to recover from gracefully but still want
 
 The same fingerprinting and deduplication rules apply. If the same exception is reported multiple times, Snitch will increment the occurrence count and comment on the existing GitHub issue rather than creating a new one.
 
+## GitHub Webhook (Auto-Close)
+
+When a developer fixes a bug and closes the GitHub issue, Snitch can automatically close the matching event record in your database — no manual dashboard cleanup required.
+
+### Setup
+
+1. Generate a webhook secret:
+
+```bash
+ruby -rsecurerandom -e "puts SecureRandom.hex(32)"
+```
+
+2. Add the secret to your environment and Snitch config:
+
+```bash
+export SNITCH_GITHUB_WEBHOOK_SECRET="your-generated-secret"
+```
+
+```ruby
+# config/initializers/snitch.rb
+config.github_webhook_secret = ENV["SNITCH_GITHUB_WEBHOOK_SECRET"]
+```
+
+3. Add the same secret to your GitHub repository. Go to **Settings > Webhooks > Add webhook** and configure:
+
+| Field          | Value                                          |
+|----------------|------------------------------------------------|
+| Payload URL    | `https://yourapp.com/snitches/webhooks/github` |
+| Content type   | `application/json`                             |
+| Secret         | The secret you generated in step 1             |
+| Events         | Select **Issues** only                         |
+
+The secret must match on both sides — your app uses it to verify that incoming webhooks are genuinely from GitHub.
+
+Once configured, closing a GitHub issue will automatically close the corresponding Snitch event.
+
 ## How It Works
 
 1. Rack middleware catches any unhandled exception (and re-raises it so normal error handling still applies)
@@ -136,8 +173,9 @@ The same fingerprinting and deduplication rules apply. If the same exception is
 
 ## Roadmap
 
-- [ ] multi-db support
-- [ ] webhook to resolve snitch record, when issues resolve
+- [x] Dashboard to view and manage captured exceptions
+- [ ] Multi-db support
+- [x] Webhook to resolve snitch records when GitHub issues close
 
 ## Requirements
 

data/app/controllers/snitch/webhooks_controller.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Snitch
+  class WebhooksController < ActionController::Base
+    skip_forgery_protection
+
+    def github
+      secret = Snitch.configuration.github_webhook_secret
+      return head :unauthorized unless secret.present?
+
+      body = request.body.read
+      signature = request.headers["X-Hub-Signature-256"]
+      expected = "sha256=#{OpenSSL::HMAC.hexdigest("SHA256", secret, body)}"
+      return head :unauthorized unless signature.present? && Rack::Utils.secure_compare(expected, signature)
+
+      return head :ok unless request.headers["X-GitHub-Event"] == "issues"
+
+      payload = JSON.parse(body)
+      return head :ok unless payload["action"] == "closed"
+
+      issue_number = payload.dig("issue", "number")
+      ResolveEventJob.perform_later(issue_number)
+
+      head :ok
+    end
+  end
+end

data/config/routes.rb

@@ -1,4 +1,5 @@
 Snitch::Engine.routes.draw do
   resources :snitches, only: [:index, :show, :update]
+  post "webhooks/github", to: "webhooks#github"
   root to: "snitches#index"
 end

data/lib/generators/snitch/install/templates/snitch.rb

@@ -13,4 +13,7 @@ Snitch.configure do |config|
 
   # Exceptions to ignore (default: RecordNotFound, RoutingError)
   # config.ignored_exceptions += [CustomError]
+
+  # GitHub webhook secret for auto-closing events when issues are closed
+  # config.github_webhook_secret = ENV["SNITCH_GITHUB_WEBHOOK_SECRET"]
 end

data/lib/snitch/configuration.rb

@@ -2,11 +2,12 @@
 
 module Snitch
   class Configuration
-    attr_accessor :github_token, :github_repo, :mention, :enabled, :ignored_exceptions
+    attr_accessor :github_token, :github_repo, :github_webhook_secret, :mention, :enabled, :ignored_exceptions
 
     def initialize
       @github_token = nil
       @github_repo = nil
+      @github_webhook_secret = nil
       @mention = "@claude"
       @enabled = true
       @ignored_exceptions = [

data/lib/snitch/exception_handler.rb

@@ -45,12 +45,14 @@ module Snitch
         existing = Event.find_by(fingerprint: fingerprint)
 
         if existing
-          existing.update!(
+          attrs = {
             occurrence_count: existing.occurrence_count + 1,
             last_occurred_at: Time.current,
             message: exception.message,
             backtrace: exception.backtrace
-          )
+          }
+          attrs[:status] = "open" if existing.status == "closed"
+          existing.update!(**attrs)
           existing
         else
           Event.create!(
@@ -69,7 +71,7 @@ module Snitch
       def enqueue_report(record)
         ReportExceptionJob.perform_later(record.id)
       rescue => e
-        Rails.logger.error("[Snitch] Failed to enqueue report job: #{e.message}") if defined?(Rails)
+        Rails.logger.error("[Snitch] Failed to enqueue report job: #{e.message}") if defined?(Rails) && Rails.respond_to?(:logger) && Rails.logger
       end
     end
   end

data/lib/snitch/github_client.rb

@@ -24,6 +24,11 @@ module Snitch
     def comment_on_issue(event)
       body = build_comment_body(event)
       @client.add_comment(@repo, event.github_issue_number, body)
+      reopen_issue(event) if event.status == "open"
+    end
+
+    def reopen_issue(event)
+      @client.update_issue(@repo, event.github_issue_number, state: "open")
     end
 
     private

data/lib/snitch/jobs/resolve_event_job.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Snitch
+  class ResolveEventJob < ActiveJob::Base
+    queue_as :default
+
+    retry_on StandardError, wait: :polynomially_later, attempts: 3
+
+    def perform(github_issue_number)
+      Event.where(github_issue_number: github_issue_number, status: "open")
+           .update_all(status: "closed")
+    end
+  end
+end

data/lib/snitch/middleware.rb

@@ -10,7 +10,7 @@ module Snitch
       begin
         ExceptionHandler.handle(e, env)
       rescue => handler_error
-        Rails.logger.error("[Snitch] Handler error: #{handler_error.message}") if defined?(Rails)
+        Rails.logger.error("[Snitch] Handler error: #{handler_error.message}") if defined?(Rails) && Rails.respond_to?(:logger) && Rails.logger
       end
       raise e
     end

data/lib/snitch/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Snitch
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 end

data/lib/snitch.rb

@@ -8,6 +8,7 @@ require "snitch/exception_handler"
 require "snitch/github_client"
 require "snitch/models/event" if defined?(ActiveRecord)
 require "snitch/jobs/report_exception_job" if defined?(ActiveJob)
+require "snitch/jobs/resolve_event_job" if defined?(ActiveJob)
 require "snitch/engine" if defined?(Rails)
 
 module Snitch

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snitch-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - RiseKit
@@ -132,6 +132,7 @@ files:
 - app/assets/builds/snitch/application.css
 - app/assets/stylesheets/snitch/application.css
 - app/controllers/snitch/snitches_controller.rb
+- app/controllers/snitch/webhooks_controller.rb
 - app/views/layouts/snitch/application.html.erb
 - app/views/snitch/snitches/index.html.erb
 - app/views/snitch/snitches/show.html.erb
@@ -148,6 +149,7 @@ files:
 - lib/snitch/fingerprint.rb
 - lib/snitch/github_client.rb
 - lib/snitch/jobs/report_exception_job.rb
+- lib/snitch/jobs/resolve_event_job.rb
 - lib/snitch/middleware.rb
 - lib/snitch/models/event.rb
 - lib/snitch/version.rb