appsignal 2.8.0.alpha.1 → 2.8.0

data/spec/lib/appsignal/config_spec.rb

@@ -1,28 +1,39 @@
 describe Appsignal::Config do
   describe "#initialize" do
-    subject { config.env }
-
     describe "environment" do
       context "when environment is nil" do
-        let(:config) { described_class.new("", "") }
+        let(:config) { described_class.new("", nil) }
 
         it "sets an empty string" do
-          expect(subject).to eq("")
+          expect(config.env).to eq("")
         end
       end
 
       context "when environment is given" do
+        let(:env) { "my_env" }
         let(:config) { described_class.new("", "my_env") }
 
         it "sets the environment" do
-          expect(subject).to eq("my_env")
+          expect(config.env).to eq(env)
+        end
+
+        it "sets the environment as loaded through the initial_config" do
+          expect(config.initial_config).to eq(:env => env)
+          expect(config.config_hash).to_not have_key(:env)
         end
 
         context "with APPSIGNAL_APP_ENV environment variable" do
-          before { ENV["APPSIGNAL_APP_ENV"] = "my_env_env" }
+          let(:env_env) { "my_env_env" }
+          before { ENV["APPSIGNAL_APP_ENV"] = env_env }
 
           it "uses the environment variable" do
-            expect(subject).to eq("my_env_env")
+            expect(config.env).to eq(env_env)
+          end
+
+          it "sets the environment as loaded through the env_config" do
+            expect(config.initial_config).to eq(:env => env)
+            expect(config.env_config).to eq(:env => env_env)
+            expect(config.config_hash).to_not have_key(:env)
           end
         end
       end
@@ -41,6 +52,11 @@ describe Appsignal::Config do
         it "becomes active" do
           expect(subject).to be_truthy
         end
+
+        it "sets the push_api_key as loaded through the env_config" do
+          expect(config.env_config).to eq(:push_api_key => "abc")
+          expect(config.system_config).to eq(:active => true)
+        end
       end
 
       context "without APPSIGNAL_PUSH_API_KEY env variable" do
@@ -59,27 +75,36 @@ describe Appsignal::Config do
         it "is set to stdout" do
           expect(subject).to eq("stdout")
         end
+
+        it "sets the log as loaded through the system" do
+          expect(config.system_config).to eq(:log => "stdout")
+        end
       end
 
       context "when not running on Heroku" do
         it "is set to file" do
           expect(subject).to eq("file")
         end
+
+        it "does not set log as loaded through the system" do
+          expect(config.system_config).to eq({})
+        end
       end
     end
   end
 
   describe "initial config" do
-    let(:config) do
-      described_class.new(
-        "non-existing-path",
-        "production",
+    let(:initial_config) do
+      {
         :push_api_key => "abc",
         :name => "TestApp",
         :active => true,
         :revision => "v2.5.1",
         :request_headers => []
-      )
+      }
+    end
+    let(:config) do
+      described_class.new("non-existing-path", "production", initial_config)
     end
 
     it "merges with the default config" do
@@ -114,6 +139,10 @@ describe Appsignal::Config do
       )
     end
 
+    it "sets the initial_config" do
+      expect(config.initial_config).to eq(initial_config)
+    end
+
     describe "overriding system detected config" do
       describe ":running_in_container" do
         let(:config) do
@@ -183,6 +212,16 @@ describe Appsignal::Config do
       config
     end
 
+    it "sets the file_config" do
+      # config found in spec/support/project_fixture/config/appsignal.yml
+      expect(config.file_config).to match(
+        :active => true,
+        :push_api_key => "abc",
+        :name => "TestApp",
+        :request_headers => kind_of(Array)
+      )
+    end
+
     describe "overriding system and defaults config" do
       let(:config) do
         described_class.new(
@@ -228,8 +267,11 @@ describe Appsignal::Config do
     end
 
     describe "support for old config keys" do
+      let(:out_stream) { std_stream }
+      let(:output) { out_stream.read }
       let(:config) { project_fixture_config(env, {}, test_logger(log)) }
       let(:log) { StringIO.new }
+      before { capture_stdout(out_stream) { config } }
 
       describe ":api_key" do
         context "without :push_api_key" do
@@ -238,8 +280,10 @@ describe Appsignal::Config do
           it "sets the :push_api_key with the old :api_key value" do
             expect(config[:push_api_key]).to eq "def"
             expect(config.config_hash).to_not have_key :api_key
-            expect(log_contents(log)).to contains_log :warn,
-              "Old configuration key found. Please update the 'api_key' to 'push_api_key'"
+
+            message = "Old configuration key found. Please update the 'api_key' to 'push_api_key'"
+            expect(output).to include "appsignal WARNING: #{message}"
+            expect(log_contents(log)).to contains_log :warn, message
           end
         end
 
@@ -249,8 +293,10 @@ describe Appsignal::Config do
           it "ignores the :api_key config and deletes it" do
             expect(config[:push_api_key]).to eq "ghi"
             expect(config.config_hash).to_not have_key :api_key
-            expect(log_contents(log)).to contains_log :warn,
-              "Old configuration key found. Please update the 'api_key' to 'push_api_key'"
+
+            message = "Old configuration key found. Please update the 'api_key' to 'push_api_key'"
+            expect(output).to include "appsignal WARNING: #{message}"
+            expect(log_contents(log)).to contains_log :warn, message
           end
         end
       end
@@ -262,8 +308,10 @@ describe Appsignal::Config do
           it "sets :ignore_errors with the old :ignore_exceptions value" do
             expect(config[:ignore_errors]).to eq ["StandardError"]
             expect(config.config_hash).to_not have_key :ignore_exceptions
-            expect(log_contents(log)).to contains_log :warn,
-              "Old configuration key found. Please update the 'ignore_exceptions' to 'ignore_errors'"
+
+            message = "Old configuration key found. Please update the 'ignore_exceptions' to 'ignore_errors'"
+            expect(output).to include "appsignal WARNING: #{message}"
+            expect(log_contents(log)).to contains_log :warn, message
           end
         end
 
@@ -273,8 +321,10 @@ describe Appsignal::Config do
           it "ignores the :ignore_exceptions config" do
             expect(config[:ignore_errors]).to eq ["NoMethodError"]
             expect(config.config_hash).to_not have_key :ignore_exceptions
-            expect(log_contents(log)).to contains_log :warn,
-              "Old configuration key found. Please update the 'ignore_exceptions' to 'ignore_errors'"
+
+            message = "Old configuration key found. Please update the 'ignore_exceptions' to 'ignore_errors'"
+            expect(output).to include "appsignal WARNING: #{message}"
+            expect(log_contents(log)).to contains_log :warn, message
           end
         end
       end
@@ -290,6 +340,24 @@ describe Appsignal::Config do
         :debug => true
       )
     end
+    let(:env_config) do
+      {
+        :running_in_container => true,
+        :push_api_key => "aaa-bbb-ccc",
+        :active => true,
+        :name => "App name",
+        :debug => true,
+        :ignore_actions => %w[action1 action2],
+        :ignore_errors => %w[ExampleStandardError AnotherError],
+        :ignore_namespaces => %w[admin private_namespace],
+        :instrument_net_http => false,
+        :instrument_redis => false,
+        :instrument_sequel => false,
+        :files_world_accessible => false,
+        :request_headers => %w[accept accept-charset],
+        :revision => "v2.5.1"
+      }
+    end
     before do
       ENV["APPSIGNAL_RUNNING_IN_CONTAINER"]    = "true"
       ENV["APPSIGNAL_PUSH_API_KEY"]            = "aaa-bbb-ccc"
@@ -310,21 +378,7 @@ describe Appsignal::Config do
     it "overrides config with environment values" do
       expect(config.valid?).to be_truthy
       expect(config.active?).to be_truthy
-
-      expect(config[:running_in_container]).to be_truthy
-      expect(config[:push_api_key]).to eq "aaa-bbb-ccc"
-      expect(config[:active]).to eq(true)
-      expect(config[:name]).to eq "App name"
-      expect(config[:debug]).to eq(true)
-      expect(config[:ignore_actions]).to eq %w[action1 action2]
-      expect(config[:ignore_errors]).to eq %w[ExampleStandardError AnotherError]
-      expect(config[:ignore_namespaces]).to eq %w[admin private_namespace]
-      expect(config[:instrument_net_http]).to eq(false)
-      expect(config[:instrument_redis]).to eq(false)
-      expect(config[:instrument_sequel]).to eq(false)
-      expect(config[:files_world_accessible]).to eq(false)
-      expect(config[:request_headers]).to eq(%w[accept accept-charset])
-      expect(config[:revision]).to eq("v2.5.1")
+      expect(config.config_hash).to include(env_config)
     end
 
     context "with mixed case `true` env variables values" do
@@ -338,6 +392,10 @@ describe Appsignal::Config do
         expect(config[:instrument_sequel]).to eq(true)
       end
     end
+
+    it "sets the env_config" do
+      expect(config.env_config).to eq(env_config)
+    end
   end
 
   describe "config keys" do
@@ -432,7 +490,6 @@ describe Appsignal::Config do
       expect(ENV["_APPSIGNAL_IGNORE_ACTIONS"]).to               eq "action1,action2"
       expect(ENV["_APPSIGNAL_IGNORE_ERRORS"]).to                eq "ExampleStandardError,AnotherError"
       expect(ENV["_APPSIGNAL_IGNORE_NAMESPACES"]).to            eq "admin,private_namespace"
-      expect(ENV["_APPSIGNAL_SEND_PARAMS"]).to                  eq "true"
       expect(ENV["_APPSIGNAL_RUNNING_IN_CONTAINER"]).to         eq "false"
       expect(ENV["_APPSIGNAL_ENABLE_HOST_METRICS"]).to          eq "true"
       expect(ENV["_APPSIGNAL_ENABLE_MINUTELY_PROBES"]).to       eq "false"

data/spec/lib/appsignal/event_formatter/elastic_search/search_formatter_spec.rb

@@ -35,7 +35,7 @@ describe Appsignal::EventFormatter::ElasticSearch::SearchFormatter do
       }
     end
 
-    it "should sanitize non-whitelisted params" do
+    it "should sanitize non-allowlisted params" do
       expect(
         formatter.sanitized_search(search)
       ).to eql(:index => "users", :type => "user", :q => "?", :other => "?")

data/spec/lib/appsignal/event_formatter_spec.rb

@@ -46,6 +46,9 @@ describe Appsignal::EventFormatter do
   end
 
   context "registering and unregistering formatters" do
+    let(:out_stream) { std_stream }
+    let(:output) { out_stream.read }
+
     it "registers a formatter" do
       expect(klass.formatters["mock"]).to be_instance_of(MockFormatter)
     end
@@ -92,19 +95,21 @@ describe Appsignal::EventFormatter do
     end
 
     it "does not register deprecated formatters" do
-      expect(Appsignal.logger).to receive(:warn)
-        .with("Formatter for 'mock.deprecated' is using a deprecated registration method. " \
-              "This event formatter will not be loaded. " \
-              "Please update the formatter according to the documentation at: " \
-              "https://docs.appsignal.com/ruby/instrumentation/event-formatters.html")
+      message = "Formatter for 'mock.deprecated' is using a deprecated registration method. " \
+        "This event formatter will not be loaded. " \
+        "Please update the formatter according to the documentation at: " \
+        "https://docs.appsignal.com/ruby/instrumentation/event-formatters.html"
+      expect(Appsignal.logger).to receive(:warn).with(message)
 
-      deprecated_formatter
+      capture_stdout(out_stream) { deprecated_formatter }
+      expect(output).to include "appsignal WARNING: #{message}"
 
       expect(Appsignal::EventFormatter.deprecated_formatter_classes.keys).to include("mock.deprecated")
     end
 
     it "initializes deprecated formatters" do
-      deprecated_formatter
+      # Silence deprecation warning
+      capture_stdout(out_stream) { deprecated_formatter }
       Appsignal::EventFormatter.initialize_deprecated_formatters
 
       expect(klass.registered?("mock.deprecated")).to be_truthy

data/spec/lib/appsignal/extension_spec.rb

@@ -29,8 +29,11 @@ describe Appsignal::Extension do
             subject.start
           end
 
-          expect(output).to include \
-            "WARNING: Error when reading appsignal config, appsignal not starting"
+          expect(output).to match \
+            %r{
+              WARNING:\sError\swhen\sreading\sappsignal\sconfig,\s
+              appsignal\s\(as\s(\d{2,4})/(\d{2,4})\)\snot\sstarting
+            }x
         end
       end
 

data/spec/lib/appsignal/garbage_collection_profiler_spec.rb

@@ -64,3 +64,13 @@ describe Appsignal::GarbageCollectionProfiler do
     end
   end
 end
+
+describe Appsignal::NilGarbageCollectionProfiler do
+  let(:profiler) { described_class.new }
+
+  describe "#total_time" do
+    it "has a total time of 0" do
+      expect(profiler.total_time).to eq(0)
+    end
+  end
+end

data/spec/lib/appsignal/system_spec.rb

@@ -123,7 +123,7 @@ describe Appsignal::System do
       let(:os) { "freebsd11" }
       let(:ldd_output) { "ldd: illegal option -- -" }
 
-      it "returns the darwin build" do
+      it "returns the FreeBSD build" do
         is_expected.to eq("freebsd")
       end
     end

data/spec/lib/appsignal/transaction_spec.rb

@@ -672,6 +672,23 @@ describe Appsignal::Transaction do
       end
     end
 
+    describe "#garbage_collection_profiler" do
+      before { Appsignal::Transaction.instance_variable_set(:@garbage_collection_profiler, nil) }
+
+      it "returns the NilGarbageCollectionProfiler" do
+        expect(Appsignal::Transaction.garbage_collection_profiler).to be_a(Appsignal::NilGarbageCollectionProfiler)
+      end
+
+      context "when gc profiling is enabled" do
+        before { Appsignal.config.config_hash[:enable_gc_instrumentation] = true }
+        after { Appsignal.config.config_hash[:enable_gc_instrumentation] = false }
+
+        it "returns the GarbageCollectionProfiler" do
+          expect(Appsignal::Transaction.garbage_collection_profiler).to be_a(Appsignal::GarbageCollectionProfiler)
+        end
+      end
+    end
+
     describe "#start_event" do
       it "should start the event in the extension" do
         expect(transaction.ext).to receive(:start_event).with(0).and_call_original
@@ -986,7 +1003,7 @@ describe Appsignal::Transaction do
     end
 
     describe "#sanitized_environment" do
-      let(:whitelisted_keys) { Appsignal.config[:request_headers] }
+      let(:allowlisted_keys) { Appsignal.config[:request_headers] }
       subject { transaction.send(:sanitized_environment) }
 
       context "when request is nil" do
@@ -1004,14 +1021,14 @@ describe Appsignal::Transaction do
       context "when env is present" do
         let(:env) do
           {}.tap do |hash|
-            whitelisted_keys.each { |o| hash[o] = 1 } # use all whitelisted keys
-            hash[whitelisted_keys] = nil # don't add if nil
-            hash[:not_whitelisted] = "I will be sanitized"
+            allowlisted_keys.each { |o| hash[o] = 1 } # use all allowlisted keys
+            hash[allowlisted_keys] = nil # don't add if nil
+            hash[:not_allowlisted] = "I will be sanitized"
           end
         end
 
-        it "only sets whitelisted keys" do
-          expect(subject.keys).to match_array(whitelisted_keys)
+        it "only sets allowlisted keys" do
+          expect(subject.keys).to match_array(allowlisted_keys)
         end
 
         context "with configured request_headers" do
@@ -1019,7 +1036,7 @@ describe Appsignal::Transaction do
             Appsignal.config.config_hash[:request_headers] = %w[CONTENT_LENGTH]
           end
 
-          it "only sets whitelisted keys" do
+          it "only sets allowlisted keys" do
             expect(subject.keys).to match_array(%w[CONTENT_LENGTH])
           end
         end

data/spec/support/helpers/std_streams_helper.rb

@@ -56,18 +56,41 @@ module StdStreamsHelper
   # If an error is found the output the output is raised as an error, failing
   # the spec. Warnings and other AppSignal messages are ignored.
   #
-  # Usage
+  # @example
+  #   silence { do_something }
+  #   # Does nothing
+  #
+  #   silence { puts "ERROR!" }
+  #   # => Error found in silenced output:
+  #   # ERROR!
   #
-  #     silence { do_something }
+  # @example Ignore certain errors
+  #   silence(:allowed => ["my error"]) { puts "my error!" }
+  #   # Does nothing
   #
-  #     silence { puts "ERROR!" }
-  #     # => Error found in silenced output:
-  #     # ERROR!
-  def silence(&block)
+  #   silence { puts "my error!" }
+  #   # => Error found in silenced output:
+  #   # my error!
+  def silence(options = {}, &block)
     stream = Tempfile.new(SecureRandom.uuid)
     capture_std_streams(stream, stream, &block)
   ensure
-    output = stream.read
-    raise "Error found in silenced output:\n#{output}" if output =~ /(ERR|Error|error)/
+    output = filter_allowed_errors(stream.read, options.fetch(:allowed, []))
+    if output =~ /(ERR|Error|error)/
+      raise "Error found in silenced output:\n#{output}"
+    end
+  end
+
+  def filter_allowed_errors(output, allowed_errors)
+    output.lines.reject do |line|
+      reject = false
+      allowed_errors.each do |error|
+        if line.include?(error)
+          reject = true
+          break
+        end
+      end
+      reject
+    end.join(",")
   end
 end