debian-mirror-gitlab/lib/api/features.rb

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

137 lines
4.1 KiB
Ruby
Raw Normal View History

2018-12-05 23:21:45 +05:30
# frozen_string_literal: true
2017-09-10 17:25:29 +05:30
module API
2021-01-03 14:25:43 +05:30
class Features < ::API::Base
2017-09-10 17:25:29 +05:30
before { authenticated_as_admin! }
2021-01-29 00:20:46 +05:30
feature_category :feature_flags
2022-07-16 23:28:13 +05:30
urgency :low
2021-01-29 00:20:46 +05:30
2017-09-10 17:25:29 +05:30
helpers do
def gate_value(params)
case params[:value]
when 'true'
true
when '0', 'false'
false
else
2021-12-11 22:18:48 +05:30
# https://github.com/jnunemaker/flipper/blob/master/lib/flipper/typecast.rb#L47
if params[:value].to_s.include?('.')
params[:value].to_f
else
params[:value].to_i
end
2017-09-10 17:25:29 +05:30
end
end
2020-05-24 23:13:21 +05:30
def gate_key(params)
case params[:key]
when 'percentage_of_actors'
:percentage_of_actors
else
:percentage_of_time
end
end
2017-09-10 17:25:29 +05:30
def gate_targets(params)
2019-03-02 22:35:43 +05:30
Feature::Target.new(params).targets
end
2017-09-10 17:25:29 +05:30
2019-03-02 22:35:43 +05:30
def gate_specified?(params)
Feature::Target.new(params).gate_specified?
2017-09-10 17:25:29 +05:30
end
end
resource :features do
desc 'Get a list of all features' do
success Entities::Feature
end
get do
features = Feature.all
present features, with: Entities::Feature, current_user: current_user
end
2021-02-22 17:27:13 +05:30
desc 'Get a list of all feature definitions' do
success Entities::Feature::Definition
end
get :definitions do
definitions = ::Feature::Definition.definitions.values.map(&:to_h)
present definitions, with: Entities::Feature::Definition, current_user: current_user
end
2017-09-10 17:25:29 +05:30
desc 'Set the gate value for the given feature' do
success Entities::Feature
end
params do
2021-12-11 22:18:48 +05:30
requires :value, type: String, desc: '`true` or `false` to enable/disable, a float for percentage of time'
2020-05-24 23:13:21 +05:30
optional :key, type: String, desc: '`percentage_of_actors` or the default `percentage_of_time`'
2017-09-10 17:25:29 +05:30
optional :feature_group, type: String, desc: 'A Feature group name'
2022-07-23 23:45:48 +05:30
optional :user, type: String, desc: 'A GitLab username or comma-separated multiple usernames'
optional :group, type: String,
desc: "A GitLab group's path, such as 'gitlab-org', or comma-separated multiple group paths"
optional :namespace, type: String,
desc: "A GitLab group or user namespace path, such as 'john-doe', or comma-separated multiple namespace paths"
optional :project, type: String,
desc: "A projects path, such as `gitlab-org/gitlab-ce`, or comma-separated multiple project paths"
2021-02-22 17:27:13 +05:30
optional :force, type: Boolean, desc: 'Skip feature flag validation checks, ie. YAML definition'
2020-05-24 23:13:21 +05:30
mutually_exclusive :key, :feature_group
mutually_exclusive :key, :user
mutually_exclusive :key, :group
2022-07-16 23:28:13 +05:30
mutually_exclusive :key, :namespace
2020-05-24 23:13:21 +05:30
mutually_exclusive :key, :project
2017-09-10 17:25:29 +05:30
end
post ':name' do
2021-02-22 17:27:13 +05:30
validate_feature_flag_name!(params[:name]) unless params[:force]
2021-01-29 00:20:46 +05:30
2017-09-10 17:25:29 +05:30
targets = gate_targets(params)
value = gate_value(params)
2020-05-24 23:13:21 +05:30
key = gate_key(params)
2017-09-10 17:25:29 +05:30
case value
when true
2019-03-02 22:35:43 +05:30
if gate_specified?(params)
2021-02-22 17:27:13 +05:30
targets.each { |target| Feature.enable(params[:name], target) }
2017-09-10 17:25:29 +05:30
else
2021-02-22 17:27:13 +05:30
Feature.enable(params[:name])
2017-09-10 17:25:29 +05:30
end
when false
2019-03-02 22:35:43 +05:30
if gate_specified?(params)
2021-02-22 17:27:13 +05:30
targets.each { |target| Feature.disable(params[:name], target) }
2017-09-10 17:25:29 +05:30
else
2021-02-22 17:27:13 +05:30
Feature.disable(params[:name])
2017-09-10 17:25:29 +05:30
end
else
2020-05-24 23:13:21 +05:30
if key == :percentage_of_actors
2021-02-22 17:27:13 +05:30
Feature.enable_percentage_of_actors(params[:name], value)
2020-05-24 23:13:21 +05:30
else
2021-02-22 17:27:13 +05:30
Feature.enable_percentage_of_time(params[:name], value)
2020-05-24 23:13:21 +05:30
end
2017-09-10 17:25:29 +05:30
end
2021-02-22 17:27:13 +05:30
present Feature.get(params[:name]), # rubocop:disable Gitlab/AvoidFeatureGet
with: Entities::Feature, current_user: current_user
2022-07-23 23:45:48 +05:30
rescue Feature::Target::UnknowTargetError => e
bad_request!(e.message)
2017-09-10 17:25:29 +05:30
end
2018-05-09 12:01:36 +05:30
desc 'Remove the gate value for the given feature'
delete ':name' do
2020-06-23 00:09:42 +05:30
Feature.remove(params[:name])
2018-05-09 12:01:36 +05:30
2020-03-13 15:44:24 +05:30
no_content!
2018-05-09 12:01:36 +05:30
end
2017-09-10 17:25:29 +05:30
end
2021-01-29 00:20:46 +05:30
helpers do
def validate_feature_flag_name!(name)
# no-op
end
end
2017-09-10 17:25:29 +05:30
end
end
2021-01-29 00:20:46 +05:30
2021-06-08 01:23:25 +05:30
API::Features.prepend_mod_with('API::Features')