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.
Files changed (199) hide show
  1. checksums.yaml +4 -4
  2. data/.github/FUNDING.yml +1 -0
  3. data/.github/workflows/ci.yml +19 -13
  4. data/.github/workflows/examples.yml +32 -15
  5. data/Changelog.md +294 -154
  6. data/Gemfile +15 -10
  7. data/README.md +13 -11
  8. data/benchmark/enabled_ips.rb +10 -0
  9. data/benchmark/enabled_multiple_actors_ips.rb +20 -0
  10. data/benchmark/enabled_profile.rb +20 -0
  11. data/benchmark/instrumentation_ips.rb +21 -0
  12. data/benchmark/typecast_ips.rb +27 -0
  13. data/docs/images/flipper_cloud.png +0 -0
  14. data/examples/api/basic.ru +3 -4
  15. data/examples/api/custom_memoized.ru +3 -4
  16. data/examples/api/memoized.ru +3 -4
  17. data/examples/cloud/app.ru +12 -0
  18. data/examples/cloud/backoff_policy.rb +13 -0
  19. data/examples/cloud/basic.rb +22 -0
  20. data/examples/cloud/cloud_setup.rb +20 -0
  21. data/examples/cloud/forked.rb +36 -0
  22. data/examples/cloud/import.rb +17 -0
  23. data/examples/cloud/threaded.rb +33 -0
  24. data/examples/dsl.rb +1 -15
  25. data/examples/enabled_for_actor.rb +4 -2
  26. data/examples/expressions.rb +213 -0
  27. data/examples/mirroring.rb +59 -0
  28. data/examples/strict.rb +18 -0
  29. data/flipper-cloud.gemspec +19 -0
  30. data/flipper.gemspec +3 -5
  31. data/lib/flipper/actor.rb +6 -3
  32. data/lib/flipper/adapter.rb +33 -7
  33. data/lib/flipper/adapter_builder.rb +44 -0
  34. data/lib/flipper/adapters/dual_write.rb +1 -3
  35. data/lib/flipper/adapters/failover.rb +0 -4
  36. data/lib/flipper/adapters/failsafe.rb +0 -4
  37. data/lib/flipper/adapters/http/client.rb +26 -7
  38. data/lib/flipper/adapters/http/error.rb +1 -1
  39. data/lib/flipper/adapters/http.rb +29 -16
  40. data/lib/flipper/adapters/instrumented.rb +25 -6
  41. data/lib/flipper/adapters/memoizable.rb +33 -21
  42. data/lib/flipper/adapters/memory.rb +81 -46
  43. data/lib/flipper/adapters/operation_logger.rb +16 -7
  44. data/lib/flipper/adapters/poll/poller.rb +2 -125
  45. data/lib/flipper/adapters/poll.rb +5 -3
  46. data/lib/flipper/adapters/pstore.rb +17 -11
  47. data/lib/flipper/adapters/read_only.rb +4 -4
  48. data/lib/flipper/adapters/strict.rb +47 -0
  49. data/lib/flipper/adapters/sync/feature_synchronizer.rb +10 -1
  50. data/lib/flipper/adapters/sync.rb +0 -4
  51. data/lib/flipper/cloud/configuration.rb +258 -0
  52. data/lib/flipper/cloud/dsl.rb +27 -0
  53. data/lib/flipper/cloud/message_verifier.rb +95 -0
  54. data/lib/flipper/cloud/middleware.rb +63 -0
  55. data/lib/flipper/cloud/routes.rb +14 -0
  56. data/lib/flipper/cloud/telemetry/backoff_policy.rb +93 -0
  57. data/lib/flipper/cloud/telemetry/instrumenter.rb +26 -0
  58. data/lib/flipper/cloud/telemetry/metric.rb +39 -0
  59. data/lib/flipper/cloud/telemetry/metric_storage.rb +30 -0
  60. data/lib/flipper/cloud/telemetry/submitter.rb +98 -0
  61. data/lib/flipper/cloud/telemetry.rb +183 -0
  62. data/lib/flipper/cloud.rb +53 -0
  63. data/lib/flipper/configuration.rb +25 -4
  64. data/lib/flipper/dsl.rb +46 -45
  65. data/lib/flipper/engine.rb +88 -0
  66. data/lib/flipper/errors.rb +3 -3
  67. data/lib/flipper/export.rb +26 -0
  68. data/lib/flipper/exporter.rb +17 -0
  69. data/lib/flipper/exporters/json/export.rb +32 -0
  70. data/lib/flipper/exporters/json/v1.rb +33 -0
  71. data/lib/flipper/expression/builder.rb +73 -0
  72. data/lib/flipper/expression/constant.rb +25 -0
  73. data/lib/flipper/expression.rb +71 -0
  74. data/lib/flipper/expressions/all.rb +11 -0
  75. data/lib/flipper/expressions/any.rb +9 -0
  76. data/lib/flipper/expressions/boolean.rb +9 -0
  77. data/lib/flipper/expressions/comparable.rb +13 -0
  78. data/lib/flipper/expressions/duration.rb +28 -0
  79. data/lib/flipper/expressions/equal.rb +9 -0
  80. data/lib/flipper/expressions/greater_than.rb +9 -0
  81. data/lib/flipper/expressions/greater_than_or_equal_to.rb +9 -0
  82. data/lib/flipper/expressions/less_than.rb +9 -0
  83. data/lib/flipper/expressions/less_than_or_equal_to.rb +9 -0
  84. data/lib/flipper/expressions/not_equal.rb +9 -0
  85. data/lib/flipper/expressions/now.rb +9 -0
  86. data/lib/flipper/expressions/number.rb +9 -0
  87. data/lib/flipper/expressions/percentage.rb +9 -0
  88. data/lib/flipper/expressions/percentage_of_actors.rb +12 -0
  89. data/lib/flipper/expressions/property.rb +9 -0
  90. data/lib/flipper/expressions/random.rb +9 -0
  91. data/lib/flipper/expressions/string.rb +9 -0
  92. data/lib/flipper/expressions/time.rb +9 -0
  93. data/lib/flipper/feature.rb +87 -26
  94. data/lib/flipper/feature_check_context.rb +10 -6
  95. data/lib/flipper/gate.rb +13 -11
  96. data/lib/flipper/gate_values.rb +5 -18
  97. data/lib/flipper/gates/actor.rb +10 -17
  98. data/lib/flipper/gates/boolean.rb +1 -1
  99. data/lib/flipper/gates/expression.rb +75 -0
  100. data/lib/flipper/gates/group.rb +5 -7
  101. data/lib/flipper/gates/percentage_of_actors.rb +10 -13
  102. data/lib/flipper/gates/percentage_of_time.rb +1 -2
  103. data/lib/flipper/identifier.rb +2 -2
  104. data/lib/flipper/instrumentation/log_subscriber.rb +24 -5
  105. data/lib/flipper/instrumentation/statsd_subscriber.rb +2 -4
  106. data/lib/flipper/instrumentation/subscriber.rb +8 -1
  107. data/lib/flipper/metadata.rb +5 -1
  108. data/lib/flipper/middleware/memoizer.rb +30 -14
  109. data/lib/flipper/poller.rb +117 -0
  110. data/lib/flipper/serializers/gzip.rb +24 -0
  111. data/lib/flipper/serializers/json.rb +19 -0
  112. data/lib/flipper/spec/shared_adapter_specs.rb +95 -54
  113. data/lib/flipper/test/shared_adapter_test.rb +91 -48
  114. data/lib/flipper/typecast.rb +56 -15
  115. data/lib/flipper/types/actor.rb +13 -13
  116. data/lib/flipper/types/group.rb +4 -4
  117. data/lib/flipper/types/percentage.rb +1 -1
  118. data/lib/flipper/version.rb +1 -1
  119. data/lib/flipper.rb +47 -10
  120. data/spec/fixtures/flipper_pstore_1679087600.json +46 -0
  121. data/spec/flipper/adapter_builder_spec.rb +73 -0
  122. data/spec/flipper/adapter_spec.rb +30 -2
  123. data/spec/flipper/adapters/dual_write_spec.rb +2 -2
  124. data/spec/flipper/adapters/http_spec.rb +64 -8
  125. data/spec/flipper/adapters/instrumented_spec.rb +29 -11
  126. data/spec/flipper/adapters/memoizable_spec.rb +51 -31
  127. data/spec/flipper/adapters/memory_spec.rb +14 -3
  128. data/spec/flipper/adapters/operation_logger_spec.rb +31 -12
  129. data/spec/flipper/adapters/read_only_spec.rb +32 -17
  130. data/spec/flipper/adapters/strict_spec.rb +62 -0
  131. data/spec/flipper/adapters/sync/feature_synchronizer_spec.rb +27 -0
  132. data/spec/flipper/cloud/configuration_spec.rb +252 -0
  133. data/spec/flipper/cloud/dsl_spec.rb +82 -0
  134. data/spec/flipper/cloud/message_verifier_spec.rb +104 -0
  135. data/spec/flipper/cloud/middleware_spec.rb +289 -0
  136. data/spec/flipper/cloud/telemetry/backoff_policy_spec.rb +108 -0
  137. data/spec/flipper/cloud/telemetry/metric_spec.rb +87 -0
  138. data/spec/flipper/cloud/telemetry/metric_storage_spec.rb +58 -0
  139. data/spec/flipper/cloud/telemetry/submitter_spec.rb +145 -0
  140. data/spec/flipper/cloud/telemetry_spec.rb +156 -0
  141. data/spec/flipper/cloud_spec.rb +180 -0
  142. data/spec/flipper/configuration_spec.rb +17 -0
  143. data/spec/flipper/dsl_spec.rb +54 -73
  144. data/spec/flipper/engine_spec.rb +291 -0
  145. data/spec/flipper/export_spec.rb +13 -0
  146. data/spec/flipper/exporter_spec.rb +16 -0
  147. data/spec/flipper/exporters/json/export_spec.rb +60 -0
  148. data/spec/flipper/exporters/json/v1_spec.rb +33 -0
  149. data/spec/flipper/expression/builder_spec.rb +248 -0
  150. data/spec/flipper/expression_spec.rb +188 -0
  151. data/spec/flipper/expressions/all_spec.rb +15 -0
  152. data/spec/flipper/expressions/any_spec.rb +15 -0
  153. data/spec/flipper/expressions/boolean_spec.rb +15 -0
  154. data/spec/flipper/expressions/duration_spec.rb +43 -0
  155. data/spec/flipper/expressions/equal_spec.rb +24 -0
  156. data/spec/flipper/expressions/greater_than_or_equal_to_spec.rb +28 -0
  157. data/spec/flipper/expressions/greater_than_spec.rb +28 -0
  158. data/spec/flipper/expressions/less_than_or_equal_to_spec.rb +28 -0
  159. data/spec/flipper/expressions/less_than_spec.rb +32 -0
  160. data/spec/flipper/expressions/not_equal_spec.rb +15 -0
  161. data/spec/flipper/expressions/now_spec.rb +11 -0
  162. data/spec/flipper/expressions/number_spec.rb +21 -0
  163. data/spec/flipper/expressions/percentage_of_actors_spec.rb +20 -0
  164. data/spec/flipper/expressions/percentage_spec.rb +15 -0
  165. data/spec/flipper/expressions/property_spec.rb +13 -0
  166. data/spec/flipper/expressions/random_spec.rb +9 -0
  167. data/spec/flipper/expressions/string_spec.rb +11 -0
  168. data/spec/flipper/expressions/time_spec.rb +13 -0
  169. data/spec/flipper/feature_check_context_spec.rb +17 -17
  170. data/spec/flipper/feature_spec.rb +436 -33
  171. data/spec/flipper/gate_values_spec.rb +2 -33
  172. data/spec/flipper/gates/boolean_spec.rb +1 -1
  173. data/spec/flipper/gates/expression_spec.rb +108 -0
  174. data/spec/flipper/gates/group_spec.rb +2 -3
  175. data/spec/flipper/gates/percentage_of_actors_spec.rb +61 -5
  176. data/spec/flipper/gates/percentage_of_time_spec.rb +2 -2
  177. data/spec/flipper/identifier_spec.rb +4 -5
  178. data/spec/flipper/instrumentation/log_subscriber_spec.rb +15 -5
  179. data/spec/flipper/instrumentation/statsd_subscriber_spec.rb +25 -1
  180. data/spec/flipper/middleware/memoizer_spec.rb +67 -0
  181. data/spec/flipper/poller_spec.rb +47 -0
  182. data/spec/flipper/serializers/gzip_spec.rb +13 -0
  183. data/spec/flipper/serializers/json_spec.rb +13 -0
  184. data/spec/flipper/typecast_spec.rb +121 -6
  185. data/spec/flipper/types/actor_spec.rb +63 -46
  186. data/spec/flipper/types/group_spec.rb +2 -2
  187. data/spec/flipper_integration_spec.rb +168 -58
  188. data/spec/flipper_spec.rb +92 -28
  189. data/spec/spec_helper.rb +6 -13
  190. data/spec/support/actor_names.yml +1 -0
  191. data/spec/support/climate_control.rb +7 -0
  192. data/spec/support/fake_backoff_policy.rb +15 -0
  193. data/spec/support/skippable.rb +18 -0
  194. data/spec/support/spec_helpers.rb +11 -3
  195. metadata +166 -13
  196. data/.github/workflows/release.yml +0 -44
  197. data/.tool-versions +0 -1
  198. data/lib/flipper/railtie.rb +0 -47
  199. data/spec/flipper/railtie_spec.rb +0 -109
