Merge health with api server

Protect health endpoint with Basic Auth credentials

.env.sample

@@ -7,3 +7,6 @@ POSTGRES_PASSWORD=
 SQLITE_FILE=beancount-bot-tg.sqlite
 
 BOT_API_KEY=
+
+MONITORING_USER=
+MONITORING_PASS=

Dockerfile

@@ -36,6 +36,5 @@ COPY --from=flutter_builder_web /api/ui/build/web /dist/api/ui/build/web
 COPY --from=golang_builder /src/app /dist/app
 
 EXPOSE 8080
-EXPOSE 8081
 
 ENTRYPOINT [ "/dist/app" ]

web/health/monitoring.go → api/health/monitoring.go

@@ -2,11 +2,11 @@ package health
 
 import (
 	"fmt"
-	"net/http"
 	"os"
 
 	"github.com/LucaBernstein/beancount-bot-tg/bot"
 	"github.com/LucaBernstein/beancount-bot-tg/helpers"
+	"github.com/gin-gonic/gin"
 )
 
 type MonitoringResult struct {
@@ -35,10 +35,10 @@ type MonitoringResult struct {
 
 // TODO: Use package?
 // https://pkg.go.dev/github.com/prometheus/client_golang/prometheus?utm_source=godoc#pkg-overview
-func MonitoringEndpoint(bc *bot.BotController) func(w http.ResponseWriter, r *http.Request) {
-	return func(w http.ResponseWriter, r *http.Request) {
+func MonitoringEndpoint(bc *bot.BotController) func(c *gin.Context) {
+	return func(c *gin.Context) {
 		m := gatherMetrics(bc)
-		fmt.Fprintf(w, `
+		fmt.Fprintf(c.Writer, `
 # HELP bc_bot_logs_daily Count of logs of specified type in the previous 24h
 # TYPE bc_bot_logs_daily gauge
 bc_bot_logs_daily{level="error"} %d

api/server.go

@@ -6,9 +6,11 @@ import (
 	"github.com/LucaBernstein/beancount-bot-tg/api/admin"
 	"github.com/LucaBernstein/beancount-bot-tg/api/config"
 	"github.com/LucaBernstein/beancount-bot-tg/api/suggestions"
+	"github.com/LucaBernstein/beancount-bot-tg/api/health"
 	"github.com/LucaBernstein/beancount-bot-tg/api/token"
 	"github.com/LucaBernstein/beancount-bot-tg/api/transactions"
 	"github.com/LucaBernstein/beancount-bot-tg/bot"
+	"github.com/LucaBernstein/beancount-bot-tg/helpers"
 	"github.com/gin-gonic/gin"
 	"github.com/mandrigin/gin-spa/spa"
 )
@@ -18,6 +20,10 @@ func StartWebServer(bc *bot.BotController) {
 	r.Use(gin.Recovery())
 	configureCors(r)
 
+	r.GET("/health", gin.BasicAuth(gin.Accounts{
+		helpers.EnvOrFb("MONITORING_USER", "beancount-bot-tg-health"): helpers.EnvOrFb("MONITORING_PASS", "this_service_should_be_healthy"),
+	}), health.MonitoringEndpoint(bc))
+
 	apiGroup := r.Group("/api")
 
 	tokenGroup := apiGroup.Group("/token")

main.go

@@ -4,7 +4,6 @@ import (
 	"github.com/LucaBernstein/beancount-bot-tg/api"
 	"github.com/LucaBernstein/beancount-bot-tg/bot"
 	"github.com/LucaBernstein/beancount-bot-tg/db"
-	"github.com/LucaBernstein/beancount-bot-tg/web"
 )
 
 func main() {
@@ -16,8 +15,6 @@ func main() {
 
 	go api.StartWebServer(bc)
 
-	go web.StartWebServer(bc)
-
 	bot := bot.CreateBot(bc)
 	bc.AddBotAndStart(bot)
 }

scenarioTests/steps/bot.py

@@ -105,7 +105,7 @@ async def step_impl(context, position, keyboardEntry):
 @when('I get the server endpoint "{endpoint}"')
 @async_run_until_complete
 async def step_impl(context, endpoint):
-    res = requests.get(url="http://localhost:8081"+endpoint, timeout=3)
+    res = requests.get(url="http://localhost:8080"+endpoint, timeout=3)
     context.body = res.text
 
 @then('the response body {shouldShouldNot} include "{include}"')