Add matrix-protection-suite skeleton for spam police (for illustration or serious purposes) #70
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Gnuxie
commented
May 15, 2024
Gnuxie
commented
May 15, 2024
Comment on lines
+113
to
+130
| // FIXME: You probably want to create your own class that impleemnts the `ProtectionsConfig` | ||
| // interface (Ctrl+click on MjolnirProtectionsConfig to drill down and find it). | ||
| // As this one reuses a state event used by Mjolnir to store it. | ||
| // You don't need to though. | ||
| const protectionsConfigResult = await MjolnirProtectionsConfig.create( | ||
| new BotSDKMatrixAccountData<MjolnirEnabledProtectionsEvent>( | ||
| MjolnirEnabledProtectionsEventType, | ||
| MjolnirEnabledProtectionsEvent, | ||
| client, | ||
| ), | ||
| loggableConfigTracker, | ||
| { | ||
| missingProtectionCB: makeMissingProtectionCB(), | ||
| }, | ||
| ); | ||
| if (isError(protectionsConfigResult)) { | ||
| return protectionsConfigResult; | ||
| } |
There was a problem hiding this comment.
We currently are reusing MjolnirProtectionsConfig
Gnuxie
commented
May 15, 2024
Comment on lines
+18
to
+50
| export class SpamPoliceBot { | ||
| private handleTimelineEventListener = this.handleTimelineEvent.bind(this); | ||
| public constructor( | ||
| /** The userID for the main bot user. */ | ||
| public readonly clientUserID: StringUserID, | ||
| public readonly managementRoomID: StringRoomID, | ||
| public readonly protectedRoomsSet: ProtectedRoomsSet, | ||
| // note for jjj: This is the MatrixClient from the bot-sdk, but only allows | ||
| // you to do actions that interact with Matrix, rather than listen for events. | ||
| // we restrict that on purpose so that people don't add adhoc listeners to it, | ||
| // which can easily get lost and become untracked / leaky etc. | ||
| public readonly client: MatrixSendClient, | ||
| // This provides the same functionality as the client, but each individual | ||
| // request into its own capability that can be provided to keep the scope | ||
| // of client dependencies restricted. (This really really helps when testing them). | ||
| // It will also help if you want the actions to go through a different client if | ||
| // say one server is down as you have suggested. Since you can easily implement | ||
| // your own client platform. | ||
| public readonly clientPlatform: ClientPlatform, | ||
| // These are used to access the various revision issuers. | ||
| public readonly roomStateManager: RoomStateManager, | ||
| public readonly policyRoomManager: PolicyRoomManager, | ||
| public readonly roomMembershipManager: RoomMembershipManager, | ||
| // This gives access to the list of joined rooms and also timelien events. | ||
| private readonly clientRooms: ClientRooms, | ||
| ) { | ||
| this.clientRooms.on("timeline", this.handleTimelineEventListener); | ||
| } | ||
|
|
||
| private handleTimelineEvent(roomID: StringRoomID, event: RoomEvent): void { | ||
| this.protectedRoomsSet.handleTimelineEvent(roomID, event); | ||
| } | ||
| } |
There was a problem hiding this comment.
This is the context object i was talking about that you'd want to give to protections
Gnuxie
commented
May 15, 2024
Comment on lines
+97
to
+99
| // for jjj: the clientsInRoomMap handles all event ingress into MPS for us, | ||
| // and in turn informs the various room state managers so that they are up to date | ||
| clientsInRoomMap.handleTimelineEvent(roomID, event); |
There was a problem hiding this comment.
This sets up one syncing client to inform the clientsInRoomMap about new events. The ClientsInRoomMap from MPS is the source for all events in MPS.
Gnuxie
commented
May 15, 2024
| } | ||
|
|
||
| // async run ({client, roomId, event, mxid, displayname, blacklist}){ | ||
| async run(datapoints) { |
There was a problem hiding this comment.
i honestly couldn't figure out how to break this down to make an example protection, it seems like there's so many different things being done in this one handle
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
(uhh, i also added typescript, eslint, and prettier).
Next steps: breaking out the message scanning into protections i guess.