flipper 0.22.2 → 0.23.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper
 version: !ruby/object:Gem::Version
-  version: 0.22.2
+  version: 0.23.0
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-06 00:00:00.000000000 Z
+date: 2021-12-24 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -20,6 +20,7 @@ files:
 - ".codeclimate.yml"
 - ".github/workflows/ci.yml"
 - ".github/workflows/examples.yml"
+- ".rspec"
 - CODE_OF_CONDUCT.md
 - Changelog.md
 - Dockerfile
@@ -28,16 +29,9 @@ files:
 - README.md
 - Rakefile
 - docker-compose.yml
-- docs/Adapters.md
-- docs/Caveats.md
 - docs/DockerCompose.md
-- docs/Gates.md
-- docs/Instrumentation.md
-- docs/Optimization.md
-- docs/api/README.md
-- docs/http/README.md
+- docs/README.md
 - docs/images/banner.jpg
-- docs/read-only/README.md
 - examples/api/basic.ru
 - examples/api/custom_memoized.ru
 - examples/api/memoized.ru
@@ -62,6 +56,7 @@ files:
 - lib/flipper/actor.rb
 - lib/flipper/adapter.rb
 - lib/flipper/adapters/dual_write.rb
+- lib/flipper/adapters/failover.rb
 - lib/flipper/adapters/http.rb
 - lib/flipper/adapters/http/client.rb
 - lib/flipper/adapters/http/error.rb
@@ -114,6 +109,7 @@ files:
 - spec/flipper/actor_spec.rb
 - spec/flipper/adapter_spec.rb
 - spec/flipper/adapters/dual_write_spec.rb
+- spec/flipper/adapters/failover_spec.rb
 - spec/flipper/adapters/http_spec.rb
 - spec/flipper/adapters/instrumented_spec.rb
 - spec/flipper/adapters/memoizable_spec.rb
@@ -154,7 +150,7 @@ files:
 - spec/flipper/types/percentage_spec.rb
 - spec/flipper_integration_spec.rb
 - spec/flipper_spec.rb
-- spec/helper.rb
+- spec/spec_helper.rb
 - spec/support/descriptions.yml
 - spec/support/fake_udp_socket.rb
 - spec/support/spec_helpers.rb
@@ -182,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Feature flipper for ANYTHING
@@ -191,6 +187,7 @@ test_files:
 - spec/flipper/actor_spec.rb
 - spec/flipper/adapter_spec.rb
 - spec/flipper/adapters/dual_write_spec.rb
+- spec/flipper/adapters/failover_spec.rb
 - spec/flipper/adapters/http_spec.rb
 - spec/flipper/adapters/instrumented_spec.rb
 - spec/flipper/adapters/memoizable_spec.rb
@@ -231,7 +228,7 @@ test_files:
 - spec/flipper/types/percentage_spec.rb
 - spec/flipper_integration_spec.rb
 - spec/flipper_spec.rb
-- spec/helper.rb
+- spec/spec_helper.rb
 - spec/support/descriptions.yml
 - spec/support/fake_udp_socket.rb
 - spec/support/spec_helpers.rb

data/docs/Adapters.md

