appsignal 2.10.7 → 2.11.0.alpha.2

data/spec/lib/appsignal/rack/js_exception_catcher_spec.rb

@@ -4,9 +4,12 @@ describe Appsignal::Rack::JSExceptionCatcher do
   let(:config_options) { { :enable_frontend_error_catching => true } }
   let(:config)         { project_fixture_config("production", config_options) }
   let(:deprecation_message) do
-    "The Appsignal::Rack::JSExceptionCatcher is deprecated. " \
-      "Please use the official AppSignal JavaScript integration instead. " \
-      "https://docs.appsignal.com/front-end/"
+    "The Appsignal::Rack::JSExceptionCatcher is " \
+      "deprecated and will be removed in a future version. Please use " \
+      "the official AppSignal JavaScript integration by disabling " \
+      "`enable_frontend_error_catching` in your configuration and " \
+      "installing AppSignal for JavaScript instead. " \
+      "(https://docs.appsignal.com/front-end/)"
   end
   before { Appsignal.config = config }
 
@@ -32,7 +35,9 @@ describe Appsignal::Rack::JSExceptionCatcher do
 
   describe "#call" do
     let(:catcher) do
-      silence { Appsignal::Rack::JSExceptionCatcher.new(app, options) }
+      silence :allowed => ["enable_frontend_error_catching"] do
+        Appsignal::Rack::JSExceptionCatcher.new(app, options)
+      end
     end
     after { catcher.call(env) }
 

data/spec/lib/appsignal/transaction_spec.rb

@@ -500,23 +500,40 @@ describe Appsignal::Transaction do
     end
 
     describe "#set_http_or_background_queue_start" do
-      context "for a http transaction" do
-        let(:namespace) { Appsignal::Transaction::HTTP_REQUEST }
-        let(:env) { { "HTTP_X_REQUEST_START" => (fixed_time * 1000).to_s } }
+      let(:header_factor) { 1_000 }
+      let(:env_queue_start) { fixed_time + 20 } # in seconds
 
-        it "should set the queue start on the transaction" do
-          expect(transaction).to receive(:set_queue_start).with(13_897_836_000)
+      context "when a queue time is found in a request header" do
+        let(:header_time) { ((fixed_time + 10) * header_factor).to_i } # in milliseconds
+        let(:env) { { "HTTP_X_REQUEST_START" => "t=#{header_time}" } }
+
+        it "sets the http header value in milliseconds on the transaction" do
+          expect(transaction).to receive(:set_queue_start).with(1_389_783_610_000)
 
           transaction.set_http_or_background_queue_start
         end
+
+        context "when a :queue_start key is found in the transaction environment" do
+          let(:env) do
+            {
+              "HTTP_X_REQUEST_START" => "t=#{header_time}",
+              :queue_start => env_queue_start
+            }
+          end
+
+          it "sets the http header value in milliseconds on the transaction" do
+            expect(transaction).to receive(:set_queue_start).with(1_389_783_610_000)
+
+            transaction.set_http_or_background_queue_start
+          end
+        end
       end
 
-      context "for a background transaction" do
-        let(:namespace) { Appsignal::Transaction::BACKGROUND_JOB }
-        let(:env) { { :queue_start => fixed_time } }
+      context "when a :queue_start key is found in the transaction environment" do
+        let(:env) { { :queue_start => env_queue_start } } # in seconds
 
-        it "should set the queue start on the transaction" do
-          expect(transaction).to receive(:set_queue_start).with(1_389_783_600_000)
+        it "sets the :queue_start value in milliseconds on the transaction" do
+          expect(transaction).to receive(:set_queue_start).with(1_389_783_620_000)
 
           transaction.set_http_or_background_queue_start
         end
@@ -910,7 +927,7 @@ describe Appsignal::Transaction do
       context "when queue start is set" do
         let(:env) { background_env_with_data }
 
-        it { is_expected.to eq 1_389_783_590_000 }
+        it { is_expected.to eq 1_389_783_600_000 }
       end
     end
 
@@ -949,7 +966,7 @@ describe Appsignal::Transaction do
             it { is_expected.to be_nil }
           end
 
-          context "with some cruft" do
+          context "with unparsable content at the end" do
             let(:env) { { "HTTP_X_REQUEST_START" => "t=#{slightly_earlier_time_value}aaaa" } }
 
             it { is_expected.to eq 1_389_783_599_600 }
@@ -969,7 +986,7 @@ describe Appsignal::Transaction do
         end
       end
 
-      context "time in miliseconds" do
+      context "time in milliseconds" do
         let(:factor) { 1_000 }
 
         it_should_behave_like "http queue start"

