appsignal 2.8.4 → 2.9.0

data/spec/lib/appsignal/system_spec.rb

@@ -19,41 +19,6 @@ describe Appsignal::System do
     end
   end
 
-  describe ".installed_agent_architecture" do
-    let(:const_name) { "GEM_EXT_PATH".freeze }
-    let(:tmp_ext_dir) { File.join(tmp_dir, "ext") }
-    let(:architecture_file) { File.join(Appsignal::System::GEM_EXT_PATH, "appsignal.architecture") }
-    around do |example|
-      original_gem_ext_path = Appsignal::System.const_get(const_name)
-      Appsignal::System.send(:remove_const, const_name)
-      Appsignal::System.const_set(const_name, tmp_ext_dir)
-      example.run
-      Appsignal::System.send(:remove_const, const_name)
-      Appsignal::System.const_set(const_name, original_gem_ext_path)
-    end
-    after { FileUtils.rm_rf(tmp_ext_dir) }
-    subject { described_class.installed_agent_architecture }
-
-    context "with an ext/appsignal.architecture file" do
-      before do
-        FileUtils.mkdir_p(Appsignal::System::GEM_EXT_PATH)
-        File.open(architecture_file, "w") do |file|
-          file.write "foo"
-        end
-      end
-
-      it "returns the contents of the file" do
-        expect(subject).to eq("foo")
-      end
-    end
-
-    context "without an ext/appsignal.architecture file" do
-      it "returns nil" do
-        expect(subject).to be_nil
-      end
-    end
-  end
-
   describe ".agent_platform" do
     let(:os) { "linux-gnu" }
     let(:ldd_output) { "" }

data/spec/lib/appsignal/utils/hash_sanitizer_spec.rb

@@ -30,19 +30,20 @@ describe Appsignal::Utils::HashSanitizer do
     let(:sanitized_params) { described_class.sanitize(params) }
     subject { sanitized_params }
 
-    it { is_expected.to be_instance_of Hash }
-    it { expect(subject[:text]).to eq("string") }
-    it { expect(subject["string"]).to eq("string key value") }
-    it do
+    it "returns a sanitized Hash" do
+      expect(subject).to_not eq(params)
+      is_expected.to be_instance_of Hash
+      expect(subject[:text]).to eq("string")
+      expect(subject["string"]).to eq("string key value")
       expect(subject[:file]).to be_instance_of String
       expect(subject[:file]).to include "::UploadedFile"
+      expect(subject[:float]).to eq(0.0)
+      expect(subject[:bool_true]).to be(true)
+      expect(subject[:bool_false]).to be(false)
+      expect(subject[:nil]).to be_nil
+      expect(subject[:int]).to eq(1)
+      expect(subject[:int64]).to eq(1 << 64)
     end
-    it { expect(subject[:float]).to eq(0.0) }
-    it { expect(subject[:bool_true]).to be(true) }
-    it { expect(subject[:bool_false]).to be(false) }
-    it { expect(subject[:nil]).to be_nil }
-    it { expect(subject[:int]).to eq(1) }
-    it { expect(subject[:int64]).to eq(1 << 64) }
 
     it "does not change the original params" do
       subject
@@ -50,29 +51,34 @@ describe Appsignal::Utils::HashSanitizer do
       expect(params[:hash][:nested_array][2]).to eq(file)
     end
 
-    describe ":hash" do
+    describe ":hash key" do
       subject { sanitized_params[:hash] }
 
-      it { is_expected.to be_instance_of Hash }
-      it { expect(subject[:nested_text]).to eq("string") }
+      it "returns a sanitized Hash" do
+        expect(subject).to_not eq(params[:hash])
+        is_expected.to be_instance_of Hash
+        expect(subject[:nested_text]).to eq("string")
+      end
 
-      describe ":nested_array" do
+      describe ":nested_array key" do
         subject { sanitized_params[:hash][:nested_array] }
 
-        it { is_expected.to be_instance_of Array }
-        it { expect(subject[0]).to eq("something") }
-        it { expect(subject[1]).to eq("else") }
-        it do
+        it "returns a sanitized Array" do
+          expect(subject).to_not eq(params[:hash][:nested_array])
+          is_expected.to be_instance_of Array
+          expect(subject[0]).to eq("something")
+          expect(subject[1]).to eq("else")
           expect(subject[2]).to be_instance_of String
           expect(subject[2]).to include "::UploadedFile"
         end
 
-        describe ":nested_hash" do
+        describe ":nested_hash key" do
           subject { sanitized_params[:hash][:nested_array][3] }
 
-          it { is_expected.to be_instance_of Hash }
-          it { expect(subject[:key]).to eq("value") }
-          it do
+          it "returns a sanitized Hash" do
+            expect(subject).to_not eq(params[:hash][:nested_array][3])
+            is_expected.to be_instance_of Hash
+            expect(subject[:key]).to eq("value")
             expect(subject[:file]).to be_instance_of String
             expect(subject[:file]).to include "::UploadedFile"
           end
@@ -86,17 +92,19 @@ describe Appsignal::Utils::HashSanitizer do
       end
       subject { sanitized_params }
 
-      it { expect(subject[:text]).to eq(described_class::FILTERED) }
-      it { expect(subject[:hash]).to eq(described_class::FILTERED) }
-      it do
+      it "returns a sanitized Hash with the given keys filtered out" do
+        expect(subject).to_not eq(params)
+        expect(subject[:text]).to eq(described_class::FILTERED)
+        expect(subject[:hash]).to eq(described_class::FILTERED)
+
         expect(subject[:file]).to be_instance_of String
         expect(subject[:file]).to include "::UploadedFile"
+        expect(subject[:float]).to eq(0.0)
+        expect(subject[:bool_true]).to be(true)
+        expect(subject[:bool_false]).to be(false)
+        expect(subject[:nil]).to be_nil
+        expect(subject[:int]).to eq(1)
       end
-      it { expect(subject[:float]).to eq(0.0) }
-      it { expect(subject[:bool_true]).to be(true) }
-      it { expect(subject[:bool_false]).to be(false) }
-      it { expect(subject[:nil]).to be_nil }
-      it { expect(subject[:int]).to eq(1) }
 
       context "with strings as key filter values" do
         let(:sanitized_params) do
@@ -108,7 +116,7 @@ describe Appsignal::Utils::HashSanitizer do
         end
       end
 
-      describe ":hash" do
+      describe ":hash key" do
         let(:sanitized_params) do
           described_class.sanitize(params, %w[nested_text])
         end

data/spec/lib/appsignal/utils/json_spec.rb

@@ -16,10 +16,12 @@ describe Appsignal::Utils::JSON do
         }
       end
 
-      it { is_expected.to eq %({"the":"payload","1":true,"":"test","foo":[1,2,"three"],"bar":null,"baz":{"foo":"bar"}}) }
+      it "returns a JSON string" do
+        is_expected.to eq %({"the":"payload","1":true,"":"test","foo":[1,2,"three"],"bar":null,"baz":{"foo":"bar"}})
+      end
     end
 
-    context "with a body that contains strings with invalid utf-8 content" do
+    context "with a body that contains strings with invalid UTF-8 content" do
       let(:string_with_invalid_utf8) { [0x61, 0x61, 0x85].pack("c*") }
       let(:body) do
         {
@@ -34,7 +36,9 @@ describe Appsignal::Utils::JSON do
         }
       end
 
-      it { is_expected.to eq %({"field_one":"aa","field_two":"aa�","field_three":["one","aa�"],"field_four":{"one":"aa�"}}) }
+      it "returns a JSON string with invalid UTF-8 content" do
+        is_expected.to eq %({"field_one":"aa","field_two":"aa�","field_three":["one","aa�"],"field_four":{"one":"aa�"}})
+      end
     end
   end
 end

data/spec/lib/appsignal_spec.rb

@@ -90,12 +90,14 @@ describe Appsignal do
         unless Appsignal::System.jruby?
           it "installs the allocation event hook" do
             expect(Appsignal::Extension).to receive(:install_allocation_event_hook)
+              .and_call_original
             Appsignal.start
           end
         end
 
         it "should add the gc probe to minutely" do
-          expect(Appsignal::Minutely).to receive(:add_gc_probe)
+          expect(Appsignal::Minutely).to receive(:register_garbage_collection_probe)
+            .and_call_original
           Appsignal.start
         end
       end
@@ -117,7 +119,7 @@ describe Appsignal do
         end
 
         it "should not add the gc probe to minutely" do
-          expect(Appsignal::Minutely).not_to receive(:add_gc_probe)
+          expect(Appsignal::Minutely).not_to receive(:register_garbage_collection_probe)
           Appsignal.start
         end
       end
@@ -650,6 +652,29 @@ describe Appsignal do
 
         after { Appsignal.send_error(error, nil, namespace) }
       end
+
+      context "when given a block" do
+        it "yields the transaction and allows additional metadata to be set" do
+          captured_transaction = nil
+          Appsignal.send_error(StandardError.new("my_error")) do |transaction|
+            captured_transaction = transaction
+            transaction.set_action("my_action")
+            transaction.set_namespace("my_namespace")
+
+            # Don't flush the transaction, so we can inspect it
+            expect(transaction).to receive(:complete)
+          end
+          expect(captured_transaction.to_h).to include(
+            "namespace" => "my_namespace",
+            "action" => "my_action",
+            "error" => {
+              "name" => "StandardError",
+              "message" => "my_error",
+              "backtrace" => kind_of(String) # TODO: should be Array
+            }
+          )
+        end
+      end
     end
 
     describe ".listen_for_error" do

data/spec/spec_helper.rb

@@ -83,6 +83,7 @@ RSpec.configure do |config|
   end
 
   config.before do
+    stop_minutely_probes
     ENV["RAILS_ENV"] ||= "test"
     ENV["RACK_ENV"] ||= "test"
     ENV["PADRINO_ENV"] ||= "test"
@@ -114,6 +115,7 @@ RSpec.configure do |config|
 
   config.after do
     Thread.current[:appsignal_transaction] = nil
+    stop_minutely_probes
   end
 
   config.after :context do
@@ -121,4 +123,15 @@ RSpec.configure do |config|
     Appsignal.config = nil
     Appsignal.logger = nil
   end
+
+  def stop_minutely_probes
+    thread =
+      begin
+        Appsignal::Minutely.class_variable_get(:@@thread) # Fetch old thread
+      rescue NameError
+        nil
+      end
+    Appsignal::Minutely.stop
+    thread && thread.join # Wait for old thread to exit
+  end
 end

data/spec/support/helpers/log_helpers.rb

@@ -1,4 +1,10 @@
 module LogHelpers
+  def capture_logs(&block)
+    log = std_stream
+    use_logger_with(log, &block)
+    log_contents(log)
+  end
+
   def use_logger_with(log)
     Appsignal.logger = test_logger(log)
     yield

data/spec/support/project_fixture/config/appsignal.yml

@@ -8,6 +8,7 @@ default: &defaults
     "REQUEST_METHOD", "REQUEST_URI", "SERVER_NAME", "SERVER_PORT",
     "SERVER_PROTOCOL", "HTTP_USER_AGENT"
   ]
+  enable_minutely_probes: false
 
 production:
   <<: *defaults

data/spec/support/stubs/sidekiq/api.rb

@@ -0,0 +1,4 @@
+class Sidekiq
+  class API
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 2.8.4
+  version: 2.9.0
 platform: ruby
 authors:
 - Robert Beekman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-28 00:00:00.000000000 Z
+date: 2019-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -166,6 +166,7 @@ files:
 - gemfiles/rails-5.0.gemfile
 - gemfiles/rails-5.1.gemfile
 - gemfiles/rails-5.2.gemfile
+- gemfiles/rails-6.0.gemfile
 - gemfiles/resque.gemfile
 - gemfiles/sequel-435.gemfile
 - gemfiles/sequel.gemfile
@@ -195,6 +196,8 @@ files:
 - lib/appsignal/extension.rb
 - lib/appsignal/extension/jruby.rb
 - lib/appsignal/garbage_collection_profiler.rb
+- lib/appsignal/helpers/instrumentation.rb
+- lib/appsignal/helpers/metrics.rb
 - lib/appsignal/hooks.rb
 - lib/appsignal/hooks/action_cable.rb
 - lib/appsignal/hooks/active_support_notifications.rb
@@ -245,6 +248,7 @@ files:
 - lib/appsignal/utils/hash_sanitizer.rb
 - lib/appsignal/utils/json.rb
 - lib/appsignal/utils/query_params_sanitizer.rb
+- lib/appsignal/utils/rails_helper.rb
 - lib/appsignal/version.rb
 - lib/sequel/extensions/appsignal_integration.rb
 - resources/appsignal.yml.erb
@@ -352,6 +356,7 @@ files:
 - spec/support/rails/my_app.rb
 - spec/support/shared_examples/instrument.rb
 - spec/support/stubs/delayed_job.rb
+- spec/support/stubs/sidekiq/api.rb
 - support/bundler_wrapper
 - support/install_deps
 homepage: https://github.com/appsignal/appsignal-ruby
@@ -482,3 +487,4 @@ test_files:
 - spec/support/rails/my_app.rb
 - spec/support/shared_examples/instrument.rb
 - spec/support/stubs/delayed_job.rb
+- spec/support/stubs/sidekiq/api.rb