flipper-dalli 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46bffba42a4bebe087a33ed757147ef0abe92bad5bc8417cad5eebd55c083e0b
-  data.tar.gz: 585bcfdef7495be45d2004c5a57123a0c8841f872cb7802796acbf90b1325aea
+  metadata.gz: 960ecc222c7e5c33b7837cca5d48f2ae5039cc050301977d3b14dfd94d9c6081
+  data.tar.gz: e759cb6f88b00a59265e9d7084046afa6e1f37b5321ab65f12ecdc9403490733
 SHA512:
-  metadata.gz: a99d7deea1e125024a759a91857ce5ed564e68952e1096cd79e288b372d592adebb7f6530119fee3c26d7e266489d58057430b16a7762b252151323a0d79bc19
-  data.tar.gz: 42874c56819a0ce8ad2061910ae0c11121a9a1173dff6203b5cff45939c7627c574a65fcca17876c2b81b29148fe58d3b4fc4ce04c34fba22927033ce501090d
+  metadata.gz: 0c0c0a121101433f3cdac3cf3d58921fd03bfecc406cd642d00b527be8b359a657216afd37c72b0873e80d40cb070786c83e20ce6abcf036448cece9d3b8a788
+  data.tar.gz: 1cf7e3aec7f903bd74e4b1b55e931ca09acb35e7c1eb64114f6ee52d1698a4efb8f632f5953e5956a07d07e00af40e08328599902fba742e2ecee8f7085e862d

data/lib/flipper/adapters/dalli.rb

@@ -1,127 +1,32 @@
 require 'dalli'
 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 Memcached using the Dalli gem.
-    class Dalli
-      include ::Flipper::Adapter
-
-      # Internal
-      attr_reader :cache
-
-      # Public: The ttl for all cached data.
-      attr_reader :ttl
-
-      # Public
-      def initialize(adapter, cache, ttl = 0)
-        @adapter = adapter
-        @cache = cache
-        @ttl = ttl
-
-        @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)
-        @cache.delete(key_for(feature.key))
-        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), @ttl) do
-          @adapter.get(feature)
-        end
-      end
-
-      def get_multi(features)
-        read_many_features(features)
-      end
-
-      def get_all
-        if @cache.add(@get_all_key, Time.now.to_i, @ttl)
-          response = @adapter.get_all
-          response.each do |key, value|
-            @cache.set(key_for(key), value, @ttl)
-          end
-          @cache.set(@features_key, response.keys.to_set, @ttl)
-          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.delete(key_for(feature.key))
-        result
-      end
-
-      # Public
-      def disable(feature, gate, thing)
-        result = @adapter.disable(feature, gate, thing)
-        @cache.delete(key_for(feature.key))
-        result
+    class Dalli < CacheBase
+      def initialize(adapter, cache, ttl = 0, prefix: nil)
+        super
       end
 
       private
 
-      def key_for(key)
-        "#{@namespace}/feature/#{key}"
+      def cache_fetch(key, &block)
+        @cache.fetch(key, @ttl, &block)
       end
 
-      def read_feature_keys
-        @cache.fetch(@features_key, @ttl) { @adapter.features }
+      def cache_read_multi(keys)
+        @cache.get_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.get_multi(keys)
-        uncached_features = features.reject { |feature| cache_result[key_for(feature.key)] }
-
-        if uncached_features.any?
-          response = @adapter.get_multi(uncached_features)
-          response.each do |key, value|
-            @cache.set(key_for(key), value, @ttl)
-            cache_result[key_for(key)] = value
-          end
-        end
+      def cache_write(key, value)
+        @cache.set(key, value, @ttl)
+      end
 
-        result = {}
-        features.each do |feature|
-          result[feature.key] = cache_result[key_for(feature.key)]
-        end
-        result
+      def cache_delete(key)
+        @cache.delete(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/dalli_spec.rb

@@ -7,7 +7,7 @@ RSpec.describe Flipper::Adapters::Dalli do
     Flipper::Adapters::OperationLogger.new(Flipper::Adapters::Memory.new)
   end
   let(:cache)   { Dalli::Client.new(ENV['MEMCACHED_URL']) }
-  let(:adapter) { described_class.new(memory_adapter, cache) }
+  let(:adapter) { described_class.new(memory_adapter, cache, 10) }
   let(:flipper) { Flipper.new(adapter) }
 
   subject { adapter }
@@ -21,6 +21,72 @@ RSpec.describe Flipper::Adapters::Dalli 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(cache.get("flipper/v1/features")).not_to be(nil)
+
+    # expire cache
+    adapter.expire_features_cache
+    expect(cache.get("flipper/v1/features")).to be(nil)
+  end
+
+  it "can expire feature cache" do
+    # cache the features
+    adapter.get(flipper[:stats])
+    expect(cache.get("flipper/v1/feature/stats")).not_to be(nil)
+
+    # expire cache
+    adapter.expire_feature_cache("stats")
+    expect(cache.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, cache, 0, 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.get("foo/flipper/v1/feature/stats")).not_to be(nil)
+
+      # check individual feature expired with prefix
+      adapter.remove(flipper[:stats])
+      expect(cache.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(cache.get("foo/flipper/v1/feature/search")[:percentage_of_actors]).to eq("10")
+      expect(cache.get("foo/flipper/v1/feature/stats")[:boolean]).to eq("true")
+    end
+  end
+
   describe '#remove' do
     it 'expires feature' do
       feature = flipper[:stats]
@@ -68,17 +134,19 @@ RSpec.describe Flipper::Adapters::Dalli do
       adapter.get_all
       expect(cache.get("flipper/v1/feature/#{stats.key}")[:boolean]).to eq('true')
       expect(cache.get("flipper/v1/feature/#{search.key}")[:boolean]).to be(nil)
-      expect(cache.get("flipper/v1/get_all")).to be_within(2).of(Time.now.to_i)
+      expect(cache.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-dalli
 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: dalli
   requirement: !ruby/object:Gem::Requirement
@@ -64,7 +64,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: