WSMessage object

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "fairhopper-sdk"]
+	path = fairhopper-sdk
+	url = git@gitea.ekirin.com:Intis/fairhopper-sdk.git

README.md

@@ -21,6 +21,35 @@
 - Move timeout: 10s. Game is finished if timeout ocurrs.
 
 
+## Game States
+
+```plantuml
+hide empty description
+
+state "Start Game" as StartGame
+state "Move" as MovePlayer: Destination reached?
+state "Destination Reached" as DestinationReached
+state "Product Selection" as ProductSelection: Enable product selection for winning player
+state "Product Selected" as ProductSelected
+state "Selection Timeout" as SelectionTimeout
+state "End Player's Game" as EndPlayer
+state "Lock Game" as LockGame <<end>>
+state "End Game" as EndGame <<end>>
+state "Unlock game" as UnlockGame <<end>>
+
+[*] -> StartGame
+StartGame -> MovePlayer
+MovePlayer <-- MovePlayer: NO
+MovePlayer --> DestinationReached: YES
+DestinationReached --> ProductSelection
+DestinationReached -> LockGame: Lock game for all other players
+ProductSelection --> ProductSelected
+ProductSelection --> SelectionTimeout
+ProductSelected --> EndGame: End game\nfor all players
+SelectionTimeout -> EndPlayer
+EndPlayer --> UnlockGame: Unlock game\n for all players
+```
+
 ## FairHopper Game Server
 
 Requirements:
@@ -75,46 +104,51 @@ actor "Player 1" as P1
 actor "Player 2" as P2
 actor "Player 3" as P3
 
-package Masterpiece {
+package Masterpiece #seashell {
-    usecase Game as "FairHopper\nGame Server"
+    rectangle "FairHopper Game Server" #lightcyan {
-    usecase WS as "WS Server"
+        usecase API as "API Server"
+        usecase Game as "Game Engine"
+        usecase WS as "WS Server"
+    }
     usecase Vis as "Visualisation\nService"
 }
 
-P1 -left-> Game: REST API
+usecase ExtVis1 as "Visualisation\nService"
-P2 -left-> Game: REST API
+usecase ExtVis2 as "Visualisation\nService"
-P3 -left-> Game: REST API
+
-Game --> WS: WebSockets
+P1 -left-> API: REST API
-WS --> Vis: WebSockets
+P2 -left-> API: REST API
+P3 -left-> API: REST API
+API --> Game
+Game --> WS: Game State
+WS --> Vis: WS Game State
+WS --> ExtVis1: WS Game State
+WS --> ExtVis2: WS Game State
 ```
 
 ### WebSockets
 
 ```plantuml
-    participant Game as "FairHopper\nGame Server"
+box "FairHopper Game Server" #lightcyan
+    participant Game as "Game Engine"
     participant WS as "WS Server"
-    participant Client1 as "Visualisation\nClient 1"
+endbox
-    participant Client2 as "Visualisation\nClient 2"
+participant Client1 as "Visualisation\nClient 1"
+participant Client2 as "Visualisation\nClient 2"
 
-    Game ->o WS: Server Connect
+Game ->o WS: Send initial state
-    activate WS #coral
-        WS -> Game: Get game state
-        activate Game #yellow
-            Game -> WS: Game state
-        deactivate
-    deactivate
 
-    Client1 ->o WS: Client Connect
+Client1 ->o WS: Client connect
-    activate WS #coral
+activate WS #coral
-        WS -> Client1: Game state
+	WS -> Client1: Game state
-    deactivate
+deactivate
 
-    Client2 ->o WS: Client Connect
+Client2 ->o WS: Client connect
-    activate WS #coral
+activate WS #coral
-        WS -> Client2: Game state
+	WS -> Client2: Game state
-    deactivate
+deactivate
 
-    loop #lightyellow On game state change
+loop #lightyellow On game state change
     Game ->o WS: Game state
     activate WS #coral
         WS o-> Client1: Game state
@@ -131,7 +165,7 @@ end
 - Move right
 - Move up
 - Move down
