safer_redis 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b398837bfdbe584e367b80c02a881ebd6a9b2c975efc3aa4e36184530306cad
-  data.tar.gz: d3adf217f7f8df1a0bda2b1e33335cab5d5733609820f5ae1ac6b60634d94cd2
+  metadata.gz: 790845a432c5b85fa5261a8cbca3170058adcc00352f79ae3a1d211e5027b7dc
+  data.tar.gz: 9bacdc397e449211800e19ccd0fb6e99089215db5fbd52593d452ec8b73f44d8
 SHA512:
-  metadata.gz: ba297615b774f407a5999a2454c0941a8dc492a9c8a9a2f221eabf8f60cdf4e4f6804cb1009fa04fd9131a1ea332eb9872fc7b5222adb89e1b4c61d2aec71575
-  data.tar.gz: e0337bdb4775911ad7bc13b2d559516e1a1a52492c9ad37c6401479ad9ade20abf64b81b09e4ffec7493decb9104e95eb8ce49f20d5b953c5af763287c55259f
+  metadata.gz: f0fa1a49e44253388abaa4483ad9ceeae25b65386c1ed5ecff2820075905245d45684aabd0dfb475041739ec1b938ddcf125e3546d52b22d1380e30793b823f6
+  data.tar.gz: ee4c6847111eb19a6e2d836e557826a3cf9a4a14219dfcb9734e26b9728d9f8649960aa0071c2a2de68f83b421c339713e92291d52b796f8926e3e15cc118b54

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [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.

data/Gemfile.lock

@@ -1,38 +1,39 @@
 PATH
   remote: .
   specs:
-    safer_redis (1.0.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.6)
-      redis-client (>= 0.9.0)
-    redis-client (0.12.1)
+    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/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

@@ -12,7 +12,10 @@ module SaferRedis
     def self.for_command(command)
       case command
       when "DEL"
-        new(command, "Consider using the non-blocking UNLINK command instead to delete the key on a background thread")
+        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

data/lib/safer_redis/version.rb

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

data/lib/safer_redis.rb

@@ -26,16 +26,4 @@ module SaferRedis
   ensure
     @active = was
   end
-
-  def self.assess!(doc)
-    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
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safer_redis
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Paul Annesley
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-07 00:00:00.000000000 Z
+date: 2023-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -56,6 +56,7 @@ 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
@@ -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.4.1
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: Catch unsafe Redis commands in production