Log every attempt to join a game (#1048)

* Log every attempt to join a game

* Fix player id reference and add test

* format

* fix sort

* remove unused variable

* Revert unnecessary whitespace changes

* Use correct db version

* Improve test

---------

Co-authored-by: Christian Schmidt <[email protected]>
Co-authored-by: Sheikah45 <[email protected]>
Co-authored-by: BlackYps <[email protected]>

Author: 4 people

.github/workflows/test.yml

@@ -11,7 +11,7 @@ on:
     - cron: '0 0 * * *'
 
 env:
-  FAF_DB_VERSION: v136
+  FAF_DB_VERSION: v138
   FLYWAY_VERSION: 7.5.4
 
 jobs:

server/db/models.py

@@ -1,6 +1,7 @@
 from sqlalchemy import (
     TIME,
     TIMESTAMP,
+    BigInteger,
     Boolean,
     Column,
     DateTime,
@@ -113,6 +114,13 @@
     Column("allow_override", Boolean)
 )
 
+game_join_log = Table(
+    "game_join_log", metadata,
+    Column("id",         BigInteger, primary_key=True),
+    Column("player_id",  Integer,    ForeignKey("login.id"), nullable=False),
+    Column("game_id",    Integer,    nullable=False),
+)
+
 game_player_stats = Table(
     "game_player_stats", metadata,
     Column("id",            Integer, primary_key=True),

server/lobbyconnection.py

@@ -28,6 +28,7 @@
     ban,
     coop_map,
     friends_and_foes,
+    game_join_log,
     lobby_ban
 )
 from .db.models import login as t_login
@@ -986,6 +987,17 @@ async def command_game_join(self, message):
         uuid = int(message["uid"])
         password = message.get("password")
 
+        async with self._db.acquire() as conn:
+            try:
+                await conn.execute(
+                    game_join_log.insert().values(
+                        player_id=self.player.id,
+                        game_id=uuid,
+                    )
+                )
+            except DBAPIError:
+                self._logger.exception("writing to game join log failed")
+
         self._logger.debug("joining: %d with pw: %s", uuid, password)
         try:
             game = self.game_service[uuid]

tests/integration_tests/test_game.py

@@ -7,9 +7,9 @@
 from unittest import mock
 
 import pytest
-from sqlalchemy import select
+from sqlalchemy import and_, select
 
-from server.db.models import game_player_stats
+from server.db.models import game_join_log, game_player_stats
 from server.games.game_results import GameOutcome
 from server.protocol import Protocol
 from server.timing import datetime_now
@@ -391,6 +391,61 @@ async def test_game_with_foed_player(lobby_server):
         await join_game(guest_proto, game_id)
 
 
+@fast_forward(60)
+async def test_game_join_log(lobby_server, database):
+    _, _, host_proto = await connect_and_sign_in(
+        ("test", "test_password"), lobby_server
+    )
+    guest_id, _, guest_proto = await connect_and_sign_in(
+        ("Rhiza", "puff_the_magic_dragon"), lobby_server
+    )
+    await read_until_command(guest_proto, "game_info")
+    await read_until_command(host_proto, "game_info")
+
+    # Host game
+    await host_proto.send_message({
+        "command": "game_host",
+        "mod": "faf",
+        "visibility": "public",
+    })
+    game_id = await host_game(host_proto)
+
+    # Join a player
+    await join_game(guest_proto, game_id)
+
+    async with database.acquire() as conn:
+        result = await conn.execute(
+            select(game_join_log).where(
+                and_(
+                    game_join_log.c.game_id == game_id,
+                    game_join_log.c.player_id == guest_id
+                )
+            )
+        )
+        row = result.one()
+        assert row is not None
+
+    # Leave and re-join
+    await guest_proto.send_message({
+        "target": "game",
+        "command": "GameState",
+        "args": ["Ended"]
+    })
+    await join_game(guest_proto, game_id)
+
+    async with database.acquire() as conn:
+        result = await conn.execute(
+            select(game_join_log).where(
+                and_(
+                    game_join_log.c.game_id == game_id,
+                    game_join_log.c.player_id == guest_id
+                )
+            )
+        )
+        rows = result.fetchall()
+        assert len(rows) == 2
+
+
 @fast_forward(60)
 async def test_game_info_messages(lobby_server):
     host_id, _, host_proto = await connect_and_sign_in(
@@ -1126,9 +1181,9 @@ async def test_partial_game_ended_rates_game(lobby_server, tmp_user):
         # Set player options
         await send_player_options(
             host_proto,
-            [guest_id, "Army", i+2],
-            [guest_id, "StartSpot", i+2],
-            [guest_id, "Color", i+2],
+            [guest_id, "Army", i + 2],
+            [guest_id, "StartSpot", i + 2],
+            [guest_id, "Color", i + 2],
             [guest_id, "Faction", 1],
             [guest_id, "Team", 3 if i % 2 == 0 else 2]
         )