appsignal 2.11.1 → 2.11.6

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

@@ -0,0 +1,266 @@
+require "appsignal/integrations/object"
+
+def is_ruby_19
+  RUBY_VERSION < "2.0"
+end
+
+describe Object do
+  describe "#instrument_method" do
+    context "with instance method" do
+      let(:klass) do
+        Class.new do
+          def foo(param1, options = {})
+            [param1, options]
+          end
+          appsignal_instrument_method :foo
+        end
+      end
+      let(:instance) { klass.new }
+
+      def call_with_arguments
+        instance.foo(
+          "abc",
+          :foo => "bar"
+        )
+      end
+
+      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)
+        end
+        after { Appsignal.config = nil }
+
+        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 \
+              "foo.AnonymousClass.other", nil, nil, Appsignal::EventFormatter::DEFAULT
+            expect(call_with_arguments).to eq(["abc", { :foo => "bar" }])
+          end
+        end
+
+        context "with named class" do
+          before do
+            class NamedClass
+              def foo
+                1
+              end
+              appsignal_instrument_method :foo
+            end
+          end
+          after { Object.send(:remove_const, :NamedClass) }
+          let(:klass) { NamedClass }
+
+          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 \
+              "foo.NamedClass.other", nil, nil, Appsignal::EventFormatter::DEFAULT
+            expect(instance.foo).to eq(1)
+          end
+        end
+
+        context "with nested named class" do
+          before do
+            module MyModule
+              module NestedModule
+                class NamedClass
+                  def bar
+                    2
+                  end
+                  appsignal_instrument_method :bar
+                end
+              end
+            end
+          end
+          after { Object.send(:remove_const, :MyModule) }
+          let(:klass) { MyModule::NestedModule::NamedClass }
+
+          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.NamedClass.NestedModule.MyModule.other", nil, nil,
+              Appsignal::EventFormatter::DEFAULT
+            expect(instance.bar).to eq(2)
+          end
+        end
+
+        context "with custom name" do
+          let(:klass) do
+            Class.new do
+              def foo
+                1
+              end
+              appsignal_instrument_method :foo, :name => "my_method.group"
+            end
+          end
+
+          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(instance.foo).to eq(1)
+          end
+        end
+
+        context "with a method given a block" do
+          let(:klass) do
+            Class.new do
+              def foo
+                yield
+              end
+              appsignal_instrument_method :foo
+            end
+          end
+
+          it "should yield the block" do
+            expect(instance.foo { 42 }).to eq(42)
+          end
+        end
+      end
+
+      context "when not active" do
+        let(:transaction) { Appsignal::Transaction.current }
+
+        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" }])
+        end
+      end
+    end
+
+    context "with class method" do
+      let(:klass) do
+        Class.new do
+          def self.bar(param1, options = {})
+            [param1, options]
+          end
+          appsignal_instrument_class_method :bar
+        end
+      end
+      def call_with_arguments
+        klass.bar(
+          "abc",
+          :foo => "bar"
+        )
+      end
+
+      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)
+        end
+        after { Appsignal.config = nil }
+
+        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" }])
+          end
+        end
+
+        context "with named class" do
+          before do
+            class NamedClass
+              def self.bar
+                2
+              end
+              appsignal_instrument_class_method :bar
+            end
+          end
+          after { Object.send(:remove_const, :NamedClass) }
+          let(:klass) { NamedClass }
+
+          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)
+          end
+
+          context "with nested named class" do
+            before do
+              module MyModule
+                module NestedModule
+                  class NamedClass
+                    def self.bar
+                      2
+                    end
+                    appsignal_instrument_class_method :bar
+                  end
+                end
+              end
+            end
+            after { Object.send(:remove_const, :MyModule) }
+            let(:klass) { MyModule::NestedModule::NamedClass }
+
+            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)
+            end
+          end
+        end
+
+        context "with custom name" do
+          let(:klass) do
+            Class.new do
+              def self.bar
+                2
+              end
+              appsignal_instrument_class_method :bar, :name => "my_method.group"
+            end
+          end
+
+          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)
+          end
+        end
+
+        context "with a method given a block" do
+          let(:klass) do
+            Class.new do
+              def self.bar
+                yield
+              end
+              appsignal_instrument_class_method :bar
+            end
+          end
+
+          it "should yield the block" do
+            expect(klass.bar { 42 }).to eq(42)
+          end
+        end
+      end
+
+      context "when not active" do
+        let(:transaction) { Appsignal::Transaction.current }
+
+        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" }])
+        end
+      end
+    end
+  end
+end

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

@@ -1,18 +1,30 @@
 require "appsignal/integrations/object"
 
+def is_ruby_19
+  RUBY_VERSION < "2.0"
+end
+
 describe Object do
   describe "#instrument_method" do
     context "with instance method" do
       let(:klass) do
         Class.new do
-          def foo
-            1
+          def foo(param1, options = {}, keyword_param: 1)
+            [param1, options, keyword_param]
           end
           appsignal_instrument_method :foo
         end
       end
       let(:instance) { klass.new }
 
+      def call_with_arguments
+        instance.foo(
+          "abc",
+          { :foo => "bar" },
+          :keyword_param => 2
+        )
+      end
+
       context "when active" do
         let(:transaction) { http_request_transaction }
         before do
@@ -27,7 +39,7 @@ describe Object do
             expect(transaction).to receive(:start_event)
             expect(transaction).to receive(:finish_event).with \
               "foo.AnonymousClass.other", nil, nil, Appsignal::EventFormatter::DEFAULT
-            expect(instance.foo).to eq(1)
+            expect(call_with_arguments).to eq(["abc", { :foo => "bar" }, 2])
           end
         end
 
@@ -116,10 +128,10 @@ describe Object do
       context "when not active" do
         let(:transaction) { Appsignal::Transaction.current }
 
-        it "should not instrument, but still call the method" 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(instance.foo).to eq(1)
+          expect(call_with_arguments).to eq(["abc", { :foo => "bar" }, 2])
         end
       end
     end
@@ -127,12 +139,19 @@ describe Object do
     context "with class method" do
       let(:klass) do
         Class.new do
-          def self.bar
-            2
+          def self.bar(param1, options = {}, keyword_param: 1)
+            [param1, options, keyword_param]
           end
           appsignal_instrument_class_method :bar
         end
       end
+      def call_with_arguments
+        klass.bar(
+          "abc",
+          { :foo => "bar" },
+          :keyword_param => 2
+        )
+      end
 
       context "when active" do
         let(:transaction) { http_request_transaction }
@@ -149,7 +168,7 @@ describe Object do
             expect(transaction).to receive(:start_event)
             expect(transaction).to receive(:finish_event).with \
               "bar.class_method.AnonymousClass.other", nil, nil, Appsignal::EventFormatter::DEFAULT
-            expect(klass.bar).to eq(2)
+            expect(call_with_arguments).to eq(["abc", { :foo => "bar" }, 2])
           end
         end
 
@@ -238,10 +257,10 @@ describe Object do
       context "when not active" do
         let(:transaction) { Appsignal::Transaction.current }
 
-        it "should not instrument, but still call the method" 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(klass.bar).to eq(2)
+          expect(call_with_arguments).to eq(["abc", { :foo => "bar" }, 2])
         end
       end
     end

data/spec/lib/appsignal/transaction_spec.rb

@@ -356,6 +356,57 @@ describe Appsignal::Transaction do
       end
     end
 
+    describe "#add_breadcrumb" do
+      context "when over the limit" do
+        before do
+          22.times do |i|
+            transaction.add_breadcrumb(
+              "network",
+              "GET http://localhost",
+              "User made external network request",
+              { :code => i + 1 },
+              Time.parse("10-10-2010 10:00:00 UTC")
+            )
+          end
+          transaction.sample_data
+        end
+
+        it "stores last <LIMIT> breadcrumbs on the transaction" do
+          expect(transaction.to_h["sample_data"]["breadcrumbs"].length).to eql(20)
+          expect(transaction.to_h["sample_data"]["breadcrumbs"][0]).to eq(
+            "action" => "GET http://localhost",
+            "category" => "network",
+            "message" => "User made external network request",
+            "metadata" => { "code" => 3 },
+            "time" => 1286704800 # rubocop:disable Style/NumericLiterals
+          )
+          expect(transaction.to_h["sample_data"]["breadcrumbs"][19]).to eq(
+            "action" => "GET http://localhost",
+            "category" => "network",
+            "message" => "User made external network request",
+            "metadata" => { "code" => 22 },
+            "time" => 1286704800 # rubocop:disable Style/NumericLiterals
+          )
+        end
+      end
+
+      context "with defaults" do
+        it "stores breadcrumb with defaults on transaction" do
+          timeframe_start = Time.now.utc.to_i
+          transaction.add_breadcrumb("user_action", "clicked HOME")
+          transaction.sample_data
+          timeframe_end = Time.now.utc.to_i
+
+          breadcrumb = transaction.to_h["sample_data"]["breadcrumbs"][0]
+          expect(breadcrumb["category"]).to eq("user_action")
+          expect(breadcrumb["action"]).to eq("clicked HOME")
+          expect(breadcrumb["message"]).to eq("")
+          expect(breadcrumb["time"]).to be_between(timeframe_start, timeframe_end)
+          expect(breadcrumb["metadata"]).to eq({})
+        end
+      end
+    end
+
     describe "#set_action" do
       context "when the action is set" do
         it "updates the action name on the transaction" do
@@ -649,6 +700,10 @@ describe Appsignal::Transaction do
           "tags",
           Appsignal::Utils::Data.generate({})
         ).once
+        expect(transaction.ext).to receive(:set_sample_data).with(
+          "breadcrumbs",
+          Appsignal::Utils::Data.generate([])
+        ).once
 
         transaction.sample_data
       end

data/spec/lib/appsignal_spec.rb

@@ -491,6 +491,36 @@ describe Appsignal do
       end
     end
 
+    describe ".add_breadcrumb" do
+      before { allow(Appsignal::Transaction).to receive(:current).and_return(transaction) }
+
+      context "with transaction" do
+        let(:transaction) { double }
+        it "should call add_breadcrumb on transaction" do
+          expect(transaction).to receive(:add_breadcrumb)
+            .with("Network", "http", "User made network request", { :response => 200 }, fixed_time)
+        end
+
+        after do
+          Appsignal.add_breadcrumb(
+            "Network",
+            "http",
+            "User made network request",
+            { :response => 200 },
+            fixed_time
+          )
+        end
+      end
+
+      context "without transaction" do
+        let(:transaction) { nil }
+
+        it "should not call add_breadcrumb on transaction" do
+          expect(Appsignal.add_breadcrumb("Network", "http")).to be_falsy
+        end
+      end
+    end
+
     describe "custom stats" do
       let(:tags) { { :foo => "bar" } }