[sentry-rails] add tests for Rails logger when :logger patch is enabled

Author: solnic

sentry-rails/spec/isolated/rails_logger_patch_spec.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+begin
+  require "simplecov"
+  SimpleCov.command_name "RailsLoggerPatch"
+rescue LoadError
+end
+
+require "logger"
+require "sentry-ruby"
+require "sentry/test_helper"
+
+require_relative "../dummy/test_rails_app/app"
+
+RSpec.describe "Rails.logger with :logger patch" do
+  include Sentry::TestHelper
+
+  # Set up a real Rails app with logger
+  let(:log_output) { StringIO.new }
+  let(:app) do
+    make_basic_app do |config|
+      config.enable_logs = true
+      config.enabled_patches = [:logger]
+      config.max_log_events = 10
+      config.sdk_logger = Logger.new(nil)
+    end
+  end
+
+  before do
+    app
+    Rails.logger = Logger.new(log_output)
+  end
+
+  context "when :logger patch is enabled" do
+    it "captures Rails.logger calls when :logger patch is enabled" do
+      Rails.logger.debug("Test debug message")
+      Rails.logger.info("Test info message")
+      Rails.logger.warn("Test warning message")
+      Rails.logger.error("Test error message")
+      Rails.logger.fatal("Test fatal message")
+
+      Sentry.get_current_client.log_event_buffer.flush
+
+      expect(sentry_logs).not_to be_empty
+
+      log_messages = sentry_logs.map { |log| log[:body] }
+      expect(log_messages).to include(
+        "Test debug message",
+        "Test info message",
+        "Test warning message",
+        "Test error message",
+        "Test fatal message"
+      )
+
+      test_logs = sentry_logs.select { |log| log[:body].start_with?("Test ") }
+      log_levels = test_logs.map { |log| log[:level] }
+      expect(log_levels).to contain_exactly("debug", "info", "warn", "error", "fatal")
+    end
+
+    it "captures Rails.logger calls with block syntax" do
+      Rails.logger.info { "Block message" }
+
+      Sentry.get_current_client.log_event_buffer.flush
+
+      expect(sentry_logs).not_to be_empty
+
+      log_messages = sentry_logs.map { |log| log[:body] }
+      expect(log_messages).to include("Block message")
+
+      block_log = sentry_logs.find { |log| log[:body] == "Block message" }
+      expect(block_log[:level]).to eq("info")
+    end
+
+    it "captures Rails.logger calls with progname" do
+      Rails.logger.info("MyProgram") { "Message with progname" }
+
+      Sentry.get_current_client.log_event_buffer.flush
+
+      expect(sentry_logs).not_to be_empty
+
+      log_messages = sentry_logs.map { |log| log[:body] }
+      expect(log_messages).to include("Message with progname")
+
+      progname_log = sentry_logs.find { |log| log[:body] == "Message with progname" }
+      expect(progname_log[:level]).to eq("info")
+    end
+
+    it "does not capture Sentry SDK internal logs" do
+      Rails.logger.info(Sentry::Logger::PROGNAME) { "Internal Sentry message" }
+
+      Sentry.get_current_client.log_event_buffer.flush
+
+      log_messages = sentry_logs.map { |log| log[:body] }
+      expect(log_messages).not_to include("Internal Sentry message")
+    end
+
+    it "strips whitespace from log messages" do
+      Rails.logger.info("  Message with whitespace  ")
+
+      Sentry.get_current_client.log_event_buffer.flush
+
+      expect(sentry_logs).not_to be_empty
+
+      log_messages = sentry_logs.map { |log| log[:body] }
+      expect(log_messages).to include("Message with whitespace")
+    end
+
+    it "handles non-string log messages" do
+      Rails.logger.info(12345)
+
+      Sentry.get_current_client.log_event_buffer.flush
+
+      expect(sentry_logs).not_to be_empty
+
+      log_messages = sentry_logs.map { |log| log[:body] }
+      expect(log_messages).to include("12345")
+    end
+  end
+
+  context "when Rails.logger is a BroadcastLogger", skip: !defined?(ActiveSupport::BroadcastLogger) do
+    let(:string_io1) { StringIO.new }
+    let(:string_io2) { StringIO.new }
+    let(:logger1) { Logger.new(string_io1) }
+    let(:logger2) { Logger.new(string_io2) }
+    let(:broadcast_logger) { ActiveSupport::BroadcastLogger.new(logger1, logger2) }
+    let(:broadcast_app) do
+      make_basic_app do |config|
+        config.enable_logs = true
+        config.enabled_patches = [:logger]
+        config.max_log_events = 10
+        config.sdk_logger = Logger.new(nil)
+      end
+    end
+
+    before do
+      broadcast_app
+      Rails.logger = broadcast_logger
+    end
+
+    it "captures logs from BroadcastLogger" do
+      Rails.logger.info("Broadcast message")
+
+      Sentry.get_current_client.log_event_buffer.flush
+
+      expect(sentry_logs).not_to be_empty
+
+      log_messages = sentry_logs.map { |log| log[:body] }
+      expect(log_messages).to include("Broadcast message")
+
+      broadcast_log = sentry_logs.find { |log| log[:body] == "Broadcast message" }
+      expect(broadcast_log[:level]).to eq("info")
+
+      expect(string_io1.string).to include("Broadcast message")
+      expect(string_io2.string).to include("Broadcast message")
+    end
+  end
+end