appsignal 3.9.2-java → 3.10.0-java

data/spec/lib/appsignal/transaction_spec.rb

@@ -40,10 +40,8 @@ describe Appsignal::Transaction do
           expect(transaction.namespace).to eq namespace
           expect(transaction.request).to eq request
 
-          expect(transaction.to_h).to include(
-            "id" => transaction_id,
-            "namespace" => namespace
-          )
+          expect(transaction).to have_id(transaction_id)
+          expect(transaction).to have_namespace(namespace)
         end
 
         it "assigns the transaction to current" do
@@ -85,10 +83,6 @@ describe Appsignal::Transaction do
     end
 
     describe ".current" do
-      def current_transaction
-        Appsignal::Transaction.current
-      end
-
       context "when there is a current transaction" do
         let!(:transaction) do
           Appsignal::Transaction.create(transaction_id, namespace, request, options)
@@ -166,9 +160,7 @@ describe Appsignal::Transaction do
       it "samples data" do
         transaction.set_tags(:foo => "bar")
         keep_transactions { transaction.complete }
-        expect(transaction.to_h["sample_data"]).to include(
-          "tags" => { "foo" => "bar" }
-        )
+        expect(transaction).to include_tags("foo" => "bar")
       end
     end
 
@@ -181,13 +173,13 @@ describe Appsignal::Transaction do
 
     context "when a transaction is marked as discarded" do
       it "does not complete the transaction" do
-        expect(transaction.ext).to_not receive(:complete)
-
         expect do
           transaction.discard!
         end.to change { transaction.discarded? }.from(false).to(true)
 
         transaction.complete
+
+        expect(transaction).to_not be_completed
       end
 
       it "logs a debug message" do
@@ -202,13 +194,13 @@ describe Appsignal::Transaction do
         before { transaction.discard! }
 
         it "completes the transaction" do
-          expect(transaction.ext).to receive(:complete).and_call_original
-
           expect do
             transaction.restore!
           end.to change { transaction.discarded? }.from(true).to(false)
 
           transaction.complete
+
+          expect(transaction).to be_completed
         end
       end
     end
@@ -334,6 +326,16 @@ describe Appsignal::Transaction do
         it "returns custom parameters" do
           expect(subject).to eq(:foo => "bar")
         end
+
+        context "when params is a callable object" do
+          it "calls the params object and sets the return value as parametesr" do
+            transaction.set_params { { "param1" => "value1" } }
+
+            expect(transaction.params).to eq(
+              "param1" => "value1"
+            )
+          end
+        end
       end
 
       context "without custom params set on transaction" do
@@ -354,9 +356,9 @@ describe Appsignal::Transaction do
         params = { "foo" => "bar" }
         silence { transaction.params = params }
 
-        transaction.complete # Sample the data
+        transaction._sample
         expect(transaction.params).to eq(params)
-        expect(transaction.to_h.dig("sample_data", "params")).to eq(params)
+        expect(transaction).to include_params(params)
       end
 
       it "logs a deprecation warning" do
@@ -378,9 +380,28 @@ describe Appsignal::Transaction do
           params = { "key" => "value" }
           transaction.set_params(params)
 
-          transaction.complete # Sample the data
+          transaction._sample
           expect(transaction.params).to eq(params)
-          expect(transaction.to_h.dig("sample_data", "params")).to eq(params)
+          expect(transaction).to include_params(params)
+        end
+
+        it "updates the params on the transaction with a block" do
+          params = { "key" => "value" }
+          transaction.set_params { params }
+
+          transaction._sample
+          expect(transaction.params).to eq(params)
+          expect(transaction).to include_params(params)
+        end
+
+        it "updates with the params argument when both an argument and block are given" do
+          arg_params = { "argument" => "value" }
+          block_params = { "block" => "value" }
+          transaction.set_params(arg_params) { block_params }
+
+          transaction._sample
+          expect(transaction.params).to eq(arg_params)
+          expect(transaction).to include_params(arg_params)
         end
       end
 
@@ -390,9 +411,9 @@ describe Appsignal::Transaction do
           transaction.set_params(params)
           transaction.set_params(nil)
 
-          transaction.complete # Sample the data
+          transaction._sample
           expect(transaction.params).to eq(params)
-          expect(transaction.to_h.dig("sample_data", "params")).to eq(params)
+          expect(transaction).to include_params(params)
         end
       end
     end
@@ -405,9 +426,28 @@ describe Appsignal::Transaction do
           params = { "key" => "value" }
           transaction.set_params_if_nil(params)
 
-          transaction.complete # Sample the data
+          transaction._sample
           expect(transaction.params).to eq(params)
-          expect(transaction.to_h.dig("sample_data", "params")).to eq(params)
+          expect(transaction).to include_params(params)
+        end
+
+        it "updates the params on the transaction with a block" do
+          params = { "key" => "value" }
+          transaction.set_params_if_nil { params }
+
+          transaction._sample
+          expect(transaction.params).to eq(params)
+          expect(transaction).to include_params(params)
+        end
+
+        it "updates with the params argument when both an argument and block are given" do
+          arg_params = { "argument" => "value" }
+          block_params = { "block" => "value" }
+          transaction.set_params_if_nil(arg_params) { block_params }
+
+          transaction._sample
+          expect(transaction.params).to eq(arg_params)
+          expect(transaction).to include_params(arg_params)
         end
 
         context "when the given params is nil" do
@@ -416,9 +456,9 @@ describe Appsignal::Transaction do
             transaction.set_params(params)
             transaction.set_params_if_nil(nil)
 
-            transaction.complete # Sample the data
+            transaction._sample
             expect(transaction.params).to eq(params)
-            expect(transaction.to_h.dig("sample_data", "params")).to eq(params)
+            expect(transaction).to include_params(params)
           end
         end
       end
@@ -430,16 +470,28 @@ describe Appsignal::Transaction do
           transaction.set_params(preset_params)
           transaction.set_params_if_nil(params)
 
-          transaction.complete # Sample the data
+          transaction._sample
           expect(transaction.params).to eq(preset_params)
-          expect(transaction.to_h.dig("sample_data", "params")).to eq(preset_params)
+          expect(transaction).to include_params(preset_params)
+        end
+
+        it "does not update the params with a block on the transaction" do
+          preset_params = { "other" => "params" }
+          params = { "key" => "value" }
+          transaction.set_params(preset_params)
+          transaction.set_params_if_nil { params }
+
+          transaction._sample
+          expect(transaction.params).to eq(preset_params)
+          expect(transaction).to include_params(preset_params)
         end
       end
     end
 
     describe "#set_tags" do
       let(:long_string) { "a" * 10_001 }
-      before do
+
+      it "stores tags on the transaction" do
         transaction.set_tags(
           :valid_key => "valid_value",
           "valid_string_key" => "valid_value",
@@ -451,11 +503,9 @@ describe Appsignal::Transaction do
           :too_long_value => long_string,
           long_string => "too_long_key"
         )
-        transaction.sample_data
-      end
+        transaction._sample
 
-      it "stores tags on the transaction" do
-        expect(transaction.to_h["sample_data"]["tags"]).to eq(
+        expect(transaction).to include_tags(
           "valid_key" => "valid_value",
           "valid_string_key" => "valid_value",
           "both_symbols" => "valid_value",
@@ -464,6 +514,96 @@ describe Appsignal::Transaction do
           long_string => "too_long_key"
         )
       end
+
+      it "merges the tags when called multiple times" do
+        transaction.set_tags(:key1 => "value1")
+        transaction.set_tags(:key2 => "value2")
+        transaction._sample
+
+        expect(transaction).to include_tags(
+          "key1" => "value1",
+          "key2" => "value2"
+        )
+      end
+    end
+
+    describe "#set_custom_data" do
+      let(:log_stream) { std_stream }
+      let(:logs) { log_contents(log_stream) }
+      around { |example| use_logger_with(log_stream) { example.run } }
+
+      it "stores custom Hash data on the transaction" do
+        transaction.set_custom_data(
+          :user => {
+            :id => 123,
+            :locale => "abc"
+          },
+          :organization => {
+            :slug => "appsignal",
+            :plan => "enterprise"
+          }
+        )
+
+        transaction._sample
+        expect(transaction).to include_custom_data(
+          "user" => {
+            "id" => 123,
+            "locale" => "abc"
+          },
+          "organization" => {
+            "slug" => "appsignal",
+            "plan" => "enterprise"
+          }
+        )
+      end
+
+      it "stores custom Array data on the transaction" do
+        transaction.set_custom_data([
+          [123, "abc"],
+          ["appsignal", "enterprise"]
+        ])
+
+        transaction._sample
+        expect(transaction).to include_custom_data([
+          [123, "abc"],
+          ["appsignal", "enterprise"]
+        ])
+      end
+
+      it "does not store non Hash or Array custom data" do
+        transaction.set_custom_data("abc")
+        transaction._sample
+        expect(transaction).to_not include_custom_data
+
+        transaction.set_custom_data(123)
+        transaction._sample
+        expect(transaction).to_not include_custom_data
+
+        transaction.set_custom_data(Object.new)
+        transaction._sample
+        expect(transaction).to_not include_custom_data
+
+        expect(logs).to contains_log(
+          :error,
+          "set_custom_data: Unsupported data type String received."
+        )
+        expect(logs).to contains_log(
+          :error,
+          "set_custom_data: Unsupported data type Integer received."
+        )
+        expect(logs).to contains_log(
+          :error,
+          "set_custom_data: Unsupported data type String received."
+        )
+      end
+
+      it "overwrites the custom data if called multiple times" do
+        transaction.set_custom_data("user" => { "id" => 123 })
+        transaction.set_custom_data("user" => { "id" => 456 })
+
+        transaction._sample
+        expect(transaction).to include_custom_data("user" => { "id" => 456 })
+      end
     end
 
     describe "#add_breadcrumb" do
@@ -507,12 +647,13 @@ describe Appsignal::Transaction do
           transaction.sample_data
           timeframe_end = Time.now.utc.to_i
 
-          breadcrumb = transaction.to_h["sample_data"]["breadcrumbs"][0]
-          expect(breadcrumb["category"]).to eq("user_action")
-          expect(breadcrumb["action"]).to eq("clicked HOME")
-          expect(breadcrumb["message"]).to eq("")
-          expect(breadcrumb["time"]).to be_between(timeframe_start, timeframe_end)
-          expect(breadcrumb["metadata"]).to eq({})
+          expect(transaction).to include_breadcrumb(
+            "clicked HOME",
+            "user_action",
+            "",
+            {},
+            be_between(timeframe_start, timeframe_end)
+          )
         end
       end
 
@@ -521,7 +662,7 @@ describe Appsignal::Transaction do
           transaction.add_breadcrumb("category", "action", "message", "invalid metadata")
           transaction.sample_data
 
-          expect(transaction.to_h["sample_data"]["breadcrumbs"]).to be_empty
+          expect(transaction).to_not include_breadcrumbs
           expect(log_contents(log)).to contains_log(
             :error,
             "add_breadcrumb: Cannot add breadcrumb. The given metadata argument is not a Hash."
@@ -537,7 +678,7 @@ describe Appsignal::Transaction do
           transaction.set_action(action_name)
 
           expect(transaction.action).to eq(action_name)
-          expect(transaction.to_h["action"]).to eq(action_name)
+          expect(transaction).to have_action(action_name)
         end
       end
 
@@ -548,7 +689,7 @@ describe Appsignal::Transaction do
           transaction.set_action(nil)
 
           expect(transaction.action).to eq(action_name)
-          expect(transaction.to_h["action"]).to eq(action_name)
+          expect(transaction).to have_action(action_name)
         end
       end
     end
@@ -557,13 +698,13 @@ describe Appsignal::Transaction do
       context "when the action is not set" do
         it "updates the action name on the transaction" do
           expect(transaction.action).to eq(nil)
-          expect(transaction.to_h["action"]).to eq(nil)
+          expect(transaction).to_not have_action
 
           action_name = "PagesController#show"
           transaction.set_action_if_nil(action_name)
 
           expect(transaction.action).to eq(action_name)
-          expect(transaction.to_h["action"]).to eq(action_name)
+          expect(transaction).to have_action(action_name)
         end
 
         context "when the given action is nil" do
@@ -573,7 +714,7 @@ describe Appsignal::Transaction do
             transaction.set_action_if_nil(nil)
 
             expect(transaction.action).to eq(action_name)
-            expect(transaction.to_h["action"]).to eq(action_name)
+            expect(transaction).to have_action(action_name)
           end
         end
       end
@@ -585,7 +726,7 @@ describe Appsignal::Transaction do
           transaction.set_action_if_nil("something else")
 
           expect(transaction.action).to eq(action_name)
-          expect(transaction.to_h["action"]).to eq(action_name)
+          expect(transaction).to have_action(action_name)
         end
       end
     end
@@ -597,7 +738,7 @@ describe Appsignal::Transaction do
           transaction.set_namespace(namespace)
 
           expect(transaction.namespace).to eq namespace
-          expect(transaction.to_h["namespace"]).to eq(namespace)
+          expect(transaction).to have_namespace(namespace)
         end
       end
 
@@ -608,7 +749,7 @@ describe Appsignal::Transaction do
           transaction.set_namespace(nil)
 
           expect(transaction.namespace).to eq(namespace)
-          expect(transaction.to_h["namespace"]).to eq(namespace)
+          expect(transaction).to have_namespace(namespace)
         end
       end
     end
@@ -620,21 +761,21 @@ describe Appsignal::Transaction do
             :controller => "HomeController",
             :action => "show"
           )
-          expect(transaction.to_h["action"]).to eql("HomeController#show")
+          expect(transaction).to have_action("HomeController#show")
         end
       end
 
       context "for a hash with just action" do
         it "sets the action" do
           transaction.set_http_or_background_action(:action => "show")
-          expect(transaction.to_h["action"]).to eql("show")
+          expect(transaction).to have_action("show")
         end
       end
 
       context "for a hash with class and method" do
         it "sets the action" do
           transaction.set_http_or_background_action(:class => "Worker", :method => "perform")
-          expect(transaction.to_h["action"]).to eql("Worker#perform")
+          expect(transaction).to have_action("Worker#perform")
         end
       end
 
@@ -642,7 +783,7 @@ describe Appsignal::Transaction do
         it "does not overwrite the set action" do
           transaction.set_action("MyCustomAction#perform")
           transaction.set_http_or_background_action(:class => "Worker", :method => "perform")
-          expect(transaction.to_h["action"]).to eql("MyCustomAction#perform")
+          expect(transaction).to have_action("MyCustomAction#perform")
         end
       end
     end
@@ -665,9 +806,7 @@ describe Appsignal::Transaction do
 
         expect(Appsignal.internal_logger).to receive(:warn).with("Queue start value 10 is too big")
 
-        expect do
-          transaction.set_queue_start(10)
-        end.to_not raise_error
+        transaction.set_queue_start(10)
       end
     end
 
@@ -716,7 +855,7 @@ describe Appsignal::Transaction do
       it "updates the metadata on the transaction" do
         transaction.set_metadata("request_method", "GET")
 
-        expect(transaction.to_h["metadata"]).to eq("request_method" => "GET")
+        expect(transaction).to include_metadata("request_method" => "GET")
       end
 
       context "when filter_metadata includes metadata key" do
@@ -727,7 +866,7 @@ describe Appsignal::Transaction do
           transaction.set_metadata(:filter_key, "filtered value")
           transaction.set_metadata("filter_key", "filtered value")
 
-          expect(transaction.to_h["metadata"].keys).to_not include("filter_key")
+          expect(transaction).to_not include_metadata("filter_key" => anything)
         end
       end
 
@@ -735,7 +874,7 @@ describe Appsignal::Transaction do
         it "does not update the metadata on the transaction" do
           transaction.set_metadata(nil, "GET")
 
-          expect(transaction.to_h["metadata"]).to eq({})
+          expect(transaction).to_not include_metadata
         end
       end
 
@@ -743,7 +882,7 @@ describe Appsignal::Transaction do
         it "does not update the metadata on the transaction" do
           transaction.set_metadata("request_method", nil)
 
-          expect(transaction.to_h["metadata"]).to eq({})
+          expect(transaction).to_not include_metadata
         end
       end
     end
@@ -757,12 +896,10 @@ describe Appsignal::Transaction do
           :id         => "1"
         )
 
-        expect(transaction.to_h["sample_data"]).to eq(
-          "params" => {
-            "action" => "show",
-            "controller" => "blog_posts",
-            "id" => "1"
-          }
+        expect(transaction).to include_params(
+          "action" => "show",
+          "controller" => "blog_posts",
+          "id" => "1"
         )
       end
 
@@ -785,7 +922,7 @@ describe Appsignal::Transaction do
           end
           transaction.set_sample_data("params", klass.new => 1)
 
-          expect(transaction.to_h["sample_data"]).to eq({})
+          expect(transaction).to_not include_params
           expect(log_contents(log)).to contains_log :error,
             "Error generating data (RuntimeError: foo) for"
         end
@@ -800,29 +937,39 @@ describe Appsignal::Transaction do
         transaction.add_breadcrumb "category", "action", "message", "key" => "value"
         transaction.sample_data
 
-        sample_data = transaction.to_h["sample_data"]
-        expect(sample_data["environment"]).to include(
+        expect(transaction).to include_environment(
           "REQUEST_METHOD" => "GET",
           "SERVER_NAME" => "example.org",
           "SERVER_PORT" => "80",
           "PATH_INFO" => "/blog"
         )
-        expect(sample_data["session_data"]).to eq("session" => "value")
-        expect(sample_data["params"]).to eq(
+        expect(transaction).to include_session_data("session" => "value")
+        expect(transaction).to include_params(
           "controller" => "blog_posts",
           "action" => "show",
           "id" => "1"
         )
-        expect(sample_data["metadata"]).to eq("key" => "value")
-        expect(sample_data["tags"]).to eq("tag" => "value")
-        expect(sample_data["breadcrumbs"]).to contain_exactly(
-          "action" => "action",
-          "category" => "category",
-          "message" => "message",
-          "metadata" => { "key" => "value" },
-          "time" => kind_of(Integer)
+        expect(transaction).to include_sample_metadata("key" => "value")
+        expect(transaction).to include_tags("tag" => "value")
+        expect(transaction).to include_breadcrumb(
+          "action",
+          "category",
+          "message",
+          { "key" => "value" },
+          kind_of(Integer)
         )
       end
+
+      context "when params is a callable object" do
+        it "calls the params object and sets the return value as parametesr" do
+          transaction.set_params { { "param1" => "value1" } }
+
+          transaction.sample_data
+          expect(transaction).to include_params(
+            "param1" => "value1"
+          )
+        end
+      end
     end
 
     describe "#set_error" do
@@ -972,7 +1119,7 @@ describe Appsignal::Transaction do
         end
 
         it "should not raise an error" do
-          expect { transaction.set_error(error) }.to_not raise_error
+          transaction.set_error(error)
         end
 
         it "should set an error in the extension" do
@@ -1613,22 +1760,20 @@ describe Appsignal::Transaction do
     subject { Appsignal::Transaction::NilTransaction.new }
 
     it "should have method stubs" do
-      expect do
-        subject.complete
-        subject.pause!
-        subject.resume!
-        subject.paused?
-        subject.store(:key)
-        subject.set_tags(:tag => 1)
-        subject.set_action("action")
-        subject.set_http_or_background_action
-        subject.set_queue_start(1)
-        subject.set_http_or_background_queue_start
-        subject.set_metadata("key", "value")
-        subject.set_sample_data("key", "data")
-        subject.sample_data
-        subject.set_error("a")
-      end.to_not raise_error
+      subject.complete
+      subject.pause!
+      subject.resume!
+      subject.paused?
+      subject.store(:key)
+      subject.set_tags(:tag => 1)
+      subject.set_action("action")
+      subject.set_http_or_background_action
+      subject.set_queue_start(1)
+      subject.set_http_or_background_queue_start
+      subject.set_metadata("key", "value")
+      subject.set_sample_data("key", "data")
+      subject.sample_data
+      subject.set_error("a")
     end
   end
 end