redis_ui_rails 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 29709da81ecbe44cd27fe2df64d974f2b3007ecbb5109ebb5174166e73d923d7
+  data.tar.gz: 3b7760666e5850d253e8c9e5db44f12ff2fd03383b3ccc331c37b9b5a0084dfe
+SHA512:
+  metadata.gz: 868503307acb61f6aacbbd9614a1c13c9408bfc66c27f104a5d1049f16909fedf113a43cdcccfcc7a779fc97a65f571e67d3e7d8ebfb98f4fee0a37196de5ab7
+  data.tar.gz: 92c5d2236d3c3a34b927b976774aa2c070e36e0491f802047d775d952e789fdb0eafc15c59c09c15ecc4e682c5b23edbab50033a1169bf995588509d09546862

data/.env.example

@@ -0,0 +1 @@
+LOG_LEVEL='debug'

data/.envrc

@@ -0,0 +1,3 @@
+if [ -f .env ]; then
+  dotenv .env
+fi

data/.gitignore

@@ -0,0 +1,10 @@
+tmp
+*.log
+!database.yml
+Gemfile.lock
+pkg
+.env
+.rspec
+.tool-versions
+.ruby-version
+*.gem

data/.rspec.example

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Specify your gem's dependencies in redis_ui_rails.gemspec.
+gemspec

data/README.md

@@ -0,0 +1,86 @@
+# RedisUiRails
+
+A mountable UI Rails engine for inspecting your Redis instances. The teams that will get the most value out of this engine are teams that cannot use the Rails console to inspect their production Redis instances.
+
+## Installation
+
+1. Add this line to your application's Gemfile:
+
+```ruby
+gem 'redis_ui_rails'
+```
+
+2. In `config/routes.rb`, mount the engine
+
+```ruby
+Rails.application.routes.draw do
+  mount RedisUiRails::Engine => "/redis_ui"
+end
+```
+
+3. Precompile your assets
+
+```bash
+cd path/to/app/root
+bundle exec rake assets:precompile
+```
+
+4. Configure your Redis UI engine.
+
+Example:
+
+```ruby
+# config/initializers/redis_ui_rail.rb
+
+# Each "instance" is a hash, with the following symbolized key structure:
+#   :id (required) The ID used in the URL for this instance.
+#   :name (required) The name that differentiates this Redis instance from others.
+#   :url (required) The URL of the redis instance.
+#   :resource_links (optional) Quick links to resources related to this instance.
+#   :enabled (optional) Allows enabling per environment. Defaults to true.
+#
+RedisUiRails.configure do |config|
+  config.redis_instances = [
+    {
+      id: :local,
+      name: "Local Queue and Cache", # many apps share a queue and cache Redis locally
+      url: ENV["REDIS_URL"],
+      enabled: Rails.env.development? || Rails.env.test?
+    },
+    {
+      id: :cache,
+      name: "Cache",
+      url: ENV.fetch("REDIS_CACHE_URL"), # many apps have separate queue and cache Redis instances in production
+      resource_links: [
+        {
+          label: "Custom Datadog Dashboard",
+          url: "https://myorg.datadoghq.com/path/to/your/dashhboard"
+        }
+      ],
+      enabled: Rails.env.production?
+    }
+  ]
+end
+```
+
+## Local Development
+
+1. Requirements:
+
+- Ruby >= 3.0
+- Direnv (don't forget your [rc file hook](https://direnv.net/docs/installation.html))
+
+2. Initial setup
+
+```
+bundle install
+cp .rspec.example .rspec
+cp .env.example .env
+direnv allow
+```
+
+3. Run tests
+
+```
+bundle exec rspec spec
+```

data/app/assets/config/manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets .css

data/app/assets/stylesheets/redis_ui_rails/application.css

@@ -0,0 +1,26 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */
+.breadcrumb {
+  margin-bottom: 0 !important;
+  padding-top: 1rem;
+  padding-bottom: 1rem;
+  padding-left: 3rem;
+  padding-right: 3rem;
+}
+
+.vertical-align {
+  vertical-align: -webkit-baseline-middle
+}

data/app/controllers/redis_ui_rails/application_controller.rb

@@ -0,0 +1,4 @@
+module RedisUiRails
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/redis_ui_rails/configs_controller.rb

@@ -0,0 +1,11 @@
+module RedisUiRails
+  class ConfigsController < ApplicationController
+    def show
+      @instance = RedisUiRails.config.redis_instances.detect { |obj| params[:id].to_s == obj.id.to_s }
+
+      raise "Missing instance for params: #{params.inspect}. Options are: #{RedisUiRails.config.redis_instances.map(&:id)}" if @instance.nil?
+
+      @redis = Redis.new(url: @instance.url(unredacted: true))
+    end
+  end
+end

data/app/controllers/redis_ui_rails/dashboard_controller.rb

@@ -0,0 +1,7 @@
+module RedisUiRails
+  class DashboardController < ApplicationController
+    def index
+      @redis_instances = RedisUiRails.config.redis_instances
+    end
+  end
+end

data/app/controllers/redis_ui_rails/instances_controller.rb

@@ -0,0 +1,12 @@
+module RedisUiRails
+  class InstancesController < ApplicationController
+    def show
+      @instance = RedisUiRails.config.redis_instances.detect { |obj| params[:id].to_s == obj.id.to_s }
+
+      raise "Missing instance for params: #{params.inspect}. Options are: #{RedisUiRails.config.redis_instances.map(&:id)}" if @instance.nil?
+
+      @redis = Redis.new(url: @instance.url(unredacted: true))
+      @sample_keys = 50.times.map { @redis.randomkey }
+    end
+  end
+end

data/app/controllers/redis_ui_rails/keys_controller.rb

@@ -0,0 +1,12 @@
+module RedisUiRails
+  class KeysController < ApplicationController
+    def show
+      @instance = RedisUiRails.config.redis_instances.detect { |obj| params[:id].to_s == obj.id.to_s }
+
+      raise "Missing instance for params: #{params.inspect}. Options are: #{RedisUiRails.config.redis_instances.map(&:id)}" if @instance.nil?
+
+      @redis = Redis.new(url: @instance.url(unredacted: true))
+      @sample_keys = 50.times.map { @redis.randomkey }.uniq
+    end
+  end
+end

data/app/views/layouts/redis_ui_rails/application.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Redis UI</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bulma@0.9.4/css/bulma.min.css">
+  <%= stylesheet_link_tag "redis_ui_rails/application", media: "all" %>
+</head>
+<body>
+  <%= yield %>
+</body>
+</html>

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

@@ -0,0 +1,18 @@
+<nav class="breadcrumb" aria-label="breadcrumbs">
+  <ul>
+    <li><%= link_to "Dashboard", root_path %></li>
+    <li><%= link_to "Instance Overview", instance_path(@instance.id) %></li>
+    <li class="is-active"><a href="#" aria-current="page">Server Config</a></li>
+  </ul>
+</nav>
+
+<%= render "shared/instance_hero" %>
+
+<section class="section">
+  <h1 class="title">Server Config</h1>
+  <ul>
+    <% @redis.info.except("redis_version").sort.each do |k, v| %>
+      <li><b><%= k %></b>: <%= v %></li>
+    <% end %>
+  </ul>
+</section>

data/app/views/redis_ui_rails/dashboard/index.html.erb

@@ -0,0 +1,23 @@
+<nav class="breadcrumb" aria-label="breadcrumbs">
+  <ul>
+    <li>Dashboard</li>
+  </ul>
+</nav>
+
+<section class="hero is-primary">
+  <div class="hero-body">
+    <h1 class="title">
+      [<%= Rails.env %>] Redis Dashboard
+    </h1>
+  </div>
+</section>
+
+<section class="section">
+  <h1>Redis Instances</h1>
+  <ul>
+    <% @redis_instances.each do |instance| %>
+      <br>
+      <li><%= link_to "#{instance.name} - #{instance.url}", instance_path(instance.id) %></li>
+    <% end %>
+  </ul>
+</section>

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

@@ -0,0 +1,35 @@
+<nav class="breadcrumb" aria-label="breadcrumbs">
+  <ul>
+    <li><%= link_to "Dashboard", root_path %></li>
+    <li class="is-active"><a href="#" aria-current="page">Instance Overview</a></li>
+  </ul>
+</nav>
+
+<%= render "shared/instance_hero" %>
+
+<section class="section">
+  <%= link_to instance_config_path(@instance.id) do %>
+    <div style="color: black;">
+      <button class="button is-info">Config</button>
+      <span class="vertical-align">View Redis server configuration details</span>
+    </div>
+  <% end %>
+  <br>
+  <%= link_to instance_keys_path(@instance.id) do %>
+    <div style="color: black;">
+      <button class="button is-warning">Keys</button>
+      <span class="vertical-align">View a sample of keys currently stored in this Redis.</span>
+    </div>
+  <% end %>
+</section>
+
+<section class="section">
+  <h2 class="title">Resource Links</h2>
+  <div class="content">
+    <ul>
+      <% @instance.resource_links.each do |resource_link| %>
+        <li><a href="<%= resource_link[:url] %>" target="_blank"><%= resource_link[:label] %></a></li>
+      <% end %>
+    </ul>
+  </div>
+</section>

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

@@ -0,0 +1,24 @@
+<nav class="breadcrumb" aria-label="breadcrumbs">
+  <ul>
+    <li><%= link_to "Dashboard", root_path %></li>
+    <li><%= link_to "Instance Overview", instance_path(@instance.id) %></li>
+    <li class="is-active"><a href="#" aria-current="page">Keys</a></li>
+  </ul>
+</nav>
+
+<%= render "shared/instance_hero" %>
+
+<section class="section">
+  <h1 class="title">Sample keys</h1>
+  <%= link_to instance_keys_path(@instance.id) do %>
+    <div style="color: black;">
+      <button class="button is-info">Refresh</button>
+    </div>
+  <% end %>
+  <br>
+  <ul>
+    <% @sample_keys.sort.each do |key| %>
+      <li><%= key %></li>
+    <% end %>
+  </ul>
+</section>

data/app/views/shared/_instance_hero.html.erb

@@ -0,0 +1,13 @@
+<section class="hero is-primary">
+  <div class="hero-body">
+    <h1 class="title">
+      [<%= Rails.env %>] Redis instance: '<%= @instance.name %>'
+    </h1>
+    <p class="subtitle">
+      redis v<%= @redis.info["redis_version"] %>
+    </p>
+    <p class="subtitle">
+      URL: </b><%= @instance.url %>
+    </p>
+  </div>
+</section>

data/config/routes.rb

@@ -0,0 +1,8 @@
+RedisUiRails::Engine.routes.draw do
+  root to: "dashboard#index"
+
+  resources :instances, only: [:show]
+
+  get "instance/:id/keys", to: "keys#show", as: :instance_keys
+  get "instance/:id/config", to: "configs#show", as: :instance_config
+end

data/lib/redis_ui_rails/config.rb

@@ -0,0 +1,64 @@
+module RedisUiRails
+  class Config
+    include ActiveModel::Validations
+
+    validate :validate_redis_instances
+    validate :validate_unique_ids
+    validate :validate_at_least_one_configured
+
+    def initialize
+      self.all_redis_instances = []
+    end
+
+    def redis_instances=(arr)
+      self.all_redis_instances = arr
+    end
+
+    def redis_instances
+      all_redis_instances.select(&:enabled?)
+    end
+
+    def ingest
+      self.redis_instances = Array(all_redis_instances).compact.map do |redis_instance|
+        RedisInstance.new(redis_instance.symbolize_keys)
+      end
+    end
+
+    private
+
+    attr_accessor :all_redis_instances
+
+    def validate_redis_instances
+      unless all_redis_instances.is_a?(Array)
+        return errors.add(:redis_instances, "must be an array")
+      end
+
+      unless all_redis_instances.all?(&:valid?)
+        error_msgs = all_redis_instances.map(&:errors).flatten.map(&:full_messages).flatten
+
+        msg = <<~MSG
+          1 or more Redis UI instance hashes are not valid in the configuration.
+          #{error_msgs.join(", ")}
+        MSG
+        errors.add(:base, msg)
+      end
+    end
+
+    def validate_unique_ids
+      duplicate_ids = all_redis_instances.map(&:id)
+        .tally
+        .select { |id, count| count > 1 }
+        .map { |id, count| count }
+
+      return if duplicate_ids.empty?
+
+      errors.add(:base, "Duplicate Redis instance ids not allowed. Found: #{duplicate_ids.uniq}")
+    end
+
+    def validate_at_least_one_configured
+      return if all_redis_instances.size > 0
+
+      errors.add(:base, "No redis instances configured during initialization. At least one is required.")
+    end
+  end
+end

data/lib/redis_ui_rails/engine.rb

@@ -0,0 +1,12 @@
+module RedisUiRails
+  class Engine < ::Rails::Engine
+    isolate_namespace RedisUiRails
+
+    initializer :assets, group: :all do |app|
+      config.assets.precompile << "redis_ui_rails/application.css"
+      config.assets.precompile << "redis_ui_rails/application.js"
+      config.assets.paths << root.join("assets", "stylesheets").to_s
+      config.assets.paths << root.join("assets", "javascripts").to_s
+    end
+  end
+end

data/lib/redis_ui_rails/redis_instance.rb

@@ -0,0 +1,54 @@
+module RedisUiRails
+  class RedisInstance
+    include ActiveModel::Validations
+
+    REQUIRED_OPTIONS_KEYS = [:url, :name, :id].freeze
+
+    validate :validate_options
+    validate :validate_resource_links
+
+    def initialize(hash)
+      self.options = hash.symbolize_keys
+      self.actual_url = options[:url]
+      self.name = options[:name]
+      self.id = options[:id]
+      self.resource_links = options[:resource_links] || []
+      self.enabled = options.key?(:enabled) ? options[:enabled] : true
+    end
+    attr_accessor :actual_url, :name, :id, :options, :resource_links
+
+    def enabled?
+      enabled
+    end
+
+    def url(unredacted: false)
+      return actual_url if unredacted
+
+      uri = URI(actual_url)
+
+      uri.host = uri.host.to_s.tr("0-9", "*") unless /localhost/.match?(uri.host.to_s)
+
+      uri.password = "*" if uri.user
+
+      uri.to_s
+    end
+
+    private
+
+    attr_accessor :enabled
+
+    def validate_options
+      return if (REQUIRED_OPTIONS_KEYS - options.keys).empty?
+
+      errors.add(:base, "Must have the following keys: '#{REQUIRED_OPTIONS_KEYS.join(", ")}'")
+    end
+
+    def validate_resource_links
+      return if resource_links.all? do |resource_link|
+        resource_link[:url].present? && resource_link[:label].present?
+      end
+
+      errors.add(:base, "All :resource_links must have :url and :label keys")
+    end
+  end
+end

data/lib/redis_ui_rails/version.rb

@@ -0,0 +1,3 @@
+module RedisUiRails
+  VERSION = "1.0.1"
+end

data/lib/redis_ui_rails.rb

@@ -0,0 +1,24 @@
+require "singleton"
+require "rails"
+require "active_model"
+require "forwardable"
+require "uri"
+require "redis"
+
+require "redis_ui_rails/version"
+require "redis_ui_rails/redis_instance"
+require "redis_ui_rails/config"
+require "redis_ui_rails/engine"
+
+module RedisUiRails
+  def self.config
+    @config ||= Config.new
+  end
+
+  def self.configure
+    yield(config)
+
+    config.ingest
+    config.validate!
+  end
+end

data/redis_ui_rails.gemspec

@@ -0,0 +1,30 @@
+require "./lib/redis_ui_rails/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "redis_ui_rails"
+  spec.version = RedisUiRails::VERSION
+  spec.authors = ['Stitch Fix Engineering']
+  spec.email = ['eng@stitchfix.com']
+  spec.homepage = "https://github.com/stitchfix/redis_ui_rails"
+  spec.summary = "A drop-in Rails UI for Redis."
+
+  spec.files = `git ls-files`.split("\n")
+  spec.test_files = `git ls-files -- {spec}/*`.split("\n")
+  spec.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", ">= 6.1.5.1"
+  spec.add_dependency "sprockets", ">= 3.7.2"
+  spec.add_dependency "sprockets-rails"
+  spec.add_dependency "redis"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+
+  # For Dummy Rails app tests
+  spec.add_development_dependency "capybara"
+  spec.add_development_dependency "webdrivers"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "puma"
+  spec.add_development_dependency "net-smtp"
+  spec.add_development_dependency "mock_redis"
+end

data/spec/feature_spec_helper.rb

@@ -0,0 +1,9 @@
+require_relative "./spec_helper"
+require_relative "./support/dummy/config/environment"
+require "capybara/rspec"
+require "webdrivers"
+
+Capybara.configure do |c|
+  c.app = RedisUiRailsDummy::Application
+  c.javascript_driver = :selenium_chrome
+end

data/spec/integration/dashboard_spec.rb

@@ -0,0 +1,12 @@
+require "feature_spec_helper"
+
+RSpec.describe "Dashboard View", type: :feature do
+  # Just a simple smoke test to make sure we haven't broken anything.
+  # Testing details beyond this isn't worth the time given the current
+  # simplicity.
+  it "loads without error" do
+    visit "redis_ui/"
+
+    expect(page).to have_content "Redis Dashboard"
+  end
+end

data/spec/integration/instance_config_spec.rb

@@ -0,0 +1,17 @@
+require "feature_spec_helper"
+
+RSpec.describe "Instance Config", type: :feature do
+  let(:mock_redis) { MockRedis.new }
+  # Just a simple smoke test to make sure we haven't broken anything.
+  # Testing details beyond this isn't worth the time given the current
+  # simplicity.
+  before do
+    allow(Redis).to receive(:new).and_return(mock_redis)
+  end
+
+  it "loads without error" do
+    visit "redis_ui/instance/dummy/config"
+
+    expect(page).to have_content "Server Config"
+  end
+end

data/spec/integration/instance_keys_spec.rb

@@ -0,0 +1,17 @@
+require "feature_spec_helper"
+
+RSpec.describe "Instance Keys", type: :feature do
+  let(:mock_redis) { MockRedis.new }
+  # Just a simple smoke test to make sure we haven't broken anything.
+  # Testing details beyond this isn't worth the time given the current
+  # simplicity.
+  before do
+    allow(Redis).to receive(:new).and_return(mock_redis)
+  end
+
+  it "loads without error" do
+    visit "redis_ui/instance/dummy/keys"
+
+    expect(page).to have_content "Sample keys"
+  end
+end