identity_cache 0.4.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1fa182ed254be40433e84f2bdef8faf341581e5f
-  data.tar.gz: b795a7e03b4cf94a9d5ff3fd77e04186cde84d5c
+SHA256:
+  metadata.gz: 5196973719eb77354c40188d33d291b31ac94b23311bd78ba263e1e9c973e1f1
+  data.tar.gz: ce1be3c774f20c56b288272b9d30ce4abcb93d60536dedb1a232b566de92e3df
 SHA512:
-  metadata.gz: 51c4645eb6a548c720444d6964412576bf9c84a399ad1a100251953d24f7e114654170eb4ae3111c906fedd1d9f0555c1c3c2734904675383f84f9ee62fe3362
-  data.tar.gz: fabf846eb3ac2d9ccd9eda7f11dc3e42ed64ac5b678863fd1755e066bc04fc77cc46c4cf9eade1149da4a7fa244c28a45a62fdd4c798501a0b3764ded56d697f
+  metadata.gz: 4e1bfc8ec934bedf3ea3c451b87b903b8c373c033ab062535cd1e2abcb75cf0da508887440e1d5024a492ea9cb6f34e26aac5b18c53a9a21af96c072bbbaf7fe
+  data.tar.gz: e3105dbebe6f2da6f25e13f05a45edd53182bbe8058ac8dbdfe800a6981d765bf7cbefb7a27caa4c21966c23a6630df0994f7f308dac70f61a35f43c801a7430

data/.github/probots.yml

@@ -0,0 +1,2 @@
+enabled:
+  - cla

data/.github/workflows/ci.yml

@@ -0,0 +1,92 @@
+name: CI
+
+on:
+  push: {}
+  pull_request:
+    types: [opened, synchronize]
+
+jobs:
+  build:
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.owner.login != 'Shopify'
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        entry:
+          - name: 'Minimum supported'
+            ruby: 2.5
+            gemfile: "Gemfile.min-supported"
+          - name: 'Latest released & run rubocop'
+            ruby: 2.7
+            gemfile: "Gemfile.latest-release"
+            rubocop: true
+          - name: 'Rails edge'
+            ruby: 2.7
+            gemfile: "Gemfile.rails-edge"
+            edge: true
+
+    name: ${{ matrix.entry.name }}
+
+    continue-on-error: ${{ matrix.entry.edge || false }}
+
+    env:
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.entry.gemfile }}
+
+    services:
+      memcached:
+        image: memcached
+        ports:
+          - 11211:11211
+      mysql:
+        image: mysql:5.7
+        env:
+          MYSQL_ALLOW_EMPTY_PASSWORD: yes
+          MYSQL_DATABASE: identity_cache_test
+        options: >-
+          --health-cmd="mysqladmin ping"
+          --health-interval=10s
+          --health-timeout=5s
+          --health-retries=5
+        ports:
+          - 3306:3306
+      postgres:
+        image: postgres
+        env:
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: identity_cache_test
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+
+    steps:
+    - name: Install required packages
+      run: |
+        sudo apt-get update
+        sudo apt-get -y install libmemcached-dev libmysqlclient-dev libpq-dev libsasl2-dev
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.entry.ruby }}
+    - name: Install bundler and gems
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+    - name: Test with mysql
+      env:
+        DB: mysql2
+      run: bundle exec rake test
+    - name: Test with postgres and memcached_store
+      env:
+        DB: postgresql
+        POSTGRES_PASSWORD: postgres
+        ADAPTER: memcached
+      run: bundle exec rake test
+    - name: Run rubocop
+      if: matrix.entry.rubocop
+      run: bundle exec rubocop

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.rubocop-http*
+.byebug_history

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_from:
+  - https://shopify.github.io/ruby-style-guide/rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.4

data/CAVEATS.md

@@ -0,0 +1,25 @@
+While IdentityCache allows to massively scale access to ActiveRecord objects, it's important to note what problems might arise with it over time and what are things that it's not solving in the current design.
+
+## Large blobs
+
+For [god objects](https://en.wikipedia.org/wiki/God_object) (like the Shop model at Shopify), it’s typical to have many associations. It’s appealing for developers to embed many of those associations into the god model’s IDC blob, such as `cache_has_many :images, embed: true`. As a side effect, over time, the god model’s IDC blob may grow very large. It gets even worse when some of the embedded records get larger themselves, and the total IDC blob gets into as much as a megabyte in size. This puts pressure on both the application, memcached, and the network fibre because this large blob needs to be serialized and unserialized each time and transferred over the network.
+
+If the cache blob gets larger than the maximum cache value in memcached, then the cache fill would always fail, causing it to have to load all that data from the database each time.
+
+### Overfetching
+
+There's currently no way to retrieve/fill the cache with a subset of a model's associations. So, for models with many embedded associations, every `Model.fetch` would result in fetching all of the blob over the network and unserializing all embedded records, even if the client has only accessed one of those associations. That's a lot of useless CPU cycles and IO operations that happen on each access. It will also increase the network and memory bandwidth used on both the client and the server.
+
+Another possible issue is that cache invalidations for a model can be amplified by the number of models that embed them. This can further aggravate the large cache blob problem by embedding an association that gets invalidated more frequently.
+
+## Hot keys
+
+To scale out memcache, it’s typical to arrange memcached instances in rings. Most memcache clients/proxies use [consistent hashing](https://github.com/facebook/mcrouter/wiki/Pools#hash-functions) to route the operation to one of the instances in the ring. This means that an IDC entry will always end up in the same memcached instance.
+
+If the key associated with a record is on a hot codepath, that memcached instance will possibly experience saturation on the network and the number of bytes that it can send out. In cloud environments, this is a limit that is easy to hit. This especially aggravates the server-side large blob problem.
+
+## Thundering herd
+
+When a record gets updated, its IDC entry in memcache is expired, and it only gets populated the next time it is accessed. When many clients request the same key concurrently (e.g. on a hot codepath), they all find out that the IDC entry is missing at the same, and hence they will all go to the database to fill the IDC key at the same time. The massive number of clients hitting the DB will create a [thundering herd problem](https://en.wikipedia.org/wiki/Thundering_herd_problem) and overload the DB.
+
+Check out https://github.com/Shopify/identity_cache/pull/373 for more context and for the proposed solution for this problem.

data/CHANGELOG.md

@@ -1,6 +1,60 @@
-# IdentityCache changelog
+# Identity Cache Changelog
 
-#### 0.4.1
+## 1.1.0
+
+### Fixes
+- Fix double debug logging of cache hits and misses (#474)
+- Fix a Rails 6.1 deprecation warning for Rails 7.0 compatibility (#482)
+- Recursively install parent expiry hooks when expiring parent caches (#476)
+- Expire caches before other `after_commit` callbacks (#471)
+- Avoid unnecessary record cache expiry on save with no DB update (#464)
+- Fix an Active Record deprecation warning by not using `Connection#type_cast` (#459)
+- Fix broken `prefetch_associations` of a polymorphic `cache_belongs_to` (#461)
+- Fix `should_use_cache?` check to avoid calling it on the wrong class (#454)
+- Fix fetch `has_many` embedded association on record after adding to it (#449)
+
+### Features
+- Support multiple databases and transactional tests in `IdentityCache.should_use_cache?` (#293)
+- Add support for the default `MemCacheStore` from `ActiveSupport` (#465)
+
+### Breaking Changes
+- Drop ruby 2.4 support, since it is no longer supported upstream (#468)
+
+## 1.0.1
+
+- Fix expiry of cache_has_one association with scope and `embed: :id` (#442)
+
+## 1.0.0
+
+- Remove inverse_name option. Specify inverse_of on the Active Record association instead. (#439)
+- Bump the minimum Active Record version to 5.2 (#438)
+- Remove the default embed option value from cache_has_one (#437)
+- Lazily evaluate nested includes to fetch blobs in batches (#427)
+- Only cache embedded association IDs when present (#397)
+- Add support for ID embedded `has_one` cached associations (#393)
+- Add support for polymorphic `belongs_to` cached associations (#387)
+- Add `fetch_multi_by_*` support for cache_index with a single field (#368)
+- Remove support for rails 4.2 (#355)
+- Type cast values using attribute types before using in cache key (#354)
+- Set inverse cached association for cache_has_one on cache hit (#345)
+- Use `ActiveSupport:Notifications` to notify subscribers of hydration events (#341)
+- Remove disable_primary_cache_index (#335)
+- Remove deprecated `embed: false` cache_has_many option (#335)
+- Fix column name in the preload association query when using custom primary keys (#338)
+- Raise when trying to cache a belong_to association with a scope. Previously the scope was ignored on a cache hit (#323)
+- Remove deprecated `never_set_inverse_association` option (#319)
+- Lazy load associated classes (#306)
+
+## 0.5.1
+
+- Fix bug in prefetch_associations for cache_has_one associations that may be nil
+
+## 0.5.0
+
+- `never_set_inverse_association` and `fetch_read_only_records` are now `true` by default (#315)
+- Store the class name instead of the class itself (#311)
+
+## 0.4.1
 
 - Deprecated embedded associations on models that don't use IDC (#305)
 - Remove a respond_to? check that hides mistakes in includes hash (#307)
@@ -11,11 +65,11 @@
 - Clone instead of dup record when readonlyifying fetched records (#292)
 - Consistently store the array for cached has many associations (#288)
 
-#### 0.4.0
+## 0.4.0
 
 - Return an array from fetched association to prevent chaining. Up to now, a relation was returned by default. (#287)
 
-#### 0.3.2
+## 0.3.2
 
 - Deprecate returning non read-only records when cache is used. Set IdentityCache.fetch_readonly_records to true to avoid this. (#282)
 - Use loaded association first when fetching a cache_has_many id embedded association (#280)
@@ -23,11 +77,11 @@
 - Fetch association returns relation or array depending on the configuration. It was only returning a relation for cache_has_many fetch association methods. (#276)
 - Stop sharing the same attributes hash between the fetched record and the memoized cache, which could interfere with dirty tracking (#267)
 
-#### 0.3.1
+## 0.3.1
 
 - Fix cache_index for non-id primary key
 
-#### 0.3.0
+## 0.3.0
 
 - Add support for includes option on cache_index and fetch_by_id
 - Use ActiveRecord instantiate
@@ -40,37 +94,37 @@
 - Fix cache_belongs_to on polymorphic assocations.
 - Fetching a cache_belongs_to association no longer loads the belongs_to association
 
-#### 0.2.5
+## 0.2.5
 
 - Fixed support for namespaced model classes
 - Added some deduplication for parent cache expiry
 - Fixed some deprecation warnings in rails 4.2
 
-#### 0.2.4
+## 0.2.4
 
 - Refactoring, documentation and test changes
 
-#### 0.2.3
+## 0.2.3
 
 - PostgreSQL support
 - Rails 4.2 compatibility
 - Fix: Don't connect to database when calling `IdentityCache.should_use_cache?`
 - Fix: Fix invalid parent cache invalidation if object is embedded in different parents
 
-#### 0.2.2
+## 0.2.2
 
 - Change: memcached is no longer a runtime dependency
 - Use cache for read-only models.
 
-#### 0.2.1
+## 0.2.1
 
 - Add a fallback backend using local memory.
 
-#### 0.2.0
+## 0.2.0
 
 - Memcache CAS support
 
-#### 0.1.0
+## 0.1.0
 
 - Backwards incompatible change: Stop expiring cache on after_touch callback.
 - Change: fetch_multi accepts an array of keys as argument
@@ -81,29 +135,29 @@
 - Fix: Avoid unused preload on fetch_multi with :includes option for cache miss
 - Fix: reload will invalidate the local instance cache
 
-#### 0.0.7
+## 0.0.7
 
 - Add support for non-integer primary keys
 - Fix: Not implemented error for cache_has_one with embed: false
 - Fix: cache key to change when adding a cache_has_many association with :embed => false
 - Fix: Compatibility rails 4.1 for `quote_value`, which needs default column.
 
-#### 0.0.6
+## 0.0.6
 
 - Fix: bug where previously nil-cached attribute caches weren't expired on record creation
 - Fix: cache key to not change when adding a non-embedded association.
 - Perf: Rails 4 Only create `CollectionProxy` when using it
 
-#### 0.0.5
+## 0.0.5
 
 
-#### 0.0.4
+## 0.0.4
 
 - Fix: only marshal attributes, embedded associations and normalized association IDs
 - Add cache version number to cache keys
 - Add test case to ensure version number is updated when the marshalled format changes
 
-#### 0.0.3
+## 0.0.3
 
 - Fix: memoization for multi hits actually work
 - Fix: quotes `SELECT` projection elements on cache misses
@@ -111,7 +165,7 @@
 - Fix: table names are not hardcoded anymore
 - Logger now differentiates memoized vs non memoized hits
 
-#### 0.0.2
+## 0.0.2
 
 - Fix: Existent embedded entries will no longer raise when `ActiveModel::MissingAttributeError` when accessing a newly created attribute.
 - Fix: Do not marshal raw ActiveRecord associations

data/Gemfile

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 gemspec
 
-gem 'mysql2', '~> 0.3.13'
+gem 'mysql2', '~> 0.5.3'
+gem 'pg', ">= 0.18", "< 2.0"
+gem 'rubocop', '~> 1.5'
+gem 'byebug', platform: :mri

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Shopify
+Copyright (c) 2013-2021 Shopify
 
 MIT License
 

data/README.md

@@ -12,6 +12,10 @@ Add this line to your application's Gemfile:
 ```ruby
 gem 'identity_cache'
 gem 'cityhash'        # optional, for faster hashing (C-Ruby only)
+
+gem 'dalli' # To use :mem_cache_store
+# alternatively
+gem 'memcached_store' # to use the old libmemcached based client
 ```
 
 And then execute:
@@ -21,8 +25,30 @@ And then execute:
 
 Add the following to all your environment/*.rb files (production/development/test):
 
+### If you use Dalli (recommended)
+
+```ruby
+config.identity_cache_store = :mem_cache_store, "mem1.server.com", "mem2.server.com", {
+  expires_in: 6.hours.to_i, # in case of network errors when sending a delete
+  failover: false, # avoids more cache consistency issues
+}
+```
+
+Add an initializer with this code:
+
+```ruby
+IdentityCache.cache_backend = ActiveSupport::Cache.lookup_store(*Rails.configuration.identity_cache_store)
+```
+
+
+### If you use Memcached (old client)
+
 ```ruby
-config.identity_cache_store = :mem_cache_store, Memcached::Rails.new(:servers => ["mem1.server.com"])
+config.identity_cache_store = :memcached_store,
+  Memcached.new(["mem1.server.com"],
+    support_cas: true,
+    auto_eject_hosts: false,  # avoids more cache consistency issues
+  ), { expires_in: 6.hours.to_i } # in case of network errors when sending a delete
 ```
 
 Add an initializer with this code:
@@ -45,10 +71,10 @@ class Product < ActiveRecord::Base
 
   has_many :images
 
-  cache_has_many :images, :embed => true
+  cache_has_many :images, embed: true
 end
 
-# Fetch the product by its id using the primary primary index as well as the embedded images association.
+# Fetch the product by its id using the primary index as well as the embedded images association.
 @product = Product.fetch(id)
 
 # Access the loaded images for the Product.
@@ -64,7 +90,7 @@ IdentityCache lets you lookup records by fields other than `id`. You can have mu
 ``` ruby
 class Product < ActiveRecord::Base
   include IdentityCache
-  cache_index :handle, :unique => true
+  cache_index :handle, unique: true
   cache_index :vendor, :product_type
 end
 
@@ -72,6 +98,9 @@ end
 # If the object isn't in the cache it is pulled from the db and stored in the cache.
 product = Product.fetch_by_handle(handle)
 
+# Fetch multiple products by providing an array of index values.
+products = Product.fetch_multi_by_handle(handles)
+
 products = Product.fetch_by_vendor_and_product_type(vendor, product_type)
 ```
 
@@ -98,7 +127,7 @@ class Product < ActiveRecord::Base
   has_one   :featured_image
 
   cache_has_many :images
-  cache_has_one :featured_image
+  cache_has_one :featured_image, embed: :id
 end
 
 @product.fetch_featured_image
@@ -112,7 +141,7 @@ class Product < ActiveRecord::Base
   include IdentityCache
 end
 
-@product.fetch_multi([1, 2])
+Product.fetch_multi([1, 2])
 ```
 
 ### Embedding Associations
@@ -124,7 +153,7 @@ class Product < ActiveRecord::Base
   include IdentityCache
 
   has_many :images
-  cache_has_many :images, :embed => true
+  cache_has_many :images, embed: true
 end
 
 @product = Product.fetch(id)
@@ -135,32 +164,29 @@ With this code, on cache miss, the product and its associated images will be loa
 
 ### Caching Polymorphic Associations
 
-IdentityCache tries to figure out both sides of an association whenever it can so it can set those up when rebuilding the object from the cache. In some cases this is hard to determine so you can tell IdentityCache what the association should be. This is most often the case when embedding polymorphic associations. The `inverse_name` option on `cache_has_many` and `cache_has_one` lets you specify the inverse name of the association.
+IdentityCache tries to figure out both sides of an association whenever it can so it can set those up when rebuilding the object from the cache. In some cases this is hard to determine so you can tell IdentityCache what the association should be. This is most often the case when embedding polymorphic associations.
 
 ``` ruby
 class Metafield < ActiveRecord::Base
   include IdentityCache
-  belongs_to :owner, :polymorphic => true
+  belongs_to :owner, polymorphic: true
   cache_belongs_to :owner
 end
 
 class Product < ActiveRecord::Base
   include IdentityCache
-  has_many :metafields, :as => 'owner'
-  cache_has_many :metafields, :inverse_name => :owner
+  has_many :metafields, as: :owner
+  cache_has_many :metafields
 end
 ```
 
-The `:inverse_name => :owner` option tells IdentityCache what the association on the other side is named so that it can correctly set the assocation when loading the metafields from the cache.
-
-
 ### Caching Attributes
 
 For cases where you may not need the entire object to be cached, just an attribute from record, `cache_attribute` can be used. This will cache the single attribute by the key specified.
 
 ``` ruby
 class Redirect < ActiveRecord::Base
-  cache_attribute :target, :by => [:shop_id, :path]
+  cache_attribute :target, by: [:shop_id, :path]
 end
 
 Redirect.fetch_target_by_shop_id_and_path(shop_id, path)
@@ -182,22 +208,18 @@ Example:
 #### cache_has_many
 
 Options:
-_[:embed]_ When true, specifies that the association should be included with the parent when caching. This means the associated objects will be loaded already when the parent is loaded from the cache and will not need to be fetched on their own. When :ids, only the id of the associated records will be included with the parent when caching.
-
-_[:inverse_name]_ Specifies the name of parent object used by the association. This is useful for polymorphic associations when the association is often named something different between the parent and child objects.
+_[:embed]_ When true, specifies that the association should be included with the parent when caching. This means the associated objects will be loaded already when the parent is loaded from the cache and will not need to be fetched on their own. When :ids, only the id of the associated records will be included with the parent when caching. Defaults to `:ids`.
 
 Example:
-`cache_has_many :metafields, :inverse_name => :owner, :embed => true`
+`cache_has_many :metafields, embed: true`
 
 #### cache_has_one
 
 Options:
-_[:embed]_ When true, specifies that the association should be included with the parent when caching. This means the associated objects will be loaded already when the parent is loaded from the cache and will not need to be fetched on their own. No other values are currently implemented.
-
-_[:inverse_name]_ Specifies the name of parent object used by the association. This is useful for polymorphic associations when the association is often named something different between the parent and child objects.
+_[:embed]_ When true, specifies that the association should be included with the parent when caching. This means the associated objects will be loaded already when the parent is loaded from the cache and will not need to be fetched on their own. No other values are currently implemented. When :id, only the id of the associated record will be included with the parent when caching.
 
 Example:
-`cache_has_one :configuration, :embed => true`
+`cache_has_one :configuration, embed: :id`
 
 #### cache_belongs_to
 
@@ -210,7 +232,7 @@ Options:
 _[:by]_ Specifies what key(s) you want the attribute cached by. Defaults to :id.
 
 Example:
-`cache_attribute :target, :by => [:shop_id, :path]`
+`cache_attribute :target, by: [:shop_id, :path]`
 
 ## Memoized Cache Proxy
 
@@ -220,8 +242,8 @@ Cache reads and writes can be memoized for a block of code to serve duplicate id
 class ApplicationController < ActionController::Base
   around_filter :identity_cache_memoization
 
-  def identity_cache_memoization
-    IdentityCache.cache.with_memoization{ yield }
+  def identity_cache_memoization(&block)
+    IdentityCache.cache.with_memoization(&block)
   end
 end
 ```
@@ -236,7 +258,7 @@ A word of warning. Some versions of rails will silently rescue all exceptions in
 
 Since everything is being marshalled and unmarshalled from Memcached changing Ruby or Rails versions could mean your objects cannot be unmarshalled from Memcached. There are a number of ways to get around this such as namespacing keys when you upgrade or rescuing marshal load errors and treating it as a cache miss. Just something to be aware of if you are using IdentityCache and upgrade Ruby or Rails.
 
-IdentityCache is also very much _opt-in_ by deliberate design. This means IdentityCache does not mess with the way normal Rails associations work, and including it in a model won't change any clients of that model until you switch them to use `fetch` instead of `find`. This is because there is no way IdentityCache is ever going to be 100% consistent. Processes die, execeptions happen, and network blips occur, which means there is a chance that some database transaction might commit but the corresponding memcached DEL operation does not make it. This means that you need to think carefully about when you use `fetch` and when you use `find`. For example, at Shopify, we never use any `fetch`ers on the path which moves money around, because IdentityCache could simply be wrong, and we want to charge people the right amount of money. We do however use the fetchers on performance critical paths where absolute correctness isn't the most important thing, and this is what IdentityCache is intended for.
+IdentityCache is also very much _opt-in_ by deliberate design. This means IdentityCache does not mess with the way normal Rails associations work, and including it in a model won't change any clients of that model until you switch them to use `fetch` instead of `find`. This is because there is no way IdentityCache is ever going to be 100% consistent. Processes die, exceptions happen, and network blips occur, which means there is a chance that some database transaction might commit but the corresponding memcached DEL operation does not make it. This means that you need to think carefully about when you use `fetch` and when you use `find`. For example, at Shopify, we never use any `fetch`ers on the path which moves money around, because IdentityCache could simply be wrong, and we want to charge people the right amount of money. We do however use the fetchers on performance critical paths where absolute correctness isn't the most important thing, and this is what IdentityCache is intended for.
 
 ## Notes