safer_redis 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0c31676a608f111b89e5de3b5ec1ba3cc46b276afb362eee6aebd1a43120cfb
-  data.tar.gz: 0bc66dde14999d62732ade01b0cf36f645cff45911eff4c818ab0f696bbe9bee
+  metadata.gz: 2b398837bfdbe584e367b80c02a881ebd6a9b2c975efc3aa4e36184530306cad
+  data.tar.gz: d3adf217f7f8df1a0bda2b1e33335cab5d5733609820f5ae1ac6b60634d94cd2
 SHA512:
-  metadata.gz: a854dda2a09c6dd52330afc9de66895eba48447767da9e0cf53bc7a9a7c3dd7e64ca2c1ea4c590f15be29d4bfc53bf7751b9335a09150b85e34d932586f42de6
-  data.tar.gz: 11d94efde9334fd9e242ebd2ec7dcd6ff1a320731cda4f1ec537ca333f642d933b9e87b2cbf0cc16171ecb1c34294570897fa191a60bda823de0c107d3622e5f
+  metadata.gz: ba297615b774f407a5999a2454c0941a8dc492a9c8a9a2f221eabf8f60cdf4e4f6804cb1009fa04fd9131a1ea332eb9872fc7b5222adb89e1b4c61d2aec71575
+  data.tar.gz: e0337bdb4775911ad7bc13b2d559516e1a1a52492c9ad37c6401479ad9ade20abf64b81b09e4ffec7493decb9104e95eb8ce49f20d5b953c5af763287c55259f

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [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,7 +1,7 @@
 PATH
   remote: .
   specs:
-    safer_redis (0.1.0)
+    safer_redis (1.0.0)
       redis (>= 4.6.0)
       zeitwerk
 
@@ -11,9 +11,9 @@ GEM
     connection_pool (2.3.0)
     diff-lcs (1.5.0)
     rake (13.0.6)
-    redis (5.0.5)
+    redis (5.0.6)
       redis-client (>= 0.9.0)
-    redis-client (0.11.2)
+    redis-client (0.12.1)
       connection_pool
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -32,6 +32,7 @@ GEM
 
 PLATFORMS
   x86_64-darwin-21
+  x86_64-darwin-22
 
 DEPENDENCIES
   rake (~> 13.0)

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/suggestion.rb

@@ -0,0 +1,21 @@
+# 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, "Consider using the non-blocking UNLINK command instead to delete the key on a background thread")
+      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.1.0"
 end

data/lib/safer_redis.rb

@@ -28,7 +28,13 @@ module SaferRedis
   end
 
   def self.assess!(doc)
-    if doc.dangerous? || doc.slow?
+    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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safer_redis
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Paul Annesley
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-02 00:00:00.000000000 Z
+date: 2023-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -59,8 +59,8 @@ files:
 - 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:
@@ -84,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.1
 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