redis-memo 0.0.0.beta.2 → 0.0.0.beta.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfc639839800aa1290622d733d9fd23619de8ccd63f2129e4570eb41a295884b
-  data.tar.gz: 26e2d86776244ba5cb0a8cebbc18e468ccf737888de9990c3a2bb9fc931bd4d5
+  metadata.gz: fd8d075c12b20782f27bdfe2488cba1c0f31f5fb537241a9cedcc72f484588b9
+  data.tar.gz: 0eef678b83746557ba84aca013e660ecc31a028042cf052606673179e185d61e
 SHA512:
-  metadata.gz: 3c6950a588fbf448d4b88e126ee9b32753ef314225d3aa5f69430d7e386a9a1085b517a08f4f6de2725810f35b493c20e2af62729f547891bcc78aaf4ce73ef2
-  data.tar.gz: 1e380d3ff6d457a6c93dcdebcbf9be072e919b2f5ff25377f169287ed8ac6c379f9a8db29a494d9174cff91e815e680201970ece43baba69b627678b628a3d77
+  metadata.gz: a8f573eb77832f3dfb0600ab607c8d60090969082c86a9403a98b784899931da60d66f1b761bf863fd4007492ff47dee2d7880ec2f10cf5143fce33bc791684b
+  data.tar.gz: 4f9e44c13d2b4918f69f143f78eb4d80ad306b43abb650c03c481d727a88938f70c3ef89854e5c67afe92cc656df82ff44df84bb07878904bcdfbb2b86c15275

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,7 @@ 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
 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

@@ -5,8 +5,9 @@ require_relative 'redis'
 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
@@ -44,12 +45,18 @@ 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

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
 
@@ -96,7 +95,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,6 +25,9 @@ class RedisMemo::Memoizable::Dependency
         # Extract dependencies from the current memoizable and recurse
         instance_exec(&memo.depends_on)
       end
+    when ActiveRecord::Relation
+      extracted = extract_dependencies_for_relation(dependency)
+      nodes.merge!(extracted.nodes)
     when UsingActiveRecord
       [
         dependency.redis_memo_class_memoizable,
@@ -40,6 +43,21 @@ class RedisMemo::Memoizable::Dependency
     end
   end
 
+  def extract_dependencies_for_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)
+        raise(
+          RedisMemo::ArgumentError,
+          "Invalid Arel dependency. Query is not enabled for RedisMemo caching."
+        ) unless is_query_cached
+        extracted_dependency = connection.dependency_of(:exec_query, query, nil, binds)
+    end
+  end
+
   class UsingActiveRecord
     def self.===(dependency)
       RedisMemo::MemoizeQuery.using_active_record?(dependency)

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
@@ -52,7 +67,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 +104,31 @@ 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])
+        bump_version(task)
       rescue SignalException, Redis::BaseConnectionError
-        retry_queue << tuple
+        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

@@ -52,7 +52,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,11 +71,21 @@ 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] ||= {}
+      RedisMemo::Cache.local_dependency_cache[ref][depends_on] ||= {}
+      RedisMemo::Cache.local_dependency_cache[ref][depends_on][method_args] ||= extract_dependencies(ref, *method_args, &depends_on)
+    else
+      extract_dependencies(ref, *method_args, &depends_on)
+    end
+  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)
+        dependency = get_or_extract_dependencies(ref, *method_args, &depends_on)
         memos[i] = dependency.memos
       end
     end

data/lib/redis_memo/memoize_query.rb

@@ -103,6 +103,10 @@ if defined?(ActiveRecord)
     end
 
     def self.invalidate(record)
+      RedisMemo::Memoizable.invalidate(to_memos(record))
+    end
+
+    def self.to_memos(record)
       # Invalidate memos with current values
       memos_to_invalidate = memoized_columns(record.class).map do |columns|
         props = {}
@@ -137,7 +141,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

@@ -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

data/lib/redis_memo/memoize_query/invalidation.rb

@@ -33,7 +33,6 @@ 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
@@ -43,7 +42,7 @@ class RedisMemo::MemoizeQuery::Invalidation
       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 +50,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 +58,28 @@ class RedisMemo::MemoizeQuery::Invalidation
       )
     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
 
   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 +94,79 @@ class RedisMemo::MemoizeQuery::Invalidation
       end
     end
   end
+
+  def self.rewrite_import_method(model_class, method_name)
+    # This optimization to avoid over-invalidation only works on postgres
+    unless ActiveRecord::Base.connection.is_a?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
+      rewrite_default_method(model_class, model_class, method_name, class_method: true)
+      return
+    end
+
+    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]
+        unique_by = options[:on_duplicate_key_update]
+        if unique_by.is_a?(Hash)
+          unique_by = unique_by[:columns]
+        end
+
+        if records.last.is_a?(Hash)
+          records.map! { |hash| model_class.new(hash) }
+        end
+
+        # Invalidate the records before and after the import to resolve
+        # - default values filled by the database
+        # - updates on conflict conditions
+        records_to_invalidate =
+          if unique_by
+            RedisMemo::MemoizeQuery::Invalidation.send(
+              :select_by_uniq_index,
+              records,
+              unique_by,
+            )
+          else
+            []
+          end
+
+        result = send(:"#{method_name}_without_redis_memo_invalidation", *args, &blk)
+
+        records_to_invalidate += RedisMemo.without_memo do
+          # Not all databases support "RETURNING", which is useful when
+          # invaldating records after bulk creation
+          model_class.where(model_class.primary_key => result.ids).to_a
+        end
+
+        memos_to_invalidate = records_to_invalidate.map do |record|
+          RedisMemo::MemoizeQuery.to_memos(record)
+        end
+        RedisMemo::Memoizable.invalidate(memos_to_invalidate.flatten)
+
+        result
+      end
+    end
+  end
+
+  def self.select_by_uniq_index(records, unique_by)
+    model_class = records.first.class
+    or_chain = nil
+
+    records.each do |record|
+      conditions = {}
+      unique_by.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
+
+    RedisMemo.without_memo { or_chain.to_a }
+  end
 end

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.0.0.beta.3
 platform: ruby
 authors:
 - Chan Zuckerberg Initiative
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !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