Handle connection error in ws handler

.docker/run.sh

@@ -0,0 +1,11 @@
+#!/bin/sh
+
+PORT=${FAIRHOPPER_API_PORT=8010}
+
+echo "Starting FairHopper game server on port ${PORT}"
+
+uvicorn \
+    main:app \
+    --host 0.0.0.0 \
+    --port ${PORT} \
+    --workers=1

.docker/settings.py

@@ -0,0 +1,40 @@
+import os
+import logging
+
+from hopper.models.config import (
+    BoardSettings,
+    DebugSettings,
+    GameSettings,
+    InactivityWatchdogSettings,
+    Settings,
+    WSServerSettings,
+)
+from hopper.models.product import Product
+
+settings = Settings(
+    game=GameSettings(),
+    board=BoardSettings(
+        WIDTH=20,
+        HEIGHT=20,
+        OBSTACLE_COUNT=0,
+    ),
+    inacivity_watchdog=InactivityWatchdogSettings(),
+    purchase_timeout=5,
+    log_level=logging.INFO,
+    products=[
+        Product(name="CocaCola", id="cocacola-id"),
+        Product(name="Pepsi", id="pepsi-id"),
+        Product(name="Fanta", id="fanta-id"),
+        Product(name="Snickers", id="snickers-id"),
+        Product(name="Mars", id="mars-id"),
+        Product(name="Burek", id="burek-id"),
+    ],
+    ws_server=WSServerSettings(
+        HOST="0.0.0.0",
+        PORT=int(os.environ.get("FAIRHOPPER_WS_PORT", 8011)),
+    ),
+    debug=DebugSettings(
+        PRINT_BOARD=True,
+        PLAYERS=[],
+    ),
+)

.gitignore

@@ -4,3 +4,5 @@ __pycache__
 /env
 /.venv
 /settings.py
+/requirements.txt
+/frontend/js/config.js

Dockerfile

@@ -0,0 +1,50 @@
+FROM python:3.10.11-alpine3.17 as env-builder
+
+# handle optional arguments
+ARG INTERNAL_API_PORT=8010
+ARG INTERNAL_WS_PORT=8011
+
+RUN \
+    apk add --no-cache gcc musl-dev libffi-dev && \
+    pip install pip -U --no-cache-dir --prefer-binary && \
+    pip install poetry --no-cache-dir --prefer-binary
+
+WORKDIR /app
+
+COPY pyproject.toml .
+COPY poetry.lock .
+
+# create virtual environment
+RUN python -m venv /venv
+# set python thingies, set environment variables and activate virtual environment
+ENV \
+    PYTHONDONTWRITEBYTECODE=1 \
+    PYTHONUNBUFFERED=1 \
+    FAIRHOPPER_API_PORT=${INTERNAL_API_PORT} \
+    FAIRHOPPER_WS_PORT=${INTERNAL_WS_PORT} \
+    PATH="/venv/bin:$PATH"
+
+RUN \
+    # dump python dependencies into requirements file
+    poetry export --without-hashes --format=requirements.txt > requirements.txt && \
+    # install python libs
+    pip install -r requirements.txt --no-cache-dir --prefer-binary
+
+
+FROM python:3.10.11-alpine3.17 as runner
+
+WORKDIR /app
+COPY --from=env-builder /venv /venv
+
+# set python thingies and activate virtual environment
+ENV \
+    PYTHONDONTWRITEBYTECODE=1 \
+    PYTHONUNBUFFERED=1 \
+    PATH="/venv/bin:$PATH"
+
+# copy all relevant files
+COPY ./.docker/* ./
+COPY ./hopper ./hopper
+COPY ./main.py .
+
+ENTRYPOINT [ "/app/run.sh" ]

Makefile

@@ -1,3 +1,11 @@
+IMAGE_NAME=fairhopper-service
+CONTAINER_NAME=fairhopper-service
+INTERNAL_API_PORT=8010
+INTERNAL_WS_PORT=8011
+EXTERNAL_API_PORT=8010
+EXTERNAL_WS_PORT=8011
+
+
 run:
 	@poetry run \
 		uvicorn \
@@ -14,3 +22,37 @@ run-dev:
 			--port 8010 \
 			--workers=1 \
 			--reload
+
+create-requirements:
+	@poetry export \
+		--without-hashes \
+		--format=requirements.txt \
+		> requirements.txt
+
+docker-clean:
+	@echo "> Removing container $(CONTAINER_NAME)"
+	- @docker rm $(CONTAINER_NAME)
+	@echo "> Removing image $(CONTAINER_NAME)"
+	- @docker image rm $(CONTAINER_NAME)
+
+
+docker-build:
+	@docker \
+		buildx build \
+			--build-arg INTERNAL_API_PORT=$(INTERNAL_API_PORT) \
+			--build-arg INTERNAL_WS_PORT=$(INTERNAL_WS_PORT) \
+			--tag $(CONTAINER_NAME) \
+			.
+
+docker-run:
+	@docker \
+		run \
+		--publish $(EXTERNAL_API_PORT):$(INTERNAL_API_PORT) \
+		--publish $(EXTERNAL_WS_PORT):$(INTERNAL_WS_PORT) \
+		--name=$(CONTAINER_NAME) \
+		$(IMAGE_NAME) \
+		--detach
+
+docker-clean-build:
+	make clean
+	make build

README.md

@@ -1,5 +1,14 @@
 # FairHopper
 
+## Useful links
+
+- [Frontend](https://fairhopper.mjerenja.com)
+- [API](https://api.fairhopper.mjerenja.com)
+- [API Docs](https://api.fairhopper.mjerenja.com/docs)
+- [FairHopper](https://gitea.ekirin.com/Intis/fairhopper)
+- [FairHopper SDK](https://gitea.ekirin.com/Intis/fairhopper-sdk)
+- Websockets: wss://fairhopper.mjerenja.com/ws
+
 ## Game
 
 ### Overview
@@ -24,6 +33,7 @@
 ## Game States
 
 ```plantuml
+scale 1024 width
 hide empty description
 
 state "Start Game" as StartGame
@@ -52,10 +62,59 @@ EndPlayer --> UnlockGame: Unlock game\n for all players
 
 ## FairHopper Game Server
 
+### Start server as docker container
+
+Build image:
+```sh
+docker build . -t CONTAINER_NAME
+```
+
+Create docker container:
+```sh
+docker \
+  create \
+  --publish EXTERNAL_API_PORT:8010 \
+  --publish EXTERNAL_WS_PORT:8011 \
+  --name=CONTAINER_NAME \
+  IMAGE_NAME
+```
+
+Parameters:
+- `EXTERNAL_API_PORT` - REST API port
+- `EXTERNAL_WS_PORT` - Websockets port
+- `CONTAINER_NAME` - FairHopper container name
+- `IMAGE_NAME` - FairHopper image name
+
+Start docker container:
+```sh
+docker start CONTAINER_NAME -d
+```
+
+Stop docker container:
+```sh
+docker stop CONTAINER_NAME
+```
+
+Example:
+```sh
+docker build . -t fairhopper-service
+docker \
+  run \
+  --publish 8010:8010 \
+  --publish 8011:8011 \
+  --name=fairhopper-service \
+  fairhopper \
+  --detach
+docker start fairhopper-service -d
+docker stop fairhopper-service
+```
+
+### Start server on local machine
+
 Requirements:
 - Python 3.10+
 
-### Install virtual envirnonment
+#### Install virtual envirnonment
 
 Project uses [Poetry](https://python-poetry.org), ultimate dependency management software for Python.
 
@@ -69,14 +128,14 @@ Install virtual environment:
 poetry install
 ```
 
-### Setting up
+#### Setting up
 
 Copy `settings_template.py` to `settings.py`.
 
 Edit `settings.py` and customize application.
 
 
-### Starting FairHopper Game Server
+#### Starting FairHopper Game Server
 
 ```sh
 make run
@@ -314,46 +373,55 @@ Response body:
 ### WS Data format
 - json
 
+```json
+{
+  "message": message_type,
+  "data": ...
+}
+```
+
 
 ### Game state structure
 
-URI: `/game-state`
+Message: `game_dump`
 
 Data:
 ```json
 {
   "board": {
-		"width": 21,
-		"height": 21
+    "width": 10,
+    "height": 10
   },
   "destination": {
     "position": {
-			"x": 10,
-			"y": 10
+      "x": 5,
+      "y": 5
     }
   },
   "players": [
     {
-			"id": "test-player-id",
+      "id": "test-player-pero",
       "name": "Pero",
       "active": true,
       "position": {
-				"x": 2,
-				"y": 2
+        "x": 3,
+        "y": 3
       },
-			"move_count": 3,
-			"move_attempt_count": 3
+      "move_count": 0,
+      "move_attempt_count": 0,
+      "state": "CREATED"
     },
     {
-			"id": "95962b49-0003-4bf2-b205-71f2590f2318",
+      "id": "test-player-mirko",
       "name": "Mirko",
       "active": true,
       "position": {
-				"x": 0,
-				"y": 0
+        "x": 4,
+        "y": 4
       },
-			"move_count": 15,
-			"move_attempt_count": 20
+      "move_count": 0,
+      "move_attempt_count": 0,
+      "state": "CREATED"
     }
   ],
   "layers": [
@@ -363,36 +431,22 @@ Data:
         {
           "type": "OBSTACLE",
           "position": {
-						"x": 4,
-						"y": 2
-					}
-				},
-				{
-					"type": "OBSTACLE",
-					"position": {
-						"x": 4,
-						"y": 13
-					}
-				},
-				{
-					"type": "OBSTACLE",
-					"position": {
-						"x": 18,
-						"y": 18
+            "x": 0,
+            "y": 6
           }
         },
         {
           "type": "OBSTACLE",
           "position": {
             "x": 5,
-						"y": 4
+            "y": 1
           }
         },
         {
           "type": "OBSTACLE",
           "position": {
-						"x": 7,
-						"y": 10
+            "x": 1,
+            "y": 6
           }
         }
       ]
@@ -403,8 +457,8 @@ Data:
         {
           "type": "DESTINATION",
           "position": {
-						"x": 10,
-						"y": 10
+            "x": 5,
+            "y": 5
           }
         }
       ]
@@ -415,15 +469,15 @@ Data:
         {
           "type": "PLAYER",
           "position": {
-						"x": 2,
-						"y": 2
+            "x": 3,
+            "y": 3
           }
         },
         {
           "type": "PLAYER",
           "position": {
-						"x": 0,
-						"y": 0
+            "x": 4,
+            "y": 4
           }
         }
       ]
@@ -431,3 +485,110 @@ Data:
   ]
 }
 ```
+
+### Product purchase start
+
+Message: `product_purchase_start`
+
+Data:
+```json
+{
+  "player": {
+    "id": "test-player-pero",
+    "name": "Pero",
+    "active": true,
+    "position": {
+      "x": 10,
+      "y": 10
+    },
+    "move_count": 1,
+    "move_attempt_count": 1,
+    "state": "ON_DESTINATION"
+  },
+  "products": [
+    {
+      "name": "CocaCola",
+      "id": "cocacola-id",
+      "description": null
+    },
+    {
+      "name": "Pepsi",
+      "id": "pepsi-id",
+      "description": null
+    },
+    {
+      "name": "Fanta",
+      "id": "fanta-id",
+      "description": null
+    },
+    {
+      "name": "Snickers",
+      "id": "snickers-id",
+      "description": null
+    },
+    {
+      "name": "Mars",
+      "id": "mars-id",
+      "description": null
+    },
+    {
+      "name": "Burek",
+      "id": "burek-id",
+      "description": null
+    }
+  ],
+  "timeout": 5
+}
+```
+
+### Product purchase timer tick
+
+Message: `product_purchase_timer_tick`
+
+Data:
+```json
+{
+  "time_left": 4,
+  "player": {
+    "id": "test-player-pero",
+    "name": "Pero",
+    "active": true,
+    "position": {
+      "x": 10,
+      "y": 10
+    },
+    "move_count": 1,
+    "move_attempt_count": 1,
+    "state": "ON_DESTINATION"
+  }
+}
+```
+
+### Product purchase timer done
+
+Message: `product_purchase_done`
+
+Data:
+```json
+{
+  "player": {
+    "id": "test-player-pero",
+    "name": "Pero",
+    "active": true,
+    "position": {
+      "x": 10,
+      "y": 10
+    },
+    "move_count": 1,
+    "move_attempt_count": 1,
+    "state": "ON_DESTINATION"
+  },
+  "product": {
+    "name": "CocaCola",
+    "id": "cocacola-id",
+    "description": null
+  }
+}
+```
+
+If product selection timeout occured, product will be null.

frontend/index.html

@@ -8,13 +8,14 @@
     <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">
+    <script src="js/config.js"></script>
     <script src="js/frontend.js"></script>
 
     <title>FairHopper Visualisation Client</title>
 </head>
 
 <body>
-    <main class="container-fluid container">
+    <main class="container-fluid main-container">
         <h1 class="mt-1 mb-2">
             FairHopper Visualisation Client
         </h1>

frontend/js/frontend.js

@@ -1,3 +1,7 @@
+if (typeof FAIRHOPPER_WS_SERVER === "undefined") {
+    var FAIRHOPPER_WS_SERVER = "ws://127.0.0.1:8011";
+}
+
 const BOARD_ICONS = {
     PLAYER: "😀",
     PLAYER_ON_DESTINATION: "😎",
@@ -33,10 +37,10 @@ function renderCellContent(position, content) {
 }
 
 function renderPlayerList(players) {
-    const html = players
+    document.getElementById("players-content").innerHTML = players
         .filter((player) => player.active)
         .map((player) => {
-            const onDestination = player.state == "ON_DESTINATION";
+            const onDestination = player.state === "ON_DESTINATION";
             return `
                 <li class="${onDestination ? "text-success" : ""}">
                     ${player.name} (${player.move_count})
@@ -45,7 +49,6 @@ function renderPlayerList(players) {
             `;
         })
         .join("");
-    document.getElementById("players-content").innerHTML = html;
 }
 
 function renderPlayers(players) {
@@ -53,14 +56,13 @@ function renderPlayers(players) {
         .filter((player) => player.active)
         .forEach((player) => {
             const cell = findCell(player.position);
-            const onDestination = player.state == "ON_DESTINATION";
+            const onDestination = player.state === "ON_DESTINATION";
             const playerIcon = onDestination ? BOARD_ICONS.PLAYER_ON_DESTINATION : BOARD_ICONS.PLAYER;
             if (cell) {
-                const html = `
+                cell.innerHTML = `
                     <div class="player-tooltip">${player.name}</div>
                     ${playerIcon}
                 `;
-                cell.innerHTML = html;
             }
         });
 }
@@ -85,6 +87,8 @@ function renderDestination(position) {
 }
 
 function renderGameDump(data) {
+    closePurchaseWindow();
+
     createBoard(data.board);
     renderObstacles(data.layers);
     renderDestination(data.destination.position);
@@ -98,10 +102,10 @@ function productPurchaseStart(products, purchaseTimeout) {
     const contentElement = document.getElementById("products-content");
     const purchaseTimeoutElement = document.getElementById("purchase-countdown");
 
-    const html = products
+    contentElement.innerHTML = products
         .map((product) => {
             return `
-                <div class="card product">
+                <div class="card product" id="product-${product.id}">
                     <img src="img/products/${product.name}.jpeg" class="card-img-topx" alt="${product.name}">
                     <div class="card-body">
                         <h5 class="card-title">${product.name}</h5>
@@ -110,8 +114,6 @@ function productPurchaseStart(products, purchaseTimeout) {
             `;
         })
         .join("");
-
-    contentElement.innerHTML = html;
     containerElement.classList.remove("d-none");
     purchaseTimeoutElement.innerText = purchaseTimeout;
 }
@@ -121,18 +123,20 @@ function productPurchaseTimerTick(timeLeft) {
     purchaseTimeoutElement.innerText = timeLeft;
 }
 
-function productPurchased(product) {
-    console.log("productPurchased:", product);
-}
-
-function productPurchaseDone() {
-    console.log("productPurchaseDone");
+function closePurchaseWindow() {
     const container = document.getElementById("purchase-container");
     container.classList.add("d-none");
 }
 
+function productPurchaseDone(product) {
+    const cardContainer = document.getElementById(`product-${product.id}`);
+    cardContainer.classList.add("selected");
+}
+
 function wsConnect() {
-    let ws = new WebSocket("ws://localhost:8011");
+    console.log("Attempting to connect to", FAIRHOPPER_WS_SERVER);
+    let ws = new WebSocket(FAIRHOPPER_WS_SERVER);
+
     ws.onopen = () => {
         console.log("WS connected");
     };
@@ -151,11 +155,8 @@ function wsConnect() {
             case "product_purchase_timer_tick":
                 productPurchaseTimerTick(wsMessage.data.time_left);
                 break;
-            case "product_purchased":
-                productPurchased(wsMessage.data);
-                break;
             case "product_purchase_done":
-                productPurchaseDone();
+                productPurchaseDone(wsMessage.data.product);
                 break;
             default:
                 console.error("Unknown message:", wsMessage);
@@ -163,7 +164,7 @@ function wsConnect() {
     };
 
     ws.onclose = (e) => {
-        setTimeout(function () {
+        setTimeout(() => {
             wsConnect();
         }, 1000);
     };

frontend/styles.css

@@ -2,7 +2,7 @@ body {
     background-color: whitesmoke;
 }
 
-main.container {
+main.main-container {
     position: relative;
 }
 
@@ -84,8 +84,13 @@ ul.players {
     grid-template-columns: 1fr 1fr 1fr;
 }
 
+.purchase-container .products-content .product.selected {
+    background-color: pink;
+}
+
 .purchase-container .products-content .product .card-title {
     text-align: center;
+    font-size: 12pt;
 }
 
 .purchase-container .products-content .product img {

hopper/api/views.py

@@ -17,7 +17,12 @@ from hopper.api.dto import (
 )
 from hopper.engine import GameEngine
 from hopper.enums import Direction, PlayerMoveResult
-from hopper.errors import Collision, GameLockForMovement, PositionOutOfBounds, PurchaseForbiddenForPlayer
+from hopper.errors import (
+    Collision,
+    GameLockForMovement,
+    PositionOutOfBounds,
+    PurchaseForbiddenForPlayer,
+)
 from hopper.models.player import Player
 from settings import settings
 
@@ -167,23 +172,39 @@ async def get_product(id: str) -> ProductDto:
     )
 
 
-@router.post("/player/{id}/product/purchase")
+@router.post(
+    "/player/{id}/product/purchase",
+    response_model=ProductDto,
+    responses={
+        status.HTTP_200_OK: {
+            "model": ProductDto,
+            "description": "Product purchased",
+        },
+        status.HTTP_403_FORBIDDEN: {
+            "model": ErrorResponseDto,
+            "description": "Purchase forbidden for this player",
+        },
+        status.HTTP_404_NOT_FOUND: {
+            "model": ErrorResponseDto,
+            "description": " Player with id not found, probably kicked out",
+        },
+    },
+)
 async def purchase_product(
     body: PurchaseProductDto,
     engine: GameEngine = Depends(get_game_engine),
     player: Player = Depends(get_player),
-):
+) -> ProductDto:
     for product in settings.products:
         if product.id == body.product_id:
             try:
                 await engine.purchase_product(player=player, product=product)
+                return ProductDto.from_orm(product)
             except PurchaseForbiddenForPlayer:
                 raise HTTPException(
                     status_code=status.HTTP_403_FORBIDDEN,
                     detail="Purchase forbidden for this player",
                 )
-            break
-    else:
     raise HTTPException(
         status_code=status.HTTP_404_NOT_FOUND, detail="Product not found"
     )

hopper/engine.py

@@ -212,6 +212,8 @@ class GameEngine:
         )
         self._purchase_countdown_timer.start()
 
+        await asyncio.sleep(settings.game.PURCHASE_START_DELAY)
+
     async def purchase_product(self, player: Player, product: Product) -> None:
         if not player.state == PlayerState.ON_DESTINATION:
             raise PurchaseForbiddenForPlayer()
@@ -220,6 +222,7 @@ class GameEngine:
         await self.ws_server.send_product_purchase_done_message(
             player=player, product=product
         )
+        await asyncio.sleep(settings.game.PURCHASE_FINISHED_DELAY)
         await self.reset_game()
 
     def _reset_player(self, player) -> None:

hopper/models/config.py

@@ -9,6 +9,8 @@ from hopper.models.product import Product
 @dataclass
 class GameSettings:
     MOVE_DELAY: float = 0.5  # seconds
+    PURCHASE_START_DELAY: float = 2  # seconds
+    PURCHASE_FINISHED_DELAY: float = 2  # seconds
 
 
 @dataclass
@@ -27,7 +29,7 @@ class InactivityWatchdogSettings:
 
 @dataclass
 class WSServerSettings:
-    HOST: str = "localhost"
+    HOST: str = "127.0.0.1"
     PORT: int = 8011
 
 
@@ -45,5 +47,5 @@ class Settings:
     ws_server: WSServerSettings
     purchase_timeout: int = 10  # seconds
     log_level: int = logging.INFO
-    products: Optional[List[Product]] = None
+    products: List[Product] = None
     debug: Optional[DebugSettings] = None

hopper/ws_server.py

@@ -5,7 +5,7 @@ from typing import Iterable, Optional
 
 import websockets
 from websockets import WebSocketServerProtocol
-from websockets.exceptions import ConnectionClosedOK
+from websockets.exceptions import ConnectionClosedOK, ConnectionClosedError
 
 from hopper.models.player import Player
 from hopper.models.product import Product
@@ -44,6 +44,10 @@ class WSServer(Thread):
                     # we're expecting nothing from client, but read if client sends a message
                     await websocket.recv()
                 except ConnectionClosedOK:
+                    logging.info(f"Connection closed OK for client: {websocket.id}")
+                    connected = False
+                except ConnectionClosedError:
+                    logging.info(f"Connection closed error for client: {websocket.id}")
                     connected = False
         finally:
             self.connected_clients.remove(websocket)