appsignal 4.0.4 → 4.0.6

data/spec/lib/appsignal/config_spec.rb

@@ -1,5 +1,18 @@
 describe Appsignal::Config do
   describe ".add_loader_defaults" do
+    context "when the config is initialized" do
+      before { Appsignal.configure(:test) }
+
+      it "logs a warning" do
+        logs = capture_logs { described_class.add_loader_defaults(:loader1) }
+
+        expect(logs).to contains_log(
+          :warn,
+          "The config defaults from the 'loader1' loader are ignored"
+        )
+      end
+    end
+
     it "adds loader defaults to the list" do
       described_class.add_loader_defaults(:loader1)
 

data/spec/lib/appsignal/hooks/at_exit_spec.rb

@@ -40,6 +40,17 @@ describe Appsignal::Hooks::AtExit::AtExitCallback do
     Appsignal::Hooks::AtExit::AtExitCallback.call
   end
 
+  it "reports no transaction if the process didn't exit with an error" do
+    logs =
+      capture_logs do
+        expect do
+          call_callback
+        end.to_not(change { created_transactions.count })
+      end
+
+    expect(logs).to_not contains_log(:error, "Appsignal.report_error: Cannot add error.")
+  end
+
   it "reports an error if there's an unhandled error" do
     expect do
       with_error(ExampleException, "error message") do

data/spec/lib/appsignal/hooks/puma_spec.rb

@@ -1,34 +1,45 @@
 describe Appsignal::Hooks::PumaHook do
   context "with puma" do
-    before(:context) do
-      class Puma
-        def self.stats
-        end
+    let(:puma_version) { "6.0.0" }
+    before do
+      stub_const("Puma", PumaMock)
+      stub_const("Puma::Const::VERSION", puma_version)
+    end
+
+    describe "#dependencies_present?" do
+      subject { described_class.new.dependencies_present? }
+
+      context "when Puma present" do
+        context "when Puma is newer than version 3.0.0" do
+          let(:puma_version) { "3.0.0" }
 
-        def self.cli_config
-          @cli_config ||= CliConfig.new
+          it { is_expected.to be_truthy }
         end
-      end
 
-      class CliConfig
-        attr_accessor :options
+        context "when Puma is older than version 3.0.0" do
+          let(:puma_version) { "2.9.9" }
 
-        def initialize
-          @options = {}
+          it { is_expected.to be_falsey }
         end
       end
-    end
-    after(:context) { Object.send(:remove_const, :Puma) }
 
-    describe "#dependencies_present?" do
-      subject { described_class.new.dependencies_present? }
+      context "when Puma is not present" do
+        before do
+          hide_const("Puma")
+        end
 
-      it { is_expected.to be_truthy }
+        it { is_expected.to be_falsey }
+      end
     end
 
     describe "installation" do
       before { Appsignal::Probes.probes.clear }
 
+      it "adds the Puma::Server patch" do
+        Appsignal::Hooks::PumaHook.new.install
+        expect(::Puma::Server.included_modules).to include(Appsignal::Integrations::PumaServer)
+      end
+
       context "when not clustered mode" do
         it "does not add AppSignal stop behavior Puma::Cluster" do
           expect(defined?(::Puma::Cluster)).to be_falsy
@@ -39,15 +50,12 @@ describe Appsignal::Hooks::PumaHook do
 
       context "when in clustered mode" do
         before do
-          class Puma
-            class Cluster
-              def stop_workers
-                @called = true
-              end
+          stub_const("Puma::Cluster", Class.new do
+            def stop_workers
+              @called = true
             end
-          end
+          end)
         end
-        after { Puma.send(:remove_const, :Cluster) }
 
         it "adds behavior to Puma::Cluster.stop_workers" do
           Appsignal::Hooks::PumaHook.new.install

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

