handle api 404 errors (#388)

Author: zupzup

src/web/handlers/mod.rs

@@ -1,6 +1,9 @@
-use super::data::{
-    BalanceResponse, CurrenciesResponse, CurrencyResponse, GeneralSearchFilterPayload,
-    GeneralSearchResponse, OverviewBalanceResponse, OverviewResponse,
+use super::{
+    data::{
+        BalanceResponse, CurrenciesResponse, CurrencyResponse, GeneralSearchFilterPayload,
+        GeneralSearchResponse, OverviewBalanceResponse, OverviewResponse,
+    },
+    ErrorResponse,
 };
 use crate::{
     constants::VALID_CURRENCIES,
@@ -9,7 +12,7 @@ use crate::{
 };
 use bill::get_current_identity_node_id;
 use rocket::{fs::NamedFile, get, post, serde::json::Json, Shutdown, State};
-use std::path::Path;
+use std::path::{Path, PathBuf};
 
 pub mod bill;
 pub mod company;
@@ -19,13 +22,24 @@ pub mod middleware;
 pub mod notifications;
 pub mod quotes;
 
+// Lowest prio, fall back to index.html if nothing matches
 #[get("/<_..>", rank = 10)]
 pub async fn serve_frontend() -> Option<NamedFile> {
     NamedFile::open(Path::new(&CONFIG.frontend_serve_folder).join("index.html"))
         .await
         .ok()
 }
 
+// Higher prio than file server and index.html fallback
+#[get("/<path..>", rank = 3)]
+pub async fn default_api_error_catcher(path: PathBuf) -> Json<ErrorResponse> {
+    Json(ErrorResponse::new(
+        "not_found",
+        format!("We couldn't find the requested path '{}'", path.display()),
+        404,
+    ))
+}
+
 #[get("/")]
 pub async fn exit(shutdown: Shutdown, state: &State<ServiceContext>) {
     log::info!("Exit called - shutting down...");

src/web/mod.rs

@@ -1,7 +1,7 @@
 use crate::service::ServiceContext;
 use api_docs::ApiDocs;
 use log::info;
-use rocket::http::{Method, Status};
+use rocket::http::Method;
 use rocket::{catch, catchers, routes, Build, Config, Request, Rocket};
 use rocket_cors::{AllowedHeaders, AllowedOrigins, CorsOptions};
 use serde::Serialize;
@@ -75,8 +75,10 @@ pub fn rocket_main(context: ServiceContext) -> Rocket<Build> {
 
     let rocket = rocket::custom(config)
         .attach(cors.clone())
+        // catchers for CORS and API errors
         .mount("/api/", rocket_cors::catch_all_options_routes())
-        .register("/", catchers![default_catcher, not_found])
+        .mount("/api/", routes![handlers::default_api_error_catcher])
+        .register("/api/", catchers![not_found])
         .manage(context)
         .manage(cors)
         .mount("/api/exit", routes![handlers::exit])
@@ -179,14 +181,15 @@ pub fn rocket_main(context: ServiceContext) -> Rocket<Build> {
             ],
         )
         .mount(
-            "/api/",
-            SwaggerUi::new("/swagger-ui/<_..>").url("/api-docs/openapi.json", ApiDocs::openapi()),
+            "/",
+            SwaggerUi::new("/api/swagger-ui/<_..>")
+                .url("/api/api-docs/openapi.json", ApiDocs::openapi()),
         )
+        // Routes for the frontend - lower rank means higher prio
         .mount(
             &CONFIG.frontend_url_path,
             FileServer::from(&CONFIG.frontend_serve_folder).rank(5),
         )
-        // TODO: fall back to index, but serve static files first
         .mount(&CONFIG.frontend_url_path, routes![handlers::serve_frontend]);
 
     info!("HTTP Server Listening on {}", conf.http_listen_url());
@@ -205,17 +208,8 @@ pub fn rocket_main(context: ServiceContext) -> Rocket<Build> {
     rocket
 }
 
-#[catch(default)]
-pub fn default_catcher(status: Status, _req: &Request) -> Json<ErrorResponse> {
-    Json(ErrorResponse::new(
-        "error",
-        status.reason().unwrap_or("Unknown error").to_string(),
-        status.code,
-    ))
-}
-
 #[catch(404)]
-pub fn not_found(req: &Request) -> Json<ErrorResponse> {
+fn not_found(req: &Request) -> Json<ErrorResponse> {
     Json(ErrorResponse::new(
         "not_found",
         format!("We couldn't find the requested path '{}'", req.uri()),