appsignal 2.9.18.beta.1 → 2.10.6.beta.1

data/spec/spec_helper.rb

@@ -9,7 +9,6 @@ Bundler.require :default
 require "cgi"
 require "rack"
 require "rspec"
-require "pry"
 require "timecop"
 require "webmock/rspec"
 
@@ -30,17 +29,11 @@ if DependencyHelper.rails_present?
     require f
   end
 end
+require "pry" if DependencyHelper.dependency_present?("pry")
 require "appsignal"
-
-module Appsignal
-  class << self
-    remove_method :testing?
-
-    def testing?
-      true
-    end
-  end
-end
+# Include patches of AppSignal modules and classes to make test helpers
+# available.
+require File.join(DirectoryHelper.support_dir, "testing.rb")
 
 puts "Running specs in #{RUBY_VERSION} on #{RUBY_PLATFORM}\n\n"
 
@@ -72,6 +65,12 @@ RSpec.configure do |config|
 
   config.example_status_persistence_file_path = "spec/examples.txt"
   config.fail_if_no_examples = true
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+  end
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
 
   def spec_system_tmp_dir
     File.join(tmp_dir, "system-tmp")
@@ -82,6 +81,20 @@ RSpec.configure do |config|
     FileUtils.mkdir_p(spec_system_tmp_dir)
   end
 
+  config.before :each, :only_ruby19 => true do
+    is_ruby19 = Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.0.0")
+    next if is_ruby19
+
+    skip "Skipping spec. Only for Ruby 1.9"
+  end
+
+  config.before :each, :not_ruby19 => true do
+    is_ruby19 = Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.0.0")
+    next unless is_ruby19
+
+    skip "Skipping spec for Ruby 1.9"
+  end
+
   config.before do
     stop_minutely_probes
     ENV["RAILS_ENV"] ||= "test"
@@ -114,7 +127,8 @@ RSpec.configure do |config|
   end
 
   config.after do
-    Thread.current[:appsignal_transaction] = nil
+    Appsignal::Testing.clear!
+    clear_current_transaction!
     stop_minutely_probes
   end
 

data/spec/support/fixtures/projects/broken/config/appsignal.yml

@@ -0,0 +1 @@
+<%= ENV.fetch("I AM A KEY THAT DOES NOT EXIST") %>

data/spec/support/helpers/cli_helpers.rb

@@ -1,3 +1,5 @@
+require "appsignal/cli/helpers"
+
 module CLIHelpers
   def cli
     Appsignal::CLI
@@ -10,7 +12,7 @@ module CLIHelpers
   def format_cli_arguments_and_options(command, options = {})
     [*command].tap do |o|
       options.each do |key, value|
-        o << "--#{key}=#{value}"
+        o << (value.nil? ? "--#{key}" : "--#{key}=#{value}")
       end
     end
   end
@@ -23,4 +25,16 @@ module CLIHelpers
     # Prepare the input by rewinding the pointer in the StringIO
     $stdin.rewind
   end
+
+  def colorize(*args)
+    ColorizeHelper.colorize(*args)
+  end
+end
+
+module ColorizeHelper
+  extend Appsignal::CLI::Helpers
+
+  def self.colorize(*_args)
+    super
+  end
 end

data/spec/support/helpers/log_helpers.rb

@@ -12,15 +12,22 @@ module LogHelpers
   end
 
   def test_logger(log)
-    Logger.new(log).tap do |logger|
-      logger.formatter =
-        proc do |severity, _datetime, _progname, msg|
-          # This format is used in the `contains_log` matcher.
-          "[#{severity}] #{msg}\n"
-        end
+    Appsignal::Logger.new(log).tap do |logger|
+      logger.formatter = logger_formatter
     end
   end
 
+  def logger_formatter
+    proc do |severity, _datetime, _progname, msg|
+      log_line(severity, msg)
+    end
+  end
+
+  def log_line(severity, message)
+    # This format is used in the `contains_log` matcher.
+    "[#{severity}] #{message}\n"
+  end
+
   def log_contents(log)
     log.rewind
     log.read

data/spec/support/helpers/transaction_helpers.rb

@@ -29,9 +29,62 @@ module TransactionHelpers
     )
   end
 
