redcord 0.1.2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0c8f566eb89b44bd73c4a444deb313af1004a342a703a0e9f504364aa96df40
-  data.tar.gz: e77507ef1ebb3a1d2a6ba9f0fc654d25355f5bc685b05e4bc07368957bdc7ec3
+  metadata.gz: bf6ea43c415c480fb7b3484deb69005c13f52bb644fef52f5570d078b15baf46
+  data.tar.gz: 0ae55fe438326a9fac46364e6ca0652d71da69aadae9dd204477f1ef502211fc
 SHA512:
-  metadata.gz: 27d9afec9f1a663516b65096439312bdc313aed672c6476bcf38d0ce98cd9178bebf3b5a46341d69ad6fc6f3f4268655956c6e5170af2f7da8489d68e343dee5
-  data.tar.gz: 1b011be75251942091acc209189f33d72ff289496a07f5700c140a06916f83ad310e1e804fc3bd60d77815f89b57fd6a66b9efe2d7fabd81d32dfca7f281b7d6
+  metadata.gz: 5f45e3e9bb1c575051df21af680a817bff3a1bb2a367adba95258ab23535cb0fb08d024008edfdd16c58e4132bf67037e7f8bb8ce947e494323ef23a33e4ab1a
+  data.tar.gz: d99aa9db0fec8580aacb6fa066612b6cc39c4028fb5a2af4c3c2bc03e851c1bdfa58a2eb17c121e148fef171a1913ed5086e4a2abc877fa47149aa701b260092

data/lib/redcord/attribute.rb

@@ -37,7 +37,7 @@ module Redcord::Attribute
     klass.include(InstanceMethods)
     klass.class_variable_set(:@@index_attributes, Set.new)
     klass.class_variable_set(:@@range_index_attributes, Set.new)
-    klass.class_variable_set(:@@custom_index_attributes, Hash.new { |h, k| h[k] = [] })
+    klass.class_variable_set(:@@custom_index_attributes, Hash.new)
     klass.class_variable_set(:@@ttl, nil)
     klass.class_variable_set(:@@shard_by_attribute, nil)
   end

data/lib/redcord/connection_pool.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+require 'connection_pool'
+require_relative 'redis'
+
+class Redcord::ConnectionPool
+  def initialize(pool_size:, timeout:, **client_options)
+    @connection_pool = ::ConnectionPool.new(size: pool_size, timeout: timeout) do
+      # Construct a new client every time the block gets called
+      Redcord::Redis.new(**client_options, logger: Redcord::Logger.proxy)
+    end
+  end
+
+  # Avoid method_missing when possible for better performance
+  methods = Set.new(Redcord::Redis.instance_methods(false) + Redis.instance_methods(false))
+  methods.each do |method_name|
+    define_method method_name do |*args, &blk|
+      @connection_pool.with do |redis|
+        redis.send(method_name, *args, &blk)
+      end
+    end
+  end
+
+  def method_missing(method_name, *args, &blk)
+    @connection_pool.with do |redis|
+      redis.send(method_name, *args, &blk)
+    end
+  end
+end

data/lib/redcord/redis_connection.rb

@@ -6,11 +6,14 @@ require 'rails'
 
 require 'redcord/lua_script_reader'
 require 'redcord/redis'
+require 'redcord/connection_pool'
 
 module Redcord::RedisConnection
   extend T::Sig
   extend T::Helpers
 
+  RedcordClientType = T.type_alias { T.any(Redcord::Redis, Redcord::ConnectionPool) }
+
   @connections = T.let(nil, T.nilable(T::Hash[String, T.untyped]))
   @procs_to_prepare = T.let([], T::Array[Proc])
 
@@ -29,17 +32,17 @@ module Redcord::RedisConnection
       (env_config[name.underscore] || env_config['default']).symbolize_keys
     end
 
-    sig { returns(Redcord::Redis) }
+    sig { returns(RedcordClientType) }
     def redis
       Redcord::RedisConnection.connections[name.underscore] ||= prepare_redis!
     end
 
-    sig { returns(Redcord::Redis) }
+    sig { returns(RedcordClientType) }
     def establish_connection
       Redcord::RedisConnection.connections[name.underscore] = prepare_redis!
     end
 
-    sig { params(redis: Redis).returns(Redcord::Redis) }
+    sig { params(redis: Redis).returns(RedcordClientType) }
     def redis=(redis)
       Redcord::RedisConnection.connections[name.underscore] =
         prepare_redis!(redis)
@@ -50,20 +53,21 @@ module Redcord::RedisConnection
     # definitions in each Redis query.
     #
     # TODO: Replace this with Redcord migrations
-    sig { params(client: T.nilable(Redis)).returns(Redcord::Redis) }
+    sig { params(client: T.nilable(Redis)).returns(RedcordClientType) }
     def prepare_redis!(client = nil)
-      return client if client.is_a?(Redcord::Redis)
-
-      client = Redcord::Redis.new(
-        **(
-          if client.nil?
-            connection_config
-          else
-            client.instance_variable_get(:@options)
-          end
-        ),
-        logger: Redcord::Logger.proxy,
-      )
+      return client if client.is_a?(Redcord::Redis) || client.is_a?(Redcord::ConnectionPool)
+
+      options = client.nil? ? connection_config : client.instance_variable_get(:@options)
+      client =
+        if options[:pool]
+          Redcord::ConnectionPool.new(
+            pool_size: options[:pool],
+            timeout: options[:connection_timeout] || 1.0,
+            **options
+          )
+        else
+          Redcord::Redis.new(**options, logger: Redcord::Logger.proxy)
+        end
 
       client.ping
       client
@@ -73,7 +77,7 @@ module Redcord::RedisConnection
   module InstanceMethods
     extend T::Sig
 
-    sig { returns(Redcord::Redis) }
+    sig { returns(RedcordClientType) }
     def redis
       self.class.redis
     end

data/lib/redcord/relation.rb

@@ -2,6 +2,7 @@
 
 # typed: strict
 
+require 'active_support'
 require 'active_support/core_ext/array'
 require 'active_support/core_ext/module'
 
@@ -98,7 +99,7 @@ class Redcord::Relation
         extract_query_conditions!,
         index_attrs: model._script_arg_index_attrs,
         range_index_attrs: model._script_arg_range_index_attrs,
-        custom_index_attrs: model._script_arg_custom_index_attrs[custom_index_name],
+        custom_index_attrs: model._script_arg_custom_index_attrs[custom_index_name] || [],
         hash_tag: extract_hash_tag!,
         custom_index_name: custom_index_name
       )
@@ -222,7 +223,7 @@ class Redcord::Relation
           select_attrs: select_attrs,
           index_attrs: model._script_arg_index_attrs,
           range_index_attrs: model._script_arg_range_index_attrs,
-          custom_index_attrs: model._script_arg_custom_index_attrs[custom_index_name],
+          custom_index_attrs: model._script_arg_custom_index_attrs[custom_index_name] || [],
           hash_tag: extract_hash_tag!,
           custom_index_name: custom_index_name
         )
@@ -238,7 +239,7 @@ class Redcord::Relation
           extract_query_conditions!,
           index_attrs: model._script_arg_index_attrs,
           range_index_attrs: model._script_arg_range_index_attrs,
-          custom_index_attrs: model._script_arg_custom_index_attrs[custom_index_name],
+          custom_index_attrs: model._script_arg_custom_index_attrs[custom_index_name] || [],
           hash_tag: extract_hash_tag!,
           custom_index_name: custom_index_name
         )
@@ -248,7 +249,7 @@ class Redcord::Relation
     end
   end
 
-  sig { returns(Redcord::Redis) }
+  sig { returns(Redcord::RedisConnection::RedcordClientType) }
   def redis
     model.redis
   end

data/lib/redcord/serializer.rb

@@ -81,7 +81,7 @@ module Redcord::Serializer
       attr_keys.each do |attr_key|
         next if attr_key == shard_by_attribute
 
-        if !custom_index_attributes.empty?
+        if !custom_index_attributes.nil? && !custom_index_attributes.empty?
           if !custom_index_attributes.include?(attr_key)
             raise(
               Redcord::AttributeNotIndexed,

data/lib/redcord/vacuum_helper.rb

@@ -9,15 +9,15 @@ module Redcord::VacuumHelper
   sig { params(model: T.class_of(Redcord::Base)).void }
   def self.vacuum(model)
     model.class_variable_get(:@@index_attributes).each do |index_attr|
-      puts "Vacuuming index attribute: #{index_attr}"
+      puts "Vacuuming index attribute: #{index_attr} for model: #{model.name}"
       _vacuum_index_attribute(model, index_attr)
     end
     model.class_variable_get(:@@range_index_attributes).each do |range_index_attr|
-      puts "Vacuuming range index attribute: #{range_index_attr}"
+      puts "Vacuuming range index attribute: #{range_index_attr} for model: #{model.name}"
       _vacuum_range_index_attribute(model, range_index_attr)
     end
     model.class_variable_get(:@@custom_index_attributes).keys.each do |index_name|
-      puts "Vacuuming custom index: #{index_name}"
+      puts "Vacuuming custom index: #{index_name} for model: #{model.name}"
       _vacuum_custom_index(model, index_name)
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redcord
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.5
 platform: ruby
 authors:
 - Chan Zuckerberg Initiative
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.3
 - !ruby/object:Gem::Dependency
   name: sorbet
   requirement: !ruby/object:Gem::Requirement
@@ -162,6 +176,7 @@ files:
 - lib/redcord/attribute.rb
 - lib/redcord/base.rb
 - lib/redcord/configurations.rb
+- lib/redcord/connection_pool.rb
 - lib/redcord/logger.rb
 - lib/redcord/lua_script_reader.rb
 - lib/redcord/migration.rb
@@ -205,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A Ruby ORM like Active Record, but for Redis