@@ -1,124 +0,0 @@
-# Adapters
-
-I plan on supporting the adapters in the flipper repo. Other adapters are welcome, so please let me know if you create one.
-
-## Officially Supported
-
-* [ActiveRecord adapter](https://github.com/jnunemaker/flipper/blob/master/docs/active_record) - Rails 5 and 6.
-* [Sequel adapter](https://github.com/jnunemaker/flipper/blob/master/docs/sequel)
-* [Redis adapter](https://github.com/jnunemaker/flipper/blob/master/docs/redis)
-* [Mongo adapter](https://github.com/jnunemaker/flipper/blob/master/docs/mongo)
-* [PStore adapter](https://github.com/jnunemaker/flipper/blob/master/lib/flipper/adapters/pstore.rb) – great for when a local file is enough
-* [Http adapter](https://github.com/jnunemaker/flipper/blob/master/docs/http) - great for using with `Flipper::Api`
-* [Moneta adapter](https://github.com/jnunemaker/flipper/blob/master/docs/moneta) - great for a variety of data stores
-* [ActiveSupportCacheStore adapter](https://github.com/jnunemaker/flipper/blob/master/docs/active_support_cache_store) - great for Rails caching
-* [Memory adapter](https://github.com/jnunemaker/flipper/blob/master/lib/flipper/adapters/memory.rb) – great for tests
-* [Read-only adapter](https://github.com/jnunemaker/flipper/blob/master/docs/read-only) - great for preventing writes from production console
-* [Rollout adapter](rollout/README.md) - great for switching from rollout to flipper
-
-## Community Supported
-
-* [Active Record 3 adapter](https://github.com/blueboxjesse/flipper-activerecord)
-* [Consul adapter](https://github.com/gdavison/flipper-consul)
-
-## Roll Your Own
-
-The basic API for an adapter is this:
-
-* `features` - Get the set of known features.
-* `add(feature)` - Add a feature to the set of known features.
-* `remove(feature)` - Remove a feature from the set of known features.
-* `clear(feature)` - Clear all gate values for a feature.
-* `get(feature)` - Get all gate values for a feature.
-* `enable(feature, gate, thing)` - Enable a gate for a thing.
-* `disable(feature, gate, thing)` - Disable a gate for a thing.
-* `get_multi(features)` - Get all gate values for several features at once. Implementation is optional. If none provided, default implementation performs N+1 `get` calls where N is the number of elements in the features parameter.
-* `get_all` - Get all gate values for all features at once. Implementation is optional. If none provided, default implementation performs two calls, one to `features` to get the names of all features and one to `get_multi` with the feature names from the first call.
-
-If you would like to make your own adapter, there are shared adapter specs (RSpec) and tests (MiniTest) that you can use to verify that you have everything working correctly.
-
-### RSpec
-For example, here is what the in-memory adapter spec looks like:
-
-`spec/flipper/adapters/memory_spec.rb`
-
-```ruby
-require 'helper'
-
-# The shared specs are included with the flipper gem so you can use them in
-# separate adapter specific gems.
-require 'flipper/spec/shared_adapter_specs'
-
-describe Flipper::Adapters::Memory do
-
-  # an instance of the new adapter you are trying to create
-  subject { described_class.new }
-
-  # include the shared specs that the subject must pass
-  it_should_behave_like 'a flipper adapter'
-end
-```
-
-### MiniTest
-
-Here is what an in-memory adapter MiniTest looks like:
-
-`test/adapters/memory_test.rb`
-
-```ruby
-require 'test_helper'
-
-class MemoryTest < MiniTest::Test
-  prepend SharedAdapterTests
-
-  def setup
-    # Any code here will run before each test
-    @adapter = Flipper::Adapters::Memory.new
-  end
-
-  def teardown
-    # Any code here will run after each test
-  end
-end
-```
-1. Create a file under `test/adapters` that inherits from MiniTest::Test.
-
-2. `prepend SharedAdapterTests`.
-
-3. Initialize an instance variable `@adapter` referencing an instance of the adapter.
-
-4. Add any code to run before each test in a `setup` method and any code to run after each test in a `teardown` method.
-
-A good place to start when creating your own adapter is to copy one of the adapters mentioned above and replace the client specific code with whatever client you are attempting to adapt.
-
-I would also recommend setting `fail_fast = true` in your RSpec configuration as that will just give you one failure at a time to work through. It is also handy to have the shared adapter spec file open.
-
-## Swapping Adapters
-
-If you find yourself using one adapter and would like to swap to another, you can do that! Flipper adapters support importing another adapter's data. This will wipe the adapter you are wanting to swap to, if it isn't already clean, so please be careful.
-
-```ruby
-# Say you are using redis...
-redis_adapter = Flipper::Adapters::Redis.new(Redis.new)
-redis_flipper = Flipper.new(redis_adapter)
-
-# And redis has some stuff enabled...
-redis_flipper.enable(:search)
-redis_flipper.enable_percentage_of_time(:verbose_logging, 5)
-redis_flipper.enable_percentage_of_actors(:new_feature, 5)
-redis_flipper.enable_actor(:issues, Flipper::Actor.new('1'))
-redis_flipper.enable_actor(:issues, Flipper::Actor.new('2'))
-redis_flipper.enable_group(:request_tracing, :staff)
-
-# And you would like to switch to active record...
-ar_adapter = Flipper::Adapters::ActiveRecord.new
-ar_flipper = Flipper.new(ar_adapter)
-
-# NOTE: This wipes active record clean and copies features/gates from redis into active record.
-ar_flipper.import(redis_flipper)
-
-# active record is now identical to redis.
-ar_flipper.features.each do |feature|
-  pp feature: feature.key, values: feature.gate_values
-end
-```

data/docs/Caveats.md

@@ -1,4 +0,0 @@
-# Caveats
-
-1. The [individual actor gate](https://github.com/jnunemaker/flipper/blob/master/docs/Gates.md#2-individual-actor) is typically not designed for hundreds or thousands of actors to be enabled. This is an explicit choice to make it easier to batch load data from the adapters instead of performing individual checks for actors over and over. If you need to enable something for more than 100 individual actors, I would recommend using a [group](https://github.com/jnunemaker/flipper/blob/master/docs/Gates.md#5-group).
-2. The `disable` method exists only to clear something that is enabled. If the thing you are disabling is not enabled, the disable is pointless. This means that if you enable one group an actor is in and disable another group, the feature will be enabled for the actor. ([related issue](https://github.com/jnunemaker/flipper/issues/71))

data/docs/Gates.md

@@ -1,167 +0,0 @@
-# Gates
-
-Out of the box several types of enabling are supported. They are checked in this order:
-
-## 1. Boolean
-
-All on or all off. Think top level things like `:stats`, `:search`, `:logging`, etc. Also, an easy way to release a new feature as once a feature is boolean enabled it is on for every situation.
-
-```ruby
-Flipper.enable :stats # turn on
-Flipper.disable :stats # turn off
-Flipper.enabled? :stats # check
-```
-
-## 2. Individual Actor
-
-Turn feature on for individual thing. Think enable feature for someone to test or for a buddy.
-
-```ruby
-Flipper.enable_actor :stats, user
-Flipper.enabled? :stats, user # true
-
-Flipper.disable_actor :stats, user
-Flipper.enabled? :stats, user # false
-
-# you can enable anything, does not need to be user or person
-Flipper.enable_actor :search, organization
-Flipper.enabled? :search, organization
-
-# you can also save a reference to a specific feature
-feature = Flipper[:search]
-
-feature.enable_actor user
-feature.enabled? user # true
-feature.disable_actor user
-```
-
-The only requirement for an individual actor is that it must have a unique `flipper_id`. Include the `Flipper::Identifier` module for a default implementation which combines the class name and `id` (e.g. `User;6`).
-
-```ruby
-class User < Struct.new(:id)
-  include Flipper::Identifier
-end
-
-User.new(5).flipper_id # => "User;5"
-```
-
-You can also define your own implementation:
-
-```
-class Organization < Struct.new(:uuid)
-  def flipper_id
-    uuid
-  end
-end
-
-Organization.new("DEB3D850-39FB-444B-A1E9-404A990FDBE0").flipper_id
-# => "DEB3D850-39FB-444B-A1E9-404A990FDBE0"
-```
-
-Just make sure each type of object has a unique `flipper_id`.
-
-## 3. Percentage of Actors
-
-Turn this on for a percentage of actors (think user, member, account, group, whatever). Consistently on or off for this user as long as percentage increases. Think slow rollout of a new feature to a percentage of things.
-
-```ruby
-# turn stats on for 10 percent of users in the system
-Flipper.enable :stats, Flipper.actors(10)
-# or
-Flipper.enable_percentage_of_actors :stats, 10
-
-# checks if actor's flipper_id is in the enabled percentage by hashing
-# user.flipper_id.to_s to ensure enabled distribution is smooth
-Flipper.enabled? :stats, user
-
-Flipper.disable_percentage_of_actors :search # sets to 0
-# or
-Flipper.disable :stats, Flipper.actors(0)
-
-# you can also save a reference to a specific feature
-feature = Flipper[:search]
-feature.enable_percentage_of_actors 10
-feature.enabled? user
-feature.disable_percentage_of_actors # sets to 0
-```
-
-## 4. Percentage of Time
-
-Turn this on for a percentage of time. Think load testing new features behind the scenes and such.
-
-```ruby
-# Register a feature called logging and turn it on for 5 percent of the time.
-# This could be on during one request and off the next
-# could even be on first time in request and off second time
-Flipper.enable_percentage_of_time :logging, 5
-
-Flipper.enabled? :logging # this will return true 5% of the time.
-
-Flipper.disable_percentage_of_time :logging # sets to 0
-
-# you can also save a reference to a specific feature
-feature = Flipper[:search]
-feature.enable_percentage_of_time, 5
-feature.enabled?
-feature.disable_percentage_of_time
-```
-
-Timeness is not a good idea for enabling new features in the UI. Most of the time you want a feature on or off for a user, but there are definitely times when I have found percentage of time to be very useful.
-
-## 5. Group
-
-Turn on feature based on the return value of block. Super flexible way to turn on a feature for multiple things (users, people, accounts, etc.) as long as the thing returns true when passed to the block.
-
-```ruby
-# this registers a group
-Flipper.register(:admins) do |actor|
-  actor.respond_to?(:admin?) && actor.admin?
-end
-
-Flipper.enable_group :stats, :admins # This registers a stats feature and turns it on for admins (which is anything that returns true from the registered block).
-Flipper.disable_group :stats, :admins # turn off the stats feature for admins
-
-person = Person.find(params[:id])
-Flipper.enabled? :stats, person # check if enabled, returns true if person.admin? is true
-
-
-# you can also use shortcut methods. This also registers a stats feature and turns it on for admins.
-feature = Flipper[:search]
-feature.enable_group :admins
-feature.enabled? person
-feature.disable_group :admins
-```
-
-Here's a quick explanation of the above code block:
-
-```ruby
-Flipper.register(:admins) do |actor|
-  actor.respond_to?(:admin?) && actor.admin?
-end
-```
-- The above first registers a group called `admins` which essentially saves a [Proc](http://www.eriktrautman.com/posts/ruby-explained-blocks-procs-and-lambdas-aka-closures) to be called later. The `actor` is an instance of the `Flipper::Types::Actor` that wraps the thing being checked against and `actor.thing` is the original object being checked.
-
-```ruby
-Flipper.enable_group :stats, :admins
-```
-
-- The above enables the stats feature to any object that returns true from the `:admins` proc.
-
-```ruby
-person = Person.find(params[:id])
-Flipper.enabled? :stats, person # check if person is enabled, returns true if person.admin? is true
-```
-
-When the `person` object is passed to the `enabled?` method, it is then passed into the proc. If the proc returns true, the entire statement returns true and so `Flipper[:stats].enabled? person` returns true. Whatever logic follows this conditional check is then executed.
-
-There is no requirement that the thing yielded to the block be a user model or whatever. It can be anything you want, therefore it is a good idea to check that the thing passed into the group block actually responds to what you are trying to do in the `register` proc.
-
-In your application code, you can do something like this now:
-
-```ruby
-if Flipper.enabled? :stats, some_admin
-  # do thing...
-else
-  # do not do thing
-end
-```

data/docs/Instrumentation.md

@@ -1,27 +0,0 @@
-# Instrumentation
-
-Flipper comes with automatic instrumentation. By default these work with ActiveSupport::Notifications, but only require the pieces of ActiveSupport that are needed and only do so if you actually attempt to require the instrumentation files listed below.
-
-To use the log subscriber:
-
-```ruby
-# Gemfile
-gem "activesupport"
-
-# config/initializers/flipper.rb (or wherever you want it)
-require "flipper/instrumentation/log_subscriber"
-```
-
-To use the statsd instrumentation:
-
-```ruby
-# Gemfile
-gem "activesupport"
-gem "statsd-ruby"
-
-# config/initializers/flipper.rb (or wherever you want it)
-require "flipper/instrumentation/statsd"
-Flipper::Instrumentation::StatsdSubscriber.client = Statsd.new # or whatever your statsd instance is
-```
-
-You can also do whatever you want with the instrumented events. Check out [this example](https://github.com/jnunemaker/flipper/blob/master/examples/instrumentation.rb) for more.

data/docs/Optimization.md

@@ -1,137 +0,0 @@
-# Optimization
-
-## Memoization
-
-By default, Flipper will preload and memoize all features to ensure one adapter call per request. This means no matter how many times you check features, Flipper will only make one network request to Postgres, MySQL, Redis, Mongo or whatever adapter you are using for the length of the request.
-
-### Preloading
-
-Flipper will preload all features before each request by default, which is recommended if you have a limited number of features (< 100?) and they are used on most requests. If you have a lot of features, but only a few are used on most requests, you may want to customize preloading:
-
-```ruby
-# config/initializers/flipper.rb
-Rails.application.configure do
-  # Load specific features that are used on most requests
-  config.flipper.preload = [:stats, :search, :some_feature]
-
-  # Or completely disable preloading
-  config.flipper.preload = false
-end
-```
-
-Features that are not preloaded are still memoized, ensuring one adapter call per feature during a request.
-
-### Skip memoization
-
-Prevent preloading and memoization on specific requests by setting `memoize` to a proc that evaluates to false.
-
-```ruby
-# config/initializers/flipper.rb
-Rails.application.configure do
-  config.flipper.memoize = ->(request) { !request.path.start_with?("/assets") }
-end
-```
-
-### Disable memoization
-
-To disable memoization entirely:
-
-```ruby
-Rails.application.configure do
-  config.flipper.memoize = false
-end
-```
-
-### Advanced
-
-Memoization is implemented as a Rack middleware, which can be used manually in any Ruby app:
-
-```ruby
-use Flipper::Middleware::Memoizer,
-  preload: true,
-  unless: ->(request) { request.path.start_with?("/assets") }
-```
-
-**Also Note**: If you need to customize the instance of Flipper used by the memoizer, you can pass the instance to `SetupEnv`:
-
-```ruby
-use Flipper::Middleware::SetupEnv, -> { Flipper.new(...) }
-use Flipper::Middleware::Memoizer
-```
-
-## Cache Adapters
-
-Cache adapters allow you to cache adapter calls for longer than a single request and should be used alongside the memoization middleware to add another caching layer.
-
-### Dalli
-
-> Dalli is a high performance pure Ruby client for accessing memcached servers.
-
-https://github.com/petergoldstein/dalli
-
-Example using the Dalli cache adapter with the Memory adapter and a TTL of 600 seconds:
-
-```ruby
-Flipper.configure do |config|
-  config.adapter do
-    dalli = Dalli::Client.new('localhost:11211')
-    adapter = Flipper::Adapters::Memory.new
-    Flipper::Adapters::Dalli.new(adapter, dalli, 600)
-  end
-end
-```
-
-### RedisCache
-
-Applications using [Redis](https://redis.io/) via the [redis-rb](https://github.com/redis/redis-rb) client can take advantage of the RedisCache adapter.
-
-Initialize `RedisCache`  with a flipper [adapter](https://github.com/jnunemaker/flipper/blob/master/docs/Adapters.md), a Redis client instance, and an optional TTL in seconds. TTL defaults to 3600 seconds.
-
-Example using the RedisCache adapter with the Memory adapter and a TTL of 4800 seconds:
-
-```ruby
-require 'flipper/adapters/redis_cache'
-
-Flipper.configure do |config|
-  config.adapter do
-    redis = Redis.new(url: ENV['REDIS_URL'])
-    memory_adapter = Flipper::Adapters::Memory.new
-    Flipper::Adapters::RedisCache.new(memory_adapter, redis, 4800)
-  end
-end
-```
-
-### ActiveSupportCacheStore
-
-Rails applications can cache Flipper calls in any [ActiveSupport::Cache::Store](http://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html) implementation.
-
-Add this line to your application's Gemfile:
-
-    gem 'flipper-active_support_cache_store'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself with:
-
-    $ gem install flipper-active_support_cache_store
-
-Example using the ActiveSupportCacheStore adapter with ActiveSupport's [MemoryStore](http://api.rubyonrails.org/classes/ActiveSupport/Cache/MemoryStore.html), Flipper's [Memory adapter](https://github.com/jnunemaker/flipper/blob/master/lib/flipper/adapters/memory.rb), and a TTL of 5 minutes.
-
-```ruby
-require 'active_support/cache'
-require 'flipper/adapters/active_support_cache_store'
-
-Flipper.configure do |config|
-  config.adapter do
-    Flipper::Adapters::ActiveSupportCacheStore.new(
-      Flipper::Adapters::Memory.new,
-      ActiveSupport::Cache::MemoryStore.new # Or Rails.cache,
-      expires_in: 5.minutes
-    )
-  end
-end
-```
-
-Setting `expires_in` is optional and will set an expiration time on Flipper cache keys.  If specified, all flipper keys will use this `expires_in` over the `expires_in` passed to your ActiveSupport cache constructor.