flipper-redis 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e55b034a67c36b705521502c717a6a702e20fe7339571700e7a9250f49f21781
-  data.tar.gz: 95633728475c7a39bd88fd59b17ba4924dbbf9c98e2f7a2b0f196722302b1b19
+  metadata.gz: 8469e0a68d8a08cc42f6e8a50ca2b3121495f3200510a9ebe71e3c4a2304a2af
+  data.tar.gz: bca16917e5dd42cfdbae647ff87c83f5420f12855c61930247fb6b50cecda34e
 SHA512:
-  metadata.gz: 4cf728abd260addff1b057c68b0ea401458bc53fe8aa1ec4247d322dd1f1083fdbec76d20a4d3fc3bd123c4babde353d5a5be1d66ff07be1881e5430e794d21f
-  data.tar.gz: af6843a3bb222f418ae9917bde9b7d4d9d5f37bcb88371950ad834a7f6d557c0bf7ee8779bcfba8ee57fe6f6144bb1ab928ecbac04fdd3d7290dd70c441f28d0
+  metadata.gz: d765d8c9434676e1ed307ffbae3e9aa4652712c91208d72ddbdd3b8ca1114af8bf7aa0590821ed55b51c103ef9f2248e63461f592071fe56897662bc010c6ab4
+  data.tar.gz: 1e43b7077112e805baf33f8ad6df5528b009b1d23bc3477d43d249cc1537fa907daf66835eed3cfb24933590001cd433ad6b5d695c260878956775c29367c7a4

data/lib/flipper/adapters/redis_cache.rb

@@ -1,147 +1,45 @@
 require 'redis'
 require 'flipper'
+require 'flipper/adapters/cache_base'
 
 module Flipper
   module Adapters
     # Public: Adapter that wraps another adapter with the ability to cache
-    # adapter calls in Redis
-    class RedisCache
-      include ::Flipper::Adapter
-
-      # Internal
-      attr_reader :cache
-
-      # Public
-      def initialize(adapter, cache, ttl = 3600)
-        @adapter = adapter
-        @cache = cache
-        @ttl = ttl
-
-        @version = 'v1'.freeze
-        @namespace = "flipper/#{@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.del(@features_key)
-        result
-      end
-
-      # Public
-      def remove(feature)
-        result = @adapter.remove(feature)
-        @cache.del(@features_key)
-        @cache.del(key_for(feature.key))
-        result
-      end
-
-      # Public
-      def clear(feature)
-        result = @adapter.clear(feature)
-        @cache.del(key_for(feature.key))
-        result
-      end
-
-      # Public
-      def get(feature)
-        fetch(key_for(feature.key)) do
-          @adapter.get(feature)
-        end
-      end
-
-      def get_multi(features)
-        read_many_features(features)
-      end
-
-      def get_all
-        if @cache.setnx(@get_all_key, Time.now.to_i)
-          @cache.expire(@get_all_key, @ttl)
-          response = @adapter.get_all
-          response.each do |key, value|
-            set_with_ttl key_for(key), value
-          end
-          set_with_ttl @features_key, response.keys.to_set
-          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)
-        @cache.del(key_for(feature.key))
-        result
-      end
-
-      # Public
-      def disable(feature, gate, thing)
-        result = @adapter.disable(feature, gate, thing)
-        @cache.del(key_for(feature.key))
-        result
+    # adapter calls in Redis.
+    class RedisCache < CacheBase
+      def initialize(adapter, cache, ttl = 3600, prefix: nil)
+        super
       end
 
       private
 
-      def key_for(key)
-        "#{@namespace}/feature/#{key}"
-      end
-
-      def read_feature_keys
-        fetch(@features_key) { @adapter.features }
-      end
-
-      def read_many_features(features)
-        keys = features.map(&:key)
-        cache_result = Hash[keys.zip(multi_cache_get(keys))]
-        uncached_features = features.reject { |feature| cache_result[feature.key] }
-
-        if uncached_features.any?
-          response = @adapter.get_multi(uncached_features)
-          response.each do |key, value|
-            set_with_ttl(key_for(key), value)
-            cache_result[key] = value
-          end
-        end
-
-        result = {}
-        features.each do |feature|
-          result[feature.key] = cache_result[feature.key]
-        end
-        result
-      end
-
-      def fetch(cache_key)
-        cached = @cache.get(cache_key)
+      def cache_fetch(key, &block)
+        cached = @cache.get(key)
         if cached
           Marshal.load(cached)
         else
           to_cache = yield
-          set_with_ttl(cache_key, to_cache)
+          cache_write key, to_cache
           to_cache
         end
       end
 
-      def set_with_ttl(key, value)
-        @cache.setex(key, @ttl, Marshal.dump(value))
-      end
+      def cache_read_multi(keys)
+        return {} if keys.empty?
 
-      def multi_cache_get(keys)
-        return [] if keys.empty?
-
-        cache_keys = keys.map { |key| key_for(key) }
-        @cache.mget(*cache_keys).map do |value|
+        values = @cache.mget(*keys).map do |value|
           value ? Marshal.load(value) : nil
         end
+
+        Hash[keys.zip(values)]
+      end
+
+      def cache_write(key, value)
+        @cache.setex(key, @ttl, Marshal.dump(value))
+      end
+
+      def cache_delete(key)
+        @cache.del(key)
       end
     end
   end

data/lib/flipper/version.rb

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

data/spec/flipper/adapters/redis_cache_spec.rb

@@ -11,7 +11,7 @@ RSpec.describe Flipper::Adapters::RedisCache do
   let(:memory_adapter) do
     Flipper::Adapters::OperationLogger.new(Flipper::Adapters::Memory.new)
   end
-  let(:adapter) { described_class.new(memory_adapter, client) }
+  let(:adapter) { described_class.new(memory_adapter, client, 10) }
   let(:flipper) { Flipper.new(adapter) }
 
   subject { adapter }
@@ -24,6 +24,73 @@ RSpec.describe Flipper::Adapters::RedisCache do
 
   it_should_behave_like 'a flipper adapter'
 
+  it "knows ttl" do
+    expect(adapter.ttl).to eq(10)
+  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(client.get("flipper/v1/features")).not_to be(nil)
+
+    # expire cache
+    adapter.expire_features_cache
+    expect(client.get("flipper/v1/features")).to be(nil)
+  end
+
+  it "can expire feature cache" do
+    # cache the features
+    adapter.get(flipper[:stats])
+    expect(client.get("flipper/v1/feature/stats")).not_to be(nil)
+
+    # expire cache
+    adapter.expire_feature_cache("stats")
+    expect(client.get("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, client, 3600, 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(Marshal.load(client.get("foo/flipper/v1/feature/stats"))).not_to be(nil)
+
+      # check individual feature expired with prefix
+      adapter.remove(flipper[:stats])
+      expect(client.get("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(Marshal.load(client.get("foo/flipper/v1/features"))).to eq(Set["stats", "search"])
+      expect(Marshal.load(client.get("foo/flipper/v1/feature/search"))[:percentage_of_actors]).to eq("10")
+      expect(Marshal.load(client.get("foo/flipper/v1/feature/stats"))[:boolean]).to eq("true")
+    end
+  end
+
   describe '#remove' do
     it 'expires feature' do
       feature = flipper[:stats]
@@ -82,17 +149,19 @@ RSpec.describe Flipper::Adapters::RedisCache do
       adapter.get_all
       expect(Marshal.load(client.get("flipper/v1/feature/#{stats.key}"))[:boolean]).to eq('true')
       expect(Marshal.load(client.get("flipper/v1/feature/#{search.key}"))[:boolean]).to be(nil)
-      expect(client.get("flipper/v1/get_all").to_i).to be_within(2).of(Time.now.to_i)
+      expect(Marshal.load(client.get("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-redis
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - John Nunemaker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-19 00:00:00.000000000 Z
+date: 2024-04-17 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.2
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.2
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -70,7 +70,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.2
+  changelog_uri: https://github.com/flippercloud/flipper/releases/tag/v1.3.0
 post_install_message:
 rdoc_options: []
 require_paths: