74ae135888
* Fix typo in context 'when request store is active' * Rearrange test since the instance variable always gets set now, even if RequestStore is active
99 lines
3 KiB
Ruby
99 lines
3 KiB
Ruby
require 'flipper/adapters/active_record'
|
|
require 'flipper/adapters/active_support_cache_store'
|
|
|
|
class Feature
|
|
# Classes to override flipper table names
|
|
class FlipperFeature < Flipper::Adapters::ActiveRecord::Feature
|
|
# Using `self.table_name` won't work. ActiveRecord bug?
|
|
superclass.table_name = 'features'
|
|
|
|
def self.feature_names
|
|
pluck(:key)
|
|
end
|
|
end
|
|
|
|
class FlipperGate < Flipper::Adapters::ActiveRecord::Gate
|
|
superclass.table_name = 'feature_gates'
|
|
end
|
|
|
|
class << self
|
|
delegate :group, to: :flipper
|
|
|
|
def all
|
|
flipper.features.to_a
|
|
end
|
|
|
|
def get(key)
|
|
flipper.feature(key)
|
|
end
|
|
|
|
def persisted_names
|
|
Gitlab::SafeRequestStore[:flipper_persisted_names] ||= FlipperFeature.feature_names
|
|
end
|
|
|
|
def persisted?(feature)
|
|
# Flipper creates on-memory features when asked for a not-yet-created one.
|
|
# If we want to check if a feature has been actually set, we look for it
|
|
# on the persisted features list.
|
|
persisted_names.include?(feature.name.to_s)
|
|
end
|
|
|
|
# use `default_enabled: true` to default the flag to being `enabled`
|
|
# unless set explicitly. The default is `disabled`
|
|
def enabled?(key, thing = nil, default_enabled: false)
|
|
feature = Feature.get(key)
|
|
|
|
# If we're not default enabling the flag or the feature has been set, always evaluate.
|
|
# `persisted?` can potentially generate DB queries and also checks for inclusion
|
|
# in an array of feature names (177 at last count), possibly reducing performance by half.
|
|
# So we only perform the `persisted` check if `default_enabled: true`
|
|
!default_enabled || Feature.persisted?(feature) ? feature.enabled?(thing) : true
|
|
end
|
|
|
|
def disabled?(key, thing = nil, default_enabled: false)
|
|
# we need to make different method calls to make it easy to mock / define expectations in test mode
|
|
thing.nil? ? !enabled?(key, default_enabled: default_enabled) : !enabled?(key, thing, default_enabled: default_enabled)
|
|
end
|
|
|
|
def enable(key, thing = true)
|
|
get(key).enable(thing)
|
|
end
|
|
|
|
def disable(key, thing = false)
|
|
get(key).disable(thing)
|
|
end
|
|
|
|
def enable_group(key, group)
|
|
get(key).enable_group(group)
|
|
end
|
|
|
|
def disable_group(key, group)
|
|
get(key).disable_group(group)
|
|
end
|
|
|
|
def flipper
|
|
@flipper ||= (Gitlab::SafeRequestStore[:flipper] ||= build_flipper_instance)
|
|
end
|
|
|
|
def build_flipper_instance
|
|
Flipper.new(flipper_adapter).tap { |flip| flip.memoize = true }
|
|
end
|
|
|
|
# This method is called from config/initializers/flipper.rb and can be used
|
|
# to register Flipper groups.
|
|
# See https://docs.gitlab.com/ee/development/feature_flags.html#feature-groups
|
|
def register_feature_groups
|
|
end
|
|
|
|
def flipper_adapter
|
|
active_record_adapter = Flipper::Adapters::ActiveRecord.new(
|
|
feature_class: FlipperFeature,
|
|
gate_class: FlipperGate)
|
|
|
|
Flipper::Adapters::ActiveSupportCacheStore.new(
|
|
active_record_adapter,
|
|
Rails.cache,
|
|
expires_in: 1.hour)
|
|
end
|
|
end
|
|
end
|