appsignal 3.9.0 → 3.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9957483552477f7eceba77181c904899b22ff6657db6782558b2fce96b9571e1
-  data.tar.gz: 36c1760ff247804c579bb0b7bf3db2aee1d4ed53ede1a1920d5a8a1fa762f032
+  metadata.gz: 4ba7ce82da19f71d170cf4e49c9766668dfe0e9f2ee8538e174c176b27f8029d
+  data.tar.gz: 69deaf2c8fe7b5abf5959a176645e640d72e9b75fb346eeba8ca9a53449374ed
 SHA512:
-  metadata.gz: '068c51758a2d48731ea31a4854cf31ab002c62fd290796832dea372f68078cbe2da29b237eb006aab7b6936b6a85b437a1f28f01d6182fad03425933b73a0241'
-  data.tar.gz: 66832484c634de15a474774f49e8c38838faf4b71889c68c4ad7ef897d1ad64c119b926152a228117409103b657f8523599597394b989bbf87553d1c072bf5a1
+  metadata.gz: 94a9cf035fc75911dbcef3ba2d39ef207387dd1f4908f268a366ef4d71a8e1eb48657d6b7ccf6ed038d530be43cc6771e696e0f89335e7603b54b09104b49113
+  data.tar.gz: 3aa39a4f0f3ed36782ffbc3501eedfb6d811248abcf4e304be4d41f64ec24a4f938c8fe130bfb7de85751780d063783a72a1a389717a636fadc71e042305687f

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # AppSignal for Ruby gem Changelog
 
+## 3.9.1
+
+_Published on 2024-06-24._
+
+### Fixed
+
+- [0a253aa1](https://github.com/appsignal/appsignal-ruby/commit/0a253aa16c00cd6172e35a4edaff34f76ac9cbe5) patch - Fix parameter reporting for Rack and Sinatra apps, especially POST payloads.
+
 ## 3.9.0
 
 _Published on 2024-06-21._

data/lib/appsignal/rack/abstract_middleware.rb

@@ -91,8 +91,6 @@ module Appsignal
       # Override this method to set metadata before the app is called.
       # Call `super` to also include the default set metadata.
       def add_transaction_metadata_before(transaction, request)
-        params = params_for(request)
-        transaction.params = params if params
       end
 
       # Add metadata to the transaction based on the request environment.
@@ -104,6 +102,7 @@ module Appsignal
         transaction.set_action_if_nil(default_action)
         transaction.set_metadata("path", request.path)
         transaction.set_metadata("method", request.request_method)
+        transaction.set_params_if_nil(params_for(request))
         transaction.set_http_or_background_queue_start
       end
 

data/lib/appsignal/transaction.rb

@@ -76,18 +76,6 @@ module Appsignal
     attr_reader :ext, :transaction_id, :action, :namespace, :request, :paused, :tags, :options,
       :discarded, :breadcrumbs
 
-    # @!attribute params
-    #   Attribute for parameters of the transaction.
-    #
-    #   When no parameters are set with {#params=} the parameters it will look
-    #   for parameters on the {#request} environment.
-    #
-    #   The parameters set using {#params=} are leading over those extracted
-    #   from a request's environment.
-    #
-    #   @return [Hash]
-    attr_writer :params
-
     def initialize(transaction_id, namespace, request, options = {})
       @transaction_id = transaction_id
       @action = nil
@@ -156,6 +144,40 @@ module Appsignal
       request_params
     end
 
+    # Set parameters on the transaction.
+    #
+    # When no parameters are set this way, the transaction will look for
+    # parameters on the {#request} environment.
+    #
+    # The parameters set using {#set_params} are leading over those extracted
+    # from a request's environment.
+    #
+    # @param given_params [Hash] The parameters to set on the transaction.
+    # @return [void]
+    def set_params(given_params)
+      @params = given_params if given_params
+    end
+
+    # @deprecated Use {#set_params} or {#set_params_if_nil} instead.
+    def params=(given_params)
+      Appsignal::Utils::StdoutAndLoggerMessage.warning(
+        "Transaction#params= is deprecated." \
+          "Use Transaction#set_params or #set_params_if_nil instead."
+      )
+      set_params(given_params)
+    end
+
+    # Set parameters on the transaction if not already set
+    #
+    # When no parameters are set this way, the transaction will look for
+    # parameters on the {#request} environment.
+    #
+    # @param given_params [Hash] The parameters to set on the transaction if none are already set.
+    # @return [void]
+    def set_params_if_nil(given_params)
+      set_params(given_params) unless @params
+    end
+
     # Set tags on the transaction.
     #
     # @param given_tags [Hash] Collection of tags.

data/lib/appsignal/version.rb

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

data/spec/lib/appsignal/transaction_spec.rb

@@ -348,9 +348,92 @@ describe Appsignal::Transaction do
     end
 
     describe "#params=" do
+      around { |example| keep_transactions { example.run } }
+
       it "sets params on the transaction" do
-        transaction.params = { :foo => "bar" }
-        expect(transaction.params).to eq(:foo => "bar")
+        params = { "foo" => "bar" }
+        transaction.params = params
+
+        transaction.complete # Sample the data
+        expect(transaction.params).to eq(params)
+        expect(transaction.to_h.dig("sample_data", "params")).to eq(params)
+      end
+
+      it "logs a deprecation warning" do
+        transaction.params = { "foo" => "bar" }
+
+        expect(log_contents(log)).to contains_log(
+          :warn,
+          "Transaction#params= is deprecated." \
+            "Use Transaction#set_params or #set_params_if_nil instead."
+        )
+      end
+    end
+
+    describe "#set_params" do
+      around { |example| keep_transactions { example.run } }
+
+      context "when the params are set" do
+        it "updates the params on the transaction" do
+          params = { "key" => "value" }
+          transaction.set_params(params)
+
+          transaction.complete # Sample the data
+          expect(transaction.params).to eq(params)
+          expect(transaction.to_h.dig("sample_data", "params")).to eq(params)
+        end
+      end
+
+      context "when the given params is nil" do
+        it "does not update the params on the transaction" do
+          params = { "key" => "value" }
+          transaction.set_params(params)
+          transaction.set_params(nil)
+
+          transaction.complete # Sample the data
+          expect(transaction.params).to eq(params)
+          expect(transaction.to_h.dig("sample_data", "params")).to eq(params)
+        end
+      end
+    end
+
+    describe "#set_params_if_nil" do
+      around { |example| keep_transactions { example.run } }
+
+      context "when the params are not set" do
+        it "sets the params on the transaction" do
+          params = { "key" => "value" }
+          transaction.set_params_if_nil(params)
+
+          transaction.complete # Sample the data
+          expect(transaction.params).to eq(params)
+          expect(transaction.to_h.dig("sample_data", "params")).to eq(params)
+        end
+
+        context "when the given params is nil" do
+          it "does not update the params on the transaction" do
+            params = { "key" => "value" }
+            transaction.set_params(params)
+            transaction.set_params_if_nil(nil)
+
+            transaction.complete # Sample the data
+            expect(transaction.params).to eq(params)
+            expect(transaction.to_h.dig("sample_data", "params")).to eq(params)
+          end
+        end
+      end
+
+      context "when the params are set" do
+        it "does not update the params on the transaction" do
+          preset_params = { "other" => "params" }
+          params = { "key" => "value" }
+          transaction.set_params(preset_params)
+          transaction.set_params_if_nil(params)
+
+          transaction.complete # Sample the data
+          expect(transaction.params).to eq(preset_params)
+          expect(transaction.to_h.dig("sample_data", "params")).to eq(preset_params)
+        end
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 3.9.0
+  version: 3.9.1
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-21 00:00:00.000000000 Z
+date: 2024-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack