martials/pac-man-board-game
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated dependencies and project to C# 12 Added primary constructors and many other refactorings

Browse Source
This commit is contained in:
martin 2023-11-18 23:47:55 +01:00
parent b0c6641ea2
commit 2520a9ed94
28 changed files with 266 additions and 285 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
BackendTests/BackendTests.csproj
View File

@ -6,13 +6,15 @@
<Nullable>enable</Nullable>
<IsPackable>false</IsPackable>
<LangVersion>12</LangVersion>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.7.2" />
<PackageReference Include="NSubstitute" Version="5.1.0" />
<PackageReference Include="NUnit" Version="3.13.3" />
<PackageReference Include="NUnit3TestAdapter" Version="4.5.0" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0"/>
<PackageReference Include="NSubstitute" Version="5.1.0"/>
<PackageReference Include="NUnit" Version="3.14.0"/>
<PackageReference Include="NUnit3TestAdapter" Version="4.5.0"/>
<PackageReference Include="NUnit.Analyzers" Version="3.9.0">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
@ -24,7 +26,7 @@
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\pac-man-board-game\pac-man-board-game.csproj" />
<ProjectReference Include="..\pac-man-board-game\pac-man-board-game.csproj"/>
</ItemGroup>
</Project>

22
BackendTests/Controllers/GameControllerTests.cs
View File

@ -51,4 +51,26 @@ public class GameControllerTests
else
Assert.Fail("Result is not an ArraySegment<byte>");
}
#region DoAction(ActionMessage message)
[Test]
public void DoAction_NegativeAction()
{
const string data = "Nothing happens";
var message = new ActionMessage { Action = (GameAction)(-1), Data = data };
_controller.DoAction(message);
Assert.That(message.Data, Is.EqualTo(data));
}
[Test]
public void DoAction_OutOfBoundsAction()
{
const string data = "Nothing happens";
var message = new ActionMessage { Action = (GameAction)100, Data = data };
_controller.DoAction(message);
Assert.That(message.Data, Is.EqualTo(data));
}
#endregion
}

23
BackendTests/Services/ActionServiceTests.cs
View File

@ -2,6 +2,7 @@ using System.Text.Json;
using BackendTests.TestUtils;
using Microsoft.Extensions.Logging;
using NSubstitute;
using pacMan.DTOs;
using pacMan.Exceptions;
using pacMan.GameStuff;
using pacMan.GameStuff.Items;
@ -99,28 +100,6 @@ public class ActionServiceTests
#endregion
#region DoAction(ActionMessage message)
[Test]
public void DoAction_NegativeAction()
{
const string data = "Nothing happens";
var message = new ActionMessage { Action = (GameAction)(-1), Data = data };
_service.DoAction(message);
Assert.That(message.Data, Is.EqualTo(data));
}
[Test]
public void DoAction_OutOfBoundsAction()
{
const string data = "Nothing happens";
var message = new ActionMessage { Action = (GameAction)100, Data = data };
_service.DoAction(message);
Assert.That(message.Data, Is.EqualTo(data));
}
#endregion
#region Ready()
[Test]

1
BackendTests/Services/WebSocketServiceTests.cs
View File

@ -1,7 +1,6 @@
using System.Net.WebSockets;
using Microsoft.Extensions.Logging;
using NSubstitute;
using pacMan.Interfaces;
using pacMan.Services;
using pacMan.Utils;

1
DataAccessLayer/DataAccessLayer.csproj
View File

@ -5,6 +5,7 @@
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<RootNamespace>DAL</RootNamespace>
<LangVersion>12</LangVersion>
</PropertyGroup>
</Project>

2
pac-man-board-game/ClientApp/package.json
View File

