dontbugme 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b8559d5544650453a07a48f7a123270fa34537e4980167b96c5391cd21bd081
-  data.tar.gz: 8e87d2da3525e8def1b4fbd7d8f7c8e0c5941cc176c835a0cedd8f9635ead888
+  metadata.gz: 9433798398dd8fdefaec811b7f52b310fcbb57febcc03a44fc2eaf94acd4ab2c
+  data.tar.gz: a513ab24f0d08c91ffa941dbbc81b326a6c240052fbac9b1c8b4a0111a0d4257
 SHA512:
-  metadata.gz: cc02e325d106483e274c53cd77258edc868bbd03241ec20aaa3e4962b5bfeea8f9345bb2e2d5b0d1fc04155e2f6caaa60a540211392f1c7a9a54c6c0ad4864f3
-  data.tar.gz: 45642d97da0b241ffd31a3b0585227195b17320e675ac9f2af671f07d38f7af11620ae9e11141a76aa8f4ae220505ddf2d1638b9f112e859ae0351e134a89038
+  metadata.gz: 10dd8c9e2263610d647a66d92eabb0d56760f524e684b7f9c9984465b398f48391d43caac9ff7caba3684a5d3e22bf0b3fa1f14fa65f2afba45ddc7ec7114360
+  data.tar.gz: 9dc17d45129c997152ac4d842b337a813a3ed184dea61598ecb496cbd9a732c391e6c2424a32e94dfdae221eafff208c1899560f27f326982477907ed9726c85

data/README.md

@@ -128,6 +128,26 @@ end
 
 Use `capture_output: false` to skip capturing the return value for sensitive data.
 
+### Automatic Variable Tracking
+
+Dontbugme automatically captures local variable changes between lines in your app code. No manual instrumentation needed — when a variable like `token` changes from `abc123` to `abc124`, you'll see an observe span with Input and Output in the UI.
+
+```ruby
+token = Member.find(1).confirmation_token
+token += 1
+Member.find(1).update(confirmation_token: token)
+```
+
+The UI will show both **Input** and **Output** for the transformation. Enabled by default in development; disable with `config.capture_variable_changes = false`. Only tracks simple types (String, Integer, Float, etc.) to avoid noise.
+
+### Manual Observe (optional)
+
+For explicit control, use `Dontbugme.observe`:
+
+```ruby
+token = Dontbugme.observe('token increment', token) { token + 1 }
+```
+
 ### Span Categories
 
 Access spans by category for assertions or analysis:

data/app/helpers/dontbugme/traces_helper.rb

@@ -17,6 +17,15 @@ module Dontbugme
     end
 
     OUTPUT_KEYS = %w[output result response_body].freeze
+    DEDICATED_INPUT_KEYS = %w[input].freeze
+
+    def span_input(span)
+      return nil if span.payload.blank?
+
+      payload = span.payload.is_a?(Hash) ? span.payload : {}
+      key = DEDICATED_INPUT_KEYS.find { |k| payload[k.to_sym] || payload[k] }
+      key ? (payload[key.to_sym] || payload[key]) : nil
+    end
 
     def span_output(span)
       return nil if span.payload.blank?
@@ -33,6 +42,7 @@ module Dontbugme
       payload.map do |key, value|
         next if value.nil?
         next if OUTPUT_KEYS.include?(key.to_s)
+        next if DEDICATED_INPUT_KEYS.include?(key.to_s)
 
         display_value = case value
         when Array then value.map { |v| v.is_a?(String) ? v : v.inspect }.join(', ')
@@ -54,5 +64,33 @@ module Dontbugme
       return str if str.length <= max_len
       "#{str[0, max_len - 3]}..."
     end
+
+    def trace_started_at_formatted(trace)
+      return nil unless trace.respond_to?(:started_at_utc) && trace.started_at_utc
+
+      trace.started_at_utc.respond_to?(:strftime) ? trace.started_at_utc.strftime('%Y-%m-%d %H:%M:%S.%3N UTC') : trace.started_at_utc.to_s
+    end
+
+    def trace_started_at_short(trace)
+      return nil unless trace.respond_to?(:started_at_utc) && trace.started_at_utc
+
+      trace.started_at_utc.respond_to?(:strftime) ? trace.started_at_utc.strftime('%Y-%m-%d %H:%M:%S') : trace.started_at_utc.to_s
+    end
+
+    def trace_finished_at_formatted(trace)
+      return nil unless trace.respond_to?(:duration_ms) && trace.duration_ms
+
+      finished = trace.started_at_utc + (trace.duration_ms / 1000.0)
+      finished.respond_to?(:strftime) ? finished.strftime('%Y-%m-%d %H:%M:%S.%3N UTC') : finished.to_s
+    end
+
+    def span_timestamp_formatted(trace, span)
+      return nil unless trace.respond_to?(:started_at_utc) && trace.started_at_utc
+      return nil unless span.respond_to?(:started_at) && span.started_at
+
+      offset_sec = (span.started_at.to_f / 1000.0)
+      at = trace.started_at_utc + offset_sec
+      at.respond_to?(:strftime) ? at.strftime('%H:%M:%S.%3N') : at.to_s
+    end
   end
 end

data/app/views/dontbugme/traces/index.html.erb

@@ -22,6 +22,7 @@
         <span class="trace-identifier"><%= trace.identifier %></span>
         <span class="badge <%= trace.status == :success ? 'badge-success' : 'badge-error' %>"><%= trace.status %></span>
         <span class="trace-duration"><%= trace.duration_ms ? "#{trace.duration_ms.round}ms" : '-' %></span>
+        <span class="trace-timestamp" title="<%= trace_started_at_formatted(trace) %>"><%= trace_started_at_short(trace) %></span>
       <% end %>
     <% end %>
   <% else %>

data/app/views/dontbugme/traces/show.html.erb

@@ -4,6 +4,7 @@
     <div class="trace-meta">
       <span class="badge <%= @trace.status == :success ? 'badge-success' : 'badge-error' %>"><%= @trace.status %></span>
       <span class="trace-meta-item"><%= @trace.duration_ms ? "#{@trace.duration_ms.round}ms" : 'N/A' %></span>
+      <span class="trace-meta-item trace-timestamp" title="<%= trace_started_at_formatted(@trace) %>"><%= trace_started_at_formatted(@trace) %></span>
       <span class="trace-meta-item"><%= @trace.id %></span>
       <% if @trace.correlation_id.present? %>
         <%= link_to "Follow chain", root_path(correlation_id: @trace.correlation_id), class: 'trace-link' %>
@@ -35,6 +36,7 @@
   <% spans_to_show.each_with_index do |span, idx| %>
     <details class="span-card card" data-category="<%= span.category %>">
       <summary class="span-summary">
+        <span class="span-timestamp" title="<%= trace_started_at_formatted(@trace) %>"><%= span_timestamp_formatted(@trace, span) %></span>
         <span class="span-offset"><%= span.started_at.to_f.round(1) %>ms</span>
         <span class="span-duration"><%= span.duration_ms ? "#{span.duration_ms.round(1)}ms" : '-' %></span>
         <span class="badge <%= span_category_badge_class(span.category) %>"><%= span.category.to_s.upcase %></span>
@@ -42,6 +44,12 @@
         <span class="span-detail-preview"><%= truncate_detail(span.detail, 80) %></span>
       </summary>
       <div class="span-details">
+        <% if span_input(span).present? %>
+          <div class="span-section span-input-section">
+            <h4>Input <button type="button" class="copy-btn" data-copy-target="input-<%= idx %>" title="Copy">Copy</button></h4>
+            <pre class="code-block input-block" id="input-<%= idx %>"><code><%= h(span_input(span)) %></code></pre>
+          </div>
+        <% end %>
         <% if span_output(span).present? %>
           <div class="span-section span-output-section">
             <h4>Output <button type="button" class="copy-btn" data-copy-target="output-<%= idx %>" title="Copy">Copy</button></h4>
@@ -81,7 +89,7 @@
 <% end %>
 
 <div class="trace-footer">
-  <p>Filter by category: <%= link_to 'All', trace_path(@trace.id) %> · <%= link_to 'SQL', trace_path(@trace.id, only: 'sql') %> · <%= link_to 'HTTP', trace_path(@trace.id, only: 'http') %> · <%= link_to 'Redis', trace_path(@trace.id, only: 'redis') %> · <%= link_to 'Cache', trace_path(@trace.id, only: 'cache') %> · <%= link_to 'Mailer', trace_path(@trace.id, only: 'mailer') %> · <%= link_to 'Enqueue', trace_path(@trace.id, only: 'enqueue') %></p>
+  <p>Filter by category: <%= link_to 'All', trace_path(@trace.id) %> · <%= link_to 'SQL', trace_path(@trace.id, only: 'sql') %> · <%= link_to 'HTTP', trace_path(@trace.id, only: 'http') %> · <%= link_to 'Redis', trace_path(@trace.id, only: 'redis') %> · <%= link_to 'Cache', trace_path(@trace.id, only: 'cache') %> · <%= link_to 'Mailer', trace_path(@trace.id, only: 'mailer') %> · <%= link_to 'Enqueue', trace_path(@trace.id, only: 'enqueue') %> · <%= link_to 'Custom', trace_path(@trace.id, only: 'custom') %> · <%= link_to 'Snapshot', trace_path(@trace.id, only: 'snapshot') %></p>
 </div>
 
 <% if @trace.error.present? %>

data/app/views/layouts/dontbugme/application.html.erb

