Add Auto Moderation #647

lukellmann · 2022-07-06T00:28:03Z

This PR adds support for Discord's Auto Moderation feature.

The DSL for creating and editing AutoModerationRules looks like this:

// or other type instead of `Keyword`
// or rule.edit { ... }
val rule = guild.createKeywordAutoModerationRule("name") {

    // for `Keword` rules:
    // select one or multiple keywords that will trigger the rule
    keyword("cat")
    prefixKeyword("dog")
    suffixKeyword("owl")
    anywhereKeyword("fish")

    // for `KeywordPreset` rules:
    // select one or multiple presets
    preset(Profanity)
    // exempt substrings from triggering presets (optional)
    allowKeyword("hamster")

    // for `MentionSpam` rules:
    mentionLimit = 11

    // select one or multiple actions
    blockMessage()
    sendAlertMessage(channelId)
    timeout(42.minutes) // can only be used for `Keyword` and `MentionSpam` rules

    // optional
    eventType = MessageSend
    enabled = true
    exemptRole(roleId)
    exemptChannel(channelId)
}

relevant doc commits / PRs / pages:

rest/src/main/kotlin/route/Route.kt

…dPresetType`

core/src/main/kotlin/cache/data/AutoModeration.kt

…difyBuilder`

# Conflicts: # core/src/main/kotlin/event/Event.kt # core/src/main/kotlin/gateway/handler/BaseGatewayEventHandler.kt # core/src/main/kotlin/gateway/handler/DefaultGatewayEventInterceptor.kt # core/src/main/kotlin/gateway/handler/InteractionEventHandler.kt # core/src/main/kotlin/gateway/handler/ThreadEventHandler.kt

lukellmann · 2022-08-28T15:32:01Z

