airbrake-ruby 6.0.1 → 6.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f89d6e09b27f36f4d4450eeb9dd6fb9dff228ffe095769f8b9bcc24a02413842
-  data.tar.gz: a2b4daefe2139f002a42754b6df05c6c11dca9d80b0ecf440cd0620336a2d87e
+  metadata.gz: 7b26c79894b2b9922c3951a91eba90c906bd3164dda7b9e66dfe3f95ed392951
+  data.tar.gz: 1b835db3c660cdbfee82a3ef3a67a7237c83a66c3d153377a1fbc50ed4870840
 SHA512:
-  metadata.gz: 423f95e5781de19de642d880106b38feca43c98f9223956e4208b616929d6a63c56e1ca223d449115f232e60f0a84f9f0c52c140df708d2deaf20aa2dfca4a3e
-  data.tar.gz: e09266840dd038be725ad564d6db02696e5c6a0f188eae5206da30cbd2cf454eccbe56cbcf027b454821e6ef1bee29cb8fb2db7c7c61f81ffa6e0ecb1566c133
+  metadata.gz: eb9e13c39dfa7f0f228716c38ff1cbe7371f2c12a7455489b4179815c4fb345e8720e95617cccfd2127c946b1772f6ecf39e3b886b0b2af9cdc8bdd3dce6c1f4
+  data.tar.gz: 6081c2a922b9334e31220a0f7d87309dd054a6d2ef5837f254d719a85dd4914a004f5fc6fe2f8adbffdd649f24320cb04973d0439e1a5b41665ee6217fa7e237

data/lib/airbrake-ruby/config/processor.rb

@@ -43,8 +43,14 @@ module Airbrake
       def process_remote_configuration
         return unless @config.remote_config
         return unless @project_id
+
+        # Never poll remote configuration in the test environment.
         return if @config.environment == 'test'
 
+        # If the current environment is ignored, don't try to poll remote
+        # configuration.
+        return if @config.ignore_environments.include?(@config.environment)
+
         RemoteSettings.poll(@project_id, @config.remote_config_host) do |data|
           @poll_callback.call(data)
         end

data/lib/airbrake-ruby/config.rb

@@ -248,14 +248,14 @@ module Airbrake
 
     # @return [Promise] resolved promise if neither of the performance options
     #   reject it, false otherwise
-    def check_performance_options(resource)
+    def check_performance_options(metric)
       promise = Airbrake::Promise.new
 
       if !performance_stats
         promise.reject("The Performance Stats feature is disabled")
-      elsif resource.is_a?(Airbrake::Query) && !query_stats
+      elsif metric.is_a?(Airbrake::Query) && !query_stats
         promise.reject("The Query Stats feature is disabled")
-      elsif resource.is_a?(Airbrake::Queue) && !job_stats
+      elsif metric.is_a?(Airbrake::Queue) && !job_stats
         promise.reject("The Job Stats feature is disabled")
       else
         promise

data/lib/airbrake-ruby/filters/git_last_checkout_filter.rb

@@ -27,7 +27,7 @@ module Airbrake
         @git_path = File.join(root_directory, '.git')
         @weight = 116
         @last_checkout = nil
-        @deploy_username = ENV['AIRBRAKE_DEPLOY_USERNAME']
+        @deploy_username = ENV.fetch('AIRBRAKE_DEPLOY_USERNAME', nil)
       end
 
       # @macro call_filter

data/lib/airbrake-ruby/filters/git_repository_filter.rb

@@ -49,7 +49,13 @@ module Airbrake
       def detect_git_version
         return unless which('git')
 
-        Gem::Version.new(`git --version`.split[2])
+        begin
+          Gem::Version.new(`git --version`.split[2])
+        rescue Errno::EAGAIN
+          # Bugfix for the case when the system cannot allocate memory for
+          # a fork() call: https://github.com/airbrake/airbrake-ruby/issues/680
+          nil
+        end
       end
 
       # Cross-platform way to tell if an executable is accessible.

data/lib/airbrake-ruby/filters/sql_filter.rb

@@ -108,20 +108,20 @@ module Airbrake
         @regexp = Regexp.union(features)
       end
 
-      # @param [Airbrake::Query] resource
-      def call(resource)
-        return unless resource.respond_to?(:query)
+      # @param [Airbrake::Query] metric
+      def call(metric)
+        return unless metric.respond_to?(:query)
 
-        query = resource.query
+        query = metric.query
         if IGNORED_QUERIES.any? { |q| q =~ query }
-          resource.ignore!
+          metric.ignore!
           return
         end
 
         q = query.gsub(@regexp, FILTERED)
         q.gsub!(POST_FILTER, FILTERED) if q =~ POST_FILTER
         q = ERROR_MSG if UNMATCHED_PAIR[@dialect] =~ q
-        resource.query = q
+        metric.query = q
       end
     end
   end

data/lib/airbrake-ruby/nested_exception.rb

@@ -9,6 +9,15 @@ module Airbrake
     #   can unwrap. Exceptions that have a longer cause chain will be ignored
     MAX_NESTED_EXCEPTIONS = 3
 
+    # On Ruby 3.1+, the error highlighting gem can produce messages that can
+    # span multiple lines. We don't display multiline error messages in the
+    # title of the notice in the Airbrake dashboard. Therefore, we want to strip
+    # out the higlighting part so that the errors look consistent. The full
+    # message with the exception will be attached to the notice body.
+    #
+    # @return [String]
+    RUBY_31_ERROR_HIGHLIGHTING_DIVIDER = "\n\n".freeze
+
     def initialize(exception)
       @exception = exception
     end
@@ -16,7 +25,7 @@ module Airbrake
     def as_json
       unwind_exceptions.map do |exception|
         { type: exception.class.name,
-          message: exception.message,
+          message: exception.message.split(RUBY_31_ERROR_HIGHLIGHTING_DIVIDER).first,
           backtrace: Backtrace.parse(exception) }
       end
     end

data/lib/airbrake-ruby/notice.rb

@@ -49,16 +49,17 @@ module Airbrake
     # @api private
     def initialize(exception, params = {})
       @config = Airbrake::Config.instance
+      @truncator = Airbrake::Truncator.new(PAYLOAD_MAX_SIZE)
+
       @payload = {
         errors: NestedException.new(exception).as_json,
-        context: context,
+        context: context(exception),
         environment: {
           program_name: $PROGRAM_NAME,
         },
         session: {},
         params: params,
       }
-      @truncator = Airbrake::Truncator.new(PAYLOAD_MAX_SIZE)
 
       stash[:exception] = exception
     end
@@ -118,7 +119,7 @@ module Airbrake
 
     private
 
-    def context
+    def context(exception)
       {
         version: @config.app_version,
         versions: @config.versions,
@@ -132,6 +133,7 @@ module Airbrake
         hostname: HOSTNAME,
 
         severity: DEFAULT_SEVERITY,
+        error_message: @truncator.truncate(exception.message),
       }.merge(CONTEXT).delete_if { |_key, val| val.nil? || val.empty? }
     end
 

data/lib/airbrake-ruby/performance_notifier.rb

@@ -1,6 +1,6 @@
 module Airbrake
-  # QueryNotifier aggregates information about SQL queries and periodically sends
-  # collected data to Airbrake.
+  # PerformanceNotifier aggregates performance data and periodically sends it to
+  # Airbrake.
   #
   # @api public
   # @since v3.2.0
@@ -21,20 +21,20 @@ module Airbrake
       @has_payload = @payload.new_cond
     end
 
-    # @param [Hash] resource
+    # @param [Hash] metric
     # @see Airbrake.notify_query
     # @see Airbrake.notify_request
-    def notify(resource)
+    def notify(metric)
       @payload.synchronize do
-        send_resource(resource, sync: false)
+        send_metric(metric, sync: false)
       end
     end
 
-    # @param [Hash] resource
+    # @param [Hash] metric
     # @since v4.10.0
     # @see Airbrake.notify_queue_sync
-    def notify_sync(resource)
-      send_resource(resource, sync: true).value
+    def notify_sync(metric)
+      send_metric(metric, sync: true).value
     end
 
     # @see Airbrake.add_performance_filter
@@ -78,16 +78,16 @@ module Airbrake
       end
     end
 
-    def send_resource(resource, sync:)
-      promise = check_configuration(resource)
+    def send_metric(metric, sync:)
+      promise = check_configuration(metric)
       return promise if promise.rejected?
 
-      @filter_chain.refine(resource)
-      if resource.ignored?
-        return Promise.new.reject("#{resource.class} was ignored by a filter")
+      @filter_chain.refine(metric)
+      if metric.ignored?
+        return Promise.new.reject("#{metric.class} was ignored by a filter")
       end
 
-      update_payload(resource)
+      update_payload(metric)
       if sync || @flush_period == 0
         send(@sync_sender, @payload, promise)
       else
@@ -96,29 +96,29 @@ module Airbrake
       end
     end
 
-    def update_payload(resource)
-      if (total_stat = @payload[resource])
-        @payload.key(total_stat).merge(resource)
+    def update_payload(metric)
+      if (total_stat = @payload[metric])
+        @payload.key(total_stat).merge(metric)
       else
-        @payload[resource] = { total: Airbrake::Stat.new }
+        @payload[metric] = { total: Airbrake::Stat.new }
       end
 
-      @payload[resource][:total].increment_ms(resource.timing)
+      @payload[metric][:total].increment_ms(metric.timing)
 
-      resource.groups.each do |name, ms|
-        @payload[resource][name] ||= Airbrake::Stat.new
-        @payload[resource][name].increment_ms(ms)
+      metric.groups.each do |name, ms|
+        @payload[metric][name] ||= Airbrake::Stat.new
+        @payload[metric][name].increment_ms(ms)
       end
     end
 
-    def check_configuration(resource)
+    def check_configuration(metric)
       promise = @config.check_configuration
       return promise if promise.rejected?
 
-      promise = @config.check_performance_options(resource)
+      promise = @config.check_performance_options(metric)
       return promise if promise.rejected?
 
-      if resource.timing && resource.timing == 0
+      if metric.timing && metric.timing == 0
         return Promise.new.reject(':timing cannot be zero')
       end
 
@@ -128,47 +128,47 @@ module Airbrake
     def send(sender, payload, promise)
       raise "payload cannot be empty. Race?" if payload.none?
 
-      with_grouped_payload(payload) do |resource_hash, destination|
+      with_grouped_payload(payload) do |metric_hash, destination|
         url = URI.join(
           @config.apm_host,
           "api/v5/projects/#{@config.project_id}/#{destination}",
         )
 
         logger.debug do
-          "#{LOG_LABEL} #{self.class.name}##{__method__}: #{resource_hash}"
+          "#{LOG_LABEL} #{self.class.name}##{__method__}: #{metric_hash}"
         end
-        sender.send(resource_hash, promise, url)
+        sender.send(metric_hash, promise, url)
       end
 
       promise
     end
 
     def with_grouped_payload(raw_payload)
-      grouped_payload = raw_payload.group_by do |resource, _stats|
-        [resource.cargo, resource.destination]
+      grouped_payload = raw_payload.group_by do |metric, _stats|
+        [metric.cargo, metric.destination]
       end
 
-      grouped_payload.each do |(cargo, destination), resources|
+      grouped_payload.each do |(cargo, destination), metrics|
         payload = {}
-        payload[cargo] = serialize_resources(resources)
+        payload[cargo] = serialize_metrics(metrics)
         payload['environment'] = @config.environment if @config.environment
 
         yield(payload, destination)
       end
     end
 
-    def serialize_resources(resources)
-      resources.map do |resource, stats|
-        resource_hash = resource.to_h.merge!(stats[:total].to_h)
+    def serialize_metrics(metrics)
+      metrics.map do |metric, stats|
+        metric_hash = metric.to_h.merge!(stats[:total].to_h)
 
-        if resource.groups.any?
+        if metric.groups.any?
           group_stats = stats.reject { |name, _stat| name == :total }
-          resource_hash['groups'] = group_stats.merge(group_stats) do |_name, stat|
+          metric_hash['groups'] = group_stats.merge(group_stats) do |_name, stat|
             stat.to_h
           end
         end
 
-        resource_hash
+        metric_hash
       end
     end
   end

data/lib/airbrake-ruby/stat.rb

@@ -4,7 +4,7 @@ module Airbrake
   # Stat is a data structure that allows accumulating performance data (route
   # performance, SQL query performance and such). It's powered by TDigests.
   #
-  # Usually, one Stat corresponds to one resource (route or query,
+  # Usually, one Stat corresponds to one metric (route or query,
   # etc.). Incrementing a stat means pushing new performance statistics.
   #
   # @example

data/lib/airbrake-ruby/time_truncate.rb

@@ -6,10 +6,10 @@ module Airbrake
   module TimeTruncate
     # Truncate +time+ to floor minute and turn it into an RFC3339 timestamp.
     #
-    # @param [Time] time
+    # @param [Time, Integer, Float] time
     # @return [String]
     def self.utc_truncate_minutes(time)
-      tm = time.getutc
+      tm = Time.at(time).getutc
 
       Time.utc(tm.year, tm.month, tm.day, tm.hour, tm.min).to_datetime.rfc3339
     end

data/lib/airbrake-ruby/version.rb

@@ -3,7 +3,7 @@
 module Airbrake
   # @return [String] the library version
   # @api public
-  AIRBRAKE_RUBY_VERSION = '6.0.1'.freeze
+  AIRBRAKE_RUBY_VERSION = '6.1.1'.freeze
 
   # @return [Hash{Symbol=>String}] the information about the notifier library
   # @since v5.0.0

data/lib/airbrake-ruby.rb

@@ -364,23 +364,14 @@ module Airbrake
     #     method: 'POST',
     #     route: '/thing/:id/create',
     #     status_code: 200,
-    #     func: 'do_stuff',
-    #     file: 'app/models/foo.rb',
-    #     line: 452,
     #     timing: 123.45 # ms
     #   )
     #
     # @param [Hash{Symbol=>Object}] request_info
     # @option request_info [String] :method The HTTP method that was invoked
     # @option request_info [String] :route The route that was invoked
-    # @option request_info [Integer] :status_code The respose code that the
+    # @option request_info [Integer] :status_code The response code that the
     #   route returned
-    # @option request_info [String] :func The function that called the query
-    #   (optional)
-    # @option request_info [String] :file The file that has the function that
-    #   called the query (optional)
-    # @option request_info [Integer] :line The line that executes the query
-    #   (optional)
     # @option request_info [Float] :timing  How much time it took to process the
     #   request (in ms)
     # @param [Hash] stash What needs to be appeneded to the stash, so it's
@@ -415,6 +406,9 @@ module Airbrake
     #     method: 'GET',
     #     route: '/things',
     #     query: 'SELECT * FROM things',
+    #     func: 'do_stuff',
+    #     file: 'app/models/foo.rb',
+    #     line: 452,
     #     timing: 123.45 # ms
     #   )
     #
@@ -424,6 +418,12 @@ module Airbrake
     # @option query_info [String] :route The route that triggered this SQL
     #    query (optional)
     # @option query_info [String] :query The query that was executed
+    # @option request_info [String] :func The function that called the query
+    #   (optional)
+    # @option request_info [String] :file The file that has the function that
+    #   called the query (optional)
+    # @option request_info [Integer] :line The line that executes the query
+    #   (optional)
     # @option query_info [Float] :timing How much time it took to process the
     #   query (in ms)
     # @param [Hash] stash What needs to be appeneded to the stash, so it's
@@ -451,7 +451,7 @@ module Airbrake
     # Increments performance breakdown statistics of a certain route.
     #
     # @example
-    #   Airbrake.notify_request(
+    #   Airbrake.notify_performance_breakdown(
     #     method: 'POST',
     #     route: '/thing/:id/create',
     #     response_type: 'json',
@@ -523,24 +523,24 @@ module Airbrake
       performance_notifier.notify_sync(queue)
     end
 
-    # Runs a callback before {.notify_request} or {.notify_query} kicks in. This
-    # is useful if you want to ignore specific resources or filter the data the
-    # resource contains.
+    # Runs a callback before {.notify_request}, {.notify_query}, {.notify_queue}
+    # or {.notify_performance_breakdown} kicks in. This is useful if you want to
+    # ignore specific metrics or filter the data the metric contains.
     #
-    # @example Ignore all resources
+    # @example Ignore all metrics
     #   Airbrake.add_performance_filter(&:ignore!)
     # @example Filter sensitive data
-    #   Airbrake.add_performance_filter do |resource|
-    #     case resource
+    #   Airbrake.add_performance_filter do |metric|
+    #     case metric
     #     when Airbrake::Query
-    #       resource.route = '[Filtered]'
+    #       metric.route = '[Filtered]'
     #     when Airbrake::Request
-    #       resource.query = '[Filtered]'
+    #       metric.query = '[Filtered]'
     #     end
     #   end
     # @example Filter with help of a class
     #   class MyFilter
-    #     def call(resource)
+    #     def call(metric)
     #       # ...
     #     end
     #   end
@@ -548,7 +548,7 @@ module Airbrake
     #   Airbrake.add_performance_filter(MyFilter.new)
     #
     # @param [#call] filter The filter object
-    # @yield [resource] The resource to filter
+    # @yield [metric] The metric to filter
     # @yieldparam [Airbrake::Query, Airbrake::Request]
     # @yieldreturn [void]
     # @return [void]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 6.0.1
+  version: 6.1.1
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-07 00:00:00.000000000 Z
+date: 2022-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbtree3
@@ -93,69 +93,11 @@ files:
 - lib/airbrake-ruby/timed_trace.rb
 - lib/airbrake-ruby/truncator.rb
 - lib/airbrake-ruby/version.rb
-- spec/airbrake_spec.rb
-- spec/async_sender_spec.rb
-- spec/backtrace_spec.rb
-- spec/benchmark_spec.rb
-- spec/code_hunk_spec.rb
-- spec/config/processor_spec.rb
-- spec/config/validator_spec.rb
-- spec/config_spec.rb
-- spec/context_spec.rb
-- spec/deploy_notifier_spec.rb
-- spec/file_cache_spec.rb
-- spec/filter_chain_spec.rb
-- spec/filters/context_filter_spec.rb
-- spec/filters/dependency_filter_spec.rb
-- spec/filters/exception_attributes_filter_spec.rb
-- spec/filters/gem_root_filter_spec.rb
-- spec/filters/git_last_checkout_filter_spec.rb
-- spec/filters/git_repository_filter.rb
-- spec/filters/git_revision_filter_spec.rb
-- spec/filters/keys_allowlist_spec.rb
-- spec/filters/keys_blocklist_spec.rb
-- spec/filters/root_directory_filter_spec.rb
-- spec/filters/sql_filter_spec.rb
-- spec/filters/system_exit_filter_spec.rb
-- spec/filters/thread_filter_spec.rb
-- spec/fixtures/notroot.txt
-- spec/fixtures/project_root/code.rb
-- spec/fixtures/project_root/empty_file.rb
-- spec/fixtures/project_root/long_line.txt
-- spec/fixtures/project_root/short_file.rb
-- spec/fixtures/project_root/vendor/bundle/ignored_file.rb
-- spec/helpers.rb
-- spec/ignorable_spec.rb
-- spec/inspectable_spec.rb
-- spec/loggable_spec.rb
-- spec/monotonic_time_spec.rb
-- spec/nested_exception_spec.rb
-- spec/notice_notifier/options_spec.rb
-- spec/notice_notifier_spec.rb
-- spec/notice_spec.rb
-- spec/performance_breakdown_spec.rb
-- spec/performance_notifier_spec.rb
-- spec/promise_spec.rb
-- spec/query_spec.rb
-- spec/queue_spec.rb
-- spec/remote_settings/callback_spec.rb
-- spec/remote_settings/settings_data_spec.rb
-- spec/remote_settings_spec.rb
-- spec/request_spec.rb
-- spec/response_spec.rb
-- spec/spec_helper.rb
-- spec/stashable_spec.rb
-- spec/stat_spec.rb
-- spec/sync_sender_spec.rb
-- spec/tdigest_spec.rb
-- spec/thread_pool_spec.rb
-- spec/time_truncate_spec.rb
-- spec/timed_trace_spec.rb
-- spec/truncator_spec.rb
 homepage: https://airbrake.io
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -171,67 +113,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Ruby notifier for https://airbrake.io
-test_files:
-- spec/airbrake_spec.rb
-- spec/async_sender_spec.rb
-- spec/backtrace_spec.rb
-- spec/benchmark_spec.rb
-- spec/code_hunk_spec.rb
-- spec/config/processor_spec.rb
-- spec/config/validator_spec.rb
-- spec/config_spec.rb
-- spec/context_spec.rb
-- spec/deploy_notifier_spec.rb
-- spec/file_cache_spec.rb
-- spec/filter_chain_spec.rb
-- spec/filters/context_filter_spec.rb
-- spec/filters/dependency_filter_spec.rb
-- spec/filters/exception_attributes_filter_spec.rb
-- spec/filters/gem_root_filter_spec.rb
-- spec/filters/git_last_checkout_filter_spec.rb
-- spec/filters/git_repository_filter.rb
-- spec/filters/git_revision_filter_spec.rb
-- spec/filters/keys_allowlist_spec.rb
-- spec/filters/keys_blocklist_spec.rb
-- spec/filters/root_directory_filter_spec.rb
-- spec/filters/sql_filter_spec.rb
-- spec/filters/system_exit_filter_spec.rb
-- spec/filters/thread_filter_spec.rb
-- spec/fixtures/notroot.txt
-- spec/fixtures/project_root/code.rb
-- spec/fixtures/project_root/empty_file.rb
-- spec/fixtures/project_root/long_line.txt
-- spec/fixtures/project_root/short_file.rb
-- spec/fixtures/project_root/vendor/bundle/ignored_file.rb
-- spec/helpers.rb
-- spec/ignorable_spec.rb
-- spec/inspectable_spec.rb
-- spec/loggable_spec.rb
-- spec/monotonic_time_spec.rb
-- spec/nested_exception_spec.rb
-- spec/notice_notifier/options_spec.rb
-- spec/notice_notifier_spec.rb
-- spec/notice_spec.rb
-- spec/performance_breakdown_spec.rb
-- spec/performance_notifier_spec.rb
-- spec/promise_spec.rb
-- spec/query_spec.rb
-- spec/queue_spec.rb
-- spec/remote_settings/callback_spec.rb
-- spec/remote_settings/settings_data_spec.rb
-- spec/remote_settings_spec.rb
-- spec/request_spec.rb
-- spec/response_spec.rb
-- spec/spec_helper.rb
-- spec/stashable_spec.rb
-- spec/stat_spec.rb
-- spec/sync_sender_spec.rb
-- spec/tdigest_spec.rb
-- spec/thread_pool_spec.rb
-- spec/time_truncate_spec.rb
-- spec/timed_trace_spec.rb
-- spec/truncator_spec.rb
+test_files: []