safer_redis 1.0.0

data/lib/safer_redis/command_doc.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "json"
+
+module SaferRedis
+  class CommandDoc
+    CATEGORY_SLOW = "@slow"
+    CATEGORY_DANGEROUS = "@dangerous"
+
+    # JSON-parsed Redis command data from the embedded copy of
+    # https://github.com/redis/redis-doc/blob/master/commands.json
+    def self.commands_data
+      @commands_data ||= begin
+        base_dir = File.absolute_path(File.join(__dir__, "..", ".."))
+        path = File.join(base_dir, "data", "redis-doc", "commands.json")
+
+        JSON.parse(File.read(path))
+      end
+    end
+
+    # The `redis` gem represents commands internally as an array with the command name
+    # as a lower-case symbol as the first item, e.g. [:del, "foo", "bar"]
+    def self.from_command_array(a)
+      new(a.first.to_s.upcase)
+    end
+
+    def initialize(name)
+      @name = name
+    end
+
+    attr_reader :name
+
+    def url
+      slug = name.downcase.gsub(" ", "-")
+
+      "https://redis.io/commands/#{slug}/"
+    end
+
+    def slow?
+      acl_categories.include?(CATEGORY_SLOW)
+    end
+
+    def dangerous?
+      acl_categories.include?(CATEGORY_DANGEROUS)
+    end
+
+    def acl_categories
+      command.fetch("acl_categories", [])
+    end
+
+    def complexity
+      command.fetch("complexity", nil)
+    end
+
+    private
+
+    def command
+      @command ||= (self.class.commands_data[name] || {})
+    end
+  end
+end

data/lib/safer_redis/danger.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module SaferRedis
+  class Danger < Error
+    def initialize(doc)
+      message = <<~MESSAGE
+        The #{doc.name} Redis command might be dangerous.
+
+        #{doc.url}
+
+        ACL categories: #{doc.acl_categories.join(" ")}
+
+        Complexity: #{doc.complexity}
+
+        If you're sure this is okay, you can try again within `SaferRedis.really { ... }`
+      MESSAGE
+
+      super(message)
+    end
+  end
+end

data/lib/safer_redis/interceptor.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SaferRedis
+  module Interceptor
+    def send_command(command, &block)
+      if SaferRedis.active?
+        SaferRedis.assess!(SaferRedis::CommandDoc.from_command_array(command))
+      end
+
+      super
+    end
+  end
+end

data/lib/safer_redis/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SaferRedis
+  VERSION = "1.0.0"
+end

data/lib/safer_redis.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+Zeitwerk::Loader.for_gem.setup
+
+module SaferRedis
+  class Error < StandardError; end
+
+  def self.activate!(klass: Redis)
+    klass.prepend(SaferRedis::Interceptor)
+    @active = true
+  end
+
+  def self.deactivate!
+    @active = false
+  end
+
+  def self.active?
+    defined?(@active) ? @active : false
+  end
+
+  def self.really
+    was = active?
+    @active = false
+    yield
+  ensure
+    @active = was
+  end
+
+  def self.assess!(doc)
+    if doc.dangerous? || doc.slow?
+      raise SaferRedis::Danger.new(doc)
+    end
+  end
+end

data/safer_redis.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/safer_redis/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "safer_redis"
+  spec.version = SaferRedis::VERSION
+  spec.authors = ["Paul Annesley"]
+  spec.email = ["paul@annesley.cc"]
+
+  spec.summary = "Catch unsafe Redis commands in production"
+  spec.description = "SaferRedis warns you before letting through commands that could impact production availability by being marked `@slow` or `@dangerous` in the Redis documentation"
+  spec.homepage = "https://github.com/buildkite/safer_redis"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/buildkite/safer_redis"
+  spec.metadata["changelog_uri"] = "https://github.com/buildkite/safer_redis/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  # The only strategy implemented so far is intercepting the private Redis#send_command method,
+  # which was introduced in v4.6.0 via https://github.com/redis/redis-rb/pull/1058 and remains
+  # in the latest release (v5.0.5) at time of writing.
+  spec.add_dependency "redis", ">= 4.6.0"
+  spec.add_dependency "zeitwerk"
+end

data/sig/safer_redis.rbs

@@ -0,0 +1,4 @@
+module SaferRedis
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: safer_redis
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Paul Annesley
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.6.0
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: SaferRedis warns you before letting through commands that could impact
+  production availability by being marked `@slow` or `@dangerous` in the Redis documentation
+email:
+- paul@annesley.cc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- data/redis-doc/commands.json
+- lib/safer_redis.rb
+- lib/safer_redis/command_doc.rb
+- lib/safer_redis/danger.rb
+- lib/safer_redis/interceptor.rb
+- lib/safer_redis/version.rb
+- safer_redis.gemspec
+- sig/safer_redis.rbs
+homepage: https://github.com/buildkite/safer_redis
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/buildkite/safer_redis
+  source_code_uri: https://github.com/buildkite/safer_redis
+  changelog_uri: https://github.com/buildkite/safer_redis/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Catch unsafe Redis commands in production
+test_files: []