Add support for feature flags

.yardopts

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

CHANGELOG.md

@@ -1,6 +1,13 @@
 Changelog
 =========
 
+## TBD
+
+### 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

features/fixtures/rack/app/app.rb

@@ -2,19 +2,36 @@
 require 'rack'
 require 'json'
 
+$clear_all_flags = false
+
 Bugsnag.configure do |config|
   config.api_key = ENV['BUGSNAG_API_KEY']
   config.endpoint = ENV['BUGSNAG_ENDPOINT']
 
   if ENV.key?('BUGSNAG_METADATA_FILTERS')
     config.meta_data_filters = JSON.parse(ENV['BUGSNAG_METADATA_FILTERS'])
   end
+
+  config.add_on_error(proc do |event|
+    event.add_feature_flags([
+      Bugsnag::FeatureFlag.new('from config 1'),
+      Bugsnag::FeatureFlag.new('from config 2', 'abc xyz'),
+    ])
+
+    event.clear_feature_flag('should be removed!')
+
+    if $clear_all_flags
+      event.clear_feature_flags
+    end
+  end)
 end
 
 class BugsnagTests
   def call(env)
     req = Rack::Request.new(env)
 
+    $clear_all_flags = !!req.params['clear_all_flags']
+
     case req.env['REQUEST_PATH']
     when '/unhandled'
       raise 'Unhandled error'
@@ -24,6 +41,29 @@ def call(env)
       rescue StandardError => e
         Bugsnag.notify(e)
       end
+    when '/feature-flags/unhandled'
+      Bugsnag.add_feature_flag('a', '1')
+
+      Bugsnag.add_feature_flags([
+        Bugsnag::FeatureFlag.new('b'),
+        Bugsnag::FeatureFlag.new('c', '3'),
+      ])
+
+      Bugsnag.add_feature_flag('d')
+      Bugsnag.add_feature_flag('should be removed!')
+
+      raise 'Unhandled error'
+    when '/feature-flags/handled'
+      Bugsnag.add_feature_flag('x')
+
+      Bugsnag.add_feature_flags([
+        Bugsnag::FeatureFlag.new('y', '1234'),
+        Bugsnag::FeatureFlag.new('z'),
+      ])
+
+      Bugsnag.add_feature_flag('should be removed!')
+
+      Bugsnag.notify(RuntimeError.new('oh no'))
     end
 
     res = Rack::Response.new

features/fixtures/rails3/app/app/controllers/feature_flags_controller.rb

@@ -0,0 +1,33 @@
+class FeatureFlagsController < ActionController::Base
+  protect_from_forgery
+
+  before_bugsnag_notify :add_feature_flags
+
+  def unhandled
+    Bugsnag.add_feature_flag('unhandled')
+
+    raise 'oh no'
+  end
+
+  def handled
+    Bugsnag.add_feature_flag('handled')
+
+    Bugsnag.notify(RuntimeError.new('ahhh'))
+
+    render json: {}
+  end
+
+  private
+
+  def add_feature_flags(event)
+    params['flags'].each do |key, value|
+      event.add_feature_flag(key, value)
+    end
+
+    if params.key?('clear_all_flags')
+      event.add_metadata(:clear_all_flags, :a, 1)
+    else
+      event.clear_feature_flag('should be removed!')
+    end
+  end
+end

features/fixtures/rails3/app/config/initializers/bugsnag.rb

@@ -32,4 +32,15 @@
       report.request[:params][:another_thing] = "hi"
     end)
   end
+
+  config.add_on_error(proc do |event|
+    event.add_feature_flags([
+      Bugsnag::FeatureFlag.new('from config 1'),
+      Bugsnag::FeatureFlag.new('from config 2', 'abc xyz'),
+    ])
+
+    if event.metadata.key?(:clear_all_flags)
+      event.clear_feature_flags
+    end
+  end)
 end

features/fixtures/rails3/app/config/routes.rb

@@ -15,5 +15,6 @@
   get "/send_environment/(:action)", controller: 'send_environment'
   get "/warden/(:action)", controller: 'warden'
   get "/breadcrumbs/(:action)", controller: 'breadcrumbs'
+  get "/features/(:action)", controller: 'feature_flags'
   get "/(:action)", controller: 'application'
 end

features/fixtures/rails4/app/app/controllers/feature_flags_controller.rb

@@ -0,0 +1,33 @@
+class FeatureFlagsController < ActionController::Base
+  protect_from_forgery
+
+  before_bugsnag_notify :add_feature_flags
+
+  def unhandled
+    Bugsnag.add_feature_flag('unhandled')
+
+    raise 'oh no'
+  end
+
+  def handled
+    Bugsnag.add_feature_flag('handled')
+
+    Bugsnag.notify(RuntimeError.new('ahhh'))
+
+    render json: {}
+  end
+
+  private
+
+  def add_feature_flags(event)
+    params['flags'].each do |key, value|
+      event.add_feature_flag(key, value)
+    end
+
+    if params.key?('clear_all_flags')
+      event.add_metadata(:clear_all_flags, :a, 1)
+    else
+      event.clear_feature_flag('should be removed!')
+    end
+  end
+end

features/fixtures/rails4/app/config/initializers/bugsnag.rb

@@ -32,4 +32,15 @@
       report.request[:params][:another_thing] = "hi"
     end)
   end
+
+  config.add_on_error(proc do |event|
+    event.add_feature_flags([
+      Bugsnag::FeatureFlag.new('from config 1'),
+      Bugsnag::FeatureFlag.new('from config 2', 'abc xyz'),
+    ])
+
+    if event.metadata.key?(:clear_all_flags)
+      event.clear_feature_flags
+    end
+  end)
 end

