appsignal 3.9.3-java → 3.11.0-java

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

@@ -15,9 +15,7 @@ describe Appsignal::Hooks::DelayedJobHook do
       end
     end
     after(:context) { Object.send(:remove_const, :Delayed) }
-    before do
-      start_agent
-    end
+    before { start_agent }
 
     describe "#dependencies_present?" do
       subject { described_class.new.dependencies_present? }
@@ -26,446 +24,7 @@ describe Appsignal::Hooks::DelayedJobHook do
     end
 
     it "adds the plugin" do
-      expect(::Delayed::Worker.plugins).to include Appsignal::Hooks::DelayedJobPlugin
-    end
-
-    # We haven't found a way to test the hooks, we'll have to do that manually
-
-    describe ".invoke_with_instrumentation" do
-      let(:plugin) { Appsignal::Hooks::DelayedJobPlugin }
-      let(:time) { Time.parse("01-01-2001 10:01:00UTC") }
-      let(:created_at) { time - 3600 }
-      let(:run_at) { time - 3600 }
-      let(:payload_object) { double(:args => args) }
-      let(:job_data) do
-        {
-          :id => 123,
-          :name => "TestClass#perform",
-          :priority => 1,
-          :attempts => 1,
-          :queue => "default",
-          :created_at => created_at,
-          :run_at => run_at,
-          :payload_object => payload_object
-        }
-      end
-      let(:args) { ["argument"] }
-      let(:job) { double(job_data) }
-      let(:invoked_block) { proc {} }
-
-      def perform
-        Timecop.freeze(time) do
-          keep_transactions do
-            plugin.invoke_with_instrumentation(job, invoked_block)
-          end
-        end
-      end
-
-      context "with a normal call" do
-        it "wraps it in a transaction" do
-          perform
-          transaction = last_transaction
-          expect(transaction).to have_action("TestClass#perform")
-          expect(transaction).to have_namespace("background_job")
-          expect(transaction).to_not have_error
-          expect(transaction).to include_event(:name => "perform_job.delayed_job")
-          expect(transaction).to include_sample_metadata(
-            "priority" => 1,
-            "attempts" => 1,
-            "queue" => "default",
-            "id" => "123"
-          )
-          expect(transaction).to include_params(["argument"])
-        end
-
-        context "with more complex params" do
-          let(:args) do
-            {
-              :foo => "Foo",
-              :bar => "Bar"
-            }
-          end
-
-          it "adds the more complex arguments" do
-            perform
-
-            expect(last_transaction).to include_params("foo" => "Foo", "bar" => "Bar")
-          end
-
-          context "with parameter filtering" do
-            before do
-              Appsignal.config = project_fixture_config("production")
-              Appsignal.config[:filter_parameters] = ["foo"]
-            end
-
-            it "filters selected arguments" do
-              perform
-
-              expect(last_transaction).to include_params("foo" => "[FILTERED]", "bar" => "Bar")
-            end
-          end
-        end
-
-        context "with run_at in the future" do
-          let(:run_at) { Time.parse("2017-01-01 10:01:00UTC") }
-
-          it "reports queue_start with run_at time" do
-            perform
-
-            expect(last_transaction).to have_queue_start(run_at.to_i * 1000)
-          end
-        end
-
-        context "with class method job" do
-          let(:job_data) do
-            { :name => "CustomClassMethod.perform", :payload_object => payload_object }
-          end
-
-          it "wraps it in a transaction using the class method job name" do
-            perform
-            expect(last_transaction).to have_action("CustomClassMethod.perform")
-          end
-        end
-
-        context "with custom name call" do
-          before { perform }
-
-          context "with appsignal_name defined" do
-            context "with payload_object being an object" do
-              context "with value" do
-                let(:payload_object) { double(:appsignal_name => "CustomClass#perform") }
-
-                it "wraps it in a transaction using the custom name" do
-                  expect(last_transaction).to have_action("CustomClass#perform")
-                end
-              end
-
-              context "with non-String value" do
-                let(:payload_object) { double(:appsignal_name => Object.new) }
-
-                it "wraps it in a transaction using the original job name" do
-                  expect(last_transaction).to have_action("TestClass#perform")
-                end
-              end
-
-              context "with class method name as job" do
-                let(:payload_object) { double(:appsignal_name => "CustomClassMethod.perform") }
-
-                it "wraps it in a transaction using the custom name" do
-                  perform
-                  expect(last_transaction).to have_action("CustomClassMethod.perform")
-                end
-              end
-            end
-
-            context "with payload_object being a Hash" do
-              context "with value" do
-                let(:payload_object) { double(:appsignal_name => "CustomClassHash#perform") }
-
-                it "wraps it in a transaction using the custom name" do
-                  expect(last_transaction).to have_action("CustomClassHash#perform")
-                end
-              end
-
-              context "with non-String value" do
-                let(:payload_object) { double(:appsignal_name => Object.new) }
-
-                it "wraps it in a transaction using the original job name" do
-                  expect(last_transaction).to have_action("TestClass#perform")
-                end
-              end
-
-              context "with class method name as job" do
-                let(:payload_object) { { :appsignal_name => "CustomClassMethod.perform" } }
-
-                it "wraps it in a transaction using the custom name" do
-                  perform
-                  expect(last_transaction).to have_action("CustomClassMethod.perform")
-                end
-              end
-            end
-
-            context "with payload_object acting like a Hash and returning a non-String value" do
-              class ClassActingAsHash
-                def self.[](_key)
-                  Object.new
-                end
-
-                def self.appsignal_name
-                  "ClassActingAsHash#perform"
-                end
-              end
-              let(:payload_object) { ClassActingAsHash }
-
-              # We check for hash values before object values
-              # this means ClassActingAsHash returns `Object.new` instead
-              # of `self.appsignal_name`. Since this isn't a valid `String`
-              # we return the default job name as action name.
-              it "wraps it in a transaction using the original job name" do
-                expect(last_transaction).to have_action("TestClass#perform")
-              end
-            end
-          end
-        end
-
-        context "with only job class name" do
-          let(:job_data) do
-            { :name => "Banana", :payload_object => payload_object }
-          end
-
-          it "appends #perform to the class name" do
-            perform
-            expect(last_transaction).to have_action("Banana#perform")
-          end
-        end
-
-        if active_job_present?
-          require "active_job"
-
-          context "when wrapped by ActiveJob" do
-            let(:payload_object) do
-              ActiveJob::QueueAdapters::DelayedJobAdapter::JobWrapper.new(
-                "arguments"  => args,
-                "job_class"  => "TestClass",
-                "job_id"     => 123,
-                "locale"     => :en,
-                "queue_name" => "default"
-              )
-            end
-            let(:job) do
-              double(
-                :id             => 123,
-                :name           => "ActiveJob::QueueAdapters::DelayedJobAdapter::JobWrapper",
-                :priority       => 1,
-                :attempts       => 1,
-                :queue          => "default",
-                :created_at     => created_at,
-                :run_at         => run_at,
-                :payload_object => payload_object
-              )
-            end
-            let(:args) { ["activejob_argument"] }
-
-            it "wraps it in a transaction with the correct params" do
-              perform
-
-              transaction = last_transaction
-              expect(transaction).to have_namespace("background_job")
-              expect(transaction).to have_action("TestClass#perform")
-              expect(transaction).to_not have_error
-              expect(transaction).to include_event("name" => "perform_job.delayed_job")
-              expect(transaction).to include_sample_metadata(
-                "priority" => 1,
-                "attempts" => 1,
-                "queue" => "default",
-                "id" => "123"
-              )
-              expect(transaction).to include_params(["activejob_argument"])
-            end
-
-            context "with more complex params" do
-              let(:args) do
-                {
-                  :foo => "Foo",
-                  :bar => "Bar"
-                }
-              end
-
-              it "adds the more complex arguments" do
-                perform
-                transaction = last_transaction
-                expect(transaction).to have_action("TestClass#perform")
-                expect(transaction).to include_params(
-                  "foo" => "Foo",
-                  "bar" => "Bar"
-                )
-              end
-
-              context "with parameter filtering" do
-                before do
-                  Appsignal.config = project_fixture_config("production")
-                  Appsignal.config[:filter_parameters] = ["foo"]
-                end
-
-                it "filters selected arguments" do
-                  perform
-                  transaction = last_transaction
-                  expect(transaction).to have_action("TestClass#perform")
-                  expect(transaction).to include_params(
-                    "foo" => "[FILTERED]",
-                    "bar" => "Bar"
-                  )
-                end
-              end
-            end
-
-            context "with run_at in the future" do
-              let(:run_at) { Time.parse("2017-01-01 10:01:00UTC") }
-
-              it "reports queue_start with run_at time" do
-                perform
-
-                expect(last_transaction).to have_queue_start(run_at.to_i * 1000)
-              end
-            end
-          end
-        end
-      end
-
-      context "with an erroring call" do
-        let(:error) { ExampleException.new("uh oh") }
-        before do
-          expect(invoked_block).to receive(:call).and_raise(error)
-        end
-
-        it "adds the error to the transaction" do
-          expect do
-            perform
-          end.to raise_error(error)
-
-          transaction = last_transaction
-          expect(transaction).to have_namespace("background_job")
-          expect(transaction).to have_action("TestClass#perform")
-          expect(transaction).to have_error("ExampleException", "uh oh")
-        end
-      end
-    end
-
-    describe ".extract_value" do
-      let(:plugin) { Appsignal::Hooks::DelayedJobPlugin }
-
-      context "for a hash" do
-        let(:hash) { { :key => "value", :bool_false => false } }
-
-        context "when the key exists" do
-          subject { plugin.extract_value(hash, :key) }
-
-          it { is_expected.to eq "value" }
-
-          context "when the value is false" do
-            subject { plugin.extract_value(hash, :bool_false) }
-
-            it { is_expected.to be false }
-          end
-        end
-
-        context "when the key does not exist" do
-          subject { plugin.extract_value(hash, :nonexistent_key) }
-
-          it { is_expected.to be_nil }
-
-          context "with a default value" do
-            subject { plugin.extract_value(hash, :nonexistent_key, 1) }
-
-            it { is_expected.to eq 1 }
-          end
-        end
-      end
-
-      context "for a struct" do
-        before :context do
-          TestStruct = Struct.new(:key)
-        end
-        let(:struct) { TestStruct.new("value") }
-
-        context "when the key exists" do
-          subject { plugin.extract_value(struct, :key) }
-
-          it { is_expected.to eq "value" }
-        end
-
-        context "when the key does not exist" do
-          subject { plugin.extract_value(struct, :nonexistent_key) }
-
-          it { is_expected.to be_nil }
-
-          context "with a default value" do
-            subject { plugin.extract_value(struct, :nonexistent_key, 1) }
-
-            it { is_expected.to eq 1 }
-          end
-        end
-      end
-
-      context "for a struct with a method" do
-        before :context do
-          class TestStructClass < Struct.new(:id) # rubocop:disable Style/StructInheritance
-            def appsignal_name
-              "TestStruct#perform"
-            end
-
-            def bool_false
-              false
-            end
-          end
-        end
-        let(:struct) { TestStructClass.new("id") }
-
-        context "when the Struct responds to a method" do
-          subject { plugin.extract_value(struct, :appsignal_name) }
-
-          it "returns the method value" do
-            is_expected.to eq "TestStruct#perform"
-          end
-
-          context "when the value is false" do
-            subject { plugin.extract_value(struct, :bool_false) }
-
-            it "returns the method value" do
-              is_expected.to be false
-            end
-          end
-        end
-
-        context "when the key does not exist" do
-          subject { plugin.extract_value(struct, :nonexistent_key) }
-
-          context "without a method with the same name" do
-            it "returns nil" do
-              is_expected.to be_nil
-            end
-          end
-
-          context "with a default value" do
-            let(:default_value) { :my_default_value }
-            subject { plugin.extract_value(struct, :nonexistent_key, default_value) }
-
-            it "returns the default value" do
-              is_expected.to eq default_value
-            end
-          end
-        end
-      end
-
-      context "for an object" do
-        let(:object) { double(:existing_method => "value") }
-
-        context "when the method exists" do
-          subject { plugin.extract_value(object, :existing_method) }
-
-          it { is_expected.to eq "value" }
-        end
-
-        context "when the method does not exist" do
-          subject { plugin.extract_value(object, :nonexistent_method) }
-
-          it { is_expected.to be_nil }
-
-          context "and there is a default value" do
-            subject { plugin.extract_value(object, :nonexistent_method, 1) }
-
-            it { is_expected.to eq 1 }
-          end
-        end
-      end
-
-      context "when we need to call to_s on the value" do
-        let(:object) { double(:existing_method => 1) }
-
-        subject { plugin.extract_value(object, :existing_method, nil, true) }
-
-        it { is_expected.to eq "1" }
-      end
+      expect(::Delayed::Worker.plugins).to include(Appsignal::Integrations::DelayedJobPlugin)
     end
   end
 

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

@@ -1,41 +1,89 @@
 require "rake"
 
 describe Appsignal::Hooks::RakeHook do
+  let(:helper) { Appsignal::Integrations::RakeIntegrationHelper }
   let(:task) { Rake::Task.new("task:name", Rake::Application.new) }
   let(:arguments) { Rake::TaskArguments.new(["foo"], ["bar"]) }
-  let(:generic_request) { Appsignal::Transaction::GenericRequest.new({}) }
-  before(:context) { start_agent }
+  before do
+    start_agent
+    allow(Kernel).to receive(:at_exit)
+  end
+  around { |example| keep_transactions { example.run } }
+  after do
+    if helper.instance_variable_defined?(:@register_at_exit_hook)
+      helper.remove_instance_variable(:@register_at_exit_hook)
+    end
+  end
+
+  def expect_to_not_have_registered_at_exit_hook
+    expect(Kernel).to_not have_received(:at_exit)
+  end
+
+  def expect_to_have_registered_at_exit_hook
+    expect(Kernel).to have_received(:at_exit)
+  end
 
   describe "#execute" do
     context "without error" do
-      before { expect(Appsignal).to_not receive(:stop) }
-
       def perform
         task.execute(arguments)
       end
 
-      it "creates no transaction" do
-        expect { perform }.to_not(change { created_transactions.count })
+      context "with :enable_rake_performance_instrumentation == false" do
+        before do
+          Appsignal.config[:enable_rake_performance_instrumentation] = false
+        end
+
+        it "creates no transaction" do
+          expect { perform }.to_not(change { created_transactions.count })
+        end
+
+        it "calls the original task" do
+          expect(perform).to eq([])
+        end
+
+        it "does not register an at_exit hook" do
+          perform
+          expect_to_not_have_registered_at_exit_hook
+        end
       end
 
-      it "calls the original task" do
-        expect(perform).to eq([])
+      context "with :enable_rake_performance_instrumentation == true" do
+        before do
+          Appsignal.config[:enable_rake_performance_instrumentation] = true
+        end
+
+        it "creates a transaction" do
+          expect { perform }.to(change { created_transactions.count }.by(1))
+
+          transaction = last_transaction
+          expect(transaction).to have_id
+          expect(transaction).to have_namespace(Appsignal::Transaction::BACKGROUND_JOB)
+          expect(transaction).to have_action("task:name")
+          expect(transaction).to_not have_error
+          expect(transaction).to include_params("foo" => "bar")
+          expect(transaction).to include_event("name" => "task.rake")
+          expect(transaction).to be_completed
+        end
+
+        it "calls the original task" do
+          expect(perform).to eq([])
+        end
+
+        it "registers an at_exit hook" do
+          perform
+          expect_to_have_registered_at_exit_hook
+        end
       end
     end
 
     context "with error" do
-      let(:error) { ExampleException }
       before do
-        task.enhance { raise error, "my error message" }
-        # We don't call `and_call_original` here as we don't want AppSignal to
-        # stop and start for every spec.
-        expect(Appsignal).to receive(:stop).with("rake")
+        task.enhance { raise ExampleException, "error message" }
       end
 
       def perform
-        keep_transactions do
-          expect { task.execute(arguments) }.to raise_error(error)
-        end
+        expect { task.execute(arguments) }.to raise_error(ExampleException, "error message")
       end
 
       it "creates a background job transaction" do
@@ -45,11 +93,16 @@ describe Appsignal::Hooks::RakeHook do
         expect(transaction).to have_id
         expect(transaction).to have_namespace(Appsignal::Transaction::BACKGROUND_JOB)
         expect(transaction).to have_action("task:name")
-        expect(transaction).to have_error("ExampleException", "my error message")
+        expect(transaction).to have_error("ExampleException", "error message")
         expect(transaction).to include_params("foo" => "bar")
         expect(transaction).to be_completed
       end
 
+      it "registers an at_exit hook" do
+        perform
+        expect_to_have_registered_at_exit_hook
+      end
+
       context "when first argument is not a `Rake::TaskArguments`" do
         let(:arguments) { nil }
 
@@ -62,3 +115,33 @@ describe Appsignal::Hooks::RakeHook do
     end
   end
 end
+
+describe "Appsignal::Integrations::RakeIntegrationHelper" do
+  let(:helper) { Appsignal::Integrations::RakeIntegrationHelper }
+  describe ".register_at_exit_hook" do
+    before do
+      start_agent
+      allow(Appsignal).to receive(:stop)
+    end
+
+    it "registers the at_exit hook only once" do
+      allow(Kernel).to receive(:at_exit)
+      helper.register_at_exit_hook
+      helper.register_at_exit_hook
+      expect(Kernel).to have_received(:at_exit).once
+    end
+  end
+
+  describe ".at_exit_hook" do
+    let(:helper) { Appsignal::Integrations::RakeIntegrationHelper }
+    before do
+      start_agent
+      allow(Appsignal).to receive(:stop)
+    end
+
+    it "calls Appsignal.stop" do
+      helper.at_exit_hook
+      expect(Appsignal).to have_received(:stop).with("rake")
+    end
+  end
+end