add healthcheck route

Makefile

@@ -1,7 +1,7 @@
 -include .env
 
 api/run:
-	go run ./cmd/api -foundry_pass=${FOUNDRY_PASS} -foundry_host=${FOUNDRY_HOST} -port=${LISTEN_PORT} -log_level=${LOG_LEVEL} -db-dsn=${DB_DSN}
+	go run ./cmd/api -foundry_pass=${FOUNDRY_PASS} -foundry_host=${FOUNDRY_HOST} -port=${LISTEN_PORT} -env=development -log_level=${LOG_LEVEL} -db-dsn=${DB_DSN}
 
 db/migration/new:
 	@echo 'Creating migration files for ${name}...'

cmd/api/errors.go

@@ -0,0 +1,24 @@
+package main
+
+import "net/http"
+
+func (app *application) logError(r *http.Request, err error) {
+	app.slogger.Error(err.Error(), "request_method", r.Method, "request_url", r.URL.String())
+}
+
+func (app *application) errorResponse(w http.ResponseWriter, r *http.Request, status int, message any) {
+	env := envelope{"error": message}
+
+	err := app.writeJSON(w, status, env, nil)
+	if err != nil {
+		app.logError(r, err)
+		w.WriteHeader(500)
+	}
+}
+
+func (app *application) serverErrorResponse(w http.ResponseWriter, r *http.Request, err error) {
+	app.logError(r, err)
+
+	message := "the server encountered a problem and could not process your request"
+	app.errorResponse(w, r, http.StatusInternalServerError, message)
+}

cmd/api/healthcheck.go

@@ -0,0 +1,21 @@
+package main
+
+import "net/http"
+
+func (app *application) healthcheckHandler(w http.ResponseWriter, r *http.Request) {
+	env := envelope{
+		"status": "available",
+		"system_info": map[string]string{
+			"environment": app.cfg.env,
+			"version":     version,
+		},
+		"foundry": map[string]any{
+			"status":       app.foundryApp.Status,
+			"is_available": app.foundryApp.IsAvailable,
+		},
+	}
+	err := app.writeJSON(w, http.StatusOK, env, nil)
+	if err != nil {
+		app.serverErrorResponse(w, r, err)
+	}
+}

cmd/api/helpers.go

@@ -0,0 +1,25 @@
+package main
+
+import (
+	"encoding/json"
+	"net/http"
+)
+
+type envelope map[string]any
+
+func (app *application) writeJSON(w http.ResponseWriter, status int, data envelope, headers http.Header) error {
+	js, err := json.MarshalIndent(data, "", "\t")
+	if err != nil {
+		return err
+	}
+	js = append(js, '\n')
+	for key, value := range headers {
+		w.Header()[key] = value
+	}
+
+	w.Header().Set("Content-Type", "application/json")
+	w.WriteHeader(status)
+	w.Write(js)
+
+	return nil
+}

cmd/api/main.go

@@ -6,7 +6,6 @@ import (
 	"flag"
 	"log"
 	"log/slog"
-	"net/http"
 	"os"
 	"time"
 
@@ -28,6 +27,7 @@ const (
 type config struct {
 	mode service_mode
 	port string
+	env  string
 
 	db struct {
 		dsn          string
@@ -44,6 +44,8 @@ type application struct {
 	logger     *log.Logger
 }
 
+var version = "0.1.0"
+
 func openDB(cfg config) (*sql.DB, error) {
 	db, err := sql.Open("sqlite3", cfg.db.dsn)
 	if err != nil {
@@ -72,6 +74,7 @@ func openDB(cfg config) (*sql.DB, error) {
 // TODO: change default values
 func (app *application) parseFlags() *requests.FoundryHttpRequest {
 	flag.StringVar(&app.cfg.port, "port", ":9090", "Service port")
+	flag.StringVar(&app.cfg.env, "env", "development", "Enivornment (development|staging|production)")
 
 	flag.StringVar(&app.cfg.db.dsn, "db-dsn", "file:db/default.db?cache=shared", "PostgreSQL DSN")
 	flag.IntVar(&app.cfg.db.maxOpenConns, "db-max-open-conns", 25, "PostgreSQL max open connections")
@@ -91,7 +94,6 @@ func (app *application) parseFlags() *requests.FoundryHttpRequest {
 	flag.Parse()
 
 	app.cfg.mode = service_mode(mode)
-	// app.foundryApp.SetConfig(&foundryConfig)
 
 	logLevel, ok := StringToLogLevel[logLevelStr]
 	if !ok {
@@ -105,19 +107,7 @@ func (app *application) parseFlags() *requests.FoundryHttpRequest {
 	return &foundryHttpData
 }
 
-// TODO: Handle application exit if wrong data
+// TODO: Handle grace application exit
-func (app *application) StartListenFoundry() {
-	var err error
-
-	for {
-		err = app.foundryApp.ConnectToWebSocket()
-		if err != nil {
-			app.slogger.Error("Error raised", "err", err.Error())
-			return
-		}
-	}
-}
-
 func main() {
 	app := application{foundryApp: &foundry.FoundryApi{}}
 
@@ -133,29 +123,8 @@ func main() {
 	defer db.Close()
 	app.slogger.Info("Database connection pool established")
 
-	app.foundryApp.Transport = transport.NewFoundryTransport(db, app.slogger, foundryHttpData)
+	app.foundryApp.SetTransport(transport.NewFoundryTransport(db, app.slogger, foundryHttpData))
-	go app.StartListenFoundry()
+	go app.foundryApp.StartListenFoundry()
 
-	errLog := slog.NewLogLogger(app.slogger.Handler(), slog.LevelError)
+	app.serve()
-	server := &http.Server{
-		Addr:     app.cfg.port,
-		Handler:  app.routes(),
-		ErrorLog: errLog,
-		// TLSConfig:    tlsConfig,
-		IdleTimeout:  time.Minute,
-		ReadTimeout:  5 * time.Second,
-		WriteTimeout: 10 * time.Second,
-	}
-
-	switch app.cfg.mode {
-	case API_MODE:
-		app.slogger.Info("Server is started", "port", app.cfg.port)
-		server.ListenAndServe()
-	case DISCORD_BOT_MODE:
-		app.slogger.Warn("TODO: implement this mode")
-	case TG_BOT_MODE:
-		app.slogger.Warn("TODO: implement this mode")
-	default:
-		app.slogger.Error("Wrong Mode. Should be one of: 'api', 'discord', 'tg'", "mode", app.cfg.mode)
-	}
 }

cmd/api/router.go

@@ -11,6 +11,7 @@ func (app *application) routes() http.Handler {
 
 	router.HandlerFunc(http.MethodGet, "/", app.ShowText)
 	router.HandlerFunc(http.MethodGet, "/v1/when", app.WhenNextSession)
+	router.HandlerFunc(http.MethodGet, "/v1/healthcheck", app.healthcheckHandler)
 
 	return router
 }

cmd/api/server.go

@@ -0,0 +1,70 @@
+package main
+
+import (
+	"context"
+	"errors"
+	"log/slog"
+	"net/http"
+	"os"
+	"os/signal"
+	"syscall"
+	"time"
+)
+
+func (app *application) serve() error {
+	srv := &http.Server{
+		Addr:     app.cfg.port,
+		Handler:  app.routes(),
+		ErrorLog: slog.NewLogLogger(app.slogger.Handler(), slog.LevelError),
+		// TLSConfig:    tlsConfig,
+		IdleTimeout:  time.Minute,
+		ReadTimeout:  5 * time.Second,
+		WriteTimeout: 10 * time.Second,
+	}
+
+	shutdownError := make(chan error)
+	go func() {
+		quit := make(chan os.Signal, 1)
+		signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM)
+		s := <-quit
+
+		app.slogger.Info("Caught signal", "signal", s.String())
+
+		ctx, cancel := context.WithTimeout(context.Background(), 20*time.Second)
+		defer cancel()
+
+		err := srv.Shutdown(ctx)
+		if err != nil {
+			shutdownError <- err
+		}
+
+		err = app.foundryApp.Shutdown()
+		if err != nil {
+			shutdownError <- err
+		}
+
+		shutdownError <- nil
+	}()
+
+	switch app.cfg.mode {
+	case API_MODE:
+		app.slogger.Info("Starting server", "addr", srv.Addr, "env", app.cfg.env)
+		err := srv.ListenAndServe()
+		if !errors.Is(err, http.ErrServerClosed) {
+			return err
+		}
+
+		app.slogger.Info("Stopped server", "addr", srv.Addr)
+		err = <-shutdownError
+		if err != nil {
+			return err
+		}
+	case DISCORD_BOT_MODE:
+		app.slogger.Warn("TODO: implement this mode")
+	case TG_BOT_MODE:
+		app.slogger.Warn("TODO: implement this mode")
+	default:
+		app.slogger.Error("Wrong Mode. Should be one of: 'api', 'discord', 'tg'", "mode", app.cfg.mode)
+	}
+	return nil
+}

internal/foundry/foundry.go

@@ -1,7 +1,10 @@
 package foundry
 
 import (
+	"context"
 	"errors"
+	"log/slog"
+	"sync"
 	"time"
 
 	"gitea.local.lab/Lbenedar/foundry_helper_service/internal/foundry/actions"
@@ -11,80 +14,69 @@ import (
 
 var (
 	ListenIsDone    = errors.New("Listen for websocket data in foundry is stopped")
+	ChannelIsClosed = errors.New("Channel is closed")
+
+	CloseTimeoutExceed = errors.New("Timeout of websocket close is exceed")
 )
 
 type FoundryApi struct {
 	//TODO: make check of admin's authentication
-	Transport   *transport.FoundryTransport
+	transport   *transport.FoundryTransport
-	IsReadReady bool
+	IsAvailable bool
 
+	Logger *slog.Logger
 	Status types.FoundryStatus
+	wg     sync.WaitGroup
 }
 
 func NewFoundry() *FoundryApi {
 	return &FoundryApi{}
 }
 
-func (foundry *FoundryApi) StartListen() error {
+func (foundry *FoundryApi) SetTransport(tr *transport.FoundryTransport) {
-	foundry.Transport.ReadChan = *types.InitWsChannels()
+	foundry.transport = tr
-
+}
-	wsChannels := &foundry.Transport.ReadChan
-	defer foundry.Transport.ReadChan.Close()
-	go foundry.ListenAndServeWS()
 
+func (foundry *FoundryApi) ListenAndServeWS() error {
 	var err error
-	for {
+
-		select {
+	foundry.transport.ReadChan = *types.InitWsChannels()
-		// case msg, ok := <-foundry.ws.channels.Msg():
+	defer foundry.transport.ReadChan.Close()
-		// 	if !ok {
+
-		// 		time.Sleep(5 * time.Microsecond)
+	foundry.background(foundry.transport.ListenWebSocket)
-		// 		continue
+
-		// 	}
+	err = foundry.ServeWebSocket()
-		// 	var foundryState *json_model.FoundryState
+	if err != nil {
-		// 	foundryState, err = json_model.ParseSetupModel(msg.ToByteSlice())
+		foundry.IsAvailable = false
-		// 	if err != nil {
-		// 		return nil
-		// 	}
-		// 	foundry.models.FoundryState.Insert(foundryState)
-		case err = <-wsChannels.Err():
-			var foundryErr *types.FoundryError
-			if errors.As(err, &foundryErr) {
-				if foundryErr.IsFatal {
-					foundry.Transport.CloseWebSocketConn()
-					return foundryErr
-				}
-				foundry.Transport.Logger.Warn("Got error when listening or served", "err", err.Error(), "type", foundryErr.Type, "direction", foundryErr.Direction)
-			}
-		case <-wsChannels.Done():
-			foundry.Transport.CloseWebSocketConn()
-			return ListenIsDone
-		}
 	}
+	return err
 }
 
-func (foundry *FoundryApi) ServeWebSocket() {
+func (foundry *FoundryApi) ServeWebSocket() error {
+	var err error
+	wsChannels := &foundry.transport.ReadChan
+
 	for {
 		select {
-		case message, ok := <-foundry.Transport.ReadChan.Msg():
+		case message, ok := <-wsChannels.Msg():
 			if !ok {
-				foundry.Transport.Logger.Debug("Read channel is closed", "type", types.WebSocketCode)
+				foundry.transport.Logger.Debug("Read channel is closed", "type", types.WebSocketCode)
-				return
+				return ChannelIsClosed
 			}
-			foundry.Transport.Logger.Debug("Data has been received\n", "msg", message.Code, "type", types.WebSocketCode) //, "msg", message.MsgJson)
+			foundry.transport.Logger.Debug("Data has been received\n", "msg", message.Code, "type", types.WebSocketCode) //, "msg", message.MsgJson)
 
 			switch message.Code {
 			case types.RespPingCode, types.RespSessionDataCode:
-				err := foundry.Transport.SendOnlyCodeRequest(message.Code)
+				err := foundry.transport.SendOnlyCodeRequest(message.Code)
 				if err != nil {
-					foundry.IsReadReady = false
+					wsChannels.Err() <- &types.FoundryError{Direction: types.WriterCode, Err: err, Type: types.WebSocketCode}
-					foundry.Transport.ReadChan.Err() <- &types.FoundryError{Direction: types.WriterCode, Err: err, Type: types.WebSocketCode}
 					continue
 				}
 			case types.RespServerChangeCode:
-				foundry.IsReadReady = true
+				foundry.IsAvailable = true
 				data, err := actions.SplitToTypeAndData([]byte(message.MsgJson))
 				if err != nil {
-					foundry.Transport.ReadChan.Err() <- &types.FoundryError{Direction: types.ReaderCode, Err: err, Type: types.WebSocketCode}
+					wsChannels.Err() <- &types.FoundryError{Direction: types.ReaderCode, Err: err, Type: types.WebSocketCode}
 					continue
 				}
 
@@ -92,63 +84,118 @@ func (foundry *FoundryApi) ServeWebSocket() {
 					continue
 				}
 
-				err = data.Action(foundry.Transport, &foundry.Status)
+				err = data.Action(foundry.transport, &foundry.Status)
 				if err != nil {
-					foundry.Transport.ReadChan.Err() <- &types.FoundryError{Direction: types.ReaderCode, Err: err, Type: types.WebSocketCode}
+					wsChannels.Err() <- &types.FoundryError{Direction: types.ReaderCode, Err: err, Type: types.WebSocketCode}
 					continue
 				}
 			case types.RespDataCode:
-				foundry.Transport.ExchangeChan.Msgs[message.Id] = make(chan []byte, 1)
+				foundry.transport.ExchangeChan.Msgs[message.Id] = make(chan []byte, 1)
-				foundry.Transport.ExchangeChan.Msgs[message.Id] <- []byte(message.MsgJson)
+				foundry.transport.ExchangeChan.Msgs[message.Id] <- []byte(message.MsgJson)
-				go foundry.Transport.CloseMsgChannel(message.Id, 5*time.Second)
+				go foundry.transport.CloseMsgChannel(message.Id, 5*time.Second)
 			default:
 			}
-		case <-foundry.Transport.ReadChan.Done():
+		case err = <-wsChannels.Err():
-			return
+			var foundryErr *types.FoundryError
+			if errors.As(err, &foundryErr) {
+				if foundryErr.IsFatal {
+					foundry.transport.CloseWebSocketConn()
+					return foundryErr
+				}
+				foundry.transport.Logger.Warn("Got error when listening or served", "err", err.Error(), "type", foundryErr.Type, "direction", foundryErr.Direction)
+			}
+		case <-wsChannels.Done():
+			foundry.transport.CloseWebSocketConn()
+			return ListenIsDone
 		}
 	}
 }
 
-func (foundry *FoundryApi) ListenAndServeWS() {
-	go foundry.Transport.ListenWebSocket()
-	foundry.ServeWebSocket()
-}
-
 func (foundry *FoundryApi) HandleWSRequest(msgType string) ([]byte, error) {
-	msg := types.NewWsMessageByPage(msgType, foundry.Transport.CurrWsId)
+	msg := types.NewWsMessageByPage(msgType, foundry.transport.CurrWsId)
 
-	return foundry.Transport.HandleWebsocketRequest(msg)
+	return foundry.transport.HandleWebsocketRequest(msg)
 }
 
-func (foundry *FoundryApi) ConnectToWebSocket() error {
+func (foundry *FoundryApi) Shutdown() error {
-	var err error
+	ctx, cancel := context.WithTimeout(context.Background(), 20*time.Second)
-	if !foundry.Transport.HasSessionId() {
+	defer cancel()
-		err = foundry.Transport.InitSessionId()
-		if err != nil {
-			return err
-		}
-	}
 
-	err = foundry.Transport.ConnectToFoundry()
+	foundry.transport.Logger.Info("Completing foundry background tasks")
-	if err != nil {
-		return err
-	}
 
-	err = foundry.Transport.InitWebSocketConnection()
+	foundryClosed := make(chan struct{})
-	if err != nil {
+	go func() {
-		return err
+		types.CloseChannel(foundry.transport.ReadChan.Done())
-	}
 
-	status, err := foundry.Transport.Http.GetStatus()
+		foundry.wg.Wait()
-	if err != nil {
+		foundry.transport.ExchangeChan.Close()
-		return err
+		foundry.transport.ReadChan.Close()
-	}
-	foundry.Status = *types.NewFoundryStatus(status)
 
-	err = foundry.StartListen()
+		types.CloseChannel(foundryClosed)
-	if err != nil && err != ListenIsDone {
+	}()
-		return err
+
+	select {
+	case <-foundryClosed:
+		foundry.transport.Logger.Info("Stopped foundry server")
+	case <-ctx.Done():
+		return CloseTimeoutExceed
 	}
 
 	return nil
 }
+
+func (foundry *FoundryApi) ConnectToWebSocket() (bool, error) {
+	var err error
+	if !foundry.transport.HasSessionId() {
+		err = foundry.transport.InitSessionId()
+		if err != nil {
+			return false, err
+		}
+	}
+
+	err = foundry.transport.ConnectToFoundry()
+	if err != nil {
+		return false, err
+	}
+
+	err = foundry.transport.InitWebSocketConnection()
+	if err != nil {
+		return false, err
+	}
+
+	status, err := foundry.transport.Http.GetStatus()
+	if err != nil {
+		return false, err
+	}
+	foundry.Status = *types.NewFoundryStatus(status)
+
+	err = foundry.ListenAndServeWS()
+	if err != nil && err != ListenIsDone {
+		return true, err
+	}
+
+	return true, nil
+}
+
+func (foundry *FoundryApi) StartListenFoundry() {
+	foundry.background(func() {
+		timeInterval := 1 * time.Second
+
+		for {
+			ok, err := foundry.ConnectToWebSocket()
+			if err != nil {
+				foundry.transport.Logger.Error("Error raised", "err", err.Error())
+
+				if ok {
+					timeInterval = 1 * time.Second
+				}
+				foundry.transport.Logger.Info("Trying to reconnect", "timer", timeInterval.String())
+
+				time.Sleep(timeInterval)
+				timeInterval = min(timeInterval*2, 15*time.Second)
+				continue
+			}
+			return
+		}
+	})
+}

internal/foundry/helpers.go

@@ -0,0 +1,18 @@
+package foundry
+
+import "fmt"
+
+func (f *FoundryApi) background(fn func()) {
+	f.wg.Add(1)
+	go func() {
+		defer f.wg.Done()
+
+		defer func() {
+			if err := recover(); err != nil {
+				f.transport.Logger.Error(fmt.Sprintf("%s", err))
+			}
+		}()
+
+		fn()
+	}()
+}

internal/foundry/transport/websocket.go

@@ -80,7 +80,12 @@ func (tr *FoundryTransport) ListenWebSocket() {
 	for {
 		_, message, err := tr.WsConn.ReadMessage()
 		if err != nil {
-			tr.ReadChan.Err() <- &types.FoundryError{Direction: types.ReaderCode, Err: err, Type: types.WebSocketCode}
+			select {
+			case <-tr.ReadChan.Done():
+				return
+			default:
+				tr.ReadChan.Err() <- &types.FoundryError{Direction: types.ReaderCode, Err: err, Type: types.WebSocketCode, IsFatal: true}
+			}
 			return
 		}
 		data, err := types.ParseWsRespMessage(string(message), types.RequestCodes)
@@ -105,7 +110,7 @@ func (tr *FoundryTransport) GetJsonData(stateType string) ([]byte, error) {
 	return tr.HandleWebsocketRequest(msg)
 }
 
-func (tr *FoundryTransport) CloseWebSocketConn() {
+func (tr *FoundryTransport) CloseWebSocketConn() error {
 	tr.Logger.Debug("Websocket has been closed")
-	tr.WsConn.Close()
+	return tr.WsConn.Close()
 }

internal/foundry/types/channels.go

@@ -8,6 +8,27 @@ type ExchangeChannels struct {
 	ProgressMutex sync.Mutex
 }
 
+func CloseMapChannel[K comparable, V any](channel map[K]chan V) {
+	for _, v := range channel {
+		select {
+		case _, ok := <-v:
+			if ok {
+				close(v)
+			}
+		default:
+			close(v)
+		}
+	}
+	for k := range channel {
+		delete(channel, k)
+	}
+}
+
+func (channels *ExchangeChannels) Close() {
+	CloseMapChannel(channels.Msgs)
+	CloseMapChannel(channels.ProgressMsg)
+}
+
 type ReadChannels struct {
 	done chan struct{}
 	msg  chan *WsMessage
@@ -26,10 +47,21 @@ func (channels ReadChannels) Done() chan struct{} {
 	return channels.done
 }
 
+func CloseChannel[V any](channel chan V) {
+	select {
+	case _, ok := <-channel:
+		if ok {
+			close(channel)
+		}
+	default:
+		close(channel)
+	}
+}
+
 func (channels *ReadChannels) Close() {
-	close(channels.done)
+	CloseChannel(channels.done)
-	close(channels.err)
+	CloseChannel(channels.err)
-	close(channels.msg)
+	CloseChannel(channels.msg)
 }
 
 func InitWsChannels() *ReadChannels {

internal/foundry/types/status.go

@@ -3,13 +3,13 @@ package types
 import "gitea.local.lab/Lbenedar/foundry_helper_service/internal/foundry/models/json"
 
 type FoundryStatus struct {
-	IsActive      bool
+	IsActive      bool   `json:"on_world"`
-	Version       string
+	Version       string `json:"version"`
-	World         string
+	World         string `json:"world,omitempty"`
-	System        string
+	System        string `json:"system,omitempty"`
-	SystemVersion string
+	SystemVersion string `json:"-"`
-	Users         int
+	Users         int    `json:"-"`
-	Uptime        int64
+	Uptime        int64  `json:"-"`
 }
 
 func NewFoundryStatus(status *json.Status) *FoundryStatus {