appsignal 3.4.4 → 3.7.0

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

@@ -1,5 +1,7 @@
 describe Appsignal::Utils::HashSanitizer do
   let(:file) { uploaded_file }
+  let(:some_array) { [1, 2, 3] }
+  let(:some_hash) { { :a => 1, :b => 2 } }
   let(:params) do
     {
       :text => "string",
@@ -8,6 +10,10 @@ describe Appsignal::Utils::HashSanitizer do
       :float => 0.0,
       :bool_true => true,
       :bool_false => false,
+      # Non-recursive appearances of the same array instance
+      :some_arrays => [some_array, some_array],
+      # Non-recursive appearances of the same hash instance
+      :some_hashes => { :a => some_hash, :b => some_hash },
       :nil => nil,
       :int => 1, # Fixnum
       :int64 => 1 << 64, # Bignum
@@ -20,9 +26,20 @@ describe Appsignal::Utils::HashSanitizer do
           {
             :key => "value",
             :file => file
-          }
-        ]
-      }
+          }.tap do |hsh|
+            # Recursive hash-in-hash (should be [:nested_array][3][:recursive_hash])
+            hsh[:recursive_hash] = hsh
+          end
+        ].tap do |ary|
+          # Recursive array-in-array (should be [:nested_array][4])
+          ary << ary
+          # Recursive array-in-hash (should be [:nested_array][3][:recursive_array])
+          ary[3][:recursive_array] = ary
+        end
+      }.tap do |hsh|
+        # Recursive hash-in-array (should be [:nested_array][5])
+        hsh[:nested_array] << hsh
+      end
     }
   end
 
@@ -43,6 +60,9 @@ describe Appsignal::Utils::HashSanitizer do
       expect(subject[:nil]).to be_nil
       expect(subject[:int]).to eq(1)
       expect(subject[:int64]).to eq(1 << 64)
+      expect(subject[:some_arrays]).to eq([[1, 2, 3], [1, 2, 3]])
+      expect(subject[:some_hashes]).to eq({ :a => { :a => 1, :b => 2 },
+:b => { :a => 1, :b => 2 } })
     end
 
     it "does not change the original params" do
@@ -72,7 +92,7 @@ describe Appsignal::Utils::HashSanitizer do
           expect(subject[2]).to include "::UploadedFile"
         end
 
-        describe ":nested_hash key" do
+        describe "nested hash" do
           subject { sanitized_params[:hash][:nested_array][3] }
 
           it "returns a sanitized Hash" do
@@ -82,6 +102,24 @@ describe Appsignal::Utils::HashSanitizer do
             expect(subject[:file]).to be_instance_of String
             expect(subject[:file]).to include "::UploadedFile"
           end
+
+          it "replaces a recursive array" do
+            expect(subject[:recursive_array]).to eq("[RECURSIVE VALUE]")
+          end
+
+          it "replaces a recursive hash" do
+            expect(subject[:recursive_hash]).to eq("[RECURSIVE VALUE]")
+          end
+        end
+
+        describe "nested array" do
+          it "replaces a recursive array" do
+            expect(sanitized_params[:hash][:nested_array][4]).to eq("[RECURSIVE VALUE]")
+          end
+
+          it "replaces a recursive hash" do
+            expect(sanitized_params[:hash][:nested_array][5]).to eq("[RECURSIVE VALUE]")
+          end
         end
       end
     end

data/spec/lib/appsignal_spec.rb

@@ -12,7 +12,7 @@ describe Appsignal do
   describe ".config=" do
     it "should set the config" do
       config = project_fixture_config
-      expect(Appsignal.logger).to_not receive(:level=)
+      expect(Appsignal.internal_logger).to_not receive(:level=)
 
       Appsignal.config = config
       expect(Appsignal.config).to eq config
@@ -22,9 +22,9 @@ describe Appsignal do
   describe ".start" do
     context "with no config set beforehand" do
       it "should do nothing when config is not set and there is no valid config in the env" do
-        expect(Appsignal.logger).to receive(:error)
+        expect(Appsignal.internal_logger).to receive(:error)
           .with("Push API key not set after loading config").once
-        expect(Appsignal.logger).to receive(:error)
+        expect(Appsignal.internal_logger).to receive(:error)
           .with("Not starting, no valid config for this environment").once
         expect(Appsignal::Extension).to_not receive(:start)
         Appsignal.start
@@ -33,7 +33,7 @@ describe Appsignal do
       it "should create a config from the env" do
         ENV["APPSIGNAL_PUSH_API_KEY"] = "something"
         expect(Appsignal::Extension).to receive(:start)
-        expect(Appsignal.logger).not_to receive(:error)
+        expect(Appsignal.internal_logger).not_to receive(:error)
         silence { Appsignal.start }
         expect(Appsignal.config[:push_api_key]).to eq("something")
       end
@@ -44,7 +44,7 @@ describe Appsignal do
 
       it "should initialize logging" do
         Appsignal.start
-        expect(Appsignal.logger.level).to eq Logger::INFO
+        expect(Appsignal.internal_logger.level).to eq Logger::INFO
       end
 
       it "should start native" do
@@ -122,7 +122,7 @@ describe Appsignal do
 
       it "should change the log level" do
         Appsignal.start
-        expect(Appsignal.logger.level).to eq Logger::DEBUG
+        expect(Appsignal.internal_logger.level).to eq Logger::DEBUG
       end
     end
   end
@@ -152,7 +152,7 @@ describe Appsignal do
 
   describe ".stop" do
     it "should call stop on the extension" do
-      expect(Appsignal.logger).to receive(:debug).with("Stopping appsignal")
+      expect(Appsignal.internal_logger).to receive(:debug).with("Stopping appsignal")
       expect(Appsignal::Extension).to receive(:stop)
       Appsignal.stop
       expect(Appsignal.active?).to be_falsy
@@ -160,7 +160,7 @@ describe Appsignal do
 
     context "with context specified" do
       it "should log the context" do
-        expect(Appsignal.logger).to receive(:debug).with("Stopping appsignal (something)")
+        expect(Appsignal.internal_logger).to receive(:debug).with("Stopping appsignal (something)")
         expect(Appsignal::Extension).to receive(:stop)
         Appsignal.stop("something")
         expect(Appsignal.active?).to be_falsy
@@ -222,9 +222,9 @@ describe Appsignal do
         Appsignal.config = project_fixture_config("not_active")
         Appsignal.start
         Appsignal.start_logger
-        Appsignal.logger = test_logger(log_stream)
+        Appsignal.internal_logger = test_logger(log_stream)
       end
-      after { Appsignal.logger = nil }
+      after { Appsignal.internal_logger = nil }
 
       it "should do nothing but still yield the block" do
         expect(Appsignal::Transaction).to_not receive(:create)
@@ -258,7 +258,7 @@ describe Appsignal do
     end
 
     describe ".listen_for_error" do
-      it "does not record anyhing" do
+      it "does not record anything" do
         error = RuntimeError.new("specific error")
         expect do
           Appsignal.listen_for_error do
@@ -308,9 +308,9 @@ describe Appsignal do
       Appsignal.config = project_fixture_config
       Appsignal.start
       Appsignal.start_logger
-      Appsignal.logger = test_logger(log_stream)
+      Appsignal.internal_logger = test_logger(log_stream)
     end
-    after { Appsignal.logger = nil }
+    after { Appsignal.internal_logger = nil }
 
     describe ".monitor_transaction" do
       context "with a successful call" do
@@ -545,7 +545,8 @@ describe Appsignal do
         it "should not raise an exception when out of range" do
           expect(Appsignal::Extension).to receive(:set_gauge).with("key", 10,
             Appsignal::Extension.data_map_new).and_raise(RangeError)
-          expect(Appsignal.logger).to receive(:warn).with("Gauge value 10 for key 'key' is too big")
+          expect(Appsignal.internal_logger).to receive(:warn)
+            .with("Gauge value 10 for key 'key' is too big")
           expect do
             Appsignal.set_gauge("key", 10)
           end.to_not raise_error
@@ -553,46 +554,46 @@ describe Appsignal do
       end
 
       describe ".set_host_gauge" do
-        it "should call set_host_gauge on the extension with a string key and float" do
-          expect(Appsignal::Extension).to receive(:set_host_gauge).with("key", 0.1)
-          Appsignal.set_host_gauge("key", 0.1)
+        let(:err_stream) { std_stream }
+        let(:stderr) { err_stream.read }
+        let(:log_stream) { StringIO.new }
+        let(:logs) { log_contents(log_stream) }
+        let(:deprecation_message) do
+          "The `set_host_gauge` method has been deprecated. " \
+            "Calling this method has no effect. " \
+            "Please remove method call in the following file to remove " \
+            "this message."
         end
-
-        it "should call set_host_gauge on the extension with a symbol key and int" do
-          expect(Appsignal::Extension).to receive(:set_host_gauge).with("key", 1.0)
-          Appsignal.set_host_gauge(:key, 1)
+        before do
+          Appsignal.internal_logger = test_logger(log_stream)
+          capture_std_streams(std_stream, err_stream) { Appsignal.set_host_gauge("key", 0.1) }
         end
 
-        it "should not raise an exception when out of range" do
-          expect(Appsignal::Extension).to receive(:set_host_gauge).with("key",
-            10).and_raise(RangeError)
-          expect(Appsignal.logger).to receive(:warn)
-            .with("Host gauge value 10 for key 'key' is too big")
-          expect do
-            Appsignal.set_host_gauge("key", 10)
-          end.to_not raise_error
+        it "logs a deprecation warning" do
+          expect(stderr).to include("appsignal WARNING: #{deprecation_message}")
+          expect(logs).to include(deprecation_message)
         end
       end
 
       describe ".set_process_gauge" do
-        it "should call set_process_gauge on the extension with a string key and float" do
-          expect(Appsignal::Extension).to receive(:set_process_gauge).with("key", 0.1)
-          Appsignal.set_process_gauge("key", 0.1)
+        let(:err_stream) { std_stream }
+        let(:stderr) { err_stream.read }
+        let(:log_stream) { StringIO.new }
+        let(:logs) { log_contents(log_stream) }
+        let(:deprecation_message) do
+          "The `set_process_gauge` method has been deprecated. " \
+            "Calling this method has no effect. " \
+            "Please remove method call in the following file to remove " \
+            "this message."
         end
-
-        it "should call set_process_gauge on the extension with a symbol key and int" do
-          expect(Appsignal::Extension).to receive(:set_process_gauge).with("key", 1.0)
-          Appsignal.set_process_gauge(:key, 1)
+        before do
+          Appsignal.internal_logger = test_logger(log_stream)
+          capture_std_streams(std_stream, err_stream) { Appsignal.set_process_gauge("key", 0.1) }
         end
 
-        it "should not raise an exception when out of range" do
-          expect(Appsignal::Extension).to receive(:set_process_gauge).with("key",
-            10).and_raise(RangeError)
-          expect(Appsignal.logger).to receive(:warn)
-            .with("Process gauge value 10 for key 'key' is too big")
-          expect do
-            Appsignal.set_process_gauge("key", 10)
-          end.to_not raise_error
+        it "logs a deprecation warning" do
+          expect(stderr).to include("appsignal WARNING: #{deprecation_message}")
+          expect(logs).to include(deprecation_message)
         end
       end
 
@@ -624,7 +625,7 @@ describe Appsignal do
         it "should not raise an exception when out of range" do
           expect(Appsignal::Extension).to receive(:increment_counter)
             .with("key", 10, Appsignal::Extension.data_map_new).and_raise(RangeError)
-          expect(Appsignal.logger).to receive(:warn)
+          expect(Appsignal.internal_logger).to receive(:warn)
             .with("Counter value 10 for key 'key' is too big")
           expect do
             Appsignal.increment_counter("key", 10)
@@ -654,7 +655,7 @@ describe Appsignal do
         it "should not raise an exception when out of range" do
           expect(Appsignal::Extension).to receive(:add_distribution_value)
             .with("key", 10, Appsignal::Extension.data_map_new).and_raise(RangeError)
-          expect(Appsignal.logger).to receive(:warn)
+          expect(Appsignal.internal_logger).to receive(:warn)
             .with("Distribution value 10 for key 'key' is too big")
           expect do
             Appsignal.add_distribution_value("key", 10)
@@ -663,8 +664,8 @@ describe Appsignal do
       end
     end
 
-    describe ".logger" do
-      subject { Appsignal.logger }
+    describe ".internal_logger" do
+      subject { Appsignal.internal_logger }
 
       it { is_expected.to be_a Logger }
     end
@@ -727,7 +728,7 @@ describe Appsignal do
         let(:error) { double }
 
         it "logs an error message" do
-          expect(Appsignal.logger).to receive(:error).with(
+          expect(Appsignal.internal_logger).to receive(:error).with(
             "Appsignal.send_error: Cannot send error. " \
               "The given value is not an exception: #{error.inspect}"
           )
@@ -915,7 +916,7 @@ describe Appsignal do
           let(:error) { Object.new }
 
           it "logs an error" do
-            expect(Appsignal.logger).to receive(:error).with(
+            expect(Appsignal.internal_logger).to receive(:error).with(
               "Appsignal.set_error: Cannot set error. " \
                 "The given value is not an exception: #{error.inspect}"
             )
@@ -1128,7 +1129,7 @@ describe Appsignal do
         "production",
         :log_path => log_path
       )
-      Appsignal.logger.error("Log in memory")
+      Appsignal.internal_logger.error("Log in memory")
     end
 
     context "when the log path is writable" do
@@ -1139,9 +1140,9 @@ describe Appsignal do
           capture_stdout(out_stream) do
             initialize_config
             Appsignal.start_logger
-            Appsignal.logger.error("Log to file")
+            Appsignal.internal_logger.error("Log to file")
           end
-          expect(Appsignal.logger).to be_a(Appsignal::Utils::IntegrationLogger)
+          expect(Appsignal.internal_logger).to be_a(Appsignal::Utils::IntegrationLogger)
         end
 
         it "logs to file" do
@@ -1163,8 +1164,8 @@ describe Appsignal do
           capture_stdout(out_stream) do
             initialize_config
             Appsignal.start_logger
-            Appsignal.logger.error("Log to not writable log file")
-            expect(Appsignal.logger).to be_a(Appsignal::Utils::IntegrationLogger)
+            Appsignal.internal_logger.error("Log to not writable log file")
+            expect(Appsignal.internal_logger).to be_a(Appsignal::Utils::IntegrationLogger)
           end
         end
 
@@ -1178,8 +1179,9 @@ describe Appsignal do
         end
 
         it "outputs a warning" do
+          puts output
           expect(output).to include \
-            "[WARN] appsignal: Unable to start logger with log path '#{log_file}'.",
+            "[WARN] appsignal: Unable to start internal logger with log path '#{log_file}'.",
             "[WARN] appsignal: Permission denied"
         end
       end
@@ -1193,9 +1195,9 @@ describe Appsignal do
         capture_stdout(out_stream) do
           initialize_config
           Appsignal.start_logger
-          Appsignal.logger.error("Log to not writable log path")
+          Appsignal.internal_logger.error("Log to not writable log path")
         end
-        expect(Appsignal.logger).to be_a(Appsignal::Utils::IntegrationLogger)
+        expect(Appsignal.internal_logger).to be_a(Appsignal::Utils::IntegrationLogger)
       end
       after do
         FileUtils.chmod 0o755, Appsignal::Config.system_tmp_dir
@@ -1222,9 +1224,9 @@ describe Appsignal do
         capture_stdout(out_stream) do
           initialize_config
           Appsignal.start_logger
-          Appsignal.logger.error("Log to stdout")
+          Appsignal.internal_logger.error("Log to stdout")
         end
-        expect(Appsignal.logger).to be_a(Appsignal::Utils::IntegrationLogger)
+        expect(Appsignal.internal_logger).to be_a(Appsignal::Utils::IntegrationLogger)
       end
       around { |example| recognize_as_heroku { example.run } }
 
@@ -1238,7 +1240,7 @@ describe Appsignal do
     end
 
     describe "#logger#level" do
-      subject { Appsignal.logger.level }
+      subject { Appsignal.internal_logger.level }
 
       context "when there is no config" do
         before do

data/spec/lib/puma/appsignal_spec.rb

@@ -204,7 +204,7 @@ RSpec.describe "Puma plugin" do
       }
     end
 
-    it "collects puma stats as guage metrics with the (summed) worker metrics" do
+    it "collects puma stats as gauge metrics with the (summed) worker metrics" do
       run_plugin(stats_data, appsignal_plugin) do
         expect(logs).to_not include([:error, kind_of(String)])
         expect_gauge(:workers, 2, "type" => "count")

data/spec/spec_helper.rb

@@ -12,25 +12,25 @@ require "rspec"
 require "timecop"
 require "webmock/rspec"
 
-Dir[File.join(APPSIGNAL_SPEC_DIR, "support", "helpers", "*.rb")].each do |f|
+Dir[File.join(APPSIGNAL_SPEC_DIR, "support", "helpers", "*.rb")].sort.each do |f|
   require f
 end
-Dir[File.join(DirectoryHelper.support_dir, "mocks", "*.rb")].each do |f|
+Dir[File.join(DirectoryHelper.support_dir, "mocks", "*.rb")].sort.each do |f|
   require f
 end
-Dir[File.join(DirectoryHelper.support_dir, "matchers", "*.rb")].each do |f|
+Dir[File.join(DirectoryHelper.support_dir, "matchers", "*.rb")].sort.each do |f|
   require f
 end
-Dir[File.join(APPSIGNAL_SPEC_DIR, "support/shared_examples", "*.rb")].each do |f|
+Dir[File.join(APPSIGNAL_SPEC_DIR, "support/shared_examples", "*.rb")].sort.each do |f|
   require f
 end
 if DependencyHelper.rails_present?
-  Dir[File.join(DirectoryHelper.support_dir, "rails", "*.rb")].each do |f|
+  Dir[File.join(DirectoryHelper.support_dir, "rails", "*.rb")].sort.each do |f|
     require f
   end
 end
 if DependencyHelper.hanami2_present?
-  Dir[File.join(DirectoryHelper.support_dir, "hanami", "*.rb")].each do |f|
+  Dir[File.join(DirectoryHelper.support_dir, "hanami", "*.rb")].sort.each do |f|
     require f
   end
 end
@@ -165,7 +165,7 @@ RSpec.configure do |config|
   config.after :context do
     FileUtils.rm_f(File.join(project_fixture_path, "log/appsignal.log"))
     Appsignal.config = nil
-    Appsignal.logger = nil
+    Appsignal.internal_logger = nil
   end
 
   def stop_minutely_probes

data/spec/support/fixtures/projects/valid/config/appsignal.yml

@@ -5,7 +5,7 @@ default: &defaults
     "HTTP_ACCEPT", "HTTP_ACCEPT_CHARSET", "HTTP_ACCEPT_ENCODING",
     "HTTP_ACCEPT_LANGUAGE", "HTTP_CACHE_CONTROL", "HTTP_CONNECTION",
     "CONTENT_LENGTH", "PATH_INFO", "HTTP_RANGE", "HTTP_REFERER",
-    "REQUEST_METHOD", "REQUEST_URI", "SERVER_NAME", "SERVER_PORT",
+    "REQUEST_METHOD", "REQUEST_PATH", "SERVER_NAME", "SERVER_PORT",
     "SERVER_PROTOCOL", "HTTP_USER_AGENT"
   ]
   enable_minutely_probes: false
@@ -33,7 +33,7 @@ old_config:
     "HTTP_ACCEPT", "HTTP_ACCEPT_CHARSET", "HTTP_ACCEPT_ENCODING",
     "HTTP_ACCEPT_LANGUAGE", "HTTP_CACHE_CONTROL", "HTTP_CONNECTION",
     "CONTENT_LENGTH", "PATH_INFO", "HTTP_RANGE", "HTTP_REFERER",
-    "REQUEST_METHOD", "REQUEST_URI", "SERVER_NAME", "SERVER_PORT",
+    "REQUEST_METHOD", "REQUEST_PATH", "SERVER_NAME", "SERVER_PORT",
     "SERVER_PROTOCOL", "HTTP_USER_AGENT"
   ]
 
@@ -49,7 +49,7 @@ old_config_mixed_with_new_config:
     "HTTP_ACCEPT", "HTTP_ACCEPT_CHARSET", "HTTP_ACCEPT_ENCODING",
     "HTTP_ACCEPT_LANGUAGE", "HTTP_CACHE_CONTROL", "HTTP_CONNECTION",
     "CONTENT_LENGTH", "PATH_INFO", "HTTP_RANGE", "HTTP_REFERER",
-    "REQUEST_METHOD", "REQUEST_URI", "SERVER_NAME", "SERVER_PORT",
+    "REQUEST_METHOD", "REQUEST_PATH", "SERVER_NAME", "SERVER_PORT",
     "SERVER_PROTOCOL", "HTTP_USER_AGENT"
   ]
 

data/spec/support/helpers/config_helpers.rb

@@ -5,8 +5,12 @@ module ConfigHelpers
     )
   end
 
-  def project_fixture_config(env = "production", initial_config = {}, logger = Appsignal.logger, # rubocop:disable Metrics/ParameterLists
-    config_file = nil)
+  def project_fixture_config( # rubocop:disable Metrics/ParameterLists
+    env = "production",
+    initial_config = {},
+    logger = Appsignal.internal_logger,
+    config_file = nil
+  )
     Appsignal::Config.new(
       project_fixture_path,
       env,

data/spec/support/helpers/dependency_helper.rb

@@ -1,4 +1,4 @@
-module DependencyHelper
+module DependencyHelper # rubocop:disable Metrics/ModuleLength
   module_function
 
   def ruby_version
@@ -53,6 +53,14 @@ module DependencyHelper
     dependency_present? "resque"
   end
 
+  def redis_client_present?
+    dependency_present? "redis-client"
+  end
+
+  def hiredis_client_present?
+    dependency_present? "hiredis-client"
+  end
+
   def redis_present?
     dependency_present? "redis"
   end
@@ -115,6 +123,10 @@ module DependencyHelper
     dependency_present? "hanami"
   end
 
+  def dry_monitor_present?
+    dependency_present? "dry-monitor"
+  end
+
   def hanami2_present?
     hanami_present? && Gem.loaded_specs["hanami"].version >= Gem::Version.new("2.0")
   end

data/spec/support/helpers/log_helpers.rb

@@ -6,9 +6,9 @@ module LogHelpers
   end
 
   def use_logger_with(log)
-    Appsignal.logger = test_logger(log)
+    Appsignal.internal_logger = test_logger(log)
     yield
-    Appsignal.logger = nil
+    Appsignal.internal_logger = nil
   end
 
   def test_logger(log)

data/spec/support/helpers/rails_helper.rb

@@ -0,0 +1,28 @@
+module RailsHelper
+  def with_railtie(app)
+    clear_rails_error_reporter! if Rails.respond_to? :error
+    Appsignal::Integrations::Railtie.initialize_appsignal(app)
+    yield
+  ensure
+    clear_rails_error_reporter!
+  end
+
+  def with_rails_error_reporter
+    if Rails.respond_to? :error
+      clear_rails_error_reporter!
+      Appsignal::Integrations::Railtie.initialize_error_reporter
+    end
+    yield
+  ensure
+    clear_rails_error_reporter!
+  end
+
+  def clear_rails_error_reporter!
+    return unless Rails.respond_to? :error
+
+    Rails
+      .error
+      .instance_variable_get(:@subscribers)
+      .reject! { |s| s == Appsignal::Integrations::RailsErrorReporterSubscriber }
+  end
+end

data/spec/support/matchers/have_colorized_text.rb

@@ -12,7 +12,7 @@ RSpec::Matchers.define :have_colorized_text do |color, text|
   attr_reader :expected
 end
 
-COLOR_TAG_MATCHER_REGEX = /\e\[(\d+)m/
+COLOR_TAG_MATCHER_REGEX = /\e\[(\d+)m/.freeze
 RSpec::Matchers.define :have_color_markers do
   match do |actual|
     actual =~ COLOR_TAG_MATCHER_REGEX