appsignal 3.12.0 → 3.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2cfb956b5058ae48109ce92cc65f4158f472797f531579e63aeb8398cb73044
-  data.tar.gz: 34ba16eb3b7c3b464e10fb9a8533d3b230cfb73550f6a804599e02b96fb909f1
+  metadata.gz: 46d05d1215b1e5df918af1f3977f72113560dc8f7eb96370990830f8679bc207
+  data.tar.gz: '095b571b4b2bb8d2e8f413d10f75ec07be08306472b2182cba69d2e628305b72'
 SHA512:
-  metadata.gz: e374e9fc6cb686ec6297cb9f8025a6309f011dfc8fff3c22f32f8ddb9635e867dfd001e7058553a3f2d624bf68065e2efe2f69e73692d9b05195736992d6af63
-  data.tar.gz: e83be1622f1c5d86748bc3bb93912d79ac2dd66cb6bbe61106aee8965b3aced6c31bc5e25689f52bfa7cb01da9f10e50fb76c47de1934b93cb12b6db705bb661
+  metadata.gz: 071c32621a02badd7ba7cc4c2ddfcaed0eb1a05e271114b0bbc083ff5e1c4c2898c305c39fe36f7cb5e8cc634410f311034f04b2b2317cce1c8ce4157f8cdef9
+  data.tar.gz: b60993c16502163d34dd7352a7636cea2fd4f7b572b241282d819be0e4a4d21dc739f52a615f2e4dd5ed28197b8873631b3288abfb29671fcd52b1f7cc2a6b3e

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # AppSignal for Ruby gem Changelog
 