+  # Returns the all {Appsignal::Transaction} objects created during this test
+  # run so far.
+  #
+  # @return [Array<Appsignal::Transaction>]
+  def created_transactions
+    Appsignal::Testing.transactions
+  end
+
+  # Returns the last created {Appsignal::Transaction}.
+  #
+  # @return [Appsignal::Transaction]
+  def last_transaction
+    created_transactions.last
+  end
+
   # Use when {Appsignal::Transaction.clear_current_transaction!} is stubbed to
   # clear the current transaction on the current thread.
   def clear_current_transaction!
     Thread.current[:appsignal_transaction] = nil
   end
+
+  # Track the AppSignal transaction JSON when a transaction gets completed
+  # ({Appsignal::Transaction.complete}).
+  #
+  # It will also add sample data to the transaction when it gets completed.
+  # This can be disabled by setting the `sample` option to `false`.
+  #
+  # It will be tracked for every transaction that is started inside the
+  # `keep_transactions` block.
+  #
+  # @example Keep a transaction while also adding sample data
+  #   keep_transactions do
+  #     transaction = Appsignal::Transaction.new(...)
+  #     transaction.complete
+  #     transaction.to_h # => Hash with transaction data before it was completed
+  #   end
+  #
+  # @example Keep a transaction without adding sample data
+  #   keep_transactions :sample => false do
+  #     transaction = Appsignal::Transaction.new(...)
+  #     transaction.complete
+  #     transaction.to_h
+  #     # => Hash with transaction data before it was completed with an empty
+  #     #    Hash for the `sample_data` key.
+  #   end
+  #
+  # @yield block to perform while the transactions are tracked.
+  # @param options [Hash]
+  # @option options [Boolean] :sample Whether or not to sample transactions.
+  # @return [Object] returns the block return value.
+  def keep_transactions(options = {})
+    Appsignal::Testing.keep_transactions = true
+    Appsignal::Testing.sample_transactions = options.fetch(:sample, true)
+    yield
+  ensure
+    Appsignal::Testing.keep_transactions = nil
+    Appsignal::Testing.sample_transactions = nil
+  end
 end

data/spec/support/helpers/wait_for_helper.rb

@@ -16,13 +16,13 @@ module WaitForHelper
   def wait_for(name)
     max_wait = 5_000
     i = 0
-    while i <= max_wait
+    while i < max_wait
       break if yield
       i += 1
       sleep 0.001
     end
 
-    return unless i == max_wait
+    return unless i >= max_wait
     raise "Waited 5 seconds for #{name} condition, but was not met."
   end
 end

data/spec/support/matchers/be_completed.rb

@@ -0,0 +1,5 @@
+RSpec::Matchers.define :be_completed do
+  match do |transaction|
+    values_match? transaction.ext._completed?, true
+  end
+end

data/spec/support/matchers/have_colorized_text.rb

@@ -0,0 +1,28 @@
+RSpec::Matchers.define :have_colorized_text do |color, text|
+  match do |actual|
+    color_codes = Appsignal::CLI::Helpers::COLOR_CODES
+    reset_color_code = color_codes.fetch(:default)
+    color_code = color_codes.fetch(color)
+
+    @expected = "\e[#{color_code}m#{text}\e[#{reset_color_code}m"
+    expect(actual).to include(@expected)
+  end
+
+  diffable
+  attr_reader :expected
+end
+
+COLOR_TAG_MATCHER_REGEX = /\e\[(\d+)m/
+RSpec::Matchers.define :have_color_markers do
+  match do |actual|
+    actual =~ COLOR_TAG_MATCHER_REGEX
+  end
+
+  failure_message do
+    "expected that output contains color markers: /\\e[\\d+m/"
+  end
+
+  failure_message_when_negated do
+    "expected that output does not contain color markers: /\\e[\\d+m/"
+  end
+end

data/spec/support/testing.rb

@@ -0,0 +1,113 @@
+module Appsignal
+  class << self
+    remove_method :testing?
+
+    # @api private
+    def testing?
+      true
+    end
+  end
+
+  # @api private
+  module Testing
+    class << self
+      def transactions
+        @transactions ||= []
+      end
+
+      def clear!
+        transactions.clear
+      end
+
+      attr_writer :keep_transactions
+      # @see TransactionHelpers#keep_transactions
+      def keep_transactions?
+        defined?(@keep_transactions) ? @keep_transactions : nil
+      end
+
+      attr_writer :sample_transactions
+      # @see TransactionHelpers#keep_transactions
+      def sample_transactions?
+        sample = defined?(@sample_transactions) ? @sample_transactions : nil
+        if sample.nil?
+          keep_transactions?
+        else
+          @sample_transactions
+        end
+      end
+    end
+  end
+
+  class Transaction
+    class << self
+      alias original_new new
+
+      # Override the {Appsignal::Transaction.new} method so we can track which
+      # transactions are created on the {Appsignal::Testing.transactions} list.
+      #
+      # @see TransactionHelpers#last_transaction
+      def new(*args)
+        transaction = original_new(*args)
+        Appsignal::Testing.transactions << transaction
+        transaction
+      end
+    end
+  end
+
+  class Extension
+    class Transaction
+      alias original_finish finish
+
+      # Override default {Extension::Transaction#finish} behavior to always
+      # return true, which tells the transaction to add its sample data (unless
+      # used in combination with {TransactionHelpers#keep_transactions}
+      # `:sample => false`). This allows us to use
+      # {Appsignal::Transaction#to_h} without relying on the extension sampling
+      # behavior.
+      #
+      # @see TransactionHelpers#keep_transactions
+      def finish(*args)
+        return_value = original_finish(*args)
+        return_value = true if Appsignal::Testing.sample_transactions?
+        return_value
+      end
+
+      alias original_complete complete
+
+      # Override default {Extension::Transaction#complete} behavior to
+      # store the transaction JSON before the transaction is completed
+      # and it's no longer possible to request the transaction JSON.
+      #
+      # @see TransactionHelpers#keep_transactions
+      # @see #_completed?
+      def complete
+        @completed = true # see {#_completed?} method
+        @transaction_json = to_json if Appsignal::Testing.keep_transactions?
+        original_complete
+      end
+
+      # Returns true when the Transaction was completed.
+      # {Appsignal::Extension::Transaction.complete} was called.
+      #
+      # @return [Boolean] returns if the transaction was completed.
+      def _completed?
+        @completed || false
+      end
+
+      alias original_to_json to_json
+
+      # Override default {Extension::Transaction#to_json} behavior to
+      # return the stored the transaction JSON when the transaction was
+      # completed.
+      #
+      # @see TransactionHelpers#keep_transactions
+      def to_json
+        if defined? @transaction_json
+          @transaction_json
+        else
+          original_to_json
+        end
+      end
+    end
+  end
+end

data/support/check_versions

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+set -eu
+
+actual_ruby_version=$(ruby --version)
+if [[ "$actual_ruby_version" == *"jruby"* ]]; then
+  # Replace "-" from specified RUBY_VERSION string. Semaphore/rbenv version uses
+  # a dash, where `jruby --version` uses a space.
+  sanitized_ruby_version="${RUBY_VERSION//-/ }"
+else
+  # Strip "-" from specified RUBY_VERSION string. Semaphore/rbenv version uses
+  # a dash, where `ruby --version` does not.
+  sanitized_ruby_version="${RUBY_VERSION//-}"
+fi
+if [[ "$actual_ruby_version" == *"$sanitized_ruby_version"* ]]; then
+  echo "Ruby version is $RUBY_VERSION"
+  exit 0
+else
+  echo "Ruby version is:        $actual_ruby_version"
+  echo "Ruby version should be: $sanitized_ruby_version"
+  exit 1
+fi

data/support/install_deps

@@ -2,20 +2,25 @@
 
 set -eu
 
+gem_args="--no-verbose"
+if [[ $(ruby --version) != "ruby 1.9.3"* ]]; then
+  gem_args+=" --no-document"
+fi
+
 case "${_RUBYGEMS_VERSION-"latest"}" in
   "latest")
-    gem update --no-document --system
+    gem update $gem_args --system
   ;;
   *)
-    gem update --no-document --system $_RUBYGEMS_VERSION
+    gem update $gem_args --system $_RUBYGEMS_VERSION
   ;;
 esac
 
 case "${_BUNDLER_VERSION-"latest"}" in
   "latest")
-    gem update bundler --no-document
+    gem update bundler $gem_args
   ;;
   *)
-    gem install bundler --no-document --version $_BUNDLER_VERSION
+    gem install bundler $gem_args --version $_BUNDLER_VERSION
   ;;
 esac

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 2.9.18.beta.1
+  version: 2.10.6.beta.1
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-18 00:00:00.000000000 Z
+date: 2020-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -55,7 +55,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.8'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -69,7 +69,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -83,47 +83,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.20
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.20
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.9.20
+        version: 0.50.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.9.20
+        version: 0.50.0
 description: The official appsignal.com gem
 email:
 - support@appsignal.com
@@ -139,7 +139,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
+- ".semaphore/semaphore.yml"
 - ".yardopts"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -227,6 +227,7 @@ files:
 - lib/appsignal/integrations/delayed_job_plugin.rb
 - lib/appsignal/integrations/grape.rb
 - lib/appsignal/integrations/mongo_ruby_driver.rb
+- lib/appsignal/integrations/net_http.rb
 - lib/appsignal/integrations/object.rb
 - lib/appsignal/integrations/padrino.rb
 - lib/appsignal/integrations/que.rb
@@ -237,6 +238,7 @@ files:
 - lib/appsignal/integrations/sinatra.rb
 - lib/appsignal/integrations/webmachine.rb
 - lib/appsignal/js_exception_transaction.rb
+- lib/appsignal/logger.rb
 - lib/appsignal/marker.rb
 - lib/appsignal/minutely.rb
 - lib/appsignal/rack/generic_instrumentation.rb
@@ -314,6 +316,7 @@ files:
 - spec/lib/appsignal/integrations/sinatra_spec.rb
 - spec/lib/appsignal/integrations/webmachine_spec.rb
 - spec/lib/appsignal/js_exception_transaction_spec.rb
+- spec/lib/appsignal/logger_spec.rb
 - spec/lib/appsignal/marker_spec.rb
 - spec/lib/appsignal/minutely_spec.rb
 - spec/lib/appsignal/rack/generic_instrumentation_spec.rb
@@ -332,6 +335,7 @@ files:
 - spec/lib/puma/appsignal_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixtures/generated_config.yml
+- spec/support/fixtures/projects/broken/config/appsignal.yml
 - spec/support/fixtures/projects/valid/config/application.rb
 - spec/support/fixtures/projects/valid/config/appsignal.yml
 - spec/support/fixtures/projects/valid/config/environments/development.rb
@@ -353,7 +357,9 @@ files:
 - spec/support/helpers/time_helpers.rb
 - spec/support/helpers/transaction_helpers.rb
 - spec/support/helpers/wait_for_helper.rb
+- spec/support/matchers/be_completed.rb
 - spec/support/matchers/contains_log.rb
+- spec/support/matchers/have_colorized_text.rb
 - spec/support/mocks/fake_gc_profiler.rb
 - spec/support/mocks/mock_extension.rb
 - spec/support/mocks/mock_probe.rb
@@ -361,7 +367,9 @@ files:
 - spec/support/shared_examples/instrument.rb
 - spec/support/stubs/delayed_job.rb
 - spec/support/stubs/sidekiq/api.rb
+- spec/support/testing.rb
 - support/bundler_wrapper
+- support/check_versions
 - support/install_deps
 homepage: https://github.com/appsignal/appsignal-ruby
 licenses:
@@ -388,7 +396,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Logs performance and exception data from your app to appsignal.com
@@ -448,6 +456,7 @@ test_files:
 - spec/lib/appsignal/integrations/sinatra_spec.rb
 - spec/lib/appsignal/integrations/webmachine_spec.rb
 - spec/lib/appsignal/js_exception_transaction_spec.rb
+- spec/lib/appsignal/logger_spec.rb
 - spec/lib/appsignal/marker_spec.rb
 - spec/lib/appsignal/minutely_spec.rb
 - spec/lib/appsignal/rack/generic_instrumentation_spec.rb
@@ -466,6 +475,7 @@ test_files:
 - spec/lib/puma/appsignal_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixtures/generated_config.yml
+- spec/support/fixtures/projects/broken/config/appsignal.yml
 - spec/support/fixtures/projects/valid/config/application.rb
 - spec/support/fixtures/projects/valid/config/appsignal.yml
 - spec/support/fixtures/projects/valid/config/environments/development.rb
@@ -487,7 +497,9 @@ test_files:
 - spec/support/helpers/time_helpers.rb
 - spec/support/helpers/transaction_helpers.rb
 - spec/support/helpers/wait_for_helper.rb
+- spec/support/matchers/be_completed.rb
 - spec/support/matchers/contains_log.rb
+- spec/support/matchers/have_colorized_text.rb
 - spec/support/mocks/fake_gc_profiler.rb
 - spec/support/mocks/mock_extension.rb
 - spec/support/mocks/mock_probe.rb
@@ -495,3 +507,4 @@ test_files:
 - spec/support/shared_examples/instrument.rb
 - spec/support/stubs/delayed_job.rb
 - spec/support/stubs/sidekiq/api.rb
+- spec/support/testing.rb