@@ -36,6 +36,8 @@
     .badge-snapshot { background: #312e81; color: #a5b4fc; }
     .badge-default { background: #334155; color: #94a3b8; }
     .trace-duration { color: #64748b; min-width: 60px; font-family: monospace; }
+    .trace-timestamp { font-family: monospace; font-size: 12px; color: #64748b; }
+    .span-timestamp { font-family: monospace; font-size: 11px; color: #64748b; min-width: 90px; }
     .filters { display: flex; gap: 12px; margin-bottom: 16px; flex-wrap: wrap; }
     .filters input, .filters select { padding: 10px 14px; border: 1px solid #334155; border-radius: 6px; font-size: 13px; background: #1e293b; color: #e2e8f0; }
     .filters button { padding: 10px 20px; background: #38bdf8; color: #0f172a; border: none; border-radius: 6px; cursor: pointer; font-size: 13px; font-weight: 600; }
@@ -90,6 +92,7 @@
     .backtrace { font-size: 11px; color: #94a3b8; }
     .span-section h4 { display: flex; align-items: center; gap: 8px; }
     .span-output-section .output-block { border-left: 3px solid #38bdf8; }
+    .span-input-section .input-block { border-left: 3px solid #94a3b8; }
     .copy-btn { background: #334155; color: #94a3b8; border: none; padding: 4px 10px; border-radius: 4px; font-size: 11px; cursor: pointer; }
     .copy-btn:hover { background: #475569; color: #e2e8f0; }
   </style>

data/lib/dontbugme/configuration.rb

@@ -18,6 +18,7 @@ module Dontbugme
                   :capture_redis_values,
                   :capture_redis_return_values,
                   :capture_span_output,
+                  :capture_variable_changes,
                   :source_mode,
                   :source_filter,
                   :source_depth,
@@ -67,6 +68,7 @@ module Dontbugme
       self.capture_redis_values = false
       self.capture_redis_return_values = true
       self.capture_span_output = true
+      self.capture_variable_changes = true
       self.source_mode = :full
       self.source_filter = %w[app/ lib/]
       self.source_depth = 3
@@ -89,6 +91,7 @@ module Dontbugme
       self.recording_mode = :off
       self.enable_web_ui = false
       self.record_on_error = false
+      self.capture_variable_changes = false
       self.max_trace_buffer_bytes = 5 * 1024 * 1024 # 5 MB
     end
 
@@ -101,6 +104,7 @@ module Dontbugme
       self.capture_sql_binds = false
       self.capture_redis_return_values = false
       self.capture_span_output = false
+      self.capture_variable_changes = false
       self.source_mode = :shallow
       self.source_depth = 1
       self.source_stack_limit = 30

data/lib/dontbugme/middleware/rack.rb

@@ -12,12 +12,15 @@ module Dontbugme
         return @app.call(env) unless Dontbugme.config.should_record_request?(env)
 
         request = ::Rack::Request.new(env)
+        path = request.path.to_s
+        mount_path = Dontbugme.config.web_ui_mount_path.to_s.chomp('/')
+        return @app.call(env) if mount_path.to_s != '' && (path == mount_path || path.start_with?("#{mount_path}/"))
+
         request_id = env['action_dispatch.request_id'] || request.get_header('HTTP_X_REQUEST_ID') || SecureRandom.uuid
         correlation_id = env['HTTP_X_CORRELATION_ID'] || Correlation.generate
         Correlation.current = correlation_id
 
         method = request.request_method
-        path = request.path
         identifier = "#{method} #{path}"
 
         metadata = {

data/lib/dontbugme/railtie.rb

@@ -23,6 +23,7 @@ module Dontbugme
       Dontbugme::Subscribers::Cache.subscribe
       Dontbugme::Subscribers::ActionMailer.subscribe
       Dontbugme::Subscribers::ActiveJob.subscribe
+      Dontbugme::VariableTracker.subscribe
     end
 
     config.after_initialize do

data/lib/dontbugme/recorder.rb

@@ -13,6 +13,7 @@ module Dontbugme
 
         trace = Trace.new(kind: kind, identifier: identifier, metadata: metadata)
         Context.current = trace
+        VariableTracker.clear_state! if defined?(VariableTracker)
 
         result = yield
         trace.finish!

data/lib/dontbugme/store/json_safe.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Dontbugme
+  module Store
+    # Sanitizes data for JSON encoding by replacing invalid UTF-8 sequences.
+    # Trace data can contain binary from SQL binds, HTTP bodies, Redis, etc.
+    module JsonSafe
+      REPLACEMENT = "\uFFFD".freeze
+
+      module_function
+
+      def sanitize(obj)
+        case obj
+        when String
+          sanitize_string(obj)
+        when Hash
+          obj.transform_values { |v| sanitize(v) }
+        when Array
+          obj.map { |v| sanitize(v) }
+        when Symbol
+          sanitize_string(obj.to_s)
+        when Numeric, TrueClass, FalseClass, NilClass
+          obj
+        when Time
+          obj.respond_to?(:iso8601) ? obj.iso8601(3) : obj.to_s
+        else
+          sanitize_string(obj.to_s)
+        end
+      end
+
+      def sanitize_string(str)
+        return str if str.nil?
+        return str if str.encoding == Encoding::UTF_8 && str.valid_encoding?
+
+        str.encode('UTF-8', invalid: :replace, undef: :replace, replace: REPLACEMENT)
+      rescue StandardError
+        REPLACEMENT
+      end
+    end
+  end
+end

data/lib/dontbugme/store/postgresql.rb

@@ -17,14 +17,14 @@ module Dontbugme
         params = [
           data[:id],
           data[:kind].to_s,
-          data[:identifier],
+          JsonSafe.sanitize_string(data[:identifier].to_s),
           data[:status].to_s,
           data[:started_at],
           data[:duration_ms],
           correlation_id,
-          data[:metadata].to_json,
-          data[:spans].to_json,
-          data[:error]&.to_json
+          JsonSafe.sanitize(data[:metadata]).to_json,
+          JsonSafe.sanitize(data[:spans]).to_json,
+          data[:error] ? JsonSafe.sanitize(data[:error]).to_json : nil
         ]
         exec_params(<<~SQL, params)
           INSERT INTO dontbugme_traces

data/lib/dontbugme/store/sqlite.rb

@@ -15,18 +15,21 @@ module Dontbugme
       def save_trace(trace)
         data = trace.to_h
         correlation_id = data[:correlation_id] || data[:metadata]&.dig(:correlation_id)
+        metadata_json = json_safe(data[:metadata])
+        spans_json = json_safe(data[:spans])
+        error_json = data[:error] ? json_safe(data[:error]) : nil
         db.execute(
           'INSERT OR REPLACE INTO traces (id, kind, identifier, status, started_at, duration_ms, correlation_id, metadata_json, spans_json, error_json) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)',
           data[:id],
           data[:kind].to_s,
-          data[:identifier],
+          sanitize_identifier(data[:identifier]),
           data[:status].to_s,
           data[:started_at],
           data[:duration_ms],
           correlation_id,
-          data[:metadata].to_json,
-          data[:spans].to_json,
-          data[:error]&.to_json
+          metadata_json,
+          spans_json,
+          error_json
         )
       end
 
@@ -108,6 +111,16 @@ module Dontbugme
         db.execute('CREATE INDEX IF NOT EXISTS idx_traces_correlation_id ON traces(correlation_id)')
       end
 
+      def json_safe(obj)
+        JsonSafe.sanitize(obj).to_json
+      end
+
+      def sanitize_identifier(str)
+        return str if str.nil?
+
+        JsonSafe.sanitize_string(str.to_s)
+      end
+
       def migrate_add_correlation_id
         return if db.execute("PRAGMA table_info(traces)").any? { |col| col[1] == 'correlation_id' }
 

data/lib/dontbugme/variable_tracker.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module Dontbugme
+  # Automatically captures local variable changes between lines using TracePoint.
+  # Emits observe-style spans when variables change, so you can inspect value
+  # transformations without manual Dontbugme.observe calls.
+  class VariableTracker
+    THREAD_KEY = :dontbugme_variable_tracker_state
+    THREAD_PATH_KEY = :dontbugme_variable_tracker_path
+    IN_TRACKER_KEY = :dontbugme_variable_tracker_in_callback
+    SKIP_VARS = %w[_ result trace e ex].freeze
+    TRACKABLE_CLASSES = [String, Integer, Float, Symbol, TrueClass, FalseClass, NilClass].freeze
+
+    class << self
+      def subscribe
+        return if @subscribed
+
+        @trace_point = TracePoint.new(:line) { |tp| handle_line(tp) }
+        @trace_point.enable
+        @subscribed = true
+      end
+
+      def unsubscribe
+        return unless @subscribed
+
+        @trace_point&.disable
+        @trace_point = nil
+        @subscribed = false
+      end
+
+      def handle_line(tp)
+        return if Thread.current[IN_TRACKER_KEY]
+        return unless Dontbugme.config.recording?
+        return unless Dontbugme.config.capture_variable_changes
+        return unless Context.active?
+
+        path = tp.path.to_s
+        return if path.include?('dontbugme') || path.include?('/gems/') || path.include?('bundler')
+        return unless Dontbugme.config.source_filter.any? { |f| path.include?(f) }
+
+        binding = tp.binding
+        return unless binding
+
+        Thread.current[IN_TRACKER_KEY] = true
+        begin
+          current = extract_locals(binding)
+          prev = Thread.current[THREAD_KEY]
+          prev_path = Thread.current[THREAD_PATH_KEY]
+          # Only diff when we're in the same file (avoid cross-scope false positives)
+          if prev && prev_path == path
+            diff_and_emit(prev, current, tp)
+          end
+          Thread.current[THREAD_KEY] = current
+          Thread.current[THREAD_PATH_KEY] = path
+        ensure
+          Thread.current[IN_TRACKER_KEY] = false
+        end
+      end
+
+      def clear_state!
+        Thread.current[THREAD_KEY] = nil
+        Thread.current[THREAD_PATH_KEY] = nil
+      end
+
+      private
+
+      def extract_locals(binding)
+        return {} unless binding.respond_to?(:local_variables)
+
+        binding.local_variables.each_with_object({}) do |name, h|
+          next if SKIP_VARS.include?(name.to_s)
+          next if name.to_s.start_with?('_')
+
+          begin
+            h[name] = binding.local_variable_get(name)
+          rescue StandardError
+            # Some vars (e.g. from C extensions) may not be readable
+          end
+        end
+      end
+
+      def diff_and_emit(prev, current, tp)
+        changed = current.select do |name, new_val|
+          prev_val = prev[name]
+          !values_equal?(prev_val, new_val)
+        end
+        return if changed.empty?
+
+        changed.each do |name, new_val|
+          prev_val = prev[name]
+          emit_observe(name, prev_val, new_val, tp)
+        end
+      end
+
+      def values_equal?(a, b)
+        return true if a.equal?(b)
+        return a == b if a.nil? || b.nil?
+
+        a == b
+      rescue StandardError
+        false
+      end
+
+      def emit_observe(name, input, output, tp)
+        return unless (input.nil? || trackable_value?(input)) && (output.nil? || trackable_value?(output))
+
+        detail = "#{name} changed"
+        payload = {
+          input: format_value(input),
+          output: format_value(output)
+        }
+        Recorder.add_span(
+          category: :custom,
+          operation: 'observe',
+          detail: detail,
+          payload: payload,
+          duration_ms: 0,
+          started_at: Time.now
+        )
+      end
+
+      def format_value(val)
+        return nil if val.nil?
+
+        Dontbugme.send(:format_output_value, val)
+      rescue StandardError
+        val.class.name
+      end
+
+      def trackable_value?(val)
+        return true if val.nil?
+        return true if TRACKABLE_CLASSES.any? { |c| val.is_a?(c) }
+        return true if val.is_a?(Array) && val.size <= 10 && val.all? { |v| trackable_value?(v) }
+        return true if val.is_a?(Hash) && val.size <= 10 && val.values.all? { |v| trackable_value?(v) }
+
+        false
+      end
+    end
+  end
+end

data/lib/dontbugme/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dontbugme
-  VERSION = '0.1.5'
+  VERSION = '0.1.7'
 end

data/lib/dontbugme.rb

@@ -48,6 +48,16 @@ module Dontbugme
       result
     end
 
+    # Captures input and output of in-house calculations for value transformation inspection.
+    # Example: token = Dontbugme.observe('token increment', token) { token + 1 }
+    def observe(name, input = nil, &block)
+      return yield unless Context.active?
+
+      payload = {}
+      payload[:input] = format_output_value(input) unless input.nil?
+      span(name, payload: payload, capture_output: true, &block)
+    end
+
     def snapshot(data)
       return unless Context.active?
 
@@ -136,6 +146,7 @@ end
 require 'dontbugme/version'
 require 'dontbugme/configuration'
 require 'dontbugme/span'
+require 'dontbugme/variable_tracker'
 require 'dontbugme/span_collection'
 require 'dontbugme/trace'
 require 'dontbugme/context'
@@ -149,6 +160,7 @@ require 'dontbugme/subscribers/cache'
 require 'dontbugme/subscribers/action_mailer'
 require 'dontbugme/subscribers/active_job'
 require 'dontbugme/store/base'
+require 'dontbugme/store/json_safe'
 require 'dontbugme/store/memory'
 require 'dontbugme/store/sqlite'
 require 'dontbugme/store/postgresql'

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

@@ -8,6 +8,9 @@ Dontbugme.configure do |config|
   # config.enable_web_ui = true
   # config.web_ui_mount_path = "/inspector"
 
+  # Automatic variable tracking (dev only): captures input/output for local var changes
+  # config.capture_variable_changes = true
+
   # Production: use PostgreSQL, async writes, selective recording
   # config.store = :postgresql
   # config.async_store = true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dontbugme
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - Inspector Contributors
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-02-28 00:00:00.000000000 Z
+date: 2026-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -149,6 +149,7 @@ files:
 - lib/dontbugme/span_collection.rb
 - lib/dontbugme/store/async.rb
 - lib/dontbugme/store/base.rb
+- lib/dontbugme/store/json_safe.rb
 - lib/dontbugme/store/memory.rb
 - lib/dontbugme/store/postgresql.rb
 - lib/dontbugme/store/sqlite.rb
@@ -160,6 +161,7 @@ files:
 - lib/dontbugme/subscribers/net_http.rb
 - lib/dontbugme/subscribers/redis.rb
 - lib/dontbugme/trace.rb
+- lib/dontbugme/variable_tracker.rb
 - lib/dontbugme/version.rb
 - lib/generators/dontbugme/install/install_generator.rb
 - lib/generators/dontbugme/install/templates/dontbugme.rb