rediconn 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a3d21283e1d2fc7408ee46ef9f2ed42fde12ebc746c8286838de74423490589
-  data.tar.gz: 919073adc67f177847c9f83992b5db89f32437609809beb821df7d8a3ab06afd
+  metadata.gz: 54e6df0f25be3be0062203f5c60fafd449fdc669da8ca541e4c30ee27c1514fd
+  data.tar.gz: ed6906c298c98b89c16c80a0271dbf5194ba34122081fece8ea52fe4f7bf1add
 SHA512:
-  metadata.gz: ec84c0303f1a2fd986990c2544a3fd084a1b5b788b062649d845e2049b5b5c774bc8f6cee3b772fa33e5f82726eb878da63341e4d60405c79fbd9a9dda241a3d
-  data.tar.gz: 4bba5d5d56ece05eb05f3a5cc822ec80de399be16c56c7c2f979c6fc62beacf42b01468345ce8f46c17be763158fe28dc68e02840953c189c6c2bbdff1309e77
+  metadata.gz: f9cd3b6a3b0a46abbe5258f5482571e1b131e61d28de814e341c847b28bfadff00061e270c0e0537a7eceb9f6df3ae5118dcea132ac8efdfc8246e815820be5f
+  data.tar.gz: 61d74b2277f556a99aba92ee56b2993c66125cf677c3b572e33f315c42f415ed1deb49a4316365d6828c6927787527a22d4f4030f33547dc45e005e152095a97

data/lib/rediconn/redis_connection.rb

@@ -77,7 +77,9 @@ module RediConn
           if (ptr = ENV["#{prefix}_REDIS_PROVIDER"]).present?
             return ENV[ptr]
           else
-            vars.push(*KNOWN_REDIS_URL_ENVS.map { |e| ENV["#{prefix}_#{e}"] })
+            # Collect variable *names*, the same as the unprefixed branch below - the lookup at
+            # the end of this method resolves them against ENV
+            vars.push(*KNOWN_REDIS_URL_ENVS.map { |e| "#{prefix}_#{e}" })
           end
         end
 

data/lib/rediconn/version.rb

@@ -1,3 +1,3 @@
 module RediConn
-  VERSION = "0.1.1".freeze
+  VERSION = "0.1.2".freeze
 end

data/spec/rediconn/determine_redis_provider_spec.rb

