closeyourit-ruby 0.3.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fce4d4eb3a92009bf70daeb903091ec30b4274d926b52d5b8df44644a808c35e
-  data.tar.gz: be83377677c8567c700d8ba5d6a47aa1664474db87aa750ab8a61dbed85fadb2
+  metadata.gz: 6dc227e626e4b47b931a80698aa8b2567bacb033dad2e5e42d6c8497890debe2
+  data.tar.gz: d012c3b1272b238e796ff7cdb1cf687276932a0c5196f14fbd0d5393edf9d938
 SHA512:
-  metadata.gz: 4533f36e714d2c8ac1706a8bdce8652beed02384f0ce09f5965679c0d76a5e098b5ed006530bc88bbc4c92ed982ed373bd9dd5d5db04cf015770949deebe3e00
-  data.tar.gz: 3500e6f71ea42ba8bb900d78dabde73941913e5b03459ab0f2e570b27c26b6637df27a786d5ea1eb6e63b7ffcb8c8b84d07b6299d5553d5711ea3700543449dd
+  metadata.gz: c4cd8b4aaa3cb4ff246d2607d3f65ec71c696c37b8ccb9525979c99175bcf5f1c35f051574d034b8cb7198fb62362c2683e74e076989cf3e2ea3ae34408385a7
+  data.tar.gz: 0b54035901e710005c1cc45339a30f0df0277e0d0708c9faff417a536eba0000b77b2a2bbb9c7b608b8528b4ac04b65f7f16b31dbd8320ec1e2d37f9465db2a4

data/README.md

@@ -26,12 +26,12 @@ Caratteristiche:
 
 ## Installazione
 
-Uso interno → install via git o path (no RubyGems):
+Pubblicata su [RubyGems](https://rubygems.org/gems/closeyourit-ruby):
 
 ```ruby
 # Gemfile del progetto da monitorare
-gem "closeyourit-ruby", git: "https://github.com/bussolabs/closeyourit-ruby"
-# in sviluppo locale:
+gem "closeyourit-ruby"
+# in sviluppo locale, dal checkout:
 # gem "closeyourit-ruby", path: "../closeyourit-ruby"
 ```
 

data/lib/closeyourit/configuration.rb

@@ -20,7 +20,8 @@ module CloseYourIt
                   :slow_query_threshold_ms, :slow_method_threshold_ms,
                   :send_pii, :obfuscate_sql, :send_server_name,
                   :capture_query_bindings, :capture_method_arguments,
-                  :capture_request, :request_header_allowlist,
+                  :capture_request, :request_header_allowlist, :context_lines,
+                  :capture_request_body,
                   :breadcrumbs_enabled, :max_breadcrumbs, :sample_rate,
                   :capture_handled_errors, :report_active_job_errors,
                   :logs_enabled, :logs_sample_rate, :logs_batch_size, :logs_flush_interval,
@@ -55,6 +56,14 @@ module CloseYourIt
       @capture_request          = true
       @request_header_allowlist = DEFAULT_REQUEST_HEADER_ALLOWLIST.dup
 
+      # Righe di sorgente attorno a ogni frame dello stacktrace (pre/context/post). 0 = disattivo.
+      @context_lines = 3
+
+      # Params del body della richiesta nell'evento (`request.data`), estratti LAZY solo quando
+      # l'errore accade, sanitizzati e scrubbati (denylist + filter_parameters). Il backend
+      # ri-scruba difensivamente. Upload → placeholder, cap 64 KB.
+      @capture_request_body = true
+
       # Breadcrumbs: cronologia (query offuscate, eventi custom) allegata all'errore.
       @breadcrumbs_enabled = true
       @max_breadcrumbs     = 100

data/lib/closeyourit/events/error_event.rb

@@ -4,6 +4,7 @@ require "securerandom"
 require "socket"
 require_relative "../event"
 require_relative "../scrubber"
+require_relative "../line_cache"
 
 module CloseYourIt
   # Trasforma un'eccezione Ruby nel **payload evento Sentry** che il backend CloseYourIt ingerisce
@@ -72,21 +73,35 @@ module CloseYourIt
       }
     end
 
-    # Sentry-style: frame più recente per ultimo; chiavi filename/function/lineno/in_app/abs_path.
+    # Sentry-style: frame più recente per ultimo; chiavi filename/function/lineno/in_app/abs_path
+    # + snippet di sorgente (pre_context/context_line/post_context) quando il file è leggibile.
     def frames(locations)
       return [] if locations.nil?
 
+      context_lines = @configuration.context_lines.to_i
       locations.reverse.map do |loc|
-        {
+        frame = {
           "filename" => loc.path,
           "abs_path" => loc.path,
           "function" => loc.label,
           "lineno" => loc.lineno,
           "in_app" => in_app?(loc.path)
         }
+        add_context!(frame, loc.path, loc.lineno, context_lines) if context_lines.positive?
+        frame
       end
     end
 
+    def add_context!(frame, path, lineno, count)
+      lines = LineCache.lines(path)
+      return if lines.nil? || lineno.nil? || lineno < 1 || lineno > lines.size
+
+      index = lineno - 1
+      frame["pre_context"]  = lines[[ index - count, 0 ].max...index]
+      frame["context_line"] = lines[index]
+      frame["post_context"] = lines[index + 1, count] || []
+    end
+
     def in_app?(path)
       return false if path.nil?
 

data/lib/closeyourit/line_cache.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module CloseYourIt
+  # Cache in-process delle righe dei file sorgente, per le context lines dei frame
+  # (pre_context/context_line/post_context). Bounded: oltre MAX_FILES si svuota per intero —
+  # semplice e sufficiente (i file di un'app in errore sono pochi e ricorrenti). Thread-safe.
+  module LineCache
+    MAX_FILES = 200
+
+    @cache = {}
+    @mutex = Mutex.new
+
+    class << self
+      # Righe del file (chomp-ate), oppure nil se non leggibile o path sintetico ("(eval)", "(irb)").
+      def lines(path)
+        return nil if path.nil? || path.empty? || path.start_with?("(")
+
+        @mutex.synchronize do
+          return @cache[path] if @cache.key?(path)
+
+          @cache.clear if @cache.size >= MAX_FILES
+          @cache[path] = read_lines(path)
+        end
+      end
+
+      def clear
+        @mutex.synchronize { @cache.clear }
+      end
+
+      private
+
+      def read_lines(path)
+        return nil unless File.readable?(path)
+
+        File.readlines(path, chomp: true)
+      rescue StandardError
+        nil
+      end
+    end
+  end
+end

data/lib/closeyourit/rails/request_body.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require "json"
+require "uri"
+require_relative "../scrubber"
+
+module CloseYourIt
+  module Rails
+    # Estrae i params del body della richiesta (`request.data`) al momento dell'EVENTO — mai
+    # eagerly a ogni richiesta (zero overhead sul percorso felice). Preferisce i params già
+    # parsati da Rails/Rack presenti in env; ripiega sulla rilettura di rack.input (con rewind)
+    # solo per JSON/form ≤ MAX_BODY_BYTES. Output sanitizzato (upload → "[FILE: …]", oggetti →
+    # "[OBJECT: …]", stringhe troncate) e scrubbato con la stessa denylist del resto del client.
+    module RequestBody
+      MAX_BODY_BYTES = 65_536
+      MAX_DEPTH = 8
+      MAX_STRING = 1024
+
+      FORM_TYPE = "application/x-www-form-urlencoded"
+      JSON_TYPE = "application/json"
+
+      class << self
+        def extract(env)
+          params = parsed_params(env) || raw_params(env)
+          return nil if params.nil? || params.empty?
+
+          Scrubber.new(CloseYourIt.configuration).filter_params(sanitize(params, 0))
+        rescue StandardError
+          nil
+        end
+
+        private
+
+        # Params già parsati a monte (ActionDispatch o Rack): nessuna rilettura del body.
+        def parsed_params(env)
+          env["action_dispatch.request.request_parameters"] || env["rack.request.form_hash"]
+        end
+
+        def raw_params(env)
+          raw = read_body(env)
+          return nil if raw.nil? || raw.empty?
+
+          case env["CONTENT_TYPE"].to_s.split(";").first.to_s.strip.downcase
+          when JSON_TYPE
+            value = JSON.parse(raw)
+            value.is_a?(Hash) ? value : { "_json" => value }
+          when FORM_TYPE
+            # Fallback flat (stdlib): il percorso reale con nesting passa dai params già parsati.
+            URI.decode_www_form(raw).to_h
+          end
+        rescue JSON::ParserError, ArgumentError
+          nil
+        end
+
+        def read_body(env)
+          input = env["rack.input"]
+          return nil if input.nil?
+
+          length = env["CONTENT_LENGTH"].to_i
+          return nil if length <= 0 || length > MAX_BODY_BYTES
+
+          input.rewind if input.respond_to?(:rewind)
+          raw = input.read(MAX_BODY_BYTES)
+          input.rewind if input.respond_to?(:rewind)
+          raw
+        end
+
+        def sanitize(value, depth)
+          return "[TRUNCATED]" if depth > MAX_DEPTH
+
+          case value
+          when Hash    then value.each_with_object({}) { |(key, val), acc| acc[key.to_s] = sanitize(val, depth + 1) }
+          when Array   then value.map { |item| sanitize(item, depth + 1) }
+          when String  then value.size > MAX_STRING ? "#{value[0, MAX_STRING]}…" : value
+          when Numeric, true, false, nil then value
+          else
+            if value.respond_to?(:original_filename)
+              "[FILE: #{value.original_filename}]"
+            else
+              "[OBJECT: #{value.class.name}]"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/closeyourit/rails/request_context.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "securerandom"
+require "rack/utils"
 
 module CloseYourIt
   module Rails
@@ -12,6 +13,10 @@ module CloseYourIt
       # Header con prefisso non-HTTP_ in env Rack.
       RAW_HEADERS = %w[CONTENT_TYPE CONTENT_LENGTH].freeze
 
+      # Cookie di correlazione scritto dal browser SDK (session replay): id opaco della
+      # sessione di replay, trasportato da ogni richiesta same-origin.
+      REPLAY_COOKIE = "cyi_replay"
+
       def initialize(app)
         @app = app
       end
@@ -20,7 +25,14 @@ module CloseYourIt
         if enabled?
           # trace_id sempre (correlazione log↔errori), anche con capture_request OFF.
           CloseYourIt::Scope.current.trace_id = trace_id_for(env)
-          CloseYourIt::Scope.current.request = build_request(env) if CloseYourIt.configuration.capture_request
+          # Correlazione errore server ↔ session replay: l'id dal cookie finisce sullo scope
+          # → contexts.replay.replay_id dell'evento (stesso punto del percorso JS).
+          CloseYourIt::Scope.current.replay_session_id = replay_session_id_for(env)
+          if CloseYourIt.configuration.capture_request
+            CloseYourIt::Scope.current.request = build_request(env)
+            # Riferimento all'env per l'estrazione LAZY del body (request.data) a evento costruito.
+            CloseYourIt::Scope.current.rack_env = env
+          end
         end
         @app.call(env)
       ensure
@@ -43,6 +55,14 @@ module CloseYourIt
           SecureRandom.uuid
       end
 
+      # Estrae `cyi_replay` dal cookie della richiesta (nil se assente). Rack puro.
+      def replay_session_id_for(env)
+        cookie = env["HTTP_COOKIE"]
+        return nil if cookie.nil? || cookie.empty?
+
+        Rack::Utils.parse_cookies_header(cookie)[REPLAY_COOKIE].to_s.then { |id| id.empty? ? nil : id }
+      end
+
       # Forma `request` Sentry. URL senza query string; header solo dall'allowlist (mai
       # Authorization/Cookie). query_string + IP solo con send_pii (opt-in).
       def build_request(env)

data/lib/closeyourit/scope.rb

@@ -35,7 +35,7 @@ module CloseYourIt
       end
     end
 
-    attr_accessor :request, :trace_id
+    attr_accessor :request, :trace_id, :rack_env, :replay_session_id
     attr_reader :user, :tags, :extra, :contexts, :breadcrumbs
 
     def initialize
@@ -78,7 +78,9 @@ module CloseYourIt
       @extra       = {}
       @contexts    = {}
       @request     = nil
+      @rack_env    = nil
       @trace_id    = nil
+      @replay_session_id = nil
       @breadcrumbs = BreadcrumbBuffer.new(CloseYourIt.configuration.max_breadcrumbs)
       @performance_profile = nil
     end
@@ -92,14 +94,23 @@ module CloseYourIt
         "user"        => serialize_user,
         "tags"        => scrub(presence(@tags)),
         "extra"       => scrub(presence(@extra)),
-        "contexts"    => scrub(presence(@contexts)),
-        "request"     => @request,
+        "contexts"    => contexts_payload,
+        "request"     => request_payload,
         "breadcrumbs" => breadcrumbs_payload
       }.reject { |_key, value| value.nil? }
     end
 
     private
 
+    # contexts utente + `replay.replay_id` (session replay) quando presente sullo scope: il
+    # backend legge contexts.replay.replay_id per legare l'errore server al video (stesso punto
+    # del percorso JS). replay/replay_id non sono chiavi sensibili → sopravvivono allo Scrubber.
+    def contexts_payload
+      merged = @contexts.dup
+      merged["replay"] = { "replay_id" => @replay_session_id } if @replay_session_id
+      scrub(presence(merged))
+    end
+
     # Redige i valori delle chiavi sensibili preservando la struttura (es. contexts.runtime resta
     # intatto, solo i valori sotto chiavi sensibili diventano [FILTERED]). Riusa lo Scrubber della
     # configurazione, lo stesso percorso di breadcrumb.data e degli attributi di log.
@@ -109,6 +120,24 @@ module CloseYourIt
       Scrubber.new(CloseYourIt.configuration).filter_params(hash)
     end
 
+    # Request context + body params (`request.data`) estratti LAZY qui — cioè solo quando un
+    # evento viene davvero costruito, mai sul percorso felice della richiesta.
+    def request_payload
+      return nil if @request.nil?
+
+      data = request_body_data
+      data ? @request.merge("data" => data) : @request
+    end
+
+    def request_body_data
+      return nil unless CloseYourIt.configuration.capture_request_body
+      return nil if @rack_env.nil?
+
+      Rails::RequestBody.extract(@rack_env)
+    rescue StandardError
+      nil
+    end
+
     # `user.id` sempre; email/ip_address/username solo con `send_pii` (il backend li strippa
     # comunque — difesa in profondità).
     def serialize_user

data/lib/closeyourit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CloseYourIt
-  VERSION = "0.3.4"
+  VERSION = "0.5.0"
 end

data/lib/closeyourit-ruby.rb

@@ -28,6 +28,7 @@ require_relative "closeyourit/monitor"
 require_relative "closeyourit/client"
 require_relative "closeyourit/rails/capture_exceptions"
 require_relative "closeyourit/rails/request_context"
+require_relative "closeyourit/rails/request_body"
 require_relative "closeyourit/rails/log_broadcast"
 require_relative "closeyourit/rails/net_http_patch"
 require_relative "closeyourit/rails/active_job_extension"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: closeyourit-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Alessio Bussolari
@@ -47,6 +47,7 @@ files:
 - lib/closeyourit/events/slow_method_event.rb
 - lib/closeyourit/events/slow_query_event.rb
 - lib/closeyourit/instrumenter.rb
+- lib/closeyourit/line_cache.rb
 - lib/closeyourit/log_buffer.rb
 - lib/closeyourit/log_device.rb
 - lib/closeyourit/monitor.rb
@@ -59,6 +60,7 @@ files:
 - lib/closeyourit/rails/net_http_patch.rb
 - lib/closeyourit/rails/query_source.rb
 - lib/closeyourit/rails/railtie.rb
+- lib/closeyourit/rails/request_body.rb
 - lib/closeyourit/rails/request_context.rb
 - lib/closeyourit/scope.rb
 - lib/closeyourit/scrubber.rb