appsignal 3.0.0.beta.1 → 3.0.0.rc.1

data/spec/lib/appsignal_spec.rb

@@ -686,6 +686,9 @@ describe Appsignal do
         )
       end
       let(:error) { ExampleException.new }
+      let(:err_stream) { std_stream }
+      let(:stderr) { err_stream.read }
+      around { |example| keep_transactions { example.run } }
 
       it "sends the error to AppSignal" do
         expect(Appsignal::Transaction).to receive(:new).with(
@@ -719,30 +722,60 @@ describe Appsignal do
 
       context "with tags" do
         let(:tags) { { :a => "a", :b => "b" } }
-        before do
-          allow(Appsignal::Transaction).to receive(:new).and_return(transaction)
-        end
 
-        it "tags the request before sending it" do
-          expect(transaction).to receive(:set_tags).with(tags).and_call_original
-          expect(transaction).to receive(:complete)
+        it "prints a deprecation warning and tags the transaction" do
+          logs = capture_logs do
+            expect do
+              capture_std_streams(std_stream, err_stream) do
+                Appsignal.send_error(error, tags)
+              end
+            end.to change { created_transactions.count }.by(1)
+          end
+
+          transaction = last_transaction
+          transaction_hash = transaction.to_h
+          expect(transaction_hash).to include(
+            "sample_data" => hash_including(
+              "tags" => { "a" => "a", "b" => "b" }
+            )
+          )
 
-          Appsignal.send_error(error, tags)
+          message = "The tags argument for `Appsignal.send_error` is deprecated. " \
+            "Please use the block method to set tags instead.\n\n" \
+            "  Appsignal.send_error(error) do |transaction|\n" \
+            "    transaction.set_tags(#{tags.inspect})\n" \
+            "  end\n\n" \
+            "Appsignal.send_error called on location: #{__FILE__}:"
+          expect(stderr).to include("appsignal WARNING: #{message}")
+          expect(logs).to include(message)
         end
       end
 
       context "with namespace" do
         let(:namespace) { "admin" }
 
-        it "sets the namespace on the transaction" do
-          expect(Appsignal::Transaction).to receive(:new).with(
-            kind_of(String),
-            "admin",
-            kind_of(Appsignal::Transaction::GenericRequest)
-          ).and_call_original
-        end
+        it "prints a deprecation warning and sets the namespace on the transaction" do
+          logs = capture_logs do
+            expect do
+              capture_std_streams(std_stream, err_stream) do
+                Appsignal.send_error(error, nil, namespace)
+              end
+            end.to change { created_transactions.count }.by(1)
+          end
+
+          transaction = last_transaction
+          transaction_hash = transaction.to_h
+          expect(transaction_hash).to include("namespace" => namespace)
 
-        after { Appsignal.send_error(error, nil, namespace) }
+          message = "The namespace argument for `Appsignal.send_error` is deprecated. " \
+            "Please use the block method to set the namespace instead.\n\n" \
+            "  Appsignal.send_error(error) do |transaction|\n" \
+            "    transaction.namespace(#{namespace.inspect})\n" \
+            "  end\n\n" \
+            "Appsignal.send_error called on location: #{__FILE__}:"
+          expect(stderr).to include("appsignal WARNING: #{message}")
+          expect(logs).to include(message)
+        end
       end
 
       context "when given a block" do
@@ -769,53 +802,85 @@ describe Appsignal do
     end
 
     describe ".listen_for_error" do
+      around { |example| keep_transactions { example.run } }
+
       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 ExampleException, "I am an exception"
-          end
-        end.to raise_error(ExampleException, "I am an exception")
+          expect do
+            Appsignal.listen_for_error do
+              raise ExampleException, "I am an exception"
+            end
+          end.to raise_error(ExampleException, "I am an exception")
+        end.to change { created_transactions.count }.by(1)
+
+        expect(last_transaction.to_h).to include(
+          "error" => {
+            "name" => "ExampleException",
+            "message" => "I am an exception",
+            "backtrace" => kind_of(String)
+          },
+          "namespace" => Appsignal::Transaction::HTTP_REQUEST, # Default namespace
+          "sample_data" => hash_including(
+            "tags" => {}
+          )
+        )
       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")
+            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.to change { created_transactions.count }.by(1)
+
+          expect(last_transaction.to_h).to include(
+            "error" => {
+              "name" => "ExampleException",
+              "message" => "I am an exception",
+              "backtrace" => kind_of(String)
+            },
+            "namespace" => Appsignal::Transaction::HTTP_REQUEST, # Default namespace
+            "sample_data" => hash_including(
+              "tags" => { "foo" => "bar" }
+            )
+          )
         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")
+            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.to change { created_transactions.count }.by(1)
+
+          expect(last_transaction.to_h).to include(
+            "error" => {
+              "name" => "ExampleException",
+              "message" => "I am an exception",
+              "backtrace" => kind_of(String)
+            },
+            "namespace" => "custom_namespace",
+            "sample_data" => hash_including(
+              "tags" => {}
+            )
+          )
         end
       end
     end
 
     describe ".set_error" do
+      let(:err_stream) { std_stream }
+      let(:stderr) { err_stream.read }
+      let(:error) { ExampleException.new("I am an exception") }
       before { allow(Appsignal::Transaction).to receive(:current).and_return(transaction) }
-      let(:error) { RuntimeError.new("I am an exception") }
+      around { |example| keep_transactions { example.run } }
 
       context "when there is an active transaction" do
         it "adds the error to the active transaction" do
@@ -845,24 +910,74 @@ describe Appsignal do
         context "with tags" do
           let(:tags) { { "foo" => "bar" } }
 
-          it "sets the tags on the transaction" do
+          it "prints a deprecation warning and tags the transaction" do
             expect(transaction).to receive(:set_error).with(error)
             expect(transaction).to receive(:set_tags).with(tags)
             expect(transaction).to_not receive(:set_namespace)
 
-            Appsignal.set_error(error, tags)
+            logs = capture_logs do
+              capture_std_streams(std_stream, err_stream) do
+                Appsignal.set_error(error, tags)
+              end
+            end
+
+            message = "The tags argument for `Appsignal.set_error` is deprecated. " \
+              "Please use the block method to set tags instead.\n\n" \
+              "  Appsignal.set_error(error) do |transaction|\n" \
+              "    transaction.set_tags(#{tags.inspect})\n" \
+              "  end\n\n" \
+              "Appsignal.set_error called on location: #{__FILE__}:"
+            expect(stderr).to include("appsignal WARNING: #{message}")
+            expect(logs).to include(message)
           end
         end
 
         context "with namespace" do
           let(:namespace) { "admin" }
 
-          it "sets the namespace on the transaction" do
+          it "prints a deprecation warning andsets the namespace on the transaction" do
             expect(transaction).to receive(:set_error).with(error)
             expect(transaction).to_not receive(:set_tags)
             expect(transaction).to receive(:set_namespace).with(namespace)
 
-            Appsignal.set_error(error, nil, namespace)
+            logs = capture_logs do
+              capture_std_streams(std_stream, err_stream) do
+                Appsignal.set_error(error, nil, namespace)
+              end
+            end
+
+            message = "The namespace argument for `Appsignal.set_error` is deprecated. " \
+              "Please use the block method to set the namespace instead.\n\n" \
+              "  Appsignal.set_error(error) do |transaction|\n" \
+              "    transaction.namespace(#{namespace.inspect})\n" \
+              "  end\n\n" \
+              "Appsignal.set_error called on location: #{__FILE__}:"
+            expect(stderr).to include("appsignal WARNING: #{message}")
+            expect(logs).to include(message)
+          end
+        end
+
+        context "when given a block" do
+          it "yields the transaction and allows additional metadata to be set" do
+            captured_transaction = nil
+            keep_transactions do
+              Appsignal.set_error(StandardError.new("my_error")) do |transaction|
+                captured_transaction = transaction
+                transaction.set_action("my_action")
+                transaction.set_namespace("my_namespace")
+              end
+            end
+
+            expect(transaction).to eql(captured_transaction)
+            expect(captured_transaction.to_h).to include(
+              "namespace" => "my_namespace",
+              "action" => "my_action",
+              "error" => {
+                "name" => "StandardError",
+                "message" => "my_error",
+                "backtrace" => kind_of(String)
+              }
+            )
           end
         end
       end

data/spec/lib/puma/appsignal_spec.rb

@@ -23,6 +23,27 @@ RSpec.describe "Puma plugin" do
       def self.stats
       end
 
+      def self.run
+        # Capture threads running before application is preloaded
+        before = Thread.list.reject { |t| t.thread_variable_get(:fork_safe) }
+
+        # An abbreviated version of what happens in Puma::Cluster#run
+        launcher = MockPumaLauncher.new
+        plugin = Plugin.plugin.new
+        plugin.start(launcher)
+        launcher.events.on_booted.call
+
+        # Wait for minutely probe thread to finish starting
+        sleep 0.005
+
+        # Capture any new threads running after application is preloaded.
+        # Any threads created during the preloading phase will not be
+        # carried over into the forked workers. Puma warns about these
+        # but the minutely probe thread should only exist in the main process.
+        after = Thread.list.reject { |t| t.thread_variable_get(:fork_safe) }
+        $stdout.puts "! WARNING: Detected #{after.size - before.size} Thread(s) started in app boot" if after.size > before.size
+      end
+
       class Plugin
         class << self
           attr_reader :plugin
@@ -68,6 +89,13 @@ RSpec.describe "Puma plugin" do
     wait_for("enough probe calls") { probe.calls >= 2 }
   end
 
+  it "marks the PumaProbe thread as fork-safe", :not_ruby19 do
+    out_stream = std_stream
+    capture_stdout(out_stream) { Puma.run }
+
+    expect(out_stream.read).not_to include("WARNING: Detected 1 Thread")
+  end
+
   context "without Puma.stats" do
     before { Puma.singleton_class.send(:remove_method, :stats) }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta.1
+  version: 3.0.0.rc.1
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-28 00:00:00.000000000 Z
+date: 2021-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -241,6 +241,7 @@ files:
 - lib/appsignal/integrations/rake.rb
 - lib/appsignal/integrations/redis.rb
 - lib/appsignal/integrations/resque.rb
+- lib/appsignal/integrations/sidekiq.rb
 - lib/appsignal/integrations/sinatra.rb
 - lib/appsignal/integrations/unicorn.rb
 - lib/appsignal/integrations/webmachine.rb
@@ -326,6 +327,7 @@ files:
 - spec/lib/appsignal/integrations/padrino_spec.rb
 - spec/lib/appsignal/integrations/que_spec.rb
 - spec/lib/appsignal/integrations/railtie_spec.rb
+- spec/lib/appsignal/integrations/sidekiq_spec.rb
 - spec/lib/appsignal/integrations/sinatra_spec.rb
 - spec/lib/appsignal/integrations/webmachine_spec.rb
 - spec/lib/appsignal/logger_spec.rb
@@ -404,14 +406,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '1.9'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.2.6
+rubygems_version: 3.2.8
 signing_key:
 specification_version: 4
 summary: Logs performance and exception data from your app to appsignal.com
@@ -473,6 +475,7 @@ test_files:
 - spec/lib/appsignal/integrations/padrino_spec.rb
 - spec/lib/appsignal/integrations/que_spec.rb
 - spec/lib/appsignal/integrations/railtie_spec.rb
+- spec/lib/appsignal/integrations/sidekiq_spec.rb
 - spec/lib/appsignal/integrations/sinatra_spec.rb
 - spec/lib/appsignal/integrations/webmachine_spec.rb
 - spec/lib/appsignal/logger_spec.rb