appsignal 3.4.11-java → 3.4.13-java

data/lib/appsignal/integrations/railtie.rb

@@ -36,9 +36,14 @@ module Appsignal
 
         Appsignal.start
 
-        if Appsignal.config[:enable_rails_error_reporter] && Rails.respond_to?(:error) # rubocop:disable Style/GuardClause
-          Rails.error.subscribe(Appsignal::Integrations::RailsErrorReporterSubscriber)
-        end
+        initialize_error_reporter
+      end
+
+      def self.initialize_error_reporter
+        return unless Appsignal.config[:enable_rails_error_reporter]
+        return unless Rails.respond_to?(:error)
+
+        Rails.error.subscribe(Appsignal::Integrations::RailsErrorReporterSubscriber)
       end
     end
 

data/lib/appsignal/transaction.rb

@@ -320,7 +320,14 @@ module Appsignal
     end
 
     def set_sample_data(key, data)
-      return unless key && data && (data.is_a?(Array) || data.is_a?(Hash))
+      return unless key && data
+
+      if !data.is_a?(Array) && !data.is_a?(Hash)
+        Appsignal.logger.error(
+          "Invalid sample data for '#{key}'. Value is not an Array or Hash: '#{data.inspect}'"
+        )
+        return
+      end
 
       @ext.set_sample_data(
         key.to_s,

data/lib/appsignal/version.rb

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

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

@@ -781,6 +781,9 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
               "file" => {},
               "env" => {},
               "override" => { "send_session_data" => true }
+            },
+            "modifiers" => {
+              "APPSIGNAL_INACTIVE_ON_CONFIG_FILE_ERROR" => ""
             }
           )
         end
@@ -912,6 +915,28 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
           end
         end
 
+        describe "modifiers" do
+          before do
+            ENV["APPSIGNAL_INACTIVE_ON_CONFIG_FILE_ERROR"] = "1"
+            run
+          end
+
+          it "outputs config modifiers" do
+            expect(output).to include(
+              "Configuration modifiers\n" \
+                "  APPSIGNAL_INACTIVE_ON_CONFIG_FILE_ERROR: \"1\""
+            )
+          end
+
+          it "transmits config modifiers in report" do
+            expect(received_report["config"]).to include(
+              "modifiers" => {
+                "APPSIGNAL_INACTIVE_ON_CONFIG_FILE_ERROR" => "1"
+              }
+            )
+          end
+        end
+
         it "transmits config in report" do
           run
           additional_initial_config = {}
@@ -935,6 +960,9 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
               "file" => hash_with_string_keys(config.file_config),
               "env" => {},
               "override" => { "send_session_data" => true }
+            },
+            "modifiers" => {
+              "APPSIGNAL_INACTIVE_ON_CONFIG_FILE_ERROR" => ""
             }
           )
         end
@@ -963,6 +991,9 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
               "file" => hash_with_string_keys(config.file_config),
               "env" => {},
               "override" => { "send_session_data" => true }
+            },
+            "modifiers" => {
+              "APPSIGNAL_INACTIVE_ON_CONFIG_FILE_ERROR" => ""
             }
           )
         end

data/spec/lib/appsignal/config_spec.rb

@@ -294,19 +294,48 @@ describe Appsignal::Config do
       end
       let(:config) { Appsignal::Config.new(config_path, "foo") }
 
-      it "logs & prints an error, skipping the file source" do
-        stdout = std_stream
-        stderr = std_stream
-        log = capture_logs { capture_std_streams(stdout, stderr) { config } }
-        message = "An error occured while loading the AppSignal config file. " \
-          "Skipping file config.\n" \
-          "File: #{File.join(config_path, "config", "appsignal.yml").inspect}\n" \
-          "KeyError: key not found"
-        expect(log).to contains_log :error, message
-        expect(log).to include("/appsignal/config.rb:") # Backtrace
-        expect(stdout.read).to_not include("appsignal:")
-        expect(stderr.read).to include "appsignal: #{message}"
-        expect(config.file_config).to eql({})
+      context "when APPSIGNAL_INACTIVE_ON_CONFIG_FILE_ERROR is not set" do
+        it "logs & prints an error, skipping the file source" do
+          stdout = std_stream
+          stderr = std_stream
+          log = capture_logs { capture_std_streams(stdout, stderr) { config } }
+          message = "An error occured while loading the AppSignal config file. " \
+            "Skipping file config. " \
+            "In future versions AppSignal will not start on a config file " \
+            "error. To opt-in to this new behavior set " \
+            "'APPSIGNAL_INACTIVE_ON_CONFIG_FILE_ERROR=1' in your system " \
+            "environment.\n" \
+            "File: #{File.join(config_path, "config", "appsignal.yml").inspect}\n" \
+            "KeyError: key not found"
+          expect(log).to contains_log :error, message
+          expect(log).to include("/appsignal/config.rb:") # Backtrace
+          expect(stdout.read).to_not include("appsignal:")
+          expect(stderr.read).to include "appsignal: #{message}"
+          expect(config.file_config).to eql({})
+        end
+      end
+
+      context "when APPSIGNAL_INACTIVE_ON_CONFIG_FILE_ERROR=1 is set" do
+        it "does not start AppSignal, logs & prints an error" do
+          stdout = std_stream
+          stderr = std_stream
+          ENV["APPSIGNAL_ACTIVE"] = "true"
+          ENV["APPSIGNAL_APP_NAME"] = "My app"
+          ENV["APPSIGNAL_APP_ENV"] = "dev"
+          ENV["APPSIGNAL_PUSH_API_KEY"] = "something valid"
+          ENV["APPSIGNAL_INACTIVE_ON_CONFIG_FILE_ERROR"] = "1"
+          log = capture_logs { capture_std_streams(stdout, stderr) { config } }
+          message = "An error occured while loading the AppSignal config file. " \
+            "Not starting AppSignal because APPSIGNAL_INACTIVE_ON_CONFIG_FILE_ERROR is set.\n" \
+            "File: #{File.join(config_path, "config", "appsignal.yml").inspect}\n" \
+            "KeyError: key not found"
+          expect(log).to contains_log :error, message
+          expect(log).to include("/appsignal/config.rb:") # Backtrace
+          expect(stdout.read).to_not include("appsignal:")
+          expect(stderr.read).to include "appsignal: #{message}"
+          expect(config.file_config).to eql({})
+          expect(config.active?).to be(false)
+        end
       end
     end
 

data/spec/lib/appsignal/event_formatter/rom/sql_formatter_spec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+describe Appsignal::EventFormatter::Rom::SqlFormatter do
+  let(:klass) { described_class }
+  let(:formatter) { klass.new }
+
+  it "registers the sql event formatter" do
+    expect(Appsignal::EventFormatter.registered?("sql.dry", klass)).to be_truthy
+  end
+
+  describe "#format" do
+    let(:payload) do
+      {
+        :name => "postgres",
+        :query => "SELECT * FROM users"
+      }
+    end
+    subject { formatter.format(payload) }
+
+    it { is_expected.to eq ["query.postgres", "SELECT * FROM users", 1] }
+  end
+end

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

@@ -22,6 +22,12 @@ describe Appsignal::Hooks::ActiveSupportNotificationsHook do
 
     it_behaves_like "activesupport instrument override"
 
+    if defined?(::ActiveSupport::Notifications::Fanout::Handle)
+      require_relative "./active_support_notifications/start_finish_shared_examples"
+
+      it_behaves_like "activesupport start finish override"
+    end
+
     if ::ActiveSupport::Notifications::Instrumenter.method_defined?(:start)
       require_relative "./active_support_notifications/start_finish_shared_examples"
 

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

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+if DependencyHelper.dry_monitor_present?
+  require "dry-monitor"
+
+  describe Appsignal::Hooks::DryMonitorHook do
+    describe "#dependencies_present?" do
+      subject { described_class.new.dependencies_present? }
+
+      context "when Dry::Monitor::Notifications constant is found" do
+        before { stub_const "Dry::Monitor::Notifications", Class.new }
+
+        it { is_expected.to be_truthy }
+      end
+
+      context "when Dry::Monitor::Notifications constant is not found" do
+        before { hide_const "Dry::Monitor::Notifications" }
+
+        it { is_expected.to be_falsy }
+      end
+    end
+  end
+
+  describe "#install" do
+    it "installs the dry-monitor hook" do
+      start_agent
+
+      expect(Dry::Monitor::Notifications.included_modules).to include(
+        Appsignal::Integrations::DryMonitorIntegration
+      )
+    end
+  end
+
+  describe "Dry Monitor Integration" do
+    before :context do
+      start_agent
+    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
+        {
+          :name => "postgres",
+          :query => "SELECT * FROM users"
+        }
+      end
+
+      it "creates an sql event" do
+        notifications.instrument(event_id, payload)
+        expect(transaction.to_h["events"]).to match([
+          {
+            "allocation_count" => kind_of(Integer),
+            "body" => "SELECT * FROM users",
+            "body_format" => Appsignal::EventFormatter::SQL_BODY_FORMAT,
+            "child_allocation_count" => kind_of(Integer),
+            "child_duration" => kind_of(Float),
+            "child_gc_duration" => kind_of(Float),
+            "count" => 1,
+            "duration" => kind_of(Float),
+            "gc_duration" => kind_of(Float),
+            "name" => "query.postgres",
+            "start" => kind_of(Float),
+            "title" => "query.postgres"
+          }
+        ])
+      end
+    end
+
+    context "when is an unregistered formatter event" do
+      let(:event_id) { :foo }
+      let(:payload) do
+        {
+          :name => "foo"
+        }
+      end
+
+      it "creates a generic event" do
+        notifications.instrument(event_id, payload)
+        expect(transaction.to_h["events"]).to match([
+          {
+            "allocation_count" => kind_of(Integer),
+            "body" => "",
+            "body_format" => Appsignal::EventFormatter::DEFAULT,
+            "child_allocation_count" => kind_of(Integer),
+            "child_duration" => kind_of(Float),
+            "child_gc_duration" => kind_of(Float),
+            "count" => 1,
+            "duration" => kind_of(Float),
+            "gc_duration" => kind_of(Float),
+            "name" => "foo",
+            "start" => kind_of(Float),
+            "title" => ""
+          }
+        ])
+      end
+    end
+  end
+end

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

@@ -2,6 +2,10 @@ if DependencyHelper.rails_present?
   require "action_mailer"
 
   describe Appsignal::Integrations::Railtie do
+    include RailsHelper
+
+    after { clear_rails_error_reporter! }
+
     context "after initializing the app" do
       it "should call initialize_appsignal" do
         expect(Appsignal::Integrations::Railtie).to receive(:initialize_appsignal)
@@ -125,17 +129,16 @@ if DependencyHelper.rails_present?
 
       if Rails.respond_to?(:error)
         describe "Rails error reporter" do
-          before do
-            Appsignal::Integrations::Railtie.initialize_appsignal(app)
-            start_agent
-          end
+          before { start_agent }
           around { |example| keep_transactions { example.run } }
 
           context "when error is not handled (reraises the error)" do
             it "does nothing" do
-              expect do
-                Rails.error.record { raise ExampleStandardError }
-              end.to raise_error(ExampleStandardError)
+              with_rails_error_reporter do
+                expect do
+                  Rails.error.record { raise ExampleStandardError }
+                end.to raise_error(ExampleStandardError)
+              end
 
               expect(created_transactions).to be_empty
             end
@@ -151,26 +154,28 @@ if DependencyHelper.rails_present?
                   :duplicated_tag => "duplicated value"
                 )
 
