bugsnag 6.24.2 → 6.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0c0062b72786fa763b8b17ff0f72647808c2c0372c08b098b70007acc52dec9
-  data.tar.gz: c467bdbbe899f9e6f2ec1bf47071c8f70228f7cac51f292e8b77a6c9724da368
+  metadata.gz: b368e5f42be9d382e6a4fc6900155646612e86378597604162f9ca3ac7a9f9bd
+  data.tar.gz: 380fb1702fd23efb10d3a0155e2c7909f3b599cc6e7863bd4e6b3f057b06c2db
 SHA512:
-  metadata.gz: c2cd2286a921e1cb2ad6e78e620c097a7a5937be53ebb75f020cc7eaba31505c904315083b545a1f9758ddb14c2e902c8e47e8845eef3a242fd8aec810860496
-  data.tar.gz: 15410f4d0280b5abb8f9804a6b66c6d05eed52c025e394ed0fbc642507d7ac64b2cb90db5a1dda0a946143d85dbab4d148dafab88697fa47bb79363d4ff6df3e
+  metadata.gz: df743de96ef2f1fcb04c3b38cbcf7c9ff293926d5ce7373b990a1512cfcf1707e90dee8e1cd04d34c37c34359138123f8b6da537cebd933d24f7b3e5afe3c5e0
+  data.tar.gz: 7aadfbaeec36c193d50d144cb4bcd2d09a8072156d1dd5c96bc5a8c7a2b262ca6ed7c24321216b1239e9ce3b22cd2a3cfef07f8f4fba58ed5004bbe6e11b8b5e

data/.yardopts

@@ -4,6 +4,7 @@
 --no-private
 --protected
 --title "bugsnag-ruby API Documentation"
+--embed-mixins
 lib/**/*.rb
 -
 README.md

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 Changelog
 =========
 
+## v6.26.0 (1 December 2022)
+
+### Enhancements
+
+* Add support for feature flags & experiments. For more information, please see https://docs.bugsnag.com/product/features-experiments
+  | [#758](https://github.com/bugsnag/bugsnag-ruby/pull/758)
+
 ## v6.24.2 (21 January 2022)
 
 ### Fixes

data/VERSION

@@ -1 +1 @@
-6.24.2
+6.25.0

data/bugsnag.gemspec

@@ -18,5 +18,13 @@ Gem::Specification.new do |s|
   ]
   s.require_paths = ["lib"]
   s.required_ruby_version = '>= 1.9.2'
-  s.add_runtime_dependency 'concurrent-ruby', '~> 1.0'
+
+  ruby_version = Gem::Version.new(RUBY_VERSION.dup)
+
+  if ruby_version < Gem::Version.new('2.2.0')
+    # concurrent-ruby 1.1.10 requires Ruby 2.2+
+    s.add_runtime_dependency 'concurrent-ruby', '~> 1.0', '< 1.1.10'
+  else
+    s.add_runtime_dependency 'concurrent-ruby', '~> 1.0'
+  end
 end

data/lib/bugsnag/feature_flag.rb

@@ -0,0 +1,74 @@
+module Bugsnag
+  class FeatureFlag
+    # Get the name of this feature flag
+    #
+    # @return [String]
+    attr_reader :name
+
+    # Get the variant of this feature flag
+    #
+    # @return [String, nil]
+    attr_reader :variant
+
+    # @param name [String] The name of this feature flags
+    # @param variant [String, nil] An optional variant for this flag
+    def initialize(name, variant = nil)
+      @name = name
+      @variant = coerce_variant(variant)
+    end
+
+    def ==(other)
+      self.class == other.class && @name == other.name && @variant == other.variant
+    end
+
+    def hash
+      [@name, @variant].hash
+    end
+
+    # Convert this flag to a hash
+    #
+    # @example With no variant
+    #   { "featureFlag" => "name" }
+    #
+    # @example With a variant
+    #   { "featureFlag" => "name", "variant" => "variant" }
+    #
+    # @return [Hash{String => String}]
+    def to_h
+      if @variant.nil?
+        { "featureFlag" => @name }
+      else
+        { "featureFlag" => @name, "variant" => @variant }
+      end
+    end
+
+    # Check if this flag is valid, i.e. has a name that's a String and a variant
+    # that's either nil or a String
+    #
+    # @return [Boolean]
+    def valid?
+      @name.is_a?(String) &&
+        !@name.empty? &&
+        (@variant.nil? || @variant.is_a?(String))
+    end
+
+    private
+
+    # Coerce this variant into a valid value (String or nil)
+    #
+    # If the variant is not already a string or nil, we use #to_s to coerce it.
+    # If #to_s raises, the variant will be set to nil
+    #
+    # @param variant [Object]
+    # @return [String, nil]
+    def coerce_variant(variant)
+      if variant.nil? || variant.is_a?(String)
+        variant
+      else
+        variant.to_s
+      end
+    rescue StandardError
+      nil
+    end
+  end
+end

data/lib/bugsnag/report.rb

@@ -6,6 +6,8 @@ require "bugsnag/stacktrace"
 module Bugsnag
   # rubocop:todo Metrics/ClassLength
   class Report
+    include Utility::FeatureDataStore
+
     NOTIFIER_NAME = "Ruby Bugsnag Notifier"
     NOTIFIER_VERSION = Bugsnag::VERSION
     NOTIFIER_URL = "https://www.bugsnag.com"
@@ -143,6 +145,7 @@ module Bugsnag
       self.user = {}
 
       @metadata_delegate = Utility::MetadataDelegate.new
+      @feature_flag_delegate = Bugsnag.feature_flag_delegate.dup
     end
 
     ##
@@ -220,6 +223,7 @@ module Bugsnag
           time: @created_at
         },
         exceptions: exceptions,
+        featureFlags: @feature_flag_delegate.as_json,
         groupingHash: grouping_hash,
         metaData: meta_data,
         session: session,
@@ -239,6 +243,7 @@ module Bugsnag
           :version => NOTIFIER_VERSION,
           :url => NOTIFIER_URL
         },
+        :payloadVersion => CURRENT_PAYLOAD_VERSION,
         :events => [payload_event]
       }
     end
@@ -357,6 +362,13 @@ module Bugsnag
       @metadata_delegate.clear_metadata(@meta_data, section, *args)
     end
 
+    # Get the array of stored feature flags
+    #
+    # @return [Array<Bugsnag::FeatureFlag>]
+    def feature_flags
+      @feature_flag_delegate.to_a
+    end
+
     ##
     # Set information about the current user
     #
@@ -393,6 +405,8 @@ module Bugsnag
 
     private
 
+    attr_reader :feature_flag_delegate
+
     def update_handled_counts(is_unhandled, was_unhandled)
       # do nothing if there is no session to update
       return if @session.nil?

data/lib/bugsnag/utility/feature_data_store.rb

@@ -0,0 +1,41 @@
+module Bugsnag::Utility
+  # @abstract Requires a #feature_flag_delegate method returning a
+  #   {Bugsnag::Utility::FeatureFlagDelegate}
+  module FeatureDataStore
+    # Add a feature flag with the given name & variant
+    #
+    # @param name [String]
+    # @param variant [String, nil]
+    # @return [void]
+    def add_feature_flag(name, variant = nil)
+      feature_flag_delegate.add(name, variant)
+    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 add_feature_flags(feature_flags)
+      feature_flag_delegate.merge(feature_flags)
+    end
+
+    # Remove the stored flag with the given name
+    #
+    # @param name [String]
+    # @return [void]
+    def clear_feature_flag(name)
+      feature_flag_delegate.remove(name)
+    end
+
+    # Remove all the stored flags
+    #
+    # @return [void]
+    def clear_feature_flags
+      feature_flag_delegate.clear
+    end
+  end
+end

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.rb

@@ -2,6 +2,7 @@ require "rubygems"
 require "thread"
 
 require "bugsnag/version"
+require "bugsnag/utility/feature_data_store"
 require "bugsnag/configuration"
 require "bugsnag/meta_data"
 require "bugsnag/report"
@@ -14,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"
@@ -36,6 +39,7 @@ 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
@@ -45,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.
     #
@@ -426,6 +432,16 @@ module Bugsnag
       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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag
 version: !ruby/object:Gem::Version
-  version: 6.24.2
+  version: 6.25.0
 platform: ruby
 authors:
 - James Smith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-21 00:00:00.000000000 Z
+date: 2022-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -55,6 +55,7 @@ files:
 - 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
@@ -97,6 +98,8 @@ files:
 - 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
@@ -119,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Ruby notifier for bugsnag.com