164 lines
4.2 KiB
Ruby
164 lines
4.2 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require "isolation/abstract_unit"
|
|
require "rack/test"
|
|
|
|
module ApplicationTests
|
|
class QueryLogsTest < ActiveSupport::TestCase
|
|
include ActiveSupport::Testing::Isolation
|
|
include Rack::Test::Methods
|
|
|
|
def setup
|
|
build_app
|
|
app_file "app/models/user.rb", <<-RUBY
|
|
class User < ActiveRecord::Base
|
|
end
|
|
RUBY
|
|
|
|
app_file "app/controllers/users_controller.rb", <<-RUBY
|
|
class UsersController < ApplicationController
|
|
def index
|
|
render inline: ActiveRecord::QueryLogs.call("")
|
|
end
|
|
|
|
def dynamic_content
|
|
Time.now.to_f
|
|
end
|
|
end
|
|
RUBY
|
|
|
|
app_file "app/jobs/user_job.rb", <<-RUBY
|
|
class UserJob < ActiveJob::Base
|
|
def perform
|
|
ActiveRecord::QueryLogs.call("")
|
|
end
|
|
|
|
def dynamic_content
|
|
Time.now.to_f
|
|
end
|
|
end
|
|
RUBY
|
|
|
|
app_file "config/routes.rb", <<-RUBY
|
|
Rails.application.routes.draw do
|
|
get "/", to: "users#index"
|
|
end
|
|
RUBY
|
|
end
|
|
|
|
def teardown
|
|
teardown_app
|
|
end
|
|
|
|
def app
|
|
@app ||= Rails.application
|
|
end
|
|
|
|
test "does not modify the query execution path by default" do
|
|
boot_app
|
|
|
|
assert_not_includes ActiveRecord.query_transformers, ActiveRecord::QueryLogs
|
|
end
|
|
|
|
test "prepends the query execution path when enabled" do
|
|
add_to_config "config.active_record.query_log_tags_enabled = true"
|
|
|
|
boot_app
|
|
|
|
assert_includes ActiveRecord.query_transformers, ActiveRecord::QueryLogs
|
|
end
|
|
|
|
test "controller and job tags are defined by default" do
|
|
add_to_config "config.active_record.query_log_tags_enabled = true"
|
|
|
|
boot_app
|
|
|
|
assert_equal ActiveRecord::QueryLogs.tags, [ :application, :controller, :action, :job ]
|
|
end
|
|
|
|
test "controller actions have tagging filters enabled by default" do
|
|
add_to_config "config.active_record.query_log_tags_enabled = true"
|
|
|
|
boot_app
|
|
|
|
get "/"
|
|
comment = last_response.body.strip
|
|
|
|
assert_includes comment, "controller:users"
|
|
end
|
|
|
|
test "controller actions tagging filters can be disabled" do
|
|
add_to_config "config.active_record.query_log_tags_enabled = true"
|
|
add_to_config "config.action_controller.log_query_tags_around_actions = false"
|
|
|
|
boot_app
|
|
|
|
get "/"
|
|
comment = last_response.body.strip
|
|
|
|
assert_not_includes comment, "controller:users"
|
|
end
|
|
|
|
test "job perform method has tagging filters enabled by default" do
|
|
add_to_config "config.active_record.query_log_tags_enabled = true"
|
|
|
|
boot_app
|
|
|
|
comment = UserJob.new.perform_now
|
|
|
|
assert_includes comment, "UserJob"
|
|
end
|
|
|
|
test "job perform method tagging filters can be disabled" do
|
|
add_to_config "config.active_record.query_log_tags_enabled = true"
|
|
add_to_config "config.active_job.log_query_tags_around_perform = false"
|
|
|
|
boot_app
|
|
|
|
comment = UserJob.new.perform_now
|
|
|
|
assert_not_includes comment, "UserJob"
|
|
end
|
|
|
|
test "query cache is cleared between requests" do
|
|
add_to_config "config.active_record.query_log_tags_enabled = true"
|
|
add_to_config "config.active_record.cache_query_log_tags = true"
|
|
add_to_config "config.active_record.query_log_tags = [ { dynamic: ->(context) { context[:controller]&.dynamic_content } } ]"
|
|
|
|
boot_app
|
|
|
|
get "/"
|
|
|
|
first_tags = last_response.body
|
|
|
|
get "/"
|
|
|
|
second_tags = last_response.body
|
|
|
|
assert_not_equal first_tags, second_tags
|
|
end
|
|
|
|
test "query cache is cleared between job executions" do
|
|
add_to_config "config.active_record.query_log_tags_enabled = true"
|
|
add_to_config "config.active_record.cache_query_log_tags = true"
|
|
add_to_config "config.active_record.query_log_tags = [ { dynamic: ->(context) { context[:job]&.dynamic_content } } ]"
|
|
|
|
boot_app
|
|
|
|
first_tags = UserJob.new.perform_now
|
|
second_tags = UserJob.new.perform_now
|
|
|
|
assert_not_equal first_tags, second_tags
|
|
end
|
|
|
|
private
|
|
def boot_app(env = "production")
|
|
ENV["RAILS_ENV"] = env
|
|
|
|
require "#{app_path}/config/environment"
|
|
ensure
|
|
ENV.delete "RAILS_ENV"
|
|
end
|
|
end
|
|
end
|