appsignal 3.12.5 → 3.12.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd62bf754a88f4f79b2ca6fb08a783bb86e97fe0c412bf7f3ea70262bf4c5d9f
-  data.tar.gz: 647bac8317c4f1c4ce67bf53b8ae06f28ffd89f89b4d64d930037b0733e11f76
+  metadata.gz: d54d86a604df3df8944cf99dcd63dfe9b337c829543f5d80ce5f6d507ff80dd9
+  data.tar.gz: 39137b4064d8cd060ef32ce59ca7fe1e66066179673d44ef099af149908feb66
 SHA512:
-  metadata.gz: b10727bb338031cb33310bec347d42f186f2e44c8e91464b6e400b2ca4e9693f975d8be2e209e332083cf17f0a28d77e279e6f7d7afd082c6bf878404e151f4b
-  data.tar.gz: 9cc47facf2c3e4448a8c18f73980d2e286b72e568c2bebdf1cf11356fc757a22781def5f4507ded0ba63d31045a935b84c811688368c2b0bc882627cac82fd9c
+  metadata.gz: e4073b5455f88773ea180fecd94bf79878d845241d2b614a5c3cf7d3485d9ea300962c838721f44b5ebeeb2cb8ebe9593056d74d0072f22a515ed8b075022740
+  data.tar.gz: 666e8ff6f6ceb7526c40be3b6cd6b8082209181644fe2538ca3a587b2299a71330210dfaea59656075707a112addbf8f5e96cce224f24db7afb5bf10048812db

data/CHANGELOG.md

@@ -1,5 +1,40 @@
 # AppSignal for Ruby gem Changelog
 
+## 3.12.6
+
+_Published on 2024-08-05._
+
+### Changed
+
+- Configure AppSignal with the install CLI when no known frameworks is found. Automate the configure step so that this doesn't have to be done manually along with the manual setup for the app. (patch [a9c546fa](https://github.com/appsignal/appsignal-ruby/commit/a9c546fa86afbec290cd8439a559bf60cad21fc8))
+
+### Deprecated
+
+- Deprecate the `Appsignal.listen_for_error` helper. Use a manual error rescue with `Appsignal.report_error`. This method allows for more customization of the reported error.
+
+  ```ruby
+  # Before
+  Appsignal.listen_for_error do
+    raise "some error"
+  end
+
+  begin
+    raise "some error"
+  rescue => error
+    Appsignal.report_error(error)
+  end
+  ```
+
+  Read our [Exception handling guide](https://docs.appsignal.com/ruby/instrumentation/exception-handling.html) for more information.
+
+  (patch [14bd8882](https://github.com/appsignal/appsignal-ruby/commit/14bd88824dea2993cb0165bbbed0def29d69f72a))
+- Deprecate the `Appsignal.configure`'s `app_path` writer. Use the `Appsignal.configure`'s `root_path` keyword argument to configure the path. (patch [c79f46c3](https://github.com/appsignal/appsignal-ruby/commit/c79f46c3cd96ac51726a963f38999bfb3c246d52))
+
+### Fixed
+
+- Fix an error on the Padrino require in the installer CLI. The latest Padrino version will crash the installer on load. Ignore the error when it fails to load. (patch [dfe23707](https://github.com/appsignal/appsignal-ruby/commit/dfe23707f769ff818714ee7cf14340f9472ce2e4))
+- Fix the `Appsignal.configure` path config not being customizable. It's now possible to pass a `root_path` keyword argument to `Appsignal.configure` to customize the path from which AppSignal reads the config file, `config/appsignal.yml`. (patch [c79f46c3](https://github.com/appsignal/appsignal-ruby/commit/c79f46c3cd96ac51726a963f38999bfb3c246d52))
+
 ## 3.12.5
 
 _Published on 2024-08-01._

data/lib/appsignal/cli/install.rb

@@ -18,16 +18,16 @@ module Appsignal
           $stdout.sync = true
 
           puts
-          puts colorize "#######################################", :green
-          puts colorize "## Starting AppSignal Installer      ##", :green
-          puts colorize "## --------------------------------- ##", :green
-          puts colorize "## Need help?  support@appsignal.com ##", :green
-          puts colorize "## Docs?       docs.appsignal.com    ##", :green
-          puts colorize "#######################################", :green
+          puts colorize "############################################", :green
+          puts colorize "## Starting AppSignal Installer           ##", :green
+          puts colorize "## -------------------------------------- ##", :green
+          puts colorize "## Need help?  support@appsignal.com      ##", :green
+          puts colorize "## Docs:       https://docs.appsignal.com ##", :green
+          puts colorize "############################################", :green
           puts
           unless push_api_key
             puts colorize "Problem encountered:", :red
-            puts "  No push API key entered."
+            puts "  No Push API key entered."
             puts "  - Sign up for AppSignal and follow the instructions"
             puts "  - Already signed up? Click 'Add app' on the account overview page"
             puts
@@ -37,22 +37,25 @@ module Appsignal
           config = new_config
           config[:push_api_key] = push_api_key
 
-          print "Validating API key"
+          print "Validating Push API key"
           periods
           puts
           begin
             auth_check = Appsignal::AuthCheck.new(config)
             unless auth_check.perform == "200"
-              puts "\n  API key '#{config[:push_api_key]}' is not valid, please get a new one on https://appsignal.com"
+              print colorize("  Error:", :red)
+              puts " Push API key '#{config[:push_api_key]}' is not valid. " \
+                "Please get a new one at https://appsignal.com/accounts"
               return
             end
           rescue => e
-            puts "  There was an error validating your API key:"
+            print colorize("  Error:", :red)
+            puts "There was an error validating your Push API key:"
             puts colorize "'#{e}'", :red
-            puts "  Please try again"
+            puts "  Please check the Push API key and try again"
             return
           end
-          puts colorize "  API key valid!", :green
+          puts colorize "  Push API key valid!", :green
           puts
 
           if installed_frameworks.include?(:rails)
@@ -66,12 +69,7 @@ module Appsignal
           elsif installed_frameworks.include?(:sinatra)
             install_for_sinatra(config)
           else
-            print colorize "Warning:", :red
-            puts " We could not detect which framework you are using. " \
-              "We'd be very grateful if you email us on support@appsignal.com " \
-              "with information about your setup."
-            puts
-            done_notice
+            install_for_unknown_framework(config)
           end
         end
 
@@ -119,11 +117,18 @@ module Appsignal
           puts
           configure(config, %w[development production staging], true)
 
-          puts "Finish Sinatra configuration"
-          puts "  Sinatra requires some manual configuration."
-          puts "  Add this line beneath require 'sinatra':"
+          puts "Sinatra installation"
+          puts "  Sinatra apps requires some manual setup."
+          puts "  Update the `config.ru` (or the application's main file) to " \
+            "look like this:"
+          puts
+          puts %(require "appsignal")
+          puts %(require "sinatra" # or require "sinatra/base")
           puts
-          puts "  require 'appsignal/integrations/sinatra'"
+          puts "Appsignal.load(:sinatra) # Load the Sinatra integration"
+          puts "Appsignal.start # Start AppSignal"
+          puts
+          puts "# Rest of the config.ru file"
           puts
           puts "  You can find more information in the documentation:"
           puts "  https://docs.appsignal.com/ruby/integrations/sinatra.html"
@@ -137,11 +142,14 @@ module Appsignal
           puts
           configure(config, %w[development production staging], true)
 
-          puts "Finish Padrino installation"
-          puts "  Padrino requires some manual configuration."
-          puts "  After installing the gem, add the following line to /config/boot.rb:"
+          puts "Padrino installation"
+          puts "  Padrino apps requires some manual setup."
+          puts "  After installing the gem, add the following lines to `config/boot.rb`:"
+          puts
+          puts %(require "appsignal")
           puts
-          puts "  require 'appsignal/integrations/padrino"
+          puts "Appsignal.load(:padrino) # Load the Padrino integration"
+          puts "Appsignal.start # Start AppSignal"
           puts
           puts "  You can find more information in the documentation:"
           puts "  https://docs.appsignal.com/ruby/integrations/padrino.html"
@@ -157,7 +165,8 @@ module Appsignal
 
           configure(config, %w[development production staging], true)
 
-          puts "Manual Grape configuration needed"
+          puts "Grape installation"
+          puts "  Grape apps require some manual setup."
           puts "  See the installation instructions at:"
           puts "  https://docs.appsignal.com/ruby/integrations/grape.html"
           press_any_key
@@ -170,11 +179,17 @@ module Appsignal
           puts
           configure(config, %w[development production staging], true)
 
-          puts "Finish Hanami installation"
-          puts "  Hanami requires some manual configuration."
-          puts "  After installing the gem, add the following line to config.ru:"
+          puts "Hanami installation"
+          puts "  Hanami apps requires some manual setup."
+          puts "  Update the config.ru file to include the following:"
+          puts
+          puts %(  require "appsignal")
+          puts %(  require "hanami/boot")
           puts
-          puts "  require 'appsignal/integrations/hanami'"
+          puts "Appsignal.load(:hanami) # Load the Hanami integration"
+          puts "Appsignal.start # Start AppSignal"
+          puts
+          puts "# Rest of the config.ru file"
           puts
           puts "  You can find more information in the documentation:"
           puts "  https://docs.appsignal.com/ruby/integrations/hanami.html"
@@ -197,6 +212,23 @@ module Appsignal
           puts
         end
 
+        def install_for_unknown_framework(config)
+          puts "Installing"
+          config[:name] = required_input("  Enter application name: ")
+          puts
+          configure(config, %w[development production staging], true)
+
+          puts colorize "Warning: We could not detect which framework you are using", :red
+          puts "  Some manual installation is most likely required."
+          puts "  Please check our documentation for supported libraries: "
+          puts "  https://docs.appsignal.com/ruby/integrations.html"
+          puts
+          puts "  We'd be very grateful if you email us on " \
+            "support@appsignal.com with information about your setup."
+          press_any_key
+          done_notice
+        end
+
         def configure(config, environments, name_overwritten)
           install_for_capistrano
 
@@ -240,29 +272,27 @@ module Appsignal
         end
 
         def done_notice
-          sleep 0.3
-          puts colorize "#####################################", :green
-          puts colorize "## AppSignal installation complete ##", :green
-          puts colorize "#####################################", :green
-          sleep 0.3
-          puts
           if Gem.win_platform?
-            puts "The AppSignal agent currently does not work on Microsoft " \
+            print colorize "Warning:", :red
+            puts " The AppSignal agent currently does not work on Microsoft " \
               "Windows. Please push these changes to your staging/production " \
               "environment and make sure some actions are performed. " \
-              "AppSignal should pick up your app after a few minutes."
+              "AppSignal will pick up your app after a few minutes."
           else
-            puts "  Sending example data to AppSignal..."
+            puts "Sending example data to AppSignal..."
             if Appsignal::Demo.transmit
               puts "  Example data sent!"
               puts "  It may take about a minute for the data to appear on https://appsignal.com/accounts"
-              puts
-              puts "  Please return to your browser and follow the instructions."
             else
-              puts "  Couldn't start the AppSignal agent and send example data to AppSignal.com"
-              puts "  Please use `appsignal diagnose` to debug your configuration."
+              print colorize "Error:", :red
+              puts " Couldn't start the AppSignal agent and send example data to AppSignal.com"
+              puts "  Please contact us at support@appsignal.com and " \
+                "send us a diagnose report using `appsignal diagnose`."
+              return
             end
           end
+          puts
+          puts "Please return to your browser and follow the instructions."
         end
 
         def installed_frameworks
@@ -281,7 +311,7 @@ module Appsignal
         def framework_available?(framework_file)
           require framework_file
           true
-        rescue LoadError
+        rescue LoadError, NameError
           false
         end
 

data/lib/appsignal/config.rb

@@ -212,7 +212,7 @@ module Appsignal
     # Initialize a new configuration object for AppSignal.
     #
     # @param root_path [String] Root path of the app.
-    # @param env [String] The environment to load when AppSignal is started. It
+    # @param initial_env [String] The environment to load when AppSignal is started. It
     #   will look for an environment with this name in the `config/appsignal.yml`
     #   config file.
     # @param initial_config [Hash<String, Object>] The initial configuration to
@@ -622,8 +622,12 @@ module Appsignal
         @config.root_path
       end
 
-      def app_path=(path)
-        @config.root_path = path
+      def app_path=(_path)
+        Appsignal::Utils::StdoutAndLoggerMessage.warning \
+          "The `Appsignal.configure`'s `app_path=` writer is deprecated " \
+            "and can no longer be used to set the root path. " \
+            "Use the `Appsignal.configure`'s method `root_path` keyword argument " \
+            "to set the root path."
       end
 
       def env

data/lib/appsignal/helpers/instrumentation.rb

@@ -309,6 +309,11 @@ module Appsignal
         tags = nil,
         namespace = Appsignal::Transaction::HTTP_REQUEST
       )
+        stdout_and_logger_warning \
+          "The `Appsignal.listen_for_error` helper is deprecated. " \
+            "Please use `rescue => error` and `Appsignal.report_error` instead. " \
+            "Read our exception handling documentation: " \
+            "https://docs.appsignal.com/ruby/instrumentation/exception-handling.html"
         yield
       rescue Exception => error # rubocop:disable Lint/RescueException
         send_error(error) do |transaction|

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appsignal
-  VERSION = "3.12.5"
+  VERSION = "3.12.6"
 end

data/lib/appsignal.rb

@@ -228,24 +228,28 @@ module Appsignal
     #   # Or for the environment given as an argument
     #   Appsignal.configure(:production)
     #
+    # @param env [String, Symbol] The environment to load.
+    # @param root_path [String] The path to look the `config/appsignal.yml` config file in.
+    #   Defaults to the current working directory.
     # @yield [Config] Gives the {Config} instance to the block.
     # @return [void]
     # @see config
     # @see Config
     # @see https://docs.appsignal.com/ruby/configuration.html Configuration guide
     # @see https://docs.appsignal.com/ruby/configuration/options.html Configuration options
-    def configure(env = nil)
+    def configure(env = nil, root_path: nil)
       if Appsignal.started?
         Appsignal.internal_logger
           .warn("AppSignal is already started. Ignoring `Appsignal.configure` call.")
         return
       end
 
-      if config && (env.nil? || config.env == env.to_s)
+      if config && ((env.nil? || config.env == env.to_s) &&
+          (root_path.nil? || config.root_path == root_path))
         config
       else
         @config = Config.new(
-          Config.determine_root_path,
+          root_path || Config.determine_root_path,
           Config.determine_env(env),
           {},
           Appsignal.internal_logger,

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

@@ -30,7 +30,7 @@ describe Appsignal::CLI::Install do
 
   define :include_complete_install do
     match do |actual|
-      actual.include?("AppSignal installation complete")
+      actual.include?("Please return to your browser and follow the instructions.")
     end
   end
 
@@ -105,7 +105,7 @@ describe Appsignal::CLI::Install do
         run
 
         expect(output).to include "Problem encountered:",
-          "No push API key entered"
+          "No Push API key entered"
       end
     end
 
@@ -120,7 +120,7 @@ describe Appsignal::CLI::Install do
           choose_environment_config
           run
 
-          expect(output).to include("Validating API key...", "API key valid")
+          expect(output).to include("Validating Push API key...", "Push API key valid")
         end
       end
 
@@ -129,7 +129,7 @@ describe Appsignal::CLI::Install do
 
         it "prints an error" do
           run
-          expect(output).to include "API key 'my_key' is not valid"
+          expect(output).to include "Push API key 'my_key' is not valid"
         end
       end
 
@@ -140,7 +140,7 @@ describe Appsignal::CLI::Install do
 
         it "prints an error" do
           run
-          expect(output).to include "There was an error validating your API key"
+          expect(output).to include "There was an error validating your Push API key"
         end
       end
     end
@@ -419,14 +419,16 @@ describe Appsignal::CLI::Install do
           expect(File.exist?(File.join(config_dir, "application.rb"))).to eql(false)
         end
 
-        it "fails the installation" do
+        it "falls back on the unknown framework installation" do
+          enter_app_name app_name
+          choose_environment_config
           run
 
-          expect(output).to include("We could not detect which framework you are using.")
+          expect(output)
+            .to include("\e[31mWarning: We could not detect which framework you are using\e[0m")
           expect(output).to_not include("Installing for Ruby on Rails")
+          expect(output).to include_env_push_api_key(push_api_key)
           expect(output).to include_complete_install
-
-          expect(File.exist?(config_file_path)).to be(false)
         end
       end
 
@@ -465,8 +467,10 @@ describe Appsignal::CLI::Install do
         let(:installation_instructions) do
           [
             "Installing for Sinatra",
-            "Sinatra requires some manual configuration.",
-            "require 'appsignal/integrations/sinatra'",
+            "Sinatra apps requires some manual setup.",
+            %(require "appsignal"),
+            "Appsignal.load(:sinatra)",
+            "Appsignal.start",
             "https://docs.appsignal.com/ruby/integrations/sinatra.html"
           ]
         end
@@ -533,7 +537,10 @@ describe Appsignal::CLI::Install do
         let(:installation_instructions) do
           [
             "Installing for Padrino",
-            "Padrino requires some manual configuration.",
+            "Padrino apps requires some manual setup.",
+            %(require "appsignal"),
+            "Appsignal.load(:padrino)",
+            "Appsignal.start",
             "https://docs.appsignal.com/ruby/integrations/padrino.html"
           ]
         end
@@ -600,7 +607,7 @@ describe Appsignal::CLI::Install do
         let(:installation_instructions) do
           [
             "Installing for Grape",
-            "Manual Grape configuration needed",
+            "Grape apps require some manual setup.",
             "https://docs.appsignal.com/ruby/integrations/grape.html"
           ]
         end
@@ -624,6 +631,7 @@ describe Appsignal::CLI::Install do
           it "completes the installation" do
             run
 
+            puts output
             expect(output).to include(*installation_instructions)
             expect(output).to include_complete_install
           end
@@ -667,7 +675,10 @@ describe Appsignal::CLI::Install do
         let(:installation_instructions) do
           [
             "Installing for Hanami",
-            "Hanami requires some manual configuration.",
+            "Hanami apps requires some manual setup.",
+            %(require "appsignal"),
+            "Appsignal.load(:hanami)",
+            "Appsignal.start",
             "https://docs.appsignal.com/ruby/integrations/hanami.html"
           ]
         end
@@ -728,47 +739,109 @@ describe Appsignal::CLI::Install do
       !hanami2_present?
     context "with unknown framework" do
       let(:push_api_key) { "my_key" }
+      let(:app_name) { "Test app" }
 
-      it_behaves_like "windows installation"
       it_behaves_like "push_api_key validation"
-      it_behaves_like "demo data"
+      it_behaves_like "requires an application name"
+
+      describe "unknown framework specific tests" do
+        let(:installation_instructions) do
+          [
+            "Installing",
+            "\e[31mWarning: We could not detect which framework you are using\e[0m",
+            "Some manual installation is most likely required.",
+            "https://docs.appsignal.com/ruby/integrations.html"
+          ]
+        end
+        before { enter_app_name app_name }
 
-      context "without color options" do
-        let(:options) { {} }
+        describe "configuration with environment variables" do
+          before { choose_environment_config }
 
-        it "prints the instructions in color" do
-          run
-          expect(output).to have_colorized_text(:green, "## Starting AppSignal Installer      ##")
+          it_behaves_like "windows installation"
+          it_behaves_like "capistrano install"
+          it_behaves_like "demo data"
+
+          it "prints environment variables" do
+            run
+
+            expect(output).to include_env_push_api_key(push_api_key)
+            expect(output).to include_env_app_name(app_name)
+          end
+
+          it "completes the installation" do
+            run
+
+            expect(output).to include(*installation_instructions)
+            expect(output).to include_complete_install
+          end
         end
-      end
 
-      context "with --color option" do
-        let(:options) { { "color" => nil } }
+        describe "configure with a configuration file" do
+          before { choose_config_file }
 
-        it "prints the instructions in color" do
-          run
-          expect(output).to have_colorized_text(:green, "## Starting AppSignal Installer      ##")
+          it_behaves_like "windows installation"
+          it_behaves_like "capistrano install"
+          it_behaves_like "demo data"
+
+          it "writes configuration to file" do
+            run
+            expect(output).to include_file_config
+            expect(config_file).to configure_app_name(app_name)
+            expect(config_file).to configure_push_api_key(push_api_key)
+            expect(config_file).to configure_environment("development")
+            expect(config_file).to configure_environment("staging")
+            expect(config_file).to configure_environment("production")
+          end
+
+          it "completes the installation" do
+            run
+
+            expect(output).to include(*installation_instructions)
+            expect(output).to include_complete_install
+          end
         end
       end
 
-      context "with --no-color option" do
-        let(:options) { { "no-color" => nil } }
+      describe "color flag" do
+        before do
+          enter_app_name "Test app"
+          choose_environment_config
+        end
 
-        it "prints the instructions without special colors" do
-          run
-          expect(output).to include("Starting AppSignal Installer")
-          expect(output).to_not have_color_markers
+        context "without color options" do
+          let(:options) { {} }
+
+          it "prints the instructions in color" do
+            run
+            expect(output).to have_colorized_text(
+              :green,
+              "## Starting AppSignal Installer           ##"
+            )
+          end
         end
-      end
 
-      it "prints a message about unknown framework" do
-        run
+        context "with --color option" do
+          let(:options) { { "color" => nil } }
 
-        expect(output).to include \
-          "\e[31mWarning:\e[0m We could not detect which framework you are using."
-        expect(output).to_not include_env_push_api_key
-        expect(output).to_not include_env_app_name
-        expect(File.exist?(config_file_path)).to be_falsy
+          it "prints the instructions in color" do
+            run
+            expect(output).to have_colorized_text(
+              :green,
+              "## Starting AppSignal Installer           ##"
+            )
+          end
+        end
+
+        context "with --no-color option" do
+          let(:options) { { "no-color" => nil } }
+
+          it "prints the instructions without special colors" do
+            run
+            expect(output).to include("## Starting AppSignal Installer           ##")
+            expect(output).to_not have_color_markers
+          end
+        end
       end
     end
   end

data/spec/lib/appsignal/config_spec.rb

@@ -1439,5 +1439,29 @@ describe Appsignal::Config do
 
       expect(dsl.cpu_count).to eq(1.0)
     end
+
+    describe "#app_path=" do
+      it "prints a deprecation warning" do
+        err_stream = std_stream
+        capture_std_streams(std_stream, err_stream) do
+          dsl.app_path = "foo"
+        end
+
+        expect(err_stream.read).to include(
+          "appsignal WARNING: The `Appsignal.configure`'s `app_path=` writer is deprecated"
+        )
+      end
+
+      it "logs a deprecation warning" do
+        logs = capture_logs do
+          silence { dsl.app_path = "foo" }
+        end
+
+        expect(logs).to contains_log(
+          :warn,
+          "The `Appsignal.configure`'s `app_path=` writer is deprecated"
+        )
+      end
+    end
   end
 end

data/spec/lib/appsignal_spec.rb

@@ -125,6 +125,28 @@ describe Appsignal do
         expect(Appsignal.config[:push_api_key]).to eq("key")
       end
 
+      it "loads a new config if the path is not the same" do
+        Appsignal._config = Appsignal::Config.new(
+          "/some/path",
+          :my_env,
+          :name => "Some name",
+          :push_api_key => "Some key",
+          :ignore_actions => ["My action"]
+        )
+
+        Appsignal.configure(:my_env, :root_path => project_fixture_path) 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
+
       it "calls configure if not started yet" do
         Appsignal.configure(:my_env) do |config|
           config.active = false
@@ -165,6 +187,16 @@ describe Appsignal do
         expect(Appsignal.config.env).to eq("env_arg")
       end
 
+      it "uses the given root path to read the config file" do
+        Appsignal.configure(:test, :root_path => project_fixture_path)
+
+        Appsignal.start
+        expect(Appsignal.config.env).to eq("test")
+        expect(Appsignal.config[:push_api_key]).to eq("abc")
+        # Ensure it loads from the config file in the given path
+        expect(Appsignal.config.file_config).to_not be_empty
+      end
+
       it "loads the config without a block being given" do
         Dir.chdir project_fixture_path do
           Appsignal.configure(:test)
@@ -172,6 +204,8 @@ describe Appsignal do
 
         expect(Appsignal.config.env).to eq("test")
         expect(Appsignal.config[:push_api_key]).to eq("abc")
+        # Ensure it loads from the config file in the current working directory
+        expect(Appsignal.config.file_config).to_not be_empty
       end
 
       it "allows customization of config in the block" do
@@ -1571,6 +1605,24 @@ describe Appsignal do
     describe ".listen_for_error" do
       around { |example| keep_transactions { example.run } }
 
+      it "prints and logs a deprecation warning" do
+        err_stream = std_stream
+        logs =
+          capture_logs do
+            capture_std_streams(std_stream, err_stream) do
+              Appsignal.listen_for_error do
+                # Do nothing
+              end
+            end
+          end
+        expect(err_stream.read)
+          .to include("appsignal WARNING: The `Appsignal.listen_for_error` helper is deprecated.")
+        expect(logs).to contains_log(
+          :warn,
+          "The `Appsignal.listen_for_error` helper is deprecated."
+        )
+      end
+
       it "records the error and re-raise it" do
         expect do
           expect do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 3.12.5
+  version: 3.12.6
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-01 00:00:00.000000000 Z
+date: 2024-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -488,7 +488,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.14
 signing_key:
 specification_version: 4
 summary: Logs performance and exception data from your app to appsignal.com