bugwatch-ruby 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d0be9627dc1693332f0a201853dbca22da0e1f5a1e98ea7253ef5749c94f245
-  data.tar.gz: d896401132b2ba5eb708fac049711184a12a0cc0001831121e9a11bccee16ebc
+  metadata.gz: 21032d38b9ffee6bf1dbef68e9ce7c39b56c28b0eb2369d76bdf684b4ed25df3
+  data.tar.gz: 052521dd770495c7bd271313788d71e9b1d0fd8dede69f1d2fa86603bd25eccc
 SHA512:
-  metadata.gz: c1212d03ecfe11f84acb0f6ef8a1dda3e97b3896bbd878fba89bd1f933b6275afabd2d51a7bd49a934cd25652e8641a37d070c9a034d3d72be410152c4a0aefd
-  data.tar.gz: 79c7558fc9c17f8540e51638a0958f520faaef012cf524d0433c87d801dcc3bf4d4abdcad740d8f77d481fbe54fd4b8906c37b5395364bf26cb16e212e8f3f67
+  metadata.gz: 9895be8ecb3c5db57f8996b1d702f75da6658d8370a470b72b88b6b12dc5da8690461208991cd14980bb5a996b70a19854c6747e4f460b9a868a75b3da0aaae8
+  data.tar.gz: a51dd3a8af6502533474624b1c1352661e0a5ce047b25d5f30dd693810cce7fd7532af83b7071a6987760a6bd61cce485fc4b6700c8f2b5f9d3d5366ef9a1ee2

data/README.md

@@ -62,6 +62,125 @@ 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.
+
+## User Feedback Widget
+
+Drop a feedback form into any view so users can report issues directly from your app. The form submits to BugWatch's feedback API — no controller code needed.
+
+```erb
+<%%= bugwatch_feedback_widget %>
+```
+
+The helper renders a plain, unstyled HTML form with CSS classes you can target:
+
+| Class | Element |
+|-------|---------|
+| `.bugwatch-feedback-form` | The `<form>` wrapper |
+| `.bugwatch-feedback-field` | Each field's `<div>` |
+| `.bugwatch-feedback-label` | `<label>` elements |
+| `.bugwatch-feedback-input` | Text/email `<input>` |
+| `.bugwatch-feedback-textarea` | The message `<textarea>` |
+| `.bugwatch-feedback-submit` | Submit `<button>` |
+| `.bugwatch-feedback-success` | Success message (hidden by default) |
+| `.bugwatch-feedback-error` | Error message (hidden by default) |
+
+### Options
+
+```erb
+<%%= bugwatch_feedback_widget(
+  user_email: current_user&.email,
+  user_name:  current_user&.name,
+  placeholder: "Describe the issue...",
+  submit_text: "Report Issue",
+  success_message: "We got it — thanks!",
+  issue_id: @issue_id,        # optional: link to a specific BugWatch issue
+  metadata: { page: "checkout" }
+) %>
+```
+
+### Styling example (Tailwind)
+
+```css
+.bugwatch-feedback-form { @apply space-y-4 max-w-md; }
+.bugwatch-feedback-label { @apply block text-sm font-medium text-gray-700; }
+.bugwatch-feedback-input,
+.bugwatch-feedback-textarea { @apply w-full border rounded-lg px-3 py-2 text-sm; }
+.bugwatch-feedback-submit { @apply bg-blue-600 text-white px-4 py-2 rounded-lg text-sm; }
+.bugwatch-feedback-success { @apply text-green-600 text-sm; }
+.bugwatch-feedback-error { @apply text-red-600 text-sm; }
+```
+
+### Server-side feedback
+
+You can also send feedback from Ruby (e.g. from a controller that handles your own form):
+
+```ruby
+Bugwatch.send_feedback(
+  params[:message],
+  email: current_user.email,
+  name:  current_user.name,
+  url:   request.original_url
+)
+```
+
 ## 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/feedback_helper.rb

@@ -0,0 +1,86 @@
+module Bugwatch
+  module FeedbackHelper
+    # Renders a minimal, unstyled feedback widget form.
+    #
+    # The form submits via fetch to the BugWatch feedback API.
+    # All markup uses "bugwatch-feedback-*" CSS classes so you
+    # can style it however you want without collisions.
+    #
+    # Options:
+    #   :user_email  - Pre-fill email (e.g. current_user.email)
+    #   :user_name   - Pre-fill name  (e.g. current_user.name)
+    #   :issue_id    - Link feedback to a specific BugWatch issue
+    #   :metadata    - Hash of extra data to attach
+    #   :placeholder - Textarea placeholder text
+    #   :submit_text - Submit button label (default: "Send Feedback")
+    #   :success_message - Message shown after successful submit
+    #
+    def bugwatch_feedback_widget(user_email: nil, user_name: nil, issue_id: nil, metadata: {}, placeholder: "What happened? Tell us about the issue...", submit_text: "Send Feedback", success_message: "Thanks for your feedback!")
+      config   = Bugwatch.configuration
+      endpoint = "#{config.endpoint&.chomp("/")}/api/v1/feedback"
+      api_key  = config.api_key
+      widget_id = "bugwatch-feedback-#{SecureRandom.hex(4)}"
+
+      html = <<~HTML
+        <form id="#{widget_id}" class="bugwatch-feedback-form" data-bugwatch-feedback>
+          <div class="bugwatch-feedback-field">
+            <label for="#{widget_id}-name" class="bugwatch-feedback-label">Name</label>
+            <input type="text" id="#{widget_id}-name" name="name" value="#{ERB::Util.html_escape(user_name.to_s)}" class="bugwatch-feedback-input" />
+          </div>
+          <div class="bugwatch-feedback-field">
+            <label for="#{widget_id}-email" class="bugwatch-feedback-label">Email</label>
+            <input type="email" id="#{widget_id}-email" name="email" value="#{ERB::Util.html_escape(user_email.to_s)}" class="bugwatch-feedback-input" />
+          </div>
+          <div class="bugwatch-feedback-field">
+            <label for="#{widget_id}-message" class="bugwatch-feedback-label">Message</label>
+            <textarea id="#{widget_id}-message" name="message" required class="bugwatch-feedback-textarea" placeholder="#{ERB::Util.html_escape(placeholder)}"></textarea>
+          </div>
+          <button type="submit" class="bugwatch-feedback-submit">#{ERB::Util.html_escape(submit_text)}</button>
+          <div class="bugwatch-feedback-success" style="display:none">#{ERB::Util.html_escape(success_message)}</div>
+          <div class="bugwatch-feedback-error" style="display:none"></div>
+        </form>
+        <script>
+          (function() {
+            var form = document.getElementById("#{widget_id}");
+            form.addEventListener("submit", function(e) {
+              e.preventDefault();
+              var btn     = form.querySelector(".bugwatch-feedback-submit");
+              var success = form.querySelector(".bugwatch-feedback-success");
+              var error   = form.querySelector(".bugwatch-feedback-error");
+              success.style.display = "none";
+              error.style.display   = "none";
+              btn.disabled = true;
+
+              var body = {
+                api_key: #{api_key.to_json},
+                message: form.querySelector("[name=message]").value,
+                name:    form.querySelector("[name=name]").value || undefined,
+                email:   form.querySelector("[name=email]").value || undefined,
+                url:     window.location.href
+              };
+              #{issue_id ? "body.issue_id = #{issue_id.to_json};" : ""}
+              #{metadata.any? ? "body.metadata = #{metadata.to_json};" : ""}
+
+              fetch(#{endpoint.to_json}, {
+                method: "POST",
+                headers: { "Content-Type": "application/json" },
+                body: JSON.stringify(body)
+              }).then(function(r) {
+                if (!r.ok) throw new Error("Request failed");
+                form.querySelector("[name=message]").value = "";
+                success.style.display = "";
+                btn.disabled = false;
+              }).catch(function(err) {
+                error.textContent = "Something went wrong. Please try again.";
+                error.style.display = "";
+                btn.disabled = false;
+              });
+            });
+          })();
+        </script>
+      HTML
+
+      html.html_safe
+    end
+  end
+end

data/lib/bugwatch/feedback_sender.rb

@@ -0,0 +1,58 @@
+require "net/http"
+require "uri"
+require "json"
+
+module Bugwatch
+  class FeedbackSender
+    TIMEOUT = 3
+
+    def initialize(message:, email: nil, name: nil, url: nil, issue_id: nil, metadata: {}, config: Bugwatch.configuration)
+      @message  = message
+      @email    = email
+      @name     = name
+      @url      = url
+      @issue_id = issue_id
+      @metadata = metadata
+      @config   = config
+    end
+
+    def deliver
+      return unless @config.api_key
+      return unless @config.endpoint
+
+      Thread.new do
+        post_feedback
+      rescue StandardError
+        # Fire-and-forget: never affect the host app
+      end
+    end
+
+    private
+
+    def post_feedback
+      uri = URI.parse("#{@config.endpoint.chomp("/")}/api/v1/feedback")
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl       = uri.scheme == "https"
+      http.open_timeout  = TIMEOUT
+      http.read_timeout  = TIMEOUT
+      http.write_timeout = TIMEOUT
+
+      request = Net::HTTP::Post.new(uri.path)
+      request["Content-Type"]    = "application/json"
+      request["X-Api-Key"]       = @config.api_key
+      request["X-BugWatch-Ruby"] = Bugwatch::VERSION
+
+      payload = { message: @message }
+      payload[:email]    = @email    if @email
+      payload[:name]     = @name     if @name
+      payload[:url]      = @url      if @url
+      payload[:issue_id] = @issue_id if @issue_id
+      payload[:metadata] = @metadata if @metadata.any?
+
+      request.body = JSON.generate(payload)
+
+      http.request(request)
+    end
+  end
+end

data/lib/bugwatch/railtie.rb

@@ -9,6 +9,27 @@ 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.view_helpers" do
+      ActiveSupport.on_load(:action_view) do
+        include Bugwatch::FeedbackHelper
+      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.5.0"
 end

data/lib/bugwatch.rb

@@ -11,7 +11,11 @@ require_relative "bugwatch/report_builder"
 require_relative "bugwatch/notification"
 require_relative "bugwatch/transaction_sender"
 require_relative "bugwatch/transaction_buffer"
+require_relative "bugwatch/feedback_sender"
+require_relative "bugwatch/feedback_helper"
 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
@@ -41,6 +45,15 @@ module Bugwatch
       Notification.new(payload).deliver
     end
 
+    def send_feedback(message, email: nil, name: nil, url: nil, issue_id: nil, metadata: {})
+      return if message.to_s.strip.empty?
+
+      FeedbackSender.new(
+        message: message, email: email, name: name,
+        url: url, issue_id: issue_id, metadata: metadata
+      ).deliver
+    end
+
     def set_user(id: nil, email: nil, name: nil, **custom)
       UserContext.set(id: id, email: email, name: name, **custom)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bugwatch-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - BugWatch
@@ -48,10 +48,14 @@ 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/feedback_helper.rb
+- lib/bugwatch/feedback_sender.rb
 - lib/bugwatch/middleware.rb
 - lib/bugwatch/notification.rb
 - lib/bugwatch/railtie.rb