bugwatch-ruby 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d0be9627dc1693332f0a201853dbca22da0e1f5a1e98ea7253ef5749c94f245
-  data.tar.gz: d896401132b2ba5eb708fac049711184a12a0cc0001831121e9a11bccee16ebc
+  metadata.gz: a9d4ff0ad03b9ab70f5f37f3a4656f7b1746a86c22ee33e429242c08c0527036
+  data.tar.gz: 0a9c5bc904036439926f2e7097d07db78d8e5139ed3d2df81a57c98836661a97
 SHA512:
-  metadata.gz: c1212d03ecfe11f84acb0f6ef8a1dda3e97b3896bbd878fba89bd1f933b6275afabd2d51a7bd49a934cd25652e8641a37d070c9a034d3d72be410152c4a0aefd
-  data.tar.gz: 79c7558fc9c17f8540e51638a0958f520faaef012cf524d0433c87d801dcc3bf4d4abdcad740d8f77d481fbe54fd4b8906c37b5395364bf26cb16e212e8f3f67
+  metadata.gz: 59abfb1a125beba2a9aff1676e0299625e6b352cb4b71005b6e4a2854cff3d19758578ce6a91addadbd64f8a7656449e3766da0b3edc5659dc6f49a3953ce733
+  data.tar.gz: 579309e1a64318f07275fc4139481021d94cd01fb816f36b42cd5b8f8a0eac273d6e690b920649cd8787eee59b555b371592fe308f16396b91c84c118b2925df

data/README.md

@@ -62,6 +62,65 @@ rescue => e
 end
 ```
 
+## Deploy tracking
+
+Track deploys so BugWatch can correlate new errors with releases.
+
+```ruby
+Bugwatch.track_deploy(
+  version:     "abc1234",
+  environment: "production",       # defaults to config.release_stage
+  description: "Deployed abc1234",
+  deployed_by: "ci"
+)
+```
+
+### Heroku
+
+On Heroku, `SOURCE_VERSION` (the git SHA) is available during the **build** phase but not during the **release** phase. The recommended approach is to bake the SHA into a `REVISION` file at build time, then read it at release time.
+
+**1. Create a Rake task** in `lib/tasks/bugwatch.rake`:
+
+```ruby
+namespace :bugwatch do
+  task write_revision: :environment do
+    revision = ENV["SOURCE_VERSION"] || `git rev-parse HEAD 2>/dev/null`.strip
+    if revision.present?
+      File.write(Rails.root.join("REVISION"), revision)
+      puts "Bugwatch: wrote REVISION #{revision[0..6]}"
+    end
+  end
+
+  task track_deploy: :environment do
+    revision_file = Rails.root.join("REVISION")
+    version = ENV["SOURCE_VERSION"] \
+      || (File.read(revision_file).strip if File.exist?(revision_file)).presence \
+      || Time.now.utc.strftime("%Y%m%d%H%M%S")
+
+    thread = Bugwatch.track_deploy(
+      version: version,
+      description: "Deployed #{version[0..6]}",
+      deployed_by: ENV["BUGWATCH_DEPLOYED_BY"] || "heroku"
+    )
+    thread&.join(5)
+    puts "Bugwatch: tracked deploy #{version[0..6]}"
+  end
+end
+
+# Bake the SHA into the slug during assets:precompile
+if Rake::Task.task_defined?("assets:precompile")
+  Rake::Task["assets:precompile"].enhance(["bugwatch:write_revision"])
+end
+```
+
+**2. Add the deploy task to your `Procfile`** release phase:
+
+```
+release: bundle exec rails db:migrate && bundle exec rails bugwatch:track_deploy
+```
+
+The build will write the commit SHA to `REVISION`, and the release phase will read it back and report the deploy to BugWatch.
+
 ## How it works
 
 1. `Bugwatch::Middleware` wraps your entire Rack stack.

data/lib/bugwatch/active_job_handler.rb

@@ -0,0 +1,26 @@
+module Bugwatch
+  class ActiveJobHandler
+    def call(job, exception)
+      return if Bugwatch.configuration.ignore?(exception)
+      return unless Bugwatch.configuration.notify_for_release_stage?
+
+      payload = ErrorBuilder.new(exception).build
+      payload[:context] = {
+        job_class: job.class.name,
+        job_id: job.job_id,
+        queue_name: job.queue_name,
+        arguments: safe_arguments(job.arguments)
+      }
+
+      Notification.new(payload).deliver
+    end
+
+    private
+
+    def safe_arguments(args)
+      args.map { |arg| arg.is_a?(GlobalID::Identification) ? arg.to_global_id.to_s : arg }
+    rescue StandardError
+      ["[unserializable]"]
+    end
+  end
+end

data/lib/bugwatch/error_subscriber.rb

@@ -0,0 +1,17 @@
+module Bugwatch
+  class ErrorSubscriber
+    def report(error, handled:, severity:, context: {}, source: nil)
+      return if Bugwatch.configuration.ignore?(error)
+      return unless Bugwatch.configuration.notify_for_release_stage?
+
+      payload = ErrorBuilder.new(error).build
+      payload[:context] = context.merge(
+        handled: handled,
+        severity: severity,
+        source: source
+      ).compact
+
+      Notification.new(payload).deliver
+    end
+  end
+end

data/lib/bugwatch/railtie.rb

@@ -9,6 +9,21 @@ module Bugwatch
         include Bugwatch::ControllerMethods
       end
     end
+
+    initializer "bugwatch.active_job" do
+      ActiveSupport.on_load(:active_job) do
+        rescue_from(Exception) do |exception|
+          Bugwatch::ActiveJobHandler.new.call(self, exception)
+          raise exception
+        end
+      end
+    end
+
+    initializer "bugwatch.error_subscriber" do
+      if defined?(Rails.error) && Rails.error.respond_to?(:subscribe)
+        Rails.error.subscribe(Bugwatch::ErrorSubscriber.new)
+      end
+    end
   end
 
   module ControllerMethods

data/lib/bugwatch/version.rb

@@ -1,3 +1,3 @@
 module Bugwatch
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/bugwatch.rb

@@ -12,6 +12,8 @@ require_relative "bugwatch/notification"
 require_relative "bugwatch/transaction_sender"
 require_relative "bugwatch/transaction_buffer"
 require_relative "bugwatch/middleware"
+require_relative "bugwatch/active_job_handler"
+require_relative "bugwatch/error_subscriber"
 require_relative "bugwatch/railtie" if defined?(Rails::Railtie)
 
 module Bugwatch

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bugwatch-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - BugWatch
@@ -48,10 +48,12 @@ files:
 - README.md
 - lib/bugwatch-ruby.rb
 - lib/bugwatch.rb
+- lib/bugwatch/active_job_handler.rb
 - lib/bugwatch/backtrace_cleaner.rb
 - lib/bugwatch/breadcrumb_collector.rb
 - lib/bugwatch/configuration.rb
 - lib/bugwatch/error_builder.rb
+- lib/bugwatch/error_subscriber.rb
 - lib/bugwatch/middleware.rb
 - lib/bugwatch/notification.rb
 - lib/bugwatch/railtie.rb