flipper-active_support_cache_store 0.28.3 → 1.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e829c5ac55bce11f8bd8f6861439d72ff43e30c40e1b2e34ac30b12411420781
-  data.tar.gz: ac9e18f185f905a1332d596cd0c272a7199269b10ece0ee57a19d67b8a50fa3e
+  metadata.gz: a7b5c9414cd4c0a7af95ab90873d6830a19e4befda24d8f22b395f88a3fc63c5
+  data.tar.gz: b64460a641c23b702de19f27e7996643a5b8f2caf32aee9949369762c52ae6af
 SHA512:
-  metadata.gz: a29e3142c493bd04435205a03486a1fd238dbe3699f3bace5fc0b95356e820c8cbcfea286eab3780a5957ea025d0a5f647c0e8b24768f775dac2da846dc9d09f
-  data.tar.gz: 75108b097026d1b9c9f9043c26fdfaf531c4db22f386337052d3bcb7a8f4dcf06556eca5b8d84e1673c4f6cd19a523caff00971e2ce4d2ceefd998799842f97c
+  metadata.gz: fc8c1e1f151f8d40dfe64bea6627f9724e5ce65b091ffe2972378eacb6c29beb8a1984f408d6e2df3c550525361e318ddd924935ba548f9aaed1b2c54836b9ff
+  data.tar.gz: d032cce0605787fc4ff38cc4537088ef607d927b8d38826e9f0904f17141e460495e39b4f7351f1a27d2fe1c75e692fc844ef733541916d42beaed864ae7234a

data/flipper-active_support_cache_store.gemspec

@@ -8,10 +8,10 @@ end
 
 Gem::Specification.new do |gem|
   gem.authors       = ['John Nunemaker']
-  gem.email         = ['nunemaker@gmail.com']
-  gem.summary       = 'ActiveSupport::Cache store adapter for Flipper'
+  gem.email         = 'support@flippercloud.io'
+  gem.summary       = 'ActiveSupport::Cache feature flag cache adapter for Flipper'
   gem.license       = 'MIT'
-  gem.homepage      = 'https://github.com/jnunemaker/flipper'
+  gem.homepage      = 'https://www.flippercloud.io/docs/optimization#activesupportcachestore'
 
   gem.files         = `git ls-files`.split("\n").select(&flipper_active_support_cache_store_files) + ['lib/flipper/version.rb']
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n").select(&flipper_active_support_cache_store_files)
@@ -21,5 +21,5 @@ Gem::Specification.new do |gem|
   gem.metadata      = Flipper::METADATA
 
   gem.add_dependency 'flipper', "~> #{Flipper::VERSION}"
-  gem.add_dependency 'activesupport', '>= 4.2', '< 8'
+  gem.add_dependency 'activesupport', '>= 4.2', '< 9'
 end

data/lib/flipper/adapters/active_support_cache_store.rb

@@ -1,155 +1,85 @@
 require 'flipper'
+require 'flipper/adapters/cache_base'
 require 'active_support/notifications'
 
 module Flipper
   module Adapters
     # Public: Adapter that wraps another adapter with the ability to cache
     # adapter calls in ActiveSupport::ActiveSupportCacheStore caches.
-    #
-    class ActiveSupportCacheStore
-      include ::Flipper::Adapter
+    class ActiveSupportCacheStore < CacheBase
 
-      Version = 'v1'.freeze
-      Namespace = "flipper/#{Version}".freeze
-      FeaturesKey = "#{Namespace}/features".freeze
-      GetAllKey = "#{Namespace}/get_all".freeze
+      # Public: The race_condition_ttl for all cached data.
+      attr_reader :race_condition_ttl
 
-      # Private
-      def self.key_for(key)
-        "#{Namespace}/feature/#{key}"
-      end
-
-      # Internal
-      attr_reader :cache
-
-      # Public: The name of the adapter.
-      attr_reader :name
-
-      # Public
-      def initialize(adapter, cache, expires_in: nil, write_through: false)
-        @adapter = adapter
-        @name = :active_support_cache_store
-        @cache = cache
-        @write_options = {}
-        @write_options[:expires_in] = expires_in if expires_in
+      def initialize(adapter, cache, ttl = nil, expires_in: :none_provided, race_condition_ttl: nil, write_through: false, prefix: nil)
+        if expires_in == :none_provided
+          ttl ||= nil
+        else
+          warn "DEPRECATION WARNING: The `expires_in` kwarg is deprecated for " +
+               "Flipper::Adapters::ActiveSupportCacheStore and will be removed " +
+               "in the next major version. Please pass in expires in as third " +
+               "argument instead."
+          ttl = expires_in
+        end
+        super(adapter, cache, ttl, prefix: prefix)
+        @race_condition_ttl = race_condition_ttl
         @write_through = write_through
       end
 
-      # Public
-      def features
-        read_feature_keys
-      end
-
-      # Public
-      def add(feature)
-        result = @adapter.add(feature)
-        @cache.delete(FeaturesKey)
-        result
-      end
-
-      ## Public
       def remove(feature)
-        result = @adapter.remove(feature)
-        @cache.delete(FeaturesKey)
-
         if @write_through
-          @cache.write(key_for(feature.key), default_config, @write_options)
+          result = @adapter.remove(feature)
+          expire_features_cache
+          cache_write feature_cache_key(feature.key), default_config
+          result
         else
-          @cache.delete(key_for(feature.key))
+          super
         end
-
-        result
       end
 
-      ## Public
-      def clear(feature)
-        result = @adapter.clear(feature)
-        @cache.delete(key_for(feature.key))
-        result
-      end
-
-      ## Public
-      def get(feature)
-        @cache.fetch(key_for(feature.key), @write_options) do
-          @adapter.get(feature)
-        end
-      end
-
-      def get_multi(features)
-        read_many_features(features)
-      end
-
-      def get_all
-        if @cache.write(GetAllKey, Time.now.to_i, @write_options.merge(unless_exist: true))
-          response = @adapter.get_all
-          response.each do |key, value|
-            @cache.write(key_for(key), value, @write_options)
-          end
-          @cache.write(FeaturesKey, response.keys.to_set, @write_options)
-          response
-        else
-          features = read_feature_keys.map { |key| Flipper::Feature.new(key, self) }
-          read_many_features(features)
-        end
-      end
-
-      ## Public
       def enable(feature, gate, thing)
-        result = @adapter.enable(feature, gate, thing)
-
         if @write_through
-          @cache.write(key_for(feature.key), @adapter.get(feature), @write_options)
+          result = @adapter.enable(feature, gate, thing)
+          cache_write feature_cache_key(feature.key), @adapter.get(feature)
+          result
         else
-          @cache.delete(key_for(feature.key))
+          super
         end
-
-        result
       end
 
-      ## Public
       def disable(feature, gate, thing)
-        result = @adapter.disable(feature, gate, thing)
-
         if @write_through
-          @cache.write(key_for(feature.key), @adapter.get(feature), @write_options)
+          result = @adapter.disable(feature, gate, thing)
+          cache_write feature_cache_key(feature.key), @adapter.get(feature)
+          result
         else
-          @cache.delete(key_for(feature.key))
+          super
         end
-
-        result
       end
 
       private
 
-      def key_for(key)
-        self.class.key_for(key)
+      def cache_fetch(key, &block)
+        @cache.fetch(key, write_options, &block)
       end
 
-      # Internal: Returns an array of the known feature keys.
-      def read_feature_keys
-        @cache.fetch(FeaturesKey, @write_options) { @adapter.features }
+      def cache_read_multi(keys)
+        @cache.read_multi(*keys)
       end
 
-      # Internal: Given an array of features, attempts to read through cache in
-      # as few network calls as possible.
-      def read_many_features(features)
-        keys = features.map { |feature| key_for(feature.key) }
-        cache_result = @cache.read_multi(*keys)
-        uncached_features = features.reject { |feature| cache_result[key_for(feature)] }
+      def cache_write(key, value)
+        @cache.write(key, value, write_options)
+      end
 
-        if uncached_features.any?
-          response = @adapter.get_multi(uncached_features)
-          response.each do |key, value|
-            @cache.write(key_for(key), value, @write_options)
-            cache_result[key_for(key)] = value
-          end
-        end
+      def cache_delete(key)
+        @cache.delete(key)
+      end
 
-        result = {}
-        features.each do |feature|
-          result[feature.key] = cache_result[key_for(feature.key)]
-        end
-        result
+      def write_options
+        write_options = {}
+        write_options[:expires_in] = @ttl if @ttl
+        write_options[:race_condition_ttl] if @race_condition_ttl
+        write_options
       end
     end
   end

data/lib/flipper/version.rb

@@ -1,3 +1,13 @@
 module Flipper
-  VERSION = '0.28.3'.freeze
+  VERSION = '1.3.6'.freeze
+
+  REQUIRED_RUBY_VERSION = '2.6'.freeze
+  NEXT_REQUIRED_RUBY_VERSION = '3.0'.freeze
+
+  REQUIRED_RAILS_VERSION = '5.2'.freeze
+  NEXT_REQUIRED_RAILS_VERSION = '6.1.0'.freeze
+
+  def self.deprecated_ruby_version?
+    Gem::Version.new(RUBY_VERSION) < Gem::Version.new(NEXT_REQUIRED_RUBY_VERSION)
+  end
 end

data/spec/flipper/adapters/active_support_cache_store_spec.rb

@@ -8,7 +8,8 @@ RSpec.describe Flipper::Adapters::ActiveSupportCacheStore do
   end
   let(:cache) { ActiveSupport::Cache::MemoryStore.new }
   let(:write_through) { false }
-  let(:adapter) { described_class.new(memory_adapter, cache, expires_in: 10.seconds, write_through: write_through) }
+  let(:race_condition_ttl) { 5 }
+  let(:adapter) { described_class.new(memory_adapter, cache, 10, race_condition_ttl: race_condition_ttl, write_through: write_through) }
   let(:flipper) { Flipper.new(adapter) }
 
   subject { adapter }
@@ -19,6 +20,101 @@ RSpec.describe Flipper::Adapters::ActiveSupportCacheStore do
 
   it_should_behave_like 'a flipper adapter'
 
+  it "knows ttl" do
+    expect(adapter.ttl).to eq(10)
+  end
+
+  it "knows ttl when only expires_in provided" do
+    silence do
+      adapter = described_class.new(memory_adapter, cache, expires_in: 10)
+      expect(adapter.ttl).to eq(10)
+    end
+  end
+
+  it "knows ttl when ttl and expires_in are provided" do
+    silence do
+      adapter = described_class.new(memory_adapter, cache, 200, expires_in: 10)
+      expect(adapter.ttl).to eq(10)
+    end
+  end
+
+  it "knows default when no ttl or expires_in provided" do
+    adapter = described_class.new(memory_adapter, cache)
+    expect(adapter.ttl).to be(nil)
+  end
+
+  it "knows race_condition_ttl" do
+    expect(adapter.race_condition_ttl).to eq(race_condition_ttl)
+  end
+
+  it "knows default when no ttl or expires_in provided" do
+    adapter = described_class.new(memory_adapter, cache)
+    expect(adapter.race_condition_ttl).to be(nil)
+  end
+
+  it "knows features_cache_key" do
+    expect(adapter.features_cache_key).to eq("flipper/v1/features")
+  end
+
+  it "can expire features cache" do
+    # cache the features
+    adapter.features
+    expect(cache.read("flipper/v1/features")).not_to be(nil)
+
+    # expire cache
+    adapter.expire_features_cache
+    expect(cache.read("flipper/v1/features")).to be(nil)
+  end
+
+  it "can expire feature cache" do
+    # cache the features
+    adapter.get(flipper[:stats])
+    expect(cache.read("flipper/v1/feature/stats")).not_to be(nil)
+
+    # expire cache
+    adapter.expire_feature_cache("stats")
+    expect(cache.read("flipper/v1/feature/stats")).to be(nil)
+  end
+
+  it "can generate feature cache key" do
+    expect(adapter.feature_cache_key("stats")).to eq("flipper/v1/feature/stats")
+  end
+
+  context "when using a prefix" do
+    let(:adapter) { described_class.new(memory_adapter, cache, 10, prefix: "foo/") }
+    it_should_behave_like 'a flipper adapter'
+
+    it "knows features_cache_key" do
+      expect(adapter.features_cache_key).to eq("foo/flipper/v1/features")
+    end
+
+    it "can generate feature cache key" do
+      expect(adapter.feature_cache_key("stats")).to eq("foo/flipper/v1/feature/stats")
+    end
+
+    it "uses the prefix for all keys" do
+      # check individual feature get cached with prefix
+      adapter.get(flipper[:stats])
+      expect(cache.read("foo/flipper/v1/feature/stats")).not_to be(nil)
+
+      # check individual feature expired with prefix
+      adapter.remove(flipper[:stats])
+      expect(cache.read("foo/flipper/v1/feature/stats")).to be(nil)
+
+      # enable some stuff
+      flipper.enable_percentage_of_actors(:search, 10)
+      flipper.enable(:stats)
+
+      # populate the cache
+      adapter.get_all
+
+      # verify cached with prefix
+      expect(cache.read("foo/flipper/v1/features")).to eq(Set["stats", "search"])
+      expect(cache.read("foo/flipper/v1/feature/search")[:percentage_of_actors]).to eq("10")
+      expect(cache.read("foo/flipper/v1/feature/stats")[:boolean]).to eq("true")
+    end
+  end
+
   describe '#remove' do
     let(:feature) { flipper[:stats] }
 
@@ -28,8 +124,8 @@ RSpec.describe Flipper::Adapters::ActiveSupportCacheStore do
     end
 
     it 'expires feature and deletes the cache' do
-      expect(cache.read(described_class.key_for(feature))).to be_nil
-      expect(cache.exist?(described_class.key_for(feature))).to be(false)
+      expect(cache.read("flipper/v1/feature/#{feature.key}")).to be_nil
+      expect(cache.exist?("flipper/v1/feature/#{feature.key}")).to be(false)
       expect(feature).not_to be_enabled
     end
 
@@ -37,8 +133,8 @@ RSpec.describe Flipper::Adapters::ActiveSupportCacheStore do
       let(:write_through) { true }
 
       it 'expires feature and writes an empty value to the cache' do
-        expect(cache.read(described_class.key_for(feature))).to eq(adapter.default_config)
-        expect(cache.exist?(described_class.key_for(feature))).to be(true)
+        expect(cache.read("flipper/v1/feature/#{feature.key}")).to eq(adapter.default_config)
+        expect(cache.exist?("flipper/v1/feature/#{feature.key}")).to be(true)
         expect(feature).not_to be_enabled
       end
     end
@@ -48,12 +144,12 @@ RSpec.describe Flipper::Adapters::ActiveSupportCacheStore do
     let(:feature) { flipper[:stats] }
 
     before do
-      adapter.enable(feature, feature.gate(:boolean), flipper.boolean)
+      adapter.enable(feature, feature.gate(:boolean), Flipper::Types::Boolean.new(true))
     end
 
     it 'enables feature and deletes the cache' do
-      expect(cache.read(described_class.key_for(feature))).to be_nil
-      expect(cache.exist?(described_class.key_for(feature))).to be(false)
+      expect(cache.read("flipper/v1/feature/#{feature.key}")).to be_nil
+      expect(cache.exist?("flipper/v1/feature/#{feature.key}")).to be(false)
       expect(feature).to be_enabled
     end
 
@@ -61,8 +157,8 @@ RSpec.describe Flipper::Adapters::ActiveSupportCacheStore do
       let(:write_through) { true }
 
       it 'expires feature and writes to the cache' do
-        expect(cache.exist?(described_class.key_for(feature))).to be(true)
-        expect(cache.read(described_class.key_for(feature))).to include(boolean: 'true')
+        expect(cache.exist?("flipper/v1/feature/#{feature.key}")).to be(true)
+        expect(cache.read("flipper/v1/feature/#{feature.key}")).to include(boolean: 'true')
         expect(feature).to be_enabled
       end
     end
@@ -72,12 +168,12 @@ RSpec.describe Flipper::Adapters::ActiveSupportCacheStore do
     let(:feature) { flipper[:stats] }
 
     before do
-      adapter.disable(feature, feature.gate(:boolean), flipper.boolean)
+      adapter.disable(feature, feature.gate(:boolean), Flipper::Types::Boolean.new)
     end
 
     it 'disables feature and deletes the cache' do
-      expect(cache.read(described_class.key_for(feature))).to be_nil
-      expect(cache.exist?(described_class.key_for(feature))).to be(false)
+      expect(cache.read("flipper/v1/feature/#{feature.key}")).to be_nil
+      expect(cache.exist?("flipper/v1/feature/#{feature.key}")).to be(false)
       expect(feature).not_to be_enabled
     end
 
@@ -85,8 +181,8 @@ RSpec.describe Flipper::Adapters::ActiveSupportCacheStore do
       let(:write_through) { true }
 
       it 'expires feature and writes to the cache' do
-        expect(cache.exist?(described_class.key_for(feature))).to be(true)
-        expect(cache.read(described_class.key_for(feature))).to include(boolean: nil)
+        expect(cache.exist?("flipper/v1/feature/#{feature.key}")).to be(true)
+        expect(cache.read("flipper/v1/feature/#{feature.key}")).to include(boolean: nil)
         expect(feature).not_to be_enabled
       end
     end
@@ -103,13 +199,13 @@ RSpec.describe Flipper::Adapters::ActiveSupportCacheStore do
       memory_adapter.reset
 
       adapter.get(stats)
-      expect(cache.read(described_class.key_for(search))).to be(nil)
-      expect(cache.read(described_class.key_for(other))).to be(nil)
+      expect(cache.read("flipper/v1/feature/#{search.key}")).to be(nil)
+      expect(cache.read("flipper/v1/feature/#{other.key}")).to be(nil)
 
       adapter.get_multi([stats, search, other])
 
-      expect(cache.read(described_class.key_for(search))[:boolean]).to eq('true')
-      expect(cache.read(described_class.key_for(other))[:boolean]).to be(nil)
+      expect(cache.read("flipper/v1/feature/#{search.key}")[:boolean]).to eq('true')
+      expect(cache.read("flipper/v1/feature/#{other.key}")[:boolean]).to be(nil)
 
       adapter.get_multi([stats, search, other])
       adapter.get_multi([stats, search, other])
@@ -128,19 +224,21 @@ RSpec.describe Flipper::Adapters::ActiveSupportCacheStore do
 
     it 'warms all features' do
       adapter.get_all
-      expect(cache.read(described_class.key_for(stats))[:boolean]).to eq('true')
-      expect(cache.read(described_class.key_for(search))[:boolean]).to be(nil)
-      expect(cache.read(described_class::GetAllKey)).to be_within(2).of(Time.now.to_i)
+      expect(cache.read("flipper/v1/feature/#{stats.key}")[:boolean]).to eq('true')
+      expect(cache.read("flipper/v1/feature/#{search.key}")[:boolean]).to be(nil)
+      expect(cache.read("flipper/v1/features")).to eq(Set["stats", "search"])
     end
 
     it 'returns same result when already cached' do
       expect(adapter.get_all).to eq(adapter.get_all)
     end
 
-    it 'only invokes one call to wrapped adapter' do
+    it 'only invokes two calls to wrapped adapter (for features set and gate data for each feature in set)' do
       memory_adapter.reset
       5.times { adapter.get_all }
-      expect(memory_adapter.count(:get_all)).to eq(1)
+      expect(memory_adapter.count(:features)).to eq(1)
+      expect(memory_adapter.count(:get_multi)).to eq(1)
+      expect(memory_adapter.count).to eq(2)
     end
   end
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: flipper-active_support_cache_store
 version: !ruby/object:Gem::Version
-  version: 0.28.3
+  version: 1.3.6
 platform: ruby
 authors:
 - John Nunemaker
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-21 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper
@@ -16,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.28.3
+        version: 1.3.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.28.3
+        version: 1.3.6
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -33,7 +32,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,10 +42,8 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
-description:
-email:
-- nunemaker@gmail.com
+        version: '9'
+email: support@flippercloud.io
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -56,12 +53,16 @@ files:
 - lib/flipper/adapters/active_support_cache_store.rb
 - lib/flipper/version.rb
 - spec/flipper/adapters/active_support_cache_store_spec.rb
-homepage: https://github.com/jnunemaker/flipper
+homepage: https://www.flippercloud.io/docs/optimization#activesupportcachestore
 licenses:
 - MIT
 metadata:
-  changelog_uri: https://github.com/jnunemaker/flipper/blob/main/Changelog.md
-post_install_message:
+  documentation_uri: https://www.flippercloud.io/docs
+  homepage_uri: https://www.flippercloud.io
+  source_code_uri: https://github.com/flippercloud/flipper
+  bug_tracker_uri: https://github.com/flippercloud/flipper/issues
+  changelog_uri: https://github.com/flippercloud/flipper/releases/tag/v1.3.6
+  funding_uri: https://github.com/sponsors/flippercloud
 rdoc_options: []
 require_paths:
 - lib
@@ -76,9 +77,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
-summary: ActiveSupport::Cache store adapter for Flipper
+summary: ActiveSupport::Cache feature flag cache adapter for Flipper
 test_files:
 - spec/flipper/adapters/active_support_cache_store_spec.rb