feat(public): add status page (#61)

* add status page which shows if the server can operate normaly or if the database connection is broken

Closes: #26

Co-authored-by: Stefan Jacobi <[email protected]>

server/api/handler/status.go

@@ -0,0 +1,29 @@
+package handler
+
+import (
+	"github.com/labstack/echo/v4"
+	"github.com/teamhanko/passkey-server/persistence"
+	"net/http"
+)
+
+type StatusHandler interface {
+	Get(ctx echo.Context) error
+}
+
+type statusHandler struct {
+	persister persistence.Persister
+}
+
+func NewStatusHandler(persister persistence.Persister) StatusHandler {
+	return &statusHandler{persister: persister}
+}
+
+func (sh *statusHandler) Get(ctx echo.Context) error {
+	// random query to check DB connectivity
+	_, err := sh.persister.GetJwkPersister(nil).GetAll()
+	if err != nil {
+		return ctx.Render(http.StatusInternalServerError, "status", map[string]bool{"dbError": true})
+	}
+
+	return ctx.Render(http.StatusOK, "status", nil)
+}

server/api/router/main.go

@@ -35,6 +35,9 @@ func NewMainRouter(cfg *config.Config, persister persistence.Persister, authenti
 	// Validator
 	main.Validator = validators.NewCustomValidator()
 
+	statusHandler := handler.NewStatusHandler(persister)
+	main.GET("/", statusHandler.Get)
+
 	rootGroup := main.Group("/:tenant_id", passkeyMiddleware.TenantMiddleware(persister))
 	tenantGroup := rootGroup.Group(
 		"",

server/api/template/templates/status.tmpl

@@ -10,7 +10,7 @@
 <p>❌ API is not functioning properly due to database connectivity problems.</p>
 {{else}}
 <p>✅ API is running.</p>
-<p>Check integration guides on <a href="https://docs.hanko.io" target="_blank">docs.hanko.io</a></p>
+<p>Check integration guides on <a href="https://docs.hanko.io/passkey-api/introduction" target="_blank">docs.hanko.io</a></p>
 {{end}}
 </body>
 </html>