appsignal 3.10.0 → 3.11.0

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

@@ -1,25 +1,21 @@
 describe Appsignal::Utils::IntegrationLogger do
-  let(:log) { std_stream }
+  let(:log_stream) { std_stream }
+  let(:logs) { log_contents(log_stream) }
   let(:logger) do
-    Appsignal::Utils::IntegrationLogger.new(log).tap do |l|
+    Appsignal::Utils::IntegrationLogger.new(log_stream).tap do |l|
       l.formatter = logger_formatter
     end
   end
 
-  describe "#seen_keys" do
-    it "returns a Set" do
-      expect(logger.seen_keys).to be_a(Set)
-    end
-  end
+  it "logs messages" do
+    logger.debug("debug message")
+    logger.info("info message")
+    logger.warn("warning message")
+    logger.error("error message")
 
-  describe "#warn_once_then_debug" do
-    it "only warns once, then uses debug" do
-      message = "This is a log line"
-      3.times { logger.warn_once_then_debug(:key, message) }
-
-      logs = log_contents(log)
-      expect(logs.scan(/#{Regexp.escape(log_line(:WARN, message))}/).count).to eql(1)
-      expect(logs.scan(/#{Regexp.escape(log_line(:DEBUG, message))}/).count).to eql(2)
-    end
+    expect(logs).to contains_log(:debug, "debug message")
+    expect(logs).to contains_log(:info, "info message")
+    expect(logs).to contains_log(:warn, "warning message")
+    expect(logs).to contains_log(:error, "error message")
   end
 end

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

@@ -68,16 +68,6 @@ describe Appsignal::Utils::IntegrationLogger do
     end
   end
 
-  describe "#warn_once_then_debug" do
-    it "only warns once, then uses debug" do
-      message = "This is a log line"
-      3.times { logger.warn_once_then_debug(:key, message) }
-
-      expect(logger.messages[:WARN]).to eq([message])
-      expect(logger.messages[:DEBUG]).to eq([message, message])
-    end
-  end
-
   describe "#error" do
     it "adds a log message with the error severity" do
       logger.error("error message")

data/spec/lib/appsignal_spec.rb

@@ -358,7 +358,178 @@ describe Appsignal do
     before { start_agent }
     around { |example| keep_transactions { example.run } }
 
+    describe ".monitor" do
+      it "creates a transaction" do
+        expect do
+          Appsignal.monitor(:action => "MyAction")
+        end.to(change { created_transactions.count }.by(1))
+
+        transaction = last_transaction
+        expect(transaction).to have_namespace(Appsignal::Transaction::HTTP_REQUEST)
+        expect(transaction).to have_action("MyAction")
+        expect(transaction).to_not have_error
+        expect(transaction).to_not include_events
+        expect(transaction).to_not have_queue_start
+        expect(transaction).to be_completed
+      end
+
+      it "returns the block's return value" do
+        expect(Appsignal.monitor(:action => nil) { :return_value }).to eq(:return_value)
+      end
+
+      it "sets a custom namespace via the namespace argument" do
+        Appsignal.monitor(:namespace => "custom", :action => nil)
+
+        expect(last_transaction).to have_namespace("custom")
+      end
+
+      it "doesn't overwrite custom namespace set in the block" do
+        Appsignal.monitor(:namespace => "custom", :action => nil) do
+          Appsignal.set_namespace("more custom")
+        end
+
+        expect(last_transaction).to have_namespace("more custom")
+      end
+
+      it "sets the action via the action argument using a string" do
+        Appsignal.monitor(:action => "custom")
+
+        expect(last_transaction).to have_action("custom")
+      end
+
+      it "sets the action via the action argument using a symbol" do
+        Appsignal.monitor(:action => :custom)
+
+        expect(last_transaction).to have_action("custom")
+      end
+
+      it "doesn't overwrite custom action set in the block" do
+        Appsignal.monitor(:action => "custom") do
+          Appsignal.set_action("more custom")
+        end
+
+        expect(last_transaction).to have_action("more custom")
+      end
+
+      it "doesn't set the action when value is nil" do
+        Appsignal.monitor(:action => nil)
+
+        expect(last_transaction).to_not have_action
+      end
+
+      it "doesn't set the action when value is :set_later" do
+        Appsignal.monitor(:action => :set_later)
+
+        expect(last_transaction).to_not have_action
+      end
+
+      it "reports exceptions that occur in the block" do
+        expect do
+          Appsignal.monitor :action => nil do
+            raise ExampleException, "error message"
+          end
+        end.to raise_error(ExampleException, "error message")
+
+        expect(last_transaction).to have_error("ExampleException", "error message")
+      end
+
+      context "with already active transction" do
+        let(:err_stream) { std_stream }
+        let(:stderr) { err_stream.read }
+        let(:transaction) { http_request_transaction }
+        before do
+          set_current_transaction(transaction)
+          transaction.set_action("My action")
+        end
+
+        it "doesn't create a new transaction" do
+          logs = nil
+          expect do
+            logs =
+              capture_logs do
+                capture_std_streams(std_stream, err_stream) do
+                  Appsignal.monitor(:action => nil)
+                end
+              end
+          end.to_not(change { created_transactions.count })
+
+          warning = "An active transaction around this 'Appsignal.monitor' call."
+          expect(logs).to contains_log(:warn, warning)
+          expect(stderr).to include("appsignal WARNING: #{warning}")
+        end
+
+        it "does not overwrite the parent transaction's namespace" do
+          silence { Appsignal.monitor(:namespace => "custom", :action => nil) }
+
+          expect(transaction).to have_namespace(Appsignal::Transaction::HTTP_REQUEST)
+        end
+
+        it "does not overwrite the parent transaction's action" do
+          silence { Appsignal.monitor(:action => "custom") }
+
+          expect(transaction).to have_action("My action")
+        end
+
+        it "doesn't complete the parent transaction" do
+          silence { Appsignal.monitor(:action => nil) }
+
+          expect(transaction).to_not be_completed
+        end
+      end
+    end
+
+    describe ".monitor_and_stop" do
+      it "calls Appsignal.stop after the block" do
+        allow(Appsignal).to receive(:stop)
+        Appsignal.monitor_and_stop(:namespace => "custom", :action => "My Action")
+
+        transaction = last_transaction
+        expect(transaction).to have_namespace("custom")
+        expect(transaction).to have_action("My Action")
+        expect(transaction).to be_completed
+
+        expect(Appsignal).to have_received(:stop).with("monitor_and_stop")
+      end
+    end
+
     describe ".monitor_transaction" do
+      it "prints a deprecation warning" do
+        err_stream = std_stream
+        capture_std_streams(std_stream, err_stream) do
+          Appsignal.monitor_transaction(
+            "perform_job.something",
+            :class => "BackgroundJob",
+            :method => "perform"
+          ) do
+            :return_value
+          end
+        end
+
+        expect(err_stream.read).to include(
+          "appsignal WARNING: The `Appsignal.monitor_transaction` helper is deprecated."
+        )
+      end
+
+      it "logs a deprecation warning" do
+        logs =
+          capture_logs do
+            silence do
+              Appsignal.monitor_transaction(
+                "perform_job.something",
+                :class => "BackgroundJob",
+                :method => "perform"
+              ) do
+                :return_value
+              end
+            end
+          end
+
+        expect(logs).to contains_log(
+          :warn,
+          "The `Appsignal.monitor_transaction` helper is deprecated."
+        )
+      end
+
       context "with a successful call" do
         it "instruments and completes for a background job" do
           return_value = nil
@@ -368,7 +539,8 @@ describe Appsignal do
                 "perform_job.something",
                 {
                   :class => "BackgroundJob",
-                  :method => "perform"
+                  :method => "perform",
+                  :queue_start => fixed_time.to_i
                 }
               ) do
                 :return_value
@@ -380,6 +552,7 @@ describe Appsignal do
           expect(transaction).to have_namespace(Appsignal::Transaction::BACKGROUND_JOB)
           expect(transaction).to have_action("BackgroundJob#perform")
           expect(transaction).to include_event("name" => "perform_job.something")
+          expect(transaction).to have_queue_start(1_389_783_600_000)
           expect(transaction).to be_completed
         end
 
@@ -391,7 +564,8 @@ describe Appsignal do
                 "process_action.something",
                 {
                   :controller => "BlogPostsController",
-                  :action => "show"
+                  :action => "show",
+                  "HTTP_X_REQUEST_START" => "t=#{fixed_time.to_i * 1000}"
                 }
               ) do
                 :return_value
@@ -403,6 +577,7 @@ describe Appsignal do
           expect(transaction).to have_namespace(Appsignal::Transaction::HTTP_REQUEST)
           expect(transaction).to have_action("BlogPostsController#show")
           expect(transaction).to include_event("name" => "process_action.something")
+          expect(transaction).to have_queue_start(1_389_783_600_000)
           expect(transaction).to be_completed
         end
       end
@@ -444,6 +619,43 @@ describe Appsignal do
     end
 
     describe ".monitor_single_transaction" do
+      it "prints a deprecation warning" do
+        err_stream = std_stream
+        capture_std_streams(std_stream, err_stream) do
+          Appsignal.monitor_single_transaction(
+            "perform_job.something",
+            :class => "BackgroundJob",
+            :method => "perform"
+          ) do
+            :return_value
+          end
+        end
+
+        expect(err_stream.read).to include(
+          "appsignal WARNING: The `Appsignal.monitor_single_transaction` helper is deprecated."
+        )
+      end
+
+      it "logs a deprecation warning" do
+        logs =
+          capture_logs do
+            silence do
+              Appsignal.monitor_single_transaction(
+                "perform_job.something",
+                :class => "BackgroundJob",
+                :method => "perform"
+              ) do
+                :return_value
+              end
+            end
+          end
+
+        expect(logs).to contains_log(
+          :warn,
+          "The `Appsignal.monitor_single_transaction` helper is deprecated."
+        )
+      end
+
       context "with a successful call" do
         it "calls monitor_transaction and Appsignal.stop" do
           expect(Appsignal).to receive(:stop)
@@ -521,9 +733,7 @@ describe Appsignal do
     end
 
     describe ".set_params" do
-      before do
-        start_agent
-      end
+      before { start_agent }
 
       context "with transaction" do
         let(:transaction) { http_request_transaction }
@@ -561,6 +771,84 @@ describe Appsignal do
       end
     end
 
+    describe ".set_session_data" do
+      before { start_agent }
+
+      context "with transaction" do
+        let(:transaction) { http_request_transaction }
+        before { set_current_transaction(transaction) }
+
+        it "sets session data on the transaction" do
+          Appsignal.set_session_data("data" => "value1")
+
+          transaction._sample
+          expect(transaction).to include_session_data("data" => "value1")
+        end
+
+        it "overwrites the session data if called multiple times" do
+          Appsignal.set_session_data("data" => "value1")
+          Appsignal.set_session_data("data" => "value2")
+
+          transaction._sample
+          expect(transaction).to include_session_data("data" => "value2")
+        end
+
+        it "sets session data with a block on the transaction" do
+          Appsignal.set_session_data { { "data" => "value1" } }
+
+          transaction._sample
+          expect(transaction).to include_session_data("data" => "value1")
+        end
+      end
+
+      context "without transaction" do
+        it "does not set session data on the transaction" do
+          Appsignal.set_session_data("a" => "b")
+
+          expect_any_instance_of(Appsignal::Transaction).to_not receive(:set_session_data)
+        end
+      end
+    end
+
+    describe ".set_headers" do
+      before { start_agent }
+
+      context "with transaction" do
+        let(:transaction) { http_request_transaction }
+        before { set_current_transaction(transaction) }
+
+        it "sets request headers on the transaction" do
+          Appsignal.set_headers("PATH_INFO" => "/some-path")
+
+          transaction._sample
+          expect(transaction).to include_environment("PATH_INFO" => "/some-path")
+        end
+
+        it "overwrites the request headers if called multiple times" do
+          Appsignal.set_headers("PATH_INFO" => "/some-path1")
+          Appsignal.set_headers("PATH_INFO" => "/some-path2")
+
+          transaction._sample
+          expect(transaction).to include_environment("PATH_INFO" => "/some-path2")
+        end
+
+        it "sets request headers with a block on the transaction" do
+          Appsignal.set_headers { { "PATH_INFO" => "/some-path" } }
+
+          transaction._sample
+          expect(transaction).to include_environment("PATH_INFO" => "/some-path")
+        end
+      end
+
+      context "without transaction" do
+        it "does not set request headers on the transaction" do
+          Appsignal.set_headers("PATH_INFO" => "/some-path")
+
+          expect_any_instance_of(Appsignal::Transaction).to_not receive(:set_headers)
+        end
+      end
+    end
+
     describe ".set_custom_data" do
       before { start_agent }
 
@@ -1269,7 +1557,7 @@ describe Appsignal do
       end
     end
 
-    describe ".without_instrumentation" do
+    describe ".ignore_instrumentation_events" do
       around { |example| keep_transactions { example.run } }
       let(:transaction) { http_request_transaction }
 
@@ -1281,20 +1569,44 @@ describe Appsignal do
           expect(transaction).to receive(:resume!).and_call_original
 
           Appsignal.instrument("register.this.event") { :do_nothing }
-          Appsignal.without_instrumentation do
+          Appsignal.ignore_instrumentation_events do
             Appsignal.instrument("dont.register.this.event") { :do_nothing }
           end
 
           expect(transaction).to include_event("name" => "register.this.event")
           expect(transaction).to_not include_event("name" => "dont.register.this.event")
         end
+
+        it "has a without_instrumentation alias that prints a deprecation warning" do
+          Appsignal.instrument("register.this.event") { :do_nothing }
+          err_stream = std_stream
+          logs =
+            capture_logs do
+              capture_std_streams(std_stream, err_stream) do
+                Appsignal.without_instrumentation do
+                  Appsignal.instrument("dont.register.this.event") { :do_nothing }
+                end
+              end
+            end
+
+          expect(transaction).to include_event("name" => "register.this.event")
+          expect(transaction).to_not include_event("name" => "dont.register.this.event")
+
+          expect(logs).to contains_log(
+            :warn,
+            "The `Appsignal.without_instrumentation` helper is deprecated."
+          )
+          expect(err_stream.read).to include(
+            "appsignal WARNING: The `Appsignal.without_instrumentation` helper is deprecated."
+          )
+        end
       end
 
       context "without current transaction" do
         let(:transaction) { nil }
 
         it "does not crash" do
-          Appsignal.without_instrumentation { :do_nothing }
+          Appsignal.ignore_instrumentation_events { :do_nothing }
         end
       end
     end
@@ -1312,8 +1624,9 @@ describe Appsignal do
           Appsignal.start_logger
         end
       end
-      expect(stderr).to include("appsignal WARNING: Callng 'Appsignal.start_logger' is deprecated.")
-      expect(log).to contains_log(:warn, "Callng 'Appsignal.start_logger' is deprecated.")
+      expect(stderr)
+        .to include("appsignal WARNING: Calling 'Appsignal.start_logger' is deprecated.")
+      expect(log).to contains_log(:warn, "Calling 'Appsignal.start_logger' is deprecated.")
     end
   end
 

data/spec/support/helpers/transaction_helpers.rb

@@ -7,26 +7,50 @@ module TransactionHelpers
     end
   end
 
-  def background_job_transaction(args = {})
-    Appsignal::Transaction.new(
-      "1",
-      Appsignal::Transaction::BACKGROUND_JOB,
-      Appsignal::Transaction::GenericRequest.new({
-        "SERVER_NAME" => "localhost",
-        "action_dispatch.routes" => "not_available"
-      }.merge(args))
-    )
-  end
-
-  def http_request_transaction(args = {})
-    Appsignal::Transaction.new(
-      "1",
-      Appsignal::Transaction::HTTP_REQUEST,
-      Appsignal::Transaction::GenericRequest.new({
-        "SERVER_NAME" => "localhost",
-        "action_dispatch.routes" => "not_available"
-      }.merge(args))
-    )
+  def default_namespace
+    Appsignal::Transaction::HTTP_REQUEST
+  end
+
+  def create_transaction(namespace = default_namespace)
+    Appsignal::Transaction.create(namespace)
+  end
+
+  def new_transaction(namespace = default_namespace)
+    Appsignal::Transaction.new(SecureRandom.uuid, namespace)
+  end
+
+  def legacy_create_transaction(
+    id: "mock_transaction_id",
+    namespace: "mock_namespace",
+    request: legacy_request,
+    options: {}
+  )
+    Appsignal::Transaction.create(id, namespace, request, options)
+  end
+
+  def legacy_new_transaction(
+    id: "mock_transaction_id",
+    namespace: "mock_namespace",
+    request: legacy_request,
+    options: {}
+  )
+    Appsignal::Transaction.new(id, namespace, request, options)
+  end
+
+  def legacy_request(env = {})
+    Appsignal::Transaction::InternalGenericRequest.new(env)
+  end
+
+  def rack_request(env)
+    Rack::Request.new(env)
+  end
+
+  def background_job_transaction
+    new_transaction(Appsignal::Transaction::BACKGROUND_JOB)
+  end
+
+  def http_request_transaction
+    new_transaction(Appsignal::Transaction::HTTP_REQUEST)
   end
 
   # Returns the all {Appsignal::Transaction} objects created during this test

data/spec/support/matchers/transaction.rb

@@ -180,6 +180,20 @@ RSpec::Matchers.alias_matcher :include_breadcrumbs, :include_breadcrumb
 
 RSpec::Matchers.define :have_queue_start do |queue_start_time|
   match(:notify_expectation_failures => true) do |transaction|
-    expect(transaction.ext.queue_start).to eq(queue_start_time)
+    actual_start = transaction.ext.queue_start
+    if queue_start_time
+      expect(actual_start).to eq(queue_start_time)
+    else
+      expect(actual_start).to_not be_nil
+    end
+  end
+
+  match_when_negated(:notify_expectation_failures => true) do |transaction|
+    actual_start = transaction.ext.queue_start
+    if queue_start_time
+      expect(actual_start).to_not eq(queue_start_time)
+    else
+      expect(actual_start).to be_nil
+    end
   end
 end

data/spec/support/testing.rb

@@ -134,7 +134,7 @@ module AppsignalTest
 
     module InstanceMethods
       def _sample
-        sample_data
+        _sample_data
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 3.10.0
+  version: 3.11.0
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-08 00:00:00.000000000 Z
+date: 2024-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -261,6 +261,7 @@ files:
 - lib/appsignal/integrations/redis.rb
 - lib/appsignal/integrations/redis_client.rb
 - lib/appsignal/integrations/resque.rb
+- lib/appsignal/integrations/shoryuken.rb
 - lib/appsignal/integrations/sidekiq.rb
 - lib/appsignal/integrations/sinatra.rb
 - lib/appsignal/integrations/unicorn.rb
@@ -362,6 +363,7 @@ files:
 - spec/lib/appsignal/hooks/webmachine_spec.rb
 - spec/lib/appsignal/hooks_spec.rb
 - spec/lib/appsignal/integrations/data_mapper_spec.rb
+- spec/lib/appsignal/integrations/delayed_job_plugin_spec.rb
 - spec/lib/appsignal/integrations/hanami_spec.rb
 - spec/lib/appsignal/integrations/http_spec.rb
 - spec/lib/appsignal/integrations/mongo_ruby_driver_spec.rb
@@ -370,6 +372,7 @@ files:
 - spec/lib/appsignal/integrations/padrino_spec.rb
 - spec/lib/appsignal/integrations/que_spec.rb
 - spec/lib/appsignal/integrations/railtie_spec.rb
+- spec/lib/appsignal/integrations/shoryuken_spec.rb
 - spec/lib/appsignal/integrations/sidekiq_spec.rb
 - spec/lib/appsignal/integrations/sinatra_spec.rb
 - spec/lib/appsignal/integrations/webmachine_spec.rb
@@ -389,6 +392,7 @@ files:
 - spec/lib/appsignal/rack/rails_instrumentation_spec.rb
 - spec/lib/appsignal/rack/sinatra_instrumentation_spec.rb
 - spec/lib/appsignal/rack/streaming_listener_spec.rb
+- spec/lib/appsignal/rack_spec.rb
 - spec/lib/appsignal/span_spec.rb
 - spec/lib/appsignal/system_spec.rb
 - spec/lib/appsignal/transaction_spec.rb