oopsie-ruby 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90e505d931c11b4c59ca0f376c0ee0ad394e21c3407831d32b2ef79f918141fe
-  data.tar.gz: 5c7fb498a876bded8a1dda466682632888999d4383d945f27b0dc8de92fd71b4
+  metadata.gz: b253a01f87bd139b82b076c5a004abc1e5ea133a35fdd4d163b0d40c9afae0af
+  data.tar.gz: 9df3a4fac0ddca3431a0dd21e22f2e382736c9741c6a30c71180a33c51501d70
 SHA512:
-  metadata.gz: 542e41ff7f9dbd60a0e8a2ab3fd243dca4c7d0ee030ea569be2a7d0d6630b00c59a0501faff05fc6e2962d8ff05b4092e1c5d56bc08359a7f75c2498b691b06b
-  data.tar.gz: 8b15abe36e4387f909ed3f8799587d42a9fe22de9303dc283eb39f8197774d44243c6c9c232ed0edf511fcf3efa13393f11b7c99f44d70e569f09b09e7f2cd3f
+  metadata.gz: 92c526acf4f16a3e78196c2dce640a9df09911ba4a2a1133a50de311919bcc69e2556afbfe34463a21ad78f10eda6fa1c00b66aff7f6b9b643941582b3e19ae4
+  data.tar.gz: '087b6a2d51840d8ada9194c832ff94789a71b08c63bdbe9c9da3d2055b823c914a13d88f273188782a0a3cbada61be3e7808b6b8a02b1f2f9b4bc8c156cf9aae'

data/lib/oopsie/client.rb

@@ -16,9 +16,9 @@ module Oopsie
       @configuration = configuration
     end
 
-    def send_error(error_class:, message:, stack_trace:)
+    def send_error(**payload)
       uri = URI.join(@configuration.endpoint, ERRORS_PATH)
-      request = build_request(uri, error_class:, message:, stack_trace:)
+      request = build_request(uri, payload)
       response = execute(uri, request)
       handle_response(response)
     rescue StandardError => e
@@ -27,15 +27,11 @@ module Oopsie
 
     private
 
-    def build_request(uri, error_class:, message:, stack_trace:)
+    def build_request(uri, payload)
       request = Net::HTTP::Post.new(uri)
       request['Content-Type'] = 'application/json'
       request['Authorization'] = "Bearer #{@configuration.api_key}"
-      request.body = JSON.generate(
-        error_class: error_class,
-        message: message,
-        stack_trace: stack_trace
-      )
+      request.body = JSON.generate(payload)
       request
     end
 

data/lib/oopsie/context_builder.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Oopsie
+  # Builds execution_context hashes for the Oopsie API.
+  # Only includes routing/metadata — never request bodies, sensitive headers
+  # (auth, cookies), or job arguments (which may contain PII).
+  # Note: query strings are excluded from the URL as they may contain sensitive parameters.
+  module ContextBuilder
+    DATA_KEYS = %i[job_class queue jid retry_count].freeze
+
+    module_function
+
+    def from_rack_env(env)
+      method = env['REQUEST_METHOD'] || 'GET'
+      path = env['PATH_INFO'] || '/'
+      data = build_http_data(env, method, path)
+
+      { type: 'http', description: "#{method} #{path}", data: data }
+    end
+
+    # Accepts both string and symbol keys (Sidekiq normalises to strings,
+    # but callers may use symbols).
+    def from_sidekiq(job_hash)
+      values = resolve_sidekiq_values(job_hash)
+      description = "#{values[:display_class] || values[:job_class] || 'Unknown'}#perform"
+      data = DATA_KEYS.each_with_object({}) { |k, h| h[k] = values[k] unless values[k].nil? }
+
+      { type: 'worker', description: description, data: data }
+    end
+
+    def default
+      { type: 'unknown' }
+    end
+
+    def build_http_data(env, method, path)
+      data = { method: method, url: path }
+      data[:content_type] = env['CONTENT_TYPE'] if env['CONTENT_TYPE']
+      data[:request_id] = env['HTTP_X_REQUEST_ID'] if env['HTTP_X_REQUEST_ID']
+      data
+    end
+
+    def resolve_sidekiq_values(job_hash)
+      {
+        job_class: job_hash.key?('class') ? job_hash['class'] : job_hash[:class],
+        display_class: job_hash.key?('display_class') ? job_hash['display_class'] : job_hash[:display_class],
+        queue: job_hash.key?('queue') ? job_hash['queue'] : job_hash[:queue],
+        jid: job_hash.key?('jid') ? job_hash['jid'] : job_hash[:jid],
+        retry_count: job_hash.key?('retry_count') ? job_hash['retry_count'] : job_hash[:retry_count]
+      }
+    end
+  end
+end

data/lib/oopsie/exception_chain_builder.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module Oopsie
+  # Walks Exception#cause and builds the exception_chain array for the Oopsie API.
+  # Entries are ordered root-cause-first, outermost-last.
+  module ExceptionChainBuilder
+    MAX_CHAIN_LENGTH = 20  # Oopsie API limit
+    MAX_FRAMES = 100       # Oopsie API limit per exception entry
+    NOT_IN_APP_PATTERNS = ['/gems/', '/ruby/', '/vendor/', '<internal:'].freeze
+    # Ruby < 3.4 uses backtick+quote (`method'), Ruby >= 3.4 uses quote+quote ('method')
+    BACKTRACE_REGEX = /\A(.+):(\d+):in\s+[`'](.+)'\z/
+
+    module_function
+
+    def build(exception)
+      chain = unwind(exception)
+      # Deduplicate by backtrace object identity — if the same backtrace array
+      # is shared across exceptions (e.g., re-raised exceptions or manual set_backtrace),
+      # we avoid re-parsing it.
+      parsed_backtrace_ids = {}.compare_by_identity
+
+      chain.each_with_index.map do |ex, index|
+        stacktrace = deduplicated_stacktrace(ex, parsed_backtrace_ids)
+        build_entry(ex, outermost: index == chain.length - 1, stacktrace: stacktrace)
+      end
+    end
+
+    def unwind(exception)
+      chain = []
+      current = exception
+      seen = {}.compare_by_identity
+
+      while current && chain.length < MAX_CHAIN_LENGTH
+        break if seen.key?(current) # guard against circular causes
+
+        seen[current] = true
+        chain.unshift(current)
+        current = current.cause
+      end
+
+      chain
+    end
+
+    def deduplicated_stacktrace(exception, parsed_backtrace_ids)
+      bt = exception.backtrace
+      return [] if bt.nil?
+      return parsed_backtrace_ids[bt] if parsed_backtrace_ids.key?(bt)
+
+      parsed_backtrace_ids[bt] = parse_backtrace(bt)
+    end
+
+    def build_entry(exception, outermost:, stacktrace:)
+      mechanism_type = outermost ? 'generic' : 'chained'
+
+      {
+        type: exception.class.name,
+        value: exception_message(exception),
+        mechanism: { type: mechanism_type, handled: false },
+        stacktrace: stacktrace
+      }
+    end
+
+    # Prefers detailed_message (Ruby 3.2+) for richer context, ensures valid UTF-8.
+    def exception_message(exception)
+      msg = raw_message(exception)
+      msg = msg.to_s unless msg.is_a?(String)
+      encode_utf8(msg)
+    rescue StandardError
+      fallback_message(exception)
+    end
+
+    def raw_message(exception)
+      if exception.respond_to?(:detailed_message)
+        exception.detailed_message(highlight: false)
+      else
+        exception.message
+      end
+    end
+
+    def fallback_message(exception)
+      encode_utf8(exception.message.to_s)
+    rescue StandardError => e
+      "(failed to retrieve exception message: #{e.class})"
+    end
+
+    def encode_utf8(str)
+      str.encode('UTF-8', invalid: :replace, undef: :replace, replace: "\uFFFD")
+    end
+
+    def parse_backtrace(backtrace)
+      backtrace.first(MAX_FRAMES).map { |line| parse_frame(line) }
+    end
+
+    def parse_frame(line)
+      match = BACKTRACE_REGEX.match(line)
+      return { file: line, function: '', lineno: 0, in_app: in_app?(line) } unless match
+
+      file = match[1]
+      {
+        file: file,
+        function: match[3],
+        lineno: match[2].to_i,
+        in_app: in_app?(file)
+      }
+    end
+
+    # Negative-match heuristic: anything under /gems/, /ruby/, /vendor/, or
+    # <internal: is not in-app. Zero-config alternative to Sentry's positive-match
+    # approach which requires knowing project_root.
+    def in_app?(file)
+      NOT_IN_APP_PATTERNS.none? { |pattern| file.include?(pattern) }
+    end
+  end
+end

data/lib/oopsie/middleware.rb

@@ -9,7 +9,13 @@ module Oopsie
     def call(env)
       @app.call(env)
     rescue Exception => e # rubocop:disable Lint/RescueException
-      Oopsie.report(e)
+      context = begin
+        Oopsie::ContextBuilder.from_rack_env(env)
+      rescue StandardError => context_error
+        Oopsie.safely_notify_error(context_error)
+        nil
+      end
+      Oopsie.report(e, context: context)
       raise
     end
   end

data/lib/oopsie/railtie.rb

@@ -10,10 +10,19 @@ module Oopsie
       app.middleware.insert_before ActionDispatch::ShowExceptions, Oopsie::Middleware
     end
 
+    # Catches exceptions raised during controller actions that Rails surfaces in
+    # the notification payload. Exceptions fully handled by rescue_from will NOT appear here.
     initializer 'oopsie.subscribe' do
       ActiveSupport::Notifications.subscribe('process_action.action_controller') do |event|
         if (exception = event.payload[:exception_object])
-          Oopsie.report(exception)
+          context = begin
+            env = event.payload[:headers]&.env
+            env ? Oopsie::ContextBuilder.from_rack_env(env) : nil
+          rescue StandardError => e
+            Oopsie.safely_notify_error(e)
+            nil
+          end
+          Oopsie.report(exception, context: context)
         end
       end
     end

data/lib/oopsie/sidekiq.rb

@@ -5,8 +5,15 @@ require 'oopsie'
 module Oopsie
   module Sidekiq
     class ErrorHandler
-      def call(exception, *)
-        Oopsie.report(exception)
+      def call(exception, context = {}, *)
+        ctx = begin
+          job = context[:job] || context['job'] || {}
+          Oopsie::ContextBuilder.from_sidekiq(job)
+        rescue StandardError => e
+          Oopsie.safely_notify_error(e)
+          nil
+        end
+        Oopsie.report(exception, context: ctx)
       end
     end
   end

data/lib/oopsie/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Oopsie
-  VERSION = '0.2.3'
+  VERSION = '0.3.0'
 end

data/lib/oopsie.rb

@@ -3,6 +3,8 @@
 require_relative 'oopsie/version'
 require_relative 'oopsie/configuration'
 require_relative 'oopsie/client'
+require_relative 'oopsie/exception_chain_builder'
+require_relative 'oopsie/context_builder'
 require_relative 'oopsie/middleware'
 require_relative 'oopsie/railtie' if defined?(Rails::Railtie)
 require_relative 'oopsie/sidekiq' if defined?(Sidekiq)
@@ -21,22 +23,42 @@ module Oopsie
       @configuration = Configuration.new
     end
 
-    def report(exception)
+    def report(exception, context: nil)
       return if skip_report?(exception)
 
       tag_reported(exception)
       configuration.validate!
-      Client.new(configuration).send_error(
-        error_class: exception.class.name,
-        message: exception.message,
-        stack_trace: exception.backtrace&.join("\n")
-      )
+      Client.new(configuration).send_error(**build_payload(exception, context))
     rescue StandardError => e
       safely_notify_error(e)
     end
 
+    def safely_notify_error(error)
+      configuration.on_error&.call(error)
+    rescue StandardError
+      # Never crash the host app
+    end
+
     private
 
+    # stack_trace kept for backwards compat; backend prefers exception_chain when present
+    def build_payload(exception, context)
+      {
+        error_class: exception.class.name,
+        message: exception.message,
+        stack_trace: exception.backtrace&.join("\n"),
+        exception_chain: safe_build_chain(exception),
+        execution_context: context
+      }
+    end
+
+    def safe_build_chain(exception)
+      ExceptionChainBuilder.build(exception)
+    rescue StandardError => e
+      safely_notify_error(e)
+      nil
+    end
+
     def skip_report?(exception)
       configuration.ignored_exceptions.any? { |klass| exception.is_a?(klass) } ||
         exception.instance_variable_get(:@_oopsie_reported)
@@ -47,11 +69,5 @@ module Oopsie
     rescue FrozenError
       # Frozen exceptions can't be tagged — skip dedup, proceed with reporting
     end
-
-    def safely_notify_error(error)
-      configuration.on_error&.call(error)
-    rescue StandardError
-      # Never crash the host app
-    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oopsie-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Oopsie
@@ -147,6 +147,8 @@ files:
 - lib/oopsie.rb
 - lib/oopsie/client.rb
 - lib/oopsie/configuration.rb
+- lib/oopsie/context_builder.rb
+- lib/oopsie/exception_chain_builder.rb
 - lib/oopsie/middleware.rb
 - lib/oopsie/railtie.rb
 - lib/oopsie/sidekiq.rb