appsignal 3.0.18-java → 3.0.21-java

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

@@ -251,14 +251,14 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
 
       it "adds the installation report to the diagnostics report" do
         run
-        jruby = DependencyHelper.running_jruby?
+        jruby = Appsignal::System.jruby?
         expect(received_report["installation"]).to match(
           "result" => {
             "status" => "success"
           },
           "language" => {
             "name" => "ruby",
-            "version" => "#{rbconfig["ruby_version"]}-p#{rbconfig["PATCHLEVEL"]}",
+            "version" => "#{rbconfig["RUBY_PROGRAM_VERSION"]}-p#{rbconfig["PATCHLEVEL"]}",
             "implementation" => jruby ? "jruby" : "ruby"
           },
           "download" => {
@@ -295,7 +295,7 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
           "  Status: success",
           "Language details",
           "  Implementation: \"#{jruby ? "jruby" : "ruby"}\"",
-          "  Ruby version: \"#{"#{rbconfig["ruby_version"]}-p#{rbconfig["PATCHLEVEL"]}"}\"",
+          "  Ruby version: \"#{"#{rbconfig["RUBY_PROGRAM_VERSION"]}-p#{rbconfig["PATCHLEVEL"]}"}\"",
           "Download details",
           "  Download URL: \"https://",
           "  Checksum: \"verified\"",
@@ -321,7 +321,7 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
           expect(File).to receive(:read)
             .with(File.expand_path("../../../../../ext/install.report", __FILE__))
             .and_return(
-              YAML.dump(
+              JSON.generate(
                 "result" => {
                   "status" => "error",
                   "error" => "RuntimeError: some error",
@@ -384,8 +384,8 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
         end
       end
 
-      context "when report is invalid YAML" do
-        let(:raw_report) { "foo:\nbar" }
+      context "when report is invalid JSON" do
+        let(:raw_report) { "{}-" }
         before do
           allow(File).to receive(:read).and_call_original
           expect(File).to receive(:read)
@@ -604,7 +604,7 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
 
     describe "host information" do
       let(:rbconfig) { RbConfig::CONFIG }
-      let(:language_version) { "#{rbconfig["ruby_version"]}-p#{rbconfig["PATCHLEVEL"]}" }
+      let(:language_version) { "#{rbconfig["RUBY_PROGRAM_VERSION"]}-p#{rbconfig["PATCHLEVEL"]}" }
 
       it "outputs host information" do
         run
@@ -769,13 +769,14 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
         it "transmits validation in report" do
           default_config = hash_with_string_keys(Appsignal::Config::DEFAULT_CONFIG)
           expect(received_report["config"]).to eq(
-            "options" => default_config.merge("env" => ""),
+            "options" => default_config.merge("env" => "", "send_session_data" => true),
             "sources" => {
               "default" => default_config,
               "system" => {},
               "initial" => { "env" => "" },
               "file" => {},
-              "env" => {}
+              "env" => {},
+              "override" => { "send_session_data" => true }
             }
           )
         end
@@ -893,7 +894,8 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
               "system" => {},
               "initial" => hash_with_string_keys(config.initial_config.merge(additional_initial_config)),
               "file" => hash_with_string_keys(config.file_config),
-              "env" => {}
+              "env" => {},
+              "override" => { "send_session_data" => true }
             }
           )
         end
@@ -920,7 +922,8 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
               "system" => {},
               "initial" => hash_with_string_keys(config.initial_config),
               "file" => hash_with_string_keys(config.file_config),
-              "env" => {}
+              "env" => {},
+              "override" => { "send_session_data" => true }
             }
           )
         end

data/spec/lib/appsignal/config_spec.rb

@@ -69,8 +69,8 @@ describe Appsignal::Config do
           end
 
           it "sets the push_api_key as loaded through the env_config" do
-            expect(config.env_config).to eq(:push_api_key => "abc")
-            expect(config.system_config).to eq(:active => true)
+            expect(config.env_config).to include(:push_api_key => "abc")
+            expect(config.system_config).to include(:active => true)
           end
         end
 
@@ -82,8 +82,8 @@ describe Appsignal::Config do
           end
 
           it "sets the push_api_key as loaded through the env_config" do
-            expect(config.env_config).to eq(:push_api_key => "")
-            expect(config.system_config).to be_empty
+            expect(config.env_config).to include(:push_api_key => "")
+            expect(config.system_config).to_not have_key(:active)
           end
         end
 
@@ -95,8 +95,8 @@ describe Appsignal::Config do
           end
 
           it "sets the push_api_key as loaded through the env_config" do
-            expect(config.env_config).to eq(:push_api_key => " ")
-            expect(config.system_config).to be_empty
+            expect(config.env_config).to include(:push_api_key => " ")
+            expect(config.system_config).to_not have_key(:active)
           end
         end
       end
@@ -119,7 +119,7 @@ describe Appsignal::Config do
         end
 
         it "sets the log as loaded through the system" do
-          expect(config.system_config).to eq(:log => "stdout")
+          expect(config.system_config).to include(:log => "stdout")
         end
       end
 
@@ -129,7 +129,7 @@ describe Appsignal::Config do
         end
 
         it "does not set log as loaded through the system" do
-          expect(config.system_config).to eq({})
+          expect(config.system_config).to_not have_key(:log)
         end
       end
     end
@@ -177,7 +177,7 @@ describe Appsignal::Config do
         :revision                       => "v2.5.1",
         :send_environment_metadata      => true,
         :send_params                    => true,
-        :skip_session_data              => false,
+        :send_session_data              => true,
         :transaction_debug_mode         => false
       )
     end
@@ -434,6 +434,87 @@ describe Appsignal::Config do
     end
   end
 
+  describe "with config based on overrides" do
+    let(:log_stream) { StringIO.new }
+    let(:logger) { test_logger(log_stream) }
+    let(:logs) { log_contents(log_stream) }
+    let(:config) do
+      described_class.new(Dir.pwd, "production", config_options, logger)
+    end
+
+    describe "skip_session_data" do
+      let(:err_stream) { std_stream }
+      let(:stderr) { err_stream.read }
+      let(:deprecation_message) do
+        "The `skip_session_data` config option is deprecated. Please use " \
+          "`send_session_data` instead."
+      end
+      before do
+        capture_std_streams(std_stream, err_stream) { config }
+      end
+
+      context "when not set" do
+        let(:config_options) { {} }
+
+        it "sets the default send_session_data value" do
+          expect(config[:skip_session_data]).to be_nil
+          expect(config[:send_session_data]).to eq(true)
+          expect(config.override_config[:send_session_data]).to eq(true)
+        end
+
+        it "does not print a deprecation warning" do
+          expect(stderr).to_not include("appsignal WARNING: #{deprecation_message}")
+          expect(logs).to_not include(deprecation_message)
+        end
+      end
+
+      context "when set to true" do
+        let(:config_options) { { :skip_session_data => true } }
+
+        it "sets send_session_data if send_session_data is not set by the user" do
+          expect(config[:skip_session_data]).to eq(true)
+          expect(config[:send_session_data]).to eq(false)
+          expect(config.override_config[:send_session_data]).to eq(false)
+        end
+
+        it "prints a deprecation warning" do
+          expect(stderr).to include("appsignal WARNING: #{deprecation_message}")
+          expect(logs).to include(deprecation_message)
+        end
+      end
+
+      context "when set to false" do
+        let(:config_options) { { :skip_session_data => false } }
+
+        it "sets send_session_data if send_session_data is not set by the user" do
+          expect(config[:skip_session_data]).to eq(false)
+          expect(config[:send_session_data]).to eq(true)
+          expect(config.override_config[:send_session_data]).to eq(true)
+        end
+
+        it "prints a deprecation warning" do
+          expect(stderr).to include("appsignal WARNING: #{deprecation_message}")
+          expect(logs).to include(deprecation_message)
+        end
+      end
+
+      context "when skip_session_data and send_session_data are both set" do
+        let(:config_options) { { :skip_session_data => true, :send_session_data => true } }
+
+        it "does not overwrite the send_session_data value" do
+          expect(config[:skip_session_data]).to eq(true)
+          expect(config[:send_session_data]).to eq(true)
+          expect(config.override_config[:send_session_data]).to be_nil
+        end
+
+        it "prints a deprecation warning" do
+          expect(stderr).to include("appsignal WARNING: #{deprecation_message}")
+          expect(logs).to include(deprecation_message)
+        end
+      end
+    end
+  end
+
   describe "config keys" do
     describe ":endpoint" do
       subject { config[:endpoint] }
@@ -743,6 +824,54 @@ describe Appsignal::Config do
     end
   end
 
+  describe "#maintain_backwards_compatibility" do
+    let(:log_stream) { StringIO.new }
+    let(:logger) { test_logger(log_stream) }
+    let(:logs) { log_contents(log_stream) }
+    let(:config) do
+      described_class.new(Dir.pwd, "production", config_options, logger)
+    end
+
+    describe "working_dir_path" do
+      let(:err_stream) { std_stream }
+      let(:stderr) { err_stream.read }
+      let(:deprecation_message) do
+        "The `working_dir_path` option is deprecated, please use " \
+          "`working_directory_path` instead and specify the " \
+          "full path to the working directory"
+      end
+      before do
+        capture_std_streams(std_stream, err_stream) { config }
+      end
+
+      context "when not set" do
+        let(:config_options) { {} }
+
+        it "sets the default working_dir_path value" do
+          expect(config[:working_dir_path]).to be_nil
+        end
+
+        it "does not print a deprecation warning" do
+          expect(stderr).to_not include("appsignal WARNING: #{deprecation_message}")
+          expect(logs).to_not include(deprecation_message)
+        end
+      end
+
+      context "when set" do
+        let(:config_options) { { :working_dir_path => "/tmp/appsignal2" } }
+
+        it "sets the default working_dir_path value" do
+          expect(config[:working_dir_path]).to eq("/tmp/appsignal2")
+        end
+
+        it "does not print a deprecation warning" do
+          expect(stderr).to include("appsignal WARNING: #{deprecation_message}")
+          expect(logs).to include(deprecation_message)
+        end
+      end
+    end
+  end
+
   describe "#validate" do
     subject { config.valid? }
     let(:config) do

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

@@ -1,5 +1,5 @@
-describe Appsignal::EventFormatter::ActiveRecord::InstantiationFormatter do
-  let(:klass)     { Appsignal::EventFormatter::ActiveRecord::SqlFormatter }
+describe Appsignal::EventFormatter::ActiveRecord::SqlFormatter do
+  let(:klass)     { described_class }
   let(:formatter) { klass.new }
 
   it "should register sql.active_record" do

data/spec/lib/appsignal/event_formatter/mongo_ruby_driver/query_formatter_spec.rb

@@ -11,8 +11,12 @@ describe Appsignal::EventFormatter::MongoRubyDriver::QueryFormatter do
     end
 
     it "should apply a strategy for each key" do
+      # TODO: additional curly brackets required for issue
+      # https://github.com/rspec/rspec-mocks/issues/1460
+      # rubocop:disable Style/BracesAroundHashParameters
       expect(formatter).to receive(:apply_strategy)
-        .with(:sanitize_document, "_id" => 1)
+        .with(:sanitize_document, { "_id" => 1 })
+      # rubocop:enable Style/BracesAroundHashParameters
 
       expect(formatter).to receive(:apply_strategy)
         .with(:allow, "users")
@@ -47,57 +51,27 @@ describe Appsignal::EventFormatter::MongoRubyDriver::QueryFormatter do
       end
     end
 
-    context "when strategy is deny" do
-      let(:strategy) { :deny }
-      let(:value)    { { "_id" => 1 } }
-
-      it "should return a '?'" do
-        expect(formatter.apply_strategy(strategy, value)).to eql("?")
-      end
-    end
-
-    context "when strategy is deny_array" do
-      let(:strategy) { :deny_array }
-      let(:value)    { { "_id" => 1 } }
-
-      it "should return a sanitized array string" do
-        expect(formatter.apply_strategy(strategy, value)).to eql("[?]")
-      end
-    end
-
     context "when strategy is sanitize_document" do
       let(:strategy) { :sanitize_document }
-      let(:value)    { { "_id" => 1 } }
-
-      it "should return a sanitized document" do
-        expect(formatter.apply_strategy(strategy, value)).to eql("_id" => "?")
-      end
-    end
-
-    context "when strategy is sanitize_bulk" do
-      let(:strategy) { :sanitize_bulk }
-      let(:value)    { [{ "q" => { "_id" => 1 }, "u" => [{ "foo" => "bar" }] }] }
-
-      it "should return an array of sanitized bulk documents" do
-        expect(formatter.apply_strategy(strategy, value)).to eql([
-          { "q" => { "_id" => "?" }, "u" => "[?]" }
-        ])
+      let(:value) do
+        {
+          "_id" => 1,
+          "authors" => [
+            { "name" => "BarBaz" },
+            { "name" => "FooBar" },
+            { "name" => "BarFoo", "surname" => "Baz" }
+          ]
+        }
       end
 
-      context "when bulk has more than one update" do
-        let(:value) do
-          [
-            { "q" => { "_id" => 1 }, "u" => [{ "foo" => "bar" }] },
-            { "q" => { "_id" => 2 }, "u" => [{ "foo" => "baz" }] }
+      it "should return a sanitized document" do
+        expect(formatter.apply_strategy(strategy, value)).to eql(
+          "_id" => "?",
+          "authors" => [
+            { "name" => "?" },
+            { "name" => "?", "surname" => "?" }
           ]
-        end
-
-        it "should return only the first value of sanitized bulk documents" do
-          expect(formatter.apply_strategy(strategy, value)).to eql([
-            { "q" => { "_id" => "?" }, "u" => "[?]" },
-            "[...]"
-          ])
-        end
+        )
       end
     end
 

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

@@ -0,0 +1,30 @@
+describe Appsignal::EventFormatter::Sequel::SqlFormatter do
+  let(:klass)     { described_class }
+  let(:formatter) { klass.new }
+
+  it "registers the sql.sequel event formatter" do
+    expect(Appsignal::EventFormatter.registered?("sql.sequel", klass)).to be_truthy
+  end
+
+  describe "#format" do
+    before do
+      stub_const(
+        "SequelDatabaseTypeClass",
+        Class.new do
+          def self.to_s
+            "SequelDatabaseTypeClassToString"
+          end
+        end
+      )
+    end
+    let(:payload) do
+      {
+        :name => SequelDatabaseTypeClass,
+        :sql => "SELECT * FROM users"
+      }
+    end
+    subject { formatter.format(payload) }
+
+    it { is_expected.to eq ["SequelDatabaseTypeClassToString", "SELECT * FROM users", 1] }
+  end
+end

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

@@ -30,6 +30,7 @@ if DependencyHelper.active_job_present?
   end
 
   describe Appsignal::Hooks::ActiveJobHook::ActiveJobClassInstrumentation do
+    include ActiveJobHelpers
     let(:time) { Time.parse("2001-01-01 10:00:00UTC") }
     let(:namespace) { Appsignal::Transaction::BACKGROUND_JOB }
     let(:queue) { "default" }
@@ -65,7 +66,7 @@ if DependencyHelper.active_job_present?
       ]
     end
     let(:expected_perform_events) do
-      if DependencyHelper.rails_version >= Gem::Version.new("7.0.0")
+      if DependencyHelper.rails7_present?
         ["perform.active_job", "perform_start.active_job"]
       else
         ["perform_start.active_job", "perform.active_job"]
@@ -597,23 +598,5 @@ if DependencyHelper.active_job_present?
         "_aj_symbol_keys"
       end
     end
-
-    def active_job_args_wrapper(args: [], params: nil)
-      if DependencyHelper.rails_version >= Gem::Version.new("7.0.0")
-        wrapped_args = {
-          "_aj_ruby2_keywords" => ["args"],
-          "args" => args
-        }
-
-        unless params.nil?
-          wrapped_args["params"] = params
-          wrapped_args["_aj_ruby2_keywords"] = ["params", "args"]
-        end
-
-        [wrapped_args]
-      else
-        params.nil? ? args : args + [params]
-      end
-    end
   end
 end

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

@@ -1,7 +1,7 @@
 describe Appsignal::Hooks::SequelHook do
   if DependencyHelper.sequel_present?
     let(:db) do
-      if Appsignal::System.jruby?
+      if DependencyHelper.running_jruby?
         Sequel.connect("jdbc:sqlite::memory:")
       else
         Sequel.sqlite

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

@@ -17,8 +17,12 @@ describe Appsignal::Hooks::MongoMonitorSubscriber do
       end
 
       it "should sanitize command" do
+        # TODO: additional curly brackets required for issue
+        # https://github.com/rspec/rspec-mocks/issues/1460
+        # rubocop:disable Style/BracesAroundHashParameters
         expect(Appsignal::EventFormatter::MongoRubyDriver::QueryFormatter)
-          .to receive(:format).with("find", "foo" => "bar")
+          .to receive(:format).with("find", { "foo" => "bar" })
+        # rubocop:enable Style/BracesAroundHashParameters
 
         subscriber.started(event)
       end

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

@@ -228,10 +228,14 @@ describe Appsignal::Integrations::SidekiqMiddleware, :with_yaml_parse_error => f
     let(:error) { ExampleException }
 
     it "creates a transaction and adds the error" do
+      # TODO: additional curly brackets required for issue
+      # https://github.com/rspec/rspec-mocks/issues/1460
+      # rubocop:disable Style/BracesAroundHashParameters
       expect(Appsignal).to receive(:increment_counter)
-        .with("sidekiq_queue_job_count", 1, :queue => "default", :status => :failed)
+        .with("sidekiq_queue_job_count", 1, { :queue => "default", :status => :failed })
       expect(Appsignal).to receive(:increment_counter)
-        .with("sidekiq_queue_job_count", 1, :queue => "default", :status => :processed)
+        .with("sidekiq_queue_job_count", 1, { :queue => "default", :status => :processed })
+      # rubocop:enable Style/BracesAroundHashParameters
 
       expect do
         perform_job { raise error, "uh oh" }
@@ -267,8 +271,12 @@ describe Appsignal::Integrations::SidekiqMiddleware, :with_yaml_parse_error => f
 
   context "without an error" do
     it "creates a transaction with events" do
+      # TODO: additional curly brackets required for issue
+      # https://github.com/rspec/rspec-mocks/issues/1460
+      # rubocop:disable Style/BracesAroundHashParameters
       expect(Appsignal).to receive(:increment_counter)
-        .with("sidekiq_queue_job_count", 1, :queue => "default", :status => :processed)
+        .with("sidekiq_queue_job_count", 1, { :queue => "default", :status => :processed })
+      # rubocop:enable Style/BracesAroundHashParameters
 
       perform_job
 
@@ -339,6 +347,7 @@ if DependencyHelper.active_job_present?
   require "sidekiq/testing"
 
   describe "Sidekiq ActiveJob integration" do
+    include ActiveJobHelpers
     let(:namespace) { Appsignal::Transaction::BACKGROUND_JOB }
     let(:time) { Time.parse("2001-01-01 10:00:00UTC") }
     let(:log) { StringIO.new }
@@ -367,7 +376,7 @@ if DependencyHelper.active_job_present?
       ]
     end
     let(:expected_wrapped_args) do
-      if DependencyHelper.rails_version >= Gem::Version.new("7.0.0")
+      if (DependencyHelper.rails6_1_present? && DependencyHelper.ruby_3_1_or_newer?) || DependencyHelper.rails7_present?
         [{
           "_aj_ruby2_keywords" => ["args"],
           "args" => expected_args
@@ -385,7 +394,7 @@ if DependencyHelper.active_job_present?
       end
     end
     let(:expected_perform_events) do
-      if DependencyHelper.rails_version >= Gem::Version.new("7.0.0")
+      if DependencyHelper.rails7_present?
         ["perform_job.sidekiq", "perform.active_job", "perform_start.active_job"]
       else
         ["perform_job.sidekiq", "perform_start.active_job", "perform.active_job"]

data/spec/lib/appsignal/transaction_spec.rb

@@ -1282,8 +1282,8 @@ describe Appsignal::Transaction do
           end
         end
 
-        context "when skipping session data" do
-          before { Appsignal.config[:skip_session_data] = true }
+        context "when not sending session data" do
+          before { Appsignal.config[:send_session_data] = false }
 
           it "does not set any session data on the transaction" do
             expect(subject).to be_nil

data/spec/lib/appsignal/utils/query_params_sanitizer_spec.rb

@@ -117,7 +117,7 @@ describe Appsignal::Utils::QueryParamsSanitizer do
       context "when value is an array" do
         let(:value) { %w[foo bar] }
 
-        it "should sanitize all hash values with a single questionmark" do
+        it "should sanitize all hash values with a single question mark" do
           expect(subject).to eq(["?"])
         end
       end
@@ -125,7 +125,7 @@ describe Appsignal::Utils::QueryParamsSanitizer do
       context "when value is a mixed array" do
         let(:value) { [nil, "foo", "bar"] }
 
-        it "should sanitize all hash values with a single questionmark" do
+        it "should sanitize all hash values with a single question mark" do
           expect(subject).to eq(["?"])
         end
       end