kasket 4.8.0 → 4.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5cec0e5e944a74b977fd8e8113983160e1a5075eade70a499e6b16863abfde6
-  data.tar.gz: d9ee5a1d6a974e998191ad656b4b962b5a7ea74e0327be3944813790bf6e7e8c
+  metadata.gz: 5b7ff0fe3b5afa5c01eb36fc7f89bfe94669b98340bb1537546fe6019b0d61db
+  data.tar.gz: d69c8e0d2f9303456f5f647867a67496b49d95e8af114f51ec54acf95947d257
 SHA512:
-  metadata.gz: 9aca01c0f69b403d2476b5db05b610604899f2a38f450b0c29d8f19b60f5f2e3e67777c172690672ae83a1a4ce14e316c85175989d5dd4df826afdbf6b8e530c
-  data.tar.gz: 1645f52ca823c5c628d9fa5c1aba45393feffc9ac3f0c0e70e1552582bd55de79df20f8870f72deca67d8e0faae036d5fc5d1fa67b7be80dcf836d86808b7c68
+  metadata.gz: 610b4879bebfdd27f4796ce840aac305d30502702befab16623f8c1e7bd316dd7529ab5af4513d05e565b25cb716089e7b71ed34aad8c75099bf5493137c3e31
+  data.tar.gz: b6710e8aa232d3105822aec11431a8d3c76618c7d124e3e1773528c3decc3de57617ffa17f6a60425729e694a4cde8e281d74ed0bd7e88fcd3b34e371cae245b

data/README.md

@@ -1,4 +1,4 @@
-# Kasket [![Build status](https://circleci.com/gh/zendesk/kasket.svg?style=svg)](https://circleci.com/gh/zendesk/kasket)
+# Kasket
 
 ### Puts a cap on your queries
 A caching layer for ActiveRecord (3.x and 4.x)

data/lib/kasket/query_parser.rb

@@ -6,32 +6,49 @@ module Kasket
     # SELECT * FROM `users` WHERE (`users`.`id` = 2) LIMIT 1
     # 'SELECT * FROM \'posts\' WHERE (\'posts\'.\'id\' = 574019247) '
 
-    AND = /\s+AND\s+/i
-    VALUE = /'?(\d+|\?|(?:(?:[^']|''|\\')*))'?/ # Matches: 123, ?, '123', '12''3'
+    AND = /\s+AND\s+/i.freeze
+    VALUE = /'?(\d+|\?|(?:(?:[^']|''|\\')*))'?/.freeze # Matches: 123, ?, '123', '12''3'
 
     def initialize(model_class)
       @model_class = model_class
 
-      @supported_query_pattern = /^select\s+((?:`|")#{@model_class.table_name}(?:`|")\.)?\* from (?:`|")#{@model_class.table_name}(?:`|") where (.*?)(|\s+limit 1)\s*$/i
+      @supported_query_pattern = /^select\s+(.+?)\s+from (?:`|")#{@model_class.table_name}(?:`|") where (.*?)(|\s+limit 1)\s*$/i
 
+      @star_pattern = /^((`|")#{@model_class.table_name}\2\.)?\*$/
       # Matches: `users`.id, `users`.`id`, users.id, id
       @table_and_column_pattern = /(?:(?:`|")?#{@model_class.table_name}(?:`|")?\.)?(?:`|")?([a-zA-Z]\w*)(?:`|")?/
       # Matches: KEY = VALUE, (KEY = VALUE), ()(KEY = VALUE))
       @key_eq_value_pattern = /^[\(\s]*#{@table_and_column_pattern}\s+(=|IN)\s+#{VALUE}[\)\s]*$/
     end
 
+    ##
+    # Parses a SQL query to produce a kasket query
+    #
+    # @param sql [String] the sql query to parse
+    # @return [Hash|nil] the kasket query, or nil if the sql query is not supported
     def parse(sql)
       if match = @supported_query_pattern.match(sql)
+        select = match[1]
+        unless @star_pattern.match? select
+          # If we're not selecting all columns using star, then ensure all columns are selected explicitly
+          select_columns = select.split(/\s*,\s*/).map do |s|
+            break unless column_match = @table_and_column_pattern.match(s)
+
+            column_match[1]
+          end.uniq
+          columns = @model_class.column_names
+          return unless columns.size == select_columns.size && (columns - select_columns).empty?
+        end
         where = match[2]
         limit = match[3]
 
         query = {}
         query[:attributes] = sorted_attribute_value_pairs(where)
-        return nil if query[:attributes].nil?
+        return if query[:attributes].nil?
 
-        if query[:attributes].size > 1 && query[:attributes].map(&:last).any? {|a| a.is_a?(Array)}
+        if query[:attributes].size > 1 && query[:attributes].map(&:last).any?(Array)
           # this is a query with IN conditions AND other conditions
-          return nil
+          return
         end
 
         query[:index] = query[:attributes].map(&:first)

data/lib/kasket/read_mixin.rb

@@ -8,6 +8,7 @@ module Kasket
       end
     end
 
+    # *args can be replaced with (sql, *args) once we stop supporting Rails < 5.2
     def find_by_sql_with_kasket(*args)
       sql = args[0]
 
@@ -32,11 +33,27 @@ module Kasket
           find_by_sql_with_kasket_on_id_array(query[:key])
         else
           if value = Kasket.cache.read(query[:key])
-            if value.is_a?(Array)
+            # Identified a specific edge case where memcached server returns 0x00 binary protocol response with no data
+            # when the node is being rebooted which causes the Dalli memcached client to return a TrueClass object instead of nil
+            # see: https://github.com/petergoldstein/dalli/blob/31dabf19d3dd94b348a00a59fe5a7b8fa80ce3ad/lib/dalli/server.rb#L520
+            # and: https://github.com/petergoldstein/dalli/issues/390
+            #
+            # The code in this first condition of TrueClass === true  will
+            # skip the kasket cache for these specific objects and go directly to SQL for retrieval.
+            result_set = if value.is_a?(TrueClass)
+              find_by_sql_without_kasket(*args)
+            elsif value.is_a?(Array)
               filter_pending_records(find_by_sql_with_kasket_on_id_array(value))
             else
               filter_pending_records(Array.wrap(value).collect { |record| instantiate(record.dup) })
             end
+
+            payload = {
+              record_count: result_set.length,
+              class_name: to_s
+            }
+
+            ActiveSupport::Notifications.instrument('instantiation.active_record', payload) { result_set }
           else
             store_in_kasket(query[:key], find_by_sql_without_kasket(*args))
           end
@@ -80,7 +97,7 @@ module Kasket
       if records.size == 1
         records.first.store_in_kasket(key)
       elsif records.empty?
-        ActiveRecord::Base.logger.info("[KASKET] would have stored an empty resultset") if ActiveRecord::Base.logger
+        ActiveRecord::Base.logger.debug("[KASKET] would have stored an empty resultset") if ActiveRecord::Base.logger
       elsif records.size <= Kasket::CONFIGURATION[:max_collection_size]
         if records.all?(&:kasket_cacheable?)
           instance_keys = records.map(&:store_in_kasket)

data/lib/kasket/relation_mixin.rb

@@ -1,16 +1,19 @@
 # frozen_string_literal: true
 module Kasket
   module RelationMixin
+    # binds can be removed when support for Rails < 5 is removed
     def to_kasket_query(binds = nil)
       if arel.is_a?(Arel::SelectManager)
         if ActiveRecord::VERSION::MAJOR < 5
           arel.to_kasket_query(klass, (binds || bind_values))
-        else
+        elsif ActiveRecord::VERSION::STRING < '5.2'
           arel.to_kasket_query(klass, (@values[:where].to_h.values + Array(@values[:limit])))
+        else
+          arel.to_kasket_query(klass)
         end
       end
     rescue TypeError # unsupported object in ast
-      return nil
+      nil
     end
   end
 end

data/lib/kasket/select_manager_mixin.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 module Kasket
   module SelectManagerMixin
+    # binds can be removed once we stop supporting Rails < 5.2
     def to_kasket_query(klass, binds = [])
       begin
         query = Kasket::Visitor.new(klass, binds).accept(ast)

data/lib/kasket/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module Kasket
-  VERSION = '4.8.0'
+  VERSION = '4.10.0'
   class Version
     MAJOR = Kasket::VERSION.split('.')[0]
     MINOR = Kasket::VERSION.split('.')[1]

data/lib/kasket/visitor.rb

@@ -3,6 +3,7 @@ require 'arel'
 
 module Kasket
   class Visitor < Arel::Visitors::Visitor
+    # binds can be removed once we stop supporting Rails < 5.2
     def initialize(model_class, binds)
       @model_class = model_class
       @binds       = binds.dup
@@ -51,11 +52,18 @@ module Kasket
       return :unsupported if ActiveRecord::VERSION::MAJOR < 5 ? node.having : node.havings.present?
       return :unsupported if node.set_quantifier
       return :unsupported if !node.source || node.source.empty?
-      return :unsupported if node.projections.size != 1
+      return :unsupported if node.projections.empty?
 
       select = node.projections[0]
       select = select.name if select.respond_to?(:name)
-      return :unsupported if select != '*'
+      if select != '*'
+        # If we're not selecting all columns using star, then ensure all columns are selected explicitly
+        column_names = @model_class.column_names
+        return :unsupported unless node.projections.size == column_names.size
+
+        projection_names = node.projections.map { |p| p.name if p.respond_to?(:name) }.compact
+        return unless (column_names - projection_names).empty?
+      end
 
       parts = [visit(node.source)]
 
@@ -75,6 +83,7 @@ module Kasket
     def visit_Arel_Nodes_JoinSource(node, *_)
       return :unsupported if !node.left || node.right.any?
       return :unsupported unless node.left.is_a?(Arel::Table)
+
       visit(node.left)
     end
 
@@ -85,6 +94,7 @@ module Kasket
     def visit_Arel_Nodes_And(node, *_)
       attributes = node.children.map { |child| visit(child) }
       return :unsupported if attributes.include?(:unsupported)
+
       attributes.sort! { |pair1, pair2| pair1[0].to_s <=> pair2[0].to_s }
       { attributes: attributes }
     end
@@ -112,8 +122,12 @@ module Kasket
     end
 
     def literal(node, *_)
-      if node == '?'
-        @binds.shift.last.to_s
+      if ActiveRecord::VERSION::STRING < '5.2'
+        if node == '?'
+          @binds.shift.last.to_s
+        else
+          node.to_s
+        end
       else
         node.to_s
       end
@@ -135,11 +149,13 @@ module Kasket
       node.map {|value| visit(value) }
     end
 
-    def visit_Arel_Nodes_Casted(node, *_)
-      case node.val
-      when nil    then nil
-      when String then node.val
-      else quoted(node.val)
+    if ActiveRecord::VERSION::STRING < '5.2'
+      def visit_Arel_Nodes_Casted(node, *_)
+        case node.val
+        when nil    then nil
+        when String then node.val
+        else quoted(node.val)
+        end
       end
     end
 

data/lib/kasket.rb

@@ -17,8 +17,8 @@ module Kasket
 
   CONFIGURATION = { # rubocop:disable Style/MutableConstant
     max_collection_size: 100,
-    write_through:       false,
-    default_expires_in:  nil
+    write_through: false,
+    default_expires_in: nil
   }
 
   module_function
@@ -33,8 +33,8 @@ module Kasket
     ActiveRecord::Base.extend(Kasket::ConfigurationMixin)
 
     if defined?(ActiveRecord::Relation)
-      ActiveRecord::Relation.send(:include, Kasket::RelationMixin)
-      Arel::SelectManager.send(:include, Kasket::SelectManagerMixin)
+      ActiveRecord::Relation.include Kasket::RelationMixin
+      Arel::SelectManager.include Kasket::SelectManagerMixin
     end
   end
 
@@ -42,10 +42,15 @@ module Kasket
     @cache_store = ActiveSupport::Cache.lookup_store(options)
   end
 
-  def self.cache
+  def self.cache_store
     @cache_store ||= Rails.cache
   end
 
+  # Alias cache_store to cache
+  class << self
+    alias_method :cache, :cache_store
+  end
+
   # Keys are the records being saved.
   # Values are either the saved record, or nil if the record has been destroyed.
   def self.pending_records

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: kasket
 version: !ruby/object:Gem::Version
-  version: 4.8.0
+  version: 4.10.0
 platform: ruby
 authors:
 - Mick Staugaard
 - Eric Chapweske
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-26 00:00:00.000000000 Z
+date: 2022-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -31,118 +31,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6.1'
-- !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: bundler
-  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: mocha
-  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: wwtd
-  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: bump
-  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: minitest
-  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: minitest-rg
-  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: timecop
-  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'
 description: puts a cap on your queries
 email:
 - mick@zendesk.com
@@ -165,7 +53,7 @@ homepage: http://github.com/zendesk/kasket
 licenses:
 - Apache License Version 2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -173,15 +61,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.0.3.1
+signing_key:
 specification_version: 4
 summary: A write back caching layer on active record
 test_files: []