flipper-redis 1.3.2 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bea3fee40316abcb1c8f5456ac56e11e4c0335ac61d7c97a61ee2da019db1788
-  data.tar.gz: ba0f54b8675619045d6bf4d81b411f06989355d3da183b7269b2ba250d335f28
+  metadata.gz: a790000c8a290b42d4e92173ddc5e00632c7113b16ca47c4c257d26ee36005aa
+  data.tar.gz: 6e6b7c2d513a8472e6bdc7cb99dff07daaf984751d7c7880bde92622663f95dc
 SHA512:
-  metadata.gz: 647d41d33a87aa7bfe4e48a39b385d3a88f1a04aab357b768f6f1fac07eaf49b3502910c86dded0db5b02c63a72169b7239382af7b70ff2c4611865fa7a59ca8
-  data.tar.gz: 50ef503e56b12b349caede24733e39ee66613c770f7f0a52565c75341535df6180e1af7359c5fdd0f8d0572a3ca644fa282fc1832730a87fd7f5eeb1008b278a
+  metadata.gz: ae7bf6f058f1a54ef97bbc2b3e86e03398d01c65df8f9752c5b0351d476e70d91754680df9223b15162c0dbd9c8cdfeb7ce5f4d40da6c6443915a2c8cecaf777
+  data.tar.gz: 709339de3e5a6cb919a2ae8fbf63f882f16fc06b7339b4fe171aef7d70feb4961031af6269b6fede7877a0bd5d1b96962b3025cc2bd4285ea6abe87ee0d59cc4

data/lib/flipper/adapters/redis.rb

@@ -1,11 +1,13 @@
 require 'set'
 require 'redis'
 require 'flipper'
+require 'flipper/adapters/redis_shared/methods'
 
 module Flipper
   module Adapters
     class Redis
       include ::Flipper::Adapter
+      include ::Flipper::Adapters::RedisShared
 
       attr_reader :key_prefix
 
@@ -25,6 +27,9 @@ module Flipper
       def initialize(client, key_prefix: nil)
         @client = client
         @key_prefix = key_prefix
+        @sadd_returns_boolean = with_connection do |conn|
+          conn.class.respond_to?(:sadd_returns_boolean) && conn.class.sadd_returns_boolean
+        end
       end
 
       # Public: The set of known features.
@@ -35,9 +40,9 @@ module Flipper
       # Public: Adds a feature to the set of known features.
       def add(feature)
         if redis_sadd_returns_boolean?
-          @client.sadd? features_key, feature.key
+          with_connection { |conn| conn.sadd? features_key, feature.key }
         else
-          @client.sadd features_key, feature.key
+          with_connection { |conn| conn.sadd features_key, feature.key }
         end
         true
       end
@@ -45,17 +50,17 @@ module Flipper
       # Public: Removes a feature from the set of known features.
       def remove(feature)
         if redis_sadd_returns_boolean?
-          @client.srem? features_key, feature.key
+          with_connection { |conn| conn.srem? features_key, feature.key }
         else
-          @client.srem features_key, feature.key
+          with_connection { |conn| conn.srem features_key, feature.key }
         end
-        @client.del key_for(feature.key)
+        with_connection { |conn| conn.del key_for(feature.key) }
         true
       end
 
       # Public: Clears the gate values for a feature.
       def clear(feature)
-        @client.del key_for(feature.key)
+        with_connection { |conn| conn.del key_for(feature.key) }
         true
       end
 
@@ -88,13 +93,13 @@ module Flipper
         case gate.data_type
         when :boolean
           clear(feature)
-          @client.hset feature_key, gate.key, thing.value.to_s
+          with_connection { |conn| conn.hset feature_key, gate.key, thing.value.to_s }
         when :integer
-          @client.hset feature_key, gate.key, thing.value.to_s
+          with_connection { |conn| conn.hset feature_key, gate.key, thing.value.to_s }
         when :set
-          @client.hset feature_key, to_field(gate, thing), 1
+          with_connection { |conn| conn.hset feature_key, to_field(gate, thing), 1 }
         when :json
-          @client.hset feature_key, gate.key, Typecast.to_json(thing.value)
+          with_connection { |conn| conn.hset feature_key, gate.key, Typecast.to_json(thing.value) }
         else
           unsupported_data_type gate.data_type
         end
@@ -113,13 +118,13 @@ module Flipper
         feature_key = key_for(feature.key)
         case gate.data_type
         when :boolean
-          @client.del feature_key
+          with_connection { |conn| conn.del feature_key }
         when :integer
-          @client.hset feature_key, gate.key, thing.value.to_s
+          with_connection { |conn| conn.hset feature_key, gate.key, thing.value.to_s }
         when :set
-          @client.hdel feature_key, to_field(gate, thing)
+          with_connection { |conn| conn.hdel feature_key, to_field(gate, thing) }
         when :json
-          @client.hdel feature_key, gate.key
+          with_connection { |conn| conn.hdel feature_key, gate.key }
         else
           unsupported_data_type gate.data_type
         end
