appsignal 2.11.0.beta.4-java → 2.11.2-java

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

@@ -60,7 +60,10 @@ describe Appsignal::Hooks::ResqueHook do
           "error" => nil,
           "namespace" => namespace,
           "metadata" => {},
-          "sample_data" => { "tags" => { "queue" => queue } }
+          "sample_data" => {
+            "breadcrumbs" => [],
+            "tags" => { "queue" => queue }
+          }
         )
         expect(transaction_hash["events"].map { |e| e["name"] })
           .to eql(["perform.resque"])
@@ -84,7 +87,10 @@ describe Appsignal::Hooks::ResqueHook do
             },
             "namespace" => namespace,
             "metadata" => {},
-            "sample_data" => { "tags" => { "queue" => queue } }
+            "sample_data" => {
+              "breadcrumbs" => [],
+              "tags" => { "queue" => queue }
+            }
           )
         end
       end
@@ -118,6 +124,7 @@ describe Appsignal::Hooks::ResqueHook do
             "metadata" => {},
             "sample_data" => {
               "tags" => { "queue" => queue },
+              "breadcrumbs" => [],
               "params" => [
                 "foo",
                 {
@@ -174,6 +181,7 @@ describe Appsignal::Hooks::ResqueHook do
             "namespace" => namespace,
             "metadata" => {},
             "sample_data" => {
+              "breadcrumbs" => [],
               "tags" => { "queue" => queue }
               # Params will be set by the ActiveJob integration
             }

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

@@ -262,7 +262,8 @@ describe Appsignal::Hooks::SidekiqPlugin, :with_yaml_parse_error => false do
         "sample_data" => {
           "environment" => {},
           "params" => expected_args,
-          "tags" => {}
+          "tags" => {},
+          "breadcrumbs" => []
         }
       )
       expect_transaction_to_have_sidekiq_event(transaction_hash)
@@ -290,7 +291,8 @@ describe Appsignal::Hooks::SidekiqPlugin, :with_yaml_parse_error => false do
         "sample_data" => {
           "environment" => {},
           "params" => expected_args,
-          "tags" => {}
+          "tags" => {},
+          "breadcrumbs" => []
         }
       )
       # TODO: Not available in transaction.to_h yet.

data/spec/lib/appsignal/hooks_spec.rb

@@ -78,6 +78,63 @@ describe Appsignal::Hooks do
     expect(Appsignal::Hooks.hooks[:mock_error_hook].installed?).to be_falsy
     Appsignal::Hooks.hooks.delete(:mock_error_hook)
   end
+
+  describe "missing constants" do
+    let(:err_stream) { std_stream }
+    let(:stderr) { err_stream.read }
+    let(:log_stream) { std_stream }
+    let(:log) { log_contents(log_stream) }
+    before do
+      Appsignal.logger = test_logger(log_stream)
+    end
+
+    def call_constant(&block)
+      capture_std_streams(std_stream, err_stream, &block)
+    end
+
+    describe "SidekiqProbe" do
+      it "logs a deprecation message and returns the new constant" do
+        constant = call_constant { Appsignal::Hooks::SidekiqProbe }
+
+        expect(constant).to eql(Appsignal::Probes::SidekiqProbe)
+        expect(constant.name).to eql("Appsignal::Probes::SidekiqProbe")
+
+        deprecation_message =
+          "The constant Appsignal::Hooks::SidekiqProbe has been deprecated. " \
+          "Please update the constant name to Appsignal::Probes::SidekiqProbe " \
+          "in the following file to remove this message.\n#{__FILE__}:"
+        expect(stderr).to include "appsignal WARNING: #{deprecation_message}"
+        expect(log).to contains_log :warn, deprecation_message
+      end
+    end
+
+    describe "PumaProbe" do
+      it "logs a deprecation message and returns the new constant" do
+        constant = call_constant { Appsignal::Hooks::PumaProbe }
+
+        expect(constant).to eql(Appsignal::Probes::PumaProbe)
+        expect(constant.name).to eql("Appsignal::Probes::PumaProbe")
+
+        deprecation_message =
+          "The constant Appsignal::Hooks::PumaProbe has been deprecated. " \
+          "Please update the constant name to Appsignal::Probes::PumaProbe " \
+          "in the following file to remove this message.\n#{__FILE__}:"
+        expect(stderr).to include "appsignal WARNING: #{deprecation_message}"
+        expect(log).to contains_log :warn, deprecation_message
+      end
+    end
+
+    describe "other constant" do
+      it "raises a NameError like Ruby normally does" do
+        expect do
+          call_constant { Appsignal::Hooks::Unknown }
+        end.to raise_error(NameError)
+
+        expect(stderr).to be_empty
+        expect(log).to be_empty
+      end
+    end
+  end
 end
 
 describe Appsignal::Hooks::Helpers do

data/spec/lib/appsignal/marker_spec.rb

@@ -4,7 +4,7 @@ describe Appsignal::Marker do
     described_class.new(
       {
         :revision => "503ce0923ed177a3ce000005",
-        :repository => "master",
+        :repository => "main",
         :user => "batman",
         :rails_env => "production"
       },

data/spec/lib/appsignal/transaction_spec.rb

@@ -356,6 +356,57 @@ describe Appsignal::Transaction do
       end
     end
 
+    describe "#add_breadcrumb" do
+      context "when over the limit" do
+        before do
+          22.times do |i|
+            transaction.add_breadcrumb(
+              "network",
+              "GET http://localhost",
+              "User made external network request",
+              { :code => i + 1 },
+              Time.parse("10-10-2010 10:00:00 UTC")
+            )
+          end
+          transaction.sample_data
+        end
+
+        it "stores last <LIMIT> breadcrumbs on the transaction" do
+          expect(transaction.to_h["sample_data"]["breadcrumbs"].length).to eql(20)
+          expect(transaction.to_h["sample_data"]["breadcrumbs"][0]).to eq(
+            "action" => "GET http://localhost",
+            "category" => "network",
+            "message" => "User made external network request",
+            "metadata" => { "code" => 3 },
+            "time" => 1286704800 # rubocop:disable Style/NumericLiterals
+          )
+          expect(transaction.to_h["sample_data"]["breadcrumbs"][19]).to eq(
+            "action" => "GET http://localhost",
+            "category" => "network",
+            "message" => "User made external network request",
+            "metadata" => { "code" => 22 },
+            "time" => 1286704800 # rubocop:disable Style/NumericLiterals
+          )
+        end
+      end
+
+      context "with defaults" do
+        it "stores breadcrumb with defaults on transaction" do
+          timeframe_start = Time.now.utc.to_i
+          transaction.add_breadcrumb("user_action", "clicked HOME")
+          transaction.sample_data
+          timeframe_end = Time.now.utc.to_i
+
+          breadcrumb = transaction.to_h["sample_data"]["breadcrumbs"][0]
+          expect(breadcrumb["category"]).to eq("user_action")
+          expect(breadcrumb["action"]).to eq("clicked HOME")
+          expect(breadcrumb["message"]).to eq("")
+          expect(breadcrumb["time"]).to be_between(timeframe_start, timeframe_end)
+          expect(breadcrumb["metadata"]).to eq({})
+        end
+      end
+    end
+
     describe "#set_action" do
       context "when the action is set" do
         it "updates the action name on the transaction" do
@@ -649,6 +700,10 @@ describe Appsignal::Transaction do
           "tags",
           Appsignal::Utils::Data.generate({})
         ).once
+        expect(transaction.ext).to receive(:set_sample_data).with(
+          "breadcrumbs",
+          Appsignal::Utils::Data.generate([])
+        ).once
 
         transaction.sample_data
       end

data/spec/lib/appsignal_spec.rb

@@ -491,6 +491,36 @@ describe Appsignal do
       end
     end
 
+    describe ".add_breadcrumb" do
+      before { allow(Appsignal::Transaction).to receive(:current).and_return(transaction) }
+
+      context "with transaction" do
+        let(:transaction) { double }
+        it "should call add_breadcrumb on transaction" do
+          expect(transaction).to receive(:add_breadcrumb)
+            .with("Network", "http", "User made network request", { :response => 200 }, fixed_time)
+        end
+
+        after do
+          Appsignal.add_breadcrumb(
+            "Network",
+            "http",
+            "User made network request",
+            { :response => 200 },
+            fixed_time
+          )
+        end
+      end
+
+      context "without transaction" do
+        let(:transaction) { nil }
+
+        it "should not call add_breadcrumb on transaction" do
+          expect(Appsignal.add_breadcrumb("Network", "http")).to be_falsy
+        end
+      end
+    end
+
     describe "custom stats" do
       let(:tags) { { :foo => "bar" } }
 

data/spec/spec_helper.rb

@@ -65,6 +65,10 @@ RSpec.configure do |config|
 
   config.example_status_persistence_file_path = "spec/examples.txt"
   config.fail_if_no_examples = true
+  config.filter_run_excluding(
+    :extension_installation_failure => true,
+    :jruby => !DependencyHelper.running_jruby?
+  )
   config.mock_with :rspec do |mocks|
     mocks.syntax = :expect
   end
@@ -111,6 +115,7 @@ RSpec.configure do |config|
     # in the diagnose task, so add it manually to the list of to-be cleaned up
     # keys.
     env_keys << "_APPSIGNAL_DIAGNOSE"
+    env_keys << "_TEST_APPSIGNAL_EXTENSION_FAILURE"
     env_keys.each do |key|
       # First set the ENV var to an empty string and then delete the key from
       # the env. We set the env var to an empty string first as JRuby doesn't

data/spec/support/helpers/config_helpers.rb

@@ -5,12 +5,13 @@ module ConfigHelpers
     )
   end
 
-  def project_fixture_config(env = "production", initial_config = {}, logger = Appsignal.logger)
+  def project_fixture_config(env = "production", initial_config = {}, logger = Appsignal.logger, config_file = nil)
     Appsignal::Config.new(
       project_fixture_path,
       env,
       initial_config,
-      logger
+      logger,
+      config_file
     )
   end
 

data/spec/support/helpers/dependency_helper.rb

@@ -37,6 +37,10 @@ module DependencyHelper
     dependency_present? "actioncable"
   end
 
+  def action_mailer_present?
+    dependency_present? "actionmailer"
+  end
+
   def active_job_present?
     dependency_present? "activejob"
   end

data/spec/support/helpers/transaction_helpers.rb

@@ -46,7 +46,7 @@ module TransactionHelpers
 
   # Set current transaction manually.
   # Cleared by {clear_current_transaction!}
-  def set_current_transaction(transaction) # rubocop:disable Style/AccessorMethodName
+  def set_current_transaction(transaction) # rubocop:disable Naming/AccessorMethodName
     Thread.current[:appsignal_transaction] = transaction
   end
 

data/spec/support/testing.rb

@@ -38,25 +38,9 @@ module Appsignal
     end
   end
 
-  class Transaction
-    class << self
-      alias original_new new
-
-      # Override the {Appsignal::Transaction.new} method so we can track which
-      # transactions are created on the {Appsignal::Testing.transactions} list.
-      #
-      # @see TransactionHelpers#last_transaction
-      def new(*args)
-        transaction = original_new(*args)
-        Appsignal::Testing.transactions << transaction
-        transaction
-      end
-    end
-  end
-
   class Extension
     class Transaction
-      alias original_finish finish
+      alias original_finish finish if method_defined? :finish
 
       # Override default {Extension::Transaction#finish} behavior to always
       # return true, which tells the transaction to add its sample data (unless
@@ -72,7 +56,7 @@ module Appsignal
         return_value
       end
 
-      alias original_complete complete
+      alias original_complete complete if method_defined? :complete
 
       # Override default {Extension::Transaction#complete} behavior to
       # store the transaction JSON before the transaction is completed
@@ -94,7 +78,7 @@ module Appsignal
         @completed || false
       end
 
-      alias original_to_json to_json
+      alias original_to_json to_json if method_defined? :to_json
 
       # Override default {Extension::Transaction#to_json} behavior to
       # return the stored the transaction JSON when the transaction was
@@ -111,3 +95,19 @@ module Appsignal
     end
   end
 end
+
+module AppsignalTest
+  module Transaction
+    # Override the {Appsignal::Transaction.new} method so we can track which
+    # transactions are created on the {Appsignal::Testing.transactions} list.
+    #
+    # @see TransactionHelpers#last_transaction
+    def new(*_args)
+      transaction = super
+      Appsignal::Testing.transactions << transaction
+      transaction
+    end
+  end
+end
+
+Appsignal::Transaction.extend(AppsignalTest::Transaction)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 2.11.0.beta.4
+  version: 2.11.2
 platform: java
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-13 00:00:00.000000000 Z
+date: 2021-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -221,6 +221,7 @@ files:
 - lib/appsignal/helpers/metrics.rb
 - lib/appsignal/hooks.rb
 - lib/appsignal/hooks/action_cable.rb
