Merge pull request #1033 from discord-csharp/1032

Start V3, refactor code paste service

Author: patrickklaeren

.editorconfig

@@ -76,7 +76,7 @@ dotnet_naming_style.interface_style.capitalization = pascal_case
 dotnet_naming_style.interface_style.required_prefix = I
 
 # Async methods are suffixed with Async
-dotnet_naming_rule.async_methods_should_be_suffixed.severity = warning
+dotnet_naming_rule.async_methods_should_be_suffixed.severity = none
 dotnet_naming_rule.async_methods_should_be_suffixed.symbols = async_methods
 dotnet_naming_rule.async_methods_should_be_suffixed.style = async_method_style
 

src/Modix.Bot/Modules/IlModule.cs

@@ -7,8 +7,8 @@
 using Discord.Commands;
 using Microsoft.Extensions.Options;
 using Modix.Data.Models.Core;
+using Modix.Services;
 using Modix.Services.AutoRemoveMessage;
-using Modix.Services.CodePaste;
 using Modix.Services.CommandHelp;
 using Modix.Services.Utilities;
 using Serilog;
@@ -22,12 +22,12 @@ public class IlModule : ModuleBase
     {
         private const string DefaultIlRemoteUrl = "http://csdiscord-repl-service:31337/Il";
         private readonly string _ilUrl;
-        private readonly CodePasteService _pasteService;
+        private readonly PasteService _pasteService;
         private readonly IAutoRemoveMessageService _autoRemoveMessageService;
         private readonly IHttpClientFactory _httpClientFactory;
 
         public IlModule(
-            CodePasteService pasteService,
+            PasteService pasteService,
             IAutoRemoveMessageService autoRemoveMessageService,
             IHttpClientFactory httpClientFactory,
             IOptions<ModixConfig> modixConfig)
@@ -118,10 +118,12 @@ private async Task<EmbedBuilder> BuildEmbedAsync(IGuildUser guildUser, string co
 
             embed.AddField(a => a.WithName("Code").WithValue(Format.Code(code, "cs")));
 
+            const int MAX_LENGTH = 990;
+
             embed.AddField(a => a.WithName($"Result:")
-                 .WithValue(Format.Code(result.TruncateTo(990), "asm")));
+                 .WithValue(Format.Code(result.TruncateTo(MAX_LENGTH), "asm")));
 
-            await embed.UploadToServiceIfBiggerThan(result, 990, _pasteService);
+            await embed.UploadToServiceIfBiggerThan(result, MAX_LENGTH, _pasteService);
 
             return embed;
         }

src/Modix.Bot/Modules/ReplModule.cs

@@ -8,8 +8,8 @@
 using Discord.Commands;
 using Microsoft.Extensions.Options;
 using Modix.Data.Models.Core;
+using Modix.Services;
 using Modix.Services.AutoRemoveMessage;
-using Modix.Services.CodePaste;
 using Modix.Services.CommandHelp;
 using Modix.Services.Utilities;
 using Newtonsoft.Json;
@@ -36,12 +36,12 @@ public class ReplModule : ModuleBase
         private const int MaxFormattedFieldSize = 1000;
         private const string DefaultReplRemoteUrl = "http://csdiscord-repl-service:31337/Eval";
         private readonly string _replUrl;
-        private readonly CodePasteService _pasteService;
+        private readonly PasteService _pasteService;
         private readonly IAutoRemoveMessageService _autoRemoveMessageService;
         private readonly IHttpClientFactory _httpClientFactory;
 
         public ReplModule(
-            CodePasteService pasteService,
+            PasteService pasteService,
             IAutoRemoveMessageService autoRemoveMessageService,
             IHttpClientFactory httpClientFactory,
             IOptions<ModixConfig> modixConfig)

src/Modix.Services/CodePaste/CodePasteService.cs

@@ -0,0 +1,39 @@
+#nullable enable
+using System.Net.Http;
+using System.Threading.Tasks;
+using Microsoft.Extensions.Logging;
+using Modix.Services.Utilities;
+using Newtonsoft.Json.Linq;
+
+namespace Modix.Services;
+
+public class PasteService(IHttpClientFactory httpClientFactory, ILogger<PasteService> logger)
+{
+    private const string PASTE_URL = "https://paste.mod.gg/";
+
+    public async Task<string?> UploadPaste(string textToUpload)
+    {
+        var content = FormatUtilities.BuildContent(textToUpload);
+
+        var client = httpClientFactory.CreateClient(HttpClientNames.TimeoutFiveSeconds);
+
+        var response = await client.PostAsync($"{PASTE_URL}documents", content);
+
+        if (!response.IsSuccessStatusCode)
+        {
+            var body = await response.Content.ReadAsStringAsync();
+
+            logger.LogError("Failed uploading paste to {Url}, failed with response {ResponseCode}, with body: {Body}",
+                PASTE_URL,
+                response.StatusCode,
+                body);
+
+            return null;
+        }
+
+        var urlResponse = await response.Content.ReadAsStringAsync();
+        var pasteKey = JObject.Parse(urlResponse)["key"]?.Value<string>();
+
+        return $"{PASTE_URL}{pasteKey}";
+    }
+}

