Implement support for join raid and mention raid protection.

See discord/discord-api-docs#5778.
Remora · Jun 17, 2023 · b3eca74 · b3eca74
1 parent 8a2ece1
commit b3eca74
Show file tree

Hide file tree

Showing 23 changed files with 61 additions and 12 deletions.
diff --git a/...ora.Discord.API.Abstractions/API/Objects/AutoModeration/IAutoModerationTriggerMetadata.cs b/...ora.Discord.API.Abstractions/API/Objects/AutoModeration/IAutoModerationTriggerMetadata.cs
@@ -78,4 +78,9 @@ public interface IAutoModerationTriggerMetadata
     /// Max 50.
     /// </remarks>
     Optional<byte> MentionTotalLimit { get; }
+
+    /// <summary>
+    /// Gets a value indicating whether to automatically detect mention raids.
+    /// </summary>
+    Optional<bool> MentionRaidProtectionEnabled { get; }
 }
diff --git a/Backend/Remora.Discord.API.Abstractions/API/Objects/Guilds/GuildFeature.cs b/Backend/Remora.Discord.API.Abstractions/API/Objects/Guilds/GuildFeature.cs
@@ -125,6 +125,11 @@ public enum GuildFeature
     /// </summary>
     PreviewEnabled,
 
+    /// <summary>
+    /// The guild has disabled alerts for join raids in the configured safety alerts channel.
+    /// </summary>
+    RaidAlertsDisabled,
+
     /// <summary>
     /// The guild is able to set role icons.
     /// </summary>

diff --git a/Backend/Remora.Discord.API.Abstractions/API/Objects/Guilds/IGuild.cs b/Backend/Remora.Discord.API.Abstractions/API/Objects/Guilds/IGuild.cs
@@ -243,6 +243,11 @@ public interface IGuild : IPartialGuild
     /// </summary>
     new bool IsPremiumProgressBarEnabled { get; }
 
+    /// <summary>
+    /// Gets the ID of the channel where admins and moderators of Community guilds receive safety alerts from Discord.
+    /// </summary>
+    new Snowflake? SafetyAlertsChannelID { get; }
+
     /// <inheritdoc/>
     Optional<Snowflake> IPartialGuild.ID => this.ID;
 
@@ -365,4 +370,7 @@ public interface IGuild : IPartialGuild
 
     /// <inheritdoc/>
     Optional<bool> IPartialGuild.IsPremiumProgressBarEnabled => this.IsPremiumProgressBarEnabled;
+
+    /// <inheritdoc/>
+    Optional<Snowflake?> IPartialGuild.SafetyAlertsChannelID => this.SafetyAlertsChannelID;
 }
diff --git a/Backend/Remora.Discord.API.Abstractions/API/Objects/Guilds/IPartialGuild.cs b/Backend/Remora.Discord.API.Abstractions/API/Objects/Guilds/IPartialGuild.cs
@@ -155,4 +155,7 @@ public interface IPartialGuild
 
     /// <inheritdoc cref="IGuild.IsPremiumProgressBarEnabled"/>
     Optional<bool> IsPremiumProgressBarEnabled { get; }
+
+    /// <inheritdoc cref="IGuild.SafetyAlertsChannelID"/>
+    Optional<Snowflake?> SafetyAlertsChannelID { get; }
 }
diff --git a/Backend/Remora.Discord.API.Abstractions/API/Rest/IDiscordRestGuildAPI.cs b/Backend/Remora.Discord.API.Abstractions/API/Rest/IDiscordRestGuildAPI.cs
@@ -131,6 +131,9 @@ Task<Result<IGuildPreview>> GetGuildPreviewAsync
     /// <param name="features">The new guild features.</param>
     /// <param name="description">The new description.</param>
     /// <param name="isPremiumProgressBarEnabled">Whether the guild has the boost progress bar enabled.</param>
+    /// <param name="safetyAlertsChannelID">
+    /// The ID of the channel where admins and moderators of Community guilds receive safety alerts from Discord.
+    /// </param>
     /// <param name="reason">The reason to mark the action in the audit log with.</param>
     /// <param name="ct">The cancellation token for this operation.</param>
     /// <returns>A modification result which may or may not have succeeded.</returns>
@@ -156,6 +159,7 @@ Task<Result<IGuild>> ModifyGuildAsync
         Optional<IReadOnlyList<GuildFeature>> features = default,
         Optional<string?> description = default,
         Optional<bool> isPremiumProgressBarEnabled = default,
+        Optional<Snowflake?> safetyAlertsChannelID = default,
         Optional<string> reason = default,
         CancellationToken ct = default
     );

diff --git a/Backend/Remora.Discord.API/API/Gateway/Events/Guilds/GuildCreate.cs b/Backend/Remora.Discord.API/API/Gateway/Events/Guilds/GuildCreate.cs
@@ -79,6 +79,7 @@ public record AvailableGuild
         GuildNSFWLevel NSFWLevel,
         Optional<IReadOnlyList<ISticker>> Stickers,
         bool IsPremiumProgressBarEnabled,
+        Snowflake? SafetyAlertsChannelID,
         DateTimeOffset JoinedAt,
         bool IsLarge,
         Optional<bool> IsUnavailable,

diff --git a/Backend/Remora.Discord.API/API/Gateway/Events/Guilds/GuildUpdate.cs b/Backend/Remora.Discord.API/API/Gateway/Events/Guilds/GuildUpdate.cs
@@ -73,5 +73,6 @@ public record GuildUpdate
     Optional<IWelcomeScreen> WelcomeScreen,
     GuildNSFWLevel NSFWLevel,
     Optional<IReadOnlyList<ISticker>> Stickers,
-    bool IsPremiumProgressBarEnabled
+    bool IsPremiumProgressBarEnabled,
+    Snowflake? SafetyAlertsChannelID
 ) : IGuildUpdate;
diff --git a/Backend/Remora.Discord.API/API/Objects/AutoModeration/AutoModerationTriggerMetadata.cs b/Backend/Remora.Discord.API/API/Objects/AutoModeration/AutoModerationTriggerMetadata.cs
@@ -35,5 +35,6 @@ public record AutoModerationTriggerMetadata
     Optional<IReadOnlyList<string>> RegexPatterns = default,
     Optional<IReadOnlyList<AutoModerationKeywordPresetType>> Presets = default,
     Optional<IReadOnlyList<string>> AllowList = default,
-    Optional<byte> MentionTotalLimit = default
+    Optional<byte> MentionTotalLimit = default,
+    Optional<bool> MentionRaidProtectionEnabled = default
 ) : IAutoModerationTriggerMetadata;
diff --git a/Backend/Remora.Discord.API/API/Objects/Guilds/Guild.cs b/Backend/Remora.Discord.API/API/Objects/Guilds/Guild.cs
@@ -74,5 +74,6 @@ public record Guild
     Optional<IWelcomeScreen> WelcomeScreen,
     GuildNSFWLevel NSFWLevel,
     Optional<IReadOnlyList<ISticker>> Stickers,
-    bool IsPremiumProgressBarEnabled
+    bool IsPremiumProgressBarEnabled,
+    Snowflake? SafetyAlertsChannelID
 ) : IGuild;
diff --git a/Backend/Remora.Discord.API/API/Objects/Guilds/PartialGuild.cs b/Backend/Remora.Discord.API/API/Objects/Guilds/PartialGuild.cs
@@ -74,5 +74,6 @@ public record PartialGuild
     Optional<IWelcomeScreen> WelcomeScreen = default,
     Optional<GuildNSFWLevel> NSFWLevel = default,
     Optional<IReadOnlyList<ISticker>> Stickers = default,
-    Optional<bool> IsPremiumProgressBarEnabled = default
+    Optional<bool> IsPremiumProgressBarEnabled = default,
+    Optional<Snowflake?> SafetyAlertsChannelID = default
 ) : IPartialGuild;
diff --git a/Backend/Remora.Discord.Caching/API/CachingDiscordRestGuildAPI.cs b/Backend/Remora.Discord.Caching/API/CachingDiscordRestGuildAPI.cs
@@ -183,6 +183,7 @@ public async Task<Result<IGuild>> ModifyGuildAsync
         Optional<IReadOnlyList<GuildFeature>> features = default,
         Optional<string?> description = default,
         Optional<bool> isPremiumProgressBarEnabled = default,
+        Optional<Snowflake?> safetyAlertsChannelID = default,
         Optional<string> reason = default,
         CancellationToken ct = default
     )
@@ -209,6 +210,7 @@ public async Task<Result<IGuild>> ModifyGuildAsync
             features,
             description,
             isPremiumProgressBarEnabled,
+            safetyAlertsChannelID,
             reason,
             ct
         );

diff --git a/Backend/Remora.Discord.Rest/API/Guilds/DiscordRestGuildAPI.cs b/Backend/Remora.Discord.Rest/API/Guilds/DiscordRestGuildAPI.cs
@@ -191,6 +191,7 @@ public virtual async Task<Result<IGuild>> ModifyGuildAsync
         Optional<IReadOnlyList<GuildFeature>> features = default,
         Optional<string?> description = default,
         Optional<bool> isPremiumProgressBarEnabled = default,
+        Optional<Snowflake?> safetyAlertsChannelID = default,
         Optional<string> reason = default,
         CancellationToken ct = default
     )
@@ -263,6 +264,7 @@ public virtual async Task<Result<IGuild>> ModifyGuildAsync
                         json.Write("features", features, this.JsonOptions);
                         json.Write("description", description, this.JsonOptions);
                         json.Write("premium_progress_bar_enabled", isPremiumProgressBarEnabled, this.JsonOptions);
+                        json.Write("safety_alerts_channel_id", safetyAlertsChannelID, this.JsonOptions);
                     }
                 )
                 .WithRateLimitContext(this.RateLimitCache),

diff --git a/Tests/Remora.Discord.Rest.Tests/API/Guild/DiscordRestGuildAPITests.cs b/Tests/Remora.Discord.Rest.Tests/API/Guild/DiscordRestGuildAPITests.cs
@@ -346,6 +346,7 @@ public async Task PerformsRequestCorrectly()
             var features = Array.Empty<GuildFeature>();
             var description = "aaa";
             var isPremiumProgressBarEnabled = true;
+            var safetyAlertsChannel = DiscordSnowflake.New(5);
             var reason = "test";
 
             var api = CreateAPI
@@ -381,6 +382,7 @@ public async Task PerformsRequestCorrectly()
                                 .WithProperty("features", p => p.IsArray())
                                 .WithProperty("description", p => p.Is(description))
                                 .WithProperty("premium_progress_bar_enabled", p => p.Is(isPremiumProgressBarEnabled))
+                                .WithProperty("safety_alerts_channel_id", p => p.Is(safetyAlertsChannel.ToString()))
                         )
                     )
                     .Respond("application/json", SampleRepository.Samples[typeof(IGuild)])
@@ -408,6 +410,7 @@ public async Task PerformsRequestCorrectly()
                 features,
                 description,
                 isPremiumProgressBarEnabled,
+                safetyAlertsChannel,
                 reason
             );
 
@@ -436,6 +439,7 @@ public async Task PerformsNullableRequestCorrectly()
                                 .WithProperty("icon", p => p.IsNull())
                                 .WithProperty("splash", p => p.IsNull())
                                 .WithProperty("banner", p => p.IsNull())
+                                .WithProperty("safety_alerts_channel_id", p => p.IsNull())
                         )
                     )
                     .Respond("application/json", SampleRepository.Samples[typeof(IGuild)])
@@ -447,7 +451,8 @@ public async Task PerformsNullableRequestCorrectly()
                 name,
                 icon: null,
                 banner: null,
-                splash: null
+                splash: null,
+                safetyAlertsChannelID: null
             );
 
             ResultAssert.Successful(result);

diff --git a/Tests/Remora.Discord.Tests/Samples/Gateway/Events/GUILD_CREATE/GUILD_CREATE.json b/Tests/Remora.Discord.Tests/Samples/Gateway/Events/GUILD_CREATE/GUILD_CREATE.json
@@ -74,6 +74,7 @@
       }
     ],
     "premium_progress_bar_enabled": true,
+    "safety_alerts_channel_id": "999999999999999999",
     "joined_at": "1970-01-01T00:00:00.000000+00:00",
     "large": true,
     "unavailable": true,

diff --git a/Tests/Remora.Discord.Tests/Samples/Gateway/Events/GUILD_CREATE/GUILD_CREATE.nulls.json b/Tests/Remora.Discord.Tests/Samples/Gateway/Events/GUILD_CREATE/GUILD_CREATE.nulls.json
@@ -73,6 +73,7 @@
       }
     ],
     "premium_progress_bar_enabled": true,
+    "safety_alerts_channel_id": null,
     "joined_at": "1970-01-01T00:00:00.000000+00:00",
     "large": true,
     "unavailable": true,

diff --git a/Tests/Remora.Discord.Tests/Samples/Gateway/Events/GUILD_CREATE/GUILD_CREATE.optionals.json b/Tests/Remora.Discord.Tests/Samples/Gateway/Events/GUILD_CREATE/GUILD_CREATE.optionals.json
@@ -49,6 +49,7 @@
     "public_updates_channel_id": "999999999999999999",
     "nsfw_level": 0,
     "premium_progress_bar_enabled": true,
+    "safety_alerts_channel_id": "999999999999999999",
     "joined_at": "1970-01-01T00:00:00.000000+00:00",
     "large": true,
     "member_count": 1,

diff --git a/Tests/Remora.Discord.Tests/Samples/Gateway/Events/GUILD_UPDATE/GUILD_UPDATE.json b/Tests/Remora.Discord.Tests/Samples/Gateway/Events/GUILD_UPDATE/GUILD_UPDATE.json
@@ -73,6 +73,7 @@
         "format_type": 1
       }
     ],
-    "premium_progress_bar_enabled": true
+    "premium_progress_bar_enabled": true,
+    "safety_alerts_channel_id": "999999999999999999"
   }
 }
diff --git a/Tests/Remora.Discord.Tests/Samples/Gateway/Events/GUILD_UPDATE/GUILD_UPDATE.nulls.json b/Tests/Remora.Discord.Tests/Samples/Gateway/Events/GUILD_UPDATE/GUILD_UPDATE.nulls.json
@@ -72,6 +72,7 @@
         "format_type": 1
       }
     ],
-    "premium_progress_bar_enabled": true
+    "premium_progress_bar_enabled": true,
+    "safety_alerts_channel_id": null
   }
 }
diff --git a/Tests/Remora.Discord.Tests/Samples/Gateway/Events/GUILD_UPDATE/GUILD_UPDATE.optionals.json b/Tests/Remora.Discord.Tests/Samples/Gateway/Events/GUILD_UPDATE/GUILD_UPDATE.optionals.json
@@ -48,6 +48,7 @@
     "preferred_locale": "en-US",
     "public_updates_channel_id": "999999999999999999",
     "nsfw_level": 0,
-    "premium_progress_bar_enabled": true
+    "premium_progress_bar_enabled": true,
+    "safety_alerts_channel_id": "999999999999999999"
   }
 }
diff --git a/...ts/Samples/Objects/AUTO_MODERATION_TRIGGER_METADATA/AUTO_MODERATION_TRIGGER_METADATA.json b/...ts/Samples/Objects/AUTO_MODERATION_TRIGGER_METADATA/AUTO_MODERATION_TRIGGER_METADATA.json
@@ -11,5 +11,6 @@
   "allow_list": [
     "none"
   ],
-  "mention_total_limit": 1
+  "mention_total_limit": 1,
+  "mention_raid_protection_enabled": true
 }
diff --git a/Tests/Remora.Discord.Tests/Samples/Objects/GUILD/GUILD.json b/Tests/Remora.Discord.Tests/Samples/Objects/GUILD/GUILD.json
@@ -69,5 +69,6 @@
       "format_type": 1
     }
   ],
-  "premium_progress_bar_enabled": true
+  "premium_progress_bar_enabled": true,
+  "safety_alerts_channel_id": "999999999999999999"
 }
diff --git a/Tests/Remora.Discord.Tests/Samples/Objects/GUILD/GUILD.nulls.json b/Tests/Remora.Discord.Tests/Samples/Objects/GUILD/GUILD.nulls.json
@@ -68,5 +68,6 @@
       "format_type": 1
     }
   ],
-  "premium_progress_bar_enabled": true
+  "premium_progress_bar_enabled": true,
+  "safety_alerts_channel_id": null
 }
diff --git a/Tests/Remora.Discord.Tests/Samples/Objects/GUILD/GUILD.optionals.json b/Tests/Remora.Discord.Tests/Samples/Objects/GUILD/GUILD.optionals.json
@@ -44,5 +44,6 @@
   "preferred_locale": "en-US",
   "public_updates_channel_id": "999999999999999999",
   "nsfw_level": 0,
-  "premium_progress_bar_enabled": true
+  "premium_progress_bar_enabled": true,
+  "safety_alerts_channel_id": "999999999999999999"
 }