exis_ray 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fd6ad63299e12bd9398e3ccc0436ee48d70f21705cfbdfac492fc97a8fda5af
-  data.tar.gz: 6cea90be719f5d1b85a9dee5cd281ba24cde652b76f6e16b1f07aa3da72ea255
+  metadata.gz: 1a158ad57fc2696906e60524f77c37652db5e84029c833cf9f33d1526f3aa91c
+  data.tar.gz: 428a2aafeaa742329aed3b39c6b86741af0b36b6e0f33ab037ae7fbf64911cbe
 SHA512:
-  metadata.gz: cbb1b60e287ba40f586c8404d4e5c9914b318090cffb1d0fc9d12ac8c27498004b019190eaaf33cfe35bb63927a016dc26a5973990401e32f0a6b4be69e7b43d
-  data.tar.gz: 806578528228d964297e68109f75f6485f901bc22919e04d22cb2a794348d9687f9f1c235441756e245f14cd60eaad41b3898c4fc4ed21328c7e3a023dce8fd1
+  metadata.gz: 07de5f2488be3ba52d8ad663bb43535b5979aa15db6a25dea2523e2453ec5aff9d7225ce02428711b71c7592410a53c1827d3dee2a0cc064fb98cd734d790057
+  data.tar.gz: 157d67c0de961846d7a62441adc4cc8fdfcea70df8e1a5b716fa0699555e4ab7ffd26bd74acadfef331a8ffbca477e3bfc6f49bb54af8874941ee4d643cdad6e

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+## [0.3.3] - 2026-03-23
+
+### Fixed
+- **`ActiveResourceInstrumentation` header incorrecto:** Se corrigió el uso de `trace_header` (formato Rack, ej: `HTTP_X_AMZN_TRACE_ID`) para requests salientes. Ahora se usa `propagation_trace_header` (formato HTTP, ej: `X-Amzn-Trace-Id`), igual que `FaradayMiddleware`. Antes, los microservicios downstream recibían un header con nombre incorrecto y la traza distribuida no se propagaba.
+- **Header injection en `Current` setters:** Los valores asignados a `user_id=`, `isp_id=` y `correlation_id=` ahora son sanitizados antes de escribirse en `ActiveResource::Base.headers`. Se eliminan caracteres CRLF (`\r\n`) para prevenir HTTP header injection hacia otros microservicios.
+- **`Reporter` exponía datos sensibles a Sentry:** `build_from_current` enviaba `user.as_json` completo (incluyendo `password_digest`, tokens, etc.) al contexto de Sentry. Ahora el comportamiento por defecto es enviar solo `{ id: }`. Se exponen los hooks `sentry_user_context` y `sentry_isp_context` para que la app host controle qué campos incluir.
+- **Reloj de pared en cálculo de duración:** `Tracer.created_at` y `current_duration_ms` usaban `Time.now` (afectado por NTP/leap seconds). Ahora usan `Process.clock_gettime(Process::CLOCK_MONOTONIC)` en todos los puntos de asignación (`HttpMiddleware`, `Sidekiq::ServerMiddleware`, `TaskMonitor`) y en el cálculo de duración.
+- **`generate_new_root` ignoraba sufijos no numéricos:** El sufijo del pod/hostname se convertía con `.to_i`, retornando siempre `0` para strings alfanuméricos (ej: `"worker01"` → `00000000`). Ahora se codifican los bytes del string directamente a hex, preservando la unicidad del identificador.
+- **`JsonFormatter#parse_kv_string` crash con quote suelto:** Un valor de un solo caracter `"` provocaba que `value[1..-2]` retornara `nil` y `.gsub` explotara con `NoMethodError`. Corregido con `|| ""` como fallback.
+- **Pérdida silenciosa de mensaje en `JsonFormatter`:** Si `kv_string?` detectaba un string como kv pero `parse_kv_string` no extraía ningún par (ej: `"key="`), el mensaje original desaparecía del JSON sin ir al campo `message`. Ahora cae al fallback correctamente.
+- **`TaskMonitor#log_event` podía enmascarar excepciones del negocio:** Si el logger fallaba dentro de `log_event`, su excepción reemplazaba la excepción original de la tarea. Ahora `log_event` está protegido con `rescue StandardError` interno.
+- **`current_class` y `reporter_class` resueltos dos veces en `ensure`:** En `Sidekiq::ServerMiddleware` y `TaskMonitor`, el bloque `ensure` llamaba `safe_constantize` dos veces por clase. Ahora se asigna a variable local antes del `ensure`.
+
+### Changed
+- **`sentry_user_context` y `sentry_isp_context` como hooks públicos en `Reporter`:** La subclase puede sobreescribir estos métodos para definir exactamente qué atributos del modelo se envían a Sentry, sin exponer datos sensibles por defecto.
+
+### Performance
+- **Memoización de `current_class` y `reporter_class` en producción:** En entornos con `cache_classes=true`, la resolución vía `safe_constantize` se ejecuta una sola vez. En desarrollo se sigue resolviendo por request para respetar el reloading de Zeitwerk.
+- **Regex de `JsonFormatter` extraídas a constantes:** `KV_DETECT_RE` y `KV_PARSE_RE` son ahora constantes de clase, eliminando recompilaciones innecesarias en cada línea de log.
+- **`Current#user` e `Current#isp` usan sentinel para cachear `nil`:** Si `find_by` no encuentra el registro, el resultado se cachea con un objeto sentinel `NOT_FOUND`. Las llamadas subsiguientes retornan `nil` sin consultar la DB.
+- **`Sidekiq::ClientMiddleware` resuelve `current_class` una sola vez** por job encolado en lugar de cuatro veces.
+
 ## [0.3.2] - 2026-03-23
 
 ### Added

data/README.md

@@ -102,6 +102,26 @@ class Choto < ExisRay::Reporter
 end
 ```
 
+#### Controlling what user/ISP data is sent to Sentry
+
+By default, ExisRay only sends `{ id: }` to Sentry for both user and ISP contexts. This is intentional — sending `user.as_json` without restrictions would expose sensitive attributes (`password_digest`, `reset_password_token`, etc.) to a third-party service.
+
+To include additional fields, override the hooks in your subclass:
+
+```ruby
+class Choto < ExisRay::Reporter
+  def self.sentry_user_context(current)
+    { id: current.user_id, email: current.user&.email, role: current.user&.role }
+  end
+
+  def self.sentry_isp_context(current)
+    { id: current.isp_id, name: current.isp&.name }
+  end
+end
+```
+
+> **Important:** never include attributes like `password_digest`, tokens, or secrets in these methods.
+
 ### 3. Hydrate Context (Controller)
 
 In your `ApplicationController`, verify the incoming request and set the context. ExisRay handles the Trace ID automatically, you just handle the Business Logic.

data/lib/exis_ray/active_resource_instrumentation.rb

@@ -25,8 +25,9 @@ module ExisRay
         # Generamos el string propagable: "Root=...;Parent=...;Sampled=..."
         trace_header_value = ExisRay::Tracer.generate_trace_header
 
-        # Buscamos la key configurada (ej: 'HTTP_X_AMZN_TRACE_ID' o custom)
-        trace_header_key = ExisRay.configuration.trace_header
+        # Usamos el header de propagación (formato HTTP, ej: 'X-Amzn-Trace-Id'),
+        # NO el trace_header que es formato Rack (HTTP_X_AMZN_TRACE_ID) para lectura entrante.
+        trace_header_key = ExisRay.configuration.propagation_trace_header
 
         # Retornamos un nuevo hash combinado (merge) para no mutar el original por error
         original_headers.merge(trace_header_key => trace_header_value)

data/lib/exis_ray/current.rb

@@ -6,10 +6,14 @@ module ExisRay
   class Current < ActiveSupport::CurrentAttributes
     attribute :user_id, :isp_id, :correlation_id
 
+    # Sentinel para distinguir "no consultado" de "consultado y no encontrado".
+    # Evita re-queries a la DB cuando el objeto no existe.
+    NOT_FOUND = Object.new.freeze
+
     # Callback nativo de Rails: Se ejecuta automáticamente al llamar a Current.reset
     resets do
-      @user = nil
-      @isp  = nil
+      @user = NOT_FOUND
+      @isp  = NOT_FOUND
 
       if defined?(PaperTrail)
         PaperTrail.request.whodunnit = nil
@@ -28,7 +32,7 @@ module ExisRay
     def user_id=(id)
       super
       if defined?(ActiveResource::Base)
-        ActiveResource::Base.headers['UserId'] = id.to_s
+        ActiveResource::Base.headers['UserId'] = sanitize_header_value(id)
       end
       if defined?(PaperTrail)
         PaperTrail.request.whodunnit = id
@@ -37,9 +41,9 @@ module ExisRay
 
     def isp_id=(id)
       super
-      @isp = nil # Invalida cache
+      @isp = NOT_FOUND # Invalida cache
       if defined?(ActiveResource::Base)
-        ActiveResource::Base.headers['IspId'] = id.to_s
+        ActiveResource::Base.headers['IspId'] = sanitize_header_value(id)
       end
     end
 
@@ -51,7 +55,7 @@ module ExisRay
       end
 
       if defined?(ActiveResource::Base)
-        ActiveResource::Base.headers['CorrelationId'] = id.to_s
+        ActiveResource::Base.headers['CorrelationId'] = sanitize_header_value(id)
       end
 
       if defined?(PaperTrail)
@@ -68,33 +72,35 @@ module ExisRay
     # Estos métodos asumen que la app host tiene modelos ::User e ::Isp
 
     def user=(object)
-      @user = object
+      @user = object || NOT_FOUND
       self.user_id = object&.id
     end
 
     def user
-      return @user if defined?(@user) && @user
+      @user = NOT_FOUND unless defined?(@user)
+      return nil if @user.equal?(NOT_FOUND) && !user_id
 
-      if user_id && defined?(::User) && ::User.respond_to?(:find_by)
-        @user = ::User.find_by(id: user_id)
-      else
-        nil
+      if @user.equal?(NOT_FOUND)
+        @user = (defined?(::User) && ::User.respond_to?(:find_by) ? ::User.find_by(id: user_id) : nil) || NOT_FOUND
       end
+
+      @user.equal?(NOT_FOUND) ? nil : @user
     end
 
     def isp=(object)
-      @isp = object
+      @isp = object || NOT_FOUND
       self.isp_id = object&.id
     end
 
     def isp
-      return @isp if defined?(@isp) && @isp
+      @isp = NOT_FOUND unless defined?(@isp)
+      return nil if @isp.equal?(NOT_FOUND) && !isp_id
 
-      if isp_id && defined?(::Isp) && ::Isp.respond_to?(:find_by)
-        @isp = ::Isp.find_by(id: isp_id)
-      else
-        nil
+      if @isp.equal?(NOT_FOUND)
+        @isp = (defined?(::Isp) && ::Isp.respond_to?(:find_by) ? ::Isp.find_by(id: isp_id) : nil) || NOT_FOUND
       end
+
+      @isp.equal?(NOT_FOUND) ? nil : @isp
     end
 
     def user?
@@ -108,5 +114,14 @@ module ExisRay
     def correlation_id?
       correlation_id.present?
     end
+
+    private
+
+    # Elimina caracteres CRLF para prevenir HTTP header injection.
+    # Un valor con "\r\n" en un header de ActiveResource podría inyectar
+    # headers arbitrarios en requests hacia otros microservicios.
+    def sanitize_header_value(value)
+      value.to_s.gsub(/[\r\n]/, '')
+    end
   end
 end

data/lib/exis_ray/http_middleware.rb

@@ -8,7 +8,7 @@ module ExisRay
 
     def call(env)
       # 1. Hidratar Infraestructura
-      ExisRay::Tracer.created_at = Time.now.utc.to_f
+      ExisRay::Tracer.created_at = Process.clock_gettime(Process::CLOCK_MONOTONIC)
       ExisRay::Tracer.source     = "http"
 
       trace_header_key = ExisRay.configuration.trace_header

data/lib/exis_ray/json_formatter.rb

@@ -15,10 +15,16 @@ module ExisRay
   # Automáticamente inyecta el contexto de trazabilidad ({ExisRay::Tracer})
   # y el contexto de negocio ({ExisRay::Current}) en cada línea de log.
   class JsonFormatter < ::Logger::Formatter
-    # Solución al NoMethodError: Garantiza que el formateador sea compatible 
+    # Solución al NoMethodError: Garantiza que el formateador sea compatible
     # con el wrapper de ActiveSupport::TaggedLogging de Rails.
     include ActiveSupport::TaggedLogging::Formatter if defined?(ActiveSupport::TaggedLogging::Formatter)
 
+    # Detecta si un string comienza con al menos un par key=value.
+    KV_DETECT_RE = /\A\w+=/
+
+    # Extrae pares key=value de un string. Soporta valores sin espacios o entre comillas dobles.
+    KV_PARSE_RE  = /(\w+)=("(?:[^"\\]|\\.)*"|\S+)/
+
     # Procesa un mensaje de log y lo formatea como una cadena estructurada en JSON.
     #
     # @param severity [String] El nivel de severidad del log (ej. "INFO", "ERROR", "DEBUG").
@@ -99,7 +105,8 @@ module ExisRay
       if msg.is_a?(Hash)
         payload.merge!(msg)
       elsif msg.is_a?(String) && kv_string?(msg)
-        payload.merge!(parse_kv_string(msg))
+        parsed = parse_kv_string(msg)
+        parsed.empty? ? payload[:message] = msg : payload.merge!(parsed)
       else
         payload[:message] = msg.to_s
       end
@@ -111,7 +118,7 @@ module ExisRay
     # @param str [String]
     # @return [Boolean]
     def kv_string?(str)
-      str.match?(/\A\w+=/)
+      str.match?(KV_DETECT_RE)
     end
 
     # Parsea un string con formato key=value y retorna un Hash.
@@ -121,8 +128,8 @@ module ExisRay
     # @return [Hash]
     def parse_kv_string(str)
       result = {}
-      str.scan(/(\w+)=("(?:[^"\\]|\\.)*"|\S+)/) do |key, value|
-        result[key.to_sym] = value.start_with?('"') ? value[1..-2].gsub('\\"', '"') : value
+      str.scan(KV_PARSE_RE) do |key, value|
+        result[key.to_sym] = value.start_with?('"') ? (value[1..-2] || "").gsub('\\"', '"') : value
       end
       result
     end

data/lib/exis_ray/reporter.rb

@@ -172,16 +172,37 @@ module ExisRay
       add_tags(isp_id: klass.isp_id)   if klass.respond_to?(:isp_id?)  && klass.isp_id?
 
       if klass.respond_to?(:user) && klass.user.present?
-        user_json = klass.user.respond_to?(:as_json) ? klass.user.as_json : { id: klass.user_id }
-        add_context(user: user_json)
+        add_context(user: sentry_user_context(klass))
       end
 
       if klass.respond_to?(:isp) && klass.isp.present?
-        isp_json = klass.isp.respond_to?(:as_json) ? klass.isp.as_json : { id: klass.isp_id }
-        add_context(isp: isp_json)
+        add_context(isp: sentry_isp_context(klass))
       end
     end
 
+    # Hook para que la app host controle qué datos del usuario se envían a Sentry.
+    # Por defecto solo se envía el ID para evitar exponer datos sensibles (password_digest, tokens, etc.).
+    #
+    # @example Sobreescribir en la subclase del Reporter de la app
+    #   def self.sentry_user_context(current)
+    #     { id: current.user_id, email: current.user&.email }
+    #   end
+    #
+    # @param current [Class] La clase Current resuelta.
+    # @return [Hash]
+    def self.sentry_user_context(current)
+      { id: current.user_id }
+    end
+
+    # Hook para que la app host controle qué datos del ISP se envían a Sentry.
+    # Por defecto solo se envía el ID.
+    #
+    # @param current [Class] La clase Current resuelta.
+    # @return [Hash]
+    def self.sentry_isp_context(current)
+      { id: current.isp_id }
+    end
+
     private_class_method :build_from_current, :build_from_tracer
   end
 end

data/lib/exis_ray/sidekiq/client_middleware.rb

@@ -14,11 +14,11 @@ module ExisRay
 
           # 2. Inyectamos el contexto de negocio (Current)
           # Esto permite saber qué Usuario o ISP disparó el job.
-          if ExisRay.current_class.present?
+          if (curr = ExisRay.current_class).present?
             context = {}
-            context[:user_id] = ExisRay.current_class.user_id if ExisRay.current_class.respond_to?(:user_id)
-            context[:isp_id]  = ExisRay.current_class.isp_id if ExisRay.current_class.respond_to?(:isp_id)
-            context[:correlation_id] = ExisRay.current_class.correlation_id if ExisRay.current_class.respond_to?(:correlation_id)
+            context[:user_id]        = curr.user_id        if curr.respond_to?(:user_id)
+            context[:isp_id]         = curr.isp_id         if curr.respond_to?(:isp_id)
+            context[:correlation_id] = curr.correlation_id if curr.respond_to?(:correlation_id)
 
             job['exis_ray_context'] = context
           end

data/lib/exis_ray/sidekiq/server_middleware.rb

@@ -32,8 +32,10 @@ module ExisRay
       ensure
         # Limpieza vital en Sidekiq para evitar fugas de contexto entre jobs en el mismo hilo.
         ExisRay::Tracer.reset
-        ExisRay.current_class&.reset  if ExisRay.current_class.respond_to?(:reset)
-        ExisRay.reporter_class&.reset if ExisRay.reporter_class.respond_to?(:reset)
+        current  = ExisRay.current_class
+        reporter = ExisRay.reporter_class
+        current.reset  if current&.respond_to?(:reset)
+        reporter.reset if reporter&.respond_to?(:reset)
       end
 
       private
@@ -44,7 +46,7 @@ module ExisRay
       # @param job [Hash] Payload de Sidekiq.
       # @return [void]
       def hydrate_tracer(worker, job)
-        ExisRay::Tracer.created_at = Time.now.utc.to_f
+        ExisRay::Tracer.created_at = Process.clock_gettime(Process::CLOCK_MONOTONIC)
         ExisRay::Tracer.sidekiq_job = worker.class.name
         ExisRay::Tracer.source      = "sidekiq"
 

data/lib/exis_ray/task_monitor.rb

@@ -41,8 +41,10 @@ module ExisRay
     ensure
       # Limpieza centralizada obligatoria para evitar filtraciones de memoria o contexto
       ExisRay::Tracer.reset
-      ExisRay.current_class&.reset  if ExisRay.current_class.respond_to?(:reset)
-      ExisRay.reporter_class&.reset if ExisRay.reporter_class.respond_to?(:reset)
+      current  = ExisRay.current_class
+      reporter = ExisRay.reporter_class
+      current.reset  if current&.respond_to?(:reset)
+      reporter.reset if reporter&.respond_to?(:reset)
     end
 
     # --- Métodos Privados ---
@@ -55,7 +57,7 @@ module ExisRay
       ExisRay::Tracer.task         = task_name.to_s
       ExisRay::Tracer.source       = "task"
       ExisRay::Tracer.request_id   = SecureRandom.uuid
-      ExisRay::Tracer.created_at   = Time.now.utc.to_f
+      ExisRay::Tracer.created_at   = Process.clock_gettime(Process::CLOCK_MONOTONIC)
 
       pod_id = get_pod_identifier
       ExisRay::Tracer.root_id = ExisRay::Tracer.send(:generate_new_root, pod_id)
@@ -93,6 +95,8 @@ module ExisRay
       else
         Rails.logger.send(level, "[ExisRay] #{message}")
       end
+    rescue StandardError
+      # El logger nunca debe interrumpir el flujo principal de la tarea.
     end
 
     private_class_method :get_pod_identifier, :setup_tracer, :execute_with_optional_tags, :log_event

data/lib/exis_ray/tracer.rb

@@ -59,7 +59,7 @@ module ExisRay
     # @return [Integer] Duración en ms.
     def self.current_duration_ms
       return 0 unless created_at
-      ((Time.now.utc.to_f - created_at) * 1000).round
+      ((Process.clock_gettime(Process::CLOCK_MONOTONIC) - created_at) * 1000).round
     end
 
     # Construye el header de trazabilidad para enviar al siguiente servicio.
@@ -89,7 +89,10 @@ module ExisRay
       timestamp_hex = Time.now.to_i.to_s(16)
 
       if suffix_id.present?
-        suffix_hex = suffix_id.to_i.to_s(16).rjust(8, '0')
+        # Codificamos los bytes del string a hex para preservar unicidad
+        # independientemente de si el sufijo es numérico o alfanumérico.
+        # Ej: "worker01" → "776f726b657230 31", "abc" → "616263"
+        suffix_hex = suffix_id.to_s.bytes.map { |b| b.to_s(16).rjust(2, '0') }.join.first(8).rjust(8, '0')
         unique_part = SecureRandom.hex(8) + suffix_hex
       else
         unique_part = SecureRandom.hex(12)

data/lib/exis_ray/version.rb

@@ -2,5 +2,5 @@
 
 module ExisRay
   # Versión actual de la gema.
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

data/lib/exis_ray.rb

@@ -60,7 +60,8 @@ module ExisRay
     # --- Helpers Centralizados de Resolución de Clases ---
 
     # Resuelve y retorna la clase configurada para manejar el contexto de negocio (Current).
-    # Convierte el String configurado (ej: 'Current') en la clase real constante.
+    # En producción (cache_classes=true) memoiza el resultado para evitar safe_constantize
+    # en cada request. En desarrollo siempre resuelve para soportar el reloading de Zeitwerk.
     #
     # @return [Class, nil] La clase constante (ej: Current) o nil si no se encuentra/configura.
     def current_class
@@ -69,12 +70,15 @@ module ExisRay
       klass_name = configuration.current_class
       return nil unless klass_name.present?
 
-      # Si es String, lo convertimos a constante de forma segura.
-      klass_name.is_a?(String) ? klass_name.safe_constantize : klass_name
+      if cache_classes?
+        @current_class_cache ||= resolve_class(klass_name)
+      else
+        resolve_class(klass_name)
+      end
     end
 
     # Resuelve y retorna la clase configurada para el reporte de errores (Reporter).
-    # Convierte el String configurado (ej: 'Choto') en la clase real constante.
+    # En producción memoiza el resultado. En desarrollo siempre resuelve.
     #
     # @return [Class, nil] La clase constante (ej: Choto) o nil si no se encuentra/configura.
     def reporter_class
@@ -83,7 +87,21 @@ module ExisRay
       klass_name = configuration.reporter_class
       return nil unless klass_name.present?
 
+      if cache_classes?
+        @reporter_class_cache ||= resolve_class(klass_name)
+      else
+        resolve_class(klass_name)
+      end
+    end
+
+    private
+
+    def resolve_class(klass_name)
       klass_name.is_a?(String) ? klass_name.safe_constantize : klass_name
     end
+
+    def cache_classes?
+      defined?(Rails) && Rails.application.config.cache_classes
+    end
   end
 end

data/spec/exis_ray/json_formatter_spec.rb

@@ -82,6 +82,10 @@ RSpec.describe ExisRay::JsonFormatter do
         expect(result["msg"]).to eq('dijo "hola"')
       end
 
+      it "no crashea con un quote suelto como valor (string malformado)" do
+        expect { call('key="') }.not_to raise_error
+      end
+
       it "soporta múltiples pares con tipos de valor variados" do
         result = call("component=orders event=invoice_generated duration_ms=42.5 retries=0")
 
@@ -94,6 +98,14 @@ RSpec.describe ExisRay::JsonFormatter do
       end
     end
 
+      it "cae a message si el string parece kv pero no produce ningún par" do
+        result = call("key=")
+
+        expect(result["message"]).to eq("key=")
+        expect(result).not_to have_key("key")
+      end
+    end
+
     context "cuando el mensaje es un String libre (sin formato key=value)" do
       it "asigna el string completo al campo message" do
         result = call("algo salió mal")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exis_ray
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Gabriel Edera