Merge pull request #21 from SnowSE/telemetry

Add telemetry

.github/workflows/deploy-main-branch.yaml

@@ -31,7 +31,7 @@ jobs:
 
       - name: Run Tests
         working-directory: src
-        run: dotnet test
+        run: dotnet test MarsRover.sln
 
       - name: dotnet publish
         working-directory: src/Mars.Web

.github/workflows/deploy-pull-request.yaml

@@ -33,7 +33,7 @@ jobs:
 
       - name: Run Tests
         working-directory: src
-        run: dotnet test
+        run: dotnet test MarsRover.sln
 
       - name: dotnet publish
         working-directory: src/Mars.Web

docker-compose.yml

@@ -0,0 +1,12 @@
+version: "3.0"
+services:
+  seq:
+    image: datalust/seq:latest
+    ports:
+      - "5341:5341"
+      - "80:80"
+      - "45341:45341"
+    volumes:
+      - /datadrive:/data
+    environment:
+      - ACCEPT_EULA=Y

src/.dockerignore

@@ -0,0 +1,25 @@
+**/.classpath
+**/.dockerignore
+**/.env
+**/.git
+**/.gitignore
+**/.project
+**/.settings
+**/.toolstarget
+**/.vs
+**/.vscode
+**/*.*proj.user
+**/*.dbmdl
+**/*.jfm
+**/azds.yaml
+**/bin
+**/charts
+**/docker-compose*
+**/Dockerfile*
+**/node_modules
+**/npm-debug.log
+**/obj
+**/secrets.dev.yaml
+**/values.dev.yaml
+LICENSE
+README.md

src/Mars.MissionControl/Game.cs

@@ -1,41 +1,46 @@
-using System.Collections.ObjectModel;
+using Microsoft.Extensions.Logging;
+using System.Collections.ObjectModel;
 
 namespace Mars.MissionControl;
 public class Game : IDisposable
 {
-  public Game(GameStartOptions startOptions)
-  {
-    GameState = GameState.Joining;
-    Board = new Board(startOptions.Map);
-    Map = startOptions.Map;
-    TargetLocation = new Location(Map.Width / 2, Map.Height / 2);
-    PerseveranceVisibilityRadius = startOptions.PerseveranceVisibilityRadius;
-    IngenuityVisibilityRadius = startOptions.IngenuityVisibilityRadius;
-    StartingBatteryLevel = startOptions.StartingBatteryLevel;
-    IngenuityStartingBatteryLevel = Board.Width * 2 + Board.Height * 2;
-  }
+    public Game(GameStartOptions startOptions, ILogger<Game> logger)
+    {
+        GameState = GameState.Joining;
+        Board = new Board(startOptions.Map);
+        Map = startOptions.Map;
+        TargetLocation = new Location(Map.Width / 2, Map.Height / 2);
+        PerseveranceVisibilityRadius = startOptions.PerseveranceVisibilityRadius;
+        IngenuityVisibilityRadius = startOptions.IngenuityVisibilityRadius;
+        StartingBatteryLevel = startOptions.StartingBatteryLevel;
+        IngenuityStartingBatteryLevel = Board.Width * 2 + Board.Height * 2;
+        this.logger= logger;        
+    }
 
-  public int MapNumber => Board.MapNumber;
-
-  public Location TargetLocation { get; private set; }
-  public int PerseveranceVisibilityRadius { get; }
-  public int IngenuityVisibilityRadius { get; }
-  public int StartingBatteryLevel { get; }
-  public int IngenuityStartingBatteryLevel { get; }
-  public Map Map { get; private set; }
-  private ConcurrentDictionary<PlayerToken, Player> players = new();
-  private ConcurrentDictionary<string, PlayerToken> playerTokenCache = new();
-  public bool TryTranslateToken(string tokenString, out PlayerToken? token) => playerTokenCache.TryGetValue(tokenString, out token);
-  private static Orientation getRandomOrientation() => (Orientation)Random.Shared.Next(0, 4);
-  public GamePlayOptions? GamePlayOptions { get; private set; }
-  public GameState GameState { get; set; }
-  public Board Board { get; private set; }
-  private Timer? rechargeTimer;
-  public DateTime GameStartedOn { get; private set; }
-  public ReadOnlyCollection<Player> Players =>
-      new ReadOnlyCollection<Player>(players.Values.ToList());
-  private ConcurrentQueue<Player> winners = new();
-  public IEnumerable<Player> Winners => winners.ToArray();
+    public int MapNumber => Board.MapNumber;
+
+    public Location TargetLocation { get; private set; }
+    public int PerseveranceVisibilityRadius { get; }
+    public int IngenuityVisibilityRadius { get; }
+    public int StartingBatteryLevel { get; }
+    public int IngenuityStartingBatteryLevel { get; }
+
+    private readonly ILogger<Game> logger;
+
+    public Map Map { get; private set; }
+    private ConcurrentDictionary<PlayerToken, Player> players = new();
+    private ConcurrentDictionary<string, PlayerToken> playerTokenCache = new();
+    public bool TryTranslateToken(string tokenString, out PlayerToken? token) => playerTokenCache.TryGetValue(tokenString, out token);
+    private static Orientation getRandomOrientation() => (Orientation)Random.Shared.Next(0, 4);
+    public GamePlayOptions? GamePlayOptions { get; private set; }
+    public GameState GameState { get; set; }
+    public Board Board { get; private set; }
+    private Timer? rechargeTimer;
+    public DateTime GameStartedOn { get; private set; }
+    public ReadOnlyCollection<Player> Players =>
+        new ReadOnlyCollection<Player>(players.Values.ToList());
+    private ConcurrentQueue<Player> winners = new();
+    public IEnumerable<Player> Winners => winners.ToArray();
 
   #region State Changed
   public event EventHandler? GameStateChanged;
@@ -58,21 +63,23 @@ public JoinResult Join(string playerName)
       throw new InvalidGameStateException();
     }
 
