From 1ceb147dc8a8708d18d623910affd60b0e1494e8 Mon Sep 17 00:00:00 2001
From: snixtho <snixtho@gmail.com>
Date: Sun, 30 Jun 2024 15:42:47 +0200
Subject: [PATCH] add comments

---
 .../Database/ILocalRecordRepository.cs        | 59 +++++++++++++++++++
 .../Interfaces/ILocalRecord.cs                | 15 +++++
 .../Services/ILocalRecordsService.cs          | 26 ++++++++
 .../LocalRecordsManialinkControllerTests.cs   | 10 ++++
 .../LocalRecordsModuleTests.cs                | 32 ++++++++++
 5 files changed, 142 insertions(+)
 create mode 100644 tests/Modules/LocalRecordsModule.Tests/LocalRecordsModuleTests.cs

diff --git a/src/Modules/LocalRecordsModule/Interfaces/Database/ILocalRecordRepository.cs b/src/Modules/LocalRecordsModule/Interfaces/Database/ILocalRecordRepository.cs
index 3a3b46f1b..cccc0a91b 100644
--- a/src/Modules/LocalRecordsModule/Interfaces/Database/ILocalRecordRepository.cs
+++ b/src/Modules/LocalRecordsModule/Interfaces/Database/ILocalRecordRepository.cs
@@ -6,13 +6,72 @@ namespace EvoSC.Modules.Official.LocalRecordsModule.Interfaces.Database;
 
 public interface ILocalRecordRepository
 {
+    /// <summary>
+    /// Get all local records from a map by its ID.
+    /// </summary>
+    /// <param name="mapId">ID of the map to get local records from.</param>
+    /// <returns></returns>
     public Task<IEnumerable<DbLocalRecord>> GetLocalRecordsOfMapByIdAsync(long mapId);
+    
+    /// <summary>
+    /// Add a new local record, or update it if its better than existing one.
+    /// </summary>
+    /// <param name="map">Map to add local record to.</param>
+    /// <param name="record">The record to add.</param>
+    /// <returns></returns>
     public Task<DbLocalRecord?> AddOrUpdateRecordAsync(IMap map, IPlayerRecord record);
+    
+    /// <summary>
+    /// Add multiple local records to a map.
+    /// </summary>
+    /// <param name="map">Map to add local records to.</param>
+    /// <param name="records">Records to add.</param>
+    /// <returns></returns>
     public Task AddRecordsAsync(IMap map, IEnumerable<IPlayerRecord> records);
+    
+    /// <summary>
+    /// Recalculate positions of all local records in a map. It will
+    /// also remove local records that does not fit within the configured
+    /// top N local records.
+    /// </summary>
+    /// <param name="map">Map to re-calculate local records for.</param>
+    /// <returns></returns>
     public Task<DbLocalRecord[]> RecalculatePositionsOfMapAsync(IMap map);
+    
+    /// <summary>
+    /// Get local records from a player.
+    /// </summary>
+    /// <param name="player">Player to get local records from.</param>
+    /// <returns></returns>
     public Task<IEnumerable<DbLocalRecord>> GetRecordsByPlayerAsync(IPlayer player);
+    
+    /// <summary>
+    /// Get the local record of a player for a map.
+    /// </summary>
+    /// <param name="player">The player to get the local record of.</param>
+    /// <param name="map">The map to get the local record for.</param>
+    /// <returns></returns>
     public Task<DbLocalRecord?> GetRecordOfPlayerInMapAsync(IPlayer player, IMap map);
+    
+    /// <summary>
+    /// Delete a local record for a player in a map.
+    /// </summary>
+    /// <param name="player">The player that has the local record.</param>
+    /// <param name="map">The map that contains the local record.</param>
+    /// <returns></returns>
     public Task DeleteRecordAsync(IPlayer player, IMap map);
+    
+    /// <summary>
+    /// Delete a local record.
+    /// </summary>
+    /// <param name="localRecord">The local record to remove.</param>
+    /// <returns></returns>
     public Task DeleteRecordAsync(ILocalRecord localRecord);
+    
+    /// <summary>
+    /// Delete all local records from a map.
+    /// </summary>
+    /// <param name="map">The map to clear all local records from.</param>
+    /// <returns></returns>
     public Task DeleteRecordsAsync(IMap map);
 }
diff --git a/src/Modules/LocalRecordsModule/Interfaces/ILocalRecord.cs b/src/Modules/LocalRecordsModule/Interfaces/ILocalRecord.cs
index 1742a30af..69b072655 100644
--- a/src/Modules/LocalRecordsModule/Interfaces/ILocalRecord.cs
+++ b/src/Modules/LocalRecordsModule/Interfaces/ILocalRecord.cs
@@ -5,8 +5,23 @@ namespace EvoSC.Modules.Official.LocalRecordsModule.Interfaces;
 
 public interface ILocalRecord
 {
+    /// <summary>
+    /// The ID of the record.
+    /// </summary>
     public long Id { get; }
+    
+    /// <summary>
+    /// The position of the record in the leaderboard.
+    /// </summary>
     public int Position { get; }
+    
+    /// <summary>
+    /// The map the record is set on.
+    /// </summary>
     public IMap Map { get; }
+    
+    /// <summary>
+    /// The player record.
+    /// </summary>
     public IPlayerRecord Record { get; }
 }
diff --git a/src/Modules/LocalRecordsModule/Interfaces/Services/ILocalRecordsService.cs b/src/Modules/LocalRecordsModule/Interfaces/Services/ILocalRecordsService.cs
index 347dc895f..1828bc803 100644
--- a/src/Modules/LocalRecordsModule/Interfaces/Services/ILocalRecordsService.cs
+++ b/src/Modules/LocalRecordsModule/Interfaces/Services/ILocalRecordsService.cs
@@ -5,10 +5,36 @@ namespace EvoSC.Modules.Official.LocalRecordsModule.Interfaces.Services;
 
 public interface ILocalRecordsService
 {
+    /// <summary>
+    /// Get all local records of the current map on the server.
+    /// </summary>
+    /// <returns></returns>
     public Task<ILocalRecord[]> GetLocalsOfCurrentMapAsync();
+    
+    /// <summary>
+    /// Show/Update the local records widget to a player.
+    /// </summary>
+    /// <param name="player"></param>
+    /// <returns></returns>
     public Task ShowWidgetAsync(IPlayer player);
+    
+    /// <summary>
+    /// Show/Update the local records widget to all players.
+    /// </summary>
+    /// <returns></returns>
     public Task ShowWidgetToAllAsync();
+    
+    /// <summary>
+    /// Update a player's local record for the current map.
+    /// </summary>
+    /// <param name="record"></param>
+    /// <returns></returns>
     public Task UpdatePbAsync(IPlayerRecord record);
 
+    /// <summary>
+    /// Remove all local records on all maps, and add them back based on the
+    /// registered PBs of players.
+    /// </summary>
+    /// <returns></returns>
     public Task ResetLocalRecordsAsync();
 }
diff --git a/tests/Modules/LocalRecordsModule.Tests/Controllers/LocalRecordsManialinkControllerTests.cs b/tests/Modules/LocalRecordsModule.Tests/Controllers/LocalRecordsManialinkControllerTests.cs
index 74671d24b..b9c6ee6b6 100644
--- a/tests/Modules/LocalRecordsModule.Tests/Controllers/LocalRecordsManialinkControllerTests.cs
+++ b/tests/Modules/LocalRecordsModule.Tests/Controllers/LocalRecordsManialinkControllerTests.cs
@@ -43,4 +43,14 @@ public async Task Reset_Records_Cancel_Does_Not_Resets_All_Records()
         AuditEventBuilder.Verify(m => m.Success(), Times.Never);
         AuditEventBuilder.Verify(m => m.Error(), Times.Never);
     }
+
+    [Fact]
+    public async Task Reset_Records_Error_Is_Reported()
+    {
+        _localRecordsService.Setup(m => m.ResetLocalRecordsAsync()).Throws<Exception>();
+        
+        await Assert.ThrowsAsync<Exception>(() => Controller.ConfirmResetAsync(true));
+        _server.Server.Verify(m => m.ErrorMessageAsync(It.IsAny<string>()));
+        AuditEventBuilder.Verify(m => m.Error());
+    }
 }
diff --git a/tests/Modules/LocalRecordsModule.Tests/LocalRecordsModuleTests.cs b/tests/Modules/LocalRecordsModule.Tests/LocalRecordsModuleTests.cs
new file mode 100644
index 000000000..076647489
--- /dev/null
+++ b/tests/Modules/LocalRecordsModule.Tests/LocalRecordsModuleTests.cs
@@ -0,0 +1,32 @@
+using EvoSC.Manialinks.Interfaces;
+using EvoSC.Modules.Official.LocalRecordsModule.Interfaces.Services;
+using Moq;
+
+namespace LocalRecordsModule.Tests;
+
+public class LocalRecordsModuleTests
+{
+    [Fact]
+    public async Task Widget_Is_Shown_To_All_On_Enable()
+    {
+        var manialinks = new Mock<IManialinkManager>();
+        var localRecords = new Mock<ILocalRecordsService>();
+        var module = new EvoSC.Modules.Official.LocalRecordsModule.LocalRecordsModule(manialinks.Object, localRecords.Object);
+
+        await module.EnableAsync();
+        
+        localRecords.Verify(m => m.ShowWidgetToAllAsync());
+    }
+    
+    [Fact]
+    public async Task Widget_Is_Hidden_On_Disable()
+    {
+        var manialinks = new Mock<IManialinkManager>();
+        var localRecords = new Mock<ILocalRecordsService>();
+        var module = new EvoSC.Modules.Official.LocalRecordsModule.LocalRecordsModule(manialinks.Object, localRecords.Object);
+
+        await module.DisableAsync();
+
+        manialinks.Verify(m => m.HideManialinkAsync("LocalRecordsModule.LocalRecordsWidget"));
+    }
+}