incrdecr_cached_counts 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 933d0e94e08544064f20c36691f4c82fc581a843
-  data.tar.gz: d60e51a4e1f2f3be7329f41999199ee04c471675
+SHA256:
+  metadata.gz: 5c0a0f2090aabd3b286436ad4bce2dca587f003cb5c19307be1d7974c84894ab
+  data.tar.gz: 546850171cb6d859149155acd0a6c3cc4697702306c7e7d7015c6a6e86bc4066
 SHA512:
-  metadata.gz: 0e83facc3fb470a922d4dbbca8fbefdfe525a8a03016a49a9e3f244b97f8ca46e4c77a1d46143fd9ad84046c98d5bc1d9c46ab50fbd861f58c15d618947e9c7b
-  data.tar.gz: c7fb4d8e58784e72ac21884abb76412050a18c6e55520d470b65fc336c49336728ff2677bf2f6b5760c2c6a5bba2ed8683ff44280ebd1967e4982b1125b80352
+  metadata.gz: dc5aa5c3e0977528853821aa6d11484f1bfccbb8c435c003ea4c90856cac06933448c52707884dd182a5727f04c701ff5a5bf21d8454b695637a62fd0860ed72
+  data.tar.gz: 7ce3ec421d5bea4a5f6e1a5a80c341fcb603f8288a13751058afb9ced3aea58ceae75668a42522132d3f3246e5955a60a16ecf80f6b9a1b6d6017a1286e9f9b1

data/.circleci/config.yml

@@ -0,0 +1,47 @@
+version: 2.1
+
+jobs:
+  build:
+    docker:
+      - image: cimg/ruby:2.7-node # use a tailored CircleCI docker image.
+    steps:
+      - checkout
+
+      - run: bundle config set path 'vendor/bundle'
+      - run: sudo apt-get update
+      - run: sudo apt install libsqlite3-dev
+
+      # There's probably a better way of doing this that avoids the repetition and manual
+      # deletion of Gemfile.lock.
+      - restore_cache:
+          key: rails-5.2.4.4-{{ checksum "Gemfile" }}
+      - run:
+          name: bundle install
+          command: bundle install
+          environment:
+            ACTIVERECORD_VERSION: 5.2.4.4
+      - save_cache:
+          key: rails-5.2.4.4-{{ checksum "Gemfile" }}
+          paths:
+            - vendor/bundle
+      - run:
+          name: Test with Rails 5.2
+          command: bundle exec rspec
+
+      - run: rm Gemfile.lock
+      - restore_cache:
+          key: rails-6.0.3.4-{{ checksum "Gemfile" }}
+      - run:
+          name: bundle install
+          command: bundle install --path vendor/bundle
+          environment:
+            ACTIVERECORD_VERSION: 6.0.3.4
+      - save_cache:
+          key: rails-6.0.3.4-{{ checksum "Gemfile" }}
+          paths:
+            - vendor/bundle
+      - restore_cache:
+          key: rails-6.0.3.4-{{ checksum "Gemfile" }}
+      - run:
+          name: Test with Rails 6.0
+          command: bundle exec rspec

data/README.rdoc

@@ -1,5 +1,7 @@
 = CachedCounts
 
+{<img src="http://circleci.com/gh/academia-edu/cached_counts.svg?style=svg" />}[https://circleci.com/gh/academia-edu/cached_counts]
+
 A replacement for Rails' counter caches, using memcached.
 
 Caches counts of models in a scope or association in memcached, and keeps the

data/incrdecr_cached_counts.gemspec

@@ -19,13 +19,11 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency "rails", ">= 4.0"
+  s.add_dependency "rails", ">= 5.2"
   s.add_dependency "dalli"
 
   s.add_development_dependency "sqlite3"
   s.add_development_dependency "rspec"
   s.add_development_dependency "database_cleaner"
-  s.add_development_dependency "test_after_commit"
-  s.add_development_dependency "after_commit_exception_notification"
   s.add_development_dependency "rake"
 end

data/lib/cached_counts.rb

@@ -1,6 +1,5 @@
 require 'cached_counts/logger'
-require 'cached_counts/dalli_check'
-require 'cached_counts/connection_for'
+require 'cached_counts/query_context'
 
 module CachedCounts
   extend ActiveSupport::Concern
@@ -39,11 +38,13 @@ module CachedCounts
     # @option options [Integer, #to_s] :version
     #   Cache version - bump if you change the definition of a count.
     #
-    # @option options [Lambda] :default_value_lambda
-    #   Uses this value when the cache is empty, while it is being populated
-    #
-    # @option options [Lambda] :value_updater_lambda
-    #   Override logic for updating a cache value - e.g. to perform background updates
+    # @option options [Proc] :race_condition_fallback
+    #   Fallback to the result of this proc if the cache is empty, while
+    #   loading the actual value from the db. Works similarly to
+    #   +race_condition_ttl+ but for empty caches rather than expired values.
+    #   Meant to prevent a thundering-herd scenario, if for example a
+    #   memcached instance goes away. Can be nil; defaults to using a value
+    #   grabbed from the cache or DB at startup.
     #
     def caches_count_where(attribute_name, options = {})
       # Delay actual run to work around circular dependencies
@@ -134,6 +135,14 @@ module CachedCounts
       version = options.fetch :version, 1
       key = scope_count_key(attribute_name, version)
 
+      unless options.has_key?(:race_condition_fallback)
+        options[:race_condition_fallback] = default_race_condition_fallback_proc(
+          key,
+          relation,
+          options
+        )
+      end
+
       [attribute_name, *Array(options[:alias])].each do |attr_name|
         add_count_attribute_methods(
           attr_name,
@@ -146,6 +155,23 @@ module CachedCounts
       end
     end
 
+    def default_race_condition_fallback_proc(key, relation, options)
+      fallback = Rails.cache.read(key)
+      fallback = fallback.value if fallback.is_a?(ActiveSupport::Cache::Entry)
+
+      if fallback.nil?
+        begin
+          fallback = relation.count
+        rescue ActiveRecord::StatementInvalid => e
+          fallback = 0
+        end
+
+        Rails.cache.write key, fallback, expires_in: options.fetch(:expires_in, 1.week), raw: true
+      end
+
+      -> { fallback }
+    end
+
     def define_association_count_attribute(attribute_name, association, options)
       options = options.dup
 
@@ -158,6 +184,18 @@ module CachedCounts
           association_count_key(id, attribute_name, version)
         end
 
+        # Try to fetch values for ids from the cache. If it's a miss return the default value
+        define_singleton_method "try_#{attr_name}_counts_for" do |ids, default=nil|
+          raw_result = Rails.cache.read_multi(*ids.map{|id| association_count_key(id, attribute_name, version)})
+
+          result = {}
+          ids.each do |id|
+            result[id] = raw_result[association_count_key(id, attribute_name, version)]&.to_i || default
+          end
+
+          result
+        end
+
         define_singleton_method "#{attr_name}_count_for" do |id|
           new({id: id}, without_protection: true).send("#{attr_name}_count")
         end
@@ -198,12 +236,7 @@ module CachedCounts
 
     def add_count_attribute_methods(attribute_name, key_getter, relation_getter, define_with, counted_class, options)
       expires_in = options.fetch :expires_in, 1.week
-      default_value_lambda = options.fetch :default_value_lambda, -> {0}
-      value_updater_lambda = options.fetch :value_updater_lambda, default_value_updater_lambda
-      # TODO: need a good strategy to figure this value out
-      # As a fallback value is used, we immediately fire the calculation for the real value
-      # Is it reasonable to wait as long as it takes to calcualte it? Is there an alternative?
-      fallback_expiry_seconds = expires_in
+      race_condition_fallback = options.fetch :race_condition_fallback, nil
 
       key_method = "#{attribute_name}_count_key"
 
@@ -213,23 +246,31 @@ module CachedCounts
         val = Rails.cache.fetch(
           send(key_method),
           expires_in: expires_in,
-          race_condition_ttl: fallback_expiry_seconds,
+          race_condition_ttl: 30.seconds,
           raw: true # Necessary for incrementing to work correctly
         ) do
-          # Write down the default value first so subsequent reads don't repeat calculations
-          # TODO: multiple requests can potentially get to this point and start multiple update operations? Is that a problem?
-          default_value = instance_exec &default_value_lambda
-          Rails.cache.write(
-            send(key_method),
-            default_value,
-            expires_in: fallback_expiry_seconds,
-            raw: true
-          )
+          if race_condition_fallback
+            # Ensure that other reads find something in the cache, but
+            # continue calculating here because the default is likely inaccurate.
+            fallback_value = instance_exec &race_condition_fallback
+            CachedCounts.logger.warn "Setting #{fallback_value} as race_condition_fallback for #{send(key_method)}"
+            Rails.cache.write(
+              send(key_method),
+              fallback_value.to_i,
+              expires_in: 30.seconds,
+              raw: true
+            )
+          end
+
           relation = instance_exec(&relation_getter)
           relation = relation.reorder('')
           relation.select_values = ['count(*)']
-          value_updater_lambda.call(counted_class, relation.to_sql, send(key_method), expires_in) || default_value
+
+          CachedCounts.query_context.call(counted_class) do
+            counted_class.connection.select_value(relation.to_sql).to_i
+          end
         end
+
         if val.is_a?(ActiveSupport::Cache::Entry)
           val.value.to_i
         else
@@ -251,22 +292,8 @@ module CachedCounts
       end
     end
 
-    def default_value_updater_lambda()
-      lambda { |counted_class, relation_sql, cache_key, expires_in|
-        conn = CachedCounts.connection_for(counted_class)
-        value = conn.select_value(relation_sql).to_i
-        Rails.cache.write(
-          cache_key,
-          value,
-          expires_in: expires_in,
-          raw: true
-        )
-        return value
-      }
-    end
-
     def add_counting_hooks(attribute_name, key_getter, counted_class, options)
-      increment_hook = "increment_#{attribute_name}_count"
+      increment_hook = "increment_#{attribute_name}_count".to_sym
       counted_class.send :define_method, increment_hook do
         if (key = instance_exec &key_getter)
           Rails.cache.increment(
@@ -277,7 +304,7 @@ module CachedCounts
         end
       end
 
-      decrement_hook = "decrement_#{attribute_name}_count"
+      decrement_hook = "decrement_#{attribute_name}_count".to_sym
       counted_class.send :define_method, decrement_hook do
         if (key = instance_exec &key_getter)
           Rails.cache.decrement(

data/lib/cached_counts/query_context.rb

@@ -0,0 +1,21 @@
+module CachedCounts
+  class << self
+    # Optional configuration: Set a proc which takes as arguments (1) the class
+    # we are counting and (2) the block that runs the count query. The
+    # `query_context` block must call the block that's passed as an argument.
+    #
+    # This is useful for replication, e.g.,
+    #
+    #     CachedCounts.query_context = proc do |klass, &run_query|
+    #       role = klass == User ? :reading : :writing
+    #       ActiveRecord::Base.connected_to(role: role) do
+    #         run_query.call
+    #       end
+    #     end
+    attr_writer :query_context
+
+    def query_context
+      @query_context ||= proc { |_klass, &block| block.call }
+    end
+  end
+end

data/lib/cached_counts/version.rb

@@ -1,3 +1,3 @@
 module CachedCounts
-  VERSION = "0.1.0"
+  VERSION = "0.5.0"
 end

data/spec/spec_helper.rb

@@ -3,7 +3,7 @@ require 'bundler/setup'
 require 'pry'
 require 'active_record'
 require 'rails'
-require 'active_support/cache/dalli_store'
+require 'active_support/cache/mem_cache_store'
 require 'cached_counts'
 
 ActiveRecord::Base.configurations = YAML::load_file('spec/database.yml')
@@ -13,7 +13,7 @@ if ActiveRecord::Base.respond_to?(:raise_in_transactional_callbacks)
   ActiveRecord::Base.raise_in_transactional_callbacks = true
 end
 
-Rails.cache = ActiveSupport::Cache::DalliStore.new("localhost")
+Rails.cache = ActiveSupport::Cache::MemCacheStore.new("localhost")
 
 RSpec.configure do |config|
   config.before(:each) do
@@ -25,13 +25,6 @@ end
 require_relative './fixtures.rb'
 require 'database_cleaner'
 
-if Rails.version.to_f < 5.0
-  require 'test_after_commit'
-end
-if Rails.version.to_f < 4.2
-  require 'after_commit_exception_notification'
-end
-
 RSpec.configure do |config|
   config.before(:suite) do
     DatabaseCleaner.strategy = :transaction

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: incrdecr_cached_counts
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.5.0
 platform: ruby
 authors:
 - David Judd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-06 00:00:00.000000000 Z
+date: 2021-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: dalli
   requirement: !ruby/object:Gem::Requirement
@@ -80,34 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: test_after_commit
-  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: after_commit_exception_notification
-  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
@@ -130,20 +102,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci-matrix.yml"
+- ".circleci/config.yml"
 - ".gitignore"
-- ".travis.yml"
 - ".yardopts"
 - Gemfile
 - MIT-LICENSE
 - README.rdoc
 - Rakefile
-- circle.yml
 - incrdecr_cached_counts.gemspec
 - lib/cached_counts.rb
-- lib/cached_counts/connection_for.rb
-- lib/cached_counts/dalli_check.rb
 - lib/cached_counts/logger.rb
+- lib/cached_counts/query_context.rb
 - lib/cached_counts/railtie.rb
 - lib/cached_counts/version.rb
 - spec/caches_count_of_spec.rb
@@ -174,10 +143,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A replacement for Rails' counter caches using memcached (via Dalli)
 test_files: []
-has_rdoc: 

data/.circleci-matrix.yml

@@ -1,8 +0,0 @@
-env:
-  - ACTIVERECORD_VERSION=4.2.6
-  - ACTIVERECORD_VERSION=4.1.15
-  - ACTIVERECORD_VERSION=4.0.13
-
-command:
-  - rm -f Gemfile.lock && ACTIVERECORD_VERSION=$ACTIVERECORD_VERSION bundle
-  - bundle exec rake

data/.travis.yml

@@ -1,15 +0,0 @@
-sudo: false # use newer travis infrastructure
-language: ruby
-rvm:
-  - "2.1.8"
-  - "2.2.4"
-  - "2.3.0"
-env:
-  - "ACTIVERECORD_VERSION=4.2.6"
-  - "ACTIVERECORD_VERSION=4.1.15"
-  - "ACTIVERECORD_VERSION=4.0.13"
-  - "ACTIVERECORD_VERSION=master"
-matrix:
-  allow_failures:
-    # Master may or may not pass
-    - env: "ACTIVERECORD_VERSION=master"

data/circle.yml

@@ -1,10 +0,0 @@
-machine:
-  ruby:
-    version: 2.2.3
-
-dependencies:
-  pre:
-    - curl -fsSL https://git.io/v2Ifn | bash
-
-database:
-  override:

data/lib/cached_counts/connection_for.rb

@@ -1,14 +0,0 @@
-module CachedCounts
-  class << self
-    # Optional configuration: set a proc which takes the class we are counting
-    # and returns a connection. Useful with replication, e.g. with Octopus:
-    #
-    # `CachedCounts.connection_for = proc { |klass| klass.using(:read_slave).connection }`
-    attr_writer :connection_for
-
-    def connection_for(counted_class)
-      @connection_for ||= proc { |klass| klass.connection }
-      @connection_for[counted_class]
-    end
-  end
-end

data/lib/cached_counts/dalli_check.rb

@@ -1,5 +0,0 @@
-if defined?(Rails)
-  ActiveSupport.on_load :cached_counts do
-    raise "CachedCounts depends on Dalli!" unless Rails.cache.respond_to?(:dalli)
-  end
-end