-    var player = new Player(playerName);
-    var startingLocation = Board.PlaceNewPlayer(player);
-    player = player with
-    {
-      BatteryLevel = StartingBatteryLevel,
-      PerseveranceLocation = startingLocation,
-      IngenuityLocation = startingLocation,
-      IngenuityBatteryLevel = StartingBatteryLevel,
-      Orientation = getRandomOrientation()
-    };
-    if (!players.TryAdd(player.Token, player) ||
-       !playerTokenCache.TryAdd(player.Token.Value, player.Token))
-    {
-      throw new Exception("Unable to add new player...that token already exists?!");
-    }
+        var player = new Player(playerName);
+        var startingLocation = Board.PlaceNewPlayer(player);
+        logger.LogInformation("New player came into existance and started at location ({x}, {y}) ", startingLocation.X, startingLocation.Y);
+        player = player with
+        {
+            BatteryLevel = StartingBatteryLevel,
+            PerseveranceLocation = startingLocation,
+            IngenuityLocation = startingLocation,
+            IngenuityBatteryLevel = StartingBatteryLevel,
+            Orientation = getRandomOrientation()
+        };
+        if (!players.TryAdd(player.Token, player) ||
+           !playerTokenCache.TryAdd(player.Token.Value, player.Token))
+        {
+            logger.LogError($"Player {player.Token.Value} couldn't be added");
+            throw new Exception("Unable to add new player...that token already exists?!");
+        }
 
     raiseStateChange();
 
@@ -171,7 +178,8 @@ public IngenuityMoveResult MoveIngenuity(PlayerToken token, Location destination
       message = GameMessages.IngenuityMoveOK;
     }
 
-    raiseStateChange();
+        raiseStateChange();
+        logger.LogInformation("player: {name} moved helicopter correctly and moved to location: {loc}", player.Name, player.IngenuityLocation);
 
     return new IngenuityMoveResult(
         player.IngenuityLocation,
@@ -254,15 +262,17 @@ public MoveResult MovePerseverance(PlayerToken token, Direction direction, int u
       return MovePerseverance(token, direction, updatePlayerTryAgainCount + 1);
     }
 
-    if (player.PerseveranceLocation == TargetLocation)//you win!
-    {
-      players.Remove(player.Token, out _);
-      player = player with { WinningTime = DateTime.Now - GameStartedOn };
-      winners.Enqueue(player);
-      message = GameMessages.YouMadeItToTheTarget;
-    }
+        if (player.PerseveranceLocation == TargetLocation)//you win!
+        {
+            logger.LogInformation("Player {0} has won!", player.Name);
+            players.Remove(player.Token, out _);
+            player = player with { WinningTime = DateTime.Now - GameStartedOn };
+            winners.Enqueue(player);
+            message = GameMessages.YouMadeItToTheTarget;
+        }
 
-    raiseStateChange();
+        raiseStateChange();
+        logger.LogInformation("player: {0} moved rover correctly", player.Name);
 
     return new MoveResult(
         player.PerseveranceLocation,

src/Mars.MissionControl/Helpers.cs

@@ -1,9 +1,16 @@
-namespace Mars.MissionControl;
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Logging.Abstractions;
+using System.Runtime.CompilerServices;
+
+namespace Mars.MissionControl;
 
 public static class Helpers
 {
+    private static ILogger<Game> logger = NullLoggerFactory.Instance.CreateLogger<Game>();
+
     public static Map CreateMap(int height, int width)
     {
+
         var cells = new List<Cell>();
         for (int x = 0; x < width; x++)
         {
@@ -30,11 +37,12 @@ public static Game CreateGame(int height, int width)
 
     public static Game CreateGame(Map map)
     {
+
         var startOptions = new GameStartOptions
         {
             Map = map
         };
-        var game = new Game(startOptions);
+        var game = new Game(startOptions, logger);
         return game;
     }
 

src/Mars.MissionControl/Mars.MissionControl.csproj

@@ -6,4 +6,8 @@
     <Nullable>enable</Nullable>
   </PropertyGroup>
 
+  <ItemGroup>
+    <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="7.0.0" />
+  </ItemGroup>
+
 </Project>

src/Mars.Web.Tests/JoinGameTests.cs

@@ -68,7 +68,7 @@ public async Task CannotMoveWithGameInJoiningState()
         var joinResponse = await client.GetFromJsonAsync<JoinResponse>($"/game/join?gameId={gameId}&name=p1");
         var moveResponse = await client.GetAsync($"/game/moveperseverance?token={joinResponse.Token}&move=Forward");
         var content = await moveResponse.Content.ReadAsStringAsync();
-        content.Should().Contain("invalid game state");
+        content.Should().Contain("Game not in Playing state");
     }
 
 }