1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
|
# frozen_string_literal: true
require "test_prof/core"
require "test_prof/ext/float_duration"
require "test_prof/any_fixture/dump"
module TestProf
# Make DB fixtures from blocks.
module AnyFixture
INSERT_RXP = /^INSERT INTO (\S+)/.freeze
using FloatDuration
# AnyFixture configuration
class Configuration
attr_accessor :reporting_enabled, :dumps_dir, :dump_sequence_start,
:import_dump_via_cli, :dump_matching_queries, :force_matching_dumps
attr_reader :default_dump_watch_paths
alias_method :reporting_enabled?, :reporting_enabled
alias_method :import_dump_via_cli?, :import_dump_via_cli
def initialize
@reporting_enabled = ENV["ANYFIXTURE_REPORT"] == "1"
@dumps_dir = "any_dumps"
@default_dump_watch_paths = %w[
db/schema.rb
db/structure.sql
]
@dump_sequence_start = 123_654
@dump_matching_queries = /^$/
@import_dump_via_cli = ENV["ANYFIXTURE_IMPORT_DUMP_CLI"] == "1"
@before_dump = []
@after_dump = []
@force_matching_dumps =
if ENV["ANYFIXTURE_FORCE_DUMP"] == "1"
/.*/
elsif ENV["ANYFIXTURE_FORCE_DUMP"]
/#{ENV["ANYFIXTURE_FORCE_DUMP"]}/
else
/^$/
end
end
def before_dump(&block)
if block
@before_dump << block
else
@before_dump
end
end
def after_dump(&block)
if block
@after_dump << block
else
@after_dump
end
end
def dump_sequence_random_start
rand(dump_sequence_start..(dump_sequence_start * 2))
end
end
class Cache # :nodoc:
attr_reader :store, :stats
def initialize
@store = {}
@stats = {}
end
def fetch(key)
if store.key?(key)
stats[key][:hit] += 1
return store[key]
end
return unless block_given?
ts = TestProf.now
store[key] = yield
stats[key] = {time: TestProf.now - ts, hit: 0}
store[key]
end
def clear
store.clear
stats.clear
end
end
class << self
include Logging
def config
@config ||= Configuration.new
end
def configure
yield config
end
# Register a block of code as a fixture,
# returns the result of the block execution
def register(id)
cached(id) do
raise "No fixture named #{id} has been registered" unless block_given?
next yield if @disabled
ActiveSupport::Notifications.subscribed(method(:subscriber), "sql.active_record") do
yield
end
end
end
def cached(id, &block)
return (block_given? ? yield : nil) if @disabled
cache.fetch(id, &block)
end
# Create and register new SQL dump.
# Use `watch` to provide additional paths to watch for
# dump re-generation
def register_dump(name, clean: true, **options)
called_from = caller_locations(1, 1).first.path
watch = options.delete(:watch) || [called_from]
cache_key = options.delete(:cache_key)
skip = options.delete(:skip_if)
id = "sql/#{name}"
register_method = clean ? :register : :cached
public_send(register_method, id) do
dump = Dump.new(name, watch: watch, cache_key: cache_key)
unless dump.force?
next if skip&.call(dump: dump)
next dump.within_prepared_env(import: true, **options) { dump.load } if dump.exists?
end
subscriber = ActiveSupport::Notifications.subscribe("sql.active_record", dump.subscriber)
res = dump.within_prepared_env(**options) { yield }
dump.commit!
res
ensure
ActiveSupport::Notifications.unsubscribe(subscriber) if subscriber
end
end
# Clean all affected tables (but do not reset cache)
def clean
disable_referential_integrity do
tables_cache.keys.reverse_each do |table|
ActiveRecord::Base.connection.execute %(
DELETE FROM #{table}
)
end
end
end
# Reset all information and clean tables
def reset
callbacks[:before_fixtures_reset].each(&:call)
clean
tables_cache.clear
cache.clear
callbacks[:after_fixtures_reset].each(&:call)
callbacks.clear
end
def disable!
@disabled = true
end
def enable!
@disabled = false
end
def before_fixtures_reset(&block)
callbacks[:before_fixtures_reset] << block
end
def after_fixtures_reset(&block)
callbacks[:after_fixtures_reset] << block
end
def subscriber(_event, _start, _finish, _id, data)
matches = data.fetch(:sql).match(INSERT_RXP)
return unless matches
table_name = matches[1]
return if /sqlite_sequence/.match?(table_name)
tables_cache[table_name] = true
end
def report_stats
if cache.stats.empty?
log :info, "AnyFixture has not been used"
return
end
msgs = []
msgs <<
<<~MSG
AnyFixture usage stats:
MSG
first_column = cache.stats.keys.map(&:size).max + 2
msgs << format(
"%#{first_column}s %12s %9s %12s",
"key", "build time", "hit count", "saved time"
)
msgs << ""
total_spent = 0.0
total_saved = 0.0
total_miss = 0.0
cache.stats.to_a.sort_by { |(_, v)| -v[:hit] }.each do |(key, stats)|
total_spent += stats[:time]
saved = stats[:time] * stats[:hit]
total_saved += saved
total_miss += stats[:time] if stats[:hit].zero?
msgs << format(
"%#{first_column}s %12s %9d %12s",
key, stats[:time].duration, stats[:hit],
saved.duration
)
end
msgs <<
<<~MSG
Total time spent: #{total_spent.duration}
Total time saved: #{total_saved.duration}
Total time wasted: #{total_miss.duration}
MSG
log :info, msgs.join("\n")
end
private
def cache
@cache ||= Cache.new
end
def tables_cache
@tables_cache ||= {}
end
def callbacks
@callbacks ||= Hash.new { |h, k| h[k] = [] }
end
def disable_referential_integrity
connection = ActiveRecord::Base.connection
return yield unless connection.respond_to?(:disable_referential_integrity)
connection.disable_referential_integrity { yield }
end
end
enable!
end
end
|