Compress event payload by default

Rules:
- If `config.transport.encoding == "gzip"` and the event envelope's
  size is larger than 30kb, the envelope will be compressed.
- If `config.transport.encoding == "gzip"` but the event envelope's
  size is smaller than 30kb, the envelope won't be compressed.
- If `config.transport.encoding != "gzip"`, the event won't be
  compressed regardless how but it is.

Author: st0012

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

@@ -1,12 +1,14 @@
 module Sentry
   class Transport
     class Configuration
-      attr_accessor :timeout, :open_timeout, :proxy, :ssl, :ssl_ca_file, :ssl_verification, :http_adapter, :faraday_builder, :transport_class
+      attr_accessor :timeout, :open_timeout, :proxy, :ssl, :ssl_ca_file, :ssl_verification, :http_adapter, :faraday_builder,
+        :transport_class, :encoding
 
       def initialize
         @ssl_verification = true
         @open_timeout = 1
         @timeout = 2
+        @encoding = HTTPTransport::GZIP_ENCODING
       end
 
       def transport_class=(klass)

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

@@ -1,8 +1,12 @@
 require 'faraday'
+require 'zlib'
 
 module Sentry
   class HTTPTransport < Transport
-    CONTENT_TYPE = 'application/json'
+    GZIP_ENCODING = "gzip"
+    GZIP_THRESHOLD = 1024 * 30
+    CONTENT_TYPE = 'application/x-sentry-envelope'
+
     attr_reader :conn, :adapter
 
     def initialize(*args)
@@ -13,8 +17,16 @@ def initialize(*args)
     end
 
     def send_data(data)
+      encoding = ""
+
+      if should_compress?(data)
+        data = Zlib.gzip(data)
+        encoding = GZIP_ENCODING
+      end
+
       conn.post @endpoint do |req|
         req.headers['Content-Type'] = CONTENT_TYPE
+        req.headers['Content-Encoding'] = encoding
         req.headers['X-Sentry-Auth'] = generate_auth_header
         req.body = data
       end
@@ -31,6 +43,10 @@ def send_data(data)
 
     private
 
+    def should_compress?(data)
+      @transport_configuration.encoding == GZIP_ENCODING && data.bytesize >= GZIP_THRESHOLD
+    end
+
     def set_conn
       server = @dsn.server
 

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

@@ -1,40 +1,92 @@
 require 'spec_helper'
 
 RSpec.describe Sentry::HTTPTransport do
-  let(:client) { Sentry::Client.new(Sentry.configuration) }
-  let(:event) { client.event_from_message("test") }
-  subject { described_class.new(Sentry.configuration) }
-
-  describe "customizations" do
-    before do
-      Sentry.init do |c|
-        c.dsn = 'http://12345@sentry.localdomain/sentry/42'
-      end
+  let(:configuration) do
+    Sentry::Configuration.new.tap do |config|
+      config.dsn = 'http://12345@sentry.localdomain/sentry/42'
     end
+  end
+  let(:client) { Sentry::Client.new(configuration) }
+  let(:event) { client.event_from_message("foobarbaz") }
+  let(:data) do
+    subject.encode(event.to_hash)
+  end
 
+  subject { described_class.new(configuration) }
+
+  describe "customizations" do
     it 'sets a custom User-Agent' do
       expect(subject.conn.headers[:user_agent]).to eq("sentry-ruby/#{Sentry::VERSION}")
     end
 
     it 'allows to customise faraday' do
       builder = spy('faraday_builder')
       expect(Faraday).to receive(:new).and_yield(builder)
-      Sentry.configuration.transport.faraday_builder = proc { |b| b.request :instrumentation }
+      configuration.transport.faraday_builder = proc { |b| b.request :instrumentation }
 
       subject
 
       expect(builder).to have_received(:request).with(:instrumentation)
     end
   end
 
+  describe "request payload" do
+    let(:compressed_stubs) do
+      Faraday::Adapter::Test::Stubs.new do |stub|
+        stub.post('sentry/api/42/envelope/') do |env|
+          expect(env.request_headers["Content-Type"]).to eq("application/x-sentry-envelope")
+          expect(env.request_headers["Content-Encoding"]).to eq("gzip")
+
+          envelope = Zlib.gunzip(env.body)
+          expect(envelope).to include(event.event_id)
+          expect(envelope).to include("foobarbaz")
+        end
+      end
+    end
+
+    let(:uncompressed_stubs) do
+      Faraday::Adapter::Test::Stubs.new do |stub|
+        stub.post('sentry/api/42/envelope/') do |env|
+          expect(env.request_headers["Content-Type"]).to eq("application/x-sentry-envelope")
+          expect(env.request_headers["Content-Encoding"]).to eq("")
+
+          envelope = env.body
+          expect(envelope).to include(event.event_id)
+          expect(envelope).to include("foobarbaz")
+        end
+      end
+    end
+
+    it "compresses data by default" do
+      configuration.transport.http_adapter = [:test, compressed_stubs]
+
+      subject.send_data(data)
+      compressed_stubs.verify_stubbed_calls
+    end
+
+    it "doesn't compress small event" do
+      configuration.transport.http_adapter = [:test, uncompressed_stubs]
+
+      event.instance_variable_set(:@threads, nil) # shrink event
+
+      subject.send_data(data)
+      uncompressed_stubs.verify_stubbed_calls
+    end
+
+    it "doesn't compress data if the encoding is not gzip" do
+      configuration.transport.http_adapter = [:test, uncompressed_stubs]
+      configuration.transport.encoding = "json"
+
+      subject.send_data(data)
+      uncompressed_stubs.verify_stubbed_calls
+    end
+  end
+
   describe "failed request handling" do
     before do
-      Sentry.init do |c|
-        c.dsn = 'http://12345@sentry.localdomain/sentry/42'
-        c.transport.http_adapter = [:test, stubs]
-        c.transport.transport_class = described_class
-      end
+      configuration.transport.http_adapter = [:test, stubs]
     end
+
     context "receive 4xx responses" do
       let(:stubs) do
         Faraday::Adapter::Test::Stubs.new do |stub|
@@ -43,7 +95,7 @@
       end
 
       it 'raises an error' do
-        expect { subject.send_data(event.to_hash) }.to raise_error(Sentry::Error, /the server responded with status 404/)
+        expect { subject.send_data(data) }.to raise_error(Sentry::Error, /the server responded with status 404/)
 
         stubs.verify_stubbed_calls
       end
@@ -57,7 +109,7 @@
       end
 
       it 'raises an error' do
-        expect { subject.send_data(event.to_hash) }.to raise_error(Sentry::Error, /the server responded with status 500/)
+        expect { subject.send_data(data) }.to raise_error(Sentry::Error, /the server responded with status 500/)
 
         stubs.verify_stubbed_calls
       end
@@ -71,7 +123,7 @@
       end
 
       it 'raises an error with header' do
-        expect { subject.send_data(event.to_hash) }.to raise_error(Sentry::Error, /error_in_header/)
+        expect { subject.send_data(data) }.to raise_error(Sentry::Error, /error_in_header/)
 
         stubs.verify_stubbed_calls
       end