Merge pull request #38 from mkantor/better-bug-message

Improve error messages for Operator bugs.

Author: mkantor

src/content/content_directory.rs

@@ -1,4 +1,5 @@
 use super::Route;
+use crate::bug_message;
 use std::env;
 use std::fs::File;
 use std::os::unix::fs::PermissionsExt;
@@ -210,10 +211,12 @@ impl ContentFile {
             route_string.push(Self::PATH_SEPARATOR);
             route_string.push_str(relative_path_without_extensions);
 
-            route_string.parse::<Route>().map_err(|error| ContentFileError(format!(
-                "You've encountered a bug! This should never happen: Could not create route from path: {}",
-                error
-            )))
+            route_string.parse::<Route>().map_err(|error| {
+                ContentFileError(format!(
+                    bug_message!("This should never happen: Could not create route from path: {}"),
+                    error,
+                ))
+            })
         }?;
 
         Ok(ContentFile {

src/content/content_engine.rs

@@ -4,6 +4,7 @@ use super::content_item::*;
 use super::content_registry::*;
 use super::handlebars_helpers::*;
 use super::*;
+use crate::bug_message;
 use handlebars::{self, Handlebars};
 use mime_guess::MimeGuess;
 use std::collections::hash_map::Entry;
@@ -53,7 +54,7 @@ pub enum ContentLoadingError {
         source: ContentIndexUpdateError,
     },
 
-    #[error("You've encountered a bug! This should never happen: {}", .0)]
+    #[error("{} This should never happen: {}", bug_message!(), .0)]
     Bug(String),
 }
 

src/content/mod.rs

@@ -9,6 +9,7 @@ mod mime;
 mod route;
 mod test_lib;
 
+use crate::bug_message;
 use bytes::Bytes;
 use content_index::ContentIndex;
 use content_item::RenderingFailedError;
@@ -58,7 +59,7 @@ pub enum RenderError {
     #[error("The requested content cannot be rendered as an acceptable media type.")]
     CannotProvideAcceptableMediaType,
 
-    #[error("You've encountered a bug! This should never happen: {}", .0)]
+    #[error("{} This should never happen: {}", bug_message!(), .0)]
     Bug(String),
 }
 

src/http.rs

@@ -98,17 +98,16 @@ where
         let media_range_from_url = MimeGuess::from_path(path).first();
         let path_without_extension = if media_range_from_url.is_some() {
             // Drop the extension from the path.
-            path.rsplitn(2, '.').last().expect(
-                "You've encountered a bug! This should never happen: Calling rsplitn(2, ..) on \
-                a non-empty string returned an empty iterator. This should be impossible!",
-            )
+            path.rsplitn(2, '.').last().expect(bug_message!(
+                "Calling rsplitn(2, ..) on a non-empty string returned an empty iterator. This should be impossible!",
+            ))
         } else {
             path
         };
 
         match path_without_extension.parse::<Route>() {
             Err(error) => panic!(
-                "You've encountered a bug! This should never happen: HTTP request path could not be parsed into a Route: {}",
+                bug_message!("This should never happen: HTTP request path could not be parsed into a Route: {}"),
                 error,
             ),
             Ok(request_route) => {
@@ -266,9 +265,10 @@ where
 {
     let error_code = if !status_code.is_client_error() && !status_code.is_server_error() {
         log::error!(
-            "You've encountered a bug! This should never happen: \
-            The HTTP status code given to the error handler ({}) does not indicate an error.",
-            status_code
+            bug_message!(
+                "This should never happen: The HTTP status code given to the error handler ({}) does not indicate an error.",
+            ),
+            status_code,
         );
         http::StatusCode::INTERNAL_SERVER_ERROR
     } else {

src/lib.rs

@@ -12,3 +12,13 @@ pub struct ServerVersion(pub &'static str);
 pub struct ServerInfo {
     pub version: ServerVersion,
 }
+
+#[macro_export]
+macro_rules! bug_message {
+    () => {
+        "You've encountered a bug in Operator! Please open an issue at <https://github.com/mkantor/operator/issues>."
+    };
+    ($detail:expr$(,)?) => {
+        concat!(bug_message!(), " ", $detail)
+    };
+}