logstruct 0.1.2 → 0.1.4

data/lib/log_struct/semantic_logger/concerns/log_methods.rb

@@ -0,0 +1,100 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LogStruct
+  module SemanticLogger
+    module Concerns
+      module LogMethods
+        extend T::Sig
+        extend T::Helpers
+        requires_ancestor { LogStruct::SemanticLogger::Logger }
+
+        # Override log methods to handle LogStruct types and broadcast
+        sig { params(message: T.untyped, payload: T.untyped, block: T.nilable(T.proc.returns(String))).returns(T::Boolean) }
+        def debug(message = nil, payload = nil, &block)
+          instrument_log(message, :debug)
+          result = if message.is_a?(LogStruct::Log::Interfaces::CommonFields) || message.is_a?(T::Struct) || message.is_a?(Hash)
+            super(nil, payload: message, &block)
+          else
+            super
+          end
+          broadcasts.each do |logger|
+            next unless logger.respond_to?(:debug)
+            message.is_a?(String) ? logger.debug(message) : (logger.debug(&block) if block)
+          end
+          result
+        end
+
+        sig { params(message: T.untyped, payload: T.untyped, block: T.nilable(T.proc.returns(String))).returns(T::Boolean) }
+        def info(message = nil, payload = nil, &block)
+          instrument_log(message, :info)
+          result = if message.is_a?(LogStruct::Log::Interfaces::CommonFields) || message.is_a?(T::Struct) || message.is_a?(Hash)
+            super(nil, payload: message, &block)
+          else
+            super
+          end
+          broadcasts.each do |logger|
+            next unless logger.respond_to?(:info)
+            message.is_a?(String) ? logger.info(message) : (logger.info(&block) if block)
+          end
+          result
+        end
+
+        sig { params(message: T.untyped, payload: T.untyped, block: T.nilable(T.proc.returns(String))).returns(T::Boolean) }
+        def warn(message = nil, payload = nil, &block)
+          instrument_log(message, :warn)
+          result = if message.is_a?(LogStruct::Log::Interfaces::CommonFields) || message.is_a?(T::Struct) || message.is_a?(Hash)
+            super(nil, payload: message, &block)
+          else
+            super
+          end
+          broadcasts.each do |logger|
+            next unless logger.respond_to?(:warn)
+            message.is_a?(String) ? logger.warn(message) : (logger.warn(&block) if block)
+          end
+          result
+        end
+
+        sig { params(message: T.untyped, payload: T.untyped, block: T.nilable(T.proc.returns(String))).returns(T::Boolean) }
+        def error(message = nil, payload = nil, &block)
+          instrument_log(message, :error)
+          result = if message.is_a?(LogStruct::Log::Interfaces::CommonFields) || message.is_a?(T::Struct) || message.is_a?(Hash)
+            super(nil, payload: message, &block)
+          else
+            super
+          end
+          broadcasts.each do |logger|
+            next unless logger.respond_to?(:error)
+            message.is_a?(String) ? logger.error(message) : (logger.error(&block) if block)
+          end
+          result
+        end
+
+        sig { params(message: T.untyped, payload: T.untyped, block: T.nilable(T.proc.returns(String))).returns(T::Boolean) }
+        def fatal(message = nil, payload = nil, &block)
+          instrument_log(message, :fatal)
+          result = if message.is_a?(LogStruct::Log::Interfaces::CommonFields) || message.is_a?(T::Struct) || message.is_a?(Hash)
+            super(nil, payload: message, &block)
+          else
+            super
+          end
+          broadcasts.each do |logger|
+            next unless logger.respond_to?(:fatal)
+            message.is_a?(String) ? logger.fatal(message) : (logger.fatal(&block) if block)
+          end
+          result
+        end
+
+        private
+
+        # Instrument log events for subscribers
+        sig { params(message: T.untyped, level: Symbol).void }
+        def instrument_log(message, level)
+          return unless message.is_a?(LogStruct::Log::Interfaces::CommonFields) || message.is_a?(T::Struct)
+
+          ::ActiveSupport::Notifications.instrument("log.logstruct", log: message, level: level)
+        end
+      end
+    end
+  end
+end

