Improve reconnection handling

1. Lobbies are only identified by their passphrases
2. Improve logging
3. Do not close an existing websocket connection for a player but ignore
   the request
This commit is contained in:
Marco 2024-05-20 15:36:13 +02:00
parent b623410aff
commit 636ce06836
10 changed files with 56 additions and 52 deletions

View File

@ -30,7 +30,6 @@ func HostGameHandler(c *gin.Context) {
passphrase := lobby.Passphrase.String() passphrase := lobby.Passphrase.String()
info := api.PlayerInfo{ info := api.PlayerInfo{
PlayerID: &player.Uuid, PlayerID: &player.Uuid,
LobbyID: &lobby.Uuid,
Passphrase: &passphrase, Passphrase: &passphrase,
} }
c.Header("Access-Control-Allow-Origin", "*") c.Header("Access-Control-Allow-Origin", "*")
@ -54,12 +53,12 @@ func GetLobbyForPassphraseHandler(c *gin.Context) {
return return
} }
lobbyInfo := api.LobbyInfo{ passphrase := api.Passphrase{
ID: &lobby.Uuid, Value: (*string)(&lobby.Passphrase),
} }
c.Header("Access-Control-Allow-Origin", "*") c.Header("Access-Control-Allow-Origin", "*")
c.IndentedJSON(http.StatusOK, lobbyInfo) c.IndentedJSON(http.StatusOK, passphrase)
} }
// TODO: this will be replaced by the JoinGameHandler() // TODO: this will be replaced by the JoinGameHandler()
@ -77,8 +76,7 @@ func JoinPrivateGame(c *gin.Context) {
if req.Passphrase != nil && if req.Passphrase != nil &&
*req.Passphrase != "" && *req.Passphrase != "" &&
req.PlayerID != nil && req.PlayerID != nil { //is reconnect
req.LobbyID != nil { //is reconnect
lobby := u.FindExistingPrivateLobby(utils.Passphrase(*req.Passphrase)) lobby := u.FindExistingPrivateLobby(utils.Passphrase(*req.Passphrase))
var found bool var found bool
if lobby != nil { if lobby != nil {
@ -90,7 +88,6 @@ func JoinPrivateGame(c *gin.Context) {
http.StatusOK, http.StatusOK,
api.PlayerInfo{ api.PlayerInfo{
PlayerID: req.PlayerID, PlayerID: req.PlayerID,
LobbyID: req.LobbyID,
Passphrase: req.Passphrase, Passphrase: req.Passphrase,
}) })
return return
@ -114,7 +111,6 @@ func JoinPrivateGame(c *gin.Context) {
info := api.PlayerInfo{ info := api.PlayerInfo{
PlayerID: &player.Uuid, PlayerID: &player.Uuid,
LobbyID: &lobby.Uuid,
Passphrase: req.Passphrase, Passphrase: req.Passphrase,
} }
c.Header("Access-Control-Allow-Origin", "*") c.Header("Access-Control-Allow-Origin", "*")
@ -124,25 +120,22 @@ func JoinPrivateGame(c *gin.Context) {
func JoinGameHandler(c *gin.Context) { func JoinGameHandler(c *gin.Context) {
limiter.Take() limiter.Take()
id := c.Param("id") passphrase := api.Passphrase{}
idAsUUID, err := uuid.Parse(id) err := c.ShouldBindJSON(&passphrase)
if err != nil { if err != nil {
c.IndentedJSON(http.StatusBadRequest, nil) c.IndentedJSON(http.StatusBadRequest, nil)
return return
} }
passphrase := api.Passphrase{}
c.ShouldBindJSON(&passphrase)
u := lobbies.GetUsher() u := lobbies.GetUsher()
lobby := u.GetLobbyByID(idAsUUID) lobby := u.FindExistingPrivateLobby(utils.Passphrase(*passphrase.Value))
if lobby == nil { if lobby == nil {
c.IndentedJSON(http.StatusNotFound, nil) c.IndentedJSON(http.StatusNotFound, nil)
return return
} }
lobbyInfo := api.LobbyInfo{ lobbyInfo := api.Passphrase{
ID: &lobby.Uuid, Value: (*string)(&lobby.Passphrase),
} }
c.IndentedJSON(http.StatusOK, lobbyInfo) c.IndentedJSON(http.StatusOK, lobbyInfo)

View File

@ -9,13 +9,12 @@ import (
"testing" "testing"
"github.com/gin-gonic/gin" "github.com/gin-gonic/gin"
"github.com/google/uuid"
"github.com/stretchr/testify/assert" "github.com/stretchr/testify/assert"
) )
func Test_GetLobbyFromPassphraseHandler(t *testing.T) { func Test_GetLobbyFromPassphraseHandler(t *testing.T) {
var passphraseURLParameter string var passphraseURLParameter string
var hostedLobbyId uuid.UUID var receivedPhrase string
t.Run("host a lobby", func(t *testing.T) { t.Run("host a lobby", func(t *testing.T) {
r1 := httptest.NewRecorder() r1 := httptest.NewRecorder()
@ -30,8 +29,7 @@ func Test_GetLobbyFromPassphraseHandler(t *testing.T) {
err := json.Unmarshal(r1.Body.Bytes(), &playerInfo) err := json.Unmarshal(r1.Body.Bytes(), &playerInfo)
assert.NoError(t, err) assert.NoError(t, err)
receivedPhrase := *playerInfo.Passphrase receivedPhrase = *playerInfo.Passphrase
hostedLobbyId = *playerInfo.LobbyID
passphrase := utils.NewPassphraseFromString(receivedPhrase) passphrase := utils.NewPassphraseFromString(receivedPhrase)
passphraseURLParameter = passphrase.AsURLParam() passphraseURLParameter = passphrase.AsURLParam()
@ -48,10 +46,10 @@ func Test_GetLobbyFromPassphraseHandler(t *testing.T) {
engine.ServeHTTP(r2, getLobbyRequest) engine.ServeHTTP(r2, getLobbyRequest)
lobbyInfo := api.LobbyInfo{} passhrase := api.Passphrase{}
err := json.Unmarshal(r2.Body.Bytes(), &lobbyInfo) err := json.Unmarshal(r2.Body.Bytes(), &passhrase)
assert.NoError(t, err) assert.NoError(t, err)
assert.Equal(t, hostedLobbyId, *lobbyInfo.ID) assert.Equal(t, http.StatusOK, r2.Code)
}) })
} }

View File

@ -6,6 +6,7 @@ import (
"fmt" "fmt"
"log" "log"
"mchess_server/api" "mchess_server/api"
"mchess_server/utils"
"net/http" "net/http"
"mchess_server/lobbies" "mchess_server/lobbies"
@ -23,7 +24,6 @@ var upgrader = gorillaws.Upgrader{
func RegisterWebSocketConnection(c *gin.Context) { func RegisterWebSocketConnection(c *gin.Context) {
limiter.Take() limiter.Take()
log.Println(c.Request)
conn, err := upgrader.Upgrade(c.Writer, c.Request, nil) conn, err := upgrader.Upgrade(c.Writer, c.Request, nil)
if err != nil { if err != nil {
log.Println(err) log.Println(err)
@ -55,7 +55,7 @@ func waitForAndHandlePlayerID(ctx context.Context, conn *gorillaws.Conn) {
return return
} }
lobby := lobbies.GetLobbyRegistry().GetLobbyByUUID(*info.LobbyID) lobby := lobbies.GetLobbyRegistry().GetLobbyByPassphrase(utils.NewPassphraseFromString(*info.Passphrase))
if lobby == nil { if lobby == nil {
conn.WriteMessage(msgType, []byte("lobby not found")) conn.WriteMessage(msgType, []byte("lobby not found"))
conn.Close() conn.Close()
@ -69,10 +69,14 @@ func waitForAndHandlePlayerID(ctx context.Context, conn *gorillaws.Conn) {
return return
} }
if player.Conn.HasWebsocketConnection() { if player.Conn.HasWebsocketConnection() {
player.Conn.Close("closing existing connection") conn.WriteMessage(msgType, []byte("player already connected"))
return
} }
lobby.Game.SetWebsocketConnectionFor(ctx, player, conn) lobby.Game.SetWebsocketConnectionFor(ctx, player, conn)
log.Println("player after setting connection: ", player) log.Println("player after setting connection: ")
log.Println("id: ", player.Uuid)
log.Println("color: ", player.GetColor())
log.Println("Connection: ", player.Conn.ID)
} }
func ConnectWsForGame(c *gin.Context) { func ConnectWsForGame(c *gin.Context) {

View File

@ -1,7 +0,0 @@
package api
import "github.com/google/uuid"
type LobbyInfo struct {
ID *uuid.UUID `json:"id,omitempty"`
}

View File

@ -4,6 +4,5 @@ import "github.com/google/uuid"
type PlayerInfo struct { type PlayerInfo struct {
PlayerID *uuid.UUID `json:"playerID,omitempty"` PlayerID *uuid.UUID `json:"playerID,omitempty"`
LobbyID *uuid.UUID `json:"lobbyID,omitempty"`
Passphrase *string `json:"passphrase,omitempty"` Passphrase *string `json:"passphrase,omitempty"`
} }

View File

@ -105,7 +105,7 @@ func (game *Game) Handle() {
log.Println("Error while reading message:", err) log.Println("Error while reading message:", err)
return return
} }
log.Println("Player ", game.currentTurnPlayer, " moved:\n", receivedMove) log.Println("Player ", game.currentTurnPlayer.color.String(), " moved:\n", receivedMove)
game.gameState = CheckMove game.gameState = CheckMove
case CheckMove: case CheckMove:
@ -190,6 +190,7 @@ func (game Game) notifyPlayersAboutGameStart() error {
} }
func (game Game) broadcastMove(move types.Move) error { func (game Game) broadcastMove(move types.Move) error {
log.Println("broadcast move")
err := game.GetPlayer1().SendBoardState(move, game.board.PGN(), game.currentTurnPlayer.GetColor()) err := game.GetPlayer1().SendBoardState(move, game.board.PGN(), game.currentTurnPlayer.GetColor())
if err != nil { if err != nil {
return err return err

View File

@ -36,6 +36,7 @@ func (p Player) hasWebsocketConnection() bool {
func (p *Player) SetWebsocketConnection(ctx context.Context, ws *gorillaws.Conn) { func (p *Player) SetWebsocketConnection(ctx context.Context, ws *gorillaws.Conn) {
p.Conn.SetWebsocketConnection(ws) p.Conn.SetWebsocketConnection(ws)
p.Conn.SetForColor(p.color)
} }
func (p *Player) SetWebsocketConnectionAndSendBoardState( func (p *Player) SetWebsocketConnectionAndSendBoardState(
@ -49,6 +50,7 @@ func (p *Player) SetWebsocketConnectionAndSendBoardState(
func (p *Player) SetColor(color types.ChessColor) { func (p *Player) SetColor(color types.ChessColor) {
p.color = color p.color = color
p.Conn.SetForColor(p.color)
} }
func (p *Player) GetColor() types.ChessColor { func (p *Player) GetColor() types.ChessColor {
@ -157,7 +159,7 @@ func (p *Player) ReadMove() (types.Move, error) {
func (p *Player) readMessage() ([]byte, error) { func (p *Player) readMessage() ([]byte, error) {
msg, err := p.Conn.Read() msg, err := p.Conn.Read()
log.Printf("Reading message: %s from player %s", string(msg), p.Uuid.String()) log.Printf("Reading message from %s: %s", p.color.String(), string(msg))
return msg, err return msg, err
} }

View File

@ -3,22 +3,27 @@ package connection
import ( import (
"context" "context"
"log" "log"
"mchess_server/types"
"sync" "sync"
"github.com/google/uuid"
gorillaws "github.com/gorilla/websocket" gorillaws "github.com/gorilla/websocket"
) )
type Connection struct { type Connection struct {
ID uuid.UUID
ws *gorillaws.Conn ws *gorillaws.Conn
wsConnectionEstablished chan bool wsConnectionEstablished chan bool
wsWriteLock sync.Mutex wsWriteLock sync.Mutex
ctx context.Context ctx context.Context
buffer MessageBuffer buffer MessageBuffer
disconnectCallback func() disconnectCallback func()
forColor types.ChessColor
} }
func NewConnection(options ...func(*Connection)) *Connection { func NewConnection(options ...func(*Connection)) *Connection {
connection := Connection{ connection := Connection{
ID: uuid.New(),
buffer: *newMessageBuffer(100), buffer: *newMessageBuffer(100),
wsConnectionEstablished: make(chan bool), wsConnectionEstablished: make(chan bool),
} }
@ -50,6 +55,10 @@ func WithDisconnectCallback(cb func()) func(*Connection) {
} }
} }
func (conn *Connection) SetForColor(color types.ChessColor) {
conn.forColor = color
}
func (conn *Connection) SetDisconnectCallback(cb func()) { func (conn *Connection) SetDisconnectCallback(cb func()) {
conn.disconnectCallback = cb conn.disconnectCallback = cb
} }
@ -60,6 +69,7 @@ func (conn *Connection) HasWebsocketConnection() bool {
func (conn *Connection) SetWebsocketConnection(ws *gorillaws.Conn) { func (conn *Connection) SetWebsocketConnection(ws *gorillaws.Conn) {
if ws == nil { if ws == nil {
conn.logConnection("ERROR: setting ws = null")
return return
} }
@ -67,14 +77,16 @@ func (conn *Connection) SetWebsocketConnection(ws *gorillaws.Conn) {
select { select {
case conn.wsConnectionEstablished <- true: case conn.wsConnectionEstablished <- true:
conn.logConnection("case wsConnectionEstablished <- true")
default: default:
conn.logConnection("DEFAULT CASE")
} }
go func() { go func() {
for { for {
_, msg, err := conn.ws.ReadMessage() _, msg, err := conn.ws.ReadMessage()
if err != nil { if err != nil {
log.Println("while reading from websocket: %w", err) conn.logConnection("while reading from websocket: %w", err)
conn.unsetWebsocketConnection() conn.unsetWebsocketConnection()
if conn.disconnectCallback != nil { if conn.disconnectCallback != nil {
@ -85,21 +97,27 @@ func (conn *Connection) SetWebsocketConnection(ws *gorillaws.Conn) {
conn.buffer.Insert(string(msg)) conn.buffer.Insert(string(msg))
} }
}() }()
defer conn.logConnection("websocket connection set")
} }
func (conn *Connection) unsetWebsocketConnection() { func (conn *Connection) unsetWebsocketConnection() {
conn.logConnection("websocket connection unset")
conn.ws = nil conn.ws = nil
} }
func (conn *Connection) Write(msg []byte) error { func (conn *Connection) Write(msg []byte) error {
conn.logConnection("about to write")
conn.logConnection("locking")
conn.wsWriteLock.Lock() conn.wsWriteLock.Lock()
defer conn.logConnection("unlocking")
defer conn.wsWriteLock.Unlock() defer conn.wsWriteLock.Unlock()
if conn.ws == nil { //if ws is not yet set, we wait for it if conn.ws == nil { //if ws is not yet set, we wait for it
conn.logConnection("waiting for wsConnectionEstablished channel")
<-conn.wsConnectionEstablished <-conn.wsConnectionEstablished
} }
log.Printf("Writing message: %s", string(msg)) conn.logConnection("Writing message: %s", string(msg))
return conn.ws.WriteMessage(gorillaws.TextMessage, msg) return conn.ws.WriteMessage(gorillaws.TextMessage, msg)
} }
@ -114,7 +132,13 @@ func (conn *Connection) Read() ([]byte, error) {
} }
func (conn *Connection) Close(msg string) { func (conn *Connection) Close(msg string) {
conn.logConnection("closing websocket connection")
conn.ws.WriteMessage(gorillaws.TextMessage, []byte(msg)) conn.ws.WriteMessage(gorillaws.TextMessage, []byte(msg))
conn.ws.Close() conn.ws.Close()
conn.ws = nil conn.ws = nil
} }
func (con *Connection) logConnection(v ...any) {
log.Println("on connection: ", con.ID)
log.Println("for color: ", con.forColor.String(), v)
}

View File

@ -7,7 +7,7 @@ import (
) )
type LobbyRegistry struct { type LobbyRegistry struct {
lobbies map[uuid.UUID]*Lobby lobbies map[utils.Passphrase]*Lobby
} }
var instance *LobbyRegistry var instance *LobbyRegistry
@ -21,7 +21,7 @@ func GetLobbyRegistry() *LobbyRegistry {
} }
func newLobbyRegistry() *LobbyRegistry { func newLobbyRegistry() *LobbyRegistry {
return &LobbyRegistry{lobbies: make(map[uuid.UUID]*Lobby)} return &LobbyRegistry{lobbies: make(map[utils.Passphrase]*Lobby)}
} }
func (r *LobbyRegistry) CreateNewPrivateLobby() *Lobby { func (r *LobbyRegistry) CreateNewPrivateLobby() *Lobby {
@ -42,10 +42,6 @@ func (r *LobbyRegistry) GetLobbyForPlayer() *Lobby {
return newLobby return newLobby
} }
func (r *LobbyRegistry) GetLobbyByUUID(uuid uuid.UUID) *Lobby {
return r.lobbies[uuid]
}
func (r *LobbyRegistry) GetLobbyByPassphrase(p utils.Passphrase) *Lobby { func (r *LobbyRegistry) GetLobbyByPassphrase(p utils.Passphrase) *Lobby {
for _, lobby := range r.lobbies { for _, lobby := range r.lobbies {
if lobby.Passphrase == p { if lobby.Passphrase == p {
@ -56,6 +52,6 @@ func (r *LobbyRegistry) GetLobbyByPassphrase(p utils.Passphrase) *Lobby {
} }
func (r *LobbyRegistry) addNewLobby(lobby *Lobby) uuid.UUID { func (r *LobbyRegistry) addNewLobby(lobby *Lobby) uuid.UUID {
r.lobbies[lobby.Uuid] = lobby r.lobbies[lobby.Passphrase] = lobby
return lobby.Uuid return lobby.Uuid
} }

View File

@ -3,8 +3,6 @@ package lobbies
import ( import (
"mchess_server/chess" "mchess_server/chess"
"mchess_server/utils" "mchess_server/utils"
"github.com/google/uuid"
) )
type Usher struct { type Usher struct {
@ -41,10 +39,6 @@ func (u *Usher) FindExistingPrivateLobby(p utils.Passphrase) *Lobby {
return lobby return lobby
} }
func (*Usher) GetLobbyByID(id uuid.UUID) *Lobby {
return GetLobbyRegistry().GetLobbyByUUID(id)
}
func (u *Usher) AddPlayerToLobbyAndStartGameIfFull(player *chess.Player, lobby *Lobby) { func (u *Usher) AddPlayerToLobbyAndStartGameIfFull(player *chess.Player, lobby *Lobby) {
lobby.AddPlayerAndStartGameIfFull(player) lobby.AddPlayerAndStartGameIfFull(player)
} }