-                with_current_transaction current_transaction do
-                  Rails.error.handle { raise ExampleStandardError }
-
-                  transaction = last_transaction
-                  transaction_hash = transaction.to_h
-                  expect(transaction_hash).to include(
-                    "action" => "CustomAction",
-                    "namespace" => "custom",
-                    "error" => {
-                      "name" => "ExampleStandardError",
-                      "message" => "ExampleStandardError",
-                      "backtrace" => kind_of(String)
-                    },
-                    "sample_data" => hash_including(
-                      "tags" => {
-                        "duplicated_tag" => "duplicated value",
-                        "severity" => "warning"
-                      }
+                with_rails_error_reporter do
+                  with_current_transaction current_transaction do
+                    Rails.error.handle { raise ExampleStandardError }
+
+                    transaction = last_transaction
+                    transaction_hash = transaction.to_h
+                    expect(transaction_hash).to include(
+                      "action" => "CustomAction",
+                      "namespace" => "custom",
+                      "error" => {
+                        "name" => "ExampleStandardError",
+                        "message" => "ExampleStandardError",
+                        "backtrace" => kind_of(String)
+                      },
+                      "sample_data" => hash_including(
+                        "tags" => hash_including(
+                          "duplicated_tag" => "duplicated value",
+                          "severity" => "warning"
+                        )
+                      )
                     )
-                  )
+                  end
                 end
               end
 
@@ -178,48 +183,52 @@ if DependencyHelper.rails_present?
                 current_transaction = http_request_transaction
                 current_transaction.set_tags(:tag1 => "duplicated value")
 
-                with_current_transaction current_transaction do
-                  given_context = { :tag1 => "value1", :tag2 => "value2" }
-                  Rails.error.handle(:context => given_context) { raise ExampleStandardError }
-
-                  transaction = last_transaction
-                  transaction_hash = transaction.to_h
-                  expect(transaction_hash).to include(
-                    "sample_data" => hash_including(
-                      "tags" => {
-                        "tag1" => "value1",
-                        "tag2" => "value2",
-                        "severity" => "warning"
-                      }
+                with_rails_error_reporter do
+                  with_current_transaction current_transaction do
+                    given_context = { :tag1 => "value1", :tag2 => "value2" }
+                    Rails.error.handle(:context => given_context) { raise ExampleStandardError }
+
+                    transaction = last_transaction
+                    transaction_hash = transaction.to_h
+                    expect(transaction_hash).to include(
+                      "sample_data" => hash_including(
+                        "tags" => hash_including(
+                          "tag1" => "value1",
+                          "tag2" => "value2",
+                          "severity" => "warning"
+                        )
+                      )
                     )
-                  )
+                  end
                 end
               end
 
               it "sends tags stored in :appsignal -> :custom_data as custom data" do
                 current_transaction = http_request_transaction
 
-                with_current_transaction current_transaction do
-                  given_context = {
-                    :appsignal => {
-                      :custom_data => {
-                        :array => [1, 2],
-                        :hash => { :one => 1, :two => 2 }
+                with_rails_error_reporter do
+                  with_current_transaction current_transaction do
+                    given_context = {
+                      :appsignal => {
+                        :custom_data => {
+                          :array => [1, 2],
+                          :hash => { :one => 1, :two => 2 }
+                        }
                       }
                     }
-                  }
-                  Rails.error.handle(:context => given_context) { raise ExampleStandardError }
-
-                  transaction = last_transaction
-                  transaction_hash = transaction.to_h
-                  expect(transaction_hash).to include(
-                    "sample_data" => hash_including(
-                      "custom_data" => {
-                        "array" => [1, 2],
-                        "hash" => { "one" => 1, "two" => 2 }
-                      }
+                    Rails.error.handle(:context => given_context) { raise ExampleStandardError }
+
+                    transaction = last_transaction
+                    transaction_hash = transaction.to_h
+                    expect(transaction_hash).to include(
+                      "sample_data" => hash_including(
+                        "custom_data" => {
+                          "array" => [1, 2],
+                          "hash" => { "one" => 1, "two" => 2 }
+                        }
+                      )
                     )
-                  )
+                  end
                 end
               end
 
@@ -228,18 +237,20 @@ if DependencyHelper.rails_present?
                 current_transaction.set_namespace "custom"
                 current_transaction.set_action "CustomAction"
 
-                with_current_transaction current_transaction do
-                  given_context = {
-                    :appsignal => { :namespace => "context", :action => "ContextAction" }
-                  }
-                  Rails.error.handle(:context => given_context) { raise ExampleStandardError }
+                with_rails_error_reporter do
+                  with_current_transaction current_transaction do
+                    given_context = {
+                      :appsignal => { :namespace => "context", :action => "ContextAction" }
+                    }
+                    Rails.error.handle(:context => given_context) { raise ExampleStandardError }
 
-                  transaction = last_transaction
-                  transaction_hash = transaction.to_h
-                  expect(transaction_hash).to include(
-                    "namespace" => "context",
-                    "action" => "ContextAction"
-                  )
+                    transaction = last_transaction
+                    transaction_hash = transaction.to_h
+                    expect(transaction_hash).to include(
+                      "namespace" => "context",
+                      "action" => "ContextAction"
+                    )
+                  end
                 end
               end
             end
@@ -267,7 +278,9 @@ if DependencyHelper.rails_present?
               it "fetches the action from the controller in the context" do
                 # The controller key is set by Rails when raised in a controller
                 given_context = { :controller => ExampleRailsControllerMock.new }
-                Rails.error.handle(:context => given_context) { raise ExampleStandardError }
+                with_rails_error_reporter do
+                  Rails.error.handle(:context => given_context) { raise ExampleStandardError }
+                end
 
                 transaction = last_transaction
                 transaction_hash = transaction.to_h
@@ -278,7 +291,9 @@ if DependencyHelper.rails_present?
 
               it "sets no action if no execution context is present" do
                 # The controller key is set by Rails when raised in a controller
-                Rails.error.handle { raise ExampleStandardError }
+                with_rails_error_reporter do
+                  Rails.error.handle { raise ExampleStandardError }
+                end
 
                 transaction = last_transaction
                 transaction_hash = transaction.to_h
@@ -296,17 +311,19 @@ if DependencyHelper.rails_present?
                 :tag1 => "value1",
                 :tag2 => "value2"
               }
-              Rails.error.handle(:context => given_context) { raise ExampleStandardError }
+              with_rails_error_reporter do
+                Rails.error.handle(:context => given_context) { raise ExampleStandardError }
+              end
 
               transaction = last_transaction
               transaction_hash = transaction.to_h
               expect(transaction_hash).to include(
                 "sample_data" => hash_including(
-                  "tags" => {
+                  "tags" => hash_including(
                     "tag1" => "value1",
                     "tag2" => "value2",
                     "severity" => "warning"
-                  }
+                  )
                 )
               )
             end

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

@@ -266,13 +266,16 @@ describe Appsignal::Integrations::SidekiqMiddleware, :with_yaml_parse_error => f
 
   if DependencyHelper.rails7_present?
     context "with Rails error reporter" do
+      include RailsHelper
+
       it "reports the worker name as the action, copies the namespace and tags" do
-        Appsignal::Integrations::Railtie.initialize_appsignal(MyApp::Application.new)
         Appsignal.config = project_fixture_config("production")
-        perform_job do
-          Appsignal.tag_job("test_tag" => "value")
-          Rails.error.handle do
-            raise error, "uh oh"
+        with_rails_error_reporter do
+          perform_job do
+            Appsignal.tag_job("test_tag" => "value")
+            Rails.error.handle do
+              raise ExampleStandardError, "uh oh"
+            end
           end
         end
 
@@ -363,7 +366,9 @@ if DependencyHelper.active_job_present?
   require "sidekiq/testing"
 
   describe "Sidekiq ActiveJob integration" do
+    include RailsHelper
     include ActiveJobHelpers
+
     let(:namespace) { Appsignal::Transaction::BACKGROUND_JOB }
     let(:time) { Time.parse("2001-01-01 10:00:00UTC") }
     let(:log) { StringIO.new }
@@ -416,7 +421,7 @@ if DependencyHelper.active_job_present?
         ["perform_job.sidekiq", "perform_start.active_job", "perform.active_job"]
       end
     end
-    before do
+    around do |example|
       start_agent
       Appsignal.logger = test_logger(log)
       ActiveJob::Base.queue_adapter = :sidekiq
@@ -441,11 +446,11 @@ if DependencyHelper.active_job_present?
       Sidekiq::Testing.server_middleware do |chain|
         chain.add Appsignal::Integrations::SidekiqMiddleware
       end
-    end
-    around do |example|
-      keep_transactions do
-        Sidekiq::Testing.fake! do
-          example.run
+      with_rails_error_reporter do
+        keep_transactions do
+          Sidekiq::Testing.fake! do
+            example.run
+          end
         end
       end
     end

data/spec/lib/appsignal/transaction_spec.rb

@@ -688,6 +688,8 @@ describe Appsignal::Transaction do
           transaction.set_sample_data("params", "string")
 
           expect(transaction.to_h["sample_data"]).to eq({})
+          expect(log_contents(log)).to contains_log :error,
+            %(Invalid sample data for 'params'. Value is not an Array or Hash: '"string"')
         end
       end
 

data/spec/support/helpers/dependency_helper.rb

@@ -115,6 +115,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/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