Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
28e7a1de
Commit
28e7a1de
authored
Mar 26, 2021
by
Vitali Tatarintev
Committed by
Mayra Cabrera
Mar 26, 2021
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add missing feature flag definition files
Add missing definition files for some feature flags
parent
8816566a
Changes
13
Hide whitespace changes
Inline
Side-by-side
Showing
13 changed files
with
157 additions
and
72 deletions
+157
-72
config/feature_flags/ops/prometheus_metrics_method_instrumentation.yml
...e_flags/ops/prometheus_metrics_method_instrumentation.yml
+8
-0
config/feature_flags/ops/prometheus_metrics_view_instrumentation.yml
...ure_flags/ops/prometheus_metrics_view_instrumentation.yml
+8
-0
lib/feature.rb
lib/feature.rb
+4
-4
spec/graphql/features/feature_flag_spec.rb
spec/graphql/features/feature_flag_spec.rb
+1
-0
spec/graphql/types/base_field_spec.rb
spec/graphql/types/base_field_spec.rb
+1
-0
spec/lib/api/helpers_spec.rb
spec/lib/api/helpers_spec.rb
+1
-0
spec/lib/feature/gitaly_spec.rb
spec/lib/feature/gitaly_spec.rb
+1
-0
spec/lib/feature_spec.rb
spec/lib/feature_spec.rb
+118
-68
spec/lib/gitlab/gon_helper_spec.rb
spec/lib/gitlab/gon_helper_spec.rb
+1
-0
spec/lib/gitlab/metrics/methods_spec.rb
spec/lib/gitlab/metrics/methods_spec.rb
+5
-0
spec/lib/gitlab/metrics_spec.rb
spec/lib/gitlab/metrics_spec.rb
+5
-0
spec/requests/api/features_spec.rb
spec/requests/api/features_spec.rb
+2
-0
spec/requests/api/usage_data_spec.rb
spec/requests/api/usage_data_spec.rb
+2
-0
No files found.
config/feature_flags/ops/prometheus_metrics_method_instrumentation.yml
0 → 100644
View file @
28e7a1de
---
name
:
prometheus_metrics_method_instrumentation
introduced_by_url
:
https://gitlab.com/gitlab-org/gitlab/-/merge_requests/4304
rollout_issue_url
:
milestone
:
'
10.5'
type
:
ops
group
:
default_enabled
:
false
config/feature_flags/ops/prometheus_metrics_view_instrumentation.yml
0 → 100644
View file @
28e7a1de
---
name
:
prometheus_metrics_view_instrumentation
introduced_by_url
:
https://gitlab.com/gitlab-org/gitlab/-/merge_requests/4304
rollout_issue_url
:
milestone
:
'
10.5'
type
:
ops
group
:
default_enabled
:
false
lib/feature.rb
View file @
28e7a1de
...
...
@@ -57,7 +57,7 @@ class Feature
# use `default_enabled: true` to default the flag to being `enabled`
# unless set explicitly. The default is `disabled`
# TODO: remove the `default_enabled:` and read it from the `defintion_yaml`
# check: https://gitlab.com/gitlab-org/gitlab/-/issues/
30228
# check: https://gitlab.com/gitlab-org/gitlab/-/issues/
271275
def
enabled?
(
key
,
thing
=
nil
,
type: :development
,
default_enabled:
false
)
if
check_feature_flags_definition?
if
thing
&&
!
thing
.
respond_to?
(
:flipper_id
)
...
...
@@ -65,11 +65,11 @@ class Feature
"The thing '
#{
thing
.
class
.
name
}
' for feature flag '
#{
key
}
' needs to include `FeatureGate` or implement `flipper_id`"
end
Feature
::
Definition
.
valid_usage!
(
key
,
type:
type
,
default_enabled:
default_enabled
)
Feature
::
Definition
.
valid_usage!
(
key
,
type:
type
,
default_enabled:
:yaml
)
end
#
If `default_enabled: :yaml` we fetch the value from the YAML definition instead.
default_enabled
=
Feature
::
Definition
.
default_enabled?
(
key
)
if
default_enabled
==
:yaml
#
TODO: Remove rubocop disable comment once `default_enabled` argument is removed https://gitlab.com/gitlab-org/gitlab/-/issues/271275
default_enabled
=
Feature
::
Definition
.
default_enabled?
(
key
)
# rubocop:disable Lint/ShadowedArgument
# During setup the database does not exist yet. So we haven't stored a value
# for the feature yet and return the default.
...
...
spec/graphql/features/feature_flag_spec.rb
View file @
28e7a1de
...
...
@@ -15,6 +15,7 @@ RSpec.describe 'Graphql Field feature flags' do
before
do
skip_feature_flags_yaml_validation
skip_default_enabled_yaml_check
end
subject
{
result
}
...
...
spec/graphql/types/base_field_spec.rb
View file @
28e7a1de
...
...
@@ -128,6 +128,7 @@ RSpec.describe Types::BaseField do
before
do
skip_feature_flags_yaml_validation
skip_default_enabled_yaml_check
end
it
'returns false if the feature is not enabled'
do
...
...
spec/lib/api/helpers_spec.rb
View file @
28e7a1de
...
...
@@ -183,6 +183,7 @@ RSpec.describe API::Helpers do
before
do
skip_feature_flags_yaml_validation
skip_default_enabled_yaml_check
end
context
'with feature enabled'
do
...
...
spec/lib/feature/gitaly_spec.rb
View file @
28e7a1de
...
...
@@ -8,6 +8,7 @@ RSpec.describe Feature::Gitaly do
before
do
skip_feature_flags_yaml_validation
skip_default_enabled_yaml_check
end
describe
".enabled?"
do
...
...
spec/lib/feature_spec.rb
View file @
28e7a1de
...
...
@@ -123,12 +123,35 @@ RSpec.describe Feature, stub_feature_flags: false do
end
describe
'.enabled?'
do
it
'returns false for undefined feature'
do
expect
(
described_class
.
enabled?
(
:some_random_feature_flag
)).
to
be_falsey
let
(
:disabled_ff_definition
)
do
Feature
::
Definition
.
new
(
'development/disabled_feature_flag.yml'
,
name:
'disabled_feature_flag'
,
type:
'development'
,
default_enabled:
false
)
end
it
'returns true for undefined feature with default_enabled'
do
expect
(
described_class
.
enabled?
(
:some_random_feature_flag
,
default_enabled:
true
)).
to
be_truthy
let
(
:enabled_ff_definition
)
do
Feature
::
Definition
.
new
(
'development/enabled_feature_flag.yml'
,
name:
'enabled_feature_flag'
,
type:
'development'
,
default_enabled:
true
)
end
before
do
allow
(
Feature
::
Definition
).
to
receive
(
:definitions
)
do
{
disabled_ff_definition
.
key
=>
disabled_ff_definition
,
enabled_ff_definition
.
key
=>
enabled_ff_definition
}
end
end
it
'raises an exception for undefined feature'
do
expect
{
described_class
.
enabled?
(
:some_random_feature_flag
)
}.
to
raise_error
Feature
::
InvalidFeatureFlagError
end
it
'returns false for existing disabled feature in the database'
do
...
...
@@ -146,39 +169,58 @@ RSpec.describe Feature, stub_feature_flags: false do
it
{
expect
(
described_class
.
send
(
:l1_cache_backend
)).
to
eq
(
Gitlab
::
ProcessMemoryCache
.
cache_backend
)
}
it
{
expect
(
described_class
.
send
(
:l2_cache_backend
)).
to
eq
(
Rails
.
cache
)
}
it
'caches the status in L1 and L2 caches'
,
:request_store
,
:use_clean_rails_memory_store_caching
do
it
'caches the status in L1 and L2 caches'
,
:request_store
,
:use_clean_rails_memory_store_caching
,
:aggregate_failures
do
described_class
.
enable
(
:enabled_feature_flag
)
flipper_key
=
"flipper/v1/feature/enabled_feature_flag"
flipper_features_key
=
'flipper/v1/features'
flipper_feature_key
=
'flipper/v1/feature/enabled_feature_flag'
expect
(
described_class
.
send
(
:l2_cache_backend
))
.
to
receive
(
:fetch
)
.
once
.
with
(
flipper_key
,
expires_in:
1
.
hour
)
.
and_call_original
expect
(
described_class
.
send
(
:l1_cache_backend
))
.
to
receive
(
:fetch
)
.
once
.
with
(
flipper_key
,
expires_in:
1
.
minute
)
.
and_call_original
allow
(
described_class
.
send
(
:l2_cache_backend
)).
to
receive
(
:fetch
).
twice
.
and_call_original
allow
(
described_class
.
send
(
:l1_cache_backend
)).
to
receive
(
:fetch
).
twice
.
and_call_original
2
.
times
do
expect
(
described_class
.
enabled?
(
:enabled_feature_flag
)).
to
be_truthy
end
expect
(
described_class
.
send
(
:l2_cache_backend
)).
to
have_received
(
:fetch
).
with
(
flipper_features_key
,
expires_in:
1
.
hour
)
expect
(
described_class
.
send
(
:l2_cache_backend
)).
to
have_received
(
:fetch
).
with
(
flipper_feature_key
,
expires_in:
1
.
hour
)
expect
(
described_class
.
send
(
:l1_cache_backend
)).
to
have_received
(
:fetch
).
with
(
flipper_features_key
,
expires_in:
1
.
minute
)
expect
(
described_class
.
send
(
:l1_cache_backend
)).
to
have_received
(
:fetch
).
with
(
flipper_feature_key
,
expires_in:
1
.
minute
)
end
it
'returns the default value when the database does not exist'
do
fake_default
=
double
(
'fake default'
)
it
'returns the default value when the database does not exist'
,
:aggregate_falures
do
a_feature
=
Feature
::
Definition
.
new
(
'development/a_feature.yml'
,
name:
'a_feature'
,
type:
'development'
,
default_enabled:
true
)
allow
(
Feature
::
Definition
).
to
receive
(
:definitions
)
do
{
a_feature
.
key
=>
a_feature
}
end
expect
(
ActiveRecord
::
Base
).
to
receive
(
:connection
)
{
raise
ActiveRecord
::
NoDatabaseError
,
"No database"
}
expect
(
described_class
.
enabled?
(
:a_feature
,
default_enabled:
fake_default
)).
to
eq
(
fake_default
)
expect
(
described_class
.
enabled?
(
:a_feature
)).
to
eq
(
true
)
end
context
'cached feature flag'
,
:request_store
do
context
'cached feature flag'
,
:request_store
,
:use_clean_rails_memory_store_caching
,
:aggregate_failures
do
let
(
:flag
)
{
:some_feature_flag
}
let
(
:some_feature_flag
)
do
Feature
::
Definition
.
new
(
"development/
#{
flag
}
.yml"
,
name:
flag
.
to_s
,
type:
'development'
,
default_enabled:
true
)
end
before
do
allow
(
Feature
::
Definition
).
to
receive
(
:definitions
)
do
{
some_feature_flag
.
key
=>
some_feature_flag
}
end
described_class
.
send
(
:flipper
).
memoize
=
false
described_class
.
enabled?
(
flag
)
end
...
...
@@ -273,63 +315,48 @@ RSpec.describe Feature, stub_feature_flags: false do
.
to
raise_error
(
/The `type:` of/
)
end
it
'when invalid default_enabled is used'
do
expect
{
described_class
.
enabled?
(
:my_feature_flag
,
default_enabled:
true
)
}
.
to
raise_error
(
/The `default_enabled:` of/
)
it
'reads the default from the YAML definition'
do
expect
(
described_class
.
enabled?
(
:my_feature_flag
)).
to
eq
(
false
)
end
context
'when `default_enabled: :yaml` is used in code'
do
it
'reads the default from the YAML definition'
do
expect
(
described_class
.
enabled?
(
:my_feature_flag
,
default_enabled: :yaml
)).
to
eq
(
false
)
end
context
'when YAML definition does not exist for an optional type'
do
let
(
:optional_type
)
{
described_class
::
Shared
::
TYPES
.
find
{
|
name
,
attrs
|
attrs
[
:optional
]
}.
first
}
context
'when default_enabled is true in the YAML definition'
do
let
(
:default_enabled
)
{
true
}
it
'reads the default from the YAML definition'
do
expect
(
described_class
.
enabled?
(
:my_feature_flag
,
default_enabled: :yaml
)).
to
eq
(
true
)
context
'when in dev or test environment'
do
it
'raises an error for dev'
do
expect
{
described_class
.
enabled?
(
:non_existent_flag
,
type:
optional_type
)
}
.
to
raise_error
(
Feature
::
InvalidFeatureFlagError
,
"The feature flag YAML definition for 'non_existent_flag' does not exist"
)
end
end
context
'when YAML definition does not exist for an optional type'
do
let
(
:optional_type
)
{
described_class
::
Shared
::
TYPES
.
find
{
|
name
,
attrs
|
attrs
[
:optional
]
}.
first
}
context
'when in dev or test environment'
do
it
'raises an error for dev'
do
expect
{
described_class
.
enabled?
(
:non_existent_flag
,
type:
optional_type
,
default_enabled: :yaml
)
}
.
to
raise_error
(
Feature
::
InvalidFeatureFlagError
,
"The feature flag YAML definition for 'non_existent_flag' does not exist"
)
end
context
'when in production'
do
before
do
allow
(
Gitlab
::
ErrorTracking
).
to
receive
(
:should_raise_for_dev?
).
and_return
(
false
)
end
context
'when
in production
'
do
context
'when
database exists
'
do
before
do
allow
(
Gitlab
::
ErrorTracking
).
to
receive
(
:should_raise_for_dev?
).
and_return
(
fals
e
)
allow
(
Gitlab
::
Database
).
to
receive
(
:exists?
).
and_return
(
tru
e
)
end
context
'when database exists'
do
before
do
allow
(
Gitlab
::
Database
).
to
receive
(
:exists?
).
and_return
(
true
)
end
it
'checks the persisted status and returns false'
do
expect
(
described_class
).
to
receive
(
:get
).
with
(
:non_existent_flag
).
and_call_original
it
'checks the persisted status and returns false'
do
expect
(
described_class
).
to
receive
(
:get
).
with
(
:non_existent_flag
).
and_call_original
expect
(
described_class
.
enabled?
(
:non_existent_flag
,
type:
optional_type
,
default_enabled: :yaml
)).
to
eq
(
false
)
end
expect
(
described_class
.
enabled?
(
:non_existent_flag
,
type:
optional_type
)).
to
eq
(
false
)
end
end
context
'when database does not exist'
do
before
do
allow
(
Gitlab
::
Database
).
to
receive
(
:exists?
).
and_return
(
false
)
end
context
'when database does not exist'
do
before
do
allow
(
Gitlab
::
Database
).
to
receive
(
:exists?
).
and_return
(
false
)
end
it
'returns false without checking the status in the database'
do
expect
(
described_class
).
not_to
receive
(
:get
)
it
'returns false without checking the status in the database'
do
expect
(
described_class
).
not_to
receive
(
:get
)
expect
(
described_class
.
enabled?
(
:non_existent_flag
,
type:
optional_type
,
default_enabled: :yaml
)).
to
eq
(
false
)
end
expect
(
described_class
.
enabled?
(
:non_existent_flag
,
type:
optional_type
)).
to
eq
(
false
)
end
end
end
...
...
@@ -337,13 +364,36 @@ RSpec.describe Feature, stub_feature_flags: false do
end
end
describe
'.disable?'
do
it
'returns true for undefined feature'
do
expect
(
described_class
.
disabled?
(
:some_random_feature_flag
)).
to
be_truthy
describe
'.disabled?'
do
let
(
:disabled_ff_definition
)
do
Feature
::
Definition
.
new
(
'development/disabled_feature_flag.yml'
,
name:
'disabled_feature_flag'
,
type:
'development'
,
default_enabled:
false
)
end
let
(
:enabled_ff_definition
)
do
Feature
::
Definition
.
new
(
'development/enabled_feature_flag.yml'
,
name:
'enabled_feature_flag'
,
type:
'development'
,
default_enabled:
true
)
end
before
do
allow
(
Feature
::
Definition
).
to
receive
(
:definitions
)
do
{
disabled_ff_definition
.
key
=>
disabled_ff_definition
,
enabled_ff_definition
.
key
=>
enabled_ff_definition
}
end
end
it
'r
eturns false for undefined feature with default_enabled
'
do
expect
(
described_class
.
disabled?
(
:some_random_feature_flag
,
default_enabled:
true
)).
to
be_falsey
it
'r
aises an exception for undefined feature
'
do
expect
{
described_class
.
disabled?
(
:some_random_feature_flag
)
}.
to
raise_error
Feature
::
InvalidFeatureFlagError
end
it
'returns true for existing disabled feature in the database'
do
...
...
spec/lib/gitlab/gon_helper_spec.rb
View file @
28e7a1de
...
...
@@ -12,6 +12,7 @@ RSpec.describe Gitlab::GonHelper do
describe
'#push_frontend_feature_flag'
do
before
do
skip_feature_flags_yaml_validation
skip_default_enabled_yaml_check
end
it
'pushes a feature flag to the frontend'
do
...
...
spec/lib/gitlab/metrics/methods_spec.rb
View file @
28e7a1de
...
...
@@ -102,6 +102,11 @@ RSpec.describe Gitlab::Metrics::Methods do
let
(
:feature_name
)
{
:some_metric_feature
}
let
(
:metric
)
{
call_fetch_metric_method
(
docstring:
docstring
,
with_feature:
feature_name
)
}
before
do
skip_feature_flags_yaml_validation
skip_default_enabled_yaml_check
end
context
'when feature is enabled'
do
before
do
stub_feature_flags
(
feature_name
=>
true
)
...
...
spec/lib/gitlab/metrics_spec.rb
View file @
28e7a1de
...
...
@@ -54,6 +54,11 @@ RSpec.describe Gitlab::Metrics do
end
describe
'.measure'
do
before
do
skip_feature_flags_yaml_validation
skip_default_enabled_yaml_check
end
context
'without a transaction'
do
it
'returns the return value of the block'
do
val
=
described_class
.
measure
(
:foo
)
{
10
}
...
...
spec/requests/api/features_spec.rb
View file @
28e7a1de
...
...
@@ -438,6 +438,8 @@ RSpec.describe API::Features, stub_feature_flags: false do
context
'when the gate value was set'
do
before
do
skip_feature_flags_yaml_validation
skip_default_enabled_yaml_check
Feature
.
enable
(
feature_name
)
end
...
...
spec/requests/api/usage_data_spec.rb
View file @
28e7a1de
...
...
@@ -73,6 +73,7 @@ RSpec.describe API::UsageData do
context
'with unknown event'
do
before
do
skip_feature_flags_yaml_validation
skip_default_enabled_yaml_check
end
it
'returns status ok'
do
...
...
@@ -149,6 +150,7 @@ RSpec.describe API::UsageData do
context
'with unknown event'
do
before
do
skip_feature_flags_yaml_validation
skip_default_enabled_yaml_check
end
it
'returns status ok'
do
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment