appsignal 3.0.20 → 3.0.21.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18e505270b1fc0966691e2d270ae08fbe7157ee4fde1708dd3252e7da69c7c9e
-  data.tar.gz: 37340595960a772bd6e094a6fc04d4f8940ac0ef96ecb3e848d7ce58f3f5019e
+  metadata.gz: 4d00b4618b222cc7be43c7bcd79445b41b356714b682bf0aa3737c131ef9893b
+  data.tar.gz: 38099b1d602f9aed9b67d38e24cee1fa7b63cf069ad806e218b8d360f4655806
 SHA512:
-  metadata.gz: e4caeabfd901dfaae05d3aece53d2f346a80cb7e7134a98e59cc9c52788d0536ec3866dbb0371e5da8f3514a2b1e6301686670604c7b43c2a30c0ea24dd78ae2
-  data.tar.gz: a3c490e7d04be8896d9513041d3d37e58dd5179664c8725d6939b432f6b516f70d27b3e27f2afde407cf145775a174619745976ab31c50747acbbbc7af29eb55
+  metadata.gz: 1514603d5cd1ae152f5b9e1bbe9297c20172e6d30f223c57a2ba7f0e9ab50e6937a207ceb32d12441a735286f0fa25cd47cc51fbc8f2fb66339d64bc2da13dbf
+  data.tar.gz: 85e43d5094ac8247abe40cade7fe61665a8fc1f0d655db63277db1a9875fa61ab675f35ef48f04f17a77882d80003b1c0d0dac4aff10f2ef6a25957b5f70796f

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # AppSignal for Ruby gem Changelog
 
+## 3.0.21.alpha.1
+
+### Changed
+
+- [f19d9dcc](https://github.com/appsignal/appsignal-ruby/commit/f19d9dcc1c00103f5dc92951481becf4d4ade39e) patch - The MongoDB query sanitization now shows all the attributes in the query at all levels.
+  Only the actual values are filtered with a `?` character. Less MongoDB queries are now marked
+  as N+1 queries when they weren't the exact same query. This increases the number of unique events
+  AppSignal tracks for MongoDB queries.
+
 ## 3.0.20
 
 ### Added

data/appsignal.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |gem| # rubocop:disable Metrics/BlockLength
   gem.extensions            = %w[ext/extconf.rb]
 
   gem.metadata = {
+    "rubygems_mfa_required" => "true",
     "bug_tracker_uri"   => "https://github.com/appsignal/appsignal-ruby/issues",
     "changelog_uri"     =>
       "https://github.com/appsignal/appsignal-ruby/blob/main/CHANGELOG.md",

data/lib/appsignal/event_formatter/mongo_ruby_driver/query_formatter.rb

@@ -21,28 +21,28 @@ module Appsignal
           },
           "insert" => {
             "insert"    => :allow,
-            "documents" => :deny_array,
+            "documents" => :sanitize_document,
             "ordered"   => :allow
           },
           "update" => {
             "update"  => :allow,
-            "updates" => :sanitize_bulk,
+            "updates" => :sanitize_document,
             "ordered" => :allow
           },
           "findandmodify" => {
             "findandmodify" => :allow,
             "query"         => :sanitize_document,
-            "update"        => :deny_array,
+            "update"        => :sanitize_document,
             "new"           => :allow
           },
           "delete" => {
             "delete" => :allow,
-            "deletes" => :sanitize_bulk,
+            "deletes" => :sanitize_document,
             "ordered" => :allow
           },
           "bulk" => {
             "q"      => :sanitize_document,
-            "u"      => :deny_array,
+            "u"      => :sanitize_document,
             "limit"  => :allow,
             "multi"  => :allow,
             "upsert" => :allow
@@ -68,20 +68,9 @@ module Appsignal
         # Applies strategy on hash values based on keys
         def self.apply_strategy(strategy, val)
           case strategy
-          when :allow      then val
-          when :deny       then "?"
-          when :deny_array then "[?]"
+          when :allow then val
           when :sanitize_document
-            Appsignal::Utils::QueryParamsSanitizer.sanitize(val, true, :mongodb)
-          when :sanitize_bulk
-            if val.length > 1
-              [
-                format(:bulk, val.first),
-                "[...]"
-              ]
-            else
-              val.map { |v| format(:bulk, v) }
-            end
+            Appsignal::Utils::QueryParamsSanitizer.sanitize(val, false, :mongodb)
           else "?"
           end
         end

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appsignal
-  VERSION = "3.0.20".freeze
+  VERSION = "3.0.21.alpha.1".freeze
 end

data/spec/lib/appsignal/event_formatter/mongo_ruby_driver/query_formatter_spec.rb

@@ -11,8 +11,12 @@ describe Appsignal::EventFormatter::MongoRubyDriver::QueryFormatter do
     end
 
     it "should apply a strategy for each key" do
+      # TODO: additional curly brackets required for issue
+      # https://github.com/rspec/rspec-mocks/issues/1460
+      # rubocop:disable Style/BracesAroundHashParameters
       expect(formatter).to receive(:apply_strategy)
-        .with(:sanitize_document, "_id" => 1)
+        .with(:sanitize_document, { "_id" => 1 })
+      # rubocop:enable Style/BracesAroundHashParameters
 
       expect(formatter).to receive(:apply_strategy)
         .with(:allow, "users")
@@ -47,57 +51,27 @@ describe Appsignal::EventFormatter::MongoRubyDriver::QueryFormatter do
       end
     end
 
-    context "when strategy is deny" do
-      let(:strategy) { :deny }
-      let(:value)    { { "_id" => 1 } }
-
-      it "should return a '?'" do
-        expect(formatter.apply_strategy(strategy, value)).to eql("?")
-      end
-    end
-
-    context "when strategy is deny_array" do
-      let(:strategy) { :deny_array }
-      let(:value)    { { "_id" => 1 } }
-
-      it "should return a sanitized array string" do
-        expect(formatter.apply_strategy(strategy, value)).to eql("[?]")
-      end
-    end
-
     context "when strategy is sanitize_document" do
       let(:strategy) { :sanitize_document }
-      let(:value)    { { "_id" => 1 } }
-
-      it "should return a sanitized document" do
-        expect(formatter.apply_strategy(strategy, value)).to eql("_id" => "?")
-      end
-    end
-
-    context "when strategy is sanitize_bulk" do
-      let(:strategy) { :sanitize_bulk }
-      let(:value)    { [{ "q" => { "_id" => 1 }, "u" => [{ "foo" => "bar" }] }] }
-
-      it "should return an array of sanitized bulk documents" do
-        expect(formatter.apply_strategy(strategy, value)).to eql([
-          { "q" => { "_id" => "?" }, "u" => "[?]" }
-        ])
+      let(:value) do
+        {
+          "_id" => 1,
+          "authors" => [
+            { "name" => "BarBaz" },
+            { "name" => "FooBar" },
+            { "name" => "BarFoo", "surname" => "Baz" }
+          ]
+        }
       end
 
-      context "when bulk has more than one update" do
-        let(:value) do
-          [
-            { "q" => { "_id" => 1 }, "u" => [{ "foo" => "bar" }] },
-            { "q" => { "_id" => 2 }, "u" => [{ "foo" => "baz" }] }
+      it "should return a sanitized document" do
+        expect(formatter.apply_strategy(strategy, value)).to eql(
+          "_id" => "?",
+          "authors" => [
+            { "name" => "?" },
+            { "name" => "?", "surname" => "?" }
           ]
-        end
-
-        it "should return only the first value of sanitized bulk documents" do
-          expect(formatter.apply_strategy(strategy, value)).to eql([
-            { "q" => { "_id" => "?" }, "u" => "[?]" },
-            "[...]"
-          ])
-        end
+        )
       end
     end
 

data/spec/lib/appsignal/integrations/mongo_ruby_driver_spec.rb

@@ -17,8 +17,12 @@ describe Appsignal::Hooks::MongoMonitorSubscriber do
       end
 
       it "should sanitize command" do
+        # TODO: additional curly brackets required for issue
+        # https://github.com/rspec/rspec-mocks/issues/1460
+        # rubocop:disable Style/BracesAroundHashParameters
         expect(Appsignal::EventFormatter::MongoRubyDriver::QueryFormatter)
-          .to receive(:format).with("find", "foo" => "bar")
+          .to receive(:format).with("find", { "foo" => "bar" })
+        # rubocop:enable Style/BracesAroundHashParameters
 
         subscriber.started(event)
       end

data/spec/lib/appsignal/integrations/sidekiq_spec.rb

@@ -228,10 +228,14 @@ describe Appsignal::Integrations::SidekiqMiddleware, :with_yaml_parse_error => f
     let(:error) { ExampleException }
 
     it "creates a transaction and adds the error" do
+      # TODO: additional curly brackets required for issue
+      # https://github.com/rspec/rspec-mocks/issues/1460
+      # rubocop:disable Style/BracesAroundHashParameters
       expect(Appsignal).to receive(:increment_counter)
-        .with("sidekiq_queue_job_count", 1, :queue => "default", :status => :failed)
+        .with("sidekiq_queue_job_count", 1, { :queue => "default", :status => :failed })
       expect(Appsignal).to receive(:increment_counter)
-        .with("sidekiq_queue_job_count", 1, :queue => "default", :status => :processed)
+        .with("sidekiq_queue_job_count", 1, { :queue => "default", :status => :processed })
+      # rubocop:enable Style/BracesAroundHashParameters
 
       expect do
         perform_job { raise error, "uh oh" }
@@ -267,8 +271,12 @@ describe Appsignal::Integrations::SidekiqMiddleware, :with_yaml_parse_error => f
 
   context "without an error" do
     it "creates a transaction with events" do
+      # TODO: additional curly brackets required for issue
+      # https://github.com/rspec/rspec-mocks/issues/1460
+      # rubocop:disable Style/BracesAroundHashParameters
       expect(Appsignal).to receive(:increment_counter)
-        .with("sidekiq_queue_job_count", 1, :queue => "default", :status => :processed)
+        .with("sidekiq_queue_job_count", 1, { :queue => "default", :status => :processed })
+      # rubocop:enable Style/BracesAroundHashParameters
 
       perform_job
 

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

@@ -117,7 +117,7 @@ describe Appsignal::Utils::QueryParamsSanitizer do
       context "when value is an array" do
         let(:value) { %w[foo bar] }
 
-        it "should sanitize all hash values with a single questionmark" do
+        it "should sanitize all hash values with a single question mark" do
           expect(subject).to eq(["?"])
         end
       end
@@ -125,7 +125,7 @@ describe Appsignal::Utils::QueryParamsSanitizer do
       context "when value is a mixed array" do
         let(:value) { [nil, "foo", "bar"] }
 
-        it "should sanitize all hash values with a single questionmark" do
+        it "should sanitize all hash values with a single question mark" do
           expect(subject).to eq(["?"])
         end
       end

data/spec/lib/appsignal_spec.rb

@@ -427,49 +427,89 @@ describe Appsignal do
     end
 
     describe ".monitor_single_transaction" do
+      around { |example| keep_transactions { example.run } }
+
       context "with a successful call" do
-        it "should call monitor_transaction and stop" do
-          expect(Appsignal).to receive(:monitor_transaction).with(
-            "perform_job.something",
-            :key => :value
-          ).and_yield
+        it "calls monitor_transaction and Appsignal.stop" do
           expect(Appsignal).to receive(:stop)
 
-          Appsignal.monitor_single_transaction("perform_job.something", :key => :value) do
+          Appsignal.monitor_single_transaction(
+            "perform_job.something",
+            :controller => :my_controller,
+            :action => :my_action
+          ) do
             # nothing
           end
+
+          transaction = last_transaction
+          transaction_hash = transaction.to_h
+          expect(transaction_hash).to include(
+            "action" => "my_controller#my_action"
+          )
+          expect(transaction_hash["events"]).to match([
+            hash_including(
+              "name" => "perform_job.something",
+              "title" => "",
+              "body" => "",
+              "body_format" => Appsignal::EventFormatter::DEFAULT
+            )
+          ])
         end
       end
 
       context "with an erroring call" do
         let(:error) { ExampleException.new }
 
-        it "should call monitor_transaction and stop and then raise the error" do
-          expect(Appsignal).to receive(:monitor_transaction).with(
-            "perform_job.something",
-            :key => :value
-          ).and_yield
+        it "calls monitor_transaction and stop and re-raises the error" do
           expect(Appsignal).to receive(:stop)
 
           expect do
-            Appsignal.monitor_single_transaction("perform_job.something", :key => :value) do
+            Appsignal.monitor_single_transaction(
+              "perform_job.something",
+              :controller => :my_controller,
+              :action => :my_action
+            ) do
               raise error
             end
           end.to raise_error(error)
+
+          transaction = last_transaction
+          transaction_hash = transaction.to_h
+          expect(transaction_hash).to include(
+            "action" => "my_controller#my_action"
+          )
+          expect(transaction_hash["events"]).to match([
+            hash_including(
+              "name" => "perform_job.something",
+              "title" => "",
+              "body" => "",
+              "body_format" => Appsignal::EventFormatter::DEFAULT
+            )
+          ])
         end
       end
     end
 
     describe ".tag_request" do
-      before { allow(Appsignal::Transaction).to receive(:current).and_return(transaction) }
+      let(:transaction) { http_request_transaction }
+      around do |example|
+        start_agent
+        with_current_transaction transaction do
+          keep_transactions { example.run }
+        end
+      end
 
       context "with transaction" do
-        let(:transaction) { double }
-        it "should call set_tags on transaction" do
-          expect(transaction).to receive(:set_tags).with("a" => "b")
-        end
+        it "calls set_tags on the current transaction" do
+          Appsignal.tag_request("a" => "b")
+          transaction.complete # Manually trigger transaction sampling
 
-        after { Appsignal.tag_request("a" => "b") }
+          expect(transaction.to_h).to include(
+            "sample_data" => hash_including(
+              "tags" => { "a" => "b" }
+            )
+          )
+        end
       end
 
       context "without transaction" do

data/spec/support/helpers/transaction_helpers.rb

@@ -56,6 +56,16 @@ module TransactionHelpers
     Thread.current[:appsignal_transaction] = nil
   end
 
+  # Set the current for the duration of the given block.
+  #
+  # Helper for {set_current_transaction} and {clear_current_transaction!}
+  def with_current_transaction(transaction)
+    set_current_transaction transaction
+    yield
+  ensure
+    clear_current_transaction!
+  end
+
   # Track the AppSignal transaction JSON when a transaction gets completed
   # ({Appsignal::Transaction.complete}).
   #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 3.0.20
+  version: 3.0.21.alpha.1
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-17 00:00:00.000000000 Z
+date: 2022-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -405,6 +405,7 @@ homepage: https://github.com/appsignal/appsignal-ruby
 licenses:
 - MIT
 metadata:
+  rubygems_mfa_required: 'true'
   bug_tracker_uri: https://github.com/appsignal/appsignal-ruby/issues
   changelog_uri: https://github.com/appsignal/appsignal-ruby/blob/main/CHANGELOG.md
   documentation_uri: https://docs.appsignal.com/ruby/
@@ -422,11 +423,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.3.4
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Logs performance and exception data from your app to appsignal.com