appsignal 3.11.0 → 3.12.1

data/spec/lib/appsignal_spec.rb

@@ -2,22 +2,226 @@ describe Appsignal do
   include EnvironmentMetadataHelper
   around { |example| keep_transactions { example.run } }
 
-  before do
-    # Make sure we have a clean state because we want to test
-    # initialization here.
-    Appsignal.config = nil
-  end
-
   let(:transaction) { http_request_transaction }
 
   describe ".config=" do
-    it "should set the config" do
+    it "sets the config" do
       config = project_fixture_config
       expect(Appsignal.internal_logger).to_not receive(:level=)
 
-      Appsignal.config = config
+      silence { Appsignal.config = config }
       expect(Appsignal.config).to eq config
     end
+
+    it "prints a deprecation warning" do
+      err_stream = std_stream
+      capture_std_streams(std_stream, err_stream) do
+        Appsignal.config = project_fixture_config
+      end
+      expect(err_stream.read).to include(
+        "appsignal WARNING: Configuring AppSignal with `Appsignal.config=` is deprecated."
+      )
+    end
+
+    it "logs a deprecation warning" do
+      logs = capture_logs { silence { Appsignal.config = project_fixture_config } }
+      expect(logs).to contains_log(
+        :warn,
+        "Configuring AppSignal with `Appsignal.config=` is deprecated."
+      )
+    end
+  end
+
+  describe ".configure" do
+    context "when active" do
+      it "doesn't update the config" do
+        start_agent
+        Appsignal::Testing.store[:config_called] = false
+        expect do
+          Appsignal.configure do |_config|
+            Appsignal::Testing.store[:config_called] = true
+          end
+        end.to_not(change { [Appsignal.config, Appsignal.active?] })
+        expect(Appsignal::Testing.store[:config_called]).to be(false)
+      end
+
+      it "logs a warning" do
+        start_agent
+        logs =
+          capture_logs do
+            Appsignal.configure do |_config|
+              # Do something
+            end
+          end
+        expect(logs).to contains_log(
+          :warn,
+          "AppSignal is already started. Ignoring `Appsignal.configure` call."
+        )
+      end
+    end
+
+    context "with config but not started" do
+      it "reuses the already loaded config if the env is the same" do
+        Appsignal._config = Appsignal::Config.new(
+          project_fixture_path,
+          :my_env,
+          :ignore_actions => ["My action"]
+        )
+
+        Appsignal.configure(:my_env) do |config|
+          expect(config.ignore_actions).to eq(["My action"])
+          config.active = true
+          config.name = "My app"
+          config.push_api_key = "key"
+        end
+        expect(Appsignal.config.valid?).to be(true)
+        expect(Appsignal.config.env).to eq("my_env")
+        expect(Appsignal.config[:active]).to be(true)
+        expect(Appsignal.config[:name]).to eq("My app")
+        expect(Appsignal.config[:push_api_key]).to eq("key")
+      end
+
+      it "loads a new config if the env is not the same" do
+        Appsignal._config = Appsignal::Config.new(
+          project_fixture_path,
+          :my_env,
+          :name => "Some name",
+          :push_api_key => "Some key",
+          :ignore_actions => ["My action"]
+        )
+
+        Appsignal.configure(:my_env2) do |config|
+          expect(config.ignore_actions).to be_empty
+          config.active = true
+          config.name = "My app"
+          config.push_api_key = "key"
+        end
+        expect(Appsignal.config.valid?).to be(true)
+        expect(Appsignal.config.env).to eq("my_env2")
+        expect(Appsignal.config[:active]).to be(true)
+        expect(Appsignal.config[:name]).to eq("My app")
+        expect(Appsignal.config[:push_api_key]).to eq("key")
+      end
+
+      it "calls configure if not started yet" do
+        Appsignal.configure(:my_env) do |config|
+          config.active = false
+          config.name = "Some name"
+        end
+        Appsignal.start
+        expect(Appsignal.started?).to be_falsy
+
+        Appsignal.configure(:my_env) do |config|
+          expect(config.ignore_actions).to be_empty
+          config.active = true
+          config.name = "My app"
+          config.push_api_key = "key"
+        end
+        expect(Appsignal.config.valid?).to be(true)
+        expect(Appsignal.config.env).to eq("my_env")
+        expect(Appsignal.config[:active]).to be(true)
+        expect(Appsignal.config[:name]).to eq("My app")
+        expect(Appsignal.config[:push_api_key]).to eq("key")
+      end
+    end
+
+    context "when not active" do
+      it "starts with the configured config" do
+        Appsignal.configure(:test) do |config|
+          config.push_api_key = "key"
+        end
+
+        Appsignal.start
+        expect(Appsignal.config[:push_api_key]).to eq("key")
+      end
+
+      it "uses the given env" do
+        ENV["APPSIGNAL_APP_ENV"] = "env_env"
+        Appsignal.configure(:env_arg)
+
+        Appsignal.start
+        expect(Appsignal.config.env).to eq("env_arg")
+      end
+
+      it "loads the config without a block being given" do
+        Dir.chdir project_fixture_path do
+          Appsignal.configure(:test)
+        end
+
+        expect(Appsignal.config.env).to eq("test")
+        expect(Appsignal.config[:push_api_key]).to eq("abc")
+      end
+
+      it "allows customization of config in the block" do
+        Appsignal.configure(:test) do |config|
+          config.push_api_key = "key"
+        end
+
+        expect(Appsignal.config.valid?).to be(true)
+        expect(Appsignal.config.env).to eq("test")
+        expect(Appsignal.config[:push_api_key]).to eq("key")
+      end
+
+      it "loads the default config" do
+        Appsignal.configure do |config|
+          Appsignal::Config::DEFAULT_CONFIG.each do |option, value|
+            expect(config.send(option)).to eq(value)
+          end
+        end
+      end
+
+      it "loads the config from the YAML file" do
+        Dir.chdir project_fixture_path do
+          Appsignal.configure(:test) do |config|
+            expect(config.name).to eq("TestApp")
+          end
+        end
+      end
+
+      it "recognizes valid config" do
+        Appsignal.configure(:my_env) do |config|
+          config.push_api_key = "key"
+        end
+
+        expect(Appsignal.config.valid?).to be(true)
+      end
+
+      it "recognizes invalid config" do
+        Appsignal.configure(:my_env) do |config|
+          config.push_api_key = ""
+        end
+
+        expect(Appsignal.config.valid?).to be(false)
+      end
+
+      it "sets the environment when given as an argument" do
+        Appsignal.configure(:my_env)
+
+        expect(Appsignal.config.env).to eq("my_env")
+      end
+
+      it "reads the environment from the environment" do
+        ENV["APPSIGNAL_APP_ENV"] = "env_env"
+        Appsignal.configure do |config|
+          expect(config.env).to eq("env_env")
+        end
+
+        expect(Appsignal.config.env).to eq("env_env")
+      end
+
+      it "allows modification of previously unset config options" do
+        expect do
+          Appsignal.configure do |config|
+            config.ignore_actions << "My action"
+            config.request_headers << "My allowed header"
+          end
+        end.to_not(change { Appsignal::Config::DEFAULT_CONFIG })
+
+        expect(Appsignal.config[:ignore_actions]).to eq(["My action"])
+        expect(Appsignal.config[:request_headers])
+          .to eq(Appsignal::Config::DEFAULT_CONFIG[:request_headers] + ["My allowed header"])
+      end
+    end
   end
 
   describe ".start" do
@@ -50,7 +254,7 @@ describe Appsignal do
     end
 
     context "when config is loaded" do
-      before { Appsignal.config = project_fixture_config }
+      before { Appsignal._config = project_fixture_config }
 
       it "should initialize logging" do
         Appsignal.start
@@ -113,6 +317,27 @@ describe Appsignal do
         end
       end
 
+      describe "loaders" do
+        it "starts loaded loaders" do
+          Appsignal::Testing.store[:loader_loaded] = 0
+          Appsignal::Testing.store[:loader_started] = 0
+          define_loader(:start_loader) do
+            def on_load
+              Appsignal::Testing.store[:loader_loaded] += 1
+            end
+
+            def on_start
+              Appsignal::Testing.store[:loader_started] += 1
+            end
+          end
+          Appsignal::Loaders.load(:start_loader)
+          Appsignal::Loaders.start
+
+          expect(Appsignal::Testing.store[:loader_loaded]).to eq(1)
+          expect(Appsignal::Testing.store[:loader_started]).to eq(1)
+        end
+      end
+
       describe "environment metadata" do
         before { capture_environment_metadata_report_calls }
 
@@ -128,7 +353,7 @@ describe Appsignal do
     end
 
     context "with debug logging" do
-      before { Appsignal.config = project_fixture_config("test") }
+      before { Appsignal._config = project_fixture_config("test") }
 
       it "should change the log level" do
         Appsignal.start
@@ -137,6 +362,22 @@ describe Appsignal do
     end
   end
 
+  describe ".load" do
+    before do
+      TestLoader = define_loader(:appsignal_loader)
+    end
+    after do
+      Object.send(:remove_const, :TestLoader)
+    end
+
+    it "loads a loader" do
+      expect(Appsignal::Loaders.instances).to be_empty
+      Appsignal.load(:appsignal_loader)
+      expect(Appsignal::Loaders.instances)
+        .to include(:appsignal_loader => instance_of(TestLoader))
+    end
+  end
+
   describe ".forked" do
     context "when not active" do
       it "does nothing" do
@@ -148,7 +389,7 @@ describe Appsignal do
 
     context "when active" do
       before do
-        Appsignal.config = project_fixture_config
+        Appsignal._config = project_fixture_config
       end
 
       it "starts the logger and extension" do
@@ -162,7 +403,7 @@ describe Appsignal do
 
   describe ".stop" do
     it "calls stop on the extension" do
-      expect(Appsignal.internal_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
@@ -177,7 +418,7 @@ describe Appsignal do
 
     context "with context specified" do
       it "should log the context" do
-        expect(Appsignal.internal_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
@@ -185,20 +426,34 @@ describe Appsignal do
     end
   end
 
-  describe ".active?" do
-    subject { Appsignal.active? }
+  describe ".started?" do
+    subject { Appsignal.started? }
 
-    context "without config" do
+    context "when started with active config" do
+      before { start_agent }
+
+      it { is_expected.to be_truthy }
+    end
+
+    context "when started with inactive config" do
       before do
-        Appsignal.config = nil
+        Appsignal._config = project_fixture_config("nonsense")
       end
 
       it { is_expected.to be_falsy }
     end
+  end
+
+  describe ".active?" do
+    subject { Appsignal.active? }
+
+    context "without config" do
+      it { is_expected.to be_falsy }
+    end
 
     context "with inactive config" do
       before do
-        Appsignal.config = project_fixture_config("nonsense")
+        Appsignal._config = project_fixture_config("nonsense")
       end
 
       it { is_expected.to be_falsy }
@@ -206,7 +461,7 @@ describe Appsignal do
 
     context "with active config" do
       before do
-        Appsignal.config = project_fixture_config
+        Appsignal._config = project_fixture_config
       end
 
       it { is_expected.to be_truthy }
@@ -232,7 +487,7 @@ describe Appsignal do
   end
 
   context "not active" do
-    before { Appsignal.config = project_fixture_config("not_active") }
+    before { Appsignal._config = project_fixture_config("not_active") }
 
     describe ".monitor_transaction" do
       it "does not create a transaction" do
@@ -490,6 +745,12 @@ describe Appsignal do
 
         expect(Appsignal).to have_received(:stop).with("monitor_and_stop")
       end
+
+      it "passes the block to Appsignal.monitor" do
+        expect do |blk|
+          Appsignal.monitor_and_stop(:action => "My action", &blk)
+        end.to yield_control
+      end
     end
 
     describe ".monitor_transaction" do
@@ -883,13 +1144,11 @@ describe Appsignal do
     end
 
     describe ".add_breadcrumb" do
-      around do |example|
-        start_agent
-        with_current_transaction(transaction) { example.run }
-      end
+      before { start_agent }
 
       context "with transaction" do
         let(:transaction) { http_request_transaction }
+        before { set_current_transaction(transaction) }
 
         it "adds the breadcrumb to the transaction" do
           Appsignal.add_breadcrumb(
@@ -1648,7 +1907,7 @@ describe Appsignal do
     after { FileUtils.rm_rf(log_path) }
 
     def initialize_config
-      Appsignal.config = project_fixture_config(
+      Appsignal._config = project_fixture_config(
         "production",
         :log_path => log_path,
         :log_level => log_level
@@ -1795,7 +2054,6 @@ describe Appsignal do
 
       context "when there is no config" do
         before do
-          Appsignal.config = nil
           capture_stdout(out_stream) do
             Appsignal._start_logger
           end

data/spec/lib/puma/appsignal_spec.rb

@@ -76,9 +76,6 @@ RSpec.describe "Puma plugin" do
   let(:hostname) { Socket.gethostname }
   let(:expected_default_tags) { { "hostname" => hostname } }
   let(:stats_data) { { :backlog => 1 } }
-  before :context do
-    Appsignal.stop
-  end
   before do
     module Puma
       def self.stats

data/spec/spec_helper.rb

@@ -66,6 +66,7 @@ RSpec.configure do |config|
   config.include ApiRequestHelper
   config.include SystemHelpers
   config.include LogHelpers
+  config.include LoaderHelper
   config.extend DependencyHelper
 
   config.example_status_persistence_file_path = "spec/examples.txt"
@@ -92,6 +93,10 @@ RSpec.configure do |config|
   end
 
   config.before do
+    Appsignal.clear!
+    Appsignal::Testing.clear!
+    Appsignal::Loaders.clear!
+    clear_current_transaction!
     stop_minutely_probes
     ENV["RAILS_ENV"] ||= "test"
     ENV["RACK_ENV"] ||= "test"
@@ -157,15 +162,11 @@ RSpec.configure do |config|
   end
 
   config.after do
-    Appsignal::Testing.clear!
-    clear_current_transaction!
     stop_minutely_probes
   end
 
   config.after :context do
     FileUtils.rm_f(File.join(project_fixture_path, "log/appsignal.log"))
-    Appsignal.config = nil
-    Appsignal.internal_logger = nil
   end
 
   def stop_minutely_probes

data/spec/support/helpers/config_helpers.rb

@@ -4,6 +4,7 @@ module ConfigHelpers
       File.join(File.dirname(__FILE__), "../fixtures/projects/valid")
     )
   end
+  module_function :project_fixture_path
 
   def project_fixture_config( # rubocop:disable Metrics/ParameterLists
     env = "production",
@@ -22,7 +23,7 @@ module ConfigHelpers
   module_function :project_fixture_config, :project_fixture_path
 
   def start_agent(env = "production")
-    Appsignal.config = project_fixture_config(env)
+    Appsignal._config = project_fixture_config(env)
     Appsignal.start
   end
 end

data/spec/support/helpers/loader_helper.rb

@@ -0,0 +1,21 @@
+module LoaderHelper
+  def load_loader(name)
+    Appsignal.load(name)
+  end
+
+  def start_loader(name)
+    Appsignal::Loaders.instances.fetch(name).on_start
+  end
+
+  def unregister_loader(name)
+    Appsignal::Loaders.unregister(name)
+  end
+
+  def define_loader(name, &block)
+    Appsignal::Testing.registered_loaders << name
+    Class.new(Appsignal::Loaders::Loader) do
+      register name
+      class_eval(&block) if block_given?
+    end
+  end
+end

data/spec/support/matchers/transaction.rb

@@ -59,6 +59,7 @@ define_transaction_sample_matcher_for(:environment)
 define_transaction_sample_matcher_for(:session_data)
 define_transaction_sample_matcher_for(:tags)
 define_transaction_sample_matcher_for(:custom_data)
+define_transaction_sample_matcher_for(:error_causes)
 
 RSpec::Matchers.define :be_completed do
   match(:notify_expectation_failures => true) do |transaction|
@@ -66,14 +67,14 @@ RSpec::Matchers.define :be_completed do
   end
 end
 
-RSpec::Matchers.define :have_error do |error_class, error_message|
+RSpec::Matchers.define :have_error do |error_class, error_message, error_backtrace|
   match(:notify_expectation_failures => true) do |transaction|
     transaction_error = transaction.to_h["error"]
     if error_class && error_message
       expect(transaction_error).to include(
         "name" => error_class,
         "message" => error_message,
-        "backtrace" => kind_of(String)
+        "backtrace" => error_backtrace ? JSON.dump(error_backtrace) : kind_of(String)
       )
     else
       expect(transaction_error).to be_any

data/spec/support/stubs/appsignal/loaders/loader_stub.rb

@@ -0,0 +1,7 @@
+module Appsignal
+  module Loaders
+    class LoaderStub < Loader
+      register :loader_stub
+    end
+  end
+end

data/spec/support/testing.rb

@@ -9,11 +9,55 @@ module Appsignal
       @testing = true unless defined?(@testing)
       @testing
     end
+
+    # @api private
+    def clear_started!
+      return unless instance_variable_defined?(:@started)
+
+      remove_instance_variable(:@started)
+    end
+
+    # @api private
+    def clear_config!
+      @config = nil
+    end
+
+    # @api private
+    def clear!
+      Appsignal.internal_logger = nil
+
+      clear_started!
+      clear_config!
+    end
+  end
+
+  class Config
+    def self.clear_loader_defaults!
+      @loader_defaults = nil
+    end
+  end
+
+  module Loaders
+    def self.clear!
+      Appsignal::Config.clear_loader_defaults!
+      loaders.reject! do |key, _value|
+        Appsignal::Testing.registered_loaders.include?(key)
+      end
+      @instances = nil
+    end
   end
 
   # @api private
   module Testing
     class << self
+      def store
+        @store ||= {}
+      end
+
+      def registered_loaders
+        @registered_loaders ||= Set.new
+      end
+
       def without_testing
         original_testing = Appsignal.testing?
         Appsignal.testing = false
@@ -27,7 +71,9 @@ module Appsignal
       end
 
       def clear!
+        store.clear
         transactions.clear
+        registered_loaders.clear
       end
 
       attr_writer :keep_transactions, :sample_transactions

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 3.11.0
+  version: 3.12.1
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-15 00:00:00.000000000 Z
+date: 2024-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -266,6 +266,11 @@ files:
 - lib/appsignal/integrations/sinatra.rb
 - lib/appsignal/integrations/unicorn.rb
 - lib/appsignal/integrations/webmachine.rb
+- lib/appsignal/loaders.rb
+- lib/appsignal/loaders/grape.rb
+- lib/appsignal/loaders/hanami.rb
+- lib/appsignal/loaders/padrino.rb
+- lib/appsignal/loaders/sinatra.rb
 - lib/appsignal/logger.rb
 - lib/appsignal/marker.rb
 - lib/appsignal/probes.rb
@@ -364,6 +369,7 @@ files:
 - spec/lib/appsignal/hooks_spec.rb
 - spec/lib/appsignal/integrations/data_mapper_spec.rb
 - spec/lib/appsignal/integrations/delayed_job_plugin_spec.rb
+- spec/lib/appsignal/integrations/grape_spec.rb
 - spec/lib/appsignal/integrations/hanami_spec.rb
 - spec/lib/appsignal/integrations/http_spec.rb
 - spec/lib/appsignal/integrations/mongo_ruby_driver_spec.rb
@@ -376,6 +382,11 @@ files:
 - spec/lib/appsignal/integrations/sidekiq_spec.rb
 - spec/lib/appsignal/integrations/sinatra_spec.rb
 - spec/lib/appsignal/integrations/webmachine_spec.rb
+- spec/lib/appsignal/loaders/grape_spec.rb
+- spec/lib/appsignal/loaders/hanami_spec.rb
+- spec/lib/appsignal/loaders/padrino_spec.rb
+- spec/lib/appsignal/loaders/sinatra_spec.rb
+- spec/lib/appsignal/loaders_spec.rb
 - spec/lib/appsignal/logger_spec.rb
 - spec/lib/appsignal/marker_spec.rb
 - spec/lib/appsignal/probes/gvl_spec.rb
@@ -427,6 +438,7 @@ files:
 - spec/support/helpers/environment_metdata_helper.rb
 - spec/support/helpers/example_exception.rb
 - spec/support/helpers/example_standard_error.rb
+- spec/support/helpers/loader_helper.rb
 - spec/support/helpers/log_helpers.rb
 - spec/support/helpers/rails_helper.rb
 - spec/support/helpers/std_streams_helper.rb
@@ -444,6 +456,7 @@ files:
 - spec/support/mocks/mock_probe.rb
 - spec/support/rails/my_app.rb
 - spec/support/shared_examples/instrument.rb
+- spec/support/stubs/appsignal/loaders/loader_stub.rb
 - spec/support/stubs/delayed_job.rb
 - spec/support/stubs/sidekiq/api.rb
 - spec/support/testing.rb