identity_cache 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5196973719eb77354c40188d33d291b31ac94b23311bd78ba263e1e9c973e1f1
-  data.tar.gz: ce1be3c774f20c56b288272b9d30ce4abcb93d60536dedb1a232b566de92e3df
+  metadata.gz: 561965856845fc5d5094581d735584924eda58557edfb3831c39bce2498635aa
+  data.tar.gz: 33a85428a3b2a298076d81a79b662b742c00a25971bf453f8f57eeab7cba2681
 SHA512:
-  metadata.gz: 4e1bfc8ec934bedf3ea3c451b87b903b8c373c033ab062535cd1e2abcb75cf0da508887440e1d5024a492ea9cb6f34e26aac5b18c53a9a21af96c072bbbaf7fe
-  data.tar.gz: e3105dbebe6f2da6f25e13f05a45edd53182bbe8058ac8dbdfe800a6981d765bf7cbefb7a27caa4c21966c23a6630df0994f7f308dac70f61a35f43c801a7430
+  metadata.gz: 6a8c691d8883acfd69f11724dfff13a3ef4858a2abd2ca658659981f1d08b36dea244100c4030b8ef5d39ac8509e639fea6cd02127e09d157be636fcc2bee77a
+  data.tar.gz: e357c3a4f02a288a5ddb3290cbd11176937821bb3c9052fb318d9139ac253650f7018a8249b2ebc9f115015a6434baf7cb1b7e76bfb0dbf1e98ee745e3e95ed7

data/.github/workflows/ci.yml

@@ -12,17 +12,18 @@ jobs:
     runs-on: ubuntu-latest
 
     strategy:
+      fail-fast: false
       matrix:
         entry:
           - name: 'Minimum supported'
-            ruby: 2.5
+            ruby: '2.5'
             gemfile: "Gemfile.min-supported"
           - name: 'Latest released & run rubocop'
-            ruby: 2.7
+            ruby: '3.0'
             gemfile: "Gemfile.latest-release"
             rubocop: true
           - name: 'Rails edge'
-            ruby: 2.7
+            ruby: '3.0'
             gemfile: "Gemfile.rails-edge"
             edge: true
 
@@ -70,7 +71,7 @@ jobs:
         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
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.entry.ruby }}
     - name: Install bundler and gems

data/.github/workflows/cla.yml

@@ -0,0 +1,22 @@
+name: Contributor License Agreement (CLA)
+
+on:
+  pull_request_target:
+    types: [opened, synchronize]
+  issue_comment:
+    types: [created]
+
+jobs:
+  cla:
+    runs-on: ubuntu-latest
+    if: |
+      (github.event.issue.pull_request 
+        && !github.event.issue.pull_request.merged_at
+        && contains(github.event.comment.body, 'signed')
+      ) 
+      || (github.event.pull_request && !github.event.pull_request.merged)
+    steps:
+      - uses: Shopify/shopify-cla-action@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          cla-token: ${{ secrets.CLA_TOKEN }}

data/.rubocop.yml

@@ -1,5 +1,9 @@
-inherit_from:
-  - https://shopify.github.io/ruby-style-guide/rubocop.yml
+inherit_gem:
+  rubocop-shopify: rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
+  NewCops: disable
+
+Layout/BeginEndAlignment:
+  EnforcedStyleAlignWith: start_of_line

data/.spin/bootstrap

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+set -e
+
+sudo apt-get install -y libsasl2-dev libpq-dev
+mysql -u root -P "$MYSQL_PORT" -e 'create database identity_cache_test'
+bundle install

data/.spin/svc.yml

@@ -0,0 +1,2 @@
+- memcached
+- mysql

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Identity Cache Changelog
 
+## 1.2.0
+
+### Fixes
+- Fix mem_cache_store adapter with pool_size (#489)
+- Fix dalli deprecation warning about requiring 'dalli/cas/client' (#511)
+- Make transitionary method IdentityCache.with_fetch_read_only_records thread-safe (#503)
+
+### Features
+- Add support for fill lock with lock wait to avoid thundering herd problem (#373)
+
 ## 1.1.0
 
 ### Fixes

data/Gemfile

@@ -1,8 +1,18 @@
 # frozen_string_literal: true
-source 'https://rubygems.org'
+
+source "https://rubygems.org"
 gemspec
 
-gem 'mysql2', '~> 0.5.3'
-gem 'pg', ">= 0.18", "< 2.0"
-gem 'rubocop', '~> 1.5'
-gem 'byebug', platform: :mri
+gem "rubocop", "~> 1.5"
+
+gem "rubocop-shopify", "~> 2.9.0", require: false
+
+gem "mysql2", "~> 0.5.3", platform: :mri
+gem "pg", ">= 0.18", "< 2.0", platform: :mri
+gem "memcached", "~> 1.8.0", platform: :mri
+gem "memcached_store", "~> 1.0.0", platform: :mri
+gem "dalli", "~> 2.7.11"
+gem "cityhash", "~> 0.6.0", platform: :mri
+
+gem "byebug", platform: :mri
+gem "stackprof", platform: :mri

data/LICENSE

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

data/README.md

@@ -1,5 +1,5 @@
 # IdentityCache
-[![Build Status](https://travis-ci.org/Shopify/identity_cache.svg?branch=master)](https://travis-ci.org/Shopify/identity_cache)
+[![Build Status](https://github.com/Shopify/identity_cache/workflows/CI/badge.svg?branch=main)](https://github.com/Shopify/identity_cache/actions?query=branch%3Amain)
 
 Opt in read through ActiveRecord caching used in production and extracted from Shopify. IdentityCache lets you specify how you want to cache your model objects, at the model level, and adds a number of convenience methods for accessing those objects through the cache. Memcached is used as the backend cache store, and the database is only hit when a copy of the object cannot be found in Memcached.
 
@@ -29,7 +29,7 @@ Add the following to all your environment/*.rb files (production/development/tes
 
 ```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
+  expires_in: 6.hours.to_i, # in case of network errors when sending a cache invalidation
   failover: false, # avoids more cache consistency issues
 }
 ```
@@ -48,7 +48,7 @@ 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
+  ), { expires_in: 6.hours.to_i } # in case of network errors when sending a cache invalidation
 ```
 
 Add an initializer with this code:
@@ -254,14 +254,13 @@ Cache keys include a version number by default, specified in `IdentityCache::CAC
 
 ## Caveats
 
-A word of warning. Some versions of rails will silently rescue all exceptions in `after_commit` hooks. If an `after_commit` fails before the cache expiry `after_commit` the cache will not be expired and you will be left with stale data.
+A word of warning. If an `after_commit` fails before the cache expiry `after_commit` the cache will not be expired and you will be left with stale data.
 
 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, 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.
+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 cache invalidation 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
 
-- JRuby will not work with this current version, as we are using the memcached gem internally to interface with memcache.
 - See CHANGELOG.md for a list of changes to the library over time.
 - The library is MIT licensed and we welcome contributions. See CONTRIBUTING.md for more information.

data/Rakefile

@@ -1,31 +1,32 @@
 #!/usr/bin/env rake
 # frozen_string_literal: true
-require 'bundler/gem_tasks'
 
-require 'rake/testtask'
-require 'rdoc/task'
+require "bundler/gem_tasks"
 
-desc('Default: run tests and style checks.')
+require "rake/testtask"
+require "rdoc/task"
+
+desc("Default: run tests and style checks.")
 task(default: [:test, :rubocop])
 
-desc('Test the identity_cache plugin.')
+desc("Test the identity_cache plugin.")
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
   t.verbose = true
 end
 
 task :rubocop do
-  require 'rubocop/rake_task'
+  require "rubocop/rake_task"
   RuboCop::RakeTask.new
 end
 
-desc('Update serialization format test fixture.')
+desc("Update serialization format test fixture.")
 task :update_serialization_format do
-  %w(mysql2 postgresql).each do |db|
+  ["mysql2", "postgresql"].each do |db|
     ENV["DB"] = db
-    ruby './test/helpers/update_serialization_format.rb'
+    ruby "./test/helpers/update_serialization_format.rb"
   end
 end
 

data/dev.yml

@@ -2,18 +2,16 @@ name: identity-cache
 
 up:
   - homebrew:
-    - postgresql
     - mysql-client@5.7:
         or:        [mysql@5.7]
         conflicts: [mysql-connector-c, mysql, mysql-client]
-  - ruby: 2.6.5
-  - railgun
+  - ruby: 2.7.2
+  - isogun
   - bundler
 
 env:
   RAILGUN_HOST: identity-cache.railgun
   MYSQL_HOST: identity-cache.railgun
-  POSTGRES_HOST: identity-cache.railgun
   MEMCACHED_HOST: identity-cache.railgun
 
 commands:

data/gemfiles/Gemfile.latest-release

@@ -1,8 +1,13 @@
-source 'https://rubygems.org'
-gemspec path: '..'
+source "https://rubygems.org"
+gemspec path: ".."
 
-gem 'activerecord'
-gem 'activesupport'
-gem "mysql2", ">= 0.4.4"
-gem "pg", ">= 0.18", "< 2.0"
-gem 'rubocop', '~> 1.5'
+gem "rubocop", "~> 1.5"
+gem "rubocop-shopify", "~> 2.9.0", require: false
+
+gem "activerecord"
+gem "activesupport"
+gem "mysql2", "~> 0.5"
+gem "pg", "~> 1.1"
+gem "memcached_store"
+gem "dalli"
+gem "cityhash"

data/gemfiles/Gemfile.min-supported

@@ -1,7 +1,12 @@
-source 'https://rubygems.org'
-gemspec path: '..'
+source "https://rubygems.org"
+gemspec path: ".."
 
-gem 'ar_transaction_changes', '~> 1.1.0'
-gem 'activerecord', '~> 5.2.0'
-gem 'mysql2', '~> 0.4.4'
-gem 'pg', '~> 0.18.0'
+gem "ar_transaction_changes", "~> 1.1.0"
+
+gem "activerecord", "~> 5.2.0"
+gem "mysql2", "~> 0.4.4"
+gem "pg", "~> 0.18.0"
+gem "memcached", "~> 1.8.0"
+gem "memcached_store", "~> 1.0.0"
+gem "dalli", "~> 2.7.11"
+gem "cityhash", "~> 0.6.0"

data/gemfiles/Gemfile.rails-edge

@@ -1,7 +1,10 @@
-source 'https://rubygems.org'
-gemspec path: '..'
+source "https://rubygems.org"
+gemspec path: ".."
 
-gem 'activerecord', github: 'rails/rails'
-gem 'activesupport', github: 'rails/rails'
-gem "mysql2", ">= 0.4.4"
+gem "activerecord", github: "rails/rails", branch: "main"
+gem "activesupport", github: "rails/rails", branch: "main"
+gem "mysql2", "~> 0.5"
 gem "pg", "~> 1.1"
+gem "memcached_store"
+gem "dalli"
+gem "cityhash"

data/identity_cache.gemspec

@@ -1,6 +1,7 @@
 # -*- encoding: utf-8 -*-
 # frozen_string_literal: true
-require File.expand_path('../lib/identity_cache/version', __FILE__)
+
+require File.expand_path("../lib/identity_cache/version", __FILE__)
 
 Gem::Specification.new do |gem|
   gem.authors = [
@@ -15,43 +16,30 @@ Gem::Specification.new do |gem|
   gem.email         = ["gems@shopify.com"]
   gem.description   = "Opt-in read through Active Record caching."
   gem.summary       = "IdentityCache lets you specify how you want to cache your " \
-                      "model objects, at the model level, and adds a number of " \
-                      "convenience methods for accessing those objects through " \
-                      "the cache. Memcached is used as the backend cache store, " \
-                      "and the database is only hit when a copy of the object " \
-                      "cannot be found in Memcached."
+    "model objects, at the model level, and adds a number of " \
+    "convenience methods for accessing those objects through " \
+    "the cache. Memcached is used as the backend cache store, " \
+    "and the database is only hit when a copy of the object " \
+    "cannot be found in Memcached."
   gem.homepage      = "https://github.com/Shopify/identity_cache"
 
   gem.files         = Dir.chdir(File.expand_path(__dir__)) do
     %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^test/}) }
   end
   gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^test/})
   gem.name          = "identity_cache"
   gem.require_paths = ["lib"]
   gem.version       = IdentityCache::VERSION
 
-  gem.required_ruby_version = '>= 2.5.0'
-
-  gem.metadata['allowed_push_host'] = 'https://rubygems.org'
+  gem.required_ruby_version = ">= 2.5.0"
 
-  gem.add_dependency('ar_transaction_changes', '~> 1.1')
-  gem.add_dependency('activerecord', '>= 5.2')
+  gem.metadata["allowed_push_host"] = "https://rubygems.org"
 
-  gem.add_development_dependency('memcached', '~> 1.8.0')
-  gem.add_development_dependency('memcached_store', '~> 1.0.0')
-  gem.add_development_dependency('dalli')
-  gem.add_development_dependency('rake')
-  gem.add_development_dependency('mocha', '0.14.0')
-  gem.add_development_dependency('spy')
-  gem.add_development_dependency('minitest', '>= 2.11.0')
+  gem.add_dependency("activerecord", ">= 5.2")
+  gem.add_dependency("ar_transaction_changes", "~> 1.1")
 
-  if RUBY_PLATFORM == 'java'
-    raise NotImplementedError
-  else
-    gem.add_development_dependency('cityhash', '0.6.0')
-    gem.add_development_dependency('mysql2')
-    gem.add_development_dependency('pg')
-    gem.add_development_dependency('stackprof')
-  end
+  gem.add_development_dependency("minitest", "~> 5.14")
+  gem.add_development_dependency("mocha", "~> 1.12")
+  gem.add_development_dependency("rake", "~> 13.0")
+  gem.add_development_dependency("spy", "~> 1.0")
 end

data/{railgun.yml → isogun.yml}

@@ -2,15 +2,10 @@
 name: identity-cache
 
 vm:
-  image:      /opt/dev/misc/railgun-images/default
   ip_address: 192.168.64.98
   memory:     1G
   cores:      2
 
-volumes:
-  root: 1G
-
 services:
   - mysql
-  - postgresql
   - memcached

data/lib/identity_cache/belongs_to_caching.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module IdentityCache
   module BelongsToCaching
     extend ActiveSupport::Concern