@@ -1,44 +0,0 @@
1
- # https://andrewm.codes/blog/automating-ruby-gem-releases-with-github-actions/
2
- name: release
3
-
4
- on:
5
- push:
6
- branches:
7
- - main
8
-
9
- jobs:
10
- release-please:
11
- runs-on: ubuntu-latest
12
- steps:
13
- - uses: google-github-actions/release-please-action@v3
14
- id: release
15
- with:
16
- release-type: ruby
17
- package-name: flipper
18
- bump-minor-pre-major: true
19
- version-file: "lib/flipper/version.rb"
20
- # Checkout code if release was created
21
- - uses: actions/checkout@v3
22
- if: ${{ steps.release.outputs.release_created }}
23
- # Setup ruby if a release was created
24
- - uses: ruby/setup-ruby@v1
25
- with:
26
- ruby-version: 3.0.0
27
- if: ${{ steps.release.outputs.release_created }}
28
- # Bundle install
29
- - run: bundle install
30
- if: ${{ steps.release.outputs.release_created }}
31
- # Publish
32
- - name: publish gem
33
- run: |
34
- mkdir -p $HOME/.gem
35
- touch $HOME/.gem/credentials
36
- chmod 0600 $HOME/.gem/credentials
37
- printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
38
- gem build *.gemspec
39
- gem push *.gem
40
- env:
41
- # Make sure to update the secret name
42
- # if yours isn't named RUBYGEMS_AUTH_TOKEN
43
- GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"
44
- if: ${{ steps.release.outputs.release_created }}
data/.tool-versions DELETED
@@ -1 +0,0 @@
1
- ruby 3.1.2
@@ -1,47 +0,0 @@
1
- module Flipper
2
- class Railtie < Rails::Railtie
3
- config.before_configuration do
4
- config.flipper = ActiveSupport::OrderedOptions.new.update(
5
- env_key: ENV.fetch('FLIPPER_ENV_KEY', 'flipper'),
6
- memoize: ENV.fetch('FLIPPER_MEMOIZE', 'true').casecmp('true').zero?,
7
- preload: ENV.fetch('FLIPPER_PRELOAD', 'true').casecmp('true').zero?,
8
- instrumenter: ENV.fetch('FLIPPER_INSTRUMENTER', 'ActiveSupport::Notifications').constantize,
9
- log: ENV.fetch('FLIPPER_LOG', 'true').casecmp('true').zero?
10
- )
11
- end
12
-
13
- initializer "flipper.identifier" do
14
- ActiveSupport.on_load(:active_record) do
15
- ActiveRecord::Base.include Flipper::Identifier
16
- end
17
- end
18
-
19
- initializer "flipper.default", before: :load_config_initializers do |app|
20
- Flipper.configure do |config|
21
- config.default do
22
- Flipper.new(config.adapter, instrumenter: app.config.flipper.instrumenter)
23
- end
24
- end
25
- end
26
-
27
- initializer "flipper.log", after: :load_config_initializers do |app|
28
- flipper = app.config.flipper
29
-
30
- if flipper.log && flipper.instrumenter == ActiveSupport::Notifications
31
- require "flipper/instrumentation/log_subscriber"
32
- end
33
- end
34
-
35
- initializer "flipper.memoizer", after: :load_config_initializers do |app|
36
- flipper = app.config.flipper
37
-
38
- if flipper.memoize
39
- app.middleware.use Flipper::Middleware::Memoizer, {
40
- env_key: flipper.env_key,
41
- preload: flipper.preload,
42
- if: flipper.memoize.respond_to?(:call) ? flipper.memoize : nil
43
- }
44
- end
45
- end
46
- end
47
- end
@@ -1,109 +0,0 @@
1
- require 'rails'
2
- require 'flipper/railtie'
3
-
4
- RSpec.describe Flipper::Railtie do
5
- let(:application) do
6
- Class.new(Rails::Application).create(railties: [Flipper::Railtie]) do
7
- config.eager_load = false
8
- end
9
- end
10
-
11
- before do
12
- ActiveSupport::Dependencies.autoload_paths = ActiveSupport::Dependencies.autoload_paths.dup
13
- ActiveSupport::Dependencies.autoload_once_paths = ActiveSupport::Dependencies.autoload_once_paths.dup
14
- end
15
-
16
- let(:config) { application.config.flipper }
17
-
18
- subject { application.initialize! }
19
-
20
- describe 'initializers' do
21
- it 'can set env_key from ENV' do
22
- ENV['FLIPPER_ENV_KEY'] = 'flopper'
23
-
24
- subject
25
- expect(config.env_key).to eq('flopper')
26
- end
27
-
28
- it 'can set memoize from ENV' do
29
- ENV['FLIPPER_MEMOIZE'] = 'false'
30
-
31
- subject
32
- expect(config.memoize).to eq(false)
33
- end
34
-
35
- it 'can set preload from ENV' do
36
- ENV['FLIPPER_PRELOAD'] = 'false'
37
-
38
- subject
39
- expect(config.preload).to eq(false)
40
- end
41
-
42
- it 'can set instrumenter from ENV' do
43
- stub_const('My::Cool::Instrumenter', Class.new)
44
- ENV['FLIPPER_INSTRUMENTER'] = 'My::Cool::Instrumenter'
45
-
46
- subject
47
- expect(config.instrumenter).to eq(My::Cool::Instrumenter)
48
- end
49
-
50
- it 'can set log from ENV' do
51
- ENV['FLIPPER_LOG'] = 'false'
52
-
53
- subject
54
- expect(config.log).to eq(false)
55
- end
56
-
57
- it 'sets defaults' do
58
- subject # initialize
59
- expect(config.env_key).to eq("flipper")
60
- expect(config.memoize).to be(true)
61
- expect(config.preload).to be(true)
62
- end
63
-
64
- it "configures instrumentor on default instance" do
65
- subject # initialize
66
- expect(Flipper.instance.instrumenter).to eq(ActiveSupport::Notifications)
67
- end
68
-
69
- it 'uses Memoizer middleware if config.memoize = true' do
70
- initializer { config.memoize = true }
71
- expect(subject.middleware).to include(Flipper::Middleware::Memoizer)
72
- end
73
-
74
- it 'does not use Memoizer middleware if config.memoize = false' do
75
- initializer { config.memoize = false }
76
- expect(subject.middleware).not_to include(Flipper::Middleware::Memoizer)
77
- end
78
-
79
- it 'passes config to memoizer' do
80
- initializer do
81
- config.update(
82
- env_key: 'my_flipper',
83
- preload: [:stats, :search]
84
- )
85
- end
86
-
87
- expect(subject.middleware).to include(Flipper::Middleware::Memoizer)
88
- middleware = subject.middleware.detect { |m| m.klass == Flipper::Middleware::Memoizer }
89
- expect(middleware.args[0]).to eq({
90
- env_key: config.env_key,
91
- preload: config.preload,
92
- if: nil
93
- })
94
- end
95
-
96
- it "defines #flipper_id on AR::Base" do
97
- subject
98
- require 'active_record'
99
- expect(ActiveRecord::Base.ancestors).to include(Flipper::Identifier)
100
- end
101
- end
102
-
103
- # Add app initializer in the same order as config/initializers/*
104
- def initializer(&block)
105
- application.initializer 'spec', before: :load_config_initializers do
106
- block.call
107
- end
108
- end
109
- end