appsignal 3.9.2 → 3.9.3

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

@@ -1,6 +1,8 @@
 require "appsignal/integrations/object"
 
 describe Object do
+  around { |example| keep_transactions { example.run } }
+
   describe "#instrument_method" do
     context "with instance method" do
       let(:klass) do
@@ -24,10 +26,8 @@ describe Object do
       context "when active" do
         let(:transaction) { http_request_transaction }
         before do
-          Appsignal.config = project_fixture_config
-          expect(Appsignal::Transaction).to receive(:current)
-            .at_least(:once).and_return(transaction)
-          expect(Appsignal.active?).to be_truthy
+          start_agent
+          set_current_transaction(transaction)
         end
         after { Appsignal.config = nil }
 
@@ -80,10 +80,9 @@ describe Object do
 
         context "with anonymous class" do
           it "instruments the method and calls it" do
-            expect(transaction).to receive(:start_event)
-            expect(transaction).to receive(:finish_event).with \
-              "foo.AnonymousClass.other", nil, nil, Appsignal::EventFormatter::DEFAULT
             expect(call_with_arguments).to eq(["abc", { :foo => "bar" }, 2])
+
+            expect(transaction).to include_event("name" => "foo.AnonymousClass.other")
           end
         end
 
@@ -100,10 +99,9 @@ describe Object do
           let(:klass) { NamedClass }
 
           it "instruments the method and calls it" do
-            expect(transaction).to receive(:start_event)
-            expect(transaction).to receive(:finish_event).with \
-              "foo.NamedClass.other", nil, nil, Appsignal::EventFormatter::DEFAULT
             expect(instance.foo).to eq(1)
+
+            expect(transaction).to include_event("name" => "foo.NamedClass.other")
           end
         end
 
@@ -124,11 +122,11 @@ describe Object do
           let(:klass) { MyModule::NestedModule::NamedClass }
 
           it "instruments the method and calls it" do
-            expect(transaction).to receive(:start_event)
-            expect(transaction).to receive(:finish_event).with \
-              "bar.NamedClass.NestedModule.MyModule.other", nil, nil,
-              Appsignal::EventFormatter::DEFAULT
             expect(instance.bar).to eq(2)
+
+            expect(transaction).to include_event(
+              "name" => "bar.NamedClass.NestedModule.MyModule.other"
+            )
           end
         end
 
@@ -143,10 +141,11 @@ describe Object do
           end
 
           it "instruments with custom name" do
-            expect(transaction).to receive(:start_event)
-            expect(transaction).to receive(:finish_event).with \
-              "my_method.group", nil, nil, Appsignal::EventFormatter::DEFAULT
             expect(instance.foo).to eq(1)
+
+            expect(transaction).to include_event(
+              "name" => "my_method.group"
+            )
           end
         end
 
@@ -160,7 +159,7 @@ describe Object do
             end
           end
 
-          it "should yield the block" do
+          it "yields the block" do
             expect(instance.foo { 42 }).to eq(42)
           end
         end
@@ -171,7 +170,6 @@ describe Object do
 
         it "does not instrument, but still calls the method" do
           expect(Appsignal.active?).to be_falsy
-          expect(transaction).to_not receive(:start_event)
           expect(call_with_arguments).to eq(["abc", { :foo => "bar" }, 2])
         end
       end
@@ -198,8 +196,7 @@ describe Object do
         let(:transaction) { http_request_transaction }
         before do
           Appsignal.config = project_fixture_config
-          expect(Appsignal::Transaction).to receive(:current).at_least(:once)
-            .and_return(transaction)
+          set_current_transaction(transaction)
         end
         after { Appsignal.config = nil }
 
@@ -253,10 +250,10 @@ describe Object do
         context "with anonymous class" do
           it "instruments the method and calls it" do
             expect(Appsignal.active?).to be_truthy
-            expect(transaction).to receive(:start_event)
-            expect(transaction).to receive(:finish_event).with \
-              "bar.class_method.AnonymousClass.other", nil, nil, Appsignal::EventFormatter::DEFAULT
             expect(call_with_arguments).to eq(["abc", { :foo => "bar" }, 2])
+
+            transaction._sample
+            expect(transaction).to include_event("name" => "bar.class_method.AnonymousClass.other")
           end
         end
 
@@ -274,10 +271,9 @@ describe Object do
 
           it "instruments the method and calls it" do
             expect(Appsignal.active?).to be_truthy
-            expect(transaction).to receive(:start_event)
-            expect(transaction).to receive(:finish_event).with \
-              "bar.class_method.NamedClass.other", nil, nil, Appsignal::EventFormatter::DEFAULT
             expect(klass.bar).to eq(2)
+
+            expect(transaction).to include_event("name" => "bar.class_method.NamedClass.other")
           end
 
           context "with nested named class" do
@@ -298,11 +294,10 @@ describe Object do
 
             it "instruments the method and calls it" do
               expect(Appsignal.active?).to be_truthy
-              expect(transaction).to receive(:start_event)
-              expect(transaction).to receive(:finish_event).with \
-                "bar.class_method.NamedClass.NestedModule.MyModule.other", nil, nil,
-                Appsignal::EventFormatter::DEFAULT
               expect(klass.bar).to eq(2)
+              expect(transaction).to include_event(
+                "name" => "bar.class_method.NamedClass.NestedModule.MyModule.other"
+              )
             end
           end
         end
@@ -319,10 +314,9 @@ describe Object do
 
           it "instruments with custom name" do
             expect(Appsignal.active?).to be_truthy
-            expect(transaction).to receive(:start_event)
-            expect(transaction).to receive(:finish_event).with \
-              "my_method.group", nil, nil, Appsignal::EventFormatter::DEFAULT
             expect(klass.bar).to eq(2)
+
+            expect(transaction).to include_event("name" => "my_method.group")
           end
         end
 
@@ -336,7 +330,7 @@ describe Object do
             end
           end
 
-          it "should yield the block" do
+          it "yields the block" do
             expect(klass.bar { 42 }).to eq(42)
           end
         end
@@ -347,7 +341,6 @@ describe Object do
 
         it "does not instrument, but still call the method" do
           expect(Appsignal.active?).to be_falsy
-          expect(transaction).to_not receive(:start_event)
           expect(call_with_arguments).to eq(["abc", { :foo => "bar" }, 2])
         end
       end

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

@@ -2,21 +2,11 @@ if DependencyHelper.padrino_present?
   describe "Padrino integration" do
     require "appsignal/integrations/padrino"
 
-    before do
-      allow(Appsignal).to receive(:active?).and_return(true)
-      allow(Appsignal).to receive(:start).and_return(true)
-      allow(Appsignal).to receive(:start_logger).and_return(true)
-    end
-
     describe Appsignal::Integrations::PadrinoPlugin do
       it "starts AppSignal on init" do
         expect(Appsignal).to receive(:start)
       end
 
-      it "starts the logger on init" do
-        expect(Appsignal).to receive(:start_logger)
-      end
-
       context "when not active" do
         before { allow(Appsignal).to receive(:active?).and_return(false) }
 
@@ -59,20 +49,9 @@ if DependencyHelper.padrino_present?
       let(:env)      { {} }
       # TODO: use an instance double
       let(:settings) { double(:name => "TestApp") }
+      around { |example| keep_transactions { example.run } }
 
       describe "routes" do
-        let(:transaction) do
-          instance_double "Appsignal::Transaction",
-            :set_http_or_background_action => nil,
-            :set_http_or_background_queue_start => nil,
-            :set_metadata => nil,
-            :set_action => nil,
-            :set_action_if_nil => nil,
-            :set_error => nil,
-            :start_event => nil,
-            :finish_event => nil,
-            :complete => nil
-        end
         let(:request_kind) { kind_of(Sinatra::Request) }
         let(:env) do
           {
@@ -90,10 +69,6 @@ if DependencyHelper.padrino_present?
           end
         end
         let(:response) { app.call(env) }
-        before do
-          allow(Appsignal::Transaction).to receive(:create).and_return(transaction)
-          allow(Appsignal::Transaction).to receive(:current).and_return(transaction)
-        end
 
         RSpec::Matchers.define :match_response do |expected_status, expected_content|
           match do |response|
@@ -109,46 +84,41 @@ if DependencyHelper.padrino_present?
         end
 
         def expect_a_transaction_to_be_created
-          expect(Appsignal::Transaction).to receive(:create).with(
-            kind_of(String),
-            Appsignal::Transaction::HTTP_REQUEST,
-            request_kind
-          ).and_return(transaction)
-
-          expect(Appsignal).to receive(:instrument)
-            .at_least(:once)
-            .with("process_action.padrino")
-            .and_call_original
-          expect(transaction).to receive(:set_metadata).with("path", path)
-          expect(transaction).to receive(:set_metadata).with("method", "GET")
-          expect(transaction).to receive(:complete)
-        end
-
-        def expect_no_transaction_to_be_created
-          expect(Appsignal::Transaction).to_not receive(:create)
-          expect(Appsignal).to_not receive(:instrument)
+          transaction = last_transaction
+          expect(transaction).to have_id
+          expect(transaction).to have_namespace(Appsignal::Transaction::HTTP_REQUEST)
+          expect(transaction).to include_metadata(
+            "path" => path,
+            "method" => "GET"
+          )
+          expect(transaction).to include_event("name" => "process_action.padrino")
+          expect(transaction).to be_completed
         end
 
         context "when AppSignal is not active" do
           before { allow(Appsignal).to receive(:active?).and_return(false) }
           let(:path) { "/foo" }
           before { app.controllers { get(:foo) { "content" } } }
-          after { expect(response).to match_response(200, "content") }
 
           it "does not instrument the request" do
-            expect_no_transaction_to_be_created
+            expect do
+              expect(response).to match_response(200, "content")
+            end.to_not(change { created_transactions.count })
           end
         end
 
         context "when AppSignal is active" do
+          before { start_agent }
+
           context "with not existing route" do
             let(:path) { "/404" }
 
             it "instruments the request" do
+              expect(response).to match_response(404, /^GET /404/)
+
               expect_a_transaction_to_be_created
               # Uses path for action name
-              expect(transaction).to receive(:set_action_if_nil).with("PadrinoTestApp#unknown")
-              expect(response).to match_response(404, /^GET /404/)
+              expect(last_transaction).to have_action("PadrinoTestApp#unknown")
             end
           end
 
@@ -158,10 +128,11 @@ if DependencyHelper.padrino_present?
               env["sinatra.static_file"] = true
               app.controllers { get(:static) { "Static!" } }
             end
-            after { expect(response).to match_response(200, "Static!") }
 
             it "does not instrument the request" do
-              expect_no_transaction_to_be_created
+              expect do
+                expect(response).to match_response(200, "Static!")
+              end.to_not(change { created_transactions.count })
             end
           end
 
@@ -172,12 +143,14 @@ if DependencyHelper.padrino_present?
               allow_any_instance_of(Sinatra::Request).to receive(:action).and_return(nil)
               app.controllers { get(:my_original_path, :with => :id) { "content" } }
             end
-            after { expect(response).to match_response(200, "content") }
 
             it "falls back on Sinatra::Request#route_obj.original_path" do
+              expect do
+                expect(response).to match_response(200, "content")
+              end.to(change { created_transactions.count }.by(1))
+
               expect_a_transaction_to_be_created
-              expect(transaction)
-                .to receive(:set_action_if_nil).with("PadrinoTestApp:/my_original_path/:id")
+              expect(last_transaction).to have_action("PadrinoTestApp:/my_original_path/:id")
             end
           end
 
@@ -188,11 +161,11 @@ if DependencyHelper.padrino_present?
               allow_any_instance_of(Sinatra::Request).to receive(:route_obj).and_return(nil)
               app.controllers { get(:my_original_path) { "content" } }
             end
-            after { expect(response).to match_response(200, "content") }
 
             it "falls back on app name" do
+              expect(response).to match_response(200, "content")
               expect_a_transaction_to_be_created
-              expect(transaction).to receive(:set_action_if_nil).with("PadrinoTestApp#unknown")
+              expect(last_transaction).to have_action("PadrinoTestApp#unknown")
             end
           end
 
@@ -200,25 +173,25 @@ if DependencyHelper.padrino_present?
             context "with an exception in the controller" do
               let(:path) { "/exception" }
               before do
-                app.controllers { get(:exception) { raise ExampleException } }
+                app.controllers { get(:exception) { raise ExampleException, "error message" } }
+                expect { response }.to raise_error(ExampleException, "error message")
                 expect_a_transaction_to_be_created
               end
-              after do
-                expect { response }.to raise_error(ExampleException)
-              end
 
               it "sets the action name based on the app name and action name" do
-                expect(transaction).to receive(:set_action_if_nil).with("PadrinoTestApp:#exception")
+                expect(last_transaction).to have_action("PadrinoTestApp:#exception")
               end
 
               it "sets the error on the transaction" do
-                expect(transaction).to receive(:set_error).with(ExampleException)
+                expect(last_transaction).to have_error("ExampleException", "error message")
               end
             end
 
             context "without an exception in the controller" do
               let(:path) { "/" }
-              after { expect(response).to match_response(200, "content") }
+              def make_request
+                expect(response).to match_response(200, "content")
+              end
 
               context "with action name as symbol" do
                 context "with :index helper" do
@@ -228,8 +201,9 @@ if DependencyHelper.padrino_present?
                   end
 
                   it "sets the action with the app name and action name" do
+                    make_request
                     expect_a_transaction_to_be_created
-                    expect(transaction).to receive(:set_action_if_nil).with("PadrinoTestApp:#index")
+                    expect(last_transaction).to have_action("PadrinoTestApp:#index")
                   end
                 end
 
@@ -240,8 +214,9 @@ if DependencyHelper.padrino_present?
                   end
 
                   it "sets the action with the app name and action name" do
+                    make_request
                     expect_a_transaction_to_be_created
-                    expect(transaction).to receive(:set_action_if_nil).with("PadrinoTestApp:#foo")
+                    expect(last_transaction).to have_action("PadrinoTestApp:#foo")
                   end
                 end
               end
@@ -254,8 +229,9 @@ if DependencyHelper.padrino_present?
                   end
 
                   it "sets the action with the app name and action path" do
+                    make_request
                     expect_a_transaction_to_be_created
-                    expect(transaction).to receive(:set_action_if_nil).with("PadrinoTestApp:#/")
+                    expect(last_transaction).to have_action("PadrinoTestApp:#/")
                   end
                 end
 
@@ -266,8 +242,9 @@ if DependencyHelper.padrino_present?
                   end
 
                   it "sets the action with the app name and action path" do
+                    make_request
                     expect_a_transaction_to_be_created
-                    expect(transaction).to receive(:set_action_if_nil).with("PadrinoTestApp:#/foo")
+                    expect(last_transaction).to have_action("PadrinoTestApp:#/foo")
                   end
                 end
               end
@@ -282,9 +259,9 @@ if DependencyHelper.padrino_present?
                   end
 
                   it "sets the action with the app name, controller name and action name" do
+                    make_request
                     expect_a_transaction_to_be_created
-                    expect(transaction).to receive(:set_action_if_nil)
-                      .with("PadrinoTestApp:my_controller#index")
+                    expect(last_transaction).to have_action("PadrinoTestApp:my_controller#index")
                   end
                 end
 
@@ -295,9 +272,9 @@ if DependencyHelper.padrino_present?
                   end
 
                   it "sets the action with the app name, controller name and action path" do
+                    make_request
                     expect_a_transaction_to_be_created
-                    expect(transaction).to receive(:set_action_if_nil)
-                      .with("PadrinoTestApp:/my_controller#index")
+                    expect(last_transaction).to have_action("PadrinoTestApp:/my_controller#index")
                   end
                 end
               end

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

@@ -53,38 +53,27 @@ if DependencyHelper.que_present?
             perform_que_job(instance)
           end.to change { created_transactions.length }.by(1)
 
-          expect(last_transaction).to be_completed
-          transaction_hash = last_transaction.to_h
-          expect(transaction_hash).to include(
-            "action" => "MyQueJob#run",
-            "id" => instance_of(String),
-            "namespace" => Appsignal::Transaction::BACKGROUND_JOB
-          )
-          expect(transaction_hash["error"]).to be_nil
-          expect(transaction_hash["events"].first).to include(
-            "allocation_count" => kind_of(Integer),
+          transaction = last_transaction
+          expect(transaction).to have_id
+          expect(transaction).to have_namespace(Appsignal::Transaction::BACKGROUND_JOB)
+          expect(transaction).to have_action("MyQueJob#run")
+          expect(transaction).to_not have_error
+          expect(transaction).to include_event(
             "body" => "",
             "body_format" => Appsignal::EventFormatter::DEFAULT,
-            "child_allocation_count" => kind_of(Integer),
-            "child_duration" => kind_of(Float),
-            "child_gc_duration" => kind_of(Float),
             "count" => 1,
-            "gc_duration" => kind_of(Float),
-            "start" => kind_of(Float),
-            "duration" => kind_of(Float),
             "name" => "perform_job.que",
             "title" => ""
           )
-          expect(transaction_hash["sample_data"]).to include(
-            "params" => %w[1 birds],
-            "metadata" => {
-              "attempts" => 0,
-              "id" => 123,
-              "priority" => 100,
-              "queue" => "dfl",
-              "run_at" => fixed_time.to_s
-            }
+          expect(transaction).to include_params(%w[1 birds])
+          expect(transaction).to include_sample_metadata(
+            "attempts" => 0,
+            "id" => 123,
+            "priority" => 100,
+            "queue" => "dfl",
+            "run_at" => fixed_time.to_s
           )
+          expect(transaction).to be_completed
         end
       end
 
@@ -100,28 +89,20 @@ if DependencyHelper.que_present?
             end.to raise_error(ExampleException)
           end.to change { created_transactions.length }.by(1)
 
-          expect(last_transaction).to be_completed
-          transaction_hash = last_transaction.to_h
-          expect(transaction_hash).to include(
-            "action" => "MyQueJob#run",
-            "id" => instance_of(String),
-            "namespace" => Appsignal::Transaction::BACKGROUND_JOB
-          )
-          expect(transaction_hash["error"]).to include(
-            "backtrace" => kind_of(String),
-            "name" => error.class.name,
-            "message" => error.message
-          )
-          expect(transaction_hash["sample_data"]).to include(
-            "params" => %w[1 birds],
-            "metadata" => {
-              "attempts" => 0,
-              "id" => 123,
-              "priority" => 100,
-              "queue" => "dfl",
-              "run_at" => fixed_time.to_s
-            }
+          transaction = last_transaction
+          expect(transaction).to have_id
+          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_sample_metadata(
+            "attempts" => 0,
+            "id" => 123,
+            "priority" => 100,
+            "queue" => "dfl",
+            "run_at" => fixed_time.to_s
           )
+          expect(transaction).to be_completed
         end
       end
 
@@ -133,28 +114,20 @@ if DependencyHelper.que_present?
 
           expect { perform_que_job(instance) }.to change { created_transactions.length }.by(1)
 
-          expect(last_transaction).to be_completed
-          transaction_hash = last_transaction.to_h
-          expect(transaction_hash).to include(
-            "action" => "MyQueJob#run",
-            "id" => instance_of(String),
-            "namespace" => Appsignal::Transaction::BACKGROUND_JOB
-          )
-          expect(transaction_hash["error"]).to include(
-            "backtrace" => kind_of(String),
-            "name" => error.class.name,
-            "message" => error.message
-          )
-          expect(transaction_hash["sample_data"]).to include(
-            "params" => %w[1 birds],
-            "metadata" => {
-              "attempts" => 0,
-              "id" => 123,
-              "priority" => 100,
-              "queue" => "dfl",
-              "run_at" => fixed_time.to_s
-            }
+          transaction = last_transaction
+          expect(transaction).to have_id
+          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_sample_metadata(
+            "attempts" => 0,
+            "id" => 123,
+            "priority" => 100,
+            "queue" => "dfl",
+            "run_at" => fixed_time.to_s
           )
+          expect(transaction).to be_completed
         end
       end
 
@@ -170,9 +143,9 @@ if DependencyHelper.que_present?
         it "uses the custom action" do
           perform_que_job(instance)
 
-          expect(last_transaction).to be_completed
-          transaction_hash = last_transaction.to_h
-          expect(transaction_hash).to include("action" => "MyCustomJob#perform")
+          transaction = last_transaction
+          expect(transaction).to have_action("MyCustomJob#perform")
+          expect(transaction).to be_completed
         end
       end
     end