feat(bug): Improve bug reporting while keeping logs private

redlib-org · Jun 19, 2024 · 997cd8f · 997cd8f
1 parent 5a13b98
commit 997cd8f
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 13 deletions.
diff --git a/src/client.rs b/src/client.rs
@@ -314,9 +314,9 @@ fn request(method: &'static Method, path: String, redirect: bool, quarantine: bo
 #[cached(size = 100, time = 30, result = true)]
 pub async fn json(path: String, quarantine: bool) -> Result<Value, String> {
 	// Closure to quickly build errors
-	let err = |msg: &str, e: String| -> Result<Value, String> {
+	let err = |msg: &str, e: String, path: String| -> Result<Value, String> {
 		// eprintln!("{} - {}: {}", url, msg, e);
-		Err(format!("{msg}: {e}"))
+		Err(format!("{msg}: {e} | {path}"))
 	};
 
 	// Fetch the url...
@@ -339,7 +339,7 @@ pub async fn json(path: String, quarantine: bool) -> Result<Value, String> {
 									let () = force_refresh_token().await;
 									return Err("OAuth token has expired. Please refresh the page!".to_string());
 								}
-								Err(format!("Reddit error {} \"{}\": {}", json["error"], json["reason"], json["message"]))
+								Err(format!("Reddit error {} \"{}\": {} | {path}", json["error"], json["reason"], json["message"]))
 							} else {
 								Ok(json)
 							}
@@ -349,15 +349,15 @@ pub async fn json(path: String, quarantine: bool) -> Result<Value, String> {
 							if status.is_server_error() {
 								Err("Reddit is having issues, check if there's an outage".to_string())
 							} else {
-								err("Failed to parse page JSON data", e.to_string())
+								err("Failed to parse page JSON data", e.to_string(), path)
 							}
 						}
 					}
 				}
-				Err(e) => err("Failed receiving body from Reddit", e.to_string()),
+				Err(e) => err("Failed receiving body from Reddit", e.to_string(), path),
 			}
 		}
-		Err(e) => err("Couldn't send request to Reddit", e),
+		Err(e) => err("Couldn't send request to Reddit", e, path),
 	}
 }
 

diff --git a/src/utils.rs b/src/utils.rs
@@ -1029,7 +1029,7 @@ pub fn redirect(path: &str) -> Response<Body> {
 
 /// Renders a generic error landing page.
 pub async fn error(req: Request<Body>, msg: &str) -> Result<Response<Body>, String> {
-	error!("Error page rendered: {msg}");
+	error!("Error page rendered: {}", msg.split("|").next().unwrap_or_default());
 	let url = req.uri().to_string();
 	let body = ErrorTemplate {
 		msg: msg.to_string(),

diff --git a/templates/error.html b/templates/error.html
@@ -2,10 +2,14 @@
 {% block title %}Error: {{ msg }}{% endblock %}
 {% block sortstyle %}{% endblock %}
 {% block content %}
-	<div id="error">
-		<h1>{{ msg }}</h1>
-		<h3><a href="https://www.redditstatus.com/">Reddit Status</a></h3>
-		<br />
-		<h3>Head back <a href="/">home</a>?</h3>
-	</div>
+<div id="error">
+	<h1>{{ msg }}</h1>
+	<h3><a href="https://www.redditstatus.com/">Reddit Status</a></h3>
+	<br />
+	<h3>Expected something to work? <a
+			href="https://github.com/redlib-org/redlib/issues/new?assignees=&labels=bug&projects=&template=bug_report.md&title=%F0%9F%90%9B+Bug+Report%3A+{{ msg }}">Report
+			an issue</a></h3>
+	<br />
+	<h3>Head back <a href="/">home</a>?</h3>
+</div>
 {% endblock %}