Skip to content

Latest commit

 

History

History
64 lines (48 loc) · 2.09 KB

README.md

File metadata and controls

64 lines (48 loc) · 2.09 KB
Raw

RubyEventStore::Flipper

Flipper integration for RubyEventStore.

Installation

  1. Ensure that your Flipper has instrumentation enabled
  2. Enable RubyEventStore subscriber via RubyEventStore::Flipper.enable(event_store_instance)

Example:

Flipper.configure do |config|
  config.default do
    # ... adapter configuration

    # Enable instrumentation in Flipper
    Flipper.new(adapter, instrumenter: ActiveSupport::Notifications)
  end
end

# Enable RubyEventStore instrumentation for Flipper
RubyEventStore::Flipper.enable(Rails.configuration.event_store)

Customize stream pattern

By default, stream name for toggle foobar is FeatureToggle$foobar. You can customize it via stream_pattern argument:

RubyEventStore::Flipper.enable(
  Rails.configuration.event_store,
  stream_pattern: ->(feature_name) { "feature_toggle-#{feature_name}" },
)

Customize notifications component

Anything with the same API as ActiveSupport::Notifications is supported.

RubyEventStore::Flipper.enable(Rails.configuration.event_store, instrumenter: AS::Notifications)

Customize events being used

You can pass your own events to be used instead of default ones. Example:

Flipper.enable(event_store, custom_events: {
  "ToggleAdded" => CustomModule::ToggleAdded,
  "ToggleRemoved" => CustomModule::ToggleRemoved,
  "ToggleGloballyEnabled" => CustomModule::ToggleGloballyEnabled,
  "ToggleEnabledForActor" => CustomModule::ToggleEnabledForActor,
  "ToggleEnabledForGroup" => CustomModule::ToggleEnabledForGroup,
  "ToggleEnabledForPercentageOfActors" => CustomModule::ToggleEnabledForPercentageOfActors,
  "ToggleEnabledForPercentageOfTime" => CustomModule::ToggleEnabledForPercentageOfTime,
  "ToggleGloballyDisabled" => CustomModule::ToggleGloballyDisabled,
  "ToggleDisabledForActor" => CustomModule::ToggleDisabledForActor,
  "ToggleDisabledForGroup" => CustomModule::ToggleDisabledForGroup,
  "ToggleDisabledForPercentageOfActors" => CustomModule::ToggleDisabledForPercentageOfActors,
  "ToggleDisabledForPercentageOfTime" => CustomModule::ToggleDisabledForPercentageOfTime,
})