appsignal 3.9.2-java → 3.10.0-java

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

@@ -0,0 +1,263 @@
+describe Appsignal::Rack::BodyWrapper do
+  let(:transaction) { http_request_transaction }
+  before do
+    start_agent
+    set_current_transaction(transaction)
+  end
+
+  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, transaction)
+      expect(wrapped).to respond_to(:each)
+      expect(wrapped).to_not respond_to(:to_ary)
+      expect(wrapped).to_not 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(:each => nil)
+
+      wrapped = described_class.wrap(fake_body, transaction)
+      expect(wrapped).to respond_to(:each)
+      expect(wrapped).to_not respond_to(:to_ary)
+      expect(wrapped).to_not 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, transaction)
+      expect { |b| wrapped.each(&b) }.to yield_successive_args("a", "b", "c")
+
+      expect(transaction).to include_event(
+        "name" => "process_response_body.rack",
+        "title" => "Process Rack response body (#each)"
+      )
+    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, transaction)
+      enum = wrapped.each
+      expect(enum).to be_kind_of(Enumerator)
+      expect { |b| enum.each(&b) }.to yield_successive_args("a", "b", "c")
+
+      expect(transaction).to_not include_event("name" => "process_response_body.rack")
+    end
+
+    it "sets the exception raised inside each() on the transaction" do
+      fake_body = double
+      expect(fake_body).to receive(:each).once.and_raise(ExampleException, "error message")
+
+      wrapped = described_class.wrap(fake_body, transaction)
+      expect do
+        expect { |b| wrapped.each(&b) }.to yield_control
+      end.to raise_error(ExampleException, "error message")
+
+      expect(transaction).to have_error("ExampleException", "error message")
+    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")
+
+      wrapped = described_class.wrap(fake_body, transaction)
+      expect { |b| wrapped.each(&b) }.to yield_successive_args("a", "b", "c")
+      wrapped.close
+
+      expect(transaction).to include_event("name" => "close_response_body.rack")
+    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, transaction)
+      expect(wrapped).to respond_to(:each)
+      expect(wrapped).to_not respond_to(:to_ary)
+      expect(wrapped).to_not respond_to(:call)
+      expect(wrapped).to_not 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, transaction)
+      expect(wrapped).to respond_to(:each)
+      expect(wrapped).to respond_to(:to_ary)
+      expect(wrapped).to_not respond_to(:call)
+      expect(wrapped).to_not 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, transaction)
+      expect { |b| wrapped.each(&b) }.to yield_successive_args("a", "b", "c")
+
+      expect(transaction).to include_event(
+        "name" => "process_response_body.rack",
+        "title" => "Process Rack response body (#each)"
+      )
+    end
+
+    it "sets the exception raised inside each() into the Appsignal transaction" do
+      expect(fake_body).to receive(:each).once.and_raise(ExampleException, "error message")
+
+      wrapped = described_class.wrap(fake_body, transaction)
+      expect do
+        expect { |b| wrapped.each(&b) }.to yield_control
+      end.to raise_error(ExampleException, "error message")
+
+      expect(transaction).to have_error("ExampleException", "error message")
+    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, transaction)
+      expect(wrapped.to_ary).to eq(["one", "two", "three"])
+
+      expect(transaction).to include_event(
+        "name" => "process_response_body.rack",
+        "title" => "Process Rack response body (#to_ary)"
+      )
+    end
+
+    it "sends the exception raised inside to_ary() into the Appsignal and closes transaction" do
+      fake_body = double
+      allow(fake_body).to receive(:each)
+      expect(fake_body).to receive(:to_ary).once.and_raise(ExampleException, "error message")
+      expect(fake_body).to_not receive(:close) # Per spec we expect the body has closed itself
+
+      wrapped = described_class.wrap(fake_body, transaction)
+      expect do
+        wrapped.to_ary
+      end.to raise_error(ExampleException, "error message")
+
+      expect(transaction).to have_error("ExampleException", "error message")
+    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, transaction)
+      expect(wrapped).to respond_to(:each)
+      expect(wrapped).to_not respond_to(:to_ary)
+      expect(wrapped).to_not 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, transaction)
+      expect { |b| wrapped.each(&b) }.to yield_successive_args("a", "b", "c")
+
+      expect(transaction).to include_event(
+        "name" => "process_response_body.rack",
+        "title" => "Process Rack response body (#each)"
+      )
+    end
+
+    it "sets the exception raised inside each() into the Appsignal transaction" do
+      expect(fake_body).to receive(:each).once.and_raise(ExampleException, "error message")
+
+      wrapped = described_class.wrap(fake_body, transaction)
+      expect do
+        expect { |b| wrapped.each(&b) }.to yield_control
+      end.to raise_error(ExampleException, "error message")
+
+      expect(transaction).to have_error("ExampleException", "error message")
+    end
+
+    it "sets the exception raised inside to_path() into the Appsignal transaction" do
+      allow(fake_body).to receive(:to_path).once.and_raise(ExampleException, "error message")
+
+      wrapped = described_class.wrap(fake_body, transaction)
+      expect do
+        wrapped.to_path
+      end.to raise_error(ExampleException, "error message")
+
+      expect(transaction).to have_error("ExampleException", "error message")
+    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, transaction)
+      expect(wrapped.to_path).to eq("/tmp/file.bin")
+
+      expect(transaction).to include_event(
+        "name" => "process_response_body.rack",
+        "title" => "Process Rack response body (#to_path)"
+      )
+    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, transaction)
+      expect(wrapped).to_not respond_to(:each)
+      expect(wrapped).to_not respond_to(:to_ary)
+      expect(wrapped).to respond_to(:call)
+      expect(wrapped).to_not 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, transaction)
+      wrapped.call(fake_rack_stream)
+
+      expect(transaction).to include_event(
+        "name" => "process_response_body.rack",
+        "title" => "Process Rack response body (#call)"
+      )
+    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(ExampleException, "error message")
+
+      wrapped = described_class.wrap(fake_body, transaction)
+
+      expect do
+        wrapped.call(fake_rack_stream)
+      end.to raise_error(ExampleException, "error message")
+
+      expect(transaction).to have_error("ExampleException", "error message")
+    end
+  end
+end

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

