ProjectSegfault/invidious-experimenting
4
0
Fork 0
forked from midou/invidious
Code Pull Requests Activity

Improve error message 2

Browse Source 
Electric Boogaloo

The long backtrace has been moved into a `<details>` HTML element, as suggested
by @B0pol. To make the error still visible it has been added to the top under
`Title:`. This also encourages informative issue titles.
This commit is contained in:
saltycrys 2020-12-01 13:41:19 +01:00
parent 2478e67d16
commit b409cdece5
1 changed files with 16 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/invidious/helpers/errors.cr
View File

@ -10,16 +10,29 @@ macro error_template(*args)
error_template_helper(env, config, locale, {{*args}}) error_template_helper(env, config, locale, {{*args}})
end end
def github_details(summary : String, content : String)
details = %(\n<details>)
details += %(\n<summary>#{summary}</summary>)
details += %(\n<p>)
details += %(\n \n```\n)
details += content.strip
details += %(\n```)
details += %(\n</p>)
details += %(\n</details>)
return HTML.escape(details)
end
def error_template_helper(env : HTTP::Server::Context, config : Config, locale : Hash(String, JSON::Any) | Nil, status_code : Int32, exception : Exception) def error_template_helper(env : HTTP::Server::Context, config : Config, locale : Hash(String, JSON::Any) | Nil, status_code : Int32, exception : Exception)
if exception.is_a?(InfoException) if exception.is_a?(InfoException)
return error_template_helper(env, config, locale, status_code, exception.message || "") return error_template_helper(env, config, locale, status_code, exception.message || "")
end end
env.response.status_code = status_code env.response.status_code = status_code
issue_template = %(Date: `#{Time::Format::ISO_8601_DATE_TIME.format(Time.utc)}`) issue_template = %(Title: `#{exception.message} (#{exception.class})`)
issue_template += %(\nDate: `#{Time::Format::ISO_8601_DATE_TIME.format(Time.utc)}`)
issue_template += %(\nRoute: `#{env.request.resource}`) issue_template += %(\nRoute: `#{env.request.resource}`)
issue_template += %(\nVersion: `#{SOFTWARE["version"]} @ #{SOFTWARE["branch"]}`) issue_template += %(\nVersion: `#{SOFTWARE["version"]} @ #{SOFTWARE["branch"]}`)
# issue_template += %(\nPreferences: ```#{env.get("preferences").as(Preferences).to_json}```) # issue_template += github_details("Preferences", env.get("preferences").as(Preferences).to_pretty_json)
issue_template += %(\nBacktrace: \n```\n#{exception.inspect_with_backtrace}```) issue_template += github_details("Backtrace", exception.inspect_with_backtrace)
error_message = <<-END_HTML error_message = <<-END_HTML
Looks like you've found a bug in Invidious. Please open a new issue Looks like you've found a bug in Invidious. Please open a new issue
<a href="https://github.com/iv-org/invidious/issues">on GitHub</a> <a href="https://github.com/iv-org/invidious/issues">on GitHub</a>