@@ -130,7 +135,7 @@ module Flipper
       private
 
       def redis_sadd_returns_boolean?
-        @client.class.respond_to?(:sadd_returns_boolean) && @client.class.sadd_returns_boolean
+        @sadd_returns_boolean
       end
 
       def read_many_features(features)
@@ -143,20 +148,26 @@ module Flipper
       end
 
       def read_feature_keys
-        @client.smembers(features_key).to_set
+        with_connection { |conn| conn.smembers(features_key).to_set }
       end
 
       # Private: Gets a hash of fields => values for the given feature.
       #
       # Returns a Hash of fields => values.
-      def doc_for(feature, pipeline: @client)
-        pipeline.hgetall(key_for(feature.key))
+      def doc_for(feature, pipeline: nil)
+        if pipeline
+          pipeline.hgetall(key_for(feature.key))
+        else
+          with_connection { |conn| conn.hgetall(key_for(feature.key)) }
+        end
       end
 
       def docs_for(features)
-        @client.pipelined do |pipeline|
-          features.each do |feature|
-            doc_for(feature, pipeline: pipeline)
+        with_connection do |conn|
+          conn.pipelined do |pipeline|
+            features.each do |feature|
+              doc_for(feature, pipeline: pipeline)
+            end
           end
         end
       end
@@ -208,7 +219,7 @@ end
 
 Flipper.configure do |config|
   config.adapter do
-    client = Redis.new(url: ENV["FLIPPER_REDIS_URL"] || ENV["REDIS_URL"])
+    client = Redis.new(url: ENV["FLIPPER_REDIS_URL"] || ENV["REDIS_URL"] || "redis://localhost:6379")
     Flipper::Adapters::Redis.new(client)
   end
 end

data/lib/flipper/adapters/redis_cache.rb

@@ -1,20 +1,24 @@
 require 'redis'
 require 'flipper'
 require 'flipper/adapters/cache_base'
+require 'flipper/adapters/redis_shared/methods'
 
 module Flipper
   module Adapters
     # Public: Adapter that wraps another adapter with the ability to cache
     # adapter calls in Redis.
     class RedisCache < CacheBase
+      include ::Flipper::Adapters::RedisShared
+
       def initialize(adapter, cache, ttl = 3600, prefix: nil)
+        @client = cache
         super
       end
 
       private
 
       def cache_fetch(key, &block)
-        cached = @cache.get(key)
+        cached = with_connection { |conn| conn.get(key) }
         if cached
           Marshal.load(cached)
         else
@@ -27,7 +31,7 @@ module Flipper
       def cache_read_multi(keys)
         return {} if keys.empty?
 
-        values = @cache.mget(*keys).map do |value|
+        values = with_connection { |conn| conn.mget(*keys) }.map do |value|
           value ? Marshal.load(value) : nil
         end
 
@@ -35,11 +39,11 @@ module Flipper
       end
 
       def cache_write(key, value)
-        @cache.setex(key, @ttl, Marshal.dump(value))
+        with_connection { |conn| conn.setex(key, @ttl, Marshal.dump(value)) }
       end
 
       def cache_delete(key)
-        @cache.del(key)
+        with_connection { |conn| conn.del(key) }
       end
     end
   end

data/lib/flipper/adapters/redis_shared/methods.rb

@@ -0,0 +1,9 @@
+module Flipper
+  module Adapters
+    module RedisShared
+      def with_connection(&block)
+        @client.respond_to?(:with) ? @client.with(&block) : yield(@client)
+      end
+    end
+  end
+end

data/lib/flipper/version.rb

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

data/spec/flipper/adapters/redis_cache_spec.rb

@@ -3,9 +3,7 @@ require 'flipper/adapters/redis_cache'
 
 RSpec.describe Flipper::Adapters::RedisCache do
   let(:client) do
-    options = {}
-    options[:url] = ENV['REDIS_URL'] if ENV['REDIS_URL']
-    Redis.new(options)
+    Redis.new(url: ENV.fetch('REDIS_URL', 'redis://localhost:6379'))
   end
 
   let(:memory_adapter) do

data/spec/flipper/adapters/redis_spec.rb

@@ -1,55 +1,101 @@
 require 'flipper/adapters/redis'
+require 'connection_pool'
 
 RSpec.describe Flipper::Adapters::Redis do
-  let(:client) do
-    options = {}
+  context "redis instance" do
+    let(:client) do
+      Redis.raise_deprecations = true
+      Redis.new(url: ENV.fetch('REDIS_URL', 'redis://localhost:6379'))
+    end
 
-    options[:url] = ENV['REDIS_URL'] if ENV['REDIS_URL']
+    subject { described_class.new(client) }
 
-    Redis.raise_deprecations = true
-    Redis.new(options)
-  end
+    before do
+      skip_on_error(Redis::CannotConnectError, 'Redis not available') do
+        client.flushdb
+      end
+    end
+
+    it_should_behave_like 'a flipper adapter'
 
-  subject { described_class.new(client) }
+    it 'configures itself on load' do
+      Flipper.configuration = nil
+      Flipper.instance = nil
 
-  before do
-    skip_on_error(Redis::CannotConnectError, 'Redis not available') do
-      client.flushdb
+      silence { load 'flipper/adapters/redis.rb' }
+
+      expect(Flipper.adapter.adapter).to be_a(Flipper::Adapters::Redis)
     end
-  end
 
-  it_should_behave_like 'a flipper adapter'
+    describe 'with a key_prefix' do
+      let(:subject) { described_class.new(client, key_prefix: "lockbox:") }
+      let(:feature) { Flipper::Feature.new(:search, subject) }
+
+      it_should_behave_like 'a flipper adapter'
+
+      it 'namespaces feature-keys' do
+        subject.add(feature)
 
-  it 'configures itself on load' do
-    Flipper.configuration = nil
-    Flipper.instance = nil
+        expect(client.smembers("flipper_features")).to eq([])
+        expect(client.exists?("search")).to eq(false)
+        expect(client.smembers("lockbox:flipper_features")).to eq(["search"])
+        expect(client.hgetall("lockbox:search")).not_to eq(nil)
+      end
 
-    silence { load 'flipper/adapters/redis.rb' }
+      it "can remove namespaced keys" do
+        subject.add(feature)
+        expect(client.smembers("lockbox:flipper_features")).to eq(["search"])
 
-    expect(Flipper.adapter.adapter).to be_a(Flipper::Adapters::Redis)
+        subject.remove(feature)
+        expect(client.smembers("lockbox:flipper_features")).to be_empty
+      end
+    end
   end
 
-  describe 'with a key_prefix' do
-    let(:subject) { described_class.new(client, key_prefix: "lockbox:") }
-    let(:feature) { Flipper::Feature.new(:search, subject) }
+  context "with a connection pool instance" do
+    let(:client) do
+      Redis.raise_deprecations = true
+      ConnectionPool.new(size: 1, timeout: 1) {
+        Redis.new(url: ENV.fetch('REDIS_URL', 'redis://localhost:6379'))
+      }
+    end
+
+    subject { described_class.new(client) }
+
+    before do
+      skip_on_error(Redis::CannotConnectError, 'Redis not available') do
+        client.with { |conn| conn.flushdb }
+      end
+    end
 
     it_should_behave_like 'a flipper adapter'
 
-    it 'namespaces feature-keys' do
-      subject.add(feature)
+    describe 'with a key_prefix' do
+      let(:subject) { described_class.new(client, key_prefix: "lockbox:") }
+      let(:feature) { Flipper::Feature.new(:search, subject) }
 
-      expect(client.smembers("flipper_features")).to eq([])
-      expect(client.exists?("search")).to eq(false)
-      expect(client.smembers("lockbox:flipper_features")).to eq(["search"])
-      expect(client.hgetall("lockbox:search")).not_to eq(nil)
-    end
+      it_should_behave_like 'a flipper adapter'
+
+      it 'namespaces feature-keys' do
+        subject.add(feature)
+
+        client.with do |conn|
+          expect(conn.smembers("flipper_features")).to eq([])
+          expect(conn.exists?("search")).to eq(false)
+          expect(conn.smembers("lockbox:flipper_features")).to eq(["search"])
+          expect(conn.hgetall("lockbox:search")).not_to eq(nil)
+        end
+      end
 
-    it "can remove namespaced keys" do
-      subject.add(feature)
-      expect(client.smembers("lockbox:flipper_features")).to eq(["search"])
+      it "can remove namespaced keys" do
+        client.with do |conn|
+          subject.add(feature)
+          expect(conn.smembers("lockbox:flipper_features")).to eq(["search"])
 
-      subject.remove(feature)
-      expect(client.smembers("lockbox:flipper_features")).to be_empty
+          subject.remove(feature)
+          expect(conn.smembers("lockbox:flipper_features")).to be_empty
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: flipper-redis
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.3
 platform: ruby
 authors:
 - John Nunemaker
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-19 00:00:00.000000000 Z
+date: 2025-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper
@@ -16,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.2
+        version: 1.3.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.2
+        version: 1.3.3
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -44,7 +43,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6'
-description:
 email: support@flippercloud.io
 executables: []
 extensions: []
@@ -57,6 +55,7 @@ files:
 - lib/flipper-redis.rb
 - lib/flipper/adapters/redis.rb
 - lib/flipper/adapters/redis_cache.rb
+- lib/flipper/adapters/redis_shared/methods.rb
 - lib/flipper/version.rb
 - spec/flipper/adapters/redis_cache_spec.rb
 - spec/flipper/adapters/redis_spec.rb
@@ -70,8 +69,8 @@ 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.3.2
-post_install_message:
+  changelog_uri: https://github.com/flippercloud/flipper/releases/tag/v1.3.3
+  funding_uri: https://github.com/sponsors/flippercloud
 rdoc_options: []
 require_paths:
 - lib
@@ -86,8 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 3.6.5
 specification_version: 4
 summary: Redis feature flag adapter for Flipper
 test_files: