From b409cdece5d4cc3e4f19235c117fb0f39f5a3c16 Mon Sep 17 00:00:00 2001 From: saltycrys <73420320+saltycrys@users.noreply.github.com> Date: Tue, 1 Dec 2020 13:41:19 +0100 Subject: [PATCH] Improve error message 2 Electric Boogaloo The long backtrace has been moved into a `
` 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. --- src/invidious/helpers/errors.cr | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/src/invidious/helpers/errors.cr b/src/invidious/helpers/errors.cr index 68f7dd31b..4487ff8c5 100644 --- a/src/invidious/helpers/errors.cr +++ b/src/invidious/helpers/errors.cr @@ -10,16 +10,29 @@ macro error_template(*args) error_template_helper(env, config, locale, {{*args}}) end +def github_details(summary : String, content : String) + details = %(\n
) + details += %(\n#{summary}) + details += %(\n

) + details += %(\n \n```\n) + details += content.strip + details += %(\n```) + details += %(\n

) + details += %(\n
) + 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) if exception.is_a?(InfoException) return error_template_helper(env, config, locale, status_code, exception.message || "") end 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 += %(\nVersion: `#{SOFTWARE["version"]} @ #{SOFTWARE["branch"]}`) - # issue_template += %(\nPreferences: ```#{env.get("preferences").as(Preferences).to_json}```) - issue_template += %(\nBacktrace: \n```\n#{exception.inspect_with_backtrace}```) + # issue_template += github_details("Preferences", env.get("preferences").as(Preferences).to_pretty_json) + issue_template += github_details("Backtrace", exception.inspect_with_backtrace) error_message = <<-END_HTML Looks like you've found a bug in Invidious. Please open a new issue on GitHub