appsignal 3.0.0.beta.1 → 3.0.3

data/CHANGELOG.md

@@ -1,10 +1,50 @@
 # Changelog
 
+# 3.0.3
+- Fix deprecation message for set_error namespace argument. PR #712
+- Fix example code for Transaction#set_namespace method. PR #713
+- Fix extension fallbacks on extension installation failure, that caused
+- NoMethodErrors. PR #720
+- Bump agent to v-75e76ad. PR #721
+
+# 3.0.2
+- Fix error on Rails boot when `enable_frontend_error_catching` is `true`.
+  PR #711
+
+# 3.0.1
+- Fix error occurring on APPSIGNAL_DNS_SERVER environment variable option
+  parsing. PR #709
+
 # 3.0.0
+
+Please read our [upgrade from version 2 to 3 guide][upgrade3] before upgrading.
+
+[upgrade3]: https://docs.appsignal.com/ruby/installation/upgrade-from-2-to-3.html
+
 - Drop Ruby 1.9 support. PR #683, #682, #688, #694
+- Require Ruby 2.0 or newer for gem. PR #701
 - Use Module.prepend for all gem integrations. Fixes #603 in combination with
   other gems that provide instrumentation for gems. PR #683
-- Remove deprecated integrations, classes, methods and arguments. PR #685
+- Remove deprecated integrations, classes, methods and arguments. PR #685, #686
+- Deprecate `set_error` and `send_error` error helpers `tags` and `namespace`
+  arguments. PR #702
+- Add Sidekiq error handler. Report more Sidekiq errors that happen around job
+  execution. PR #699
+
+# 2.11.9
+- Fix and simplify Ruby method delegation for object method instrumentation in
+  the different Ruby versions. PR #706
+
+# 2.11.8
+- Mark minutely probe thread as fork-safe by @pixeltrix. PR #704
+
+# 2.11.7
+- Fix ActionCable integration in test environment using `stub_connection`.
+  PR #705
+
+# 2.11.6
+- Prepend Sidekiq middleware to wrap all Sidekiq middleware. Catches more
+  errors and provide more complete performance measurements. PR #698
 
 # 2.11.5
 - Add more detailed logging to finish_event calls when the event is unknown, so

data/Rakefile

@@ -377,8 +377,6 @@ begin
   is_jruby = defined?(RUBY_ENGINE) && RUBY_ENGINE == "jruby"
   excludes = []
   excludes << "spec/lib/appsignal/extension/jruby_spec.rb" unless is_jruby
-  is_ruby19 = RUBY_VERSION < "2.0"
-  excludes << "spec/lib/appsignal/integrations/object_spec.rb" if is_ruby19
   exclude_pattern = "--exclude-pattern=#{excludes.join(",")}" if excludes.any?
 
   desc "Run the AppSignal gem test suite."
@@ -387,10 +385,20 @@ begin
   end
 
   namespace :test do
-    desc "Run the Appsignal gem test in an extension failure scenario"
-    RSpec::Core::RakeTask.new :failure do |t|
+    RSpec::Core::RakeTask.new :rspec_failure do |t|
       t.rspec_opts = "#{exclude_pattern} --tag extension_installation_failure"
     end
+
+    desc "Intentionally fail the extension installation"
+    task :prepare_failure do
+      # ENV var to make sure installation fails on purpurse
+      ENV["_TEST_APPSIGNAL_EXTENSION_FAILURE"] = "true"
+      # Run extension installation with intentional failure
+      `rake extension:install`
+    end
+
+    desc "Run the Appsignal gem test in an extension failure scenario"
+    task :failure => [:prepare_failure, :rspec_failure]
   end
 rescue LoadError # rubocop:disable Lint/HandleExceptions
   # When running rake install, there is no RSpec yet.

data/appsignal.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |gem| # rubocop:disable Metrics/BlockLength
   gem.name                  = "appsignal"
   gem.require_paths         = %w[lib ext]
   gem.version               = Appsignal::VERSION
-  gem.required_ruby_version = ">= 1.9"
+  gem.required_ruby_version = ">= 2.0"
   # Default extension installer. Overridden by JRuby gemspec as defined in
   # `Rakefile`.
   gem.extensions            = %w[ext/extconf.rb]
@@ -42,9 +42,11 @@ Gem::Specification.new do |gem| # rubocop:disable Metrics/BlockLength
   gem.add_development_dependency "timecop"
   gem.add_development_dependency "webmock"
   gem.add_development_dependency "yard", ">= 0.9.20"
-  is_modern_ruby = Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.0.0")
-  if is_modern_ruby
-    gem.add_development_dependency "pry"
-    gem.add_development_dependency "rubocop", "0.50.0"
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "rubocop", "0.50.0"
+  if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.1.0")
+    # Newer versions of rexml use keyword arguments with optional arguments which
+    # work in Ruby 2.1 and newer.
+    gem.add_development_dependency "rexml", "3.2.4"
   end
 end

data/build_matrix.yml

@@ -58,7 +58,7 @@ semaphore: # Default `.semaphore/semaphore.yml` contents
         - name: Validate CI setup
           env_vars:
             - name: RUBY_VERSION
-              value: 2.6.5
+              value: 2.6.6
             - name: GEMSET
               value: no_dependencies
             - name: BUNDLE_GEMFILE
@@ -72,7 +72,7 @@ semaphore: # Default `.semaphore/semaphore.yml` contents
         - name: RuboCop
           env_vars:
             - name: RUBY_VERSION
-              value: 2.6.5
+              value: 2.6.6
             - name: GEMSET
               value: no_dependencies
             - name: BUNDLE_GEMFILE
@@ -107,12 +107,12 @@ matrix:
       gems: "none"
     - ruby: "2.3.8"
       gems: "none"
-    - ruby: "2.4.9"
+    - ruby: "2.4.10"
       gems: "none"
-    - ruby: "2.5.7"
+    - ruby: "2.5.8"
       gems: "minimal"
-    - ruby: "2.6.5"
-    - ruby: "2.7.1"
+    - ruby: "2.6.6"
+    - ruby: "2.7.2"
     - ruby: "3.0.0"
     - ruby: "jruby-9.1.17.0"
       gems: "minimal"
@@ -134,15 +134,15 @@ matrix:
       bundler: "1.17.3"
       exclude:
         ruby:
-          - "2.6.5"
-          - "2.7.1"
+          - "2.6.6"
+          - "2.7.2"
           - "3.0.0"
     - gem: "rails-4.2"
       bundler: "1.17.3"
       exclude:
         ruby:
-          - "2.6.5"
-          - "2.7.1"
+          - "2.6.6"
+          - "2.7.2"
           - "3.0.0"
     - gem: "rails-5.0"
       exclude:
@@ -166,7 +166,7 @@ matrix:
           - "2.1.10"
           - "2.2.10"
           - "2.3.8"
-          - "2.4.9"
+          - "2.4.10"
           - "jruby-9.1.17.0"
     - gem: "resque-1"
       bundler: "1.17.3"

data/ext/agent.yml

@@ -1,62 +1,62 @@
 ---
-version: d98461b
+version: 75e76ad
 mirrors:
 - https://appsignal-agent-releases.global.ssl.fastly.net
 - https://d135dj0rjqvssy.cloudfront.net
 triples:
   x86_64-darwin:
     static:
-      checksum: 178ab2329c7b29cf45140e4707e75c20379fa0c7dfd7f39266a7a95aea510780
+      checksum: 81edea50b934fe5b42c0081a1de5782bc477c321c1c76127d7fa525917f70a04
       filename: appsignal-x86_64-darwin-all-static.tar.gz
     dynamic:
-      checksum: '0923985cc78c5cf278f45d530679954b94b1a91c87453369116fc05525e29864'
+      checksum: 60befd59ac704ee21d5881ca0aef6b38caa50b1d1972425bf8f40b4f9710ec1e
       filename: appsignal-x86_64-darwin-all-dynamic.tar.gz
   universal-darwin:
     static:
-      checksum: 178ab2329c7b29cf45140e4707e75c20379fa0c7dfd7f39266a7a95aea510780
+      checksum: 81edea50b934fe5b42c0081a1de5782bc477c321c1c76127d7fa525917f70a04
       filename: appsignal-x86_64-darwin-all-static.tar.gz
     dynamic:
-      checksum: '0923985cc78c5cf278f45d530679954b94b1a91c87453369116fc05525e29864'
+      checksum: 60befd59ac704ee21d5881ca0aef6b38caa50b1d1972425bf8f40b4f9710ec1e
       filename: appsignal-x86_64-darwin-all-dynamic.tar.gz
   i686-linux:
     static:
-      checksum: cb772a8a178edb25d666b650efda80149c98e80e4264435d6176f8a6104f959a
+      checksum: 60ad6a1f69c8f89b5642f49fbf794409e8ada7d63a9126b2c59832c2a92d5b22
       filename: appsignal-i686-linux-all-static.tar.gz
     dynamic:
-      checksum: c9ac51f4d1b3cc13773d8fa8ea5cfad6af7909144d85186cef9324ec0531bdac
+      checksum: aedf259de392ea00fd17bc30924cde70d9a1d82a62c6eeefc881cd5ea5dcce63
       filename: appsignal-i686-linux-all-dynamic.tar.gz
   x86-linux:
     static:
-      checksum: cb772a8a178edb25d666b650efda80149c98e80e4264435d6176f8a6104f959a
+      checksum: 60ad6a1f69c8f89b5642f49fbf794409e8ada7d63a9126b2c59832c2a92d5b22
       filename: appsignal-i686-linux-all-static.tar.gz
     dynamic:
-      checksum: c9ac51f4d1b3cc13773d8fa8ea5cfad6af7909144d85186cef9324ec0531bdac
+      checksum: aedf259de392ea00fd17bc30924cde70d9a1d82a62c6eeefc881cd5ea5dcce63
       filename: appsignal-i686-linux-all-dynamic.tar.gz
   x86_64-linux:
     static:
-      checksum: d6c280e992d74f97d59da9827ec5707ca4f6776b0568cde1c083c1113e4b7104
+      checksum: 7e3cf760f9bd364a6602f05e5014ce1c8e8ac9a97f7a533769711e0fb21e1f45
       filename: appsignal-x86_64-linux-all-static.tar.gz
     dynamic:
-      checksum: ef1a3f5d4b2ed61ea2ae4d5cb1a261a0e685fb9d3e7ea9efe455498aad386e59
+      checksum: 4a9a4ea22abc93c3afa7d5bfd6f442cd69bf4d672e8db2df1aa2157cfb3fcc4b
       filename: appsignal-x86_64-linux-all-dynamic.tar.gz
   x86_64-linux-musl:
     static:
-      checksum: 9cf8ad34392662746a45cfce18113ad19cc29954789e2058f30e527163f2e98a
+      checksum: 4d4dd00607cbe0fb4d14a15e74990f207eba90134c2d1a079b58f0d50f1ab76b
       filename: appsignal-x86_64-linux-musl-all-static.tar.gz
     dynamic:
-      checksum: 01bd76983227648d9bc41d035e1552fcf18d62f0d6818bf7bb7fc2e7c166513d
+      checksum: 067a6d821e220c9c88ceb8f936390ce458fa94f41c13d32603d773485a8cdfd2
       filename: appsignal-x86_64-linux-musl-all-dynamic.tar.gz
   x86_64-freebsd:
     static:
-      checksum: 403a597cbdbdba08460c5c9e93347ed9ad1d24333204e6d72db342deb266a296
+      checksum: 176bc1ff1ad40a585ea10456a8ae3f6502c614d713dcbb957d550fa1ae44e7ca
       filename: appsignal-x86_64-freebsd-all-static.tar.gz
     dynamic:
-      checksum: a1faae80ae09a6588c4cd35cb91dfa4b2176fc3cb17fbf79db80194c21e75bf9
+      checksum: 88c6f3e03f8f6c25a4705f7d6c4286eaa563069a9fb8fad3c0a19e5b9a09f80b
       filename: appsignal-x86_64-freebsd-all-dynamic.tar.gz
   amd64-freebsd:
     static:
-      checksum: 403a597cbdbdba08460c5c9e93347ed9ad1d24333204e6d72db342deb266a296
+      checksum: 176bc1ff1ad40a585ea10456a8ae3f6502c614d713dcbb957d550fa1ae44e7ca
       filename: appsignal-x86_64-freebsd-all-static.tar.gz
     dynamic:
-      checksum: a1faae80ae09a6588c4cd35cb91dfa4b2176fc3cb17fbf79db80194c21e75bf9
+      checksum: 88c6f3e03f8f6c25a4705f7d6c4286eaa563069a9fb8fad3c0a19e5b9a09f80b
       filename: appsignal-x86_64-freebsd-all-dynamic.tar.gz

data/gemfiles/no_dependencies.gemfile

@@ -2,11 +2,4 @@ source 'https://rubygems.org'
 
 gem 'rack', '~> 1.6'
 
-ruby_version = Gem::Version.new(RUBY_VERSION)
-if ruby_version < Gem::Version.new("2.0.0")
-  # Newer versions of this gem have rexml as a dependency which doesn't work on
-  # Ruby 1.9
-  gem "crack", "0.4.4"
-end
-
 gemspec :path => '../'

data/lib/appsignal.rb

@@ -4,9 +4,9 @@ require "json"
 require "securerandom"
 
 require "appsignal/logger"
+require "appsignal/utils/deprecation_message"
 require "appsignal/helpers/instrumentation"
 require "appsignal/helpers/metrics"
-require "appsignal/utils/deprecation_message"
 
 # AppSignal for Ruby gem's main module.
 #
@@ -18,7 +18,6 @@ module Appsignal
   class << self
     include Helpers::Instrumentation
     include Helpers::Metrics
-    include Utils::DeprecationMessage
 
     # Accessor for the AppSignal configuration.
     # Return the current AppSignal configuration.

data/lib/appsignal/config.rb

@@ -81,7 +81,6 @@ module Appsignal
     ENV_STRING_KEYS = %w[
       APPSIGNAL_APP_NAME
       APPSIGNAL_CA_FILE_PATH
-      APPSIGNAL_DNS_SERVERS
       APPSIGNAL_HOSTNAME
       APPSIGNAL_HTTP_PROXY
       APPSIGNAL_LOG
@@ -112,6 +111,7 @@ module Appsignal
     ].freeze
     # @api private
     ENV_ARRAY_KEYS = %w[
+      APPSIGNAL_DNS_SERVERS
       APPSIGNAL_FILTER_PARAMETERS
       APPSIGNAL_FILTER_SESSION_DATA
       APPSIGNAL_IGNORE_ACTIONS

data/lib/appsignal/extension.rb

@@ -40,6 +40,16 @@ module Appsignal
       def method_missing(m, *args, &block)
         super if Appsignal.testing?
       end
+
+      unless Appsignal.extension_loaded?
+        def data_map_new
+          Appsignal::Extension::MockData.new
+        end
+
+        def data_array_new
+          Appsignal::Extension::MockData.new
+        end
+      end
     end
 
     if Appsignal::System.jruby?
@@ -62,5 +72,45 @@ module Appsignal
         "#<#{self.class.name}:#{object_id} #{self}>"
       end
     end
+
+    # Mock of the {Data} class. This mock is used when the extension cannot be
+    # loaded. This mock listens to all method calls and does nothing, and
+    # prevents NoMethodErrors from being raised.
+    #
+    # Disabled in testing so we can make sure that we don't miss an extension
+    # function implementation.
+    #
+    # This class inherits from the {Data} class so that it passes type checks.
+    class MockData < Data
+      def initialize(*_args)
+        # JRuby extension requirement, as it sends a pointer to the Data object
+        # when creating it
+      end
+
+      def method_missing(_method, *_args, &_block)
+        super if Appsignal.testing?
+      end
+
+      def to_s
+        "{}"
+      end
+    end
+
+    # Mock of the {Transaction} class. This mock is used when the extension
+    # cannot be loaded. This mock listens to all method calls and does nothing,
+    # and prevents NoMethodErrors from being raised.
+    #
+    # Disabled in testing so we can make sure that we don't miss an extension
+    # function implementation.
+    class MockTransaction
+      def initialize(*_args)
+        # JRuby extension requirement, as it sends a pointer to the Transaction
+        # object when creating it
+      end
+
+      def method_missing(_method, *_args, &_block)
+        super if Appsignal.testing?
+      end
+    end
   end
 end

data/lib/appsignal/helpers/instrumentation.rb

@@ -3,6 +3,8 @@
 module Appsignal
   module Helpers
     module Instrumentation # rubocop:disable Metrics/ModuleLength
+      include Appsignal::Utils::DeprecationMessage
+
       # Creates an AppSignal transaction for the given block.
       #
       # If AppSignal is not {.active?} it will still execute the block, but not
@@ -139,7 +141,10 @@ module Appsignal
       )
         yield
       rescue Exception => error # rubocop:disable Lint/RescueException
-        send_error(error, tags, namespace)
+        send_error(error) do |transaction|
+          transaction.set_tags(tags) if tags
+          transaction.set_namespace(namespace) if namespace
+        end
         raise error
       end
       alias :listen_for_exception :listen_for_error
@@ -164,7 +169,7 @@ module Appsignal
       #     Appsignal.send_error(e)
       #   end
       #
-      # @example Send an exception with tags
+      # @example Send an exception with tags. Deprecated method.
       #   begin
       #     raise "oh no!"
       #   rescue => e
@@ -172,17 +177,20 @@ module Appsignal
       #   end
       #
       # @example Add more metadata to transaction
-      #   Appsignal.send_error(e, :key => "value") do |transaction|
+      #   Appsignal.send_error(e) do |transaction|
       #     transaction.params(:search_query => params[:search_query])
       #     transaction.set_action("my_action_name")
+      #     transaction.set_tags(:key => "value")
       #     transaction.set_namespace("my_namespace")
       #   end
       #
       # @param error [Exception] The error to send to AppSignal.
       # @param tags [Hash{String, Symbol => String, Symbol, Integer}]
       #   Additional tags to add to the error. See also {.tag_request}.
+      #   This parameter is deprecated. Use the block argument instead.
       # @param namespace [String] The namespace in which the error occurred.
       #   See also {.set_namespace}.
+      #   This parameter is deprecated. Use the block argument instead.
       # @yield [transaction] yields block to allow modification of the
       #   transaction before it's send.
       # @yieldparam transaction [Transaction] yields the AppSignal transaction
@@ -197,9 +205,30 @@ module Appsignal
       def send_error(
         error,
         tags = nil,
-        namespace = Appsignal::Transaction::HTTP_REQUEST
+        namespace = nil
       )
+        if tags
+          call_location = caller(1..1).first
+          deprecation_message \
+            "The tags argument for `Appsignal.send_error` is deprecated. " \
+            "Please use the block method to set tags instead.\n\n" \
+            "  Appsignal.send_error(error) do |transaction|\n" \
+            "    transaction.set_tags(#{tags})\n" \
+            "  end\n\n" \
+            "Appsignal.send_error called on location: #{call_location}"
+        end
+        if namespace
+          call_location = caller(1..1).first
+          deprecation_message \
+            "The namespace argument for `Appsignal.send_error` is deprecated. " \
+            "Please use the block method to set the namespace instead.\n\n" \
+            "  Appsignal.send_error(error) do |transaction|\n" \
+            "    transaction.set_namespace(#{namespace.inspect})\n" \
+            "  end\n\n" \
+            "Appsignal.send_error called on location: #{call_location}"
+        end
         return unless active?
+
         unless error.is_a?(Exception)
           logger.error "Appsignal.send_error: Cannot send error. The given " \
             "value is not an exception: #{error.inspect}"
@@ -207,7 +236,7 @@ module Appsignal
         end
         transaction = Appsignal::Transaction.new(
           SecureRandom.uuid,
-          namespace,
+          namespace || Appsignal::Transaction::HTTP_REQUEST,
           Appsignal::Transaction::GenericRequest.new({})
         )
         transaction.set_tags(tags) if tags
@@ -244,12 +273,26 @@ module Appsignal
       #     end
       #   end
       #
+      # @example Add more metadata to transaction
+      #   Appsignal.set_error(e) do |transaction|
+      #     transaction.params(:search_query => params[:search_query])
+      #     transaction.set_action("my_action_name")
+      #     transaction.set_tags(:key => "value")
+      #     transaction.set_namespace("my_namespace")
+      #   end
+      #
       # @param exception [Exception] The error to add to the current
       #   transaction.
       # @param tags [Hash{String, Symbol => String, Symbol, Integer}]
       #   Additional tags to add to the error. See also {.tag_request}.
+      #   This parameter is deprecated. Use the block argument instead.
       # @param namespace [String] The namespace in which the error occurred.
       #   See also {.set_namespace}.
+      #   This parameter is deprecated. Use the block argument instead.
+      # @yield [transaction] yields block to allow modification of the
+      #   transaction.
+      # @yieldparam transaction [Transaction] yields the AppSignal transaction
+      #   used to store the error.
       # @return [void]
       #
       # @see Transaction#set_error
@@ -257,6 +300,26 @@ module Appsignal
       #   Exception handling guide
       # @since 0.6.6
       def set_error(exception, tags = nil, namespace = nil)
+        if tags
+          call_location = caller(1..1).first
+          deprecation_message \
+            "The tags argument for `Appsignal.set_error` is deprecated. " \
+            "Please use the block method to set tags instead.\n\n" \
+            "  Appsignal.set_error(error) do |transaction|\n" \
+            "    transaction.set_tags(#{tags})\n" \
+            "  end\n\n" \
+            "Appsignal.set_error called on location: #{call_location}"
+        end
+        if namespace
+          call_location = caller(1..1).first
+          deprecation_message \
+            "The namespace argument for `Appsignal.set_error` is deprecated. " \
+            "Please use the block method to set the namespace instead.\n\n" \
+            "  Appsignal.set_error(error) do |transaction|\n" \
+            "    transaction.set_namespace(#{namespace.inspect})\n" \
+            "  end\n\n" \
+            "Appsignal.set_error called on location: #{call_location}"
+        end
         unless exception.is_a?(Exception)
           logger.error "Appsignal.set_error: Cannot set error. The given " \
             "value is not an exception: #{exception.inspect}"
@@ -267,6 +330,7 @@ module Appsignal
         transaction.set_error(exception)
         transaction.set_tags(tags) if tags
         transaction.set_namespace(namespace) if namespace
+        yield transaction if block_given?
       end
       alias :set_exception :set_error
       alias :add_exception :set_error