data/spec/lib/appsignal_spec.rb

@@ -1,4 +1,6 @@
 describe Appsignal do
+  include EnvironmentMetadataHelper
+
   before do
     # Make sure we have a clean state because we want to test
     # initialization here.
@@ -80,18 +82,22 @@ describe Appsignal do
           allow(GC::Profiler).to receive(:enable)
           Appsignal.config.config_hash[:enable_allocation_tracking] = true
           Appsignal.config.config_hash[:enable_gc_instrumentation] = true
+          capture_environment_metadata_report_calls
         end
 
         it "should enable Ruby's GC::Profiler" do
           expect(GC::Profiler).to receive(:enable)
           Appsignal.start
+          expect_environment_metadata("ruby_gc_instrumentation_enabled", "true")
         end
 
         unless Appsignal::System.jruby?
+
           it "installs the allocation event hook" do
             expect(Appsignal::Extension).to receive(:install_allocation_event_hook)
               .and_call_original
             Appsignal.start
+            expect_environment_metadata("ruby_allocation_tracking_enabled", "true")
           end
         end
       end
@@ -100,6 +106,7 @@ describe Appsignal do
         before do
           Appsignal.config.config_hash[:enable_allocation_tracking] = false
           Appsignal.config.config_hash[:enable_gc_instrumentation] = false
+          capture_environment_metadata_report_calls
         end
 
         it "should not enable Ruby's GC::Profiler" do
@@ -110,11 +117,13 @@ describe Appsignal do
         it "should not install the allocation event hook" do
           expect(Appsignal::Minutely).not_to receive(:install_allocation_event_hook)
           Appsignal.start
+          expect_not_environment_metadata("ruby_allocation_tracking_enabled")
         end
 
         it "should not add the gc probe to minutely" do
           expect(Appsignal::Minutely).not_to receive(:register_garbage_collection_probe)
           Appsignal.start
+          expect_not_environment_metadata("ruby_gc_instrumentation_enabled")
         end
       end
 
@@ -139,6 +148,19 @@ describe Appsignal do
           Appsignal.start
         end
       end
+
+      describe "environment metadata" do
+        before { capture_environment_metadata_report_calls }
+
+        it "collects and reports environment metadata" do
+          Appsignal.start
+          expect_environment_metadata("ruby_version", "#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}")
+          expect_environment_metadata("ruby_engine", RUBY_ENGINE)
+          if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.3.0")
+            expect_environment_metadata("ruby_engine_version", RUBY_ENGINE_VERSION)
+          end
+        end
+      end
     end
 
     context "with debug logging" do

data/spec/lib/puma/appsignal_spec.rb

@@ -62,7 +62,7 @@ RSpec.describe "Puma plugin" do
     expect(launcher.events.on_booted).to_not be_nil
 
     launcher.events.on_booted.call
-    expect(Appsignal::Minutely.probes[:puma]).to eql(Appsignal::Hooks::PumaProbe)
+    expect(Appsignal::Minutely.probes[:puma]).to eql(Appsignal::Probes::PumaProbe)
 
     # Minutely probes started and called
     wait_for("enough probe calls") { probe.calls >= 2 }

data/spec/support/helpers/dependency_helper.rb

@@ -9,6 +9,11 @@ module DependencyHelper
     dependency_present? "rails"
   end
 
+  def rails6_present?
+    rails_present? &&
+      Gem.loaded_specs["rails"].version >= Gem::Version.new("6.0.0")
+  end
+
   def sequel_present?
     dependency_present? "sequel"
   end

data/spec/support/helpers/env_helpers.rb

@@ -27,7 +27,7 @@ module EnvHelpers
       :priority => 1,
       :attempts => 0,
       :queue => "default",
-      :queue_start => fixed_time - 10.0
+      :queue_start => fixed_time
     }.merge(args)
   end
 end

data/spec/support/helpers/environment_metdata_helper.rb

@@ -0,0 +1,16 @@
+module EnvironmentMetadataHelper
+  def capture_environment_metadata_report_calls
+    allow(Appsignal::Extension).to receive(:set_environment_metadata)
+      .and_call_original
+  end
+
+  def expect_environment_metadata(key, value)
+    expect(Appsignal::Extension).to have_received(:set_environment_metadata)
+      .with(key, value)
+  end
+
+  def expect_not_environment_metadata(key)
+    expect(Appsignal::Extension).to_not have_received(:set_environment_metadata)
+      .with(key, anything)
+  end
+end

data/spec/support/stubs/sidekiq/api.rb

@@ -1,4 +1,4 @@
-class Sidekiq
+module Sidekiq
   class API
   end
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 2.10.7
+  version: 2.11.0.alpha.2
 platform: ruby
 authors:
 - Robert Beekman
 - Thijs Cadier
 - Tom de Bruijn
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-05 00:00:00.000000000 Z
+date: 2020-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -190,6 +190,7 @@ files:
 - lib/appsignal/cli/notify_of_deploy.rb
 - lib/appsignal/config.rb
 - lib/appsignal/demo.rb
+- lib/appsignal/environment.rb
 - lib/appsignal/event_formatter.rb
 - lib/appsignal/event_formatter/action_view/render_formatter.rb
 - lib/appsignal/event_formatter/active_record/instantiation_formatter.rb
@@ -240,6 +241,8 @@ files:
 - lib/appsignal/logger.rb
 - lib/appsignal/marker.rb
 - lib/appsignal/minutely.rb
+- lib/appsignal/probes/puma.rb
+- lib/appsignal/probes/sidekiq.rb
 - lib/appsignal/rack/generic_instrumentation.rb
 - lib/appsignal/rack/js_exception_catcher.rb
 - lib/appsignal/rack/rails_instrumentation.rb
@@ -274,6 +277,7 @@ files:
 - spec/lib/appsignal/cli_spec.rb
 - spec/lib/appsignal/config_spec.rb
 - spec/lib/appsignal/demo_spec.rb
+- spec/lib/appsignal/environment_spec.rb
 - spec/lib/appsignal/event_formatter/action_view/render_formatter_spec.rb
 - spec/lib/appsignal/event_formatter/active_record/instantiation_formatter_spec.rb
 - spec/lib/appsignal/event_formatter/active_record/sql_formatter_spec.rb
@@ -318,6 +322,8 @@ files:
 - spec/lib/appsignal/logger_spec.rb
 - spec/lib/appsignal/marker_spec.rb
 - spec/lib/appsignal/minutely_spec.rb
+- spec/lib/appsignal/probes/puma_spec.rb
+- spec/lib/appsignal/probes/sidekiq_spec.rb
 - spec/lib/appsignal/rack/generic_instrumentation_spec.rb
 - spec/lib/appsignal/rack/js_exception_catcher_spec.rb
 - spec/lib/appsignal/rack/rails_instrumentation_spec.rb
@@ -348,6 +354,7 @@ files:
 - spec/support/helpers/dependency_helper.rb
 - spec/support/helpers/directory_helper.rb
 - spec/support/helpers/env_helpers.rb
+- spec/support/helpers/environment_metdata_helper.rb
 - spec/support/helpers/example_exception.rb
 - spec/support/helpers/example_standard_error.rb
 - spec/support/helpers/log_helpers.rb
@@ -379,7 +386,7 @@ metadata:
   documentation_uri: https://docs.appsignal.com/ruby/
   homepage_uri: https://docs.appsignal.com/ruby/
   source_code_uri: https://github.com/appsignal/appsignal-ruby
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -391,12 +398,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Logs performance and exception data from your app to appsignal.com
 test_files:
@@ -414,6 +421,7 @@ test_files:
 - spec/lib/appsignal/cli_spec.rb
 - spec/lib/appsignal/config_spec.rb
 - spec/lib/appsignal/demo_spec.rb
+- spec/lib/appsignal/environment_spec.rb
 - spec/lib/appsignal/event_formatter/action_view/render_formatter_spec.rb
 - spec/lib/appsignal/event_formatter/active_record/instantiation_formatter_spec.rb
 - spec/lib/appsignal/event_formatter/active_record/sql_formatter_spec.rb
@@ -458,6 +466,8 @@ test_files:
 - spec/lib/appsignal/logger_spec.rb
 - spec/lib/appsignal/marker_spec.rb
 - spec/lib/appsignal/minutely_spec.rb
+- spec/lib/appsignal/probes/puma_spec.rb
+- spec/lib/appsignal/probes/sidekiq_spec.rb
 - spec/lib/appsignal/rack/generic_instrumentation_spec.rb
 - spec/lib/appsignal/rack/js_exception_catcher_spec.rb
 - spec/lib/appsignal/rack/rails_instrumentation_spec.rb
@@ -488,6 +498,7 @@ test_files:
 - spec/support/helpers/dependency_helper.rb
 - spec/support/helpers/directory_helper.rb
 - spec/support/helpers/env_helpers.rb
+- spec/support/helpers/environment_metdata_helper.rb
 - spec/support/helpers/example_exception.rb
 - spec/support/helpers/example_standard_error.rb
 - spec/support/helpers/log_helpers.rb