Module: Rack::MiniProfiler::Views

Included in:
Rack::MiniProfiler
Defined in:
lib/mini_profiler/views.rb

Constant Summary collapse

BLANK_PAGE = 
<<~HTML
  <!DOCTYPE html>
  <html>
    <head>
      <title>Rack::MiniProfiler Requests</title>
    </head>
    <body>
    </body>
  </html>
HTML

Instance Method Summary collapse

Instance Method Details

#blank_page_html ⇒ Object 



103
104
105
 
# File 'lib/mini_profiler/views.rb', line 103

def blank_page_html
  BLANK_PAGE
end

#flamegraph(graph, path, env) ⇒ Object 



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
 
# File 'lib/mini_profiler/views.rb', line 112

def flamegraph(graph, path, env)
  headers = { 'Content-Type' => 'text/html' }
  iframe_src = "#{public_base_path(env)}speedscope/index.html"
  html = <<~HTML
    <!DOCTYPE html>
    <html>
      <head>
        <title>Rack::MiniProfiler Flamegraph</title>
        <style>
          body { margin: 0; height: 100vh; }
          #speedscope-iframe { width: 100%; height: 100%; border: none; }
        </style>
      </head>
      <body>
        <script type="text/javascript">
          var graph = #{JSON.generate(graph)};
          var json = JSON.stringify(graph);
          var blob = new Blob([json], { type: 'text/plain' });
          var objUrl = encodeURIComponent(URL.createObjectURL(blob));
          var iframe = document.createElement('IFRAME');
          iframe.setAttribute('id', 'speedscope-iframe');
          document.body.appendChild(iframe);
          var iframeUrl = '#{iframe_src}#profileURL=' + objUrl + '&title=' + 'Flamegraph for #{CGI.escape(path)}';
          iframe.setAttribute('src', iframeUrl);
        </script>
      </body>
    </html>
  HTML
  [200, headers, [html]]
end

#generate_html(page_struct, env, result_json = page_struct.to_json) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/mini_profiler/views.rb', line 13

def generate_html(page_struct, env, result_json = page_struct.to_json)
  # double-assigning to suppress "assigned but unused variable" warnings
  path = path = "#{env['RACK_MINI_PROFILER_ORIGINAL_SCRIPT_NAME']}#{@config.base_url_path}"
  version = version = MiniProfiler::ASSET_VERSION
  json = json = result_json
  includes = includes = get_profile_script(env)
  name = name = page_struct[:name]
  duration = duration = page_struct.duration_ms.round(1).to_s

  share_template.result(binding)
end

#get_profile_script(env, response_headers = {}) ⇒ Object

get_profile_script returns script to be injected inside current html page By default, profile_script is appended to the end of all html requests automatically. Calling get_profile_script cancels automatic append for the current page Use it when:

  • you have disabled auto append behaviour throught :auto_inject => false flag

  • you do not want script to be automatically appended for the current page. You can also call cancel_auto_inject



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
 
# File 'lib/mini_profiler/views.rb', line 31

def get_profile_script(env, response_headers = {})
  path = public_base_path(env)
  version = MiniProfiler::ASSET_VERSION
  if @config.assets_url
    url = @config.assets_url.call('rack-mini-profiler.js', version, env)
    css_url = @config.assets_url.call('rack-mini-profiler.css', version, env)
  end

  url = "#{path}includes.js?v=#{version}" if !url
  css_url = "#{path}includes.css?v=#{version}" if !css_url

  configured_nonce = @config.content_security_policy_nonce
  if configured_nonce && !configured_nonce.is_a?(String)
    configured_nonce = configured_nonce.call(env, response_headers)
  end

  content_security_policy_nonce = configured_nonce ||
                                  env["action_dispatch.content_security_policy_nonce"] ||
                                  env["secure_headers_content_security_policy_nonce"]

  settings = {
   path: path,
   url: url,
   cssUrl: css_url,
   version: version,
   verticalPosition: @config.vertical_position,
   horizontalPosition: @config.horizontal_position,
   showTrivial: @config.show_trivial,
   showChildren: @config.show_children,
   maxTracesToShow: @config.max_traces_to_show,
   showControls: @config.show_controls,
   showTotalSqlCount: @config.show_total_sql_count,
   authorized: true,
   toggleShortcut: @config.toggle_shortcut,
   startHidden: @config.start_hidden,
   collapseResults: @config.collapse_results,
   htmlContainer: @config.html_container,
   hiddenCustomFields: @config.snapshot_hidden_custom_fields.join(','),
   cspNonce: content_security_policy_nonce,
   hotwireTurboDriveSupport: @config.enable_hotwire_turbo_drive_support,
  }

  if current && current.page_struct
    settings[:ids]       = ids_comma_separated(env)
    settings[:currentId] = current.page_struct[:id]
  else
    settings[:ids]       = []
    settings[:currentId] = ""
  end

  # TODO : cache this snippet
  script = ::File.read(::File.expand_path('../html/profile_handler.js', ::File.dirname(__FILE__)))
  # replace the variables
  settings.each do |k, v|
    regex = Regexp.new("\\{#{k}\\}")
    script.gsub!(regex, v.to_s)
  end

  current.inject_js = false if current
  script
