flipper 0.11.0.beta9 → 0.11.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82cc5ffd7d40e3b8930038e06718a378e22d5798
-  data.tar.gz: 5cbc699f683fa1ee88efc46aff9577220ff63ac1
+  metadata.gz: 7fe7a64b6dfb6cbefeb2f111e3ea777018016ff5
+  data.tar.gz: 3c8e8754b21fdc37f9f90772ca893a0e16931f33
 SHA512:
-  metadata.gz: acebdb682fce4b45c99267ef345e9eec161b7421ac957248445e235a7ebde7d2fd3a6181f2d5e2cc362c69ecf5637cfede638cbba49233e8658895b801a5140f
-  data.tar.gz: 239a7733640400443d7adb7c4d745257eadbe61dd791330235728296395ff365292f9570a15f1994d054c08374486fbc85cc7fe65ee5ba4c99e01ae0c4804b1d
+  metadata.gz: 63863f70f3b8499f2d6f802eb6cfe20e19c84fad799c8b27d92de31b0ffba968f623b2dad4c387b9fe55c974d83a82f58253e8d683badac9ab9a4c084cafc216
+  data.tar.gz: 27f0085cfd6865a80dcd2722f81e2b516d3cd67b9702999fb90737cce263f6dd2afe5e013cbf470a6522447e70df7748f692b28cb1b7ca3a2e2ccf7e4cea4e42

data/.rubocop.yml

@@ -40,3 +40,6 @@ Style/TrailingCommaInLiteral:
 
 RSpec/InstanceVariable:
   Enabled: false
+
+Style/AccessorMethodName:
+  Enabled: false

data/Gemfile

@@ -13,7 +13,7 @@ gem 'statsd-ruby', '~> 1.2.1'
 gem 'rspec', '~> 3.0'
 gem 'rack-test', '~> 0.6.3'
 gem 'sqlite3', '~> 1.3.11'
-gem 'rails', "~> #{ENV['RAILS_VERSION'] || '4.2.5'}"
+gem 'rails', "~> #{ENV['RAILS_VERSION'] || '5.1.4'}"
 gem 'minitest', '~> 5.8.0'
 gem 'rubocop', '~> 0.45.0'
 gem 'rubocop-rspec', '= 1.5.1'

data/examples/importing.rb

@@ -1,17 +1,9 @@
 require File.expand_path('../example_setup', __FILE__)
-
+require_relative 'active_record/ar_setup'
 require 'flipper'
 require 'flipper/adapters/redis'
 require 'flipper/adapters/active_record'
 
-# Active Record boiler plate, feel free to ignore.
-ActiveRecord::Base.establish_connection({
-  adapter: 'sqlite3',
-  database: ':memory:',
-})
-require 'generators/flipper/templates/migration'
-CreateFlipperTables.up
-
 # Say you are using redis...
 redis_adapter = Flipper::Adapters::Redis.new(Redis.new)
 redis_flipper = Flipper.new(redis_adapter)

data/lib/flipper/adapters/memoizable.rb

@@ -9,6 +9,7 @@ module Flipper
       include ::Flipper::Adapter
 
       FeaturesKey = :flipper_features
+      GetAllKey = :all_memoized
 
       # Internal
       attr_reader :cache
@@ -19,6 +20,11 @@ module Flipper
       # Internal: The adapter this adapter is wrapping.
       attr_reader :adapter
 
+      # Private
+      def self.key_for(key)
+        "feature/#{key}"
+      end
+
       # Public
       def initialize(adapter, cache = nil)
         super(adapter)
@@ -26,7 +32,6 @@ module Flipper
         @name = :memoizable
         @cache = cache || {}
         @memoize = false
-        @all_fetched = false
       end
 
       # Public
@@ -63,7 +68,7 @@ module Flipper
       # Public
       def get(feature)
         if memoizing?
-          cache.fetch(feature.key) { cache[feature.key] = @adapter.get(feature) }
+          cache.fetch(key_for(feature.key)) { cache[key_for(feature.key)] = @adapter.get(feature) }
         else
           @adapter.get(feature)
         end
@@ -72,18 +77,18 @@ module Flipper
       # Public
       def get_multi(features)
         if memoizing?
-          uncached_features = features.reject { |feature| cache[feature.key] }
+          uncached_features = features.reject { |feature| cache[key_for(feature.key)] }
 
           if uncached_features.any?
             response = @adapter.get_multi(uncached_features)
             response.each do |key, hash|
-              cache[key] = hash
+              cache[key_for(key)] = hash
             end
           end
 
           result = {}
           features.each do |feature|
-            result[feature.key] = cache[feature.key]
+            result[feature.key] = cache[key_for(feature.key)]
           end
           result
         else
@@ -93,20 +98,25 @@ module Flipper
 
       def get_all
         if memoizing?
-          unless @all_fetched
-            result = @adapter.get_all
-            result.each do |key, value|
-              cache[key] = value
+          response = nil
+          if cache[GetAllKey]
+            response = {}
+            cache[FeaturesKey].each do |key|
+              response[key] = cache[key_for(key)]
             end
-            cache[FeaturesKey] = result.keys.to_set
-            @all_fetched = true
+          else
+            response = @adapter.get_all
+            response.each do |key, value|
+              cache[key_for(key)] = value
+            end
+            cache[FeaturesKey] = response.keys.to_set
+            cache[GetAllKey] = true
           end
 
-          result = {}
-          features.each do |key|
-            result[key] = cache[key]
-          end
-          result
+          # Ensures that looking up other features that do not exist doesn't
+          # result in N+1 adapter calls.
+          response.default_proc = ->(memo, key) { memo[key] = default_config }
+          response
         else
           @adapter.get_all
         end
@@ -130,7 +140,6 @@ module Flipper
       #
       # value - The Boolean that decides if local caching is on.
       def memoize=(value)
-        @all_fetched = false
         cache.clear
         @memoize = value
       end
@@ -142,8 +151,12 @@ module Flipper
 
       private
 
+      def key_for(key)
+        self.class.key_for(key)
+      end
+
       def expire_feature(feature)
-        cache.delete(feature.key) if memoizing?
+        cache.delete(key_for(feature.key)) if memoizing?
       end
 
       def expire_features_set

data/lib/flipper/adapters/memory.rb

@@ -7,7 +7,7 @@ module Flipper
     class Memory
       include ::Flipper::Adapter
 
-      FeaturesKey = :flipper_features
+      FeaturesKey = :features
 
       # Public: The name of the adapter.
       attr_reader :name
@@ -20,7 +20,7 @@ module Flipper
 
       # Public: The set of known features.
       def features
-        set_members(FeaturesKey)
+        read_feature_keys
       end
 
       # Public: Adds a feature to the set of known features.
@@ -47,21 +47,19 @@ module Flipper
 
       # Public
       def get(feature)
-        result = {}
+        read_feature(feature)
+      end
 
-        feature.gates.each do |gate|
-          result[gate.key] =
-            case gate.data_type
-            when :boolean, :integer
-              read key(feature, gate)
-            when :set
-              set_members key(feature, gate)
-            else
-              raise "#{gate} is not supported by this adapter yet"
-            end
+      def get_multi(features)
+        read_many_features(features)
+      end
+
+      def get_all
+        features = read_feature_keys.map do |key|
+          Flipper::Feature.new(key, self)
         end
 
-        result
+        read_many_features(features)
       end
 
       # Public
@@ -103,9 +101,41 @@ module Flipper
         "#<#{self.class.name}:#{object_id} #{attributes.join(', ')}>"
       end
 
+      private
+
+      def read_feature_keys
+        set_members(FeaturesKey)
+      end
+
       # Private
       def key(feature, gate)
-        "#{feature.key}/#{gate.key}"
+        "feature/#{feature.key}/#{gate.key}"
+      end
+
+      def read_many_features(features)
+        result = {}
+        features.each do |feature|
+          result[feature.key] = read_feature(feature)
+        end
+        result
+      end
+
+      def read_feature(feature)
+        result = {}
+
+        feature.gates.each do |gate|
+          result[gate.key] =
+            case gate.data_type
+            when :boolean, :integer
+              read key(feature, gate)
+            when :set
+              set_members key(feature, gate)
+            else
+              raise "#{gate} is not supported by this adapter yet"
+            end
+        end
+
+        result
       end
 
       # Private

data/lib/flipper/adapters/pstore.rb

@@ -25,59 +25,68 @@ module Flipper
 
       # Public: The set of known features.
       def features
-        set_members FeaturesKey
+        @store.transaction do
+          read_feature_keys
+        end
       end
 
       # Public: Adds a feature to the set of known features.
       def add(feature)
-        set_add FeaturesKey, feature.key
+        @store.transaction do
+          set_add FeaturesKey, feature.key
+        end
         true
       end
 
       # Public: Removes a feature from the set of known features and clears
       # all the values for the feature.
       def remove(feature)
-        set_delete FeaturesKey, feature.key
-        clear(feature)
+        @store.transaction do
+          set_delete FeaturesKey, feature.key
+          clear_gates(feature)
+        end
         true
       end
 
       # Public: Clears all the gate values for a feature.
       def clear(feature)
-        feature.gates.each do |gate|
-          delete key(feature, gate)
+        @store.transaction do
+          clear_gates(feature)
         end
         true
       end
 
       # Public
       def get(feature)
-        result = {}
+        @store.transaction do
+          result_for_feature(feature)
+        end
+      end
 
-        feature.gates.each do |gate|
-          result[gate.key] =
-            case gate.data_type
-            when :boolean, :integer
-              read key(feature, gate)
-            when :set
-              set_members key(feature, gate)
-            else
-              raise "#{gate} is not supported by this adapter yet"
-            end
+      def get_multi(features)
+        @store.transaction do
+          read_many_features(features)
         end
+      end
 
-        result
+      def get_all
+        @store.transaction do
+          features = read_feature_keys.map { |key| Flipper::Feature.new(key, self) }
+          read_many_features(features)
+        end
       end
 
       # Public
       def enable(feature, gate, thing)
-        case gate.data_type
-        when :boolean, :integer
-          write key(feature, gate), thing.value.to_s
-        when :set
-          set_add key(feature, gate), thing.value.to_s
-        else
-          raise "#{gate} is not supported by this adapter yet"
+        @store.transaction do
+          case gate.data_type
+          when :boolean, :integer
+            write key(feature, gate), thing.value.to_s
+          when :set
+            set_add key(feature, gate), thing.value.to_s
+          else
+            raise "#{gate} is not supported by this adapter yet"
+          end
         end
 
         true
@@ -89,9 +98,13 @@ module Flipper
         when :boolean
           clear(feature)
         when :integer
-          write key(feature, gate), thing.value.to_s
+          @store.transaction do
+            write key(feature, gate), thing.value.to_s
+          end
         when :set
-          set_delete key(feature, gate), thing.value.to_s
+          @store.transaction do
+            set_delete key(feature, gate), thing.value.to_s
+          end
         else
           raise "#{gate} is not supported by this adapter yet"
         end
@@ -111,6 +124,42 @@ module Flipper
 
       private
 
+      def clear_gates(feature)
+        feature.gates.each do |gate|
+          delete key(feature, gate)
+        end
+      end
+
+      def read_feature_keys
+        set_members FeaturesKey
+      end
+
+      def read_many_features(features)
+        result = {}
+        features.each do |feature|
+          result[feature.key] = result_for_feature(feature)
+        end
+        result
+      end
+
+      def result_for_feature(feature)
+        result = {}
+
+        feature.gates.each do |gate|
+          result[gate.key] =
+            case gate.data_type
+            when :boolean, :integer
+              read key(feature, gate)
+            when :set
+              set_members key(feature, gate)
+            else
+              raise "#{gate} is not supported by this adapter yet"
+            end
+        end
+
+        result
+      end
+
       # Private
       def key(feature, gate)
         "#{feature.key}/#{gate.key}"
@@ -118,23 +167,17 @@ module Flipper
 
       # Private
       def read(key)
-        @store.transaction do
-          @store[key.to_s]
-        end
+        @store[key.to_s]
       end
 
       # Private
       def write(key, value)
-        @store.transaction do
-          @store[key.to_s] = value.to_s
-        end
+        @store[key.to_s] = value.to_s
       end
 
       # Private
       def delete(key)
-        @store.transaction do
-          @store.delete(key.to_s)
-        end
+        @store.delete(key.to_s)
       end
 
       # Private
@@ -154,14 +197,13 @@ module Flipper
       # Private
       def set_members(key)
         key = key.to_s
-        @store.transaction do
-          @store[key] ||= Set.new
 
-          if block_given?
-            yield @store[key]
-          else
-            @store[key]
-          end
+        @store[key] ||= Set.new
+
+        if block_given?
+          yield @store[key]
+        else
+          @store[key]
         end
       end
     end

data/lib/flipper/adapters/read_only.rb

@@ -27,6 +27,14 @@ module Flipper
         @adapter.get(feature)
       end
 
+      def get_multi(features)
+        @adapter.get_multi(features)
+      end
+
+      def get_all
+        @adapter.get_all
+      end
+
       def add(_feature)
         raise WriteAttempted
       end

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.11.0.beta9'.freeze
+  VERSION = '0.11.0.rc1'.freeze
 end

data/spec/flipper/adapters/memoizable_spec.rb

@@ -1,6 +1,7 @@
 require 'helper'
 require 'flipper/adapters/memoizable'
 require 'flipper/adapters/memory'
+require 'flipper/adapters/operation_logger'
 require 'flipper/spec/shared_adapter_specs'
 
 RSpec.describe Flipper::Adapters::Memoizable do
@@ -66,7 +67,7 @@ RSpec.describe Flipper::Adapters::Memoizable do
       it 'memoizes feature' do
         feature = flipper[:stats]
         result = subject.get(feature)
-        expect(cache[feature.key]).to be(result)
+        expect(cache[described_class.key_for(feature.key)]).to be(result)
       end
     end
 
@@ -95,8 +96,8 @@ RSpec.describe Flipper::Adapters::Memoizable do
         features = names.map { |name| flipper[name] }
         results = subject.get_multi(features)
         features.each do |feature|
-          expect(cache[feature.key]).not_to be(nil)
-          expect(cache[feature.key]).to be(results[feature.key])
+          expect(cache[described_class.key_for(feature.key)]).not_to be(nil)
+          expect(cache[described_class.key_for(feature.key)]).to be(results[feature.key])
         end
       end
     end
@@ -127,11 +128,32 @@ RSpec.describe Flipper::Adapters::Memoizable do
         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])
+          expect(cache[described_class.key_for(feature.key)]).not_to be(nil)
+          expect(cache[described_class.key_for(feature.key)]).to be(results[feature.key])
         end
         expect(cache[subject.class::FeaturesKey]).to eq(names.map(&:to_s).to_set)
       end
+
+      it 'only calls get_all once for memoized adapter' do
+        adapter = Flipper::Adapters::OperationLogger.new(Flipper::Adapters::Memory.new)
+        cache = {}
+        instance = described_class.new(adapter, cache)
+        instance.memoize = true
+
+        instance.get_all
+        expect(adapter.count(:get_all)).to be(1)
+
+        instance.get_all
+        expect(adapter.count(:get_all)).to be(1)
+      end
+
+      it 'returns default_config for unknown feature keys' do
+        first = subject.get_all
+        expect(first['doesntexist']).to eq(subject.default_config)
+
+        second = subject.get_all
+        expect(second['doesntexist']).to eq(subject.default_config)
+      end
     end
 
     context "with memoization disabled" do
@@ -146,6 +168,27 @@ RSpec.describe Flipper::Adapters::Memoizable do
         adapter_result = adapter.get_all
         expect(result).to eq(adapter_result)
       end
+
+      it 'calls get_all every time for memoized adapter' do
+        adapter = Flipper::Adapters::OperationLogger.new(Flipper::Adapters::Memory.new)
+        cache = {}
+        instance = described_class.new(adapter, cache)
+        instance.memoize = false
+
+        instance.get_all
+        expect(adapter.count(:get_all)).to be(1)
+
+        instance.get_all
+        expect(adapter.count(:get_all)).to be(2)
+      end
+
+      it 'returns nil for unknown feature keys' do
+        first = subject.get_all
+        expect(first['doesntexist']).to be(nil)
+
+        second = subject.get_all
+        expect(second['doesntexist']).to be(nil)
+      end
     end
   end
 
@@ -158,9 +201,9 @@ RSpec.describe Flipper::Adapters::Memoizable do
       it 'unmemoizes feature' do
         feature = flipper[:stats]
         gate = feature.gate(:boolean)
-        cache[feature.key] = { some: 'thing' }
+        cache[described_class.key_for(feature.key)] = { some: 'thing' }
         subject.enable(feature, gate, flipper.bool)
