Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix stackprof not installed error #547

Merged
merged 1 commit into from
Apr 5, 2023
Merged

Fix stackprof not installed error #547

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 16 additions & 6 deletions lib/mini_profiler/profiler.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,10 +285,12 @@ def call(env)

unless defined?(MemoryProfiler) && MemoryProfiler.respond_to?(:report)
message = "Please install the memory_profiler gem and require it: add gem 'memory_profiler' to your Gemfile"
_, _, body = @app.call(env)
status, headers, body = @app.call(env)
body.close if body.respond_to? :close

return client_settings.handle_cookie(text_result(message))
return client_settings.handle_cookie(
text_result(message, status: status, headers: headers)
)
end

query_params = Rack::Utils.parse_nested_query(query_string)
Expand Down Expand Up @@ -347,7 +349,15 @@ def call(env)
env['HTTP_ACCEPT_ENCODING'] = 'identity' if config.suppress_encoding

if query_string =~ /pp=(async-)?flamegraph/ || env['HTTP_REFERER'] =~ /pp=async-flamegraph/
if defined?(StackProf) && StackProf.respond_to?(:run)
unless defined?(StackProf) && StackProf.respond_to?(:run)
message = "Please install the stackprof gem and require it: add gem 'stackprof' to your Gemfile"
status, headers, body = @app.call(env)
body.close if body.respond_to? :close

return client_settings.handle_cookie(
text_result(message, status: status, headers: headers)
)
else
# do not sully our profile with mini profiler timings
current.measure = false
match_data = query_string.match(/flamegraph_sample_rate=([\d\.]+)/)
Expand Down Expand Up @@ -638,9 +648,9 @@ def analyze_memory
text_result(body)
end

def text_result(body)
headers = { 'Content-Type' => 'text/plain; charset=utf-8' }
[200, headers, [body]]
def text_result(body, status: 200, headers: nil)
headers = (headers || {}).merge('Content-Type' => 'text/plain; charset=utf-8')
[status, headers, [body]]
end

def make_link(postfix, env)
Expand Down
22 changes: 19 additions & 3 deletions spec/integration/middleware_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,15 @@ def app
def app
Rack::Builder.new do
use Rack::MiniProfiler
run lambda { |_env| [200, { 'Content-Type' => 'text/html' }, [+'<html><body><h1>Hi</h1></body></html>']] }
run(
lambda do |_env|
[
201,
{ 'Content-Type' => 'text/html', 'X-CUSTOM' => "1" },
[+'<html><body><h1>Hi</h1></body></html>'],
]
end
)
end
end

Expand All @@ -59,29 +67,37 @@ def app
describe 'with profile-memory query' do
it 'should return memory_profiler error message' do
do_get(pp: 'profile-memory')

expect(last_response.body).to eq(
'Please install the memory_profiler gem and require it: add gem \'memory_profiler\' to your Gemfile'
)
expect(last_response.headers['Content-Type']).to eq('text/plain; charset=utf-8')
expect(last_response.headers['X-CUSTOM']).to eq('1')
expect(last_response.status).to eq(201)
end
end

describe 'with flamegraph query' do
it 'should return stackprof error message' do
Rack::MiniProfiler.config.enable_advanced_debugging_tools = true
do_get(pp: 'flamegraph')
expect(last_response.body).to eq(
'Please install the stackprof gem and require it: add gem \'stackprof\' to your Gemfile'
)
expect(last_response.headers['Content-Type']).to eq('text/plain; charset=utf-8')
expect(last_response.headers['X-CUSTOM']).to eq('1')
expect(last_response.status).to eq(201)
end
end

describe 'with async-flamegraph query' do
it 'should return stackprof error message' do
Rack::MiniProfiler.config.enable_advanced_debugging_tools = true
do_get(pp: 'async-flamegraph')
expect(last_response.body).to eq(
'Please install the stackprof gem and require it: add gem \'stackprof\' to your Gemfile'
)
expect(last_response.headers['Content-Type']).to eq('text/plain; charset=utf-8')
expect(last_response.headers['X-CUSTOM']).to eq('1')
expect(last_response.status).to eq(201)
end
end
end
Expand Down
31 changes: 31 additions & 0 deletions spec/lib/profiler_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,4 +198,35 @@ def self.bar(baz, boo)
expect(Rack::MiniProfiler.snapshots_transporter?).to eq(true)
end
end

describe '#call' do
let(:app) { lambda { |env| [200, {}, ["OK"]] } }
let(:profiler) { Rack::MiniProfiler.new(app) }

it "returns error response when stackprof isn't installed" do
response = profiler.call({ "PATH_INFO" => "/", "QUERY_STRING" => "pp=flamegraph" })

expect(response).to eq([
200,
{ "Content-Type" => "text/plain; charset=utf-8", "Set-Cookie"=>"__profilin=p%3Dt; path=/; HttpOnly; SameSite=Lax" },
["Please install the stackprof gem and require it: add gem 'stackprof' to your Gemfile"],
])
end

it "returns error response when memory_profiler isn't installed" do
original_enable_advanced_debugging_tools = Rack::MiniProfiler.config.enable_advanced_debugging_tools
Rack::MiniProfiler.config.enable_advanced_debugging_tools = true

response = profiler.call({ "PATH_INFO" => "/", "QUERY_STRING" => "pp=profile-memory" })

expect(response).to eq([
200,
{ "Content-Type" => "text/plain; charset=utf-8", "Set-Cookie"=>"__profilin=p%3Dt; path=/; HttpOnly; SameSite=Lax" },
["Please install the memory_profiler gem and require it: add gem 'memory_profiler' to your Gemfile"],
])

ensure
Rack::MiniProfiler.config.enable_advanced_debugging_tools = original_enable_advanced_debugging_tools
end
end
end