-- Get current position
+- Get player info
 - Get board info
 
 Check REST API interface on [FastAPI docs](http://localhost:8010/docs).

api_tests/requests.http

@@ -0,0 +1,39 @@
+GET http://localhost:8010/ping
+###
+
+# create new game
+POST http://localhost:8010/game
+Content-Type: application/json
+
+{
+  "player_name": "Mirko"
+}
+###
+
+# get game info
+GET http://localhost:8010/game
+###
+
+# get player info
+GET http://localhost:8010/player/test-player-pero
+###
+
+# move player left
+POST http://localhost:8010/player/test-player-pero/move/left
+###
+
+# move player right
+POST http://localhost:8010/player/test-player-pero/move/right
+###
+
+# move player up
+POST http://localhost:8010/player/test-player-pero/move/up
+###
+
+# move player down
+POST http://localhost:8010/player/test-player-pero/move/down
+###
+
+# move Mirko left
+POST http://localhost:8010/player/test-player-mirko/move/left
+###

frontend/index.html

@@ -8,13 +8,15 @@
     <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/css/bootstrap.min.css"
         integrity="sha384-rbsA2VBKQhggwzxH7pPCaAqO46MgnOM80zW1RWuH61DGLwZJEdK2Kadq2F9CUG65" crossorigin="anonymous">
     <link rel="stylesheet" href="styles.css">
-    <title>Document</title>
+
+    <title>FairHopper Visualisation Client</title>
 </head>
 
 <body>
     <div class="container-fluid">
-        <h1>FairHopper WS Client</h1>
+        <h1 class="mt-1 mb-2">
-
+            FairHopper Visualisation Client
+        </h1>
         <div class="row">
             <div class="col-10">
                 <div class="board-container">
@@ -22,14 +24,23 @@
                 </div>
             </div>
             <div class="col-2">
-                <h3>Players</h3>
+                <h3 class="pb-2 border-bottom">
-                <ul id="players-content"></ul>
+                    Players
+                </h3>
+                <ul class="players" id="players-content"></ul>
             </div>
         </div>
     </div>
 </body>
 
 <script>
+    const BOARD_ICONS = {
+        PLAYER: "😀",
+        PLAYER_ON_DESTINATION: "😎",
+        OBSTACLE: "🔥",
+        DESTINATION: "🏠",
+    };
+
     function createBoard(board) {
         let html = "";
         for (let y = 0; y < board.height; y++) {
@@ -46,25 +57,42 @@
         document.getElementById("board-content").innerHTML = html;
     }
 
-    function renderCellContent(x, y, content) {
+    function findCell(position) {
-        const cell = document.getElementById(`cell-${x}-${y}`);
+        return document.getElementById(`cell-${position.x}-${position.y}`);
+    }
+
+    function renderCellContent(position, content) {
+        const cell = findCell(position);
         if (cell) {
             cell.innerText = content;
         }
     }
 
     function renderPlayerList(players) {
-        const html = players.map((player) => {
+        const html = players.filter(player => player.active).map((player) => {
+            const onDestination = player.state == "ON_DESTINATION";
             return `
-                <li>${player.name} (${player.move_count})</li>
+                <li class="${onDestination ? "text-success" : ""}">
+                    ${player.name} (${player.move_count})
+                    ${onDestination ? "✅" : ""}
+                </li>
             `;
         }).join("");
         document.getElementById("players-content").innerHTML = html;
     }
 
     function renderPlayers(players) {
-        players.forEach(player => {
+        players.filter(player => player.active).forEach(player => {
-            renderCellContent(player.position.x, player.position.y, "😎");
+            const cell = findCell(player.position);
+            const onDestination = player.state == "ON_DESTINATION";
+            const playerIcon = onDestination ? BOARD_ICONS.PLAYER_ON_DESTINATION : BOARD_ICONS.PLAYER;
+            if (cell) {
+                const html = `
+                    <div class="player-tooltip">${player.name}</div>
+                    ${playerIcon}
+                `;
+                cell.innerHTML = html;
+            }
         });
     }
 
@@ -79,41 +107,56 @@
     function renderObstacles(layers) {
         const objects = getLayerObjectsOfType(layers, "OBSTACLE");
         objects.forEach(obj => {
-            renderCellContent(obj.position.x, obj.position.y, "🔥");
+            renderCellContent(obj.position, BOARD_ICONS.OBSTACLE);
         });
     }
 
     function renderDestination(position) {
-        renderCellContent(position.x, position.y, "🏠");
+        renderCellContent(position, BOARD_ICONS.DESTINATION);
     }
 
-    window.onload = function () {
+    function renderGameDump(data) {
-        const ws = new WebSocket('ws://localhost:8011/bla-tra');
+        createBoard(data.board);
-
+        renderObstacles(data.layers)
-        ws.onmessage = function (event) {
+        renderDestination(data.destination.position);
-            const data = JSON.parse(event.data);
+        renderPlayerList(data.players);
-            console.log("message received:", data)
+        renderPlayers(data.players);
-
-            createBoard(data.board);
-            renderObstacles(data.layers)
-            renderDestination(data.destination.position);
-            renderPlayerList(data.players);
-            renderPlayers(data.players);
-        }
-
-        ws.onopen = function () {
-            console.log("open");
-        }
-
-        ws.onclose = function () {
-            console.log("close");
-        }
-
-        ws.onerror = function () {
-            console.log("error");
-        }
     }
 
+    function wsConnect() {
+        let ws = new WebSocket('ws://localhost:8011');
+        ws.onopen = () => {
+            console.log("WS connected")
+        };
+
+        ws.onmessage = (e) => {
+            const wsMessage = JSON.parse(e.data);
+            console.log("WS message received:", wsMessage)
+
+            switch (wsMessage.message) {
+                case "game_dump":
+                    renderGameDump(wsMessage.data);
+                    break;
+                default:
+                    console.error("Unknown message:", wsMessage)
+            }
+        };
+
+        ws.onclose = (e) => {
+            setTimeout(function () {
+                wsConnect();
+            }, 1000);
+        };
+
+        ws.onerror = (err) => {
+            console.error("Socket encountered error:", err.message, "Closing socket");
+            ws.close();
+        };
+    }
+
+    window.onload = () => {
+        wsConnect();
+    }
 </script>
 
 

frontend/styles.css

@@ -13,8 +13,43 @@ body {
     grid-gap: 2px;
     padding-bottom: 2px;
 }
+.flex-grid:last-of-type {
+    padding-bottom: 0px;
+}
+
 .cell {
     flex: 1;
-    text-align: center;
+    aspect-ratio: 1;
     background-color: beige;
+    position: relative;
+    display: flex;
+    align-items: center;
+    justify-content: center;
+}
+
+ul.players {
+    list-style-type: none;
+    padding-left: 0;
+}
+
+.player-tooltip {
+    position: absolute;
+    margin-bottom: 50px;
+    font-size: 8pt;
+    padding: 2px 10px;
+    color: white;
+    background-color: darkred;
+    border-radius: 5px;
+    z-index: 1000;
+}
+
+.player-tooltip::after {
+    content: " ";
+    position: absolute;
+    top: 100%; /* At the bottom of the tooltip */
+    left: 50%;
+    margin-left: -5px;
+    border-width: 5px;
+    border-style: solid;
+    border-color: darkred transparent transparent transparent;
 }

hopper/api/dto.py

@@ -2,6 +2,8 @@ from __future__ import annotations
 
 from pydantic import BaseModel as PydanticBaseModel
 
+from hopper.enums import PlayerState
+
 
 class BaseModel(PydanticBaseModel):
     class Config:
@@ -29,6 +31,7 @@ class PlayerDto(BaseModel):
     position: PositionDto
     move_count: int
     move_attempt_count: int
+    state: PlayerState
 
 
 class DestinationDto(BaseModel):

hopper/api/views.py

@@ -14,11 +14,26 @@ from hopper.api.dto import (
 )
 from hopper.engine import GameEngine
 from hopper.enums import Direction, PlayerMoveResult
-from hopper.errors import Collision, PositionOutOfBounds
+from hopper.errors import Collision, GameLockForMovement, PositionOutOfBounds
+from hopper.models.player import Player
 
 router = APIRouter()
 
 
+def get_player(uuid: str, engine: GameEngine = Depends(get_game_engine)) -> Player:
+    player = engine.players.find(uuid)
+    if player is None:
+        raise HTTPException(
+            status_code=status.HTTP_404_NOT_FOUND, detail="Player not found"
+        )
+    if not player.active:
+        raise HTTPException(
+            status_code=status.HTTP_403_FORBIDDEN,
+            detail="Player kicked out due to inactivity",
+        )
+    return player
+
+
 @router.get("/ping", response_model=PingResponse)
 async def ping() -> PingResponse:
     return PingResponse(
@@ -38,12 +53,14 @@ async def get_game_info(
     )
 
 
-@router.post("/game", response_model=StartGameResponseDto)
+@router.post(
+    "/game", response_model=StartGameResponseDto, status_code=status.HTTP_201_CREATED
+)
 async def start_game(
     body: StartGameRequestDto,
     engine: GameEngine = Depends(get_game_engine),
 ) -> StartGameResponseDto:
-    new_player = await engine.start_game(player_name=body.player_name)
+    new_player = await engine.start_game_for_player(player_name=body.player_name)
 
     return StartGameResponseDto(
         board=engine.board,
@@ -57,22 +74,20 @@ async def start_game(
 @router.get(
     "/player/{uuid}",
     response_model=PlayerInfoResponseDto,
-    status_code=status.HTTP_201_CREATED,
+    responses={
+        status.HTTP_403_FORBIDDEN: {
+            "model": ErrorResponseDto,
+            "description": " Player inactive",
+        },
+        status.HTTP_404_NOT_FOUND: {
+            "model": ErrorResponseDto,
+            "description": " Player with uuid not found, probably kicked out",
+        },
+    },
 )
 async def get_player_info(
-    uuid: str,
+    player: Player = Depends(get_player),
-    engine: GameEngine = Depends(get_game_engine),
 ) -> MovePlayerResponseDto:
-    player = engine.players.find(uuid)
-    if player is None:
-        raise HTTPException(
-            status_code=status.HTTP_404_NOT_FOUND, detail="Player not found"
-        )
-    if not player.active:
-        raise HTTPException(
-            status_code=status.HTTP_404_NOT_FOUND,
-            detail="Player kicked out due to inactivity",
-        )
     return PlayerInfoResponseDto(player=player)
 
 
@@ -87,31 +102,28 @@ async def get_player_info(
         },
         status.HTTP_403_FORBIDDEN: {
             "model": ErrorResponseDto,
-            "description": " Player uuid not valid, probably due to inactivity",
+            "description": " Player inactive",
+        },
+        status.HTTP_404_NOT_FOUND: {
+            "model": ErrorResponseDto,
+            "description": " Player with uuid not found, probably kicked out",
         },
         status.HTTP_409_CONFLICT: {
             "model": ErrorResponseDto,
             "description": " Position out of bounds or collision with an object",
         },
+        status.HTTP_423_LOCKED: {
+            "model": ErrorResponseDto,
+            "description": " Player reached destination. Can't move anymore.",
+        },
     },
 )
 async def move_player(
-    uuid: str,
     direction: Direction,
     response: Response,
     engine: GameEngine = Depends(get_game_engine),
+    player: Player = Depends(get_player),
 ) -> MovePlayerResponseDto:
-    player = engine.players.find(uuid)
-    if player is None:
-        raise HTTPException(
-            status_code=status.HTTP_404_NOT_FOUND, detail="Player not found"
-        )
-    if not player.active:
-        raise HTTPException(
-            status_code=status.HTTP_404_NOT_FOUND,
-            detail="Player kicked out due to inactivity",
-        )
-
     try:
         move_result = await engine.move_player(player, direction)
     except PositionOutOfBounds:
@@ -122,6 +134,11 @@ async def move_player(
         raise HTTPException(
             status_code=status.HTTP_409_CONFLICT, detail="Collision with an object"
         )
+    except GameLockForMovement:
+        raise HTTPException(
+            status_code=status.HTTP_423_LOCKED,
+            detail="Player reached destination. Can't move anymore.",
+        )
 
     if move_result == PlayerMoveResult.DESTINATION_REACHED:
         response.status_code = status.HTTP_200_OK

hopper/api_tests/requests.http

@@ -1,35 +0,0 @@
-GET http://localhost:8010/ping
-###
-
-# create new game
-POST http://localhost:8010/game
-Content-Type: application/json
-
-{
-  "player_name": "Mirko"
-}
-###
-
-# get game info
-GET http://localhost:8010/game
-###
-
-# get player info
-GET http://localhost:8010/player/test-player-id
-###
-
-# move player left
-POST http://localhost:8010/player/test-player-id/move/left
-###
-
-# move player right
-POST http://localhost:8010/player/test-player-id/move/right
-###
-
-# move player up
-POST http://localhost:8010/player/test-player-id/move/up
-###
-
-# move player down
-POST http://localhost:8010/player/test-player-id/move/down
-###

hopper/countdown_timer.py

@@ -0,0 +1,25 @@
+import time
+from threading import Event, Thread
+from typing import Callable, Optional
+
+
+class CountdownTimer(Thread):
+    def __init__(
+        self, seconds: int, callback: Optional[Callable[[], None]] = None
+    ) -> None:
+        self.seconds = seconds
+        self.stop_event = Event()
+        self.callback = callback
+        super().__init__()
+
+    def run(self) -> None:
+        cnt = self.seconds
+        while cnt > 0 and not self.stop_event.is_set():
+            cnt -= 1
+            time.sleep(1)
+
+        if cnt == 0 and self.callback:
+            self.callback()
+
+    def stop(self) -> None:
+        self.stop_event.set()

hopper/engine.py

@@ -1,9 +1,12 @@
 import asyncio
 import logging
+import random
 from typing import Optional
 
-from hopper.enums import Direction, PlayerMoveResult
+from hopper.countdown_timer import CountdownTimer
-from hopper.errors import Collision, PositionOutOfBounds
+from hopper.enums import Direction, GameState, PlayerMoveResult, PlayerState
+from hopper.errors import Collision, GameLockForMovement, PositionOutOfBounds
+from hopper.interfaces import SendGameDumpInterface
 from hopper.models.board import (
     BOARD_DUMP_CHARS,
     BoardLayout,
@@ -16,25 +19,33 @@ from hopper.models.board import (
 )
 from hopper.models.player import Player, PlayerList, Position
 from hopper.watchdog import InactivityWatchdog
-from hopper.ws_server import WSServer
 from settings import settings
 
 
 class GameEngine:
-    def __init__(self, board: GameBoard, ws_server: Optional[WSServer] = None) -> None:
+    def __init__(
+        self, board: GameBoard, ws_server: Optional[SendGameDumpInterface] = None
+    ) -> None:
         self.board = board
         self.ws_server = ws_server
         self.players = PlayerList()
         self._inacivity_watchdog = None
-        self.__debug_print_board()
+        self._purchase_countdown_timer: Optional[CountdownTimer] = None
+        self.reset_game()
 
     def dump_board(self) -> list[list[str]]:
         dump = self.board.dump()
 
         for player in self.players:
-            dump[player.position.y][player.position.x] = BOARD_DUMP_CHARS[
+            show_player = (
-                ObjectType.PLAYER
+                player.active
-            ]
+                and player.position.y < len(dump)
+                and player.position.x < len(dump[player.position.y])
+            )
+            if show_player:
+                dump[player.position.y][player.position.x] = BOARD_DUMP_CHARS[
+                    ObjectType.PLAYER
+                ]
 
         return dump
 
@@ -53,11 +64,16 @@ class GameEngine:
             )
             self._inacivity_watchdog.start()
 
-    async def start_game(self, player_name: str) -> Player:
+    def reset_game(self) -> None:
+        self.__debug_print_board()
+        self.game_state = GameState.RUNNING
+
+    async def start_game_for_player(self, player_name: str) -> Player:
         self._start_inactivity_watchdog()
         player = Player(
             name=player_name,
-            position=Position(0, 0),
+            position=self._create_player_start_position(),
+            state=PlayerState.CREATED,
         )
         self.players.append(player)
 
@@ -65,18 +81,28 @@ class GameEngine:
         self.__debug_print_board()
 
         if self.ws_server:
-            await self.ws_server.send_game_state()
+            await self.ws_server.send_game_dump()
 
+        await asyncio.sleep(settings.game.MOVE_DELAY)
         return player
 
-    async def move_player(
+    def _create_player_start_position(self) -> Position:
-        self, player: Player, direction: Direction
+        """Create random position somewhere on the board border"""
-    ) -> PlayerMoveResult:
+        border_len = (self.board.width + self.board.height) * 2
-        player.reset_timeout()
+        rnd_position = random.randint(0, border_len - 1)
 
-        new_position = Position(player.position.x, player.position.y)
+        if rnd_position < self.board.width * 2:
-        logging.info(f"Player {player} move to {direction}")
+            x = rnd_position % self.board.width
+            y = 0 if rnd_position < self.board.width else self.board.height - 1
+        else:
+            rnd_position -= 2 * self.board.width
+            x = 0 if rnd_position < self.board.height else self.board.width - 1
+            y = rnd_position % self.board.height
 
+        return Position(x=x, y=y)
+
+    def _move_position(self, position: Position, direction: Direction) -> Position:
+        new_position = Position(position.x, position.y)
         if direction == Direction.LEFT:
             new_position.x -= 1
         elif direction == Direction.RIGHT:
@@ -87,41 +113,78 @@ class GameEngine:
             new_position.y += 1
         else:
             raise ValueError(f"Unhandled direction: {direction}")
+        return new_position
+
+    async def move_player(
+        self, player: Player, direction: Direction
+    ) -> PlayerMoveResult:
+        player.reset_timeout()
+
+        if self.game_state == GameState.LOCK_FOR_MOVEMENT:
+            raise GameLockForMovement("Player reached destination. Can't move anymore.")
+
+        # player will not be able to move once they reach the destination
+        if player.state == PlayerState.ON_DESTINATION:
+            return PlayerMoveResult.DESTINATION_REACHED
+
+        logging.info(f"Player {player} move to {direction}")
+        new_position = self._move_position(player.position, direction)
 
         player.move_attempt_count += 1
+        player.state = PlayerState.MOVING
 
-        if not self.position_in_board_bounds(new_position):
+        if not self._position_in_board_bounds(new_position):
             raise PositionOutOfBounds()
 
-        if self.colided_with_obstacle(new_position):
+        if self._colided_with_obstacle(new_position):
             raise Collision()
 
         player.position = new_position
         player.move_count += 1
 
-        if self.ws_server:
+        if self._is_player_on_destination(player):
-            await self.ws_server.send_game_state()
+            player.state = PlayerState.ON_DESTINATION
-
+            self._player_on_destination(player)
-        if self.is_player_on_destination(player):
             logging.info(f"Player {player} reached destination!")
-            return PlayerMoveResult.DESTINATION_REACHED
+
+        if self.ws_server:
+            await self.ws_server.send_game_dump()
 
         self.__debug_print_board()
 
+        if player.state == PlayerState.ON_DESTINATION:
+            self.game_state = GameState.LOCK_FOR_MOVEMENT
+            return PlayerMoveResult.DESTINATION_REACHED
+
         await asyncio.sleep(settings.game.MOVE_DELAY)
+
         return PlayerMoveResult.OK
 
-    def is_player_on_destination(self, player: Player) -> bool:
+    def _is_player_on_destination(self, player: Player) -> bool:
         return player.position == self.board.destination.position
 
-    def position_in_board_bounds(self, position: Position) -> bool:
+    def _position_in_board_bounds(self, position: Position) -> bool:
         return (
             0 <= position.x < self.board.width and 0 <= position.y < self.board.height
         )
 
-    def colided_with_obstacle(self, position: Position) -> bool:
+    def _colided_with_obstacle(self, position: Position) -> bool:
         return self.board.get_object_at_position(position) is not None
 
+    def _player_on_destination(self, player: Player) -> None:
+        self.game_state = GameState.LOCK_FOR_MOVEMENT
+        logging.info(f"Starting purchase countdown timer for {settings.purchase_timeout} seconds")
+        self._purchase_countdown_timer = CountdownTimer(
+            seconds=settings.purchase_timeout,
+            callback=self._on_purchase_timeout,
+        )
+        self._purchase_countdown_timer.start()
+
+    def _on_purchase_timeout(self) -> None:
+        logging.info("Ding ding! Purchase countdown timer timeout")
+        self._purchase_countdown_timer = None
+        self.game_state = GameState.RUNNING
+
     def get_board_layout(self) -> BoardLayout:
         return BoardLayout(board=self.board, players=self.players)
 
@@ -132,12 +195,12 @@ class GameEngineFactory:
         board_width: int,
         board_height: int,
         obstacle_count: int = 0,
-        ws_server: Optional[WSServer] = None,
+        ws_server: Optional[SendGameDumpInterface] = None,
     ) -> GameEngine:
         board = GameBoard(
             width=board_width,
             height=board_height,
-            destination=Destination(Position(board_height // 2, board_height // 2)),
+            destination=Destination(Position(board_width // 2, board_height // 2)),
         )
         obstacle_layer = Layer(name="obstacles")
         for _ in range(obstacle_count):
@@ -153,11 +216,13 @@ class GameEngineFactory:
             board=board,
             ws_server=ws_server,
         )
-        GameEngineFactory.__add_test_player(game.players)
+        GameEngineFactory.__add_test_players(game.players)
         return game
 
     @staticmethod
-    def create_default(ws_server: Optional[WSServer] = None) -> GameEngine:
+    def create_default(
+        ws_server: Optional[SendGameDumpInterface] = None,
+    ) -> GameEngine:
         return GameEngineFactory.create(
             board_width=settings.board.WIDTH,
             board_height=settings.board.HEIGHT,
@@ -166,15 +231,10 @@ class GameEngineFactory:
         )
 
     @staticmethod
-    def __add_test_player(players: PlayerList) -> None:
+    def __add_test_players(players: PlayerList) -> None:
-        if not (settings.debug and settings.debug.CREATE_TEST_PLAYER):
+        if not settings.debug:
             return
 
-        player = Player(
+        for player in settings.debug.PLAYERS:
-            name="Pero",
+            players.append(player)
-            uuid="test-player-id",
+            logging.info(f"Test player created: {player}")
-            position=Position(2, 2),
-            can_be_deactivated=False,
-        )
-        players.append(player)
-        logging.info(f"Test player created: {player}")

hopper/enums.py

@@ -18,3 +18,16 @@ class ObjectType(str, Enum):
 class PlayerMoveResult(Enum):
     OK = auto()
     DESTINATION_REACHED = auto()
+
+
+class GameState(Enum):
+    RUNNING = auto()
+    LOCK_FOR_MOVEMENT = auto()
+    ENDGAME = auto()
+
+
+class PlayerState(str, Enum):
+    CREATED = "CREATED"
+    MOVING = "MOVING"
+    ON_DESTINATION = "ON_DESTINATION"
+    INACTIVE = "INACTIVE"

hopper/errors.py

@@ -8,3 +8,7 @@ class PositionOutOfBounds(BaseError):
 
 class Collision(BaseError):
     ...
+
+
+class GameLockForMovement(BaseError):
+    ...

hopper/interfaces.py

@@ -0,0 +1,6 @@
+from typing import Protocol
+
+
+class SendGameDumpInterface(Protocol):
+    async def send_game_dump(self) -> None:
+        ...

hopper/models/config.py

@@ -1,10 +1,15 @@
 import logging
 from dataclasses import dataclass
-from typing import Optional
+from typing import List, Optional
+
+from hopper.models.player import Player
+from hopper.models.product import Product
+
 
 @dataclass
 class GameSettings:
-    MOVE_DELAY: int = 0.5  # seconds
+    MOVE_DELAY: float = 0.5  # seconds
+
 
 @dataclass
 class BoardSettings:
@@ -29,7 +34,7 @@ class WSServerSettings:
 @dataclass
 class DebugSettings:
     PRINT_BOARD: bool = False
-    CREATE_TEST_PLAYER: bool = False
+    PLAYERS: Optional[List[Player]] = None
 
 
 @dataclass
@@ -38,5 +43,7 @@ class Settings:
     board: BoardSettings
     inacivity_watchdog: InactivityWatchdogSettings
     ws_server: WSServerSettings
+    purchase_timeout: int = 10 # seconds
     log_level: int = logging.INFO
+    products: Optional[List[Product]] = None
     debug: Optional[DebugSettings] = None

hopper/models/player.py

@@ -3,6 +3,8 @@ import uuid
 from dataclasses import dataclass, field
 from typing import Optional
 
+from hopper.enums import PlayerState
+
 
 @dataclass
 class Position:
@@ -20,6 +22,7 @@ class Player:
     last_seen: datetime.datetime = field(
         default_factory=lambda: datetime.datetime.now()
     )
+    state: PlayerState = PlayerState.CREATED
     active: bool = True
     can_be_deactivated: bool = True
 

hopper/models/product.py

@@ -0,0 +1,8 @@
+from dataclasses import dataclass, field
+import uuid
+
+
+@dataclass
+class Product:
+    name: str
+    uuid: str = field(default_factory=lambda: str(uuid.uuid4()))

hopper/models/ws_dto.py

@@ -1,6 +1,10 @@
 from __future__ import annotations
 
+import json
+from typing import TypeVar, Generic
+
 from pydantic import Field
+from pydantic.generics import GenericModel
 
 from hopper.api.dto import BaseModel, BoardDto, DestinationDto, PlayerDto, PositionDto
 from hopper.enums import ObjectType
@@ -16,8 +20,31 @@ class LayerDto(BaseModel):
     objects: list[LayerObjectDto]
 
 
-class GameStateDto(BaseModel):
+class GameDumpPlayerDto(PlayerDto):
+    ...
+
+
+class GameDumpDto(BaseModel):
     board: BoardDto
     destination: DestinationDto
-    players: list[PlayerDto]
+    players: list[GameDumpPlayerDto]
     layers: list[LayerDto]
+
+
+TMessageData = TypeVar("TMessageData", bound=BaseModel)
+
+
+class WSMessage(GenericModel):
+    message: str
+    data: TMessageData
+
+    def __str__(self) -> str:
+        return self.to_str()
+
+    def to_str(self) -> str:
+        return json.dumps(self.dict())
+
+
+class WSGameDumpMessage(WSMessage):
+    message: str = "game_dump"
+    data: GameDumpDto

hopper/watchdog.py

@@ -5,14 +5,18 @@ import time
 from threading import Thread
 from typing import Optional
 
+from hopper.interfaces import SendGameDumpInterface
 from hopper.models.player import PlayerList
-from hopper.ws_server import WSServer
 from settings import settings
 
 
 class InactivityWatchdog(Thread):
     def __init__(
-        self, players: PlayerList, ws_server: Optional[WSServer] = None, *args, **kwargs
+        self,
+        players: PlayerList,
+        ws_server: Optional[SendGameDumpInterface] = None,
+        *args,
+        **kwargs,
     ) -> None:
         self.players = players
         self.ws_server = ws_server
@@ -34,7 +38,7 @@ class InactivityWatchdog(Thread):
             seconds=settings.inacivity_watchdog.KICK_TIMEOUT
         )
 
-        send_game_state = False
+        send_game_dump = False
 
         for player in self.players:
             if (
@@ -44,7 +48,7 @@ class InactivityWatchdog(Thread):
             ):
                 player.active = False
                 logging.info(f"Player {player} set as inactive")
-                send_game_state = True
+                send_game_dump = True
 
         # safe remove from list
         n = 0
@@ -53,18 +57,18 @@ class InactivityWatchdog(Thread):
             if player.can_be_deactivated and player.last_seen < kick_threshold:
                 self.players.pop(n)
                 logging.info(f"Player {player} kicked out")
-                send_game_state = True
+                send_game_dump = True
             else:
                 n += 1
 
-        if send_game_state:
+        if send_game_dump:
-            self.send_game_state()
+            self.send_game_dump()
 
-    def send_game_state(self):
+    def send_game_dump(self):
         if not self.ws_server:
             return
-        logging.info("Sending WS game state")
+        logging.info("Sending WS game dump")
-        asyncio.run(self.ws_server.send_game_state())
+        asyncio.run(self.ws_server.send_game_dump())
 
     def stop(self) -> None:
         self.stopped = True

hopper/ws_server.py

@@ -1,5 +1,4 @@
 import asyncio
-import json
 import logging
 from threading import Thread
 
@@ -7,59 +6,61 @@ import websockets
 from websockets import WebSocketServerProtocol
 from websockets.exceptions import ConnectionClosedOK
 
-from hopper.models.ws_dto import GameStateDto
+from hopper.models.ws_dto import GameDumpDto, WSGameDumpMessage
 from settings import settings
 
 
 class WSServer(Thread):
-    def __init__(self, *args, **kwargs) -> None:
-        self.connected_clients = set[WebSocketServerProtocol]()
-        super().__init__(*args, **kwargs)
-
     async def handler(self, websocket: WebSocketServerProtocol) -> None:
+        """New handler instance spawns for each connected client"""
         self.connected_clients.add(websocket)
         logging.info(f"Add client: {websocket.id}")
 
         try:
-            await self.send_game_state_to_client(websocket)
+            # send initial game dump to connected client
+            await self.send_game_dump_to_client(websocket)
+            # loop and do nothing while client is connected
             connected = True
             while connected:
                 try:
-                    message = await websocket.recv()
+                    # we're expecting nothing from client, but read if client sends a message
+                    await websocket.recv()
                 except ConnectionClosedOK:
                     connected = False
         finally:
             self.connected_clients.remove(websocket)
             logging.info(f"Remove client: {websocket.id}")
 
-    def _create_game_state_message(self) -> str:
+    def _create_game_dump_message(self) -> WSGameDumpMessage:
         # avoid circular imports
         from hopper.api.dependencies import get_game_engine
 
         engine = get_game_engine()
 
-        game_state = GameStateDto(
+        game_dump = GameDumpDto(
             board=engine.board,
             destination=engine.board.destination,
             players=engine.players,
             layers=engine.get_board_layout().layers,
         )
-        return json.dumps(game_state.dict())
+        return WSGameDumpMessage(data=game_dump)
 
-    async def send_game_state_to_client(
+    async def send_game_dump_to_client(
         self, websocket: WebSocketServerProtocol
     ) -> None:
-        message = self._create_game_state_message()
+        """Send game dump to the client"""
-        logging.debug(f"Sending game state to client: {websocket.id}")
+        message = self._create_game_dump_message()
-        await websocket.send(message)
+        logging.debug(f"Sending game dump to client: {websocket.id}")
+        await websocket.send(message.to_str())
 
-    async def send_game_state(self) -> None:
+    async def send_game_dump(self) -> None:
+        """Broadcast game state to all connected clients"""
         if not self.connected_clients:
             return
 
-        message = self._create_game_state_message()
+        message = self._create_game_dump_message()
         logging.debug(
-            f"Sending game state to clients: {self.connected_clients}: {message}"
+            f"Sending game dump to clients: {self.connected_clients}: {message}"
         )
         for client in self.connected_clients:
             await client.send(message)
@@ -77,4 +78,5 @@ class WSServer(Thread):
             await asyncio.Future()  # run forever
 
     def run(self) -> None:
+        self.connected_clients = set[WebSocketServerProtocol]()
         asyncio.run(self.run_async())

settings_template.py

@@ -14,5 +14,6 @@ settings = Settings(
     inacivity_watchdog=InactivityWatchdogSettings(),
     log_level=logging.INFO,
     ws_server=WSServerSettings(),
+    purchase_timeout=10,
     debug=None,
 )