identity_cache 0.4.1 → 1.1.0

data/test/recursive_denormalized_has_many_test.rb

@@ -1,131 +0,0 @@
-require "test_helper"
-
-class RecursiveDenormalizedHasManyTest < IdentityCache::TestCase
-  def setup
-    super
-    AssociatedRecord.cache_has_many :deeply_associated_records, :embed => true
-    Item.cache_has_many :associated_records, :embed => true
-    Item.cache_has_one :associated
-
-    @record = Item.new(:title => 'foo')
-
-    @associated_record = AssociatedRecord.new(:name => 'bar')
-    @record.associated_records << AssociatedRecord.new(:name => 'baz')
-    @record.associated_records << @associated_record
-
-    @deeply_associated_record = DeeplyAssociatedRecord.new(:name => "corge")
-    @associated_record.deeply_associated_records << @deeply_associated_record
-    @associated_record.deeply_associated_records << DeeplyAssociatedRecord.new(:name => "qux")
-
-    @record.save
-    @record.reload
-    @associated_record.reload
-  end
-
-  def test_cache_fetch_includes
-    assert_equal [{:associated_records => [:deeply_associated_records]}, :associated => [:deeply_associated_records]], Item.send(:cache_fetch_includes)
-  end
-
-  def test_uncached_record_from_the_db_will_use_normal_association_for_deeply_associated_records
-    expected = @associated_record.deeply_associated_records
-    record_from_db = Item.find(@record.id)
-    assert_equal expected, record_from_db.fetch_associated_records[0].fetch_deeply_associated_records
-  end
-
-  def test_on_cache_miss_record_should_embed_associated_objects_and_return
-    record_from_cache_miss = Item.fetch(@record.id)
-    expected = @associated_record.deeply_associated_records
-
-    child_record_from_cache_miss = record_from_cache_miss.fetch_associated_records[0]
-    assert_equal @associated_record, child_record_from_cache_miss
-    assert_equal expected, child_record_from_cache_miss.fetch_deeply_associated_records
-  end
-
-  def test_on_cache_hit_record_should_return_embed_associated_objects
-    Item.fetch(@record.id) # warm cache
-    expected = @associated_record.deeply_associated_records
-
-    Item.any_instance.expects(:associated_records).never
-    AssociatedRecord.any_instance.expects(:deeply_associated_records).never
-
-    record_from_cache_hit = Item.fetch(@record.id)
-    child_record_from_cache_hit = record_from_cache_hit.fetch_associated_records[0]
-    assert_equal @associated_record, child_record_from_cache_hit
-    assert_equal expected, child_record_from_cache_hit.fetch_deeply_associated_records
-  end
-
-  def test_on_cache_miss_child_record_fetch_should_include_nested_associations_to_avoid_n_plus_ones
-    assert_queries(5) do
-      # one for the top level record
-      # one for the mid level has_many association
-      # one for the mid level has_one association
-      # one for the deep level level has_many on the mid level has_many association
-      # one for the deep level level has_many on the mid level has_one association
-      Item.fetch(@record.id)
-    end
-  end
-
-  def test_saving_child_record_should_expire_parent_record
-    IdentityCache.cache.expects(:delete).with(@record.primary_cache_index_key)
-    if AssociatedRecord.primary_cache_index_enabled
-      IdentityCache.cache.expects(:delete).with(@associated_record.primary_cache_index_key)
-    else
-      IdentityCache.cache.expects(:delete).with(@associated_record.primary_cache_index_key).never
-    end
-    @associated_record.name = 'different'
-    @associated_record.save!
-  end
-
-  def test_saving_grand_child_record_should_expire_parent_record
-    IdentityCache.cache.expects(:delete).with(@record.primary_cache_index_key)
-    if AssociatedRecord.primary_cache_index_enabled
-      IdentityCache.cache.expects(:delete).with(@associated_record.primary_cache_index_key)
-    else
-      IdentityCache.cache.expects(:delete).with(@associated_record.primary_cache_index_key).never
-    end
-    IdentityCache.cache.expects(:delete).with(@deeply_associated_record.primary_cache_index_key)
-    @deeply_associated_record.name = 'different'
-    @deeply_associated_record.save!
-  end
-
-  def test_set_inverse_associations
-    DeeplyAssociatedRecord.cache_belongs_to :associated_record
-    AssociatedRecord.cache_belongs_to :item
-    Item.fetch(@record.id) # warm cache
-
-    item = Item.fetch(@record.id)
-
-    assert_queries(0) do
-      assert_memcache_operations(0) do
-        associated_record = item.fetch_associated_records.to_a.first
-        deeply_associated_record = associated_record.fetch_deeply_associated_records.first
-        assert_equal item.id, deeply_associated_record.fetch_associated_record.fetch_item.id
-      end
-    end
-  end
-
-end
-
-class RecursiveNormalizedHasManyTest < IdentityCache::TestCase
-  def setup
-    super
-    AssociatedRecord.cache_has_many :deeply_associated_records, :embed => true
-    Item.cache_has_many :associated_records, :embed => :ids
-
-    @record = Item.new(:title => 'foo')
-    @record.save
-    @record.reload
-  end
-
-  def test_cache_repopulation_should_not_fetch_non_embedded_associations
-    Item.any_instance.expects(:fetch_associated_records).never
-    Item.fetch(@record.id) # cache miss
-  end
-end
-
-class DisabledPrimaryIndexTest < RecursiveDenormalizedHasManyTest
-  def setup
-    super
-    AssociatedRecord.disable_primary_cache_index
-  end
-end

data/test/save_test.rb

@@ -1,82 +0,0 @@
-require "test_helper"
-
-class SaveTest < IdentityCache::TestCase
-  NAMESPACE = IdentityCache::CacheKeyGeneration::DEFAULT_NAMESPACE
-
-  def setup
-    super
-    Item.cache_index :title, :unique => true
-    Item.cache_index :id, :title, :unique => true
-
-    @record = Item.create(:title => 'bob')
-    @blob_key = "#{NAMESPACE}blob:Item:#{cache_hash("created_at:datetime,id:integer,item_id:integer,title:string,updated_at:datetime")}:1"
-  end
-
-  def test_create
-    @record = Item.new
-    @record.title = 'bob'
-
-    expect_cache_delete("#{NAMESPACE}attr:Item:id:id/title:#{cache_hash('2/bob')}")
-    expect_cache_delete("#{NAMESPACE}attr:Item:id:title:#{cache_hash('bob')}")
-    expect_cache_delete("#{NAMESPACE}blob:Item:#{cache_hash("created_at:datetime,id:integer,item_id:integer,title:string,updated_at:datetime")}:2").once
-    @record.save
-  end
-
-  def test_update
-    # Regular flow, write index id, write index id/tile, delete data blob since Record has changed
-    expect_cache_delete("#{NAMESPACE}attr:Item:id:id/title:#{cache_hash('1/fred')}")
-    expect_cache_delete("#{NAMESPACE}attr:Item:id:title:#{cache_hash('fred')}")
-    expect_cache_delete(@blob_key)
-
-    # Delete index id, delete index id/title
-    expect_cache_delete("#{NAMESPACE}attr:Item:id:id/title:#{cache_hash('1/bob')}")
-    expect_cache_delete("#{NAMESPACE}attr:Item:id:title:#{cache_hash('bob')}")
-
-    @record.title = 'fred'
-    @record.save
-  end
-
-  def test_destroy
-    # Regular flow: delete data blob, delete index id, delete index id/tile
-    expect_cache_delete("#{NAMESPACE}attr:Item:id:id/title:#{cache_hash('1/bob')}")
-    expect_cache_delete("#{NAMESPACE}attr:Item:id:title:#{cache_hash('bob')}")
-    expect_cache_delete(@blob_key)
-
-    @record.destroy
-  end
-
-  def test_destroy_with_changed_attributes
-    # Make sure to delete the old cache index key, since the new title never ended up in an index
-    expect_cache_delete("#{NAMESPACE}attr:Item:id:id/title:#{cache_hash('1/bob')}")
-    expect_cache_delete("#{NAMESPACE}attr:Item:id:title:#{cache_hash('bob')}")
-    expect_cache_delete(@blob_key)
-
-    @record.title = 'fred'
-    @record.destroy
-  end
-
-  def test_touch_will_expire_the_caches
-    # Regular flow: delete data blob, delete index id, delete index id/tile
-    expect_cache_delete("#{NAMESPACE}attr:Item:id:id/title:#{cache_hash('1/bob')}")
-    expect_cache_delete("#{NAMESPACE}attr:Item:id:title:#{cache_hash('bob')}")
-    expect_cache_delete(@blob_key)
-
-    @record.touch
-  end
-
-  def test_expire_cache_works_in_a_transaction
-    expect_cache_delete("#{NAMESPACE}attr:Item:id:id/title:#{cache_hash('1/bob')}")
-    expect_cache_delete("#{NAMESPACE}attr:Item:id:title:#{cache_hash('bob')}")
-    expect_cache_delete(@blob_key)
-
-    ActiveRecord::Base.transaction do
-      @record.send(:expire_cache)
-    end
-  end
-
-  private
-
-  def expect_cache_delete(key)
-    @backend.expects(:write).with(key, IdentityCache::DELETED, anything)
-  end
-end

data/test/schema_change_test.rb

@@ -1,112 +0,0 @@
-require "test_helper"
-
-class SchemaChangeTest < IdentityCache::TestCase
-  class AddColumnToChild < ActiveRecord::Migration
-    def up
-      add_column :associated_records, :shiny, :string
-    end
-  end
-
-  class AddColumnToDeepChild < ActiveRecord::Migration
-    def up
-      add_column :deeply_associated_records, :new_column, :string
-    end
-  end
-
-  def setup
-    super
-    ActiveRecord::Migration.verbose = false
-
-    read_new_schema
-    Item.cache_has_one :associated, :embed => true
-    AssociatedRecord.cache_has_many :deeply_associated_records, :embed => true
-
-    @associated_record = AssociatedRecord.new(:name => 'bar')
-    @deeply_associated_record = DeeplyAssociatedRecord.new(:name => "corge")
-    @associated_record.deeply_associated_records << @deeply_associated_record
-    @associated_record.deeply_associated_records << DeeplyAssociatedRecord.new(:name => "qux")
-    @record = Item.new(:title => 'foo')
-    @record.associated = @associated_record
-
-    @associated_record.save!
-    @record.save!
-
-    @record.reload
-  end
-
-  def teardown
-    active_records = [AssociatedRecord, DeeplyAssociatedRecord]
-    super
-    active_records.each {|ar| ar.reset_column_information }
-  end
-
-  # This helper simulates the models being reloaded
-  def read_new_schema
-    AssociatedRecord.reset_column_information
-    DeeplyAssociatedRecord.reset_column_information
-
-    AssociatedRecord.send(:instance_variable_set, :@rails_cache_key_prefix, nil)
-    Item.send(:instance_variable_set, :@rails_cache_key_prefix, nil)
-  end
-
-  def test_schema_changes_on_embedded_association_should_cause_cache_miss_for_old_cached_objects
-    record = Item.fetch(@record.id)
-    record.fetch_associated
-
-    AddColumnToChild.new.up
-    read_new_schema
-
-    Item.expects(:resolve_cache_miss).returns(@record)
-    record = Item.fetch(@record.id)
-  end
-
-  def test_schema_changes_on_deeply_embedded_association_should_cause_cache_miss_for_old_cached_objects
-    record = Item.fetch(@record.id)
-    associated_record_from_cache = record.fetch_associated
-    associated_record_from_cache.fetch_deeply_associated_records
-
-    AddColumnToDeepChild.new.up
-    read_new_schema
-
-    Item.expects(:resolve_cache_miss).returns(@record)
-    record = Item.fetch(@record.id)
-  end
-
-  def test_schema_changes_on_new_cached_child_association
-    record = Item.fetch(@record.id)
-
-    PolymorphicRecord.include(IdentityCache::WithoutPrimaryIndex)
-    Item.cache_has_many :polymorphic_records, :inverse_name => :owner, :embed => true
-    read_new_schema
-
-    Item.expects(:resolve_cache_miss).returns(@record)
-    record = Item.fetch(@record.id)
-  end
-
-  def test_embed_existing_cache_has_many
-    PolymorphicRecord.include(IdentityCache)
-    Item.cache_has_many :polymorphic_records, :inverse_name => :owner, :embed => :ids
-    read_new_schema
-
-    record = Item.fetch(@record.id)
-
-    teardown_models
-    setup_models
-
-    PolymorphicRecord.include(IdentityCache::WithoutPrimaryIndex)
-    Item.cache_has_many :polymorphic_records, :inverse_name => :owner, :embed => true
-    read_new_schema
-
-    record = Item.fetch(@record.id)
-  end
-
-  def test_add_non_embedded_cache_has_many
-    PolymorphicRecord.include(IdentityCache)
-    record = Item.fetch(@record.id)
-
-    Item.cache_has_many :polymorphic_records, :inverse_name => :owner, :embed => :ids
-    read_new_schema
-
-    record = Item.fetch(@record.id)
-  end
-end

data/test/serialization_format_change_test.rb

@@ -1,16 +0,0 @@
-require "test_helper"
-require "helpers/serialization_format"
-
-class SerializationFormatChangeTest < IdentityCache::TestCase
-  include SerializationFormat
-
-  MESSAGE = "serialization format changed => increment IdentityCache.CACHE_VERSION and run rake update_serialization_format"
-
-  def test_serialization_format_has_not_changed
-    serialization = Marshal.load(serialize(serialized_record))
-    preserialization = Marshal.load(File.binread(serialized_record_file))
-    assert_equal(preserialization, serialization, MESSAGE)
-  rescue SystemCallError
-    assert(false, MESSAGE)
-  end
-end

data/test/test_helper.rb

@@ -1,140 +0,0 @@
-require 'logger'
-require 'minitest/autorun'
-require 'mocha/setup'
-require 'active_record'
-require 'helpers/database_connection'
-require 'helpers/active_record_objects'
-require 'spy/integration'
-require 'memcached_store'
-require 'active_support/cache/memcached_store'
-
-require File.dirname(__FILE__) + '/../lib/identity_cache'
-
-DatabaseConnection.setup
-ActiveSupport::Cache::Store.instrument = true if ActiveSupport.version < Gem::Version.new("4.2.0")
-
-# This patches AR::MemcacheStore to notify AS::Notifications upon read_multis like the rest of rails does
-module MemcachedStoreInstrumentation
-  def read_multi(*args, &block)
-    instrument('read_multi', 'MULTI', keys: args) do
-      super(*args, &block)
-    end
-  end
-end
-ActiveSupport::Cache::MemcachedStore.prepend(MemcachedStoreInstrumentation)
-
-
-MiniTest::Test = MiniTest::Unit::TestCase unless defined?(MiniTest::Test)
-class IdentityCache::TestCase < Minitest::Test
-  include ActiveRecordObjects
-  attr_reader :backend
-
-  def setup
-    if ActiveRecord.gem_version < Gem::Version.new('5') && ActiveRecord::Base.respond_to?(:raise_in_transactional_callbacks=)
-      ActiveRecord::Base.raise_in_transactional_callbacks = true
-    end
-
-    DatabaseConnection.drop_tables
-    DatabaseConnection.create_tables
-
-    IdentityCache.logger = Logger.new(nil)
-
-    memcached_host = ENV['MEMCACHED_HOST'] || "127.0.0.1"
-    IdentityCache.cache_backend = @backend = ActiveSupport::Cache::MemcachedStore.new("#{memcached_host}:11211", :support_cas => true)
-
-    setup_models
-  end
-
-  def teardown
-    IdentityCache.cache.clear
-    teardown_models
-  end
-
-  private
-
-  def fetcher
-    IdentityCache.cache.cache_fetcher
-  end
-
-  def assert_nothing_raised
-    yield
-  end
-
-  def assert_not_nil(*args)
-    assert(*args)
-  end
-
-  def assert_queries(num = 1)
-    counter = SQLCounter.new
-    subscriber = ActiveSupport::Notifications.subscribe('sql.active_record', counter)
-    exception = false
-    yield
-  rescue
-    exception = true
-    raise
-  ensure
-    ActiveSupport::Notifications.unsubscribe(subscriber)
-    assert_equal num, counter.log.size, "#{counter.log.size} instead of #{num} queries were executed.#{counter.log.size == 0 ? '' : "\nQueries:\n#{counter.log.join("\n")}"}" unless exception
-  end
-
-  def assert_memcache_operations(num)
-    counter = CacheCounter.new
-    subscriber = ActiveSupport::Notifications.subscribe(/cache_.*\.active_support/, counter)
-    exception = false
-    yield
-  rescue
-    exception = true
-    raise
-  ensure
-    ActiveSupport::Notifications.unsubscribe(subscriber)
-    assert_equal num, counter.log.size, "#{counter.log.size} instead of #{num} memcache operations were executed. #{counter.log.size == 0 ? '' : "\nOperations:\n#{counter.log.join("\n")}"}" unless exception
-  end
-
-  def assert_no_queries
-    assert_queries(0) do
-      yield
-    end
-  end
-
-  def cache_hash(key)
-    IdentityCache.memcache_hash(key)
-  end
-end
-
-class SQLCounter
-  cattr_accessor :ignored_sql
-  self.ignored_sql = [/^PRAGMA (?!(table_info))/, /^SELECT currval/, /^SELECT CAST/, /^SELECT @@IDENTITY/, /^SELECT @@ROWCOUNT/, /^SAVEPOINT/, /^ROLLBACK TO SAVEPOINT/, /^RELEASE SAVEPOINT/, /^SHOW max_identifier_length/, /^BEGIN/, /^COMMIT/, /^SHOW /]
-
-  # FIXME: this needs to be refactored so specific database can add their own
-  # ignored SQL.  This ignored SQL is for Oracle.
-  ignored_sql.concat [/^select .*nextval/i, /^SAVEPOINT/, /^ROLLBACK TO/, /^\s*select .* from all_triggers/im]
-
-  attr_reader :ignore
-  attr_accessor :log
-
-  def initialize(ignore = self.class.ignored_sql)
-    @ignore   = ignore
-    @log = []
-  end
-
-  def call(name, start, finish, message_id, values)
-    sql = values[:sql]
-
-    # FIXME: this seems bad. we should probably have a better way to indicate
-    # the query was cached
-    return if 'CACHE' == values[:name] || ignore.any? { |x| x =~ sql }
-    self.log << sql
-  end
-end
-
-class CacheCounter
-  attr_accessor :log
-
-  def initialize()
-    @log = []
-  end
-
-  def call(name, start, finish, message_id, values)
-    self.log << "#{name} #{(values[:keys].try(:join, ', ') || values[:key])}"
-  end
-end