Add redis-client support

With version 5 of the redis gem the client was moved into a separate gem. Since then the redis integration stopped working.
appsignal · Jan 17, 2024 · d44f709 · d44f709
1 parent 7868633
commit d44f709
Show file tree

Hide file tree

Showing 13 changed files with 543 additions and 77 deletions.
diff --git a/.changesets/add-redis-client-support.md b/.changesets/add-redis-client-support.md
@@ -0,0 +1,6 @@
+---
+bump: "patch"
+type: "add"
+---
+
+Add support for the `redis-client` gem, which is used by the redis gem since version 5.
diff --git a/.semaphore/semaphore.yml b/.semaphore/semaphore.yml
@@ -500,6 +500,42 @@ blocks:
         value: latest
       commands:
       - "./support/bundler_wrapper exec rake test"
+    - name: Ruby 2.7.8 for redis-4
+      env_vars:
+      - *2
+      - *3
+      - *4
+      - *5
+      - name: RUBY_VERSION
+        value: 2.7.8
+      - name: GEMSET
+        value: redis-4
+      - name: BUNDLE_GEMFILE
+        value: gemfiles/redis-4.gemfile
+      - name: _RUBYGEMS_VERSION
+        value: latest
+      - name: _BUNDLER_VERSION
+        value: latest
+      commands:
+      - "./support/bundler_wrapper exec rake test"
+    - name: Ruby 2.7.8 for redis-5
+      env_vars:
+      - *2
+      - *3
+      - *4
+      - *5
+      - name: RUBY_VERSION
+        value: 2.7.8
+      - name: GEMSET
+        value: redis-5
+      - name: BUNDLE_GEMFILE
+        value: gemfiles/redis-5.gemfile
+      - name: _RUBYGEMS_VERSION
+        value: latest
+      - name: _BUNDLER_VERSION
+        value: latest
+      commands:
+      - "./support/bundler_wrapper exec rake test"
 - name: Ruby 3.0.5
   dependencies:
   - Validation
@@ -899,6 +935,42 @@ blocks:
         value: latest
       commands:
       - "./support/bundler_wrapper exec rake test"
+    - name: Ruby 3.0.5 for redis-4
+      env_vars:
+      - *2
+      - *3
+      - *4
+      - *5
+      - name: RUBY_VERSION
+        value: 3.0.5
+      - name: GEMSET
+        value: redis-4
+      - name: BUNDLE_GEMFILE
+        value: gemfiles/redis-4.gemfile
+      - name: _RUBYGEMS_VERSION
+        value: latest
+      - name: _BUNDLER_VERSION
+        value: latest
+      commands:
+      - "./support/bundler_wrapper exec rake test"
+    - name: Ruby 3.0.5 for redis-5
+      env_vars:
+      - *2
+      - *3
+      - *4
+      - *5
+      - name: RUBY_VERSION
+        value: 3.0.5
+      - name: GEMSET
+        value: redis-5
+      - name: BUNDLE_GEMFILE
+        value: gemfiles/redis-5.gemfile
+      - name: _RUBYGEMS_VERSION
+        value: latest
+      - name: _BUNDLER_VERSION
+        value: latest
+      commands:
+      - "./support/bundler_wrapper exec rake test"
 - name: Ruby 3.1.3
   dependencies:
   - Validation
@@ -1280,6 +1352,42 @@ blocks:
         value: latest
       commands:
       - "./support/bundler_wrapper exec rake test"
+    - name: Ruby 3.1.3 for redis-4
+      env_vars:
+      - *2
+      - *3
+      - *4
+      - *5
+      - name: RUBY_VERSION
+        value: 3.1.3
+      - name: GEMSET
+        value: redis-4
+      - name: BUNDLE_GEMFILE
+        value: gemfiles/redis-4.gemfile
+      - name: _RUBYGEMS_VERSION
+        value: latest
+      - name: _BUNDLER_VERSION
+        value: latest
+      commands:
+      - "./support/bundler_wrapper exec rake test"
+    - name: Ruby 3.1.3 for redis-5
+      env_vars:
+      - *2
+      - *3
+      - *4
+      - *5
+      - name: RUBY_VERSION
+        value: 3.1.3
+      - name: GEMSET
+        value: redis-5
+      - name: BUNDLE_GEMFILE
+        value: gemfiles/redis-5.gemfile
+      - name: _RUBYGEMS_VERSION
+        value: latest
+      - name: _BUNDLER_VERSION
+        value: latest
+      commands:
+      - "./support/bundler_wrapper exec rake test"
 - name: Ruby 3.2.1
   dependencies:
   - Validation
@@ -1661,6 +1769,42 @@ blocks:
         value: latest
       commands:
       - "./support/bundler_wrapper exec rake test"
+    - name: Ruby 3.2.1 for redis-4
+      env_vars:
+      - *2
+      - *3
+      - *4
+      - *5
+      - name: RUBY_VERSION
+        value: 3.2.1
+      - name: GEMSET
+        value: redis-4
+      - name: BUNDLE_GEMFILE
+        value: gemfiles/redis-4.gemfile
+      - name: _RUBYGEMS_VERSION
+        value: latest
+      - name: _BUNDLER_VERSION
+        value: latest
+      commands:
+      - "./support/bundler_wrapper exec rake test"
+    - name: Ruby 3.2.1 for redis-5
+      env_vars:
+      - *2
+      - *3
+      - *4
+      - *5
+      - name: RUBY_VERSION
+        value: 3.2.1
+      - name: GEMSET
+        value: redis-5
+      - name: BUNDLE_GEMFILE
+        value: gemfiles/redis-5.gemfile
+      - name: _RUBYGEMS_VERSION
+        value: latest
+      - name: _BUNDLER_VERSION
+        value: latest
+      commands:
+      - "./support/bundler_wrapper exec rake test"
 - name: Ruby jruby-9.4.1.0
   dependencies:
   - Validation

diff --git a/README.md b/README.md
@@ -253,6 +253,8 @@ BUNDLE_GEMFILE=gemfiles/sequel-435.gemfile bundle exec rspec
 BUNDLE_GEMFILE=gemfiles/sequel.gemfile bundle exec rspec
 BUNDLE_GEMFILE=gemfiles/sinatra.gemfile bundle exec rspec
 BUNDLE_GEMFILE=gemfiles/webmachine.gemfile bundle exec rspec
+BUNDLE_GEMFILE=gemfiles/redis-4.gemfile bundle exec rspec
+BUNDLE_GEMFILE=gemfiles/redis-5.gemfile bundle exec rspec
 ```
 
 If you have either [RVM][rvm], [rbenv][rbenv] or [chruby][chruby] installed you

diff --git a/build_matrix.yml b/build_matrix.yml
@@ -245,3 +245,5 @@ matrix:
     - gem: "sinatra"
     - gem: "webmachine1"
     - gem: "webmachine2"
+    - gem: "redis-4"
+    - gem: "redis-5"
diff --git a/gemfiles/redis-4.gemfile b/gemfiles/redis-4.gemfile
@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'redis', "~> 4.0"
+
+gemspec :path => '../'
diff --git a/gemfiles/redis-5.gemfile b/gemfiles/redis-5.gemfile
@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'redis', '~> 5.0'
+gem 'hiredis-client'
+
+gemspec :path => '../'
diff --git a/lib/appsignal/hooks.rb b/lib/appsignal/hooks.rb
@@ -103,6 +103,7 @@ def self.const_missing(name)
 require "appsignal/hooks/puma"
 require "appsignal/hooks/rake"
 require "appsignal/hooks/redis"
+require "appsignal/hooks/redis_client"
 require "appsignal/hooks/resque"
 require "appsignal/hooks/sequel"
 require "appsignal/hooks/shoryuken"

diff --git a/lib/appsignal/hooks/redis.rb b/lib/appsignal/hooks/redis.rb
@@ -8,6 +8,7 @@ class RedisHook < Appsignal::Hooks::Hook
 
       def dependencies_present?
         defined?(::Redis) &&
+          !defined?(::RedisClient) &&
           Appsignal.config &&
           Appsignal.config[:instrument_redis]
       end

diff --git a/lib/appsignal/hooks/redis_client.rb b/lib/appsignal/hooks/redis_client.rb
@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Appsignal
+  class Hooks
+    # @api private
+    class RedisClientHook < Appsignal::Hooks::Hook
+      register :redis_client
+
+      def dependencies_present?
+        defined?(::RedisClient) &&
+          Appsignal.config &&
+          Appsignal.config[:instrument_redis]
+      end
+
+      def install
+        require "appsignal/integrations/redis_client"
+        ::RedisClient::RubyConnection.prepend Appsignal::Integrations::RedisClientIntegration
+        Appsignal::Environment.report_enabled("redis")
+
+        return unless defined?(::RedisClient::HiredisConnection)
+
+        ::RedisClient::HiredisConnection.prepend Appsignal::Integrations::RedisClientIntegration
+        Appsignal::Environment.report_enabled("hiredis")
+      end
+    end
+  end
+end
diff --git a/lib/appsignal/integrations/redis_client.rb b/lib/appsignal/integrations/redis_client.rb
@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Appsignal
+  module Integrations
+    module RedisClientIntegration
+      def write(command)
+        sanitized_command =
+          if command[0] == :eval
+            "#{command[1]}#{" ?" * (command.size - 3)}"
+          else
+            "#{command[0]}#{" ?" * (command.size - 1)}"
+          end
+
+        Appsignal.instrument "query.redis", @config.id, sanitized_command do
+          super
+        end
+      end
+    end
+  end
+end