redis-memo 0.0.0.beta.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfc639839800aa1290622d733d9fd23619de8ccd63f2129e4570eb41a295884b
-  data.tar.gz: 26e2d86776244ba5cb0a8cebbc18e468ccf737888de9990c3a2bb9fc931bd4d5
+  metadata.gz: dd1d436b41e1f30d0d0910d086811f675b87b6bbe799a0087da7453b4c016b66
+  data.tar.gz: 7ca970165cb321e0016d6f70f6135868df19b68d27a180084f8053f94bf780c0
 SHA512:
-  metadata.gz: 3c6950a588fbf448d4b88e126ee9b32753ef314225d3aa5f69430d7e386a9a1085b517a08f4f6de2725810f35b493c20e2af62729f547891bcc78aaf4ce73ef2
-  data.tar.gz: 1e380d3ff6d457a6c93dcdebcbf9be072e919b2f5ff25377f169287ed8ac6c379f9a8db29a494d9174cff91e815e680201970ece43baba69b627678b628a3d77
+  metadata.gz: d79af32bc2a55a3755072cd0502d355745c7f060241d6a7f5e116eab8c0b7a45b107d02ef5d4bbcec0e6acb5bf435f1bb4d6b50084d13e410307610ef675f420
+  data.tar.gz: d9e0714a72c526be0043185dfc2c0dc3f6a6c94557da5b81e31905616b1a156cb6d2c89934548332802fff42a24ed53c1518a97b3912d2cc8beae41d9dffc7bf

data/lib/redis-memo.rb

@@ -1 +1,5 @@
+# frozen_string_literal: true
+
+# Automatically require the main file of the redis-memo gem when adding it to
+# the Gemfile
 require_relative 'redis_memo'

data/lib/redis_memo.rb

@@ -1,18 +1,53 @@
 # frozen_string_literal: true
+
 require 'active_support/all'
 require 'digest'
 require 'json'
+require 'securerandom'
 
 module RedisMemo
   require 'redis_memo/memoize_method'
   require 'redis_memo/memoize_query'
 
+  # A process-level +RedisMemo::Options+ instance that stores the global
+  # options. This object can be modified by +RedisMemo.configure+.
+  #
+  # +memoize_method+ allows users to provide method-level configuration.
+  # When no callsite-level configuration specified we will use the values in
+  # +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.
+  #
+  # @yieldparam [RedisMemo::Options] default_options
+  # +RedisMemo::DefaultOptions+
+  # @return [void]
   def self.configure(&blk)
     blk.call(DefaultOptions)
   end
 
+  # Batch Redis calls triggered by +memoize_method+ to minimize the 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.size == 5 # true
+  #
+  # See +RedisMemo::Batch+ for more information.
   def self.batch(&blk)
     RedisMemo::Batch.open
     blk.call
@@ -21,10 +56,17 @@ 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|
@@ -33,12 +75,17 @@ module RedisMemo
     end
   end
 
-  THREAD_KEY_WITHOUT_MEMO = :__redis_memo_without_memo__
-
+  # 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
   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
@@ -47,6 +94,8 @@ module RedisMemo
     Thread.current[THREAD_KEY_WITHOUT_MEMO] = prev_value
   end
 
+  # @todo Move errors to a separate file errors.rb
   class ArgumentError < ::ArgumentError; end
   class RuntimeError < ::RuntimeError; end
+  class WithoutMemoization < Exception; end
 end

data/lib/redis_memo/after_commit.rb

@@ -66,7 +66,12 @@ class RedisMemo::AfterCommit
       @@pending_memo_versions.each do |key, version|
         invalidation_queue =
           RedisMemo::Memoizable::Invalidation.class_variable_get(:@@invalidation_queue)
-        invalidation_queue << [key, version, @@previous_memo_versions[key]]
+
+        invalidation_queue << RedisMemo::Memoizable::Invalidation::Task.new(
+          key,
+          version,
+          @@previous_memo_versions[key],
+        )
       end
 
       RedisMemo::Memoizable::Invalidation.drain_invalidation_queue

data/lib/redis_memo/cache.rb

@@ -1,12 +1,14 @@
  # frozen_string_literal: true
 require_relative 'options'
 require_relative 'redis'
+require_relative 'connection_pool'
 
 class RedisMemo::Cache < ActiveSupport::Cache::RedisCacheStore
   class Rescuable < Exception; end
 
-  THREAD_KEY_LOCAL_CACHE = :__redis_memo_cache_local_cache__
-  THREAD_KEY_RAISE_ERROR = :__redis_memo_cache_raise_error__
+  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__
 
   @@redis = nil
   @@redis_store = nil
@@ -23,7 +25,12 @@ class RedisMemo::Cache < ActiveSupport::Cache::RedisCacheStore
   end
 
   def self.redis
-    @@redis ||= RedisMemo::DefaultOptions.redis
+    @@redis ||=
+      if RedisMemo::DefaultOptions.connection_pool
+        RedisMemo::ConnectionPool.new(**RedisMemo::DefaultOptions.connection_pool)
+      else
+        RedisMemo::DefaultOptions.redis
+      end
   end
 
   def self.redis_store
@@ -44,16 +51,22 @@ class RedisMemo::Cache < ActiveSupport::Cache::RedisCacheStore
     Thread.current[THREAD_KEY_LOCAL_CACHE]
   end
 
+  def self.local_dependency_cache
+    Thread.current[THREAD_KEY_LOCAL_DEPENDENCY_CACHE]
+  end
+
   class << self
     def with_local_cache(&blk)
       Thread.current[THREAD_KEY_LOCAL_CACHE] = {}
+      Thread.current[THREAD_KEY_LOCAL_DEPENDENCY_CACHE] = {}
       blk.call
     ensure
       Thread.current[THREAD_KEY_LOCAL_CACHE] = nil
+      Thread.current[THREAD_KEY_LOCAL_DEPENDENCY_CACHE] = nil
     end
 
     # RedisCacheStore doesn't read from the local cache before reading from redis
-    def read_multi(*keys, raise_error: false)
+    def read_multi(*keys, raw: false, raise_error: false)
       return {} if keys.empty?
 
       Thread.current[THREAD_KEY_RAISE_ERROR] = raise_error
@@ -64,7 +77,7 @@ class RedisMemo::Cache < ActiveSupport::Cache::RedisCacheStore
       keys_to_fetch -= local_entries.keys unless local_entries.empty?
       return local_entries if keys_to_fetch.empty?
 
-      remote_entries = redis_store.read_multi(*keys_to_fetch)
+      remote_entries = redis_store.read_multi(*keys_to_fetch, raw: raw)
       local_cache&.merge!(remote_entries)
 
       if local_entries.empty?

data/lib/redis_memo/connection_pool.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+require 'connection_pool'
+require_relative 'redis'
+
+class RedisMemo::ConnectionPool
+  def initialize(**options)
+    @connection_pool = ::ConnectionPool.new(**options) do
+      # Construct a new client every time the block gets called
+      RedisMemo::Redis.new(RedisMemo::DefaultOptions.redis_config)
+    end
+  end
+
+  # Avoid method_missing when possible for better performance
+  %i(get mget mapped_mget set eval).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/redis_memo/future.rb

@@ -9,14 +9,14 @@ class RedisMemo::Future
     ref,
     method_id,
     method_args,
-    depends_on,
+    dependent_memos,
     cache_options,
     method_name_without_memo
   )
     @ref = ref
     @method_id = method_id
     @method_args = method_args
-    @depends_on = depends_on
+    @dependent_memos = dependent_memos
     @cache_options = cache_options
     @method_name_without_memo = method_name_without_memo
     @method_cache_key = nil
@@ -28,7 +28,7 @@ class RedisMemo::Future
   end
 
   def context
-    [@ref, @method_id, @method_args, @depends_on]
+    [@method_id, @method_args, @dependent_memos]
   end
 
   def method_cache_key

data/lib/redis_memo/memoizable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-require 'securerandom'
 
 class RedisMemo::Memoizable
   require_relative 'memoizable/dependency'
@@ -52,7 +51,7 @@ class RedisMemo::Memoizable
       cache_key = instance.cache_key
       RedisMemo::Memoizable::Invalidation.bump_version_later(
         cache_key,
-        SecureRandom.uuid,
+        RedisMemo.uuid,
       )
     end
 
@@ -83,7 +82,11 @@ class RedisMemo::Memoizable
       if keys_to_fetch.empty?
         {}
       else
-        RedisMemo::Cache.read_multi(*keys_to_fetch, raise_error: true)
+        RedisMemo::Cache.read_multi(
+          *keys_to_fetch,
+          raw: true,
+          raise_error: true,
+        )
       end
     memo_versions.merge!(cached_versions) unless cached_versions.empty?
 
@@ -96,7 +99,7 @@ class RedisMemo::Memoizable
         # cached result.
         need_to_bump_versions = true
 
