appsignal 2.4.0.alpha.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d33d7ecbdd7ba0817888cd6b6347f2e9289a627b
-  data.tar.gz: f9c435c47c4403295da1ff78f89d9c1ac45b67f9
+  metadata.gz: 73a704494489e09f2d92ffc41f9628aef70e9974
+  data.tar.gz: 267fe55728850ffe4802ea0761a748c809235de5
 SHA512:
-  metadata.gz: 957c20fa113f260bbd401e3eb95f9266b4edd03f7986a555046e86cb2266e274939691ddd8cc8583406241a06bb3cbf0201b811dbfb0f65990f8972137f8cea8
-  data.tar.gz: be4355279b8fffbfd45ebaf86f0b180e0311887f37051e9aed6ee69137f71c99fdb79907f18a45fc36404127f652daad51a9ee21a537a8f2e701c253dfbeb24b
+  metadata.gz: cd3aa5683ed5c745a828caa4b4971cc1795056c91d990d114cd8e95737ce9bc02419b5255c91761cb3b5bec4aa1fdee9c59b47c6588f52a3f27679342ca2a14e
+  data.tar.gz: d2f42c59c32fc1dcfe7be0e64466d0afafc81e4d355b26c5b9618436ed9946b67e8988a960d689ada112798551833c4cc81fe6038a0de9c80487164f00ac3fc5

data/.travis.yml

@@ -30,7 +30,6 @@ gemfile:
   - "gemfiles/resque.gemfile"
   - "gemfiles/sequel.gemfile"
   - "gemfiles/sequel-435.gemfile"
-  - "gemfiles/sidekiq.gemfile"
   - "gemfiles/sinatra.gemfile"
   - "gemfiles/grape.gemfile"
   - "gemfiles/webmachine.gemfile"
@@ -46,12 +45,6 @@ matrix:
     - rvm: "jruby-19mode"
 
     # Rails 5 doesn't support Ruby < 2.2
-    - rvm: "2.0.0"
-      gemfile: "gemfiles/sidekiq.gemfile"
-    - rvm: "2.1.8"
-      gemfile: "gemfiles/sidekiq.gemfile"
-    - rvm: "jruby-19mode"
-      gemfile: "gemfiles/sidekiq.gemfile"
     - rvm: "2.0.0"
       gemfile: "gemfiles/rails-5.0.gemfile"
     - rvm: "2.1.8"

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-# 2.4.0 (alpha)
+# 2.4.0
 - Add separate GNU linux build. PR #351 and
   Commit d1763f4dcb685608468a73f3192226f60f66b217
 - Add separate FreeBSD build
@@ -8,7 +8,11 @@
   Commit d1763f4dcb685608468a73f3192226f60f66b217
 - Auto restart agent when none is running
   Commit d1763f4dcb685608468a73f3192226f60f66b217
+- Add `appsignal_user` Capistrano config option. PR #355
 - Track Exception-level exceptions. PR #356
+- Add tags and namespace arguments to `Appsignal.listen_for_error`. PR #357
+- Revert Sidekiq delayed extension job action names fix.
+  Commit 9b84a098604de5ef5e52645ba7fcb09d84f66eaa
 
 # 2.3.7
 * Support Sidekiq delayed extension job action names better. Now action names

data/README.md

