ar_cache 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4d25cbd1abb845a90dbd29d50d1dfb5b622e454e6c0bfe4a1ae65b4eddb818f
-  data.tar.gz: 821f3036d2df0db1f143a3212cffacf306ac30aa2335385defde6b41edf5f46d
+  metadata.gz: 2d9f5ff76912fe1e2276c795f619cf2e1e88780e7592e7fcb659e55a75bd8aff
+  data.tar.gz: 51ccc09d008c7d345dc9901c2898463ef5d2ebd40649b829b63ba801b13948da
 SHA512:
-  metadata.gz: a0a9706501fa606ee7cf02931bdbfc5efd3e2668fb5b51c55b971d616233b43595363b30ccf279d500df64789268398c140870c8683b7e79e8b70717ebd2983a
-  data.tar.gz: 46e0a6c9a76401dec6d2f3c11f52e4e9a3e0d1b975c827df7eca05f0068612d78755238db00c5f170ab30523c5aee15eb6556b3956599490d0a812d4f8d917d5
+  metadata.gz: f8422672824015d7496620282919ff08b380066c8e05d8bde53bd8ef732f6b3a1c475f86bdd258f188be151fd78734b79bddbfa00bb20ce9b78be4443e96a168
+  data.tar.gz: 3059b104bf49417391e3edb84c5005822ba652b8c29bf8fd0de7c23080444fbd8345da5776a8bd0ba81b515845e567776c22b0a925c0235042c7383f4610cbc6

data/CHANGELOG.md

@@ -1,3 +1,9 @@
 # Change log
 
 ## main
+
+## 2.1.0 (2018-06-29 UTC)
+
+- [PR [#4](https://github.com/OuYangJinTing/ar_cache/pull/4)] Fix high concurrency causes write dirty cache ([@OuYangJinTing](https://github.com/OuYangJinTing))
+- [PR [#3](https://github.com/OuYangJinTing/ar_cache/pull/3)] Shouldn't open database transaction when use cache lock ([@OuYangJinTing](https://github.com/OuYangJinTing))
+- [PR [#2](https://github.com/OuYangJinTing/ar_cache/pull/2)] Use configuration template as default values ([@OuYangJinTing](https://github.com/OuYangJinTing))

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ar_cache (2.0.0)
+    ar_cache (2.1.0)
       activerecord (>= 6.1, < 7)
       oj (>= 3, < 4)
 

data/lib/ar_cache.rb

@@ -71,5 +71,11 @@ module ArCache
     def load_attributes(attributes)
       memcached? || redis? ? Oj.load(attributes) : attributes
     end
+
+    def lock_key(key)
+      ArCache.write(key, PLACEHOLDER, raw: true, expires_in: 1.hour)
+    end
   end
 end
+
+require_relative './generators/ar_cache/templates/configuration'

data/lib/ar_cache/active_record/connection_adapters/abstract/transaction.rb

@@ -14,7 +14,7 @@ module ArCache
 
         def handle_ar_cache_primary_keys(keys)
           if ArCache::Configuration.cache_lock?
-            keys.each { |k| ArCache.write(k, ArCache::PLACEHOLDER, raw: true, expires_in: 1.day) }
+            keys.each { |k| ArCache.lock_key(k) }
           else
             ArCache.delete_multi(keys)
           end

data/lib/ar_cache/configuration.rb

@@ -3,7 +3,7 @@
 module ArCache
   class Configuration
     class << self
-      attr_writer :cache_lock
+      attr_writer :cache_lock, :lock_statement
       attr_reader :cache_store, :tables_options
       attr_accessor :disabled, :select_disabled, :expires_in
 
@@ -46,6 +46,19 @@ module ArCache
         options[:unique_indexes] = Array(options[:unique_indexes]).map { |index| Array(index).map(&:to_s).uniq }.uniq
         options
       end
+
+      def lock_statement
+        @lock_statement ||= case ::ActiveRecord::Base.connection.class.name
+                            when 'ActiveRecord::ConnectionAdapters::PostgreSQLAdapter'
+                              'FOR SHARE'
+                            when 'ActiveRecord::ConnectionAdapters::Mysql2Adapter'
+                              'LOCK IN SHARE MODE'
+                            when 'ActiveRecord::ConnectionAdapters::SQLite3Adapter'
+                              raise "SQLite3 don't support lock statement, please use cache lock."
+                            else
+                              raise "Arcache can't identify database, please defined lock statement or use cache lock"
+                            end
+      end
     end
   end
 end

data/lib/ar_cache/marshal.rb

@@ -11,12 +11,19 @@ module ArCache
       ArCache.delete_multi(ids.map { |id| primary_cache_key(id) })
     end
 
-    def write(records)
+    def write(records) # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
       return -1 if disabled?
 
       records.each do |attributes|
         key = primary_cache_key(attributes[primary_key])
-        ArCache.write(key, dump_attributes(attributes), unless_exist: cache_lock?, raw: true, expires_in: expires_in)
+        stringify_attributes = dump_attributes(attributes)
+        bool = ArCache.write(key, stringify_attributes, unless_exist: cache_lock?, raw: true, expires_in: expires_in)
+        if cache_lock? && !bool
+          value = ArCache.read(key, raw: true)
+          next if value == ArCache::PLACEHOLDER
+          next ArCache.lock_key(key) if value != stringify_attributes
+        end
+
         unique_indexes.each_with_index do |index, i|
           # The first index is primary key, should skip it.
           ArCache.write(cache_key(attributes, index), key, raw: true, expires_in: expires_in) unless i.zero?
@@ -26,14 +33,15 @@ module ArCache
       0
     end
 
-    def read(where_clause, select_values = nil, &block) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
+    def read(where_clause, select_values = nil, &block) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
       entries_hash = ArCache.read_multi(*where_clause.cache_hash.keys, raw: true)
       where_clause.cache_hash.each_key do |k|
         v = entries_hash[k]
 
-        if v.nil?
+        case v
+        when nil
           where_clause.add_missed_values(k)
-        elsif v == ArCache::PLACEHOLDER
+        when ArCache::PLACEHOLDER
           where_clause.add_missed_values(k)
           where_clause.add_blank_primary_cache_key(k)
           entries_hash.delete(k)

data/lib/ar_cache/query.rb

@@ -2,9 +2,7 @@
 
 module ArCache
   class Query
-    @lock_statement = 'FOR SHARE'
-    singleton_class.attr_accessor :lock_statement
-    delegate :lock_statement, :lock_statement=, to: 'self.class'
+    delegate :lock_statement, :cache_lock?, to: ArCache::Configuration
 
     attr_reader :relation, :table, :where_clause
 
@@ -21,19 +19,16 @@ module ArCache
       records = table.read(where_clause, @select_values, &block)
 
       if where_clause.missed_hash.any?
-        begin
-          missed_relation = relation.rewhere(where_clause.missed_hash).reselect('*').lock(lock_statement)
-          missed_relation.arel.singleton_class.attr_accessor(:klass_and_select_values)
-          missed_relation.arel.klass_and_select_values = [relation.klass, @select_values]
+        missed_relation = relation.rewhere(where_clause.missed_hash).reselect('*')
+        missed_relation = missed_relation.lock(lock_statement) unless cache_lock?
+        missed_relation.arel.singleton_class.attr_accessor(:klass_and_select_values)
+        missed_relation.arel.klass_and_select_values = [relation.klass, @select_values]
+        if cache_lock?
+          records += missed_relation.find_by_sql(missed_relation.arel, &block)
+        else
           missed_relation.connection.transaction do
             records += missed_relation.find_by_sql(missed_relation.arel, &block)
           end
-        rescue ::ActiveRecord::StatementInvalid => e
-          raise e if relation.connection.class.name != 'ActiveRecord::ConnectionAdapters::Mysql2Adapter'
-          raise e if lock_statement == 'LOCK IN SHARE MODE'
-
-          self.lock_statement = 'LOCK IN SHARE MODE'
-          retry
         end
       end
 

data/lib/ar_cache/table.rb

@@ -64,7 +64,7 @@ module ArCache
       return '' if disabled?
 
       key = "#{identity_cache_key}:#{short_sha1}:#{Time.now.to_f}"
-      ArCache.write(identity_cache_key, key, raw: true, expires_in: 100.years)
+      ArCache.write(identity_cache_key, key, raw: true, expires_in: 20.years)
       key
     end
 

data/lib/ar_cache/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ArCache
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

data/lib/generators/ar_cache/templates/configuration.rb

@@ -2,26 +2,31 @@
 
 # For more information, please see: https://github.com/OuYangJinTing/ar_cache/README.md
 ArCache.configure do |config|
-  # NOTE: Please change true if database happened some problems
-  # Arcache default use database share lock to ensure that the cache is correct.
-  config.cache_lock = false # Boolean
-
-  # The cache tool.
+  # The cache tool. It must be an instance of ActiveSupport::Cache::Store.
   config.cache_store = defined?(Rails) ? Rails.cache : ActiveSupport::Cache::MemoryStore.new
 
+  # NOTE: Please use cache lock if it casue database happened dead lock.
+  # ArCache default use database share lock('FOR SHARE' or 'LOCK IN SHARE MODE') to ensure that the cache is correct.
+  # You can customize the lock statement, if your database don't support lock (eg: SQLite3), please use cache lock.
+  # config.lock_statement = 'custom lock statement'
+
+  # WARNING: If the cache store is not Redis nor Memcached, the cache lock may be unreliable.
+  config.cache_lock = false # Boolean
+
   # The cache key valid time.
   config.expires_in = 1.week # Integer
 
-  # ArCache switch.
+  # ArCache switch (default).
   config.disabled = false # Boolean
 
-  # Whether to support select column sql.
+  # Whether to support select column sql (default)..
   config.select_disabled = true # Boolean
 
+  # WARNING: If you use database lock, you should not custom unique index, otherwise may be happen lock table.
   config.tables_options = {
-    # table_name: {
-    #   disabled: Boolean,
-    #   select_disabled: Boolean,
+    # table_name: { # Database's table name.
+    #   disabled: Boolean, # sArCache switch.
+    #   select_disabled: Boolean, # Whether to support select column sql.
     #   unique_indexes: Array # eg: [:id, [:name, :statue]], The default is the unique index column of the table.
     # },
     # ...

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar_cache
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - OuYangJinTing
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-29 00:00:00.000000000 Z
+date: 2021-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord