appsignal 3.11.0 → 3.12.0

data/spec/lib/appsignal/config_spec.rb

@@ -11,7 +11,7 @@ describe Appsignal::Config do
 
       context "when environment is given" do
         let(:env) { "my_env" }
-        let(:config) { described_class.new("", "my_env") }
+        let(:config) { described_class.new("/root/path", "my_env") }
 
         it "sets the environment" do
           expect(config.env).to eq(env)
@@ -20,6 +20,7 @@ describe Appsignal::Config do
         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)
+          expect(config.config_hash).to_not have_key(:root_path)
         end
 
         context "with APPSIGNAL_APP_ENV environment variable" do
@@ -34,6 +35,7 @@ describe Appsignal::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)
+            expect(config.config_hash).to_not have_key(:root_path)
           end
         end
       end
@@ -121,6 +123,76 @@ describe Appsignal::Config do
     end
   end
 
+  describe "loader default config" do
+    let(:config) do
+      described_class.new("some-path", "production")
+    end
+    before do
+      class TestLoader < Appsignal::Loaders::Loader
+        register :test
+        def on_load
+          register_config_defaults(
+            :env => "new_env",
+            :root_path => "/some/path",
+            :my_option => "my_value",
+            :nil_option => nil
+          )
+        end
+      end
+      load_loader(:test)
+    end
+    after do
+      Object.send(:remove_const, :TestLoader)
+      unregister_loader(:first)
+    end
+
+    it "merges with the loader defaults" do
+      expect(config.config_hash).to include(:my_option => "my_value")
+    end
+
+    it "does not set any nil values" do
+      expect(config.config_hash).to_not have_key(:nil_option)
+    end
+
+    it "overwrites the env" do
+      expect(config.env).to eq("new_env")
+    end
+
+    it "overwrites the path" do
+      expect(config.root_path).to eq("/some/path")
+    end
+
+    context "with multiple loaders" do
+      before do
+        class SecondLoader < Appsignal::Loaders::Loader
+          register :second
+          def on_load
+            register_config_defaults(
+              :env => "second_env",
+              :root_path => "/second/path",
+              :my_option => "second_value",
+              :second_option => "second_value"
+            )
+          end
+        end
+        load_loader(:second)
+      end
+      after do
+        Object.send(:remove_const, :SecondLoader)
+        unregister_loader(:second)
+      end
+
+      it "makes the first loader's config leading" do
+        expect(config.config_hash).to include(
+          :my_option => "my_value",
+          :second_option => "second_value"
+        )
+        expect(config.env).to eq("new_env")
+        expect(config.root_path).to eq("/some/path")
+      end
+    end
+  end
+
   describe "initial config" do
     let(:initial_config) do
       {
@@ -1259,4 +1331,84 @@ describe Appsignal::Config do
       end
     end
   end
+
+  describe Appsignal::Config::ConfigDSL do
+    let(:env) { :production }
+    let(:config) { project_fixture_config(env) }
+    let(:dsl) { described_class.new(config) }
+
+    describe "default options" do
+      let(:env) { :unknown_env }
+
+      it "returns default values for config options" do
+        Appsignal::Config::DEFAULT_CONFIG.each do |option, value|
+          expect(dsl.send(option)).to eq(value)
+        end
+      end
+    end
+
+    it "returns already set values for config options" do
+      ENV["APPSIGNAL_IGNORE_ERRORS"] = "my_error1,my_error2"
+      config[:push_api_key] = "my push key"
+      config[:ignore_actions] = ["My ignored action"]
+
+      expect(dsl.push_api_key).to eq("my push key")
+      expect(dsl.ignore_actions).to eq(["My ignored action"])
+      expect(dsl.ignore_errors).to eq(["my_error1", "my_error2"])
+    end
+
+    it "returns the env" do
+      expect(dsl.env).to eq("production")
+    end
+
+    it "sets config options" do
+      dsl.push_api_key = "my push key"
+      dsl.ignore_actions = ["My ignored action"]
+
+      expect(dsl.push_api_key).to eq("my push key")
+      expect(dsl.ignore_actions).to eq(["My ignored action"])
+    end
+
+    it "doesn't update the config object" do
+      dsl.push_api_key = "my push key"
+
+      expect(dsl.push_api_key).to eq("my push key")
+      expect(config[:push_api_key]).to eq("abc") # Loaded from file
+    end
+
+    it "casts strings to strings" do
+      dsl.activejob_report_errors = :all
+      dsl.sidekiq_report_errors = :all
+
+      expect(dsl.activejob_report_errors).to eq("all")
+      expect(dsl.sidekiq_report_errors).to eq("all")
+    end
+
+    it "casts booleans to booleans" do
+      dsl.active = :yes
+      dsl.enable_host_metrics = "An object representing a truthy value"
+      dsl.send_params = true
+      dsl.send_session_data = false
+
+      expect(dsl.active).to be(true)
+      expect(dsl.enable_host_metrics).to be(true)
+      expect(dsl.send_params).to be(true)
+      expect(dsl.send_session_data).to be(false)
+    end
+
+    it "casts arrays to arrays" do
+      ignore_actions = Set.new
+      ignore_actions << "my ignored action 1"
+      ignore_actions << "my ignored action 2"
+      dsl.ignore_actions = ignore_actions
+
+      expect(dsl.ignore_actions).to eq(["my ignored action 1", "my ignored action 2"])
+    end
+
+    it "casts floats to floats" do
+      dsl.cpu_count = 1
+
+      expect(dsl.cpu_count).to eq(1.0)
+    end
+  end
 end

data/spec/lib/appsignal/demo_spec.rb

@@ -16,8 +16,7 @@ describe Appsignal::Demo do
     end
 
     context "with config" do
-      let(:config) { project_fixture_config("production") }
-      before { Appsignal.config = config }
+      before { start_agent }
 
       it "returns true" do
         expect(subject).to eq(true)

data/spec/lib/appsignal/environment_spec.rb

@@ -1,8 +1,10 @@
 describe Appsignal::Environment do
   include EnvironmentMetadataHelper
 
-  before(:context) { start_agent }
-  before { capture_environment_metadata_report_calls }
+  before do
+    start_agent
+    capture_environment_metadata_report_calls
+  end
 
   def report(key, &value_block)
     described_class.report(key, &value_block)

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

@@ -4,13 +4,10 @@ describe Appsignal::Hooks::ActiveSupportNotificationsHook do
   if active_support_present?
     let(:notifier) { ActiveSupport::Notifications::Fanout.new }
     let(:as) { ActiveSupport::Notifications }
-    let!(:transaction) do
-      Appsignal::Transaction.create("uuid", Appsignal::Transaction::HTTP_REQUEST, "test")
-    end
-    before :context do
-      start_agent
-    end
+    let(:transaction) { http_request_transaction }
     before do
+      start_agent
+      set_current_transaction(transaction)
       as.notifier = notifier
     end
 

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

@@ -210,7 +210,7 @@ if DependencyHelper.active_job_present?
 
       context "with activejob_report_errors set to none" do
         it "does not report the error" do
-          Appsignal.config = project_fixture_config("production")
+          start_agent("production")
           Appsignal.config[:activejob_report_errors] = "none"
 
           allow(Appsignal).to receive(:increment_counter)
@@ -229,7 +229,7 @@ if DependencyHelper.active_job_present?
       if DependencyHelper.rails_version >= Gem::Version.new("7.1.0")
         context "with activejob_report_errors set to discard" do
           before do
-            Appsignal.config = project_fixture_config("production")
+            start_agent("production")
             Appsignal.config[:activejob_report_errors] = "discard"
           end
 
@@ -352,7 +352,7 @@ if DependencyHelper.active_job_present?
 
     context "with params" do
       it "filters the configured params" do
-        Appsignal.config = project_fixture_config("production")
+        start_agent("production")
         Appsignal.config[:filter_parameters] = ["foo"]
         queue_job(ActiveJobTestJob, method_given_args)
 

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

@@ -32,16 +32,13 @@ if DependencyHelper.dry_monitor_present?
   end
 
   describe "Dry Monitor Integration" do
-    before :context do
+    let(:notifications) { Dry::Monitor::Notifications.new(:test) }
+    let(:transaction) { http_request_transaction }
+    before do
       start_agent
+      set_current_transaction(transaction)
     end
 
-    let!(:transaction) do
-      Appsignal::Transaction.create("uuid", Appsignal::Transaction::HTTP_REQUEST, "test")
-    end
-
-    let(:notifications) { Dry::Monitor::Notifications.new(:test) }
-
     context "when is a dry-sql event" do
       let(:event_id) { :sql }
       let(:payload) do

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

@@ -1,7 +1,5 @@
 describe Appsignal::Hooks::ExconHook do
-  before :context do
-    start_agent
-  end
+  before { start_agent }
 
   context "with Excon" do
     before(:context) do
@@ -27,9 +25,8 @@ describe Appsignal::Hooks::ExconHook do
     end
 
     describe "instrumentation" do
-      let!(:transaction) do
-        Appsignal::Transaction.create("uuid", Appsignal::Transaction::HTTP_REQUEST, "test")
-      end
+      let(:transaction) { http_request_transaction }
+      before { set_current_transaction(transaction) }
       around { |example| keep_transactions { example.run } }
 
       it "instruments a http request" do

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

@@ -7,8 +7,8 @@ describe Appsignal::Hooks::GvlHook do
       end
     end
   else
-    before(:context) do
-      Appsignal.config = project_fixture_config
+    before do
+      start_agent
     end
 
     def expect_gvltools_require

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

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
 describe Appsignal::Hooks::HttpHook do
-  before :context do
-    start_agent
-  end
+  before { start_agent }
 
   if DependencyHelper.http_present?
     context "with instrument_http_rb set to true" do

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

@@ -1,5 +1,5 @@
 describe Appsignal::Hooks::NetHttpHook do
-  before(:context) { start_agent }
+  before { start_agent }
 
   describe "#dependencies_present?" do
     subject { described_class.new.dependencies_present? }

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

@@ -1,6 +1,6 @@
 describe Appsignal::Hooks::RedisClientHook do
   before do
-    Appsignal.config = project_fixture_config
+    start_agent
   end
 
   if DependencyHelper.redis_client_present?
@@ -78,10 +78,9 @@ describe Appsignal::Hooks::RedisClientHook do
                 # track if it was installed already or not.
                 Appsignal::Hooks::RedisClientHook.new.install
               end
-              let!(:transaction) do
-                Appsignal::Transaction.create("uuid", Appsignal::Transaction::HTTP_REQUEST, "test")
-              end
+              let(:transaction) { http_request_transaction }
               let!(:client_config) { RedisClient::Config.new(:id => "stub_id") }
+              before { set_current_transaction(transaction) }
               around { |example| keep_transactions { example.run } }
 
               it "instrument a redis call" do
@@ -164,11 +163,9 @@ describe Appsignal::Hooks::RedisClientHook do
                   # track if it was installed already or not.
                   Appsignal::Hooks::RedisClientHook.new.install
                 end
-                let!(:transaction) do
-                  Appsignal::Transaction.create("uuid", Appsignal::Transaction::HTTP_REQUEST,
-                    "test")
-                end
+                let(:transaction) { http_request_transaction }
                 let!(:client_config) { RedisClient::Config.new(:id => "stub_id") }
+                before { set_current_transaction(transaction) }
                 around { |example| keep_transactions { example.run } }
 
                 it "instrument a redis call" do

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

@@ -1,7 +1,5 @@
 describe Appsignal::Hooks::RedisHook do
-  before do
-    Appsignal.config = project_fixture_config
-  end
+  before { start_agent }
 
   if DependencyHelper.redis_present?
     context "with redis" do
@@ -72,9 +70,8 @@ describe Appsignal::Hooks::RedisHook do
                 # track if it was installed already or not.
                 Appsignal::Hooks::RedisHook.new.install
               end
-              let!(:transaction) do
-                Appsignal::Transaction.create("uuid", Appsignal::Transaction::HTTP_REQUEST, "test")
-              end
+              let(:transaction) { http_request_transaction }
+              before { set_current_transaction(transaction) }
               around { |example| keep_transactions { example.run } }
 
               it "instrument a redis call" do

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

@@ -83,7 +83,7 @@ describe Appsignal::Hooks::ResqueHook do
 
       context "with arguments" do
         before do
-          Appsignal.config = project_fixture_config("production")
+          start_agent("production")
           Appsignal.config[:filter_parameters] = ["foo"]
         end
 

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

@@ -8,9 +8,7 @@ describe Appsignal::Hooks::SequelHook do
       end
     end
 
-    before :context do
-      start_agent
-    end
+    before { start_agent }
 
     describe "#dependencies_present?" do
       subject { described_class.new.dependencies_present? }
@@ -19,9 +17,9 @@ describe Appsignal::Hooks::SequelHook do
     end
 
     context "with a transaction" do
-      let(:transaction) { Appsignal::Transaction.current }
+      let(:transaction) { http_request_transaction }
       before do
-        Appsignal::Transaction.create("uuid", Appsignal::Transaction::HTTP_REQUEST, "test")
+        set_current_transaction(transaction)
         db.logger = Logger.new($stdout) # To test #log_duration call
       end
 

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

@@ -65,7 +65,7 @@ describe Appsignal::Hooks::SidekiqHook do
     end
 
     before do
-      Appsignal.config = project_fixture_config
+      start_agent
       stub_const "Sidekiq", SidekiqMock
     end
 

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

@@ -2,7 +2,7 @@ describe Appsignal::Hooks::WebmachineHook do
   if DependencyHelper.webmachine_present?
     context "with webmachine" do
       let(:fsm) { Webmachine::Decision::FSM.new(double(:trace? => false), double, double) }
-      before(:context) { start_agent }
+      before { start_agent }
 
       describe "#dependencies_present?" do
         subject { described_class.new.dependencies_present? }

data/spec/lib/appsignal/integrations/delayed_job_plugin_spec.rb

@@ -83,7 +83,7 @@ describe "Appsignal::Integrations::DelayedJobHook" do
 
         context "with parameter filtering" do
           before do
-            Appsignal.config = project_fixture_config("production")
+            start_agent("production")
             Appsignal.config[:filter_parameters] = ["foo"]
           end
 
@@ -272,7 +272,7 @@ describe "Appsignal::Integrations::DelayedJobHook" do
 
             context "with parameter filtering" do
               before do
-                Appsignal.config = project_fixture_config("production")
+                start_agent("production")
                 Appsignal.config[:filter_parameters] = ["foo"]
               end
 

data/spec/lib/appsignal/integrations/grape_spec.rb

@@ -0,0 +1,36 @@
+if DependencyHelper.grape_present?
+  require "appsignal/integrations/grape"
+
+  context "Appsignal::Grape::Middleware constant" do
+    let(:err_stream) { std_stream }
+    let(:stderr) { err_stream.read }
+
+    it "returns the Rack::GrapeMiddleware constant calling the Grape::Middleware constant" do
+      silence { expect(Appsignal::Grape::Middleware).to be(Appsignal::Rack::GrapeMiddleware) }
+    end
+
+    it "prints a deprecation warning to STDERR" do
+      capture_std_streams(std_stream, err_stream) do
+        expect(Appsignal::Grape::Middleware).to be(Appsignal::Rack::GrapeMiddleware)
+      end
+
+      expect(stderr).to include(
+        "appsignal WARNING: The constant Appsignal::Grape::Middleware has been deprecated."
+      )
+    end
+
+    it "logs a warning" do
+      logs =
+        capture_logs do
+          silence do
+            expect(Appsignal::Grape::Middleware).to be(Appsignal::Rack::GrapeMiddleware)
+          end
+        end
+
+      expect(logs).to contains_log(
+        :warn,
+        "The constant Appsignal::Grape::Middleware has been deprecated."
+      )
+    end
+  end
+end