+- lib/appsignal/hooks/action_mailer.rb
 - lib/appsignal/hooks/active_job.rb
 - lib/appsignal/hooks/active_support_notifications.rb
 - lib/appsignal/hooks/celluloid.rb
@@ -258,6 +259,7 @@ files:
 - lib/appsignal/logger.rb
 - lib/appsignal/marker.rb
 - lib/appsignal/minutely.rb
+- lib/appsignal/probes.rb
 - lib/appsignal/probes/puma.rb
 - lib/appsignal/probes/sidekiq.rb
 - lib/appsignal/rack/generic_instrumentation.rb
@@ -304,9 +306,14 @@ files:
 - spec/lib/appsignal/event_formatter/moped/query_formatter_spec.rb
 - spec/lib/appsignal/event_formatter_spec.rb
 - spec/lib/appsignal/extension/jruby_spec.rb
+- spec/lib/appsignal/extension_install_failure_spec.rb
 - spec/lib/appsignal/extension_spec.rb
 - spec/lib/appsignal/garbage_collection_profiler_spec.rb
 - spec/lib/appsignal/hooks/action_cable_spec.rb
+- spec/lib/appsignal/hooks/action_mailer_spec.rb
+- spec/lib/appsignal/hooks/active_support_notifications/finish_with_state_shared_examples.rb
+- spec/lib/appsignal/hooks/active_support_notifications/instrument_shared_examples.rb
+- spec/lib/appsignal/hooks/active_support_notifications/start_finish_shared_examples.rb
 - spec/lib/appsignal/hooks/active_support_notifications_spec.rb
 - spec/lib/appsignal/hooks/activejob_spec.rb
 - spec/lib/appsignal/hooks/celluloid_spec.rb
@@ -402,7 +409,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/appsignal/appsignal-ruby/issues
-  changelog_uri: https://github.com/appsignal/appsignal-ruby/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/appsignal/appsignal-ruby/blob/main/CHANGELOG.md
   documentation_uri: https://docs.appsignal.com/ruby/
   homepage_uri: https://docs.appsignal.com/ruby/
   source_code_uri: https://github.com/appsignal/appsignal-ruby
@@ -418,9 +425,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.4
 signing_key:
@@ -451,9 +458,14 @@ test_files:
 - spec/lib/appsignal/event_formatter/moped/query_formatter_spec.rb
 - spec/lib/appsignal/event_formatter_spec.rb
 - spec/lib/appsignal/extension/jruby_spec.rb
+- spec/lib/appsignal/extension_install_failure_spec.rb
 - spec/lib/appsignal/extension_spec.rb
 - spec/lib/appsignal/garbage_collection_profiler_spec.rb
 - spec/lib/appsignal/hooks/action_cable_spec.rb
+- spec/lib/appsignal/hooks/action_mailer_spec.rb
+- spec/lib/appsignal/hooks/active_support_notifications/finish_with_state_shared_examples.rb
+- spec/lib/appsignal/hooks/active_support_notifications/instrument_shared_examples.rb
+- spec/lib/appsignal/hooks/active_support_notifications/start_finish_shared_examples.rb
 - spec/lib/appsignal/hooks/active_support_notifications_spec.rb
 - spec/lib/appsignal/hooks/activejob_spec.rb
 - spec/lib/appsignal/hooks/celluloid_spec.rb