Simplify Spotlight

Author: natikgadzhi

sentry-ruby/lib/sentry/configuration.rb

@@ -7,7 +7,6 @@
 require "sentry/dsn"
 require "sentry/release_detector"
 require "sentry/transport/configuration"
-require "sentry/spotlight/configuration"
 require "sentry/linecache"
 require "sentry/interfaces/stacktrace_builder"
 
@@ -142,6 +141,14 @@ class Configuration
     # Whether to capture local variables from the raised exception's frame. Default is false.
     # @return [Boolean]
     attr_accessor :include_local_variables
+    
+    # Whether to capture events and traces into Spotlight. Default is false.
+    # If you set this to true, Sentry will send events and traces to the local
+    # Sidecar proxy at http://localhost:8969/stream.
+    # If you want to use a different Sidecar proxy address, set this to String
+    # with the proxy URL.
+    # @return [Boolean, String]
+    attr_accessor :spotlight
 
     # @deprecated Use {#include_local_variables} instead.
     alias_method :capture_exception_frame_locals, :include_local_variables
@@ -360,11 +367,11 @@ def initialize
       self.traces_sampler = nil
       self.enable_tracing = nil
 
+      self.spotlight = false
+
       @transport = Transport::Configuration.new
       @gem_specs = Hash[Gem::Specification.map { |spec| [spec.name, spec.version.to_s] }] if Gem::Specification.respond_to?(:map)
 
-      @spotlight = Spotlight::Configuration.new
-
       run_post_initialization_callbacks
     end
 

sentry-ruby/lib/sentry/spotlight.rb

@@ -1,2 +1,63 @@
-require "sentry/spotlight/configuration"
-require "sentry/spotlight/transport"
+# frozen_string_literal: true
+
+require "net/http"
+require "zlib"
+
+module Sentry
+    
+  # Spotlight Transport class is like HTTPTransport,
+  # but it's experimental, with limited featureset. 
+  # - It does not care about rate limits, assuming working with local Sidecar proxy
+  # - Designed to just report events to Spotlight in development.
+  #  
+  # TODO: This needs a cleanup, we could extract most of common code into a module.
+  class Spotlight
+    GZIP_ENCODING = "gzip"
+    GZIP_THRESHOLD = 1024 * 30
+    CONTENT_TYPE = 'application/x-sentry-envelope'
+    USER_AGENT = "sentry-ruby/#{Sentry::VERSION}"
+    
+    # Takes the sidecar URL in and initializes the new Spotlight transport.
+    # HTTPTransport will call this if config.spotlight is truthy, and pass it here.
+    # so sidecar_url arg can either be true, or a string with the sidecar URL.
+    def initialize(sidecar_url)
+      @sidecar_url = sidecar_url.is_a?(String) ? sidecar_url : "http://localhost:8769/stream"
+    end
+
+    def send_data(data)
+      headers = {
+        'Content-Type' => CONTENT_TYPE,
+        'Content-Encoding' => "",
+        'User-Agent' => USER_AGENT
+      }
+
+      response = conn.start do |http|
+        request = ::Net::HTTP::Post.new(@sidecar_url, headers)
+        request.body = data
+        http.request(request)
+      end
+
+      unless response.code.match?(/\A2\d{2}/)
+        error_info = "the server responded with status #{response.code}"
+        error_info += "\nbody: #{response.body}"
+        error_info += " Error in headers is: #{response['x-sentry-error']}" if response['x-sentry-error']
+
+        raise Sentry::ExternalError, error_info
+      end
+
+    # TODO: We might want to rescue the other HTTP_ERRORS like in HTTPTransport
+    rescue SocketError, * Sentry::HTTPTransport::HTTP_ERRORS => e
+      raise Sentry::ExternalError.new(e.message)
+    end
+
+    private
+
+    # Similar to HTTPTransport connection, but does not support Proxy and SSL 
+    def conn
+      sidecar = URI(@sidecar_url)
+      connection = ::Net::HTTP.new(sidecar.hostname, sidecar.port, nil)
+      connection.use_ssl = false
+      connection
+    end
+  end
+end

sentry-ruby/lib/sentry/spotlight/configuration.rb

@@ -32,7 +32,7 @@ class Transport
     def initialize(configuration)
       @logger = configuration.logger
       @transport_configuration = configuration.transport
-      @spotlight_configuration = configuration.spotlight
+      @spotlight = configuration.spotlight
       @dsn = configuration.dsn
       @rate_limits = {}
       @send_client_reports = configuration.send_client_reports

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

@@ -23,20 +23,21 @@ class HTTPTransport < Transport
       Zlib::BufError, Errno::EHOSTUNREACH, Errno::ECONNREFUSED
     ].freeze
 
-
     def initialize(*args)
       super
       @endpoint = @dsn.envelope_endpoint
 
       log_debug("Sentry HTTP Transport will connect to #{@dsn.server}")
 
-      if @spotlight_configuration.enabled?
-        @spotlight_transport = Sentry::Spotlight::Transport.new(@transport_configuration)
+      if @spotlight
+        @spotlight_transport = Sentry::Spotlight.new(@spotlight)
       end
     end
 
     def send_data(data)
-      @spotlight_transport.send_data(data) unless @spotlight_transport.nil?
+      if should_send_to_spotlight?
+        @spotlight_transport.send_data(data)
+      end
 
       encoding = ""
 
@@ -142,6 +143,10 @@ def should_compress?(data)
       @transport_configuration.encoding == GZIP_ENCODING && data.bytesize >= GZIP_THRESHOLD
     end
 
+    def should_send_to_spotlight?
+      !@spotlight_transport.nil?
+    end
+
     def conn
       server = URI(@dsn.server)
 

sentry-ruby/lib/sentry/transport.rb

@@ -258,9 +258,7 @@
 
   describe "#spotlight" do
     it "returns initialized Spotlight config by default" do
-      spotlight_config = subject.spotlight
-      expect(spotlight_config.enabled).to eq(false)
-      expect(spotlight_config.sidecar_url).to eq("http://localhost:8969/stream")
+      expect(subject.spotlight).to eq(false)
     end
   end
 

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

@@ -324,28 +324,24 @@
 
   describe "Spotlight integration" do
     let(:fake_response) { build_fake_response("200") }
-    context "when spotlight is enabled" do
-      let(:spotlight_transport) { Sentry::Spotlight::Transport.new(configuration.spotlight) }
 
+    context "when spotlight is enabled" do
       it "calls @spotlight_transport.send_data(data)" do
-        configuration.spotlight.enabled = true
+        configuration.spotlight = true
 
         stub_request(fake_response)
 
-        subject.instance_variable_set(:@spotlight_transport, spotlight_transport)
-        expect( spotlight_transport ).to receive(:send_data).with(data)
+        expect( subject.instance_variable_get(:@spotlight_transport) ).to receive(:send_data).with(data)
         subject.send_data(data)
       end
     end
 
     context "when spotlight integration is disabled" do
       let(:spotlight_transport) { nil } 
       it "does not call @spotlight_transport.send_data(data)" do
-        configuration.spotlight.enabled = false
-
         stub_request(fake_response)
 
-        expect( spotlight_transport ).not_to receive(:send_data).with(data)
+        expect( subject.instance_variable_get(:@spotlight_transport) ).not_to receive(:send_data).with(data)
         subject.send_data(data)
       end
     end