features/fixtures/rails4/app/config/routes.rb

@@ -19,4 +19,5 @@
   get "/breadcrumbs/(:action)", controller: 'breadcrumbs'
   get "/mongo/(:action)", controller: 'mongo'
   get "/active_job/(:action)", controller: 'active_job'
+  get "/features/(:action)", controller: 'feature_flags'
 end

features/fixtures/rails5/app/app/controllers/feature_flags_controller.rb

@@ -0,0 +1,31 @@
+class FeatureFlagsController < ActionController::Base
+  protect_from_forgery
+
+  before_bugsnag_notify :add_feature_flags
+
+  def unhandled
+    Bugsnag.add_feature_flag('unhandled')
+
+    raise 'oh no'
+  end
+
+  def handled
+    Bugsnag.add_feature_flag('handled')
+
+    Bugsnag.notify(RuntimeError.new('ahhh'))
+  end
+
+  private
+
+  def add_feature_flags(event)
+    params['flags'].each do |key, value|
+      event.add_feature_flag(key, value)
+    end
+
+    if params.key?('clear_all_flags')
+      event.add_metadata(:clear_all_flags, :a, 1)
+    else
+      event.clear_feature_flag('should be removed!')
+    end
+  end
+end

features/fixtures/rails5/app/config/initializers/bugsnag.rb

@@ -32,4 +32,15 @@
       report.request[:params][:another_thing] = "hi"
     end)
   end
+
+  config.add_on_error(proc do |event|
+    event.add_feature_flags([
+      Bugsnag::FeatureFlag.new('from config 1'),
+      Bugsnag::FeatureFlag.new('from config 2', 'abc xyz'),
+    ])
+
+    if event.metadata.key?(:clear_all_flags)
+      event.clear_feature_flags
+    end
+  end)
 end

features/fixtures/rails5/app/config/routes.rb

@@ -65,4 +65,7 @@
 
   get 'active_job/handled', to: 'active_job#handled'
   get 'active_job/unhandled', to: 'active_job#unhandled'
+
+  get 'features/handled', to: 'feature_flags#handled'
+  get 'features/unhandled', to: 'feature_flags#unhandled'
 end

features/fixtures/rails6/app/app/controllers/feature_flags_controller.rb

@@ -0,0 +1,31 @@
+class FeatureFlagsController < ActionController::Base
+  protect_from_forgery
+
+  before_bugsnag_notify :add_feature_flags
+
+  def unhandled
+    Bugsnag.add_feature_flag('unhandled')
+
+    raise 'oh no'
+  end
+
+  def handled
+    Bugsnag.add_feature_flag('handled')
+
+    Bugsnag.notify(RuntimeError.new('ahhh'))
+  end
+
+  private
+
+  def add_feature_flags(event)
+    params['flags'].each do |key, value|
+      event.add_feature_flag(key, value)
+    end
+
+    if params.key?('clear_all_flags')
+      event.add_metadata(:clear_all_flags, :a, 1)
+    else
+      event.clear_feature_flag('should be removed!')
+    end
+  end
+end

features/fixtures/rails6/app/config/initializers/bugsnag.rb

@@ -32,4 +32,15 @@
       report.request[:params][:another_thing] = "hi"
     end)
   end
+
+  config.add_on_error(proc do |event|
+    event.add_feature_flags([
+      Bugsnag::FeatureFlag.new('from config 1'),
+      Bugsnag::FeatureFlag.new('from config 2', 'abc xyz'),
+    ])
+
+    if event.metadata.key?(:clear_all_flags)
+      event.clear_feature_flags
+    end
+  end)
 end

features/fixtures/rails6/app/config/routes.rb

@@ -65,4 +65,7 @@
 
   get 'active_job/handled', to: 'active_job#handled'
   get 'active_job/unhandled', to: 'active_job#unhandled'
+
+  get 'features/handled', to: 'feature_flags#handled'
+  get 'features/unhandled', to: 'feature_flags#unhandled'
 end

features/fixtures/rails7/app/app/controllers/feature_flags_controller.rb

@@ -0,0 +1,31 @@
+class FeatureFlagsController < ActionController::Base
+  protect_from_forgery
+
+  before_bugsnag_notify :add_feature_flags
+
+  def unhandled
+    Bugsnag.add_feature_flag('unhandled')
+
+    raise 'oh no'
+  end
+
+  def handled
+    Bugsnag.add_feature_flag('handled')
+
+    Bugsnag.notify(RuntimeError.new('ahhh'))
+  end
+
+  private
+
+  def add_feature_flags(event)
+    params['flags'].each do |key, value|
+      event.add_feature_flag(key, value)
+    end
+
+    if params.key?('clear_all_flags')
+      event.add_metadata(:clear_all_flags, :a, 1)
+    else
+      event.clear_feature_flag('should be removed!')
+    end
+  end
+end

features/fixtures/rails7/app/config/initializers/bugsnag.rb

@@ -32,4 +32,15 @@
       report.request[:params][:another_thing] = "hi"
     end)
   end
+
+  config.add_on_error(proc do |event|
+    event.add_feature_flags([
+      Bugsnag::FeatureFlag.new('from config 1'),
+      Bugsnag::FeatureFlag.new('from config 2', 'abc xyz'),
+    ])
+
+    if event.metadata.key?(:clear_all_flags)
+      event.clear_feature_flags
+    end
+  end)
 end

features/fixtures/rails7/app/config/routes.rb

@@ -65,4 +65,7 @@
 
   get 'active_job/handled', to: 'active_job#handled'
   get 'active_job/unhandled', to: 'active_job#unhandled'
+
+  get 'features/handled', to: 'feature_flags#handled'
+  get 'features/unhandled', to: 'feature_flags#unhandled'
 end