actioncable/lib/action_cable/connection/tagged_logger_proxy.rb

Summary

Maintainability
A
0 mins
Test Coverage
# frozen_string_literal: true

# :markup: markdown

module ActionCable
  module Connection
    # # Action Cable Connection TaggedLoggerProxy
    #
    # Allows the use of per-connection tags against the server logger. This wouldn't
    # work using the traditional ActiveSupport::TaggedLogging enhanced Rails.logger,
    # as that logger will reset the tags between requests. The connection is
    # long-lived, so it needs its own set of tags for its independent duration.
    class TaggedLoggerProxy
      attr_reader :tags

      def initialize(logger, tags:)
        @logger = logger
        @tags = tags.flatten
      end

      def add_tags(*tags)
        @tags += tags.flatten
        @tags = @tags.uniq
      end

      def tag(logger, &block)
        if logger.respond_to?(:tagged)
          current_tags = tags - logger.formatter.current_tags
          logger.tagged(*current_tags, &block)
        else
          yield
        end
      end

      %i( debug info warn error fatal unknown ).each do |severity|
        define_method(severity) do |message = nil, &block|
          log severity, message, &block
        end
      end

      private
        def log(type, message, &block) # :doc:
          tag(@logger) { @logger.send type, message, &block }
        end
    end
  end
end