From 767189821d0a1673008833cf919b0d6bc9895cb9 Mon Sep 17 00:00:00 2001
From: Martin Berg Alstad <600878@stud.hvl.no>
Date: Wed, 19 Jul 2023 16:03:43 +0200
Subject: [PATCH] Players can rejoin when refreshing window, changed Name to
 UserName

---
 BackendTests/Services/ActionServiceTests.cs   | 10 ++++-----
 BackendTests/TestUtils/Players.cs             |  4 ++--
 .../ClientApp/src/components/gameBoard.tsx    |  4 ++--
 .../src/components/gameComponent.tsx          |  6 +++--
 .../ClientApp/src/components/playerStats.tsx  |  7 +++---
 .../ClientApp/src/game/player.ts              |  9 ++++----
 .../ClientApp/src/pages/home.tsx              |  2 +-
 .../ClientApp/src/types/props.d.ts            |  2 +-
 .../ClientApp/src/utils/actions.ts            |  4 ++--
 .../ClientApp/src/utils/state.ts              |  2 +-
 pac-man-board-game/GameStuff/Items/Player.cs  |  9 ++++----
 pac-man-board-game/Services/ActionService.cs  | 17 ++++++++++++--
 pac-man-board-game/Services/Game.cs           |  4 ++--
 pac-man-board-game/Services/GameService.cs    | 22 ++++++++++++++-----
 14 files changed, 64 insertions(+), 38 deletions(-)

diff --git a/BackendTests/Services/ActionServiceTests.cs b/BackendTests/Services/ActionServiceTests.cs
index 00bb70a..279ec3b 100644
--- a/BackendTests/Services/ActionServiceTests.cs
+++ b/BackendTests/Services/ActionServiceTests.cs
@@ -165,7 +165,7 @@ public class ActionServiceTests
         // If selected the state is changed to InGame
         _whitePlayer.State = State.InGame;
         var players = result.GetType().GetProperty("Players")?.GetValue(result) as IEnumerable<IPlayer>;
-        Assert.That(players?.First().Name, Is.EqualTo(_whitePlayer.Name));
+        Assert.That(players?.First().UserName, Is.EqualTo(_whitePlayer.UserName));
     }
 
     [Test]
@@ -185,7 +185,7 @@ public class ActionServiceTests
         result = _service.Ready();
 
         var players = result.GetType().GetProperty("Players")?.GetValue(result) as IEnumerable<IPlayer>;
-        Assert.That(players?.First().Name, Is.EqualTo(_blackPlayer.Name).Or.EqualTo(_whitePlayer.Name));
+        Assert.That(players?.First().UserName, Is.EqualTo(_blackPlayer.UserName).Or.EqualTo(_whitePlayer.UserName));
     }
 
     #endregion
@@ -208,7 +208,7 @@ public class ActionServiceTests
                 { Players = { _whitePlayer } };
 
         var name = _service.FindNextPlayer();
-        Assert.That(name, Is.EqualTo(_whitePlayer.Name));
+        Assert.That(name, Is.EqualTo(_whitePlayer.UserName));
     }
 
     [Test]
@@ -222,9 +222,9 @@ public class ActionServiceTests
             })) { Players = { _whitePlayer, _blackPlayer } };
 
         var first = _service.FindNextPlayer();
-        Assert.That(first, Is.EqualTo(_blackPlayer.Name));
+        Assert.That(first, Is.EqualTo(_blackPlayer.UserName));
         var second = _service.FindNextPlayer();
-        Assert.That(second, Is.EqualTo(_whitePlayer.Name));
+        Assert.That(second, Is.EqualTo(_whitePlayer.UserName));
     }
 
     #endregion
diff --git a/BackendTests/TestUtils/Players.cs b/BackendTests/TestUtils/Players.cs
index 5c68b9f..07e46da 100644
--- a/BackendTests/TestUtils/Players.cs
+++ b/BackendTests/TestUtils/Players.cs
@@ -8,7 +8,7 @@ internal static class Players
     internal static IPlayer Create(string colour) =>
         new Player
         {
-            Name = colour,
+            UserName = colour,
             Colour = colour,
             PacMan = CreatePacMan(colour),
             Box = CreateBox(colour)
@@ -33,7 +33,7 @@ internal static class Players
         {
             Box = player.Box,
             Colour = player.Colour,
-            Name = player.Name,
+            UserName = player.UserName,
             PacMan = player.PacMan
         };
 }
diff --git a/pac-man-board-game/ClientApp/src/components/gameBoard.tsx b/pac-man-board-game/ClientApp/src/components/gameBoard.tsx
index 5f888db..c6b6092 100644
--- a/pac-man-board-game/ClientApp/src/components/gameBoard.tsx
+++ b/pac-man-board-game/ClientApp/src/components/gameBoard.tsx
@@ -181,8 +181,8 @@ const SelectPlayerModal: Component = () => {
 
                   {
                     allPlayers.map(player =>
-                      <div key={player.Name} className={"border-b pb-1"}>
-                        <span className={"mx-2"}>{player.Name} has {player.Box.count} pellets</span>
+                      <div key={player.UserName} className={"border-b pb-1"}>
+                        <span className={"mx-2"}>{player.UserName} has {player.Box.count} pellets</span>
                         <button className={"text-blue-500 enabled:cursor-pointer disabled:text-gray-500"}
                                 style={{background: "none"}}
                                 disabled={player.Box.count === 0}
diff --git a/pac-man-board-game/ClientApp/src/components/gameComponent.tsx b/pac-man-board-game/ClientApp/src/components/gameComponent.tsx
index 8caca1c..f325f2c 100644
--- a/pac-man-board-game/ClientApp/src/components/gameComponent.tsx
+++ b/pac-man-board-game/ClientApp/src/components/gameComponent.tsx
@@ -15,9 +15,11 @@ const wsService = new WebSocketService(import.meta.env.VITE_API_WS);
 
 // TODO bug, when taking player on last dice, the currentPlayer changes and the wrong character get to steal
 // TODO bug, first player can sometimes roll dice twice (maybe only on firefox)
+// TODO bug, when refreshing page, the characters are reset for all players
+// TODO bug, when refreshing page, some data is missing until other clients make a move
 
 // TODO add debug menu on dev, for testing and cheating
-// TODO join game lobby
+// TODO join/new game lobby
 // TODO sign up player page
 // TODO sign in page
 // TODO show box with collected pellets
@@ -91,7 +93,7 @@ export const GameComponent: Component<{ player: Player, map: GameMap }> = ({play
   return (
     <>
       <div className={"flex justify-center"}>
-        {players?.map(p => <PlayerStats key={p.Name} player={p}/>)}
+        {players?.map(p => <PlayerStats key={p.UserName} player={p}/>)}
       </div>
       <div className={"flex-center"}>
         <GameButton onReadyClick={sendReady} onRollDiceClick={rollDice}/>
diff --git a/pac-man-board-game/ClientApp/src/components/playerStats.tsx b/pac-man-board-game/ClientApp/src/components/playerStats.tsx
index eb67f87..8445bb7 100644
--- a/pac-man-board-game/ClientApp/src/components/playerStats.tsx
+++ b/pac-man-board-game/ClientApp/src/components/playerStats.tsx
@@ -11,10 +11,11 @@ const PlayerStats: Component<{ player: Player } & ComponentProps> = (
   }) => {
   const currentPlayerName = useAtomValue(currentPlayerNameAtom);
   return (
-    <div key={player.Colour} className={`w-fit m-2 ${className}`} id={id}>
-      <p className={player.Name === currentPlayerName ? "underline" : ""}>Player: {player.Name}</p>
+    <div key={player.Colour}
+         className={`w-fit m-2 ${player.State === State.disconnected ? "text-gray-500" : ""} ${className}`} id={id}>
+      <p className={player.UserName === currentPlayerName ? "underline" : ""}>Player: {player.UserName}</p>
       <p>Colour: {player.Colour}</p>
-      {player.State === State.inGame ?
+      {player.State === State.inGame || player.State === State.disconnected ?
         <>
           <p>Pellets: {player.Box.count}</p>
           <p>PowerPellets: {player.Box.countPowerPellets}</p>
diff --git a/pac-man-board-game/ClientApp/src/game/player.ts b/pac-man-board-game/ClientApp/src/game/player.ts
index b24dc69..1b2d942 100644
--- a/pac-man-board-game/ClientApp/src/game/player.ts
+++ b/pac-man-board-game/ClientApp/src/game/player.ts
@@ -9,18 +9,19 @@ import rules from "./rules";
 export enum State {
   waitingForPlayers,
   ready,
-  inGame
+  inGame,
+  disconnected
 }
 
 export default class Player {
-  public readonly Name: string;
+  public readonly UserName: string;
   public readonly PacMan: Character;
   public readonly Colour: Colour;
   public readonly Box: Box;
   public State: State;
 
   constructor(props: PlayerProps) {
-    this.Name = props.Name;
+    this.UserName = props.UserName;
     this.Colour = props.Colour;
     this.Box = new Box(props.Box ?? {Colour: props.Colour});
     this.PacMan = new Character(props.PacMan ?? {
@@ -32,7 +33,7 @@ export default class Player {
 
   public isTurn(): boolean {
     const store = getDefaultStore();
-    return store.get(currentPlayerNameAtom) === this.Name;
+    return store.get(currentPlayerNameAtom) === this.UserName;
   }
 
   public addPellet(pellet: Pellet): void {
diff --git a/pac-man-board-game/ClientApp/src/pages/home.tsx b/pac-man-board-game/ClientApp/src/pages/home.tsx
index 11454bc..b964629 100644
--- a/pac-man-board-game/ClientApp/src/pages/home.tsx
+++ b/pac-man-board-game/ClientApp/src/pages/home.tsx
@@ -17,7 +17,7 @@ const Home: Component = () => {
   function formHandler(): void {
     if (!input.current || !dropdown.current) return;
     const player = new Player({
-      Name: input.current.value,
+      UserName: input.current.value,
       Colour: dropdown.current.value as Colour,
     });
     setPlayer(player);
diff --git a/pac-man-board-game/ClientApp/src/types/props.d.ts b/pac-man-board-game/ClientApp/src/types/props.d.ts
index 3d480a9..1e0828f 100644
--- a/pac-man-board-game/ClientApp/src/types/props.d.ts
+++ b/pac-man-board-game/ClientApp/src/types/props.d.ts
@@ -39,7 +39,7 @@ interface BoxProps {
 }
 
 interface PlayerProps {
-  readonly Name: string,
+  readonly UserName: string,
   readonly PacMan?: CharacterProps,
   readonly Colour: import("../game/colour").Colour,
   readonly Box?: BoxProps,
diff --git a/pac-man-board-game/ClientApp/src/utils/actions.ts b/pac-man-board-game/ClientApp/src/utils/actions.ts
index d7281f9..babcd77 100644
--- a/pac-man-board-game/ClientApp/src/utils/actions.ts
+++ b/pac-man-board-game/ClientApp/src/utils/actions.ts
@@ -91,7 +91,7 @@ function removeEatenPellets(data?: MoveCharacterData): void {
   }
 }
 
-function playerInfo(data?: PlayerProps[]): void {
+function playerInfo(data?: PlayerProps[]): void { // TODO missing data when refreshing page
   const playerProps = data ?? [];
   spawns = getCharacterSpawns(testMap).filter(spawn => spawn.type === CharacterType.pacMan);
   store.set(playersAtom, playerProps.map(p => new Player(p)));
@@ -104,7 +104,7 @@ function ready(data?: ReadyData): void {
     const players = data.Players.map(p => new Player(p));
     store.set(playersAtom, players);
     if (data.AllReady) {
-      store.set(currentPlayerNameAtom, data.Players[0].Name);
+      store.set(currentPlayerNameAtom, data.Players[0].UserName);
     }
   } else {
     console.error("Error:", data);
diff --git a/pac-man-board-game/ClientApp/src/utils/state.ts b/pac-man-board-game/ClientApp/src/utils/state.ts
index 51b08f8..d5e9ca0 100644
--- a/pac-man-board-game/ClientApp/src/utils/state.ts
+++ b/pac-man-board-game/ClientApp/src/utils/state.ts
@@ -47,7 +47,7 @@ export const currentPlayerNameAtom = atom<string | undefined>(undefined);
  */
 export const currentPlayerAtom = atom<Player | undefined>(get => {
   const currentPlayerName = get(currentPlayerNameAtom);
-  return get(playersAtom).find(player => player.Name === currentPlayerName);
+  return get(playersAtom).find(player => player.UserName === currentPlayerName);
 });
 /**
  * Whether the roll dice button should be enabled.
diff --git a/pac-man-board-game/GameStuff/Items/Player.cs b/pac-man-board-game/GameStuff/Items/Player.cs
index 2cc298a..e6554d8 100644
--- a/pac-man-board-game/GameStuff/Items/Player.cs
+++ b/pac-man-board-game/GameStuff/Items/Player.cs
@@ -2,7 +2,7 @@ namespace pacMan.GameStuff.Items;
 
 public interface IPlayer
 {
-    string Name { get; init; }
+    string UserName { get; init; }
     Character PacMan { get; init; }
     string Colour { get; init; }
     Box? Box { get; init; }
@@ -23,11 +23,10 @@ public class Player : IPlayer, IEquatable<Player>
     {
         if (ReferenceEquals(null, other)) return false;
         if (ReferenceEquals(this, other)) return true;
-        return Name == other.Name && PacMan.Equals(other.PacMan) && Colour == other.Colour && Box.Equals(other.Box) &&
-               State == other.State;
+        return UserName == other.UserName;
     }
 
-    public required string Name { get; init; }
+    public required string UserName { get; init; }
     public required Character PacMan { get; init; }
     public required string Colour { get; init; }
     public Box? Box { get; init; }
@@ -40,5 +39,5 @@ public class Player : IPlayer, IEquatable<Player>
         return obj.GetType() == GetType() && Equals((Player)obj);
     }
 
-    public override int GetHashCode() => HashCode.Combine(Name, PacMan, Colour, Box, (int)State);
+    public override int GetHashCode() => UserName.GetHashCode();
 }
diff --git a/pac-man-board-game/Services/ActionService.cs b/pac-man-board-game/Services/ActionService.cs
index a9d15a6..93e65d5 100644
--- a/pac-man-board-game/Services/ActionService.cs
+++ b/pac-man-board-game/Services/ActionService.cs
@@ -62,7 +62,20 @@ public class ActionService : IActionService
             PlayerInfoData data = JsonSerializer.Deserialize<PlayerInfoData>(message.Data);
             Player = data.Player;
 
-            Group = _gameService.AddPlayer(Player, data.Spawns);
+            Game? group;
+            IPlayer? player;
+            if ((group = _gameService.FindGameByUsername(Player.UserName)) != null &&
+                (player = group.Players.Find(p => p.UserName == Player.UserName))?.State == State.Disconnected)
+            {
+                player.State = group.IsGameStarted ? State.InGame : State.WaitingForPlayers;
+                Player = player;
+                Group = group;
+                // TODO send missing data: Dices, CurrentPlayer, Ghosts
+            }
+            else
+            {
+                Group = _gameService.AddPlayer(Player, data.Spawns);
+            }
         }
         catch (RuntimeBinderException e)
         {
@@ -95,7 +108,7 @@ public class ActionService : IActionService
         return data;
     }
 
-    public string FindNextPlayer() => Group?.NextPlayer().Name ?? "Error: No group found";
+    public string FindNextPlayer() => Group?.NextPlayer().UserName ?? "Error: No group found";
 
     public void Disconnect()
     {
diff --git a/pac-man-board-game/Services/Game.cs b/pac-man-board-game/Services/Game.cs
index d04ab56..6102cc9 100644
--- a/pac-man-board-game/Services/Game.cs
+++ b/pac-man-board-game/Services/Game.cs
@@ -52,7 +52,7 @@ public class Game // TODO handle disconnects and reconnects
          */
 
         player.State = State.WaitingForPlayers;
-        if (Players.Exists(p => p.Name == player.Name)) return true; // TODO change to false
+        if (Players.Exists(p => p.UserName == player.UserName)) return true; // TODO change to false
         Players.Add(player);
         if (player.PacMan.SpawnPosition is null) SetSpawn(player);
         return true;
@@ -70,7 +70,7 @@ public class Game // TODO handle disconnects and reconnects
 
     public IEnumerable<IPlayer> SetReady(IPlayer player)
     {
-        if (!Players.Contains(player)) // TODO throws exception after game has started and refresh
+        if (!Players.Contains(player))
             throw new PlayerNotFoundException("The player was not found in the game group.");
         player.State = State.Ready;
         return Players;
diff --git a/pac-man-board-game/Services/GameService.cs b/pac-man-board-game/Services/GameService.cs
index 012f45c..467c041 100644
--- a/pac-man-board-game/Services/GameService.cs
+++ b/pac-man-board-game/Services/GameService.cs
@@ -5,15 +5,17 @@ using pacMan.GameStuff.Items;
 namespace pacMan.Services;
 
 /// <summary>
-/// The GameService class provides functionality for managing games in a WebSocket environment. It inherits from the WebSocketService class.
+///     The GameService class provides functionality for managing games in a WebSocket environment. It inherits from the
+///     WebSocketService class.
 /// </summary>
 public class GameService : WebSocketService
 {
     public GameService(ILogger<GameService> logger) : base(logger) { }
 
     /// <summary>
-    /// A thread-safe collection (SynchronizedCollection) of "Game" objects. Utilized for managing multiple game instances simultaneously.
-    /// It represents all the current games being managed by GameService. 
+    ///     A thread-safe collection (SynchronizedCollection) of "Game" objects. Utilized for managing multiple game instances
+    ///     simultaneously.
+    ///     It represents all the current games being managed by GameService.
     /// </summary>
     public SynchronizedCollection<Game> Games { get; } = new();
 
@@ -42,7 +44,7 @@ public class GameService : WebSocketService
     }
 
     /// <summary>
-    /// This method tries to find a game with the specified id, add a player to it and return the updated game.
+    ///     This method tries to find a game with the specified id, add a player to it and return the updated game.
     /// </summary>
     /// <param name="id">The unique id of the game the player wants to join</param>
     /// <param name="player">The player instance that wants to join the game</param>
@@ -58,12 +60,15 @@ public class GameService : WebSocketService
 
 
     /// <summary>
-    /// Creates a new game and adds a player to it.
+    ///     Creates a new game and adds a player to it.
     /// </summary>
     /// <param name="player">The player instance that is going to join the new game.</param>
     /// <param name="spawns">A collection of spawn points arranged in a directional queue.</param>
     /// <returns>Returns the newly created Game object, with the player added to it.</returns>
-    /// <exception cref="ArgumentException">Thrown if the number of spawns is not equal to the maximum number of players set by the Rules.</exception>
+    /// <exception cref="ArgumentException">
+    ///     Thrown if the number of spawns is not equal to the maximum number of players set by
+    ///     the Rules.
+    /// </exception>
     public Game CreateAndJoin(IPlayer player, Queue<DirectionalPosition> spawns)
     {
         if (spawns.Count != Rules.MaxPlayers)
@@ -75,4 +80,9 @@ public class GameService : WebSocketService
 
         return game;
     }
+
+    public Game? FindGameByUsername(string username)
+    {
+        return Games.FirstOrDefault(game => game.Players.Exists(player => player.UserName == username));
+    }
 }