@@ -22,17 +22,19 @@ describe Appsignal::Rack::EventHandler do
     event_handler_instance.on_start(request, response)
   end
 
+  def on_error(error)
+    event_handler_instance.on_error(request, response, error)
+  end
+
   describe "#on_start" do
     it "creates a new transaction" do
       expect { on_start }.to change { created_transactions.length }.by(1)
 
       transaction = last_transaction
-      expect(transaction.to_h).to include(
-        "id" => kind_of(String),
-        "namespace" => Appsignal::Transaction::HTTP_REQUEST
-      )
+      expect(transaction).to have_id
+      expect(transaction).to have_namespace(Appsignal::Transaction::HTTP_REQUEST)
 
-      expect(Appsignal::Transaction.current).to eq(last_transaction)
+      expect(Appsignal::Transaction.current).to eq(transaction)
     end
 
     context "when the handler is nested in another EventHandler" do
@@ -119,21 +121,11 @@ describe Appsignal::Rack::EventHandler do
   end
 
   describe "#on_error" do
-    def on_error(error)
-      event_handler_instance.on_error(request, response, error)
-    end
-
     it "reports the error" do
       on_start
       on_error(ExampleStandardError.new("the error"))
 
-      expect(last_transaction.to_h).to include(
-        "error" => {
-          "name" => "ExampleStandardError",
-          "message" => "the error",
-          "backtrace" => kind_of(String)
-        }
-      )
+      expect(last_transaction).to have_error("ExampleStandardError", "the error")
     end
 
     context "when the handler is nested in another EventHandler" do
@@ -141,7 +133,7 @@ describe Appsignal::Rack::EventHandler do
         on_start
         described_class.new.on_error(request, response, ExampleStandardError.new("the error"))
 
-        expect(last_transaction.to_h).to include("error" => nil)
+        expect(last_transaction).to_not have_error
       end
     end
 
@@ -174,11 +166,9 @@ describe Appsignal::Rack::EventHandler do
 
       on_finish
 
-      expect(last_transaction.to_h).to include(
-        "action" => nil,
-        "sample_data" => {},
-        "events" => []
-      )
+      expect(last_transaction).to_not have_action
+      expect(last_transaction).to_not include_events
+      expect(last_transaction).to include("sample_data" => {})
       expect(last_transaction).to_not be_completed
     end
 
@@ -186,18 +176,12 @@ describe Appsignal::Rack::EventHandler do
       on_start
       on_finish
 
-      expect(last_transaction.to_h).to include(
-        # The action is not set on purpose, as we can't set a normalized route
-        # It requires the app to set an action name
-        "action" => nil,
-        "sample_data" => hash_including(
-          "environment" => {
-            "REQUEST_METHOD" => "GET",
-            "PATH_INFO" => "/path"
-          }
-        )
+      expect(last_transaction).to_not have_action
+      expect(last_transaction).to include_environment(
+        "REQUEST_METHOD" => "GET",
+        "PATH_INFO" => "/path"
       )
-      expect(last_transaction.ext.queue_start).to eq(queue_start_time)
+      expect(last_transaction).to have_queue_start(queue_start_time)
       expect(last_transaction).to be_completed
     end
 
@@ -206,18 +190,14 @@ describe Appsignal::Rack::EventHandler do
         on_start
         on_finish(request, nil)
 
-        expect(last_transaction.to_h).to include(
-          # The action is not set on purpose, as we can't set a normalized route
-          # It requires the app to set an action name
-          "action" => nil,
-          "sample_data" => hash_including(
-            "environment" => {
-              "REQUEST_METHOD" => "GET",
-              "PATH_INFO" => "/path"
-            }
-          )
+        # The action is not set on purpose, as we can't set a normalized route
+        # It requires the app to set an action name
+        expect(last_transaction).to_not have_action
+        expect(last_transaction).to include_environment(
+          "REQUEST_METHOD" => "GET",
+          "PATH_INFO" => "/path"
         )
-        expect(last_transaction.ext.queue_start).to eq(queue_start_time)
+        expect(last_transaction).to have_queue_start(queue_start_time)
         expect(last_transaction).to be_completed
       end
 
@@ -225,7 +205,7 @@ describe Appsignal::Rack::EventHandler do
         on_start
         on_finish(request, nil)
 
-        expect(last_transaction.to_h.dig("sample_data", "tags")).to_not have_key("response_status")
+        expect(last_transaction).to_not include_tags("response_status" => anything)
       end
 
       it "does not report a response_status counter metric" do
@@ -235,6 +215,25 @@ describe Appsignal::Rack::EventHandler do
         on_start
         on_finish(request, nil)
       end
+
+      context "with an error previously recorded by on_error" do
+        it "sets response status 500 as a tag" do
+          on_start
+          on_error(ExampleStandardError.new("the error"))
+          on_finish(request, nil)
+
+          expect(last_transaction).to include_tags("response_status" => 500)
+        end
+
+        it "increments the response status counter for response status 500" do
+          expect(Appsignal).to receive(:increment_counter)
+            .with(:response_status, 1, :status => 500, :namespace => :web)
+
+          on_start
+          on_error(ExampleStandardError.new("the error"))
+          on_finish(request, nil)
+        end
+      end
     end
 
     context "with error inside on_finish handler" do
@@ -260,12 +259,10 @@ describe Appsignal::Rack::EventHandler do
         on_start
         described_class.new.on_finish(request, response)
 
-        expect(last_transaction.to_h).to include(
-          "action" => nil,
-          "metadata" => {},
-          "sample_data" => {},
-          "events" => []
-        )
+        expect(last_transaction).to_not have_action
+        expect(last_transaction).to_not include_metadata
+        expect(last_transaction).to_not include_events
+        expect(last_transaction.to_h).to include("sample_data" => {})
         expect(last_transaction).to_not be_completed
       end
     end
@@ -275,44 +272,50 @@ describe Appsignal::Rack::EventHandler do
       last_transaction.set_action("My action")
       on_finish
 
-      expect(last_transaction.to_h).to include(
-        "action" => "My action"
-      )
+      expect(last_transaction).to have_action("My action")
     end
 
     it "finishes the process_request.rack event" do
       on_start
       on_finish
 
-      expect(last_transaction.to_h).to include(
-        "events" => [
-          hash_including(
-            "name" => "process_request.rack",
-            "title" => "",
-            "body" => "",
-            "body_format" => Appsignal::EventFormatter::DEFAULT
-          )
-        ]
-      )
+      expect(last_transaction).to include_event("name" => "process_request.rack")
     end
 
-    it "sets the response status as a tag" do
-      on_start
-      on_finish
+    context "with response" do
+      it "sets the response status as a tag" do
+        on_start
+        on_finish
 
-      expect(last_transaction.to_h).to include(
-        "sample_data" => hash_including(
-          "tags" => { "response_status" => 200 }
-        )
-      )
-    end
+        expect(last_transaction).to include_tags("response_status" => 200)
+      end
 
-    it "increments the response status counter for response status" do
-      expect(Appsignal).to receive(:increment_counter)
-        .with(:response_status, 1, :status => 200, :namespace => :web)
+      it "increments the response status counter for response status" do
+        expect(Appsignal).to receive(:increment_counter)
+          .with(:response_status, 1, :status => 200, :namespace => :web)
 
-      on_start
-      on_finish
+        on_start
+        on_finish
+      end
+
+      context "with an error previously recorded by on_error" do
+        it "sets response status from the response as a tag" do
+          on_start
+          on_error(ExampleStandardError.new("the error"))
+          on_finish
+
+          expect(last_transaction).to include_tags("response_status" => 200)
+        end
+
+        it "increments the response status counter based on the response" do
+          expect(Appsignal).to receive(:increment_counter)
+            .with(:response_status, 1, :status => 200, :namespace => :web)
+
+          on_start
+          on_error(ExampleStandardError.new("the error"))
+          on_finish
+        end
+      end
     end
 
     it "logs an error in case of an error" do

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

@@ -1,38 +1,81 @@
-describe Appsignal::Rack::GenericInstrumentation do
-  let(:app) { double(:call => true) }
-  let(:env) { Rack::MockRequest.env_for("/some/path") }
-  let(:middleware) { Appsignal::Rack::GenericInstrumentation.new(app, {}) }
+describe "Appsignal::Rack::GenericInstrumentation" do
+  describe "Appsignal::Rack::GenericInstrumentation constant" do
+    let(:err_stream) { std_stream }
+    let(:stderr) { err_stream.read }
+    before do
+      if Appsignal::Rack.const_defined?(:GenericInstrumentation)
+        hide_const "Appsignal::Rack::GenericInstrumentation"
+      end
+    end
 
-  before(:context) { start_agent }
-  around { |example| keep_transactions { example.run } }
+    it "returns the Rack::GenericInstrumentation constant" do
+      silence do
+        expect(Appsignal::Rack::GenericInstrumentation)
+          .to be(Appsignal::Rack::GenericInstrumentationAlias)
+      end
+    end
 
-  def make_request(env)
-    middleware.call(env)
-  end
+    it "prints a deprecation warning to STDERR" do
+      capture_std_streams(std_stream, err_stream) do
+        Appsignal::Rack::GenericInstrumentation
+      end
 
-  context "without an exception" do
-    it "reports a process_action.generic event" do
-      make_request(env)
-
-      expect(last_transaction.to_h).to include(
-        "events" => [
-          hash_including(
-            "body" => "",
-            "body_format" => Appsignal::EventFormatter::DEFAULT,
-            "count" => 1,
-            "name" => "process_action.generic",
-            "title" => ""
-          )
-        ]
+      expect(stderr).to include(
+        "appsignal WARNING: The constant Appsignal::Rack::GenericInstrumentation " \
+          "has been deprecated."
+      )
+    end
+
+    it "logs a warning" do
+      logs =
+        capture_logs do
+          silence do
+            Appsignal::Rack::GenericInstrumentation
+          end
+        end
+
+      expect(logs).to contains_log(
+        :warn,
+        "The constant Appsignal::Rack::GenericInstrumentation has been deprecated."
       )
     end
   end
 
-  context "without action name metadata" do
-    it "reports 'unknown' as the action name" do
-      make_request(env)
+  describe "middleware" do
+    let(:app) { double(:call => true) }
+    let(:env) { Rack::MockRequest.env_for("/some/path") }
+    let(:middleware) { Appsignal::Rack::GenericInstrumentation.new(app, {}) }
+
+    before(:context) { start_agent }
+    around { |example| keep_transactions { example.run } }
+
+    def make_request(env)
+      middleware.call(env)
+    end
+
+    context "without an exception" do
+      it "reports a process_action.generic event" do
+        make_request(env)
+
+        expect(last_transaction).to include_event("name" => "process_action.generic")
+      end
+    end
+
+    context "with action name env" do
+      it "reports the appsignal.action env as the action name" do
+        env["appsignal.action"] = "MyAction"
+        make_request(env)
+
+        expect(last_transaction).to have_action("MyAction")
+      end
+    end
+
+    context "without action name metadata" do
+      it "reports 'unknown' as the action name" do
+        make_request(env)
 
-      expect(last_transaction.to_h).to include("action" => "unknown")
+        expect(last_transaction).to have_action("unknown")
+      end
     end
   end
 end