Error handling

fabiotadashi · fabiotadashi · commit 4aeeada5fb7d · 2024-01-04T19:28:43.000-03:00
diff --git a/kotlin-ktor/build.gradle.kts b/kotlin-ktor/build.gradle.kts
@@ -20,6 +20,7 @@ dependencies {
     implementation("io.ktor", "ktor-server-core", ktorVersion)
     implementation("io.ktor", "ktor-server-netty", ktorVersion)
     implementation("io.ktor", "ktor-server-websockets", ktorVersion)
+    implementation("io.ktor","ktor-server-status-pages", ktorVersion)
 
     implementation("io.ktor", "ktor-server-thymeleaf-jvm", ktorVersion)
     implementation("ch.qos.logback","logback-classic", logbackVersion)
diff --git a/kotlin-ktor/src/main/java/com/baeldung/thymeleaf/server/ThymeleafKtorApplication.kt b/kotlin-ktor/src/main/java/com/baeldung/thymeleaf/server/ThymeleafKtorApplication.kt
@@ -1,6 +1,7 @@
 package com.baeldung.thymeleaf.server
 
 import com.baeldung.thymeleaf.server.plugins.configureRouting
+import com.baeldung.thymeleaf.server.plugins.configureStatusPages
 import com.baeldung.thymeleaf.server.plugins.configureTemplating
 import io.ktor.server.engine.*
 import io.ktor.server.netty.*
@@ -9,5 +10,6 @@ fun main() {
     embeddedServer(Netty, port = 8080, host = "0.0.0.0") {
         configureTemplating()
         configureRouting()
+        configureStatusPages()
     }.start(wait = true)
 }
diff --git a/kotlin-ktor/src/main/java/com/baeldung/thymeleaf/server/plugins/StatusPages.kt b/kotlin-ktor/src/main/java/com/baeldung/thymeleaf/server/plugins/StatusPages.kt
@@ -0,0 +1,15 @@
+package com.baeldung.thymeleaf.server.plugins
+
+import io.ktor.http.*
+import io.ktor.server.application.*
+import io.ktor.server.plugins.statuspages.*
+import io.ktor.server.response.*
+import io.ktor.server.thymeleaf.*
+
+fun Application.configureStatusPages() {
+    install(StatusPages) {
+        status(HttpStatusCode.NotFound) { call, _ ->
+            call.respond(ThymeleafContent("error404", mapOf("message" to "Sorry! Page was not found.")))
+        }
+    }
+}
diff --git a/kotlin-ktor/src/main/resources/templates/error404.html b/kotlin-ktor/src/main/resources/templates/error404.html
@@ -0,0 +1,20 @@
+<!DOCTYPE html >
+<html xmlns:th="http://www.thymeleaf.org">
+    <head>
+        <meta charset="UTF-8">
+        <title>Error</title>
+        <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/css/bootstrap.min.css"
+              rel="stylesheet"
+              integrity="sha384-T3c6CoIi6uLrA9TneNEoa7RxnatzjcDSCmG1MXxSR1GAsXEV/Dwwykc2MPK8M2HN"
+              crossorigin="anonymous">
+    </head>
+    <body>
+    <div class="container">
+       <h2>Error</h2>
+       <p th:text="${message}" />
+    </div>
+    <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"
+            integrity="sha384-C6RzsynM9kWDrMNeT87bh95OGNyZPhcTNXj1NW7RuBCsyN/o0jlpcV8Qyq46cDfL"
+            crossorigin="anonymous"/>
+    </body>
+</html>
diff --git a/kotlin-ktor/src/test/java/com/baeldung/thymeleaf/server/ThymeleafServerIntegrationTest.kt b/kotlin-ktor/src/test/java/com/baeldung/thymeleaf/server/ThymeleafServerIntegrationTest.kt
@@ -1,7 +1,7 @@
 package com.baeldung.thymeleaf.server
 
-import com.baeldung.graphql.client.GraphQLClient
 import com.baeldung.thymeleaf.server.plugins.configureRouting
+import com.baeldung.thymeleaf.server.plugins.configureStatusPages
 import com.baeldung.thymeleaf.server.plugins.configureTemplating
 import io.ktor.server.engine.*
 import io.ktor.server.netty.*
@@ -27,6 +27,7 @@ class ThymeleafServerIntegrationTest {
                 module {
                     configureRouting()
                     configureTemplating()
+                    configureStatusPages()
                 }
                 connector {
                     host = "0.0.0.0"
@@ -76,4 +77,15 @@ class ThymeleafServerIntegrationTest {
         driver.close()
     }
 
+    @Test
+    fun `when get an invalid route then should return a default error page`() {
+        val options = ChromeOptions()
+        options.addArguments("--headless=new");
+        val driver = ChromeDriver(options)
+        driver.get("http://0.0.0.0:8080/other-page")
+        val header2 = driver.findElements(By.tagName("h2"))
+        assertEquals("Error", header2.first().text)
+        driver.close()
+    }
+
 }
