safer_redis 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0c31676a608f111b89e5de3b5ec1ba3cc46b276afb362eee6aebd1a43120cfb
-  data.tar.gz: 0bc66dde14999d62732ade01b0cf36f645cff45911eff4c818ab0f696bbe9bee
+  metadata.gz: 790845a432c5b85fa5261a8cbca3170058adcc00352f79ae3a1d211e5027b7dc
+  data.tar.gz: 9bacdc397e449211800e19ccd0fb6e99089215db5fbd52593d452ec8b73f44d8
 SHA512:
-  metadata.gz: a854dda2a09c6dd52330afc9de66895eba48447767da9e0cf53bc7a9a7c3dd7e64ca2c1ea4c590f15be29d4bfc53bf7751b9335a09150b85e34d932586f42de6
-  data.tar.gz: 11d94efde9334fd9e242ebd2ec7dcd6ff1a320731cda4f1ec537ca333f642d933b9e87b2cbf0cc16171ecb1c34294570897fa191a60bda823de0c107d3622e5f
+  metadata.gz: f0fa1a49e44253388abaa4483ad9ceeae25b65386c1ed5ecff2820075905245d45684aabd0dfb475041739ec1b938ddcf125e3546d52b22d1380e30793b823f6
+  data.tar.gz: ee4c6847111eb19a6e2d836e557826a3cf9a4a14219dfcb9734e26b9728d9f8649960aa0071c2a2de68f83b421c339713e92291d52b796f8926e3e15cc118b54

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [1.2.0] - 2023-11-14
+
+- Allow `DEL` (`@slow`) if `lazyfree-lazy-user-del` server option is enabled.
+
+## [1.1.0] - 2023-01-07
+
+- Allow `@slow` if it's only `O(1)` complexity, e.g. the `SET` (string) command.
+
 ## [1.0.0] - 2022-12-02
 
 - Initial release

data/Gemfile.lock

@@ -1,37 +1,39 @@
 PATH
   remote: .
   specs:
-    safer_redis (0.1.0)
+    safer_redis (1.1.0)
       redis (>= 4.6.0)
       zeitwerk
 
 GEM
   remote: https://rubygems.org/
   specs:
-    connection_pool (2.3.0)
+    connection_pool (2.4.1)
     diff-lcs (1.5.0)
-    rake (13.0.6)
-    redis (5.0.5)
-      redis-client (>= 0.9.0)
-    redis-client (0.11.2)
+    rake (13.1.0)
+    redis (5.0.8)
+      redis-client (>= 0.17.0)
+    redis-client (0.18.0)
       connection_pool
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.0)
+    rspec-core (3.12.2)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.0)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.0)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    zeitwerk (2.6.6)
+    rspec-support (3.12.1)
+    zeitwerk (2.6.12)
 
 PLATFORMS
   x86_64-darwin-21
+  x86_64-darwin-22
+  x86_64-darwin-23
 
 DEPENDENCIES
   rake (~> 13.0)

data/README.md

@@ -4,9 +4,16 @@ SaferRedis wraps a Redis connection, and warns you before letting through comman
 
 Inspiration is taken from https://github.com/ankane/strong_migrations which provides similar guard-rails for potentially dangerous database migrations.
 
+## Special cases
+
+Commands tagged as `@slow` but with only O(1) complexity are not considered dangerous. This includes
+e.g. the extremely commonly used `SET` command.
+
+The [`DEL`](https://redis.io/commands/del/) command (`@slow`) is treated as [`UNLINK`](https://redis.io/commands/unlink/) (`@fast`) when the `lazyfree-lazy-user-del` server option is set.
+
 ## Limitations
 
-Currently SaferRedis works with the [`redis` gem](https://rubygems.org/gems/redis) from https://github.com/redis/redis-rb (regardless of which connection adapter is being used, e.g. [`hiredis`](https://rubygems.org/gems/hiredis)) by hooking into the private `#send_command` method which was introduced in v4.6.0. This isn't a stable API, so other interception strategies will be considered and may be added in future. Some Redis connectors/drivers suport middleware, but others don't.
+Currently SaferRedis works with the [`redis` gem](https://rubygems.org/gems/redis) from https://github.com/redis/redis-rb (regardless of which connection adapter is being used, e.g. [`hiredis`](https://rubygems.org/gems/hiredis)) by hooking into the private `#send_command` method which was introduced in v4.6.0. This isn't a stable API, so other interception strategies will be considered and may be added in future. Some Redis connectors/drivers support middleware, but others don't.
 
 Some commands are documented at the subcommand level as multiple words (e.g. `CLIENT LIST`). SaferRedis currently only recognises commands documented at their top-level single word (e.g. `DEL`). Support for multi-word commands will be considered and may be added in future.
 

data/lib/safer_redis/assessor.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "json"
+
+module SaferRedis
+  class Assessor
+    def self.assess!(doc, redis:)
+      # DEL becomes UNLINK if lazyfree-lazy-user-del is set
+      # https://github.com/redis/redis/pull/6243
+      # https://redis.io/docs/management/config-file/
+      if doc.name == "DEL" && config_get("lazyfree-lazy-user-del", redis:) == "yes"
+        doc = SaferRedis::CommandDoc.new("UNLINK")
+      end
+
+      if doc.dangerous?
+        # Anything tagged @dangerous is… dangerous
+        raise SaferRedis::Danger.new(doc)
+
+      elsif doc.slow? && doc.complexity != "O(1)"
+        # Anything tagged @slow might be dangerous, but we'll let through O(1)
+        # complexity commands e.g. SET
+        raise SaferRedis::Danger.new(doc)
+      end
+    end
+
+    def self.config_get(option, redis:)
+      SaferRedis.really { redis.config(:get, option)[option] }
+    end
+  end
+end

data/lib/safer_redis/command_doc.rb

@@ -52,6 +52,10 @@ module SaferRedis
       command.fetch("complexity", nil)
     end
 
+    def suggestion
+      Suggestion.for_command(name)
+    end
+
     private
 
     def command

data/lib/safer_redis/danger.rb

@@ -15,6 +15,13 @@ module SaferRedis
         If you're sure this is okay, you can try again within `SaferRedis.really { ... }`
       MESSAGE
 
+      if doc.suggestion
+        message = <<~MESSAGE
+          #{message}
+          Suggestion: #{doc.suggestion.description}
+        MESSAGE
+      end
+
       super(message)
     end
   end

data/lib/safer_redis/interceptor.rb

@@ -4,7 +4,10 @@ module SaferRedis
   module Interceptor
     def send_command(command, &block)
       if SaferRedis.active?
-        SaferRedis.assess!(SaferRedis::CommandDoc.from_command_array(command))
+        SaferRedis::Assessor.assess!(
+          SaferRedis::CommandDoc.from_command_array(command),
+          redis: self,
+        )
       end
 
       super

data/lib/safer_redis/suggestion.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module SaferRedis
+  class Suggestion
+    attr_reader :command, :description
+
+    def initialize(command, description)
+      @command = command
+      @description = description
+    end
+
+    def self.for_command(command)
+      case command
+      when "DEL"
+        new(command, <<~END)
+          Consider using the non-blocking UNLINK command instead to delete the key on a \
+          background thread, or set the lazyfree-lazy-user-del server option
+        END
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/safer_redis/version.rb

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

data/lib/safer_redis.rb

@@ -26,10 +26,4 @@ module SaferRedis
   ensure
     @active = was
   end
-
-  def self.assess!(doc)
-    if doc.dangerous? || doc.slow?
-      raise SaferRedis::Danger.new(doc)
-    end
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safer_redis
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Paul Annesley
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-02 00:00:00.000000000 Z
+date: 2023-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -56,11 +56,12 @@ files:
 - Rakefile
 - data/redis-doc/commands.json
 - lib/safer_redis.rb
+- lib/safer_redis/assessor.rb
 - lib/safer_redis/command_doc.rb
 - lib/safer_redis/danger.rb
 - lib/safer_redis/interceptor.rb
+- lib/safer_redis/suggestion.rb
 - lib/safer_redis/version.rb
-- safer_redis.gemspec
 - sig/safer_redis.rbs
 homepage: https://github.com/buildkite/safer_redis
 licenses:
@@ -77,14 +78,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: Catch unsafe Redis commands in production

data/safer_redis.gemspec

@@ -1,35 +0,0 @@
-# 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