flipper 0.11.0.beta3 → 0.11.0.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ff62d3ba23318ccb0c071a989e83364739c731a
-  data.tar.gz: ecefd31c44930c4d6a3dc70c55175b3d3d1ba44f
+  metadata.gz: baf85e722be59174189c5871316c40cb1109c507
+  data.tar.gz: a05626a7197b77e0ef609a21233d24aeac5d639d
 SHA512:
-  metadata.gz: d6cf59627197fb719492b2438b931c51645c2aa8860943b89845a01f4ef8f1696080aec6b53965ea1e918aaa647325c23d1b3731dd85ae5b787f426333c43bb3
-  data.tar.gz: 73b5f76153abc395ef61069e4dc1338335d9a2c21932d853891435a7f9529f6fdf322e402562515db0af62cd95c0f8ab8e937432bb6e0636304e75917ffd7121
+  metadata.gz: 0b0f2bbae8bc3a80afa52ee58563cbc5e284a9c0093268e535dd6b7f6cd67b9868690eae86d2b9a93efc01e5f0d4b6f23b2667ecd688f4fc35fcd4d121ab96a2
+  data.tar.gz: 785f3114118eaa592f7c012319fcdacd34d0bb21ca342ca2ba197a622ab32f6de1808df4a3faf9a846b0b47b1b0e881532f6372e5ac1576d77e6742267dc2406

data/.rubocop_todo.yml

@@ -186,3 +186,13 @@ Style/IfInsideElse:
 Style/MethodMissing:
   Exclude:
     - 'lib/flipper/types/actor.rb'
+
+Style/AccessorMethodName:
+  Exclude:
+    - 'lib/flipper/adapter.rb'
+    - 'lib/flipper/adapters/http.rb'
+    - 'lib/flipper/adapters/instrumented.rb'
+    - 'lib/flipper/adapters/memoizable.rb'
+    - 'lib/flipper/adapters/operation_logger.rb'
+    - 'lib/flipper/adapters/memory.rb'
+    - 'lib/flipper/adapters/pstore.rb'

data/Changelog.md