src/Modix.Services/CodePaste/CodePasteSetup.cs

@@ -4,7 +4,6 @@
 using System.Threading.Tasks;
 using Discord;
 using Discord.Webhook;
-using Modix.Services.CodePaste;
 using Newtonsoft.Json;
 using Serilog;
 using Serilog.Configuration;
@@ -15,7 +14,7 @@ namespace Modix.Services.Utilities;
 
 public sealed class DiscordWebhookSink : ILogEventSink, IAsyncDisposable
 {
-    private readonly Lazy<CodePasteService> _codePasteService;
+    private readonly Lazy<PasteService> _codePasteService;
     private readonly DiscordWebhookClient _discordWebhookClient;
     private readonly IFormatProvider _formatProvider;
     private readonly JsonSerializerSettings _jsonSerializerSettings;
@@ -27,7 +26,7 @@ public DiscordWebhookSink(
         ulong webhookId,
         string webhookToken,
         IFormatProvider formatProvider,
-        Lazy<CodePasteService> codePasteService)
+        Lazy<PasteService> codePasteService)
     {
         _codePasteService = codePasteService;
         _discordWebhookClient = new DiscordWebhookClient(webhookId, webhookToken);
@@ -75,12 +74,15 @@ public async Task ProcessLogEventItemsAsync()
 
                     var eventAsJson = JsonConvert.SerializeObject(logEvent, _jsonSerializerSettings);
 
-                    var url = await _codePasteService.Value.UploadCodeAsync(eventAsJson);
+                    var url = await _codePasteService.Value.UploadPaste(eventAsJson);
 
-                    message.AddField(new EmbedFieldBuilder()
-                        .WithIsInline(false)
-                        .WithName("Full Log Event")
-                        .WithValue($"[view on paste.mod.gg]({url})"));
+                    if (!string.IsNullOrWhiteSpace(url))
+                    {
+                        message.AddField(new EmbedFieldBuilder()
+                            .WithIsInline(false)
+                            .WithName("Full Log Event")
+                            .WithValue($"[view on paste.mod.gg]({url})"));
+                    }
                 }
                 catch (Exception ex)
                 {
@@ -121,7 +123,7 @@ public async ValueTask DisposeAsync()
 
 public static class DiscordWebhookSinkExtensions
 {
-    public static LoggerConfiguration DiscordWebhookSink(this LoggerSinkConfiguration config, ulong id, string token, LogEventLevel minLevel, Lazy<CodePasteService> codePasteService)
+    public static LoggerConfiguration DiscordWebhookSink(this LoggerSinkConfiguration config, ulong id, string token, LogEventLevel minLevel, Lazy<PasteService> codePasteService)
         => config.Sink(new DiscordWebhookSink(id, token, null, codePasteService), minLevel);
 }
 

src/Modix.Services/PasteService.cs

@@ -8,14 +8,10 @@
 using System.Text;
 using System.Text.RegularExpressions;
 using System.Threading.Tasks;
-
 using Discord;
-
 using Humanizer;
 using Humanizer.Localisation;
-
 using Modix.Data.Models.Moderation;
-using Modix.Services.CodePaste;
 
 namespace Modix.Services.Utilities
 {
@@ -38,18 +34,16 @@ public static string StripFormatting(string code) =>
             //strip out the ` characters and code block markers
             _buildContentRegex.Replace(code.Trim(), string.Empty);
 
-        public static async Task UploadToServiceIfBiggerThan(this EmbedBuilder embed, string content, uint size, CodePasteService service)
+        public static async Task UploadToServiceIfBiggerThan(this EmbedBuilder embed, string content, uint size,
+            PasteService service)
         {
             if (content.Length > size)
             {
-                try
-                {
-                    var resultLink = await service.UploadCodeAsync(content);
-                    embed.AddField(a => a.WithName("More...").WithValue($"[View on Hastebin]({resultLink})"));
-                }
-                catch (WebException we)
+                var resultLink = await service.UploadPaste(content);
+
+                if (!string.IsNullOrWhiteSpace(resultLink))
                 {
-                    embed.AddField(a => a.WithName("More...").WithValue(we.Message));
+                    embed.AddField(a => a.WithName("More...").WithValue($"[View on paste.mod.gg]({resultLink})"));
                 }
             }
         }
@@ -87,7 +81,8 @@ public static IReadOnlyCollection<string> CollapsePlurals(IReadOnlyCollection<st
                 Value: x
             ));
 
-            var groupedBySingulars = withSingulars.GroupBy(x => x.Singular, x => x.Value, new SequenceEqualityComparer<string>());
+            var groupedBySingulars =
+                withSingulars.GroupBy(x => x.Singular, x => x.Value, new SequenceEqualityComparer<string>());
 
             var withDistinctParts = new HashSet<string>[groupedBySingulars.Count()][];
 
@@ -129,7 +124,8 @@ public static IReadOnlyCollection<string> CollapsePlurals(IReadOnlyCollection<st
                             ? word.First()
                             : word.Last();
 
-                        parenthesized[aliasIndex][wordIndex] = $"{longestForm[..indexOfDifference]}({longestForm[indexOfDifference..]})";
+                        parenthesized[aliasIndex][wordIndex] =
+                            $"{longestForm[..indexOfDifference]}({longestForm[indexOfDifference..]})";
                     }
                     else
                     {
@@ -202,6 +198,7 @@ public static string FormatCodeForEmbed(string language, string sourceCode, int
                             AddRemainingLineComment();
                             break;
                         }
+
                         braceOnlyLinesEliminated++;
                     }
                     else if (!TryAddLine(line))
@@ -244,11 +241,13 @@ public static string FormatCodeForEmbed(string language, string sourceCode, int
             bool TryAddLine(string line)
             {
                 var remainingCount = GetRemainingLineCount();
-                var possibleRemainingLineCommentLength = remainingCount > 1 // 1, because the current line is included in the count
-                    ? GetRemainingLineCountComment(remainingCount).Length
-                    : 0;
+                var possibleRemainingLineCommentLength =
+                    remainingCount > 1 // 1, because the current line is included in the count
+                        ? GetRemainingLineCountComment(remainingCount).Length
+                        : 0;
 
-                if (line.Length + currentLength + possibleRemainingLineCommentLength + 1 > maxLength) // +1 because of the newline that will be added later
+                if (line.Length + currentLength + possibleRemainingLineCommentLength + 1 >
+                    maxLength) // +1 because of the newline that will be added later
                     return false;
 
                 processedLines.Add(line);

src/Modix.Services/Utilities/DiscordWebhookSink.cs

@@ -22,7 +22,6 @@
 using Modix.Data.Repositories;
 using Modix.Services;
 using Modix.Services.AutoRemoveMessage;
-using Modix.Services.CodePaste;
 using Modix.Services.CommandHelp;
 using Modix.Services.Core;
 using Modix.Services.Csharp;
@@ -157,7 +156,6 @@ public static IServiceCollection AddModix(
                 .AddModixCore()
                 .AddModixModeration()
                 .AddModixPromotions()
-                .AddCodePaste()
                 .AddCommandHelp()
                 .AddGuildStats()
                 .AddModixTags()
@@ -166,6 +164,8 @@ public static IServiceCollection AddModix(
                 .AddEmojiStats()
                 .AddImages();
 
+            services.AddScoped<PasteService>();
+
             services.AddScoped<IQuoteService, QuoteService>();
             services.AddSingleton<IBehavior, MessageLinkBehavior>();
             services.AddMemoryCache();

src/Modix.Services/Utilities/FormatUtilities.cs

@@ -17,7 +17,7 @@
 using Modix.Configuration;
 using Modix.Data;
 using Modix.Data.Models.Core;
-using Modix.Services.CodePaste;
+using Modix.Services;
 using Modix.Services.Utilities;
 using Modix.Web;
 using Newtonsoft.Json.Converters;
@@ -106,7 +106,7 @@ private static void ConfigureServices(WebApplicationBuilder builder, IConfigurat
                 if (webhookId.HasValue && webhookToken != null)
                 {
                     lc
-                        .WriteTo.DiscordWebhookSink(webhookId.Value, webhookToken, LogEventLevel.Error, new Lazy<CodePasteService>(sp.GetRequiredService<CodePasteService>));
+                        .WriteTo.DiscordWebhookSink(webhookId.Value, webhookToken, LogEventLevel.Error, new Lazy<PasteService>(sp.GetRequiredService<PasteService>));
                 }
             });