+## 3.12.1
+
+_Published on 2024-07-25._
+
+### Fixed
+
+- Fix `Appsignal.monitor_and_stop` block passing. It would error with a `LocalJumpError`. Thanks to @cwaider. (patch [150569ff](https://github.com/appsignal/appsignal-ruby/commit/150569ff49e54ab743ed3db16d109abcf5719e30))
+
 ## 3.12.0
 
 _Published on 2024-07-22._
@@ -28,11 +36,9 @@ _Published on 2024-07-22._
   ```ruby
   # config/initializers/appsignal.rb
 
-  Appsignal.config = Appsignal::Config.new(
-    Rails.root,
-    Rails.env,
-    :ignore_actions => ["My action"]
-  )
+  Appsignal.configure do |config|
+    config.ignore_actions = ["My action"]
+  end
   ```
 
   Be aware that when `start_at` is set to `after_initialize`, AppSignal will not track any errors that occur when the initializers are run and the app fails to start.

data/lib/appsignal/helpers/instrumentation.rb

@@ -154,8 +154,8 @@ module Appsignal
       # documentation.
       #
       # @see monitor
-      def monitor_and_stop(action:, namespace: nil)
-        monitor(:namespace => namespace, :action => action)
+      def monitor_and_stop(action:, namespace: nil, &block)
+        monitor(:namespace => namespace, :action => action, &block)
       ensure
         Appsignal.stop("monitor_and_stop")
       end

data/lib/appsignal/version.rb

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

data/spec/lib/appsignal/transaction_spec.rb

@@ -1499,54 +1499,53 @@ describe Appsignal::Transaction do
   describe "#set_error" do
     let(:transaction) { new_transaction }
     let(:env) { http_request_env_with_data }
-    let(:error) do
-      e = ExampleStandardError.new("test message")
-      allow(e).to receive(:backtrace).and_return(["line 1"])
-      e
-    end
+    let(:error) { ExampleStandardError.new("test message") }
 
-    it "should also respond to add_exception for backwards compatibility" do
+    it "responds to add_exception for backwards compatibility" do
       expect(transaction).to respond_to(:add_exception)
     end
 
-    it "should not add the error if appsignal is not active" do
+    it "does not add the error if not active" do
       allow(Appsignal).to receive(:active?).and_return(false)
-      expect(transaction.ext).to_not receive(:set_error)
 
       transaction.set_error(error)
+
+      expect(transaction).to_not have_error
     end
 
-    context "when error is not an error" do
+    context "when error argument is not an error" do
       let(:error) { Object.new }
 
       it "does not add the error" do
-        expect(Appsignal.internal_logger).to receive(:error).with(
+        logs = capture_logs { transaction.set_error(error) }
+
+        expect(transaction).to_not have_error
+        expect(logs).to contains_log(
+          :error,
           "Appsignal::Transaction#set_error: Cannot set error. " \
             "The given value is not an exception: #{error.inspect}"
         )
-        expect(transaction.ext).to_not receive(:set_error)
-
-        transaction.set_error(error)
       end
     end
 
     context "for a http request" do
-      it "should set an error in the extension" do
-        expect(transaction.ext).to receive(:set_error).with(
+      it "sets an error on the transaction" do
+        allow(error).to receive(:backtrace).and_return(["line 1"])
+        transaction.set_error(error)
+
+        expect(transaction).to have_error(
           "ExampleStandardError",
           "test message",
-          Appsignal::Utils::Data.generate(["line 1"])
+          ["line 1"]
         )
-
-        transaction.set_error(error)
       end
     end
 
     context "when the error has no causes" do
-      it "should not send the causes information as sample data" do
-        expect(transaction.ext).to_not receive(:set_sample_data)
-
+      it "does not set the causes information as sample data" do
         transaction.set_error(error)
+
+        expect(transaction).to_not include_error_causes
       end
     end
 
@@ -1562,31 +1561,25 @@ describe Appsignal::Transaction do
       end
 
       it "sends the causes information as sample data" do
-        expect(transaction.ext).to receive(:set_error).with(
+        transaction.set_error(error)
+
+        expect(transaction).to have_error(
           "ExampleStandardError",
           "test message",
-          Appsignal::Utils::Data.generate(["line 1"])
+          ["line 1"]
         )
-
-        expect(transaction.ext).to receive(:set_sample_data).with(
-          "error_causes",
-          Appsignal::Utils::Data.generate(
-            [
-              {
-                :name => "RuntimeError",
-                :message => "cause message"
-              },
-              {
-                :name => "StandardError",
-                :message => "cause message 2"
-              }
-            ]
-          )
+        expect(transaction).to include_error_causes(
+          [
+            {
+              "name" => "RuntimeError",
+              "message" => "cause message"
+            },
+            {
+              "name" => "StandardError",
+              "message" => "cause message 2"
+            }
+          ]
         )
-
-        expect(Appsignal.internal_logger).to_not receive(:debug)
-
-        transaction.set_error(error)
       end
     end
 
@@ -1605,33 +1598,29 @@ describe Appsignal::Transaction do
       end
 
       it "sends only the first causes as sample data" do
-        expect(transaction.ext).to receive(:set_error).with(
-          "ExampleStandardError",
-          "wrapper error 10",
-          Appsignal::Utils::Data.generate(["line 1"])
-        )
-
-        expected_error_causes = Array.new(10) do |i|
-          {
-            :name => "ExampleStandardError",
-            :message => "wrapper error #{9 - i}"
-          }
-        end
+        expected_error_causes =
+          Array.new(10) do |i|
+            {
+              "name" => "ExampleStandardError",
+              "message" => "wrapper error #{9 - i}"
+            }
+          end
+        expected_error_causes.last["is_root_cause"] = false
 
-        expected_error_causes.last[:is_root_cause] = false
+        logs = capture_logs { transaction.set_error(error) }
 
-        expect(transaction.ext).to receive(:set_sample_data).with(
-          "error_causes",
-          Appsignal::Utils::Data.generate(expected_error_causes)
+        expect(transaction).to have_error(
+          "ExampleStandardError",
+          "wrapper error 10",
+          ["line 1"]
         )
-
-        expect(Appsignal.internal_logger).to receive(:debug).with(
+        expect(transaction).to include_error_causes(expected_error_causes)
+        expect(logs).to contains_log(
+          :debug,
           "Appsignal::Transaction#set_error: Error has more " \
             "than 10 error causes. Only the first 10 " \
             "will be reported."
         )
-
-        transaction.set_error(error)
       end
     end
 
@@ -1643,18 +1632,18 @@ describe Appsignal::Transaction do
         e
       end
 
-      it "should not raise an error" do
+      it "does not raise an error" do
         transaction.set_error(error)
       end
 
-      it "should set an error in the extension" do
-        expect(transaction.ext).to receive(:set_error).with(
+      it "sets an error on the transaction without an error message" do
+        transaction.set_error(error)
+
+        expect(transaction).to have_error(
           "ExampleStandardError",
           "",
-          Appsignal::Utils::Data.generate(["line 1"])
+          ["line 1"]
         )
-
-        transaction.set_error(error)
       end
     end
   end

data/spec/lib/appsignal_spec.rb

@@ -745,6 +745,12 @@ describe Appsignal do
 
         expect(Appsignal).to have_received(:stop).with("monitor_and_stop")
       end
+
+      it "passes the block to Appsignal.monitor" do
+        expect do |blk|
+          Appsignal.monitor_and_stop(:action => "My action", &blk)
+        end.to yield_control
+      end
     end
 
     describe ".monitor_transaction" do

data/spec/support/matchers/transaction.rb

@@ -59,6 +59,7 @@ define_transaction_sample_matcher_for(:environment)
 define_transaction_sample_matcher_for(:session_data)
 define_transaction_sample_matcher_for(:tags)
 define_transaction_sample_matcher_for(:custom_data)
+define_transaction_sample_matcher_for(:error_causes)
 
 RSpec::Matchers.define :be_completed do
   match(:notify_expectation_failures => true) do |transaction|
@@ -66,14 +67,14 @@ RSpec::Matchers.define :be_completed do
   end
 end
 
-RSpec::Matchers.define :have_error do |error_class, error_message|
+RSpec::Matchers.define :have_error do |error_class, error_message, error_backtrace|
   match(:notify_expectation_failures => true) do |transaction|
     transaction_error = transaction.to_h["error"]
     if error_class && error_message
       expect(transaction_error).to include(
         "name" => error_class,
         "message" => error_message,
-        "backtrace" => kind_of(String)
+        "backtrace" => error_backtrace ? JSON.dump(error_backtrace) : kind_of(String)
       )
     else
       expect(transaction_error).to be_any

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 3.12.0
+  version: 3.12.1
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-22 00:00:00.000000000 Z
+date: 2024-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack