appsignal 3.4.5 → 3.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 705f36b319b37252017d10688f6429008bcd237eb36ae28792585a50551434fe
-  data.tar.gz: 411f73432159452ea26370a1e664cb440b3b6d89ffd0f0b4c2fe3400b4b3c043
+  metadata.gz: b2ca2df33b93d5de3deda35c427430f86c701e811c1e00a340d8a02e956fbb77
+  data.tar.gz: 69d319fa4870d64c3e54bb78f12c643934bb0a17c20145dcc373b52defcea554
 SHA512:
-  metadata.gz: 0b216dedc500b3a74adefec649b0cdb267f5f53ae670ec6662cbb1a10dfa9086ab3ab4b3a368ffdaeeb7ba48e54e5bb736da73b4e67d6c6e8fa01f053f865e0b
-  data.tar.gz: 8b9d4618362c63bb4dede332f5fa7e1c2b042cb673bacf70eb84233a7ad8d191740c2fdebd0ce28ce8fb9819dbc26e0a1053bbebad431bda6062aa555e08bb99
+  metadata.gz: 5791a6df017a1c54ce7631bbe61042150d500028dee4eda3f85d94c339c5c0728d103ece2586ed0cff2c45d8983de3e7ee1512a0b9221bd75db76e042a851f05
+  data.tar.gz: e23e971908c575908983bd7f16ed6321f559799af5e6442766208532a117722dc51d245b11d723a08a22e348b18cbec6f2911f52abe598df87be24cc2aea1743

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # AppSignal for Ruby gem Changelog
 
+## 3.4.6
+
+### Changed
+
+- [85c155a0](https://github.com/appsignal/appsignal-ruby/commit/85c155a0a4b2b618c04db52c34ee7f0adba8f3c5) patch - When sanitizing an array or hash, replace recursively nested values with a placeholder string. This fixes a SystemStackError issue when sanitising arrays and hashes.
+
 ## 3.4.5
 
 ### Added

data/lib/appsignal/utils/hash_sanitizer.rb

@@ -5,20 +5,21 @@ module Appsignal
     # @api private
     class HashSanitizer
       FILTERED = "[FILTERED]"
+      RECURSIVE = "[RECURSIVE VALUE]"
 
       class << self
         def sanitize(value, filter_keys = [])
-          sanitize_value(value, filter_keys)
+          sanitize_value(value, filter_keys, [])
         end
 
         private
 
-        def sanitize_value(value, filter_keys)
+        def sanitize_value(value, filter_keys, seen)
           case value
           when Hash
-            sanitize_hash(value, filter_keys)
+            sanitize_hash(value, filter_keys, seen)
           when Array
-            sanitize_array(value, filter_keys)
+            sanitize_array(value, filter_keys, seen)
           when TrueClass, FalseClass, NilClass, Integer, String, Symbol, Float
             unmodified(value)
           else
@@ -26,23 +27,34 @@ module Appsignal
           end
         end
 
-        def sanitize_hash(source, filter_keys)
+        def sanitize_hash(source, filter_keys, seen)
+          seen = seen.clone << source.object_id
+
           {}.tap do |hash|
             source.each_pair do |key, value|
               hash[key] =
-                if filter_keys.include?(key.to_s)
+                if seen.include?(value.object_id)
+                  RECURSIVE
+                elsif filter_keys.include?(key.to_s)
                   FILTERED
                 else
-                  sanitize_value(value, filter_keys)
+                  sanitize_value(value, filter_keys, seen)
                 end
             end
           end
         end
 
-        def sanitize_array(source, filter_keys)
+        def sanitize_array(source, filter_keys, seen)
+          seen = seen.clone << source.object_id
+
           [].tap do |array|
             source.each_with_index do |item, index|
-              array[index] = sanitize_value(item, filter_keys)
+              array[index] =
+                if seen.include?(item.object_id)
+                  RECURSIVE
+                else
+                  sanitize_value(item, filter_keys, seen)
+                end
             end
           end
         end

data/lib/appsignal/version.rb

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

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

@@ -1,5 +1,7 @@
 describe Appsignal::Utils::HashSanitizer do
   let(:file) { uploaded_file }
+  let(:some_array) { [1, 2, 3] }
+  let(:some_hash) { { :a => 1, :b => 2 } }
   let(:params) do
     {
       :text => "string",
@@ -8,6 +10,10 @@ describe Appsignal::Utils::HashSanitizer do
       :float => 0.0,
       :bool_true => true,
       :bool_false => false,
+      # Non-recursive appearances of the same array instance
+      :some_arrays => [some_array, some_array],
+      # Non-recursive appearances of the same hash instance
+      :some_hashes => { :a => some_hash, :b => some_hash },
       :nil => nil,
       :int => 1, # Fixnum
       :int64 => 1 << 64, # Bignum
@@ -20,9 +26,20 @@ describe Appsignal::Utils::HashSanitizer do
           {
             :key => "value",
             :file => file
-          }
-        ]
-      }
+          }.tap do |hsh|
+            # Recursive hash-in-hash (should be [:nested_array][3][:recursive_hash])
+            hsh[:recursive_hash] = hsh
+          end
+        ].tap do |ary|
+          # Recursive array-in-array (should be [:nested_array][4])
+          ary << ary
+          # Recursive array-in-hash (should be [:nested_array][3][:recursive_array])
+          ary[3][:recursive_array] = ary
+        end
+      }.tap do |hsh|
+        # Recursive hash-in-array (should be [:nested_array][5])
+        hsh[:nested_array] << hsh
+      end
     }
   end
 
@@ -43,6 +60,9 @@ describe Appsignal::Utils::HashSanitizer do
       expect(subject[:nil]).to be_nil
       expect(subject[:int]).to eq(1)
       expect(subject[:int64]).to eq(1 << 64)
+      expect(subject[:some_arrays]).to eq([[1, 2, 3], [1, 2, 3]])
+      expect(subject[:some_hashes]).to eq({ :a => { :a => 1, :b => 2 },
+:b => { :a => 1, :b => 2 } })
     end
 
     it "does not change the original params" do
@@ -72,7 +92,7 @@ describe Appsignal::Utils::HashSanitizer do
           expect(subject[2]).to include "::UploadedFile"
         end
 
-        describe ":nested_hash key" do
+        describe "nested hash" do
           subject { sanitized_params[:hash][:nested_array][3] }
 
           it "returns a sanitized Hash" do
@@ -82,6 +102,24 @@ describe Appsignal::Utils::HashSanitizer do
             expect(subject[:file]).to be_instance_of String
             expect(subject[:file]).to include "::UploadedFile"
           end
+
+          it "replaces a recursive array" do
+            expect(subject[:recursive_array]).to eq("[RECURSIVE VALUE]")
+          end
+
+          it "replaces a recursive hash" do
+            expect(subject[:recursive_hash]).to eq("[RECURSIVE VALUE]")
+          end
+        end
+
+        describe "nested array" do
+          it "replaces a recursive array" do
+            expect(sanitized_params[:hash][:nested_array][4]).to eq("[RECURSIVE VALUE]")
+          end
+
+          it "replaces a recursive hash" do
+            expect(sanitized_params[:hash][:nested_array][5]).to eq("[RECURSIVE VALUE]")
+          end
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 3.4.5
+  version: 3.4.6
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-27 00:00:00.000000000 Z
+date: 2023-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -439,7 +439,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.8
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Logs performance and exception data from your app to appsignal.com