Merge branch 'main' into develop

Conflicts: - CHANGELOG.md - lib/appsignal/version.rb
appsignal · Aug 23, 2024 · 6091d1e · 6091d1e
2 parents d4e0626 + 4b0e61d
commit 6091d1e
Show file tree

Hide file tree

Showing 3 changed files with 76 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -121,6 +121,22 @@ _Published on 2024-08-19._
 
 - Fix an issue where, when setting several errors for the same transaction, error causes from a different error would be shown for an error that has no causes. (patch [d54ce8b9](https://github.com/appsignal/appsignal-ruby/commit/d54ce8b947c9316756c4191155e8d255a8e25a8c))
 
+## 3.13.1
+
+_Published on 2024-08-23._
+
+### Changed
+
+- Release the final package version. See the pre-release changelog entries for the changes in this version. (patch)
+
+## 3.13.1.alpha.1
+
+_Published on 2024-08-22._
+
+### Changed
+
+- Ignore `Errno::EPIPE` errors when instrumenting response bodies. We've noticed this error gets reported when the connection is broken between server and client. This happens in normal scenarios so we'll ignore this error in this scenario to avoid error reports from errors that cannot be resolved. (patch [8ad8a057](https://github.com/appsignal/appsignal-ruby/commit/8ad8a05787dcb12a5c7febc64559e7f145a59096))
+
 ## 3.13.0
 
 _Published on 2024-08-14._

diff --git a/lib/appsignal/rack/body_wrapper.rb b/lib/appsignal/rack/body_wrapper.rb
@@ -4,6 +4,8 @@ module Appsignal
   module Rack
     # @api private
     class BodyWrapper
+      IGNORED_ERRORS = [Errno::EPIPE].freeze
+
       def self.wrap(original_body, appsignal_transaction)
         # The logic of how Rack treats a response body differs based on which methods
         # the body responds to. This means that to support the Rack 3.x spec in full
@@ -49,6 +51,8 @@ def close
           Appsignal.instrument("close_response_body.rack") { @body.close }
         end
         @body_already_closed = true
+      rescue *IGNORED_ERRORS # Do not report
+        raise
       rescue Exception => error # rubocop:disable Lint/RescueException
         @transaction.set_error(error)
         raise error
@@ -75,6 +79,8 @@ def each(&blk)
         Appsignal.instrument("process_response_body.rack", "Process Rack response body (#each)") do
           @body.each(&blk)
         end
+      rescue *IGNORED_ERRORS # Do not report
+        raise
       rescue Exception => error # rubocop:disable Lint/RescueException
         @transaction.set_error(error)
         raise error
@@ -94,6 +100,8 @@ def call(stream)
         Appsignal.instrument("process_response_body.rack", "Process Rack response body (#call)") do
           @body.call(stream)
         end
+      rescue *IGNORED_ERRORS # Do not report
+        raise
       rescue Exception => error # rubocop:disable Lint/RescueException
         @transaction.set_error(error)
         raise error
@@ -118,6 +126,8 @@ def to_ary
         ) do
           @body.to_ary
         end
+      rescue *IGNORED_ERRORS # Do not report
+        raise
       rescue Exception => error # rubocop:disable Lint/RescueException
         @transaction.set_error(error)
         raise error
@@ -134,6 +144,8 @@ def to_path
         ) do
           @body.to_path
         end
+      rescue *IGNORED_ERRORS # Do not report
+        raise
       rescue Exception => error # rubocop:disable Lint/RescueException
         @transaction.set_error(error)
         raise error

diff --git a/spec/lib/appsignal/rack/body_wrapper_spec.rb b/spec/lib/appsignal/rack/body_wrapper_spec.rb
@@ -72,6 +72,18 @@
       expect(transaction).to have_error("ExampleException", "error message")
     end
 
+    it "doesn't report EPIPE error" do
+      fake_body = double
+      expect(fake_body).to receive(:each).once.and_raise(Errno::EPIPE)
+
+      wrapped = described_class.wrap(fake_body, transaction)
+      expect do
+        expect { |b| wrapped.each(&b) }.to yield_control
+      end.to raise_error(Errno::EPIPE)
+
+      expect(transaction).to_not have_error
+    end
+
     it "closes the body and tracks an instrumentation event when it gets closed" do
       fake_body = double(:close => nil)
       expect(fake_body).to receive(:each).once.and_yield("a").and_yield("b").and_yield("c")
@@ -134,6 +146,17 @@
       expect(transaction).to have_error("ExampleException", "error message")
     end
 
+    it "doesn't report EPIPE error" do
+      expect(fake_body).to receive(:each).once.and_raise(Errno::EPIPE)
+
+      wrapped = described_class.wrap(fake_body, transaction)
+      expect do
+        expect { |b| wrapped.each(&b) }.to yield_control
+      end.to raise_error(Errno::EPIPE)
+
+      expect(transaction).to_not have_error
+    end
+
     it "reads out the body in full using to_ary" do
       expect(fake_body).to receive(:to_ary).and_return(["one", "two", "three"])
 
@@ -207,6 +230,17 @@
       expect(transaction).to have_error("ExampleException", "error message")
     end
 
+    it "doesn't report EPIPE error" do
+      expect(fake_body).to receive(:to_path).once.and_raise(Errno::EPIPE)
+
+      wrapped = described_class.wrap(fake_body, transaction)
+      expect do
+        wrapped.to_path
+      end.to raise_error(Errno::EPIPE)
+
+      expect(transaction).to_not have_error
+    end
+
     it "exposes to_path to the sender" do
       allow(fake_body).to receive(:to_path).and_return("/tmp/file.bin")
 
@@ -259,5 +293,19 @@
 
       expect(transaction).to have_error("ExampleException", "error message")
     end
+
+    it "doesn't report EPIPE error" do
+      fake_rack_stream = double
+      expect(fake_body).to receive(:call)
+        .with(fake_rack_stream)
+        .and_raise(Errno::EPIPE)
+
+      wrapped = described_class.wrap(fake_body, transaction)
+      expect do
+        wrapped.call(fake_rack_stream)
+      end.to raise_error(Errno::EPIPE)
+
+      expect(transaction).to_not have_error
+    end
   end
 end