@ -43,7 +43,7 @@
"serve": "vite preview",
"test": "cross-env CI=true vitest",
"coverage": "vitest run --coverage",
"format": "prettier --write \"src/**/*.{js,jsx,ts,tsx,json,css,scss,md}\""
"format": "prettier --write \"src/**/*.{js,jsx,ts,tsx,json,css,md}\""
},
"browserslist": {
"production": [

80
pac-man-board-game/Controllers/GameController.cs
View File

@ -1,5 +1,6 @@
using System.Net.WebSockets;
using Microsoft.AspNetCore.Mvc;
using pacMan.DTOs;
using pacMan.Exceptions;
using pacMan.GameStuff;
using pacMan.GameStuff.Items;
@ -10,35 +11,26 @@ namespace pacMan.Controllers;
[ApiController]
[Route("api/[controller]")]
public class GameController : GenericController
public class GameController(ILogger<GameController> logger, IGameService webSocketService, IActionService actionService)
: GenericController(logger, webSocketService)
{
private readonly IActionService _actionService;
private readonly GameService _gameService;
[HttpGet("[action]")]
public override async Task Connect() => await base.Connect();
public GameController(ILogger<GameController> logger, GameService webSocketService, IActionService actionService) :
base(logger, webSocketService)
[HttpGet("[action]")]
public IEnumerable<Game> All()
{
_gameService = webSocketService;
_actionService = actionService;
Logger.LogDebug("Returning all games");
return webSocketService.Games;
}
[HttpGet("connect")]
public override async Task Accept() => await base.Accept();
[HttpGet("all")]
public IEnumerable<Game> GetAllGames()
[HttpPost("[action]/{gameId:guid}")]
public IActionResult Join(Guid gameId, [FromBody] Player player) // TODO what if player is in a game already?
{
Logger.Log(LogLevel.Debug, "Returning all games");
return _gameService.Games;
}
[HttpPost("join/{gameId:guid}")]
public IActionResult JoinGame(Guid gameId, [FromBody] Player player) // TODO what if player is in a game already?
{
Logger.Log(LogLevel.Debug, "Joining game {}", gameId);
Logger.LogDebug("Joining game {}", gameId);
try
{
_gameService.JoinById(gameId, player);
webSocketService.JoinById(gameId, player);
return Ok("Game joined successfully");
}
catch (GameNotFoundException e)
@ -51,20 +43,20 @@ public class GameController : GenericController
}
}
[HttpGet("exists/{gameId:guid}")]
public IActionResult GameExists(Guid gameId)
[HttpGet("[action]/{gameId:guid}")]
public IActionResult Exists(Guid gameId)
{
Logger.Log(LogLevel.Debug, "Checking if game {} exists", gameId);
return _gameService.Games.Any(game => game.Id == gameId) ? Ok() : NotFound();
Logger.LogDebug("Checking if game {} exists", gameId);
return webSocketService.Games.Any(game => game.Id == gameId) ? Ok() : NotFound();
}
[HttpPost("create")]
public IActionResult CreateGame([FromBody] CreateGameData data)
[HttpPost("[action]")]
public IActionResult Create([FromBody] CreateGameData data)
{
Logger.Log(LogLevel.Debug, "Creating game");
Logger.LogDebug("Creating game");
try
{
var game = _gameService.CreateAndJoin(data.Player, data.Spawns);
var game = webSocketService.CreateAndJoin(data.Player, data.Spawns);
return Created($"/{game.Id}", game);
}
catch (Exception e)
@ -75,7 +67,7 @@ public class GameController : GenericController
protected override Task Echo()
{
_actionService.WebSocket = WebSocket ?? throw new NullReferenceException("WebSocket is null");
actionService.WebSocket = WebSocket ?? throw new NullReferenceException("WebSocket is null");
return base.Echo();
}
@ -83,16 +75,16 @@ public class GameController : GenericController
{
var stringResult = data.GetString(result.Count);
Logger.Log(LogLevel.Information, "Received: {}", stringResult);
Logger.LogInformation("Received: {}", stringResult);
var action = ActionMessage.FromJson(stringResult);
try
{
_actionService.DoAction(action);
DoAction(action);
}
catch (Exception e)
{
Logger.Log(LogLevel.Error, "{}", e.Message);
Logger.LogError("{}", e.Message);
action = new ActionMessage { Action = GameAction.Error, Data = e.Message };
}
@ -101,15 +93,27 @@ public class GameController : GenericController
protected override async void Send(ArraySegment<byte> segment)
{
if (_actionService.Game is not null)
_actionService.SendToAll(segment);
if (actionService.Game is not null)
actionService.SendToAll(segment);
else if (WebSocket is not null)
await _gameService.Send(WebSocket, segment);
await webSocketService.Send(WebSocket, segment);
}
protected override ArraySegment<byte>? Disconnect() =>
new ActionMessage { Action = GameAction.Disconnect, Data = _actionService.Disconnect() }
new ActionMessage { Action = GameAction.Disconnect, Data = actionService.Disconnect() }
.ToArraySegment();
protected override void SendDisconnectMessage(ArraySegment<byte> segment) => _actionService.SendToAll(segment);
protected override void SendDisconnectMessage(ArraySegment<byte> segment) => actionService.SendToAll(segment);
public void DoAction(ActionMessage message) =>
message.Data = message.Action switch
{
GameAction.RollDice => actionService.RollDice(),
GameAction.MoveCharacter => actionService.HandleMoveCharacter(message.Data),
GameAction.JoinGame => actionService.FindGame(message.Data),
GameAction.Ready => actionService.Ready(),
GameAction.NextPlayer => actionService.FindNextPlayer(),
GameAction.Disconnect => actionService.LeaveGame(),
_ => message.Data
};
}

33
pac-man-board-game/Controllers/GenericController.cs
View File

@ -1,29 +1,22 @@
using System.Net.WebSockets;
using Microsoft.AspNetCore.Mvc;
using pacMan.Interfaces;
using pacMan.Services;
namespace pacMan.Controllers;
public abstract class GenericController : ControllerBase
public abstract class GenericController(ILogger<GenericController> logger, IWebSocketService webSocketService)
: ControllerBase
{
private const int BufferSize = 1024 * 4;
private readonly IWebSocketService _webSocketService;
protected readonly ILogger<GenericController> Logger;
protected readonly ILogger<GenericController> Logger = logger;
protected WebSocket? WebSocket;
protected GenericController(ILogger<GenericController> logger, IWebSocketService webSocketService)
{
Logger = logger;
_webSocketService = webSocketService;
Logger.Log(LogLevel.Debug, "WebSocket Controller created");
}
public virtual async Task Accept()
public virtual async Task Connect()
{
if (HttpContext.WebSockets.IsWebSocketRequest)
{
using var webSocket = await HttpContext.WebSockets.AcceptWebSocketAsync();
Logger.Log(LogLevel.Information, "WebSocket connection established to {}", HttpContext.Connection.Id);
Logger.LogInformation("WebSocket connection established to {}", HttpContext.Connection.Id);
WebSocket = webSocket;
await Echo();
}
@ -35,14 +28,14 @@ public abstract class GenericController : ControllerBase
protected virtual async Task Echo()
{
if (WebSocket == null) return;
if (WebSocket is null) return;
try
{
WebSocketReceiveResult? result;
do
{
var buffer = new byte[BufferSize];
result = await _webSocketService.Receive(WebSocket, buffer);
result = await webSocketService.Receive(WebSocket, buffer);
if (result.CloseStatus.HasValue) break;
@ -52,21 +45,21 @@ public abstract class GenericController : ControllerBase
} while (true);
var disconnectSegment = Disconnect();
if (disconnectSegment != null)
if (disconnectSegment is not null)
SendDisconnectMessage((ArraySegment<byte>)disconnectSegment);
await _webSocketService.Close(WebSocket, result.CloseStatus.Value, result.CloseStatusDescription);
await webSocketService.Close(WebSocket, result.CloseStatus.Value, result.CloseStatusDescription);
}
catch (WebSocketException e)
{
Logger.Log(LogLevel.Error, "{}", e.Message);
Logger.LogError("{}", e.Message);
}
}
protected virtual async void Send(ArraySegment<byte> segment)
{
if (WebSocket == null) return;
await _webSocketService.Send(WebSocket, segment);
if (WebSocket is null) return;
await webSocketService.Send(WebSocket, segment);
}
protected abstract ArraySegment<byte> Run(WebSocketReceiveResult result, byte[] data);

14
pac-man-board-game/Controllers/PlayerController.cs
View File

@ -6,21 +6,17 @@ using pacMan.GameStuff.Items;
namespace pacMan.Controllers;
[ApiController]
[Route("api/[controller]")]
public class PlayerController : ControllerBase
[Route("api/[controller]/[action]")]
public class PlayerController(UserService userService) : ControllerBase
{
private readonly UserService _userService;
public PlayerController(UserService userService) => _userService = userService;
[HttpPost("login")]
[HttpPost]
public async Task<IActionResult> Login([FromBody] User user)
{
var result = await _userService.Login(user.Username, user.Password);
var result = await userService.Login(user.Username, user.Password);
if (result is null) return Unauthorized("Invalid username or password");
return Ok((Player)result);
}
[HttpPost("register")]
[HttpPost]
public async Task<IActionResult> Register([FromBody] User user) => throw new NotSupportedException();
}

7
pac-man-board-game/Controllers/WsController.cs
View File

@ -6,12 +6,11 @@ namespace pacMan.Controllers;
[ApiController]
[Route("api/[controller]")]
public class WsController : GenericController
public class WsController(ILogger<WsController> logger, IWebSocketService gameService) :
GenericController(logger, gameService)
{
public WsController(ILogger<WsController> logger, GameService gameService) : base(logger, gameService) { }
[HttpGet]
public override async Task Accept() => await base.Accept();
public override async Task Connect() => await base.Connect();
protected override ArraySegment<byte> Run(WebSocketReceiveResult result, byte[] data)
{

50
pac-man-board-game/DTOs/DTO.cs Normal file
View File

@ -0,0 +1,50 @@
using System.Text.Json.Serialization;
using pacMan.GameStuff;
using pacMan.GameStuff.Items;
namespace pacMan.DTOs;
public readonly record struct JoinGameData(
[property: JsonInclude]
[property: JsonPropertyName("username")]
string Username,
[property: JsonInclude]
[property: JsonPropertyName("gameId")]
Guid GameId
)
{
public void Deconstruct(out string username, out Guid gameId) => (username, gameId) = (Username, GameId);
}
public readonly record struct CreateGameData(
[property: JsonInclude]
[property: JsonPropertyName("player")]
Player Player,
[property: JsonInclude]
[property: JsonPropertyName("spawns")]
Queue<DirectionalPosition> Spawns
);
public readonly record struct ReadyData(
[property: JsonInclude]
[property: JsonPropertyName("allReady")]
bool AllReady,
[property: JsonInclude]
[property: JsonPropertyName("players")]
IEnumerable<Player> Players
);
public readonly record struct MovePlayerData(
[property: JsonInclude]
[property: JsonPropertyName("players")]
List<Player> Players,
[property: JsonInclude]
[property: JsonPropertyName("ghosts")]
List<Character> Ghosts,
[property: JsonInclude]
[property: JsonPropertyName("dice")]
List<int> Dice,
[property: JsonInclude]
[property: JsonPropertyName("eatenPellets")]
List<Position> EatenPellets
);

5
pac-man-board-game/Exceptions/GameExceptions.cs Normal file
View File

@ -0,0 +1,5 @@
namespace pacMan.Exceptions;
public class GameNotFoundException(string message = "Game not found") : Exception(message);
public class GameNotPlayableException(string message = "Game is not allowed to be played") : Exception(message);

6
pac-man-board-game/Exceptions/GameNotFoundException.cs
View File

@ -1,6 +0,0 @@
namespace pacMan.Exceptions;
public class GameNotFoundException : Exception
{
public GameNotFoundException(string message = "Game not found") : base(message) { }
}

6
pac-man-board-game/Exceptions/GameNotPlayableException.cs
View File

@ -1,6 +0,0 @@
namespace pacMan.Exceptions;
public class GameNotPlayableException : Exception
{
public GameNotPlayableException(string message = "Game is not allowed to be played") : base(message) { }
}

3
pac-man-board-game/Exceptions/PlayerExceptions.cs Normal file
View File

@ -0,0 +1,3 @@
namespace pacMan.Exceptions;
public class PlayerNotFoundException(string? message = "Player not found") : Exception(message);

6
pac-man-board-game/Exceptions/PlayerNotFoundException.cs
View File

@ -1,6 +0,0 @@
namespace pacMan.Exceptions;
public class PlayerNotFoundException : Exception
{
public PlayerNotFoundException(string? message = "Player not found") : base(message) { }
}

2
pac-man-board-game/GameStuff/Actions.cs
View File

@ -23,4 +23,4 @@ public class ActionMessage<T>
public static ActionMessage FromJson(string json) => JsonSerializer.Deserialize<ActionMessage>(json)!;
}
public class ActionMessage : ActionMessage<dynamic> { }
public class ActionMessage : ActionMessage<dynamic>;

13
pac-man-board-game/GameStuff/Items/Box.cs
View File

@ -4,10 +4,17 @@ namespace pacMan.GameStuff.Items;
public class Box : IEquatable<Box>
{
[JsonPropertyName("pellets")] public int Pellets { get; init; }
[JsonPropertyName("powerPellets")] public int PowerPellet { get; init; }
[JsonInclude]
[JsonPropertyName("pellets")]
public int Pellets { get; init; }
[JsonPropertyName("colour")] public required string Colour { get; init; }
[JsonInclude]
[JsonPropertyName("powerPellets")]
public int PowerPellet { get; init; }
[JsonInclude]
[JsonPropertyName("colour")]
public required string Colour { get; init; }
public bool Equals(Box? other)
{

9
pac-man-board-game/GameStuff/Items/DiceCup.cs
View File

@ -4,13 +4,10 @@ namespace pacMan.GameStuff.Items;
public class DiceCup
{
private readonly List<Dice> _dices;
public DiceCup() =>
_dices = new List<Dice>
private readonly List<Dice> _dices = new()
{
new(),
new()
new Dice(),
new Dice()
};
[JsonInclude] public List<int> Values => _dices.Select(dice => dice.Value).ToList();

2
pac-man-board-game/GameStuff/Rules.cs
View File

@ -1,6 +1,6 @@
namespace pacMan.GameStuff;
public class Rules
public static class Rules
{
public const int MinPlayers = 2;
public const int MaxPlayers = 4;

10
pac-man-board-game/Interfaces/IWebSocketService.cs
View File

@ -1,10 +0,0 @@
using System.Net.WebSockets;
namespace pacMan.Interfaces;
public interface IWebSocketService
{
Task Send(WebSocket webSocket, ArraySegment<byte> segment);
Task<WebSocketReceiveResult> Receive(WebSocket webSocket, byte[] buffer);
Task Close(WebSocket webSocket, WebSocketCloseStatus closeStatus, string? closeStatusDescription);
}

2
pac-man-board-game/Program.cs
View File

@ -1,5 +1,4 @@
using DAL.Database.Service;
using pacMan.Interfaces;
using pacMan.Services;
var builder = WebApplication.CreateBuilder(args);
@ -8,6 +7,7 @@ var builder = WebApplication.CreateBuilder(args);
builder.Services.AddControllersWithViews();
builder.Services
.AddSingleton<IGameService, GameService>()
.AddSingleton<IWebSocketService, WebSocketService>()
.AddSingleton<GameService>()
.AddScoped<UserService>()

111
pac-man-board-game/Services/ActionService.cs
View File

@ -1,8 +1,7 @@
using System.Net.WebSockets;
using System.Text.Json;
using System.Text.Json.Serialization;
using pacMan.DTOs;
using pacMan.Exceptions;
using pacMan.GameStuff;
using pacMan.GameStuff.Items;
namespace pacMan.Services;
@ -11,11 +10,10 @@ public interface IActionService
{
Player Player { set; }
Game? Game { get; set; }
WebSocket? WebSocket { set; }
void DoAction(ActionMessage message);
WebSocket WebSocket { set; }
List<int> RollDice();
List<Player> FindGame(JsonElement? jsonElement);
object? HandleMoveCharacter(JsonElement? jsonElement);
MovePlayerData HandleMoveCharacter(JsonElement? jsonElement);
ReadyData Ready();
string FindNextPlayer();
List<Player> LeaveGame();
@ -23,68 +21,45 @@ public interface IActionService
List<Player>? Disconnect();
}
public class ActionService : IActionService
public class ActionService(ILogger logger, IGameService gameService) : IActionService
{
private readonly GameService _gameService;
private readonly ILogger<ActionService> _logger;
public ActionService(ILogger<ActionService> logger, GameService gameService)
{
_logger = logger;
_gameService = gameService;
}
public WebSocket? WebSocket { private get; set; }
public WebSocket WebSocket { private get; set; } = null!;
public Game? Game { get; set; }
public Player? Player { get; set; }
public void DoAction(ActionMessage message)
{
message.Data = message.Action switch
{
GameAction.RollDice => RollDice(),
GameAction.MoveCharacter => HandleMoveCharacter(message.Data),
GameAction.JoinGame => FindGame(message.Data),
GameAction.Ready => Ready(),
GameAction.NextPlayer => FindNextPlayer(),
GameAction.Disconnect => LeaveGame(),
_ => message.Data
};
}
public List<int> RollDice()
{
Game?.DiceCup.Roll();
var rolls = Game?.DiceCup.Values ?? new List<int>();
_logger.Log(LogLevel.Information, "Rolled [{}]", string.Join(", ", rolls));
logger.LogInformation("Rolled [{}]", string.Join(", ", rolls));
return rolls;
}
public object? HandleMoveCharacter(JsonElement? jsonElement)
public MovePlayerData HandleMoveCharacter(JsonElement? jsonElement)
{
if (Game != null && jsonElement.HasValue)
var data = jsonElement?.Deserialize<MovePlayerData>() ?? throw new NullReferenceException("Data is null");
if (Game is not null)
{
Game.Ghosts = jsonElement.Value.GetProperty("ghosts").Deserialize<List<Character>>() ??
throw new NullReferenceException("Ghosts is null");
Game.Players = jsonElement.Value.GetProperty("players").Deserialize<List<Player>>() ??
throw new NullReferenceException("Players is null");
Game.Ghosts = data.Ghosts;
Game.Players = data.Players;
}
return jsonElement;
return data;
}
public List<Player> FindGame(JsonElement? jsonElement)
{
var data = jsonElement?.Deserialize<JoinGameData>() ?? throw new NullReferenceException("Data is null");
var (username, gameId) =
jsonElement?.Deserialize<JoinGameData>() ?? throw new NullReferenceException("Data is null");
var game = _gameService.Games.FirstOrDefault(game => game.Id == data.GameId) ??
throw new GameNotFoundException($"Game was not found, id \"{data.GameId}\" does not exist");
var game = gameService.FindGameById(gameId) ??
throw new GameNotFoundException($"Game was not found, id \"{gameId}\" does not exist");
var player = game.Players.Find(p => p.Username == data.Username)
?? throw new PlayerNotFoundException($"Player \"{data.Username}\" was not found in game");
var player = game.FindPlayerByUsername(username) ??
throw new PlayerNotFoundException($"Player \"{username}\" was not found in game");
player.State = game.IsGameStarted ? State.InGame : State.WaitingForPlayers; // TODO doesn't work anymore
Player = player;
@ -96,8 +71,10 @@ public class ActionService : IActionService
public ReadyData Ready()
{
if (Player == null || Game == null)
if (Player is null)
throw new PlayerNotFoundException("Player not found, please create a new player");
if (Game is null)
throw new GameNotFoundException();
var players = Game.SetReady(Player.Username).ToArray();
// TODO roll to start
@ -111,57 +88,21 @@ public class ActionService : IActionService
public List<Player> LeaveGame()
{
if (Game == null || Player == null) throw new NullReferenceException("Game or Player is null");
if (Game is null) throw new NullReferenceException("Game is null");
if (Player is null) throw new NullReferenceException("Player is null");
Game.RemovePlayer(Player.Username);
return Game.Players;
}
public List<Player>? Disconnect()
{
if (Player == null) return null;
if (Player is null) return null;
Player.State = State.Disconnected;
if (Game != null) Game.Connections -= SendSegment;
if (Game is not null) Game.Connections -= SendSegment;
return Game?.Players;
}
public void SendToAll(ArraySegment<byte> segment) => Game?.SendToAll(segment);
private async Task SendSegment(ArraySegment<byte> segment)
{
if (WebSocket != null) await _gameService.Send(WebSocket, segment);
else await Task.FromCanceled(new CancellationToken(true));
}
}
public struct JoinGameData
{
[JsonInclude]
[JsonPropertyName("username")]
public required string Username { get; init; }
[JsonInclude]
[JsonPropertyName("gameId")]
public required Guid GameId { get; init; }
}
public struct CreateGameData
{
[JsonInclude]
[JsonPropertyName("player")]
public required Player Player { get; init; }
[JsonInclude]
[JsonPropertyName("spawns")]
public required Queue<DirectionalPosition> Spawns { get; init; }
}
public struct ReadyData
{
[JsonInclude]
[JsonPropertyName("allReady")]
public required bool AllReady { get; init; }
[JsonInclude]
[JsonPropertyName("players")]
public required IEnumerable<Player> Players { get; set; }
private async Task SendSegment(ArraySegment<byte> segment) => await gameService.Send(WebSocket, segment);
}

13
pac-man-board-game/Services/Game.cs
View File

@ -5,14 +5,12 @@ using pacMan.GameStuff.Items;
namespace pacMan.Services;
public class Game
public class Game(Queue<DirectionalPosition> spawns)
{
private readonly Random _random = new();
private int _currentPlayerIndex;
private List<Player> _players = new();
public Game(Queue<DirectionalPosition> spawns) => Spawns = spawns;
[JsonInclude] public Guid Id { get; } = Guid.NewGuid();
[JsonIgnore]
@ -36,7 +34,7 @@ public class Game
[JsonIgnore] public List<Character> Ghosts { get; set; } = new(); // TODO include
[JsonIgnore] private Queue<DirectionalPosition> Spawns { get; }
[JsonIgnore] private Queue<DirectionalPosition> Spawns { get; } = spawns;
[JsonIgnore] public DiceCup DiceCup { get; } = new(); // TODO include
@ -53,7 +51,7 @@ public class Game
}
catch (DivideByZeroException)
{
throw new InvalidOperationException("There are no players in the game.");
throw new PlayerNotFoundException("There are no players in the game.");
}
return Players[_currentPlayerIndex];
@ -107,9 +105,12 @@ public class Game
public bool SetAllInGame()
{
if (Players.Any(player => player.State != State.Ready)) return false;
if (Players.Any(player => player.State is not State.Ready)) return false;
foreach (var player in Players) player.State = State.InGame;
return true;
}
public Player? FindPlayerByUsername(string username) =>
Players.FirstOrDefault(player => player.Username == username);
}

18
pac-man-board-game/Services/GameService.cs
View File

@ -4,14 +4,21 @@ using pacMan.GameStuff.Items;
namespace pacMan.Services;
public interface IGameService : IWebSocketService
{
SynchronizedCollection<Game> Games { get; }
Game JoinById(Guid id, Player player);
Game CreateAndJoin(Player player, Queue<DirectionalPosition> spawns);
Game? FindGameById(Guid id);
Game? FindGameByUsername(string username);
}
/// <summary>
/// The GameService class provides functionality for managing games in a WebSocket environment. It inherits from the
/// WebSocketService class.
/// </summary>
public class GameService : WebSocketService
public class GameService(ILogger logger) : WebSocketService(logger), IGameService
{
public GameService(ILogger<GameService> logger) : base(logger) { }
/// <summary>
/// A thread-safe collection (SynchronizedCollection) of "Game" objects. Utilized for managing multiple game instances
/// simultaneously.
@ -57,6 +64,11 @@ public class GameService : WebSocketService
return game;
}
public Game? FindGameById(Guid id)
{
return Games.FirstOrDefault(game => game.Id == id);
}
public Game? FindGameByUsername(string username)
{
return Games.FirstOrDefault(game => game.Players.Exists(player => player.Username == username));

23
pac-man-board-game/Services/WebSocketService.cs
View File

@ -1,20 +1,17 @@
using System.Net.WebSockets;
using pacMan.Interfaces;
using pacMan.Utils;
namespace pacMan.Services;
public class WebSocketService : IWebSocketService
public interface IWebSocketService
{
protected readonly ILogger<WebSocketService> Logger;
public WebSocketService(ILogger<WebSocketService> logger)
{
Logger = logger;
logger.Log(LogLevel.Debug, "WebSocket Service created");
}
Task Send(WebSocket webSocket, ArraySegment<byte> segment);
Task<WebSocketReceiveResult> Receive(WebSocket webSocket, byte[] buffer);
Task Close(WebSocket webSocket, WebSocketCloseStatus closeStatus, string? closeStatusDescription);
}
public class WebSocketService(ILogger logger) : IWebSocketService
{
public async Task Send(WebSocket webSocket, ArraySegment<byte> segment)
{
await webSocket.SendAsync(
@ -23,13 +20,13 @@ public class WebSocketService : IWebSocketService
true,
CancellationToken.None);
Logger.Log(LogLevel.Debug, "Message sent to WebSocket");
logger.LogDebug("Message sent through WebSocket");
}
public async Task<WebSocketReceiveResult> Receive(WebSocket webSocket, byte[] buffer)
{
var result = await webSocket.ReceiveAsync(new ArraySegment<byte>(buffer), CancellationToken.None);
Logger.Log(LogLevel.Debug,
logger.LogDebug(
"Message \"{}\" received from WebSocket",
buffer.GetString(result.Count));
return result;
@ -42,6 +39,6 @@ public class WebSocketService : IWebSocketService
closeStatusDescription,
CancellationToken.None);
Logger.Log(LogLevel.Information, "WebSocket connection closed");
logger.LogInformation("WebSocket connection closed");
}
}

2
pac-man-board-game/Utils/Extensions.cs
View File

@ -10,7 +10,7 @@ public static partial class Extensions
{
var s = Encoding.UTF8.GetString(bytes, 0, length);
// Removes invalid characters from the string
return InvalidCharacters().Replace(s, "");
return InvalidCharacters().Replace(s, string.Empty);
}
public static ArraySegment<byte> ToArraySegment(this object obj)

57
pac-man-board-game/pac-man-board-game.csproj
View File

@ -13,70 +13,71 @@
<RootNamespace>pacMan</RootNamespace>
<ImplicitUsings>enable</ImplicitUsings>
<DockerDefaultTargetOS>Linux</DockerDefaultTargetOS>
<LangVersion>12</LangVersion>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Microsoft.AspNetCore.SpaProxy" Version="7.0.13" />
<PackageReference Include="Microsoft.AspNetCore.SpaProxy" Version="8.0.0"/>
<PackageReference Include="Microsoft.TypeScript.MSBuild" Version="5.2.2">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
<PackageReference Include="System.ServiceModel.Primitives" Version="6.1.0" />
<PackageReference Include="System.ServiceModel.Primitives" Version="6.2.0"/>
</ItemGroup>
<ItemGroup>
<!-- Don't publish the SPA source files, but do show them in the project files list -->
<Content Remove="$(SpaRoot)**" />
<Content Remove="$(SpaRoot)**"/>
<Content Include="..\.dockerignore">
<Link>.dockerignore</Link>
</Content>
<None Remove="$(SpaRoot)**" />
<None Include="$(SpaRoot)**" Exclude="$(SpaRoot)node_modules\**" />
<None Remove="$(SpaRoot)**"/>
<None Include="$(SpaRoot)**" Exclude="$(SpaRoot)node_modules\**"/>
</ItemGroup>
<ItemGroup>
<TypeScriptCompile Remove="ClientApp\src\components\Counter.tsx" />
<TypeScriptCompile Remove="ClientApp\src\components\FetchData.tsx" />
<TypeScriptCompile Remove="ClientApp\src\components\Home.tsx" />
<TypeScriptCompile Remove="ClientApp\src\pages\FetchData.tsx" />
<TypeScriptCompile Remove="ClientApp\src\classes\tileMap.ts" />
<TypeScriptCompile Remove="ClientApp\src\game\tileMap.ts" />
<TypeScriptCompile Remove="ClientApp\src\components\gameCanvas.tsx" />
<TypeScriptCompile Remove="ClientApp\src\game\game.ts" />
<TypeScriptCompile Remove="ClientApp\src\App.test.tsx" />
<TypeScriptCompile Remove="ClientApp\src\game\playerStats.tsx" />
<TypeScriptCompile Remove="ClientApp\src\websockets\actions.ts" />
<TypeScriptCompile Remove="ClientApp\src\utils\colours.ts" />
<TypeScriptCompile Remove="ClientApp\src\utils\dom.ts" />
<TypeScriptCompile Remove="ClientApp\src\game\pellet.ts" />
<TypeScriptCompile Remove="ClientApp\src\components\Counter.tsx"/>
<TypeScriptCompile Remove="ClientApp\src\components\FetchData.tsx"/>
<TypeScriptCompile Remove="ClientApp\src\components\Home.tsx"/>
<TypeScriptCompile Remove="ClientApp\src\pages\FetchData.tsx"/>
<TypeScriptCompile Remove="ClientApp\src\classes\tileMap.ts"/>
<TypeScriptCompile Remove="ClientApp\src\game\tileMap.ts"/>
<TypeScriptCompile Remove="ClientApp\src\components\gameCanvas.tsx"/>
<TypeScriptCompile Remove="ClientApp\src\game\game.ts"/>
<TypeScriptCompile Remove="ClientApp\src\App.test.tsx"/>
<TypeScriptCompile Remove="ClientApp\src\game\playerStats.tsx"/>
<TypeScriptCompile Remove="ClientApp\src\websockets\actions.ts"/>
<TypeScriptCompile Remove="ClientApp\src\utils\colours.ts"/>
<TypeScriptCompile Remove="ClientApp\src\utils\dom.ts"/>
<TypeScriptCompile Remove="ClientApp\src\game\pellet.ts"/>
</ItemGroup>
<ItemGroup>
<Folder Include="ClientApp\tests\utils\" />
<Folder Include="ClientApp\tests\utils\"/>
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\DataAccessLayer\DataAccessLayer.csproj" />
<ProjectReference Include="..\DataAccessLayer\DataAccessLayer.csproj"/>
</ItemGroup>
<Target Name="DebugEnsureNodeEnv" BeforeTargets="Build" Condition=" '$(Configuration)' == 'Debug' And !Exists('$(SpaRoot)node_modules') ">
<!-- Ensure Node.js is installed -->
<Exec Command="node --version" ContinueOnError="true">
<Output TaskParameter="ExitCode" PropertyName="ErrorCode" />
<Output TaskParameter="ExitCode" PropertyName="ErrorCode"/>
</Exec>
<Error Condition="'$(ErrorCode)' != '0'" Text="Node.js is required to build and run this project. To continue, please install Node.js from https://nodejs.org/, and then restart your command prompt or IDE." />
<Message Importance="high" Text="Restoring dependencies using 'pnpm'. This may take several minutes..." />
<Exec WorkingDirectory="$(SpaRoot)" Command="pnpm install" />
<Error Condition="'$(ErrorCode)' != '0'" Text="Node.js is required to build and run this project. To continue, please install Node.js from https://nodejs.org/, and then restart your command prompt or IDE."/>
<Message Importance="high" Text="Restoring dependencies using 'pnpm'. This may take several minutes..."/>
<Exec WorkingDirectory="$(SpaRoot)" Command="pnpm install"/>
</Target>
<Target Name="PublishRunWebpack" AfterTargets="ComputeFilesToPublish">
<!-- As part of publishing, ensure the JS resources are freshly built in production mode -->
<Exec WorkingDirectory="$(SpaRoot)" Command="pnpm install" />
<Exec WorkingDirectory="$(SpaRoot)" Command="pnpm build" />
<Exec WorkingDirectory="$(SpaRoot)" Command="pnpm install"/>
<Exec WorkingDirectory="$(SpaRoot)" Command="pnpm build"/>
<!-- Include the newly-built files in the publish output -->
<ItemGroup>
<DistFiles Include="$(SpaRoot)build\**" />
<DistFiles Include="$(SpaRoot)build\**"/>
<ResolvedFileToPublish Include="@(DistFiles->'%(FullPath)')" Exclude="@(ResolvedFileToPublish)">
<RelativePath>wwwroot\%(RecursiveDir)%(FileName)%(Extension)</RelativePath>
<CopyToPublishDirectory>PreserveNewest</CopyToPublishDirectory>