appsignal 3.4.13 → 3.6.1

data/spec/lib/appsignal/rack/body_wrapper_spec.rb

@@ -0,0 +1,220 @@
+describe Appsignal::Rack::BodyWrapper do
+  let(:nil_txn) { Appsignal::Transaction::NilTransaction.new }
+
+  describe "with a body that supports all possible features" do
+    it "reduces the supported methods to just each()" do
+      # which is the safest thing to do, since the body is likely broken
+      fake_body = double(:each => nil, :call => nil, :to_ary => [], :to_path => "/tmp/foo.bin",
+        :close => nil)
+      wrapped = described_class.wrap(fake_body, nil_txn)
+      expect(wrapped).to respond_to(:each)
+      expect(wrapped).not_to respond_to(:to_ary)
+      expect(wrapped).not_to respond_to(:call)
+      expect(wrapped).to respond_to(:close)
+    end
+  end
+
+  describe "with a body only supporting each()" do
+    it "wraps with appropriate class" do
+      fake_body = double
+      allow(fake_body).to receive(:each)
+
+      wrapped = described_class.wrap(fake_body, nil_txn)
+      expect(wrapped).to respond_to(:each)
+      expect(wrapped).not_to respond_to(:to_ary)
+      expect(wrapped).not_to respond_to(:call)
+      expect(wrapped).to respond_to(:close)
+    end
+
+    it "reads out the body in full using each" do
+      fake_body = double
+      expect(fake_body).to receive(:each).once.and_yield("a").and_yield("b").and_yield("c")
+      wrapped = described_class.wrap(fake_body, nil_txn)
+      expect { |b| wrapped.each(&b) }.to yield_successive_args("a", "b", "c")
+    end
+
+    it "returns an Enumerator if each() gets called without a block" do
+      fake_body = double
+      expect(fake_body).to receive(:each).once.and_yield("a").and_yield("b").and_yield("c")
+
+      wrapped = described_class.wrap(fake_body, nil_txn)
+      enum = wrapped.each
+      expect(enum).to be_kind_of(Enumerator)
+      expect { |b| enum.each(&b) }.to yield_successive_args("a", "b", "c")
+    end
+
+    it "sets the exception raised inside each() into the Appsignal transaction" do
+      fake_body = double
+      expect(fake_body).to receive(:each).once.and_raise(Exception.new("Oops"))
+
+      txn = double("Appsignal transaction", "nil_transaction?" => false)
+      expect(txn).to receive(:set_error).once.with(instance_of(Exception))
+
+      wrapped = described_class.wrap(fake_body, txn)
+      expect do
+        expect { |b| wrapped.each(&b) }.to yield_control
+      end.to raise_error(/Oops/)
+    end
+
+    it "closes the body and the transaction when it gets closed" do
+      fake_body = double
+      expect(fake_body).to receive(:each).once.and_yield("a").and_yield("b").and_yield("c")
+
+      txn = double("Appsignal transaction", "nil_transaction?" => false)
+      expect(Appsignal::Transaction).to receive(:complete_current!).once
+
+      wrapped = described_class.wrap(fake_body, txn)
+      expect { |b| wrapped.each(&b) }.to yield_successive_args("a", "b", "c")
+      expect { wrapped.close }.not_to raise_error
+    end
+  end
+
+  describe "with a body supporting both each() and call" do
+    it "wraps with the wrapper that conceals call() and exposes each" do
+      fake_body = double
+      allow(fake_body).to receive(:each)
+      allow(fake_body).to receive(:call)
+
+      wrapped = described_class.wrap(fake_body, nil_txn)
+      expect(wrapped).to respond_to(:each)
+      expect(wrapped).not_to respond_to(:to_ary)
+      expect(wrapped).not_to respond_to(:call)
+      expect(wrapped).not_to respond_to(:to_path)
+      expect(wrapped).to respond_to(:close)
+    end
+  end
+
+  describe "with a body supporting both to_ary and each" do
+    let(:fake_body) { double(:each => nil, :to_ary => []) }
+    it "wraps with appropriate class" do
+      wrapped = described_class.wrap(fake_body, nil_txn)
+      expect(wrapped).to respond_to(:each)
+      expect(wrapped).to respond_to(:to_ary)
+      expect(wrapped).not_to respond_to(:call)
+      expect(wrapped).not_to respond_to(:to_path)
+      expect(wrapped).to respond_to(:close)
+    end
+
+    it "reads out the body in full using each" do
+      expect(fake_body).to receive(:each).once.and_yield("a").and_yield("b").and_yield("c")
+
+      wrapped = described_class.wrap(fake_body, nil_txn)
+      expect { |b| wrapped.each(&b) }.to yield_successive_args("a", "b", "c")
+    end
+
+    it "sets the exception raised inside each() into the Appsignal transaction" do
+      expect(fake_body).to receive(:each).once.and_raise(Exception.new("Oops"))
+
+      txn = double("Appsignal transaction", "nil_transaction?" => false)
+      expect(txn).to receive(:set_error).once.with(instance_of(Exception))
+
+      wrapped = described_class.wrap(fake_body, txn)
+      expect do
+        expect { |b| wrapped.each(&b) }.to yield_control
+      end.to raise_error(/Oops/)
+    end
+
+    it "reads out the body in full using to_ary" do
+      expect(fake_body).to receive(:to_ary).and_return(["one", "two", "three"])
+
+      wrapped = described_class.wrap(fake_body, nil_txn)
+      expect(wrapped.to_ary).to eq(["one", "two", "three"])
+    end
+
+    it "sends the exception raised inside to_ary() into the Appsignal and closes txn" do
+      fake_body = double
+      allow(fake_body).to receive(:each)
+      expect(fake_body).to receive(:to_ary).once.and_raise(Exception.new("Oops"))
+      expect(fake_body).not_to receive(:close) # Per spec we expect the body has closed itself
+
+      txn = double("Appsignal transaction", "nil_transaction?" => false)
+      expect(txn).to receive(:set_error).once.with(instance_of(Exception))
+      expect(Appsignal::Transaction).to receive(:complete_current!).once
+
+      wrapped = described_class.wrap(fake_body, txn)
+      expect { wrapped.to_ary }.to raise_error(/Oops/)
+    end
+  end
+
+  describe "with a body supporting both to_path and each" do
+    let(:fake_body) { double(:each => nil, :to_path => nil) }
+
+    it "wraps with appropriate class" do
+      wrapped = described_class.wrap(fake_body, nil_txn)
+      expect(wrapped).to respond_to(:each)
+      expect(wrapped).not_to respond_to(:to_ary)
+      expect(wrapped).not_to respond_to(:call)
+      expect(wrapped).to respond_to(:to_path)
+      expect(wrapped).to respond_to(:close)
+    end
+
+    it "reads out the body in full using each()" do
+      expect(fake_body).to receive(:each).once.and_yield("a").and_yield("b").and_yield("c")
+
+      wrapped = described_class.wrap(fake_body, nil_txn)
+      expect { |b| wrapped.each(&b) }.to yield_successive_args("a", "b", "c")
+    end
+
+    it "sets the exception raised inside each() into the Appsignal transaction" do
+      expect(fake_body).to receive(:each).once.and_raise(Exception.new("Oops"))
+
+      txn = double("Appsignal transaction", "nil_transaction?" => false)
+      expect(txn).to receive(:set_error).once.with(instance_of(Exception))
+
+      wrapped = described_class.wrap(fake_body, txn)
+      expect do
+        expect { |b| wrapped.each(&b) }.to yield_control
+      end.to raise_error(/Oops/)
+    end
+
+    it "sets the exception raised inside to_path() into the Appsignal transaction" do
+      allow(fake_body).to receive(:to_path).once.and_raise(Exception.new("Oops"))
+
+      txn = double("Appsignal transaction", "nil_transaction?" => false)
+      expect(txn).to receive(:set_error).once.with(instance_of(Exception))
+      expect(txn).not_to receive(:complete) # gets called by the caller via close()
+
+      wrapped = described_class.wrap(fake_body, txn)
+      expect { wrapped.to_path }.to raise_error(/Oops/)
+    end
+
+    it "exposes to_path to the sender" do
+      allow(fake_body).to receive(:to_path).and_return("/tmp/file.bin")
+
+      wrapped = described_class.wrap(fake_body, nil_txn)
+      expect(wrapped.to_path).to eq("/tmp/file.bin")
+    end
+  end
+
+  describe "with a body only supporting call()" do
+    let(:fake_body) { double(:call => nil) }
+    it "wraps with appropriate class" do
+      wrapped = described_class.wrap(fake_body, nil_txn)
+      expect(wrapped).not_to respond_to(:each)
+      expect(wrapped).not_to respond_to(:to_ary)
+      expect(wrapped).to respond_to(:call)
+      expect(wrapped).not_to respond_to(:to_path)
+      expect(wrapped).to respond_to(:close)
+    end
+
+    it "passes the stream into the call() of the body" do
+      fake_rack_stream = double("stream")
+      expect(fake_body).to receive(:call).with(fake_rack_stream)
+
+      wrapped = described_class.wrap(fake_body, nil_txn)
+      expect { wrapped.call(fake_rack_stream) }.not_to raise_error
+    end
+
+    it "sets the exception raised inside call() into the Appsignal transaction" do
+      fake_rack_stream = double
+      allow(fake_body).to receive(:call).with(fake_rack_stream).and_raise(Exception.new("Oopsie"))
+
+      txn = double("Appsignal transaction", "nil_transaction?" => false)
+      expect(txn).to receive(:set_error).once.with(instance_of(Exception))
+      expect(txn).not_to receive(:complete) # gets called by the caller via close()
+      wrapped = described_class.wrap(fake_body, txn)
+
+      expect { wrapped.call(fake_rack_stream) }.to raise_error(/Oopsie/)
+    end
+  end
+end

data/spec/lib/appsignal/rack/generic_instrumentation_spec.rb

@@ -50,7 +50,7 @@ describe Appsignal::Rack::GenericInstrumentation do
       expect(app).to receive(:call).with(env)
     end
 
-    context "with an exception", :error => true do
+    context "with an exception raised from call()", :error => true do
       let(:error) { ExampleException }
       let(:app) do
         double.tap do |d|
@@ -58,8 +58,9 @@ describe Appsignal::Rack::GenericInstrumentation do
         end
       end
 
-      it "records the exception" do
+      it "records the exception and completes the transaction" do
         expect_any_instance_of(Appsignal::Transaction).to receive(:set_error).with(error)
+        expect(Appsignal::Transaction).to receive(:complete_current!)
       end
     end
 

data/spec/lib/appsignal/rack/rails_instrumentation_spec.rb

@@ -6,7 +6,7 @@ if DependencyHelper.rails_present?
     let(:log) { StringIO.new }
     before do
       start_agent
-      Appsignal.logger = test_logger(log)
+      Appsignal.internal_logger = test_logger(log)
     end
 
     let(:params) do
@@ -65,7 +65,8 @@ if DependencyHelper.rails_present?
 
     describe "#call_with_appsignal_monitoring" do
       def run
-        middleware.call(env)
+        _status, _headers, body = middleware.call(env)
+        body.close # Rack will always call close() on the body
       end
 
       it "calls the wrapped app" do
@@ -126,7 +127,8 @@ if DependencyHelper.rails_present?
           end
         end
 
-        it "records the exception" do
+        it "records the exception and completes the transaction" do
+          expect(Appsignal::Transaction).to receive(:complete_current!)
           expect { run }.to raise_error(error)
 
           transaction_hash = last_transaction.to_h

data/spec/lib/appsignal/rack/sinatra_instrumentation_spec.rb

@@ -3,7 +3,9 @@ if DependencyHelper.sinatra_present?
 
   module SinatraRequestHelpers
     def make_request(env)
-      middleware.call(env)
+      _status, _headers, body = middleware.call(env)
+      # Close the body so that the transaction gets completed
+      body&.close
     end
 
     def make_request_with_error(env, error)

data/spec/lib/appsignal/rack/streaming_listener_spec.rb

@@ -90,10 +90,11 @@ describe Appsignal::Rack::StreamingListener do
     context "with an exception in the instrumentation call" do
       let(:error) { ExampleException }
 
-      it "should add the exception to the transaction" do
+      it "should add the exception to the transaction and complete the transaction" do
         allow(app).to receive(:call).and_raise(error)
 
         expect(transaction).to receive(:set_error).with(error)
+        expect(Appsignal::Transaction).to receive(:complete_current!).and_call_original
 
         expect do
           listener.call_with_appsignal_monitoring(env)
@@ -101,64 +102,19 @@ describe Appsignal::Rack::StreamingListener do
       end
     end
 
-    it "should wrap the body in a wrapper" do
-      expect(Appsignal::StreamWrapper).to receive(:new)
-        .with("body", transaction)
-        .and_return(wrapper)
-
+    it "should wrap the response body in a wrapper" do
       body = listener.call_with_appsignal_monitoring(env)[2]
 
-      expect(body).to be_a(Appsignal::StreamWrapper)
+      expect(body).to be_kind_of(Appsignal::Rack::BodyWrapper)
     end
   end
 end
 
 describe Appsignal::StreamWrapper do
-  let(:stream)      { double }
-  let(:transaction) do
-    Appsignal::Transaction.create(SecureRandom.uuid, Appsignal::Transaction::HTTP_REQUEST, {})
-  end
-  let(:wrapper) { Appsignal::StreamWrapper.new(stream, transaction) }
-
-  describe "#each" do
-    it "calls the original stream" do
-      expect(stream).to receive(:each)
-
-      wrapper.each
-    end
-
-    context "when #each raises an error" do
-      let(:error) { ExampleException }
-
-      it "records the exception" do
-        allow(stream).to receive(:each).and_raise(error)
-
-        expect(transaction).to receive(:set_error).with(error)
-
-        expect { wrapper.send(:each) }.to raise_error(error)
-      end
-    end
-  end
-
-  describe "#close" do
-    it "closes the original stream and completes the transaction" do
-      expect(stream).to receive(:close)
-      expect(Appsignal::Transaction).to receive(:complete_current!)
-
-      wrapper.close
-    end
-
-    context "when #close raises an error" do
-      let(:error) { ExampleException }
-
-      it "records the exception and completes the transaction" do
-        allow(stream).to receive(:close).and_raise(error)
-
-        expect(transaction).to receive(:set_error).with(error)
-        expect(transaction).to receive(:complete)
-
-        expect { wrapper.send(:close) }.to raise_error(error)
-      end
-    end
+  it ".new returns an EnumerableWrapper" do
+    fake_body = double(:each => nil)
+    fake_txn = double
+    stream_wrapper = Appsignal::StreamWrapper.new(fake_body, fake_txn)
+    expect(stream_wrapper).to be_kind_of(Appsignal::Rack::EnumerableBodyWrapper)
   end
 end

data/spec/lib/appsignal/transaction_spec.rb

@@ -580,7 +580,7 @@ describe Appsignal::Transaction do
       it "does not raise an error when the queue start is too big" do
         expect(transaction.ext).to receive(:set_queue_start).and_raise(RangeError)
 
-        expect(Appsignal.logger).to receive(:warn).with("Queue start value 10 is too big")
+        expect(Appsignal.internal_logger).to receive(:warn).with("Queue start value 10 is too big")
 
         expect do
           transaction.set_queue_start(10)
@@ -766,7 +766,7 @@ describe Appsignal::Transaction do
         let(:error) { Object.new }
 
         it "does not add the error" do
-          expect(Appsignal.logger).to receive(:error).with(
+          expect(Appsignal.internal_logger).to receive(:error).with(
             "Appsignal::Transaction#set_error: Cannot set error. " \
               "The given value is not an exception: #{error.inspect}"
           )
@@ -788,6 +788,99 @@ describe Appsignal::Transaction do
         end
       end
 
+      context "when the error has no causes" do
+        it "should not send the causes information as sample data" do
+          expect(transaction.ext).to_not receive(:set_sample_data)
+
+          transaction.set_error(error)
+        end
+      end
+
+      context "when the error has multiple causes" do
+        let(:error) do
+          e = ExampleStandardError.new("test message")
+          e2 = RuntimeError.new("cause message")
+          e3 = StandardError.new("cause message 2")
+          allow(e).to receive(:backtrace).and_return(["line 1"])
+          allow(e).to receive(:cause).and_return(e2)
+          allow(e2).to receive(:cause).and_return(e3)
+          e
+        end
+
+        it "sends the causes information as sample data" do
+          expect(transaction.ext).to receive(:set_error).with(
+            "ExampleStandardError",
+            "test message",
+            Appsignal::Utils::Data.generate(["line 1"])
+          )
+
+          expect(transaction.ext).to receive(:set_sample_data).with(
+            "error_causes",
+            Appsignal::Utils::Data.generate(
+              [
+                {
+                  :name => "RuntimeError",
+                  :message => "cause message"
+                },
+                {
+                  :name => "StandardError",
+                  :message => "cause message 2"
+                }
+              ]
+            )
+          )
+
+          expect(Appsignal.internal_logger).to_not receive(:debug)
+
+          transaction.set_error(error)
+        end
+      end
+
+      context "when the error has too many causes" do
+        let(:error) do
+          e = ExampleStandardError.new("root cause error")
+
+          11.times do |i|
+            next_e = ExampleStandardError.new("wrapper error #{i}")
+            allow(next_e).to receive(:cause).and_return(e)
+            e = next_e
+          end
+
+          allow(e).to receive(:backtrace).and_return(["line 1"])
+          e
+        end
+
+        it "sends only the first causes as sample data" do
+          expect(transaction.ext).to receive(:set_error).with(
+            "ExampleStandardError",
+            "wrapper error 10",
+            Appsignal::Utils::Data.generate(["line 1"])
+          )
+
+          expected_error_causes = Array.new(10) do |i|
+            {
+              :name => "ExampleStandardError",
+              :message => "wrapper error #{9 - i}"
+            }
+          end
+
+          expected_error_causes.last[:is_root_cause] = false
+
+          expect(transaction.ext).to receive(:set_sample_data).with(
+            "error_causes",
+            Appsignal::Utils::Data.generate(expected_error_causes)
+          )
+
+          expect(Appsignal.internal_logger).to receive(:debug).with(
+            "Appsignal::Transaction#set_error: Error has more " \
+              "than 10 error causes. Only the first 10 " \
+              "will be reported."
+          )
+
+          transaction.set_error(error)
+        end
+      end
+
       context "when error message is nil" do
         let(:error) do
           e = ExampleStandardError.new