@@ -13,6 +13,11 @@
 * Finish API and HTTP adapter that speaks to API.
 * Add flipper cloud adapter (https://github.com/jnunemaker/flipper/pull/249). Nothing to see here yet, but good stuff soon. ;)
 * Add importing (https://github.com/jnunemaker/flipper/pull/251).
+* Added Adapter#get_all to allow for more efficient preload_all (https://github.com/jnunemaker/flipper/pull/255).
+* Added :unless option to Flipper::Middleware::Memoizer to allow skipping memoization and preloading for certain requests.
+* Made it possible to instrument Flipper::Cloud (https://github.com/jnunemaker/flipper/commit/4b10e4d807772202f63881f5e2c00d11ac58481f).
+* Made it possible to wrap Http adapter when using Flipper::Cloud (https://github.com/jnunemaker/flipper/commit/4b10e4d807772202f63881f5e2c00d11ac58481f).
+* Instrument get_multi in instrumented adapter (https://github.com/jnunemaker/flipper/commit/951d25c5ce07d3b56b0b2337adf5f6bcbe4050e7).
 
 ## 0.10.2
 

data/Gemfile

@@ -6,6 +6,7 @@ Dir['flipper-*.gemspec'].each do |gemspec|
   gemspec(name: "flipper-#{plugin}", development_group: plugin)
 end
 
+gem 'pry'
 gem 'rake', '~> 10.4.2'
 gem 'metriks', '~> 0.9.9'
 gem 'shotgun', '~> 0.9'

data/docker-compose.yml

@@ -24,9 +24,9 @@ app:
     - mongo
     - memcached
   environment:
-    - BOXEN_REDIS_URL=redis://redis:6379
-    - BOXEN_MONGODB_HOST=mongo
-    - BOXEN_MEMCACHED_URL=memcached:11211
+    - REDIS_URL=redis://redis:6379
+    - MONGODB_HOST=mongo
+    - MEMCACHED_URL=memcached:11211
 bundle_cache:
   container_name: flipper_bundle_cache
   image: busybox

data/docs/Adapters.md

@@ -31,6 +31,7 @@ The basic API for an adapter is this:
 * `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.
 

data/docs/DockerCompose.md

@@ -12,7 +12,7 @@ new contributor could start working on code with a minumum efforts.
 1. Run specs `docker-compose run --rm app bundle exec rspec`
 1. Run tests `docker-compose run --rm app bundle exec rake test`
 1. Clear and check files with Rubocop `docker-compose run --rm  app bundle exec rubocop -D`
-1. Optional: log in to container an using a bash for running specs
+1. Optional: log in to container an using a `bash` shell for running specs
 ```sh
 docker-compose run --rm app bash
 bundle exec rspec

data/docs/Optimization.md

@@ -48,11 +48,17 @@ The Memoizer middleware also supports a few options. Use either `preload` or `pr
     config.middleware.use Flipper::Middleware::Memoizer,
       preload: [:stats, :search, :some_feature]
     ```
-* **`:preload_all`** - A Boolean value (default: false) of whether or not all features should be preloaded. Using this results in a `preload` call with the result of `Adapter#features`. Any subsequent feature checks will be memoized and perform no network calls. I wouldn't recommend using this unless you have few features (< 30?) and nearly all of them are used on every request.
+* **`:preload_all`** - A Boolean value (default: false) of whether or not all features should be preloaded. Using this results in a `preload_all` call with the result of `Adapter#get_all`. Any subsequent feature checks will be memoized and perform no network calls. I wouldn't recommend using this unless you have few features (< 100?) and nearly all of them are used on every request.
     ```ruby
     config.middleware.use Flipper::Middleware::Memoizer,
       preload_all: true
     ```
+* **`:unless`** - A block that prevents preloading and memoization if it evaluates to true.
+    ```ruby
+    # skip preloading and memoizing if path starts with /assets
+    config.middleware.use Flipper::Middleware::Memoizer,
+      unless: ->(request) { request.path.start_with?("/assets") }
+    ```
 
 ## Cache Adapters
 

data/lib/flipper/adapter.rb

@@ -18,6 +18,14 @@ module Flipper
       end
     end
 
+    # Public: Get all features and gate values in one call. Defaults to one call
+    # to features and another to get_multi. Feel free to override per adapter to
+    # make this more efficient.
+    def get_all
+      instances = features.map { |key| Flipper::Feature.new(key, self) }
+      get_multi(instances)
+    end
+
     # Public: Get multiple features in one call. Defaults to one get per
     # feature. Feel free to override per adapter to make this more efficient and
     # reduce network calls.

data/lib/flipper/adapters/http.rb

@@ -59,6 +59,25 @@ module Flipper
         result
       end
 
+      def get_all
+        response = @client.get("/features")
+        raise Error, response unless response.is_a?(Net::HTTPOK)
+
+        parsed_response = JSON.parse(response.body)
+        parsed_features = parsed_response.fetch('features')
+        gates_by_key = parsed_features.each_with_object({}) do |parsed_feature, hash|
+          hash[parsed_feature['key']] = parsed_feature['gates']
+          hash
+        end
+
+        result = {}
+        gates_by_key.keys.each do |key|
+          feature = Feature.new(key, self)
+          result[feature.key] = result_for_feature(feature, gates_by_key[feature.key])
+        end
+        result
+      end
+
       def features
         response = @client.get('/features')
         raise Error, response unless response.is_a?(Net::HTTPOK)

data/lib/flipper/adapters/instrumented.rb

@@ -4,7 +4,7 @@ require 'flipper/instrumenters/noop'
 module Flipper
   module Adapters
     # Internal: Adapter that wraps another adapter and instruments all adapter
-    # operations. Used by flipper dsl to provide instrumentatin for flipper.
+    # operations.
     class Instrumented < SimpleDelegator
       include ::Flipper::Adapter
 
@@ -95,6 +95,29 @@ module Flipper
         end
       end
 
+      def get_multi(features)
+        payload = {
+          operation: :get_multi,
+          adapter_name: @adapter.name,
+          feature_names: features.map(&:name),
+        }
+
+        @instrumenter.instrument(InstrumentationName, payload) do |payload|
+          payload[:result] = @adapter.get_multi(features)
+        end
+      end
+
+      def get_all
+        payload = {
+          operation: :get_all,
+          adapter_name: @adapter.name,
+        }
+
+        @instrumenter.instrument(InstrumentationName, payload) do |payload|
+          payload[:result] = @adapter.get_all
+        end
+      end
+
       # Public
       def enable(feature, gate, thing)
         payload = {

data/lib/flipper/adapters/memoizable.rb

@@ -26,6 +26,7 @@ module Flipper
         @name = :memoizable
         @cache = cache || {}
         @memoize = false
+        @all_fetched = false
       end
 
       # Public
@@ -90,6 +91,27 @@ module Flipper
         end
       end
 
+      def get_all
+        if memoizing?
+          unless @all_fetched
+            result = @adapter.get_all
+            result.each do |key, value|
+              cache[key] = value
+            end
+            cache[FeaturesKey] = result.keys.to_set
+            @all_fetched = true
+          end
+
+          result = {}
+          features.each do |key|
+            result[key] = cache[key]
+          end
+          result
+        else
+          @adapter.get_all
+        end
+      end
+
       # Public
       def enable(feature, gate, thing)
         result = @adapter.enable(feature, gate, thing)
@@ -108,6 +130,7 @@ module Flipper
       #
       # value - The Boolean that decides if local caching is on.
       def memoize=(value)
+        @all_fetched = false
         cache.clear
         @memoize = value
       end

data/lib/flipper/adapters/operation_logger.rb

@@ -17,6 +17,7 @@ module Flipper
         :clear,
         :get,
         :get_multi,
+        :get_all,
         :enable,
         :disable,
       ].freeze
@@ -72,6 +73,12 @@ module Flipper
         @adapter.get_multi(features)
       end
 
+      # Public
+      def get_all
+        @operations << Operation.new(:get_all, [])
+        @adapter.get_all
+      end
+
       # Public
       def enable(feature, gate, thing)
         @operations << Operation.new(:enable, [feature, gate, thing])

data/lib/flipper/dsl.rb

@@ -181,6 +181,14 @@ module Flipper
       features
     end
 
+    # Public: Preload all the adapters features.
+    #
+    # Returns an Array of Flipper::Feature.
+    def preload_all
+      keys = @adapter.get_all.keys
+      keys.map { |key| feature(key) }
+    end
+
     # Public: Shortcut access to a feature instance by name.
     #
     # name - The String or Symbol name of the feature.

data/lib/flipper/middleware/memoizer.rb

@@ -32,16 +32,31 @@ module Flipper
       end
 
       def call(env)
+        request = Rack::Request.new(env)
+
+        if skip_memoize?(request)
+          @app.call(env)
+        else
+          memoized_call(env)
+        end
+      end
+
+      private
+
+      def skip_memoize?(request)
+        @opts[:unless] && @opts[:unless].call(request)
+      end
+
+      def memoized_call(env)
         flipper = env.fetch('flipper')
         original = flipper.adapter.memoizing?
         flipper.adapter.memoize = true
 
-        if @opts[:preload_all]
-          names = flipper.features.map(&:name)
-          flipper.preload(names)
-        end
+        flipper.preload_all if @opts[:preload_all]
 
-        flipper.preload(@opts[:preload]) if @opts[:preload]
+        if (preload = @opts[:preload])
+          flipper.preload(preload)
+        end
 
         response = @app.call(env)
         response[2] = Rack::BodyProxy.new(response[2]) do

data/lib/flipper/spec/shared_adapter_specs.rb

@@ -1,5 +1,6 @@
 # Requires the following methods:
 # * subject - The instance of the adapter
+# rubocop:disable Metrics/BlockLength
 RSpec.shared_examples_for 'a flipper adapter' do
   let(:flipper) { Flipper.new(subject) }
   let(:feature) { flipper[:stats] }
@@ -231,15 +232,30 @@ RSpec.shared_examples_for 'a flipper adapter' do
   it 'can get multiple features' do
     expect(subject.add(flipper[:stats])).to eq(true)
     expect(subject.enable(flipper[:stats], boolean_gate, flipper.boolean)).to eq(true)
-
     expect(subject.add(flipper[:search])).to eq(true)
 
     result = subject.get_multi([flipper[:stats], flipper[:search], flipper[:other]])
     expect(result).to be_instance_of(Hash)
 
-    stats, search, other = result.values
+    stats = result["stats"]
+    search = result["search"]
+    other = result["other"]
     expect(stats).to eq(subject.default_config.merge(boolean: 'true'))
     expect(search).to eq(subject.default_config)
     expect(other).to eq(subject.default_config)
   end
+
+  it 'can get all features' do
+    expect(subject.add(flipper[:stats])).to eq(true)
+    expect(subject.enable(flipper[:stats], boolean_gate, flipper.boolean)).to eq(true)
+    expect(subject.add(flipper[:search])).to eq(true)
+
+    result = subject.get_all
+    expect(result).to be_instance_of(Hash)
+
+    stats = result["stats"]
+    search = result["search"]
+    expect(stats).to eq(subject.default_config.merge(boolean: 'true'))
+    expect(search).to eq(subject.default_config)
+  end
 end

data/lib/flipper/test/shared_adapter_test.rb

@@ -232,11 +232,27 @@ module Flipper
         result = @adapter.get_multi([@flipper[:stats], @flipper[:search], @flipper[:other]])
         assert_instance_of Hash, result
 
-        stats, search, other = result.values
+        stats = result["stats"]
+        search = result["search"]
+        other = result["other"]
         assert_equal @adapter.default_config.merge(boolean: 'true'), stats
         assert_equal @adapter.default_config, search
         assert_equal @adapter.default_config, other
       end
+
+      def test_can_get_all_features
+        assert @adapter.add(@flipper[:stats])
+        assert @adapter.enable(@flipper[:stats], @boolean_gate, @flipper.boolean)
+        assert @adapter.add(@flipper[:search])
+
+        result = @adapter.get_all
+        assert_instance_of Hash, result
+
+        stats = result["stats"]
+        search = result["search"]
+        assert_equal @adapter.default_config.merge(boolean: 'true'), stats
+        assert_equal @adapter.default_config, search
+      end
     end
   end
 end

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.11.0.beta3'.freeze
+  VERSION = '0.11.0.beta4'.freeze
 end

data/spec/flipper/adapter_spec.rb

@@ -17,7 +17,7 @@ RSpec.describe Flipper::Adapter do
   describe '.default_config' do
     it 'returns default config' do
       adapter_class = Class.new do
-        include described_class
+        include Flipper::Adapter # rubocop:disable RSpec/DescribedClass
       end
       expect(adapter_class.default_config).to eq(default_config)
     end
@@ -26,7 +26,7 @@ RSpec.describe Flipper::Adapter do
   describe '#default_config' do
     it 'returns default config' do
       adapter_class = Class.new do
-        include described_class
+        include Flipper::Adapter # rubocop:disable RSpec/DescribedClass
       end
       expect(adapter_class.new.default_config).to eq(default_config)
     end

data/spec/flipper/adapters/http_spec.rb

@@ -94,6 +94,18 @@ RSpec.describe Flipper::Adapters::Http do
     end
   end
 
+  describe "#get_all" do
+    it "raises error when not successful response" do
+      stub_request(:get, "http://app.com/flipper/features")
+        .to_return(status: 503, body: "", headers: {})
+
+      adapter = described_class.new(uri: URI('http://app.com/flipper'))
+      expect do
+        adapter.get_all
+      end.to raise_error(Flipper::Adapters::Http::Error)
+    end
+  end
+
   describe "#features" do
     it "raises error when not successful response" do
       stub_request(:get, "http://app.com/flipper/features")

data/spec/flipper/adapters/instrumented_spec.rb

@@ -49,6 +49,20 @@ RSpec.describe Flipper::Adapters::Instrumented do
     end
   end
 
+  describe '#get_multi' do
+    it 'records instrumentation' do
+      result = subject.get_multi([feature])
+
+      event = instrumenter.events.last
+      expect(event).not_to be_nil
+      expect(event.name).to eq('adapter_operation.flipper')
+      expect(event.payload[:operation]).to eq(:get_multi)
+      expect(event.payload[:adapter_name]).to eq(:memory)
+      expect(event.payload[:feature_names]).to eq([:stats])
+      expect(event.payload[:result]).to be(result)
+    end
+  end
+
   describe '#enable' do
     it 'records instrumentation' do
       result = subject.enable(feature, gate, thing)

data/spec/flipper/adapters/memoizable_spec.rb

@@ -90,7 +90,7 @@ RSpec.describe Flipper::Adapters::Memoizable do
         subject.memoize = true
       end
 
-      it 'memoizes feature' do
+      it 'memoizes features' do
         names = %i(stats shiny)
         features = names.map { |name| flipper[name] }
         results = subject.get_multi(features)
@@ -116,6 +116,39 @@ RSpec.describe Flipper::Adapters::Memoizable do
     end
   end
 
+  describe '#get_all' do
+    context "with memoization enabled" do
+      before do
+        subject.memoize = true
+      end
+
+      it 'memoizes features' do
+        names = %i(stats shiny)
+        features = names.map { |name| flipper[name].tap(&:enable) }
+        results = subject.get_all
+        features.each do |feature|
+          expect(cache[feature.key]).not_to be(nil)
+          expect(cache[feature.key]).to be(results[feature.key])
+        end
+        expect(cache[subject.class::FeaturesKey]).to eq(names.map(&:to_s).to_set)
+      end
+    end
+
+    context "with memoization disabled" do
+      before do
+        subject.memoize = false
+      end
+
+      it 'returns result' do
+        names = %i(stats shiny)
+        names.map { |name| flipper[name].tap(&:enable) }
+        result = subject.get_all
+        adapter_result = adapter.get_all
+        expect(result).to eq(adapter_result)
+      end
+    end
+  end
+
   describe '#enable' do
     context 'with memoization enabled' do
       before do

data/spec/flipper/dsl_spec.rb

@@ -70,6 +70,42 @@ RSpec.describe Flipper::DSL do
     end
   end
 
+  describe '#preload_all' do
+    let(:instrumenter) { double('Instrumentor', instrument: nil) }
+    let(:dsl) do
+      names.each { |name| adapter.add subject[name] }
+      described_class.new(adapter, instrumenter: instrumenter)
+    end
+    let(:names) { %i(stats shiny) }
+    let(:features) { dsl.preload_all }
+
+    it 'returns array of features' do
+      expect(features).to all be_instance_of(Flipper::Feature)
+    end
+
+    it 'sets names' do
+      expect(features.map(&:key)).to eq(names.map(&:to_s))
+    end
+
+    it 'sets adapter' do
+      features.each do |feature|
+        expect(feature.adapter.name).to eq(dsl.adapter.name)
+      end
+    end
+
+    it 'sets instrumenter' do
+      features.each do |feature|
+        expect(feature.instrumenter).to eq(dsl.instrumenter)
+      end
+    end
+
+    it 'memoizes the feature' do
+      features.each do |feature|
+        expect(dsl.feature(feature.name)).to equal(feature)
+      end
+    end
+  end
+
   describe '#[]' do
     it_should_behave_like 'a DSL feature' do
       let(:method_name) { :[] }

data/spec/flipper/middleware/memoizer_spec.rb

@@ -141,9 +141,7 @@ RSpec.describe Flipper::Middleware::Memoizer do
       middleware = described_class.new(app, preload_all: true)
       middleware.call(env)
 
-      expect(adapter.count(:features)).to be(1)
-      expect(adapter.count(:get_multi)).to be(1)
-      expect(adapter.last(:get_multi).args).to eq([[flipper[:stats], flipper[:shiny]]])
+      expect(adapter.count(:get_all)).to be(1)
     end
 
     it 'caches unknown features for duration of request' do
@@ -255,4 +253,34 @@ RSpec.describe Flipper::Middleware::Memoizer do
 
     include_examples 'flipper middleware'
   end
+
+  context 'with preload_all and unless option' do
+    let(:app) do
+      # ensure scoped for builder block, annoying...
+      middleware = described_class
+
+      Rack::Builder.new do
+        use middleware, preload_all: true,
+                        unless: ->(request) { request.path.start_with?("/assets") }
+
+        map '/' do
+          run ->(_env) { [200, {}, []] }
+        end
+
+        map '/fail' do
+          run ->(_env) { raise 'FAIL!' }
+        end
+      end.to_app
+    end
+
+    it 'does NOT preload_all if request matches unless block' do
+      expect(flipper).to receive(:preload_all).never
+      get '/assets/foo.png', {}, 'flipper' => flipper
+    end
+
+    it 'does preload_all if request does NOT match unless block' do
+      expect(flipper).to receive(:preload_all).once
+      get '/some/other/path', {}, 'flipper' => flipper
+    end
+  end
 end

data/spec/helper.rb

@@ -9,6 +9,7 @@ require 'bundler'
 
 Bundler.setup(:default)
 
+require 'pry'
 require 'webmock/rspec'
 WebMock.disable_net_connect!(allow_localhost: true)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper
 version: !ruby/object:Gem::Version
-  version: 0.11.0.beta3
+  version: 0.11.0.beta4
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-10 00:00:00.000000000 Z
+date: 2017-05-10 00:00:00.000000000 Z
 dependencies: []
 description: Feature flipper is the act of enabling/disabling features in your application,
   ideally without re-deploying or changing anything in your code base. Flipper makes