factory_bot_caching 1.0.0

data/lib/factory_bot_caching.rb

@@ -0,0 +1,34 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2017-2018 Avant
+#
+# Author Tim Mertens
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'factory_girl'
+
+require 'factory_bot_caching/version'
+require 'factory_bot_caching/caching_factory_runner'
+
+module FactoryBotCaching
+  def self.initialize
+    FactoryGirl::FactoryRunner.prepend(FactoryBotCaching::CachingFactoryRunner)
+  end
+end

data/lib/factory_bot_caching/cache_manager.rb

@@ -0,0 +1,55 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2017-2018 Avant
+#
+# Author Tim Mertens
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'factory_cache'
+
+module FactoryBotCaching
+  class CacheManager
+    def self.instance
+      @instance ||= self.new
+    end
+
+    def initialize
+      @factory_cache = Hash.new do |hash, key|
+        hash[key] = FactoryCache.new(factory_name: key)
+      end
+    end
+
+    def reset_cache
+      factory_cache.each_value(&:reset)
+    end
+
+    def reset_cache_counter
+      factory_cache.each_value(&:reset_counter)
+    end
+
+    def fetch(name:, overrides:, traits:, &block)
+      factory_cache[name].fetch(overrides: overrides, traits: traits, &block)
+    end
+
+    private
+
+    attr_reader :factory_cache
+  end
+end

data/lib/factory_bot_caching/caching_factory_runner.rb

@@ -0,0 +1,43 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2017-2018 Avant
+#
+# Author Tim Mertens
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'cache_manager'
+require_relative 'module_methods'
+
+module FactoryBotCaching
+  module CachingFactoryRunner
+    def run(runner_strategy = @strategy, &block)
+      # We have to define the cache here so that it has access to super.
+      if FactoryBotCaching.enabled? && runner_strategy == :create
+        CacheManager.instance.fetch(name:      @name,
+                                    overrides: @overrides,
+                                    traits:    @traits) do
+          super
+        end
+      else
+        super
+      end
+    end
+  end
+end

data/lib/factory_bot_caching/config.rb

@@ -0,0 +1,56 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2017-2018 Avant
+#
+# Author Tim Mertens
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module FactoryBotCaching
+  class Config
+    FIFTEEN_MINUTES_IN_SECONDS = 900
+
+    def initialize
+      @factory_caching_enabled = false
+      @custom_cache_key = nil
+      @cache_timeout = FIFTEEN_MINUTES_IN_SECONDS
+    end
+
+    attr_reader :factory_caching_enabled, :custom_cache_key, :cache_timeout
+    alias_method :factory_caching_enabled?, :factory_caching_enabled
+
+    def cache_timeout=(seconds)
+      raise ArgumentError, 'Cache timeout must be an Integer!' unless seconds.is_a?(Integer)
+      @cache_timeout = seconds
+    end
+
+    def enable_factory_caching
+      @factory_caching_enabled = true
+    end
+
+    def disable_factory_caching
+      @factory_caching_enabled = false
+    end
+
+    def custom_cache_key=(block)
+      raise ArgumentError, 'The custom cache key must be a Proc!' unless block.instance_of?(Proc)
+      @custom_cache_key = block
+    end
+  end
+end

data/lib/factory_bot_caching/customized_cache.rb

@@ -0,0 +1,54 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2017-2018 Avant
+#
+# Author Tim Mertens
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'factory_record_cache'
+require 'i18n'
+
+module FactoryBotCaching
+  class CustomizedCache
+    def initialize(build_class:, cache_key_generator:)
+      @cache_key_generator = cache_key_generator
+      @cache = Hash.new do |hash, key|
+        hash[key] = FactoryRecordCache.new(build_class: build_class)
+      end
+    end
+
+    def fetch(overrides:, traits:, &block)
+      customized_cache.fetch(overrides: overrides, traits: traits, &block)
+    end
+
+    def reset_counters
+      cache.each_value(&:reset_counters)
+    end
+
+    private
+
+    attr_reader :cache, :cache_key_generator
+
+    def customized_cache
+      key = cache_key_generator.call
+      cache[key]
+    end
+  end
+end

data/lib/factory_bot_caching/factory_cache.rb

@@ -0,0 +1,123 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2017-2018 Avant
+#
+# Author Tim Mertens
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'customized_cache'
+
+module FactoryBotCaching
+  class FactoryCache
+    def initialize(factory_name:)
+      @factory_name       = factory_name
+      @build_class        = FactoryGirl.factory_by_name(factory_name).build_class
+      @cache              = new_cache(@build_class)
+      @cachable_overrides = []
+      collect_uncachable_traits
+    end
+
+    attr_reader :factory_name
+
+    def fetch(overrides:, traits:, &block)
+      key = { overrides: overrides, traits: traits}
+      if should_cache?(key)
+        cache.fetch(key, &block)
+      else
+        block.call
+      end
+    end
+
+    def reset
+      @cache = new_cache(build_class)
+    end
+
+    def reset_counter
+      cache.reset_counters
+    end
+
+    private
+
+    attr_reader :cache, :build_class
+
+    def new_cache(build_class)
+      if FactoryBotCaching.configuration.custom_cache_key.nil?
+        FactoryRecordCache.new(build_class: build_class)
+      else
+        CustomizedCache.new(
+          build_class: build_class,
+          cache_key_generator: FactoryBotCaching.configuration.custom_cache_key)
+      end
+    end
+
+    # Collect a list of traits that are considered 'uncachable' if passed in the overrides list.
+    # We collect two lists - belongs_to associations, which have a high probability to be overridden in
+    # a factory call and should be compared against first, followed by uncommon_associations
+    def collect_uncachable_traits
+      return unless build_class < ActiveRecord::Base
+
+      @common_associations = []
+      @uncommon_associations  = []
+
+      reflections = build_class.reflect_on_all_associations
+      reflections.each do |reflection|
+        if reflection.macro == :belongs_to
+          @common_associations << reflection.name.to_sym
+          # In rails land, some foreign keys are symbols, some strings; coerce them here:
+          @common_associations << reflection.foreign_key.to_sym
+        else
+          @uncommon_associations << reflection.name.to_sym
+        end
+      end
+    end
+
+    attr_reader :common_associations, :uncommon_associations, :cachable_overrides
+
+    # Determine whether or not an overridden value in a factory call is cacheable.
+    # We use some caching and perform comparisons in order of probability which nets a 70x improvement in
+    # performance over previous versions of this validation.
+    #
+    # For example:
+    #   FactoryGirl.create(:customer, name: 'John Doe', email: 'john.doe@example.test')
+    #   FactoryGirl.create(:customer, name: 'John Doe', address_id: 123)
+    #
+    # In the above examples, `address_id` is a passed in association and should not be cached.
+    #
+    # @param override_sym [Symbol]
+    # @return [Boolean] true if the overridden value is cacheable, false otherwise
+    def cacheable_override?(override_sym)
+      # Search in order of probability to reduce lookup times:
+      return true  if cachable_overrides.include?(override_sym)
+      return false if common_associations.include?(override_sym)
+      return false if uncommon_associations.include?(override_sym)
+      cachable_overrides << override_sym
+      true
+    end
+
+    # Skip caching for factories that are called with passed in associations, as it mutates the association and persisted record
+    def should_cache?(key)
+      return false unless build_class < ActiveRecord::Base
+
+      key[:overrides].all? do |key, v|
+        cacheable_override?(key.to_sym)
+      end
+    end
+  end
+end

data/lib/factory_bot_caching/factory_record_cache.rb

@@ -0,0 +1,109 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2017-2018 Avant
+#
+# Author Tim Mertens
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'immutable_iterator'
+require_relative 'module_methods'
+
+module FactoryBotCaching
+  class FactoryRecordCache
+    CacheEntry = Struct.new(:created_at, :identifier)
+
+    def initialize(build_class:)
+      @build_class = build_class
+      @cache = Hash.new do |factory_hash, key|
+        factory_hash[key] = []
+      end
+      reset_counters
+    end
+
+    def fetch(overrides:, traits:, &block)
+      key = {overrides: overrides, traits: traits}
+      now        = Time.now
+      enumerator = enumerator_for(key, at: now)
+
+      enumerator.until_end do |entry|
+        # Entries are sorted by created at, so we can break as soon as we see an entry created_at after now
+        break if entry.created_at > now
+        record = build_class.find_by(build_class.primary_key => entry.identifier)
+        return record unless record.nil?
+      end
+
+      cache_new_record(key, &block)
+    end
+
+    def reset_counters
+      @enumerator_cache = Hash.new do |enumerator_hash, key|
+        enumerator_hash[key] = ImmutableIterator.new(cache[key])
+      end
+    end
+
+    private
+
+    attr_reader :build_class, :cache, :enumerator_cache
+
+    def enumerator_for(key, at:)
+      enumerator    = enumerator_cache[key]
+      boundary_time = lookback_start_time(time: at)
+      enumerator.fast_forward { |entry| entry.created_at > boundary_time }
+      enumerator
+    end
+
+    def lookback_start_time(time: Time.now)
+      time - FactoryBotCaching.configuration.cache_timeout
+    end
+
+    def cache_new_record(cache_key, &block)
+      new_record = process_block(&block)
+      primary_key = new_record.class.primary_key
+
+      entry = CacheEntry.new(Time.now, new_record[primary_key])
+      cached_records = cache[cache_key]
+
+      insert_at_index = cached_records.find_index { |record| record.created_at > entry.created_at }
+      if insert_at_index.nil?
+        cached_records << entry
+      else
+        cached_records.insert(insert_at_index, entry)
+      end
+
+      new_record
+    end
+
+    def process_block(&block)
+      record = nil
+
+      Thread.new do
+        ActiveRecord::Base.connection_pool.with_connection do |conn|
+          conn.execute("SET statement_timeout = '20s'")
+          record = FactoryBotCaching.without_caching(&block)
+        end
+      end.join
+      record
+    rescue => e
+      # Append the backtrace of the current thread to the backtrace of the joined thread
+      e.set_backtrace(e.backtrace + caller)
+      raise e
+    end
+  end
+end