-        new_version = SecureRandom.uuid
+        new_version = RedisMemo.uuid
         RedisMemo::Memoizable::Invalidation.bump_version_later(
           key,
           new_version,

data/lib/redis_memo/memoizable/dependency.rb

@@ -25,12 +25,19 @@ class RedisMemo::Memoizable::Dependency
         # Extract dependencies from the current memoizable and recurse
         instance_exec(&memo.depends_on)
       end
-    when UsingActiveRecord
-      [
-        dependency.redis_memo_class_memoizable,
-        RedisMemo::MemoizeQuery.create_memo(dependency, **conditions),
-      ].each do |memo|
+    when ActiveRecord::Relation
+      extracted = self.class.extract_from_relation(dependency)
+      nodes.merge!(extracted.nodes)
+    when RedisMemo::MemoizeQuery::CachedSelect::BindParams
+      # A private API
+      dependency.params.each do |model, attrs_set|
+        memo = model.redis_memo_class_memoizable
         nodes[memo.cache_key] = memo
+
+        attrs_set.each do |attrs|
+          memo = RedisMemo::MemoizeQuery.create_memo(model, **attrs)
+          nodes[memo.cache_key] = memo
+        end
       end
     else
       raise(
@@ -40,9 +47,21 @@ class RedisMemo::Memoizable::Dependency
     end
   end
 
-  class UsingActiveRecord
-    def self.===(dependency)
-      RedisMemo::MemoizeQuery.using_active_record?(dependency)
+  private
+
+  def self.extract_from_relation(relation)
+    # Extract the dependent memos of an Arel without calling exec_query to actually execute the query
+    RedisMemo::MemoizeQuery::CachedSelect.with_new_query_context do
+      connection = ActiveRecord::Base.connection
+      query, binds, _ = connection.send(:to_sql_and_binds, relation.arel)
+      RedisMemo::MemoizeQuery::CachedSelect.current_query = relation.arel
+      is_query_cached = RedisMemo::MemoizeQuery::CachedSelect.extract_bind_params(query)
+
+      unless is_query_cached
+        raise RedisMemo::WithoutMemoization, 'Arel query is not cached using RedisMemo'
+      end
+
+      connection.dependency_of(:exec_query, query, nil, binds)
     end
   end
 end

data/lib/redis_memo/memoizable/invalidation.rb

@@ -3,12 +3,29 @@ require_relative '../after_commit'
 require_relative '../cache'
 
 module RedisMemo::Memoizable::Invalidation
-  # This is a thread safe data structure
-  #
-  # Handle transient network errors during cache invalidation
-  # Each item in the queue is a tuple:
-  #
-  #   [key, version (a UUID), previous_version (a UUID)]
+  class Task
+    attr_reader :key
+    attr_reader :version
+    attr_reader :previous_version
+
+    def initialize(key, version, previous_version)
+      @key = key
+      @version = version
+      @previous_version = previous_version
+      @created_at = current_timestamp
+    end
+
+    def current_timestamp
+      Process.clock_gettime(Process::CLOCK_REALTIME, :nanosecond)
+    end
+
+    def duration
+      current_timestamp - @created_at
+    end
+  end
+
+  # This is a thread safe data structure to handle transient network errors
+  # during cache invalidation
   #
   # When an invalidation call arrives at Redis, we only bump to the specified
   # version (so the cached results using that version will become visible) if
@@ -28,8 +45,6 @@ module RedisMemo::Memoizable::Invalidation
   @@invalidation_queue = Queue.new
 
   def self.bump_version_later(key, version, previous_version: nil)
-    RedisMemo::DefaultOptions.logger&.info("[received] Bump memo key #{key}")
-
     if RedisMemo::AfterCommit.in_transaction?
       previous_version ||= RedisMemo::AfterCommit.pending_memo_versions[key]
     end
@@ -41,7 +56,10 @@ module RedisMemo::Memoizable::Invalidation
       # Fill an expected previous version so the later calculation results
       # based on this version can still be rolled out if this version
       # does not change
-      previous_version ||= RedisMemo::Cache.read_multi(key)[key]
+      previous_version ||= RedisMemo::Cache.read_multi(
+        key,
+        raw: true,
+      )[key]
     end
 
     local_cache&.send(:[]=, key, version)
@@ -52,7 +70,7 @@ module RedisMemo::Memoizable::Invalidation
         previous_version: previous_version,
       )
     else
-      @@invalidation_queue << [key, version, previous_version]
+      @@invalidation_queue << Task.new(key, version, previous_version)
     end
   end
 
@@ -89,31 +107,32 @@ module RedisMemo::Memoizable::Invalidation
     return redis.call('set', key, new_version, unpack(px))
   LUA
 
-  def self.bump_version(cache_key, version, previous_version:)
-    RedisMemo::Tracer.trace('redis_memo.memoizable.bump_version', nil) do
+  def self.bump_version(task)
+    RedisMemo::Tracer.trace('redis_memo.memoizable.bump_version', task.key) do
       ttl = RedisMemo::DefaultOptions.expires_in
       ttl = (ttl * 1000.0).to_i if ttl
       RedisMemo::Cache.redis.eval(
         LUA_BUMP_VERSION,
-        keys: [cache_key],
-        argv: [previous_version, version, SecureRandom.uuid, ttl],
+        keys: [task.key],
+        argv: [task.previous_version, task.version, RedisMemo.uuid, ttl],
       )
+      RedisMemo::Tracer.set_tag(enqueue_to_finish: task.duration)
     end
-    RedisMemo::DefaultOptions.logger&.info("[performed] Bump memo key #{cache_key}")
   end
 
   def self.drain_invalidation_queue_now
     retry_queue = []
     until @@invalidation_queue.empty?
-      tuple = @@invalidation_queue.pop
+      task = @@invalidation_queue.pop
       begin
-        bump_version(tuple[0], tuple[1], previous_version: tuple[2])
-      rescue SignalException, Redis::BaseConnectionError
-        retry_queue << tuple
+        bump_version(task)
+      rescue SignalException, Redis::BaseConnectionError,
+             ::ConnectionPool::TimeoutError
+        retry_queue << task
       end
     end
   ensure
-    retry_queue.each { |t| @@invalidation_queue << t }
+    retry_queue.each { |task| @@invalidation_queue << task }
   end
 
   at_exit do

data/lib/redis_memo/memoize_method.rb

@@ -15,6 +15,12 @@ module RedisMemo::MemoizeMethod
     define_method method_name_with_memo do |*args|
       return send(method_name_without_memo, *args) if RedisMemo.without_memo?
 
+      dependent_memos = nil
+      if depends_on
+        dependency = RedisMemo::MemoizeMethod.get_or_extract_dependencies(self, *args, &depends_on)
+        dependent_memos = dependency.memos
+      end
+
       future = RedisMemo::Future.new(
         self,
         case method_id
@@ -26,7 +32,7 @@ module RedisMemo::MemoizeMethod
           method_id.call(self, *args)
         end,
         args,
-        depends_on,
+        dependent_memos,
         options,
         method_name_without_memo,
       )
@@ -37,6 +43,8 @@ module RedisMemo::MemoizeMethod
       end
 
       future.execute
+    rescue RedisMemo::WithoutMemoization
+      send(method_name_without_memo, *args)
     end
 
     alias_method method_name, method_name_with_memo
@@ -52,7 +60,7 @@ module RedisMemo::MemoizeMethod
           "#{method_name} is not a memoized method"
         )
       end
-      RedisMemo::MemoizeMethod.extract_dependencies(self, *method_args, &method_depends_on)
+      RedisMemo::MemoizeMethod.get_or_extract_dependencies(self, *method_args, &method_depends_on)
     end
   end
 
@@ -71,19 +79,100 @@ module RedisMemo::MemoizeMethod
     dependency
   end
 
+  def self.get_or_extract_dependencies(ref, *method_args, &depends_on)
+    if RedisMemo::Cache.local_dependency_cache
+      RedisMemo::Cache.local_dependency_cache[ref.class] ||= {}
+      RedisMemo::Cache.local_dependency_cache[ref.class][depends_on] ||= {}
+      named_args = exclude_anonymous_args(depends_on, ref, method_args)
+      RedisMemo::Cache.local_dependency_cache[ref.class][depends_on][named_args] ||= extract_dependencies(ref, *method_args, &depends_on)
+    else
+      extract_dependencies(ref, *method_args, &depends_on)
+    end
+  end
+
+  # We only look at named method parameters in the dependency block in order to define its dependent
+  # memos and ignore anonymous parameters, following the convention that nil or :_ is an anonymous parameter.
+  # Example:
+  # ```
+  #    def method(param1, param2)
+  #    end
+  #
+  #    memoize_method :method do |_, _, param2|`
+  #      depends_on RedisMemo::Memoizable.new(param2: param2)
+  #    end
+  # ```
+  #  `exclude_anonymous_args(depends_on, ref, [1, 2])` returns [2]
+  def self.exclude_anonymous_args(depends_on, ref, args)
+    return [] if depends_on.parameters.empty? or args.empty?
+
+    positional_args = []
+    kwargs = {}
+    depends_on_args = [ref] + args
+    options = depends_on_args.extract_options!
+
+    # Keep track of the splat start index, and the number of positional args before and after the splat,
+    # so we can map which args belong to positional args and which args belong to the splat.
+    named_splat = false
+    splat_index = nil
+    num_positional_args_after_splat = 0
+    num_positional_args_before_splat = 0
+
+    depends_on.parameters.each_with_index do |param, i|
+      # Defined by https://github.com/ruby/ruby/blob/22b8ddfd1049c3fd1e368684c4fd03bceb041b3a/proc.c#L3048-L3059
+      case param.first
+      when :opt, :req
+        if splat_index
+          num_positional_args_after_splat += 1
+        else
+          num_positional_args_before_splat += 1
+        end
+      when :rest
+        named_splat = is_named?(param)
+        splat_index = i
+      when :key, :keyreq
+        kwargs[param.last] = options[param.last] if is_named?(param)
+      when :keyrest
+        kwargs.merge!(options) if is_named?(param)
+      else
+        raise(RedisMemo::ArgumentError, "#{param.first} argument isn't supported in the dependency block")
+      end
+    end
+
+    # Determine the named positional and splat arguments after we know the # of pos. arguments before and after splat
+    after_splat_index = depends_on_args.size - num_positional_args_after_splat
+    depends_on_args.each_with_index do |arg, i|
+      # if the index is within the splat
+      if i >= num_positional_args_before_splat && i < after_splat_index
+        positional_args << arg if named_splat
+      else
+        j = i < num_positional_args_before_splat ? i : i - (after_splat_index - splat_index) - 1
+        positional_args << arg if is_named?(depends_on.parameters[j])
+      end
+    end
+
+    if !kwargs.empty?
+      positional_args + [kwargs]
+    elsif named_splat && !options.empty?
+      positional_args + [options]
+    else
+      positional_args
+    end
+  end
+private
+  def self.is_named?(param)
+    param.size == 2 && param.last != :_
+  end
+
   def self.method_cache_keys(future_contexts)
     memos = Array.new(future_contexts.size)
-    future_contexts.each_with_index do |(ref, _, method_args, depends_on), i|
-      if depends_on
-        dependency = extract_dependencies(ref, *method_args, &depends_on)
-        memos[i] = dependency.memos
-      end
+    future_contexts.each_with_index do |(_, _, dependent_memos), i|
+      memos[i] = dependent_memos
     end
 
     j = 0
     memo_checksums = RedisMemo::Memoizable.checksums(memos.compact)
     method_cache_key_versions = Array.new(future_contexts.size)
-    future_contexts.each_with_index do |(_, method_id, method_args, _), i|
+    future_contexts.each_with_index do |(method_id, method_args, _), i|
       if memos[i]
         method_cache_key_versions[i] = [method_id, memo_checksums[j]]
         j += 1

data/lib/redis_memo/memoize_query.rb

@@ -13,6 +13,8 @@ if defined?(ActiveRecord)
     # after each record save
     def memoize_table_column(*raw_columns, editable: true)
       RedisMemo::MemoizeQuery.using_active_record!(self)
+      return if ENV["REDIS_MEMO_DISABLE_#{self.table_name.upcase}"] == 'true'
+
       columns = raw_columns.map(&:to_sym).sort
 
       RedisMemo::MemoizeQuery.memoized_columns(self, editable_only: true) << columns if editable
@@ -102,7 +104,13 @@ if defined?(ActiveRecord)
       end
     end
 
-    def self.invalidate(record)
+    def self.invalidate(*records)
+      RedisMemo::Memoizable.invalidate(
+        records.map { |record| to_memos(record) }.flatten,
+      )
+    end
+
+    def self.to_memos(record)
       # Invalidate memos with current values
       memos_to_invalidate = memoized_columns(record.class).map do |columns|
         props = {}
@@ -137,7 +145,7 @@ if defined?(ActiveRecord)
         end
       end
 
-      RedisMemo::Memoizable.invalidate(memos_to_invalidate)
+      memos_to_invalidate
     end
   end
 end

data/lib/redis_memo/memoize_query/cached_select.rb

@@ -111,19 +111,19 @@ class RedisMemo::MemoizeQuery::CachedSelect
           sql.gsub(/(\$\d+)/, '?')      # $1 -> ?
              .gsub(/((, *)*\?)+/, '?')  # (?, ?, ? ...) -> (?)
         end,
-      ) do |_, sql, name, binds, **kwargs|
-        RedisMemo::MemoizeQuery::CachedSelect
-          .current_query_bind_params
-          .params
-          .each do |model, attrs_set|
-            attrs_set.each do |attrs|
-              depends_on model, **attrs
-            end
-          end
+      ) do |_, sql, _, binds, **|
+        depends_on RedisMemo::MemoizeQuery::CachedSelect.current_query_bind_params
 
         depends_on RedisMemo::Memoizable.new(
           __redis_memo_memoize_query_memoize_query_sql__: sql,
-          __redis_memo_memoize_query_memoize_query_binds__: binds.map(&:value_for_database),
+          __redis_memo_memoize_query_memoize_query_binds__: binds.map do |bind|
+            if bind.respond_to?(:value_for_database)
+              bind.value_for_database
+            else
+              # In activerecord >= 6, a bind could be an actual database value
+              bind
+            end
+          end
         )
       end
     end
@@ -187,6 +187,19 @@ class RedisMemo::MemoizeQuery::CachedSelect
     Thread.current[THREAD_KEY_AREL_BIND_PARAMS] = nil
   end
 
+  def self.with_new_query_context
+    prev_arel = Thread.current[THREAD_KEY_AREL]
+    prev_substitutes = Thread.current[THREAD_KEY_SUBSTITUTES]
+    prev_bind_params = Thread.current[THREAD_KEY_AREL_BIND_PARAMS]
+    RedisMemo::MemoizeQuery::CachedSelect.reset_current_query
+
+    yield
+  ensure
+    Thread.current[THREAD_KEY_AREL] = prev_arel
+    Thread.current[THREAD_KEY_SUBSTITUTES] = prev_substitutes
+    Thread.current[THREAD_KEY_AREL_BIND_PARAMS] = prev_bind_params
+  end
+
   private
 
   # A pre-order Depth First Search
@@ -197,7 +210,7 @@ class RedisMemo::MemoizeQuery::CachedSelect
     bind_params = BindParams.new
 
     case node
-    when Arel::Nodes::Equality, Arel::Nodes::In
+    when NodeHasFilterCondition
       attr_node = node.left
       return unless attr_node.is_a?(Arel::Attributes::Attribute)
 
@@ -234,7 +247,13 @@ class RedisMemo::MemoizeQuery::CachedSelect
           }
         when Arel::Nodes::Casted
           bind_params.params[binding_relation] << {
-            right.attribute.name.to_sym => right.val,
+            right.attribute.name.to_sym =>
+              if right.respond_to?(:val)
+                right.val
+              else
+                # activerecord >= 6
+                right.value
+              end,
           }
         else
           bind_params = bind_params.union(extract_bind_params_recurse(right))
@@ -330,6 +349,23 @@ class RedisMemo::MemoizeQuery::CachedSelect
     enabled_models[table_node.try(:name)]
   end
 
+  class NodeHasFilterCondition
+    def self.===(node)
+      case node
+      when Arel::Nodes::Equality, Arel::Nodes::In
+        true
+      else
+        # In activerecord >= 6, a new arel node HomogeneousIn is introduced
+        if defined?(Arel::Nodes::HomogeneousIn) &&
+           node.is_a?(Arel::Nodes::HomogeneousIn)
+          true
+        else
+          false
+        end
+      end
+    end
+  end
+
   # Thread locals to exchange information between RedisMemo and ActiveRecord
   THREAD_KEY_AREL = :__redis_memo_memoize_query_cached_select_arel__
   THREAD_KEY_SUBSTITUTES = :__redis_memo_memoize_query_cached_select_substitues__

data/lib/redis_memo/memoize_query/invalidation.rb

@@ -33,17 +33,14 @@ class RedisMemo::MemoizeQuery::Invalidation
     # Methods that won't trigger model callbacks
     # https://guides.rubyonrails.org/active_record_callbacks.html#skipping-callbacks
     %i(
-      import import!
       decrement_counter
       delete_all delete_by
       increment_counter
-      insert insert! insert_all insert_all!
       touch_all
       update_column update_columns update_all update_counters
-      upsert upsert_all
     ).each do |method_name|
       # Example: Model.update_all
-      rewrite_bulk_update_method(
+      rewrite_default_method(
         model_class,
         model_class,
         method_name,
@@ -51,7 +48,7 @@ class RedisMemo::MemoizeQuery::Invalidation
       )
 
       # Example: Model.where(...).update_all
-      rewrite_bulk_update_method(
+      rewrite_default_method(
         model_class,
         model_class.const_get(:ActiveRecord_Relation),
         method_name,
@@ -59,20 +56,76 @@ class RedisMemo::MemoizeQuery::Invalidation
       )
     end
 
+    %i(
+      insert insert! insert_all insert_all!
+    ).each do |method_name|
+      rewrite_insert_method(
+        model_class,
+        method_name,
+      )
+    end
+
+    %i(
+      upsert upsert_all
+    ).each do |method_name|
+      rewrite_upsert_method(
+        model_class,
+        method_name,
+      )
+    end
+
+    %i(
+      import import!
+    ).each do |method_name|
+      rewrite_import_method(
+        model_class,
+        method_name,
+      )
+    end
+
     model_class.class_variable_set(var_name, true)
   end
 
+  def self.invalidate_new_records(model_class, &blk)
+    current_id = model_class.maximum(model_class.primary_key)
+    result = blk.call
+    records = select_by_new_ids(model_class, current_id)
+    RedisMemo::MemoizeQuery.invalidate(*records) unless records.empty?
+    result
+  end
+
+  def self.invalidate_records_by_conflict_target(model_class, records:, conflict_target: nil, &blk)
+    if conflict_target.nil?
+      # When the conflict_target is not set, we are basically inserting new
+      # records since duplicate rows are simply skipped
+      return invalidate_new_records(model_class, &blk)
+    end
+
+    relation = build_relation_by_conflict_target(model_class, records, conflict_target)
+    # Invalidate records before updating
+    records = select_by_conflict_target_relation(model_class, relation)
+    RedisMemo::MemoizeQuery.invalidate(*records) unless records.empty?
+
+    # Perform updating
+    result = blk.call
+
+    # Invalidate records after updating
+    records = select_by_conflict_target_relation(model_class, relation)
+    RedisMemo::MemoizeQuery.invalidate(*records) unless records.empty?
+
+    result
+  end
+
   private
 
   #
-  # There’s no good way to perform fine-grind cache invalidation when operations
-  # are bulk update operations such as import, update_all, and destroy_all:
-  # Performing fine-grind cache invalidation would require the applications to
-  # fetch additional data from the database, which might lead to performance
-  # degradation. Thus we simply invalidate all existing cached records after each
-  # bulk_updates.
+  # There’s no good way to perform fine-grind cache invalidation when
+  # operations are bulk update operations such as update_all, and delete_all
+  # witout fetching additional data from the database, which might lead to
+  # performance degradation. Thus, by default, we simply invalidate all
+  # existing cached records after each bulk_updates.
   #
-  def self.rewrite_bulk_update_method(model_class, klass, method_name, class_method:)
+  def self.rewrite_default_method(model_class, klass, method_name, class_method:)
     methods = class_method ? :methods : :instance_methods
     return unless klass.send(methods).include?(method_name)
 
@@ -87,4 +140,125 @@ class RedisMemo::MemoizeQuery::Invalidation
       end
     end
   end
+
+  def self.rewrite_insert_method(model_class, method_name)
+    return unless model_class.respond_to?(method_name)
+
+    model_class.singleton_class.class_eval do
+      alias_method :"#{method_name}_without_redis_memo_invalidation", method_name
+
+      define_method method_name do |*args, &blk|
+        RedisMemo::MemoizeQuery::Invalidation.invalidate_new_records(model_class) do
+          send(:"#{method_name}_without_redis_memo_invalidation", *args, &blk)
+        end
+      end
+    end
+  end
+
+  def self.rewrite_upsert_method(model_class, method_name)
+    return unless model_class.respond_to?(method_name)
+
+    model_class.singleton_class.class_eval do
+      alias_method :"#{method_name}_without_redis_memo_invalidation", method_name
+
+      define_method method_name do |attributes, unique_by: nil, **kwargs, &blk|
+        RedisMemo::MemoizeQuery::Invalidation.invalidate_records_by_conflict_target(
+          model_class,
+          records: nil, # not used
+          # upsert does not support on_duplicate_key_update yet at activerecord
+          # HEAD (6.1.3)
+          conflict_target: nil,
+        ) do
+          send(
+            :"#{method_name}_without_redis_memo_invalidation",
+            attributes,
+            unique_by: unique_by,
+            **kwargs,
+            &blk
+          )
+        end
+      end
+    end
+  end
+
+  def self.rewrite_import_method(model_class, method_name)
+    return unless model_class.respond_to?(method_name)
+
+    model_class.singleton_class.class_eval do
+      alias_method :"#{method_name}_without_redis_memo_invalidation", method_name
+
+      # For the args format, see
+      # https://github.com/zdennis/activerecord-import/blob/master/lib/activerecord-import/import.rb#L128
+      define_method method_name do |*args, &blk|
+        options = args.last.is_a?(Hash) ? args.last : {}
+        records = args[args.last.is_a?(Hash) ? -2 : -1]
+        on_duplicate_key_update = options[:on_duplicate_key_update]
+        conflict_target =
+          case on_duplicate_key_update
+          when Hash
+            # The conflict_target option is only supported in PostgreSQL. In
+            # MySQL, the primary_key is used as the conflict_target
+            on_duplicate_key_update[:conflict_target] || [model_class.primary_key.to_sym]
+          when Array
+            # The default conflict_target is just the primary_key
+            [model_class.primary_key.to_sym]
+          else
+            # Ignore duplicate rows
+            nil
+          end
+
+        if conflict_target && records.last.is_a?(Hash)
+          records.map! { |hash| model_class.new(hash) }
+        end
+
+        RedisMemo::MemoizeQuery::Invalidation.invalidate_records_by_conflict_target(
+          model_class,
+          records: records,
+          conflict_target: conflict_target,
+        ) do
+          send(:"#{method_name}_without_redis_memo_invalidation", *args, &blk)
+        end
+      end
+    end
+  end
+
+  def self.build_relation_by_conflict_target(model_class, records, conflict_target)
+    or_chain = nil
+
+    records.each do |record|
+      conditions = {}
+      conflict_target.each do |column|
+        conditions[column] = record.send(column)
+      end
+      if or_chain
+        or_chain = or_chain.or(model_class.where(conditions))
+      else
+        or_chain = model_class.where(conditions)
+      end
+    end
+
+    or_chain
+  end
+
+  def self.select_by_new_ids(model_class, target_id)
+    RedisMemo::Tracer.trace(
+      'redis_memo.memoize_query.invalidation',
+      "#{__method__}##{model_class.name}",
+    ) do
+      RedisMemo.without_memo do
+        model_class.where(
+          model_class.arel_table[model_class.primary_key].gt(target_id),
+        ).to_a
+      end
+    end
+  end
+
+  def self.select_by_conflict_target_relation(model_class, relation)
+    RedisMemo::Tracer.trace(
+      'redis_memo.memoize_query.invalidation',
+      "#{__method__}##{model_class.name}",
+    ) do
+      RedisMemo.without_memo { relation.reload }
+    end
+  end
 end

data/lib/redis_memo/options.rb

@@ -13,7 +13,7 @@ class RedisMemo::Options
   )
     @compress = compress.nil? ? true : compress
     @compress_threshold = compress_threshold || 1.kilobyte
-    @redis = redis
+    @redis_config = redis
     @redis_client = nil
     @redis_error_handler = redis_error_handler
     @tracer = tracer
@@ -22,20 +22,18 @@ class RedisMemo::Options
     @expires_in = expires_in
   end
 
-  def redis(&blk)
-    if blk.nil?
-      return @redis_client if @redis_client.is_a?(RedisMemo::Redis)
+  def redis
+    @redis_client ||= RedisMemo::Redis.new(redis_config)
+  end
 
-      if @redis.respond_to?(:call)
-        @redis_client = RedisMemo::Redis.new(@redis.call)
-      elsif @redis
-        @redis_client = RedisMemo::Redis.new(@redis)
-      else
-        @redis_client = RedisMemo::Redis.new
-      end
-    else
-      @redis = blk
-    end
+  def redis_config
+    @redis_config || {}
+  end
+
+  def redis=(config)
+    @redis_config = config
+    @redis_client = nil
+    redis
   end
 
   def tracer(&blk)
@@ -74,15 +72,15 @@ class RedisMemo::Options
   end
 
   attr_accessor :async
+  attr_accessor :cache_out_of_date_handler
+  attr_accessor :cache_validation_sampler
   attr_accessor :compress
   attr_accessor :compress_threshold
-  attr_accessor :redis_error_handler
+  attr_accessor :connection_pool
   attr_accessor :expires_in
-  attr_accessor :cache_validation_sampler
-  attr_accessor :cache_out_of_date_handler
+  attr_accessor :redis_error_handler
 
   attr_writer :global_cache_key_version
-  attr_writer :redis
   attr_writer :tracer
   attr_writer :logger
 end

data/lib/redis_memo/redis.rb

@@ -31,7 +31,8 @@ class RedisMemo::Redis < Redis::Distributed
   end
 
   class WithReplicas < ::Redis
-    def initialize(options)
+    def initialize(orig_options)
+      options = orig_options.dup
       primary_option = options.shift
       @replicas = options.map do |option|
         option[:logger] ||= RedisMemo::DefaultOptions.logger

data/lib/redis_memo/tracer.rb

@@ -11,13 +11,15 @@ class RedisMemo::Tracer
     end
   end
 
-  def self.set_tag(cache_hit:)
+  def self.set_tag(**tags)
     tracer = RedisMemo::DefaultOptions.tracer
     return if tracer.nil? || !tracer.respond_to?(:active_span)
 
     active_span = tracer.active_span
     return if !active_span.respond_to?(:set_tag)
 
-    active_span.set_tag('cache_hit', cache_hit)
+    tags.each do |name, value|
+      active_span.set_tag(name, value)
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-memo
 version: !ruby/object:Gem::Version
-  version: 0.0.0.beta.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Chan Zuckerberg Initiative
@@ -14,44 +14,72 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: 4.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+- !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: '4'
+        version: 2.2.3
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: activerecord-import
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
@@ -147,6 +175,7 @@ files:
 - lib/redis_memo/after_commit.rb
 - lib/redis_memo/batch.rb
 - lib/redis_memo/cache.rb
+- lib/redis_memo/connection_pool.rb
 - lib/redis_memo/future.rb
 - lib/redis_memo/memoizable.rb
 - lib/redis_memo/memoizable/dependency.rb
@@ -179,9 +208,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.8
 signing_key: