Merge pull request #67 from SahneeDEV/develop

Develop

Author: Kaylee Sachs

README.md

@@ -144,15 +144,18 @@ If hosting the bot yourself you will need to adjust the `appsettings.json` file:
     "BotSettings": {
         "IconUrl": "https://sahnee.dev/wp-content/uploads/2020/04/sahnee-bot-150x150.png",
         "Url": "https://sahnee.dev/en/project/sahnee-bot/",
+        "GithubUrl": "https://github.com/SahneeDEV/sahnee-bot",
         "WarningRolePrefix": "warning: ",
         "WarningRoleColor": "#607D8B",
         "SupportServer": "https://discord.gg/FfVurUzVfE",
         "Changelog": "./CHANGELOG.md",
+        "MaxChangelogsSendCount": "5",
         "ReleaseInformation": "./ReleaseInformation.txt",
         "InviteUrl": "https://discord.com/api/oauth2/authorize?client_id=689600370430836793&permissions=268627014&redirect_uri=https%3A%2F%2Fsahnee.dev%2Fen%2Fproject%2Fsahnee-bot%2F&scope=bot%20applications.commands",
         "ErrorWebhookUrl": "https://discord.com/api/webhooks/12345/abcde",
         "Jobs": {
-            "CleanupWarningRoles": "1:00:00"
+            "CleanupWarningRoles": "1:00:00",
+            "UpdateGuildChangelog": "0:01:00"
         }
     }
 }
@@ -165,13 +168,25 @@ If hosting the bot yourself you will need to adjust the `appsettings.json` file:
 * `Discord:Implementation` - Allows you to set if you want to use the `Socket` or `Rest` discord API implementation. Don't change unless you know what you are doing and absolutely need it.
 * `BotSettings:IconUrl` - The icon of the bot used in messages.
 * `BotSettings:Url` - The homepage the bot links to.
+* `BotSettings:GithubUrl` - The source code page the bot links to.
 * `BotSettings:WarningRolePrefix` - The default prefix for warning roles of servers that have not configured their own.
 * `BotSettings:WarningRoleColor` - The default color for warning roles on a server.
 * `BotSettings:SupportServer` - A link to the support page for the bot.
 * `BotSettings:Changelog` - The path to the changelog file on disk. Will be scanned for a new version of bot startup.
+* `BotSettings:MaxChangelogsSendCount` - How many servers will be notified at once about a new version.
 * `BotSettings:ReleaseInformation` - A file that contains information about the release of the bot. Will be printed in the `/help` command.
 * `BotSettings:InviteUrl` - The invite URL users should use to invite the bot to their servers.
 * `BotSettings:ErrorWebhookUrl` - A webhook errors will be sent to.
 * `BotSettings:Jobs:CleanupWarningRoles` - The frequency in how often warnings created by the bot that are no longer used will be deleted.
+* `BotSettings:Jobs:UpdateGuildChangelog` - How often the bot will check if more servers need to be informed about a new version.
 
 Time spans for jobs are formatted in the format documented [here](https://docs.microsoft.com/en-us/dotnet/api/system.timespan.parse?view=net-6.0#system-timespan-parse(system-string)) under the section "Remarks" (`[ws][-]{ d | [d.]hh:mm[:ss[.ff]] }[ws]`).
+
+### Discord developer portal settings
+
+* **Bot -> Privileged Gateway Intents**: `Presence Intent`, `Server Members Intent`
+* **OAuth2 -> General -> Redirects**: Add your redirect URL. In the example below `https://sahnee.dev/en/project/sahnee-bot/`
+* **Permissions**: When creating the invite URL the bot needs the following numeric permissions: `268627014`.
+* **Scopes**: The following scopes are required: `bot` and `application.commands`.
+
+This for reference is the official invite URL: `https://discord.com/api/oauth2/authorize?client_id=689600370430836793&permissions=268627014&redirect_uri=https%3A%2F%2Fsahnee.dev%2Fen%2Fproject%2Fsahnee-bot%2F&scope=bot%20applications.commands`

SahneeBot/CHANGELOG.md

@@ -1,4 +1,16 @@
-# CHANGELOG
+# CHANGELOG
+
+## 1.0.3
+
+Changelogs after a new update are now sent to only a few servers at a time instead of all at once (causing the Discord API to trigger a rate limit). This should reduce the flood of false error messages some servers got after a new update has been released.
+
+## 1.1.0
+
+- We updated some internally used libraries to communicate with Discord. This should overall fix some common errors.
+- We fixed an error in the warning cleanup job if a role without a name exists.
+- We updated the changelog distribution system to not overload the bot after each update when sending out all these changelogs to you folks! (hopefully)
+
+Additionally, we are currently conducting a user survey about the Sahnee-Bot. We'd love for everyone to share their opinion, regardless of if you are a server admin, moderator or a normal user: https://click.sahnee.dev/UsEHTYOj - Thank you for your time! 🙂
 
 ## 1.0.2
 

SahneeBot/Commands/ChangelogCommand.cs

@@ -1,6 +1,6 @@
 using Discord.Interactions;
 using SahneeBot.Formatter;
-using SahneeBotController.Tasks;
+using SahneeBotController.Tasks.Changelog;
 
 namespace SahneeBot.Commands;
 

SahneeBot/Events/ChangelogEvent.cs

@@ -0,0 +1,46 @@
+using Discord;
+using Microsoft.Extensions.Logging;
+using SahneeBotController;
+
+namespace SahneeBot.Events;
+
+/// <summary>
+/// The changelog event is called whenever a guild is available and posts the newest changelog.
+/// </summary>
+[Event]
+public class EnqueueGuildForChangelogEvent : EventBase<IGuild>
+{
+    private readonly ILogger<EnqueueGuildForChangelogEvent> _logger;
+    private readonly Bot _bot;
+    private readonly GuildChangelogQueue _queue;
+
+    public EnqueueGuildForChangelogEvent(IServiceProvider serviceProvider
+        , ILogger<EnqueueGuildForChangelogEvent> logger
+        , Bot bot
+        , GuildChangelogQueue queue) : base(serviceProvider)
+    {
+        _logger = logger;
+        _bot = bot;
+        _queue = queue;
+    }
+
+    public override void Register()
+    {
+        _bot.Impl(socket => socket.GuildAvailable += Handle
+            , rest => 
+                throw new InvalidOperationException("The changelog event only support the socket client."));
+    }
+
+    public override Task Handle(IGuild arg) => HandleAsync(ctx => 
+    {
+        _logger.LogDebug("Enqueue guild {Id} ({Name}) for the changelog event", arg.Id, arg.Name);
+        _queue.Enqueue(arg.Id);
+        return Task.FromResult<ISuccess>(new Success<bool>(true));
+    }, new EventExecutionOptions 
+    {
+        PlaceInQueue = arg.Id
+        , RelatedGuildId = arg.Id
+        , Name = "prepare new changelogs"
+        , Debug = arg.Id.ToString()
+    });
+}

SahneeBot/Events/EnqueueGuildForChangelogEvent.cs

@@ -114,11 +114,25 @@ public delegate Task RespondAsyncDelegate(
         AllowedMentions? allowedMentions = null,
         RequestOptions? options = null,
         MessageComponent? components = null,
-        Embed? embed = null);
+        Embed? embed = null,
+        MessageFlags flags = MessageFlags.None, 
+        ulong? threadId = null);
 
     public delegate Task SendMessageAsyncDelegate(
         string? text = null,
         bool isTts = false,
+        IEnumerable<Embed>? embeds = null,
+        string? username = null,
+        string? avatarUrl = null,
+        RequestOptions? options = null,
+        AllowedMentions? allowedMentions = null,
+        MessageComponent? components = null,
+        MessageFlags flags = MessageFlags.None, 
+        ulong? threadId = null);
+
+    public delegate Task SendUserMessageAsyncDelegate(
+        string? text = null,
+        bool isTtS = false,
         Embed? embed = null,
         RequestOptions? options = null,
         AllowedMentions? allowedMentions = null,
@@ -142,7 +156,8 @@ public delegate Task<IUserMessage> SendChannelMessageAsyncDelegate(
         MessageReference? messageReference = null,
         MessageComponent? components = null,
         ISticker[]? stickers = null,
-        Embed[]? embeds = null);
+        Embed[]? embeds = null,
+        MessageFlags flags = MessageFlags.None);
 
     public delegate Task<ulong> SendWebhookMessageAsyncDelegate(
         string? text = null,
@@ -163,14 +178,19 @@ await del(Text, Embeds?.Select(e => e.Build()).ToArray(), sendOptions.IsTts, sen
     }
     public async Task Send(SendMessageAsyncDelegate del, SendOptions sendOptions = default)
     {
-        await del(Text, sendOptions.IsTts, Embed?.Build(), sendOptions.Request, AllowedMentions, Components?.Build(),
-            Embeds?.Select(e => e.Build()).ToArray());
+        await del(Text, sendOptions.IsTts, Embeds?.Select(e => e.Build()).ToArray(), "", string.Empty, 
+            sendOptions.Request, AllowedMentions, Components?.Build());
     }
     public async Task Send(SendChannelMessageAsyncDelegate del, SendOptions sendOptions = default)
     {
         await del(Text, sendOptions.IsTts, Embed?.Build(), sendOptions.Request, AllowedMentions, null,
             Components?.Build(), null, Embeds?.Select(e => e.Build()).ToArray());
     }
+    public async Task Send(SendUserMessageAsyncDelegate del, SendOptions sendOptions = default)
+    {
+        await del(Text, sendOptions.IsTts, Embed?.Build(), sendOptions.Request, AllowedMentions,
+            Components?.Build(), Embeds?.Select(e => e.Build()).ToArray());
+    }
     public async Task Send(SendWebhookMessageAsyncDelegate del, SendOptions sendOptions = default)
     {
         var embeds = Embeds != null 

SahneeBot/Formatter/DiscordFormat.cs

@@ -1,4 +1,5 @@
 using Discord;
+using Microsoft.Extensions.Configuration;
 
 namespace SahneeBot.Formatter;
 
@@ -15,16 +16,19 @@ public record struct Args(ulong? GuildId, ulong? UserId);
     private readonly DefaultFormatArguments _defaultFormatArguments;
     private readonly Release _release;
     private readonly Changelog _changelog;
-    private const string WEBSITE = "https://sahnee.dev/en/project/sahnee-bot/";
-    private const string GITHUB = "https://github.com/Sahnee-DE/sahnee-bot";
+    private readonly string _website;
+    private readonly string _github;
 
     public HelpDiscordFormatter(DefaultFormatArguments defaultFormatArguments
         , Release release
-        , Changelog changelog)
+        , Changelog changelog
+        , IConfiguration configuration)
     {
         _defaultFormatArguments = defaultFormatArguments;
         _release = release;
         _changelog = changelog;
+        _website = configuration["BotSettings:Url"];
+        _github = configuration["BotSettings:GithubUrl"];
     }
 
     public Task<DiscordFormat> Format(Args arg)
@@ -36,13 +40,13 @@ public Task<DiscordFormat> Format(Args arg)
             new()
             {
                 Name = "Website of the bot",
-                Value = WEBSITE,
+                Value = _website,
                 IsInline = true
             },
             new()
             {
                 Name = "GitHub Repository of the bot",
-                Value = GITHUB,
+                Value = _github,
                 IsInline = true
             },
             new()

SahneeBot/Formatter/HelpDiscordFormatter.cs

@@ -47,6 +47,12 @@ public static async Task FormatAndSend<T>(this IDiscordFormatter<T> discordForma
         var format = await discordFormatter.Format(arg);
         await format.Send(del, sendOptions);
     }
+    public static async Task FormatAndSend<T>(this IDiscordFormatter<T> discordFormatter, T arg, 
+        DiscordFormat.SendUserMessageAsyncDelegate del, DiscordFormat.SendOptions sendOptions = default)
+    {
+        var format = await discordFormatter.Format(arg);
+        await format.Send(del, sendOptions);
+    }
     public static async Task FormatAndSend<T>(this IDiscordFormatter<T> discordFormatter, T arg, 
         DiscordFormat.SendWebhookMessageAsyncDelegate del, DiscordFormat.SendOptions sendOptions = default)
     {
@@ -125,6 +131,25 @@ public static async Task<bool> SendMany(this IEnumerable<DiscordFormat> formats
         return sentAny;
     }
 
+    public static async Task<bool> SendMany(this IEnumerable<DiscordFormat> formats
+        , DiscordFormat.SendUserMessageAsyncDelegate del
+        , DiscordFormat.SendOptions sendOptions = default
+        , Func<Task>? beforeSendFirst = null)
+    {
+        var sentAny = false;
+        foreach (var format in formats)
+        {
+            if (!sentAny && beforeSendFirst != null)
+            {
+                await beforeSendFirst();
+            }
+            await format.Send(del, sendOptions);
+            sentAny = true;
+        }
+
+        return sentAny;
+    }
+
     public static async Task<bool> SendMany(this IEnumerable<DiscordFormat> formats
         , DiscordFormat.SendMessageAsyncDelegate del
         , DiscordFormat.SendOptions sendOptions = default

SahneeBot/Formatter/IDiscordFormatter.cs

@@ -0,0 +1,30 @@
+using System.Collections.Concurrent;
+
+namespace SahneeBot;
+
+/// <summary>
+/// The queue for guilds that should be checked for changelogs.
+/// </summary>
+public class GuildChangelogQueue
+{
+    private readonly ConcurrentQueue<ulong> _queue = new();
+
+    /// <summary>
+    /// Enqueues a guild ID.
+    /// </summary>
+    /// <param name="guildId">The guild ID.</param>
+    public void Enqueue(ulong guildId)
+    {
+        _queue.Enqueue(guildId);
+    }
+
+    /// <summary>
+    /// Tries to dequeue a guild ID.
+    /// </summary>
+    /// <param name="guildId">The guild ID, only valid is true is returned.</param>
+    /// <returns>If an ID could be dequeued.</returns>
+    public bool TryDequeue(out ulong guildId)
+    {
+        return _queue.TryDequeue(out guildId);
+    }
+}

SahneeBot/GuildChangelogQueue.cs

@@ -0,0 +1,59 @@
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Logging;
+using SahneeBotController.Tasks.Changelog;
+
+namespace SahneeBot.Jobs;
+
+/// <summary>
+/// This job sends changelogs to guilds that do not have them yet in regular intervals.
+/// </summary>
+[Job]
+public sealed class SendChangelogsJob : JobBase {
+    private readonly ILogger<SendChangelogsJob> _logger;
+    private readonly GuildChangelogQueue _queue;
+    private readonly Bot _bot;
+    private readonly UpdateGuildChangelogTask _updateGuildChangelogTask;
+    private readonly uint _maxChangelogsSendCount;
+
+    public SendChangelogsJob(IServiceProvider serviceProvider
+        , ILogger<SendChangelogsJob> logger
+        , GuildChangelogQueue queue
+        , IConfiguration cfg
+        , Bot bot
+        , UpdateGuildChangelogTask updateGuildChangelogTask) : base(serviceProvider) {
+        _logger = logger;
+        _queue = queue;
+        _bot = bot;
+        _updateGuildChangelogTask = updateGuildChangelogTask;
+        _maxChangelogsSendCount = uint.Parse(cfg["BotSettings:MaxChangelogsSendCount"]);
+        Time = new JobTimeSpanRepeat(TimeSpan.Parse(cfg["BotSettings:Jobs:UpdateGuildChangelog"]));
+    }
+
+    public override async Task Perform() {
+        _logger.LogDebug(EventIds.Jobs, "Starting changelogs job");
+        
+        uint sentChangelogs = 0;
+        while (sentChangelogs < _maxChangelogsSendCount && _queue.TryDequeue(out var guildId))
+        {
+            var guild = await _bot.Client.GetGuildAsync(guildId);
+            if (guild == null)
+            {
+                _logger.LogWarning(EventIds.Jobs, "Tried to update changelogs of guild {Guild}, but it was null", guildId);
+                continue;
+            }
+            sentChangelogs++;
+            
+            // try to send new changelogs for each guild
+            await PerformAsync(
+                async ctx => await _updateGuildChangelogTask
+                    .Execute(ctx, new UpdateGuildChangelogTask.Args(guild.Id))
+                , new JobExecutionOptions {
+                PlaceInQueue = guild.Id
+                , RelatedGuildId = guild.Id
+                , Name = "send new changelogs"
+                , Debug = guild.Id.ToString()
+            });
+        }
+        _logger.LogInformation(EventIds.Jobs, "Finished sending changelogs. {Sent} changelogs were sent", sentChangelogs);
+    }
+}