Improve DebugTransport

Author: solnic

sentry-ruby/lib/sentry/test_helper.rb

@@ -4,6 +4,9 @@ module Sentry
   module TestHelper
     DUMMY_DSN = "http://12345:67890@sentry.localdomain/sentry/42"
 
+    # Not really real, but it will be resolved as a non-local for testing needs
+    REAL_DSN = "https://user:pass@getsentry.io/project/42"
+
     # Alters the existing SDK configuration with test-suitable options. Mainly:
     # - Sets a dummy DSN instead of `nil` or an actual DSN.
     # - Sets the transport to DummyTransport, which allows easy access to the captured events.

sentry-ruby/lib/sentry/transport/debug_transport.rb

@@ -2,44 +2,35 @@
 
 require "json"
 require "fileutils"
+require "pathname"
+require "delegate"
 
 module Sentry
   # DebugTransport is a transport that logs events to a file for debugging purposes.
   #
   # It can optionally also send events to Sentry via HTTP transport if a real DSN
   # is provided.
+  class DebugTransport < SimpleDelegator
+    DEFAULT_LOG_FILE_PATH = File.join("log", "sentry_debug_events.log")
 
-  DEFAULT_LOG_FILE_PATH = File.join("log", "sentry_debug_events.log")
+    attr_reader :log_file, :backend
 
-  class DebugTransport < Transport
-    attr_reader :log_file_path, :http_transport
+    alias_method :__getobj, :backend
 
     def initialize(configuration)
-      super
+      @log_file = initialize_log_file(configuration)
+      @backend = initialize_backend(configuration)
 
-      @log_file_path = configuration.sdk_debug_transport_log_file || DEFAULT_LOG_FILE_PATH
-
-      FileUtils.mkdir_p(File.dirname(@log_file_path))
-
-      log_debug("DebugTransport: Initialized with log file: #{@log_file_path}")
-
-      if configuration.dsn && !configuration.dsn.to_s.include?("localhost")
-        @http_transport = Sentry::HTTPTransport.new(configuration)
-        log_debug("DebugTransport: Initialized with HTTP transport for DSN: #{configuration.dsn}")
-      else
-        @http_transport = nil
-        log_debug("DebugTransport: Using local-only mode for DSN: #{configuration.dsn}")
-      end
+      super(@backend)
     end
 
     def send_event(event)
-      envelope = envelope_from_event(event)
-      send_envelope(envelope)
-      event
+      log_envelope(envelope_from_event(event))
+      backend.send_event(event)
     end
 
-    def send_envelope(envelope)
-      envelope_data = {
+    def log_envelope(envelope)
+      envelope_json = {
         timestamp: Time.now.utc.iso8601,
         envelope_headers: envelope.headers,
         items: envelope.items.map do |item|
@@ -50,26 +41,35 @@ def send_envelope(envelope)
         end
       }
 
-      File.open(log_file_path, "a") do |file|
-        file << JSON.dump(envelope_data) << "\n"
-      end
-
-      if http_transport
-        http_transport.send_envelope(envelope)
-      end
+      File.open(log_file, "a") { |file| file << JSON.dump(envelope_json) << "\n" }
     end
 
-    def events
-      return [] unless File.exist?(log_file_path)
+    def logged_envelopes
+      return [] unless File.exist?(log_file)
 
-      File.readlines(log_file_path).map do |line|
+      File.readlines(log_file).map do |line|
         JSON.parse(line)
       end
     end
 
     def clear
-      File.write(log_file_path, "")
-      log_debug("DebugTransport: Cleared events from #{log_file_path}")
+      File.write(log_file, "")
+      log_debug("DebugTransport: Cleared events from #{log_file}")
+    end
+
+    private
+
+    def initialize_backend(configuration)
+      backend = configuration.dsn.local? ? DummyTransport : HTTPTransport
+      backend.new(configuration)
+    end
+
+    def initialize_log_file(configuration)
+      log_file = Pathname(configuration.sdk_debug_transport_log_file || DEFAULT_LOG_FILE_PATH)
+
+      FileUtils.mkdir_p(log_file.dirname) unless log_file.dirname.exist?
+
+      log_file
     end
   end
 end

sentry-ruby/lib/sentry/transport/dummy_transport.rb

@@ -12,6 +12,7 @@ def initialize(*)
 
     def send_event(event)
       @events << event
+      super
     end
 
     def send_envelope(envelope)

sentry-ruby/spec/sentry/transport/debug_transport_spec.rb

@@ -1,36 +1,62 @@
 # frozen_string_literal: true
 
-require 'contexts/with_request_mock'
-
 RSpec.describe Sentry do
-  include_context "with request mock"
-
   let(:client) { Sentry.get_current_client }
   let(:transport) { Sentry.get_current_client.transport }
+  let(:error) { StandardError.new("test error") }
 
-  before :all do
+  before do
     perform_basic_setup
-  end
 
-  before do
     setup_sentry_test do |config|
+      config.dsn = dsn
       config.transport.transport_class = Sentry::DebugTransport
+      config.debug = true
     end
   end
 
   after do
     teardown_sentry_test
   end
 
-  describe ".send_event" do
-    let(:event) { Sentry.get_current_client.event_from_message("test message") }
+  context "with local DSN for testing" do
+    let(:dsn) { Sentry::TestHelper::DUMMY_DSN }
+
+    describe ".capture_exception with debug transport" do
+      it "logs envelope data and stores an event internally" do
+        Sentry.capture_exception(error)
+
+        expect(transport.events.count).to be(1)
+        expect(transport.backend.events.count).to be(1)
+        expect(transport.backend.envelopes.count).to be(1)
+
+        event = transport.logged_envelopes.last
+        item = event["items"].first
+        payload = item["payload"]
+
+        expect(payload["exception"]["values"].first["value"]).to include("test error")
+      end
+    end
+  end
+
+  context "with a real DSN for testing" do
+    let(:dsn) { Sentry::TestHelper::REAL_DSN }
+
+    describe ".capture_exception with debug transport" do
+      it "sends an event and logs envelope" do
+        stub_request(:post, "https://getsentry.io/project/api/42/envelope/")
+          .to_return(status: 200, body: "", headers: {})
+
+        Sentry.capture_exception(error)
 
-    it "sends the event and logs to a file" do
-      sentry_stub_request(build_fake_response("200"))
+        expect(transport.logged_envelopes.count).to be(1)
 
-      Sentry.send_event(event)
+        event = transport.logged_envelopes.last
+        item = event["items"].first
+        payload = item["payload"]
 
-      expect(transport.events.count).to be(1)
+        expect(payload["exception"]["values"].first["value"]).to include("test error")
+      end
     end
   end
 end