SimpleCloudNotifier/scnserver/api/handler/common.go

213 lines
5.3 KiB
Go
Raw Normal View History

2022-11-13 19:17:07 +01:00
package handler
import (
2022-11-23 20:21:49 +01:00
"blackforestbytes.com/simplecloudnotifier/api/apierr"
2022-12-20 13:55:09 +01:00
"blackforestbytes.com/simplecloudnotifier/api/ginresp"
2022-11-13 19:17:07 +01:00
"blackforestbytes.com/simplecloudnotifier/logic"
"bytes"
2022-11-24 12:53:27 +01:00
"context"
2022-11-23 19:32:23 +01:00
"errors"
2022-11-13 19:17:07 +01:00
"github.com/gin-gonic/gin"
sqlite3 "github.com/mattn/go-sqlite3"
2022-11-24 12:53:27 +01:00
"gogs.mikescher.com/BlackForestBytes/goext/langext"
2022-11-23 20:21:49 +01:00
"gogs.mikescher.com/BlackForestBytes/goext/timeext"
2022-11-13 19:17:07 +01:00
"net/http"
2022-11-23 20:21:49 +01:00
"time"
2022-11-13 19:17:07 +01:00
)
type CommonHandler struct {
app *logic.Application
}
func NewCommonHandler(app *logic.Application) CommonHandler {
return CommonHandler{
app: app,
}
}
type pingResponse struct {
Message string `json:"message"`
Info pingResponseInfo `json:"info"`
}
type pingResponseInfo struct {
Method string `json:"method"`
Request string `json:"request"`
Headers map[string][]string `json:"headers"`
URI string `json:"uri"`
Address string `json:"addr"`
}
// Ping swaggerdoc
//
2022-11-23 19:32:23 +01:00
// @Summary Simple endpoint to test connection (any http method)
// @Tags Common
//
2022-11-13 19:17:07 +01:00
// @Success 200 {object} pingResponse
2022-11-18 21:25:40 +01:00
// @Failure 500 {object} ginresp.apiError
2022-11-23 19:32:23 +01:00
//
// @Router /api/ping [get]
// @Router /api/ping [post]
// @Router /api/ping [put]
// @Router /api/ping [delete]
// @Router /api/ping [patch]
2022-11-13 19:17:07 +01:00
func (h CommonHandler) Ping(g *gin.Context) ginresp.HTTPResponse {
buf := new(bytes.Buffer)
_, _ = buf.ReadFrom(g.Request.Body)
resuestBody := buf.String()
return ginresp.JSON(http.StatusOK, pingResponse{
Message: "Pong",
Info: pingResponseInfo{
Method: g.Request.Method,
Request: resuestBody,
Headers: g.Request.Header,
URI: g.Request.RequestURI,
Address: g.Request.RemoteAddr,
},
})
}
// DatabaseTest swaggerdoc
//
// @Summary Check for a working database connection
2022-11-23 19:32:23 +01:00
// @ID api-common-dbtest
// @Tags Common
//
2022-11-13 19:17:07 +01:00
// @Success 200 {object} handler.DatabaseTest.response
2022-11-18 21:25:40 +01:00
// @Failure 500 {object} ginresp.apiError
2022-11-23 19:32:23 +01:00
//
2022-11-24 12:53:27 +01:00
// @Router /api/db-test [post]
2022-11-13 19:17:07 +01:00
func (h CommonHandler) DatabaseTest(g *gin.Context) ginresp.HTTPResponse {
type response struct {
Success bool `json:"success"`
LibVersion string `json:"libVersion"`
LibVersionNumber int `json:"libVersionNumber"`
SourceID string `json:"sourceID"`
}
ctx, cancel := context.WithTimeout(context.Background(), 2*time.Second)
defer cancel()
2022-11-13 19:17:07 +01:00
libVersion, libVersionNumber, sourceID := sqlite3.Version()
err := h.app.Database.Ping(ctx)
2022-11-13 19:17:07 +01:00
if err != nil {
return ginresp.InternalError(err)
}
return ginresp.JSON(http.StatusOK, response{
Success: true,
LibVersion: libVersion,
LibVersionNumber: libVersionNumber,
SourceID: sourceID,
})
}
// Health swaggerdoc
//
2022-11-23 19:32:23 +01:00
// @Summary Server Health-checks
// @ID api-common-health
// @Tags Common
//
2022-11-13 19:17:07 +01:00
// @Success 200 {object} handler.Health.response
2022-11-18 21:25:40 +01:00
// @Failure 500 {object} ginresp.apiError
2022-11-23 19:32:23 +01:00
//
// @Router /api/health [get]
2022-11-23 20:21:49 +01:00
func (h CommonHandler) Health(g *gin.Context) ginresp.HTTPResponse {
2022-11-13 19:17:07 +01:00
type response struct {
Status string `json:"status"`
}
2022-11-23 19:32:23 +01:00
2022-11-24 12:53:27 +01:00
ctx, cancel := context.WithTimeout(context.Background(), 2*time.Second)
defer cancel()
2022-11-23 19:32:23 +01:00
_, libVersionNumber, _ := sqlite3.Version()
if libVersionNumber < 3039000 {
return ginresp.InternalError(errors.New("sqlite version too low"))
2022-11-23 19:32:23 +01:00
}
err := h.app.Database.Ping(ctx)
2022-11-23 19:32:23 +01:00
if err != nil {
return ginresp.InternalError(err)
}
2022-11-24 12:53:27 +01:00
uuidKey, _ := langext.NewHexUUID()
uuidWrite, _ := langext.NewHexUUID()
err = h.app.Database.WriteMetaString(ctx, uuidKey, uuidWrite)
if err != nil {
return ginresp.InternalError(err)
}
uuidRead, err := h.app.Database.ReadMetaString(ctx, uuidKey)
if err != nil {
return ginresp.InternalError(err)
}
if uuidRead == nil || uuidWrite != *uuidRead {
return ginresp.InternalError(errors.New("writing into DB was not consistent"))
}
err = h.app.Database.DeleteMeta(ctx, uuidKey)
if err != nil {
return ginresp.InternalError(err)
}
2022-11-13 19:17:07 +01:00
return ginresp.JSON(http.StatusOK, response{Status: "ok"})
}
2022-11-18 21:25:40 +01:00
2022-11-23 20:21:49 +01:00
// Sleep swaggerdoc
//
// @Summary Return 200 after x seconds
// @ID api-common-sleep
// @Tags Common
//
2022-11-23 22:12:47 +01:00
// @Param secs path number true "sleep delay (in seconds)"
//
// @Success 200 {object} handler.Sleep.response
// @Failure 400 {object} ginresp.apiError
// @Failure 500 {object} ginresp.apiError
2022-11-23 20:21:49 +01:00
//
// @Router /api/sleep/{secs} [post]
func (h CommonHandler) Sleep(g *gin.Context) ginresp.HTTPResponse {
type uri struct {
Seconds float64 `uri:"secs"`
}
type response struct {
Start string `json:"start"`
End string `json:"end"`
Duration float64 `json:"duration"`
}
t0 := time.Now().Format(time.RFC3339Nano)
var u uri
if err := g.ShouldBindUri(&u); err != nil {
return ginresp.APIError(g, 400, apierr.BINDFAIL_URI_PARAM, "Failed to read uri", err)
}
time.Sleep(timeext.FromSeconds(u.Seconds))
2022-11-23 20:21:49 +01:00
t1 := time.Now().Format(time.RFC3339Nano)
return ginresp.JSON(http.StatusOK, response{
Start: t0,
End: t1,
Duration: u.Seconds,
})
}
2022-11-18 21:25:40 +01:00
func (h CommonHandler) NoRoute(g *gin.Context) ginresp.HTTPResponse {
return ginresp.JSON(http.StatusNotFound, gin.H{
2022-11-23 19:32:23 +01:00
"": "================ ROUTE NOT FOUND ================",
2022-11-18 21:25:40 +01:00
"FullPath": g.FullPath(),
"Method": g.Request.Method,
"URL": g.Request.URL.String(),
"RequestURI": g.Request.RequestURI,
"Proto": g.Request.Proto,
"Header": g.Request.Header,
2022-11-23 19:32:23 +01:00
"~": "================ ROUTE NOT FOUND ================",
2022-11-18 21:25:40 +01:00
})
}