data/lib/log_struct/semantic_logger/logger.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require "semantic_logger"
+require_relative "concerns/log_methods"
 
 module LogStruct
   module SemanticLogger
@@ -69,25 +70,37 @@ module LogStruct
       def initialize(name = "Application", level: nil, filter: nil)
         # SemanticLogger::Logger expects positional arguments, not named arguments
         super(name, level, filter)
+        # T.untyped because users can pass any logger: ::Logger, ActiveSupport::Logger,
+        # custom loggers (FakeLogger in tests), or third-party loggers
+        @broadcasts = T.let([], T::Array[T.untyped])
+        # ActiveJob expects logger.formatter to exist and respond to current_tags
+        @formatter = T.let(FormatterProxy.new, FormatterProxy)
       end
 
-      # Override log methods to handle LogStruct types
-      %i[debug info warn error fatal].each do |level|
-        define_method(level) do |message = nil, payload = nil, &block|
-          # If message is a LogStruct type, use it as payload
-          if message.is_a?(LogStruct::Log::Interfaces::CommonFields) ||
-              message.is_a?(T::Struct) ||
-              message.is_a?(Hash)
-            payload = message
-            message = nil
-            super(message, payload: payload, &block)
-          else
-            # For plain string messages, pass them through normally
-            super(message, payload, &block)
-          end
-        end
+      # ActiveSupport::BroadcastLogger compatibility
+      # These methods allow Rails.logger to broadcast to multiple loggers
+      sig { returns(T::Array[T.untyped]) }
+      attr_reader :broadcasts
+
+      # ActiveJob compatibility - expects logger.formatter.current_tags
+      sig { returns(FormatterProxy) }
+      attr_reader :formatter
+
+      # T.untyped for logger param because we accept any logger-like object:
+      # ::Logger, ActiveSupport::Logger, test doubles, etc.
+      sig { params(logger: T.untyped).returns(T.untyped) }
+      def broadcast_to(logger)
+        @broadcasts << logger
+        logger
+      end
+
+      sig { params(logger: T.untyped).void }
+      def stop_broadcasting_to(logger)
+        @broadcasts.delete(logger)
       end
 
+      include Concerns::LogMethods
+
       # Support for tagged logging
       sig { params(tags: T.untyped, block: T.proc.returns(T.untyped)).returns(T.untyped) }
       def tagged(*tags, &block)
@@ -124,6 +137,24 @@ module LogStruct
       def pop_tags(count = 1)
         ::SemanticLogger.pop_tags(count)
       end
+
+      # Support for << operator (used by RailsLogSplitter)
+      sig { params(msg: String).returns(T.self_type) }
+      def <<(msg)
+        info(msg)
+        @broadcasts.each { |logger| logger << msg if logger.respond_to?(:<<) }
+        self
+      end
+    end
+
+    # Proxy object to provide ActiveJob-compatible formatter interface
+    class FormatterProxy
+      extend T::Sig
+
+      sig { returns(T::Array[T.any(String, Symbol)]) }
+      def current_tags
+        Thread.current[:activesupport_tagged_logging_tags] || []
+      end
     end
   end
 end

data/lib/log_struct/semantic_logger/setup.rb

@@ -152,8 +152,8 @@ module LogStruct
           )
         end
 
-        # Add file appender if configured and not already logging to STDOUT/StringIO
-        if app.config.paths["log"].first && io != $stdout && !io.is_a?(StringIO)
+        # Add file appender if Rails has a log path configured (normal Rails behavior)
+        if app.config.paths["log"].first
           ::SemanticLogger.add_appender(
             file_name: app.config.paths["log"].first,
             formatter: LogStruct::SemanticLogger::Formatter.new,
@@ -164,14 +164,14 @@ module LogStruct
 
       sig { params(app: T.untyped).returns(T.untyped) }
       def self.determine_output(app)
-        # Always honor explicit STDOUT directive, even in test, or when LogStruct is enabled via env
-        return $stdout if ENV["RAILS_LOG_TO_STDOUT"].present? || ENV["LOGSTRUCT_ENABLED"].to_s.strip.downcase == "true"
+        # Always honor explicit STDOUT directive
+        return $stdout if ENV["RAILS_LOG_TO_STDOUT"].present?
 
         if Rails.env.test?
-          # Default to StringIO to keep test output clean unless STDOUT is requested
+          # Use StringIO in test to keep stdout clean
           StringIO.new
         else
-          # Default to STDOUT for app logs
+          # Use STDOUT for app logs in dev/production
           $stdout
         end
       end
@@ -222,7 +222,11 @@ module LogStruct
         # Also replace various component loggers
         ActiveRecord::Base.logger = logger if defined?(ActiveRecord::Base)
         ActionController::Base.logger = logger if defined?(ActionController::Base)
-        ActionMailer::Base.logger = logger if defined?(ActionMailer::Base)
+        if defined?(ActionMailer::Base)
+          ActionMailer::Base.logger = logger
+          # Ensure ActionMailer.logger is also set (it might be accessed directly)
+          T.unsafe(::ActionMailer).logger = logger if T.unsafe(::ActionMailer).respond_to?(:logger=)
+        end
         ActiveJob::Base.logger = logger if defined?(ActiveJob::Base)
         ActionView::Base.logger = logger if defined?(ActionView::Base)
         ActionCable.server.config.logger = logger if defined?(ActionCable)

data/lib/log_struct/shared/{shared/add_request_fields.rb → add_request_fields.rb}

@@ -1,8 +1,8 @@
 # typed: strict
 # frozen_string_literal: true
 
-require_relative "../../enums/log_field"
-require_relative "../interfaces/request_fields"
+require_relative "../enums/log_field"
+require_relative "interfaces/request_fields"
 
 module LogStruct
   module Log

data/lib/log_struct/shared/{shared/merge_additional_data_fields.rb → merge_additional_data_fields.rb}

@@ -1,7 +1,7 @@
 # typed: strict
 # frozen_string_literal: true
 
-require_relative "../interfaces/additional_data_field"
+require_relative "interfaces/additional_data_field"
 
 module LogStruct
   module Log

data/lib/log_struct/shared/{shared/serialize_common.rb → serialize_common.rb}

@@ -1,9 +1,9 @@
 # typed: strict
 # frozen_string_literal: true
 
-require_relative "../../enums/log_field"
-require_relative "../interfaces/common_fields"
-require_relative "../../log/shared/merge_additional_data_fields"
+require_relative "../enums/log_field"
+require_relative "interfaces/common_fields"
+require_relative "merge_additional_data_fields"
 
 module LogStruct
   module Log
@@ -25,6 +25,12 @@ module LogStruct
           field_hash.each do |log_field, value|
             next if value.nil?
             key = log_field.serialize
+
+            # Limit backtrace to first 5 lines
+            if key == :backtrace && value.is_a?(Array)
+              value = value.first(5)
+            end
+
             out[key] = value.is_a?(::Time) ? value.iso8601 : value
           end
 

data/lib/log_struct/{log/shared → shared}/serialize_common_public.rb

@@ -1,8 +1,8 @@
 # typed: strict
 # frozen_string_literal: true
 
-require_relative "../../enums/log_field"
-require_relative "../interfaces/public_common_fields"
+require_relative "../enums/log_field"
+require_relative "interfaces/public_common_fields"
 
 module LogStruct
   module Log

data/lib/log_struct/version.rb

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

data/lib/log_struct.rb

@@ -22,6 +22,9 @@ require "log_struct/semantic_logger/logger"
 require "log_struct/semantic_logger/setup"
 require "log_struct/rails_boot_banner_silencer"
 
+# Monkey patches for Rails compatibility
+require "log_struct/monkey_patches/active_support/tagged_logging/formatter"
+
 module LogStruct
   extend T::Sig
 
@@ -44,7 +47,7 @@ module LogStruct
   end
 
   # Set enabled at require time based on current Rails environment.
-  # (Users can disable or enable LogStruct later in an initializer.)
+  # (Users can override this in their initializer which runs before the Railtie checks enabled)
   set_enabled_from_rails_env!
 
   # Silence Rails boot banners for cleaner server output

data/logstruct.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "lograge", ">= 0.11"
-  spec.add_dependency "rails", ">= 7.0"
+  spec.add_dependency "rails", ">= 7.1"
   spec.add_dependency "semantic_logger", "~> 4.15"
   spec.add_dependency "sorbet-runtime", ">= 0.5"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logstruct
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - DocSpring
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: semantic_logger
   requirement: !ruby/object:Gem::Requirement
@@ -260,7 +260,6 @@ files:
 - lib/log_struct/hash_utils.rb
 - lib/log_struct/integrations.rb
 - lib/log_struct/integrations/action_mailer.rb
-- lib/log_struct/integrations/action_mailer/callbacks.rb
 - lib/log_struct/integrations/action_mailer/error_handling.rb
 - lib/log_struct/integrations/action_mailer/event_logging.rb
 - lib/log_struct/integrations/action_mailer/metadata_collection.rb
@@ -290,6 +289,7 @@ files:
 - lib/log_struct/log/action_mailer.rb
 - lib/log_struct/log/action_mailer/delivered.rb
 - lib/log_struct/log/action_mailer/delivery.rb
+- lib/log_struct/log/action_mailer/error.rb
 - lib/log_struct/log/active_job.rb
 - lib/log_struct/log/active_job/enqueue.rb
 - lib/log_struct/log/active_job/finish.rb
@@ -335,10 +335,6 @@ files:
 - lib/log_struct/log/security/blocked_host.rb
 - lib/log_struct/log/security/csrf_violation.rb
 - lib/log_struct/log/security/ip_spoof.rb
-- lib/log_struct/log/shared/add_request_fields.rb
-- lib/log_struct/log/shared/merge_additional_data_fields.rb
-- lib/log_struct/log/shared/serialize_common.rb
-- lib/log_struct/log/shared/serialize_common_public.rb
 - lib/log_struct/log/shrine.rb
 - lib/log_struct/log/shrine/delete.rb
 - lib/log_struct/log/shrine/download.rb
@@ -353,16 +349,18 @@ files:
 - lib/log_struct/rails_boot_banner_silencer.rb
 - lib/log_struct/railtie.rb
 - lib/log_struct/semantic_logger/color_formatter.rb
+- lib/log_struct/semantic_logger/concerns/log_methods.rb
 - lib/log_struct/semantic_logger/formatter.rb
 - lib/log_struct/semantic_logger/logger.rb
 - lib/log_struct/semantic_logger/setup.rb
+- lib/log_struct/shared/add_request_fields.rb
 - lib/log_struct/shared/interfaces/additional_data_field.rb
 - lib/log_struct/shared/interfaces/common_fields.rb
 - lib/log_struct/shared/interfaces/public_common_fields.rb
 - lib/log_struct/shared/interfaces/request_fields.rb
-- lib/log_struct/shared/shared/add_request_fields.rb
-- lib/log_struct/shared/shared/merge_additional_data_fields.rb
-- lib/log_struct/shared/shared/serialize_common.rb
+- lib/log_struct/shared/merge_additional_data_fields.rb
+- lib/log_struct/shared/serialize_common.rb
+- lib/log_struct/shared/serialize_common_public.rb
 - lib/log_struct/sorbet.rb
 - lib/log_struct/sorbet/serialize_symbol_keys.rb
 - lib/log_struct/string_scrubber.rb

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

@@ -1,100 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-module LogStruct
-  module Integrations
-    module ActionMailer
-      # Backport of the *_deliver callbacks from Rails 7.1
-      module Callbacks
-        extend T::Sig
-        extend ::ActiveSupport::Concern
-
-        # Track if we've already patched MessageDelivery
-        @patched_message_delivery = T.let(false, T::Boolean)
-
-        # We can't use included block with strict typing
-        # This will be handled by ActiveSupport::Concern at runtime
-        included do
-          include ::ActiveSupport::Callbacks
-          if defined?(::ActiveSupport) && ::ActiveSupport.gem_version >= Gem::Version.new("7.1.0")
-            define_callbacks :deliver, skip_after_callbacks_if_terminated: true
-          else
-            define_callbacks :deliver
-          end
-        end
-
-        # When this module is prepended (our integration uses prepend), ensure callbacks are defined
-        if respond_to?(:prepended)
-          prepended do
-            include ::ActiveSupport::Callbacks
-            if defined?(::ActiveSupport) && ::ActiveSupport.gem_version >= Gem::Version.new("7.1.0")
-              define_callbacks :deliver, skip_after_callbacks_if_terminated: true
-            else
-              define_callbacks :deliver
-            end
-          end
-        end
-
-        # Define class methods in a separate module
-        module ClassMethods
-          extend T::Sig
-
-          # Defines a callback that will get called right before the
-          # message is sent to the delivery method.
-          sig { params(filters: T.untyped, blk: T.nilable(T.proc.bind(T.untyped).void)).void }
-          def before_deliver(*filters, &blk)
-            # Use T.unsafe for splat arguments due to Sorbet limitation
-            T.unsafe(self).set_callback(:deliver, :before, *filters, &blk)
-          end
-
-          # Defines a callback that will get called right after the
-          # message's delivery method is finished.
-          sig { params(filters: T.untyped, blk: T.nilable(T.proc.bind(T.untyped).void)).void }
-          def after_deliver(*filters, &blk)
-            # Use T.unsafe for splat arguments due to Sorbet limitation
-            T.unsafe(self).set_callback(:deliver, :after, *filters, &blk)
-          end
-
-          # Defines a callback that will get called around the message's deliver method.
-          sig { params(filters: T.untyped, blk: T.nilable(T.proc.bind(T.untyped).params(arg0: T.untyped).void)).void }
-          def around_deliver(*filters, &blk)
-            # Use T.unsafe for splat arguments due to Sorbet limitation
-            T.unsafe(self).set_callback(:deliver, :around, *filters, &blk)
-          end
-        end
-
-        # Module to patch ActionMailer::MessageDelivery with callback support
-        module MessageDeliveryCallbacks
-          extend T::Sig
-
-          sig { returns(T.untyped) }
-          def deliver_now
-            processed_mailer.run_callbacks(:deliver) do
-              message.deliver
-            end
-          end
-
-          sig { returns(T.untyped) }
-          def deliver_now!
-            processed_mailer.run_callbacks(:deliver) do
-              message.deliver!
-            end
-          end
-        end
-
-        sig { returns(T::Boolean) }
-        def self.patch_message_delivery
-          # Return early if we've already patched
-          return true if @patched_message_delivery
-
-          # Prepend our module to add callback support to MessageDelivery
-          ::ActionMailer::MessageDelivery.prepend(MessageDeliveryCallbacks)
-
-          # Mark as patched so we don't do it again
-          @patched_message_delivery = true
-          true
-        end
-      end
-    end
-  end
-end

data/lib/log_struct/log/shared/add_request_fields.rb

@@ -1,4 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-require "log_struct/shared/shared/add_request_fields"

data/lib/log_struct/log/shared/merge_additional_data_fields.rb

@@ -1,4 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-require "log_struct/shared/shared/merge_additional_data_fields"

data/lib/log_struct/log/shared/serialize_common.rb

@@ -1,4 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-require "log_struct/shared/shared/serialize_common"