end

#help(client_settings, env) ⇒ Object 



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
 
# File 'lib/mini_profiler/views.rb', line 143

def help(client_settings, env)
  headers = { 'Content-Type' => 'text/html' }
  html = <<~HTML
    <!DOCTYPE html>
    <html>
      <head>
        <title>Rack::MiniProfiler Help</title>
      </head>
      <body>
        <pre style='line-height: 30px; font-size: 16px'>
          This is the help menu of the <a href='#{Rack::MiniProfiler::SOURCE_CODE_URI}'>rack-mini-profiler</a> gem, append the following to your query string for more options:

          #{make_link "help", env} : display this screen
          #{make_link "env", env} : display the rack environment
          #{make_link "skip", env} : skip mini profiler for this request
          #{make_link "no-backtrace", env} #{"(*) " if client_settings.backtrace_none?}: don't collect stack traces from all the SQL executed (sticky, use #{@config.profile_parameter}=normal-backtrace to enable)
          #{make_link "normal-backtrace", env} #{"(*) " if client_settings.backtrace_default?}: collect stack traces from all the SQL executed and filter normally
          #{make_link "full-backtrace", env} #{"(*) " if client_settings.backtrace_full?}: enable full backtraces for SQL executed (use #{@config.profile_parameter}=normal-backtrace to disable)
          #{make_link "disable", env} : disable profiling for this session
          #{make_link "enable", env} : enable profiling for this session (if previously disabled)
          #{make_link "profile-gc", env} : perform gc profiling on this request, analyzes ObjectSpace generated by request
          #{make_link "profile-memory", env} : requires the memory_profiler gem, new location based report
          #{make_link "flamegraph", env} : a graph representing sampled activity (requires the stackprof gem).
          #{make_link "async-flamegraph", env} : store flamegraph data for this page and all its AJAX requests. Flamegraph links will be available in the mini-profiler UI (requires the stackprof gem).
          #{make_link "flamegraph&flamegraph_sample_rate=1", env}: creates a flamegraph with the specified sample rate (in ms). Overrides value set in config
          #{make_link "flamegraph&flamegraph_mode=cpu", env}: creates a flamegraph with the specified mode (one of cpu, wall, object, or custom). Overrides value set in config
          #{make_link "flamegraph&flamegraph_ignore_gc=true", env}: ignore garbage collection frames in flamegraphs. Overrides value set in config
          #{make_link "flamegraph_embed", env} : a graph representing sampled activity (requires the stackprof gem), embedded resources for use on an intranet.
          #{make_link "trace-exceptions", env} : will return all the spots where your application raises exceptions
          #{make_link "analyze-memory", env} : will perform basic memory analysis of heap

          All features can also be accessed by adding the X-Rack-Mini-Profiler header to the request, with any of the values above (e.g. 'X-Rack-Mini-Profiler: flamegraph')
        </pre>
      </body>
    </html>
  HTML

  [200, headers, [html]]
end

#make_link(postfix, env) ⇒ Object 



107
108
109
110
 
# File 'lib/mini_profiler/views.rb', line 107

def make_link(postfix, env)
  link = env["PATH_INFO"] + "?" + env["QUERY_STRING"].sub("#{@config.profile_parameter}=help", "#{@config.profile_parameter}=#{postfix}")
  "#{@config.profile_parameter}=<a href='#{ERB::Util.html_escape(link)}'>#{postfix}</a>"
end

#public_base_path(env) ⇒ Object 



193
194
195
 
# File 'lib/mini_profiler/views.rb', line 193

def public_base_path(env)
  "#{env['RACK_MINI_PROFILER_ORIGINAL_SCRIPT_NAME']}#{@config.base_url_path}"
end

#resources_root ⇒ Object 



5
6
7
 
# File 'lib/mini_profiler/views.rb', line 5

def resources_root
  @resources_root ||= ::File.expand_path("../../html", __FILE__)
end

#share_template ⇒ Object 



9
10
11
 
# File 'lib/mini_profiler/views.rb', line 9

def share_template
  @share_template ||= ERB.new(::File.read(::File.expand_path("../html/share.html", ::File.dirname(__FILE__))))
end

#url_for_snapshot(id, group_name) ⇒ Object 



188
189
190
191
 
# File 'lib/mini_profiler/views.rb', line 188

def url_for_snapshot(id, group_name)
  qs = Rack::Utils.build_query({ id: id, group: group_name })
  "/#{@config.base_url_path.gsub('/', '')}/results?#{qs}"
end

#url_for_snapshots_group(group_name) ⇒ Object 



183
184
185
186
 
# File 'lib/mini_profiler/views.rb', line 183

def url_for_snapshots_group(group_name)
  qs = Rack::Utils.build_query({ group_name: group_name })
  "/#{@config.base_url_path.gsub('/', '')}/snapshots?#{qs}"
end