logstruct 0.1.8 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3634f56776f895f97747c8165065651aca55098520469624f73f2d75b090f33c
-  data.tar.gz: c29661ad9e8044bad356a5a699f9aaed053c55ec124226784c60dd78655e794f
+  metadata.gz: b138e5ba6e0739ee31d032606f4d7508463deeee00b64e3a870d34d4316e7567
+  data.tar.gz: f36bc4a9cb5ee2ab42b77a581efd1b28c7c23a75191429ac5b5926023d33a594
 SHA512:
-  metadata.gz: c491c3087d5341e5ab88bc607c2596be06fb90c482b74498b5aebd5a0eb5ef92f917b889b3ea26f56cb5a69be756bbc0afabfb957bff557cbbd7615f45b3934b
-  data.tar.gz: '090f85673e396225d96254c14fdfcdc941904354d3c11700be60b93e83e7c2e230bcbc15c8436ba2e0491223c77e0498f33d866beddb1e34379b7e4863916d1b'
+  metadata.gz: c06589605729de5ac9ea44694e82712d2d175201adab6052b6eff1a2ae2cc8cc6b476ed7200d1fa6bf6a79db6eb280847b4ca34559a501bc327129db4574acfe
+  data.tar.gz: 992fc803c47c57367ca906179bf9b356618e42bf840ac6a3de4b7296d90be0db8d513177c57643e1564967624f444d0af00f2582844e4d68825a03f8e911ac37

data/CHANGELOG.md

@@ -5,8 +5,24 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Changed
+
+## [0.1.10] - 2026-01-23
+
+### Added
+
+- **Feature**: `request_id` now appears on all logs during a request, not just the request log
+
+## [0.1.9] - 2026-01-23
+
 ### Changed
 
+- **Fix**: ActiveJob integration handles Rails main event reporter subscribers
+- **Fix**: Rack error handler avoids deprecated CSRF exception class on Rails main
+- **CI**: Added Rails main daily integration run and updated Rails test matrix (7.1.6, 7.2.3, 8.0.4, 8.1.2)
+
 ## [0.1.8] - 2026-01-22
 
 - **Fix**: Lograge custom options now appear in request logs

data/lib/log_struct/enums/log_field.rb

@@ -32,7 +32,7 @@ module LogStruct
       SourceIp = new(:source_ip)
       UserAgent = new(:user_agent)
       Referer = new(:referer)
-      RequestId = new(:request_id)
+      RequestId = new(:req_id)
       Host = new(:host)
       ContentType = new(:content_type)
       Accept = new(:accept)

data/lib/log_struct/integrations/action_mailer/metadata_collection.rb

@@ -54,12 +54,6 @@ module LogStruct
           end
           log_data[:tags] = tags if tags.present?
 
-          # Get request_id from ActionDispatch if available
-          if ::ActionDispatch::Request.respond_to?(:current_request_id) &&
-              T.unsafe(::ActionDispatch::Request).current_request_id.present?
-            log_data[:request_id] = T.unsafe(::ActionDispatch::Request).current_request_id
-          end
-
           # Get job_id from ActiveJob if available
           if defined?(::ActiveJob::Logging) && ::ActiveJob::Logging.respond_to?(:job_id) &&
               T.unsafe(::ActiveJob::Logging).job_id.present?

data/lib/log_struct/integrations/active_job/log_subscriber.rb

@@ -1,6 +1,7 @@
 # typed: strict
 # frozen_string_literal: true
 
+require "active_support/log_subscriber"
 require_relative "../../enums/source"
 require_relative "../../enums/event"
 require_relative "../../log/active_job"
@@ -10,7 +11,7 @@ module LogStruct
   module Integrations
     module ActiveJob
       # Structured logging for ActiveJob
-      class LogSubscriber < ::ActiveJob::LogSubscriber
+      class LogSubscriber < ::ActiveSupport::LogSubscriber
         extend T::Sig
 
         sig { params(event: ::ActiveSupport::Notifications::Event).void }

data/lib/log_struct/integrations/active_job.rb

@@ -25,8 +25,13 @@ module LogStruct
         return nil unless config.integrations.enable_activejob
 
         ::ActiveSupport.on_load(:active_job) do
-          # Detach the default text formatter
-          ::ActiveJob::LogSubscriber.detach_from :active_job
+          if ::ActiveJob::LogSubscriber.respond_to?(:detach_from)
+            # Detach the default text formatter
+            ::ActiveJob::LogSubscriber.detach_from :active_job
+          elsif ::ActiveSupport.respond_to?(:event_reporter)
+            reporter = ::ActiveSupport.event_reporter
+            reporter.unsubscribe(::ActiveJob::LogSubscriber) if reporter.respond_to?(:unsubscribe)
+          end
 
           # Attach our structured formatter
           Integrations::ActiveJob::LogSubscriber.attach_to :active_job

data/lib/log_struct/integrations/host_authorization.rb

@@ -63,7 +63,6 @@ module LogStruct
             source_ip: request.ip,
             user_agent: request.user_agent,
             referer: request.referer,
-            request_id: request.request_id,
             x_forwarded_for: request.x_forwarded_for,
             allowed_hosts: allowed_hosts_array&.empty? ? nil : allowed_hosts_array,
             allow_ip_hosts: allow_ip_hosts_value

data/lib/log_struct/integrations/lograge.rb

@@ -101,6 +101,12 @@ module LogStruct
           headers = event.payload[:headers]
           return if headers.blank?
 
+          # Rails' ActionDispatch::RequestId middleware stores request_id in headers
+          # Only set if not already present in payload (payload takes precedence)
+          if options[:request_id].blank? && headers["action_dispatch.request_id"].present?
+            options[:request_id] = headers["action_dispatch.request_id"]
+          end
+
           options[:user_agent] = headers["HTTP_USER_AGENT"]
           options[:referer] = headers["HTTP_REFERER"]
           options[:content_type] = headers["CONTENT_TYPE"]
@@ -144,7 +150,6 @@ module LogStruct
             view: view,
             database: db,
             params: params,
-            request_id: normalized_data[:request_id]&.to_s,
             source_ip: normalized_data[:source_ip]&.to_s,
             user_agent: normalized_data[:user_agent]&.to_s,
             referer: normalized_data[:referer]&.to_s,

data/lib/log_struct/integrations/rack_error_handler/middleware.rb

@@ -71,7 +71,6 @@ module LogStruct
               http_method: env["REQUEST_METHOD"],
               user_agent: env["HTTP_USER_AGENT"],
               referer: env["HTTP_REFERER"],
-              request_id: request.request_id,
               message: ip_spoof_error.message,
               client_ip: env["HTTP_CLIENT_IP"],
               x_forwarded_for: env["HTTP_X_FORWARDED_FOR"],
@@ -81,38 +80,39 @@ module LogStruct
             ::Rails.logger.warn(security_log)
 
             [FORBIDDEN_STATUS, IP_SPOOF_HEADERS.dup, [IP_SPOOF_HTML]]
-          rescue ::ActionController::InvalidAuthenticityToken => invalid_auth_token_error
-            # Create a security log for CSRF error
-            security_log = Log::Security::CSRFViolation.new(
-              path: request.path,
-              http_method: request.method,
-              source_ip: request.remote_ip,
-              user_agent: request.user_agent,
-              referer: request.referer,
-              request_id: request.request_id,
-              message: invalid_auth_token_error.message,
-              timestamp: Time.now
-            )
-            LogStruct.error(security_log)
-
-            # Report to error reporting service and/or re-raise
-            context = extract_request_context(env, request)
-            LogStruct.handle_exception(invalid_auth_token_error, source: Source::Security, context: context)
-
-            # If handle_exception raised an exception then Rails will deal with it (e.g. config.exceptions_app)
-            # If we are only logging or reporting these security errors, then return a default response
-            [FORBIDDEN_STATUS, CSRF_HEADERS.dup, [CSRF_HTML]]
           rescue => error
