bugsnag 6.21.0 → 6.25.2

data/lib/bugsnag/utility/feature_flag_delegate.rb

@@ -0,0 +1,89 @@
+module Bugsnag::Utility
+  # @api private
+  class FeatureFlagDelegate
+    def initialize
+      # feature flags are stored internally in a hash of "name" => <FeatureFlag>
+      # we don't use a Set because new feature flags should overwrite old ones
+      # that share a name, but FeatureFlag equality also uses the variant
+      @storage = {}
+    end
+
+    def initialize_dup(original)
+      super
+
+      # copy the internal storage when 'dup' is called
+      @storage = @storage.dup
+    end
+
+    # Add a feature flag with the given name & variant
+    #
+    # @param name [String]
+    # @param variant [String, nil]
+    # @return [void]
+    def add(name, variant)
+      flag = Bugsnag::FeatureFlag.new(name, variant)
+
+      return unless flag.valid?
+
+      @storage[flag.name] = flag
+    end
+
+    # Merge the given array of FeatureFlag instances into the stored feature
+    # flags
+    #
+    # New flags will be appended to the array. Flags with the same name will be
+    # overwritten, but their position in the array will not change
+    #
+    # @param feature_flags [Array<Bugsnag::FeatureFlag>]
+    # @return [void]
+    def merge(feature_flags)
+      feature_flags.each do |flag|
+        next unless flag.is_a?(Bugsnag::FeatureFlag)
+        next unless flag.valid?
+
+        @storage[flag.name] = flag
+      end
+    end
+
+    # Remove the stored flag with the given name
+    #
+    # @param name [String]
+    # @return [void]
+    def remove(name)
+      @storage.delete(name)
+    end
+
+    # Remove all the stored flags
+    #
+    # @return [void]
+    def clear
+      @storage.clear
+    end
+
+    # Get an array of FeatureFlag instances
+    #
+    # @example
+    #   [
+    #     <#Bugsnag::FeatureFlag>,
+    #     <#Bugsnag::FeatureFlag>,
+    #   ]
+    #
+    # @return [Array<Bugsnag::FeatureFlag>]
+    def to_a
+      @storage.values
+    end
+
+    # Get the feature flags in their JSON representation
+    #
+    # @example
+    #   [
+    #     { "featureFlag" => "name", "variant" => "variant" },
+    #     { "featureFlag" => "another name" },
+    #   ]
+    #
+    # @return [Array<Hash{String => String}>]
+    def as_json
+      to_a.map(&:to_h)
+    end
+  end
+end

data/lib/bugsnag/utility/metadata_delegate.rb

@@ -0,0 +1,102 @@
+module Bugsnag::Utility
+  # @api private
+  class MetadataDelegate
+    # nil is a valid metadata value, so we need a sentinel object so we can tell
+    # if the value parameter has been provided
+    NOT_PROVIDED = Object.new
+
+    ##
+    # Add values to metadata
+    #
+    # @overload add_metadata(metadata, section, data)
+    #   Merges data into the given section of metadata
+    #   @param metadata [Hash] The metadata hash to operate on
+    #   @param section [String, Symbol]
+    #   @param data [Hash]
+    #
+    # @overload add_metadata(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 metadata [Hash] The metadata hash to operate on
+    #   @param section [String, Symbol]
+    #   @param key [String, Symbol]
+    #   @param value
+    #
+    # @return [void]
+    def add_metadata(metadata, section, key_or_data, value = NOT_PROVIDED)
+      case value
+      when NOT_PROVIDED
+        merge_metadata(metadata, section, key_or_data)
+      when nil
+        clear_metadata(metadata, section, key_or_data)
+      else
+        overwrite_metadata(metadata, section, key_or_data, value)
+      end
+    end
+
+    ##
+    # Clear values from metadata
+    #
+    # @overload clear_metadata(metadata, section)
+    #   Clears the given section of metadata
+    #   @param metadata [Hash] The metadata hash to operate on
+    #   @param section [String, Symbol]
+    #
+    # @overload clear_metadata(metadata, section, key)
+    #   Clears the key in the given section of metadata
+    #   @param metadata [Hash] The metadata hash to operate on
+    #   @param section [String, Symbol]
+    #   @param key [String, Symbol]
+    #
+    # @return [void]
+    def clear_metadata(metadata, section, key = nil)
+      if key.nil?
+        metadata.delete(section)
+      elsif metadata[section]
+        metadata[section].delete(key)
+      end
+    end
+
+    private
+
+    ##
+    # Merge new metadata into the existing metadata
+    #
+    # Any keys with a 'nil' value in the new metadata will be deleted from the
+    # existing metadata
+    #
+    # @param existing_metadata [Hash]
+    # @param section [String, Symbol]
+    # @param new_metadata [Hash]
+    # @return [void]
+    def merge_metadata(existing_metadata, section, new_metadata)
+      return unless new_metadata.is_a?(Hash)
+
+      existing_metadata[section] ||= {}
+      data = existing_metadata[section]
+
+      new_metadata.each do |key, value|
+        if value.nil?
+          data.delete(key)
+        else
+          data[key] = value
+        end
+      end
+    end
+
+    ##
+    # Overwrite the value in metadata's section & key
+    #
+    # @param metadata [Hash]
+    # @param section [String, Symbol]
+    # @param key [String, Symbol]
+    # @param value
+    # @return [void]
+    def overwrite_metadata(metadata, section, key, value)
+      return unless key.is_a?(String) || key.is_a?(Symbol)
+
+      metadata[section] ||= {}
+      metadata[section][key] = value
+    end
+  end
+end

data/lib/bugsnag.rb

@@ -2,9 +2,11 @@ require "rubygems"
 require "thread"
 
 require "bugsnag/version"
+require "bugsnag/utility/feature_data_store"
 require "bugsnag/configuration"
 require "bugsnag/meta_data"
 require "bugsnag/report"
+require "bugsnag/event"
 require "bugsnag/cleaner"
 require "bugsnag/helpers"
 require "bugsnag/session_tracker"
@@ -13,6 +15,8 @@ require "bugsnag/delivery"
 require "bugsnag/delivery/synchronous"
 require "bugsnag/delivery/thread_queue"
 
+require "bugsnag/feature_flag"
+
 # Rack is not bundled with the other integrations
 # as it doesn't auto-configure when loaded
 require "bugsnag/integrations/rack"
@@ -28,10 +32,15 @@ require "bugsnag/middleware/rake"
 require "bugsnag/middleware/classify_error"
 require "bugsnag/middleware/delayed_job"
 
+require "bugsnag/breadcrumb_type"
 require "bugsnag/breadcrumbs/validator"
 require "bugsnag/breadcrumbs/breadcrumb"
 require "bugsnag/breadcrumbs/breadcrumbs"
 
+require "bugsnag/utility/duplicator"
+require "bugsnag/utility/metadata_delegate"
+require "bugsnag/utility/feature_flag_delegate"
+
 # rubocop:todo Metrics/ModuleLength
 module Bugsnag
   LOCK = Mutex.new
@@ -40,6 +49,8 @@ module Bugsnag
   NIL_EXCEPTION_DESCRIPTION = "'nil' was notified as an exception"
 
   class << self
+    include Utility::FeatureDataStore
+
     ##
     # Configure the Bugsnag notifier application-wide settings.
     #
@@ -67,7 +78,7 @@ module Bugsnag
     #
     # Optionally accepts a block to append metadata to the yielded report.
     def notify(exception, auto_notify=false, &block)
-      unless auto_notify.is_a? TrueClass or auto_notify.is_a? FalseClass
+      unless false.equal? auto_notify or true.equal? auto_notify
         configuration.warn("Adding metadata/severity using a hash is no longer supported, please use block syntax instead")
         auto_notify = false
       end
@@ -132,6 +143,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
@@ -187,13 +203,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.
     #
@@ -237,7 +276,7 @@ module Bugsnag
     #
     # @param name [String] the main breadcrumb name/message
     # @param meta_data [Hash] String, Numeric, or Boolean meta data to attach
-    # @param type [String] the breadcrumb type, from Bugsnag::Breadcrumbs::VALID_BREADCRUMB_TYPES
+    # @param type [String] the breadcrumb type, see {Bugsnag::BreadcrumbType}
     # @param auto [Symbol] set to :auto if the breadcrumb is automatically created
     # @return [void]
     def leave_breadcrumb(name, meta_data={}, type=Bugsnag::Breadcrumbs::MANUAL_BREADCRUMB_TYPE, auto=:manual)
@@ -250,7 +289,7 @@ module Bugsnag
       # Skip if it's already invalid
       return if breadcrumb.ignore?
 
-      # Run callbacks
+      # Run before_breadcrumb_callbacks
       configuration.before_breadcrumb_callbacks.each do |c|
         c.arity > 0 ? c.call(breadcrumb) : c.call
         break if breadcrumb.ignore?
@@ -259,6 +298,10 @@ module Bugsnag
       # Return early if ignored
       return if breadcrumb.ignore?
 
+      # Run on_breadcrumb callbacks
+      configuration.on_breadcrumb_callbacks.call(breadcrumb)
+      return if breadcrumb.ignore?
+
       # Validate again in case of callback alteration
       validator.validate(breadcrumb)
 
@@ -293,6 +336,44 @@ module Bugsnag
       configuration.remove_on_error(callback)
     end
 
+    ##
+    # Add the given callback to the list of on_breadcrumb callbacks
+    #
+    # The on_breadcrumb callbacks will be called when a breadcrumb is left and
+    # are passed the {Breadcrumbs::Breadcrumb Breadcrumb} object
+    #
+    # Returning false from an on_breadcrumb callback will cause the breadcrumb
+    # to be ignored and will prevent any remaining callbacks from being called
+    #
+    # @param callback [Proc, Method, #call]
+    # @return [void]
+    def add_on_breadcrumb(callback)
+      configuration.add_on_breadcrumb(callback)
+    end
+
+    ##
+    # Remove the given callback from the list of on_breadcrumb callbacks
+    #
+    # Note that this must be the same instance that was passed to
+    # {add_on_breadcrumb}, otherwise it will not be removed
+    #
+    # @param callback [Proc, Method, #call]
+    # @return [void]
+    def remove_on_breadcrumb(callback)
+      configuration.remove_on_breadcrumb(callback)
+    end
+
+    ##
+    # Returns the current list of breadcrumbs
+    #
+    # This is a per-thread circular buffer, containing at most 'max_breadcrumbs'
+    # breadcrumbs
+    #
+    # @return [Bugsnag::Utility::CircularBuffer]
+    def breadcrumbs
+      configuration.breadcrumbs
+    end
+
     ##
     # Returns the client's Cleaner object, or creates one if not yet created.
     #
@@ -306,9 +387,66 @@ 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
+
+    # Expose the feature flag delegate internally for use when creating new Events
+    #
+    # The Bugsnag module's feature_flag_delegate is request-specific
+    #
+    # @return [Bugsnag::Utility::FeatureFlagDelegate]
+    # @api private
+    def feature_flag_delegate
+      configuration.request_data[:feature_flag_delegate] ||= Utility::FeatureFlagDelegate.new
+    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.21.0
+  version: 6.25.2
 platform: ruby
 authors:
 - James Smith
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-23 00:00:00.000000000 Z
+date: 2023-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -40,8 +40,10 @@ files:
 - VERSION
 - bugsnag.gemspec
 - lib/bugsnag.rb
+- lib/bugsnag/breadcrumb_type.rb
 - lib/bugsnag/breadcrumbs/breadcrumb.rb
 - lib/bugsnag/breadcrumbs/breadcrumbs.rb
+- lib/bugsnag/breadcrumbs/on_breadcrumb_callback_list.rb
 - lib/bugsnag/breadcrumbs/validator.rb
 - lib/bugsnag/cleaner.rb
 - lib/bugsnag/code_extractor.rb
@@ -49,12 +51,18 @@ 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/feature_flag.rb
 - lib/bugsnag/helpers.rb
 - lib/bugsnag/integrations/delayed_job.rb
 - lib/bugsnag/integrations/mailman.rb
 - lib/bugsnag/integrations/mongo.rb
 - lib/bugsnag/integrations/que.rb
 - lib/bugsnag/integrations/rack.rb
+- lib/bugsnag/integrations/rails/active_job.rb
 - lib/bugsnag/integrations/rails/active_record_rescue.rb
 - lib/bugsnag/integrations/rails/controller_methods.rb
 - lib/bugsnag/integrations/rails/rails_breadcrumbs.rb
@@ -64,6 +72,7 @@ files:
 - lib/bugsnag/integrations/shoryuken.rb
 - lib/bugsnag/integrations/sidekiq.rb
 - lib/bugsnag/meta_data.rb
+- lib/bugsnag/middleware/active_job.rb
 - lib/bugsnag/middleware/breadcrumbs.rb
 - lib/bugsnag/middleware/callbacks.rb
 - lib/bugsnag/middleware/classify_error.rb
@@ -88,13 +97,21 @@ files:
 - lib/bugsnag/tasks.rb
 - lib/bugsnag/tasks/bugsnag.rake
 - lib/bugsnag/utility/circular_buffer.rb
+- lib/bugsnag/utility/duplicator.rb
+- lib/bugsnag/utility/feature_data_store.rb
+- lib/bugsnag/utility/feature_flag_delegate.rb
+- lib/bugsnag/utility/metadata_delegate.rb
 - lib/bugsnag/version.rb
 - lib/generators/bugsnag/bugsnag_generator.rb
 homepage: https://github.com/bugsnag/bugsnag-ruby
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  changelog_uri: https://github.com/bugsnag/bugsnag-ruby/blob/HEAD/CHANGELOG.md
+  documentation_uri: https://docs.bugsnag.com/platforms/ruby/
+  source_code_uri: https://github.com/bugsnag/bugsnag-ruby/
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -109,8 +126,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.3.7
+signing_key:
 specification_version: 4
 summary: Ruby notifier for bugsnag.com
 test_files: []