dontbugme 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f71bd0ef418ea0d47ca94a5242d3677a00d82cf36e2fd0d8b69f3f4ce323f9c
-  data.tar.gz: c9692d06855f24fc322e218588958881a0a8d9ee4b278125961143b7527fdf3a
+  metadata.gz: 9433798398dd8fdefaec811b7f52b310fcbb57febcc03a44fc2eaf94acd4ab2c
+  data.tar.gz: a513ab24f0d08c91ffa941dbbc81b326a6c240052fbac9b1c8b4a0111a0d4257
 SHA512:
-  metadata.gz: 85e2c35aa316839754b10c22353ef1b89970c893f78f537708fce9a5af7653c4532219a98bd035c833bfdc9e3f3d4fbd3c61a6ad8fb9f60a6d8bff2f1a301511
-  data.tar.gz: 646af28b63c0f177fcc68b48c0892f3a92c0b1dd102aad33b70d2c54915b85fa325bdcf5b6661c4e2b8c5b13af735d10a6b088643df9335f8967ab8569e918b9
+  metadata.gz: 10dd8c9e2263610d647a66d92eabb0d56760f524e684b7f9c9984465b398f48391d43caac9ff7caba3684a5d3e22bf0b3fa1f14fa65f2afba45ddc7ec7114360
+  data.tar.gz: 9dc17d45129c997152ac4d842b337a813a3ed184dea61598ecb496cbd9a732c391e6c2424a32e94dfdae221eafff208c1899560f27f326982477907ed9726c85

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/version.rb

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

data/lib/dontbugme.rb

@@ -160,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'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dontbugme
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Inspector Contributors
@@ -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