@@ -0,0 +1,150 @@
+require "appsignal/integrations/puma"
+
+describe Appsignal::Integrations::PumaServer do
+  describe "#lowlevel_error" do
+    before do
+      stub_const("Puma", PumaMock)
+      stub_const("Puma::Server", puma_server)
+      start_agent
+    end
+    let(:queue_start_time) { fixed_time * 1_000 }
+    let(:env) do
+      Rack::MockRequest.env_for(
+        "/some/path",
+        "REQUEST_METHOD" => "GET",
+        :params => { "page" => 2, "query" => "lorem" },
+        "rack.session" => { "session" => "data", "user_id" => 123 },
+        "HTTP_X_REQUEST_START" => "t=#{queue_start_time.to_i}" # in milliseconds
+      )
+    end
+    let(:server) { Puma::Server.new }
+    let(:error) { ExampleException.new("error message") }
+    around { |example| keep_transactions { example.run } }
+    before { Appsignal::Hooks::PumaHook.new.install }
+
+    def lowlevel_error(error, env, status = nil)
+      result =
+        if status
+          server.lowlevel_error(error, env, status)
+        else
+          server.lowlevel_error(error, env)
+        end
+      # Transaction is normally closed by the EventHandler's RACK_AFTER_REPLY hook
+      last_transaction&.complete
+      result
+    end
+
+    describe "error reporting" do
+      let(:puma_server) { default_puma_server_mock }
+
+      context "with active transaction" do
+        before { create_transaction }
+
+        it "reports the error to the transaction" do
+          expect do
+            lowlevel_error(error, env)
+          end.to_not(change { created_transactions.count })
+
+          expect(last_transaction).to have_error("ExampleException", "error message")
+          expect(last_transaction).to include_tags("reported_by" => "puma_lowlevel_error")
+        end
+      end
+
+      # This shouldn't happen if the EventHandler is set up correctly, but if
+      # it's not it will create a new transaction.
+      context "without active transaction" do
+        it "creates a new transaction with the error" do
+          expect do
+            lowlevel_error(error, env)
+          end.to change { created_transactions.count }.by(1)
+
+          expect(last_transaction).to have_error("ExampleException", "error message")
+          expect(last_transaction).to include_tags("reported_by" => "puma_lowlevel_error")
+        end
+      end
+
+      it "doesn't report internal Puma errors" do
+        expect do
+          lowlevel_error(Puma::MiniSSL::SSLError.new("error message"), env)
+          lowlevel_error(Puma::HttpParserError.new("error message"), env)
+          lowlevel_error(Puma::HttpParserError501.new("error message"), env)
+        end.to_not(change { created_transactions.count })
+      end
+
+      describe "request metadata" do
+        it "sets request metadata" do
+          lowlevel_error(error, env)
+
+          expect(last_transaction).to include_metadata(
+            "request_method" => "GET",
+            "method" => "GET",
+            "request_path" => "/some/path",
+            "path" => "/some/path"
+          )
+          expect(last_transaction).to include_environment(
+            "REQUEST_METHOD" => "GET",
+            "PATH_INFO" => "/some/path"
+            # and more, but we don't need to test Rack mock defaults
+          )
+        end
+
+        it "sets request parameters" do
+          lowlevel_error(error, env)
+
+          expect(last_transaction).to include_params(
+            "page" => "2",
+            "query" => "lorem"
+          )
+        end
+
+        it "sets session data" do
+          lowlevel_error(error, env)
+
+          expect(last_transaction).to include_session_data("session" => "data", "user_id" => 123)
+        end
+
+        it "sets the queue start" do
+          lowlevel_error(error, env)
+
+          expect(last_transaction).to have_queue_start(queue_start_time)
+        end
+      end
+    end
+
+    context "with Puma::Server#lowlevel_error accepting 3 arguments" do
+      let(:puma_server) { default_puma_server_mock }
+
+      it "calls the super class with 3 arguments" do
+        result = lowlevel_error(error, env, 501)
+        expect(result).to eq([501, {}, ""])
+
+        expect(last_transaction).to include_tags("response_status" => 501)
+      end
+    end
+
+    context "with Puma::Server#lowlevel_error accepting 2 arguments" do
+      let(:puma_server) do
+        Class.new do
+          def lowlevel_error(_error, _env)
+            [500, {}, ""]
+          end
+        end
+      end
+
+      it "calls the super class with 3 arguments" do
+        result = lowlevel_error(error, env)
+        expect(result).to eq([500, {}, ""])
+
+        expect(last_transaction).to include_tags("response_status" => 500)
+      end
+    end
+  end
+
+  def default_puma_server_mock
+    Class.new do
+      def lowlevel_error(_error, _env, status = 500)
+        [status, {}, ""]
+      end
+    end
+  end
+end

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

@@ -9,28 +9,16 @@ if DependencyHelper.que_present?
           :queue => "dfl",
           :job_class => "MyQueJob",
           :priority => 100,
-          :args => %w[1 birds],
+          :args => %w[post_id_123 user_id_123],
           :run_at => fixed_time,
           :error_count => 0
-        }
-      end
-      let(:env) do
-        {
-          :class => "MyQueJob",
-          :method => "run",
-          :metadata => {
-            :id => 123,
-            :queue => "dfl",
-            :priority => 100,
-            :run_at => fixed_time.to_s,
-            :attempts => 0
-          },
-          :params => %w[1 birds]
-        }
+        }.tap do |hash|
+          hash[:kwargs] = {} if DependencyHelper.que2_present?
+        end
       end
       let(:job) do
         Class.new(::Que::Job) do
-          def run(*args)
+          def run(post_id, user_id)
           end
         end
       end
@@ -46,7 +34,7 @@ if DependencyHelper.que_present?
         job._run
       end
 
-      context "success" do
+      context "without exception" do
         it "creates a transaction for a job" do
           expect do
             perform_que_job(instance)
@@ -64,7 +52,18 @@ if DependencyHelper.que_present?
             "name" => "perform_job.que",
             "title" => ""
           )
-          expect(transaction).to include_params(%w[1 birds])
+          expect(transaction).to include_params(
+            "arguments" => %w[post_id_123 user_id_123]
+          )
+          if DependencyHelper.que2_present?
+            expect(transaction).to include_params(
+              "keyword_arguments" => {}
+            )
+          else
+            expect(transaction).to_not include_params(
+              "keyword_arguments" => anything
+            )
+          end
           expect(transaction).to include_tags(
             "attempts" => 0,
             "id" => 123,
@@ -93,7 +92,9 @@ if DependencyHelper.que_present?
           expect(transaction).to have_action("MyQueJob#run")
           expect(transaction).to have_namespace(Appsignal::Transaction::BACKGROUND_JOB)
           expect(transaction).to have_error(error.class.name, error.message)
-          expect(transaction).to include_params(%w[1 birds])
+          expect(transaction).to include_params(
+            "arguments" => %w[post_id_123 user_id_123]
+          )
           expect(transaction).to include_tags(
             "attempts" => 0,
             "id" => 123,
@@ -118,7 +119,9 @@ if DependencyHelper.que_present?
           expect(transaction).to have_action("MyQueJob#run")
           expect(transaction).to have_namespace(Appsignal::Transaction::BACKGROUND_JOB)
           expect(transaction).to have_error(error.class.name, error.message)
-          expect(transaction).to include_params(%w[1 birds])
+          expect(transaction).to include_params(
+            "arguments" => %w[post_id_123 user_id_123]
+          )
           expect(transaction).to include_tags(
             "attempts" => 0,
             "id" => 123,
@@ -130,6 +133,38 @@ if DependencyHelper.que_present?
         end
       end
 
+      if DependencyHelper.que2_present?
+        context "with keyword argument" do
+          let(:job_attrs) do
+            {
+              :job_id => 123,
+              :queue => "dfl",
+              :job_class => "MyQueJob",
+              :priority => 100,
+              :args => %w[post_id_123],
+              :kwargs => { :user_id => "user_id_123" },
+              :run_at => fixed_time,
+              :error_count => 0
+            }
+          end
+          let(:job) do
+            Class.new(::Que::Job) do
+              def run(post_id, user_id: nil)
+              end
+            end
+          end
+
+          it "reports keyword arguments as parameters" do
+            perform_que_job(instance)
+
+            expect(last_transaction).to include_params(
+              "arguments" => %w[post_id_123],
+              "keyword_arguments" => { "user_id" => "user_id_123" }
+            )
+          end
+        end
+      end
+
       context "when action set in job" do
         let(:job) do
           Class.new(::Que::Job) do

data/spec/lib/appsignal/probes_spec.rb

@@ -43,6 +43,9 @@ describe Appsignal::Probes do
     let(:log) { log_contents(log_stream) }
     before do
       Appsignal.internal_logger = test_logger(log_stream)
+      # TODO: These logs are here to debug an issue on CI
+      Appsignal.internal_logger.info("a" * 100)
+      Appsignal.internal_logger.info("b" * 100)
       speed_up_tests!
     end
 
@@ -244,12 +247,7 @@ describe Appsignal::Probes do
   end
 
   describe ".unregister" do
-    let(:log_stream) { StringIO.new }
-    let(:log) { log_contents(log_stream) }
-    before do
-      Appsignal.internal_logger = test_logger(log_stream)
-      speed_up_tests!
-    end
+    before { speed_up_tests! }
 
     it "does not call the initialized probe after unregistering" do
       probe1_calls = 0

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

@@ -1,19 +1,8 @@
 describe Appsignal::Rack::AbstractMiddleware do
-  class HashLike < Hash
-    def initialize(value)
-      @value = value
-    end
-
-    def to_h
-      @value
-    end
-  end
-
   let(:app) { DummyApp.new }
-  let(:request_path) { "/some/path" }
   let(:env) do
     Rack::MockRequest.env_for(
-      request_path,
+      "/some/path",
       "REQUEST_METHOD" => "GET",
       :params => { "page" => 2, "query" => "lorem" },
       "rack.session" => { "session" => "data", "user_id" => 123 }
@@ -174,13 +163,17 @@ describe Appsignal::Rack::AbstractMiddleware do
         end
       end
 
+      # Partial duplicate tests from Appsignal::Rack::ApplyRackRequest that
+      # ensure the request metadata is set on via the AbstractMiddleware.
       describe "request metadata" do
         it "sets request metadata" do
           env.merge!("PATH_INFO" => "/some/path", "REQUEST_METHOD" => "GET")
           make_request
 
           expect(last_transaction).to include_metadata(
+            "request_method" => "GET",
             "method" => "GET",
+            "request_path" => "/some/path",
             "path" => "/some/path"
           )
           expect(last_transaction).to include_environment(
@@ -190,36 +183,6 @@ describe Appsignal::Rack::AbstractMiddleware do
           )
         end
 
-        context "with an invalid HTTP request method" do
-          it "stores the invalid HTTP request method" do
-            env["REQUEST_METHOD"] = "FOO"
-            make_request
-
-            expect(last_transaction).to include_metadata("method" => "FOO")
-          end
-        end
-
-        context "when fetching the request method raises an error" do
-          class BrokenRequestMethodRequest < Rack::Request
-            def request_method
-              raise "uh oh!"
-            end
-          end
-
-          let(:options) { { :request_class => BrokenRequestMethodRequest } }
-
-          it "does not store the invalid HTTP request method" do
-            env["REQUEST_METHOD"] = "FOO"
-            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
-
         it "sets request parameters" do
           make_request
 
@@ -229,107 +192,63 @@ describe Appsignal::Rack::AbstractMiddleware do
           )
         end
 
-        context "when setting custom params" do
-          let(:app) do
-            DummyApp.new do |_env|
-              Appsignal::Transaction.current.set_params("custom" => "param")
-            end
-          end
-
-          it "allow custom request parameters to be set" do
-            make_request
-
-            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
 
-        it "sets session data if the session is a Hash-like type" do
-          env["rack.session"] = HashLike.new("hash-like" => "value", "user_id" => 123)
-          make_request
-
-          expect(last_transaction).to include_session_data("hash-like" => "value", "user_id" => 123)
-        end
-      end
-
-      context "with queue start header" do
-        let(:queue_start_time) { fixed_time * 1_000 }
+        context "with queue start header" do
+          let(:queue_start_time) { fixed_time * 1_000 }
 
-        it "sets the queue start" do
-          env["HTTP_X_REQUEST_START"] = "t=#{queue_start_time.to_i}" # in milliseconds
-          make_request
+          it "sets the queue start" do
+            env["HTTP_X_REQUEST_START"] = "t=#{queue_start_time.to_i}" # in milliseconds
+            make_request
 
-          expect(last_transaction).to have_queue_start(queue_start_time)
+            expect(last_transaction).to have_queue_start(queue_start_time)
+          end
         end
-      end
 
-      class FilteredRequest
-        attr_reader :env
+        class SomeFilteredRequest
+          attr_reader :env
 
-        def initialize(env)
-          @env = env
-        end
+          def initialize(env)
+            @env = env
+          end
 
-        def path
-          "/static/path"
-        end
+          def path
+            "/static/path"
+          end
 
-        def request_method
-          "GET"
-        end
+          def request_method
+            "GET"
+          end
 
-        def filtered_params
-          { "abc" => "123" }
-        end
+          def filtered_params
+            { "abc" => "123" }
+          end
 
-        def session
-          { "data" => "value" }
+          def session
+            { "data" => "value" }
+          end
         end
-      end
 
-      context "with overridden request class and params method" do
-        let(:options) do
-          { :request_class => FilteredRequest, :params_method => :filtered_params }
-        end
+        context "with overridden request class and params method" do
+          let(:options) do
+            { :request_class => SomeFilteredRequest, :params_method => :filtered_params }
+          end
 
-        it "uses the overridden request class and params method to fetch params" do
-          make_request
+          it "uses the overridden request class and params method to fetch params" do
+            make_request
 
-          expect(last_transaction).to include_params("abc" => "123")
-        end
+            expect(last_transaction).to include_params("abc" => "123")
+          end
 
-        it "uses the overridden request class to fetch session data" do
-          make_request
+          it "uses the overridden request class to fetch session data" do
+            make_request
 
-          expect(last_transaction).to include_session_data("data" => "value")
+            expect(last_transaction).to include_session_data("data" => "value")
+          end
         end
       end