redis-memo 0.0.0.alpha → 0.0.0.beta.4

data/lib/redis_memo/options.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+class RedisMemo::Options
+  def initialize(
+    async: nil,
+    compress: nil,
+    compress_threshold: nil,
+    redis: nil,
+    redis_error_handler: nil,
+    tracer: nil,
+    global_cache_key_version: nil,
+    expires_in: nil
+  )
+    @compress = compress.nil? ? true : compress
+    @compress_threshold = compress_threshold || 1.kilobyte
+    @redis_config = redis
+    @redis_client = nil
+    @redis_error_handler = redis_error_handler
+    @tracer = tracer
+    @logger = logger
+    @global_cache_key_version = global_cache_key_version
+    @expires_in = expires_in
+  end
+
+  def redis
+    @redis_client ||= RedisMemo::Redis.new(redis_config)
+  end
+
+  def redis_config
+    @redis_config || {}
+  end
+
+  def redis=(config)
+    @redis_config = config
+    @redis_client = nil
+    redis
+  end
+
+  def tracer(&blk)
+    if blk.nil?
+      return @tracer if @tracer.respond_to?(:trace)
+
+      @tracer&.call
+    else
+      @tracer = blk
+    end
+  end
+
+  def logger(&blk)
+    if blk.nil?
+      return @logger if @logger.respond_to?(:warn)
+
+      @logger&.call
+    else
+      @logger = blk
+    end
+  end
+
+  def global_cache_key_version(&blk)
+    # this method takes a block to be consistent with the inline memo_method
+    # API
+    if blk.nil?
+      if !@global_cache_key_version.respond_to?(:call)
+        return @global_cache_key_version
+      end
+
+      @global_cache_key_version&.call
+    else
+      # save the global cache_key_version eagerly
+      @global_cache_key_version = blk
+    end
+  end
+
+  attr_accessor :async
+  attr_accessor :bulk_operations_invalidation_limit
+  attr_accessor :cache_out_of_date_handler
+  attr_accessor :cache_validation_sampler
+  attr_accessor :compress
+  attr_accessor :compress_threshold
+  attr_accessor :connection_pool
+  attr_accessor :expires_in
+  attr_accessor :redis_error_handler
+
+  attr_writer :global_cache_key_version
+  attr_writer :tracer
+  attr_writer :logger
+end

data/lib/redis_memo/redis.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+require 'redis'
+require 'redis/distributed'
+
+require_relative 'options'
+
+# Redis::Distributed does not support reading from multiple read replicas. This
+# class adds this functionality
+class RedisMemo::Redis < Redis::Distributed
+  def initialize(options={})
+    clients =
+      if options.is_a?(Array)
+        options.map do |option|
+          if option.is_a?(Array)
+            RedisMemo::Redis::WithReplicas.new(option)
+          else
+            option[:logger] ||= RedisMemo::DefaultOptions.logger
+            ::Redis.new(option)
+          end
+        end
+      else
+        options[:logger] ||= RedisMemo::DefaultOptions.logger
+        [::Redis.new(options)]
+      end
+
+    # Pass in our own hash ring to use the clients with multi-read-replica
+    # support
+    hash_ring = Redis::HashRing.new(clients)
+
+    super([], ring: hash_ring)
+  end
+
+  class WithReplicas < ::Redis
+    def initialize(options)
+      primary_option = options.shift
+      @replicas = options.map do |option|
+        option[:logger] ||= RedisMemo::DefaultOptions.logger
+        ::Redis.new(option)
+      end
+
+      primary_option[:logger] ||= RedisMemo::DefaultOptions.logger
+      super(primary_option)
+    end
+
+    alias_method :get_primary, :get
+    alias_method :mget_primary, :mget
+    alias_method :mapped_mget_primary, :mapped_mget
+
+    def get(key)
+      return get_primary(key) if @replicas.empty?
+
+      @replicas.sample(1).first.get(key)
+    end
+
+    def mget(*keys, &blk)
+      return mget_primary(*keys, &blk) if @replicas.empty?
+
+      @replicas.sample(1).first.mget(*keys)
+    end
+
+    def mapped_mget(*keys)
+      return mapped_mget_primary(*keys) if @replicas.empty?
+
+      @replicas.sample(1).first.mapped_mget(*keys)
+    end
+  end
+end

data/lib/redis_memo/tracer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+require_relative 'options'
+
+class RedisMemo::Tracer
+  def self.trace(span_name, method_id, &blk)
+    tracer = RedisMemo::DefaultOptions.tracer
+    return blk.call if tracer.nil?
+
+    tracer.trace(span_name, resource: method_id, service: 'redis_memo') do
+      blk.call
+    end
+  end
+
+  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)
+
+    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.alpha
+  version: 0.0.0.beta.4
 platform: ruby
 authors:
 - Chan Zuckerberg Initiative
@@ -10,48 +10,76 @@ bindir: bin
 cert_chain: []
 date: 2020-10-31 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  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: sorbet
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.4704
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.4704
+        version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: sorbet-static
+  name: activerecord-import
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.4704
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.4704
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +94,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner-active_record
+  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: pg
+  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: rake
+  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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -100,7 +170,29 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/redis-memo.rb
 - lib/redis_memo.rb
+- 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
+- lib/redis_memo/memoizable/invalidation.rb
+- lib/redis_memo/memoize_method.rb
+- lib/redis_memo/memoize_query.rb
+- lib/redis_memo/memoize_query/cached_select.rb
+- lib/redis_memo/memoize_query/cached_select/bind_params.rb
+- lib/redis_memo/memoize_query/cached_select/connection_adapter.rb
+- lib/redis_memo/memoize_query/cached_select/statement_cache.rb
+- lib/redis_memo/memoize_query/invalidation.rb
+- lib/redis_memo/memoize_query/memoize_table_column.rb
+- lib/redis_memo/memoize_query/model_callback.rb
+- lib/redis_memo/middleware.rb
+- lib/redis_memo/options.rb
+- lib/redis_memo/redis.rb
+- lib/redis_memo/tracer.rb
 homepage: https://github.com/chanzuckerberg/redis-memo
 licenses:
 - MIT
@@ -120,9 +212,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
-summary: Redis based memoization
+summary: A Redis-based version-addressable caching system. Memoize pure functions,
+  aggregated database queries, and 3rd party API calls.
 test_files: []