appsignal 3.10.0 → 3.11.0

data/spec/lib/appsignal/integrations/webmachine_spec.rb

@@ -18,7 +18,11 @@ if DependencyHelper.webmachine_present?
       Webmachine::Request.new(
         "GET",
         "http://google.com:80/foo?param1=value1&param2=value2",
-        {},
+        {
+          "REQUEST_METHOD" => "GET",
+          "PATH_INFO" => "/some/path",
+          "ignored_header" => "something"
+        },
         nil
       )
     end
@@ -81,6 +85,14 @@ if DependencyHelper.webmachine_present?
         expect(last_transaction).to include_params("param1" => "value1", "param2" => "value2")
       end
 
+      it "sets the headers" do
+        fsm.run
+        expect(last_transaction).to include_environment(
+          "REQUEST_METHOD" => "GET",
+          "PATH_INFO" => "/some/path"
+        )
+      end
+
       it "closes the transaction" do
         fsm.run
         expect(last_transaction).to be_completed

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

@@ -5,7 +5,8 @@ describe Appsignal::Rack::AbstractMiddleware do
     Rack::MockRequest.env_for(
       request_path,
       "REQUEST_METHOD" => "GET",
-      :params => { "page" => 2, "query" => "lorem" }
+      :params => { "page" => 2, "query" => "lorem" },
+      "rack.session" => { "session" => "data", "user_id" => 123 }
     )
   end
   let(:options) { {} }
@@ -247,7 +248,7 @@ describe Appsignal::Rack::AbstractMiddleware do
           end
         end
 
-        context "with fetching the request method raises an error" do
+        context "when fetching the request method raises an error" do
           class BrokenRequestMethodRequest < Rack::Request
             def request_method
               raise "uh oh!"
@@ -255,11 +256,16 @@ describe Appsignal::Rack::AbstractMiddleware do
           end
 
           let(:options) { { :request_class => BrokenRequestMethodRequest } }
+
           it "does not store the invalid HTTP request method" do
             env["REQUEST_METHOD"] = "FOO"
-            make_request
+            logs = capture_logs { make_request }
 
             expect(last_transaction).to_not include_metadata("method" => anything)
+            expect(logs).to contains_log(
+              :error,
+              "Exception while fetching the HTTP request method: RuntimeError: uh oh"
+            )
           end
         end
 
@@ -285,6 +291,35 @@ describe Appsignal::Rack::AbstractMiddleware do
             expect(last_transaction).to include_params("custom" => "param")
           end
         end
+
+        context "when fetching the request method raises an error" do
+          class BrokenRequestParamsRequest < Rack::Request
+            def params
+              raise "uh oh!"
+            end
+          end
+
+          let(:options) do
+            { :request_class => BrokenRequestParamsRequest, :params_method => :params }
+          end
+
+          it "does not store the invalid HTTP request method" do
+            logs = capture_logs { make_request }
+
+            expect(last_transaction).to_not include_params
+            expect(logs).to contains_log(
+              :error,
+              "Exception while fetching params " \
+                "from 'BrokenRequestParamsRequest#params': RuntimeError uh oh!"
+            )
+          end
+        end
+
+        it "sets session data" do
+          make_request
+
+          expect(last_transaction).to include_session_data("session" => "data", "user_id" => 123)
+        end
       end
 
       context "with queue start header" do
@@ -316,6 +351,10 @@ describe Appsignal::Rack::AbstractMiddleware do
         def filtered_params
           { "abc" => "123" }
         end
+
+        def session
+          { "data" => "value" }
+        end
       end
 
       context "with overridden request class and params method" do
@@ -328,6 +367,12 @@ describe Appsignal::Rack::AbstractMiddleware do
 
           expect(last_transaction).to include_params("abc" => "123")
         end
+
+        it "uses the overridden request class to fetch session data" do
+          make_request
+
+          expect(last_transaction).to include_session_data("data" => "value")
+        end
       end
 
       context "with parent instrumentation" do

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) }
@@ -172,20 +175,93 @@ describe Appsignal::Rack::EventHandler do
       expect(last_transaction).to_not be_completed
     end
 
-    it "completes the transaction" 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_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 +269,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/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_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