Added: Hints to error messages

Patrick Sachs · Patrick Sachs · commit 691faf8acc1c · 2022-04-29T22:11:25.000+02:00
diff --git a/SahneeBot/Events/CommandEvent.cs b/SahneeBot/Events/CommandEvent.cs
@@ -61,6 +61,7 @@ public override Task Handle(IGuild arg) => HandleAsync(async ctx =>
             {
                 Exception = exception
                 , GuildId = arg.Id
+                , Hint = "Your bot is not allowed to create slash commands on your server. Please ensure that you use the official invite link or contact our support."
             });
             if (error != null)
             {
diff --git a/SahneeBot/Events/WelcomeMessageEvent.cs b/SahneeBot/Events/WelcomeMessageEvent.cs
@@ -51,7 +51,9 @@ await _welcomeOnNewGuildJoinDiscordFormatter.FormatAndSend(
         {
             var error = await _discordError.TryGetError<bool>(ctx, new SahneeBotDiscordError.ErrorOptions
             {
-                Exception = exception, GuildId = arg.Id
+                Exception = exception
+                , GuildId = arg.Id
+                , Hint = $"The bot does not have permissions to post its welcome message in the channel {channel.Mention}. If you do not want to grant it permissions to this channel please bind it to one of your other channels using `/config bind <channel>`."
             });
             if (error != null)
             {
diff --git a/SahneeBot/SahneeBotDiscordError.cs b/SahneeBot/SahneeBotDiscordError.cs
@@ -39,6 +39,11 @@ public struct ErrorOptions
         /// The exception.
         /// </summary>
         public Exception Exception { get; init; }
+        
+        /// <summary>
+        /// A hint to what happened.
+        /// </summary>
+        public string? Hint { get; init; }
     }
 
     /// <summary>
@@ -74,19 +79,19 @@ public struct ErrorOptions
             case HttpException {DiscordCode: DiscordErrorCode.InsufficientPermissions}:
             {
                 var prefix = await GetGuildPrefix(ctx, options.GuildId);
-                return GetMissingRolePermissionsError<T>(prefix);
+                return GetMissingRolePermissionsError<T>(prefix, options.Hint);
             }
             // Bot cannot manage roles
             case HttpException {HttpCode: HttpStatusCode.Forbidden}:
             {
                 var prefix = await GetGuildPrefix(ctx, options.GuildId);
-                return GetMissingRolePermissionsError<T>(prefix);
+                return GetMissingRolePermissionsError<T>(prefix, options.Hint);
             }
             // Missing intent when invited
             case HttpException {DiscordCode: DiscordErrorCode.MissingPermissions}:
             {
                 var prefix = await GetGuildPrefix(ctx, options.GuildId);
-                return GetMissingRolePermissionsError<T>(prefix);
+                return GetMissingRolePermissionsError<T>(prefix, options.Hint);
             }
             default:
             {
@@ -103,10 +108,11 @@ private async Task<string> GetGuildPrefix(ITaskContext ctx, ulong? guildId)
         return guildState?.WarningRolePrefix.Trim() ?? "n/a";
     }
     
-    private ISuccess<T> GetMissingRolePermissionsError<T>(string prefix)
+    private ISuccess<T> GetMissingRolePermissionsError<T>(string prefix, string? hint)
     {
         var inviteUrl = _cfg["BotSettings:InviteUrl"];
         return new Error<T>("The Sahnee-Bot does not have enough permissions on your server.\n" +
+                            (string.IsNullOrEmpty(hint) ? "" : ("**Hint:** " + hint + "\n")) + 
                             "-----------------\n" +
                             "Please drag the Sahnee-Bot role above all other roles starting with " +
                             $"\"{prefix.TrimEnd()}\" in your Server Settings and make sure that it has the \"Manage " +
diff --git a/SahneeBot/Tasks/SahneeBotChangeWarningRoleNameTask.cs b/SahneeBot/Tasks/SahneeBotChangeWarningRoleNameTask.cs
@@ -56,8 +56,9 @@ public override async Task<ISuccess<string>> Execute(ITaskContext ctx, Args args
         {
             var error = await _discordError.TryGetError<string>(ctx, new SahneeBotDiscordError.ErrorOptions
             {
-                Exception = exception,
-                GuildId = args.GuildId
+                Exception = exception
+                , GuildId = args.GuildId
+                , Hint = $"The bot could not rename the roles from `{oldPrefix}` to `{args.WarningRolePrefix}`. Please ensure that you use the official invite link and drag the Sahnee-Bot **above** all warning roles in your Server Settings. If that does not help, please contact our support."
             });
             if (error != null)
             {
diff --git a/SahneeBot/Tasks/SahneeBotCleanupWarningRolesTask.cs b/SahneeBot/Tasks/SahneeBotCleanupWarningRolesTask.cs
@@ -94,8 +94,9 @@ public async Task<ISuccess<uint>> Execute(ITaskContext ctx, Args arg)
             {
                 error = await _discordError.TryGetError<uint>(ctx, new SahneeBotDiscordError.ErrorOptions
                 {
-                    Exception = exception,
-                    GuildId = guildId
+                    Exception = exception
+                    , GuildId = guildId
+                    , Hint = $"The bot could not delete the unused warning role {notNeededRole.Mention}. Please ensure that you use the official invite link and drag the Sahnee-Bot **above** all warning roles in your Server Settings. If that does not help, please contact our support."
                 });
                 if (error == null)
                 {
diff --git a/SahneeBot/Tasks/SahneeBotGuildChangeRoleColorTask.cs b/SahneeBot/Tasks/SahneeBotGuildChangeRoleColorTask.cs
@@ -66,8 +66,9 @@ public override async Task<ISuccess<string>> Execute(ITaskContext ctx, Args arg)
         {
             var error = await _discordError.TryGetError<string>(ctx, new SahneeBotDiscordError.ErrorOptions
             {
-                Exception = exception,
-                GuildId = arg.GuildId
+                Exception = exception
+                , GuildId = arg.GuildId
+                , Hint = $"The bot could not change the color of your warning roles to `{customColor}`. Please ensure that you use the official invite link and drag the Sahnee-Bot **above** all warning roles in your Server Settings. If that does not help, please contact our support."
             });
             if (error != null)
             {
diff --git a/SahneeBot/Tasks/SahneeBotModifyUserWarningRoleTask.cs b/SahneeBot/Tasks/SahneeBotModifyUserWarningRoleTask.cs
@@ -92,8 +92,9 @@ public override async Task<ISuccess<ulong>> Execute(ITaskContext ctx, Args args)
             }
             var error = await _discordError.TryGetError<ulong>(ctx, new SahneeBotDiscordError.ErrorOptions
             {
-                Exception = exception,
-                GuildId = args.GuildId
+                Exception = exception
+                , GuildId = args.GuildId
+                , Hint = $"Could not remove the old warning role of {currentGuildUser.Mention}. Please ensure that you use the official invite link and drag the Sahnee-Bot **above** all warning roles in your Server Settings. If that does not help, please contact our support."
             });
             if (error != null)
             {
@@ -122,9 +123,8 @@ public override async Task<ISuccess<ulong>> Execute(ITaskContext ctx, Args args)
                     roleColor = new Color(rgb.R, rgb.G, rgb.B);
                 }
                 // Create the new role
-                newRole = await currentGuild
-                    .CreateRoleAsync(newRoleName, default,
-                        roleColor, false, null);
+                newRole = await currentGuild.CreateRoleAsync(newRoleName, default
+                                                             , roleColor, false, null);
                 // Add the new role to the guild
                 await currentGuildUser.AddRoleAsync(newRole);
                 await _checkRoleLimitTask.Execute(ctx, new CheckRoleLimitTask.Args(currentGuild.Id));
@@ -138,8 +138,9 @@ public override async Task<ISuccess<ulong>> Execute(ITaskContext ctx, Args args)
                 await removeRolesCommand.Undo();
                 var error = await _discordError.TryGetError<ulong>(ctx, new SahneeBotDiscordError.ErrorOptions
                 {
-                    Exception = exception,
-                    GuildId = args.GuildId
+                    Exception = exception
+                    , GuildId = args.GuildId
+                    , Hint = $"Could not create the new warning role for {currentGuildUser.Mention}. Please ensure that you use the official invite link and drag the Sahnee-Bot **above** all warning roles in your Server Settings. If that does not help, please contact our support."
                 });
                 if (error != null)
                 {
@@ -164,8 +165,9 @@ public override async Task<ISuccess<ulong>> Execute(ITaskContext ctx, Args args)
             await removeRolesCommand.Undo();
             var error = await _discordError.TryGetError<ulong>(ctx, new SahneeBotDiscordError.ErrorOptions
             {
-                Exception = exception,
-                GuildId = args.GuildId
+                Exception = exception
+                , GuildId = args.GuildId
+                , Hint = $"Could not assign the the warning role to {currentGuildUser.Mention}. Please ensure that you use the official invite link and drag the Sahnee-Bot **above** all warning roles in your Server Settings. If that does not help, please contact our support."
             });
             if (error != null)
             {
diff --git a/SahneeBot/Tasks/SahneeBotPostChangelogsToGuildTask.cs b/SahneeBot/Tasks/SahneeBotPostChangelogsToGuildTask.cs
@@ -69,6 +69,7 @@ public override async Task<ISuccess<uint>> Execute(ITaskContext ctx, Args arg)
                                                               , new SahneeBotDiscordError.ErrorOptions {
                                                                   Exception = exception
                                                                   , GuildId = guildId
+                                                                  , Hint = $"Could not post a message in the channel {channel.Mention}."
                                                               });
             if (error != null)
             {

Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,7 @@ public override Task Handle(IGuild arg) => HandleAsync(async ctx =>`
`61`	`61`	`{`
`62`	`62`	`Exception = exception`
`63`	`63`	`, GuildId = arg.Id`
	`64`	`+ , Hint = "Your bot is not allowed to create slash commands on your server. Please ensure that you use the official invite link or contact our support."`
`64`	`65`	`});`
`65`	`66`	`if (error != null)`
`66`	`67`	`{`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,9 @@ await _welcomeOnNewGuildJoinDiscordFormatter.FormatAndSend(`
`51`	`51`	`{`
`52`	`52`	`var error = await _discordError.TryGetError<bool>(ctx, new SahneeBotDiscordError.ErrorOptions`
`53`	`53`	`{`
`54`		`- Exception = exception, GuildId = arg.Id`
	`54`	`+ Exception = exception`
	`55`	`+ , GuildId = arg.Id`
	`56`	+ , Hint = $"The bot does not have permissions to post its welcome message in the channel {channel.Mention}. If you do not want to grant it permissions to this channel please bind it to one of your other channels using `/config bind <channel>`."
`55`	`57`	`});`
`56`	`58`	`if (error != null)`
`57`	`59`	`{`
Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,11 @@ public struct ErrorOptions`
`39`	`39`	`/// The exception.`
`40`	`40`	`/// </summary>`
`41`	`41`	`public Exception Exception { get; init; }`
	`42`	`+`
	`43`	`+ /// <summary>`
	`44`	`+ /// A hint to what happened.`
	`45`	`+ /// </summary>`
	`46`	`+ public string? Hint { get; init; }`
`42`	`47`	`}`
`43`	`48`
`44`	`49`	`/// <summary>`
`@@ -74,19 +79,19 @@ public struct ErrorOptions`
`74`	`79`	`case HttpException {DiscordCode: DiscordErrorCode.InsufficientPermissions}:`
`75`	`80`	`{`
`76`	`81`	`var prefix = await GetGuildPrefix(ctx, options.GuildId);`
`77`		`- return GetMissingRolePermissionsError<T>(prefix);`
	`82`	`+ return GetMissingRolePermissionsError<T>(prefix, options.Hint);`
`78`	`83`	`}`
`79`	`84`	`// Bot cannot manage roles`
`80`	`85`	`case HttpException {HttpCode: HttpStatusCode.Forbidden}:`
`81`	`86`	`{`
`82`	`87`	`var prefix = await GetGuildPrefix(ctx, options.GuildId);`
`83`		`- return GetMissingRolePermissionsError<T>(prefix);`
	`88`	`+ return GetMissingRolePermissionsError<T>(prefix, options.Hint);`
`84`	`89`	`}`
`85`	`90`	`// Missing intent when invited`
`86`	`91`	`case HttpException {DiscordCode: DiscordErrorCode.MissingPermissions}:`
`87`	`92`	`{`
`88`	`93`	`var prefix = await GetGuildPrefix(ctx, options.GuildId);`
`89`		`- return GetMissingRolePermissionsError<T>(prefix);`
	`94`	`+ return GetMissingRolePermissionsError<T>(prefix, options.Hint);`
`90`	`95`	`}`
`91`	`96`	`default:`
`92`	`97`	`{`
`@@ -103,10 +108,11 @@ private async Task<string> GetGuildPrefix(ITaskContext ctx, ulong? guildId)`
`103`	`108`	`return guildState?.WarningRolePrefix.Trim() ?? "n/a";`
`104`	`109`	`}`
`105`	`110`
`106`		`- private ISuccess<T> GetMissingRolePermissionsError<T>(string prefix)`
	`111`	`+ private ISuccess<T> GetMissingRolePermissionsError<T>(string prefix, string? hint)`
`107`	`112`	`{`
`108`	`113`	`var inviteUrl = _cfg["BotSettings:InviteUrl"];`
`109`	`114`	`return new Error<T>("The Sahnee-Bot does not have enough permissions on your server.\n" +`
	`115`	`+ (string.IsNullOrEmpty(hint) ? "" : ("Hint: " + hint + "\n")) +`
`110`	`116`	`"-----------------\n" +`
`111`	`117`	`"Please drag the Sahnee-Bot role above all other roles starting with " +`
`112`	`118`	`$"\"{prefix.TrimEnd()}\" in your Server Settings and make sure that it has the \"Manage " +`
Original file line number	Diff line number	Diff line change
`@@ -56,8 +56,9 @@ public override async Task<ISuccess<string>> Execute(ITaskContext ctx, Args args`
`56`	`56`	`{`
`57`	`57`	`var error = await _discordError.TryGetError<string>(ctx, new SahneeBotDiscordError.ErrorOptions`
`58`	`58`	`{`
`59`		`- Exception = exception,`
`60`		`- GuildId = args.GuildId`
	`59`	`+ Exception = exception`
	`60`	`+ , GuildId = args.GuildId`
	`61`	+ , Hint = $"The bot could not rename the roles from `{oldPrefix}` to `{args.WarningRolePrefix}`. Please ensure that you use the official invite link and drag the Sahnee-Bot above all warning roles in your Server Settings. If that does not help, please contact our support."
`61`	`62`	`});`
`62`	`63`	`if (error != null)`
`63`	`64`	`{`
Original file line number	Diff line number	Diff line change
`@@ -94,8 +94,9 @@ public async Task<ISuccess<uint>> Execute(ITaskContext ctx, Args arg)`
`94`	`94`	`{`
`95`	`95`	`error = await _discordError.TryGetError<uint>(ctx, new SahneeBotDiscordError.ErrorOptions`
`96`	`96`	`{`
`97`		`- Exception = exception,`
`98`		`- GuildId = guildId`
	`97`	`+ Exception = exception`
	`98`	`+ , GuildId = guildId`
	`99`	`+ , Hint = $"The bot could not delete the unused warning role {notNeededRole.Mention}. Please ensure that you use the official invite link and drag the Sahnee-Bot above all warning roles in your Server Settings. If that does not help, please contact our support."`
`99`	`100`	`});`
`100`	`101`	`if (error == null)`
`101`	`102`	`{`
Original file line number	Diff line number	Diff line change
`@@ -66,8 +66,9 @@ public override async Task<ISuccess<string>> Execute(ITaskContext ctx, Args arg)`
`66`	`66`	`{`
`67`	`67`	`var error = await _discordError.TryGetError<string>(ctx, new SahneeBotDiscordError.ErrorOptions`
`68`	`68`	`{`
`69`		`- Exception = exception,`
`70`		`- GuildId = arg.GuildId`
	`69`	`+ Exception = exception`
	`70`	`+ , GuildId = arg.GuildId`
	`71`	+ , Hint = $"The bot could not change the color of your warning roles to `{customColor}`. Please ensure that you use the official invite link and drag the Sahnee-Bot above all warning roles in your Server Settings. If that does not help, please contact our support."
`71`	`72`	`});`
`72`	`73`	`if (error != null)`
`73`	`74`	`{`
Original file line number	Diff line number	Diff line change
`@@ -69,6 +69,7 @@ public override async Task<ISuccess<uint>> Execute(ITaskContext ctx, Args arg)`
`69`	`69`	`, new SahneeBotDiscordError.ErrorOptions {`
`70`	`70`	`Exception = exception`
`71`	`71`	`, GuildId = guildId`
	`72`	`+ , Hint = $"Could not post a message in the channel {channel.Mention}."`
`72`	`73`	`});`
`73`	`74`	`if (error != null)`
`74`	`75`	`{`