appsignal 3.10.0 → 3.12.0

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

@@ -3,8 +3,11 @@ describe Appsignal::Rack::EventHandler do
   let(:env) do
     {
       "HTTP_X_REQUEST_START" => "t=#{queue_start_time.to_i}", # in milliseconds
-      "REQUEST_METHOD" => "GET",
-      "PATH_INFO" => "/path"
+      "REQUEST_METHOD" => "POST",
+      "PATH_INFO" => "/path",
+      "QUERY_STRING" => "query_param1=value1&query_param2=value2",
+      "rack.session" => { "session1" => "value1", "session2" => "value2" },
+      "rack.input" => StringIO.new("post_param1=value1&post_param2=value2")
     }
   end
   let(:request) { Rack::Request.new(env) }
@@ -37,6 +40,14 @@ describe Appsignal::Rack::EventHandler do
       expect(Appsignal::Transaction.current).to eq(transaction)
     end
 
+    context "when not active" do
+      it "does not create a new transaction" do
+        allow(Appsignal).to receive(:active?).and_return(false)
+
+        expect { on_start }.to_not(change { created_transactions.length })
+      end
+    end
+
     context "when the handler is nested in another EventHandler" do
       it "does not create a new transaction in the nested EventHandler" do
         on_start
@@ -128,6 +139,17 @@ describe Appsignal::Rack::EventHandler do
       expect(last_transaction).to have_error("ExampleStandardError", "the error")
     end
 
+    context "when not active" do
+      it "does not report the transaction" do
+        allow(Appsignal).to receive(:active?).and_return(false)
+
+        on_start
+        on_error(ExampleStandardError.new("the error"))
+
+        expect(last_transaction).to_not have_error
+      end
+    end
+
     context "when the handler is nested in another EventHandler" do
       it "does not report the error on the transaction" do
         on_start
@@ -172,20 +194,107 @@ describe Appsignal::Rack::EventHandler do
       expect(last_transaction).to_not be_completed
     end
 
-    it "completes the transaction" do
+    context "when not active" do
+      it "doesn't do anything" do
+        allow(Appsignal).to receive(:active?).and_return(false)
+
+        request.env[Appsignal::Rack::APPSIGNAL_TRANSACTION] = http_request_transaction
+        on_finish
+
+        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
+    end
+
+    it "sets params on the transaction" do
+      on_start
+      on_finish
+
+      expect(last_transaction).to include_params(
+        "query_param1" => "value1",
+        "query_param2" => "value2",
+        "post_param1" => "value1",
+        "post_param2" => "value2"
+      )
+    end
+
+    it "sets headers on the transaction" do
       on_start
       on_finish
 
-      expect(last_transaction).to_not have_action
       expect(last_transaction).to include_environment(
-        "REQUEST_METHOD" => "GET",
+        "REQUEST_METHOD" => "POST",
         "PATH_INFO" => "/path"
       )
+    end
+
+    it "sets session data on the transaction" do
+      on_start
+      on_finish
+
+      expect(last_transaction).to include_session_data(
+        "session1" => "value1",
+        "session2" => "value2"
+      )
+    end
+
+    it "sets the queue start time on the transaction" do
+      on_start
+      on_finish
+
       expect(last_transaction).to have_queue_start(queue_start_time)
+    end
+
+    it "completes the transaction" do
+      on_start
+      on_finish
+
+      expect(last_transaction).to_not have_action
       expect(last_transaction).to be_completed
     end
 
     context "without a response" do
+      it "sets params on the transaction" do
+        on_start
+        on_finish
+
+        expect(last_transaction).to include_params(
+          "query_param1" => "value1",
+          "query_param2" => "value2",
+          "post_param1" => "value1",
+          "post_param2" => "value2"
+        )
+      end
+
+      it "sets headers on the transaction" do
+        on_start
+        on_finish
+
+        expect(last_transaction).to include_environment(
+          "REQUEST_METHOD" => "POST",
+          "PATH_INFO" => "/path"
+        )
+      end
+
+      it "sets session data on the transaction" do
+        on_start
+        on_finish
+
+        expect(last_transaction).to include_session_data(
+          "session1" => "value1",
+          "session2" => "value2"
+        )
+      end
+
+      it "sets the queue start time on the transaction" do
+        on_start
+        on_finish
+
+        expect(last_transaction).to have_queue_start(queue_start_time)
+      end
+
       it "completes the transaction" do
         on_start
         on_finish(request, nil)
@@ -193,11 +302,6 @@ describe Appsignal::Rack::EventHandler do
         # 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).to have_queue_start(queue_start_time)
         expect(last_transaction).to be_completed
       end
 

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

@@ -46,7 +46,7 @@ describe "Appsignal::Rack::GenericInstrumentation" do
     let(:env) { Rack::MockRequest.env_for("/some/path") }
     let(:middleware) { Appsignal::Rack::GenericInstrumentation.new(app, {}) }
 
-    before(:context) { start_agent }
+    before { start_agent }
     around { |example| keep_transactions { example.run } }
 
     def make_request(env)

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

@@ -1,38 +1,5 @@
 if DependencyHelper.grape_present?
-  require "appsignal/integrations/grape"
-
-  context "Appsignal::Grape::Middleware constant" do
-    let(:err_stream) { std_stream }
-    let(:stderr) { err_stream.read }
-
-    it "returns the Rack::GrapeMiddleware constant calling the Grape::Middleware constant" do
-      silence { expect(Appsignal::Grape::Middleware).to be(Appsignal::Rack::GrapeMiddleware) }
-    end
-
-    it "prints a deprecation warning to STDERR" do
-      capture_std_streams(std_stream, err_stream) do
-        expect(Appsignal::Grape::Middleware).to be(Appsignal::Rack::GrapeMiddleware)
-      end
-
-      expect(stderr).to include(
-        "appsignal WARNING: The constant Appsignal::Grape::Middleware has been deprecated."
-      )
-    end
-
-    it "logs a warning" do
-      logs =
-        capture_logs do
-          silence do
-            expect(Appsignal::Grape::Middleware).to be(Appsignal::Rack::GrapeMiddleware)
-          end
-        end
-
-      expect(logs).to contains_log(
-        :warn,
-        "The constant Appsignal::Grape::Middleware has been deprecated."
-      )
-    end
-  end
+  require "appsignal/rack/grape_middleware"
 
   describe Appsignal::Rack::GrapeMiddleware do
     let(:app) do
@@ -52,7 +19,7 @@ if DependencyHelper.grape_present?
     end
     let(:middleware) { Appsignal::Rack::GrapeMiddleware.new(api_endpoint) }
     let(:transaction) { http_request_transaction }
-    before(:context) { start_agent }
+    before { start_agent }
     around do |example|
       GrapeExample = Module.new
       GrapeExample.send(:const_set, :Api, app)

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

@@ -12,7 +12,7 @@ if DependencyHelper.hanami2_present?
     end
     let(:middleware) { Appsignal::Rack::HanamiMiddleware.new(app, {}) }
 
-    before(:context) { start_agent }
+    before { start_agent }
     around { |example| keep_transactions { example.run } }
 
     def make_request(env)

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

@@ -114,8 +114,10 @@ if DependencyHelper.rails_present?
         make_request
 
         expect(last_transaction).to_not include_metadata("method" => anything)
-        expect(log_contents(log))
-          .to contains_log(:error, "Unable to report HTTP request method: '")
+        expect(log_contents(log)).to contains_log(
+          :error,
+          "Exception while fetching the HTTP request method: "
+        )
       end
     end
 

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

@@ -1,5 +1,5 @@
 if DependencyHelper.sinatra_present?
-  require "appsignal/integrations/sinatra"
+  require "appsignal/rack/sinatra_instrumentation"
 
   module SinatraRequestHelpers
     def make_request
@@ -21,7 +21,7 @@ if DependencyHelper.sinatra_present?
     end
     let(:middleware) { Appsignal::Rack::SinatraInstrumentation.new(app) }
 
-    before(:context) { start_agent }
+    before { start_agent }
     around do |example|
       keep_transactions { example.run }
     end
@@ -54,7 +54,7 @@ if DependencyHelper.sinatra_present?
     let(:options) { {} }
     let(:middleware) { Appsignal::Rack::SinatraBaseInstrumentation.new(app, options) }
 
-    before(:context) { start_agent }
+    before { start_agent }
     around do |example|
       keep_transactions { example.run }
     end

data/spec/lib/appsignal/rack_spec.rb

@@ -0,0 +1,63 @@
+describe Appsignal::Rack::Utils do
+  describe ".queue_start_from" do
+    let(:header_time) { fixed_time - 0.4 }
+    let(:header_time_value) { (header_time * factor).to_i }
+    subject { described_class.queue_start_from(env) }
+
+    shared_examples "HTTP queue start" do
+      context "when env is nil" do
+        let(:env) { nil }
+
+        it { is_expected.to be_nil }
+      end
+
+      context "with no relevant header set" do
+        let(:env) { {} }
+
+        it { is_expected.to be_nil }
+      end
+
+      context "with the HTTP_X_REQUEST_START header set" do
+        let(:env) { { "HTTP_X_REQUEST_START" => "t=#{header_time_value}" } }
+
+        it { is_expected.to eq 1_389_783_599_600 }
+
+        context "with unparsable content" do
+          let(:env) { { "HTTP_X_REQUEST_START" => "something" } }
+
+          it { is_expected.to be_nil }
+        end
+
+        context "with unparsable content at the end" do
+          let(:env) { { "HTTP_X_REQUEST_START" => "t=#{header_time_value}aaaa" } }
+
+          it { is_expected.to eq 1_389_783_599_600 }
+        end
+
+        context "with a really low number" do
+          let(:env) { { "HTTP_X_REQUEST_START" => "t=100" } }
+
+          it { is_expected.to be_nil }
+        end
+
+        context "with the alternate HTTP_X_QUEUE_START header set" do
+          let(:env) { { "HTTP_X_QUEUE_START" => "t=#{header_time_value}" } }
+
+          it { is_expected.to eq 1_389_783_599_600 }
+        end
+      end
+    end
+
+    context "time in milliseconds" do
+      let(:factor) { 1_000 }
+
+      it_should_behave_like "HTTP queue start"
+    end
+
+    context "time in microseconds" do
+      let(:factor) { 1_000_000 }
+
+      it_should_behave_like "HTTP queue start"
+    end
+  end
+end

data/spec/lib/appsignal/span_spec.rb

@@ -1,9 +1,7 @@
 require "appsignal/span"
 
 describe Appsignal::Span do
-  before :context do
-    start_agent
-  end
+  before { start_agent }
 
   let(:namespace) { "web" }
   let(:root) { Appsignal::Span.new(namespace) }