flipper-active_support_cache_store 1.2.1 → 1.3.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84ad91134e2791b47d15a6527ef4ced39f777bed68062d424c0b2e3fa972d629
-  data.tar.gz: 28b447d2647ecc8c39d9b45d8e8ee64b1092203a4678fb57b608ad4a0ea891f4
+  metadata.gz: bbb7450e9a2de26da717b62bffb2f49b7dbb7bd8afd845630793d0d9b140360e
+  data.tar.gz: c5497eef3c7643330268af315b027e31e6b7021849c03f503eb8410684f64160
 SHA512:
-  metadata.gz: 750c13ea0264aa8eabe37862a21c3e4cc4cee317b713d3970c351c3f0de6e68552c075d01ff4bb6c4db19b504279675fab3c10de12810f9f524232941e9fb642
-  data.tar.gz: 8f2d0dc2a57c1fba31e9940fcba931ebb26618d7679998de426ef31c7be50aec866cbcf16f06f6920641c6fff1ab36c99b82692cc666c998f523a388e90b23a0
+  metadata.gz: c044942a4c2a7b737fc84dcb380858f93487ef08c5662c519074915099e8cbb3a1eb2ace3fe5da4a385c977115c58175ca50a2a58a80d82e199009dd34ec2216
+  data.tar.gz: fe145df6098e3926b16b10e6607f4629492822cda6ac2b395960b12315961033955a52f653a9dea6b30111456bc90c358a6ce84814c978448794bdb40647ed28

data/lib/flipper/adapters/active_support_cache_store.rb

@@ -1,146 +1,79 @@
 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
-
-      # Internal
-      attr_reader :cache
-
-      # Public
-      def initialize(adapter, cache, expires_in: nil, write_through: false)
-        @adapter = adapter
-        @cache = cache
-        @write_options = {}
-        @write_options[:expires_in] = expires_in if expires_in
+    class ActiveSupportCacheStore < CacheBase
+      def initialize(adapter, cache, ttl = nil, expires_in: :none_provided, 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)
         @write_through = write_through
-
-        @cache_version = 'v1'.freeze
-        @namespace = "flipper/#{@cache_version}".freeze
-        @features_key = "#{@namespace}/features".freeze
-        @get_all_key = "#{@namespace}/get_all".freeze
-      end
-
-      # Public
-      def features
-        read_feature_keys
       end
 
-      # Public
-      def add(feature)
-        result = @adapter.add(feature)
-        @cache.delete(@features_key)
-        result
-      end
-
-      ## Public
       def remove(feature)
-        result = @adapter.remove(feature)
-        @cache.delete(@features_key)
-
         if @write_through
-          @cache.write(key_for(feature.key), default_config, @write_options)
-        else
-          @cache.delete(key_for(feature.key))
-        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(@get_all_key, 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(@features_key, response.keys.to_set, @write_options)
-          response
+          result = @adapter.remove(feature)
+          expire_features_cache
+          cache_write feature_cache_key(feature.key), default_config
+          result
         else
-          features = read_feature_keys.map { |key| Flipper::Feature.new(key, self) }
-          read_many_features(features)
+          super
         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)
-        "#{@namespace}/feature/#{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(@features_key, @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
       end
     end
   end

data/lib/flipper/version.rb

@@ -1,5 +1,5 @@
 module Flipper
-  VERSION = '1.2.1'.freeze
+  VERSION = '1.3.0.pre'.freeze
 
   REQUIRED_RUBY_VERSION = '2.6'.freeze
   NEXT_REQUIRED_RUBY_VERSION = '3.0'.freeze

data/spec/flipper/adapters/active_support_cache_store_spec.rb

@@ -8,7 +8,7 @@ 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(:adapter) { described_class.new(memory_adapter, cache, 10, write_through: write_through) }
   let(:flipper) { Flipper.new(adapter) }
 
   subject { adapter }
@@ -19,6 +19,92 @@ 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 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] }
 
@@ -130,17 +216,19 @@ RSpec.describe Flipper::Adapters::ActiveSupportCacheStore do
       adapter.get_all
       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/get_all")).to be_within(2).of(Time.now.to_i)
+      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,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-active_support_cache_store
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0.pre
 platform: ruby
 authors:
 - John Nunemaker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-15 00:00:00.000000000 Z
+date: 2024-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.3.0.pre
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.3.0.pre
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -63,7 +63,7 @@ metadata:
   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.2.1
+  changelog_uri: https://github.com/flippercloud/flipper/releases/tag/v1.3.0.pre
 post_install_message:
 rdoc_options: []
 require_paths: