appsignal 3.9.3 → 3.10.0

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

@@ -45,6 +45,11 @@ describe Appsignal::Rack::AbstractMiddleware do
         expect(last_transaction).to have_namespace(Appsignal::Transaction::HTTP_REQUEST)
       end
 
+      it "wraps the response body in a BodyWrapper subclass" do
+        _status, _headers, body = make_request
+        expect(body).to be_kind_of(Appsignal::Rack::BodyWrapper)
+      end
+
       context "without an error" do
         before { make_request }
 
@@ -56,8 +61,20 @@ describe Appsignal::Rack::AbstractMiddleware do
           expect(last_transaction).to_not have_error
         end
 
-        it "records an instrumentation event" do
-          expect(last_transaction).to include_event(:name => "process.abstract")
+        context "without :instrument_event_name option set" do
+          let(:options) { {} }
+
+          it "does not record an instrumentation event" do
+            expect(last_transaction).to_not include_event
+          end
+        end
+
+        context "with :instrument_event_name option set" do
+          let(:options) { { :instrument_event_name => "event_name.category" } }
+
+          it "records an instrumentation event" do
+            expect(last_transaction).to include_event(:name => "event_name.category")
+          end
         end
 
         it "completes the transaction" do
@@ -66,8 +83,8 @@ describe Appsignal::Rack::AbstractMiddleware do
             .to be_kind_of(Appsignal::Transaction::NilTransaction)
         end
 
-        context "when instrument_span_name option is nil" do
-          let(:options) { { :instrument_span_name => nil } }
+        context "when instrument_event_name option is nil" do
+          let(:options) { { :instrument_event_name => nil } }
 
           it "does not record an instrumentation event" do
             expect(last_transaction).to_not include_events
@@ -148,21 +165,61 @@ describe Appsignal::Rack::AbstractMiddleware do
       end
 
       context "with appsignal.route env" do
+        before { env["appsignal.route"] = "POST /my-route" }
+
         it "reports the appsignal.route value as the action name" do
-          env["appsignal.route"] = "POST /my-route"
           make_request
 
           expect(last_transaction).to have_action("POST /my-route")
         end
+
+        it "prints a deprecation warning" do
+          err_stream = std_stream
+          capture_std_streams(std_stream, err_stream) do
+            make_request
+          end
+
+          expect(err_stream.read).to include(
+            "Setting the action name with the request env 'appsignal.route' is deprecated."
+          )
+        end
+
+        it "logs a deprecation warning" do
+          logs = capture_logs { make_request }
+          expect(logs).to contains_log(
+            :warn,
+            "Setting the action name with the request env 'appsignal.route' is deprecated."
+          )
+        end
       end
 
       context "with appsignal.action env" do
-        it "reports the appsignal.route value as the action name" do
-          env["appsignal.action"] = "POST /my-action"
+        before { env["appsignal.action"] = "POST /my-action" }
+
+        it "reports the appsignal.action value as the action name" do
           make_request
 
           expect(last_transaction).to have_action("POST /my-action")
         end
+
+        it "prints a deprecation warning" do
+          err_stream = std_stream
+          capture_std_streams(std_stream, err_stream) do
+            make_request
+          end
+
+          expect(err_stream.read).to include(
+            "Setting the action name with the request env 'appsignal.action' is deprecated."
+          )
+        end
+
+        it "logs a deprecation warning" do
+          logs = capture_logs { make_request }
+          expect(logs).to contains_log(
+            :warn,
+            "Setting the action name with the request env 'appsignal.action' is deprecated."
+          )
+        end
       end
 
       describe "request metadata" do
@@ -274,8 +331,10 @@ describe Appsignal::Rack::AbstractMiddleware do
       end
 
       context "with parent instrumentation" do
+        let(:transaction) { http_request_transaction }
         before do
-          env[Appsignal::Rack::APPSIGNAL_TRANSACTION] = http_request_transaction
+          env[Appsignal::Rack::APPSIGNAL_TRANSACTION] = transaction
+          set_current_transaction(transaction)
         end
 
         it "uses the existing transaction" do
@@ -284,6 +343,35 @@ describe Appsignal::Rack::AbstractMiddleware do
           expect { make_request }.to_not(change { created_transactions.count })
         end
 
+        it "wraps the response body in a BodyWrapper subclass" do
+          _status, _headers, body = make_request
+          expect(body).to be_kind_of(Appsignal::Rack::BodyWrapper)
+
+          body.to_ary
+          response_events =
+            last_transaction.to_h["events"].count do |event|
+              event["name"] == "process_response_body.rack"
+            end
+          expect(response_events).to eq(1)
+        end
+
+        context "when response body is already a BodyWrapper subclass" do
+          let(:body) { Appsignal::Rack::BodyWrapper.wrap(["hello!"], transaction) }
+          let(:app) { DummyApp.new { [200, {}, body] } }
+
+          it "doesn't wrap the body again" do
+            _status, _headers, body = make_request
+            expect(body).to eq(body)
+
+            body.to_ary
+            response_events =
+              last_transaction.to_h["events"].count do |event|
+                event["name"] == "process_response_body.rack"
+              end
+            expect(response_events).to eq(1)
+          end
+        end
+
         context "with error" do
           let(:app) { lambda { |_env| raise ExampleException, "error message" } }
 

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/generic_instrumentation_spec.rb

@@ -1,28 +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
+
+    it "returns the Rack::GenericInstrumentation constant" do
+      silence do
+        expect(Appsignal::Rack::GenericInstrumentation)
+          .to be(Appsignal::Rack::GenericInstrumentationAlias)
+      end
+    end
 
-  before(:context) { start_agent }
-  around { |example| keep_transactions { example.run } }
+    it "prints a deprecation warning to STDERR" do
+      capture_std_streams(std_stream, err_stream) do
+        Appsignal::Rack::GenericInstrumentation
+      end
 
-  def make_request(env)
-    middleware.call(env)
-  end
+      expect(stderr).to include(
+        "appsignal WARNING: The constant Appsignal::Rack::GenericInstrumentation " \
+          "has been deprecated."
+      )
+    end
 
-  context "without an exception" do
-    it "reports a process_action.generic event" do
-      make_request(env)
+    it "logs a warning" do
+      logs =
+        capture_logs do
+          silence do
+            Appsignal::Rack::GenericInstrumentation
+          end
+        end
 
-      expect(last_transaction).to include_event("name" => "process_action.generic")
+      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 have_action("unknown")
+        expect(last_transaction).to have_action("unknown")
+      end
     end
   end
 end

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

@@ -5,7 +5,7 @@ if DependencyHelper.grape_present?
     let(:err_stream) { std_stream }
     let(:stderr) { err_stream.read }
 
-    it "returns the Probes constant calling the Minutely constant" do
+    it "returns the Rack::GrapeMiddleware constant calling the Grape::Middleware constant" do
       silence { expect(Appsignal::Grape::Middleware).to be(Appsignal::Rack::GrapeMiddleware) }
     end
 

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

@@ -0,0 +1,38 @@
+describe Appsignal::Rack::InstrumentationMiddleware do
+  let(:app) { DummyApp.new }
+  let(:env) { Rack::MockRequest.env_for("/some/path") }
+  let(:middleware) { described_class.new(app, {}) }
+
+  before { 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_request_middleware.rack event" do
+      make_request(env)
+
+      expect(last_transaction).to include_event("name" => "process_request_middleware.rack")
+    end
+  end
+
+  context "with custom action name" do
+    let(:app) { DummyApp.new { |_env| Appsignal.set_action("MyAction") } }
+
+    it "reports the custom action name" do
+      make_request(env)
+
+      expect(last_transaction).to have_action("MyAction")
+    end
+  end
+
+  context "without action name metadata" do
+    it "reports no action name" do
+      make_request(env)
+
+      expect(last_transaction).to_not have_action
+    end
+  end
+end