@@ -72,7 +72,8 @@ instrumentation anywhere in your code.
 ```ruby
 # Simple instrumentation
 Appsignal.instrument("array_to_hash.expensive_logic", "Complex calculations") do
-  Hash[["a", 1], ["b", 2], ["c", 3]]
+  array = [["a", 1], ["b", 2], ["c", 3]]
+  Hash[array]
 end
 
 # Add the query that you're monitoring
@@ -150,7 +151,7 @@ currently. Be sure to check it out!
 ## Supported systems
 
 Currently the AppSignal agent works on most Unix-like operating systems, such
-as most Linux distributions and macOS, excluding FreeBSD and Windows.
+as most Linux distributions, FreeBSD, macOS, excluding Microsoft Windows.
 
 For more detailed information please visit our [Supported
 systems][supported-systems] page.

data/Rakefile

@@ -14,7 +14,6 @@ GEMFILES = %w(
   resque
   sequel
   sequel-435
-  sidekiq
   sinatra
   grape
   webmachine

data/lib/appsignal.rb

@@ -217,10 +217,37 @@ module Appsignal
       stop("monitor_single_transaction")
     end
 
-    def listen_for_error
+    # Listen for an error to occur and send it to AppSignal.
+    #
+    # Uses {.send_error} to directly send the error in a separate transaction.
+    # Does not add the error to the current transaction.
+    #
+    # Make sure that AppSignal is integrated in your application beforehand.
+    # AppSignal won't record errors unless {Config#active?} is `true`.
+    #
+    # @example
+    #   # my_app.rb
+    #   # setup AppSignal beforehand
+    #
+    #   Appsignal.listen_for_error do
+    #     # my code
+    #     raise "foo"
+    #   end
+    #
+    # @see Transaction.set_tags
+    # @see Transaction.set_namespace
+    # @see .send_error
+    # @see https://docs.appsignal.com/ruby/instrumentation/integrating-appsignal.html
+    #   AppSignal integration guide
+    #
+    # @param tags [Hash, nil]
+    # @param namespace [String] the namespace for this error.
+    # @yield yields the given block.
+    # @return [Object] returns the return value of the given block.
+    def listen_for_error(tags = nil, namespace = Appsignal::Transaction::HTTP_REQUEST)
       yield
     rescue Exception => error # rubocop:disable Lint/RescueException
-      send_error(error)
+      send_error(error, tags, namespace)
       raise error
     end
     alias :listen_for_exception :listen_for_error

data/lib/appsignal/hooks/sidekiq.rb

@@ -14,78 +14,32 @@ module Appsignal
       end
 
       def call(_worker, item, _queue)
-        job = fetch_sidekiq_job { ::Sidekiq::Job.new(item) }
-        job_metadata = call_and_log_on_error(job, &:item)
-
-        job_action_name = parse_action_name(job)
-        params = Appsignal::Utils::ParamsSanitizer.sanitize(
-          call_and_log_on_error(job, &:display_args),
-          :filter_parameters => Appsignal.config[:filter_parameters]
-        )
-
-        transaction = Appsignal::Transaction.create(
-          SecureRandom.uuid,
-          Appsignal::Transaction::BACKGROUND_JOB,
-          Appsignal::Transaction::GenericRequest.new(
-            :queue_start => call_and_log_on_error(job, &:enqueued_at),
-            :queue_time  => call_and_log_on_error(job) { |j| j.latency.to_f * 1000 }
-          )
-        )
-
-        Appsignal.instrument "perform_job.sidekiq" do
-          begin
-            yield
-          rescue Exception => exception # rubocop:disable Lint/RescueException
-            transaction.set_error(exception)
-            raise exception
+        args =
+          if item["class"] == "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper"
+            item["args"].first["arguments"]
+          else
+            item["args"]
           end
-        end
-      ensure
-        if transaction
-          transaction.set_action_if_nil(job_action_name)
-          transaction.params = params
-          formatted_metadata(job_metadata).each do |key, value|
-            transaction.set_metadata key, value
-          end
-          transaction.set_http_or_background_queue_start
-          Appsignal::Transaction.complete_current!
-        end
-      end
-
-      private
-
-      def fetch_sidekiq_job
-        yield
-      rescue NameError => e
-        Appsignal.logger.error("Problem parsing the Sidekiq job data: #{e.inspect}")
-        nil
-      end
-
-      def call_and_log_on_error(job)
-        yield job if job
-      rescue NameError => e
-        Appsignal.logger.error("Problem parsing the Sidekiq job data: #{e.inspect}")
-        nil
-      end
+        params = Appsignal::Utils::ParamsSanitizer.sanitize args,
+          :filter_parameters => Appsignal.config[:filter_parameters]
 
-      def parse_action_name(job)
-        # `job.display_class` needs to be called before `job.display_args`,
-        # see https://github.com/appsignal/appsignal-ruby/pull/348#issuecomment-333629065
-        action_name = call_and_log_on_error(job, &:display_class)
-        if action_name =~ /[\.#]+/
-          action_name
-        else
-          # Add `#perform` as default method name for job names without a
-          # method name
-          "#{action_name}#perform"
+        Appsignal.monitor_transaction(
+          "perform_job.sidekiq",
+          :class       => item["wrapped"] || item["class"],
+          :method      => "perform",
+          :metadata    => formatted_metadata(item),
+          :params      => params,
+          :queue_start => item["enqueued_at"],
+          :queue_time  => (Time.now.to_f - item["enqueued_at"].to_f) * 1000
+        ) do
+          yield
         end
       end
 
       def formatted_metadata(item)
-        {}.tap do |hash|
-          (item || {}).each do |key, value|
-            next if job_keys.include?(key)
-            hash[key] = truncate(string_or_inspect(value))
+        {}.tap do |hsh|
+          item.each do |key, val|
+            hsh[key] = truncate(string_or_inspect(val)) unless job_keys.include?(key)
           end
         end
       end
@@ -99,7 +53,6 @@ module Appsignal
       end
 
       def install
-        require "sidekiq/api"
         ::Sidekiq.configure_server do |config|
           config.server_middleware do |chain|
             chain.add Appsignal::Hooks::SidekiqPlugin

data/lib/appsignal/integrations/capistrano/appsignal.cap

@@ -1,7 +1,7 @@
 namespace :appsignal do
   task :deploy do
     appsignal_env = fetch(:appsignal_env, fetch(:stage, fetch(:rails_env, fetch(:rack_env, "production"))))
-    user = ENV["USER"] || ENV["USERNAME"]
+    user = fetch(:appsignal_user, ENV["USER"] || ENV["USERNAME"])
     revision = fetch(:appsignal_revision, fetch(:current_revision))
 
     appsignal_config = Appsignal::Config.new(

data/lib/appsignal/integrations/capistrano/capistrano_2_tasks.rb

@@ -10,7 +10,7 @@ module Appsignal
         namespace :appsignal do
           task :deploy do
             env = fetch(:appsignal_env, fetch(:stage, fetch(:rails_env, fetch(:rack_env, "production"))))
-            user = ENV["USER"] || ENV["USERNAME"]
+            user = fetch(:appsignal_user, ENV["USER"] || ENV["USERNAME"])
             revision = fetch(:appsignal_revision, fetch(:current_revision))
 
             appsignal_config = Appsignal::Config.new(

data/lib/appsignal/transaction.rb

@@ -54,12 +54,6 @@ module Appsignal
       rescue => e
         Appsignal.logger.error("Failed to complete transaction ##{current.transaction_id}. #{e.message}")
       ensure
-        clear_current_transaction!
-      end
-
-      # Remove current transaction from current Thread.
-      # @api private
-      def clear_current_transaction!
         Thread.current[:appsignal_transaction] = nil
       end
 
@@ -318,7 +312,6 @@ module Appsignal
       finish_event(name, title, body, body_format)
     end
 
-    # @api private
     def to_h
       JSON.parse(@ext.to_json)
     end

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 require "yaml"
 
 module Appsignal
-  VERSION = "2.4.0.alpha.1".freeze
+  VERSION = "2.4.0".freeze
 end

data/spec/lib/appsignal/capistrano2_spec.rb

@@ -152,6 +152,20 @@ if DependencyHelper.capistrano2_present?
             end
           end
 
+          context "with overridden deploy user" do
+            before do
+              capistrano_config.set(:appsignal_user, "robin")
+              stub_marker_request(:user => "robin").to_return(:status => 200)
+              run
+            end
+
+            it "transmits the overriden deploy user" do
+              expect(output).to include \
+                "Notifying AppSignal of deploy with: revision: 503ce0923ed177a3ce000005, user: robin",
+                "AppSignal has been notified of this deploy!"
+            end
+          end
+
           context "with failed request" do
             before do
               stub_marker_request.to_return(:status => 500)

data/spec/lib/appsignal/capistrano3_spec.rb

@@ -152,6 +152,20 @@ if DependencyHelper.capistrano3_present?
             end
           end
 
+          context "with overridden deploy user" do
+            before do
+              capistrano_config.set(:appsignal_user, "robin")
+              stub_marker_request(:user => "robin").to_return(:status => 200)
+              run
+            end
+
+            it "transmits the overriden deploy user" do
+              expect(output).to include \
+                "Notifying AppSignal of deploy with: revision: 503ce0923ed177a3ce000005, user: robin",
+                "AppSignal has been notified of this deploy!"
+            end
+          end
+
           if Gem::Version.new(Capistrano::VERSION) >= Gem::Version.new("3.5.0")
             context "when dry run" do
               before do

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

@@ -1,101 +1,145 @@
-if DependencyHelper.sidekiq_present?
-  describe Appsignal::Hooks::SidekiqPlugin, :with_sidekiq_error => false do
-    let(:namespace) { Appsignal::Transaction::BACKGROUND_JOB }
-    let(:worker) { anything }
-    let(:queue) { anything }
-    let(:args) { ["Model", 1] }
-    let(:job_class) { "TestClass" }
-    let(:item) do
-      {
-        "class"       => job_class,
-        "retry_count" => 0,
-        "queue"       => "default",
-        "enqueued_at" => Time.parse("01-01-2001 10:00:00UTC").to_f,
-        "args"        => args,
-        "extra"       => "data"
-      }
-    end
-    let(:plugin) { Appsignal::Hooks::SidekiqPlugin.new }
-    let(:test_store) { {} }
+describe Appsignal::Hooks::SidekiqPlugin do
+  let(:worker) { double }
+  let(:queue) { double }
+  let(:current_transaction) { background_job_transaction }
+  let(:args) { ["Model", 1] }
+  let(:item) do
+    {
+      "class"       => "TestClass",
+      "retry_count" => 0,
+      "queue"       => "default",
+      "enqueued_at" => Time.parse("01-01-2001 10:00:00UTC"),
+      "args"        => args,
+      "extra"       => "data"
+    }
+  end
+  let(:plugin) { Appsignal::Hooks::SidekiqPlugin.new }
 
-    before :with_sidekiq_error => false do
-      # Stub calls to extension, because that would remove the transaction
-      # from the extension.
-      allow_any_instance_of(Appsignal::Extension::Transaction).to receive(:finish).and_return(true)
-      allow_any_instance_of(Appsignal::Extension::Transaction).to receive(:complete)
+  before do
+    allow(Appsignal::Transaction).to receive(:current).and_return(current_transaction)
+    start_agent
+  end
 
-      # Stub removal of current transaction from current thread so we can fetch
-      # it later.
-      expect(Appsignal::Transaction).to receive(:clear_current_transaction!).at_least(:once) do
-        transaction = Thread.current[:appsignal_transaction]
-        test_store[:transaction] = transaction if transaction
+  context "with a performance call" do
+    after do
+      Timecop.freeze(Time.parse("01-01-2001 10:01:00UTC")) do
+        Appsignal::Hooks::SidekiqPlugin.new.call(worker, item, queue) do
+          # nothing
+        end
       end
     end
-    before do
-      start_agent
+
+    it "wraps it in a transaction with the correct params" do
+      expect(Appsignal).to receive(:monitor_transaction).with(
+        "perform_job.sidekiq",
+        :class    => "TestClass",
+        :method   => "perform",
+        :metadata => {
+          "retry_count" => "0",
+          "queue"       => "default",
+          "extra"       => "data"
+        },
+        :params      => ["Model", 1],
+        :queue_start => Time.parse("01-01-2001 10:00:00UTC"),
+        :queue_time  => 60_000.to_f
+      )
     end
-    after { clear_current_transaction! }
 
-    context "when there's a problem with calling the Sidekiq::Job class", :with_sidekiq_error => true do
-      let(:log) { StringIO.new }
-      before do
-        Appsignal.logger = Logger.new(log)
-        expect(::Sidekiq::Job).to receive(:new).and_raise(NameError, "woops")
-        perform_job
+    context "with more complex arguments" do
+      let(:default_params) do
+        {
+          :class    => "TestClass",
+          :method   => "perform",
+          :metadata => {
+            "retry_count" => "0",
+            "queue"       => "default",
+            "extra"       => "data"
+          },
+          :params => {
+            :foo => "Foo",
+            :bar => "Bar"
+          },
+          :queue_start => Time.parse("01-01-2001 10:00:00UTC"),
+          :queue_time  => 60_000.to_f
+        }
+      end
+      let(:args) do
+        {
+          :foo => "Foo",
+          :bar => "Bar"
+        }
       end
 
-      it "does not record a transaction and logs an error" do
-        expect(transaction).to be_nil
-        log.rewind
-        expect(log.read).to include(
-          "ERROR",
-          "Problem parsing the Sidekiq job data: #<NameError: woops>"
+      it "adds the more complex arguments" do
+        expect(Appsignal).to receive(:monitor_transaction).with(
+          "perform_job.sidekiq",
+          default_params.merge(
+            :params => {
+              :foo => "Foo",
+              :bar => "Bar"
+            }
+          )
         )
       end
-    end
 
-    context "with a performance call" do
-      it "creates a transaction with performance events" do
-        perform_job
+      context "with parameter filtering" do
+        before do
+          Appsignal.config = project_fixture_config("production")
+          Appsignal.config[:filter_parameters] = ["foo"]
+        end
 
-        transaction_hash = transaction.to_h
-        expect(transaction_hash).to include(
-          "id" => kind_of(String),
-          "action" => "TestClass#perform",
-          "error" => nil,
-          "namespace" => namespace,
-          "metadata" => {
-            "extra" => "data",
-            "queue" => "default",
-            "retry_count" => "0"
-          },
-          "sample_data" => {
-            "environment" => {},
-            "params" => args,
-            "tags" => {}
-          }
-        )
-        # 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("01-01-2001 10:00:00UTC"),
-          :queue_time  => 60_000.0
-        )
-        expect_transaction_to_have_sidekiq_event(transaction_hash)
+        it "filters selected arguments" do
+          expect(Appsignal).to receive(:monitor_transaction).with(
+            "perform_job.sidekiq",
+            default_params.merge(
+              :params => {
+                :foo => "[FILTERED]",
+                :bar => "Bar"
+              }
+            )
+          )
+        end
       end
+    end
 
-      context "when receiving class.method instead of class#method" do
-        let(:job_class) { "ActionMailer.deliver_message" }
-
-        it "uses the class method action name for the action" do
-          perform_job
+    context "when wrapped by ActiveJob" do
+      let(:item) do
+        {
+          "class" => "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper",
+          "wrapped" => "TestClass",
+          "queue" => "default",
+          "args" => [{
+            "job_class" => "TestJob",
+            "job_id" => "23e79d48-6966-40d0-b2d4-f7938463a263",
+            "queue_name" => "default",
+            "arguments" => args
+          }],
+          "retry" => true,
+          "jid" => "efb140489485999d32b5504c",
+          "created_at" => Time.parse("01-01-2001 10:00:00UTC").to_f,
+          "enqueued_at" => Time.parse("01-01-2001 10:00:00UTC").to_f
+        }
+      end
+      let(:default_params) do
+        {
+          :class    => "TestClass",
+          :method   => "perform",
+          :metadata => {
+            "queue" => "default"
+          },
+          :queue_start => Time.parse("01-01-2001 10:00:00UTC").to_f,
+          :queue_time  => 60_000.to_f
+        }
+      end
 
-          transaction_hash = transaction.to_h
-          expect(transaction_hash["action"]).to eq("ActionMailer.deliver_message")
-        end
+      it "wraps it in a transaction with the correct params" do
+        expect(Appsignal).to receive(:monitor_transaction).with(
+          "perform_job.sidekiq",
+          default_params.merge(:params => ["Model", 1])
+        )
       end
 
-      context "with more complex job arguments" do
+      context "with more complex arguments" do
         let(:args) do
           {
             :foo => "Foo",
@@ -104,14 +148,14 @@ if DependencyHelper.sidekiq_present?
         end
 
         it "adds the more complex arguments" do
-          perform_job
-
-          transaction_hash = transaction.to_h
-          expect(transaction_hash["sample_data"]).to include(
-            "params" => {
-              "foo" => "Foo",
-              "bar" => "Bar"
-            }
+          expect(Appsignal).to receive(:monitor_transaction).with(
+            "perform_job.sidekiq",
+            default_params.merge(
+              :params => {
+                :foo => "Foo",
+                :bar => "Bar"
+              }
+            )
           )
         end
 
@@ -122,166 +166,90 @@ if DependencyHelper.sidekiq_present?
           end
 
           it "filters selected arguments" do
-            perform_job
-
-            transaction_hash = transaction.to_h
-            expect(transaction_hash["sample_data"]).to include(
-              "params" => {
-                "foo" => "[FILTERED]",
-                "bar" => "Bar"
-              }
-            )
-          end
-        end
-      end
-
-      context "when job is wrapped by ActiveJob" do
-        let(:item) do
-          {
-            "class" => "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper",
-            "wrapped" => "TestClass",
-            "queue" => "default",
-            "args" => [{
-              "job_class" => "TestJob",
-              "job_id" => "23e79d48-6966-40d0-b2d4-f7938463a263",
-              "queue_name" => "default",
-              "arguments" => args
-            }],
-            "retry" => true,
-            "jid" => "efb140489485999d32b5504c",
-            "created_at" => Time.parse("01-01-2001 10:00:00UTC"),
-            "enqueued_at" => Time.parse("01-01-2001 10:00:00UTC").to_f
-          }
-        end
-
-        it "creates a transaction with performance events" do
-          perform_job
-
-          transaction_hash = transaction.to_h
-          expect(transaction_hash).to include(
-            "id" => kind_of(String),
-            "action" => "TestClass#perform",
-            "error" => nil,
-            "namespace" => namespace,
-            "metadata" => {
-              "queue" => "default"
-            },
-            "sample_data" => {
-              "environment" => {},
-              "params" => args,
-              "tags" => {}
-            }
-          )
-          # 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("01-01-2001 10:00:00UTC"),
-            :queue_time  => 60_000.0
-          )
-          expect_transaction_to_have_sidekiq_event(transaction_hash)
-        end
-
-        context "with more complex arguments" do
-          let(:args) do
-            {
-              :foo => "Foo",
-              :bar => "Bar"
-            }
-          end
-
-          it "adds the more complex arguments" do
-            perform_job
-
-            transaction_hash = transaction.to_h
-            expect(transaction_hash["sample_data"]).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_job
-
-              transaction_hash = transaction.to_h
-              expect(transaction_hash["sample_data"]).to include(
-                "params" => {
-                  "foo" => "[FILTERED]",
-                  "bar" => "Bar"
+            expect(Appsignal).to receive(:monitor_transaction).with(
+              "perform_job.sidekiq",
+              default_params.merge(
+                :params => {
+                  :foo => "[FILTERED]",
+                  :bar => "Bar"
                 }
               )
-            end
+            )
           end
         end
       end
     end
+  end
 
-    context "with an erroring job" do
-      let(:error) { ExampleException }
-      before do
-        expect do
-          Timecop.freeze(Time.parse("01-01-2001 10:01:00UTC")) do
-            plugin.call(worker, item, queue) do
-              raise error, "uh oh"
-            end
-          end
-        end.to raise_error(error)
-      end
+  context "with an erroring call" do
+    let(:error) { ExampleException }
+    let(:transaction) do
+      Appsignal::Transaction.new(
+        SecureRandom.uuid,
+        Appsignal::Transaction::BACKGROUND_JOB,
+        Appsignal::Transaction::GenericRequest.new({})
+      )
+    end
+    before do
+      allow(Appsignal::Transaction).to receive(:current).and_return(transaction)
+      expect(Appsignal::Transaction).to receive(:create)
+        .with(
+          kind_of(String),
+          Appsignal::Transaction::BACKGROUND_JOB,
+          kind_of(Appsignal::Transaction::GenericRequest)
+        ).and_return(transaction)
+    end
 
-      it "adds the error to the transaction" do
-        transaction_hash = transaction.to_h
-        # TODO: backtrace should be an Array of Strings
-        # https://github.com/appsignal/appsignal-agent/issues/294
-        expect(transaction_hash["error"]).to include(
-          "name" => "ExampleException",
-          "message" => "uh oh",
-          "backtrace" => kind_of(String)
-        )
-        expect_transaction_to_have_sidekiq_event(transaction_hash)
-      end
+    it "adds the error to the transaction" do
+      expect(transaction).to receive(:set_error).with(error)
+      expect(transaction).to receive(:complete)
     end
 
-    def perform_job
-      Timecop.freeze(Time.parse("01-01-2001 10:01:00UTC")) do
-        plugin.call(worker, item, queue) do
-          # nothing
+    after do
+      expect do
+        Timecop.freeze(Time.parse("01-01-2001 10:01:00UTC")) do
+          Appsignal::Hooks::SidekiqPlugin.new.call(worker, item, queue) do
+            raise error
+          end
         end
-      end
+      end.to raise_error(error)
     end
+  end
 
-    def transaction
-      test_store[:transaction]
+  # TODO: Don't test (what are basically) private methods
+  describe "#formatted_data" do
+    let(:item) do
+      {
+        "foo"   => "bar",
+        "class" => "TestClass"
+      }
     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
-      )
+    it "only adds items to the hash that do not appear in JOB_KEYS" do
+      expect(plugin.formatted_metadata(item)).to eq("foo" => "bar")
     end
   end
 end
 
 describe Appsignal::Hooks::SidekiqHook do
-  if DependencyHelper.sidekiq_present?
+  context "with sidekiq" do
+    before :context do
+      module Sidekiq
+        def self.configure_server
+        end
+      end
+      Appsignal::Hooks::SidekiqHook.new.install
+    end
+    after(:context) { Object.send(:remove_const, :Sidekiq) }
+
     describe "#dependencies_present?" do
       subject { described_class.new.dependencies_present? }
 
       it { is_expected.to be_truthy }
     end
-  else
+  end
+
+  context "without sidekiq" do
     describe "#dependencies_present?" do
       subject { described_class.new.dependencies_present? }
 

data/spec/lib/appsignal_spec.rb

@@ -257,7 +257,7 @@ describe Appsignal do
     end
 
     describe ".listen_for_error" do
-      it "should do nothing" do
+      it "does not record anyhing" do
         error = RuntimeError.new("specific error")
         expect do
           Appsignal.listen_for_error do
@@ -779,13 +779,47 @@ describe Appsignal do
     end
 
     describe ".listen_for_error" do
-      it "should call send_error and re-raise" do
-        expect(Appsignal).to receive(:send_error).with(kind_of(Exception))
+      it "records the error and re-raise it" do
+        expect(Appsignal).to receive(:send_error).with(
+          kind_of(ExampleException),
+          nil,
+          Appsignal::Transaction::HTTP_REQUEST
+        )
         expect do
           Appsignal.listen_for_error do
-            raise "I am an exception"
+            raise ExampleException, "I am an exception"
           end
-        end.to raise_error(RuntimeError, "I am an exception")
+        end.to raise_error(ExampleException, "I am an exception")
+      end
+
+      context "with tags" do
+        it "adds tags to the transaction" do
+          expect(Appsignal).to receive(:send_error).with(
+            kind_of(ExampleException),
+            { "foo" => "bar" },
+            Appsignal::Transaction::HTTP_REQUEST
+          )
+          expect do
+            Appsignal.listen_for_error("foo" => "bar") do
+              raise ExampleException, "I am an exception"
+            end
+          end.to raise_error(ExampleException, "I am an exception")
+        end
+      end
+
+      context "with a custom namespace" do
+        it "adds the namespace to the transaction" do
+          expect(Appsignal).to receive(:send_error).with(
+            kind_of(ExampleException),
+            nil,
+            "custom_namespace"
+          )
+          expect do
+            Appsignal.listen_for_error(nil, "custom_namespace") do
+              raise ExampleException, "I am an exception"
+            end
+          end.to raise_error(ExampleException, "I am an exception")
+        end
       end
     end
 

data/spec/support/helpers/dependency_helper.rb

@@ -63,10 +63,6 @@ module DependencyHelper
       Gem.loaded_specs["capistrano"].version >= Gem::Version.new("3.0")
   end
 
-  def sidekiq_present?
-    dependency_present? "sidekiq"
-  end
-
   def dependency_present?(dependency_file)
     Gem.loaded_specs.key? dependency_file
   end

data/spec/support/helpers/transaction_helpers.rb

@@ -28,10 +28,4 @@ module TransactionHelpers
       }.merge(args))
     )
   end
-
-  # Use when {Appsignal::Transaction.clear_current_transaction!} is stubbed to
-  # clear the current transaction on the current thread.
-  def clear_current_transaction!
-    Thread.current[:appsignal_transaction] = nil
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 2.4.0.alpha.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Robert Beekman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-17 00:00:00.000000000 Z
+date: 2017-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -163,7 +163,6 @@ files:
 - gemfiles/resque.gemfile
 - gemfiles/sequel-435.gemfile
 - gemfiles/sequel.gemfile
-- gemfiles/sidekiq.gemfile
 - gemfiles/sinatra.gemfile
 - gemfiles/webmachine.gemfile
 - lib/appsignal.rb
@@ -349,9 +348,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.2.1

data/gemfiles/sidekiq.gemfile

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'sidekiq'
-
-gemspec :path => '../'