@@ -0,0 +1,150 @@
+require 'spec_helper'
+
+RSpec.describe RediConn::RedisConnection, '.determine_redis_provider' do
+  PREFIXED = "MYAPP"
+  GLOBAL_URL = "redis://global:6379/0"
+  PREFIXED_URL = "redis://prefixed:6379/1"
+
+  # Every variable this method consults, so an example never inherits the developer's shell
+  MANAGED_VARS = (
+    RediConn::RedisConnection::KNOWN_REDIS_URL_ENVS +
+    RediConn::RedisConnection::KNOWN_REDIS_URL_ENVS.map { |e| "#{PREFIXED}_#{e}" } +
+    ["REDIS_PROVIDER", "#{PREFIXED}_REDIS_PROVIDER", "POINTED_AT_URL"]
+  ).freeze
+
+  around do |example|
+    saved = MANAGED_VARS.to_h { |name| [name, ENV[name]] }
+    MANAGED_VARS.each { |name| ENV.delete(name) }
+    example.run
+  ensure
+    saved.each { |name, value| value.nil? ? ENV.delete(name) : ENV[name] = value }
+  end
+
+  def resolve(prefix: PREFIXED, explicit: false)
+    described_class.send(:determine_redis_provider, prefix: prefix, explicit: explicit)
+  end
+
+  context "with no configuration" do
+    it "returns nil" do
+      expect(resolve).to be_nil
+    end
+  end
+
+  context "with only a global URL" do
+    before { ENV["REDIS_URL"] = GLOBAL_URL }
+
+    it "falls back to it" do
+      expect(resolve).to eq(GLOBAL_URL)
+    end
+
+    it "falls back to it when no prefix is given" do
+      expect(resolve(prefix: nil)).to eq(GLOBAL_URL)
+    end
+
+    it "does not fall back when the prefix is declared explicit" do
+      expect(resolve(explicit: true)).to be_nil
+    end
+  end
+
+  # Regression: the prefixed branch used to collect env *values* while the lookup expected
+  # *names*, so a prefixed URL resolved to nil and silently fell through to the global one
+  context "with a prefixed URL" do
+    before { ENV["#{PREFIXED}_REDIS_URL"] = PREFIXED_URL }
+
+    it "resolves it" do
+      expect(resolve).to eq(PREFIXED_URL)
+    end
+
+    it "resolves it when a global URL is also set" do
+      ENV["REDIS_URL"] = GLOBAL_URL
+
+      expect(resolve).to eq(PREFIXED_URL)
+    end
+
+    it "resolves it when the prefix is declared explicit" do
+      expect(resolve(explicit: true)).to eq(PREFIXED_URL)
+    end
+
+    it "is ignored for a different prefix" do
+      ENV["REDIS_URL"] = GLOBAL_URL
+
+      expect(resolve(prefix: "OTHER")).to eq(GLOBAL_URL)
+    end
+  end
+
+  RediConn::RedisConnection::KNOWN_REDIS_URL_ENVS.each do |var|
+    context "with #{PREFIXED}_#{var}" do
+      it "resolves it" do
+        ENV["#{PREFIXED}_#{var}"] = PREFIXED_URL
+
+        expect(resolve).to eq(PREFIXED_URL)
+      end
+    end
+
+    context "with #{var}" do
+      it "resolves it" do
+        ENV[var] = GLOBAL_URL
+
+        expect(resolve).to eq(GLOBAL_URL)
+      end
+    end
+  end
+
+  context "with a prefixed provider pointer" do
+    before do
+      ENV["#{PREFIXED}_REDIS_PROVIDER"] = "POINTED_AT_URL"
+      ENV["POINTED_AT_URL"] = PREFIXED_URL
+    end
+
+    it "follows the pointer" do
+      expect(resolve).to eq(PREFIXED_URL)
+    end
+
+    it "wins over a global URL" do
+      ENV["REDIS_URL"] = GLOBAL_URL
+
+      expect(resolve).to eq(PREFIXED_URL)
+    end
+  end
+
+  context "with a global provider pointer" do
+    before do
+      ENV["REDIS_PROVIDER"] = "POINTED_AT_URL"
+      ENV["POINTED_AT_URL"] = GLOBAL_URL
+    end
+
+    it "follows the pointer" do
+      expect(resolve).to eq(GLOBAL_URL)
+    end
+
+    it "loses to a prefixed URL" do
+      ENV["#{PREFIXED}_REDIS_URL"] = PREFIXED_URL
+
+      expect(resolve).to eq(PREFIXED_URL)
+    end
+  end
+
+  describe ".configured?" do
+    it "is false when nothing is set" do
+      expect(described_class.configured?(PREFIXED)).to be false
+    end
+
+    it "is true for a prefixed URL" do
+      ENV["#{PREFIXED}_REDIS_URL"] = PREFIXED_URL
+
+      expect(described_class.configured?(PREFIXED)).to be true
+    end
+
+    it "is false for a global URL when the prefix is explicit" do
+      ENV["REDIS_URL"] = GLOBAL_URL
+
+      expect(described_class.configured?(PREFIXED)).to be false
+    end
+
+    it "is true for a global URL when the prefix is not explicit" do
+      ENV["REDIS_URL"] = GLOBAL_URL
+
+      expect(described_class.configured?(PREFIXED, explicit: false)).to be true
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rediconn
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ethan Knapp
@@ -91,6 +91,7 @@ files:
 - lib/rediconn/redis_script.rb
 - lib/rediconn/version.rb
 - rediconn.gemspec
+- spec/rediconn/determine_redis_provider_spec.rb
 - spec/rediconn/redis_connection_spec.rb
 - spec/spec_helper.rb
 homepage: https://instructure.com
@@ -114,5 +115,6 @@ rubygems_version: 3.6.9
 specification_version: 4
 summary: Gem for consistent, de-duplicated Redis Connection Pooling
 test_files:
+- spec/rediconn/determine_redis_provider_spec.rb
 - spec/rediconn/redis_connection_spec.rb
 - spec/spec_helper.rb