appsignal 4.0.0.beta.1 → 4.0.0.beta.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c62aeea855bb28e59a5580d8babf88ff51a63f73aa0a3ff17721e6ed4aeb3da
-  data.tar.gz: 37e732954a981ad21f73d6baabea1857f21566e9534044a6c164b53b3277c123
+  metadata.gz: 106096bf50f3e6f1e98e570a806b2086bd5f9ad1d2a8740642d605efb4059e04
+  data.tar.gz: e9b763431f5c412a6aa3354f9b9e9c4ebd3ee6a1e36f7f9addd9b4c796811af1
 SHA512:
-  metadata.gz: 1202595935a48c8ed7d5b0e5b2462cad9e0e6b998be9c7c9f5a1742c5ce670b5bfe73ada71edf3f5c7e648bc9e97cd5e926254e46c322c58dac12a19f6669cf1
-  data.tar.gz: d006348ba01d732dfe2abd6bb09fa9d2b0128577011eb54df402ed43a4f04df300472e374d4f851d921be24e98800bbe6e0c6c636e0b30146e5d2c0e17f982c8
+  metadata.gz: 7d16d3e178791d3caaaf0acd7484c358ec09557a407c6ffa386c41ce5b27ba3d7e1d67f603f9db6993d13aa185d51a87cc2c18e4c46d868db7131852f713f770
+  data.tar.gz: d6b4d552c1eb6016e8a58ed06fee58719f49a0b775c588b6052da9ac6c97b2a3c1a71f80a1c2e9e0d0e7aa3734f0b3d27ddb9b2352ae9f81f3c2efbb6c9047df

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # AppSignal for Ruby gem Changelog
 
+## 4.0.0.beta.2
+
+_Published on 2024-08-19._
+
+### Added
+
+- Add a helper for parameters sample data to be unset. This is a private method until we stabilize it. (patch [e9336363](https://github.com/appsignal/appsignal-ruby/commit/e9336363fa869c88ab925f57e86ead45e8e18c29))
+
 ## 4.0.0.beta.1
 
 _Published on 2024-08-19._

data/lib/appsignal/helpers/instrumentation.rb

@@ -552,6 +552,20 @@ module Appsignal
       end
       alias :set_params :add_params
 
+      # Mark the parameters sample data to be set as an empty value.
+      #
+      # @api private
+      # @since 4.0.0
+      # @return [void]
+      # @see Helpers::Instrumentation#set_empty_params!
+      def set_empty_params!
+        return unless active?
+        return unless Appsignal::Transaction.current?
+
+        transaction = Appsignal::Transaction.current
+        transaction.set_empty_params!
+      end
+
       # Add session data to the current transaction.
       #
       # Session data is automatically added by most of our integrations. It

data/lib/appsignal/sample_data.rb

@@ -7,9 +7,11 @@ module Appsignal
       @key = key
       @accepted_type = accepted_type
       @blocks = []
+      @empty = false
     end
 
     def add(data = nil, &block)
+      @empty = false
       if block_given?
         @blocks << block
       elsif accepted_type?(data)
@@ -19,6 +21,12 @@ module Appsignal
       end
     end
 
+    # @api private
+    def set_empty_value!
+      @empty = true
+      @blocks.clear
+    end
+
     def value
       value = nil
       @blocks.map! do |block_or_value|
@@ -44,6 +52,11 @@ module Appsignal
       @blocks.any?
     end
 
+    # @api private
+    def empty?
+      @empty
+    end
+
     protected
 
     attr_reader :blocks

data/lib/appsignal/transaction.rb

@@ -246,6 +246,14 @@ module Appsignal
     end
     alias :set_params :add_params
 
+    # @api private
+    # @since 4.0.0
+    # @return [void]
+    # @see Helpers::Instrumentation#set_empty_params!
+    def set_empty_params!
+      @params.set_empty_value!
+    end
+
     # Add parameters to the transaction if not already set.
     #
     # @api private
@@ -257,7 +265,7 @@ module Appsignal
     #
     # @see #add_params
     def add_params_if_nil(given_params = nil, &block)
-      add_params(given_params, &block) unless @params.value?
+      add_params(given_params, &block) if !@params.value? && !@params.empty?
     end
     alias :set_params_if_nil :add_params_if_nil
 

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appsignal
-  VERSION = "4.0.0.beta.1"
+  VERSION = "4.0.0.beta.2"
 end

data/spec/lib/appsignal/sample_data_spec.rb

@@ -142,6 +142,45 @@ describe Appsignal::SampleData do
     end
   end
 
+  describe "#set_empty_value!" do
+    it "clears the set values" do
+      data.add(["abc"])
+      data.add(["def"])
+      data.set_empty_value!
+
+      expect(data.value).to be_nil
+    end
+
+    it "allows values to be added afterwards" do
+      data.add(["abc"])
+      data.set_empty_value!
+
+      expect(data.value).to be_nil
+
+      data.add(["def"])
+      expect(data.value).to eq(["def"])
+    end
+  end
+
+  describe "#cleared?" do
+    it "returns false if not cleared" do
+      expect(data.empty?).to be(false)
+    end
+
+    it "returns true if cleared" do
+      data.set_empty_value!
+
+      expect(data.empty?).to be(true)
+    end
+
+    it "returns false if cleared and then new values were added" do
+      data.set_empty_value!
+      data.add(["abc"])
+
+      expect(data.empty?).to be(false)
+    end
+  end
+
   describe "#duplicate" do
     it "duplicates the internal Hash state without modifying the original" do
       data = described_class.new(:my_key, Hash)

data/spec/lib/appsignal/transaction_spec.rb

@@ -732,6 +732,17 @@ describe Appsignal::Transaction do
         expect(transaction).to include_params(preset_params)
       end
     end
+
+    context "when the params were set as an empty value" do
+      it "does not set params on the transaction" do
+        transaction.add_params("key1" => "value")
+        transaction.set_empty_params!
+        transaction.add_params_if_nil("key2" => "value")
+
+        transaction._sample
+        expect(transaction).to_not include_params
+      end
+    end
   end
 
   describe "#add_session_data" do

data/spec/lib/appsignal_spec.rb

@@ -935,6 +935,23 @@ describe Appsignal do
       end
     end
 
+    describe ".set_empty_params!" do
+      before { start_agent }
+
+      context "with transaction" do
+        let(:transaction) { http_request_transaction }
+        before { set_current_transaction(transaction) }
+
+        it "marks parameters to be sent as an empty value" do
+          Appsignal.add_params("key1" => "value")
+          Appsignal.set_empty_params!
+
+          transaction._sample
+          expect(transaction).to_not include_params
+        end
+      end
+    end
+
     describe ".add_session_data" do
       before { start_agent }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 4.0.0.beta.1
+  version: 4.0.0.beta.2
 platform: ruby
 authors:
 - Robert Beekman