appsignal 4.0.5-java → 4.0.6-java

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

@@ -9,28 +9,16 @@ if DependencyHelper.que_present?
           :queue => "dfl",
           :job_class => "MyQueJob",
           :priority => 100,
-          :args => %w[1 birds],
+          :args => %w[post_id_123 user_id_123],
           :run_at => fixed_time,
           :error_count => 0
-        }
-      end
-      let(:env) do
-        {
-          :class => "MyQueJob",
-          :method => "run",
-          :metadata => {
-            :id => 123,
-            :queue => "dfl",
-            :priority => 100,
-            :run_at => fixed_time.to_s,
-            :attempts => 0
-          },
-          :params => %w[1 birds]
-        }
+        }.tap do |hash|
+          hash[:kwargs] = {} if DependencyHelper.que2_present?
+        end
       end
       let(:job) do
         Class.new(::Que::Job) do
-          def run(*args)
+          def run(post_id, user_id)
           end
         end
       end
@@ -46,7 +34,7 @@ if DependencyHelper.que_present?
         job._run
       end
 
-      context "success" do
+      context "without exception" do
         it "creates a transaction for a job" do
           expect do
             perform_que_job(instance)
@@ -64,7 +52,18 @@ if DependencyHelper.que_present?
             "name" => "perform_job.que",
             "title" => ""
           )
-          expect(transaction).to include_params(%w[1 birds])
+          expect(transaction).to include_params(
+            "arguments" => %w[post_id_123 user_id_123]
+          )
+          if DependencyHelper.que2_present?
+            expect(transaction).to include_params(
+              "keyword_arguments" => {}
+            )
+          else
+            expect(transaction).to_not include_params(
+              "keyword_arguments" => anything
+            )
+          end
           expect(transaction).to include_tags(
             "attempts" => 0,
             "id" => 123,
@@ -93,7 +92,9 @@ if DependencyHelper.que_present?
           expect(transaction).to have_action("MyQueJob#run")
           expect(transaction).to have_namespace(Appsignal::Transaction::BACKGROUND_JOB)
           expect(transaction).to have_error(error.class.name, error.message)
-          expect(transaction).to include_params(%w[1 birds])
+          expect(transaction).to include_params(
+            "arguments" => %w[post_id_123 user_id_123]
+          )
           expect(transaction).to include_tags(
             "attempts" => 0,
             "id" => 123,
@@ -118,7 +119,9 @@ if DependencyHelper.que_present?
           expect(transaction).to have_action("MyQueJob#run")
           expect(transaction).to have_namespace(Appsignal::Transaction::BACKGROUND_JOB)
           expect(transaction).to have_error(error.class.name, error.message)
-          expect(transaction).to include_params(%w[1 birds])
+          expect(transaction).to include_params(
+            "arguments" => %w[post_id_123 user_id_123]
+          )
           expect(transaction).to include_tags(
             "attempts" => 0,
             "id" => 123,
@@ -130,6 +133,38 @@ if DependencyHelper.que_present?
         end
       end
 
+      if DependencyHelper.que2_present?
+        context "with keyword argument" do
+          let(:job_attrs) do
+            {
+              :job_id => 123,
+              :queue => "dfl",
+              :job_class => "MyQueJob",
+              :priority => 100,
+              :args => %w[post_id_123],
+              :kwargs => { :user_id => "user_id_123" },
+              :run_at => fixed_time,
+              :error_count => 0
+            }
+          end
+          let(:job) do
+            Class.new(::Que::Job) do
+              def run(post_id, user_id: nil)
+              end
+            end
+          end
+
+          it "reports keyword arguments as parameters" do
+            perform_que_job(instance)
+
+            expect(last_transaction).to include_params(
+              "arguments" => %w[post_id_123],
+              "keyword_arguments" => { "user_id" => "user_id_123" }
+            )
+          end
+        end
+      end
+
       context "when action set in job" do
         let(:job) do
           Class.new(::Que::Job) do

data/spec/lib/appsignal/probes_spec.rb

@@ -43,6 +43,9 @@ describe Appsignal::Probes do
     let(:log) { log_contents(log_stream) }
     before do
       Appsignal.internal_logger = test_logger(log_stream)
+      # TODO: These logs are here to debug an issue on CI
+      Appsignal.internal_logger.info("a" * 100)
+      Appsignal.internal_logger.info("b" * 100)
       speed_up_tests!
     end
 

data/spec/lib/appsignal/transaction_spec.rb

@@ -211,15 +211,15 @@ describe Appsignal::Transaction do
 
     context "when a transaction has errors" do
       let(:error) do
-        e = ExampleStandardError.new("test message")
-        allow(e).to receive(:backtrace).and_return(["line 1"])
-        e
+        ExampleStandardError.new("test message").tap do |e|
+          e.set_backtrace(["line 1"])
+        end
       end
 
       let(:other_error) do
-        e = ExampleStandardError.new("other test message")
-        allow(e).to receive(:backtrace).and_return(["line 2"])
-        e
+        ExampleStandardError.new("other test message").tap do |e|
+          e.set_backtrace(["line 2"])
+        end
       end
 
       context "when an error is already set on the transaction" do
@@ -1526,9 +1526,9 @@ describe Appsignal::Transaction do
     let(:transaction) { create_transaction }
 
     let(:error) do
-      e = ExampleStandardError.new("test message")
-      allow(e).to receive(:backtrace).and_return(["line 1"])
-      e
+      ExampleStandardError.new("test message").tap do |e|
+        e.set_backtrace(["line 1"])
+      end
     end
 
     context "when error argument is not an error" do
@@ -1588,9 +1588,9 @@ describe Appsignal::Transaction do
 
     context "when an error is already set in the transaction" do
       let(:other_error) do
-        e = ExampleStandardError.new("other test message")
-        allow(e).to receive(:backtrace).and_return(["line 2"])
-        e
+        ExampleStandardError.new("other test message").tap do |e|
+          e.set_backtrace(["line 2"])
+        end
       end
 
       before { transaction.set_error(other_error) }
@@ -1697,12 +1697,92 @@ describe Appsignal::Transaction do
         end
       end
     end
+
+    context "with a PG::UniqueViolation" do
+      let(:error) do
+        PG::UniqueViolation.new(
+          "ERROR: duplicate key value violates unique constraint " \
+            "\"index_users_on_email\" DETAIL: Key (email)=(test@test.com) already exists."
+        )
+      end
+      before do
+        stub_const("PG::UniqueViolation", Class.new(StandardError))
+        transaction.add_error(error)
+      end
+
+      it "returns a sanizited error message" do
+        expect(transaction).to have_error(
+          "PG::UniqueViolation",
+          "ERROR: duplicate key value violates unique constraint " \
+            "\"index_users_on_email\" DETAIL: Key (email)=(?) already exists."
+        )
+      end
+    end
+
+    context "with a ActiveRecord::RecordNotUnique" do
+      let(:error) do
+        ActiveRecord::RecordNotUnique.new(
+          "PG::UniqueViolation: ERROR: duplicate key value violates unique constraint " \
+            "\"example_constraint\"\nDETAIL: Key (email)=(foo@example.com) already exists."
+        )
+      end
+      before do
+        stub_const("ActiveRecord::RecordNotUnique", Class.new(StandardError))
+        transaction.add_error(error)
+      end
+
+      it "returns a sanizited error message" do
+        expect(transaction).to have_error(
+          "ActiveRecord::RecordNotUnique",
+          "PG::UniqueViolation: ERROR: duplicate key value violates unique constraint " \
+            "\"example_constraint\"\nDETAIL: Key (email)=(?) already exists."
+        )
+      end
+    end
+
+    context "with Rails module but without backtrace_cleaner method" do
+      it "returns the backtrace uncleaned" do
+        stub_const("Rails", Module.new)
+        error = ExampleStandardError.new("error message")
+        error.set_backtrace(["line 1", "line 2"])
+        transaction.add_error(error)
+
+        expect(last_transaction).to have_error(
+          "ExampleStandardError",
+          "error message",
+          ["line 1", "line 2"]
+        )
+      end
+    end
+
+    if rails_present?
+      context "with Rails" do
+        it "cleans the backtrace with the Rails backtrace cleaner" do
+          ::Rails.backtrace_cleaner.add_filter do |line|
+            line.tr("2", "?")
+          end
+
+          error = ExampleStandardError.new("error message")
+          error.set_backtrace(["line 1", "line 2"])
+          transaction.add_error(error)
+          expect(last_transaction).to have_error(
+            "ExampleStandardError",
+            "error message",
+            ["line 1", "line ?"]
+          )
+        end
+      end
+    end
   end
 
   describe "#_set_error" do
     let(:transaction) { new_transaction }
     let(:env) { http_request_env_with_data }
-    let(:error) { ExampleStandardError.new("test message") }
+    let(:error) do
+      ExampleStandardError.new("test message").tap do |e|
+        e.set_backtrace(["line 1"])
+      end
+    end
 
     it "responds to add_exception for backwards compatibility" do
       expect(transaction).to respond_to(:add_exception)
@@ -1716,7 +1796,6 @@ describe Appsignal::Transaction do
 
     context "for a http request" do
       it "sets an error on the transaction" do
-        allow(error).to receive(:backtrace).and_return(["line 1"])
         transaction.send(:_set_error, error)
 
         expect(transaction).to have_error(
@@ -1738,9 +1817,9 @@ describe Appsignal::Transaction do
     context "when the error has multiple causes" do
       let(:error) do
         e = ExampleStandardError.new("test message")
+        e.set_backtrace(["line 1"])
         e2 = RuntimeError.new("cause message")
         e3 = StandardError.new("cause message 2")
-        allow(e).to receive(:backtrace).and_return(["line 1"])
         allow(e).to receive(:cause).and_return(e2)
         allow(e2).to receive(:cause).and_return(e3)
         e
@@ -1795,8 +1874,7 @@ describe Appsignal::Transaction do
           allow(next_e).to receive(:cause).and_return(e)
           e = next_e
         end
-
-        allow(e).to receive(:backtrace).and_return(["line 1"])
+        e.set_backtrace(["line 1"])
         e
       end
 
@@ -1831,7 +1909,7 @@ describe Appsignal::Transaction do
       let(:error) do
         e = ExampleStandardError.new
         allow(e).to receive(:message).and_return(nil)
-        allow(e).to receive(:backtrace).and_return(["line 1"])
+        e.set_backtrace(["line 1"])
         e
       end
 
@@ -1985,80 +2063,6 @@ describe Appsignal::Transaction do
 
   # private
 
-  describe "#cleaned_backtrace" do
-    let(:transaction) { new_transaction }
-    subject { transaction.send(:cleaned_backtrace, ["line 1", "line 2"]) }
-
-    it "returns the backtrace" do
-      expect(subject).to eq ["line 1", "line 2"]
-    end
-
-    context "with Rails module but without backtrace_cleaner method" do
-      it "returns the backtrace uncleaned" do
-        stub_const("Rails", Module.new)
-        expect(subject).to eq ["line 1", "line 2"]
-      end
-    end
-
-    if rails_present?
-      context "with rails" do
-        it "cleans the backtrace with the Rails backtrace cleaner" do
-          ::Rails.backtrace_cleaner.add_filter do |line|
-            line.tr("2", "?")
-          end
-          expect(subject).to eq ["line 1", "line ?"]
-        end
-      end
-    end
-  end
-
-  describe "#cleaned_error_message" do
-    let(:transaction) { new_transaction }
-    let(:error) { StandardError.new("Error message") }
-    subject { transaction.send(:cleaned_error_message, error) }
-
-    it "returns the error message" do
-      expect(subject).to eq "Error message"
-    end
-
-    context "with a PG::UniqueViolation" do
-      before do
-        stub_const("PG::UniqueViolation", Class.new(StandardError))
-      end
-
-      let(:error) do
-        PG::UniqueViolation.new(
-          "ERROR: duplicate key value violates unique constraint " \
-            "\"index_users_on_email\" DETAIL: Key (email)=(test@test.com) already exists."
-        )
-      end
-
-      it "returns a sanizited error message" do
-        expect(subject).to eq "ERROR: duplicate key value violates unique constraint " \
-          "\"index_users_on_email\" DETAIL: Key (email)=(?) already exists."
-      end
-    end
-
-    context "with a ActiveRecord::RecordNotUnique" do
-      before do
-        stub_const("ActiveRecord::RecordNotUnique", Class.new(StandardError))
-      end
-
-      let(:error) do
-        ActiveRecord::RecordNotUnique.new(
-          "PG::UniqueViolation: ERROR: duplicate key value violates unique constraint " \
-            "\"example_constraint\"\nDETAIL: Key (email)=(foo@example.com) already exists."
-        )
-      end
-
-      it "returns a sanizited error message" do
-        expect(subject).to eq \
-          "PG::UniqueViolation: ERROR: duplicate key value violates unique constraint " \
-            "\"example_constraint\"\nDETAIL: Key (email)=(?) already exists."
-      end
-    end
-  end
-
   describe ".to_hash / .to_h" do
     let(:transaction) { new_transaction }
     subject { transaction.to_hash }

data/spec/spec_helper.rb

@@ -85,6 +85,10 @@ RSpec.configure do |config|
     File.join(tmp_dir, "system-tmp")
   end
 
+  config.before :suite do
+    WebMock.disable_net_connect!
+  end
+
   config.before :context do
     FileUtils.rm_rf(tmp_dir)
     FileUtils.mkdir_p(spec_system_tmp_dir)
@@ -94,6 +98,8 @@ RSpec.configure do |config|
     Appsignal.clear!
     Appsignal::Testing.clear!
     Appsignal::Loaders.clear!
+    Appsignal::CheckIn.clear!
+
     clear_current_transaction!
     stop_minutely_probes
     ENV["RAILS_ENV"] ||= "test"

data/spec/support/helpers/api_request_helper.rb

@@ -17,4 +17,44 @@ module ApiRequestHelper
     endpoint = config[:endpoint] || Appsignal::Config::DEFAULT_CONFIG[:endpoint]
     stub_request(:post, "#{endpoint}/1/#{path}").with(options)
   end
+
+  def stub_check_in_request(events:, response: { :status => 200 })
+    config = Appsignal.config
+    options = {
+      :query => {
+        :api_key => config[:push_api_key],
+        :name => config[:name],
+        :environment => config.respond_to?(:env) ? config.env : config[:environment],
+        :hostname => config[:hostname],
+        :gem_version => Appsignal::VERSION
+      },
+      :headers => { "Content-Type" => "application/x-ndjson; charset=UTF-8" }
+    }
+
+    request_stub =
+      stub_request(
+        :post,
+        "#{config[:logging_endpoint]}/check_ins/json"
+      ).with(options) do |request|
+        # Parse each line as JSON per the NDJSON format
+        payloads = request.body.split("\n").map { |line| JSON.parse(line) }
+        formatted_events =
+          events.map do |event|
+            {
+              "identifier" => nil,
+              "digest" => kind_of(String),
+              "kind" => "start",
+              "timestamp" => kind_of(Integer),
+              "check_in_type" => "cron"
+            }.merge(event)
+          end
+        expect(payloads).to include(*formatted_events)
+      end
+
+    if response.is_a?(Exception)
+      request_stub.to_raise(response)
+    else
+      request_stub.to_return(response)
+    end
+  end
 end

data/spec/support/helpers/dependency_helper.rb

@@ -127,6 +127,11 @@ module DependencyHelper
     dependency_present? "que"
   end
 
+  def que2_present?
+    que_present? &&
+      Gem.loaded_specs["que"].version >= Gem::Version.new("2.0.0")
+  end
+
   def hanami_present?
     dependency_present? "hanami"
   end

data/spec/support/testing.rb

@@ -47,6 +47,15 @@ module Appsignal
     end
   end
 
+  module CheckIn
+    class << self
+      def clear!
+        @transmitter = nil
+        @scheduler = nil
+      end
+    end
+  end
+
   # @api private
   module Testing
     class << self

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 4.0.5
+  version: 4.0.6
 platform: java
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-02 00:00:00.000000000 Z
+date: 2024-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -184,7 +184,8 @@ files:
 - gemfiles/padrino.gemfile
 - gemfiles/psych-3.gemfile
 - gemfiles/psych-4.gemfile
-- gemfiles/que.gemfile
+- gemfiles/que-1.gemfile
+- gemfiles/que-2.gemfile
 - gemfiles/rails-6.0.gemfile
 - gemfiles/rails-6.1.gemfile
 - gemfiles/rails-7.0.gemfile

data/gemfiles/que.gemfile

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'que', "~> 1.0"
-
-gemspec :path => '../'