Add fallback html responses for unhandled routes

tpoliaw · tpoliaw · commit 7dda925ce9c0 · 2025-01-16T15:32:27.000Z
Makes it look less like something has gone wrong when visiting the site
from a browser.
diff --git a/Dockerfile b/Dockerfile
@@ -14,6 +14,7 @@ COPY ./.env ./.env
 COPY ./src ./src
 COPY ./.sqlx ./.sqlx
 COPY ./migrations ./migrations
+COPY ./static ./static
 
 RUN cargo build --release --target x86_64-unknown-linux-musl
 
diff --git a/src/graphql.rs b/src/graphql.rs
@@ -30,6 +30,7 @@ use async_graphql::{
 };
 use async_graphql_axum::{GraphQLRequest, GraphQLResponse};
 use auth::{AuthError, PolicyCheck};
+use axum::http::StatusCode;
 use axum::response::{Html, IntoResponse};
 use axum::routing::{get, post};
 use axum::{Extension, Json, Router};
@@ -75,7 +76,22 @@ pub async fn serve_graphql(db: &Path, opts: ServeOptions) {
         // making graphql queries
         .route("/status", get(server_status))
         .route("/graphql", post(graphql_handler))
+        // make it obvious that /graphql isn't expected to work when visiting from a browser
+        .route(
+            "/graphql",
+            get((
+                StatusCode::METHOD_NOT_ALLOWED,
+                [("Allow", "POST")],
+                Html(include_str!("../static/get_graphql_warning.html")),
+            )),
+        )
+        // Interactive graphiql playground
         .route("/graphiql", get(graphiql))
+        // Make it look less like something is broken when going to any other page
+        .fallback((
+            StatusCode::NOT_FOUND,
+            Html(include_str!("../static/404.html")),
+        ))
         .layer(Extension(schema));
     let listener = TcpListener::bind(addr)
         .await
diff --git a/static/404.html b/static/404.html
@@ -0,0 +1,14 @@
+<html>
+    <head>
+        <title>Numtracker</title>
+    </head>
+    <body>
+        <h1>Data Acquisition File Naming Service</h1>
+        <p>
+            Service is available at
+            <a href="/graphql">/graphql</a>.
+            Playground is available for testing at
+            <a href="/graphiql">/graphiql</a>
+        </p>
+    </body>
+</html>
diff --git a/static/get_graphql_warning.html b/static/get_graphql_warning.html
@@ -0,0 +1,8 @@
+<html>
+    <head>
+        <title>Numtracker</title>
+    </head>
+    <body>
+        <p>Requests should be made as graphql queries</p>
+    </body>
+</html>

-Original file line number
+Diff line change
@@ @@ -0,0 +1,8 @@ @@
 +<html>
 +    <head>
 +        <title>Numtracker</title>
 +    </head>
 +    <body>
 +        <p>Requests should be made as graphql queries</p>
 +    </body>
 +</html>