redis-memo 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd1d436b41e1f30d0d0910d086811f675b87b6bbe799a0087da7453b4c016b66
-  data.tar.gz: 7ca970165cb321e0016d6f70f6135868df19b68d27a180084f8053f94bf780c0
+  metadata.gz: 8b3cb72a8a4bf3dcd6d30bb112e387710c65d09d60c3dc687e10db649da1e91a
+  data.tar.gz: b2452e1d4b2b7a3d588c13822eaffc1fb4336c3a4666f8a4ca473dbbd961578f
 SHA512:
-  metadata.gz: d79af32bc2a55a3755072cd0502d355745c7f060241d6a7f5e116eab8c0b7a45b107d02ef5d4bbcec0e6acb5bf435f1bb4d6b50084d13e410307610ef675f420
-  data.tar.gz: d9e0714a72c526be0043185dfc2c0dc3f6a6c94557da5b81e31905616b1a156cb6d2c89934548332802fff42a24ed53c1518a97b3912d2cc8beae41d9dffc7bf
+  metadata.gz: 4d9193ddb53419db1e14a5eda4d4ab73b4a96620f592998c764abe3a118fb266761b04a929ff49d15194a9bcf959f9cb7c82f45f783387a85f4e1be2b1315ada
+  data.tar.gz: 383b2b053917ceeb3991de1c7c399fa83cd8e2bc326f735a0d0924767cea5d6157cf2f3e4a07b3d5d6524b54cae7e62276fb0723daad6a66ebaa6d0b6da64745

data/lib/redis_memo.rb

@@ -3,11 +3,20 @@
 require 'active_support/all'
 require 'digest'
 require 'json'
+require 'ruby2_keywords'
 require 'securerandom'
 
 module RedisMemo
+  require 'redis_memo/thread_local_var'
+
+  ThreadLocalVar.define :without_memoization
+  ThreadLocalVar.define :connection_attempts_count
+  ThreadLocalVar.define :max_connection_attempts
+
+  require 'redis_memo/errors'
   require 'redis_memo/memoize_method'
-  require 'redis_memo/memoize_query'
+  require 'redis_memo/memoize_query' if defined?(ActiveRecord)
+  require 'redis_memo/railtie' if defined?(Rails) && defined?(Rails::Railtie)
 
   # A process-level +RedisMemo::Options+ instance that stores the global
   # options. This object can be modified by +RedisMemo.configure+.
@@ -17,9 +26,6 @@ module RedisMemo
   # +DefaultOptions+ as the default value.
   DefaultOptions = RedisMemo::Options.new
 
-  # @todo Move thread keys to +RedisMemo::ThreadKey+
-  THREAD_KEY_WITHOUT_MEMO = :__redis_memo_without_memo__
-
   # Configure global-level default options. Those options will be used unless
   # some options specified at +memoize_method+ callsite level. See
   # +RedisMemo::Options+ for all the possible options.
@@ -35,10 +41,10 @@ module RedisMemo
   # to Redis.
   # - Batches cannot be nested
   # - When a batch is still open (while still in the +RedisMemo.batch+ block)
-  # the return value of any memoized method is a +RedisMemo::Future+ instead of
-  # the actual method value
+  #   the return value of any memoized method is a +RedisMemo::Future+ instead of
+  #   the actual method value
   # - The actual method values are returned as a list, in the same order as
-  # invoking, after exiting the block
+  #   invoking, after exiting the block
   #
   # @example
   #   results = RedisMemo.batch do
@@ -56,46 +62,52 @@ module RedisMemo
     RedisMemo::Batch.close
   end
 
-  # @todo Move this method out of the top namespace
-  def self.checksum(serialized)
-    Digest::SHA1.base64digest(serialized)
-  end
-
-  # @todo Move this method out of the top namespace
-  def self.uuid
-    SecureRandom.uuid
-  end
-
-  # @todo Move this method out of the top namespace
-  def self.deep_sort_hash(orig_hash)
-    {}.tap do |new_hash|
-      orig_hash.sort.each do |k, v|
-        new_hash[k] = v.is_a?(Hash) ? deep_sort_hash(v) : v
-      end
-    end
-  end
-
   # Whether the current execution context has been configured to skip
   # memoization and use the uncached code path.
   #
   # @return [Boolean]
-  def self.without_memo?
-    Thread.current[THREAD_KEY_WITHOUT_MEMO] == true
+  def self.without_memoization?
+    RedisMemo::DefaultOptions.disable_all || ThreadLocalVar.without_memoization == true
   end
 
   # Configure the wrapped code in the block to skip memoization.
   #
   # @yield [] no_args The block of code to skip memoization.
-  def self.without_memo
-    prev_value = Thread.current[THREAD_KEY_WITHOUT_MEMO]
-    Thread.current[THREAD_KEY_WITHOUT_MEMO] = true
+  def self.without_memoization
+    prev_value = ThreadLocalVar.without_memoization
+    ThreadLocalVar.without_memoization = true
     yield
   ensure
-    Thread.current[THREAD_KEY_WITHOUT_MEMO] = prev_value
+    ThreadLocalVar.without_memoization = prev_value
   end
 
-  # @todo Move errors to a separate file errors.rb
-  class ArgumentError < ::ArgumentError; end
-  class RuntimeError < ::RuntimeError; end
-  class WithoutMemoization < Exception; end
+  # Set the max connection attempts to Redis per code block. If we fail to
+  # connect to Redis more than `max_attempts` times, the rest of the code block
+  # will fall back to the uncached flow, `RedisMemo.without_memoization`.
+  #
+  # @param [Integer] The max number of connection attempts.
+  # @yield [] no_args the block of code to set the max attempts for.
+  def self.with_max_connection_attempts(max_attempts)
+    prev_value = ThreadLocalVar.without_memoization
+    ThreadLocalVar.connection_attempts_count = 0
+    ThreadLocalVar.max_connection_attempts = max_attempts
+
+    yield
+  ensure
+    ThreadLocalVar.without_memoization = prev_value
+    ThreadLocalVar.connection_attempts_count = nil
+    ThreadLocalVar.max_connection_attempts = nil
+  end
+
+  private_class_method def self.incr_connection_attempts # :nodoc:
+    return unless ThreadLocalVar.max_connection_attempts && ThreadLocalVar.connection_attempts_count
+
+    # The connection attempts count and max connection attempts are reset in
+    # RedisMemo.with_max_connection_attempts
+    ThreadLocalVar.connection_attempts_count += 1
+    return if ThreadLocalVar.connection_attempts_count <
+              ThreadLocalVar.max_connection_attempts
+
+    ThreadLocalVar.without_memoization = true
+  end
 end

data/lib/redis_memo/after_commit.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # TODO: -> RedisMemo::Memoizable::AfterCommit
 
 class RedisMemo::AfterCommit
@@ -34,8 +35,6 @@ class RedisMemo::AfterCommit
     connection.transaction_open? && connection.current_transaction.joinable?
   end
 
-  private
-
   def self.after_commit(&blk)
     connection.add_transaction_record(
       RedisMemo::AfterCommit::Callback.new(connection, committed: blk),
@@ -50,6 +49,7 @@ class RedisMemo::AfterCommit
 
   def self.reset_after_transaction
     return if @@callback_added
+
     @@callback_added = true
 
     after_commit do

data/lib/redis_memo/batch.rb

@@ -1,30 +1,54 @@
- # frozen_string_literal: true
+# frozen_string_literal: true
+
 require_relative 'cache'
 require_relative 'tracer'
 
+##
+# This class facilitates the batching of Redis calls triggered by +memoize_method+
+# to minimize the number of round trips to Redis.
+#
+# - Batches cannot be nested
+# - When a batch is still open (while still in the +RedisMemo.batch+ block)
+#   the return value of any memoized method is a +RedisMemo::Future+ instead of
+#   the actual method value
+# - The actual method values are returned as a list, in the same order as
+#   invoking, after exiting the block
+#
+# @example
+#   results = RedisMemo.batch do
+#     5.times { |i| memoized_calculation(i) }
+#     nil # Not the return value of the block
+#   end
+#   results # [1,2,3,4,5] (results from the memoized_calculation calls)
 class RedisMemo::Batch
-  THREAD_KEY = :__redis_memo_current_batch__
+  RedisMemo::ThreadLocalVar.define :batch
 
+  # Opens a new batch. If a batch is already open, raises an error
+  # to prevent nested batches.
   def self.open
     if current
-      raise RedisMemo::RuntimeError, 'Batch can not be nested'
+      raise RedisMemo::RuntimeError.new('Batch can not be nested')
     end
 
-    Thread.current[THREAD_KEY] = []
+    RedisMemo::ThreadLocalVar.batch = []
   end
 
+  # Closes the current batch, returning the futures in that batch.
   def self.close
-    if current
-      futures = current
-      Thread.current[THREAD_KEY] = nil
-      futures
-    end
+    return unless current
+
+    futures = current
+    RedisMemo::ThreadLocalVar.batch = nil
+    futures
   end
 
+  # Retrieves the current open batch.
   def self.current
-    Thread.current[THREAD_KEY]
+    RedisMemo::ThreadLocalVar.batch
   end
 
+  # Executes all the futures in the current batch using batched calls to
+  # Redis and closes it.
   def self.execute
     futures = close
     return unless futures
@@ -33,7 +57,8 @@ class RedisMemo::Batch
     method_cache_keys = nil
 
     RedisMemo::Tracer.trace('redis_memo.cache.batch.read', nil) do
-      method_cache_keys = RedisMemo::MemoizeMethod.method_cache_keys(
+      method_cache_keys = RedisMemo::MemoizeMethod.__send__(
+        :method_cache_keys,
         futures.map(&:context),
       )
 

data/lib/redis_memo/cache.rb

@@ -1,14 +1,17 @@
- # frozen_string_literal: true
+# frozen_string_literal: true
+
 require_relative 'options'
 require_relative 'redis'
 require_relative 'connection_pool'
 
 class RedisMemo::Cache < ActiveSupport::Cache::RedisCacheStore
-  class Rescuable < Exception; end
+  # This needs to be an Exception since RedisCacheStore rescues all
+  # RuntimeErrors
+  class Rescuable < Exception; end # rubocop:disable Lint/InheritException
 
-  THREAD_KEY_LOCAL_CACHE            = :__redis_memo_cache_local_cache__
-  THREAD_KEY_LOCAL_DEPENDENCY_CACHE = :__redis_memo_local_cache_dependency_cache__
-  THREAD_KEY_RAISE_ERROR            = :__redis_memo_cache_raise_error__
+  RedisMemo::ThreadLocalVar.define :local_cache
+  RedisMemo::ThreadLocalVar.define :local_dependency_cache
+  RedisMemo::ThreadLocalVar.define :raise_error
 
   @@redis = nil
   @@redis_store = nil
@@ -17,11 +20,15 @@ class RedisMemo::Cache < ActiveSupport::Cache::RedisCacheStore
     RedisMemo::DefaultOptions.redis_error_handler&.call(exception, method)
     RedisMemo::DefaultOptions.logger&.warn(exception.full_message)
 
-    if Thread.current[THREAD_KEY_RAISE_ERROR]
+    if exception.is_a?(Redis::BaseConnectionError)
+      RedisMemo.__send__(:incr_connection_attempts)
+    end
+
+    if RedisMemo::ThreadLocalVar.raise_error
       raise RedisMemo::Cache::Rescuable
-    else
-      returning
     end
+
+    returning
   end
 
   def self.redis
@@ -48,28 +55,38 @@ class RedisMemo::Cache < ActiveSupport::Cache::RedisCacheStore
   # ActiveSupport::Cache::Entry object -- which is slower comparing to a simple
   # hash storing object references
   def self.local_cache
-    Thread.current[THREAD_KEY_LOCAL_CACHE]
+    RedisMemo::ThreadLocalVar.local_cache
   end
 
   def self.local_dependency_cache
-    Thread.current[THREAD_KEY_LOCAL_DEPENDENCY_CACHE]
+    RedisMemo::ThreadLocalVar.local_dependency_cache
+  end
+
+  # See https://github.com/rails/rails/blob/fe76a95b0d252a2d7c25e69498b720c96b243ea2/activesupport/lib/active_support/cache/redis_cache_store.rb#L477
+  # We overwrite this private method so we can also rescue ConnectionPool::TimeoutErrors
+  def failsafe(method, returning: nil)
+    yield
+  rescue ::Redis::BaseError, ::ConnectionPool::TimeoutError => error
+    handle_exception exception: error, method: method, returning: returning
+    returning
   end
+  private :failsafe
 
   class << self
-    def with_local_cache(&blk)
-      Thread.current[THREAD_KEY_LOCAL_CACHE] = {}
-      Thread.current[THREAD_KEY_LOCAL_DEPENDENCY_CACHE] = {}
-      blk.call
+    def with_local_cache
+      RedisMemo::ThreadLocalVar.local_cache = {}
+      RedisMemo::ThreadLocalVar.local_dependency_cache = {}
+      yield
     ensure
-      Thread.current[THREAD_KEY_LOCAL_CACHE] = nil
-      Thread.current[THREAD_KEY_LOCAL_DEPENDENCY_CACHE] = nil
+      RedisMemo::ThreadLocalVar.local_cache = nil
+      RedisMemo::ThreadLocalVar.local_dependency_cache = nil
     end
 
     # RedisCacheStore doesn't read from the local cache before reading from redis
     def read_multi(*keys, raw: false, raise_error: false)
       return {} if keys.empty?
 
-      Thread.current[THREAD_KEY_RAISE_ERROR] = raise_error
+      RedisMemo::ThreadLocalVar.raise_error = raise_error
 
       local_entries = local_cache&.slice(*keys) || {}
 
@@ -88,7 +105,7 @@ class RedisMemo::Cache < ActiveSupport::Cache::RedisCacheStore
     end
 
     def write(key, value, disable_async: false, raise_error: false, **options)
-      Thread.current[THREAD_KEY_RAISE_ERROR] = raise_error
+      RedisMemo::ThreadLocalVar.raise_error = raise_error
 
       if local_cache
         local_cache[key] = value
@@ -99,7 +116,7 @@ class RedisMemo::Cache < ActiveSupport::Cache::RedisCacheStore
         redis_store.write(key, value, **options)
       else
         async.call do
-          Thread.current[THREAD_KEY_RAISE_ERROR] = raise_error
+          RedisMemo::ThreadLocalVar.raise_error = raise_error
           redis_store.write(key, value, **options)
         end
       end

data/lib/redis_memo/connection_pool.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'connection_pool'
 require_relative 'redis'
 
@@ -11,17 +12,17 @@ class RedisMemo::ConnectionPool
   end
 
   # Avoid method_missing when possible for better performance
-  %i(get mget mapped_mget set eval).each do |method_name|
+  %i[get mget mapped_mget set eval evalsha run_script].each do |method_name|
     define_method method_name do |*args, &blk|
       @connection_pool.with do |redis|
-        redis.send(method_name, *args, &blk)
+        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)
+      redis.__send__(method_name, *args, &blk)
     end
   end
 end

data/lib/redis_memo/errors.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RedisMemo
+  class ArgumentError < ::ArgumentError; end
+
+  class RuntimeError < ::RuntimeError; end
+
+  class WithoutMemoization < RuntimeError; end
+end

data/lib/redis_memo/future.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'cache'
 require_relative 'tracer'
 
@@ -11,14 +12,14 @@ class RedisMemo::Future
     method_args,
     dependent_memos,
     cache_options,
-    method_name_without_memo
+    method_name_without_memoization
   )
     @ref = ref
     @method_id = method_id
     @method_args = method_args
     @dependent_memos = dependent_memos
     @cache_options = cache_options
