bearcat 1.5.6 → 1.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f21ad17cf7cd2e8157f04e429943c0483c42d5cb7438f3e8708ad6f85f58bc9d
-  data.tar.gz: 6350855a61b9d18121eab67e1f09ebbc3625ac8a52a1f6b669bf5ac6f47ee447
+  metadata.gz: 8a944f30f69dd137902c99b5810bb29eebbdf48136039160b5259106f722661e
+  data.tar.gz: 044c52dc104b65aac858da9f53f44de11ad8ac08a956cd9fdd21fb458a0d6b0f
 SHA512:
-  metadata.gz: 621f03512619d6845e278882918b7ada0d2bb81ad7b1cc3737f4ebe0527b753709df2a4e17b7b44ad7416fe0634fb06b57d61a6c680e6c1e62c2adcf68485dee
-  data.tar.gz: 3ebdcc2ba0809d4407eaba804b3cec69f4f7ea7b9182cebd60738f1de0c112017793e9db267e54f63c76091b251d37c71bc0d4871234ee21d2a091d14f07a603
+  metadata.gz: a02a9c9a4ff44e03da5a5e3b0de9aefa1565814aeb2ab8d2099d90eaf9388fae9de67118905b3fa4d72ec6684092b1ece95bc68bdd486494d221a2e05ace823f
+  data.tar.gz: 0a42a5dfee36522129ad182a88318891de98da90b6f120f269a93ea8f041d72b6482c0a77e711b1c75873356af10ea508c826e497a7c2c78b2b6481ce7e2c8ba

data/bearcat.gemspec

@@ -33,4 +33,5 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "activesupport"
   gem.add_dependency "footrest", ">= 0.2.2"
+  gem.add_dependency "connection_pool", ">= 2.2.0", "< 3.0"
 end

data/lib/bearcat/client.rb

@@ -85,8 +85,8 @@ module Bearcat
         rl = config[:rate_limiter] || Bearcat.rate_limiter
         master_rate_limit = config[:master_rate_limit].present? ? config[:master_rate_limit] : Bearcat.master_rate_limit
 
-        if rl.nil? && master_rate_limit.nil? && defined?(Rails) && Rails.env.production?
-          master_rate_limit = true if defined?(::Sidekiq)
+        if rl.nil? && master_rate_limit.nil? && defined?(Rails) && Rails.env.production? && defined?(::Redis) && RedisConnection.configured?("BEARCAT", explicit: false)
+          master_rate_limit = true
         end
 
         if rl.nil? && master_rate_limit

data/lib/bearcat/rate_limiting.rb

@@ -58,11 +58,10 @@ module Bearcat
       end
 
       def redis(&blk)
-        # TODO Add bearcat-native ConnectionPool instead of relying on application or Sidekiq to do so
         if @params[:redis]
           @params[:redis].call(blk)
         else
-          ::Sidekiq.redis(&blk)
+          ::Bearcat.redis(&blk)
         end
       end
     end

data/lib/bearcat/redis_connection.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require "connection_pool"
+require "redis"
+require "uri"
+
+# Adapted from Sidekiq 6.x Implementation
+
+module Bearcat
+  module RedisConnection
+    KNOWN_REDIS_URL_ENVS = %w[REDIS_URL REDISTOGO_URL REDISCLOUD_URL].freeze
+
+    class << self
+      def configured?(prefix, explicit: false)
+        determine_redis_provider(prefix: prefix, explicit: true)
+      end
+
+      def create(options = {})
+        symbolized_options = options.transform_keys(&:to_sym)
+
+        if !symbolized_options[:url] && (u = determine_redis_provider(prefix: options[:env_prefix]))
+          symbolized_options[:url] = u
+        end
+
+        size = if symbolized_options[:size]
+          symbolized_options[:size]
+        elsif symbolized_options[:env_prefix] && (v = ENV["#{symbolized_options[:env_prefix]}_REDIS_POOL_SIZE"])
+          Integer(v)
+        elsif ENV["RAILS_MAX_THREADS"]
+          Integer(ENV["RAILS_MAX_THREADS"])
+        else
+          5
+        end
+
+        pool_timeout = symbolized_options[:pool_timeout] || 1
+
+        ConnectionPool.new(timeout: pool_timeout, size: size) do
+          namespace = symbolized_options[:namespace]
+          client = Redis.new client_opts(symbolized_options)
+
+          if namespace
+            begin
+              require "redis/namespace"
+              Redis::Namespace.new(namespace, redis: client)
+            rescue LoadError
+              Rails.logger.error("Your Redis configuration uses the namespace '#{namespace}' but the redis-namespace gem is not included in the Gemfile." \
+                                   "Add the gem to your Gemfile to continue using a namespace. Otherwise, remove the namespace parameter.")
+              exit(-127)
+            end
+          else
+            client
+          end
+        end
+      end
+
+      private
+
+      def client_opts(options)
+        opts = options.dup
+        if opts[:namespace]
+          opts.delete(:namespace)
+        end
+
+        if opts[:network_timeout]
+          opts[:timeout] = opts[:network_timeout]
+          opts.delete(:network_timeout)
+        end
+
+        opts[:reconnect_attempts] ||= 1
+
+        opts
+      end
+
+      def determine_redis_provider(prefix: nil, explicit: false)
+        vars = []
+
+        if prefix.present?
+          if (ptr = ENV["#{prefix}_REDIS_PROVIDER"]).present?
+            return ENV[ptr]
+          else
+            vars.push(*KNOWN_REDIS_URL_ENVS.map { |e| ENV["#{prefix}_#{e}"] })
+          end
+        end
+
+        if !explicit || !prefix.present?
+          if (ptr = ENV["REDIS_PROVIDER"]).present?
+            vars << ptr # Intentionally not a return
+          else
+            vars.push(*KNOWN_REDIS_URL_ENVS)
+          end
+        end
+
+        vars.select!(&:present?)
+
+        vars.each do |e|
+          return ENV[e] if ENV[e].present?
+        end
+
+        nil
+      end
+    end
+  end
+end

data/lib/bearcat/version.rb

@@ -1,3 +1,3 @@
 module Bearcat
-  VERSION = '1.5.6' unless defined?(Bearcat::VERSION)
+  VERSION = '1.5.7' unless defined?(Bearcat::VERSION)
 end

data/lib/bearcat.rb

@@ -1,5 +1,6 @@
 require 'bearcat/version'
 require 'bearcat/client'
+require 'bearcat/redis_connection'
 
 module Bearcat
   class << self
@@ -27,6 +28,7 @@ module Bearcat
       @max_sleep_seconds ||= 60
     end
 
+    # @deprecated
     def master_rate_limit
       @master_rate_limit ||= false
     end
@@ -37,5 +39,16 @@ module Bearcat
       @logger.level = Logger::DEBUG
       @logger
     end
+
+    def redis_pool
+      @redis_pool ||= RedisConnection.create(env_prefix: "BEARCAT")
+    end
+
+    def redis
+      raise ArgumentError, "requires a block" unless block_given?
+      redis_pool.with do |conn|
+        yield conn
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bearcat
 version: !ruby/object:Gem::Version
-  version: 1.5.6
+  version: 1.5.7
 platform: ruby
 authors:
 - Instructure CustomDev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-15 00:00:00.000000000 Z
+date: 2023-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -122,6 +122,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Ruby interface for interacting with the canvas API
 email:
 - pseng@instructure.com
@@ -187,6 +207,7 @@ files:
 - lib/bearcat/rate_limiting/functions.lua
 - lib/bearcat/rate_limiting/increment_bucket.lua
 - lib/bearcat/rate_limiting/redis_script.rb
+- lib/bearcat/redis_connection.rb
 - lib/bearcat/spec_helpers.rb
 - lib/bearcat/version.rb
 - lib/catalogcat.rb