appsignal 2.9.2.alpha.1 → 2.9.18.beta.1

data/spec/lib/appsignal/transaction_spec.rb

@@ -630,7 +630,11 @@ describe Appsignal::Transaction do
 
     describe "#set_error" do
       let(:env) { http_request_env_with_data }
-      let(:error) { double(:error, :message => "test message", :backtrace => ["line 1"]) }
+      let(:error) do
+        e = ExampleStandardError.new("test message")
+        allow(e).to receive(:backtrace).and_return(["line 1"])
+        e
+      end
 
       it "should also respond to add_exception for backwords compatibility" do
         expect(transaction).to respond_to(:add_exception)
@@ -643,10 +647,24 @@ describe Appsignal::Transaction do
         transaction.set_error(error)
       end
 
+      context "when error is not an error" do
+        let(:error) { Object.new }
+
+        it "does not add the error" do
+          expect(Appsignal.logger).to receive(:error).with(
+            "Appsignal::Transaction#set_error: Cannot set error. " \
+            "The given value is not an exception: #{error.inspect}"
+          )
+          expect(transaction.ext).to_not receive(:set_error)
+
+          transaction.set_error(error)
+        end
+      end
+
       context "for a http request" do
         it "should set an error in the extension" do
           expect(transaction.ext).to receive(:set_error).with(
-            "RSpec::Mocks::Double",
+            "ExampleStandardError",
             "test message",
             Appsignal::Utils::Data.generate(["line 1"])
           )
@@ -656,7 +674,12 @@ describe Appsignal::Transaction do
       end
 
       context "when error message is nil" do
-        let(:error) { double(:error, :message => nil, :backtrace => ["line 1"]) }
+        let(:error) do
+          e = ExampleStandardError.new
+          allow(e).to receive(:message).and_return(nil)
+          allow(e).to receive(:backtrace).and_return(["line 1"])
+          e
+        end
 
         it "should not raise an error" do
           expect { transaction.set_error(error) }.to_not raise_error
@@ -664,7 +687,7 @@ describe Appsignal::Transaction do
 
         it "should set an error in the extension" do
           expect(transaction.ext).to receive(:set_error).with(
-            "RSpec::Mocks::Double",
+            "ExampleStandardError",
             "",
             Appsignal::Utils::Data.generate(["line 1"])
           )

data/spec/lib/appsignal_spec.rb

@@ -94,12 +94,6 @@ describe Appsignal do
             Appsignal.start
           end
         end
-
-        it "should add the gc probe to minutely" do
-          expect(Appsignal::Minutely).to receive(:register_garbage_collection_probe)
-            .and_call_original
-          Appsignal.start
-        end
       end
 
       context "when allocation tracking and gc instrumentation have been disabled" do
@@ -246,6 +240,16 @@ describe Appsignal do
 
   context "not active" do
     describe ".monitor_transaction" do
+      let(:log_stream) { StringIO.new }
+      let(:log) { log_contents(log_stream) }
+      before do
+        Appsignal.config = project_fixture_config("not_active")
+        Appsignal.start
+        Appsignal.start_logger
+        Appsignal.logger = test_logger(log_stream)
+      end
+      after { Appsignal.logger = nil }
+
       it "should do nothing but still yield the block" do
         expect(Appsignal::Transaction).to_not receive(:create)
         expect(Appsignal).to_not receive(:instrument)
@@ -258,6 +262,23 @@ describe Appsignal do
           end).to eq 1
         end.to_not raise_error
       end
+
+      context "with an unknown event type" do
+        it "yields the given block" do
+          expect do |blk|
+            Appsignal.monitor_transaction("unknown.sidekiq", &blk)
+          end.to yield_control
+        end
+
+        it "logs an error" do
+          Appsignal.monitor_transaction("unknown.sidekiq") {}
+          expect(log).to contains_log(
+            :error,
+            "Unrecognized name 'unknown.sidekiq': names must start with either 'perform_job' " \
+              "(for jobs and tasks) or 'process_action' (for HTTP requests)"
+          )
+        end
+      end
     end
 
     describe ".listen_for_error" do
@@ -305,10 +326,15 @@ describe Appsignal do
   end
 
   context "with config and started" do
+    let(:log_stream) { StringIO.new }
+    let(:log) { log_contents(log_stream) }
     before do
       Appsignal.config = project_fixture_config
       Appsignal.start
+      Appsignal.start_logger
+      Appsignal.logger = test_logger(log_stream)
     end
+    after { Appsignal.logger = nil }
 
     describe ".monitor_transaction" do
       context "with a successful call" do
@@ -365,6 +391,23 @@ describe Appsignal do
           end.to raise_error(error)
         end
       end
+
+      context "with an unknown event type" do
+        it "yields the given block" do
+          expect do |blk|
+            Appsignal.monitor_transaction("unknown.sidekiq", &blk)
+          end.to yield_control
+        end
+
+        it "logs an error" do
+          Appsignal.monitor_transaction("unknown.sidekiq") {}
+          expect(log).to contains_log(
+            :error,
+            "Unrecognized name 'unknown.sidekiq': names must start with either 'perform_job' " \
+              "(for jobs and tasks) or 'process_action' (for HTTP requests)"
+          )
+        end
+      end
     end
 
     describe ".monitor_single_transaction" do
@@ -614,8 +657,10 @@ describe Appsignal do
         let(:error) { double }
 
         it "logs an error message" do
-          expect(Appsignal.logger).to receive(:error)
-            .with("Can't send error, given value is not an exception")
+          expect(Appsignal.logger).to receive(:error).with(
+            "Appsignal.send_error: Cannot send error. " \
+              "The given value is not an exception: #{error.inspect}"
+          )
         end
 
         it "does not send the error" do
@@ -735,13 +780,19 @@ describe Appsignal do
           Appsignal.set_error(error)
         end
 
-        context "when the error is nil" do
-          it "does nothing" do
+        context "when the error is not an Exception" do
+          let(:error) { Object.new }
+
+          it "logs an error" do
+            expect(Appsignal.logger).to receive(:error).with(
+              "Appsignal.set_error: Cannot set error. " \
+                "The given value is not an exception: #{error.inspect}"
+            )
             expect(transaction).to_not receive(:set_error)
             expect(transaction).to_not receive(:set_tags)
             expect(transaction).to_not receive(:set_namespace)
 
-            Appsignal.set_error(nil)
+            Appsignal.set_error(error)
           end
         end
 

data/spec/lib/puma/appsignal_spec.rb

@@ -0,0 +1,91 @@
+RSpec.describe "Puma plugin" do
+  include WaitForHelper
+
+  class MockPumaLauncher
+    def events
+      return @events if defined?(@events)
+
+      @events = MockPumaEvents.new
+    end
+  end
+
+  class MockPumaEvents
+    def on_booted(&block)
+      @on_booted = block if block_given?
+      @on_booted if defined?(@on_booted)
+    end
+  end
+
+  let(:probe) { MockProbe.new }
+  let(:launcher) { MockPumaLauncher.new }
+  before do
+    module Puma
+      def self.stats
+      end
+
+      class Plugin
+        class << self
+          attr_reader :plugin
+
+          def create(&block)
+            @plugin = Class.new(::Puma::Plugin)
+            @plugin.class_eval(&block)
+          end
+        end
+      end
+    end
+
+    Appsignal::Minutely.probes.clear
+    ENV["APPSIGNAL_ENABLE_MINUTELY_PROBES"] = "true"
+    Appsignal.config = project_fixture_config
+    # Speed up test time
+    allow(Appsignal::Minutely).to receive(:initial_wait_time).and_return(0.001)
+    allow(Appsignal::Minutely).to receive(:wait_time).and_return(0.001)
+
+    Appsignal::Minutely.probes.register :my_probe, probe
+    load File.expand_path("../lib/puma/plugin/appsignal.rb", APPSIGNAL_SPEC_DIR)
+  end
+  after do
+    Appsignal.config = nil
+    Object.send :remove_const, :Puma
+    Object.send :remove_const, :APPSIGNAL_PUMA_PLUGIN_LOADED
+  end
+
+  it "registers the PumaProbe" do
+    expect(Appsignal::Minutely.probes[:my_probe]).to eql(probe)
+    expect(Appsignal::Minutely.probes[:puma]).to be_nil
+    plugin = Puma::Plugin.plugin.new
+    expect(launcher.events.on_booted).to be_nil
+
+    plugin.start(launcher)
+    expect(Appsignal::Minutely.probes[:puma]).to be_nil
+    expect(launcher.events.on_booted).to_not be_nil
+
+    launcher.events.on_booted.call
+    expect(Appsignal::Minutely.probes[:puma]).to eql(Appsignal::Hooks::PumaProbe)
+
+    # Minutely probes started and called
+    wait_for("enough probe calls") { probe.calls >= 2 }
+  end
+
+  context "without Puma.stats" do
+    before { Puma.singleton_class.send(:remove_method, :stats) }
+
+    it "does not register the PumaProbe" do
+      expect(Appsignal::Minutely.probes[:my_probe]).to eql(probe)
+      expect(Appsignal::Minutely.probes[:puma]).to be_nil
+      plugin = Puma::Plugin.plugin.new
+      expect(launcher.events.on_booted).to be_nil
+
+      plugin.start(launcher)
+      expect(Appsignal::Minutely.probes[:puma]).to be_nil
+      expect(launcher.events.on_booted).to_not be_nil
+
+      launcher.events.on_booted.call
+      expect(Appsignal::Minutely.probes[:puma]).to be_nil
+
+      # Minutely probes started and called
+      wait_for("enough probe calls") { probe.calls >= 2 }
+    end
+  end
+end

data/spec/support/helpers/config_helpers.rb

@@ -1,7 +1,7 @@
 module ConfigHelpers
   def project_fixture_path
     File.expand_path(
-      File.join(File.dirname(__FILE__), "../project_fixture")
+      File.join(File.dirname(__FILE__), "../fixtures/projects/valid")
     )
   end
 

data/spec/support/helpers/wait_for_helper.rb

@@ -0,0 +1,28 @@
+module WaitForHelper
+  # Wait for a condition to be met
+  #
+  # @example
+  #   # Perform threaded operation
+  #   wait_for("enough probe calls") { probe.calls >= 2 }
+  #   # Assert on result
+  #
+  # @param name [String] The name of the condition to check. Used in the
+  #   error when it fails.
+  # @yield Assertion to check.
+  # @yieldreturn [Boolean] True/False value that indicates if the condition
+  #   is met.
+  # @raise [StandardError] Raises error if the condition is not met after 5
+  #   seconds, 5_000 tries.
+  def wait_for(name)
+    max_wait = 5_000
+    i = 0
+    while i <= max_wait
+      break if yield
+      i += 1
+      sleep 0.001
+    end
+
+    return unless i == max_wait
+    raise "Waited 5 seconds for #{name} condition, but was not met."
+  end
+end

data/spec/support/mocks/mock_probe.rb

@@ -0,0 +1,11 @@
+class MockProbe
+  attr_reader :calls
+
+  def initialize
+    @calls = 0
+  end
+
+  def call
+    @calls += 1
+  end
+end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 2.9.2.alpha.1
+  version: 2.9.18.beta.1
 platform: ruby
 authors:
 - Robert Beekman
 - Thijs Cadier
+- Tom de Bruijn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-28 00:00:00.000000000 Z
+date: 2019-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -45,14 +46,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -115,14 +116,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.20
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.20
 description: The official appsignal.com gem
 email:
 - support@appsignal.com
@@ -132,6 +133,8 @@ extensions:
 - ext/extconf.rb
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/chore.md"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -144,6 +147,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- SUPPORT.md
 - appsignal.gemspec
 - benchmark.rake
 - bin/appsignal
@@ -159,6 +163,7 @@ files:
 - gemfiles/no_dependencies.gemfile
 - gemfiles/padrino.gemfile
 - gemfiles/que.gemfile
+- gemfiles/que_beta.gemfile
 - gemfiles/rails-3.2.gemfile
 - gemfiles/rails-4.0.gemfile
 - gemfiles/rails-4.1.gemfile
@@ -250,6 +255,7 @@ files:
 - lib/appsignal/utils/query_params_sanitizer.rb
 - lib/appsignal/utils/rails_helper.rb
 - lib/appsignal/version.rb
+- lib/puma/plugin/appsignal.rb
 - lib/sequel/extensions/appsignal_integration.rb
 - resources/appsignal.yml.erb
 - resources/cacert.pem
@@ -323,13 +329,15 @@ files:
 - spec/lib/appsignal/utils/json_spec.rb
 - spec/lib/appsignal/utils/query_params_sanitizer_spec.rb
 - spec/lib/appsignal_spec.rb
+- spec/lib/puma/appsignal_spec.rb
 - spec/spec_helper.rb
-- spec/support/fixtures/containers/cgroups/docker
-- spec/support/fixtures/containers/cgroups/docker_systemd
-- spec/support/fixtures/containers/cgroups/lxc
-- spec/support/fixtures/containers/cgroups/no_permission
-- spec/support/fixtures/containers/cgroups/none
 - spec/support/fixtures/generated_config.yml
+- spec/support/fixtures/projects/valid/config/application.rb
+- spec/support/fixtures/projects/valid/config/appsignal.yml
+- spec/support/fixtures/projects/valid/config/environments/development.rb
+- spec/support/fixtures/projects/valid/config/environments/production.rb
+- spec/support/fixtures/projects/valid/config/environments/test.rb
+- spec/support/fixtures/projects/valid/log/.gitkeep
 - spec/support/fixtures/uploaded_file.txt
 - spec/support/helpers/api_request_helper.rb
 - spec/support/helpers/cli_helpers.rb
@@ -344,15 +352,11 @@ files:
 - spec/support/helpers/system_helpers.rb
 - spec/support/helpers/time_helpers.rb
 - spec/support/helpers/transaction_helpers.rb
+- spec/support/helpers/wait_for_helper.rb
 - spec/support/matchers/contains_log.rb
 - spec/support/mocks/fake_gc_profiler.rb
 - spec/support/mocks/mock_extension.rb
-- spec/support/project_fixture/config/application.rb
-- spec/support/project_fixture/config/appsignal.yml
-- spec/support/project_fixture/config/environments/development.rb
-- spec/support/project_fixture/config/environments/production.rb
-- spec/support/project_fixture/config/environments/test.rb
-- spec/support/project_fixture/log/.gitkeep
+- spec/support/mocks/mock_probe.rb
 - spec/support/rails/my_app.rb
 - spec/support/shared_examples/instrument.rb
 - spec/support/stubs/delayed_job.rb
@@ -362,7 +366,12 @@ files:
 homepage: https://github.com/appsignal/appsignal-ruby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/appsignal/appsignal-ruby/issues
+  changelog_uri: https://github.com/appsignal/appsignal-ruby/blob/master/CHANGELOG.md
+  documentation_uri: https://docs.appsignal.com/ruby/
+  homepage_uri: https://docs.appsignal.com/ruby/
+  source_code_uri: https://github.com/appsignal/appsignal-ruby
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -379,7 +388,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Logs performance and exception data from your app to appsignal.com
@@ -454,13 +463,15 @@ test_files:
 - spec/lib/appsignal/utils/json_spec.rb
 - spec/lib/appsignal/utils/query_params_sanitizer_spec.rb
 - spec/lib/appsignal_spec.rb
+- spec/lib/puma/appsignal_spec.rb
 - spec/spec_helper.rb
-- spec/support/fixtures/containers/cgroups/docker
-- spec/support/fixtures/containers/cgroups/docker_systemd
-- spec/support/fixtures/containers/cgroups/lxc
-- spec/support/fixtures/containers/cgroups/no_permission
-- spec/support/fixtures/containers/cgroups/none
 - spec/support/fixtures/generated_config.yml
+- spec/support/fixtures/projects/valid/config/application.rb
+- spec/support/fixtures/projects/valid/config/appsignal.yml
+- spec/support/fixtures/projects/valid/config/environments/development.rb
+- spec/support/fixtures/projects/valid/config/environments/production.rb
+- spec/support/fixtures/projects/valid/config/environments/test.rb
+- spec/support/fixtures/projects/valid/log/.gitkeep
 - spec/support/fixtures/uploaded_file.txt
 - spec/support/helpers/api_request_helper.rb
 - spec/support/helpers/cli_helpers.rb
@@ -475,15 +486,11 @@ test_files:
 - spec/support/helpers/system_helpers.rb
 - spec/support/helpers/time_helpers.rb
 - spec/support/helpers/transaction_helpers.rb
+- spec/support/helpers/wait_for_helper.rb
 - spec/support/matchers/contains_log.rb
 - spec/support/mocks/fake_gc_profiler.rb
 - spec/support/mocks/mock_extension.rb
-- spec/support/project_fixture/config/application.rb
-- spec/support/project_fixture/config/appsignal.yml
-- spec/support/project_fixture/config/environments/development.rb
-- spec/support/project_fixture/config/environments/production.rb
-- spec/support/project_fixture/config/environments/test.rb
-- spec/support/project_fixture/log/.gitkeep
+- spec/support/mocks/mock_probe.rb
 - spec/support/rails/my_app.rb
 - spec/support/shared_examples/instrument.rb
 - spec/support/stubs/delayed_job.rb