rest/src/main/kotlin/service/AuditLogService.kt


 public class AuditLogService(requestHandler: RequestHandler) : RestService(requestHandler) {

    public suspend inline fun getAuditLogs(
        guildId: Snowflake,
        builder: AuditLogGetRequestBuilder.() -> Unit,
    ): DiscordAuditLog {
+        contract { callsInPlace(builder, EXACTLY_ONCE) }


doesn't have anything to do with automod but contract was missing

lukellmann · 2022-08-28T15:54:00Z

gateway/src/main/kotlin/Gateway.kt

@@ -32,7 +32,7 @@ public interface Gateway : CoroutineScope {
    public val events: SharedFlow<Event>

    /**
-     * The duration between the last [Heartbeat] and [HeartbeatACK].
+     * The duration between the last [Heartbeat][Command.Heartbeat] and [HeartbeatACK].


doesn't have anything to do with automod but link was wrong

lukellmann · 2022-08-28T15:54:54Z

gateway/src/main/kotlin/Command.kt

-        "Identify(token=hunter2,properties=$properties,compress=$compress,largeThreshold=$largeThreshold," +
-                "shard=$shard,presence=$presence"
+        "Identify(token=hunter2, properties=$properties, compress=$compress, largeThreshold=$largeThreshold, " +
+                "shard=$shard, presence=$presence, intents=$intents)"


doesn't have anything to do with automod

lukellmann · 2022-08-28T15:54:59Z

gateway/src/main/kotlin/Command.kt

-    override fun toString(): String = "Resume(token=hunter2,sessionId=$sessionId,sequenceNumber:$sequenceNumber)"
+    override fun toString(): String = "Resume(token=hunter2, sessionId=$sessionId, sequenceNumber=$sequenceNumber)"


doesn't have anything to do with automod

lukellmann · 2022-08-28T16:17:59Z

rest/api/rest.api

-public abstract interface class dev/kord/rest/builder/AuditRequestBuilder : dev/kord/rest/builder/RequestBuilder {
+public abstract interface class dev/kord/rest/builder/AuditBuilder {
 	public abstract fun getReason ()Ljava/lang/String;
 	public abstract fun setReason (Ljava/lang/String;)V
 }

+public abstract interface class dev/kord/rest/builder/AuditRequestBuilder : dev/kord/rest/builder/AuditBuilder, dev/kord/rest/builder/RequestBuilder {
+}
+


This is a binary compatible change, AuditRequestBuilder doesn't lose or get new members (they are just inherited now).

lukellmann · 2022-08-28T16:21:55Z

rest/src/main/kotlin/builder/RequestBuilder.kt

 @KordDsl
-public interface RequestBuilder<T> {
-    public fun toRequest(): T
-}
-
-@KordDsl
-public interface AuditRequestBuilder<T> : RequestBuilder<T> {
+public interface AuditBuilder {
    /**
     * The reason for this request, this will be displayed in the audit log.
     */
    public var reason: String?
 }
+
+@KordDsl
+public interface RequestBuilder<out T : Any> {
+    public fun toRequest(): T
+}
+
+@KordDsl
+public interface AuditRequestBuilder<out T : Any> : AuditBuilder, RequestBuilder<T>


This allows supertypes of create and modify builders to implement AuditBuilder. They can't implement AuditRequestBuilder since create and modify builders usually have different return types for toRequest.

lukellmann · 2022-08-28T20:07:34Z

core/src/main/kotlin/cache/data/UserData.kt

-        public val description: DataDescription<UserData, Snowflake>
-            get() = description(UserData::id) {
-                link(UserData::id to MemberData::userId)
-                link(UserData::id to WebhookData::nullableUserId)
-                link(UserData::id to VoiceStateData::userId)
-                link(UserData::id to PresenceData::userId)
-            }
+        public val description: DataDescription<UserData, Snowflake> = description(UserData::id) {
+            link(UserData::id to MemberData::userId)
+            link(UserData::id to WebhookData::nullableUserId)
+            link(UserData::id to VoiceStateData::userId)
+            link(UserData::id to PresenceData::userId)
+        }


removed the getter and replaced it with an initializer

lukellmann · 2022-08-28T20:18:51Z

core/src/main/kotlin/cache/DataCacheExtensions.kt

+    query<ThreadMemberData>().remove()
    query<MessageData>().remove()
    query<EmojiData>().remove()
    query<WebhookData>().remove()
    query<PresenceData>().remove()
    query<VoiceStateData>().remove()
+    query<ApplicationCommandData>().remove()
+    query<GuildApplicationCommandPermissionsData>().remove()
+    query<StickerPackData>().remove()
+    query<StickerData>().remove()


Added these because they were missing, is this right?

lukellmann · 2022-08-28T20:40:24Z

core/src/main/kotlin/behavior/automoderation/AutoModerationRuleBehavior.kt

+    override fun equals(other: Any?): Boolean
+    override fun hashCode(): Int
+    override fun toString(): String


this forces overrides in subtypes

lukellmann · 2022-08-28T22:42:54Z

core/src/main/kotlin/event/Event.kt

    /**
     * The Gateway that spawned this event.
     */
    public val gateway: Gateway get() = kord.gateway.gateways.getValue(shard)

-    public val kord: Kord


KordObject has this property too

lukellmann · 2022-08-28T23:23:46Z

core/src/main/kotlin/gateway/DefaultMasterGateway.kt

-    @OptIn(FlowPreview::class)
-    override val events: Flow<ShardEvent> = gateways.entries.asFlow()
+    override val events: Flow<ShardEvent> = gateways.entries
        .map { (shard, gateway) -> gateway.events.map { ShardEvent(it, gateway, shard) } }
-        .flattenMerge(gateways.size.coerceAtLeast(1))
+        .merge()


merge() has no limit on concurrency (we used the max with flattenMerge before anyway) and isn't marked with @FlowPreview

core/src/main/kotlin/event/automoderation/AutoModerationActionExecutionEvent.kt

lukellmann · 2022-08-29T00:11:00Z

core/api/core.api

-public abstract interface class dev/kord/core/event/Event {
+public abstract interface class dev/kord/core/event/Event : dev/kord/core/KordObject {
 	public abstract fun getCustomContext ()Ljava/lang/Object;
 	public abstract fun getGateway ()Ldev/kord/gateway/Gateway;
-	public abstract fun getKord ()Ldev/kord/core/Kord;
 	public abstract fun getShard ()I
 }


This is a binary compatible change, Event doesn't lose or get new members (getKord() is just inherited now).

lukellmann · 2022-08-29T00:24:17Z

This should now be ready for review 🥳

HopeBaron · 2022-08-29T09:40:24Z

The overall PR looks good; tho it could've been easier if we used smaller PRs this would've helped splitting tasks to contributors as well

Great job tho 👍

lukellmann · 2022-08-29T11:51:10Z

The overall PR looks good; tho it could've been easier if we used smaller PRs this would've helped splitting tasks to contributors as well

Yeah, didn't anticipate that it would be this big.

HopeBaron

Would be nice to have some tests before we merge this

lukellmann · 2022-08-29T14:31:18Z

What kind of tests are you thinking of? Automated tests with the api are hard in this case as automod is only available in community guilds (I did some manual api tests).

HopeBaron · 2022-08-31T12:23:22Z

This is enough then

HopeBaron and others added 4 commits June 24, 2022 21:36

Automod models [broken]

b1607fb

Merge branch '0.8.x' into automod

b733abf

Fix Auto Moderation models

5ab959e

Add "Discord" prefix to Auto Moderation models

85f6a0c

lukellmann marked this pull request as draft July 6, 2022 00:29

Add Auto Moderation routes

cdf5451

lukellmann commented Jul 6, 2022

View reviewed changes

rest/src/main/kotlin/route/Route.kt Show resolved Hide resolved

lukellmann added 18 commits July 6, 2022 03:12

Add Auto Moderation requests

674e623

Add AutoModerationService

1b587a2

Add Auto Moderation to Audit Log

01ba306

Add GuildFeature.AutoModeration

78da15b

Add MessageType.AutoModerationAction

2f8b2ce

Add Auto Moderation Gateway Intents

52f9335

Add Auto Moderation Gateway Events

c8169bf

Fix test

4ff6296

Rename AutoModerationKeywordPresetType to `AutoModerationRuleKeywor…

c51dbe2

…dPresetType`

Remove TODOs, fields are indeed optional

3485fba

Add missing Optional default

068c784

Add DiscordAutoModerationRuleTriggerMetadata.allowList

efcc54f

Add builders

4d03cf0

Add docs for builders

9591b4e

Merge branch '0.8.x' into automod

790bd62

Add builder-taking functions to AutoModerationService

2744416

Merge branch '0.8.x' into automod

933f63b

Add cache models

f4e861c

lukellmann commented Jul 11, 2022

View reviewed changes

core/src/main/kotlin/cache/data/AutoModeration.kt Show resolved Hide resolved

lukellmann added 4 commits July 12, 2022 14:57

Rename package

058f7ce

Add TypedAutoModerationRuleBuilder and `UntypedAutoModerationRuleMo…

307cf3c

…difyBuilder`

Start adding core models/functions

9509d10

Add missing properties to AutoModerationRule

b056320

lukellmann force-pushed the 0.8.x branch 2 times, most recently from a1bb076 to 1e6718a Compare August 17, 2022 12:47

lukellmann added 9 commits August 19, 2022 18:16

Fix after merge

e0d5a16

Forgot api dump for gateway

2025541

Merge branch '0.8.x' into automod

7d002a6

Remove AutoModerationRuleTriggerType.HarmfulLink

694a99d

@KordExperimental for Spam and MentionSpam trigger types

b9ca8c6

Allow Timeout actions for MentionSpam rules

895d601

KDoc for AutoModerationRuleKeywordPresetType

c1e7213

KDoc for AutoModerationActionType

4a58bbe

lukellmann commented Aug 28, 2022

View reviewed changes

lukellmann added 2 commits August 28, 2022 21:32

Add missing removes in removeKordData()

c9cb627

Add KordCacheBuilder.autoModerationRules

b1edada

lukellmann force-pushed the automod branch from 1466b4c to b1edada Compare August 28, 2022 19:44

lukellmann added 2 commits August 28, 2022 22:30

Add KDoc for automod methods in EntitySupplier

c7e548e

Adjust init blocks

9af4780

lukellmann commented Aug 29, 2022

View reviewed changes

lukellmann marked this pull request as ready for review August 29, 2022 00:23

lukellmann requested a review from HopeBaron August 29, 2022 00:24

Rename user to member in AutoModerationActionExecutionEvent

2ee9016

HopeBaron approved these changes Aug 29, 2022

View reviewed changes

HopeBaron merged commit a2bfc1f into 0.8.x Aug 31, 2022

Codeize mentioned this pull request Sep 11, 2022

chore: update Kord automod status advaith1/libs#168

Merged

lukellmann deleted the automod branch September 12, 2022 13:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Auto Moderation #647

Add Auto Moderation #647

lukellmann commented Jul 6, 2022 •

edited

Loading

lukellmann Aug 28, 2022

lukellmann Aug 28, 2022

lukellmann Aug 28, 2022

lukellmann Aug 28, 2022

lukellmann Aug 28, 2022

lukellmann Aug 28, 2022

lukellmann Aug 28, 2022

lukellmann Aug 28, 2022

lukellmann Aug 28, 2022

lukellmann Aug 28, 2022

lukellmann Aug 28, 2022

lukellmann Aug 29, 2022

lukellmann commented Aug 29, 2022

HopeBaron commented Aug 29, 2022

lukellmann commented Aug 29, 2022

HopeBaron left a comment

lukellmann commented Aug 29, 2022

HopeBaron commented Aug 31, 2022

		override fun toString(): String = "Resume(token=hunter2,sessionId=$sessionId,sequenceNumber:$sequenceNumber)"
		override fun toString(): String = "Resume(token=hunter2, sessionId=$sessionId, sequenceNumber=$sequenceNumber)"

Add Auto Moderation #647

Add Auto Moderation #647

Conversation

lukellmann commented Jul 6, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lukellmann commented Aug 29, 2022

HopeBaron commented Aug 29, 2022

lukellmann commented Aug 29, 2022

HopeBaron left a comment

Choose a reason for hiding this comment

lukellmann commented Aug 29, 2022

HopeBaron commented Aug 31, 2022

lukellmann commented Jul 6, 2022 •

edited

Loading