DiscordSink: Add bot owner pings for bad exceptions

Author: Erisa

Commands/Debug.cs

@@ -615,6 +615,29 @@ public async Task SearchMembersCmd(CommandContext ctx, string regex)
                 await ctx.Channel.SendMessageAsync(await StringHelpers.CodeOrHasteBinAsync(JsonConvert.SerializeObject(memberIdsTonames, Formatting.Indented), "json"));
             }
 
+            [Command("testnre")]
+            [Description("throw a System.NullReferenceException error. dont spam this please.")]
+            [IsBotOwner]
+            public async Task ThrowNRE(CommandContext ctx, bool catchAsWarning = false)
+            {
+                if (catchAsWarning)
+                {
+                    try
+                    {
+                        throw new NullReferenceException();
+                    }
+                    catch (NullReferenceException e)
+                    {
+                        ctx.Client.Logger.LogWarning(e, "logging test NRE as warning");
+                        await ctx.RespondAsync("thrown NRE and logged as warning, check logs");
+                    }
+                }
+                else
+                {
+                    throw new NullReferenceException();
+                }
+            }
+
             private static async Task<(bool success, ulong failedOverwrite)> ImportOverridesFromChannelAsync(DiscordChannel channel)
             {
                 // Imports overrides from the specified channel to the database. See 'debug overrides import' and 'debug overrides importall'

Helpers/DiscordSink.cs

@@ -39,19 +39,40 @@ public async void Emit(LogEvent logEvent)
                         return;
                     }
 
-                    if (dummyWriter.ToString().Length > 1984 && dummyWriter.ToString().Length < 4096)
+                    string extraText = "";
+
+                    if (
+                        Program.cfgjson.PingBotOwnersOnBadErrors &&
+                        logEvent.Level >= LogEventLevel.Error &&
+                        logEvent.Exception is not null &&
+                            (
+                                logEvent.Exception.GetType() == typeof(NullReferenceException) ||
+                                logEvent.Exception.GetType() == typeof(RedisTimeoutException)
+                            )
+                        )
+                    {
+                        var pingList = Program.cfgjson.BotOwners.Select(x => $"<@{x}>").ToList();
+                        extraText = string.Join(", ", pingList);
+                    }
+
+                    if (dummyWriter.ToString().Length > (1984 - extraText.Length) && dummyWriter.ToString().Length < (4096 - extraText.Length))
                     {
-                        LogChannelHelper.LogMessageAsync("errors", new DiscordEmbedBuilder().WithDescription($"```cs\n{dummyWriter}\n```"));
+                        LogChannelHelper.LogMessageAsync("errors", new DiscordMessageBuilder().AddEmbed(new DiscordEmbedBuilder().WithDescription($"{extraText}\n```cs\n{dummyWriter}\n```")).WithAllowedMentions(Mentions.All));
 
                     }
-                    else if (dummyWriter.ToString().Length < 1984)
+                    else if (dummyWriter.ToString().Length < (1984 - extraText.Length))
                     {
-                        LogChannelHelper.LogMessageAsync("errors", $"```cs\n{dummyWriter}\n```");
+                        LogChannelHelper.LogMessageAsync("errors", new DiscordMessageBuilder().WithContent($"{extraText}\n```cs\n{dummyWriter}\n```").WithAllowedMentions(Mentions.All));
                     }
                     else
                     {
                         var stream = new MemoryStream(Encoding.UTF8.GetBytes(dummyWriter.ToString()));
-                        LogChannelHelper.LogMessageAsync("errors", new DiscordMessageBuilder().AddFile("error.txt", stream));
+                        var resp = new DiscordMessageBuilder().AddFile("error.txt", stream).WithAllowedMentions(Mentions.All);
+                        if (extraText.Length > 0)
+                        {
+                            resp.WithContent(extraText);
+                        }
+                        LogChannelHelper.LogMessageAsync("errors", resp);
                     }
                 }
                 catch

Structs.cs

@@ -321,6 +321,9 @@ public ulong InsidersChannel
 
         [JsonProperty("mentionTrackExcludedChannels")]
         public List<ulong> MentionTrackExcludedChannels { get; private set; } = new();
+
+        [JsonProperty("pingBotOwnersOnBadErrors")]
+        public bool PingBotOwnersOnBadErrors { get; private set; } = false;
     }
 
     public enum Level { Information, Warning, Error, Debug, Verbose }

config.json

@@ -296,8 +296,7 @@
   },
   "botOwners": [
     228574821590499329,
-    455432936339144705,
-    159016432498114560
+    455432936339144705
   ],
   "ignoredVoiceChannels": [
     922260379470548992
@@ -342,5 +341,6 @@
     883400305679663156,
     593381041629298688,
     450181490345508884
-  ]
+  ],
+  "pingBotOwnersOnBadErrors": true
 }