-    @method_name_without_memo = method_name_without_memo
+    @method_name_without_memoization = method_name_without_memoization
     @method_cache_key = nil
     @cache_hit = false
     @cached_result = nil
@@ -33,18 +34,26 @@ class RedisMemo::Future
 
   def method_cache_key
     @method_cache_key ||=
-      RedisMemo::MemoizeMethod.method_cache_keys([context])&.first || ''
+      RedisMemo::MemoizeMethod.__send__(:method_cache_keys, [context])&.first || ''
   end
 
-  def execute(cached_results=nil)
+  def validate_cache_result
+    cache_validation_sample_percentage =
+      @cache_options[:cache_validation_sample_percentage] || RedisMemo::DefaultOptions.cache_validation_sample_percentage
+
+    if cache_validation_sample_percentage.nil?
+      false
+    else
+      cache_validation_sample_percentage > Random.rand(0...100)
+    end
+  end
+
+  def execute(cached_results = nil)
     if RedisMemo::Batch.current
-      raise RedisMemo::RuntimeError, 'Cannot execute future when a batch is still open'
+      raise RedisMemo::RuntimeError.new('Cannot execute future when a batch is still open')
     end
 
     if cache_hit?(cached_results)
-      validate_cache_result =
-        RedisMemo::DefaultOptions.cache_validation_sampler&.call(@method_id)
-
       if validate_cache_result && cached_result != fresh_result
         RedisMemo::DefaultOptions.cache_out_of_date_handler&.call(
           @ref,
@@ -64,7 +73,7 @@ class RedisMemo::Future
 
   def result
     unless @computed_cached_result
-      raise RedisMemo::RuntimeError, 'Future has not been executed'
+      raise RedisMemo::RuntimeError.new('Future has not been executed')
     end
 
     @fresh_result || @cached_result
@@ -72,13 +81,13 @@ class RedisMemo::Future
 
   private
 
-  def cache_hit?(cached_results=nil)
+  def cache_hit?(cached_results = nil)
     cached_result(cached_results)
 
     @cache_hit
   end
 
-  def cached_result(cached_results=nil)
+  def cached_result(cached_results = nil)
     return @cached_result if @computed_cached_result
 
     @cache_hit = false
@@ -102,7 +111,7 @@ class RedisMemo::Future
 
     RedisMemo::Tracer.trace('redis_memo.cache.write', @method_id) do
       # cache miss
-      @fresh_result = @ref.send(@method_name_without_memo, *@method_args)
+      @fresh_result = @ref.__send__(@method_name_without_memoization, *@method_args)
       if @cache_options.include?(:expires_in) && @cache_options[:expires_in].respond_to?(:call)
         @cache_options[:expires_in] = @cache_options[:expires_in].call(@fresh_result)
       end
@@ -114,7 +123,7 @@ class RedisMemo::Future
             # result)
             @cache_hit && @cached_result != @fresh_result
           )
-      )
+        )
         RedisMemo::Cache.write(method_cache_key, @fresh_result, **@cache_options)
       end
     end