appsignal 2.11.0.beta.4 → 2.11.0.beta.5

data/lib/appsignal/probes.rb

@@ -0,0 +1,7 @@
+module Appsignal
+  module Probes
+  end
+end
+
+require "appsignal/probes/puma"
+require "appsignal/probes/sidekiq"

data/lib/appsignal/probes/puma.rb

@@ -1,11 +1,11 @@
 module Appsignal
   module Probes
-    # @api private
     class PumaProbe
       def initialize
         @hostname = Appsignal.config[:hostname] || Socket.gethostname
       end
 
+      # @api private
       def call
         puma_stats = fetch_puma_stats
         return unless puma_stats

data/lib/appsignal/probes/sidekiq.rb

@@ -1,9 +1,10 @@
 module Appsignal
   module Probes
-    # @api private
     class SidekiqProbe
+      # @api private
       attr_reader :config
 
+      # @api private
       def self.dependencies_present?
         Gem::Version.new(::Redis::VERSION) >= Gem::Version.new("3.3.5")
       end
@@ -16,6 +17,7 @@ module Appsignal
         require "sidekiq/api"
       end
 
+      # @api private
       def call
         track_redis_info
         track_stats

data/lib/appsignal/utils/deprecation_message.rb

@@ -2,7 +2,7 @@ module Appsignal
   module Utils
     module DeprecationMessage
       def self.message(message, logger = Appsignal.logger)
-        $stderr.puts "appsignal WARNING: #{message}"
+        Kernel.warn "appsignal WARNING: #{message}"
         logger.warn message
       end
 

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appsignal
-  VERSION = "2.11.0.beta.4".freeze
+  VERSION = "2.11.0.beta.5".freeze
 end

data/spec/lib/appsignal/auth_check_spec.rb

@@ -28,6 +28,29 @@ describe Appsignal::AuthCheck do
     end.join("&")
   end
 
+  describe ".new" do
+    describe "with logger argument" do
+      let(:err_stream) { std_stream }
+      let(:stderr) { err_stream.read }
+      let(:log_stream) { std_stream }
+      let(:log) { log_contents(log_stream) }
+
+      it "logs and prints a deprecation message" do
+        Appsignal.logger = test_logger(log_stream)
+
+        capture_std_streams(std_stream, err_stream) do
+          Appsignal::AuthCheck.new(config, Appsignal.logger)
+        end
+
+        deprecation_message =
+          "`Appsignal::AuthCheck.new`'s `logger` argument " \
+          "will be removed in the next major version."
+        expect(stderr).to include "appsignal WARNING: #{deprecation_message}"
+        expect(log).to contains_log :warn, deprecation_message
+      end
+    end
+  end
+
   describe "#perform" do
     subject { auth_check.perform }
 

data/spec/lib/appsignal/capistrano2_spec.rb

@@ -10,7 +10,7 @@ if DependencyHelper.capistrano2_present?
     let(:capistrano_config) do
       Capistrano::Configuration.new.tap do |c|
         c.set(:rails_env, "production")
-        c.set(:repository, "master")
+        c.set(:repository, "main")
         c.set(:deploy_to, "/home/username/app")
         c.set(:current_release, "")
         c.set(:current_revision, "503ce0923ed177a3ce000005")

data/spec/lib/appsignal/capistrano3_spec.rb

@@ -15,7 +15,7 @@ if DependencyHelper.capistrano3_present?
         c.set(:log_level, :error)
         c.set(:logger, logger)
         c.set(:rails_env, "production")
-        c.set(:repository, "master")
+        c.set(:repository, "main")
         c.set(:deploy_to, "/home/username/app")
         c.set(:current_release, "")
         c.set(:current_revision, "503ce0923ed177a3ce000005")

data/spec/lib/appsignal/cli/diagnose_spec.rb

@@ -290,6 +290,8 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
         jruby = Appsignal::System.jruby?
         expect(output).to include(
           "Extension installation report",
+          "Installation result",
+          "  Status: success",
           "Language details",
           "  Implementation: #{jruby ? "jruby" : "ruby"}",
           "  Ruby version: #{"#{rbconfig["ruby_version"]}-p#{rbconfig["PATCHLEVEL"]}"}",
@@ -310,6 +312,46 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
         )
       end
 
+      context "with error in install report" do
+        let(:error) { RuntimeError.new("some error") }
+        before do
+          allow(File).to receive(:read).and_call_original
+          expect(File).to receive(:read)
+            .with(File.expand_path("../../../../../ext/install.report", __FILE__))
+            .and_return(
+              YAML.dump(
+                "result" => {
+                  "status" => "error",
+                  "error" => "RuntimeError: some error",
+                  "backtrace" => error.backtrace
+                }
+              )
+            )
+        end
+
+        it "sends an error" do
+          run
+          expect(received_report["installation"]).to match(
+            "result" => {
+              "status" => "error",
+              "error" => "RuntimeError: some error",
+              "backtrace" => error.backtrace
+            }
+          )
+        end
+
+        it "prints the error" do
+          run
+
+          expect(output).to include(
+            "Extension installation report",
+            "Installation result",
+            "Status: error\n    Error: RuntimeError: some error"
+          )
+          expect(output).to_not include("Raw report:")
+        end
+      end
+
       context "without install report" do
         let(:error) { RuntimeError.new("foo") }
         before do

data/spec/lib/appsignal/config_spec.rb

@@ -244,6 +244,27 @@ describe Appsignal::Config do
       end
     end
 
+    context "with an overriden config file" do
+      let(:config) do
+        project_fixture_config("production", {}, Appsignal.logger, File.join(project_fixture_path, "config", "appsignal.yml"))
+      end
+
+      it "is valid and active" do
+        expect(config.valid?).to be_truthy
+        expect(config.active?).to be_truthy
+      end
+
+      context "with an invalid overriden config file" do
+        let(:config) do
+          project_fixture_config("production", {}, Appsignal.logger, File.join(project_fixture_path, "config", "missing.yml"))
+        end
+
+        it "is not valid" do
+          expect(config.valid?).to be_falsy
+        end
+      end
+    end
+
     context "with the config file causing an error" do
       let(:config_path) do
         File.expand_path(

data/spec/lib/appsignal/extension/jruby_spec.rb

@@ -1,42 +1,45 @@
-if Appsignal::System.jruby?
-  describe Appsignal::Extension::Jruby do
-    let(:extension) { Appsignal::Extension }
+describe "JRuby extension", :jruby do
+  let(:extension) { Appsignal::Extension }
+  let(:jruby_module) { Appsignal::Extension::Jruby }
 
-    describe "string conversions" do
-      it "keeps the same value during string type conversions" do
-        # UTF-8 string with NULL
-        # Tests if the conversions between the conversions without breaking on
-        # NULL terminated strings in C.
-        string = "Merry Christmas! \u0000 🎄"
+  it "creates a JRuby extension module" do
+    expect(Appsignal::Extension::Jruby).to be_kind_of(Module)
+  end
 
-        appsignal_string = extension.make_appsignal_string(string)
-        ruby_string = extension.make_ruby_string(appsignal_string)
+  describe "string conversions" do
+    it "keeps the same value during string type conversions" do
+      # UTF-8 string with NULL
+      # Tests if the conversions between the conversions without breaking on
+      # NULL terminated strings in C.
+      string = "Merry Christmas! \u0000 🎄"
 
-        expect(ruby_string).to eq("Merry Christmas! \u0000 🎄")
-      end
-    end
+      appsignal_string = extension.make_appsignal_string(string)
+      ruby_string = extension.make_ruby_string(appsignal_string)
 
-    it "loads libappsignal with FFI" do
-      expect(described_class.ffi_libraries.map(&:name).first).to include "libappsignal"
+      expect(ruby_string).to eq("Merry Christmas! \u0000 🎄")
     end
+  end
 
-    describe ".lib_extension" do
-      subject { described_class.lib_extension }
+  it "loads libappsignal with FFI" do
+    expect(jruby_module.ffi_libraries.map(&:name).first).to include "libappsignal"
+  end
+
+  describe ".lib_extension" do
+    subject { jruby_module.lib_extension }
 
-      context "when on a darwin system" do
-        before { expect(Appsignal::System).to receive(:agent_platform).and_return("darwin") }
+    context "when on a darwin system" do
+      before { expect(Appsignal::System).to receive(:agent_platform).and_return("darwin") }
 
-        it "returns the extension for darwin" do
-          is_expected.to eq "dylib"
-        end
+      it "returns the extension for darwin" do
+        is_expected.to eq "dylib"
       end
+    end
 
-      context "when on a linux system" do
-        before { expect(Appsignal::System).to receive(:agent_platform).and_return("linux") }
+    context "when on a linux system" do
+      before { expect(Appsignal::System).to receive(:agent_platform).and_return("linux") }
 
-        it "returns the lib extension for linux" do
-          is_expected.to eq "so"
-        end
+      it "returns the lib extension for linux" do
+        is_expected.to eq "so"
       end
     end
   end

data/spec/lib/appsignal/extension_install_failure_spec.rb

@@ -0,0 +1,23 @@
+describe Appsignal::Extension, :extension_installation_failure do
+  context "when the extension library cannot be loaded" do
+    # This test breaks the installation on purpose and is not run by default.
+    # See `rake test:failure`. If this test was run, run `rake
+    # extension:install` again to fix the extension installation.
+    it "prints and logs an error" do
+      # ENV var to make sure installation fails on purpurse
+      ENV["_TEST_APPSIGNAL_EXTENSION_FAILURE"] = "true"
+      `rake extension:install` # Run installation
+
+      require "open3"
+      _stdout, stderr, _status = Open3.capture3("bin/appsignal --version")
+      expect(stderr).to include("ERROR: AppSignal failed to load extension")
+      error_message =
+        if DependencyHelper.running_jruby?
+          "cannot open shared object file"
+        else
+          "LoadError: cannot load such file"
+        end
+      expect(stderr).to include(error_message)
+    end
+  end
+end

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

@@ -154,9 +154,11 @@ if DependencyHelper.active_job_present?
         end
 
         it "reports the priority as tag on the transaction" do
-          tags = { :priority => 10, :queue => queue }
+          tags = { :queue => queue }
           expect(Appsignal).to receive(:increment_counter)
             .with("active_job_queue_job_count", 1, tags.merge(:status => :processed))
+          expect(Appsignal).to receive(:increment_counter)
+            .with("active_job_queue_priority_job_count", 1, tags.merge(:priority => 10, :status => :processed))
 
           perform_job(ActiveJobPriorityTestJob)
 
@@ -208,6 +210,47 @@ if DependencyHelper.active_job_present?
           .map { |event| event["name"] }
         expect(events).to eq(["perform_start.active_job", "perform.active_job"])
       end
+
+      if DependencyHelper.rails_version >= Gem::Version.new("5.0.0")
+        context "with priority" do
+          before do
+            class ActiveJobErrorPriorityTestJob < ActiveJob::Base
+              queue_with_priority 10
+
+              def perform(*_args)
+                raise "uh oh"
+              end
+            end
+          end
+          after do
+            Object.send(:remove_const, :ActiveJobErrorPriorityTestJob)
+          end
+
+          it "reports the priority as tag on the transaction" do
+            tags = { :queue => queue }
+            expect(Appsignal).to receive(:increment_counter)
+              .with("active_job_queue_job_count", 1, tags.merge(:status => :processed))
+            expect(Appsignal).to receive(:increment_counter)
+              .with("active_job_queue_job_count", 1, tags.merge(:status => :failed))
+            expect(Appsignal).to receive(:increment_counter)
+              .with("active_job_queue_priority_job_count", 1, tags.merge(:priority => 10, :status => :processed))
+            expect(Appsignal).to receive(:increment_counter)
+              .with("active_job_queue_priority_job_count", 1, tags.merge(:priority => 10, :status => :failed))
+
+            expect do
+              perform_job(ActiveJobErrorPriorityTestJob)
+            end.to raise_error(RuntimeError, "uh oh")
+
+            transaction = last_transaction
+            transaction_hash = transaction.to_h
+            expect(transaction_hash).to include(
+              "sample_data" => hash_including(
+                "tags" => hash_including("queue" => queue, "priority" => 10)
+              )
+            )
+          end
+        end
+      end
     end
 
     context "when wrapped in another transaction" do

data/spec/lib/appsignal/hooks_spec.rb

@@ -78,6 +78,63 @@ describe Appsignal::Hooks do
     expect(Appsignal::Hooks.hooks[:mock_error_hook].installed?).to be_falsy
     Appsignal::Hooks.hooks.delete(:mock_error_hook)
   end
+
+  describe "missing constants" do
+    let(:err_stream) { std_stream }
+    let(:stderr) { err_stream.read }
+    let(:log_stream) { std_stream }
+    let(:log) { log_contents(log_stream) }
+    before do
+      Appsignal.logger = test_logger(log_stream)
+    end
+
+    def call_constant(&block)
+      capture_std_streams(std_stream, err_stream, &block)
+    end
+
+    describe "SidekiqProbe" do
+      it "logs a deprecation message and returns the new constant" do
+        constant = call_constant { Appsignal::Hooks::SidekiqProbe }
+
+        expect(constant).to eql(Appsignal::Probes::SidekiqProbe)
+        expect(constant.name).to eql("Appsignal::Probes::SidekiqProbe")
+
+        deprecation_message =
+          "The constant Appsignal::Hooks::SidekiqProbe has been deprecated. " \
+          "Please update the constant name to Appsignal::Probes::SidekiqProbe " \
+          "in the following file to remove this message.\n#{__FILE__}:"
+        expect(stderr).to include "appsignal WARNING: #{deprecation_message}"
+        expect(log).to contains_log :warn, deprecation_message
+      end
+    end
+
+    describe "PumaProbe" do
+      it "logs a deprecation message and returns the new constant" do
+        constant = call_constant { Appsignal::Hooks::PumaProbe }
+
+        expect(constant).to eql(Appsignal::Probes::PumaProbe)
+        expect(constant.name).to eql("Appsignal::Probes::PumaProbe")
+
+        deprecation_message =
+          "The constant Appsignal::Hooks::PumaProbe has been deprecated. " \
+          "Please update the constant name to Appsignal::Probes::PumaProbe " \
+          "in the following file to remove this message.\n#{__FILE__}:"
+        expect(stderr).to include "appsignal WARNING: #{deprecation_message}"
+        expect(log).to contains_log :warn, deprecation_message
+      end
+    end
+
+    describe "other constant" do
+      it "raises a NameError like Ruby normally does" do
+        expect do
+          call_constant { Appsignal::Hooks::Unknown }
+        end.to raise_error(NameError)
+
+        expect(stderr).to be_empty
+        expect(log).to be_empty
+      end
+    end
+  end
 end
 
 describe Appsignal::Hooks::Helpers do

data/spec/lib/appsignal/marker_spec.rb

@@ -4,7 +4,7 @@ describe Appsignal::Marker do
     described_class.new(
       {
         :revision => "503ce0923ed177a3ce000005",
-        :repository => "master",
+        :repository => "main",
         :user => "batman",
         :rails_env => "production"
       },

data/spec/spec_helper.rb

@@ -65,6 +65,10 @@ RSpec.configure do |config|
 
   config.example_status_persistence_file_path = "spec/examples.txt"
   config.fail_if_no_examples = true
+  config.filter_run_excluding(
+    :extension_installation_failure => true,
+    :jruby => !DependencyHelper.running_jruby?
+  )
   config.mock_with :rspec do |mocks|
     mocks.syntax = :expect
   end
@@ -111,6 +115,7 @@ RSpec.configure do |config|
     # in the diagnose task, so add it manually to the list of to-be cleaned up
     # keys.
     env_keys << "_APPSIGNAL_DIAGNOSE"
+    env_keys << "_TEST_APPSIGNAL_EXTENSION_FAILURE"
     env_keys.each do |key|
       # First set the ENV var to an empty string and then delete the key from
       # the env. We set the env var to an empty string first as JRuby doesn't