Module: Roda::RodaPlugins::ExceptionPage

Defined in:
lib/roda/plugins/exception_page.rb

Overview

The exception_page plugin provides an exception_page method that is designed to be called inside the error handler to provide a page to the developer with debugging information. It should only be used in developer environments with trusted clients, as it can leak source code and other information that may be useful for attackers if used in other environments.

Example:

plugin :exception_page
plugin :error_handler do |e|
  next exception_page(e) if ENV['RACK_ENV'] == 'development'
  # ...
end

The exception_page plugin is based on Rack::ShowExceptions, with the following differences:

  • Not a middleware, so it doesn’t handle exceptions itself, and has no effect on the callstack unless the exception_page method is called.

  • Supports external javascript and stylesheets, allowing context toggling to work in applications that use a content security policy to restrict inline javascript and stylesheets (:assets, :css_file, and :js_file options).

  • Has fewer dependencies (does not require ostruct and erb).

  • Sets the Content-Type for the response, and returns the body string, but does not modify other headers or the response status.

  • Supports a configurable amount of context lines in backtraces (:context option).

  • Supports optional JSON formatted output, if used with the json plugin (:json option).

To use the external javascript and stylesheets, you can call r.exception_page_assets in your routing tree:

route do |r|
  # ...

  # serve GET /exception_page.{css,js} requests
  # Use with assets: true +exception_page+ option
  r.exception_page_assets

  r.on "static" do
    # serve GET /static/exception_page.{css,js} requests
    # Use with assets: '/static' +exception_page+ option
    r.exception_page_assets
  end
end

It’s also possible to store the asset information in static files and serve those, you can get the current assets by calling:

Roda::RodaPlugins::ExceptionPage.css
Roda::RodaPlugins::ExceptionPage.js

As the exception_page plugin is based on Rack::ShowExceptions, it is also under rack’s license:

Copyright © 2007-2018 Christian Neukirchen <chneukirchen.org/infopage.html>

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 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.

The HTML template used in Rack::ShowExceptions was based on Django’s template and is under the following license:

adapted from Django <www.djangoproject.com> Copyright © Django Software Foundation and individual contributors. Used under the modified BSD license: www.xfree86.org/3.3.6/COPYRIGHT2.html#5

Defined Under Namespace

Modules: InstanceMethods, RequestMethods

Class Method Summary collapse

Class Method Details

.css ⇒ Object

Stylesheet used by the HTML exception page



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
 
# File 'lib/roda/plugins/exception_page.rb', line 92

def self.css
  <<END
html * { padding:0; margin:0; }
body * { padding:10px 20px; }
body * * { padding:0; }
body { font:small sans-serif; }
body>div { border-bottom:1px solid #ddd; }
h1 { font-weight:normal; }
h2 { margin-bottom:.8em; }
h2 span { font-size:80%; color:#666; font-weight:normal; }
h3 { margin:1em 0 .5em 0; }
h4 { margin:0 0 .5em 0; font-weight: normal; }
table {
    border:1px solid #ccc; border-collapse: collapse; background:white; }
tbody td, tbody th { vertical-align:top; padding:2px 3px; }
thead th {
    padding:1px 6px 1px 3px; background:#fefefe; text-align:left;
    font-weight:normal; font-size:11px; border:1px solid #ddd; }
tbody th { text-align:right; color:#666; padding-right:.5em; }
table.vars { margin:5px 0 2px 40px; }
table.vars td, table.req td { font-family:monospace; }
table td.code { width:100%;}
table td.code div { overflow:hidden; }
table.source th { color:#666; }
table.source td {
    font-family:monospace; white-space:pre; border-bottom:1px solid #eee; }
ul.traceback { list-style-type:none; }
ul.traceback li.frame { margin-bottom:1em; }
div.context { margin: 10px 0; }
div.context ol {
    padding-left:30px; margin:0 10px; list-style-position: inside; }
div.context ol li {
    font-family:monospace; white-space:pre; color:#666; cursor:pointer; }
div.context ol.context-line li { color:black; background-color:#ccc; }
div.context ol.context-line li span { float: right; }
div.commands { margin-left: 40px; }
div.commands a { color:black; text-decoration:none; }
#summary { background: #ffc; }
#summary h2 { font-weight: normal; color: #666; font-family: monospace; white-space: pre-wrap;}
#summary ul#quicklinks { list-style-type: none; margin-bottom: 2em; }
#summary ul#quicklinks li { float: left; padding: 0 1em; }
#summary ul#quicklinks>li+li { border-left: 1px #666 solid; }
#explanation { background:#eee; }
#traceback { background:#eee; }
#requestinfo { background:#f6f6f6; padding-left:120px; }
#summary table { border:none; background:transparent; }
#requestinfo h2, #requestinfo h3 { position:relative; margin-left:-100px; }
#requestinfo h3 { margin-bottom:-1em; }
.error { background: #ffc; }
.specific { color:#cc3300; font-weight:bold; }
END
end

.js ⇒ Object

Javascript used by the HTML exception page for context toggling



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/roda/plugins/exception_page.rb', line 146

def self.js
  <<END
var contexts = document.getElementsByClassName('context');
var num_contexts = contexts.length;
function toggle() {
  for (var i = 0; i < arguments.length; i++) {
    var e = document.getElementById(arguments[i]);
    if (e) {
e.style.display = e.style.display == 'none' ? 'block' : 'none';
    }
  }
  return false;
}
for (var j = 0; j < num_contexts; j++) {
  contexts[j].onclick = function(){toggle('b'+this.id, 'a'+this.id);}
  contexts[j].onclick();
}
END
end

.load_dependencies(app) ⇒ Object 



87
88
89
 
# File 'lib/roda/plugins/exception_page.rb', line 87

def self.load_dependencies(app)
  app.plugin :h
end