-            # Extract request context for error reporting
-            context = extract_request_context(env, request)
-
-            # Create and log a structured exception with request context
-            exception_log = Log.from_exception(Source::Rails, error, context)
-            LogStruct.error(exception_log)
-
-            # Re-raise any standard errors to let Rails or error reporter handle it.
-            # Rails will also log the request details separately
-            raise error
+            if csrf_error?(error)
+              # Create a security log for CSRF error
+              security_log = Log::Security::CSRFViolation.new(
+                path: request.path,
+                http_method: request.method,
+                source_ip: request.remote_ip,
+                user_agent: request.user_agent,
+                referer: request.referer,
+                message: error.message,
+                timestamp: Time.now
+              )
+              LogStruct.error(security_log)
+
+              # Report to error reporting service and/or re-raise
+              context = extract_request_context(env, request)
+              LogStruct.handle_exception(error, source: Source::Security, context: context)
+
+              # If handle_exception raised an exception then Rails will deal with it (e.g. config.exceptions_app)
+              # If we are only logging or reporting these security errors, then return a default response
+              [FORBIDDEN_STATUS, CSRF_HEADERS.dup, [CSRF_HTML]]
+            else
+              # Extract request context for error reporting
+              context = extract_request_context(env, request)
+
+              # Create and log a structured exception with request context
+              exception_log = Log.from_exception(Source::Rails, error, context)
+              LogStruct.error(exception_log)
+
+              # Re-raise any standard errors to let Rails or error reporter handle it.
+              # Rails will also log the request details separately
+              raise error
+            end
           end
         end
 
@@ -135,7 +135,6 @@ module LogStruct
         def extract_request_context(env, request = nil)
           request ||= ::ActionDispatch::Request.new(env)
           {
-            request_id: request.request_id,
             path: request.path,
             method: request.method,
             user_agent: request.user_agent,
@@ -146,6 +145,13 @@ module LogStruct
           {error_extracting_context: error.message}
         end
 
+        sig { params(error: StandardError).returns(T::Boolean) }
+        def csrf_error?(error)
+          error_name = error.class.name
+          error_name == "ActionController::InvalidAuthenticityToken" ||
+            error_name == "ActionController::InvalidCrossOriginRequest"
+        end
+
         sig { params(configured_proxies: T.untyped).returns(T.untyped) }
         def normalized_trusted_proxies(configured_proxies)
           if configured_proxies.nil? || (configured_proxies.respond_to?(:empty?) && configured_proxies.empty?)

data/lib/log_struct/integrations/request_context/middleware.rb

@@ -0,0 +1,28 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LogStruct
+  module Integrations
+    module RequestContext
+      # Middleware that captures request_id and stores it in SemanticLogger's
+      # named_tags so all logs during the request include the request_id.
+      class Middleware
+        extend T::Sig
+
+        sig { params(app: T.untyped).void }
+        def initialize(app)
+          @app = app
+        end
+
+        sig { params(env: T.untyped).returns(T.untyped) }
+        def call(env)
+          request = ::ActionDispatch::Request.new(env)
+          ::SemanticLogger.push_named_tags(request_id: request.request_id)
+          @app.call(env)
+        ensure
+          ::SemanticLogger.pop_named_tags
+        end
+      end
+    end
+  end
+end

data/lib/log_struct/integrations/request_context.rb

@@ -0,0 +1,27 @@
+# typed: strict
+# frozen_string_literal: true
+
+require_relative "request_context/middleware"
+
+module LogStruct
+  module Integrations
+    # Request context integration that captures request_id for all logs
+    module RequestContext
+      extend T::Sig
+      extend IntegrationInterface
+
+      sig { override.params(config: LogStruct::Configuration).returns(T.nilable(T::Boolean)) }
+      def self.setup(config)
+        return nil unless config.enabled
+
+        # Insert after RequestId middleware so request_id is available
+        ::Rails.application.middleware.insert_after(
+          ::ActionDispatch::RequestId,
+          Integrations::RequestContext::Middleware
+        )
+
+        true
+      end
+    end
+  end
+end

data/lib/log_struct/integrations.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require_relative "integrations/integration_interface"
+require_relative "integrations/request_context"
 require_relative "integrations/active_job"
 require_relative "integrations/active_record"
 require_relative "integrations/rack_error_handler"
@@ -77,6 +78,7 @@ module LogStruct
 
     sig { params(config: LogStruct::Configuration).void }
     def self.setup_middleware_integrations(config)
+      Integrations::RequestContext.setup(config)
       Integrations::HostAuthorization.setup(config) if config.integrations.enable_host_authorization
       Integrations::RackErrorHandler.setup(config) if config.integrations.enable_rack_error_handler
     end

data/lib/log_struct/log/request.rb

@@ -33,7 +33,6 @@ module LogStruct
       const :source_ip, T.nilable(String), default: nil
       const :user_agent, T.nilable(String), default: nil
       const :referer, T.nilable(String), default: nil
-      const :request_id, T.nilable(String), default: nil
 
       # Event-specific fields
       const :format, T.nilable(Symbol), default: nil
@@ -69,7 +68,6 @@ module LogStruct
         h[LogField::SourceIp] = source_ip unless source_ip.nil?
         h[LogField::UserAgent] = user_agent unless user_agent.nil?
         h[LogField::Referer] = referer unless referer.nil?
-        h[LogField::RequestId] = request_id unless request_id.nil?
         h[LogField::Format] = format unless format.nil?
         h[LogField::Controller] = controller unless controller.nil?
         h[LogField::Action] = action unless action.nil?

data/lib/log_struct/log/security/blocked_host.rb

@@ -34,7 +34,6 @@ module LogStruct
         const :source_ip, T.nilable(String), default: nil
         const :user_agent, T.nilable(String), default: nil
         const :referer, T.nilable(String), default: nil
-        const :request_id, T.nilable(String), default: nil
 
         # Event-specific fields
         const :message, T.nilable(String), default: nil
@@ -65,7 +64,6 @@ module LogStruct
           h[LogField::SourceIp] = source_ip unless source_ip.nil?
           h[LogField::UserAgent] = user_agent unless user_agent.nil?
           h[LogField::Referer] = referer unless referer.nil?
-          h[LogField::RequestId] = request_id unless request_id.nil?
           h[LogField::Message] = message unless message.nil?
           h[LogField::BlockedHost] = blocked_host unless blocked_host.nil?
           h[LogField::BlockedHosts] = blocked_hosts unless blocked_hosts.nil?

data/lib/log_struct/log/security/csrf_violation.rb

@@ -34,7 +34,6 @@ module LogStruct
         const :source_ip, T.nilable(String), default: nil
         const :user_agent, T.nilable(String), default: nil
         const :referer, T.nilable(String), default: nil
-        const :request_id, T.nilable(String), default: nil
 
         # Event-specific fields
         const :message, T.nilable(String), default: nil
@@ -60,7 +59,6 @@ module LogStruct
           h[LogField::SourceIp] = source_ip unless source_ip.nil?
           h[LogField::UserAgent] = user_agent unless user_agent.nil?
           h[LogField::Referer] = referer unless referer.nil?
-          h[LogField::RequestId] = request_id unless request_id.nil?
           h[LogField::Message] = message unless message.nil?
           h
         end

data/lib/log_struct/log/security/ip_spoof.rb

@@ -34,7 +34,6 @@ module LogStruct
         const :source_ip, T.nilable(String), default: nil
         const :user_agent, T.nilable(String), default: nil
         const :referer, T.nilable(String), default: nil
-        const :request_id, T.nilable(String), default: nil
 
         # Event-specific fields
         const :message, T.nilable(String), default: nil
@@ -62,7 +61,6 @@ module LogStruct
           h[LogField::SourceIp] = source_ip unless source_ip.nil?
           h[LogField::UserAgent] = user_agent unless user_agent.nil?
           h[LogField::Referer] = referer unless referer.nil?
-          h[LogField::RequestId] = request_id unless request_id.nil?
           h[LogField::Message] = message unless message.nil?
           h[LogField::ClientIp] = client_ip unless client_ip.nil?
           h[LogField::XForwardedFor] = x_forwarded_for unless x_forwarded_for.nil?

data/lib/log_struct/log/security.rb

@@ -20,7 +20,6 @@ module LogStruct
         const :source_ip, T.nilable(String), default: nil
         const :user_agent, T.nilable(String), default: nil
         const :referer, T.nilable(String), default: nil
-        const :request_id, T.nilable(String), default: nil
 
         Kwargs = T.type_alias do
           {
@@ -28,8 +27,7 @@ module LogStruct
             http_method: T.nilable(String),
             source_ip: T.nilable(String),
             user_agent: T.nilable(String),
-            referer: T.nilable(String),
-            request_id: T.nilable(String)
+            referer: T.nilable(String)
           }
         end
 
@@ -40,8 +38,7 @@ module LogStruct
             http_method: http_method,
             source_ip: source_ip,
             user_agent: user_agent,
-            referer: referer,
-            request_id: request_id
+            referer: referer
           }
         end
       end

data/lib/log_struct/semantic_logger/formatter.rb

@@ -79,6 +79,15 @@ module LogStruct
           )
           @logstruct_formatter.call(log.level, log.time, log.name, plain_log)
         end
+
+        # Add request_id from named_tags if present
+        request_id = log.named_tags[:request_id]
+        if request_id
+          data = JSON.parse(json)
+          data["req_id"] = request_id
+          json = data.to_json
+        end
+
         # SemanticLogger appenders typically add their own newline. Avoid double newlines by stripping ours.
         json.end_with?("\n") ? json.chomp : json
       end

data/lib/log_struct/semantic_logger/logger.rb

@@ -148,7 +148,9 @@ module LogStruct
     end
 
     # Proxy object to provide ActiveJob-compatible formatter interface
-    class FormatterProxy
+    # Also implements the standard Logger formatter interface (call method)
+    # for compatibility with Ruby's Logger (especially logger gem 1.7.0+)
+    class FormatterProxy < ::Logger::Formatter
       extend T::Sig
 
       sig { returns(T::Array[T.any(String, Symbol)]) }

data/lib/log_struct/shared/add_request_fields.rb

@@ -20,7 +20,6 @@ module LogStruct
           hash[LogField::SourceIp.serialize] = source_ip if source_ip
           hash[LogField::UserAgent.serialize] = user_agent if user_agent
           hash[LogField::Referer.serialize] = referer if referer
-          hash[LogField::RequestId.serialize] = request_id if request_id
         end
       end
     end

data/lib/log_struct/shared/interfaces/request_fields.rb

@@ -29,10 +29,6 @@ module LogStruct
         sig { abstract.returns(T.nilable(String)) }
         def referer
         end
-
-        sig { abstract.returns(T.nilable(String)) }
-        def request_id
-        end
       end
     end
   end

data/lib/log_struct/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module LogStruct
-  VERSION = "0.1.8"
+  VERSION = "0.1.10"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logstruct
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.10
 platform: ruby
 authors:
 - DocSpring
@@ -281,6 +281,8 @@ files:
 - lib/log_struct/integrations/rack.rb
 - lib/log_struct/integrations/rack_error_handler.rb
 - lib/log_struct/integrations/rack_error_handler/middleware.rb
+- lib/log_struct/integrations/request_context.rb
+- lib/log_struct/integrations/request_context/middleware.rb
 - lib/log_struct/integrations/shrine.rb
 - lib/log_struct/integrations/sidekiq.rb
 - lib/log_struct/integrations/sidekiq/logger.rb