-        expect(cache[feature.key]).to be_nil
+        expect(cache[described_class.key_for(feature.key)]).to be_nil
       end
     end
 
@@ -188,9 +231,9 @@ RSpec.describe Flipper::Adapters::Memoizable do
       it 'unmemoizes feature' do
         feature = flipper[:stats]
         gate = feature.gate(:boolean)
-        cache[feature.key] = { some: 'thing' }
+        cache[described_class.key_for(feature.key)] = { some: 'thing' }
         subject.disable(feature, gate, flipper.bool)
-        expect(cache[feature.key]).to be_nil
+        expect(cache[described_class.key_for(feature.key)]).to be_nil
       end
     end
 
@@ -272,9 +315,9 @@ RSpec.describe Flipper::Adapters::Memoizable do
 
       it 'unmemoizes the feature' do
         feature = flipper[:stats]
-        cache[feature.key] = { some: 'thing' }
+        cache[described_class.key_for(feature.key)] = { some: 'thing' }
         subject.remove(feature)
-        expect(cache[feature.key]).to be_nil
+        expect(cache[described_class.key_for(feature.key)]).to be_nil
       end
     end
 
@@ -297,9 +340,9 @@ RSpec.describe Flipper::Adapters::Memoizable do
 
       it 'unmemoizes feature' do
         feature = flipper[:stats]
-        cache[feature.key] = { some: 'thing' }
+        cache[described_class.key_for(feature.key)] = { some: 'thing' }
         subject.clear(feature)
-        expect(cache[feature.key]).to be_nil
+        expect(cache[described_class.key_for(feature.key)]).to be_nil
       end
     end
 

data/spec/flipper/middleware/memoizer_spec.rb

@@ -1,6 +1,9 @@
 require 'helper'
 require 'rack/test'
+require 'active_support/cache'
+require 'active_support/cache/dalli_store'
 require 'flipper/middleware/memoizer'
+require 'flipper/adapters/active_support_cache_store'
 require 'flipper/adapters/operation_logger'
 require 'flipper/adapters/memory'
 
@@ -141,6 +144,7 @@ RSpec.describe Flipper::Middleware::Memoizer do
       middleware = described_class.new(app, preload_all: true)
       middleware.call(env)
 
+      expect(adapter.operations.size).to be(1)
       expect(adapter.count(:get_all)).to be(1)
     end
 
@@ -335,4 +339,45 @@ RSpec.describe Flipper::Middleware::Memoizer do
       get '/some/other/path', {}, 'flipper' => flipper
     end
   end
+
+  context 'with preload_all and caching adapter' do
+    it 'eagerly caches known features for duration of request' do
+      memory = Flipper::Adapters::Memory.new
+      logged_memory = Flipper::Adapters::OperationLogger.new(memory)
+      cache = ActiveSupport::Cache::DalliStore.new
+      cache.clear
+      cached = Flipper::Adapters::ActiveSupportCacheStore.new(logged_memory, cache, expires_in: 10)
+      logged_cached = Flipper::Adapters::OperationLogger.new(cached)
+      memo = {}
+      flipper = Flipper.new(logged_cached)
+      flipper[:stats].enable
+      flipper[:shiny].enable
+
+      # clear the log of operations
+      logged_memory.reset
+      logged_cached.reset
+
+      app = lambda do |_env|
+        flipper[:stats].enabled?
+        flipper[:stats].enabled?
+        flipper[:shiny].enabled?
+        flipper[:shiny].enabled?
+        [200, {}, []]
+      end
+
+      middleware = described_class.new(app, preload_all: true)
+
+      middleware.call('flipper' => flipper)
+      expect(logged_cached.count(:get_all)).to be(1)
+      expect(logged_memory.count(:get_all)).to be(1)
+
+      middleware.call('flipper' => flipper)
+      expect(logged_cached.count(:get_all)).to be(2)
+      expect(logged_memory.count(:get_all)).to be(1)
+
+      middleware.call('flipper' => flipper)
+      expect(logged_cached.count(:get_all)).to be(3)
+      expect(logged_memory.count(:get_all)).to be(1)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper
 version: !ruby/object:Gem::Version
-  version: 0.11.0.beta9
+  version: 0.11.0.rc1
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-28 00:00:00.000000000 Z
+date: 2017-11-04 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