bugsnag 6.23.0 → 6.24.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 763fc185ada81aaefdfb19edc7ca88788921c4577ec3e5a76addadcd8e13227c
-  data.tar.gz: 47661582b92e719b81f9023678dac8fcd558dd641ae124e0305b3f32157ccdd7
+  metadata.gz: b0c0062b72786fa763b8b17ff0f72647808c2c0372c08b098b70007acc52dec9
+  data.tar.gz: c467bdbbe899f9e6f2ec1bf47071c8f70228f7cac51f292e8b77a6c9724da368
 SHA512:
-  metadata.gz: 5de707cdf88e2c4d46cbfcd6fde2dad857c584c366788ea31dffa0b62c80d9a8dea9e8cf030306f70e793bff3999b92ae5c165309eb48d4fab2d77453160cd33
-  data.tar.gz: f23a0d06302491091fc15d209bd09e45f1a47017467f163e1ea36fd4702dbadf1c395e36fb71283261d78c505dc6f2459ad7a7da9052989f81200f6df3c0b7ba
+  metadata.gz: c2cd2286a921e1cb2ad6e78e620c097a7a5937be53ebb75f020cc7eaba31505c904315083b545a1f9758ddb14c2e902c8e47e8845eef3a242fd8aec810860496
+  data.tar.gz: 15410f4d0280b5abb8f9804a6b66c6d05eed52c025e394ed0fbc642507d7ac64b2cb90db5a1dda0a946143d85dbab4d148dafab88697fa47bb79363d4ff6df3e

data/CHANGELOG.md

@@ -1,6 +1,48 @@
 Changelog
 =========
 
+## v6.24.2 (21 January 2022)
+
+### Fixes
+
+* Avoid rescuing from errors in Active Record transaction callbacks in versions of Rails where they will be re-raised
+  | [#709](https://github.com/bugsnag/bugsnag-ruby/pull/709)
+  | [apalmblad](https://github.com/apalmblad)
+
+## v6.24.1 (30 November 2021)
+
+### Fixes
+
+* Fix metadata not being recorded when using Resque outside of Active Job
+  | [#710](https://github.com/bugsnag/bugsnag-ruby/pull/710)
+  | [isnotajoke](https://github.com/isnotajoke)
+
+## v6.24.0 (6 October 2021)
+
+### Enhancements
+
+* Allow overriding an event's unhandled flag
+  | [#698](https://github.com/bugsnag/bugsnag-ruby/pull/698)
+* Add the ability to store metadata globally
+  | [#699](https://github.com/bugsnag/bugsnag-ruby/pull/699)
+* Add `cookies`, `body` and `httpVersion` to the automatically captured request data for Rack apps
+  | [#700](https://github.com/bugsnag/bugsnag-ruby/pull/700)
+* Add `Configuration#endpoints` for reading the notify and sessions endpoints and `Configuration#endpoints=` for setting them
+  | [#701](https://github.com/bugsnag/bugsnag-ruby/pull/701)
+* Add `Configuration#redacted_keys`. This is like `meta_data_filters` but matches strings with case-insensitive equality, rather than matching based on inclusion
+  | [#703](https://github.com/bugsnag/bugsnag-ruby/pull/703)
+* Allow pausing and resuming sessions, giving more control over the stability score
+  | [#704](https://github.com/bugsnag/bugsnag-ruby/pull/704)
+* Add `Configuration#vendor_paths` to replace `Configuration#vendor_path`
+  | [#705](https://github.com/bugsnag/bugsnag-ruby/pull/705)
+
+### Deprecated
+
+* In the next major release, `params` will only contain query string parameters. Currently it also contains the request body for form data requests, but this is deprecated in favour of the new `body` property
+* The `Configuration#set_endpoints` method is now deprecated in favour of `Configuration#endpoints=`
+* The `Configuration#meta_data_filters` option is now deprecated in favour of `Configuration#redacted_keys`
+* The `Configuration#vendor_path` option is now deprecated in favour of `Configuration#vendor_paths`
+
 ## v6.23.0 (21 September 2021)
 
 ### Enhancements

data/VERSION

@@ -1 +1 @@
-6.23.0
+6.24.2

data/lib/bugsnag/cleaner.rb

@@ -25,7 +25,7 @@ module Bugsnag
     # @param url [String]
     # @return [String]
     def clean_url(url)
-      return url if @configuration.meta_data_filters.empty?
+      return url if @configuration.meta_data_filters.empty? && @configuration.redacted_keys.empty?
 
       uri = URI(url)
       return url unless uri.query
@@ -43,6 +43,33 @@ module Bugsnag
       uri.to_s
     end
 
+    ##
+    # @param key [String, #to_s]
+    # @return [Boolean]
+    def filters_match?(key)
+      str = key.to_s
+
+      matched = @configuration.meta_data_filters.any? do |filter|
+        case filter
+        when Regexp
+          str.match(filter)
+        else
+          str.include?(filter.to_s)
+        end
+      end
+
+      return true if matched
+
+      @configuration.redacted_keys.any? do |redaction_pattern|
+        case redaction_pattern
+        when Regexp
+          str.match(redaction_pattern)
+        when String
+          str.downcase == redaction_pattern.downcase
+        end
+      end
+    end
+
     private
 
     ##
@@ -54,9 +81,11 @@ module Bugsnag
     #
     # @return [Boolean]
     def deep_filters?
-      @configuration.meta_data_filters.any? do |filter|
+      is_deep_filter = proc do |filter|
         filter.is_a?(Regexp) && filter.to_s.include?("\\.".freeze)
       end
+
+      @configuration.meta_data_filters.any?(&is_deep_filter) || @configuration.redacted_keys.any?(&is_deep_filter)
     end
 
     def clean_string(str)
@@ -137,22 +166,6 @@ module Bugsnag
       value
     end
 
-    ##
-    # @param key [String, #to_s]
-    # @return [Boolean]
-    def filters_match?(key)
-      str = key.to_s
-
-      @configuration.meta_data_filters.any? do |filter|
-        case filter
-        when Regexp
-          str.match(filter)
-        else
-          str.include?(filter.to_s)
-        end
-      end
-    end
-
     ##
     # If someone has a Rails filter like /^stuff\.secret/, it won't match
     # "request.params.stuff.secret", so we try it both with and without the

data/lib/bugsnag/configuration.rb

@@ -13,6 +13,8 @@ require "bugsnag/middleware/breadcrumbs"
 require "bugsnag/utility/circular_buffer"
 require "bugsnag/breadcrumbs/breadcrumbs"
 require "bugsnag/breadcrumbs/on_breadcrumb_callback_list"
+require "bugsnag/endpoint_configuration"
+require "bugsnag/endpoint_validator"
 
 module Bugsnag
   class Configuration
@@ -54,9 +56,20 @@ module Bugsnag
 
     # A list of keys that should be filtered out from the report and breadcrumb
     # metadata before sending them to Bugsnag
+    # @deprecated Use {#redacted_keys} instead
     # @return [Set<String, Regexp>]
     attr_accessor :meta_data_filters
 
+    # A set of keys that should be redacted from the report and breadcrumb
+    # metadata before sending them to Bugsnag
+    #
+    # When adding strings, keys that are equal to the string (ignoring case)
+    # will be redacted. When adding regular expressions, any keys which match
+    # the regular expression will be redacted
+    #
+    # @return [Set<String, Regexp>]
+    attr_accessor :redacted_keys
+
     # The logger to use for Bugsnag log messages
     # @return [Logger]
     attr_accessor :logger
@@ -114,16 +127,17 @@ module Bugsnag
     # @return [Set<Class, Proc>]
     attr_accessor :ignore_classes
 
-    # The URL error notifications will be delivered to
-    # @return [String]
-    attr_reader :notify_endpoint
-    alias :endpoint :notify_endpoint
+    # The URLs to send events and sessions to
+    # @return [EndpointConfiguration]
+    attr_reader :endpoints
 
-    # The URL session notifications will be delivered to
-    # @return [String]
-    attr_reader :session_endpoint
+    # Whether events will be delivered
+    # @api private
+    # @return [Boolean]
+    attr_reader :enable_events
 
     # Whether sessions will be delivered
+    # @api private
     # @return [Boolean]
     attr_reader :enable_sessions
 
@@ -141,15 +155,28 @@ module Bugsnag
     # @return [Integer]
     attr_reader :max_breadcrumbs
 
-    #
+    # @deprecated Use {vendor_paths} instead
     # @return [Regexp]
     attr_accessor :vendor_path
 
+    # An array of paths within the {project_root} that should not be considered
+    # as "in project"
+    #
+    # These paths should be relative to the {project_root} and will only match
+    # whole directory names
+    #
+    # @return [Array<String>]
+    attr_accessor :vendor_paths
+
     # The default context for all future events
     # Setting this will disable automatic context setting
     # @return [String, nil]
     attr_accessor :context
 
+    # Global metadata added to every event
+    # @return [Hash]
+    attr_reader :metadata
+
     # @api private
     # @return [Array<String>]
     attr_reader :scopes_to_filter
@@ -194,6 +221,7 @@ module Bugsnag
       self.send_environment = false
       self.send_code = true
       self.meta_data_filters = Set.new(DEFAULT_META_DATA_FILTERS)
+      @redacted_keys = Set.new
       self.scopes_to_filter = DEFAULT_SCOPES_TO_FILTER
       self.hostname = default_hostname
       self.runtime_versions = {}
@@ -213,11 +241,14 @@ module Bugsnag
       # to avoid infinite recursion when creating breadcrumb buffer
       @max_breadcrumbs = DEFAULT_MAX_BREADCRUMBS
 
-      # These are set exclusively using the "set_endpoints" method
-      @notify_endpoint = DEFAULT_NOTIFY_ENDPOINT
-      @session_endpoint = DEFAULT_SESSION_ENDPOINT
+      @endpoints = EndpointConfiguration.new(DEFAULT_NOTIFY_ENDPOINT, DEFAULT_SESSION_ENDPOINT)
+
+      @enable_events = true
       @enable_sessions = true
 
+      @metadata = {}
+      @metadata_delegate = Utility::MetadataDelegate.new
+
       # SystemExit and SignalException are common Exception types seen with
       # successful exits and are not automatically reported to Bugsnag
       # TODO move these defaults into `discard_classes` when `ignore_classes`
@@ -237,6 +268,7 @@ module Bugsnag
       # Stacktrace lines that matches regex will be marked as "out of project"
       # will only appear in the full trace.
       self.vendor_path = DEFAULT_VENDOR_PATH
+      @vendor_paths = []
 
       # Set up logging
       self.logger = Logger.new(STDOUT)
@@ -459,26 +491,44 @@ module Bugsnag
       request_data[:breadcrumbs] ||= Bugsnag::Utility::CircularBuffer.new(@max_breadcrumbs)
     end
 
+    # The URL error notifications will be delivered to
+    # @!attribute notify_endpoint
+    # @return [String]
+    # @deprecated Use {#endpoints} instead
+    def notify_endpoint
+      @endpoints.notify
+    end
+
+    alias :endpoint :notify_endpoint
+
     # Sets the notification endpoint
     #
-    # @deprecated Use {#set_endpoints} instead
+    # @deprecated Use {#endpoints} instead
     #
     # @param new_notify_endpoint [String] The URL to deliver error notifications to
     # @return [void]
     def endpoint=(new_notify_endpoint)
-      warn("The 'endpoint' configuration option is deprecated. The 'set_endpoints' method should be used instead")
+      warn("The 'endpoint' configuration option is deprecated. Set both endpoints with the 'endpoints=' method instead")
       set_endpoints(new_notify_endpoint, session_endpoint) # Pass the existing session_endpoint through so it doesn't get overwritten
     end
 
+    # The URL session notifications will be delivered to
+    # @!attribute session_endpoint
+    # @return [String]
+    # @deprecated Use {#endpoints} instead
+    def session_endpoint
+      @endpoints.sessions
+    end
+
     ##
     # Sets the sessions endpoint
     #
-    # @deprecated Use {#set_endpoints} instead
+    # @deprecated Use {#endpoints} instead
     #
     # @param new_session_endpoint [String] The URL to deliver session notifications to
     # @return [void]
     def session_endpoint=(new_session_endpoint)
-      warn("The 'session_endpoint' configuration option is deprecated. The 'set_endpoints' method should be used instead")
+      warn("The 'session_endpoint' configuration option is deprecated. Set both endpoints with the 'endpoints=' method instead")
       set_endpoints(notify_endpoint, new_session_endpoint) # Pass the existing notify_endpoint through so it doesn't get overwritten
     end
 
@@ -488,9 +538,26 @@ module Bugsnag
     # @param new_notify_endpoint [String] The URL to deliver error notifications to
     # @param new_session_endpoint [String] The URL to deliver session notifications to
     # @return [void]
+    # @deprecated Use {#endpoints} instead
     def set_endpoints(new_notify_endpoint, new_session_endpoint)
-      @notify_endpoint = new_notify_endpoint
-      @session_endpoint = new_session_endpoint
+      self.endpoints = EndpointConfiguration.new(new_notify_endpoint, new_session_endpoint)
+    end
+
+    def endpoints=(endpoint_configuration)
+      result = EndpointValidator.validate(endpoint_configuration)
+
+      if result.valid?
+        @enable_events = true
+        @enable_sessions = true
+      else
+        warn(result.reason)
+
+        @enable_events = result.keep_events_enabled_for_backwards_compatibility?
+        @enable_sessions = false
+      end
+
+      # use the given endpoints even if they are invalid
+      @endpoints = endpoint_configuration
     end
 
     ##
@@ -556,6 +623,47 @@ module Bugsnag
       @on_breadcrumb_callbacks.remove(callback)
     end
 
+    ##
+    # Add values to metadata
+    #
+    # @overload add_metadata(section, data)
+    #   Merges data into the given section of metadata
+    #   @param section [String, Symbol]
+    #   @param data [Hash]
+    #
+    # @overload add_metadata(section, key, value)
+    #   Sets key to value in the given section of metadata. If the value is nil
+    #   the key will be deleted
+    #   @param section [String, Symbol]
+    #   @param key [String, Symbol]
+    #   @param value
+    #
+    # @return [void]
+    def add_metadata(section, key_or_data, *args)
+      @mutex.synchronize do
+        @metadata_delegate.add_metadata(@metadata, section, key_or_data, *args)
+      end
+    end
+
+    ##
+    # Clear values from metadata
+    #
+    # @overload clear_metadata(section)
+    #   Clears the given section of metadata
+    #   @param section [String, Symbol]
+    #
+    # @overload clear_metadata(section, key)
+    #   Clears the key in the given section of metadata
+    #   @param section [String, Symbol]
+    #   @param key [String, Symbol]
+    #
+    # @return [void]
+    def clear_metadata(section, *args)
+      @mutex.synchronize do
+        @metadata_delegate.clear_metadata(@metadata, section, *args)
+      end
+    end
+
     ##
     # Has the context been explicitly set?
     #

data/lib/bugsnag/endpoint_configuration.rb

@@ -0,0 +1,11 @@
+module Bugsnag
+  class EndpointConfiguration
+    attr_reader :notify
+    attr_reader :sessions
+
+    def initialize(notify, sessions)
+      @notify = notify
+      @sessions = sessions
+    end
+  end
+end

data/lib/bugsnag/endpoint_validator.rb

@@ -0,0 +1,80 @@
+module Bugsnag
+  # @api private
+  class EndpointValidator
+    def self.validate(endpoints)
+      # ensure we have an EndpointConfiguration object
+      return Result.missing_urls unless endpoints.is_a?(EndpointConfiguration)
+
+      # check for missing URLs
+      return Result.missing_urls if endpoints.notify.nil? && endpoints.sessions.nil?
+      return Result.missing_notify if endpoints.notify.nil?
+      return Result.missing_session if endpoints.sessions.nil?
+
+      # check for empty URLs
+      return Result.invalid_urls if endpoints.notify.empty? && endpoints.sessions.empty?
+      return Result.invalid_notify if endpoints.notify.empty?
+      return Result.invalid_session if endpoints.sessions.empty?
+
+      Result.valid
+    end
+
+    # @api private
+    class Result
+      # rubocop:disable Layout/LineLength
+      MISSING_URLS = "Invalid configuration. endpoints must be set with both a notify and session URL. Bugsnag will not send any requests.".freeze
+      MISSING_NOTIFY_URL = "Invalid configuration. endpoints.sessions cannot be set without also setting endpoints.notify. Bugsnag will not send any requests.".freeze
+      MISSING_SESSION_URL = "Invalid configuration. endpoints.notify cannot be set without also setting endpoints.sessions. Bugsnag will not send any sessions.".freeze
+
+      INVALID_URLS = "Invalid configuration. endpoints should be valid URLs, got empty strings. Bugsnag will not send any requests.".freeze
+      INVALID_NOTIFY_URL = "Invalid configuration. endpoints.notify should be a valid URL, got empty string. Bugsnag will not send any requests.".freeze
+      INVALID_SESSION_URL = "Invalid configuration. endpoints.sessions should be a valid URL, got empty string. Bugsnag will not send any sessions.".freeze
+      # rubocop:enable Layout/LineLength
+
+      attr_reader :reason
+
+      def initialize(valid, keep_events_enabled_for_backwards_compatibility = true, reason = nil)
+        @valid = valid
+        @keep_events_enabled_for_backwards_compatibility = keep_events_enabled_for_backwards_compatibility
+        @reason = reason
+      end
+
+      def valid?
+        @valid
+      end
+
+      def keep_events_enabled_for_backwards_compatibility?
+        @keep_events_enabled_for_backwards_compatibility
+      end
+
+      # factory functions
+
+      def self.valid
+        new(true)
+      end
+
+      def self.missing_urls
+        new(false, false, MISSING_URLS)
+      end
+
+      def self.missing_notify
+        new(false, false, MISSING_NOTIFY_URL)
+      end
+
+      def self.missing_session
+        new(false, true, MISSING_SESSION_URL)
+      end
+
+      def self.invalid_urls
+        new(false, false, INVALID_URLS)
+      end
+
+      def self.invalid_notify
+        new(false, false, INVALID_NOTIFY_URL)
+      end
+
+      def self.invalid_session
+        new(false, true, INVALID_SESSION_URL)
+      end
+    end
+  end
+end

data/lib/bugsnag/integrations/railtie.rb

@@ -47,6 +47,29 @@ module Bugsnag
       end
     end
 
+    ##
+    # Do we need to rescue (& notify) in Active Record callbacks?
+    #
+    # On Rails versions < 4.2, Rails did not raise errors in AR callbacks
+    # On Rails version 4.2, a config option was added to control this
+    # On Rails version 5.0, the config option was removed and errors in callbacks
+    # always bubble up
+    #
+    # @api private
+    def self.rescue_in_active_record_callbacks?
+      # Rails 5+ will re-raise errors in callbacks, so we don't need to rescue them
+      return false if ::Rails::VERSION::MAJOR > 4
+
+      # before 4.2, errors were always swallowed, so we need to rescue them
+      return true if ::Rails::VERSION::MAJOR < 4
+
+      # a config option was added in 4.2 to control this, but won't exist in 4.0 & 4.1
+      return true unless ActiveRecord::Base.respond_to?(:raise_in_transactional_callbacks)
+
+      # if the config option is false, we need to rescue and notify
+      ActiveRecord::Base.raise_in_transactional_callbacks == false
+    end
+
     rake_tasks do
       require "bugsnag/integrations/rake"
       load "bugsnag/tasks/bugsnag.rake"
@@ -70,8 +93,10 @@ module Bugsnag
       end
 
       ActiveSupport.on_load(:active_record) do
-        require "bugsnag/integrations/rails/active_record_rescue"
-        include Bugsnag::Rails::ActiveRecordRescue
+        if Bugsnag::Railtie.rescue_in_active_record_callbacks?
+          require "bugsnag/integrations/rails/active_record_rescue"
+          include Bugsnag::Rails::ActiveRecordRescue
+        end
       end
 
       ActiveSupport.on_load(:active_job) do

data/lib/bugsnag/integrations/resque.rb

@@ -45,13 +45,17 @@ module Bugsnag
         }
 
         metadata = payload
-        class_name = payload['class']
+        class_name = metadata['class']
 
         # when using Active Job the payload "class" will always be the Resque
-        # "JobWrapper", not the actual job class so we need to fix this here
-        if metadata['args'] && metadata['args'][0] && metadata['args'][0]['job_class']
-          class_name = metadata['args'][0]['job_class']
-          metadata['wrapped'] ||= class_name
+        # "JobWrapper", so we need to unwrap the actual class name
+        if class_name == "ActiveJob::QueueAdapters::ResqueAdapter::JobWrapper"
+          unwrapped_class_name = metadata['args'][0]['job_class'] rescue nil
+
+          if unwrapped_class_name
+            class_name = unwrapped_class_name
+            metadata['wrapped'] ||= unwrapped_class_name
+          end
         end
 
         context = "#{class_name}@#{queue}"

data/lib/bugsnag/middleware/rack_request.rb

@@ -1,8 +1,11 @@
+require "json"
+
 module Bugsnag::Middleware
   ##
   # Extracts and attaches rack data to an error report
   class RackRequest
     SPOOF = "[SPOOF]".freeze
+    COOKIE_HEADER = "Cookie".freeze
 
     def initialize(bugsnag)
       @bugsnag = bugsnag
@@ -42,22 +45,6 @@ module Bugsnag::Middleware
           Bugsnag.configuration.warn "RackRequest - Rescued error while cleaning request.referer: #{stde}"
         end
 
-        headers = {}
-
-        env.each_pair do |key, value|
-          if key.to_s.start_with?("HTTP_")
-            header_key = key[5..-1]
-          elsif ["CONTENT_TYPE", "CONTENT_LENGTH"].include?(key)
-            header_key = key
-          else
-            next
-          end
-
-          headers[header_key.split("_").map {|s| s.capitalize}.join("-")] = value
-        end
-
-        headers["Referer"] = referer if headers["Referer"]
-
         # Add a request tab
         report.add_tab(:request, {
           :url => url,
@@ -65,9 +52,17 @@ module Bugsnag::Middleware
           :params => params.to_hash,
           :referer => referer,
           :clientIp => client_ip,
-          :headers => headers
+          :headers => format_headers(env, referer)
         })
 
+        # add the HTTP version if present
+        if env["SERVER_PROTOCOL"]
+          report.add_metadata(:request, :httpVersion, env["SERVER_PROTOCOL"])
+        end
+
+        add_request_body(report, request, env)
+        add_cookies(report, request)
+
         # Add an environment tab
         if report.configuration.send_environment
           report.add_tab(:environment, env)
@@ -87,5 +82,75 @@ module Bugsnag::Middleware
 
       @bugsnag.call(report)
     end
+
+    private
+
+    def format_headers(env, referer)
+      headers = {}
+
+      env.each_pair do |key, value|
+        if key.to_s.start_with?("HTTP_")
+          header_key = key[5..-1]
+        elsif ["CONTENT_TYPE", "CONTENT_LENGTH"].include?(key)
+          header_key = key
+        else
+          next
+        end
+
+        headers[header_key.split("_").map {|s| s.capitalize}.join("-")] = value
+      end
+
+      headers["Referer"] = referer if headers["Referer"]
+
+      headers
+    end
+
+    def add_request_body(report, request, env)
+      body = parsed_request_body(request, env)
+
+      # this request may not have a body
+      return unless body.is_a?(Hash) && !body.empty?
+
+      report.add_metadata(:request, :body, body)
+    end
+
+    def parsed_request_body(request, env)
+      return request.POST rescue nil if request.form_data?
+
+      content_type = env["CONTENT_TYPE"]
+
+      return nil if content_type.nil?
+
+      if content_type.include?('/json') || content_type.include?('+json')
+        begin
+          body = request.body
+
+          return JSON.parse(body.read)
+        rescue StandardError
+          return nil
+        ensure
+          # the body must be rewound so other things can read it after we do
+          body.rewind
+        end
+      end
+
+      nil
+    end
+
+    def add_cookies(report, request)
+      return unless record_cookies?
+
+      cookies = request.cookies rescue nil
+
+      return unless cookies.is_a?(Hash) && !cookies.empty?
+
+      report.add_metadata(:request, :cookies, cookies)
+    end
+
+    def record_cookies?
+      # only record cookies in the request if none of the filters match "Cookie"
+      # the "Cookie" header will be filtered as normal
+      !Bugsnag.cleaner.filters_match?(COOKIE_HEADER)
+    end
   end
 end

data/lib/bugsnag/middleware/session_data.rb

@@ -8,12 +8,14 @@ module Bugsnag::Middleware
 
     def call(report)
       session = Bugsnag::SessionTracker.get_current_session
-      unless session.nil?
+
+      if session && !session[:paused?]
         if report.unhandled
           session[:events][:unhandled] += 1
         else
           session[:events][:handled] += 1
         end
+
         report.session = session
       end
 

data/lib/bugsnag/report.rb

@@ -119,6 +119,7 @@ module Bugsnag
 
       @should_ignore = false
       @unhandled = auto_notify
+      @initial_unhandled = @unhandled
 
       self.configuration = passed_configuration
 
@@ -135,7 +136,7 @@ module Bugsnag
       self.delivery_method = configuration.delivery_method
       self.hostname = configuration.hostname
       self.runtime_versions = configuration.runtime_versions.dup
-      self.meta_data = {}
+      self.meta_data = Utility::Duplicator.duplicate(configuration.metadata)
       self.release_stage = configuration.release_stage
       self.severity = auto_notify ? "error" : "warning"
       self.severity_reason = auto_notify ? {:type => UNHANDLED_EXCEPTION} : {:type => HANDLED_EXCEPTION}
@@ -374,8 +375,43 @@ module Bugsnag
       @user = new_user
     end
 
+    def unhandled=(new_unhandled)
+      # fix the handled/unhandled counts in the current session
+      update_handled_counts(new_unhandled, @unhandled)
+
+      @unhandled = new_unhandled
+    end
+
+    ##
+    # Returns true if the unhandled flag has been changed from its initial value
+    #
+    # @api private
+    # @return [Boolean]
+    def unhandled_overridden?
+      @unhandled != @initial_unhandled
+    end
+
     private
 
+    def update_handled_counts(is_unhandled, was_unhandled)
+      # do nothing if there is no session to update
+      return if @session.nil?
+
+      # increment the counts for the current unhandled value
+      if is_unhandled
+        @session[:events][:unhandled] += 1
+      else
+        @session[:events][:handled] += 1
+      end
+
+      # decrement the counts for the previous unhandled value
+      if was_unhandled
+        @session[:events][:unhandled] -= 1
+      else
+        @session[:events][:handled] -= 1
+      end
+    end
+
     def generate_exception_list
       raw_exceptions.map do |exception|
         {

data/lib/bugsnag/session_tracker.rb

@@ -34,17 +34,20 @@ module Bugsnag
     # Starts a new session, storing it on the current thread.
     #
     # This allows Bugsnag to track error rates for a release.
+    #
+    # @return [void]
     def start_session
       return unless Bugsnag.configuration.enable_sessions && Bugsnag.configuration.should_notify_release_stage?
 
       start_delivery_thread
       start_time = Time.now().utc().strftime('%Y-%m-%dT%H:%M:00')
       new_session = {
-        :id => SecureRandom.uuid,
-        :startedAt => start_time,
-        :events => {
-          :handled => 0,
-          :unhandled => 0
+        id: SecureRandom.uuid,
+        startedAt: start_time,
+        paused?: false,
+        events: {
+          handled: 0,
+          unhandled: 0
         }
       }
       SessionTracker.set_current_session(new_session)
@@ -53,6 +56,47 @@ module Bugsnag
 
     alias_method :create_session, :start_session
 
+    ##
+    # Stop any events being attributed to the current session until it is
+    # resumed or a new session is started
+    #
+    # @see resume_session
+    #
+    # @return [void]
+    def pause_session
+      current_session = SessionTracker.get_current_session
+
+      return unless current_session
+
+      current_session[:paused?] = true
+    end
+
+    ##
+    # Resume the current session if it was previously paused. If there is no
+    # current session, a new session will be started
+    #
+    # @see pause_session
+    #
+    # @return [Boolean] true if a paused session was resumed
+    def resume_session
+      current_session = SessionTracker.get_current_session
+
+      if current_session
+        # if the session is paused then resume it, otherwise we don't need to
+        # do anything
+        if current_session[:paused?]
+          current_session[:paused?] = false
+
+          return true
+        end
+      else
+        # if there's no current session, start a new one
+        start_session
+      end
+
+      false
+    end
+
     ##
     # Delivers the current session_counts lists to the session endpoint.
     def send_sessions

data/lib/bugsnag/stacktrace.rb

@@ -43,7 +43,7 @@ module Bugsnag
         if defined?(configuration.project_root) && configuration.project_root.to_s != ''
           trace_hash[:inProject] = true if file.start_with?(configuration.project_root.to_s)
           file.sub!(/#{configuration.project_root}\//, "")
-          trace_hash.delete(:inProject) if file.match(configuration.vendor_path)
+          trace_hash.delete(:inProject) if vendor_path?(configuration, file)
         end
 
         # Strip common gem path prefixes
@@ -67,5 +67,14 @@ module Bugsnag
 
       processed_backtrace
     end
+
+    # @api private
+    def self.vendor_path?(configuration, file_path)
+      return true if configuration.vendor_path && file_path.match(configuration.vendor_path)
+
+      configuration.vendor_paths.any? do |vendor_path|
+        file_path.start_with?("#{vendor_path.sub(/\/$/, '')}/")
+      end
+    end
   end
 end

data/lib/bugsnag/utility/duplicator.rb

@@ -0,0 +1,124 @@
+module Bugsnag::Utility
+  # @api private
+  class Duplicator
+    class << self
+      ##
+      # Duplicate (deep clone) the given object
+      #
+      # @param object [Object]
+      # @param seen_objects [Hash<String, Object>]
+      # @return [Object]
+      def duplicate(object, seen_objects = {})
+        case object
+        # return immutable & non-duplicatable objects as-is
+        when Symbol, Numeric, Method, TrueClass, FalseClass, NilClass
+          object
+        when Array
+          duplicate_array(object, seen_objects)
+        when Hash
+          duplicate_hash(object, seen_objects)
+        when Range
+          duplicate_range(object, seen_objects)
+        when Struct
+          duplicate_struct(object, seen_objects)
+        else
+          duplicate_generic_object(object, seen_objects)
+        end
+      rescue StandardError
+        object
+      end
+
+      private
+
+      def duplicate_array(array, seen_objects)
+        id = array.object_id
+
+        return seen_objects[id] if seen_objects.key?(id)
+
+        copy = array.dup
+        seen_objects[id] = copy
+
+        copy.map! do |value|
+          duplicate(value, seen_objects)
+        end
+
+        copy
+      end
+
+      def duplicate_hash(hash, seen_objects)
+        id = hash.object_id
+
+        return seen_objects[id] if seen_objects.key?(id)
+
+        copy = {}
+        seen_objects[id] = copy
+
+        hash.each do |key, value|
+          copy[duplicate(key, seen_objects)] = duplicate(value, seen_objects)
+        end
+
+        copy
+      end
+
+      ##
+      # Ranges are immutable but the values they contain may not be
+      #
+      # For example, a range of "a".."z" can be mutated: range.first.upcase!
+      def duplicate_range(range, seen_objects)
+        id = range.object_id
+
+        return seen_objects[id] if seen_objects.key?(id)
+
+        begin
+          copy = range.class.new(
+            duplicate(range.first, seen_objects),
+            duplicate(range.last, seen_objects),
+            range.exclude_end?
+          )
+        rescue StandardError
+          copy = range.dup
+        end
+
+        seen_objects[id] = copy
+      end
+
+      def duplicate_struct(struct, seen_objects)
+        id = struct.object_id
+
+        return seen_objects[id] if seen_objects.key?(id)
+
+        copy = struct.dup
+        seen_objects[id] = copy
+
+        struct.each_pair do |attribute, value|
+          begin
+            copy.send("#{attribute}=", duplicate(value, seen_objects))
+          rescue StandardError # rubocop:todo Lint/SuppressedException
+          end
+        end
+
+        copy
+      end
+
+      def duplicate_generic_object(object, seen_objects)
+        id = object.object_id
+
+        return seen_objects[id] if seen_objects.key?(id)
+
+        copy = object.dup
+        seen_objects[id] = copy
+
+        begin
+          copy.instance_variables.each do |variable|
+            value = copy.instance_variable_get(variable)
+
+            copy.instance_variable_set(variable, duplicate(value, seen_objects))
+          end
+        rescue StandardError # rubocop:todo Lint/SuppressedException
+        end
+
+        copy
+      end
+    end
+  end
+end

data/lib/bugsnag.rb

@@ -34,6 +34,7 @@ require "bugsnag/breadcrumbs/validator"
 require "bugsnag/breadcrumbs/breadcrumb"
 require "bugsnag/breadcrumbs/breadcrumbs"
 
+require "bugsnag/utility/duplicator"
 require "bugsnag/utility/metadata_delegate"
 
 # rubocop:todo Metrics/ModuleLength
@@ -136,6 +137,11 @@ module Bugsnag
           report.severity_reason = initial_reason
         end
 
+        if report.unhandled_overridden?
+          # let the dashboard know that the unhandled flag was overridden
+          report.severity_reason[:unhandledOverridden] = true
+        end
+
         deliver_notification(report)
       end
     end
@@ -191,13 +197,36 @@ module Bugsnag
     end
 
     ##
-    # Starts a session.
+    # Starts a new session, which allows Bugsnag to track error rates across
+    # releases
     #
-    # Allows Bugsnag to track error rates across releases.
+    # @return [void]
     def start_session
       session_tracker.start_session
     end
 
+    ##
+    # Stop any events being attributed to the current session until it is
+    # resumed or a new session is started
+    #
+    # @see resume_session
+    #
+    # @return [void]
+    def pause_session
+      session_tracker.pause_session
+    end
+
+    ##
+    # Resume the current session if it was previously paused. If there is no
+    # current session, a new session will be started
+    #
+    # @see pause_session
+    #
+    # @return [Boolean] true if a paused session was resumed
+    def resume_session
+      session_tracker.resume_session
+    end
+
     ##
     # Allow access to "before notify" callbacks as an array.
     #
@@ -352,9 +381,56 @@ module Bugsnag
       end
     end
 
+    ##
+    # Global metadata added to every event
+    #
+    # @return [Hash]
+    def metadata
+      configuration.metadata
+    end
+
+    ##
+    # Add values to metadata
+    #
+    # @overload add_metadata(section, data)
+    #   Merges data into the given section of metadata
+    #   @param section [String, Symbol]
+    #   @param data [Hash]
+    #
+    # @overload add_metadata(section, key, value)
+    #   Sets key to value in the given section of metadata. If the value is nil
+    #   the key will be deleted
+    #   @param section [String, Symbol]
+    #   @param key [String, Symbol]
+    #   @param value
+    #
+    # @return [void]
+    def add_metadata(section, key_or_data, *args)
+      configuration.add_metadata(section, key_or_data, *args)
+    end
+
+    ##
+    # Clear values from metadata
+    #
+    # @overload clear_metadata(section)
+    #   Clears the given section of metadata
+    #   @param section [String, Symbol]
+    #
+    # @overload clear_metadata(section, key)
+    #   Clears the key in the given section of metadata
+    #   @param section [String, Symbol]
+    #   @param key [String, Symbol]
+    #
+    # @return [void]
+    def clear_metadata(section, *args)
+      configuration.clear_metadata(section, *args)
+    end
+
     private
 
     def should_deliver_notification?(exception, auto_notify)
+      return false unless configuration.enable_events
+
       reason = abort_reason(exception, auto_notify)
       configuration.debug(reason) unless reason.nil?
       reason.nil?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag
 version: !ruby/object:Gem::Version
-  version: 6.23.0
+  version: 6.24.2
 platform: ruby
 authors:
 - James Smith
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-21 00:00:00.000000000 Z
+date: 2022-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -51,6 +51,8 @@ files:
 - lib/bugsnag/delivery.rb
 - lib/bugsnag/delivery/synchronous.rb
 - lib/bugsnag/delivery/thread_queue.rb
+- lib/bugsnag/endpoint_configuration.rb
+- lib/bugsnag/endpoint_validator.rb
 - lib/bugsnag/error.rb
 - lib/bugsnag/event.rb
 - lib/bugsnag/helpers.rb
@@ -94,6 +96,7 @@ files:
 - lib/bugsnag/tasks.rb
 - lib/bugsnag/tasks/bugsnag.rake
 - lib/bugsnag/utility/circular_buffer.rb
+- lib/bugsnag/utility/duplicator.rb
 - lib/bugsnag/utility/metadata_delegate.rb
 - lib/bugsnag/version.rb
 - lib/generators/bugsnag/bugsnag_generator.rb
@@ -101,7 +104,7 @@ homepage: https://github.com/bugsnag/bugsnag-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -116,8 +119,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.11
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Ruby notifier for bugsnag.com
 test_files: []