appsignal 3.5.6 → 3.6.0

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

@@ -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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 3.5.6
+  version: 3.6.0
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-08 00:00:00.000000000 Z
+date: 2024-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -268,6 +268,7 @@ files:
 - lib/appsignal/probes/helpers.rb
 - lib/appsignal/probes/mri.rb
 - lib/appsignal/probes/sidekiq.rb
+- lib/appsignal/rack/body_wrapper.rb
 - lib/appsignal/rack/generic_instrumentation.rb
 - lib/appsignal/rack/rails_instrumentation.rb
 - lib/appsignal/rack/sinatra_instrumentation.rb
@@ -366,6 +367,7 @@ files:
 - spec/lib/appsignal/probes/gvl_spec.rb
 - spec/lib/appsignal/probes/mri_spec.rb
 - spec/lib/appsignal/probes/sidekiq_spec.rb
+- spec/lib/appsignal/rack/body_wrapper_spec.rb
 - spec/lib/appsignal/rack/generic_instrumentation_spec.rb
 - spec/lib/appsignal/rack/rails_instrumentation_spec.rb
 - spec/lib/appsignal/rack/sinatra_instrumentation_spec.rb
@@ -451,7 +453,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.11
+rubygems_version: 3.4.15
 signing_key:
 specification_version: 4
 summary: Logs performance and exception data from your app to appsignal.com