redis_ui_rails 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 022043af6bf4282e5d29a4983943786b3b12e77596f7f843a10f7d6363efd770
-  data.tar.gz: 5e35877700ad1aab0fb1292b3dcad16beba355e35cac51b995cb32d5decb8888
+  metadata.gz: e74c6167c2329118d6223cf7c11ac899eeb192a989c1db1cfa3a07cfa2545dae
+  data.tar.gz: 8d42cbc5618b945115be2175ac091a38458e2ed36a6ea9ebd36c629e3f370126
 SHA512:
-  metadata.gz: fb2ab5ace7fbbeece6e33111aebbe4c2ed3441f378d6b1dfeca05ee9ac07df55d4e7316b9a19099ea4e86137ac4a8e9dd2420d22cc72cc87f233febfbc3d4126
-  data.tar.gz: 6796f8d8f1fa4a986e1bdfa47d6df6b1d25b8292e72494d434d7836918299ec8ec5c57d067e888fce7d0caa2ee3727fb7ef8ecd0b7fdc2b3a0b5cc07ca986495
+  metadata.gz: 07ad0dee546ad59160a8e82bf60e43d73ef750978f6e1570acb36cc8612ba14d222a8cb3edfa1deee829d2e95c499617b11d61b898f4bd78c3e3deb79b230f19
+  data.tar.gz: e58ae0465fa758f6b8f342ca103e8be3d49244ae3f63bf35aec2be6626eb1e8fa69a0811124f9041bd0f5a118d71aecfd8530f8df95dc5afbe65239e94361bd7

data/CHANGELOG.md

@@ -9,6 +9,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <!-- Add unreleased changes here -->
 
+## [1.2.0] - 2022-09-30
+
+- Added ability to find-and-delete more than just Redis "string" keys.
+
 ## [1.1.0] - 2022-09-16
 
 - Fix `vertical-align` class to properly align text in Firefox

data/app/controllers/redis_ui_rails/key_searches_controller.rb

@@ -7,7 +7,12 @@ module RedisUiRails
     def create
       @instance = Instance.find(params[:id])
       key = params[:key]
-      value = @instance.get(params[:key])
+
+      value = case @instance.type(key)
+      when "none" then nil
+      else
+        "found"
+      end
 
       if value.nil?
         flash[:warning] = "No key '#{key}' found in Redis instance '#{@instance.id}'"
@@ -20,12 +25,15 @@ module RedisUiRails
     def show
       @instance = Instance.find(params[:id])
       @key = params[:key]
-      @value = @instance.get(params[:key])
+      @value = RedisValue.find(@key, instance: @instance)
 
       if @value.nil?
         flash[:warning] = "No key '#{params[:key]}' found in Redis instance '#{@instance.id}'"
         render :new
       end
+    rescue => e
+      flash[:error] = e.message
+      render :new
     end
   end
 end

data/app/views/redis_ui_rails/key_searches/show.html.erb

@@ -16,7 +16,7 @@
     <b class="has-text-weight-bold">Key:</b> <%= @key %>
   </div>
   <div>
-    <b class="has-text-weight-bold">Value:</b> <%= @value %>
+    <b class="has-text-weight-bold">Value (long lists may be truncated):</b> <%= @value %>
   </div>
   <br>
   <%= link_to new_instance_key_search_path(@instance.id) do %>

data/lib/redis_ui_rails/errors.rb

@@ -1,3 +1,7 @@
 module RedisUiRails
   class InstanceMissing < StandardError; end
+
+  class RedisValueMissing < StandardError; end
+
+  class UnsupportedValueType < StandardError; end
 end

data/{app/models → lib}/redis_ui_rails/instance.rb

@@ -19,7 +19,19 @@ module RedisUiRails
     end
 
     delegate :name, :id, :url, :resource_links, to: :config_redis_instance
-    delegate :randomkey, :info, :get, :set, :del, to: :redis
+    delegate(
+      :randomkey,
+      :info,
+      :get,
+      :set,
+      :type,
+      :hgetall,
+      :llen,
+      :lrange,
+      :srandmember,
+      :del,
+      to: :redis
+    )
 
     private
 

data/lib/redis_ui_rails/redis_value.rb

@@ -0,0 +1,25 @@
+module RedisUiRails
+  class RedisValue
+    MAX_RETRIEVED_LIST_LENGTH = 10
+
+    class << self
+      def find(key, instance:)
+        case instance.type(key)
+        when "string"
+          instance.get(key)
+        when "hash"
+          instance.hgetall(key)
+        when "list"
+          max = [instance.llen(key), MAX_RETRIEVED_LIST_LENGTH].min
+          instance.lrange(key, 0, max)
+        when "set"
+          instance.srandmember(key, MAX_RETRIEVED_LIST_LENGTH)
+        when "none"
+          raise RedisValueMissing.new("Unable to find key '#{key}' in Redis instance '#{name}'")
+        else
+          raise UnsupportedValueType.new("Unsupported Redis key value type of '#{instance.type(key)}'")
+        end
+      end
+    end
+  end
+end

data/lib/redis_ui_rails/version.rb

@@ -1,3 +1,3 @@
 module RedisUiRails
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/redis_ui_rails.rb

@@ -8,6 +8,8 @@ require "redis"
 require "redis_ui_rails/version"
 require "redis_ui_rails/errors"
 require "redis_ui_rails/config_redis_instance"
+require "redis_ui_rails/instance"
+require "redis_ui_rails/redis_value"
 require "redis_ui_rails/config"
 require "redis_ui_rails/engine"
 

data/spec/redis_ui_rails/redis_value_spec.rb

@@ -0,0 +1,108 @@
+require "spec_helper"
+
+RSpec.describe RedisUiRails::RedisValue do
+  describe "#find" do
+    let(:mock_redis) { MockRedis.new }
+    let(:config_redis_instance) { RedisUiRails::ConfigRedisInstance.new(name: "dummy") }
+    let(:instance) { RedisUiRails::Instance.new(config_redis_instance) }
+    let(:result) { find! }
+
+    def find!
+      described_class.find(key, instance: instance)
+    end
+
+    before do
+      allow(Redis).to receive(:new).and_return(mock_redis)
+    end
+
+    context "given a string key" do
+      let(:key) { "key" }
+      let(:value) { "val" }
+
+      before(:each) { mock_redis.set(key, value) }
+
+      it "returns the value" do
+        expect(result).to eq(value)
+      end
+    end
+
+    context "given a hash key" do
+      let(:key) { "key" }
+      let(:value) { {"value" => "1"} }
+
+      before(:each) { mock_redis.hset(key, value) }
+
+      it "returns the value" do
+        expect(result).to eq(value)
+      end
+    end
+
+    context "given a list key" do
+      let(:key) { "key" }
+      let(:value) { "value" }
+
+      before(:each) { mock_redis.lpush(key, value) }
+
+      it "returns the value" do
+        expect(result).to eq([value])
+      end
+    end
+
+    context "given a set key" do
+      let(:key) { "key" }
+      let(:value) { "value" }
+
+      before(:each) { mock_redis.sadd(key, value) }
+
+      it "returns the value" do
+        expect(result).to eq([value])
+      end
+    end
+
+    context "given no value" do
+      let(:key) { "missing" }
+
+      it "raises an error" do
+        expect { find! }.to raise_error(RedisUiRails::RedisValueMissing)
+      end
+    end
+
+    context "given an unsupported value type" do
+      let(:key) { "unsupported" }
+
+      before(:each) { allow(instance).to receive(:type).and_return("other") }
+
+      it "raises an error" do
+        expect { find! }.to raise_error(RedisUiRails::UnsupportedValueType)
+      end
+    end
+
+    describe "trunaction of values" do
+      context "given a very long list" do
+        let(:key) { "key" }
+        let(:large_size) { 100 }
+
+        before(:each) do
+          large_size.times { |i| mock_redis.lpush(key, i) }
+        end
+
+        it "truncates the returned list" do
+          expect(result.size).to be < large_size
+        end
+      end
+
+      context "given a very long set" do
+        let(:key) { "key" }
+        let(:large_size) { 100 }
+
+        before(:each) do
+          large_size.times { |i| mock_redis.sadd(key, i) }
+        end
+
+        it "truncates the returned list" do
+          expect(result.size).to be < large_size
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis_ui_rails
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Stitch Fix Engineering
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-21 00:00:00.000000000 Z
+date: 2022-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -236,7 +236,6 @@ files:
 - app/controllers/redis_ui_rails/instances_controller.rb
 - app/controllers/redis_ui_rails/key_searches_controller.rb
 - app/controllers/redis_ui_rails/keys_controller.rb
-- app/models/redis_ui_rails/instance.rb
 - app/views/layouts/redis_ui_rails/application.html.erb
 - app/views/redis_ui_rails/configs/show.html.erb
 - app/views/redis_ui_rails/dashboard/index.html.erb
@@ -254,6 +253,8 @@ files:
 - lib/redis_ui_rails/config_redis_instance.rb
 - lib/redis_ui_rails/engine.rb
 - lib/redis_ui_rails/errors.rb
+- lib/redis_ui_rails/instance.rb
+- lib/redis_ui_rails/redis_value.rb
 - lib/redis_ui_rails/version.rb
 - redis_ui_rails.gemspec
 - spec/feature_spec_helper.rb
@@ -263,6 +264,7 @@ files:
 - spec/integration/instance_keys_spec.rb
 - spec/redis_ui_rails/config_redis_instance_spec.rb
 - spec/redis_ui_rails/config_spec.rb
+- spec/redis_ui_rails/redis_value_spec.rb
 - spec/redis_ui_rails_spec.rb
 - spec/spec_helper.rb
 - spec/support/dummy/app/assets/config/manifest.js