appsignal 2.11.9-java → 3.0.2-java

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

@@ -3,6 +3,11 @@ describe Appsignal::Hooks::CelluloidHook do
     before :context do
       module Celluloid
         def self.shutdown
+          @shut_down = true
+        end
+
+        def self.shut_down?
+          @shut_down == true
         end
       end
       Appsignal::Hooks::CelluloidHook.new.install
@@ -18,7 +23,7 @@ describe Appsignal::Hooks::CelluloidHook do
     end
 
     specify { expect(Appsignal).to receive(:stop) }
-    specify { expect(Celluloid).to receive(:shutdown_without_appsignal) }
+    specify { expect(Celluloid.shut_down?).to be true }
 
     after do
       Celluloid.shutdown

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

@@ -20,8 +20,7 @@ describe Appsignal::Hooks::RakeHook do
       end
 
       it "calls the original task" do
-        expect(task).to receive(:execute_without_appsignal).with(arguments)
-        perform
+        expect(perform).to eq([])
       end
     end
 

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

@@ -1,33 +1,68 @@
 describe Appsignal::Hooks::RedisHook do
   before do
     Appsignal.config = project_fixture_config
-    Appsignal::Hooks.load_hooks
   end
 
   if DependencyHelper.redis_present?
     context "with redis" do
       context "with instrumentation enabled" do
-        before do
-          Appsignal.config.config_hash[:instrument_redis] = true
-          allow_any_instance_of(Redis::Client).to receive(:process_without_appsignal).and_return(1)
-        end
-
         describe "#dependencies_present?" do
           subject { described_class.new.dependencies_present? }
 
           it { is_expected.to be_truthy }
         end
 
-        it "should instrument a redis call" do
-          Appsignal::Transaction.create("uuid", Appsignal::Transaction::HTTP_REQUEST, "test")
-          expect(Appsignal::Transaction.current).to receive(:start_event)
-            .at_least(:once)
-          expect(Appsignal::Transaction.current).to receive(:finish_event)
-            .at_least(:once)
-            .with("query.redis", "redis://127.0.0.1:6379/0", "get ?", 0)
+        describe "integration" do
+          before do
+            Appsignal.config.config_hash[:instrument_redis] = true
+          end
+
+          context "install" do
+            before do
+              Appsignal::Hooks.load_hooks
+            end
+
+            it "does something" do
+              # Test if the last included module (prepended module) was our
+              # integration. That's not certain with the assertions below
+              # because we have to overwrite the `process` method for the test.
+              expect(Redis::Client.included_modules.first)
+                .to eql(Appsignal::Integrations::RedisIntegration)
+            end
+          end
+
+          context "instrumentation" do
+            before do
+              # Stub Redis::Client class so that it doesn't perform an actual
+              # Redis query. This class will be included (prepended) with the
+              # AppSignal Redis integration.
+              stub_const("Redis::Client", Class.new do
+                def id
+                  :stub_id
+                end
+
+                def process(_commands)
+                  :stub_process
+                end
+              end)
+              # Load the integration again for the stubbed Redis::Client class.
+              # Call it directly because {Appsignal::Hooks.load_hooks} keeps
+              # track if it was installed already or not.
+              Appsignal::Hooks::RedisHook.new.install
+            end
+
+            it "instrument a redis call" do
+              Appsignal::Transaction.create("uuid", Appsignal::Transaction::HTTP_REQUEST, "test")
+              expect(Appsignal::Transaction.current).to receive(:start_event)
+                .at_least(:once)
+              expect(Appsignal::Transaction.current).to receive(:finish_event)
+                .at_least(:once)
+                .with("query.redis", :stub_id, "get ?", 0)
 
-          client = Redis::Client.new
-          expect(client.process([[:get, "key"]])).to eq 1
+              client = Redis::Client.new
+              expect(client.process([[:get, "key"]])).to eql(:stub_process)
+            end
+          end
         end
       end
 

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

@@ -51,6 +51,10 @@ describe Appsignal::Hooks::SidekiqHook do
         yield middlewares if block_given?
         middlewares
       end
+
+      def self.error_handlers
+        @error_handlers ||= []
+      end
     end
 
     def add_middleware(middleware)
@@ -64,6 +68,12 @@ describe Appsignal::Hooks::SidekiqHook do
       stub_const "Sidekiq", SidekiqMock
     end
 
+    it "adds error handler" do
+      Sidekiq.middleware_mock = SidekiqMiddlewareMockWithPrepend
+      described_class.new.install
+      expect(Sidekiq.error_handlers).to include(Appsignal::Integrations::SidekiqErrorHandler)
+    end
+
     context "when Sidekiq middleware responds to prepend method" do # Sidekiq 3.3.0 and newer
       before { Sidekiq.middleware_mock = SidekiqMiddlewareMockWithPrepend }
 
@@ -75,7 +85,7 @@ describe Appsignal::Hooks::SidekiqHook do
         add_middleware(user_middleware2)
 
         expect(Sidekiq.server_middleware).to eql([
-          Appsignal::Hooks::SidekiqPlugin, # Prepend makes it the first entry
+          Appsignal::Integrations::SidekiqMiddleware, # Prepend makes it the first entry
           user_middleware1,
           user_middleware2
         ])
@@ -95,472 +105,10 @@ describe Appsignal::Hooks::SidekiqHook do
         # Add middlewares in whatever order they were added
         expect(Sidekiq.server_middleware).to eql([
           user_middleware1,
-          Appsignal::Hooks::SidekiqPlugin,
+          Appsignal::Integrations::SidekiqMiddleware,
           user_middleware2
         ])
       end
     end
   end
 end
-
-describe Appsignal::Hooks::SidekiqPlugin, :with_yaml_parse_error => false do
-  class DelayedTestClass; end
-
-  let(:namespace) { Appsignal::Transaction::BACKGROUND_JOB }
-  let(:worker) { anything }
-  let(:queue) { anything }
-  let(:given_args) do
-    [
-      "foo",
-      {
-        :foo => "Foo",
-        :bar => "Bar",
-        "baz" => { 1 => :foo }
-      }
-    ]
-  end
-  let(:expected_args) do
-    [
-      "foo",
-      {
-        "foo" => "Foo",
-        "bar" => "Bar",
-        "baz" => { "1" => "foo" }
-      }
-    ]
-  end
-  let(:job_class) { "TestClass" }
-  let(:jid) { "b4a577edbccf1d805744efa9" }
-  let(:item) do
-    {
-      "jid"         => jid,
-      "class"       => job_class,
-      "retry_count" => 0,
-      "queue"       => "default",
-      "created_at"  => Time.parse("2001-01-01 10:00:00UTC").to_f,
-      "enqueued_at" => Time.parse("2001-01-01 10:00:00UTC").to_f,
-      "args"        => given_args,
-      "extra"       => "data"
-    }
-  end
-  let(:plugin) { Appsignal::Hooks::SidekiqPlugin.new }
-  let(:log) { StringIO.new }
-  before do
-    start_agent
-    Appsignal.logger = test_logger(log)
-  end
-  around { |example| keep_transactions { example.run } }
-  after :with_yaml_parse_error => false do
-    expect(log_contents(log)).to_not contains_log(:warn, "Unable to load YAML")
-  end
-
-  describe "internal Sidekiq job values" do
-    it "does not save internal Sidekiq values as metadata on transaction" do
-      perform_job
-
-      transaction_hash = transaction.to_h
-      expect(transaction_hash["metadata"].keys)
-        .to_not include(*Appsignal::Hooks::SidekiqPlugin::EXCLUDED_JOB_KEYS)
-    end
-  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_job
-
-      transaction_hash = transaction.to_h
-      expect(transaction_hash["sample_data"]).to include(
-        "params" => [
-          "foo",
-          {
-            "foo" => "[FILTERED]",
-            "bar" => "Bar",
-            "baz" => { "1" => "foo" }
-          }
-        ]
-      )
-    end
-  end
-
-  context "with encrypted arguments" do
-    before do
-      item["encrypt"] = true
-      item["args"] << "super secret value" # Last argument will be replaced
-    end
-
-    it "replaces the last argument (the secret bag) with an [encrypted data] string" do
-      perform_job
-
-      transaction_hash = transaction.to_h
-      expect(transaction_hash["sample_data"]).to include(
-        "params" => expected_args << "[encrypted data]"
-      )
-    end
-  end
-
-  context "when using the Sidekiq delayed extension" do
-    let(:item) do
-      {
-        "jid" => jid,
-        "class" => "Sidekiq::Extensions::DelayedClass",
-        "queue" => "default",
-        "args" => [
-          "---\n- !ruby/class 'DelayedTestClass'\n- :foo_method\n- - :bar: baz\n"
-        ],
-        "retry" => true,
-        "created_at" => Time.parse("2001-01-01 10:00:00UTC").to_f,
-        "enqueued_at" => Time.parse("2001-01-01 10:00:00UTC").to_f,
-        "extra" => "data"
-      }
-    end
-
-    it "uses the delayed class and method name for the action" do
-      perform_job
-
-      transaction_hash = transaction.to_h
-      expect(transaction_hash["action"]).to eq("DelayedTestClass.foo_method")
-      expect(transaction_hash["sample_data"]).to include(
-        "params" => ["bar" => "baz"]
-      )
-    end
-
-    context "when job arguments is a malformed YAML object", :with_yaml_parse_error => true do
-      before { item["args"] = [] }
-
-      it "logs a warning and uses the default argument" do
-        perform_job
-
-        transaction_hash = transaction.to_h
-        expect(transaction_hash["action"]).to eq("Sidekiq::Extensions::DelayedClass#perform")
-        expect(transaction_hash["sample_data"]).to include("params" => [])
-        expect(log_contents(log)).to contains_log(:warn, "Unable to load YAML")
-      end
-    end
-  end
-
-  context "when using the Sidekiq ActiveRecord instance delayed extension" do
-    let(:item) do
-      {
-        "jid" => jid,
-        "class" => "Sidekiq::Extensions::DelayedModel",
-        "queue" => "default",
-        "args" => [
-          "---\n- !ruby/object:DelayedTestClass {}\n- :foo_method\n- - :bar: :baz\n"
-        ],
-        "retry" => true,
-        "created_at" => Time.parse("2001-01-01 10:00:00UTC").to_f,
-        "enqueued_at" => Time.parse("2001-01-01 10:00:00UTC").to_f,
-        "extra" => "data"
-      }
-    end
-
-    it "uses the delayed class and method name for the action" do
-      perform_job
-
-      transaction_hash = transaction.to_h
-      expect(transaction_hash["action"]).to eq("DelayedTestClass#foo_method")
-      expect(transaction_hash["sample_data"]).to include(
-        "params" => ["bar" => "baz"]
-      )
-    end
-
-    context "when job arguments is a malformed YAML object", :with_yaml_parse_error => true do
-      before { item["args"] = [] }
-
-      it "logs a warning and uses the default argument" do
-        perform_job
-
-        transaction_hash = transaction.to_h
-        expect(transaction_hash["action"]).to eq("Sidekiq::Extensions::DelayedModel#perform")
-        expect(transaction_hash["sample_data"]).to include("params" => [])
-        expect(log_contents(log)).to contains_log(:warn, "Unable to load YAML")
-      end
-    end
-  end
-
-  context "with an error" do
-    let(:error) { ExampleException }
-
-    it "creates a transaction and adds the error" do
-      expect(Appsignal).to receive(:increment_counter)
-        .with("sidekiq_queue_job_count", 1, :queue => "default", :status => :failed)
-      expect(Appsignal).to receive(:increment_counter)
-        .with("sidekiq_queue_job_count", 1, :queue => "default", :status => :processed)
-
-      expect do
-        perform_job { raise error, "uh oh" }
-      end.to raise_error(error)
-
-      transaction_hash = transaction.to_h
-      expect(transaction_hash).to include(
-        "id" => jid,
-        "action" => "TestClass#perform",
-        "error" => {
-          "name" => "ExampleException",
-          "message" => "uh oh",
-          # TODO: backtrace should be an Array of Strings
-          # https://github.com/appsignal/appsignal-agent/issues/294
-          "backtrace" => kind_of(String)
-        },
-        "metadata" => {
-          "extra" => "data",
-          "queue" => "default",
-          "retry_count" => "0"
-        },
-        "namespace" => namespace,
-        "sample_data" => {
-          "environment" => {},
-          "params" => expected_args,
-          "tags" => {},
-          "breadcrumbs" => []
-        }
-      )
-      expect_transaction_to_have_sidekiq_event(transaction_hash)
-    end
-  end
-
-  context "without an error" do
-    it "creates a transaction with events" do
-      expect(Appsignal).to receive(:increment_counter)
-        .with("sidekiq_queue_job_count", 1, :queue => "default", :status => :processed)
-
-      perform_job
-
-      transaction_hash = transaction.to_h
-      expect(transaction_hash).to include(
-        "id" => jid,
-        "action" => "TestClass#perform",
-        "error" => nil,
-        "metadata" => {
-          "extra" => "data",
-          "queue" => "default",
-          "retry_count" => "0"
-        },
-        "namespace" => namespace,
-        "sample_data" => {
-          "environment" => {},
-          "params" => expected_args,
-          "tags" => {},
-          "breadcrumbs" => []
-        }
-      )
-      # TODO: Not available in transaction.to_h yet.
-      # https://github.com/appsignal/appsignal-agent/issues/293
-      expect(transaction.request.env).to eq(
-        :queue_start => Time.parse("2001-01-01 10:00:00UTC").to_f
-      )
-      expect_transaction_to_have_sidekiq_event(transaction_hash)
-    end
-  end
-
-  def perform_job
-    Timecop.freeze(Time.parse("2001-01-01 10:01:00UTC")) do
-      plugin.call(worker, item, queue) do
-        yield if block_given?
-      end
-    end
-  end
-
-  def transaction
-    last_transaction
-  end
-
-  def expect_transaction_to_have_sidekiq_event(transaction_hash)
-    events = transaction_hash["events"]
-    expect(events.count).to eq(1)
-    expect(events.first).to include(
-      "name"        => "perform_job.sidekiq",
-      "title"       => "",
-      "count"       => 1,
-      "body"        => "",
-      "body_format" => Appsignal::EventFormatter::DEFAULT
-    )
-  end
-end
-
-if DependencyHelper.active_job_present?
-  require "active_job"
-  require "action_mailer"
-  require "sidekiq/testing"
-
-  describe "Sidekiq ActiveJob integration" do
-    let(:namespace) { Appsignal::Transaction::BACKGROUND_JOB }
-    let(:time) { Time.parse("2001-01-01 10:00:00UTC") }
-    let(:log) { StringIO.new }
-    let(:given_args) do
-      [
-        "foo",
-        {
-          :foo => "Foo",
-          "bar" => "Bar",
-          "baz" => { "1" => "foo" }
-        }
-      ]
-    end
-    let(:expected_args) do
-      [
-        "foo",
-        {
-          "_aj_symbol_keys" => ["foo"],
-          "foo" => "Foo",
-          "bar" => "Bar",
-          "baz" => {
-            "_aj_symbol_keys" => [],
-            "1" => "foo"
-          }
-        }
-      ]
-    end
-    let(:expected_tags) do
-      {}.tap do |hash|
-        hash["active_job_id"] = kind_of(String)
-        if DependencyHelper.rails_version >= Gem::Version.new("5.0.0")
-          hash["provider_job_id"] = kind_of(String)
-        end
-      end
-    end
-    before do
-      start_agent
-      Appsignal.logger = test_logger(log)
-      ActiveJob::Base.queue_adapter = :sidekiq
-
-      class ActiveJobSidekiqTestJob < ActiveJob::Base
-        self.queue_adapter = :sidekiq
-
-        def perform(*_args)
-        end
-      end
-
-      class ActiveJobSidekiqErrorTestJob < ActiveJob::Base
-        self.queue_adapter = :sidekiq
-
-        def perform(*_args)
-          raise "uh oh"
-        end
-      end
-      # Manually add the AppSignal middleware for the Testing environment.
-      # It doesn't use configured middlewares by default looks like.
-      # We test somewhere else if the middleware is installed properly.
-      Sidekiq::Testing.server_middleware do |chain|
-        chain.add Appsignal::Hooks::SidekiqPlugin
-      end
-    end
-    around do |example|
-      keep_transactions do
-        Sidekiq::Testing.fake! do
-          example.run
-        end
-      end
-    end
-    after do
-      Object.send(:remove_const, :ActiveJobSidekiqTestJob)
-      Object.send(:remove_const, :ActiveJobSidekiqErrorTestJob)
-    end
-
-    it "reports the transaction from the ActiveJob integration" do
-      perform_job(ActiveJobSidekiqTestJob, given_args)
-
-      transaction = last_transaction
-      transaction_hash = transaction.to_h
-      expect(transaction_hash).to include(
-        "action" => "ActiveJobSidekiqTestJob#perform",
-        "error" => nil,
-        "namespace" => namespace,
-        "metadata" => hash_including(
-          "queue" => "default"
-        ),
-        "sample_data" => hash_including(
-          "environment" => {},
-          "params" => [expected_args],
-          "tags" => expected_tags.merge("queue" => "default")
-        )
-      )
-      expect(transaction.request.env).to eq(:queue_start => time.to_f)
-      events = transaction_hash["events"]
-        .sort_by { |e| e["start"] }
-        .map { |event| event["name"] }
-      expect(events)
-        .to eq(["perform_job.sidekiq", "perform_start.active_job", "perform.active_job"])
-    end
-
-    context "with error" do
-      it "reports the error on the transaction from the ActiveRecord integration" do
-        expect do
-          perform_job(ActiveJobSidekiqErrorTestJob, given_args)
-        end.to raise_error(RuntimeError, "uh oh")
-
-        transaction = last_transaction
-        transaction_hash = transaction.to_h
-        expect(transaction_hash).to include(
-          "action" => "ActiveJobSidekiqErrorTestJob#perform",
-          "error" => {
-            "name" => "RuntimeError",
-            "message" => "uh oh",
-            "backtrace" => kind_of(String)
-          },
-          "namespace" => namespace,
-          "metadata" => hash_including(
-            "queue" => "default"
-          ),
-          "sample_data" => hash_including(
-            "environment" => {},
-            "params" => [expected_args],
-            "tags" => expected_tags.merge("queue" => "default")
-          )
-        )
-        expect(transaction.request.env).to eq(:queue_start => time.to_f)
-        events = transaction_hash["events"]
-          .sort_by { |e| e["start"] }
-          .map { |event| event["name"] }
-        expect(events)
-          .to eq(["perform_job.sidekiq", "perform_start.active_job", "perform.active_job"])
-      end
-    end
-
-    context "with ActionMailer" do
-      include ActionMailerHelpers
-
-      before do
-        class ActionMailerSidekiqTestJob < ActionMailer::Base
-          def welcome(*args)
-          end
-        end
-      end
-
-      it "reports ActionMailer data on the transaction" do
-        perform_mailer(ActionMailerSidekiqTestJob, :welcome, given_args)
-
-        transaction = last_transaction
-        transaction_hash = transaction.to_h
-        expect(transaction_hash).to include(
-          "action" => "ActionMailerSidekiqTestJob#welcome",
-          "sample_data" => hash_including(
-            "params" => ["ActionMailerSidekiqTestJob", "welcome", "deliver_now"] + expected_args
-          )
-        )
-      end
-    end
-
-    def perform_sidekiq
-      Timecop.freeze(time) do
-        yield
-        # Combined with Sidekiq::Testing.fake! and drain_all we get a
-        # enqueue_at in the job data.
-        Sidekiq::Worker.drain_all
-      end
-    end
-
-    def perform_job(job_class, args)
-      perform_sidekiq { job_class.perform_later(args) }
-    end
-
-    def perform_mailer(mailer, method, args = nil)
-      perform_sidekiq { perform_action_mailer(mailer, method, args) }
-    end
-  end
-end