flipper 0.26.0 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.github/FUNDING.yml +1 -0
- data/.github/workflows/ci.yml +19 -13
- data/.github/workflows/examples.yml +32 -15
- data/Changelog.md +294 -154
- data/Gemfile +15 -10
- data/README.md +13 -11
- data/benchmark/enabled_ips.rb +10 -0
- data/benchmark/enabled_multiple_actors_ips.rb +20 -0
- data/benchmark/enabled_profile.rb +20 -0
- data/benchmark/instrumentation_ips.rb +21 -0
- data/benchmark/typecast_ips.rb +27 -0
- data/docs/images/flipper_cloud.png +0 -0
- data/examples/api/basic.ru +3 -4
- data/examples/api/custom_memoized.ru +3 -4
- data/examples/api/memoized.ru +3 -4
- data/examples/cloud/app.ru +12 -0
- data/examples/cloud/backoff_policy.rb +13 -0
- data/examples/cloud/basic.rb +22 -0
- data/examples/cloud/cloud_setup.rb +20 -0
- data/examples/cloud/forked.rb +36 -0
- data/examples/cloud/import.rb +17 -0
- data/examples/cloud/threaded.rb +33 -0
- data/examples/dsl.rb +1 -15
- data/examples/enabled_for_actor.rb +4 -2
- data/examples/expressions.rb +213 -0
- data/examples/mirroring.rb +59 -0
- data/examples/strict.rb +18 -0
- data/flipper-cloud.gemspec +19 -0
- data/flipper.gemspec +3 -5
- data/lib/flipper/actor.rb +6 -3
- data/lib/flipper/adapter.rb +33 -7
- data/lib/flipper/adapter_builder.rb +44 -0
- data/lib/flipper/adapters/dual_write.rb +1 -3
- data/lib/flipper/adapters/failover.rb +0 -4
- data/lib/flipper/adapters/failsafe.rb +0 -4
- data/lib/flipper/adapters/http/client.rb +26 -7
- data/lib/flipper/adapters/http/error.rb +1 -1
- data/lib/flipper/adapters/http.rb +29 -16
- data/lib/flipper/adapters/instrumented.rb +25 -6
- data/lib/flipper/adapters/memoizable.rb +33 -21
- data/lib/flipper/adapters/memory.rb +81 -46
- data/lib/flipper/adapters/operation_logger.rb +16 -7
- data/lib/flipper/adapters/poll/poller.rb +2 -125
- data/lib/flipper/adapters/poll.rb +5 -3
- data/lib/flipper/adapters/pstore.rb +17 -11
- data/lib/flipper/adapters/read_only.rb +4 -4
- data/lib/flipper/adapters/strict.rb +47 -0
- data/lib/flipper/adapters/sync/feature_synchronizer.rb +10 -1
- data/lib/flipper/adapters/sync.rb +0 -4
- data/lib/flipper/cloud/configuration.rb +258 -0
- data/lib/flipper/cloud/dsl.rb +27 -0
- data/lib/flipper/cloud/message_verifier.rb +95 -0
- data/lib/flipper/cloud/middleware.rb +63 -0
- data/lib/flipper/cloud/routes.rb +14 -0
- data/lib/flipper/cloud/telemetry/backoff_policy.rb +93 -0
- data/lib/flipper/cloud/telemetry/instrumenter.rb +26 -0
- data/lib/flipper/cloud/telemetry/metric.rb +39 -0
- data/lib/flipper/cloud/telemetry/metric_storage.rb +30 -0
- data/lib/flipper/cloud/telemetry/submitter.rb +98 -0
- data/lib/flipper/cloud/telemetry.rb +183 -0
- data/lib/flipper/cloud.rb +53 -0
- data/lib/flipper/configuration.rb +25 -4
- data/lib/flipper/dsl.rb +46 -45
- data/lib/flipper/engine.rb +88 -0
- data/lib/flipper/errors.rb +3 -3
- data/lib/flipper/export.rb +26 -0
- data/lib/flipper/exporter.rb +17 -0
- data/lib/flipper/exporters/json/export.rb +32 -0
- data/lib/flipper/exporters/json/v1.rb +33 -0
- data/lib/flipper/expression/builder.rb +73 -0
- data/lib/flipper/expression/constant.rb +25 -0
- data/lib/flipper/expression.rb +71 -0
- data/lib/flipper/expressions/all.rb +11 -0
- data/lib/flipper/expressions/any.rb +9 -0
- data/lib/flipper/expressions/boolean.rb +9 -0
- data/lib/flipper/expressions/comparable.rb +13 -0
- data/lib/flipper/expressions/duration.rb +28 -0
- data/lib/flipper/expressions/equal.rb +9 -0
- data/lib/flipper/expressions/greater_than.rb +9 -0
- data/lib/flipper/expressions/greater_than_or_equal_to.rb +9 -0
- data/lib/flipper/expressions/less_than.rb +9 -0
- data/lib/flipper/expressions/less_than_or_equal_to.rb +9 -0
- data/lib/flipper/expressions/not_equal.rb +9 -0
- data/lib/flipper/expressions/now.rb +9 -0
- data/lib/flipper/expressions/number.rb +9 -0
- data/lib/flipper/expressions/percentage.rb +9 -0
- data/lib/flipper/expressions/percentage_of_actors.rb +12 -0
- data/lib/flipper/expressions/property.rb +9 -0
- data/lib/flipper/expressions/random.rb +9 -0
- data/lib/flipper/expressions/string.rb +9 -0
- data/lib/flipper/expressions/time.rb +9 -0
- data/lib/flipper/feature.rb +87 -26
- data/lib/flipper/feature_check_context.rb +10 -6
- data/lib/flipper/gate.rb +13 -11
- data/lib/flipper/gate_values.rb +5 -18
- data/lib/flipper/gates/actor.rb +10 -17
- data/lib/flipper/gates/boolean.rb +1 -1
- data/lib/flipper/gates/expression.rb +75 -0
- data/lib/flipper/gates/group.rb +5 -7
- data/lib/flipper/gates/percentage_of_actors.rb +10 -13
- data/lib/flipper/gates/percentage_of_time.rb +1 -2
- data/lib/flipper/identifier.rb +2 -2
- data/lib/flipper/instrumentation/log_subscriber.rb +24 -5
- data/lib/flipper/instrumentation/statsd_subscriber.rb +2 -4
- data/lib/flipper/instrumentation/subscriber.rb +8 -1
- data/lib/flipper/metadata.rb +5 -1
- data/lib/flipper/middleware/memoizer.rb +30 -14
- data/lib/flipper/poller.rb +117 -0
- data/lib/flipper/serializers/gzip.rb +24 -0
- data/lib/flipper/serializers/json.rb +19 -0
- data/lib/flipper/spec/shared_adapter_specs.rb +95 -54
- data/lib/flipper/test/shared_adapter_test.rb +91 -48
- data/lib/flipper/typecast.rb +56 -15
- data/lib/flipper/types/actor.rb +13 -13
- data/lib/flipper/types/group.rb +4 -4
- data/lib/flipper/types/percentage.rb +1 -1
- data/lib/flipper/version.rb +1 -1
- data/lib/flipper.rb +47 -10
- data/spec/fixtures/flipper_pstore_1679087600.json +46 -0
- data/spec/flipper/adapter_builder_spec.rb +73 -0
- data/spec/flipper/adapter_spec.rb +30 -2
- data/spec/flipper/adapters/dual_write_spec.rb +2 -2
- data/spec/flipper/adapters/http_spec.rb +64 -8
- data/spec/flipper/adapters/instrumented_spec.rb +29 -11
- data/spec/flipper/adapters/memoizable_spec.rb +51 -31
- data/spec/flipper/adapters/memory_spec.rb +14 -3
- data/spec/flipper/adapters/operation_logger_spec.rb +31 -12
- data/spec/flipper/adapters/read_only_spec.rb +32 -17
- data/spec/flipper/adapters/strict_spec.rb +62 -0
- data/spec/flipper/adapters/sync/feature_synchronizer_spec.rb +27 -0
- data/spec/flipper/cloud/configuration_spec.rb +252 -0
- data/spec/flipper/cloud/dsl_spec.rb +82 -0
- data/spec/flipper/cloud/message_verifier_spec.rb +104 -0
- data/spec/flipper/cloud/middleware_spec.rb +289 -0
- data/spec/flipper/cloud/telemetry/backoff_policy_spec.rb +108 -0
- data/spec/flipper/cloud/telemetry/metric_spec.rb +87 -0
- data/spec/flipper/cloud/telemetry/metric_storage_spec.rb +58 -0
- data/spec/flipper/cloud/telemetry/submitter_spec.rb +145 -0
- data/spec/flipper/cloud/telemetry_spec.rb +156 -0
- data/spec/flipper/cloud_spec.rb +180 -0
- data/spec/flipper/configuration_spec.rb +17 -0
- data/spec/flipper/dsl_spec.rb +54 -73
- data/spec/flipper/engine_spec.rb +291 -0
- data/spec/flipper/export_spec.rb +13 -0
- data/spec/flipper/exporter_spec.rb +16 -0
- data/spec/flipper/exporters/json/export_spec.rb +60 -0
- data/spec/flipper/exporters/json/v1_spec.rb +33 -0
- data/spec/flipper/expression/builder_spec.rb +248 -0
- data/spec/flipper/expression_spec.rb +188 -0
- data/spec/flipper/expressions/all_spec.rb +15 -0
- data/spec/flipper/expressions/any_spec.rb +15 -0
- data/spec/flipper/expressions/boolean_spec.rb +15 -0
- data/spec/flipper/expressions/duration_spec.rb +43 -0
- data/spec/flipper/expressions/equal_spec.rb +24 -0
- data/spec/flipper/expressions/greater_than_or_equal_to_spec.rb +28 -0
- data/spec/flipper/expressions/greater_than_spec.rb +28 -0
- data/spec/flipper/expressions/less_than_or_equal_to_spec.rb +28 -0
- data/spec/flipper/expressions/less_than_spec.rb +32 -0
- data/spec/flipper/expressions/not_equal_spec.rb +15 -0
- data/spec/flipper/expressions/now_spec.rb +11 -0
- data/spec/flipper/expressions/number_spec.rb +21 -0
- data/spec/flipper/expressions/percentage_of_actors_spec.rb +20 -0
- data/spec/flipper/expressions/percentage_spec.rb +15 -0
- data/spec/flipper/expressions/property_spec.rb +13 -0
- data/spec/flipper/expressions/random_spec.rb +9 -0
- data/spec/flipper/expressions/string_spec.rb +11 -0
- data/spec/flipper/expressions/time_spec.rb +13 -0
- data/spec/flipper/feature_check_context_spec.rb +17 -17
- data/spec/flipper/feature_spec.rb +436 -33
- data/spec/flipper/gate_values_spec.rb +2 -33
- data/spec/flipper/gates/boolean_spec.rb +1 -1
- data/spec/flipper/gates/expression_spec.rb +108 -0
- data/spec/flipper/gates/group_spec.rb +2 -3
- data/spec/flipper/gates/percentage_of_actors_spec.rb +61 -5
- data/spec/flipper/gates/percentage_of_time_spec.rb +2 -2
- data/spec/flipper/identifier_spec.rb +4 -5
- data/spec/flipper/instrumentation/log_subscriber_spec.rb +15 -5
- data/spec/flipper/instrumentation/statsd_subscriber_spec.rb +25 -1
- data/spec/flipper/middleware/memoizer_spec.rb +67 -0
- data/spec/flipper/poller_spec.rb +47 -0
- data/spec/flipper/serializers/gzip_spec.rb +13 -0
- data/spec/flipper/serializers/json_spec.rb +13 -0
- data/spec/flipper/typecast_spec.rb +121 -6
- data/spec/flipper/types/actor_spec.rb +63 -46
- data/spec/flipper/types/group_spec.rb +2 -2
- data/spec/flipper_integration_spec.rb +168 -58
- data/spec/flipper_spec.rb +92 -28
- data/spec/spec_helper.rb +6 -13
- data/spec/support/actor_names.yml +1 -0
- data/spec/support/climate_control.rb +7 -0
- data/spec/support/fake_backoff_policy.rb +15 -0
- data/spec/support/skippable.rb +18 -0
- data/spec/support/spec_helpers.rb +11 -3
- metadata +166 -13
- data/.github/workflows/release.yml +0 -44
- data/.tool-versions +0 -1
- data/lib/flipper/railtie.rb +0 -47
- data/spec/flipper/railtie_spec.rb +0 -109
@@ -0,0 +1,289 @@
|
|
1
|
+
require 'securerandom'
|
2
|
+
require 'flipper/cloud'
|
3
|
+
require 'flipper/cloud/middleware'
|
4
|
+
require 'flipper/adapters/operation_logger'
|
5
|
+
|
6
|
+
RSpec.describe Flipper::Cloud::Middleware do
|
7
|
+
let(:flipper) {
|
8
|
+
Flipper::Cloud.new(token: "regular") do |config|
|
9
|
+
config.local_adapter = Flipper::Adapters::OperationLogger.new(Flipper::Adapters::Memory.new)
|
10
|
+
config.sync_secret = "regular_tasty"
|
11
|
+
end
|
12
|
+
}
|
13
|
+
|
14
|
+
let(:env_flipper) {
|
15
|
+
Flipper::Cloud.new(token: "env") do |config|
|
16
|
+
config.local_adapter = Flipper::Adapters::OperationLogger.new(Flipper::Adapters::Memory.new)
|
17
|
+
config.sync_secret = "env_tasty"
|
18
|
+
end
|
19
|
+
}
|
20
|
+
|
21
|
+
let(:app) { Flipper::Cloud.app(flipper) }
|
22
|
+
let(:response_body) { JSON.generate({features: {}}) }
|
23
|
+
let(:request_body) {
|
24
|
+
JSON.generate({
|
25
|
+
"environment_id" => 1,
|
26
|
+
"webhook_id" => 1,
|
27
|
+
"delivery_id" => SecureRandom.uuid,
|
28
|
+
"action" => "sync",
|
29
|
+
})
|
30
|
+
}
|
31
|
+
let(:timestamp) { Time.now }
|
32
|
+
let(:signature) {
|
33
|
+
Flipper::Cloud::MessageVerifier.new(secret: flipper.sync_secret).generate(request_body, timestamp)
|
34
|
+
}
|
35
|
+
let(:signature_header_value) {
|
36
|
+
Flipper::Cloud::MessageVerifier.new(secret: "").header(signature, timestamp)
|
37
|
+
}
|
38
|
+
|
39
|
+
context 'when initializing middleware with flipper instance' do
|
40
|
+
let(:app) { Flipper::Cloud.app(flipper) }
|
41
|
+
|
42
|
+
it 'uses instance to sync' do
|
43
|
+
Flipper.register(:admins) { |*args| false }
|
44
|
+
Flipper.register(:staff) { |*args| false }
|
45
|
+
Flipper.register(:basic) { |*args| false }
|
46
|
+
Flipper.register(:plus) { |*args| false }
|
47
|
+
Flipper.register(:premium) { |*args| false }
|
48
|
+
|
49
|
+
stub = stub_request_for_token('regular')
|
50
|
+
env = {
|
51
|
+
"HTTP_FLIPPER_CLOUD_SIGNATURE" => signature_header_value,
|
52
|
+
}
|
53
|
+
post '/', request_body, env
|
54
|
+
|
55
|
+
expect(last_response.status).to eq(200)
|
56
|
+
expect(JSON.parse(last_response.body)).to eq({
|
57
|
+
"groups" => [
|
58
|
+
{"name" => "admins"},
|
59
|
+
{"name" => "staff"},
|
60
|
+
{"name" => "basic"},
|
61
|
+
{"name" => "plus"},
|
62
|
+
{"name" => "premium"},
|
63
|
+
],
|
64
|
+
})
|
65
|
+
expect(stub).to have_been_requested
|
66
|
+
end
|
67
|
+
end
|
68
|
+
|
69
|
+
context 'when signature is invalid' do
|
70
|
+
let(:app) { Flipper::Cloud.app(flipper) }
|
71
|
+
let(:signature) {
|
72
|
+
Flipper::Cloud::MessageVerifier.new(secret: "nope").generate(request_body, timestamp)
|
73
|
+
}
|
74
|
+
|
75
|
+
it 'uses instance to sync' do
|
76
|
+
stub = stub_request_for_token('regular')
|
77
|
+
env = {
|
78
|
+
"HTTP_FLIPPER_CLOUD_SIGNATURE" => signature_header_value,
|
79
|
+
}
|
80
|
+
post '/', request_body, env
|
81
|
+
|
82
|
+
expect(last_response.status).to eq(400)
|
83
|
+
expect(stub).not_to have_been_requested
|
84
|
+
end
|
85
|
+
end
|
86
|
+
|
87
|
+
context "when flipper cloud responds with 402" do
|
88
|
+
let(:app) { Flipper::Cloud.app(flipper) }
|
89
|
+
|
90
|
+
it "results in 402" do
|
91
|
+
Flipper.register(:admins) { |*args| false }
|
92
|
+
Flipper.register(:staff) { |*args| false }
|
93
|
+
Flipper.register(:basic) { |*args| false }
|
94
|
+
Flipper.register(:plus) { |*args| false }
|
95
|
+
Flipper.register(:premium) { |*args| false }
|
96
|
+
|
97
|
+
stub = stub_request_for_token('regular', status: 402)
|
98
|
+
env = {
|
99
|
+
"HTTP_FLIPPER_CLOUD_SIGNATURE" => signature_header_value,
|
100
|
+
}
|
101
|
+
post '/', request_body, env
|
102
|
+
|
103
|
+
expect(last_response.status).to eq(402)
|
104
|
+
expect(last_response.headers["Flipper-Cloud-Response-Error-Class"]).to eq("Flipper::Adapters::Http::Error")
|
105
|
+
expect(last_response.headers["Flipper-Cloud-Response-Error-Message"]).to include("Failed with status: 402")
|
106
|
+
expect(stub).to have_been_requested
|
107
|
+
end
|
108
|
+
end
|
109
|
+
|
110
|
+
context "when flipper cloud responds with non-402 and non-2xx code" do
|
111
|
+
let(:app) { Flipper::Cloud.app(flipper) }
|
112
|
+
|
113
|
+
it "results in 500" do
|
114
|
+
Flipper.register(:admins) { |*args| false }
|
115
|
+
Flipper.register(:staff) { |*args| false }
|
116
|
+
Flipper.register(:basic) { |*args| false }
|
117
|
+
Flipper.register(:plus) { |*args| false }
|
118
|
+
Flipper.register(:premium) { |*args| false }
|
119
|
+
|
120
|
+
stub = stub_request_for_token('regular', status: 503)
|
121
|
+
env = {
|
122
|
+
"HTTP_FLIPPER_CLOUD_SIGNATURE" => signature_header_value,
|
123
|
+
}
|
124
|
+
post '/', request_body, env
|
125
|
+
|
126
|
+
expect(last_response.status).to eq(500)
|
127
|
+
expect(last_response.headers["Flipper-Cloud-Response-Error-Class"]).to eq("Flipper::Adapters::Http::Error")
|
128
|
+
expect(last_response.headers["Flipper-Cloud-Response-Error-Message"]).to include("Failed with status: 503")
|
129
|
+
expect(stub).to have_been_requested
|
130
|
+
end
|
131
|
+
end
|
132
|
+
|
133
|
+
context "when flipper cloud responds with timeout" do
|
134
|
+
let(:app) { Flipper::Cloud.app(flipper) }
|
135
|
+
|
136
|
+
it "results in 500" do
|
137
|
+
Flipper.register(:admins) { |*args| false }
|
138
|
+
Flipper.register(:staff) { |*args| false }
|
139
|
+
Flipper.register(:basic) { |*args| false }
|
140
|
+
Flipper.register(:plus) { |*args| false }
|
141
|
+
Flipper.register(:premium) { |*args| false }
|
142
|
+
|
143
|
+
stub = stub_request_for_token('regular', status: :timeout)
|
144
|
+
env = {
|
145
|
+
"HTTP_FLIPPER_CLOUD_SIGNATURE" => signature_header_value,
|
146
|
+
}
|
147
|
+
post '/', request_body, env
|
148
|
+
|
149
|
+
expect(last_response.status).to eq(500)
|
150
|
+
expect(last_response.headers["Flipper-Cloud-Response-Error-Class"]).to eq("Net::OpenTimeout")
|
151
|
+
expect(last_response.headers["Flipper-Cloud-Response-Error-Message"]).to eq("execution expired")
|
152
|
+
expect(stub).to have_been_requested
|
153
|
+
end
|
154
|
+
end
|
155
|
+
|
156
|
+
context 'when initialized with flipper instance and flipper instance in env' do
|
157
|
+
let(:app) { Flipper::Cloud.app(flipper) }
|
158
|
+
let(:signature) {
|
159
|
+
Flipper::Cloud::MessageVerifier.new(secret: env_flipper.sync_secret).generate(request_body, timestamp)
|
160
|
+
}
|
161
|
+
|
162
|
+
it 'uses env instance to sync' do
|
163
|
+
stub = stub_request_for_token('env')
|
164
|
+
env = {
|
165
|
+
"HTTP_FLIPPER_CLOUD_SIGNATURE" => signature_header_value,
|
166
|
+
'flipper' => env_flipper,
|
167
|
+
}
|
168
|
+
post '/', request_body, env
|
169
|
+
|
170
|
+
expect(last_response.status).to eq(200)
|
171
|
+
expect(stub).to have_been_requested
|
172
|
+
end
|
173
|
+
end
|
174
|
+
|
175
|
+
context 'when initialized without flipper instance but flipper instance in env' do
|
176
|
+
let(:app) { Flipper::Cloud.app }
|
177
|
+
let(:signature) {
|
178
|
+
Flipper::Cloud::MessageVerifier.new(secret: env_flipper.sync_secret).generate(request_body, timestamp)
|
179
|
+
}
|
180
|
+
|
181
|
+
it 'uses env instance to sync' do
|
182
|
+
stub = stub_request_for_token('env')
|
183
|
+
env = {
|
184
|
+
"HTTP_FLIPPER_CLOUD_SIGNATURE" => signature_header_value,
|
185
|
+
'flipper' => env_flipper,
|
186
|
+
}
|
187
|
+
post '/', request_body, env
|
188
|
+
|
189
|
+
expect(last_response.status).to eq(200)
|
190
|
+
expect(stub).to have_been_requested
|
191
|
+
end
|
192
|
+
end
|
193
|
+
|
194
|
+
context 'when initialized with env_key' do
|
195
|
+
let(:app) { Flipper::Cloud.app(flipper, env_key: 'flipper_cloud') }
|
196
|
+
let(:signature) {
|
197
|
+
Flipper::Cloud::MessageVerifier.new(secret: env_flipper.sync_secret).generate(request_body, timestamp)
|
198
|
+
}
|
199
|
+
|
200
|
+
it 'uses provided env key instead of default' do
|
201
|
+
stub = stub_request_for_token('env')
|
202
|
+
env = {
|
203
|
+
"HTTP_FLIPPER_CLOUD_SIGNATURE" => signature_header_value,
|
204
|
+
'flipper' => flipper,
|
205
|
+
'flipper_cloud' => env_flipper,
|
206
|
+
}
|
207
|
+
post '/', request_body, env
|
208
|
+
|
209
|
+
expect(last_response.status).to eq(200)
|
210
|
+
expect(stub).to have_been_requested
|
211
|
+
end
|
212
|
+
end
|
213
|
+
|
214
|
+
context 'when initializing lazily with a block' do
|
215
|
+
let(:app) { Flipper::Cloud.app(-> { flipper }) }
|
216
|
+
|
217
|
+
it 'works' do
|
218
|
+
stub = stub_request_for_token('regular')
|
219
|
+
env = {
|
220
|
+
"HTTP_FLIPPER_CLOUD_SIGNATURE" => signature_header_value,
|
221
|
+
}
|
222
|
+
post '/', request_body, env
|
223
|
+
|
224
|
+
expect(last_response.status).to eq(200)
|
225
|
+
expect(stub).to have_been_requested
|
226
|
+
end
|
227
|
+
end
|
228
|
+
|
229
|
+
context 'when using older /webhooks path' do
|
230
|
+
let(:app) { Flipper::Cloud.app(flipper) }
|
231
|
+
|
232
|
+
it 'uses instance to sync' do
|
233
|
+
Flipper.register(:admins) { |*args| false }
|
234
|
+
Flipper.register(:staff) { |*args| false }
|
235
|
+
Flipper.register(:basic) { |*args| false }
|
236
|
+
Flipper.register(:plus) { |*args| false }
|
237
|
+
Flipper.register(:premium) { |*args| false }
|
238
|
+
|
239
|
+
stub = stub_request_for_token('regular')
|
240
|
+
env = {
|
241
|
+
"HTTP_FLIPPER_CLOUD_SIGNATURE" => signature_header_value,
|
242
|
+
}
|
243
|
+
post '/webhooks', request_body, env
|
244
|
+
|
245
|
+
expect(last_response.status).to eq(200)
|
246
|
+
expect(JSON.parse(last_response.body)).to eq({
|
247
|
+
"groups" => [
|
248
|
+
{"name" => "admins"},
|
249
|
+
{"name" => "staff"},
|
250
|
+
{"name" => "basic"},
|
251
|
+
{"name" => "plus"},
|
252
|
+
{"name" => "premium"},
|
253
|
+
],
|
254
|
+
})
|
255
|
+
expect(stub).to have_been_requested
|
256
|
+
end
|
257
|
+
end
|
258
|
+
|
259
|
+
describe 'Request method unsupported' do
|
260
|
+
it 'skips middleware' do
|
261
|
+
get '/'
|
262
|
+
expect(last_response.status).to eq(404)
|
263
|
+
expect(last_response.content_type).to eq("application/json")
|
264
|
+
expect(last_response.body).to eq("{}")
|
265
|
+
end
|
266
|
+
end
|
267
|
+
|
268
|
+
describe 'Inspecting the built Rack app' do
|
269
|
+
it 'returns a String' do
|
270
|
+
expect(Flipper::Cloud.app(flipper).inspect).to eq("Flipper::Cloud")
|
271
|
+
end
|
272
|
+
end
|
273
|
+
|
274
|
+
private
|
275
|
+
|
276
|
+
def stub_request_for_token(token, status: 200)
|
277
|
+
stub = stub_request(:get, "https://www.flippercloud.io/adapter/features?exclude_gate_names=true").
|
278
|
+
with({
|
279
|
+
headers: {
|
280
|
+
'Flipper-Cloud-Token' => token,
|
281
|
+
},
|
282
|
+
})
|
283
|
+
if status == :timeout
|
284
|
+
stub.to_timeout
|
285
|
+
else
|
286
|
+
stub.to_return(status: status, body: response_body, headers: {})
|
287
|
+
end
|
288
|
+
end
|
289
|
+
end
|
@@ -0,0 +1,108 @@
|
|
1
|
+
require 'flipper/cloud/telemetry/backoff_policy'
|
2
|
+
|
3
|
+
RSpec.describe Flipper::Cloud::Telemetry::BackoffPolicy do
|
4
|
+
context "#initialize" do
|
5
|
+
it "with no options" do
|
6
|
+
policy = described_class.new
|
7
|
+
expect(policy.min_timeout_ms).to eq(1_000)
|
8
|
+
expect(policy.max_timeout_ms).to eq(30_000)
|
9
|
+
expect(policy.multiplier).to eq(1.5)
|
10
|
+
expect(policy.randomization_factor).to eq(0.5)
|
11
|
+
end
|
12
|
+
|
13
|
+
it "with options" do
|
14
|
+
policy = described_class.new({
|
15
|
+
min_timeout_ms: 1234,
|
16
|
+
max_timeout_ms: 5678,
|
17
|
+
multiplier: 24,
|
18
|
+
randomization_factor: 0.4,
|
19
|
+
})
|
20
|
+
expect(policy.min_timeout_ms).to eq(1234)
|
21
|
+
expect(policy.max_timeout_ms).to eq(5678)
|
22
|
+
expect(policy.multiplier).to eq(24)
|
23
|
+
expect(policy.randomization_factor).to eq(0.4)
|
24
|
+
end
|
25
|
+
|
26
|
+
it "with min higher than max" do
|
27
|
+
expect {
|
28
|
+
described_class.new({
|
29
|
+
min_timeout_ms: 2,
|
30
|
+
max_timeout_ms: 1,
|
31
|
+
})
|
32
|
+
}.to raise_error(ArgumentError, ":min_timeout_ms (2) must be <= :max_timeout_ms (1)")
|
33
|
+
end
|
34
|
+
|
35
|
+
it "with invalid min_timeout_ms" do
|
36
|
+
expect {
|
37
|
+
described_class.new({
|
38
|
+
min_timeout_ms: -1,
|
39
|
+
})
|
40
|
+
}.to raise_error(ArgumentError, ":min_timeout_ms must be >= 0 but was -1")
|
41
|
+
end
|
42
|
+
|
43
|
+
it "with invalid max_timeout_ms" do
|
44
|
+
expect {
|
45
|
+
described_class.new({
|
46
|
+
max_timeout_ms: -1,
|
47
|
+
})
|
48
|
+
}.to raise_error(ArgumentError, ":max_timeout_ms must be >= 0 but was -1")
|
49
|
+
end
|
50
|
+
|
51
|
+
it "from env" do
|
52
|
+
env = {
|
53
|
+
"FLIPPER_BACKOFF_MIN_TIMEOUT_MS" => "1000",
|
54
|
+
"FLIPPER_BACKOFF_MAX_TIMEOUT_MS" => "2000",
|
55
|
+
"FLIPPER_BACKOFF_MULTIPLIER" => "1.9",
|
56
|
+
"FLIPPER_BACKOFF_RANDOMIZATION_FACTOR" => "0.1",
|
57
|
+
}
|
58
|
+
with_env env do
|
59
|
+
policy = described_class.new
|
60
|
+
expect(policy.min_timeout_ms).to eq(1000)
|
61
|
+
expect(policy.max_timeout_ms).to eq(2000)
|
62
|
+
expect(policy.multiplier).to eq(1.9)
|
63
|
+
expect(policy.randomization_factor).to eq(0.1)
|
64
|
+
end
|
65
|
+
end
|
66
|
+
end
|
67
|
+
|
68
|
+
context "#next_interval" do
|
69
|
+
it "works" do
|
70
|
+
policy = described_class.new({
|
71
|
+
min_timeout_ms: 1_000,
|
72
|
+
max_timeout_ms: 10_000,
|
73
|
+
multiplier: 2,
|
74
|
+
randomization_factor: 0.5,
|
75
|
+
})
|
76
|
+
|
77
|
+
expect(policy.next_interval).to be_within(500).of(1000)
|
78
|
+
expect(policy.next_interval).to be_within(1000).of(2000)
|
79
|
+
expect(policy.next_interval).to be_within(2000).of(4000)
|
80
|
+
expect(policy.next_interval).to be_within(4000).of(8000)
|
81
|
+
end
|
82
|
+
|
83
|
+
it "caps maximum duration at max_timeout_secs" do
|
84
|
+
policy = described_class.new({
|
85
|
+
min_timeout_ms: 1_000,
|
86
|
+
max_timeout_ms: 10_000,
|
87
|
+
multiplier: 2,
|
88
|
+
randomization_factor: 0.5,
|
89
|
+
})
|
90
|
+
10.times { policy.next_interval }
|
91
|
+
expect(policy.next_interval).to eq(10_000)
|
92
|
+
end
|
93
|
+
end
|
94
|
+
|
95
|
+
it "can reset" do
|
96
|
+
policy = described_class.new({
|
97
|
+
min_timeout_ms: 1_000,
|
98
|
+
max_timeout_ms: 10_000,
|
99
|
+
multiplier: 2,
|
100
|
+
randomization_factor: 0.5,
|
101
|
+
})
|
102
|
+
10.times { policy.next_interval }
|
103
|
+
|
104
|
+
expect(policy.attempts).to eq(10)
|
105
|
+
policy.reset
|
106
|
+
expect(policy.attempts).to eq(0)
|
107
|
+
end
|
108
|
+
end
|
@@ -0,0 +1,87 @@
|
|
1
|
+
require 'flipper/cloud/telemetry/metric'
|
2
|
+
|
3
|
+
RSpec.describe Flipper::Cloud::Telemetry::Metric do
|
4
|
+
it 'has key, result and time' do
|
5
|
+
metric = described_class.new(:search, true, 1696793160)
|
6
|
+
expect(metric.key).to eq(:search)
|
7
|
+
expect(metric.result).to eq(true)
|
8
|
+
expect(metric.time).to eq(1696793160)
|
9
|
+
end
|
10
|
+
|
11
|
+
it "clamps time to minute" do
|
12
|
+
metric = described_class.new(:search, true, 1696793204)
|
13
|
+
expect(metric.time).to eq(1696793160)
|
14
|
+
end
|
15
|
+
|
16
|
+
describe "#eql?" do
|
17
|
+
it "returns true when key, time and result are the same" do
|
18
|
+
metric = described_class.new(:search, true, 1696793204)
|
19
|
+
other = described_class.new(:search, true, 1696793204)
|
20
|
+
expect(metric.eql?(other)).to be(true)
|
21
|
+
end
|
22
|
+
|
23
|
+
it "returns false for other class" do
|
24
|
+
metric = described_class.new(:search, true, 1696793204)
|
25
|
+
other = Object.new
|
26
|
+
expect(metric.eql?(other)).to be(false)
|
27
|
+
end
|
28
|
+
|
29
|
+
it "returns false for sub class" do
|
30
|
+
metric = described_class.new(:search, true, 1696793204)
|
31
|
+
other = Class.new(described_class).new(:search, true, 1696793204)
|
32
|
+
expect(metric.eql?(other)).to be(false)
|
33
|
+
end
|
34
|
+
|
35
|
+
it "returns false if key is different" do
|
36
|
+
metric = described_class.new(:search, true, 1696793204)
|
37
|
+
other = described_class.new(:other, true, 1696793204)
|
38
|
+
expect(metric.eql?(other)).to be(false)
|
39
|
+
end
|
40
|
+
|
41
|
+
it "returns false if time is different" do
|
42
|
+
metric = described_class.new(:search, true, 1696793204)
|
43
|
+
other = described_class.new(:search, true, 1696793204 - 60 - 60)
|
44
|
+
expect(metric.eql?(other)).to be(false)
|
45
|
+
end
|
46
|
+
|
47
|
+
it "returns true with different times if times are in same minute" do
|
48
|
+
metric = described_class.new(:search, true, 1696793204)
|
49
|
+
other = described_class.new(:search, true, 1696793206)
|
50
|
+
expect(metric.eql?(other)).to be(true)
|
51
|
+
end
|
52
|
+
|
53
|
+
it "returns false if result is different" do
|
54
|
+
metric = described_class.new(:search, true, 1696793204)
|
55
|
+
other = described_class.new(:search, false, 1696793204)
|
56
|
+
expect(metric.eql?(other)).to be(false)
|
57
|
+
end
|
58
|
+
end
|
59
|
+
|
60
|
+
describe "#hash" do
|
61
|
+
it "returns hash based on class, key, time and result" do
|
62
|
+
metric = described_class.new(:search, true, 1696793204)
|
63
|
+
expect(metric.hash).to eq([described_class, metric.key, metric.time, metric.result].hash)
|
64
|
+
end
|
65
|
+
end
|
66
|
+
|
67
|
+
describe "#as_json" do
|
68
|
+
it "returns key time and result" do
|
69
|
+
metric = described_class.new(:search, true, 1696793160)
|
70
|
+
expect(metric.as_json).to eq({
|
71
|
+
"key" => "search",
|
72
|
+
"result" => true,
|
73
|
+
"time" => 1696793160,
|
74
|
+
})
|
75
|
+
end
|
76
|
+
|
77
|
+
it "can include other hashes" do
|
78
|
+
metric = described_class.new(:search, true, 1696793160)
|
79
|
+
expect(metric.as_json(with: {"value" => 2})).to eq({
|
80
|
+
"key" => "search",
|
81
|
+
"result" => true,
|
82
|
+
"time" => 1696793160,
|
83
|
+
"value" => 2,
|
84
|
+
})
|
85
|
+
end
|
86
|
+
end
|
87
|
+
end
|
@@ -0,0 +1,58 @@
|
|
1
|
+
require 'flipper/cloud/telemetry/metric_storage'
|
2
|
+
require 'flipper/cloud/telemetry/metric'
|
3
|
+
|
4
|
+
RSpec.describe Flipper::Cloud::Telemetry::MetricStorage do
|
5
|
+
describe "#increment" do
|
6
|
+
it "increments the counter for the metric" do
|
7
|
+
metric_storage = described_class.new
|
8
|
+
storage = metric_storage.instance_variable_get(:@storage)
|
9
|
+
metric = Flipper::Cloud::Telemetry::Metric.new(:search, true, 1696793160)
|
10
|
+
other = Flipper::Cloud::Telemetry::Metric.new(:search, false, 1696793160)
|
11
|
+
|
12
|
+
metric_storage.increment(metric)
|
13
|
+
expect(storage[metric].value).to be(1)
|
14
|
+
|
15
|
+
5.times { metric_storage.increment(metric) }
|
16
|
+
expect(storage[metric].value).to be(6)
|
17
|
+
|
18
|
+
metric_storage.increment(other)
|
19
|
+
expect(storage[other].value).to be(1)
|
20
|
+
end
|
21
|
+
end
|
22
|
+
|
23
|
+
describe "#drain" do
|
24
|
+
it "returns clears metrics and return hash" do
|
25
|
+
metric_storage = described_class.new
|
26
|
+
storage = metric_storage.instance_variable_get(:@storage)
|
27
|
+
storage[Flipper::Cloud::Telemetry::Metric.new(:search, true, 1696793160)] = Concurrent::AtomicFixnum.new(10)
|
28
|
+
storage[Flipper::Cloud::Telemetry::Metric.new(:search, false, 1696793161)] = Concurrent::AtomicFixnum.new(15)
|
29
|
+
storage[Flipper::Cloud::Telemetry::Metric.new(:plausible, true, 1696793162)] = Concurrent::AtomicFixnum.new(25)
|
30
|
+
storage[Flipper::Cloud::Telemetry::Metric.new(:administrator, true, 1696793164)] = Concurrent::AtomicFixnum.new(1)
|
31
|
+
storage[Flipper::Cloud::Telemetry::Metric.new(:administrator, false, 1696793164)] = Concurrent::AtomicFixnum.new(24)
|
32
|
+
|
33
|
+
drained = metric_storage.drain
|
34
|
+
expect(drained).to be_frozen
|
35
|
+
expect(drained).to eq({
|
36
|
+
Flipper::Cloud::Telemetry::Metric.new(:search, true, 1696793160) => 10,
|
37
|
+
Flipper::Cloud::Telemetry::Metric.new(:search, false, 1696793161) => 15,
|
38
|
+
Flipper::Cloud::Telemetry::Metric.new(:plausible, true, 1696793162) => 25,
|
39
|
+
Flipper::Cloud::Telemetry::Metric.new(:administrator, true, 1696793164) => 1,
|
40
|
+
Flipper::Cloud::Telemetry::Metric.new(:administrator, false, 1696793164) => 24,
|
41
|
+
})
|
42
|
+
expect(storage.keys).to eq([])
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
46
|
+
describe "#empty?" do
|
47
|
+
it "returns true if empty" do
|
48
|
+
metric_storage = described_class.new
|
49
|
+
expect(metric_storage).to be_empty
|
50
|
+
end
|
51
|
+
|
52
|
+
it "returns false if not empty" do
|
53
|
+
metric_storage = described_class.new
|
54
|
+
metric_storage.increment Flipper::Cloud::Telemetry::Metric.new(:search, true, 1696793160)
|
55
|
+
expect(metric_storage).not_to be_empty
|
56
|
+
end
|
57
|
+
end
|
58
|
+
end
|
@@ -0,0 +1,145 @@
|
|
1
|
+
require "stringio"
|
2
|
+
require 'flipper/cloud/configuration'
|
3
|
+
require 'flipper/cloud/telemetry/submitter'
|
4
|
+
|
5
|
+
RSpec.describe Flipper::Cloud::Telemetry::Submitter do
|
6
|
+
let(:cloud_configuration) {
|
7
|
+
Flipper::Cloud::Configuration.new({token: "asdf"})
|
8
|
+
}
|
9
|
+
let(:fake_backoff_policy) { FakeBackoffPolicy.new }
|
10
|
+
let(:subject) { described_class.new(cloud_configuration, backoff_policy: fake_backoff_policy) }
|
11
|
+
|
12
|
+
describe "#initialize" do
|
13
|
+
it "works with cloud_configuration" do
|
14
|
+
submitter = described_class.new(cloud_configuration)
|
15
|
+
expect(submitter.cloud_configuration).to eq(cloud_configuration)
|
16
|
+
end
|
17
|
+
end
|
18
|
+
|
19
|
+
describe "#call" do
|
20
|
+
let(:enabled_metrics) {
|
21
|
+
{
|
22
|
+
Flipper::Cloud::Telemetry::Metric.new(:search, true, 1696793160) => 10,
|
23
|
+
Flipper::Cloud::Telemetry::Metric.new(:search, false, 1696793161) => 15,
|
24
|
+
Flipper::Cloud::Telemetry::Metric.new(:plausible, true, 1696793162) => 25,
|
25
|
+
Flipper::Cloud::Telemetry::Metric.new(:administrator, true, 1696793164) => 1,
|
26
|
+
Flipper::Cloud::Telemetry::Metric.new(:administrator, false, 1696793164) => 24,
|
27
|
+
}
|
28
|
+
}
|
29
|
+
|
30
|
+
it "does not submit blank metrics" do
|
31
|
+
expect(subject.call({})).to be(nil)
|
32
|
+
end
|
33
|
+
|
34
|
+
it "submits present metrics" do
|
35
|
+
expected_body = {
|
36
|
+
"request_id" => subject.request_id,
|
37
|
+
"enabled_metrics" =>[
|
38
|
+
{"key" => "search", "time" => 1696793160, "result" => true, "value" => 10},
|
39
|
+
{"key" => "search", "time" => 1696793160, "result" => false, "value" => 15},
|
40
|
+
{"key" => "plausible", "time" => 1696793160, "result" => true, "value" => 25},
|
41
|
+
{"key" => "administrator", "time" => 1696793160, "result" => true, "value" => 1},
|
42
|
+
{"key" => "administrator", "time" => 1696793160, "result" => false, "value" => 24},
|
43
|
+
]
|
44
|
+
}
|
45
|
+
expected_headers = {
|
46
|
+
'Accept' => 'application/json',
|
47
|
+
'Client-Engine' => defined?(RUBY_ENGINE) ? RUBY_ENGINE : "",
|
48
|
+
'Client-Hostname' => Socket.gethostname,
|
49
|
+
'Client-Language' => 'ruby',
|
50
|
+
'Client-Language-Version' => "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})",
|
51
|
+
'Client-Pid' => Process.pid.to_s,
|
52
|
+
'Client-Platform' => RUBY_PLATFORM,
|
53
|
+
'Client-Thread' => Thread.current.object_id.to_s,
|
54
|
+
'Content-Encoding' => 'gzip',
|
55
|
+
'Content-Type' => 'application/json',
|
56
|
+
'Flipper-Cloud-Token' => 'asdf',
|
57
|
+
'Schema-Version' => 'V1',
|
58
|
+
'User-Agent' => "Flipper HTTP Adapter v#{Flipper::VERSION}",
|
59
|
+
}
|
60
|
+
stub_request(:post, "https://www.flippercloud.io/adapter/telemetry").
|
61
|
+
with(headers: expected_headers) { |request|
|
62
|
+
gunzipped = Flipper::Typecast.from_gzip(request.body)
|
63
|
+
body = Flipper::Typecast.from_json(gunzipped)
|
64
|
+
body == expected_body
|
65
|
+
}.to_return(status: 200, body: "{}", headers: {})
|
66
|
+
subject.call(enabled_metrics)
|
67
|
+
end
|
68
|
+
|
69
|
+
it "defaults backoff_policy" do
|
70
|
+
stub_request(:post, "https://www.flippercloud.io/adapter/telemetry").
|
71
|
+
to_return(status: 429, body: "{}", headers: {}).
|
72
|
+
to_return(status: 200, body: "{}", headers: {})
|
73
|
+
instance = described_class.new(cloud_configuration)
|
74
|
+
expect(instance.backoff_policy.min_timeout_ms).to eq(1_000)
|
75
|
+
expect(instance.backoff_policy.max_timeout_ms).to eq(30_000)
|
76
|
+
end
|
77
|
+
|
78
|
+
it "tries 10 times by default" do
|
79
|
+
stub_request(:post, "https://www.flippercloud.io/adapter/telemetry").
|
80
|
+
to_return(status: 500, body: "{}", headers: {})
|
81
|
+
subject.call(enabled_metrics)
|
82
|
+
expect(subject.backoff_policy.retries).to eq(9) # 9 retries + 1 initial attempt
|
83
|
+
end
|
84
|
+
|
85
|
+
[
|
86
|
+
EOFError,
|
87
|
+
Errno::ECONNABORTED,
|
88
|
+
Errno::ECONNREFUSED,
|
89
|
+
Errno::ECONNRESET,
|
90
|
+
Errno::EHOSTUNREACH,
|
91
|
+
Errno::EINVAL,
|
92
|
+
Errno::ENETUNREACH,
|
93
|
+
Errno::ENOTSOCK,
|
94
|
+
Errno::EPIPE,
|
95
|
+
Errno::ETIMEDOUT,
|
96
|
+
Net::HTTPBadResponse,
|
97
|
+
Net::HTTPHeaderSyntaxError,
|
98
|
+
Net::ProtocolError,
|
99
|
+
Net::ReadTimeout,
|
100
|
+
OpenSSL::SSL::SSLError,
|
101
|
+
SocketError,
|
102
|
+
Timeout::Error, # Also covers subclasses like Net::OpenTimeout.
|
103
|
+
].each do |error_class|
|
104
|
+
it "retries on #{error_class}" do
|
105
|
+
stub_request(:post, "https://www.flippercloud.io/adapter/telemetry").
|
106
|
+
to_raise(error_class)
|
107
|
+
subject.call(enabled_metrics)
|
108
|
+
expect(subject.backoff_policy.retries).to eq(9)
|
109
|
+
end
|
110
|
+
end
|
111
|
+
|
112
|
+
it "retries on 429" do
|
113
|
+
stub_request(:post, "https://www.flippercloud.io/adapter/telemetry").
|
114
|
+
to_return(status: 429, body: "{}", headers: {}).
|
115
|
+
to_return(status: 429, body: "{}", headers: {}).
|
116
|
+
to_return(status: 200, body: "{}", headers: {})
|
117
|
+
subject.call(enabled_metrics)
|
118
|
+
expect(subject.backoff_policy.retries).to eq(2)
|
119
|
+
end
|
120
|
+
|
121
|
+
it "retries on 500" do
|
122
|
+
stub_request(:post, "https://www.flippercloud.io/adapter/telemetry").
|
123
|
+
to_return(status: 500, body: "{}", headers: {}).
|
124
|
+
to_return(status: 503, body: "{}", headers: {}).
|
125
|
+
to_return(status: 502, body: "{}", headers: {}).
|
126
|
+
to_return(status: 200, body: "{}", headers: {})
|
127
|
+
subject.call(enabled_metrics)
|
128
|
+
expect(subject.backoff_policy.retries).to eq(3)
|
129
|
+
end
|
130
|
+
end
|
131
|
+
|
132
|
+
def with_telemetry_debug_logging(&block)
|
133
|
+
output = StringIO.new
|
134
|
+
original_logger = cloud_configuration.logger
|
135
|
+
|
136
|
+
begin
|
137
|
+
cloud_configuration.logger = Logger.new(output)
|
138
|
+
block.call
|
139
|
+
ensure
|
140
|
+
cloud_configuration.logger = original_logger
|
141
|
+
end
|
142
|
+
|
143
|
+
output.string
|
144
|
+
end
|
145
|
+
end
|