Implement Achievement/Badge System with Admin Commands

DiscordBot.Tests/Extensions/BadgeRepositoryTests.cs

@@ -0,0 +1,31 @@
+using DiscordBot.Extensions;
+
+namespace DiscordBot.Tests.Extensions;
+
+public class BadgeRepositoryTests
+{
+    [Fact]
+    public void EnsureBadgeDetails_UsesFlattenedBadgeColumns_WhenNavigationPropertyIsMissing()
+    {
+        var userBadge = new UserBadge
+        {
+            UserID = "123",
+            BadgeId = 42,
+            AwardedAt = new DateTime(2024, 01, 01, 12, 0, 0, DateTimeKind.Utc),
+            AwardedBy = "456",
+            BadgeTitle = "Test Badge",
+            BadgeDescription = "A very nice badge.",
+            BadgeGroupKey = "udcjam",
+            BadgeIsPublic = true
+        };
+
+        var badge = userBadge.EnsureBadgeDetails();
+
+        Assert.NotNull(badge);
+        Assert.Equal("Test Badge", badge.Title);
+        Assert.Equal("A very nice badge.", badge.Description);
+        Assert.Equal("udcjam", badge.GroupKey);
+        Assert.True(badge.IsPublic);
+        Assert.Same(badge, userBadge.Badge);
+    }
+}

DiscordBot/Extensions/BadgeRepository.cs

@@ -0,0 +1,210 @@
+using Insight.Database;
+
+namespace DiscordBot.Extensions;
+
+public class Badge
+{
+    public int Id { get; set; }
+    public string Title { get; set; }
+    public string Description { get; set; }
+    public string? GroupKey { get; set; }
+    public bool IsPublic { get; set; } = true;
+    public DateTime CreatedAt { get; set; }
+}
+
+public class UserBadge
+{
+    public int Id { get; set; }
+    public string UserID { get; set; } = string.Empty;
+    public int BadgeId { get; set; }
+    public DateTime AwardedAt { get; set; }
+    public string AwardedBy { get; set; } = string.Empty;
+
+    // Flattened fields returned by joined badge queries.
+    public string? BadgeTitle { get; set; }
+    public string? BadgeDescription { get; set; }
+    public string? BadgeGroupKey { get; set; }
+    public bool BadgeIsPublic { get; set; } = true;
+    public DateTime? BadgeCreatedAt { get; set; }
+
+    // Navigation property used by code that expects a fully hydrated badge.
+    public Badge Badge { get; set; } = new();
+
+    public Badge EnsureBadgeDetails()
+    {
+        if (Badge != null && !string.IsNullOrWhiteSpace(Badge.Title) && !string.IsNullOrWhiteSpace(Badge.Description))
+            return Badge;
+
+        Badge = new Badge
+        {
+            Id = BadgeId,
+            Title = BadgeTitle ?? string.Empty,
+            Description = BadgeDescription ?? string.Empty,
+            GroupKey = BadgeGroupKey,
+            IsPublic = BadgeIsPublic,
+            CreatedAt = BadgeCreatedAt ?? AwardedAt
+        };
+
+        return Badge;
+    }
+}
+
+public class BadgeLeaderboardEntry
+{
+    public string UserId { get; set; }
+    public long BadgeCount { get; set; }
+}
+
+/// <summary>
+/// Table Properties for Badge. Intended to be used with IBadgeRepo and enforce consistency.
+/// </summary>
+public static class BadgeProps
+{
+    public const string TableName = "badges";
+
+    public const string Id = nameof(Badge.Id);
+    public const string Title = nameof(Badge.Title);
+    public const string Description = nameof(Badge.Description);
+    public const string GroupKey = nameof(Badge.GroupKey);
+    public const string IsPublic = nameof(Badge.IsPublic);
+    public const string CreatedAt = nameof(Badge.CreatedAt);
+}
+
+/// <summary>
+/// Table Properties for UserBadge. Intended to be used with IBadgeRepo and enforce consistency.
+/// </summary>
+public static class UserBadgeProps
+{
+    public const string TableName = "user_badges";
+
+    public const string Id = nameof(UserBadge.Id);
+    public const string UserID = nameof(UserBadge.UserID);
+    public const string BadgeId = nameof(UserBadge.BadgeId);
+    public const string AwardedAt = nameof(UserBadge.AwardedAt);
+    public const string AwardedBy = nameof(UserBadge.AwardedBy);
+}
+
+public interface IBadgeRepo
+{
+    #region Badge Management
+
+    [Sql($@"
+    INSERT INTO {BadgeProps.TableName} ({BadgeProps.Title}, {BadgeProps.Description}, {BadgeProps.GroupKey}, {BadgeProps.IsPublic}, {BadgeProps.CreatedAt}) 
+    VALUES (@{BadgeProps.Title}, @{BadgeProps.Description}, @{BadgeProps.GroupKey}, @{BadgeProps.IsPublic}, @{BadgeProps.CreatedAt})
+    RETURNING *")]
+    Task<Badge> CreateBadge(Badge badge);
+
+    [Sql($"SELECT * FROM {BadgeProps.TableName} ORDER BY {BadgeProps.Title}")]
+    Task<IList<Badge>> GetAllBadges();
+
+    [Sql($"SELECT * FROM {BadgeProps.TableName} WHERE {BadgeProps.IsPublic} = TRUE ORDER BY {BadgeProps.Title}")]
+    Task<IList<Badge>> GetPublicBadges();
+
+    [Sql($"SELECT * FROM {BadgeProps.TableName} WHERE {BadgeProps.Id} = @badgeId")]
+    Task<Badge> GetBadge(int badgeId);
+
+    [Sql($"SELECT * FROM {BadgeProps.TableName} WHERE {BadgeProps.Title} = @title")]
+    Task<Badge> GetBadgeByTitle(string title);
+
+    [Sql($"UPDATE {BadgeProps.TableName} SET {BadgeProps.Title} = @{BadgeProps.Title}, {BadgeProps.Description} = @{BadgeProps.Description}, {BadgeProps.GroupKey} = @{BadgeProps.GroupKey}, {BadgeProps.IsPublic} = @{BadgeProps.IsPublic} WHERE {BadgeProps.Id} = @{BadgeProps.Id}")]
+    Task UpdateBadge(Badge badge);
+
+    [Sql($"DELETE FROM {BadgeProps.TableName} WHERE {BadgeProps.Id} = @badgeId")]
+    Task DeleteBadge(int badgeId);
+
+    #endregion // Badge Management
+
+    #region User Badge Management
+
+    [Sql($@"
+    INSERT INTO {UserBadgeProps.TableName} ({UserBadgeProps.UserID}, {UserBadgeProps.BadgeId}, {UserBadgeProps.AwardedAt}, {UserBadgeProps.AwardedBy}) 
+    VALUES (@{UserBadgeProps.UserID}, @{UserBadgeProps.BadgeId}, @{UserBadgeProps.AwardedAt}, @{UserBadgeProps.AwardedBy})
+    RETURNING *")]
+    Task<UserBadge> AssignBadgeToUser(UserBadge userBadge);
+
+    [Sql($"DELETE FROM {UserBadgeProps.TableName} WHERE {UserBadgeProps.UserID} = @userId AND {UserBadgeProps.BadgeId} = @badgeId")]
+    Task RemoveBadgeFromUser(string userId, int badgeId);
+
+    [Sql($@"
+        SELECT ub.*, 
+            b.{BadgeProps.Title} AS {nameof(UserBadge.BadgeTitle)}, 
+            b.{BadgeProps.Description} AS {nameof(UserBadge.BadgeDescription)}, 
+            b.{BadgeProps.GroupKey} AS {nameof(UserBadge.BadgeGroupKey)}, 
+            b.{BadgeProps.IsPublic} AS {nameof(UserBadge.BadgeIsPublic)}, 
+            b.{BadgeProps.CreatedAt} AS {nameof(UserBadge.BadgeCreatedAt)}
+    FROM {UserBadgeProps.TableName} ub
+    JOIN {BadgeProps.TableName} b ON ub.{UserBadgeProps.BadgeId} = b.{BadgeProps.Id}
+    WHERE ub.{UserBadgeProps.UserID} = @userId
+    ORDER BY ub.{UserBadgeProps.AwardedAt} DESC")]
+    Task<IList<UserBadge>> GetUserBadges(string userId);
+
+    [Sql($@"
+        SELECT ub.*, 
+            b.{BadgeProps.Title} AS {nameof(UserBadge.BadgeTitle)}, 
+            b.{BadgeProps.Description} AS {nameof(UserBadge.BadgeDescription)}, 
+            b.{BadgeProps.GroupKey} AS {nameof(UserBadge.BadgeGroupKey)}, 
+            b.{BadgeProps.IsPublic} AS {nameof(UserBadge.BadgeIsPublic)}, 
+            b.{BadgeProps.CreatedAt} AS {nameof(UserBadge.BadgeCreatedAt)}
+    FROM {UserBadgeProps.TableName} ub
+    JOIN {BadgeProps.TableName} b ON ub.{UserBadgeProps.BadgeId} = b.{BadgeProps.Id}
+    WHERE ub.{UserBadgeProps.UserID} = @userId AND b.{BadgeProps.IsPublic} = TRUE
+    ORDER BY ub.{UserBadgeProps.AwardedAt} DESC")]
+    Task<IList<UserBadge>> GetUserPublicBadges(string userId);
+
+    [Sql($@"
+    SELECT ub.{UserBadgeProps.UserID} AS UserId, COUNT(*) AS BadgeCount
+    FROM {UserBadgeProps.TableName} ub
+    JOIN {BadgeProps.TableName} b ON ub.{UserBadgeProps.BadgeId} = b.{BadgeProps.Id}
+    GROUP BY ub.{UserBadgeProps.UserID}
+    ORDER BY BadgeCount DESC, ub.{UserBadgeProps.UserID}
+    LIMIT @limit")]
+    Task<IList<BadgeLeaderboardEntry>> GetBadgeLeaderboard(int limit);
+
+    [Sql($@"
+    SELECT ub.{UserBadgeProps.UserID} AS UserId, COUNT(*) AS BadgeCount
+    FROM {UserBadgeProps.TableName} ub
+    JOIN {BadgeProps.TableName} b ON ub.{UserBadgeProps.BadgeId} = b.{BadgeProps.Id}
+    WHERE b.{BadgeProps.IsPublic} = TRUE
+    GROUP BY ub.{UserBadgeProps.UserID}
+    ORDER BY BadgeCount DESC, ub.{UserBadgeProps.UserID}
+    LIMIT @limit")]
+    Task<IList<BadgeLeaderboardEntry>> GetPublicBadgeLeaderboard(int limit);
+
+    [Sql($@"
+    SELECT ub.{UserBadgeProps.UserID} AS UserId, COUNT(*) AS BadgeCount
+    FROM {UserBadgeProps.TableName} ub
+    JOIN {BadgeProps.TableName} b ON ub.{UserBadgeProps.BadgeId} = b.{BadgeProps.Id}
+    WHERE b.{BadgeProps.GroupKey} = @groupKey
+    GROUP BY ub.{UserBadgeProps.UserID}
+    ORDER BY BadgeCount DESC, ub.{UserBadgeProps.UserID}
+    LIMIT @limit")]
+    Task<IList<BadgeLeaderboardEntry>> GetBadgeLeaderboardByGroup(string groupKey, int limit);
+
+    [Sql($@"
+    SELECT ub.{UserBadgeProps.UserID} AS UserId, COUNT(*) AS BadgeCount
+    FROM {UserBadgeProps.TableName} ub
+    JOIN {BadgeProps.TableName} b ON ub.{UserBadgeProps.BadgeId} = b.{BadgeProps.Id}
+    WHERE b.{BadgeProps.IsPublic} = TRUE AND b.{BadgeProps.GroupKey} = @groupKey
+    GROUP BY ub.{UserBadgeProps.UserID}
+    ORDER BY BadgeCount DESC, ub.{UserBadgeProps.UserID}
+    LIMIT @limit")]
+    Task<IList<BadgeLeaderboardEntry>> GetPublicBadgeLeaderboardByGroup(string groupKey, int limit);
+
+    [Sql($@"
+    SELECT COUNT(*) FROM {UserBadgeProps.TableName}
+    WHERE {UserBadgeProps.UserID} = @userId AND {UserBadgeProps.BadgeId} = @badgeId")]
+    Task<long> CheckUserHasBadge(string userId, int badgeId);
+
+    [Sql($@"
+    SELECT ub.{UserBadgeProps.UserID}, ub.{UserBadgeProps.AwardedAt}, ub.{UserBadgeProps.AwardedBy}
+    FROM {UserBadgeProps.TableName} ub
+    WHERE ub.{UserBadgeProps.BadgeId} = @badgeId
+    ORDER BY ub.{UserBadgeProps.AwardedAt} DESC")]
+    Task<IList<UserBadge>> GetBadgeHolders(int badgeId);
+
+    #endregion // User Badge Management
+
+    /// <summary>Returns a count of badges in the Table, used for testing connection. </summary>
+    [Sql($"SELECT COUNT(*) FROM {BadgeProps.TableName}")]
+    Task<long> TestBadgeConnection();
+}