appsignal 2.9.18 → 2.10.0

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

@@ -0,0 +1 @@
+<%= NotExistingConstant.not_existing_method %>

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/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/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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 2.9.18
+  version: 2.10.0
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-19 00:00:00.000000000 Z
+date: 2019-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -332,6 +332,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 +354,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,6 +364,7 @@ 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/install_deps
 homepage: https://github.com/appsignal/appsignal-ruby
@@ -466,6 +470,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 +492,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 +502,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