Endgame WS messages & docs

.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
@@ -8,10 +17,10 @@
 - Destination: center of a board (W / 2, H / 2)
 - Initial player position: Random on board border
 - Available moves:
-	- left
-	- right
-	- up
-	- down
+    - left
+    - right
+    - up
+    - down
 - Optional on-board obstacles
 
 ### Rules
@@ -21,12 +30,91 @@
 - Move timeout: 10s. Game is finished if timeout ocurrs.
 
 
+## Game States
+
+```plantuml
+scale 1024 width
+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
 
+### 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.
 
@@ -40,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
@@ -71,22 +159,22 @@ WebSockets server runs on port **8011**. To run WS Server on different port, edi
 ### Architecture
 
 ```plantuml
+scale 1024 width
 actor "Player 1" as P1
 actor "Player 2" as P2
 actor "Player 3" as P3
 
-
 package Masterpiece #seashell {
     rectangle "FairHopper Game Server" #lightcyan {
         usecase API as "API Server"
         usecase Game as "Game Engine"
         usecase WS as "WS Server"
     }
-    usecase Vis as "Visualisation\nService"
+    usecase Vis as "Flutter\nVisualisation\nService"
 }
 
-usecase ExtVis1 as "Visualisation\nService"
-usecase ExtVis2 as "Visualisation\nService"
+usecase ExtVis1 as "Visualisation\nClient"
+usecase ExtVis2 as "Visualisation\nClient"
 
 P1 -left-> API: REST API
 P2 -left-> API: REST API
@@ -101,6 +189,7 @@ WS --> ExtVis2: WS Game State
 ### WebSockets
 
 ```plantuml
+scale 1024 width
 box "FairHopper Game Server" #lightcyan
     participant Game as "Game Engine"
     participant WS as "WS Server"
@@ -108,25 +197,65 @@ endbox
 participant Client1 as "Visualisation\nClient 1"
 participant Client2 as "Visualisation\nClient 2"
 
+== Player movement mode ==
+
 Game ->o WS: Send initial state
 
 Client1 ->o WS: Client connect
 activate WS #coral
 	WS -> Client1: Game state
-deactivate
+deactivate WS
 
 Client2 ->o WS: Client connect
 activate WS #coral
 	WS -> Client2: Game state
-deactivate
+deactivate WS
 
 loop #lightyellow On game state change
     Game ->o WS: Game state
     activate WS #coral
         WS o-> Client1: Game state
         WS o-> Client2: Game state
-    deactivate
+    deactivate WS
 end
+
+== Player reached destination ==
+
+Game -> Game: Lock game for other players
+activate Game
+  Game -> WS: Player reached destination
+  activate WS #coral
+    WS o-> Client1: Select product
+    WS o-> Client2: Select product
+  deactivate WS
+deactivate Game
+
+loop #lightyellow Product select countdown timer (60s)
+	Game ->o WS: Timer timeout
+  activate Game
+    activate WS #coral
+      WS o-> Client1: Selection timeout
+      WS o-> Client2: Selection timeout
+    deactivate WS
+    Game -> Game: Unlock game
+  deactivate Game
+end
+
+Client1 -> WS: Product selected
+activate WS #coral
+	WS o-> Game: Product selected
+    activate Game
+	WS o-> Client2: Product selected
+deactivate WS
+
+
+Game -> Game: Unlock game
+    Game -> WS: Game state
+    activate WS #coral
+        WS o-> Client1: Game state
+        WS o-> Client2: Game state
+    deactivate WS
+deactivate Game
 ```
 
 
@@ -137,7 +266,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).
@@ -149,87 +278,87 @@ Check REST API interface on [FastAPI docs](http://localhost:8010/docs).
 Request body:
 ```json
 {
-	"player_name": "Pero"
+  "player_name": "Pero"
 }
 ```
 
 Response body:
 ```json
 {
-	"board": {
-		"width": 101,
-		"height": 101
-	},
-	"destination": {
-		"position": {
-			"x": 50,
-			"y": 50
-		}
-	},
-	"player": {
-		"uuid": "75bba7cd-a4c1-4b50-b0b5-6382c2822a25",
-		"name": "Pero",
-		"position": {
-			"x": 0,
-			"y": 10
-		},
-		"move_count": 0,
-		"move_attempt_count": 0
-	}
+  "board": {
+    "width": 101,
+    "height": 101
+  },
+  "destination": {
+    "position": {
+      "x": 50,
+      "y": 50
+    }
+  },
+  "player": {
+    "id": "75bba7cd-a4c1-4b50-b0b5-6382c2822a25",
+    "name": "Pero",
+    "position": {
+      "x": 0,
+      "y": 10
+    },
+    "move_count": 0,
+    "move_attempt_count": 0
+  }
 }
 ```
 
 ### Player Move
 
-- POST `/player/{uuid}/move/left`
-- POST `/player/{uuid}/move/right`
-- POST `/player/{uuid}/move/up`
-- POST `/player/{uuid}/move/down`
+- POST `/player/{id}/move/left`
+- POST `/player/{id}/move/right`
+- POST `/player/{id}/move/up`
+- POST `/player/{id}/move/down`
 
 Request body: None
 
 Response code:
 - 200 OK: Destination reached
 - 201 Created: Player moved successfully
-- 403 Forbidden: Player uuid not valid, probably timeout
+- 403 Forbidden: Player id not valid, probably timeout
 - 409 Conflict: Invalid move, obstacle or position out of board
 - 422 Unprocessable Content: Validation error
 
 Response body:
 ```json
 {
-	"player": {
-		"uuid": "string",
-		"name": "Pero",
-		"position": {
-			"x": 50,
-			"y": 50
-		},
-		"move_count": 10,
-		"move_attempt_count": 12
-	}
+  "player": {
+    "id": "string",
+    "name": "Pero",
+    "position": {
+      "x": 50,
+      "y": 50
+    },
+    "move_count": 10,
+    "move_attempt_count": 12
+  }
 }
 ```
 
 ### Get Player Info
 
-GET `/player/{{uuid}}`
+GET `/player/{{id}}`
 
 Request body: None
 
 Response body:
 ```json
 {
-	"player": {
-		"uuid": "string",
-		"name": "Pero",
-		"position": {
-			"x": 50,
-			"y": 50
-		},
-		"move_count": 10,
-		"move_attempt_count": 12
-	}
+  "player": {
+    "id": "string",
+    "name": "Pero",
+    "position": {
+      "x": 50,
+      "y": 50
+    },
+    "move_count": 10,
+    "move_attempt_count": 12
+  }
 }
 ```
 
@@ -240,19 +369,19 @@ GET `/game`
 Response body:
 ```json
 {
-	"playerId": "75bba7cd-a4c1-4b50-b0b5-6382c2822a25",
-	"board": {
-		"width": 101,
-		"height": 101
-	},
-	"destinationPosition": {
-		"x": 50,
-		"y": 50
-	},
-	"playerPosition": {
-		"x": 0,
-		"y": 10
-	}
+  "playerId": "75bba7cd-a4c1-4b50-b0b5-6382c2822a25",
+  "board": {
+    "width": 101,
+    "height": 101
+  },
+  "destinationPosition": {
+    "x": 50,
+    "y": 50
+  },
+  "playerPosition": {
+    "x": 0,
+    "y": 10
+  }
 }
 ```
 
@@ -261,120 +390,157 @@ Response body:
 ### WS Data format
 - json
 
+```json
+{
+  "message": message_type,
+  "data": ...
+}
+```
+
 
 ### Game state structure
 
-URI: `/game-state`
+Direction: Game server -> Clients
+
+Message: `game_dump`
 
 Data:
 ```json
 {
-	"board": {
-		"width": 21,
-		"height": 21
-	},
-	"destination": {
-		"position": {
-			"x": 10,
-			"y": 10
-		}
-	},
-	"players": [
-		{
-			"uuid": "test-player-id",
-			"name": "Pero",
-			"active": true,
-			"position": {
-				"x": 2,
-				"y": 2
-			},
-			"move_count": 3,
-			"move_attempt_count": 3
-		},
-		{
-			"uuid": "95962b49-0003-4bf2-b205-71f2590f2318",
-			"name": "Mirko",
-			"active": true,
-			"position": {
-				"x": 0,
-				"y": 0
-			},
-			"move_count": 15,
-			"move_attempt_count": 20
-		}
-	],
-	"layers": [
-		{
-			"name": "obstacles",
-			"objects": [
-				{
-					"type": "OBSTACLE",
-					"position": {
-						"x": 4,
-						"y": 2
-					}
-				},
-				{
-					"type": "OBSTACLE",
-					"position": {
-						"x": 4,
-						"y": 13
-					}
-				},
-				{
-					"type": "OBSTACLE",
-					"position": {
-						"x": 18,
-						"y": 18
-					}
-				},
-				{
-					"type": "OBSTACLE",
-					"position": {
-						"x": 5,
-						"y": 4
-					}
-				},
-				{
-					"type": "OBSTACLE",
-					"position": {
-						"x": 7,
-						"y": 10
-					}
-				}
-			]
-		},
-		{
-			"name": "destination",
-			"objects": [
-				{
-					"type": "DESTINATION",
-					"position": {
-						"x": 10,
-						"y": 10
-					}
-				}
-			]
-		},
-		{
-			"name": "players",
-			"objects": [
-				{
-					"type": "PLAYER",
-					"position": {
-						"x": 2,
-						"y": 2
-					}
-				},
-				{
-					"type": "PLAYER",
-					"position": {
-						"x": 0,
-						"y": 0
-					}
-				}
-			]
-		}
-	]
+  "board": {
+    "width": 10,
+    "height": 10
+  },
+  "destination": {
+    "position": {
+      "x": 5,
+      "y": 5
+    }
+  },
+  "players": [
+    {
+      "id": "test-player-pero",
+      "name": "Pero",
+      "active": true,
+      "position": {
+        "x": 3,
+        "y": 3
+      },
+      "move_count": 0,
+      "move_attempt_count": 0,
+      "state": "CREATED"
+    },
+    {
+      "id": "test-player-mirko",
+      "name": "Mirko",
+      "active": true,
+      "position": {
+        "x": 4,
+        "y": 4
+      },
+      "move_count": 0,
+      "move_attempt_count": 0,
+      "state": "CREATED"
+    }
+  ],
+  "layers": [
+    {
+      "name": "obstacles",
+      "objects": [
+        {
+          "type": "OBSTACLE",
+          "position": {
+            "x": 0,
+            "y": 6
+          }
+        },
+        {
+          "type": "OBSTACLE",
+          "position": {
+            "x": 5,
+            "y": 1
+          }
+        },
+        {
+          "type": "OBSTACLE",
+          "position": {
+            "x": 1,
+            "y": 6
+          }
+        }
+      ]
+    },
+    {
+      "name": "destination",
+      "objects": [
+        {
+          "type": "DESTINATION",
+          "position": {
+            "x": 5,
+            "y": 5
+          }
+        }
+      ]
+    },
+    {
+      "name": "players",
+      "objects": [
+        {
+          "type": "PLAYER",
+          "position": {
+            "x": 3,
+            "y": 3
+          }
+        },
+        {
+          "type": "PLAYER",
+          "position": {
+            "x": 4,
+            "y": 4
+          }
+        }
+      ]
+    }
+  ]
 }
 ```
+
+### Player reached destination
+
+Direction: Game server -> Clients
+
+Message: `player_reached_destination`
+
+Data:
+```json
+{
+  "player": {
+    "id": "2e0f1a50-eaa6-4efd-b0c3-adbf7000eec2",
+    "name": "Joso",
+    "active": true,
+    "position": {
+      "x": 5,
+      "y": 5
+    },
+    "move_count": 6,
+    "move_attempt_count": 6,
+    "state": "ON_DESTINATION"
+  }
+}
+```
+
+### Product selection timeout
+
+Direction: Game server -> Clients
+
+Message: `product_selection_timeout`
+
+Data: `null`
+
+### Product selection done
+
+Message: `product_selection_done`
+
+Direction: Client -> Game server, Game server -> Clients
+
+Data: `null`

api_tests/requests.http

@@ -15,21 +15,34 @@ GET http://localhost:8010/game
 ###
 
 # get player info
-GET http://localhost:8010/player/test-player-id
+GET http://localhost:8010/player/test-player-pero
 ###
 
 # move player left
-POST http://localhost:8010/player/test-player-id/move/left
+POST http://localhost:8010/player/test-player-pero/move/left
 ###
 
 # move player right
-POST http://localhost:8010/player/test-player-id/move/right
+POST http://localhost:8010/player/test-player-pero/move/right
 ###
 
 # move player up
-POST http://localhost:8010/player/test-player-id/move/up
+POST http://localhost:8010/player/test-player-pero/move/up
 ###
 
 # move player down
-POST http://localhost:8010/player/test-player-id/move/down
+POST http://localhost:8010/player/test-player-pero/move/down
+###
+
+# purchase product
+POST http://localhost:8010/player/test-player-pero/product/purchase
+Content-Type: application/json
+
+{
+  "product_id": "cocacola-id"
+}
+###
+
+# move Mirko left
+POST http://localhost:8010/player/test-player-mirko/move/left
 ###

frontend/index.html

@@ -8,15 +8,29 @@
     <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="https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/js/bootstrap.min.js"
+        integrity="sha384-cuYeSxntonz0PPNlHhBs68uyIAVpIIOZZ5JqeqvYYIcEL727kskC66kF92t6Xl2V"
+        crossorigin="anonymous"></script>
+    <script src="js/config.js"></script>
+    <script src="js/frontend.js"></script>
 
     <title>FairHopper Visualisation Client</title>
 </head>
 
 <body>
-    <div class="container-fluid">
+    <main class="container-fluid main-container">
         <h1 class="mt-1 mb-2">
             FairHopper Visualisation Client
         </h1>
+        <div id="purchase-container" class="purchase-container d-none">
+            <div class="d-flex header">
+                <h3>
+                    Product selection
+                </h3>
+                <h3 id="purchase-countdown" class="countdown"></h3>
+            </div>
+            <div id="products-content" class="products-content"></div>
+        </div>
         <div class="row">
             <div class="col-10">
                 <div class="board-container">
@@ -30,123 +44,27 @@
                 <ul class="players" id="players-content"></ul>
             </div>
         </div>
+    </main>
+
+    <div class="modal fade" id="player-on-destination-modal">
+        <div class="modal-dialog">
+            <div class="modal-content">
+                <div class="modal-header">
+                    <h5 class="modal-title">Player on destination</h5>
+                </div>
+                <div class="modal-body">
+                    Player <strong class="player-name"></strong>
+                    reached destination in <strong class="move-count"></strong>
+                    moves.
+                </div>
+                <div class="modal-footer">
+                    <button type="button" class="btn btn-primary" id="finish-product-selection" data-bs-dismiss="modal">
+                        Finish product selection
+                    </button>
+                </div>
+            </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++) {
-            let colHtml = "";
-            for (let x = 0; x < board.width; x++) {
-                colHtml += `<div class="cell" id="cell-${x}-${y}">&nbsp;</div>`;
-            }
-            html += `
-                <div class="flex-grid">
-                    ${colHtml}
-                </div>
-            `;
-        }
-        document.getElementById("board-content").innerHTML = html;
-    }
-
-    function findCell(position) {
-        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.filter(player => player.active).map((player) => {
-            return `
-                <li class="${player.reached_destination ? "text-success" : ""}">
-                    ${player.name} (${player.move_count})
-                    ${player.reached_destination ? "✅" : ""}
-                </li>
-            `;
-        }).join("");
-        document.getElementById("players-content").innerHTML = html;
-    }
-
-    function renderPlayers(players) {
-        players.filter(player => player.active).forEach(player => {
-            const cell = findCell(player.position);
-            const playerIcon = player.reached_destination ? BOARD_ICONS.PLAYER_ON_DESTINATION : BOARD_ICONS.PLAYER;
-            if (cell) {
-                const html = `
-                    <div class="player-tooltip">${player.name}</div>
-                    ${playerIcon}
-                `;
-                cell.innerHTML = html;
-            }
-        });
-    }
-
-    function getLayerObjectsOfType(layers, type) {
-        let objects = [];
-        layers.forEach(layer => {
-            objects = objects.concat(layer.objects.filter(obj => obj.type === type))
-        });
-        return objects;
-    }
-
-    function renderObstacles(layers) {
-        const objects = getLayerObjectsOfType(layers, "OBSTACLE");
-        objects.forEach(obj => {
-            renderCellContent(obj.position, BOARD_ICONS.OBSTACLE);
-        });
-    }
-
-    function renderDestination(position) {
-        renderCellContent(position, BOARD_ICONS.DESTINATION);
-    }
-
-
-    function wsConnect() {
-        let ws = new WebSocket('ws://localhost:8011');
-        ws.onopen = () => {
-            console.log("WS connected")
-        };
-
-        ws.onmessage = (e) => {
-            const data = JSON.parse(e.data);
-            console.log("WS message received:", data)
-
-            createBoard(data.board);
-            renderObstacles(data.layers)
-            renderDestination(data.destination.position);
-            renderPlayerList(data.players);
-            renderPlayers(data.players);
-        };
-
-        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>
-
-
 </html>

frontend/js/frontend.js

@@ -0,0 +1,178 @@
+if (typeof FAIRHOPPER_WS_SERVER === "undefined") {
+    var FAIRHOPPER_WS_SERVER = "ws://127.0.0.1:8011";
+}
+
+let ws = null;
+let playerOnDestinationModal = null;
+
+const BOARD_ICONS = {
+    PLAYER: "😀",
+    PLAYER_ON_DESTINATION: "😎",
+    OBSTACLE: "🔥",
+    DESTINATION: "🏠",
+};
+
+function createBoard(board) {
+    let html = "";
+    for (let y = 0; y < board.height; y++) {
+        let colHtml = "";
+        for (let x = 0; x < board.width; x++) {
+            colHtml += `<div class="cell" id="cell-${x}-${y}">&nbsp;</div>`;
+        }
+        html += `
+            <div class="flex-grid">
+                ${colHtml}
+            </div>
+        `;
+    }
+    document.getElementById("board-content").innerHTML = html;
+}
+
+function findCell(position) {
+    return document.getElementById(`cell-${position.x}-${position.y}`);
+}
+
+function renderCellContent(position, content) {
+    const cell = findCell(position);
+    if (cell) {
+        cell.innerText = content;
+    }
+}
+
+function renderPlayerList(players) {
+    document.getElementById("players-content").innerHTML = players
+        .filter((player) => player.active)
+        .map((player) => {
+            const onDestination = player.state === "ON_DESTINATION";
+            return `
+                <li class="${onDestination ? "text-success" : ""}">
+                    ${player.name} (${player.move_count})
+                    ${onDestination ? "✅" : ""}
+                </li>
+            `;
+        })
+        .join("");
+}
+
+function renderPlayers(players) {
+    players
+        .filter((player) => player.active)
+        .forEach((player) => {
+            const cell = findCell(player.position);
+            const onDestination = player.state === "ON_DESTINATION";
+            const playerIcon = onDestination ? BOARD_ICONS.PLAYER_ON_DESTINATION : BOARD_ICONS.PLAYER;
+            if (cell) {
+                cell.innerHTML = `
+                    <div class="player-tooltip">${player.name}</div>
+                    ${playerIcon}
+                `;
+            }
+        });
+}
+
+function getLayerObjectsOfType(layers, type) {
+    let objects = [];
+    layers.forEach((layer) => {
+        objects = objects.concat(layer.objects.filter((obj) => obj.type === type));
+    });
+    return objects;
+}
+
+function renderObstacles(layers) {
+    const objects = getLayerObjectsOfType(layers, "OBSTACLE");
+    objects.forEach((obj) => {
+        renderCellContent(obj.position, BOARD_ICONS.OBSTACLE);
+    });
+}
+
+function renderDestination(position) {
+    renderCellContent(position, BOARD_ICONS.DESTINATION);
+}
+
+function renderGameDump(data) {
+    createBoard(data.board);
+    renderObstacles(data.layers);
+    renderDestination(data.destination.position);
+    renderPlayerList(data.players);
+    renderPlayers(data.players);
+}
+
+function playerReachedDestination(data) {
+    const dlgElement = document.getElementById("player-on-destination-modal");
+    dlgElement.querySelector(".player-name").textContent = data.player.name;
+    dlgElement.querySelector(".move-count").textContent = data.player.move_count;
+    playerOnDestinationModal.show();
+}
+
+function productSelectionTimeout() {
+    playerOnDestinationModal.hide();
+}
+
+function productSelectionDone() {
+    playerOnDestinationModal.hide();
+}
+
+function wsConnect() {
+    console.log("Attempting to connect to", FAIRHOPPER_WS_SERVER);
+    ws = new WebSocket(FAIRHOPPER_WS_SERVER);
+
+    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;
+            case "player_reached_destination":
+                playerReachedDestination(wsMessage.data);
+                break;
+            case "product_selection_timeout":
+                productSelectionTimeout();
+                break;
+            case "product_selection_done":
+                productSelectionDone();
+                break;
+            default:
+                console.error("Unknown message:", wsMessage);
+        }
+    };
+
+    ws.onclose = (e) => {
+        ws = null;
+        setTimeout(() => {
+            wsConnect();
+        }, 1000);
+    };
+
+    ws.onerror = (err) => {
+        console.error("Socket encountered error:", err.message, "Closing socket");
+        ws.close();
+    };
+}
+
+function finishProductSelection() {
+    if (!ws) {
+        return;
+    }
+    const wsMessage = {
+        message: "product_selection_done",
+        data: null,
+    };
+    ws.send(JSON.stringify(wsMessage));
+}
+
+window.onload = () => {
+    const dlgElement = document.getElementById("player-on-destination-modal");
+    playerOnDestinationModal = new bootstrap.Modal(dlgElement);
+
+    document.getElementById("finish-product-selection").onclick = () => {
+        finishProductSelection();
+    };
+
+    wsConnect();
+};

frontend/styles.css

@@ -2,6 +2,10 @@ body {
     background-color: whitesmoke;
 }
 
+main.main-container {
+    position: relative;
+}
+
 .board-container {
     background-color: white;
     border: 1px solid black;
@@ -40,7 +44,6 @@ ul.players {
     color: white;
     background-color: darkred;
     border-radius: 5px;
-    z-index: 1000;
 }
 
 .player-tooltip::after {
@@ -53,3 +56,44 @@ ul.players {
     border-style: solid;
     border-color: darkred transparent transparent transparent;
 }
+
+.purchase-container {
+    width: 50vw;
+    position: fixed;
+    top: 200px;
+    left: 50%;
+    padding: 20px;
+    transform: translateX(-50%);
+    background-color: darkred;
+    z-index: 999;
+    border-radius: 10px;
+}
+
+.purchase-container .header {
+    color: white;
+    margin-bottom: 20px;
+}
+
+.purchase-container .header .countdown {
+    margin-left: auto;
+}
+
+.purchase-container .products-content {
+    display: grid;
+    grid-gap: 10px;
+    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 {
+    margin: 20px;
+    max-height: 300px;
+}

hopper/api/dependencies.py

@@ -2,6 +2,7 @@ from typing import Optional
 
 from hopper.engine import GameEngine, GameEngineFactory
 from hopper.ws_server import WSServer
+from settings import settings
 
 game_engine: Optional[GameEngine] = None
 
@@ -12,7 +13,10 @@ def create_game_engine() -> GameEngine:
     if game_engine:
         raise RuntimeError("Can't call create_game_engine() more than once!")
 
-    ws_server = WSServer(daemon=True)
+    ws_server = WSServer(
+        host=settings.ws_server.HOST,
+        port=settings.ws_server.PORT,
+    )
     ws_server.start()
 
     game_engine = GameEngineFactory.create_default(ws_server=ws_server)

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:
@@ -23,12 +25,13 @@ class PositionDto(BaseModel):
 
 
 class PlayerDto(BaseModel):
-    uuid: str
+    id: str
     name: str
     active: bool
     position: PositionDto
     move_count: int
     move_attempt_count: int
+    state: PlayerState
 
 
 class DestinationDto(BaseModel):

hopper/api/views.py

@@ -14,14 +14,18 @@ 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)
+def get_player(id: str, engine: GameEngine = Depends(get_game_engine)) -> Player:
+    player = engine.players.find(id)
     if player is None:
         raise HTTPException(
             status_code=status.HTTP_404_NOT_FOUND, detail="Player not found"
@@ -60,7 +64,7 @@ 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,
@@ -72,16 +76,16 @@ async def start_game(
 
 
 @router.get(
-    "/player/{uuid}",
+    "/player/{id}",
     response_model=PlayerInfoResponseDto,
     responses={
         status.HTTP_403_FORBIDDEN: {
             "model": ErrorResponseDto,
-            "description": " Player inactive",
+            "description": "Player inactive",
         },
         status.HTTP_404_NOT_FOUND: {
             "model": ErrorResponseDto,
-            "description": " Player with uuid not found, probably kicked out",
+            "description": "Player with id not found, probably kicked out",
         },
     },
 )
@@ -92,7 +96,7 @@ async def get_player_info(
 
 
 @router.post(
-    "/player/{uuid}/move/{direction}",
+    "/player/{id}/move/{direction}",
     response_model=MovePlayerResponseDto,
     status_code=status.HTTP_201_CREATED,
     responses={
@@ -102,15 +106,19 @@ async def get_player_info(
         },
         status.HTTP_403_FORBIDDEN: {
             "model": ErrorResponseDto,
-            "description": " Player inactive",
+            "description": "Player inactive",
         },
         status.HTTP_404_NOT_FOUND: {
             "model": ErrorResponseDto,
-            "description": " Player with uuid not found, probably kicked out",
+            "description": "Player with id not found, probably kicked out",
         },
         status.HTTP_409_CONFLICT: {
             "model": ErrorResponseDto,
-            "description": " Position out of bounds or collision with an object",
+            "description": "Position out of bounds or collision with an object",
+        },
+        status.HTTP_423_LOCKED: {
+            "model": ErrorResponseDto,
+            "description": "Player reached destination. Can't move anymore.",
         },
     },
 )
@@ -130,6 +138,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/countdown_timer.py

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

hopper/engine.py

@@ -3,9 +3,9 @@ import logging
 import random
 from typing import Optional
 
-from hopper.enums import Direction, PlayerMoveResult
-from hopper.errors import Collision, PositionOutOfBounds
-from hopper.interfaces import SendGameStateInterface
+from hopper.countdown_timer import CountdownTimer
+from hopper.enums import Direction, GameState, PlayerMoveResult, PlayerState
+from hopper.errors import Collision, GameLockForMovement, PositionOutOfBounds
 from hopper.models.board import (
     BOARD_DUMP_CHARS,
     BoardLayout,
@@ -18,17 +18,34 @@ 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
 
 
+def create_player_start_position(board_width: int, board_height: int) -> Position:
+    """Create random position somewhere on the board border"""
+    border_len = (board_width + board_height) * 2
+    rnd_position = random.randint(0, border_len - 1)
+
+    if rnd_position < board_width * 2:
+        x = rnd_position % board_width
+        y = 0 if rnd_position < board_width else board_height - 1
+    else:
+        rnd_position -= 2 * board_width
+        x = 0 if rnd_position < board_height else board_width - 1
+        y = rnd_position % board_height
+
+    return Position(x=x, y=y)
+
+
 class GameEngine:
-    def __init__(
-        self, board: GameBoard, ws_server: Optional[SendGameStateInterface] = None
-    ) -> None:
+    def __init__(self, board: GameBoard, ws_server: WSServer = None) -> None:
         self.board = board
         self.ws_server = ws_server
         self.players = PlayerList()
         self._inacivity_watchdog = None
+        self._purchase_countdown_timer: Optional[CountdownTimer] = None
+        self.game_state = GameState.RUNNING
         self.__debug_print_board()
 
     def dump_board(self) -> list[list[str]]:
@@ -58,42 +75,35 @@ class GameEngine:
             self._inacivity_watchdog = InactivityWatchdog(
                 players=self.players,
                 ws_server=self.ws_server,
-                daemon=True,
             )
             self._inacivity_watchdog.start()
 
-    async def start_game(self, player_name: str) -> Player:
+    async def send_game_dump(self):
+        self.__debug_print_board()
+        await self.ws_server.send_game_dump()
+
+    async def reset_game(self) -> None:
+        self.__debug_print_board()
+        self.game_state = GameState.RUNNING
+        self.players.clear()
+        await self.send_game_dump()
+
+    async def start_game_for_player(self, player_name: str) -> Player:
         self._start_inactivity_watchdog()
         player = Player(
             name=player_name,
-            position=self._create_player_start_position(),
+            position=create_player_start_position(self.board.width, self.board.height),
+            state=PlayerState.CREATED,
         )
         self.players.append(player)
 
         logging.info(f"Starting new game for player: {player}")
         self.__debug_print_board()
 
-        if self.ws_server:
-            await self.ws_server.send_game_state()
-
+        await self.send_game_dump()
         await asyncio.sleep(settings.game.MOVE_DELAY)
         return player
 
-    def _create_player_start_position(self) -> Position:
-        """Create random position somewhere on the board border"""
-        border_len = (self.board.width + self.board.height) * 2
-        rnd_position = random.randint(0, border_len - 1)
-
-        if rnd_position < self.board.width * 2:
-            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:
@@ -113,14 +123,18 @@ class GameEngine:
     ) -> 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.reached_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):
             raise PositionOutOfBounds()
@@ -132,19 +146,13 @@ class GameEngine:
         player.move_count += 1
 
         if self._is_player_on_destination(player):
-            player.reached_destination = True
-            logging.info(f"Player {player} reached destination!")
-
-        if self.ws_server:
-            await self.ws_server.send_game_state()
-
-        self.__debug_print_board()
-
-        if player.reached_destination:
+            player.state = PlayerState.ON_DESTINATION
+            await self._player_on_destination(player)
             return PlayerMoveResult.DESTINATION_REACHED
 
-        await asyncio.sleep(settings.game.MOVE_DELAY)
+        await self.send_game_dump()
 
+        await asyncio.sleep(settings.game.MOVE_DELAY)
         return PlayerMoveResult.OK
 
     def _is_player_on_destination(self, player: Player) -> bool:
@@ -158,6 +166,54 @@ class GameEngine:
     def _colided_with_obstacle(self, position: Position) -> bool:
         return self.board.get_object_at_position(position) is not None
 
+    async def _player_on_destination(self, player: Player) -> None:
+        logging.info(f"Player {player} reached destination!")
+
+        self.game_state = GameState.LOCK_FOR_MOVEMENT
+        await self.send_game_dump()
+
+        await self.ws_server.send_player_reached_destination_message(player=player)
+
+        logging.info(
+            f"Starting product selection countdown timer for {settings.purchase_timeout} seconds"
+        )
+
+        def on_purchase_timer_tick(time_left) -> None:
+            logging.info(f"Product selection countdown timer tick, time left: {time_left}")
+
+        def on_purchase_timer_done() -> None:
+            logging.info("Ding ding! Product selection countdown timer timeout")
+            self._purchase_countdown_timer = None
+            asyncio.run(
+                self.ws_server.send_product_selection_timeout_message()
+            )
+            self.game_state = GameState.RUNNING
+            asyncio.run(self.send_game_dump())
+
+        self._purchase_countdown_timer = CountdownTimer(
+            seconds=settings.purchase_timeout,
+            timer_tick_callback=on_purchase_timer_tick,
+            timer_done_callback=on_purchase_timer_done,
+        )
+        self._purchase_countdown_timer.start()
+
+        await asyncio.sleep(settings.game.PURCHASE_START_DELAY)
+
+    async def product_selection_done(self) -> None:
+        logging.info("Product selection done, unlocking game")
+        if self._purchase_countdown_timer:
+            self._purchase_countdown_timer.stop()
+        await self.ws_server.send_product_selection_done_message()
+        await self.reset_game()
+
+    def _reset_player(self, player) -> None:
+        # move player to start position
+        player.position = create_player_start_position(
+            self.board.width, self.board.height
+        )
+        player.state = PlayerState.CREATED
+        player.last_seen = None
+
     def get_board_layout(self) -> BoardLayout:
         return BoardLayout(board=self.board, players=self.players)
 
@@ -168,7 +224,7 @@ class GameEngineFactory:
         board_width: int,
         board_height: int,
         obstacle_count: int = 0,
-        ws_server: Optional[SendGameStateInterface] = None,
+        ws_server: WSServer = None,
     ) -> GameEngine:
         board = GameBoard(
             width=board_width,
@@ -189,12 +245,12 @@ 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[SendGameStateInterface] = None,
+        ws_server: WSServer = None,
     ) -> GameEngine:
         return GameEngineFactory.create(
             board_width=settings.board.WIDTH,
@@ -204,18 +260,10 @@ class GameEngineFactory:
         )
 
     @staticmethod
-    def __add_test_player(players: PlayerList) -> None:
-        if not (settings.debug and settings.debug.CREATE_TEST_PLAYER):
+    def __add_test_players(players: PlayerList) -> None:
+        if not settings.debug:
             return
 
-        player = Player(
-            name="Pero",
-            uuid="test-player-id",
-            position=Position(
-                settings.debug.TEST_PLAYER_START_X,
-                settings.debug.TEST_PLAYER_START_Y,
-            ),
-            can_be_deactivated=False,
-        )
-        players.append(player)
-        logging.info(f"Test player created: {player}")
+        for player in settings.debug.PLAYERS:
+            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

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

hopper/models/config.py

@@ -1,10 +1,16 @@
 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: float = 0.5  # seconds
+    PURCHASE_START_DELAY: float = 2  # seconds
+
 
 @dataclass
 class BoardSettings:
@@ -22,16 +28,14 @@ class InactivityWatchdogSettings:
 
 @dataclass
 class WSServerSettings:
-    HOST: str = "localhost"
+    HOST: str = "127.0.0.1"
     PORT: int = 8011
 
 
 @dataclass
 class DebugSettings:
     PRINT_BOARD: bool = False
-    CREATE_TEST_PLAYER: bool = False
-    TEST_PLAYER_START_X: int = 0
-    TEST_PLAYER_START_Y: int = 0
+    PLAYERS: Optional[List[Player]] = None
 
 
 @dataclass
@@ -40,5 +44,7 @@ class Settings:
     board: BoardSettings
     inacivity_watchdog: InactivityWatchdogSettings
     ws_server: WSServerSettings
+    purchase_timeout: int = 10  # seconds
     log_level: int = logging.INFO
+    products: 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:
@@ -13,24 +15,24 @@ class Position:
 @dataclass
 class Player:
     name: str
-    uuid: str = field(default_factory=lambda: str(uuid.uuid4()))
+    id: str = field(default_factory=lambda: str(uuid.uuid4()))
     position: Position = field(default_factory=lambda: Position(0, 0))
     move_count: int = 0
     move_attempt_count: int = 0
     last_seen: datetime.datetime = field(
         default_factory=lambda: datetime.datetime.now()
     )
+    state: PlayerState = PlayerState.CREATED
     active: bool = True
     can_be_deactivated: bool = True
-    reached_destination: bool = False
 
     def reset_timeout(self) -> None:
         self.last_seen = datetime.datetime.now()
 
 
 class PlayerList(list[Player]):
-    def find(self, uuid: str) -> Optional[Player]:
+    def find(self, id: str) -> Optional[Player]:
         for player in self:
-            if player.uuid == uuid:
+            if player.id == id:
                 return player
         return None

hopper/models/product.py

@@ -0,0 +1,10 @@
+import uuid
+from dataclasses import dataclass, field
+from typing import Optional
+
+
+@dataclass
+class Product:
+    name: str
+    id: str = field(default_factory=lambda: str(uuid.uuid4()))
+    description: Optional[str] = None

hopper/models/ws_dto.py

@@ -1,6 +1,10 @@
 from __future__ import annotations
 
+import json
+from typing import Optional, TypeVar
+
 from pydantic import Field
+from pydantic.generics import GenericModel
 
 from hopper.api.dto import BaseModel, BoardDto, DestinationDto, PlayerDto, PositionDto
 from hopper.enums import ObjectType
@@ -15,12 +19,50 @@ class LayerDto(BaseModel):
     name: str
     objects: list[LayerObjectDto]
 
-class GameStatePlayerDto(PlayerDto):
-    reached_destination: bool
 
-
-class GameStateDto(BaseModel):
+class GameDumpDto(BaseModel):
     board: BoardDto
     destination: DestinationDto
-    players: list[GameStatePlayerDto]
+    players: list[PlayerDto]
     layers: list[LayerDto]
+
+
+class PlayerReachedDestinationDto(BaseModel):
+    player: PlayerDto
+
+
+TMessageData = TypeVar("TMessageData", bound=BaseModel)
+
+
+class WSMessage(GenericModel):
+    message: str
+    data: Optional[TMessageData] = None
+
+    def __str__(self) -> str:
+        return self.to_str()
+
+    def to_str(self) -> str:
+        return json.dumps(self.dict())
+
+    @classmethod
+    @property
+    def message_type(cls) -> str:
+        return cls.__fields__["message"].default
+
+
+class WSGameDumpMessage(WSMessage):
+    message: str = "game_dump"
+    data: GameDumpDto
+
+
+class WSProductSelectionDoneMessage(WSMessage):
+    message: str = "product_selection_done"
+
+
+class WSProductSelectionTimeoutMessage(WSMessage):
+    message: str = "product_selection_timeout"
+
+
+class WSPlayerReachedDestinationMessage(WSMessage):
+    message: str = "player_reached_destination"
+    data: PlayerReachedDestinationDto

hopper/watchdog.py

@@ -3,25 +3,20 @@ import datetime
 import logging
 import time
 from threading import Thread
-from typing import Optional
 
-from hopper.interfaces import SendGameStateInterface
 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[SendGameStateInterface] = None,
-        *args,
-        **kwargs,
+        self, players: PlayerList, ws_server: WSServer = None
     ) -> None:
         self.players = players
         self.ws_server = ws_server
         self.stopped = False
-        super().__init__(*args, **kwargs)
+        super().__init__(daemon=True)
 
     def run(self) -> None:
         logging.info("Starting inactivity watchdog")
@@ -38,7 +33,7 @@ class InactivityWatchdog(Thread):
             seconds=settings.inacivity_watchdog.KICK_TIMEOUT
         )
 
-        send_game_state = False
+        send_game_dump = False
 
         for player in self.players:
             if (
@@ -48,7 +43,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
@@ -57,18 +52,16 @@ 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:
-            self.send_game_state()
+        if send_game_dump:
+            self.send_game_dump()
 
-    def send_game_state(self):
-        if not self.ws_server:
-            return
-        logging.info("Sending WS game state")
-        asyncio.run(self.ws_server.send_game_state())
+    def send_game_dump(self):
+        logging.info("Sending WS game dump")
+        asyncio.run(self.ws_server.send_game_dump())
 
     def stop(self) -> None:
         self.stopped = True

hopper/ws_server.py

@@ -5,76 +5,143 @@ from threading import Thread
 
 import websockets
 from websockets import WebSocketServerProtocol
-from websockets.exceptions import ConnectionClosedOK
+from websockets.exceptions import ConnectionClosedError, ConnectionClosedOK
 
-from hopper.models.ws_dto import GameStateDto
-from settings import settings
+from hopper.models.player import Player
+from hopper.models.ws_dto import (
+    GameDumpDto,
+    PlayerReachedDestinationDto,
+    WSGameDumpMessage,
+    WSMessage,
+    WSPlayerReachedDestinationMessage,
+    WSProductSelectionDoneMessage,
+    WSProductSelectionTimeoutMessage,
+)
 
 
 class WSServer(Thread):
+    def __init__(self, host: str, port: int) -> None:
+        self.host = host
+        self.port = port
+        super().__init__(daemon=True)
+
+    async def handle_rcv_message(
+        self, client: WebSocketServerProtocol, raw_message: str
+    ) -> None:
+        try:
+            ws_message = json.loads(raw_message)
+        except Exception as ex:
+            logging.error(
+                f"Error decoding WS message from {client.id} {raw_message}: {ex}"
+            )
+            return None
+
+        data_message = ws_message.get("message")
+        if data_message == WSProductSelectionDoneMessage.message_type:
+            await self.handle_rcv_product_selection_done(client)
+
+    async def handle_rcv_product_selection_done(
+        self, client: WebSocketServerProtocol
+    ) -> None:
+        logging.info(f"Handle WSProductSelectionDoneMessage: {client.id}")
+        # avoid circular imports
+        from hopper.api.dependencies import get_game_engine
+
+        engine = get_game_engine()
+        await engine.product_selection_done()
+
     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:
-            # send initial game state to connected client
-            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:
                     # we're expecting nothing from client, but read if client sends a message
-                    await websocket.recv()
+                    rcv_data = await websocket.recv()
+                    await self.handle_rcv_message(
+                        client=websocket, raw_message=rcv_data
+                    )
                 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)
             logging.info(f"Remove client: {websocket.id}")
 
-    def _create_game_state_message(self) -> str:
+    async def send_message_to_client(
+        self, client: WebSocketServerProtocol, message: WSMessage
+    ) -> None:
+        message_str = message.to_str()
+        logging.debug(
+            f"Sending message {message.message} to clients: {self.connected_clients}: {message_str}"
+        )
+        await client.send(message_str)
+
+    async def send_message_to_clients(self, message: WSMessage) -> None:
+        for client in self.connected_clients:
+            await self.send_message_to_client(client, message)
+
+    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:
-        """Send game state to the client"""
-        message = self._create_game_state_message()
-        logging.debug(f"Sending game state to client: {websocket.id}")
-        await websocket.send(message)
+        """Send game dump to the client"""
+        message = self._create_game_dump_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_dump_message()
+        await self.send_message_to_clients(message)
 
-        message = self._create_game_state_message()
-        logging.debug(
-            f"Sending game state to clients: {self.connected_clients}: {message}"
+    async def send_player_reached_destination_message(self, player: Player) -> None:
+        message = WSPlayerReachedDestinationMessage(
+            data=PlayerReachedDestinationDto(
+                player=player,
+            )
         )
-        for client in self.connected_clients:
-            await client.send(message)
+        await self.send_message_to_clients(message)
+
+    async def send_product_selection_done_message(self) -> None:
+        message = WSProductSelectionDoneMessage()
+        await self.send_message_to_clients(message)
+
+    async def send_product_selection_timeout_message(self) -> None:
+        message = WSProductSelectionTimeoutMessage()
+        await self.send_message_to_clients(message)
 
     async def run_async(self) -> None:
         logging.info(
-            f"Starting FairHopper Websockets Server on {settings.ws_server.HOST}:{settings.ws_server.PORT}"
+            f"Starting FairHopper Websockets Server on {self.host}:{self.port}"
         )
 
         async with websockets.serve(
             ws_handler=self.handler,
-            host=settings.ws_server.HOST,
-            port=settings.ws_server.PORT,
+            host=self.host,
+            port=self.port,
         ):
             await asyncio.Future()  # run forever
 

sdk/demo.py

@@ -0,0 +1,51 @@
+import random
+from fh_sdk import Direction, FairHopper, Position
+import math
+
+HOST = "http://localhost"
+PORT = 8010
+
+
+def calc_angle(position1: Position, position2: Position) -> float:
+    x1, y1 = position1.x, position1.y
+    x2, y2 = position2.x, position2.y
+    return math.atan2(y2 - y1, x2 - x1) * (180 / math.pi)
+
+
+fh = FairHopper(host=HOST, port=PORT)
+res = fh.ping()
+
+game = fh.start_game(player_name=f"Mirko {random.randint(0, 9999)}")
+print(game.player.position)
+quit()
+
+res = fh.get_game_info()
+print(">>>>>", res)
+
+res = fh.get_player_info("XX")
+print(">>>>>", res)
+
+position = game.player.position
+dest_position = game.destination.position
+
+# p1 = PositionDto(x=0, y=20)
+# p2 = PositionDto(x=10, y=10)
+# angle = calc_angle(p1, p2)
+# print(angle)
+# quit()
+
+for _ in range(10):
+    angle = calc_angle(position, dest_position) + 180
+    if 0 <= angle < 90:
+        direction = Direction.RIGHT
+    elif 90 <= angle <= 180:
+        direction = Direction.DOWN
+    elif 180 <= angle <= 270:
+        direction = Direction.RIGHT
+    else:
+        direction = Direction.UP
+
+    print(position, dest_position, int(angle), direction)
+
+    move_response = fh.move(game.player.id, direction)
+    position = move_response.player.position

settings_template.py

@@ -2,17 +2,49 @@ import logging
 
 from hopper.models.config import (
     BoardSettings,
+    DebugSettings,
     GameSettings,
     InactivityWatchdogSettings,
     Settings,
     WSServerSettings,
 )
+from hopper.models.player import Player, Position
+from hopper.models.product import Product
 
 settings = Settings(
     game=GameSettings(),
-    board=BoardSettings(),
+    board=BoardSettings(
+        WIDTH=20,
+        HEIGHT=20,
+        OBSTACLE_COUNT=10,
+    ),
     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(),
-    debug=None,
+    debug=DebugSettings(
+        PRINT_BOARD=True,
+        PLAYERS=[
+            Player(
+                name="Pero",
+                id="test-player-pero",
+                position=Position(x=9, y=10),
+                can_be_deactivated=False,
+            ),
+            Player(
+                name="Mirko",
+                id="test-player-mirko",
+                position=Position(x=10, y=5),
+                can_be_deactivated=False,
+            ),
+        ],
+    ),
 )